Interface: EmbedApiClientInterface
services/embed.EmbedApiClientInterface
Methods
createEmbed
▸ createEmbed(data
, config?
): Promise
<SCEmbedType
>
Parameters
Name | Type |
---|---|
data | SCEmbedType |
config? | AxiosRequestConfig <any > |
Returns
Promise
<SCEmbedType
>
Defined in
getAllEmbeds
▸ getAllEmbeds(params?
, config?
): Promise
<SCPaginatedResponse
<SCEmbedType
>>
Parameters
Name | Type |
---|---|
params? | BaseGetParams |
config? | AxiosRequestConfig <any > |
Returns
Promise
<SCPaginatedResponse
<SCEmbedType
>>
Defined in
getEmbedFeed
▸ getEmbedFeed(embed_type?
, embed_id?
, config?
): Promise
<SCPaginatedResponse
<SCFeedUnitType
>>
Parameters
Name | Type |
---|---|
embed_type? | string |
embed_id? | string |
config? | AxiosRequestConfig <any > |
Returns
Promise
<SCPaginatedResponse
<SCFeedUnitType
>>
Defined in
getSpecificEmbed
▸ getSpecificEmbed(id
, config?
): Promise
<SCEmbedType
>
Parameters
Name | Type |
---|---|
id | string | number |
config? | AxiosRequestConfig <any > |
Returns
Promise
<SCEmbedType
>
Defined in
getSpecificEmbedFeed
▸ getSpecificEmbedFeed(id
, config?
): Promise
<SCPaginatedResponse
<SCFeedUnitType
>>
Parameters
Name | Type |
---|---|
id | string | number |
config? | AxiosRequestConfig <any > |
Returns
Promise
<SCPaginatedResponse
<SCFeedUnitType
>>
Defined in
patchASpecificEmbed
▸ patchASpecificEmbed(id
, data?
, config?
): Promise
<SCEmbedType
>
Parameters
Name | Type |
---|---|
id | string | number |
data? | EmbedUpdateParams |
config? | AxiosRequestConfig <any > |
Returns
Promise
<SCEmbedType
>
Defined in
searchEmbed
▸ searchEmbed(params?
, config?
): Promise
<SCPaginatedResponse
<SCEmbedType
>>
Parameters
Name | Type |
---|---|
params? | EmbedSearchParams |
config? | AxiosRequestConfig <any > |
Returns
Promise
<SCPaginatedResponse
<SCEmbedType
>>
Defined in
updateASpecificEmbed
▸ updateASpecificEmbed(id
, data?
, config?
): Promise
<SCEmbedType
>
Parameters
Name | Type |
---|---|
id | string | number |
data? | EmbedUpdateParams |
config? | AxiosRequestConfig <any > |
Returns
Promise
<SCEmbedType
>