@payabli/sdk-node 0.0.129 → 0.0.131

package/dist/esm/api/resources/moneyOut/client/Client.mjs

@@ -157,18 +157,13 @@ export class MoneyOutClient {
         return __awaiter(this, void 0, void 0, function* () {
             var _a, _b, _c, _d, _e, _f, _g, _h, _j;
             const { allowDuplicatedBills, doNotCreateBills, forceVendorCreation, idempotencyKey, body: _body } = request;
-            const _queryParams = {};
-            if (allowDuplicatedBills != null) {
-                _queryParams.allowDuplicatedBills = allowDuplicatedBills.toString();
-            }
-            if (doNotCreateBills != null) {
-                _queryParams.doNotCreateBills = doNotCreateBills.toString();
-            }
-            if (forceVendorCreation != null) {
-                _queryParams.forceVendorCreation = forceVendorCreation.toString();
-            }
+            const _queryParams = {
+                allowDuplicatedBills,
+                doNotCreateBills,
+                forceVendorCreation,
+            };
             const _authRequest = yield this._options.authProvider.getAuthRequest();
-            const _headers = mergeHeaders(_authRequest.headers, (_a = this._options) === null || _a === void 0 ? void 0 : _a.headers, mergeOnlyDefinedHeaders({ idempotencyKey: idempotencyKey != null ? idempotencyKey : undefined }), requestOptions === null || requestOptions === void 0 ? void 0 : requestOptions.headers);
+            const _headers = mergeHeaders(_authRequest.headers, (_a = this._options) === null || _a === void 0 ? void 0 : _a.headers, 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, "MoneyOut/authorize"),
                 method: "POST",
@@ -405,7 +400,7 @@ export class MoneyOutClient {
             var _a, _b, _c, _d, _e, _f, _g, _h, _j;
             const { idempotencyKey, body: _body } = request;
             const _authRequest = yield this._options.authProvider.getAuthRequest();
-            const _headers = mergeHeaders(_authRequest.headers, (_a = this._options) === null || _a === void 0 ? void 0 : _a.headers, mergeOnlyDefinedHeaders({ idempotencyKey: idempotencyKey != null ? idempotencyKey : undefined }), requestOptions === null || requestOptions === void 0 ? void 0 : requestOptions.headers);
+            const _headers = mergeHeaders(_authRequest.headers, (_a = this._options) === null || _a === void 0 ? void 0 : _a.headers, 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, "MoneyOut/captureAll"),
                 method: "POST",
@@ -467,7 +462,7 @@ export class MoneyOutClient {
             var _a, _b, _c, _d, _e, _f, _g, _h, _j;
             const { idempotencyKey } = request;
             const _authRequest = yield this._options.authProvider.getAuthRequest();
-            const _headers = mergeHeaders(_authRequest.headers, (_a = this._options) === null || _a === void 0 ? void 0 : _a.headers, mergeOnlyDefinedHeaders({ idempotencyKey: idempotencyKey != null ? idempotencyKey : undefined }), requestOptions === null || requestOptions === void 0 ? void 0 : requestOptions.headers);
+            const _headers = mergeHeaders(_authRequest.headers, (_a = this._options) === null || _a === void 0 ? void 0 : _a.headers, 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, `MoneyOut/capture/${core.url.encodePathParam(referenceId)}`),
                 method: "GET",
@@ -747,4 +742,79 @@ export class MoneyOutClient {
             return handleNonStatusCodeError(_response.error, _response.rawResponse, "GET", "/MoneyOut/checkimage/{assetName}");
         });
     }
+    /**
+     * Updates the status of a processed check payment transaction. This endpoint handles the status transition, updates related bills, creates audit events, and triggers notifications.
+     *
+     * The transaction must meet all of the following criteria:
+     * - **Status**: Must be in Processing or Processed status.
+     * - **Payment method**: Must be a check payment method.
+     *
+     * ### Allowed status values
+     *
+     * | Value | Status | Description |
+     * |-------|--------|-------------|
+     * | `0` | Cancelled/Voided | Cancels the check transaction. Reverts associated bills to their previous state (Approved or Active), creates "Cancelled" events, and sends a `payout_transaction_voidedcancelled` notification if the notification is enabled. |
+     * | `5` | Paid | Marks the check transaction as paid. Updates associated bills to "Paid" status, creates "Paid" events, and sends a `payout_transaction_paid` notification if the notification is enabled. |
+     *
+     * @param {string} transId - The Payabli transaction ID for the check payment.
+     * @param {Payabli.AllowedCheckPaymentStatus} checkPaymentStatus - The new status to apply to the check transaction. To mark a check as `Paid`, send 5. To mark a check as `Cancelled`, send 0.
+     * @param {MoneyOutClient.RequestOptions} requestOptions - Request-specific configuration.
+     *
+     * @throws {@link Payabli.BadRequestError}
+     * @throws {@link Payabli.UnauthorizedError}
+     * @throws {@link Payabli.InternalServerError}
+     * @throws {@link Payabli.ServiceUnavailableError}
+     *
+     * @example
+     *     await client.moneyOut.updateCheckPaymentStatus("TRANS123456", "5")
+     *
+     * @example
+     *     await client.moneyOut.updateCheckPaymentStatus("TRANS123456", "0")
+     */
+    updateCheckPaymentStatus(transId, checkPaymentStatus, requestOptions) {
+        return core.HttpResponsePromise.fromPromise(this.__updateCheckPaymentStatus(transId, checkPaymentStatus, requestOptions));
+    }
+    __updateCheckPaymentStatus(transId, checkPaymentStatus, requestOptions) {
+        return __awaiter(this, void 0, void 0, function* () {
+            var _a, _b, _c, _d, _e, _f, _g, _h, _j;
+            const _authRequest = yield this._options.authProvider.getAuthRequest();
+            const _headers = mergeHeaders(_authRequest.headers, (_a = this._options) === null || _a === void 0 ? void 0 : _a.headers, 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, `MoneyOut/status/${core.url.encodePathParam(transId)}/${core.url.encodePathParam(checkPaymentStatus)}`),
+                method: "PATCH",
+                headers: _headers,
+                queryParameters: requestOptions === null || requestOptions === void 0 ? void 0 : requestOptions.queryParams,
+                timeoutMs: ((_f = (_d = requestOptions === null || requestOptions === void 0 ? void 0 : requestOptions.timeoutInSeconds) !== null && _d !== void 0 ? _d : (_e = this._options) === null || _e === void 0 ? void 0 : _e.timeoutInSeconds) !== null && _f !== void 0 ? _f : 60) * 1000,
+                maxRetries: (_g = requestOptions === null || requestOptions === void 0 ? void 0 : requestOptions.maxRetries) !== null && _g !== void 0 ? _g : (_h = this._options) === null || _h === void 0 ? void 0 : _h.maxRetries,
+                abortSignal: requestOptions === null || requestOptions === void 0 ? void 0 : requestOptions.abortSignal,
+                fetchFn: (_j = this._options) === null || _j === void 0 ? void 0 : _j.fetch,
+                logging: this._options.logging,
+            });
+            if (_response.ok) {
+                return {
+                    data: _response.body,
+                    rawResponse: _response.rawResponse,
+                };
+            }
+            if (_response.error.reason === "status-code") {
+                switch (_response.error.statusCode) {
+                    case 400:
+                        throw new Payabli.BadRequestError(_response.error.body, _response.rawResponse);
+                    case 401:
+                        throw new Payabli.UnauthorizedError(_response.error.body, _response.rawResponse);
+                    case 500:
+                        throw new Payabli.InternalServerError(_response.error.body, _response.rawResponse);
+                    case 503:
+                        throw new Payabli.ServiceUnavailableError(_response.error.body, _response.rawResponse);
+                    default:
+                        throw new errors.PayabliError({
+                            statusCode: _response.error.statusCode,
+                            body: _response.error.body,
+                            rawResponse: _response.rawResponse,
+                        });
+                }
+            }
+            return handleNonStatusCodeError(_response.error, _response.rawResponse, "PATCH", "/MoneyOut/status/{transId}/{checkPaymentStatus}");
+        });
+    }
 }

