@wix/auto_sdk_ecom_orders 1.0.34 → 1.0.35

This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
Files changed (134) hide show
  1. package/build/cjs/index.d.ts +1 -0
  2. package/build/cjs/index.js +18 -0
  3. package/build/cjs/index.js.map +1 -0
  4. package/build/cjs/index.typings.d.ts +1 -0
  5. package/build/cjs/index.typings.js +18 -0
  6. package/build/cjs/index.typings.js.map +1 -0
  7. package/build/cjs/meta.d.ts +1 -0
  8. package/build/cjs/meta.js +18 -0
  9. package/build/cjs/meta.js.map +1 -0
  10. package/build/cjs/src/ecom-v1-order-orders.context.d.ts +34 -0
  11. package/build/cjs/src/ecom-v1-order-orders.context.js +117 -0
  12. package/build/cjs/src/ecom-v1-order-orders.context.js.map +1 -0
  13. package/build/cjs/src/ecom-v1-order-orders.http.d.ts +200 -0
  14. package/build/cjs/src/ecom-v1-order-orders.http.js +1610 -0
  15. package/build/cjs/src/ecom-v1-order-orders.http.js.map +1 -0
  16. package/build/cjs/src/ecom-v1-order-orders.meta.d.ts +78 -0
  17. package/build/cjs/src/ecom-v1-order-orders.meta.js +503 -0
  18. package/build/cjs/src/ecom-v1-order-orders.meta.js.map +1 -0
  19. package/build/cjs/src/ecom-v1-order-orders.public.d.ts +189 -0
  20. package/build/cjs/src/ecom-v1-order-orders.public.js +382 -0
  21. package/build/cjs/src/ecom-v1-order-orders.public.js.map +1 -0
  22. package/build/{ecom-v1-order-orders.universal-UflOyGzD.d.mts → cjs/src/ecom-v1-order-orders.types.d.ts} +637 -1109
  23. package/build/cjs/src/ecom-v1-order-orders.types.js +652 -0
  24. package/build/cjs/src/ecom-v1-order-orders.types.js.map +1 -0
  25. package/build/{internal/ecom-v1-order-orders.universal-DkzM7BQ-.d.ts → cjs/src/ecom-v1-order-orders.universal.d.ts} +985 -957
  26. package/build/cjs/src/ecom-v1-order-orders.universal.js +2294 -0
  27. package/build/cjs/src/ecom-v1-order-orders.universal.js.map +1 -0
  28. package/build/es/index.d.ts +1 -0
  29. package/build/es/index.js +2 -0
  30. package/build/es/index.js.map +1 -0
  31. package/build/es/index.typings.d.ts +1 -0
  32. package/build/es/index.typings.js +2 -0
  33. package/build/es/index.typings.js.map +1 -0
  34. package/build/es/meta.d.ts +1 -0
  35. package/build/es/meta.js +2 -0
  36. package/build/es/meta.js.map +1 -0
  37. package/build/es/package.json +3 -0
  38. package/build/es/src/ecom-v1-order-orders.context.d.ts +34 -0
  39. package/build/es/src/ecom-v1-order-orders.context.js +62 -0
  40. package/build/es/src/ecom-v1-order-orders.context.js.map +1 -0
  41. package/build/es/src/ecom-v1-order-orders.http.d.ts +200 -0
  42. package/build/es/src/ecom-v1-order-orders.http.js +1582 -0
  43. package/build/es/src/ecom-v1-order-orders.http.js.map +1 -0
  44. package/build/es/src/ecom-v1-order-orders.meta.d.ts +78 -0
  45. package/build/es/src/ecom-v1-order-orders.meta.js +452 -0
  46. package/build/es/src/ecom-v1-order-orders.meta.js.map +1 -0
  47. package/build/es/src/ecom-v1-order-orders.public.d.ts +189 -0
  48. package/build/es/src/ecom-v1-order-orders.public.js +302 -0
  49. package/build/es/src/ecom-v1-order-orders.public.js.map +1 -0
  50. package/build/{ecom-v1-order-orders.universal-UflOyGzD.d.ts → es/src/ecom-v1-order-orders.types.d.ts} +637 -1109
  51. package/build/es/src/ecom-v1-order-orders.types.js +648 -0
  52. package/build/es/src/ecom-v1-order-orders.types.js.map +1 -0
  53. package/build/{internal/ecom-v1-order-orders.universal-DkzM7BQ-.d.mts → es/src/ecom-v1-order-orders.universal.d.ts} +985 -957
  54. package/build/es/src/ecom-v1-order-orders.universal.js +2242 -0
  55. package/build/es/src/ecom-v1-order-orders.universal.js.map +1 -0
  56. package/build/internal/cjs/index.d.ts +1 -0
  57. package/build/internal/cjs/index.js +18 -0
  58. package/build/internal/cjs/index.js.map +1 -0
  59. package/build/internal/cjs/index.typings.d.ts +1 -0
  60. package/build/internal/cjs/index.typings.js +18 -0
  61. package/build/internal/cjs/index.typings.js.map +1 -0
  62. package/build/internal/cjs/meta.d.ts +1 -0
  63. package/build/internal/cjs/meta.js +18 -0
  64. package/build/internal/cjs/meta.js.map +1 -0
  65. package/build/internal/cjs/src/ecom-v1-order-orders.context.d.ts +62 -0
  66. package/build/internal/cjs/src/ecom-v1-order-orders.context.js +117 -0
  67. package/build/internal/cjs/src/ecom-v1-order-orders.context.js.map +1 -0
  68. package/build/internal/cjs/src/ecom-v1-order-orders.http.d.ts +200 -0
  69. package/build/internal/cjs/src/ecom-v1-order-orders.http.js +1610 -0
  70. package/build/internal/cjs/src/ecom-v1-order-orders.http.js.map +1 -0
  71. package/build/internal/cjs/src/ecom-v1-order-orders.meta.d.ts +78 -0
  72. package/build/internal/cjs/src/ecom-v1-order-orders.meta.js +503 -0
  73. package/build/internal/cjs/src/ecom-v1-order-orders.meta.js.map +1 -0
  74. package/build/internal/cjs/src/ecom-v1-order-orders.public.d.ts +340 -0
  75. package/build/internal/cjs/src/ecom-v1-order-orders.public.js +382 -0
  76. package/build/internal/cjs/src/ecom-v1-order-orders.public.js.map +1 -0
  77. package/build/internal/cjs/src/ecom-v1-order-orders.types.d.ts +6096 -0
  78. package/build/internal/cjs/src/ecom-v1-order-orders.types.js +652 -0
  79. package/build/internal/cjs/src/ecom-v1-order-orders.types.js.map +1 -0
  80. package/build/internal/cjs/src/ecom-v1-order-orders.universal.d.ts +7750 -0
  81. package/build/internal/cjs/src/ecom-v1-order-orders.universal.js +2294 -0
  82. package/build/internal/cjs/src/ecom-v1-order-orders.universal.js.map +1 -0
  83. package/build/internal/es/index.d.ts +1 -0
  84. package/build/internal/es/index.js +2 -0
  85. package/build/internal/es/index.js.map +1 -0
  86. package/build/internal/es/index.typings.d.ts +1 -0
  87. package/build/internal/es/index.typings.js +2 -0
  88. package/build/internal/es/index.typings.js.map +1 -0
  89. package/build/internal/es/meta.d.ts +1 -0
  90. package/build/internal/es/meta.js +2 -0
  91. package/build/internal/es/meta.js.map +1 -0
  92. package/build/internal/es/src/ecom-v1-order-orders.context.d.ts +62 -0
  93. package/build/internal/es/src/ecom-v1-order-orders.context.js +62 -0
  94. package/build/internal/es/src/ecom-v1-order-orders.context.js.map +1 -0
  95. package/build/internal/es/src/ecom-v1-order-orders.http.d.ts +200 -0
  96. package/build/internal/es/src/ecom-v1-order-orders.http.js +1582 -0
  97. package/build/internal/es/src/ecom-v1-order-orders.http.js.map +1 -0
  98. package/build/internal/es/src/ecom-v1-order-orders.meta.d.ts +78 -0
  99. package/build/internal/es/src/ecom-v1-order-orders.meta.js +452 -0
  100. package/build/internal/es/src/ecom-v1-order-orders.meta.js.map +1 -0
  101. package/build/internal/es/src/ecom-v1-order-orders.public.d.ts +340 -0
  102. package/build/internal/es/src/ecom-v1-order-orders.public.js +302 -0
  103. package/build/internal/es/src/ecom-v1-order-orders.public.js.map +1 -0
  104. package/build/internal/es/src/ecom-v1-order-orders.types.d.ts +6096 -0
  105. package/build/internal/es/src/ecom-v1-order-orders.types.js +648 -0
  106. package/build/internal/es/src/ecom-v1-order-orders.types.js.map +1 -0
  107. package/build/internal/es/src/ecom-v1-order-orders.universal.d.ts +7750 -0
  108. package/build/internal/es/src/ecom-v1-order-orders.universal.js +2242 -0
  109. package/build/internal/es/src/ecom-v1-order-orders.universal.js.map +1 -0
  110. package/package.json +11 -12
  111. package/build/index.d.mts +0 -212
  112. package/build/index.d.ts +0 -212
  113. package/build/index.js +0 -3504
  114. package/build/index.js.map +0 -1
  115. package/build/index.mjs +0 -3401
  116. package/build/index.mjs.map +0 -1
  117. package/build/internal/index.d.mts +0 -391
  118. package/build/internal/index.d.ts +0 -391
  119. package/build/internal/index.js +0 -3504
  120. package/build/internal/index.js.map +0 -1
  121. package/build/internal/index.mjs +0 -3401
  122. package/build/internal/index.mjs.map +0 -1
  123. package/build/internal/meta.d.mts +0 -3192
  124. package/build/internal/meta.d.ts +0 -3192
  125. package/build/internal/meta.js +0 -1941
  126. package/build/internal/meta.js.map +0 -1
  127. package/build/internal/meta.mjs +0 -1890
  128. package/build/internal/meta.mjs.map +0 -1
  129. package/build/meta.d.mts +0 -3192
  130. package/build/meta.d.ts +0 -3192
  131. package/build/meta.js +0 -1941
  132. package/build/meta.js.map +0 -1
  133. package/build/meta.mjs +0 -1890
  134. package/build/meta.mjs.map +0 -1
