@payabli/sdk-node 0.0.116 → 0.0.117

package/dist/cjs/api/resources/boarding/client/Client.d.ts

@@ -1,20 +1,21 @@
 import type { BaseClientOptions, BaseRequestOptions } from "../../../../BaseClient.js";
+import { type NormalizedClientOptionsWithAuth } from "../../../../BaseClient.js";
 import * as core from "../../../../core/index.js";
 import * as Payabli from "../../../index.js";
-export declare namespace Boarding {
+export declare namespace BoardingClient {
     interface Options extends BaseClientOptions {
     }
     interface RequestOptions extends BaseRequestOptions {
     }
 }
-export declare class Boarding {
-    protected readonly _options: Boarding.Options;
-    constructor(_options?: Boarding.Options);
+export declare class BoardingClient {
+    protected readonly _options: NormalizedClientOptionsWithAuth<BoardingClient.Options>;
+    constructor(options?: BoardingClient.Options);
     /**
      * Creates a boarding application in an organization. This endpoint requires an application API token.
      *
      * @param {Payabli.AddApplicationRequest} request
-     * @param {Boarding.RequestOptions} requestOptions - Request-specific configuration.
+     * @param {BoardingClient.RequestOptions} requestOptions - Request-specific configuration.
      *
      * @throws {@link Payabli.BadRequestError}
      * @throws {@link Payabli.UnauthorizedError}
@@ -496,13 +497,13 @@ export declare class Boarding {
      *         website: "www.hermanscoatings.com"
      *     })
      */
-    addApplication(request: Payabli.AddApplicationRequest, requestOptions?: Boarding.RequestOptions): core.HttpResponsePromise<Payabli.PayabliApiResponse00Responsedatanonobject>;
+    addApplication(request: Payabli.AddApplicationRequest, requestOptions?: BoardingClient.RequestOptions): core.HttpResponsePromise<Payabli.PayabliApiResponse00Responsedatanonobject>;
     private __addApplication;
     /**
      * Deletes a boarding application by ID.
      *
      * @param {number} appId - Boarding application ID.
-     * @param {Boarding.RequestOptions} requestOptions - Request-specific configuration.
+     * @param {BoardingClient.RequestOptions} requestOptions - Request-specific configuration.
      *
      * @throws {@link Payabli.BadRequestError}
      * @throws {@link Payabli.UnauthorizedError}
@@ -512,13 +513,13 @@ export declare class Boarding {
      * @example
      *     await client.boarding.deleteApplication(352)
      */
-    deleteApplication(appId: number, requestOptions?: Boarding.RequestOptions): core.HttpResponsePromise<Payabli.PayabliApiResponse00Responsedatanonobject>;
+    deleteApplication(appId: number, requestOptions?: BoardingClient.RequestOptions): core.HttpResponsePromise<Payabli.PayabliApiResponse00Responsedatanonobject>;
     private __deleteApplication;
     /**
      * Retrieves the details for a boarding application by ID.
      *
      * @param {number} appId - Boarding application ID.
-     * @param {Boarding.RequestOptions} requestOptions - Request-specific configuration.
+     * @param {BoardingClient.RequestOptions} requestOptions - Request-specific configuration.
      *
      * @throws {@link Payabli.BadRequestError}
      * @throws {@link Payabli.UnauthorizedError}
@@ -528,14 +529,14 @@ export declare class Boarding {
      * @example
      *     await client.boarding.getApplication(352)
      */
-    getApplication(appId: number, requestOptions?: Boarding.RequestOptions): core.HttpResponsePromise<Payabli.ApplicationDetailsRecord>;
+    getApplication(appId: number, requestOptions?: BoardingClient.RequestOptions): core.HttpResponsePromise<Payabli.ApplicationDetailsRecord>;
     private __getApplication;
     /**
      * Gets a boarding application by authentication information. This endpoint requires an `application` API token.
      *
      * @param {string} xId - The application ID in Hex format. Find this at the end of the boarding link URL returned in a call to api/Boarding/applink/{appId}/{mail2}. For example in:  `https://boarding-sandbox.payabli.com/boarding/externalapp/load/17E`, the xId is `17E`.
      * @param {Payabli.RequestAppByAuth} request
-     * @param {Boarding.RequestOptions} requestOptions - Request-specific configuration.
+     * @param {BoardingClient.RequestOptions} requestOptions - Request-specific configuration.
      *
      * @throws {@link Payabli.BadRequestError}
      * @throws {@link Payabli.UnauthorizedError}
@@ -548,13 +549,13 @@ export declare class Boarding {
      *         referenceId: "n6UCd1f1ygG7"
      *     })
      */
-    getApplicationByAuth(xId: string, request?: Payabli.RequestAppByAuth, requestOptions?: Boarding.RequestOptions): core.HttpResponsePromise<Payabli.ApplicationQueryRecord>;
+    getApplicationByAuth(xId: string, request?: Payabli.RequestAppByAuth, requestOptions?: BoardingClient.RequestOptions): core.HttpResponsePromise<Payabli.ApplicationQueryRecord>;
     private __getApplicationByAuth;
     /**
      * Retrieves details for a boarding link, by ID.
      *
      * @param {number} boardingLinkId - The boarding link ID. You can find this at the end of the boarding link reference name. For example `https://boarding.payabli.com/boarding/app/myorgaccountname-00091`. The ID is `91`.
-     * @param {Boarding.RequestOptions} requestOptions - Request-specific configuration.
+     * @param {BoardingClient.RequestOptions} requestOptions - Request-specific configuration.
      *
      * @throws {@link Payabli.BadRequestError}
      * @throws {@link Payabli.UnauthorizedError}
@@ -564,13 +565,13 @@ export declare class Boarding {
      * @example
      *     await client.boarding.getByIdLinkApplication(91)
      */
-    getByIdLinkApplication(boardingLinkId: number, requestOptions?: Boarding.RequestOptions): core.HttpResponsePromise<Payabli.BoardingLinkQueryRecord>;
+    getByIdLinkApplication(boardingLinkId: number, requestOptions?: BoardingClient.RequestOptions): core.HttpResponsePromise<Payabli.BoardingLinkQueryRecord>;
     private __getByIdLinkApplication;
     /**
      * Get details for a boarding link using the boarding template ID. This endpoint requires an application API token.
      *
      * @param {number} templateId - The boarding template ID. You can find this at the end of the boarding template URL in PartnerHub. Example: `https://partner-sandbox.payabli.com/myorganization/boarding/edittemplate/80`. Here, the template ID is `80`.
-     * @param {Boarding.RequestOptions} requestOptions - Request-specific configuration.
+     * @param {BoardingClient.RequestOptions} requestOptions - Request-specific configuration.
      *
      * @throws {@link Payabli.BadRequestError}
      * @throws {@link Payabli.UnauthorizedError}
@@ -580,7 +581,7 @@ export declare class Boarding {
      * @example
      *     await client.boarding.getByTemplateIdLinkApplication(80)
      */
-    getByTemplateIdLinkApplication(templateId: number, requestOptions?: Boarding.RequestOptions): core.HttpResponsePromise<Payabli.BoardingLinkQueryRecord>;
+    getByTemplateIdLinkApplication(templateId: number, requestOptions?: BoardingClient.RequestOptions): core.HttpResponsePromise<Payabli.BoardingLinkQueryRecord>;
     private __getByTemplateIdLinkApplication;
     /**
      * Retrieves a link and the verification code used to log into an existing boarding application. You can also use this endpoint to send a link and referenceId for an existing boarding application to an email address. The recipient can use the referenceId and email address to access and edit the application.
@@ -588,7 +589,7 @@ export declare class Boarding {
      * @param {number} appId - Boarding application ID.
      * @param {string} mail2 - Email address used to access the application. If `sendEmail` parameter is true, a link to the application is sent to this email address.
      * @param {Payabli.GetExternalApplicationRequest} request
-     * @param {Boarding.RequestOptions} requestOptions - Request-specific configuration.
+     * @param {BoardingClient.RequestOptions} requestOptions - Request-specific configuration.
      *
      * @throws {@link Payabli.BadRequestError}
      * @throws {@link Payabli.UnauthorizedError}
@@ -598,13 +599,13 @@ export declare class Boarding {
      * @example
      *     await client.boarding.getExternalApplication(352, "mail2")
      */
-    getExternalApplication(appId: number, mail2: string, request?: Payabli.GetExternalApplicationRequest, requestOptions?: Boarding.RequestOptions): core.HttpResponsePromise<Payabli.PayabliApiResponse00>;
+    getExternalApplication(appId: number, mail2: string, request?: Payabli.GetExternalApplicationRequest, requestOptions?: BoardingClient.RequestOptions): core.HttpResponsePromise<Payabli.PayabliApiResponse00>;
     private __getExternalApplication;
     /**
      * Retrieves the details for a boarding link, by reference name. This endpoint requires an application API token.
      *
      * @param {string} boardingLinkReference - The boarding link reference name. You can find this at the end of the boarding link URL. For example `https://boarding.payabli.com/boarding/app/myorgaccountname-00091`
-     * @param {Boarding.RequestOptions} requestOptions - Request-specific configuration.
+     * @param {BoardingClient.RequestOptions} requestOptions - Request-specific configuration.
      *
      * @throws {@link Payabli.BadRequestError}
      * @throws {@link Payabli.UnauthorizedError}
@@ -614,14 +615,14 @@ export declare class Boarding {
      * @example
      *     await client.boarding.getLinkApplication("myorgaccountname-00091")
      */
-    getLinkApplication(boardingLinkReference: string, requestOptions?: Boarding.RequestOptions): core.HttpResponsePromise<Payabli.BoardingLinkQueryRecord>;
+    getLinkApplication(boardingLinkReference: string, requestOptions?: BoardingClient.RequestOptions): core.HttpResponsePromise<Payabli.BoardingLinkQueryRecord>;
     private __getLinkApplication;
     /**
      * Returns a list of boarding applications 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.ListApplicationsRequest} request
-     * @param {Boarding.RequestOptions} requestOptions - Request-specific configuration.
+     * @param {BoardingClient.RequestOptions} requestOptions - Request-specific configuration.
      *
      * @throws {@link Payabli.BadRequestError}
      * @throws {@link Payabli.UnauthorizedError}
@@ -635,14 +636,14 @@ export declare class Boarding {
      *         sortBy: "desc(field_name)"
      *     })
      */
-    listApplications(orgId: number, request?: Payabli.ListApplicationsRequest, requestOptions?: Boarding.RequestOptions): core.HttpResponsePromise<Payabli.QueryBoardingAppsListResponse>;
+    listApplications(orgId: number, request?: Payabli.ListApplicationsRequest, requestOptions?: BoardingClient.RequestOptions): core.HttpResponsePromise<Payabli.QueryBoardingAppsListResponse>;
     private __listApplications;
     /**
      * Return a list of boarding links for an organization. Use filters to limit results.
      *
      * @param {number} orgId - The numeric identifier for organization, assigned by Payabli.
      * @param {Payabli.ListBoardingLinksRequest} request
-     * @param {Boarding.RequestOptions} requestOptions - Request-specific configuration.
+     * @param {BoardingClient.RequestOptions} requestOptions - Request-specific configuration.
      *
      * @throws {@link Payabli.BadRequestError}
      * @throws {@link Payabli.UnauthorizedError}
@@ -656,14 +657,14 @@ export declare class Boarding {
      *         sortBy: "desc(field_name)"
      *     })
      */
-    listBoardingLinks(orgId: number, request?: Payabli.ListBoardingLinksRequest, requestOptions?: Boarding.RequestOptions): core.HttpResponsePromise<Payabli.QueryBoardingLinksResponse>;
+    listBoardingLinks(orgId: number, request?: Payabli.ListBoardingLinksRequest, requestOptions?: BoardingClient.RequestOptions): core.HttpResponsePromise<Payabli.QueryBoardingLinksResponse>;
     private __listBoardingLinks;
     /**
      * Updates a boarding application by ID. This endpoint requires an application API token.
      *
      * @param {number} appId - Boarding application ID.
      * @param {Payabli.ApplicationData} request
-     * @param {Boarding.RequestOptions} requestOptions - Request-specific configuration.
+     * @param {BoardingClient.RequestOptions} requestOptions - Request-specific configuration.
      *
      * @throws {@link Payabli.BadRequestError}
      * @throws {@link Payabli.UnauthorizedError}
@@ -673,7 +674,6 @@ export declare class Boarding {
      * @example
      *     await client.boarding.updateApplication(352, {})
      */
-    updateApplication(appId: number, request: Payabli.ApplicationData, requestOptions?: Boarding.RequestOptions): core.HttpResponsePromise<Payabli.PayabliApiResponse00Responsedatanonobject>;
+    updateApplication(appId: number, request: Payabli.ApplicationData, requestOptions?: BoardingClient.RequestOptions): core.HttpResponsePromise<Payabli.PayabliApiResponse00Responsedatanonobject>;
     private __updateApplication;
-    protected _getCustomAuthorizationHeaders(): Promise<Record<string, string | undefined>>;
 }