Suppliers | @tillhub/javascript-sdk

Hierarchy

ThBaseHandler
- Suppliers

Index

Constructors

constructor

Properties

Methods

Constructors

constructor

new Suppliers(options: SuppliersOptions, http: Client): Suppliers

Overrides ThBaseHandler.constructor
- Defined in src/v0/suppliers.ts:149
Parameters
- options: SuppliersOptions
- http: Client
Returns Suppliers

Properties

endpoint

endpoint: string

http

http: Client

options

options: SuppliersOptions

uriHelper

uriHelper: UriHelper

Static baseEndpoint

baseEndpoint: string = '/api/v0/business-partners'

Methods

bulkCreate

bulkCreate(suppliers: Supplier[], query?: HandlerSupplierQuery): Promise<SuppliersBulkResponse>

- Defined in src/v0/suppliers.ts:245
Parameters
- suppliers: Supplier[]
- Optional query: HandlerSupplierQuery
Returns Promise<SuppliersBulkResponse>

create

create(supplier: Supplier, query?: HandlerSupplierQuery): Promise<SupplierResponse>

- Defined in src/v0/suppliers.ts:226
Parameters
- supplier: Supplier
- Optional query: HandlerSupplierQuery
Returns Promise<SupplierResponse>

delete

delete(supplierId: string): Promise<SupplierResponse>

- Defined in src/v0/suppliers.ts:292
Parameters
- supplierId: string
Returns Promise<SupplierResponse>

export

export(query?: SuppliersQuery): Promise<SuppliersExportResponse>

- Defined in src/v0/suppliers.ts:307
Parameters
- Optional query: SuppliersQuery
Returns Promise<SuppliersExportResponse>

get

get(supplierId: string, query: SuppliersQuery): Promise<SupplierResponse>

- Defined in src/v0/suppliers.ts:189
Parameters
- supplierId: string
- query: SuppliersQuery
Returns Promise<SupplierResponse>

getAll

getAll(query?: SuppliersQuery): Promise<SuppliersResponse>

- Defined in src/v0/suppliers.ts:164
Parameters
- Optional query: SuppliersQuery
Returns Promise<SuppliersResponse>

meta

meta(q?: SuppliersMetaQuery): Promise<SuppliersResponse>

- Defined in src/v0/suppliers.ts:271
Parameters
- Optional q: SuppliersMetaQuery
Returns Promise<SuppliersResponse>

put

put(supplierId: string, supplier: Supplier): Promise<SupplierResponse>

- Defined in src/v0/suppliers.ts:209
Parameters
- supplierId: string
- supplier: Supplier
Returns Promise<SupplierResponse>

Generated using TypeDoc