@wix/auto_sdk_payments_payouts 1.0.0

package/build/cjs/schemas.js

@@ -0,0 +1,229 @@
+"use strict";
+var __create = Object.create;
+var __defProp = Object.defineProperty;
+var __getOwnPropDesc = Object.getOwnPropertyDescriptor;
+var __getOwnPropNames = Object.getOwnPropertyNames;
+var __getProtoOf = Object.getPrototypeOf;
+var __hasOwnProp = Object.prototype.hasOwnProperty;
+var __export = (target, all) => {
+  for (var name in all)
+    __defProp(target, name, { get: all[name], enumerable: true });
+};
+var __copyProps = (to, from, except, desc) => {
+  if (from && typeof from === "object" || typeof from === "function") {
+    for (let key of __getOwnPropNames(from))
+      if (!__hasOwnProp.call(to, key) && key !== except)
+        __defProp(to, key, { get: () => from[key], enumerable: !(desc = __getOwnPropDesc(from, key)) || desc.enumerable });
+  }
+  return to;
+};
+var __toESM = (mod, isNodeMode, target) => (target = mod != null ? __create(__getProtoOf(mod)) : {}, __copyProps(
+  // If the importer is in node compatibility mode or this is not an ESM
+  // file that has been converted to a CommonJS file using a Babel-
+  // compatible transform (i.e. "__esModule" has not been set), then set
+  // "default" to the CommonJS "module.exports" for node compatibility.
+  isNodeMode || !mod || !mod.__esModule ? __defProp(target, "default", { value: mod, enumerable: true }) : target,
+  mod
+));
+var __toCommonJS = (mod) => __copyProps(__defProp({}, "__esModule", { value: true }), mod);
+
+// schemas.ts
+var schemas_exports = {};
+__export(schemas_exports, {
+  GetPayoutRequest: () => GetPayoutRequest,
+  GetPayoutResponse: () => GetPayoutResponse,
+  ListPayoutsRequest: () => ListPayoutsRequest,
+  ListPayoutsResponse: () => ListPayoutsResponse
+});
+module.exports = __toCommonJS(schemas_exports);
+
+// src/payments-payouts-v4-payout-payouts.schemas.ts
+var z = __toESM(require("zod"));
+var ListPayoutsRequest = z.object({
+  accountId: z.string().describe("ID of the Wix Payments account whose payouts to list.").regex(
+    /^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$/,
+    "Must be a valid GUID"
+  ),
+  options: z.object({
+    accountProfileId: z.string().describe(
+      "Optional. When omitted, payouts across all profiles of the account are returned.\nWhen set, only payouts belonging to the specified account profile are returned."
+    ).regex(
+      /^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$/,
+      "Must be a valid GUID"
+    ).optional().nullable(),
+    createdBefore: z.date().describe(
+      "Optional. Returns only payouts created before this timestamp."
+    ).optional().nullable(),
+    createdAfter: z.date().describe(
+      "Optional. Returns only payouts created after this timestamp."
+    ).optional().nullable(),
+    sort: z.object({
+      fieldName: z.string().describe("Name of the field to sort by.").max(512).optional(),
+      order: z.enum(["ASC", "DESC"]).optional()
+    }).describe(
+      "Optional. Sorting. Only `created_date` is supported; requests sorting by any other field are rejected with INVALID_ARGUMENT."
+    ).optional(),
+    paging: z.object({
+      limit: z.number().int().describe("Number of items to load.").min(0).optional().nullable(),
+      offset: z.number().int().describe("Number of items to skip in the current sort order.").min(0).optional().nullable()
+    }).describe("Optional paging. Offset-based.").optional()
+  }).optional()
+});
+var ListPayoutsResponse = z.object({
+  payouts: z.array(
+    z.object({
+      _id: z.string().describe("Unique identifier of the payout. Immutable.").regex(
+        /^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$/,
+        "Must be a valid GUID"
+      ).optional(),
+      accountId: z.string().describe("ID of the Wix Payments account that owns this payout.").regex(
+        /^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$/,
+        "Must be a valid GUID"
+      ).optional(),
+      accountProfileId: z.string().describe(
+        "ID of the Wix Payments account profile this payout belongs to.\nA Wix Payments account has one or more profiles; each profile has its own\nbalance and its own payouts. Most merchants have a single profile."
+      ).regex(
+        /^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$/,
+        "Must be a valid GUID"
+      ).optional(),
+      _createdDate: z.date().describe(
+        "Date the payout was created, in advance of the underlying transfer being\ninitiated at the bank rail. Once initiated, the funds typically reach the\nmerchant's bank account within 3-5 business days, depending on the receiving bank."
+      ).optional().nullable(),
+      amount: z.object({
+        value: z.string().describe(
+          "Monetary amount. Decimal string with a period as a decimal separator (e.g., 3.99). Optionally, a single (-), to indicate that the amount is negative."
+        ).optional(),
+        currency: z.string().describe(
+          "Currency code. Must be valid ISO 4217 currency code (e.g., USD)."
+        ).optional(),
+        formattedValue: z.string().describe(
+          "Monetary amount. Decimal string in local format (e.g., 1 000,30). Optionally, a single (-), to indicate that the amount is negative."
+        ).optional().nullable()
+      }).describe(
+        "Amount of funds transferred to the merchant's bank account."
+      ).optional(),
+      status: z.enum(["UNKNOWN", "SENT", "FAILED"]).describe(
+        'Lifecycle status of the payout. `SENT` means the bank rail accepted the transfer\nfor delivery; `FAILED` means the receiving bank rejected the transfer. The rail\ndoes not provide a delivery acknowledgement, so `SENT` is not the same as\n"delivered to the merchant" \u2014 see the per-value documentation on `PayoutStatus`.'
+      ).optional(),
+      estimatedArrivalDateV2: z.string().describe(
+        "Estimated date for when the funds should arrive at the merchant's bank, returned\nby the underlying bank rail when available. This is a prediction, not a guarantee \u2014\nactual arrival depends on the receiving bank's processing and may be later."
+      ).optional().nullable(),
+      failureReason: z.object({
+        code: z.enum([
+          "GENERIC_PAYOUT_FAILURE",
+          "ACCOUNT_CLOSED",
+          "ACCOUNT_FROZEN",
+          "BANK_ACCOUNT_RESTRICTED",
+          "BANK_OWNERSHIP_CHANGED",
+          "COULD_NOT_PROCESS",
+          "DEBIT_NOT_AUTHORIZED",
+          "INCORRECT_ACCOUNT_HOLDER_NAME",
+          "INVALID_ACCOUNT_DETAILS_CITY",
+          "INVALID_ACCOUNT_NUMBER",
+          "INVALID_CURRENCY",
+          "INVALID_ROUTING_NUMBER",
+          "INVALID_SORT_CODE",
+          "NO_ACCOUNT",
+          "TECHNICAL_ERROR"
+        ]).describe("Why the bank rail rejected the transfer.").optional()
+      }).describe(
+        "Set only when `status` is `FAILED`. Indicates why the bank rail rejected the transfer.\nThe codes are a Wix Payments unified set; the original provider-specific reason is not exposed."
+      ).optional(),
+      bankTransferReference: z.string().describe(
+        "Reference returned by the bank rail (e.g. ACH trace number, SEPA reference) once\nthe transfer is initiated. Use it for reconciliation against the merchant's bank\nstatement. Empty when the rail has not yet returned a reference."
+      ).max(500).optional().nullable(),
+      cashAdvanceIncluded: z.boolean().describe(
+        "`true` if the payout's `amount` includes funds that originate from a Wix Capital\nadvance the merchant has taken out. `false` if the amount is composed only of\nregular sales proceeds."
+      ).optional()
+    })
+  ).optional(),
+  metadata: z.object({
+    count: z.number().int().describe("Number of items returned in the response.").optional().nullable(),
+    offset: z.number().int().describe("Offset that was requested.").optional().nullable(),
+    total: z.number().int().describe("Total number of items that match the query.").optional().nullable(),
+    tooManyToCount: z.boolean().describe(
+      "Flag that indicates the server failed to calculate the `total` field."
+    ).optional().nullable()
+  }).describe("Paging metadata.").optional()
+});
+var GetPayoutRequest = z.object({
+  payoutId: z.string().describe("ID of the payout to retrieve.").regex(
+    /^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$/,
+    "Must be a valid GUID"
+  ),
+  accountId: z.string().describe("ID of the Wix Payments account the payout belongs to.").regex(
+    /^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$/,
+    "Must be a valid GUID"
+  )
+});
+var GetPayoutResponse = z.object({
+  _id: z.string().describe("Unique identifier of the payout. Immutable.").regex(
+    /^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$/,
+    "Must be a valid GUID"
+  ).optional(),
+  accountId: z.string().describe("ID of the Wix Payments account that owns this payout.").regex(
+    /^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$/,
+    "Must be a valid GUID"
+  ).optional(),
+  accountProfileId: z.string().describe(
+    "ID of the Wix Payments account profile this payout belongs to.\nA Wix Payments account has one or more profiles; each profile has its own\nbalance and its own payouts. Most merchants have a single profile."
+  ).regex(
+    /^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$/,
+    "Must be a valid GUID"
+  ).optional(),
+  _createdDate: z.date().describe(
+    "Date the payout was created, in advance of the underlying transfer being\ninitiated at the bank rail. Once initiated, the funds typically reach the\nmerchant's bank account within 3-5 business days, depending on the receiving bank."
+  ).optional().nullable(),
+  amount: z.object({
+    value: z.string().describe(
+      "Monetary amount. Decimal string with a period as a decimal separator (e.g., 3.99). Optionally, a single (-), to indicate that the amount is negative."
+    ).optional(),
+    currency: z.string().describe(
+      "Currency code. Must be valid ISO 4217 currency code (e.g., USD)."
+    ).optional(),
+    formattedValue: z.string().describe(
+      "Monetary amount. Decimal string in local format (e.g., 1 000,30). Optionally, a single (-), to indicate that the amount is negative."
+    ).optional().nullable()
+  }).describe("Amount of funds transferred to the merchant's bank account.").optional(),
+  status: z.enum(["UNKNOWN", "SENT", "FAILED"]).describe(
+    'Lifecycle status of the payout. `SENT` means the bank rail accepted the transfer\nfor delivery; `FAILED` means the receiving bank rejected the transfer. The rail\ndoes not provide a delivery acknowledgement, so `SENT` is not the same as\n"delivered to the merchant" \u2014 see the per-value documentation on `PayoutStatus`.'
+  ).optional(),
+  estimatedArrivalDateV2: z.string().describe(
+    "Estimated date for when the funds should arrive at the merchant's bank, returned\nby the underlying bank rail when available. This is a prediction, not a guarantee \u2014\nactual arrival depends on the receiving bank's processing and may be later."
+  ).optional().nullable(),
+  failureReason: z.object({
+    code: z.enum([
+      "GENERIC_PAYOUT_FAILURE",
+      "ACCOUNT_CLOSED",
+      "ACCOUNT_FROZEN",
+      "BANK_ACCOUNT_RESTRICTED",
+      "BANK_OWNERSHIP_CHANGED",
+      "COULD_NOT_PROCESS",
+      "DEBIT_NOT_AUTHORIZED",
+      "INCORRECT_ACCOUNT_HOLDER_NAME",
+      "INVALID_ACCOUNT_DETAILS_CITY",
+      "INVALID_ACCOUNT_NUMBER",
+      "INVALID_CURRENCY",
+      "INVALID_ROUTING_NUMBER",
+      "INVALID_SORT_CODE",
+      "NO_ACCOUNT",
+      "TECHNICAL_ERROR"
+    ]).describe("Why the bank rail rejected the transfer.").optional()
+  }).describe(
+    "Set only when `status` is `FAILED`. Indicates why the bank rail rejected the transfer.\nThe codes are a Wix Payments unified set; the original provider-specific reason is not exposed."
+  ).optional(),
+  bankTransferReference: z.string().describe(
+    "Reference returned by the bank rail (e.g. ACH trace number, SEPA reference) once\nthe transfer is initiated. Use it for reconciliation against the merchant's bank\nstatement. Empty when the rail has not yet returned a reference."
+  ).max(500).optional().nullable(),
+  cashAdvanceIncluded: z.boolean().describe(
+    "`true` if the payout's `amount` includes funds that originate from a Wix Capital\nadvance the merchant has taken out. `false` if the amount is composed only of\nregular sales proceeds."
+  ).optional()
+});
+// Annotate the CommonJS export names for ESM import in node:
+0 && (module.exports = {
+  GetPayoutRequest,
+  GetPayoutResponse,
+  ListPayoutsRequest,
+  ListPayoutsResponse
+});
+//# sourceMappingURL=schemas.js.map

