Class: EmbedApiClient

services/embed.EmbedApiClient

Contains all the endpoints needed to manage embeds.

Constructors

constructor

• new EmbedApiClient(): EmbedApiClient

Returns

EmbedApiClient

Methods

createEmbed

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

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

Parameters

Name	Type
data	SCEmbedType
config?	AxiosRequestConfig<any>

Returns

Promise<SCEmbedType>

Defined in

services/embed/index.ts:38

---

getAllEmbeds

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

This endpoint retrieves all embeds.

Parameters

Name	Type
params?	BaseGetParams
config?	AxiosRequestConfig<any>

Returns

Promise<SCPaginatedResponse<SCEmbedType>>

Defined in

services/embed/index.ts:28

---

getEmbedFeed

▸ 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

Name	Type
embed_type?	string
embed_id?	string
config?	AxiosRequestConfig<any>

Returns

Promise<SCPaginatedResponse<SCFeedUnitType>>

Defined in

services/embed/index.ts:87

---

getSpecificEmbed

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

This endpoint retrieves a specific embed using ID.

Parameters

Name	Type
id	string | number
config?	AxiosRequestConfig<any>

Returns

Promise<SCEmbedType>

Defined in

services/embed/index.ts:57

---

getSpecificEmbedFeed

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

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

Parameters

Name	Type
id	string | number
config?	AxiosRequestConfig<any>

Returns

Promise<SCPaginatedResponse<SCFeedUnitType>>

Defined in

services/embed/index.ts:97

---

patchASpecificEmbed

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

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

Parameters

Name	Type
id	string | number
data?	EmbedUpdateParams
config?	AxiosRequestConfig<any>

Returns

Promise<SCEmbedType>

Defined in

services/embed/index.ts:77

---

searchEmbed

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

This endpoint performs embed search.

Parameters

Name	Type
params?	EmbedSearchParams
config?	AxiosRequestConfig<any>

Returns

Promise<SCPaginatedResponse<SCEmbedType>>

Defined in

services/embed/index.ts:47

---

updateASpecificEmbed

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

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

Parameters

Name	Type
id	string | number
data?	EmbedUpdateParams
config?	AxiosRequestConfig<any>

Returns

Promise<SCEmbedType>

Defined in

services/embed/index.ts:67