Analytics | @tillhub/javascript-sdk

Hierarchy

Analytics

Index

Constructors

constructor

Properties

Constructors

constructor

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

- Defined in src/v0/analytics.ts:172
Parameters
- options: AnalyticsOptions
- http: Client
Returns Analytics

Properties

endpoint

endpoint: string

http

http: Client

options

options: AnalyticsOptions

timeout

timeout: undefined | number

uriHelper

uriHelper: UriHelper

Methods

balances

balances(): Balances

- Defined in src/v0/analytics.ts:610
Returns Balances

cashBook

cashBook(): CashBook

- Defined in src/v0/analytics.ts:626
Returns CashBook

customers

customers(): Customers

- Defined in src/v0/analytics.ts:630
Returns Customers

getCustomersOverview

getCustomersOverview(query: CustomersTransactionOptions): Promise<AnalyticsResponse>

- Defined in src/v0/analytics.ts:523
Parameters
- query: CustomersTransactionOptions
Returns Promise<AnalyticsResponse>

getCustomersReport

getCustomersReport(query?: ExportFormatOptions): Promise<AnalyticsResponse>

- Defined in src/v0/analytics.ts:487
Parameters
- Optional query: ExportFormatOptions
Returns Promise<AnalyticsResponse>

getCustomersTransaction

getCustomersTransaction(query: CustomersTransactionOptions): Promise<AnalyticsResponse>

- Defined in src/v0/analytics.ts:505
Parameters
- query: CustomersTransactionOptions
Returns Promise<AnalyticsResponse>

getDiscountsReports

getDiscountsReports(query?: DiscountOptions): Promise<AnalyticsResponse>

- Defined in src/v0/analytics.ts:379
Parameters
- Optional query: DiscountOptions
Returns Promise<AnalyticsResponse>

getPaymentsReport

getPaymentsReport(query?: PaymentsReportOptions): Promise<AnalyticsResponse>

- Defined in src/v0/analytics.ts:413
Parameters
- Optional query: PaymentsReportOptions
Returns Promise<AnalyticsResponse>

getProductGroups

getProductGroups(query?: ProductGroupsOptions): Promise<AnalyticsResponse>

- Defined in src/v0/analytics.ts:576
Parameters
- Optional query: ProductGroupsOptions
Returns Promise<AnalyticsResponse>

getProductGroupsFilters

getProductGroupsFilters(query: ProductGroupsFilters): Promise<AnalyticsResponse>

- Defined in src/v0/analytics.ts:593
Parameters
- query: ProductGroupsFilters
Returns Promise<AnalyticsResponse>

getProductGroupsReport

getProductGroupsReport(query?: RevenuBasicOptions): Promise<AnalyticsResponse>

- Defined in src/v0/analytics.ts:328
Parameters
- Optional query: RevenuBasicOptions
Returns Promise<AnalyticsResponse>

getProductGroupsStaffReport

getProductGroupsStaffReport(options?: ReportOptions): Promise<AnalyticsResponse>

- Defined in src/v0/analytics.ts:311
Parameters
- Optional options: ReportOptions
Returns Promise<AnalyticsResponse>

getProductsChildren

getProductsChildren(productNumber: string, query?: ProductsOptions): Promise<AnalyticsResponse>

- Defined in src/v0/analytics.ts:273
Parameters
- productNumber: string
- Optional query: ProductsOptions
Returns Promise<AnalyticsResponse>

getProductsReport

getProductsReport(options?: ReportOptions): Promise<AnalyticsResponse>

- Defined in src/v0/analytics.ts:396
Parameters
- Optional options: ReportOptions
Returns Promise<AnalyticsResponse>

getRefundsReport

getRefundsReport(options?: ReportOptions): Promise<AnalyticsResponse>

- Defined in src/v0/analytics.ts:345
Parameters
- Optional options: ReportOptions
Returns Promise<AnalyticsResponse>

getReportsProducts

getReportsProducts(query?: ProductsOptions): Promise<AnalyticsResponse>

- Defined in src/v0/analytics.ts:253
Parameters
- Optional query: ProductsOptions
Returns Promise<AnalyticsResponse>

getRevenues

getRevenues(query: RevenuesOptions): Promise<AnalyticsResponse>

- Defined in src/v0/analytics.ts:218
Parameters
- query: RevenuesOptions
Returns Promise<AnalyticsResponse>

getRevenuesForDayOfWeek

getRevenuesForDayOfWeek(query: RevenuBasicOptions): Promise<AnalyticsResponse>

- Defined in src/v0/analytics.ts:184
Parameters
- query: RevenuBasicOptions
Returns Promise<AnalyticsResponse>

getRevenuesForHourOfDay

getRevenuesForHourOfDay(query: RevenuBasicOptions): Promise<AnalyticsResponse>

- Defined in src/v0/analytics.ts:236
Parameters
- query: RevenuBasicOptions
Returns Promise<AnalyticsResponse>

getRevenuesSumForTimeRange

getRevenuesSumForTimeRange(query: RevenuBasicOptions): Promise<AnalyticsResponse>

- Defined in src/v0/analytics.ts:201
Parameters
- query: RevenuBasicOptions
Returns Promise<AnalyticsResponse>

getSimpleSalesCartItems

getSimpleSalesCartItems(query?: SimpleSalesCartItemsOptions): Promise<AnalyticsResponse>

- Defined in src/v0/analytics.ts:464
Parameters
- Optional query: SimpleSalesCartItemsOptions
Returns Promise<AnalyticsResponse>

getStaffOverviewReport

getStaffOverviewReport(query?: StaffQuery): Promise<AnalyticsResponse>

- Defined in src/v0/analytics.ts:294
Parameters
- Optional query: StaffQuery
Returns Promise<AnalyticsResponse>

getStaffSales

getStaffSales(query?: StaffSalesOptions): Promise<AnalyticsResponse>

- Defined in src/v0/analytics.ts:559
Parameters
- Optional query: StaffSalesOptions
Returns Promise<AnalyticsResponse>

getStocksReport

getStocksReport(query?: ExportFormatOptions): Promise<AnalyticsResponse>

- Defined in src/v0/analytics.ts:540
Parameters
- Optional query: ExportFormatOptions
Returns Promise<AnalyticsResponse>

getTopPaymentsReport

getTopPaymentsReport(query?: TopPaymentsReportOptions): Promise<AnalyticsResponse>

- Defined in src/v0/analytics.ts:447
Parameters
- Optional query: TopPaymentsReportOptions
Returns Promise<AnalyticsResponse>

getTopProductsReport

getTopProductsReport(options?: ReportOptions): Promise<AnalyticsResponse>

- Defined in src/v0/analytics.ts:430
Parameters
- Optional options: ReportOptions
Returns Promise<AnalyticsResponse>

getVouchersReports

getVouchersReports(query?: VoucherOptions): Promise<AnalyticsResponse>

- Defined in src/v0/analytics.ts:362
Parameters
- Optional query: VoucherOptions
Returns Promise<AnalyticsResponse>

paymentOptions

paymentOptions(): PaymentOptions

- Defined in src/v0/analytics.ts:614
Returns PaymentOptions

payments

payments(): Payments

- Defined in src/v0/analytics.ts:618
Returns Payments

vat

vat(): Vat

- Defined in src/v0/analytics.ts:622
Returns Vat

Generated using TypeDoc