package/build/cjs/schemas.js.map

@@ -0,0 +1 @@
+{"version":3,"sources":["../../schemas.ts","../../src/payments-payouts-v4-payout-payouts.schemas.ts"],"sourcesContent":["export * from './src/payments-payouts-v4-payout-payouts.schemas.js';\n","import * as z from 'zod';\n\nexport const ListPayoutsRequest = z.object({\n  accountId: z\n    .string()\n    .describe('ID of the Wix Payments account whose payouts to list.')\n    .regex(\n      /^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$/,\n      'Must be a valid GUID'\n    ),\n  options: z\n    .object({\n      accountProfileId: z\n        .string()\n        .describe(\n          'Optional. When omitted, payouts across all profiles of the account are returned.\\nWhen set, only payouts belonging to the specified account profile are returned.'\n        )\n        .regex(\n          /^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$/,\n          'Must be a valid GUID'\n        )\n        .optional()\n        .nullable(),\n      createdBefore: z\n        .date()\n        .describe(\n          'Optional. Returns only payouts created before this timestamp.'\n        )\n        .optional()\n        .nullable(),\n      createdAfter: z\n        .date()\n        .describe(\n          'Optional. Returns only payouts created after this timestamp.'\n        )\n        .optional()\n        .nullable(),\n      sort: z\n        .object({\n          fieldName: z\n            .string()\n            .describe('Name of the field to sort by.')\n            .max(512)\n            .optional(),\n          order: z.enum(['ASC', 'DESC']).optional(),\n        })\n        .describe(\n          'Optional. Sorting. Only `created_date` is supported; requests sorting by any other field are rejected with INVALID_ARGUMENT.'\n        )\n        .optional(),\n      paging: z\n        .object({\n          limit: z\n            .number()\n            .int()\n            .describe('Number of items to load.')\n            .min(0)\n            .optional()\n            .nullable(),\n          offset: z\n            .number()\n            .int()\n            .describe('Number of items to skip in the current sort order.')\n            .min(0)\n            .optional()\n            .nullable(),\n        })\n        .describe('Optional paging. Offset-based.')\n        .optional(),\n    })\n    .optional(),\n});\nexport const ListPayoutsResponse = z.object({\n  payouts: z\n    .array(\n      z.object({\n        _id: z\n          .string()\n          .describe('Unique identifier of the payout. Immutable.')\n          .regex(\n            /^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$/,\n            'Must be a valid GUID'\n          )\n          .optional(),\n        accountId: z\n          .string()\n          .describe('ID of the Wix Payments account that owns this payout.')\n          .regex(\n            /^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$/,\n            'Must be a valid GUID'\n          )\n          .optional(),\n        accountProfileId: z\n          .string()\n          .describe(\n            'ID of the Wix Payments account profile this payout belongs to.\\nA Wix Payments account has one or more profiles; each profile has its own\\nbalance and its own payouts. Most merchants have a single profile.'\n          )\n          .regex(\n            /^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$/,\n            'Must be a valid GUID'\n          )\n          .optional(),\n        _createdDate: z\n          .date()\n          .describe(\n            \"Date the payout was created, in advance of the underlying transfer being\\ninitiated at the bank rail. Once initiated, the funds typically reach the\\nmerchant's bank account within 3-5 business days, depending on the receiving bank.\"\n          )\n          .optional()\n          .nullable(),\n        amount: z\n          .object({\n            value: z\n              .string()\n              .describe(\n                'Monetary amount. Decimal string with a period as a decimal separator (e.g., 3.99). Optionally, a single (-), to indicate that the amount is negative.'\n              )\n              .optional(),\n            currency: z\n              .string()\n              .describe(\n                'Currency code. Must be valid ISO 4217 currency code (e.g., USD).'\n              )\n              .optional(),\n            formattedValue: z\n              .string()\n              .describe(\n                'Monetary amount. Decimal string in local format (e.g., 1 000,30). Optionally, a single (-), to indicate that the amount is negative.'\n              )\n              .optional()\n              .nullable(),\n          })\n          .describe(\n            \"Amount of funds transferred to the merchant's bank account.\"\n          )\n          .optional(),\n        status: z\n          .enum(['UNKNOWN', 'SENT', 'FAILED'])\n          .describe(\n            'Lifecycle status of the payout. `SENT` means the bank rail accepted the transfer\\nfor delivery; `FAILED` means the receiving bank rejected the transfer. The rail\\ndoes not provide a delivery acknowledgement, so `SENT` is not the same as\\n\"delivered to the merchant\" — see the per-value documentation on `PayoutStatus`.'\n          )\n          .optional(),\n        estimatedArrivalDateV2: z\n          .string()\n          .describe(\n            \"Estimated date for when the funds should arrive at the merchant's bank, returned\\nby the underlying bank rail when available. This is a prediction, not a guarantee —\\nactual arrival depends on the receiving bank's processing and may be later.\"\n          )\n          .optional()\n          .nullable(),\n        failureReason: z\n          .object({\n            code: z\n              .enum([\n                'GENERIC_PAYOUT_FAILURE',\n                'ACCOUNT_CLOSED',\n                'ACCOUNT_FROZEN',\n                'BANK_ACCOUNT_RESTRICTED',\n                'BANK_OWNERSHIP_CHANGED',\n                'COULD_NOT_PROCESS',\n                'DEBIT_NOT_AUTHORIZED',\n                'INCORRECT_ACCOUNT_HOLDER_NAME',\n                'INVALID_ACCOUNT_DETAILS_CITY',\n                'INVALID_ACCOUNT_NUMBER',\n                'INVALID_CURRENCY',\n                'INVALID_ROUTING_NUMBER',\n                'INVALID_SORT_CODE',\n                'NO_ACCOUNT',\n                'TECHNICAL_ERROR',\n              ])\n              .describe('Why the bank rail rejected the transfer.')\n              .optional(),\n          })\n          .describe(\n            'Set only when `status` is `FAILED`. Indicates why the bank rail rejected the transfer.\\nThe codes are a Wix Payments unified set; the original provider-specific reason is not exposed.'\n          )\n          .optional(),\n        bankTransferReference: z\n          .string()\n          .describe(\n            \"Reference returned by the bank rail (e.g. ACH trace number, SEPA reference) once\\nthe transfer is initiated. Use it for reconciliation against the merchant's bank\\nstatement. Empty when the rail has not yet returned a reference.\"\n          )\n          .max(500)\n          .optional()\n          .nullable(),\n        cashAdvanceIncluded: z\n          .boolean()\n          .describe(\n            \"`true` if the payout's `amount` includes funds that originate from a Wix Capital\\nadvance the merchant has taken out. `false` if the amount is composed only of\\nregular sales proceeds.\"\n          )\n          .optional(),\n      })\n    )\n    .optional(),\n  metadata: z\n    .object({\n      count: z\n        .number()\n        .int()\n        .describe('Number of items returned in the response.')\n        .optional()\n        .nullable(),\n      offset: z\n        .number()\n        .int()\n        .describe('Offset that was requested.')\n        .optional()\n        .nullable(),\n      total: z\n        .number()\n        .int()\n        .describe('Total number of items that match the query.')\n        .optional()\n        .nullable(),\n      tooManyToCount: z\n        .boolean()\n        .describe(\n          'Flag that indicates the server failed to calculate the `total` field.'\n        )\n        .optional()\n        .nullable(),\n    })\n    .describe('Paging metadata.')\n    .optional(),\n});\nexport const GetPayoutRequest = z.object({\n  payoutId: z\n    .string()\n    .describe('ID of the payout to retrieve.')\n    .regex(\n      /^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$/,\n      'Must be a valid GUID'\n    ),\n  accountId: z\n    .string()\n    .describe('ID of the Wix Payments account the payout belongs to.')\n    .regex(\n      /^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$/,\n      'Must be a valid GUID'\n    ),\n});\nexport const GetPayoutResponse = z.object({\n  _id: z\n    .string()\n    .describe('Unique identifier of the payout. Immutable.')\n    .regex(\n      /^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$/,\n      'Must be a valid GUID'\n    )\n    .optional(),\n  accountId: z\n    .string()\n    .describe('ID of the Wix Payments account that owns this payout.')\n    .regex(\n      /^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$/,\n      'Must be a valid GUID'\n    )\n    .optional(),\n  accountProfileId: z\n    .string()\n    .describe(\n      'ID of the Wix Payments account profile this payout belongs to.\\nA Wix Payments account has one or more profiles; each profile has its own\\nbalance and its own payouts. Most merchants have a single profile.'\n    )\n    .regex(\n      /^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$/,\n      'Must be a valid GUID'\n    )\n    .optional(),\n  _createdDate: z\n    .date()\n    .describe(\n      \"Date the payout was created, in advance of the underlying transfer being\\ninitiated at the bank rail. Once initiated, the funds typically reach the\\nmerchant's bank account within 3-5 business days, depending on the receiving bank.\"\n    )\n    .optional()\n    .nullable(),\n  amount: z\n    .object({\n      value: z\n        .string()\n        .describe(\n          'Monetary amount. Decimal string with a period as a decimal separator (e.g., 3.99). Optionally, a single (-), to indicate that the amount is negative.'\n        )\n        .optional(),\n      currency: z\n        .string()\n        .describe(\n          'Currency code. Must be valid ISO 4217 currency code (e.g., USD).'\n        )\n        .optional(),\n      formattedValue: z\n        .string()\n        .describe(\n          'Monetary amount. Decimal string in local format (e.g., 1 000,30). Optionally, a single (-), to indicate that the amount is negative.'\n        )\n        .optional()\n        .nullable(),\n    })\n    .describe(\"Amount of funds transferred to the merchant's bank account.\")\n    .optional(),\n  status: z\n    .enum(['UNKNOWN', 'SENT', 'FAILED'])\n    .describe(\n      'Lifecycle status of the payout. `SENT` means the bank rail accepted the transfer\\nfor delivery; `FAILED` means the receiving bank rejected the transfer. The rail\\ndoes not provide a delivery acknowledgement, so `SENT` is not the same as\\n\"delivered to the merchant\" — see the per-value documentation on `PayoutStatus`.'\n    )\n    .optional(),\n  estimatedArrivalDateV2: z\n    .string()\n    .describe(\n      \"Estimated date for when the funds should arrive at the merchant's bank, returned\\nby the underlying bank rail when available. This is a prediction, not a guarantee —\\nactual arrival depends on the receiving bank's processing and may be later.\"\n    )\n    .optional()\n    .nullable(),\n  failureReason: z\n    .object({\n      code: z\n        .enum([\n          'GENERIC_PAYOUT_FAILURE',\n          'ACCOUNT_CLOSED',\n          'ACCOUNT_FROZEN',\n          'BANK_ACCOUNT_RESTRICTED',\n          'BANK_OWNERSHIP_CHANGED',\n          'COULD_NOT_PROCESS',\n          'DEBIT_NOT_AUTHORIZED',\n          'INCORRECT_ACCOUNT_HOLDER_NAME',\n          'INVALID_ACCOUNT_DETAILS_CITY',\n          'INVALID_ACCOUNT_NUMBER',\n          'INVALID_CURRENCY',\n          'INVALID_ROUTING_NUMBER',\n          'INVALID_SORT_CODE',\n          'NO_ACCOUNT',\n          'TECHNICAL_ERROR',\n        ])\n        .describe('Why the bank rail rejected the transfer.')\n        .optional(),\n    })\n    .describe(\n      'Set only when `status` is `FAILED`. Indicates why the bank rail rejected the transfer.\\nThe codes are a Wix Payments unified set; the original provider-specific reason is not exposed.'\n    )\n    .optional(),\n  bankTransferReference: z\n    .string()\n    .describe(\n      \"Reference returned by the bank rail (e.g. ACH trace number, SEPA reference) once\\nthe transfer is initiated. Use it for reconciliation against the merchant's bank\\nstatement. Empty when the rail has not yet returned a reference.\"\n    )\n    .max(500)\n    .optional()\n    .nullable(),\n  cashAdvanceIncluded: z\n    .boolean()\n    .describe(\n      \"`true` if the payout's `amount` includes funds that originate from a Wix Capital\\nadvance the merchant has taken out. `false` if the amount is composed only of\\nregular sales proceeds.\"\n    )\n    .optional(),\n});\n"],"mappings":";;;;;;;;;;;;;;;;;;;;;;;;;;;;;;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;;;ACAA,QAAmB;AAEZ,IAAM,qBAAuB,SAAO;AAAA,EACzC,WACG,SAAO,EACP,SAAS,uDAAuD,EAChE;AAAA,IACC;AAAA,IACA;AAAA,EACF;AAAA,EACF,SACG,SAAO;AAAA,IACN,kBACG,SAAO,EACP;AAAA,MACC;AAAA,IACF,EACC;AAAA,MACC;AAAA,MACA;AAAA,IACF,EACC,SAAS,EACT,SAAS;AAAA,IACZ,eACG,OAAK,EACL;AAAA,MACC;AAAA,IACF,EACC,SAAS,EACT,SAAS;AAAA,IACZ,cACG,OAAK,EACL;AAAA,MACC;AAAA,IACF,EACC,SAAS,EACT,SAAS;AAAA,IACZ,MACG,SAAO;AAAA,MACN,WACG,SAAO,EACP,SAAS,+BAA+B,EACxC,IAAI,GAAG,EACP,SAAS;AAAA,MACZ,OAAS,OAAK,CAAC,OAAO,MAAM,CAAC,EAAE,SAAS;AAAA,IAC1C,CAAC,EACA;AAAA,MACC;AAAA,IACF,EACC,SAAS;AAAA,IACZ,QACG,SAAO;AAAA,MACN,OACG,SAAO,EACP,IAAI,EACJ,SAAS,0BAA0B,EACnC,IAAI,CAAC,EACL,SAAS,EACT,SAAS;AAAA,MACZ,QACG,SAAO,EACP,IAAI,EACJ,SAAS,oDAAoD,EAC7D,IAAI,CAAC,EACL,SAAS,EACT,SAAS;AAAA,IACd,CAAC,EACA,SAAS,gCAAgC,EACzC,SAAS;AAAA,EACd,CAAC,EACA,SAAS;AACd,CAAC;AACM,IAAM,sBAAwB,SAAO;AAAA,EAC1C,SACG;AAAA,IACG,SAAO;AAAA,MACP,KACG,SAAO,EACP,SAAS,6CAA6C,EACtD;AAAA,QACC;AAAA,QACA;AAAA,MACF,EACC,SAAS;AAAA,MACZ,WACG,SAAO,EACP,SAAS,uDAAuD,EAChE;AAAA,QACC;AAAA,QACA;AAAA,MACF,EACC,SAAS;AAAA,MACZ,kBACG,SAAO,EACP;AAAA,QACC;AAAA,MACF,EACC;AAAA,QACC;AAAA,QACA;AAAA,MACF,EACC,SAAS;AAAA,MACZ,cACG,OAAK,EACL;AAAA,QACC;AAAA,MACF,EACC,SAAS,EACT,SAAS;AAAA,MACZ,QACG,SAAO;AAAA,QACN,OACG,SAAO,EACP;AAAA,UACC;AAAA,QACF,EACC,SAAS;AAAA,QACZ,UACG,SAAO,EACP;AAAA,UACC;AAAA,QACF,EACC,SAAS;AAAA,QACZ,gBACG,SAAO,EACP;AAAA,UACC;AAAA,QACF,EACC,SAAS,EACT,SAAS;AAAA,MACd,CAAC,EACA;AAAA,QACC;AAAA,MACF,EACC,SAAS;AAAA,MACZ,QACG,OAAK,CAAC,WAAW,QAAQ,QAAQ,CAAC,EAClC;AAAA,QACC;AAAA,MACF,EACC,SAAS;AAAA,MACZ,wBACG,SAAO,EACP;AAAA,QACC;AAAA,MACF,EACC,SAAS,EACT,SAAS;AAAA,MACZ,eACG,SAAO;AAAA,QACN,MACG,OAAK;AAAA,UACJ;AAAA,UACA;AAAA,UACA;AAAA,UACA;AAAA,UACA;AAAA,UACA;AAAA,UACA;AAAA,UACA;AAAA,UACA;AAAA,UACA;AAAA,UACA;AAAA,UACA;AAAA,UACA;AAAA,UACA;AAAA,UACA;AAAA,QACF,CAAC,EACA,SAAS,0CAA0C,EACnD,SAAS;AAAA,MACd,CAAC,EACA;AAAA,QACC;AAAA,MACF,EACC,SAAS;AAAA,MACZ,uBACG,SAAO,EACP;AAAA,QACC;AAAA,MACF,EACC,IAAI,GAAG,EACP,SAAS,EACT,SAAS;AAAA,MACZ,qBACG,UAAQ,EACR;AAAA,QACC;AAAA,MACF,EACC,SAAS;AAAA,IACd,CAAC;AAAA,EACH,EACC,SAAS;AAAA,EACZ,UACG,SAAO;AAAA,IACN,OACG,SAAO,EACP,IAAI,EACJ,SAAS,2CAA2C,EACpD,SAAS,EACT,SAAS;AAAA,IACZ,QACG,SAAO,EACP,IAAI,EACJ,SAAS,4BAA4B,EACrC,SAAS,EACT,SAAS;AAAA,IACZ,OACG,SAAO,EACP,IAAI,EACJ,SAAS,6CAA6C,EACtD,SAAS,EACT,SAAS;AAAA,IACZ,gBACG,UAAQ,EACR;AAAA,MACC;AAAA,IACF,EACC,SAAS,EACT,SAAS;AAAA,EACd,CAAC,EACA,SAAS,kBAAkB,EAC3B,SAAS;AACd,CAAC;AACM,IAAM,mBAAqB,SAAO;AAAA,EACvC,UACG,SAAO,EACP,SAAS,+BAA+B,EACxC;AAAA,IACC;AAAA,IACA;AAAA,EACF;AAAA,EACF,WACG,SAAO,EACP,SAAS,uDAAuD,EAChE;AAAA,IACC;AAAA,IACA;AAAA,EACF;AACJ,CAAC;AACM,IAAM,oBAAsB,SAAO;AAAA,EACxC,KACG,SAAO,EACP,SAAS,6CAA6C,EACtD;AAAA,IACC;AAAA,IACA;AAAA,EACF,EACC,SAAS;AAAA,EACZ,WACG,SAAO,EACP,SAAS,uDAAuD,EAChE;AAAA,IACC;AAAA,IACA;AAAA,EACF,EACC,SAAS;AAAA,EACZ,kBACG,SAAO,EACP;AAAA,IACC;AAAA,EACF,EACC;AAAA,IACC;AAAA,IACA;AAAA,EACF,EACC,SAAS;AAAA,EACZ,cACG,OAAK,EACL;AAAA,IACC;AAAA,EACF,EACC,SAAS,EACT,SAAS;AAAA,EACZ,QACG,SAAO;AAAA,IACN,OACG,SAAO,EACP;AAAA,MACC;AAAA,IACF,EACC,SAAS;AAAA,IACZ,UACG,SAAO,EACP;AAAA,MACC;AAAA,IACF,EACC,SAAS;AAAA,IACZ,gBACG,SAAO,EACP;AAAA,MACC;AAAA,IACF,EACC,SAAS,EACT,SAAS;AAAA,EACd,CAAC,EACA,SAAS,6DAA6D,EACtE,SAAS;AAAA,EACZ,QACG,OAAK,CAAC,WAAW,QAAQ,QAAQ,CAAC,EAClC;AAAA,IACC;AAAA,EACF,EACC,SAAS;AAAA,EACZ,wBACG,SAAO,EACP;AAAA,IACC;AAAA,EACF,EACC,SAAS,EACT,SAAS;AAAA,EACZ,eACG,SAAO;AAAA,IACN,MACG,OAAK;AAAA,MACJ;AAAA,MACA;AAAA,MACA;AAAA,MACA;AAAA,MACA;AAAA,MACA;AAAA,MACA;AAAA,MACA;AAAA,MACA;AAAA,MACA;AAAA,MACA;AAAA,MACA;AAAA,MACA;AAAA,MACA;AAAA,MACA;AAAA,IACF,CAAC,EACA,SAAS,0CAA0C,EACnD,SAAS;AAAA,EACd,CAAC,EACA;AAAA,IACC;AAAA,EACF,EACC,SAAS;AAAA,EACZ,uBACG,SAAO,EACP;AAAA,IACC;AAAA,EACF,EACC,IAAI,GAAG,EACP,SAAS,EACT,SAAS;AAAA,EACZ,qBACG,UAAQ,EACR;AAAA,IACC;AAAA,EACF,EACC,SAAS;AACd,CAAC;","names":[]}

