AnalyticsReportsCommunications | @tillhub/javascript-sdk

Hierarchy

ThAnalyticsBaseHandler
- AnalyticsReportsCommunications

Index

Constructors

constructor

Properties

Methods

Constructors

constructor

new AnalyticsReportsCommunications(options: AnalyticsOptions, http: Client): AnalyticsReportsCommunications

Overrides ThAnalyticsBaseHandler.constructor
- Defined in src/v1/analytics/reports/communications.ts:43
Parameters
- options: AnalyticsOptions
- http: Client
Returns AnalyticsReportsCommunications

Properties

http

http: Client

options

options: AnalyticsOptions

timeout

timeout: undefined | number

uriHelper

uriHelper: UriHelper

Methods

getAll

getAll(query?: AnalyticsReportsCommunicationsQuery): Promise<AnalyticsReportsCommunicationsResponse>

- Defined in src/v1/analytics/reports/communications.ts:61
Parameters
- Optional query: AnalyticsReportsCommunicationsQuery
Returns Promise<AnalyticsReportsCommunicationsResponse>

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>

meta

meta(queryOrOptions?: AnalyticsReportsCommunicationsQuery): Promise<AnalyticsReportsCommunicationsMetaResponse>

- Defined in src/v1/analytics/reports/communications.ts:86
Parameters
- Optional queryOrOptions: AnalyticsReportsCommunicationsQuery
Returns Promise<AnalyticsReportsCommunicationsMetaResponse>

Static create

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

- Defined in src/v1/analytics/reports/communications.ts:53
Parameters
- options: Record<string, unknown>
- http: Client
Returns AnalyticsReportsCommunications

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