@payabli/sdk-node 0.0.116 → 0.0.117

package/dist/esm/api/resources/invoice/client/Client.d.mts

@@ -1,21 +1,22 @@
 import type { BaseClientOptions, BaseRequestOptions } from "../../../../BaseClient.mjs";
+import { type NormalizedClientOptionsWithAuth } from "../../../../BaseClient.mjs";
 import * as core from "../../../../core/index.mjs";
 import * as Payabli from "../../../index.mjs";
-export declare namespace Invoice {
+export declare namespace InvoiceClient {
     interface Options extends BaseClientOptions {
     }
     interface RequestOptions extends BaseRequestOptions {
     }
 }
-export declare class Invoice {
-    protected readonly _options: Invoice.Options;
-    constructor(_options?: Invoice.Options);
+export declare class InvoiceClient {
+    protected readonly _options: NormalizedClientOptionsWithAuth<InvoiceClient.Options>;
+    constructor(options?: InvoiceClient.Options);
     /**
      * Creates an invoice in an entrypoint.
      *
      * @param {string} entry - The paypoint's entrypoint identifier. [Learn more](/api-reference/api-overview#entrypoint-vs-entry)
      * @param {Payabli.AddInvoiceRequest} request
-     * @param {Invoice.RequestOptions} requestOptions - Request-specific configuration.
+     * @param {InvoiceClient.RequestOptions} requestOptions - Request-specific configuration.
      *
      * @throws {@link Payabli.BadRequestError}
      * @throws {@link Payabli.UnauthorizedError}
@@ -54,11 +55,12 @@ export declare class Invoice {
      *         }
      *     })
      */
-    addInvoice(entry: string, request: Payabli.AddInvoiceRequest, requestOptions?: Invoice.RequestOptions): core.HttpResponsePromise<Payabli.InvoiceResponseWithoutData>;
+    addInvoice(entry: string, request: Payabli.AddInvoiceRequest, requestOptions?: InvoiceClient.RequestOptions): core.HttpResponsePromise<Payabli.InvoiceResponseWithoutData>;
     private __addInvoice;
     /**
      * Deletes an invoice that's attached to a file.
      *
+     * @param {number} idInvoice - Invoice ID
      * @param {string} filename - The filename in Payabli. Filename is `zipName` in response to a request to `/api/Invoice/{idInvoice}`. Here, the filename is `0_Bill.pdf``.
      *                            "DocumentsRef": {
      *                              "zipfile": "inva_269.zip",
@@ -70,8 +72,7 @@ export declare class Invoice {
      *                                }
      *                              ]
      *                            }
-     * @param {number} idInvoice - Invoice ID
-     * @param {Invoice.RequestOptions} requestOptions - Request-specific configuration.
+     * @param {InvoiceClient.RequestOptions} requestOptions - Request-specific configuration.
      *
      * @throws {@link Payabli.BadRequestError}
      * @throws {@link Payabli.UnauthorizedError}
@@ -79,15 +80,15 @@ export declare class Invoice {
      * @throws {@link Payabli.ServiceUnavailableError}
      *
      * @example
-     *     await client.invoice.deleteAttachedFromInvoice("0_Bill.pdf", 23548884)
+     *     await client.invoice.deleteAttachedFromInvoice(23548884, "0_Bill.pdf")
      */
-    deleteAttachedFromInvoice(filename: string, idInvoice: number, requestOptions?: Invoice.RequestOptions): core.HttpResponsePromise<Payabli.InvoiceResponseWithoutData>;
+    deleteAttachedFromInvoice(idInvoice: number, filename: string, requestOptions?: InvoiceClient.RequestOptions): core.HttpResponsePromise<Payabli.InvoiceResponseWithoutData>;
     private __deleteAttachedFromInvoice;
     /**
      * Deletes a single invoice from an entrypoint.
      *
      * @param {number} idInvoice - Invoice ID
-     * @param {Invoice.RequestOptions} requestOptions - Request-specific configuration.
+     * @param {InvoiceClient.RequestOptions} requestOptions - Request-specific configuration.
      *
      * @throws {@link Payabli.BadRequestError}
      * @throws {@link Payabli.UnauthorizedError}
@@ -97,14 +98,14 @@ export declare class Invoice {
      * @example
      *     await client.invoice.deleteInvoice(23548884)
      */
-    deleteInvoice(idInvoice: number, requestOptions?: Invoice.RequestOptions): core.HttpResponsePromise<Payabli.InvoiceResponseWithoutData>;
+    deleteInvoice(idInvoice: number, requestOptions?: InvoiceClient.RequestOptions): core.HttpResponsePromise<Payabli.InvoiceResponseWithoutData>;
     private __deleteInvoice;
     /**
      * Updates details for a single invoice in an entrypoint.
      *
      * @param {number} idInvoice - Invoice ID
      * @param {Payabli.EditInvoiceRequest} request
-     * @param {Invoice.RequestOptions} requestOptions - Request-specific configuration.
+     * @param {InvoiceClient.RequestOptions} requestOptions - Request-specific configuration.
      *
      * @throws {@link Payabli.BadRequestError}
      * @throws {@link Payabli.UnauthorizedError}
@@ -128,11 +129,12 @@ export declare class Invoice {
      *         }
      *     })
      */
-    editInvoice(idInvoice: number, request: Payabli.EditInvoiceRequest, requestOptions?: Invoice.RequestOptions): core.HttpResponsePromise<Payabli.InvoiceResponseWithoutData>;
+    editInvoice(idInvoice: number, request: Payabli.EditInvoiceRequest, requestOptions?: InvoiceClient.RequestOptions): core.HttpResponsePromise<Payabli.InvoiceResponseWithoutData>;
     private __editInvoice;
     /**
      * Retrieves a file attached to an invoice.
      *
+     * @param {number} idInvoice - Invoice ID
      * @param {string} filename - The filename in Payabli. Filename is `zipName` in the response to a request to `/api/Invoice/{idInvoice}`. Here, the filename is `0_Bill.pdf``.
      *                            ```
      *                              "DocumentsRef": {
@@ -146,9 +148,8 @@ export declare class Invoice {
      *                                ]
      *                              }
      *                              ```
-     * @param {number} idInvoice - Invoice ID
      * @param {Payabli.GetAttachedFileFromInvoiceRequest} request
-     * @param {Invoice.RequestOptions} requestOptions - Request-specific configuration.
+     * @param {InvoiceClient.RequestOptions} requestOptions - Request-specific configuration.
      *
      * @throws {@link Payabli.BadRequestError}
      * @throws {@link Payabli.UnauthorizedError}
@@ -156,15 +157,15 @@ export declare class Invoice {
      * @throws {@link Payabli.ServiceUnavailableError}
      *
      * @example
-     *     await client.invoice.getAttachedFileFromInvoice("filename", 1)
+     *     await client.invoice.getAttachedFileFromInvoice(1, "filename")
      */
-    getAttachedFileFromInvoice(filename: string, idInvoice: number, request?: Payabli.GetAttachedFileFromInvoiceRequest, requestOptions?: Invoice.RequestOptions): core.HttpResponsePromise<Payabli.FileContent>;
+    getAttachedFileFromInvoice(idInvoice: number, filename: string, request?: Payabli.GetAttachedFileFromInvoiceRequest, requestOptions?: InvoiceClient.RequestOptions): core.HttpResponsePromise<Payabli.FileContent>;
     private __getAttachedFileFromInvoice;
     /**
      * Retrieves a single invoice by ID.
      *
      * @param {number} idInvoice - Invoice ID
-     * @param {Invoice.RequestOptions} requestOptions - Request-specific configuration.
+     * @param {InvoiceClient.RequestOptions} requestOptions - Request-specific configuration.
      *
      * @throws {@link Payabli.BadRequestError}
      * @throws {@link Payabli.UnauthorizedError}
@@ -174,13 +175,13 @@ export declare class Invoice {
      * @example
      *     await client.invoice.getInvoice(23548884)
      */
-    getInvoice(idInvoice: number, requestOptions?: Invoice.RequestOptions): core.HttpResponsePromise<Payabli.GetInvoiceRecord>;
+    getInvoice(idInvoice: number, requestOptions?: InvoiceClient.RequestOptions): core.HttpResponsePromise<Payabli.GetInvoiceRecord>;
     private __getInvoice;
     /**
      * Retrieves the next available invoice number for a paypoint.
      *
      * @param {string} entry - The paypoint's entrypoint identifier. [Learn more](/api-reference/api-overview#entrypoint-vs-entry)
-     * @param {Invoice.RequestOptions} requestOptions - Request-specific configuration.
+     * @param {InvoiceClient.RequestOptions} requestOptions - Request-specific configuration.
      *
      * @throws {@link Payabli.BadRequestError}
      * @throws {@link Payabli.UnauthorizedError}
@@ -190,14 +191,14 @@ export declare class Invoice {
      * @example
      *     await client.invoice.getInvoiceNumber("8cfec329267")
      */
-    getInvoiceNumber(entry: string, requestOptions?: Invoice.RequestOptions): core.HttpResponsePromise<Payabli.InvoiceNumberResponse>;
+    getInvoiceNumber(entry: string, requestOptions?: InvoiceClient.RequestOptions): core.HttpResponsePromise<Payabli.InvoiceNumberResponse>;
     private __getInvoiceNumber;
     /**
      * Returns a list of invoices for an entrypoint. Use filters to limit results. Include the `exportFormat` query parameter to return the results as a file instead of a JSON response.
      *
      * @param {string} entry - The paypoint's entrypoint identifier. [Learn more](/api-reference/api-overview#entrypoint-vs-entry)
      * @param {Payabli.ListInvoicesRequest} request
-     * @param {Invoice.RequestOptions} requestOptions - Request-specific configuration.
+     * @param {InvoiceClient.RequestOptions} requestOptions - Request-specific configuration.
      *
      * @throws {@link Payabli.BadRequestError}
      * @throws {@link Payabli.UnauthorizedError}
@@ -211,14 +212,14 @@ export declare class Invoice {
      *         sortBy: "desc(field_name)"
      *     })
      */
-    listInvoices(entry: string, request?: Payabli.ListInvoicesRequest, requestOptions?: Invoice.RequestOptions): core.HttpResponsePromise<Payabli.QueryInvoiceResponse>;
+    listInvoices(entry: string, request?: Payabli.ListInvoicesRequest, requestOptions?: InvoiceClient.RequestOptions): core.HttpResponsePromise<Payabli.QueryInvoiceResponse>;
     private __listInvoices;
     /**
      * Returns a list of invoices for an org. Use filters to limit results. Include the `exportFormat` query parameter to return the results as a file instead of a JSON response.
      *
      * @param {number} orgId - The numeric identifier for organization, assigned by Payabli.
      * @param {Payabli.ListInvoicesOrgRequest} request
-     * @param {Invoice.RequestOptions} requestOptions - Request-specific configuration.
+     * @param {InvoiceClient.RequestOptions} requestOptions - Request-specific configuration.
      *
      * @throws {@link Payabli.BadRequestError}
      * @throws {@link Payabli.UnauthorizedError}
@@ -232,14 +233,14 @@ export declare class Invoice {
      *         sortBy: "desc(field_name)"
      *     })
      */
-    listInvoicesOrg(orgId: number, request?: Payabli.ListInvoicesOrgRequest, requestOptions?: Invoice.RequestOptions): core.HttpResponsePromise<Payabli.QueryInvoiceResponse>;
+    listInvoicesOrg(orgId: number, request?: Payabli.ListInvoicesOrgRequest, requestOptions?: InvoiceClient.RequestOptions): core.HttpResponsePromise<Payabli.QueryInvoiceResponse>;
     private __listInvoicesOrg;
     /**
      * Sends an invoice from an entrypoint via email.
      *
      * @param {number} idInvoice - Invoice ID
      * @param {Payabli.SendInvoiceRequest} request
-     * @param {Invoice.RequestOptions} requestOptions - Request-specific configuration.
+     * @param {InvoiceClient.RequestOptions} requestOptions - Request-specific configuration.
      *
      * @throws {@link Payabli.BadRequestError}
      * @throws {@link Payabli.UnauthorizedError}
@@ -252,13 +253,13 @@ export declare class Invoice {
      *         mail2: "tamara@example.com"
      *     })
      */
-    sendInvoice(idInvoice: number, request?: Payabli.SendInvoiceRequest, requestOptions?: Invoice.RequestOptions): core.HttpResponsePromise<Payabli.SendInvoiceResponse>;
+    sendInvoice(idInvoice: number, request?: Payabli.SendInvoiceRequest, requestOptions?: InvoiceClient.RequestOptions): core.HttpResponsePromise<Payabli.SendInvoiceResponse>;
     private __sendInvoice;
     /**
      * Export a single invoice in PDF format.
      *
      * @param {number} idInvoice - Invoice ID
-     * @param {Invoice.RequestOptions} requestOptions - Request-specific configuration.
+     * @param {InvoiceClient.RequestOptions} requestOptions - Request-specific configuration.
      *
      * @throws {@link Payabli.BadRequestError}
      * @throws {@link Payabli.UnauthorizedError}
@@ -268,7 +269,6 @@ export declare class Invoice {
      * @example
      *     await client.invoice.getInvoicePdf(23548884)
      */
-    getInvoicePdf(idInvoice: number, requestOptions?: Invoice.RequestOptions): core.HttpResponsePromise<Payabli.File_>;
+    getInvoicePdf(idInvoice: number, requestOptions?: InvoiceClient.RequestOptions): core.HttpResponsePromise<Payabli.File_>;
     private __getInvoicePdf;
-    protected _getCustomAuthorizationHeaders(): Promise<Record<string, string | undefined>>;
 }