@payabli/sdk-node 0.0.130 → 0.0.132

package/dist/cjs/api/resources/ocr/types/OcrBillItemAdditionalData.d.ts

@@ -1,6 +1,6 @@
 export interface OcrBillItemAdditionalData {
-    category?: string;
-    currency_code?: string;
-    type?: string;
-    reference_number?: string;
+    category?: string | undefined;
+    currency_code?: string | undefined;
+    type?: string | undefined;
+    reference_number?: string | undefined;
 }

package/dist/cjs/api/resources/ocr/types/OcrResponseData.d.ts

@@ -1,4 +1,4 @@
 import type * as Payabli from "../../../index.js";
 export interface OcrResponseData {
-    resultData?: Payabli.OcrResultData;
+    resultData?: Payabli.OcrResultData | undefined;
 }

package/dist/cjs/api/resources/ocr/types/OcrResultData.d.ts

@@ -1,20 +1,20 @@
 import type * as Payabli from "../../../index.js";
 export interface OcrResultData {
-    billNumber?: string;
-    netAmount?: number;
-    billDate?: string;
-    dueDate?: string;
-    comments?: string;
-    billItems?: Payabli.OcrBillItem[];
-    mode?: number;
-    accountingField1?: string;
-    accountingField2?: string;
-    additionalData?: Payabli.OcrBillItemAdditionalData;
-    vendor?: Payabli.OcrVendor;
-    endDate?: string;
-    frequency?: string;
-    terms?: string;
-    status?: number;
-    lotNumber?: string;
-    attachments?: Payabli.OcrAttachment[];
+    billNumber?: string | undefined;
+    netAmount?: number | undefined;
+    billDate?: string | undefined;
+    dueDate?: string | undefined;
+    comments?: string | undefined;
+    billItems?: Payabli.OcrBillItem[] | undefined;
+    mode?: number | undefined;
+    accountingField1?: string | undefined;
+    accountingField2?: string | undefined;
+    additionalData?: Payabli.OcrBillItemAdditionalData | undefined;
+    vendor?: Payabli.OcrVendor | undefined;
+    endDate?: string | undefined;
+    frequency?: string | undefined;
+    terms?: string | undefined;
+    status?: number | undefined;
+    lotNumber?: string | undefined;
+    attachments?: Payabli.OcrAttachment[] | undefined;
 }

package/dist/cjs/api/resources/ocr/types/OcrVendor.d.ts

@@ -1,34 +1,34 @@
 import type * as Payabli from "../../../index.js";
 export interface OcrVendor {
-    vendorNumber?: string;
-    name1?: string;
-    name2?: string;
-    ein?: string;
-    phone?: string;
-    email?: string;
-    address1?: string;
-    address2?: string;
-    city?: string;
-    state?: string;
-    zip?: string;
-    country?: string;
-    mcc?: string;
-    locationCode?: string;
-    contacts?: Payabli.Contacts[];
-    billingData?: Payabli.OcrVendorBillingData;
-    paymentMethod?: string;
-    vendorStatus?: number;
-    remitAddress1?: string;
-    remitAddress2?: string;
-    remitCity?: string;
-    remitState?: string;
-    remitZip?: string;
-    remitCountry?: string;
-    payeeName1?: string;
-    payeeName2?: string;
-    customerVendorAccount?: string;
-    internalReferenceId?: number;
-    customField1?: string;
-    customField2?: string;
-    additionalData?: Payabli.OcrVendorAdditionalData;
+    vendorNumber?: string | undefined;
+    name1?: string | undefined;
+    name2?: string | undefined;
+    ein?: string | undefined;
+    phone?: string | undefined;
+    email?: string | undefined;
+    address1?: string | undefined;
+    address2?: string | undefined;
+    city?: string | undefined;
+    state?: string | undefined;
+    zip?: string | undefined;
+    country?: string | undefined;
+    mcc?: string | undefined;
+    locationCode?: string | undefined;
+    contacts?: Payabli.Contacts[] | undefined;
+    billingData?: Payabli.OcrVendorBillingData | undefined;
+    paymentMethod?: string | undefined;
+    vendorStatus?: number | undefined;
+    remitAddress1?: string | undefined;
+    remitAddress2?: string | undefined;
+    remitCity?: string | undefined;
+    remitState?: string | undefined;
+    remitZip?: string | undefined;
+    remitCountry?: string | undefined;
+    payeeName1?: string | undefined;
+    payeeName2?: string | undefined;
+    customerVendorAccount?: string | undefined;
+    internalReferenceId?: number | undefined;
+    customField1?: string | undefined;
+    customField2?: string | undefined;
+    additionalData?: Payabli.OcrVendorAdditionalData | undefined;
 }

