@kommerz/ts-client 1.184.1 → 1.186.0

package/dist/apis/InvoicesApi.d.ts

@@ -9,50 +9,122 @@
  * Do not edit the class manually.
  */
 import * as runtime from '../runtime';
-import type { GetAllInvoices200Response, InvoiceDto, InvoicePortalShareConfigDto, InvoiceValidationResult, KommerzPageable, MarkInvoiceAsPaidRequest, ShareInvoiceDto } from '../models/index';
+import { type GetAllInvoices200Response } from '../models/GetAllInvoices200Response';
+import { type InvoiceDto } from '../models/InvoiceDto';
+import { type InvoicePortalShareConfigDto } from '../models/InvoicePortalShareConfigDto';
+import { type InvoiceValidationResult } from '../models/InvoiceValidationResult';
+import { type InvoiceWhatsAppMessageDto } from '../models/InvoiceWhatsAppMessageDto';
+import { type KommerzPageable } from '../models/KommerzPageable';
+import { type MarkInvoiceAsPaidRequest } from '../models/MarkInvoiceAsPaidRequest';
+import { type ShareInvoiceDto } from '../models/ShareInvoiceDto';
 export interface CreateInvoiceRequest {
-    invoiceDto: Omit<InvoiceDto, 'id' | 'version' | 'finalized' | 'dueDate' | 'invoiceDate' | 'invoiceNumber' | 'total' | 'paidTotal' | 'paidAt' | 'paidBy' | 'fileId'>;
+    /**
+     *
+     */
+    invoiceDto: Omit<InvoiceDto, 'id' | 'version' | 'finalized' | 'dueDate' | 'invoiceDate' | 'invoiceNumber' | 'total' | 'invoiceTaxItems' | 'paidTotal' | 'paidAt' | 'paidBy' | 'fileId' | 'secretId'>;
 }
 export interface DeleteInvoiceRequest {
+    /**
+     * id of entity
+     */
     id: string;
 }
 export interface DownloadInvoiceRequest {
+    /**
+     * id of entity
+     */
     id: string;
 }
 export interface DuplicateInvoiceRequest {
+    /**
+     * id of entity
+     */
     id: string;
 }
 export interface FinalizeInvoiceRequest {
+    /**
+     * id of entity
+     */
     id: string;
 }
 export interface GetAllInvoicesRequest {
+    /**
+     * Pageable query parameters
+     */
     pageable: KommerzPageable;
+    /**
+     * Filter query parameters. Operators: sim, nsim, eq, neq, leq, less, geq, gtr). Values have to be url-encoded.
+     */
     filter?: Array<string>;
 }
 export interface GetInvoiceRequest {
+    /**
+     * id of entity
+     */
     id: string;
 }
 export interface MarkInvoiceAsPaidOperationRequest {
+    /**
+     * id of entity
+     */
     id: string;
+    /**
+     *
+     */
     markInvoiceAsPaidRequest: MarkInvoiceAsPaidRequest;
+    /**
+     * whether to force update the entity
+     */
     force?: boolean;
 }
