Options
All
  • Public
  • Public/Protected
  • All
Menu

Hierarchy

  • EventEmitter

Index

Constructors

Properties

Methods

Constructors

constructor

Properties

auth

auth: Auth

Optional http

http: Client

initialized

initialized: boolean = false

on

on: (event: "raw-error" | "error", listener: (error: Error) => void) => TillhubClient & (event: string, listener: Fn) => TillhubClient

options

options: undefined | TillhubSDKOptions

Optional user

user: string

Static defaultMaxListeners

defaultMaxListeners: number

Static environment

environment: { VERSION: any } = ...

Type declaration

  • VERSION: any

Static Readonly errorMonitor

errorMonitor: typeof errorMonitor

This symbol shall be used to install a listener for only monitoring 'error' events. Listeners installed using this symbol are called before the regular 'error' listeners are called.

Installing a listener using this symbol does not change the behavior once an 'error' event is emitted, therefore the process will still crash if no regular 'error' listener is installed.

Methods

abocardSystems

accounts

addListener

  • addListener(event: string | symbol, listener: (...args: any[]) => void): TillhubClient
  • Parameters

    • event: string | symbol
    • listener: (...args: any[]) => void
        • (...args: any[]): void
        • Parameters

          • Rest ...args: any[]

          Returns void

    Returns TillhubClient

analytics

  • analytics(axiosOptions?: AxiosOptions): Analytics

analyticsHandlers

analyticsHandlersV1

analyticsHandlersV3

analyticsV4

appointmentReminders

auditActions

auditLogs

auditLogsV1

balances

branchGroups

branches

branchesV1

businessUnits

carts

categories

categoryTrees

configurations

configurationsV1

consignmentNotes

contentTemplates

contents

correspondences

countingProtocols

customerAppointments

customers

customersV1

data

dbBackups

deliveries

dependencies

destroy

  • destroy(): void

deviceGroups

devices

devicesV1

discounts

documentExports

documents

emit

  • emit(event: string | symbol, ...args: any[]): boolean
  • Parameters

    • event: string | symbol
    • Rest ...args: any[]

    Returns boolean

eventNames

  • eventNames(): (string | symbol)[]
  • Returns (string | symbol)[]

expenseAccounts

exports

exportsV1

favourites

fiscalization

functions

Private generateAuthenticatedInstance

  • generateAuthenticatedInstance<T>(Type: new (options: Record<string, unknown>, http: Client) => T, maybeOptions?: Record<string, unknown>): T
  • Type parameters

    • T

    Parameters

    • Type: new (options: Record<string, unknown>, http: Client) => T
        • new (options: Record<string, unknown>, http: Client): T
        • Parameters

          • options: Record<string, unknown>
          • http: Client

          Returns T

    • Optional maybeOptions: Record<string, unknown>

    Returns T

getMaxListeners

  • getMaxListeners(): number
  • Returns number

Private handleOptions

holidays

iamUsers

images

init

inventoryConfiguration

invoices

listenerCount

  • listenerCount(type: string | symbol): number
  • Parameters

    • type: string | symbol

    Returns number

listeners

  • listeners(event: string | symbol): Function[]
  • Parameters

    • event: string | symbol

    Returns Function[]

me

  • me(): Me

messages

notifications

notificationsMsu

notificationsUnsubscribe

off

  • off(event: string | symbol, listener: (...args: any[]) => void): TillhubClient
  • Parameters

    • event: string | symbol
    • listener: (...args: any[]) => void
        • (...args: any[]): void
        • Parameters

          • Rest ...args: any[]

          Returns void

    Returns TillhubClient

once

  • once(event: string | symbol, listener: (...args: any[]) => void): TillhubClient
  • Parameters

    • event: string | symbol
    • listener: (...args: any[]) => void
        • (...args: any[]): void
        • Parameters

          • Rest ...args: any[]

          Returns void

    Returns TillhubClient

orders

ordersV2

paymentOptions

prependListener

  • prependListener(event: string | symbol, listener: (...args: any[]) => void): TillhubClient
  • Parameters

    • event: string | symbol
    • listener: (...args: any[]) => void
        • (...args: any[]): void
        • Parameters

          • Rest ...args: any[]

          Returns void

    Returns TillhubClient

prependOnceListener

  • prependOnceListener(event: string | symbol, listener: (...args: any[]) => void): TillhubClient
  • Parameters

    • event: string | symbol
    • listener: (...args: any[]) => void
        • (...args: any[]): void
        • Parameters

          • Rest ...args: any[]

          Returns void

    Returns TillhubClient

print

processes

productAddonGroups

productAddons

productBranchCustomizations

productGroups

productServiceQuestionGroups

productServiceQuestions

productTemplateDefaults

productTemplates

products

productsV2

productsV4

promotions

promotionsV1

purchaseOrders

rawListeners

  • rawListeners(event: string | symbol): Function[]
  • Parameters

    • event: string | symbol

    Returns Function[]

reasons

registers

removeAllListeners

  • Parameters

    • Optional event: string | symbol

    Returns TillhubClient

removeListener

  • removeListener(event: string | symbol, listener: (...args: any[]) => void): TillhubClient
  • Parameters

    • event: string | symbol
    • listener: (...args: any[]) => void
        • (...args: any[]): void
        • Parameters

          • Rest ...args: any[]

          Returns void

    Returns TillhubClient

safes

safesLogBook

safesLogBookV1

scheduledExports

serviceCategory

services

setMaxListeners

  • Parameters

    • n: number

    Returns TillhubClient

settings_old

shiftPlan

staff

staffGroups

staffPermissionsTemplates

stockTakings

stocks

stocksBook

stocksBookV1

storefronts

suppliers

suppliersProductsRelation

supportedEvents

tags

tagsV1

taxes

templates

timetracking

transactions

transactionsLegacy

transactionsV2

transactionsV3

trash

uodInvoices

uodInvoicesDownload

userPermissionsTemplates

users

  • users(configurationId: string): Users
  • Create an authenticated configurations instance

    Parameters

    • configurationId: string

    Returns Users

videos

voucherLogs

voucherSystems

vouchers

warehouses

webhookEvents

webhooks

Static listenerCount

  • listenerCount(emitter: EventEmitter, event: string | symbol): number
  • deprecated

    since v4.0.0

    Parameters

    • emitter: EventEmitter
    • event: string | symbol

    Returns number

Legend

  • Class
  • Constructor
  • Property
  • Method
  • Variable
  • Function
  • Type alias
  • Enumeration
  • Interface
  • Private method
  • Static property

Generated using TypeDoc