@kreiseck/kasseneck-api 1.28.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 +11 -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 +3 -3
- package/dist/cjs/client/aufrufe.js +28 -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/stored/vokabular.d.ts +1 -1
- package/dist/cjs/stored/vokabular.js +1 -1
- 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 +3 -3
- package/dist/esm/client/aufrufe.js +28 -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/stored/vokabular.d.ts +1 -1
- package/dist/esm/stored/vokabular.js +1 -1
- package/dist/esm/version.d.ts +1 -1
- package/dist/esm/version.js +1 -1
- 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 +1 -1
- package/fixtures/surface.json +19 -3
- package/fixtures/v3/antworten/belege.json +1 -1
- package/fixtures/v3/antworten/belegmail.json +1 -1
- package/fixtures/v3/antworten/berichte.json +1 -1
- package/fixtures/v3/antworten/kasse-belege.json +1 -1
- package/fixtures/v3/antworten/kasse.json +2 -2
- package/fixtures/v3/antworten/lager.json +1 -1
- package/fixtures/v3/antworten/rechnungen.json +1 -1
- package/fixtures/v3/antworten/storno.json +1 -1
- package/fixtures/v3/stored/belege.json +1 -1
- package/fixtures/v3/stored/kasse.json +2 -2
- package/fixtures/v3/stored/rechnungen.json +1 -1
- package/fixtures/v3/v3-vokabular.json +55 -4
- package/fixtures/v3/zahlbetrag-faelle.json +1 -1
- package/package.json +1 -1
|
@@ -0,0 +1,288 @@
|
|
|
1
|
+
"use strict";
|
|
2
|
+
Object.defineProperty(exports, "__esModule", { value: true });
|
|
3
|
+
exports.TERMINAL_REQUESTED_BY_MAX = exports.TERMINAL_APP_MAX = exports.TERMINAL_LABEL_MAX = exports.TERMINAL_ERROR_CODES = exports.TERMINAL_CODE_SOURCES = exports.TERMINAL_CODE_STATUSES = exports.TERMINAL_SETUP_STATES = exports.TERMINAL_PLATFORMS = void 0;
|
|
4
|
+
exports.registerTerminalDevice = registerTerminalDevice;
|
|
5
|
+
exports.getTerminalAccess = getTerminalAccess;
|
|
6
|
+
exports.claimTerminal = claimTerminal;
|
|
7
|
+
exports.requestTerminalCode = requestTerminalCode;
|
|
8
|
+
exports.getTerminalCode = getTerminalCode;
|
|
9
|
+
exports.reportTerminalLogin = reportTerminalLogin;
|
|
10
|
+
exports.reportTerminalReady = reportTerminalReady;
|
|
11
|
+
const errors_js_1 = require("./errors.js");
|
|
12
|
+
/**
|
|
13
|
+
* Kartenterminal am Handy (nur unter `/v3`): Kasseneck verwaltet die Zugaenge
|
|
14
|
+
* der Terminal-App, die Terminal-IDs (TID) je Betrieb und den Code, den der
|
|
15
|
+
* Anbieter beim Umzug einer TID auf ein anderes Geraet per E-Mail schickt.
|
|
16
|
+
* Die App holt sich Zugang, TID und Code von hier; am Geraet tippt niemand
|
|
17
|
+
* E-Mail, Passwort oder TID.
|
|
18
|
+
*
|
|
19
|
+
* **Anmeldung:** der `api_key` des Betriebs als Bearer. Ein `cashregister-token`
|
|
20
|
+
* (wie ihn `apiKeyAuth` mitsendet) stoert nicht, wird aber nicht gebraucht; eine
|
|
21
|
+
* App ohne Kasse nimmt eine Anmeldung nur mit dem Schluessel (etwa
|
|
22
|
+
* `inventoryKeyAuth` aus `./inventory`). Das Geraet weist sich zusaetzlich mit
|
|
23
|
+
* `deviceId` + `deviceSecret` aus, die es einmal mit [registerTerminalDevice]
|
|
24
|
+
* bekommt. Am Kassenweg gibt es die Aufrufe noch nicht.
|
|
25
|
+
*
|
|
26
|
+
* **Geheimnisse:** `deviceSecret`, `password` und `code` stehen nur in den
|
|
27
|
+
* Antworten bzw. Anfragen. Das Paket schreibt sie in kein Log und in keinen
|
|
28
|
+
* Fehler (das Geraetegeheimnis geht als `secretParams` an den Transport); die
|
|
29
|
+
* App darf sie ebenfalls nie loggen und speichert `deviceSecret` im sicheren
|
|
30
|
+
* Speicher des Geraets.
|
|
31
|
+
*
|
|
32
|
+
* Geprueft wird hier nur die Form; was der Server nicht annimmt, lehnt er mit
|
|
33
|
+
* einem Code aus [TERMINAL_ERROR_CODES] ab.
|
|
34
|
+
*/
|
|
35
|
+
/** Plattform des Geraets. */
|
|
36
|
+
exports.TERMINAL_PLATFORMS = Object.freeze(['android', 'ios']);
|
|
37
|
+
/**
|
|
38
|
+
* Einrichtungsstand der Terminal-App am Geraet: TID zugewiesen, wartet auf den
|
|
39
|
+
* Code, wird eingerichtet, bereit, fehlgeschlagen.
|
|
40
|
+
*/
|
|
41
|
+
exports.TERMINAL_SETUP_STATES = Object.freeze(['assigned', 'waiting_for_code', 'setting_up', 'ready', 'failed']);
|
|
42
|
+
/**
|
|
43
|
+
* Stand einer Code-Anfrage: keine Anfrage, sucht, gefunden, zugestellt,
|
|
44
|
+
* unklar (mehrere Geraete warteten gleichzeitig), kein Code gefunden,
|
|
45
|
+
* abgelaufen.
|
|
46
|
+
*/
|
|
47
|
+
exports.TERMINAL_CODE_STATUSES = Object.freeze(['none', 'searching', 'found', 'delivered', 'unclear', 'no_code', 'expired']);
|
|
48
|
+
/** Woher ein Code kam: aus dem Postfach oder vom Support eingetragen. */
|
|
49
|
+
exports.TERMINAL_CODE_SOURCES = Object.freeze(['mailbox', 'support']);
|
|
50
|
+
/**
|
|
51
|
+
* Fehlercodes der sieben Aufrufe (`code` des [KasseneckApiError]) wie im
|
|
52
|
+
* Vertrag des Backends (`errorCodes.terminal` in `fixtures/v3/v3-vokabular.json`),
|
|
53
|
+
* in dessen Reihenfolge; dazu kommen die gemeinsamen Codes von Anmeldung und
|
|
54
|
+
* Rand. Ein Code ausserhalb bleibt ueber `KasseneckApiError.code` lesbar.
|
|
55
|
+
*/
|
|
56
|
+
exports.TERMINAL_ERROR_CODES = Object.freeze([
|
|
57
|
+
'terminal_not_enabled', // dem Betrieb ist keine aktive TID zugeordnet
|
|
58
|
+
'terminal_test_environment', // nur in der Live-Umgebung (kein kr_test_-Schluessel)
|
|
59
|
+
'terminal_device_unknown', // deviceId oder deviceSecret falsch (gleiche Antwort fuer beides)
|
|
60
|
+
'terminal_device_blocked', // das Geraet ist gesperrt
|
|
61
|
+
'invalid_terminal_device', // Angaben zum Geraet unvollstaendig oder ungueltig
|
|
62
|
+
'too_many_terminal_devices', // Obergrenze der Geraete je Betrieb oder der Anmeldungen je Tag erreicht
|
|
63
|
+
'terminal_not_in_business', // die TID gibt es nicht oder sie gehoert einem anderen Betrieb (gleiche Antwort)
|
|
64
|
+
'terminal_code_manual', // Konto ohne Postfach: die App fragt nach dem Code
|
|
65
|
+
'terminal_code_rate_limited', // hoechstens 6 Code-Anfragen je Geraet und Stunde
|
|
66
|
+
'terminal_not_assigned', // dem Geraet ist keine TID zugeordnet: zuerst getTerminalAccess
|
|
67
|
+
'server_error',
|
|
68
|
+
]);
|
|
69
|
+
/** Laengen der Texte, die der Server annimmt (nach Abzug von Leerraum am Rand). */
|
|
70
|
+
exports.TERMINAL_LABEL_MAX = 60;
|
|
71
|
+
exports.TERMINAL_APP_MAX = 40;
|
|
72
|
+
exports.TERMINAL_REQUESTED_BY_MAX = 80;
|
|
73
|
+
// ---- Hilfen -------------------------------------------------------------------------------------
|
|
74
|
+
function eingabefehler(name, grund) {
|
|
75
|
+
return new errors_js_1.KasseneckValidationError(name, grund, 'request');
|
|
76
|
+
}
|
|
77
|
+
function antwortfehler(name, grund) {
|
|
78
|
+
return new errors_js_1.KasseneckValidationError(name, grund, 'response');
|
|
79
|
+
}
|
|
80
|
+
const istObjekt = (v) => typeof v === 'object' && v !== null && !Array.isArray(v);
|
|
81
|
+
const istText = (v) => typeof v === 'string' && v.trim() !== '';
|
|
82
|
+
const textOderNull = (v) => (typeof v === 'string' ? v : null);
|
|
83
|
+
/** Pflichttext mit Hoechstlaenge (nach Abzug von Leerraum am Rand, wie der Server). */
|
|
84
|
+
function pruefeText(name, feld, wert, max) {
|
|
85
|
+
if (typeof wert !== 'string' || wert.trim() === '')
|
|
86
|
+
throw eingabefehler(name, `${feld} fehlt oder ist leer`);
|
|
87
|
+
if (wert.trim().length > max)
|
|
88
|
+
throw eingabefehler(name, `${feld}: hoechstens ${max} Zeichen`);
|
|
89
|
+
return wert;
|
|
90
|
+
}
|
|
91
|
+
function pruefePlattform(name, wert) {
|
|
92
|
+
if (!exports.TERMINAL_PLATFORMS.includes(wert))
|
|
93
|
+
throw eingabefehler(name, 'platform muss android oder ios sein');
|
|
94
|
+
return wert;
|
|
95
|
+
}
|
|
96
|
+
/** Ausweis des Geraets pruefen; die Meldung nennt nie das Geheimnis. */
|
|
97
|
+
function ausweis(name, options) {
|
|
98
|
+
if (!istObjekt(options))
|
|
99
|
+
throw eingabefehler(name, 'Anfrage muss ein Objekt sein');
|
|
100
|
+
if (!istText(options.deviceId))
|
|
101
|
+
throw eingabefehler(name, 'deviceId fehlt oder ist leer');
|
|
102
|
+
if (!istText(options.deviceSecret))
|
|
103
|
+
throw eingabefehler(name, 'deviceSecret fehlt oder ist leer');
|
|
104
|
+
return { params: { deviceId: options.deviceId, deviceSecret: options.deviceSecret }, geheim: options.deviceSecret };
|
|
105
|
+
}
|
|
106
|
+
/** Optionale Felder nur, wenn gesetzt. */
|
|
107
|
+
function optional(name, params, options) {
|
|
108
|
+
if (options.platform !== undefined)
|
|
109
|
+
params['platform'] = pruefePlattform(name, options.platform);
|
|
110
|
+
if (options.app !== undefined)
|
|
111
|
+
params['app'] = pruefeText(name, 'app', options.app, exports.TERMINAL_APP_MAX);
|
|
112
|
+
if (options.label !== undefined)
|
|
113
|
+
params['label'] = pruefeText(name, 'label', options.label, exports.TERMINAL_LABEL_MAX);
|
|
114
|
+
if (options.requestedBy !== undefined)
|
|
115
|
+
params['requestedBy'] = pruefeText(name, 'requestedBy', options.requestedBy, exports.TERMINAL_REQUESTED_BY_MAX);
|
|
116
|
+
}
|
|
117
|
+
function setupAus(name, wert) {
|
|
118
|
+
if (!istObjekt(wert) || typeof wert['state'] !== 'string')
|
|
119
|
+
throw antwortfehler(name, 'Antwort ohne setup.state');
|
|
120
|
+
return { state: wert['state'], since: textOderNull(wert['since']) };
|
|
121
|
+
}
|
|
122
|
+
/** Zugang aus der Antwort; die Meldungen nennen nie Login, Passwort oder TID. */
|
|
123
|
+
function zugangAus(name, d) {
|
|
124
|
+
if (!istText(d['username']) || !istText(d['password']) || !istText(d['terminalId']) || typeof d['accountId'] !== 'string') {
|
|
125
|
+
throw antwortfehler(name, 'Zugang unvollstaendig (username, password, terminalId, accountId)');
|
|
126
|
+
}
|
|
127
|
+
if (typeof d['autoCode'] !== 'boolean')
|
|
128
|
+
throw antwortfehler(name, 'Antwort ohne autoCode');
|
|
129
|
+
const format = d['codeFormat'];
|
|
130
|
+
if (!istObjekt(format) || !(typeof format['length'] === 'number' && Number.isSafeInteger(format['length']) && format['length'] > 0) ||
|
|
131
|
+
!Array.isArray(format['labels']) || !format['labels'].every((l) => typeof l === 'string')) {
|
|
132
|
+
throw antwortfehler(name, 'Antwort ohne gueltiges codeFormat (length, labels)');
|
|
133
|
+
}
|
|
134
|
+
return {
|
|
135
|
+
available: true,
|
|
136
|
+
username: d['username'],
|
|
137
|
+
password: d['password'],
|
|
138
|
+
terminalId: d['terminalId'],
|
|
139
|
+
terminalName: textOderNull(d['terminalName']),
|
|
140
|
+
accountId: d['accountId'],
|
|
141
|
+
autoCode: d['autoCode'],
|
|
142
|
+
codeFormat: { length: format['length'], labels: [...format['labels']] },
|
|
143
|
+
setup: setupAus(name, d['setup']),
|
|
144
|
+
updatedAt: textOderNull(d['updatedAt']),
|
|
145
|
+
};
|
|
146
|
+
}
|
|
147
|
+
function listeAus(name, d) {
|
|
148
|
+
const roh = d['terminals'];
|
|
149
|
+
if (typeof d['reason'] !== 'string' || !Array.isArray(roh))
|
|
150
|
+
throw antwortfehler(name, 'Antwort ohne reason oder terminals');
|
|
151
|
+
const terminals = [];
|
|
152
|
+
for (const t of roh) {
|
|
153
|
+
if (!istObjekt(t) || !istText(t['terminalId']))
|
|
154
|
+
throw antwortfehler(name, 'Eintrag in terminals ohne terminalId');
|
|
155
|
+
terminals.push({
|
|
156
|
+
terminalId: t['terminalId'],
|
|
157
|
+
name: textOderNull(t['name']),
|
|
158
|
+
lastUsedBy: textOderNull(t['lastUsedBy']),
|
|
159
|
+
lastUsedAt: textOderNull(t['lastUsedAt']),
|
|
160
|
+
});
|
|
161
|
+
}
|
|
162
|
+
return { available: false, reason: d['reason'], terminals };
|
|
163
|
+
}
|
|
164
|
+
async function zugangRufen(transport, name, params, geheim) {
|
|
165
|
+
const daten = await transport(name, params, undefined, [geheim]);
|
|
166
|
+
if (!istObjekt(daten) || typeof daten['available'] !== 'boolean')
|
|
167
|
+
throw antwortfehler(name, 'Antwort ohne available');
|
|
168
|
+
return daten['available'] ? zugangAus(name, daten) : listeAus(name, daten);
|
|
169
|
+
}
|
|
170
|
+
// ---- Aufrufe ------------------------------------------------------------------------------------
|
|
171
|
+
/**
|
|
172
|
+
* Meldet ein Geraet einmal an (`registerTerminalDevice`) und liefert seinen
|
|
173
|
+
* Ausweis. `deviceSecret` steht nur in dieser Antwort: im sicheren Speicher
|
|
174
|
+
* ablegen, nie loggen. Hoechstens 20 Geraete je Betrieb und 10 Anmeldungen je
|
|
175
|
+
* Tag (`too_many_terminal_devices`). Eine Wiederholung nach unklarem Ausgang
|
|
176
|
+
* legt ein weiteres Geraet an.
|
|
177
|
+
*/
|
|
178
|
+
async function registerTerminalDevice(transport, options) {
|
|
179
|
+
const name = 'registerTerminalDevice';
|
|
180
|
+
if (!istObjekt(options))
|
|
181
|
+
throw eingabefehler(name, 'Anfrage muss ein Objekt sein');
|
|
182
|
+
const params = {
|
|
183
|
+
label: pruefeText(name, 'label', options.label, exports.TERMINAL_LABEL_MAX),
|
|
184
|
+
platform: pruefePlattform(name, options.platform),
|
|
185
|
+
app: pruefeText(name, 'app', options.app, exports.TERMINAL_APP_MAX),
|
|
186
|
+
};
|
|
187
|
+
optional(name, params, { requestedBy: options.requestedBy });
|
|
188
|
+
const daten = await transport(name, params);
|
|
189
|
+
if (!istObjekt(daten) || !istText(daten['deviceId']) || !istText(daten['deviceSecret'])) {
|
|
190
|
+
throw antwortfehler(name, 'Antwort ohne deviceId oder deviceSecret');
|
|
191
|
+
}
|
|
192
|
+
return { deviceId: daten['deviceId'], deviceSecret: daten['deviceSecret'] };
|
|
193
|
+
}
|
|
194
|
+
/**
|
|
195
|
+
* Zugang und TID fuer dieses Geraet (`getTerminalAccess`). Das Geraet behaelt
|
|
196
|
+
* seine TID; ohne eine bekommt es eine freie seines Betriebs. Ist keine frei,
|
|
197
|
+
* kommt `available: false` mit den TIDs des eigenen Betriebs zur Auswahl fuer
|
|
198
|
+
* [claimTerminal]. Die App ruft das bei jedem Start und mindestens einmal am
|
|
199
|
+
* Tag. `password` nie loggen.
|
|
200
|
+
*/
|
|
201
|
+
async function getTerminalAccess(transport, options) {
|
|
202
|
+
const name = 'getTerminalAccess';
|
|
203
|
+
const { params, geheim } = ausweis(name, options);
|
|
204
|
+
optional(name, params, { platform: options.platform, app: options.app, label: options.label });
|
|
205
|
+
return zugangRufen(transport, name, params, geheim);
|
|
206
|
+
}
|
|
207
|
+
/**
|
|
208
|
+
* Uebernimmt eine TID des eigenen Betriebs (`claimTerminal`); das Geraet, das
|
|
209
|
+
* sie bisher nutzte, verliert sie. Antwort wie [getTerminalAccess] mit
|
|
210
|
+
* Zugang. Eine fremde oder unbekannte TID ist `terminal_not_in_business`.
|
|
211
|
+
*/
|
|
212
|
+
async function claimTerminal(transport, options) {
|
|
213
|
+
const name = 'claimTerminal';
|
|
214
|
+
const { params, geheim } = ausweis(name, options);
|
|
215
|
+
if (!istText(options.terminalId))
|
|
216
|
+
throw eingabefehler(name, 'terminalId fehlt oder ist leer');
|
|
217
|
+
params['terminalId'] = options.terminalId;
|
|
218
|
+
optional(name, params, { label: options.label });
|
|
219
|
+
const ergebnis = await zugangRufen(transport, name, params, geheim);
|
|
220
|
+
if (!ergebnis.available)
|
|
221
|
+
throw antwortfehler(name, 'Antwort ohne Zugang');
|
|
222
|
+
return ergebnis;
|
|
223
|
+
}
|
|
224
|
+
/**
|
|
225
|
+
* Fragt den Code fuer die TID dieses Geraets an (`requestTerminalCode`); nur
|
|
226
|
+
* bei Konten mit Postfach (`TerminalAccess.autoCode`), sonst
|
|
227
|
+
* `terminal_code_manual`. Eine offene Anfrage juenger als 6 Minuten bleibt
|
|
228
|
+
* (doppeltes Tippen schadet nicht); hoechstens 6 Anfragen je Stunde
|
|
229
|
+
* (`terminal_code_rate_limited`). Den Code holt danach [getTerminalCode].
|
|
230
|
+
*/
|
|
231
|
+
async function requestTerminalCode(transport, options) {
|
|
232
|
+
const name = 'requestTerminalCode';
|
|
233
|
+
const { params, geheim } = ausweis(name, options);
|
|
234
|
+
params['platform'] = pruefePlattform(name, options.platform);
|
|
235
|
+
optional(name, params, { requestedBy: options.requestedBy });
|
|
236
|
+
const daten = await transport(name, params, undefined, [geheim]);
|
|
237
|
+
if (!istObjekt(daten) || typeof daten['status'] !== 'string')
|
|
238
|
+
throw antwortfehler(name, 'Antwort ohne status');
|
|
239
|
+
return { status: daten['status'] };
|
|
240
|
+
}
|
|
241
|
+
/**
|
|
242
|
+
* Stand der Code-Anfrage und der Einrichtung (`getTerminalCode`); ohne Anfrage
|
|
243
|
+
* `status: 'none'`. Bei `found` steht der Code genau in dieser Antwort: auf
|
|
244
|
+
* Android wird er dabei verbraucht (eine verlorene Antwort verliert ihn), auf
|
|
245
|
+
* iOS bleibt er bis `validUntil` lesbar. Den Code nie loggen.
|
|
246
|
+
*/
|
|
247
|
+
async function getTerminalCode(transport, options) {
|
|
248
|
+
const name = 'getTerminalCode';
|
|
249
|
+
const { params, geheim } = ausweis(name, options);
|
|
250
|
+
const daten = await transport(name, params, undefined, [geheim]);
|
|
251
|
+
if (!istObjekt(daten) || typeof daten['status'] !== 'string')
|
|
252
|
+
throw antwortfehler(name, 'Antwort ohne status');
|
|
253
|
+
const ergebnis = { status: daten['status'], setup: setupAus(name, daten['setup']) };
|
|
254
|
+
if (daten['code'] !== undefined && daten['code'] !== null) {
|
|
255
|
+
if (!istText(daten['code']))
|
|
256
|
+
throw antwortfehler(name, 'code ist kein Text');
|
|
257
|
+
ergebnis.code = daten['code'];
|
|
258
|
+
if (typeof daten['source'] === 'string')
|
|
259
|
+
ergebnis.source = daten['source'];
|
|
260
|
+
ergebnis.validUntil = textOderNull(daten['validUntil']);
|
|
261
|
+
}
|
|
262
|
+
return ergebnis;
|
|
263
|
+
}
|
|
264
|
+
/**
|
|
265
|
+
* Meldet den Ausgang der Anmeldung in der Terminal-App (`reportTerminalLogin`).
|
|
266
|
+
* Antwort: nichts. Eine andere als die zugewiesene TID schreibt der Server
|
|
267
|
+
* nicht.
|
|
268
|
+
*/
|
|
269
|
+
async function reportTerminalLogin(transport, options) {
|
|
270
|
+
const name = 'reportTerminalLogin';
|
|
271
|
+
const { params, geheim } = ausweis(name, options);
|
|
272
|
+
if (!istText(options.terminalId))
|
|
273
|
+
throw eingabefehler(name, 'terminalId fehlt oder ist leer');
|
|
274
|
+
if (typeof options.success !== 'boolean')
|
|
275
|
+
throw eingabefehler(name, 'success muss true oder false sein');
|
|
276
|
+
if (typeof options.newOnDevice !== 'boolean')
|
|
277
|
+
throw eingabefehler(name, 'newOnDevice muss true oder false sein');
|
|
278
|
+
params['terminalId'] = options.terminalId;
|
|
279
|
+
params['success'] = options.success;
|
|
280
|
+
params['newOnDevice'] = options.newOnDevice;
|
|
281
|
+
await transport(name, params, undefined, [geheim]);
|
|
282
|
+
}
|
|
283
|
+
/** Meldet, dass die Terminal-App fertig eingerichtet ist (`reportTerminalReady`). Antwort: nichts. */
|
|
284
|
+
async function reportTerminalReady(transport, options) {
|
|
285
|
+
const name = 'reportTerminalReady';
|
|
286
|
+
const { params, geheim } = ausweis(name, options);
|
|
287
|
+
await transport(name, params, undefined, [geheim]);
|
|
288
|
+
}
|
package/dist/cjs/index.d.ts
CHANGED
|
@@ -1,6 +1,6 @@
|
|
|
1
1
|
export { ReceiptType, type ReceiptTypeKey, VatRate, type VatRateKey, KeckPaymentMethod, type KeckPaymentMethodKey, CreditCardProvider, type CreditCardProviderKey, VoucherType, type VoucherTypeKey, VoucherAction, type VoucherActionKey, StripeLinkMode, type StripeLinkModeKey, } from './enums/index.js';
|
|
2
2
|
export { type ReceiptItem, type ReceiptItemPayload, type ReceiptItemPayloadRead, toReceiptItemPayload, fromReceiptItemPayload, receiptItemTotalCents, receiptItemIsValid, negateReceiptItem, type TipRecipient, isTipItem, isVoucherItem, isVoucherFloatItem, type Voucher, type VoucherArticle, type IssuedVoucher, type ReturnIssuedVoucher, type VoucherPayload, toVoucherPayload, fromVoucherPayload, voucherIsValid, type Receipt, type RegistrationInfo, type ReceiptPayload, type ReceiptPayloadRead, toReceiptPayload, fromReceiptPayload, receiptSubSumCents, receiptSumCents, receiptValueVoucherSign, type CancellationOf, type CancellationItem, type Cancellation, type CancellationReason, type CancellationErrorCode, type CancellationStatus, type ReturnDisposition, RETURN_DISPOSITIONS, CANCELLATION_REASONS, CANCELLATION_STATUSES, CANCELLATION_ERROR_CODES, CANCELLATION_RESERVATION_MS, isCancellationReason, isReturnDisposition, isCancellationErrorCode, cancellationErrorCode, isCancellationError, cancellationFieldErrors, type CancellationFieldError, type ReceiptPayment, type ReceiptPaymentPayload, type ReceiptPaymentInput, fromReceiptPaymentPayload, toReceiptPaymentPayload, type PaymentErrorCode, PAYMENT_ERROR_CODES, isPaymentErrorCode, paymentErrorCode, isPaymentError, paymentFieldErrors, type PaymentFieldError, type ReceiptEmailErrorCode, type ReceiptEmailVia, RECEIPT_EMAIL_ERROR_CODES, RECEIPT_EMAIL_SEND_ERROR_CODES, type ReceiptEmailSendErrorCode, RECEIPT_EMAIL_VIAS, isReceiptEmailErrorCode, receiptEmailErrorCode, isReceiptEmailError, receiptEmailFieldErrors, type ReceiptEmailFieldError, RECEIPT_OUTPUT_KINDS, type ReceiptOutputKind, RECEIPT_OUTPUT_LOG_KINDS, type ReceiptOutputLogKind, RECEIPT_OUTPUT_RESULTS, type ReceiptOutputResult, RECEIPT_OUTPUT_ENTRIES_MAX, type ReceiptOutput, type ReceiptOutputActor, RECEIPT_OUTPUT_ENTRY_ERROR_CODES, type ReceiptOutputEntryErrorCode, RECEIPT_OUTPUT_ERROR_CODES, type ReceiptOutputErrorCode, isReceiptOutputErrorCode, receiptOutputErrorCode, isReceiptOutputError, receiptOutputFieldErrors, type ReceiptOutputFieldError, type ReceiptErrorCode, type ReceiptFieldError, RECEIPT_ERROR_CODES, isReceiptErrorCode, receiptErrorCode, isReceiptError, receiptFieldErrors, remainingQuantities, TIP_REFUND_SOURCES, type TipRefundSource, isTipRefundSource, openStaffTipCents, cancellationItemsForTip, cancellationCashRefundCents, asksTipRefundSource, asksRefundTip, type ReceiptCompany, type ReceiptCompanyPayload, fromReceiptCompanyPayload, receiptCompanyTaxInfo, type Cashregister, type CashregisterOnboarding, type CashregisterPayload, type CashregisterOnboardingPayload, type CashregisterAutoLogout, type CashregisterAutoLogoutPayload, fromCashregisterPayload, type ReceiptSummary, type ReceiptSummaryPayload, fromReceiptSummaryPayload, type ZeroKind, ZERO_KINDS, isZeroKind, type ReportMonth, reportMonthFromDate, previousReportMonth, nextReportMonth, reportMonthKey, reportMonthReadable, type StripeUrlSession, type StripeUrlSessionPayload, toStripeUrlSessionPayload, fromStripeUrlSessionPayload, type HobexReceipt, type HobexReceiptPayload, toHobexReceiptPayload, fromHobexReceiptPayload, hobexReceiptToCardPaymentData, hobexReceiptNeedsSignature, } from './models/index.js';
|
|
3
|
-
export { type AuthCredentials, type KasseneckAuth, type ApiKeyAuthOptions, type RegisterUserAuthOptions, apiKeyAuth, registerUserAuth, DEFAULT_BASE_URL, POS_BASE_URL, DEFAULT_TIMEOUT_MS, type HttpResponseLike, type HttpRequestInit, type FetchLike, type TransportOptions, type TransportBodyFields, type TransportCallOptions, type KasseneckTransport, type KasseneckBinaryTransport, type KasseneckPdfOrDataTransport, type PdfOrData, ALL_CALLS, type ApiCall, PUBLIC_CALLS, POS_CALLS, UNKNOWN_OUTCOME_CALLS, type PublicCall, type PosCall, createTransport, createBinaryTransport, createPdfOrDataTransport, createFileOrDataTransport, type FileOrData, type FileOrDataCallOptions, type KasseneckFileOrDataTransport, KasseneckApiError, KasseneckAuthError, KasseneckHttpError, KasseneckNetworkError, KasseneckValidationError, type ValidationScope, type KasseneckError, type HttpFailureReason, type CauseDigest, type ErrorOutcome, CLIENT_ERROR_CODES, type ClientErrorCode, isKasseneckApiError, isKasseneckAuthError, isKasseneckHttpError, isKasseneckNetworkError, isKasseneckValidationError, isOutcomeUnknown, type ReceiptCommonOptions, type SellReceiptOptions, type TipOptions, type TipRecipientShare, type CancelReceiptOptions, type CancelReceiptResult, type ReceiptWithCompany, sellReceipt, sellReceiptWithCompany, paymentsExpectedCents, cardRefundReference, receiptLayoutFromResult, cancelReceipt, zeroReceipt, getReceipt, getReceiptWithCompany, generateFullReceiptId, getFirstReceiptDate, listMyReceipts, type ListMyReceiptsOptions, type ReceiptList, type ReceiptListStats, listMyCashregisters, checkVoucherCombinationError, type SendReceiptEmailOptions, type SendReceiptEmailResult, sendReceiptEmail, type ReceiptOutputEntry, type LogReceiptOutputsOptions, type LogReceiptOutputsResult, type RejectedReceiptOutput, logReceiptOutputs, downloadDailyReport, downloadMonthlyReport, getCashregisterReport, type CashregisterReportPeriod, getReportV2, type ReportV2, type ReportV2Metadata, type ReportV2Options, 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, 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, type ListedFullReceipt, type ListReceiptsHeader, type CashboxStatus, type SignatureStatus, getCashboxStatus, getSignatureStatus, type KasseneckApi, createKasseneckApi, } from './client/index.js';
|
|
3
|
+
export { type AuthCredentials, type KasseneckAuth, type ApiKeyAuthOptions, type RegisterUserAuthOptions, apiKeyAuth, registerUserAuth, DEFAULT_BASE_URL, POS_BASE_URL, DEFAULT_TIMEOUT_MS, type HttpResponseLike, type HttpRequestInit, type FetchLike, type TransportOptions, type TransportBodyFields, type TransportCallOptions, type KasseneckTransport, type KasseneckBinaryTransport, type KasseneckPdfOrDataTransport, type PdfOrData, ALL_CALLS, type ApiCall, PUBLIC_CALLS, POS_CALLS, UNKNOWN_OUTCOME_CALLS, type PublicCall, type PosCall, createTransport, createBinaryTransport, createPdfOrDataTransport, createFileOrDataTransport, type FileOrData, type FileOrDataCallOptions, type KasseneckFileOrDataTransport, KasseneckApiError, KasseneckAuthError, KasseneckHttpError, KasseneckNetworkError, KasseneckValidationError, type ValidationScope, type KasseneckError, type HttpFailureReason, type CauseDigest, type ErrorOutcome, CLIENT_ERROR_CODES, type ClientErrorCode, isKasseneckApiError, isKasseneckAuthError, isKasseneckHttpError, isKasseneckNetworkError, isKasseneckValidationError, isOutcomeUnknown, type ReceiptCommonOptions, type SellReceiptOptions, type TipOptions, type TipRecipientShare, type CancelReceiptOptions, type CancelReceiptResult, type ReceiptWithCompany, sellReceipt, sellReceiptWithCompany, paymentsExpectedCents, cardRefundReference, receiptLayoutFromResult, cancelReceipt, zeroReceipt, getReceipt, getReceiptWithCompany, generateFullReceiptId, getFirstReceiptDate, listMyReceipts, type ListMyReceiptsOptions, type ReceiptList, type ReceiptListStats, listMyCashregisters, checkVoucherCombinationError, type SendReceiptEmailOptions, type SendReceiptEmailResult, sendReceiptEmail, type ReceiptOutputEntry, type LogReceiptOutputsOptions, type LogReceiptOutputsResult, type RejectedReceiptOutput, logReceiptOutputs, downloadDailyReport, downloadMonthlyReport, getCashregisterReport, type CashregisterReportPeriod, getReportV2, type ReportV2, type ReportV2Metadata, type ReportV2Options, 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, 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, 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, type ListedFullReceipt, type ListReceiptsHeader, type CashboxStatus, type SignatureStatus, getCashboxStatus, getSignatureStatus, type KasseneckApi, createKasseneckApi, } from './client/index.js';
|
|
4
4
|
export { type ReceiptDueTip, type ReceiptDueTipRecipient, type ReceiptDueOptions, type ReceiptDueBuckets, type ReceiptDueBreakdown, type ReceiptDueErrorReason, receiptDueCents, receiptDueBreakdown, ReceiptDueError, RECEIPT_DUE_ERROR_REASONS, isReceiptDueError, type VoucherDueInfo, type VoucherDueArticle, type VoucherDueType, type VoucherRedeemContext, voucherRedeemMaxCents, VOUCHER_ZERO_RATE_BUCKET_FROM, } from './receipt/due.js';
|
|
5
5
|
export { parseServerTimeStamp, toViennaWallClock, type ViennaWallClock } from './vienna-time.js';
|
|
6
6
|
export { type PosBusinessSettings, type PosDeviceSettings, type PosSettings, type ArticleGroup, type PosArticle, POS_BUSINESS_DEFAULTS, POS_DEVICE_DEFAULTS, mergePosSettings, fromArticleGroupPayload, fromPosArticlePayload, listMyArticleGroups, listMyArticles, getPosSettings, setMyPosSettings, setMyRegisterDeviceSettings, distributeDiscount, cancelScopeOf, receiptsScopeOf, stockViewOf, voucherPermsOf, } from './pos/index.js';
|
package/dist/cjs/index.js
CHANGED
|
@@ -3,7 +3,8 @@ Object.defineProperty(exports, "__esModule", { value: true });
|
|
|
3
3
|
exports.RECEIPT_OUTPUT_LOG_KINDS = exports.RECEIPT_OUTPUT_KINDS = exports.receiptEmailFieldErrors = exports.isReceiptEmailError = exports.receiptEmailErrorCode = exports.isReceiptEmailErrorCode = exports.RECEIPT_EMAIL_VIAS = exports.RECEIPT_EMAIL_SEND_ERROR_CODES = exports.RECEIPT_EMAIL_ERROR_CODES = exports.paymentFieldErrors = exports.isPaymentError = exports.paymentErrorCode = exports.isPaymentErrorCode = exports.PAYMENT_ERROR_CODES = exports.toReceiptPaymentPayload = exports.fromReceiptPaymentPayload = exports.cancellationFieldErrors = exports.isCancellationError = exports.cancellationErrorCode = exports.isCancellationErrorCode = exports.isReturnDisposition = exports.isCancellationReason = exports.CANCELLATION_RESERVATION_MS = exports.CANCELLATION_ERROR_CODES = exports.CANCELLATION_STATUSES = exports.CANCELLATION_REASONS = exports.RETURN_DISPOSITIONS = exports.receiptValueVoucherSign = exports.receiptSumCents = exports.receiptSubSumCents = exports.fromReceiptPayload = exports.toReceiptPayload = exports.voucherIsValid = exports.fromVoucherPayload = exports.toVoucherPayload = exports.isVoucherFloatItem = exports.isVoucherItem = exports.isTipItem = exports.negateReceiptItem = exports.receiptItemIsValid = exports.receiptItemTotalCents = exports.fromReceiptItemPayload = exports.toReceiptItemPayload = exports.StripeLinkMode = exports.VoucherAction = exports.VoucherType = exports.CreditCardProvider = exports.KeckPaymentMethod = exports.VatRate = exports.ReceiptType = void 0;
|
|
4
4
|
exports.createPdfOrDataTransport = exports.createBinaryTransport = exports.createTransport = exports.UNKNOWN_OUTCOME_CALLS = exports.POS_CALLS = exports.PUBLIC_CALLS = exports.ALL_CALLS = exports.DEFAULT_TIMEOUT_MS = exports.POS_BASE_URL = exports.DEFAULT_BASE_URL = exports.registerUserAuth = exports.apiKeyAuth = exports.hobexReceiptNeedsSignature = exports.hobexReceiptToCardPaymentData = exports.fromHobexReceiptPayload = exports.toHobexReceiptPayload = exports.fromStripeUrlSessionPayload = exports.toStripeUrlSessionPayload = exports.reportMonthReadable = exports.reportMonthKey = exports.nextReportMonth = exports.previousReportMonth = exports.reportMonthFromDate = exports.isZeroKind = exports.ZERO_KINDS = exports.fromReceiptSummaryPayload = exports.fromCashregisterPayload = exports.receiptCompanyTaxInfo = exports.fromReceiptCompanyPayload = exports.asksRefundTip = exports.asksTipRefundSource = exports.cancellationCashRefundCents = exports.cancellationItemsForTip = exports.openStaffTipCents = exports.isTipRefundSource = exports.TIP_REFUND_SOURCES = exports.remainingQuantities = exports.receiptFieldErrors = exports.isReceiptError = exports.receiptErrorCode = exports.isReceiptErrorCode = exports.RECEIPT_ERROR_CODES = exports.receiptOutputFieldErrors = exports.isReceiptOutputError = exports.receiptOutputErrorCode = exports.isReceiptOutputErrorCode = exports.RECEIPT_OUTPUT_ERROR_CODES = exports.RECEIPT_OUTPUT_ENTRY_ERROR_CODES = exports.RECEIPT_OUTPUT_ENTRIES_MAX = exports.RECEIPT_OUTPUT_RESULTS = void 0;
|
|
5
5
|
exports.DepExportTimeoutError = exports.revokeDepHandoverLink = exports.createDepHandoverLink = exports.getDepExportFile = exports.waitForDepExport = exports.getDepExport = exports.createDepExport = exports.LIST_RECEIPTS_ERROR_CODES = exports.LIST_ALL_RECEIPTS_MAX_PAGES = exports.LIST_RECEIPTS_DAYS_MAX = exports.LIST_RECEIPTS_LIMIT_MAX = exports.LIST_RECEIPTS_ORDERS = exports.LIST_RECEIPTS_VIEWS = exports.listedReceiptWithCompany = exports.fromListReceiptsSummaryPayload = exports.listAllReceipts = exports.listReceipts = exports.getReportV2 = exports.getCashregisterReport = exports.downloadMonthlyReport = exports.downloadDailyReport = exports.logReceiptOutputs = exports.sendReceiptEmail = exports.checkVoucherCombinationError = exports.listMyCashregisters = exports.listMyReceipts = exports.getFirstReceiptDate = exports.generateFullReceiptId = exports.getReceiptWithCompany = exports.getReceipt = exports.zeroReceipt = exports.cancelReceipt = exports.receiptLayoutFromResult = exports.cardRefundReference = exports.paymentsExpectedCents = exports.sellReceiptWithCompany = exports.sellReceipt = exports.isOutcomeUnknown = exports.isKasseneckValidationError = exports.isKasseneckNetworkError = exports.isKasseneckHttpError = exports.isKasseneckAuthError = exports.isKasseneckApiError = exports.CLIENT_ERROR_CODES = exports.KasseneckValidationError = exports.KasseneckNetworkError = exports.KasseneckHttpError = exports.KasseneckAuthError = exports.KasseneckApiError = exports.createFileOrDataTransport = void 0;
|
|
6
|
-
exports.
|
|
6
|
+
exports.receiptsScopeOf = exports.cancelScopeOf = exports.distributeDiscount = exports.setMyRegisterDeviceSettings = exports.setMyPosSettings = exports.getPosSettings = exports.listMyArticles = exports.listMyArticleGroups = exports.fromPosArticlePayload = exports.fromArticleGroupPayload = exports.mergePosSettings = exports.POS_DEVICE_DEFAULTS = exports.POS_BUSINESS_DEFAULTS = exports.toViennaWallClock = exports.parseServerTimeStamp = exports.VOUCHER_ZERO_RATE_BUCKET_FROM = exports.voucherRedeemMaxCents = exports.isReceiptDueError = exports.RECEIPT_DUE_ERROR_REASONS = exports.ReceiptDueError = exports.receiptDueBreakdown = exports.receiptDueCents = exports.createKasseneckApi = exports.getSignatureStatus = exports.getCashboxStatus = exports.TERMINAL_REQUESTED_BY_MAX = exports.TERMINAL_APP_MAX = exports.TERMINAL_LABEL_MAX = exports.TERMINAL_ERROR_CODES = exports.TERMINAL_CODE_SOURCES = exports.TERMINAL_CODE_STATUSES = exports.TERMINAL_SETUP_STATES = exports.TERMINAL_PLATFORMS = exports.reportTerminalReady = exports.reportTerminalLogin = exports.getTerminalCode = exports.requestTerminalCode = exports.claimTerminal = exports.getTerminalAccess = exports.registerTerminalDevice = exports.DEP_EXPORT_DOWNLOAD_TIMEOUT_MS = exports.DEP_EXPORT_WAIT_TIMEOUT_MS = exports.DEP_EXPORT_POLL_MAX_MS = exports.DEP_EXPORT_POLL_FACTOR = exports.DEP_EXPORT_POLL_START_MS = exports.DEP_EXPORT_FAILURES = exports.DEP_EXPORT_ERROR_CODES = exports.DEP_EXPORT_FILES = exports.DEP_EXPORT_STATUSES = exports.DepExportChecksumError = void 0;
|
|
7
|
+
exports.voucherPermsOf = exports.stockViewOf = void 0;
|
|
7
8
|
var index_js_1 = require("./enums/index.js");
|
|
8
9
|
Object.defineProperty(exports, "ReceiptType", { enumerable: true, get: function () { return index_js_1.ReceiptType; } });
|
|
9
10
|
Object.defineProperty(exports, "VatRate", { enumerable: true, get: function () { return index_js_1.VatRate; } });
|
|
@@ -167,6 +168,21 @@ Object.defineProperty(exports, "DEP_EXPORT_POLL_FACTOR", { enumerable: true, get
|
|
|
167
168
|
Object.defineProperty(exports, "DEP_EXPORT_POLL_MAX_MS", { enumerable: true, get: function () { return index_js_3.DEP_EXPORT_POLL_MAX_MS; } });
|
|
168
169
|
Object.defineProperty(exports, "DEP_EXPORT_WAIT_TIMEOUT_MS", { enumerable: true, get: function () { return index_js_3.DEP_EXPORT_WAIT_TIMEOUT_MS; } });
|
|
169
170
|
Object.defineProperty(exports, "DEP_EXPORT_DOWNLOAD_TIMEOUT_MS", { enumerable: true, get: function () { return index_js_3.DEP_EXPORT_DOWNLOAD_TIMEOUT_MS; } });
|
|
171
|
+
Object.defineProperty(exports, "registerTerminalDevice", { enumerable: true, get: function () { return index_js_3.registerTerminalDevice; } });
|
|
172
|
+
Object.defineProperty(exports, "getTerminalAccess", { enumerable: true, get: function () { return index_js_3.getTerminalAccess; } });
|
|
173
|
+
Object.defineProperty(exports, "claimTerminal", { enumerable: true, get: function () { return index_js_3.claimTerminal; } });
|
|
174
|
+
Object.defineProperty(exports, "requestTerminalCode", { enumerable: true, get: function () { return index_js_3.requestTerminalCode; } });
|
|
175
|
+
Object.defineProperty(exports, "getTerminalCode", { enumerable: true, get: function () { return index_js_3.getTerminalCode; } });
|
|
176
|
+
Object.defineProperty(exports, "reportTerminalLogin", { enumerable: true, get: function () { return index_js_3.reportTerminalLogin; } });
|
|
177
|
+
Object.defineProperty(exports, "reportTerminalReady", { enumerable: true, get: function () { return index_js_3.reportTerminalReady; } });
|
|
178
|
+
Object.defineProperty(exports, "TERMINAL_PLATFORMS", { enumerable: true, get: function () { return index_js_3.TERMINAL_PLATFORMS; } });
|
|
179
|
+
Object.defineProperty(exports, "TERMINAL_SETUP_STATES", { enumerable: true, get: function () { return index_js_3.TERMINAL_SETUP_STATES; } });
|
|
180
|
+
Object.defineProperty(exports, "TERMINAL_CODE_STATUSES", { enumerable: true, get: function () { return index_js_3.TERMINAL_CODE_STATUSES; } });
|
|
181
|
+
Object.defineProperty(exports, "TERMINAL_CODE_SOURCES", { enumerable: true, get: function () { return index_js_3.TERMINAL_CODE_SOURCES; } });
|
|
182
|
+
Object.defineProperty(exports, "TERMINAL_ERROR_CODES", { enumerable: true, get: function () { return index_js_3.TERMINAL_ERROR_CODES; } });
|
|
183
|
+
Object.defineProperty(exports, "TERMINAL_LABEL_MAX", { enumerable: true, get: function () { return index_js_3.TERMINAL_LABEL_MAX; } });
|
|
184
|
+
Object.defineProperty(exports, "TERMINAL_APP_MAX", { enumerable: true, get: function () { return index_js_3.TERMINAL_APP_MAX; } });
|
|
185
|
+
Object.defineProperty(exports, "TERMINAL_REQUESTED_BY_MAX", { enumerable: true, get: function () { return index_js_3.TERMINAL_REQUESTED_BY_MAX; } });
|
|
170
186
|
Object.defineProperty(exports, "getCashboxStatus", { enumerable: true, get: function () { return index_js_3.getCashboxStatus; } });
|
|
171
187
|
Object.defineProperty(exports, "getSignatureStatus", { enumerable: true, get: function () { return index_js_3.getSignatureStatus; } });
|
|
172
188
|
Object.defineProperty(exports, "createKasseneckApi", { enumerable: true, get: function () { return index_js_3.createKasseneckApi; } });
|
|
@@ -1,5 +1,5 @@
|
|
|
1
1
|
/** Fingerabdruck des Vertrags-Exports, aus dem diese Datei stammt (`_quelle.sha256`). */
|
|
2
|
-
export declare const VOKABULAR_QUELLE = "
|
|
2
|
+
export declare const VOKABULAR_QUELLE = "c137b0f64dd1a06c8cddd9d9164bd2360ecbc3133cc04ca2b82d0e37f9d4fe5d";
|
|
3
3
|
/** Schema-Notation des Vertrags: Blatt 'aussen': 'innen', Objekt { __: 'innen', ... }, Liste [ { __: 'innen', ... } ]. */
|
|
4
4
|
export type SchemaEintrag = string | SchemaObjekt | readonly [SchemaObjekt];
|
|
5
5
|
export interface SchemaObjekt {
|
|
@@ -4,7 +4,7 @@
|
|
|
4
4
|
Object.defineProperty(exports, "__esModule", { value: true });
|
|
5
5
|
exports.KATALOGE = exports.ARTIKEL_FELDER = exports.SCHEMAS = exports.VOKABULAR_QUELLE = void 0;
|
|
6
6
|
/** Fingerabdruck des Vertrags-Exports, aus dem diese Datei stammt (`_quelle.sha256`). */
|
|
7
|
-
exports.VOKABULAR_QUELLE = "
|
|
7
|
+
exports.VOKABULAR_QUELLE = "c137b0f64dd1a06c8cddd9d9164bd2360ecbc3133cc04ca2b82d0e37f9d4fe5d";
|
|
8
8
|
/** Schema je Endpunkt (aussen -> innen) und Wertverweise auf die Kataloge. */
|
|
9
9
|
exports.SCHEMAS = {
|
|
10
10
|
"getReceipt": {
|
package/dist/cjs/version.d.ts
CHANGED
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", "recordMyShiftCount", "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
|
|
@@ -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", "recordMyShiftCount", "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
|
/**
|
|
@@ -151,6 +151,14 @@ export const ALL_CALLS = [
|
|
|
151
151
|
'getRegisterInspectionInfo',
|
|
152
152
|
// Connect-Bestand (./pos): welche Connect-Version an welchem Kassengeraet laeuft; nur ueber den Kassenweg.
|
|
153
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',
|
|
154
162
|
];
|
|
155
163
|
/**
|
|
156
164
|
* Die oeffentlichen Endpunkte unter `/v3` (`https://api.kasseneck.at/v3/<name>`),
|
|
@@ -281,6 +289,14 @@ export const PUBLIC_CALLS = [
|
|
|
281
289
|
'getDepExportFile',
|
|
282
290
|
'createDepHandoverLink',
|
|
283
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',
|
|
284
300
|
];
|
|
285
301
|
/**
|
|
286
302
|
* Die Endpunkte des Kassenwegs (`https://kasse.kasseneck.at/api/v3/<name>`,
|
|
@@ -394,6 +410,8 @@ export const UNKNOWN_OUTCOME_CALLS = [
|
|
|
394
410
|
'deleteWebhook',
|
|
395
411
|
'extendReservation',
|
|
396
412
|
'financeWebService',
|
|
413
|
+
// Auf Android verbraucht die Antwort den Code: nach einem Zeitlimit kann er zugestellt und weg sein.
|
|
414
|
+
'getTerminalCode',
|
|
397
415
|
'hobexPayApi',
|
|
398
416
|
'hobexRefundApi',
|
|
399
417
|
'issueInvoice',
|
|
@@ -410,6 +428,7 @@ export const UNKNOWN_OUTCOME_CALLS = [
|
|
|
410
428
|
'recordStockLoss',
|
|
411
429
|
'recordStocktakeCount',
|
|
412
430
|
'recountStocktake',
|
|
431
|
+
'registerTerminalDevice',
|
|
413
432
|
'releaseReservation',
|
|
414
433
|
'reportConnectState',
|
|
415
434
|
'reportCustomerContract',
|
|
@@ -468,6 +487,8 @@ export const UNKNOWN_OUTCOME_CALLS = [
|
|
|
468
487
|
export const CALLS_WITHOUT_EFFECT = Object.freeze({
|
|
469
488
|
checkPartnerCustomerEmail: 'read',
|
|
470
489
|
checkVoucher: 'read',
|
|
490
|
+
// Kartenterminal: dieselbe TID noch einmal uebernehmen aendert nichts am Server.
|
|
491
|
+
claimTerminal: 'repeatable',
|
|
471
492
|
downloadDailyReport: 'read',
|
|
472
493
|
downloadReceipt: 'read',
|
|
473
494
|
downloadReport: 'read',
|
|
@@ -510,6 +531,8 @@ export const CALLS_WITHOUT_EFFECT = Object.freeze({
|
|
|
510
531
|
getStocktake: 'read',
|
|
511
532
|
getSignatureCardOrder: 'read',
|
|
512
533
|
getStocktakePdf: 'read',
|
|
534
|
+
// Behaelt die TID des Geraets bzw. vergibt eine freie; eine Wiederholung liefert dieselbe Zuordnung und bucht nichts.
|
|
535
|
+
getTerminalAccess: 'repeatable',
|
|
513
536
|
getVariantGroup: 'read',
|
|
514
537
|
hobexGetStatus: 'read',
|
|
515
538
|
listArticles: 'read',
|
|
@@ -548,7 +571,12 @@ export const CALLS_WITHOUT_EFFECT = Object.freeze({
|
|
|
548
571
|
registerPinLogin: 'repeatable',
|
|
549
572
|
registerUserLogin: 'repeatable',
|
|
550
573
|
renewRegisterSession: 'repeatable',
|
|
574
|
+
// Kartenterminal: Anmeldung und Einrichtung melden schreiben denselben Stand noch einmal.
|
|
575
|
+
reportTerminalLogin: 'repeatable',
|
|
576
|
+
reportTerminalReady: 'repeatable',
|
|
551
577
|
reprintVoucherLabel: 'repeatable',
|
|
578
|
+
// Eine offene Code-Anfrage juenger als 6 Minuten bleibt; eine Wiederholung legt keine neue an.
|
|
579
|
+
requestTerminalCode: 'repeatable',
|
|
552
580
|
searchCustomers: 'read',
|
|
553
581
|
});
|
|
554
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';
|