Skip to main content

EmbedApiClient

Contains all the endpoints needed to manage embeds.

Constructors

Constructor

new EmbedApiClient(): EmbedApiClient

Returns

EmbedApiClient

Methods

createEmbed()

static createEmbed(data, config?): Promise<SCEmbedType>

This endpoint creates an embed. This operation requires admin role.

Parameters

ParameterTypeDescription
dataSCEmbedType
config?AxiosRequestConfig

Returns

Promise<SCEmbedType>


getAllEmbeds()

static getAllEmbeds(params?, config?): Promise<SCPaginatedResponse<SCEmbedType>>

This endpoint retrieves all embeds.

Parameters

ParameterTypeDescription
params?BaseGetParams
config?AxiosRequestConfig

Returns

Promise<SCPaginatedResponse<SCEmbedType>>


getEmbedFeed()

static getEmbedFeed(embed_type?, embed_id?, config?): Promise<SCPaginatedResponse<SCFeedUnitType>>

This endpoint retrieves the embed's feed which contains Feed that has the Embed as associated media.

Parameters

ParameterTypeDescription
embed_type?string
embed_id?string
config?AxiosRequestConfig

Returns

Promise<SCPaginatedResponse<SCFeedUnitType>>


getSpecificEmbed()

static getSpecificEmbed(id, config?): Promise<SCEmbedType>

This endpoint retrieves a specific embed using ID.

Parameters

ParameterTypeDescription
idstring | number
config?AxiosRequestConfig

Returns

Promise<SCEmbedType>


getSpecificEmbedFeed()

static getSpecificEmbedFeed(id, config?): Promise<SCPaginatedResponse<SCFeedUnitType>>

This endpoint retrieves the embed's feed which contains Feed that has an Embed as associated media.

Parameters

ParameterTypeDescription
idstring | number
config?AxiosRequestConfig

Returns

Promise<SCPaginatedResponse<SCFeedUnitType>>


patchASpecificEmbed()

static patchASpecificEmbed(id, data?, config?): Promise<SCEmbedType>

This endpoint patches a specific embed. This operation requires admin role.

Parameters

ParameterTypeDescription
idstring | number
data?EmbedUpdateParams
config?AxiosRequestConfig

Returns

Promise<SCEmbedType>


searchEmbed()

static searchEmbed(params?, config?): Promise<SCPaginatedResponse<SCEmbedType>>

This endpoint performs embed search.

Parameters

ParameterTypeDescription
params?EmbedSearchParams
config?AxiosRequestConfig

Returns

Promise<SCPaginatedResponse<SCEmbedType>>


updateASpecificEmbed()

static updateASpecificEmbed(id, data?, config?): Promise<SCEmbedType>

This endpoint updates a specific embed. This operation requires admin role.

Parameters

ParameterTypeDescription
idstring | number
data?EmbedUpdateParams
config?AxiosRequestConfig

Returns

Promise<SCEmbedType>