package/dist/cjs/api/resources/ocr/types/OcrVendorAdditionalData.d.ts

@@ -1,3 +1,3 @@
 export interface OcrVendorAdditionalData {
-    web?: string;
+    web?: string | undefined;
 }

package/dist/cjs/api/resources/ocr/types/OcrVendorBillingData.d.ts

@@ -1,10 +1,10 @@
 export interface OcrVendorBillingData {
-    id?: number;
-    bankName?: string;
-    routingAccount?: string;
-    accountNumber?: string;
-    typeAccount?: string;
-    bankAccountHolderName?: string;
-    bankAccountHolderType?: string;
-    bankAccountFunction?: number;
+    id?: number | undefined;
+    bankName?: string | undefined;
+    routingAccount?: string | undefined;
+    accountNumber?: string | undefined;
+    typeAccount?: string | undefined;
+    bankAccountHolderName?: string | undefined;
+    bankAccountHolderType?: string | undefined;
+    bankAccountFunction?: number | undefined;
 }

package/dist/cjs/api/resources/ocr/types/PayabliApiResponseOcr.d.ts

@@ -4,5 +4,5 @@ export interface PayabliApiResponseOcr {
     responseText: Payabli.ResponseText;
     responseCode: Payabli.Responsecode;
     /** Details of the OCR processing result */
-    responseData?: Payabli.OcrResponseData;
+    responseData?: Payabli.OcrResponseData | undefined;
 }

package/dist/cjs/api/resources/organization/client/Client.js

