@wix/auto_sdk_ecom_orders 1.0.272 → 1.0.273

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