@wix/auto_sdk_payments_payouts 1.0.0 → 1.0.2

package/build/cjs/meta.js.map

@@ -1 +1 @@
-{"version":3,"sources":["../../meta.ts","../../src/payments-payouts-v4-payout-payouts.http.ts","../../src/payments-payouts-v4-payout-payouts.types.ts","../../src/payments-payouts-v4-payout-payouts.meta.ts"],"sourcesContent":["export * from './src/payments-payouts-v4-payout-payouts.meta.js';\n","import { toURLSearchParams } from '@wix/sdk-runtime/rest-modules';\nimport { transformSDKTimestampToRESTTimestamp } from '@wix/sdk-runtime/transformations/timestamp';\nimport { transformRESTTimestampToSDKTimestamp } from '@wix/sdk-runtime/transformations/timestamp';\nimport { transformPaths } from '@wix/sdk-runtime/transformations/transform-paths';\nimport { resolveUrl } from '@wix/sdk-runtime/rest-modules';\nimport { ResolveUrlOpts } from '@wix/sdk-runtime/rest-modules';\nimport { RequestOptionsFactory } from '@wix/sdk-types';\n\nfunction resolveWixPaymentsV4PayoutsPayoutsServiceUrl(\n  opts: Omit<ResolveUrlOpts, 'domainToMappings'>\n) {\n  const domainToMappings = {\n    'api._api_base_domain_': [\n      {\n        srcPath: '/wixpay-payout',\n        destPath: '',\n      },\n    ],\n    'manage._base_domain_': [\n      {\n        srcPath: '/_api/wixpay-payout/v4/payout-groups',\n        destPath: '/v4/payout-groups',\n      },\n      {\n        srcPath: '/_api/wixpay-payout/v4/payouts',\n        destPath: '/v4/payouts',\n      },\n    ],\n    'bo._base_domain_': [\n      {\n        srcPath: '/_api/wixpay-payout/v4/payouts',\n        destPath: '/v4/payouts',\n      },\n      {\n        srcPath: '/_api/wixpay-payout/v4/payout-groups',\n        destPath: '/v4/payout-groups',\n      },\n      {\n        srcPath: '/_api/wixpay-payout/v4/bo-payouts',\n        destPath: '/v4/bo-payouts',\n      },\n      {\n        srcPath: '/_api/wixpay-payout/v4/bo-payout-policies',\n        destPath: '/v4/bo-payout-policies',\n      },\n    ],\n    'wixbo.ai': [\n      {\n        srcPath: '/_api/wixpay-payout/v4/payouts',\n        destPath: '/v4/payouts',\n      },\n      {\n        srcPath: '/_api/wixpay-payout/v4/payout-groups',\n        destPath: '/v4/payout-groups',\n      },\n      {\n        srcPath: '/_api/wixpay-payout/v4/bo-payouts',\n        destPath: '/v4/bo-payouts',\n      },\n      {\n        srcPath: '/_api/wixpay-payout/v4/bo-payout-policies',\n        destPath: '/v4/bo-payout-policies',\n      },\n    ],\n    'wix-bo.com': [\n      {\n        srcPath: '/_api/wixpay-payout/v4/payouts',\n        destPath: '/v4/payouts',\n      },\n      {\n        srcPath: '/_api/wixpay-payout/v4/payout-groups',\n        destPath: '/v4/payout-groups',\n      },\n      {\n        srcPath: '/_api/wixpay-payout/v4/bo-payouts',\n        destPath: '/v4/bo-payouts',\n      },\n      {\n        srcPath: '/_api/wixpay-payout/v4/bo-payout-policies',\n        destPath: '/v4/bo-payout-policies',\n      },\n    ],\n    'payment-webhooks.wixapps.net': [\n      {\n        srcPath: '/wix-payments/payout-callbacks/stripe',\n        destPath: '/payout-callbacks/stripe',\n      },\n      {\n        srcPath: '/wix-payments/payout-callbacks/adyen',\n        destPath: '/payout-callbacks/adyen',\n      },\n      {\n        srcPath: '/wix-payments/payout-callbacks/stone',\n        destPath: '/payout-callbacks/stone',\n      },\n      {\n        srcPath: '/wix-payments/payout-callbacks/paypal',\n        destPath: '/payout-callbacks/paypal',\n      },\n    ],\n    'cronulla-jobs._base_domain_': [\n      {\n        srcPath: '/wix-payments/wixpay-payout/internal-api/jobs',\n        destPath: '/internal-api/jobs',\n      },\n    ],\n    'manage.base44.com': [\n      {\n        srcPath: '/_api/wixpay-payout',\n        destPath: '',\n      },\n    ],\n    'payments.base44.com': [\n      {\n        srcPath: '/_api/wixpay-payout',\n        destPath: '',\n      },\n    ],\n    'www.wixapis.com': [\n      {\n        srcPath: '/wixpay-payouts/v4/payouts',\n        destPath: '/v4/payouts',\n      },\n    ],\n  };\n\n  return resolveUrl(Object.assign(opts, { domainToMappings }));\n}\n\nconst PACKAGE_NAME = '@wix/auto_sdk_payments_payouts';\n\n/**\n * Retrieves a paginated list of payouts for the specified Wix Payments account,\n * with optional filters by profile and creation date.\n */\nexport function listPayouts(payload: object): RequestOptionsFactory<any> {\n  function __listPayouts({ host }: any) {\n    const serializedData = transformPaths(payload, [\n      {\n        transformFn: transformSDKTimestampToRESTTimestamp,\n        paths: [{ path: 'createdBefore' }, { path: 'createdAfter' }],\n      },\n    ]);\n    const metadata = {\n      entityFqdn: 'wix.payments.payouts.v4.payout',\n      method: 'GET' as any,\n      methodFqn: 'wix.payments.v4.payouts.PayoutsService.ListPayouts',\n      packageName: PACKAGE_NAME,\n      migrationOptions: {\n        optInTransformResponse: true,\n      },\n      url: resolveWixPaymentsV4PayoutsPayoutsServiceUrl({\n        protoPath: '/v4/payouts',\n        data: serializedData,\n        host,\n      }),\n      params: toURLSearchParams(serializedData, true),\n      transformResponse: (payload: any) =>\n        transformPaths(payload, [\n          {\n            transformFn: transformRESTTimestampToSDKTimestamp,\n            paths: [{ path: 'payouts.createdDate' }],\n          },\n        ]),\n    };\n\n    return metadata;\n  }\n\n  return __listPayouts;\n}\n\n/** Retrieves a single payout by id. */\nexport function getPayout(payload: object): RequestOptionsFactory<any> {\n  function __getPayout({ host }: any) {\n    const metadata = {\n      entityFqdn: 'wix.payments.payouts.v4.payout',\n      method: 'GET' as any,\n      methodFqn: 'wix.payments.v4.payouts.PayoutsService.GetPayout',\n      packageName: PACKAGE_NAME,\n      migrationOptions: {\n        optInTransformResponse: true,\n      },\n      url: resolveWixPaymentsV4PayoutsPayoutsServiceUrl({\n        protoPath: '/v4/payouts/{payoutId}',\n        data: payload,\n        host,\n      }),\n      params: toURLSearchParams(payload),\n      transformResponse: (payload: any) =>\n        transformPaths(payload, [\n          {\n            transformFn: transformRESTTimestampToSDKTimestamp,\n            paths: [{ path: 'payout.createdDate' }],\n          },\n        ]),\n    };\n\n    return metadata;\n  }\n\n  return __getPayout;\n}\n","/**\n * A payout is one outgoing transfer of funds from a Wix Payments merchant account\n * to the merchant's bank account. The entity carries the amount, lifecycle status,\n * estimated arrival date, and (when applicable) failure information.\n */\nexport interface Payout {\n  /**\n   * Unique identifier of the payout. Immutable.\n   * @format GUID\n   */\n  id?: string;\n  /**\n   * ID of the Wix Payments account that owns this payout.\n   * @format GUID\n   */\n  accountId?: string;\n  /**\n   * ID of the Wix Payments account profile this payout belongs to.\n   * A Wix Payments account has one or more profiles; each profile has its own\n   * balance and its own payouts. Most merchants have a single profile.\n   * @format GUID\n   */\n  accountProfileId?: string;\n  /**\n   * Date the payout was created, in advance of the underlying transfer being\n   * initiated at the bank rail. Once initiated, the funds typically reach the\n   * merchant's bank account within 3-5 business days, depending on the receiving bank.\n   */\n  createdDate?: Date | null;\n  /** Amount of funds transferred to the merchant's bank account. */\n  amount?: Money;\n  /**\n   * Lifecycle status of the payout. `SENT` means the bank rail accepted the transfer\n   * for delivery; `FAILED` means the receiving bank rejected the transfer. The rail\n   * does 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  status?: PayoutStatusWithLiterals;\n  /**\n   * Estimated date for when the funds should arrive at the merchant's bank, returned\n   * by the underlying bank rail when available. This is a prediction, not a guarantee —\n   * actual arrival depends on the receiving bank's processing and may be later.\n   * @format LOCAL_DATE\n   */\n  estimatedArrivalDateV2?: string | null;\n  /**\n   * Set only when `status` is `FAILED`. Indicates why the bank rail rejected the transfer.\n   * The codes are a Wix Payments unified set; the original provider-specific reason is not exposed.\n   */\n  failureReason?: PayoutFailureReason;\n  /**\n   * Reference returned by the bank rail (e.g. ACH trace number, SEPA reference) once\n   * the transfer is initiated. Use it for reconciliation against the merchant's bank\n   * statement. Empty when the rail has not yet returned a reference.\n   * @maxLength 500\n   */\n  bankTransferReference?: string | null;\n  /**\n   * `true` if the payout's `amount` includes funds that originate from a Wix Capital\n   * advance the merchant has taken out. `false` if the amount is composed only of\n   * regular sales proceeds.\n   */\n  cashAdvanceIncluded?: boolean;\n}\n\n/**\n * Money.\n * Default format to use. Sufficiently compliant with majority of standards: w3c, ISO 4217, ISO 20022, ISO 8583:2003.\n */\nexport interface Money {\n  /**\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   * @format DECIMAL_VALUE\n   */\n  value?: string;\n  /**\n   * Currency code. Must be valid ISO 4217 currency code (e.g., USD).\n   * @format CURRENCY\n   */\n  currency?: string;\n  /** Monetary amount. Decimal string in local format (e.g., 1 000,30). Optionally, a single (-), to indicate that the amount is negative. */\n  formattedValue?: string | null;\n}\n\n/** Lifecycle status of a payout. */\nexport enum PayoutStatus {\n  /** Default value. Not returned by the API. */\n  UNKNOWN = 'UNKNOWN',\n  /**\n   * The bank rail accepted the transfer. Funds are en route to the merchant's bank,\n   * but acceptance is not the same as delivery — a `SENT` payout can still flip to\n   * `FAILED` if the receiving bank rejects the transfer (the rail's return window\n   * is up to 60 days for ACH and up to 13 months for SEPA).\n   */\n  SENT = 'SENT',\n  /**\n   * The transfer was rejected by the receiving bank. See `failure_reason` for the cause;\n   * the funds remain in the merchant's Wix Payments balance.\n   */\n  FAILED = 'FAILED',\n}\n\n/** @enumType */\nexport type PayoutStatusWithLiterals =\n  | PayoutStatus\n  | 'UNKNOWN'\n  | 'SENT'\n  | 'FAILED';\n\n/**\n * Carries the reason a payout failed. Wraps the `PayoutFailureCode` enum to leave room\n * for future fields (e.g. a human-readable message); new clients should still read\n * `failure_reason.code` for the enum value.\n */\nexport interface PayoutFailureReason {\n  /** Why the bank rail rejected the transfer. */\n  code?: PayoutFailureCodeWithLiterals;\n}\n\n/**\n * Reasons a payout can fail. Values describe real-world bank-rail conditions and\n * are mapped from the underlying provider into a Wix Payments unified vocabulary.\n */\nexport enum PayoutFailureCode {\n  /**\n   * Generic failure with no more specific reason available from the bank rail.\n   * Note: this value is also returned when no failure reason is known — clients\n   * cannot distinguish \"unknown\" from \"generic\" using this code alone.\n   */\n  GENERIC_PAYOUT_FAILURE = 'GENERIC_PAYOUT_FAILURE',\n  /**\n   * The merchant's bank account is closed. The merchant must provide new bank\n   * account details before further payouts can succeed.\n   */\n  ACCOUNT_CLOSED = 'ACCOUNT_CLOSED',\n  /**\n   * The merchant's bank account is frozen (e.g. due to a hold placed by the bank).\n   * The merchant must resolve the hold with their bank before further payouts can succeed.\n   */\n  ACCOUNT_FROZEN = 'ACCOUNT_FROZEN',\n  /**\n   * The merchant's bank account is restricted from receiving the transfer\n   * (e.g. account type or status does not permit incoming credits).\n   */\n  BANK_ACCOUNT_RESTRICTED = 'BANK_ACCOUNT_RESTRICTED',\n  /**\n   * Ownership of the merchant's bank account changed and the rail no longer\n   * recognises the previously-recorded owner. New bank details are required.\n   */\n  BANK_OWNERSHIP_CHANGED = 'BANK_OWNERSHIP_CHANGED',\n  /**\n   * The receiving bank could not process the transfer for an unspecified reason.\n   * A subsequent payout attempt may succeed.\n   */\n  COULD_NOT_PROCESS = 'COULD_NOT_PROCESS',\n  /**\n   * The merchant's bank declined the debit authorisation associated with the transfer.\n   * The merchant must contact their bank to authorise Wix Payments payouts.\n   */\n  DEBIT_NOT_AUTHORIZED = 'DEBIT_NOT_AUTHORIZED',\n  /**\n   * The account holder name on file does not match what the receiving bank has on record.\n   * The merchant must correct the account holder name.\n   */\n  INCORRECT_ACCOUNT_HOLDER_NAME = 'INCORRECT_ACCOUNT_HOLDER_NAME',\n  /** The city in the bank account details is invalid for the receiving bank. */\n  INVALID_ACCOUNT_DETAILS_CITY = 'INVALID_ACCOUNT_DETAILS_CITY',\n  /** The bank account number is invalid (wrong format or does not exist). */\n  INVALID_ACCOUNT_NUMBER = 'INVALID_ACCOUNT_NUMBER',\n  /** The payout currency is not supported by the receiving bank account. */\n  INVALID_CURRENCY = 'INVALID_CURRENCY',\n  /** The routing number (US) is invalid or does not match the receiving bank. */\n  INVALID_ROUTING_NUMBER = 'INVALID_ROUTING_NUMBER',\n  /** The sort code (UK) is invalid or does not match the receiving bank. */\n  INVALID_SORT_CODE = 'INVALID_SORT_CODE',\n  /**\n   * No bank account is on file for the merchant.\n   * The merchant must add bank details before payouts can succeed.\n   */\n  NO_ACCOUNT = 'NO_ACCOUNT',\n  /**\n   * A technical error at the bank rail prevented the transfer.\n   * A subsequent payout attempt may succeed.\n   */\n  TECHNICAL_ERROR = 'TECHNICAL_ERROR',\n}\n\n/** @enumType */\nexport type PayoutFailureCodeWithLiterals =\n  | PayoutFailureCode\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\nexport interface ListPayoutsRequest {\n  /**\n   * ID of the Wix Payments account whose payouts to list.\n   * @format GUID\n   */\n  accountId: string;\n  /**\n   * Optional. When omitted, payouts across all profiles of the account are returned.\n   * When set, only payouts belonging to the specified account profile are returned.\n   * @format GUID\n   */\n  accountProfileId?: string | null;\n  /** Optional. Returns only payouts created before this timestamp. */\n  createdBefore?: Date | null;\n  /** Optional. Returns only payouts created after this timestamp. */\n  createdAfter?: Date | null;\n  /** Optional. Sorting. Only `created_date` is supported; requests sorting by any other field are rejected with INVALID_ARGUMENT. */\n  sort?: Sorting;\n  /** Optional paging. Offset-based. */\n  paging?: Paging;\n}\n\nexport interface Sorting {\n  /**\n   * Name of the field to sort by.\n   * @maxLength 512\n   */\n  fieldName?: string;\n  /** Sort order. */\n  order?: SortOrderWithLiterals;\n}\n\nexport enum SortOrder {\n  ASC = 'ASC',\n  DESC = 'DESC',\n}\n\n/** @enumType */\nexport type SortOrderWithLiterals = SortOrder | 'ASC' | 'DESC';\n\nexport interface Paging {\n  /** Number of items to load. */\n  limit?: number | null;\n  /** Number of items to skip in the current sort order. */\n  offset?: number | null;\n}\n\nexport interface ListPayoutsResponse {\n  /** List of payouts. */\n  payouts?: Payout[];\n  /** Paging metadata. */\n  metadata?: PagingMetadata;\n}\n\nexport interface PagingMetadata {\n  /** Number of items returned in the response. */\n  count?: number | null;\n  /** Offset that was requested. */\n  offset?: number | null;\n  /** Total number of items that match the query. */\n  total?: number | null;\n  /** Flag that indicates the server failed to calculate the `total` field. */\n  tooManyToCount?: boolean | null;\n}\n\nexport interface CreatePayoutRequest {\n  /** Payout. */\n  payout?: Payout;\n}\n\nexport interface CreatePayoutResponse {\n  /** Payout. */\n  payout?: Payout;\n}\n\nexport interface GetPayoutRequest {\n  /**\n   * ID of the Wix Payments account the payout belongs to.\n   * @format GUID\n   */\n  accountId: string;\n  /**\n   * ID of the payout to retrieve.\n   * @format GUID\n   */\n  payoutId: string;\n}\n\nexport interface GetPayoutResponse {\n  /** Payout. */\n  payout?: Payout;\n}\n\nexport interface ListPayoutGroupsRequest {\n  /**\n   * Wix Payments account identifier.\n   * @format GUID\n   */\n  accountId?: string;\n  /**\n   * Optional filter by payout date. Use it to return payouts before specific date.\n   * @format LOCAL_DATE\n   */\n  payoutDateBefore?: string | null;\n  /**\n   * Optional filter by payout date. Use it to return payouts after specific date.\n   * @format LOCAL_DATE\n   */\n  payoutDateAfter?: string | null;\n  /** Optional sorting. Supported fields: \"payout_date\". */\n  sort?: Sorting;\n  /** Optional paging. */\n  paging?: Paging;\n}\n\nexport interface ListPayoutGroupsResponse {\n  /** List of payout groups. */\n  groups?: PayoutGroup[];\n  /** Paging metadata. */\n  metadata?: PagingMetadata;\n}\n\n/** Payout group */\nexport interface PayoutGroup {\n  /**\n   * Payout date.\n   * @format LOCAL_DATE\n   */\n  payoutDate?: string;\n  /**\n   * Payout number within the same date, is absent if there's only one group\n   * @min 1\n   * @max 99\n   */\n  payoutNumber?: number | null;\n  /** Payout group amount */\n  amount?: Money;\n  /**\n   * Payouts associated with the group\n   * @maxSize 10\n   */\n  payouts?: Payout[];\n}\n\nexport interface GetPayoutGroupRequest {\n  /**\n   * Wix Payments account identifier.\n   * @format GUID\n   */\n  accountId?: string;\n  /**\n   * Payout date.\n   * @format LOCAL_DATE\n   */\n  payoutDate?: string;\n  /**\n   * Optional payout number within the same date\n   * @min 1\n   * @max 99\n   */\n  payoutNumber?: number | null;\n}\n\nexport interface GetPayoutGroupResponse {\n  /** Payout group. */\n  group?: PayoutGroup;\n}\n\nexport interface GetPayoutGroupByPayoutIdRequest {\n  /**\n   * Wix Payments account identifier.\n   * @format GUID\n   */\n  accountId?: string;\n  /**\n   * Payout identifier.\n   * @format GUID\n   */\n  payoutId?: string;\n}\n\nexport interface GetPayoutGroupByPayoutIdResponse {\n  /** Payout group. */\n  group?: PayoutGroup;\n}\n\nexport interface DomainEvent extends DomainEventBodyOneOf {\n  createdEvent?: EntityCreatedEvent;\n  updatedEvent?: EntityUpdatedEvent;\n  deletedEvent?: EntityDeletedEvent;\n  actionEvent?: ActionEvent;\n  /** Event ID. With this ID you can easily spot duplicated events and ignore them. */\n  id?: string;\n  /**\n   * Fully Qualified Domain Name of an entity. This is a unique identifier assigned to the API main business entities.\n   * For example, `wix.stores.catalog.product`, `wix.bookings.session`, `wix.payments.transaction`.\n   */\n  entityFqdn?: string;\n  /**\n   * Event action name, placed at the top level to make it easier for users to dispatch messages.\n   * For example: `created`/`updated`/`deleted`/`started`/`completed`/`email_opened`.\n   */\n  slug?: string;\n  /** ID of the entity associated with the event. */\n  entityId?: string;\n  /** Event timestamp in [ISO-8601](https://en.wikipedia.org/wiki/ISO_8601) format and UTC time. For example, `2020-04-26T13:57:50.699Z`. */\n  eventTime?: Date | null;\n  /**\n   * Whether the event was triggered as a result of a privacy regulation application\n   * (for example, GDPR).\n   */\n  triggeredByAnonymizeRequest?: boolean | null;\n  /** If present, indicates the action that triggered the event. */\n  originatedFrom?: string | null;\n  /**\n   * A sequence number that indicates the order of updates to an entity. For example, if an entity was updated at 16:00 and then again at 16:01, the second update will always have a higher sequence number.\n   * You can use this number to make sure you're handling updates in the right order. Just save the latest sequence number on your end and compare it to the one in each new message. If the new message has an older (lower) number, you can safely ignore it.\n   */\n  entityEventSequence?: string | null;\n}\n\n/** @oneof */\nexport interface DomainEventBodyOneOf {\n  createdEvent?: EntityCreatedEvent;\n  updatedEvent?: EntityUpdatedEvent;\n  deletedEvent?: EntityDeletedEvent;\n  actionEvent?: ActionEvent;\n}\n\nexport interface EntityCreatedEvent {\n  entityAsJson?: string;\n  /** Indicates the event was triggered by a restore-from-trashbin operation for a previously deleted entity */\n  restoreInfo?: RestoreInfo;\n}\n\nexport interface RestoreInfo {\n  deletedDate?: Date | null;\n}\n\nexport interface EntityUpdatedEvent {\n  /**\n   * Since platformized APIs only expose PATCH and not PUT we can't assume that the fields sent from the client are the actual diff.\n   * This means that to generate a list of changed fields (as opposed to sent fields) one needs to traverse both objects.\n   * We don't want to impose this on all developers and so we leave this traversal to the notification recipients which need it.\n   */\n  currentEntityAsJson?: string;\n}\n\nexport interface EntityDeletedEvent {\n  /** Entity that was deleted. */\n  deletedEntityAsJson?: string | null;\n}\n\nexport interface ActionEvent {\n  bodyAsJson?: string;\n}\n\nexport interface MessageEnvelope {\n  /**\n   * App instance ID.\n   * @format GUID\n   */\n  instanceId?: string | null;\n  /**\n   * Event type.\n   * @maxLength 150\n   */\n  eventType?: string;\n  /** The identification type and identity data. */\n  identity?: IdentificationData;\n  /** Stringify payload. */\n  data?: string;\n  /** Details related to the account */\n  accountInfo?: AccountInfo;\n}\n\nexport interface IdentificationData extends IdentificationDataIdOneOf {\n  /**\n   * ID of a site visitor that has not logged in to the site.\n   * @format GUID\n   */\n  anonymousVisitorId?: string;\n  /**\n   * ID of a site visitor that has logged in to the site.\n   * @format GUID\n   */\n  memberId?: string;\n  /**\n   * ID of a Wix user (site owner, contributor, etc.).\n   * @format GUID\n   */\n  wixUserId?: string;\n  /**\n   * ID of an app.\n   * @format GUID\n   */\n  appId?: string;\n  /** @readonly */\n  identityType?: WebhookIdentityTypeWithLiterals;\n}\n\n/** @oneof */\nexport interface IdentificationDataIdOneOf {\n  /**\n   * ID of a site visitor that has not logged in to the site.\n   * @format GUID\n   */\n  anonymousVisitorId?: string;\n  /**\n   * ID of a site visitor that has logged in to the site.\n   * @format GUID\n   */\n  memberId?: string;\n  /**\n   * ID of a Wix user (site owner, contributor, etc.).\n   * @format GUID\n   */\n  wixUserId?: string;\n  /**\n   * ID of an app.\n   * @format GUID\n   */\n  appId?: string;\n}\n\nexport enum WebhookIdentityType {\n  UNKNOWN = 'UNKNOWN',\n  ANONYMOUS_VISITOR = 'ANONYMOUS_VISITOR',\n  MEMBER = 'MEMBER',\n  WIX_USER = 'WIX_USER',\n  APP = 'APP',\n}\n\n/** @enumType */\nexport type WebhookIdentityTypeWithLiterals =\n  | WebhookIdentityType\n  | 'UNKNOWN'\n  | 'ANONYMOUS_VISITOR'\n  | 'MEMBER'\n  | 'WIX_USER'\n  | 'APP';\n\nexport interface AccountInfo {\n  /**\n   * ID of the Wix account associated with the event.\n   * @format GUID\n   */\n  accountId?: string | null;\n  /**\n   * ID of the parent Wix account. Only included when accountId belongs to a child account.\n   * @format GUID\n   */\n  parentAccountId?: string | null;\n  /**\n   * ID of the Wix site associated with the event. Only included when the event is tied to a specific site.\n   * @format GUID\n   */\n  siteId?: string | null;\n}\n","import * as ambassadorWixPaymentsPayoutsV4Payout from './payments-payouts-v4-payout-payouts.http.js';\nimport * as ambassadorWixPaymentsPayoutsV4PayoutTypes from './payments-payouts-v4-payout-payouts.types.js';\nimport * as ambassadorWixPaymentsPayoutsV4PayoutUniversalTypes from './payments-payouts-v4-payout-payouts.universal.js';\n\nexport type __PublicMethodMetaInfo<\n  K = string,\n  M = unknown,\n  T = unknown,\n  S = unknown,\n  Q = unknown,\n  R = unknown\n> = {\n  getUrl: (context: any) => string;\n  httpMethod: K;\n  path: string;\n  pathParams: M;\n  __requestType: T;\n  __originalRequestType: S;\n  __responseType: Q;\n  __originalResponseType: R;\n};\n\nexport function listPayouts(): __PublicMethodMetaInfo<\n  'GET',\n  {},\n  ambassadorWixPaymentsPayoutsV4PayoutUniversalTypes.ListPayoutsRequest,\n  ambassadorWixPaymentsPayoutsV4PayoutTypes.ListPayoutsRequest,\n  ambassadorWixPaymentsPayoutsV4PayoutUniversalTypes.ListPayoutsResponse,\n  ambassadorWixPaymentsPayoutsV4PayoutTypes.ListPayoutsResponse\n> {\n  const payload = {} as any;\n\n  const getRequestOptions =\n    ambassadorWixPaymentsPayoutsV4Payout.listPayouts(payload);\n\n  const getUrl = (context: any): string => {\n    const { url } = getRequestOptions(context);\n    return url!;\n  };\n\n  return {\n    getUrl,\n    httpMethod: 'GET',\n    path: '/v4/payouts',\n    pathParams: {},\n    __requestType: null as any,\n    __originalRequestType: null as any,\n    __responseType: null as any,\n    __originalResponseType: null as any,\n  };\n}\n\nexport function getPayout(): __PublicMethodMetaInfo<\n  'GET',\n  { payoutId: string },\n  ambassadorWixPaymentsPayoutsV4PayoutUniversalTypes.GetPayoutRequest,\n  ambassadorWixPaymentsPayoutsV4PayoutTypes.GetPayoutRequest,\n  ambassadorWixPaymentsPayoutsV4PayoutUniversalTypes.GetPayoutResponse,\n  ambassadorWixPaymentsPayoutsV4PayoutTypes.GetPayoutResponse\n> {\n  const payload = { payoutId: ':payoutId' } as any;\n\n  const getRequestOptions =\n    ambassadorWixPaymentsPayoutsV4Payout.getPayout(payload);\n\n  const getUrl = (context: any): string => {\n    const { url } = getRequestOptions(context);\n    return url!;\n  };\n\n  return {\n    getUrl,\n    httpMethod: 'GET',\n    path: '/v4/payouts/{payoutId}',\n    pathParams: { payoutId: 'payoutId' },\n    __requestType: null as any,\n    __originalRequestType: null as any,\n    __responseType: null as any,\n    __originalResponseType: null as any,\n  };\n}\n\nexport {\n  Payout as PayoutOriginal,\n  Money as MoneyOriginal,\n  PayoutStatus as PayoutStatusOriginal,\n  PayoutStatusWithLiterals as PayoutStatusWithLiteralsOriginal,\n  PayoutFailureReason as PayoutFailureReasonOriginal,\n  PayoutFailureCode as PayoutFailureCodeOriginal,\n  PayoutFailureCodeWithLiterals as PayoutFailureCodeWithLiteralsOriginal,\n  ListPayoutsRequest as ListPayoutsRequestOriginal,\n  Sorting as SortingOriginal,\n  SortOrder as SortOrderOriginal,\n  SortOrderWithLiterals as SortOrderWithLiteralsOriginal,\n  Paging as PagingOriginal,\n  ListPayoutsResponse as ListPayoutsResponseOriginal,\n  PagingMetadata as PagingMetadataOriginal,\n  CreatePayoutRequest as CreatePayoutRequestOriginal,\n  CreatePayoutResponse as CreatePayoutResponseOriginal,\n  GetPayoutRequest as GetPayoutRequestOriginal,\n  GetPayoutResponse as GetPayoutResponseOriginal,\n  ListPayoutGroupsRequest as ListPayoutGroupsRequestOriginal,\n  ListPayoutGroupsResponse as ListPayoutGroupsResponseOriginal,\n  PayoutGroup as PayoutGroupOriginal,\n  GetPayoutGroupRequest as GetPayoutGroupRequestOriginal,\n  GetPayoutGroupResponse as GetPayoutGroupResponseOriginal,\n  GetPayoutGroupByPayoutIdRequest as GetPayoutGroupByPayoutIdRequestOriginal,\n  GetPayoutGroupByPayoutIdResponse as GetPayoutGroupByPayoutIdResponseOriginal,\n  DomainEvent as DomainEventOriginal,\n  DomainEventBodyOneOf as DomainEventBodyOneOfOriginal,\n  EntityCreatedEvent as EntityCreatedEventOriginal,\n  RestoreInfo as RestoreInfoOriginal,\n  EntityUpdatedEvent as EntityUpdatedEventOriginal,\n  EntityDeletedEvent as EntityDeletedEventOriginal,\n  ActionEvent as ActionEventOriginal,\n  MessageEnvelope as MessageEnvelopeOriginal,\n  IdentificationData as IdentificationDataOriginal,\n  IdentificationDataIdOneOf as IdentificationDataIdOneOfOriginal,\n  WebhookIdentityType as WebhookIdentityTypeOriginal,\n  WebhookIdentityTypeWithLiterals as WebhookIdentityTypeWithLiteralsOriginal,\n  AccountInfo as AccountInfoOriginal,\n} from './payments-payouts-v4-payout-payouts.types.js';\n"],"mappings":";;;;;;;;;;;;;;;;;;;;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA,mBAAAA;AAAA,EAAA,mBAAAC;AAAA;AAAA;;;ACAA,0BAAkC;AAClC,uBAAqD;AACrD,IAAAC,oBAAqD;AACrD,6BAA+B;AAC/B,IAAAC,uBAA2B;AAI3B,SAAS,6CACP,MACA;AACA,QAAM,mBAAmB;AAAA,IACvB,yBAAyB;AAAA,MACvB;AAAA,QACE,SAAS;AAAA,QACT,UAAU;AAAA,MACZ;AAAA,IACF;AAAA,IACA,wBAAwB;AAAA,MACtB;AAAA,QACE,SAAS;AAAA,QACT,UAAU;AAAA,MACZ;AAAA,MACA;AAAA,QACE,SAAS;AAAA,QACT,UAAU;AAAA,MACZ;AAAA,IACF;AAAA,IACA,oBAAoB;AAAA,MAClB;AAAA,QACE,SAAS;AAAA,QACT,UAAU;AAAA,MACZ;AAAA,MACA;AAAA,QACE,SAAS;AAAA,QACT,UAAU;AAAA,MACZ;AAAA,MACA;AAAA,QACE,SAAS;AAAA,QACT,UAAU;AAAA,MACZ;AAAA,MACA;AAAA,QACE,SAAS;AAAA,QACT,UAAU;AAAA,MACZ;AAAA,IACF;AAAA,IACA,YAAY;AAAA,MACV;AAAA,QACE,SAAS;AAAA,QACT,UAAU;AAAA,MACZ;AAAA,MACA;AAAA,QACE,SAAS;AAAA,QACT,UAAU;AAAA,MACZ;AAAA,MACA;AAAA,QACE,SAAS;AAAA,QACT,UAAU;AAAA,MACZ;AAAA,MACA;AAAA,QACE,SAAS;AAAA,QACT,UAAU;AAAA,MACZ;AAAA,IACF;AAAA,IACA,cAAc;AAAA,MACZ;AAAA,QACE,SAAS;AAAA,QACT,UAAU;AAAA,MACZ;AAAA,MACA;AAAA,QACE,SAAS;AAAA,QACT,UAAU;AAAA,MACZ;AAAA,MACA;AAAA,QACE,SAAS;AAAA,QACT,UAAU;AAAA,MACZ;AAAA,MACA;AAAA,QACE,SAAS;AAAA,QACT,UAAU;AAAA,MACZ;AAAA,IACF;AAAA,IACA,gCAAgC;AAAA,MAC9B;AAAA,QACE,SAAS;AAAA,QACT,UAAU;AAAA,MACZ;AAAA,MACA;AAAA,QACE,SAAS;AAAA,QACT,UAAU;AAAA,MACZ;AAAA,MACA;AAAA,QACE,SAAS;AAAA,QACT,UAAU;AAAA,MACZ;AAAA,MACA;AAAA,QACE,SAAS;AAAA,QACT,UAAU;AAAA,MACZ;AAAA,IACF;AAAA,IACA,+BAA+B;AAAA,MAC7B;AAAA,QACE,SAAS;AAAA,QACT,UAAU;AAAA,MACZ;AAAA,IACF;AAAA,IACA,qBAAqB;AAAA,MACnB;AAAA,QACE,SAAS;AAAA,QACT,UAAU;AAAA,MACZ;AAAA,IACF;AAAA,IACA,uBAAuB;AAAA,MACrB;AAAA,QACE,SAAS;AAAA,QACT,UAAU;AAAA,MACZ;AAAA,IACF;AAAA,IACA,mBAAmB;AAAA,MACjB;AAAA,QACE,SAAS;AAAA,QACT,UAAU;AAAA,MACZ;AAAA,IACF;AAAA,EACF;AAEA,aAAO,iCAAW,OAAO,OAAO,MAAM,EAAE,iBAAiB,CAAC,CAAC;AAC7D;AAEA,IAAM,eAAe;AAMd,SAAS,YAAY,SAA6C;AACvE,WAAS,cAAc,EAAE,KAAK,GAAQ;AACpC,UAAM,qBAAiB,uCAAe,SAAS;AAAA,MAC7C;AAAA,QACE,aAAa;AAAA,QACb,OAAO,CAAC,EAAE,MAAM,gBAAgB,GAAG,EAAE,MAAM,eAAe,CAAC;AAAA,MAC7D;AAAA,IACF,CAAC;AACD,UAAM,WAAW;AAAA,MACf,YAAY;AAAA,MACZ,QAAQ;AAAA,MACR,WAAW;AAAA,MACX,aAAa;AAAA,MACb,kBAAkB;AAAA,QAChB,wBAAwB;AAAA,MAC1B;AAAA,MACA,KAAK,6CAA6C;AAAA,QAChD,WAAW;AAAA,QACX,MAAM;AAAA,QACN;AAAA,MACF,CAAC;AAAA,MACD,YAAQ,uCAAkB,gBAAgB,IAAI;AAAA,MAC9C,mBAAmB,CAACC,iBAClB,uCAAeA,UAAS;AAAA,QACtB;AAAA,UACE,aAAa;AAAA,UACb,OAAO,CAAC,EAAE,MAAM,sBAAsB,CAAC;AAAA,QACzC;AAAA,MACF,CAAC;AAAA,IACL;AAEA,WAAO;AAAA,EACT;AAEA,SAAO;AACT;AAGO,SAAS,UAAU,SAA6C;AACrE,WAAS,YAAY,EAAE,KAAK,GAAQ;AAClC,UAAM,WAAW;AAAA,MACf,YAAY;AAAA,MACZ,QAAQ;AAAA,MACR,WAAW;AAAA,MACX,aAAa;AAAA,MACb,kBAAkB;AAAA,QAChB,wBAAwB;AAAA,MAC1B;AAAA,MACA,KAAK,6CAA6C;AAAA,QAChD,WAAW;AAAA,QACX,MAAM;AAAA,QACN;AAAA,MACF,CAAC;AAAA,MACD,YAAQ,uCAAkB,OAAO;AAAA,MACjC,mBAAmB,CAACA,iBAClB,uCAAeA,UAAS;AAAA,QACtB;AAAA,UACE,aAAa;AAAA,UACb,OAAO,CAAC,EAAE,MAAM,qBAAqB,CAAC;AAAA,QACxC;AAAA,MACF,CAAC;AAAA,IACL;AAEA,WAAO;AAAA,EACT;AAEA,SAAO;AACT;;;ACrHO,IAAK,eAAL,kBAAKC,kBAAL;AAEL,EAAAA,cAAA,aAAU;AAOV,EAAAA,cAAA,UAAO;AAKP,EAAAA,cAAA,YAAS;AAdC,SAAAA;AAAA,GAAA;AAsCL,IAAK,oBAAL,kBAAKC,uBAAL;AAML,EAAAA,mBAAA,4BAAyB;AAKzB,EAAAA,mBAAA,oBAAiB;AAKjB,EAAAA,mBAAA,oBAAiB;AAKjB,EAAAA,mBAAA,6BAA0B;AAK1B,EAAAA,mBAAA,4BAAyB;AAKzB,EAAAA,mBAAA,uBAAoB;AAKpB,EAAAA,mBAAA,0BAAuB;AAKvB,EAAAA,mBAAA,mCAAgC;AAEhC,EAAAA,mBAAA,kCAA+B;AAE/B,EAAAA,mBAAA,4BAAyB;AAEzB,EAAAA,mBAAA,sBAAmB;AAEnB,EAAAA,mBAAA,4BAAyB;AAEzB,EAAAA,mBAAA,uBAAoB;AAKpB,EAAAA,mBAAA,gBAAa;AAKb,EAAAA,mBAAA,qBAAkB;AA7DR,SAAAA;AAAA,GAAA;AAmHL,IAAK,YAAL,kBAAKC,eAAL;AACL,EAAAA,WAAA,SAAM;AACN,EAAAA,WAAA,UAAO;AAFG,SAAAA;AAAA,GAAA;AAqSL,IAAK,sBAAL,kBAAKC,yBAAL;AACL,EAAAA,qBAAA,aAAU;AACV,EAAAA,qBAAA,uBAAoB;AACpB,EAAAA,qBAAA,YAAS;AACT,EAAAA,qBAAA,cAAW;AACX,EAAAA,qBAAA,SAAM;AALI,SAAAA;AAAA,GAAA;;;AC7fL,SAASC,eAOd;AACA,QAAM,UAAU,CAAC;AAEjB,QAAM,oBACiC,YAAY,OAAO;AAE1D,QAAM,SAAS,CAAC,YAAyB;AACvC,UAAM,EAAE,IAAI,IAAI,kBAAkB,OAAO;AACzC,WAAO;AAAA,EACT;AAEA,SAAO;AAAA,IACL;AAAA,IACA,YAAY;AAAA,IACZ,MAAM;AAAA,IACN,YAAY,CAAC;AAAA,IACb,eAAe;AAAA,IACf,uBAAuB;AAAA,IACvB,gBAAgB;AAAA,IAChB,wBAAwB;AAAA,EAC1B;AACF;AAEO,SAASC,aAOd;AACA,QAAM,UAAU,EAAE,UAAU,YAAY;AAExC,QAAM,oBACiC,UAAU,OAAO;AAExD,QAAM,SAAS,CAAC,YAAyB;AACvC,UAAM,EAAE,IAAI,IAAI,kBAAkB,OAAO;AACzC,WAAO;AAAA,EACT;AAEA,SAAO;AAAA,IACL;AAAA,IACA,YAAY;AAAA,IACZ,MAAM;AAAA,IACN,YAAY,EAAE,UAAU,WAAW;AAAA,IACnC,eAAe;AAAA,IACf,uBAAuB;AAAA,IACvB,gBAAgB;AAAA,IAChB,wBAAwB;AAAA,EAC1B;AACF;","names":["getPayout","listPayouts","import_timestamp","import_rest_modules","payload","PayoutStatus","PayoutFailureCode","SortOrder","WebhookIdentityType","listPayouts","getPayout"]}
+{"version":3,"sources":["../../meta.ts","../../src/payments-payouts-v4-payout-payouts.http.ts","../../src/payments-payouts-v4-payout-payouts.types.ts","../../src/payments-payouts-v4-payout-payouts.meta.ts"],"sourcesContent":["export * from './src/payments-payouts-v4-payout-payouts.meta.js';\n","import { toURLSearchParams } from '@wix/sdk-runtime/rest-modules';\nimport { transformSDKTimestampToRESTTimestamp } from '@wix/sdk-runtime/transformations/timestamp';\nimport { transformRESTTimestampToSDKTimestamp } from '@wix/sdk-runtime/transformations/timestamp';\nimport { transformPaths } from '@wix/sdk-runtime/transformations/transform-paths';\nimport { resolveUrl } from '@wix/sdk-runtime/rest-modules';\nimport { ResolveUrlOpts } from '@wix/sdk-runtime/rest-modules';\nimport { RequestOptionsFactory } from '@wix/sdk-types';\n\nfunction resolveWixPaymentsV4PayoutsPayoutsServiceUrl(\n  opts: Omit<ResolveUrlOpts, 'domainToMappings'>\n) {\n  const domainToMappings = {\n    'api._api_base_domain_': [\n      {\n        srcPath: '/wixpay-payout',\n        destPath: '',\n      },\n    ],\n    'manage._base_domain_': [\n      {\n        srcPath: '/_api/wixpay-payout/v4/payout-groups',\n        destPath: '/v4/payout-groups',\n      },\n      {\n        srcPath: '/_api/wixpay-payout/v4/payouts',\n        destPath: '/v4/payouts',\n      },\n    ],\n    'bo._base_domain_': [\n      {\n        srcPath: '/_api/wixpay-payout/v4/payouts',\n        destPath: '/v4/payouts',\n      },\n      {\n        srcPath: '/_api/wixpay-payout/v4/payout-groups',\n        destPath: '/v4/payout-groups',\n      },\n      {\n        srcPath: '/_api/wixpay-payout/v4/bo-payouts',\n        destPath: '/v4/bo-payouts',\n      },\n      {\n        srcPath: '/_api/wixpay-payout/v4/bo-payout-policies',\n        destPath: '/v4/bo-payout-policies',\n      },\n    ],\n    'wixbo.ai': [\n      {\n        srcPath: '/_api/wixpay-payout/v4/payouts',\n        destPath: '/v4/payouts',\n      },\n      {\n        srcPath: '/_api/wixpay-payout/v4/payout-groups',\n        destPath: '/v4/payout-groups',\n      },\n      {\n        srcPath: '/_api/wixpay-payout/v4/bo-payouts',\n        destPath: '/v4/bo-payouts',\n      },\n      {\n        srcPath: '/_api/wixpay-payout/v4/bo-payout-policies',\n        destPath: '/v4/bo-payout-policies',\n      },\n    ],\n    'wix-bo.com': [\n      {\n        srcPath: '/_api/wixpay-payout/v4/payouts',\n        destPath: '/v4/payouts',\n      },\n      {\n        srcPath: '/_api/wixpay-payout/v4/payout-groups',\n        destPath: '/v4/payout-groups',\n      },\n      {\n        srcPath: '/_api/wixpay-payout/v4/bo-payouts',\n        destPath: '/v4/bo-payouts',\n      },\n      {\n        srcPath: '/_api/wixpay-payout/v4/bo-payout-policies',\n        destPath: '/v4/bo-payout-policies',\n      },\n    ],\n    'payment-webhooks.wixapps.net': [\n      {\n        srcPath: '/wix-payments/payout-callbacks/stripe',\n        destPath: '/payout-callbacks/stripe',\n      },\n      {\n        srcPath: '/wix-payments/payout-callbacks/adyen',\n        destPath: '/payout-callbacks/adyen',\n      },\n      {\n        srcPath: '/wix-payments/payout-callbacks/stone',\n        destPath: '/payout-callbacks/stone',\n      },\n      {\n        srcPath: '/wix-payments/payout-callbacks/paypal',\n        destPath: '/payout-callbacks/paypal',\n      },\n    ],\n    'cronulla-jobs._base_domain_': [\n      {\n        srcPath: '/wix-payments/wixpay-payout/internal-api/jobs',\n        destPath: '/internal-api/jobs',\n      },\n    ],\n    'manage.base44.com': [\n      {\n        srcPath: '/_api/wixpay-payout',\n        destPath: '',\n      },\n    ],\n    'payments.base44.com': [\n      {\n        srcPath: '/_api/wixpay-payout',\n        destPath: '',\n      },\n    ],\n    'www.wixapis.com': [\n      {\n        srcPath: '/wixpay-payouts/v4/payouts',\n        destPath: '/v4/payouts',\n      },\n    ],\n  };\n\n  return resolveUrl(Object.assign(opts, { domainToMappings }));\n}\n\nconst PACKAGE_NAME = '@wix/auto_sdk_payments_payouts';\n\n/**\n * Retrieves a paginated list of payouts for the specified Wix Payments account.\n *\n * Supports optional filters by account profile and by creation date range.\n */\nexport function listPayouts(payload: object): RequestOptionsFactory<any> {\n  function __listPayouts({ host }: any) {\n    const serializedData = transformPaths(payload, [\n      {\n        transformFn: transformSDKTimestampToRESTTimestamp,\n        paths: [{ path: 'createdBefore' }, { path: 'createdAfter' }],\n      },\n    ]);\n    const metadata = {\n      entityFqdn: 'wix.payments.payouts.v4.payout',\n      method: 'GET' as any,\n      methodFqn: 'wix.payments.v4.payouts.PayoutsService.ListPayouts',\n      packageName: PACKAGE_NAME,\n      migrationOptions: {\n        optInTransformResponse: true,\n      },\n      url: resolveWixPaymentsV4PayoutsPayoutsServiceUrl({\n        protoPath: '/v4/payouts',\n        data: serializedData,\n        host,\n      }),\n      params: toURLSearchParams(serializedData, true),\n      transformResponse: (payload: any) =>\n        transformPaths(payload, [\n          {\n            transformFn: transformRESTTimestampToSDKTimestamp,\n            paths: [{ path: 'payouts.createdDate' }],\n          },\n        ]),\n    };\n\n    return metadata;\n  }\n\n  return __listPayouts;\n}\n\n/** Retrieves a single payout by ID. */\nexport function getPayout(payload: object): RequestOptionsFactory<any> {\n  function __getPayout({ host }: any) {\n    const metadata = {\n      entityFqdn: 'wix.payments.payouts.v4.payout',\n      method: 'GET' as any,\n      methodFqn: 'wix.payments.v4.payouts.PayoutsService.GetPayout',\n      packageName: PACKAGE_NAME,\n      migrationOptions: {\n        optInTransformResponse: true,\n      },\n      url: resolveWixPaymentsV4PayoutsPayoutsServiceUrl({\n        protoPath: '/v4/payouts/{payoutId}',\n        data: payload,\n        host,\n      }),\n      params: toURLSearchParams(payload),\n      transformResponse: (payload: any) =>\n        transformPaths(payload, [\n          {\n            transformFn: transformRESTTimestampToSDKTimestamp,\n            paths: [{ path: 'payout.createdDate' }],\n          },\n        ]),\n    };\n\n    return metadata;\n  }\n\n  return __getPayout;\n}\n","/**\n * A payout is an outgoing transfer of funds from a Wix Payments account to the\n * merchant's bank account. Each payout has an amount, a lifecycle status, an\n * estimated arrival date, and (when applicable) a failure reason.\n */\nexport interface Payout {\n  /**\n   * Payout ID.\n   * @format GUID\n   */\n  id?: string;\n  /**\n   * ID of the Wix Payments account that owns the payout. Retrieve account IDs\n   * from the Accounts API.\n   * @format GUID\n   */\n  accountId?: string;\n  /**\n   * ID of the Wix Payments account profile that owns the payout.\n   *\n   * A Wix Payments account has 1 or more profiles. Each profile has its own\n   * balance and its own payouts. Most merchants have 1 profile. Retrieve\n   * profile IDs from the Accounts API.\n   * @format GUID\n   */\n  accountProfileId?: string;\n  /**\n   * Date and time the payout was created.\n   *\n   * The payout is created before the underlying transfer is initiated at the\n   * bank. Once initiated, the funds typically reach the merchant's bank account\n   * within 3 to 5 business days, depending on the receiving bank.\n   */\n  createdDate?: Date | null;\n  /** Amount of the transfer to the merchant's bank account. */\n  amount?: Money;\n  /**\n   * Lifecycle status of the payout.\n   *\n   * `SENT` means the bank rail accepted the transfer for delivery. `FAILED` means\n   * the receiving bank rejected the transfer.\n   *\n   * A `SENT` status doesn't guarantee that the funds were delivered to the\n   * merchant. The bank rail doesn't provide a delivery acknowledgement, and a\n   * payout in `SENT` can later transition to `FAILED` if the receiving bank\n   * rejects the transfer. See the per-value documentation on `PayoutStatus` for\n   * details.\n   */\n  status?: PayoutStatusWithLiterals;\n  /**\n   * Estimated date for when the funds should arrive at the merchant's bank\n   * account, in `YYYY-MM-DD` format.\n   *\n   * The estimated arrival date is a prediction, not a guarantee. Actual arrival\n   * depends on the receiving bank's processing and may be later.\n   * @format LOCAL_DATE\n   */\n  estimatedArrivalDateV2?: string | null;\n  /**\n   * Reason the bank rail rejected the transfer.\n   *\n   * Returned only when `status` is `FAILED`.\n   */\n  failureReason?: PayoutFailureReason;\n  /**\n   * Reference returned by the bank rail once the transfer is initiated. For\n   * example, an ACH trace number or a SEPA reference. Use this value to\n   * reconcile against the merchant's bank statement.\n   *\n   * Empty until the bank rail returns a reference.\n   * @maxLength 500\n   */\n  bankTransferReference?: string | null;\n  /**\n   * Whether the payout `amount` includes funds from a Wix Capital cash advance\n   * taken out by the merchant. If `false`, the amount comes only from the\n   * merchant's sales proceeds.\n   */\n  cashAdvanceIncluded?: boolean;\n}\n\n/**\n * Money.\n * Default format to use. Sufficiently compliant with majority of standards: w3c, ISO 4217, ISO 20022, ISO 8583:2003.\n */\nexport interface Money {\n  /**\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   * @format DECIMAL_VALUE\n   */\n  value?: string;\n  /**\n   * Currency code. Must be valid ISO 4217 currency code (e.g., USD).\n   * @format CURRENCY\n   */\n  currency?: string;\n  /** Monetary amount. Decimal string in local format (e.g., 1 000,30). Optionally, a single (-), to indicate that the amount is negative. */\n  formattedValue?: string | null;\n}\n\n/** Lifecycle status of a payout. */\nexport enum PayoutStatus {\n  /** Unknown payout status. Not returned by the API. */\n  UNKNOWN = 'UNKNOWN',\n  /**\n   * The bank rail accepted the transfer. Funds are en route to the merchant's\n   * bank account.\n   *\n   * Acceptance isn't the same as delivery. A `SENT` payout can still\n   * transition to `FAILED` if the receiving bank rejects the transfer. The\n   * bank rail's return window is up to 60 days for ACH and up to 13 months\n   * for SEPA.\n   */\n  SENT = 'SENT',\n  /**\n   * The bank rail rejected the transfer. See `failureReason` for the cause.\n   * The funds remain in the merchant's Wix Payments balance.\n   */\n  FAILED = 'FAILED',\n}\n\n/** @enumType */\nexport type PayoutStatusWithLiterals =\n  | PayoutStatus\n  | 'UNKNOWN'\n  | 'SENT'\n  | 'FAILED';\n\n/** Reason a payout failed. */\nexport interface PayoutFailureReason {\n  /** Why the bank rail rejected the transfer. */\n  code?: PayoutFailureCodeWithLiterals;\n}\n\n/**\n * Possible reasons for a payout failure. Each value describes a real-world\n * bank-rail condition.\n */\nexport enum PayoutFailureCode {\n  /**\n   * Generic failure with no more specific reason available from the bank\n   * rail. This value is also returned when no failure reason is known.\n   * Clients can't distinguish \"unknown\" from \"generic\" using this code alone.\n   */\n  GENERIC_PAYOUT_FAILURE = 'GENERIC_PAYOUT_FAILURE',\n  /**\n   * The merchant's bank account is closed. The merchant must provide new\n   * bank account details before further payouts can succeed.\n   */\n  ACCOUNT_CLOSED = 'ACCOUNT_CLOSED',\n  /**\n   * The merchant's bank account is frozen, for example due to a hold placed\n   * by the bank. The merchant must resolve the hold with their bank before\n   * further payouts can succeed.\n   */\n  ACCOUNT_FROZEN = 'ACCOUNT_FROZEN',\n  /**\n   * The merchant's bank account is restricted from receiving the transfer.\n   * For example, the account type or status doesn't permit incoming credits.\n   */\n  BANK_ACCOUNT_RESTRICTED = 'BANK_ACCOUNT_RESTRICTED',\n  /**\n   * Ownership of the merchant's bank account changed and the rail no longer\n   * recognises the previously-recorded owner. New bank details are required.\n   */\n  BANK_OWNERSHIP_CHANGED = 'BANK_OWNERSHIP_CHANGED',\n  /**\n   * The receiving bank couldn't process the transfer for an unspecified\n   * reason. A subsequent payout attempt may succeed.\n   */\n  COULD_NOT_PROCESS = 'COULD_NOT_PROCESS',\n  /**\n   * The merchant's bank declined the debit authorisation associated with the\n   * transfer. The merchant must contact their bank to authorise Wix Payments\n   * payouts.\n   */\n  DEBIT_NOT_AUTHORIZED = 'DEBIT_NOT_AUTHORIZED',\n  /**\n   * The account holder name on file doesn't match the name the receiving\n   * bank has on record. The merchant must correct the account holder name.\n   */\n  INCORRECT_ACCOUNT_HOLDER_NAME = 'INCORRECT_ACCOUNT_HOLDER_NAME',\n  /** The city in the bank account details is invalid for the receiving bank. */\n  INVALID_ACCOUNT_DETAILS_CITY = 'INVALID_ACCOUNT_DETAILS_CITY',\n  /**\n   * The bank account number is invalid. The format is wrong or the account\n   * doesn't exist.\n   */\n  INVALID_ACCOUNT_NUMBER = 'INVALID_ACCOUNT_NUMBER',\n  /** The payout currency isn't supported by the receiving bank account. */\n  INVALID_CURRENCY = 'INVALID_CURRENCY',\n  /** The routing number (US) is invalid or doesn't match the receiving bank. */\n  INVALID_ROUTING_NUMBER = 'INVALID_ROUTING_NUMBER',\n  /** The sort code (UK) is invalid or doesn't match the receiving bank. */\n  INVALID_SORT_CODE = 'INVALID_SORT_CODE',\n  /**\n   * No bank account is on file for the merchant. The merchant must add bank\n   * details before payouts can succeed.\n   */\n  NO_ACCOUNT = 'NO_ACCOUNT',\n  /**\n   * A technical error at the bank rail prevented the transfer. A subsequent\n   * payout attempt may succeed.\n   */\n  TECHNICAL_ERROR = 'TECHNICAL_ERROR',\n}\n\n/** @enumType */\nexport type PayoutFailureCodeWithLiterals =\n  | PayoutFailureCode\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\nexport interface ListPayoutsRequest {\n  /**\n   * ID of the Wix Payments account whose payouts to list. Retrieve account\n   * IDs from the Accounts API.\n   * @format GUID\n   */\n  accountId: string;\n  /**\n   * ID of the Wix Payments account profile to filter by.\n   *\n   * When omitted, payouts across all profiles of the account are returned.\n   * Retrieve profile IDs from the Accounts API.\n   * @format GUID\n   */\n  accountProfileId?: string | null;\n  /** Returns only payouts created before this date and time. */\n  createdBefore?: Date | null;\n  /** Returns only payouts created after this date and time. */\n  createdAfter?: Date | null;\n  /**\n   * Sort order for the result list.\n   *\n   * Supported `fieldName` values: `created_date` (snake_case, not auto-converted). At most 1 sort field is allowed.\n   */\n  sort?: Sorting;\n  /** Offset-based paging. */\n  paging?: Paging;\n}\n\nexport interface Sorting {\n  /**\n   * Name of the field to sort by.\n   * @maxLength 512\n   */\n  fieldName?: string;\n  /** Sort order. */\n  order?: SortOrderWithLiterals;\n}\n\nexport enum SortOrder {\n  ASC = 'ASC',\n  DESC = 'DESC',\n}\n\n/** @enumType */\nexport type SortOrderWithLiterals = SortOrder | 'ASC' | 'DESC';\n\nexport interface Paging {\n  /** Number of items to load. */\n  limit?: number | null;\n  /** Number of items to skip in the current sort order. */\n  offset?: number | null;\n}\n\nexport interface ListPayoutsResponse {\n  /** List of retrieved payouts. */\n  payouts?: Payout[];\n  /** Paging metadata. */\n  metadata?: PagingMetadata;\n}\n\nexport interface PagingMetadata {\n  /** Number of items returned in the response. */\n  count?: number | null;\n  /** Offset that was requested. */\n  offset?: number | null;\n  /** Total number of items that match the query. */\n  total?: number | null;\n  /** Flag that indicates the server failed to calculate the `total` field. */\n  tooManyToCount?: boolean | null;\n}\n\nexport interface CreatePayoutRequest {\n  /** Payout to create. */\n  payout?: Payout;\n}\n\nexport interface CreatePayoutResponse {\n  /** Created payout. */\n  payout?: Payout;\n}\n\nexport interface GetPayoutRequest {\n  /**\n   * ID of the Wix Payments account that owns the payout. The payout must\n   * belong to this account. Retrieve account IDs from the Accounts API.\n   * @format GUID\n   */\n  accountId: string;\n  /**\n   * ID of the payout to retrieve.\n   * @format GUID\n   */\n  payoutId: string;\n}\n\nexport interface GetPayoutResponse {\n  /** Retrieved payout. */\n  payout?: Payout;\n}\n\nexport interface ListPayoutGroupsRequest {\n  /**\n   * ID of the Wix Payments account whose payout groups to list. Retrieve\n   * account IDs from the Accounts API.\n   * @format GUID\n   */\n  accountId?: string;\n  /**\n   * Optional filter by payout date. Use it to return payouts before specific date.\n   * @format LOCAL_DATE\n   */\n  payoutDateBefore?: string | null;\n  /**\n   * Optional filter by payout date. Use it to return payouts after specific date.\n   * @format LOCAL_DATE\n   */\n  payoutDateAfter?: string | null;\n  /** Optional sorting. Supported fields: \"payout_date\". */\n  sort?: Sorting;\n  /** Optional paging. */\n  paging?: Paging;\n}\n\nexport interface ListPayoutGroupsResponse {\n  /** List of payout groups. */\n  groups?: PayoutGroup[];\n  /** Paging metadata. */\n  metadata?: PagingMetadata;\n}\n\n/** Payout group */\nexport interface PayoutGroup {\n  /**\n   * Payout date.\n   * @format LOCAL_DATE\n   */\n  payoutDate?: string;\n  /**\n   * Payout number within the same date, is absent if there's only one group\n   * @min 1\n   * @max 99\n   */\n  payoutNumber?: number | null;\n  /** Payout group amount */\n  amount?: Money;\n  /**\n   * Payouts associated with the group\n   * @maxSize 10\n   */\n  payouts?: Payout[];\n}\n\nexport interface GetPayoutGroupRequest {\n  /**\n   * ID of the Wix Payments account that owns the payout group. Retrieve\n   * account IDs from the Accounts API.\n   * @format GUID\n   */\n  accountId?: string;\n  /**\n   * Payout date.\n   * @format LOCAL_DATE\n   */\n  payoutDate?: string;\n  /**\n   * Optional payout number within the same date\n   * @min 1\n   * @max 99\n   */\n  payoutNumber?: number | null;\n}\n\nexport interface GetPayoutGroupResponse {\n  /** Payout group. */\n  group?: PayoutGroup;\n}\n\nexport interface GetPayoutGroupByPayoutIdRequest {\n  /**\n   * ID of the Wix Payments account that owns the payout. Retrieve account IDs\n   * from the Accounts API.\n   * @format GUID\n   */\n  accountId?: string;\n  /**\n   * ID of the payout whose group to retrieve.\n   * @format GUID\n   */\n  payoutId?: string;\n}\n\nexport interface GetPayoutGroupByPayoutIdResponse {\n  /** Payout group. */\n  group?: PayoutGroup;\n}\n\nexport interface DomainEvent extends DomainEventBodyOneOf {\n  createdEvent?: EntityCreatedEvent;\n  updatedEvent?: EntityUpdatedEvent;\n  deletedEvent?: EntityDeletedEvent;\n  actionEvent?: ActionEvent;\n  /** Event ID. With this ID you can easily spot duplicated events and ignore them. */\n  id?: string;\n  /**\n   * Fully Qualified Domain Name of an entity. This is a unique identifier assigned to the API main business entities.\n   * For example, `wix.stores.catalog.product`, `wix.bookings.session`, `wix.payments.transaction`.\n   */\n  entityFqdn?: string;\n  /**\n   * Event action name, placed at the top level to make it easier for users to dispatch messages.\n   * For example: `created`/`updated`/`deleted`/`started`/`completed`/`email_opened`.\n   */\n  slug?: string;\n  /** ID of the entity associated with the event. */\n  entityId?: string;\n  /** Event timestamp in [ISO-8601](https://en.wikipedia.org/wiki/ISO_8601) format and UTC time. For example, `2020-04-26T13:57:50.699Z`. */\n  eventTime?: Date | null;\n  /**\n   * Whether the event was triggered as a result of a privacy regulation application\n   * (for example, GDPR).\n   */\n  triggeredByAnonymizeRequest?: boolean | null;\n  /** If present, indicates the action that triggered the event. */\n  originatedFrom?: string | null;\n  /**\n   * A sequence number that indicates the order of updates to an entity. For example, if an entity was updated at 16:00 and then again at 16:01, the second update will always have a higher sequence number.\n   * You can use this number to make sure you're handling updates in the right order. Just save the latest sequence number on your end and compare it to the one in each new message. If the new message has an older (lower) number, you can safely ignore it.\n   */\n  entityEventSequence?: string | null;\n}\n\n/** @oneof */\nexport interface DomainEventBodyOneOf {\n  createdEvent?: EntityCreatedEvent;\n  updatedEvent?: EntityUpdatedEvent;\n  deletedEvent?: EntityDeletedEvent;\n  actionEvent?: ActionEvent;\n}\n\nexport interface EntityCreatedEvent {\n  entityAsJson?: string;\n  /** Indicates the event was triggered by a restore-from-trashbin operation for a previously deleted entity */\n  restoreInfo?: RestoreInfo;\n}\n\nexport interface RestoreInfo {\n  deletedDate?: Date | null;\n}\n\nexport interface EntityUpdatedEvent {\n  /**\n   * Since platformized APIs only expose PATCH and not PUT we can't assume that the fields sent from the client are the actual diff.\n   * This means that to generate a list of changed fields (as opposed to sent fields) one needs to traverse both objects.\n   * We don't want to impose this on all developers and so we leave this traversal to the notification recipients which need it.\n   */\n  currentEntityAsJson?: string;\n}\n\nexport interface EntityDeletedEvent {\n  /** Entity that was deleted. */\n  deletedEntityAsJson?: string | null;\n}\n\nexport interface ActionEvent {\n  bodyAsJson?: string;\n}\n\nexport interface MessageEnvelope {\n  /**\n   * App instance ID.\n   * @format GUID\n   */\n  instanceId?: string | null;\n  /**\n   * Event type.\n   * @maxLength 150\n   */\n  eventType?: string;\n  /** The identification type and identity data. */\n  identity?: IdentificationData;\n  /** Stringify payload. */\n  data?: string;\n  /** Details related to the account */\n  accountInfo?: AccountInfo;\n}\n\nexport interface IdentificationData extends IdentificationDataIdOneOf {\n  /**\n   * ID of a site visitor that has not logged in to the site.\n   * @format GUID\n   */\n  anonymousVisitorId?: string;\n  /**\n   * ID of a site visitor that has logged in to the site.\n   * @format GUID\n   */\n  memberId?: string;\n  /**\n   * ID of a Wix user (site owner, contributor, etc.).\n   * @format GUID\n   */\n  wixUserId?: string;\n  /**\n   * ID of an app.\n   * @format GUID\n   */\n  appId?: string;\n  /** @readonly */\n  identityType?: WebhookIdentityTypeWithLiterals;\n}\n\n/** @oneof */\nexport interface IdentificationDataIdOneOf {\n  /**\n   * ID of a site visitor that has not logged in to the site.\n   * @format GUID\n   */\n  anonymousVisitorId?: string;\n  /**\n   * ID of a site visitor that has logged in to the site.\n   * @format GUID\n   */\n  memberId?: string;\n  /**\n   * ID of a Wix user (site owner, contributor, etc.).\n   * @format GUID\n   */\n  wixUserId?: string;\n  /**\n   * ID of an app.\n   * @format GUID\n   */\n  appId?: string;\n}\n\nexport enum WebhookIdentityType {\n  UNKNOWN = 'UNKNOWN',\n  ANONYMOUS_VISITOR = 'ANONYMOUS_VISITOR',\n  MEMBER = 'MEMBER',\n  WIX_USER = 'WIX_USER',\n  APP = 'APP',\n}\n\n/** @enumType */\nexport type WebhookIdentityTypeWithLiterals =\n  | WebhookIdentityType\n  | 'UNKNOWN'\n  | 'ANONYMOUS_VISITOR'\n  | 'MEMBER'\n  | 'WIX_USER'\n  | 'APP';\n\nexport interface AccountInfo {\n  /**\n   * ID of the Wix account associated with the event.\n   * @format GUID\n   */\n  accountId?: string | null;\n  /**\n   * ID of the parent Wix account. Only included when accountId belongs to a child account.\n   * @format GUID\n   */\n  parentAccountId?: string | null;\n  /**\n   * ID of the Wix site associated with the event. Only included when the event is tied to a specific site.\n   * @format GUID\n   */\n  siteId?: string | null;\n}\n","import * as ambassadorWixPaymentsPayoutsV4Payout from './payments-payouts-v4-payout-payouts.http.js';\nimport * as ambassadorWixPaymentsPayoutsV4PayoutTypes from './payments-payouts-v4-payout-payouts.types.js';\nimport * as ambassadorWixPaymentsPayoutsV4PayoutUniversalTypes from './payments-payouts-v4-payout-payouts.universal.js';\n\nexport type __PublicMethodMetaInfo<\n  K = string,\n  M = unknown,\n  T = unknown,\n  S = unknown,\n  Q = unknown,\n  R = unknown\n> = {\n  getUrl: (context: any) => string;\n  httpMethod: K;\n  path: string;\n  pathParams: M;\n  __requestType: T;\n  __originalRequestType: S;\n  __responseType: Q;\n  __originalResponseType: R;\n};\n\nexport function listPayouts(): __PublicMethodMetaInfo<\n  'GET',\n  {},\n  ambassadorWixPaymentsPayoutsV4PayoutUniversalTypes.ListPayoutsRequest,\n  ambassadorWixPaymentsPayoutsV4PayoutTypes.ListPayoutsRequest,\n  ambassadorWixPaymentsPayoutsV4PayoutUniversalTypes.ListPayoutsResponse,\n  ambassadorWixPaymentsPayoutsV4PayoutTypes.ListPayoutsResponse\n> {\n  const payload = {} as any;\n\n  const getRequestOptions =\n    ambassadorWixPaymentsPayoutsV4Payout.listPayouts(payload);\n\n  const getUrl = (context: any): string => {\n    const { url } = getRequestOptions(context);\n    return url!;\n  };\n\n  return {\n    getUrl,\n    httpMethod: 'GET',\n    path: '/v4/payouts',\n    pathParams: {},\n    __requestType: null as any,\n    __originalRequestType: null as any,\n    __responseType: null as any,\n    __originalResponseType: null as any,\n  };\n}\n\nexport function getPayout(): __PublicMethodMetaInfo<\n  'GET',\n  { payoutId: string },\n  ambassadorWixPaymentsPayoutsV4PayoutUniversalTypes.GetPayoutRequest,\n  ambassadorWixPaymentsPayoutsV4PayoutTypes.GetPayoutRequest,\n  ambassadorWixPaymentsPayoutsV4PayoutUniversalTypes.GetPayoutResponse,\n  ambassadorWixPaymentsPayoutsV4PayoutTypes.GetPayoutResponse\n> {\n  const payload = { payoutId: ':payoutId' } as any;\n\n  const getRequestOptions =\n    ambassadorWixPaymentsPayoutsV4Payout.getPayout(payload);\n\n  const getUrl = (context: any): string => {\n    const { url } = getRequestOptions(context);\n    return url!;\n  };\n\n  return {\n    getUrl,\n    httpMethod: 'GET',\n    path: '/v4/payouts/{payoutId}',\n    pathParams: { payoutId: 'payoutId' },\n    __requestType: null as any,\n    __originalRequestType: null as any,\n    __responseType: null as any,\n    __originalResponseType: null as any,\n  };\n}\n\nexport {\n  Payout as PayoutOriginal,\n  Money as MoneyOriginal,\n  PayoutStatus as PayoutStatusOriginal,\n  PayoutStatusWithLiterals as PayoutStatusWithLiteralsOriginal,\n  PayoutFailureReason as PayoutFailureReasonOriginal,\n  PayoutFailureCode as PayoutFailureCodeOriginal,\n  PayoutFailureCodeWithLiterals as PayoutFailureCodeWithLiteralsOriginal,\n  ListPayoutsRequest as ListPayoutsRequestOriginal,\n  Sorting as SortingOriginal,\n  SortOrder as SortOrderOriginal,\n  SortOrderWithLiterals as SortOrderWithLiteralsOriginal,\n  Paging as PagingOriginal,\n  ListPayoutsResponse as ListPayoutsResponseOriginal,\n  PagingMetadata as PagingMetadataOriginal,\n  CreatePayoutRequest as CreatePayoutRequestOriginal,\n  CreatePayoutResponse as CreatePayoutResponseOriginal,\n  GetPayoutRequest as GetPayoutRequestOriginal,\n  GetPayoutResponse as GetPayoutResponseOriginal,\n  ListPayoutGroupsRequest as ListPayoutGroupsRequestOriginal,\n  ListPayoutGroupsResponse as ListPayoutGroupsResponseOriginal,\n  PayoutGroup as PayoutGroupOriginal,\n  GetPayoutGroupRequest as GetPayoutGroupRequestOriginal,\n  GetPayoutGroupResponse as GetPayoutGroupResponseOriginal,\n  GetPayoutGroupByPayoutIdRequest as GetPayoutGroupByPayoutIdRequestOriginal,\n  GetPayoutGroupByPayoutIdResponse as GetPayoutGroupByPayoutIdResponseOriginal,\n  DomainEvent as DomainEventOriginal,\n  DomainEventBodyOneOf as DomainEventBodyOneOfOriginal,\n  EntityCreatedEvent as EntityCreatedEventOriginal,\n  RestoreInfo as RestoreInfoOriginal,\n  EntityUpdatedEvent as EntityUpdatedEventOriginal,\n  EntityDeletedEvent as EntityDeletedEventOriginal,\n  ActionEvent as ActionEventOriginal,\n  MessageEnvelope as MessageEnvelopeOriginal,\n  IdentificationData as IdentificationDataOriginal,\n  IdentificationDataIdOneOf as IdentificationDataIdOneOfOriginal,\n  WebhookIdentityType as WebhookIdentityTypeOriginal,\n  WebhookIdentityTypeWithLiterals as WebhookIdentityTypeWithLiteralsOriginal,\n  AccountInfo as AccountInfoOriginal,\n} from './payments-payouts-v4-payout-payouts.types.js';\n"],"mappings":";;;;;;;;;;;;;;;;;;;;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA,mBAAAA;AAAA,EAAA,mBAAAC;AAAA;AAAA;;;ACAA,0BAAkC;AAClC,uBAAqD;AACrD,IAAAC,oBAAqD;AACrD,6BAA+B;AAC/B,IAAAC,uBAA2B;AAI3B,SAAS,6CACP,MACA;AACA,QAAM,mBAAmB;AAAA,IACvB,yBAAyB;AAAA,MACvB;AAAA,QACE,SAAS;AAAA,QACT,UAAU;AAAA,MACZ;AAAA,IACF;AAAA,IACA,wBAAwB;AAAA,MACtB;AAAA,QACE,SAAS;AAAA,QACT,UAAU;AAAA,MACZ;AAAA,MACA;AAAA,QACE,SAAS;AAAA,QACT,UAAU;AAAA,MACZ;AAAA,IACF;AAAA,IACA,oBAAoB;AAAA,MAClB;AAAA,QACE,SAAS;AAAA,QACT,UAAU;AAAA,MACZ;AAAA,MACA;AAAA,QACE,SAAS;AAAA,QACT,UAAU;AAAA,MACZ;AAAA,MACA;AAAA,QACE,SAAS;AAAA,QACT,UAAU;AAAA,MACZ;AAAA,MACA;AAAA,QACE,SAAS;AAAA,QACT,UAAU;AAAA,MACZ;AAAA,IACF;AAAA,IACA,YAAY;AAAA,MACV;AAAA,QACE,SAAS;AAAA,QACT,UAAU;AAAA,MACZ;AAAA,MACA;AAAA,QACE,SAAS;AAAA,QACT,UAAU;AAAA,MACZ;AAAA,MACA;AAAA,QACE,SAAS;AAAA,QACT,UAAU;AAAA,MACZ;AAAA,MACA;AAAA,QACE,SAAS;AAAA,QACT,UAAU;AAAA,MACZ;AAAA,IACF;AAAA,IACA,cAAc;AAAA,MACZ;AAAA,QACE,SAAS;AAAA,QACT,UAAU;AAAA,MACZ;AAAA,MACA;AAAA,QACE,SAAS;AAAA,QACT,UAAU;AAAA,MACZ;AAAA,MACA;AAAA,QACE,SAAS;AAAA,QACT,UAAU;AAAA,MACZ;AAAA,MACA;AAAA,QACE,SAAS;AAAA,QACT,UAAU;AAAA,MACZ;AAAA,IACF;AAAA,IACA,gCAAgC;AAAA,MAC9B;AAAA,QACE,SAAS;AAAA,QACT,UAAU;AAAA,MACZ;AAAA,MACA;AAAA,QACE,SAAS;AAAA,QACT,UAAU;AAAA,MACZ;AAAA,MACA;AAAA,QACE,SAAS;AAAA,QACT,UAAU;AAAA,MACZ;AAAA,MACA;AAAA,QACE,SAAS;AAAA,QACT,UAAU;AAAA,MACZ;AAAA,IACF;AAAA,IACA,+BAA+B;AAAA,MAC7B;AAAA,QACE,SAAS;AAAA,QACT,UAAU;AAAA,MACZ;AAAA,IACF;AAAA,IACA,qBAAqB;AAAA,MACnB;AAAA,QACE,SAAS;AAAA,QACT,UAAU;AAAA,MACZ;AAAA,IACF;AAAA,IACA,uBAAuB;AAAA,MACrB;AAAA,QACE,SAAS;AAAA,QACT,UAAU;AAAA,MACZ;AAAA,IACF;AAAA,IACA,mBAAmB;AAAA,MACjB;AAAA,QACE,SAAS;AAAA,QACT,UAAU;AAAA,MACZ;AAAA,IACF;AAAA,EACF;AAEA,aAAO,iCAAW,OAAO,OAAO,MAAM,EAAE,iBAAiB,CAAC,CAAC;AAC7D;AAEA,IAAM,eAAe;AAOd,SAAS,YAAY,SAA6C;AACvE,WAAS,cAAc,EAAE,KAAK,GAAQ;AACpC,UAAM,qBAAiB,uCAAe,SAAS;AAAA,MAC7C;AAAA,QACE,aAAa;AAAA,QACb,OAAO,CAAC,EAAE,MAAM,gBAAgB,GAAG,EAAE,MAAM,eAAe,CAAC;AAAA,MAC7D;AAAA,IACF,CAAC;AACD,UAAM,WAAW;AAAA,MACf,YAAY;AAAA,MACZ,QAAQ;AAAA,MACR,WAAW;AAAA,MACX,aAAa;AAAA,MACb,kBAAkB;AAAA,QAChB,wBAAwB;AAAA,MAC1B;AAAA,MACA,KAAK,6CAA6C;AAAA,QAChD,WAAW;AAAA,QACX,MAAM;AAAA,QACN;AAAA,MACF,CAAC;AAAA,MACD,YAAQ,uCAAkB,gBAAgB,IAAI;AAAA,MAC9C,mBAAmB,CAACC,iBAClB,uCAAeA,UAAS;AAAA,QACtB;AAAA,UACE,aAAa;AAAA,UACb,OAAO,CAAC,EAAE,MAAM,sBAAsB,CAAC;AAAA,QACzC;AAAA,MACF,CAAC;AAAA,IACL;AAEA,WAAO;AAAA,EACT;AAEA,SAAO;AACT;AAGO,SAAS,UAAU,SAA6C;AACrE,WAAS,YAAY,EAAE,KAAK,GAAQ;AAClC,UAAM,WAAW;AAAA,MACf,YAAY;AAAA,MACZ,QAAQ;AAAA,MACR,WAAW;AAAA,MACX,aAAa;AAAA,MACb,kBAAkB;AAAA,QAChB,wBAAwB;AAAA,MAC1B;AAAA,MACA,KAAK,6CAA6C;AAAA,QAChD,WAAW;AAAA,QACX,MAAM;AAAA,QACN;AAAA,MACF,CAAC;AAAA,MACD,YAAQ,uCAAkB,OAAO;AAAA,MACjC,mBAAmB,CAACA,iBAClB,uCAAeA,UAAS;AAAA,QACtB;AAAA,UACE,aAAa;AAAA,UACb,OAAO,CAAC,EAAE,MAAM,qBAAqB,CAAC;AAAA,QACxC;AAAA,MACF,CAAC;AAAA,IACL;AAEA,WAAO;AAAA,EACT;AAEA,SAAO;AACT;;;ACtGO,IAAK,eAAL,kBAAKC,kBAAL;AAEL,EAAAA,cAAA,aAAU;AAUV,EAAAA,cAAA,UAAO;AAKP,EAAAA,cAAA,YAAS;AAjBC,SAAAA;AAAA,GAAA;AAqCL,IAAK,oBAAL,kBAAKC,uBAAL;AAML,EAAAA,mBAAA,4BAAyB;AAKzB,EAAAA,mBAAA,oBAAiB;AAMjB,EAAAA,mBAAA,oBAAiB;AAKjB,EAAAA,mBAAA,6BAA0B;AAK1B,EAAAA,mBAAA,4BAAyB;AAKzB,EAAAA,mBAAA,uBAAoB;AAMpB,EAAAA,mBAAA,0BAAuB;AAKvB,EAAAA,mBAAA,mCAAgC;AAEhC,EAAAA,mBAAA,kCAA+B;AAK/B,EAAAA,mBAAA,4BAAyB;AAEzB,EAAAA,mBAAA,sBAAmB;AAEnB,EAAAA,mBAAA,4BAAyB;AAEzB,EAAAA,mBAAA,uBAAoB;AAKpB,EAAAA,mBAAA,gBAAa;AAKb,EAAAA,mBAAA,qBAAkB;AAlER,SAAAA;AAAA,GAAA;AA+HL,IAAK,YAAL,kBAAKC,eAAL;AACL,EAAAA,WAAA,SAAM;AACN,EAAAA,WAAA,UAAO;AAFG,SAAAA;AAAA,GAAA;AAySL,IAAK,sBAAL,kBAAKC,yBAAL;AACL,EAAAA,qBAAA,aAAU;AACV,EAAAA,qBAAA,uBAAoB;AACpB,EAAAA,qBAAA,YAAS;AACT,EAAAA,qBAAA,cAAW;AACX,EAAAA,qBAAA,SAAM;AALI,SAAAA;AAAA,GAAA;;;AC5hBL,SAASC,eAOd;AACA,QAAM,UAAU,CAAC;AAEjB,QAAM,oBACiC,YAAY,OAAO;AAE1D,QAAM,SAAS,CAAC,YAAyB;AACvC,UAAM,EAAE,IAAI,IAAI,kBAAkB,OAAO;AACzC,WAAO;AAAA,EACT;AAEA,SAAO;AAAA,IACL;AAAA,IACA,YAAY;AAAA,IACZ,MAAM;AAAA,IACN,YAAY,CAAC;AAAA,IACb,eAAe;AAAA,IACf,uBAAuB;AAAA,IACvB,gBAAgB;AAAA,IAChB,wBAAwB;AAAA,EAC1B;AACF;AAEO,SAASC,aAOd;AACA,QAAM,UAAU,EAAE,UAAU,YAAY;AAExC,QAAM,oBACiC,UAAU,OAAO;AAExD,QAAM,SAAS,CAAC,YAAyB;AACvC,UAAM,EAAE,IAAI,IAAI,kBAAkB,OAAO;AACzC,WAAO;AAAA,EACT;AAEA,SAAO;AAAA,IACL;AAAA,IACA,YAAY;AAAA,IACZ,MAAM;AAAA,IACN,YAAY,EAAE,UAAU,WAAW;AAAA,IACnC,eAAe;AAAA,IACf,uBAAuB;AAAA,IACvB,gBAAgB;AAAA,IAChB,wBAAwB;AAAA,EAC1B;AACF;","names":["getPayout","listPayouts","import_timestamp","import_rest_modules","payload","PayoutStatus","PayoutFailureCode","SortOrder","WebhookIdentityType","listPayouts","getPayout"]}

