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