@kommerz/ts-client 1.176.1 → 1.177.0

package/dist/apis/InvoicesApi.d.ts

@@ -9,7 +9,7 @@
  * Do not edit the class manually.
  */
 import * as runtime from '../runtime';
-import type { GetAllInvoices200Response, InvoiceDto, KommerzPageable, MarkInvoiceAsPaidRequest } from '../models/index';
+import type { GetAllInvoices200Response, InvoiceDto, InvoiceValidationResult, KommerzPageable, MarkInvoiceAsPaidRequest } from '../models/index';
 export interface CreateInvoiceRequest {
     invoiceDto: Omit<InvoiceDto, 'id' | 'version' | 'finalized' | 'dueDate' | 'invoiceDate' | 'invoiceNumber' | 'total' | 'paidTotal' | 'paidAt' | 'paidBy' | 'fileId'>;
 }
@@ -42,6 +42,9 @@ export interface UpdateInvoiceRequest {
     invoiceDto: Omit<InvoiceDto, 'id' | 'version' | 'finalized' | 'dueDate' | 'invoiceDate' | 'invoiceNumber' | 'total' | 'paidTotal' | 'paidAt' | 'paidBy' | 'fileId'>;
     force?: boolean;
 }
+export interface ValidateInvoiceRequest {
+    id: string;
+}
 /**
  *
  */
@@ -118,4 +121,12 @@ export declare class InvoicesApi extends runtime.BaseAPI {
      * Update an invoice
      */
     updateInvoice(requestParameters: UpdateInvoiceRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<InvoiceDto>;
+    /**
+     * validate invoice
+     */
+    validateInvoiceRaw(requestParameters: ValidateInvoiceRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<runtime.ApiResponse<InvoiceValidationResult>>;
+    /**
+     * validate invoice
+     */
+    validateInvoice(requestParameters: ValidateInvoiceRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<InvoiceValidationResult>;
 }

package/dist/apis/InvoicesApi.js

@@ -508,6 +508,52 @@ var InvoicesApi = /** @class */ (function (_super) {
             });
         });
     };
+    /**
+     * validate invoice
+     */
+    InvoicesApi.prototype.validateInvoiceRaw = function (requestParameters, initOverrides) {
+        return __awaiter(this, void 0, void 0, function () {
+            var queryParameters, headerParameters, urlPath, response;
+            return __generator(this, function (_a) {
+                switch (_a.label) {
+                    case 0:
+                        if (requestParameters['id'] == null) {
+                            throw new runtime.RequiredError('id', 'Required parameter "id" was null or undefined when calling validateInvoice().');
+                        }
+                        queryParameters = {};
+                        headerParameters = {};
+                        urlPath = "/ui/invoices/v1/{id}/validate";
+                        urlPath = urlPath.replace("{".concat("id", "}"), encodeURIComponent(String(requestParameters['id'])));
+                        return [4 /*yield*/, this.request({
+                                path: urlPath,
+                                method: 'POST',
+                                headers: headerParameters,
+                                query: queryParameters,
+                            }, initOverrides)];
+                    case 1:
+                        response = _a.sent();
+                        return [2 /*return*/, new runtime.JSONApiResponse(response, function (jsonValue) { return (0, index_1.InvoiceValidationResultFromJSON)(jsonValue); })];
+                }
+            });
+        });
+    };
+    /**
+     * validate invoice
+     */
+    InvoicesApi.prototype.validateInvoice = function (requestParameters, initOverrides) {
+        return __awaiter(this, void 0, void 0, function () {
+            var response;
+            return __generator(this, function (_a) {
+                switch (_a.label) {
+                    case 0: return [4 /*yield*/, this.validateInvoiceRaw(requestParameters, initOverrides)];
+                    case 1:
+                        response = _a.sent();
+                        return [4 /*yield*/, response.value()];
+                    case 2: return [2 /*return*/, _a.sent()];
+                }
+            });
+        });
+    };
     return InvoicesApi;
 }(runtime.BaseAPI));
 exports.InvoicesApi = InvoicesApi;

package/dist/models/InvoiceDto.d.ts

