Customers | @tillhub/javascript-sdk

Hierarchy

ThBaseHandler
- Customers

Index

Constructors

constructor

Properties

Methods

Constructors

constructor

new Customers(options: CustomersOptions, http: Client): Customers

Overrides ThBaseHandler.constructor
- Defined in src/v0/customers.ts:164
Parameters
- options: CustomersOptions
- http: Client
Returns Customers

Properties

endpoint

endpoint: string

http

http: Client

options

options: CustomersOptions

uriHelper

uriHelper: UriHelper

Static baseEndpoint

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

Methods

bulkCreate

bulkCreate(customers: Customer[], query?: HandlerCustomerQuery): Promise<CustomersBulkResponse>

- Defined in src/v0/customers.ts:279
Parameters
- customers: Customer[]
- Optional query: HandlerCustomerQuery
Returns Promise<CustomersBulkResponse>

count

count(): Promise<CustomersResponse>

- Defined in src/v0/customers.ts:341
Returns Promise<CustomersResponse>

create

create(customer: Customer, query?: HandlerCustomerQuery): Promise<CustomerResponse>

- Defined in src/v0/customers.ts:260
Parameters
- customer: Customer
- Optional query: HandlerCustomerQuery
Returns Promise<CustomerResponse>

createNote

createNote(customerId: string, note: CustomerNoteItem): Promise<CustomerResponse>

- Defined in src/v0/customers.ts:224
Parameters
- customerId: string
- note: CustomerNoteItem
Returns Promise<CustomerResponse>

delete

delete(customerId: string): Promise<CustomerResponse>

- Defined in src/v0/customers.ts:326
Parameters
- customerId: string
Returns Promise<CustomerResponse>

get

get(customerId: string, query: CustomersQuery): Promise<CustomerResponse>

- Defined in src/v0/customers.ts:204
Parameters
- customerId: string
- query: CustomersQuery
Returns Promise<CustomerResponse>

getAll

getAll(query?: CustomersQuery): Promise<CustomersResponse>

- Defined in src/v0/customers.ts:179
Parameters
- Optional query: CustomersQuery
Returns Promise<CustomersResponse>

meta

meta(q?: CustomersMetaQuery): Promise<CustomersResponse>

- Defined in src/v0/customers.ts:305
Parameters
- Optional q: CustomersMetaQuery
Returns Promise<CustomersResponse>

put

put(customerId: string, customer: Customer): Promise<CustomerResponse>

- Defined in src/v0/customers.ts:243
Parameters
- customerId: string
- customer: Customer
Returns Promise<CustomerResponse>

search

search(searchTerm: string): Promise<CustomersResponse>

- Defined in src/v0/customers.ts:358
Parameters
- searchTerm: string
Returns Promise<CustomersResponse>

Generated using TypeDoc