@payabli/sdk-node 0.0.107

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

@@ -0,0 +1,696 @@
+/**
+ * This file was auto-generated by Fern from our API Definition.
+ */
+import * as environments from "../../../../environments";
+import * as core from "../../../../core";
+import * as Payabli from "../../../index";
+export declare namespace Boarding {
+    interface Options {
+        environment?: core.Supplier<environments.PayabliEnvironment | string>;
+        /** Specify a custom URL to connect the client to. */
+        baseUrl?: core.Supplier<string>;
+        apiKey?: core.Supplier<string | undefined>;
+    }
+    interface RequestOptions {
+        /** The maximum time to wait for a response in seconds. */
+        timeoutInSeconds?: number;
+        /** The number of times to retry the request. Defaults to 2. */
+        maxRetries?: number;
+        /** A hook to abort the request. */
+        abortSignal?: AbortSignal;
+        /** Additional headers to include in the request. */
+        headers?: Record<string, string>;
+    }
+}
+export declare class Boarding {
+    protected readonly _options: Boarding.Options;
+    constructor(_options?: Boarding.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.
+     *
+     * @throws {@link Payabli.BadRequestError}
+     * @throws {@link Payabli.UnauthorizedError}
+     * @throws {@link Payabli.InternalServerError}
+     * @throws {@link Payabli.ServiceUnavailableError}
+     *
+     * @example
+     *     await client.boarding.addApplication({
+     *         services: {
+     *             ach: {},
+     *             card: {
+     *                 acceptAmex: true,
+     *                 acceptDiscover: true,
+     *                 acceptMastercard: true,
+     *                 acceptVisa: true
+     *             }
+     *         },
+     *         annualRevenue: 1000,
+     *         averageBillSize: "500",
+     *         averageMonthlyBill: "5650",
+     *         avgmonthly: 1000,
+     *         baddress: "123 Walnut Street",
+     *         baddress1: "Suite 103",
+     *         bankData: {},
+     *         bcity: "New Vegas",
+     *         bcountry: "US",
+     *         binperson: 60,
+     *         binphone: 20,
+     *         binweb: 20,
+     *         bstate: "FL",
+     *         bsummary: "Brick and mortar store that sells office supplies",
+     *         btype: "Limited Liability Company",
+     *         bzip: "33000",
+     *         contacts: [{
+     *                 contactEmail: "herman@hermanscoatings.com",
+     *                 contactName: "Herman Martinez",
+     *                 contactPhone: "3055550000",
+     *                 contactTitle: "Owner"
+     *             }],
+     *         creditLimit: "creditLimit",
+     *         dbaName: "Sunshine Gutters",
+     *         ein: "123456789",
+     *         faxnumber: "1234567890",
+     *         highticketamt: 1000,
+     *         legalName: "Sunshine Services, LLC",
+     *         license: "2222222FFG",
+     *         licstate: "CA",
+     *         maddress: "123 Walnut Street",
+     *         maddress1: "STE 900",
+     *         mcc: "7777",
+     *         mcity: "Johnson City",
+     *         mcountry: "US",
+     *         mstate: "TN",
+     *         mzip: "37615",
+     *         orgId: 123,
+     *         ownership: [{
+     *                 oaddress: "33 North St",
+     *                 ocity: "Any City",
+     *                 ocountry: "US",
+     *                 odriverstate: "CA",
+     *                 ostate: "CA",
+     *                 ownerdob: "01/01/1990",
+     *                 ownerdriver: "CA6677778",
+     *                 owneremail: "test@email.com",
+     *                 ownername: "John Smith",
+     *                 ownerpercent: 100,
+     *                 ownerphone1: "555888111",
+     *                 ownerphone2: "555888111",
+     *                 ownerssn: "123456789",
+     *                 ownertitle: "CEO",
+     *                 ozip: "55555"
+     *             }],
+     *         phonenumber: "1234567890",
+     *         processingRegion: "US",
+     *         recipientEmail: "josephray@example.com",
+     *         recipientEmailNotification: true,
+     *         resumable: true,
+     *         signer: {
+     *             address: "33 North St",
+     *             address1: "STE 900",
+     *             city: "Bristol",
+     *             country: "US",
+     *             dob: "01/01/1976",
+     *             email: "test@email.com",
+     *             name: "John Smith",
+     *             phone: "555888111",
+     *             ssn: "123456789",
+     *             state: "TN",
+     *             zip: "55555",
+     *             pciAttestation: true,
+     *             signedDocumentReference: "https://example.com/signed-document.pdf",
+     *             attestationDate: "04/20/2025",
+     *             signDate: "04/20/2025",
+     *             additionalData: "{\"deviceId\":\"499585-389fj484-3jcj8hj3\",\"session\":\"fifji4-fiu443-fn4843\",\"timeWithCompany\":\"6 Years\"}"
+     *         },
+     *         startdate: "01/01/1990",
+     *         taxFillName: "Sunshine LLC",
+     *         templateId: 22,
+     *         ticketamt: 1000,
+     *         website: "www.example.com",
+     *         whenCharged: "When Service Provided",
+     *         whenDelivered: "Over 30 Days",
+     *         whenProvided: "30 Days or Less",
+     *         whenRefunded: "30 Days or Less"
+     *     })
+     *
+     * @example
+     *     await client.boarding.addApplication({
+     *         annualRevenue: 750000,
+     *         baddress: "789 Industrial Parkway",
+     *         baddress1: "Unit 12",
+     *         bankData: [{
+     *                 accountNumber: "1XXXXXX3100",
+     *                 bankAccountFunction: 1,
+     *                 bankAccountHolderName: "Herman's Coatings LLC",
+     *                 bankAccountHolderType: "Business",
+     *                 bankName: "First Miami Bank",
+     *                 nickname: "Withdrawal Account",
+     *                 routingAccount: "123123123",
+     *                 typeAccount: "Checking",
+     *                 accountId: "123-456"
+     *             }, {
+     *                 accountNumber: "1XXXXXX3200",
+     *                 bankAccountFunction: 0,
+     *                 bankAccountHolderName: "Herman's Coatings LLC",
+     *                 bankAccountHolderType: "Business",
+     *                 bankName: "First Miami Bank",
+     *                 nickname: "Deposit Account",
+     *                 routingAccount: "123123123",
+     *                 typeAccount: "Checking",
+     *                 accountId: "123-789"
+     *             }, {
+     *                 accountNumber: "1XXXXXX3123",
+     *                 bankAccountFunction: 3,
+     *                 bankAccountHolderName: "Herman's Coatings LLC",
+     *                 bankAccountHolderType: "Business",
+     *                 bankName: "First Miami Bank",
+     *                 nickname: "Remittance Account",
+     *                 routingAccount: "123123123",
+     *                 typeAccount: "Checking",
+     *                 accountId: "123-100"
+     *             }],
+     *         bcity: "Miami",
+     *         bcountry: "US",
+     *         bstate: "FL",
+     *         bsummary: "Commercial and industrial coating services, including protective and decorative coatings",
+     *         btype: "Limited Liability Company",
+     *         bzip: "33101",
+     *         contacts: [{
+     *                 contactEmail: "herman@hermanscoatings.com",
+     *                 contactName: "Herman Martinez",
+     *                 contactPhone: "3055550000",
+     *                 contactTitle: "Owner"
+     *             }],
+     *         dbaname: "Herman's Coatings",
+     *         ein: "123456789",
+     *         faxnumber: "3055550001",
+     *         legalname: "Herman's Coatings LLC",
+     *         license: "FL123456",
+     *         licstate: "FL",
+     *         maddress: "789 Industrial Parkway",
+     *         maddress1: "Unit 12",
+     *         mcc: "1799",
+     *         mcity: "Miami",
+     *         mcountry: "US",
+     *         mstate: "FL",
+     *         mzip: "33101",
+     *         orgId: 123,
+     *         ownership: [{
+     *                 oaddress: "123 Palm Avenue",
+     *                 ocity: "Miami",
+     *                 ocountry: "US",
+     *                 odriverstate: "FL",
+     *                 ostate: "FL",
+     *                 ownerdob: "05/15/1980",
+     *                 ownerdriver: "FL789456",
+     *                 owneremail: "herman@hermanscoatings.com",
+     *                 ownername: "Herman Martinez",
+     *                 ownerpercent: 100,
+     *                 ownerphone1: "3055550000",
+     *                 ownerphone2: "3055550002",
+     *                 ownerssn: "123456789",
+     *                 ownertitle: "Owner",
+     *                 ozip: "33102"
+     *             }],
+     *         phonenumber: "3055550000",
+     *         recipientEmail: "herman@hermanscoatings.com",
+     *         recipientEmailNotification: true,
+     *         resumable: true,
+     *         signer: {
+     *             address: "33 North St",
+     *             address1: "STE 900",
+     *             city: "Bristol",
+     *             country: "US",
+     *             dob: "01/01/1976",
+     *             email: "test@email.com",
+     *             name: "John Smith",
+     *             phone: "555888111",
+     *             ssn: "123456789",
+     *             state: "TN",
+     *             zip: "55555",
+     *             pciAttestation: true,
+     *             signedDocumentReference: "https://example.com/signed-document.pdf",
+     *             attestationDate: "04/20/2025",
+     *             signDate: "04/20/2025",
+     *             additionalData: "{\"deviceId\":\"499585-389fj484-3jcj8hj3\",\"session\":\"fifji4-fiu443-fn4843\",\"timeWithCompany\":\"6 Years\"}"
+     *         },
+     *         startdate: "01/01/2015",
+     *         taxfillname: "Herman's Coatings LLC",
+     *         templateId: 22,
+     *         website: "www.hermanscoatings.com"
+     *     })
+     *
+     * @example
+     *     await client.boarding.addApplication({
+     *         services: {
+     *             ach: {
+     *                 acceptCCD: true,
+     *                 acceptPPD: true,
+     *                 acceptWeb: true
+     *             },
+     *             card: {
+     *                 acceptAmex: true,
+     *                 acceptDiscover: true,
+     *                 acceptMastercard: true,
+     *                 acceptVisa: true
+     *             },
+     *             odp: {
+     *                 allowAch: true,
+     *                 allowChecks: true,
+     *                 allowVCard: true,
+     *                 processing_region: "US",
+     *                 processor: "tsys",
+     *                 issuerNetworkSettingsId: "12345678901234"
+     *             }
+     *         },
+     *         annualRevenue: 750000,
+     *         baddress: "789 Industrial Parkway",
+     *         baddress1: "Unit 12",
+     *         bankData: [{
+     *                 accountNumber: "1XXXXXX3100",
+     *                 bankAccountFunction: 1,
+     *                 bankAccountHolderName: "Herman's Coatings LLC",
+     *                 bankAccountHolderType: "Business",
+     *                 bankName: "First Miami Bank",
+     *                 nickname: "Withdrawal Account",
+     *                 routingAccount: "123123123",
+     *                 typeAccount: "Checking",
+     *                 accountId: "333-789"
+     *             }, {
+     *                 accountNumber: "1XXXXXX3200",
+     *                 bankAccountFunction: 0,
+     *                 bankAccountHolderName: "Herman's Coatings LLC",
+     *                 bankAccountHolderType: "Business",
+     *                 bankName: "First Miami Bank",
+     *                 nickname: "Deposit Account",
+     *                 routingAccount: "123123123",
+     *                 typeAccount: "Checking",
+     *                 accountId: "333-234"
+     *             }, {
+     *                 accountNumber: "1XXXXXX3123",
+     *                 bankAccountFunction: 3,
+     *                 bankAccountHolderName: "Herman's Coatings LLC",
+     *                 bankAccountHolderType: "Business",
+     *                 bankName: "First Miami Bank",
+     *                 nickname: "Remittance Account",
+     *                 routingAccount: "123123123",
+     *                 typeAccount: "Checking",
+     *                 accountId: "333-567"
+     *             }],
+     *         bcity: "Miami",
+     *         bcountry: "US",
+     *         bstate: "FL",
+     *         bsummary: "Commercial and industrial coating services, including protective and decorative coatings",
+     *         btype: "Limited Liability Company",
+     *         bzip: "33101",
+     *         contacts: [{
+     *                 contactEmail: "herman@hermanscoatings.com",
+     *                 contactName: "Herman Martinez",
+     *                 contactPhone: "3055550000",
+     *                 contactTitle: "Owner"
+     *             }],
+     *         dbaname: "Herman's Coatings",
+     *         ein: "123456789",
+     *         faxnumber: "3055550001",
+     *         highticketamt: 15000,
+     *         legalname: "Herman's Coatings LLC",
+     *         license: "FL123456",
+     *         licstate: "FL",
+     *         maddress: "789 Industrial Parkway",
+     *         maddress1: "Unit 12",
+     *         mcc: "1799",
+     *         mcity: "Miami",
+     *         mcountry: "US",
+     *         mstate: "FL",
+     *         mzip: "33101",
+     *         orgId: 123,
+     *         ownership: [{
+     *                 oaddress: "123 Palm Avenue",
+     *                 ocity: "Miami",
+     *                 ocountry: "US",
+     *                 odriverstate: "FL",
+     *                 ostate: "FL",
+     *                 ownerdob: "05/15/1980",
+     *                 ownerdriver: "FL789456",
+     *                 owneremail: "herman@hermanscoatings.com",
+     *                 ownername: "Herman Martinez",
+     *                 ownerpercent: 100,
+     *                 ownerphone1: "3055550000",
+     *                 ownerphone2: "3055550002",
+     *                 ownerssn: "123456789",
+     *                 ownertitle: "Owner",
+     *                 ozip: "33102"
+     *             }],
+     *         payoutAverageMonthlyVolume: 50000,
+     *         payoutAverageTicketAmount: 3500,
+     *         payoutCreditLimit: 25000,
+     *         payoutHighTicketAmount: 15000,
+     *         phonenumber: "3055550000",
+     *         recipientEmail: "herman@hermanscoatings.com",
+     *         recipientEmailNotification: true,
+     *         resumable: true,
+     *         signer: {
+     *             address: "33 North St",
+     *             address1: "STE 900",
+     *             city: "Bristol",
+     *             country: "US",
+     *             dob: "01/01/1976",
+     *             email: "test@email.com",
+     *             name: "John Smith",
+     *             phone: "555888111",
+     *             ssn: "123456789",
+     *             state: "TN",
+     *             zip: "55555",
+     *             pciAttestation: true,
+     *             signedDocumentReference: "https://example.com/signed-document.pdf",
+     *             attestationDate: "04/20/2025",
+     *             signDate: "04/20/2025",
+     *             additionalData: "{\"deviceId\":\"499585-389fj484-3jcj8hj3\",\"session\":\"fifji4-fiu443-fn4843\",\"timeWithCompany\":\"6 Years\"}"
+     *         },
+     *         startdate: "01/01/2015",
+     *         taxfillname: "Herman's Coatings LLC",
+     *         templateId: 22,
+     *         website: "www.hermanscoatings.com"
+     *     })
+     *
+     * @example
+     *     await client.boarding.addApplication({
+     *         services: {
+     *             ach: {
+     *                 acceptCCD: true,
+     *                 acceptPPD: true,
+     *                 acceptWeb: true
+     *             },
+     *             card: {
+     *                 acceptAmex: true,
+     *                 acceptDiscover: true,
+     *                 acceptMastercard: true,
+     *                 acceptVisa: true
+     *             },
+     *             odp: {
+     *                 allowAch: false,
+     *                 allowChecks: false,
+     *                 allowVCard: false
+     *             }
+     *         },
+     *         annualRevenue: 750000,
+     *         attachments: [{}, {}],
+     *         baddress: "789 Industrial Parkway",
+     *         baddress1: "Unit 12",
+     *         bankData: [{
+     *                 accountNumber: "1XXXXXX3100",
+     *                 bankAccountFunction: 1,
+     *                 bankAccountHolderName: "Herman's Coatings LLC",
+     *                 bankAccountHolderType: "Business",
+     *                 bankName: "First Miami Bank",
+     *                 id: 123,
+     *                 nickname: "Withdrawal Account",
+     *                 routingAccount: "123123123",
+     *                 typeAccount: "Checking",
+     *                 accountId: "123-789"
+     *             }, {
+     *                 accountNumber: "1XXXXXX3200",
+     *                 bankAccountFunction: 0,
+     *                 bankAccountHolderName: "Herman's Coatings LLC",
+     *                 bankAccountHolderType: "Business",
+     *                 bankName: "First Miami Bank",
+     *                 id: 456,
+     *                 nickname: "Deposit Account",
+     *                 routingAccount: "123123123",
+     *                 typeAccount: "Checking",
+     *                 accountId: "123-456"
+     *             }, {
+     *                 accountNumber: "1XXXXXX3123",
+     *                 bankAccountFunction: 3,
+     *                 bankAccountHolderName: "Herman's Coatings LLC",
+     *                 bankAccountHolderType: "Business",
+     *                 bankName: "First Miami Bank",
+     *                 id: 987,
+     *                 nickname: "Remittance Account",
+     *                 routingAccount: "123123123",
+     *                 typeAccount: "Checking",
+     *                 accountId: "123-100"
+     *             }],
+     *         bcity: "Miami",
+     *         bcountry: "US",
+     *         boardingLinkId: "bl_123456",
+     *         bstate: "FL",
+     *         bsummary: "Commercial and industrial coating services, including protective and decorative coatings",
+     *         btype: "Limited Liability Company",
+     *         bzip: "33101",
+     *         contacts: [{
+     *                 contactEmail: "herman@hermanscoatings.com",
+     *                 contactName: "Herman Martinez",
+     *                 contactPhone: "3055550000",
+     *                 contactTitle: "Owner"
+     *             }],
+     *         dbaname: "Herman's Coatings",
+     *         ein: "123456789",
+     *         faxnumber: "3055550001",
+     *         highticketamt: 15000,
+     *         legalname: "Herman's Coatings LLC",
+     *         license: "FL123456",
+     *         licstate: "FL",
+     *         maddress: "789 Industrial Parkway",
+     *         maddress1: "Unit 12",
+     *         mcc: "1799",
+     *         mcity: "Miami",
+     *         mcountry: "US",
+     *         mstate: "FL",
+     *         mzip: "33101",
+     *         orgId: 123,
+     *         ownership: [{
+     *                 oaddress: "123 Palm Avenue",
+     *                 ocity: "Miami",
+     *                 ocountry: "US",
+     *                 odriverstate: "FL",
+     *                 ostate: "FL",
+     *                 ownerdob: "05/15/1980",
+     *                 ownerdriver: "FL789456",
+     *                 owneremail: "herman@hermanscoatings.com",
+     *                 ownername: "Herman Martinez",
+     *                 ownerpercent: 100,
+     *                 ownerphone1: "3055550000",
+     *                 ownerphone2: "3055550002",
+     *                 ownerssn: "123456789",
+     *                 ownertitle: "Owner",
+     *                 ozip: "33102"
+     *             }],
+     *         payoutAverageMonthlyVolume: 50000,
+     *         payoutAverageTicketAmount: 500,
+     *         payoutCreditLimit: 25000,
+     *         payoutHighTicketAmount: 15000,
+     *         phonenumber: "3055550000",
+     *         recipientEmail: "herman@hermanscoatings.com",
+     *         recipientEmailNotification: true,
+     *         resumable: true,
+     *         signer: {
+     *             address: "33 North St",
+     *             address1: "STE 900",
+     *             city: "Bristol",
+     *             country: "US",
+     *             dob: "01/01/1976",
+     *             email: "test@email.com",
+     *             name: "John Smith",
+     *             phone: "555888111",
+     *             ssn: "123456789",
+     *             state: "TN",
+     *             zip: "55555",
+     *             pciAttestation: true,
+     *             signedDocumentReference: "https://example.com/signed-document.pdf",
+     *             attestationDate: "04/20/2025",
+     *             signDate: "04/20/2025",
+     *             additionalData: "{\"deviceId\":\"499585-389fj484-3jcj8hj3\",\"session\":\"fifji4-fiu443-fn4843\",\"timeWithCompany\":\"6 Years\"}"
+     *         },
+     *         startdate: "01/01/2015",
+     *         taxfillname: "Herman's Coatings LLC",
+     *         templateId: 22,
+     *         website: "www.hermanscoatings.com"
+     *     })
+     */
+    addApplication(request: Payabli.AddApplicationRequest, requestOptions?: Boarding.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.
+     *
+     * @throws {@link Payabli.BadRequestError}
+     * @throws {@link Payabli.UnauthorizedError}
+     * @throws {@link Payabli.InternalServerError}
+     * @throws {@link Payabli.ServiceUnavailableError}
+     *
+     * @example
+     *     await client.boarding.deleteApplication(352)
+     */
+    deleteApplication(appId: number, requestOptions?: Boarding.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.
+     *
+     * @throws {@link Payabli.BadRequestError}
+     * @throws {@link Payabli.UnauthorizedError}
+     * @throws {@link Payabli.InternalServerError}
+     * @throws {@link Payabli.ServiceUnavailableError}
+     *
+     * @example
+     *     await client.boarding.getApplication(352)
+     */
+    getApplication(appId: number, requestOptions?: Boarding.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.
+     *
+     * @throws {@link Payabli.BadRequestError}
+     * @throws {@link Payabli.UnauthorizedError}
+     * @throws {@link Payabli.InternalServerError}
+     * @throws {@link Payabli.ServiceUnavailableError}
+     *
+     * @example
+     *     await client.boarding.getApplicationByAuth("17E", {
+     *         email: "admin@email.com",
+     *         referenceId: "n6UCd1f1ygG7"
+     *     })
+     */
+    getApplicationByAuth(xId: string, request?: Payabli.RequestAppByAuth, requestOptions?: Boarding.RequestOptions): core.HttpResponsePromise<Payabli.ApplicationQueryRecord>;
+    private __getApplicationByAuth;
+    /**
+     * Retrieves details for a boarding link, by ID.
+     *
+     * @param {number} boardingLinkId - The boarding link ID. Can be found at the end of the boarding link reference name.  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.
+     *
+     * @throws {@link Payabli.BadRequestError}
+     * @throws {@link Payabli.UnauthorizedError}
+     * @throws {@link Payabli.InternalServerError}
+     * @throws {@link Payabli.ServiceUnavailableError}
+     *
+     * @example
+     *     await client.boarding.getByIdLinkApplication(91)
+     */
+    getByIdLinkApplication(boardingLinkId: number, requestOptions?: Boarding.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. Can be found 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.
+     *
+     * @throws {@link Payabli.BadRequestError}
+     * @throws {@link Payabli.UnauthorizedError}
+     * @throws {@link Payabli.InternalServerError}
+     * @throws {@link Payabli.ServiceUnavailableError}
+     *
+     * @example
+     *     await client.boarding.getByTemplateIdLinkApplication(80)
+     */
+    getByTemplateIdLinkApplication(templateId: number, requestOptions?: Boarding.RequestOptions): core.HttpResponsePromise<Payabli.BoardingLinkQueryRecord>;
+    private __getByTemplateIdLinkApplication;
+    /**
+     * Retrieves a link and the verification code used to log into an existing boarding application. This endpoint can also be used 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.
+     *
+     * @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.
+     *
+     * @throws {@link Payabli.BadRequestError}
+     * @throws {@link Payabli.UnauthorizedError}
+     * @throws {@link Payabli.InternalServerError}
+     * @throws {@link Payabli.ServiceUnavailableError}
+     *
+     * @example
+     *     await client.boarding.getExternalApplication(352, "mail2")
+     */
+    getExternalApplication(appId: number, mail2: string, request?: Payabli.GetExternalApplicationRequest, requestOptions?: Boarding.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.
+     *
+     * @throws {@link Payabli.BadRequestError}
+     * @throws {@link Payabli.UnauthorizedError}
+     * @throws {@link Payabli.InternalServerError}
+     * @throws {@link Payabli.ServiceUnavailableError}
+     *
+     * @example
+     *     await client.boarding.getLinkApplication("myorgaccountname-00091")
+     */
+    getLinkApplication(boardingLinkReference: string, requestOptions?: Boarding.RequestOptions): core.HttpResponsePromise<Payabli.BoardingLinkQueryRecord>;
+    private __getLinkApplication;
+    /**
+     * Returns a list of boarding applications for an organization. Use filters to limit results.
+     *
+     * @param {number} orgId - The numeric identifier for organization, assigned by Payabli.
+     * @param {Payabli.ListApplicationsRequest} request
+     * @param {Boarding.RequestOptions} requestOptions - Request-specific configuration.
+     *
+     * @throws {@link Payabli.BadRequestError}
+     * @throws {@link Payabli.UnauthorizedError}
+     * @throws {@link Payabli.InternalServerError}
+     * @throws {@link Payabli.ServiceUnavailableError}
+     *
+     * @example
+     *     await client.boarding.listApplications(123, {
+     *         fromRecord: 251,
+     *         limitRecord: 0,
+     *         sortBy: "desc(field_name)"
+     *     })
+     */
+    listApplications(orgId: number, request?: Payabli.ListApplicationsRequest, requestOptions?: Boarding.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.
+     *
+     * @throws {@link Payabli.BadRequestError}
+     * @throws {@link Payabli.UnauthorizedError}
+     * @throws {@link Payabli.InternalServerError}
+     * @throws {@link Payabli.ServiceUnavailableError}
+     *
+     * @example
+     *     await client.boarding.listBoardingLinks(123, {
+     *         fromRecord: 251,
+     *         limitRecord: 0,
+     *         sortBy: "desc(field_name)"
+     *     })
+     */
+    listBoardingLinks(orgId: number, request?: Payabli.ListBoardingLinksRequest, requestOptions?: Boarding.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.
+     *
+     * @throws {@link Payabli.BadRequestError}
+     * @throws {@link Payabli.UnauthorizedError}
+     * @throws {@link Payabli.InternalServerError}
+     * @throws {@link Payabli.ServiceUnavailableError}
+     *
+     * @example
+     *     await client.boarding.updateApplication(352, {})
+     */
+    updateApplication(appId: number, request: Payabli.ApplicationData, requestOptions?: Boarding.RequestOptions): core.HttpResponsePromise<Payabli.PayabliApiResponse00Responsedatanonobject>;
+    private __updateApplication;
+    protected _getCustomAuthorizationHeaders(): Promise<{
+        requestToken: string | undefined;
+    }>;
+}