Transactions | @tillhub/javascript-sdk

Hierarchy

ThBaseHandler
- Transactions

Index

Constructors

constructor

Properties

Methods

Constructors

constructor

new Transactions(options: AnalyticsOptions, http: Client): Transactions

Overrides ThBaseHandler.constructor
- Defined in src/v1/transactions.ts:54
Parameters
- options: AnalyticsOptions
- http: Client
Returns Transactions

Properties

endpoint

endpoint: string

http

http: Client

options

options: AnalyticsOptions

timeout

timeout: undefined | number

uriHelper

uriHelper: UriHelper

Static baseEndpoint

baseEndpoint: string = '/api/v1/transactions'

Methods

createImage

createImage(transactionId: string, image: TransactionImage): Promise<TransactionImageResponse>

- Defined in src/v1/transactions.ts:144
Parameters
- transactionId: string
- image: TransactionImage
Returns Promise<TransactionImageResponse>

getAll

getAll(query?: TransactionsQuery): Promise<TransactionResponse>

- Defined in src/v1/transactions.ts:70
Parameters
- Optional query: TransactionsQuery
Returns Promise<TransactionResponse>

getImages

getImages(transactionId: string): Promise<TransactionResponse>

- Defined in src/v1/transactions.ts:110
Parameters
- transactionId: string
Returns Promise<TransactionResponse>

meta

meta(q?: TransactionsMetaQuery): Promise<TransactionResponse>

- Defined in src/v1/transactions.ts:92
Parameters
- Optional q: TransactionsMetaQuery
Returns Promise<TransactionResponse>

putImage

putImage(transactionId: string, image: TransactionImage): Promise<TransactionImageResponse>

- Defined in src/v1/transactions.ts:127
Parameters
- transactionId: string
- image: TransactionImage
Returns Promise<TransactionImageResponse>

Generated using TypeDoc