Class: MediaApiClient
services/media.MediaApiClient
Contains all the endpoints needed to manage medias.
Constructors
constructor
• new MediaApiClient(): MediaApiClient
Returns
Methods
chunkUploadMedia
▸ chunkUploadMedia(data, bytesStart, bytesEnd, bytesTotal, config?): Promise<SCChunkMediaType>
This endpoint performs the chunk upload of a media with type image or document. The client must split the file into chunks and send to the server in series. After all the chunks have been uploaded the client must call the Chunk Upload Complete endpoint with the given upload_id parameter to finalize the upload and retrieve the Media. To perform chunk upload the request must contain Content-Range header with the information about the chunk(range of the chunk upload in the format bytes start-end/total)
Parameters
| Name | Type |
|---|---|
data | ChunkUploadParams |
bytesStart | number |
bytesEnd | number |
bytesTotal | number |
config? | AxiosRequestConfig<any> |
Returns
Promise<SCChunkMediaType>
Defined in
chunkUploadMediaComplete
▸ chunkUploadMediaComplete(data, config?): Promise<SCMediaType>
This endpoint completes the chunk upload and create the media.
Parameters
| Name | Type |
|---|---|
data | ChunkUploadCompleteParams |
config? | AxiosRequestConfig<any> |
Returns
Promise<SCMediaType>
Defined in
clickMedia
▸ clickMedia(id, ip?, config?): Promise<any>
This endpoint saves a click on a specific media using ID.
Parameters
| Name | Type |
|---|---|
id | string | number |
ip? | string |
config? | AxiosRequestConfig<any> |
Returns
Promise<any>
Defined in
createMedia
▸ createMedia(data, config?): Promise<SCMediaType>
This endpoint creates a media.
Parameters
| Name | Type |
|---|---|
data | MediaCreateParams |
config? | AxiosRequestConfig<any> |
Returns
Promise<SCMediaType>
Defined in
deleteMedia
▸ deleteMedia(id, config?): Promise<any>
This endpoint deletes a media.
Parameters
| Name | Type |
|---|---|
id | string | number |
config? | AxiosRequestConfig<any> |
Returns
Promise<any>
Defined in
getSpecificMedia
▸ getSpecificMedia(id, config?): Promise<SCMediaType>
This endpoint retrieves a specific media using ID.
Parameters
| Name | Type |
|---|---|
id | string | number |
config? | AxiosRequestConfig<any> |
Returns
Promise<SCMediaType>
Defined in
updateMedia
▸ updateMedia(id, image, config?): Promise<SCMediaType>
This endpoint updates a media.
Parameters
| Name | Type |
|---|---|
id | string | number |
image | string |
config? | AxiosRequestConfig<any> |
Returns
Promise<SCMediaType>