@kreiseck/kasseneck-api 0.31.0 → 1.0.0-rc.2

package/dist/esm/partner/api.d.ts

@@ -5,16 +5,13 @@
  * Funktionen und bleiben einzeln importierbar.
  */
 import { type FetchLike } from '../client/transport.js';
-import { type CreateWebhookOptions, type CreateWebhookResult, type DeleteWebhookResult, type PartnerWebhook, type WebhookListe, type PartnerWebhookEventType, type WebhookPatch, type WebhookTestResult, type WebhookZustellung } from './webhooks.js';
-import type { ActivateCashregisterResult, CreateCashregisterOptions, CreateCashregisterResult, CreateCustomerOptions, CreateCustomerResult, CustomerCredentials, FonLinkResult, KassenListe, Kunde, KundenListe, ListCustomersOptions, PartnerInfo, RequestSignatureOptions, RequestSignatureResult, SignaturStand } from './typen.js';
+import { type CreateWebhookOptions, type CreateWebhookResult, type DeleteWebhookResult, type PartnerWebhook, type WebhookList, type PartnerWebhookEventType, type WebhookPatch, type WebhookTestResult, type WebhookDelivery } from './webhooks.js';
+import type { ActivateCashregisterResult, CreateCashregisterOptions, CreateCashregisterResult, CreateCustomerOptions, CreateCustomerResult, CustomerCredentials, FonLinkResult, CustomerCashregisterList, PartnerCustomer, PartnerCustomerList, ListCustomersOptions, PartnerInfo, ReportCustomerContractOptions, ReportCustomerContractResult, RequestSignatureOptions, RequestSignatureResult, CustomerSignatureStatus } from './typen.js';
 /**
- * Die Basis-URL der Partner-API: `/v3`, die englische Fassung.
- *
- * Nur der Partner-Teil spricht `/v3`. Belege, Rechnungen, Kasse und Zahlungen
- * laufen weiter ueber [DEFAULT_BASE_URL] (`/v1`), bis es fuer sie eine `/v3`
- * gibt. Die Partner-Endpunkte unter `/v1` antworten weiter, deutsch und
- * abgekuendigt (Kopfzeilen `Deprecation`/`Sunset`); dieser Client spricht sie
- * nicht mehr.
+ * Die Basis-URL der Partner-API: `/v3`, die englische Fassung, dieselbe wie
+ * [DEFAULT_BASE_URL]. Die 1.x-Linie spricht nur noch `/v3`; die
+ * Partner-Endpunkte unter `/v1` antworten weiter, deutsch und abgekuendigt
+ * (Kopfzeilen `Deprecation`/`Sunset`), dieser Client spricht sie nicht.
  */
 export declare const PARTNER_BASE_URL = "https://api.kasseneck.at/v3";
 export interface PartnerApiOptions {
@@ -34,15 +31,15 @@ export interface PartnerApiOptions {
 }
 export interface PartnerApi {
     getPartnerInfo(): Promise<PartnerInfo>;
-    createPartnerCustomer(optionen: CreateCustomerOptions): Promise<CreateCustomerResult>;
-    listPartnerCustomers(optionen?: ListCustomersOptions): Promise<KundenListe>;
-    getPartnerCustomer(customerId: string): Promise<Kunde>;
+    createPartnerCustomer(options: CreateCustomerOptions): Promise<CreateCustomerResult>;
+    listPartnerCustomers(options?: ListCustomersOptions): Promise<PartnerCustomerList>;
+    getPartnerCustomer(customerId: string): Promise<PartnerCustomer>;
     sendPartnerCustomerFonLink(customerId: string): Promise<FonLinkResult>;
-    requestCustomerSignature(customerId: string, optionen?: RequestSignatureOptions): Promise<RequestSignatureResult>;
-    getCustomerSignatureStatus(customerId: string): Promise<SignaturStand>;
-    createCustomerCashregister(optionen: CreateCashregisterOptions): Promise<CreateCashregisterResult>;
+    requestCustomerSignature(customerId: string, options?: RequestSignatureOptions): Promise<RequestSignatureResult>;
+    getCustomerSignatureStatus(customerId: string): Promise<CustomerSignatureStatus>;
+    createCustomerCashregister(options: CreateCashregisterOptions): Promise<CreateCashregisterResult>;
     activateCashregister(customerId: string, cashregisterId: string): Promise<ActivateCashregisterResult>;
-    listCustomerCashregisters(customerId: string): Promise<KassenListe>;
+    listCustomerCashregisters(customerId: string): Promise<CustomerCashregisterList>;
     /** Geheimnisse des Betriebs — siehe `getCustomerCredentials` in endpunkte.ts. */
     getCustomerCredentials(customerId: string): Promise<CustomerCredentials>;
     /**
@@ -51,8 +48,13 @@ export interface PartnerApi {
      * erst nach dem ganzen Formular auf.
      */
     checkPartnerCustomerEmail(email: string): Promise<boolean>;
-    createPartnerWebhook(optionen: CreateWebhookOptions): Promise<CreateWebhookResult>;
-    listPartnerWebhooks(): Promise<WebhookListe>;
+    /**
+     * Meldet eine in Vollmacht eingeholte Zustimmung des Betriebs (nur AVV);
+     * siehe `reportCustomerContract` in endpunkte.ts.
+     */
+    reportCustomerContract(options: ReportCustomerContractOptions): Promise<ReportCustomerContractResult>;
+    createPartnerWebhook(options: CreateWebhookOptions): Promise<CreateWebhookResult>;
+    listPartnerWebhooks(): Promise<WebhookList>;
     updatePartnerWebhook(webhookId: string, patch: WebhookPatch): Promise<PartnerWebhook>;
     deletePartnerWebhook(webhookId: string): Promise<DeleteWebhookResult>;
     /**
@@ -66,15 +68,16 @@ export interface PartnerApi {
      * soll. Jede Probe traegt `test: true` im Umschlag.
      */
     sendPartnerWebhookTest(webhookId: string, event?: PartnerWebhookEventType | (string & {})): Promise<WebhookTestResult>;
-    listPartnerWebhookDeliveries(optionen?: {
+    listPartnerWebhookDeliveries(options?: {
         webhookId?: string;
         limit?: number;
-    }): Promise<WebhookZustellung[]>;
+    }): Promise<WebhookDelivery[]>;
     /**
      * Der Handlungssatz zu einem beliebigen Fehlercode der Partner-API. Gehoert
      * in die eigene Fehlermeldung, damit ein Anwender nicht in der Doku
-     * nachschlagen muss.
+     * nachschlagen muss. Fuer einen unbekannten Code kommt ein Rueckfallsatz,
+     * nie `undefined` und nie ein Wurf.
      */
-    fehlerRat(code: string): string | undefined;
+    errorAdvice(code: string): string;
 }
-export declare function createPartnerApi(optionen: PartnerApiOptions): PartnerApi;
+export declare function createPartnerApi(options: PartnerApiOptions): PartnerApi;

package/dist/esm/partner/api.js

@@ -6,25 +6,22 @@
  */
 import { createTransport } from '../client/transport.js';
 import { partnerKeyAuth } from './auth.js';
-import { partnerFehlerRat } from './fehler.js';
-import { activateCashregister, createCustomerCashregister, createPartnerCustomer, getCustomerCredentials, getCustomerSignatureStatus, getPartnerCustomer, getPartnerInfo, checkPartnerCustomerEmail, listCustomerCashregisters, listPartnerCustomers, requestCustomerSignature, sendPartnerCustomerFonLink, } from './endpunkte.js';
+import { partnerErrorAdvice } from './fehler.js';
+import { activateCashregister, createCustomerCashregister, createPartnerCustomer, getCustomerCredentials, getCustomerSignatureStatus, getPartnerCustomer, getPartnerInfo, checkPartnerCustomerEmail, listCustomerCashregisters, reportCustomerContract, listPartnerCustomers, requestCustomerSignature, sendPartnerCustomerFonLink, } from './endpunkte.js';
 import { createPartnerWebhook, deletePartnerWebhook, listPartnerWebhookDeliveries, listPartnerWebhooks, rotatePartnerWebhookSecret, sendPartnerWebhookTest, updatePartnerWebhook, } from './webhooks.js';
 /**
- * Die Basis-URL der Partner-API: `/v3`, die englische Fassung.
- *
- * Nur der Partner-Teil spricht `/v3`. Belege, Rechnungen, Kasse und Zahlungen
- * laufen weiter ueber [DEFAULT_BASE_URL] (`/v1`), bis es fuer sie eine `/v3`
- * gibt. Die Partner-Endpunkte unter `/v1` antworten weiter, deutsch und
- * abgekuendigt (Kopfzeilen `Deprecation`/`Sunset`); dieser Client spricht sie
- * nicht mehr.
+ * Die Basis-URL der Partner-API: `/v3`, die englische Fassung, dieselbe wie
+ * [DEFAULT_BASE_URL]. Die 1.x-Linie spricht nur noch `/v3`; die
+ * Partner-Endpunkte unter `/v1` antworten weiter, deutsch und abgekuendigt
+ * (Kopfzeilen `Deprecation`/`Sunset`), dieser Client spricht sie nicht.
  */
 export const PARTNER_BASE_URL = 'https://api.kasseneck.at/v3';
-export function createPartnerApi(optionen) {
+export function createPartnerApi(options) {
     const rufen = createTransport({
-        auth: partnerKeyAuth({ partnerKey: optionen.partnerKey }),
-        baseUrl: optionen.baseUrl ?? PARTNER_BASE_URL,
-        timeoutMs: optionen.timeoutMs,
-        fetch: optionen.fetch,
+        auth: partnerKeyAuth({ partnerKey: options.partnerKey }),
+        baseUrl: options.baseUrl ?? PARTNER_BASE_URL,
+        timeoutMs: options.timeoutMs,
+        fetch: options.fetch,
     });
     return {
         getPartnerInfo: () => getPartnerInfo(rufen),
@@ -39,6 +36,7 @@ export function createPartnerApi(optionen) {
         listCustomerCashregisters: (id) => listCustomerCashregisters(rufen, id),
         getCustomerCredentials: (id) => getCustomerCredentials(rufen, id),
         checkPartnerCustomerEmail: (email) => checkPartnerCustomerEmail(rufen, email),
+        reportCustomerContract: (o) => reportCustomerContract(rufen, o),
         createPartnerWebhook: (o) => createPartnerWebhook(rufen, o),
         listPartnerWebhooks: () => listPartnerWebhooks(rufen),
         updatePartnerWebhook: (id, patch) => updatePartnerWebhook(rufen, id, patch),
@@ -46,6 +44,6 @@ export function createPartnerApi(optionen) {
         rotatePartnerWebhookSecret: (id) => rotatePartnerWebhookSecret(rufen, id),
         sendPartnerWebhookTest: (id, event) => sendPartnerWebhookTest(rufen, id, event),
         listPartnerWebhookDeliveries: (o) => listPartnerWebhookDeliveries(rufen, o),
-        fehlerRat: (code) => partnerFehlerRat(code),
+        errorAdvice: (code) => partnerErrorAdvice(code),
     };
 }

package/dist/esm/partner/auth.d.ts

@@ -17,7 +17,7 @@ import type { PartnerEnv } from './typen.js';
  * keiner ist. Nuetzlich fuer die Zusicherung „auf diesem Server laeuft nur
  * `pk_live_`" beim Hochfahren.
  */
-export declare function partnerKeyEnv(schluessel: string): PartnerEnv | null;
+export declare function partnerKeyEnv(key: string): PartnerEnv | null;
 export interface PartnerKeyAuthOptions {
     /** Partner-Schluessel `pk_test_…` / `pk_live_…`. */
     partnerKey: string;

package/dist/esm/partner/auth.js

@@ -22,8 +22,8 @@ const SCHLUESSEL_FORM = /^pk_(test|live)_[A-Za-z0-9_-]{16,}$/;
  * keiner ist. Nuetzlich fuer die Zusicherung „auf diesem Server laeuft nur
  * `pk_live_`" beim Hochfahren.
  */
-export function partnerKeyEnv(schluessel) {
-    const treffer = SCHLUESSEL_FORM.exec(typeof schluessel === 'string' ? schluessel.trim() : '');
+export function partnerKeyEnv(key) {
+    const treffer = SCHLUESSEL_FORM.exec(typeof key === 'string' ? key.trim() : '');
     return treffer ? treffer[1] : null;
 }
 /**

package/dist/esm/partner/betrieb.d.ts

@@ -13,15 +13,15 @@
  *
  * Zwei Dinge halten diese Seite dagegen:
  *
- * - der Typ [Betrieb] (typen.ts) hat genau diese Felder, und TypeScript meldet
+ * - der Typ [Business] (typen.ts) hat genau diese Felder, und TypeScript meldet
  *   ein ueberzaehliges schon beim Tippen;
- * - [unbekannteBetriebsfelder] beantwortet dieselbe Frage zur Laufzeit — fuer
+ * - [unknownBusinessFields] beantwortet dieselbe Frage zur Laufzeit, fuer
  *   Daten, die aus einer Datenbank oder einem Formular kommen und deshalb nie
  *   durch die Typpruefung gelaufen sind.
  *
  * **Die Wahrheit bleibt der Server.** Dieser Client weist nichts von sich aus
  * ab: eine spaetere Backend-Fassung darf ein Feld ergaenzen, ohne dass ein
- * aelterer Client es blockiert. [unbekannteBetriebsfelder] ist die Vorschau,
+ * aelterer Client es blockiert. [unknownBusinessFields] ist die Vorschau,
  * nicht das Tor.
  *
  * Quelle der Liste: `partner-core.BETRIEB_FELDER` im Backend.
@@ -34,10 +34,10 @@
  * Zwilling Zeile fuer Zeile nachhalten kann. Das Schema fuer die Pruefung
  * entsteht daraus (siehe unten) und nicht daneben.
  */
-export declare const BETRIEB_FELDER: readonly ["companyName", "legalForm", "state", "industry", "companyRegister", "court", "web", "phone", "email", "billingEmail", "address.street", "address.number", "address.zip", "address.city", "taxDetails.taxNumber", "taxDetails.vatId", "taxDetails.gln", "taxDetails.smallBusiness", "contacts[].name", "contacts[].email", "contacts[].phone", "contacts[].roles", "taxAdvisor.name", "taxAdvisor.email", "taxAdvisor.phone", "taxAdvisor.mayContact"];
-export type BetriebFeld = typeof BETRIEB_FELDER[number];
+export declare const BUSINESS_FIELDS: readonly ["companyName", "legalForm", "state", "industry", "companyRegister", "court", "web", "phone", "email", "billingEmail", "address.street", "address.number", "address.zip", "address.city", "taxDetails.taxNumber", "taxDetails.vatId", "taxDetails.gln", "taxDetails.smallBusiness", "contacts[].name", "contacts[].email", "contacts[].phone", "contacts[].roles", "taxAdvisor.name", "taxAdvisor.email", "taxAdvisor.phone", "taxAdvisor.mayContact"];
+export type BusinessField = typeof BUSINESS_FIELDS[number];
 /**
- * Die Feldpfade eines Betriebs, die [BETRIEB_FELDER] nicht kennt — dieselbe
+ * Die Feldpfade eines Betriebs, die [BUSINESS_FIELDS] nicht kennt, dieselbe
  * Ableitung wie im Backend, also dieselben Pfade wie in `data.errors[].field`.
  * Leer heisst: aus dieser Sicht ist nichts ueberzaehlig.
  *
@@ -45,4 +45,4 @@ export type BetriebFeld = typeof BETRIEB_FELDER[number];
  * das Backend mit `@kreiseck/validator`. Diese Funktion beantwortet nur die
  * Frage „schicke ich etwas, das dort niemand erwartet?".
  */
-export declare function unbekannteBetriebsfelder(business: unknown): string[];
+export declare function unknownBusinessFields(business: unknown): string[];

package/dist/esm/partner/betrieb.js

@@ -13,15 +13,15 @@
  *
  * Zwei Dinge halten diese Seite dagegen:
  *
- * - der Typ [Betrieb] (typen.ts) hat genau diese Felder, und TypeScript meldet
+ * - der Typ [Business] (typen.ts) hat genau diese Felder, und TypeScript meldet
  *   ein ueberzaehliges schon beim Tippen;
- * - [unbekannteBetriebsfelder] beantwortet dieselbe Frage zur Laufzeit — fuer
+ * - [unknownBusinessFields] beantwortet dieselbe Frage zur Laufzeit, fuer
  *   Daten, die aus einer Datenbank oder einem Formular kommen und deshalb nie
  *   durch die Typpruefung gelaufen sind.
  *
  * **Die Wahrheit bleibt der Server.** Dieser Client weist nichts von sich aus
  * ab: eine spaetere Backend-Fassung darf ein Feld ergaenzen, ohne dass ein
- * aelterer Client es blockiert. [unbekannteBetriebsfelder] ist die Vorschau,
+ * aelterer Client es blockiert. [unknownBusinessFields] ist die Vorschau,
  * nicht das Tor.
  *
  * Quelle der Liste: `partner-core.BETRIEB_FELDER` im Backend.
@@ -34,7 +34,7 @@
  * Zwilling Zeile fuer Zeile nachhalten kann. Das Schema fuer die Pruefung
  * entsteht daraus (siehe unten) und nicht daneben.
  */
-export const BETRIEB_FELDER = [
+export const BUSINESS_FIELDS = [
     'companyName',
     'legalForm',
     'state',
@@ -62,10 +62,10 @@ export const BETRIEB_FELDER = [
     'taxAdvisor.phone',
     'taxAdvisor.mayContact',
 ];
-/** Das Schema entsteht aus [BETRIEB_FELDER] — eine Quelle, keine zweite Liste. */
+/** Das Schema entsteht aus [BUSINESS_FIELDS]: eine Quelle, keine zweite Liste. */
 const SCHEMA = (() => {
     const wurzel = {};
-    for (const pfad of BETRIEB_FELDER) {
+    for (const pfad of BUSINESS_FIELDS) {
         const teile = pfad.split('.');
         let stand = wurzel;
         teile.forEach((rohes, i) => {
@@ -119,7 +119,7 @@ function sammle(eingabe, schema, pfad) {
     return raus;
 }
 /**
- * Die Feldpfade eines Betriebs, die [BETRIEB_FELDER] nicht kennt — dieselbe
+ * Die Feldpfade eines Betriebs, die [BUSINESS_FIELDS] nicht kennt, dieselbe
  * Ableitung wie im Backend, also dieselben Pfade wie in `data.errors[].field`.
  * Leer heisst: aus dieser Sicht ist nichts ueberzaehlig.
  *
@@ -127,6 +127,6 @@ function sammle(eingabe, schema, pfad) {
  * das Backend mit `@kreiseck/validator`. Diese Funktion beantwortet nur die
  * Frage „schicke ich etwas, das dort niemand erwartet?".
  */
-export function unbekannteBetriebsfelder(business) {
+export function unknownBusinessFields(business) {
     return sammle(business, SCHEMA, '');
 }

package/dist/esm/partner/endpunkte.d.ts

@@ -11,7 +11,7 @@
  * PLZ, Gericht) macht das Backend mit `@kreiseck/validator` — sie hier zu
  * wiederholen hiesse, zwei Wahrheiten zu haben, von denen eine veraltet.
  * Ein Formfehler kommt als `KasseneckApiError` mit `code:"validation"` zurueck;
- * `partnerFeldFehler(fehler)` macht `data.errors[]` daraus. **Es entsteht dabei
+ * `partnerFieldErrors(fehler)` macht `data.errors[]` daraus. **Es entsteht dabei
  * nichts** — der Aufruf ist folgenlos wiederholbar.
  *
  * Nach dem Senden wird nichts hart gecastet: fehlt ein zugesagtes Feld, wirft
@@ -19,7 +19,7 @@
  * einen `TypeError` an unpassender Stelle.
  */
 import type { InternerTransport } from '../client/aufrufe.js';
-import type { ActivateCashregisterResult, CreateCashregisterOptions, CreateCashregisterResult, CreateCustomerOptions, CreateCustomerResult, CustomerCredentials, FonLinkResult, KassenListe, Kunde, KundenListe, ListCustomersOptions, PartnerInfo, RequestSignatureOptions, RequestSignatureResult, SignaturStand } from './typen.js';
+import type { ActivateCashregisterResult, CreateCashregisterOptions, CreateCashregisterResult, CreateCustomerOptions, CreateCustomerResult, CustomerCredentials, FonLinkResult, CustomerCashregisterList, PartnerCustomer, PartnerCustomerList, ListCustomersOptions, PartnerInfo, ReportCustomerContractOptions, ReportCustomerContractResult, RequestSignatureOptions, RequestSignatureResult, CustomerSignatureStatus } from './typen.js';
 /**
  * Wer bin ich, in welcher Umgebung, mit welchen Rechten — und welche Apps
  * gehoeren mir. `apps[].id` ist die `appId` fuer [createPartnerCustomer].
@@ -27,7 +27,7 @@ import type { ActivateCashregisterResult, CreateCashregisterOptions, CreateCashr
  * Der guenstigste Selbsttest beim Hochfahren: er beweist Schluessel, Umgebung
  * und Rechte in einem Aufruf.
  */
-export declare function getPartnerInfo(rufen: InternerTransport): Promise<PartnerInfo>;
+export declare function getPartnerInfo(transport: InternerTransport): Promise<PartnerInfo>;
 /**
  * Legt einen Betrieb an.
  *
@@ -46,11 +46,11 @@ export declare function getPartnerInfo(rufen: InternerTransport): Promise<Partne
  * — auch dann, wenn der Rumpf inzwischen abweicht. Die eigene Kundennummer ist
  * der natuerliche Wert dafuer.
  */
-export declare function createPartnerCustomer(rufen: InternerTransport, optionen: CreateCustomerOptions): Promise<CreateCustomerResult>;
+export declare function createPartnerCustomer(transport: InternerTransport, options: CreateCustomerOptions): Promise<CreateCustomerResult>;
 /** Betriebe dieses Partners, seitenweise. `cursor` aus der Antwort setzt fort. */
-export declare function listPartnerCustomers(rufen: InternerTransport, optionen?: ListCustomersOptions): Promise<KundenListe>;
+export declare function listPartnerCustomers(transport: InternerTransport, options?: ListCustomersOptions): Promise<PartnerCustomerList>;
 /** Ein Betrieb mit allem, was der Partner ueber ihn sehen darf — nie Geheimnisse. */
-export declare function getPartnerCustomer(rufen: InternerTransport, customerId: string): Promise<Kunde>;
+export declare function getPartnerCustomer(transport: InternerTransport, customerId: string): Promise<PartnerCustomer>;
 /**
  * Schickt dem Betrieb den Einrichtungs-Link fuer seinen FinanzOnline-Zugang.
  * Ohne diesen Zugang gibt es live keine Signatureinheit (`fon_missing`).
@@ -69,8 +69,8 @@ export declare function getPartnerCustomer(rufen: InternerTransport, customerId:
  * einem ganzen ausgefuellten Formular auf. Die Antwort sagt NUR ja oder nein —
  * nie, wem die Adresse gehoert.
  */
-export declare function checkPartnerCustomerEmail(rufen: InternerTransport, email: string): Promise<boolean>;
-export declare function sendPartnerCustomerFonLink(rufen: InternerTransport, customerId: string): Promise<FonLinkResult>;
+export declare function checkPartnerCustomerEmail(transport: InternerTransport, email: string): Promise<boolean>;
+export declare function sendPartnerCustomerFonLink(transport: InternerTransport, customerId: string): Promise<FonLinkResult>;
 /**
  * Beantragt die Signatureinheit. Kasseneck laesst die Karte beim
  * Vertrauensdiensteanbieter **auf diesen Betrieb** ausstellen und meldet sie
@@ -87,9 +87,9 @@ export declare function sendPartnerCustomerFonLink(rufen: InternerTransport, cus
  * Abschluss kommt als Ereignis `signature.ready`, nicht als Antwort auf diesen
  * Aufruf.
  */
-export declare function requestCustomerSignature(rufen: InternerTransport, customerId: string, optionen?: RequestSignatureOptions): Promise<RequestSignatureResult>;
+export declare function requestCustomerSignature(transport: InternerTransport, customerId: string, options?: RequestSignatureOptions): Promise<RequestSignatureResult>;
 /** Stand der Signatur eines Betriebs samt aller Signaturen, Antraege und des FON-Zugangs. */
-export declare function getCustomerSignatureStatus(rufen: InternerTransport, customerId: string): Promise<SignaturStand>;
+export declare function getCustomerSignatureStatus(transport: InternerTransport, customerId: string): Promise<CustomerSignatureStatus>;
 /**
  * Legt eine Kasse an.
  *
@@ -105,7 +105,7 @@ export declare function getCustomerSignatureStatus(rufen: InternerTransport, cus
  * Hoechstens 20 Kassen je Betrieb (`cashregister_limit`); ohne gebuchtes Modul
  * `module_inactive`.
  */
-export declare function createCustomerCashregister(rufen: InternerTransport, optionen: CreateCashregisterOptions): Promise<CreateCashregisterResult>;
+export declare function createCustomerCashregister(transport: InternerTransport, options: CreateCashregisterOptions): Promise<CreateCashregisterResult>;
 /**
  * Nimmt eine Kasse in Betrieb — von Hand, wenn `automatic:false` gilt oder
  * ein Lauf abgebrochen ist.
@@ -117,9 +117,9 @@ export declare function createCustomerCashregister(rufen: InternerTransport, opt
  * veraendernde Aufruf dieses Clients, der ohne Idempotenzschluessel gefahrlos
  * wiederholbar ist — weil der Server ihn so gebaut hat.
  */
-export declare function activateCashregister(rufen: InternerTransport, customerId: string, cashregisterId: string): Promise<ActivateCashregisterResult>;
+export declare function activateCashregister(transport: InternerTransport, customerId: string, cashregisterId: string): Promise<ActivateCashregisterResult>;
 /** Die Kassen eines Betriebs samt Stand der Inbetriebnahme — **nie** Token. */
-export declare function listCustomerCashregisters(rufen: InternerTransport, customerId: string): Promise<KassenListe>;
+export declare function listCustomerCashregisters(transport: InternerTransport, customerId: string): Promise<CustomerCashregisterList>;
 /**
  * Holt die **Geheimnisse des Betriebs**: seinen `api_key` und die Token seiner
  * Kassen. Damit signiert eine App in seinem Namen Belege — und ein Beleg ist
@@ -136,4 +136,17 @@ export declare function listCustomerCashregisters(rufen: InternerTransport, cust
  * Zeichenketten-Umwandlung zeigen eine Maske, heraus kommt man nur ueber
  * `.reveal()`.
  */
-export declare function getCustomerCredentials(rufen: InternerTransport, customerId: string): Promise<CustomerCredentials>;
+export declare function getCustomerCredentials(transport: InternerTransport, customerId: string): Promise<CustomerCredentials>;
+/**
+ * Meldet eine Zustimmung des Betriebs, die der Partner **in Vollmacht**
+ * eingeholt hat (Endpunkt `reportCustomerContract`, unter `/v1`
+ * `reportCustomerVertrag`). Braucht die Berechtigung `customers:write`.
+ *
+ * Vor dem Senden prueft dieser Client nur, dass jede Pflichtangabe da ist und
+ * `acceptedAt` eine Zahl ist. Ob die Art erlaubt ist (`kind_not_allowed`), die
+ * Fassung gilt (`unknown_version`, `no_version`) und der Text derselbe ist
+ * (`text_changed`), entscheidet der Server. Eine schon bestaetigte Fassung
+ * kommt als `already_accepted` mit `data.contractId`; das ist kein Schaden,
+ * sondern die Bestaetigung, dass es sie gibt.
+ */
+export declare function reportCustomerContract(transport: InternerTransport, options: ReportCustomerContractOptions): Promise<ReportCustomerContractResult>;

package/dist/esm/partner/endpunkte.js

@@ -11,7 +11,7 @@
  * PLZ, Gericht) macht das Backend mit `@kreiseck/validator` — sie hier zu
  * wiederholen hiesse, zwei Wahrheiten zu haben, von denen eine veraltet.
  * Ein Formfehler kommt als `KasseneckApiError` mit `code:"validation"` zurueck;
- * `partnerFeldFehler(fehler)` macht `data.errors[]` daraus. **Es entsteht dabei
+ * `partnerFieldErrors(fehler)` macht `data.errors[]` daraus. **Es entsteht dabei
  * nichts** — der Aufruf ist folgenlos wiederholbar.
  *
  * Nach dem Senden wird nichts hart gecastet: fehlt ein zugesagtes Feld, wirft
@@ -86,8 +86,8 @@ function pflicht(wert, vorgang, feld) {
  * Der guenstigste Selbsttest beim Hochfahren: er beweist Schluessel, Umgebung
  * und Rechte in einem Aufruf.
  */
-export async function getPartnerInfo(rufen) {
-    const daten = objekt(await rufen('getPartnerInfo'));
+export async function getPartnerInfo(transport) {
+    const daten = objekt(await transport('getPartnerInfo'));
     const partner = verlangt(daten['partner'], 'getPartnerInfo', 'partner');
     const key = objekt(daten['key']);
     return {
@@ -145,18 +145,18 @@ export async function getPartnerInfo(rufen) {
  * — auch dann, wenn der Rumpf inzwischen abweicht. Die eigene Kundennummer ist
  * der natuerliche Wert dafuer.
  */
-export async function createPartnerCustomer(rufen, optionen) {
-    const appId = pflicht(optionen?.appId, 'createPartnerCustomer', 'appId');
-    const betrieb = optionen?.business;
+export async function createPartnerCustomer(transport, options) {
+    const appId = pflicht(options?.appId, 'createPartnerCustomer', 'appId');
+    const betrieb = options?.business;
     if (betrieb === null || typeof betrieb !== 'object') {
         throw new KasseneckValidationError('createPartnerCustomer', 'business fehlt', 'request');
     }
-    const daten = objekt(await rufen('createPartnerCustomer', {
+    const daten = objekt(await transport('createPartnerCustomer', {
         appId,
         business: betrieb,
-        idempotencyKey: optionen.idempotencyKey,
-        access: optionen.access,
-        env: optionen.env,
+        idempotencyKey: options.idempotencyKey,
+        access: options.access,
+        env: options.env,
     }));
     const customerId = textOderNull(daten['customerId']);
     if (!customerId) {
@@ -176,14 +176,14 @@ export async function createPartnerCustomer(rufen, optionen) {
     };
 }
 /** Betriebe dieses Partners, seitenweise. `cursor` aus der Antwort setzt fort. */
-export async function listPartnerCustomers(rufen, optionen = {}) {
-    if (optionen.limit !== undefined && (!Number.isInteger(optionen.limit) || optionen.limit < 1 || optionen.limit > 200)) {
+export async function listPartnerCustomers(transport, options = {}) {
+    if (options.limit !== undefined && (!Number.isInteger(options.limit) || options.limit < 1 || options.limit > 200)) {
         throw new KasseneckValidationError('listPartnerCustomers', 'limit muss zwischen 1 und 200 liegen', 'request');
     }
-    const daten = objekt(await rufen('listPartnerCustomers', {
-        status: optionen.status,
-        limit: optionen.limit,
-        cursor: optionen.cursor,
+    const daten = objekt(await transport('listPartnerCustomers', {
+        status: options.status,
+        limit: options.limit,
+        cursor: options.cursor,
     }));
     return {
         customers: liste(daten['customers']).map(kundenZeile),
@@ -233,9 +233,9 @@ function avvStand(wert) {
     return { ...v, mode: textOderNull(wert['mode']) };
 }
 /** Ein Betrieb mit allem, was der Partner ueber ihn sehen darf — nie Geheimnisse. */
-export async function getPartnerCustomer(rufen, customerId) {
+export async function getPartnerCustomer(transport, customerId) {
     const id = pflicht(customerId, 'getPartnerCustomer', 'customerId');
-    const daten = objekt(await rufen('getPartnerCustomer', { customerId: id }));
+    const daten = objekt(await transport('getPartnerCustomer', { customerId: id }));
     const k = verlangt(daten['customer'], 'getPartnerCustomer', 'customer');
     const fon = objekt(k['fon']);
     const zugang = k['access'];
@@ -280,16 +280,16 @@ export async function getPartnerCustomer(rufen, customerId) {
  * einem ganzen ausgefuellten Formular auf. Die Antwort sagt NUR ja oder nein —
  * nie, wem die Adresse gehoert.
  */
-export async function checkPartnerCustomerEmail(rufen, email) {
+export async function checkPartnerCustomerEmail(transport, email) {
     const adresse = typeof email === 'string' ? email.trim() : '';
     if (!adresse)
         throw new KasseneckValidationError('checkPartnerCustomerEmail', 'email fehlt', 'request');
-    const daten = objekt(await rufen('checkPartnerCustomerEmail', { email: adresse }));
+    const daten = objekt(await transport('checkPartnerCustomerEmail', { email: adresse }));
     return daten['available'] === true;
 }
-export async function sendPartnerCustomerFonLink(rufen, customerId) {
+export async function sendPartnerCustomerFonLink(transport, customerId) {
     const id = pflicht(customerId, 'sendPartnerCustomerFonLink', 'customerId');
-    const daten = objekt(await rufen('sendPartnerCustomerFonLink', { customerId: id }));
+    const daten = objekt(await transport('sendPartnerCustomerFonLink', { customerId: id }));
     return {
         customerId: text(daten['customerId'], id),
         sentTo: text(daten['sentTo']),
@@ -346,12 +346,12 @@ function antrag(eintrag) {
  * Abschluss kommt als Ereignis `signature.ready`, nicht als Antwort auf diesen
  * Aufruf.
  */
-export async function requestCustomerSignature(rufen, customerId, optionen = {}) {
+export async function requestCustomerSignature(transport, customerId, options = {}) {
     const id = pflicht(customerId, 'requestCustomerSignature', 'customerId');
-    const daten = objekt(await rufen('requestCustomerSignature', {
+    const daten = objekt(await transport('requestCustomerSignature', {
         customerId: id,
-        kind: optionen.kind,
-        additional: optionen.additional,
+        kind: options.kind,
+        additional: options.additional,
     }));
     return {
         request: antrag(verlangt(daten['request'], 'requestCustomerSignature', 'request')),
@@ -385,9 +385,9 @@ function signaturEinzeln(eintrag) {
     };
 }
 /** Stand der Signatur eines Betriebs samt aller Signaturen, Antraege und des FON-Zugangs. */
-export async function getCustomerSignatureStatus(rufen, customerId) {
+export async function getCustomerSignatureStatus(transport, customerId) {
     const id = pflicht(customerId, 'getCustomerSignatureStatus', 'customerId');
-    const daten = objekt(await rufen('getCustomerSignatureStatus', { customerId: id }));
+    const daten = objekt(await transport('getCustomerSignatureStatus', { customerId: id }));
     const signatur = objekt(daten['signature']);
     const fon = objekt(daten['fon']);
     return {
@@ -447,12 +447,12 @@ function kasse(eintrag) {
  * Hoechstens 20 Kassen je Betrieb (`cashregister_limit`); ohne gebuchtes Modul
  * `module_inactive`.
  */
-export async function createCustomerCashregister(rufen, optionen) {
-    const id = pflicht(optionen?.customerId, 'createCustomerCashregister', 'customerId');
-    const daten = objekt(await rufen('createCustomerCashregister', {
+export async function createCustomerCashregister(transport, options) {
+    const id = pflicht(options?.customerId, 'createCustomerCashregister', 'customerId');
+    const daten = objekt(await transport('createCustomerCashregister', {
         customerId: id,
-        automatic: optionen.automatic,
-        signatureRequestId: optionen.signatureRequestId,
+        automatic: options.automatic,
+        signatureRequestId: options.signatureRequestId,
     }));
     const ib = objekt(daten['activation']);
     return {
@@ -476,19 +476,19 @@ export async function createCustomerCashregister(rufen, optionen) {
  * veraendernde Aufruf dieses Clients, der ohne Idempotenzschluessel gefahrlos
  * wiederholbar ist — weil der Server ihn so gebaut hat.
  */
-export async function activateCashregister(rufen, customerId, cashregisterId) {
+export async function activateCashregister(transport, customerId, cashregisterId) {
     const kunde = pflicht(customerId, 'activateCashregister', 'customerId');
     const kassenId = pflicht(cashregisterId, 'activateCashregister', 'cashregisterId');
-    const daten = objekt(await rufen('activateCashregister', { customerId: kunde, cashregisterId: kassenId }));
+    const daten = objekt(await transport('activateCashregister', { customerId: kunde, cashregisterId: kassenId }));
     return {
         cashregister: kasse(verlangt(daten['cashregister'], 'activateCashregister', 'cashregister')),
         unchanged: jaNein(daten['unchanged']),
     };
 }
 /** Die Kassen eines Betriebs samt Stand der Inbetriebnahme — **nie** Token. */
-export async function listCustomerCashregisters(rufen, customerId) {
+export async function listCustomerCashregisters(transport, customerId) {
     const id = pflicht(customerId, 'listCustomerCashregisters', 'customerId');
-    const daten = objekt(await rufen('listCustomerCashregisters', { customerId: id }));
+    const daten = objekt(await transport('listCustomerCashregisters', { customerId: id }));
     return {
         customerId: text(daten['customerId'], id),
         cashregisters: liste(daten['cashregisters']).map(kasse),
@@ -511,9 +511,9 @@ export async function listCustomerCashregisters(rufen, customerId) {
  * Zeichenketten-Umwandlung zeigen eine Maske, heraus kommt man nur ueber
  * `.reveal()`.
  */
-export async function getCustomerCredentials(rufen, customerId) {
+export async function getCustomerCredentials(transport, customerId) {
     const id = pflicht(customerId, 'getCustomerCredentials', 'customerId');
-    const daten = objekt(await rufen('getCustomerCredentials', { customerId: id }));
+    const daten = objekt(await transport('getCustomerCredentials', { customerId: id }));
     return {
         customerId: text(daten['customerId'], id),
         companyName: text(daten['companyName']),
@@ -531,3 +531,43 @@ export async function getCustomerCredentials(rufen, customerId) {
         note: text(daten['note']),
     };
 }
+// ---------------------------------------------------------------------------
+// Vertraege
+// ---------------------------------------------------------------------------
+/**
+ * Meldet eine Zustimmung des Betriebs, die der Partner **in Vollmacht**
+ * eingeholt hat (Endpunkt `reportCustomerContract`, unter `/v1`
+ * `reportCustomerVertrag`). Braucht die Berechtigung `customers:write`.
+ *
+ * Vor dem Senden prueft dieser Client nur, dass jede Pflichtangabe da ist und
+ * `acceptedAt` eine Zahl ist. Ob die Art erlaubt ist (`kind_not_allowed`), die
+ * Fassung gilt (`unknown_version`, `no_version`) und der Text derselbe ist
+ * (`text_changed`), entscheidet der Server. Eine schon bestaetigte Fassung
+ * kommt als `already_accepted` mit `data.contractId`; das ist kein Schaden,
+ * sondern die Bestaetigung, dass es sie gibt.
+ */
+export async function reportCustomerContract(transport, options) {
+    const vorgang = 'reportCustomerContract';
+    const o = objekt(options);
+    const customerId = pflicht(o['customerId'], vorgang, 'customerId');
+    const kind = pflicht(o['kind'], vorgang, 'kind');
+    const version = pflicht(o['version'], vorgang, 'version');
+    const textHash = pflicht(o['textHash'], vorgang, 'textHash');
+    const name = pflicht(o['name'], vorgang, 'name');
+    const signerRole = pflicht(o['signerRole'], vorgang, 'signerRole');
+    const acceptedAt = o['acceptedAt'];
+    if (acceptedAt !== undefined && (typeof acceptedAt !== 'number' || !Number.isFinite(acceptedAt))) {
+        throw new KasseneckValidationError(vorgang, 'acceptedAt muss eine Zahl sein (Unix-Millisekunden)', 'request');
+    }
+    const daten = objekt(await transport(vorgang, { customerId, kind, version, textHash, name, signerRole, acceptedAt }));
+    const contractId = daten['contractId'];
+    if (typeof contractId !== 'string' || !contractId) {
+        throw new KasseneckValidationError(vorgang, 'Antwort enthaelt keine contractId', 'response');
+    }
+    return {
+        contractId,
+        confirmedAt: zahlOderNull(daten['confirmedAt']),
+        kind: text(daten['kind'], kind),
+        version: text(daten['version'], version),
+    };
+}