package/build/es/index.d.mts

@@ -0,0 +1,44 @@
+import { HttpClient, NonNullablePaths, EventDefinition, MaybeContext, BuildRESTFunction, BuildEventDefinition } from '@wix/sdk-types';
+import { ListPayoutsOptions, ListPayoutsResponse, Payout, PayoutCreatedEnvelope, PayoutUpdatedEnvelope } from './index.typings.mjs';
+export { AccountInfo, AccountInfoMetadata, ActionEvent, BaseEventMetadata, CreatePayoutRequest, CreatePayoutResponse, DomainEvent, DomainEventBodyOneOf, EntityCreatedEvent, EntityDeletedEvent, EntityUpdatedEvent, EventMetadata, GetPayoutGroupByPayoutIdRequest, GetPayoutGroupByPayoutIdResponse, GetPayoutGroupRequest, GetPayoutGroupResponse, GetPayoutRequest, GetPayoutResponse, IdentificationData, IdentificationDataIdOneOf, ListPayoutGroupsRequest, ListPayoutGroupsResponse, ListPayoutsRequest, MessageEnvelope, Money, Paging, PagingMetadata, PayoutFailureCode, PayoutFailureCodeWithLiterals, PayoutFailureReason, PayoutGroup, PayoutStatus, PayoutStatusWithLiterals, RestoreInfo, SortOrder, SortOrderWithLiterals, Sorting, WebhookIdentityType, WebhookIdentityTypeWithLiterals } from './index.typings.mjs';
+
+declare function listPayouts$1(httpClient: HttpClient): ListPayoutsSignature;
+interface ListPayoutsSignature {
+    /**
+     * Retrieves a paginated list of payouts for the specified Wix Payments account,
+     * with optional filters by profile and creation date.
+     * @param - ID of the Wix Payments account whose payouts to list.
+     */
+    (accountId: string, options?: ListPayoutsOptions): Promise<NonNullablePaths<ListPayoutsResponse, `payouts` | `payouts.${number}._id` | `payouts.${number}.accountId` | `payouts.${number}.accountProfileId` | `payouts.${number}.amount.value` | `payouts.${number}.amount.currency` | `payouts.${number}.status` | `payouts.${number}.failureReason.code` | `payouts.${number}.cashAdvanceIncluded`, 5>>;
+}
+declare function getPayout$1(httpClient: HttpClient): GetPayoutSignature;
+interface GetPayoutSignature {
+    /**
+     * Retrieves a single payout by id.
+     * @param - ID of the payout to retrieve.
+     * @param - ID of the Wix Payments account the payout belongs to.
+     * @returns Payout.
+     */
+    (payoutId: string, accountId: string): Promise<NonNullablePaths<Payout, `_id` | `accountId` | `accountProfileId` | `amount.value` | `amount.currency` | `status` | `failureReason.code` | `cashAdvanceIncluded`, 3>>;
+}
+declare const onPayoutCreated$1: EventDefinition<PayoutCreatedEnvelope, "wix.payments.payouts.v4.payout_created">;
+declare const onPayoutUpdated$1: EventDefinition<PayoutUpdatedEnvelope, "wix.payments.payouts.v4.payout_updated">;
+
+declare const listPayouts: MaybeContext<BuildRESTFunction<typeof listPayouts$1> & typeof listPayouts$1>;
+declare const getPayout: MaybeContext<BuildRESTFunction<typeof getPayout$1> & typeof getPayout$1>;
+/**
+ * Emitted once when the payout is first persisted, before the underlying transfer
+ * is initiated at the bank. At this point `status` is SENT and `estimated_arrival_date`
+ * is set if the bank rail returned one; `failure_reason` and `bank_transfer_reference`
+ * are not yet populated.
+ */
+declare const onPayoutCreated: BuildEventDefinition<typeof onPayoutCreated$1> & typeof onPayoutCreated$1;
+/**
+ * Emitted on every change to a persisted payout. Typical transitions include:
+ * status moving from SENT to FAILED (and the corresponding `failure_reason` being set),
+ * `estimated_arrival_date` being updated by the bank rail, and `bank_transfer_reference`
+ * being populated once the rail returns it.
+ */
+declare const onPayoutUpdated: BuildEventDefinition<typeof onPayoutUpdated$1> & typeof onPayoutUpdated$1;
+
+export { ListPayoutsOptions, ListPayoutsResponse, Payout, PayoutCreatedEnvelope, PayoutUpdatedEnvelope, getPayout, listPayouts, onPayoutCreated, onPayoutUpdated };