@@ -188,6 +188,12 @@ export interface InvoiceDto {
      * @memberof InvoiceDto
      */
     showGross?: boolean;
+    /**
+     * whether the invoice is issued as a factur-X/ZUGFeRD e-invoice; only then the additional fields the German business rules demand are required, defaults to false
+     * @type {boolean}
+     * @memberof InvoiceDto
+     */
+    facturX?: boolean;
 }
 /**
  * Check if a given object implements the InvoiceDto interface.

package/dist/models/InvoiceDto.js

@@ -71,6 +71,7 @@ function InvoiceDtoFromJSONTyped(json, ignoreDiscriminator) {
         'referencedInvoiceId': json['referencedInvoiceId'] == null ? undefined : json['referencedInvoiceId'],
         'type': json['type'] == null ? undefined : (0, InvoiceType_1.InvoiceTypeFromJSON)(json['type']),
         'showGross': json['showGross'] == null ? undefined : json['showGross'],
+        'facturX': json['facturX'] == null ? undefined : json['facturX'],
     };
 }
 function InvoiceDtoToJSON(json) {
@@ -99,5 +100,6 @@ function InvoiceDtoToJSONTyped(value, ignoreDiscriminator) {
         'referencedInvoiceId': value['referencedInvoiceId'],
         'type': (0, InvoiceType_1.InvoiceTypeToJSON)(value['type']),
         'showGross': value['showGross'],
+        'facturX': value['facturX'],
     };
 }

package/dist/models/InvoiceValidationCheck.d.ts

@@ -0,0 +1,38 @@
+/**
+ * Kommerz API Specification
+ * API specification for Kommerz Services.  - /ui/ for services consumed by the frontend - /intern/ for internal administration endpoints - /extern/ for services consumed by external services - /stats/ for monitoring endpoints - /actuator/ for health endpoints (e.g. /actuator/health )  All endpoints are postfixed with a version number.
+ *
+ * Contact: info@kommerz.app
+ *
+ * NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech).
+ * https://openapi-generator.tech
+ * Do not edit the class manually.
+ */
+/**
+ *
+ * @export
+ */
+export declare const InvoiceValidationCheck: {
+    readonly TenantName: "TENANT_NAME";
+    readonly TenantZipCode: "TENANT_ZIP_CODE";
+    readonly TenantCity: "TENANT_CITY";
+    readonly TenantCountry: "TENANT_COUNTRY";
+    readonly TenantTaxIdentifier: "TENANT_TAX_IDENTIFIER";
+    readonly TenantPhoneNumber: "TENANT_PHONE_NUMBER";
+    readonly TenantEmail: "TENANT_EMAIL";
+    readonly TenantIban: "TENANT_IBAN";
+    readonly CustomerName: "CUSTOMER_NAME";
+    readonly CustomerZipCode: "CUSTOMER_ZIP_CODE";
+    readonly CustomerCity: "CUSTOMER_CITY";
+    readonly CustomerCountry: "CUSTOMER_COUNTRY";
+    readonly CustomerEmail: "CUSTOMER_EMAIL";
+    readonly ReferencedInvoice: "REFERENCED_INVOICE";
+    readonly DiscountReason: "DISCOUNT_REASON";
+    readonly SmallBusinessNote: "SMALL_BUSINESS_NOTE";
+};
+export type InvoiceValidationCheck = typeof InvoiceValidationCheck[keyof typeof InvoiceValidationCheck];
+export declare function instanceOfInvoiceValidationCheck(value: any): boolean;
+export declare function InvoiceValidationCheckFromJSON(json: any): InvoiceValidationCheck;
+export declare function InvoiceValidationCheckFromJSONTyped(json: any, ignoreDiscriminator: boolean): InvoiceValidationCheck;
+export declare function InvoiceValidationCheckToJSON(value?: InvoiceValidationCheck | null): any;
+export declare function InvoiceValidationCheckToJSONTyped(value: any, ignoreDiscriminator: boolean): InvoiceValidationCheck;

package/dist/models/InvoiceValidationCheck.js

