Skip to main content

Interface: EmbedApiClientInterface

services/embed.EmbedApiClientInterface

Methods

createEmbed

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

Parameters

NameType
dataSCEmbedType
config?AxiosRequestConfig<any>

Returns

Promise<SCEmbedType>

Defined in

services/embed/index.ts:10


getAllEmbeds

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

Parameters

NameType
params?BaseGetParams
config?AxiosRequestConfig<any>

Returns

Promise<SCPaginatedResponse<SCEmbedType>>

Defined in

services/embed/index.ts:9


getEmbedFeed

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

Parameters

NameType
embed_type?string
embed_id?string
config?AxiosRequestConfig<any>

Returns

Promise<SCPaginatedResponse<SCFeedUnitType>>

Defined in

services/embed/index.ts:15


getSpecificEmbed

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

Parameters

NameType
idstring | number
config?AxiosRequestConfig<any>

Returns

Promise<SCEmbedType>

Defined in

services/embed/index.ts:12


getSpecificEmbedFeed

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

Parameters

NameType
idstring | number
config?AxiosRequestConfig<any>

Returns

Promise<SCPaginatedResponse<SCFeedUnitType>>

Defined in

services/embed/index.ts:16


patchASpecificEmbed

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

Parameters

NameType
idstring | number
data?EmbedUpdateParams
config?AxiosRequestConfig<any>

Returns

Promise<SCEmbedType>

Defined in

services/embed/index.ts:14


searchEmbed

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

Parameters

NameType
params?EmbedSearchParams
config?AxiosRequestConfig<any>

Returns

Promise<SCPaginatedResponse<SCEmbedType>>

Defined in

services/embed/index.ts:11


updateASpecificEmbed

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

Parameters

NameType
idstring | number
data?EmbedUpdateParams
config?AxiosRequestConfig<any>

Returns

Promise<SCEmbedType>

Defined in

services/embed/index.ts:13