Class BankUserService

Hierarchy

BankUserService

Index

Constructors

constructor

Methods

Constructors

constructor

new BankUserService(): BankUserService

- Defined in lib/services/api-bank-user-service.ts:4
Returns BankUserService

Methods

create

create(request: BankUserRequest): Promise<BankUser>

- Defined in lib/services/api-bank-user-service.ts:36
Create a xs2a.api bank user

Parameters
- request: BankUserRequest
Returns Promise<BankUser>

createAccessToken

createAccessToken(userId: string, validUntil: string): Promise<BankUserAccessToken>

- Defined in lib/services/api-bank-user-service.ts:92
Create a bank user access token

Parameters
- userId: string
  
  bank-user-id of the bank user to create an accesstoken for
- validUntil: string
  
  The accesstoken will be valid until the given date (Format: YYYY-MM-DD hh:mm:ss).
Returns Promise<BankUserAccessToken>

delete

delete(userId: string): Promise<any>

- Defined in lib/services/api-bank-user-service.ts:72
Delete a xs2a.api bank user by user-id

Parameters
- userId: string
  
  id of user to be retrieved
Returns Promise<any>

deleteAccessToken

deleteAccessToken(userId: string, tokenId: string): Promise<any>

- Defined in lib/services/api-bank-user-service.ts:172
Delete an accesstoken

Parameters
- userId: string
  
  The user-id for the user to delete a specific accesstoken for.
- tokenId: string
  
  ID of the accesstoken to delete.
Returns Promise<any>

get

get(userId: string): Promise<BankUser>

- Defined in lib/services/api-bank-user-service.ts:54
Get a xs2a.api bank user by user-id

Parameters
- userId: string
  
  id of user to be retrieved
Returns Promise<BankUser>

getAccessToken

getAccessToken(userId: string, tokenId: string): Promise<BankUserAccessToken>

- Defined in lib/services/api-bank-user-service.ts:131
Get a specific accesstoken for a xs2a.api bank user

Parameters
- userId: string
  
  The user-id for the user to retrieve a specific accesstoken for.
- tokenId: string
  
  ID of the accesstoken to get.
Returns Promise<BankUserAccessToken>

list

list(perPage?: number, page?: number): Promise<BankUserList>

- Defined in lib/services/api-bank-user-service.ts:13
Get a list of all xs2a.api bank users

Parameters
- Default value perPage: number = 15
  
  Items per page
- Default value page: number = 1
  
  page to display
Returns Promise<BankUserList>

listAccessTokens

listAccessTokens(userId: string): Promise<BankUserAccessTokenList>

- Defined in lib/services/api-bank-user-service.ts:112
Get a list of accesstokens for a xs2a.api bank user

Parameters
- userId: string
  
  The user-id for the user to retrieve all accesstoken for.
Returns Promise<BankUserAccessTokenList>

refreshAccessToken

refreshAccessToken(userId: string, tokenId: string, validUntil: string): Promise<BankUserAccessToken>

- Defined in lib/services/api-bank-user-service.ts:151
Refresh an accesstoken

Parameters
- userId: string
  
  The user-id for the user to refresh a specific accesstoken for.
- tokenId: string
  
  ID of the accesstoken to refresh.
- validUntil: string
  
  The accesstoken is valid until the given date (Format: YYYY-MM-DD hh:mm:ss).
Returns Promise<BankUserAccessToken>

Generated using TypeDoc