Class: PrivateMessageApiClient
services/private_message.PrivateMessageApiClient
Contains all the endpoints needed to manage private messages.
Constructors
constructor
• new PrivateMessageApiClient(): PrivateMessageApiClient
Returns
Methods
chunkUploadDone
▸ chunkUploadDone(data, config?): Promise<SCPrivateMessageUploadMediaType>
This endpoint finalizes the chunk upload and creates the file.
Parameters
| Name | Type |
|---|---|
data | MessageChunkUploadDoneParams |
config? | AxiosRequestConfig<any> |
Returns
Promise<SCPrivateMessageUploadMediaType>
Defined in
services/private_message/index.ts:139
deleteAMessage
▸ deleteAMessage(id, config?): Promise<any>
This endpoint deletes a single message.
Parameters
| Name | Type |
|---|---|
id | string | number |
config? | AxiosRequestConfig<any> |
Returns
Promise<any>
Defined in
services/private_message/index.ts:83
deleteAThread
▸ deleteAThread(params, config?): Promise<any>
This endpoint deletes a thread.
Parameters
| Name | Type |
|---|---|
params | ThreadDeleteParams |
config? | AxiosRequestConfig<any> |
Returns
Promise<any>
Defined in
services/private_message/index.ts:92
getASingleMessage
▸ getASingleMessage(id, config?): Promise<SCPrivateMessageThreadType>
This endpoint retrieves a single message using ID.
Parameters
| Name | Type |
|---|---|
id | string | number |
config? | AxiosRequestConfig<any> |
Returns
Promise<SCPrivateMessageThreadType>
Defined in
services/private_message/index.ts:65
getAThread
▸ getAThread(params, config?): Promise<SCPaginatedResponse<SCPrivateMessageThreadType>>
This endpoint retrieves all messages in a thread.
Parameters
| Name | Type |
|---|---|
params | ThreadParams |
config? | AxiosRequestConfig<any> |
Returns
Promise<SCPaginatedResponse<SCPrivateMessageThreadType>>
Defined in
services/private_message/index.ts:55
getAllSnippets
▸ getAllSnippets(config?): Promise<SCPaginatedResponse<SCPrivateMessageSnippetType>>
This endpoint retrieves all snippets.
Parameters
| Name | Type |
|---|---|
config? | AxiosRequestConfig<any> |
Returns
Promise<SCPaginatedResponse<SCPrivateMessageSnippetType>>
Defined in
services/private_message/index.ts:46
searchUser
▸ searchUser(search, config?): Promise<SCPaginatedResponse<SCUserType>>
This endpoint performs users search.
Parameters
| Name | Type |
|---|---|
search | string |
config? | AxiosRequestConfig<any> |
Returns
Promise<SCPaginatedResponse<SCUserType>>
Defined in
services/private_message/index.ts:152
sendAMessage
▸ sendAMessage(data, config?): Promise<SCPrivateMessageThreadType>
This endpoint sends a message.
Parameters
| Name | Type |
|---|---|
data | MessageCreateParams |
config? | AxiosRequestConfig<any> |
Returns
Promise<SCPrivateMessageThreadType>
Defined in
services/private_message/index.ts:74
uploadMedia
▸ uploadMedia(data, config?): Promise<SCPrivateMessageUploadMediaType>
This endpoint uploads a media.
Parameters
| Name | Type |
|---|---|
data | MessageMediaUploadParams |
config? | AxiosRequestConfig<any> |
Returns
Promise<SCPrivateMessageUploadMediaType>
Defined in
services/private_message/index.ts:102
uploadMediaInChunks
▸ uploadMediaInChunks(data, config?): Promise<SCPrivateMessageUploadMediaChunkType>
This endpoint performs the chunk upload of a file.
Parameters
| Name | Type |
|---|---|
data | MessageMediaChunksParams |
config? | AxiosRequestConfig<any> |
Returns
Promise<SCPrivateMessageUploadMediaChunkType>
Defined in
services/private_message/index.ts:125
uploadThumbnail
▸ uploadThumbnail(data, config?): Promise<SCPrivateMessageUploadThumbnailType>
This endpoint uploads a thumbnail.
Parameters
| Name | Type |
|---|---|
data | MessageThumbnailUploadParams |
config? | AxiosRequestConfig<any> |
Returns
Promise<SCPrivateMessageUploadThumbnailType>