@wix/auto_sdk_ecom_orders 1.0.251 → 1.0.252

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