+export interface RenderInvoiceWhatsAppMessageRequest {
+    /**
+     * id of entity
+     */
+    id: string;
+    /**
+     *
+     */
+    invoiceWhatsAppMessageDto: Omit<InvoiceWhatsAppMessageDto, 'text'>;
+}
 export interface ShareInvoiceRequest {
+    /**
+     * id of entity
+     */
     id: string;
+    /**
+     *
+     */
     invoicePortalShareConfigDto: InvoicePortalShareConfigDto;
 }
 export interface UpdateInvoiceRequest {
+    /**
+     * id of entity
+     */
     id: string;
-    invoiceDto: Omit<InvoiceDto, 'id' | 'version' | 'finalized' | 'dueDate' | 'invoiceDate' | 'invoiceNumber' | 'total' | 'paidTotal' | 'paidAt' | 'paidBy' | 'fileId'>;
+    /**
+     *
+     */
+    invoiceDto: Omit<InvoiceDto, 'id' | 'version' | 'finalized' | 'dueDate' | 'invoiceDate' | 'invoiceNumber' | 'total' | 'invoiceTaxItems' | 'paidTotal' | 'paidAt' | 'paidBy' | 'fileId' | 'secretId'>;
+    /**
+     * whether to force update the entity
+     */
     force?: boolean;
 }
 export interface ValidateInvoiceRequest {
+    /**
+     * id of entity
+     */
     id: string;
 }
 /**
  *
  */
 export declare class InvoicesApi extends runtime.BaseAPI {
+    /**
+     * Creates request options for createInvoice without sending the request
+     */
+    createInvoiceRequestOpts(requestParameters: CreateInvoiceRequest): Promise<runtime.RequestOpts>;
     /**
      * Create a new invoice
      */
@@ -61,6 +133,10 @@ export declare class InvoicesApi extends runtime.BaseAPI {
      * Create a new invoice
      */
     createInvoice(requestParameters: CreateInvoiceRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<InvoiceDto>;
+    /**
+     * Creates request options for deleteInvoice without sending the request
+     */
+    deleteInvoiceRequestOpts(requestParameters: DeleteInvoiceRequest): Promise<runtime.RequestOpts>;
     /**
      * delete single invoice
      */
@@ -69,14 +145,22 @@ export declare class InvoicesApi extends runtime.BaseAPI {
      * delete single invoice
      */
     deleteInvoice(requestParameters: DeleteInvoiceRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<void>;
+    /**
+     * Creates request options for downloadInvoice without sending the request
+     */
+    downloadInvoiceRequestOpts(requestParameters: DownloadInvoiceRequest): Promise<runtime.RequestOpts>;
     /**
      * download final invoice or preview
      */
-    downloadInvoiceRaw(requestParameters: DownloadInvoiceRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<runtime.ApiResponse<Blob>>;
+    downloadInvoiceRaw(requestParameters: DownloadInvoiceRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<runtime.ApiResponse<runtime.HttpFile>>;
     /**
      * download final invoice or preview
      */
-    downloadInvoice(requestParameters: DownloadInvoiceRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<Blob>;
+    downloadInvoice(requestParameters: DownloadInvoiceRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<runtime.HttpFile>;
+    /**
+     * Creates request options for duplicateInvoice without sending the request
+     */
+    duplicateInvoiceRequestOpts(requestParameters: DuplicateInvoiceRequest): Promise<runtime.RequestOpts>;
     /**
      * get original invoice dto
      */
@@ -85,6 +169,10 @@ export declare class InvoicesApi extends runtime.BaseAPI {
      * get original invoice dto
      */
     duplicateInvoice(requestParameters: DuplicateInvoiceRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<InvoiceDto>;
+    /**
+     * Creates request options for finalizeInvoice without sending the request
+     */
+    finalizeInvoiceRequestOpts(requestParameters: FinalizeInvoiceRequest): Promise<runtime.RequestOpts>;
     /**
      * finalize invoice
      */
@@ -93,6 +181,10 @@ export declare class InvoicesApi extends runtime.BaseAPI {
      * finalize invoice
      */
     finalizeInvoice(requestParameters: FinalizeInvoiceRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<InvoiceDto>;
+    /**
+     * Creates request options for getAllInvoices without sending the request
+     */
+    getAllInvoicesRequestOpts(requestParameters: GetAllInvoicesRequest): Promise<runtime.RequestOpts>;
     /**
      * get all invoices
      */
@@ -101,6 +193,10 @@ export declare class InvoicesApi extends runtime.BaseAPI {
      * get all invoices
      */
     getAllInvoices(requestParameters: GetAllInvoicesRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<GetAllInvoices200Response>;
+    /**
+     * Creates request options for getInvoice without sending the request
+     */
+    getInvoiceRequestOpts(requestParameters: GetInvoiceRequest): Promise<runtime.RequestOpts>;
     /**
      * read one invoice
      */
@@ -109,6 +205,10 @@ export declare class InvoicesApi extends runtime.BaseAPI {
      * read one invoice
      */
     getInvoice(requestParameters: GetInvoiceRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<InvoiceDto>;
+    /**
+     * Creates request options for markInvoiceAsPaid without sending the request
+     */
+    markInvoiceAsPaidRequestOpts(requestParameters: MarkInvoiceAsPaidOperationRequest): Promise<runtime.RequestOpts>;
     /**
      * mark Invoice as paid
      */
@@ -117,6 +217,24 @@ export declare class InvoicesApi extends runtime.BaseAPI {
      * mark Invoice as paid
      */
     markInvoiceAsPaid(requestParameters: MarkInvoiceAsPaidOperationRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<InvoiceDto>;
+    /**
+     * Creates request options for renderInvoiceWhatsAppMessage without sending the request
+     */
+    renderInvoiceWhatsAppMessageRequestOpts(requestParameters: RenderInvoiceWhatsAppMessageRequest): Promise<runtime.RequestOpts>;
+    /**
+     * Resolves the placeholders of the message template, e.g. the link to the invoice portal, and returns the plain text to be sent via WhatsApp.
+     * render the WhatsApp message for a finalized invoice
+     */
+    renderInvoiceWhatsAppMessageRaw(requestParameters: RenderInvoiceWhatsAppMessageRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<runtime.ApiResponse<InvoiceWhatsAppMessageDto>>;
+    /**
+     * Resolves the placeholders of the message template, e.g. the link to the invoice portal, and returns the plain text to be sent via WhatsApp.
+     * render the WhatsApp message for a finalized invoice
+     */
+    renderInvoiceWhatsAppMessage(requestParameters: RenderInvoiceWhatsAppMessageRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<InvoiceWhatsAppMessageDto>;
+    /**
+     * Creates request options for shareInvoice without sending the request
+     */
+    shareInvoiceRequestOpts(requestParameters: ShareInvoiceRequest): Promise<runtime.RequestOpts>;
     /**
      * send invoice via email
      */
@@ -125,6 +243,10 @@ export declare class InvoicesApi extends runtime.BaseAPI {
      * send invoice via email
      */
     shareInvoice(requestParameters: ShareInvoiceRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<ShareInvoiceDto>;
+    /**
+     * Creates request options for updateInvoice without sending the request
+     */
+    updateInvoiceRequestOpts(requestParameters: UpdateInvoiceRequest): Promise<runtime.RequestOpts>;
     /**
      * Update an invoice
      */
@@ -133,6 +255,10 @@ export declare class InvoicesApi extends runtime.BaseAPI {
      * Update an invoice
      */
     updateInvoice(requestParameters: UpdateInvoiceRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<InvoiceDto>;
+    /**
+     * Creates request options for validateInvoice without sending the request
+     */
+    validateInvoiceRequestOpts(requestParameters: ValidateInvoiceRequest): Promise<runtime.RequestOpts>;
     /**
      * validate invoice
      */