EmbedApiClientInterface

Methods

createEmbed()

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

Parameters

Parameter	Type
data	SCEmbedType
config?	AxiosRequestConfig<any>

Returns

Promise<SCEmbedType>

Source

services/embed/index.ts:10

---

getAllEmbeds()

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

Parameters

Parameter	Type
params?	BaseGetParams
config?	AxiosRequestConfig<any>

Returns

Promise <SCPaginatedResponse<SCEmbedType>>

Source

services/embed/index.ts:9

---

getEmbedFeed()

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

Parameters

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

Returns

Promise <SCPaginatedResponse<SCFeedUnitType>>

Source

services/embed/index.ts:15

---

getSpecificEmbed()

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

Parameters

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

Returns

Promise<SCEmbedType>

Source

services/embed/index.ts:12

---

getSpecificEmbedFeed()

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

Parameters

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

Returns

Promise <SCPaginatedResponse<SCFeedUnitType>>

Source

services/embed/index.ts:16

---

patchASpecificEmbed()

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

Parameters

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

Returns

Promise<SCEmbedType>

Source

services/embed/index.ts:14

---

searchEmbed()

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

Parameters

Parameter	Type
params?	EmbedSearchParams
config?	AxiosRequestConfig<any>

Returns

Promise <SCPaginatedResponse<SCEmbedType>>

Source

services/embed/index.ts:11

---

updateASpecificEmbed()

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

Parameters

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

Returns

Promise<SCEmbedType>

Source

services/embed/index.ts:13