@wix/auto_sdk_ecom_orders 1.0.331 → 1.0.333

This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
Files changed (29) hide show
  1. package/build/cjs/{ecom-v1-order-orders.universal-BvamC5-B.d.ts → ecom-v1-order-orders.universal-2uoEHa97.d.ts} +1682 -1682
  2. package/build/cjs/index.d.ts +2 -2
  3. package/build/cjs/index.js +80 -80
  4. package/build/cjs/index.js.map +1 -1
  5. package/build/cjs/index.typings.d.ts +2 -2
  6. package/build/cjs/index.typings.js +80 -80
  7. package/build/cjs/index.typings.js.map +1 -1
  8. package/build/cjs/meta.d.ts +1682 -1682
  9. package/build/cjs/meta.js +80 -80
  10. package/build/cjs/meta.js.map +1 -1
  11. package/build/es/{ecom-v1-order-orders.universal-BvamC5-B.d.mts → ecom-v1-order-orders.universal-2uoEHa97.d.mts} +1682 -1682
  12. package/build/es/index.d.mts +2 -2
  13. package/build/es/index.mjs +80 -80
  14. package/build/es/index.mjs.map +1 -1
  15. package/build/es/index.typings.d.mts +2 -2
  16. package/build/es/index.typings.mjs +80 -80
  17. package/build/es/index.typings.mjs.map +1 -1
  18. package/build/es/meta.d.mts +1682 -1682
  19. package/build/es/meta.mjs +80 -80
  20. package/build/es/meta.mjs.map +1 -1
  21. package/build/internal/cjs/{ecom-v1-order-orders.universal-CAyh4UDq.d.ts → ecom-v1-order-orders.universal-BVqsClnV.d.ts} +1824 -1824
  22. package/build/internal/cjs/index.d.ts +2 -2
  23. package/build/internal/cjs/index.typings.d.ts +2 -2
  24. package/build/internal/cjs/meta.d.ts +1824 -1824
  25. package/build/internal/es/{ecom-v1-order-orders.universal-CAyh4UDq.d.mts → ecom-v1-order-orders.universal-BVqsClnV.d.mts} +1824 -1824
  26. package/build/internal/es/index.d.mts +2 -2
  27. package/build/internal/es/index.typings.d.mts +2 -2
  28. package/build/internal/es/meta.d.mts +1824 -1824
  29. package/package.json +3 -3
@@ -4109,461 +4109,163 @@ interface BulkDeleteImportedOrdersResponse {
4109
4109
  */
4110
4110
  jobId?: string;
4111
4111
  }
