Deliveries | @tillhub/javascript-sdk

Hierarchy

ThBaseHandler
- Deliveries

Index

Constructors

constructor

Properties

Methods

Constructors

constructor

new Deliveries(options: DeliveriesOptions, http: Client): Deliveries

Overrides ThBaseHandler.constructor
- Defined in src/v0/deliveries.ts:145
Parameters
- options: DeliveriesOptions
- http: Client
Returns Deliveries

Properties

endpoint

endpoint: string

http

http: Client

options

options: DeliveriesOptions

uriHelper

uriHelper: UriHelper

Static baseEndpoint

baseEndpoint: string = '/api/v0/deliveries'

Methods

createDelivery

createDelivery(requestObject: DeliveriesCreateRequestObject): Promise<DeliveriesResponse>

- Defined in src/v0/deliveries.ts:216
Parameters
- requestObject: DeliveriesCreateRequestObject
Returns Promise<DeliveriesResponse>

createDeliveryItems

createDeliveryItems(requestObject: DeliveryItemsCreateRequestObject): Promise<DeliveriesResponse>

- Defined in src/v0/deliveries.ts:315
Parameters
- requestObject: DeliveryItemsCreateRequestObject
Returns Promise<DeliveriesResponse>

createDeliveryPDF

createDeliveryPDF(deliveryId: string): Promise<DeliveriesResponse>

- Defined in src/v0/deliveries.ts:233
Parameters
- deliveryId: string
Returns Promise<DeliveriesResponse>

deleteDelivery

deleteDelivery(deliveryId: string): Promise<DeliveriesResponse>

- Defined in src/v0/deliveries.ts:302
Parameters
- deliveryId: string
Returns Promise<DeliveriesResponse>

deleteDeliveryItem

deleteDeliveryItem(itemId: string): Promise<DeliveriesResponse>

- Defined in src/v0/deliveries.ts:370
Parameters
- itemId: string
Returns Promise<DeliveriesResponse>

dispatchDelivery

dispatchDelivery(requestObject: DeliveriesSimpleUpdateRequestBody): Promise<DeliveriesResponse>

- Defined in src/v0/deliveries.ts:285
Parameters
- requestObject: DeliveriesSimpleUpdateRequestBody
Returns Promise<DeliveriesResponse>

generateUriQueryEmbed

generateUriQueryEmbed(base: string, query?: DeliveriesQuery): string

- Defined in src/v0/deliveries.ts:160
Parameters
- base: string
- Optional query: DeliveriesQuery
Returns string

getAll

getAll(query?: DeliveriesQuery): Promise<DeliveriesResponse>

- Defined in src/v0/deliveries.ts:177
Parameters
- Optional query: DeliveriesQuery
Returns Promise<DeliveriesResponse>

getAllDeliveryItems

getAllDeliveryItems(requestObject: DeliveryItemsGetAllRequestObject): Promise<DeliveriesResponse>

- Defined in src/v0/deliveries.ts:334
Parameters
- requestObject: DeliveryItemsGetAllRequestObject
Returns Promise<DeliveriesResponse>

getOne

getOne(requestObject: DeliveriesGetOneRequestObject): Promise<DeliveriesResponse>

- Defined in src/v0/deliveries.ts:199
Parameters
- requestObject: DeliveriesGetOneRequestObject
Returns Promise<DeliveriesResponse>

setInProgress

setInProgress(requestObject: DeliveriesSimpleUpdateRequestBody): Promise<DeliveriesResponse>

- Defined in src/v0/deliveries.ts:268
Parameters
- requestObject: DeliveriesSimpleUpdateRequestBody
Returns Promise<DeliveriesResponse>

updateDelivery

updateDelivery(requestObject: DeliveriesUpdateRequestObject): Promise<DeliveriesResponse>

- Defined in src/v0/deliveries.ts:251
Parameters
- requestObject: DeliveriesUpdateRequestObject
Returns Promise<DeliveriesResponse>

updateDeliveryItem

updateDeliveryItem(requestObject: DeliveryItemUpdateRequestObject): Promise<DeliveriesResponse>

- Defined in src/v0/deliveries.ts:353
Parameters
- requestObject: DeliveryItemUpdateRequestObject
Returns Promise<DeliveriesResponse>

Generated using TypeDoc