Methods
delete
- delete<T>(endpoint: string, headers?: object): Promise<T>
-
Type parameters
Parameters
-
endpoint: string
-
Optional headers: object
Returns Promise<T>
get
- get<T>(endpoint: string, headers?: object): Promise<T>
-
Type parameters
Parameters
-
endpoint: string
-
Optional headers: object
Returns Promise<T>
patch
- patch<T>(endpoint: string, body: object, headers?: object): Promise<T>
-
Type parameters
Parameters
-
endpoint: string
-
body: object
-
Optional headers: object
Returns Promise<T>
post
- post<T>(endpoint: string, body: object, headers?: object): Promise<T>
-
Type parameters
Parameters
-
endpoint: string
-
body: object
-
Optional headers: object
Returns Promise<T>
put
- put<T>(endpoint: string, body: object, headers?: object): Promise<T>
-
Type parameters
Parameters
-
endpoint: string
-
body: object
-
Optional headers: object
Returns Promise<T>
readStreamToRequest
- readStreamToRequest(endpoint: string, mimeType: string, size: number, readStream: ReadStream): Promise<AttachmentsResponse>
-
Parameters
-
endpoint: string
-
mimeType: string
-
size: number
-
readStream: ReadStream
writeBinaryResponseToStream
- writeBinaryResponseToStream(endpoint: string, mimeType: string, writeStream: WriteStream): Promise<void>
-
Parameters
-
endpoint: string
-
mimeType: string
-
writeStream: WriteStream
Returns Promise<void>
writeUTF8ResponseToStream
- writeUTF8ResponseToStream(endpoint: string, mimeType: string, writeStream: WriteStream): Promise<void>
-
Parameters
-
endpoint: string
-
mimeType: string
-
writeStream: WriteStream
Returns Promise<void>