AnalyticsReportsCustomers | @tillhub/javascript-sdk

Hierarchy

ThAnalyticsBaseHandler
- AnalyticsReportsCustomers

Index

Constructors

constructor

Properties

Methods

Constructors

constructor

new AnalyticsReportsCustomers(options: CustomersHandlerOptions, http: Client): AnalyticsReportsCustomers

Overrides ThAnalyticsBaseHandler.constructor
- Defined in src/v1/analytics/reports/customers.ts:26
Parameters
- options: CustomersHandlerOptions
- http: Client
Returns AnalyticsReportsCustomers

Properties

http

http: Client

options

options: CustomersHandlerOptions

timeout

timeout: undefined | number

Methods

getAll

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

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

Protected handleExport

handleExport(url: string, query?: HandlerQuery, requestOptions?: any): Promise<ThAnalyticsExportsBaseResponse>

Inherited from ThAnalyticsBaseHandler.handleExport
- Defined in src/base/handler.ts:122
Parameters
- url: string
- Optional query: HandlerQuery
- Optional requestOptions: any
Returns Promise<ThAnalyticsExportsBaseResponse>

Protected handleGet

handleGet(url: string, query?: HandlerQuery, requestOptions?: any): Promise<ThAnalyticsBaseResponse>

Inherited from ThAnalyticsBaseHandler.handleGet
- Defined in src/base/handler.ts:102
Parameters
- url: string
- Optional query: HandlerQuery
- Optional requestOptions: any
Returns Promise<ThAnalyticsBaseResponse>

Protected handleSocketsExport

handleSocketsExport(url: string, query?: HandlerQuery, requestOptions?: any): Promise<AnalyticsSocketsExportResponseItem>

Inherited from ThAnalyticsBaseHandler.handleSocketsExport
- Defined in src/base/handler.ts:139
Parameters
- url: string
- Optional query: HandlerQuery
- Optional requestOptions: any
Returns Promise<AnalyticsSocketsExportResponseItem>

Static create

create(options: Record<string, unknown>, http: Client): AnalyticsReportsCustomers

- Defined in src/v1/analytics/reports/customers.ts:35
Parameters
- options: Record<string, unknown>
- http: Client
Returns AnalyticsReportsCustomers

Static Protected generateAuthenticatedInstance

generateAuthenticatedInstance<T>(Type: new (options: ThAnalyticsBaseHandlerOptions, http: Client) => T, options: ThAnalyticsBaseHandlerOptions, http: Client): T

Inherited from ThAnalyticsBaseHandler.generateAuthenticatedInstance
- Defined in src/base/handler.ts:76
Type parameters
- T
Parameters
- Type: new (options: ThAnalyticsBaseHandlerOptions, http: Client) => T
  - - new (options: ThAnalyticsBaseHandlerOptions, http: Client): T
    - Parameters
      - options: ThAnalyticsBaseHandlerOptions
      - http: Client
      Returns T
- options: ThAnalyticsBaseHandlerOptions
- http: Client
Returns T

Generated using TypeDoc