package/dist/esm/api/resources/moneyOutTypes/types/AllowedCheckPaymentStatus.d.mts

@@ -0,0 +1,10 @@
+/**
+ * The new status to apply to a check payment transaction.
+ * - `0`: Cancelled/Voided — Cancels the check transaction.
+ * - `5`: Paid — Marks the check transaction as paid.
+ */
+export declare const AllowedCheckPaymentStatus: {
+    readonly Cancelled: "0";
+    readonly Paid: "5";
+};
+export type AllowedCheckPaymentStatus = (typeof AllowedCheckPaymentStatus)[keyof typeof AllowedCheckPaymentStatus];

package/dist/esm/api/resources/moneyOutTypes/types/AllowedCheckPaymentStatus.mjs

@@ -0,0 +1,10 @@
+// This file was auto-generated by Fern from our API Definition.
+/**
+ * The new status to apply to a check payment transaction.
+ * - `0`: Cancelled/Voided — Cancels the check transaction.
+ * - `5`: Paid — Marks the check transaction as paid.
+ */
+export const AllowedCheckPaymentStatus = {
+    Cancelled: "0",
+    Paid: "5",
+};

package/dist/esm/api/resources/moneyOutTypes/types/AuthorizePaymentMethod.d.mts

@@ -11,17 +11,17 @@ export interface AuthorizePaymentMethod {
     /** Payment method type - "managed", "vcard", "check", or "ach" */
     method: string;
     /** Account holder name for ACH payments. Required when method is "ach" and not using `storedMethodId`. */
-    achHolder?: string;
+    achHolder?: string | undefined;
     /** Bank routing number for ACH payments. Required when method is "ach" and not using `storedMethodId`. */
-    achRouting?: string;
+    achRouting?: string | undefined;
     /** Bank account number for ACH payments. Required when method is "ach" and not using `storedMethodId`. */
-    achAccount?: string;
+    achAccount?: string | undefined;
     /** Account type for ACH payments ("checking" or "savings"). Required when method is "ach" and not using `storedMethodId`. */
-    achAccountType?: string;
-    achCode?: Payabli.AchSecCode;
-    achHolderType?: Payabli.AchHolderType;
+    achAccountType?: string | undefined;
+    achCode?: Payabli.AchSecCode | undefined;
+    achHolderType?: Payabli.AchHolderType | undefined;
     /** ID of the stored ACH payment method. Only applicable when method is `ach`. Use this to reference a previously saved ACH method instead of providing bank details directly. */
-    storedMethodId?: string;
-    initiator?: Payabli.Initiator;
-    storedMethodUsageType?: Payabli.StoredMethodUsageType;
+    storedMethodId?: string | undefined;
+    initiator?: Payabli.Initiator | undefined;
+    storedMethodUsageType?: Payabli.StoredMethodUsageType | undefined;
 }

