@wix/auto_sdk_ecom_orders 1.0.251 → 1.0.252
This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
- package/build/cjs/{ecom-v1-order-orders.universal-Dyxd-jx1.d.ts → ecom-v1-order-orders.universal-Cc8IUoG2.d.ts} +1789 -1768
- package/build/cjs/index.d.ts +2 -2
- package/build/cjs/index.js +81 -81
- package/build/cjs/index.js.map +1 -1
- package/build/cjs/index.typings.d.ts +2 -2
- package/build/cjs/index.typings.js +81 -81
- package/build/cjs/index.typings.js.map +1 -1
- package/build/cjs/meta.d.ts +1790 -1769
- package/build/cjs/meta.js +81 -81
- package/build/cjs/meta.js.map +1 -1
- package/build/es/{ecom-v1-order-orders.universal-Dyxd-jx1.d.mts → ecom-v1-order-orders.universal-Cc8IUoG2.d.mts} +1789 -1768
- package/build/es/index.d.mts +2 -2
- package/build/es/index.mjs +81 -81
- package/build/es/index.mjs.map +1 -1
- package/build/es/index.typings.d.mts +2 -2
- package/build/es/index.typings.mjs +81 -81
- package/build/es/index.typings.mjs.map +1 -1
- package/build/es/meta.d.mts +1790 -1769
- package/build/es/meta.mjs +81 -81
- package/build/es/meta.mjs.map +1 -1
- package/build/internal/cjs/{ecom-v1-order-orders.universal-DBd4Vc1m.d.ts → ecom-v1-order-orders.universal-Cikj7dUx.d.ts} +1823 -1802
- package/build/internal/cjs/index.d.ts +2 -2
- package/build/internal/cjs/index.js +81 -81
- package/build/internal/cjs/index.js.map +1 -1
- package/build/internal/cjs/index.typings.d.ts +2 -2
- package/build/internal/cjs/index.typings.js +81 -81
- package/build/internal/cjs/index.typings.js.map +1 -1
- package/build/internal/cjs/meta.d.ts +1790 -1769
- package/build/internal/cjs/meta.js +81 -81
- package/build/internal/cjs/meta.js.map +1 -1
- package/build/internal/es/{ecom-v1-order-orders.universal-DBd4Vc1m.d.mts → ecom-v1-order-orders.universal-Cikj7dUx.d.mts} +1823 -1802
- package/build/internal/es/index.d.mts +2 -2
- package/build/internal/es/index.mjs +81 -81
- package/build/internal/es/index.mjs.map +1 -1
- package/build/internal/es/index.typings.d.mts +2 -2
- package/build/internal/es/index.typings.mjs +81 -81
- package/build/internal/es/index.typings.mjs.map +1 -1
- package/build/internal/es/meta.d.mts +1790 -1769
- package/build/internal/es/meta.mjs +81 -81
- package/build/internal/es/meta.mjs.map +1 -1
- package/package.json +2 -2
package/build/es/meta.d.mts
CHANGED
|
@@ -1,4 +1,4 @@
|
|
|
1
|
-
import {
|
|
1
|
+
import { dG as ImportOrderRequest$1, dH as ImportOrderResponse$1, dI as SetOrderNumberCounterRequest$1, dJ as SetOrderNumberCounterResponse$1, dK as BulkDeleteImportedOrdersRequest$1, dL as BulkDeleteImportedOrdersResponse$1, dP as PreparePaymentCollectionRequest$1, b as PreparePaymentCollectionResponse$1, dT as GetPaymentCollectabilityStatusRequest$1, G as GetPaymentCollectabilityStatusResponse$1, dU as RecordManuallyCollectedPaymentRequest$1, dX as RecordManuallyCollectedPaymentResponse$1, dY as MarkOrderAsPaidRequest$1, dZ as MarkOrderAsPaidResponse$1, d_ as BulkMarkOrdersAsPaidRequest$1, d$ as BulkMarkOrdersAsPaidResponse$1, e4 as GetRefundabilityStatusRequest$1, e5 as GetRefundabilityStatusResponse$1, e8 as CreatePaymentGatewayOrderRequest$1, ea as CreatePaymentGatewayOrderResponse$1, eb as ChargeMembershipsRequest$1, ef as ChargeMembershipsResponse$1, eg as TriggerRefundRequest$1, eq as TriggerRefundResponse$1, eU as VoidAuthorizedPaymentsRequest$1, V as VoidAuthorizedPaymentsResponse$1, eV as CaptureAuthorizedPaymentsRequest$1, C as CaptureAuthorizedPaymentsResponse$1, gd as GetOrderRequest$1, ge as GetOrderResponse$1, gq as SearchOrdersRequest$1, S as SearchOrdersResponse$1, gu as CreateOrderRequest$1, gy as CreateOrderResponse$1, gz as UpdateOrderRequest$1, gA as UpdateOrderResponse$1, gB as BulkUpdateOrdersRequest$1, l as BulkUpdateOrdersResponse$1, h4 as UpdateOrderLineItemRequest$1, h5 as UpdateOrderLineItemResponse$1, hw as AddActivityRequest$1, hz as AddActivityResponse$1, hA as AddActivitiesRequest$1, m as AddActivitiesResponse$1, hB as UpdateActivityRequest$1, hC as UpdateActivityResponse$1, hD as DeleteActivityRequest$1, hE as DeleteActivityResponse$1, hK as CancelOrderRequest$1, o as CancelOrderResponse$1, hL as UpdateOrderStatusRequest$1, hM as UpdateOrderStatusResponse$1, i8 as AggregateOrdersRequest$1, i9 as AggregateOrdersResponse$1, id as BulkUpdateOrderTagsRequest$1, r as BulkUpdateOrderTagsResponse$1 } from './ecom-v1-order-orders.universal-Cc8IUoG2.mjs';
|
|
2
2
|
import '@wix/sdk-types';
|
|
3
3
|
|
|
4
4
|
/**
|
|
@@ -3104,6 +3104,141 @@ declare enum ChargeType {
|
|
|
3104
3104
|
}
|
|
3105
3105
|
/** @enumType */
|
|
3106
3106
|
type ChargeTypeWithLiterals = ChargeType | 'PASS_ON' | 'ABSORBED';
|
|
3107
|
+
interface UpdateInternalDocumentsEvent extends UpdateInternalDocumentsEventOperationOneOf {
|
|
3108
|
+
/** insert/update documents */
|
|
3109
|
+
update?: InternalDocumentUpdateOperation;
|
|
3110
|
+
/** delete by document ids */
|
|
3111
|
+
deleteByIds?: DeleteByIdsOperation;
|
|
3112
|
+
/** delete documents matching filter */
|
|
3113
|
+
deleteByFilter?: DeleteByFilterOperation;
|
|
3114
|
+
/** update internal documents matching filter */
|
|
3115
|
+
updateByFilter?: InternalDocumentUpdateByFilterOperation;
|
|
3116
|
+
/** update only existing documents */
|
|
3117
|
+
updateExisting?: InternalUpdateExistingOperation;
|
|
3118
|
+
/** insert/update documents with versioning */
|
|
3119
|
+
versionedUpdate?: VersionedDocumentUpdateOperation;
|
|
3120
|
+
/** delete by document ids with versioning */
|
|
3121
|
+
versionedDeleteByIds?: VersionedDeleteByIdsOperation;
|
|
3122
|
+
/**
|
|
3123
|
+
* type of the documents
|
|
3124
|
+
* @minLength 2
|
|
3125
|
+
*/
|
|
3126
|
+
documentType?: string;
|
|
3127
|
+
/**
|
|
3128
|
+
* language of the documents (mandatory)
|
|
3129
|
+
* @minLength 2
|
|
3130
|
+
*/
|
|
3131
|
+
language?: string | null;
|
|
3132
|
+
/**
|
|
3133
|
+
* one or more search documents
|
|
3134
|
+
* @deprecated
|
|
3135
|
+
*/
|
|
3136
|
+
addDocuments?: InternalDocument[];
|
|
3137
|
+
/**
|
|
3138
|
+
* one or more ids of indexed documents to be removed. Removal will happen before addition (if both provided)
|
|
3139
|
+
* @deprecated
|
|
3140
|
+
*/
|
|
3141
|
+
removeDocumentIds?: string[];
|
|
3142
|
+
/** id to pass to processing notification */
|
|
3143
|
+
correlationId?: string | null;
|
|
3144
|
+
/** when event was created / issued */
|
|
3145
|
+
issuedAt?: Date | null;
|
|
3146
|
+
}
|
|
3147
|
+
/** @oneof */
|
|
3148
|
+
interface UpdateInternalDocumentsEventOperationOneOf {
|
|
3149
|
+
/** insert/update documents */
|
|
3150
|
+
update?: InternalDocumentUpdateOperation;
|
|
3151
|
+
/** delete by document ids */
|
|
3152
|
+
deleteByIds?: DeleteByIdsOperation;
|
|
3153
|
+
/** delete documents matching filter */
|
|
3154
|
+
deleteByFilter?: DeleteByFilterOperation;
|
|
3155
|
+
/** update internal documents matching filter */
|
|
3156
|
+
updateByFilter?: InternalDocumentUpdateByFilterOperation;
|
|
3157
|
+
/** update only existing documents */
|
|
3158
|
+
updateExisting?: InternalUpdateExistingOperation;
|
|
3159
|
+
/** insert/update documents with versioning */
|
|
3160
|
+
versionedUpdate?: VersionedDocumentUpdateOperation;
|
|
3161
|
+
/** delete by document ids with versioning */
|
|
3162
|
+
versionedDeleteByIds?: VersionedDeleteByIdsOperation;
|
|
3163
|
+
}
|
|
3164
|
+
interface InternalDocument {
|
|
3165
|
+
/** document with mandatory fields (id) and with fields specific to the type of the document */
|
|
3166
|
+
document?: Record<string, any> | null;
|
|
3167
|
+
}
|
|
3168
|
+
interface InternalDocumentUpdateOperation {
|
|
3169
|
+
/** documents to index or update */
|
|
3170
|
+
documents?: InternalDocument[];
|
|
3171
|
+
}
|
|
3172
|
+
interface DeleteByIdsOperation {
|
|
3173
|
+
/** ids of the documents to delete */
|
|
3174
|
+
documentIds?: string[];
|
|
3175
|
+
/**
|
|
3176
|
+
* tenant id for custom tenancy strategy
|
|
3177
|
+
* @minLength 2
|
|
3178
|
+
* @maxLength 300
|
|
3179
|
+
*/
|
|
3180
|
+
tenantId?: string | null;
|
|
3181
|
+
}
|
|
3182
|
+
interface DeleteByFilterOperation {
|
|
3183
|
+
/** documents matching this filter wil be deleted. only filterable documents defined in document_type can be used for filtering */
|
|
3184
|
+
filter?: Record<string, any> | null;
|
|
3185
|
+
/**
|
|
3186
|
+
* tenant id for custom tenancy strategy
|
|
3187
|
+
* @minLength 2
|
|
3188
|
+
* @maxLength 300
|
|
3189
|
+
*/
|
|
3190
|
+
tenantId?: string | null;
|
|
3191
|
+
}
|
|
3192
|
+
interface InternalDocumentUpdateByFilterOperation {
|
|
3193
|
+
/** documents matching this filter will be updated */
|
|
3194
|
+
filter?: Record<string, any> | null;
|
|
3195
|
+
/** partial document to apply */
|
|
3196
|
+
document?: InternalDocument;
|
|
3197
|
+
/**
|
|
3198
|
+
* tenant id for custom tenancy strategy
|
|
3199
|
+
* @minLength 2
|
|
3200
|
+
* @maxLength 300
|
|
3201
|
+
*/
|
|
3202
|
+
tenantId?: string | null;
|
|
3203
|
+
}
|
|
3204
|
+
interface InternalUpdateExistingOperation {
|
|
3205
|
+
/** documents to update */
|
|
3206
|
+
documents?: InternalDocument[];
|
|
3207
|
+
}
|
|
3208
|
+
interface VersionedDocumentUpdateOperation {
|
|
3209
|
+
/** documents to create or overwrite */
|
|
3210
|
+
documents?: InternalDocument[];
|
|
3211
|
+
/** versioning mode to use instead of default */
|
|
3212
|
+
versioningMode?: VersioningModeWithLiterals;
|
|
3213
|
+
}
|
|
3214
|
+
declare enum VersioningMode {
|
|
3215
|
+
/** use default versioning mode agreed with search team */
|
|
3216
|
+
DEFAULT = "DEFAULT",
|
|
3217
|
+
/** execute only if version is greater than existing */
|
|
3218
|
+
GREATER_THAN = "GREATER_THAN",
|
|
3219
|
+
/** execute only if version is greater or equal to existing */
|
|
3220
|
+
GREATER_OR_EQUAL = "GREATER_OR_EQUAL"
|
|
3221
|
+
}
|
|
3222
|
+
/** @enumType */
|
|
3223
|
+
type VersioningModeWithLiterals = VersioningMode | 'DEFAULT' | 'GREATER_THAN' | 'GREATER_OR_EQUAL';
|
|
3224
|
+
interface VersionedDeleteByIdsOperation {
|
|
3225
|
+
/** ids with version of the documents to delete */
|
|
3226
|
+
documentIds?: VersionedDocumentId[];
|
|
3227
|
+
/**
|
|
3228
|
+
* tenant id for custom tenancy strategy
|
|
3229
|
+
* @minLength 2
|
|
3230
|
+
* @maxLength 300
|
|
3231
|
+
*/
|
|
3232
|
+
tenantId?: string | null;
|
|
3233
|
+
}
|
|
3234
|
+
interface VersionedDocumentId {
|
|
3235
|
+
/** document id */
|
|
3236
|
+
documentId?: string;
|
|
3237
|
+
/** document version */
|
|
3238
|
+
version?: string;
|
|
3239
|
+
/** versioning mode to use instead of default */
|
|
3240
|
+
versioningMode?: VersioningModeWithLiterals;
|
|
3241
|
+
}
|
|
3107
3242
|
/** Triggered when the order status changes to approved */
|
|
3108
3243
|
interface OrderApproved {
|
|
3109
3244
|
/** The order that was updated */
|
|
@@ -3404,50 +3539,17 @@ declare enum InventoryAction {
|
|
|
3404
3539
|
}
|
|
3405
3540
|
/** @enumType */
|
|
3406
3541
|
type InventoryActionWithLiterals = InventoryAction | 'RESTOCK' | 'DECREASE';
|
|
3407
|
-
interface
|
|
3408
|
-
/**
|
|
3409
|
-
|
|
3410
|
-
* If order.order_settings.order_type and order.order_settings.custom_order_type not set than VIEW_ONLY will be used
|
|
3411
|
-
*/
|
|
3412
|
-
order: Order;
|
|
3413
|
-
}
|
|
3414
|
-
interface ImportOrderResponse {
|
|
3415
|
-
order?: Order;
|
|
3416
|
-
}
|
|
3417
|
-
/** Set Order number counter request */
|
|
3418
|
-
interface SetOrderNumberCounterRequest {
|
|
3419
|
-
/**
|
|
3420
|
-
* Order number counter to set.
|
|
3421
|
-
* Counter will be used as start of number sequence and used as order number with increment
|
|
3422
|
-
* @max 999999999
|
|
3423
|
-
*/
|
|
3424
|
-
counter: string;
|
|
3425
|
-
/** Whether to allow setting a lower counter than current value */
|
|
3426
|
-
allowLowerCounter?: boolean;
|
|
3427
|
-
}
|
|
3428
|
-
interface SetOrderNumberCounterResponse {
|
|
3429
|
-
/** Order number counter before update */
|
|
3430
|
-
oldCounter?: string;
|
|
3431
|
-
/** Order number counter after update */
|
|
3432
|
-
newCounter?: string;
|
|
3433
|
-
}
|
|
3434
|
-
/** Bulk Delete Imported Orders Messages */
|
|
3435
|
-
interface BulkDeleteImportedOrdersRequest {
|
|
3542
|
+
interface TriggerReindexRequest {
|
|
3543
|
+
/** @format GUID */
|
|
3544
|
+
metasiteId?: string;
|
|
3436
3545
|
/**
|
|
3437
|
-
*
|
|
3438
|
-
*
|
|
3439
|
-
* @
|
|
3440
|
-
* @minSize 1
|
|
3441
|
-
* @maxSize 1000
|
|
3546
|
+
* @minLength 1
|
|
3547
|
+
* @maxLength 100
|
|
3548
|
+
* @maxSize 100
|
|
3442
3549
|
*/
|
|
3443
|
-
orderIds
|
|
3550
|
+
orderIds?: string[];
|
|
3444
3551
|
}
|
|
3445
|
-
interface
|
|
3446
|
-
/**
|
|
3447
|
-
* Job ID for async operation tracking. Pass to [Get Async Job](https://dev.wix.com/docs/rest/business-management/async-job/get-async-job) or [List Async Job Items](https://dev.wix.com/docs/rest/business-management/async-job/list-async-job-items) to retrieve details and metadata
|
|
3448
|
-
* @format GUID
|
|
3449
|
-
*/
|
|
3450
|
-
jobId?: string;
|
|
3552
|
+
interface TriggerReindexResponse {
|
|
3451
3553
|
}
|
|
3452
3554
|
interface DomainEvent extends DomainEventBodyOneOf {
|
|
3453
3555
|
createdEvent?: EntityCreatedEvent;
|
|
@@ -3513,6 +3615,17 @@ interface EntityDeletedEvent {
|
|
|
3513
3615
|
interface ActionEvent {
|
|
3514
3616
|
bodyAsJson?: string;
|
|
3515
3617
|
}
|
|
3618
|
+
interface Empty {
|
|
3619
|
+
}
|
|
3620
|
+
interface TriggerReindexOrderRequest {
|
|
3621
|
+
/** @format GUID */
|
|
3622
|
+
metasiteId?: string;
|
|
3623
|
+
/**
|
|
3624
|
+
* @minLength 1
|
|
3625
|
+
* @maxLength 100
|
|
3626
|
+
*/
|
|
3627
|
+
orderId?: string;
|
|
3628
|
+
}
|
|
3516
3629
|
interface MessageEnvelope {
|
|
3517
3630
|
/**
|
|
3518
3631
|
* App instance ID.
|
|
@@ -3604,142 +3717,52 @@ interface AccountInfo {
|
|
|
3604
3717
|
*/
|
|
3605
3718
|
siteId?: string | null;
|
|
3606
3719
|
}
|
|
3607
|
-
interface
|
|
3608
|
-
/** insert/update documents */
|
|
3609
|
-
update?: InternalDocumentUpdateOperation;
|
|
3610
|
-
/** delete by document ids */
|
|
3611
|
-
deleteByIds?: DeleteByIdsOperation;
|
|
3612
|
-
/** delete documents matching filter */
|
|
3613
|
-
deleteByFilter?: DeleteByFilterOperation;
|
|
3614
|
-
/** update internal documents matching filter */
|
|
3615
|
-
updateByFilter?: InternalDocumentUpdateByFilterOperation;
|
|
3616
|
-
/** update only existing documents */
|
|
3617
|
-
updateExisting?: InternalUpdateExistingOperation;
|
|
3618
|
-
/** insert/update documents with versioning */
|
|
3619
|
-
versionedUpdate?: VersionedDocumentUpdateOperation;
|
|
3620
|
-
/** delete by document ids with versioning */
|
|
3621
|
-
versionedDeleteByIds?: VersionedDeleteByIdsOperation;
|
|
3720
|
+
interface ImportOrderRequest {
|
|
3622
3721
|
/**
|
|
3623
|
-
*
|
|
3624
|
-
*
|
|
3722
|
+
* Order to be imported
|
|
3723
|
+
* If order.order_settings.order_type and order.order_settings.custom_order_type not set than VIEW_ONLY will be used
|
|
3625
3724
|
*/
|
|
3626
|
-
|
|
3725
|
+
order: Order;
|
|
3726
|
+
}
|
|
3727
|
+
interface ImportOrderResponse {
|
|
3728
|
+
order?: Order;
|
|
3729
|
+
}
|
|
3730
|
+
/** Set Order number counter request */
|
|
3731
|
+
interface SetOrderNumberCounterRequest {
|
|
3627
3732
|
/**
|
|
3628
|
-
*
|
|
3629
|
-
*
|
|
3733
|
+
* Order number counter to set.
|
|
3734
|
+
* Counter will be used as start of number sequence and used as order number with increment
|
|
3735
|
+
* @max 999999999
|
|
3630
3736
|
*/
|
|
3631
|
-
|
|
3737
|
+
counter: string;
|
|
3738
|
+
/** Whether to allow setting a lower counter than current value */
|
|
3739
|
+
allowLowerCounter?: boolean;
|
|
3740
|
+
}
|
|
3741
|
+
interface SetOrderNumberCounterResponse {
|
|
3742
|
+
/** Order number counter before update */
|
|
3743
|
+
oldCounter?: string;
|
|
3744
|
+
/** Order number counter after update */
|
|
3745
|
+
newCounter?: string;
|
|
3746
|
+
}
|
|
3747
|
+
/** Bulk Delete Imported Orders Messages */
|
|
3748
|
+
interface BulkDeleteImportedOrdersRequest {
|
|
3632
3749
|
/**
|
|
3633
|
-
*
|
|
3634
|
-
*
|
|
3750
|
+
* List of order ids to be deleted.
|
|
3751
|
+
* Only orders imported via ImportOrders API can be deleted.
|
|
3752
|
+
* @format GUID
|
|
3753
|
+
* @minSize 1
|
|
3754
|
+
* @maxSize 1000
|
|
3635
3755
|
*/
|
|
3636
|
-
|
|
3756
|
+
orderIds: string[];
|
|
3757
|
+
}
|
|
3758
|
+
interface BulkDeleteImportedOrdersResponse {
|
|
3637
3759
|
/**
|
|
3638
|
-
*
|
|
3639
|
-
* @
|
|
3760
|
+
* Job ID for async operation tracking. Pass to [Get Async Job](https://dev.wix.com/docs/rest/business-management/async-job/get-async-job) or [List Async Job Items](https://dev.wix.com/docs/rest/business-management/async-job/list-async-job-items) to retrieve details and metadata
|
|
3761
|
+
* @format GUID
|
|
3640
3762
|
*/
|
|
3641
|
-
|
|
3642
|
-
/** id to pass to processing notification */
|
|
3643
|
-
correlationId?: string | null;
|
|
3644
|
-
/** when event was created / issued */
|
|
3645
|
-
issuedAt?: Date | null;
|
|
3646
|
-
}
|
|
3647
|
-
/** @oneof */
|
|
3648
|
-
interface UpdateInternalDocumentsEventOperationOneOf {
|
|
3649
|
-
/** insert/update documents */
|
|
3650
|
-
update?: InternalDocumentUpdateOperation;
|
|
3651
|
-
/** delete by document ids */
|
|
3652
|
-
deleteByIds?: DeleteByIdsOperation;
|
|
3653
|
-
/** delete documents matching filter */
|
|
3654
|
-
deleteByFilter?: DeleteByFilterOperation;
|
|
3655
|
-
/** update internal documents matching filter */
|
|
3656
|
-
updateByFilter?: InternalDocumentUpdateByFilterOperation;
|
|
3657
|
-
/** update only existing documents */
|
|
3658
|
-
updateExisting?: InternalUpdateExistingOperation;
|
|
3659
|
-
/** insert/update documents with versioning */
|
|
3660
|
-
versionedUpdate?: VersionedDocumentUpdateOperation;
|
|
3661
|
-
/** delete by document ids with versioning */
|
|
3662
|
-
versionedDeleteByIds?: VersionedDeleteByIdsOperation;
|
|
3663
|
-
}
|
|
3664
|
-
interface InternalDocument {
|
|
3665
|
-
/** document with mandatory fields (id) and with fields specific to the type of the document */
|
|
3666
|
-
document?: Record<string, any> | null;
|
|
3667
|
-
}
|
|
3668
|
-
interface InternalDocumentUpdateOperation {
|
|
3669
|
-
/** documents to index or update */
|
|
3670
|
-
documents?: InternalDocument[];
|
|
3671
|
-
}
|
|
3672
|
-
interface DeleteByIdsOperation {
|
|
3673
|
-
/** ids of the documents to delete */
|
|
3674
|
-
documentIds?: string[];
|
|
3675
|
-
/**
|
|
3676
|
-
* tenant id for custom tenancy strategy
|
|
3677
|
-
* @minLength 2
|
|
3678
|
-
* @maxLength 300
|
|
3679
|
-
*/
|
|
3680
|
-
tenantId?: string | null;
|
|
3681
|
-
}
|
|
3682
|
-
interface DeleteByFilterOperation {
|
|
3683
|
-
/** documents matching this filter wil be deleted. only filterable documents defined in document_type can be used for filtering */
|
|
3684
|
-
filter?: Record<string, any> | null;
|
|
3685
|
-
/**
|
|
3686
|
-
* tenant id for custom tenancy strategy
|
|
3687
|
-
* @minLength 2
|
|
3688
|
-
* @maxLength 300
|
|
3689
|
-
*/
|
|
3690
|
-
tenantId?: string | null;
|
|
3691
|
-
}
|
|
3692
|
-
interface InternalDocumentUpdateByFilterOperation {
|
|
3693
|
-
/** documents matching this filter will be updated */
|
|
3694
|
-
filter?: Record<string, any> | null;
|
|
3695
|
-
/** partial document to apply */
|
|
3696
|
-
document?: InternalDocument;
|
|
3697
|
-
/**
|
|
3698
|
-
* tenant id for custom tenancy strategy
|
|
3699
|
-
* @minLength 2
|
|
3700
|
-
* @maxLength 300
|
|
3701
|
-
*/
|
|
3702
|
-
tenantId?: string | null;
|
|
3703
|
-
}
|
|
3704
|
-
interface InternalUpdateExistingOperation {
|
|
3705
|
-
/** documents to update */
|
|
3706
|
-
documents?: InternalDocument[];
|
|
3707
|
-
}
|
|
3708
|
-
interface VersionedDocumentUpdateOperation {
|
|
3709
|
-
/** documents to create or overwrite */
|
|
3710
|
-
documents?: InternalDocument[];
|
|
3711
|
-
/** versioning mode to use instead of default */
|
|
3712
|
-
versioningMode?: VersioningModeWithLiterals;
|
|
3713
|
-
}
|
|
3714
|
-
declare enum VersioningMode {
|
|
3715
|
-
/** use default versioning mode agreed with search team */
|
|
3716
|
-
DEFAULT = "DEFAULT",
|
|
3717
|
-
/** execute only if version is greater than existing */
|
|
3718
|
-
GREATER_THAN = "GREATER_THAN",
|
|
3719
|
-
/** execute only if version is greater or equal to existing */
|
|
3720
|
-
GREATER_OR_EQUAL = "GREATER_OR_EQUAL"
|
|
3721
|
-
}
|
|
3722
|
-
/** @enumType */
|
|
3723
|
-
type VersioningModeWithLiterals = VersioningMode | 'DEFAULT' | 'GREATER_THAN' | 'GREATER_OR_EQUAL';
|
|
3724
|
-
interface VersionedDeleteByIdsOperation {
|
|
3725
|
-
/** ids with version of the documents to delete */
|
|
3726
|
-
documentIds?: VersionedDocumentId[];
|
|
3727
|
-
/**
|
|
3728
|
-
* tenant id for custom tenancy strategy
|
|
3729
|
-
* @minLength 2
|
|
3730
|
-
* @maxLength 300
|
|
3731
|
-
*/
|
|
3732
|
-
tenantId?: string | null;
|
|
3733
|
-
}
|
|
3734
|
-
interface VersionedDocumentId {
|
|
3735
|
-
/** document id */
|
|
3736
|
-
documentId?: string;
|
|
3737
|
-
/** document version */
|
|
3738
|
-
version?: string;
|
|
3739
|
-
/** versioning mode to use instead of default */
|
|
3740
|
-
versioningMode?: VersioningModeWithLiterals;
|
|
3763
|
+
jobId?: string;
|
|
3741
3764
|
}
|
|
3742
|
-
interface
|
|
3765
|
+
interface V1TriggerReindexRequest {
|
|
3743
3766
|
/** @format GUID */
|
|
3744
3767
|
metasiteId?: string;
|
|
3745
3768
|
/**
|
|
@@ -3749,11 +3772,9 @@ interface TriggerReindexRequest {
|
|
|
3749
3772
|
*/
|
|
3750
3773
|
orderIds?: string[];
|
|
3751
3774
|
}
|
|
3752
|
-
interface
|
|
3753
|
-
}
|
|
3754
|
-
interface Empty {
|
|
3775
|
+
interface V1TriggerReindexResponse {
|
|
3755
3776
|
}
|
|
3756
|
-
interface
|
|
3777
|
+
interface V1TriggerReindexOrderRequest {
|
|
3757
3778
|
/** @format GUID */
|
|
3758
3779
|
metasiteId?: string;
|
|
3759
3780
|
/**
|
|
@@ -3762,201 +3783,488 @@ interface TriggerReindexOrderRequest {
|
|
|
3762
3783
|
*/
|
|
3763
3784
|
orderId?: string;
|
|
3764
3785
|
}
|
|
3765
|
-
interface
|
|
3766
|
-
/** @format GUID */
|
|
3767
|
-
orderId?: string;
|
|
3768
|
-
}
|
|
3769
|
-
interface SendBuyerConfirmationEmailResponse {
|
|
3770
|
-
}
|
|
3771
|
-
interface SendBuyerPaymentsReceivedEmailRequest {
|
|
3786
|
+
interface PreparePaymentCollectionRequest {
|
|
3772
3787
|
/**
|
|
3788
|
+
* Ecom order ID.
|
|
3773
3789
|
* @minLength 1
|
|
3774
3790
|
* @maxLength 100
|
|
3775
3791
|
*/
|
|
3776
|
-
|
|
3777
|
-
|
|
3778
|
-
|
|
3779
|
-
}
|
|
3780
|
-
interface SendBuyerPickupConfirmationEmailRequest {
|
|
3792
|
+
ecomOrderId: string;
|
|
3793
|
+
/** Amount to collect */
|
|
3794
|
+
amount: Price;
|
|
3781
3795
|
/**
|
|
3782
|
-
*
|
|
3783
|
-
*
|
|
3796
|
+
* Optional parameter. When present, payment collection will be performed using given payment gateway order.
|
|
3797
|
+
* Existing payment gateway order will be updated with a new amount.
|
|
3798
|
+
* When parameter is absent, new payment gateway order will be created and used for payment collection.
|
|
3784
3799
|
*/
|
|
3785
|
-
|
|
3786
|
-
}
|
|
3787
|
-
interface SendBuyerPickupConfirmationEmailResponse {
|
|
3788
|
-
}
|
|
3789
|
-
interface BulkSendBuyerPickupConfirmationEmailsRequest {
|
|
3800
|
+
paymentGatewayOrderId?: string | null;
|
|
3790
3801
|
/**
|
|
3791
|
-
*
|
|
3792
|
-
*
|
|
3793
|
-
* @
|
|
3802
|
+
* Whether to delay capture of the payment.
|
|
3803
|
+
* Default: false
|
|
3804
|
+
* @deprecated Whether to delay capture of the payment.
|
|
3805
|
+
* Default: false
|
|
3806
|
+
* @replacedBy delayed_capture_settings.scheduled_action
|
|
3807
|
+
* @targetRemovalDate 2024-09-30
|
|
3794
3808
|
*/
|
|
3795
|
-
|
|
3796
|
-
|
|
3797
|
-
|
|
3809
|
+
delayedCapture?: boolean;
|
|
3810
|
+
/** Delayed capture payment settings */
|
|
3811
|
+
delayedCaptureSettings?: DelayedCaptureSettings;
|
|
3798
3812
|
}
|
|
3799
|
-
interface
|
|
3813
|
+
interface RedirectUrls {
|
|
3800
3814
|
/**
|
|
3801
|
-
*
|
|
3802
|
-
* @
|
|
3815
|
+
* URL to redirect buyer in case of approved (successful) transaction
|
|
3816
|
+
* @format WEB_URL
|
|
3803
3817
|
*/
|
|
3804
|
-
|
|
3818
|
+
successUrl?: string | null;
|
|
3819
|
+
/**
|
|
3820
|
+
* URL to redirect buyer in case of buyer canceled the transaction
|
|
3821
|
+
* @format WEB_URL
|
|
3822
|
+
*/
|
|
3823
|
+
cancelUrl?: string | null;
|
|
3824
|
+
/**
|
|
3825
|
+
* URL to redirect buyer in case of failed/rejected transaction
|
|
3826
|
+
* @format WEB_URL
|
|
3827
|
+
*/
|
|
3828
|
+
errorUrl?: string | null;
|
|
3829
|
+
/**
|
|
3830
|
+
* URL to redirect buyer in case of pending transaction (that might take some time to process)
|
|
3831
|
+
* @format WEB_URL
|
|
3832
|
+
*/
|
|
3833
|
+
pendingUrl?: string | null;
|
|
3805
3834
|
}
|
|
3806
|
-
interface
|
|
3835
|
+
interface DelayedCaptureSettings {
|
|
3836
|
+
/** Specifies the automatic action (void/capture) for authorized transaction after the specified duration */
|
|
3837
|
+
scheduledAction?: ScheduledActionWithLiterals;
|
|
3838
|
+
/** Delay duration before execution. Optional - if not set, providers default period will be used */
|
|
3839
|
+
delayDuration?: Duration;
|
|
3807
3840
|
}
|
|
3808
|
-
|
|
3841
|
+
declare enum ScheduledAction {
|
|
3842
|
+
/** Whether payment will be auto-voided when duration passes */
|
|
3843
|
+
VOID = "VOID",
|
|
3844
|
+
/** Whether payment will be auto-captured when duration passes */
|
|
3845
|
+
CAPTURE = "CAPTURE"
|
|
3846
|
+
}
|
|
3847
|
+
/** @enumType */
|
|
3848
|
+
type ScheduledActionWithLiterals = ScheduledAction | 'VOID' | 'CAPTURE';
|
|
3849
|
+
interface Duration {
|
|
3809
3850
|
/**
|
|
3810
|
-
*
|
|
3811
|
-
* @
|
|
3812
|
-
* @maxSize 300
|
|
3851
|
+
* Amount of units. For example, 30 MINUTES, 1 HOURS, 7 DAYS, etc
|
|
3852
|
+
* @min 1
|
|
3813
3853
|
*/
|
|
3814
|
-
|
|
3854
|
+
count?: number;
|
|
3855
|
+
/** Duration unit: MINUTES, HOURS and DAYS */
|
|
3856
|
+
unit?: DurationUnitWithLiterals;
|
|
3815
3857
|
}
|
|
3816
|
-
|
|
3858
|
+
declare enum DurationUnit {
|
|
3859
|
+
MINUTES = "MINUTES",
|
|
3860
|
+
HOURS = "HOURS",
|
|
3861
|
+
DAYS = "DAYS"
|
|
3817
3862
|
}
|
|
3818
|
-
|
|
3863
|
+
/** @enumType */
|
|
3864
|
+
type DurationUnitWithLiterals = DurationUnit | 'MINUTES' | 'HOURS' | 'DAYS';
|
|
3865
|
+
interface PreparePaymentCollectionResponse {
|
|
3866
|
+
/** Payment gateway order id which is associated with given payment */
|
|
3867
|
+
paymentGatewayOrderId?: string;
|
|
3868
|
+
}
|
|
3869
|
+
interface GetPaymentCollectabilityStatusRequest {
|
|
3819
3870
|
/**
|
|
3871
|
+
* Ecom order ID.
|
|
3820
3872
|
* @minLength 1
|
|
3821
3873
|
* @maxLength 100
|
|
3822
3874
|
*/
|
|
3823
|
-
|
|
3875
|
+
ecomOrderId: string;
|
|
3824
3876
|
}
|
|
3825
|
-
interface
|
|
3877
|
+
interface GetPaymentCollectabilityStatusResponse {
|
|
3878
|
+
/** Payment collectability status */
|
|
3879
|
+
status?: PaymentCollectabilityStatusWithLiterals;
|
|
3880
|
+
/** Collectable order amount */
|
|
3881
|
+
amount?: Price;
|
|
3826
3882
|
}
|
|
3827
|
-
|
|
3883
|
+
declare enum PaymentCollectabilityStatus {
|
|
3884
|
+
UNKNOWN = "UNKNOWN",
|
|
3885
|
+
COLLECTABLE = "COLLECTABLE",
|
|
3886
|
+
NONCOLLECTABLE_ORDER_IS_CANCELLED = "NONCOLLECTABLE_ORDER_IS_CANCELLED",
|
|
3887
|
+
NONCOLLECTABLE_ORDER_IS_PAID = "NONCOLLECTABLE_ORDER_IS_PAID",
|
|
3888
|
+
NONCOLLECTABLE_MISSING_PAYMENT_METHOD = "NONCOLLECTABLE_MISSING_PAYMENT_METHOD",
|
|
3889
|
+
NONCOLLECTABLE_ORDER_IS_PENDING = "NONCOLLECTABLE_ORDER_IS_PENDING",
|
|
3890
|
+
NONCOLLECTABLE_ORDER_IS_REJECTED = "NONCOLLECTABLE_ORDER_IS_REJECTED",
|
|
3891
|
+
NONCOLLECTABLE_ORDER_HAS_SUBSCRIPTIONS = "NONCOLLECTABLE_ORDER_HAS_SUBSCRIPTIONS",
|
|
3892
|
+
NONCOLLECTABLE_ORDER_HAS_CHARGEBACKS = "NONCOLLECTABLE_ORDER_HAS_CHARGEBACKS",
|
|
3893
|
+
NONCOLLECTABLE_SUBSCRIPTION_CYCLE_ALREADY_PASSED = "NONCOLLECTABLE_SUBSCRIPTION_CYCLE_ALREADY_PASSED",
|
|
3894
|
+
NONCOLLECTABLE_ORDER_HAS_UNSUPPORTED_SUBSCRIPTION = "NONCOLLECTABLE_ORDER_HAS_UNSUPPORTED_SUBSCRIPTION",
|
|
3895
|
+
NONCOLLECTABLE_CUSTOM_AMOUNT_NOT_SUPPORTED = "NONCOLLECTABLE_CUSTOM_AMOUNT_NOT_SUPPORTED"
|
|
3896
|
+
}
|
|
3897
|
+
/** @enumType */
|
|
3898
|
+
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';
|
|
3899
|
+
interface RecordManuallyCollectedPaymentRequest {
|
|
3828
3900
|
/**
|
|
3829
|
-
*
|
|
3901
|
+
* Order ID.
|
|
3830
3902
|
* @minLength 1
|
|
3831
3903
|
* @maxLength 100
|
|
3832
3904
|
*/
|
|
3833
|
-
orderId
|
|
3905
|
+
orderId: string;
|
|
3906
|
+
/** Amount to be recorded as approved manual payment for given order */
|
|
3907
|
+
amount: Price;
|
|
3908
|
+
}
|
|
3909
|
+
/**
|
|
3910
|
+
* User-defined payment method name.
|
|
3911
|
+
* Allows specifying either a predefined type or a custom name.
|
|
3912
|
+
*/
|
|
3913
|
+
interface UserDefinedPaymentMethodName extends UserDefinedPaymentMethodNameKindOneOf {
|
|
3914
|
+
/** Predefined payment method. */
|
|
3915
|
+
predefined?: PredefinedPaymentMethodWithLiterals;
|
|
3834
3916
|
/**
|
|
3835
|
-
*
|
|
3917
|
+
* Custom payment method name provided by user.
|
|
3918
|
+
*
|
|
3919
|
+
* For example, `"Wire transfer"`, `"Money order"`, `"Venmo"` or any other custom name.
|
|
3836
3920
|
* @minLength 1
|
|
3837
|
-
* @maxLength
|
|
3921
|
+
* @maxLength 100
|
|
3838
3922
|
*/
|
|
3839
|
-
|
|
3840
|
-
|
|
3841
|
-
|
|
3923
|
+
custom?: string | null;
|
|
3924
|
+
}
|
|
3925
|
+
/** @oneof */
|
|
3926
|
+
interface UserDefinedPaymentMethodNameKindOneOf {
|
|
3927
|
+
/** Predefined payment method. */
|
|
3928
|
+
predefined?: PredefinedPaymentMethodWithLiterals;
|
|
3842
3929
|
/**
|
|
3843
|
-
*
|
|
3844
|
-
*
|
|
3930
|
+
* Custom payment method name provided by user.
|
|
3931
|
+
*
|
|
3932
|
+
* For example, `"Wire transfer"`, `"Money order"`, `"Venmo"` or any other custom name.
|
|
3933
|
+
* @minLength 1
|
|
3934
|
+
* @maxLength 100
|
|
3845
3935
|
*/
|
|
3846
|
-
|
|
3936
|
+
custom?: string | null;
|
|
3847
3937
|
}
|
|
3848
|
-
|
|
3938
|
+
/** Predefined payment method types for offline/manual payments. */
|
|
3939
|
+
declare enum PredefinedPaymentMethod {
|
|
3940
|
+
/** Cash payment. */
|
|
3941
|
+
CASH = "CASH",
|
|
3942
|
+
/** Bank transfer. */
|
|
3943
|
+
BANK_TRANSFER = "BANK_TRANSFER",
|
|
3944
|
+
/** Payment by check. */
|
|
3945
|
+
CHECK = "CHECK"
|
|
3849
3946
|
}
|
|
3850
|
-
|
|
3947
|
+
/** @enumType */
|
|
3948
|
+
type PredefinedPaymentMethodWithLiterals = PredefinedPaymentMethod | 'CASH' | 'BANK_TRANSFER' | 'CHECK';
|
|
3949
|
+
interface RecordManuallyCollectedPaymentResponse {
|
|
3950
|
+
}
|
|
3951
|
+
interface MarkOrderAsPaidRequest {
|
|
3851
3952
|
/**
|
|
3852
|
-
*
|
|
3853
|
-
* @
|
|
3953
|
+
* Ecom order ID.
|
|
3954
|
+
* @minLength 1
|
|
3955
|
+
* @maxLength 100
|
|
3854
3956
|
*/
|
|
3855
|
-
|
|
3957
|
+
ecomOrderId: string;
|
|
3958
|
+
}
|
|
3959
|
+
interface MarkOrderAsPaidResponse {
|
|
3960
|
+
/** Updated order. */
|
|
3961
|
+
order?: Order;
|
|
3962
|
+
}
|
|
3963
|
+
interface BulkMarkOrdersAsPaidRequest {
|
|
3856
3964
|
/**
|
|
3857
|
-
*
|
|
3858
|
-
* @
|
|
3965
|
+
* IDs of orders to mark as paid.
|
|
3966
|
+
* @minSize 1
|
|
3967
|
+
* @maxSize 100
|
|
3968
|
+
* @minLength 1
|
|
3969
|
+
* @maxLength 100
|
|
3859
3970
|
*/
|
|
3860
|
-
|
|
3971
|
+
ecomOrderIds: string[];
|
|
3972
|
+
}
|
|
3973
|
+
interface BulkMarkOrdersAsPaidResponse {
|
|
3861
3974
|
/**
|
|
3862
|
-
*
|
|
3863
|
-
*
|
|
3864
|
-
* @maxLength 1000
|
|
3975
|
+
* Items updated by the bulk action.
|
|
3976
|
+
* The Order entity within the results optimistically changes its payment status to paid, however this process is async.
|
|
3865
3977
|
*/
|
|
3866
|
-
|
|
3978
|
+
results?: BulkOrderResult[];
|
|
3979
|
+
/** Bulk action metadata. */
|
|
3980
|
+
bulkActionMetadata?: BulkActionMetadata;
|
|
3867
3981
|
}
|
|
3868
|
-
interface
|
|
3982
|
+
interface BulkOrderResult {
|
|
3983
|
+
/** Item metadata. */
|
|
3984
|
+
itemMetadata?: ItemMetadata;
|
|
3985
|
+
/**
|
|
3986
|
+
* Updated order.
|
|
3987
|
+
*
|
|
3988
|
+
* Returned when `returnFullEntity = true`.
|
|
3989
|
+
*/
|
|
3990
|
+
item?: Order;
|
|
3869
3991
|
}
|
|
3870
|
-
interface
|
|
3871
|
-
/**
|
|
3872
|
-
|
|
3873
|
-
/**
|
|
3874
|
-
|
|
3992
|
+
interface ItemMetadata {
|
|
3993
|
+
/** Item ID. Should always be available, unless it's impossible (for example, when failing to create an item). */
|
|
3994
|
+
id?: string | null;
|
|
3995
|
+
/** Index of the item within the request array. Allows for correlation between request and response items. */
|
|
3996
|
+
originalIndex?: number;
|
|
3997
|
+
/** Whether the requested action was successful for this item. When `false`, the `error` field is populated. */
|
|
3998
|
+
success?: boolean;
|
|
3999
|
+
/** Details about the error in case of failure. */
|
|
4000
|
+
error?: ApplicationError;
|
|
3875
4001
|
}
|
|
3876
|
-
interface
|
|
4002
|
+
interface ApplicationError {
|
|
4003
|
+
/** Error code. */
|
|
4004
|
+
code?: string;
|
|
4005
|
+
/** Description of the error. */
|
|
4006
|
+
description?: string;
|
|
4007
|
+
/** Data related to the error. */
|
|
4008
|
+
data?: Record<string, any> | null;
|
|
3877
4009
|
}
|
|
3878
|
-
interface
|
|
4010
|
+
interface BulkActionMetadata {
|
|
4011
|
+
/** Number of items that were successfully processed. */
|
|
4012
|
+
totalSuccesses?: number;
|
|
4013
|
+
/** Number of items that couldn't be processed. */
|
|
4014
|
+
totalFailures?: number;
|
|
4015
|
+
/** Number of failures without details because detailed failure threshold was exceeded. */
|
|
4016
|
+
undetailedFailures?: number;
|
|
4017
|
+
}
|
|
4018
|
+
interface GetRefundabilityStatusRequest {
|
|
3879
4019
|
/**
|
|
4020
|
+
* Order ID.
|
|
3880
4021
|
* @minLength 1
|
|
3881
4022
|
* @maxLength 100
|
|
3882
4023
|
*/
|
|
3883
|
-
|
|
4024
|
+
ecomOrderId: string;
|
|
3884
4025
|
}
|
|
3885
|
-
interface
|
|
4026
|
+
interface GetRefundabilityStatusResponse {
|
|
4027
|
+
/**
|
|
4028
|
+
* Refundability details.
|
|
4029
|
+
* @maxSize 300
|
|
4030
|
+
*/
|
|
4031
|
+
refundabilities?: Refundability[];
|
|
4032
|
+
/**
|
|
4033
|
+
* Whether the order supports refunding per item.
|
|
4034
|
+
* @deprecated
|
|
4035
|
+
*/
|
|
4036
|
+
refundablePerItem?: boolean;
|
|
3886
4037
|
}
|
|
3887
|
-
interface
|
|
3888
|
-
|
|
4038
|
+
interface Refundability extends RefundabilityAdditionalRefundabilityInfoOneOf {
|
|
4039
|
+
/** Reason why payment is not refundable. */
|
|
4040
|
+
nonRefundableReason?: NonRefundableReasonWithLiterals;
|
|
4041
|
+
/** Reason why payment is only refundable manually. */
|
|
4042
|
+
manuallyRefundableReason?: ManuallyRefundableReasonWithLiterals;
|
|
4043
|
+
/** Payment ID. */
|
|
4044
|
+
paymentId?: string;
|
|
4045
|
+
/** Payment refundability status. */
|
|
4046
|
+
refundabilityStatus?: RefundableStatusWithLiterals;
|
|
4047
|
+
/** Link to payment provider dashboard. */
|
|
4048
|
+
providerLink?: string | null;
|
|
3889
4049
|
}
|
|
3890
|
-
|
|
3891
|
-
|
|
3892
|
-
|
|
3893
|
-
|
|
3894
|
-
|
|
4050
|
+
/** @oneof */
|
|
4051
|
+
interface RefundabilityAdditionalRefundabilityInfoOneOf {
|
|
4052
|
+
/** Reason why payment is not refundable. */
|
|
4053
|
+
nonRefundableReason?: NonRefundableReasonWithLiterals;
|
|
4054
|
+
/** Reason why payment is only refundable manually. */
|
|
4055
|
+
manuallyRefundableReason?: ManuallyRefundableReasonWithLiterals;
|
|
4056
|
+
}
|
|
4057
|
+
declare enum RefundableStatus {
|
|
4058
|
+
NOT_REFUNDABLE = "NOT_REFUNDABLE",
|
|
4059
|
+
MANUAL = "MANUAL",
|
|
4060
|
+
REFUNDABLE = "REFUNDABLE"
|
|
3895
4061
|
}
|
|
3896
4062
|
/** @enumType */
|
|
3897
|
-
type
|
|
3898
|
-
|
|
3899
|
-
|
|
4063
|
+
type RefundableStatusWithLiterals = RefundableStatus | 'NOT_REFUNDABLE' | 'MANUAL' | 'REFUNDABLE';
|
|
4064
|
+
declare enum NonRefundableReason {
|
|
4065
|
+
NONE = "NONE",
|
|
4066
|
+
ALREADY_REFUNDED = "ALREADY_REFUNDED",
|
|
4067
|
+
PROVIDER_IS_DOWN = "PROVIDER_IS_DOWN",
|
|
4068
|
+
INTERNAL_ERROR = "INTERNAL_ERROR",
|
|
4069
|
+
NOT_PAID = "NOT_PAID",
|
|
4070
|
+
ACCESS_DENIED = "ACCESS_DENIED",
|
|
4071
|
+
ZERO_PRICE = "ZERO_PRICE",
|
|
4072
|
+
DISABLED_BY_PROVIDER = "DISABLED_BY_PROVIDER",
|
|
4073
|
+
PENDING_REFUND = "PENDING_REFUND",
|
|
4074
|
+
FORBIDDEN = "FORBIDDEN",
|
|
4075
|
+
TRANSACTION_NOT_FOUND = "TRANSACTION_NOT_FOUND",
|
|
4076
|
+
ORDER_IS_PENDING = "ORDER_IS_PENDING",
|
|
4077
|
+
ORDER_IS_REJECTED = "ORDER_IS_REJECTED"
|
|
3900
4078
|
}
|
|
3901
|
-
|
|
4079
|
+
/** @enumType */
|
|
4080
|
+
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';
|
|
4081
|
+
declare enum ManuallyRefundableReason {
|
|
4082
|
+
EXPIRED = "EXPIRED",
|
|
4083
|
+
NOT_SUPPORTED = "NOT_SUPPORTED",
|
|
4084
|
+
OFFLINE = "OFFLINE",
|
|
4085
|
+
REQUIRES_CARD_READER = "REQUIRES_CARD_READER"
|
|
4086
|
+
}
|
|
4087
|
+
/** @enumType */
|
|
4088
|
+
type ManuallyRefundableReasonWithLiterals = ManuallyRefundableReason | 'EXPIRED' | 'NOT_SUPPORTED' | 'OFFLINE' | 'REQUIRES_CARD_READER';
|
|
4089
|
+
interface CreatePaymentGatewayOrderRequest {
|
|
3902
4090
|
/**
|
|
4091
|
+
* Ecom order ID.
|
|
3903
4092
|
* @minLength 1
|
|
3904
4093
|
* @maxLength 100
|
|
3905
4094
|
*/
|
|
3906
|
-
|
|
3907
|
-
/**
|
|
3908
|
-
|
|
3909
|
-
|
|
3910
|
-
|
|
4095
|
+
ecomOrderId: string;
|
|
4096
|
+
/** Information about the user who initiated the payment. */
|
|
4097
|
+
chargedBy?: ChargedBy;
|
|
4098
|
+
}
|
|
4099
|
+
interface ChargedBy {
|
|
3911
4100
|
/**
|
|
3912
|
-
*
|
|
3913
|
-
* @
|
|
3914
|
-
* @maxLength 1000
|
|
4101
|
+
* ID - id of the user who initiated the payment
|
|
4102
|
+
* @format GUID
|
|
3915
4103
|
*/
|
|
3916
|
-
|
|
4104
|
+
id?: string;
|
|
3917
4105
|
/**
|
|
3918
|
-
*
|
|
3919
|
-
* @
|
|
4106
|
+
* Full name - name of the user who initiated the payment
|
|
4107
|
+
* @minLength 1
|
|
4108
|
+
* @maxLength 200
|
|
3920
4109
|
*/
|
|
3921
|
-
|
|
4110
|
+
fullName?: string | null;
|
|
3922
4111
|
}
|
|
3923
|
-
|
|
3924
|
-
|
|
4112
|
+
interface CreatePaymentGatewayOrderResponse {
|
|
4113
|
+
/** ID of the order created in the payment gateway */
|
|
4114
|
+
paymentGatewayOrderId?: string;
|
|
4115
|
+
}
|
|
4116
|
+
interface ChargeMembershipsRequest {
|
|
3925
4117
|
/**
|
|
3926
|
-
* Order
|
|
3927
|
-
* @
|
|
4118
|
+
* Order ID.
|
|
4119
|
+
* @minLength 1
|
|
4120
|
+
* @maxLength 100
|
|
3928
4121
|
*/
|
|
3929
|
-
|
|
3930
|
-
/** Whether the shipping fee was also refunded. */
|
|
3931
|
-
shippingIncluded?: boolean;
|
|
4122
|
+
ecomOrderId: string;
|
|
3932
4123
|
/**
|
|
3933
|
-
*
|
|
3934
|
-
*
|
|
4124
|
+
* The member id. Do not attempt to get it from the request context, since in some cases the caller is not a member
|
|
4125
|
+
* but a user which is using the membership on behalf of the a member
|
|
4126
|
+
* @format GUID
|
|
3935
4127
|
*/
|
|
3936
|
-
|
|
4128
|
+
memberId: string;
|
|
3937
4129
|
/**
|
|
3938
|
-
*
|
|
4130
|
+
* List of items to be paid by memberships
|
|
4131
|
+
* @minSize 1
|
|
3939
4132
|
* @maxSize 300
|
|
3940
4133
|
*/
|
|
3941
|
-
|
|
4134
|
+
membershipCharges?: MembershipChargeItem[];
|
|
4135
|
+
}
|
|
4136
|
+
interface MembershipChargeItem {
|
|
3942
4137
|
/**
|
|
3943
|
-
*
|
|
3944
|
-
* @
|
|
4138
|
+
* The id of used membership
|
|
4139
|
+
* @minLength 1
|
|
4140
|
+
* @maxLength 100
|
|
3945
4141
|
*/
|
|
3946
|
-
|
|
3947
|
-
/** Shipping amount that was refunded. */
|
|
3948
|
-
shipping?: ShippingRefund;
|
|
3949
|
-
}
|
|
3950
|
-
interface RefundItem {
|
|
4142
|
+
membershipId?: string;
|
|
3951
4143
|
/**
|
|
3952
|
-
*
|
|
4144
|
+
* ID of the application providing this payment option
|
|
3953
4145
|
* @format GUID
|
|
3954
4146
|
*/
|
|
3955
|
-
|
|
3956
|
-
/**
|
|
3957
|
-
|
|
3958
|
-
|
|
3959
|
-
|
|
4147
|
+
appId?: string;
|
|
4148
|
+
/** The name of used membership */
|
|
4149
|
+
membershipName?: MembershipName;
|
|
4150
|
+
/** Additional data about this membership */
|
|
4151
|
+
membershipAdditionalData?: Record<string, any> | null;
|
|
4152
|
+
/** Catalog and item reference info. */
|
|
4153
|
+
catalogReference?: CatalogReference;
|
|
4154
|
+
/** Properties of the service. When relevant, contains information such as date and number of participants. */
|
|
4155
|
+
serviceProperties?: ServiceProperties;
|
|
4156
|
+
/**
|
|
4157
|
+
* Usually would be the same as catalogReference.catalogItemId
|
|
4158
|
+
* For cases when these are not the same, this field would return the actual id of the item in the catalog
|
|
4159
|
+
* For example, for Wix bookings, catalogReference.catalogItemId is the booking id, and this value is being set to be the service id
|
|
4160
|
+
* @minLength 1
|
|
4161
|
+
* @maxLength 36
|
|
4162
|
+
*/
|
|
4163
|
+
rootCatalogItemId?: string | null;
|
|
4164
|
+
/**
|
|
4165
|
+
* line item id of Checkout/Order line item
|
|
4166
|
+
* @minLength 1
|
|
4167
|
+
* @maxLength 100
|
|
4168
|
+
*/
|
|
4169
|
+
lineItemId?: string;
|
|
4170
|
+
}
|
|
4171
|
+
interface MembershipName {
|
|
4172
|
+
/**
|
|
4173
|
+
* Membership name.
|
|
4174
|
+
* @maxLength 100
|
|
4175
|
+
*/
|
|
4176
|
+
original?: string;
|
|
4177
|
+
/**
|
|
4178
|
+
* Translated membership name. Defaults to `original` when not provided.
|
|
4179
|
+
* @maxLength 100
|
|
4180
|
+
*/
|
|
4181
|
+
translated?: string | null;
|
|
4182
|
+
}
|
|
4183
|
+
interface ServiceProperties {
|
|
4184
|
+
/**
|
|
4185
|
+
* 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.
|
|
4186
|
+
* For example, the start time of a class.
|
|
4187
|
+
*/
|
|
4188
|
+
scheduledDate?: Date | null;
|
|
4189
|
+
/**
|
|
4190
|
+
* 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.
|
|
4191
|
+
* @min 1
|
|
4192
|
+
* @max 10000
|
|
4193
|
+
*/
|
|
4194
|
+
numberOfParticipants?: number | null;
|
|
4195
|
+
}
|
|
4196
|
+
interface ChargeMembershipsResponse {
|
|
4197
|
+
}
|
|
4198
|
+
interface TriggerRefundRequest {
|
|
4199
|
+
/**
|
|
4200
|
+
* The order this refund related to
|
|
4201
|
+
* @minLength 1
|
|
4202
|
+
* @maxLength 100
|
|
4203
|
+
*/
|
|
4204
|
+
ecomOrderId: string;
|
|
4205
|
+
/**
|
|
4206
|
+
* Refund operations information
|
|
4207
|
+
* @minSize 1
|
|
4208
|
+
* @maxSize 1
|
|
4209
|
+
*/
|
|
4210
|
+
payments: PaymentRefund[];
|
|
4211
|
+
/** Business model of a refund */
|
|
4212
|
+
details?: RefundDetails;
|
|
4213
|
+
/** Side effect details related to refund */
|
|
4214
|
+
sideEffects?: RefundSideEffects;
|
|
4215
|
+
}
|
|
4216
|
+
interface PaymentRefund {
|
|
4217
|
+
/**
|
|
4218
|
+
* Specific payment within the order to refund
|
|
4219
|
+
* @format GUID
|
|
4220
|
+
*/
|
|
4221
|
+
paymentId?: string;
|
|
4222
|
+
/** Refund amount. Not relevant for membership and gift card refunds. */
|
|
4223
|
+
amount?: Price;
|
|
4224
|
+
/**
|
|
4225
|
+
* Whether refund is made externally and manually (on the payment provider's side)
|
|
4226
|
+
* 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.
|
|
4227
|
+
* When true, the payment will only be *marked* as refunded, and no actual refund will be performed.
|
|
4228
|
+
*/
|
|
4229
|
+
externalRefund?: boolean;
|
|
4230
|
+
}
|
|
4231
|
+
/** Business model of a refund request */
|
|
4232
|
+
interface RefundDetails {
|
|
4233
|
+
/**
|
|
4234
|
+
* Order line item IDs and quantities that were refunded.
|
|
4235
|
+
* @maxSize 300
|
|
4236
|
+
*/
|
|
4237
|
+
items?: RefundItem[];
|
|
4238
|
+
/** Whether the shipping fee was also refunded. */
|
|
4239
|
+
shippingIncluded?: boolean;
|
|
4240
|
+
/**
|
|
4241
|
+
* Reason for the refund, provided by customer (optional).
|
|
4242
|
+
* @maxLength 200
|
|
4243
|
+
*/
|
|
4244
|
+
reason?: string | null;
|
|
4245
|
+
/**
|
|
4246
|
+
* Line items that were refunded.
|
|
4247
|
+
* @maxSize 300
|
|
4248
|
+
*/
|
|
4249
|
+
lineItems?: LineItemRefund[];
|
|
4250
|
+
/**
|
|
4251
|
+
* Additional fees that were refunded.
|
|
4252
|
+
* @maxSize 100
|
|
4253
|
+
*/
|
|
4254
|
+
additionalFees?: AdditionalFeeRefund[];
|
|
4255
|
+
/** Shipping amount that was refunded. */
|
|
4256
|
+
shipping?: ShippingRefund;
|
|
4257
|
+
}
|
|
4258
|
+
interface RefundItem {
|
|
4259
|
+
/**
|
|
4260
|
+
* Line item ID the refunded line item.
|
|
4261
|
+
* @format GUID
|
|
4262
|
+
*/
|
|
4263
|
+
lineItemId?: string;
|
|
4264
|
+
/**
|
|
4265
|
+
* Line item quantity refunded.
|
|
4266
|
+
* @min 1
|
|
4267
|
+
* @max 100000
|
|
3960
4268
|
*/
|
|
3961
4269
|
quantity?: number;
|
|
3962
4270
|
}
|
|
@@ -3995,1777 +4303,1490 @@ interface ShippingRefund {
|
|
|
3995
4303
|
*/
|
|
3996
4304
|
amount?: Price;
|
|
3997
4305
|
}
|
|
3998
|
-
interface
|
|
3999
|
-
|
|
4000
|
-
|
|
4001
|
-
|
|
4002
|
-
|
|
4003
|
-
* @minLength 1
|
|
4004
|
-
* @maxLength 100
|
|
4005
|
-
*/
|
|
4006
|
-
orderId?: string;
|
|
4306
|
+
interface RefundSideEffects {
|
|
4307
|
+
/** Inventory restock details as part of this refund. */
|
|
4308
|
+
restockInfo?: RestockInfo;
|
|
4309
|
+
/** Whether to send a refund confirmation email to the customer. */
|
|
4310
|
+
sendOrderRefundedEmail?: boolean;
|
|
4007
4311
|
/**
|
|
4008
|
-
*
|
|
4312
|
+
* Custom message added to the refund confirmation email.
|
|
4009
4313
|
* @minLength 1
|
|
4010
4314
|
* @maxLength 1000
|
|
4011
4315
|
*/
|
|
4012
4316
|
customMessage?: string | null;
|
|
4013
4317
|
}
|
|
4014
|
-
interface
|
|
4015
|
-
|
|
4016
|
-
|
|
4017
|
-
interface PreviewCancelRefundEmailRequest {
|
|
4318
|
+
interface RestockInfo {
|
|
4319
|
+
/** Restock type. */
|
|
4320
|
+
type?: RestockTypeWithLiterals;
|
|
4018
4321
|
/**
|
|
4019
|
-
*
|
|
4020
|
-
* @
|
|
4322
|
+
* Restocked line items and quantities. Only relevant for `{"type": "SOME_ITEMS"}`.
|
|
4323
|
+
* @maxSize 300
|
|
4021
4324
|
*/
|
|
4022
|
-
|
|
4325
|
+
items?: RestockItem[];
|
|
4326
|
+
}
|
|
4327
|
+
declare enum RestockType {
|
|
4328
|
+
NO_ITEMS = "NO_ITEMS",
|
|
4329
|
+
ALL_ITEMS = "ALL_ITEMS",
|
|
4330
|
+
SOME_ITEMS = "SOME_ITEMS"
|
|
4331
|
+
}
|
|
4332
|
+
/** @enumType */
|
|
4333
|
+
type RestockTypeWithLiterals = RestockType | 'NO_ITEMS' | 'ALL_ITEMS' | 'SOME_ITEMS';
|
|
4334
|
+
interface RestockItem {
|
|
4023
4335
|
/**
|
|
4024
|
-
*
|
|
4025
|
-
* @
|
|
4026
|
-
* @maxLength 1000
|
|
4336
|
+
* ID of the line item being restocked.
|
|
4337
|
+
* @format GUID
|
|
4027
4338
|
*/
|
|
4028
|
-
|
|
4029
|
-
/** Refund amount */
|
|
4030
|
-
refundAmount?: Price;
|
|
4339
|
+
lineItemId?: string;
|
|
4031
4340
|
/**
|
|
4032
|
-
*
|
|
4033
|
-
* @
|
|
4341
|
+
* Line item quantity being restocked.
|
|
4342
|
+
* @min 1
|
|
4343
|
+
* @max 100000
|
|
4034
4344
|
*/
|
|
4035
|
-
|
|
4036
|
-
}
|
|
4037
|
-
interface PreviewCancelRefundEmailResponse {
|
|
4038
|
-
emailPreview?: string;
|
|
4039
|
-
}
|
|
4040
|
-
interface PreviewBuyerPaymentsReceivedEmailRequest {
|
|
4041
|
-
}
|
|
4042
|
-
interface PreviewBuyerPaymentsReceivedEmailResponse {
|
|
4043
|
-
emailPreview?: string;
|
|
4044
|
-
}
|
|
4045
|
-
interface PreviewBuyerConfirmationEmailRequest {
|
|
4345
|
+
quantity?: number;
|
|
4046
4346
|
}
|
|
4047
|
-
interface
|
|
4048
|
-
|
|
4347
|
+
interface TriggerRefundResponse {
|
|
4348
|
+
/** All order's transactions after the refunds were added */
|
|
4349
|
+
orderTransactions?: OrderTransactions;
|
|
4350
|
+
/** Created refund ID */
|
|
4351
|
+
refundId?: string | null;
|
|
4352
|
+
/** Payment ID's that the refund execution had failed for */
|
|
4353
|
+
failedPaymentIds?: ItemMetadata[];
|
|
4049
4354
|
}
|
|
4050
|
-
|
|
4355
|
+
/**
|
|
4356
|
+
* A record of all payments and refunds associated with an order.
|
|
4357
|
+
*
|
|
4358
|
+
* Use order transactions to track payment status, add payment records, process refunds, and monitor chargebacks.
|
|
4359
|
+
*/
|
|
4360
|
+
interface OrderTransactions {
|
|
4361
|
+
/**
|
|
4362
|
+
* Order ID.
|
|
4363
|
+
* @format GUID
|
|
4364
|
+
*/
|
|
4365
|
+
orderId?: string;
|
|
4366
|
+
/**
|
|
4367
|
+
* Record of payments made to the merchant.
|
|
4368
|
+
* @maxSize 100
|
|
4369
|
+
*/
|
|
4370
|
+
payments?: Payment[];
|
|
4371
|
+
/**
|
|
4372
|
+
* Record of refunds made to the buyer.
|
|
4373
|
+
* @maxSize 300
|
|
4374
|
+
*/
|
|
4375
|
+
refunds?: Refund[];
|
|
4051
4376
|
}
|
|
4052
|
-
interface
|
|
4053
|
-
|
|
4377
|
+
interface Payment extends PaymentPaymentDetailsOneOf, PaymentReceiptInfoOneOf {
|
|
4378
|
+
/** Regular payment details. */
|
|
4379
|
+
regularPaymentDetails?: RegularPaymentDetails;
|
|
4380
|
+
/** Gift card payment details. */
|
|
4381
|
+
giftcardPaymentDetails?: GiftCardPaymentDetails;
|
|
4382
|
+
/**
|
|
4383
|
+
* Payment ID.
|
|
4384
|
+
* @format GUID
|
|
4385
|
+
* @readonly
|
|
4386
|
+
*/
|
|
4387
|
+
id?: string | null;
|
|
4388
|
+
/** 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. */
|
|
4389
|
+
createdDate?: Date | null;
|
|
4390
|
+
/**
|
|
4391
|
+
* Date and time the payment was last updated in [ISO-8601](https://en.wikipedia.org/wiki/ISO_8601#Combined_date_and_time_representations) format.
|
|
4392
|
+
* @readonly
|
|
4393
|
+
*/
|
|
4394
|
+
updatedDate?: Date | null;
|
|
4395
|
+
/** Payment amount. */
|
|
4396
|
+
amount?: Price;
|
|
4397
|
+
/**
|
|
4398
|
+
* Whether refunds for this payment are disabled.
|
|
4399
|
+
* + `true`: This payment is not refundable.
|
|
4400
|
+
* + `false`: This payment may be refunded. However, this ultimately depends on the payment provider.
|
|
4401
|
+
*/
|
|
4402
|
+
refundDisabled?: boolean;
|
|
4054
4403
|
}
|
|
4055
|
-
|
|
4404
|
+
/** @oneof */
|
|
4405
|
+
interface PaymentPaymentDetailsOneOf {
|
|
4406
|
+
/** Regular payment details. */
|
|
4407
|
+
regularPaymentDetails?: RegularPaymentDetails;
|
|
4408
|
+
/** Gift card payment details. */
|
|
4409
|
+
giftcardPaymentDetails?: GiftCardPaymentDetails;
|
|
4056
4410
|
}
|
|
4057
|
-
|
|
4058
|
-
|
|
4411
|
+
/** @oneof */
|
|
4412
|
+
interface PaymentReceiptInfoOneOf {
|
|
4059
4413
|
}
|
|
4060
|
-
interface
|
|
4061
|
-
|
|
4062
|
-
|
|
4063
|
-
emailPreview?: string;
|
|
4064
|
-
}
|
|
4065
|
-
interface MetaSiteSpecialEvent extends MetaSiteSpecialEventPayloadOneOf {
|
|
4066
|
-
/** Emitted on a meta site creation. */
|
|
4067
|
-
siteCreated?: SiteCreated;
|
|
4068
|
-
/** Emitted on a meta site transfer completion. */
|
|
4069
|
-
siteTransferred?: SiteTransferred;
|
|
4070
|
-
/** Emitted on a meta site deletion. */
|
|
4071
|
-
siteDeleted?: SiteDeleted;
|
|
4072
|
-
/** Emitted on a meta site restoration. */
|
|
4073
|
-
siteUndeleted?: SiteUndeleted;
|
|
4074
|
-
/** Emitted on the first* publish of the meta site (* switching from unpublished to published state). */
|
|
4075
|
-
sitePublished?: SitePublished;
|
|
4076
|
-
/** Emitted on a meta site unpublish. */
|
|
4077
|
-
siteUnpublished?: SiteUnpublished;
|
|
4078
|
-
/** Emitted when meta site is marked as template. */
|
|
4079
|
-
siteMarkedAsTemplate?: SiteMarkedAsTemplate;
|
|
4080
|
-
/** Emitted when meta site is marked as a WixSite. */
|
|
4081
|
-
siteMarkedAsWixSite?: SiteMarkedAsWixSite;
|
|
4082
|
-
/** Emitted when an application is provisioned (installed). */
|
|
4083
|
-
serviceProvisioned?: ServiceProvisioned;
|
|
4084
|
-
/** Emitted when an application is removed (uninstalled). */
|
|
4085
|
-
serviceRemoved?: ServiceRemoved;
|
|
4086
|
-
/** Emitted when meta site name (URL slug) is changed. */
|
|
4087
|
-
siteRenamedPayload?: SiteRenamed;
|
|
4088
|
-
/** Emitted when meta site was permanently deleted. */
|
|
4089
|
-
hardDeleted?: SiteHardDeleted;
|
|
4090
|
-
/** Emitted on a namespace change. */
|
|
4091
|
-
namespaceChanged?: NamespaceChanged;
|
|
4092
|
-
/** Emitted when Studio is attached. */
|
|
4093
|
-
studioAssigned?: StudioAssigned;
|
|
4094
|
-
/** Emitted when Studio is detached. */
|
|
4095
|
-
studioUnassigned?: StudioUnassigned;
|
|
4096
|
-
/**
|
|
4097
|
-
* Emitted when one of the URLs is changed. After this event you may call `urls-server` to fetch
|
|
4098
|
-
* the actual URL.
|
|
4099
|
-
*
|
|
4100
|
-
* See: https://wix.slack.com/archives/C0UHEBPFT/p1732520791210559?thread_ts=1732027914.294059&cid=C0UHEBPFT
|
|
4101
|
-
* See: https://wix.slack.com/archives/C0UHEBPFT/p1744115197619459
|
|
4102
|
-
*/
|
|
4103
|
-
urlChanged?: SiteUrlChanged;
|
|
4104
|
-
/** Site is marked as PurgedExternally */
|
|
4105
|
-
sitePurgedExternally?: SitePurgedExternally;
|
|
4106
|
-
/** Emitted when Odeditor is attached. */
|
|
4107
|
-
odeditorAssigned?: OdeditorAssigned;
|
|
4108
|
-
/** Emitted when Odeditor is detached. */
|
|
4109
|
-
odeditorUnassigned?: OdeditorUnassigned;
|
|
4110
|
-
/** Emitted when Picasso is attached. */
|
|
4111
|
-
picassoAssigned?: PicassoAssigned;
|
|
4112
|
-
/** Emitted when Picasso is detached. */
|
|
4113
|
-
picassoUnassigned?: PicassoUnassigned;
|
|
4114
|
-
/** Emitted when Wixel is attached. */
|
|
4115
|
-
wixelAssigned?: WixelAssigned;
|
|
4116
|
-
/** Emitted when Wixel is detached. */
|
|
4117
|
-
wixelUnassigned?: WixelUnassigned;
|
|
4118
|
-
/** Emitted when StudioTwo is attached. */
|
|
4119
|
-
studioTwoAssigned?: StudioTwoAssigned;
|
|
4120
|
-
/** Emitted when StudioTwo is detached. */
|
|
4121
|
-
studioTwoUnassigned?: StudioTwoUnassigned;
|
|
4122
|
-
/** Emitted when media from user domain is enabled. */
|
|
4123
|
-
userDomainMediaEnabled?: UserDomainMediaEnabled;
|
|
4124
|
-
/** Emitted when media from user domain is disabled. */
|
|
4125
|
-
userDomainMediaDisabled?: UserDomainMediaDisabled;
|
|
4126
|
-
/** Emitted when Editorless is attached. */
|
|
4127
|
-
editorlessAssigned?: EditorlessAssigned;
|
|
4128
|
-
/** Emitted when Editorless is detached. */
|
|
4129
|
-
editorlessUnassigned?: EditorlessUnassigned;
|
|
4130
|
-
/**
|
|
4131
|
-
* A meta site id.
|
|
4132
|
-
* @format GUID
|
|
4133
|
-
*/
|
|
4134
|
-
metaSiteId?: string;
|
|
4135
|
-
/** A meta site version. Monotonically increasing. */
|
|
4136
|
-
version?: string;
|
|
4137
|
-
/** A timestamp of the event. */
|
|
4138
|
-
timestamp?: string;
|
|
4139
|
-
/**
|
|
4140
|
-
* TODO(meta-site): Change validation once validations are disabled for consumers
|
|
4141
|
-
* More context: https://wix.slack.com/archives/C0UHEBPFT/p1720957844413149 and https://wix.slack.com/archives/CFWKX325T/p1728892152855659
|
|
4142
|
-
* @maxSize 4000
|
|
4143
|
-
*/
|
|
4144
|
-
assets?: Asset[];
|
|
4145
|
-
}
|
|
4146
|
-
/** @oneof */
|
|
4147
|
-
interface MetaSiteSpecialEventPayloadOneOf {
|
|
4148
|
-
/** Emitted on a meta site creation. */
|
|
4149
|
-
siteCreated?: SiteCreated;
|
|
4150
|
-
/** Emitted on a meta site transfer completion. */
|
|
4151
|
-
siteTransferred?: SiteTransferred;
|
|
4152
|
-
/** Emitted on a meta site deletion. */
|
|
4153
|
-
siteDeleted?: SiteDeleted;
|
|
4154
|
-
/** Emitted on a meta site restoration. */
|
|
4155
|
-
siteUndeleted?: SiteUndeleted;
|
|
4156
|
-
/** Emitted on the first* publish of the meta site (* switching from unpublished to published state). */
|
|
4157
|
-
sitePublished?: SitePublished;
|
|
4158
|
-
/** Emitted on a meta site unpublish. */
|
|
4159
|
-
siteUnpublished?: SiteUnpublished;
|
|
4160
|
-
/** Emitted when meta site is marked as template. */
|
|
4161
|
-
siteMarkedAsTemplate?: SiteMarkedAsTemplate;
|
|
4162
|
-
/** Emitted when meta site is marked as a WixSite. */
|
|
4163
|
-
siteMarkedAsWixSite?: SiteMarkedAsWixSite;
|
|
4164
|
-
/** Emitted when an application is provisioned (installed). */
|
|
4165
|
-
serviceProvisioned?: ServiceProvisioned;
|
|
4166
|
-
/** Emitted when an application is removed (uninstalled). */
|
|
4167
|
-
serviceRemoved?: ServiceRemoved;
|
|
4168
|
-
/** Emitted when meta site name (URL slug) is changed. */
|
|
4169
|
-
siteRenamedPayload?: SiteRenamed;
|
|
4170
|
-
/** Emitted when meta site was permanently deleted. */
|
|
4171
|
-
hardDeleted?: SiteHardDeleted;
|
|
4172
|
-
/** Emitted on a namespace change. */
|
|
4173
|
-
namespaceChanged?: NamespaceChanged;
|
|
4174
|
-
/** Emitted when Studio is attached. */
|
|
4175
|
-
studioAssigned?: StudioAssigned;
|
|
4176
|
-
/** Emitted when Studio is detached. */
|
|
4177
|
-
studioUnassigned?: StudioUnassigned;
|
|
4178
|
-
/**
|
|
4179
|
-
* Emitted when one of the URLs is changed. After this event you may call `urls-server` to fetch
|
|
4180
|
-
* the actual URL.
|
|
4181
|
-
*
|
|
4182
|
-
* See: https://wix.slack.com/archives/C0UHEBPFT/p1732520791210559?thread_ts=1732027914.294059&cid=C0UHEBPFT
|
|
4183
|
-
* See: https://wix.slack.com/archives/C0UHEBPFT/p1744115197619459
|
|
4184
|
-
*/
|
|
4185
|
-
urlChanged?: SiteUrlChanged;
|
|
4186
|
-
/** Site is marked as PurgedExternally */
|
|
4187
|
-
sitePurgedExternally?: SitePurgedExternally;
|
|
4188
|
-
/** Emitted when Odeditor is attached. */
|
|
4189
|
-
odeditorAssigned?: OdeditorAssigned;
|
|
4190
|
-
/** Emitted when Odeditor is detached. */
|
|
4191
|
-
odeditorUnassigned?: OdeditorUnassigned;
|
|
4192
|
-
/** Emitted when Picasso is attached. */
|
|
4193
|
-
picassoAssigned?: PicassoAssigned;
|
|
4194
|
-
/** Emitted when Picasso is detached. */
|
|
4195
|
-
picassoUnassigned?: PicassoUnassigned;
|
|
4196
|
-
/** Emitted when Wixel is attached. */
|
|
4197
|
-
wixelAssigned?: WixelAssigned;
|
|
4198
|
-
/** Emitted when Wixel is detached. */
|
|
4199
|
-
wixelUnassigned?: WixelUnassigned;
|
|
4200
|
-
/** Emitted when StudioTwo is attached. */
|
|
4201
|
-
studioTwoAssigned?: StudioTwoAssigned;
|
|
4202
|
-
/** Emitted when StudioTwo is detached. */
|
|
4203
|
-
studioTwoUnassigned?: StudioTwoUnassigned;
|
|
4204
|
-
/** Emitted when media from user domain is enabled. */
|
|
4205
|
-
userDomainMediaEnabled?: UserDomainMediaEnabled;
|
|
4206
|
-
/** Emitted when media from user domain is disabled. */
|
|
4207
|
-
userDomainMediaDisabled?: UserDomainMediaDisabled;
|
|
4208
|
-
/** Emitted when Editorless is attached. */
|
|
4209
|
-
editorlessAssigned?: EditorlessAssigned;
|
|
4210
|
-
/** Emitted when Editorless is detached. */
|
|
4211
|
-
editorlessUnassigned?: EditorlessUnassigned;
|
|
4212
|
-
}
|
|
4213
|
-
interface Asset {
|
|
4214
|
-
/**
|
|
4215
|
-
* An application definition id (app_id in dev-center). For legacy reasons may be UUID or a string (from Java Enum).
|
|
4216
|
-
* @maxLength 36
|
|
4217
|
-
*/
|
|
4218
|
-
appDefId?: string;
|
|
4219
|
-
/**
|
|
4220
|
-
* An instance id. For legacy reasons may be UUID or a string.
|
|
4221
|
-
* @maxLength 200
|
|
4222
|
-
*/
|
|
4223
|
-
instanceId?: string;
|
|
4224
|
-
/** An application state. */
|
|
4225
|
-
state?: StateWithLiterals;
|
|
4226
|
-
}
|
|
4227
|
-
declare enum State {
|
|
4228
|
-
UNKNOWN = "UNKNOWN",
|
|
4229
|
-
ENABLED = "ENABLED",
|
|
4230
|
-
DISABLED = "DISABLED",
|
|
4231
|
-
PENDING = "PENDING",
|
|
4232
|
-
DEMO = "DEMO"
|
|
4233
|
-
}
|
|
4234
|
-
/** @enumType */
|
|
4235
|
-
type StateWithLiterals = State | 'UNKNOWN' | 'ENABLED' | 'DISABLED' | 'PENDING' | 'DEMO';
|
|
4236
|
-
interface SiteCreated {
|
|
4237
|
-
/**
|
|
4238
|
-
* A template identifier (empty if not created from a template).
|
|
4239
|
-
* @maxLength 36
|
|
4240
|
-
*/
|
|
4241
|
-
originTemplateId?: string;
|
|
4242
|
-
/**
|
|
4243
|
-
* An account id of the owner.
|
|
4244
|
-
* @format GUID
|
|
4245
|
-
*/
|
|
4246
|
-
ownerId?: string;
|
|
4247
|
-
/** A context in which meta site was created. */
|
|
4248
|
-
context?: SiteCreatedContextWithLiterals;
|
|
4249
|
-
/**
|
|
4250
|
-
* A meta site id from which this site was created.
|
|
4251
|
-
*
|
|
4252
|
-
* In case of a creation from a template it's a template id.
|
|
4253
|
-
* In case of a site duplication ("Save As" in dashboard or duplicate in UM) it's an id of a source site.
|
|
4254
|
-
* @format GUID
|
|
4255
|
-
*/
|
|
4256
|
-
originMetaSiteId?: string | null;
|
|
4257
|
-
/**
|
|
4258
|
-
* A meta site name (URL slug).
|
|
4259
|
-
* @maxLength 20
|
|
4260
|
-
*/
|
|
4261
|
-
siteName?: string;
|
|
4262
|
-
/** A namespace. */
|
|
4263
|
-
namespace?: NamespaceWithLiterals;
|
|
4264
|
-
}
|
|
4265
|
-
declare enum SiteCreatedContext {
|
|
4266
|
-
/** A valid option, we don't expose all reasons why site might be created. */
|
|
4267
|
-
OTHER = "OTHER",
|
|
4268
|
-
/** A meta site was created from template. */
|
|
4269
|
-
FROM_TEMPLATE = "FROM_TEMPLATE",
|
|
4270
|
-
/** A meta site was created by copying of the transfferred meta site. */
|
|
4271
|
-
DUPLICATE_BY_SITE_TRANSFER = "DUPLICATE_BY_SITE_TRANSFER",
|
|
4272
|
-
/** A copy of existing meta site. */
|
|
4273
|
-
DUPLICATE = "DUPLICATE",
|
|
4274
|
-
/** A meta site was created as a transfferred site (copy of the original), old flow, should die soon. */
|
|
4275
|
-
OLD_SITE_TRANSFER = "OLD_SITE_TRANSFER",
|
|
4276
|
-
/** deprecated A meta site was created for Flash editor. */
|
|
4277
|
-
FLASH = "FLASH"
|
|
4278
|
-
}
|
|
4279
|
-
/** @enumType */
|
|
4280
|
-
type SiteCreatedContextWithLiterals = SiteCreatedContext | 'OTHER' | 'FROM_TEMPLATE' | 'DUPLICATE_BY_SITE_TRANSFER' | 'DUPLICATE' | 'OLD_SITE_TRANSFER' | 'FLASH';
|
|
4281
|
-
declare enum Namespace {
|
|
4282
|
-
UNKNOWN_NAMESPACE = "UNKNOWN_NAMESPACE",
|
|
4283
|
-
/** Default namespace for UGC sites. MetaSites with this namespace will be shown in a user's site list by default. */
|
|
4284
|
-
WIX = "WIX",
|
|
4285
|
-
/** 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. */
|
|
4286
|
-
SHOUT_OUT = "SHOUT_OUT",
|
|
4287
|
-
/** 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. */
|
|
4288
|
-
ALBUMS = "ALBUMS",
|
|
4289
|
-
/** 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. */
|
|
4290
|
-
WIX_STORES_TEST_DRIVE = "WIX_STORES_TEST_DRIVE",
|
|
4291
|
-
/** Hotels standalone (siteless). MetaSites with this namespace will *not* be shown in a user's site list by default. */
|
|
4292
|
-
HOTELS = "HOTELS",
|
|
4293
|
-
/** 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. */
|
|
4294
|
-
CLUBS = "CLUBS",
|
|
4295
|
-
/** A partially created ADI website. MetaSites with this namespace will *not* be shown in a user's site list by default. */
|
|
4296
|
-
ONBOARDING_DRAFT = "ONBOARDING_DRAFT",
|
|
4297
|
-
/** AppBuilder for AppStudio / shmite (c). MetaSites with this namespace will *not* be shown in a user's site list by default. */
|
|
4298
|
-
DEV_SITE = "DEV_SITE",
|
|
4299
|
-
/** 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. */
|
|
4300
|
-
LOGOS = "LOGOS",
|
|
4301
|
-
/** 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. */
|
|
4302
|
-
VIDEO_MAKER = "VIDEO_MAKER",
|
|
4303
|
-
/** MetaSites with this namespace will *not* be shown in a user's site list by default. */
|
|
4304
|
-
PARTNER_DASHBOARD = "PARTNER_DASHBOARD",
|
|
4305
|
-
/** MetaSites with this namespace will *not* be shown in a user's site list by default. */
|
|
4306
|
-
DEV_CENTER_COMPANY = "DEV_CENTER_COMPANY",
|
|
4307
|
-
/**
|
|
4308
|
-
* A draft created by HTML editor on open. Upon "first save" it will be moved to be of WIX domain.
|
|
4309
|
-
*
|
|
4310
|
-
* Meta site with this namespace will *not* be shown in a user's site list by default.
|
|
4311
|
-
*/
|
|
4312
|
-
HTML_DRAFT = "HTML_DRAFT",
|
|
4313
|
-
/**
|
|
4314
|
-
* the user-journey for Fitness users who want to start from managing their business instead of designing their website.
|
|
4315
|
-
* Will be accessible from Site List and will not have a website app.
|
|
4316
|
-
* Once the user attaches a site, the site will become a regular wixsite.
|
|
4317
|
-
*/
|
|
4318
|
-
SITELESS_BUSINESS = "SITELESS_BUSINESS",
|
|
4319
|
-
/** Belongs to "strategic products" company. Supports new product in the creator's economy space. */
|
|
4320
|
-
CREATOR_ECONOMY = "CREATOR_ECONOMY",
|
|
4321
|
-
/** It is to be used in the Business First efforts. */
|
|
4322
|
-
DASHBOARD_FIRST = "DASHBOARD_FIRST",
|
|
4323
|
-
/** Bookings business flow with no site. */
|
|
4324
|
-
ANYWHERE = "ANYWHERE",
|
|
4325
|
-
/** Namespace for Headless Backoffice with no editor */
|
|
4326
|
-
HEADLESS = "HEADLESS",
|
|
4327
|
-
/**
|
|
4328
|
-
* Namespace for master site that will exist in parent account that will be referenced by subaccounts
|
|
4329
|
-
* The site will be used for account level CSM feature for enterprise
|
|
4330
|
-
*/
|
|
4331
|
-
ACCOUNT_MASTER_CMS = "ACCOUNT_MASTER_CMS",
|
|
4332
|
-
/** Rise.ai Siteless account management for Gift Cards and Store Credit. */
|
|
4333
|
-
RISE = "RISE",
|
|
4334
|
-
/**
|
|
4335
|
-
* As part of the branded app new funnel, users now can create a meta site that will be branded app first.
|
|
4336
|
-
* There's a blank site behind the scene but it's blank).
|
|
4337
|
-
* The Mobile company will be the owner of this namespace.
|
|
4338
|
-
*/
|
|
4339
|
-
BRANDED_FIRST = "BRANDED_FIRST",
|
|
4340
|
-
/** Nownia.com Siteless account management for Ai Scheduling Assistant. */
|
|
4341
|
-
NOWNIA = "NOWNIA",
|
|
4342
|
-
/**
|
|
4343
|
-
* UGC Templates are templates that are created by users for personal use and to sale to other users.
|
|
4344
|
-
* The Partners company owns this namespace.
|
|
4345
|
-
*/
|
|
4346
|
-
UGC_TEMPLATE = "UGC_TEMPLATE",
|
|
4347
|
-
/** Codux Headless Sites */
|
|
4348
|
-
CODUX = "CODUX",
|
|
4349
|
-
/** Bobb - AI Design Creator. */
|
|
4350
|
-
MEDIA_DESIGN_CREATOR = "MEDIA_DESIGN_CREATOR",
|
|
4351
|
-
/**
|
|
4352
|
-
* Shared Blog Site is a unique single site across Enterprise account,
|
|
4353
|
-
* This site will hold all Blog posts related to the Marketing product.
|
|
4354
|
-
*/
|
|
4355
|
-
SHARED_BLOG_ENTERPRISE = "SHARED_BLOG_ENTERPRISE",
|
|
4356
|
-
/** Standalone forms (siteless). MetaSites with this namespace will *not* be shown in a user's site list by default. */
|
|
4357
|
-
STANDALONE_FORMS = "STANDALONE_FORMS",
|
|
4358
|
-
/** Standalone events (siteless). MetaSites with this namespace will *not* be shown in a user's site list by default. */
|
|
4359
|
-
STANDALONE_EVENTS = "STANDALONE_EVENTS",
|
|
4360
|
-
/** MIMIR - Siteless account for MIMIR Ai Job runner. */
|
|
4361
|
-
MIMIR = "MIMIR",
|
|
4362
|
-
/** Wix Twins platform. */
|
|
4363
|
-
TWINS = "TWINS",
|
|
4364
|
-
/** Wix Nano. */
|
|
4365
|
-
NANO = "NANO",
|
|
4366
|
-
/** Base44 headless sites. */
|
|
4367
|
-
BASE44 = "BASE44",
|
|
4368
|
-
/** Wix Channels Sites */
|
|
4369
|
-
CHANNELS = "CHANNELS",
|
|
4370
|
-
/** Nautilus platform. */
|
|
4371
|
-
NAUTILUS = "NAUTILUS"
|
|
4372
|
-
}
|
|
4373
|
-
/** @enumType */
|
|
4374
|
-
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';
|
|
4375
|
-
/** Site transferred to another user. */
|
|
4376
|
-
interface SiteTransferred {
|
|
4377
|
-
/**
|
|
4378
|
-
* A previous owner id (user that transfers meta site).
|
|
4379
|
-
* @format GUID
|
|
4380
|
-
*/
|
|
4381
|
-
oldOwnerId?: string;
|
|
4382
|
-
/**
|
|
4383
|
-
* A new owner id (user that accepts meta site).
|
|
4384
|
-
* @format GUID
|
|
4385
|
-
*/
|
|
4386
|
-
newOwnerId?: string;
|
|
4387
|
-
}
|
|
4388
|
-
/** Soft deletion of the meta site. Could be restored. */
|
|
4389
|
-
interface SiteDeleted {
|
|
4390
|
-
/** A deletion context. */
|
|
4391
|
-
deleteContext?: DeleteContext;
|
|
4392
|
-
}
|
|
4393
|
-
interface DeleteContext {
|
|
4394
|
-
/** When the meta site was deleted. */
|
|
4395
|
-
dateDeleted?: Date | null;
|
|
4396
|
-
/** A status. */
|
|
4397
|
-
deleteStatus?: DeleteStatusWithLiterals;
|
|
4398
|
-
/**
|
|
4399
|
-
* A reason (flow).
|
|
4400
|
-
* @maxLength 255
|
|
4401
|
-
*/
|
|
4402
|
-
deleteOrigin?: string;
|
|
4403
|
-
/**
|
|
4404
|
-
* A service that deleted it.
|
|
4405
|
-
* @maxLength 255
|
|
4406
|
-
*/
|
|
4407
|
-
initiatorId?: string | null;
|
|
4408
|
-
}
|
|
4409
|
-
declare enum DeleteStatus {
|
|
4410
|
-
UNKNOWN = "UNKNOWN",
|
|
4411
|
-
TRASH = "TRASH",
|
|
4412
|
-
DELETED = "DELETED",
|
|
4413
|
-
PENDING_PURGE = "PENDING_PURGE",
|
|
4414
|
-
PURGED_EXTERNALLY = "PURGED_EXTERNALLY"
|
|
4415
|
-
}
|
|
4416
|
-
/** @enumType */
|
|
4417
|
-
type DeleteStatusWithLiterals = DeleteStatus | 'UNKNOWN' | 'TRASH' | 'DELETED' | 'PENDING_PURGE' | 'PURGED_EXTERNALLY';
|
|
4418
|
-
/** Restoration of the meta site. */
|
|
4419
|
-
interface SiteUndeleted {
|
|
4420
|
-
}
|
|
4421
|
-
/** First publish of a meta site. Or subsequent publish after unpublish. */
|
|
4422
|
-
interface SitePublished {
|
|
4423
|
-
}
|
|
4424
|
-
interface SiteUnpublished {
|
|
4425
|
-
/**
|
|
4426
|
-
* A list of URLs previously associated with the meta site.
|
|
4427
|
-
* @maxLength 4000
|
|
4428
|
-
* @maxSize 10000
|
|
4429
|
-
*/
|
|
4430
|
-
urls?: string[];
|
|
4431
|
-
}
|
|
4432
|
-
interface SiteMarkedAsTemplate {
|
|
4433
|
-
}
|
|
4434
|
-
interface SiteMarkedAsWixSite {
|
|
4435
|
-
}
|
|
4436
|
-
/**
|
|
4437
|
-
* Represents a service provisioned a site.
|
|
4438
|
-
*
|
|
4439
|
-
* Note on `origin_instance_id`:
|
|
4440
|
-
* There is no guarantee that you will be able to find a meta site using `origin_instance_id`.
|
|
4441
|
-
* This is because of the following scenario:
|
|
4442
|
-
*
|
|
4443
|
-
* Imagine you have a template where a third-party application (TPA) includes some stub data,
|
|
4444
|
-
* such as a product catalog. When you create a site from this template, you inherit this
|
|
4445
|
-
* default product catalog. However, if the template's product catalog is modified,
|
|
4446
|
-
* your site will retain the catalog as it was at the time of site creation. This ensures that
|
|
4447
|
-
* your site remains consistent with what you initially received and does not include any
|
|
4448
|
-
* changes made to the original template afterward.
|
|
4449
|
-
* To ensure this, the TPA on the template gets a new instance_id.
|
|
4450
|
-
*/
|
|
4451
|
-
interface ServiceProvisioned {
|
|
4452
|
-
/**
|
|
4453
|
-
* Either UUID or EmbeddedServiceType.
|
|
4454
|
-
* @maxLength 36
|
|
4455
|
-
*/
|
|
4456
|
-
appDefId?: string;
|
|
4457
|
-
/**
|
|
4458
|
-
* Not only UUID. Something here could be something weird.
|
|
4459
|
-
* @maxLength 36
|
|
4460
|
-
*/
|
|
4461
|
-
instanceId?: string;
|
|
4462
|
-
/**
|
|
4463
|
-
* An instance id from which this instance is originated.
|
|
4464
|
-
* @maxLength 36
|
|
4465
|
-
*/
|
|
4466
|
-
originInstanceId?: string;
|
|
4467
|
-
/**
|
|
4468
|
-
* A version.
|
|
4469
|
-
* @maxLength 500
|
|
4470
|
-
*/
|
|
4471
|
-
version?: string | null;
|
|
4472
|
-
/**
|
|
4473
|
-
* The origin meta site id
|
|
4474
|
-
* @format GUID
|
|
4475
|
-
*/
|
|
4476
|
-
originMetaSiteId?: string | null;
|
|
4477
|
-
}
|
|
4478
|
-
interface ServiceRemoved {
|
|
4479
|
-
/**
|
|
4480
|
-
* Either UUID or EmbeddedServiceType.
|
|
4481
|
-
* @maxLength 36
|
|
4482
|
-
*/
|
|
4483
|
-
appDefId?: string;
|
|
4484
|
-
/**
|
|
4485
|
-
* Not only UUID. Something here could be something weird.
|
|
4486
|
-
* @maxLength 36
|
|
4487
|
-
*/
|
|
4488
|
-
instanceId?: string;
|
|
4489
|
-
/**
|
|
4490
|
-
* A version.
|
|
4491
|
-
* @maxLength 500
|
|
4492
|
-
*/
|
|
4493
|
-
version?: string | null;
|
|
4494
|
-
}
|
|
4495
|
-
/** Rename of the site. Meaning, free public url has been changed as well. */
|
|
4496
|
-
interface SiteRenamed {
|
|
4497
|
-
/**
|
|
4498
|
-
* A new meta site name (URL slug).
|
|
4499
|
-
* @maxLength 20
|
|
4500
|
-
*/
|
|
4501
|
-
newSiteName?: string;
|
|
4502
|
-
/**
|
|
4503
|
-
* A previous meta site name (URL slug).
|
|
4504
|
-
* @maxLength 255
|
|
4505
|
-
*/
|
|
4506
|
-
oldSiteName?: string;
|
|
4507
|
-
}
|
|
4508
|
-
/**
|
|
4509
|
-
* Hard deletion of the meta site.
|
|
4510
|
-
*
|
|
4511
|
-
* Could not be restored. Therefore it's desirable to cleanup data.
|
|
4512
|
-
*/
|
|
4513
|
-
interface SiteHardDeleted {
|
|
4514
|
-
/** A deletion context. */
|
|
4515
|
-
deleteContext?: DeleteContext;
|
|
4516
|
-
}
|
|
4517
|
-
interface NamespaceChanged {
|
|
4518
|
-
/** A previous namespace. */
|
|
4519
|
-
oldNamespace?: NamespaceWithLiterals;
|
|
4520
|
-
/** A new namespace. */
|
|
4521
|
-
newNamespace?: NamespaceWithLiterals;
|
|
4522
|
-
}
|
|
4523
|
-
/** Assigned Studio editor */
|
|
4524
|
-
interface StudioAssigned {
|
|
4525
|
-
}
|
|
4526
|
-
/** Unassigned Studio editor */
|
|
4527
|
-
interface StudioUnassigned {
|
|
4528
|
-
}
|
|
4529
|
-
/**
|
|
4530
|
-
* Fired in case site URLs were changed in any way: new secondary domain, published, account slug rename, site rename etc.
|
|
4531
|
-
*
|
|
4532
|
-
* This is an internal event, it's not propagated in special events, because it's non-actionable. If you need to keep up
|
|
4533
|
-
* with sites and its urls, you need to listen to another topic/event. Read about it:
|
|
4534
|
-
*
|
|
4535
|
-
* https://bo.wix.com/wix-docs/rest/meta-site/meta-site---urls-service
|
|
4536
|
-
*/
|
|
4537
|
-
interface SiteUrlChanged {
|
|
4538
|
-
}
|
|
4539
|
-
/**
|
|
4540
|
-
* Used at the end of the deletion flow for both draft sites and when a user deletes a site.
|
|
4541
|
-
* Consumed by other teams to remove relevant data.
|
|
4542
|
-
*/
|
|
4543
|
-
interface SitePurgedExternally {
|
|
4544
|
-
/**
|
|
4545
|
-
* @maxLength 2048
|
|
4546
|
-
* @maxSize 100
|
|
4547
|
-
* @deprecated
|
|
4548
|
-
* @targetRemovalDate 2025-04-15
|
|
4549
|
-
*/
|
|
4550
|
-
appDefId?: string[];
|
|
4551
|
-
}
|
|
4552
|
-
/** Assigned Odeditor */
|
|
4553
|
-
interface OdeditorAssigned {
|
|
4554
|
-
}
|
|
4555
|
-
/** Unassigned Odeditor */
|
|
4556
|
-
interface OdeditorUnassigned {
|
|
4557
|
-
}
|
|
4558
|
-
/** Assigned Picasso editor */
|
|
4559
|
-
interface PicassoAssigned {
|
|
4560
|
-
}
|
|
4561
|
-
/** Unassigned Picasso */
|
|
4562
|
-
interface PicassoUnassigned {
|
|
4563
|
-
}
|
|
4564
|
-
/** Assigned Wixel */
|
|
4565
|
-
interface WixelAssigned {
|
|
4566
|
-
}
|
|
4567
|
-
/** Unassigned Wixel */
|
|
4568
|
-
interface WixelUnassigned {
|
|
4569
|
-
}
|
|
4570
|
-
/** Assigned StudioTwo */
|
|
4571
|
-
interface StudioTwoAssigned {
|
|
4572
|
-
}
|
|
4573
|
-
/** Unassigned StudioTwo */
|
|
4574
|
-
interface StudioTwoUnassigned {
|
|
4575
|
-
}
|
|
4576
|
-
/** Media from user domain is enabled. */
|
|
4577
|
-
interface UserDomainMediaEnabled {
|
|
4578
|
-
}
|
|
4579
|
-
/** Media from user domain is disabled. */
|
|
4580
|
-
interface UserDomainMediaDisabled {
|
|
4581
|
-
}
|
|
4582
|
-
/** Assigned Editorless */
|
|
4583
|
-
interface EditorlessAssigned {
|
|
4584
|
-
}
|
|
4585
|
-
/** Unassigned Editorless */
|
|
4586
|
-
interface EditorlessUnassigned {
|
|
4587
|
-
}
|
|
4588
|
-
interface HasCustomEmailConfigurationsRequest {
|
|
4589
|
-
}
|
|
4590
|
-
interface HasCustomEmailConfigurationsResponse {
|
|
4591
|
-
hasCustomConfigurations?: boolean;
|
|
4592
|
-
}
|
|
4593
|
-
interface AddToAutomationMigrationPopulationRequest {
|
|
4594
|
-
/** When true, sends custom email configurations to automation system via email */
|
|
4595
|
-
sendCustomEmailConfigs?: boolean;
|
|
4596
|
-
/** Origin of the migration request. Defaults to OPT_IN when UNKNOWN_ORIGIN. */
|
|
4597
|
-
origin?: OriginWithLiterals;
|
|
4598
|
-
}
|
|
4599
|
-
declare enum Origin {
|
|
4600
|
-
OPT_IN = "OPT_IN",
|
|
4601
|
-
MIGRATION = "MIGRATION"
|
|
4602
|
-
}
|
|
4603
|
-
/** @enumType */
|
|
4604
|
-
type OriginWithLiterals = Origin | 'OPT_IN' | 'MIGRATION';
|
|
4605
|
-
interface AddToAutomationMigrationPopulationResponse {
|
|
4606
|
-
success?: boolean;
|
|
4607
|
-
}
|
|
4608
|
-
interface IsInAutomationMigrationPopulationRequest {
|
|
4609
|
-
}
|
|
4610
|
-
interface IsInAutomationMigrationPopulationResponse {
|
|
4611
|
-
inPopulation?: boolean;
|
|
4612
|
-
}
|
|
4613
|
-
interface PreparePaymentCollectionRequest {
|
|
4414
|
+
interface RegularPaymentDetails extends RegularPaymentDetailsPaymentMethodDetailsOneOf {
|
|
4415
|
+
/** Credit card details. */
|
|
4416
|
+
creditCardDetails?: CreditCardPaymentMethodDetails;
|
|
4614
4417
|
/**
|
|
4615
|
-
*
|
|
4616
|
-
* @minLength 1
|
|
4418
|
+
* Wix Payments order ID.
|
|
4617
4419
|
* @maxLength 100
|
|
4618
4420
|
*/
|
|
4619
|
-
|
|
4620
|
-
/** Amount to collect */
|
|
4621
|
-
amount: Price;
|
|
4622
|
-
/**
|
|
4623
|
-
* Optional parameter. When present, payment collection will be performed using given payment gateway order.
|
|
4624
|
-
* Existing payment gateway order will be updated with a new amount.
|
|
4625
|
-
* When parameter is absent, new payment gateway order will be created and used for payment collection.
|
|
4626
|
-
*/
|
|
4627
|
-
paymentGatewayOrderId?: string | null;
|
|
4628
|
-
/**
|
|
4629
|
-
* Whether to delay capture of the payment.
|
|
4630
|
-
* Default: false
|
|
4631
|
-
* @deprecated Whether to delay capture of the payment.
|
|
4632
|
-
* Default: false
|
|
4633
|
-
* @replacedBy delayed_capture_settings.scheduled_action
|
|
4634
|
-
* @targetRemovalDate 2024-09-30
|
|
4635
|
-
*/
|
|
4636
|
-
delayedCapture?: boolean;
|
|
4637
|
-
/** Delayed capture payment settings */
|
|
4638
|
-
delayedCaptureSettings?: DelayedCaptureSettings;
|
|
4639
|
-
}
|
|
4640
|
-
interface RedirectUrls {
|
|
4641
|
-
/**
|
|
4642
|
-
* URL to redirect buyer in case of approved (successful) transaction
|
|
4643
|
-
* @format WEB_URL
|
|
4644
|
-
*/
|
|
4645
|
-
successUrl?: string | null;
|
|
4646
|
-
/**
|
|
4647
|
-
* URL to redirect buyer in case of buyer canceled the transaction
|
|
4648
|
-
* @format WEB_URL
|
|
4649
|
-
*/
|
|
4650
|
-
cancelUrl?: string | null;
|
|
4651
|
-
/**
|
|
4652
|
-
* URL to redirect buyer in case of failed/rejected transaction
|
|
4653
|
-
* @format WEB_URL
|
|
4654
|
-
*/
|
|
4655
|
-
errorUrl?: string | null;
|
|
4656
|
-
/**
|
|
4657
|
-
* URL to redirect buyer in case of pending transaction (that might take some time to process)
|
|
4658
|
-
* @format WEB_URL
|
|
4659
|
-
*/
|
|
4660
|
-
pendingUrl?: string | null;
|
|
4661
|
-
}
|
|
4662
|
-
interface DelayedCaptureSettings {
|
|
4663
|
-
/** Specifies the automatic action (void/capture) for authorized transaction after the specified duration */
|
|
4664
|
-
scheduledAction?: ScheduledActionWithLiterals;
|
|
4665
|
-
/** Delay duration before execution. Optional - if not set, providers default period will be used */
|
|
4666
|
-
delayDuration?: Duration;
|
|
4667
|
-
}
|
|
4668
|
-
declare enum ScheduledAction {
|
|
4669
|
-
/** Whether payment will be auto-voided when duration passes */
|
|
4670
|
-
VOID = "VOID",
|
|
4671
|
-
/** Whether payment will be auto-captured when duration passes */
|
|
4672
|
-
CAPTURE = "CAPTURE"
|
|
4673
|
-
}
|
|
4674
|
-
/** @enumType */
|
|
4675
|
-
type ScheduledActionWithLiterals = ScheduledAction | 'VOID' | 'CAPTURE';
|
|
4676
|
-
interface Duration {
|
|
4677
|
-
/**
|
|
4678
|
-
* Amount of units. For example, 30 MINUTES, 1 HOURS, 7 DAYS, etc
|
|
4679
|
-
* @min 1
|
|
4680
|
-
*/
|
|
4681
|
-
count?: number;
|
|
4682
|
-
/** Duration unit: MINUTES, HOURS and DAYS */
|
|
4683
|
-
unit?: DurationUnitWithLiterals;
|
|
4684
|
-
}
|
|
4685
|
-
declare enum DurationUnit {
|
|
4686
|
-
MINUTES = "MINUTES",
|
|
4687
|
-
HOURS = "HOURS",
|
|
4688
|
-
DAYS = "DAYS"
|
|
4689
|
-
}
|
|
4690
|
-
/** @enumType */
|
|
4691
|
-
type DurationUnitWithLiterals = DurationUnit | 'MINUTES' | 'HOURS' | 'DAYS';
|
|
4692
|
-
interface PreparePaymentCollectionResponse {
|
|
4693
|
-
/** Payment gateway order id which is associated with given payment */
|
|
4694
|
-
paymentGatewayOrderId?: string;
|
|
4695
|
-
}
|
|
4696
|
-
interface GetPaymentCollectabilityStatusRequest {
|
|
4421
|
+
paymentOrderId?: string | null;
|
|
4697
4422
|
/**
|
|
4698
|
-
*
|
|
4699
|
-
*
|
|
4423
|
+
* Payment gateway's transaction ID.
|
|
4424
|
+
* This field is only returned when the value of `offline_payment` is `false`.
|
|
4700
4425
|
* @maxLength 100
|
|
4701
4426
|
*/
|
|
4702
|
-
|
|
4703
|
-
}
|
|
4704
|
-
interface GetPaymentCollectabilityStatusResponse {
|
|
4705
|
-
/** Payment collectability status */
|
|
4706
|
-
status?: PaymentCollectabilityStatusWithLiterals;
|
|
4707
|
-
/** Collectable order amount */
|
|
4708
|
-
amount?: Price;
|
|
4709
|
-
}
|
|
4710
|
-
declare enum PaymentCollectabilityStatus {
|
|
4711
|
-
UNKNOWN = "UNKNOWN",
|
|
4712
|
-
COLLECTABLE = "COLLECTABLE",
|
|
4713
|
-
NONCOLLECTABLE_ORDER_IS_CANCELLED = "NONCOLLECTABLE_ORDER_IS_CANCELLED",
|
|
4714
|
-
NONCOLLECTABLE_ORDER_IS_PAID = "NONCOLLECTABLE_ORDER_IS_PAID",
|
|
4715
|
-
NONCOLLECTABLE_MISSING_PAYMENT_METHOD = "NONCOLLECTABLE_MISSING_PAYMENT_METHOD",
|
|
4716
|
-
NONCOLLECTABLE_ORDER_IS_PENDING = "NONCOLLECTABLE_ORDER_IS_PENDING",
|
|
4717
|
-
NONCOLLECTABLE_ORDER_IS_REJECTED = "NONCOLLECTABLE_ORDER_IS_REJECTED",
|
|
4718
|
-
NONCOLLECTABLE_ORDER_HAS_SUBSCRIPTIONS = "NONCOLLECTABLE_ORDER_HAS_SUBSCRIPTIONS",
|
|
4719
|
-
NONCOLLECTABLE_ORDER_HAS_CHARGEBACKS = "NONCOLLECTABLE_ORDER_HAS_CHARGEBACKS",
|
|
4720
|
-
NONCOLLECTABLE_SUBSCRIPTION_CYCLE_ALREADY_PASSED = "NONCOLLECTABLE_SUBSCRIPTION_CYCLE_ALREADY_PASSED",
|
|
4721
|
-
NONCOLLECTABLE_ORDER_HAS_UNSUPPORTED_SUBSCRIPTION = "NONCOLLECTABLE_ORDER_HAS_UNSUPPORTED_SUBSCRIPTION",
|
|
4722
|
-
NONCOLLECTABLE_CUSTOM_AMOUNT_NOT_SUPPORTED = "NONCOLLECTABLE_CUSTOM_AMOUNT_NOT_SUPPORTED"
|
|
4723
|
-
}
|
|
4724
|
-
/** @enumType */
|
|
4725
|
-
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';
|
|
4726
|
-
interface RecordManuallyCollectedPaymentRequest {
|
|
4427
|
+
gatewayTransactionId?: string | null;
|
|
4727
4428
|
/**
|
|
4728
|
-
*
|
|
4729
|
-
*
|
|
4429
|
+
* Payment method.
|
|
4430
|
+
* Deprecated. Use `paymentMethodName.buyerLanguageName` instead.
|
|
4431
|
+
* Non-exhaustive list of supported values:
|
|
4432
|
+
* + `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`
|
|
4730
4433
|
* @maxLength 100
|
|
4434
|
+
* @deprecated Payment method.
|
|
4435
|
+
* Deprecated. Use `paymentMethodName.buyerLanguageName` instead.
|
|
4436
|
+
* Non-exhaustive list of supported values:
|
|
4437
|
+
* + `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`
|
|
4438
|
+
* @replacedBy payment_method_name
|
|
4439
|
+
* @targetRemovalDate 2026-07-01
|
|
4731
4440
|
*/
|
|
4732
|
-
|
|
4733
|
-
/** Amount to be recorded as approved manual payment for given order */
|
|
4734
|
-
amount: Price;
|
|
4735
|
-
}
|
|
4736
|
-
/**
|
|
4737
|
-
* User-defined payment method name.
|
|
4738
|
-
* Allows specifying either a predefined type or a custom name.
|
|
4739
|
-
*/
|
|
4740
|
-
interface UserDefinedPaymentMethodName extends UserDefinedPaymentMethodNameKindOneOf {
|
|
4741
|
-
/** Predefined payment method. */
|
|
4742
|
-
predefined?: PredefinedPaymentMethodWithLiterals;
|
|
4441
|
+
paymentMethod?: string | null;
|
|
4743
4442
|
/**
|
|
4744
|
-
*
|
|
4745
|
-
*
|
|
4746
|
-
* For example, `"Wire transfer"`, `"Money order"`, `"Venmo"` or any other custom name.
|
|
4747
|
-
* @minLength 1
|
|
4443
|
+
* Transaction ID in the payment provider's system. For example, at PayPal, Square, Stripe, etc. Not returned for offline payments.
|
|
4748
4444
|
* @maxLength 100
|
|
4749
4445
|
*/
|
|
4750
|
-
|
|
4751
|
-
|
|
4752
|
-
|
|
4753
|
-
|
|
4754
|
-
|
|
4755
|
-
predefined?: PredefinedPaymentMethodWithLiterals;
|
|
4446
|
+
providerTransactionId?: string | null;
|
|
4447
|
+
/** Whether the payment was made offline. For example, when using cash or when marked as paid in the Business Manager. */
|
|
4448
|
+
offlinePayment?: boolean;
|
|
4449
|
+
/** Payment status. */
|
|
4450
|
+
status?: TransactionStatusWithLiterals;
|
|
4756
4451
|
/**
|
|
4757
|
-
*
|
|
4758
|
-
*
|
|
4759
|
-
* For example, `"Wire transfer"`, `"Money order"`, `"Venmo"` or any other custom name.
|
|
4760
|
-
* @minLength 1
|
|
4761
|
-
* @maxLength 100
|
|
4452
|
+
* Whether there is a payment agreement that allows for future charges.
|
|
4453
|
+
* @immutable
|
|
4762
4454
|
*/
|
|
4763
|
-
|
|
4764
|
-
|
|
4765
|
-
|
|
4766
|
-
|
|
4767
|
-
|
|
4768
|
-
|
|
4769
|
-
|
|
4770
|
-
|
|
4771
|
-
/**
|
|
4772
|
-
|
|
4773
|
-
}
|
|
4774
|
-
/** @enumType */
|
|
4775
|
-
type PredefinedPaymentMethodWithLiterals = PredefinedPaymentMethod | 'CASH' | 'BANK_TRANSFER' | 'CHECK';
|
|
4776
|
-
interface RecordManuallyCollectedPaymentResponse {
|
|
4777
|
-
}
|
|
4778
|
-
interface MarkOrderAsPaidRequest {
|
|
4455
|
+
savedPaymentMethod?: boolean;
|
|
4456
|
+
/** Authorization details. */
|
|
4457
|
+
authorizationDetails?: AuthorizationDetails;
|
|
4458
|
+
/**
|
|
4459
|
+
* Record of chargebacks made by the buyer.
|
|
4460
|
+
* @maxSize 6
|
|
4461
|
+
*/
|
|
4462
|
+
chargebacks?: Chargeback[];
|
|
4463
|
+
/** Platform fee amount associated with this payment. */
|
|
4464
|
+
platformFee?: Price;
|
|
4779
4465
|
/**
|
|
4780
|
-
*
|
|
4781
|
-
*
|
|
4782
|
-
*
|
|
4466
|
+
* Payment method with buyer and optional owner translations.
|
|
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`
|
|
4783
4469
|
*/
|
|
4784
|
-
|
|
4470
|
+
paymentMethodName?: PaymentMethodName;
|
|
4785
4471
|
}
|
|
4786
|
-
|
|
4787
|
-
|
|
4788
|
-
|
|
4472
|
+
/** @oneof */
|
|
4473
|
+
interface RegularPaymentDetailsPaymentMethodDetailsOneOf {
|
|
4474
|
+
/** Credit card details. */
|
|
4475
|
+
creditCardDetails?: CreditCardPaymentMethodDetails;
|
|
4789
4476
|
}
|
|
4790
|
-
|
|
4477
|
+
declare enum TransactionStatus {
|
|
4478
|
+
UNDEFINED = "UNDEFINED",
|
|
4479
|
+
APPROVED = "APPROVED",
|
|
4480
|
+
PENDING = "PENDING",
|
|
4481
|
+
PENDING_MERCHANT = "PENDING_MERCHANT",
|
|
4482
|
+
CANCELED = "CANCELED",
|
|
4483
|
+
DECLINED = "DECLINED",
|
|
4484
|
+
REFUNDED = "REFUNDED",
|
|
4485
|
+
PARTIALLY_REFUNDED = "PARTIALLY_REFUNDED",
|
|
4486
|
+
AUTHORIZED = "AUTHORIZED",
|
|
4487
|
+
VOIDED = "VOIDED"
|
|
4488
|
+
}
|
|
4489
|
+
/** @enumType */
|
|
4490
|
+
type TransactionStatusWithLiterals = TransactionStatus | 'UNDEFINED' | 'APPROVED' | 'PENDING' | 'PENDING_MERCHANT' | 'CANCELED' | 'DECLINED' | 'REFUNDED' | 'PARTIALLY_REFUNDED' | 'AUTHORIZED' | 'VOIDED';
|
|
4491
|
+
interface CreditCardPaymentMethodDetails {
|
|
4791
4492
|
/**
|
|
4792
|
-
*
|
|
4793
|
-
* @
|
|
4794
|
-
* @maxSize 100
|
|
4795
|
-
* @minLength 1
|
|
4796
|
-
* @maxLength 100
|
|
4493
|
+
* The last 4 digits of the card number.
|
|
4494
|
+
* @maxLength 4
|
|
4797
4495
|
*/
|
|
4798
|
-
|
|
4799
|
-
}
|
|
4800
|
-
interface BulkMarkOrdersAsPaidResponse {
|
|
4496
|
+
lastFourDigits?: string | null;
|
|
4801
4497
|
/**
|
|
4802
|
-
*
|
|
4803
|
-
*
|
|
4498
|
+
* Card issuer's brand.
|
|
4499
|
+
* @maxLength 100
|
|
4804
4500
|
*/
|
|
4805
|
-
|
|
4806
|
-
/** Bulk action metadata. */
|
|
4807
|
-
bulkActionMetadata?: BulkActionMetadata;
|
|
4501
|
+
brand?: string | null;
|
|
4808
4502
|
}
|
|
4809
|
-
interface
|
|
4810
|
-
/** Item metadata. */
|
|
4811
|
-
itemMetadata?: ItemMetadata;
|
|
4503
|
+
interface AuthorizationDetails {
|
|
4812
4504
|
/**
|
|
4813
|
-
*
|
|
4814
|
-
*
|
|
4815
|
-
* Returned when `returnFullEntity = true`.
|
|
4505
|
+
* Whether the authorized payment is of a delayed capture.
|
|
4506
|
+
* @readonly
|
|
4816
4507
|
*/
|
|
4817
|
-
|
|
4818
|
-
|
|
4819
|
-
|
|
4820
|
-
/** Item ID. Should always be available, unless it's impossible (for example, when failing to create an item). */
|
|
4821
|
-
id?: string | null;
|
|
4822
|
-
/** Index of the item within the request array. Allows for correlation between request and response items. */
|
|
4823
|
-
originalIndex?: number;
|
|
4824
|
-
/** Whether the requested action was successful for this item. When `false`, the `error` field is populated. */
|
|
4825
|
-
success?: boolean;
|
|
4826
|
-
/** Details about the error in case of failure. */
|
|
4827
|
-
error?: ApplicationError;
|
|
4828
|
-
}
|
|
4829
|
-
interface ApplicationError {
|
|
4830
|
-
/** Error code. */
|
|
4831
|
-
code?: string;
|
|
4832
|
-
/** Description of the error. */
|
|
4833
|
-
description?: string;
|
|
4834
|
-
/** Data related to the error. */
|
|
4835
|
-
data?: Record<string, any> | null;
|
|
4836
|
-
}
|
|
4837
|
-
interface BulkActionMetadata {
|
|
4838
|
-
/** Number of items that were successfully processed. */
|
|
4839
|
-
totalSuccesses?: number;
|
|
4840
|
-
/** Number of items that couldn't be processed. */
|
|
4841
|
-
totalFailures?: number;
|
|
4842
|
-
/** Number of failures without details because detailed failure threshold was exceeded. */
|
|
4843
|
-
undetailedFailures?: number;
|
|
4844
|
-
}
|
|
4845
|
-
interface GetRefundabilityStatusRequest {
|
|
4508
|
+
delayedCapture?: boolean;
|
|
4509
|
+
/** Date and time the payment was authorized in [ISO-8601](https://en.wikipedia.org/wiki/ISO_8601#Combined_date_and_time_representations) format. */
|
|
4510
|
+
authorizedDate?: Date | null;
|
|
4846
4511
|
/**
|
|
4847
|
-
*
|
|
4848
|
-
*
|
|
4849
|
-
* @
|
|
4512
|
+
* List of captures associated with payment
|
|
4513
|
+
* In case of failed it can be replaced with new one with PENDING or SUCCESS statuses
|
|
4514
|
+
* @maxSize 1
|
|
4850
4515
|
*/
|
|
4851
|
-
|
|
4516
|
+
captures?: AuthorizationCapture[];
|
|
4517
|
+
/** Void associated with payment */
|
|
4518
|
+
void?: AuthorizationVoid;
|
|
4519
|
+
/** Scheduled action for this transaction */
|
|
4520
|
+
scheduledAction?: V1ScheduledAction;
|
|
4852
4521
|
}
|
|
4853
|
-
interface
|
|
4522
|
+
interface AuthorizationCapture {
|
|
4854
4523
|
/**
|
|
4855
|
-
*
|
|
4856
|
-
* @
|
|
4524
|
+
* Capture ID.
|
|
4525
|
+
* @format GUID
|
|
4526
|
+
* @readonly
|
|
4857
4527
|
*/
|
|
4858
|
-
|
|
4528
|
+
id?: string | null;
|
|
4529
|
+
/** Status of this capture action */
|
|
4530
|
+
status?: AuthorizationCaptureStatusWithLiterals;
|
|
4859
4531
|
/**
|
|
4860
|
-
*
|
|
4861
|
-
* @
|
|
4532
|
+
* Amount of this capture
|
|
4533
|
+
* @immutable
|
|
4862
4534
|
*/
|
|
4863
|
-
|
|
4535
|
+
amount?: Price;
|
|
4536
|
+
/** Date and time the capture was initiated in [ISO-8601](https://en.wikipedia.org/wiki/ISO_8601#Combined_date_and_time_representations) format. */
|
|
4537
|
+
createdDate?: Date | null;
|
|
4538
|
+
/** In case of status is FAILED may contain failure details */
|
|
4539
|
+
failureDetails?: AuthorizationActionFailureDetails;
|
|
4864
4540
|
}
|
|
4865
|
-
|
|
4866
|
-
/**
|
|
4867
|
-
|
|
4868
|
-
/**
|
|
4869
|
-
|
|
4870
|
-
/**
|
|
4871
|
-
|
|
4872
|
-
/** Payment refundability status. */
|
|
4873
|
-
refundabilityStatus?: RefundableStatusWithLiterals;
|
|
4874
|
-
/** Link to payment provider dashboard. */
|
|
4875
|
-
providerLink?: string | null;
|
|
4541
|
+
declare enum AuthorizationCaptureStatus {
|
|
4542
|
+
/** Capture operation still in progress. */
|
|
4543
|
+
PENDING = "PENDING",
|
|
4544
|
+
/** Capture operation succeeded. */
|
|
4545
|
+
SUCCEEDED = "SUCCEEDED",
|
|
4546
|
+
/** Capture operation failed. */
|
|
4547
|
+
FAILED = "FAILED"
|
|
4876
4548
|
}
|
|
4877
|
-
/** @
|
|
4878
|
-
|
|
4879
|
-
|
|
4880
|
-
|
|
4881
|
-
|
|
4882
|
-
manuallyRefundableReason?: ManuallyRefundableReasonWithLiterals;
|
|
4549
|
+
/** @enumType */
|
|
4550
|
+
type AuthorizationCaptureStatusWithLiterals = AuthorizationCaptureStatus | 'PENDING' | 'SUCCEEDED' | 'FAILED';
|
|
4551
|
+
interface AuthorizationActionFailureDetails {
|
|
4552
|
+
/** @maxLength 100 */
|
|
4553
|
+
failureCode?: string;
|
|
4883
4554
|
}
|
|
4884
|
-
|
|
4885
|
-
|
|
4555
|
+
interface AuthorizationVoid {
|
|
4556
|
+
/** Status of this void action */
|
|
4557
|
+
status?: AuthorizationVoidStatusWithLiterals;
|
|
4558
|
+
/** Date and time the void was initiated in [ISO-8601](https://en.wikipedia.org/wiki/ISO_8601#Combined_date_and_time_representations) format. */
|
|
4559
|
+
voidedDate?: Date | null;
|
|
4560
|
+
/** In case of status is FAILED may contain failure details */
|
|
4561
|
+
failureDetails?: AuthorizationActionFailureDetails;
|
|
4562
|
+
/** Reason of void action */
|
|
4563
|
+
reason?: ReasonWithLiterals;
|
|
4564
|
+
}
|
|
4565
|
+
declare enum AuthorizationVoidStatus {
|
|
4566
|
+
/** Void operation still in progress. */
|
|
4567
|
+
PENDING = "PENDING",
|
|
4568
|
+
/** Void operation succeeded. */
|
|
4569
|
+
SUCCEEDED = "SUCCEEDED",
|
|
4570
|
+
/** Void operation failed. */
|
|
4571
|
+
FAILED = "FAILED"
|
|
4572
|
+
}
|
|
4573
|
+
/** @enumType */
|
|
4574
|
+
type AuthorizationVoidStatusWithLiterals = AuthorizationVoidStatus | 'PENDING' | 'SUCCEEDED' | 'FAILED';
|
|
4575
|
+
/** Reason the authorization was voided. */
|
|
4576
|
+
declare enum Reason {
|
|
4577
|
+
/** Authorization was voided by user. */
|
|
4886
4578
|
MANUAL = "MANUAL",
|
|
4887
|
-
|
|
4579
|
+
/** Authorization passed execution date. */
|
|
4580
|
+
SCHEDULED = "SCHEDULED"
|
|
4888
4581
|
}
|
|
4889
4582
|
/** @enumType */
|
|
4890
|
-
type
|
|
4891
|
-
|
|
4892
|
-
|
|
4893
|
-
|
|
4894
|
-
|
|
4895
|
-
|
|
4896
|
-
|
|
4897
|
-
|
|
4898
|
-
|
|
4899
|
-
|
|
4900
|
-
PENDING_REFUND = "PENDING_REFUND",
|
|
4901
|
-
FORBIDDEN = "FORBIDDEN",
|
|
4902
|
-
TRANSACTION_NOT_FOUND = "TRANSACTION_NOT_FOUND",
|
|
4903
|
-
ORDER_IS_PENDING = "ORDER_IS_PENDING",
|
|
4904
|
-
ORDER_IS_REJECTED = "ORDER_IS_REJECTED"
|
|
4583
|
+
type ReasonWithLiterals = Reason | 'MANUAL' | 'SCHEDULED';
|
|
4584
|
+
interface V1ScheduledAction {
|
|
4585
|
+
/** Type of the action. */
|
|
4586
|
+
actionType?: ActionTypeWithLiterals;
|
|
4587
|
+
/** The date and time of the action. */
|
|
4588
|
+
executionDate?: Date | null;
|
|
4589
|
+
}
|
|
4590
|
+
declare enum ActionType {
|
|
4591
|
+
VOID = "VOID",
|
|
4592
|
+
CAPTURE = "CAPTURE"
|
|
4905
4593
|
}
|
|
4906
4594
|
/** @enumType */
|
|
4907
|
-
type
|
|
4908
|
-
|
|
4909
|
-
|
|
4910
|
-
|
|
4911
|
-
|
|
4912
|
-
|
|
4595
|
+
type ActionTypeWithLiterals = ActionType | 'VOID' | 'CAPTURE';
|
|
4596
|
+
interface Chargeback {
|
|
4597
|
+
/**
|
|
4598
|
+
* Chargeback ID.
|
|
4599
|
+
* @format GUID
|
|
4600
|
+
* @readonly
|
|
4601
|
+
* @immutable
|
|
4602
|
+
*/
|
|
4603
|
+
id?: string;
|
|
4604
|
+
/**
|
|
4605
|
+
* 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.
|
|
4606
|
+
* @readonly
|
|
4607
|
+
* @immutable
|
|
4608
|
+
*/
|
|
4609
|
+
createdDate?: Date | null;
|
|
4610
|
+
/**
|
|
4611
|
+
* 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.
|
|
4612
|
+
* @readonly
|
|
4613
|
+
*/
|
|
4614
|
+
updatedDate?: Date | null;
|
|
4615
|
+
/**
|
|
4616
|
+
* Amount.
|
|
4617
|
+
* @readonly
|
|
4618
|
+
* @immutable
|
|
4619
|
+
*/
|
|
4620
|
+
amount?: Price;
|
|
4621
|
+
/**
|
|
4622
|
+
* Reversal amount. Present only when status is REVERSED.
|
|
4623
|
+
* @readonly
|
|
4624
|
+
*/
|
|
4625
|
+
reversalAmount?: Price;
|
|
4626
|
+
/**
|
|
4627
|
+
* Status.
|
|
4628
|
+
*
|
|
4629
|
+
* Default: `"APPROVED"`.
|
|
4630
|
+
*/
|
|
4631
|
+
status?: ChargebackStatusWithLiterals;
|
|
4632
|
+
/**
|
|
4633
|
+
* External chargeback ID.
|
|
4634
|
+
* @format GUID
|
|
4635
|
+
* @readonly
|
|
4636
|
+
* @immutable
|
|
4637
|
+
*/
|
|
4638
|
+
externalId?: string | null;
|
|
4639
|
+
}
|
|
4640
|
+
declare enum ChargebackStatus {
|
|
4641
|
+
/** Chargeback was approved. */
|
|
4642
|
+
APPROVED = "APPROVED",
|
|
4643
|
+
/** Chargeback was reversed. */
|
|
4644
|
+
REVERSED = "REVERSED"
|
|
4913
4645
|
}
|
|
4914
4646
|
/** @enumType */
|
|
4915
|
-
type
|
|
4916
|
-
interface
|
|
4647
|
+
type ChargebackStatusWithLiterals = ChargebackStatus | 'APPROVED' | 'REVERSED';
|
|
4648
|
+
interface PaymentMethodName {
|
|
4917
4649
|
/**
|
|
4918
|
-
*
|
|
4919
|
-
* @minLength 1
|
|
4650
|
+
* Translated payment method name in buyer language.
|
|
4920
4651
|
* @maxLength 100
|
|
4921
4652
|
*/
|
|
4922
|
-
|
|
4923
|
-
/** Information about the user who initiated the payment. */
|
|
4924
|
-
chargedBy?: ChargedBy;
|
|
4925
|
-
}
|
|
4926
|
-
interface ChargedBy {
|
|
4653
|
+
buyerLanguageName?: string | null;
|
|
4927
4654
|
/**
|
|
4928
|
-
*
|
|
4929
|
-
* @
|
|
4655
|
+
* Translated payment method name in site owner language.
|
|
4656
|
+
* @maxLength 100
|
|
4930
4657
|
*/
|
|
4931
|
-
|
|
4658
|
+
siteLanguageName?: string | null;
|
|
4932
4659
|
/**
|
|
4933
|
-
*
|
|
4934
|
-
*
|
|
4935
|
-
*
|
|
4660
|
+
* User-provided payment method name.
|
|
4661
|
+
*
|
|
4662
|
+
* When set, takes precedence over `buyerLanguageName` and `siteLanguageName`.
|
|
4936
4663
|
*/
|
|
4937
|
-
|
|
4938
|
-
}
|
|
4939
|
-
interface CreatePaymentGatewayOrderResponse {
|
|
4940
|
-
/** ID of the order created in the payment gateway */
|
|
4941
|
-
paymentGatewayOrderId?: string;
|
|
4664
|
+
userDefinedName?: UserDefinedPaymentMethodName;
|
|
4942
4665
|
}
|
|
4943
|
-
interface
|
|
4666
|
+
interface GiftCardPaymentDetails {
|
|
4944
4667
|
/**
|
|
4945
|
-
*
|
|
4946
|
-
* @minLength 1
|
|
4668
|
+
* Gift card payment ID.
|
|
4947
4669
|
* @maxLength 100
|
|
4948
4670
|
*/
|
|
4949
|
-
|
|
4671
|
+
giftCardPaymentId?: string;
|
|
4950
4672
|
/**
|
|
4951
|
-
*
|
|
4952
|
-
* but a user which is using the membership on behalf of the a member
|
|
4673
|
+
* ID of the app that created the gift card.
|
|
4953
4674
|
* @format GUID
|
|
4954
4675
|
*/
|
|
4955
|
-
|
|
4676
|
+
appId?: string;
|
|
4956
4677
|
/**
|
|
4957
|
-
*
|
|
4958
|
-
* @
|
|
4959
|
-
* @maxSize 300
|
|
4678
|
+
* Whether the gift card is voided.
|
|
4679
|
+
* @readonly
|
|
4960
4680
|
*/
|
|
4961
|
-
|
|
4681
|
+
voided?: boolean;
|
|
4962
4682
|
}
|
|
4963
|
-
interface
|
|
4683
|
+
interface MembershipPaymentDetails {
|
|
4964
4684
|
/**
|
|
4965
|
-
*
|
|
4685
|
+
* Membership ID.
|
|
4966
4686
|
* @minLength 1
|
|
4967
4687
|
* @maxLength 100
|
|
4968
4688
|
*/
|
|
4969
4689
|
membershipId?: string;
|
|
4970
4690
|
/**
|
|
4971
|
-
* ID of the
|
|
4972
|
-
* @format GUID
|
|
4973
|
-
*/
|
|
4974
|
-
appId?: string;
|
|
4975
|
-
/** The name of used membership */
|
|
4976
|
-
membershipName?: MembershipName;
|
|
4977
|
-
/** Additional data about this membership */
|
|
4978
|
-
membershipAdditionalData?: Record<string, any> | null;
|
|
4979
|
-
/** Catalog and item reference info. */
|
|
4980
|
-
catalogReference?: CatalogReference;
|
|
4981
|
-
/** Properties of the service. When relevant, contains information such as date and number of participants. */
|
|
4982
|
-
serviceProperties?: ServiceProperties;
|
|
4983
|
-
/**
|
|
4984
|
-
* Usually would be the same as catalogReference.catalogItemId
|
|
4985
|
-
* For cases when these are not the same, this field would return the actual id of the item in the catalog
|
|
4986
|
-
* For example, for Wix bookings, catalogReference.catalogItemId is the booking id, and this value is being set to be the service id
|
|
4691
|
+
* ID of the line item this membership applies to.
|
|
4987
4692
|
* @minLength 1
|
|
4988
|
-
* @maxLength
|
|
4693
|
+
* @maxLength 100
|
|
4989
4694
|
*/
|
|
4990
|
-
|
|
4695
|
+
lineItemId?: string;
|
|
4696
|
+
/** Payment status. */
|
|
4697
|
+
status?: MembershipPaymentStatusWithLiterals;
|
|
4698
|
+
/** Membership name. */
|
|
4699
|
+
name?: MembershipName;
|
|
4991
4700
|
/**
|
|
4992
|
-
*
|
|
4701
|
+
* The transaction ID in the membership system. Can be used to void the transaction.
|
|
4993
4702
|
* @minLength 1
|
|
4994
4703
|
* @maxLength 100
|
|
4995
4704
|
*/
|
|
4996
|
-
|
|
4705
|
+
externalTransactionId?: string | null;
|
|
4706
|
+
/**
|
|
4707
|
+
* Whether the membership is voided.
|
|
4708
|
+
* @readonly
|
|
4709
|
+
*/
|
|
4710
|
+
voided?: boolean;
|
|
4711
|
+
/**
|
|
4712
|
+
* ID of the application providing this payment option.
|
|
4713
|
+
* @format GUID
|
|
4714
|
+
*/
|
|
4715
|
+
providerAppId?: string;
|
|
4997
4716
|
}
|
|
4998
|
-
|
|
4717
|
+
declare enum MembershipPaymentStatus {
|
|
4718
|
+
/** Payment was charged. */
|
|
4719
|
+
CHARGED = "CHARGED",
|
|
4720
|
+
/** The attempt to charge the payment failed, for example, due to lack of credits. */
|
|
4721
|
+
CHARGE_FAILED = "CHARGE_FAILED",
|
|
4722
|
+
/** Payment is pending. */
|
|
4723
|
+
CHARGE_PENDING = "CHARGE_PENDING",
|
|
4724
|
+
/** Payment was voided. */
|
|
4725
|
+
VOIDED = "VOIDED"
|
|
4726
|
+
}
|
|
4727
|
+
/** @enumType */
|
|
4728
|
+
type MembershipPaymentStatusWithLiterals = MembershipPaymentStatus | 'CHARGED' | 'CHARGE_FAILED' | 'CHARGE_PENDING' | 'VOIDED';
|
|
4729
|
+
interface WixReceiptInfo {
|
|
4999
4730
|
/**
|
|
5000
|
-
*
|
|
5001
|
-
* @
|
|
4731
|
+
* Receipt ID
|
|
4732
|
+
* @format GUID
|
|
5002
4733
|
*/
|
|
5003
|
-
|
|
4734
|
+
receiptId?: string;
|
|
5004
4735
|
/**
|
|
5005
|
-
*
|
|
5006
|
-
* @
|
|
4736
|
+
* Display number of receipt
|
|
4737
|
+
* @minLength 1
|
|
4738
|
+
* @maxLength 40
|
|
5007
4739
|
*/
|
|
5008
|
-
|
|
4740
|
+
displayNumber?: string | null;
|
|
5009
4741
|
}
|
|
5010
|
-
interface
|
|
4742
|
+
interface ExternalReceiptInfo {
|
|
5011
4743
|
/**
|
|
5012
|
-
*
|
|
5013
|
-
*
|
|
4744
|
+
* External receipt ID
|
|
4745
|
+
* @maxLength 100
|
|
5014
4746
|
*/
|
|
5015
|
-
|
|
4747
|
+
receiptId?: string | null;
|
|
5016
4748
|
/**
|
|
5017
|
-
*
|
|
5018
|
-
* @
|
|
5019
|
-
* @max 10000
|
|
4749
|
+
* ID of the app providing the receipt
|
|
4750
|
+
* @format GUID
|
|
5020
4751
|
*/
|
|
5021
|
-
|
|
4752
|
+
appId?: string | null;
|
|
4753
|
+
/**
|
|
4754
|
+
* Display number of receipt
|
|
4755
|
+
* @minLength 1
|
|
4756
|
+
* @maxLength 40
|
|
4757
|
+
*/
|
|
4758
|
+
displayNumber?: string | null;
|
|
5022
4759
|
}
|
|
5023
|
-
interface
|
|
4760
|
+
interface CashRoundingDetails {
|
|
5024
4761
|
}
|
|
5025
|
-
|
|
4762
|
+
declare enum PaymentStatus {
|
|
4763
|
+
APPROVED = "APPROVED",
|
|
4764
|
+
PENDING = "PENDING",
|
|
4765
|
+
PENDING_MERCHANT = "PENDING_MERCHANT",
|
|
4766
|
+
CANCELED = "CANCELED",
|
|
4767
|
+
DECLINED = "DECLINED",
|
|
4768
|
+
REFUNDED = "REFUNDED",
|
|
4769
|
+
PARTIALLY_REFUNDED = "PARTIALLY_REFUNDED",
|
|
4770
|
+
AUTHORIZED = "AUTHORIZED",
|
|
4771
|
+
VOIDED = "VOIDED"
|
|
4772
|
+
}
|
|
4773
|
+
/** @enumType */
|
|
4774
|
+
type PaymentStatusWithLiterals = PaymentStatus | 'APPROVED' | 'PENDING' | 'PENDING_MERCHANT' | 'CANCELED' | 'DECLINED' | 'REFUNDED' | 'PARTIALLY_REFUNDED' | 'AUTHORIZED' | 'VOIDED';
|
|
4775
|
+
interface Refund {
|
|
5026
4776
|
/**
|
|
5027
|
-
*
|
|
5028
|
-
* @
|
|
5029
|
-
* @
|
|
4777
|
+
* Refund ID.
|
|
4778
|
+
* @format GUID
|
|
4779
|
+
* @readonly
|
|
5030
4780
|
*/
|
|
5031
|
-
|
|
4781
|
+
id?: string;
|
|
5032
4782
|
/**
|
|
5033
|
-
*
|
|
5034
|
-
* @
|
|
5035
|
-
* @maxSize 1
|
|
4783
|
+
* List of transactions.
|
|
4784
|
+
* @maxSize 50
|
|
5036
4785
|
*/
|
|
5037
|
-
|
|
5038
|
-
/**
|
|
4786
|
+
transactions?: RefundTransaction[];
|
|
4787
|
+
/** Refund business details. */
|
|
5039
4788
|
details?: RefundDetails;
|
|
5040
|
-
/**
|
|
5041
|
-
|
|
4789
|
+
/**
|
|
4790
|
+
* 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.
|
|
4791
|
+
* @readonly
|
|
4792
|
+
* @immutable
|
|
4793
|
+
*/
|
|
4794
|
+
createdDate?: Date | null;
|
|
4795
|
+
/**
|
|
4796
|
+
* Aggregated refund summary.
|
|
4797
|
+
* @readonly
|
|
4798
|
+
*/
|
|
4799
|
+
summary?: AggregatedRefundSummary;
|
|
4800
|
+
/**
|
|
4801
|
+
* ID of the app that initiated this refund.
|
|
4802
|
+
* @format GUID
|
|
4803
|
+
* @readonly
|
|
4804
|
+
* @immutable
|
|
4805
|
+
*/
|
|
4806
|
+
requestingServiceAppId?: string | null;
|
|
5042
4807
|
}
|
|
5043
|
-
interface
|
|
4808
|
+
interface RefundTransaction {
|
|
5044
4809
|
/**
|
|
5045
|
-
*
|
|
4810
|
+
* ID of the payment associated with this refund.
|
|
5046
4811
|
* @format GUID
|
|
4812
|
+
* @immutable
|
|
5047
4813
|
*/
|
|
5048
4814
|
paymentId?: string;
|
|
5049
|
-
/**
|
|
4815
|
+
/**
|
|
4816
|
+
* Refund amount.
|
|
4817
|
+
* @immutable
|
|
4818
|
+
*/
|
|
5050
4819
|
amount?: Price;
|
|
4820
|
+
/** Refund status. */
|
|
4821
|
+
refundStatus?: RefundStatusWithLiterals;
|
|
4822
|
+
/** Optional details of current refund status. */
|
|
4823
|
+
refundStatusInfo?: RefundStatusInfo;
|
|
5051
4824
|
/**
|
|
5052
|
-
*
|
|
5053
|
-
*
|
|
5054
|
-
*
|
|
4825
|
+
* Payment gateway's refund ID.
|
|
4826
|
+
* This field is only returned when the value of `external_refund` is `false`.
|
|
4827
|
+
* @format GUID
|
|
4828
|
+
*/
|
|
4829
|
+
gatewayRefundId?: string | null;
|
|
4830
|
+
/** ID of the refund in the payment provider's system. For example, at PayPal, Square, Stripe, etc. Not returned for external refunds. */
|
|
4831
|
+
providerRefundId?: string | null;
|
|
4832
|
+
/**
|
|
4833
|
+
* Whether refund was made externally and manually on the payment provider's side.
|
|
4834
|
+
* @immutable
|
|
5055
4835
|
*/
|
|
5056
4836
|
externalRefund?: boolean;
|
|
5057
4837
|
}
|
|
5058
|
-
|
|
5059
|
-
|
|
5060
|
-
|
|
5061
|
-
|
|
5062
|
-
|
|
4838
|
+
/** Refund transaction status. */
|
|
4839
|
+
declare enum RefundStatus {
|
|
4840
|
+
/** Refund was initiated on payment provider side. PENDING status was assigned by provider. */
|
|
4841
|
+
PENDING = "PENDING",
|
|
4842
|
+
/** Refund transaction succeeded. */
|
|
4843
|
+
SUCCEEDED = "SUCCEEDED",
|
|
4844
|
+
/** Refund transaction failed. */
|
|
4845
|
+
FAILED = "FAILED",
|
|
4846
|
+
/** Refund request acknowledged, and will be executed soon. */
|
|
4847
|
+
SCHEDULED = "SCHEDULED",
|
|
4848
|
+
/** Refund was initiated on payment provider side. */
|
|
4849
|
+
STARTED = "STARTED"
|
|
4850
|
+
}
|
|
4851
|
+
/** @enumType */
|
|
4852
|
+
type RefundStatusWithLiterals = RefundStatus | 'PENDING' | 'SUCCEEDED' | 'FAILED' | 'SCHEDULED' | 'STARTED';
|
|
4853
|
+
interface RefundStatusInfo {
|
|
4854
|
+
/**
|
|
4855
|
+
* Reason code for the refund's current status.
|
|
4856
|
+
*
|
|
4857
|
+
* Learn more about [reason codes](https://dev.wix.com/docs/rest/business-management/payments/service-plugins/payment-service-provider-service-plugin/reason-codes).
|
|
4858
|
+
* @minLength 1
|
|
4859
|
+
* @maxLength 10
|
|
4860
|
+
*/
|
|
4861
|
+
paymentGatewayReasonCode?: string | null;
|
|
5063
4862
|
/**
|
|
5064
|
-
*
|
|
4863
|
+
* Free text explanation of current refund status.
|
|
5065
4864
|
* @minLength 1
|
|
5066
4865
|
* @maxLength 1000
|
|
5067
4866
|
*/
|
|
5068
|
-
|
|
4867
|
+
description?: string | null;
|
|
5069
4868
|
}
|
|
5070
|
-
interface
|
|
5071
|
-
/**
|
|
5072
|
-
|
|
4869
|
+
interface AggregatedRefundSummary {
|
|
4870
|
+
/** Total amount requested for refund. */
|
|
4871
|
+
requestedRefund?: Price;
|
|
4872
|
+
/** Pending refund amount - the portion of `requestedRefund` that is still pending. */
|
|
4873
|
+
pendingRefund?: Price;
|
|
4874
|
+
/** Refunded amount - the portion of `requestedRefund` that refunded successfully. */
|
|
4875
|
+
refunded?: Price;
|
|
4876
|
+
/** Failed refund amount - the portion of `requestedRefund` that failed. */
|
|
4877
|
+
failedRefundAmount?: Price;
|
|
4878
|
+
/** Whether at least one refund transaction is still in `"PENDING"` status. */
|
|
4879
|
+
pending?: boolean;
|
|
4880
|
+
/** Breakdown of refunded items. Available only after refund is complete. */
|
|
4881
|
+
breakdown?: RefundItemsBreakdown;
|
|
4882
|
+
}
|
|
4883
|
+
interface RefundItemsBreakdown {
|
|
5073
4884
|
/**
|
|
5074
|
-
*
|
|
4885
|
+
* Refunded line items and the amount refunded for each.
|
|
5075
4886
|
* @maxSize 300
|
|
5076
4887
|
*/
|
|
5077
|
-
|
|
5078
|
-
}
|
|
5079
|
-
declare enum RestockType {
|
|
5080
|
-
NO_ITEMS = "NO_ITEMS",
|
|
5081
|
-
ALL_ITEMS = "ALL_ITEMS",
|
|
5082
|
-
SOME_ITEMS = "SOME_ITEMS"
|
|
4888
|
+
lineItems?: LineItemRefundSummary[];
|
|
5083
4889
|
}
|
|
5084
|
-
|
|
5085
|
-
type RestockTypeWithLiterals = RestockType | 'NO_ITEMS' | 'ALL_ITEMS' | 'SOME_ITEMS';
|
|
5086
|
-
interface RestockItem {
|
|
4890
|
+
interface LineItemRefundSummary {
|
|
5087
4891
|
/**
|
|
5088
|
-
* ID of the line item
|
|
4892
|
+
* ID of the refunded line item.
|
|
5089
4893
|
* @format GUID
|
|
5090
4894
|
*/
|
|
5091
4895
|
lineItemId?: string;
|
|
5092
|
-
/**
|
|
5093
|
-
|
|
5094
|
-
* @min 1
|
|
5095
|
-
* @max 100000
|
|
5096
|
-
*/
|
|
5097
|
-
quantity?: number;
|
|
5098
|
-
}
|
|
5099
|
-
interface TriggerRefundResponse {
|
|
5100
|
-
/** All order's transactions after the refunds were added */
|
|
5101
|
-
orderTransactions?: OrderTransactions;
|
|
5102
|
-
/** Created refund ID */
|
|
5103
|
-
refundId?: string | null;
|
|
5104
|
-
/** Payment ID's that the refund execution had failed for */
|
|
5105
|
-
failedPaymentIds?: ItemMetadata[];
|
|
4896
|
+
/** Total refunded amount for the line item. */
|
|
4897
|
+
totalRefundedAmount?: Price;
|
|
5106
4898
|
}
|
|
5107
|
-
|
|
5108
|
-
* A record of all payments and refunds associated with an order.
|
|
5109
|
-
*
|
|
5110
|
-
* Use order transactions to track payment status, add payment records, process refunds, and monitor chargebacks.
|
|
5111
|
-
*/
|
|
5112
|
-
interface OrderTransactions {
|
|
5113
|
-
/**
|
|
5114
|
-
* Order ID.
|
|
5115
|
-
* @format GUID
|
|
5116
|
-
*/
|
|
5117
|
-
orderId?: string;
|
|
4899
|
+
interface CalculateRefundRequest {
|
|
5118
4900
|
/**
|
|
5119
|
-
*
|
|
5120
|
-
* @
|
|
4901
|
+
* Order ID
|
|
4902
|
+
* @minLength 1
|
|
4903
|
+
* @maxLength 100
|
|
5121
4904
|
*/
|
|
5122
|
-
|
|
4905
|
+
ecomOrderId?: string;
|
|
5123
4906
|
/**
|
|
5124
|
-
*
|
|
4907
|
+
* Refunded line items and quantity
|
|
5125
4908
|
* @maxSize 300
|
|
5126
4909
|
*/
|
|
5127
|
-
|
|
4910
|
+
refundItems?: CalculateRefundItemRequest[];
|
|
4911
|
+
/** Should include shipping in refund calculation */
|
|
4912
|
+
refundShipping?: boolean;
|
|
5128
4913
|
}
|
|
5129
|
-
interface
|
|
5130
|
-
/** Regular payment details. */
|
|
5131
|
-
regularPaymentDetails?: RegularPaymentDetails;
|
|
5132
|
-
/** Gift card payment details. */
|
|
5133
|
-
giftcardPaymentDetails?: GiftCardPaymentDetails;
|
|
4914
|
+
interface CalculateRefundItemRequest {
|
|
5134
4915
|
/**
|
|
5135
|
-
*
|
|
4916
|
+
* ID of the line item being refunded
|
|
5136
4917
|
* @format GUID
|
|
5137
|
-
* @readonly
|
|
5138
|
-
*/
|
|
5139
|
-
id?: string | null;
|
|
5140
|
-
/** 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. */
|
|
5141
|
-
createdDate?: Date | null;
|
|
5142
|
-
/**
|
|
5143
|
-
* Date and time the payment was last updated in [ISO-8601](https://en.wikipedia.org/wiki/ISO_8601#Combined_date_and_time_representations) format.
|
|
5144
|
-
* @readonly
|
|
5145
4918
|
*/
|
|
5146
|
-
|
|
5147
|
-
/** Payment amount. */
|
|
5148
|
-
amount?: Price;
|
|
4919
|
+
id?: string;
|
|
5149
4920
|
/**
|
|
5150
|
-
*
|
|
5151
|
-
*
|
|
5152
|
-
*
|
|
4921
|
+
* How much of that line item is being refunded
|
|
4922
|
+
* @min 1
|
|
4923
|
+
* @max 100000
|
|
5153
4924
|
*/
|
|
5154
|
-
|
|
5155
|
-
}
|
|
5156
|
-
/** @oneof */
|
|
5157
|
-
interface PaymentPaymentDetailsOneOf {
|
|
5158
|
-
/** Regular payment details. */
|
|
5159
|
-
regularPaymentDetails?: RegularPaymentDetails;
|
|
5160
|
-
/** Gift card payment details. */
|
|
5161
|
-
giftcardPaymentDetails?: GiftCardPaymentDetails;
|
|
5162
|
-
}
|
|
5163
|
-
/** @oneof */
|
|
5164
|
-
interface PaymentReceiptInfoOneOf {
|
|
4925
|
+
quantity?: number;
|
|
5165
4926
|
}
|
|
5166
|
-
interface
|
|
5167
|
-
/**
|
|
5168
|
-
|
|
5169
|
-
/**
|
|
5170
|
-
|
|
5171
|
-
|
|
5172
|
-
|
|
5173
|
-
|
|
4927
|
+
interface CalculateRefundResponse {
|
|
4928
|
+
/** Total refundable amount */
|
|
4929
|
+
total?: Price;
|
|
4930
|
+
/** Tax cost of the order */
|
|
4931
|
+
tax?: Price;
|
|
4932
|
+
/** Discount given for this order */
|
|
4933
|
+
discount?: Price;
|
|
4934
|
+
/** Total cost of the order (without tax) */
|
|
4935
|
+
subtotal?: Price;
|
|
4936
|
+
/** Total shipping cost for order */
|
|
4937
|
+
shipping?: Price;
|
|
4938
|
+
/** Previous refund given on that order */
|
|
4939
|
+
previouslyRefundedAmount?: Price;
|
|
5174
4940
|
/**
|
|
5175
|
-
*
|
|
5176
|
-
*
|
|
5177
|
-
* @maxLength 100
|
|
4941
|
+
* The refundable items of that order
|
|
4942
|
+
* @maxSize 300
|
|
5178
4943
|
*/
|
|
5179
|
-
|
|
4944
|
+
items?: CalculateRefundItemResponse[];
|
|
4945
|
+
}
|
|
4946
|
+
interface CalculateRefundItemResponse {
|
|
5180
4947
|
/**
|
|
5181
|
-
*
|
|
5182
|
-
*
|
|
5183
|
-
* Non-exhaustive list of supported values:
|
|
5184
|
-
* + `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`
|
|
5185
|
-
* @maxLength 100
|
|
5186
|
-
* @deprecated Payment method.
|
|
5187
|
-
* Deprecated. Use `paymentMethodName.buyerLanguageName` instead.
|
|
5188
|
-
* Non-exhaustive list of supported values:
|
|
5189
|
-
* + `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`
|
|
5190
|
-
* @replacedBy payment_method_name
|
|
5191
|
-
* @targetRemovalDate 2026-07-01
|
|
4948
|
+
* Line item ID
|
|
4949
|
+
* @format GUID
|
|
5192
4950
|
*/
|
|
5193
|
-
|
|
4951
|
+
id?: string;
|
|
4952
|
+
/** Refundable amount for requested quantity of items (price of requested quantity of items without tax and discount) */
|
|
4953
|
+
price?: Price;
|
|
4954
|
+
}
|
|
4955
|
+
interface VoidAuthorizedPaymentsRequest {
|
|
5194
4956
|
/**
|
|
5195
|
-
*
|
|
4957
|
+
* Wix eCommerce order ID
|
|
4958
|
+
* @minLength 1
|
|
5196
4959
|
* @maxLength 100
|
|
5197
4960
|
*/
|
|
5198
|
-
|
|
5199
|
-
/** Whether the payment was made offline. For example, when using cash or when marked as paid in the Business Manager. */
|
|
5200
|
-
offlinePayment?: boolean;
|
|
5201
|
-
/** Payment status. */
|
|
5202
|
-
status?: TransactionStatusWithLiterals;
|
|
5203
|
-
/**
|
|
5204
|
-
* Whether there is a payment agreement that allows for future charges.
|
|
5205
|
-
* @immutable
|
|
5206
|
-
*/
|
|
5207
|
-
savedPaymentMethod?: boolean;
|
|
5208
|
-
/** Authorization details. */
|
|
5209
|
-
authorizationDetails?: AuthorizationDetails;
|
|
5210
|
-
/**
|
|
5211
|
-
* Record of chargebacks made by the buyer.
|
|
5212
|
-
* @maxSize 6
|
|
5213
|
-
*/
|
|
5214
|
-
chargebacks?: Chargeback[];
|
|
5215
|
-
/** Platform fee amount associated with this payment. */
|
|
5216
|
-
platformFee?: Price;
|
|
4961
|
+
ecomOrderId: string;
|
|
5217
4962
|
/**
|
|
5218
|
-
* Payment
|
|
5219
|
-
*
|
|
5220
|
-
*
|
|
4963
|
+
* Payment IDs
|
|
4964
|
+
* @minSize 1
|
|
4965
|
+
* @maxSize 100
|
|
4966
|
+
* @format GUID
|
|
5221
4967
|
*/
|
|
5222
|
-
|
|
5223
|
-
}
|
|
5224
|
-
/** @oneof */
|
|
5225
|
-
interface RegularPaymentDetailsPaymentMethodDetailsOneOf {
|
|
5226
|
-
/** Credit card details. */
|
|
5227
|
-
creditCardDetails?: CreditCardPaymentMethodDetails;
|
|
4968
|
+
paymentIds: string[];
|
|
5228
4969
|
}
|
|
5229
|
-
|
|
5230
|
-
|
|
5231
|
-
|
|
5232
|
-
PENDING = "PENDING",
|
|
5233
|
-
PENDING_MERCHANT = "PENDING_MERCHANT",
|
|
5234
|
-
CANCELED = "CANCELED",
|
|
5235
|
-
DECLINED = "DECLINED",
|
|
5236
|
-
REFUNDED = "REFUNDED",
|
|
5237
|
-
PARTIALLY_REFUNDED = "PARTIALLY_REFUNDED",
|
|
5238
|
-
AUTHORIZED = "AUTHORIZED",
|
|
5239
|
-
VOIDED = "VOIDED"
|
|
4970
|
+
interface VoidAuthorizedPaymentsResponse {
|
|
4971
|
+
/** All order's transactions after the void was triggered */
|
|
4972
|
+
orderTransactions?: OrderTransactions;
|
|
5240
4973
|
}
|
|
5241
|
-
|
|
5242
|
-
type TransactionStatusWithLiterals = TransactionStatus | 'UNDEFINED' | 'APPROVED' | 'PENDING' | 'PENDING_MERCHANT' | 'CANCELED' | 'DECLINED' | 'REFUNDED' | 'PARTIALLY_REFUNDED' | 'AUTHORIZED' | 'VOIDED';
|
|
5243
|
-
interface CreditCardPaymentMethodDetails {
|
|
5244
|
-
/**
|
|
5245
|
-
* The last 4 digits of the card number.
|
|
5246
|
-
* @maxLength 4
|
|
5247
|
-
*/
|
|
5248
|
-
lastFourDigits?: string | null;
|
|
4974
|
+
interface CaptureAuthorizedPaymentsRequest {
|
|
5249
4975
|
/**
|
|
5250
|
-
*
|
|
4976
|
+
* Wix eCommerce order ID
|
|
4977
|
+
* @minLength 1
|
|
5251
4978
|
* @maxLength 100
|
|
5252
4979
|
*/
|
|
5253
|
-
|
|
5254
|
-
}
|
|
5255
|
-
interface AuthorizationDetails {
|
|
5256
|
-
/**
|
|
5257
|
-
* Whether the authorized payment is of a delayed capture.
|
|
5258
|
-
* @readonly
|
|
5259
|
-
*/
|
|
5260
|
-
delayedCapture?: boolean;
|
|
5261
|
-
/** Date and time the payment was authorized in [ISO-8601](https://en.wikipedia.org/wiki/ISO_8601#Combined_date_and_time_representations) format. */
|
|
5262
|
-
authorizedDate?: Date | null;
|
|
4980
|
+
ecomOrderId: string;
|
|
5263
4981
|
/**
|
|
5264
|
-
*
|
|
5265
|
-
*
|
|
5266
|
-
* @maxSize
|
|
4982
|
+
* Capture payments information
|
|
4983
|
+
* @minSize 1
|
|
4984
|
+
* @maxSize 100
|
|
5267
4985
|
*/
|
|
5268
|
-
|
|
5269
|
-
/** Void associated with payment */
|
|
5270
|
-
void?: AuthorizationVoid;
|
|
5271
|
-
/** Scheduled action for this transaction */
|
|
5272
|
-
scheduledAction?: V1ScheduledAction;
|
|
4986
|
+
payments: PaymentCapture[];
|
|
5273
4987
|
}
|
|
5274
|
-
interface
|
|
4988
|
+
interface PaymentCapture {
|
|
5275
4989
|
/**
|
|
5276
|
-
*
|
|
4990
|
+
* Payment ID
|
|
5277
4991
|
* @format GUID
|
|
5278
|
-
* @readonly
|
|
5279
4992
|
*/
|
|
5280
|
-
|
|
5281
|
-
/** Status of this capture action */
|
|
5282
|
-
status?: AuthorizationCaptureStatusWithLiterals;
|
|
4993
|
+
paymentId?: string | null;
|
|
5283
4994
|
/**
|
|
5284
|
-
*
|
|
5285
|
-
*
|
|
4995
|
+
* Capture amount.
|
|
4996
|
+
* If not provided - full authorized amount will be captured.
|
|
5286
4997
|
*/
|
|
5287
4998
|
amount?: Price;
|
|
5288
|
-
/** Date and time the capture was initiated in [ISO-8601](https://en.wikipedia.org/wiki/ISO_8601#Combined_date_and_time_representations) format. */
|
|
5289
|
-
createdDate?: Date | null;
|
|
5290
|
-
/** In case of status is FAILED may contain failure details */
|
|
5291
|
-
failureDetails?: AuthorizationActionFailureDetails;
|
|
5292
4999
|
}
|
|
5293
|
-
|
|
5294
|
-
/**
|
|
5295
|
-
|
|
5296
|
-
/** Capture operation succeeded. */
|
|
5297
|
-
SUCCEEDED = "SUCCEEDED",
|
|
5298
|
-
/** Capture operation failed. */
|
|
5299
|
-
FAILED = "FAILED"
|
|
5000
|
+
interface CaptureAuthorizedPaymentsResponse {
|
|
5001
|
+
/** All order's transactions after the capture was triggered */
|
|
5002
|
+
orderTransactions?: OrderTransactions;
|
|
5300
5003
|
}
|
|
5301
|
-
|
|
5302
|
-
|
|
5303
|
-
|
|
5304
|
-
|
|
5305
|
-
|
|
5004
|
+
interface ChargeSavedPaymentMethodRequest {
|
|
5005
|
+
/**
|
|
5006
|
+
* Ecom Order ID.
|
|
5007
|
+
* @minLength 1
|
|
5008
|
+
* @maxLength 100
|
|
5009
|
+
*/
|
|
5010
|
+
ecomOrderId?: string;
|
|
5011
|
+
/** Amount to be charged */
|
|
5012
|
+
amount?: Price;
|
|
5306
5013
|
}
|
|
5307
|
-
interface
|
|
5308
|
-
/**
|
|
5309
|
-
|
|
5310
|
-
/** Date and time the void was initiated in [ISO-8601](https://en.wikipedia.org/wiki/ISO_8601#Combined_date_and_time_representations) format. */
|
|
5311
|
-
voidedDate?: Date | null;
|
|
5312
|
-
/** In case of status is FAILED may contain failure details */
|
|
5313
|
-
failureDetails?: AuthorizationActionFailureDetails;
|
|
5314
|
-
/** Reason of void action */
|
|
5315
|
-
reason?: ReasonWithLiterals;
|
|
5014
|
+
interface ChargeSavedPaymentMethodResponse {
|
|
5015
|
+
/** Payment gateway's order ID (e.g Wix Payments) */
|
|
5016
|
+
paymentGatewayOrderId?: string;
|
|
5316
5017
|
}
|
|
5317
|
-
|
|
5318
|
-
/**
|
|
5319
|
-
|
|
5320
|
-
/** Void operation succeeded. */
|
|
5321
|
-
SUCCEEDED = "SUCCEEDED",
|
|
5322
|
-
/** Void operation failed. */
|
|
5323
|
-
FAILED = "FAILED"
|
|
5018
|
+
interface SendBuyerConfirmationEmailRequest {
|
|
5019
|
+
/** @format GUID */
|
|
5020
|
+
orderId?: string;
|
|
5324
5021
|
}
|
|
5325
|
-
|
|
5326
|
-
type AuthorizationVoidStatusWithLiterals = AuthorizationVoidStatus | 'PENDING' | 'SUCCEEDED' | 'FAILED';
|
|
5327
|
-
/** Reason the authorization was voided. */
|
|
5328
|
-
declare enum Reason {
|
|
5329
|
-
/** Authorization was voided by user. */
|
|
5330
|
-
MANUAL = "MANUAL",
|
|
5331
|
-
/** Authorization passed execution date. */
|
|
5332
|
-
SCHEDULED = "SCHEDULED"
|
|
5022
|
+
interface SendBuyerConfirmationEmailResponse {
|
|
5333
5023
|
}
|
|
5334
|
-
|
|
5335
|
-
|
|
5336
|
-
|
|
5337
|
-
|
|
5338
|
-
|
|
5339
|
-
|
|
5340
|
-
executionDate?: Date | null;
|
|
5024
|
+
interface SendBuyerPaymentsReceivedEmailRequest {
|
|
5025
|
+
/**
|
|
5026
|
+
* @minLength 1
|
|
5027
|
+
* @maxLength 100
|
|
5028
|
+
*/
|
|
5029
|
+
orderId?: string;
|
|
5341
5030
|
}
|
|
5342
|
-
|
|
5343
|
-
VOID = "VOID",
|
|
5344
|
-
CAPTURE = "CAPTURE"
|
|
5031
|
+
interface SendBuyerPaymentsReceivedEmailResponse {
|
|
5345
5032
|
}
|
|
5346
|
-
|
|
5347
|
-
type ActionTypeWithLiterals = ActionType | 'VOID' | 'CAPTURE';
|
|
5348
|
-
interface Chargeback {
|
|
5033
|
+
interface SendBuyerPickupConfirmationEmailRequest {
|
|
5349
5034
|
/**
|
|
5350
|
-
*
|
|
5351
|
-
* @
|
|
5352
|
-
* @readonly
|
|
5353
|
-
* @immutable
|
|
5035
|
+
* @minLength 1
|
|
5036
|
+
* @maxLength 100
|
|
5354
5037
|
*/
|
|
5355
|
-
|
|
5038
|
+
orderId?: string;
|
|
5039
|
+
}
|
|
5040
|
+
interface SendBuyerPickupConfirmationEmailResponse {
|
|
5041
|
+
}
|
|
5042
|
+
interface BulkSendBuyerPickupConfirmationEmailsRequest {
|
|
5356
5043
|
/**
|
|
5357
|
-
*
|
|
5358
|
-
* @
|
|
5359
|
-
* @
|
|
5044
|
+
* IDs of orders to send pickup emails for.
|
|
5045
|
+
* @minSize 1
|
|
5046
|
+
* @maxSize 300
|
|
5360
5047
|
*/
|
|
5361
|
-
|
|
5048
|
+
orderIds?: string[];
|
|
5049
|
+
}
|
|
5050
|
+
interface BulkSendBuyerPickupConfirmationEmailsResponse {
|
|
5051
|
+
}
|
|
5052
|
+
interface SendBuyerShippingConfirmationEmailRequest {
|
|
5362
5053
|
/**
|
|
5363
|
-
*
|
|
5364
|
-
* @
|
|
5054
|
+
* @minLength 1
|
|
5055
|
+
* @maxLength 100
|
|
5365
5056
|
*/
|
|
5366
|
-
|
|
5057
|
+
orderId?: string;
|
|
5058
|
+
}
|
|
5059
|
+
interface SendBuyerShippingConfirmationEmailResponse {
|
|
5060
|
+
}
|
|
5061
|
+
interface BulkSendBuyerShippingConfirmationEmailsRequest {
|
|
5367
5062
|
/**
|
|
5368
|
-
*
|
|
5369
|
-
* @
|
|
5370
|
-
* @
|
|
5063
|
+
* IDs of orders to send pickup emails for.
|
|
5064
|
+
* @minSize 1
|
|
5065
|
+
* @maxSize 300
|
|
5371
5066
|
*/
|
|
5372
|
-
|
|
5067
|
+
orderIds?: string[];
|
|
5068
|
+
}
|
|
5069
|
+
interface BulkSendBuyerShippingConfirmationEmailsResponse {
|
|
5070
|
+
}
|
|
5071
|
+
interface SendMerchantOrderReceivedNotificationRequest {
|
|
5373
5072
|
/**
|
|
5374
|
-
*
|
|
5375
|
-
* @
|
|
5073
|
+
* @minLength 1
|
|
5074
|
+
* @maxLength 100
|
|
5376
5075
|
*/
|
|
5377
|
-
|
|
5076
|
+
orderId?: string;
|
|
5077
|
+
}
|
|
5078
|
+
interface SendMerchantOrderReceivedNotificationResponse {
|
|
5079
|
+
}
|
|
5080
|
+
interface SendCancelRefundEmailRequest {
|
|
5378
5081
|
/**
|
|
5379
|
-
*
|
|
5380
|
-
*
|
|
5381
|
-
*
|
|
5082
|
+
* The ID of order that is canceled/refunded
|
|
5083
|
+
* @minLength 1
|
|
5084
|
+
* @maxLength 100
|
|
5382
5085
|
*/
|
|
5383
|
-
|
|
5086
|
+
orderId?: string;
|
|
5384
5087
|
/**
|
|
5385
|
-
*
|
|
5088
|
+
* Personal note added to the email (optional)
|
|
5089
|
+
* @minLength 1
|
|
5090
|
+
* @maxLength 1000
|
|
5091
|
+
*/
|
|
5092
|
+
customMessage?: string | null;
|
|
5093
|
+
/** Refund amount */
|
|
5094
|
+
refundAmount?: Price;
|
|
5095
|
+
/**
|
|
5096
|
+
* Refund ID. (Optional)
|
|
5386
5097
|
* @format GUID
|
|
5387
|
-
* @readonly
|
|
5388
|
-
* @immutable
|
|
5389
5098
|
*/
|
|
5390
|
-
|
|
5099
|
+
refundId?: string | null;
|
|
5391
5100
|
}
|
|
5392
|
-
|
|
5393
|
-
/** Chargeback was approved. */
|
|
5394
|
-
APPROVED = "APPROVED",
|
|
5395
|
-
/** Chargeback was reversed. */
|
|
5396
|
-
REVERSED = "REVERSED"
|
|
5101
|
+
interface SendCancelRefundEmailResponse {
|
|
5397
5102
|
}
|
|
5398
|
-
|
|
5399
|
-
type ChargebackStatusWithLiterals = ChargebackStatus | 'APPROVED' | 'REVERSED';
|
|
5400
|
-
interface PaymentMethodName {
|
|
5103
|
+
interface SendRefundEmailRequest {
|
|
5401
5104
|
/**
|
|
5402
|
-
*
|
|
5403
|
-
* @
|
|
5105
|
+
* The ID of order that is refunded
|
|
5106
|
+
* @format GUID
|
|
5404
5107
|
*/
|
|
5405
|
-
|
|
5108
|
+
orderId?: string;
|
|
5406
5109
|
/**
|
|
5407
|
-
*
|
|
5408
|
-
* @
|
|
5110
|
+
* Refund ID
|
|
5111
|
+
* @format GUID
|
|
5409
5112
|
*/
|
|
5410
|
-
|
|
5113
|
+
refundId?: string;
|
|
5411
5114
|
/**
|
|
5412
|
-
*
|
|
5413
|
-
*
|
|
5414
|
-
*
|
|
5115
|
+
* Personal note added to the email (optional)
|
|
5116
|
+
* @minLength 1
|
|
5117
|
+
* @maxLength 1000
|
|
5415
5118
|
*/
|
|
5416
|
-
|
|
5119
|
+
customMessage?: string | null;
|
|
5417
5120
|
}
|
|
5418
|
-
interface
|
|
5121
|
+
interface SendRefundEmailResponse {
|
|
5122
|
+
}
|
|
5123
|
+
interface SendFulfillmentEmailRequest {
|
|
5124
|
+
/** @format GUID */
|
|
5125
|
+
orderId?: string;
|
|
5126
|
+
/** @format GUID */
|
|
5127
|
+
fulfillerId?: string;
|
|
5128
|
+
}
|
|
5129
|
+
interface SendFulfillmentEmailResponse {
|
|
5130
|
+
}
|
|
5131
|
+
interface SendMerchantOrderReceivedPushRequest {
|
|
5419
5132
|
/**
|
|
5420
|
-
*
|
|
5133
|
+
* @minLength 1
|
|
5421
5134
|
* @maxLength 100
|
|
5422
5135
|
*/
|
|
5423
|
-
|
|
5136
|
+
orderId?: string;
|
|
5137
|
+
}
|
|
5138
|
+
interface SendMerchantOrderReceivedPushResponse {
|
|
5139
|
+
}
|
|
5140
|
+
interface PreviewEmailByTypeRequest {
|
|
5141
|
+
emailType?: PreviewEmailTypeWithLiterals;
|
|
5142
|
+
}
|
|
5143
|
+
declare enum PreviewEmailType {
|
|
5144
|
+
ORDER_PLACED = "ORDER_PLACED",
|
|
5145
|
+
DOWNLOAD_LINKS = "DOWNLOAD_LINKS",
|
|
5146
|
+
ORDER_SHIPPED = "ORDER_SHIPPED",
|
|
5147
|
+
ORDER_READY_FOR_PICKUP = "ORDER_READY_FOR_PICKUP"
|
|
5148
|
+
}
|
|
5149
|
+
/** @enumType */
|
|
5150
|
+
type PreviewEmailTypeWithLiterals = PreviewEmailType | 'ORDER_PLACED' | 'DOWNLOAD_LINKS' | 'ORDER_SHIPPED' | 'ORDER_READY_FOR_PICKUP';
|
|
5151
|
+
interface PreviewEmailByTypeResponse {
|
|
5152
|
+
emailPreview?: string;
|
|
5153
|
+
}
|
|
5154
|
+
interface PreviewRefundEmailRequest {
|
|
5424
5155
|
/**
|
|
5425
|
-
*
|
|
5426
|
-
* @
|
|
5156
|
+
* @minLength 1
|
|
5157
|
+
* @maxLength 100
|
|
5427
5158
|
*/
|
|
5428
|
-
|
|
5159
|
+
orderId?: string;
|
|
5160
|
+
/** Refund amount */
|
|
5161
|
+
refundAmount?: Price;
|
|
5162
|
+
/** Refund business details */
|
|
5163
|
+
details?: RefundDetails;
|
|
5429
5164
|
/**
|
|
5430
|
-
*
|
|
5431
|
-
* @
|
|
5165
|
+
* Personal note added to the email (optional)
|
|
5166
|
+
* @minLength 1
|
|
5167
|
+
* @maxLength 1000
|
|
5168
|
+
*/
|
|
5169
|
+
customMessage?: string | null;
|
|
5170
|
+
/**
|
|
5171
|
+
* Refund ID. (Optional)
|
|
5172
|
+
* @format GUID
|
|
5432
5173
|
*/
|
|
5433
|
-
|
|
5174
|
+
refundId?: string | null;
|
|
5434
5175
|
}
|
|
5435
|
-
interface
|
|
5176
|
+
interface PreviewRefundEmailResponse {
|
|
5177
|
+
emailPreview?: string;
|
|
5178
|
+
}
|
|
5179
|
+
interface PreviewCancelEmailRequest {
|
|
5436
5180
|
/**
|
|
5437
|
-
* Membership ID.
|
|
5438
5181
|
* @minLength 1
|
|
5439
5182
|
* @maxLength 100
|
|
5440
5183
|
*/
|
|
5441
|
-
|
|
5184
|
+
orderId?: string;
|
|
5442
5185
|
/**
|
|
5443
|
-
*
|
|
5186
|
+
* Personal note added to the email (optional)
|
|
5444
5187
|
* @minLength 1
|
|
5445
|
-
* @maxLength
|
|
5188
|
+
* @maxLength 1000
|
|
5446
5189
|
*/
|
|
5447
|
-
|
|
5448
|
-
|
|
5449
|
-
|
|
5450
|
-
|
|
5451
|
-
|
|
5190
|
+
customMessage?: string | null;
|
|
5191
|
+
}
|
|
5192
|
+
interface PreviewCancelEmailResponse {
|
|
5193
|
+
emailPreview?: string;
|
|
5194
|
+
}
|
|
5195
|
+
interface PreviewCancelRefundEmailRequest {
|
|
5452
5196
|
/**
|
|
5453
|
-
* The transaction ID in the membership system. Can be used to void the transaction.
|
|
5454
5197
|
* @minLength 1
|
|
5455
5198
|
* @maxLength 100
|
|
5456
5199
|
*/
|
|
5457
|
-
|
|
5200
|
+
orderId?: string;
|
|
5458
5201
|
/**
|
|
5459
|
-
*
|
|
5460
|
-
* @
|
|
5202
|
+
* Personal note added to the email (optional)
|
|
5203
|
+
* @minLength 1
|
|
5204
|
+
* @maxLength 1000
|
|
5461
5205
|
*/
|
|
5462
|
-
|
|
5206
|
+
customMessage?: string | null;
|
|
5207
|
+
/** Refund amount */
|
|
5208
|
+
refundAmount?: Price;
|
|
5463
5209
|
/**
|
|
5464
|
-
* ID
|
|
5210
|
+
* Refund ID. (Optional)
|
|
5465
5211
|
* @format GUID
|
|
5466
5212
|
*/
|
|
5467
|
-
|
|
5213
|
+
refundId?: string | null;
|
|
5468
5214
|
}
|
|
5469
|
-
|
|
5470
|
-
|
|
5471
|
-
CHARGED = "CHARGED",
|
|
5472
|
-
/** The attempt to charge the payment failed, for example, due to lack of credits. */
|
|
5473
|
-
CHARGE_FAILED = "CHARGE_FAILED",
|
|
5474
|
-
/** Payment is pending. */
|
|
5475
|
-
CHARGE_PENDING = "CHARGE_PENDING",
|
|
5476
|
-
/** Payment was voided. */
|
|
5477
|
-
VOIDED = "VOIDED"
|
|
5215
|
+
interface PreviewCancelRefundEmailResponse {
|
|
5216
|
+
emailPreview?: string;
|
|
5478
5217
|
}
|
|
5479
|
-
|
|
5480
|
-
|
|
5481
|
-
interface
|
|
5218
|
+
interface PreviewBuyerPaymentsReceivedEmailRequest {
|
|
5219
|
+
}
|
|
5220
|
+
interface PreviewBuyerPaymentsReceivedEmailResponse {
|
|
5221
|
+
emailPreview?: string;
|
|
5222
|
+
}
|
|
5223
|
+
interface PreviewBuyerConfirmationEmailRequest {
|
|
5224
|
+
}
|
|
5225
|
+
interface PreviewBuyerConfirmationEmailResponse {
|
|
5226
|
+
emailPreview?: string;
|
|
5227
|
+
}
|
|
5228
|
+
interface PreviewBuyerPickupConfirmationEmailRequest {
|
|
5229
|
+
}
|
|
5230
|
+
interface PreviewBuyerPickupConfirmationEmailResponse {
|
|
5231
|
+
emailPreview?: string;
|
|
5232
|
+
}
|
|
5233
|
+
interface PreviewShippingConfirmationEmailRequest {
|
|
5234
|
+
}
|
|
5235
|
+
interface PreviewShippingConfirmationEmailResponse {
|
|
5236
|
+
emailPreview?: string;
|
|
5237
|
+
}
|
|
5238
|
+
interface PreviewResendDownloadLinksEmailRequest {
|
|
5239
|
+
}
|
|
5240
|
+
interface PreviewResendDownloadLinksEmailResponse {
|
|
5241
|
+
emailPreview?: string;
|
|
5242
|
+
}
|
|
5243
|
+
interface MetaSiteSpecialEvent extends MetaSiteSpecialEventPayloadOneOf {
|
|
5244
|
+
/** Emitted on a meta site creation. */
|
|
5245
|
+
siteCreated?: SiteCreated;
|
|
5246
|
+
/** Emitted on a meta site transfer completion. */
|
|
5247
|
+
siteTransferred?: SiteTransferred;
|
|
5248
|
+
/** Emitted on a meta site deletion. */
|
|
5249
|
+
siteDeleted?: SiteDeleted;
|
|
5250
|
+
/** Emitted on a meta site restoration. */
|
|
5251
|
+
siteUndeleted?: SiteUndeleted;
|
|
5252
|
+
/** Emitted on the first* publish of the meta site (* switching from unpublished to published state). */
|
|
5253
|
+
sitePublished?: SitePublished;
|
|
5254
|
+
/** Emitted on a meta site unpublish. */
|
|
5255
|
+
siteUnpublished?: SiteUnpublished;
|
|
5256
|
+
/** Emitted when meta site is marked as template. */
|
|
5257
|
+
siteMarkedAsTemplate?: SiteMarkedAsTemplate;
|
|
5258
|
+
/** Emitted when meta site is marked as a WixSite. */
|
|
5259
|
+
siteMarkedAsWixSite?: SiteMarkedAsWixSite;
|
|
5260
|
+
/** Emitted when an application is provisioned (installed). */
|
|
5261
|
+
serviceProvisioned?: ServiceProvisioned;
|
|
5262
|
+
/** Emitted when an application is removed (uninstalled). */
|
|
5263
|
+
serviceRemoved?: ServiceRemoved;
|
|
5264
|
+
/** Emitted when meta site name (URL slug) is changed. */
|
|
5265
|
+
siteRenamedPayload?: SiteRenamed;
|
|
5266
|
+
/** Emitted when meta site was permanently deleted. */
|
|
5267
|
+
hardDeleted?: SiteHardDeleted;
|
|
5268
|
+
/** Emitted on a namespace change. */
|
|
5269
|
+
namespaceChanged?: NamespaceChanged;
|
|
5270
|
+
/** Emitted when Studio is attached. */
|
|
5271
|
+
studioAssigned?: StudioAssigned;
|
|
5272
|
+
/** Emitted when Studio is detached. */
|
|
5273
|
+
studioUnassigned?: StudioUnassigned;
|
|
5482
5274
|
/**
|
|
5483
|
-
*
|
|
5275
|
+
* Emitted when one of the URLs is changed. After this event you may call `urls-server` to fetch
|
|
5276
|
+
* the actual URL.
|
|
5277
|
+
*
|
|
5278
|
+
* See: https://wix.slack.com/archives/C0UHEBPFT/p1732520791210559?thread_ts=1732027914.294059&cid=C0UHEBPFT
|
|
5279
|
+
* See: https://wix.slack.com/archives/C0UHEBPFT/p1744115197619459
|
|
5280
|
+
*/
|
|
5281
|
+
urlChanged?: SiteUrlChanged;
|
|
5282
|
+
/** Site is marked as PurgedExternally */
|
|
5283
|
+
sitePurgedExternally?: SitePurgedExternally;
|
|
5284
|
+
/** Emitted when Odeditor is attached. */
|
|
5285
|
+
odeditorAssigned?: OdeditorAssigned;
|
|
5286
|
+
/** Emitted when Odeditor is detached. */
|
|
5287
|
+
odeditorUnassigned?: OdeditorUnassigned;
|
|
5288
|
+
/** Emitted when Picasso is attached. */
|
|
5289
|
+
picassoAssigned?: PicassoAssigned;
|
|
5290
|
+
/** Emitted when Picasso is detached. */
|
|
5291
|
+
picassoUnassigned?: PicassoUnassigned;
|
|
5292
|
+
/** Emitted when Wixel is attached. */
|
|
5293
|
+
wixelAssigned?: WixelAssigned;
|
|
5294
|
+
/** Emitted when Wixel is detached. */
|
|
5295
|
+
wixelUnassigned?: WixelUnassigned;
|
|
5296
|
+
/** Emitted when StudioTwo is attached. */
|
|
5297
|
+
studioTwoAssigned?: StudioTwoAssigned;
|
|
5298
|
+
/** Emitted when StudioTwo is detached. */
|
|
5299
|
+
studioTwoUnassigned?: StudioTwoUnassigned;
|
|
5300
|
+
/** Emitted when media from user domain is enabled. */
|
|
5301
|
+
userDomainMediaEnabled?: UserDomainMediaEnabled;
|
|
5302
|
+
/** Emitted when media from user domain is disabled. */
|
|
5303
|
+
userDomainMediaDisabled?: UserDomainMediaDisabled;
|
|
5304
|
+
/** Emitted when Editorless is attached. */
|
|
5305
|
+
editorlessAssigned?: EditorlessAssigned;
|
|
5306
|
+
/** Emitted when Editorless is detached. */
|
|
5307
|
+
editorlessUnassigned?: EditorlessUnassigned;
|
|
5308
|
+
/**
|
|
5309
|
+
* A meta site id.
|
|
5484
5310
|
* @format GUID
|
|
5485
5311
|
*/
|
|
5486
|
-
|
|
5312
|
+
metaSiteId?: string;
|
|
5313
|
+
/** A meta site version. Monotonically increasing. */
|
|
5314
|
+
version?: string;
|
|
5315
|
+
/** A timestamp of the event. */
|
|
5316
|
+
timestamp?: string;
|
|
5487
5317
|
/**
|
|
5488
|
-
*
|
|
5489
|
-
*
|
|
5490
|
-
* @
|
|
5318
|
+
* TODO(meta-site): Change validation once validations are disabled for consumers
|
|
5319
|
+
* More context: https://wix.slack.com/archives/C0UHEBPFT/p1720957844413149 and https://wix.slack.com/archives/CFWKX325T/p1728892152855659
|
|
5320
|
+
* @maxSize 4000
|
|
5491
5321
|
*/
|
|
5492
|
-
|
|
5322
|
+
assets?: Asset[];
|
|
5493
5323
|
}
|
|
5494
|
-
|
|
5324
|
+
/** @oneof */
|
|
5325
|
+
interface MetaSiteSpecialEventPayloadOneOf {
|
|
5326
|
+
/** Emitted on a meta site creation. */
|
|
5327
|
+
siteCreated?: SiteCreated;
|
|
5328
|
+
/** Emitted on a meta site transfer completion. */
|
|
5329
|
+
siteTransferred?: SiteTransferred;
|
|
5330
|
+
/** Emitted on a meta site deletion. */
|
|
5331
|
+
siteDeleted?: SiteDeleted;
|
|
5332
|
+
/** Emitted on a meta site restoration. */
|
|
5333
|
+
siteUndeleted?: SiteUndeleted;
|
|
5334
|
+
/** Emitted on the first* publish of the meta site (* switching from unpublished to published state). */
|
|
5335
|
+
sitePublished?: SitePublished;
|
|
5336
|
+
/** Emitted on a meta site unpublish. */
|
|
5337
|
+
siteUnpublished?: SiteUnpublished;
|
|
5338
|
+
/** Emitted when meta site is marked as template. */
|
|
5339
|
+
siteMarkedAsTemplate?: SiteMarkedAsTemplate;
|
|
5340
|
+
/** Emitted when meta site is marked as a WixSite. */
|
|
5341
|
+
siteMarkedAsWixSite?: SiteMarkedAsWixSite;
|
|
5342
|
+
/** Emitted when an application is provisioned (installed). */
|
|
5343
|
+
serviceProvisioned?: ServiceProvisioned;
|
|
5344
|
+
/** Emitted when an application is removed (uninstalled). */
|
|
5345
|
+
serviceRemoved?: ServiceRemoved;
|
|
5346
|
+
/** Emitted when meta site name (URL slug) is changed. */
|
|
5347
|
+
siteRenamedPayload?: SiteRenamed;
|
|
5348
|
+
/** Emitted when meta site was permanently deleted. */
|
|
5349
|
+
hardDeleted?: SiteHardDeleted;
|
|
5350
|
+
/** Emitted on a namespace change. */
|
|
5351
|
+
namespaceChanged?: NamespaceChanged;
|
|
5352
|
+
/** Emitted when Studio is attached. */
|
|
5353
|
+
studioAssigned?: StudioAssigned;
|
|
5354
|
+
/** Emitted when Studio is detached. */
|
|
5355
|
+
studioUnassigned?: StudioUnassigned;
|
|
5356
|
+
/**
|
|
5357
|
+
* Emitted when one of the URLs is changed. After this event you may call `urls-server` to fetch
|
|
5358
|
+
* the actual URL.
|
|
5359
|
+
*
|
|
5360
|
+
* See: https://wix.slack.com/archives/C0UHEBPFT/p1732520791210559?thread_ts=1732027914.294059&cid=C0UHEBPFT
|
|
5361
|
+
* See: https://wix.slack.com/archives/C0UHEBPFT/p1744115197619459
|
|
5362
|
+
*/
|
|
5363
|
+
urlChanged?: SiteUrlChanged;
|
|
5364
|
+
/** Site is marked as PurgedExternally */
|
|
5365
|
+
sitePurgedExternally?: SitePurgedExternally;
|
|
5366
|
+
/** Emitted when Odeditor is attached. */
|
|
5367
|
+
odeditorAssigned?: OdeditorAssigned;
|
|
5368
|
+
/** Emitted when Odeditor is detached. */
|
|
5369
|
+
odeditorUnassigned?: OdeditorUnassigned;
|
|
5370
|
+
/** Emitted when Picasso is attached. */
|
|
5371
|
+
picassoAssigned?: PicassoAssigned;
|
|
5372
|
+
/** Emitted when Picasso is detached. */
|
|
5373
|
+
picassoUnassigned?: PicassoUnassigned;
|
|
5374
|
+
/** Emitted when Wixel is attached. */
|
|
5375
|
+
wixelAssigned?: WixelAssigned;
|
|
5376
|
+
/** Emitted when Wixel is detached. */
|
|
5377
|
+
wixelUnassigned?: WixelUnassigned;
|
|
5378
|
+
/** Emitted when StudioTwo is attached. */
|
|
5379
|
+
studioTwoAssigned?: StudioTwoAssigned;
|
|
5380
|
+
/** Emitted when StudioTwo is detached. */
|
|
5381
|
+
studioTwoUnassigned?: StudioTwoUnassigned;
|
|
5382
|
+
/** Emitted when media from user domain is enabled. */
|
|
5383
|
+
userDomainMediaEnabled?: UserDomainMediaEnabled;
|
|
5384
|
+
/** Emitted when media from user domain is disabled. */
|
|
5385
|
+
userDomainMediaDisabled?: UserDomainMediaDisabled;
|
|
5386
|
+
/** Emitted when Editorless is attached. */
|
|
5387
|
+
editorlessAssigned?: EditorlessAssigned;
|
|
5388
|
+
/** Emitted when Editorless is detached. */
|
|
5389
|
+
editorlessUnassigned?: EditorlessUnassigned;
|
|
5390
|
+
}
|
|
5391
|
+
interface Asset {
|
|
5392
|
+
/**
|
|
5393
|
+
* An application definition id (app_id in dev-center). For legacy reasons may be UUID or a string (from Java Enum).
|
|
5394
|
+
* @maxLength 36
|
|
5395
|
+
*/
|
|
5396
|
+
appDefId?: string;
|
|
5397
|
+
/**
|
|
5398
|
+
* An instance id. For legacy reasons may be UUID or a string.
|
|
5399
|
+
* @maxLength 200
|
|
5400
|
+
*/
|
|
5401
|
+
instanceId?: string;
|
|
5402
|
+
/** An application state. */
|
|
5403
|
+
state?: StateWithLiterals;
|
|
5404
|
+
}
|
|
5405
|
+
declare enum State {
|
|
5406
|
+
UNKNOWN = "UNKNOWN",
|
|
5407
|
+
ENABLED = "ENABLED",
|
|
5408
|
+
DISABLED = "DISABLED",
|
|
5409
|
+
PENDING = "PENDING",
|
|
5410
|
+
DEMO = "DEMO"
|
|
5411
|
+
}
|
|
5412
|
+
/** @enumType */
|
|
5413
|
+
type StateWithLiterals = State | 'UNKNOWN' | 'ENABLED' | 'DISABLED' | 'PENDING' | 'DEMO';
|
|
5414
|
+
interface SiteCreated {
|
|
5415
|
+
/**
|
|
5416
|
+
* A template identifier (empty if not created from a template).
|
|
5417
|
+
* @maxLength 36
|
|
5418
|
+
*/
|
|
5419
|
+
originTemplateId?: string;
|
|
5495
5420
|
/**
|
|
5496
|
-
*
|
|
5497
|
-
* @
|
|
5421
|
+
* An account id of the owner.
|
|
5422
|
+
* @format GUID
|
|
5498
5423
|
*/
|
|
5499
|
-
|
|
5424
|
+
ownerId?: string;
|
|
5425
|
+
/** A context in which meta site was created. */
|
|
5426
|
+
context?: SiteCreatedContextWithLiterals;
|
|
5500
5427
|
/**
|
|
5501
|
-
*
|
|
5428
|
+
* A meta site id from which this site was created.
|
|
5429
|
+
*
|
|
5430
|
+
* In case of a creation from a template it's a template id.
|
|
5431
|
+
* In case of a site duplication ("Save As" in dashboard or duplicate in UM) it's an id of a source site.
|
|
5502
5432
|
* @format GUID
|
|
5503
5433
|
*/
|
|
5504
|
-
|
|
5434
|
+
originMetaSiteId?: string | null;
|
|
5505
5435
|
/**
|
|
5506
|
-
*
|
|
5507
|
-
* @
|
|
5508
|
-
* @maxLength 40
|
|
5436
|
+
* A meta site name (URL slug).
|
|
5437
|
+
* @maxLength 20
|
|
5509
5438
|
*/
|
|
5510
|
-
|
|
5511
|
-
|
|
5512
|
-
|
|
5439
|
+
siteName?: string;
|
|
5440
|
+
/** A namespace. */
|
|
5441
|
+
namespace?: NamespaceWithLiterals;
|
|
5513
5442
|
}
|
|
5514
|
-
declare enum
|
|
5515
|
-
|
|
5516
|
-
|
|
5517
|
-
|
|
5518
|
-
|
|
5519
|
-
|
|
5520
|
-
|
|
5521
|
-
|
|
5522
|
-
|
|
5523
|
-
|
|
5443
|
+
declare enum SiteCreatedContext {
|
|
5444
|
+
/** A valid option, we don't expose all reasons why site might be created. */
|
|
5445
|
+
OTHER = "OTHER",
|
|
5446
|
+
/** A meta site was created from template. */
|
|
5447
|
+
FROM_TEMPLATE = "FROM_TEMPLATE",
|
|
5448
|
+
/** A meta site was created by copying of the transfferred meta site. */
|
|
5449
|
+
DUPLICATE_BY_SITE_TRANSFER = "DUPLICATE_BY_SITE_TRANSFER",
|
|
5450
|
+
/** A copy of existing meta site. */
|
|
5451
|
+
DUPLICATE = "DUPLICATE",
|
|
5452
|
+
/** A meta site was created as a transfferred site (copy of the original), old flow, should die soon. */
|
|
5453
|
+
OLD_SITE_TRANSFER = "OLD_SITE_TRANSFER",
|
|
5454
|
+
/** deprecated A meta site was created for Flash editor. */
|
|
5455
|
+
FLASH = "FLASH"
|
|
5524
5456
|
}
|
|
5525
5457
|
/** @enumType */
|
|
5526
|
-
type
|
|
5527
|
-
|
|
5528
|
-
|
|
5529
|
-
|
|
5530
|
-
|
|
5531
|
-
|
|
5532
|
-
|
|
5533
|
-
|
|
5458
|
+
type SiteCreatedContextWithLiterals = SiteCreatedContext | 'OTHER' | 'FROM_TEMPLATE' | 'DUPLICATE_BY_SITE_TRANSFER' | 'DUPLICATE' | 'OLD_SITE_TRANSFER' | 'FLASH';
|
|
5459
|
+
declare enum Namespace {
|
|
5460
|
+
UNKNOWN_NAMESPACE = "UNKNOWN_NAMESPACE",
|
|
5461
|
+
/** Default namespace for UGC sites. MetaSites with this namespace will be shown in a user's site list by default. */
|
|
5462
|
+
WIX = "WIX",
|
|
5463
|
+
/** 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. */
|
|
5464
|
+
SHOUT_OUT = "SHOUT_OUT",
|
|
5465
|
+
/** 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. */
|
|
5466
|
+
ALBUMS = "ALBUMS",
|
|
5467
|
+
/** 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. */
|
|
5468
|
+
WIX_STORES_TEST_DRIVE = "WIX_STORES_TEST_DRIVE",
|
|
5469
|
+
/** Hotels standalone (siteless). MetaSites with this namespace will *not* be shown in a user's site list by default. */
|
|
5470
|
+
HOTELS = "HOTELS",
|
|
5471
|
+
/** 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. */
|
|
5472
|
+
CLUBS = "CLUBS",
|
|
5473
|
+
/** A partially created ADI website. MetaSites with this namespace will *not* be shown in a user's site list by default. */
|
|
5474
|
+
ONBOARDING_DRAFT = "ONBOARDING_DRAFT",
|
|
5475
|
+
/** AppBuilder for AppStudio / shmite (c). MetaSites with this namespace will *not* be shown in a user's site list by default. */
|
|
5476
|
+
DEV_SITE = "DEV_SITE",
|
|
5477
|
+
/** 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. */
|
|
5478
|
+
LOGOS = "LOGOS",
|
|
5479
|
+
/** 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. */
|
|
5480
|
+
VIDEO_MAKER = "VIDEO_MAKER",
|
|
5481
|
+
/** MetaSites with this namespace will *not* be shown in a user's site list by default. */
|
|
5482
|
+
PARTNER_DASHBOARD = "PARTNER_DASHBOARD",
|
|
5483
|
+
/** MetaSites with this namespace will *not* be shown in a user's site list by default. */
|
|
5484
|
+
DEV_CENTER_COMPANY = "DEV_CENTER_COMPANY",
|
|
5534
5485
|
/**
|
|
5535
|
-
*
|
|
5536
|
-
*
|
|
5486
|
+
* A draft created by HTML editor on open. Upon "first save" it will be moved to be of WIX domain.
|
|
5487
|
+
*
|
|
5488
|
+
* Meta site with this namespace will *not* be shown in a user's site list by default.
|
|
5537
5489
|
*/
|
|
5538
|
-
|
|
5539
|
-
/** Refund business details. */
|
|
5540
|
-
details?: RefundDetails;
|
|
5490
|
+
HTML_DRAFT = "HTML_DRAFT",
|
|
5541
5491
|
/**
|
|
5542
|
-
*
|
|
5543
|
-
*
|
|
5544
|
-
*
|
|
5492
|
+
* the user-journey for Fitness users who want to start from managing their business instead of designing their website.
|
|
5493
|
+
* Will be accessible from Site List and will not have a website app.
|
|
5494
|
+
* Once the user attaches a site, the site will become a regular wixsite.
|
|
5545
5495
|
*/
|
|
5546
|
-
|
|
5496
|
+
SITELESS_BUSINESS = "SITELESS_BUSINESS",
|
|
5497
|
+
/** Belongs to "strategic products" company. Supports new product in the creator's economy space. */
|
|
5498
|
+
CREATOR_ECONOMY = "CREATOR_ECONOMY",
|
|
5499
|
+
/** It is to be used in the Business First efforts. */
|
|
5500
|
+
DASHBOARD_FIRST = "DASHBOARD_FIRST",
|
|
5501
|
+
/** Bookings business flow with no site. */
|
|
5502
|
+
ANYWHERE = "ANYWHERE",
|
|
5503
|
+
/** Namespace for Headless Backoffice with no editor */
|
|
5504
|
+
HEADLESS = "HEADLESS",
|
|
5547
5505
|
/**
|
|
5548
|
-
*
|
|
5549
|
-
*
|
|
5506
|
+
* Namespace for master site that will exist in parent account that will be referenced by subaccounts
|
|
5507
|
+
* The site will be used for account level CSM feature for enterprise
|
|
5550
5508
|
*/
|
|
5551
|
-
|
|
5509
|
+
ACCOUNT_MASTER_CMS = "ACCOUNT_MASTER_CMS",
|
|
5510
|
+
/** Rise.ai Siteless account management for Gift Cards and Store Credit. */
|
|
5511
|
+
RISE = "RISE",
|
|
5552
5512
|
/**
|
|
5553
|
-
*
|
|
5554
|
-
*
|
|
5555
|
-
*
|
|
5556
|
-
* @immutable
|
|
5513
|
+
* As part of the branded app new funnel, users now can create a meta site that will be branded app first.
|
|
5514
|
+
* There's a blank site behind the scene but it's blank).
|
|
5515
|
+
* The Mobile company will be the owner of this namespace.
|
|
5557
5516
|
*/
|
|
5558
|
-
|
|
5559
|
-
|
|
5560
|
-
|
|
5517
|
+
BRANDED_FIRST = "BRANDED_FIRST",
|
|
5518
|
+
/** Nownia.com Siteless account management for Ai Scheduling Assistant. */
|
|
5519
|
+
NOWNIA = "NOWNIA",
|
|
5561
5520
|
/**
|
|
5562
|
-
*
|
|
5563
|
-
*
|
|
5564
|
-
* @immutable
|
|
5521
|
+
* UGC Templates are templates that are created by users for personal use and to sale to other users.
|
|
5522
|
+
* The Partners company owns this namespace.
|
|
5565
5523
|
*/
|
|
5566
|
-
|
|
5524
|
+
UGC_TEMPLATE = "UGC_TEMPLATE",
|
|
5525
|
+
/** Codux Headless Sites */
|
|
5526
|
+
CODUX = "CODUX",
|
|
5527
|
+
/** Bobb - AI Design Creator. */
|
|
5528
|
+
MEDIA_DESIGN_CREATOR = "MEDIA_DESIGN_CREATOR",
|
|
5567
5529
|
/**
|
|
5568
|
-
*
|
|
5569
|
-
*
|
|
5530
|
+
* Shared Blog Site is a unique single site across Enterprise account,
|
|
5531
|
+
* This site will hold all Blog posts related to the Marketing product.
|
|
5570
5532
|
*/
|
|
5571
|
-
|
|
5572
|
-
/**
|
|
5573
|
-
|
|
5574
|
-
/**
|
|
5575
|
-
|
|
5533
|
+
SHARED_BLOG_ENTERPRISE = "SHARED_BLOG_ENTERPRISE",
|
|
5534
|
+
/** Standalone forms (siteless). MetaSites with this namespace will *not* be shown in a user's site list by default. */
|
|
5535
|
+
STANDALONE_FORMS = "STANDALONE_FORMS",
|
|
5536
|
+
/** Standalone events (siteless). MetaSites with this namespace will *not* be shown in a user's site list by default. */
|
|
5537
|
+
STANDALONE_EVENTS = "STANDALONE_EVENTS",
|
|
5538
|
+
/** MIMIR - Siteless account for MIMIR Ai Job runner. */
|
|
5539
|
+
MIMIR = "MIMIR",
|
|
5540
|
+
/** Wix Twins platform. */
|
|
5541
|
+
TWINS = "TWINS",
|
|
5542
|
+
/** Wix Nano. */
|
|
5543
|
+
NANO = "NANO",
|
|
5544
|
+
/** Base44 headless sites. */
|
|
5545
|
+
BASE44 = "BASE44",
|
|
5546
|
+
/** Wix Channels Sites */
|
|
5547
|
+
CHANNELS = "CHANNELS",
|
|
5548
|
+
/** Nautilus platform. */
|
|
5549
|
+
NAUTILUS = "NAUTILUS"
|
|
5550
|
+
}
|
|
5551
|
+
/** @enumType */
|
|
5552
|
+
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';
|
|
5553
|
+
/** Site transferred to another user. */
|
|
5554
|
+
interface SiteTransferred {
|
|
5576
5555
|
/**
|
|
5577
|
-
*
|
|
5578
|
-
* This field is only returned when the value of `external_refund` is `false`.
|
|
5556
|
+
* A previous owner id (user that transfers meta site).
|
|
5579
5557
|
* @format GUID
|
|
5580
5558
|
*/
|
|
5581
|
-
|
|
5582
|
-
/** ID of the refund in the payment provider's system. For example, at PayPal, Square, Stripe, etc. Not returned for external refunds. */
|
|
5583
|
-
providerRefundId?: string | null;
|
|
5559
|
+
oldOwnerId?: string;
|
|
5584
5560
|
/**
|
|
5585
|
-
*
|
|
5586
|
-
* @
|
|
5561
|
+
* A new owner id (user that accepts meta site).
|
|
5562
|
+
* @format GUID
|
|
5587
5563
|
*/
|
|
5588
|
-
|
|
5564
|
+
newOwnerId?: string;
|
|
5589
5565
|
}
|
|
5590
|
-
/**
|
|
5591
|
-
|
|
5592
|
-
/**
|
|
5593
|
-
|
|
5594
|
-
/** Refund transaction succeeded. */
|
|
5595
|
-
SUCCEEDED = "SUCCEEDED",
|
|
5596
|
-
/** Refund transaction failed. */
|
|
5597
|
-
FAILED = "FAILED",
|
|
5598
|
-
/** Refund request acknowledged, and will be executed soon. */
|
|
5599
|
-
SCHEDULED = "SCHEDULED",
|
|
5600
|
-
/** Refund was initiated on payment provider side. */
|
|
5601
|
-
STARTED = "STARTED"
|
|
5566
|
+
/** Soft deletion of the meta site. Could be restored. */
|
|
5567
|
+
interface SiteDeleted {
|
|
5568
|
+
/** A deletion context. */
|
|
5569
|
+
deleteContext?: DeleteContext;
|
|
5602
5570
|
}
|
|
5603
|
-
|
|
5604
|
-
|
|
5605
|
-
|
|
5571
|
+
interface DeleteContext {
|
|
5572
|
+
/** When the meta site was deleted. */
|
|
5573
|
+
dateDeleted?: Date | null;
|
|
5574
|
+
/** A status. */
|
|
5575
|
+
deleteStatus?: DeleteStatusWithLiterals;
|
|
5606
5576
|
/**
|
|
5607
|
-
*
|
|
5608
|
-
*
|
|
5609
|
-
* Learn more about [reason codes](https://dev.wix.com/docs/rest/business-management/payments/service-plugins/payment-service-provider-service-plugin/reason-codes).
|
|
5610
|
-
* @minLength 1
|
|
5611
|
-
* @maxLength 10
|
|
5577
|
+
* A reason (flow).
|
|
5578
|
+
* @maxLength 255
|
|
5612
5579
|
*/
|
|
5613
|
-
|
|
5580
|
+
deleteOrigin?: string;
|
|
5614
5581
|
/**
|
|
5615
|
-
*
|
|
5616
|
-
* @
|
|
5617
|
-
* @maxLength 1000
|
|
5582
|
+
* A service that deleted it.
|
|
5583
|
+
* @maxLength 255
|
|
5618
5584
|
*/
|
|
5619
|
-
|
|
5585
|
+
initiatorId?: string | null;
|
|
5620
5586
|
}
|
|
5621
|
-
|
|
5622
|
-
|
|
5623
|
-
|
|
5624
|
-
|
|
5625
|
-
|
|
5626
|
-
|
|
5627
|
-
refunded?: Price;
|
|
5628
|
-
/** Failed refund amount - the portion of `requestedRefund` that failed. */
|
|
5629
|
-
failedRefundAmount?: Price;
|
|
5630
|
-
/** Whether at least one refund transaction is still in `"PENDING"` status. */
|
|
5631
|
-
pending?: boolean;
|
|
5632
|
-
/** Breakdown of refunded items. Available only after refund is complete. */
|
|
5633
|
-
breakdown?: RefundItemsBreakdown;
|
|
5587
|
+
declare enum DeleteStatus {
|
|
5588
|
+
UNKNOWN = "UNKNOWN",
|
|
5589
|
+
TRASH = "TRASH",
|
|
5590
|
+
DELETED = "DELETED",
|
|
5591
|
+
PENDING_PURGE = "PENDING_PURGE",
|
|
5592
|
+
PURGED_EXTERNALLY = "PURGED_EXTERNALLY"
|
|
5634
5593
|
}
|
|
5635
|
-
|
|
5636
|
-
|
|
5637
|
-
|
|
5638
|
-
|
|
5639
|
-
*/
|
|
5640
|
-
lineItems?: LineItemRefundSummary[];
|
|
5594
|
+
/** @enumType */
|
|
5595
|
+
type DeleteStatusWithLiterals = DeleteStatus | 'UNKNOWN' | 'TRASH' | 'DELETED' | 'PENDING_PURGE' | 'PURGED_EXTERNALLY';
|
|
5596
|
+
/** Restoration of the meta site. */
|
|
5597
|
+
interface SiteUndeleted {
|
|
5641
5598
|
}
|
|
5642
|
-
|
|
5643
|
-
|
|
5644
|
-
* ID of the refunded line item.
|
|
5645
|
-
* @format GUID
|
|
5646
|
-
*/
|
|
5647
|
-
lineItemId?: string;
|
|
5648
|
-
/** Total refunded amount for the line item. */
|
|
5649
|
-
totalRefundedAmount?: Price;
|
|
5599
|
+
/** First publish of a meta site. Or subsequent publish after unpublish. */
|
|
5600
|
+
interface SitePublished {
|
|
5650
5601
|
}
|
|
5651
|
-
interface
|
|
5602
|
+
interface SiteUnpublished {
|
|
5652
5603
|
/**
|
|
5653
|
-
*
|
|
5654
|
-
* @
|
|
5655
|
-
* @
|
|
5604
|
+
* A list of URLs previously associated with the meta site.
|
|
5605
|
+
* @maxLength 4000
|
|
5606
|
+
* @maxSize 10000
|
|
5656
5607
|
*/
|
|
5657
|
-
|
|
5608
|
+
urls?: string[];
|
|
5609
|
+
}
|
|
5610
|
+
interface SiteMarkedAsTemplate {
|
|
5611
|
+
}
|
|
5612
|
+
interface SiteMarkedAsWixSite {
|
|
5613
|
+
}
|
|
5614
|
+
/**
|
|
5615
|
+
* Represents a service provisioned a site.
|
|
5616
|
+
*
|
|
5617
|
+
* Note on `origin_instance_id`:
|
|
5618
|
+
* There is no guarantee that you will be able to find a meta site using `origin_instance_id`.
|
|
5619
|
+
* This is because of the following scenario:
|
|
5620
|
+
*
|
|
5621
|
+
* Imagine you have a template where a third-party application (TPA) includes some stub data,
|
|
5622
|
+
* such as a product catalog. When you create a site from this template, you inherit this
|
|
5623
|
+
* default product catalog. However, if the template's product catalog is modified,
|
|
5624
|
+
* your site will retain the catalog as it was at the time of site creation. This ensures that
|
|
5625
|
+
* your site remains consistent with what you initially received and does not include any
|
|
5626
|
+
* changes made to the original template afterward.
|
|
5627
|
+
* To ensure this, the TPA on the template gets a new instance_id.
|
|
5628
|
+
*/
|
|
5629
|
+
interface ServiceProvisioned {
|
|
5658
5630
|
/**
|
|
5659
|
-
*
|
|
5660
|
-
* @
|
|
5631
|
+
* Either UUID or EmbeddedServiceType.
|
|
5632
|
+
* @maxLength 36
|
|
5661
5633
|
*/
|
|
5662
|
-
|
|
5663
|
-
/** Should include shipping in refund calculation */
|
|
5664
|
-
refundShipping?: boolean;
|
|
5665
|
-
}
|
|
5666
|
-
interface CalculateRefundItemRequest {
|
|
5634
|
+
appDefId?: string;
|
|
5667
5635
|
/**
|
|
5668
|
-
*
|
|
5669
|
-
* @
|
|
5636
|
+
* Not only UUID. Something here could be something weird.
|
|
5637
|
+
* @maxLength 36
|
|
5670
5638
|
*/
|
|
5671
|
-
|
|
5639
|
+
instanceId?: string;
|
|
5672
5640
|
/**
|
|
5673
|
-
*
|
|
5674
|
-
* @
|
|
5675
|
-
* @max 100000
|
|
5641
|
+
* An instance id from which this instance is originated.
|
|
5642
|
+
* @maxLength 36
|
|
5676
5643
|
*/
|
|
5677
|
-
|
|
5678
|
-
}
|
|
5679
|
-
interface CalculateRefundResponse {
|
|
5680
|
-
/** Total refundable amount */
|
|
5681
|
-
total?: Price;
|
|
5682
|
-
/** Tax cost of the order */
|
|
5683
|
-
tax?: Price;
|
|
5684
|
-
/** Discount given for this order */
|
|
5685
|
-
discount?: Price;
|
|
5686
|
-
/** Total cost of the order (without tax) */
|
|
5687
|
-
subtotal?: Price;
|
|
5688
|
-
/** Total shipping cost for order */
|
|
5689
|
-
shipping?: Price;
|
|
5690
|
-
/** Previous refund given on that order */
|
|
5691
|
-
previouslyRefundedAmount?: Price;
|
|
5644
|
+
originInstanceId?: string;
|
|
5692
5645
|
/**
|
|
5693
|
-
*
|
|
5694
|
-
* @
|
|
5646
|
+
* A version.
|
|
5647
|
+
* @maxLength 500
|
|
5695
5648
|
*/
|
|
5696
|
-
|
|
5697
|
-
}
|
|
5698
|
-
interface CalculateRefundItemResponse {
|
|
5649
|
+
version?: string | null;
|
|
5699
5650
|
/**
|
|
5700
|
-
*
|
|
5651
|
+
* The origin meta site id
|
|
5701
5652
|
* @format GUID
|
|
5702
5653
|
*/
|
|
5703
|
-
|
|
5704
|
-
/** Refundable amount for requested quantity of items (price of requested quantity of items without tax and discount) */
|
|
5705
|
-
price?: Price;
|
|
5654
|
+
originMetaSiteId?: string | null;
|
|
5706
5655
|
}
|
|
5707
|
-
interface
|
|
5708
|
-
/**
|
|
5709
|
-
* Wix eCommerce order ID
|
|
5710
|
-
* @minLength 1
|
|
5711
|
-
* @maxLength 100
|
|
5712
|
-
*/
|
|
5713
|
-
ecomOrderId: string;
|
|
5656
|
+
interface ServiceRemoved {
|
|
5714
5657
|
/**
|
|
5715
|
-
*
|
|
5716
|
-
* @
|
|
5717
|
-
* @maxSize 100
|
|
5718
|
-
* @format GUID
|
|
5658
|
+
* Either UUID or EmbeddedServiceType.
|
|
5659
|
+
* @maxLength 36
|
|
5719
5660
|
*/
|
|
5720
|
-
|
|
5721
|
-
}
|
|
5722
|
-
interface VoidAuthorizedPaymentsResponse {
|
|
5723
|
-
/** All order's transactions after the void was triggered */
|
|
5724
|
-
orderTransactions?: OrderTransactions;
|
|
5725
|
-
}
|
|
5726
|
-
interface CaptureAuthorizedPaymentsRequest {
|
|
5661
|
+
appDefId?: string;
|
|
5727
5662
|
/**
|
|
5728
|
-
*
|
|
5729
|
-
* @
|
|
5730
|
-
* @maxLength 100
|
|
5663
|
+
* Not only UUID. Something here could be something weird.
|
|
5664
|
+
* @maxLength 36
|
|
5731
5665
|
*/
|
|
5732
|
-
|
|
5666
|
+
instanceId?: string;
|
|
5733
5667
|
/**
|
|
5734
|
-
*
|
|
5735
|
-
* @
|
|
5736
|
-
* @maxSize 100
|
|
5668
|
+
* A version.
|
|
5669
|
+
* @maxLength 500
|
|
5737
5670
|
*/
|
|
5738
|
-
|
|
5671
|
+
version?: string | null;
|
|
5739
5672
|
}
|
|
5740
|
-
|
|
5673
|
+
/** Rename of the site. Meaning, free public url has been changed as well. */
|
|
5674
|
+
interface SiteRenamed {
|
|
5741
5675
|
/**
|
|
5742
|
-
*
|
|
5743
|
-
* @
|
|
5676
|
+
* A new meta site name (URL slug).
|
|
5677
|
+
* @maxLength 20
|
|
5744
5678
|
*/
|
|
5745
|
-
|
|
5679
|
+
newSiteName?: string;
|
|
5746
5680
|
/**
|
|
5747
|
-
*
|
|
5748
|
-
*
|
|
5681
|
+
* A previous meta site name (URL slug).
|
|
5682
|
+
* @maxLength 255
|
|
5749
5683
|
*/
|
|
5750
|
-
|
|
5684
|
+
oldSiteName?: string;
|
|
5751
5685
|
}
|
|
5752
|
-
|
|
5753
|
-
|
|
5754
|
-
|
|
5686
|
+
/**
|
|
5687
|
+
* Hard deletion of the meta site.
|
|
5688
|
+
*
|
|
5689
|
+
* Could not be restored. Therefore it's desirable to cleanup data.
|
|
5690
|
+
*/
|
|
5691
|
+
interface SiteHardDeleted {
|
|
5692
|
+
/** A deletion context. */
|
|
5693
|
+
deleteContext?: DeleteContext;
|
|
5755
5694
|
}
|
|
5756
|
-
interface
|
|
5695
|
+
interface NamespaceChanged {
|
|
5696
|
+
/** A previous namespace. */
|
|
5697
|
+
oldNamespace?: NamespaceWithLiterals;
|
|
5698
|
+
/** A new namespace. */
|
|
5699
|
+
newNamespace?: NamespaceWithLiterals;
|
|
5700
|
+
}
|
|
5701
|
+
/** Assigned Studio editor */
|
|
5702
|
+
interface StudioAssigned {
|
|
5703
|
+
}
|
|
5704
|
+
/** Unassigned Studio editor */
|
|
5705
|
+
interface StudioUnassigned {
|
|
5706
|
+
}
|
|
5707
|
+
/**
|
|
5708
|
+
* Fired in case site URLs were changed in any way: new secondary domain, published, account slug rename, site rename etc.
|
|
5709
|
+
*
|
|
5710
|
+
* This is an internal event, it's not propagated in special events, because it's non-actionable. If you need to keep up
|
|
5711
|
+
* with sites and its urls, you need to listen to another topic/event. Read about it:
|
|
5712
|
+
*
|
|
5713
|
+
* https://bo.wix.com/wix-docs/rest/meta-site/meta-site---urls-service
|
|
5714
|
+
*/
|
|
5715
|
+
interface SiteUrlChanged {
|
|
5716
|
+
}
|
|
5717
|
+
/**
|
|
5718
|
+
* Used at the end of the deletion flow for both draft sites and when a user deletes a site.
|
|
5719
|
+
* Consumed by other teams to remove relevant data.
|
|
5720
|
+
*/
|
|
5721
|
+
interface SitePurgedExternally {
|
|
5757
5722
|
/**
|
|
5758
|
-
*
|
|
5759
|
-
* @
|
|
5760
|
-
* @
|
|
5723
|
+
* @maxLength 2048
|
|
5724
|
+
* @maxSize 100
|
|
5725
|
+
* @deprecated
|
|
5726
|
+
* @targetRemovalDate 2025-04-15
|
|
5761
5727
|
*/
|
|
5762
|
-
|
|
5763
|
-
/** Amount to be charged */
|
|
5764
|
-
amount?: Price;
|
|
5728
|
+
appDefId?: string[];
|
|
5765
5729
|
}
|
|
5766
|
-
|
|
5767
|
-
|
|
5768
|
-
|
|
5730
|
+
/** Assigned Odeditor */
|
|
5731
|
+
interface OdeditorAssigned {
|
|
5732
|
+
}
|
|
5733
|
+
/** Unassigned Odeditor */
|
|
5734
|
+
interface OdeditorUnassigned {
|
|
5735
|
+
}
|
|
5736
|
+
/** Assigned Picasso editor */
|
|
5737
|
+
interface PicassoAssigned {
|
|
5738
|
+
}
|
|
5739
|
+
/** Unassigned Picasso */
|
|
5740
|
+
interface PicassoUnassigned {
|
|
5741
|
+
}
|
|
5742
|
+
/** Assigned Wixel */
|
|
5743
|
+
interface WixelAssigned {
|
|
5744
|
+
}
|
|
5745
|
+
/** Unassigned Wixel */
|
|
5746
|
+
interface WixelUnassigned {
|
|
5747
|
+
}
|
|
5748
|
+
/** Assigned StudioTwo */
|
|
5749
|
+
interface StudioTwoAssigned {
|
|
5750
|
+
}
|
|
5751
|
+
/** Unassigned StudioTwo */
|
|
5752
|
+
interface StudioTwoUnassigned {
|
|
5753
|
+
}
|
|
5754
|
+
/** Media from user domain is enabled. */
|
|
5755
|
+
interface UserDomainMediaEnabled {
|
|
5756
|
+
}
|
|
5757
|
+
/** Media from user domain is disabled. */
|
|
5758
|
+
interface UserDomainMediaDisabled {
|
|
5759
|
+
}
|
|
5760
|
+
/** Assigned Editorless */
|
|
5761
|
+
interface EditorlessAssigned {
|
|
5762
|
+
}
|
|
5763
|
+
/** Unassigned Editorless */
|
|
5764
|
+
interface EditorlessUnassigned {
|
|
5765
|
+
}
|
|
5766
|
+
interface HasCustomEmailConfigurationsRequest {
|
|
5767
|
+
}
|
|
5768
|
+
interface HasCustomEmailConfigurationsResponse {
|
|
5769
|
+
hasCustomConfigurations?: boolean;
|
|
5770
|
+
}
|
|
5771
|
+
interface AddToAutomationMigrationPopulationRequest {
|
|
5772
|
+
/** When true, sends custom email configurations to automation system via email */
|
|
5773
|
+
sendCustomEmailConfigs?: boolean;
|
|
5774
|
+
/** Origin of the migration request. Defaults to OPT_IN when UNKNOWN_ORIGIN. */
|
|
5775
|
+
origin?: OriginWithLiterals;
|
|
5776
|
+
}
|
|
5777
|
+
declare enum Origin {
|
|
5778
|
+
OPT_IN = "OPT_IN",
|
|
5779
|
+
MIGRATION = "MIGRATION"
|
|
5780
|
+
}
|
|
5781
|
+
/** @enumType */
|
|
5782
|
+
type OriginWithLiterals = Origin | 'OPT_IN' | 'MIGRATION';
|
|
5783
|
+
interface AddToAutomationMigrationPopulationResponse {
|
|
5784
|
+
success?: boolean;
|
|
5785
|
+
}
|
|
5786
|
+
interface IsInAutomationMigrationPopulationRequest {
|
|
5787
|
+
}
|
|
5788
|
+
interface IsInAutomationMigrationPopulationResponse {
|
|
5789
|
+
inPopulation?: boolean;
|
|
5769
5790
|
}
|
|
5770
5791
|
interface DiffmatokyPayload {
|
|
5771
5792
|
left?: string;
|
|
@@ -7750,4 +7771,4 @@ declare function updateOrderStatus(): __PublicMethodMetaInfo<'POST', {
|
|
|
7750
7771
|
declare function aggregateOrders(): __PublicMethodMetaInfo<'POST', {}, AggregateOrdersRequest$1, AggregateOrdersRequest, AggregateOrdersResponse$1, AggregateOrdersResponse>;
|
|
7751
7772
|
declare function bulkUpdateOrderTags(): __PublicMethodMetaInfo<'POST', {}, BulkUpdateOrderTagsRequest$1, BulkUpdateOrderTagsRequest, BulkUpdateOrderTagsResponse$1, BulkUpdateOrderTagsResponse>;
|
|
7752
7773
|
|
|
7753
|
-
export { type AccountInfo as AccountInfoOriginal, type ActionEvent as ActionEventOriginal, ActionType as ActionTypeOriginal, type ActionTypeWithLiterals as ActionTypeWithLiteralsOriginal, type ActivityContentOneOf as ActivityContentOneOfOriginal, type Activity as ActivityOriginal, ActivityType as ActivityTypeOriginal, type ActivityTypeWithLiterals as ActivityTypeWithLiteralsOriginal, type AddActivitiesRequest as AddActivitiesRequestOriginal, type AddActivitiesResponse as AddActivitiesResponseOriginal, type AddActivityRequest as AddActivityRequestOriginal, type AddActivityResponse as AddActivityResponseOriginal, type AddInternalActivityRequest as AddInternalActivityRequestOriginal, type AddInternalActivityResponse as AddInternalActivityResponseOriginal, type AddToAutomationMigrationPopulationRequest as AddToAutomationMigrationPopulationRequestOriginal, type AddToAutomationMigrationPopulationResponse as AddToAutomationMigrationPopulationResponseOriginal, type AdditionalFeeDeltaDeltaOneOf as AdditionalFeeDeltaDeltaOneOfOriginal, type AdditionalFeeDelta as AdditionalFeeDeltaOriginal, type AdditionalFee as AdditionalFeeOriginal, type AdditionalFeeRefund as AdditionalFeeRefundOriginal, AdditionalFeeSource as AdditionalFeeSourceOriginal, type AdditionalFeeSourceWithLiterals as AdditionalFeeSourceWithLiteralsOriginal, type AddressDescription as AddressDescriptionOriginal, type AddressLocation as AddressLocationOriginal, type Address as AddressOriginal, type AddressWithContact as AddressWithContactOriginal, AdjustmentType as AdjustmentTypeOriginal, type AdjustmentTypeWithLiterals as AdjustmentTypeWithLiteralsOriginal, type AggregateOrdersRequest as AggregateOrdersRequestOriginal, type AggregateOrdersResponse as AggregateOrdersResponseOriginal, type AggregatedRefundSummary as AggregatedRefundSummaryOriginal, type ApplicationError as ApplicationErrorOriginal, type AppliedDiscountDeltaDeltaOneOf as AppliedDiscountDeltaDeltaOneOfOriginal, type AppliedDiscountDelta as AppliedDiscountDeltaOriginal, type AppliedDiscountDiscountSourceOneOf as AppliedDiscountDiscountSourceOneOfOriginal, type AppliedDiscount as AppliedDiscountOriginal, type ArchiveOrderRequest as ArchiveOrderRequestOriginal, type ArchiveOrderResponse as ArchiveOrderResponseOriginal, type Asset as AssetOriginal, AttributionSource as AttributionSourceOriginal, type AttributionSourceWithLiterals as AttributionSourceWithLiteralsOriginal, type AuthorizationActionFailureDetails as AuthorizationActionFailureDetailsOriginal, type AuthorizationCapture as AuthorizationCaptureOriginal, AuthorizationCaptureStatus as AuthorizationCaptureStatusOriginal, type AuthorizationCaptureStatusWithLiterals as AuthorizationCaptureStatusWithLiteralsOriginal, type AuthorizationDetails as AuthorizationDetailsOriginal, type AuthorizationVoid as AuthorizationVoidOriginal, AuthorizationVoidStatus as AuthorizationVoidStatusOriginal, type AuthorizationVoidStatusWithLiterals as AuthorizationVoidStatusWithLiteralsOriginal, type AuthorizedPaymentCaptured as AuthorizedPaymentCapturedOriginal, type AuthorizedPaymentCreated as AuthorizedPaymentCreatedOriginal, type AuthorizedPaymentVoided as AuthorizedPaymentVoidedOriginal, type Balance as BalanceOriginal, type BalanceSummary as BalanceSummaryOriginal, type BigDecimalWrapper as BigDecimalWrapperOriginal, type BillingAdjustment as BillingAdjustmentOriginal, type BillingAdjustmentPriceSummary as BillingAdjustmentPriceSummaryOriginal, type BillingSettings as BillingSettingsOriginal, type BulkActionMetadata as BulkActionMetadataOriginal, type BulkArchiveOrdersByFilterRequest as BulkArchiveOrdersByFilterRequestOriginal, type BulkArchiveOrdersByFilterResponse as BulkArchiveOrdersByFilterResponseOriginal, type BulkArchiveOrdersRequest as BulkArchiveOrdersRequestOriginal, type BulkArchiveOrdersResponse as BulkArchiveOrdersResponseOriginal, type BulkDeleteImportedOrdersRequest as BulkDeleteImportedOrdersRequestOriginal, type BulkDeleteImportedOrdersResponse as BulkDeleteImportedOrdersResponseOriginal, type BulkMarkAsFulfilledByFilterRequest as BulkMarkAsFulfilledByFilterRequestOriginal, type BulkMarkAsFulfilledByFilterResponse as BulkMarkAsFulfilledByFilterResponseOriginal, type BulkMarkAsFulfilledRequest as BulkMarkAsFulfilledRequestOriginal, type BulkMarkAsFulfilledResponse as BulkMarkAsFulfilledResponseOriginal, type BulkMarkAsUnfulfilledByFilterRequest as BulkMarkAsUnfulfilledByFilterRequestOriginal, type BulkMarkAsUnfulfilledByFilterResponse as BulkMarkAsUnfulfilledByFilterResponseOriginal, type BulkMarkAsUnfulfilledRequest as BulkMarkAsUnfulfilledRequestOriginal, type BulkMarkAsUnfulfilledResponse as BulkMarkAsUnfulfilledResponseOriginal, type BulkMarkOrdersAsPaidRequest as BulkMarkOrdersAsPaidRequestOriginal, type BulkMarkOrdersAsPaidResponse as BulkMarkOrdersAsPaidResponseOriginal, type BulkOrderResult as BulkOrderResultOriginal, type BulkSendBuyerPickupConfirmationEmailsRequest as BulkSendBuyerPickupConfirmationEmailsRequestOriginal, type BulkSendBuyerPickupConfirmationEmailsResponse as BulkSendBuyerPickupConfirmationEmailsResponseOriginal, type BulkSendBuyerShippingConfirmationEmailsRequest as BulkSendBuyerShippingConfirmationEmailsRequestOriginal, type BulkSendBuyerShippingConfirmationEmailsResponse as BulkSendBuyerShippingConfirmationEmailsResponseOriginal, type BulkSetBusinessLocationRequest as BulkSetBusinessLocationRequestOriginal, type BulkSetBusinessLocationResponse as BulkSetBusinessLocationResponseOriginal, type BulkSetBusinessLocationResult as BulkSetBusinessLocationResultOriginal, type BulkUnArchiveOrdersByFilterRequest as BulkUnArchiveOrdersByFilterRequestOriginal, type BulkUnArchiveOrdersByFilterResponse as BulkUnArchiveOrdersByFilterResponseOriginal, type BulkUnArchiveOrdersRequest as BulkUnArchiveOrdersRequestOriginal, type BulkUnArchiveOrdersResponse as BulkUnArchiveOrdersResponseOriginal, type BulkUpdateOrderTagsRequest as BulkUpdateOrderTagsRequestOriginal, type BulkUpdateOrderTagsResponse as BulkUpdateOrderTagsResponseOriginal, type BulkUpdateOrderTagsResult as BulkUpdateOrderTagsResultOriginal, type BulkUpdateOrdersRequest as BulkUpdateOrdersRequestOriginal, type BulkUpdateOrdersResponse as BulkUpdateOrdersResponseOriginal, type BuyerInfoIdOneOf as BuyerInfoIdOneOfOriginal, type BuyerInfo as BuyerInfoOriginal, type BuyerInfoUpdate as BuyerInfoUpdateOriginal, type CalculateRefundItemRequest as CalculateRefundItemRequestOriginal, type CalculateRefundItemResponse as CalculateRefundItemResponseOriginal, type CalculateRefundRequest as CalculateRefundRequestOriginal, type CalculateRefundResponse as CalculateRefundResponseOriginal, type CalculatedTax as CalculatedTaxOriginal, type CalculatedTaxes as CalculatedTaxesOriginal, type CancelOrderApplicationErrors as CancelOrderApplicationErrorsOriginal, type CancelOrderRequest as CancelOrderRequestOriginal, type CancelOrderResponse as CancelOrderResponseOriginal, type Cancel as CancelOriginal, type CaptureAuthorizedPaymentsApplicationErrors as CaptureAuthorizedPaymentsApplicationErrorsOriginal, type CaptureAuthorizedPaymentsRequest as CaptureAuthorizedPaymentsRequestOriginal, type CaptureAuthorizedPaymentsResponse as CaptureAuthorizedPaymentsResponseOriginal, type CashRoundingDetails as CashRoundingDetailsOriginal, type CashRounding as CashRoundingOriginal, type CatalogReference as CatalogReferenceOriginal, type ChannelInfo as ChannelInfoOriginal, ChannelType as ChannelTypeOriginal, type ChannelTypeWithLiterals as ChannelTypeWithLiteralsOriginal, type ChargeMembershipsRequest as ChargeMembershipsRequestOriginal, type ChargeMembershipsResponse as ChargeMembershipsResponseOriginal, type ChargeSavedPaymentMethodRequest as ChargeSavedPaymentMethodRequestOriginal, type ChargeSavedPaymentMethodResponse as ChargeSavedPaymentMethodResponseOriginal, ChargeType as ChargeTypeOriginal, type ChargeTypeWithLiterals as ChargeTypeWithLiteralsOriginal, type ChargebackCreated as ChargebackCreatedOriginal, type Chargeback as ChargebackOriginal, type ChargebackReversed as ChargebackReversedOriginal, ChargebackStatus as ChargebackStatusOriginal, type ChargebackStatusWithLiterals as ChargebackStatusWithLiteralsOriginal, type ChargedBy as ChargedByOriginal, type Color as ColorOriginal, type CommitDeltasRequest as CommitDeltasRequestOriginal, type CommitDeltasResponse as CommitDeltasResponseOriginal, type CommittedDiffs as CommittedDiffsOriginal, type CommittedDiffsShippingUpdateInfoOneOf as CommittedDiffsShippingUpdateInfoOneOfOriginal, type CommonAddress as CommonAddressOriginal, type CommonAddressStreetOneOf as CommonAddressStreetOneOfOriginal, type Company as CompanyOriginal, type Complete as CompleteOriginal, type Coupon as CouponOriginal, type CreateOrderApplicationErrors as CreateOrderApplicationErrorsOriginal, type CreateOrderRequest as CreateOrderRequestOriginal, type CreateOrderResponse as CreateOrderResponseOriginal, type CreatePaymentGatewayOrderRequest as CreatePaymentGatewayOrderRequestOriginal, type CreatePaymentGatewayOrderResponse as CreatePaymentGatewayOrderResponseOriginal, type CreatedBy as CreatedByOriginal, type CreatedByStringOneOf as CreatedByStringOneOfOriginal, type CreditCardDetails as CreditCardDetailsOriginal, type CreditCardPaymentMethodDetails as CreditCardPaymentMethodDetailsOriginal, type CurrencyConversionDetails as CurrencyConversionDetailsOriginal, type CursorPagingMetadata as CursorPagingMetadataOriginal, type CursorPaging as CursorPagingOriginal, type CursorSearch as CursorSearchOriginal, type CursorSearchPagingMethodOneOf as CursorSearchPagingMethodOneOfOriginal, type Cursors as CursorsOriginal, type CustomActivity as CustomActivityOriginal, type CustomAllowedActions as CustomAllowedActionsOriginal, CustomFieldGroup as CustomFieldGroupOriginal, type CustomFieldGroupWithLiterals as CustomFieldGroupWithLiteralsOriginal, type CustomField as CustomFieldOriginal, type CustomFieldValue as CustomFieldValueOriginal, type Customer as CustomerOriginal, type DecrementData as DecrementDataOriginal, type DecrementItemsQuantityRequest as DecrementItemsQuantityRequestOriginal, type DecrementItemsQuantityResponse as DecrementItemsQuantityResponseOriginal, type DelayedCaptureSettings as DelayedCaptureSettingsOriginal, type DeleteActivityRequest as DeleteActivityRequestOriginal, type DeleteActivityResponse as DeleteActivityResponseOriginal, type DeleteByFilterOperation as DeleteByFilterOperationOriginal, type DeleteByIdsOperation as DeleteByIdsOperationOriginal, type DeleteContext as DeleteContextOriginal, DeleteStatus as DeleteStatusOriginal, type DeleteStatusWithLiterals as DeleteStatusWithLiteralsOriginal, type DeliveryLogisticsAddressOneOf as DeliveryLogisticsAddressOneOfOriginal, type DeliveryLogistics as DeliveryLogisticsOriginal, type DeliveryTimeSlot as DeliveryTimeSlotOriginal, DeltaPaymentOptionType as DeltaPaymentOptionTypeOriginal, type DeltaPaymentOptionTypeWithLiterals as DeltaPaymentOptionTypeWithLiteralsOriginal, type Deposit as DepositOriginal, DepositType as DepositTypeOriginal, type DepositTypeWithLiterals as DepositTypeWithLiteralsOriginal, type DescriptionLineDescriptionLineValueOneOf as DescriptionLineDescriptionLineValueOneOfOriginal, type DescriptionLineName as DescriptionLineNameOriginal, type DescriptionLine as DescriptionLineOriginal, DescriptionLineType as DescriptionLineTypeOriginal, type DescriptionLineTypeWithLiterals as DescriptionLineTypeWithLiteralsOriginal, type DescriptionLineValueOneOf as DescriptionLineValueOneOfOriginal, type DiffmatokyPayload as DiffmatokyPayloadOriginal, type DigitalFile as DigitalFileOriginal, type Dimensions as DimensionsOriginal, DimensionsUnit as DimensionsUnitOriginal, type DimensionsUnitWithLiterals as DimensionsUnitWithLiteralsOriginal, type DiscountOneDiscountTypeOneOf as DiscountOneDiscountTypeOneOfOriginal, type Discount as DiscountOriginal, DiscountReason as DiscountReasonOriginal, type DiscountReasonWithLiterals as DiscountReasonWithLiteralsOriginal, type DiscountRuleName as DiscountRuleNameOriginal, type DiscountRule as DiscountRuleOriginal, DiscountType as DiscountTypeOriginal, type DiscountTypeWithLiterals as DiscountTypeWithLiteralsOriginal, type DomainEventBodyOneOf as DomainEventBodyOneOfOriginal, type DomainEvent as DomainEventOriginal, type DownloadLinkSent as DownloadLinkSentOriginal, type DraftOrderChangesApplied as DraftOrderChangesAppliedOriginal, type DraftOrderCommitSettings as DraftOrderCommitSettingsOriginal, type DraftOrderDiffsBillingUpdateInfoOneOf as DraftOrderDiffsBillingUpdateInfoOneOfOriginal, type DraftOrderDiffsBuyerUpdateInfoOneOf as DraftOrderDiffsBuyerUpdateInfoOneOfOriginal, type DraftOrderDiffs as DraftOrderDiffsOriginal, type DraftOrderDiffsRecipientUpdateInfoOneOf as DraftOrderDiffsRecipientUpdateInfoOneOfOriginal, type DraftOrderDiffsShippingUpdateInfoOneOf as DraftOrderDiffsShippingUpdateInfoOneOfOriginal, type Duration as DurationOriginal, DurationUnit as DurationUnitOriginal, type DurationUnitWithLiterals as DurationUnitWithLiteralsOriginal, type EditorlessAssigned as EditorlessAssignedOriginal, type EditorlessUnassigned as EditorlessUnassignedOriginal, type EmailEdited as EmailEditedOriginal, type Email as EmailOriginal, type Empty as EmptyOriginal, type EntityCreatedEvent as EntityCreatedEventOriginal, type EntityDeletedEvent as EntityDeletedEventOriginal, type EntityUpdatedEvent as EntityUpdatedEventOriginal, type ErrorInformation as ErrorInformationOriginal, type ExtendedFields as ExtendedFieldsOriginal, type ExternalReceiptInfo as ExternalReceiptInfoOriginal, type ExternalReceipt as ExternalReceiptOriginal, type FocalPoint as FocalPointOriginal, type FormIdentifier as FormIdentifierOriginal, type FormInfo as FormInfoOriginal, type FreeTrialPeriod as FreeTrialPeriodOriginal, type FulfillerEmailSent as FulfillerEmailSentOriginal, FulfillmentStatus as FulfillmentStatusOriginal, type FulfillmentStatusUpdated as FulfillmentStatusUpdatedOriginal, type FulfillmentStatusWithLiterals as FulfillmentStatusWithLiteralsOriginal, type FulfillmentStatusesAggregate as FulfillmentStatusesAggregateOriginal, type FullAddressContactDetails as FullAddressContactDetailsOriginal, type GetOrderApplicationErrors as GetOrderApplicationErrorsOriginal, type GetOrderRequest as GetOrderRequestOriginal, type GetOrderResponse as GetOrderResponseOriginal, type GetPaymentCollectabilityStatusRequest as GetPaymentCollectabilityStatusRequestOriginal, type GetPaymentCollectabilityStatusResponse as GetPaymentCollectabilityStatusResponseOriginal, type GetRefundabilityStatusRequest as GetRefundabilityStatusRequestOriginal, type GetRefundabilityStatusResponse as GetRefundabilityStatusResponseOriginal, type GetShipmentsRequest as GetShipmentsRequestOriginal, type GetShipmentsResponse as GetShipmentsResponseOriginal, type GiftCardPaymentDetails as GiftCardPaymentDetailsOriginal, type GiftCardPaymentRefund as GiftCardPaymentRefundOriginal, type HasCustomEmailConfigurationsRequest as HasCustomEmailConfigurationsRequestOriginal, type HasCustomEmailConfigurationsResponse as HasCustomEmailConfigurationsResponseOriginal, type IdAndVersion as IdAndVersionOriginal, type IdentificationDataIdOneOf as IdentificationDataIdOneOfOriginal, type IdentificationData as IdentificationDataOriginal, type Image as ImageOriginal, type ImportOrderApplicationErrors as ImportOrderApplicationErrorsOriginal, type ImportOrderRequest as ImportOrderRequestOriginal, type ImportOrderResponse as ImportOrderResponseOriginal, type ImportedOrderDeleted as ImportedOrderDeletedOriginal, type InternalActivityContentOneOf as InternalActivityContentOneOfOriginal, type InternalActivity as InternalActivityOriginal, type InternalDocument as InternalDocumentOriginal, type InternalDocumentUpdateByFilterOperation as InternalDocumentUpdateByFilterOperationOriginal, type InternalDocumentUpdateOperation as InternalDocumentUpdateOperationOriginal, type InternalQueryOrdersRequest as InternalQueryOrdersRequestOriginal, type InternalQueryOrdersResponse as InternalQueryOrdersResponseOriginal, type InternalUpdateExistingOperation as InternalUpdateExistingOperationOriginal, InventoryAction as InventoryActionOriginal, type InventoryActionWithLiterals as InventoryActionWithLiteralsOriginal, type InventoryUpdateDetails as InventoryUpdateDetailsOriginal, type InvoiceAdded as InvoiceAddedOriginal, type InvoiceDates as InvoiceDatesOriginal, type InvoiceDynamicPriceTotals as InvoiceDynamicPriceTotalsOriginal, type InvoiceFields as InvoiceFieldsOriginal, type InvoiceSentEvent as InvoiceSentEventOriginal, type InvoiceSent as InvoiceSentOriginal, InvoiceStatus as InvoiceStatusOriginal, type InvoiceStatusWithLiterals as InvoiceStatusWithLiteralsOriginal, type InvoicesPayment as InvoicesPaymentOriginal, type IsInAutomationMigrationPopulationRequest as IsInAutomationMigrationPopulationRequestOriginal, type IsInAutomationMigrationPopulationResponse as IsInAutomationMigrationPopulationResponseOriginal, type ItemChangedDetails as ItemChangedDetailsOriginal, type ItemCombinationLineItem as ItemCombinationLineItemOriginal, type ItemCombination as ItemCombinationOriginal, type ItemMetadata as ItemMetadataOriginal, type ItemModifier as ItemModifierOriginal, type ItemTaxFullDetails as ItemTaxFullDetailsOriginal, type ItemTypeItemTypeDataOneOf as ItemTypeItemTypeDataOneOfOriginal, type ItemType as ItemTypeOriginal, ItemTypePreset as ItemTypePresetOriginal, type ItemTypePresetWithLiterals as ItemTypePresetWithLiteralsOriginal, type ItemizedFee as ItemizedFeeOriginal, JurisdictionType as JurisdictionTypeOriginal, type JurisdictionTypeWithLiterals as JurisdictionTypeWithLiteralsOriginal, type LineItemAmount as LineItemAmountOriginal, type LineItemChanges as LineItemChangesOriginal, type LineItemDeltaDeltaOneOf as LineItemDeltaDeltaOneOfOriginal, type LineItemDelta as LineItemDeltaOriginal, type LineItemDescriptionLineChange as LineItemDescriptionLineChangeOriginal, type LineItemDiscount as LineItemDiscountOriginal, type LineItemExchangeData as LineItemExchangeDataOriginal, type LineItemMetaData as LineItemMetaDataOriginal, type LineItemModifiersChange as LineItemModifiersChangeOriginal, type LineItem as LineItemOriginal, type LineItemPriceChange as LineItemPriceChangeOriginal, type LineItemProductNameChange as LineItemProductNameChangeOriginal, type LineItemQuantityChange as LineItemQuantityChangeOriginal, LineItemQuantityChangeType as LineItemQuantityChangeTypeOriginal, type LineItemQuantityChangeTypeWithLiterals as LineItemQuantityChangeTypeWithLiteralsOriginal, type LineItemRefund as LineItemRefundOriginal, type LineItemRefundSummary as LineItemRefundSummaryOriginal, type LineItemTaxBreakdown as LineItemTaxBreakdownOriginal, type LineItemTaxInfo as LineItemTaxInfoOriginal, type LineItemTax as LineItemTaxOriginal, type LineItemUpdate as LineItemUpdateOriginal, type LineItems as LineItemsOriginal, type Locale as LocaleOriginal, type LocationAndQuantity as LocationAndQuantityOriginal, type Location as LocationOriginal, type ManagedAdditionalFee as ManagedAdditionalFeeOriginal, type ManagedDiscount as ManagedDiscountOriginal, type ManagedLineItem as ManagedLineItemOriginal, ManuallyRefundableReason as ManuallyRefundableReasonOriginal, type ManuallyRefundableReasonWithLiterals as ManuallyRefundableReasonWithLiteralsOriginal, type MarkAsFulfilledRequest as MarkAsFulfilledRequestOriginal, type MarkAsFulfilledResponse as MarkAsFulfilledResponseOriginal, type MarkAsUnfulfilledRequest as MarkAsUnfulfilledRequestOriginal, type MarkAsUnfulfilledResponse as MarkAsUnfulfilledResponseOriginal, type MarkOrderAsPaidRequest as MarkOrderAsPaidRequestOriginal, type MarkOrderAsPaidResponse as MarkOrderAsPaidResponseOriginal, type MarkOrderAsSeenByHumanRequest as MarkOrderAsSeenByHumanRequestOriginal, type MarkOrderAsSeenByHumanResponse as MarkOrderAsSeenByHumanResponseOriginal, type MaskedOrderLineItem as MaskedOrderLineItemOriginal, type MaskedOrder as MaskedOrderOriginal, type MembershipChargeItem as MembershipChargeItemOriginal, type MembershipName as MembershipNameOriginal, type MembershipPaymentDetails as MembershipPaymentDetailsOriginal, type MembershipPaymentRefund as MembershipPaymentRefundOriginal, MembershipPaymentStatus as MembershipPaymentStatusOriginal, type MembershipPaymentStatusWithLiterals as MembershipPaymentStatusWithLiteralsOriginal, type MerchantComment as MerchantCommentOriginal, type MerchantDiscountMerchantDiscountReasonOneOf as MerchantDiscountMerchantDiscountReasonOneOfOriginal, type MerchantDiscount as MerchantDiscountOriginal, type MessageEnvelope as MessageEnvelopeOriginal, type MetaData as MetaDataOriginal, type MetaSiteSpecialEvent as MetaSiteSpecialEventOriginal, type MetaSiteSpecialEventPayloadOneOf as MetaSiteSpecialEventPayloadOneOfOriginal, type ModifierGroup as ModifierGroupOriginal, type NamespaceChanged as NamespaceChangedOriginal, Namespace as NamespaceOriginal, type NamespaceWithLiterals as NamespaceWithLiteralsOriginal, type NewExchangeOrderCreated as NewExchangeOrderCreatedOriginal, NonRefundableReason as NonRefundableReasonOriginal, type NonRefundableReasonWithLiterals as NonRefundableReasonWithLiteralsOriginal, type OdeditorAssigned as OdeditorAssignedOriginal, type OdeditorUnassigned as OdeditorUnassignedOriginal, OrderActionType as OrderActionTypeOriginal, type OrderActionTypeWithLiterals as OrderActionTypeWithLiteralsOriginal, OrderActivityTypeEnumActivityType as OrderActivityTypeEnumActivityTypeOriginal, type OrderActivityTypeEnumActivityTypeWithLiterals as OrderActivityTypeEnumActivityTypeWithLiteralsOriginal, OrderApprovalStrategy as OrderApprovalStrategyOriginal, type OrderApprovalStrategyWithLiterals as OrderApprovalStrategyWithLiteralsOriginal, type OrderApproved as OrderApprovedOriginal, type OrderCanceledEventOrderCanceled as OrderCanceledEventOrderCanceledOriginal, type OrderCanceled as OrderCanceledOriginal, type OrderChange as OrderChangeOriginal, type OrderChangeValueOneOf as OrderChangeValueOneOfOriginal, type OrderCreateNotifications as OrderCreateNotificationsOriginal, type OrderCreatedFromExchange as OrderCreatedFromExchangeOriginal, type OrderCreationSettingsEditableByOneOf as OrderCreationSettingsEditableByOneOfOriginal, type OrderCreationSettings as OrderCreationSettingsOriginal, type OrderDeltasCommitted as OrderDeltasCommittedOriginal, type OrderFulfilled as OrderFulfilledOriginal, type OrderImported as OrderImportedOriginal, type OrderItemsRestocked as OrderItemsRestockedOriginal, type OrderLineItemChangedDetails as OrderLineItemChangedDetailsOriginal, type OrderLineItem as OrderLineItemOriginal, type OrderNotFulfilled as OrderNotFulfilledOriginal, type Order as OrderOriginal, type OrderPaid as OrderPaidOriginal, type OrderPartiallyPaid as OrderPartiallyPaidOriginal, type OrderPending as OrderPendingOriginal, type OrderPlaced as OrderPlacedOriginal, type OrderRefunded as OrderRefundedOriginal, type OrderRejectedEventOrderRejected as OrderRejectedEventOrderRejectedOriginal, type OrderRejected as OrderRejectedOriginal, type OrderSettingsAllowedActionsOneOf as OrderSettingsAllowedActionsOneOfOriginal, type OrderSettingsEditableByOneOf as OrderSettingsEditableByOneOfOriginal, type OrderSettings as OrderSettingsOriginal, OrderStatus as OrderStatusOriginal, type OrderStatusWithLiterals as OrderStatusWithLiteralsOriginal, type OrderTaxBreakdown as OrderTaxBreakdownOriginal, type OrderTaxInfo as OrderTaxInfoOriginal, type OrderTransactions as OrderTransactionsOriginal, type OrdersExperiments as OrdersExperimentsOriginal, Origin as OriginOriginal, type OriginWithLiterals as OriginWithLiteralsOriginal, type OwnerApps as OwnerAppsOriginal, type PaymentCanceled as PaymentCanceledOriginal, type PaymentCanceledPaymentDetailsOneOf as PaymentCanceledPaymentDetailsOneOfOriginal, type PaymentCapture as PaymentCaptureOriginal, PaymentCollectabilityStatus as PaymentCollectabilityStatusOriginal, type PaymentCollectabilityStatusWithLiterals as PaymentCollectabilityStatusWithLiteralsOriginal, type PaymentCollectionCreatePaymentGatewayOrderApplicationErrors as PaymentCollectionCreatePaymentGatewayOrderApplicationErrorsOriginal, type PaymentCollectionMarkOrderAsPaidApplicationErrors as PaymentCollectionMarkOrderAsPaidApplicationErrorsOriginal, type PaymentDeclined as PaymentDeclinedOriginal, type PaymentDeclinedPaymentDetailsOneOf as PaymentDeclinedPaymentDetailsOneOfOriginal, type PaymentMethodName as PaymentMethodNameOriginal, PaymentOptionType as PaymentOptionTypeOriginal, type PaymentOptionTypeWithLiterals as PaymentOptionTypeWithLiteralsOriginal, type Payment as PaymentOriginal, type PaymentPaymentDetailsOneOf as PaymentPaymentDetailsOneOfOriginal, type PaymentPending as PaymentPendingOriginal, type PaymentPendingPaymentDetailsOneOf as PaymentPendingPaymentDetailsOneOfOriginal, type PaymentReceiptInfoOneOf as PaymentReceiptInfoOneOfOriginal, type PaymentRefundFailed as PaymentRefundFailedOriginal, type PaymentRefund as PaymentRefundOriginal, type PaymentRefunded as PaymentRefundedOriginal, PaymentStatusEnumPaymentStatus as PaymentStatusEnumPaymentStatusOriginal, type PaymentStatusEnumPaymentStatusWithLiterals as PaymentStatusEnumPaymentStatusWithLiteralsOriginal, PaymentStatus as PaymentStatusOriginal, type PaymentStatusUpdated as PaymentStatusUpdatedOriginal, type PaymentStatusWithLiterals as PaymentStatusWithLiteralsOriginal, type Payments as PaymentsOriginal, type Phone as PhoneOriginal, type PhysicalProperties as PhysicalPropertiesOriginal, type PicassoAssigned as PicassoAssignedOriginal, type PicassoUnassigned as PicassoUnassignedOriginal, type PickupAddress as PickupAddressOriginal, type PickupDetails as PickupDetailsOriginal, PickupMethod as PickupMethodOriginal, type PickupMethodWithLiterals as PickupMethodWithLiteralsOriginal, type PickupReadyEmailSent as PickupReadyEmailSentOriginal, Placement as PlacementOriginal, type PlacementWithLiterals as PlacementWithLiteralsOriginal, type PlainTextValue as PlainTextValueOriginal, type PlatformFee as PlatformFeeOriginal, type PlatformFeeSummary as PlatformFeeSummaryOriginal, type PlatformPagingMetadata as PlatformPagingMetadataOriginal, type PlatformPaging as PlatformPagingOriginal, type PlatformQuery as PlatformQueryOriginal, type PlatformQueryPagingMethodOneOf as PlatformQueryPagingMethodOneOfOriginal, PredefinedPaymentMethod as PredefinedPaymentMethodOriginal, type PredefinedPaymentMethodWithLiterals as PredefinedPaymentMethodWithLiteralsOriginal, type PreparePaymentCollectionApplicationErrors as PreparePaymentCollectionApplicationErrorsOriginal, type PreparePaymentCollectionRequest as PreparePaymentCollectionRequestOriginal, type PreparePaymentCollectionResponse as PreparePaymentCollectionResponseOriginal, type PreviewBuyerConfirmationEmailRequest as PreviewBuyerConfirmationEmailRequestOriginal, type PreviewBuyerConfirmationEmailResponse as PreviewBuyerConfirmationEmailResponseOriginal, type PreviewBuyerPaymentsReceivedEmailRequest as PreviewBuyerPaymentsReceivedEmailRequestOriginal, type PreviewBuyerPaymentsReceivedEmailResponse as PreviewBuyerPaymentsReceivedEmailResponseOriginal, type PreviewBuyerPickupConfirmationEmailRequest as PreviewBuyerPickupConfirmationEmailRequestOriginal, type PreviewBuyerPickupConfirmationEmailResponse as PreviewBuyerPickupConfirmationEmailResponseOriginal, type PreviewCancelEmailRequest as PreviewCancelEmailRequestOriginal, type PreviewCancelEmailResponse as PreviewCancelEmailResponseOriginal, type PreviewCancelRefundEmailRequest as PreviewCancelRefundEmailRequestOriginal, type PreviewCancelRefundEmailResponse as PreviewCancelRefundEmailResponseOriginal, type PreviewEmailByTypeRequest as PreviewEmailByTypeRequestOriginal, type PreviewEmailByTypeResponse as PreviewEmailByTypeResponseOriginal, PreviewEmailType as PreviewEmailTypeOriginal, type PreviewEmailTypeWithLiterals as PreviewEmailTypeWithLiteralsOriginal, type PreviewRefundEmailRequest as PreviewRefundEmailRequestOriginal, type PreviewRefundEmailResponse as PreviewRefundEmailResponseOriginal, type PreviewResendDownloadLinksEmailRequest as PreviewResendDownloadLinksEmailRequestOriginal, type PreviewResendDownloadLinksEmailResponse as PreviewResendDownloadLinksEmailResponseOriginal, type PreviewShippingConfirmationEmailRequest as PreviewShippingConfirmationEmailRequestOriginal, type PreviewShippingConfirmationEmailResponse as PreviewShippingConfirmationEmailResponseOriginal, type PriceDescription as PriceDescriptionOriginal, type Price as PriceOriginal, type PriceSummary as PriceSummaryOriginal, type ProductName as ProductNameOriginal, type PublicActivityContentOneOf as PublicActivityContentOneOfOriginal, type PublicActivity as PublicActivityOriginal, type QueryOrderRequest as QueryOrderRequestOriginal, type QueryOrderResponse as QueryOrderResponseOriginal, type QuotesAddress as QuotesAddressOriginal, Reason as ReasonOriginal, type ReasonWithLiterals as ReasonWithLiteralsOriginal, type ReceiptCreated as ReceiptCreatedOriginal, type ReceiptCreatedReceiptInfoOneOf as ReceiptCreatedReceiptInfoOneOfOriginal, type ReceiptSent as ReceiptSentOriginal, type ReceiptSentReceiptInfoOneOf as ReceiptSentReceiptInfoOneOfOriginal, type RecordManuallyCollectedPaymentApplicationErrors as RecordManuallyCollectedPaymentApplicationErrorsOriginal, type RecordManuallyCollectedPaymentRequest as RecordManuallyCollectedPaymentRequestOriginal, type RecordManuallyCollectedPaymentResponse as RecordManuallyCollectedPaymentResponseOriginal, type RedirectUrls as RedirectUrlsOriginal, type RefundDetails as RefundDetailsOriginal, type RefundInitiated as RefundInitiatedOriginal, type RefundItem as RefundItemOriginal, type RefundItemsBreakdown as RefundItemsBreakdownOriginal, type Refund as RefundOriginal, type RefundSideEffects as RefundSideEffectsOriginal, type RefundStatusInfo as RefundStatusInfoOriginal, RefundStatus as RefundStatusOriginal, type RefundStatusWithLiterals as RefundStatusWithLiteralsOriginal, type RefundTransaction as RefundTransactionOriginal, type RefundabilityAdditionalRefundabilityInfoOneOf as RefundabilityAdditionalRefundabilityInfoOneOfOriginal, type Refundability as RefundabilityOriginal, RefundableStatus as RefundableStatusOriginal, type RefundableStatusWithLiterals as RefundableStatusWithLiteralsOriginal, type RefundedAsStoreCredit as RefundedAsStoreCreditOriginal, type RefundedPaymentKindOneOf as RefundedPaymentKindOneOfOriginal, type RefundedPayment as RefundedPaymentOriginal, type RegularPaymentDetails as RegularPaymentDetailsOriginal, type RegularPaymentDetailsPaymentMethodDetailsOneOf as RegularPaymentDetailsPaymentMethodDetailsOneOfOriginal, type RegularPayment as RegularPaymentOriginal, type RegularPaymentPaymentMethodDetailsOneOf as RegularPaymentPaymentMethodDetailsOneOfOriginal, type RegularPaymentRefund as RegularPaymentRefundOriginal, type Reschedule as RescheduleOriginal, type RestockInfo as RestockInfoOriginal, type RestockItem as RestockItemOriginal, type RestockLocation as RestockLocationOriginal, RestockType as RestockTypeOriginal, type RestockTypeWithLiterals as RestockTypeWithLiteralsOriginal, type RestoreInfo as RestoreInfoOriginal, type SavedPaymentMethod as SavedPaymentMethodOriginal, ScheduledAction as ScheduledActionOriginal, type ScheduledActionWithLiterals as ScheduledActionWithLiteralsOriginal, type SearchOrdersRequest as SearchOrdersRequestOriginal, type SearchOrdersResponse as SearchOrdersResponseOriginal, type SendBuyerConfirmationEmailRequest as SendBuyerConfirmationEmailRequestOriginal, type SendBuyerConfirmationEmailResponse as SendBuyerConfirmationEmailResponseOriginal, type SendBuyerPaymentsReceivedEmailRequest as SendBuyerPaymentsReceivedEmailRequestOriginal, type SendBuyerPaymentsReceivedEmailResponse as SendBuyerPaymentsReceivedEmailResponseOriginal, type SendBuyerPickupConfirmationEmailRequest as SendBuyerPickupConfirmationEmailRequestOriginal, type SendBuyerPickupConfirmationEmailResponse as SendBuyerPickupConfirmationEmailResponseOriginal, type SendBuyerShippingConfirmationEmailRequest as SendBuyerShippingConfirmationEmailRequestOriginal, type SendBuyerShippingConfirmationEmailResponse as SendBuyerShippingConfirmationEmailResponseOriginal, type SendCancelRefundEmailRequest as SendCancelRefundEmailRequestOriginal, type SendCancelRefundEmailResponse as SendCancelRefundEmailResponseOriginal, type SendFulfillmentEmailRequest as SendFulfillmentEmailRequestOriginal, type SendFulfillmentEmailResponse as SendFulfillmentEmailResponseOriginal, type SendMerchantOrderReceivedNotificationRequest as SendMerchantOrderReceivedNotificationRequestOriginal, type SendMerchantOrderReceivedNotificationResponse as SendMerchantOrderReceivedNotificationResponseOriginal, type SendMerchantOrderReceivedPushRequest as SendMerchantOrderReceivedPushRequestOriginal, type SendMerchantOrderReceivedPushResponse as SendMerchantOrderReceivedPushResponseOriginal, type SendOrderUpdatedDomainEventRequest as SendOrderUpdatedDomainEventRequestOriginal, type SendOrderUpdatedDomainEventResponse as SendOrderUpdatedDomainEventResponseOriginal, type SendRefundEmailRequest as SendRefundEmailRequestOriginal, type SendRefundEmailResponse as SendRefundEmailResponseOriginal, type ServiceProperties as ServicePropertiesOriginal, type ServiceProvisioned as ServiceProvisionedOriginal, type ServiceRemoved as ServiceRemovedOriginal, type SetOrderNumberCounterRequest as SetOrderNumberCounterRequestOriginal, type SetOrderNumberCounterResponse as SetOrderNumberCounterResponseOriginal, type ShippingAddressEdited as ShippingAddressEditedOriginal, type ShippingConfirmationEmailSent as ShippingConfirmationEmailSentOriginal, type ShippingInformationChange as ShippingInformationChangeOriginal, type ShippingInformation as ShippingInformationOriginal, type ShippingPrice as ShippingPriceOriginal, type ShippingRefund as ShippingRefundOriginal, type ShippingRegion as ShippingRegionOriginal, SiteCreatedContext as SiteCreatedContextOriginal, type SiteCreatedContextWithLiterals as SiteCreatedContextWithLiteralsOriginal, type SiteCreated as SiteCreatedOriginal, type SiteDeleted as SiteDeletedOriginal, type SiteHardDeleted as SiteHardDeletedOriginal, type SiteMarkedAsTemplate as SiteMarkedAsTemplateOriginal, type SiteMarkedAsWixSite as SiteMarkedAsWixSiteOriginal, type SitePublished as SitePublishedOriginal, type SitePurgedExternally as SitePurgedExternallyOriginal, type SiteRenamed as SiteRenamedOriginal, type SiteTransferred as SiteTransferredOriginal, type SiteUndeleted as SiteUndeletedOriginal, type SiteUnpublished as SiteUnpublishedOriginal, type SiteUrlChanged as SiteUrlChangedOriginal, SortOrder as SortOrderOriginal, type SortOrderWithLiterals as SortOrderWithLiteralsOriginal, type Sorting as SortingOriginal, type Source as SourceOriginal, SourceType as SourceTypeOriginal, type SourceTypeWithLiterals as SourceTypeWithLiteralsOriginal, SpecificItemsCouponBehavior as SpecificItemsCouponBehaviorOriginal, type SpecificItemsCouponBehaviorWithLiterals as SpecificItemsCouponBehaviorWithLiteralsOriginal, type StandardDetails as StandardDetailsOriginal, State as StateOriginal, type StateWithLiterals as StateWithLiteralsOriginal, type StreetAddress as StreetAddressOriginal, type StudioAssigned as StudioAssignedOriginal, type StudioTwoAssigned as StudioTwoAssignedOriginal, type StudioTwoUnassigned as StudioTwoUnassignedOriginal, type StudioUnassigned as StudioUnassignedOriginal, type Subdivision as SubdivisionOriginal, SubdivisionType as SubdivisionTypeOriginal, type SubdivisionTypeWithLiterals as SubdivisionTypeWithLiteralsOriginal, type SubscriptionDescription as SubscriptionDescriptionOriginal, SubscriptionFrequency as SubscriptionFrequencyOriginal, type SubscriptionFrequencyWithLiterals as SubscriptionFrequencyWithLiteralsOriginal, type SubscriptionInfo as SubscriptionInfoOriginal, type SubscriptionSettings as SubscriptionSettingsOriginal, type SubscriptionTitle as SubscriptionTitleOriginal, type TagList as TagListOriginal, type Tags as TagsOriginal, type TagsTagList as TagsTagListOriginal, type TagsTags as TagsTagsOriginal, type TaskActionActionOneOf as TaskActionActionOneOfOriginal, type TaskAction as TaskActionOriginal, type TaskKey as TaskKeyOriginal, type Task as TaskOriginal, type TaxSummary as TaxSummaryOriginal, type TaxableAddress as TaxableAddressOriginal, type TaxableAddressTaxableAddressDataOneOf as TaxableAddressTaxableAddressDataOneOfOriginal, TaxableAddressType as TaxableAddressTypeOriginal, type TaxableAddressTypeWithLiterals as TaxableAddressTypeWithLiteralsOriginal, type TotalPriceChange as TotalPriceChangeOriginal, type TotalPrice as TotalPriceOriginal, type TrackingLinkAdded as TrackingLinkAddedOriginal, type TrackingNumberAdded as TrackingNumberAddedOriginal, type TrackingNumberEdited as TrackingNumberEditedOriginal, TransactionStatus as TransactionStatusOriginal, type TransactionStatusWithLiterals as TransactionStatusWithLiteralsOriginal, type TranslatableString as TranslatableStringOriginal, type TranslatedValue as TranslatedValueOriginal, type TriggerRefundApplicationErrors as TriggerRefundApplicationErrorsOriginal, type TriggerRefundRequest as TriggerRefundRequestOriginal, type TriggerRefundResponse as TriggerRefundResponseOriginal, type TriggerReindexOrderRequest as TriggerReindexOrderRequestOriginal, type TriggerReindexRequest as TriggerReindexRequestOriginal, type TriggerReindexResponse as TriggerReindexResponseOriginal, type UnArchiveOrderRequest as UnArchiveOrderRequestOriginal, type UnArchiveOrderResponse as UnArchiveOrderResponseOriginal, type UpdateActivityRequest as UpdateActivityRequestOriginal, type UpdateActivityResponse as UpdateActivityResponseOriginal, type UpdateBillingContactDetailsRequest as UpdateBillingContactDetailsRequestOriginal, type UpdateBillingContactDetailsResponse as UpdateBillingContactDetailsResponseOriginal, type UpdateBuyerEmailRequest as UpdateBuyerEmailRequestOriginal, type UpdateBuyerEmailResponse as UpdateBuyerEmailResponseOriginal, type UpdateBuyerInfoRequest as UpdateBuyerInfoRequestOriginal, type UpdateBuyerInfoResponse as UpdateBuyerInfoResponseOriginal, type UpdateInternalDocumentsEventOperationOneOf as UpdateInternalDocumentsEventOperationOneOfOriginal, type UpdateInternalDocumentsEvent as UpdateInternalDocumentsEventOriginal, type UpdateLineItemsDescriptionLinesRequest as UpdateLineItemsDescriptionLinesRequestOriginal, type UpdateLineItemsDescriptionLinesResponse as UpdateLineItemsDescriptionLinesResponseOriginal, type UpdateOrderApplicationErrors as UpdateOrderApplicationErrorsOriginal, type UpdateOrderLineItemRequest as UpdateOrderLineItemRequestOriginal, type UpdateOrderLineItemResponse as UpdateOrderLineItemResponseOriginal, type UpdateOrderLineItemsRequest as UpdateOrderLineItemsRequestOriginal, type UpdateOrderLineItemsResponse as UpdateOrderLineItemsResponseOriginal, type UpdateOrderRequest as UpdateOrderRequestOriginal, type UpdateOrderResponse as UpdateOrderResponseOriginal, type UpdateOrderShippingAddressRequest as UpdateOrderShippingAddressRequestOriginal, type UpdateOrderShippingAddressResponse as UpdateOrderShippingAddressResponseOriginal, type UpdateOrderStatusApplicationErrors as UpdateOrderStatusApplicationErrorsOriginal, type UpdateOrderStatusRequest as UpdateOrderStatusRequestOriginal, type UpdateOrderStatusResponse as UpdateOrderStatusResponseOriginal, type UserDefinedPaymentMethodNameKindOneOf as UserDefinedPaymentMethodNameKindOneOfOriginal, type UserDefinedPaymentMethodName as UserDefinedPaymentMethodNameOriginal, type UserDomainMediaDisabled as UserDomainMediaDisabledOriginal, type UserDomainMediaEnabled as UserDomainMediaEnabledOriginal, type V1BulkMarkOrdersAsPaidRequest as V1BulkMarkOrdersAsPaidRequestOriginal, type V1BulkMarkOrdersAsPaidResponse as V1BulkMarkOrdersAsPaidResponseOriginal, type V1CreatePaymentGatewayOrderRequest as V1CreatePaymentGatewayOrderRequestOriginal, type V1CreatePaymentGatewayOrderResponse as V1CreatePaymentGatewayOrderResponseOriginal, type V1LineItemDeltaDeltaOneOf as V1LineItemDeltaDeltaOneOfOriginal, type V1LineItemDelta as V1LineItemDeltaOriginal, type V1MarkOrderAsPaidRequest as V1MarkOrderAsPaidRequestOriginal, type V1MarkOrderAsPaidResponse as V1MarkOrderAsPaidResponseOriginal, type V1RestockItem as V1RestockItemOriginal, type V1ScheduledAction as V1ScheduledActionOriginal, type V1ShippingInformation as V1ShippingInformationOriginal, type Value as ValueOriginal, ValueType as ValueTypeOriginal, type ValueTypeWithLiterals as ValueTypeWithLiteralsOriginal, type VatId as VatIdOriginal, VatType as VatTypeOriginal, type VatTypeWithLiterals as VatTypeWithLiteralsOriginal, type VersionedDeleteByIdsOperation as VersionedDeleteByIdsOperationOriginal, type VersionedDocumentId as VersionedDocumentIdOriginal, type VersionedDocumentUpdateOperation as VersionedDocumentUpdateOperationOriginal, VersioningMode as VersioningModeOriginal, type VersioningModeWithLiterals as VersioningModeWithLiteralsOriginal, type VoidAuthorizedPaymentsApplicationErrors as VoidAuthorizedPaymentsApplicationErrorsOriginal, type VoidAuthorizedPaymentsRequest as VoidAuthorizedPaymentsRequestOriginal, type VoidAuthorizedPaymentsResponse as VoidAuthorizedPaymentsResponseOriginal, WebhookIdentityType as WebhookIdentityTypeOriginal, type WebhookIdentityTypeWithLiterals as WebhookIdentityTypeWithLiteralsOriginal, WeightUnit as WeightUnitOriginal, type WeightUnitWithLiterals as WeightUnitWithLiteralsOriginal, type WixReceiptInfo as WixReceiptInfoOriginal, type WixReceipt as WixReceiptOriginal, type WixelAssigned as WixelAssignedOriginal, type WixelUnassigned as WixelUnassignedOriginal, type __PublicMethodMetaInfo, addActivities, addActivity, aggregateOrders, bulkDeleteImportedOrders, bulkUpdateOrderTags, bulkUpdateOrders, cancelOrder, captureAuthorizedPayments, chargeMemberships, createOrder, deleteActivity, getOrder, getPaymentCollectabilityStatus, getRefundabilityStatus, importOrder, paymentCollectionBulkMarkOrdersAsPaid, paymentCollectionCreatePaymentGatewayOrder, paymentCollectionMarkOrderAsPaid, preparePaymentCollection, recordManuallyCollectedPayment, searchOrders, setOrderNumberCounter, triggerRefund, updateActivity, updateOrder, updateOrderLineItem, updateOrderStatus, voidAuthorizedPayments };
|
|
7774
|
+
export { type AccountInfo as AccountInfoOriginal, type ActionEvent as ActionEventOriginal, ActionType as ActionTypeOriginal, type ActionTypeWithLiterals as ActionTypeWithLiteralsOriginal, type ActivityContentOneOf as ActivityContentOneOfOriginal, type Activity as ActivityOriginal, ActivityType as ActivityTypeOriginal, type ActivityTypeWithLiterals as ActivityTypeWithLiteralsOriginal, type AddActivitiesRequest as AddActivitiesRequestOriginal, type AddActivitiesResponse as AddActivitiesResponseOriginal, type AddActivityRequest as AddActivityRequestOriginal, type AddActivityResponse as AddActivityResponseOriginal, type AddInternalActivityRequest as AddInternalActivityRequestOriginal, type AddInternalActivityResponse as AddInternalActivityResponseOriginal, type AddToAutomationMigrationPopulationRequest as AddToAutomationMigrationPopulationRequestOriginal, type AddToAutomationMigrationPopulationResponse as AddToAutomationMigrationPopulationResponseOriginal, type AdditionalFeeDeltaDeltaOneOf as AdditionalFeeDeltaDeltaOneOfOriginal, type AdditionalFeeDelta as AdditionalFeeDeltaOriginal, type AdditionalFee as AdditionalFeeOriginal, type AdditionalFeeRefund as AdditionalFeeRefundOriginal, AdditionalFeeSource as AdditionalFeeSourceOriginal, type AdditionalFeeSourceWithLiterals as AdditionalFeeSourceWithLiteralsOriginal, type AddressDescription as AddressDescriptionOriginal, type AddressLocation as AddressLocationOriginal, type Address as AddressOriginal, type AddressWithContact as AddressWithContactOriginal, AdjustmentType as AdjustmentTypeOriginal, type AdjustmentTypeWithLiterals as AdjustmentTypeWithLiteralsOriginal, type AggregateOrdersRequest as AggregateOrdersRequestOriginal, type AggregateOrdersResponse as AggregateOrdersResponseOriginal, type AggregatedRefundSummary as AggregatedRefundSummaryOriginal, type ApplicationError as ApplicationErrorOriginal, type AppliedDiscountDeltaDeltaOneOf as AppliedDiscountDeltaDeltaOneOfOriginal, type AppliedDiscountDelta as AppliedDiscountDeltaOriginal, type AppliedDiscountDiscountSourceOneOf as AppliedDiscountDiscountSourceOneOfOriginal, type AppliedDiscount as AppliedDiscountOriginal, type ArchiveOrderRequest as ArchiveOrderRequestOriginal, type ArchiveOrderResponse as ArchiveOrderResponseOriginal, type Asset as AssetOriginal, AttributionSource as AttributionSourceOriginal, type AttributionSourceWithLiterals as AttributionSourceWithLiteralsOriginal, type AuthorizationActionFailureDetails as AuthorizationActionFailureDetailsOriginal, type AuthorizationCapture as AuthorizationCaptureOriginal, AuthorizationCaptureStatus as AuthorizationCaptureStatusOriginal, type AuthorizationCaptureStatusWithLiterals as AuthorizationCaptureStatusWithLiteralsOriginal, type AuthorizationDetails as AuthorizationDetailsOriginal, type AuthorizationVoid as AuthorizationVoidOriginal, AuthorizationVoidStatus as AuthorizationVoidStatusOriginal, type AuthorizationVoidStatusWithLiterals as AuthorizationVoidStatusWithLiteralsOriginal, type AuthorizedPaymentCaptured as AuthorizedPaymentCapturedOriginal, type AuthorizedPaymentCreated as AuthorizedPaymentCreatedOriginal, type AuthorizedPaymentVoided as AuthorizedPaymentVoidedOriginal, type Balance as BalanceOriginal, type BalanceSummary as BalanceSummaryOriginal, type BigDecimalWrapper as BigDecimalWrapperOriginal, type BillingAdjustment as BillingAdjustmentOriginal, type BillingAdjustmentPriceSummary as BillingAdjustmentPriceSummaryOriginal, type BillingSettings as BillingSettingsOriginal, type BulkActionMetadata as BulkActionMetadataOriginal, type BulkArchiveOrdersByFilterRequest as BulkArchiveOrdersByFilterRequestOriginal, type BulkArchiveOrdersByFilterResponse as BulkArchiveOrdersByFilterResponseOriginal, type BulkArchiveOrdersRequest as BulkArchiveOrdersRequestOriginal, type BulkArchiveOrdersResponse as BulkArchiveOrdersResponseOriginal, type BulkDeleteImportedOrdersRequest as BulkDeleteImportedOrdersRequestOriginal, type BulkDeleteImportedOrdersResponse as BulkDeleteImportedOrdersResponseOriginal, type BulkMarkAsFulfilledByFilterRequest as BulkMarkAsFulfilledByFilterRequestOriginal, type BulkMarkAsFulfilledByFilterResponse as BulkMarkAsFulfilledByFilterResponseOriginal, type BulkMarkAsFulfilledRequest as BulkMarkAsFulfilledRequestOriginal, type BulkMarkAsFulfilledResponse as BulkMarkAsFulfilledResponseOriginal, type BulkMarkAsUnfulfilledByFilterRequest as BulkMarkAsUnfulfilledByFilterRequestOriginal, type BulkMarkAsUnfulfilledByFilterResponse as BulkMarkAsUnfulfilledByFilterResponseOriginal, type BulkMarkAsUnfulfilledRequest as BulkMarkAsUnfulfilledRequestOriginal, type BulkMarkAsUnfulfilledResponse as BulkMarkAsUnfulfilledResponseOriginal, type BulkMarkOrdersAsPaidRequest as BulkMarkOrdersAsPaidRequestOriginal, type BulkMarkOrdersAsPaidResponse as BulkMarkOrdersAsPaidResponseOriginal, type BulkOrderResult as BulkOrderResultOriginal, type BulkSendBuyerPickupConfirmationEmailsRequest as BulkSendBuyerPickupConfirmationEmailsRequestOriginal, type BulkSendBuyerPickupConfirmationEmailsResponse as BulkSendBuyerPickupConfirmationEmailsResponseOriginal, type BulkSendBuyerShippingConfirmationEmailsRequest as BulkSendBuyerShippingConfirmationEmailsRequestOriginal, type BulkSendBuyerShippingConfirmationEmailsResponse as BulkSendBuyerShippingConfirmationEmailsResponseOriginal, type BulkSetBusinessLocationRequest as BulkSetBusinessLocationRequestOriginal, type BulkSetBusinessLocationResponse as BulkSetBusinessLocationResponseOriginal, type BulkSetBusinessLocationResult as BulkSetBusinessLocationResultOriginal, type BulkUnArchiveOrdersByFilterRequest as BulkUnArchiveOrdersByFilterRequestOriginal, type BulkUnArchiveOrdersByFilterResponse as BulkUnArchiveOrdersByFilterResponseOriginal, type BulkUnArchiveOrdersRequest as BulkUnArchiveOrdersRequestOriginal, type BulkUnArchiveOrdersResponse as BulkUnArchiveOrdersResponseOriginal, type BulkUpdateOrderTagsRequest as BulkUpdateOrderTagsRequestOriginal, type BulkUpdateOrderTagsResponse as BulkUpdateOrderTagsResponseOriginal, type BulkUpdateOrderTagsResult as BulkUpdateOrderTagsResultOriginal, type BulkUpdateOrdersRequest as BulkUpdateOrdersRequestOriginal, type BulkUpdateOrdersResponse as BulkUpdateOrdersResponseOriginal, type BuyerInfoIdOneOf as BuyerInfoIdOneOfOriginal, type BuyerInfo as BuyerInfoOriginal, type BuyerInfoUpdate as BuyerInfoUpdateOriginal, type CalculateRefundItemRequest as CalculateRefundItemRequestOriginal, type CalculateRefundItemResponse as CalculateRefundItemResponseOriginal, type CalculateRefundRequest as CalculateRefundRequestOriginal, type CalculateRefundResponse as CalculateRefundResponseOriginal, type CalculatedTax as CalculatedTaxOriginal, type CalculatedTaxes as CalculatedTaxesOriginal, type CancelOrderApplicationErrors as CancelOrderApplicationErrorsOriginal, type CancelOrderRequest as CancelOrderRequestOriginal, type CancelOrderResponse as CancelOrderResponseOriginal, type Cancel as CancelOriginal, type CaptureAuthorizedPaymentsApplicationErrors as CaptureAuthorizedPaymentsApplicationErrorsOriginal, type CaptureAuthorizedPaymentsRequest as CaptureAuthorizedPaymentsRequestOriginal, type CaptureAuthorizedPaymentsResponse as CaptureAuthorizedPaymentsResponseOriginal, type CashRoundingDetails as CashRoundingDetailsOriginal, type CashRounding as CashRoundingOriginal, type CatalogReference as CatalogReferenceOriginal, type ChannelInfo as ChannelInfoOriginal, ChannelType as ChannelTypeOriginal, type ChannelTypeWithLiterals as ChannelTypeWithLiteralsOriginal, type ChargeMembershipsRequest as ChargeMembershipsRequestOriginal, type ChargeMembershipsResponse as ChargeMembershipsResponseOriginal, type ChargeSavedPaymentMethodRequest as ChargeSavedPaymentMethodRequestOriginal, type ChargeSavedPaymentMethodResponse as ChargeSavedPaymentMethodResponseOriginal, ChargeType as ChargeTypeOriginal, type ChargeTypeWithLiterals as ChargeTypeWithLiteralsOriginal, type ChargebackCreated as ChargebackCreatedOriginal, type Chargeback as ChargebackOriginal, type ChargebackReversed as ChargebackReversedOriginal, ChargebackStatus as ChargebackStatusOriginal, type ChargebackStatusWithLiterals as ChargebackStatusWithLiteralsOriginal, type ChargedBy as ChargedByOriginal, type Color as ColorOriginal, type CommitDeltasRequest as CommitDeltasRequestOriginal, type CommitDeltasResponse as CommitDeltasResponseOriginal, type CommittedDiffs as CommittedDiffsOriginal, type CommittedDiffsShippingUpdateInfoOneOf as CommittedDiffsShippingUpdateInfoOneOfOriginal, type CommonAddress as CommonAddressOriginal, type CommonAddressStreetOneOf as CommonAddressStreetOneOfOriginal, type Company as CompanyOriginal, type Complete as CompleteOriginal, type Coupon as CouponOriginal, type CreateOrderApplicationErrors as CreateOrderApplicationErrorsOriginal, type CreateOrderRequest as CreateOrderRequestOriginal, type CreateOrderResponse as CreateOrderResponseOriginal, type CreatePaymentGatewayOrderRequest as CreatePaymentGatewayOrderRequestOriginal, type CreatePaymentGatewayOrderResponse as CreatePaymentGatewayOrderResponseOriginal, type CreatedBy as CreatedByOriginal, type CreatedByStringOneOf as CreatedByStringOneOfOriginal, type CreditCardDetails as CreditCardDetailsOriginal, type CreditCardPaymentMethodDetails as CreditCardPaymentMethodDetailsOriginal, type CurrencyConversionDetails as CurrencyConversionDetailsOriginal, type CursorPagingMetadata as CursorPagingMetadataOriginal, type CursorPaging as CursorPagingOriginal, type CursorSearch as CursorSearchOriginal, type CursorSearchPagingMethodOneOf as CursorSearchPagingMethodOneOfOriginal, type Cursors as CursorsOriginal, type CustomActivity as CustomActivityOriginal, type CustomAllowedActions as CustomAllowedActionsOriginal, CustomFieldGroup as CustomFieldGroupOriginal, type CustomFieldGroupWithLiterals as CustomFieldGroupWithLiteralsOriginal, type CustomField as CustomFieldOriginal, type CustomFieldValue as CustomFieldValueOriginal, type Customer as CustomerOriginal, type DecrementData as DecrementDataOriginal, type DecrementItemsQuantityRequest as DecrementItemsQuantityRequestOriginal, type DecrementItemsQuantityResponse as DecrementItemsQuantityResponseOriginal, type DelayedCaptureSettings as DelayedCaptureSettingsOriginal, type DeleteActivityRequest as DeleteActivityRequestOriginal, type DeleteActivityResponse as DeleteActivityResponseOriginal, type DeleteByFilterOperation as DeleteByFilterOperationOriginal, type DeleteByIdsOperation as DeleteByIdsOperationOriginal, type DeleteContext as DeleteContextOriginal, DeleteStatus as DeleteStatusOriginal, type DeleteStatusWithLiterals as DeleteStatusWithLiteralsOriginal, type DeliveryLogisticsAddressOneOf as DeliveryLogisticsAddressOneOfOriginal, type DeliveryLogistics as DeliveryLogisticsOriginal, type DeliveryTimeSlot as DeliveryTimeSlotOriginal, DeltaPaymentOptionType as DeltaPaymentOptionTypeOriginal, type DeltaPaymentOptionTypeWithLiterals as DeltaPaymentOptionTypeWithLiteralsOriginal, type Deposit as DepositOriginal, DepositType as DepositTypeOriginal, type DepositTypeWithLiterals as DepositTypeWithLiteralsOriginal, type DescriptionLineDescriptionLineValueOneOf as DescriptionLineDescriptionLineValueOneOfOriginal, type DescriptionLineName as DescriptionLineNameOriginal, type DescriptionLine as DescriptionLineOriginal, DescriptionLineType as DescriptionLineTypeOriginal, type DescriptionLineTypeWithLiterals as DescriptionLineTypeWithLiteralsOriginal, type DescriptionLineValueOneOf as DescriptionLineValueOneOfOriginal, type DiffmatokyPayload as DiffmatokyPayloadOriginal, type DigitalFile as DigitalFileOriginal, type Dimensions as DimensionsOriginal, DimensionsUnit as DimensionsUnitOriginal, type DimensionsUnitWithLiterals as DimensionsUnitWithLiteralsOriginal, type DiscountOneDiscountTypeOneOf as DiscountOneDiscountTypeOneOfOriginal, type Discount as DiscountOriginal, DiscountReason as DiscountReasonOriginal, type DiscountReasonWithLiterals as DiscountReasonWithLiteralsOriginal, type DiscountRuleName as DiscountRuleNameOriginal, type DiscountRule as DiscountRuleOriginal, DiscountType as DiscountTypeOriginal, type DiscountTypeWithLiterals as DiscountTypeWithLiteralsOriginal, type DomainEventBodyOneOf as DomainEventBodyOneOfOriginal, type DomainEvent as DomainEventOriginal, type DownloadLinkSent as DownloadLinkSentOriginal, type DraftOrderChangesApplied as DraftOrderChangesAppliedOriginal, type DraftOrderCommitSettings as DraftOrderCommitSettingsOriginal, type DraftOrderDiffsBillingUpdateInfoOneOf as DraftOrderDiffsBillingUpdateInfoOneOfOriginal, type DraftOrderDiffsBuyerUpdateInfoOneOf as DraftOrderDiffsBuyerUpdateInfoOneOfOriginal, type DraftOrderDiffs as DraftOrderDiffsOriginal, type DraftOrderDiffsRecipientUpdateInfoOneOf as DraftOrderDiffsRecipientUpdateInfoOneOfOriginal, type DraftOrderDiffsShippingUpdateInfoOneOf as DraftOrderDiffsShippingUpdateInfoOneOfOriginal, type Duration as DurationOriginal, DurationUnit as DurationUnitOriginal, type DurationUnitWithLiterals as DurationUnitWithLiteralsOriginal, type EditorlessAssigned as EditorlessAssignedOriginal, type EditorlessUnassigned as EditorlessUnassignedOriginal, type EmailEdited as EmailEditedOriginal, type Email as EmailOriginal, type Empty as EmptyOriginal, type EntityCreatedEvent as EntityCreatedEventOriginal, type EntityDeletedEvent as EntityDeletedEventOriginal, type EntityUpdatedEvent as EntityUpdatedEventOriginal, type ErrorInformation as ErrorInformationOriginal, type ExtendedFields as ExtendedFieldsOriginal, type ExternalReceiptInfo as ExternalReceiptInfoOriginal, type ExternalReceipt as ExternalReceiptOriginal, type FocalPoint as FocalPointOriginal, type FormIdentifier as FormIdentifierOriginal, type FormInfo as FormInfoOriginal, type FreeTrialPeriod as FreeTrialPeriodOriginal, type FulfillerEmailSent as FulfillerEmailSentOriginal, FulfillmentStatus as FulfillmentStatusOriginal, type FulfillmentStatusUpdated as FulfillmentStatusUpdatedOriginal, type FulfillmentStatusWithLiterals as FulfillmentStatusWithLiteralsOriginal, type FulfillmentStatusesAggregate as FulfillmentStatusesAggregateOriginal, type FullAddressContactDetails as FullAddressContactDetailsOriginal, type GetOrderApplicationErrors as GetOrderApplicationErrorsOriginal, type GetOrderRequest as GetOrderRequestOriginal, type GetOrderResponse as GetOrderResponseOriginal, type GetPaymentCollectabilityStatusRequest as GetPaymentCollectabilityStatusRequestOriginal, type GetPaymentCollectabilityStatusResponse as GetPaymentCollectabilityStatusResponseOriginal, type GetRefundabilityStatusRequest as GetRefundabilityStatusRequestOriginal, type GetRefundabilityStatusResponse as GetRefundabilityStatusResponseOriginal, type GetShipmentsRequest as GetShipmentsRequestOriginal, type GetShipmentsResponse as GetShipmentsResponseOriginal, type GiftCardPaymentDetails as GiftCardPaymentDetailsOriginal, type GiftCardPaymentRefund as GiftCardPaymentRefundOriginal, type HasCustomEmailConfigurationsRequest as HasCustomEmailConfigurationsRequestOriginal, type HasCustomEmailConfigurationsResponse as HasCustomEmailConfigurationsResponseOriginal, type IdAndVersion as IdAndVersionOriginal, type IdentificationDataIdOneOf as IdentificationDataIdOneOfOriginal, type IdentificationData as IdentificationDataOriginal, type Image as ImageOriginal, type ImportOrderApplicationErrors as ImportOrderApplicationErrorsOriginal, type ImportOrderRequest as ImportOrderRequestOriginal, type ImportOrderResponse as ImportOrderResponseOriginal, type ImportedOrderDeleted as ImportedOrderDeletedOriginal, type InternalActivityContentOneOf as InternalActivityContentOneOfOriginal, type InternalActivity as InternalActivityOriginal, type InternalDocument as InternalDocumentOriginal, type InternalDocumentUpdateByFilterOperation as InternalDocumentUpdateByFilterOperationOriginal, type InternalDocumentUpdateOperation as InternalDocumentUpdateOperationOriginal, type InternalQueryOrdersRequest as InternalQueryOrdersRequestOriginal, type InternalQueryOrdersResponse as InternalQueryOrdersResponseOriginal, type InternalUpdateExistingOperation as InternalUpdateExistingOperationOriginal, InventoryAction as InventoryActionOriginal, type InventoryActionWithLiterals as InventoryActionWithLiteralsOriginal, type InventoryUpdateDetails as InventoryUpdateDetailsOriginal, type InvoiceAdded as InvoiceAddedOriginal, type InvoiceDates as InvoiceDatesOriginal, type InvoiceDynamicPriceTotals as InvoiceDynamicPriceTotalsOriginal, type InvoiceFields as InvoiceFieldsOriginal, type InvoiceSentEvent as InvoiceSentEventOriginal, type InvoiceSent as InvoiceSentOriginal, InvoiceStatus as InvoiceStatusOriginal, type InvoiceStatusWithLiterals as InvoiceStatusWithLiteralsOriginal, type InvoicesPayment as InvoicesPaymentOriginal, type IsInAutomationMigrationPopulationRequest as IsInAutomationMigrationPopulationRequestOriginal, type IsInAutomationMigrationPopulationResponse as IsInAutomationMigrationPopulationResponseOriginal, type ItemChangedDetails as ItemChangedDetailsOriginal, type ItemCombinationLineItem as ItemCombinationLineItemOriginal, type ItemCombination as ItemCombinationOriginal, type ItemMetadata as ItemMetadataOriginal, type ItemModifier as ItemModifierOriginal, type ItemTaxFullDetails as ItemTaxFullDetailsOriginal, type ItemTypeItemTypeDataOneOf as ItemTypeItemTypeDataOneOfOriginal, type ItemType as ItemTypeOriginal, ItemTypePreset as ItemTypePresetOriginal, type ItemTypePresetWithLiterals as ItemTypePresetWithLiteralsOriginal, type ItemizedFee as ItemizedFeeOriginal, JurisdictionType as JurisdictionTypeOriginal, type JurisdictionTypeWithLiterals as JurisdictionTypeWithLiteralsOriginal, type LineItemAmount as LineItemAmountOriginal, type LineItemChanges as LineItemChangesOriginal, type LineItemDeltaDeltaOneOf as LineItemDeltaDeltaOneOfOriginal, type LineItemDelta as LineItemDeltaOriginal, type LineItemDescriptionLineChange as LineItemDescriptionLineChangeOriginal, type LineItemDiscount as LineItemDiscountOriginal, type LineItemExchangeData as LineItemExchangeDataOriginal, type LineItemMetaData as LineItemMetaDataOriginal, type LineItemModifiersChange as LineItemModifiersChangeOriginal, type LineItem as LineItemOriginal, type LineItemPriceChange as LineItemPriceChangeOriginal, type LineItemProductNameChange as LineItemProductNameChangeOriginal, type LineItemQuantityChange as LineItemQuantityChangeOriginal, LineItemQuantityChangeType as LineItemQuantityChangeTypeOriginal, type LineItemQuantityChangeTypeWithLiterals as LineItemQuantityChangeTypeWithLiteralsOriginal, type LineItemRefund as LineItemRefundOriginal, type LineItemRefundSummary as LineItemRefundSummaryOriginal, type LineItemTaxBreakdown as LineItemTaxBreakdownOriginal, type LineItemTaxInfo as LineItemTaxInfoOriginal, type LineItemTax as LineItemTaxOriginal, type LineItemUpdate as LineItemUpdateOriginal, type LineItems as LineItemsOriginal, type Locale as LocaleOriginal, type LocationAndQuantity as LocationAndQuantityOriginal, type Location as LocationOriginal, type ManagedAdditionalFee as ManagedAdditionalFeeOriginal, type ManagedDiscount as ManagedDiscountOriginal, type ManagedLineItem as ManagedLineItemOriginal, ManuallyRefundableReason as ManuallyRefundableReasonOriginal, type ManuallyRefundableReasonWithLiterals as ManuallyRefundableReasonWithLiteralsOriginal, type MarkAsFulfilledRequest as MarkAsFulfilledRequestOriginal, type MarkAsFulfilledResponse as MarkAsFulfilledResponseOriginal, type MarkAsUnfulfilledRequest as MarkAsUnfulfilledRequestOriginal, type MarkAsUnfulfilledResponse as MarkAsUnfulfilledResponseOriginal, type MarkOrderAsPaidRequest as MarkOrderAsPaidRequestOriginal, type MarkOrderAsPaidResponse as MarkOrderAsPaidResponseOriginal, type MarkOrderAsSeenByHumanRequest as MarkOrderAsSeenByHumanRequestOriginal, type MarkOrderAsSeenByHumanResponse as MarkOrderAsSeenByHumanResponseOriginal, type MaskedOrderLineItem as MaskedOrderLineItemOriginal, type MaskedOrder as MaskedOrderOriginal, type MembershipChargeItem as MembershipChargeItemOriginal, type MembershipName as MembershipNameOriginal, type MembershipPaymentDetails as MembershipPaymentDetailsOriginal, type MembershipPaymentRefund as MembershipPaymentRefundOriginal, MembershipPaymentStatus as MembershipPaymentStatusOriginal, type MembershipPaymentStatusWithLiterals as MembershipPaymentStatusWithLiteralsOriginal, type MerchantComment as MerchantCommentOriginal, type MerchantDiscountMerchantDiscountReasonOneOf as MerchantDiscountMerchantDiscountReasonOneOfOriginal, type MerchantDiscount as MerchantDiscountOriginal, type MessageEnvelope as MessageEnvelopeOriginal, type MetaData as MetaDataOriginal, type MetaSiteSpecialEvent as MetaSiteSpecialEventOriginal, type MetaSiteSpecialEventPayloadOneOf as MetaSiteSpecialEventPayloadOneOfOriginal, type ModifierGroup as ModifierGroupOriginal, type NamespaceChanged as NamespaceChangedOriginal, Namespace as NamespaceOriginal, type NamespaceWithLiterals as NamespaceWithLiteralsOriginal, type NewExchangeOrderCreated as NewExchangeOrderCreatedOriginal, NonRefundableReason as NonRefundableReasonOriginal, type NonRefundableReasonWithLiterals as NonRefundableReasonWithLiteralsOriginal, type OdeditorAssigned as OdeditorAssignedOriginal, type OdeditorUnassigned as OdeditorUnassignedOriginal, OrderActionType as OrderActionTypeOriginal, type OrderActionTypeWithLiterals as OrderActionTypeWithLiteralsOriginal, OrderActivityTypeEnumActivityType as OrderActivityTypeEnumActivityTypeOriginal, type OrderActivityTypeEnumActivityTypeWithLiterals as OrderActivityTypeEnumActivityTypeWithLiteralsOriginal, OrderApprovalStrategy as OrderApprovalStrategyOriginal, type OrderApprovalStrategyWithLiterals as OrderApprovalStrategyWithLiteralsOriginal, type OrderApproved as OrderApprovedOriginal, type OrderCanceledEventOrderCanceled as OrderCanceledEventOrderCanceledOriginal, type OrderCanceled as OrderCanceledOriginal, type OrderChange as OrderChangeOriginal, type OrderChangeValueOneOf as OrderChangeValueOneOfOriginal, type OrderCreateNotifications as OrderCreateNotificationsOriginal, type OrderCreatedFromExchange as OrderCreatedFromExchangeOriginal, type OrderCreationSettingsEditableByOneOf as OrderCreationSettingsEditableByOneOfOriginal, type OrderCreationSettings as OrderCreationSettingsOriginal, type OrderDeltasCommitted as OrderDeltasCommittedOriginal, type OrderFulfilled as OrderFulfilledOriginal, type OrderImported as OrderImportedOriginal, type OrderItemsRestocked as OrderItemsRestockedOriginal, type OrderLineItemChangedDetails as OrderLineItemChangedDetailsOriginal, type OrderLineItem as OrderLineItemOriginal, type OrderNotFulfilled as OrderNotFulfilledOriginal, type Order as OrderOriginal, type OrderPaid as OrderPaidOriginal, type OrderPartiallyPaid as OrderPartiallyPaidOriginal, type OrderPending as OrderPendingOriginal, type OrderPlaced as OrderPlacedOriginal, type OrderRefunded as OrderRefundedOriginal, type OrderRejectedEventOrderRejected as OrderRejectedEventOrderRejectedOriginal, type OrderRejected as OrderRejectedOriginal, type OrderSettingsAllowedActionsOneOf as OrderSettingsAllowedActionsOneOfOriginal, type OrderSettingsEditableByOneOf as OrderSettingsEditableByOneOfOriginal, type OrderSettings as OrderSettingsOriginal, OrderStatus as OrderStatusOriginal, type OrderStatusWithLiterals as OrderStatusWithLiteralsOriginal, type OrderTaxBreakdown as OrderTaxBreakdownOriginal, type OrderTaxInfo as OrderTaxInfoOriginal, type OrderTransactions as OrderTransactionsOriginal, type OrdersExperiments as OrdersExperimentsOriginal, Origin as OriginOriginal, type OriginWithLiterals as OriginWithLiteralsOriginal, type OwnerApps as OwnerAppsOriginal, type PaymentCanceled as PaymentCanceledOriginal, type PaymentCanceledPaymentDetailsOneOf as PaymentCanceledPaymentDetailsOneOfOriginal, type PaymentCapture as PaymentCaptureOriginal, PaymentCollectabilityStatus as PaymentCollectabilityStatusOriginal, type PaymentCollectabilityStatusWithLiterals as PaymentCollectabilityStatusWithLiteralsOriginal, type PaymentCollectionCreatePaymentGatewayOrderApplicationErrors as PaymentCollectionCreatePaymentGatewayOrderApplicationErrorsOriginal, type PaymentCollectionMarkOrderAsPaidApplicationErrors as PaymentCollectionMarkOrderAsPaidApplicationErrorsOriginal, type PaymentDeclined as PaymentDeclinedOriginal, type PaymentDeclinedPaymentDetailsOneOf as PaymentDeclinedPaymentDetailsOneOfOriginal, type PaymentMethodName as PaymentMethodNameOriginal, PaymentOptionType as PaymentOptionTypeOriginal, type PaymentOptionTypeWithLiterals as PaymentOptionTypeWithLiteralsOriginal, type Payment as PaymentOriginal, type PaymentPaymentDetailsOneOf as PaymentPaymentDetailsOneOfOriginal, type PaymentPending as PaymentPendingOriginal, type PaymentPendingPaymentDetailsOneOf as PaymentPendingPaymentDetailsOneOfOriginal, type PaymentReceiptInfoOneOf as PaymentReceiptInfoOneOfOriginal, type PaymentRefundFailed as PaymentRefundFailedOriginal, type PaymentRefund as PaymentRefundOriginal, type PaymentRefunded as PaymentRefundedOriginal, PaymentStatusEnumPaymentStatus as PaymentStatusEnumPaymentStatusOriginal, type PaymentStatusEnumPaymentStatusWithLiterals as PaymentStatusEnumPaymentStatusWithLiteralsOriginal, PaymentStatus as PaymentStatusOriginal, type PaymentStatusUpdated as PaymentStatusUpdatedOriginal, type PaymentStatusWithLiterals as PaymentStatusWithLiteralsOriginal, type Payments as PaymentsOriginal, type Phone as PhoneOriginal, type PhysicalProperties as PhysicalPropertiesOriginal, type PicassoAssigned as PicassoAssignedOriginal, type PicassoUnassigned as PicassoUnassignedOriginal, type PickupAddress as PickupAddressOriginal, type PickupDetails as PickupDetailsOriginal, PickupMethod as PickupMethodOriginal, type PickupMethodWithLiterals as PickupMethodWithLiteralsOriginal, type PickupReadyEmailSent as PickupReadyEmailSentOriginal, Placement as PlacementOriginal, type PlacementWithLiterals as PlacementWithLiteralsOriginal, type PlainTextValue as PlainTextValueOriginal, type PlatformFee as PlatformFeeOriginal, type PlatformFeeSummary as PlatformFeeSummaryOriginal, type PlatformPagingMetadata as PlatformPagingMetadataOriginal, type PlatformPaging as PlatformPagingOriginal, type PlatformQuery as PlatformQueryOriginal, type PlatformQueryPagingMethodOneOf as PlatformQueryPagingMethodOneOfOriginal, PredefinedPaymentMethod as PredefinedPaymentMethodOriginal, type PredefinedPaymentMethodWithLiterals as PredefinedPaymentMethodWithLiteralsOriginal, type PreparePaymentCollectionApplicationErrors as PreparePaymentCollectionApplicationErrorsOriginal, type PreparePaymentCollectionRequest as PreparePaymentCollectionRequestOriginal, type PreparePaymentCollectionResponse as PreparePaymentCollectionResponseOriginal, type PreviewBuyerConfirmationEmailRequest as PreviewBuyerConfirmationEmailRequestOriginal, type PreviewBuyerConfirmationEmailResponse as PreviewBuyerConfirmationEmailResponseOriginal, type PreviewBuyerPaymentsReceivedEmailRequest as PreviewBuyerPaymentsReceivedEmailRequestOriginal, type PreviewBuyerPaymentsReceivedEmailResponse as PreviewBuyerPaymentsReceivedEmailResponseOriginal, type PreviewBuyerPickupConfirmationEmailRequest as PreviewBuyerPickupConfirmationEmailRequestOriginal, type PreviewBuyerPickupConfirmationEmailResponse as PreviewBuyerPickupConfirmationEmailResponseOriginal, type PreviewCancelEmailRequest as PreviewCancelEmailRequestOriginal, type PreviewCancelEmailResponse as PreviewCancelEmailResponseOriginal, type PreviewCancelRefundEmailRequest as PreviewCancelRefundEmailRequestOriginal, type PreviewCancelRefundEmailResponse as PreviewCancelRefundEmailResponseOriginal, type PreviewEmailByTypeRequest as PreviewEmailByTypeRequestOriginal, type PreviewEmailByTypeResponse as PreviewEmailByTypeResponseOriginal, PreviewEmailType as PreviewEmailTypeOriginal, type PreviewEmailTypeWithLiterals as PreviewEmailTypeWithLiteralsOriginal, type PreviewRefundEmailRequest as PreviewRefundEmailRequestOriginal, type PreviewRefundEmailResponse as PreviewRefundEmailResponseOriginal, type PreviewResendDownloadLinksEmailRequest as PreviewResendDownloadLinksEmailRequestOriginal, type PreviewResendDownloadLinksEmailResponse as PreviewResendDownloadLinksEmailResponseOriginal, type PreviewShippingConfirmationEmailRequest as PreviewShippingConfirmationEmailRequestOriginal, type PreviewShippingConfirmationEmailResponse as PreviewShippingConfirmationEmailResponseOriginal, type PriceDescription as PriceDescriptionOriginal, type Price as PriceOriginal, type PriceSummary as PriceSummaryOriginal, type ProductName as ProductNameOriginal, type PublicActivityContentOneOf as PublicActivityContentOneOfOriginal, type PublicActivity as PublicActivityOriginal, type QueryOrderRequest as QueryOrderRequestOriginal, type QueryOrderResponse as QueryOrderResponseOriginal, type QuotesAddress as QuotesAddressOriginal, Reason as ReasonOriginal, type ReasonWithLiterals as ReasonWithLiteralsOriginal, type ReceiptCreated as ReceiptCreatedOriginal, type ReceiptCreatedReceiptInfoOneOf as ReceiptCreatedReceiptInfoOneOfOriginal, type ReceiptSent as ReceiptSentOriginal, type ReceiptSentReceiptInfoOneOf as ReceiptSentReceiptInfoOneOfOriginal, type RecordManuallyCollectedPaymentApplicationErrors as RecordManuallyCollectedPaymentApplicationErrorsOriginal, type RecordManuallyCollectedPaymentRequest as RecordManuallyCollectedPaymentRequestOriginal, type RecordManuallyCollectedPaymentResponse as RecordManuallyCollectedPaymentResponseOriginal, type RedirectUrls as RedirectUrlsOriginal, type RefundDetails as RefundDetailsOriginal, type RefundInitiated as RefundInitiatedOriginal, type RefundItem as RefundItemOriginal, type RefundItemsBreakdown as RefundItemsBreakdownOriginal, type Refund as RefundOriginal, type RefundSideEffects as RefundSideEffectsOriginal, type RefundStatusInfo as RefundStatusInfoOriginal, RefundStatus as RefundStatusOriginal, type RefundStatusWithLiterals as RefundStatusWithLiteralsOriginal, type RefundTransaction as RefundTransactionOriginal, type RefundabilityAdditionalRefundabilityInfoOneOf as RefundabilityAdditionalRefundabilityInfoOneOfOriginal, type Refundability as RefundabilityOriginal, RefundableStatus as RefundableStatusOriginal, type RefundableStatusWithLiterals as RefundableStatusWithLiteralsOriginal, type RefundedAsStoreCredit as RefundedAsStoreCreditOriginal, type RefundedPaymentKindOneOf as RefundedPaymentKindOneOfOriginal, type RefundedPayment as RefundedPaymentOriginal, type RegularPaymentDetails as RegularPaymentDetailsOriginal, type RegularPaymentDetailsPaymentMethodDetailsOneOf as RegularPaymentDetailsPaymentMethodDetailsOneOfOriginal, type RegularPayment as RegularPaymentOriginal, type RegularPaymentPaymentMethodDetailsOneOf as RegularPaymentPaymentMethodDetailsOneOfOriginal, type RegularPaymentRefund as RegularPaymentRefundOriginal, type Reschedule as RescheduleOriginal, type RestockInfo as RestockInfoOriginal, type RestockItem as RestockItemOriginal, type RestockLocation as RestockLocationOriginal, RestockType as RestockTypeOriginal, type RestockTypeWithLiterals as RestockTypeWithLiteralsOriginal, type RestoreInfo as RestoreInfoOriginal, type SavedPaymentMethod as SavedPaymentMethodOriginal, ScheduledAction as ScheduledActionOriginal, type ScheduledActionWithLiterals as ScheduledActionWithLiteralsOriginal, type SearchOrdersRequest as SearchOrdersRequestOriginal, type SearchOrdersResponse as SearchOrdersResponseOriginal, type SendBuyerConfirmationEmailRequest as SendBuyerConfirmationEmailRequestOriginal, type SendBuyerConfirmationEmailResponse as SendBuyerConfirmationEmailResponseOriginal, type SendBuyerPaymentsReceivedEmailRequest as SendBuyerPaymentsReceivedEmailRequestOriginal, type SendBuyerPaymentsReceivedEmailResponse as SendBuyerPaymentsReceivedEmailResponseOriginal, type SendBuyerPickupConfirmationEmailRequest as SendBuyerPickupConfirmationEmailRequestOriginal, type SendBuyerPickupConfirmationEmailResponse as SendBuyerPickupConfirmationEmailResponseOriginal, type SendBuyerShippingConfirmationEmailRequest as SendBuyerShippingConfirmationEmailRequestOriginal, type SendBuyerShippingConfirmationEmailResponse as SendBuyerShippingConfirmationEmailResponseOriginal, type SendCancelRefundEmailRequest as SendCancelRefundEmailRequestOriginal, type SendCancelRefundEmailResponse as SendCancelRefundEmailResponseOriginal, type SendFulfillmentEmailRequest as SendFulfillmentEmailRequestOriginal, type SendFulfillmentEmailResponse as SendFulfillmentEmailResponseOriginal, type SendMerchantOrderReceivedNotificationRequest as SendMerchantOrderReceivedNotificationRequestOriginal, type SendMerchantOrderReceivedNotificationResponse as SendMerchantOrderReceivedNotificationResponseOriginal, type SendMerchantOrderReceivedPushRequest as SendMerchantOrderReceivedPushRequestOriginal, type SendMerchantOrderReceivedPushResponse as SendMerchantOrderReceivedPushResponseOriginal, type SendOrderUpdatedDomainEventRequest as SendOrderUpdatedDomainEventRequestOriginal, type SendOrderUpdatedDomainEventResponse as SendOrderUpdatedDomainEventResponseOriginal, type SendRefundEmailRequest as SendRefundEmailRequestOriginal, type SendRefundEmailResponse as SendRefundEmailResponseOriginal, type ServiceProperties as ServicePropertiesOriginal, type ServiceProvisioned as ServiceProvisionedOriginal, type ServiceRemoved as ServiceRemovedOriginal, type SetOrderNumberCounterRequest as SetOrderNumberCounterRequestOriginal, type SetOrderNumberCounterResponse as SetOrderNumberCounterResponseOriginal, type ShippingAddressEdited as ShippingAddressEditedOriginal, type ShippingConfirmationEmailSent as ShippingConfirmationEmailSentOriginal, type ShippingInformationChange as ShippingInformationChangeOriginal, type ShippingInformation as ShippingInformationOriginal, type ShippingPrice as ShippingPriceOriginal, type ShippingRefund as ShippingRefundOriginal, type ShippingRegion as ShippingRegionOriginal, SiteCreatedContext as SiteCreatedContextOriginal, type SiteCreatedContextWithLiterals as SiteCreatedContextWithLiteralsOriginal, type SiteCreated as SiteCreatedOriginal, type SiteDeleted as SiteDeletedOriginal, type SiteHardDeleted as SiteHardDeletedOriginal, type SiteMarkedAsTemplate as SiteMarkedAsTemplateOriginal, type SiteMarkedAsWixSite as SiteMarkedAsWixSiteOriginal, type SitePublished as SitePublishedOriginal, type SitePurgedExternally as SitePurgedExternallyOriginal, type SiteRenamed as SiteRenamedOriginal, type SiteTransferred as SiteTransferredOriginal, type SiteUndeleted as SiteUndeletedOriginal, type SiteUnpublished as SiteUnpublishedOriginal, type SiteUrlChanged as SiteUrlChangedOriginal, SortOrder as SortOrderOriginal, type SortOrderWithLiterals as SortOrderWithLiteralsOriginal, type Sorting as SortingOriginal, type Source as SourceOriginal, SourceType as SourceTypeOriginal, type SourceTypeWithLiterals as SourceTypeWithLiteralsOriginal, SpecificItemsCouponBehavior as SpecificItemsCouponBehaviorOriginal, type SpecificItemsCouponBehaviorWithLiterals as SpecificItemsCouponBehaviorWithLiteralsOriginal, type StandardDetails as StandardDetailsOriginal, State as StateOriginal, type StateWithLiterals as StateWithLiteralsOriginal, type StreetAddress as StreetAddressOriginal, type StudioAssigned as StudioAssignedOriginal, type StudioTwoAssigned as StudioTwoAssignedOriginal, type StudioTwoUnassigned as StudioTwoUnassignedOriginal, type StudioUnassigned as StudioUnassignedOriginal, type Subdivision as SubdivisionOriginal, SubdivisionType as SubdivisionTypeOriginal, type SubdivisionTypeWithLiterals as SubdivisionTypeWithLiteralsOriginal, type SubscriptionDescription as SubscriptionDescriptionOriginal, SubscriptionFrequency as SubscriptionFrequencyOriginal, type SubscriptionFrequencyWithLiterals as SubscriptionFrequencyWithLiteralsOriginal, type SubscriptionInfo as SubscriptionInfoOriginal, type SubscriptionSettings as SubscriptionSettingsOriginal, type SubscriptionTitle as SubscriptionTitleOriginal, type TagList as TagListOriginal, type Tags as TagsOriginal, type TagsTagList as TagsTagListOriginal, type TagsTags as TagsTagsOriginal, type TaskActionActionOneOf as TaskActionActionOneOfOriginal, type TaskAction as TaskActionOriginal, type TaskKey as TaskKeyOriginal, type Task as TaskOriginal, type TaxSummary as TaxSummaryOriginal, type TaxableAddress as TaxableAddressOriginal, type TaxableAddressTaxableAddressDataOneOf as TaxableAddressTaxableAddressDataOneOfOriginal, TaxableAddressType as TaxableAddressTypeOriginal, type TaxableAddressTypeWithLiterals as TaxableAddressTypeWithLiteralsOriginal, type TotalPriceChange as TotalPriceChangeOriginal, type TotalPrice as TotalPriceOriginal, type TrackingLinkAdded as TrackingLinkAddedOriginal, type TrackingNumberAdded as TrackingNumberAddedOriginal, type TrackingNumberEdited as TrackingNumberEditedOriginal, TransactionStatus as TransactionStatusOriginal, type TransactionStatusWithLiterals as TransactionStatusWithLiteralsOriginal, type TranslatableString as TranslatableStringOriginal, type TranslatedValue as TranslatedValueOriginal, type TriggerRefundApplicationErrors as TriggerRefundApplicationErrorsOriginal, type TriggerRefundRequest as TriggerRefundRequestOriginal, type TriggerRefundResponse as TriggerRefundResponseOriginal, type TriggerReindexOrderRequest as TriggerReindexOrderRequestOriginal, type TriggerReindexRequest as TriggerReindexRequestOriginal, type TriggerReindexResponse as TriggerReindexResponseOriginal, type UnArchiveOrderRequest as UnArchiveOrderRequestOriginal, type UnArchiveOrderResponse as UnArchiveOrderResponseOriginal, type UpdateActivityRequest as UpdateActivityRequestOriginal, type UpdateActivityResponse as UpdateActivityResponseOriginal, type UpdateBillingContactDetailsRequest as UpdateBillingContactDetailsRequestOriginal, type UpdateBillingContactDetailsResponse as UpdateBillingContactDetailsResponseOriginal, type UpdateBuyerEmailRequest as UpdateBuyerEmailRequestOriginal, type UpdateBuyerEmailResponse as UpdateBuyerEmailResponseOriginal, type UpdateBuyerInfoRequest as UpdateBuyerInfoRequestOriginal, type UpdateBuyerInfoResponse as UpdateBuyerInfoResponseOriginal, type UpdateInternalDocumentsEventOperationOneOf as UpdateInternalDocumentsEventOperationOneOfOriginal, type UpdateInternalDocumentsEvent as UpdateInternalDocumentsEventOriginal, type UpdateLineItemsDescriptionLinesRequest as UpdateLineItemsDescriptionLinesRequestOriginal, type UpdateLineItemsDescriptionLinesResponse as UpdateLineItemsDescriptionLinesResponseOriginal, type UpdateOrderApplicationErrors as UpdateOrderApplicationErrorsOriginal, type UpdateOrderLineItemRequest as UpdateOrderLineItemRequestOriginal, type UpdateOrderLineItemResponse as UpdateOrderLineItemResponseOriginal, type UpdateOrderLineItemsRequest as UpdateOrderLineItemsRequestOriginal, type UpdateOrderLineItemsResponse as UpdateOrderLineItemsResponseOriginal, type UpdateOrderRequest as UpdateOrderRequestOriginal, type UpdateOrderResponse as UpdateOrderResponseOriginal, type UpdateOrderShippingAddressRequest as UpdateOrderShippingAddressRequestOriginal, type UpdateOrderShippingAddressResponse as UpdateOrderShippingAddressResponseOriginal, type UpdateOrderStatusApplicationErrors as UpdateOrderStatusApplicationErrorsOriginal, type UpdateOrderStatusRequest as UpdateOrderStatusRequestOriginal, type UpdateOrderStatusResponse as UpdateOrderStatusResponseOriginal, type UserDefinedPaymentMethodNameKindOneOf as UserDefinedPaymentMethodNameKindOneOfOriginal, type UserDefinedPaymentMethodName as UserDefinedPaymentMethodNameOriginal, type UserDomainMediaDisabled as UserDomainMediaDisabledOriginal, type UserDomainMediaEnabled as UserDomainMediaEnabledOriginal, type V1BulkMarkOrdersAsPaidRequest as V1BulkMarkOrdersAsPaidRequestOriginal, type V1BulkMarkOrdersAsPaidResponse as V1BulkMarkOrdersAsPaidResponseOriginal, type V1CreatePaymentGatewayOrderRequest as V1CreatePaymentGatewayOrderRequestOriginal, type V1CreatePaymentGatewayOrderResponse as V1CreatePaymentGatewayOrderResponseOriginal, type V1LineItemDeltaDeltaOneOf as V1LineItemDeltaDeltaOneOfOriginal, type V1LineItemDelta as V1LineItemDeltaOriginal, type V1MarkOrderAsPaidRequest as V1MarkOrderAsPaidRequestOriginal, type V1MarkOrderAsPaidResponse as V1MarkOrderAsPaidResponseOriginal, type V1RestockItem as V1RestockItemOriginal, type V1ScheduledAction as V1ScheduledActionOriginal, type V1ShippingInformation as V1ShippingInformationOriginal, type V1TriggerReindexOrderRequest as V1TriggerReindexOrderRequestOriginal, type V1TriggerReindexRequest as V1TriggerReindexRequestOriginal, type V1TriggerReindexResponse as V1TriggerReindexResponseOriginal, type Value as ValueOriginal, ValueType as ValueTypeOriginal, type ValueTypeWithLiterals as ValueTypeWithLiteralsOriginal, type VatId as VatIdOriginal, VatType as VatTypeOriginal, type VatTypeWithLiterals as VatTypeWithLiteralsOriginal, type VersionedDeleteByIdsOperation as VersionedDeleteByIdsOperationOriginal, type VersionedDocumentId as VersionedDocumentIdOriginal, type VersionedDocumentUpdateOperation as VersionedDocumentUpdateOperationOriginal, VersioningMode as VersioningModeOriginal, type VersioningModeWithLiterals as VersioningModeWithLiteralsOriginal, type VoidAuthorizedPaymentsApplicationErrors as VoidAuthorizedPaymentsApplicationErrorsOriginal, type VoidAuthorizedPaymentsRequest as VoidAuthorizedPaymentsRequestOriginal, type VoidAuthorizedPaymentsResponse as VoidAuthorizedPaymentsResponseOriginal, WebhookIdentityType as WebhookIdentityTypeOriginal, type WebhookIdentityTypeWithLiterals as WebhookIdentityTypeWithLiteralsOriginal, WeightUnit as WeightUnitOriginal, type WeightUnitWithLiterals as WeightUnitWithLiteralsOriginal, type WixReceiptInfo as WixReceiptInfoOriginal, type WixReceipt as WixReceiptOriginal, type WixelAssigned as WixelAssignedOriginal, type WixelUnassigned as WixelUnassignedOriginal, type __PublicMethodMetaInfo, addActivities, addActivity, aggregateOrders, bulkDeleteImportedOrders, bulkUpdateOrderTags, bulkUpdateOrders, cancelOrder, captureAuthorizedPayments, chargeMemberships, createOrder, deleteActivity, getOrder, getPaymentCollectabilityStatus, getRefundabilityStatus, importOrder, paymentCollectionBulkMarkOrdersAsPaid, paymentCollectionCreatePaymentGatewayOrder, paymentCollectionMarkOrderAsPaid, preparePaymentCollection, recordManuallyCollectedPayment, searchOrders, setOrderNumberCounter, triggerRefund, updateActivity, updateOrder, updateOrderLineItem, updateOrderStatus, voidAuthorizedPayments };
|