@payabli/sdk-node 0.0.116 → 0.0.117

package/dist/esm/api/resources/bill/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 Bill {
+export declare namespace BillClient {
     interface Options extends BaseClientOptions {
     }
     interface RequestOptions extends BaseRequestOptions {
     }
 }
-export declare class Bill {
-    protected readonly _options: Bill.Options;
-    constructor(_options?: Bill.Options);
+export declare class BillClient {
+    protected readonly _options: NormalizedClientOptionsWithAuth<BillClient.Options>;
+    constructor(options?: BillClient.Options);
     /**
      * Creates a bill in an entrypoint.
      *
      * @param {string} entry - The paypoint's entrypoint identifier. [Learn more](/api-reference/api-overview#entrypoint-vs-entry)
      * @param {Payabli.AddBillRequest} request
-     * @param {Bill.RequestOptions} requestOptions - Request-specific configuration.
+     * @param {BillClient.RequestOptions} requestOptions - Request-specific configuration.
      *
      * @throws {@link Payabli.BadRequestError}
      * @throws {@link Payabli.UnauthorizedError}
@@ -61,11 +62,12 @@ export declare class Bill {
      *         }
      *     })
      */
-    addBill(entry: string, request: Payabli.AddBillRequest, requestOptions?: Bill.RequestOptions): core.HttpResponsePromise<Payabli.BillResponse>;
+    addBill(entry: string, request: Payabli.AddBillRequest, requestOptions?: BillClient.RequestOptions): core.HttpResponsePromise<Payabli.BillResponse>;
     private __addBill;
     /**
      * Delete a file attached to a bill.
      *
+     * @param {number} idBill - Payabli ID for the bill. Get this ID by querying `/api/Query/bills/` for the entrypoint or the organization.
      * @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`.
@@ -82,9 +84,8 @@ export declare class Bill {
      *                                ]
      *                              }
      *                              ```
-     * @param {number} idBill - Payabli ID for the bill. Get this ID by querying `/api/Query/bills/` for the entrypoint or the organization.
      * @param {Payabli.DeleteAttachedFromBillRequest} request
-     * @param {Bill.RequestOptions} requestOptions - Request-specific configuration.
+     * @param {BillClient.RequestOptions} requestOptions - Request-specific configuration.
      *
      * @throws {@link Payabli.BadRequestError}
      * @throws {@link Payabli.UnauthorizedError}
@@ -92,15 +93,15 @@ export declare class Bill {
      * @throws {@link Payabli.ServiceUnavailableError}
      *
      * @example
-     *     await client.bill.deleteAttachedFromBill("0_Bill.pdf", 285)
+     *     await client.bill.deleteAttachedFromBill(285, "0_Bill.pdf")
      */
-    deleteAttachedFromBill(filename: string, idBill: number, request?: Payabli.DeleteAttachedFromBillRequest, requestOptions?: Bill.RequestOptions): core.HttpResponsePromise<Payabli.BillResponse>;
+    deleteAttachedFromBill(idBill: number, filename: string, request?: Payabli.DeleteAttachedFromBillRequest, requestOptions?: BillClient.RequestOptions): core.HttpResponsePromise<Payabli.BillResponse>;
     private __deleteAttachedFromBill;
     /**
      * Deletes a bill by ID.
      *
      * @param {number} idBill - Payabli ID for the bill. Get this ID by querying `/api/Query/bills/` for the entrypoint or the organization.
-     * @param {Bill.RequestOptions} requestOptions - Request-specific configuration.
+     * @param {BillClient.RequestOptions} requestOptions - Request-specific configuration.
      *
      * @throws {@link Payabli.BadRequestError}
      * @throws {@link Payabli.UnauthorizedError}
@@ -110,14 +111,14 @@ export declare class Bill {
      * @example
      *     await client.bill.deleteBill(285)
      */
-    deleteBill(idBill: number, requestOptions?: Bill.RequestOptions): core.HttpResponsePromise<Payabli.BillResponse>;
+    deleteBill(idBill: number, requestOptions?: BillClient.RequestOptions): core.HttpResponsePromise<Payabli.BillResponse>;
     private __deleteBill;
     /**
      * Updates a bill by ID.
      *
      * @param {number} idBill - Payabli ID for the bill. Get this ID by querying `/api/Query/bills/` for the entrypoint or the organization.
      * @param {Payabli.BillOutData} request
-     * @param {Bill.RequestOptions} requestOptions - Request-specific configuration.
+     * @param {BillClient.RequestOptions} requestOptions - Request-specific configuration.
      *
      * @throws {@link Payabli.BadRequestError}
      * @throws {@link Payabli.UnauthorizedError}
@@ -130,11 +131,12 @@ export declare class Bill {
      *         billDate: "2025-07-01"
      *     })
      */
-    editBill(idBill: number, request: Payabli.BillOutData, requestOptions?: Bill.RequestOptions): core.HttpResponsePromise<Payabli.EditBillResponse>;
+    editBill(idBill: number, request: Payabli.BillOutData, requestOptions?: BillClient.RequestOptions): core.HttpResponsePromise<Payabli.EditBillResponse>;
     private __editBill;
     /**
      * Retrieves a file attached to a bill, either as a binary file or as a Base64-encoded string.
      *
+     * @param {number} idBill - Payabli ID for the bill. Get this ID by querying `/api/Query/bills/` for the entrypoint or the organization.
      * @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",
@@ -146,9 +148,8 @@ export declare class Bill {
      *                                }
      *                              ]
      *                            }
-     * @param {number} idBill - Payabli ID for the bill. Get this ID by querying `/api/Query/bills/` for the entrypoint or the organization.
      * @param {Payabli.GetAttachedFromBillRequest} request
-     * @param {Bill.RequestOptions} requestOptions - Request-specific configuration.
+     * @param {BillClient.RequestOptions} requestOptions - Request-specific configuration.
      *
      * @throws {@link Payabli.BadRequestError}
      * @throws {@link Payabli.UnauthorizedError}
@@ -156,17 +157,17 @@ export declare class Bill {
      * @throws {@link Payabli.ServiceUnavailableError}
      *
      * @example
-     *     await client.bill.getAttachedFromBill("0_Bill.pdf", 285, {
+     *     await client.bill.getAttachedFromBill(285, "0_Bill.pdf", {
      *         returnObject: true
      *     })
      */
-    getAttachedFromBill(filename: string, idBill: number, request?: Payabli.GetAttachedFromBillRequest, requestOptions?: Bill.RequestOptions): core.HttpResponsePromise<Payabli.FileContent>;
+    getAttachedFromBill(idBill: number, filename: string, request?: Payabli.GetAttachedFromBillRequest, requestOptions?: BillClient.RequestOptions): core.HttpResponsePromise<Payabli.FileContent>;
     private __getAttachedFromBill;
     /**
      * Retrieves a bill by ID from an entrypoint.
      *
      * @param {number} idBill - Payabli ID for the bill. Get this ID by querying `/api/Query/bills/` for the entrypoint or the organization.
-     * @param {Bill.RequestOptions} requestOptions - Request-specific configuration.
+     * @param {BillClient.RequestOptions} requestOptions - Request-specific configuration.
      *
      * @throws {@link Payabli.BadRequestError}
      * @throws {@link Payabli.UnauthorizedError}
@@ -176,14 +177,14 @@ export declare class Bill {
      * @example
      *     await client.bill.getBill(285)
      */
-    getBill(idBill: number, requestOptions?: Bill.RequestOptions): core.HttpResponsePromise<Payabli.GetBillResponse>;
+    getBill(idBill: number, requestOptions?: BillClient.RequestOptions): core.HttpResponsePromise<Payabli.GetBillResponse>;
     private __getBill;
     /**
      * Retrieve a list of bills 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.ListBillsRequest} request
-     * @param {Bill.RequestOptions} requestOptions - Request-specific configuration.
+     * @param {BillClient.RequestOptions} requestOptions - Request-specific configuration.
      *
      * @throws {@link Payabli.BadRequestError}
      * @throws {@link Payabli.UnauthorizedError}
@@ -197,14 +198,14 @@ export declare class Bill {
      *         sortBy: "desc(field_name)"
      *     })
      */
-    listBills(entry: string, request?: Payabli.ListBillsRequest, requestOptions?: Bill.RequestOptions): core.HttpResponsePromise<Payabli.BillQueryResponse>;
+    listBills(entry: string, request?: Payabli.ListBillsRequest, requestOptions?: BillClient.RequestOptions): core.HttpResponsePromise<Payabli.BillQueryResponse>;
     private __listBills;
     /**
      * Retrieve a list of bills for an organization. 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.ListBillsOrgRequest} request
-     * @param {Bill.RequestOptions} requestOptions - Request-specific configuration.
+     * @param {BillClient.RequestOptions} requestOptions - Request-specific configuration.
      *
      * @throws {@link Payabli.BadRequestError}
      * @throws {@link Payabli.UnauthorizedError}
@@ -218,14 +219,14 @@ export declare class Bill {
      *         sortBy: "desc(field_name)"
      *     })
      */
-    listBillsOrg(orgId: number, request?: Payabli.ListBillsOrgRequest, requestOptions?: Bill.RequestOptions): core.HttpResponsePromise<Payabli.BillQueryResponse>;
+    listBillsOrg(orgId: number, request?: Payabli.ListBillsOrgRequest, requestOptions?: BillClient.RequestOptions): core.HttpResponsePromise<Payabli.BillQueryResponse>;
     private __listBillsOrg;
     /**
      * Modify the list of users the bill is sent to for approval.
      *
      * @param {number} idBill - Payabli ID for the bill. Get this ID by querying `/api/Query/bills/` for the entrypoint or the organization.
      * @param {string[]} request
-     * @param {Bill.RequestOptions} requestOptions - Request-specific configuration.
+     * @param {BillClient.RequestOptions} requestOptions - Request-specific configuration.
      *
      * @throws {@link Payabli.BadRequestError}
      * @throws {@link Payabli.UnauthorizedError}
@@ -235,14 +236,14 @@ export declare class Bill {
      * @example
      *     await client.bill.modifyApprovalBill(285, ["string"])
      */
-    modifyApprovalBill(idBill: number, request: string[], requestOptions?: Bill.RequestOptions): core.HttpResponsePromise<Payabli.ModifyApprovalBillResponse>;
+    modifyApprovalBill(idBill: number, request: string[], requestOptions?: BillClient.RequestOptions): core.HttpResponsePromise<Payabli.ModifyApprovalBillResponse>;
     private __modifyApprovalBill;
     /**
      * Send a bill to a user or list of users to approve.
      *
      * @param {number} idBill - Payabli ID for the bill. Get this ID by querying `/api/Query/bills/` for the entrypoint or the organization.
      * @param {Payabli.SendToApprovalBillRequest} request
-     * @param {Bill.RequestOptions} requestOptions - Request-specific configuration.
+     * @param {BillClient.RequestOptions} requestOptions - Request-specific configuration.
      *
      * @throws {@link Payabli.BadRequestError}
      * @throws {@link Payabli.UnauthorizedError}
@@ -255,15 +256,15 @@ export declare class Bill {
      *         body: ["string"]
      *     })
      */
-    sendToApprovalBill(idBill: number, request: Payabli.SendToApprovalBillRequest, requestOptions?: Bill.RequestOptions): core.HttpResponsePromise<Payabli.BillResponse>;
+    sendToApprovalBill(idBill: number, request: Payabli.SendToApprovalBillRequest, requestOptions?: BillClient.RequestOptions): core.HttpResponsePromise<Payabli.BillResponse>;
     private __sendToApprovalBill;
     /**
      * Approve or disapprove a bill by ID.
      *
-     * @param {string} approved - String representing the approved status. Accepted values: 'true' or 'false'.
      * @param {number} idBill - Payabli ID for the bill. Get this ID by querying `/api/Query/bills/` for the entrypoint or the organization.
+     * @param {string} approved - String representing the approved status. Accepted values: 'true' or 'false'.
      * @param {Payabli.SetApprovedBillRequest} request
-     * @param {Bill.RequestOptions} requestOptions - Request-specific configuration.
+     * @param {BillClient.RequestOptions} requestOptions - Request-specific configuration.
      *
      * @throws {@link Payabli.BadRequestError}
      * @throws {@link Payabli.UnauthorizedError}
@@ -271,9 +272,8 @@ export declare class Bill {
      * @throws {@link Payabli.ServiceUnavailableError}
      *
      * @example
-     *     await client.bill.setApprovedBill("true", 285)
+     *     await client.bill.setApprovedBill(285, "true")
      */
-    setApprovedBill(approved: string, idBill: number, request?: Payabli.SetApprovedBillRequest, requestOptions?: Bill.RequestOptions): core.HttpResponsePromise<Payabli.SetApprovedBillResponse>;
+    setApprovedBill(idBill: number, approved: string, request?: Payabli.SetApprovedBillRequest, requestOptions?: BillClient.RequestOptions): core.HttpResponsePromise<Payabli.SetApprovedBillResponse>;
     private __setApprovedBill;
-    protected _getCustomAuthorizationHeaders(): Promise<Record<string, string | undefined>>;
 }