IncubatorApiClient

Contains all the endpoints needed to manage incubators.

Constructors

new IncubatorApiClient()

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<any>

Returns

Promise<SCIncubatorSubscriptionType>

Source

services/incubator/index.ts:83

---

createIncubator()

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

This endpoint creates an incubator.

Parameters

Parameter	Type	Description
data	IncubatorCreateParams
config?	AxiosRequestConfig<any>

Returns

Promise<SCIncubatorType>

Source

services/incubator/index.ts:56

---

getAllIncubators()

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

This endpoint retrieves all incubators.

Parameters

Parameter	Type	Description
params?	IncubatorSearchParams
config?	AxiosRequestConfig<any>

Returns

Promise <SCPaginatedResponse<SCIncubatorType>>

Source

services/incubator/index.ts:27

---

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<any>

Returns

Promise <SCPaginatedResponse<SCUserType>>

Source

services/incubator/index.ts:65

---

getSpecificIncubator()

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

This endpoint retrieves a specific incubator.

Parameters

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

Returns

Promise<SCIncubatorType>

Source

services/incubator/index.ts:47

---

searchIncubators()

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

This endpoint performs search od Incubators

Parameters

Parameter	Type	Description
params?	IncubatorSearchParams
config?	AxiosRequestConfig<any>

Returns

Promise <SCPaginatedResponse<SCIncubatorType>>

Source

services/incubator/index.ts:37

---

subscribeToIncubator()

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

This endpoint subscribes to an incubator.

Parameters

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

Returns

Promise<any>

Source

services/incubator/index.ts:74