@kreiseck/kasseneck-api 1.27.0 → 1.29.0
This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
- package/CHANGELOG.md +27 -0
- package/README.md +84 -0
- package/dist/cjs/client/api.d.ts +15 -0
- package/dist/cjs/client/api.js +8 -0
- package/dist/cjs/client/aufrufe.d.ts +4 -4
- package/dist/cjs/client/aufrufe.js +31 -0
- package/dist/cjs/client/index.d.ts +1 -0
- package/dist/cjs/client/index.js +17 -1
- package/dist/cjs/client/terminal.d.ts +206 -0
- package/dist/cjs/client/terminal.js +288 -0
- package/dist/cjs/index.d.ts +1 -1
- package/dist/cjs/index.js +17 -1
- package/dist/cjs/pos/aufrunden.d.ts +6 -0
- package/dist/cjs/pos/aufrunden.js +59 -0
- package/dist/cjs/pos/client.js +12 -1
- package/dist/cjs/pos/index.d.ts +4 -3
- package/dist/cjs/pos/index.js +17 -4
- package/dist/cjs/pos/schicht-lesen.d.ts +2 -1
- package/dist/cjs/pos/schicht-lesen.js +48 -1
- package/dist/cjs/pos/schicht-typen.d.ts +106 -3
- package/dist/cjs/pos/schicht-typen.js +14 -4
- package/dist/cjs/pos/schicht.d.ts +28 -2
- package/dist/cjs/pos/schicht.js +19 -0
- package/dist/cjs/pos/settings.d.ts +39 -0
- package/dist/cjs/pos/settings.js +65 -4
- package/dist/cjs/pos/texte.d.ts +292 -0
- package/dist/cjs/pos/texte.js +108 -0
- package/dist/cjs/receipt/shift-sheet.js +29 -0
- package/dist/cjs/stored/einstellungen.js +31 -4
- package/dist/cjs/stored/vokabular.d.ts +1 -1
- package/dist/cjs/stored/vokabular.js +29 -2
- package/dist/cjs/version.d.ts +1 -1
- package/dist/cjs/version.js +1 -1
- package/dist/esm/client/api.d.ts +15 -0
- package/dist/esm/client/api.js +8 -0
- package/dist/esm/client/aufrufe.d.ts +4 -4
- package/dist/esm/client/aufrufe.js +31 -0
- package/dist/esm/client/index.d.ts +1 -0
- package/dist/esm/client/index.js +1 -0
- package/dist/esm/client/terminal.d.ts +206 -0
- package/dist/esm/client/terminal.js +278 -0
- package/dist/esm/index.d.ts +1 -1
- package/dist/esm/index.js +1 -1
- package/dist/esm/pos/aufrunden.d.ts +6 -0
- package/dist/esm/pos/aufrunden.js +56 -0
- package/dist/esm/pos/client.js +13 -2
- package/dist/esm/pos/index.d.ts +4 -3
- package/dist/esm/pos/index.js +5 -4
- package/dist/esm/pos/schicht-lesen.d.ts +2 -1
- package/dist/esm/pos/schicht-lesen.js +47 -1
- package/dist/esm/pos/schicht-typen.d.ts +106 -3
- package/dist/esm/pos/schicht-typen.js +13 -3
- package/dist/esm/pos/schicht.d.ts +28 -2
- package/dist/esm/pos/schicht.js +19 -1
- package/dist/esm/pos/settings.d.ts +39 -0
- package/dist/esm/pos/settings.js +60 -3
- package/dist/esm/pos/texte.d.ts +292 -0
- package/dist/esm/pos/texte.js +108 -0
- package/dist/esm/receipt/shift-sheet.js +29 -0
- package/dist/esm/stored/einstellungen.js +32 -5
- package/dist/esm/stored/vokabular.d.ts +1 -1
- package/dist/esm/stored/vokabular.js +29 -2
- package/dist/esm/version.d.ts +1 -1
- package/dist/esm/version.js +1 -1
- package/fixtures/duplicate-cases.json +6 -0
- package/fixtures/expected/duplicate.shift-close.hex +28 -27
- package/fixtures/expected/shift-close-blind.grid32.txt +1 -0
- package/fixtures/expected/shift-close-blind.grid48.txt +1 -0
- package/fixtures/expected/shift-close-blind.lines.json +6 -0
- package/fixtures/expected/shift-close-put-in.grid32.txt +1 -0
- package/fixtures/expected/shift-close-put-in.grid48.txt +1 -0
- package/fixtures/expected/shift-close-put-in.lines.json +6 -0
- package/fixtures/expected/shift-close-take-out.grid32.txt +1 -0
- package/fixtures/expected/shift-close-take-out.grid48.txt +1 -0
- package/fixtures/expected/shift-close-take-out.lines.json +6 -0
- package/fixtures/expected/shift-close.grid32.txt +1 -0
- package/fixtures/expected/shift-close.grid48.txt +1 -0
- package/fixtures/expected/shift-close.lines.json +6 -0
- package/fixtures/expected/shift-interim.grid32.txt +1 -0
- package/fixtures/expected/shift-interim.grid48.txt +1 -0
- package/fixtures/expected/shift-interim.lines.json +6 -0
- package/fixtures/hobex-hps-codes.json +1 -1
- package/fixtures/invoice-api.schema.json +1 -1
- package/fixtures/invoice-texts.json +1 -1
- package/fixtures/pos-texts.json +337 -1
- package/fixtures/renames-1.0.json +30 -0
- package/fixtures/shift-ablauf-cases.json +182 -0
- package/fixtures/shift-receipts.json +15 -15
- package/fixtures/surface.json +59 -4
- package/fixtures/tip-round-up-cases.json +27 -0
- package/fixtures/v3/antworten/belege.json +2 -2
- package/fixtures/v3/antworten/belegmail.json +2 -2
- package/fixtures/v3/antworten/berichte.json +2 -2
- package/fixtures/v3/antworten/kasse-belege.json +2 -2
- package/fixtures/v3/antworten/kasse.json +504 -4
- package/fixtures/v3/antworten/lager.json +1 -1
- package/fixtures/v3/antworten/rechnungen.json +2 -2
- package/fixtures/v3/antworten/storno.json +2 -2
- package/fixtures/v3/stored/belege.json +2 -2
- package/fixtures/v3/stored/kasse.json +520 -12
- package/fixtures/v3/stored/rechnungen.json +2 -2
- package/fixtures/v3/v3-vokabular.json +184 -11
- package/fixtures/v3/zahlbetrag-faelle.json +2 -2
- package/package.json +1 -1
package/dist/cjs/version.js
CHANGED
package/dist/esm/client/api.d.ts
CHANGED
|
@@ -5,6 +5,7 @@ import { type TransportOptions } from './transport.js';
|
|
|
5
5
|
import { type CashregisterReportPeriod, type ReportV2, type ReportV2Options } from './reports.js';
|
|
6
6
|
import { type CashboxStatus, type SignatureStatus } from './status.js';
|
|
7
7
|
import { type CreateDepExportOptions, type CreateDepExportResult, type DepExport, type DepExportFile, type DepHandoverLink, type GetDepExportFileOptions, type RevokedDepHandoverLink, type WaitForDepExportOptions } from './dep-export.js';
|
|
8
|
+
import { type ClaimTerminalOptions, type GetTerminalAccessOptions, type RegisteredTerminalDevice, type RegisterTerminalDeviceOptions, type ReportTerminalLoginOptions, type RequestTerminalCodeOptions, type TerminalAccess, type TerminalAccessResult, type TerminalCode, type TerminalCodeRequest, type TerminalDeviceCredentials } from './terminal.js';
|
|
8
9
|
import { type ListedReceipt, type ListReceiptsOptions, type ListReceiptsPage, type ListReceiptsView } from './list-receipts.js';
|
|
9
10
|
import { type SendReceiptEmailOptions, type SendReceiptEmailResult, type LogReceiptOutputsOptions, type LogReceiptOutputsResult, type ListMyReceiptsOptions, type ReceiptList, type ReceiptWithCompany, type SellReceiptOptions, type CancelReceiptOptions, type CancelReceiptResult } from './receipts.js';
|
|
10
11
|
/**
|
|
@@ -80,6 +81,20 @@ export interface KasseneckApi {
|
|
|
80
81
|
revokeDepHandoverLink(options: {
|
|
81
82
|
linkId: string;
|
|
82
83
|
}): Promise<RevokedDepHandoverLink>;
|
|
84
|
+
/** Geraet fuer das Kartenterminal am Handy einmal anmelden (`registerTerminalDevice`, nur /v3); `deviceSecret` nur in dieser Antwort. */
|
|
85
|
+
registerTerminalDevice(options: RegisterTerminalDeviceOptions): Promise<RegisteredTerminalDevice>;
|
|
86
|
+
/** Zugang und TID fuer das Geraet, oder die TIDs des eigenen Betriebs, wenn keine frei ist (`getTerminalAccess`). */
|
|
87
|
+
getTerminalAccess(options: GetTerminalAccessOptions): Promise<TerminalAccessResult>;
|
|
88
|
+
/** TID des eigenen Betriebs auf dieses Geraet uebernehmen (`claimTerminal`). */
|
|
89
|
+
claimTerminal(options: ClaimTerminalOptions): Promise<TerminalAccess>;
|
|
90
|
+
/** Code fuer die TID aus dem Postfach anfragen (`requestTerminalCode`, nur bei `autoCode`). */
|
|
91
|
+
requestTerminalCode(options: RequestTerminalCodeOptions): Promise<TerminalCodeRequest>;
|
|
92
|
+
/** Stand der Code-Anfrage und der Einrichtung, bei `found` mit Code (`getTerminalCode`). */
|
|
93
|
+
getTerminalCode(options: TerminalDeviceCredentials): Promise<TerminalCode>;
|
|
94
|
+
/** Ausgang der Anmeldung in der Terminal-App melden (`reportTerminalLogin`). */
|
|
95
|
+
reportTerminalLogin(options: ReportTerminalLoginOptions): Promise<void>;
|
|
96
|
+
/** Terminal-App fertig eingerichtet melden (`reportTerminalReady`). */
|
|
97
|
+
reportTerminalReady(options: TerminalDeviceCredentials): Promise<void>;
|
|
83
98
|
/** Kassenbericht als PDF (v2): abgeschlossener Monat, Tag oder Zeitraum (Endpunkt `getCashregisterReport`). */
|
|
84
99
|
getCashregisterReport(options: CashregisterReportPeriod): Promise<Uint8Array>;
|
|
85
100
|
/** @deprecated Since 1.10.0: use getCashregisterReport. Tagesbericht als PDF (Kalendertag nach Wiener Zeit). */
|
package/dist/esm/client/api.js
CHANGED
|
@@ -4,6 +4,7 @@ import { createTransport, createBinaryTransport, createFileOrDataTransport } fro
|
|
|
4
4
|
import { downloadDailyReport, downloadMonthlyReport, getCashregisterReport, getReportV2 } from './reports.js';
|
|
5
5
|
import { getCashboxStatus, getSignatureStatus } from './status.js';
|
|
6
6
|
import { createDepExport, createDepHandoverLink, getDepExport, getDepExportFile, revokeDepHandoverLink, waitForDepExport, } from './dep-export.js';
|
|
7
|
+
import { claimTerminal, getTerminalAccess, getTerminalCode, registerTerminalDevice, reportTerminalLogin, reportTerminalReady, requestTerminalCode, } from './terminal.js';
|
|
7
8
|
import { listAllReceipts, listReceipts } from './list-receipts.js';
|
|
8
9
|
import { sellReceipt, sellReceiptWithCompany, cancelReceipt, zeroReceipt, getReceipt, getReceiptWithCompany, generateFullReceiptId, getFirstReceiptDate, listMyReceipts, sendReceiptEmail, logReceiptOutputs, } from './receipts.js';
|
|
9
10
|
import { listMyCashregisters } from './cashregisters.js';
|
|
@@ -46,6 +47,13 @@ export function createKasseneckApi(options) {
|
|
|
46
47
|
getDepExportFile: (o) => getDepExportFile(rufenDatei, holen, o),
|
|
47
48
|
createDepHandoverLink: (o) => createDepHandoverLink(rufen, o),
|
|
48
49
|
revokeDepHandoverLink: (o) => revokeDepHandoverLink(rufen, o),
|
|
50
|
+
registerTerminalDevice: (o) => registerTerminalDevice(rufen, o),
|
|
51
|
+
getTerminalAccess: (o) => getTerminalAccess(rufen, o),
|
|
52
|
+
claimTerminal: (o) => claimTerminal(rufen, o),
|
|
53
|
+
requestTerminalCode: (o) => requestTerminalCode(rufen, o),
|
|
54
|
+
getTerminalCode: (o) => getTerminalCode(rufen, o),
|
|
55
|
+
reportTerminalLogin: (o) => reportTerminalLogin(rufen, o),
|
|
56
|
+
reportTerminalReady: (o) => reportTerminalReady(rufen, o),
|
|
49
57
|
getCashregisterReport: (options) => getCashregisterReport(rufenBinaer, options),
|
|
50
58
|
downloadDailyReport: (date) => downloadDailyReport(rufenBinaer, date),
|
|
51
59
|
downloadMonthlyReport: (reportMonth) => downloadMonthlyReport(rufenBinaer, reportMonth),
|
|
@@ -13,7 +13,7 @@
|
|
|
13
13
|
* umhuellt, muss ihn weiterhin absetzen koennen.
|
|
14
14
|
*/
|
|
15
15
|
import type { FileOrData, FileOrDataCallOptions, PdfOrData, TransportBodyFields, TransportCallOptions } from './transport.js';
|
|
16
|
-
export declare const ALL_CALLS: readonly ["activateCashregister", "cancelInvoice", "cancelReceipt", "createCreditNote", "createCustomer", "createCustomerCashregister", "createDepExport", "createDepHandoverLink", "createPartnerCustomer", "checkPartnerCustomerEmail", "createPartnerWebhook", "createPaymentLinkStripe", "createPrintJob", "createReceipt", "deletePartnerWebhook", "downloadDailyReport", "downloadReport", "endRegisterSession", "financeWebService", "generateFullReceiptId", "getCashregisterReport", "getCustomer", "getCustomerCredentials", "getCustomerSignatureStatus", "getDepExport", "getDepExportFile", "getFirstReceiptDate", "getInvoice", "getInvoicePdf", "getInvoiceSetupStatus", "getInvoiceXml", "getKasseSettings", "getPartnerCustomer", "getPartnerInfo", "getPrintJob", "getReceipt", "getReportV2", "hobexPayApi", "hobexRefundApi", "issueInvoice", "listCustomerCashregisters", "listInvoices", "listBrands", "listMyArticleGroups", "listMyArticles", "listMyCashregisters", "listMyPrinters", "listMyReceipts", "listMyStock", "listMyStockLocations", "listMyTipRecipients", "listPartnerCustomers", "listPartnerWebhookDeliveries", "listPartnerWebhooks", "listReceipts", "listRegisterUsersForDevice", "listRegisterSessionsForDevice", "pairRegisterDevice", "recordInvoicePayment", "registerPinLogin", "registerUserLogin", "renewRegisterSession", "reportCustomerContract", "requestCustomerSignature", "revokeDepHandoverLink", "searchCustomers", "sendPartnerCustomerFonLink", "sendPartnerWebhookTest", "sendReceiptEmail", "setMyCashregisterStockLocation", "setMyKasseLogo", "setMyKasseSettings", "setMyRegisterDeviceSettings", "stripeCaptureIntent", "unpairRegisterDevice", "rotatePartnerWebhookSecret", "updateCustomer", "updatePartnerWebhook", "getArticle", "listArticles", "lookupArticleByCode", "listLocations", "getStock", "listStock", "listStockMovements", "createWebhook", "updateWebhook", "deleteWebhook", "listWebhooks", "sendWebhookTest", "rotateWebhookSecret", "listWebhookDeliveries", "createArticle", "updateArticle", "deactivateArticle", "receiveGoods", "transferStock", "recordStockLoss", "changeStockCondition", "reverseStockMovement", "createReservation", "extendReservation", "releaseReservation", "getReservation", "listReservations", "createVariantGroup", "updateVariantGroup", "getVariantGroup", "listVariantGroups", "addVariant", "createStocktake", "listStocktakes", "getStocktake", "listStocktakeItems", "recordStocktakeCount", "voidStocktakeCount", "listStocktakeCounts", "reviewStocktake", "recountStocktake", "closeStocktake", "cancelStocktake", "getStocktakePdf", "orderSignatureCard", "getSignatureCardOrder", "listMyStocktakes", "listMyStocktakeItems", "listMyStocktakeCounts", "recordMyStocktakeCount", "voidMyStocktakeCount", "checkVoucher", "reprintVoucherLabel", "getMyDrawerState", "openMyShift", "recordMyCashMovement", "logMyDrawerOpenings", "getMyShiftReport", "closeMyShift", "logReceiptOutputs", "getRegisterInspectionInfo", "reportConnectState"];
|
|
16
|
+
export declare const ALL_CALLS: readonly ["activateCashregister", "cancelInvoice", "cancelReceipt", "createCreditNote", "createCustomer", "createCustomerCashregister", "createDepExport", "createDepHandoverLink", "createPartnerCustomer", "checkPartnerCustomerEmail", "createPartnerWebhook", "createPaymentLinkStripe", "createPrintJob", "createReceipt", "deletePartnerWebhook", "downloadDailyReport", "downloadReport", "endRegisterSession", "financeWebService", "generateFullReceiptId", "getCashregisterReport", "getCustomer", "getCustomerCredentials", "getCustomerSignatureStatus", "getDepExport", "getDepExportFile", "getFirstReceiptDate", "getInvoice", "getInvoicePdf", "getInvoiceSetupStatus", "getInvoiceXml", "getKasseSettings", "getPartnerCustomer", "getPartnerInfo", "getPrintJob", "getReceipt", "getReportV2", "hobexPayApi", "hobexRefundApi", "issueInvoice", "listCustomerCashregisters", "listInvoices", "listBrands", "listMyArticleGroups", "listMyArticles", "listMyCashregisters", "listMyPrinters", "listMyReceipts", "listMyStock", "listMyStockLocations", "listMyTipRecipients", "listPartnerCustomers", "listPartnerWebhookDeliveries", "listPartnerWebhooks", "listReceipts", "listRegisterUsersForDevice", "listRegisterSessionsForDevice", "pairRegisterDevice", "recordInvoicePayment", "registerPinLogin", "registerUserLogin", "renewRegisterSession", "reportCustomerContract", "requestCustomerSignature", "revokeDepHandoverLink", "searchCustomers", "sendPartnerCustomerFonLink", "sendPartnerWebhookTest", "sendReceiptEmail", "setMyCashregisterStockLocation", "setMyKasseLogo", "setMyKasseSettings", "setMyRegisterDeviceSettings", "stripeCaptureIntent", "unpairRegisterDevice", "rotatePartnerWebhookSecret", "updateCustomer", "updatePartnerWebhook", "getArticle", "listArticles", "lookupArticleByCode", "listLocations", "getStock", "listStock", "listStockMovements", "createWebhook", "updateWebhook", "deleteWebhook", "listWebhooks", "sendWebhookTest", "rotateWebhookSecret", "listWebhookDeliveries", "createArticle", "updateArticle", "deactivateArticle", "receiveGoods", "transferStock", "recordStockLoss", "changeStockCondition", "reverseStockMovement", "createReservation", "extendReservation", "releaseReservation", "getReservation", "listReservations", "createVariantGroup", "updateVariantGroup", "getVariantGroup", "listVariantGroups", "addVariant", "createStocktake", "listStocktakes", "getStocktake", "listStocktakeItems", "recordStocktakeCount", "voidStocktakeCount", "listStocktakeCounts", "reviewStocktake", "recountStocktake", "closeStocktake", "cancelStocktake", "getStocktakePdf", "orderSignatureCard", "getSignatureCardOrder", "listMyStocktakes", "listMyStocktakeItems", "listMyStocktakeCounts", "recordMyStocktakeCount", "voidMyStocktakeCount", "checkVoucher", "reprintVoucherLabel", "getMyDrawerState", "openMyShift", "recordMyCashMovement", "logMyDrawerOpenings", "getMyShiftReport", "closeMyShift", "recordMyShiftCount", "logReceiptOutputs", "getRegisterInspectionInfo", "reportConnectState", "registerTerminalDevice", "getTerminalAccess", "claimTerminal", "requestTerminalCode", "getTerminalCode", "reportTerminalLogin", "reportTerminalReady"];
|
|
17
17
|
export type ApiCall = typeof ALL_CALLS[number];
|
|
18
18
|
/**
|
|
19
19
|
* Die oeffentlichen Endpunkte unter `/v3` (`https://api.kasseneck.at/v3/<name>`),
|
|
@@ -21,7 +21,7 @@ export type ApiCall = typeof ALL_CALLS[number];
|
|
|
21
21
|
* (`fixtures/v3/v3-vokabular.json`, `endpoints.public`, umbenannt nach
|
|
22
22
|
* `names`). Ein Test haelt beide Listen deckungsgleich.
|
|
23
23
|
*/
|
|
24
|
-
export declare const PUBLIC_CALLS: readonly ["createReceipt", "getReceipt", "cancelReceipt", "sendReceiptEmail", "generateFullReceiptId", "downloadReceipt", "getFirstReceiptDate", "getReportV2", "downloadReport", "downloadDailyReport", "getCashregisterReport", "createPaymentLinkStripe", "stripeCaptureIntent", "hobexPayApi", "hobexRefundApi", "hobexGetStatus", "financeWebService", "listMyTipRecipients", "getPartnerInfo", "createPartnerCustomer", "checkPartnerCustomerEmail", "listPartnerCustomers", "getPartnerCustomer", "sendPartnerCustomerFonLink", "createPartnerWebhook", "updatePartnerWebhook", "deletePartnerWebhook", "listPartnerWebhooks", "sendPartnerWebhookTest", "rotatePartnerWebhookSecret", "listPartnerWebhookDeliveries", "requestCustomerSignature", "getCustomerSignatureStatus", "createCustomerCashregister", "activateCashregister", "listCustomerCashregisters", "getCustomerCredentials", "reportCustomerContract", "getPartnerBilling", "getPartnerBillingMonth", "createCustomer", "getCustomer", "updateCustomer", "searchCustomers", "issueInvoice", "cancelInvoice", "createCreditNote", "getInvoice", "listInvoices", "getInvoicePdf", "getInvoiceXml", "getInvoiceSetupStatus", "listBrands", "recordInvoicePayment", "createInvoiceItem", "updateInvoiceItem", "withdrawInvoiceItem", "getInvoiceItem", "listInvoiceItems", "setCustomerMandate", "revokeCustomerMandate", "getArticle", "listArticles", "lookupArticleByCode", "listLocations", "getStock", "listStock", "listStockMovements", "createWebhook", "updateWebhook", "deleteWebhook", "listWebhooks", "sendWebhookTest", "rotateWebhookSecret", "listWebhookDeliveries", "createArticle", "updateArticle", "deactivateArticle", "receiveGoods", "transferStock", "recordStockLoss", "changeStockCondition", "reverseStockMovement", "createReservation", "extendReservation", "releaseReservation", "getReservation", "listReservations", "createVariantGroup", "updateVariantGroup", "getVariantGroup", "listVariantGroups", "addVariant", "createStocktake", "listStocktakes", "getStocktake", "listStocktakeItems", "recordStocktakeCount", "voidStocktakeCount", "listStocktakeCounts", "reviewStocktake", "recountStocktake", "closeStocktake", "cancelStocktake", "getStocktakePdf", "orderSignatureCard", "getSignatureCardOrder", "listReceipts", "createDepExport", "getDepExport", "getDepExportFile", "createDepHandoverLink", "revokeDepHandoverLink"];
|
|
24
|
+
export declare const PUBLIC_CALLS: readonly ["createReceipt", "getReceipt", "cancelReceipt", "sendReceiptEmail", "generateFullReceiptId", "downloadReceipt", "getFirstReceiptDate", "getReportV2", "downloadReport", "downloadDailyReport", "getCashregisterReport", "createPaymentLinkStripe", "stripeCaptureIntent", "hobexPayApi", "hobexRefundApi", "hobexGetStatus", "financeWebService", "listMyTipRecipients", "getPartnerInfo", "createPartnerCustomer", "checkPartnerCustomerEmail", "listPartnerCustomers", "getPartnerCustomer", "sendPartnerCustomerFonLink", "createPartnerWebhook", "updatePartnerWebhook", "deletePartnerWebhook", "listPartnerWebhooks", "sendPartnerWebhookTest", "rotatePartnerWebhookSecret", "listPartnerWebhookDeliveries", "requestCustomerSignature", "getCustomerSignatureStatus", "createCustomerCashregister", "activateCashregister", "listCustomerCashregisters", "getCustomerCredentials", "reportCustomerContract", "getPartnerBilling", "getPartnerBillingMonth", "createCustomer", "getCustomer", "updateCustomer", "searchCustomers", "issueInvoice", "cancelInvoice", "createCreditNote", "getInvoice", "listInvoices", "getInvoicePdf", "getInvoiceXml", "getInvoiceSetupStatus", "listBrands", "recordInvoicePayment", "createInvoiceItem", "updateInvoiceItem", "withdrawInvoiceItem", "getInvoiceItem", "listInvoiceItems", "setCustomerMandate", "revokeCustomerMandate", "getArticle", "listArticles", "lookupArticleByCode", "listLocations", "getStock", "listStock", "listStockMovements", "createWebhook", "updateWebhook", "deleteWebhook", "listWebhooks", "sendWebhookTest", "rotateWebhookSecret", "listWebhookDeliveries", "createArticle", "updateArticle", "deactivateArticle", "receiveGoods", "transferStock", "recordStockLoss", "changeStockCondition", "reverseStockMovement", "createReservation", "extendReservation", "releaseReservation", "getReservation", "listReservations", "createVariantGroup", "updateVariantGroup", "getVariantGroup", "listVariantGroups", "addVariant", "createStocktake", "listStocktakes", "getStocktake", "listStocktakeItems", "recordStocktakeCount", "voidStocktakeCount", "listStocktakeCounts", "reviewStocktake", "recountStocktake", "closeStocktake", "cancelStocktake", "getStocktakePdf", "orderSignatureCard", "getSignatureCardOrder", "listReceipts", "createDepExport", "getDepExport", "getDepExportFile", "createDepHandoverLink", "revokeDepHandoverLink", "registerTerminalDevice", "getTerminalAccess", "claimTerminal", "requestTerminalCode", "getTerminalCode", "reportTerminalLogin", "reportTerminalReady"];
|
|
25
25
|
/**
|
|
26
26
|
* Die Endpunkte des Kassenwegs (`https://kasse.kasseneck.at/api/v3/<name>`,
|
|
27
27
|
* Web-Kasse: gleicher Ursprung `/api/v3`), in der Reihenfolge von
|
|
@@ -29,7 +29,7 @@ export declare const PUBLIC_CALLS: readonly ["createReceipt", "getReceipt", "can
|
|
|
29
29
|
* die fuenf DEP-Aufrufe); die Kasse ruft sie trotzdem ueber diesen Weg (ein Dialekt
|
|
30
30
|
* je Client, Nachtrag §5.2).
|
|
31
31
|
*/
|
|
32
|
-
export declare const POS_CALLS: readonly ["pairRegisterDevice", "listRegisterUsersForDevice", "listRegisterSessionsForDevice", "registerUserLogin", "registerPinLogin", "renewRegisterSession", "endRegisterSession", "unpairRegisterDevice", "listMyCashregisters", "listMyReceipts", "getReceipt", "createReceipt", "generateFullReceiptId", "cancelReceipt", "sendReceiptEmail", "listMyArticleGroups", "listMyArticles", "getKasseSettings", "setMyKasseSettings", "setMyKasseLogo", "setMyRegisterDeviceSettings", "listMyPrinters", "createPrintJob", "getPrintJob", "listMyTipRecipients", "listMyStockLocations", "listMyStock", "setMyCashregisterStockLocation", "listMyStocktakes", "listMyStocktakeItems", "listMyStocktakeCounts", "recordMyStocktakeCount", "voidMyStocktakeCount", "checkVoucher", "reprintVoucherLabel", "getMyDrawerState", "openMyShift", "recordMyCashMovement", "logMyDrawerOpenings", "getMyShiftReport", "closeMyShift", "logReceiptOutputs", "createDepExport", "getDepExport", "getDepExportFile", "createDepHandoverLink", "revokeDepHandoverLink", "getRegisterInspectionInfo", "reportConnectState"];
|
|
32
|
+
export declare const POS_CALLS: readonly ["pairRegisterDevice", "listRegisterUsersForDevice", "listRegisterSessionsForDevice", "registerUserLogin", "registerPinLogin", "renewRegisterSession", "endRegisterSession", "unpairRegisterDevice", "listMyCashregisters", "listMyReceipts", "getReceipt", "createReceipt", "generateFullReceiptId", "cancelReceipt", "sendReceiptEmail", "listMyArticleGroups", "listMyArticles", "getKasseSettings", "setMyKasseSettings", "setMyKasseLogo", "setMyRegisterDeviceSettings", "listMyPrinters", "createPrintJob", "getPrintJob", "listMyTipRecipients", "listMyStockLocations", "listMyStock", "setMyCashregisterStockLocation", "listMyStocktakes", "listMyStocktakeItems", "listMyStocktakeCounts", "recordMyStocktakeCount", "voidMyStocktakeCount", "checkVoucher", "reprintVoucherLabel", "getMyDrawerState", "openMyShift", "recordMyCashMovement", "logMyDrawerOpenings", "getMyShiftReport", "closeMyShift", "recordMyShiftCount", "logReceiptOutputs", "createDepExport", "getDepExport", "getDepExportFile", "createDepHandoverLink", "revokeDepHandoverLink", "getRegisterInspectionInfo", "reportConnectState"];
|
|
33
33
|
export type PublicCall = typeof PUBLIC_CALLS[number];
|
|
34
34
|
export type PosCall = typeof POS_CALLS[number];
|
|
35
35
|
/**
|
|
@@ -50,7 +50,7 @@ export type PosCall = typeof POS_CALLS[number];
|
|
|
50
50
|
* [ALL_CALLS], [PUBLIC_CALLS] und [POS_CALLS] steht entweder hier oder in
|
|
51
51
|
* [CALLS_WITHOUT_EFFECT] (Waechter `test/ausgang-einordnung.test.ts`).
|
|
52
52
|
*/
|
|
53
|
-
export declare const UNKNOWN_OUTCOME_CALLS: readonly ["activateCashregister", "addVariant", "cancelInvoice", "cancelReceipt", "cancelStocktake", "changeStockCondition", "closeMyShift", "closeStocktake", "createArticle", "createCreditNote", "createCustomer", "createCustomerCashregister", "createInvoiceItem", "createPartnerCustomer", "createPartnerWebhook", "createPrintJob", "createReceipt", "createReservation", "createStocktake", "createVariantGroup", "createWebhook", "deactivateArticle", "deletePartnerWebhook", "deleteWebhook", "extendReservation", "financeWebService", "hobexPayApi", "hobexRefundApi", "issueInvoice", "logMyDrawerOpenings", "logReceiptOutputs", "openMyShift", "orderSignatureCard", "pairRegisterDevice", "receiveGoods", "recordInvoicePayment", "recordMyCashMovement", "recordMyStocktakeCount", "recordStockLoss", "recordStocktakeCount", "recountStocktake", "releaseReservation", "reportConnectState", "reportCustomerContract", "requestCustomerSignature", "reverseStockMovement", "reviewStocktake", "revokeCustomerMandate", "rotatePartnerWebhookSecret", "rotateWebhookSecret", "sendPartnerCustomerFonLink", "sendPartnerWebhookTest", "sendReceiptEmail", "sendWebhookTest", "setCustomerMandate", "setMyCashregisterStockLocation", "setMyKasseLogo", "setMyKasseSettings", "setMyRegisterDeviceSettings", "stripeCaptureIntent", "transferStock", "unpairRegisterDevice", "updateArticle", "updateCustomer", "updateInvoiceItem", "updatePartnerWebhook", "updateVariantGroup", "updateWebhook", "voidMyStocktakeCount", "voidStocktakeCount", "withdrawInvoiceItem"];
|
|
53
|
+
export declare const UNKNOWN_OUTCOME_CALLS: readonly ["activateCashregister", "addVariant", "cancelInvoice", "cancelReceipt", "cancelStocktake", "changeStockCondition", "closeMyShift", "closeStocktake", "createArticle", "createCreditNote", "createCustomer", "createCustomerCashregister", "createInvoiceItem", "createPartnerCustomer", "createPartnerWebhook", "createPrintJob", "createReceipt", "createReservation", "createStocktake", "createVariantGroup", "createWebhook", "deactivateArticle", "deletePartnerWebhook", "deleteWebhook", "extendReservation", "financeWebService", "getTerminalCode", "hobexPayApi", "hobexRefundApi", "issueInvoice", "logMyDrawerOpenings", "logReceiptOutputs", "openMyShift", "orderSignatureCard", "pairRegisterDevice", "receiveGoods", "recordInvoicePayment", "recordMyCashMovement", "recordMyShiftCount", "recordMyStocktakeCount", "recordStockLoss", "recordStocktakeCount", "recountStocktake", "registerTerminalDevice", "releaseReservation", "reportConnectState", "reportCustomerContract", "requestCustomerSignature", "reverseStockMovement", "reviewStocktake", "revokeCustomerMandate", "rotatePartnerWebhookSecret", "rotateWebhookSecret", "sendPartnerCustomerFonLink", "sendPartnerWebhookTest", "sendReceiptEmail", "sendWebhookTest", "setCustomerMandate", "setMyCashregisterStockLocation", "setMyKasseLogo", "setMyKasseSettings", "setMyRegisterDeviceSettings", "stripeCaptureIntent", "transferStock", "unpairRegisterDevice", "updateArticle", "updateCustomer", "updateInvoiceItem", "updatePartnerWebhook", "updateVariantGroup", "updateWebhook", "voidMyStocktakeCount", "voidStocktakeCount", "withdrawInvoiceItem"];
|
|
54
54
|
/** Warum ein Aufruf keine Wirkung hat, die ein Zeitlimit offen lassen koennte. */
|
|
55
55
|
export type CallWithoutEffectReason = 'read' | 'repeatable';
|
|
56
56
|
/**
|
|
@@ -144,12 +144,21 @@ export const ALL_CALLS = [
|
|
|
144
144
|
'logMyDrawerOpenings',
|
|
145
145
|
'getMyShiftReport',
|
|
146
146
|
'closeMyShift',
|
|
147
|
+
'recordMyShiftCount',
|
|
147
148
|
// Ausgaben eines Belegs (Drucke, Teilen) melden: nur ueber den Kassenweg.
|
|
148
149
|
'logReceiptOutputs',
|
|
149
150
|
// Kasseninfo fuer die Pruefung (Kassennachschau, Stufe 2b, ./pos): nur ueber den Kassenweg.
|
|
150
151
|
'getRegisterInspectionInfo',
|
|
151
152
|
// Connect-Bestand (./pos): welche Connect-Version an welchem Kassengeraet laeuft; nur ueber den Kassenweg.
|
|
152
153
|
'reportConnectState',
|
|
154
|
+
// Kartenterminal am Handy: Geraet, Zugang, TID und Code (nur /v3).
|
|
155
|
+
'registerTerminalDevice',
|
|
156
|
+
'getTerminalAccess',
|
|
157
|
+
'claimTerminal',
|
|
158
|
+
'requestTerminalCode',
|
|
159
|
+
'getTerminalCode',
|
|
160
|
+
'reportTerminalLogin',
|
|
161
|
+
'reportTerminalReady',
|
|
153
162
|
];
|
|
154
163
|
/**
|
|
155
164
|
* Die oeffentlichen Endpunkte unter `/v3` (`https://api.kasseneck.at/v3/<name>`),
|
|
@@ -280,6 +289,14 @@ export const PUBLIC_CALLS = [
|
|
|
280
289
|
'getDepExportFile',
|
|
281
290
|
'createDepHandoverLink',
|
|
282
291
|
'revokeDepHandoverLink',
|
|
292
|
+
// Kartenterminal am Handy (api_key + Geraete-Ausweis), nur unter /v3; am Kassenweg noch nicht.
|
|
293
|
+
'registerTerminalDevice',
|
|
294
|
+
'getTerminalAccess',
|
|
295
|
+
'claimTerminal',
|
|
296
|
+
'requestTerminalCode',
|
|
297
|
+
'getTerminalCode',
|
|
298
|
+
'reportTerminalLogin',
|
|
299
|
+
'reportTerminalReady',
|
|
283
300
|
];
|
|
284
301
|
/**
|
|
285
302
|
* Die Endpunkte des Kassenwegs (`https://kasse.kasseneck.at/api/v3/<name>`,
|
|
@@ -334,6 +351,7 @@ export const POS_CALLS = [
|
|
|
334
351
|
'logMyDrawerOpenings',
|
|
335
352
|
'getMyShiftReport',
|
|
336
353
|
'closeMyShift',
|
|
354
|
+
'recordMyShiftCount',
|
|
337
355
|
// Ausgaben eines Belegs melden: nur ueber den Kassenweg.
|
|
338
356
|
'logReceiptOutputs',
|
|
339
357
|
// DEP fuer die Kassennachschau (Stufe 2): zugleich oeffentlich; an der Kasse nur fuer den Chef (manager_only).
|
|
@@ -392,6 +410,8 @@ export const UNKNOWN_OUTCOME_CALLS = [
|
|
|
392
410
|
'deleteWebhook',
|
|
393
411
|
'extendReservation',
|
|
394
412
|
'financeWebService',
|
|
413
|
+
// Auf Android verbraucht die Antwort den Code: nach einem Zeitlimit kann er zugestellt und weg sein.
|
|
414
|
+
'getTerminalCode',
|
|
395
415
|
'hobexPayApi',
|
|
396
416
|
'hobexRefundApi',
|
|
397
417
|
'issueInvoice',
|
|
@@ -403,10 +423,12 @@ export const UNKNOWN_OUTCOME_CALLS = [
|
|
|
403
423
|
'receiveGoods',
|
|
404
424
|
'recordInvoicePayment',
|
|
405
425
|
'recordMyCashMovement',
|
|
426
|
+
'recordMyShiftCount',
|
|
406
427
|
'recordMyStocktakeCount',
|
|
407
428
|
'recordStockLoss',
|
|
408
429
|
'recordStocktakeCount',
|
|
409
430
|
'recountStocktake',
|
|
431
|
+
'registerTerminalDevice',
|
|
410
432
|
'releaseReservation',
|
|
411
433
|
'reportConnectState',
|
|
412
434
|
'reportCustomerContract',
|
|
@@ -465,6 +487,8 @@ export const UNKNOWN_OUTCOME_CALLS = [
|
|
|
465
487
|
export const CALLS_WITHOUT_EFFECT = Object.freeze({
|
|
466
488
|
checkPartnerCustomerEmail: 'read',
|
|
467
489
|
checkVoucher: 'read',
|
|
490
|
+
// Kartenterminal: dieselbe TID noch einmal uebernehmen aendert nichts am Server.
|
|
491
|
+
claimTerminal: 'repeatable',
|
|
468
492
|
downloadDailyReport: 'read',
|
|
469
493
|
downloadReceipt: 'read',
|
|
470
494
|
downloadReport: 'read',
|
|
@@ -507,6 +531,8 @@ export const CALLS_WITHOUT_EFFECT = Object.freeze({
|
|
|
507
531
|
getStocktake: 'read',
|
|
508
532
|
getSignatureCardOrder: 'read',
|
|
509
533
|
getStocktakePdf: 'read',
|
|
534
|
+
// Behaelt die TID des Geraets bzw. vergibt eine freie; eine Wiederholung liefert dieselbe Zuordnung und bucht nichts.
|
|
535
|
+
getTerminalAccess: 'repeatable',
|
|
510
536
|
getVariantGroup: 'read',
|
|
511
537
|
hobexGetStatus: 'read',
|
|
512
538
|
listArticles: 'read',
|
|
@@ -545,7 +571,12 @@ export const CALLS_WITHOUT_EFFECT = Object.freeze({
|
|
|
545
571
|
registerPinLogin: 'repeatable',
|
|
546
572
|
registerUserLogin: 'repeatable',
|
|
547
573
|
renewRegisterSession: 'repeatable',
|
|
574
|
+
// Kartenterminal: Anmeldung und Einrichtung melden schreiben denselben Stand noch einmal.
|
|
575
|
+
reportTerminalLogin: 'repeatable',
|
|
576
|
+
reportTerminalReady: 'repeatable',
|
|
548
577
|
reprintVoucherLabel: 'repeatable',
|
|
578
|
+
// Eine offene Code-Anfrage juenger als 6 Minuten bleibt; eine Wiederholung legt keine neue an.
|
|
579
|
+
requestTerminalCode: 'repeatable',
|
|
549
580
|
searchCustomers: 'read',
|
|
550
581
|
});
|
|
551
582
|
const MIT_WIRKUNG = new Set(UNKNOWN_OUTCOME_CALLS);
|
|
@@ -6,6 +6,7 @@ export { type ReceiptCommonOptions, type SellReceiptOptions, type TipOptions, ty
|
|
|
6
6
|
export { listMyCashregisters } from './cashregisters.js';
|
|
7
7
|
export { listReceipts, listAllReceipts, fromListReceiptsSummaryPayload, listedReceiptWithCompany, LIST_RECEIPTS_VIEWS, LIST_RECEIPTS_ORDERS, LIST_RECEIPTS_LIMIT_MAX, LIST_RECEIPTS_DAYS_MAX, LIST_ALL_RECEIPTS_MAX_PAGES, LIST_RECEIPTS_ERROR_CODES, type ListReceiptsErrorCode, type ListReceiptsView, type ListReceiptsOrder, type ListReceiptsOptions, type ListReceiptsWindow, type ListReceiptsGrossByRate, type ListReceiptsSummary, type ListReceiptsDaySummary, type ListReceiptsPage, type ListedReceipt, type ListedFullReceipt, type ListReceiptsHeader, } from './list-receipts.js';
|
|
8
8
|
export { createDepExport, getDepExport, waitForDepExport, getDepExportFile, createDepHandoverLink, revokeDepHandoverLink, DepExportTimeoutError, DepExportChecksumError, DEP_EXPORT_STATUSES, DEP_EXPORT_FILES, DEP_EXPORT_ERROR_CODES, DEP_EXPORT_FAILURES, DEP_EXPORT_POLL_START_MS, DEP_EXPORT_POLL_FACTOR, DEP_EXPORT_POLL_MAX_MS, DEP_EXPORT_WAIT_TIMEOUT_MS, DEP_EXPORT_DOWNLOAD_TIMEOUT_MS, type DepExportStatus, type DepExportFileKind, type DepExportErrorCode, type DepExportFailure, type CreateDepExportOptions, type CreateDepExportResult, type DepExportGap, type DepExportChainBreak, type DepExportFindings, type DepExportItems, type DepHandoverLinkInfo, type DepExport, type WaitForDepExportOptions, type GetDepExportFileOptions, type DepExportFile, type DepHandoverLink, type RevokedDepHandoverLink, } from './dep-export.js';
|
|
9
|
+
export { registerTerminalDevice, getTerminalAccess, claimTerminal, requestTerminalCode, getTerminalCode, reportTerminalLogin, reportTerminalReady, TERMINAL_PLATFORMS, TERMINAL_SETUP_STATES, TERMINAL_CODE_STATUSES, TERMINAL_CODE_SOURCES, TERMINAL_ERROR_CODES, TERMINAL_LABEL_MAX, TERMINAL_APP_MAX, TERMINAL_REQUESTED_BY_MAX, type TerminalPlatform, type TerminalSetupState, type TerminalCodeStatus, type TerminalCodeSource, type TerminalErrorCode, type TerminalDeviceCredentials, type RegisterTerminalDeviceOptions, type RegisteredTerminalDevice, type GetTerminalAccessOptions, type ClaimTerminalOptions, type RequestTerminalCodeOptions, type ReportTerminalLoginOptions, type TerminalSetup, type TerminalCodeFormat, type TerminalAccess, type TerminalListEntry, type TerminalAccessUnavailable, type TerminalAccessResult, type TerminalCodeRequest, type TerminalCode, } from './terminal.js';
|
|
9
10
|
export { downloadDailyReport, downloadMonthlyReport, getCashregisterReport, getReportV2, type CashregisterReportPeriod, type ReportV2, type ReportV2Metadata, type ReportV2Options } from './reports.js';
|
|
10
11
|
export { type CashboxStatus, type SignatureStatus, getCashboxStatus, getSignatureStatus, } from './status.js';
|
|
11
12
|
export { type KasseneckApi, createKasseneckApi } from './api.js';
|
package/dist/esm/client/index.js
CHANGED
|
@@ -6,6 +6,7 @@ export { sellReceipt, sellReceiptWithCompany, paymentsExpectedCents, cardRefundR
|
|
|
6
6
|
export { listMyCashregisters } from './cashregisters.js';
|
|
7
7
|
export { listReceipts, listAllReceipts, fromListReceiptsSummaryPayload, listedReceiptWithCompany, LIST_RECEIPTS_VIEWS, LIST_RECEIPTS_ORDERS, LIST_RECEIPTS_LIMIT_MAX, LIST_RECEIPTS_DAYS_MAX, LIST_ALL_RECEIPTS_MAX_PAGES, LIST_RECEIPTS_ERROR_CODES, } from './list-receipts.js';
|
|
8
8
|
export { createDepExport, getDepExport, waitForDepExport, getDepExportFile, createDepHandoverLink, revokeDepHandoverLink, DepExportTimeoutError, DepExportChecksumError, DEP_EXPORT_STATUSES, DEP_EXPORT_FILES, DEP_EXPORT_ERROR_CODES, DEP_EXPORT_FAILURES, DEP_EXPORT_POLL_START_MS, DEP_EXPORT_POLL_FACTOR, DEP_EXPORT_POLL_MAX_MS, DEP_EXPORT_WAIT_TIMEOUT_MS, DEP_EXPORT_DOWNLOAD_TIMEOUT_MS, } from './dep-export.js';
|
|
9
|
+
export { registerTerminalDevice, getTerminalAccess, claimTerminal, requestTerminalCode, getTerminalCode, reportTerminalLogin, reportTerminalReady, TERMINAL_PLATFORMS, TERMINAL_SETUP_STATES, TERMINAL_CODE_STATUSES, TERMINAL_CODE_SOURCES, TERMINAL_ERROR_CODES, TERMINAL_LABEL_MAX, TERMINAL_APP_MAX, TERMINAL_REQUESTED_BY_MAX, } from './terminal.js';
|
|
9
10
|
export { downloadDailyReport, downloadMonthlyReport, getCashregisterReport, getReportV2 } from './reports.js';
|
|
10
11
|
export { getCashboxStatus, getSignatureStatus, } from './status.js';
|
|
11
12
|
export { createKasseneckApi } from './api.js';
|
|
@@ -0,0 +1,206 @@
|
|
|
1
|
+
import type { InternerTransport } from './aufrufe.js';
|
|
2
|
+
/**
|
|
3
|
+
* Kartenterminal am Handy (nur unter `/v3`): Kasseneck verwaltet die Zugaenge
|
|
4
|
+
* der Terminal-App, die Terminal-IDs (TID) je Betrieb und den Code, den der
|
|
5
|
+
* Anbieter beim Umzug einer TID auf ein anderes Geraet per E-Mail schickt.
|
|
6
|
+
* Die App holt sich Zugang, TID und Code von hier; am Geraet tippt niemand
|
|
7
|
+
* E-Mail, Passwort oder TID.
|
|
8
|
+
*
|
|
9
|
+
* **Anmeldung:** der `api_key` des Betriebs als Bearer. Ein `cashregister-token`
|
|
10
|
+
* (wie ihn `apiKeyAuth` mitsendet) stoert nicht, wird aber nicht gebraucht; eine
|
|
11
|
+
* App ohne Kasse nimmt eine Anmeldung nur mit dem Schluessel (etwa
|
|
12
|
+
* `inventoryKeyAuth` aus `./inventory`). Das Geraet weist sich zusaetzlich mit
|
|
13
|
+
* `deviceId` + `deviceSecret` aus, die es einmal mit [registerTerminalDevice]
|
|
14
|
+
* bekommt. Am Kassenweg gibt es die Aufrufe noch nicht.
|
|
15
|
+
*
|
|
16
|
+
* **Geheimnisse:** `deviceSecret`, `password` und `code` stehen nur in den
|
|
17
|
+
* Antworten bzw. Anfragen. Das Paket schreibt sie in kein Log und in keinen
|
|
18
|
+
* Fehler (das Geraetegeheimnis geht als `secretParams` an den Transport); die
|
|
19
|
+
* App darf sie ebenfalls nie loggen und speichert `deviceSecret` im sicheren
|
|
20
|
+
* Speicher des Geraets.
|
|
21
|
+
*
|
|
22
|
+
* Geprueft wird hier nur die Form; was der Server nicht annimmt, lehnt er mit
|
|
23
|
+
* einem Code aus [TERMINAL_ERROR_CODES] ab.
|
|
24
|
+
*/
|
|
25
|
+
/** Plattform des Geraets. */
|
|
26
|
+
export declare const TERMINAL_PLATFORMS: readonly ["android", "ios"];
|
|
27
|
+
export type TerminalPlatform = (typeof TERMINAL_PLATFORMS)[number];
|
|
28
|
+
/**
|
|
29
|
+
* Einrichtungsstand der Terminal-App am Geraet: TID zugewiesen, wartet auf den
|
|
30
|
+
* Code, wird eingerichtet, bereit, fehlgeschlagen.
|
|
31
|
+
*/
|
|
32
|
+
export declare const TERMINAL_SETUP_STATES: readonly ["assigned", "waiting_for_code", "setting_up", "ready", "failed"];
|
|
33
|
+
export type TerminalSetupState = (typeof TERMINAL_SETUP_STATES)[number];
|
|
34
|
+
/**
|
|
35
|
+
* Stand einer Code-Anfrage: keine Anfrage, sucht, gefunden, zugestellt,
|
|
36
|
+
* unklar (mehrere Geraete warteten gleichzeitig), kein Code gefunden,
|
|
37
|
+
* abgelaufen.
|
|
38
|
+
*/
|
|
39
|
+
export declare const TERMINAL_CODE_STATUSES: readonly ["none", "searching", "found", "delivered", "unclear", "no_code", "expired"];
|
|
40
|
+
export type TerminalCodeStatus = (typeof TERMINAL_CODE_STATUSES)[number];
|
|
41
|
+
/** Woher ein Code kam: aus dem Postfach oder vom Support eingetragen. */
|
|
42
|
+
export declare const TERMINAL_CODE_SOURCES: readonly ["mailbox", "support"];
|
|
43
|
+
export type TerminalCodeSource = (typeof TERMINAL_CODE_SOURCES)[number];
|
|
44
|
+
/**
|
|
45
|
+
* Fehlercodes der sieben Aufrufe (`code` des [KasseneckApiError]) wie im
|
|
46
|
+
* Vertrag des Backends (`errorCodes.terminal` in `fixtures/v3/v3-vokabular.json`),
|
|
47
|
+
* in dessen Reihenfolge; dazu kommen die gemeinsamen Codes von Anmeldung und
|
|
48
|
+
* Rand. Ein Code ausserhalb bleibt ueber `KasseneckApiError.code` lesbar.
|
|
49
|
+
*/
|
|
50
|
+
export declare const TERMINAL_ERROR_CODES: readonly ["terminal_not_enabled", "terminal_test_environment", "terminal_device_unknown", "terminal_device_blocked", "invalid_terminal_device", "too_many_terminal_devices", "terminal_not_in_business", "terminal_code_manual", "terminal_code_rate_limited", "terminal_not_assigned", "server_error"];
|
|
51
|
+
export type TerminalErrorCode = (typeof TERMINAL_ERROR_CODES)[number];
|
|
52
|
+
/** Laengen der Texte, die der Server annimmt (nach Abzug von Leerraum am Rand). */
|
|
53
|
+
export declare const TERMINAL_LABEL_MAX = 60;
|
|
54
|
+
export declare const TERMINAL_APP_MAX = 40;
|
|
55
|
+
export declare const TERMINAL_REQUESTED_BY_MAX = 80;
|
|
56
|
+
/** Ausweis des Geraets, aus [registerTerminalDevice]. */
|
|
57
|
+
export interface TerminalDeviceCredentials {
|
|
58
|
+
deviceId: string;
|
|
59
|
+
/** Geheimnis des Geraets: nur im sicheren Speicher ablegen, nie loggen. */
|
|
60
|
+
deviceSecret: string;
|
|
61
|
+
}
|
|
62
|
+
/** Eingabe von [registerTerminalDevice]. */
|
|
63
|
+
export interface RegisterTerminalDeviceOptions {
|
|
64
|
+
/** Anzeige des Geraets, 1 bis 60 Zeichen (etwa Modell und Fahrer). */
|
|
65
|
+
label: string;
|
|
66
|
+
platform: TerminalPlatform;
|
|
67
|
+
/** App und Version, 1 bis 40 Zeichen, z. B. `karteck/1.6.21`. */
|
|
68
|
+
app: string;
|
|
69
|
+
/** Wer das Geraet anmeldet, hoechstens 80 Zeichen; steht im Protokoll. */
|
|
70
|
+
requestedBy?: string;
|
|
71
|
+
}
|
|
72
|
+
/** Antwort von [registerTerminalDevice]. `deviceSecret` kommt nur in dieser Antwort, danach nie wieder. */
|
|
73
|
+
export type RegisteredTerminalDevice = TerminalDeviceCredentials;
|
|
74
|
+
/** Eingabe von [getTerminalAccess]: Ausweis, dazu optional neue Anzeigewerte des Geraets. */
|
|
75
|
+
export interface GetTerminalAccessOptions extends TerminalDeviceCredentials {
|
|
76
|
+
platform?: TerminalPlatform;
|
|
77
|
+
/** App und Version, 1 bis 40 Zeichen. */
|
|
78
|
+
app?: string;
|
|
79
|
+
/** Anzeige des Geraets, 1 bis 60 Zeichen. */
|
|
80
|
+
label?: string;
|
|
81
|
+
}
|
|
82
|
+
/** Eingabe von [claimTerminal]. */
|
|
83
|
+
export interface ClaimTerminalOptions extends TerminalDeviceCredentials {
|
|
84
|
+
/** TID aus `TerminalAccessUnavailable.terminals`. */
|
|
85
|
+
terminalId: string;
|
|
86
|
+
/** Anzeige des Geraets, 1 bis 60 Zeichen. */
|
|
87
|
+
label?: string;
|
|
88
|
+
}
|
|
89
|
+
/** Eingabe von [requestTerminalCode]. */
|
|
90
|
+
export interface RequestTerminalCodeOptions extends TerminalDeviceCredentials {
|
|
91
|
+
platform: TerminalPlatform;
|
|
92
|
+
/** Wer den Code anfragt, hoechstens 80 Zeichen; steht im Protokoll. */
|
|
93
|
+
requestedBy?: string;
|
|
94
|
+
}
|
|
95
|
+
/** Eingabe von [reportTerminalLogin]. */
|
|
96
|
+
export interface ReportTerminalLoginOptions extends TerminalDeviceCredentials {
|
|
97
|
+
/** TID, mit der sich die Terminal-App angemeldet hat. */
|
|
98
|
+
terminalId: string;
|
|
99
|
+
success: boolean;
|
|
100
|
+
/** Erste Anmeldung dieser TID auf diesem Geraet. */
|
|
101
|
+
newOnDevice: boolean;
|
|
102
|
+
}
|
|
103
|
+
/** Einrichtungsstand mit Zeitpunkt (ISO 8601, UTC). Ein spaeter ergaenzter Stand kommt unveraendert an. */
|
|
104
|
+
export interface TerminalSetup {
|
|
105
|
+
state: TerminalSetupState | (string & {});
|
|
106
|
+
since: string | null;
|
|
107
|
+
}
|
|
108
|
+
/** Wie die App einen eingefuegten Code prueft: Laenge und Bezeichnungen vor dem Code in der Mail. */
|
|
109
|
+
export interface TerminalCodeFormat {
|
|
110
|
+
length: number;
|
|
111
|
+
labels: string[];
|
|
112
|
+
}
|
|
113
|
+
/** Zugang fuer die Terminal-App ([getTerminalAccess], [claimTerminal]). */
|
|
114
|
+
export interface TerminalAccess {
|
|
115
|
+
available: true;
|
|
116
|
+
/** Login der Terminal-App. */
|
|
117
|
+
username: string;
|
|
118
|
+
/** Passwort der Terminal-App: nie loggen, nie dauerhaft ausserhalb des sicheren Speichers ablegen. */
|
|
119
|
+
password: string;
|
|
120
|
+
terminalId: string;
|
|
121
|
+
terminalName: string | null;
|
|
122
|
+
accountId: string;
|
|
123
|
+
/** `true`: der Code kommt automatisch ([requestTerminalCode]); sonst fragt die App den Menschen danach. */
|
|
124
|
+
autoCode: boolean;
|
|
125
|
+
codeFormat: TerminalCodeFormat;
|
|
126
|
+
setup: TerminalSetup;
|
|
127
|
+
/** Letzte Aenderung von Konto oder Zuordnung (ISO 8601), `null` unbekannt. */
|
|
128
|
+
updatedAt: string | null;
|
|
129
|
+
}
|
|
130
|
+
/** Eine TID des eigenen Betriebs, die gerade ein anderes Geraet nutzt. */
|
|
131
|
+
export interface TerminalListEntry {
|
|
132
|
+
terminalId: string;
|
|
133
|
+
name: string | null;
|
|
134
|
+
/** Anzeige des Geraets, das sie zuletzt nutzte. */
|
|
135
|
+
lastUsedBy: string | null;
|
|
136
|
+
lastUsedAt: string | null;
|
|
137
|
+
}
|
|
138
|
+
/** Keine TID frei: die TIDs des eigenen Betriebs zur Auswahl fuer [claimTerminal]. */
|
|
139
|
+
export interface TerminalAccessUnavailable {
|
|
140
|
+
available: false;
|
|
141
|
+
reason: 'no_free_terminal' | (string & {});
|
|
142
|
+
terminals: TerminalListEntry[];
|
|
143
|
+
}
|
|
144
|
+
/** Antwort von [getTerminalAccess]: Zugang oder Liste. */
|
|
145
|
+
export type TerminalAccessResult = TerminalAccess | TerminalAccessUnavailable;
|
|
146
|
+
/** Antwort von [requestTerminalCode]. */
|
|
147
|
+
export interface TerminalCodeRequest {
|
|
148
|
+
status: TerminalCodeStatus | (string & {});
|
|
149
|
+
}
|
|
150
|
+
/**
|
|
151
|
+
* Antwort von [getTerminalCode]. `code` (6 Zeichen, Gross-/Kleinschreibung
|
|
152
|
+
* zaehlt) nur bei `found` bzw. auf iOS auch bei `delivered` bis `validUntil`.
|
|
153
|
+
*/
|
|
154
|
+
export interface TerminalCode {
|
|
155
|
+
status: TerminalCodeStatus | (string & {});
|
|
156
|
+
/** Der Code: nie loggen. */
|
|
157
|
+
code?: string;
|
|
158
|
+
source?: TerminalCodeSource | (string & {});
|
|
159
|
+
validUntil?: string | null;
|
|
160
|
+
setup: TerminalSetup;
|
|
161
|
+
}
|
|
162
|
+
/**
|
|
163
|
+
* Meldet ein Geraet einmal an (`registerTerminalDevice`) und liefert seinen
|
|
164
|
+
* Ausweis. `deviceSecret` steht nur in dieser Antwort: im sicheren Speicher
|
|
165
|
+
* ablegen, nie loggen. Hoechstens 20 Geraete je Betrieb und 10 Anmeldungen je
|
|
166
|
+
* Tag (`too_many_terminal_devices`). Eine Wiederholung nach unklarem Ausgang
|
|
167
|
+
* legt ein weiteres Geraet an.
|
|
168
|
+
*/
|
|
169
|
+
export declare function registerTerminalDevice(transport: InternerTransport, options: RegisterTerminalDeviceOptions): Promise<RegisteredTerminalDevice>;
|
|
170
|
+
/**
|
|
171
|
+
* Zugang und TID fuer dieses Geraet (`getTerminalAccess`). Das Geraet behaelt
|
|
172
|
+
* seine TID; ohne eine bekommt es eine freie seines Betriebs. Ist keine frei,
|
|
173
|
+
* kommt `available: false` mit den TIDs des eigenen Betriebs zur Auswahl fuer
|
|
174
|
+
* [claimTerminal]. Die App ruft das bei jedem Start und mindestens einmal am
|
|
175
|
+
* Tag. `password` nie loggen.
|
|
176
|
+
*/
|
|
177
|
+
export declare function getTerminalAccess(transport: InternerTransport, options: GetTerminalAccessOptions): Promise<TerminalAccessResult>;
|
|
178
|
+
/**
|
|
179
|
+
* Uebernimmt eine TID des eigenen Betriebs (`claimTerminal`); das Geraet, das
|
|
180
|
+
* sie bisher nutzte, verliert sie. Antwort wie [getTerminalAccess] mit
|
|
181
|
+
* Zugang. Eine fremde oder unbekannte TID ist `terminal_not_in_business`.
|
|
182
|
+
*/
|
|
183
|
+
export declare function claimTerminal(transport: InternerTransport, options: ClaimTerminalOptions): Promise<TerminalAccess>;
|
|
184
|
+
/**
|
|
185
|
+
* Fragt den Code fuer die TID dieses Geraets an (`requestTerminalCode`); nur
|
|
186
|
+
* bei Konten mit Postfach (`TerminalAccess.autoCode`), sonst
|
|
187
|
+
* `terminal_code_manual`. Eine offene Anfrage juenger als 6 Minuten bleibt
|
|
188
|
+
* (doppeltes Tippen schadet nicht); hoechstens 6 Anfragen je Stunde
|
|
189
|
+
* (`terminal_code_rate_limited`). Den Code holt danach [getTerminalCode].
|
|
190
|
+
*/
|
|
191
|
+
export declare function requestTerminalCode(transport: InternerTransport, options: RequestTerminalCodeOptions): Promise<TerminalCodeRequest>;
|
|
192
|
+
/**
|
|
193
|
+
* Stand der Code-Anfrage und der Einrichtung (`getTerminalCode`); ohne Anfrage
|
|
194
|
+
* `status: 'none'`. Bei `found` steht der Code genau in dieser Antwort: auf
|
|
195
|
+
* Android wird er dabei verbraucht (eine verlorene Antwort verliert ihn), auf
|
|
196
|
+
* iOS bleibt er bis `validUntil` lesbar. Den Code nie loggen.
|
|
197
|
+
*/
|
|
198
|
+
export declare function getTerminalCode(transport: InternerTransport, options: TerminalDeviceCredentials): Promise<TerminalCode>;
|
|
199
|
+
/**
|
|
200
|
+
* Meldet den Ausgang der Anmeldung in der Terminal-App (`reportTerminalLogin`).
|
|
201
|
+
* Antwort: nichts. Eine andere als die zugewiesene TID schreibt der Server
|
|
202
|
+
* nicht.
|
|
203
|
+
*/
|
|
204
|
+
export declare function reportTerminalLogin(transport: InternerTransport, options: ReportTerminalLoginOptions): Promise<void>;
|
|
205
|
+
/** Meldet, dass die Terminal-App fertig eingerichtet ist (`reportTerminalReady`). Antwort: nichts. */
|
|
206
|
+
export declare function reportTerminalReady(transport: InternerTransport, options: TerminalDeviceCredentials): Promise<void>;
|