EmbedService

Embed service can be used in the following way:

1. Import the service from our library:

import {EmbedService} from "@selfcommunity/api-services";

2. Create a function and put the service inside it!
The async function `getAllEmbeds` will return the paginated list of embeds.

async getAllEmbeds() {
       return await EmbedService.getAllEmbeds();
     }

In case of required `params`, just add them inside the brackets.

async getSpecificEmbed(embedId) {
       return await EmbedService.getSpecificEmbed(embedId);
    }

If you need to customize the request, you can add optional config params (`AxiosRequestConfig` type).

1. Declare it(or declare them, it is possible to add multiple params)

const headers = headers: {Authorization: `Bearer ${yourToken}`}

2. Add it inside the brackets and pass it to the function, as shown in the previous example!

Constructors

Constructor

new EmbedService(): EmbedService

Returns

EmbedService

Methods

createEmbed()

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

Parameters

Parameter	Type
data	SCEmbedType
config?	AxiosRequestConfig

Returns

Promise<SCEmbedType>

---

getAllEmbeds()

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

Parameters

Parameter	Type
params?	BaseGetParams
config?	AxiosRequestConfig

Returns

Promise<SCPaginatedResponse<SCEmbedType>>

---

getEmbedFeed()

static 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()

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

Parameters

Parameter	Type
id	string | number
config?	AxiosRequestConfig

Returns

Promise<SCEmbedType>

---

getSpecificEmbedFeed()

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

Parameters

Parameter	Type
id	string | number
config?	AxiosRequestConfig

Returns

Promise<SCPaginatedResponse<SCFeedUnitType>>

---

patchASpecificEmbed()

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

Parameters

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

Returns

Promise<SCEmbedType>

---

searchEmbed()

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

Parameters

Parameter	Type
params?	EmbedSearchParams
config?	AxiosRequestConfig

Returns

Promise<SCPaginatedResponse<SCEmbedType>>

---

updateASpecificEmbed()

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

Parameters

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

Returns

Promise<SCEmbedType>