4112
- interface V1TriggerReindexRequest {
4112
+ interface SendBuyerConfirmationEmailRequest {
4113
4113
  /** @format GUID */
4114
- metasiteId?: string;
4114
+ orderId?: string;
4115
+ }
4116
+ interface SendBuyerConfirmationEmailResponse {
4117
+ }
4118
+ interface SendBuyerPaymentsReceivedEmailRequest {
4115
4119
  /**
4116
4120
  * @minLength 1
4117
4121
  * @maxLength 100
4118
- * @maxSize 100
4119
4122
  */
4120
- orderIds?: string[];
4123
+ orderId?: string;
4121
4124
  }
4122
- interface V1TriggerReindexResponse {
4125
+ interface SendBuyerPaymentsReceivedEmailResponse {
4123
4126
  }
4124
- interface V1TriggerReindexOrderRequest {
4125
- /** @format GUID */
4126
- metasiteId?: string;
4127
+ interface SendBuyerPickupConfirmationEmailRequest {
4127
4128
  /**
4128
4129
  * @minLength 1
4129
4130
  * @maxLength 100
4130
4131
  */
4131
4132
  orderId?: string;
4132
4133
  }
4133
- interface PreparePaymentCollectionRequest {
4134
+ interface SendBuyerPickupConfirmationEmailResponse {
4135
+ }
4136
+ interface BulkSendBuyerPickupConfirmationEmailsRequest {
4134
4137
  /**
4135
- * Ecom order ID.
4136
- * @minLength 1
4137
- * @maxLength 100
4138
+ * IDs of orders to send pickup emails for.
4139
+ * @minSize 1
4140
+ * @maxSize 300
4138
4141
  */
4139
- ecomOrderId: string;
4140
- /** Amount to collect */
4141
- amount: Price;
4142
+ orderIds?: string[];
4143
+ }
4144
+ interface BulkSendBuyerPickupConfirmationEmailsResponse {
4145
+ }
4146
+ interface SendBuyerShippingConfirmationEmailRequest {
4142
4147
  /**
4143
- * Optional parameter. When present, payment collection will be performed using given payment gateway order.
4144
- * Existing payment gateway order will be updated with a new amount.
4145
- * When parameter is absent, new payment gateway order will be created and used for payment collection.
4148
+ * @minLength 1
4149
+ * @maxLength 100
4146
4150
  */
4147
- paymentGatewayOrderId?: string | null;
4151
+ orderId?: string;
4152
+ }
4153
+ interface SendBuyerShippingConfirmationEmailResponse {
4154
+ }
4155
+ interface BulkSendBuyerShippingConfirmationEmailsRequest {
4148
4156
  /**
4149
- * Whether to delay capture of the payment.
4150
- * Default: false
4151
- * @deprecated Whether to delay capture of the payment.
4152
- * Default: false
4153
- * @replacedBy delayed_capture_settings.scheduled_action
4154
- * @targetRemovalDate 2024-09-30
4157
+ * IDs of orders to send pickup emails for.
4158
+ * @minSize 1
4159
+ * @maxSize 300
4155
4160
  */
4156
- delayedCapture?: boolean;
4157
- /** Delayed capture payment settings */
4158
- delayedCaptureSettings?: DelayedCaptureSettings;
4161
+ orderIds?: string[];
4159
4162
  }
4160
- interface RedirectUrls {
4163
+ interface BulkSendBuyerShippingConfirmationEmailsResponse {
4164
+ }
4165
+ interface SendMerchantOrderReceivedNotificationRequest {
4161
4166
  /**
4162
- * URL to redirect buyer in case of approved (successful) transaction
4163
- * @format WEB_URL
4167
+ * @minLength 1
4168
+ * @maxLength 100
4164
4169
  */
4165
- successUrl?: string | null;
4170
+ orderId?: string;
4171
+ }
4172
+ interface SendMerchantOrderReceivedNotificationResponse {
4173
+ }
4174
+ interface SendCancelRefundEmailRequest {
4166
4175
  /**
4167
- * URL to redirect buyer in case of buyer canceled the transaction
4168
- * @format WEB_URL
4176
+ * The ID of order that is canceled/refunded
4177
+ * @minLength 1
4178
+ * @maxLength 100
4169
4179
  */
4170
- cancelUrl?: string | null;
4180
+ orderId?: string;
4171
4181
  /**
4172
- * URL to redirect buyer in case of failed/rejected transaction
4173
- * @format WEB_URL
4182
+ * Personal note added to the email (optional)
4183
+ * @minLength 1
4184
+ * @maxLength 1000
4174
4185
  */
4175
- errorUrl?: string | null;
4186
+ customMessage?: string | null;
4187
+ /** Refund amount */
4188
+ refundAmount?: Price;
4176
4189
  /**
4177
- * URL to redirect buyer in case of pending transaction (that might take some time to process)
4178
- * @format WEB_URL
4190
+ * Refund ID. (Optional)
4191
+ * @format GUID
4179
4192
  */
4180
- pendingUrl?: string | null;
4181
- }
4182
- interface DelayedCaptureSettings {
4183
- /** Specifies the automatic action (void/capture) for authorized transaction after the specified duration */
4184
- scheduledAction?: ScheduledActionWithLiterals;
4185
- /** Delay duration before execution. Optional - if not set, providers default period will be used */
4186
- delayDuration?: Duration;
4193
+ refundId?: string | null;
4187
4194
  }
4188
- declare enum ScheduledAction {
4189
- /** Whether payment will be auto-voided when duration passes */
4190
- VOID = "VOID",
4191
- /** Whether payment will be auto-captured when duration passes */
4192
- CAPTURE = "CAPTURE"
4195
+ interface SendCancelRefundEmailResponse {
4193
4196
  }
4194
- /** @enumType */
4195
- type ScheduledActionWithLiterals = ScheduledAction | 'VOID' | 'CAPTURE';
4196
- interface Duration {
4197
+ interface SendRefundEmailRequest {
4197
4198
  /**
4198
- * Amount of units. For example, 30 MINUTES, 1 HOURS, 7 DAYS, etc
4199
- * @min 1
4199
+ * The ID of order that is refunded
4200
+ * @format GUID
4200
4201
  */
4201
- count?: number;
4202
- /** Duration unit: MINUTES, HOURS and DAYS */
4203
- unit?: DurationUnitWithLiterals;
4204
- }
4205
- declare enum DurationUnit {
4206
- MINUTES = "MINUTES",
4207
- HOURS = "HOURS",
4208
- DAYS = "DAYS"
4209
- }
4210
- /** @enumType */
4211
- type DurationUnitWithLiterals = DurationUnit | 'MINUTES' | 'HOURS' | 'DAYS';
4212
- interface PreparePaymentCollectionResponse {
4213
- /** Payment gateway order id which is associated with given payment */
4214
- paymentGatewayOrderId?: string;
4215
- }
4216
- interface GetPaymentCollectabilityStatusRequest {
4202
+ orderId?: string;
4217
4203
  /**
4218
- * Ecom order ID.
4204
+ * Refund ID
4205
+ * @format GUID
4206
+ */
4207
+ refundId?: string;
4208
+ /**
4209
+ * Personal note added to the email (optional)
4219
4210
  * @minLength 1
4220
- * @maxLength 100
4211
+ * @maxLength 1000
4221
4212
  */
4222
- ecomOrderId: string;
4213
+ customMessage?: string | null;
4223
4214
  }
4224
- interface GetPaymentCollectabilityStatusResponse {
4225
- /** Payment collectability status */
4226
- status?: PaymentCollectabilityStatusWithLiterals;
4227
- /** Collectable order amount */
4228
- amount?: Price;
4215
+ interface SendRefundEmailResponse {
4229
4216
  }
4230
- declare enum PaymentCollectabilityStatus {
4231
- UNKNOWN = "UNKNOWN",
4232
- COLLECTABLE = "COLLECTABLE",
4233
- NONCOLLECTABLE_ORDER_IS_CANCELLED = "NONCOLLECTABLE_ORDER_IS_CANCELLED",
4234
- NONCOLLECTABLE_ORDER_IS_PAID = "NONCOLLECTABLE_ORDER_IS_PAID",
4235
- NONCOLLECTABLE_MISSING_PAYMENT_METHOD = "NONCOLLECTABLE_MISSING_PAYMENT_METHOD",
4236
- NONCOLLECTABLE_ORDER_IS_PENDING = "NONCOLLECTABLE_ORDER_IS_PENDING",
4237
- NONCOLLECTABLE_ORDER_IS_REJECTED = "NONCOLLECTABLE_ORDER_IS_REJECTED",
4238
- NONCOLLECTABLE_ORDER_HAS_SUBSCRIPTIONS = "NONCOLLECTABLE_ORDER_HAS_SUBSCRIPTIONS",
4239
- NONCOLLECTABLE_ORDER_HAS_CHARGEBACKS = "NONCOLLECTABLE_ORDER_HAS_CHARGEBACKS",
4240
- NONCOLLECTABLE_SUBSCRIPTION_CYCLE_ALREADY_PASSED = "NONCOLLECTABLE_SUBSCRIPTION_CYCLE_ALREADY_PASSED",
4241
- NONCOLLECTABLE_ORDER_HAS_UNSUPPORTED_SUBSCRIPTION = "NONCOLLECTABLE_ORDER_HAS_UNSUPPORTED_SUBSCRIPTION",
4242
- NONCOLLECTABLE_CUSTOM_AMOUNT_NOT_SUPPORTED = "NONCOLLECTABLE_CUSTOM_AMOUNT_NOT_SUPPORTED",
4243
- NONCOLLECTABLE_SUBSCRIPTION_START_DATE_IN_PAST = "NONCOLLECTABLE_SUBSCRIPTION_START_DATE_IN_PAST"
4217
+ interface SendFulfillmentEmailRequest {
4218
+ /** @format GUID */
4219
+ orderId?: string;
4220
+ /** @format GUID */
4221
+ fulfillerId?: string;
4244
4222
  }
4245
- /** @enumType */
4246
- type PaymentCollectabilityStatusWithLiterals = PaymentCollectabilityStatus | 'UNKNOWN' | 'COLLECTABLE' | 'NONCOLLECTABLE_ORDER_IS_CANCELLED' | 'NONCOLLECTABLE_ORDER_IS_PAID' | 'NONCOLLECTABLE_MISSING_PAYMENT_METHOD' | 'NONCOLLECTABLE_ORDER_IS_PENDING' | 'NONCOLLECTABLE_ORDER_IS_REJECTED' | 'NONCOLLECTABLE_ORDER_HAS_SUBSCRIPTIONS' | 'NONCOLLECTABLE_ORDER_HAS_CHARGEBACKS' | 'NONCOLLECTABLE_SUBSCRIPTION_CYCLE_ALREADY_PASSED' | 'NONCOLLECTABLE_ORDER_HAS_UNSUPPORTED_SUBSCRIPTION' | 'NONCOLLECTABLE_CUSTOM_AMOUNT_NOT_SUPPORTED' | 'NONCOLLECTABLE_SUBSCRIPTION_START_DATE_IN_PAST';
4247
- interface RecordManuallyCollectedPaymentRequest {
4223
+ interface SendFulfillmentEmailResponse {
4224
+ }
4225
+ interface SendMerchantOrderReceivedPushRequest {
4248
4226
  /**
4249
- * Order ID.
4250
4227
  * @minLength 1
4251
4228
  * @maxLength 100
4252
4229
  */
4253
- orderId: string;
4254
- /** Amount to be recorded as approved manual payment for given order */
4255
- amount: Price;
4230
+ orderId?: string;
4256
4231
  }
4257
- /**
4258
- * User-defined payment method name.
4259
- * Allows specifying either a predefined type or a custom name.
4260
- */
4261
- interface UserDefinedPaymentMethodName extends UserDefinedPaymentMethodNameKindOneOf {
4262
- /** Predefined payment method. */
4263
- predefined?: PredefinedPaymentMethodWithLiterals;
4264
- /**
4265
- * Custom payment method name provided by user.
4266
- *
4267
- * For example, `"Wire transfer"`, `"Money order"`, `"Venmo"` or any other custom name.
4268
- * @minLength 1
4269
- * @maxLength 150
4270
- */
4271
- custom?: string | null;
4232
+ interface SendMerchantOrderReceivedPushResponse {
4272
4233
  }
4273
- /** @oneof */
4274
- interface UserDefinedPaymentMethodNameKindOneOf {
4275
- /** Predefined payment method. */
4276
- predefined?: PredefinedPaymentMethodWithLiterals;
4277
- /**
4278
- * Custom payment method name provided by user.
4279
- *
4280
- * For example, `"Wire transfer"`, `"Money order"`, `"Venmo"` or any other custom name.
4281
- * @minLength 1
4282
- * @maxLength 150
4283
- */
4284
- custom?: string | null;
4234
+ interface PreviewEmailByTypeRequest {
4235
+ emailType?: PreviewEmailTypeWithLiterals;
4285
4236
  }
4286
- /** Predefined payment method types for offline/manual payments. */
4287
- declare enum PredefinedPaymentMethod {
4288
- /** Cash payment. */
4289
- CASH = "CASH",
4290
- /** Bank transfer. */
4291
- BANK_TRANSFER = "BANK_TRANSFER",
4292
- /** Payment by check. */
4293
- CHECK = "CHECK"
4237
+ declare enum PreviewEmailType {
4238
+ ORDER_PLACED = "ORDER_PLACED",
4239
+ DOWNLOAD_LINKS = "DOWNLOAD_LINKS",
4240
+ ORDER_SHIPPED = "ORDER_SHIPPED",
4241
+ ORDER_READY_FOR_PICKUP = "ORDER_READY_FOR_PICKUP"
4294
4242
  }
4295
4243
  /** @enumType */
4296
- type PredefinedPaymentMethodWithLiterals = PredefinedPaymentMethod | 'CASH' | 'BANK_TRANSFER' | 'CHECK';
4297
- interface RecordManuallyCollectedPaymentResponse {
4244
+ type PreviewEmailTypeWithLiterals = PreviewEmailType | 'ORDER_PLACED' | 'DOWNLOAD_LINKS' | 'ORDER_SHIPPED' | 'ORDER_READY_FOR_PICKUP';
4245
+ interface PreviewEmailByTypeResponse {
4246
+ emailPreview?: string;
4298
4247
  }
4299
- interface MarkOrderAsPaidRequest {
4248
+ interface PreviewRefundEmailRequest {
4300
4249
  /**
4301
- * Ecom order ID.
4302
4250
  * @minLength 1
4303
4251
  * @maxLength 100
4304
4252
  */
4305
- ecomOrderId: string;
4306
- }
4307
- interface MarkOrderAsPaidResponse {
4308
- /** Updated order. */
4309
- order?: Order;
4310
- }
4311
- interface BulkMarkOrdersAsPaidRequest {
4253
+ orderId?: string;
4254
+ /** Refund amount */
4255
+ refundAmount?: Price;
4256
+ /** Refund business details */
4257
+ details?: RefundDetails;
4312
4258
  /**
4313
- * IDs of orders to mark as paid.
4314
- * @minSize 1
4315
- * @maxSize 100
4259
+ * Personal note added to the email (optional)
4316
4260
  * @minLength 1
4317
- * @maxLength 100
4261
+ * @maxLength 1000
4318
4262
  */
4319
- ecomOrderIds: string[];
4320
- }
4321
- interface BulkMarkOrdersAsPaidResponse {
4263
+ customMessage?: string | null;
4322
4264
  /**
4323
- * Items updated by the bulk action.
4324
- * The Order entity within the results optimistically changes its payment status to paid, however this process is async.
4265
+ * Refund ID. (Optional)
4266
+ * @format GUID
4325
4267
  */
4326
- results?: BulkOrderResult[];
4327
- /** Bulk action metadata. */
4328
- bulkActionMetadata?: BulkActionMetadata;
4329
- }
4330
- interface BulkOrderResult {
4331
- /** Item metadata. */
4332
- itemMetadata?: ItemMetadata;
4333
- /**
4334
- * Updated order.
4335
- *
4336
- * Returned when `returnFullEntity = true`.
4337
- */
4338
- item?: Order;
4339
- }
4340
- interface ItemMetadata {
4341
- /** Item ID. Should always be available, unless it's impossible (for example, when failing to create an item). */
4342
- _id?: string | null;
4343
- /** Index of the item within the request array. Allows for correlation between request and response items. */
4344
- originalIndex?: number;
4345
- /** Whether the requested action was successful for this item. When `false`, the `error` field is populated. */
4346
- success?: boolean;
4347
- /** Details about the error in case of failure. */
4348
- error?: ApplicationError;
4349
- }
4350
- interface ApplicationError {
4351
- /** Error code. */
4352
- code?: string;
4353
- /** Description of the error. */
4354
- description?: string;
4355
- /** Data related to the error. */
4356
- data?: Record<string, any> | null;
4357
- }
4358
- interface BulkActionMetadata {
4359
- /** Number of items that were successfully processed. */
4360
- totalSuccesses?: number;
4361
- /** Number of items that couldn't be processed. */
4362
- totalFailures?: number;
4363
- /** Number of failures without details because detailed failure threshold was exceeded. */
4364
- undetailedFailures?: number;
4365
- }
4366
- interface GetRefundabilityStatusRequest {
4367
- /**
4368
- * Order ID.
4369
- * @minLength 1
4370
- * @maxLength 100
4371
- */
4372
- ecomOrderId: string;
4373
- }
4374
- interface GetRefundabilityStatusResponse {
4375
- /**
4376
- * Refundability details.
4377
- * @maxSize 300
4378
- */
4379
- refundabilities?: Refundability[];
4380
- /**
4381
- * Whether the order supports refunding per item.
4382
- * @deprecated
4383
- */
4384
- refundablePerItem?: boolean;
4385
- }
4386
- interface Refundability extends RefundabilityAdditionalRefundabilityInfoOneOf {
4387
- /** Reason why payment is not refundable. */
4388
- nonRefundableReason?: NonRefundableReasonWithLiterals;
4389
- /** Reason why payment is only refundable manually. */
4390
- manuallyRefundableReason?: ManuallyRefundableReasonWithLiterals;
4391
- /** Payment ID. */
4392
- paymentId?: string;
4393
- /** Payment refundability status. */
4394
- refundabilityStatus?: RefundableStatusWithLiterals;
4395
- /** Link to payment provider dashboard. */
4396
- providerLink?: string | null;
4397
- }
4398
- /** @oneof */
4399
- interface RefundabilityAdditionalRefundabilityInfoOneOf {
4400
- /** Reason why payment is not refundable. */
4401
- nonRefundableReason?: NonRefundableReasonWithLiterals;
4402
- /** Reason why payment is only refundable manually. */
4403
- manuallyRefundableReason?: ManuallyRefundableReasonWithLiterals;
4404
- }
4405
- declare enum RefundableStatus {
4406
- NOT_REFUNDABLE = "NOT_REFUNDABLE",
4407
- MANUAL = "MANUAL",
4408
- REFUNDABLE = "REFUNDABLE"
4409
- }
4410
- /** @enumType */
4411
- type RefundableStatusWithLiterals = RefundableStatus | 'NOT_REFUNDABLE' | 'MANUAL' | 'REFUNDABLE';
4412
- declare enum NonRefundableReason {
4413
- NONE = "NONE",
4414
- ALREADY_REFUNDED = "ALREADY_REFUNDED",
4415
- PROVIDER_IS_DOWN = "PROVIDER_IS_DOWN",
4416
- INTERNAL_ERROR = "INTERNAL_ERROR",
4417
- NOT_PAID = "NOT_PAID",
4418
- ACCESS_DENIED = "ACCESS_DENIED",
4419
- ZERO_PRICE = "ZERO_PRICE",
4420
- DISABLED_BY_PROVIDER = "DISABLED_BY_PROVIDER",
4421
- PENDING_REFUND = "PENDING_REFUND",
4422
- FORBIDDEN = "FORBIDDEN",
4423
- TRANSACTION_NOT_FOUND = "TRANSACTION_NOT_FOUND",
4424
- ORDER_IS_PENDING = "ORDER_IS_PENDING",
4425
- ORDER_IS_REJECTED = "ORDER_IS_REJECTED"
4426
- }
4427
- /** @enumType */
4428
- type NonRefundableReasonWithLiterals = NonRefundableReason | 'NONE' | 'ALREADY_REFUNDED' | 'PROVIDER_IS_DOWN' | 'INTERNAL_ERROR' | 'NOT_PAID' | 'ACCESS_DENIED' | 'ZERO_PRICE' | 'DISABLED_BY_PROVIDER' | 'PENDING_REFUND' | 'FORBIDDEN' | 'TRANSACTION_NOT_FOUND' | 'ORDER_IS_PENDING' | 'ORDER_IS_REJECTED';
4429
- declare enum ManuallyRefundableReason {
4430
- EXPIRED = "EXPIRED",
4431
- NOT_SUPPORTED = "NOT_SUPPORTED",
4432
- OFFLINE = "OFFLINE",
4433
- REQUIRES_CARD_READER = "REQUIRES_CARD_READER"
4434
- }
4435
- /** @enumType */
4436
- type ManuallyRefundableReasonWithLiterals = ManuallyRefundableReason | 'EXPIRED' | 'NOT_SUPPORTED' | 'OFFLINE' | 'REQUIRES_CARD_READER';
4437
- interface CreatePaymentGatewayOrderRequest {
4438
- /**
4439
- * Ecom order ID.
4440
- * @minLength 1
4441
- * @maxLength 100
4442
- */
4443
- ecomOrderId: string;
4444
- /** Information about the user who initiated the payment. */
4445
- chargedBy?: ChargedBy;
4446
- }
4447
- interface ChargedBy {
4448
- /**
4449
- * ID - id of the user who initiated the payment
4450
- * @format GUID
4451
- */
4452
- _id?: string;
4453
- /**
4454
- * Full name - name of the user who initiated the payment
4455
- * @minLength 1
4456
- * @maxLength 200
4457
- */
4458
- fullName?: string | null;
4459
- }
4460
- interface CreatePaymentGatewayOrderResponse {
4461
- /** ID of the order created in the payment gateway */
4462
- paymentGatewayOrderId?: string;
4463
- }
4464
- interface ChargeMembershipsRequest {
4465
- /**
4466
- * Order ID.
4467
- * @minLength 1
4468
- * @maxLength 100
4469
- */
4470
- ecomOrderId: string;
4471
- /**
4472
- * The member id. Do not attempt to get it from the request context, since in some cases the caller is not a member
4473
- * but a user which is using the membership on behalf of the a member
4474
- * @format GUID
4475
- */
4476
- memberId: string;
4477
- /**
4478
- * List of items to be paid by memberships
4479
- * @minSize 1
4480
- * @maxSize 300
4481
- */
4482
- membershipCharges?: MembershipChargeItem[];
4483
- }
4484
- interface MembershipChargeItem {
4485
- /**
4486
- * The id of used membership
4487
- * @minLength 1
4488
- * @maxLength 100
4489
- */
4490
- membershipId?: string;
4491
- /**
4492
- * ID of the application providing this payment option
4493
- * @format GUID
4494
- */
4495
- appId?: string;
4496
- /** The name of used membership */
4497
- membershipName?: MembershipName;
4498
- /** Additional data about this membership */
4499
- membershipAdditionalData?: Record<string, any> | null;
4500
- /** Catalog and item reference info. */
4501
- catalogReference?: CatalogReference;
4502
- /** Properties of the service. When relevant, contains information such as date and number of participants. */
4503
- serviceProperties?: ServiceProperties;
4504
- /**
4505
- * Usually would be the same as catalogReference.catalogItemId
4506
- * For cases when these are not the same, this field would return the actual id of the item in the catalog
4507
- * For example, for Wix bookings, catalogReference.catalogItemId is the booking id, and this value is being set to be the service id
4508
- * @minLength 1
4509
- * @maxLength 36
4510
- */
4511
- rootCatalogItemId?: string | null;
4512
- /**
4513
- * line item id of Checkout/Order line item
4514
- * @minLength 1
4515
- * @maxLength 100
4516
- */
4517
- lineItemId?: string;
4518
- }
4519
- interface MembershipName {
4520
- /**
4521
- * Membership name in the site's original language.
4522
- * @maxLength 100
4523
- */
4524
- original?: string;
4525
- /**
4526
- * Membership name translated into the buyer's language.
4527
- *
4528
- * Default: The value of `original`
4529
- * @maxLength 100
4530
- */
4531
- translated?: string | null;
4532
- }
4533
- interface ChargeMembershipsResponse {
4534
- }
4535
- interface TriggerRefundRequest {
4536
- /**
4537
- * The order this refund related to
4538
- * @minLength 1
4539
- * @maxLength 100
4540
- */
4541
- ecomOrderId: string;
4542
- /**
4543
- * Refund operations information
4544
- * @minSize 1
4545
- * @maxSize 1
4546
- */
4547
- payments: PaymentRefund[];
4548
- /** Business model of a refund */
4549
- details?: RefundDetails;
4550
- /** Side effect details related to refund */
4551
- sideEffects?: RefundSideEffects;
4552
- }
4553
- interface PaymentRefund {
4554
- /**
4555
- * Specific payment within the order to refund
4556
- * @format GUID
4557
- */
4558
- paymentId?: string;
4559
- /** Refund amount. Not relevant for membership and gift card refunds. */
4560
- amount?: Price;
4561
- /**
4562
- * Whether refund is made externally and manually (on the payment provider's side)
4563
- * When false (default), the payment gateway will be called in order to make an actual refund, and then the payment will be marked as refunded.
4564
- * When true, the payment will only be *marked* as refunded, and no actual refund will be performed.
4565
- */
4566
- externalRefund?: boolean;
4268
+ refundId?: string | null;
4567
4269
  }
4568
4270
  /** Business model of a refund request */
4569
4271
  interface RefundDetails {
@@ -4640,1647 +4342,1945 @@ interface ShippingRefund {
4640
4342
  */
4641
4343
  amount?: Price;
4642
4344
  }
4643
- interface RefundSideEffects {
4644
- /** Inventory restock details as part of this refund. */
4645
- restockInfo?: RestockInfo;
4646
- /** Whether to send a refund confirmation email to the customer. */
4647
- sendOrderRefundedEmail?: boolean;
4345
+ interface PreviewRefundEmailResponse {
4346
+ emailPreview?: string;
4347
+ }
4348
+ interface PreviewCancelEmailRequest {
4648
4349
  /**
4649
- * Custom message added to the refund confirmation email.
4650
4350
  * @minLength 1
4651
- * @maxLength 1000
4351
+ * @maxLength 100
4652
4352
  */
4653
- customMessage?: string | null;
4654
- }
4655
- interface RestockInfo {
4656
- /** Restock type. */
4657
- type?: RestockTypeWithLiterals;
4353
+ orderId?: string;
4354
+ /**
4355
+ * Personal note added to the email (optional)
4356
+ * @minLength 1
4357
+ * @maxLength 1000
4358
+ */
4359
+ customMessage?: string | null;
4360
+ }
4361
+ interface PreviewCancelEmailResponse {
4362
+ emailPreview?: string;
4363
+ }
4364
+ interface PreviewCancelRefundEmailRequest {
4365
+ /**
4366
+ * @minLength 1
4367
+ * @maxLength 100
4368
+ */
4369
+ orderId?: string;
4370
+ /**
4371
+ * Personal note added to the email (optional)
4372
+ * @minLength 1
4373
+ * @maxLength 1000
4374
+ */
4375
+ customMessage?: string | null;
4376
+ /** Refund amount */
4377
+ refundAmount?: Price;
4378
+ /**
4379
+ * Refund ID. (Optional)
4380
+ * @format GUID
4381
+ */
4382
+ refundId?: string | null;
4383
+ }
4384
+ interface PreviewCancelRefundEmailResponse {
4385
+ emailPreview?: string;
4386
+ }
4387
+ interface PreviewBuyerPaymentsReceivedEmailRequest {
4388
+ }
4389
+ interface PreviewBuyerPaymentsReceivedEmailResponse {
4390
+ emailPreview?: string;
4391
+ }
4392
+ interface PreviewBuyerConfirmationEmailRequest {
4393
+ }
4394
+ interface PreviewBuyerConfirmationEmailResponse {
4395
+ emailPreview?: string;
4396
+ }
4397
+ interface PreviewBuyerPickupConfirmationEmailRequest {
4398
+ }
4399
+ interface PreviewBuyerPickupConfirmationEmailResponse {
4400
+ emailPreview?: string;
4401
+ }
4402
+ interface PreviewShippingConfirmationEmailRequest {
4403
+ }
4404
+ interface PreviewShippingConfirmationEmailResponse {
4405
+ emailPreview?: string;
4406
+ }
4407
+ interface PreviewResendDownloadLinksEmailRequest {
4408
+ }
4409
+ interface PreviewResendDownloadLinksEmailResponse {
4410
+ emailPreview?: string;
4411
+ }
4412
+ interface MetaSiteSpecialEvent extends MetaSiteSpecialEventPayloadOneOf {
4413
+ /** Emitted on a meta site creation. */
4414
+ siteCreated?: SiteCreated;
4415
+ /** Emitted on a meta site transfer completion. */
4416
+ siteTransferred?: SiteTransferred;
4417
+ /** Emitted on a meta site deletion. */
4418
+ siteDeleted?: SiteDeleted;
4419
+ /** Emitted on a meta site restoration. */
4420
+ siteUndeleted?: SiteUndeleted;
4421
+ /** Emitted on the first* publish of the meta site (* switching from unpublished to published state). */
4422
+ sitePublished?: SitePublished;
4423
+ /** Emitted on a meta site unpublish. */
4424
+ siteUnpublished?: SiteUnpublished;
4425
+ /** Emitted when meta site is marked as template. */
4426
+ siteMarkedAsTemplate?: SiteMarkedAsTemplate;
4427
+ /** Emitted when meta site is marked as a WixSite. */
4428
+ siteMarkedAsWixSite?: SiteMarkedAsWixSite;
4429
+ /** Emitted when an application is provisioned (installed). */
4430
+ serviceProvisioned?: ServiceProvisioned;
4431
+ /** Emitted when an application is removed (uninstalled). */
4432
+ serviceRemoved?: ServiceRemoved;
4433
+ /** Emitted when meta site name (URL slug) is changed. */
4434
+ siteRenamedPayload?: SiteRenamed;
4435
+ /** Emitted when meta site was permanently deleted. */
4436
+ hardDeleted?: SiteHardDeleted;
4437
+ /** Emitted on a namespace change. */
4438
+ namespaceChanged?: NamespaceChanged;
4439
+ /** Emitted when Studio is attached. */
4440
+ studioAssigned?: StudioAssigned;
4441
+ /** Emitted when Studio is detached. */
4442
+ studioUnassigned?: StudioUnassigned;
4443
+ /**
4444
+ * Emitted when one of the URLs is changed. After this event you may call `urls-server` to fetch
4445
+ * the actual URL.
4446
+ *
4447
+ * See: https://wix.slack.com/archives/C0UHEBPFT/p1732520791210559?thread_ts=1732027914.294059&cid=C0UHEBPFT
4448
+ * See: https://wix.slack.com/archives/C0UHEBPFT/p1744115197619459
4449
+ */
4450
+ urlChanged?: SiteUrlChanged;
4451
+ /** Site is marked as PurgedExternally */
4452
+ sitePurgedExternally?: SitePurgedExternally;
4453
+ /** Emitted when Odeditor is attached. */
4454
+ odeditorAssigned?: OdeditorAssigned;
4455
+ /** Emitted when Odeditor is detached. */
4456
+ odeditorUnassigned?: OdeditorUnassigned;
4457
+ /** Emitted when Picasso is attached. */
4458
+ picassoAssigned?: PicassoAssigned;
4459
+ /** Emitted when Picasso is detached. */
4460
+ picassoUnassigned?: PicassoUnassigned;
4461
+ /** Emitted when Wixel is attached. */
4462
+ wixelAssigned?: WixelAssigned;
4463
+ /** Emitted when Wixel is detached. */
4464
+ wixelUnassigned?: WixelUnassigned;
4465
+ /** Emitted when StudioTwo is attached. */
4466
+ studioTwoAssigned?: StudioTwoAssigned;
4467
+ /** Emitted when StudioTwo is detached. */
4468
+ studioTwoUnassigned?: StudioTwoUnassigned;
4469
+ /** Emitted when media from user domain is enabled. */
4470
+ userDomainMediaEnabled?: UserDomainMediaEnabled;
4471
+ /** Emitted when media from user domain is disabled. */
4472
+ userDomainMediaDisabled?: UserDomainMediaDisabled;
4473
+ /** Emitted when Editorless is attached. */
4474
+ editorlessAssigned?: EditorlessAssigned;
4475
+ /** Emitted when Editorless is detached. */
4476
+ editorlessUnassigned?: EditorlessUnassigned;
4477
+ /**
4478
+ * A meta site id.
4479
+ * @format GUID
4480
+ */
4481
+ metaSiteId?: string;
4482
+ /** A meta site version. Monotonically increasing. */
4483
+ version?: string;
4484
+ /** A timestamp of the event. */
4485
+ timestamp?: string;
4486
+ /**
4487
+ * TODO(meta-site): Change validation once validations are disabled for consumers
4488
+ * More context: https://wix.slack.com/archives/C0UHEBPFT/p1720957844413149 and https://wix.slack.com/archives/CFWKX325T/p1728892152855659
4489
+ * @maxSize 4000
4490
+ */
4491
+ assets?: Asset[];
4492
+ }
4493
+ /** @oneof */
4494
+ interface MetaSiteSpecialEventPayloadOneOf {
4495
+ /** Emitted on a meta site creation. */
4496
+ siteCreated?: SiteCreated;
4497
+ /** Emitted on a meta site transfer completion. */
4498
+ siteTransferred?: SiteTransferred;
4499
+ /** Emitted on a meta site deletion. */
4500
+ siteDeleted?: SiteDeleted;
4501
+ /** Emitted on a meta site restoration. */
4502
+ siteUndeleted?: SiteUndeleted;
4503
+ /** Emitted on the first* publish of the meta site (* switching from unpublished to published state). */
4504
+ sitePublished?: SitePublished;
4505
+ /** Emitted on a meta site unpublish. */
4506
+ siteUnpublished?: SiteUnpublished;
4507
+ /** Emitted when meta site is marked as template. */
4508
+ siteMarkedAsTemplate?: SiteMarkedAsTemplate;
4509
+ /** Emitted when meta site is marked as a WixSite. */
4510
+ siteMarkedAsWixSite?: SiteMarkedAsWixSite;
4511
+ /** Emitted when an application is provisioned (installed). */
4512
+ serviceProvisioned?: ServiceProvisioned;
4513
+ /** Emitted when an application is removed (uninstalled). */
4514
+ serviceRemoved?: ServiceRemoved;
4515
+ /** Emitted when meta site name (URL slug) is changed. */
4516
+ siteRenamedPayload?: SiteRenamed;
4517
+ /** Emitted when meta site was permanently deleted. */
4518
+ hardDeleted?: SiteHardDeleted;
4519
+ /** Emitted on a namespace change. */
4520
+ namespaceChanged?: NamespaceChanged;
4521
+ /** Emitted when Studio is attached. */
4522
+ studioAssigned?: StudioAssigned;
4523
+ /** Emitted when Studio is detached. */
4524
+ studioUnassigned?: StudioUnassigned;
4525
+ /**
4526
+ * Emitted when one of the URLs is changed. After this event you may call `urls-server` to fetch
4527
+ * the actual URL.
4528
+ *
4529
+ * See: https://wix.slack.com/archives/C0UHEBPFT/p1732520791210559?thread_ts=1732027914.294059&cid=C0UHEBPFT
4530
+ * See: https://wix.slack.com/archives/C0UHEBPFT/p1744115197619459
4531
+ */
4532
+ urlChanged?: SiteUrlChanged;
4533
+ /** Site is marked as PurgedExternally */
4534
+ sitePurgedExternally?: SitePurgedExternally;
4535
+ /** Emitted when Odeditor is attached. */
4536
+ odeditorAssigned?: OdeditorAssigned;
4537
+ /** Emitted when Odeditor is detached. */
4538
+ odeditorUnassigned?: OdeditorUnassigned;
4539
+ /** Emitted when Picasso is attached. */
4540
+ picassoAssigned?: PicassoAssigned;
4541
+ /** Emitted when Picasso is detached. */
4542
+ picassoUnassigned?: PicassoUnassigned;
4543
+ /** Emitted when Wixel is attached. */
4544
+ wixelAssigned?: WixelAssigned;
4545
+ /** Emitted when Wixel is detached. */
4546
+ wixelUnassigned?: WixelUnassigned;
4547
+ /** Emitted when StudioTwo is attached. */
4548
+ studioTwoAssigned?: StudioTwoAssigned;
4549
+ /** Emitted when StudioTwo is detached. */
4550
+ studioTwoUnassigned?: StudioTwoUnassigned;
4551
+ /** Emitted when media from user domain is enabled. */
4552
+ userDomainMediaEnabled?: UserDomainMediaEnabled;
4553
+ /** Emitted when media from user domain is disabled. */
4554
+ userDomainMediaDisabled?: UserDomainMediaDisabled;
4555
+ /** Emitted when Editorless is attached. */
4556
+ editorlessAssigned?: EditorlessAssigned;
4557
+ /** Emitted when Editorless is detached. */
4558
+ editorlessUnassigned?: EditorlessUnassigned;
4559
+ }
4560
+ interface Asset {
4561
+ /**
4562
+ * An application definition id (app_id in dev-center). For legacy reasons may be UUID or a string (from Java Enum).
4563
+ * @maxLength 36
4564
+ */
4565
+ appDefId?: string;
4566
+ /**
4567
+ * An instance id. For legacy reasons may be UUID or a string.
4568
+ * @maxLength 200
4569
+ */
4570
+ instanceId?: string;
4571
+ /** An application state. */
4572
+ state?: StateWithLiterals;
4573
+ }
4574
+ declare enum State {
4575
+ UNKNOWN = "UNKNOWN",
4576
+ ENABLED = "ENABLED",
4577
+ DISABLED = "DISABLED",
4578
+ PENDING = "PENDING",
4579
+ DEMO = "DEMO"
4580
+ }
4581
+ /** @enumType */
4582
+ type StateWithLiterals = State | 'UNKNOWN' | 'ENABLED' | 'DISABLED' | 'PENDING' | 'DEMO';
4583
+ interface SiteCreated {
4584
+ /**
4585
+ * A template identifier (empty if not created from a template).
4586
+ * @maxLength 36
4587
+ */
4588
+ originTemplateId?: string;
4589
+ /**
4590
+ * An account id of the owner.
4591
+ * @format GUID
4592
+ */
4593
+ ownerId?: string;
4594
+ /** A context in which meta site was created. */
4595
+ context?: SiteCreatedContextWithLiterals;
4596
+ /**
4597
+ * A meta site id from which this site was created.
4598
+ *
4599
+ * In case of a creation from a template it's a template id.
4600
+ * In case of a site duplication ("Save As" in dashboard or duplicate in UM) it's an id of a source site.
4601
+ * @format GUID
4602
+ */
4603
+ originMetaSiteId?: string | null;
4604
+ /**
4605
+ * A meta site name (URL slug).
4606
+ * @maxLength 20
4607
+ */
4608
+ siteName?: string;
4609
+ /** A namespace. */
4610
+ namespace?: NamespaceWithLiterals;
4611
+ }
4612
+ declare enum SiteCreatedContext {
4613
+ /** A valid option, we don't expose all reasons why site might be created. */
4614
+ OTHER = "OTHER",
4615
+ /** A meta site was created from template. */
4616
+ FROM_TEMPLATE = "FROM_TEMPLATE",
4617
+ /** A meta site was created by copying of the transfferred meta site. */
4618
+ DUPLICATE_BY_SITE_TRANSFER = "DUPLICATE_BY_SITE_TRANSFER",
4619
+ /** A copy of existing meta site. */
4620
+ DUPLICATE = "DUPLICATE",
4621
+ /** A meta site was created as a transfferred site (copy of the original), old flow, should die soon. */
4622
+ OLD_SITE_TRANSFER = "OLD_SITE_TRANSFER",
4623
+ /** deprecated A meta site was created for Flash editor. */
4624
+ FLASH = "FLASH"
4625
+ }
4626
+ /** @enumType */
4627
+ type SiteCreatedContextWithLiterals = SiteCreatedContext | 'OTHER' | 'FROM_TEMPLATE' | 'DUPLICATE_BY_SITE_TRANSFER' | 'DUPLICATE' | 'OLD_SITE_TRANSFER' | 'FLASH';
4628
+ declare enum Namespace {
4629
+ UNKNOWN_NAMESPACE = "UNKNOWN_NAMESPACE",
4630
+ /** Default namespace for UGC sites. MetaSites with this namespace will be shown in a user's site list by default. */
4631
+ WIX = "WIX",
4632
+ /** ShoutOut stand alone product. These are siteless (no actual Wix site, no HtmlWeb). MetaSites with this namespace will *not* be shown in a user's site list by default. */
4633
+ SHOUT_OUT = "SHOUT_OUT",
4634
+ /** MetaSites created by the Albums product, they appear as part of the Albums app. MetaSites with this namespace will *not* be shown in a user's site list by default. */
4635
+ ALBUMS = "ALBUMS",
4636
+ /** Part of the WixStores migration flow, a user tries to migrate and gets this site to view and if the user likes it then stores removes this namespace and deletes the old site with the old stores. MetaSites with this namespace will *not* be shown in a user's site list by default. */
4637
+ WIX_STORES_TEST_DRIVE = "WIX_STORES_TEST_DRIVE",
4638
+ /** Hotels standalone (siteless). MetaSites with this namespace will *not* be shown in a user's site list by default. */
4639
+ HOTELS = "HOTELS",
4640
+ /** Clubs siteless MetaSites, a club without a wix website. MetaSites with this namespace will *not* be shown in a user's site list by default. */
4641
+ CLUBS = "CLUBS",
4642
+ /** A partially created ADI website. MetaSites with this namespace will *not* be shown in a user's site list by default. */
4643
+ ONBOARDING_DRAFT = "ONBOARDING_DRAFT",
4658
4644
  /**
4659
- * Restocked line items and quantities. Only relevant for `{"type": "SOME_ITEMS"}`.
4660
- * @maxSize 300
4645
+ * AppBuilder for AppStudio / shmite (c). MetaSites with this namespace will *not* be shown in a user's site list by default.
4646
+ * Not the dev-center dev site (see Flag.DEV_CENTER_DEV_SITE_FLAG).
4661
4647
  */
4662
- items?: RestockItem[];
4663
- }
4664
- declare enum RestockType {
4665
- NO_ITEMS = "NO_ITEMS",
4666
- ALL_ITEMS = "ALL_ITEMS",
4667
- SOME_ITEMS = "SOME_ITEMS"
4668
- }
4669
- /** @enumType */
4670
- type RestockTypeWithLiterals = RestockType | 'NO_ITEMS' | 'ALL_ITEMS' | 'SOME_ITEMS';
4671
- interface RestockItem {
4648
+ DEV_SITE = "DEV_SITE",
4649
+ /** LogoMaker websites offered to the user after logo purchase. MetaSites with this namespace will *not* be shown in a user's site list by default. */
4650
+ LOGOS = "LOGOS",
4651
+ /** VideoMaker websites offered to the user after video purchase. MetaSites with this namespace will *not* be shown in a user's site list by default. */
4652
+ VIDEO_MAKER = "VIDEO_MAKER",
4653
+ /** MetaSites with this namespace will *not* be shown in a user's site list by default. */
4654
+ PARTNER_DASHBOARD = "PARTNER_DASHBOARD",
4655
+ /** MetaSites with this namespace will *not* be shown in a user's site list by default. */
4656
+ DEV_CENTER_COMPANY = "DEV_CENTER_COMPANY",
4672
4657
  /**
4673
- * ID of the line item being restocked.
4674
- * @format GUID
4658
+ * A draft created by HTML editor on open. Upon "first save" it will be moved to be of WIX domain.
4659
+ *
4660
+ * Meta site with this namespace will *not* be shown in a user's site list by default.
4675
4661
  */
4676
- lineItemId?: string;
4662
+ HTML_DRAFT = "HTML_DRAFT",
4677
4663
  /**
4678
- * Line item quantity being restocked.
4679
- * @min 1
4680
- * @max 100000
4664
+ * the user-journey for Fitness users who want to start from managing their business instead of designing their website.
4665
+ * Will be accessible from Site List and will not have a website app.
4666
+ * Once the user attaches a site, the site will become a regular wixsite.
4681
4667
  */
4682
- quantity?: number;
4683
- }
4684
- interface TriggerRefundResponse {
4685
- /** All order's transactions after the refunds were added */
4686
- orderTransactions?: OrderTransactions;
4687
- /** Created refund ID */
4688
- refundId?: string | null;
4689
- /** Payment ID's that the refund execution had failed for */
4690
- failedPaymentIds?: ItemMetadata[];
4691
- }
4692
- /**
4693
- * A record of all payments and refunds associated with an order.
4694
- *
4695
- * Use order transactions to track payment status, add payment records, process refunds, and monitor chargebacks.
4696
- */
4697
- interface OrderTransactions {
4668
+ SITELESS_BUSINESS = "SITELESS_BUSINESS",
4669
+ /** Belongs to "strategic products" company. Supports new product in the creator's economy space. */
4670
+ CREATOR_ECONOMY = "CREATOR_ECONOMY",
4671
+ /** It is to be used in the Business First efforts. */
4672
+ DASHBOARD_FIRST = "DASHBOARD_FIRST",
4673
+ /** Bookings business flow with no site. */
4674
+ ANYWHERE = "ANYWHERE",
4675
+ /** Namespace for Headless Backoffice with no editor */
4676
+ HEADLESS = "HEADLESS",
4698
4677
  /**
4699
- * Order ID.
4700
- * @format GUID
4678
+ * Namespace for master site that will exist in parent account that will be referenced by subaccounts
4679
+ * The site will be used for account level CSM feature for enterprise
4701
4680
  */
4702
- orderId?: string;
4681
+ ACCOUNT_MASTER_CMS = "ACCOUNT_MASTER_CMS",
4682
+ /** Rise.ai Siteless account management for Gift Cards and Store Credit. */
4683
+ RISE = "RISE",
4703
4684
  /**
4704
- * Record of payments made to the merchant.
4705
- * @maxSize 100
4685
+ * As part of the branded app new funnel, users now can create a meta site that will be branded app first.
4686
+ * There's a blank site behind the scene but it's blank).
4687
+ * The Mobile company will be the owner of this namespace.
4706
4688
  */
4707
- payments?: Payment[];
4689
+ BRANDED_FIRST = "BRANDED_FIRST",
4690
+ /** Nownia.com Siteless account management for Ai Scheduling Assistant. */
4691
+ NOWNIA = "NOWNIA",
4708
4692
  /**
4709
- * Record of refunds made to the buyer.
4710
- * @maxSize 300
4693
+ * UGC Templates are templates that are created by users for personal use and to sale to other users.
4694
+ * The Partners company owns this namespace.
4711
4695
  */
4712
- refunds?: Refund[];
4713
- }
4714
- interface Payment extends PaymentPaymentDetailsOneOf, PaymentReceiptInfoOneOf, PaymentStatusDetailsOneOf {
4715
- /** Regular payment details. */
4716
- regularPaymentDetails?: RegularPaymentDetails;
4717
- /** Gift card payment details. */
4718
- giftcardPaymentDetails?: GiftCardPaymentDetails;
4719
- /** Membership payment details. */
4720
- membershipPaymentDetails?: MembershipPaymentDetails;
4696
+ UGC_TEMPLATE = "UGC_TEMPLATE",
4697
+ /** Codux Headless Sites */
4698
+ CODUX = "CODUX",
4699
+ /** Bobb - AI Design Creator. */
4700
+ MEDIA_DESIGN_CREATOR = "MEDIA_DESIGN_CREATOR",
4721
4701
  /**
4722
- * Payment ID.
4723
- * @format GUID
4724
- * @readonly
4702
+ * Shared Blog Site is a unique single site across Enterprise account,
4703
+ * This site will hold all Blog posts related to the Marketing product.
4725
4704
  */
4726
- _id?: string | null;
4727
- /** Date and time the payment was created in [ISO-8601](https://en.wikipedia.org/wiki/ISO_8601#Combined_date_and_time_representations) format. Defaults to current time when not provided. */
4728
- _createdDate?: Date | null;
4705
+ SHARED_BLOG_ENTERPRISE = "SHARED_BLOG_ENTERPRISE",
4706
+ /** Standalone forms (siteless). MetaSites with this namespace will *not* be shown in a user's site list by default. */
4707
+ STANDALONE_FORMS = "STANDALONE_FORMS",
4708
+ /** Standalone events (siteless). MetaSites with this namespace will *not* be shown in a user's site list by default. */
4709
+ STANDALONE_EVENTS = "STANDALONE_EVENTS",
4710
+ /** MIMIR - Siteless account for MIMIR Ai Job runner. */
4711
+ MIMIR = "MIMIR",
4712
+ /** Wix Twins platform. */
4713
+ TWINS = "TWINS",
4714
+ /** Wix Nano. */
4715
+ NANO = "NANO",
4716
+ /** Base44 headless sites. */
4717
+ BASE44 = "BASE44",
4718
+ /** Wix Channels Sites */
4719
+ CHANNELS = "CHANNELS",
4720
+ /** Nautilus platform. */
4721
+ NAUTILUS = "NAUTILUS",
4729
4722
  /**
4730
- * Date and time the payment was last updated in [ISO-8601](https://en.wikipedia.org/wiki/ISO_8601#Combined_date_and_time_representations) format.
4731
- * @readonly
4723
+ * Symphony — a siteless site representing a project within Symphony (the evolution of Orion).
4724
+ * Holds project data, conversations, assets, and manages collaborators / shared team members for the project.
4732
4725
  */
4733
- _updatedDate?: Date | null;
4734
- /** Payment amount. */
4735
- amount?: Price;
4726
+ SYMPHONY = "SYMPHONY",
4727
+ /** Nautilus platform app. */
4728
+ NAUTILUS_APPS = "NAUTILUS_APPS",
4736
4729
  /**
4737
- * Whether refunds for this payment are disabled.
4738
- * + `true`: This payment is not refundable.
4739
- * + `false`: This payment may be refunded. However, this ultimately depends on the payment provider.
4730
+ * Vibu — a siteless site representing a project built with Vibu (the AI app builder).
4731
+ * Holds the project's generated code, conversations, assets, and manages collaborators for the project.
4740
4732
  */
4741
- refundDisabled?: boolean;
4733
+ VIBU = "VIBU",
4742
4734
  /**
4743
- * Whether receipt generation is allowed for this payment.
4744
- * + `true`: This payment supports receipt generation.
4745
- * + `false`: This payment doesn't support receipt generation, or a receipt was already generated.
4746
- * @readonly
4735
+ * Ghost site for the BrandKit multi-site platform. Each ghost backs a single BrandKit
4736
+ * (an Enterprise account may have several), holding that BrandKit's brand definition
4737
+ * (theme, typography, assets) which is rolled out to the BrandKit's connected sites.
4738
+ * MetaSites with this namespace will *not* be shown in a user's site list by default.
4747
4739
  */
4748
- supportReceiptGeneration?: boolean;
4749
- /** Details about cash rounding applied to this payment, when relevant. */
4750
- cashRounding?: CashRoundingDetails;
4740
+ ENTERPRISE_BRAND_KIT = "ENTERPRISE_BRAND_KIT",
4751
4741
  /**
4752
- * Overall payment status.
4753
- *
4754
- * Gift card and membership payments support only `APPROVED`, `PENDING`, `CANCELED`, `DECLINED`, and `VOIDED`. The remaining values apply to regular payments.
4742
+ * Dev-center development sites (com.wixpress.devcenter.dsm).
4743
+ * DEPRECATED: replaced by Flag.DEV_CENTER_DEV_SITE_FLAG (a dev site is orthogonal to the namespace). Do not use for new sites.
4755
4744
  */
4756
- status?: PaymentStatusWithLiterals;
4745
+ DEV_CENTER_DEV_SITE = "DEV_CENTER_DEV_SITE"
4746
+ }
4747
+ /** @enumType */
4748
+ type NamespaceWithLiterals = Namespace | 'UNKNOWN_NAMESPACE' | 'WIX' | 'SHOUT_OUT' | 'ALBUMS' | 'WIX_STORES_TEST_DRIVE' | 'HOTELS' | 'CLUBS' | 'ONBOARDING_DRAFT' | 'DEV_SITE' | 'LOGOS' | 'VIDEO_MAKER' | 'PARTNER_DASHBOARD' | 'DEV_CENTER_COMPANY' | 'HTML_DRAFT' | 'SITELESS_BUSINESS' | 'CREATOR_ECONOMY' | 'DASHBOARD_FIRST' | 'ANYWHERE' | 'HEADLESS' | 'ACCOUNT_MASTER_CMS' | 'RISE' | 'BRANDED_FIRST' | 'NOWNIA' | 'UGC_TEMPLATE' | 'CODUX' | 'MEDIA_DESIGN_CREATOR' | 'SHARED_BLOG_ENTERPRISE' | 'STANDALONE_FORMS' | 'STANDALONE_EVENTS' | 'MIMIR' | 'TWINS' | 'NANO' | 'BASE44' | 'CHANNELS' | 'NAUTILUS' | 'SYMPHONY' | 'NAUTILUS_APPS' | 'VIBU' | 'ENTERPRISE_BRAND_KIT' | 'DEV_CENTER_DEV_SITE';
4749
+ /** Site transferred to another user. */
4750
+ interface SiteTransferred {
4757
4751
  /**
4758
- * ID linking this payment to the charge request that created it. Matches the `idempotencyKey` sent in the Charge Order request.
4752
+ * A previous owner id (user that transfers meta site).
4759
4753
  * @format GUID
4760
4754
  */
4761
- chargeCorrelationId?: string | null;
4762
- }
4763
- /** @oneof */
4764
- interface PaymentPaymentDetailsOneOf {
4765
- /** Regular payment details. */
4766
- regularPaymentDetails?: RegularPaymentDetails;
4767
- /** Gift card payment details. */
4768
- giftcardPaymentDetails?: GiftCardPaymentDetails;
4769
- /** Membership payment details. */
4770
- membershipPaymentDetails?: MembershipPaymentDetails;
4771
- }
4772
- /** @oneof */
4773
- interface PaymentReceiptInfoOneOf {
4755
+ oldOwnerId?: string;
4756
+ /**
4757
+ * A new owner id (user that accepts meta site).
4758
+ * @format GUID
4759
+ */
4760
+ newOwnerId?: string;
4774
4761
  }
4775
- /** @oneof */
4776
- interface PaymentStatusDetailsOneOf {
4762
+ /** Soft deletion of the meta site. Could be restored. */
4763
+ interface SiteDeleted {
4764
+ /** A deletion context. */
4765
+ deleteContext?: DeleteContext;
4777
4766
  }
4778
- interface RegularPaymentDetails extends RegularPaymentDetailsPaymentMethodDetailsOneOf {
4779
- /** Credit card details. */
4780
- creditCardDetails?: CreditCardPaymentMethodDetails;
4767
+ interface DeleteContext {
4768
+ /** When the meta site was deleted. */
4769
+ dateDeleted?: Date | null;
4770
+ /** A status. */
4771
+ deleteStatus?: DeleteStatusWithLiterals;
4781
4772
  /**
4782
- * Wix Payments order ID.
4783
- * @maxLength 100
4773
+ * A reason (flow).
4774
+ * @maxLength 255
4784
4775
  */
4785
- paymentOrderId?: string | null;
4776
+ deleteOrigin?: string;
4786
4777
  /**
4787
- * Payment gateway's transaction ID.
4788
- * This field is only returned when the value of `offline_payment` is `false`.
4789
- * @maxLength 100
4778
+ * A service that deleted it.
4779
+ * @maxLength 255
4790
4780
  */
4791
- gatewayTransactionId?: string | null;
4781
+ initiatorId?: string | null;
4782
+ }
4783
+ declare enum DeleteStatus {
4784
+ UNKNOWN = "UNKNOWN",
4785
+ TRASH = "TRASH",
4786
+ DELETED = "DELETED",
4787
+ PENDING_PURGE = "PENDING_PURGE",
4788
+ PURGED_EXTERNALLY = "PURGED_EXTERNALLY"
4789
+ }
4790
+ /** @enumType */
4791
+ type DeleteStatusWithLiterals = DeleteStatus | 'UNKNOWN' | 'TRASH' | 'DELETED' | 'PENDING_PURGE' | 'PURGED_EXTERNALLY';
4792
+ /** Restoration of the meta site. */
4793
+ interface SiteUndeleted {
4794
+ }
4795
+ /** First publish of a meta site. Or subsequent publish after unpublish. */
4796
+ interface SitePublished {
4797
+ }
4798
+ interface SiteUnpublished {
4799
+ /**
4800
+ * A list of URLs previously associated with the meta site.
4801
+ * @maxLength 4000
4802
+ * @maxSize 10000
4803
+ */
4804
+ urls?: string[];
4805
+ }
4806
+ interface SiteMarkedAsTemplate {
4807
+ }
4808
+ interface SiteMarkedAsWixSite {
4809
+ }
4810
+ /**
4811
+ * Represents a service provisioned a site.
4812
+ *
4813
+ * Note on `origin_instance_id`:
4814
+ * There is no guarantee that you will be able to find a meta site using `origin_instance_id`.
4815
+ * This is because of the following scenario:
4816
+ *
4817
+ * Imagine you have a template where a third-party application (TPA) includes some stub data,
4818
+ * such as a product catalog. When you create a site from this template, you inherit this
4819
+ * default product catalog. However, if the template's product catalog is modified,
4820
+ * your site will retain the catalog as it was at the time of site creation. This ensures that
4821
+ * your site remains consistent with what you initially received and does not include any
4822
+ * changes made to the original template afterward.
4823
+ * To ensure this, the TPA on the template gets a new instance_id.
4824
+ */
4825
+ interface ServiceProvisioned {
4792
4826
  /**
4793
- * Payment method.
4794
- * Deprecated. Use `paymentMethodName.buyerLanguageName` instead.
4795
- * Non-exhaustive list of supported values:
4796
- * + `CreditCard`, `Alipay`, `AstropayCash`, `AstropayDBT`, `AstropayMBT`, `Bitcoin`, `BitPay`, `Cash`, `ConvenienceStore`, `EPay`, `Fake`, `Giropay`, `IDeal`, `InPerson`, `Klarna`, `MercadoPago`, `Netpay`, `NordeaSolo`, `Offline`, `PagSeguro`, `PayEasy`, `PayPal`, `Paysafecard`, `Paysafecash`, `PointOfSale`, `Poli`, `Privat24`, `Przelewy24`, `RapidTransfer`, `Sepa`, `Skrill`, `Sofort`, `Trustly`, `Neteller`, `Unionpay`, `UniPay`, `Yandex`
4797
- * @maxLength 150
4798
- * @deprecated Payment method.
4799
- * Deprecated. Use `paymentMethodName.buyerLanguageName` instead.
4800
- * Non-exhaustive list of supported values:
4801
- * + `CreditCard`, `Alipay`, `AstropayCash`, `AstropayDBT`, `AstropayMBT`, `Bitcoin`, `BitPay`, `Cash`, `ConvenienceStore`, `EPay`, `Fake`, `Giropay`, `IDeal`, `InPerson`, `Klarna`, `MercadoPago`, `Netpay`, `NordeaSolo`, `Offline`, `PagSeguro`, `PayEasy`, `PayPal`, `Paysafecard`, `Paysafecash`, `PointOfSale`, `Poli`, `Privat24`, `Przelewy24`, `RapidTransfer`, `Sepa`, `Skrill`, `Sofort`, `Trustly`, `Neteller`, `Unionpay`, `UniPay`, `Yandex`
4802
- * @replacedBy payment_method_name
4803
- * @targetRemovalDate 2026-07-01
4827
+ * Either UUID or EmbeddedServiceType.
4828
+ * @maxLength 36
4804
4829
  */
4805
- paymentMethod?: string | null;
4830
+ appDefId?: string;
4806
4831
  /**
4807
- * Transaction ID in the payment provider's system. For example, at PayPal, Square, Stripe, etc. Not returned for offline payments.
4808
- * @maxLength 100
4832
+ * Not only UUID. Something here could be something weird.
4833
+ * @maxLength 36
4809
4834
  */
4810
- providerTransactionId?: string | null;
4811
- /** Whether the payment was made offline. For example, when using cash or when marked as paid in the Business Manager. */
4812
- offlinePayment?: boolean;
4835
+ instanceId?: string;
4813
4836
  /**
4814
- * Payment status.
4815
- * @deprecated Payment status.
4816
- * @replacedBy payment.status
4817
- * @targetRemovalDate 2026-11-01
4837
+ * An instance id from which this instance is originated.
4838
+ * @maxLength 36
4818
4839
  */
4819
- status?: TransactionStatusWithLiterals;
4820
- /** Whether there is a payment agreement that allows for future charges. */
4821
- savedPaymentMethod?: boolean;
4822
- /** Authorization details. */
4823
- authorizationDetails?: AuthorizationDetails;
4840
+ originInstanceId?: string;
4824
4841
  /**
4825
- * Record of chargebacks made by the buyer.
4826
- * @maxSize 6
4842
+ * A version.
4843
+ * @maxLength 500
4827
4844
  */
4828
- chargebacks?: Chargeback[];
4829
- /** Platform fee amount associated with this payment. */
4830
- platformFee?: Price;
4845
+ version?: string | null;
4831
4846
  /**
4832
- * Payment method with buyer and optional owner translations.
4833
- * Non-exhaustive list of supported values:
4834
- * + `CreditCard`, `Alipay`, `AstropayCash`, `AstropayDBT`, `AstropayMBT`, `Bitcoin`, `BitPay`, `Cash`, `ConvenienceStore`, `EPay`, `Fake`, `Giropay`, `IDeal`, `InPerson`, `Klarna`, `MercadoPago`, `Netpay`, `NordeaSolo`, `Offline`, `PagSeguro`, `PayEasy`, `PayPal`, `Paysafecard`, `Paysafecash`, `PointOfSale`, `Poli`, `Privat24`, `Przelewy24`, `RapidTransfer`, `Sepa`, `Skrill`, `Sofort`, `Trustly`, `Neteller`, `Unionpay`, `UniPay`, `Yandex`
4847
+ * The origin meta site id
4848
+ * @format GUID
4835
4849
  */
4836
- paymentMethodName?: PaymentMethodName;
4837
- }
4838
- /** @oneof */
4839
- interface RegularPaymentDetailsPaymentMethodDetailsOneOf {
4840
- /** Credit card details. */
4841
- creditCardDetails?: CreditCardPaymentMethodDetails;
4842
- }
4843
- declare enum TransactionStatus {
4844
- UNDEFINED = "UNDEFINED",
4845
- APPROVED = "APPROVED",
4846
- PENDING = "PENDING",
4847
- PENDING_MERCHANT = "PENDING_MERCHANT",
4848
- CANCELED = "CANCELED",
4849
- DECLINED = "DECLINED",
4850
- REFUNDED = "REFUNDED",
4851
- PARTIALLY_REFUNDED = "PARTIALLY_REFUNDED",
4852
- AUTHORIZED = "AUTHORIZED",
4853
- VOIDED = "VOIDED"
4850
+ originMetaSiteId?: string | null;
4854
4851
  }
4855
- /** @enumType */
4856
- type TransactionStatusWithLiterals = TransactionStatus | 'UNDEFINED' | 'APPROVED' | 'PENDING' | 'PENDING_MERCHANT' | 'CANCELED' | 'DECLINED' | 'REFUNDED' | 'PARTIALLY_REFUNDED' | 'AUTHORIZED' | 'VOIDED';
4857
- interface CreditCardPaymentMethodDetails {
4852
+ interface ServiceRemoved {
4858
4853
  /**
4859
- * The last 4 digits of the card number.
4860
- * @maxLength 4
4854
+ * Either UUID or EmbeddedServiceType.
4855
+ * @maxLength 36
4861
4856
  */
4862
- lastFourDigits?: string | null;
4857
+ appDefId?: string;
4863
4858
  /**
4864
- * Card issuer's brand.
4865
- * @maxLength 100
4859
+ * Not only UUID. Something here could be something weird.
4860
+ * @maxLength 36
4866
4861
  */
4867
- brand?: string | null;
4868
- }
4869
- interface AuthorizationDetails {
4862
+ instanceId?: string;
4870
4863
  /**
4871
- * Whether the authorized payment is of a delayed capture.
4872
- * @readonly
4864
+ * A version.
4865
+ * @maxLength 500
4873
4866
  */
4874
- delayedCapture?: boolean;
4875
- /** Date and time the payment was authorized in [ISO-8601](https://en.wikipedia.org/wiki/ISO_8601#Combined_date_and_time_representations) format. */
4876
- authorizedDate?: Date | null;
4867
+ version?: string | null;
4868
+ }
4869
+ /** Rename of the site. Meaning, free public url has been changed as well. */
4870
+ interface SiteRenamed {
4877
4871
  /**
4878
- * List of captures associated with payment
4879
- * In case of failed it can be replaced with new one with PENDING or SUCCESS statuses
4880
- * @maxSize 1
4872
+ * A new meta site name (URL slug).
4873
+ * @maxLength 20
4881
4874
  */
4882
- captures?: AuthorizationCapture[];
4883
- /** Void associated with payment */
4884
- void?: AuthorizationVoid;
4885
- /** Scheduled action for this transaction */
4886
- scheduledAction?: V1ScheduledAction;
4887
- }
4888
- interface AuthorizationCapture {
4875
+ newSiteName?: string;
4889
4876
  /**
4890
- * Capture ID.
4891
- * @format GUID
4892
- * @readonly
4877
+ * A previous meta site name (URL slug).
4878
+ * @maxLength 255
4893
4879
  */
4894
- _id?: string | null;
4895
- /** Status of this capture action */
4896
- status?: AuthorizationCaptureStatusWithLiterals;
4880
+ oldSiteName?: string;
4881
+ }
4882
+ /**
4883
+ * Hard deletion of the meta site.
4884
+ *
4885
+ * Could not be restored. Therefore it's desirable to cleanup data.
4886
+ */
4887
+ interface SiteHardDeleted {
4888
+ /** A deletion context. */
4889
+ deleteContext?: DeleteContext;
4890
+ }
4891
+ interface NamespaceChanged {
4892
+ /** A previous namespace. */
4893
+ oldNamespace?: NamespaceWithLiterals;
4894
+ /** A new namespace. */
4895
+ newNamespace?: NamespaceWithLiterals;
4896
+ }
4897
+ /** Assigned Studio editor */
4898
+ interface StudioAssigned {
4899
+ }
4900
+ /** Unassigned Studio editor */
4901
+ interface StudioUnassigned {
4902
+ }
4903
+ /**
4904
+ * Fired in case site URLs were changed in any way: new secondary domain, published, account slug rename, site rename etc.
4905
+ *
4906
+ * This is an internal event, it's not propagated in special events, because it's non-actionable. If you need to keep up
4907
+ * with sites and its urls, you need to listen to another topic/event. Read about it:
4908
+ *
4909
+ * https://bo.wix.com/wix-docs/rest/meta-site/meta-site---urls-service
4910
+ */
4911
+ interface SiteUrlChanged {
4912
+ }
4913
+ /**
4914
+ * Used at the end of the deletion flow for both draft sites and when a user deletes a site.
4915
+ * Consumed by other teams to remove relevant data.
4916
+ */
4917
+ interface SitePurgedExternally {
4897
4918
  /**
4898
- * Amount of this capture
4899
- * @immutable
4919
+ * @maxLength 2048
4920
+ * @maxSize 100
4921
+ * @deprecated
4922
+ * @targetRemovalDate 2025-04-15
4900
4923
  */
4901
- amount?: Price;
4902
- /** Date and time the capture was initiated in [ISO-8601](https://en.wikipedia.org/wiki/ISO_8601#Combined_date_and_time_representations) format. */
4903
- _createdDate?: Date | null;
4904
- /** In case of status is FAILED may contain failure details */
4905
- failureDetails?: AuthorizationActionFailureDetails;
4924
+ appDefId?: string[];
4906
4925
  }
4907
- declare enum AuthorizationCaptureStatus {
4908
- /** Capture operation still in progress. */
4909
- PENDING = "PENDING",
4910
- /** Capture operation succeeded. */
4911
- SUCCEEDED = "SUCCEEDED",
4912
- /** Capture operation failed. */
4913
- FAILED = "FAILED"
4926
+ /** Assigned Odeditor */
4927
+ interface OdeditorAssigned {
4914
4928
  }
4915
- /** @enumType */
4916
- type AuthorizationCaptureStatusWithLiterals = AuthorizationCaptureStatus | 'PENDING' | 'SUCCEEDED' | 'FAILED';
4917
- interface AuthorizationActionFailureDetails {
4918
- /** @maxLength 100 */
4919
- failureCode?: string;
4929
+ /** Unassigned Odeditor */
4930
+ interface OdeditorUnassigned {
4920
4931
  }
4921
- interface AuthorizationVoid {
4922
- /** Status of this void action */
4923
- status?: AuthorizationVoidStatusWithLiterals;
4924
- /** Date and time the void was initiated in [ISO-8601](https://en.wikipedia.org/wiki/ISO_8601#Combined_date_and_time_representations) format. */
4925
- voidedDate?: Date | null;
4926
- /** In case of status is FAILED may contain failure details */
4927
- failureDetails?: AuthorizationActionFailureDetails;
4928
- /** Reason of void action */
4929
- reason?: ReasonWithLiterals;
4932
+ /** Assigned Picasso editor */
4933
+ interface PicassoAssigned {
4930
4934
  }
4931
- declare enum AuthorizationVoidStatus {
4932
- /** Void operation still in progress. */
4933
- PENDING = "PENDING",
4934
- /** Void operation succeeded. */
4935
- SUCCEEDED = "SUCCEEDED",
4936
- /** Void operation failed. */
4937
- FAILED = "FAILED"
4935
+ /** Unassigned Picasso */
4936
+ interface PicassoUnassigned {
4938
4937
  }
4939
- /** @enumType */
4940
- type AuthorizationVoidStatusWithLiterals = AuthorizationVoidStatus | 'PENDING' | 'SUCCEEDED' | 'FAILED';
4941
- /** Reason the authorization was voided. */
4942
- declare enum Reason {
4943
- /** Authorization was voided by user. */
4944
- MANUAL = "MANUAL",
4945
- /** Authorization passed execution date. */
4946
- SCHEDULED = "SCHEDULED"
4938
+ /** Assigned Wixel */
4939
+ interface WixelAssigned {
4947
4940
  }
4948
- /** @enumType */
4949
- type ReasonWithLiterals = Reason | 'MANUAL' | 'SCHEDULED';
4950
- interface V1ScheduledAction {
4951
- /** Type of the action. */
4952
- actionType?: ActionTypeWithLiterals;
4953
- /** The date and time of the action. */
4954
- executionDate?: Date | null;
4941
+ /** Unassigned Wixel */
4942
+ interface WixelUnassigned {
4955
4943
  }
4956
- declare enum ActionType {
4957
- VOID = "VOID",
4958
- CAPTURE = "CAPTURE"
4944
+ /** Assigned StudioTwo */
4945
+ interface StudioTwoAssigned {
4946
+ }
4947
+ /** Unassigned StudioTwo */
4948
+ interface StudioTwoUnassigned {
4949
+ }
4950
+ /** Media from user domain is enabled. */
4951
+ interface UserDomainMediaEnabled {
4952
+ }
4953
+ /** Media from user domain is disabled. */
4954
+ interface UserDomainMediaDisabled {
4955
+ }
4956
+ /** Assigned Editorless */
4957
+ interface EditorlessAssigned {
4958
+ }
4959
+ /** Unassigned Editorless */
4960
+ interface EditorlessUnassigned {
4961
+ }
4962
+ interface HasCustomEmailConfigurationsRequest {
4963
+ }
4964
+ interface HasCustomEmailConfigurationsResponse {
4965
+ hasCustomConfigurations?: boolean;
4966
+ }
4967
+ interface AddToAutomationMigrationPopulationRequest {
4968
+ /** When true, sends custom email configurations to automation system via email */
4969
+ sendCustomEmailConfigs?: boolean;
4970
+ /** Origin of the migration request. Defaults to OPT_IN when UNKNOWN_ORIGIN. */
4971
+ origin?: OriginWithLiterals;
4972
+ }
4973
+ declare enum Origin {
4974
+ OPT_IN = "OPT_IN",
4975
+ MIGRATION = "MIGRATION"
4959
4976
  }
4960
4977
  /** @enumType */
4961
- type ActionTypeWithLiterals = ActionType | 'VOID' | 'CAPTURE';
4962
- interface Chargeback {
4978
+ type OriginWithLiterals = Origin | 'OPT_IN' | 'MIGRATION';
4979
+ interface AddToAutomationMigrationPopulationResponse {
4980
+ success?: boolean;
4981
+ }
4982
+ interface IsInAutomationMigrationPopulationRequest {
4983
+ }
4984
+ interface IsInAutomationMigrationPopulationResponse {
4985
+ inPopulation?: boolean;
4986
+ }
4987
+ interface PreparePaymentCollectionRequest {
4963
4988
  /**
4964
- * Chargeback ID.
4965
- * @format GUID
4966
- * @readonly
4967
- * @immutable
4989
+ * Ecom order ID.
4990
+ * @minLength 1
4991
+ * @maxLength 100
4968
4992
  */
4969
- _id?: string;
4993
+ ecomOrderId: string;
4994
+ /** Amount to collect */
4995
+ amount: Price;
4970
4996
  /**
4971
- * Date and time the chargeback was created in [ISO-8601](https://en.wikipedia.org/wiki/ISO_8601#Combined_date_and_time_representations) format. Defaults to current time when not provided.
4972
- * @readonly
4973
- * @immutable
4997
+ * Optional parameter. When present, payment collection will be performed using given payment gateway order.
4998
+ * Existing payment gateway order will be updated with a new amount.
4999
+ * When parameter is absent, new payment gateway order will be created and used for payment collection.
4974
5000
  */
4975
- _createdDate?: Date | null;
5001
+ paymentGatewayOrderId?: string | null;
4976
5002
  /**
4977
- * Date and time the chargeback was updated in [ISO-8601](https://en.wikipedia.org/wiki/ISO_8601#Combined_date_and_time_representations) format. Defaults to current time when not provided.
4978
- * @readonly
5003
+ * Whether to delay capture of the payment.
5004
+ * Default: false
5005
+ * @deprecated Whether to delay capture of the payment.
5006
+ * Default: false
5007
+ * @replacedBy delayed_capture_settings.scheduled_action
5008
+ * @targetRemovalDate 2024-09-30
4979
5009
  */
4980
- _updatedDate?: Date | null;
5010
+ delayedCapture?: boolean;
5011
+ /** Delayed capture payment settings */
5012
+ delayedCaptureSettings?: DelayedCaptureSettings;
5013
+ }
5014
+ interface RedirectUrls {
4981
5015
  /**
4982
- * Amount.
4983
- * @readonly
4984
- * @immutable
5016
+ * URL to redirect buyer in case of approved (successful) transaction
5017
+ * @format WEB_URL
4985
5018
  */
4986
- amount?: Price;
5019
+ successUrl?: string | null;
4987
5020
  /**
4988
- * Reversal amount. Present only when status is REVERSED.
4989
- * @readonly
5021
+ * URL to redirect buyer in case of buyer canceled the transaction
5022
+ * @format WEB_URL
4990
5023
  */
4991
- reversalAmount?: Price;
5024
+ cancelUrl?: string | null;
4992
5025
  /**
4993
- * Status.
4994
- *
4995
- * Default: `"APPROVED"`.
5026
+ * URL to redirect buyer in case of failed/rejected transaction
5027
+ * @format WEB_URL
4996
5028
  */
4997
- status?: ChargebackStatusWithLiterals;
5029
+ errorUrl?: string | null;
4998
5030
  /**
4999
- * External chargeback ID.
5000
- * @format GUID
5001
- * @readonly
5002
- * @immutable
5031
+ * URL to redirect buyer in case of pending transaction (that might take some time to process)
5032
+ * @format WEB_URL
5003
5033
  */
5004
- externalId?: string | null;
5034
+ pendingUrl?: string | null;
5005
5035
  }
5006
- declare enum ChargebackStatus {
5007
- /** Chargeback was approved. */
5008
- APPROVED = "APPROVED",
5009
- /** Chargeback was reversed. */
5010
- REVERSED = "REVERSED"
5036
+ interface DelayedCaptureSettings {
5037
+ /** Specifies the automatic action (void/capture) for authorized transaction after the specified duration */
5038
+ scheduledAction?: ScheduledActionWithLiterals;
5039
+ /** Delay duration before execution. Optional - if not set, providers default period will be used */
5040
+ delayDuration?: Duration;
5041
+ }
5042
+ declare enum ScheduledAction {
5043
+ /** Whether payment will be auto-voided when duration passes */
5044
+ VOID = "VOID",
5045
+ /** Whether payment will be auto-captured when duration passes */
5046
+ CAPTURE = "CAPTURE"
5011
5047
  }
5012
5048
  /** @enumType */
5013
- type ChargebackStatusWithLiterals = ChargebackStatus | 'APPROVED' | 'REVERSED';
5014
- interface PaymentMethodName {
5015
- /**
5016
- * Payment method name in the buyer's language. For example, `"Credit/Debit Cards"`.
5017
- * @maxLength 150
5018
- */
5019
- buyerLanguageName?: string | null;
5020
- /**
5021
- * Payment method name in the site's language. For example, `"Credit/Debit Cards"`.
5022
- *
5023
- * When no site-language name is stored, holds the same value as `buyerLanguageName`.
5024
- * @maxLength 150
5025
- */
5026
- siteLanguageName?: string | null;
5049
+ type ScheduledActionWithLiterals = ScheduledAction | 'VOID' | 'CAPTURE';
5050
+ interface Duration {
5027
5051
  /**
5028
- * User-provided payment method name.
5029
- *
5030
- * When set, takes precedence over `buyerLanguageName` and `siteLanguageName`.
5052
+ * Amount of units. For example, 30 MINUTES, 1 HOURS, 7 DAYS, etc
5053
+ * @min 1
5031
5054
  */
5032
- userDefinedName?: UserDefinedPaymentMethodName;
5055
+ count?: number;
5056
+ /** Duration unit: MINUTES, HOURS and DAYS */
5057
+ unit?: DurationUnitWithLiterals;
5033
5058
  }
5034
- interface GiftCardPaymentDetails {
5035
- /**
5036
- * Gift card payment ID.
5037
- * @maxLength 100
5038
- */
5039
- giftCardPaymentId?: string;
5040
- /**
5041
- * ID of the app that created the gift card.
5042
- * @format GUID
5043
- */
5044
- appId?: string;
5045
- /**
5046
- * Whether the gift card is voided.
5047
- * @readonly
5048
- * @deprecated Whether the gift card is voided.
5049
- * @replacedBy payment.status
5050
- * @targetRemovalDate 2026-11-01
5051
- */
5052
- voided?: boolean;
5053
- /**
5054
- * Gift card code with all but the last four characters masked. For example, `************QXY1`.
5055
- * @maxLength 30
5056
- * @immutable
5057
- */
5058
- obfuscatedCode?: string | null;
5059
+ declare enum DurationUnit {
5060
+ MINUTES = "MINUTES",
5061
+ HOURS = "HOURS",
5062
+ DAYS = "DAYS"
5059
5063
  }
5060
- interface MembershipPaymentDetails {
5061
- /**
5062
- * Membership ID.
5063
- * @maxLength 200
5064
- */
5065
- membershipId?: string;
5064
+ /** @enumType */
5065
+ type DurationUnitWithLiterals = DurationUnit | 'MINUTES' | 'HOURS' | 'DAYS';
5066
+ interface PreparePaymentCollectionResponse {
5067
+ /** Payment gateway order id which is associated with given payment */
5068
+ paymentGatewayOrderId?: string;
5069
+ }
5070
+ interface GetPaymentCollectabilityStatusRequest {
5066
5071
  /**
5067
- * ID of the line item this membership applies to.
5072
+ * Ecom order ID.
5068
5073
  * @minLength 1
5069
5074
  * @maxLength 100
5070
5075
  */
5071
- lineItemId?: string;
5072
- /**
5073
- * Payment status.
5074
- * @deprecated Payment status.
5075
- * @replacedBy payment.status
5076
- * @targetRemovalDate 2026-11-01
5077
- */
5078
- status?: MembershipPaymentStatusWithLiterals;
5079
- /** Membership name. */
5080
- name?: MembershipName;
5076
+ ecomOrderId: string;
5077
+ }
5078
+ interface GetPaymentCollectabilityStatusResponse {
5079
+ /** Payment collectability status */
5080
+ status?: PaymentCollectabilityStatusWithLiterals;
5081
+ /** Collectable order amount */
5082
+ amount?: Price;
5083
+ }
5084
+ declare enum PaymentCollectabilityStatus {
5085
+ UNKNOWN = "UNKNOWN",
5086
+ COLLECTABLE = "COLLECTABLE",
5087
+ NONCOLLECTABLE_ORDER_IS_CANCELLED = "NONCOLLECTABLE_ORDER_IS_CANCELLED",
5088
+ NONCOLLECTABLE_ORDER_IS_PAID = "NONCOLLECTABLE_ORDER_IS_PAID",
5089
+ NONCOLLECTABLE_MISSING_PAYMENT_METHOD = "NONCOLLECTABLE_MISSING_PAYMENT_METHOD",
5090
+ NONCOLLECTABLE_ORDER_IS_PENDING = "NONCOLLECTABLE_ORDER_IS_PENDING",
5091
+ NONCOLLECTABLE_ORDER_IS_REJECTED = "NONCOLLECTABLE_ORDER_IS_REJECTED",
5092
+ NONCOLLECTABLE_ORDER_HAS_SUBSCRIPTIONS = "NONCOLLECTABLE_ORDER_HAS_SUBSCRIPTIONS",
5093
+ NONCOLLECTABLE_ORDER_HAS_CHARGEBACKS = "NONCOLLECTABLE_ORDER_HAS_CHARGEBACKS",
5094
+ NONCOLLECTABLE_SUBSCRIPTION_CYCLE_ALREADY_PASSED = "NONCOLLECTABLE_SUBSCRIPTION_CYCLE_ALREADY_PASSED",
5095
+ NONCOLLECTABLE_ORDER_HAS_UNSUPPORTED_SUBSCRIPTION = "NONCOLLECTABLE_ORDER_HAS_UNSUPPORTED_SUBSCRIPTION",
5096
+ NONCOLLECTABLE_CUSTOM_AMOUNT_NOT_SUPPORTED = "NONCOLLECTABLE_CUSTOM_AMOUNT_NOT_SUPPORTED",
5097
+ NONCOLLECTABLE_SUBSCRIPTION_START_DATE_IN_PAST = "NONCOLLECTABLE_SUBSCRIPTION_START_DATE_IN_PAST"
5098
+ }
5099
+ /** @enumType */
5100
+ type PaymentCollectabilityStatusWithLiterals = PaymentCollectabilityStatus | 'UNKNOWN' | 'COLLECTABLE' | 'NONCOLLECTABLE_ORDER_IS_CANCELLED' | 'NONCOLLECTABLE_ORDER_IS_PAID' | 'NONCOLLECTABLE_MISSING_PAYMENT_METHOD' | 'NONCOLLECTABLE_ORDER_IS_PENDING' | 'NONCOLLECTABLE_ORDER_IS_REJECTED' | 'NONCOLLECTABLE_ORDER_HAS_SUBSCRIPTIONS' | 'NONCOLLECTABLE_ORDER_HAS_CHARGEBACKS' | 'NONCOLLECTABLE_SUBSCRIPTION_CYCLE_ALREADY_PASSED' | 'NONCOLLECTABLE_ORDER_HAS_UNSUPPORTED_SUBSCRIPTION' | 'NONCOLLECTABLE_CUSTOM_AMOUNT_NOT_SUPPORTED' | 'NONCOLLECTABLE_SUBSCRIPTION_START_DATE_IN_PAST';
5101
+ interface RecordManuallyCollectedPaymentRequest {
5081
5102
  /**
5082
- * The transaction ID in the membership system. Can be used to void the transaction.
5103
+ * Order ID.
5083
5104
  * @minLength 1
5084
5105
  * @maxLength 100
5085
5106
  */
5086
- externalTransactionId?: string | null;
5107
+ orderId: string;
5108
+ /** Amount to be recorded as approved manual payment for given order */
5109
+ amount: Price;
5110
+ }
5111
+ /**
5112
+ * User-defined payment method name.
5113
+ * Allows specifying either a predefined type or a custom name.
5114
+ */
5115
+ interface UserDefinedPaymentMethodName extends UserDefinedPaymentMethodNameKindOneOf {
5116
+ /** Predefined payment method. */
5117
+ predefined?: PredefinedPaymentMethodWithLiterals;
5087
5118
  /**
5088
- * Whether the membership is voided.
5089
- * @readonly
5090
- * @deprecated Whether the membership is voided.
5091
- * @replacedBy payment.status
5092
- * @targetRemovalDate 2026-11-01
5119
+ * Custom payment method name provided by user.
5120
+ *
5121
+ * For example, `"Wire transfer"`, `"Money order"`, `"Venmo"` or any other custom name.
5122
+ * @minLength 1
5123
+ * @maxLength 150
5093
5124
  */
5094
- voided?: boolean;
5125
+ custom?: string | null;
5126
+ }
5127
+ /** @oneof */
5128
+ interface UserDefinedPaymentMethodNameKindOneOf {
5129
+ /** Predefined payment method. */
5130
+ predefined?: PredefinedPaymentMethodWithLiterals;
5095
5131
  /**
5096
- * ID of the application providing this payment option.
5097
- * @format GUID
5132
+ * Custom payment method name provided by user.
5133
+ *
5134
+ * For example, `"Wire transfer"`, `"Money order"`, `"Venmo"` or any other custom name.
5135
+ * @minLength 1
5136
+ * @maxLength 150
5098
5137
  */
5099
- providerAppId?: string;
5100
- /** Details of a membership that does not yet exist, allowing the payment to be held before the membership is created. */
5101
- futureMembership?: FutureMembershipDetails;
5138
+ custom?: string | null;
5102
5139
  }
5103
- declare enum MembershipPaymentStatus {
5104
- /** Payment was charged. */
5105
- CHARGED = "CHARGED",
5106
- /** The attempt to charge the payment failed, for example, due to lack of credits. */
5107
- CHARGE_FAILED = "CHARGE_FAILED",
5108
- /** Payment is pending. */
5109
- CHARGE_PENDING = "CHARGE_PENDING",
5110
- /** Payment was voided. */
5111
- VOIDED = "VOIDED"
5140
+ /** Predefined payment method types for offline/manual payments. */
5141
+ declare enum PredefinedPaymentMethod {
5142
+ /** Cash payment. */
5143
+ CASH = "CASH",
5144
+ /** Bank transfer. */
5145
+ BANK_TRANSFER = "BANK_TRANSFER",
5146
+ /** Payment by check. */
5147
+ CHECK = "CHECK"
5112
5148
  }
5113
5149
  /** @enumType */
5114
- type MembershipPaymentStatusWithLiterals = MembershipPaymentStatus | 'CHARGED' | 'CHARGE_FAILED' | 'CHARGE_PENDING' | 'VOIDED';
5115
- interface FutureMembershipDetails {
5116
- /**
5117
- * ID of the plan line item in the order from which the membership will be created.
5118
- * @format GUID
5119
- */
5120
- lineItemId?: string;
5121
- /**
5122
- * ID of the benefit the future membership will grant.
5123
- * @maxLength 200
5124
- */
5125
- benefitId?: string;
5150
+ type PredefinedPaymentMethodWithLiterals = PredefinedPaymentMethod | 'CASH' | 'BANK_TRANSFER' | 'CHECK';
5151
+ interface RecordManuallyCollectedPaymentResponse {
5126
5152
  }
5127
- interface WixReceiptInfo {
5153
+ interface MarkOrderAsPaidRequest {
5128
5154
  /**
5129
- * Receipt ID
5130
- * @format GUID
5155
+ * Ecom order ID.
5156
+ * @minLength 1
5157
+ * @maxLength 100
5131
5158
  */
5132
- receiptId?: string;
5159
+ ecomOrderId: string;
5160
+ }
5161
+ interface MarkOrderAsPaidResponse {
5162
+ /** Updated order. */
5163
+ order?: Order;
5164
+ }
5165
+ interface BulkMarkOrdersAsPaidRequest {
5133
5166
  /**
5134
- * Display number of receipt
5167
+ * IDs of orders to mark as paid.
5168
+ * @minSize 1
5169
+ * @maxSize 100
5135
5170
  * @minLength 1
5136
- * @maxLength 40
5171
+ * @maxLength 100
5137
5172
  */
5138
- displayNumber?: string | null;
5173
+ ecomOrderIds: string[];
5139
5174
  }
5140
- interface ExternalReceiptInfo {
5175
+ interface BulkMarkOrdersAsPaidResponse {
5141
5176
  /**
5142
- * External receipt ID
5143
- * @maxLength 100
5177
+ * Items updated by the bulk action.
5178
+ * The Order entity within the results optimistically changes its payment status to paid, however this process is async.
5144
5179
  */
5145
- receiptId?: string | null;
5180
+ results?: BulkOrderResult[];
5181
+ /** Bulk action metadata. */
5182
+ bulkActionMetadata?: BulkActionMetadata;
5183
+ }
5184
+ interface BulkOrderResult {
5185
+ /** Item metadata. */
5186
+ itemMetadata?: ItemMetadata;
5146
5187
  /**
5147
- * ID of the app providing the receipt
5148
- * @format GUID
5188
+ * Updated order.
5189
+ *
5190
+ * Returned when `returnFullEntity = true`.
5149
5191
  */
5150
- appId?: string | null;
5192
+ item?: Order;
5193
+ }
5194
+ interface ItemMetadata {
5195
+ /** Item ID. Should always be available, unless it's impossible (for example, when failing to create an item). */
5196
+ _id?: string | null;
5197
+ /** Index of the item within the request array. Allows for correlation between request and response items. */
5198
+ originalIndex?: number;
5199
+ /** Whether the requested action was successful for this item. When `false`, the `error` field is populated. */
5200
+ success?: boolean;
5201
+ /** Details about the error in case of failure. */
5202
+ error?: ApplicationError;
5203
+ }
5204
+ interface ApplicationError {
5205
+ /** Error code. */
5206
+ code?: string;
5207
+ /** Description of the error. */
5208
+ description?: string;
5209
+ /** Data related to the error. */
5210
+ data?: Record<string, any> | null;
5211
+ }
5212
+ interface BulkActionMetadata {
5213
+ /** Number of items that were successfully processed. */
5214
+ totalSuccesses?: number;
5215
+ /** Number of items that couldn't be processed. */
5216
+ totalFailures?: number;
5217
+ /** Number of failures without details because detailed failure threshold was exceeded. */
5218
+ undetailedFailures?: number;
5219
+ }
5220
+ interface GetRefundabilityStatusRequest {
5151
5221
  /**
5152
- * Display number of receipt
5222
+ * Order ID.
5153
5223
  * @minLength 1
5154
- * @maxLength 40
5224
+ * @maxLength 100
5155
5225
  */
5156
- displayNumber?: string | null;
5226
+ ecomOrderId: string;
5157
5227
  }
5158
- interface CashRoundingDetails {
5228
+ interface GetRefundabilityStatusResponse {
5159
5229
  /**
5160
- * Payment amount before cash rounding was applied.
5161
- * When provided, balance and status calculations use this value instead of `amount`
5162
- * to prevent false overpayment or underpayment due to rounding.
5230
+ * Refundability details.
5231
+ * @maxSize 300
5163
5232
  */
5164
- unroundedAmount?: Price;
5233
+ refundabilities?: Refundability[];
5165
5234
  /**
5166
- * The difference between 'amount' and 'unroundedAmount' (amount minus unroundedAmount).
5167
- * A positive value indicates the price was rounded up; a negative value indicates a round-down.
5168
- * @readonly
5235
+ * Whether the order supports refunding per item.
5236
+ * @deprecated
5169
5237
  */
5170
- roundingAdjustment?: CashRounding;
5238
+ refundablePerItem?: boolean;
5171
5239
  }
5172
- declare enum PaymentStatus {
5173
- /** Payment was charged successfully. */
5174
- APPROVED = "APPROVED",
5175
- /** Payment is being processed and hasn't been confirmed yet. */
5176
- PENDING = "PENDING",
5177
- /** Payment is awaiting confirmation. For an offline payment, the merchant must confirm they received it. For an online payment, the payment provider hasn't confirmed it, which typically means the merchant's provider account setup isn't complete. */
5178
- PENDING_MERCHANT = "PENDING_MERCHANT",
5179
- /** Payment was canceled before it was charged. */
5180
- CANCELED = "CANCELED",
5181
- /** Payment was declined by the payment provider. */
5182
- DECLINED = "DECLINED",
5183
- /** Payment was fully refunded. */
5184
- REFUNDED = "REFUNDED",
5185
- /** Part of the payment amount was refunded. */
5186
- PARTIALLY_REFUNDED = "PARTIALLY_REFUNDED",
5187
- /** Funds are held on the buyer's payment method but haven't been captured. Capture them with [Capture Authorized Payments](https://dev.wix.com/docs/api-reference/business-solutions/e-commerce/orders/order-billing/capture-authorized-payments) or release them with [Void Authorized Payments](https://dev.wix.com/docs/api-reference/business-solutions/e-commerce/orders/order-billing/void-authorized-payments). An authorized payment can't be refunded until it's captured. */
5188
- AUTHORIZED = "AUTHORIZED",
5189
- /**
5190
- * Payment was voided, releasing whatever it held or consumed: an authorization on the buyer's payment method, a gift card balance, or membership credits.
5191
- *
5192
- * Gift card and membership payments don't support partial refunds, so a full refund of one is reported as `VOIDED` rather than `REFUNDED`.
5193
- */
5194
- VOIDED = "VOIDED"
5240
+ interface Refundability extends RefundabilityAdditionalRefundabilityInfoOneOf {
5241
+ /** Reason why payment is not refundable. */
5242
+ nonRefundableReason?: NonRefundableReasonWithLiterals;
5243
+ /** Reason why payment is only refundable manually. */
5244
+ manuallyRefundableReason?: ManuallyRefundableReasonWithLiterals;
5245
+ /** Payment ID. */
5246
+ paymentId?: string;
5247
+ /** Payment refundability status. */
5248
+ refundabilityStatus?: RefundableStatusWithLiterals;
5249
+ /** Link to payment provider dashboard. */
5250
+ providerLink?: string | null;
5195
5251
  }
5196
- /** @enumType */
5197
- type PaymentStatusWithLiterals = PaymentStatus | 'APPROVED' | 'PENDING' | 'PENDING_MERCHANT' | 'CANCELED' | 'DECLINED' | 'REFUNDED' | 'PARTIALLY_REFUNDED' | 'AUTHORIZED' | 'VOIDED';
5198
- interface CanceledStatusDetails {
5199
- reason?: CanceledReasonWithLiterals;
5252
+ /** @oneof */
5253
+ interface RefundabilityAdditionalRefundabilityInfoOneOf {
5254
+ /** Reason why payment is not refundable. */
5255
+ nonRefundableReason?: NonRefundableReasonWithLiterals;
5256
+ /** Reason why payment is only refundable manually. */
5257
+ manuallyRefundableReason?: ManuallyRefundableReasonWithLiterals;
5200
5258
  }
5201
- declare enum CanceledReason {
5202
- /** Other payment with the same chargeCorrelationId failed before current payment started. */
5203
- OTHER_PAYMENT_FAILURE = "OTHER_PAYMENT_FAILURE",
5204
- /** Payment was not completed by user and expired. */
5205
- EXPIRED = "EXPIRED"
5259
+ declare enum RefundableStatus {
5260
+ NOT_REFUNDABLE = "NOT_REFUNDABLE",
5261
+ MANUAL = "MANUAL",
5262
+ REFUNDABLE = "REFUNDABLE"
5206
5263
  }
5207
5264
  /** @enumType */
5208
- type CanceledReasonWithLiterals = CanceledReason | 'OTHER_PAYMENT_FAILURE' | 'EXPIRED';
5209
- interface DeclinedStatusDetails {
5210
- reason?: DeclinedReasonWithLiterals;
5211
- }
5212
- declare enum DeclinedReason {
5213
- /** Corresponding charge failed. */
5214
- CHARGE_FAILED = "CHARGE_FAILED",
5215
- /** Payment details expired. */
5216
- EXPIRED = "EXPIRED",
5217
- /** Insufficient funds. */
5218
- INSUFFICIENT_FUNDS = "INSUFFICIENT_FUNDS",
5219
- /** Gift card was disabled before charge was attempted. */
5220
- GIFT_CARD_DISABLED = "GIFT_CARD_DISABLED"
5265
+ type RefundableStatusWithLiterals = RefundableStatus | 'NOT_REFUNDABLE' | 'MANUAL' | 'REFUNDABLE';
5266
+ declare enum NonRefundableReason {
5267
+ NONE = "NONE",
5268
+ ALREADY_REFUNDED = "ALREADY_REFUNDED",
5269
+ PROVIDER_IS_DOWN = "PROVIDER_IS_DOWN",
5270
+ INTERNAL_ERROR = "INTERNAL_ERROR",
5271
+ NOT_PAID = "NOT_PAID",
5272
+ ACCESS_DENIED = "ACCESS_DENIED",
5273
+ ZERO_PRICE = "ZERO_PRICE",
5274
+ DISABLED_BY_PROVIDER = "DISABLED_BY_PROVIDER",
5275
+ PENDING_REFUND = "PENDING_REFUND",
5276
+ FORBIDDEN = "FORBIDDEN",
5277
+ TRANSACTION_NOT_FOUND = "TRANSACTION_NOT_FOUND",
5278
+ ORDER_IS_PENDING = "ORDER_IS_PENDING",
5279
+ ORDER_IS_REJECTED = "ORDER_IS_REJECTED"
5221
5280
  }
5222
5281
  /** @enumType */
5223
- type DeclinedReasonWithLiterals = DeclinedReason | 'CHARGE_FAILED' | 'EXPIRED' | 'INSUFFICIENT_FUNDS' | 'GIFT_CARD_DISABLED';
5224
- interface VoidedStatusDetails {
5225
- reason?: VoidedReasonWithLiterals;
5226
- }
5227
- declare enum VoidedReason {
5228
- /** Payment was voided by merchant request. */
5229
- MERCHANT_REQUEST = "MERCHANT_REQUEST",
5230
- /** Other payment with the same chargeCorrelationId failed and caused rollback of all payments with same chargeCorrelationId. */
5231
- OTHER_PAYMENT_FAILURE = "OTHER_PAYMENT_FAILURE"
5282
+ type NonRefundableReasonWithLiterals = NonRefundableReason | 'NONE' | 'ALREADY_REFUNDED' | 'PROVIDER_IS_DOWN' | 'INTERNAL_ERROR' | 'NOT_PAID' | 'ACCESS_DENIED' | 'ZERO_PRICE' | 'DISABLED_BY_PROVIDER' | 'PENDING_REFUND' | 'FORBIDDEN' | 'TRANSACTION_NOT_FOUND' | 'ORDER_IS_PENDING' | 'ORDER_IS_REJECTED';
5283
+ declare enum ManuallyRefundableReason {
5284
+ EXPIRED = "EXPIRED",
5285
+ NOT_SUPPORTED = "NOT_SUPPORTED",
5286
+ OFFLINE = "OFFLINE",
5287
+ REQUIRES_CARD_READER = "REQUIRES_CARD_READER"
5232
5288
  }
5233
5289
  /** @enumType */
5234
- type VoidedReasonWithLiterals = VoidedReason | 'MERCHANT_REQUEST' | 'OTHER_PAYMENT_FAILURE';
5235
- interface PaymentStatusDetails extends PaymentStatusDetailsStatusDetailsOneOf {
5236
- }
5237
- /** @oneof */
5238
- interface PaymentStatusDetailsStatusDetailsOneOf {
5290
+ type ManuallyRefundableReasonWithLiterals = ManuallyRefundableReason | 'EXPIRED' | 'NOT_SUPPORTED' | 'OFFLINE' | 'REQUIRES_CARD_READER';
5291
+ interface CreatePaymentGatewayOrderRequest {
5292
+ /**
5293
+ * Ecom order ID.
5294
+ * @minLength 1
5295
+ * @maxLength 100
5296
+ */
5297
+ ecomOrderId: string;
5298
+ /** Information about the user who initiated the payment. */
5299
+ chargedBy?: ChargedBy;
5239
5300
  }
5240
- interface Refund {
5301
+ interface ChargedBy {
5241
5302
  /**
5242
- * Refund ID.
5303
+ * ID - id of the user who initiated the payment
5243
5304
  * @format GUID
5244
- * @readonly
5245
5305
  */
5246
5306
  _id?: string;
5247
5307
  /**
5248
- * List of transactions.
5249
- * @maxSize 50
5308
+ * Full name - name of the user who initiated the payment
5309
+ * @minLength 1
5310
+ * @maxLength 200
5250
5311
  */
5251
- transactions?: RefundTransaction[];
5252
- /** Refund business details. */
5253
- details?: RefundDetails;
5312
+ fullName?: string | null;
5313
+ }
5314
+ interface CreatePaymentGatewayOrderResponse {
5315
+ /** ID of the order created in the payment gateway */
5316
+ paymentGatewayOrderId?: string;
5317
+ }
5318
+ interface ChargeMembershipsRequest {
5254
5319
  /**
5255
- * Date and time the refund was created in [ISO-8601](https://en.wikipedia.org/wiki/ISO_8601#Combined_date_and_time_representations) format. Defaults to current time when not provided.
5256
- * @readonly
5257
- * @immutable
5320
+ * Order ID.
5321
+ * @minLength 1
5322
+ * @maxLength 100
5323
+ */
5324
+ ecomOrderId: string;
5325
+ /**
5326
+ * The member id. Do not attempt to get it from the request context, since in some cases the caller is not a member
5327
+ * but a user which is using the membership on behalf of the a member
5328
+ * @format GUID
5329
+ */
5330
+ memberId: string;
5331
+ /**
5332
+ * List of items to be paid by memberships
5333
+ * @minSize 1
5334
+ * @maxSize 300
5258
5335
  */
5259
- _createdDate?: Date | null;
5336
+ membershipCharges?: MembershipChargeItem[];
5337
+ }
5338
+ interface MembershipChargeItem {
5260
5339
  /**
5261
- * Aggregated refund summary.
5262
- *
5263
- * The refunded amount of this refund is in `summary.refunded`. To get the total refunded across the whole order, use `balanceSummary.refunded` on the order instead.
5264
- * @readonly
5340
+ * The id of used membership
5341
+ * @minLength 1
5342
+ * @maxLength 100
5265
5343
  */
5266
- summary?: AggregatedRefundSummary;
5344
+ membershipId?: string;
5267
5345
  /**
5268
- * ID of the app that initiated this refund.
5346
+ * ID of the application providing this payment option
5269
5347
  * @format GUID
5270
- * @readonly
5271
- * @immutable
5272
5348
  */
5273
- requestingServiceAppId?: string | null;
5274
- }
5275
- interface RefundTransaction {
5349
+ appId?: string;
5350
+ /** The name of used membership */
5351
+ membershipName?: MembershipName;
5352
+ /** Additional data about this membership */
5353
+ membershipAdditionalData?: Record<string, any> | null;
5354
+ /** Catalog and item reference info. */
5355
+ catalogReference?: CatalogReference;
5356
+ /** Properties of the service. When relevant, contains information such as date and number of participants. */
5357
+ serviceProperties?: ServiceProperties;
5276
5358
  /**
5277
- * ID of the payment associated with this refund.
5278
- * @format GUID
5279
- * @immutable
5359
+ * Usually would be the same as catalogReference.catalogItemId
5360
+ * For cases when these are not the same, this field would return the actual id of the item in the catalog
5361
+ * For example, for Wix bookings, catalogReference.catalogItemId is the booking id, and this value is being set to be the service id
5362
+ * @minLength 1
5363
+ * @maxLength 36
5280
5364
  */
5281
- paymentId?: string;
5365
+ rootCatalogItemId?: string | null;
5282
5366
  /**
5283
- * Refund amount.
5284
- * @immutable
5367
+ * line item id of Checkout/Order line item
5368
+ * @minLength 1
5369
+ * @maxLength 100
5285
5370
  */
5286
- amount?: Price;
5287
- /** Refund status. */
5288
- refundStatus?: RefundStatusWithLiterals;
5289
- /** Optional details of current refund status. */
5290
- refundStatusInfo?: RefundStatusInfo;
5371
+ lineItemId?: string;
5372
+ }
5373
+ interface MembershipName {
5291
5374
  /**
5292
- * Payment gateway's refund ID.
5293
- * This field is only returned when the value of `external_refund` is `false`.
5294
- * @format GUID
5375
+ * Membership name in the site's original language.
5376
+ * @maxLength 100
5295
5377
  */
5296
- gatewayRefundId?: string | null;
5297
- /** ID of the refund in the payment provider's system. For example, at PayPal, Square, Stripe, etc. Not returned for external refunds. */
5298
- providerRefundId?: string | null;
5378
+ original?: string;
5299
5379
  /**
5300
- * Whether refund was made externally and manually on the payment provider's side.
5301
- * @immutable
5380
+ * Membership name translated into the buyer's language.
5381
+ *
5382
+ * Default: The value of `original`
5383
+ * @maxLength 100
5302
5384
  */
5303
- externalRefund?: boolean;
5385
+ translated?: string | null;
5304
5386
  }
5305
- /** Refund transaction status. */
5306
- declare enum RefundStatus {
5307
- /** Refund was initiated on payment provider side. PENDING status was assigned by provider. */
5308
- PENDING = "PENDING",
5309
- /** Refund transaction succeeded. */
5310
- SUCCEEDED = "SUCCEEDED",
5311
- /** Refund transaction failed. */
5312
- FAILED = "FAILED",
5313
- /** Refund request acknowledged, and will be executed soon. */
5314
- SCHEDULED = "SCHEDULED",
5315
- /** Refund was initiated on payment provider side. */
5316
- STARTED = "STARTED"
5387
+ interface ChargeMembershipsResponse {
5317
5388
  }
5318
- /** @enumType */
5319
- type RefundStatusWithLiterals = RefundStatus | 'PENDING' | 'SUCCEEDED' | 'FAILED' | 'SCHEDULED' | 'STARTED';
5320
- interface RefundStatusInfo {
5389
+ interface TriggerRefundRequest {
5321
5390
  /**
5322
- * Reason code for the refund's current status.
5323
- *
5324
- * Learn more about [reason codes](https://dev.wix.com/docs/rest/business-management/payments/service-plugins/payment-service-provider-service-plugin/reason-codes).
5391
+ * The order this refund related to
5325
5392
  * @minLength 1
5326
- * @maxLength 10
5393
+ * @maxLength 100
5327
5394
  */
5328
- paymentGatewayReasonCode?: string | null;
5395
+ ecomOrderId: string;
5329
5396
  /**
5330
- * Free text explanation of current refund status.
5331
- * @minLength 1
5332
- * @maxLength 1000
5397
+ * Refund operations information
5398
+ * @minSize 1
5399
+ * @maxSize 1
5333
5400
  */
5334
- description?: string | null;
5335
- }
5336
- interface AggregatedRefundSummary {
5337
- /** Total amount requested for refund. */
5338
- requestedRefund?: Price;
5339
- /** Pending refund amount - the portion of `requestedRefund` that is still pending. */
5340
- pendingRefund?: Price;
5341
- /** Refunded amount - the portion of `requestedRefund` that refunded successfully. */
5342
- refunded?: Price;
5343
- /** Failed refund amount - the portion of `requestedRefund` that failed. */
5344
- failedRefundAmount?: Price;
5345
- /** Whether at least one refund transaction is still in `"PENDING"` status. */
5346
- pending?: boolean;
5347
- /** Breakdown of refunded items. Available only after refund is complete. */
5348
- breakdown?: RefundItemsBreakdown;
5401
+ payments: PaymentRefund[];
5402
+ /** Business model of a refund */
5403
+ details?: RefundDetails;
5404
+ /** Side effect details related to refund */
5405
+ sideEffects?: RefundSideEffects;
5349
5406
  }
5350
- interface RefundItemsBreakdown {
5407
+ interface PaymentRefund {
5351
5408
  /**
5352
- * Refunded line items and the amount refunded for each.
5353
- * @maxSize 300
5409
+ * Specific payment within the order to refund
5410
+ * @format GUID
5354
5411
  */
5355
- lineItems?: LineItemRefundSummary[];
5356
- }
5357
- interface LineItemRefundSummary {
5412
+ paymentId?: string;
5413
+ /** Refund amount. Not relevant for membership and gift card refunds. */
5414
+ amount?: Price;
5358
5415
  /**
5359
- * ID of the refunded line item.
5360
- * @format GUID
5416
+ * Whether refund is made externally and manually (on the payment provider's side)
5417
+ * When false (default), the payment gateway will be called in order to make an actual refund, and then the payment will be marked as refunded.
5418
+ * When true, the payment will only be *marked* as refunded, and no actual refund will be performed.
5361
5419
  */
5362
- lineItemId?: string;
5363
- /** Total refunded amount for the line item. */
5364
- totalRefundedAmount?: Price;
5420
+ externalRefund?: boolean;
5365
5421
  }
5366
- interface CalculateRefundRequest {
5422
+ interface RefundSideEffects {
5423
+ /** Inventory restock details as part of this refund. */
5424
+ restockInfo?: RestockInfo;
5425
+ /** Whether to send a refund confirmation email to the customer. */
5426
+ sendOrderRefundedEmail?: boolean;
5367
5427
  /**
5368
- * Order ID
5428
+ * Custom message added to the refund confirmation email.
5369
5429
  * @minLength 1
5370
- * @maxLength 100
5430
+ * @maxLength 1000
5371
5431
  */
5372
- ecomOrderId?: string;
5432
+ customMessage?: string | null;
5433
+ }
5434
+ interface RestockInfo {
5435
+ /** Restock type. */
5436
+ type?: RestockTypeWithLiterals;
5373
5437
  /**
5374
- * Refunded line items and quantity
5438
+ * Restocked line items and quantities. Only relevant for `{"type": "SOME_ITEMS"}`.
5375
5439
  * @maxSize 300
5376
5440
  */
5377
- refundItems?: CalculateRefundItemRequest[];
5378
- /** Should include shipping in refund calculation */
5379
- refundShipping?: boolean;
5441
+ items?: RestockItem[];
5380
5442
  }
5381
- interface CalculateRefundItemRequest {
5443
+ declare enum RestockType {
5444
+ NO_ITEMS = "NO_ITEMS",
5445
+ ALL_ITEMS = "ALL_ITEMS",
5446
+ SOME_ITEMS = "SOME_ITEMS"
5447
+ }
5448
+ /** @enumType */
5449
+ type RestockTypeWithLiterals = RestockType | 'NO_ITEMS' | 'ALL_ITEMS' | 'SOME_ITEMS';
5450
+ interface RestockItem {
5382
5451
  /**
5383
- * ID of the line item being refunded
5452
+ * ID of the line item being restocked.
5384
5453
  * @format GUID
5385
5454
  */
5386
- _id?: string;
5455
+ lineItemId?: string;
5387
5456
  /**
5388
- * How much of that line item is being refunded
5457
+ * Line item quantity being restocked.
5389
5458
  * @min 1
5390
5459
  * @max 100000
5391
5460
  */
5392
5461
  quantity?: number;
5393
5462
  }
5394
- interface CalculateRefundResponse {
5395
- /** Total refundable amount */
5396
- total?: Price;
5397
- /** Tax cost of the order */
5398
- tax?: Price;
5399
- /** Discount given for this order */
5400
- discount?: Price;
5401
- /** Total cost of the order (without tax) */
5402
- subtotal?: Price;
5403
- /** Total shipping cost for order */
5404
- shipping?: Price;
5405
- /** Previous refund given on that order */
5406
- previouslyRefundedAmount?: Price;
5407
- /**
5408
- * The refundable items of that order
5409
- * @maxSize 300
5410
- */
5411
- items?: CalculateRefundItemResponse[];
5463
+ interface TriggerRefundResponse {
5464
+ /** All order's transactions after the refunds were added */
5465
+ orderTransactions?: OrderTransactions;
5466
+ /** Created refund ID */
5467
+ refundId?: string | null;
5468
+ /** Payment ID's that the refund execution had failed for */
5469
+ failedPaymentIds?: ItemMetadata[];
5412
5470
  }
5413
- interface CalculateRefundItemResponse {
5471
+ /**
5472
+ * A record of all payments and refunds associated with an order.
5473
+ *
5474
+ * Use order transactions to track payment status, add payment records, process refunds, and monitor chargebacks.
5475
+ */
5476
+ interface OrderTransactions {
5414
5477
  /**
5415
- * Line item ID
5478
+ * Order ID.
5416
5479
  * @format GUID
5417
5480
  */
5418
- _id?: string;
5419
- /** Refundable amount for requested quantity of items (price of requested quantity of items without tax and discount) */
5420
- price?: Price;
5421
- }
5422
- interface VoidAuthorizedPaymentsRequest {
5481
+ orderId?: string;
5423
5482
  /**
5424
- * Wix eCommerce order ID
5425
- * @minLength 1
5426
- * @maxLength 100
5483
+ * Record of payments made to the merchant.
5484
+ * @maxSize 100
5427
5485
  */
5428
- ecomOrderId: string;
5486
+ payments?: Payment[];
5429
5487
  /**
5430
- * Payment IDs
5431
- * @minSize 1
5432
- * @maxSize 100
5433
- * @format GUID
5488
+ * Record of refunds made to the buyer.
5489
+ * @maxSize 300
5434
5490
  */
5435
- paymentIds: string[];
5436
- }
5437
- interface VoidAuthorizedPaymentsResponse {
5438
- /** All order's transactions after the void was triggered */
5439
- orderTransactions?: OrderTransactions;
5491
+ refunds?: Refund[];
5440
5492
  }
5441
- interface CaptureAuthorizedPaymentsRequest {
5493
+ interface Payment extends PaymentPaymentDetailsOneOf, PaymentReceiptInfoOneOf, PaymentStatusDetailsOneOf {
5494
+ /** Regular payment details. */
5495
+ regularPaymentDetails?: RegularPaymentDetails;
5496
+ /** Gift card payment details. */
5497
+ giftcardPaymentDetails?: GiftCardPaymentDetails;
5498
+ /** Membership payment details. */
5499
+ membershipPaymentDetails?: MembershipPaymentDetails;
5442
5500
  /**
5443
- * Wix eCommerce order ID
5444
- * @minLength 1
5445
- * @maxLength 100
5501
+ * Payment ID.
5502
+ * @format GUID
5503
+ * @readonly
5504
+ */
5505
+ _id?: string | null;
5506
+ /** Date and time the payment was created in [ISO-8601](https://en.wikipedia.org/wiki/ISO_8601#Combined_date_and_time_representations) format. Defaults to current time when not provided. */
5507
+ _createdDate?: Date | null;
5508
+ /**
5509
+ * Date and time the payment was last updated in [ISO-8601](https://en.wikipedia.org/wiki/ISO_8601#Combined_date_and_time_representations) format.
5510
+ * @readonly
5446
5511
  */
5447
- ecomOrderId: string;
5512
+ _updatedDate?: Date | null;
5513
+ /** Payment amount. */
5514
+ amount?: Price;
5448
5515
  /**
5449
- * Capture payments information
5450
- * @minSize 1
5451
- * @maxSize 100
5516
+ * Whether refunds for this payment are disabled.
5517
+ * + `true`: This payment is not refundable.
5518
+ * + `false`: This payment may be refunded. However, this ultimately depends on the payment provider.
5452
5519
  */
5453
- payments: PaymentCapture[];
5454
- }
5455
- interface PaymentCapture {
5520
+ refundDisabled?: boolean;
5456
5521
  /**
5457
- * Payment ID
5458
- * @format GUID
5522
+ * Whether receipt generation is allowed for this payment.
5523
+ * + `true`: This payment supports receipt generation.
5524
+ * + `false`: This payment doesn't support receipt generation, or a receipt was already generated.
5525
+ * @readonly
5459
5526
  */
5460
- paymentId?: string | null;
5527
+ supportReceiptGeneration?: boolean;
5528
+ /** Details about cash rounding applied to this payment, when relevant. */
5529
+ cashRounding?: CashRoundingDetails;
5461
5530
  /**
5462
- * Capture amount.
5463
- * If not provided - full authorized amount will be captured.
5531
+ * Overall payment status.
5532
+ *
5533
+ * Gift card and membership payments support only `APPROVED`, `PENDING`, `CANCELED`, `DECLINED`, and `VOIDED`. The remaining values apply to regular payments.
5464
5534
  */
5465
- amount?: Price;
5466
- }
5467
- interface CaptureAuthorizedPaymentsResponse {
5468
- /** All order's transactions after the capture was triggered */
5469
- orderTransactions?: OrderTransactions;
5470
- }
5471
- interface ChargeSavedPaymentMethodRequest {
5535
+ status?: PaymentStatusWithLiterals;
5472
5536
  /**
5473
- * Ecom Order ID.
5474
- * @minLength 1
5475
- * @maxLength 100
5537
+ * ID linking this payment to the charge request that created it. Matches the `idempotencyKey` sent in the Charge Order request.
5538
+ * @format GUID
5476
5539
  */
5477
- ecomOrderId?: string;
5478
- /** Amount to be charged */
5479
- amount?: Price;
5540
+ chargeCorrelationId?: string | null;
5480
5541
  }
5481
- interface ChargeSavedPaymentMethodResponse {
5482
- /** Payment gateway's order ID (e.g Wix Payments) */
5483
- paymentGatewayOrderId?: string;
5542
+ /** @oneof */
5543
+ interface PaymentPaymentDetailsOneOf {
5544
+ /** Regular payment details. */
5545
+ regularPaymentDetails?: RegularPaymentDetails;
5546
+ /** Gift card payment details. */
5547
+ giftcardPaymentDetails?: GiftCardPaymentDetails;
5548
+ /** Membership payment details. */
5549
+ membershipPaymentDetails?: MembershipPaymentDetails;
5484
5550
  }
5485
- interface SendBuyerConfirmationEmailRequest {
5486
- /** @format GUID */
5487
- orderId?: string;
5551
+ /** @oneof */
5552
+ interface PaymentReceiptInfoOneOf {
5488
5553
  }
5489
- interface SendBuyerConfirmationEmailResponse {
5554
+ /** @oneof */
5555
+ interface PaymentStatusDetailsOneOf {
5490
5556
  }
5491
- interface SendBuyerPaymentsReceivedEmailRequest {
5557
+ interface RegularPaymentDetails extends RegularPaymentDetailsPaymentMethodDetailsOneOf {
5558
+ /** Credit card details. */
5559
+ creditCardDetails?: CreditCardPaymentMethodDetails;
5492
5560
  /**
5493
- * @minLength 1
5561
+ * Wix Payments order ID.
5494
5562
  * @maxLength 100
5495
5563
  */
5496
- orderId?: string;
5497
- }
5498
- interface SendBuyerPaymentsReceivedEmailResponse {
5499
- }
5500
- interface SendBuyerPickupConfirmationEmailRequest {
5564
+ paymentOrderId?: string | null;
5501
5565
  /**
5502
- * @minLength 1
5566
+ * Payment gateway's transaction ID.
5567
+ * This field is only returned when the value of `offline_payment` is `false`.
5503
5568
  * @maxLength 100
5504
5569
  */
5505
- orderId?: string;
5506
- }
5507
- interface SendBuyerPickupConfirmationEmailResponse {
5508
- }
5509
- interface BulkSendBuyerPickupConfirmationEmailsRequest {
5570
+ gatewayTransactionId?: string | null;
5510
5571
  /**
5511
- * IDs of orders to send pickup emails for.
5512
- * @minSize 1
5513
- * @maxSize 300
5572
+ * Payment method.
5573
+ * Deprecated. Use `paymentMethodName.buyerLanguageName` instead.
5574
+ * Non-exhaustive list of supported values:
5575
+ * + `CreditCard`, `Alipay`, `AstropayCash`, `AstropayDBT`, `AstropayMBT`, `Bitcoin`, `BitPay`, `Cash`, `ConvenienceStore`, `EPay`, `Fake`, `Giropay`, `IDeal`, `InPerson`, `Klarna`, `MercadoPago`, `Netpay`, `NordeaSolo`, `Offline`, `PagSeguro`, `PayEasy`, `PayPal`, `Paysafecard`, `Paysafecash`, `PointOfSale`, `Poli`, `Privat24`, `Przelewy24`, `RapidTransfer`, `Sepa`, `Skrill`, `Sofort`, `Trustly`, `Neteller`, `Unionpay`, `UniPay`, `Yandex`
5576
+ * @maxLength 150
5577
+ * @deprecated Payment method.
5578
+ * Deprecated. Use `paymentMethodName.buyerLanguageName` instead.
5579
+ * Non-exhaustive list of supported values:
5580
+ * + `CreditCard`, `Alipay`, `AstropayCash`, `AstropayDBT`, `AstropayMBT`, `Bitcoin`, `BitPay`, `Cash`, `ConvenienceStore`, `EPay`, `Fake`, `Giropay`, `IDeal`, `InPerson`, `Klarna`, `MercadoPago`, `Netpay`, `NordeaSolo`, `Offline`, `PagSeguro`, `PayEasy`, `PayPal`, `Paysafecard`, `Paysafecash`, `PointOfSale`, `Poli`, `Privat24`, `Przelewy24`, `RapidTransfer`, `Sepa`, `Skrill`, `Sofort`, `Trustly`, `Neteller`, `Unionpay`, `UniPay`, `Yandex`
5581
+ * @replacedBy payment_method_name
5582
+ * @targetRemovalDate 2026-07-01
5514
5583
  */
5515
- orderIds?: string[];
5516
- }
5517
- interface BulkSendBuyerPickupConfirmationEmailsResponse {
5518
- }
5519
- interface SendBuyerShippingConfirmationEmailRequest {
5584
+ paymentMethod?: string | null;
5520
5585
  /**
5521
- * @minLength 1
5586
+ * Transaction ID in the payment provider's system. For example, at PayPal, Square, Stripe, etc. Not returned for offline payments.
5522
5587
  * @maxLength 100
5523
5588
  */
5524
- orderId?: string;
5525
- }
5526
- interface SendBuyerShippingConfirmationEmailResponse {
5527
- }
5528
- interface BulkSendBuyerShippingConfirmationEmailsRequest {
5589
+ providerTransactionId?: string | null;
5590
+ /** Whether the payment was made offline. For example, when using cash or when marked as paid in the Business Manager. */
5591
+ offlinePayment?: boolean;
5529
5592
  /**
5530
- * IDs of orders to send pickup emails for.
5531
- * @minSize 1
5532
- * @maxSize 300
5593
+ * Payment status.
5594
+ * @deprecated Payment status.
5595
+ * @replacedBy payment.status
5596
+ * @targetRemovalDate 2026-11-01
5533
5597
  */
5534
- orderIds?: string[];
5598
+ status?: TransactionStatusWithLiterals;
5599
+ /** Whether there is a payment agreement that allows for future charges. */
5600
+ savedPaymentMethod?: boolean;
5601
+ /** Authorization details. */
5602
+ authorizationDetails?: AuthorizationDetails;
5603
+ /**
5604
+ * Record of chargebacks made by the buyer.
5605
+ * @maxSize 6
5606
+ */
5607
+ chargebacks?: Chargeback[];
5608
+ /** Platform fee amount associated with this payment. */
5609
+ platformFee?: Price;
5610
+ /**
5611
+ * Payment method with buyer and optional owner translations.
5612
+ * Non-exhaustive list of supported values:
5613
+ * + `CreditCard`, `Alipay`, `AstropayCash`, `AstropayDBT`, `AstropayMBT`, `Bitcoin`, `BitPay`, `Cash`, `ConvenienceStore`, `EPay`, `Fake`, `Giropay`, `IDeal`, `InPerson`, `Klarna`, `MercadoPago`, `Netpay`, `NordeaSolo`, `Offline`, `PagSeguro`, `PayEasy`, `PayPal`, `Paysafecard`, `Paysafecash`, `PointOfSale`, `Poli`, `Privat24`, `Przelewy24`, `RapidTransfer`, `Sepa`, `Skrill`, `Sofort`, `Trustly`, `Neteller`, `Unionpay`, `UniPay`, `Yandex`
5614
+ */
5615
+ paymentMethodName?: PaymentMethodName;
5535
5616
  }
5536
- interface BulkSendBuyerShippingConfirmationEmailsResponse {
5617
+ /** @oneof */
5618
+ interface RegularPaymentDetailsPaymentMethodDetailsOneOf {
5619
+ /** Credit card details. */
5620
+ creditCardDetails?: CreditCardPaymentMethodDetails;
5537
5621
  }
5538
- interface SendMerchantOrderReceivedNotificationRequest {
5622
+ declare enum TransactionStatus {
5623
+ UNDEFINED = "UNDEFINED",
5624
+ APPROVED = "APPROVED",
5625
+ PENDING = "PENDING",
5626
+ PENDING_MERCHANT = "PENDING_MERCHANT",
5627
+ CANCELED = "CANCELED",
5628
+ DECLINED = "DECLINED",
5629
+ REFUNDED = "REFUNDED",
5630
+ PARTIALLY_REFUNDED = "PARTIALLY_REFUNDED",
5631
+ AUTHORIZED = "AUTHORIZED",
5632
+ VOIDED = "VOIDED"
5633
+ }
5634
+ /** @enumType */
5635
+ type TransactionStatusWithLiterals = TransactionStatus | 'UNDEFINED' | 'APPROVED' | 'PENDING' | 'PENDING_MERCHANT' | 'CANCELED' | 'DECLINED' | 'REFUNDED' | 'PARTIALLY_REFUNDED' | 'AUTHORIZED' | 'VOIDED';
5636
+ interface CreditCardPaymentMethodDetails {
5539
5637
  /**
5540
- * @minLength 1
5638
+ * The last 4 digits of the card number.
5639
+ * @maxLength 4
5640
+ */
5641
+ lastFourDigits?: string | null;
5642
+ /**
5643
+ * Card issuer's brand.
5541
5644
  * @maxLength 100
5542
5645
  */
5543
- orderId?: string;
5544
- }
5545
- interface SendMerchantOrderReceivedNotificationResponse {
5646
+ brand?: string | null;
5546
5647
  }
5547
- interface SendCancelRefundEmailRequest {
5648
+ interface AuthorizationDetails {
5548
5649
  /**
5549
- * The ID of order that is canceled/refunded
5550
- * @minLength 1
5551
- * @maxLength 100
5650
+ * Whether the authorized payment is of a delayed capture.
5651
+ * @readonly
5552
5652
  */
5553
- orderId?: string;
5653
+ delayedCapture?: boolean;
5654
+ /** Date and time the payment was authorized in [ISO-8601](https://en.wikipedia.org/wiki/ISO_8601#Combined_date_and_time_representations) format. */
5655
+ authorizedDate?: Date | null;
5554
5656
  /**
5555
- * Personal note added to the email (optional)
5556
- * @minLength 1
5557
- * @maxLength 1000
5657
+ * List of captures associated with payment
5658
+ * In case of failed it can be replaced with new one with PENDING or SUCCESS statuses
5659
+ * @maxSize 1
5558
5660
  */
5559
- customMessage?: string | null;
5560
- /** Refund amount */
5561
- refundAmount?: Price;
5661
+ captures?: AuthorizationCapture[];
5662
+ /** Void associated with payment */
5663
+ void?: AuthorizationVoid;
5664
+ /** Scheduled action for this transaction */
5665
+ scheduledAction?: V1ScheduledAction;
5666
+ }
5667
+ interface AuthorizationCapture {
5562
5668
  /**
5563
- * Refund ID. (Optional)
5669
+ * Capture ID.
5564
5670
  * @format GUID
5671
+ * @readonly
5565
5672
  */
5566
- refundId?: string | null;
5673
+ _id?: string | null;
5674
+ /** Status of this capture action */
5675
+ status?: AuthorizationCaptureStatusWithLiterals;
5676
+ /**
5677
+ * Amount of this capture
5678
+ * @immutable
5679
+ */
5680
+ amount?: Price;
5681
+ /** Date and time the capture was initiated in [ISO-8601](https://en.wikipedia.org/wiki/ISO_8601#Combined_date_and_time_representations) format. */
5682
+ _createdDate?: Date | null;
5683
+ /** In case of status is FAILED may contain failure details */
5684
+ failureDetails?: AuthorizationActionFailureDetails;
5685
+ }
5686
+ declare enum AuthorizationCaptureStatus {
5687
+ /** Capture operation still in progress. */
5688
+ PENDING = "PENDING",
5689
+ /** Capture operation succeeded. */
5690
+ SUCCEEDED = "SUCCEEDED",
5691
+ /** Capture operation failed. */
5692
+ FAILED = "FAILED"
5693
+ }
5694
+ /** @enumType */
5695
+ type AuthorizationCaptureStatusWithLiterals = AuthorizationCaptureStatus | 'PENDING' | 'SUCCEEDED' | 'FAILED';
5696
+ interface AuthorizationActionFailureDetails {
5697
+ /** @maxLength 100 */
5698
+ failureCode?: string;
5699
+ }
5700
+ interface AuthorizationVoid {
5701
+ /** Status of this void action */
5702
+ status?: AuthorizationVoidStatusWithLiterals;
5703
+ /** Date and time the void was initiated in [ISO-8601](https://en.wikipedia.org/wiki/ISO_8601#Combined_date_and_time_representations) format. */
5704
+ voidedDate?: Date | null;
5705
+ /** In case of status is FAILED may contain failure details */
5706
+ failureDetails?: AuthorizationActionFailureDetails;
5707
+ /** Reason of void action */
5708
+ reason?: ReasonWithLiterals;
5709
+ }
5710
+ declare enum AuthorizationVoidStatus {
5711
+ /** Void operation still in progress. */
5712
+ PENDING = "PENDING",
5713
+ /** Void operation succeeded. */
5714
+ SUCCEEDED = "SUCCEEDED",
5715
+ /** Void operation failed. */
5716
+ FAILED = "FAILED"
5717
+ }
5718
+ /** @enumType */
5719
+ type AuthorizationVoidStatusWithLiterals = AuthorizationVoidStatus | 'PENDING' | 'SUCCEEDED' | 'FAILED';
5720
+ /** Reason the authorization was voided. */
5721
+ declare enum Reason {
5722
+ /** Authorization was voided by user. */
5723
+ MANUAL = "MANUAL",
5724
+ /** Authorization passed execution date. */
5725
+ SCHEDULED = "SCHEDULED"
5567
5726
  }
5568
- interface SendCancelRefundEmailResponse {
5727
+ /** @enumType */
5728
+ type ReasonWithLiterals = Reason | 'MANUAL' | 'SCHEDULED';
5729
+ interface V1ScheduledAction {
5730
+ /** Type of the action. */
5731
+ actionType?: ActionTypeWithLiterals;
5732
+ /** The date and time of the action. */
5733
+ executionDate?: Date | null;
5569
5734
  }
5570
- interface SendRefundEmailRequest {
5735
+ declare enum ActionType {
5736
+ VOID = "VOID",
5737
+ CAPTURE = "CAPTURE"
5738
+ }
5739
+ /** @enumType */
5740
+ type ActionTypeWithLiterals = ActionType | 'VOID' | 'CAPTURE';
5741
+ interface Chargeback {
5571
5742
  /**
5572
- * The ID of order that is refunded
5743
+ * Chargeback ID.
5573
5744
  * @format GUID
5745
+ * @readonly
5746
+ * @immutable
5574
5747
  */
5575
- orderId?: string;
5748
+ _id?: string;
5576
5749
  /**
5577
- * Refund ID
5578
- * @format GUID
5750
+ * Date and time the chargeback was created in [ISO-8601](https://en.wikipedia.org/wiki/ISO_8601#Combined_date_and_time_representations) format. Defaults to current time when not provided.
5751
+ * @readonly
5752
+ * @immutable
5579
5753
  */
5580
- refundId?: string;
5754
+ _createdDate?: Date | null;
5581
5755
  /**
5582
- * Personal note added to the email (optional)
5583
- * @minLength 1
5584
- * @maxLength 1000
5756
+ * Date and time the chargeback was updated in [ISO-8601](https://en.wikipedia.org/wiki/ISO_8601#Combined_date_and_time_representations) format. Defaults to current time when not provided.
5757
+ * @readonly
5585
5758
  */
5586
- customMessage?: string | null;
5587
- }
5588
- interface SendRefundEmailResponse {
5589
- }
5590
- interface SendFulfillmentEmailRequest {
5591
- /** @format GUID */
5592
- orderId?: string;
5593
- /** @format GUID */
5594
- fulfillerId?: string;
5595
- }
5596
- interface SendFulfillmentEmailResponse {
5597
- }
5598
- interface SendMerchantOrderReceivedPushRequest {
5759
+ _updatedDate?: Date | null;
5599
5760
  /**
5600
- * @minLength 1
5601
- * @maxLength 100
5761
+ * Amount.
5762
+ * @readonly
5763
+ * @immutable
5602
5764
  */
5603
- orderId?: string;
5604
- }
5605
- interface SendMerchantOrderReceivedPushResponse {
5606
- }
5607
- interface PreviewEmailByTypeRequest {
5608
- emailType?: PreviewEmailTypeWithLiterals;
5609
- }
5610
- declare enum PreviewEmailType {
5611
- ORDER_PLACED = "ORDER_PLACED",
5612
- DOWNLOAD_LINKS = "DOWNLOAD_LINKS",
5613
- ORDER_SHIPPED = "ORDER_SHIPPED",
5614
- ORDER_READY_FOR_PICKUP = "ORDER_READY_FOR_PICKUP"
5615
- }
5616
- /** @enumType */
5617
- type PreviewEmailTypeWithLiterals = PreviewEmailType | 'ORDER_PLACED' | 'DOWNLOAD_LINKS' | 'ORDER_SHIPPED' | 'ORDER_READY_FOR_PICKUP';
5618
- interface PreviewEmailByTypeResponse {
5619
- emailPreview?: string;
5620
- }
5621
- interface PreviewRefundEmailRequest {
5765
+ amount?: Price;
5622
5766
  /**
5623
- * @minLength 1
5624
- * @maxLength 100
5767
+ * Reversal amount. Present only when status is REVERSED.
5768
+ * @readonly
5625
5769
  */
5626
- orderId?: string;
5627
- /** Refund amount */
5628
- refundAmount?: Price;
5629
- /** Refund business details */
5630
- details?: RefundDetails;
5770
+ reversalAmount?: Price;
5631
5771
  /**
5632
- * Personal note added to the email (optional)
5633
- * @minLength 1
5634
- * @maxLength 1000
5772
+ * Status.
5773
+ *
5774
+ * Default: `"APPROVED"`.
5635
5775
  */
5636
- customMessage?: string | null;
5776
+ status?: ChargebackStatusWithLiterals;
5637
5777
  /**
5638
- * Refund ID. (Optional)
5778
+ * External chargeback ID.
5639
5779
  * @format GUID
5780
+ * @readonly
5781
+ * @immutable
5640
5782
  */
5641
- refundId?: string | null;
5783
+ externalId?: string | null;
5642
5784
  }
5643
- interface PreviewRefundEmailResponse {
5644
- emailPreview?: string;
5785
+ declare enum ChargebackStatus {
5786
+ /** Chargeback was approved. */
5787
+ APPROVED = "APPROVED",
5788
+ /** Chargeback was reversed. */
5789
+ REVERSED = "REVERSED"
5645
5790
  }
5646
- interface PreviewCancelEmailRequest {
5791
+ /** @enumType */
5792
+ type ChargebackStatusWithLiterals = ChargebackStatus | 'APPROVED' | 'REVERSED';
5793
+ interface PaymentMethodName {
5647
5794
  /**
5648
- * @minLength 1
5649
- * @maxLength 100
5795
+ * Payment method name in the buyer's language. For example, `"Credit/Debit Cards"`.
5796
+ * @maxLength 150
5650
5797
  */
5651
- orderId?: string;
5798
+ buyerLanguageName?: string | null;
5652
5799
  /**
5653
- * Personal note added to the email (optional)
5654
- * @minLength 1
5655
- * @maxLength 1000
5800
+ * Payment method name in the site's language. For example, `"Credit/Debit Cards"`.
5801
+ *
5802
+ * When no site-language name is stored, holds the same value as `buyerLanguageName`.
5803
+ * @maxLength 150
5656
5804
  */
5657
- customMessage?: string | null;
5658
- }
5659
- interface PreviewCancelEmailResponse {
5660
- emailPreview?: string;
5805
+ siteLanguageName?: string | null;
5806
+ /**
5807
+ * User-provided payment method name.
5808
+ *
5809
+ * When set, takes precedence over `buyerLanguageName` and `siteLanguageName`.
5810
+ */
5811
+ userDefinedName?: UserDefinedPaymentMethodName;
5661
5812
  }
5662
- interface PreviewCancelRefundEmailRequest {
5813
+ interface GiftCardPaymentDetails {
5663
5814
  /**
5664
- * @minLength 1
5815
+ * Gift card payment ID.
5665
5816
  * @maxLength 100
5666
5817
  */
5667
- orderId?: string;
5818
+ giftCardPaymentId?: string;
5668
5819
  /**
5669
- * Personal note added to the email (optional)
5670
- * @minLength 1
5671
- * @maxLength 1000
5820
+ * ID of the app that created the gift card.
5821
+ * @format GUID
5672
5822
  */
5673
- customMessage?: string | null;
5674
- /** Refund amount */
5675
- refundAmount?: Price;
5823
+ appId?: string;
5676
5824
  /**
5677
- * Refund ID. (Optional)
5678
- * @format GUID
5825
+ * Whether the gift card is voided.
5826
+ * @readonly
5827
+ * @deprecated Whether the gift card is voided.
5828
+ * @replacedBy payment.status
5829
+ * @targetRemovalDate 2026-11-01
5679
5830
  */
5680
- refundId?: string | null;
5681
- }
5682
- interface PreviewCancelRefundEmailResponse {
5683
- emailPreview?: string;
5684
- }
5685
- interface PreviewBuyerPaymentsReceivedEmailRequest {
5686
- }
5687
- interface PreviewBuyerPaymentsReceivedEmailResponse {
5688
- emailPreview?: string;
5689
- }
5690
- interface PreviewBuyerConfirmationEmailRequest {
5691
- }
5692
- interface PreviewBuyerConfirmationEmailResponse {
5693
- emailPreview?: string;
5694
- }
5695
- interface PreviewBuyerPickupConfirmationEmailRequest {
5696
- }
5697
- interface PreviewBuyerPickupConfirmationEmailResponse {
5698
- emailPreview?: string;
5699
- }
5700
- interface PreviewShippingConfirmationEmailRequest {
5701
- }
5702
- interface PreviewShippingConfirmationEmailResponse {
5703
- emailPreview?: string;
5704
- }
5705
- interface PreviewResendDownloadLinksEmailRequest {
5706
- }
5707
- interface PreviewResendDownloadLinksEmailResponse {
5708
- emailPreview?: string;
5709
- }
5710
- interface MetaSiteSpecialEvent extends MetaSiteSpecialEventPayloadOneOf {
5711
- /** Emitted on a meta site creation. */
5712
- siteCreated?: SiteCreated;
5713
- /** Emitted on a meta site transfer completion. */
5714
- siteTransferred?: SiteTransferred;
5715
- /** Emitted on a meta site deletion. */
5716
- siteDeleted?: SiteDeleted;
5717
- /** Emitted on a meta site restoration. */
5718
- siteUndeleted?: SiteUndeleted;
5719
- /** Emitted on the first* publish of the meta site (* switching from unpublished to published state). */
5720
- sitePublished?: SitePublished;
5721
- /** Emitted on a meta site unpublish. */
5722
- siteUnpublished?: SiteUnpublished;
5723
- /** Emitted when meta site is marked as template. */
5724
- siteMarkedAsTemplate?: SiteMarkedAsTemplate;
5725
- /** Emitted when meta site is marked as a WixSite. */
5726
- siteMarkedAsWixSite?: SiteMarkedAsWixSite;
5727
- /** Emitted when an application is provisioned (installed). */
5728
- serviceProvisioned?: ServiceProvisioned;
5729
- /** Emitted when an application is removed (uninstalled). */
5730
- serviceRemoved?: ServiceRemoved;
5731
- /** Emitted when meta site name (URL slug) is changed. */
5732
- siteRenamedPayload?: SiteRenamed;
5733
- /** Emitted when meta site was permanently deleted. */
5734
- hardDeleted?: SiteHardDeleted;
5735
- /** Emitted on a namespace change. */
5736
- namespaceChanged?: NamespaceChanged;
5737
- /** Emitted when Studio is attached. */
5738
- studioAssigned?: StudioAssigned;
5739
- /** Emitted when Studio is detached. */
5740
- studioUnassigned?: StudioUnassigned;
5831
+ voided?: boolean;
5741
5832
  /**
5742
- * Emitted when one of the URLs is changed. After this event you may call `urls-server` to fetch
5743
- * the actual URL.
5744
- *
5745
- * See: https://wix.slack.com/archives/C0UHEBPFT/p1732520791210559?thread_ts=1732027914.294059&cid=C0UHEBPFT
5746
- * See: https://wix.slack.com/archives/C0UHEBPFT/p1744115197619459
5833
+ * Gift card code with all but the last four characters masked. For example, `************QXY1`.
5834
+ * @maxLength 30
5835
+ * @immutable
5747
5836
  */
5748
- urlChanged?: SiteUrlChanged;
5749
- /** Site is marked as PurgedExternally */
5750
- sitePurgedExternally?: SitePurgedExternally;
5751
- /** Emitted when Odeditor is attached. */
5752
- odeditorAssigned?: OdeditorAssigned;
5753
- /** Emitted when Odeditor is detached. */
5754
- odeditorUnassigned?: OdeditorUnassigned;
5755
- /** Emitted when Picasso is attached. */
5756
- picassoAssigned?: PicassoAssigned;
5757
- /** Emitted when Picasso is detached. */
5758
- picassoUnassigned?: PicassoUnassigned;
5759
- /** Emitted when Wixel is attached. */
5760
- wixelAssigned?: WixelAssigned;
5761
- /** Emitted when Wixel is detached. */
5762
- wixelUnassigned?: WixelUnassigned;
5763
- /** Emitted when StudioTwo is attached. */
5764
- studioTwoAssigned?: StudioTwoAssigned;
5765
- /** Emitted when StudioTwo is detached. */
5766
- studioTwoUnassigned?: StudioTwoUnassigned;
5767
- /** Emitted when media from user domain is enabled. */
5768
- userDomainMediaEnabled?: UserDomainMediaEnabled;
5769
- /** Emitted when media from user domain is disabled. */
5770
- userDomainMediaDisabled?: UserDomainMediaDisabled;
5771
- /** Emitted when Editorless is attached. */
5772
- editorlessAssigned?: EditorlessAssigned;
5773
- /** Emitted when Editorless is detached. */
5774
- editorlessUnassigned?: EditorlessUnassigned;
5837
+ obfuscatedCode?: string | null;
5838
+ }
5839
+ interface MembershipPaymentDetails {
5775
5840
  /**
5776
- * A meta site id.
5777
- * @format GUID
5841
+ * Membership ID.
5842
+ * @maxLength 200
5778
5843
  */
5779
- metaSiteId?: string;
5780
- /** A meta site version. Monotonically increasing. */
5781
- version?: string;
5782
- /** A timestamp of the event. */
5783
- timestamp?: string;
5844
+ membershipId?: string;
5784
5845
  /**
5785
- * TODO(meta-site): Change validation once validations are disabled for consumers
5786
- * More context: https://wix.slack.com/archives/C0UHEBPFT/p1720957844413149 and https://wix.slack.com/archives/CFWKX325T/p1728892152855659
5787
- * @maxSize 4000
5846
+ * ID of the line item this membership applies to.
5847
+ * @minLength 1
5848
+ * @maxLength 100
5788
5849
  */
5789
- assets?: Asset[];
5790
- }
5791
- /** @oneof */
5792
- interface MetaSiteSpecialEventPayloadOneOf {
5793
- /** Emitted on a meta site creation. */
5794
- siteCreated?: SiteCreated;
5795
- /** Emitted on a meta site transfer completion. */
5796
- siteTransferred?: SiteTransferred;
5797
- /** Emitted on a meta site deletion. */
5798
- siteDeleted?: SiteDeleted;
5799
- /** Emitted on a meta site restoration. */
5800
- siteUndeleted?: SiteUndeleted;
5801
- /** Emitted on the first* publish of the meta site (* switching from unpublished to published state). */
5802
- sitePublished?: SitePublished;
5803
- /** Emitted on a meta site unpublish. */
5804
- siteUnpublished?: SiteUnpublished;
5805
- /** Emitted when meta site is marked as template. */
5806
- siteMarkedAsTemplate?: SiteMarkedAsTemplate;
5807
- /** Emitted when meta site is marked as a WixSite. */
5808
- siteMarkedAsWixSite?: SiteMarkedAsWixSite;
5809
- /** Emitted when an application is provisioned (installed). */
5810
- serviceProvisioned?: ServiceProvisioned;
5811
- /** Emitted when an application is removed (uninstalled). */
5812
- serviceRemoved?: ServiceRemoved;
5813
- /** Emitted when meta site name (URL slug) is changed. */
5814
- siteRenamedPayload?: SiteRenamed;
5815
- /** Emitted when meta site was permanently deleted. */
5816
- hardDeleted?: SiteHardDeleted;
5817
- /** Emitted on a namespace change. */
5818
- namespaceChanged?: NamespaceChanged;
5819
- /** Emitted when Studio is attached. */
5820
- studioAssigned?: StudioAssigned;
5821
- /** Emitted when Studio is detached. */
5822
- studioUnassigned?: StudioUnassigned;
5850
+ lineItemId?: string;
5823
5851
  /**
5824
- * Emitted when one of the URLs is changed. After this event you may call `urls-server` to fetch
5825
- * the actual URL.
5826
- *
5827
- * See: https://wix.slack.com/archives/C0UHEBPFT/p1732520791210559?thread_ts=1732027914.294059&cid=C0UHEBPFT
5828
- * See: https://wix.slack.com/archives/C0UHEBPFT/p1744115197619459
5852
+ * Payment status.
5853
+ * @deprecated Payment status.
5854
+ * @replacedBy payment.status
5855
+ * @targetRemovalDate 2026-11-01
5829
5856
  */
5830
- urlChanged?: SiteUrlChanged;
5831
- /** Site is marked as PurgedExternally */
5832
- sitePurgedExternally?: SitePurgedExternally;
5833
- /** Emitted when Odeditor is attached. */
5834
- odeditorAssigned?: OdeditorAssigned;
5835
- /** Emitted when Odeditor is detached. */
5836
- odeditorUnassigned?: OdeditorUnassigned;
5837
- /** Emitted when Picasso is attached. */
5838
- picassoAssigned?: PicassoAssigned;
5839
- /** Emitted when Picasso is detached. */
5840
- picassoUnassigned?: PicassoUnassigned;
5841
- /** Emitted when Wixel is attached. */
5842
- wixelAssigned?: WixelAssigned;
5843
- /** Emitted when Wixel is detached. */
5844
- wixelUnassigned?: WixelUnassigned;
5845
- /** Emitted when StudioTwo is attached. */
5846
- studioTwoAssigned?: StudioTwoAssigned;
5847
- /** Emitted when StudioTwo is detached. */
5848
- studioTwoUnassigned?: StudioTwoUnassigned;
5849
- /** Emitted when media from user domain is enabled. */
5850
- userDomainMediaEnabled?: UserDomainMediaEnabled;
5851
- /** Emitted when media from user domain is disabled. */
5852
- userDomainMediaDisabled?: UserDomainMediaDisabled;
5853
- /** Emitted when Editorless is attached. */
5854
- editorlessAssigned?: EditorlessAssigned;
5855
- /** Emitted when Editorless is detached. */
5856
- editorlessUnassigned?: EditorlessUnassigned;
5857
- }
5858
- interface Asset {
5857
+ status?: MembershipPaymentStatusWithLiterals;
5858
+ /** Membership name. */
5859
+ name?: MembershipName;
5859
5860
  /**
5860
- * An application definition id (app_id in dev-center). For legacy reasons may be UUID or a string (from Java Enum).
5861
- * @maxLength 36
5861
+ * The transaction ID in the membership system. Can be used to void the transaction.
5862
+ * @minLength 1
5863
+ * @maxLength 100
5862
5864
  */
5863
- appDefId?: string;
5865
+ externalTransactionId?: string | null;
5864
5866
  /**
5865
- * An instance id. For legacy reasons may be UUID or a string.
5866
- * @maxLength 200
5867
+ * Whether the membership is voided.
5868
+ * @readonly
5869
+ * @deprecated Whether the membership is voided.
5870
+ * @replacedBy payment.status
5871
+ * @targetRemovalDate 2026-11-01
5867
5872
  */
5868
- instanceId?: string;
5869
- /** An application state. */
5870
- state?: StateWithLiterals;
5873
+ voided?: boolean;
5874
+ /**
5875
+ * ID of the application providing this payment option.
5876
+ * @format GUID
5877
+ */
5878
+ providerAppId?: string;
5879
+ /** Details of a membership that does not yet exist, allowing the payment to be held before the membership is created. */
5880
+ futureMembership?: FutureMembershipDetails;
5871
5881
  }
5872
- declare enum State {
5873
- UNKNOWN = "UNKNOWN",
5874
- ENABLED = "ENABLED",
5875
- DISABLED = "DISABLED",
5876
- PENDING = "PENDING",
5877
- DEMO = "DEMO"
5882
+ declare enum MembershipPaymentStatus {
5883
+ /** Payment was charged. */
5884
+ CHARGED = "CHARGED",
5885
+ /** The attempt to charge the payment failed, for example, due to lack of credits. */
5886
+ CHARGE_FAILED = "CHARGE_FAILED",
5887
+ /** Payment is pending. */
5888
+ CHARGE_PENDING = "CHARGE_PENDING",
5889
+ /** Payment was voided. */
5890
+ VOIDED = "VOIDED"
5878
5891
  }
5879
5892
  /** @enumType */
5880
- type StateWithLiterals = State | 'UNKNOWN' | 'ENABLED' | 'DISABLED' | 'PENDING' | 'DEMO';
5881
- interface SiteCreated {
5893
+ type MembershipPaymentStatusWithLiterals = MembershipPaymentStatus | 'CHARGED' | 'CHARGE_FAILED' | 'CHARGE_PENDING' | 'VOIDED';
5894
+ interface FutureMembershipDetails {
5882
5895
  /**
5883
- * A template identifier (empty if not created from a template).
5884
- * @maxLength 36
5896
+ * ID of the plan line item in the order from which the membership will be created.
5897
+ * @format GUID
5885
5898
  */
5886
- originTemplateId?: string;
5899
+ lineItemId?: string;
5887
5900
  /**
5888
- * An account id of the owner.
5889
- * @format GUID
5901
+ * ID of the benefit the future membership will grant.
5902
+ * @maxLength 200
5890
5903
  */
5891
- ownerId?: string;
5892
- /** A context in which meta site was created. */
5893
- context?: SiteCreatedContextWithLiterals;
5904
+ benefitId?: string;
5905
+ }
5906
+ interface WixReceiptInfo {
5894
5907
  /**
5895
- * A meta site id from which this site was created.
5896
- *
5897
- * In case of a creation from a template it's a template id.
5898
- * In case of a site duplication ("Save As" in dashboard or duplicate in UM) it's an id of a source site.
5908
+ * Receipt ID
5899
5909
  * @format GUID
5900
5910
  */
5901
- originMetaSiteId?: string | null;
5911
+ receiptId?: string;
5902
5912
  /**
5903
- * A meta site name (URL slug).
5904
- * @maxLength 20
5913
+ * Display number of receipt
5914
+ * @minLength 1
5915
+ * @maxLength 40
5905
5916
  */
5906
- siteName?: string;
5907
- /** A namespace. */
5908
- namespace?: NamespaceWithLiterals;
5909
- }
5910
- declare enum SiteCreatedContext {
5911
- /** A valid option, we don't expose all reasons why site might be created. */
5912
- OTHER = "OTHER",
5913
- /** A meta site was created from template. */
5914
- FROM_TEMPLATE = "FROM_TEMPLATE",
5915
- /** A meta site was created by copying of the transfferred meta site. */
5916
- DUPLICATE_BY_SITE_TRANSFER = "DUPLICATE_BY_SITE_TRANSFER",
5917
- /** A copy of existing meta site. */
5918
- DUPLICATE = "DUPLICATE",
5919
- /** A meta site was created as a transfferred site (copy of the original), old flow, should die soon. */
5920
- OLD_SITE_TRANSFER = "OLD_SITE_TRANSFER",
5921
- /** deprecated A meta site was created for Flash editor. */
5922
- FLASH = "FLASH"
5917
+ displayNumber?: string | null;
5923
5918
  }
5924
- /** @enumType */
5925
- type SiteCreatedContextWithLiterals = SiteCreatedContext | 'OTHER' | 'FROM_TEMPLATE' | 'DUPLICATE_BY_SITE_TRANSFER' | 'DUPLICATE' | 'OLD_SITE_TRANSFER' | 'FLASH';
5926
- declare enum Namespace {
5927
- UNKNOWN_NAMESPACE = "UNKNOWN_NAMESPACE",
5928
- /** Default namespace for UGC sites. MetaSites with this namespace will be shown in a user's site list by default. */
5929
- WIX = "WIX",
5930
- /** ShoutOut stand alone product. These are siteless (no actual Wix site, no HtmlWeb). MetaSites with this namespace will *not* be shown in a user's site list by default. */
5931
- SHOUT_OUT = "SHOUT_OUT",
5932
- /** MetaSites created by the Albums product, they appear as part of the Albums app. MetaSites with this namespace will *not* be shown in a user's site list by default. */
5933
- ALBUMS = "ALBUMS",
5934
- /** Part of the WixStores migration flow, a user tries to migrate and gets this site to view and if the user likes it then stores removes this namespace and deletes the old site with the old stores. MetaSites with this namespace will *not* be shown in a user's site list by default. */
5935
- WIX_STORES_TEST_DRIVE = "WIX_STORES_TEST_DRIVE",
5936
- /** Hotels standalone (siteless). MetaSites with this namespace will *not* be shown in a user's site list by default. */
5937
- HOTELS = "HOTELS",
5938
- /** Clubs siteless MetaSites, a club without a wix website. MetaSites with this namespace will *not* be shown in a user's site list by default. */
5939
- CLUBS = "CLUBS",
5940
- /** A partially created ADI website. MetaSites with this namespace will *not* be shown in a user's site list by default. */
5941
- ONBOARDING_DRAFT = "ONBOARDING_DRAFT",
5919
+ interface ExternalReceiptInfo {
5942
5920
  /**
5943
- * AppBuilder for AppStudio / shmite (c). MetaSites with this namespace will *not* be shown in a user's site list by default.
5944
- * Not the dev-center dev site (see Flag.DEV_CENTER_DEV_SITE_FLAG).
5921
+ * External receipt ID
5922
+ * @maxLength 100
5945
5923
  */
5946
- DEV_SITE = "DEV_SITE",
5947
- /** LogoMaker websites offered to the user after logo purchase. MetaSites with this namespace will *not* be shown in a user's site list by default. */
5948
- LOGOS = "LOGOS",
5949
- /** VideoMaker websites offered to the user after video purchase. MetaSites with this namespace will *not* be shown in a user's site list by default. */
5950
- VIDEO_MAKER = "VIDEO_MAKER",
5951
- /** MetaSites with this namespace will *not* be shown in a user's site list by default. */
5952
- PARTNER_DASHBOARD = "PARTNER_DASHBOARD",
5953
- /** MetaSites with this namespace will *not* be shown in a user's site list by default. */
5954
- DEV_CENTER_COMPANY = "DEV_CENTER_COMPANY",
5924
+ receiptId?: string | null;
5955
5925
  /**
5956
- * A draft created by HTML editor on open. Upon "first save" it will be moved to be of WIX domain.
5957
- *
5958
- * Meta site with this namespace will *not* be shown in a user's site list by default.
5926
+ * ID of the app providing the receipt
5927
+ * @format GUID
5959
5928
  */
5960
- HTML_DRAFT = "HTML_DRAFT",
5929
+ appId?: string | null;
5961
5930
  /**
5962
- * the user-journey for Fitness users who want to start from managing their business instead of designing their website.
5963
- * Will be accessible from Site List and will not have a website app.
5964
- * Once the user attaches a site, the site will become a regular wixsite.
5931
+ * Display number of receipt
5932
+ * @minLength 1
5933
+ * @maxLength 40
5965
5934
  */
5966
- SITELESS_BUSINESS = "SITELESS_BUSINESS",
5967
- /** Belongs to "strategic products" company. Supports new product in the creator's economy space. */
5968
- CREATOR_ECONOMY = "CREATOR_ECONOMY",
5969
- /** It is to be used in the Business First efforts. */
5970
- DASHBOARD_FIRST = "DASHBOARD_FIRST",
5971
- /** Bookings business flow with no site. */
5972
- ANYWHERE = "ANYWHERE",
5973
- /** Namespace for Headless Backoffice with no editor */
5974
- HEADLESS = "HEADLESS",
5935
+ displayNumber?: string | null;
5936
+ }
5937
+ interface CashRoundingDetails {
5975
5938
  /**
5976
- * Namespace for master site that will exist in parent account that will be referenced by subaccounts
5977
- * The site will be used for account level CSM feature for enterprise
5939
+ * Payment amount before cash rounding was applied.
5940
+ * When provided, balance and status calculations use this value instead of `amount`
5941
+ * to prevent false overpayment or underpayment due to rounding.
5978
5942
  */
5979
- ACCOUNT_MASTER_CMS = "ACCOUNT_MASTER_CMS",
5980
- /** Rise.ai Siteless account management for Gift Cards and Store Credit. */
5981
- RISE = "RISE",
5982
- /**
5983
- * As part of the branded app new funnel, users now can create a meta site that will be branded app first.
5984
- * There's a blank site behind the scene but it's blank).
5985
- * The Mobile company will be the owner of this namespace.
5943
+ unroundedAmount?: Price;
5944
+ /**
5945
+ * The difference between 'amount' and 'unroundedAmount' (amount minus unroundedAmount).
5946
+ * A positive value indicates the price was rounded up; a negative value indicates a round-down.
5947
+ * @readonly
5986
5948
  */
5987
- BRANDED_FIRST = "BRANDED_FIRST",
5988
- /** Nownia.com Siteless account management for Ai Scheduling Assistant. */
5989
- NOWNIA = "NOWNIA",
5949
+ roundingAdjustment?: CashRounding;
5950
+ }
5951
+ declare enum PaymentStatus {
5952
+ /** Payment was charged successfully. */
5953
+ APPROVED = "APPROVED",
5954
+ /** Payment is being processed and hasn't been confirmed yet. */
5955
+ PENDING = "PENDING",
5956
+ /** Payment is awaiting confirmation. For an offline payment, the merchant must confirm they received it. For an online payment, the payment provider hasn't confirmed it, which typically means the merchant's provider account setup isn't complete. */
5957
+ PENDING_MERCHANT = "PENDING_MERCHANT",
5958
+ /** Payment was canceled before it was charged. */
5959
+ CANCELED = "CANCELED",
5960
+ /** Payment was declined by the payment provider. */
5961
+ DECLINED = "DECLINED",
5962
+ /** Payment was fully refunded. */
5963
+ REFUNDED = "REFUNDED",
5964
+ /** Part of the payment amount was refunded. */
5965
+ PARTIALLY_REFUNDED = "PARTIALLY_REFUNDED",
5966
+ /** Funds are held on the buyer's payment method but haven't been captured. Capture them with [Capture Authorized Payments](https://dev.wix.com/docs/api-reference/business-solutions/e-commerce/orders/order-billing/capture-authorized-payments) or release them with [Void Authorized Payments](https://dev.wix.com/docs/api-reference/business-solutions/e-commerce/orders/order-billing/void-authorized-payments). An authorized payment can't be refunded until it's captured. */
5967
+ AUTHORIZED = "AUTHORIZED",
5990
5968
  /**
5991
- * UGC Templates are templates that are created by users for personal use and to sale to other users.
5992
- * The Partners company owns this namespace.
5969
+ * Payment was voided, releasing whatever it held or consumed: an authorization on the buyer's payment method, a gift card balance, or membership credits.
5970
+ *
5971
+ * Gift card and membership payments don't support partial refunds, so a full refund of one is reported as `VOIDED` rather than `REFUNDED`.
5993
5972
  */
5994
- UGC_TEMPLATE = "UGC_TEMPLATE",
5995
- /** Codux Headless Sites */
5996
- CODUX = "CODUX",
5997
- /** Bobb - AI Design Creator. */
5998
- MEDIA_DESIGN_CREATOR = "MEDIA_DESIGN_CREATOR",
5973
+ VOIDED = "VOIDED"
5974
+ }
5975
+ /** @enumType */
5976
+ type PaymentStatusWithLiterals = PaymentStatus | 'APPROVED' | 'PENDING' | 'PENDING_MERCHANT' | 'CANCELED' | 'DECLINED' | 'REFUNDED' | 'PARTIALLY_REFUNDED' | 'AUTHORIZED' | 'VOIDED';
5977
+ interface CanceledStatusDetails {
5978
+ reason?: CanceledReasonWithLiterals;
5979
+ }
5980
+ declare enum CanceledReason {
5981
+ /** Other payment with the same chargeCorrelationId failed before current payment started. */
5982
+ OTHER_PAYMENT_FAILURE = "OTHER_PAYMENT_FAILURE",
5983
+ /** Payment was not completed by user and expired. */
5984
+ EXPIRED = "EXPIRED"
5985
+ }
5986
+ /** @enumType */
5987
+ type CanceledReasonWithLiterals = CanceledReason | 'OTHER_PAYMENT_FAILURE' | 'EXPIRED';
5988
+ interface DeclinedStatusDetails {
5989
+ reason?: DeclinedReasonWithLiterals;
5990
+ }
5991
+ declare enum DeclinedReason {
5992
+ /** Corresponding charge failed. */
5993
+ CHARGE_FAILED = "CHARGE_FAILED",
5994
+ /** Payment details expired. */
5995
+ EXPIRED = "EXPIRED",
5996
+ /** Insufficient funds. */
5997
+ INSUFFICIENT_FUNDS = "INSUFFICIENT_FUNDS",
5998
+ /** Gift card was disabled before charge was attempted. */
5999
+ GIFT_CARD_DISABLED = "GIFT_CARD_DISABLED"
6000
+ }
6001
+ /** @enumType */
6002
+ type DeclinedReasonWithLiterals = DeclinedReason | 'CHARGE_FAILED' | 'EXPIRED' | 'INSUFFICIENT_FUNDS' | 'GIFT_CARD_DISABLED';
6003
+ interface VoidedStatusDetails {
6004
+ reason?: VoidedReasonWithLiterals;
6005
+ }
6006
+ declare enum VoidedReason {
6007
+ /** Payment was voided by merchant request. */
6008
+ MERCHANT_REQUEST = "MERCHANT_REQUEST",
6009
+ /** Other payment with the same chargeCorrelationId failed and caused rollback of all payments with same chargeCorrelationId. */
6010
+ OTHER_PAYMENT_FAILURE = "OTHER_PAYMENT_FAILURE"
6011
+ }
6012
+ /** @enumType */
6013
+ type VoidedReasonWithLiterals = VoidedReason | 'MERCHANT_REQUEST' | 'OTHER_PAYMENT_FAILURE';
6014
+ interface PaymentStatusDetails extends PaymentStatusDetailsStatusDetailsOneOf {
6015
+ }
6016
+ /** @oneof */
6017
+ interface PaymentStatusDetailsStatusDetailsOneOf {
6018
+ }
6019
+ interface Refund {
5999
6020
  /**
6000
- * Shared Blog Site is a unique single site across Enterprise account,
6001
- * This site will hold all Blog posts related to the Marketing product.
6021
+ * Refund ID.
6022
+ * @format GUID
6023
+ * @readonly
6002
6024
  */
6003
- SHARED_BLOG_ENTERPRISE = "SHARED_BLOG_ENTERPRISE",
6004
- /** Standalone forms (siteless). MetaSites with this namespace will *not* be shown in a user's site list by default. */
6005
- STANDALONE_FORMS = "STANDALONE_FORMS",
6006
- /** Standalone events (siteless). MetaSites with this namespace will *not* be shown in a user's site list by default. */
6007
- STANDALONE_EVENTS = "STANDALONE_EVENTS",
6008
- /** MIMIR - Siteless account for MIMIR Ai Job runner. */
6009
- MIMIR = "MIMIR",
6010
- /** Wix Twins platform. */
6011
- TWINS = "TWINS",
6012
- /** Wix Nano. */
6013
- NANO = "NANO",
6014
- /** Base44 headless sites. */
6015
- BASE44 = "BASE44",
6016
- /** Wix Channels Sites */
6017
- CHANNELS = "CHANNELS",
6018
- /** Nautilus platform. */
6019
- NAUTILUS = "NAUTILUS",
6025
+ _id?: string;
6020
6026
  /**
6021
- * Symphony — a siteless site representing a project within Symphony (the evolution of Orion).
6022
- * Holds project data, conversations, assets, and manages collaborators / shared team members for the project.
6027
+ * List of transactions.
6028
+ * @maxSize 50
6023
6029
  */
6024
- SYMPHONY = "SYMPHONY",
6025
- /** Nautilus platform app. */
6026
- NAUTILUS_APPS = "NAUTILUS_APPS",
6030
+ transactions?: RefundTransaction[];
6031
+ /** Refund business details. */
6032
+ details?: RefundDetails;
6027
6033
  /**
6028
- * Vibu — a siteless site representing a project built with Vibu (the AI app builder).
6029
- * Holds the project's generated code, conversations, assets, and manages collaborators for the project.
6034
+ * Date and time the refund was created in [ISO-8601](https://en.wikipedia.org/wiki/ISO_8601#Combined_date_and_time_representations) format. Defaults to current time when not provided.
6035
+ * @readonly
6036
+ * @immutable
6030
6037
  */
6031
- VIBU = "VIBU",
6038
+ _createdDate?: Date | null;
6032
6039
  /**
6033
- * Ghost site for the BrandKit multi-site platform. Each ghost backs a single BrandKit
6034
- * (an Enterprise account may have several), holding that BrandKit's brand definition
6035
- * (theme, typography, assets) which is rolled out to the BrandKit's connected sites.
6036
- * MetaSites with this namespace will *not* be shown in a user's site list by default.
6040
+ * Aggregated refund summary.
6041
+ *
6042
+ * The refunded amount of this refund is in `summary.refunded`. To get the total refunded across the whole order, use `balanceSummary.refunded` on the order instead.
6043
+ * @readonly
6037
6044
  */
6038
- ENTERPRISE_BRAND_KIT = "ENTERPRISE_BRAND_KIT",
6045
+ summary?: AggregatedRefundSummary;
6039
6046
  /**
6040
- * Dev-center development sites (com.wixpress.devcenter.dsm).
6041
- * DEPRECATED: replaced by Flag.DEV_CENTER_DEV_SITE_FLAG (a dev site is orthogonal to the namespace). Do not use for new sites.
6047
+ * ID of the app that initiated this refund.
6048
+ * @format GUID
6049
+ * @readonly
6050
+ * @immutable
6042
6051
  */
6043
- DEV_CENTER_DEV_SITE = "DEV_CENTER_DEV_SITE"
6052
+ requestingServiceAppId?: string | null;
6044
6053
  }
6045
- /** @enumType */
6046
- type NamespaceWithLiterals = Namespace | 'UNKNOWN_NAMESPACE' | 'WIX' | 'SHOUT_OUT' | 'ALBUMS' | 'WIX_STORES_TEST_DRIVE' | 'HOTELS' | 'CLUBS' | 'ONBOARDING_DRAFT' | 'DEV_SITE' | 'LOGOS' | 'VIDEO_MAKER' | 'PARTNER_DASHBOARD' | 'DEV_CENTER_COMPANY' | 'HTML_DRAFT' | 'SITELESS_BUSINESS' | 'CREATOR_ECONOMY' | 'DASHBOARD_FIRST' | 'ANYWHERE' | 'HEADLESS' | 'ACCOUNT_MASTER_CMS' | 'RISE' | 'BRANDED_FIRST' | 'NOWNIA' | 'UGC_TEMPLATE' | 'CODUX' | 'MEDIA_DESIGN_CREATOR' | 'SHARED_BLOG_ENTERPRISE' | 'STANDALONE_FORMS' | 'STANDALONE_EVENTS' | 'MIMIR' | 'TWINS' | 'NANO' | 'BASE44' | 'CHANNELS' | 'NAUTILUS' | 'SYMPHONY' | 'NAUTILUS_APPS' | 'VIBU' | 'ENTERPRISE_BRAND_KIT' | 'DEV_CENTER_DEV_SITE';
6047
- /** Site transferred to another user. */
6048
- interface SiteTransferred {
6054
+ interface RefundTransaction {
6049
6055
  /**
6050
- * A previous owner id (user that transfers meta site).
6056
+ * ID of the payment associated with this refund.
6051
6057
  * @format GUID
6058
+ * @immutable
6052
6059
  */
6053
- oldOwnerId?: string;
6060
+ paymentId?: string;
6054
6061
  /**
6055
- * A new owner id (user that accepts meta site).
6056
- * @format GUID
6062
+ * Refund amount.
6063
+ * @immutable
6057
6064
  */
6058
- newOwnerId?: string;
6059
- }
6060
- /** Soft deletion of the meta site. Could be restored. */
6061
- interface SiteDeleted {
6062
- /** A deletion context. */
6063
- deleteContext?: DeleteContext;
6064
- }
6065
- interface DeleteContext {
6066
- /** When the meta site was deleted. */
6067
- dateDeleted?: Date | null;
6068
- /** A status. */
6069
- deleteStatus?: DeleteStatusWithLiterals;
6065
+ amount?: Price;
6066
+ /** Refund status. */
6067
+ refundStatus?: RefundStatusWithLiterals;
6068
+ /** Optional details of current refund status. */
6069
+ refundStatusInfo?: RefundStatusInfo;
6070
6070
  /**
6071
- * A reason (flow).
6072
- * @maxLength 255
6071
+ * Payment gateway's refund ID.
6072
+ * This field is only returned when the value of `external_refund` is `false`.
6073
+ * @format GUID
6073
6074
  */
6074
- deleteOrigin?: string;
6075
+ gatewayRefundId?: string | null;
6076
+ /** ID of the refund in the payment provider's system. For example, at PayPal, Square, Stripe, etc. Not returned for external refunds. */
6077
+ providerRefundId?: string | null;
6075
6078
  /**
6076
- * A service that deleted it.
6077
- * @maxLength 255
6079
+ * Whether refund was made externally and manually on the payment provider's side.
6080
+ * @immutable
6078
6081
  */
6079
- initiatorId?: string | null;
6082
+ externalRefund?: boolean;
6080
6083
  }
6081
- declare enum DeleteStatus {
6082
- UNKNOWN = "UNKNOWN",
6083
- TRASH = "TRASH",
6084
- DELETED = "DELETED",
6085
- PENDING_PURGE = "PENDING_PURGE",
6086
- PURGED_EXTERNALLY = "PURGED_EXTERNALLY"
6084
+ /** Refund transaction status. */
6085
+ declare enum RefundStatus {
6086
+ /** Refund was initiated on payment provider side. PENDING status was assigned by provider. */
6087
+ PENDING = "PENDING",
6088
+ /** Refund transaction succeeded. */
6089
+ SUCCEEDED = "SUCCEEDED",
6090
+ /** Refund transaction failed. */
6091
+ FAILED = "FAILED",
6092
+ /** Refund request acknowledged, and will be executed soon. */
6093
+ SCHEDULED = "SCHEDULED",
6094
+ /** Refund was initiated on payment provider side. */
6095
+ STARTED = "STARTED"
6087
6096
  }
6088
6097
  /** @enumType */
6089
- type DeleteStatusWithLiterals = DeleteStatus | 'UNKNOWN' | 'TRASH' | 'DELETED' | 'PENDING_PURGE' | 'PURGED_EXTERNALLY';
6090
- /** Restoration of the meta site. */
6091
- interface SiteUndeleted {
6092
- }
6093
- /** First publish of a meta site. Or subsequent publish after unpublish. */
6094
- interface SitePublished {
6095
- }
6096
- interface SiteUnpublished {
6098
+ type RefundStatusWithLiterals = RefundStatus | 'PENDING' | 'SUCCEEDED' | 'FAILED' | 'SCHEDULED' | 'STARTED';
6099
+ interface RefundStatusInfo {
6097
6100
  /**
6098
- * A list of URLs previously associated with the meta site.
6099
- * @maxLength 4000
6100
- * @maxSize 10000
6101
+ * Reason code for the refund's current status.
6102
+ *
6103
+ * Learn more about [reason codes](https://dev.wix.com/docs/rest/business-management/payments/service-plugins/payment-service-provider-service-plugin/reason-codes).
6104
+ * @minLength 1
6105
+ * @maxLength 10
6101
6106
  */
6102
- urls?: string[];
6103
- }
6104
- interface SiteMarkedAsTemplate {
6105
- }
6106
- interface SiteMarkedAsWixSite {
6107
+ paymentGatewayReasonCode?: string | null;
6108
+ /**
6109
+ * Free text explanation of current refund status.
6110
+ * @minLength 1
6111
+ * @maxLength 1000
6112
+ */
6113
+ description?: string | null;
6107
6114
  }
6108
- /**
6109
- * Represents a service provisioned a site.
6110
- *
6111
- * Note on `origin_instance_id`:
6112
- * There is no guarantee that you will be able to find a meta site using `origin_instance_id`.
6113
- * This is because of the following scenario:
6114
- *
6115
- * Imagine you have a template where a third-party application (TPA) includes some stub data,
6116
- * such as a product catalog. When you create a site from this template, you inherit this
6117
- * default product catalog. However, if the template's product catalog is modified,
6118
- * your site will retain the catalog as it was at the time of site creation. This ensures that
6119
- * your site remains consistent with what you initially received and does not include any
6120
- * changes made to the original template afterward.
6121
- * To ensure this, the TPA on the template gets a new instance_id.
6122
- */
6123
- interface ServiceProvisioned {
6115
+ interface AggregatedRefundSummary {
6116
+ /** Total amount requested for refund. */
6117
+ requestedRefund?: Price;
6118
+ /** Pending refund amount - the portion of `requestedRefund` that is still pending. */
6119
+ pendingRefund?: Price;
6120
+ /** Refunded amount - the portion of `requestedRefund` that refunded successfully. */
6121
+ refunded?: Price;
6122
+ /** Failed refund amount - the portion of `requestedRefund` that failed. */
6123
+ failedRefundAmount?: Price;
6124
+ /** Whether at least one refund transaction is still in `"PENDING"` status. */
6125
+ pending?: boolean;
6126
+ /** Breakdown of refunded items. Available only after refund is complete. */
6127
+ breakdown?: RefundItemsBreakdown;
6128
+ }
6129
+ interface RefundItemsBreakdown {
6124
6130
  /**
6125
- * Either UUID or EmbeddedServiceType.
6126
- * @maxLength 36
6131
+ * Refunded line items and the amount refunded for each.
6132
+ * @maxSize 300
6127
6133
  */
6128
- appDefId?: string;
6134
+ lineItems?: LineItemRefundSummary[];
6135
+ }
6136
+ interface LineItemRefundSummary {
6129
6137
  /**
6130
- * Not only UUID. Something here could be something weird.
6131
- * @maxLength 36
6138
+ * ID of the refunded line item.
6139
+ * @format GUID
6132
6140
  */
6133
- instanceId?: string;
6141
+ lineItemId?: string;
6142
+ /** Total refunded amount for the line item. */
6143
+ totalRefundedAmount?: Price;
6144
+ }
6145
+ interface CalculateRefundRequest {
6134
6146
  /**
6135
- * An instance id from which this instance is originated.
6136
- * @maxLength 36
6147
+ * Order ID
6148
+ * @minLength 1
6149
+ * @maxLength 100
6137
6150
  */
6138
- originInstanceId?: string;
6151
+ ecomOrderId?: string;
6139
6152
  /**
6140
- * A version.
6141
- * @maxLength 500
6153
+ * Refunded line items and quantity
6154
+ * @maxSize 300
6142
6155
  */
6143
- version?: string | null;
6156
+ refundItems?: CalculateRefundItemRequest[];
6157
+ /** Should include shipping in refund calculation */
6158
+ refundShipping?: boolean;
6159
+ }
6160
+ interface CalculateRefundItemRequest {
6144
6161
  /**
6145
- * The origin meta site id
6162
+ * ID of the line item being refunded
6146
6163
  * @format GUID
6147
6164
  */
6148
- originMetaSiteId?: string | null;
6149
- }
6150
- interface ServiceRemoved {
6165
+ _id?: string;
6151
6166
  /**
6152
- * Either UUID or EmbeddedServiceType.
6153
- * @maxLength 36
6167
+ * How much of that line item is being refunded
6168
+ * @min 1
6169
+ * @max 100000
6154
6170
  */
6155
- appDefId?: string;
6171
+ quantity?: number;
6172
+ }
6173
+ interface CalculateRefundResponse {
6174
+ /** Total refundable amount */
6175
+ total?: Price;
6176
+ /** Tax cost of the order */
6177
+ tax?: Price;
6178
+ /** Discount given for this order */
6179
+ discount?: Price;
6180
+ /** Total cost of the order (without tax) */
6181
+ subtotal?: Price;
6182
+ /** Total shipping cost for order */
6183
+ shipping?: Price;
6184
+ /** Previous refund given on that order */
6185
+ previouslyRefundedAmount?: Price;
6156
6186
  /**
6157
- * Not only UUID. Something here could be something weird.
6158
- * @maxLength 36
6187
+ * The refundable items of that order
6188
+ * @maxSize 300
6159
6189
  */
6160
- instanceId?: string;
6190
+ items?: CalculateRefundItemResponse[];
6191
+ }
6192
+ interface CalculateRefundItemResponse {
6161
6193
  /**
6162
- * A version.
6163
- * @maxLength 500
6194
+ * Line item ID
6195
+ * @format GUID
6164
6196
  */
6165
- version?: string | null;
6197
+ _id?: string;
6198
+ /** Refundable amount for requested quantity of items (price of requested quantity of items without tax and discount) */
6199
+ price?: Price;
6166
6200
  }
6167
- /** Rename of the site. Meaning, free public url has been changed as well. */
6168
- interface SiteRenamed {
6201
+ interface VoidAuthorizedPaymentsRequest {
6169
6202
  /**
6170
- * A new meta site name (URL slug).
6171
- * @maxLength 20
6203
+ * Wix eCommerce order ID
6204
+ * @minLength 1
6205
+ * @maxLength 100
6172
6206
  */
6173
- newSiteName?: string;
6207
+ ecomOrderId: string;
6174
6208
  /**
6175
- * A previous meta site name (URL slug).
6176
- * @maxLength 255
6209
+ * Payment IDs
6210
+ * @minSize 1
6211
+ * @maxSize 100
6212
+ * @format GUID
6177
6213
  */
6178
- oldSiteName?: string;
6179
- }
6180
- /**
6181
- * Hard deletion of the meta site.
6182
- *
6183
- * Could not be restored. Therefore it's desirable to cleanup data.
6184
- */
6185
- interface SiteHardDeleted {
6186
- /** A deletion context. */
6187
- deleteContext?: DeleteContext;
6188
- }
6189
- interface NamespaceChanged {
6190
- /** A previous namespace. */
6191
- oldNamespace?: NamespaceWithLiterals;
6192
- /** A new namespace. */
6193
- newNamespace?: NamespaceWithLiterals;
6194
- }
6195
- /** Assigned Studio editor */
6196
- interface StudioAssigned {
6197
- }
6198
- /** Unassigned Studio editor */
6199
- interface StudioUnassigned {
6214
+ paymentIds: string[];
6200
6215
  }
6201
- /**
6202
- * Fired in case site URLs were changed in any way: new secondary domain, published, account slug rename, site rename etc.
6203
- *
6204
- * This is an internal event, it's not propagated in special events, because it's non-actionable. If you need to keep up
6205
- * with sites and its urls, you need to listen to another topic/event. Read about it:
6206
- *
6207
- * https://bo.wix.com/wix-docs/rest/meta-site/meta-site---urls-service
6208
- */
6209
- interface SiteUrlChanged {
6216
+ interface VoidAuthorizedPaymentsResponse {
6217
+ /** All order's transactions after the void was triggered */
6218
+ orderTransactions?: OrderTransactions;
6210
6219
  }
6211
- /**
6212
- * Used at the end of the deletion flow for both draft sites and when a user deletes a site.
6213
- * Consumed by other teams to remove relevant data.
6214
- */
6215
- interface SitePurgedExternally {
6220
+ interface CaptureAuthorizedPaymentsRequest {
6216
6221
  /**
6217
- * @maxLength 2048
6222
+ * Wix eCommerce order ID
6223
+ * @minLength 1
6224
+ * @maxLength 100
6225
+ */
6226
+ ecomOrderId: string;
6227
+ /**
6228
+ * Capture payments information
6229
+ * @minSize 1
6218
6230
  * @maxSize 100
6219
- * @deprecated
6220
- * @targetRemovalDate 2025-04-15
6221
6231
  */
6222
- appDefId?: string[];
6223
- }
6224
- /** Assigned Odeditor */
6225
- interface OdeditorAssigned {
6226
- }
6227
- /** Unassigned Odeditor */
6228
- interface OdeditorUnassigned {
6229
- }
6230
- /** Assigned Picasso editor */
6231
- interface PicassoAssigned {
6232
- }
6233
- /** Unassigned Picasso */
6234
- interface PicassoUnassigned {
6235
- }
6236
- /** Assigned Wixel */
6237
- interface WixelAssigned {
6238
- }
6239
- /** Unassigned Wixel */
6240
- interface WixelUnassigned {
6241
- }
6242
- /** Assigned StudioTwo */
6243
- interface StudioTwoAssigned {
6244
- }
6245
- /** Unassigned StudioTwo */
6246
- interface StudioTwoUnassigned {
6247
- }
6248
- /** Media from user domain is enabled. */
6249
- interface UserDomainMediaEnabled {
6250
- }
6251
- /** Media from user domain is disabled. */
6252
- interface UserDomainMediaDisabled {
6253
- }
6254
- /** Assigned Editorless */
6255
- interface EditorlessAssigned {
6256
- }
6257
- /** Unassigned Editorless */
6258
- interface EditorlessUnassigned {
6232
+ payments: PaymentCapture[];
6259
6233
  }
6260
- interface HasCustomEmailConfigurationsRequest {
6234
+ interface PaymentCapture {
6235
+ /**
6236
+ * Payment ID
6237
+ * @format GUID
6238
+ */
6239
+ paymentId?: string | null;
6240
+ /**
6241
+ * Capture amount.
6242
+ * If not provided - full authorized amount will be captured.
6243
+ */
6244
+ amount?: Price;
6261
6245
  }
6262
- interface HasCustomEmailConfigurationsResponse {
6263
- hasCustomConfigurations?: boolean;
6246
+ interface CaptureAuthorizedPaymentsResponse {
6247
+ /** All order's transactions after the capture was triggered */
6248
+ orderTransactions?: OrderTransactions;
6264
6249
  }
6265
- interface AddToAutomationMigrationPopulationRequest {
6266
- /** When true, sends custom email configurations to automation system via email */
6267
- sendCustomEmailConfigs?: boolean;
6268
- /** Origin of the migration request. Defaults to OPT_IN when UNKNOWN_ORIGIN. */
6269
- origin?: OriginWithLiterals;
6250
+ interface ChargeSavedPaymentMethodRequest {
6251
+ /**
6252
+ * Ecom Order ID.
6253
+ * @minLength 1
6254
+ * @maxLength 100
6255
+ */
6256
+ ecomOrderId?: string;
6257
+ /** Amount to be charged */
6258
+ amount?: Price;
6270
6259
  }
6271
- declare enum Origin {
6272
- OPT_IN = "OPT_IN",
6273
- MIGRATION = "MIGRATION"
6260
+ interface ChargeSavedPaymentMethodResponse {
6261
+ /** Payment gateway's order ID (e.g Wix Payments) */
6262
+ paymentGatewayOrderId?: string;
6274
6263
  }
6275
- /** @enumType */
6276
- type OriginWithLiterals = Origin | 'OPT_IN' | 'MIGRATION';
6277
- interface AddToAutomationMigrationPopulationResponse {
6278
- success?: boolean;
6264
+ interface V1TriggerReindexRequest {
6265
+ /** @format GUID */
6266
+ metasiteId?: string;
6267
+ /**
6268
+ * @minLength 1
6269
+ * @maxLength 100
6270
+ * @maxSize 100
6271
+ */
6272
+ orderIds?: string[];
6279
6273
  }
6280
- interface IsInAutomationMigrationPopulationRequest {
6274
+ interface V1TriggerReindexResponse {
6281
6275
  }
6282
- interface IsInAutomationMigrationPopulationResponse {
6283
- inPopulation?: boolean;
6276
+ interface V1TriggerReindexOrderRequest {
6277
+ /** @format GUID */
6278
+ metasiteId?: string;
6279
+ /**
6280
+ * @minLength 1
6281
+ * @maxLength 100
6282
+ */
6283
+ orderId?: string;
6284
6284
  }
6285
6285
  interface DiffmatokyPayload {
6286
6286
  left?: string;
@@ -9516,4 +9516,4 @@ interface BulkUpdateOrderTagsOptions {
9516
9516
  unassignTags?: TagsTags;
9517
9517
  }
9518
9518
 
9519
- export { RepriceStatus as $, type AddActivitiesOptions as A, type BulkDeleteImportedOrdersResponse as B, type CaptureAuthorizedPaymentsResponse as C, type OrderCreatedEnvelope as D, type OrderFulfilledEnvelope as E, type OrderImportedEnvelope as F, type GetPaymentCollectabilityStatusResponse as G, type OrderImportedOrderDeletedEnvelope as H, type ImportOrderResponse as I, type OrderPaymentStatusUpdatedEnvelope as J, type OrderUpdatedEnvelope as K, DescriptionLineType as L, type MaskedOrder as M, DimensionsUnit as N, type Order as O, type Price as P, ItemTypePreset as Q, PaymentOptionType as R, type SetOrderNumberCounterOptions as S, JurisdictionType as T, type UpdateOrder as U, type VoidAuthorizedPaymentsResponse as V, SubscriptionFrequency as W, ProductPeriodAlignment as X, AdjustmentType as Y, TaxableAddressType as Z, MeasurementUnit as _, type ImportOrderApplicationErrors as a, type DescriptionLine as a$, BaseRateSource as a0, PaymentStatusEnumPaymentStatus as a1, FulfillmentStatus as a2, WeightUnit as a3, VatType as a4, PickupMethod as a5, OrderStatus as a6, CrossBorderNotApplicableReason as a7, CrossBorderRepricingMode as a8, DiscountType as a9, Reason as aA, ActionType as aB, ChargebackStatus as aC, MembershipPaymentStatus as aD, PaymentStatus as aE, CanceledReason as aF, DeclinedReason as aG, VoidedReason as aH, RefundStatus as aI, PreviewEmailType as aJ, State as aK, SiteCreatedContext as aL, Namespace as aM, DeleteStatus as aN, Origin as aO, SortOrder as aP, OrderApprovalStrategy as aQ, Placement as aR, SubdivisionType as aS, SourceType as aT, CustomFieldGroup as aU, ValueType as aV, DepositType as aW, InvoiceStatus as aX, type OrderLineItem as aY, type ProductName as aZ, type CatalogReference as a_, DiscountValueType as aa, DiscountReason as ab, LineItemQuantityChangeType as ac, ActivityType as ad, OrderActivityTypeEnumActivityType as ae, AttributionSource as af, ChannelType as ag, AdditionalFeeSource as ah, OrderActionType as ai, SpecificItemsCouponBehavior as aj, ChargeType as ak, VersioningMode as al, DeltaPaymentOptionType as am, InventoryAction as an, WebhookIdentityType as ao, ScheduledAction as ap, DurationUnit as aq, PaymentCollectabilityStatus as ar, PredefinedPaymentMethod as as, RefundableStatus as at, NonRefundableReason as au, ManuallyRefundableReason as av, RestockType as aw, TransactionStatus as ax, AuthorizationCaptureStatus as ay, AuthorizationVoidStatus as az, type SetOrderNumberCounterResponse as b, type MerchantDiscount as b$, type DescriptionLineValueOneOf as b0, type DescriptionLineDescriptionLineValueOneOf as b1, type DescriptionLineName as b2, type PlainTextValue as b3, type Color as b4, type FocalPoint as b5, type PhysicalProperties as b6, type Dimensions as b7, type ItemType as b8, type ItemTypeItemTypeDataOneOf as b9, type BuyerInfo as bA, type BuyerInfoIdOneOf as bB, type CurrencyConversionDetails as bC, type CrossBorderRepricing as bD, type PriceSummary as bE, type AddressWithContact as bF, type Address as bG, type StreetAddress as bH, type AddressLocation as bI, type FullAddressContactDetails as bJ, type VatId as bK, type V1ShippingInformation as bL, type DeliveryLogistics as bM, type DeliveryLogisticsAddressOneOf as bN, type PickupDetails as bO, type PickupAddress as bP, type DeliveryTimeSlot as bQ, type ShippingPrice as bR, type ShippingRegion as bS, type TaxSummary as bT, type OrderTaxInfo as bU, type OrderTaxBreakdown as bV, type CrossBorderCalculation as bW, type AppliedDiscount as bX, type AppliedDiscountDiscountSourceOneOf as bY, type Coupon as bZ, type CouponDiscountValueOneOf as b_, type RestockLocation as ba, type ItemTaxFullDetails as bb, type LineItemTaxInfo as bc, type LineItemTaxBreakdown as bd, type DigitalFile as be, type SubscriptionInfo as bf, type SubscriptionTitle as bg, type SubscriptionDescription as bh, type SubscriptionSettings as bi, type FreeTrialPeriod as bj, type BillingSettings as bk, type BillingAdjustment as bl, type BillingAdjustmentPriceSummary as bm, type CyclePriceOverride as bn, type PriceDescription as bo, type LocationAndQuantity as bp, type TaxableAddress as bq, type TaxableAddressTaxableAddressDataOneOf as br, type DecimalQuantity as bs, type DecimalQuantityUnitOneOf as bt, type TranslatableString as bu, type ExtendedFields as bv, type ModifierGroup as bw, type ItemModifier as bx, type ServiceProperties as by, type CrossBorderPriceAdjustment as bz, type SetOrderNumberCounterApplicationErrors as c, type CreatedBy as c$, type MerchantDiscountMerchantDiscountReasonOneOf as c0, type DiscountRule as c1, type DiscountRuleDiscountValueOneOf as c2, type DiscountRuleName as c3, type LineItemDiscount as c4, type ItemCombination as c5, type ItemCombinationLineItem as c6, type Activity as c7, type ActivityContentOneOf as c8, type CustomActivity as c9, type AuthorizedPaymentVoided as cA, type RefundInitiated as cB, type RefundedPayment as cC, type RefundedPaymentKindOneOf as cD, type RegularPaymentRefund as cE, type GiftCardPaymentRefund as cF, type MembershipPaymentRefund as cG, type PaymentRefunded as cH, type PaymentRefundFailed as cI, type RefundedAsStoreCredit as cJ, type PaymentPending as cK, type PaymentPendingPaymentDetailsOneOf as cL, type RegularPayment as cM, type RegularPaymentPaymentMethodDetailsOneOf as cN, type CreditCardDetails as cO, type PaymentCanceled as cP, type PaymentCanceledPaymentDetailsOneOf as cQ, type PaymentDeclined as cR, type PaymentDeclinedPaymentDetailsOneOf as cS, type ReceiptCreated as cT, type ReceiptCreatedReceiptInfoOneOf as cU, type WixReceipt as cV, type ExternalReceipt as cW, type ReceiptSent as cX, type ReceiptSentReceiptInfoOneOf as cY, type ChargebackCreated as cZ, type ChargebackReversed as c_, type MerchantComment as ca, type OrderRefunded as cb, type OrderCreatedFromExchange as cc, type NewExchangeOrderCreated as cd, type LineItemExchangeData as ce, type DraftOrderChangesApplied as cf, type OrderChange as cg, type OrderChangeValueOneOf as ch, type LineItemChanges as ci, type LineItemQuantityChange as cj, type LineItemPriceChange as ck, type LineItemProductNameChange as cl, type LineItemDescriptionLineChange as cm, type LineItemModifiersChange as cn, type ManagedLineItem as co, type ManagedDiscount as cp, type TranslatedValue as cq, type LineItemAmount as cr, type ManagedAdditionalFee as cs, type TotalPriceChange as ct, type ShippingInformationChange as cu, type ShippingInformation as cv, type PricesRecalculatedForDestination as cw, type SavedPaymentMethod as cx, type AuthorizedPaymentCreated as cy, type AuthorizedPaymentCaptured as cz, type PreparePaymentCollectionOptions as d, type EntityUpdatedEvent as d$, type CreatedByStringOneOf as d0, type ChannelInfo as d1, type CustomField as d2, type BalanceSummary as d3, type Balance as d4, type CashRounding as d5, type AdditionalFee as d6, type FulfillmentStatusesAggregate as d7, type Tags as d8, type TagList as d9, type V1RestockItem as dA, type OrderImported as dB, type ImportedOrderDeleted as dC, type PaymentStatusUpdated as dD, type FulfillmentStatusUpdated as dE, type OrderCanceledEventOrderCanceled as dF, type OrderDeltasCommitted as dG, type CommittedDiffs as dH, type CommittedDiffsShippingUpdateInfoOneOf as dI, type ItemChangedDetails as dJ, type OrderLineItemChangedDetails as dK, type DecimalQuantityUpdate as dL, type CrossBorderAdjustmentUpdate as dM, type LineItemDelta as dN, type LineItemDeltaDeltaOneOf as dO, type AppliedDiscountDelta as dP, type AppliedDiscountDeltaDeltaOneOf as dQ, type AdditionalFeeDelta as dR, type AdditionalFeeDeltaDeltaOneOf as dS, type DraftOrderCommitSettings as dT, type InventoryUpdateDetails as dU, type TriggerReindexRequest as dV, type TriggerReindexResponse as dW, type DomainEvent as dX, type DomainEventBodyOneOf as dY, type EntityCreatedEvent as dZ, type RestoreInfo as d_, type Location as da, type OrderSettings as db, type OrderSettingsAllowedActionsOneOf as dc, type OrderSettingsEditableByOneOf as dd, type CustomAllowedActions as de, type OwnerApps as df, type FormInfo as dg, type FormIdentifier as dh, type PlatformFeeSummary as di, type PlatformFee as dj, type UpdateInternalDocumentsEvent as dk, type UpdateInternalDocumentsEventOperationOneOf as dl, type InternalDocument as dm, type InternalDocumentUpdateOperation as dn, type DeleteByIdsOperation as dp, type DeleteByFilterOperation as dq, type InternalDocumentUpdateByFilterOperation as dr, type InternalUpdateExistingOperation as ds, type VersionedDocumentUpdateOperation as dt, type VersionedDeleteByIdsOperation as du, type VersionedDocumentId as dv, type OrderApproved as dw, type OrdersExperiments as dx, type OrderRejectedEventOrderRejected as dy, type OrderItemsRestocked as dz, type PreparePaymentCollectionResponse as e, type AuthorizationActionFailureDetails as e$, type EntityDeletedEvent as e0, type ActionEvent as e1, type Empty as e2, type TriggerReindexOrderRequest as e3, type MessageEnvelope as e4, type IdentificationData as e5, type IdentificationDataIdOneOf as e6, type AccountInfo as e7, type ImportOrderRequest as e8, type SetOrderNumberCounterRequest as e9, type ChargedBy as eA, type CreatePaymentGatewayOrderResponse as eB, type ChargeMembershipsRequest as eC, type MembershipChargeItem as eD, type MembershipName as eE, type ChargeMembershipsResponse as eF, type TriggerRefundRequest as eG, type PaymentRefund as eH, type RefundDetails as eI, type RefundItem as eJ, type LineItemRefund as eK, type AdditionalFeeRefund as eL, type ShippingRefund as eM, type RefundSideEffects as eN, type RestockInfo as eO, type RestockItem as eP, type TriggerRefundResponse as eQ, type OrderTransactions as eR, type Payment as eS, type PaymentPaymentDetailsOneOf as eT, type PaymentReceiptInfoOneOf as eU, type PaymentStatusDetailsOneOf as eV, type RegularPaymentDetails as eW, type RegularPaymentDetailsPaymentMethodDetailsOneOf as eX, type CreditCardPaymentMethodDetails as eY, type AuthorizationDetails as eZ, type AuthorizationCapture as e_, type BulkDeleteImportedOrdersRequest as ea, type V1TriggerReindexRequest as eb, type V1TriggerReindexResponse as ec, type V1TriggerReindexOrderRequest as ed, type PreparePaymentCollectionRequest as ee, type RedirectUrls as ef, type DelayedCaptureSettings as eg, type Duration as eh, type GetPaymentCollectabilityStatusRequest as ei, type RecordManuallyCollectedPaymentRequest as ej, type UserDefinedPaymentMethodName as ek, type UserDefinedPaymentMethodNameKindOneOf as el, type RecordManuallyCollectedPaymentResponse as em, type MarkOrderAsPaidRequest as en, type MarkOrderAsPaidResponse as eo, type BulkMarkOrdersAsPaidRequest as ep, type BulkMarkOrdersAsPaidResponse as eq, type BulkOrderResult as er, type ItemMetadata as es, type ApplicationError as et, type BulkActionMetadata as eu, type GetRefundabilityStatusRequest as ev, type GetRefundabilityStatusResponse as ew, type Refundability as ex, type RefundabilityAdditionalRefundabilityInfoOneOf as ey, type CreatePaymentGatewayOrderRequest as ez, type PreparePaymentCollectionApplicationErrors as f, type PreviewBuyerPickupConfirmationEmailRequest as f$, type AuthorizationVoid as f0, type V1ScheduledAction as f1, type Chargeback as f2, type PaymentMethodName as f3, type GiftCardPaymentDetails as f4, type MembershipPaymentDetails as f5, type FutureMembershipDetails as f6, type WixReceiptInfo as f7, type ExternalReceiptInfo as f8, type CashRoundingDetails as f9, type BulkSendBuyerPickupConfirmationEmailsResponse as fA, type SendBuyerShippingConfirmationEmailRequest as fB, type SendBuyerShippingConfirmationEmailResponse as fC, type BulkSendBuyerShippingConfirmationEmailsRequest as fD, type BulkSendBuyerShippingConfirmationEmailsResponse as fE, type SendMerchantOrderReceivedNotificationRequest as fF, type SendMerchantOrderReceivedNotificationResponse as fG, type SendCancelRefundEmailRequest as fH, type SendCancelRefundEmailResponse as fI, type SendRefundEmailRequest as fJ, type SendRefundEmailResponse as fK, type SendFulfillmentEmailRequest as fL, type SendFulfillmentEmailResponse as fM, type SendMerchantOrderReceivedPushRequest as fN, type SendMerchantOrderReceivedPushResponse as fO, type PreviewEmailByTypeRequest as fP, type PreviewEmailByTypeResponse as fQ, type PreviewRefundEmailRequest as fR, type PreviewRefundEmailResponse as fS, type PreviewCancelEmailRequest as fT, type PreviewCancelEmailResponse as fU, type PreviewCancelRefundEmailRequest as fV, type PreviewCancelRefundEmailResponse as fW, type PreviewBuyerPaymentsReceivedEmailRequest as fX, type PreviewBuyerPaymentsReceivedEmailResponse as fY, type PreviewBuyerConfirmationEmailRequest as fZ, type PreviewBuyerConfirmationEmailResponse as f_, type CanceledStatusDetails as fa, type DeclinedStatusDetails as fb, type VoidedStatusDetails as fc, type PaymentStatusDetails as fd, type PaymentStatusDetailsStatusDetailsOneOf as fe, type Refund as ff, type RefundTransaction as fg, type RefundStatusInfo as fh, type AggregatedRefundSummary as fi, type RefundItemsBreakdown as fj, type LineItemRefundSummary as fk, type CalculateRefundRequest as fl, type CalculateRefundItemRequest as fm, type CalculateRefundResponse as fn, type CalculateRefundItemResponse as fo, type VoidAuthorizedPaymentsRequest as fp, type CaptureAuthorizedPaymentsRequest as fq, type ChargeSavedPaymentMethodRequest as fr, type ChargeSavedPaymentMethodResponse as fs, type SendBuyerConfirmationEmailRequest as ft, type SendBuyerConfirmationEmailResponse as fu, type SendBuyerPaymentsReceivedEmailRequest as fv, type SendBuyerPaymentsReceivedEmailResponse as fw, type SendBuyerPickupConfirmationEmailRequest as fx, type SendBuyerPickupConfirmationEmailResponse as fy, type BulkSendBuyerPickupConfirmationEmailsRequest as fz, type VoidAuthorizedPaymentsApplicationErrors as g, type CreateOrderRequest as g$, type PreviewBuyerPickupConfirmationEmailResponse as g0, type PreviewShippingConfirmationEmailRequest as g1, type PreviewShippingConfirmationEmailResponse as g2, type PreviewResendDownloadLinksEmailRequest as g3, type PreviewResendDownloadLinksEmailResponse as g4, type MetaSiteSpecialEvent as g5, type MetaSiteSpecialEventPayloadOneOf as g6, type Asset as g7, type SiteCreated as g8, type SiteTransferred as g9, type EditorlessAssigned as gA, type EditorlessUnassigned as gB, type HasCustomEmailConfigurationsRequest as gC, type HasCustomEmailConfigurationsResponse as gD, type AddToAutomationMigrationPopulationRequest as gE, type AddToAutomationMigrationPopulationResponse as gF, type IsInAutomationMigrationPopulationRequest as gG, type IsInAutomationMigrationPopulationResponse as gH, type DiffmatokyPayload as gI, type ErrorInformation as gJ, type GetOrderRequest as gK, type GetOrderResponse as gL, type InternalQueryOrdersRequest as gM, type PlatformQuery as gN, type PlatformQueryPagingMethodOneOf as gO, type Sorting as gP, type PlatformPaging as gQ, type CursorPaging as gR, type InternalQueryOrdersResponse as gS, type PlatformPagingMetadata as gT, type Cursors as gU, type QueryOrderRequest as gV, type QueryOrderResponse as gW, type SearchOrdersRequest as gX, type CursorSearch as gY, type CursorSearchPagingMethodOneOf as gZ, type CursorPagingMetadata as g_, type SiteDeleted as ga, type DeleteContext as gb, type SiteUndeleted as gc, type SitePublished as gd, type SiteUnpublished as ge, type SiteMarkedAsTemplate as gf, type SiteMarkedAsWixSite as gg, type ServiceProvisioned as gh, type ServiceRemoved as gi, type SiteRenamed as gj, type SiteHardDeleted as gk, type NamespaceChanged as gl, type StudioAssigned as gm, type StudioUnassigned as gn, type SiteUrlChanged as go, type SitePurgedExternally as gp, type OdeditorAssigned as gq, type OdeditorUnassigned as gr, type PicassoAssigned as gs, type PicassoUnassigned as gt, type WixelAssigned as gu, type WixelUnassigned as gv, type StudioTwoAssigned as gw, type StudioTwoUnassigned as gx, type UserDomainMediaEnabled as gy, type UserDomainMediaDisabled as gz, type PaymentCapture as h, type OrderRejected as h$, type OrderCreationSettings as h0, type OrderCreationSettingsEditableByOneOf as h1, type OrderCreateNotifications as h2, type CreateOrderResponse as h3, type UpdateOrderRequest as h4, type UpdateOrderResponse as h5, type BulkUpdateOrdersRequest as h6, type CommitDeltasRequest as h7, type DraftOrderDiffs as h8, type DraftOrderDiffsShippingUpdateInfoOneOf as h9, type UpdateBillingContactDetailsResponse as hA, type UpdateOrderLineItemRequest as hB, type UpdateOrderLineItemResponse as hC, type UpdateOrderLineItemsRequest as hD, type MaskedOrderLineItem as hE, type UpdateOrderLineItemsResponse as hF, type AddInternalActivityRequest as hG, type InternalActivity as hH, type InternalActivityContentOneOf as hI, type OrderPlaced as hJ, type OrderPaid as hK, type OrderFulfilled as hL, type OrderNotFulfilled as hM, type OrderCanceled as hN, type DownloadLinkSent as hO, type TrackingNumberAdded as hP, type TrackingNumberEdited as hQ, type TrackingLinkAdded as hR, type ShippingConfirmationEmailSent as hS, type InvoiceAdded as hT, type InvoiceSent as hU, type FulfillerEmailSent as hV, type ShippingAddressEdited as hW, type EmailEdited as hX, type PickupReadyEmailSent as hY, type OrderPartiallyPaid as hZ, type OrderPending as h_, type DraftOrderDiffsBuyerUpdateInfoOneOf as ha, type DraftOrderDiffsBillingUpdateInfoOneOf as hb, type DraftOrderDiffsRecipientUpdateInfoOneOf as hc, type V1LineItemDelta as hd, type V1LineItemDeltaDeltaOneOf as he, type CommitDeltasResponse as hf, type ArchiveOrderRequest as hg, type ArchiveOrderResponse as hh, type BulkArchiveOrdersRequest as hi, type BulkArchiveOrdersResponse as hj, type BulkArchiveOrdersByFilterRequest as hk, type BulkArchiveOrdersByFilterResponse as hl, type UnArchiveOrderRequest as hm, type UnArchiveOrderResponse as hn, type BulkUnArchiveOrdersRequest as ho, type BulkUnArchiveOrdersResponse as hp, type BulkUnArchiveOrdersByFilterRequest as hq, type BulkUnArchiveOrdersByFilterResponse as hr, type UpdateBuyerInfoRequest as hs, type BuyerInfoUpdate as ht, type UpdateBuyerInfoResponse as hu, type UpdateBuyerEmailRequest as hv, type UpdateBuyerEmailResponse as hw, type UpdateOrderShippingAddressRequest as hx, type UpdateOrderShippingAddressResponse as hy, type UpdateBillingContactDetailsRequest as hz, type CaptureAuthorizedPaymentsApplicationErrors as i, type InvoiceFields as i$, type AddInternalActivityResponse as i0, type AddActivityRequest as i1, type PublicActivity as i2, type PublicActivityContentOneOf as i3, type AddActivityResponse as i4, type AddActivitiesRequest as i5, type UpdateActivityRequest as i6, type UpdateActivityResponse as i7, type DeleteActivityRequest as i8, type DeleteActivityResponse as i9, type V1MarkOrderAsPaidResponse as iA, type V1BulkMarkOrdersAsPaidRequest as iB, type V1BulkMarkOrdersAsPaidResponse as iC, type V1CreatePaymentGatewayOrderRequest as iD, type V1CreatePaymentGatewayOrderResponse as iE, type GetShipmentsRequest as iF, type GetShipmentsResponse as iG, type AggregateOrdersRequest as iH, type AggregateOrdersResponse as iI, type DecrementItemsQuantityRequest as iJ, type DecrementData as iK, type DecrementItemsQuantityResponse as iL, type BulkUpdateOrderTagsRequest as iM, type TagsTags as iN, type TagsTagList as iO, type BulkUpdateOrderTagsResult as iP, type SendOrderUpdatedDomainEventRequest as iQ, type SendOrderUpdatedDomainEventResponse as iR, type Task as iS, type TaskKey as iT, type TaskAction as iU, type TaskActionActionOneOf as iV, type Complete as iW, type Cancel as iX, type Reschedule as iY, type InvoiceSentEvent as iZ, type IdAndVersion as i_, type UpdateLineItemsDescriptionLinesRequest as ia, type LineItemUpdate as ib, type UpdateLineItemsDescriptionLinesResponse as ic, type MarkOrderAsSeenByHumanRequest as id, type MarkOrderAsSeenByHumanResponse as ie, type CancelOrderRequest as ig, type UpdateOrderStatusRequest as ih, type UpdateOrderStatusResponse as ii, type MarkAsFulfilledRequest as ij, type MarkAsFulfilledResponse as ik, type BulkMarkAsFulfilledRequest as il, type BulkMarkAsFulfilledResponse as im, type BulkMarkAsFulfilledByFilterRequest as io, type BulkMarkAsFulfilledByFilterResponse as ip, type MarkAsUnfulfilledRequest as iq, type MarkAsUnfulfilledResponse as ir, type BulkMarkAsUnfulfilledRequest as is, type BulkMarkAsUnfulfilledResponse as it, type BulkMarkAsUnfulfilledByFilterRequest as iu, type BulkMarkAsUnfulfilledByFilterResponse as iv, type BulkSetBusinessLocationRequest as iw, type BulkSetBusinessLocationResponse as ix, type BulkSetBusinessLocationResult as iy, type V1MarkOrderAsPaidRequest as iz, type GetOrderApplicationErrors as j, type PickupMethodWithLiterals as j$, type Customer as j0, type Email as j1, type QuotesAddress as j2, type AddressDescription as j3, type Phone as j4, type Company as j5, type CommonAddress as j6, type CommonAddressStreetOneOf as j7, type Subdivision as j8, type StandardDetails as j9, type PaymentCollectionMarkOrderAsPaidOptions as jA, type PaymentCollectionCreatePaymentGatewayOrderOptions as jB, type ChargeMembershipsOptions as jC, type TriggerRefundOptions as jD, type OrderSearchSpec as jE, type UpdateOrderLineItemIdentifiers as jF, type UpdateOrderLineItem as jG, type UpdateActivityIdentifiers as jH, type DeleteActivityIdentifiers as jI, type AggregateOrdersOptions as jJ, utils as jK, type DescriptionLineTypeWithLiterals as jL, type DimensionsUnitWithLiterals as jM, type ItemTypePresetWithLiterals as jN, type PaymentOptionTypeWithLiterals as jO, type JurisdictionTypeWithLiterals as jP, type SubscriptionFrequencyWithLiterals as jQ, type ProductPeriodAlignmentWithLiterals as jR, type AdjustmentTypeWithLiterals as jS, type TaxableAddressTypeWithLiterals as jT, type MeasurementUnitWithLiterals as jU, type RepriceStatusWithLiterals as jV, type BaseRateSourceWithLiterals as jW, type PaymentStatusEnumPaymentStatusWithLiterals as jX, type FulfillmentStatusWithLiterals as jY, type WeightUnitWithLiterals as jZ, type VatTypeWithLiterals as j_, type ShippingContactDetails as ja, type InvoiceDates as jb, type LineItems as jc, type LineItem as jd, type BigDecimalWrapper as je, type LineItemTax as jf, type Source as jg, type LineItemMetaData as jh, type Locale as ji, type TotalPrice as jj, type ItemizedFee as jk, type Discount as jl, type DiscountOneDiscountTypeOneOf as jm, type CalculatedTaxes as jn, type CalculatedTax as jo, type Payments as jp, type InvoicesPayment as jq, type MetaData as jr, type InvoiceDynamicPriceTotals as js, type CustomFieldValue as jt, type Value as ju, type Deposit as jv, type BaseEventMetadata as jw, type EventMetadata as jx, type AccountInfoMetadata as jy, type RecordManuallyCollectedPaymentOptions as jz, type OrderSearch as k, onOrderCreated as k$, type OrderStatusWithLiterals as k0, type CrossBorderNotApplicableReasonWithLiterals as k1, type CrossBorderRepricingModeWithLiterals as k2, type DiscountTypeWithLiterals as k3, type DiscountValueTypeWithLiterals as k4, type DiscountReasonWithLiterals as k5, type LineItemQuantityChangeTypeWithLiterals as k6, type ActivityTypeWithLiterals as k7, type OrderActivityTypeEnumActivityTypeWithLiterals as k8, type AttributionSourceWithLiterals as k9, type DeclinedReasonWithLiterals as kA, type VoidedReasonWithLiterals as kB, type RefundStatusWithLiterals as kC, type PreviewEmailTypeWithLiterals as kD, type StateWithLiterals as kE, type SiteCreatedContextWithLiterals as kF, type NamespaceWithLiterals as kG, type DeleteStatusWithLiterals as kH, type OriginWithLiterals as kI, type SortOrderWithLiterals as kJ, type OrderApprovalStrategyWithLiterals as kK, type PlacementWithLiterals as kL, type SubdivisionTypeWithLiterals as kM, type SourceTypeWithLiterals as kN, type CustomFieldGroupWithLiterals as kO, type ValueTypeWithLiterals as kP, type DepositTypeWithLiterals as kQ, type InvoiceStatusWithLiterals as kR, type RecordManuallyCollectedPaymentApplicationErrors as kS, type PaymentCollectionMarkOrderAsPaidApplicationErrors as kT, type PaymentCollectionCreatePaymentGatewayOrderApplicationErrors as kU, type TriggerRefundApplicationErrors as kV, type UpdateOrderStatusApplicationErrors as kW, type CommonSearchWithEntityContext as kX, onOrderApproved as kY, onOrderCanceled as kZ, onOrderCommitted as k_, type ChannelTypeWithLiterals as ka, type AdditionalFeeSourceWithLiterals as kb, type OrderActionTypeWithLiterals as kc, type SpecificItemsCouponBehaviorWithLiterals as kd, type ChargeTypeWithLiterals as ke, type VersioningModeWithLiterals as kf, type DeltaPaymentOptionTypeWithLiterals as kg, type InventoryActionWithLiterals as kh, type WebhookIdentityTypeWithLiterals as ki, type ScheduledActionWithLiterals as kj, type DurationUnitWithLiterals as kk, type PaymentCollectabilityStatusWithLiterals as kl, type PredefinedPaymentMethodWithLiterals as km, type RefundableStatusWithLiterals as kn, type NonRefundableReasonWithLiterals as ko, type ManuallyRefundableReasonWithLiterals as kp, type RestockTypeWithLiterals as kq, type TransactionStatusWithLiterals as kr, type AuthorizationCaptureStatusWithLiterals as ks, type AuthorizationVoidStatusWithLiterals as kt, type ReasonWithLiterals as ku, type ActionTypeWithLiterals as kv, type ChargebackStatusWithLiterals as kw, type MembershipPaymentStatusWithLiterals as kx, type PaymentStatusWithLiterals as ky, type CanceledReasonWithLiterals as kz, type SearchOrdersResponse as l, onOrderFulfilled as l0, onOrderImported as l1, onOrderImportedOrderDeleted as l2, onOrderPaymentStatusUpdated as l3, onOrderUpdated as l4, importOrder as l5, setOrderNumberCounter as l6, bulkDeleteImportedOrders as l7, preparePaymentCollection as l8, getPaymentCollectabilityStatus as l9, voidAuthorizedPayments as la, captureAuthorizedPayments as lb, getOrder as lc, createOrder as ld, updateOrder as le, bulkUpdateOrders as lf, addActivities as lg, cancelOrder as lh, bulkUpdateOrderTags as li, type CreateOrderOptions as m, type CreateOrderApplicationErrors as n, type UpdateOrderApplicationErrors as o, type BulkUpdateOrdersOptions as p, type BulkUpdateOrdersResponse as q, type AddActivitiesResponse as r, type CancelOrderOptions as s, type CancelOrderResponse as t, type CancelOrderApplicationErrors as u, type BulkUpdateOrderTagsOptions as v, type BulkUpdateOrderTagsResponse as w, type OrderApprovedEnvelope as x, type OrderCanceledEnvelope as y, type OrderCommittedEnvelope as z };
9519
+ export { RepriceStatus as $, type AddActivitiesOptions as A, type BulkDeleteImportedOrdersResponse as B, type CaptureAuthorizedPaymentsResponse as C, type OrderCreatedEnvelope as D, type OrderFulfilledEnvelope as E, type OrderImportedEnvelope as F, type GetPaymentCollectabilityStatusResponse as G, type OrderImportedOrderDeletedEnvelope as H, type ImportOrderResponse as I, type OrderPaymentStatusUpdatedEnvelope as J, type OrderUpdatedEnvelope as K, DescriptionLineType as L, type MaskedOrder as M, DimensionsUnit as N, type Order as O, type Price as P, ItemTypePreset as Q, PaymentOptionType as R, type SetOrderNumberCounterOptions as S, JurisdictionType as T, type UpdateOrder as U, type VoidAuthorizedPaymentsResponse as V, SubscriptionFrequency as W, ProductPeriodAlignment as X, AdjustmentType as Y, TaxableAddressType as Z, MeasurementUnit as _, type ImportOrderApplicationErrors as a, type DescriptionLine as a$, BaseRateSource as a0, PaymentStatusEnumPaymentStatus as a1, FulfillmentStatus as a2, WeightUnit as a3, VatType as a4, PickupMethod as a5, OrderStatus as a6, CrossBorderNotApplicableReason as a7, CrossBorderRepricingMode as a8, DiscountType as a9, NonRefundableReason as aA, ManuallyRefundableReason as aB, RestockType as aC, TransactionStatus as aD, AuthorizationCaptureStatus as aE, AuthorizationVoidStatus as aF, Reason as aG, ActionType as aH, ChargebackStatus as aI, MembershipPaymentStatus as aJ, PaymentStatus as aK, CanceledReason as aL, DeclinedReason as aM, VoidedReason as aN, RefundStatus as aO, SortOrder as aP, OrderApprovalStrategy as aQ, Placement as aR, SubdivisionType as aS, SourceType as aT, CustomFieldGroup as aU, ValueType as aV, DepositType as aW, InvoiceStatus as aX, type OrderLineItem as aY, type ProductName as aZ, type CatalogReference as a_, DiscountValueType as aa, DiscountReason as ab, LineItemQuantityChangeType as ac, ActivityType as ad, OrderActivityTypeEnumActivityType as ae, AttributionSource as af, ChannelType as ag, AdditionalFeeSource as ah, OrderActionType as ai, SpecificItemsCouponBehavior as aj, ChargeType as ak, VersioningMode as al, DeltaPaymentOptionType as am, InventoryAction as an, WebhookIdentityType as ao, PreviewEmailType as ap, State as aq, SiteCreatedContext as ar, Namespace as as, DeleteStatus as at, Origin as au, ScheduledAction as av, DurationUnit as aw, PaymentCollectabilityStatus as ax, PredefinedPaymentMethod as ay, RefundableStatus as az, type SetOrderNumberCounterResponse as b, type MerchantDiscount as b$, type DescriptionLineValueOneOf as b0, type DescriptionLineDescriptionLineValueOneOf as b1, type DescriptionLineName as b2, type PlainTextValue as b3, type Color as b4, type FocalPoint as b5, type PhysicalProperties as b6, type Dimensions as b7, type ItemType as b8, type ItemTypeItemTypeDataOneOf as b9, type BuyerInfo as bA, type BuyerInfoIdOneOf as bB, type CurrencyConversionDetails as bC, type CrossBorderRepricing as bD, type PriceSummary as bE, type AddressWithContact as bF, type Address as bG, type StreetAddress as bH, type AddressLocation as bI, type FullAddressContactDetails as bJ, type VatId as bK, type V1ShippingInformation as bL, type DeliveryLogistics as bM, type DeliveryLogisticsAddressOneOf as bN, type PickupDetails as bO, type PickupAddress as bP, type DeliveryTimeSlot as bQ, type ShippingPrice as bR, type ShippingRegion as bS, type TaxSummary as bT, type OrderTaxInfo as bU, type OrderTaxBreakdown as bV, type CrossBorderCalculation as bW, type AppliedDiscount as bX, type AppliedDiscountDiscountSourceOneOf as bY, type Coupon as bZ, type CouponDiscountValueOneOf as b_, type RestockLocation as ba, type ItemTaxFullDetails as bb, type LineItemTaxInfo as bc, type LineItemTaxBreakdown as bd, type DigitalFile as be, type SubscriptionInfo as bf, type SubscriptionTitle as bg, type SubscriptionDescription as bh, type SubscriptionSettings as bi, type FreeTrialPeriod as bj, type BillingSettings as bk, type BillingAdjustment as bl, type BillingAdjustmentPriceSummary as bm, type CyclePriceOverride as bn, type PriceDescription as bo, type LocationAndQuantity as bp, type TaxableAddress as bq, type TaxableAddressTaxableAddressDataOneOf as br, type DecimalQuantity as bs, type DecimalQuantityUnitOneOf as bt, type TranslatableString as bu, type ExtendedFields as bv, type ModifierGroup as bw, type ItemModifier as bx, type ServiceProperties as by, type CrossBorderPriceAdjustment as bz, type SetOrderNumberCounterApplicationErrors as c, type CreatedBy as c$, type MerchantDiscountMerchantDiscountReasonOneOf as c0, type DiscountRule as c1, type DiscountRuleDiscountValueOneOf as c2, type DiscountRuleName as c3, type LineItemDiscount as c4, type ItemCombination as c5, type ItemCombinationLineItem as c6, type Activity as c7, type ActivityContentOneOf as c8, type CustomActivity as c9, type AuthorizedPaymentVoided as cA, type RefundInitiated as cB, type RefundedPayment as cC, type RefundedPaymentKindOneOf as cD, type RegularPaymentRefund as cE, type GiftCardPaymentRefund as cF, type MembershipPaymentRefund as cG, type PaymentRefunded as cH, type PaymentRefundFailed as cI, type RefundedAsStoreCredit as cJ, type PaymentPending as cK, type PaymentPendingPaymentDetailsOneOf as cL, type RegularPayment as cM, type RegularPaymentPaymentMethodDetailsOneOf as cN, type CreditCardDetails as cO, type PaymentCanceled as cP, type PaymentCanceledPaymentDetailsOneOf as cQ, type PaymentDeclined as cR, type PaymentDeclinedPaymentDetailsOneOf as cS, type ReceiptCreated as cT, type ReceiptCreatedReceiptInfoOneOf as cU, type WixReceipt as cV, type ExternalReceipt as cW, type ReceiptSent as cX, type ReceiptSentReceiptInfoOneOf as cY, type ChargebackCreated as cZ, type ChargebackReversed as c_, type MerchantComment as ca, type OrderRefunded as cb, type OrderCreatedFromExchange as cc, type NewExchangeOrderCreated as cd, type LineItemExchangeData as ce, type DraftOrderChangesApplied as cf, type OrderChange as cg, type OrderChangeValueOneOf as ch, type LineItemChanges as ci, type LineItemQuantityChange as cj, type LineItemPriceChange as ck, type LineItemProductNameChange as cl, type LineItemDescriptionLineChange as cm, type LineItemModifiersChange as cn, type ManagedLineItem as co, type ManagedDiscount as cp, type TranslatedValue as cq, type LineItemAmount as cr, type ManagedAdditionalFee as cs, type TotalPriceChange as ct, type ShippingInformationChange as cu, type ShippingInformation as cv, type PricesRecalculatedForDestination as cw, type SavedPaymentMethod as cx, type AuthorizedPaymentCreated as cy, type AuthorizedPaymentCaptured as cz, type PreparePaymentCollectionOptions as d, type EntityUpdatedEvent as d$, type CreatedByStringOneOf as d0, type ChannelInfo as d1, type CustomField as d2, type BalanceSummary as d3, type Balance as d4, type CashRounding as d5, type AdditionalFee as d6, type FulfillmentStatusesAggregate as d7, type Tags as d8, type TagList as d9, type V1RestockItem as dA, type OrderImported as dB, type ImportedOrderDeleted as dC, type PaymentStatusUpdated as dD, type FulfillmentStatusUpdated as dE, type OrderCanceledEventOrderCanceled as dF, type OrderDeltasCommitted as dG, type CommittedDiffs as dH, type CommittedDiffsShippingUpdateInfoOneOf as dI, type ItemChangedDetails as dJ, type OrderLineItemChangedDetails as dK, type DecimalQuantityUpdate as dL, type CrossBorderAdjustmentUpdate as dM, type LineItemDelta as dN, type LineItemDeltaDeltaOneOf as dO, type AppliedDiscountDelta as dP, type AppliedDiscountDeltaDeltaOneOf as dQ, type AdditionalFeeDelta as dR, type AdditionalFeeDeltaDeltaOneOf as dS, type DraftOrderCommitSettings as dT, type InventoryUpdateDetails as dU, type TriggerReindexRequest as dV, type TriggerReindexResponse as dW, type DomainEvent as dX, type DomainEventBodyOneOf as dY, type EntityCreatedEvent as dZ, type RestoreInfo as d_, type Location as da, type OrderSettings as db, type OrderSettingsAllowedActionsOneOf as dc, type OrderSettingsEditableByOneOf as dd, type CustomAllowedActions as de, type OwnerApps as df, type FormInfo as dg, type FormIdentifier as dh, type PlatformFeeSummary as di, type PlatformFee as dj, type UpdateInternalDocumentsEvent as dk, type UpdateInternalDocumentsEventOperationOneOf as dl, type InternalDocument as dm, type InternalDocumentUpdateOperation as dn, type DeleteByIdsOperation as dp, type DeleteByFilterOperation as dq, type InternalDocumentUpdateByFilterOperation as dr, type InternalUpdateExistingOperation as ds, type VersionedDocumentUpdateOperation as dt, type VersionedDeleteByIdsOperation as du, type VersionedDocumentId as dv, type OrderApproved as dw, type OrdersExperiments as dx, type OrderRejectedEventOrderRejected as dy, type OrderItemsRestocked as dz, type PreparePaymentCollectionResponse as e, type SiteUndeleted as e$, type EntityDeletedEvent as e0, type ActionEvent as e1, type Empty as e2, type TriggerReindexOrderRequest as e3, type MessageEnvelope as e4, type IdentificationData as e5, type IdentificationDataIdOneOf as e6, type AccountInfo as e7, type ImportOrderRequest as e8, type SetOrderNumberCounterRequest as e9, type RefundDetails as eA, type RefundItem as eB, type LineItemRefund as eC, type AdditionalFeeRefund as eD, type ShippingRefund as eE, type PreviewRefundEmailResponse as eF, type PreviewCancelEmailRequest as eG, type PreviewCancelEmailResponse as eH, type PreviewCancelRefundEmailRequest as eI, type PreviewCancelRefundEmailResponse as eJ, type PreviewBuyerPaymentsReceivedEmailRequest as eK, type PreviewBuyerPaymentsReceivedEmailResponse as eL, type PreviewBuyerConfirmationEmailRequest as eM, type PreviewBuyerConfirmationEmailResponse as eN, type PreviewBuyerPickupConfirmationEmailRequest as eO, type PreviewBuyerPickupConfirmationEmailResponse as eP, type PreviewShippingConfirmationEmailRequest as eQ, type PreviewShippingConfirmationEmailResponse as eR, type PreviewResendDownloadLinksEmailRequest as eS, type PreviewResendDownloadLinksEmailResponse as eT, type MetaSiteSpecialEvent as eU, type MetaSiteSpecialEventPayloadOneOf as eV, type Asset as eW, type SiteCreated as eX, type SiteTransferred as eY, type SiteDeleted as eZ, type DeleteContext as e_, type BulkDeleteImportedOrdersRequest as ea, type SendBuyerConfirmationEmailRequest as eb, type SendBuyerConfirmationEmailResponse as ec, type SendBuyerPaymentsReceivedEmailRequest as ed, type SendBuyerPaymentsReceivedEmailResponse as ee, type SendBuyerPickupConfirmationEmailRequest as ef, type SendBuyerPickupConfirmationEmailResponse as eg, type BulkSendBuyerPickupConfirmationEmailsRequest as eh, type BulkSendBuyerPickupConfirmationEmailsResponse as ei, type SendBuyerShippingConfirmationEmailRequest as ej, type SendBuyerShippingConfirmationEmailResponse as ek, type BulkSendBuyerShippingConfirmationEmailsRequest as el, type BulkSendBuyerShippingConfirmationEmailsResponse as em, type SendMerchantOrderReceivedNotificationRequest as en, type SendMerchantOrderReceivedNotificationResponse as eo, type SendCancelRefundEmailRequest as ep, type SendCancelRefundEmailResponse as eq, type SendRefundEmailRequest as er, type SendRefundEmailResponse as es, type SendFulfillmentEmailRequest as et, type SendFulfillmentEmailResponse as eu, type SendMerchantOrderReceivedPushRequest as ev, type SendMerchantOrderReceivedPushResponse as ew, type PreviewEmailByTypeRequest as ex, type PreviewEmailByTypeResponse as ey, type PreviewRefundEmailRequest as ez, type PreparePaymentCollectionApplicationErrors as f, type RestockItem as f$, type SitePublished as f0, type SiteUnpublished as f1, type SiteMarkedAsTemplate as f2, type SiteMarkedAsWixSite as f3, type ServiceProvisioned as f4, type ServiceRemoved as f5, type SiteRenamed as f6, type SiteHardDeleted as f7, type NamespaceChanged as f8, type StudioAssigned as f9, type RecordManuallyCollectedPaymentRequest as fA, type UserDefinedPaymentMethodName as fB, type UserDefinedPaymentMethodNameKindOneOf as fC, type RecordManuallyCollectedPaymentResponse as fD, type MarkOrderAsPaidRequest as fE, type MarkOrderAsPaidResponse as fF, type BulkMarkOrdersAsPaidRequest as fG, type BulkMarkOrdersAsPaidResponse as fH, type BulkOrderResult as fI, type ItemMetadata as fJ, type ApplicationError as fK, type BulkActionMetadata as fL, type GetRefundabilityStatusRequest as fM, type GetRefundabilityStatusResponse as fN, type Refundability as fO, type RefundabilityAdditionalRefundabilityInfoOneOf as fP, type CreatePaymentGatewayOrderRequest as fQ, type ChargedBy as fR, type CreatePaymentGatewayOrderResponse as fS, type ChargeMembershipsRequest as fT, type MembershipChargeItem as fU, type MembershipName as fV, type ChargeMembershipsResponse as fW, type TriggerRefundRequest as fX, type PaymentRefund as fY, type RefundSideEffects as fZ, type RestockInfo as f_, type StudioUnassigned as fa, type SiteUrlChanged as fb, type SitePurgedExternally as fc, type OdeditorAssigned as fd, type OdeditorUnassigned as fe, type PicassoAssigned as ff, type PicassoUnassigned as fg, type WixelAssigned as fh, type WixelUnassigned as fi, type StudioTwoAssigned as fj, type StudioTwoUnassigned as fk, type UserDomainMediaEnabled as fl, type UserDomainMediaDisabled as fm, type EditorlessAssigned as fn, type EditorlessUnassigned as fo, type HasCustomEmailConfigurationsRequest as fp, type HasCustomEmailConfigurationsResponse as fq, type AddToAutomationMigrationPopulationRequest as fr, type AddToAutomationMigrationPopulationResponse as fs, type IsInAutomationMigrationPopulationRequest as ft, type IsInAutomationMigrationPopulationResponse as fu, type PreparePaymentCollectionRequest as fv, type RedirectUrls as fw, type DelayedCaptureSettings as fx, type Duration as fy, type GetPaymentCollectabilityStatusRequest as fz, type VoidAuthorizedPaymentsApplicationErrors as g, type CreateOrderRequest as g$, type TriggerRefundResponse as g0, type OrderTransactions as g1, type Payment as g2, type PaymentPaymentDetailsOneOf as g3, type PaymentReceiptInfoOneOf as g4, type PaymentStatusDetailsOneOf as g5, type RegularPaymentDetails as g6, type RegularPaymentDetailsPaymentMethodDetailsOneOf as g7, type CreditCardPaymentMethodDetails as g8, type AuthorizationDetails as g9, type CalculateRefundItemResponse as gA, type VoidAuthorizedPaymentsRequest as gB, type CaptureAuthorizedPaymentsRequest as gC, type ChargeSavedPaymentMethodRequest as gD, type ChargeSavedPaymentMethodResponse as gE, type V1TriggerReindexRequest as gF, type V1TriggerReindexResponse as gG, type V1TriggerReindexOrderRequest as gH, type DiffmatokyPayload as gI, type ErrorInformation as gJ, type GetOrderRequest as gK, type GetOrderResponse as gL, type InternalQueryOrdersRequest as gM, type PlatformQuery as gN, type PlatformQueryPagingMethodOneOf as gO, type Sorting as gP, type PlatformPaging as gQ, type CursorPaging as gR, type InternalQueryOrdersResponse as gS, type PlatformPagingMetadata as gT, type Cursors as gU, type QueryOrderRequest as gV, type QueryOrderResponse as gW, type SearchOrdersRequest as gX, type CursorSearch as gY, type CursorSearchPagingMethodOneOf as gZ, type CursorPagingMetadata as g_, type AuthorizationCapture as ga, type AuthorizationActionFailureDetails as gb, type AuthorizationVoid as gc, type V1ScheduledAction as gd, type Chargeback as ge, type PaymentMethodName as gf, type GiftCardPaymentDetails as gg, type MembershipPaymentDetails as gh, type FutureMembershipDetails as gi, type WixReceiptInfo as gj, type ExternalReceiptInfo as gk, type CashRoundingDetails as gl, type CanceledStatusDetails as gm, type DeclinedStatusDetails as gn, type VoidedStatusDetails as go, type PaymentStatusDetails as gp, type PaymentStatusDetailsStatusDetailsOneOf as gq, type Refund as gr, type RefundTransaction as gs, type RefundStatusInfo as gt, type AggregatedRefundSummary as gu, type RefundItemsBreakdown as gv, type LineItemRefundSummary as gw, type CalculateRefundRequest as gx, type CalculateRefundItemRequest as gy, type CalculateRefundResponse as gz, type PaymentCapture as h, type OrderRejected as h$, type OrderCreationSettings as h0, type OrderCreationSettingsEditableByOneOf as h1, type OrderCreateNotifications as h2, type CreateOrderResponse as h3, type UpdateOrderRequest as h4, type UpdateOrderResponse as h5, type BulkUpdateOrdersRequest as h6, type CommitDeltasRequest as h7, type DraftOrderDiffs as h8, type DraftOrderDiffsShippingUpdateInfoOneOf as h9, type UpdateBillingContactDetailsResponse as hA, type UpdateOrderLineItemRequest as hB, type UpdateOrderLineItemResponse as hC, type UpdateOrderLineItemsRequest as hD, type MaskedOrderLineItem as hE, type UpdateOrderLineItemsResponse as hF, type AddInternalActivityRequest as hG, type InternalActivity as hH, type InternalActivityContentOneOf as hI, type OrderPlaced as hJ, type OrderPaid as hK, type OrderFulfilled as hL, type OrderNotFulfilled as hM, type OrderCanceled as hN, type DownloadLinkSent as hO, type TrackingNumberAdded as hP, type TrackingNumberEdited as hQ, type TrackingLinkAdded as hR, type ShippingConfirmationEmailSent as hS, type InvoiceAdded as hT, type InvoiceSent as hU, type FulfillerEmailSent as hV, type ShippingAddressEdited as hW, type EmailEdited as hX, type PickupReadyEmailSent as hY, type OrderPartiallyPaid as hZ, type OrderPending as h_, type DraftOrderDiffsBuyerUpdateInfoOneOf as ha, type DraftOrderDiffsBillingUpdateInfoOneOf as hb, type DraftOrderDiffsRecipientUpdateInfoOneOf as hc, type V1LineItemDelta as hd, type V1LineItemDeltaDeltaOneOf as he, type CommitDeltasResponse as hf, type ArchiveOrderRequest as hg, type ArchiveOrderResponse as hh, type BulkArchiveOrdersRequest as hi, type BulkArchiveOrdersResponse as hj, type BulkArchiveOrdersByFilterRequest as hk, type BulkArchiveOrdersByFilterResponse as hl, type UnArchiveOrderRequest as hm, type UnArchiveOrderResponse as hn, type BulkUnArchiveOrdersRequest as ho, type BulkUnArchiveOrdersResponse as hp, type BulkUnArchiveOrdersByFilterRequest as hq, type BulkUnArchiveOrdersByFilterResponse as hr, type UpdateBuyerInfoRequest as hs, type BuyerInfoUpdate as ht, type UpdateBuyerInfoResponse as hu, type UpdateBuyerEmailRequest as hv, type UpdateBuyerEmailResponse as hw, type UpdateOrderShippingAddressRequest as hx, type UpdateOrderShippingAddressResponse as hy, type UpdateBillingContactDetailsRequest as hz, type CaptureAuthorizedPaymentsApplicationErrors as i, type InvoiceFields as i$, type AddInternalActivityResponse as i0, type AddActivityRequest as i1, type PublicActivity as i2, type PublicActivityContentOneOf as i3, type AddActivityResponse as i4, type AddActivitiesRequest as i5, type UpdateActivityRequest as i6, type UpdateActivityResponse as i7, type DeleteActivityRequest as i8, type DeleteActivityResponse as i9, type V1MarkOrderAsPaidResponse as iA, type V1BulkMarkOrdersAsPaidRequest as iB, type V1BulkMarkOrdersAsPaidResponse as iC, type V1CreatePaymentGatewayOrderRequest as iD, type V1CreatePaymentGatewayOrderResponse as iE, type GetShipmentsRequest as iF, type GetShipmentsResponse as iG, type AggregateOrdersRequest as iH, type AggregateOrdersResponse as iI, type DecrementItemsQuantityRequest as iJ, type DecrementData as iK, type DecrementItemsQuantityResponse as iL, type BulkUpdateOrderTagsRequest as iM, type TagsTags as iN, type TagsTagList as iO, type BulkUpdateOrderTagsResult as iP, type SendOrderUpdatedDomainEventRequest as iQ, type SendOrderUpdatedDomainEventResponse as iR, type Task as iS, type TaskKey as iT, type TaskAction as iU, type TaskActionActionOneOf as iV, type Complete as iW, type Cancel as iX, type Reschedule as iY, type InvoiceSentEvent as iZ, type IdAndVersion as i_, type UpdateLineItemsDescriptionLinesRequest as ia, type LineItemUpdate as ib, type UpdateLineItemsDescriptionLinesResponse as ic, type MarkOrderAsSeenByHumanRequest as id, type MarkOrderAsSeenByHumanResponse as ie, type CancelOrderRequest as ig, type UpdateOrderStatusRequest as ih, type UpdateOrderStatusResponse as ii, type MarkAsFulfilledRequest as ij, type MarkAsFulfilledResponse as ik, type BulkMarkAsFulfilledRequest as il, type BulkMarkAsFulfilledResponse as im, type BulkMarkAsFulfilledByFilterRequest as io, type BulkMarkAsFulfilledByFilterResponse as ip, type MarkAsUnfulfilledRequest as iq, type MarkAsUnfulfilledResponse as ir, type BulkMarkAsUnfulfilledRequest as is, type BulkMarkAsUnfulfilledResponse as it, type BulkMarkAsUnfulfilledByFilterRequest as iu, type BulkMarkAsUnfulfilledByFilterResponse as iv, type BulkSetBusinessLocationRequest as iw, type BulkSetBusinessLocationResponse as ix, type BulkSetBusinessLocationResult as iy, type V1MarkOrderAsPaidRequest as iz, type GetOrderApplicationErrors as j, type PickupMethodWithLiterals as j$, type Customer as j0, type Email as j1, type QuotesAddress as j2, type AddressDescription as j3, type Phone as j4, type Company as j5, type CommonAddress as j6, type CommonAddressStreetOneOf as j7, type Subdivision as j8, type StandardDetails as j9, type PaymentCollectionMarkOrderAsPaidOptions as jA, type PaymentCollectionCreatePaymentGatewayOrderOptions as jB, type ChargeMembershipsOptions as jC, type TriggerRefundOptions as jD, type OrderSearchSpec as jE, type UpdateOrderLineItemIdentifiers as jF, type UpdateOrderLineItem as jG, type UpdateActivityIdentifiers as jH, type DeleteActivityIdentifiers as jI, type AggregateOrdersOptions as jJ, utils as jK, type DescriptionLineTypeWithLiterals as jL, type DimensionsUnitWithLiterals as jM, type ItemTypePresetWithLiterals as jN, type PaymentOptionTypeWithLiterals as jO, type JurisdictionTypeWithLiterals as jP, type SubscriptionFrequencyWithLiterals as jQ, type ProductPeriodAlignmentWithLiterals as jR, type AdjustmentTypeWithLiterals as jS, type TaxableAddressTypeWithLiterals as jT, type MeasurementUnitWithLiterals as jU, type RepriceStatusWithLiterals as jV, type BaseRateSourceWithLiterals as jW, type PaymentStatusEnumPaymentStatusWithLiterals as jX, type FulfillmentStatusWithLiterals as jY, type WeightUnitWithLiterals as jZ, type VatTypeWithLiterals as j_, type ShippingContactDetails as ja, type InvoiceDates as jb, type LineItems as jc, type LineItem as jd, type BigDecimalWrapper as je, type LineItemTax as jf, type Source as jg, type LineItemMetaData as jh, type Locale as ji, type TotalPrice as jj, type ItemizedFee as jk, type Discount as jl, type DiscountOneDiscountTypeOneOf as jm, type CalculatedTaxes as jn, type CalculatedTax as jo, type Payments as jp, type InvoicesPayment as jq, type MetaData as jr, type InvoiceDynamicPriceTotals as js, type CustomFieldValue as jt, type Value as ju, type Deposit as jv, type BaseEventMetadata as jw, type EventMetadata as jx, type AccountInfoMetadata as jy, type RecordManuallyCollectedPaymentOptions as jz, type OrderSearch as k, onOrderCreated as k$, type OrderStatusWithLiterals as k0, type CrossBorderNotApplicableReasonWithLiterals as k1, type CrossBorderRepricingModeWithLiterals as k2, type DiscountTypeWithLiterals as k3, type DiscountValueTypeWithLiterals as k4, type DiscountReasonWithLiterals as k5, type LineItemQuantityChangeTypeWithLiterals as k6, type ActivityTypeWithLiterals as k7, type OrderActivityTypeEnumActivityTypeWithLiterals as k8, type AttributionSourceWithLiterals as k9, type ReasonWithLiterals as kA, type ActionTypeWithLiterals as kB, type ChargebackStatusWithLiterals as kC, type MembershipPaymentStatusWithLiterals as kD, type PaymentStatusWithLiterals as kE, type CanceledReasonWithLiterals as kF, type DeclinedReasonWithLiterals as kG, type VoidedReasonWithLiterals as kH, type RefundStatusWithLiterals as kI, type SortOrderWithLiterals as kJ, type OrderApprovalStrategyWithLiterals as kK, type PlacementWithLiterals as kL, type SubdivisionTypeWithLiterals as kM, type SourceTypeWithLiterals as kN, type CustomFieldGroupWithLiterals as kO, type ValueTypeWithLiterals as kP, type DepositTypeWithLiterals as kQ, type InvoiceStatusWithLiterals as kR, type RecordManuallyCollectedPaymentApplicationErrors as kS, type PaymentCollectionMarkOrderAsPaidApplicationErrors as kT, type PaymentCollectionCreatePaymentGatewayOrderApplicationErrors as kU, type TriggerRefundApplicationErrors as kV, type UpdateOrderStatusApplicationErrors as kW, type CommonSearchWithEntityContext as kX, onOrderApproved as kY, onOrderCanceled as kZ, onOrderCommitted as k_, type ChannelTypeWithLiterals as ka, type AdditionalFeeSourceWithLiterals as kb, type OrderActionTypeWithLiterals as kc, type SpecificItemsCouponBehaviorWithLiterals as kd, type ChargeTypeWithLiterals as ke, type VersioningModeWithLiterals as kf, type DeltaPaymentOptionTypeWithLiterals as kg, type InventoryActionWithLiterals as kh, type WebhookIdentityTypeWithLiterals as ki, type PreviewEmailTypeWithLiterals as kj, type StateWithLiterals as kk, type SiteCreatedContextWithLiterals as kl, type NamespaceWithLiterals as km, type DeleteStatusWithLiterals as kn, type OriginWithLiterals as ko, type ScheduledActionWithLiterals as kp, type DurationUnitWithLiterals as kq, type PaymentCollectabilityStatusWithLiterals as kr, type PredefinedPaymentMethodWithLiterals as ks, type RefundableStatusWithLiterals as kt, type NonRefundableReasonWithLiterals as ku, type ManuallyRefundableReasonWithLiterals as kv, type RestockTypeWithLiterals as kw, type TransactionStatusWithLiterals as kx, type AuthorizationCaptureStatusWithLiterals as ky, type AuthorizationVoidStatusWithLiterals as kz, type SearchOrdersResponse as l, onOrderFulfilled as l0, onOrderImported as l1, onOrderImportedOrderDeleted as l2, onOrderPaymentStatusUpdated as l3, onOrderUpdated as l4, importOrder as l5, setOrderNumberCounter as l6, bulkDeleteImportedOrders as l7, preparePaymentCollection as l8, getPaymentCollectabilityStatus as l9, voidAuthorizedPayments as la, captureAuthorizedPayments as lb, getOrder as lc, createOrder as ld, updateOrder as le, bulkUpdateOrders as lf, addActivities as lg, cancelOrder as lh, bulkUpdateOrderTags as li, type CreateOrderOptions as m, type CreateOrderApplicationErrors as n, type UpdateOrderApplicationErrors as o, type BulkUpdateOrdersOptions as p, type BulkUpdateOrdersResponse as q, type AddActivitiesResponse as r, type CancelOrderOptions as s, type CancelOrderResponse as t, type CancelOrderApplicationErrors as u, type BulkUpdateOrderTagsOptions as v, type BulkUpdateOrderTagsResponse as w, type OrderApprovedEnvelope as x, type OrderCanceledEnvelope as y, type OrderCommittedEnvelope as z };