DataPortabilityApiClient
Contains all the endpoints needed to manage data portability.
Constructors
new DataPortabilityApiClient()
new DataPortabilityApiClient():
DataPortabilityApiClient
Returns
Methods
dataPortabilityStatus()
static
dataPortabilityStatus(config
?):Promise
<SCDataPortabilityType
>
This endpoint retrieves data portability status.
Parameters
Parameter | Type | Description |
---|---|---|
config ? | AxiosRequestConfig <any > |
Returns
Promise
<SCDataPortabilityType
>
Source
services/data_portability/index.ts:41
downloadDataPortability()
static
downloadDataPortability(config
?):Promise
<any
>
This endpoint downloads data portability.
Parameters
Parameter | Type | Description |
---|---|---|
config ? | AxiosRequestConfig <any > |
Returns
Promise
<any
>
Source
services/data_portability/index.ts:28
generateDataPortability()
static
generateDataPortability(config
?):Promise
<SCDataPortabilityType
>
This endpoint generates data portability.
Parameters
Parameter | Type | Description |
---|---|---|
config ? | AxiosRequestConfig <any > |
Returns
Promise
<SCDataPortabilityType
>