Class: IncubatorApiClient
services/incubator.IncubatorApiClient
Contains all the endpoints needed to manage incubators.
Constructors
constructor
• new IncubatorApiClient(): IncubatorApiClient
Returns
Methods
checkIncubatorSubscription
▸ checkIncubatorSubscription(id, config?): Promise<SCIncubatorSubscriptionType>
This endpoint returns subscribed = true if the incubator (identified in path) is subscribed by the authenticated user.
Parameters
| Name | Type |
|---|---|
id | string | number |
config? | AxiosRequestConfig<any> |
Returns
Promise<SCIncubatorSubscriptionType>
Defined in
services/incubator/index.ts:83
createIncubator
▸ createIncubator(data, config?): Promise<SCIncubatorType>
This endpoint creates an incubator.
Parameters
| Name | Type |
|---|---|
data | IncubatorCreateParams |
config? | AxiosRequestConfig<any> |
Returns
Promise<SCIncubatorType>
Defined in
services/incubator/index.ts:56
getAllIncubators
▸ getAllIncubators(params?, config?): Promise<SCPaginatedResponse<SCIncubatorType>>
This endpoint retrieves all incubators.
Parameters
| Name | Type |
|---|---|
params? | IncubatorSearchParams |
config? | AxiosRequestConfig<any> |
Returns
Promise<SCPaginatedResponse<SCIncubatorType>>
Defined in
services/incubator/index.ts:27
getIncubatorSubscribers
▸ getIncubatorSubscribers(id, config?): Promise<SCPaginatedResponse<SCUserType>>
This endpoint returns all subscribers of a specific incubator.
Parameters
| Name | Type |
|---|---|
id | string | number |
config? | AxiosRequestConfig<any> |
Returns
Promise<SCPaginatedResponse<SCUserType>>
Defined in
services/incubator/index.ts:65
getSpecificIncubator
▸ getSpecificIncubator(id, config?): Promise<SCIncubatorType>
This endpoint retrieves a specific incubator.
Parameters
| Name | Type |
|---|---|
id | string | number |
config? | AxiosRequestConfig<any> |
Returns
Promise<SCIncubatorType>
Defined in
services/incubator/index.ts:47
searchIncubators
▸ searchIncubators(params?, config?): Promise<SCPaginatedResponse<SCIncubatorType>>
This endpoint performs search od Incubators
Parameters
| Name | Type |
|---|---|
params? | IncubatorSearchParams |
config? | AxiosRequestConfig<any> |
Returns
Promise<SCPaginatedResponse<SCIncubatorType>>
Defined in
services/incubator/index.ts:37
subscribeToIncubator
▸ subscribeToIncubator(id, config?): Promise<any>
This endpoint subscribes to an incubator.
Parameters
| Name | Type |
|---|---|
id | string | number |
config? | AxiosRequestConfig<any> |
Returns
Promise<any>