Customers | @tillhub/javascript-sdk

Hierarchy

Customers

Index

Constructors

constructor

Properties

Methods

Constructors

constructor

new Customers(options: AnalyticsOptions, http: Client, uriHelper: UriHelper): Customers

- Defined in src/v0/analytics/reports/customers.ts:52
Parameters
- options: AnalyticsOptions
- http: Client
- uriHelper: UriHelper
Returns Customers

Properties

http

http: Client

options

options: AnalyticsOptions

uriHelper

uriHelper: UriHelper

Methods

getAll

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

- Defined in src/v0/analytics/reports/customers.ts:60
Parameters
- Optional query: CustomersQuery
Returns Promise<AnalyticsResponse>

getFilters

getFilters(query?: FiltersQuery): Promise<AnalyticsResponse>

- Defined in src/v0/analytics/reports/customers.ts:77
Parameters
- Optional query: FiltersQuery
Returns Promise<AnalyticsResponse>

getOverview

getOverview(query: CustomersOneQuery): Promise<AnalyticsResponse>

- Defined in src/v0/analytics/reports/customers.ts:118
Parameters
- query: CustomersOneQuery
Returns Promise<AnalyticsResponse>

getTransaction

getTransaction(query: CustomersOneQuery): Promise<AnalyticsResponse>

- Defined in src/v0/analytics/reports/customers.ts:101
Parameters
- query: CustomersOneQuery
Returns Promise<AnalyticsResponse>

meta

meta(query?: CustomersQuery): Promise<AnalyticsResponse>

- Defined in src/v0/analytics/reports/customers.ts:135
Parameters
- Optional query: CustomersQuery
Returns Promise<AnalyticsResponse>

Generated using TypeDoc