@payabli/sdk-node 0.0.131 → 0.0.133

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

@@ -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;
 }