PrivateMessageApiClient

Contains all the endpoints needed to manage private messages.

Constructors

Constructor

new PrivateMessageApiClient(): PrivateMessageApiClient

Returns

PrivateMessageApiClient

Methods

chunkUploadDone()

static chunkUploadDone(data, config?): Promise<SCPrivateMessageUploadMediaType>

This endpoint finalizes the chunk upload and creates the file.

Parameters

Parameter	Type	Description
data	MessageChunkUploadDoneParams
config?	AxiosRequestConfig

Returns

Promise<SCPrivateMessageUploadMediaType>

---

deleteAMessage()

static deleteAMessage(id, config?): Promise<any>

This endpoint deletes a single message.

Parameters

Parameter	Type	Description
id	string | number
config?	AxiosRequestConfig

Returns

Promise<any>

---

deleteAThread()

static deleteAThread(params, config?): Promise<any>

This endpoint deletes a thread.

Parameters

Parameter	Type	Description
params	ThreadDeleteParams
config?	AxiosRequestConfig

Returns

Promise<any>

---

getAllSnippets()

static getAllSnippets(config?): Promise<SCPaginatedResponse<SCPrivateMessageSnippetType>>

This endpoint retrieves all snippets.

Parameters

Parameter	Type	Description
config?	AxiosRequestConfig

Returns

Promise<SCPaginatedResponse<SCPrivateMessageSnippetType>>

---

getASingleMessage()

static getASingleMessage(id, config?): Promise<SCPrivateMessageThreadType>

This endpoint retrieves a single message using ID.

Parameters

Parameter	Type	Description
id	string | number
config?	AxiosRequestConfig

Returns

Promise<SCPrivateMessageThreadType>

---

getAThread()

static getAThread(params, config?): Promise<SCPaginatedResponse<SCPrivateMessageThreadType>>

This endpoint retrieves all messages in a thread.

Parameters

Parameter	Type	Description
params	ThreadParams
config?	AxiosRequestConfig

Returns

Promise<SCPaginatedResponse<SCPrivateMessageThreadType>>

---

searchUser()

static searchUser(search, config?): Promise<SCPaginatedResponse<SCUserType>>

This endpoint performs users search.

Parameters

Parameter	Type	Description
search	string
config?	AxiosRequestConfig

Returns

Promise<SCPaginatedResponse<SCUserType>>

---

sendAMessage()

static sendAMessage(data, config?): Promise<SCPrivateMessageThreadType>

This endpoint sends a message.

Parameters

Parameter	Type	Description
data	MessageCreateParams
config?	AxiosRequestConfig

Returns

Promise<SCPrivateMessageThreadType>

---

uploadMedia()

static uploadMedia(data, config?): Promise<SCPrivateMessageUploadMediaType>

This endpoint uploads a media.

Parameters

Parameter	Type	Description
data	MessageMediaUploadParams
config?	AxiosRequestConfig

Returns

Promise<SCPrivateMessageUploadMediaType>

---

uploadMediaInChunks()

static uploadMediaInChunks(data, config?): Promise<SCPrivateMessageUploadMediaChunkType>

This endpoint performs the chunk upload of a file.

Parameters

Parameter	Type	Description
data	MessageMediaChunksParams
config?	AxiosRequestConfig

Returns

Promise<SCPrivateMessageUploadMediaChunkType>

---

uploadThumbnail()

static uploadThumbnail(data, config?): Promise<SCPrivateMessageUploadThumbnailType>

This endpoint uploads a thumbnail.

Parameters

Parameter	Type	Description
data	MessageThumbnailUploadParams
config?	AxiosRequestConfig

Returns

Promise<SCPrivateMessageUploadThumbnailType>