Hierarchy

  • DigimeSDK

Authorization

exchangeCodeForToken: ((props: ExchangeCodeForTokenOptions) => Promise<UserAccessToken>)

Type declaration

getAuthorizeUrl: ((props: GetAuthorizeUrlOptions) => Promise<GetAuthorizeUrlResponse>)

Type declaration

    • (props: GetAuthorizeUrlOptions): Promise<GetAuthorizeUrlResponse>
    • In order to push or read data from digi.me, we first need to create an access token. Access tokens are linked to a contract, and it is possible to create multiple access tokens that access to the same digi.me libary. This function is called when:

      • Authorize a new user. You have the option to also onboard a service during this process.
      • An existing user authorizing a new contract.
      • Existing user’s refresh token has expired and we need to extend it.
      // run typedoc --help for a list of supported languages
      const instance = new MyClass();

      Parameters

      Returns Promise<GetAuthorizeUrlResponse>

getOnboardServiceUrl: ((props: GetOnboardServiceUrlOptions) => Promise<GetOnboardServiceUrlResponse>)

Type declaration

getReauthorizeAccountUrl: ((props: GetReauthorizeAccountUrlOptions) => Promise<GetReauthorizeAccountUrlResponse>)

Type declaration

getRevokeAccountPermissionUrl: ((props: GetRevokeAccountPermissionUrlOptions) => Promise<GetRevokeAccountPermissionUrlResponse>)

Type declaration

refreshToken: ((props: RefreshTokenOptions) => Promise<UserAccessToken>)

Type declaration

Delete

deleteAccount: ((props: DeleteAccountOptions) => Promise<DeleteAccountResponse>)

Type declaration

deleteUser: ((props: DeleteUserOptions) => Promise<DeleteUserResponse>)

Type declaration

Other

getPortabilityReport: ((props: GetPortabilityReportOptions) => Promise<GetPortabilityReportResponse>)

Type declaration

Push

pushData: ((props: PushDataOptions) => Promise<void>)

Type declaration

    • (props: PushDataOptions): Promise<void>
    • Push something to the user's digi.me library or to provider

      Parameters

      Returns Promise<void>

Read

getAvailableServices: ((props: GetAvailableServicesOptions) => Promise<GetAvailableServicesResponse>)

Type declaration

getServiceSampleDataSets: ((props: GetServiceSampleDataSetsOptions) => Promise<GetServiceSampleDataSetsResponse>)

Type declaration

readAccounts: ((props: ReadAccountsOptions) => Promise<ReadAccountsResponse>)

Type declaration

readAllFiles: ((props: ReadAllFilesOptions) => ReadAllFilesResponse)

Type declaration

readFile: ((props: ReadFileOptions) => Promise<ReadFileResponse>)

Type declaration

readFileList: ((props: ReadFileListOptions) => Promise<ReadFileListResponse>)

Type declaration

readSession: ((props: ReadSessionOptions) => Promise<ReadSessionResponse>)

Type declaration

Generated using TypeDoc