package/dist/esm/api/resources/moneyOutTypes/types/AuthorizePayoutBody.d.mts

@@ -1,9 +1,9 @@
 import type * as Payabli from "../../../index.mjs";
 export interface AuthorizePayoutBody {
     entryPoint: Payabli.Entrypointfield;
-    source?: Payabli.Source;
-    orderId?: Payabli.OrderId;
-    orderDescription?: Payabli.Orderdescription;
+    source?: Payabli.Source | undefined;
+    orderId?: Payabli.OrderId | undefined;
+    orderDescription?: Payabli.Orderdescription | undefined;
     paymentMethod: Payabli.AuthorizePaymentMethod;
     /** Object containing payment details. */
     paymentDetails: AuthorizePayoutBody.PaymentDetails;
@@ -11,91 +11,91 @@ export interface AuthorizePayoutBody {
     vendorData: AuthorizePayoutBody.VendorData;
     /** Array of bills associated to the transaction */
     invoiceData: AuthorizePayoutBody.InvoiceData.Item[];
-    accountId?: Payabli.Accountid;
-    subdomain?: Payabli.Subdomain;
-    subscriptionId?: Payabli.Subscriptionid;
+    accountId?: Payabli.Accountid | undefined;
+    subdomain?: Payabli.Subdomain | undefined;
+    subscriptionId?: Payabli.Subscriptionid | undefined;
 }
 export declare namespace AuthorizePayoutBody {
     /**
      * Object containing payment details.
      */
     interface PaymentDetails {
-        checkNumber?: Payabli.VendorCheckNumber;
+        checkNumber?: Payabli.VendorCheckNumber | undefined;
         /** Currency code ISO-4217. If no code is provided, then the currency in the paypoint setting is used. Default is **USD**. */
-        currency?: string;
+        currency?: string | undefined;
         /** Service fee to be deducted from the total amount. This amount must be a number, percentages aren't accepted. If you are using a percentage-based fee schedule, you must calculate the value manually. */
-        serviceFee?: number;
+        serviceFee?: number | undefined;
         /** Total amount to be charged. If a service fee is included, then this amount should include the service fee. */
-        totalAmount?: number;
+        totalAmount?: number | undefined;
         /** Indicates whether the payout should be bundled into a single transaction or processed separately. If set to `true`, each bill will be processed as a separate payout. If `false` or not provided, then multiple bills will be paid with a single payout. */
-        unbundled?: boolean;
+        unbundled?: boolean | undefined;
     }
     /**
      * Object containing vendor data.
      */
     interface VendorData {
-        vendorNumber?: Payabli.VendorNumber;
-        name1?: Payabli.VendorName1;
-        name2?: Payabli.VendorName2;
-        ein?: Payabli.VendorEin;
+        vendorNumber?: Payabli.VendorNumber | undefined;
+        name1?: Payabli.VendorName1 | undefined;
+        name2?: Payabli.VendorName2 | undefined;
+        ein?: Payabli.VendorEin | undefined;
         phone?: Payabli.VendorPhone | undefined;
-        email?: Payabli.Email;
-        address1?: Payabli.AddressNullable;
-        city?: string;
-        state?: string;
-        zip?: string;
-        country?: string;
-        mcc?: Payabli.Mcc;
+        email?: Payabli.Email | undefined;
+        address1?: Payabli.AddressNullable | undefined;
+        city?: string | undefined;
+        state?: string | undefined;
+        zip?: string | undefined;
+        country?: string | undefined;
+        mcc?: Payabli.Mcc | undefined;
         contacts?: Payabli.ContactsField | undefined;
-        billingData?: VendorData.BillingData;
-        vendorStatus?: Payabli.Vendorstatus;
-        remitAddress1?: Payabli.Remitaddress1;
-        remitAddress2?: Payabli.Remitaddress2;
-        remitCity?: Payabli.Remitcity;
-        remitState?: Payabli.Remitstate;
-        remitZip?: Payabli.Remitzip;
-        remitCountry?: Payabli.Remitcountry;
-        customerVendorAccount?: string;
-        customField1?: string;
-        customField2?: string;
-        additionalData?: Payabli.AdditionalData;
-        address2?: Payabli.AddressAddtlNullable;
-        internalReferenceId?: number;
-        locationCode?: Payabli.LocationCode;
-        payeeName1?: Payabli.PayeeName;
-        payeeName2?: Payabli.PayeeName;
-        paymentMethod?: Payabli.VendorPaymentMethod;
-        vendorId?: Payabli.Vendorid;
+        billingData?: VendorData.BillingData | undefined;
+        vendorStatus?: Payabli.Vendorstatus | undefined;
+        remitAddress1?: Payabli.Remitaddress1 | undefined;
+        remitAddress2?: Payabli.Remitaddress2 | undefined;
+        remitCity?: Payabli.Remitcity | undefined;
+        remitState?: Payabli.Remitstate | undefined;
+        remitZip?: Payabli.Remitzip | undefined;
+        remitCountry?: Payabli.Remitcountry | undefined;
+        customerVendorAccount?: string | undefined;
+        customField1?: string | undefined;
+        customField2?: string | undefined;
+        additionalData?: Payabli.AdditionalData | undefined;
+        address2?: Payabli.AddressAddtlNullable | undefined;
+        internalReferenceId?: number | undefined;
+        locationCode?: Payabli.LocationCode | undefined;
+        payeeName1?: Payabli.PayeeName | undefined;
+        payeeName2?: Payabli.PayeeName | undefined;
+        paymentMethod?: Payabli.VendorPaymentMethod | undefined;
+        vendorId?: Payabli.Vendorid | undefined;
     }
     namespace VendorData {
         /**
          * Object containing vendor's bank information. This object is deprecated for this endpoint. Use the `paymentMethod` object in payout authorize requests instead.
          */
         interface BillingData {
-            bankName?: Payabli.BankName;
-            routingAccount?: Payabli.RoutingAccount;
-            accountNumber?: Payabli.AccountNumber;
-            typeAccount?: Payabli.TypeAccount;
-            bankAccountHolderName?: Payabli.BankAccountHolderName;
+            bankName?: Payabli.BankName | undefined;
+            routingAccount?: Payabli.RoutingAccount | undefined;
+            accountNumber?: Payabli.AccountNumber | undefined;
+            typeAccount?: Payabli.TypeAccount | undefined;
+            bankAccountHolderName?: Payabli.BankAccountHolderName | undefined;
         }
     }
     type InvoiceData = InvoiceData.Item[];
     namespace InvoiceData {
         interface Item {
-            invoiceNumber?: Payabli.InvoiceNumber;
-            netAmount?: Payabli.NetAmountstring;
+            invoiceNumber?: Payabli.InvoiceNumber | undefined;
+            netAmount?: Payabli.NetAmountstring | undefined;
             /** Invoice date in any of the accepted formats: YYYY-MM-DD, MM/DD/YYYY. */
             invoiceDate?: Payabli.Datenullable | undefined;
             /** Invoice due date in any of the accepted formats: YYYY-MM-DD, MM/DD/YYYY. */
             dueDate?: Payabli.Datenullable | undefined;
-            comments?: Payabli.Comments;
-            lotNumber?: Payabli.LotNumber;
-            billId?: Payabli.BillId;
+            comments?: Payabli.Comments | undefined;
+            lotNumber?: Payabli.LotNumber | undefined;
+            billId?: Payabli.BillId | undefined;
             discount?: Payabli.Discount | undefined;
-            terms?: Payabli.Terms;
-            accountingField1?: Payabli.AccountingField;
-            accountingField2?: Payabli.AccountingField;
-            additionalData?: Payabli.AdditionalDataString;
+            terms?: Payabli.Terms | undefined;
+            accountingField1?: Payabli.AccountingField | undefined;
+            accountingField2?: Payabli.AccountingField | undefined;
+            additionalData?: Payabli.AdditionalDataString | undefined;
             attachments?: Payabli.Attachments | undefined;
         }
     }

package/dist/esm/api/resources/moneyOutTypes/types/CaptureAllOutResponse.d.mts

@@ -1,10 +1,10 @@
 import type * as Payabli from "../../../index.mjs";
 export interface CaptureAllOutResponse {
-    isSuccess?: Payabli.IsSuccess;
-    pageIdentifier?: Payabli.PageIdentifier;
-    responseCode?: Payabli.Responsecode;
+    isSuccess?: Payabli.IsSuccess | undefined;
+    pageIdentifier?: Payabli.PageIdentifier | undefined;
+    responseCode?: Payabli.Responsecode | undefined;
     /** Array of objects describing the transactions. */
-    responseData?: CaptureAllOutResponse.ResponseData.Item[];
+    responseData?: CaptureAllOutResponse.ResponseData.Item[] | undefined;
     responseText: Payabli.ResponseText;
 }
 export declare namespace CaptureAllOutResponse {
@@ -12,15 +12,15 @@ export declare namespace CaptureAllOutResponse {
     namespace ResponseData {
         interface Item {
             /** Internal unique Id of vendor owner of transaction. Returns `0` if the transaction wasn't assigned to an existing vendor or no vendor was created. */
-            CustomerId?: Payabli.Customeridtrans;
-            ReferenceId?: Payabli.Referenceidtrans;
-            ResultCode?: Payabli.ResultCode;
+            CustomerId?: Payabli.Customeridtrans | undefined;
+            ReferenceId?: Payabli.Referenceidtrans | undefined;
+            ResultCode?: Payabli.ResultCode | undefined;
             /**
              * Text describing the result.
              * If `ResultCode`` = 1, returns 'Authorized'.
              * If `ResultCode` = 2 or 3, this contains the cause of the decline.
              */
-            ResultText?: Payabli.Resulttext;
+            ResultText?: Payabli.Resulttext | undefined;
         }
     }
 }

package/dist/esm/api/resources/moneyOutTypes/types/OperationResult.d.mts

@@ -1,6 +1,6 @@
 export interface OperationResult {
     /** Message describing the result. If the virtual card link was sent successfully, this contains the email address to which the link was sent. */
-    message?: string;
+    message?: string | undefined;
     /** Indicates whether the operation was successful. */
     success: boolean;
 }