@wix/auto_sdk_ecom_checkout 1.0.15 → 1.0.16

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/{es/src/ecom-v1-checkout-checkout.types.d.ts → ecom-v1-checkout-checkout.universal-C4Y04uL3.d.mts} +658 -376
  2. package/build/{cjs/src/ecom-v1-checkout-checkout.types.d.ts → ecom-v1-checkout-checkout.universal-C4Y04uL3.d.ts} +658 -376
  3. package/build/index.d.mts +211 -0
  4. package/build/index.d.ts +211 -0
  5. package/build/index.js +2781 -0
  6. package/build/index.js.map +1 -0
  7. package/build/index.mjs +2707 -0
  8. package/build/index.mjs.map +1 -0
  9. package/build/internal/{cjs/src/ecom-v1-checkout-checkout.types.d.ts → ecom-v1-checkout-checkout.universal-ClmAJ_ss.d.mts} +867 -376
  10. package/build/internal/{es/src/ecom-v1-checkout-checkout.types.d.ts → ecom-v1-checkout-checkout.universal-ClmAJ_ss.d.ts} +867 -376
  11. package/build/internal/index.d.mts +252 -0
  12. package/build/internal/index.d.ts +252 -0
  13. package/build/internal/index.js +2781 -0
  14. package/build/internal/index.js.map +1 -0
  15. package/build/internal/index.mjs +2707 -0
  16. package/build/internal/index.mjs.map +1 -0
  17. package/build/internal/meta.d.mts +2322 -0
  18. package/build/internal/meta.d.ts +2322 -0
  19. package/build/internal/meta.js +1587 -0
  20. package/build/internal/meta.js.map +1 -0
  21. package/build/internal/meta.mjs +1544 -0
  22. package/build/internal/meta.mjs.map +1 -0
  23. package/build/meta.d.mts +2322 -0
  24. package/build/meta.d.ts +2322 -0
  25. package/build/meta.js +1587 -0
  26. package/build/meta.js.map +1 -0
  27. package/build/meta.mjs +1544 -0
  28. package/build/meta.mjs.map +1 -0
  29. package/package.json +13 -12
  30. package/build/cjs/index.d.ts +0 -1
  31. package/build/cjs/index.js +0 -18
  32. package/build/cjs/index.js.map +0 -1
  33. package/build/cjs/index.typings.d.ts +0 -1
  34. package/build/cjs/index.typings.js +0 -18
  35. package/build/cjs/index.typings.js.map +0 -1
  36. package/build/cjs/meta.d.ts +0 -1
  37. package/build/cjs/meta.js +0 -18
  38. package/build/cjs/meta.js.map +0 -1
  39. package/build/cjs/src/ecom-v1-checkout-checkout.context.d.ts +0 -34
  40. package/build/cjs/src/ecom-v1-checkout-checkout.context.js +0 -77
  41. package/build/cjs/src/ecom-v1-checkout-checkout.context.js.map +0 -1
  42. package/build/cjs/src/ecom-v1-checkout-checkout.http.d.ts +0 -122
  43. package/build/cjs/src/ecom-v1-checkout-checkout.http.js +0 -1338
  44. package/build/cjs/src/ecom-v1-checkout-checkout.http.js.map +0 -1
  45. package/build/cjs/src/ecom-v1-checkout-checkout.meta.d.ts +0 -59
  46. package/build/cjs/src/ecom-v1-checkout-checkout.meta.js +0 -351
  47. package/build/cjs/src/ecom-v1-checkout-checkout.meta.js.map +0 -1
  48. package/build/cjs/src/ecom-v1-checkout-checkout.public.d.ts +0 -186
  49. package/build/cjs/src/ecom-v1-checkout-checkout.public.js +0 -358
  50. package/build/cjs/src/ecom-v1-checkout-checkout.public.js.map +0 -1
  51. package/build/cjs/src/ecom-v1-checkout-checkout.types.js +0 -301
  52. package/build/cjs/src/ecom-v1-checkout-checkout.types.js.map +0 -1
  53. package/build/cjs/src/ecom-v1-checkout-checkout.universal.d.ts +0 -4211
  54. package/build/cjs/src/ecom-v1-checkout-checkout.universal.js +0 -1597
  55. package/build/cjs/src/ecom-v1-checkout-checkout.universal.js.map +0 -1
  56. package/build/es/index.d.ts +0 -1
  57. package/build/es/index.js +0 -2
  58. package/build/es/index.js.map +0 -1
  59. package/build/es/index.typings.d.ts +0 -1
  60. package/build/es/index.typings.js +0 -2
  61. package/build/es/index.typings.js.map +0 -1
  62. package/build/es/meta.d.ts +0 -1
  63. package/build/es/meta.js +0 -2
  64. package/build/es/meta.js.map +0 -1
  65. package/build/es/package.json +0 -3
  66. package/build/es/src/ecom-v1-checkout-checkout.context.d.ts +0 -34
  67. package/build/es/src/ecom-v1-checkout-checkout.context.js +0 -42
  68. package/build/es/src/ecom-v1-checkout-checkout.context.js.map +0 -1
  69. package/build/es/src/ecom-v1-checkout-checkout.http.d.ts +0 -122
  70. package/build/es/src/ecom-v1-checkout-checkout.http.js +0 -1318
  71. package/build/es/src/ecom-v1-checkout-checkout.http.js.map +0 -1
  72. package/build/es/src/ecom-v1-checkout-checkout.meta.d.ts +0 -59
  73. package/build/es/src/ecom-v1-checkout-checkout.meta.js +0 -308
  74. package/build/es/src/ecom-v1-checkout-checkout.meta.js.map +0 -1
  75. package/build/es/src/ecom-v1-checkout-checkout.public.d.ts +0 -186
  76. package/build/es/src/ecom-v1-checkout-checkout.public.js +0 -306
  77. package/build/es/src/ecom-v1-checkout-checkout.public.js.map +0 -1
  78. package/build/es/src/ecom-v1-checkout-checkout.types.js +0 -298
  79. package/build/es/src/ecom-v1-checkout-checkout.types.js.map +0 -1
  80. package/build/es/src/ecom-v1-checkout-checkout.universal.d.ts +0 -4211
  81. package/build/es/src/ecom-v1-checkout-checkout.universal.js +0 -1554
  82. package/build/es/src/ecom-v1-checkout-checkout.universal.js.map +0 -1
  83. package/build/internal/cjs/index.d.ts +0 -1
  84. package/build/internal/cjs/index.js +0 -18
  85. package/build/internal/cjs/index.js.map +0 -1
  86. package/build/internal/cjs/index.typings.d.ts +0 -1
  87. package/build/internal/cjs/index.typings.js +0 -18
  88. package/build/internal/cjs/index.typings.js.map +0 -1
  89. package/build/internal/cjs/meta.d.ts +0 -1
  90. package/build/internal/cjs/meta.js +0 -18
  91. package/build/internal/cjs/meta.js.map +0 -1
  92. package/build/internal/cjs/src/ecom-v1-checkout-checkout.context.d.ts +0 -42
  93. package/build/internal/cjs/src/ecom-v1-checkout-checkout.context.js +0 -77
  94. package/build/internal/cjs/src/ecom-v1-checkout-checkout.context.js.map +0 -1
  95. package/build/internal/cjs/src/ecom-v1-checkout-checkout.http.d.ts +0 -122
  96. package/build/internal/cjs/src/ecom-v1-checkout-checkout.http.js +0 -1338
  97. package/build/internal/cjs/src/ecom-v1-checkout-checkout.http.js.map +0 -1
  98. package/build/internal/cjs/src/ecom-v1-checkout-checkout.meta.d.ts +0 -59
  99. package/build/internal/cjs/src/ecom-v1-checkout-checkout.meta.js +0 -351
  100. package/build/internal/cjs/src/ecom-v1-checkout-checkout.meta.js.map +0 -1
  101. package/build/internal/cjs/src/ecom-v1-checkout-checkout.public.d.ts +0 -219
  102. package/build/internal/cjs/src/ecom-v1-checkout-checkout.public.js +0 -358
  103. package/build/internal/cjs/src/ecom-v1-checkout-checkout.public.js.map +0 -1
  104. package/build/internal/cjs/src/ecom-v1-checkout-checkout.types.js +0 -301
  105. package/build/internal/cjs/src/ecom-v1-checkout-checkout.types.js.map +0 -1
  106. package/build/internal/cjs/src/ecom-v1-checkout-checkout.universal.d.ts +0 -4500
  107. package/build/internal/cjs/src/ecom-v1-checkout-checkout.universal.js +0 -1597
  108. package/build/internal/cjs/src/ecom-v1-checkout-checkout.universal.js.map +0 -1
  109. package/build/internal/es/index.d.ts +0 -1
  110. package/build/internal/es/index.js +0 -2
  111. package/build/internal/es/index.js.map +0 -1
  112. package/build/internal/es/index.typings.d.ts +0 -1
  113. package/build/internal/es/index.typings.js +0 -2
  114. package/build/internal/es/index.typings.js.map +0 -1
  115. package/build/internal/es/meta.d.ts +0 -1
  116. package/build/internal/es/meta.js +0 -2
  117. package/build/internal/es/meta.js.map +0 -1
  118. package/build/internal/es/src/ecom-v1-checkout-checkout.context.d.ts +0 -42
  119. package/build/internal/es/src/ecom-v1-checkout-checkout.context.js +0 -42
  120. package/build/internal/es/src/ecom-v1-checkout-checkout.context.js.map +0 -1
  121. package/build/internal/es/src/ecom-v1-checkout-checkout.http.d.ts +0 -122
  122. package/build/internal/es/src/ecom-v1-checkout-checkout.http.js +0 -1318
  123. package/build/internal/es/src/ecom-v1-checkout-checkout.http.js.map +0 -1
  124. package/build/internal/es/src/ecom-v1-checkout-checkout.meta.d.ts +0 -59
  125. package/build/internal/es/src/ecom-v1-checkout-checkout.meta.js +0 -308
  126. package/build/internal/es/src/ecom-v1-checkout-checkout.meta.js.map +0 -1
  127. package/build/internal/es/src/ecom-v1-checkout-checkout.public.d.ts +0 -219
  128. package/build/internal/es/src/ecom-v1-checkout-checkout.public.js +0 -306
  129. package/build/internal/es/src/ecom-v1-checkout-checkout.public.js.map +0 -1
  130. package/build/internal/es/src/ecom-v1-checkout-checkout.types.js +0 -298
  131. package/build/internal/es/src/ecom-v1-checkout-checkout.types.js.map +0 -1
  132. package/build/internal/es/src/ecom-v1-checkout-checkout.universal.d.ts +0 -4500
  133. package/build/internal/es/src/ecom-v1-checkout-checkout.universal.js +0 -1554
  134. package/build/internal/es/src/ecom-v1-checkout-checkout.universal.js.map +0 -1