@@ -126,7 +126,7 @@ class OrganizationClient {
             var _a, _b, _c, _d, _e, _f, _g, _h, _j;
             const { idempotencyKey } = request, _body = __rest(request, ["idempotencyKey"]);
             const _authRequest = yield this._options.authProvider.getAuthRequest();
-            const _headers = (0, headers_js_1.mergeHeaders)(_authRequest.headers, (_a = this._options) === null || _a === void 0 ? void 0 : _a.headers, (0, headers_js_1.mergeOnlyDefinedHeaders)({ idempotencyKey: idempotencyKey != null ? idempotencyKey : undefined }), requestOptions === null || requestOptions === void 0 ? void 0 : requestOptions.headers);
+            const _headers = (0, headers_js_1.mergeHeaders)(_authRequest.headers, (_a = this._options) === null || _a === void 0 ? void 0 : _a.headers, (0, headers_js_1.mergeOnlyDefinedHeaders)({ idempotencyKey: idempotencyKey }), requestOptions === null || requestOptions === void 0 ? void 0 : requestOptions.headers);
             const _response = yield core.fetcher({
                 url: core.url.join((_c = (_b = (yield core.Supplier.get(this._options.baseUrl))) !== null && _b !== void 0 ? _b : (yield core.Supplier.get(this._options.environment))) !== null && _c !== void 0 ? _c : environments.PayabliEnvironment.Sandbox, "Organization"),
                 method: "POST",

package/dist/cjs/api/resources/organization/client/requests/AddOrganizationRequest.d.ts

@@ -45,7 +45,7 @@ export interface AddOrganizationRequest {
     idempotencyKey?: Payabli.IdempotencyKey;
     services?: Payabli.ServiceCost[];
     billingInfo?: Payabli.Instrument;
-    contacts?: Payabli.ContactsField | undefined;
+    contacts?: Payabli.ContactsField;
     hasBilling?: boolean;
     hasResidual?: boolean;
     orgAddress?: Payabli.Orgaddress;

package/dist/cjs/api/resources/organization/client/requests/OrganizationData.d.ts

@@ -24,7 +24,7 @@ import type * as Payabli from "../../../../index.js";
 export interface OrganizationData {
     services?: Payabli.ServiceCost[];
     billingInfo?: Payabli.Instrument;
-    contacts?: Payabli.ContactsField | undefined;
+    contacts?: Payabli.ContactsField;
     hasBilling?: boolean;
     hasResidual?: boolean;
     orgAddress?: Payabli.Orgaddress;

package/dist/cjs/api/resources/organization/types/AddOrganizationResponse.d.ts

@@ -1,7 +1,7 @@
 import type * as Payabli from "../../../index.js";
 export interface AddOrganizationResponse {
-    isSuccess?: Payabli.IsSuccess;
+    isSuccess?: Payabli.IsSuccess | undefined;
     /** Returns the organization ID. */
-    responseData?: Payabli.Responsedatanonobject;
+    responseData?: Payabli.Responsedatanonobject | undefined;
     responseText: Payabli.ResponseText;
 }

package/dist/cjs/api/resources/organization/types/DeleteOrganizationResponse.d.ts

@@ -1,7 +1,7 @@
 import type * as Payabli from "../../../index.js";
 export interface DeleteOrganizationResponse {
-    isSuccess?: Payabli.IsSuccess;
+    isSuccess?: Payabli.IsSuccess | undefined;
     /** Returns the organization ID. */
-    responseData?: Payabli.Responsedatanonobject;
+    responseData?: Payabli.Responsedatanonobject | undefined;
     responseText: Payabli.ResponseText;
 }

package/dist/cjs/api/resources/organization/types/EditOrganizationResponse.d.ts

@@ -1,9 +1,9 @@
 import type * as Payabli from "../../../index.js";
 export interface EditOrganizationResponse {
-    isSuccess?: Payabli.IsSuccess;
-    pageIdentifier?: Payabli.PageIdentifier;
+    isSuccess?: Payabli.IsSuccess | undefined;
+    pageIdentifier?: Payabli.PageIdentifier | undefined;
     responseCode: Payabli.Responsecode;
     /** Returns the organization ID. */
-    responseData?: Payabli.Responsedatanonobject;
+    responseData?: Payabli.Responsedatanonobject | undefined;
     responseText: Payabli.ResponseText;
 }

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

@@ -137,7 +137,7 @@ export declare class PaymentLinkClient {
     addPayLinkFromInvoice(idInvoice: number, request: Payabli.PayLinkDataInvoice, requestOptions?: PaymentLinkClient.RequestOptions): core.HttpResponsePromise<Payabli.PayabliApiResponsePaymentLinks>;
     private __addPayLinkFromInvoice;
     /**
-     * Generates a payment link for a bill from the bill ID.
+     * Generates a payment link for a bill from the bill ID. The vendor receives a secure page where they can select their preferred payment method (ACH, virtual card, or check) and complete the payment.
      *
      * @param {number} billId - The Payabli ID for the bill.
      * @param {Payabli.PayLinkDataBill} request
@@ -189,35 +189,82 @@ export declare class PaymentLinkClient {
      *             },
      *             paymentMethods: {
      *                 allMethodsChecked: true,
+     *                 allowMultipleMethods: true,
+     *                 defaultMethod: "vcard",
      *                 enabled: true,
      *                 header: "Payment Methods",
      *                 methods: {
-     *                     amex: true,
-     *                     applePay: true,
-     *                     discover: true,
-     *                     eCheck: true,
-     *                     mastercard: true,
-     *                     visa: true
+     *                     ach: true,
+     *                     check: true,
+     *                     vcard: true
      *                 },
+     *                 order: 0,
+     *                 showPreviewVirtualCard: true
+     *             },
+     *             review: {
+     *                 enabled: true,
+     *                 header: "Review Payment",
      *                 order: 0
      *             },
-     *             payor: {
+     *             settings: {
+     *                 color: "#000000",
+     *                 language: "en"
+     *             }
+     *         }
+     *     })
+     *
+     * @example
+     *     await client.paymentLink.addPayLinkFromBill(23548884, {
+     *         body: {
+     *             contactUs: {
+     *                 emailLabel: "Email",
+     *                 enabled: true,
+     *                 header: "Contact Us",
+     *                 order: 0,
+     *                 paymentIcons: true,
+     *                 phoneLabel: "Phone"
+     *             },
+     *             logo: {
      *                 enabled: true,
-     *                 fields: [{
-     *                         display: true,
-     *                         fixed: true,
-     *                         identifier: true,
-     *                         label: "Full Name",
-     *                         name: "fullName",
-     *                         order: 0,
-     *                         required: true,
-     *                         validation: "alpha",
-     *                         value: "",
-     *                         width: 0
-     *                     }],
-     *                 header: "Payor Information",
      *                 order: 0
      *             },
+     *             messageBeforePaying: {
+     *                 enabled: true,
+     *                 label: "Please review your payment details",
+     *                 order: 0
+     *             },
+     *             notes: {
+     *                 enabled: true,
+     *                 header: "Additional Notes",
+     *                 order: 0,
+     *                 placeholder: "Enter any additional notes here",
+     *                 value: ""
+     *             },
+     *             page: {
+     *                 description: "Get paid securely",
+     *                 enabled: true,
+     *                 header: "Payment Page",
+     *                 order: 0
+     *             },
+     *             paymentButton: {
+     *                 enabled: true,
+     *                 label: "Pay Now",
+     *                 order: 0
+     *             },
+     *             paymentMethods: {
+     *                 allMethodsChecked: true,
+     *                 allowMultipleMethods: true,
+     *                 defaultMethod: "vcard",
+     *                 enabled: true,
+     *                 header: "Payment Methods",
+     *                 methods: {
+     *                     ach: true,
+     *                     check: true,
+     *                     vcard: true
+     *                 },
+     *                 order: 0,
+     *                 showPreviewVirtualCard: true
+     *             },
      *             review: {
      *                 enabled: true,
      *                 header: "Review Payment",
@@ -244,7 +291,7 @@ export declare class PaymentLinkClient {
      * @throws {@link Payabli.ServiceUnavailableError}
      *
      * @example
-     *     await client.paymentLink.deletePayLinkFromId("payLinkId")
+     *     await client.paymentLink.deletePayLinkFromId("2325-XXXXXXX-90b1-4598-b6c7-44cdcbf495d7-1234")
      */
     deletePayLinkFromId(payLinkId: string, requestOptions?: PaymentLinkClient.RequestOptions): core.HttpResponsePromise<Payabli.PayabliApiResponsePaymentLinks>;
     private __deletePayLinkFromId;
@@ -407,34 +454,17 @@ export declare class PaymentLinkClient {
      *             },
      *             paymentMethods: {
      *                 allMethodsChecked: true,
+     *                 allowMultipleMethods: true,
+     *                 defaultMethod: "vcard",
      *                 enabled: true,
      *                 header: "Payment Methods",
      *                 methods: {
-     *                     amex: true,
-     *                     applePay: true,
-     *                     discover: true,
-     *                     eCheck: true,
-     *                     mastercard: true,
-     *                     visa: true
+     *                     ach: true,
+     *                     check: true,
+     *                     vcard: true
      *                 },
-     *                 order: 0
-     *             },
-     *             payor: {
-     *                 enabled: true,
-     *                 fields: [{
-     *                         display: true,
-     *                         fixed: true,
-     *                         identifier: true,
-     *                         label: "Full Name",
-     *                         name: "fullName",
-     *                         order: 0,
-     *                         required: true,
-     *                         validation: "alpha",
-     *                         value: "",
-     *                         width: 0
-     *                     }],
-     *                 header: "Payor Information",
-     *                 order: 0
+     *                 order: 0,
+     *                 showPreviewVirtualCard: true
      *             },
      *             review: {
      *                 enabled: true,
@@ -450,4 +480,159 @@ export declare class PaymentLinkClient {
      */
     addPayLinkFromBillLotNumber(lotNumber: string, request: Payabli.PayLinkDataOut, requestOptions?: PaymentLinkClient.RequestOptions): core.HttpResponsePromise<Payabli.PayabliApiResponsePaymentLinks>;
     private __addPayLinkFromBillLotNumber;
+    /**
+     * Partially updates a Pay Out payment link's content, expiration date, and/or status. Use this to modify the payment page configuration, extend or change the expiration, or cancel a link. Updating the expiration date of an expired link reactivates it to Active status.
+     *
+     * @param {string} paylinkId - ID for the payment link.
+     * @param {Payabli.PatchOutPaymentLinkRequest} request
+     * @param {PaymentLinkClient.RequestOptions} requestOptions - Request-specific configuration.
+     *
+     * @throws {@link Payabli.BadRequestError}
+     * @throws {@link Payabli.UnauthorizedError}
+     * @throws {@link Payabli.InternalServerError}
+     * @throws {@link Payabli.ServiceUnavailableError}
+     *
+     * @example
+     *     await client.paymentLink.patchOutPaymentLink("2325-XXXXXXX-90b1-4598-b6c7-44cdcbf495d7-1234", {
+     *         expirationDate: "2026-06-01T00:00:00Z",
+     *         status: "Active"
+     *     })
+     *
+     * @example
+     *     await client.paymentLink.patchOutPaymentLink("2325-XXXXXXX-90b1-4598-b6c7-44cdcbf495d7-1234", {
+     *         status: "Canceled"
+     *     })
+     *
+     * @example
+     *     await client.paymentLink.patchOutPaymentLink("2325-XXXXXXX-90b1-4598-b6c7-44cdcbf495d7-1234", {
+     *         billPageData: {
+     *             page: {
+     *                 description: "You have a payment waiting",
+     *                 enabled: true,
+     *                 header: "Vendor Payment",
+     *                 order: 0
+     *             },
+     *             paymentButton: {
+     *                 enabled: true,
+     *                 label: "Select Payment Method",
+     *                 order: 0
+     *             },
+     *             paymentMethods: {
+     *                 allMethodsChecked: true,
+     *                 allowMultipleMethods: true,
+     *                 defaultMethod: "ach",
+     *                 enabled: true,
+     *                 header: "Payment Methods",
+     *                 methods: {
+     *                     ach: true,
+     *                     check: true,
+     *                     vcard: true
+     *                 },
+     *                 order: 0,
+     *                 showPreviewVirtualCard: false
+     *             }
+     *         }
+     *     })
+     */
+    patchOutPaymentLink(paylinkId: string, request: Payabli.PatchOutPaymentLinkRequest, requestOptions?: PaymentLinkClient.RequestOptions): core.HttpResponsePromise<Payabli.PayabliApiResponsePaymentLinks>;
+    private __patchOutPaymentLink;
+    /**
+     * Updates the payment page content for a Pay Out payment link. Use this to change the branding, messaging, payment methods offered, or other page configuration.
+     *
+     * @param {string} paylinkId - ID for the payment link.
+     * @param {Payabli.PaymentPageRequestBodyOut} request
+     * @param {PaymentLinkClient.RequestOptions} requestOptions - Request-specific configuration.
+     *
+     * @throws {@link Payabli.BadRequestError}
+     * @throws {@link Payabli.UnauthorizedError}
+     * @throws {@link Payabli.InternalServerError}
+     * @throws {@link Payabli.ServiceUnavailableError}
+     *
+     * @example
+     *     await client.paymentLink.updatePayLinkOutFromId("2325-XXXXXXX-90b1-4598-b6c7-44cdcbf495d7-1234", {
+     *         contactUs: {
+     *             emailLabel: "Email",
+     *             enabled: true,
+     *             header: "Contact Us",
+     *             order: 0,
+     *             paymentIcons: true,
+     *             phoneLabel: "Phone"
+     *         },
+     *         logo: {
+     *             enabled: true,
+     *             order: 0
+     *         },
+     *         messageBeforePaying: {
+     *             enabled: true,
+     *             label: "Please review your payment details",
+     *             order: 0
+     *         },
+     *         notes: {
+     *             enabled: true,
+     *             header: "Additional Notes",
+     *             order: 0,
+     *             placeholder: "Enter any additional notes here",
+     *             value: ""
+     *         },
+     *         page: {
+     *             description: "Get paid securely",
+     *             enabled: true,
+     *             header: "Payment Page",
+     *             order: 0
+     *         },
+     *         paymentButton: {
+     *             enabled: true,
+     *             label: "Pay Now",
+     *             order: 0
+     *         },
+     *         paymentMethods: {
+     *             allMethodsChecked: true,
+     *             allowMultipleMethods: true,
+     *             defaultMethod: "vcard",
+     *             enabled: true,
+     *             header: "Payment Methods",
+     *             methods: {
+     *                 ach: true,
+     *                 check: true,
+     *                 vcard: true
+     *             },
+     *             order: 0,
+     *             showPreviewVirtualCard: true
+     *         },
+     *         review: {
+     *             enabled: true,
+     *             header: "Review Payment",
+     *             order: 0
+     *         },
+     *         settings: {
+     *             color: "#000000",
+     *             language: "en"
+     *         }
+     *     })
+     *
+     * @example
+     *     await client.paymentLink.updatePayLinkOutFromId("2325-XXXXXXX-90b1-4598-b6c7-44cdcbf495d7-1234", {
+     *         paymentMethods: {
+     *             allMethodsChecked: false,
+     *             allowMultipleMethods: true,
+     *             defaultMethod: "vcard",
+     *             enabled: true,
+     *             header: "Payment Methods",
+     *             methods: {
+     *                 ach: true,
+     *                 check: false,
+     *                 vcard: true
+     *             },
+     *             order: 0,
+     *             showPreviewVirtualCard: true
+     *         },
+     *         paymentButton: {
+     *             enabled: true,
+     *             label: "Choose Payment Method",
+     *             order: 0
+     *         }
+     *     })
+     */
+    updatePayLinkOutFromId(paylinkId: string, request: Payabli.PaymentPageRequestBodyOut, requestOptions?: PaymentLinkClient.RequestOptions): core.HttpResponsePromise<Payabli.PayabliApiResponsePaymentLinks>;
+    private __updatePayLinkOutFromId;
 }