Variable actionsConst

Type Declaration

• apiTokenRequest: PayloadAC<"cpi/CRANE_API_TOKEN_REQUEST", void>

  This action saves the crane API token to Redux

• apiTokenResponse: PayloadAC<"cpi/CRANE_API_TOKEN_RESPONSE", string>

• cancelCashPayment: PayloadAC<"cpi/CANCEL_CASH_PAYMENT", { transactionId?: string }>

• cancelTransaction: PayloadAC<"cpi/CANCEL_TRANSACTION", { transactionId: string }>

• cashManagement: PayloadAC<"cpi/CASH_MANAGEMENT_REQUEST", CashManagementRequest>

  Param: POST

  /api/Transactions

  Empty Notes To Cashbox (Total): task = AdminActionTask.NotesToCashbox

  Example

  payload: CashManagementRequest {
    "task": AdminActionTask.NotesToCashbox,
  }
  
  Empty Notes To Cashbox (Float) task = AdminActionTask.FloatToCashbox
  Copy

  Example

  payload: CashManagementRequest {
    "task": AdminActionTask.FloatToCashbox,
  }
  
  Epic: Start Fill Recycler (task = AdminActionTask.EnterFillMode)
  Copy

  Example

  payload: CashManagementRequest {
    "task": AdminActionTask.EnterFillMode,
  }
  Copy

  Returns

  TransactionDTOResponse

• cashManagementResponse: PayloadAC<"cpi/CASH_MANAGEMENT_RESPONSE", TransactionDTOResponse>

• cashPaymentCancelFailed: PayloadAC<
      "cpi/CASH_PAYMENT_CANCEL_FAILED",
      { error: string; transactionId?: string },
  >

• cashPaymentCancelStarted: PayloadAC<"cpi/CASH_PAYMENT_CANCEL_STARTED", { transactionId: string }>

• cashPaymentCancelSucceeded: PayloadAC<"cpi/CASH_PAYMENT_CANCEL_SUCCEEDED", { transaction: TransactionDTO }>

• clearAdminMenuBusy: PayloadAC<"cpi/CLEAR_ADMIN_MENU_BUSY", void>

• clearCashPaymentState: PayloadAC<"cpi/CLEAR_CASH_PAYMENT_STATE", void>

• createCashTransaction: PayloadAC<
      "cpi/CREATE_CASH_TRANSACTION",
      { customAttribute?: string; value: number },
  >

• endTransaction: PayloadAC<"cpi/END_TRANSACTION", TransactionRequest>

  Param: GET

  /api/Transactions/{transactionId}/end

  Example

  payload: EndTransactionPayload: {
    "transactionId": string,
  }
  Copy

  Returns

  boolean

• endTransactionResponse: PayloadAC<"cpi/END_TRANSACTION_RESPONSE", void>

• getAllDevices: PayloadAC<"cpi/GET_ALL_DEVICES", LimitOffsetPayload>

  getAllDevices(limit: number, offset: number) => PaymentDeviceModel[]

• getCurrentTransaction: PayloadAC<"cpi/GET_CURRENT_TRANSACTION", void>

  @description: Get current transaction details

  Api

  GET /api/Transactions/Current

  Returns

  TransactionDTO

• initCashPayment: PayloadAC<"cpi/INIT_CASH_PAYMENT", void>

• loadAdminTransactionStatusResponse: PayloadAC<"cpi/LOAD_ADMIN_TRANSACTION_STATUS_RESPONSE", TransactionDTOResponse>

• loadAllDevicesResponse: PayloadAC<"cpi/LOAD_ALL_DEVICES_RESPONSE", PaymentDeviceModel[]>

• loadBnrStatusFailure: PayloadAC<"cpi/LOAD_BNR_STATUS_FAILURE", { checkedAt: string; error: string }>

• loadBnrStatusResponse: PayloadAC<
      "cpi/LOAD_BNR_STATUS_RESPONSE",
      { checkedAt: string; status: SystemStatusDTO },
  >

• loadCancelTransactionResponse: PayloadAC<
      "cpi/LOAD_CANCEL_TRANSACTION_RESPONSE",
      { message: string; transactionId: string },
  >

• loadCashTransactionStatusResponse: PayloadAC<"cpi/LOAD_CASH_TRANSACTION_STATUS_RESPONSE", TransactionDTO>

• loadCreateCashTransactionResponse: PayloadAC<"cpi/LOAD_CREATE_CASH_TRANSACTION_RESPONSE", TransactionDTO>

• loadCurrentTransactionResponse: PayloadAC<"cpi/LOAD_CURRENT_TRANSACTION_RESPONSE", TransactionDTO>

• loadDeviceMessagesFailure: PayloadAC<
      "cpi/LOAD_DEVICE_MESSAGES_FAILURE",
      { deviceId?: string; error: string; fetchedAt: string },
  >

• loadDeviceMessagesResponse: PayloadAC<
      "cpi/LOAD_DEVICE_MESSAGES_RESPONSE",
      { deviceId: string; fetchedAt: string; messages: DeviceMessageDTO[] },
  >

• refreshAllDevices: PayloadAC<"cpi/REFRESH_ALL_DEVICES", void>

  @description: Refresh all devices

  Returns

  void

• requestBnrStatus: PayloadAC<"cpi/REQUEST_BNR_STATUS", void>

• requestDeviceMessages: PayloadAC<
      "cpi/REQUEST_DEVICE_MESSAGES",
      { deviceId: string; requestedAt: string },
  >

• setAdminMenuBusy: PayloadAC<
      "cpi/SET_ADMIN_MENU_BUSY",
      { message?: string; operation?: AdminOperationType },
  >

• setCashPaymentError: PayloadAC<
      "SET_CASH_PAYMENT_ERROR",
      { action: string; error: string; scope?: string },
  >

• transactionRequest: PayloadAC<"cpi/TRANSACTION_REQUEST", TransactionRequest>

  @description: Check transaction status: Initially: InProgress -> Completed: CompletedSuccess or Failed @notes: How to use TransactionDTO (status should be CompletedSuccess)

  Notes

  1: For Epic: Zero Cashbox Count: TransactionDTO.movedItems for REPORT (not necessary)

  Notes

  2: For Epic: Accept Notes: TransactionDTO.acceptedItems for REPORT @error: If the transaction is failed (Failed), return the error message.

  Epic: Check Transaction Status (task = AdminActionTask.CheckTransactionStatus)

  Api

  GET /api/Transactions/{transactionId}

  Param: payload:

  CheckTransactionRequest { "transactionId": string, }

  Returns

  CheckTransactionResponse

• transactionResponse: PayloadAC<"cpi/TRANSACTION_RESPONSE", TransactionDTOResponse>

• zeroCashbox: PayloadAC<"cpi/REMOVE_ZERO_CASHBOX_COUNT", ZeroCashboxRequest>

  @description: Zero any counters in the cash box, as well as perform any other actions required to remove the cash box @notes: This is a final step in the workflow to remove the cash box. Use CashboxRemove (contents for REPORT)

  Param: GET

  /api/PaymentDevices/{deviceId}/CashBoxes/{cashBoxId}/Actions/Remove

  Epic: Zero Cashbox Count (task = AdminActionTask.ClearCashbox)

  Example

  payload: ZeroCashboxRequest {
    "deviceId": string,
    "cashBoxId": string,
  }
  Copy

  Returns

  ZeroCashbox

• zeroCashboxResponse: PayloadAC<"cpi/REMOVE_ZERO_CASHBOX_COUNT_RESPONSE", ZeroCashbox>