@@ -1,1554 +0,0 @@
1
- import { transformError as sdkTransformError } from '@wix/sdk-runtime/transform-error';
2
- import { renameKeysFromSDKRequestToRESTRequest, renameKeysFromRESTResponseToSDKResponse, } from '@wix/sdk-runtime/rename-all-nested-keys';
3
- import * as ambassadorWixEcomV1Checkout from './ecom-v1-checkout-checkout.http.js';
4
- import { transformSDKAddressToRESTAddress } from '@wix/sdk-runtime/transformations/address';
5
- import { transformRESTAddressToSDKAddress } from '@wix/sdk-runtime/transformations/address';
6
- import { transformSDKImageToRESTImage } from '@wix/sdk-runtime/transformations/image';
7
- import { transformRESTImageToSDKImage } from '@wix/sdk-runtime/transformations/image';
8
- import { transformSDKPageURLV2ToRESTPageURLV2 } from '@wix/sdk-runtime/transformations/page-url-v2';
9
- import { transformRESTPageURLV2ToSDKPageURLV2 } from '@wix/sdk-runtime/transformations/page-url-v2';
10
- import { transformPaths } from '@wix/sdk-runtime/transformations/transform-paths';
11
- /** JurisdictionType represents the type of the jurisdiction in which this tax detail applies (e.g. Country,State,County,City,Special). */
12
- export var JurisdictionType;
13
- (function (JurisdictionType) {
14
- JurisdictionType["UNDEFINED"] = "UNDEFINED";
15
- JurisdictionType["COUNTRY"] = "COUNTRY";
16
- JurisdictionType["STATE"] = "STATE";
17
- JurisdictionType["COUNTY"] = "COUNTY";
18
- JurisdictionType["CITY"] = "CITY";
19
- JurisdictionType["SPECIAL"] = "SPECIAL";
20
- })(JurisdictionType || (JurisdictionType = {}));
21
- export var DescriptionLineType;
22
- (function (DescriptionLineType) {
23
- /** Unrecognized type. */
24
- DescriptionLineType["UNRECOGNISED"] = "UNRECOGNISED";
25
- /** Plain text type. */
26
- DescriptionLineType["PLAIN_TEXT"] = "PLAIN_TEXT";
27
- /** Color type. */
28
- DescriptionLineType["COLOR"] = "COLOR";
29
- })(DescriptionLineType || (DescriptionLineType = {}));
30
- export var ItemAvailabilityStatus;
31
- (function (ItemAvailabilityStatus) {
32
- ItemAvailabilityStatus["AVAILABLE"] = "AVAILABLE";
33
- /** Item does not exist. */
34
- ItemAvailabilityStatus["NOT_FOUND"] = "NOT_FOUND";
35
- /** Item is not in stock. */
36
- ItemAvailabilityStatus["NOT_AVAILABLE"] = "NOT_AVAILABLE";
37
- /** Available quantity is less than requested. */
38
- ItemAvailabilityStatus["PARTIALLY_AVAILABLE"] = "PARTIALLY_AVAILABLE";
39
- })(ItemAvailabilityStatus || (ItemAvailabilityStatus = {}));
40
- export var ItemTypeItemType;
41
- (function (ItemTypeItemType) {
42
- ItemTypeItemType["UNRECOGNISED"] = "UNRECOGNISED";
43
- ItemTypeItemType["PHYSICAL"] = "PHYSICAL";
44
- ItemTypeItemType["DIGITAL"] = "DIGITAL";
45
- ItemTypeItemType["GIFT_CARD"] = "GIFT_CARD";
46
- ItemTypeItemType["SERVICE"] = "SERVICE";
47
- })(ItemTypeItemType || (ItemTypeItemType = {}));
48
- /** Frequency unit of recurring payment */
49
- export var SubscriptionFrequency;
50
- (function (SubscriptionFrequency) {
51
- SubscriptionFrequency["UNDEFINED"] = "UNDEFINED";
52
- SubscriptionFrequency["DAY"] = "DAY";
53
- SubscriptionFrequency["WEEK"] = "WEEK";
54
- SubscriptionFrequency["MONTH"] = "MONTH";
55
- SubscriptionFrequency["YEAR"] = "YEAR";
56
- })(SubscriptionFrequency || (SubscriptionFrequency = {}));
57
- export var FileType;
58
- (function (FileType) {
59
- FileType["UNSPECIFIED"] = "UNSPECIFIED";
60
- FileType["SECURE_PICTURE"] = "SECURE_PICTURE";
61
- FileType["SECURE_VIDEO"] = "SECURE_VIDEO";
62
- FileType["SECURE_DOCUMENT"] = "SECURE_DOCUMENT";
63
- FileType["SECURE_MUSIC"] = "SECURE_MUSIC";
64
- FileType["SECURE_ARCHIVE"] = "SECURE_ARCHIVE";
65
- })(FileType || (FileType = {}));
66
- /** Type of selected payment option for catalog item */
67
- export var PaymentOptionType;
68
- (function (PaymentOptionType) {
69
- /** The entire payment for this item happens as part of the checkout. */
70
- PaymentOptionType["FULL_PAYMENT_ONLINE"] = "FULL_PAYMENT_ONLINE";
71
- /** The entire payment for this item happens after checkout. For example, when using cash, check, or other offline payment methods. */
72
- PaymentOptionType["FULL_PAYMENT_OFFLINE"] = "FULL_PAYMENT_OFFLINE";
73
- /** Payment for this item is done by charging a membership. When selected, `price` is `0`. */
74
- PaymentOptionType["MEMBERSHIP"] = "MEMBERSHIP";
75
- /** Partial payment to be paid upfront during checkout. The initial amount to be paid for each line item is specified in `depositAmount`. */
76
- PaymentOptionType["DEPOSIT_ONLINE"] = "DEPOSIT_ONLINE";
77
- /** 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`. */
78
- PaymentOptionType["MEMBERSHIP_OFFLINE"] = "MEMBERSHIP_OFFLINE";
79
- })(PaymentOptionType || (PaymentOptionType = {}));
80
- export var TaxableAddressType;
81
- (function (TaxableAddressType) {
82
- TaxableAddressType["UNKNOWN_TAXABLE_ADDRESS"] = "UNKNOWN_TAXABLE_ADDRESS";
83
- TaxableAddressType["BUSINESS"] = "BUSINESS";
84
- TaxableAddressType["BILLING"] = "BILLING";
85
- TaxableAddressType["SHIPPING"] = "SHIPPING";
86
- })(TaxableAddressType || (TaxableAddressType = {}));
87
- /** tax info types */
88
- export var CommonVatType;
89
- (function (CommonVatType) {
90
- CommonVatType["UNSPECIFIED"] = "UNSPECIFIED";
91
- /** CPF - for individual tax payers. */
92
- CommonVatType["CPF"] = "CPF";
93
- /** CNPJ - for corporations */
94
- CommonVatType["CNPJ"] = "CNPJ";
95
- })(CommonVatType || (CommonVatType = {}));
96
- export var PickupMethod;
97
- (function (PickupMethod) {
98
- PickupMethod["UNKNOWN_METHOD"] = "UNKNOWN_METHOD";
99
- PickupMethod["STORE_PICKUP"] = "STORE_PICKUP";
100
- PickupMethod["PICKUP_POINT"] = "PICKUP_POINT";
101
- })(PickupMethod || (PickupMethod = {}));
102
- export var ChargeType;
103
- (function (ChargeType) {
104
- ChargeType["HANDLING_FEE"] = "HANDLING_FEE";
105
- ChargeType["INSURANCE"] = "INSURANCE";
106
- })(ChargeType || (ChargeType = {}));
107
- export var RuleType;
108
- (function (RuleType) {
109
- RuleType["VALIDATION"] = "VALIDATION";
110
- RuleType["OTHER"] = "OTHER";
111
- RuleType["MAX"] = "MAX";
112
- RuleType["MIN"] = "MIN";
113
- RuleType["MAX_LENGTH"] = "MAX_LENGTH";
114
- RuleType["MIN_LENGTH"] = "MIN_LENGTH";
115
- RuleType["MAX_SIZE"] = "MAX_SIZE";
116
- RuleType["MIN_SIZE"] = "MIN_SIZE";
117
- RuleType["FORMAT"] = "FORMAT";
118
- RuleType["DECIMAL_LTE"] = "DECIMAL_LTE";
119
- RuleType["DECIMAL_GTE"] = "DECIMAL_GTE";
120
- RuleType["DECIMAL_LT"] = "DECIMAL_LT";
121
- RuleType["DECIMAL_GT"] = "DECIMAL_GT";
122
- RuleType["DECIMAL_MAX_SCALE"] = "DECIMAL_MAX_SCALE";
123
- RuleType["INVALID_ENUM_VALUE"] = "INVALID_ENUM_VALUE";
124
- RuleType["REQUIRED_FIELD"] = "REQUIRED_FIELD";
125
- RuleType["FIELD_NOT_ALLOWED"] = "FIELD_NOT_ALLOWED";
126
- RuleType["ONE_OF_ALIGNMENT"] = "ONE_OF_ALIGNMENT";
127
- RuleType["EXACT_LENGTH"] = "EXACT_LENGTH";
128
- RuleType["EXACT_SIZE"] = "EXACT_SIZE";
129
- RuleType["REQUIRED_ONE_OF_FIELD"] = "REQUIRED_ONE_OF_FIELD";
130
- })(RuleType || (RuleType = {}));
131
- export var DiscountType;
132
- (function (DiscountType) {
133
- DiscountType["GLOBAL"] = "GLOBAL";
134
- DiscountType["SPECIFIC_ITEMS"] = "SPECIFIC_ITEMS";
135
- DiscountType["SHIPPING"] = "SHIPPING";
136
- })(DiscountType || (DiscountType = {}));
137
- export var WeightUnit;
138
- (function (WeightUnit) {
139
- /** Weight unit can't be classified due to an error. */
140
- WeightUnit["UNSPECIFIED_WEIGHT_UNIT"] = "UNSPECIFIED_WEIGHT_UNIT";
141
- /** Kilograms. */
142
- WeightUnit["KG"] = "KG";
143
- /** Pounds. */
144
- WeightUnit["LB"] = "LB";
145
- })(WeightUnit || (WeightUnit = {}));
146
- export var RateType;
147
- (function (RateType) {
148
- /** no tax being collected for this request due to location of purchase */
149
- RateType["NO_TAX_COLLECTED"] = "NO_TAX_COLLECTED";
150
- /** manual rate used for calculation */
151
- RateType["MANUAL_RATE"] = "MANUAL_RATE";
152
- /** autotax rate used for calculation */
153
- RateType["AUTO_RATE"] = "AUTO_RATE";
154
- /** fallback rate used for calculation */
155
- RateType["FALLBACK_RATE"] = "FALLBACK_RATE";
156
- })(RateType || (RateType = {}));
157
- export var ManualCalculationReason;
158
- (function (ManualCalculationReason) {
159
- /** user set calculator in Business Manager to be Manual */
160
- ManualCalculationReason["GLOBAL_SETTING_TO_MANUAL"] = "GLOBAL_SETTING_TO_MANUAL";
161
- /** specific region is on manual even though Global setting is Auto-tax */
162
- ManualCalculationReason["REGION_SETTING_TO_MANUAL"] = "REGION_SETTING_TO_MANUAL";
163
- })(ManualCalculationReason || (ManualCalculationReason = {}));
164
- export var FallbackReason;
165
- (function (FallbackReason) {
166
- /** auto-tax failed to be calculated */
167
- FallbackReason["AUTO_TAX_FAILED"] = "AUTO_TAX_FAILED";
168
- /** auto-tax was temporarily deactivated on a system-level */
169
- FallbackReason["AUTO_TAX_DEACTIVATED"] = "AUTO_TAX_DEACTIVATED";
170
- })(FallbackReason || (FallbackReason = {}));
171
- export var ChannelType;
172
- (function (ChannelType) {
173
- /** Unspecified sales channel. This value is not supported. */
174
- ChannelType["UNSPECIFIED"] = "UNSPECIFIED";
175
- /** A web client. */
176
- ChannelType["WEB"] = "WEB";
177
- /** [Point of sale solutions](https://support.wix.com/en/wix-mobile-pos-2196395). */
178
- ChannelType["POS"] = "POS";
179
- /** [eBay shop](https://support.wix.com/en/article/wix-stores-connecting-and-setting-up-an-ebay-shop). */
180
- ChannelType["EBAY"] = "EBAY";
181
- /** [Amazon shop](https://support.wix.com/en/article/wix-stores-connecting-and-setting-up-an-amazon-shop). */
182
- ChannelType["AMAZON"] = "AMAZON";
183
- /** Other sales platform. */
184
- ChannelType["OTHER_PLATFORM"] = "OTHER_PLATFORM";
185
- /** [Wix Owner app](https://support.wix.com/article/wix-owner-app-an-overview). */
186
- ChannelType["WIX_APP_STORE"] = "WIX_APP_STORE";
187
- /** Wix Invoices app in [your dashboard](https://www.wix.com/my-account/site-selector/?buttonText=Select%20Site&title=Select%20a%20Site&autoSelectOnSingleSite=true&actionUrl=https:%2F%2Fwww.wix.com%2Fdashboard%2F%7B%7BmetaSiteId%7D%7D%2Finvoices/settings/general-settings) */
188
- ChannelType["WIX_INVOICES"] = "WIX_INVOICES";
189
- /** Wix merchant backoffice. */
190
- ChannelType["BACKOFFICE_MERCHANT"] = "BACKOFFICE_MERCHANT";
191
- /** Wish sales channel. */
192
- ChannelType["WISH"] = "WISH";
193
- /** [ClassPass sales channel](https://support.wix.com/en/article/wix-bookings-letting-clients-book-your-services-with-classpass). */
194
- ChannelType["CLASS_PASS"] = "CLASS_PASS";
195
- /** Global-E sales channel. */
196
- ChannelType["GLOBAL_E"] = "GLOBAL_E";
197
- /** [Facebook shop](https://support.wix.com/en/article/wix-stores-changes-to-facebook-shops). */
198
- ChannelType["FACEBOOK"] = "FACEBOOK";
199
- /** [Etsy sales channel](https://support.wix.com/en/article/wix-stores-request-adding-etsy-as-a-sales-channel). */
200
- ChannelType["ETSY"] = "ETSY";
201
- /** [TikTok sales channel](https://support.wix.com/en/article/wix-stores-request-adding-tiktok-as-a-sales-channel). */
202
- ChannelType["TIKTOK"] = "TIKTOK";
203
- /** [Faire marketplace integration](https://support.wix.com/en/article/wix-stores-creating-a-faire-store-using-the-faire-integration-app). */
204
- ChannelType["FAIRE_COM"] = "FAIRE_COM";
205
- })(ChannelType || (ChannelType = {}));
206
- export var AdditionalFeeSource;
207
- (function (AdditionalFeeSource) {
208
- AdditionalFeeSource["UNKNOWN_ADDITIONAL_FEE_SOURCE"] = "UNKNOWN_ADDITIONAL_FEE_SOURCE";
209
- /** The additional fee was added by an additional fee service plugin */
210
- AdditionalFeeSource["SERVICE_PLUGIN"] = "SERVICE_PLUGIN";
211
- /** The additional fee was added on the item either via the catalog or on custom line item */
212
- AdditionalFeeSource["ITEM"] = "ITEM";
213
- /** The additional fee was added manually on the request */
214
- AdditionalFeeSource["MANUAL"] = "MANUAL";
215
- })(AdditionalFeeSource || (AdditionalFeeSource = {}));
216
- export var Severity;
217
- (function (Severity) {
218
- /** The user is allowed to move forward in the flow. */
219
- Severity["WARNING"] = "WARNING";
220
- /**
221
- * The user is blocked from moving forward in the flow.
222
- * For example, if callerContext is CART - moving to checkout is blocked. if callerContext is CHECKOUT, placing an order is blocked.
223
- */
224
- Severity["ERROR"] = "ERROR";
225
- })(Severity || (Severity = {}));
226
- /** Available locations on the webpage */
227
- export var NameInOther;
228
- (function (NameInOther) {
229
- /** Default location, in case no specific location is specified. */
230
- NameInOther["OTHER_DEFAULT"] = "OTHER_DEFAULT";
231
- })(NameInOther || (NameInOther = {}));
232
- /** Available locations on the line item */
233
- export var NameInLineItem;
234
- (function (NameInLineItem) {
235
- /** Default location, in case no specific location is specified. */
236
- NameInLineItem["LINE_ITEM_DEFAULT"] = "LINE_ITEM_DEFAULT";
237
- })(NameInLineItem || (NameInLineItem = {}));
238
- export var SuggestedFix;
239
- (function (SuggestedFix) {
240
- /** No suggested fix is specified. The user should refer to the violation description to resolve the issue. */
241
- SuggestedFix["UNKNOWN_SUGGESTED_FIX"] = "UNKNOWN_SUGGESTED_FIX";
242
- /** The line item should be removed from the cart or checkout to resolve the violation. */
243
- SuggestedFix["REMOVE_LINE_ITEM"] = "REMOVE_LINE_ITEM";
244
- })(SuggestedFix || (SuggestedFix = {}));
245
- export var GetCheckoutPaymentSettingsResponsePaymentOption;
246
- (function (GetCheckoutPaymentSettingsResponsePaymentOption) {
247
- GetCheckoutPaymentSettingsResponsePaymentOption["UNKNOWN_PAYMENT_OPTION"] = "UNKNOWN_PAYMENT_OPTION";
248
- GetCheckoutPaymentSettingsResponsePaymentOption["MANUAL"] = "MANUAL";
249
- })(GetCheckoutPaymentSettingsResponsePaymentOption || (GetCheckoutPaymentSettingsResponsePaymentOption = {}));
250
- export var IdentityType;
251
- (function (IdentityType) {
252
- IdentityType["UNSPECIFIED_IDENTITY_TYPE"] = "UNSPECIFIED_IDENTITY_TYPE";
253
- /** Site member */
254
- IdentityType["MEMBER"] = "MEMBER";
255
- /** Contact */
256
- IdentityType["CONTACT"] = "CONTACT";
257
- })(IdentityType || (IdentityType = {}));
258
- export var LineItemType;
259
- (function (LineItemType) {
260
- /** Line item type can't be classified, due to an error */
261
- LineItemType["UNSPECIFIED_LINE_ITEM_TYPE"] = "UNSPECIFIED_LINE_ITEM_TYPE";
262
- /** Physical item type */
263
- LineItemType["PHYSICAL"] = "PHYSICAL";
264
- /** Digital item type */
265
- LineItemType["DIGITAL"] = "DIGITAL";
266
- /** Custom item price */
267
- LineItemType["CUSTOM_AMOUNT_ITEM"] = "CUSTOM_AMOUNT_ITEM";
268
- })(LineItemType || (LineItemType = {}));
269
- export var MediaItemType;
270
- (function (MediaItemType) {
271
- /** Media item type can't be classified, due to an error */
272
- MediaItemType["UNSPECIFIED_MEDIA_TYPE_ITEM"] = "UNSPECIFIED_MEDIA_TYPE_ITEM";
273
- /** Image item type */
274
- MediaItemType["IMAGE"] = "IMAGE";
275
- })(MediaItemType || (MediaItemType = {}));
276
- /** Brazilian tax info types */
277
- export var VatType;
278
- (function (VatType) {
279
- /** When the tax info type can't be classified, due to an error */
280
- VatType["UNSPECIFIED_TAX_TYPE"] = "UNSPECIFIED_TAX_TYPE";
281
- /** CPF - for individual tax payers */
282
- VatType["CPF"] = "CPF";
283
- /** CNPJ - for corporations */
284
- VatType["CNPJ"] = "CNPJ";
285
- })(VatType || (VatType = {}));
286
- export var DiscountDiscountType;
287
- (function (DiscountDiscountType) {
288
- DiscountDiscountType["UNDEFINED"] = "UNDEFINED";
289
- /** No discount */
290
- DiscountDiscountType["AMOUNT"] = "AMOUNT";
291
- DiscountDiscountType["PERCENT"] = "PERCENT";
292
- })(DiscountDiscountType || (DiscountDiscountType = {}));
293
- export var ChannelInfoChannelType;
294
- (function (ChannelInfoChannelType) {
295
- ChannelInfoChannelType["UNSPECIFIED"] = "UNSPECIFIED";
296
- ChannelInfoChannelType["WEB"] = "WEB";
297
- ChannelInfoChannelType["OTHER_PLATFORM"] = "OTHER_PLATFORM";
298
- ChannelInfoChannelType["WIX_APP_STORE"] = "WIX_APP_STORE";
299
- })(ChannelInfoChannelType || (ChannelInfoChannelType = {}));
300
- export var WebhookIdentityType;
301
- (function (WebhookIdentityType) {
302
- WebhookIdentityType["UNKNOWN"] = "UNKNOWN";
303
- WebhookIdentityType["ANONYMOUS_VISITOR"] = "ANONYMOUS_VISITOR";
304
- WebhookIdentityType["MEMBER"] = "MEMBER";
305
- WebhookIdentityType["WIX_USER"] = "WIX_USER";
306
- WebhookIdentityType["APP"] = "APP";
307
- })(WebhookIdentityType || (WebhookIdentityType = {}));
308
- /**
309
- * Creates a checkout.
310
- *
311
- *
312
- * The `createCheckout()` function returns a Promise that resolves to the new checkout when it's created.
313
- *
314
- * > **Notes:**
315
- * > + Checkout must include at least 1 item in the `options.lineItems` array.
316
- * > + `options.channelType` is required.
317
- * > + If `_id` for `options.lineItems` is added, make sure that each `_id` is unique.
318
- * > + If `options.checkoutInfo.customFields` are added, then `options.checkoutInfo.customFields.value` is required.
319
- * @public
320
- * @requiredField options.channelType
321
- * @requiredField options.checkoutInfo.customFields.value
322
- * @requiredField options.checkoutInfo.membershipOptions.selectedMemberships.memberships._id
323
- * @requiredField options.checkoutInfo.membershipOptions.selectedMemberships.memberships.appId
324
- * @requiredField options.checkoutInfo.membershipOptions.selectedMemberships.memberships.lineItemIds
325
- * @requiredField options.customLineItems.descriptionLines.name
326
- * @requiredField options.customLineItems.descriptionLines.value
327
- * @requiredField options.customLineItems.itemType
328
- * @requiredField options.customLineItems.price
329
- * @requiredField options.customLineItems.productName
330
- * @requiredField options.customLineItems.quantity
331
- * @requiredField options.lineItems.catalogReference
332
- * @requiredField options.lineItems.catalogReference.appId
333
- * @requiredField options.lineItems.catalogReference.catalogItemId
334
- * @requiredField options.lineItems.quantity
335
- * @param options - Checkout creation options.
336
- * @permissionId ECOM.MODIFY_CHECKOUTS
337
- * @permissionId ECOM.ADMIN_MODIFY_CHECKOUTS
338
- * @permissionScope Manage Stores - all permissions
339
- * @permissionScopeId SCOPE.DC-STORES-MEGA.MANAGE-STORES
340
- * @permissionScope Manage Restaurants - all permissions
341
- * @permissionScopeId SCOPE.RESTAURANTS.MEGA-SCOPES
342
- * @permissionScope Manage eCommerce - all permissions
343
- * @permissionScopeId SCOPE.DC-ECOM-MEGA.MANAGE-ECOM
344
- * @permissionScope Picasso private app mega scope
345
- * @permissionScopeId SCOPE.TEST.MEGA-PICASSO-MANAGE-SITE
346
- * @permissionScope Manage Orders
347
- * @permissionScopeId SCOPE.DC-STORES.MANAGE-ORDERS
348
- * @permissionScope Manage Stores - all permissions
349
- * @permissionScopeId SCOPE.DC-STORES-MEGA.MANAGE-STORES
350
- * @permissionScope Manage eCommerce - Admin Permissions
351
- * @permissionScopeId SCOPE.ECOM.MANAGE-ADMIN
352
- * @permissionScope Manage Restaurants - all permissions
353
- * @permissionScopeId SCOPE.RESTAURANTS.MEGA-SCOPES
354
- * @permissionScope Manage eCommerce - all permissions
355
- * @permissionScopeId SCOPE.DC-ECOM-MEGA.MANAGE-ECOM
356
- * @permissionScope Picasso private app mega scope
357
- * @permissionScopeId SCOPE.TEST.MEGA-PICASSO-MANAGE-SITE
358
- * @applicableIdentity APP
359
- * @applicableIdentity VISITOR
360
- * @returns Fulfilled - the newly created checkout.
361
- * @fqn com.wix.ecom.checkout.api.v1.CheckoutService.CreateCheckout
362
- */
363
- export async function createCheckout(options) {
364
- // @ts-ignore
365
- const { httpClient, sideEffects } = arguments[1];
366
- const payload = transformPaths(renameKeysFromSDKRequestToRESTRequest({
367
- checkoutInfo: options?.checkoutInfo,
368
- couponCode: options?.couponCode,
369
- lineItems: options?.lineItems,
370
- customLineItems: options?.customLineItems,
371
- channelType: options?.channelType,
372
- giftCardCode: options?.giftCardCode,
373
- overrideCheckoutUrl: options?.overrideCheckoutUrl,
374
- }), [
375
- {
376
- transformFn: transformSDKPageURLV2ToRESTPageURLV2,
377
- paths: [
378
- { path: 'checkoutInfo.lineItems.url' },
379
- { path: 'lineItems.url' },
380
- { path: 'customLineItems.url' },
381
- ],
382
- },
383
- {
384
- transformFn: transformSDKImageToRESTImage,
385
- paths: [
386
- { path: 'checkoutInfo.lineItems.media' },
387
- { path: 'checkoutInfo.lineItems.catalogOverrideFields.image' },
388
- { path: 'lineItems.media' },
389
- { path: 'lineItems.catalogOverrideFields.image' },
390
- { path: 'customLineItems.media' },
391
- ],
392
- },
393
- {
394
- transformFn: transformSDKAddressToRESTAddress,
395
- paths: [
396
- { path: 'checkoutInfo.billingInfo.address' },
397
- { path: 'checkoutInfo.shippingInfo.shippingDestination.address' },
398
- {
399
- path: 'checkoutInfo.shippingInfo.selectedCarrierServiceOption.logistics.pickupDetails.address',
400
- },
401
- {
402
- path: 'checkoutInfo.shippingInfo.carrierServiceOptions.shippingOptions.logistics.pickupDetails.address',
403
- },
404
- ],
405
- },
406
- ]);
407
- const reqOpts = ambassadorWixEcomV1Checkout.createCheckout(payload);
408
- sideEffects?.onSiteCall?.();
409
- try {
410
- const result = await httpClient.request(reqOpts);
411
- sideEffects?.onSuccess?.(result);
412
- return renameKeysFromRESTResponseToSDKResponse(transformPaths(result.data, [
413
- {
414
- transformFn: transformRESTPageURLV2ToSDKPageURLV2,
415
- paths: [{ path: 'checkout.lineItems.url' }],
416
- },
417
- {
418
- transformFn: transformRESTImageToSDKImage,
419
- paths: [
420
- { path: 'checkout.lineItems.media' },
421
- { path: 'checkout.lineItems.catalogOverrideFields.image' },
422
- ],
423
- },
424
- {
425
- transformFn: transformRESTAddressToSDKAddress,
426
- paths: [
427
- { path: 'checkout.billingInfo.address' },
428
- { path: 'checkout.shippingInfo.shippingDestination.address' },
429
- {
430
- path: 'checkout.shippingInfo.selectedCarrierServiceOption.logistics.pickupDetails.address',
431
- },
432
- {
433
- path: 'checkout.shippingInfo.carrierServiceOptions.shippingOptions.logistics.pickupDetails.address',
434
- },
435
- ],
436
- },
437
- ]))?.checkout;
438
- }
439
- catch (err) {
440
- const transformedError = sdkTransformError(err, {
441
- spreadPathsToArguments: {},
442
- explicitPathsToArguments: {
443
- checkoutInfo: '$[0].checkoutInfo',
444
- couponCode: '$[0].couponCode',
445
- lineItems: '$[0].lineItems',
446
- customLineItems: '$[0].customLineItems',
447
- channelType: '$[0].channelType',
448
- giftCardCode: '$[0].giftCardCode',
449
- overrideCheckoutUrl: '$[0].overrideCheckoutUrl',
450
- },
451
- singleArgumentUnchanged: false,
452
- }, ['options']);
453
- sideEffects?.onError?.(err);
454
- throw transformedError;
455
- }
456
- }
457
- /**
458
- * Retrieves a checkout.
459
- *
460
- *
461
- * The `getCheckout()` function returns a Promise that resolves when the specified checkout is retrieved.
462
- * @param _id - Checkout ID.
463
- * @public
464
- * @requiredField _id
465
- * @permissionId ECOM.READ_CHECKOUTS
466
- * @permissionScope Manage Stores - all permissions
467
- * @permissionScopeId SCOPE.DC-STORES-MEGA.MANAGE-STORES
468
- * @permissionScope Read eCommerce - all read permissions
469
- * @permissionScopeId SCOPE.DC-ECOM-MEGA.READ-ECOM
470
- * @permissionScope Read Orders
471
- * @permissionScopeId SCOPE.DC-STORES.READ-ORDERS
472
- * @permissionScope Read Stores - all read permissions
473
- * @permissionScopeId SCOPE.DC-STORES-MEGA.READ-STORES
474
- * @permissionScope Manage Restaurants - all permissions
475
- * @permissionScopeId SCOPE.RESTAURANTS.MEGA-SCOPES
476
- * @permissionScope Manage eCommerce - all permissions
477
- * @permissionScopeId SCOPE.DC-ECOM-MEGA.MANAGE-ECOM
478
- * @permissionScope Picasso private app mega scope
479
- * @permissionScopeId SCOPE.TEST.MEGA-PICASSO-MANAGE-SITE
480
- * @permissionScope Manage Orders
481
- * @permissionScopeId SCOPE.DC-STORES.MANAGE-ORDERS
482
- * @applicableIdentity APP
483
- * @applicableIdentity VISITOR
484
- * @returns Fulfilled - the requested checkout.
485
- * @fqn com.wix.ecom.checkout.api.v1.CheckoutService.GetCheckout
486
- */
487
- export async function getCheckout(_id) {
488
- // @ts-ignore
489
- const { httpClient, sideEffects } = arguments[1];
490
- const payload = renameKeysFromSDKRequestToRESTRequest({ id: _id });
491
- const reqOpts = ambassadorWixEcomV1Checkout.getCheckout(payload);
492
- sideEffects?.onSiteCall?.();
493
- try {
494
- const result = await httpClient.request(reqOpts);
495
- sideEffects?.onSuccess?.(result);
496
- return renameKeysFromRESTResponseToSDKResponse(transformPaths(result.data, [
497
- {
498
- transformFn: transformRESTPageURLV2ToSDKPageURLV2,
499
- paths: [{ path: 'checkout.lineItems.url' }],
500
- },
501
- {
502
- transformFn: transformRESTImageToSDKImage,
503
- paths: [
504
- { path: 'checkout.lineItems.media' },
505
- { path: 'checkout.lineItems.catalogOverrideFields.image' },
506
- ],
507
- },
508
- {
509
- transformFn: transformRESTAddressToSDKAddress,
510
- paths: [
511
- { path: 'checkout.billingInfo.address' },
512
- { path: 'checkout.shippingInfo.shippingDestination.address' },
513
- {
514
- path: 'checkout.shippingInfo.selectedCarrierServiceOption.logistics.pickupDetails.address',
515
- },
516
- {
517
- path: 'checkout.shippingInfo.carrierServiceOptions.shippingOptions.logistics.pickupDetails.address',
518
- },
519
- ],
520
- },
521
- ]))?.checkout;
522
- }
523
- catch (err) {
524
- const transformedError = sdkTransformError(err, {
525
- spreadPathsToArguments: {},
526
- explicitPathsToArguments: { id: '$[0]' },
527
- singleArgumentUnchanged: false,
528
- }, ['_id']);
529
- sideEffects?.onError?.(err);
530
- throw transformedError;
531
- }
532
- }
533
- /**
534
- * Retrieves the checkout associated with a specified cart.
535
- * @param _id - Cart ID.
536
- * @public
537
- * @requiredField _id
538
- * @permissionId ECOM.READ_CHECKOUTS
539
- * @permissionScope Manage Stores - all permissions
540
- * @permissionScopeId SCOPE.DC-STORES-MEGA.MANAGE-STORES
541
- * @permissionScope Read eCommerce - all read permissions
542
- * @permissionScopeId SCOPE.DC-ECOM-MEGA.READ-ECOM
543
- * @permissionScope Read Orders
544
- * @permissionScopeId SCOPE.DC-STORES.READ-ORDERS
545
- * @permissionScope Read Stores - all read permissions
546
- * @permissionScopeId SCOPE.DC-STORES-MEGA.READ-STORES
547
- * @permissionScope Manage Restaurants - all permissions
548
- * @permissionScopeId SCOPE.RESTAURANTS.MEGA-SCOPES
549
- * @permissionScope Manage eCommerce - all permissions
550
- * @permissionScopeId SCOPE.DC-ECOM-MEGA.MANAGE-ECOM
551
- * @permissionScope Picasso private app mega scope
552
- * @permissionScopeId SCOPE.TEST.MEGA-PICASSO-MANAGE-SITE
553
- * @permissionScope Manage Orders
554
- * @permissionScopeId SCOPE.DC-STORES.MANAGE-ORDERS
555
- * @applicableIdentity APP
556
- * @applicableIdentity VISITOR
557
- * @fqn com.wix.ecom.checkout.api.v1.CheckoutService.GetCheckoutByCartId
558
- */
559
- export async function getCheckoutByCartId(_id) {
560
- // @ts-ignore
561
- const { httpClient, sideEffects } = arguments[1];
562
- const payload = renameKeysFromSDKRequestToRESTRequest({ id: _id });
563
- const reqOpts = ambassadorWixEcomV1Checkout.getCheckoutByCartId(payload);
564
- sideEffects?.onSiteCall?.();
565
- try {
566
- const result = await httpClient.request(reqOpts);
567
- sideEffects?.onSuccess?.(result);
568
- return renameKeysFromRESTResponseToSDKResponse(transformPaths(result.data, [
569
- {
570
- transformFn: transformRESTPageURLV2ToSDKPageURLV2,
571
- paths: [{ path: 'checkout.lineItems.url' }],
572
- },
573
- {
574
- transformFn: transformRESTImageToSDKImage,
575
- paths: [
576
- { path: 'checkout.lineItems.media' },
577
- { path: 'checkout.lineItems.catalogOverrideFields.image' },
578
- ],
579
- },
580
- {
581
- transformFn: transformRESTAddressToSDKAddress,
582
- paths: [
583
- { path: 'checkout.billingInfo.address' },
584
- { path: 'checkout.shippingInfo.shippingDestination.address' },
585
- {
586
- path: 'checkout.shippingInfo.selectedCarrierServiceOption.logistics.pickupDetails.address',
587
- },
588
- {
589
- path: 'checkout.shippingInfo.carrierServiceOptions.shippingOptions.logistics.pickupDetails.address',
590
- },
591
- ],
592
- },
593
- ]));
594
- }
595
- catch (err) {
596
- const transformedError = sdkTransformError(err, {
597
- spreadPathsToArguments: {},
598
- explicitPathsToArguments: { id: '$[0]' },
599
- singleArgumentUnchanged: false,
600
- }, ['_id']);
601
- sideEffects?.onError?.(err);
602
- throw transformedError;
603
- }
604
- }
605
- /**
606
- * Deprecated and will be removed soon, use GetCheckoutURL
607
- * @param _id - Checkout ID.
608
- * @internal
609
- * @documentationMaturity preview
610
- * @requiredField _id
611
- * @permissionId ECOM.READ_CHECKOUTS
612
- * @permissionScope Manage Stores - all permissions
613
- * @permissionScopeId SCOPE.DC-STORES-MEGA.MANAGE-STORES
614
- * @permissionScope Read eCommerce - all read permissions
615
- * @permissionScopeId SCOPE.DC-ECOM-MEGA.READ-ECOM
616
- * @permissionScope Read Orders
617
- * @permissionScopeId SCOPE.DC-STORES.READ-ORDERS
618
- * @permissionScope Read Stores - all read permissions
619
- * @permissionScopeId SCOPE.DC-STORES-MEGA.READ-STORES
620
- * @permissionScope Manage Restaurants - all permissions
621
- * @permissionScopeId SCOPE.RESTAURANTS.MEGA-SCOPES
622
- * @permissionScope Manage eCommerce - all permissions
623
- * @permissionScopeId SCOPE.DC-ECOM-MEGA.MANAGE-ECOM
624
- * @permissionScope Picasso private app mega scope
625
- * @permissionScopeId SCOPE.TEST.MEGA-PICASSO-MANAGE-SITE
626
- * @permissionScope Manage Orders
627
- * @permissionScopeId SCOPE.DC-STORES.MANAGE-ORDERS
628
- * @applicableIdentity APP
629
- * @applicableIdentity VISITOR
630
- * @fqn com.wix.ecom.checkout.api.v1.CheckoutService.GetWixCheckoutURL
631
- */
632
- export async function getWixCheckoutUrl(_id) {
633
- // @ts-ignore
634
- const { httpClient, sideEffects } = arguments[1];
635
- const payload = renameKeysFromSDKRequestToRESTRequest({ id: _id });
636
- const reqOpts = ambassadorWixEcomV1Checkout.getWixCheckoutUrl(payload);
637
- sideEffects?.onSiteCall?.();
638
- try {
639
- const result = await httpClient.request(reqOpts);
640
- sideEffects?.onSuccess?.(result);
641
- return renameKeysFromRESTResponseToSDKResponse(result.data);
642
- }
643
- catch (err) {
644
- const transformedError = sdkTransformError(err, {
645
- spreadPathsToArguments: {},
646
- explicitPathsToArguments: { id: '$[0]' },
647
- singleArgumentUnchanged: false,
648
- }, ['_id']);
649
- sideEffects?.onError?.(err);
650
- throw transformedError;
651
- }
652
- }
653
- /**
654
- * Retrieves the checkout page URL of a specified checkout.
655
- *
656
- * By default, a `checkoutUrl` generates for a checkout and directs to a standard Wix checkout page.
657
- * However, if `overrideCheckoutUrl` has a value, it will replace and set the value of `checkoutUrl`.
658
- * @param _id - Checkout ID.
659
- * @public
660
- * @requiredField _id
661
- * @permissionId ECOM.READ_CHECKOUTS
662
- * @permissionScope Manage Stores - all permissions
663
- * @permissionScopeId SCOPE.DC-STORES-MEGA.MANAGE-STORES
664
- * @permissionScope Read eCommerce - all read permissions
665
- * @permissionScopeId SCOPE.DC-ECOM-MEGA.READ-ECOM
666
- * @permissionScope Read Orders
667
- * @permissionScopeId SCOPE.DC-STORES.READ-ORDERS
668
- * @permissionScope Read Stores - all read permissions
669
- * @permissionScopeId SCOPE.DC-STORES-MEGA.READ-STORES
670
- * @permissionScope Manage Restaurants - all permissions
671
- * @permissionScopeId SCOPE.RESTAURANTS.MEGA-SCOPES
672
- * @permissionScope Manage eCommerce - all permissions
673
- * @permissionScopeId SCOPE.DC-ECOM-MEGA.MANAGE-ECOM
674
- * @permissionScope Picasso private app mega scope
675
- * @permissionScopeId SCOPE.TEST.MEGA-PICASSO-MANAGE-SITE
676
- * @permissionScope Manage Orders
677
- * @permissionScopeId SCOPE.DC-STORES.MANAGE-ORDERS
678
- * @applicableIdentity APP
679
- * @applicableIdentity VISITOR
680
- * @fqn com.wix.ecom.checkout.api.v1.CheckoutService.GetCheckoutURL
681
- */
682
- export async function getCheckoutUrl(_id) {
683
- // @ts-ignore
684
- const { httpClient, sideEffects } = arguments[1];
685
- const payload = renameKeysFromSDKRequestToRESTRequest({ id: _id });
686
- const reqOpts = ambassadorWixEcomV1Checkout.getCheckoutUrl(payload);
687
- sideEffects?.onSiteCall?.();
688
- try {
689
- const result = await httpClient.request(reqOpts);
690
- sideEffects?.onSuccess?.(result);
691
- return renameKeysFromRESTResponseToSDKResponse(result.data);
692
- }
693
- catch (err) {
694
- const transformedError = sdkTransformError(err, {
695
- spreadPathsToArguments: {},
696
- explicitPathsToArguments: { id: '$[0]' },
697
- singleArgumentUnchanged: false,
698
- }, ['_id']);
699
- sideEffects?.onError?.(err);
700
- throw transformedError;
701
- }
702
- }
703
- /**
704
- * Updates a checkout.
705
- *
706
- *
707
- * The `updateCheckout()` function returns a Promise that resolves to the updated checkout when the specified properties are updated.
708
- *
709
- * >**Notes:**
710
- * > + If nothing is passed in the request, the call will fail.
711
- * > + The `checkout.buyerInfo.email` may not be removed once it is set.
712
- * @param _id - Checkout ID.
713
- * @public
714
- * @requiredField _id
715
- * @requiredField checkout
716
- * @requiredField checkout.customFields.value
717
- * @requiredField checkout.membershipOptions.selectedMemberships.memberships._id
718
- * @requiredField checkout.membershipOptions.selectedMemberships.memberships.appId
719
- * @requiredField checkout.membershipOptions.selectedMemberships.memberships.lineItemIds
720
- * @requiredField options.customLineItems.descriptionLines.name
721
- * @requiredField options.customLineItems.descriptionLines.value
722
- * @requiredField options.customLineItems.itemType
723
- * @requiredField options.customLineItems.productName
724
- * @requiredField options.customLineItems.quantity
725
- * @requiredField options.lineItems.catalogReference
726
- * @requiredField options.lineItems.catalogReference.appId
727
- * @requiredField options.lineItems.catalogReference.catalogItemId
728
- * @requiredField options.lineItems.quantity
729
- * @param options - Checkout update options.
730
- * @permissionId ECOM.MODIFY_CHECKOUTS
731
- * @permissionId ECOM.ADMIN_MODIFY_CHECKOUTS
732
- * @permissionScope Manage Stores - all permissions
733
- * @permissionScopeId SCOPE.DC-STORES-MEGA.MANAGE-STORES
734
- * @permissionScope Manage Restaurants - all permissions
735
- * @permissionScopeId SCOPE.RESTAURANTS.MEGA-SCOPES
736
- * @permissionScope Manage eCommerce - all permissions
737
- * @permissionScopeId SCOPE.DC-ECOM-MEGA.MANAGE-ECOM
738
- * @permissionScope Picasso private app mega scope
739
- * @permissionScopeId SCOPE.TEST.MEGA-PICASSO-MANAGE-SITE
740
- * @permissionScope Manage Orders
741
- * @permissionScopeId SCOPE.DC-STORES.MANAGE-ORDERS
742
- * @permissionScope Manage Stores - all permissions
743
- * @permissionScopeId SCOPE.DC-STORES-MEGA.MANAGE-STORES
744
- * @permissionScope Manage eCommerce - Admin Permissions
745
- * @permissionScopeId SCOPE.ECOM.MANAGE-ADMIN
746
- * @permissionScope Manage Restaurants - all permissions
747
- * @permissionScopeId SCOPE.RESTAURANTS.MEGA-SCOPES
748
- * @permissionScope Manage eCommerce - all permissions
749
- * @permissionScopeId SCOPE.DC-ECOM-MEGA.MANAGE-ECOM
750
- * @permissionScope Picasso private app mega scope
751
- * @permissionScopeId SCOPE.TEST.MEGA-PICASSO-MANAGE-SITE
752
- * @applicableIdentity APP
753
- * @applicableIdentity VISITOR
754
- * @returns Updated checkout.
755
- * @fqn com.wix.ecom.checkout.api.v1.CheckoutService.UpdateCheckout
756
- */
757
- export async function updateCheckout(_id, checkout, options) {
758
- // @ts-ignore
759
- const { httpClient, sideEffects } = arguments[3];
760
- const payload = transformPaths(renameKeysFromSDKRequestToRESTRequest({
761
- checkout: { ...checkout, id: _id },
762
- couponCode: options?.couponCode,
763
- giftCardCode: options?.giftCardCode,
764
- overrideCheckoutUrl: options?.overrideCheckoutUrl,
765
- lineItems: options?.lineItems,
766
- customLineItems: options?.customLineItems,
767
- }), [
768
- {
769
- transformFn: transformSDKPageURLV2ToRESTPageURLV2,
770
- paths: [
771
- { path: 'checkout.lineItems.url' },
772
- { path: 'lineItems.url' },
773
- { path: 'customLineItems.url' },
774
- ],
775
- },
776
- {
777
- transformFn: transformSDKImageToRESTImage,
778
- paths: [
779
- { path: 'checkout.lineItems.media' },
780
- { path: 'checkout.lineItems.catalogOverrideFields.image' },
781
- { path: 'lineItems.media' },
782
- { path: 'lineItems.catalogOverrideFields.image' },
783
- { path: 'customLineItems.media' },
784
- ],
785
- },
786
- {
787
- transformFn: transformSDKAddressToRESTAddress,
788
- paths: [
789
- { path: 'checkout.billingInfo.address' },
790
- { path: 'checkout.shippingInfo.shippingDestination.address' },
791
- {
792
- path: 'checkout.shippingInfo.selectedCarrierServiceOption.logistics.pickupDetails.address',
793
- },
794
- {
795
- path: 'checkout.shippingInfo.carrierServiceOptions.shippingOptions.logistics.pickupDetails.address',
796
- },
797
- ],
798
- },
799
- ]);
800
- const reqOpts = ambassadorWixEcomV1Checkout.updateCheckout(payload);
801
- sideEffects?.onSiteCall?.();
802
- try {
803
- const result = await httpClient.request(reqOpts);
804
- sideEffects?.onSuccess?.(result);
805
- return renameKeysFromRESTResponseToSDKResponse(transformPaths(result.data, [
806
- {
807
- transformFn: transformRESTPageURLV2ToSDKPageURLV2,
808
- paths: [{ path: 'checkout.lineItems.url' }],
809
- },
810
- {
811
- transformFn: transformRESTImageToSDKImage,
812
- paths: [
813
- { path: 'checkout.lineItems.media' },
814
- { path: 'checkout.lineItems.catalogOverrideFields.image' },
815
- ],
816
- },
817
- {
818
- transformFn: transformRESTAddressToSDKAddress,
819
- paths: [
820
- { path: 'checkout.billingInfo.address' },
821
- { path: 'checkout.shippingInfo.shippingDestination.address' },
822
- {
823
- path: 'checkout.shippingInfo.selectedCarrierServiceOption.logistics.pickupDetails.address',
824
- },
825
- {
826
- path: 'checkout.shippingInfo.carrierServiceOptions.shippingOptions.logistics.pickupDetails.address',
827
- },
828
- ],
829
- },
830
- ]))?.checkout;
831
- }
832
- catch (err) {
833
- const transformedError = sdkTransformError(err, {
834
- spreadPathsToArguments: { checkout: '$[1]' },
835
- explicitPathsToArguments: {
836
- 'checkout.id': '$[0]',
837
- couponCode: '$[2].couponCode',
838
- giftCardCode: '$[2].giftCardCode',
839
- overrideCheckoutUrl: '$[2].overrideCheckoutUrl',
840
- lineItems: '$[2].lineItems',
841
- customLineItems: '$[2].customLineItems',
842
- },
843
- singleArgumentUnchanged: false,
844
- }, ['_id', 'checkout', 'options']);
845
- sideEffects?.onError?.(err);
846
- throw transformedError;
847
- }
848
- }
849
- /**
850
- * Removes the coupon from a specified checkout.
851
- *
852
- *
853
- * The `removeCoupon()` function returns a Promise that resolves to the updated checkout when the coupon is removed from the specified checkout.
854
- *
855
- * >**Note:** A checkout can only hold 1 coupon.
856
- * @param _id - ID of the checkout to remove the coupon from.
857
- * @public
858
- * @requiredField _id
859
- * @permissionId ECOM.MODIFY_CHECKOUTS
860
- * @permissionScope Manage Stores - all permissions
861
- * @permissionScopeId SCOPE.DC-STORES-MEGA.MANAGE-STORES
862
- * @permissionScope Manage Restaurants - all permissions
863
- * @permissionScopeId SCOPE.RESTAURANTS.MEGA-SCOPES
864
- * @permissionScope Manage eCommerce - all permissions
865
- * @permissionScopeId SCOPE.DC-ECOM-MEGA.MANAGE-ECOM
866
- * @permissionScope Picasso private app mega scope
867
- * @permissionScopeId SCOPE.TEST.MEGA-PICASSO-MANAGE-SITE
868
- * @permissionScope Manage Orders
869
- * @permissionScopeId SCOPE.DC-STORES.MANAGE-ORDERS
870
- * @applicableIdentity APP
871
- * @applicableIdentity VISITOR
872
- * @fqn com.wix.ecom.checkout.api.v1.CheckoutService.RemoveCoupon
873
- */
874
- export async function removeCoupon(_id) {
875
- // @ts-ignore
876
- const { httpClient, sideEffects } = arguments[1];
877
- const payload = renameKeysFromSDKRequestToRESTRequest({ id: _id });
878
- const reqOpts = ambassadorWixEcomV1Checkout.removeCoupon(payload);
879
- sideEffects?.onSiteCall?.();
880
- try {
881
- const result = await httpClient.request(reqOpts);
882
- sideEffects?.onSuccess?.(result);
883
- return renameKeysFromRESTResponseToSDKResponse(transformPaths(result.data, [
884
- {
885
- transformFn: transformRESTPageURLV2ToSDKPageURLV2,
886
- paths: [{ path: 'checkout.lineItems.url' }],
887
- },
888
- {
889
- transformFn: transformRESTImageToSDKImage,
890
- paths: [
891
- { path: 'checkout.lineItems.media' },
892
- { path: 'checkout.lineItems.catalogOverrideFields.image' },
893
- ],
894
- },
895
- {
896
- transformFn: transformRESTAddressToSDKAddress,
897
- paths: [
898
- { path: 'checkout.billingInfo.address' },
899
- { path: 'checkout.shippingInfo.shippingDestination.address' },
900
- {
901
- path: 'checkout.shippingInfo.selectedCarrierServiceOption.logistics.pickupDetails.address',
902
- },
903
- {
904
- path: 'checkout.shippingInfo.carrierServiceOptions.shippingOptions.logistics.pickupDetails.address',
905
- },
906
- ],
907
- },
908
- ]));
909
- }
910
- catch (err) {
911
- const transformedError = sdkTransformError(err, {
912
- spreadPathsToArguments: {},
913
- explicitPathsToArguments: { id: '$[0]' },
914
- singleArgumentUnchanged: false,
915
- }, ['_id']);
916
- sideEffects?.onError?.(err);
917
- throw transformedError;
918
- }
919
- }
920
- /**
921
- * Removes the gift card from a specified checkout.
922
- *
923
- *
924
- * The `removeGiftCard()` function returns a Promise that resolves to the updated checkout when the gift card is removed from the specified checkout.
925
- *
926
- * >**Note:** A checkout can only hold 1 gift card.
927
- * @param _id - ID of the checkout to remove the gift card from.
928
- * @public
929
- * @requiredField _id
930
- * @permissionId ECOM.MODIFY_CHECKOUTS
931
- * @permissionScope Manage Stores - all permissions
932
- * @permissionScopeId SCOPE.DC-STORES-MEGA.MANAGE-STORES
933
- * @permissionScope Manage Restaurants - all permissions
934
- * @permissionScopeId SCOPE.RESTAURANTS.MEGA-SCOPES
935
- * @permissionScope Manage eCommerce - all permissions
936
- * @permissionScopeId SCOPE.DC-ECOM-MEGA.MANAGE-ECOM
937
- * @permissionScope Picasso private app mega scope
938
- * @permissionScopeId SCOPE.TEST.MEGA-PICASSO-MANAGE-SITE
939
- * @permissionScope Manage Orders
940
- * @permissionScopeId SCOPE.DC-STORES.MANAGE-ORDERS
941
- * @applicableIdentity APP
942
- * @applicableIdentity VISITOR
943
- * @fqn com.wix.ecom.checkout.api.v1.CheckoutService.RemoveGiftCard
944
- */
945
- export async function removeGiftCard(_id) {
946
- // @ts-ignore
947
- const { httpClient, sideEffects } = arguments[1];
948
- const payload = renameKeysFromSDKRequestToRESTRequest({ id: _id });
949
- const reqOpts = ambassadorWixEcomV1Checkout.removeGiftCard(payload);
950
- sideEffects?.onSiteCall?.();
951
- try {
952
- const result = await httpClient.request(reqOpts);
953
- sideEffects?.onSuccess?.(result);
954
- return renameKeysFromRESTResponseToSDKResponse(transformPaths(result.data, [
955
- {
956
- transformFn: transformRESTPageURLV2ToSDKPageURLV2,
957
- paths: [{ path: 'checkout.lineItems.url' }],
958
- },
959
- {
960
- transformFn: transformRESTImageToSDKImage,
961
- paths: [
962
- { path: 'checkout.lineItems.media' },
963
- { path: 'checkout.lineItems.catalogOverrideFields.image' },
964
- ],
965
- },
966
- {
967
- transformFn: transformRESTAddressToSDKAddress,
968
- paths: [
969
- { path: 'checkout.billingInfo.address' },
970
- { path: 'checkout.shippingInfo.shippingDestination.address' },
971
- {
972
- path: 'checkout.shippingInfo.selectedCarrierServiceOption.logistics.pickupDetails.address',
973
- },
974
- {
975
- path: 'checkout.shippingInfo.carrierServiceOptions.shippingOptions.logistics.pickupDetails.address',
976
- },
977
- ],
978
- },
979
- ]));
980
- }
981
- catch (err) {
982
- const transformedError = sdkTransformError(err, {
983
- spreadPathsToArguments: {},
984
- explicitPathsToArguments: { id: '$[0]' },
985
- singleArgumentUnchanged: false,
986
- }, ['_id']);
987
- sideEffects?.onError?.(err);
988
- throw transformedError;
989
- }
990
- }
991
- /**
992
- * Removes the `overrideCheckoutUrl` from a specified checkout.
993
- *
994
- * When `overrideCheckoutUrl` is removed, the `checkoutUrl` will be set to the default, standard
995
- * Wix checkout page URL.
996
- * @param _id - ID of the checkout to remove the override checkout url from.
997
- * @public
998
- * @requiredField _id
999
- * @permissionId ECOM.MODIFY_CHECKOUTS
1000
- * @permissionScope Manage Stores - all permissions
1001
- * @permissionScopeId SCOPE.DC-STORES-MEGA.MANAGE-STORES
1002
- * @permissionScope Manage Restaurants - all permissions
1003
- * @permissionScopeId SCOPE.RESTAURANTS.MEGA-SCOPES
1004
- * @permissionScope Manage eCommerce - all permissions
1005
- * @permissionScopeId SCOPE.DC-ECOM-MEGA.MANAGE-ECOM
1006
- * @permissionScope Picasso private app mega scope
1007
- * @permissionScopeId SCOPE.TEST.MEGA-PICASSO-MANAGE-SITE
1008
- * @permissionScope Manage Orders
1009
- * @permissionScopeId SCOPE.DC-STORES.MANAGE-ORDERS
1010
- * @applicableIdentity APP
1011
- * @applicableIdentity VISITOR
1012
- * @fqn com.wix.ecom.checkout.api.v1.CheckoutService.RemoveOverrideCheckoutUrl
1013
- */
1014
- export async function removeOverrideCheckoutUrl(_id) {
1015
- // @ts-ignore
1016
- const { httpClient, sideEffects } = arguments[1];
1017
- const payload = renameKeysFromSDKRequestToRESTRequest({ id: _id });
1018
- const reqOpts = ambassadorWixEcomV1Checkout.removeOverrideCheckoutUrl(payload);
1019
- sideEffects?.onSiteCall?.();
1020
- try {
1021
- const result = await httpClient.request(reqOpts);
1022
- sideEffects?.onSuccess?.(result);
1023
- return renameKeysFromRESTResponseToSDKResponse(transformPaths(result.data, [
1024
- {
1025
- transformFn: transformRESTPageURLV2ToSDKPageURLV2,
1026
- paths: [{ path: 'checkout.lineItems.url' }],
1027
- },
1028
- {
1029
- transformFn: transformRESTImageToSDKImage,
1030
- paths: [
1031
- { path: 'checkout.lineItems.media' },
1032
- { path: 'checkout.lineItems.catalogOverrideFields.image' },
1033
- ],
1034
- },
1035
- {
1036
- transformFn: transformRESTAddressToSDKAddress,
1037
- paths: [
1038
- { path: 'checkout.billingInfo.address' },
1039
- { path: 'checkout.shippingInfo.shippingDestination.address' },
1040
- {
1041
- path: 'checkout.shippingInfo.selectedCarrierServiceOption.logistics.pickupDetails.address',
1042
- },
1043
- {
1044
- path: 'checkout.shippingInfo.carrierServiceOptions.shippingOptions.logistics.pickupDetails.address',
1045
- },
1046
- ],
1047
- },
1048
- ]));
1049
- }
1050
- catch (err) {
1051
- const transformedError = sdkTransformError(err, {
1052
- spreadPathsToArguments: {},
1053
- explicitPathsToArguments: { id: '$[0]' },
1054
- singleArgumentUnchanged: false,
1055
- }, ['_id']);
1056
- sideEffects?.onError?.(err);
1057
- throw transformedError;
1058
- }
1059
- }
1060
- /**
1061
- * Adds catalog line items and/or custom line items to a checkout.
1062
- *
1063
- *
1064
- * The `addToCheckout()` function returns a Promise that resolves to the updated checkout when the specified items have been added.
1065
- * > **Note:** When adding catalog items, `options.lineItems.catalogReference` is required.
1066
- * @param _id - Checkout ID.
1067
- * @public
1068
- * @requiredField _id
1069
- * @requiredField options.customLineItems.descriptionLines.name
1070
- * @requiredField options.customLineItems.descriptionLines.value
1071
- * @requiredField options.customLineItems.itemType
1072
- * @requiredField options.customLineItems.productName
1073
- * @requiredField options.customLineItems.quantity
1074
- * @requiredField options.lineItems.catalogReference
1075
- * @requiredField options.lineItems.catalogReference.appId
1076
- * @requiredField options.lineItems.catalogReference.catalogItemId
1077
- * @requiredField options.lineItems.quantity
1078
- * @param options - Items to be added to checkout.
1079
- * @permissionId ECOM.MODIFY_CHECKOUTS
1080
- * @permissionId ECOM.ADMIN_MODIFY_CHECKOUTS
1081
- * @permissionScope Manage Stores - all permissions
1082
- * @permissionScopeId SCOPE.DC-STORES-MEGA.MANAGE-STORES
1083
- * @permissionScope Manage Restaurants - all permissions
1084
- * @permissionScopeId SCOPE.RESTAURANTS.MEGA-SCOPES
1085
- * @permissionScope Manage eCommerce - all permissions
1086
- * @permissionScopeId SCOPE.DC-ECOM-MEGA.MANAGE-ECOM
1087
- * @permissionScope Picasso private app mega scope
1088
- * @permissionScopeId SCOPE.TEST.MEGA-PICASSO-MANAGE-SITE
1089
- * @permissionScope Manage Orders
1090
- * @permissionScopeId SCOPE.DC-STORES.MANAGE-ORDERS
1091
- * @permissionScope Manage Stores - all permissions
1092
- * @permissionScopeId SCOPE.DC-STORES-MEGA.MANAGE-STORES
1093
- * @permissionScope Manage eCommerce - Admin Permissions
1094
- * @permissionScopeId SCOPE.ECOM.MANAGE-ADMIN
1095
- * @permissionScope Manage Restaurants - all permissions
1096
- * @permissionScopeId SCOPE.RESTAURANTS.MEGA-SCOPES
1097
- * @permissionScope Manage eCommerce - all permissions
1098
- * @permissionScopeId SCOPE.DC-ECOM-MEGA.MANAGE-ECOM
1099
- * @permissionScope Picasso private app mega scope
1100
- * @permissionScopeId SCOPE.TEST.MEGA-PICASSO-MANAGE-SITE
1101
- * @applicableIdentity APP
1102
- * @applicableIdentity VISITOR
1103
- * @fqn com.wix.ecom.checkout.api.v1.CheckoutService.AddToCheckout
1104
- */
1105
- export async function addToCheckout(_id, options) {
1106
- // @ts-ignore
1107
- const { httpClient, sideEffects } = arguments[2];
1108
- const payload = transformPaths(renameKeysFromSDKRequestToRESTRequest({
1109
- id: _id,
1110
- lineItems: options?.lineItems,
1111
- customLineItems: options?.customLineItems,
1112
- }), [
1113
- {
1114
- transformFn: transformSDKPageURLV2ToRESTPageURLV2,
1115
- paths: [{ path: 'lineItems.url' }, { path: 'customLineItems.url' }],
1116
- },
1117
- {
1118
- transformFn: transformSDKImageToRESTImage,
1119
- paths: [
1120
- { path: 'lineItems.media' },
1121
- { path: 'lineItems.catalogOverrideFields.image' },
1122
- { path: 'customLineItems.media' },
1123
- ],
1124
- },
1125
- ]);
1126
- const reqOpts = ambassadorWixEcomV1Checkout.addToCheckout(payload);
1127
- sideEffects?.onSiteCall?.();
1128
- try {
1129
- const result = await httpClient.request(reqOpts);
1130
- sideEffects?.onSuccess?.(result);
1131
- return renameKeysFromRESTResponseToSDKResponse(transformPaths(result.data, [
1132
- {
1133
- transformFn: transformRESTPageURLV2ToSDKPageURLV2,
1134
- paths: [{ path: 'checkout.lineItems.url' }],
1135
- },
1136
- {
1137
- transformFn: transformRESTImageToSDKImage,
1138
- paths: [
1139
- { path: 'checkout.lineItems.media' },
1140
- { path: 'checkout.lineItems.catalogOverrideFields.image' },
1141
- ],
1142
- },
1143
- {
1144
- transformFn: transformRESTAddressToSDKAddress,
1145
- paths: [
1146
- { path: 'checkout.billingInfo.address' },
1147
- { path: 'checkout.shippingInfo.shippingDestination.address' },
1148
- {
1149
- path: 'checkout.shippingInfo.selectedCarrierServiceOption.logistics.pickupDetails.address',
1150
- },
1151
- {
1152
- path: 'checkout.shippingInfo.carrierServiceOptions.shippingOptions.logistics.pickupDetails.address',
1153
- },
1154
- ],
1155
- },
1156
- ]));
1157
- }
1158
- catch (err) {
1159
- const transformedError = sdkTransformError(err, {
1160
- spreadPathsToArguments: {},
1161
- explicitPathsToArguments: {
1162
- id: '$[0]',
1163
- lineItems: '$[1].lineItems',
1164
- customLineItems: '$[1].customLineItems',
1165
- },
1166
- singleArgumentUnchanged: false,
1167
- }, ['_id', 'options']);
1168
- sideEffects?.onError?.(err);
1169
- throw transformedError;
1170
- }
1171
- }
1172
- /**
1173
- * Removes line items from the specified checkout.
1174
- *
1175
- *
1176
- * The `removeLineItems()` function returns a Promise that resolves to the updated checkout when the line items are removed from the specified checkout.
1177
- * @param _id - ID of the checkout to remove line items from.
1178
- * @public
1179
- * @requiredField _id
1180
- * @requiredField lineItemIds
1181
- * @param lineItemIds - IDs of the line items to be removed.
1182
- * To find the IDs of the checkout line items you'd like to remove, pass the `checkout._id` to [getCheckout()](https://www.wix.com/velo/reference/wix-ecom-backend/checkout/getcheckout) and look for the IDs under `lineItems` and/or `customLineItems`.
1183
- * @permissionId ECOM.MODIFY_CHECKOUTS
1184
- * @permissionScope Manage Stores - all permissions
1185
- * @permissionScopeId SCOPE.DC-STORES-MEGA.MANAGE-STORES
1186
- * @permissionScope Manage Restaurants - all permissions
1187
- * @permissionScopeId SCOPE.RESTAURANTS.MEGA-SCOPES
1188
- * @permissionScope Manage eCommerce - all permissions
1189
- * @permissionScopeId SCOPE.DC-ECOM-MEGA.MANAGE-ECOM
1190
- * @permissionScope Picasso private app mega scope
1191
- * @permissionScopeId SCOPE.TEST.MEGA-PICASSO-MANAGE-SITE
1192
- * @permissionScope Manage Orders
1193
- * @permissionScopeId SCOPE.DC-STORES.MANAGE-ORDERS
1194
- * @applicableIdentity APP
1195
- * @applicableIdentity VISITOR
1196
- * @fqn com.wix.ecom.checkout.api.v1.CheckoutService.RemoveLineItems
1197
- */
1198
- export async function removeLineItems(_id, lineItemIds) {
1199
- // @ts-ignore
1200
- const { httpClient, sideEffects } = arguments[2];
1201
- const payload = renameKeysFromSDKRequestToRESTRequest({
1202
- id: _id,
1203
- lineItemIds: lineItemIds,
1204
- });
1205
- const reqOpts = ambassadorWixEcomV1Checkout.removeLineItems(payload);
1206
- sideEffects?.onSiteCall?.();
1207
- try {
1208
- const result = await httpClient.request(reqOpts);
1209
- sideEffects?.onSuccess?.(result);
1210
- return renameKeysFromRESTResponseToSDKResponse(transformPaths(result.data, [
1211
- {
1212
- transformFn: transformRESTPageURLV2ToSDKPageURLV2,
1213
- paths: [{ path: 'checkout.lineItems.url' }],
1214
- },
1215
- {
1216
- transformFn: transformRESTImageToSDKImage,
1217
- paths: [
1218
- { path: 'checkout.lineItems.media' },
1219
- { path: 'checkout.lineItems.catalogOverrideFields.image' },
1220
- ],
1221
- },
1222
- {
1223
- transformFn: transformRESTAddressToSDKAddress,
1224
- paths: [
1225
- { path: 'checkout.billingInfo.address' },
1226
- { path: 'checkout.shippingInfo.shippingDestination.address' },
1227
- {
1228
- path: 'checkout.shippingInfo.selectedCarrierServiceOption.logistics.pickupDetails.address',
1229
- },
1230
- {
1231
- path: 'checkout.shippingInfo.carrierServiceOptions.shippingOptions.logistics.pickupDetails.address',
1232
- },
1233
- ],
1234
- },
1235
- ]));
1236
- }
1237
- catch (err) {
1238
- const transformedError = sdkTransformError(err, {
1239
- spreadPathsToArguments: {},
1240
- explicitPathsToArguments: { id: '$[0]', lineItemIds: '$[1]' },
1241
- singleArgumentUnchanged: false,
1242
- }, ['_id', 'lineItemIds']);
1243
- sideEffects?.onError?.(err);
1244
- throw transformedError;
1245
- }
1246
- }
1247
- /**
1248
- * Creates an order from a specified checkout.
1249
- *
1250
- * The `createOrder()` function returns a Promise that resolves to the new order's ID and `paymentGatewayOrderID` when the order is created.
1251
- * Pass the `paymentGatewayOrderId` as the `paymentId` param to the [`startPayment()`](https://www.wix.com/velo/reference/wix-pay-frontend/startpayment) function to allow a customer to pay for their order.
1252
- *
1253
- * > **Note:** The following requirements must be met for an order to be created from a checkout.
1254
- * > + A checkout cannot have calculation errors. Pass the `checkout._id` to [Get Checkout](https://www.wix.com/velo/reference/wix-ecom-backend/checkout/getcheckout) and take a look at the `calculationErrors` field.
1255
- * > + A checkout must have at least 1 line item.
1256
- * > + All of the line Items have an `availability.status` of `"AVAILABLE"` or `"PARTIALLY_AVAILABLE"`.
1257
- * > + If there is a payment to be made, meaning that `priceSummary.total` is greater than 0, the `billingInfo.address` field must be provided.
1258
- * > + When a checkout has line items to be shipped, the `shippingInfo.shippingDestination.address` and `shippingInfo.selectedCarrierServiceOption` fields must be provided.
1259
- * > + When a checkout has line items for pickup, the `shippingInfo.selectedCarrierServiceOption.logistics.pickupDetails` field must be provided.
1260
- * @param _id - Checkout ID.
1261
- * @public
1262
- * @requiredField _id
1263
- * @param options - Further order creation options.
1264
- * @permissionId ECOM.CREATE_ORDER_FROM_CHECKOUT
1265
- * @permissionScope Manage Stores - all permissions
1266
- * @permissionScopeId SCOPE.DC-STORES-MEGA.MANAGE-STORES
1267
- * @permissionScope Manage Restaurants - all permissions
1268
- * @permissionScopeId SCOPE.RESTAURANTS.MEGA-SCOPES
1269
- * @permissionScope Manage eCommerce - all permissions
1270
- * @permissionScopeId SCOPE.DC-ECOM-MEGA.MANAGE-ECOM
1271
- * @permissionScope Picasso private app mega scope
1272
- * @permissionScopeId SCOPE.TEST.MEGA-PICASSO-MANAGE-SITE
1273
- * @permissionScope Manage Orders
1274
- * @permissionScopeId SCOPE.DC-STORES.MANAGE-ORDERS
1275
- * @applicableIdentity APP
1276
- * @applicableIdentity VISITOR
1277
- * @fqn com.wix.ecom.checkout.api.v1.CheckoutService.CreateOrder
1278
- */
1279
- export async function createOrder(_id, options) {
1280
- // @ts-ignore
1281
- const { httpClient, sideEffects } = arguments[2];
1282
- const payload = renameKeysFromSDKRequestToRESTRequest({
1283
- id: _id,
1284
- savePaymentMethod: options?.savePaymentMethod,
1285
- delayCapture: options?.delayCapture,
1286
- });
1287
- const reqOpts = ambassadorWixEcomV1Checkout.createOrder(payload);
1288
- sideEffects?.onSiteCall?.();
1289
- try {
1290
- const result = await httpClient.request(reqOpts);
1291
- sideEffects?.onSuccess?.(result);
1292
- return renameKeysFromRESTResponseToSDKResponse(result.data);
1293
- }
1294
- catch (err) {
1295
- const transformedError = sdkTransformError(err, {
1296
- spreadPathsToArguments: {},
1297
- explicitPathsToArguments: {
1298
- id: '$[0]',
1299
- savePaymentMethod: '$[1].savePaymentMethod',
1300
- delayCapture: '$[1].delayCapture',
1301
- },
1302
- singleArgumentUnchanged: false,
1303
- }, ['_id', 'options']);
1304
- sideEffects?.onError?.(err);
1305
- throw transformedError;
1306
- }
1307
- }
1308
- /**
1309
- * Deprecated (use createOrder instead)
1310
- * @param _id - Checkout ID.
1311
- * @internal
1312
- * @documentationMaturity preview
1313
- * @requiredField _id
1314
- * @permissionId ECOM.CREATE_ORDER_FROM_CHECKOUT
1315
- * @permissionScope Manage Stores - all permissions
1316
- * @permissionScopeId SCOPE.DC-STORES-MEGA.MANAGE-STORES
1317
- * @permissionScope Manage Restaurants - all permissions
1318
- * @permissionScopeId SCOPE.RESTAURANTS.MEGA-SCOPES
1319
- * @permissionScope Manage eCommerce - all permissions
1320
- * @permissionScopeId SCOPE.DC-ECOM-MEGA.MANAGE-ECOM
1321
- * @permissionScope Picasso private app mega scope
1322
- * @permissionScopeId SCOPE.TEST.MEGA-PICASSO-MANAGE-SITE
1323
- * @permissionScope Manage Orders
1324
- * @permissionScopeId SCOPE.DC-STORES.MANAGE-ORDERS
1325
- * @applicableIdentity APP
1326
- * @applicableIdentity VISITOR
1327
- * @fqn com.wix.ecom.checkout.api.v1.CheckoutService.CreateOrderAndCharge
1328
- */
1329
- export async function createOrderAndCharge(_id, options) {
1330
- // @ts-ignore
1331
- const { httpClient, sideEffects } = arguments[2];
1332
- const payload = renameKeysFromSDKRequestToRESTRequest({
1333
- id: _id,
1334
- paymentToken: options?.paymentToken,
1335
- savePaymentMethod: options?.savePaymentMethod,
1336
- delayCapture: options?.delayCapture,
1337
- });
1338
- const reqOpts = ambassadorWixEcomV1Checkout.createOrderAndCharge(payload);
1339
- sideEffects?.onSiteCall?.();
1340
- try {
1341
- const result = await httpClient.request(reqOpts);
1342
- sideEffects?.onSuccess?.(result);
1343
- return renameKeysFromRESTResponseToSDKResponse(result.data);
1344
- }
1345
- catch (err) {
1346
- const transformedError = sdkTransformError(err, {
1347
- spreadPathsToArguments: {},
1348
- explicitPathsToArguments: {
1349
- id: '$[0]',
1350
- paymentToken: '$[1].paymentToken',
1351
- savePaymentMethod: '$[1].savePaymentMethod',
1352
- delayCapture: '$[1].delayCapture',
1353
- },
1354
- singleArgumentUnchanged: false,
1355
- }, ['_id', 'options']);
1356
- sideEffects?.onError?.(err);
1357
- throw transformedError;
1358
- }
1359
- }
1360
- /**
1361
- * Marks a checkout as completed and redirects to a specified URL.
1362
- * @param token - Server-signed JWT token with required information to complete checkout
1363
- * @internal
1364
- * @documentationMaturity preview
1365
- * @requiredField token
1366
- * @permissionId ECOM.MODIFY_CHECKOUTS
1367
- * @permissionScope Manage Stores - all permissions
1368
- * @permissionScopeId SCOPE.DC-STORES-MEGA.MANAGE-STORES
1369
- * @permissionScope Manage Restaurants - all permissions
1370
- * @permissionScopeId SCOPE.RESTAURANTS.MEGA-SCOPES
1371
- * @permissionScope Manage eCommerce - all permissions
1372
- * @permissionScopeId SCOPE.DC-ECOM-MEGA.MANAGE-ECOM
1373
- * @permissionScope Picasso private app mega scope
1374
- * @permissionScopeId SCOPE.TEST.MEGA-PICASSO-MANAGE-SITE
1375
- * @permissionScope Manage Orders
1376
- * @permissionScopeId SCOPE.DC-STORES.MANAGE-ORDERS
1377
- * @applicableIdentity APP
1378
- * @applicableIdentity VISITOR
1379
- * @fqn com.wix.ecom.checkout.api.v1.CheckoutService.MarkCheckoutAsCompletedAndRedirectToUrl
1380
- */
1381
- export async function markCheckoutAsCompletedAndRedirectToUrl(token) {
1382
- // @ts-ignore
1383
- const { httpClient, sideEffects } = arguments[1];
1384
- const payload = renameKeysFromSDKRequestToRESTRequest({ token: token });
1385
- const reqOpts = ambassadorWixEcomV1Checkout.markCheckoutAsCompletedAndRedirectToUrl(payload);
1386
- sideEffects?.onSiteCall?.();
1387
- try {
1388
- const result = await httpClient.request(reqOpts);
1389
- sideEffects?.onSuccess?.(result);
1390
- return renameKeysFromRESTResponseToSDKResponse(result.data);
1391
- }
1392
- catch (err) {
1393
- const transformedError = sdkTransformError(err, {
1394
- spreadPathsToArguments: {},
1395
- explicitPathsToArguments: { token: '$[0]' },
1396
- singleArgumentUnchanged: false,
1397
- }, ['token']);
1398
- sideEffects?.onError?.(err);
1399
- throw transformedError;
1400
- }
1401
- }
1402
- /**
1403
- * Marks a checkout as completed - `checkout.complete` boolean is set to `true`.
1404
- *
1405
- *
1406
- * The `markCheckoutAsCompleted()` function returns a Promise that resolves when the specified checkout is marked as completed.
1407
- * @param _id - Checkout ID.
1408
- * @public
1409
- * @requiredField _id
1410
- * @permissionId ECOM.MODIFY_CHECKOUTS
1411
- * @permissionScope Manage Stores - all permissions
1412
- * @permissionScopeId SCOPE.DC-STORES-MEGA.MANAGE-STORES
1413
- * @permissionScope Manage Restaurants - all permissions
1414
- * @permissionScopeId SCOPE.RESTAURANTS.MEGA-SCOPES
1415
- * @permissionScope Manage eCommerce - all permissions
1416
- * @permissionScopeId SCOPE.DC-ECOM-MEGA.MANAGE-ECOM
1417
- * @permissionScope Picasso private app mega scope
1418
- * @permissionScopeId SCOPE.TEST.MEGA-PICASSO-MANAGE-SITE
1419
- * @permissionScope Manage Orders
1420
- * @permissionScopeId SCOPE.DC-STORES.MANAGE-ORDERS
1421
- * @applicableIdentity APP
1422
- * @applicableIdentity VISITOR
1423
- * @fqn com.wix.ecom.checkout.api.v1.CheckoutService.MarkCheckoutAsCompleted
1424
- */
1425
- export async function markCheckoutAsCompleted(_id) {
1426
- // @ts-ignore
1427
- const { httpClient, sideEffects } = arguments[1];
1428
- const payload = renameKeysFromSDKRequestToRESTRequest({ id: _id });
1429
- const reqOpts = ambassadorWixEcomV1Checkout.markCheckoutAsCompleted(payload);
1430
- sideEffects?.onSiteCall?.();
1431
- try {
1432
- const result = await httpClient.request(reqOpts);
1433
- sideEffects?.onSuccess?.(result);
1434
- }
1435
- catch (err) {
1436
- const transformedError = sdkTransformError(err, {
1437
- spreadPathsToArguments: {},
1438
- explicitPathsToArguments: { id: '$[0]' },
1439
- singleArgumentUnchanged: false,
1440
- }, ['_id']);
1441
- sideEffects?.onError?.(err);
1442
- throw transformedError;
1443
- }
1444
- }
1445
- /**
1446
- * Updates the quantity of one or more line items in a checkout.
1447
- *
1448
- * This endpoint is only for updating the quantity of line items. To entirely remove a line item from
1449
- * the checkout, use [`removeLineItems()`](#removelineitems).
1450
- * To add a new line item to the checkout, use [`addToCheckout()`](#addtocheckout).
1451
- *
1452
- * This endpoint checks the amount of stock remaining for this line item. If the specified `quantity`
1453
- * is greater than the remaining stock, then the `quantity` returned in the response is the total amount
1454
- * of remaining stock.
1455
- * @param _id - Checkout ID.
1456
- * @param lineItems - Line item info to update.
1457
- * @public
1458
- * @requiredField _id
1459
- * @requiredField lineItems
1460
- * @requiredField lineItems._id
1461
- * @requiredField lineItems.quantity
1462
- * @permissionId ECOM.MODIFY_CHECKOUTS
1463
- * @permissionScope Manage Stores - all permissions
1464
- * @permissionScopeId SCOPE.DC-STORES-MEGA.MANAGE-STORES
1465
- * @permissionScope Manage Restaurants - all permissions
1466
- * @permissionScopeId SCOPE.RESTAURANTS.MEGA-SCOPES
1467
- * @permissionScope Manage eCommerce - all permissions
1468
- * @permissionScopeId SCOPE.DC-ECOM-MEGA.MANAGE-ECOM
1469
- * @permissionScope Picasso private app mega scope
1470
- * @permissionScopeId SCOPE.TEST.MEGA-PICASSO-MANAGE-SITE
1471
- * @permissionScope Manage Orders
1472
- * @permissionScopeId SCOPE.DC-STORES.MANAGE-ORDERS
1473
- * @applicableIdentity APP
1474
- * @applicableIdentity VISITOR
1475
- * @fqn com.wix.ecom.checkout.api.v1.CheckoutService.UpdateLineItemsQuantity
1476
- */
1477
- export async function updateLineItemsQuantity(_id, lineItems) {
1478
- // @ts-ignore
1479
- const { httpClient, sideEffects } = arguments[2];
1480
- const payload = renameKeysFromSDKRequestToRESTRequest({
1481
- id: _id,
1482
- lineItems: lineItems,
1483
- });
1484
- const reqOpts = ambassadorWixEcomV1Checkout.updateLineItemsQuantity(payload);
1485
- sideEffects?.onSiteCall?.();
1486
- try {
1487
- const result = await httpClient.request(reqOpts);
1488
- sideEffects?.onSuccess?.(result);
1489
- return renameKeysFromRESTResponseToSDKResponse(transformPaths(result.data, [
1490
- {
1491
- transformFn: transformRESTPageURLV2ToSDKPageURLV2,
1492
- paths: [{ path: 'checkout.lineItems.url' }],
1493
- },
1494
- {
1495
- transformFn: transformRESTImageToSDKImage,
1496
- paths: [
1497
- { path: 'checkout.lineItems.media' },
1498
- { path: 'checkout.lineItems.catalogOverrideFields.image' },
1499
- ],
1500
- },
1501
- {
1502
- transformFn: transformRESTAddressToSDKAddress,
1503
- paths: [
1504
- { path: 'checkout.billingInfo.address' },
1505
- { path: 'checkout.shippingInfo.shippingDestination.address' },
1506
- {
1507
- path: 'checkout.shippingInfo.selectedCarrierServiceOption.logistics.pickupDetails.address',
1508
- },
1509
- {
1510
- path: 'checkout.shippingInfo.carrierServiceOptions.shippingOptions.logistics.pickupDetails.address',
1511
- },
1512
- ],
1513
- },
1514
- ]));
1515
- }
1516
- catch (err) {
1517
- const transformedError = sdkTransformError(err, {
1518
- spreadPathsToArguments: {},
1519
- explicitPathsToArguments: { id: '$[0]', lineItems: '$[1]' },
1520
- singleArgumentUnchanged: false,
1521
- }, ['_id', 'lineItems']);
1522
- sideEffects?.onError?.(err);
1523
- throw transformedError;
1524
- }
1525
- }
1526
- /** @param _id - Checkout ID.
1527
- * @internal
1528
- * @documentationMaturity preview
1529
- * @requiredField _id
1530
- * @permissionId ECOM.READ_PAYMENT_SETTINGS
1531
- * @fqn com.wix.ecom.checkout.api.v1.CheckoutService.GetCheckoutPaymentSettings
1532
- */
1533
- export async function getCheckoutPaymentSettings(_id) {
1534
- // @ts-ignore
1535
- const { httpClient, sideEffects } = arguments[1];
1536
- const payload = renameKeysFromSDKRequestToRESTRequest({ id: _id });
1537
- const reqOpts = ambassadorWixEcomV1Checkout.getCheckoutPaymentSettings(payload);
1538
- sideEffects?.onSiteCall?.();
1539
- try {
1540
- const result = await httpClient.request(reqOpts);
1541
- sideEffects?.onSuccess?.(result);
1542
- return renameKeysFromRESTResponseToSDKResponse(result.data);
1543
- }
1544
- catch (err) {
1545
- const transformedError = sdkTransformError(err, {
1546
- spreadPathsToArguments: {},
1547
- explicitPathsToArguments: { id: '$[0]' },
1548
- singleArgumentUnchanged: false,
1549
- }, ['_id']);
1550
- sideEffects?.onError?.(err);
1551
- throw transformedError;
1552
- }
1553
- }
1554
- //# sourceMappingURL=ecom-v1-checkout-checkout.universal.js.map