TransactionApi | ahoi-swagger-fetchclient

TransactionApi - object-oriented interface

export
class: TransactionApi
extends: {BaseAPI}

Hierarchy

BaseAPI
- TransactionApi

Index

Constructors

constructor

Methods

Constructors

constructor

new TransactionApi(configuration?: Configuration, basePath?: string, fetch?: FetchAPI): TransactionApi

Inherited from BaseAPI.constructor
- Defined in api.ts:58
Parameters
- Optional configuration: Configuration
- Default value basePath: string = BASE_PATH
- Default value fetch: FetchAPI = portableFetch
Returns TransactionApi

Methods

getTransaction

getTransaction(accessId: string, accountId: string, transactionId: string, options?: any): Promise<Transaction>

- Defined in api.ts:4994
Returns the transaction identified by transactionId in relation to accountId.

summary

Get transaction

throws

{RequiredError}

memberof

TransactionApi

Parameters
- accessId: string
  
  The accessId for the transaction to retrieve
- accountId: string
  
  The accountId for the transaction to retrieve
- transactionId: string
  
  The transactionId for the pattern to retrieve
- Optional options: any
Returns Promise<Transaction>

listTransactions

listTransactions(accessId: string, accountId: string, maxAge?: number, limit?: number, offset?: number, from?: string, to?: string, options?: any): Promise<Transaction[]>

- Defined in api.ts:5012
Retrieve all transactions for accountId

summary

List transactions for account

throws

{RequiredError}

memberof

TransactionApi

Parameters
- accessId: string
  
  The accessId for which to retrieve transactions
- accountId: string
  
  The accountId for which to retrieve transactions
- Optional maxAge: number
- Optional limit: number
- Optional offset: number
- Optional from: string
- Optional to: string
- Optional options: any
Returns Promise<Transaction[]>

listTransactionsForPattern

listTransactionsForPattern(accessId: string, accountId: string, patternId: string, maxAge?: number, limit?: number, offset?: number, from?: string, to?: string, options?: any): Promise<Transaction[]>

- Defined in api.ts:5031
Retrieve all transactions for patternId

summary

List transactions for pattern

throws

{RequiredError}

memberof

TransactionApi

Parameters
- accessId: string
  
  The accessId for which to retrieve transactions
- accountId: string
  
  The accountId for which to retrieve transactions
- patternId: string
  
  The patternId for which to retrieve transactions
- Optional maxAge: number
- Optional limit: number
- Optional offset: number
- Optional from: string
- Optional to: string
- Optional options: any
Returns Promise<Transaction[]>

Hierarchy

Index

Constructors

Methods

Constructors

constructor

Parameters

Optional configuration: Configuration

Default value basePath: string = BASE_PATH

Default value fetch: FetchAPI = portableFetch

Returns TransactionApi

Methods

getTransaction

Parameters

accessId: string

accountId: string

transactionId: string

Optional options: any

Returns Promise<Transaction>

listTransactions

Parameters

accessId: string

accountId: string

Optional maxAge: number

Optional limit: number

Optional offset: number

Optional from: string

Optional to: string

Optional options: any

Returns Promise<Transaction[]>

listTransactionsForPattern

Parameters

accessId: string

accountId: string

patternId: string

Optional maxAge: number

Optional limit: number

Optional offset: number

Optional from: string

Optional to: string

Optional options: any

Returns Promise<Transaction[]>