EmbedApiClientInterface

Methods

createEmbed()

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

Parameters

Parameter	Type
data	SCEmbedType
config?	AxiosRequestConfig

Returns

Promise<SCEmbedType>

---

getAllEmbeds()

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

Parameters

Parameter	Type
params?	BaseGetParams
config?	AxiosRequestConfig

Returns

Promise<SCPaginatedResponse<SCEmbedType>>

---

getEmbedFeed()

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

Parameters

Parameter	Type
embed_type?	string
embed_id?	string
config?	AxiosRequestConfig

Returns

Promise<SCPaginatedResponse<SCFeedUnitType>>

---

getSpecificEmbed()

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

Parameters

Parameter	Type
id	string | number
config?	AxiosRequestConfig

Returns

Promise<SCEmbedType>

---

getSpecificEmbedFeed()

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

Parameters

Parameter	Type
id	string | number
config?	AxiosRequestConfig

Returns

Promise<SCPaginatedResponse<SCFeedUnitType>>

---

patchASpecificEmbed()

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

Parameters

Parameter	Type
id	string | number
data?	EmbedUpdateParams
config?	AxiosRequestConfig

Returns

Promise<SCEmbedType>

---

searchEmbed()

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

Parameters

Parameter	Type
params?	EmbedSearchParams
config?	AxiosRequestConfig

Returns

Promise<SCPaginatedResponse<SCEmbedType>>

---

updateASpecificEmbed()

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

Parameters

Parameter	Type
id	string | number
data?	EmbedUpdateParams
config?	AxiosRequestConfig

Returns

Promise<SCEmbedType>