TransactionBatches | @tillhub/javascript-sdk

Hierarchy

TransactionBatches

Index

Constructors

constructor

Properties

Methods

Constructors

constructor

new TransactionBatches(options: TransactionBatchesOptions, http: Client): TransactionBatches

- Defined in src/v0/transaction_batches.ts:73
Parameters
- options: TransactionBatchesOptions
- http: Client
Returns TransactionBatches

Properties

endpoint

endpoint: string

http

http: Client

options

options: TransactionBatchesOptions

uriHelper

uriHelper: UriHelper

Methods

download

download(id: string | number, fileName: string): Promise<Blob>

- Defined in src/v0/transaction_batches.ts:140
Download the processed batch file. GET /api/v0/transaction-batches/:id/download

Parameters
- id: string | number
- fileName: string
Returns Promise<Blob>

downloadInput

downloadInput(id: string | number, inputFileName: string): Promise<Blob>

- Defined in src/v0/transaction_batches.ts:161
Download the originally uploaded file (before processing). GET /api/v0/transaction-batches/:id/download-input

Parameters
- id: string | number
- inputFileName: string
Returns Promise<Blob>

getAll

getAll(query?: TransactionBatchesQueryHandler): Promise<TransactionBatchesListResponse>

- Defined in src/v0/transaction_batches.ts:88
List transaction batches. GET /api/v0/transaction-batches

Parameters
- Optional query: TransactionBatchesQueryHandler
Returns Promise<TransactionBatchesListResponse>

meta

meta(query?: TransactionBatchesQueryHandler): Promise<TransactionBatchesMetaData>

- Defined in src/v0/transaction_batches.ts:118
Get transaction batches metadata (e.g. total count). GET /api/v0/transaction-batches/meta

Parameters
- Optional query: TransactionBatchesQueryHandler
Returns Promise<TransactionBatchesMetaData>

upload

upload(payload: FileUploadPayload): Promise<TransactionBatchUploadResponse>

- Defined in src/v0/transaction_batches.ts:182
Upload a transaction batch file via multipart/form-data. POST /api/v0/transaction-batches/upload

Parameters
- payload: FileUploadPayload
Returns Promise<TransactionBatchUploadResponse>

Generated using TypeDoc