Zamok Kiosk API
    Preparing search index...
    • Parameters

      • state: {
            crane: {
                addDevice: null | PaymentDeviceModel;
                addItemToRecycler: null | void;
                addTransactions: any;
                allDevices: PaymentDeviceModel[];
                apiReady: null | string;
                auditResponse: null | AuditDTO;
                cancelTransaction: any;
                cancelTransactionResponse:
                    | null
                    | { message: string; transactionId: string };
                cashBoxes: null | CashBoxModelCollectionModel;
                cashInventory: PaymentDeviceModel[];
                checkPaymentOptions: EnabledPaymentOptionsPayload;
                checkSystemStatusResponse: null | SystemStatusDTO;
                clearDeviceSwappedWarning: any;
                configurationItem: null | number;
                configurationItems: ConfigurationItemDTO[];
                configurationItemsByItem: null | ConfigurationItemDTO[];
                configureFloatLevels: { message: string; success: boolean };
                createCashTransactionResponse: null | TransactionDTO;
                cspOverrideSettings: null | CSPOverrideDto;
                currentTransaction: any;
                deleteDevice: null | void;
                device: null | PaymentDeviceModel;
                deviceCashBox: null | CashBoxModel;
                deviceInfo: null | IDeviceInfo;
                deviceLoader: null | LoaderDto;
                deviceLoaders: null | LoaderDtoCollectionModel;
                deviceMessages: any;
                deviceRecycler: null | RecyclerModel;
                deviceRecyclers: null | RecyclerModelCollectionModel;
                diagnosticsLog: null | DiagnosticsLogDTO;
                downloadFullLogsFileName: null | string;
                downloadPartialLogsFileName: null | string;
                downloadTransactions: any;
                enablePaymentItem: any;
                endTransaction: any;
                hostProtocolSecuritySettings: null | HostProtocolSecurityDto;
                inhibitPaymentItems: any;
                initAPI: boolean;
                installCashBox: any;
                loaderAuditResponse: null | LoaderAuditDTO;
                messages: any;
                note: null | ICashModel;
                notes: ICashModel[];
                partialLogs: null | DiagnosticsLogDTO;
                paymentDeviceAudit: any;
                paymentDeviceModule: null | ModuleStatusModel;
                paymentDeviceModules: IModuleStatus[];
                paymentItem: any;
                paymentItems: any;
                printTransactionReceiptResponse: null | PrintTransactionReceiptPayload;
                properties: null | PaymentDeviceModel;
                recyclerWorkflowState: DeviceState;
                removeCashBox: any;
                removeItemFromRecycler: null | void;
                session: null | SessionDTO;
                sessions: SessionDTO[];
                setDeviceRecycler: null | void;
                setDeviceRecyclers: null | void;
                setLoaderInitialContent: any;
                settingsSchema: any;
                startCashboxTransactionResponse: null | CashBoxModelCollectionModel;
                supportedDevices: any[];
                systemSettings: null | SystemSettingsModel;
                systemStatus: any;
                transaction: any;
                transactionActionCount: any;
                transactions: any;
                transactionsForInProgressChecking: TransactionDTO[];
                trialData: null | TrialSettingsDTO;
                triggerRemoveCashboxResponse: null | CashBoxModel;
                updateConfigurationItem: boolean;
                updateConfigurationItems: boolean;
                updateFirmware: any;
                userSettings: null | UserSettingsDto;
                version: any;
            };
        }

      Returns {
          addDevice: null | PaymentDeviceModel;
          addItemToRecycler: null | void;
          addTransactions: any;
          allDevices: PaymentDeviceModel[];
          apiReady: null | string;
          auditResponse: null | AuditDTO;
          cancelTransaction: any;
          cancelTransactionResponse:
              | null
              | { message: string; transactionId: string };
          cashBoxes: null | CashBoxModelCollectionModel;
          cashInventory: PaymentDeviceModel[];
          checkPaymentOptions: EnabledPaymentOptionsPayload;
          checkSystemStatusResponse: null | SystemStatusDTO;
          clearDeviceSwappedWarning: any;
          configurationItem: null | number;
          configurationItems: ConfigurationItemDTO[];
          configurationItemsByItem: null | ConfigurationItemDTO[];
          configureFloatLevels: { message: string; success: boolean };
          createCashTransactionResponse: null | TransactionDTO;
          cspOverrideSettings: null | CSPOverrideDto;
          currentTransaction: any;
          deleteDevice: null | void;
          device: null | PaymentDeviceModel;
          deviceCashBox: null | CashBoxModel;
          deviceInfo: null | IDeviceInfo;
          deviceLoader: null | LoaderDto;
          deviceLoaders: null | LoaderDtoCollectionModel;
          deviceMessages: any;
          deviceRecycler: null | RecyclerModel;
          deviceRecyclers: null | RecyclerModelCollectionModel;
          diagnosticsLog: null | DiagnosticsLogDTO;
          downloadFullLogsFileName: null | string;
          downloadPartialLogsFileName: null | string;
          downloadTransactions: any;
          enablePaymentItem: any;
          endTransaction: any;
          hostProtocolSecuritySettings: null | HostProtocolSecurityDto;
          inhibitPaymentItems: any;
          initAPI: boolean;
          installCashBox: any;
          loaderAuditResponse: null | LoaderAuditDTO;
          messages: any;
          note: null | ICashModel;
          notes: ICashModel[];
          partialLogs: null | DiagnosticsLogDTO;
          paymentDeviceAudit: any;
          paymentDeviceModule: null | ModuleStatusModel;
          paymentDeviceModules: IModuleStatus[];
          paymentItem: any;
          paymentItems: any;
          printTransactionReceiptResponse: null | PrintTransactionReceiptPayload;
          properties: null | PaymentDeviceModel;
          recyclerWorkflowState: DeviceState;
          removeCashBox: any;
          removeItemFromRecycler: null | void;
          session: null | SessionDTO;
          sessions: SessionDTO[];
          setDeviceRecycler: null | void;
          setDeviceRecyclers: null | void;
          setLoaderInitialContent: any;
          settingsSchema: any;
          startCashboxTransactionResponse: null | CashBoxModelCollectionModel;
          supportedDevices: any[];
          systemSettings: null | SystemSettingsModel;
          systemStatus: any;
          transaction: any;
          transactionActionCount: any;
          transactions: any;
          transactionsForInProgressChecking: TransactionDTO[];
          trialData: null | TrialSettingsDTO;
          triggerRemoveCashboxResponse: null | CashBoxModel;
          updateConfigurationItem: boolean;
          updateConfigurationItems: boolean;
          updateFirmware: any;
          userSettings: null | UserSettingsDto;
          version: any;
      }

      • addDevice: null | PaymentDeviceModel
      • addItemToRecycler: null | void
      • addTransactions: any

        POST /api/Transactions

      • allDevices: PaymentDeviceModel[]
      • apiReady: null | string

        ======================= API Ready State

      • auditResponse: null | AuditDTO
      • cancelTransaction: any

        GET /api/Transactions/action/{id}/cancel

      • cancelTransactionResponse: null | { message: string; transactionId: string }
      • cashBoxes: null | CashBoxModelCollectionModel
      • cashInventory: PaymentDeviceModel[]
      • checkPaymentOptions: EnabledPaymentOptionsPayload

        ======================= Transaction Workflow Reducers

      • checkSystemStatusResponse: null | SystemStatusDTO
      • clearDeviceSwappedWarning: any
      • configurationItem: null | number
      • configurationItems: ConfigurationItemDTO[]
      • configurationItemsByItem: null | ConfigurationItemDTO[]
      • configureFloatLevels: { message: string; success: boolean }
      • createCashTransactionResponse: null | TransactionDTO
      • cspOverrideSettings: null | CSPOverrideDto
      • currentTransaction: any

        GET /api/Transactions/Current

      • deleteDevice: null | void
      • device: null | PaymentDeviceModel
      • deviceCashBox: null | CashBoxModel
      • deviceInfo: null | IDeviceInfo
      • deviceLoader: null | LoaderDto
      • deviceLoaders: null | LoaderDtoCollectionModel
      • deviceMessages: any
      • deviceRecycler: null | RecyclerModel
      • deviceRecyclers: null | RecyclerModelCollectionModel
      • diagnosticsLog: null | DiagnosticsLogDTO
      • downloadFullLogsFileName: null | string
      • downloadPartialLogsFileName: null | string
      • downloadTransactions: any

        GET /api/Transactions/download

      • enablePaymentItem: any
      • endTransaction: any

        GET /api/Transactions/action/{id}/end

      • hostProtocolSecuritySettings: null | HostProtocolSecurityDto
      • inhibitPaymentItems: any
      • initAPI: boolean
      • installCashBox: any
      • loaderAuditResponse: null | LoaderAuditDTO
      • messages: any
      • note: null | ICashModel
      • notes: ICashModel[]
      • partialLogs: null | DiagnosticsLogDTO
      • paymentDeviceAudit: any
      • paymentDeviceModule: null | ModuleStatusModel
      • paymentDeviceModules: IModuleStatus[]
      • paymentItem: any
      • paymentItems: any
      • printTransactionReceiptResponse: null | PrintTransactionReceiptPayload
      • properties: null | PaymentDeviceModel
      • recyclerWorkflowState: DeviceState

        ======================= Recycler Workflow Reducers

      • removeCashBox: any
      • removeItemFromRecycler: null | void
      • session: null | SessionDTO
      • sessions: SessionDTO[]
      • setDeviceRecycler: null | void
      • setDeviceRecyclers: null | void
      • setLoaderInitialContent: any
      • settingsSchema: any
      • startCashboxTransactionResponse: null | CashBoxModelCollectionModel

        ======================= Cashbox Workflow Reducers

      • supportedDevices: any[]
      • systemSettings: null | SystemSettingsModel
      • systemStatus: any
      • transaction: any

        GET /api/Transactions/{id}

      • transactionActionCount: any

        GET /api/Transactions/action/count

      • transactions: any

        GET /api/Transactions

      • transactionsForInProgressChecking: TransactionDTO[]

        ======================= Monitor Workflow Reducers

        REST API: WORKFLOW_MONITOR (workFlowCashbox.ts: checkSystemStatus$ epic)) Get Transactions for In Progress Checking (getTransactionsForInProgressChecking$ epic) Get Cash Inventory (getCashInventory$ epic) Configure Float Levels (configureFloatLevels$ epic)

      • trialData: null | TrialSettingsDTO
      • triggerRemoveCashboxResponse: null | CashBoxModel
      • updateConfigurationItem: boolean
      • updateConfigurationItems: boolean
      • updateFirmware: any
      • userSettings: null | UserSettingsDto
      • version: any