ConsignmentNotes | @tillhub/javascript-sdk

Hierarchy

ThBaseHandler
- ConsignmentNotes

Index

Constructors

constructor

Properties

Methods

Constructors

constructor

new ConsignmentNotes(options: ConsignmentNotesOptions, http: Client): ConsignmentNotes

Overrides ThBaseHandler.constructor
- Defined in src/v0/consignment_notes.ts:49
Parameters
- options: ConsignmentNotesOptions
- http: Client
Returns ConsignmentNotes

Properties

endpoint

endpoint: string

http

http: Client

options

options: ConsignmentNotesOptions

uriHelper

uriHelper: UriHelper

Static baseEndpoint

baseEndpoint: string = '/api/v0/consignment-notes'

Methods

getAll

getAll(options?: ConsignmentNotesOptions): Promise<ConsignmentNotesResponse>

- Defined in src/v0/consignment_notes.ts:64
Parameters
- Optional options: ConsignmentNotesOptions
Returns Promise<ConsignmentNotesResponse>

meta

meta(q?: ConsignmentNotesMetaQuery): Promise<ConsignmentNotesResponse>

- Defined in src/v0/consignment_notes.ts:92
Parameters
- Optional q: ConsignmentNotesMetaQuery
Returns Promise<ConsignmentNotesResponse>

pdfUri

pdfUri(consignmentNoteId: string): Promise<ConsignmentNotesPdfResponse>

- Defined in src/v0/consignment_notes.ts:113
Parameters
- consignmentNoteId: string
Returns Promise<ConsignmentNotesPdfResponse>

Generated using TypeDoc