OrderActions | @tillhub/javascript-sdk

Hierarchy

ThBaseHandler
- OrderActions

Index

Constructors

constructor

Properties

Methods

Constructors

constructor

new OrderActions(options: OrderActionsOptions, http: Client): OrderActions

Overrides ThBaseHandler.constructor
- Defined in src/v2/order-actions.ts:208
Parameters
- options: OrderActionsOptions
- http: Client
Returns OrderActions

Properties

endpoint

endpoint: string

http

http: Client

options

options: OrderActionsOptions

uriHelper

uriHelper: UriHelper

Static baseEndpoint

baseEndpoint: string = '/api/v2/orders'

Methods

authorize

authorize(keypairId: string, transaction: TransactionAuthorize): Promise<TransactionAuthorizeResponse>

- Defined in src/v2/order-actions.ts:293
Parameters
- keypairId: string
- transaction: TransactionAuthorize
Returns Promise<TransactionAuthorizeResponse>

charge

charge(keypairId: string, transaction: TransactionCharge): Promise<TransactionChargeResponse>

- Defined in src/v2/order-actions.ts:307
Parameters
- keypairId: string
- transaction: TransactionCharge
Returns Promise<TransactionChargeResponse>

createBasket

createBasket(keypairId: string, basket: Basket): Promise<TransactionBasketResponse>

- Defined in src/v2/order-actions.ts:279
Parameters
- keypairId: string
- basket: Basket
Returns Promise<TransactionBasketResponse>

orderCancel

orderCancel(orderId: string, payload: AuthorizeCancelRequest): Promise<AuthorizeCancelResponse>

- Defined in src/v2/order-actions.ts:242
Parameters
- orderId: string
- payload: AuthorizeCancelRequest
Returns Promise<AuthorizeCancelResponse>

orderCapture

orderCapture(orderId: string, payload: AuthorizeChargeRequest): Promise<AuthorizeChargeResponse>

- Defined in src/v2/order-actions.ts:261
Parameters
- orderId: string
- payload: AuthorizeChargeRequest
Returns Promise<AuthorizeChargeResponse>

orderRefund

orderRefund(orderId: string, payload: ChargeCancelRequest): Promise<ChargeCancelResponse>

- Defined in src/v2/order-actions.ts:223
Parameters
- orderId: string
- payload: ChargeCancelRequest
Returns Promise<ChargeCancelResponse>

Generated using TypeDoc