IncubatorApiClient

Contains all the endpoints needed to manage incubators.

Constructors

Constructor

new IncubatorApiClient(): IncubatorApiClient

Returns

IncubatorApiClient

Methods

checkIncubatorSubscription()

static checkIncubatorSubscription(id, config?): Promise<SCIncubatorSubscriptionType>

This endpoint returns subscribed = true if the incubator (identified in path) is subscribed by the authenticated user.

Parameters

Parameter	Type	Description
id	string | number
config?	AxiosRequestConfig

Returns

Promise<SCIncubatorSubscriptionType>

---

createIncubator()

static createIncubator(data, config?): Promise<SCIncubatorType>

This endpoint creates an incubator.

Parameters

Parameter	Type	Description
data	IncubatorCreateParams
config?	AxiosRequestConfig

Returns

Promise<SCIncubatorType>

---

getAllIncubators()

static getAllIncubators(params?, config?): Promise<SCPaginatedResponse<SCIncubatorType>>

This endpoint retrieves all incubators.

Parameters

Parameter	Type	Description
params?	IncubatorSearchParams
config?	AxiosRequestConfig

Returns

Promise<SCPaginatedResponse<SCIncubatorType>>

---

getIncubatorSubscribers()

static getIncubatorSubscribers(id, config?): Promise<SCPaginatedResponse<SCUserType>>

This endpoint returns all subscribers of a specific incubator.

Parameters

Parameter	Type	Description
id	string | number
config?	AxiosRequestConfig

Returns

Promise<SCPaginatedResponse<SCUserType>>

---

getSpecificIncubator()

static getSpecificIncubator(id, config?): Promise<SCIncubatorType>

This endpoint retrieves a specific incubator.

Parameters

Parameter	Type	Description
id	string | number
config?	AxiosRequestConfig

Returns

Promise<SCIncubatorType>

---

searchIncubators()

static searchIncubators(params?, config?): Promise<SCPaginatedResponse<SCIncubatorType>>

This endpoint performs search od Incubators

Parameters

Parameter	Type	Description
params?	IncubatorSearchParams
config?	AxiosRequestConfig

Returns

Promise<SCPaginatedResponse<SCIncubatorType>>

---

subscribeToIncubator()

static subscribeToIncubator(id, config?): Promise<any>

This endpoint subscribes to an incubator.

Parameters

Parameter	Type	Description
id	string | number
config?	AxiosRequestConfig

Returns

Promise<any>