Skip to main content

DataPortabilityService

Data Portability service can be used in the following way:
1. Import the service from our library:

import {DataPortabilityService} from "@selfcommunity/api-services";
2. Create a function and put the service inside it!
The async function `generateDataPortability` will return the generated data portability.

async generateDataPortability() {
return await DataPortabilityService.generateDataPortability();
}
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

new DataPortabilityService()

new DataPortabilityService(): DataPortabilityService

Returns

DataPortabilityService

Methods

dataPortabilityStatus()

static dataPortabilityStatus(config?): Promise<SCDataPortabilityType>

Parameters

ParameterType
config?AxiosRequestConfig<any>

Returns

Promise<SCDataPortabilityType>

Source

services/data_portability/index.ts:81


downloadDataPortability()

static downloadDataPortability(config?): Promise<any>

Parameters

ParameterType
config?AxiosRequestConfig<any>

Returns

Promise<any>

Source

services/data_portability/index.ts:78


generateDataPortability()

static generateDataPortability(config?): Promise<SCDataPortabilityType>

Parameters

ParameterType
config?AxiosRequestConfig<any>

Returns

Promise<SCDataPortabilityType>

Source

services/data_portability/index.ts:75