package/build/cjs/schemas.js

@@ -40,54 +40,54 @@ 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(
+  accountId: z.string().describe(
+    "ID of the Wix Payments account whose payouts to list. Retrieve account\nIDs from the Accounts API."
+  ).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."
+      "ID of the Wix Payments account profile to filter by.\n\nWhen omitted, payouts across all profiles of the account are returned.\nRetrieve profile IDs from the Accounts API."
     ).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(),
+    createdBefore: z.date().describe("Returns only payouts created before this date and time.").optional().nullable(),
+    createdAfter: z.date().describe("Returns only payouts created after this date and time.").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."
+      "Sort order for the result list.\n\nSupported `fieldName` values: `created_date` (snake_case, not auto-converted). At most 1 sort field is allowed."
     ).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()
+    }).describe("Offset-based paging.").optional()
   }).optional()
 });
 var ListPayoutsResponse = z.object({
   payouts: z.array(
     z.object({
-      _id: z.string().describe("Unique identifier of the payout. Immutable.").regex(
+      _id: z.string().describe("Payout ID.").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(
+      accountId: z.string().describe(
+        "ID of the Wix Payments account that owns the payout. Retrieve account IDs\nfrom the Accounts API."
+      ).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."
+        "ID of the Wix Payments account profile that owns the payout.\n\nA Wix Payments account has 1 or more profiles. Each profile has its own\nbalance and its own payouts. Most merchants have 1 profile. Retrieve\nprofile IDs from the Accounts API."
       ).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."
+        "Date and time the payout was created.\n\nThe payout is created before the underlying transfer is initiated at the\nbank. Once initiated, the funds typically reach the merchant's bank account\nwithin 3 to 5 business days, depending on the receiving bank."
       ).optional().nullable(),
       amount: z.object({
         value: z.string().describe(
@@ -99,14 +99,12 @@ var ListPayoutsResponse = z.object({
         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(),
+      }).describe("Amount of the transfer 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`.'
+        "Lifecycle status of the payout.\n\n`SENT` means the bank rail accepted the transfer for delivery. `FAILED` means\nthe receiving bank rejected the transfer.\n\nA `SENT` status doesn't guarantee that the funds were delivered to the\nmerchant. The bank rail doesn't provide a delivery acknowledgement, and a\npayout in `SENT` can later transition to `FAILED` if the receiving bank\nrejects the transfer. See the per-value documentation on `PayoutStatus` for\ndetails."
       ).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."
+        "Estimated date for when the funds should arrive at the merchant's bank\naccount, in `YYYY-MM-DD` format.\n\nThe estimated arrival date is a prediction, not a guarantee. Actual arrival\ndepends on the receiving bank's processing and may be later."
       ).optional().nullable(),
       failureReason: z.object({
         code: z.enum([
@@ -127,13 +125,13 @@ var ListPayoutsResponse = z.object({
           "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."
+        "Reason the bank rail rejected the transfer.\n\nReturned only when `status` is `FAILED`."
       ).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."
+        "Reference returned by the bank rail once the transfer is initiated. For\nexample, an ACH trace number or a SEPA reference. Use this value to\nreconcile against the merchant's bank statement.\n\nEmpty until the bank rail returns 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."
+        "Whether the payout `amount` includes funds from a Wix Capital cash advance\ntaken out by the merchant. If `false`, the amount comes only from the\nmerchant's sales proceeds."
       ).optional()
     })
   ).optional(),
@@ -151,28 +149,32 @@ var GetPayoutRequest = z.object({
     /^[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(
+  accountId: z.string().describe(
+    "ID of the Wix Payments account that owns the payout. The payout must\nbelong to this account. Retrieve account IDs from the Accounts API."
+  ).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(
+  _id: z.string().describe("Payout ID.").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(
+  accountId: z.string().describe(
+    "ID of the Wix Payments account that owns the payout. Retrieve account IDs\nfrom the Accounts API."
+  ).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."
+    "ID of the Wix Payments account profile that owns the payout.\n\nA Wix Payments account has 1 or more profiles. Each profile has its own\nbalance and its own payouts. Most merchants have 1 profile. Retrieve\nprofile IDs from the Accounts API."
   ).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."
+    "Date and time the payout was created.\n\nThe payout is created before the underlying transfer is initiated at the\nbank. Once initiated, the funds typically reach the merchant's bank account\nwithin 3 to 5 business days, depending on the receiving bank."
   ).optional().nullable(),
   amount: z.object({
     value: z.string().describe(
@@ -184,12 +186,12 @@ var GetPayoutResponse = z.object({
     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(),
+  }).describe("Amount of the transfer 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`.'
+    "Lifecycle status of the payout.\n\n`SENT` means the bank rail accepted the transfer for delivery. `FAILED` means\nthe receiving bank rejected the transfer.\n\nA `SENT` status doesn't guarantee that the funds were delivered to the\nmerchant. The bank rail doesn't provide a delivery acknowledgement, and a\npayout in `SENT` can later transition to `FAILED` if the receiving bank\nrejects the transfer. See the per-value documentation on `PayoutStatus` for\ndetails."
   ).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."
+    "Estimated date for when the funds should arrive at the merchant's bank\naccount, in `YYYY-MM-DD` format.\n\nThe estimated arrival date is a prediction, not a guarantee. Actual arrival\ndepends on the receiving bank's processing and may be later."
   ).optional().nullable(),
   failureReason: z.object({
     code: z.enum([
@@ -210,13 +212,13 @@ var GetPayoutResponse = z.object({
       "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."
+    "Reason the bank rail rejected the transfer.\n\nReturned only when `status` is `FAILED`."
   ).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."
+    "Reference returned by the bank rail once the transfer is initiated. For\nexample, an ACH trace number or a SEPA reference. Use this value to\nreconcile against the merchant's bank statement.\n\nEmpty until the bank rail returns 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."
+    "Whether the payout `amount` includes funds from a Wix Capital cash advance\ntaken out by the merchant. If `false`, the amount comes only from the\nmerchant's sales proceeds."
   ).optional()
 });
 // Annotate the CommonJS export names for ESM import in node:

package/build/cjs/schemas.js.map

@@ -1 +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":[]}
+{"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(\n      'ID of the Wix Payments account whose payouts to list. Retrieve account\\nIDs from the Accounts API.'\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  options: z\n    .object({\n      accountProfileId: z\n        .string()\n        .describe(\n          'ID of the Wix Payments account profile to filter by.\\n\\nWhen omitted, payouts across all profiles of the account are returned.\\nRetrieve profile IDs from the Accounts API.'\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('Returns only payouts created before this date and time.')\n        .optional()\n        .nullable(),\n      createdAfter: z\n        .date()\n        .describe('Returns only payouts created after this date and time.')\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          'Sort order for the result list.\\n\\nSupported `fieldName` values: `created_date` (snake_case, not auto-converted). At most 1 sort field is allowed.'\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('Offset-based paging.')\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('Payout ID.')\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(\n            'ID of the Wix Payments account that owns the payout. Retrieve account IDs\\nfrom the Accounts API.'\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        accountProfileId: z\n          .string()\n          .describe(\n            'ID of the Wix Payments account profile that owns the payout.\\n\\nA Wix Payments account has 1 or more profiles. Each profile has its own\\nbalance and its own payouts. Most merchants have 1 profile. Retrieve\\nprofile IDs from the Accounts API.'\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 and time the payout was created.\\n\\nThe payout is created before the underlying transfer is initiated at the\\nbank. Once initiated, the funds typically reach the merchant's bank account\\nwithin 3 to 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 the transfer to the merchant's bank account.\")\n          .optional(),\n        status: z\n          .enum(['UNKNOWN', 'SENT', 'FAILED'])\n          .describe(\n            \"Lifecycle status of the payout.\\n\\n`SENT` means the bank rail accepted the transfer for delivery. `FAILED` means\\nthe receiving bank rejected the transfer.\\n\\nA `SENT` status doesn't guarantee that the funds were delivered to the\\nmerchant. The bank rail doesn't provide a delivery acknowledgement, and a\\npayout in `SENT` can later transition to `FAILED` if the receiving bank\\nrejects the transfer. See the per-value documentation on `PayoutStatus` for\\ndetails.\"\n          )\n          .optional(),\n        estimatedArrivalDateV2: z\n          .string()\n          .describe(\n            \"Estimated date for when the funds should arrive at the merchant's bank\\naccount, in `YYYY-MM-DD` format.\\n\\nThe estimated arrival date is a prediction, not a guarantee. Actual arrival\\ndepends 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            'Reason the bank rail rejected the transfer.\\n\\nReturned only when `status` is `FAILED`.'\n          )\n          .optional(),\n        bankTransferReference: z\n          .string()\n          .describe(\n            \"Reference returned by the bank rail once the transfer is initiated. For\\nexample, an ACH trace number or a SEPA reference. Use this value to\\nreconcile against the merchant's bank statement.\\n\\nEmpty until the bank rail returns a reference.\"\n          )\n          .max(500)\n          .optional()\n          .nullable(),\n        cashAdvanceIncluded: z\n          .boolean()\n          .describe(\n            \"Whether the payout `amount` includes funds from a Wix Capital cash advance\\ntaken out by the merchant. If `false`, the amount comes only from the\\nmerchant's 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(\n      'ID of the Wix Payments account that owns the payout. The payout must\\nbelong to this account. Retrieve account IDs from the Accounts API.'\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});\nexport const GetPayoutResponse = z.object({\n  _id: z\n    .string()\n    .describe('Payout ID.')\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(\n      'ID of the Wix Payments account that owns the payout. Retrieve account IDs\\nfrom the Accounts API.'\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  accountProfileId: z\n    .string()\n    .describe(\n      'ID of the Wix Payments account profile that owns the payout.\\n\\nA Wix Payments account has 1 or more profiles. Each profile has its own\\nbalance and its own payouts. Most merchants have 1 profile. Retrieve\\nprofile IDs from the Accounts API.'\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 and time the payout was created.\\n\\nThe payout is created before the underlying transfer is initiated at the\\nbank. Once initiated, the funds typically reach the merchant's bank account\\nwithin 3 to 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 the transfer to the merchant's bank account.\")\n    .optional(),\n  status: z\n    .enum(['UNKNOWN', 'SENT', 'FAILED'])\n    .describe(\n      \"Lifecycle status of the payout.\\n\\n`SENT` means the bank rail accepted the transfer for delivery. `FAILED` means\\nthe receiving bank rejected the transfer.\\n\\nA `SENT` status doesn't guarantee that the funds were delivered to the\\nmerchant. The bank rail doesn't provide a delivery acknowledgement, and a\\npayout in `SENT` can later transition to `FAILED` if the receiving bank\\nrejects the transfer. See the per-value documentation on `PayoutStatus` for\\ndetails.\"\n    )\n    .optional(),\n  estimatedArrivalDateV2: z\n    .string()\n    .describe(\n      \"Estimated date for when the funds should arrive at the merchant's bank\\naccount, in `YYYY-MM-DD` format.\\n\\nThe estimated arrival date is a prediction, not a guarantee. Actual arrival\\ndepends 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      'Reason the bank rail rejected the transfer.\\n\\nReturned only when `status` is `FAILED`.'\n    )\n    .optional(),\n  bankTransferReference: z\n    .string()\n    .describe(\n      \"Reference returned by the bank rail once the transfer is initiated. For\\nexample, an ACH trace number or a SEPA reference. Use this value to\\nreconcile against the merchant's bank statement.\\n\\nEmpty until the bank rail returns a reference.\"\n    )\n    .max(500)\n    .optional()\n    .nullable(),\n  cashAdvanceIncluded: z\n    .boolean()\n    .describe(\n      \"Whether the payout `amount` includes funds from a Wix Capital cash advance\\ntaken out by the merchant. If `false`, the amount comes only from the\\nmerchant's 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;AAAA,IACC;AAAA,EACF,EACC;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,SAAS,yDAAyD,EAClE,SAAS,EACT,SAAS;AAAA,IACZ,cACG,OAAK,EACL,SAAS,wDAAwD,EACjE,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,sBAAsB,EAC/B,SAAS;AAAA,EACd,CAAC,EACA,SAAS;AACd,CAAC;AACM,IAAM,sBAAwB,SAAO;AAAA,EAC1C,SACG;AAAA,IACG,SAAO;AAAA,MACP,KACG,SAAO,EACP,SAAS,YAAY,EACrB;AAAA,QACC;AAAA,QACA;AAAA,MACF,EACC,SAAS;AAAA,MACZ,WACG,SAAO,EACP;AAAA,QACC;AAAA,MACF,EACC;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,SAAS,wDAAwD,EACjE,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;AAAA,IACC;AAAA,EACF,EACC;AAAA,IACC;AAAA,IACA;AAAA,EACF;AACJ,CAAC;AACM,IAAM,oBAAsB,SAAO;AAAA,EACxC,KACG,SAAO,EACP,SAAS,YAAY,EACrB;AAAA,IACC;AAAA,IACA;AAAA,EACF,EACC,SAAS;AAAA,EACZ,WACG,SAAO,EACP;AAAA,IACC;AAAA,EACF,EACC;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,wDAAwD,EACjE,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

@@ -5,19 +5,22 @@ export { AccountInfo, AccountInfoMetadata, ActionEvent, BaseEventMetadata, Creat
 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.
+     * Retrieves a paginated list of payouts for the specified Wix Payments account.
+     *
+     * Supports optional filters by account profile and by creation date range.
+     * @param - ID of the Wix Payments account whose payouts to list. Retrieve account
+     * IDs from the Accounts API.
      */
     (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.
+     * 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.
+     * @param - ID of the Wix Payments account that owns the payout. The payout must
+     * belong to this account. Retrieve account IDs from the Accounts API.
+     * @returns Retrieved payout.
      */
     (payoutId: string, accountId: string): Promise<NonNullablePaths<Payout, `_id` | `accountId` | `accountProfileId` | `amount.value` | `amount.currency` | `status` | `failureReason.code` | `cashAdvanceIncluded`, 3>>;
 }
@@ -27,17 +30,21 @@ declare const onPayoutUpdated$1: EventDefinition<PayoutUpdatedEnvelope, "wix.pay
 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`
+ * Triggered when a payout is created.
+ *
+ * The payout is created before the underlying transfer is initiated at the
+ * bank. At this point `status` is `SENT` and `estimatedArrivalDateV2` is set
+ * if the bank rail returned one. `failureReason` and `bankTransferReference`
  * 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.
+ * Triggered when a payout is updated.
+ *
+ * Typical updates include `status` transitioning from `SENT` to `FAILED`
+ * (with `failureReason` being set), `estimatedArrivalDateV2` being refined by
+ * the bank rail, and `bankTransferReference` being populated once the rail
+ * returns it.
  */
 declare const onPayoutUpdated: BuildEventDefinition<typeof onPayoutUpdated$1> & typeof onPayoutUpdated$1;