@@ -1,4 +1,5 @@
1
- interface Order {
1
+ import { NonNullablePaths } from '@wix/sdk-types';
2
+ export interface Order {
2
3
  /**
3
4
  * Order ID.
4
5
  * @format GUID
@@ -165,14 +166,8 @@ interface Order {
165
166
  purchasedDate?: Date | null;
166
167
  /** Order Location */
167
168
  businessLocation?: Location;
168
- /**
169
- * Pay after free trial price summary. Price summary that should be paid for subscriptions after free trial period.
170
- * @internal
171
- * @readonly
172
- */
173
- payAfterFreeTrial?: PriceSummary;
174
169
  }
175
- interface OrderLineItem {
170
+ export interface OrderLineItem {
176
171
  /**
177
172
  * Line item ID.
178
173
  * @immutable
@@ -280,17 +275,6 @@ interface OrderLineItem {
280
275
  * @maxSize 5
281
276
  */
282
277
  locations?: LocationAndQuantity[];
283
- /**
284
- * Address used for tax calculation.
285
- * @internal
286
- */
287
- taxableAddress?: TaxableAddress;
288
- /**
289
- * ID of the app managing the inventory.
290
- * @internal
291
- * @format GUID
292
- */
293
- inventoryAppId?: string | null;
294
278
  /**
295
279
  * Custom extended fields for the line item object.
296
280
  *
@@ -298,7 +282,7 @@ interface OrderLineItem {
298
282
  */
299
283
  extendedFields?: ExtendedFields;
300
284
  }
301
- interface ProductName {
285
+ export interface ProductName {
302
286
  /**
303
287
  * __Required.__ Item name in the site's default language as defined in the [request envelope](https://dev.wix.com/docs/build-apps/develop-your-app/frameworks/self-hosting/supported-extensions/backend-extensions/add-self-hosted-service-plugin-extensions#request-envelope).
304
288
  *
@@ -320,7 +304,7 @@ interface ProductName {
320
304
  translated?: string | null;
321
305
  }
322
306
  /** Used for grouping line items. Sent when an item is added to a cart, checkout, or order. */
323
- interface CatalogReference {
307
+ export interface CatalogReference {
324
308
  /**
325
309
  * ID of the item within the catalog it belongs to.
326
310
  * @minLength 1
@@ -348,7 +332,7 @@ interface CatalogReference {
348
332
  */
349
333
  options?: Record<string, any> | null;
350
334
  }
351
- interface Price {
335
+ export interface Price {
352
336
  /**
353
337
  * Amount.
354
338
  * @decimalValue options { gte:0, lte:1000000000000000 }
@@ -360,7 +344,7 @@ interface Price {
360
344
  */
361
345
  formattedAmount?: string;
362
346
  }
363
- interface DescriptionLine extends DescriptionLineValueOneOf, DescriptionLineDescriptionLineValueOneOf {
347
+ export interface DescriptionLine extends DescriptionLineValueOneOf, DescriptionLineDescriptionLineValueOneOf {
364
348
  /** Description line plain text value. */
365
349
  plainText?: PlainTextValue;
366
350
  /** Description line color value. */
@@ -369,16 +353,16 @@ interface DescriptionLine extends DescriptionLineValueOneOf, DescriptionLineDesc
369
353
  name?: DescriptionLineName;
370
354
  }
371
355
  /** @oneof */
372
- interface DescriptionLineValueOneOf {
356
+ export interface DescriptionLineValueOneOf {
373
357
  /** Description line plain text value. */
374
358
  plainText?: PlainTextValue;
375
359
  /** Description line color value. */
376
360
  colorInfo?: Color;
377
361
  }
378
362
  /** @oneof */
379
- interface DescriptionLineDescriptionLineValueOneOf {
363
+ export interface DescriptionLineDescriptionLineValueOneOf {
380
364
  }
381
- interface DescriptionLineName {
365
+ export interface DescriptionLineName {
382
366
  /**
383
367
  * Description line name in the site's default language as defined in the [request envelope](https://dev.wix.com/docs/build-apps/develop-your-app/frameworks/self-hosting/supported-extensions/backend-extensions/add-self-hosted-service-plugin-extensions#request-envelope).
384
368
  * @maxLength 100
@@ -392,7 +376,7 @@ interface DescriptionLineName {
392
376
  */
393
377
  translated?: string | null;
394
378
  }
395
- interface PlainTextValue {
379
+ export interface PlainTextValue {
396
380
  /**
397
381
  * Description line plain text value in the site's default language as defined in the [request envelope](https://dev.wix.com/docs/build-apps/develop-your-app/frameworks/self-hosting/supported-extensions/backend-extensions/add-self-hosted-service-plugin-extensions#request-envelope).
398
382
  * @maxLength 600
@@ -406,7 +390,7 @@ interface PlainTextValue {
406
390
  */
407
391
  translated?: string | null;
408
392
  }
409
- interface Color {
393
+ export interface Color {
410
394
  /**
411
395
  * Description line color name in the site's default language as defined in the [request envelope](https://dev.wix.com/docs/build-apps/develop-your-app/frameworks/self-hosting/supported-extensions/backend-extensions/add-self-hosted-service-plugin-extensions#request-envelope).
412
396
  * @maxLength 500
@@ -422,7 +406,7 @@ interface Color {
422
406
  /** HEX or RGB color code for display. */
423
407
  code?: string | null;
424
408
  }
425
- declare enum DescriptionLineType {
409
+ export declare enum DescriptionLineType {
426
410
  /** Unrecognized type. */
427
411
  UNRECOGNISED = "UNRECOGNISED",
428
412
  /** Plain text type. */
@@ -430,7 +414,7 @@ declare enum DescriptionLineType {
430
414
  /** Color type. */
431
415
  COLOR = "COLOR"
432
416
  }
433
- interface FocalPoint {
417
+ export interface FocalPoint {
434
418
  /** X-coordinate of the focal point. */
435
419
  x?: number;
436
420
  /** Y-coordinate of the focal point. */
@@ -440,7 +424,7 @@ interface FocalPoint {
440
424
  /** crop by width */
441
425
  width?: number | null;
442
426
  }
443
- interface PhysicalProperties {
427
+ export interface PhysicalProperties {
444
428
  /** Line item weight. Measurement unit matches the weight unit specified in `weightUnit` in the request. */
445
429
  weight?: number | null;
446
430
  /**
@@ -451,20 +435,20 @@ interface PhysicalProperties {
451
435
  /** Whether this line item is shippable. */
452
436
  shippable?: boolean;
453
437
  }
454
- interface ItemType extends ItemTypeItemTypeDataOneOf {
438
+ export interface ItemType extends ItemTypeItemTypeDataOneOf {
455
439
  /** Preset item type. */
456
440
  preset?: ItemTypeItemType;
457
441
  /** Custom item type. When none of the preset types are suitable, specifies the custom type. */
458
442
  custom?: string;
459
443
  }
460
444
  /** @oneof */
461
- interface ItemTypeItemTypeDataOneOf {
445
+ export interface ItemTypeItemTypeDataOneOf {
462
446
  /** Preset item type. */
463
447
  preset?: ItemTypeItemType;
464
448
  /** Custom item type. When none of the preset types are suitable, specifies the custom type. */
465
449
  custom?: string;
466
450
  }
467
- declare enum ItemTypeItemType {
451
+ export declare enum ItemTypeItemType {
468
452
  UNRECOGNISED = "UNRECOGNISED",
469
453
  PHYSICAL = "PHYSICAL",
470
454
  DIGITAL = "DIGITAL",
@@ -472,7 +456,7 @@ declare enum ItemTypeItemType {
472
456
  SERVICE = "SERVICE"
473
457
  }
474
458
  /** Type of selected payment option for catalog item */
475
- declare enum PaymentOptionType {
459
+ export declare enum PaymentOptionType {
476
460
  /** The entire payment for this item happens as part of the checkout. */
477
461
  FULL_PAYMENT_ONLINE = "FULL_PAYMENT_ONLINE",
478
462
  /** The entire payment for this item happens after checkout. For example, when using cash, check, or other offline payment methods. */
@@ -484,7 +468,7 @@ declare enum PaymentOptionType {
484
468
  /** Payment for this item can only be done by charging a membership and must be manually redeemed in the dashboard by the site admin. When selected, `price` is `0`. */
485
469
  MEMBERSHIP_OFFLINE = "MEMBERSHIP_OFFLINE"
486
470
  }
487
- interface ItemTaxFullDetails {
471
+ export interface ItemTaxFullDetails {
488
472
  /** Taxable amount of this line item. */
489
473
  taxableAmount?: Price;
490
474
  /**
@@ -495,7 +479,7 @@ interface ItemTaxFullDetails {
495
479
  /** The calculated tax, based on the `taxableAmount` and `taxRate`. */
496
480
  totalTax?: Price;
497
481
  }
498
- interface LineItemTaxInfo {
482
+ export interface LineItemTaxInfo {
499
483
  /** Calculated tax, based on `taxable_amount` and `tax_rate`. */
500
484
  taxAmount?: Price;
501
485
  /** Amount for which tax is calculated. */
@@ -523,7 +507,7 @@ interface LineItemTaxInfo {
523
507
  * TaxBreakdown represents tax information for a line item.
524
508
  * It holds the tax amount and the tax rate for each tax authority that apply on the line item.
525
509
  */
526
- interface LineItemTaxBreakdown {
510
+ export interface LineItemTaxBreakdown {
527
511
  /**
528
512
  * Jurisdiction that taxes were calculated for. For example, "New York", or "Quebec".
529
513
  * @maxLength 200
@@ -556,7 +540,7 @@ interface LineItemTaxBreakdown {
556
540
  taxableAmount?: Price;
557
541
  }
558
542
  /** JurisdictionType represents the type of the jurisdiction in which this tax detail applies (e.g. Country,State,County,City,Special). */
559
- declare enum JurisdictionType {
543
+ export declare enum JurisdictionType {
560
544
  UNDEFINED = "UNDEFINED",
561
545
  COUNTRY = "COUNTRY",
562
546
  STATE = "STATE",
@@ -564,7 +548,7 @@ declare enum JurisdictionType {
564
548
  CITY = "CITY",
565
549
  SPECIAL = "SPECIAL"
566
550
  }
567
- interface DigitalFile {
551
+ export interface DigitalFile {
568
552
  /**
569
553
  * ID of the secure file in media.
570
554
  * @minLength 1
@@ -584,7 +568,7 @@ interface DigitalFile {
584
568
  */
585
569
  expirationDate?: Date | null;
586
570
  }
587
- interface SubscriptionInfo {
571
+ export interface SubscriptionInfo {
588
572
  /**
589
573
  * Subscription ID.
590
574
  * @format GUID
@@ -603,11 +587,6 @@ interface SubscriptionInfo {
603
587
  * @targetRemovalDate 2025-10-01
604
588
  */
605
589
  subscriptionOptionTitle?: string;
606
- /**
607
- * Subscription title. For example, `"Monthly coffee Subscription"`.
608
- * @internal
609
- */
610
- title?: SubscriptionTitle;
611
590
  /**
612
591
  * Subscription option description. For example, `"1kg of selected coffee, once a month"`.
613
592
  * @maxLength 60
@@ -616,29 +595,13 @@ interface SubscriptionInfo {
616
595
  * @targetRemovalDate 2025-10-01
617
596
  */
618
597
  subscriptionOptionDescription?: string | null;
619
- /**
620
- * Subscription description. For example, `"1kg of selected coffee, once a month"`.
621
- * @internal
622
- */
623
- description?: SubscriptionDescription;
624
598
  /**
625
599
  * Subscription detailed information.
626
600
  * @immutable
627
601
  */
628
602
  subscriptionSettings?: SubscriptionSettings;
629
- /**
630
- * Description of the charges that will be applied for subscription.
631
- * @internal
632
- * @maxLength 1000
633
- */
634
- chargesDescription?: string | null;
635
- /**
636
- * Details of the billing adjustment applied to the current subscription cycle due to a shift in the subscription’s billing date.
637
- * @internal
638
- */
639
- billingAdjustment?: BillingAdjustment;
640
603
  }
641
- interface SubscriptionTitle {
604
+ export interface SubscriptionTitle {
642
605
  /**
643
606
  * Subscription option name in the site's default language as defined in the [request envelope](https://dev.wix.com/docs/build-apps/develop-your-app/frameworks/self-hosting/supported-extensions/backend-extensions/add-self-hosted-service-plugin-extensions#request-envelope).
644
607
  * @minLength 1
@@ -654,7 +617,7 @@ interface SubscriptionTitle {
654
617
  */
655
618
  translated?: string | null;
656
619
  }
657
- interface SubscriptionDescription {
620
+ export interface SubscriptionDescription {
658
621
  /**
659
622
  * Subscription option description.
660
623
  * @maxLength 500
@@ -666,7 +629,7 @@ interface SubscriptionDescription {
666
629
  */
667
630
  translated?: string | null;
668
631
  }
669
- interface SubscriptionSettings {
632
+ export interface SubscriptionSettings {
670
633
  /** Frequency of recurring payment. */
671
634
  frequency?: SubscriptionFrequency;
672
635
  /**
@@ -682,31 +645,16 @@ interface SubscriptionSettings {
682
645
  * @min 1
683
646
  */
684
647
  billingCycles?: number | null;
685
- /**
686
- * Whether to allow the customer to cancel the subscription.
687
- * @internal
688
- */
689
- enableCustomerCancellation?: boolean;
690
- /**
691
- * Period until first cycle starts. If None => no free trial
692
- * @internal
693
- */
694
- freeTrialPeriod?: FreeTrialPeriod;
695
- /**
696
- * The date the subscription will start. The subscription will be charged either now or according to freeTrialDays.
697
- * @internal
698
- */
699
- startDate?: Date | null;
700
648
  }
701
649
  /** Frequency unit of recurring payment */
702
- declare enum SubscriptionFrequency {
650
+ export declare enum SubscriptionFrequency {
703
651
  UNDEFINED = "UNDEFINED",
704
652
  DAY = "DAY",
705
653
  WEEK = "WEEK",
706
654
  MONTH = "MONTH",
707
655
  YEAR = "YEAR"
708
656
  }
709
- interface FreeTrialPeriod {
657
+ export interface FreeTrialPeriod {
710
658
  /** Frequency of period. Values: DAY, WEEK, MONTH, YEAR */
711
659
  frequency?: SubscriptionFrequency;
712
660
  /**
@@ -716,20 +664,20 @@ interface FreeTrialPeriod {
716
664
  */
717
665
  interval?: number;
718
666
  }
719
- interface BillingAdjustment {
667
+ export interface BillingAdjustment {
720
668
  /** The type of adjustment. */
721
669
  type?: AdjustmentType;
722
670
  /** Summary of the prorated adjustment amount. */
723
671
  priceSummary?: BillingAdjustmentPriceSummary;
724
672
  }
725
- declare enum AdjustmentType {
673
+ export declare enum AdjustmentType {
726
674
  UNKNOWN_ADJUSTMENT_TYPE = "UNKNOWN_ADJUSTMENT_TYPE",
727
675
  /** Adjustment increases the total amount due to changes like covering extra billing days. Typically results in an additional fee. */
728
676
  EXTRA_CHARGE = "EXTRA_CHARGE",
729
677
  /** Adjustment reduces the total amount due to changes like covering fewer billing days. Typically results in a credit or discount. */
730
678
  CREDIT = "CREDIT"
731
679
  }
732
- interface BillingAdjustmentPriceSummary {
680
+ export interface BillingAdjustmentPriceSummary {
733
681
  /** Subtotal of adjustment, before tax. */
734
682
  subtotal?: Price;
735
683
  /** Tax on adjustment. */
@@ -737,7 +685,7 @@ interface BillingAdjustmentPriceSummary {
737
685
  /** Total price after tax. */
738
686
  total?: Price;
739
687
  }
740
- interface PriceDescription {
688
+ export interface PriceDescription {
741
689
  /**
742
690
  * __Required.__ Price description in the site's default language as defined in the [request envelope](https://dev.wix.com/docs/build-apps/develop-your-app/frameworks/self-hosting/supported-extensions/backend-extensions/add-self-hosted-service-plugin-extensions#request-envelope).
743
691
  * @minLength 1
@@ -753,7 +701,7 @@ interface PriceDescription {
753
701
  */
754
702
  translated?: string | null;
755
703
  }
756
- interface LocationAndQuantity {
704
+ export interface LocationAndQuantity {
757
705
  /**
758
706
  * Location id in the associated owner app.
759
707
  * @format GUID
@@ -779,22 +727,22 @@ interface LocationAndQuantity {
779
727
  */
780
728
  name?: string | null;
781
729
  }
782
- interface TaxableAddress extends TaxableAddressTaxableAddressDataOneOf {
730
+ export interface TaxableAddress extends TaxableAddressTaxableAddressDataOneOf {
783
731
  /** taxable address type. if this field is selected, the address is automatically resolved, and the tax is calculated accordingly. */
784
732
  addressType?: TaxableAddressType;
785
733
  }
786
734
  /** @oneof */
787
- interface TaxableAddressTaxableAddressDataOneOf {
735
+ export interface TaxableAddressTaxableAddressDataOneOf {
788
736
  /** taxable address type. if this field is selected, the address is automatically resolved, and the tax is calculated accordingly. */
789
737
  addressType?: TaxableAddressType;
790
738
  }
791
- declare enum TaxableAddressType {
739
+ export declare enum TaxableAddressType {
792
740
  UNKNOWN_TAXABLE_ADDRESS = "UNKNOWN_TAXABLE_ADDRESS",
793
741
  BUSINESS = "BUSINESS",
794
742
  BILLING = "BILLING",
795
743
  SHIPPING = "SHIPPING"
796
744
  }
797
- interface ExtendedFields {
745
+ export interface ExtendedFields {
798
746
  /**
799
747
  * Extended field data. Each key corresponds to the namespace of the app that created the extended fields.
800
748
  * The value of each key is structured according to the schema defined when the extended fields were configured.
@@ -806,7 +754,7 @@ interface ExtendedFields {
806
754
  namespaces?: Record<string, Record<string, any>>;
807
755
  }
808
756
  /** Buyer Info */
809
- interface BuyerInfo extends BuyerInfoIdOneOf {
757
+ export interface BuyerInfo extends BuyerInfoIdOneOf {
810
758
  /**
811
759
  * Visitor ID (if site visitor is not a member).
812
760
  * @format GUID
@@ -829,7 +777,7 @@ interface BuyerInfo extends BuyerInfoIdOneOf {
829
777
  email?: string | null;
830
778
  }
831
779
  /** @oneof */
832
- interface BuyerInfoIdOneOf {
780
+ export interface BuyerInfoIdOneOf {
833
781
  /**
834
782
  * Visitor ID (if site visitor is not a member).
835
783
  * @format GUID
@@ -841,7 +789,7 @@ interface BuyerInfoIdOneOf {
841
789
  */
842
790
  memberId?: string;
843
791
  }
844
- declare enum PaymentStatus {
792
+ export declare enum PaymentStatus {
845
793
  UNSPECIFIED = "UNSPECIFIED",
846
794
  /**
847
795
  * `NOT_PAID` can apply to an order made online, but not yet paid. In such cases `order.status` will be `INITIALIZED`.
@@ -882,7 +830,7 @@ declare enum PaymentStatus {
882
830
  */
883
831
  DECLINED = "DECLINED"
884
832
  }
885
- declare enum FulfillmentStatus {
833
+ export declare enum FulfillmentStatus {
886
834
  /** None of the order items are fulfilled or the order was manually marked as unfulfilled. */
887
835
  NOT_FULFILLED = "NOT_FULFILLED",
888
836
  /**
@@ -893,7 +841,7 @@ declare enum FulfillmentStatus {
893
841
  /** Some, but not all, of the order items are fulfilled. */
894
842
  PARTIALLY_FULFILLED = "PARTIALLY_FULFILLED"
895
843
  }
896
- declare enum WeightUnit {
844
+ export declare enum WeightUnit {
897
845
  /** Weight unit can't be classified due to an error. */
898
846
  UNSPECIFIED_WEIGHT_UNIT = "UNSPECIFIED_WEIGHT_UNIT",
899
847
  /** Kilograms. */
@@ -901,7 +849,7 @@ declare enum WeightUnit {
901
849
  /** Pounds. */
902
850
  LB = "LB"
903
851
  }
904
- interface CurrencyConversionDetails {
852
+ export interface CurrencyConversionDetails {
905
853
  /**
906
854
  * Original currency used to calculate the pricing before conversion to payment currency set on the order [ISO-4217](https://en.wikipedia.org/wiki/ISO_4217#List_of_ISO_4217_currency_codes) format.
907
855
  * @readonly
@@ -917,7 +865,7 @@ interface CurrencyConversionDetails {
917
865
  */
918
866
  conversionRate?: string | null;
919
867
  }
920
- interface PriceSummary {
868
+ export interface PriceSummary {
921
869
  /** Subtotal of all the line items, before discounts and before tax. */
922
870
  subtotal?: Price;
923
871
  /** Total shipping price, before discounts and before tax. */
@@ -932,14 +880,14 @@ interface PriceSummary {
932
880
  totalAdditionalFees?: Price;
933
881
  }
934
882
  /** Billing Info and shipping details */
935
- interface AddressWithContact {
883
+ export interface AddressWithContact {
936
884
  /** Address. */
937
885
  address?: Address;
938
886
  /** Contact details. */
939
887
  contactDetails?: FullAddressContactDetails;
940
888
  }
941
889
  /** Physical address */
942
- interface Address {
890
+ export interface Address {
943
891
  /**
944
892
  * Two-letter country code in [ISO-3166 alpha-2](https://www.iso.org/obp/ui/#search/code/) format.
945
893
  * @format COUNTRY
@@ -983,20 +931,20 @@ interface Address {
983
931
  */
984
932
  subdivisionFullname?: string | null;
985
933
  }
986
- interface StreetAddress {
934
+ export interface StreetAddress {
987
935
  /** Street number. */
988
936
  number?: string;
989
937
  /** Street name. */
990
938
  name?: string;
991
939
  }
992
- interface AddressLocation {
940
+ export interface AddressLocation {
993
941
  /** Address latitude. */
994
942
  latitude?: number | null;
995
943
  /** Address longitude. */
996
944
  longitude?: number | null;
997
945
  }
998
946
  /** Full contact details for an address */
999
- interface FullAddressContactDetails {
947
+ export interface FullAddressContactDetails {
1000
948
  /**
1001
949
  * First name.
1002
950
  * @maxLength 100
@@ -1020,7 +968,7 @@ interface FullAddressContactDetails {
1020
968
  /** Tax information (for Brazil only). If ID is provided, `vatId.type` must also be set, `UNSPECIFIED` is not allowed. */
1021
969
  vatId?: VatId;
1022
970
  }
1023
- interface VatId {
971
+ export interface VatId {
1024
972
  /** Customer's tax ID. */
1025
973
  _id?: string;
1026
974
  /**
@@ -1033,14 +981,14 @@ interface VatId {
1033
981
  type?: VatType;
1034
982
  }
1035
983
  /** tax info types */
1036
- declare enum VatType {
984
+ export declare enum VatType {
1037
985
  UNSPECIFIED = "UNSPECIFIED",
1038
986
  /** CPF - for individual tax payers. */
1039
987
  CPF = "CPF",
1040
988
  /** CNPJ - for corporations */
1041
989
  CNPJ = "CNPJ"
1042
990
  }
1043
- interface V1ShippingInformation {
991
+ export interface V1ShippingInformation {
1044
992
  /**
1045
993
  * App Def Id of external provider which was a source of shipping info
1046
994
  * @minLength 1
@@ -1066,7 +1014,7 @@ interface V1ShippingInformation {
1066
1014
  /** Shipping region. */
1067
1015
  region?: ShippingRegion;
1068
1016
  }
1069
- interface DeliveryLogistics extends DeliveryLogisticsAddressOneOf {
1017
+ export interface DeliveryLogistics extends DeliveryLogisticsAddressOneOf {
1070
1018
  /** Shipping address and contact details. */
1071
1019
  shippingDestination?: AddressWithContact;
1072
1020
  /** Pickup details. */
@@ -1090,20 +1038,20 @@ interface DeliveryLogistics extends DeliveryLogisticsAddressOneOf {
1090
1038
  deliveryTimeSlot?: DeliveryTimeSlot;
1091
1039
  }
1092
1040
  /** @oneof */
1093
- interface DeliveryLogisticsAddressOneOf {
1041
+ export interface DeliveryLogisticsAddressOneOf {
1094
1042
  /** Shipping address and contact details. */
1095
1043
  shippingDestination?: AddressWithContact;
1096
1044
  /** Pickup details. */
1097
1045
  pickupDetails?: PickupDetails;
1098
1046
  }
1099
- interface PickupDetails {
1047
+ export interface PickupDetails {
1100
1048
  /** Pickup address. */
1101
1049
  address?: PickupAddress;
1102
1050
  /** Pickup method */
1103
1051
  pickupMethod?: PickupMethod;
1104
1052
  }
1105
1053
  /** Physical address */
1106
- interface PickupAddress {
1054
+ export interface PickupAddress {
1107
1055
  /**
1108
1056
  * Two-letter country code in [ISO-3166 alpha-2](https://www.iso.org/obp/ui/#search/code/) format.
1109
1057
  * @format COUNTRY
@@ -1147,18 +1095,18 @@ interface PickupAddress {
1147
1095
  */
1148
1096
  subdivisionFullname?: string | null;
1149
1097
  }
1150
- declare enum PickupMethod {
1098
+ export declare enum PickupMethod {
1151
1099
  UNKNOWN_METHOD = "UNKNOWN_METHOD",
1152
1100
  STORE_PICKUP = "STORE_PICKUP",
1153
1101
  PICKUP_POINT = "PICKUP_POINT"
1154
1102
  }
1155
- interface DeliveryTimeSlot {
1103
+ export interface DeliveryTimeSlot {
1156
1104
  /** Delivery slot starting time. */
1157
1105
  from?: Date | null;
1158
1106
  /** Delivery slot ending time. */
1159
1107
  to?: Date | null;
1160
1108
  }
1161
- interface ShippingPrice {
1109
+ export interface ShippingPrice {
1162
1110
  /** Shipping price for display purposes. */
1163
1111
  price?: Price;
1164
1112
  /**
@@ -1179,14 +1127,14 @@ interface ShippingPrice {
1179
1127
  */
1180
1128
  discount?: Price;
1181
1129
  }
1182
- interface ShippingRegion {
1130
+ export interface ShippingRegion {
1183
1131
  /**
1184
1132
  * Name of shipping region. For example, `"Metropolitan London"`, or `"Outer Melbourne suburbs"`.
1185
1133
  * @maxLength 100
1186
1134
  */
1187
1135
  name?: string | null;
1188
1136
  }
1189
- declare enum OrderStatus {
1137
+ export declare enum OrderStatus {
1190
1138
  /** Order created, but not yet approved or canceled. */
1191
1139
  INITIALIZED = "INITIALIZED",
1192
1140
  /**
@@ -1211,14 +1159,14 @@ declare enum OrderStatus {
1211
1159
  */
1212
1160
  REJECTED = "REJECTED"
1213
1161
  }
1214
- interface TaxSummary {
1162
+ export interface TaxSummary {
1215
1163
  /**
1216
1164
  * Total tax.
1217
1165
  * @readonly
1218
1166
  */
1219
1167
  totalTax?: Price;
1220
1168
  }
1221
- interface OrderTaxInfo {
1169
+ export interface OrderTaxInfo {
1222
1170
  /** Calculated tax, added from line items. */
1223
1171
  totalTax?: Price;
1224
1172
  /**
@@ -1238,7 +1186,7 @@ interface OrderTaxInfo {
1238
1186
  * The summary of the tax breakdown for all the line items. It will hold for each tax name, the aggregated tax amount paid for it and the tax rate.
1239
1187
  * Tax breakdown is the tax amount split to the tax authorities that applied on the line item.
1240
1188
  */
1241
- interface OrderTaxBreakdown {
1189
+ export interface OrderTaxBreakdown {
1242
1190
  /**
1243
1191
  * The name of the tax against which this tax amount was calculated.
1244
1192
  * @maxLength 200
@@ -1265,7 +1213,7 @@ interface OrderTaxBreakdown {
1265
1213
  /** The sum of all the tax from line items that calculated by the tax identifiers. */
1266
1214
  aggregatedTaxAmount?: Price;
1267
1215
  }
1268
- interface AppliedDiscount extends AppliedDiscountDiscountSourceOneOf {
1216
+ export interface AppliedDiscount extends AppliedDiscountDiscountSourceOneOf {
1269
1217
  /** Applied coupon info. */
1270
1218
  coupon?: Coupon;
1271
1219
  /** Merchant discount. */
@@ -1296,17 +1244,9 @@ interface AppliedDiscount extends AppliedDiscountDiscountSourceOneOf {
1296
1244
  * @immutable
1297
1245
  */
1298
1246
  _id?: string | null;
1299
- /**
1300
- * Number of subscription billing cycles the discount applies to.
1301
- * If None and discount is linked to subscription line item, it applies to all cycles.
1302
- * @internal
1303
- * @min 1
1304
- * @max 999
1305
- */
1306
- subscriptionCycles?: number | null;
1307
1247
  }
1308
1248
  /** @oneof */
1309
- interface AppliedDiscountDiscountSourceOneOf {
1249
+ export interface AppliedDiscountDiscountSourceOneOf {
1310
1250
  /** Applied coupon info. */
1311
1251
  coupon?: Coupon;
1312
1252
  /** Merchant discount. */
@@ -1314,13 +1254,13 @@ interface AppliedDiscountDiscountSourceOneOf {
1314
1254
  /** Automatic Discount */
1315
1255
  discountRule?: DiscountRule;
1316
1256
  }
1317
- declare enum DiscountType {
1257
+ export declare enum DiscountType {
1318
1258
  GLOBAL = "GLOBAL",
1319
1259
  SPECIFIC_ITEMS = "SPECIFIC_ITEMS",
1320
1260
  SHIPPING = "SHIPPING"
1321
1261
  }
1322
1262
  /** Coupon */
1323
- interface Coupon {
1263
+ export interface Coupon {
1324
1264
  /** Coupon ID. */
1325
1265
  _id?: string;
1326
1266
  /** Coupon code. */
@@ -1330,7 +1270,7 @@ interface Coupon {
1330
1270
  /** Coupon value. */
1331
1271
  amount?: Price;
1332
1272
  }
1333
- interface MerchantDiscount extends MerchantDiscountMerchantDiscountReasonOneOf {
1273
+ export interface MerchantDiscount extends MerchantDiscountMerchantDiscountReasonOneOf {
1334
1274
  /**
1335
1275
  * Pre-defined discount reason (optional).
1336
1276
  * * `"ITEMS_EXCHANGE"` - exchange balance acquired as a result of items exchange.
@@ -1343,16 +1283,9 @@ interface MerchantDiscount extends MerchantDiscountMerchantDiscountReasonOneOf {
1343
1283
  description?: string | null;
1344
1284
  /** Discount amount. */
1345
1285
  amount?: Price;
1346
- /**
1347
- * Discount percentage.
1348
- * @internal
1349
- * @format DECIMAL_VALUE
1350
- * @decimalValue options { gte:0, lte:100, maxScale:2 }
1351
- */
1352
- percentage?: string | null;
1353
1286
  }
1354
1287
  /** @oneof */
1355
- interface MerchantDiscountMerchantDiscountReasonOneOf {
1288
+ export interface MerchantDiscountMerchantDiscountReasonOneOf {
1356
1289
  /**
1357
1290
  * Pre-defined discount reason (optional).
1358
1291
  * * `"ITEMS_EXCHANGE"` - exchange balance acquired as a result of items exchange.
@@ -1364,12 +1297,12 @@ interface MerchantDiscountMerchantDiscountReasonOneOf {
1364
1297
  */
1365
1298
  description?: string | null;
1366
1299
  }
1367
- declare enum DiscountReason {
1300
+ export declare enum DiscountReason {
1368
1301
  UNSPECIFIED = "UNSPECIFIED",
1369
1302
  EXCHANGED_ITEMS = "EXCHANGED_ITEMS",
1370
1303
  BILLING_ADJUSTMENT = "BILLING_ADJUSTMENT"
1371
1304
  }
1372
- interface DiscountRule {
1305
+ export interface DiscountRule {
1373
1306
  /**
1374
1307
  * Discount rule ID
1375
1308
  * @format GUID
@@ -1380,7 +1313,7 @@ interface DiscountRule {
1380
1313
  /** Discount value. */
1381
1314
  amount?: Price;
1382
1315
  }
1383
- interface DiscountRuleName {
1316
+ export interface DiscountRuleName {
1384
1317
  /**
1385
1318
  * Original discount rule name (in site's default language).
1386
1319
  * @minLength 1
@@ -1394,7 +1327,7 @@ interface DiscountRuleName {
1394
1327
  */
1395
1328
  translated?: string | null;
1396
1329
  }
1397
- interface LineItemDiscount {
1330
+ export interface LineItemDiscount {
1398
1331
  /**
1399
1332
  * ID of line item the discount applies to.
1400
1333
  * @format GUID
@@ -1403,67 +1336,13 @@ interface LineItemDiscount {
1403
1336
  /** Total discount for this line item. */
1404
1337
  totalDiscount?: Price;
1405
1338
  }
1406
- interface Activity extends ActivityContentOneOf {
1339
+ export interface Activity extends ActivityContentOneOf {
1407
1340
  /** Custom activity details (optional). `activity.type` must be `CUSTOM_ACTIVITY`. */
1408
1341
  customActivity?: CustomActivity;
1409
1342
  /** Merchant comment details (optional). `activity.type` must be `MERCHANT_COMMENT`. */
1410
1343
  merchantComment?: MerchantComment;
1411
1344
  /** Additional info about order refunded activity (optional). `activity.type` must be `ORDER_REFUNDED`. */
1412
1345
  orderRefunded?: OrderRefunded;
1413
- /**
1414
- * Details of an initiated refund process.
1415
- *
1416
- * > **Note:** A single `refund_initiated` activity can result in multiple `payment_refunded` or `payment_refund_failed` activities.
1417
- * > In these cases, the `refund_id` will be identical across the activities.
1418
- * @internal
1419
- */
1420
- refundInitiated?: RefundInitiated;
1421
- /**
1422
- * Details of a refunded payment.
1423
- *
1424
- * > **Note:** A single `refund_initiated` activity can result in multiple `payment_refunded` or `payment_refund_failed` activities.
1425
- * > In these cases, the `refund_id` will be identical across the activities.
1426
- * @internal
1427
- */
1428
- paymentRefunded?: PaymentRefunded;
1429
- /**
1430
- * Details of a failed payment refund.
1431
- *
1432
- * > **Note:** A single `refund_initiated` activity can result in multiple `payment_refunded` or `payment_refund_failed` activities.
1433
- * > In these cases, the `refund_id` will be identical across the activities.
1434
- * @internal
1435
- */
1436
- paymentRefundFailed?: PaymentRefundFailed;
1437
- /**
1438
- * Details of refund to store credit.
1439
- * @internal
1440
- */
1441
- refundedAsStoreCredit?: RefundedAsStoreCredit;
1442
- /**
1443
- * Details of a pending payment
1444
- * @internal
1445
- */
1446
- paymentPending?: PaymentPending;
1447
- /**
1448
- * Details of a canceled payment
1449
- * @internal
1450
- */
1451
- paymentCanceled?: PaymentCanceled;
1452
- /**
1453
- * Details of a declined payment
1454
- * @internal
1455
- */
1456
- paymentDeclined?: PaymentDeclined;
1457
- /**
1458
- * Receipt was added for associated payment
1459
- * @internal
1460
- */
1461
- receiptCreated?: ReceiptCreated;
1462
- /**
1463
- * Receipt sent to customer
1464
- * @internal
1465
- */
1466
- receiptSent?: ReceiptSent;
1467
1346
  /**
1468
1347
  * Activity ID.
1469
1348
  * @format GUID
@@ -1485,69 +1364,15 @@ interface Activity extends ActivityContentOneOf {
1485
1364
  type?: ActivityType;
1486
1365
  }
1487
1366
  /** @oneof */
1488
- interface ActivityContentOneOf {
1367
+ export interface ActivityContentOneOf {
1489
1368
  /** Custom activity details (optional). `activity.type` must be `CUSTOM_ACTIVITY`. */
1490
1369
  customActivity?: CustomActivity;
1491
1370
  /** Merchant comment details (optional). `activity.type` must be `MERCHANT_COMMENT`. */
1492
1371
  merchantComment?: MerchantComment;
1493
1372
  /** Additional info about order refunded activity (optional). `activity.type` must be `ORDER_REFUNDED`. */
1494
1373
  orderRefunded?: OrderRefunded;
1495
- /**
1496
- * Details of an initiated refund process.
1497
- *
1498
- * > **Note:** A single `refund_initiated` activity can result in multiple `payment_refunded` or `payment_refund_failed` activities.
1499
- * > In these cases, the `refund_id` will be identical across the activities.
1500
- * @internal
1501
- */
1502
- refundInitiated?: RefundInitiated;
1503
- /**
1504
- * Details of a refunded payment.
1505
- *
1506
- * > **Note:** A single `refund_initiated` activity can result in multiple `payment_refunded` or `payment_refund_failed` activities.
1507
- * > In these cases, the `refund_id` will be identical across the activities.
1508
- * @internal
1509
- */
1510
- paymentRefunded?: PaymentRefunded;
1511
- /**
1512
- * Details of a failed payment refund.
1513
- *
1514
- * > **Note:** A single `refund_initiated` activity can result in multiple `payment_refunded` or `payment_refund_failed` activities.
1515
- * > In these cases, the `refund_id` will be identical across the activities.
1516
- * @internal
1517
- */
1518
- paymentRefundFailed?: PaymentRefundFailed;
1519
- /**
1520
- * Details of refund to store credit.
1521
- * @internal
1522
- */
1523
- refundedAsStoreCredit?: RefundedAsStoreCredit;
1524
- /**
1525
- * Details of a pending payment
1526
- * @internal
1527
- */
1528
- paymentPending?: PaymentPending;
1529
- /**
1530
- * Details of a canceled payment
1531
- * @internal
1532
- */
1533
- paymentCanceled?: PaymentCanceled;
1534
- /**
1535
- * Details of a declined payment
1536
- * @internal
1537
- */
1538
- paymentDeclined?: PaymentDeclined;
1539
- /**
1540
- * Receipt was added for associated payment
1541
- * @internal
1542
- */
1543
- receiptCreated?: ReceiptCreated;
1544
- /**
1545
- * Receipt sent to customer
1546
- * @internal
1547
- */
1548
- receiptSent?: ReceiptSent;
1549
1374
  }
1550
- interface CustomActivity {
1375
+ export interface CustomActivity {
1551
1376
  /**
1552
1377
  * ID of the app that created the custom activity.
1553
1378
  * @format GUID
@@ -1562,7 +1387,7 @@ interface CustomActivity {
1562
1387
  additionalData?: Record<string, string>;
1563
1388
  }
1564
1389
  /** Store owner added a comment */
1565
- interface MerchantComment {
1390
+ export interface MerchantComment {
1566
1391
  /**
1567
1392
  * Merchant comment message.
1568
1393
  * @minLength 1
@@ -1570,7 +1395,7 @@ interface MerchantComment {
1570
1395
  */
1571
1396
  message?: string;
1572
1397
  }
1573
- interface OrderRefunded {
1398
+ export interface OrderRefunded {
1574
1399
  /** Whether order was refunded manually. For example, via payment provider or using cash. */
1575
1400
  manual?: boolean;
1576
1401
  /** Refund amount. */
@@ -1581,14 +1406,14 @@ interface OrderRefunded {
1581
1406
  */
1582
1407
  reason?: string;
1583
1408
  }
1584
- interface OrderCreatedFromExchange {
1409
+ export interface OrderCreatedFromExchange {
1585
1410
  /**
1586
1411
  * ID of the original order for which the exchange happened.
1587
1412
  * @format GUID
1588
1413
  */
1589
1414
  originalOrderId?: string;
1590
1415
  }
1591
- interface NewExchangeOrderCreated {
1416
+ export interface NewExchangeOrderCreated {
1592
1417
  /**
1593
1418
  * ID of the new order created as a result of an exchange of items.
1594
1419
  * @format GUID
@@ -1601,7 +1426,7 @@ interface NewExchangeOrderCreated {
1601
1426
  */
1602
1427
  lineItems?: LineItemExchangeData[];
1603
1428
  }
1604
- interface LineItemExchangeData {
1429
+ export interface LineItemExchangeData {
1605
1430
  /**
1606
1431
  * ID of the exchanged line item.
1607
1432
  * @format GUID
@@ -1614,7 +1439,7 @@ interface LineItemExchangeData {
1614
1439
  */
1615
1440
  quantity?: number;
1616
1441
  }
1617
- interface DraftOrderChangesApplied {
1442
+ export interface DraftOrderChangesApplied {
1618
1443
  /** Draft order id. */
1619
1444
  draftOrderId?: string;
1620
1445
  /**
@@ -1625,7 +1450,7 @@ interface DraftOrderChangesApplied {
1625
1450
  /** Changes applied to order. */
1626
1451
  changes?: OrderChange[];
1627
1452
  }
1628
- interface OrderChange extends OrderChangeValueOneOf {
1453
+ export interface OrderChange extends OrderChangeValueOneOf {
1629
1454
  lineItemChanged?: LineItemChanges;
1630
1455
  lineItemAdded?: ManagedLineItem;
1631
1456
  lineItemRemoved?: ManagedLineItem;
@@ -1637,7 +1462,7 @@ interface OrderChange extends OrderChangeValueOneOf {
1637
1462
  shippingInformationChanged?: ShippingInformationChange;
1638
1463
  }
1639
1464
  /** @oneof */
1640
- interface OrderChangeValueOneOf {
1465
+ export interface OrderChangeValueOneOf {
1641
1466
  lineItemChanged?: LineItemChanges;
1642
1467
  lineItemAdded?: ManagedLineItem;
1643
1468
  lineItemRemoved?: ManagedLineItem;
@@ -1648,7 +1473,7 @@ interface OrderChangeValueOneOf {
1648
1473
  totalPriceChanged?: TotalPriceChange;
1649
1474
  shippingInformationChanged?: ShippingInformationChange;
1650
1475
  }
1651
- interface LineItemChanges {
1476
+ export interface LineItemChanges {
1652
1477
  /**
1653
1478
  * Line item ID.
1654
1479
  * @format GUID
@@ -1661,7 +1486,7 @@ interface LineItemChanges {
1661
1486
  /** Item price change. */
1662
1487
  price?: LineItemPriceChange;
1663
1488
  }
1664
- interface LineItemQuantityChange {
1489
+ export interface LineItemQuantityChange {
1665
1490
  /**
1666
1491
  * Item quantity before update.
1667
1492
  * @max 1000000
@@ -1681,19 +1506,19 @@ interface LineItemQuantityChange {
1681
1506
  /** Type of quantity change: increase or decrease. */
1682
1507
  deltaType?: LineItemQuantityChangeType;
1683
1508
  }
1684
- declare enum LineItemQuantityChangeType {
1509
+ export declare enum LineItemQuantityChangeType {
1685
1510
  /** Quantity increased. */
1686
1511
  QUANTITY_INCREASED = "QUANTITY_INCREASED",
1687
1512
  /** Quantity decreased. */
1688
1513
  QUANTITY_DECREASED = "QUANTITY_DECREASED"
1689
1514
  }
1690
- interface LineItemPriceChange {
1515
+ export interface LineItemPriceChange {
1691
1516
  /** Item price before update. */
1692
1517
  originalPrice?: Price;
1693
1518
  /** Item price after update. */
1694
1519
  newPrice?: Price;
1695
1520
  }
1696
- interface ManagedLineItem {
1521
+ export interface ManagedLineItem {
1697
1522
  /**
1698
1523
  * Line item ID.
1699
1524
  * @format GUID
@@ -1708,7 +1533,7 @@ interface ManagedLineItem {
1708
1533
  */
1709
1534
  quantity?: number;
1710
1535
  }
1711
- interface ManagedDiscount {
1536
+ export interface ManagedDiscount {
1712
1537
  /**
1713
1538
  * Discount id.
1714
1539
  * @format GUID
@@ -1721,7 +1546,7 @@ interface ManagedDiscount {
1721
1546
  /** Discount amount. */
1722
1547
  totalAmount?: Price;
1723
1548
  }
1724
- interface TranslatedValue {
1549
+ export interface TranslatedValue {
1725
1550
  /**
1726
1551
  * Value in site default language.
1727
1552
  * @minLength 1
@@ -1733,7 +1558,7 @@ interface TranslatedValue {
1733
1558
  */
1734
1559
  translated?: string | null;
1735
1560
  }
1736
- interface LineItemAmount {
1561
+ export interface LineItemAmount {
1737
1562
  /**
1738
1563
  * Order line item id
1739
1564
  * @format GUID
@@ -1744,7 +1569,7 @@ interface LineItemAmount {
1744
1569
  /** Amount associated with this item. (Discount amount for item / additional fee amount for item) */
1745
1570
  amount?: Price;
1746
1571
  }
1747
- interface ManagedAdditionalFee {
1572
+ export interface ManagedAdditionalFee {
1748
1573
  /**
1749
1574
  * Additional fee id.
1750
1575
  * @format GUID
@@ -1757,19 +1582,19 @@ interface ManagedAdditionalFee {
1757
1582
  /** Additional fee amount. */
1758
1583
  totalAmount?: Price;
1759
1584
  }
1760
- interface TotalPriceChange {
1585
+ export interface TotalPriceChange {
1761
1586
  /** Order’s total price after discounts and tax. Before update */
1762
1587
  originalTotal?: Price;
1763
1588
  /** Order’s total price after discounts and tax. After update */
1764
1589
  newTotal?: Price;
1765
1590
  }
1766
- interface ShippingInformationChange {
1591
+ export interface ShippingInformationChange {
1767
1592
  /** Order’s Shipping Information. Before update */
1768
1593
  originalShippingInfo?: ShippingInformation;
1769
1594
  /** Order’s Shipping Information. After update */
1770
1595
  newShippingInfo?: ShippingInformation;
1771
1596
  }
1772
- interface ShippingInformation {
1597
+ export interface ShippingInformation {
1773
1598
  /** Order’s shipping price. */
1774
1599
  total?: Price;
1775
1600
  /**
@@ -1779,7 +1604,7 @@ interface ShippingInformation {
1779
1604
  shippingTitle?: string;
1780
1605
  }
1781
1606
  /** Payment method is saved for order */
1782
- interface SavedPaymentMethod {
1607
+ export interface SavedPaymentMethod {
1783
1608
  /**
1784
1609
  * Payment method name
1785
1610
  * @minLength 1
@@ -1793,7 +1618,7 @@ interface SavedPaymentMethod {
1793
1618
  */
1794
1619
  description?: string | null;
1795
1620
  }
1796
- interface AuthorizedPaymentCreated {
1621
+ export interface AuthorizedPaymentCreated {
1797
1622
  /**
1798
1623
  * Payment ID of payment associated with this activity
1799
1624
  * @format GUID
@@ -1812,7 +1637,7 @@ interface AuthorizedPaymentCreated {
1812
1637
  */
1813
1638
  brand?: string | null;
1814
1639
  }
1815
- interface AuthorizedPaymentCaptured {
1640
+ export interface AuthorizedPaymentCaptured {
1816
1641
  /**
1817
1642
  * Payment ID of payment associated with this activity
1818
1643
  * @format GUID
@@ -1831,7 +1656,7 @@ interface AuthorizedPaymentCaptured {
1831
1656
  */
1832
1657
  brand?: string | null;
1833
1658
  }
1834
- interface AuthorizedPaymentVoided {
1659
+ export interface AuthorizedPaymentVoided {
1835
1660
  /**
1836
1661
  * Payment ID of payment associated with this activity
1837
1662
  * @format GUID
@@ -1850,7 +1675,7 @@ interface AuthorizedPaymentVoided {
1850
1675
  */
1851
1676
  brand?: string | null;
1852
1677
  }
1853
- interface RefundInitiated {
1678
+ export interface RefundInitiated {
1854
1679
  /**
1855
1680
  * Refund ID.
1856
1681
  * @format GUID
@@ -1870,7 +1695,7 @@ interface RefundInitiated {
1870
1695
  */
1871
1696
  reason?: string | null;
1872
1697
  }
1873
- interface RefundedPayment extends RefundedPaymentKindOneOf {
1698
+ export interface RefundedPayment extends RefundedPaymentKindOneOf {
1874
1699
  /** Regular payment refund. */
1875
1700
  regular?: RegularPaymentRefund;
1876
1701
  /** Gift card payment refund. */
@@ -1886,7 +1711,7 @@ interface RefundedPayment extends RefundedPaymentKindOneOf {
1886
1711
  externalRefund?: boolean;
1887
1712
  }
1888
1713
  /** @oneof */
1889
- interface RefundedPaymentKindOneOf {
1714
+ export interface RefundedPaymentKindOneOf {
1890
1715
  /** Regular payment refund. */
1891
1716
  regular?: RegularPaymentRefund;
1892
1717
  /** Gift card payment refund. */
@@ -1894,7 +1719,7 @@ interface RefundedPaymentKindOneOf {
1894
1719
  /** Membership payment refund. */
1895
1720
  membership?: MembershipPaymentRefund;
1896
1721
  }
1897
- interface RegularPaymentRefund {
1722
+ export interface RegularPaymentRefund {
1898
1723
  /** Refund amount */
1899
1724
  amount?: Price;
1900
1725
  /**
@@ -1908,7 +1733,7 @@ interface RegularPaymentRefund {
1908
1733
  */
1909
1734
  brand?: string | null;
1910
1735
  }
1911
- interface GiftCardPaymentRefund {
1736
+ export interface GiftCardPaymentRefund {
1912
1737
  /**
1913
1738
  * Gift card payment ID
1914
1739
  * @minLength 1
@@ -1918,7 +1743,7 @@ interface GiftCardPaymentRefund {
1918
1743
  /** Refund amount */
1919
1744
  amount?: Price;
1920
1745
  }
1921
- interface MembershipPaymentRefund {
1746
+ export interface MembershipPaymentRefund {
1922
1747
  /**
1923
1748
  * Membership ID
1924
1749
  * @minLength 1
@@ -1926,7 +1751,7 @@ interface MembershipPaymentRefund {
1926
1751
  */
1927
1752
  membershipId?: string | null;
1928
1753
  }
1929
- interface PaymentRefunded {
1754
+ export interface PaymentRefunded {
1930
1755
  /**
1931
1756
  * Refund ID.
1932
1757
  * @format GUID
@@ -1935,7 +1760,7 @@ interface PaymentRefunded {
1935
1760
  /** Details about the refunded payment. */
1936
1761
  payment?: RefundedPayment;
1937
1762
  }
1938
- interface PaymentRefundFailed {
1763
+ export interface PaymentRefundFailed {
1939
1764
  /**
1940
1765
  * Refund ID.
1941
1766
  * @format GUID
@@ -1944,7 +1769,7 @@ interface PaymentRefundFailed {
1944
1769
  /** Details about the failed payment refund. */
1945
1770
  payment?: RefundedPayment;
1946
1771
  }
1947
- interface RefundedAsStoreCredit {
1772
+ export interface RefundedAsStoreCredit {
1948
1773
  /** Refund amount */
1949
1774
  amount?: Price;
1950
1775
  /**
@@ -1953,7 +1778,7 @@ interface RefundedAsStoreCredit {
1953
1778
  */
1954
1779
  reason?: string | null;
1955
1780
  }
1956
- interface PaymentPending extends PaymentPendingPaymentDetailsOneOf {
1781
+ export interface PaymentPending extends PaymentPendingPaymentDetailsOneOf {
1957
1782
  /** Regular payment. */
1958
1783
  regular?: RegularPayment;
1959
1784
  /**
@@ -1963,22 +1788,22 @@ interface PaymentPending extends PaymentPendingPaymentDetailsOneOf {
1963
1788
  paymentId?: string;
1964
1789
  }
1965
1790
  /** @oneof */
1966
- interface PaymentPendingPaymentDetailsOneOf {
1791
+ export interface PaymentPendingPaymentDetailsOneOf {
1967
1792
  /** Regular payment. */
1968
1793
  regular?: RegularPayment;
1969
1794
  }
1970
- interface RegularPayment extends RegularPaymentPaymentMethodDetailsOneOf {
1795
+ export interface RegularPayment extends RegularPaymentPaymentMethodDetailsOneOf {
1971
1796
  /** Whether regular card used */
1972
1797
  creditCardDetails?: CreditCardDetails;
1973
1798
  /** Payment amount */
1974
1799
  amount?: Price;
1975
1800
  }
1976
1801
  /** @oneof */
1977
- interface RegularPaymentPaymentMethodDetailsOneOf {
1802
+ export interface RegularPaymentPaymentMethodDetailsOneOf {
1978
1803
  /** Whether regular card used */
1979
1804
  creditCardDetails?: CreditCardDetails;
1980
1805
  }
1981
- interface CreditCardDetails {
1806
+ export interface CreditCardDetails {
1982
1807
  /**
1983
1808
  * The last 4 digits of the card number.
1984
1809
  * @maxLength 4
@@ -1990,7 +1815,7 @@ interface CreditCardDetails {
1990
1815
  */
1991
1816
  brand?: string | null;
1992
1817
  }
1993
- interface PaymentCanceled extends PaymentCanceledPaymentDetailsOneOf {
1818
+ export interface PaymentCanceled extends PaymentCanceledPaymentDetailsOneOf {
1994
1819
  /** Regular payment. */
1995
1820
  regular?: RegularPayment;
1996
1821
  /**
@@ -2000,11 +1825,11 @@ interface PaymentCanceled extends PaymentCanceledPaymentDetailsOneOf {
2000
1825
  paymentId?: string;
2001
1826
  }
2002
1827
  /** @oneof */
2003
- interface PaymentCanceledPaymentDetailsOneOf {
1828
+ export interface PaymentCanceledPaymentDetailsOneOf {
2004
1829
  /** Regular payment. */
2005
1830
  regular?: RegularPayment;
2006
1831
  }
2007
- interface PaymentDeclined extends PaymentDeclinedPaymentDetailsOneOf {
1832
+ export interface PaymentDeclined extends PaymentDeclinedPaymentDetailsOneOf {
2008
1833
  /** Regular payment. */
2009
1834
  regular?: RegularPayment;
2010
1835
  /**
@@ -2014,11 +1839,11 @@ interface PaymentDeclined extends PaymentDeclinedPaymentDetailsOneOf {
2014
1839
  paymentId?: string;
2015
1840
  }
2016
1841
  /** @oneof */
2017
- interface PaymentDeclinedPaymentDetailsOneOf {
1842
+ export interface PaymentDeclinedPaymentDetailsOneOf {
2018
1843
  /** Regular payment. */
2019
1844
  regular?: RegularPayment;
2020
1845
  }
2021
- interface ReceiptCreated extends ReceiptCreatedReceiptInfoOneOf {
1846
+ export interface ReceiptCreated extends ReceiptCreatedReceiptInfoOneOf {
2022
1847
  /** Receipt created by Wix */
2023
1848
  wixReceipt?: WixReceipt;
2024
1849
  /** Receipt created by an external system. */
@@ -2030,13 +1855,13 @@ interface ReceiptCreated extends ReceiptCreatedReceiptInfoOneOf {
2030
1855
  paymentId?: string;
2031
1856
  }
2032
1857
  /** @oneof */
2033
- interface ReceiptCreatedReceiptInfoOneOf {
1858
+ export interface ReceiptCreatedReceiptInfoOneOf {
2034
1859
  /** Receipt created by Wix */
2035
1860
  wixReceipt?: WixReceipt;
2036
1861
  /** Receipt created by an external system. */
2037
1862
  externalReceipt?: ExternalReceipt;
2038
1863
  }
2039
- interface WixReceipt {
1864
+ export interface WixReceipt {
2040
1865
  /**
2041
1866
  * Receipt ID
2042
1867
  * @format GUID
@@ -2049,7 +1874,7 @@ interface WixReceipt {
2049
1874
  */
2050
1875
  displayNumber?: string | null;
2051
1876
  }
2052
- interface ExternalReceipt {
1877
+ export interface ExternalReceipt {
2053
1878
  /**
2054
1879
  * Receipt ID
2055
1880
  * @maxLength 100
@@ -2062,7 +1887,7 @@ interface ExternalReceipt {
2062
1887
  */
2063
1888
  displayNumber?: string | null;
2064
1889
  }
2065
- interface ReceiptSent extends ReceiptSentReceiptInfoOneOf {
1890
+ export interface ReceiptSent extends ReceiptSentReceiptInfoOneOf {
2066
1891
  /** Receipt created by Wix */
2067
1892
  wixReceipt?: WixReceipt;
2068
1893
  /** Receipt created by an external system. */
@@ -2074,13 +1899,13 @@ interface ReceiptSent extends ReceiptSentReceiptInfoOneOf {
2074
1899
  paymentId?: string;
2075
1900
  }
2076
1901
  /** @oneof */
2077
- interface ReceiptSentReceiptInfoOneOf {
1902
+ export interface ReceiptSentReceiptInfoOneOf {
2078
1903
  /** Receipt created by Wix */
2079
1904
  wixReceipt?: WixReceipt;
2080
1905
  /** Receipt created by an external system. */
2081
1906
  externalReceipt?: ExternalReceipt;
2082
1907
  }
2083
- declare enum ActivityType {
1908
+ export declare enum ActivityType {
2084
1909
  ORDER_REFUNDED = "ORDER_REFUNDED",
2085
1910
  ORDER_PLACED = "ORDER_PLACED",
2086
1911
  ORDER_PAID = "ORDER_PAID",
@@ -2117,11 +1942,11 @@ declare enum ActivityType {
2117
1942
  /** @documentationMaturity preview */
2118
1943
  ORDER_REJECTED = "ORDER_REJECTED"
2119
1944
  }
2120
- declare enum AttributionSource {
1945
+ export declare enum AttributionSource {
2121
1946
  UNSPECIFIED = "UNSPECIFIED",
2122
1947
  FACEBOOK_ADS = "FACEBOOK_ADS"
2123
1948
  }
2124
- interface CreatedBy extends CreatedByStringOneOf {
1949
+ export interface CreatedBy extends CreatedByStringOneOf {
2125
1950
  /**
2126
1951
  * User ID - when the order was created by a Wix user on behalf of a buyer.
2127
1952
  * For example, via POS (point of service).
@@ -2145,7 +1970,7 @@ interface CreatedBy extends CreatedByStringOneOf {
2145
1970
  appId?: string;
2146
1971
  }
2147
1972
  /** @oneof */
2148
- interface CreatedByStringOneOf {
1973
+ export interface CreatedByStringOneOf {
2149
1974
  /**
2150
1975
  * User ID - when the order was created by a Wix user on behalf of a buyer.
2151
1976
  * For example, via POS (point of service).
@@ -2168,7 +1993,7 @@ interface CreatedByStringOneOf {
2168
1993
  */
2169
1994
  appId?: string;
2170
1995
  }
2171
- interface ChannelInfo {
1996
+ export interface ChannelInfo {
2172
1997
  /** Sales channel that submitted the order. */
2173
1998
  type?: ChannelType;
2174
1999
  /**
@@ -2182,7 +2007,7 @@ interface ChannelInfo {
2182
2007
  */
2183
2008
  externalOrderUrl?: string | null;
2184
2009
  }
2185
- declare enum ChannelType {
2010
+ export declare enum ChannelType {
2186
2011
  /** Unspecified sales channel. This value is not supported. */
2187
2012
  UNSPECIFIED = "UNSPECIFIED",
2188
2013
  /** A web client. */
@@ -2216,7 +2041,7 @@ declare enum ChannelType {
2216
2041
  /** [Faire marketplace integration](https://support.wix.com/en/article/wix-stores-creating-a-faire-store-using-the-faire-integration-app). */
2217
2042
  FAIRE_COM = "FAIRE_COM"
2218
2043
  }
2219
- interface CustomField {
2044
+ export interface CustomField {
2220
2045
  /** Custom field value. */
2221
2046
  value?: any;
2222
2047
  /**
@@ -2232,7 +2057,7 @@ interface CustomField {
2232
2057
  */
2233
2058
  translatedTitle?: string | null;
2234
2059
  }
2235
- interface BalanceSummary {
2060
+ export interface BalanceSummary {
2236
2061
  /**
2237
2062
  * Current amount left to pay.
2238
2063
  * @readonly
@@ -2255,12 +2080,6 @@ interface BalanceSummary {
2255
2080
  * @readonly
2256
2081
  */
2257
2082
  authorized?: Price;
2258
- /**
2259
- * Sum of all pending refund transactions.
2260
- * @internal
2261
- * @readonly
2262
- */
2263
- pendingRefund?: Price;
2264
2083
  /**
2265
2084
  * Sum of all pending transactions.
2266
2085
  * @readonly
@@ -2274,7 +2093,7 @@ interface BalanceSummary {
2274
2093
  * + PARTIALLY_PAID : price_summary.total_price - pay_now.total_price
2275
2094
  * + PENDING, REFUNDED, PARTIALLY_REFUNDED, PAID : 0
2276
2095
  */
2277
- interface Balance {
2096
+ export interface Balance {
2278
2097
  /**
2279
2098
  * Balance amount.
2280
2099
  *
@@ -2289,7 +2108,7 @@ interface Balance {
2289
2108
  */
2290
2109
  formattedAmount?: string;
2291
2110
  }
2292
- interface AdditionalFee {
2111
+ export interface AdditionalFee {
2293
2112
  /**
2294
2113
  * Additional fee's unique code for future processing.
2295
2114
  * @minLength 1
@@ -2327,16 +2146,8 @@ interface AdditionalFee {
2327
2146
  * @format GUID
2328
2147
  */
2329
2148
  lineItemIds?: string[];
2330
- /**
2331
- * Number of subscription billing cycles the additional fee applies to.
2332
- * If None and additional fee is linked to subscription line item, it applies to all cycles.
2333
- * @internal
2334
- * @min 1
2335
- * @max 999
2336
- */
2337
- subscriptionCycles?: number | null;
2338
2149
  }
2339
- interface FulfillmentStatusesAggregate {
2150
+ export interface FulfillmentStatusesAggregate {
2340
2151
  /** Unique string values based on Fulfillment entities statuses */
2341
2152
  statuses?: string[] | null;
2342
2153
  }
@@ -2362,13 +2173,13 @@ interface FulfillmentStatusesAggregate {
2362
2173
  * }
2363
2174
  * }
2364
2175
  */
2365
- interface Tags {
2176
+ export interface Tags {
2366
2177
  /** Tags that require an additional permission in order to access them, normally not given to site members or visitors. */
2367
2178
  privateTags?: TagList;
2368
2179
  /** Tags that are exposed to anyone who has access to the labeled entity itself, including site members and visitors. */
2369
2180
  tags?: TagList;
2370
2181
  }
2371
- interface TagList {
2182
+ export interface TagList {
2372
2183
  /**
2373
2184
  * List of tag IDs
2374
2185
  * @maxSize 100
@@ -2376,7 +2187,7 @@ interface TagList {
2376
2187
  */
2377
2188
  tagIds?: string[];
2378
2189
  }
2379
- interface Location {
2190
+ export interface Location {
2380
2191
  /**
2381
2192
  * Location ID.
2382
2193
  * Learn more about the [Wix Locations API](https://dev.wix.com/docs/rest/business-management/locations/introduction).
@@ -2392,29 +2203,29 @@ interface Location {
2392
2203
  name?: string;
2393
2204
  }
2394
2205
  /** Triggered when the order status changes to approved */
2395
- interface OrderApproved {
2206
+ export interface OrderApproved {
2396
2207
  /** The order that was updated */
2397
2208
  order?: Order;
2398
2209
  }
2399
- interface OrdersExperiments {
2210
+ export interface OrdersExperiments {
2400
2211
  epCommitTax?: boolean;
2401
2212
  moveMerchantEmailToEp?: boolean;
2402
2213
  moveBuyerOrderConfirmationEmailToEp?: boolean;
2403
2214
  producedByEpBridge?: boolean;
2404
2215
  enableRewrittenSideEffects?: boolean;
2405
2216
  }
2406
- interface OrderRejectedEventOrderRejected {
2217
+ export interface OrderRejectedEventOrderRejected {
2407
2218
  /** The order that was rejected */
2408
2219
  order?: Order;
2409
2220
  }
2410
2221
  /** Triggered when order items are marked as restocked */
2411
- interface OrderItemsRestocked {
2222
+ export interface OrderItemsRestocked {
2412
2223
  /** The order which items were restocked */
2413
2224
  order?: Order;
2414
2225
  /** Restocked items and quantities */
2415
2226
  restockItems?: V1RestockItem[];
2416
2227
  }
2417
- interface V1RestockItem {
2228
+ export interface V1RestockItem {
2418
2229
  /**
2419
2230
  * ID of the line item being restocked.
2420
2231
  * @format GUID
@@ -2427,7 +2238,7 @@ interface V1RestockItem {
2427
2238
  */
2428
2239
  quantity?: number;
2429
2240
  }
2430
- interface PreparePaymentCollectionRequest {
2241
+ export interface PreparePaymentCollectionRequest {
2431
2242
  /**
2432
2243
  * Ecom order ID.
2433
2244
  * @minLength 1
@@ -2451,21 +2262,10 @@ interface PreparePaymentCollectionRequest {
2451
2262
  * @targetRemovalDate 2024-09-30
2452
2263
  */
2453
2264
  delayedCapture?: boolean;
2454
- /**
2455
- * Specifies whether payment collection is initiated by Merchant or User of User
2456
- * Default: `true`
2457
- * @internal
2458
- */
2459
- merchantInitiated?: boolean | null;
2460
- /**
2461
- * Redirect urls which are used to return buyer to third party system.
2462
- * @internal
2463
- */
2464
- redirectUrls?: RedirectUrls;
2465
2265
  /** Delayed capture payment settings */
2466
2266
  delayedCaptureSettings?: DelayedCaptureSettings;
2467
2267
  }
2468
- interface RedirectUrls {
2268
+ export interface RedirectUrls {
2469
2269
  /**
2470
2270
  * URL to redirect buyer in case of approved (successful) transaction
2471
2271
  * @format WEB_URL
@@ -2487,20 +2287,20 @@ interface RedirectUrls {
2487
2287
  */
2488
2288
  pendingUrl?: string | null;
2489
2289
  }
2490
- interface DelayedCaptureSettings {
2290
+ export interface DelayedCaptureSettings {
2491
2291
  /** Specifies the automatic action (void/capture) for authorized transaction after the specified duration */
2492
2292
  scheduledAction?: ScheduledAction;
2493
2293
  /** Delay duration before execution. Optional - if not set, providers default period will be used */
2494
2294
  delayDuration?: Duration;
2495
2295
  }
2496
- declare enum ScheduledAction {
2296
+ export declare enum ScheduledAction {
2497
2297
  UNSPECIFIED = "UNSPECIFIED",
2498
2298
  /** Whether payment will be auto-voided when duration passes */
2499
2299
  VOID = "VOID",
2500
2300
  /** Whether payment will be auto-captured when duration passes */
2501
2301
  CAPTURE = "CAPTURE"
2502
2302
  }
2503
- interface Duration {
2303
+ export interface Duration {
2504
2304
  /**
2505
2305
  * Amount of units. For example, 30 MINUTES, 1 HOURS, 7 DAYS, etc
2506
2306
  * @min 1
@@ -2509,17 +2309,17 @@ interface Duration {
2509
2309
  /** Duration unit: MINUTES, HOURS and DAYS */
2510
2310
  unit?: DurationUnit;
2511
2311
  }
2512
- declare enum DurationUnit {
2312
+ export declare enum DurationUnit {
2513
2313
  UNKNOWN_DURATION_UNIT = "UNKNOWN_DURATION_UNIT",
2514
2314
  MINUTES = "MINUTES",
2515
2315
  HOURS = "HOURS",
2516
2316
  DAYS = "DAYS"
2517
2317
  }
2518
- interface PreparePaymentCollectionResponse {
2318
+ export interface PreparePaymentCollectionResponse {
2519
2319
  /** Payment gateway order id which is associated with given payment */
2520
2320
  paymentGatewayOrderId?: string;
2521
2321
  }
2522
- interface GetPaymentCollectabilityStatusRequest {
2322
+ export interface GetPaymentCollectabilityStatusRequest {
2523
2323
  /**
2524
2324
  * Ecom order ID.
2525
2325
  * @minLength 1
@@ -2527,13 +2327,13 @@ interface GetPaymentCollectabilityStatusRequest {
2527
2327
  */
2528
2328
  ecomOrderId: string;
2529
2329
  }
2530
- interface GetPaymentCollectabilityStatusResponse {
2330
+ export interface GetPaymentCollectabilityStatusResponse {
2531
2331
  /** Payment collectability status */
2532
2332
  status?: PaymentCollectabilityStatus;
2533
2333
  /** Collectable order amount */
2534
2334
  amount?: Price;
2535
2335
  }
2536
- declare enum PaymentCollectabilityStatus {
2336
+ export declare enum PaymentCollectabilityStatus {
2537
2337
  UNKNOWN = "UNKNOWN",
2538
2338
  COLLECTABLE = "COLLECTABLE",
2539
2339
  NONCOLLECTABLE_ORDER_IS_CANCELLED = "NONCOLLECTABLE_ORDER_IS_CANCELLED",
@@ -2543,7 +2343,7 @@ declare enum PaymentCollectabilityStatus {
2543
2343
  NONCOLLECTABLE_ORDER_IS_REJECTED = "NONCOLLECTABLE_ORDER_IS_REJECTED",
2544
2344
  NONCOLLECTABLE_ORDER_HAS_SUBSCRIPTIONS = "NONCOLLECTABLE_ORDER_HAS_SUBSCRIPTIONS"
2545
2345
  }
2546
- interface RecordManuallyCollectedPaymentRequest {
2346
+ export interface RecordManuallyCollectedPaymentRequest {
2547
2347
  /**
2548
2348
  * Order ID.
2549
2349
  * @minLength 1
@@ -2553,9 +2353,9 @@ interface RecordManuallyCollectedPaymentRequest {
2553
2353
  /** Amount to be recorded as approved manual payment for given order */
2554
2354
  amount: Price;
2555
2355
  }
2556
- interface RecordManuallyCollectedPaymentResponse {
2356
+ export interface RecordManuallyCollectedPaymentResponse {
2557
2357
  }
2558
- interface MarkOrderAsPaidRequest {
2358
+ export interface MarkOrderAsPaidRequest {
2559
2359
  /**
2560
2360
  * Ecom order ID.
2561
2361
  * @minLength 1
@@ -2563,18 +2363,18 @@ interface MarkOrderAsPaidRequest {
2563
2363
  */
2564
2364
  ecomOrderId: string;
2565
2365
  }
2566
- interface MarkOrderAsPaidResponse {
2366
+ export interface MarkOrderAsPaidResponse {
2567
2367
  /** Updated order. */
2568
2368
  order?: Order;
2569
2369
  }
2570
2370
  /** Triggered when the payment status of an order is updated */
2571
- interface PaymentStatusUpdated {
2371
+ export interface PaymentStatusUpdated {
2572
2372
  /** The order that was updated */
2573
2373
  order?: Order;
2574
2374
  /** The previous status (before the update) */
2575
2375
  previousPaymentStatus?: PaymentStatus;
2576
2376
  }
2577
- interface BulkMarkOrdersAsPaidRequest {
2377
+ export interface BulkMarkOrdersAsPaidRequest {
2578
2378
  /**
2579
2379
  * IDs of orders to mark as paid.
2580
2380
  * @minSize 1
@@ -2584,7 +2384,7 @@ interface BulkMarkOrdersAsPaidRequest {
2584
2384
  */
2585
2385
  ecomOrderIds: string[];
2586
2386
  }
2587
- interface BulkMarkOrdersAsPaidResponse {
2387
+ export interface BulkMarkOrdersAsPaidResponse {
2588
2388
  /**
2589
2389
  * Items updated by the bulk action.
2590
2390
  * The Order entity within the results optimistically changes its payment status to paid, however this process is async.
@@ -2593,7 +2393,7 @@ interface BulkMarkOrdersAsPaidResponse {
2593
2393
  /** Bulk action metadata. */
2594
2394
  bulkActionMetadata?: BulkActionMetadata;
2595
2395
  }
2596
- interface BulkOrderResult {
2396
+ export interface BulkOrderResult {
2597
2397
  /** Item metadata. */
2598
2398
  itemMetadata?: ItemMetadata;
2599
2399
  /**
@@ -2603,7 +2403,7 @@ interface BulkOrderResult {
2603
2403
  */
2604
2404
  item?: Order;
2605
2405
  }
2606
- interface ItemMetadata {
2406
+ export interface ItemMetadata {
2607
2407
  /** Item ID. Should always be available, unless it's impossible (for example, when failing to create an item). */
2608
2408
  _id?: string | null;
2609
2409
  /** Index of the item within the request array. Allows for correlation between request and response items. */
@@ -2613,7 +2413,7 @@ interface ItemMetadata {
2613
2413
  /** Details about the error in case of failure. */
2614
2414
  error?: ApplicationError;
2615
2415
  }
2616
- interface ApplicationError {
2416
+ export interface ApplicationError {
2617
2417
  /** Error code. */
2618
2418
  code?: string;
2619
2419
  /** Description of the error. */
@@ -2621,7 +2421,7 @@ interface ApplicationError {
2621
2421
  /** Data related to the error. */
2622
2422
  data?: Record<string, any> | null;
2623
2423
  }
2624
- interface BulkActionMetadata {
2424
+ export interface BulkActionMetadata {
2625
2425
  /** Number of items that were successfully processed. */
2626
2426
  totalSuccesses?: number;
2627
2427
  /** Number of items that couldn't be processed. */
@@ -2629,7 +2429,7 @@ interface BulkActionMetadata {
2629
2429
  /** Number of failures without details because detailed failure threshold was exceeded. */
2630
2430
  undetailedFailures?: number;
2631
2431
  }
2632
- interface GetRefundabilityStatusRequest {
2432
+ export interface GetRefundabilityStatusRequest {
2633
2433
  /**
2634
2434
  * Order ID.
2635
2435
  * @minLength 1
@@ -2637,7 +2437,7 @@ interface GetRefundabilityStatusRequest {
2637
2437
  */
2638
2438
  ecomOrderId: string;
2639
2439
  }
2640
- interface GetRefundabilityStatusResponse {
2440
+ export interface GetRefundabilityStatusResponse {
2641
2441
  /**
2642
2442
  * Refundability details.
2643
2443
  * @maxSize 300
@@ -2649,7 +2449,7 @@ interface GetRefundabilityStatusResponse {
2649
2449
  */
2650
2450
  refundablePerItem?: boolean;
2651
2451
  }
2652
- interface Refundability extends RefundabilityAdditionalRefundabilityInfoOneOf {
2452
+ export interface Refundability extends RefundabilityAdditionalRefundabilityInfoOneOf {
2653
2453
  /** Reason why payment is not refundable. */
2654
2454
  nonRefundableReason?: NonRefundableReason;
2655
2455
  /** Reason why payment is only refundable manually. */
@@ -2662,18 +2462,18 @@ interface Refundability extends RefundabilityAdditionalRefundabilityInfoOneOf {
2662
2462
  providerLink?: string | null;
2663
2463
  }
2664
2464
  /** @oneof */
2665
- interface RefundabilityAdditionalRefundabilityInfoOneOf {
2465
+ export interface RefundabilityAdditionalRefundabilityInfoOneOf {
2666
2466
  /** Reason why payment is not refundable. */
2667
2467
  nonRefundableReason?: NonRefundableReason;
2668
2468
  /** Reason why payment is only refundable manually. */
2669
2469
  manuallyRefundableReason?: ManuallyRefundableReason;
2670
2470
  }
2671
- declare enum RefundableStatus {
2471
+ export declare enum RefundableStatus {
2672
2472
  NOT_REFUNDABLE = "NOT_REFUNDABLE",
2673
2473
  MANUAL = "MANUAL",
2674
2474
  REFUNDABLE = "REFUNDABLE"
2675
2475
  }
2676
- declare enum NonRefundableReason {
2476
+ export declare enum NonRefundableReason {
2677
2477
  NONE = "NONE",
2678
2478
  ALREADY_REFUNDED = "ALREADY_REFUNDED",
2679
2479
  PROVIDER_IS_DOWN = "PROVIDER_IS_DOWN",
@@ -2688,13 +2488,13 @@ declare enum NonRefundableReason {
2688
2488
  ORDER_IS_PENDING = "ORDER_IS_PENDING",
2689
2489
  ORDER_IS_REJECTED = "ORDER_IS_REJECTED"
2690
2490
  }
2691
- declare enum ManuallyRefundableReason {
2491
+ export declare enum ManuallyRefundableReason {
2692
2492
  EXPIRED = "EXPIRED",
2693
2493
  NOT_SUPPORTED = "NOT_SUPPORTED",
2694
2494
  OFFLINE = "OFFLINE",
2695
2495
  REQUIRES_CARD_READER = "REQUIRES_CARD_READER"
2696
2496
  }
2697
- interface CreatePaymentGatewayOrderRequest {
2497
+ export interface CreatePaymentGatewayOrderRequest {
2698
2498
  /**
2699
2499
  * Ecom order ID.
2700
2500
  * @minLength 1
@@ -2704,7 +2504,7 @@ interface CreatePaymentGatewayOrderRequest {
2704
2504
  /** Information about the user who initiated the payment. */
2705
2505
  chargedBy?: ChargedBy;
2706
2506
  }
2707
- interface ChargedBy {
2507
+ export interface ChargedBy {
2708
2508
  /**
2709
2509
  * ID - id of the user who initiated the payment
2710
2510
  * @format GUID
@@ -2717,11 +2517,11 @@ interface ChargedBy {
2717
2517
  */
2718
2518
  fullName?: string | null;
2719
2519
  }
2720
- interface CreatePaymentGatewayOrderResponse {
2520
+ export interface CreatePaymentGatewayOrderResponse {
2721
2521
  /** ID of the order created in the payment gateway */
2722
2522
  paymentGatewayOrderId?: string;
2723
2523
  }
2724
- interface ChargeMembershipsRequest {
2524
+ export interface ChargeMembershipsRequest {
2725
2525
  /**
2726
2526
  * Order ID.
2727
2527
  * @minLength 1
@@ -2741,7 +2541,7 @@ interface ChargeMembershipsRequest {
2741
2541
  */
2742
2542
  membershipCharges?: MembershipChargeItem[];
2743
2543
  }
2744
- interface MembershipChargeItem {
2544
+ export interface MembershipChargeItem {
2745
2545
  /**
2746
2546
  * The id of used membership
2747
2547
  * @minLength 1
@@ -2776,7 +2576,7 @@ interface MembershipChargeItem {
2776
2576
  */
2777
2577
  lineItemId?: string;
2778
2578
  }
2779
- interface MembershipName {
2579
+ export interface MembershipName {
2780
2580
  /**
2781
2581
  * Membership name.
2782
2582
  * @maxLength 100
@@ -2788,7 +2588,7 @@ interface MembershipName {
2788
2588
  */
2789
2589
  translated?: string | null;
2790
2590
  }
2791
- interface ServiceProperties {
2591
+ export interface ServiceProperties {
2792
2592
  /**
2793
2593
  * 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.
2794
2594
  * For example, the start time of a class.
@@ -2801,9 +2601,9 @@ interface ServiceProperties {
2801
2601
  */
2802
2602
  numberOfParticipants?: number | null;
2803
2603
  }
2804
- interface ChargeMembershipsResponse {
2604
+ export interface ChargeMembershipsResponse {
2805
2605
  }
2806
- interface TriggerRefundRequest {
2606
+ export interface TriggerRefundRequest {
2807
2607
  /**
2808
2608
  * The order this refund related to
2809
2609
  * @minLength 1
@@ -2821,7 +2621,7 @@ interface TriggerRefundRequest {
2821
2621
  /** Side effect details related to refund */
2822
2622
  sideEffects?: RefundSideEffects;
2823
2623
  }
2824
- interface PaymentRefund {
2624
+ export interface PaymentRefund {
2825
2625
  /**
2826
2626
  * Specific payment within the order to refund
2827
2627
  * @format GUID
@@ -2837,7 +2637,7 @@ interface PaymentRefund {
2837
2637
  externalRefund?: boolean;
2838
2638
  }
2839
2639
  /** Business model of a refund request */
2840
- interface RefundDetails {
2640
+ export interface RefundDetails {
2841
2641
  /**
2842
2642
  * Order line item IDs and quantities that were refunded.
2843
2643
  * @maxSize 300
@@ -2863,7 +2663,7 @@ interface RefundDetails {
2863
2663
  /** Shipping amount that was refunded. */
2864
2664
  shipping?: ShippingRefund;
2865
2665
  }
2866
- interface RefundItem {
2666
+ export interface RefundItem {
2867
2667
  /**
2868
2668
  * Line item ID the refunded line item.
2869
2669
  * @format GUID
@@ -2876,7 +2676,7 @@ interface RefundItem {
2876
2676
  */
2877
2677
  quantity?: number;
2878
2678
  }
2879
- interface LineItemRefund {
2679
+ export interface LineItemRefund {
2880
2680
  /**
2881
2681
  * Line item ID.
2882
2682
  * @format GUID
@@ -2891,7 +2691,7 @@ interface LineItemRefund {
2891
2691
  */
2892
2692
  quantity?: number;
2893
2693
  }
2894
- interface AdditionalFeeRefund {
2694
+ export interface AdditionalFeeRefund {
2895
2695
  /**
2896
2696
  * Additional fee ID.
2897
2697
  * @format GUID
@@ -2904,14 +2704,14 @@ interface AdditionalFeeRefund {
2904
2704
  */
2905
2705
  amount?: Price;
2906
2706
  }
2907
- interface ShippingRefund {
2707
+ export interface ShippingRefund {
2908
2708
  /**
2909
2709
  * Refund amount.
2910
2710
  * @immutable
2911
2711
  */
2912
2712
  amount?: Price;
2913
2713
  }
2914
- interface RefundSideEffects {
2714
+ export interface RefundSideEffects {
2915
2715
  /** Inventory restock details as part of this refund. */
2916
2716
  restockInfo?: RestockInfo;
2917
2717
  /** Whether to send a refund confirmation email to the customer. */
@@ -2923,7 +2723,7 @@ interface RefundSideEffects {
2923
2723
  */
2924
2724
  customMessage?: string | null;
2925
2725
  }
2926
- interface RestockInfo {
2726
+ export interface RestockInfo {
2927
2727
  /** Restock type. */
2928
2728
  type?: RestockType;
2929
2729
  /**
@@ -2932,12 +2732,12 @@ interface RestockInfo {
2932
2732
  */
2933
2733
  items?: RestockItem[];
2934
2734
  }
2935
- declare enum RestockType {
2735
+ export declare enum RestockType {
2936
2736
  NO_ITEMS = "NO_ITEMS",
2937
2737
  ALL_ITEMS = "ALL_ITEMS",
2938
2738
  SOME_ITEMS = "SOME_ITEMS"
2939
2739
  }
2940
- interface RestockItem {
2740
+ export interface RestockItem {
2941
2741
  /**
2942
2742
  * ID of the line item being restocked.
2943
2743
  * @format GUID
@@ -2950,7 +2750,7 @@ interface RestockItem {
2950
2750
  */
2951
2751
  quantity?: number;
2952
2752
  }
2953
- interface TriggerRefundResponse {
2753
+ export interface TriggerRefundResponse {
2954
2754
  /** All order's transactions after the refunds were added */
2955
2755
  orderTransactions?: OrderTransactions;
2956
2756
  /** Created refund ID */
@@ -2958,7 +2758,7 @@ interface TriggerRefundResponse {
2958
2758
  /** Payment ID's that the refund execution had failed for */
2959
2759
  failedPaymentIds?: ItemMetadata[];
2960
2760
  }
2961
- interface OrderTransactions {
2761
+ export interface OrderTransactions {
2962
2762
  /**
2963
2763
  * Order ID.
2964
2764
  * @format GUID
@@ -2975,21 +2775,11 @@ interface OrderTransactions {
2975
2775
  */
2976
2776
  refunds?: Refund[];
2977
2777
  }
2978
- interface Payment extends PaymentPaymentDetailsOneOf, PaymentReceiptInfoOneOf {
2778
+ export interface Payment extends PaymentPaymentDetailsOneOf, PaymentReceiptInfoOneOf {
2979
2779
  /** Regular payment details. */
2980
2780
  regularPaymentDetails?: RegularPaymentDetails;
2981
2781
  /** Gift card payment details. */
2982
2782
  giftcardPaymentDetails?: GiftCardPaymentDetails;
2983
- /**
2984
- * Receipt created by Wix
2985
- * @internal
2986
- */
2987
- wixReceipt?: WixReceiptInfo;
2988
- /**
2989
- * Receipt created by an external system.
2990
- * @internal
2991
- */
2992
- externalReceipt?: ExternalReceiptInfo;
2993
2783
  /**
2994
2784
  * Payment ID.
2995
2785
  * @format GUID
@@ -3011,36 +2801,18 @@ interface Payment extends PaymentPaymentDetailsOneOf, PaymentReceiptInfoOneOf {
3011
2801
  * + `false`: This payment may be refunded. However, this ultimately depends on the payment provider.
3012
2802
  */
3013
2803
  refundDisabled?: boolean;
3014
- /**
3015
- * Whether receipt generation for this payment are allowed.
3016
- * + `true`: This payment supports receipt generation.
3017
- * + `false`: This payment not supports receipt generation, or receipt already generated
3018
- * @internal
3019
- * @readonly
3020
- */
3021
- supportReceiptGeneration?: boolean;
3022
2804
  }
3023
2805
  /** @oneof */
3024
- interface PaymentPaymentDetailsOneOf {
2806
+ export interface PaymentPaymentDetailsOneOf {
3025
2807
  /** Regular payment details. */
3026
2808
  regularPaymentDetails?: RegularPaymentDetails;
3027
2809
  /** Gift card payment details. */
3028
2810
  giftcardPaymentDetails?: GiftCardPaymentDetails;
3029
2811
  }
3030
2812
  /** @oneof */
3031
- interface PaymentReceiptInfoOneOf {
3032
- /**
3033
- * Receipt created by Wix
3034
- * @internal
3035
- */
3036
- wixReceipt?: WixReceiptInfo;
3037
- /**
3038
- * Receipt created by an external system.
3039
- * @internal
3040
- */
3041
- externalReceipt?: ExternalReceiptInfo;
2813
+ export interface PaymentReceiptInfoOneOf {
3042
2814
  }
3043
- interface RegularPaymentDetails extends RegularPaymentDetailsPaymentMethodDetailsOneOf {
2815
+ export interface RegularPaymentDetails extends RegularPaymentDetailsPaymentMethodDetailsOneOf {
3044
2816
  /** Whether regular card used */
3045
2817
  creditCardDetails?: CreditCardPaymentMethodDetails;
3046
2818
  /**
@@ -3076,19 +2848,13 @@ interface RegularPaymentDetails extends RegularPaymentDetailsPaymentMethodDetail
3076
2848
  savedPaymentMethod?: boolean;
3077
2849
  /** Authorization details. */
3078
2850
  authorizationDetails?: AuthorizationDetails;
3079
- /**
3080
- * Payment service provider display name. Non-exhaustive list of supported values: Wix Payments, PayPal, Square, Stripe, etc.
3081
- * @internal
3082
- * @maxLength 300
3083
- */
3084
- paymentProvider?: string | null;
3085
2851
  }
3086
2852
  /** @oneof */
3087
- interface RegularPaymentDetailsPaymentMethodDetailsOneOf {
2853
+ export interface RegularPaymentDetailsPaymentMethodDetailsOneOf {
3088
2854
  /** Whether regular card used */
3089
2855
  creditCardDetails?: CreditCardPaymentMethodDetails;
3090
2856
  }
3091
- declare enum TransactionStatus {
2857
+ export declare enum TransactionStatus {
3092
2858
  UNDEFINED = "UNDEFINED",
3093
2859
  APPROVED = "APPROVED",
3094
2860
  PENDING = "PENDING",
@@ -3100,7 +2866,7 @@ declare enum TransactionStatus {
3100
2866
  AUTHORIZED = "AUTHORIZED",
3101
2867
  VOIDED = "VOIDED"
3102
2868
  }
3103
- interface CreditCardPaymentMethodDetails {
2869
+ export interface CreditCardPaymentMethodDetails {
3104
2870
  /**
3105
2871
  * The last 4 digits of the card number.
3106
2872
  * @maxLength 4
@@ -3112,7 +2878,7 @@ interface CreditCardPaymentMethodDetails {
3112
2878
  */
3113
2879
  brand?: string | null;
3114
2880
  }
3115
- interface AuthorizationDetails {
2881
+ export interface AuthorizationDetails {
3116
2882
  /**
3117
2883
  * Whether the authorized payment is of a delayed capture.
3118
2884
  * @readonly
@@ -3131,7 +2897,7 @@ interface AuthorizationDetails {
3131
2897
  /** Scheduled action for this transaction */
3132
2898
  scheduledAction?: V1ScheduledAction;
3133
2899
  }
3134
- interface AuthorizationCapture {
2900
+ export interface AuthorizationCapture {
3135
2901
  /**
3136
2902
  * Capture ID.
3137
2903
  * @format GUID
@@ -3150,7 +2916,7 @@ interface AuthorizationCapture {
3150
2916
  /** In case of status is FAILED may contain failure details */
3151
2917
  failureDetails?: AuthorizationActionFailureDetails;
3152
2918
  }
3153
- declare enum AuthorizationCaptureStatus {
2919
+ export declare enum AuthorizationCaptureStatus {
3154
2920
  UNKNOWN_STATUS = "UNKNOWN_STATUS",
3155
2921
  /** Capture operation still in progress. */
3156
2922
  PENDING = "PENDING",
@@ -3159,11 +2925,11 @@ declare enum AuthorizationCaptureStatus {
3159
2925
  /** Capture operation failed. */
3160
2926
  FAILED = "FAILED"
3161
2927
  }
3162
- interface AuthorizationActionFailureDetails {
2928
+ export interface AuthorizationActionFailureDetails {
3163
2929
  /** @maxLength 100 */
3164
2930
  failureCode?: string;
3165
2931
  }
3166
- interface AuthorizationVoid {
2932
+ export interface AuthorizationVoid {
3167
2933
  /** Status of this void action */
3168
2934
  status?: AuthorizationVoidStatus;
3169
2935
  /** Date and time the void was initiated in [ISO-8601](https://en.wikipedia.org/wiki/ISO_8601#Combined_date_and_time_representations) format. */
@@ -3173,7 +2939,7 @@ interface AuthorizationVoid {
3173
2939
  /** Reason of void action */
3174
2940
  reason?: Reason;
3175
2941
  }
3176
- declare enum AuthorizationVoidStatus {
2942
+ export declare enum AuthorizationVoidStatus {
3177
2943
  UNKNOWN_STATUS = "UNKNOWN_STATUS",
3178
2944
  /** Void operation still in progress. */
3179
2945
  PENDING = "PENDING",
@@ -3183,25 +2949,25 @@ declare enum AuthorizationVoidStatus {
3183
2949
  FAILED = "FAILED"
3184
2950
  }
3185
2951
  /** Reason the authorization was voided. */
3186
- declare enum Reason {
2952
+ export declare enum Reason {
3187
2953
  UNKNOWN_REASON = "UNKNOWN_REASON",
3188
2954
  /** Authorization was voided by user. */
3189
2955
  MANUAL = "MANUAL",
3190
2956
  /** Authorization passed execution date. */
3191
2957
  SCHEDULED = "SCHEDULED"
3192
2958
  }
3193
- interface V1ScheduledAction {
2959
+ export interface V1ScheduledAction {
3194
2960
  /** Type of the action. */
3195
2961
  actionType?: ActionType;
3196
2962
  /** The date and time of the action. */
3197
2963
  executionDate?: Date | null;
3198
2964
  }
3199
- declare enum ActionType {
2965
+ export declare enum ActionType {
3200
2966
  UNKNOWN_ACTION_TYPE = "UNKNOWN_ACTION_TYPE",
3201
2967
  VOID = "VOID",
3202
2968
  CAPTURE = "CAPTURE"
3203
2969
  }
3204
- interface GiftCardPaymentDetails {
2970
+ export interface GiftCardPaymentDetails {
3205
2971
  /**
3206
2972
  * Gift card payment ID.
3207
2973
  * @minLength 1
@@ -3218,15 +2984,8 @@ interface GiftCardPaymentDetails {
3218
2984
  * @readonly
3219
2985
  */
3220
2986
  voided?: boolean;
3221
- /**
3222
- * Gift card obfuscated code.
3223
- * @internal
3224
- * @maxLength 30
3225
- * @immutable
3226
- */
3227
- obfuscatedCode?: string | null;
3228
2987
  }
3229
- interface MembershipPaymentDetails {
2988
+ export interface MembershipPaymentDetails {
3230
2989
  /**
3231
2990
  * Membership ID.
3232
2991
  * @minLength 1
@@ -3260,13 +3019,13 @@ interface MembershipPaymentDetails {
3260
3019
  */
3261
3020
  providerAppId?: string;
3262
3021
  }
3263
- declare enum MembershipPaymentStatus {
3022
+ export declare enum MembershipPaymentStatus {
3264
3023
  /** Payment was charged. */
3265
3024
  CHARGED = "CHARGED",
3266
3025
  /** The attempt to charge the payment failed, for example, due to lack of credits. */
3267
3026
  CHARGE_FAILED = "CHARGE_FAILED"
3268
3027
  }
3269
- interface WixReceiptInfo {
3028
+ export interface WixReceiptInfo {
3270
3029
  /**
3271
3030
  * Receipt ID
3272
3031
  * @format GUID
@@ -3279,7 +3038,7 @@ interface WixReceiptInfo {
3279
3038
  */
3280
3039
  displayNumber?: string | null;
3281
3040
  }
3282
- interface ExternalReceiptInfo {
3041
+ export interface ExternalReceiptInfo {
3283
3042
  /**
3284
3043
  * External receipt ID
3285
3044
  * @maxLength 100
@@ -3297,7 +3056,7 @@ interface ExternalReceiptInfo {
3297
3056
  */
3298
3057
  displayNumber?: string | null;
3299
3058
  }
3300
- interface Refund {
3059
+ export interface Refund {
3301
3060
  /**
3302
3061
  * Refund ID.
3303
3062
  * @format GUID
@@ -3330,7 +3089,7 @@ interface Refund {
3330
3089
  */
3331
3090
  requestingServiceAppId?: string | null;
3332
3091
  }
3333
- interface RefundTransaction {
3092
+ export interface RefundTransaction {
3334
3093
  /**
3335
3094
  * ID of the payment associated with this refund.
3336
3095
  * @format GUID
@@ -3361,7 +3120,7 @@ interface RefundTransaction {
3361
3120
  externalRefund?: boolean;
3362
3121
  }
3363
3122
  /** Refund transaction status. */
3364
- declare enum RefundStatus {
3123
+ export declare enum RefundStatus {
3365
3124
  /** Refund was initiated on payment provider side. PENDING status was assigned by provider. */
3366
3125
  PENDING = "PENDING",
3367
3126
  /** Refund transaction succeeded. */
@@ -3373,7 +3132,7 @@ declare enum RefundStatus {
3373
3132
  /** Refund was initiated on payment provider side. */
3374
3133
  STARTED = "STARTED"
3375
3134
  }
3376
- interface RefundStatusInfo {
3135
+ export interface RefundStatusInfo {
3377
3136
  /**
3378
3137
  * Reason code for the refund's current status.
3379
3138
  *
@@ -3389,7 +3148,7 @@ interface RefundStatusInfo {
3389
3148
  */
3390
3149
  description?: string | null;
3391
3150
  }
3392
- interface AggregatedRefundSummary {
3151
+ export interface AggregatedRefundSummary {
3393
3152
  /** Total amount requested for refund. */
3394
3153
  requestedRefund?: Price;
3395
3154
  /** Pending refund amount - the portion of `requestedRefund` that is still pending. */
@@ -3403,14 +3162,14 @@ interface AggregatedRefundSummary {
3403
3162
  /** Breakdown of refunded items. Available only after refund is complete. */
3404
3163
  breakdown?: RefundItemsBreakdown;
3405
3164
  }
3406
- interface RefundItemsBreakdown {
3165
+ export interface RefundItemsBreakdown {
3407
3166
  /**
3408
3167
  * Refunded line items and the amount refunded for each.
3409
3168
  * @maxSize 300
3410
3169
  */
3411
3170
  lineItems?: LineItemRefundSummary[];
3412
3171
  }
3413
- interface LineItemRefundSummary {
3172
+ export interface LineItemRefundSummary {
3414
3173
  /**
3415
3174
  * ID of the refunded line item.
3416
3175
  * @format GUID
@@ -3419,7 +3178,7 @@ interface LineItemRefundSummary {
3419
3178
  /** Total refunded amount for the line item. */
3420
3179
  totalRefundedAmount?: Price;
3421
3180
  }
3422
- interface CalculateRefundRequest {
3181
+ export interface CalculateRefundRequest {
3423
3182
  /**
3424
3183
  * Order ID
3425
3184
  * @minLength 1
@@ -3434,7 +3193,7 @@ interface CalculateRefundRequest {
3434
3193
  /** Should include shipping in refund calculation */
3435
3194
  refundShipping?: boolean;
3436
3195
  }
3437
- interface CalculateRefundItemRequest {
3196
+ export interface CalculateRefundItemRequest {
3438
3197
  /**
3439
3198
  * ID of the line item being refunded
3440
3199
  * @format GUID
@@ -3447,7 +3206,7 @@ interface CalculateRefundItemRequest {
3447
3206
  */
3448
3207
  quantity?: number;
3449
3208
  }
3450
- interface CalculateRefundResponse {
3209
+ export interface CalculateRefundResponse {
3451
3210
  /** Total refundable amount */
3452
3211
  total?: Price;
3453
3212
  /** Tax cost of the order */
@@ -3466,7 +3225,7 @@ interface CalculateRefundResponse {
3466
3225
  */
3467
3226
  items?: CalculateRefundItemResponse[];
3468
3227
  }
3469
- interface CalculateRefundItemResponse {
3228
+ export interface CalculateRefundItemResponse {
3470
3229
  /**
3471
3230
  * Line item ID
3472
3231
  * @format GUID
@@ -3475,7 +3234,7 @@ interface CalculateRefundItemResponse {
3475
3234
  /** Refundable amount for requested quantity of items (price of requested quantity of items without tax and discount) */
3476
3235
  price?: Price;
3477
3236
  }
3478
- interface VoidAuthorizedPaymentsRequest {
3237
+ export interface VoidAuthorizedPaymentsRequest {
3479
3238
  /**
3480
3239
  * Wix eCommerce order ID
3481
3240
  * @minLength 1
@@ -3490,11 +3249,11 @@ interface VoidAuthorizedPaymentsRequest {
3490
3249
  */
3491
3250
  paymentIds: string[];
3492
3251
  }
3493
- interface VoidAuthorizedPaymentsResponse {
3252
+ export interface VoidAuthorizedPaymentsResponse {
3494
3253
  /** All order's transactions after the void was triggered */
3495
3254
  orderTransactions?: OrderTransactions;
3496
3255
  }
3497
- interface CaptureAuthorizedPaymentsRequest {
3256
+ export interface CaptureAuthorizedPaymentsRequest {
3498
3257
  /**
3499
3258
  * Wix eCommerce order ID
3500
3259
  * @minLength 1
@@ -3508,7 +3267,7 @@ interface CaptureAuthorizedPaymentsRequest {
3508
3267
  */
3509
3268
  payments: PaymentCapture[];
3510
3269
  }
3511
- interface PaymentCapture {
3270
+ export interface PaymentCapture {
3512
3271
  /**
3513
3272
  * Payment ID
3514
3273
  * @format GUID
@@ -3520,11 +3279,11 @@ interface PaymentCapture {
3520
3279
  */
3521
3280
  amount?: Price;
3522
3281
  }
3523
- interface CaptureAuthorizedPaymentsResponse {
3282
+ export interface CaptureAuthorizedPaymentsResponse {
3524
3283
  /** All order's transactions after the capture was triggered */
3525
3284
  orderTransactions?: OrderTransactions;
3526
3285
  }
3527
- interface ChargeSavedPaymentMethodRequest {
3286
+ export interface ChargeSavedPaymentMethodRequest {
3528
3287
  /**
3529
3288
  * Ecom Order ID.
3530
3289
  * @minLength 1
@@ -3534,11 +3293,11 @@ interface ChargeSavedPaymentMethodRequest {
3534
3293
  /** Amount to be charged */
3535
3294
  amount?: Price;
3536
3295
  }
3537
- interface ChargeSavedPaymentMethodResponse {
3296
+ export interface ChargeSavedPaymentMethodResponse {
3538
3297
  /** Payment gateway's order ID (e.g Wix Payments) */
3539
3298
  paymentGatewayOrderId?: string;
3540
3299
  }
3541
- interface DomainEvent extends DomainEventBodyOneOf {
3300
+ export interface DomainEvent extends DomainEventBodyOneOf {
3542
3301
  createdEvent?: EntityCreatedEvent;
3543
3302
  updatedEvent?: EntityUpdatedEvent;
3544
3303
  deletedEvent?: EntityDeletedEvent;
@@ -3581,19 +3340,19 @@ interface DomainEvent extends DomainEventBodyOneOf {
3581
3340
  entityEventSequence?: string | null;
3582
3341
  }
3583
3342
  /** @oneof */
3584
- interface DomainEventBodyOneOf {
3343
+ export interface DomainEventBodyOneOf {
3585
3344
  createdEvent?: EntityCreatedEvent;
3586
3345
  updatedEvent?: EntityUpdatedEvent;
3587
3346
  deletedEvent?: EntityDeletedEvent;
3588
3347
  actionEvent?: ActionEvent;
3589
3348
  }
3590
- interface EntityCreatedEvent {
3349
+ export interface EntityCreatedEvent {
3591
3350
  entity?: string;
3592
3351
  }
3593
- interface RestoreInfo {
3352
+ export interface RestoreInfo {
3594
3353
  deletedDate?: Date | null;
3595
3354
  }
3596
- interface EntityUpdatedEvent {
3355
+ export interface EntityUpdatedEvent {
3597
3356
  /**
3598
3357
  * Since platformized APIs only expose PATCH and not PUT we can't assume that the fields sent from the client are the actual diff.
3599
3358
  * This means that to generate a list of changed fields (as opposed to sent fields) one needs to traverse both objects.
@@ -3601,16 +3360,16 @@ interface EntityUpdatedEvent {
3601
3360
  */
3602
3361
  currentEntity?: string;
3603
3362
  }
3604
- interface EntityDeletedEvent {
3363
+ export interface EntityDeletedEvent {
3605
3364
  /** Entity that was deleted */
3606
3365
  deletedEntity?: string | null;
3607
3366
  }
3608
- interface ActionEvent {
3367
+ export interface ActionEvent {
3609
3368
  body?: string;
3610
3369
  }
3611
- interface Empty {
3370
+ export interface Empty {
3612
3371
  }
3613
- interface MessageEnvelope {
3372
+ export interface MessageEnvelope {
3614
3373
  /**
3615
3374
  * App instance ID.
3616
3375
  * @format GUID
@@ -3626,7 +3385,7 @@ interface MessageEnvelope {
3626
3385
  /** Stringify payload. */
3627
3386
  data?: string;
3628
3387
  }
3629
- interface IdentificationData extends IdentificationDataIdOneOf {
3388
+ export interface IdentificationData extends IdentificationDataIdOneOf {
3630
3389
  /**
3631
3390
  * ID of a site visitor that has not logged in to the site.
3632
3391
  * @format GUID
@@ -3651,7 +3410,7 @@ interface IdentificationData extends IdentificationDataIdOneOf {
3651
3410
  identityType?: WebhookIdentityType;
3652
3411
  }
3653
3412
  /** @oneof */
3654
- interface IdentificationDataIdOneOf {
3413
+ export interface IdentificationDataIdOneOf {
3655
3414
  /**
3656
3415
  * ID of a site visitor that has not logged in to the site.
3657
3416
  * @format GUID
@@ -3673,14 +3432,14 @@ interface IdentificationDataIdOneOf {
3673
3432
  */
3674
3433
  appId?: string;
3675
3434
  }
3676
- declare enum WebhookIdentityType {
3435
+ export declare enum WebhookIdentityType {
3677
3436
  UNKNOWN = "UNKNOWN",
3678
3437
  ANONYMOUS_VISITOR = "ANONYMOUS_VISITOR",
3679
3438
  MEMBER = "MEMBER",
3680
3439
  WIX_USER = "WIX_USER",
3681
3440
  APP = "APP"
3682
3441
  }
3683
- declare enum TextDetection {
3442
+ export declare enum TextDetection {
3684
3443
  /** No detection was made */
3685
3444
  UNKNOWN_TEXT_DETECTION = "UNKNOWN_TEXT_DETECTION",
3686
3445
  /** The image contains text */
@@ -3688,7 +3447,7 @@ declare enum TextDetection {
3688
3447
  /** The image does not contain text */
3689
3448
  NO_TEXT = "NO_TEXT"
3690
3449
  }
3691
- declare enum AnimationDetection {
3450
+ export declare enum AnimationDetection {
3692
3451
  /** No detection was made */
3693
3452
  UNKNOWN_ANIMATION_DETECTION = "UNKNOWN_ANIMATION_DETECTION",
3694
3453
  /** The image contains animation */
@@ -3696,37 +3455,37 @@ declare enum AnimationDetection {
3696
3455
  /** The image does not contain animation */
3697
3456
  NO_ANIMATION = "NO_ANIMATION"
3698
3457
  }
3699
- interface ImageContent {
3458
+ export interface ImageContent {
3700
3459
  /** Text detection */
3701
3460
  text?: TextDetection;
3702
3461
  /** Animation detection */
3703
3462
  animation?: AnimationDetection;
3704
3463
  }
3705
- interface SendBuyerConfirmationEmailRequest {
3464
+ export interface SendBuyerConfirmationEmailRequest {
3706
3465
  /** @format GUID */
3707
3466
  orderId?: string;
3708
3467
  }
3709
- interface SendBuyerConfirmationEmailResponse {
3468
+ export interface SendBuyerConfirmationEmailResponse {
3710
3469
  }
3711
- interface SendBuyerPaymentsReceivedEmailRequest {
3470
+ export interface SendBuyerPaymentsReceivedEmailRequest {
3712
3471
  /**
3713
3472
  * @minLength 1
3714
3473
  * @maxLength 100
3715
3474
  */
3716
3475
  orderId?: string;
3717
3476
  }
3718
- interface SendBuyerPaymentsReceivedEmailResponse {
3477
+ export interface SendBuyerPaymentsReceivedEmailResponse {
3719
3478
  }
3720
- interface SendBuyerPickupConfirmationEmailRequest {
3479
+ export interface SendBuyerPickupConfirmationEmailRequest {
3721
3480
  /**
3722
3481
  * @minLength 1
3723
3482
  * @maxLength 100
3724
3483
  */
3725
3484
  orderId?: string;
3726
3485
  }
3727
- interface SendBuyerPickupConfirmationEmailResponse {
3486
+ export interface SendBuyerPickupConfirmationEmailResponse {
3728
3487
  }
3729
- interface BulkSendBuyerPickupConfirmationEmailsRequest {
3488
+ export interface BulkSendBuyerPickupConfirmationEmailsRequest {
3730
3489
  /**
3731
3490
  * IDs of orders to send pickup emails for.
3732
3491
  * @minSize 1
@@ -3734,18 +3493,18 @@ interface BulkSendBuyerPickupConfirmationEmailsRequest {
3734
3493
  */
3735
3494
  orderIds?: string[];
3736
3495
  }
3737
- interface BulkSendBuyerPickupConfirmationEmailsResponse {
3496
+ export interface BulkSendBuyerPickupConfirmationEmailsResponse {
3738
3497
  }
3739
- interface SendBuyerShippingConfirmationEmailRequest {
3498
+ export interface SendBuyerShippingConfirmationEmailRequest {
3740
3499
  /**
3741
3500
  * @minLength 1
3742
3501
  * @maxLength 100
3743
3502
  */
3744
3503
  orderId?: string;
3745
3504
  }
3746
- interface SendBuyerShippingConfirmationEmailResponse {
3505
+ export interface SendBuyerShippingConfirmationEmailResponse {
3747
3506
  }
3748
- interface BulkSendBuyerShippingConfirmationEmailsRequest {
3507
+ export interface BulkSendBuyerShippingConfirmationEmailsRequest {
3749
3508
  /**
3750
3509
  * IDs of orders to send pickup emails for.
3751
3510
  * @minSize 1
@@ -3753,18 +3512,18 @@ interface BulkSendBuyerShippingConfirmationEmailsRequest {
3753
3512
  */
3754
3513
  orderIds?: string[];
3755
3514
  }
3756
- interface BulkSendBuyerShippingConfirmationEmailsResponse {
3515
+ export interface BulkSendBuyerShippingConfirmationEmailsResponse {
3757
3516
  }
3758
- interface SendMerchantOrderReceivedNotificationRequest {
3517
+ export interface SendMerchantOrderReceivedNotificationRequest {
3759
3518
  /**
3760
3519
  * @minLength 1
3761
3520
  * @maxLength 100
3762
3521
  */
3763
3522
  orderId?: string;
3764
3523
  }
3765
- interface SendMerchantOrderReceivedNotificationResponse {
3524
+ export interface SendMerchantOrderReceivedNotificationResponse {
3766
3525
  }
3767
- interface SendCancelRefundEmailRequest {
3526
+ export interface SendCancelRefundEmailRequest {
3768
3527
  /**
3769
3528
  * The ID of order that is canceled/refunded
3770
3529
  * @minLength 1
@@ -3785,9 +3544,9 @@ interface SendCancelRefundEmailRequest {
3785
3544
  */
3786
3545
  refundId?: string | null;
3787
3546
  }
3788
- interface SendCancelRefundEmailResponse {
3547
+ export interface SendCancelRefundEmailResponse {
3789
3548
  }
3790
- interface SendRefundEmailRequest {
3549
+ export interface SendRefundEmailRequest {
3791
3550
  /**
3792
3551
  * The ID of order that is refunded
3793
3552
  * @format GUID
@@ -3805,30 +3564,30 @@ interface SendRefundEmailRequest {
3805
3564
  */
3806
3565
  customMessage?: string | null;
3807
3566
  }
3808
- interface SendRefundEmailResponse {
3567
+ export interface SendRefundEmailResponse {
3809
3568
  }
3810
- interface SendMerchantOrderReceivedPushRequest {
3569
+ export interface SendMerchantOrderReceivedPushRequest {
3811
3570
  /**
3812
3571
  * @minLength 1
3813
3572
  * @maxLength 100
3814
3573
  */
3815
3574
  orderId?: string;
3816
3575
  }
3817
- interface SendMerchantOrderReceivedPushResponse {
3576
+ export interface SendMerchantOrderReceivedPushResponse {
3818
3577
  }
3819
- interface PreviewEmailByTypeRequest {
3578
+ export interface PreviewEmailByTypeRequest {
3820
3579
  emailType?: PreviewEmailType;
3821
3580
  }
3822
- declare enum PreviewEmailType {
3581
+ export declare enum PreviewEmailType {
3823
3582
  ORDER_PLACED = "ORDER_PLACED",
3824
3583
  DOWNLOAD_LINKS = "DOWNLOAD_LINKS",
3825
3584
  ORDER_SHIPPED = "ORDER_SHIPPED",
3826
3585
  ORDER_READY_FOR_PICKUP = "ORDER_READY_FOR_PICKUP"
3827
3586
  }
3828
- interface PreviewEmailByTypeResponse {
3587
+ export interface PreviewEmailByTypeResponse {
3829
3588
  emailPreview?: string;
3830
3589
  }
3831
- interface PreviewRefundEmailRequest {
3590
+ export interface PreviewRefundEmailRequest {
3832
3591
  /**
3833
3592
  * @minLength 1
3834
3593
  * @maxLength 100
@@ -3850,10 +3609,10 @@ interface PreviewRefundEmailRequest {
3850
3609
  */
3851
3610
  refundId?: string | null;
3852
3611
  }
3853
- interface PreviewRefundEmailResponse {
3612
+ export interface PreviewRefundEmailResponse {
3854
3613
  emailPreview?: string;
3855
3614
  }
3856
- interface PreviewCancelEmailRequest {
3615
+ export interface PreviewCancelEmailRequest {
3857
3616
  /**
3858
3617
  * @minLength 1
3859
3618
  * @maxLength 100
@@ -3866,10 +3625,10 @@ interface PreviewCancelEmailRequest {
3866
3625
  */
3867
3626
  customMessage?: string | null;
3868
3627
  }
3869
- interface PreviewCancelEmailResponse {
3628
+ export interface PreviewCancelEmailResponse {
3870
3629
  emailPreview?: string;
3871
3630
  }
3872
- interface PreviewCancelRefundEmailRequest {
3631
+ export interface PreviewCancelRefundEmailRequest {
3873
3632
  /**
3874
3633
  * @minLength 1
3875
3634
  * @maxLength 100
@@ -3889,35 +3648,35 @@ interface PreviewCancelRefundEmailRequest {
3889
3648
  */
3890
3649
  refundId?: string | null;
3891
3650
  }
3892
- interface PreviewCancelRefundEmailResponse {
3651
+ export interface PreviewCancelRefundEmailResponse {
3893
3652
  emailPreview?: string;
3894
3653
  }
3895
- interface PreviewBuyerPaymentsReceivedEmailRequest {
3654
+ export interface PreviewBuyerPaymentsReceivedEmailRequest {
3896
3655
  }
3897
- interface PreviewBuyerPaymentsReceivedEmailResponse {
3656
+ export interface PreviewBuyerPaymentsReceivedEmailResponse {
3898
3657
  emailPreview?: string;
3899
3658
  }
3900
- interface PreviewBuyerConfirmationEmailRequest {
3659
+ export interface PreviewBuyerConfirmationEmailRequest {
3901
3660
  }
3902
- interface PreviewBuyerConfirmationEmailResponse {
3661
+ export interface PreviewBuyerConfirmationEmailResponse {
3903
3662
  emailPreview?: string;
3904
3663
  }
3905
- interface PreviewBuyerPickupConfirmationEmailRequest {
3664
+ export interface PreviewBuyerPickupConfirmationEmailRequest {
3906
3665
  }
3907
- interface PreviewBuyerPickupConfirmationEmailResponse {
3666
+ export interface PreviewBuyerPickupConfirmationEmailResponse {
3908
3667
  emailPreview?: string;
3909
3668
  }
3910
- interface PreviewShippingConfirmationEmailRequest {
3669
+ export interface PreviewShippingConfirmationEmailRequest {
3911
3670
  }
3912
- interface PreviewShippingConfirmationEmailResponse {
3671
+ export interface PreviewShippingConfirmationEmailResponse {
3913
3672
  emailPreview?: string;
3914
3673
  }
3915
- interface PreviewResendDownloadLinksEmailRequest {
3674
+ export interface PreviewResendDownloadLinksEmailRequest {
3916
3675
  }
3917
- interface PreviewResendDownloadLinksEmailResponse {
3676
+ export interface PreviewResendDownloadLinksEmailResponse {
3918
3677
  emailPreview?: string;
3919
3678
  }
3920
- interface TriggerReindexOrderRequest {
3679
+ export interface TriggerReindexOrderRequest {
3921
3680
  /** @format GUID */
3922
3681
  metasiteId?: string;
3923
3682
  /**
@@ -3926,18 +3685,18 @@ interface TriggerReindexOrderRequest {
3926
3685
  */
3927
3686
  orderId?: string;
3928
3687
  }
3929
- interface SnapshotMessage {
3688
+ export interface SnapshotMessage {
3930
3689
  _id?: string;
3931
3690
  opType?: number;
3932
3691
  }
3933
- interface GetMetasiteDataRequest {
3692
+ export interface GetMetasiteDataRequest {
3934
3693
  /**
3935
3694
  * meta site Id for data to retrieve
3936
3695
  * @format GUID
3937
3696
  */
3938
3697
  metasiteId?: string;
3939
3698
  }
3940
- interface GetMetasiteDataResponse {
3699
+ export interface GetMetasiteDataResponse {
3941
3700
  /** meta site data */
3942
3701
  metasite?: MetaSite;
3943
3702
  /** is metasite added to new SDL population via population manager */
@@ -3955,7 +3714,7 @@ interface GetMetasiteDataResponse {
3955
3714
  *
3956
3715
  * We prefer to pronounce it as 2 separate words, therefore we use terms "meta site" or "metaSite" or "meta_site" in code.
3957
3716
  */
3958
- interface MetaSite {
3717
+ export interface MetaSite {
3959
3718
  /**
3960
3719
  * Identifier of meta site.
3961
3720
  * @format GUID
@@ -4076,7 +3835,7 @@ interface MetaSite {
4076
3835
  */
4077
3836
  accountCreatedDate?: Date | null;
4078
3837
  }
4079
- interface App {
3838
+ export interface App {
4080
3839
  /**
4081
3840
  * Identifier of application type (application definition id).
4082
3841
  *
@@ -4111,7 +3870,7 @@ interface App {
4111
3870
  * Represents the actual state of the application on site. Do not confuse with the State in the old MetaSiteDTO,
4112
3871
  * which has less values and doesn't have 1-to-1 correspondence with this one (this one is exact and correct!)
4113
3872
  */
4114
- declare enum State {
3873
+ export declare enum State {
4115
3874
  UNKNOWN = "UNKNOWN",
4116
3875
  /** App is installed on a site. */
4117
3876
  ENABLED = "ENABLED",
@@ -4122,7 +3881,7 @@ declare enum State {
4122
3881
  /** App is not installed, there is a user intention for it only (user will see the pimpl in the editor). */
4123
3882
  PENDING = "PENDING"
4124
3883
  }
4125
- declare enum Namespace {
3884
+ export declare enum Namespace {
4126
3885
  UNKNOWN_NAMESPACE = "UNKNOWN_NAMESPACE",
4127
3886
  /** Default namespace for UGC sites. MetaSites with this namespace will be shown in a user's site list by default. */
4128
3887
  WIX = "WIX",
@@ -4204,7 +3963,7 @@ declare enum Namespace {
4204
3963
  /** MIMIR - Siteless account for MIMIR Ai Job runner. */
4205
3964
  MIMIR = "MIMIR"
4206
3965
  }
4207
- interface SeoData {
3966
+ export interface SeoData {
4208
3967
  /**
4209
3968
  * A title.
4210
3969
  * @maxLength 255
@@ -4230,7 +3989,7 @@ interface SeoData {
4230
3989
  */
4231
3990
  canonicalUrl?: string | null;
4232
3991
  }
4233
- interface MetaTag {
3992
+ export interface MetaTag {
4234
3993
  /**
4235
3994
  * A name.
4236
3995
  * @maxLength 50
@@ -4245,7 +4004,7 @@ interface MetaTag {
4245
4004
  property?: boolean;
4246
4005
  }
4247
4006
  /** Represents an HTML application (HTML site). */
4248
- interface HtmlApplication {
4007
+ export interface HtmlApplication {
4249
4008
  /** Legacy, don't use it if you can. */
4250
4009
  intId?: number;
4251
4010
  /** Identifier of the instance. */
@@ -4260,7 +4019,7 @@ interface HtmlApplication {
4260
4019
  /** Indicates whether this site is managed by Wix Studio. */
4261
4020
  studio?: boolean;
4262
4021
  }
4263
- interface ExternalUriMapping {
4022
+ export interface ExternalUriMapping {
4264
4023
  /**
4265
4024
  * Deprecated.
4266
4025
  * @maxLength 255
@@ -4279,7 +4038,7 @@ interface ExternalUriMapping {
4279
4038
  /** Deprecated. */
4280
4039
  requireDomain?: boolean | null;
4281
4040
  }
4282
- interface UserDataResponse {
4041
+ export interface UserDataResponse {
4283
4042
  userEmail?: string;
4284
4043
  /** owner name */
4285
4044
  userName?: string;
@@ -4288,7 +4047,7 @@ interface UserDataResponse {
4288
4047
  /** owner language */
4289
4048
  userLanguage?: string;
4290
4049
  }
4291
- interface QueryOrdersForMetasiteRequest {
4050
+ export interface QueryOrdersForMetasiteRequest {
4292
4051
  /**
4293
4052
  * meta site Id for EP orders to retrieve
4294
4053
  * @format GUID
@@ -4297,11 +4056,11 @@ interface QueryOrdersForMetasiteRequest {
4297
4056
  /** paginated internal orders query request */
4298
4057
  internalQueryOrdersRequest?: InternalQueryOrdersRequest;
4299
4058
  }
4300
- interface InternalQueryOrdersRequest {
4059
+ export interface InternalQueryOrdersRequest {
4301
4060
  /** Query options. */
4302
4061
  query?: PlatformQuery;
4303
4062
  }
4304
- interface PlatformQuery extends PlatformQueryPagingMethodOneOf {
4063
+ export interface PlatformQuery extends PlatformQueryPagingMethodOneOf {
4305
4064
  /** Pointer to page of results using offset. Cannot be used together with `cursorPaging`. */
4306
4065
  paging?: PlatformPaging;
4307
4066
  /** Cursor pointing to page of results. Cannot be used together with `paging`. `cursorPaging.cursor` can not be used together with `filter` or `sort`. */
@@ -4312,13 +4071,13 @@ interface PlatformQuery extends PlatformQueryPagingMethodOneOf {
4312
4071
  sort?: Sorting[];
4313
4072
  }
4314
4073
  /** @oneof */
4315
- interface PlatformQueryPagingMethodOneOf {
4074
+ export interface PlatformQueryPagingMethodOneOf {
4316
4075
  /** Pointer to page of results using offset. Cannot be used together with `cursorPaging`. */
4317
4076
  paging?: PlatformPaging;
4318
4077
  /** Cursor pointing to page of results. Cannot be used together with `paging`. `cursorPaging.cursor` can not be used together with `filter` or `sort`. */
4319
4078
  cursorPaging?: CursorPaging;
4320
4079
  }
4321
- interface Sorting {
4080
+ export interface Sorting {
4322
4081
  /**
4323
4082
  * Name of the field to sort by.
4324
4083
  * @maxLength 512
@@ -4327,11 +4086,11 @@ interface Sorting {
4327
4086
  /** Sort order. */
4328
4087
  order?: SortOrder;
4329
4088
  }
4330
- declare enum SortOrder {
4089
+ export declare enum SortOrder {
4331
4090
  ASC = "ASC",
4332
4091
  DESC = "DESC"
4333
4092
  }
4334
- interface PlatformPaging {
4093
+ export interface PlatformPaging {
4335
4094
  /**
4336
4095
  * Number of items to load.
4337
4096
  * @max 100
@@ -4340,7 +4099,7 @@ interface PlatformPaging {
4340
4099
  /** Number of items to skip in the current sort order. */
4341
4100
  offset?: number | null;
4342
4101
  }
4343
- interface CursorPaging {
4102
+ export interface CursorPaging {
4344
4103
  /**
4345
4104
  * Maximum number of items to return in the results.
4346
4105
  * @max 100
@@ -4355,13 +4114,13 @@ interface CursorPaging {
4355
4114
  */
4356
4115
  cursor?: string | null;
4357
4116
  }
4358
- interface QueryOrdersForMetasiteResponse {
4117
+ export interface QueryOrdersForMetasiteResponse {
4359
4118
  /** found exisitng orders according to pagination and query provided. */
4360
4119
  orders?: Order[];
4361
4120
  /** Details on the paged set of results returned. */
4362
4121
  pagingMetadata?: PlatformPagingMetadata;
4363
4122
  }
4364
- interface PlatformPagingMetadata {
4123
+ export interface PlatformPagingMetadata {
4365
4124
  /** The number of items returned in this response. */
4366
4125
  count?: number | null;
4367
4126
  /** The offset which was requested. Returned if offset paging was used. */
@@ -4371,7 +4130,7 @@ interface PlatformPagingMetadata {
4371
4130
  /** Cursors to navigate through result pages. Returned if cursor paging was used. */
4372
4131
  cursors?: Cursors;
4373
4132
  }
4374
- interface Cursors {
4133
+ export interface Cursors {
4375
4134
  /**
4376
4135
  * Cursor string pointing to the next page in the list of results.
4377
4136
  * @maxLength 16000
@@ -4383,7 +4142,7 @@ interface Cursors {
4383
4142
  */
4384
4143
  prev?: string | null;
4385
4144
  }
4386
- interface GetOrderForMetasiteRequest {
4145
+ export interface GetOrderForMetasiteRequest {
4387
4146
  /**
4388
4147
  * meta site Id for EP order to retrieve
4389
4148
  * @format GUID
@@ -4396,11 +4155,11 @@ interface GetOrderForMetasiteRequest {
4396
4155
  */
4397
4156
  orderId?: string;
4398
4157
  }
4399
- interface GetOrderForMetasiteResponse {
4158
+ export interface GetOrderForMetasiteResponse {
4400
4159
  /** Existing EP order */
4401
4160
  order?: Order;
4402
4161
  }
4403
- interface ListOrderTransactionsForMetasiteRequest {
4162
+ export interface ListOrderTransactionsForMetasiteRequest {
4404
4163
  /**
4405
4164
  * meta site Id for EP order transactions to retrieve
4406
4165
  * @format GUID
@@ -4412,11 +4171,11 @@ interface ListOrderTransactionsForMetasiteRequest {
4412
4171
  */
4413
4172
  orderId?: string;
4414
4173
  }
4415
- interface ListOrderTransactionsForMetasiteResponse {
4174
+ export interface ListOrderTransactionsForMetasiteResponse {
4416
4175
  /** Order ID and its associated transactions. */
4417
4176
  orderTransactions?: OrderTransactions;
4418
4177
  }
4419
- interface UpsertRefundRequest {
4178
+ export interface UpsertRefundRequest {
4420
4179
  /**
4421
4180
  * Meta site ID.
4422
4181
  * @format GUID
@@ -4430,11 +4189,11 @@ interface UpsertRefundRequest {
4430
4189
  /** Refund to upsert. */
4431
4190
  refund?: Refund;
4432
4191
  }
4433
- interface UpsertRefundResponse {
4192
+ export interface UpsertRefundResponse {
4434
4193
  /** Updated order transactions. */
4435
4194
  orderTransactions?: OrderTransactions;
4436
4195
  }
4437
- interface UpdateInternalDocumentsEvent extends UpdateInternalDocumentsEventOperationOneOf {
4196
+ export interface UpdateInternalDocumentsEvent extends UpdateInternalDocumentsEventOperationOneOf {
4438
4197
  /** insert/update documents */
4439
4198
  update?: InternalDocumentUpdateOperation;
4440
4199
  /** delete by document ids */
@@ -4475,7 +4234,7 @@ interface UpdateInternalDocumentsEvent extends UpdateInternalDocumentsEventOpera
4475
4234
  issuedAt?: Date | null;
4476
4235
  }
4477
4236
  /** @oneof */
4478
- interface UpdateInternalDocumentsEventOperationOneOf {
4237
+ export interface UpdateInternalDocumentsEventOperationOneOf {
4479
4238
  /** insert/update documents */
4480
4239
  update?: InternalDocumentUpdateOperation;
4481
4240
  /** delete by document ids */
@@ -4491,39 +4250,39 @@ interface UpdateInternalDocumentsEventOperationOneOf {
4491
4250
  /** delete by document ids with versioning */
4492
4251
  versionedDeleteByIds?: VersionedDeleteByIdsOperation;
4493
4252
  }
4494
- interface InternalDocument {
4253
+ export interface InternalDocument {
4495
4254
  /** document with mandatory fields (id) and with fields specific to the type of the document */
4496
4255
  document?: Record<string, any> | null;
4497
4256
  }
4498
- interface InternalDocumentUpdateOperation {
4257
+ export interface InternalDocumentUpdateOperation {
4499
4258
  /** documents to index or update */
4500
4259
  documents?: InternalDocument[];
4501
4260
  }
4502
- interface DeleteByIdsOperation {
4261
+ export interface DeleteByIdsOperation {
4503
4262
  /** ids of the documents to delete */
4504
4263
  documentIds?: string[];
4505
4264
  }
4506
- interface DeleteByFilterOperation {
4265
+ export interface DeleteByFilterOperation {
4507
4266
  /** documents matching this filter wil be deleted. only filterable documents defined in document_type can be used for filtering */
4508
4267
  filter?: Record<string, any> | null;
4509
4268
  }
4510
- interface InternalDocumentUpdateByFilterOperation {
4269
+ export interface InternalDocumentUpdateByFilterOperation {
4511
4270
  /** documents matching this filter will be updated */
4512
4271
  filter?: Record<string, any> | null;
4513
4272
  /** partial document to apply */
4514
4273
  document?: InternalDocument;
4515
4274
  }
4516
- interface InternalUpdateExistingOperation {
4275
+ export interface InternalUpdateExistingOperation {
4517
4276
  /** documents to update */
4518
4277
  documents?: InternalDocument[];
4519
4278
  }
4520
- interface VersionedDocumentUpdateOperation {
4279
+ export interface VersionedDocumentUpdateOperation {
4521
4280
  /** documents to create or overwrite */
4522
4281
  documents?: InternalDocument[];
4523
4282
  /** versioning mode to use instead of default */
4524
4283
  versioningMode?: VersioningMode;
4525
4284
  }
4526
- declare enum VersioningMode {
4285
+ export declare enum VersioningMode {
4527
4286
  /** use default versioning mode agreed with search team */
4528
4287
  DEFAULT = "DEFAULT",
4529
4288
  /** execute only if version is greater than existing */
@@ -4531,11 +4290,11 @@ declare enum VersioningMode {
4531
4290
  /** execute only if version is greater or equal to existing */
4532
4291
  GREATER_OR_EQUAL = "GREATER_OR_EQUAL"
4533
4292
  }
4534
- interface VersionedDeleteByIdsOperation {
4293
+ export interface VersionedDeleteByIdsOperation {
4535
4294
  /** ids with version of the documents to delete */
4536
4295
  documentIds?: VersionedDocumentId[];
4537
4296
  }
4538
- interface VersionedDocumentId {
4297
+ export interface VersionedDocumentId {
4539
4298
  /** document id */
4540
4299
  documentId?: string;
4541
4300
  /** document version */
@@ -4543,7 +4302,7 @@ interface VersionedDocumentId {
4543
4302
  /** versioning mode to use instead of default */
4544
4303
  versioningMode?: VersioningMode;
4545
4304
  }
4546
- interface TriggerReindexRequest {
4305
+ export interface TriggerReindexRequest {
4547
4306
  /** @format GUID */
4548
4307
  metasiteId?: string;
4549
4308
  /**
@@ -4553,13 +4312,13 @@ interface TriggerReindexRequest {
4553
4312
  */
4554
4313
  orderIds?: string[];
4555
4314
  }
4556
- interface TriggerReindexResponse {
4315
+ export interface TriggerReindexResponse {
4557
4316
  }
4558
- interface BatchOfTriggerReindexOrderRequest {
4317
+ export interface BatchOfTriggerReindexOrderRequest {
4559
4318
  /** @maxSize 25 */
4560
4319
  requests?: TriggerReindexOrderRequest[];
4561
4320
  }
4562
- interface DiffmatokyPayload {
4321
+ export interface DiffmatokyPayload {
4563
4322
  left?: string;
4564
4323
  right?: string;
4565
4324
  compareChannel?: string;
@@ -4567,20 +4326,20 @@ interface DiffmatokyPayload {
4567
4326
  errorInformation?: ErrorInformation;
4568
4327
  tags?: string[];
4569
4328
  }
4570
- interface ErrorInformation {
4329
+ export interface ErrorInformation {
4571
4330
  stackTrace?: string;
4572
4331
  }
4573
- interface ContinueSideEffectsFlowInLegacyData {
4332
+ export interface ContinueSideEffectsFlowInLegacyData {
4574
4333
  storeId?: string;
4575
4334
  orderId?: string;
4576
4335
  ordersExperiments?: OrdersExperiments;
4577
4336
  }
4578
- interface IndexingMessage {
4337
+ export interface IndexingMessage {
4579
4338
  _id?: string;
4580
4339
  opType?: number;
4581
4340
  requiredVersions?: string[];
4582
4341
  }
4583
- interface GetOrderRequest {
4342
+ export interface GetOrderRequest {
4584
4343
  /**
4585
4344
  * ID of the order to retrieve.
4586
4345
  * @minLength 1
@@ -4588,31 +4347,31 @@ interface GetOrderRequest {
4588
4347
  */
4589
4348
  _id: string;
4590
4349
  }
4591
- interface GetOrderResponse {
4350
+ export interface GetOrderResponse {
4592
4351
  /** The requested order. */
4593
4352
  order?: Order;
4594
4353
  }
4595
- interface InternalQueryOrdersResponse {
4354
+ export interface InternalQueryOrdersResponse {
4596
4355
  /** List of orders. */
4597
4356
  orders?: Order[];
4598
4357
  /** Details on the paged set of results returned. */
4599
4358
  metadata?: PlatformPagingMetadata;
4600
4359
  }
4601
- interface QueryOrderRequest {
4360
+ export interface QueryOrderRequest {
4602
4361
  /** Query options. */
4603
4362
  query?: PlatformQuery;
4604
4363
  }
4605
- interface QueryOrderResponse {
4364
+ export interface QueryOrderResponse {
4606
4365
  /** List of orders. */
4607
4366
  orders?: Order[];
4608
4367
  /** Details on the paged set of results returned. */
4609
4368
  metadata?: PlatformPagingMetadata;
4610
4369
  }
4611
- interface SearchOrdersRequest {
4370
+ export interface SearchOrdersRequest {
4612
4371
  /** Search options. */
4613
4372
  search?: CursorSearch;
4614
4373
  }
4615
- interface CursorSearch extends CursorSearchPagingMethodOneOf {
4374
+ export interface CursorSearch extends CursorSearchPagingMethodOneOf {
4616
4375
  /**
4617
4376
  * Cursor paging options.
4618
4377
  * Learn more about [cursor paging](https://dev.wix.com/docs/rest/articles/getting-started/api-query-language#cursor-paging).
@@ -4641,20 +4400,20 @@ interface CursorSearch extends CursorSearchPagingMethodOneOf {
4641
4400
  sort?: Sorting[];
4642
4401
  }
4643
4402
  /** @oneof */
4644
- interface CursorSearchPagingMethodOneOf {
4403
+ export interface CursorSearchPagingMethodOneOf {
4645
4404
  /**
4646
4405
  * Cursor paging options.
4647
4406
  * Learn more about [cursor paging](https://dev.wix.com/docs/rest/articles/getting-started/api-query-language#cursor-paging).
4648
4407
  */
4649
4408
  cursorPaging?: CursorPaging;
4650
4409
  }
4651
- interface SearchOrdersResponse {
4410
+ export interface SearchOrdersResponse {
4652
4411
  /** List of orders. */
4653
4412
  orders?: Order[];
4654
4413
  /** Details on the paged set of results returned. */
4655
4414
  metadata?: CursorPagingMetadata;
4656
4415
  }
4657
- interface CursorPagingMetadata {
4416
+ export interface CursorPagingMetadata {
4658
4417
  /** Number of items returned in current page. */
4659
4418
  count?: number | null;
4660
4419
  /** Cursor strings that point to the next page, previous page, or both. */
@@ -4667,13 +4426,13 @@ interface CursorPagingMetadata {
4667
4426
  */
4668
4427
  hasNext?: boolean | null;
4669
4428
  }
4670
- interface CreateOrderRequest {
4429
+ export interface CreateOrderRequest {
4671
4430
  /** Order info. */
4672
4431
  order: Order;
4673
4432
  /** Determine order lifecycle */
4674
4433
  settings?: OrderCreationSettings;
4675
4434
  }
4676
- interface OrderCreationSettings {
4435
+ export interface OrderCreationSettings {
4677
4436
  /**
4678
4437
  * Condition for the order to be approved.
4679
4438
  * Default: `DEFAULT`
@@ -4682,7 +4441,7 @@ interface OrderCreationSettings {
4682
4441
  /** Notification settings to be applied on order creation */
4683
4442
  notifications?: OrderCreateNotifications;
4684
4443
  }
4685
- declare enum OrderApprovalStrategy {
4444
+ export declare enum OrderApprovalStrategy {
4686
4445
  /** Order is automatically approved when `order.priceSummary.total = 0`, **or** after receiving payment. */
4687
4446
  DEFAULT = "DEFAULT",
4688
4447
  /** Order is automatically approved **only** after receiving payment. */
@@ -4690,7 +4449,7 @@ declare enum OrderApprovalStrategy {
4690
4449
  /** Order is automatically approved when payment method is saved for it. */
4691
4450
  PAYMENT_METHOD_SAVED = "PAYMENT_METHOD_SAVED"
4692
4451
  }
4693
- interface OrderCreateNotifications {
4452
+ export interface OrderCreateNotifications {
4694
4453
  /**
4695
4454
  * Whether to send notification to the buyer.
4696
4455
  *
@@ -4704,19 +4463,19 @@ interface OrderCreateNotifications {
4704
4463
  */
4705
4464
  sendNotificationsToBusiness?: boolean | null;
4706
4465
  }
4707
- interface CreateOrderResponse {
4466
+ export interface CreateOrderResponse {
4708
4467
  /** Newly created order. */
4709
4468
  order?: Order;
4710
4469
  }
4711
- interface UpdateOrderRequest {
4470
+ export interface UpdateOrderRequest {
4712
4471
  /** Order to be updated. */
4713
4472
  order: Order;
4714
4473
  }
4715
- interface UpdateOrderResponse {
4474
+ export interface UpdateOrderResponse {
4716
4475
  /** Newly created order. */
4717
4476
  order?: Order;
4718
4477
  }
4719
- interface BulkUpdateOrdersRequest {
4478
+ export interface BulkUpdateOrdersRequest {
4720
4479
  /**
4721
4480
  * Orders to update.
4722
4481
  * @minSize 1
@@ -4730,11 +4489,11 @@ interface BulkUpdateOrdersRequest {
4730
4489
  */
4731
4490
  returnEntity?: boolean;
4732
4491
  }
4733
- interface MaskedOrder {
4492
+ export interface MaskedOrder {
4734
4493
  /** Order to be updated. */
4735
4494
  order?: Order;
4736
4495
  }
4737
- interface BulkUpdateOrdersResponse {
4496
+ export interface BulkUpdateOrdersResponse {
4738
4497
  /**
4739
4498
  * Bulk action results.
4740
4499
  * @minSize 1
@@ -4744,7 +4503,7 @@ interface BulkUpdateOrdersResponse {
4744
4503
  /** Bulk action metadata. */
4745
4504
  bulkActionMetadata?: BulkActionMetadata;
4746
4505
  }
4747
- interface CommitDeltasRequest {
4506
+ export interface CommitDeltasRequest {
4748
4507
  /** Order id to be updated */
4749
4508
  _id: string;
4750
4509
  /**
@@ -4763,41 +4522,11 @@ interface CommitDeltasRequest {
4763
4522
  */
4764
4523
  reason?: string | null;
4765
4524
  }
4766
- interface DraftOrderDiffs extends DraftOrderDiffsShippingUpdateInfoOneOf, DraftOrderDiffsBuyerUpdateInfoOneOf, DraftOrderDiffsBillingUpdateInfoOneOf, DraftOrderDiffsRecipientUpdateInfoOneOf {
4525
+ export interface DraftOrderDiffs extends DraftOrderDiffsShippingUpdateInfoOneOf, DraftOrderDiffsBuyerUpdateInfoOneOf, DraftOrderDiffsBillingUpdateInfoOneOf, DraftOrderDiffsRecipientUpdateInfoOneOf {
4767
4526
  /** Shipping info and selected shipping option details. */
4768
4527
  changedShippingInfo?: V1ShippingInformation;
4769
4528
  /** Remove existing shipping info. */
4770
4529
  shippingInfoRemoved?: boolean;
4771
- /**
4772
- * Buyer info and selected buyer option details.
4773
- * @internal
4774
- */
4775
- changedBuyerInfo?: BuyerInfo;
4776
- /**
4777
- * Remove existing buyer info.
4778
- * @internal
4779
- */
4780
- buyerInfoRemoved?: boolean;
4781
- /**
4782
- * Updated billing info.
4783
- * @internal
4784
- */
4785
- changedBillingInfo?: AddressWithContact;
4786
- /**
4787
- * Remove existing billing info.
4788
- * @internal
4789
- */
4790
- billingInfoRemoved?: boolean;
4791
- /**
4792
- * Updated recipient info.
4793
- * @internal
4794
- */
4795
- changedRecipientInfo?: AddressWithContact;
4796
- /**
4797
- * Remove existing recipient info.
4798
- * @internal
4799
- */
4800
- recipientInfoRemoved?: boolean;
4801
4530
  /**
4802
4531
  * Added/updated/removed order line items.
4803
4532
  * @maxSize 300
@@ -4831,52 +4560,22 @@ interface DraftOrderDiffs extends DraftOrderDiffsShippingUpdateInfoOneOf, DraftO
4831
4560
  priceSummary?: PriceSummary;
4832
4561
  }
4833
4562
  /** @oneof */
4834
- interface DraftOrderDiffsShippingUpdateInfoOneOf {
4563
+ export interface DraftOrderDiffsShippingUpdateInfoOneOf {
4835
4564
  /** Shipping info and selected shipping option details. */
4836
4565
  changedShippingInfo?: V1ShippingInformation;
4837
4566
  /** Remove existing shipping info. */
4838
4567
  shippingInfoRemoved?: boolean;
4839
4568
  }
4840
4569
  /** @oneof */
4841
- interface DraftOrderDiffsBuyerUpdateInfoOneOf {
4842
- /**
4843
- * Buyer info and selected buyer option details.
4844
- * @internal
4845
- */
4846
- changedBuyerInfo?: BuyerInfo;
4847
- /**
4848
- * Remove existing buyer info.
4849
- * @internal
4850
- */
4851
- buyerInfoRemoved?: boolean;
4570
+ export interface DraftOrderDiffsBuyerUpdateInfoOneOf {
4852
4571
  }
4853
4572
  /** @oneof */
4854
- interface DraftOrderDiffsBillingUpdateInfoOneOf {
4855
- /**
4856
- * Updated billing info.
4857
- * @internal
4858
- */
4859
- changedBillingInfo?: AddressWithContact;
4860
- /**
4861
- * Remove existing billing info.
4862
- * @internal
4863
- */
4864
- billingInfoRemoved?: boolean;
4573
+ export interface DraftOrderDiffsBillingUpdateInfoOneOf {
4865
4574
  }
4866
4575
  /** @oneof */
4867
- interface DraftOrderDiffsRecipientUpdateInfoOneOf {
4868
- /**
4869
- * Updated recipient info.
4870
- * @internal
4871
- */
4872
- changedRecipientInfo?: AddressWithContact;
4873
- /**
4874
- * Remove existing recipient info.
4875
- * @internal
4876
- */
4877
- recipientInfoRemoved?: boolean;
4576
+ export interface DraftOrderDiffsRecipientUpdateInfoOneOf {
4878
4577
  }
4879
- interface V1LineItemDelta extends V1LineItemDeltaDeltaOneOf {
4578
+ export interface V1LineItemDelta extends V1LineItemDeltaDeltaOneOf {
4880
4579
  /** The line item was added. */
4881
4580
  lineItemAdded?: boolean;
4882
4581
  /** The line item was modified. */
@@ -4891,7 +4590,7 @@ interface V1LineItemDelta extends V1LineItemDeltaDeltaOneOf {
4891
4590
  lineItem?: OrderLineItemChangedDetails;
4892
4591
  }
4893
4592
  /** @oneof */
4894
- interface V1LineItemDeltaDeltaOneOf {
4593
+ export interface V1LineItemDeltaDeltaOneOf {
4895
4594
  /** The line item was added. */
4896
4595
  lineItemAdded?: boolean;
4897
4596
  /** The line item was modified. */
@@ -4899,7 +4598,7 @@ interface V1LineItemDeltaDeltaOneOf {
4899
4598
  /** The line item was added. */
4900
4599
  lineItemRemoved?: boolean;
4901
4600
  }
4902
- interface OrderLineItemChangedDetails {
4601
+ export interface OrderLineItemChangedDetails {
4903
4602
  /**
4904
4603
  * Item name.
4905
4604
  * + Stores - `product.name`
@@ -4974,17 +4673,11 @@ interface OrderLineItemChangedDetails {
4974
4673
  * @maxSize 5
4975
4674
  */
4976
4675
  locations?: LocationAndQuantity[];
4977
- /**
4978
- * ID of the app managing the inventory.
4979
- * @internal
4980
- * @format GUID
4981
- */
4982
- inventoryAppId?: string | null;
4983
4676
  /** Subscription info. */
4984
4677
  subscriptionInfo?: SubscriptionInfo;
4985
4678
  }
4986
4679
  /** Type of selected payment option for catalog item */
4987
- declare enum DeltaPaymentOptionType {
4680
+ export declare enum DeltaPaymentOptionType {
4988
4681
  /** Irrelevant */
4989
4682
  UNKNOWN_PAYMENT_OPTION = "UNKNOWN_PAYMENT_OPTION",
4990
4683
  /** The entire payment for the given item will happen after checkout. */
@@ -4995,7 +4688,7 @@ declare enum DeltaPaymentOptionType {
4995
4688
  */
4996
4689
  MEMBERSHIP_OFFLINE = "MEMBERSHIP_OFFLINE"
4997
4690
  }
4998
- interface ItemChangedDetails {
4691
+ export interface ItemChangedDetails {
4999
4692
  /**
5000
4693
  * The quantity before the change.
5001
4694
  * @min 1
@@ -5007,7 +4700,7 @@ interface ItemChangedDetails {
5007
4700
  /** The price description before the change */
5008
4701
  priceDescriptionBeforeChange?: PriceDescription;
5009
4702
  }
5010
- interface AppliedDiscountDelta extends AppliedDiscountDeltaDeltaOneOf {
4703
+ export interface AppliedDiscountDelta extends AppliedDiscountDeltaDeltaOneOf {
5011
4704
  editedDiscount?: AppliedDiscount;
5012
4705
  discountRemoved?: boolean;
5013
4706
  /**
@@ -5017,11 +4710,11 @@ interface AppliedDiscountDelta extends AppliedDiscountDeltaDeltaOneOf {
5017
4710
  discountId?: string;
5018
4711
  }
5019
4712
  /** @oneof */
5020
- interface AppliedDiscountDeltaDeltaOneOf {
4713
+ export interface AppliedDiscountDeltaDeltaOneOf {
5021
4714
  editedDiscount?: AppliedDiscount;
5022
4715
  discountRemoved?: boolean;
5023
4716
  }
5024
- interface AdditionalFeeDelta extends AdditionalFeeDeltaDeltaOneOf {
4717
+ export interface AdditionalFeeDelta extends AdditionalFeeDeltaDeltaOneOf {
5025
4718
  editedAdditionalFee?: AdditionalFee;
5026
4719
  additionalFeeRemoved?: boolean;
5027
4720
  /**
@@ -5031,11 +4724,11 @@ interface AdditionalFeeDelta extends AdditionalFeeDeltaDeltaOneOf {
5031
4724
  additionalFeeId?: string;
5032
4725
  }
5033
4726
  /** @oneof */
5034
- interface AdditionalFeeDeltaDeltaOneOf {
4727
+ export interface AdditionalFeeDeltaDeltaOneOf {
5035
4728
  editedAdditionalFee?: AdditionalFee;
5036
4729
  additionalFeeRemoved?: boolean;
5037
4730
  }
5038
- interface DraftOrderCommitSettings {
4731
+ export interface DraftOrderCommitSettings {
5039
4732
  /** If false, do not send notifications to buyer. Default is true. */
5040
4733
  sendNotificationsToBuyer?: boolean | null;
5041
4734
  /** If false, do not send notifications to business. Default is true. */
@@ -5050,7 +4743,7 @@ interface DraftOrderCommitSettings {
5050
4743
  */
5051
4744
  inventoryUpdates?: InventoryUpdateDetails[];
5052
4745
  }
5053
- interface InventoryUpdateDetails {
4746
+ export interface InventoryUpdateDetails {
5054
4747
  /** Action to be applied - decrease or restock */
5055
4748
  actionType?: InventoryAction;
5056
4749
  /** Order line item id */
@@ -5058,18 +4751,18 @@ interface InventoryUpdateDetails {
5058
4751
  /** The amount to be increased or restocked */
5059
4752
  quantityChange?: number;
5060
4753
  }
5061
- declare enum InventoryAction {
4754
+ export declare enum InventoryAction {
5062
4755
  /** Restock inventory */
5063
4756
  RESTOCK = "RESTOCK",
5064
4757
  /** Decrease inventory. Without failing on negative inventory. */
5065
4758
  DECREASE = "DECREASE"
5066
4759
  }
5067
- interface CommitDeltasResponse {
4760
+ export interface CommitDeltasResponse {
5068
4761
  /** Order after deltas are applied */
5069
4762
  order?: Order;
5070
4763
  }
5071
4764
  /** Triggered when order is edited by draftOrders */
5072
- interface OrderDeltasCommitted {
4765
+ export interface OrderDeltasCommitted {
5073
4766
  /** The order after committed changes. */
5074
4767
  order?: Order;
5075
4768
  /** Draft order Id representing this change. */
@@ -5084,7 +4777,7 @@ interface OrderDeltasCommitted {
5084
4777
  */
5085
4778
  commitDate?: Date | null;
5086
4779
  }
5087
- interface CommittedDiffs extends CommittedDiffsShippingUpdateInfoOneOf {
4780
+ export interface CommittedDiffs extends CommittedDiffsShippingUpdateInfoOneOf {
5088
4781
  /** Shipping info and selected shipping option details. */
5089
4782
  changedShippingInfo?: V1ShippingInformation;
5090
4783
  /** Remove existing shipping info. */
@@ -5106,13 +4799,13 @@ interface CommittedDiffs extends CommittedDiffsShippingUpdateInfoOneOf {
5106
4799
  additionalFees?: AdditionalFeeDelta[];
5107
4800
  }
5108
4801
  /** @oneof */
5109
- interface CommittedDiffsShippingUpdateInfoOneOf {
4802
+ export interface CommittedDiffsShippingUpdateInfoOneOf {
5110
4803
  /** Shipping info and selected shipping option details. */
5111
4804
  changedShippingInfo?: V1ShippingInformation;
5112
4805
  /** Remove existing shipping info. */
5113
4806
  shippingInfoRemoved?: boolean;
5114
4807
  }
5115
- interface LineItemDelta extends LineItemDeltaDeltaOneOf {
4808
+ export interface LineItemDelta extends LineItemDeltaDeltaOneOf {
5116
4809
  lineItemAdded?: boolean;
5117
4810
  changedDetails?: ItemChangedDetails;
5118
4811
  lineItemRemoved?: OrderLineItemChangedDetails;
@@ -5123,12 +4816,12 @@ interface LineItemDelta extends LineItemDeltaDeltaOneOf {
5123
4816
  lineItemId?: string;
5124
4817
  }
5125
4818
  /** @oneof */
5126
- interface LineItemDeltaDeltaOneOf {
4819
+ export interface LineItemDeltaDeltaOneOf {
5127
4820
  lineItemAdded?: boolean;
5128
4821
  changedDetails?: ItemChangedDetails;
5129
4822
  lineItemRemoved?: OrderLineItemChangedDetails;
5130
4823
  }
5131
- interface ArchiveOrderRequest {
4824
+ export interface ArchiveOrderRequest {
5132
4825
  /**
5133
4826
  * Order ID.
5134
4827
  * @minLength 1
@@ -5136,11 +4829,11 @@ interface ArchiveOrderRequest {
5136
4829
  */
5137
4830
  _id?: string;
5138
4831
  }
5139
- interface ArchiveOrderResponse {
4832
+ export interface ArchiveOrderResponse {
5140
4833
  /** Archived order. */
5141
4834
  order?: Order;
5142
4835
  }
5143
- interface BulkArchiveOrdersRequest {
4836
+ export interface BulkArchiveOrdersRequest {
5144
4837
  /**
5145
4838
  * IDs of orders to archive.
5146
4839
  * @minSize 1
@@ -5150,23 +4843,23 @@ interface BulkArchiveOrdersRequest {
5150
4843
  /** Whether to return the full updated order entities in the response. */
5151
4844
  returnFullEntity?: boolean;
5152
4845
  }
5153
- interface BulkArchiveOrdersResponse {
4846
+ export interface BulkArchiveOrdersResponse {
5154
4847
  /** Items updated by bulk action. */
5155
4848
  results?: BulkOrderResult[];
5156
4849
  /** Bulk action metadata. */
5157
4850
  bulkActionMetadata?: BulkActionMetadata;
5158
4851
  }
5159
- interface BulkArchiveOrdersByFilterRequest {
4852
+ export interface BulkArchiveOrdersByFilterRequest {
5160
4853
  /** Filter object. Learn more about supported filters [here](https://bo.wix.com/wix-docs/rest/ecommerce/orders/filter-and-sort). */
5161
4854
  filter?: Record<string, any> | null;
5162
4855
  }
5163
- interface BulkArchiveOrdersByFilterResponse {
4856
+ export interface BulkArchiveOrdersByFilterResponse {
5164
4857
  /** Items updated by bulk action. */
5165
4858
  results?: BulkOrderResult[];
5166
4859
  /** Bulk action metadata. */
5167
4860
  bulkActionMetadata?: BulkActionMetadata;
5168
4861
  }
5169
- interface UnArchiveOrderRequest {
4862
+ export interface UnArchiveOrderRequest {
5170
4863
  /**
5171
4864
  * Order ID.
5172
4865
  * @minLength 1
@@ -5174,11 +4867,11 @@ interface UnArchiveOrderRequest {
5174
4867
  */
5175
4868
  _id?: string;
5176
4869
  }
5177
- interface UnArchiveOrderResponse {
4870
+ export interface UnArchiveOrderResponse {
5178
4871
  /** Unarchived order. */
5179
4872
  order?: Order;
5180
4873
  }
5181
- interface BulkUnArchiveOrdersRequest {
4874
+ export interface BulkUnArchiveOrdersRequest {
5182
4875
  /**
5183
4876
  * IDs or orders to unarchive.
5184
4877
  * @minSize 1
@@ -5188,23 +4881,23 @@ interface BulkUnArchiveOrdersRequest {
5188
4881
  /** Whether to return the full updated order entities in the response. */
5189
4882
  returnFullEntity?: boolean;
5190
4883
  }
5191
- interface BulkUnArchiveOrdersResponse {
4884
+ export interface BulkUnArchiveOrdersResponse {
5192
4885
  /** Items updated by bulk action. */
5193
4886
  results?: BulkOrderResult[];
5194
4887
  /** Bulk action metadata. */
5195
4888
  bulkActionMetadata?: BulkActionMetadata;
5196
4889
  }
5197
- interface BulkUnArchiveOrdersByFilterRequest {
4890
+ export interface BulkUnArchiveOrdersByFilterRequest {
5198
4891
  /** Filter object. Learn more about supported filters [here](https://bo.wix.com/wix-docs/rest/ecommerce/orders/filter-and-sort). */
5199
4892
  filter?: Record<string, any> | null;
5200
4893
  }
5201
- interface BulkUnArchiveOrdersByFilterResponse {
4894
+ export interface BulkUnArchiveOrdersByFilterResponse {
5202
4895
  /** Items updated by bulk action. */
5203
4896
  results?: BulkOrderResult[];
5204
4897
  /** Bulk action metadata. */
5205
4898
  bulkActionMetadata?: BulkActionMetadata;
5206
4899
  }
5207
- interface UpdateBuyerInfoRequest {
4900
+ export interface UpdateBuyerInfoRequest {
5208
4901
  /**
5209
4902
  * Order ID.
5210
4903
  * @minLength 1
@@ -5215,7 +4908,7 @@ interface UpdateBuyerInfoRequest {
5215
4908
  /** Buyer info. */
5216
4909
  buyerInfo?: BuyerInfoUpdate;
5217
4910
  }
5218
- interface BuyerInfoUpdate {
4911
+ export interface BuyerInfoUpdate {
5219
4912
  /**
5220
4913
  * Contact ID.
5221
4914
  * @format GUID
@@ -5227,11 +4920,11 @@ interface BuyerInfoUpdate {
5227
4920
  */
5228
4921
  email?: string | null;
5229
4922
  }
5230
- interface UpdateBuyerInfoResponse {
4923
+ export interface UpdateBuyerInfoResponse {
5231
4924
  /** Updated order. */
5232
4925
  order?: Order;
5233
4926
  }
5234
- interface UpdateBuyerEmailRequest {
4927
+ export interface UpdateBuyerEmailRequest {
5235
4928
  /**
5236
4929
  * @minLength 1
5237
4930
  * @maxLength 100
@@ -5241,10 +4934,10 @@ interface UpdateBuyerEmailRequest {
5241
4934
  /** @format EMAIL */
5242
4935
  email?: string | null;
5243
4936
  }
5244
- interface UpdateBuyerEmailResponse {
4937
+ export interface UpdateBuyerEmailResponse {
5245
4938
  order?: Order;
5246
4939
  }
5247
- interface UpdateOrderShippingAddressRequest {
4940
+ export interface UpdateOrderShippingAddressRequest {
5248
4941
  /**
5249
4942
  * Order ID.
5250
4943
  * @minLength 1
@@ -5254,11 +4947,11 @@ interface UpdateOrderShippingAddressRequest {
5254
4947
  /** Shipping address and contact details to be updated. */
5255
4948
  shippingAddress?: AddressWithContact;
5256
4949
  }
5257
- interface UpdateOrderShippingAddressResponse {
4950
+ export interface UpdateOrderShippingAddressResponse {
5258
4951
  /** Updated order. */
5259
4952
  order?: Order;
5260
4953
  }
5261
- interface UpdateBillingContactDetailsRequest {
4954
+ export interface UpdateBillingContactDetailsRequest {
5262
4955
  /**
5263
4956
  * Order ID.
5264
4957
  * @minLength 1
@@ -5269,11 +4962,11 @@ interface UpdateBillingContactDetailsRequest {
5269
4962
  /** Contact details. */
5270
4963
  addressContactDetails?: FullAddressContactDetails;
5271
4964
  }
5272
- interface UpdateBillingContactDetailsResponse {
4965
+ export interface UpdateBillingContactDetailsResponse {
5273
4966
  /** Updated order. */
5274
4967
  order?: Order;
5275
4968
  }
5276
- interface UpdateOrderLineItemRequest {
4969
+ export interface UpdateOrderLineItemRequest {
5277
4970
  /**
5278
4971
  * Order ID
5279
4972
  * @minLength 1
@@ -5283,11 +4976,11 @@ interface UpdateOrderLineItemRequest {
5283
4976
  /** Order line item to update */
5284
4977
  lineItem: OrderLineItem;
5285
4978
  }
5286
- interface UpdateOrderLineItemResponse {
4979
+ export interface UpdateOrderLineItemResponse {
5287
4980
  /** Updated order data */
5288
4981
  order?: Order;
5289
4982
  }
5290
- interface UpdateOrderLineItemsRequest {
4983
+ export interface UpdateOrderLineItemsRequest {
5291
4984
  /**
5292
4985
  * Order ID
5293
4986
  * @minLength 1
@@ -5301,15 +4994,15 @@ interface UpdateOrderLineItemsRequest {
5301
4994
  */
5302
4995
  lineItems?: MaskedOrderLineItem[];
5303
4996
  }
5304
- interface MaskedOrderLineItem {
4997
+ export interface MaskedOrderLineItem {
5305
4998
  /** Order line item to update */
5306
4999
  lineItem?: OrderLineItem;
5307
5000
  }
5308
- interface UpdateOrderLineItemsResponse {
5001
+ export interface UpdateOrderLineItemsResponse {
5309
5002
  /** Updated order data */
5310
5003
  order?: Order;
5311
5004
  }
5312
- interface AddInternalActivityRequest {
5005
+ export interface AddInternalActivityRequest {
5313
5006
  /**
5314
5007
  * Order ID.
5315
5008
  * @minLength 1
@@ -5319,7 +5012,7 @@ interface AddInternalActivityRequest {
5319
5012
  /** Activity info. */
5320
5013
  activity?: InternalActivity;
5321
5014
  }
5322
- interface InternalActivity extends InternalActivityContentOneOf {
5015
+ export interface InternalActivity extends InternalActivityContentOneOf {
5323
5016
  /** Order refunded. */
5324
5017
  orderRefunded?: OrderRefunded;
5325
5018
  /** Order placed. */
@@ -5364,35 +5057,6 @@ interface InternalActivity extends InternalActivityContentOneOf {
5364
5057
  draftOrderChangesApplied?: DraftOrderChangesApplied;
5365
5058
  /** Payment method is saved for order */
5366
5059
  savedPaymentMethod?: SavedPaymentMethod;
5367
- /**
5368
- * Details of an initiated refund process.
5369
- *
5370
- * > **Note:** A single `refund_initiated` activity can result in multiple `payment_refunded` or `payment_refund_failed` activities.
5371
- * > In these cases, the `refund_id` will be identical across the activities.
5372
- * @internal
5373
- */
5374
- refundInitiated?: RefundInitiated;
5375
- /**
5376
- * Details of a refunded payment.
5377
- *
5378
- * > **Note:** A single `refund_initiated` activity can result in multiple `payment_refunded` or `payment_refund_failed` activities.
5379
- * > In these cases, the `refund_id` will be identical across the activities.
5380
- * @internal
5381
- */
5382
- paymentRefunded?: PaymentRefunded;
5383
- /**
5384
- * Details of a failed payment refund.
5385
- *
5386
- * > **Note:** A single `refund_initiated` activity can result in multiple `payment_refunded` or `payment_refund_failed` activities.
5387
- * > In these cases, the `refund_id` will be identical across the activities.
5388
- * @internal
5389
- */
5390
- paymentRefundFailed?: PaymentRefundFailed;
5391
- /**
5392
- * Details of refund to store credit.
5393
- * @internal
5394
- */
5395
- refundedAsStoreCredit?: RefundedAsStoreCredit;
5396
5060
  /** Details of a pending payment */
5397
5061
  paymentPending?: PaymentPending;
5398
5062
  /** Details of a canceled payment */
@@ -5403,16 +5067,6 @@ interface InternalActivity extends InternalActivityContentOneOf {
5403
5067
  orderPending?: OrderPending;
5404
5068
  /** Order rejected */
5405
5069
  orderRejected?: OrderRejected;
5406
- /**
5407
- * Receipt was added for associated payment
5408
- * @internal
5409
- */
5410
- receiptCreated?: ReceiptCreated;
5411
- /**
5412
- * Receipt sent to customer
5413
- * @internal
5414
- */
5415
- receiptSent?: ReceiptSent;
5416
5070
  /**
5417
5071
  * Internal activity ID.
5418
5072
  * @format GUID
@@ -5432,7 +5086,7 @@ interface InternalActivity extends InternalActivityContentOneOf {
5432
5086
  _createdDate?: Date | null;
5433
5087
  }
5434
5088
  /** @oneof */
5435
- interface InternalActivityContentOneOf {
5089
+ export interface InternalActivityContentOneOf {
5436
5090
  /** Order refunded. */
5437
5091
  orderRefunded?: OrderRefunded;
5438
5092
  /** Order placed. */
@@ -5477,35 +5131,6 @@ interface InternalActivityContentOneOf {
5477
5131
  draftOrderChangesApplied?: DraftOrderChangesApplied;
5478
5132
  /** Payment method is saved for order */
5479
5133
  savedPaymentMethod?: SavedPaymentMethod;
5480
- /**
5481
- * Details of an initiated refund process.
5482
- *
5483
- * > **Note:** A single `refund_initiated` activity can result in multiple `payment_refunded` or `payment_refund_failed` activities.
5484
- * > In these cases, the `refund_id` will be identical across the activities.
5485
- * @internal
5486
- */
5487
- refundInitiated?: RefundInitiated;
5488
- /**
5489
- * Details of a refunded payment.
5490
- *
5491
- * > **Note:** A single `refund_initiated` activity can result in multiple `payment_refunded` or `payment_refund_failed` activities.
5492
- * > In these cases, the `refund_id` will be identical across the activities.
5493
- * @internal
5494
- */
5495
- paymentRefunded?: PaymentRefunded;
5496
- /**
5497
- * Details of a failed payment refund.
5498
- *
5499
- * > **Note:** A single `refund_initiated` activity can result in multiple `payment_refunded` or `payment_refund_failed` activities.
5500
- * > In these cases, the `refund_id` will be identical across the activities.
5501
- * @internal
5502
- */
5503
- paymentRefundFailed?: PaymentRefundFailed;
5504
- /**
5505
- * Details of refund to store credit.
5506
- * @internal
5507
- */
5508
- refundedAsStoreCredit?: RefundedAsStoreCredit;
5509
5134
  /** Details of a pending payment */
5510
5135
  paymentPending?: PaymentPending;
5511
5136
  /** Details of a canceled payment */
@@ -5516,75 +5141,65 @@ interface InternalActivityContentOneOf {
5516
5141
  orderPending?: OrderPending;
5517
5142
  /** Order rejected */
5518
5143
  orderRejected?: OrderRejected;
5519
- /**
5520
- * Receipt was added for associated payment
5521
- * @internal
5522
- */
5523
- receiptCreated?: ReceiptCreated;
5524
- /**
5525
- * Receipt sent to customer
5526
- * @internal
5527
- */
5528
- receiptSent?: ReceiptSent;
5529
5144
  }
5530
5145
  /** Order placed */
5531
- interface OrderPlaced {
5146
+ export interface OrderPlaced {
5532
5147
  }
5533
5148
  /** Order marked as paid, either by the store owner (for offline orders), or when an online transaction was confirmed */
5534
- interface OrderPaid {
5149
+ export interface OrderPaid {
5535
5150
  }
5536
5151
  /** Order shipping status set as fulfilled */
5537
- interface OrderFulfilled {
5152
+ export interface OrderFulfilled {
5538
5153
  }
5539
5154
  /** Order shipping status set as not fulfilled */
5540
- interface OrderNotFulfilled {
5155
+ export interface OrderNotFulfilled {
5541
5156
  }
5542
5157
  /** Order canceled */
5543
- interface OrderCanceled {
5158
+ export interface OrderCanceled {
5544
5159
  }
5545
5160
  /** A download link was sent (relevant for orders with digital line items) */
5546
- interface DownloadLinkSent {
5161
+ export interface DownloadLinkSent {
5547
5162
  }
5548
5163
  /** Shipping tracking number was set */
5549
- interface TrackingNumberAdded {
5164
+ export interface TrackingNumberAdded {
5550
5165
  }
5551
5166
  /** Shipping tracking number was edited */
5552
- interface TrackingNumberEdited {
5167
+ export interface TrackingNumberEdited {
5553
5168
  }
5554
5169
  /** Shipping tracking link was set */
5555
- interface TrackingLinkAdded {
5170
+ export interface TrackingLinkAdded {
5556
5171
  }
5557
5172
  /** An email confirmation of order shipment was sent */
5558
- interface ShippingConfirmationEmailSent {
5173
+ export interface ShippingConfirmationEmailSent {
5559
5174
  }
5560
5175
  /** Invoice was set in the order */
5561
- interface InvoiceAdded {
5176
+ export interface InvoiceAdded {
5562
5177
  }
5563
5178
  /** Invoice sent to customer via email */
5564
- interface InvoiceSent {
5179
+ export interface InvoiceSent {
5565
5180
  }
5566
5181
  /** Email was sent to fulfiller */
5567
- interface FulfillerEmailSent {
5182
+ export interface FulfillerEmailSent {
5568
5183
  }
5569
5184
  /** Shipping address was updated */
5570
- interface ShippingAddressEdited {
5185
+ export interface ShippingAddressEdited {
5571
5186
  }
5572
5187
  /** Order email was updated */
5573
- interface EmailEdited {
5188
+ export interface EmailEdited {
5574
5189
  }
5575
5190
  /** An email notification for pickup was sent */
5576
- interface PickupReadyEmailSent {
5191
+ export interface PickupReadyEmailSent {
5577
5192
  }
5578
5193
  /** Order marked as partially paid when an online transaction was confirmed with partial minimal required amount of total sum */
5579
- interface OrderPartiallyPaid {
5194
+ export interface OrderPartiallyPaid {
5580
5195
  }
5581
5196
  /** Order reject */
5582
- interface OrderPending {
5197
+ export interface OrderPending {
5583
5198
  }
5584
5199
  /** Order reject */
5585
- interface OrderRejected {
5200
+ export interface OrderRejected {
5586
5201
  }
5587
- interface AddInternalActivityResponse {
5202
+ export interface AddInternalActivityResponse {
5588
5203
  /** Updated order. */
5589
5204
  order?: Order;
5590
5205
  /**
@@ -5594,7 +5209,7 @@ interface AddInternalActivityResponse {
5594
5209
  */
5595
5210
  activityId?: string;
5596
5211
  }
5597
- interface AddActivityRequest {
5212
+ export interface AddActivityRequest {
5598
5213
  /**
5599
5214
  * Order ID.
5600
5215
  * @minLength 1
@@ -5604,20 +5219,20 @@ interface AddActivityRequest {
5604
5219
  /** Activity info. */
5605
5220
  activity: PublicActivity;
5606
5221
  }
5607
- interface PublicActivity extends PublicActivityContentOneOf {
5222
+ export interface PublicActivity extends PublicActivityContentOneOf {
5608
5223
  /** Custom activity details. */
5609
5224
  customActivity?: CustomActivity;
5610
5225
  /** Merchant commment. */
5611
5226
  merchantComment?: MerchantComment;
5612
5227
  }
5613
5228
  /** @oneof */
5614
- interface PublicActivityContentOneOf {
5229
+ export interface PublicActivityContentOneOf {
5615
5230
  /** Custom activity details. */
5616
5231
  customActivity?: CustomActivity;
5617
5232
  /** Merchant commment. */
5618
5233
  merchantComment?: MerchantComment;
5619
5234
  }
5620
- interface AddActivityResponse {
5235
+ export interface AddActivityResponse {
5621
5236
  /** Updated order. */
5622
5237
  order?: Order;
5623
5238
  /**
@@ -5627,7 +5242,7 @@ interface AddActivityResponse {
5627
5242
  */
5628
5243
  activityId?: string;
5629
5244
  }
5630
- interface AddActivitiesRequest {
5245
+ export interface AddActivitiesRequest {
5631
5246
  /**
5632
5247
  * Order ID.
5633
5248
  * @format GUID
@@ -5640,7 +5255,7 @@ interface AddActivitiesRequest {
5640
5255
  */
5641
5256
  activities?: PublicActivity[];
5642
5257
  }
5643
- interface AddActivitiesResponse {
5258
+ export interface AddActivitiesResponse {
5644
5259
  /** Updated order. */
5645
5260
  order?: Order;
5646
5261
  /**
@@ -5650,7 +5265,7 @@ interface AddActivitiesResponse {
5650
5265
  */
5651
5266
  activityIds?: string[];
5652
5267
  }
5653
- interface UpdateActivityRequest {
5268
+ export interface UpdateActivityRequest {
5654
5269
  /**
5655
5270
  * Order ID.
5656
5271
  * @minLength 1
@@ -5665,11 +5280,11 @@ interface UpdateActivityRequest {
5665
5280
  /** Activity info. */
5666
5281
  activity: PublicActivity;
5667
5282
  }
5668
- interface UpdateActivityResponse {
5283
+ export interface UpdateActivityResponse {
5669
5284
  /** Updated order. */
5670
5285
  order?: Order;
5671
5286
  }
5672
- interface DeleteActivityRequest {
5287
+ export interface DeleteActivityRequest {
5673
5288
  /**
5674
5289
  * Order ID.
5675
5290
  * @minLength 1
@@ -5682,11 +5297,11 @@ interface DeleteActivityRequest {
5682
5297
  */
5683
5298
  activityId: string;
5684
5299
  }
5685
- interface DeleteActivityResponse {
5300
+ export interface DeleteActivityResponse {
5686
5301
  /** Updated order. */
5687
5302
  order?: Order;
5688
5303
  }
5689
- interface UpdateLineItemsDescriptionLinesRequest {
5304
+ export interface UpdateLineItemsDescriptionLinesRequest {
5690
5305
  /**
5691
5306
  * Order ID.
5692
5307
  * @minLength 1
@@ -5700,7 +5315,7 @@ interface UpdateLineItemsDescriptionLinesRequest {
5700
5315
  */
5701
5316
  lineItems?: LineItemUpdate[];
5702
5317
  }
5703
- interface LineItemUpdate {
5318
+ export interface LineItemUpdate {
5704
5319
  /**
5705
5320
  * Line item ID.
5706
5321
  * @format GUID
@@ -5714,11 +5329,11 @@ interface LineItemUpdate {
5714
5329
  */
5715
5330
  descriptionLines?: DescriptionLine[];
5716
5331
  }
5717
- interface UpdateLineItemsDescriptionLinesResponse {
5332
+ export interface UpdateLineItemsDescriptionLinesResponse {
5718
5333
  /** Updated order. */
5719
5334
  order?: Order;
5720
5335
  }
5721
- interface MarkOrderAsSeenByHumanRequest {
5336
+ export interface MarkOrderAsSeenByHumanRequest {
5722
5337
  /**
5723
5338
  * Order ID.
5724
5339
  * @minLength 1
@@ -5726,11 +5341,11 @@ interface MarkOrderAsSeenByHumanRequest {
5726
5341
  */
5727
5342
  _id?: string;
5728
5343
  }
5729
- interface MarkOrderAsSeenByHumanResponse {
5344
+ export interface MarkOrderAsSeenByHumanResponse {
5730
5345
  /** Updated order. */
5731
5346
  order?: Order;
5732
5347
  }
5733
- interface CancelOrderRequest {
5348
+ export interface CancelOrderRequest {
5734
5349
  /**
5735
5350
  * Order ID.
5736
5351
  * @minLength 1
@@ -5748,11 +5363,11 @@ interface CancelOrderRequest {
5748
5363
  /** Whether to restock all items in the order. This will only apply to products in the Wix Stores inventory. */
5749
5364
  restockAllItems?: boolean;
5750
5365
  }
5751
- interface CancelOrderResponse {
5366
+ export interface CancelOrderResponse {
5752
5367
  /** Canceled order. */
5753
5368
  order?: Order;
5754
5369
  }
5755
- interface OrderCanceledEventOrderCanceled {
5370
+ export interface OrderCanceledEventOrderCanceled {
5756
5371
  /** The order that was cancelled */
5757
5372
  order?: Order;
5758
5373
  /** Should restock all items on that order */
@@ -5762,7 +5377,7 @@ interface OrderCanceledEventOrderCanceled {
5762
5377
  /** Personal note added to the email */
5763
5378
  customMessage?: string | null;
5764
5379
  }
5765
- interface UpdateOrderStatusRequest {
5380
+ export interface UpdateOrderStatusRequest {
5766
5381
  /**
5767
5382
  * Order ID.
5768
5383
  * @format GUID
@@ -5771,11 +5386,11 @@ interface UpdateOrderStatusRequest {
5771
5386
  /** New order status. */
5772
5387
  status: OrderStatus;
5773
5388
  }
5774
- interface UpdateOrderStatusResponse {
5389
+ export interface UpdateOrderStatusResponse {
5775
5390
  /** Updated order. */
5776
5391
  order?: Order;
5777
5392
  }
5778
- interface MarkAsFulfilledRequest {
5393
+ export interface MarkAsFulfilledRequest {
5779
5394
  /**
5780
5395
  * Order ID.
5781
5396
  * @minLength 1
@@ -5783,12 +5398,12 @@ interface MarkAsFulfilledRequest {
5783
5398
  */
5784
5399
  _id?: string;
5785
5400
  }
5786
- interface MarkAsFulfilledResponse {
5401
+ export interface MarkAsFulfilledResponse {
5787
5402
  /** Updated order. */
5788
5403
  order?: Order;
5789
5404
  }
5790
5405
  /** Triggered when the fulfillment status of an order is updated */
5791
- interface FulfillmentStatusUpdated {
5406
+ export interface FulfillmentStatusUpdated {
5792
5407
  /** The order that was updated */
5793
5408
  order?: Order;
5794
5409
  /** The previous status (before the update) */
@@ -5798,7 +5413,7 @@ interface FulfillmentStatusUpdated {
5798
5413
  /** the action that caused this update */
5799
5414
  action?: string;
5800
5415
  }
5801
- interface BulkMarkAsFulfilledRequest {
5416
+ export interface BulkMarkAsFulfilledRequest {
5802
5417
  /**
5803
5418
  * IDs of orders to be marked as fulfilled.
5804
5419
  * @minSize 1
@@ -5808,23 +5423,23 @@ interface BulkMarkAsFulfilledRequest {
5808
5423
  /** Whether to return the full updated order entities in the response. */
5809
5424
  returnFullEntity?: boolean;
5810
5425
  }
5811
- interface BulkMarkAsFulfilledResponse {
5426
+ export interface BulkMarkAsFulfilledResponse {
5812
5427
  /** Items updated by bulk action. */
5813
5428
  results?: BulkOrderResult[];
5814
5429
  /** Bulk action metadata. */
5815
5430
  bulkActionMetadata?: BulkActionMetadata;
5816
5431
  }
5817
- interface BulkMarkAsFulfilledByFilterRequest {
5432
+ export interface BulkMarkAsFulfilledByFilterRequest {
5818
5433
  /** Filter object. Learn more about supported filters [here](https://bo.wix.com/wix-docs/rest/ecommerce/orders/filter-and-sort). */
5819
5434
  filter?: Record<string, any> | null;
5820
5435
  }
5821
- interface BulkMarkAsFulfilledByFilterResponse {
5436
+ export interface BulkMarkAsFulfilledByFilterResponse {
5822
5437
  /** Items updated by bulk action. */
5823
5438
  results?: BulkOrderResult[];
5824
5439
  /** Bulk action metadata. */
5825
5440
  bulkActionMetadata?: BulkActionMetadata;
5826
5441
  }
5827
- interface MarkAsUnfulfilledRequest {
5442
+ export interface MarkAsUnfulfilledRequest {
5828
5443
  /**
5829
5444
  * Order ID.
5830
5445
  * @minLength 1
@@ -5832,11 +5447,11 @@ interface MarkAsUnfulfilledRequest {
5832
5447
  */
5833
5448
  _id?: string;
5834
5449
  }
5835
- interface MarkAsUnfulfilledResponse {
5450
+ export interface MarkAsUnfulfilledResponse {
5836
5451
  /** Updated order. */
5837
5452
  order?: Order;
5838
5453
  }
5839
- interface BulkMarkAsUnfulfilledRequest {
5454
+ export interface BulkMarkAsUnfulfilledRequest {
5840
5455
  /**
5841
5456
  * IDs of orders to be marked as not fulfilled.
5842
5457
  * @minSize 1
@@ -5846,23 +5461,23 @@ interface BulkMarkAsUnfulfilledRequest {
5846
5461
  /** Whether to return the full updated order entities in the response. */
5847
5462
  returnFullEntity?: boolean;
5848
5463
  }
5849
- interface BulkMarkAsUnfulfilledResponse {
5464
+ export interface BulkMarkAsUnfulfilledResponse {
5850
5465
  /** Items updated by bulk action. */
5851
5466
  results?: BulkOrderResult[];
5852
5467
  /** Bulk action metadata. */
5853
5468
  bulkActionMetadata?: BulkActionMetadata;
5854
5469
  }
5855
- interface BulkMarkAsUnfulfilledByFilterRequest {
5470
+ export interface BulkMarkAsUnfulfilledByFilterRequest {
5856
5471
  /** Filter object. Learn more about supported filters [here](https://bo.wix.com/wix-docs/rest/ecommerce/orders/filter-and-sort). */
5857
5472
  filter?: Record<string, any> | null;
5858
5473
  }
5859
- interface BulkMarkAsUnfulfilledByFilterResponse {
5474
+ export interface BulkMarkAsUnfulfilledByFilterResponse {
5860
5475
  /** Items updated by bulk action. */
5861
5476
  results?: BulkOrderResult[];
5862
5477
  /** Bulk action metadata. */
5863
5478
  bulkActionMetadata?: BulkActionMetadata;
5864
5479
  }
5865
- interface BulkSetBusinessLocationRequest {
5480
+ export interface BulkSetBusinessLocationRequest {
5866
5481
  /**
5867
5482
  * IDs of orders to update location for.
5868
5483
  * @minSize 1
@@ -5873,7 +5488,7 @@ interface BulkSetBusinessLocationRequest {
5873
5488
  /** Business location. */
5874
5489
  businessLocation?: Location;
5875
5490
  }
5876
- interface BulkSetBusinessLocationResponse {
5491
+ export interface BulkSetBusinessLocationResponse {
5877
5492
  /**
5878
5493
  * Bulk action results.
5879
5494
  * @minSize 1
@@ -5883,10 +5498,10 @@ interface BulkSetBusinessLocationResponse {
5883
5498
  /** Bulk action metadata. */
5884
5499
  bulkActionMetadata?: BulkActionMetadata;
5885
5500
  }
5886
- interface BulkSetBusinessLocationResult {
5501
+ export interface BulkSetBusinessLocationResult {
5887
5502
  itemMetadata?: ItemMetadata;
5888
5503
  }
5889
- interface V1MarkOrderAsPaidRequest {
5504
+ export interface V1MarkOrderAsPaidRequest {
5890
5505
  /**
5891
5506
  * Order ID.
5892
5507
  * @minLength 1
@@ -5894,11 +5509,11 @@ interface V1MarkOrderAsPaidRequest {
5894
5509
  */
5895
5510
  _id?: string;
5896
5511
  }
5897
- interface V1MarkOrderAsPaidResponse {
5512
+ export interface V1MarkOrderAsPaidResponse {
5898
5513
  /** Updated order. */
5899
5514
  order?: Order;
5900
5515
  }
5901
- interface V1BulkMarkOrdersAsPaidRequest {
5516
+ export interface V1BulkMarkOrdersAsPaidRequest {
5902
5517
  /**
5903
5518
  * IDs of orders to mark as paid.
5904
5519
  * @minSize 1
@@ -5908,7 +5523,7 @@ interface V1BulkMarkOrdersAsPaidRequest {
5908
5523
  */
5909
5524
  ids?: string[];
5910
5525
  }
5911
- interface V1BulkMarkOrdersAsPaidResponse {
5526
+ export interface V1BulkMarkOrdersAsPaidResponse {
5912
5527
  /**
5913
5528
  * Items updated by the bulk action.
5914
5529
  * The Order entity within the results optimistically changes its payment status to paid, however this process is async.
@@ -5917,7 +5532,7 @@ interface V1BulkMarkOrdersAsPaidResponse {
5917
5532
  /** Bulk action metadata. */
5918
5533
  bulkActionMetadata?: BulkActionMetadata;
5919
5534
  }
5920
- interface V1CreatePaymentGatewayOrderRequest {
5535
+ export interface V1CreatePaymentGatewayOrderRequest {
5921
5536
  /**
5922
5537
  * eCom Order ID
5923
5538
  * @minLength 1
@@ -5925,21 +5540,21 @@ interface V1CreatePaymentGatewayOrderRequest {
5925
5540
  */
5926
5541
  ecomOrderId?: string;
5927
5542
  }
5928
- interface V1CreatePaymentGatewayOrderResponse {
5543
+ export interface V1CreatePaymentGatewayOrderResponse {
5929
5544
  /** ID of the order created in the payment gateway */
5930
5545
  paymentGatewayOrderId?: string;
5931
5546
  }
5932
- interface GetShipmentsRequest {
5547
+ export interface GetShipmentsRequest {
5933
5548
  /**
5934
5549
  * @minLength 1
5935
5550
  * @maxLength 100
5936
5551
  */
5937
5552
  _id?: string;
5938
5553
  }
5939
- interface GetShipmentsResponse {
5554
+ export interface GetShipmentsResponse {
5940
5555
  shipmentIds?: string[];
5941
5556
  }
5942
- interface AggregateOrdersRequest {
5557
+ export interface AggregateOrdersRequest {
5943
5558
  /** Filter applied to original data */
5944
5559
  filter?: Record<string, any> | null;
5945
5560
  /** This is an object defining aggregation itself */
@@ -5955,10 +5570,10 @@ interface AggregateOrdersRequest {
5955
5570
  */
5956
5571
  hierarchySeparatorOverride?: string | null;
5957
5572
  }
5958
- interface AggregateOrdersResponse {
5573
+ export interface AggregateOrdersResponse {
5959
5574
  aggregates?: Record<string, any> | null;
5960
5575
  }
5961
- interface DecrementItemsQuantityRequest {
5576
+ export interface DecrementItemsQuantityRequest {
5962
5577
  /**
5963
5578
  * Order ID
5964
5579
  * @minLength 1
@@ -5972,7 +5587,7 @@ interface DecrementItemsQuantityRequest {
5972
5587
  */
5973
5588
  decrementData?: DecrementData[];
5974
5589
  }
5975
- interface DecrementData {
5590
+ export interface DecrementData {
5976
5591
  /**
5977
5592
  * ID of the line item being decremented.
5978
5593
  * @format GUID
@@ -5987,11 +5602,11 @@ interface DecrementData {
5987
5602
  /** Whether to restock the line item (triggers inventory update). */
5988
5603
  restock?: boolean;
5989
5604
  }
5990
- interface DecrementItemsQuantityResponse {
5605
+ export interface DecrementItemsQuantityResponse {
5991
5606
  /** Updated order data */
5992
5607
  order?: Order;
5993
5608
  }
5994
- interface BulkUpdateOrderTagsRequest {
5609
+ export interface BulkUpdateOrderTagsRequest {
5995
5610
  /**
5996
5611
  * IDs of orders to update tags for.
5997
5612
  * @minSize 1
@@ -6004,7 +5619,7 @@ interface BulkUpdateOrderTagsRequest {
6004
5619
  /** Tags to be removed from orders */
6005
5620
  unassignTags?: Tags;
6006
5621
  }
6007
- interface BulkUpdateOrderTagsResponse {
5622
+ export interface BulkUpdateOrderTagsResponse {
6008
5623
  /**
6009
5624
  * @minSize 1
6010
5625
  * @maxSize 100
@@ -6012,51 +5627,51 @@ interface BulkUpdateOrderTagsResponse {
6012
5627
  results?: BulkUpdateOrderTagsResult[];
6013
5628
  bulkActionMetadata?: BulkActionMetadata;
6014
5629
  }
6015
- interface BulkUpdateOrderTagsResult {
5630
+ export interface BulkUpdateOrderTagsResult {
6016
5631
  itemMetadata?: ItemMetadata;
6017
5632
  }
6018
- interface Task {
5633
+ export interface Task {
6019
5634
  key?: TaskKey;
6020
5635
  executeAt?: Date | null;
6021
5636
  payload?: string | null;
6022
5637
  }
6023
- interface TaskKey {
5638
+ export interface TaskKey {
6024
5639
  appId?: string;
6025
5640
  instanceId?: string;
6026
5641
  subjectId?: string | null;
6027
5642
  }
6028
- interface TaskAction extends TaskActionActionOneOf {
5643
+ export interface TaskAction extends TaskActionActionOneOf {
6029
5644
  complete?: Complete;
6030
5645
  cancel?: Cancel;
6031
5646
  reschedule?: Reschedule;
6032
5647
  }
6033
5648
  /** @oneof */
6034
- interface TaskActionActionOneOf {
5649
+ export interface TaskActionActionOneOf {
6035
5650
  complete?: Complete;
6036
5651
  cancel?: Cancel;
6037
5652
  reschedule?: Reschedule;
6038
5653
  }
6039
- interface Complete {
5654
+ export interface Complete {
6040
5655
  }
6041
- interface Cancel {
5656
+ export interface Cancel {
6042
5657
  }
6043
- interface Reschedule {
5658
+ export interface Reschedule {
6044
5659
  executeAt?: Date | null;
6045
5660
  payload?: string | null;
6046
5661
  }
6047
- interface InvoiceSentEvent {
5662
+ export interface InvoiceSentEvent {
6048
5663
  _id?: IdAndVersion;
6049
5664
  /** @readonly */
6050
5665
  data?: InvoiceFields;
6051
5666
  /** @readonly */
6052
5667
  status?: InvoiceStatus;
6053
5668
  }
6054
- interface IdAndVersion {
5669
+ export interface IdAndVersion {
6055
5670
  /** @format GUID */
6056
5671
  _id?: string | null;
6057
5672
  version?: number | null;
6058
5673
  }
6059
- interface InvoiceFields {
5674
+ export interface InvoiceFields {
6060
5675
  /** The invoice number allocated the invoice by the server. The number is limited to at most 11 digits. */
6061
5676
  number?: string | null;
6062
5677
  /**
@@ -6127,7 +5742,7 @@ interface InvoiceFields {
6127
5742
  /** Associated checkout for this invoice */
6128
5743
  ecomCheckoutId?: string | null;
6129
5744
  }
6130
- interface Customer {
5745
+ export interface Customer {
6131
5746
  contactId?: string | null;
6132
5747
  name?: string | null;
6133
5748
  email?: Email;
@@ -6139,10 +5754,10 @@ interface Customer {
6139
5754
  billingAddress?: CommonAddress;
6140
5755
  shippingAddress?: CommonAddress;
6141
5756
  }
6142
- interface Email {
5757
+ export interface Email {
6143
5758
  address?: string;
6144
5759
  }
6145
- interface QuotesAddress {
5760
+ export interface QuotesAddress {
6146
5761
  street?: string | null;
6147
5762
  city?: string | null;
6148
5763
  zip?: string | null;
@@ -6151,25 +5766,25 @@ interface QuotesAddress {
6151
5766
  /** @readonly */
6152
5767
  description?: AddressDescription;
6153
5768
  }
6154
- interface AddressDescription {
5769
+ export interface AddressDescription {
6155
5770
  content?: string;
6156
5771
  placement?: Placement;
6157
5772
  }
6158
- declare enum Placement {
5773
+ export declare enum Placement {
6159
5774
  Unknown = "Unknown",
6160
5775
  Replace = "Replace",
6161
5776
  Before = "Before",
6162
5777
  After = "After"
6163
5778
  }
6164
- interface Phone {
5779
+ export interface Phone {
6165
5780
  number?: string;
6166
5781
  }
6167
- interface Company {
5782
+ export interface Company {
6168
5783
  name?: string;
6169
5784
  _id?: string | null;
6170
5785
  }
6171
5786
  /** Physical address */
6172
- interface CommonAddress extends CommonAddressStreetOneOf {
5787
+ export interface CommonAddress extends CommonAddressStreetOneOf {
6173
5788
  /** Street name and number. */
6174
5789
  streetAddress?: StreetAddress;
6175
5790
  /** Main address line, usually street and number as free text. */
@@ -6189,19 +5804,19 @@ interface CommonAddress extends CommonAddressStreetOneOf {
6189
5804
  addressLine2?: string | null;
6190
5805
  }
6191
5806
  /** @oneof */
6192
- interface CommonAddressStreetOneOf {
5807
+ export interface CommonAddressStreetOneOf {
6193
5808
  /** Street name and number. */
6194
5809
  streetAddress?: StreetAddress;
6195
5810
  /** Main address line, usually street and number as free text. */
6196
5811
  addressLine?: string | null;
6197
5812
  }
6198
- interface Subdivision {
5813
+ export interface Subdivision {
6199
5814
  /** Short subdivision code. */
6200
5815
  code?: string;
6201
5816
  /** Subdivision full name. */
6202
5817
  name?: string;
6203
5818
  }
6204
- declare enum SubdivisionType {
5819
+ export declare enum SubdivisionType {
6205
5820
  UNKNOWN_SUBDIVISION_TYPE = "UNKNOWN_SUBDIVISION_TYPE",
6206
5821
  /** State */
6207
5822
  ADMINISTRATIVE_AREA_LEVEL_1 = "ADMINISTRATIVE_AREA_LEVEL_1",
@@ -6217,14 +5832,14 @@ declare enum SubdivisionType {
6217
5832
  COUNTRY = "COUNTRY"
6218
5833
  }
6219
5834
  /** Subdivision Concordance values */
6220
- interface StandardDetails {
5835
+ export interface StandardDetails {
6221
5836
  /**
6222
5837
  * subdivision iso-3166-2 code according to [ISO 3166-2](https://en.wikipedia.org/wiki/ISO_3166-2). e.g. US-NY, GB-SCT, NO-30
6223
5838
  * @maxLength 20
6224
5839
  */
6225
5840
  iso31662?: string | null;
6226
5841
  }
6227
- interface InvoiceDates {
5842
+ export interface InvoiceDates {
6228
5843
  /** use UTC midnight date to set the issue date according to the site time zone */
6229
5844
  issueDate?: Date | null;
6230
5845
  /** use UTC midnight date to set the due date according to the site time zone */
@@ -6237,10 +5852,10 @@ interface InvoiceDates {
6237
5852
  */
6238
5853
  lastSeenDate?: Date | null;
6239
5854
  }
6240
- interface LineItems {
5855
+ export interface LineItems {
6241
5856
  lineItems?: LineItem[];
6242
5857
  }
6243
- interface LineItem {
5858
+ export interface LineItem {
6244
5859
  /** @format GUID */
6245
5860
  _id?: string;
6246
5861
  name?: string;
@@ -6254,15 +5869,15 @@ interface LineItem {
6254
5869
  /** The line-item level metadata. */
6255
5870
  metadata?: LineItemMetaData;
6256
5871
  }
6257
- interface BigDecimalWrapper {
5872
+ export interface BigDecimalWrapper {
6258
5873
  serializedValue?: number;
6259
5874
  }
6260
- interface LineItemTax {
5875
+ export interface LineItemTax {
6261
5876
  name?: string;
6262
5877
  rate?: BigDecimalWrapper;
6263
5878
  code?: string | null;
6264
5879
  }
6265
- interface Source {
5880
+ export interface Source {
6266
5881
  /**
6267
5882
  * Source app or service ID.
6268
5883
  * @readonly
@@ -6274,24 +5889,24 @@ interface Source {
6274
5889
  */
6275
5890
  sourceType?: SourceType;
6276
5891
  }
6277
- declare enum SourceType {
5892
+ export declare enum SourceType {
6278
5893
  UNKNOWN_SOURCE_TYPE = "UNKNOWN_SOURCE_TYPE",
6279
5894
  WIX_APP = "WIX_APP",
6280
5895
  EXTERNAL = "EXTERNAL",
6281
5896
  ADMIN = "ADMIN",
6282
5897
  OTHER = "OTHER"
6283
5898
  }
6284
- interface LineItemMetaData {
5899
+ export interface LineItemMetaData {
6285
5900
  metadata?: Record<string, string>;
6286
5901
  }
6287
- interface Locale {
5902
+ export interface Locale {
6288
5903
  /** ISO 639 alpha-2 or alpha-3 language code, or a language subtag */
6289
5904
  language?: string;
6290
5905
  /** An ISO 3166 alpha-2 country code or a UN M.49 numeric-3 area code. */
6291
5906
  country?: string | null;
6292
5907
  invariant?: string | null;
6293
5908
  }
6294
- interface TotalPrice {
5909
+ export interface TotalPrice {
6295
5910
  /** the subtotal of the line items without the tax reduction */
6296
5911
  subtotal?: BigDecimalWrapper;
6297
5912
  /** the total price taking into account the itemized fees and the taxes */
@@ -6300,24 +5915,24 @@ interface TotalPrice {
6300
5915
  discountAmount?: BigDecimalWrapper;
6301
5916
  taxedAmount?: BigDecimalWrapper;
6302
5917
  }
6303
- interface ItemizedFee {
5918
+ export interface ItemizedFee {
6304
5919
  name?: string;
6305
5920
  price?: BigDecimalWrapper;
6306
5921
  }
6307
- interface Discount extends DiscountOneDiscountTypeOneOf {
5922
+ export interface Discount extends DiscountOneDiscountTypeOneOf {
6308
5923
  /** Discount as percentage value. */
6309
5924
  percentage?: BigDecimalWrapper;
6310
5925
  }
6311
5926
  /** @oneof */
6312
- interface DiscountOneDiscountTypeOneOf {
5927
+ export interface DiscountOneDiscountTypeOneOf {
6313
5928
  /** Discount as percentage value. */
6314
5929
  percentage?: BigDecimalWrapper;
6315
5930
  }
6316
- interface CalculatedTaxes {
5931
+ export interface CalculatedTaxes {
6317
5932
  /** consider calculated or not - cannot enforce set */
6318
5933
  taxes?: CalculatedTax[];
6319
5934
  }
6320
- interface CalculatedTax {
5935
+ export interface CalculatedTax {
6321
5936
  name?: string;
6322
5937
  rate?: BigDecimalWrapper;
6323
5938
  /** the costs on which the taxes are applied */
@@ -6326,10 +5941,10 @@ interface CalculatedTax {
6326
5941
  taxed?: BigDecimalWrapper;
6327
5942
  code?: string | null;
6328
5943
  }
6329
- interface Payments {
5944
+ export interface Payments {
6330
5945
  payments?: InvoicesPayment[];
6331
5946
  }
6332
- interface InvoicesPayment {
5947
+ export interface InvoicesPayment {
6333
5948
  /** document */
6334
5949
  _id?: string;
6335
5950
  type?: string;
@@ -6346,7 +5961,7 @@ interface InvoicesPayment {
6346
5961
  */
6347
5962
  transactionId?: string | null;
6348
5963
  }
6349
- interface MetaData {
5964
+ export interface MetaData {
6350
5965
  notes?: string | null;
6351
5966
  legalTerms?: string | null;
6352
5967
  sourceUrl?: string | null;
@@ -6356,7 +5971,7 @@ interface MetaData {
6356
5971
  /** Optional indicator whether to allow editing of the invoice by other applications other than the source. Default is true. */
6357
5972
  allowEditByOthers?: boolean | null;
6358
5973
  }
6359
- interface InvoiceDynamicPriceTotals {
5974
+ export interface InvoiceDynamicPriceTotals {
6360
5975
  paidAmount?: BigDecimalWrapper;
6361
5976
  balance?: BigDecimalWrapper;
6362
5977
  }
@@ -6364,7 +5979,7 @@ interface InvoiceDynamicPriceTotals {
6364
5979
  * A custom field value is used to add additional data to a financial document or to a financial document template.
6365
5980
  * The custom field value may be based on a custom field definition.
6366
5981
  */
6367
- interface CustomFieldValue {
5982
+ export interface CustomFieldValue {
6368
5983
  /**
6369
5984
  * The unique id of the custom field value
6370
5985
  * @format GUID
@@ -6388,7 +6003,7 @@ interface CustomFieldValue {
6388
6003
  */
6389
6004
  originCustomFieldKey?: string | null;
6390
6005
  }
6391
- declare enum CustomFieldGroup {
6006
+ export declare enum CustomFieldGroup {
6392
6007
  UNKNOWN_CUSTOM_FIELD_GROUP = "UNKNOWN_CUSTOM_FIELD_GROUP",
6393
6008
  BUSINESS_DETAILS = "BUSINESS_DETAILS",
6394
6009
  CUSTOMER_DETAILS = "CUSTOMER_DETAILS",
@@ -6396,18 +6011,18 @@ declare enum CustomFieldGroup {
6396
6011
  FOOTER = "FOOTER",
6397
6012
  OTHER = "OTHER"
6398
6013
  }
6399
- interface Value {
6014
+ export interface Value {
6400
6015
  value?: string;
6401
6016
  valueType?: ValueType;
6402
6017
  }
6403
- declare enum ValueType {
6018
+ export declare enum ValueType {
6404
6019
  UNKNOWN_VALUE_TYPE = "UNKNOWN_VALUE_TYPE",
6405
6020
  STRING = "STRING",
6406
6021
  DATE = "DATE",
6407
6022
  BOOLEAN = "BOOLEAN",
6408
6023
  NUMBER = "NUMBER"
6409
6024
  }
6410
- interface Deposit {
6025
+ export interface Deposit {
6411
6026
  /**
6412
6027
  * The flat amount of the deposit. The flat amount of the deposit must be less than the invoice total.
6413
6028
  * @format DECIMAL_VALUE
@@ -6425,7 +6040,7 @@ interface Deposit {
6425
6040
  /** The type of the deposit. The default is FLAT. */
6426
6041
  type?: DepositType;
6427
6042
  }
6428
- declare enum DepositType {
6043
+ export declare enum DepositType {
6429
6044
  UNKNOWN = "UNKNOWN",
6430
6045
  FLAT = "FLAT",
6431
6046
  PERCENTAGE = "PERCENTAGE"
@@ -6440,7 +6055,7 @@ declare enum DepositType {
6440
6055
  * Void -> Deleted
6441
6056
  * Deleted
6442
6057
  */
6443
- declare enum InvoiceStatus {
6058
+ export declare enum InvoiceStatus {
6444
6059
  Draft = "Draft",
6445
6060
  Sent = "Sent",
6446
6061
  Processing = "Processing",
@@ -6451,12 +6066,12 @@ declare enum InvoiceStatus {
6451
6066
  PartiallyPaid = "PartiallyPaid",
6452
6067
  PartialAndOverdue = "PartialAndOverdue"
6453
6068
  }
6454
- interface TriggerSideEffectsFromLegacyData {
6069
+ export interface TriggerSideEffectsFromLegacyData {
6455
6070
  storeId?: string;
6456
6071
  orderId?: string;
6457
6072
  ordersExperiments?: OrdersExperiments;
6458
6073
  }
6459
- interface BaseEventMetadata {
6074
+ export interface BaseEventMetadata {
6460
6075
  /**
6461
6076
  * App instance ID.
6462
6077
  * @format GUID
@@ -6470,7 +6085,7 @@ interface BaseEventMetadata {
6470
6085
  /** The identification type and identity data. */
6471
6086
  identity?: IdentificationData;
6472
6087
  }
6473
- interface EventMetadata extends BaseEventMetadata {
6088
+ export interface EventMetadata extends BaseEventMetadata {
6474
6089
  /**
6475
6090
  * Unique event ID.
6476
6091
  * Allows clients to ignore duplicate webhooks.
@@ -6508,23 +6123,137 @@ interface EventMetadata extends BaseEventMetadata {
6508
6123
  */
6509
6124
  entityEventSequence?: string | null;
6510
6125
  }
6511
- interface OrderApprovedEnvelope {
6126
+ export interface OrderApprovedEnvelope {
6512
6127
  data: OrderApproved;
6513
6128
  metadata: EventMetadata;
6514
6129
  }
6515
- interface OrderUpdatedEnvelope {
6130
+ /** @permissionScope Manage Stores - all permissions
6131
+ * @permissionScopeId SCOPE.DC-STORES-MEGA.MANAGE-STORES
6132
+ * @permissionScope Read eCommerce - all read permissions
6133
+ * @permissionScopeId SCOPE.DC-ECOM-MEGA.READ-ECOM
6134
+ * @permissionScope Read Orders
6135
+ * @permissionScopeId SCOPE.DC-STORES.READ-ORDERS
6136
+ * @permissionScope Read Stores - all read permissions
6137
+ * @permissionScopeId SCOPE.DC-STORES-MEGA.READ-STORES
6138
+ * @permissionScope Manage Restaurants - all permissions
6139
+ * @permissionScopeId SCOPE.RESTAURANTS.MEGA-SCOPES
6140
+ * @permissionScope Manage eCommerce - all permissions
6141
+ * @permissionScopeId SCOPE.DC-ECOM-MEGA.MANAGE-ECOM
6142
+ * @permissionScope Picasso private app mega scope
6143
+ * @permissionScopeId SCOPE.TEST.MEGA-PICASSO-MANAGE-SITE
6144
+ * @permissionScope Manage Orders
6145
+ * @permissionScopeId SCOPE.DC-STORES.MANAGE-ORDERS
6146
+ * @permissionId ECOM.READ_ORDERS
6147
+ * @webhook
6148
+ * @eventType wix.ecom.v1.order_approved
6149
+ * @slug approved
6150
+ */
6151
+ export declare function onOrderApproved(handler: (event: OrderApprovedEnvelope) => void | Promise<void>): void;
6152
+ export interface OrderUpdatedEnvelope {
6516
6153
  entity: Order;
6517
6154
  metadata: EventMetadata;
6518
6155
  }
6519
- interface OrderCanceledEnvelope {
6156
+ /** @permissionScope Manage Stores - all permissions
6157
+ * @permissionScopeId SCOPE.DC-STORES-MEGA.MANAGE-STORES
6158
+ * @permissionScope Read eCommerce - all read permissions
6159
+ * @permissionScopeId SCOPE.DC-ECOM-MEGA.READ-ECOM
6160
+ * @permissionScope Read Orders
6161
+ * @permissionScopeId SCOPE.DC-STORES.READ-ORDERS
6162
+ * @permissionScope Read Stores - all read permissions
6163
+ * @permissionScopeId SCOPE.DC-STORES-MEGA.READ-STORES
6164
+ * @permissionScope Manage Restaurants - all permissions
6165
+ * @permissionScopeId SCOPE.RESTAURANTS.MEGA-SCOPES
6166
+ * @permissionScope Manage eCommerce - all permissions
6167
+ * @permissionScopeId SCOPE.DC-ECOM-MEGA.MANAGE-ECOM
6168
+ * @permissionScope Picasso private app mega scope
6169
+ * @permissionScopeId SCOPE.TEST.MEGA-PICASSO-MANAGE-SITE
6170
+ * @permissionScope Manage Orders
6171
+ * @permissionScopeId SCOPE.DC-STORES.MANAGE-ORDERS
6172
+ * @permissionId ECOM.READ_ORDERS
6173
+ * @webhook
6174
+ * @eventType wix.ecom.v1.order_updated
6175
+ * @slug updated
6176
+ */
6177
+ export declare function onOrderUpdated(handler: (event: OrderUpdatedEnvelope) => void | Promise<void>): void;
6178
+ export interface OrderCanceledEnvelope {
6520
6179
  data: OrderCanceledEventOrderCanceled;
6521
6180
  metadata: EventMetadata;
6522
6181
  }
6523
- interface OrderCreatedEnvelope {
6182
+ /**
6183
+ * Triggered when an order is canceled.
6184
+ * Learn more about [eCommerce webhook payload structure](https://dev.wix.com/docs/rest/api-reference/wix-e-commerce/orders/order-object-conversion#webhook-conversion-table).
6185
+ * @permissionScope Manage Stores - all permissions
6186
+ * @permissionScopeId SCOPE.DC-STORES-MEGA.MANAGE-STORES
6187
+ * @permissionScope Read eCommerce - all read permissions
6188
+ * @permissionScopeId SCOPE.DC-ECOM-MEGA.READ-ECOM
6189
+ * @permissionScope Read Orders
6190
+ * @permissionScopeId SCOPE.DC-STORES.READ-ORDERS
6191
+ * @permissionScope Read Stores - all read permissions
6192
+ * @permissionScopeId SCOPE.DC-STORES-MEGA.READ-STORES
6193
+ * @permissionScope Manage Restaurants - all permissions
6194
+ * @permissionScopeId SCOPE.RESTAURANTS.MEGA-SCOPES
6195
+ * @permissionScope Manage eCommerce - all permissions
6196
+ * @permissionScopeId SCOPE.DC-ECOM-MEGA.MANAGE-ECOM
6197
+ * @permissionScope Manage Orders
6198
+ * @permissionScopeId SCOPE.DC-STORES.MANAGE-ORDERS
6199
+ * @permissionId ECOM.READ_ORDERS
6200
+ * @webhook
6201
+ * @eventType wix.ecom.v1.order_canceled
6202
+ * @serviceIdentifier com.wix.ecom.orders.v1.Orders
6203
+ * @slug canceled
6204
+ */
6205
+ export declare function onOrderCanceled(handler: (event: OrderCanceledEnvelope) => void | Promise<void>): void;
6206
+ export interface OrderCreatedEnvelope {
6524
6207
  entity: Order;
6525
6208
  metadata: EventMetadata;
6526
6209
  }
6527
- interface PreparePaymentCollectionOptions {
6210
+ /**
6211
+ * Triggered when an order is created.
6212
+ * Learn more about [webhook payload structure](https://dev.wix.com/docs/rest/api-reference/wix-e-commerce/orders/order-object-conversion#webhook-conversion-table).
6213
+ * @permissionScope Manage Stores - all permissions
6214
+ * @permissionScopeId SCOPE.DC-STORES-MEGA.MANAGE-STORES
6215
+ * @permissionScope Read eCommerce - all read permissions
6216
+ * @permissionScopeId SCOPE.DC-ECOM-MEGA.READ-ECOM
6217
+ * @permissionScope Read Orders
6218
+ * @permissionScopeId SCOPE.DC-STORES.READ-ORDERS
6219
+ * @permissionScope Read Stores - all read permissions
6220
+ * @permissionScopeId SCOPE.DC-STORES-MEGA.READ-STORES
6221
+ * @permissionScope Manage Restaurants - all permissions
6222
+ * @permissionScopeId SCOPE.RESTAURANTS.MEGA-SCOPES
6223
+ * @permissionScope Manage eCommerce - all permissions
6224
+ * @permissionScopeId SCOPE.DC-ECOM-MEGA.MANAGE-ECOM
6225
+ * @permissionScope Manage Orders
6226
+ * @permissionScopeId SCOPE.DC-STORES.MANAGE-ORDERS
6227
+ * @permissionId ECOM.READ_ORDERS
6228
+ * @webhook
6229
+ * @eventType wix.ecom.v1.order_created
6230
+ * @serviceIdentifier com.wix.ecom.orders.v1.Orders
6231
+ * @slug created
6232
+ */
6233
+ export declare function onOrderCreated(handler: (event: OrderCreatedEnvelope) => void | Promise<void>): void;
6234
+ type OrderNonNullablePaths = `number` | `lineItems` | `lineItems.${number}._id` | `lineItems.${number}.productName.original` | `lineItems.${number}.catalogReference.catalogItemId` | `lineItems.${number}.catalogReference.appId` | `lineItems.${number}.quantity` | `lineItems.${number}.totalDiscount.amount` | `lineItems.${number}.totalDiscount.formattedAmount` | `lineItems.${number}.descriptionLines` | `lineItems.${number}.descriptionLines.${number}.plainText.original` | `lineItems.${number}.descriptionLines.${number}.colorInfo.original` | `lineItems.${number}.descriptionLines.${number}.name.original` | `lineItems.${number}.physicalProperties.shippable` | `lineItems.${number}.itemType.preset` | `lineItems.${number}.itemType.custom` | `lineItems.${number}.paymentOption` | `lineItems.${number}.taxDetails.taxRate` | `lineItems.${number}.taxInfo.taxIncludedInPrice` | `lineItems.${number}.taxInfo.taxBreakdown` | `lineItems.${number}.taxInfo.taxBreakdown.${number}.jurisdictionType` | `lineItems.${number}.digitalFile.fileId` | `lineItems.${number}.subscriptionInfo.cycleNumber` | `lineItems.${number}.subscriptionInfo.subscriptionOptionTitle` | `lineItems.${number}.subscriptionInfo.subscriptionSettings.frequency` | `lineItems.${number}.subscriptionInfo.subscriptionSettings.autoRenewal` | `lineItems.${number}.priceDescription.original` | `lineItems.${number}.locations` | `lineItems.${number}.locations.${number}._id` | `lineItems.${number}.locations.${number}.quantity` | `buyerInfo.visitorId` | `buyerInfo.memberId` | `paymentStatus` | `fulfillmentStatus` | `weightUnit` | `taxIncludedInPrices` | `priceSummary.subtotal.amount` | `priceSummary.subtotal.formattedAmount` | `billingInfo.address.streetAddress.number` | `billingInfo.address.streetAddress.name` | `billingInfo.contactDetails.vatId._id` | `billingInfo.contactDetails.vatId.type` | `shippingInfo.title` | `shippingInfo.logistics.shippingDestination.address.streetAddress.number` | `shippingInfo.logistics.shippingDestination.address.streetAddress.name` | `shippingInfo.logistics.shippingDestination.contactDetails.vatId._id` | `shippingInfo.logistics.shippingDestination.contactDetails.vatId.type` | `shippingInfo.logistics.pickupDetails.pickupMethod` | `shippingInfo.cost.price.amount` | `shippingInfo.cost.price.formattedAmount` | `shippingInfo.cost.taxDetails.taxRate` | `status` | `taxSummary.totalTax.amount` | `taxSummary.totalTax.formattedAmount` | `taxInfo.totalTax.amount` | `taxInfo.totalTax.formattedAmount` | `taxInfo.taxBreakdown` | `taxInfo.taxBreakdown.${number}.taxName` | `taxInfo.taxBreakdown.${number}.taxType` | `taxInfo.taxBreakdown.${number}.jurisdiction` | `taxInfo.taxBreakdown.${number}.jurisdictionType` | `taxInfo.taxBreakdown.${number}.rate` | `appliedDiscounts` | `appliedDiscounts.${number}.coupon._id` | `appliedDiscounts.${number}.coupon.code` | `appliedDiscounts.${number}.coupon.name` | `appliedDiscounts.${number}.coupon.amount.amount` | `appliedDiscounts.${number}.coupon.amount.formattedAmount` | `appliedDiscounts.${number}.merchantDiscount.discountReason` | `appliedDiscounts.${number}.discountRule._id` | `appliedDiscounts.${number}.discountRule.name.original` | `appliedDiscounts.${number}.discountType` | `appliedDiscounts.${number}.lineItemIds` | `activities` | `activities.${number}.customActivity.appId` | `activities.${number}.customActivity.type` | `activities.${number}.merchantComment.message` | `activities.${number}.orderRefunded.manual` | `activities.${number}.orderRefunded.amount.amount` | `activities.${number}.orderRefunded.amount.formattedAmount` | `activities.${number}.orderRefunded.reason` | `activities.${number}.type` | `attributionSource` | `createdBy.userId` | `createdBy.memberId` | `createdBy.visitorId` | `createdBy.appId` | `channelInfo.type` | `customFields` | `customFields.${number}.title` | `balanceSummary.balance.amount` | `balanceSummary.balance.formattedAmount` | `balanceSummary.paid.amount` | `balanceSummary.paid.formattedAmount` | `additionalFees` | `additionalFees.${number}.name` | `additionalFees.${number}.price.amount` | `additionalFees.${number}.price.formattedAmount` | `additionalFees.${number}.taxDetails.taxRate` | `additionalFees.${number}._id` | `additionalFees.${number}.lineItemIds` | `recipientInfo.address.streetAddress.number` | `recipientInfo.address.streetAddress.name` | `recipientInfo.contactDetails.vatId._id` | `recipientInfo.contactDetails.vatId.type` | `tags.privateTags.tagIds` | `businessLocation._id` | `businessLocation.name`;
6235
+ /**
6236
+ * Prepares payment collection for given ecom order. This is the first of 2-step process of payment collection.
6237
+ * Here we ensure that payment collection is possible for given order and store and prepare payment gateway order for future charge.
6238
+ * 2nd step is an actual charge of prepared payment gateway order. This could be done either
6239
+ * via Wix-Cashier's API (https://bo.wix.com/wix-docs/rest/wix-cashier/pay/charge/charge-for-order)
6240
+ * or using Cashier Payments Widget (https://github.com/wix-private/cashier-client/tree/master/packages/cashier-payments-widget)
6241
+ * @param ecomOrderId - Ecom order ID.
6242
+ * @param amount - Amount to collect
6243
+ * @public
6244
+ * @documentationMaturity preview
6245
+ * @requiredField amount
6246
+ * @requiredField ecomOrderId
6247
+ * @permissionId ECOM.COLLECT_PAYMENTS
6248
+ * @permissionScope Manage Restaurants - all permissions
6249
+ * @permissionScopeId SCOPE.RESTAURANTS.MEGA-SCOPES
6250
+ * @permissionScope Picasso private app mega scope
6251
+ * @permissionScopeId SCOPE.TEST.MEGA-PICASSO-MANAGE-SITE
6252
+ * @applicableIdentity APP
6253
+ * @fqn com.wix.ecom.orders.payments_collector.v1.PaymentsCollector.PreparePaymentCollection
6254
+ */
6255
+ export declare function preparePaymentCollection(ecomOrderId: string, amount: Price, options?: PreparePaymentCollectionOptions): Promise<NonNullablePaths<PreparePaymentCollectionResponse, `paymentGatewayOrderId`>>;
6256
+ export interface PreparePaymentCollectionOptions {
6528
6257
  /**
6529
6258
  * Optional parameter. When present, payment collection will be performed using given payment gateway order.
6530
6259
  * Existing payment gateway order will be updated with a new amount.
@@ -6543,11 +6272,28 @@ interface PreparePaymentCollectionOptions {
6543
6272
  /** Delayed capture payment settings */
6544
6273
  delayedCaptureSettings?: DelayedCaptureSettings;
6545
6274
  }
6546
- interface PaymentCollectionCreatePaymentGatewayOrderOptions {
6275
+ /**
6276
+ * Provides payment collectability status for given order. If payment collection is possible
6277
+ * response will contain collectable amount for given ecom order. If not - response will contain
6278
+ * reason why payment collection is not possible.
6279
+ * @param ecomOrderId - Ecom order ID.
6280
+ * @public
6281
+ * @documentationMaturity preview
6282
+ * @requiredField ecomOrderId
6283
+ * @permissionId ECOM.COLLECT_PAYMENTS
6284
+ * @permissionScope Manage Restaurants - all permissions
6285
+ * @permissionScopeId SCOPE.RESTAURANTS.MEGA-SCOPES
6286
+ * @permissionScope Picasso private app mega scope
6287
+ * @permissionScopeId SCOPE.TEST.MEGA-PICASSO-MANAGE-SITE
6288
+ * @applicableIdentity APP
6289
+ * @fqn com.wix.ecom.orders.payments_collector.v1.PaymentsCollector.GetPaymentCollectabilityStatus
6290
+ */
6291
+ export declare function getPaymentCollectabilityStatus(ecomOrderId: string): Promise<NonNullablePaths<GetPaymentCollectabilityStatusResponse, `status` | `amount.amount` | `amount.formattedAmount`>>;
6292
+ export interface PaymentCollectionCreatePaymentGatewayOrderOptions {
6547
6293
  /** Information about the user who initiated the payment. */
6548
6294
  chargedBy?: ChargedBy;
6549
6295
  }
6550
- interface ChargeMembershipsOptions {
6296
+ export interface ChargeMembershipsOptions {
6551
6297
  /**
6552
6298
  * List of items to be paid by memberships
6553
6299
  * @minSize 1
@@ -6555,21 +6301,223 @@ interface ChargeMembershipsOptions {
6555
6301
  */
6556
6302
  membershipCharges?: MembershipChargeItem[];
6557
6303
  }
6558
- interface TriggerRefundOptions {
6304
+ export interface TriggerRefundOptions {
6559
6305
  /** Business model of a refund */
6560
6306
  details?: RefundDetails;
6561
6307
  /** Side effect details related to refund */
6562
6308
  sideEffects?: RefundSideEffects;
6563
6309
  }
6564
- interface SearchOrdersOptions {
6310
+ /**
6311
+ * Void authorized payments
6312
+ * Transaction statuses for related payments will be updated in async way
6313
+ * @param ecomOrderId - Wix eCommerce order ID
6314
+ * @param paymentIds - Payment IDs
6315
+ * @public
6316
+ * @documentationMaturity preview
6317
+ * @requiredField ecomOrderId
6318
+ * @requiredField paymentIds
6319
+ * @permissionId ECOM.ORDER_VOID_AUTHORIZED_PAYMENT
6320
+ * @permissionScope Manage Stores - all permissions
6321
+ * @permissionScopeId SCOPE.DC-STORES-MEGA.MANAGE-STORES
6322
+ * @permissionScope Manage Restaurants - all permissions
6323
+ * @permissionScopeId SCOPE.RESTAURANTS.MEGA-SCOPES
6324
+ * @permissionScope Manage eCommerce - all permissions
6325
+ * @permissionScopeId SCOPE.DC-ECOM-MEGA.MANAGE-ECOM
6326
+ * @permissionScope Picasso private app mega scope
6327
+ * @permissionScopeId SCOPE.TEST.MEGA-PICASSO-MANAGE-SITE
6328
+ * @permissionScope Manage Orders
6329
+ * @permissionScopeId SCOPE.DC-STORES.MANAGE-ORDERS
6330
+ * @applicableIdentity APP
6331
+ * @fqn com.wix.ecom.orders.payments_collector.v1.PaymentsCollector.VoidAuthorizedPayments
6332
+ */
6333
+ export declare function voidAuthorizedPayments(ecomOrderId: string, paymentIds: string[]): Promise<NonNullablePaths<VoidAuthorizedPaymentsResponse, `orderTransactions.orderId` | `orderTransactions.payments` | `orderTransactions.payments.${number}.regularPaymentDetails.offlinePayment` | `orderTransactions.payments.${number}.regularPaymentDetails.status` | `orderTransactions.payments.${number}.regularPaymentDetails.savedPaymentMethod` | `orderTransactions.payments.${number}.regularPaymentDetails.authorizationDetails.delayedCapture` | `orderTransactions.payments.${number}.regularPaymentDetails.authorizationDetails.captures` | `orderTransactions.payments.${number}.regularPaymentDetails.authorizationDetails.captures.${number}.status` | `orderTransactions.payments.${number}.regularPaymentDetails.authorizationDetails.captures.${number}.amount.amount` | `orderTransactions.payments.${number}.regularPaymentDetails.authorizationDetails.captures.${number}.amount.formattedAmount` | `orderTransactions.payments.${number}.regularPaymentDetails.authorizationDetails.captures.${number}.failureDetails.failureCode` | `orderTransactions.payments.${number}.regularPaymentDetails.authorizationDetails.void.status` | `orderTransactions.payments.${number}.regularPaymentDetails.authorizationDetails.void.reason` | `orderTransactions.payments.${number}.regularPaymentDetails.authorizationDetails.scheduledAction.actionType` | `orderTransactions.payments.${number}.giftcardPaymentDetails.giftCardPaymentId` | `orderTransactions.payments.${number}.giftcardPaymentDetails.appId` | `orderTransactions.payments.${number}.giftcardPaymentDetails.voided` | `orderTransactions.payments.${number}.refundDisabled` | `orderTransactions.refunds` | `orderTransactions.refunds.${number}._id` | `orderTransactions.refunds.${number}.transactions` | `orderTransactions.refunds.${number}.transactions.${number}.paymentId` | `orderTransactions.refunds.${number}.transactions.${number}.refundStatus` | `orderTransactions.refunds.${number}.transactions.${number}.externalRefund` | `orderTransactions.refunds.${number}.details.items` | `orderTransactions.refunds.${number}.details.items.${number}.lineItemId` | `orderTransactions.refunds.${number}.details.items.${number}.quantity` | `orderTransactions.refunds.${number}.details.shippingIncluded` | `orderTransactions.refunds.${number}.details.lineItems` | `orderTransactions.refunds.${number}.details.lineItems.${number}.lineItemId` | `orderTransactions.refunds.${number}.details.lineItems.${number}.quantity` | `orderTransactions.refunds.${number}.details.additionalFees` | `orderTransactions.refunds.${number}.details.additionalFees.${number}.additionalFeeId` | `orderTransactions.refunds.${number}.summary.pending` | `orderTransactions.refunds.${number}.summary.breakdown.lineItems` | `orderTransactions.refunds.${number}.summary.breakdown.lineItems.${number}.lineItemId`>>;
6334
+ /**
6335
+ * Capture authorized payments
6336
+ * Transaction statuses for related payments will be updated in async way
6337
+ * @param ecomOrderId - Wix eCommerce order ID
6338
+ * @param payments - Capture payments information
6339
+ * @public
6340
+ * @documentationMaturity preview
6341
+ * @requiredField ecomOrderId
6342
+ * @requiredField payments
6343
+ * @requiredField payments.paymentId
6344
+ * @permissionId ECOM.ORDER_CAPTURE_AUTHORIZED_PAYMENT
6345
+ * @permissionScope Manage Stores - all permissions
6346
+ * @permissionScopeId SCOPE.DC-STORES-MEGA.MANAGE-STORES
6347
+ * @permissionScope Manage Restaurants - all permissions
6348
+ * @permissionScopeId SCOPE.RESTAURANTS.MEGA-SCOPES
6349
+ * @permissionScope Manage eCommerce - all permissions
6350
+ * @permissionScopeId SCOPE.DC-ECOM-MEGA.MANAGE-ECOM
6351
+ * @permissionScope Picasso private app mega scope
6352
+ * @permissionScopeId SCOPE.TEST.MEGA-PICASSO-MANAGE-SITE
6353
+ * @permissionScope Manage Orders
6354
+ * @permissionScopeId SCOPE.DC-STORES.MANAGE-ORDERS
6355
+ * @applicableIdentity APP
6356
+ * @fqn com.wix.ecom.orders.payments_collector.v1.PaymentsCollector.CaptureAuthorizedPayments
6357
+ */
6358
+ export declare function captureAuthorizedPayments(ecomOrderId: string, payments: NonNullablePaths<PaymentCapture, `paymentId`>[]): Promise<NonNullablePaths<CaptureAuthorizedPaymentsResponse, `orderTransactions.orderId` | `orderTransactions.payments` | `orderTransactions.payments.${number}.regularPaymentDetails.offlinePayment` | `orderTransactions.payments.${number}.regularPaymentDetails.status` | `orderTransactions.payments.${number}.regularPaymentDetails.savedPaymentMethod` | `orderTransactions.payments.${number}.regularPaymentDetails.authorizationDetails.delayedCapture` | `orderTransactions.payments.${number}.regularPaymentDetails.authorizationDetails.captures` | `orderTransactions.payments.${number}.regularPaymentDetails.authorizationDetails.captures.${number}.status` | `orderTransactions.payments.${number}.regularPaymentDetails.authorizationDetails.captures.${number}.amount.amount` | `orderTransactions.payments.${number}.regularPaymentDetails.authorizationDetails.captures.${number}.amount.formattedAmount` | `orderTransactions.payments.${number}.regularPaymentDetails.authorizationDetails.captures.${number}.failureDetails.failureCode` | `orderTransactions.payments.${number}.regularPaymentDetails.authorizationDetails.void.status` | `orderTransactions.payments.${number}.regularPaymentDetails.authorizationDetails.void.reason` | `orderTransactions.payments.${number}.regularPaymentDetails.authorizationDetails.scheduledAction.actionType` | `orderTransactions.payments.${number}.giftcardPaymentDetails.giftCardPaymentId` | `orderTransactions.payments.${number}.giftcardPaymentDetails.appId` | `orderTransactions.payments.${number}.giftcardPaymentDetails.voided` | `orderTransactions.payments.${number}.refundDisabled` | `orderTransactions.refunds` | `orderTransactions.refunds.${number}._id` | `orderTransactions.refunds.${number}.transactions` | `orderTransactions.refunds.${number}.transactions.${number}.paymentId` | `orderTransactions.refunds.${number}.transactions.${number}.refundStatus` | `orderTransactions.refunds.${number}.transactions.${number}.externalRefund` | `orderTransactions.refunds.${number}.details.items` | `orderTransactions.refunds.${number}.details.items.${number}.lineItemId` | `orderTransactions.refunds.${number}.details.items.${number}.quantity` | `orderTransactions.refunds.${number}.details.shippingIncluded` | `orderTransactions.refunds.${number}.details.lineItems` | `orderTransactions.refunds.${number}.details.lineItems.${number}.lineItemId` | `orderTransactions.refunds.${number}.details.lineItems.${number}.quantity` | `orderTransactions.refunds.${number}.details.additionalFees` | `orderTransactions.refunds.${number}.details.additionalFees.${number}.additionalFeeId` | `orderTransactions.refunds.${number}.summary.pending` | `orderTransactions.refunds.${number}.summary.breakdown.lineItems` | `orderTransactions.refunds.${number}.summary.breakdown.lineItems.${number}.lineItemId`>>;
6359
+ /**
6360
+ * Retrieves an order.
6361
+ *
6362
+ *
6363
+ * The `getOrder()` function returns a Promise that resolves when the specified order is retrieved.
6364
+ *
6365
+ * To retrieve an order's payment and refund details, including amounts, payment methods, and payment statuses, pass the order ID to [`listTransactionsForSingleOrder( )`](https://www.wix.com/velo/reference/wix-ecom-backend/ordertransactions/listtransactionsforsingleorder).
6366
+ * @param _id - ID of the order to retrieve.
6367
+ * @public
6368
+ * @requiredField _id
6369
+ * @permissionId ECOM.READ_ORDERS
6370
+ * @permissionId ECOM.ORDER_READ_ALL_EXTENDED_FIELDS
6371
+ * @permissionScope Manage Stores - all permissions
6372
+ * @permissionScopeId SCOPE.DC-STORES-MEGA.MANAGE-STORES
6373
+ * @permissionScope Read eCommerce - all read permissions
6374
+ * @permissionScopeId SCOPE.DC-ECOM-MEGA.READ-ECOM
6375
+ * @permissionScope Read Orders
6376
+ * @permissionScopeId SCOPE.DC-STORES.READ-ORDERS
6377
+ * @permissionScope Read Stores - all read permissions
6378
+ * @permissionScopeId SCOPE.DC-STORES-MEGA.READ-STORES
6379
+ * @permissionScope Manage Restaurants - all permissions
6380
+ * @permissionScopeId SCOPE.RESTAURANTS.MEGA-SCOPES
6381
+ * @permissionScope Manage eCommerce - all permissions
6382
+ * @permissionScopeId SCOPE.DC-ECOM-MEGA.MANAGE-ECOM
6383
+ * @permissionScope Manage Orders
6384
+ * @permissionScopeId SCOPE.DC-STORES.MANAGE-ORDERS
6385
+ * @applicableIdentity APP
6386
+ * @returns Fulfilled - The requested order.
6387
+ * @fqn com.wix.ecom.orders.v1.Orders.GetOrder
6388
+ */
6389
+ export declare function getOrder(_id: string): Promise<NonNullablePaths<Order, OrderNonNullablePaths>>;
6390
+ /**
6391
+ * Retrieves a list of orders, given the provided paging, filtering, and sorting.
6392
+ *
6393
+ *
6394
+ * Search Orders runs with these defaults, which you can override:
6395
+ *
6396
+ * - `createdDate` is sorted in `DESC` order
6397
+ * - `cursorPaging.limit` is `100`
6398
+ * - `filter: {"status": {"$ne": "INITIALIZED"}}` - other order statuses can be queried, but orders with `status: "INITIALIZED"` are never returned
6399
+ *
6400
+ * For field support for filters and sorting, see [Orders: Supported Filters and Sorting](https://dev.wix.com/docs/rest/api-reference/wix-e-commerce/orders/supported-filters-and-sorting).
6401
+ *
6402
+ * To learn about working with _Search_ endpoints, see
6403
+ * [API Query Language](https://dev.wix.com/docs/rest/articles/getting-started/api-query-language), and
6404
+ * [Sorting and Paging](https://dev.wix.com/docs/rest/articles/getting-started/sorting-and-paging).
6405
+ * @public
6406
+ * @permissionId ECOM.READ_ORDERS
6407
+ * @permissionScope Manage Stores - all permissions
6408
+ * @permissionScopeId SCOPE.DC-STORES-MEGA.MANAGE-STORES
6409
+ * @permissionScope Read eCommerce - all read permissions
6410
+ * @permissionScopeId SCOPE.DC-ECOM-MEGA.READ-ECOM
6411
+ * @permissionScope Read Orders
6412
+ * @permissionScopeId SCOPE.DC-STORES.READ-ORDERS
6413
+ * @permissionScope Read Stores - all read permissions
6414
+ * @permissionScopeId SCOPE.DC-STORES-MEGA.READ-STORES
6415
+ * @permissionScope Manage Restaurants - all permissions
6416
+ * @permissionScopeId SCOPE.RESTAURANTS.MEGA-SCOPES
6417
+ * @permissionScope Manage eCommerce - all permissions
6418
+ * @permissionScopeId SCOPE.DC-ECOM-MEGA.MANAGE-ECOM
6419
+ * @permissionScope Manage Orders
6420
+ * @permissionScopeId SCOPE.DC-STORES.MANAGE-ORDERS
6421
+ * @applicableIdentity APP
6422
+ * @fqn com.wix.ecom.orders.v1.Orders.SearchOrders
6423
+ */
6424
+ export declare function searchOrders(options?: SearchOrdersOptions): Promise<NonNullablePaths<SearchOrdersResponse, {
6425
+ [P in OrderNonNullablePaths]: `orders.${number}.${P}`;
6426
+ }[OrderNonNullablePaths]>>;
6427
+ export interface SearchOrdersOptions {
6565
6428
  /** Search options. */
6566
6429
  search?: CursorSearch;
6567
6430
  }
6568
- interface CreateOrderOptions {
6431
+ /**
6432
+ * Creates an order.
6433
+ *
6434
+ *
6435
+ * The `createOrder()` function returns a Promise that resolves when the order is created.
6436
+ *
6437
+ * > **Notes:**
6438
+ * > + If an item is digital - `lineItems[i].itemType.preset: DIGITAL` - then `lineItems[i].digitalFile` must be provided.
6439
+ * > + If `lineItems[i].id` is passed, it must be either a valid GUID, or empty.
6440
+ * @param order - Order info.
6441
+ * @public
6442
+ * @requiredField order
6443
+ * @requiredField order.billingInfo.contactDetails
6444
+ * @requiredField order.channelInfo
6445
+ * @requiredField order.currencyConversionDetails.conversionRate
6446
+ * @requiredField order.currencyConversionDetails.originalCurrency
6447
+ * @requiredField order.lineItems
6448
+ * @requiredField order.lineItems.catalogReference.appId
6449
+ * @requiredField order.lineItems.catalogReference.catalogItemId
6450
+ * @requiredField order.lineItems.itemType
6451
+ * @requiredField order.lineItems.price
6452
+ * @requiredField order.lineItems.productName
6453
+ * @requiredField order.lineItems.productName.original
6454
+ * @requiredField order.lineItems.quantity
6455
+ * @requiredField order.priceSummary
6456
+ * @permissionId ECOM.CREATE_ORDERS
6457
+ * @permissionId ECOM.ORDER_WRITE_ALL_EXTENDED_FIELDS
6458
+ * @permissionScope Manage Stores - all permissions
6459
+ * @permissionScopeId SCOPE.DC-STORES-MEGA.MANAGE-STORES
6460
+ * @permissionScope Manage Restaurants - all permissions
6461
+ * @permissionScopeId SCOPE.RESTAURANTS.MEGA-SCOPES
6462
+ * @permissionScope Manage eCommerce - all permissions
6463
+ * @permissionScopeId SCOPE.DC-ECOM-MEGA.MANAGE-ECOM
6464
+ * @permissionScope Manage Orders
6465
+ * @permissionScopeId SCOPE.DC-STORES.MANAGE-ORDERS
6466
+ * @applicableIdentity APP
6467
+ * @returns Newly created order.
6468
+ * @fqn com.wix.ecom.orders.v1.Orders.CreateOrder
6469
+ */
6470
+ export declare function createOrder(order: NonNullablePaths<Order, `billingInfo.contactDetails` | `channelInfo` | `currencyConversionDetails.conversionRate` | `currencyConversionDetails.originalCurrency` | `lineItems` | `lineItems.${number}.catalogReference.appId` | `lineItems.${number}.catalogReference.catalogItemId` | `lineItems.${number}.itemType` | `lineItems.${number}.price` | `lineItems.${number}.productName` | `lineItems.${number}.productName.original` | `lineItems.${number}.quantity` | `priceSummary`>, options?: CreateOrderOptions): Promise<NonNullablePaths<Order, OrderNonNullablePaths>>;
6471
+ export interface CreateOrderOptions {
6569
6472
  /** Determine order lifecycle */
6570
6473
  settings?: OrderCreationSettings;
6571
6474
  }
6572
- interface UpdateOrder {
6475
+ /**
6476
+ * Updates an order.
6477
+ *
6478
+ *
6479
+ * The `updateOrder()` function returns a Promise that resolves when the specified order's information is updated.
6480
+ *
6481
+ * Currently, the following fields can be updated:
6482
+ * + `order.buyerInfo.email`
6483
+ * + `order.buyerLanguage`
6484
+ * + `order.weightUnit`
6485
+ * + `order.billingInfo.address`
6486
+ * + `order.billingInfo.contactDetails`
6487
+ * + `order.archived`
6488
+ * + `order.attributionSource`
6489
+ * + `order.seenByAHuman`
6490
+ * + `order.recipientInfo.address`
6491
+ * + `order.recipientInfo.contactDetails`
6492
+ * + `order.shippingInfo.logistics.shippingDestination.address`
6493
+ * + `order.shippingInfo.logistics.shippingDestination.contactDetails`
6494
+ *
6495
+ * To update a field's value, include the new value in the `order` object in the method parameters.
6496
+ * To remove a field's value, pass `null`.
6497
+ *
6498
+ * > **Note:** Removing `buyerInfo` or `contactDetails` fields results in an error.
6499
+ *
6500
+ * To update an order's payment status, use [`updatePaymentStatus( )`](https://www.wix.com/velo/reference/wix-ecom-backend/ordertransactions/updatepaymentstatus).
6501
+ * @param _id - Order ID.
6502
+ * @public
6503
+ * @requiredField _id
6504
+ * @requiredField order
6505
+ * @permissionId ECOM.MODIFY_ORDERS
6506
+ * @permissionId ECOM.ORDER_WRITE_ALL_EXTENDED_FIELDS
6507
+ * @permissionScope Manage Stores - all permissions
6508
+ * @permissionScopeId SCOPE.DC-STORES-MEGA.MANAGE-STORES
6509
+ * @permissionScope Manage Restaurants - all permissions
6510
+ * @permissionScopeId SCOPE.RESTAURANTS.MEGA-SCOPES
6511
+ * @permissionScope Manage eCommerce - all permissions
6512
+ * @permissionScopeId SCOPE.DC-ECOM-MEGA.MANAGE-ECOM
6513
+ * @permissionScope Manage Orders
6514
+ * @permissionScopeId SCOPE.DC-STORES.MANAGE-ORDERS
6515
+ * @applicableIdentity APP
6516
+ * @returns Newly created order.
6517
+ * @fqn com.wix.ecom.orders.v1.Orders.UpdateOrder
6518
+ */
6519
+ export declare function updateOrder(_id: string, order: UpdateOrder): Promise<NonNullablePaths<Order, OrderNonNullablePaths>>;
6520
+ export interface UpdateOrder {
6573
6521
  /**
6574
6522
  * Order ID.
6575
6523
  * @format GUID
@@ -6736,14 +6684,54 @@ interface UpdateOrder {
6736
6684
  purchasedDate?: Date | null;
6737
6685
  /** Order Location */
6738
6686
  businessLocation?: Location;
6739
- /**
6740
- * Pay after free trial price summary. Price summary that should be paid for subscriptions after free trial period.
6741
- * @internal
6742
- * @readonly
6743
- */
6744
- payAfterFreeTrial?: PriceSummary;
6745
6687
  }
6746
- interface BulkUpdateOrdersOptions {
6688
+ /**
6689
+ * Updates up to 100 orders.
6690
+ *
6691
+ *
6692
+ * The `bulkUpdateOrders()` function returns a Promise that resolves when the specified orders' information is updated.
6693
+ *
6694
+ * Currently, the following fields can be updated:
6695
+ * + `order.buyerInfo.email`
6696
+ * + `order.buyerLanguage`
6697
+ * + `order.weightUnit`
6698
+ * + `order.billingInfo.address`
6699
+ * + `order.billingInfo.contactDetails`
6700
+ * + `order.archived`
6701
+ * + `order.attributionSource`
6702
+ * + `order.seenByAHuman`
6703
+ * + `order.recipientInfo.address`
6704
+ * + `order.recipientInfo.contactDetails`
6705
+ * + `order.shippingInfo.logistics.shippingDestination.address`
6706
+ * + `order.shippingInfo.logistics.shippingDestination.contactDetails`
6707
+ *
6708
+ * To update a field's value, include the new value in the `orders.order` object in the method parameters.
6709
+ * To remove a field's value, pass `null`.
6710
+ *
6711
+ * > **Note:** Removing `buyerInfo` or `contactDetails` fields results in an error.
6712
+ *
6713
+ * To update an order's payment status, use [`updatePaymentStatus( )`](https://www.wix.com/velo/reference/wix-ecom-backend/ordertransactions/updatepaymentstatus).
6714
+ * @param orders - Orders to update.
6715
+ * @public
6716
+ * @requiredField orders
6717
+ * @requiredField orders.order
6718
+ * @requiredField orders.order._id
6719
+ * @permissionId ECOM.MODIFY_ORDERS
6720
+ * @permissionScope Manage Stores - all permissions
6721
+ * @permissionScopeId SCOPE.DC-STORES-MEGA.MANAGE-STORES
6722
+ * @permissionScope Manage Restaurants - all permissions
6723
+ * @permissionScopeId SCOPE.RESTAURANTS.MEGA-SCOPES
6724
+ * @permissionScope Manage eCommerce - all permissions
6725
+ * @permissionScopeId SCOPE.DC-ECOM-MEGA.MANAGE-ECOM
6726
+ * @permissionScope Manage Orders
6727
+ * @permissionScopeId SCOPE.DC-STORES.MANAGE-ORDERS
6728
+ * @applicableIdentity APP
6729
+ * @fqn com.wix.ecom.orders.v1.Orders.BulkUpdateOrders
6730
+ */
6731
+ export declare function bulkUpdateOrders(orders: NonNullablePaths<MaskedOrder, `order` | `order._id`>[], options?: BulkUpdateOrdersOptions): Promise<NonNullablePaths<BulkUpdateOrdersResponse, `results` | `results.${number}.itemMetadata.originalIndex` | `results.${number}.itemMetadata.success` | `results.${number}.itemMetadata.error.code` | `results.${number}.itemMetadata.error.description` | {
6732
+ [P in OrderNonNullablePaths]: `results.${number}.item.${P}`;
6733
+ }[OrderNonNullablePaths] | `bulkActionMetadata.totalSuccesses` | `bulkActionMetadata.totalFailures` | `bulkActionMetadata.undetailedFailures`>>;
6734
+ export interface BulkUpdateOrdersOptions {
6747
6735
  /**
6748
6736
  * Whether to return the full order entities.
6749
6737
  *
@@ -6751,7 +6739,7 @@ interface BulkUpdateOrdersOptions {
6751
6739
  */
6752
6740
  returnEntity?: boolean;
6753
6741
  }
6754
- interface CommitDeltasOptions {
6742
+ export interface CommitDeltasOptions {
6755
6743
  /**
6756
6744
  * Draft order Id representing this change.
6757
6745
  * Use this ID to get this specific draft content. call .../v1/draft-orders/{draft_order_id}/get
@@ -6768,7 +6756,7 @@ interface CommitDeltasOptions {
6768
6756
  */
6769
6757
  reason?: string | null;
6770
6758
  }
6771
- interface UpdateOrderLineItemIdentifiers {
6759
+ export interface UpdateOrderLineItemIdentifiers {
6772
6760
  /**
6773
6761
  * Order ID
6774
6762
  * @minLength 1
@@ -6781,7 +6769,7 @@ interface UpdateOrderLineItemIdentifiers {
6781
6769
  */
6782
6770
  lineItemId?: string;
6783
6771
  }
6784
- interface UpdateOrderLineItem {
6772
+ export interface UpdateOrderLineItem {
6785
6773
  /**
6786
6774
  * Line item ID.
6787
6775
  * @immutable
@@ -6889,17 +6877,6 @@ interface UpdateOrderLineItem {
6889
6877
  * @maxSize 5
6890
6878
  */
6891
6879
  locations?: LocationAndQuantity[];
6892
- /**
6893
- * Address used for tax calculation.
6894
- * @internal
6895
- */
6896
- taxableAddress?: TaxableAddress;
6897
- /**
6898
- * ID of the app managing the inventory.
6899
- * @internal
6900
- * @format GUID
6901
- */
6902
- inventoryAppId?: string | null;
6903
6880
  /**
6904
6881
  * Custom extended fields for the line item object.
6905
6882
  *
@@ -6907,7 +6884,7 @@ interface UpdateOrderLineItem {
6907
6884
  */
6908
6885
  extendedFields?: ExtendedFields;
6909
6886
  }
6910
- interface UpdateActivityIdentifiers {
6887
+ export interface UpdateActivityIdentifiers {
6911
6888
  /**
6912
6889
  * Order ID.
6913
6890
  * @minLength 1
@@ -6920,7 +6897,7 @@ interface UpdateActivityIdentifiers {
6920
6897
  */
6921
6898
  activityId: string;
6922
6899
  }
6923
- interface DeleteActivityIdentifiers {
6900
+ export interface DeleteActivityIdentifiers {
6924
6901
  /**
6925
6902
  * Order ID.
6926
6903
  * @minLength 1
@@ -6933,7 +6910,30 @@ interface DeleteActivityIdentifiers {
6933
6910
  */
6934
6911
  activityId: string;
6935
6912
  }
6936
- interface CancelOrderOptions {
6913
+ /**
6914
+ * Cancels an order.
6915
+ *
6916
+ *
6917
+ * The `cancelOrder()` function returns a Promise that resolves when the specified order is canceled and the `order.status` field changes to `CANCELED`.
6918
+ * @param _id - Order ID.
6919
+ * @public
6920
+ * @requiredField _id
6921
+ * @permissionId ECOM.MODIFY_ORDERS
6922
+ * @permissionScope Manage Stores - all permissions
6923
+ * @permissionScopeId SCOPE.DC-STORES-MEGA.MANAGE-STORES
6924
+ * @permissionScope Manage Restaurants - all permissions
6925
+ * @permissionScopeId SCOPE.RESTAURANTS.MEGA-SCOPES
6926
+ * @permissionScope Manage eCommerce - all permissions
6927
+ * @permissionScopeId SCOPE.DC-ECOM-MEGA.MANAGE-ECOM
6928
+ * @permissionScope Manage Orders
6929
+ * @permissionScopeId SCOPE.DC-STORES.MANAGE-ORDERS
6930
+ * @applicableIdentity APP
6931
+ * @fqn com.wix.ecom.orders.v1.Orders.CancelOrder
6932
+ */
6933
+ export declare function cancelOrder(_id: string, options?: CancelOrderOptions): Promise<NonNullablePaths<CancelOrderResponse, {
6934
+ [P in OrderNonNullablePaths]: `order.${P}`;
6935
+ }[OrderNonNullablePaths]>>;
6936
+ export interface CancelOrderOptions {
6937
6937
  /** Whether to send an order canceled email to the buyer. */
6938
6938
  sendOrderCanceledEmail?: boolean;
6939
6939
  /**
@@ -6945,7 +6945,7 @@ interface CancelOrderOptions {
6945
6945
  /** Whether to restock all items in the order. This will only apply to products in the Wix Stores inventory. */
6946
6946
  restockAllItems?: boolean;
6947
6947
  }
6948
- interface AggregateOrdersOptions {
6948
+ export interface AggregateOrdersOptions {
6949
6949
  /** Filter applied to original data */
6950
6950
  filter?: Record<string, any> | null;
6951
6951
  /** This is an object defining aggregation itself */
@@ -6961,11 +6961,39 @@ interface AggregateOrdersOptions {
6961
6961
  */
6962
6962
  hierarchySeparatorOverride?: string | null;
6963
6963
  }
6964
- interface BulkUpdateOrderTagsOptions {
6964
+ /**
6965
+ * Synchronously update tags on multiple orders, by list of order IDs.
6966
+ *
6967
+ * > **Note:** If the same tag is passed to both the `assignTags` and `unassignTags` fields, it will be assigned.
6968
+ * @param orderIds - IDs of orders to update tags for.
6969
+ * @public
6970
+ * @requiredField orderIds
6971
+ * @permissionId ECOM.MODIFY_ORDERS
6972
+ * @permissionId ECOM.ORDER_MODIFY_PRIVATE_TAGS
6973
+ * @permissionScope Manage Stores - all permissions
6974
+ * @permissionScopeId SCOPE.DC-STORES-MEGA.MANAGE-STORES
6975
+ * @permissionScope Manage Restaurants - all permissions
6976
+ * @permissionScopeId SCOPE.RESTAURANTS.MEGA-SCOPES
6977
+ * @permissionScope Manage eCommerce - all permissions
6978
+ * @permissionScopeId SCOPE.DC-ECOM-MEGA.MANAGE-ECOM
6979
+ * @permissionScope Manage Orders
6980
+ * @permissionScopeId SCOPE.DC-STORES.MANAGE-ORDERS
6981
+ * @permissionScope Manage Stores - all permissions
6982
+ * @permissionScopeId SCOPE.DC-STORES-MEGA.MANAGE-STORES
6983
+ * @permissionScope Manage Restaurants - all permissions
6984
+ * @permissionScopeId SCOPE.RESTAURANTS.MEGA-SCOPES
6985
+ * @permissionScope Manage eCommerce - all permissions
6986
+ * @permissionScopeId SCOPE.DC-ECOM-MEGA.MANAGE-ECOM
6987
+ * @permissionScope Manage Orders
6988
+ * @permissionScopeId SCOPE.DC-STORES.MANAGE-ORDERS
6989
+ * @applicableIdentity APP
6990
+ * @fqn com.wix.ecom.orders.v1.Orders.BulkUpdateOrderTags
6991
+ */
6992
+ export declare function bulkUpdateOrderTags(orderIds: string[], options?: BulkUpdateOrderTagsOptions): Promise<NonNullablePaths<BulkUpdateOrderTagsResponse, `results` | `results.${number}.itemMetadata.originalIndex` | `results.${number}.itemMetadata.success` | `results.${number}.itemMetadata.error.code` | `results.${number}.itemMetadata.error.description` | `bulkActionMetadata.totalSuccesses` | `bulkActionMetadata.totalFailures` | `bulkActionMetadata.undetailedFailures`>>;
6993
+ export interface BulkUpdateOrderTagsOptions {
6965
6994
  /** Tags to be added to orders */
6966
6995
  assignTags?: Tags;
6967
6996
  /** Tags to be removed from orders */
6968
6997
  unassignTags?: Tags;
6969
6998
  }
6970
-
6971
- export { VatType as $, type AddActivityResponse as A, type BulkMarkOrdersAsPaidResponse as B, type CreatePaymentGatewayOrderResponse as C, type DeleteActivityIdentifiers as D, type UpdateOrderStatusResponse as E, type AggregateOrdersOptions as F, type GetPaymentCollectabilityStatusResponse as G, type AggregateOrdersResponse as H, type BulkUpdateOrderTagsOptions as I, type BulkUpdateOrderTagsResponse as J, DescriptionLineType as K, ItemTypeItemType as L, type MarkOrderAsPaidResponse as M, PaymentOptionType as N, type Order as O, type Price as P, JurisdictionType as Q, SubscriptionFrequency as R, type SearchOrdersOptions as S, type TriggerRefundOptions as T, type UpdateOrder as U, type VoidAuthorizedPaymentsResponse as V, AdjustmentType as W, TaxableAddressType as X, PaymentStatus as Y, FulfillmentStatus as Z, WeightUnit as _, type PreparePaymentCollectionOptions as a, type PriceDescription as a$, PickupMethod as a0, DiscountType as a1, DiscountReason as a2, LineItemQuantityChangeType as a3, ActivityType as a4, AttributionSource as a5, ChannelType as a6, ScheduledAction as a7, DurationUnit as a8, PaymentCollectabilityStatus as a9, ValueType as aA, DepositType as aB, InvoiceStatus as aC, type OrderLineItem as aD, type ProductName as aE, type CatalogReference as aF, type DescriptionLine as aG, type DescriptionLineValueOneOf as aH, type DescriptionLineDescriptionLineValueOneOf as aI, type DescriptionLineName as aJ, type PlainTextValue as aK, type Color as aL, type FocalPoint as aM, type PhysicalProperties as aN, type ItemType as aO, type ItemTypeItemTypeDataOneOf as aP, type ItemTaxFullDetails as aQ, type LineItemTaxInfo as aR, type LineItemTaxBreakdown as aS, type DigitalFile as aT, type SubscriptionInfo as aU, type SubscriptionTitle as aV, type SubscriptionDescription as aW, type SubscriptionSettings as aX, type FreeTrialPeriod as aY, type BillingAdjustment as aZ, type BillingAdjustmentPriceSummary as a_, RefundableStatus as aa, NonRefundableReason as ab, ManuallyRefundableReason as ac, RestockType as ad, TransactionStatus as ae, AuthorizationCaptureStatus as af, AuthorizationVoidStatus as ag, Reason as ah, ActionType as ai, MembershipPaymentStatus as aj, RefundStatus as ak, WebhookIdentityType as al, TextDetection as am, AnimationDetection as an, PreviewEmailType as ao, State as ap, Namespace as aq, SortOrder as ar, VersioningMode as as, OrderApprovalStrategy as at, DeltaPaymentOptionType as au, InventoryAction as av, Placement as aw, SubdivisionType as ax, SourceType as ay, CustomFieldGroup as az, type PreparePaymentCollectionResponse as b, type GiftCardPaymentRefund as b$, type LocationAndQuantity as b0, type TaxableAddress as b1, type TaxableAddressTaxableAddressDataOneOf as b2, type ExtendedFields as b3, type BuyerInfo as b4, type BuyerInfoIdOneOf as b5, type CurrencyConversionDetails as b6, type PriceSummary as b7, type AddressWithContact as b8, type Address as b9, type MerchantComment as bA, type OrderRefunded as bB, type OrderCreatedFromExchange as bC, type NewExchangeOrderCreated as bD, type LineItemExchangeData as bE, type DraftOrderChangesApplied as bF, type OrderChange as bG, type OrderChangeValueOneOf as bH, type LineItemChanges as bI, type LineItemQuantityChange as bJ, type LineItemPriceChange as bK, type ManagedLineItem as bL, type ManagedDiscount as bM, type TranslatedValue as bN, type LineItemAmount as bO, type ManagedAdditionalFee as bP, type TotalPriceChange as bQ, type ShippingInformationChange as bR, type ShippingInformation as bS, type SavedPaymentMethod as bT, type AuthorizedPaymentCreated as bU, type AuthorizedPaymentCaptured as bV, type AuthorizedPaymentVoided as bW, type RefundInitiated as bX, type RefundedPayment as bY, type RefundedPaymentKindOneOf as bZ, type RegularPaymentRefund as b_, type StreetAddress as ba, type AddressLocation as bb, type FullAddressContactDetails as bc, type VatId as bd, type V1ShippingInformation as be, type DeliveryLogistics as bf, type DeliveryLogisticsAddressOneOf as bg, type PickupDetails as bh, type PickupAddress as bi, type DeliveryTimeSlot as bj, type ShippingPrice as bk, type ShippingRegion as bl, type TaxSummary as bm, type OrderTaxInfo as bn, type OrderTaxBreakdown as bo, type AppliedDiscount as bp, type AppliedDiscountDiscountSourceOneOf as bq, type Coupon as br, type MerchantDiscount as bs, type MerchantDiscountMerchantDiscountReasonOneOf as bt, type DiscountRule as bu, type DiscountRuleName as bv, type LineItemDiscount as bw, type Activity as bx, type ActivityContentOneOf as by, type CustomActivity as bz, type GetRefundabilityStatusResponse as c, type AdditionalFeeRefund as c$, type MembershipPaymentRefund as c0, type PaymentRefunded as c1, type PaymentRefundFailed as c2, type RefundedAsStoreCredit as c3, type PaymentPending as c4, type PaymentPendingPaymentDetailsOneOf as c5, type RegularPayment as c6, type RegularPaymentPaymentMethodDetailsOneOf as c7, type CreditCardDetails as c8, type PaymentCanceled as c9, type RedirectUrls as cA, type DelayedCaptureSettings as cB, type Duration as cC, type GetPaymentCollectabilityStatusRequest as cD, type RecordManuallyCollectedPaymentRequest as cE, type RecordManuallyCollectedPaymentResponse as cF, type MarkOrderAsPaidRequest as cG, type PaymentStatusUpdated as cH, type BulkMarkOrdersAsPaidRequest as cI, type BulkOrderResult as cJ, type ItemMetadata as cK, type ApplicationError as cL, type BulkActionMetadata as cM, type GetRefundabilityStatusRequest as cN, type Refundability as cO, type RefundabilityAdditionalRefundabilityInfoOneOf as cP, type CreatePaymentGatewayOrderRequest as cQ, type ChargedBy as cR, type ChargeMembershipsRequest as cS, type MembershipChargeItem as cT, type MembershipName as cU, type ServiceProperties as cV, type ChargeMembershipsResponse as cW, type TriggerRefundRequest as cX, type RefundDetails as cY, type RefundItem as cZ, type LineItemRefund as c_, type PaymentCanceledPaymentDetailsOneOf as ca, type PaymentDeclined as cb, type PaymentDeclinedPaymentDetailsOneOf as cc, type ReceiptCreated as cd, type ReceiptCreatedReceiptInfoOneOf as ce, type WixReceipt as cf, type ExternalReceipt as cg, type ReceiptSent as ch, type ReceiptSentReceiptInfoOneOf as ci, type CreatedBy as cj, type CreatedByStringOneOf as ck, type ChannelInfo as cl, type CustomField as cm, type BalanceSummary as cn, type Balance as co, type AdditionalFee as cp, type FulfillmentStatusesAggregate as cq, type Tags as cr, type TagList as cs, type Location as ct, type OrderApproved as cu, type OrdersExperiments as cv, type OrderRejectedEventOrderRejected as cw, type OrderItemsRestocked as cx, type V1RestockItem as cy, type PreparePaymentCollectionRequest as cz, type PaymentCollectionCreatePaymentGatewayOrderOptions as d, type SendRefundEmailRequest as d$, type ShippingRefund as d0, type RefundSideEffects as d1, type RestockInfo as d2, type RestockItem as d3, type OrderTransactions as d4, type Payment as d5, type PaymentPaymentDetailsOneOf as d6, type PaymentReceiptInfoOneOf as d7, type RegularPaymentDetails as d8, type RegularPaymentDetailsPaymentMethodDetailsOneOf as d9, type DomainEventBodyOneOf as dA, type EntityCreatedEvent as dB, type RestoreInfo as dC, type EntityUpdatedEvent as dD, type EntityDeletedEvent as dE, type ActionEvent as dF, type Empty as dG, type MessageEnvelope as dH, type IdentificationData as dI, type IdentificationDataIdOneOf as dJ, type ImageContent as dK, type SendBuyerConfirmationEmailRequest as dL, type SendBuyerConfirmationEmailResponse as dM, type SendBuyerPaymentsReceivedEmailRequest as dN, type SendBuyerPaymentsReceivedEmailResponse as dO, type SendBuyerPickupConfirmationEmailRequest as dP, type SendBuyerPickupConfirmationEmailResponse as dQ, type BulkSendBuyerPickupConfirmationEmailsRequest as dR, type BulkSendBuyerPickupConfirmationEmailsResponse as dS, type SendBuyerShippingConfirmationEmailRequest as dT, type SendBuyerShippingConfirmationEmailResponse as dU, type BulkSendBuyerShippingConfirmationEmailsRequest as dV, type BulkSendBuyerShippingConfirmationEmailsResponse as dW, type SendMerchantOrderReceivedNotificationRequest as dX, type SendMerchantOrderReceivedNotificationResponse as dY, type SendCancelRefundEmailRequest as dZ, type SendCancelRefundEmailResponse as d_, type CreditCardPaymentMethodDetails as da, type AuthorizationDetails as db, type AuthorizationCapture as dc, type AuthorizationActionFailureDetails as dd, type AuthorizationVoid as de, type V1ScheduledAction as df, type GiftCardPaymentDetails as dg, type MembershipPaymentDetails as dh, type WixReceiptInfo as di, type ExternalReceiptInfo as dj, type Refund as dk, type RefundTransaction as dl, type RefundStatusInfo as dm, type AggregatedRefundSummary as dn, type RefundItemsBreakdown as dp, type LineItemRefundSummary as dq, type CalculateRefundRequest as dr, type CalculateRefundItemRequest as ds, type CalculateRefundResponse as dt, type CalculateRefundItemResponse as du, type VoidAuthorizedPaymentsRequest as dv, type CaptureAuthorizedPaymentsRequest as dw, type ChargeSavedPaymentMethodRequest as dx, type ChargeSavedPaymentMethodResponse as dy, type DomainEvent as dz, type ChargeMembershipsOptions as e, type ErrorInformation as e$, type SendRefundEmailResponse as e0, type SendMerchantOrderReceivedPushRequest as e1, type SendMerchantOrderReceivedPushResponse as e2, type PreviewEmailByTypeRequest as e3, type PreviewEmailByTypeResponse as e4, type PreviewRefundEmailRequest as e5, type PreviewRefundEmailResponse as e6, type PreviewCancelEmailRequest as e7, type PreviewCancelEmailResponse as e8, type PreviewCancelRefundEmailRequest as e9, type Sorting as eA, type PlatformPaging as eB, type CursorPaging as eC, type QueryOrdersForMetasiteResponse as eD, type PlatformPagingMetadata as eE, type Cursors as eF, type GetOrderForMetasiteRequest as eG, type GetOrderForMetasiteResponse as eH, type ListOrderTransactionsForMetasiteRequest as eI, type ListOrderTransactionsForMetasiteResponse as eJ, type UpsertRefundRequest as eK, type UpsertRefundResponse as eL, type UpdateInternalDocumentsEvent as eM, type UpdateInternalDocumentsEventOperationOneOf as eN, type InternalDocument as eO, type InternalDocumentUpdateOperation as eP, type DeleteByIdsOperation as eQ, type DeleteByFilterOperation as eR, type InternalDocumentUpdateByFilterOperation as eS, type InternalUpdateExistingOperation as eT, type VersionedDocumentUpdateOperation as eU, type VersionedDeleteByIdsOperation as eV, type VersionedDocumentId as eW, type TriggerReindexRequest as eX, type TriggerReindexResponse as eY, type BatchOfTriggerReindexOrderRequest as eZ, type DiffmatokyPayload as e_, type PreviewCancelRefundEmailResponse as ea, type PreviewBuyerPaymentsReceivedEmailRequest as eb, type PreviewBuyerPaymentsReceivedEmailResponse as ec, type PreviewBuyerConfirmationEmailRequest as ed, type PreviewBuyerConfirmationEmailResponse as ee, type PreviewBuyerPickupConfirmationEmailRequest as ef, type PreviewBuyerPickupConfirmationEmailResponse as eg, type PreviewShippingConfirmationEmailRequest as eh, type PreviewShippingConfirmationEmailResponse as ei, type PreviewResendDownloadLinksEmailRequest as ej, type PreviewResendDownloadLinksEmailResponse as ek, type TriggerReindexOrderRequest as el, type SnapshotMessage as em, type GetMetasiteDataRequest as en, type GetMetasiteDataResponse as eo, type MetaSite as ep, type App as eq, type SeoData as er, type MetaTag as es, type HtmlApplication as et, type ExternalUriMapping as eu, type UserDataResponse as ev, type QueryOrdersForMetasiteRequest as ew, type InternalQueryOrdersRequest as ex, type PlatformQuery as ey, type PlatformQueryPagingMethodOneOf as ez, type PaymentRefund as f, type UpdateOrderLineItemsResponse as f$, type ContinueSideEffectsFlowInLegacyData as f0, type IndexingMessage as f1, type GetOrderRequest as f2, type GetOrderResponse as f3, type InternalQueryOrdersResponse as f4, type QueryOrderRequest as f5, type QueryOrderResponse as f6, type SearchOrdersRequest as f7, type CursorSearch as f8, type CursorSearchPagingMethodOneOf as f9, type CommittedDiffsShippingUpdateInfoOneOf as fA, type LineItemDelta as fB, type LineItemDeltaDeltaOneOf as fC, type ArchiveOrderRequest as fD, type ArchiveOrderResponse as fE, type BulkArchiveOrdersRequest as fF, type BulkArchiveOrdersResponse as fG, type BulkArchiveOrdersByFilterRequest as fH, type BulkArchiveOrdersByFilterResponse as fI, type UnArchiveOrderRequest as fJ, type UnArchiveOrderResponse as fK, type BulkUnArchiveOrdersRequest as fL, type BulkUnArchiveOrdersResponse as fM, type BulkUnArchiveOrdersByFilterRequest as fN, type BulkUnArchiveOrdersByFilterResponse as fO, type UpdateBuyerInfoRequest as fP, type BuyerInfoUpdate as fQ, type UpdateBuyerInfoResponse as fR, type UpdateBuyerEmailRequest as fS, type UpdateBuyerEmailResponse as fT, type UpdateOrderShippingAddressRequest as fU, type UpdateOrderShippingAddressResponse as fV, type UpdateBillingContactDetailsRequest as fW, type UpdateBillingContactDetailsResponse as fX, type UpdateOrderLineItemRequest as fY, type UpdateOrderLineItemsRequest as fZ, type MaskedOrderLineItem as f_, type CursorPagingMetadata as fa, type CreateOrderRequest as fb, type OrderCreationSettings as fc, type OrderCreateNotifications as fd, type CreateOrderResponse as fe, type UpdateOrderRequest as ff, type UpdateOrderResponse as fg, type BulkUpdateOrdersRequest as fh, type CommitDeltasRequest as fi, type DraftOrderDiffs as fj, type DraftOrderDiffsShippingUpdateInfoOneOf as fk, type DraftOrderDiffsBuyerUpdateInfoOneOf as fl, type DraftOrderDiffsBillingUpdateInfoOneOf as fm, type DraftOrderDiffsRecipientUpdateInfoOneOf as fn, type V1LineItemDelta as fo, type V1LineItemDeltaDeltaOneOf as fp, type OrderLineItemChangedDetails as fq, type ItemChangedDetails as fr, type AppliedDiscountDelta as fs, type AppliedDiscountDeltaDeltaOneOf as ft, type AdditionalFeeDelta as fu, type AdditionalFeeDeltaDeltaOneOf as fv, type DraftOrderCommitSettings as fw, type InventoryUpdateDetails as fx, type OrderDeltasCommitted as fy, type CommittedDiffs as fz, type TriggerRefundResponse as g, type DecrementData as g$, type AddInternalActivityRequest as g0, type InternalActivity as g1, type InternalActivityContentOneOf as g2, type OrderPlaced as g3, type OrderPaid as g4, type OrderFulfilled as g5, type OrderNotFulfilled as g6, type OrderCanceled as g7, type DownloadLinkSent as g8, type TrackingNumberAdded as g9, type UpdateOrderStatusRequest as gA, type MarkAsFulfilledRequest as gB, type MarkAsFulfilledResponse as gC, type FulfillmentStatusUpdated as gD, type BulkMarkAsFulfilledRequest as gE, type BulkMarkAsFulfilledResponse as gF, type BulkMarkAsFulfilledByFilterRequest as gG, type BulkMarkAsFulfilledByFilterResponse as gH, type MarkAsUnfulfilledRequest as gI, type MarkAsUnfulfilledResponse as gJ, type BulkMarkAsUnfulfilledRequest as gK, type BulkMarkAsUnfulfilledResponse as gL, type BulkMarkAsUnfulfilledByFilterRequest as gM, type BulkMarkAsUnfulfilledByFilterResponse as gN, type BulkSetBusinessLocationRequest as gO, type BulkSetBusinessLocationResponse as gP, type BulkSetBusinessLocationResult as gQ, type V1MarkOrderAsPaidRequest as gR, type V1MarkOrderAsPaidResponse as gS, type V1BulkMarkOrdersAsPaidRequest as gT, type V1BulkMarkOrdersAsPaidResponse as gU, type V1CreatePaymentGatewayOrderRequest as gV, type V1CreatePaymentGatewayOrderResponse as gW, type GetShipmentsRequest as gX, type GetShipmentsResponse as gY, type AggregateOrdersRequest as gZ, type DecrementItemsQuantityRequest as g_, type TrackingNumberEdited as ga, type TrackingLinkAdded as gb, type ShippingConfirmationEmailSent as gc, type InvoiceAdded as gd, type InvoiceSent as ge, type FulfillerEmailSent as gf, type ShippingAddressEdited as gg, type EmailEdited as gh, type PickupReadyEmailSent as gi, type OrderPartiallyPaid as gj, type OrderPending as gk, type OrderRejected as gl, type AddInternalActivityResponse as gm, type AddActivityRequest as gn, type PublicActivityContentOneOf as go, type AddActivitiesRequest as gp, type AddActivitiesResponse as gq, type UpdateActivityRequest as gr, type DeleteActivityRequest as gs, type UpdateLineItemsDescriptionLinesRequest as gt, type LineItemUpdate as gu, type UpdateLineItemsDescriptionLinesResponse as gv, type MarkOrderAsSeenByHumanRequest as gw, type MarkOrderAsSeenByHumanResponse as gx, type CancelOrderRequest as gy, type OrderCanceledEventOrderCanceled as gz, type PaymentCapture as h, type DecrementItemsQuantityResponse as h0, type BulkUpdateOrderTagsRequest as h1, type BulkUpdateOrderTagsResult as h2, type Task as h3, type TaskKey as h4, type TaskAction as h5, type TaskActionActionOneOf as h6, type Complete as h7, type Cancel as h8, type Reschedule as h9, type CalculatedTax as hA, type Payments as hB, type InvoicesPayment as hC, type MetaData as hD, type InvoiceDynamicPriceTotals as hE, type CustomFieldValue as hF, type Value as hG, type Deposit as hH, type TriggerSideEffectsFromLegacyData as hI, type BaseEventMetadata as hJ, type EventMetadata as hK, type OrderApprovedEnvelope as hL, type OrderUpdatedEnvelope as hM, type OrderCanceledEnvelope as hN, type OrderCreatedEnvelope as hO, type InvoiceSentEvent as ha, type IdAndVersion as hb, type InvoiceFields as hc, type Customer as hd, type Email as he, type QuotesAddress as hf, type AddressDescription as hg, type Phone as hh, type Company as hi, type CommonAddress as hj, type CommonAddressStreetOneOf as hk, type Subdivision as hl, type StandardDetails as hm, type InvoiceDates as hn, type LineItems as ho, type LineItem as hp, type BigDecimalWrapper as hq, type LineItemTax as hr, type Source as hs, type LineItemMetaData as ht, type Locale as hu, type TotalPrice as hv, type ItemizedFee as hw, type Discount as hx, type DiscountOneDiscountTypeOneOf as hy, type CalculatedTaxes as hz, type CaptureAuthorizedPaymentsResponse as i, type SearchOrdersResponse as j, type CreateOrderOptions as k, type MaskedOrder as l, type BulkUpdateOrdersOptions as m, type BulkUpdateOrdersResponse as n, type CommitDeltasOptions as o, type CommitDeltasResponse as p, type UpdateOrderLineItemIdentifiers as q, type UpdateOrderLineItem as r, type UpdateOrderLineItemResponse as s, type PublicActivity as t, type UpdateActivityIdentifiers as u, type UpdateActivityResponse as v, type DeleteActivityResponse as w, type CancelOrderOptions as x, type CancelOrderResponse as y, OrderStatus as z };
6999
+ export {};