@@ -0,0 +1,64 @@
+"use strict";
+/* tslint:disable */
+/* eslint-disable */
+/**
+ * Kommerz API Specification
+ * API specification for Kommerz Services.  - /ui/ for services consumed by the frontend - /intern/ for internal administration endpoints - /extern/ for services consumed by external services - /stats/ for monitoring endpoints - /actuator/ for health endpoints (e.g. /actuator/health )  All endpoints are postfixed with a version number.
+ *
+ * Contact: info@kommerz.app
+ *
+ * NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech).
+ * https://openapi-generator.tech
+ * Do not edit the class manually.
+ */
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.InvoiceValidationCheck = void 0;
+exports.instanceOfInvoiceValidationCheck = instanceOfInvoiceValidationCheck;
+exports.InvoiceValidationCheckFromJSON = InvoiceValidationCheckFromJSON;
+exports.InvoiceValidationCheckFromJSONTyped = InvoiceValidationCheckFromJSONTyped;
+exports.InvoiceValidationCheckToJSON = InvoiceValidationCheckToJSON;
+exports.InvoiceValidationCheckToJSONTyped = InvoiceValidationCheckToJSONTyped;
+/**
+ *
+ * @export
+ */
+exports.InvoiceValidationCheck = {
+    TenantName: 'TENANT_NAME',
+    TenantZipCode: 'TENANT_ZIP_CODE',
+    TenantCity: 'TENANT_CITY',
+    TenantCountry: 'TENANT_COUNTRY',
+    TenantTaxIdentifier: 'TENANT_TAX_IDENTIFIER',
+    TenantPhoneNumber: 'TENANT_PHONE_NUMBER',
+    TenantEmail: 'TENANT_EMAIL',
+    TenantIban: 'TENANT_IBAN',
+    CustomerName: 'CUSTOMER_NAME',
+    CustomerZipCode: 'CUSTOMER_ZIP_CODE',
+    CustomerCity: 'CUSTOMER_CITY',
+    CustomerCountry: 'CUSTOMER_COUNTRY',
+    CustomerEmail: 'CUSTOMER_EMAIL',
+    ReferencedInvoice: 'REFERENCED_INVOICE',
+    DiscountReason: 'DISCOUNT_REASON',
+    SmallBusinessNote: 'SMALL_BUSINESS_NOTE'
+};
+function instanceOfInvoiceValidationCheck(value) {
+    for (var key in exports.InvoiceValidationCheck) {
+        if (Object.prototype.hasOwnProperty.call(exports.InvoiceValidationCheck, key)) {
+            if (exports.InvoiceValidationCheck[key] === value) {
+                return true;
+            }
+        }
+    }
+    return false;
+}
+function InvoiceValidationCheckFromJSON(json) {
+    return InvoiceValidationCheckFromJSONTyped(json, false);
+}
+function InvoiceValidationCheckFromJSONTyped(json, ignoreDiscriminator) {
+    return json;
+}
+function InvoiceValidationCheckToJSON(value) {
+    return value;
+}
+function InvoiceValidationCheckToJSONTyped(value, ignoreDiscriminator) {
+    return value;
+}

package/dist/models/InvoiceValidationResult.d.ts

@@ -0,0 +1,32 @@
+/**
+ * Kommerz API Specification
+ * API specification for Kommerz Services.  - /ui/ for services consumed by the frontend - /intern/ for internal administration endpoints - /extern/ for services consumed by external services - /stats/ for monitoring endpoints - /actuator/ for health endpoints (e.g. /actuator/health )  All endpoints are postfixed with a version number.
+ *
+ * Contact: info@kommerz.app
+ *
+ * NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech).
+ * https://openapi-generator.tech
+ * Do not edit the class manually.
+ */
+import type { InvoiceValidationCheck } from './InvoiceValidationCheck';
+/**
+ *
+ * @export
+ * @interface InvoiceValidationResult
+ */
+export interface InvoiceValidationResult {
+    /**
+     *
+     * @type {Array<InvoiceValidationCheck>}
+     * @memberof InvoiceValidationResult
+     */
+    failedChecks?: Array<InvoiceValidationCheck>;
+}
+/**
+ * Check if a given object implements the InvoiceValidationResult interface.
+ */
+export declare function instanceOfInvoiceValidationResult(value: object): value is InvoiceValidationResult;
+export declare function InvoiceValidationResultFromJSON(json: any): InvoiceValidationResult;
+export declare function InvoiceValidationResultFromJSONTyped(json: any, ignoreDiscriminator: boolean): InvoiceValidationResult;
+export declare function InvoiceValidationResultToJSON(json: any): InvoiceValidationResult;
+export declare function InvoiceValidationResultToJSONTyped(value?: InvoiceValidationResult | null, ignoreDiscriminator?: boolean): any;

package/dist/models/InvoiceValidationResult.js

@@ -0,0 +1,49 @@
+"use strict";
+/* tslint:disable */
+/* eslint-disable */
+/**
+ * Kommerz API Specification
+ * API specification for Kommerz Services.  - /ui/ for services consumed by the frontend - /intern/ for internal administration endpoints - /extern/ for services consumed by external services - /stats/ for monitoring endpoints - /actuator/ for health endpoints (e.g. /actuator/health )  All endpoints are postfixed with a version number.
+ *
+ * Contact: info@kommerz.app
+ *
+ * NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech).
+ * https://openapi-generator.tech
+ * Do not edit the class manually.
+ */
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.instanceOfInvoiceValidationResult = instanceOfInvoiceValidationResult;
+exports.InvoiceValidationResultFromJSON = InvoiceValidationResultFromJSON;
+exports.InvoiceValidationResultFromJSONTyped = InvoiceValidationResultFromJSONTyped;
+exports.InvoiceValidationResultToJSON = InvoiceValidationResultToJSON;
+exports.InvoiceValidationResultToJSONTyped = InvoiceValidationResultToJSONTyped;
+var InvoiceValidationCheck_1 = require("./InvoiceValidationCheck");
+/**
+ * Check if a given object implements the InvoiceValidationResult interface.
+ */
+function instanceOfInvoiceValidationResult(value) {
+    return true;
+}
+function InvoiceValidationResultFromJSON(json) {
+    return InvoiceValidationResultFromJSONTyped(json, false);
+}
+function InvoiceValidationResultFromJSONTyped(json, ignoreDiscriminator) {
+    if (json == null) {
+        return json;
+    }
+    return {
+        'failedChecks': json['failedChecks'] == null ? undefined : (json['failedChecks'].map(InvoiceValidationCheck_1.InvoiceValidationCheckFromJSON)),
+    };
+}
+function InvoiceValidationResultToJSON(json) {
+    return InvoiceValidationResultToJSONTyped(json, false);
+}
+function InvoiceValidationResultToJSONTyped(value, ignoreDiscriminator) {
+    if (ignoreDiscriminator === void 0) { ignoreDiscriminator = false; }
+    if (value == null) {
+        return value;
+    }
+    return {
+        'failedChecks': value['failedChecks'] == null ? undefined : (value['failedChecks'].map(InvoiceValidationCheck_1.InvoiceValidationCheckToJSON)),
+    };
+}

package/dist/models/index.d.ts

@@ -188,6 +188,8 @@ export * from './InvoiceItemDto';
 export * from './InvoiceTaxItemDto';
 export * from './InvoiceTextFieldsDto';
 export * from './InvoiceType';
+export * from './InvoiceValidationCheck';
+export * from './InvoiceValidationResult';
 export * from './JobDto';
 export * from './KanbanBoardDto';
 export * from './KanbanCardDto';

package/dist/models/index.js

@@ -206,6 +206,8 @@ __exportStar(require("./InvoiceItemDto"), exports);
 __exportStar(require("./InvoiceTaxItemDto"), exports);
 __exportStar(require("./InvoiceTextFieldsDto"), exports);
 __exportStar(require("./InvoiceType"), exports);
+__exportStar(require("./InvoiceValidationCheck"), exports);
+__exportStar(require("./InvoiceValidationResult"), exports);
 __exportStar(require("./JobDto"), exports);
 __exportStar(require("./KanbanBoardDto"), exports);
 __exportStar(require("./KanbanCardDto"), exports);

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@kommerz/ts-client",
-  "version": "1.176.1",
+  "version": "1.177.0",
   "description": "Typescript client for Kommerz API",
   "author": "Kommerz.App",
   "license": "MIT",