@wix/auto_sdk_stores_customizations-v-3 1.0.15 → 1.0.17

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/index.d.mts +154 -0
  2. package/build/index.d.ts +154 -0
  3. package/build/index.js +1389 -0
  4. package/build/index.js.map +1 -0
  5. package/build/index.mjs +1346 -0
  6. package/build/index.mjs.map +1 -0
  7. package/build/internal/index.d.mts +154 -0
  8. package/build/internal/index.d.ts +154 -0
  9. package/build/internal/index.js +1389 -0
  10. package/build/internal/index.js.map +1 -0
  11. package/build/internal/index.mjs +1346 -0
  12. package/build/internal/index.mjs.map +1 -0
  13. package/build/internal/meta.d.mts +619 -0
  14. package/build/internal/meta.d.ts +619 -0
  15. package/build/internal/meta.js +873 -0
  16. package/build/internal/meta.js.map +1 -0
  17. package/build/internal/meta.mjs +836 -0
  18. package/build/internal/meta.mjs.map +1 -0
  19. package/build/{es/src/stores-catalog-v3-customization-customizations-v-3.types.d.ts → internal/stores-catalog-v3-customization-customizations-v-3.universal-CT4feroB.d.mts} +377 -108
  20. package/build/{cjs/src/stores-catalog-v3-customization-customizations-v-3.types.d.ts → internal/stores-catalog-v3-customization-customizations-v-3.universal-CT4feroB.d.ts} +377 -108
  21. package/build/meta.d.mts +619 -0
  22. package/build/meta.d.ts +619 -0
  23. package/build/meta.js +873 -0
  24. package/build/meta.js.map +1 -0
  25. package/build/meta.mjs +836 -0
  26. package/build/meta.mjs.map +1 -0
  27. package/build/{internal/cjs/src/stores-catalog-v3-customization-customizations-v-3.types.d.ts → stores-catalog-v3-customization-customizations-v-3.universal-CT4feroB.d.mts} +377 -108
  28. package/build/{internal/es/src/stores-catalog-v3-customization-customizations-v-3.types.d.ts → stores-catalog-v3-customization-customizations-v-3.universal-CT4feroB.d.ts} +377 -108
  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/stores-catalog-v3-customization-customizations-v-3.context.d.ts +0 -31
  40. package/build/cjs/src/stores-catalog-v3-customization-customizations-v-3.context.js +0 -40
  41. package/build/cjs/src/stores-catalog-v3-customization-customizations-v-3.context.js.map +0 -1
  42. package/build/cjs/src/stores-catalog-v3-customization-customizations-v-3.http.d.ts +0 -63
  43. package/build/cjs/src/stores-catalog-v3-customization-customizations-v-3.http.js +0 -683
  44. package/build/cjs/src/stores-catalog-v3-customization-customizations-v-3.http.js.map +0 -1
  45. package/build/cjs/src/stores-catalog-v3-customization-customizations-v-3.meta.d.ts +0 -35
  46. package/build/cjs/src/stores-catalog-v3-customization-customizations-v-3.meta.js +0 -237
  47. package/build/cjs/src/stores-catalog-v3-customization-customizations-v-3.meta.js.map +0 -1
  48. package/build/cjs/src/stores-catalog-v3-customization-customizations-v-3.public.d.ts +0 -130
  49. package/build/cjs/src/stores-catalog-v3-customization-customizations-v-3.public.js +0 -126
  50. package/build/cjs/src/stores-catalog-v3-customization-customizations-v-3.public.js.map +0 -1
  51. package/build/cjs/src/stores-catalog-v3-customization-customizations-v-3.types.js +0 -54
  52. package/build/cjs/src/stores-catalog-v3-customization-customizations-v-3.types.js.map +0 -1
  53. package/build/cjs/src/stores-catalog-v3-customization-customizations-v-3.universal.d.ts +0 -1588
  54. package/build/cjs/src/stores-catalog-v3-customization-customizations-v-3.universal.js +0 -819
  55. package/build/cjs/src/stores-catalog-v3-customization-customizations-v-3.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/stores-catalog-v3-customization-customizations-v-3.context.d.ts +0 -31
  67. package/build/es/src/stores-catalog-v3-customization-customizations-v-3.context.js +0 -31
  68. package/build/es/src/stores-catalog-v3-customization-customizations-v-3.context.js.map +0 -1
  69. package/build/es/src/stores-catalog-v3-customization-customizations-v-3.http.d.ts +0 -63
  70. package/build/es/src/stores-catalog-v3-customization-customizations-v-3.http.js +0 -669
  71. package/build/es/src/stores-catalog-v3-customization-customizations-v-3.http.js.map +0 -1
  72. package/build/es/src/stores-catalog-v3-customization-customizations-v-3.meta.d.ts +0 -35
  73. package/build/es/src/stores-catalog-v3-customization-customizations-v-3.meta.js +0 -200
  74. package/build/es/src/stores-catalog-v3-customization-customizations-v-3.meta.js.map +0 -1
  75. package/build/es/src/stores-catalog-v3-customization-customizations-v-3.public.d.ts +0 -130
  76. package/build/es/src/stores-catalog-v3-customization-customizations-v-3.public.js +0 -106
  77. package/build/es/src/stores-catalog-v3-customization-customizations-v-3.public.js.map +0 -1
  78. package/build/es/src/stores-catalog-v3-customization-customizations-v-3.types.js +0 -51
  79. package/build/es/src/stores-catalog-v3-customization-customizations-v-3.types.js.map +0 -1
  80. package/build/es/src/stores-catalog-v3-customization-customizations-v-3.universal.d.ts +0 -1588
  81. package/build/es/src/stores-catalog-v3-customization-customizations-v-3.universal.js +0 -782
  82. package/build/es/src/stores-catalog-v3-customization-customizations-v-3.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/stores-catalog-v3-customization-customizations-v-3.context.d.ts +0 -31
  93. package/build/internal/cjs/src/stores-catalog-v3-customization-customizations-v-3.context.js +0 -40
  94. package/build/internal/cjs/src/stores-catalog-v3-customization-customizations-v-3.context.js.map +0 -1
  95. package/build/internal/cjs/src/stores-catalog-v3-customization-customizations-v-3.http.d.ts +0 -63
  96. package/build/internal/cjs/src/stores-catalog-v3-customization-customizations-v-3.http.js +0 -683
  97. package/build/internal/cjs/src/stores-catalog-v3-customization-customizations-v-3.http.js.map +0 -1
  98. package/build/internal/cjs/src/stores-catalog-v3-customization-customizations-v-3.meta.d.ts +0 -35
  99. package/build/internal/cjs/src/stores-catalog-v3-customization-customizations-v-3.meta.js +0 -237
  100. package/build/internal/cjs/src/stores-catalog-v3-customization-customizations-v-3.meta.js.map +0 -1
  101. package/build/internal/cjs/src/stores-catalog-v3-customization-customizations-v-3.public.d.ts +0 -130
  102. package/build/internal/cjs/src/stores-catalog-v3-customization-customizations-v-3.public.js +0 -126
  103. package/build/internal/cjs/src/stores-catalog-v3-customization-customizations-v-3.public.js.map +0 -1
  104. package/build/internal/cjs/src/stores-catalog-v3-customization-customizations-v-3.types.js +0 -54
  105. package/build/internal/cjs/src/stores-catalog-v3-customization-customizations-v-3.types.js.map +0 -1
  106. package/build/internal/cjs/src/stores-catalog-v3-customization-customizations-v-3.universal.d.ts +0 -1588
  107. package/build/internal/cjs/src/stores-catalog-v3-customization-customizations-v-3.universal.js +0 -819
  108. package/build/internal/cjs/src/stores-catalog-v3-customization-customizations-v-3.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/stores-catalog-v3-customization-customizations-v-3.context.d.ts +0 -31
  119. package/build/internal/es/src/stores-catalog-v3-customization-customizations-v-3.context.js +0 -31
  120. package/build/internal/es/src/stores-catalog-v3-customization-customizations-v-3.context.js.map +0 -1
  121. package/build/internal/es/src/stores-catalog-v3-customization-customizations-v-3.http.d.ts +0 -63
  122. package/build/internal/es/src/stores-catalog-v3-customization-customizations-v-3.http.js +0 -669
  123. package/build/internal/es/src/stores-catalog-v3-customization-customizations-v-3.http.js.map +0 -1
  124. package/build/internal/es/src/stores-catalog-v3-customization-customizations-v-3.meta.d.ts +0 -35
  125. package/build/internal/es/src/stores-catalog-v3-customization-customizations-v-3.meta.js +0 -200
  126. package/build/internal/es/src/stores-catalog-v3-customization-customizations-v-3.meta.js.map +0 -1
  127. package/build/internal/es/src/stores-catalog-v3-customization-customizations-v-3.public.d.ts +0 -130
  128. package/build/internal/es/src/stores-catalog-v3-customization-customizations-v-3.public.js +0 -106
  129. package/build/internal/es/src/stores-catalog-v3-customization-customizations-v-3.public.js.map +0 -1
  130. package/build/internal/es/src/stores-catalog-v3-customization-customizations-v-3.types.js +0 -51
  131. package/build/internal/es/src/stores-catalog-v3-customization-customizations-v-3.types.js.map +0 -1
  132. package/build/internal/es/src/stores-catalog-v3-customization-customizations-v-3.universal.d.ts +0 -1588
  133. package/build/internal/es/src/stores-catalog-v3-customization-customizations-v-3.universal.js +0 -782
  134. package/build/internal/es/src/stores-catalog-v3-customization-customizations-v-3.universal.js.map +0 -1
@@ -1,782 +0,0 @@
1
- import { transformError as sdkTransformError } from '@wix/sdk-runtime/transform-error';
2
- import { queryBuilder } from '@wix/sdk-runtime/query-builder';
3
- import { renameKeysFromSDKRequestToRESTRequest, renameKeysFromRESTResponseToSDKResponse, } from '@wix/sdk-runtime/rename-all-nested-keys';
4
- import * as ambassadorWixStoresCatalogV3Customization from './stores-catalog-v3-customization-customizations-v-3.http.js';
5
- // @ts-ignore
6
- import { transformSDKImageToRESTImage } from '@wix/sdk-runtime/transformations/image';
7
- import { transformRESTImageToSDKImage } from '@wix/sdk-runtime/transformations/image';
8
- import { transformPaths } from '@wix/sdk-runtime/transformations/transform-paths';
9
- export var CustomizationType;
10
- (function (CustomizationType) {
11
- CustomizationType["UNKNOWN_CUSTOMIZATION_TYPE"] = "UNKNOWN_CUSTOMIZATION_TYPE";
12
- CustomizationType["PRODUCT_OPTION"] = "PRODUCT_OPTION";
13
- CustomizationType["MODIFIER"] = "MODIFIER";
14
- })(CustomizationType || (CustomizationType = {}));
15
- export var CustomizationRenderType;
16
- (function (CustomizationRenderType) {
17
- CustomizationRenderType["UNKNOWN_CUSTOMIZATION_RENDER_TYPE"] = "UNKNOWN_CUSTOMIZATION_RENDER_TYPE";
18
- /** Customization by free text input. */
19
- CustomizationRenderType["FREE_TEXT"] = "FREE_TEXT";
20
- /** Customization by selection of text choices. */
21
- CustomizationRenderType["TEXT_CHOICES"] = "TEXT_CHOICES";
22
- /** Customization by selection of colors. */
23
- CustomizationRenderType["SWATCH_CHOICES"] = "SWATCH_CHOICES";
24
- })(CustomizationRenderType || (CustomizationRenderType = {}));
25
- export var ChoiceType;
26
- (function (ChoiceType) {
27
- ChoiceType["UNKNOWN_CHOICE_TYPE"] = "UNKNOWN_CHOICE_TYPE";
28
- /** For a `customizationRenderType` of `TEXT_CHOICES` and `FREE_TEXT`. */
29
- ChoiceType["CHOICE_TEXT"] = "CHOICE_TEXT";
30
- /** For `customizationRenderType: SWATCH_CHOICES`. */
31
- ChoiceType["ONE_COLOR"] = "ONE_COLOR";
32
- /** For `customizationRenderType: SWATCH_CHOICES`. */
33
- ChoiceType["MULTIPLE_COLORS"] = "MULTIPLE_COLORS";
34
- /** For `customizationRenderType: SWATCH_CHOICES`. */
35
- ChoiceType["IMAGE"] = "IMAGE";
36
- })(ChoiceType || (ChoiceType = {}));
37
- export var RequestedFields;
38
- (function (RequestedFields) {
39
- /** Unknown requested field. */
40
- RequestedFields["UNKNOWN_REQUESTED_FIELD"] = "UNKNOWN_REQUESTED_FIELD";
41
- /** Assigned products count. */
42
- RequestedFields["ASSIGNED_PRODUCTS_COUNT"] = "ASSIGNED_PRODUCTS_COUNT";
43
- })(RequestedFields || (RequestedFields = {}));
44
- export var SortOrder;
45
- (function (SortOrder) {
46
- /** Ascending order. */
47
- SortOrder["ASC"] = "ASC";
48
- /** Descending order. */
49
- SortOrder["DESC"] = "DESC";
50
- })(SortOrder || (SortOrder = {}));
51
- export var WebhookIdentityType;
52
- (function (WebhookIdentityType) {
53
- WebhookIdentityType["UNKNOWN"] = "UNKNOWN";
54
- WebhookIdentityType["ANONYMOUS_VISITOR"] = "ANONYMOUS_VISITOR";
55
- WebhookIdentityType["MEMBER"] = "MEMBER";
56
- WebhookIdentityType["WIX_USER"] = "WIX_USER";
57
- WebhookIdentityType["APP"] = "APP";
58
- })(WebhookIdentityType || (WebhookIdentityType = {}));
59
- /**
60
- * Creates a customization.
61
- * @param customization - Customization to create.
62
- * @public
63
- * @documentationMaturity preview
64
- * @requiredField customization
65
- * @requiredField customization.customizationRenderType
66
- * @requiredField customization.customizationSettings
67
- * @requiredField customization.customizationType
68
- * @requiredField customization.freeTextInput.title
69
- * @requiredField customization.name
70
- * @permissionId WIX_STORES.CUSTOMIZATION_CREATE
71
- * @permissionScope Manage Stores - all permissions
72
- * @permissionScopeId SCOPE.DC-STORES-MEGA.MANAGE-STORES
73
- * @permissionScope Manage Stores
74
- * @permissionScopeId SCOPE.STORES.MANAGE-STORES
75
- * @permissionScope Customization write in v3 catalog
76
- * @permissionScopeId SCOPE.STORES.CUSTOMIZATION_WRITE
77
- * @permissionScope Manage Products
78
- * @permissionScopeId SCOPE.DC-STORES.MANAGE-PRODUCTS
79
- * @permissionScope Product write in v3 catalog
80
- * @permissionScopeId SCOPE.STORES.PRODUCT_WRITE
81
- * @permissionScope Manage v3 catalog
82
- * @permissionScopeId SCOPE.STORES.CATALOG_WRITE
83
- * @applicableIdentity APP
84
- * @returns Created customization.
85
- * @fqn wix.stores.catalog.customization.v3.CustomizationService.CreateCustomization
86
- */
87
- export async function createCustomization(customization) {
88
- // @ts-ignore
89
- const { httpClient, sideEffects } = arguments[1];
90
- const payload = transformPaths(renameKeysFromSDKRequestToRESTRequest({ customization: customization }), [
91
- {
92
- transformFn: transformSDKImageToRESTImage,
93
- paths: [{ path: 'customization.choicesSettings.choices.image' }],
94
- },
95
- ]);
96
- const reqOpts = ambassadorWixStoresCatalogV3Customization.createCustomization(payload);
97
- sideEffects?.onSiteCall?.();
98
- try {
99
- const result = await httpClient.request(reqOpts);
100
- sideEffects?.onSuccess?.(result);
101
- return renameKeysFromRESTResponseToSDKResponse(transformPaths(result.data, [
102
- {
103
- transformFn: transformRESTImageToSDKImage,
104
- paths: [{ path: 'customization.choicesSettings.choices.image' }],
105
- },
106
- ]))?.customization;
107
- }
108
- catch (err) {
109
- const transformedError = sdkTransformError(err, {
110
- spreadPathsToArguments: {},
111
- explicitPathsToArguments: { customization: '$[0]' },
112
- singleArgumentUnchanged: false,
113
- }, ['customization']);
114
- sideEffects?.onError?.(err);
115
- throw transformedError;
116
- }
117
- }
118
- /**
119
- * Retrieves a customization.
120
- * @param customizationId - Customization ID.
121
- * @public
122
- * @documentationMaturity preview
123
- * @requiredField customizationId
124
- * @permissionId WIX_STORES.CUSTOMIZATION_READ
125
- * @permissionScope Manage Stores - all permissions
126
- * @permissionScopeId SCOPE.DC-STORES-MEGA.MANAGE-STORES
127
- * @permissionScope Manage Stores
128
- * @permissionScopeId SCOPE.STORES.MANAGE-STORES
129
- * @permissionScope Read v3 catalog
130
- * @permissionScopeId SCOPE.STORES.CATALOG_READ
131
- * @permissionScope Manage Products
132
- * @permissionScopeId SCOPE.DC-STORES.MANAGE-PRODUCTS
133
- * @permissionScope Read Stores - all read permissions
134
- * @permissionScopeId SCOPE.DC-STORES-MEGA.READ-STORES
135
- * @permissionScope Read Products
136
- * @permissionScopeId SCOPE.DC-STORES.READ-PRODUCTS
137
- * @permissionScope Manage Restaurants - all permissions
138
- * @permissionScopeId SCOPE.RESTAURANTS.MEGA-SCOPES
139
- * @permissionScope Product write in v3 catalog
140
- * @permissionScopeId SCOPE.STORES.PRODUCT_WRITE
141
- * @permissionScope Read customizations in v3 catalog
142
- * @permissionScopeId SCOPE.STORES.CUSTOMIZATION_READ
143
- * @permissionScope Manage v3 catalog
144
- * @permissionScopeId SCOPE.STORES.CATALOG_WRITE
145
- * @permissionScope Manage Orders
146
- * @permissionScopeId SCOPE.DC-STORES.MANAGE-ORDERS
147
- * @applicableIdentity APP
148
- * @applicableIdentity VISITOR
149
- * @returns Customization.
150
- * @fqn wix.stores.catalog.customization.v3.CustomizationService.GetCustomization
151
- */
152
- export async function getCustomization(customizationId, options) {
153
- // @ts-ignore
154
- const { httpClient, sideEffects } = arguments[2];
155
- const payload = renameKeysFromSDKRequestToRESTRequest({
156
- customizationId: customizationId,
157
- fields: options?.fields,
158
- });
159
- const reqOpts = ambassadorWixStoresCatalogV3Customization.getCustomization(payload);
160
- sideEffects?.onSiteCall?.();
161
- try {
162
- const result = await httpClient.request(reqOpts);
163
- sideEffects?.onSuccess?.(result);
164
- return renameKeysFromRESTResponseToSDKResponse(transformPaths(result.data, [
165
- {
166
- transformFn: transformRESTImageToSDKImage,
167
- paths: [{ path: 'customization.choicesSettings.choices.image' }],
168
- },
169
- ]))?.customization;
170
- }
171
- catch (err) {
172
- const transformedError = sdkTransformError(err, {
173
- spreadPathsToArguments: {},
174
- explicitPathsToArguments: {
175
- customizationId: '$[0]',
176
- fields: '$[1].fields',
177
- },
178
- singleArgumentUnchanged: false,
179
- }, ['customizationId', 'options']);
180
- sideEffects?.onError?.(err);
181
- throw transformedError;
182
- }
183
- }
184
- /**
185
- * Updates a customization.
186
- *
187
- * Each time the customization is updated, `revision` increments by 1.
188
- * The current `revision` must be passed when updating the customization.
189
- * This ensures you're working with the latest customization and prevents unintended overwrites.
190
- * @param _id - Customization ID.
191
- * @public
192
- * @documentationMaturity preview
193
- * @requiredField _id
194
- * @requiredField customization
195
- * @requiredField customization.revision
196
- * @permissionId WIX_STORES.CUSTOMIZATION_UPDATE
197
- * @permissionScope Manage Stores - all permissions
198
- * @permissionScopeId SCOPE.DC-STORES-MEGA.MANAGE-STORES
199
- * @permissionScope Manage Stores
200
- * @permissionScopeId SCOPE.STORES.MANAGE-STORES
201
- * @permissionScope Customization write in v3 catalog
202
- * @permissionScopeId SCOPE.STORES.CUSTOMIZATION_WRITE
203
- * @permissionScope Manage Products
204
- * @permissionScopeId SCOPE.DC-STORES.MANAGE-PRODUCTS
205
- * @permissionScope Product write in v3 catalog
206
- * @permissionScopeId SCOPE.STORES.PRODUCT_WRITE
207
- * @permissionScope Manage v3 catalog
208
- * @permissionScopeId SCOPE.STORES.CATALOG_WRITE
209
- * @applicableIdentity APP
210
- * @returns Updated customization.
211
- * @fqn wix.stores.catalog.customization.v3.CustomizationService.UpdateCustomization
212
- */
213
- export async function updateCustomization(_id, customization, options) {
214
- // @ts-ignore
215
- const { httpClient, sideEffects } = arguments[3];
216
- const payload = transformPaths(renameKeysFromSDKRequestToRESTRequest({
217
- customization: { ...customization, id: _id },
218
- fields: options?.fields,
219
- }), [
220
- {
221
- transformFn: transformSDKImageToRESTImage,
222
- paths: [{ path: 'customization.choicesSettings.choices.image' }],
223
- },
224
- ]);
225
- const reqOpts = ambassadorWixStoresCatalogV3Customization.updateCustomization(payload);
226
- sideEffects?.onSiteCall?.();
227
- try {
228
- const result = await httpClient.request(reqOpts);
229
- sideEffects?.onSuccess?.(result);
230
- return renameKeysFromRESTResponseToSDKResponse(transformPaths(result.data, [
231
- {
232
- transformFn: transformRESTImageToSDKImage,
233
- paths: [{ path: 'customization.choicesSettings.choices.image' }],
234
- },
235
- ]))?.customization;
236
- }
237
- catch (err) {
238
- const transformedError = sdkTransformError(err, {
239
- spreadPathsToArguments: { customization: '$[1]' },
240
- explicitPathsToArguments: {
241
- 'customization.id': '$[0]',
242
- fields: '$[2].fields',
243
- },
244
- singleArgumentUnchanged: false,
245
- }, ['_id', 'customization', 'options']);
246
- sideEffects?.onError?.(err);
247
- throw transformedError;
248
- }
249
- }
250
- /**
251
- * Deletes a customization.
252
- *
253
- * > **Note:** A customization cannot be deleted if it is assigned to one or more products.
254
- * @param customizationId - Customization ID.
255
- * @public
256
- * @documentationMaturity preview
257
- * @requiredField customizationId
258
- * @permissionId WIX_STORES.CUSTOMIZATION_DELETE
259
- * @permissionScope Manage Stores - all permissions
260
- * @permissionScopeId SCOPE.DC-STORES-MEGA.MANAGE-STORES
261
- * @permissionScope Manage Stores
262
- * @permissionScopeId SCOPE.STORES.MANAGE-STORES
263
- * @permissionScope Customization write in v3 catalog
264
- * @permissionScopeId SCOPE.STORES.CUSTOMIZATION_WRITE
265
- * @permissionScope Manage Products
266
- * @permissionScopeId SCOPE.DC-STORES.MANAGE-PRODUCTS
267
- * @permissionScope Product write in v3 catalog
268
- * @permissionScopeId SCOPE.STORES.PRODUCT_WRITE
269
- * @permissionScope Manage v3 catalog
270
- * @permissionScopeId SCOPE.STORES.CATALOG_WRITE
271
- * @applicableIdentity APP
272
- * @fqn wix.stores.catalog.customization.v3.CustomizationService.DeleteCustomization
273
- */
274
- export async function deleteCustomization(customizationId) {
275
- // @ts-ignore
276
- const { httpClient, sideEffects } = arguments[1];
277
- const payload = renameKeysFromSDKRequestToRESTRequest({
278
- customizationId: customizationId,
279
- });
280
- const reqOpts = ambassadorWixStoresCatalogV3Customization.deleteCustomization(payload);
281
- sideEffects?.onSiteCall?.();
282
- try {
283
- const result = await httpClient.request(reqOpts);
284
- sideEffects?.onSuccess?.(result);
285
- }
286
- catch (err) {
287
- const transformedError = sdkTransformError(err, {
288
- spreadPathsToArguments: {},
289
- explicitPathsToArguments: { customizationId: '$[0]' },
290
- singleArgumentUnchanged: false,
291
- }, ['customizationId']);
292
- sideEffects?.onError?.(err);
293
- throw transformedError;
294
- }
295
- }
296
- /**
297
- * Retrieves a list of up to 100 customizations, given the provided filtering, sorting, and cursor paging.
298
- * Pass supported values to the `fields` array in the request to include those fields in the response.
299
- *
300
- *
301
- * Query Customizations runs with these defaults, which you can override:
302
- *
303
- * - `createdDate` is sorted in `DESC` order
304
- * - `cursorPaging.limit` is `100`
305
- *
306
- * For field support for filters and sorting,
307
- * see [Customizations: Supported Filters and Sorting](https://dev.wix.com/docs/rest/business-solutions/stores/catalog-v3/customizations-v3/supported-filters-and-sorting).
308
- *
309
- * To learn about working with _Query_ endpoints, see
310
- * [API Query Language](https://dev.wix.com/docs/rest/articles/getting-started/api-query-language),
311
- * and [Sorting and Paging](https://dev.wix.com/docs/rest/articles/getting-started/sorting-and-paging).
312
- * @public
313
- * @documentationMaturity preview
314
- * @permissionScope Manage Stores - all permissions
315
- * @permissionScopeId SCOPE.DC-STORES-MEGA.MANAGE-STORES
316
- * @permissionScope Manage Stores
317
- * @permissionScopeId SCOPE.STORES.MANAGE-STORES
318
- * @permissionScope Read v3 catalog
319
- * @permissionScopeId SCOPE.STORES.CATALOG_READ
320
- * @permissionScope Manage Products
321
- * @permissionScopeId SCOPE.DC-STORES.MANAGE-PRODUCTS
322
- * @permissionScope Read Stores - all read permissions
323
- * @permissionScopeId SCOPE.DC-STORES-MEGA.READ-STORES
324
- * @permissionScope Read Products
325
- * @permissionScopeId SCOPE.DC-STORES.READ-PRODUCTS
326
- * @permissionScope Manage Restaurants - all permissions
327
- * @permissionScopeId SCOPE.RESTAURANTS.MEGA-SCOPES
328
- * @permissionScope Product write in v3 catalog
329
- * @permissionScopeId SCOPE.STORES.PRODUCT_WRITE
330
- * @permissionScope Read customizations in v3 catalog
331
- * @permissionScopeId SCOPE.STORES.CUSTOMIZATION_READ
332
- * @permissionScope Manage v3 catalog
333
- * @permissionScopeId SCOPE.STORES.CATALOG_WRITE
334
- * @permissionScope Manage Orders
335
- * @permissionScopeId SCOPE.DC-STORES.MANAGE-ORDERS
336
- * @permissionId WIX_STORES.CUSTOMIZATION_READ
337
- * @applicableIdentity APP
338
- * @applicableIdentity VISITOR
339
- * @fqn wix.stores.catalog.customization.v3.CustomizationService.QueryCustomizations
340
- */
341
- export function queryCustomizations(options) {
342
- // @ts-ignore
343
- const { httpClient, sideEffects } = arguments[1];
344
- return queryBuilder({
345
- func: async (payload) => {
346
- const reqOpts = ambassadorWixStoresCatalogV3Customization.queryCustomizations({
347
- ...payload,
348
- ...(options ?? {}),
349
- });
350
- sideEffects?.onSiteCall?.();
351
- try {
352
- const result = await httpClient.request(reqOpts);
353
- sideEffects?.onSuccess?.(result);
354
- return result;
355
- }
356
- catch (err) {
357
- sideEffects?.onError?.(err);
358
- throw err;
359
- }
360
- },
361
- requestTransformer: (query) => {
362
- const args = [query, options];
363
- return renameKeysFromSDKRequestToRESTRequest({
364
- ...args?.[1],
365
- query: args?.[0],
366
- });
367
- },
368
- responseTransformer: ({ data, }) => {
369
- const transformedData = renameKeysFromRESTResponseToSDKResponse(transformPaths(data, [
370
- {
371
- transformFn: transformRESTImageToSDKImage,
372
- paths: [{ path: 'customizations.choicesSettings.choices.image' }],
373
- },
374
- ]));
375
- return {
376
- items: transformedData?.customizations,
377
- pagingMetadata: transformedData?.pagingMetadata,
378
- };
379
- },
380
- errorTransformer: (err) => {
381
- const transformedError = sdkTransformError(err, {
382
- spreadPathsToArguments: {},
383
- explicitPathsToArguments: { query: '$[0]' },
384
- singleArgumentUnchanged: false,
385
- });
386
- throw transformedError;
387
- },
388
- pagingMethod: 'CURSOR',
389
- transformationPaths: {},
390
- });
391
- }
392
- /**
393
- * Creates multiple brands.
394
- * @param customizations - Customizations to create.
395
- * @public
396
- * @documentationMaturity preview
397
- * @requiredField customizations
398
- * @permissionId WIX_STORES.CUSTOMIZATION_CREATE
399
- * @permissionScope Manage Stores - all permissions
400
- * @permissionScopeId SCOPE.DC-STORES-MEGA.MANAGE-STORES
401
- * @permissionScope Manage Stores
402
- * @permissionScopeId SCOPE.STORES.MANAGE-STORES
403
- * @permissionScope Customization write in v3 catalog
404
- * @permissionScopeId SCOPE.STORES.CUSTOMIZATION_WRITE
405
- * @permissionScope Manage Products
406
- * @permissionScopeId SCOPE.DC-STORES.MANAGE-PRODUCTS
407
- * @permissionScope Product write in v3 catalog
408
- * @permissionScopeId SCOPE.STORES.PRODUCT_WRITE
409
- * @permissionScope Manage v3 catalog
410
- * @permissionScopeId SCOPE.STORES.CATALOG_WRITE
411
- * @applicableIdentity APP
412
- * @fqn wix.stores.catalog.customization.v3.CustomizationService.BulkCreateCustomizations
413
- */
414
- export async function bulkCreateCustomizations(customizations, options) {
415
- // @ts-ignore
416
- const { httpClient, sideEffects } = arguments[2];
417
- const payload = transformPaths(renameKeysFromSDKRequestToRESTRequest({
418
- customizations: customizations,
419
- returnEntity: options?.returnEntity,
420
- }), [
421
- {
422
- transformFn: transformSDKImageToRESTImage,
423
- paths: [{ path: 'customizations.choicesSettings.choices.image' }],
424
- },
425
- ]);
426
- const reqOpts = ambassadorWixStoresCatalogV3Customization.bulkCreateCustomizations(payload);
427
- sideEffects?.onSiteCall?.();
428
- try {
429
- const result = await httpClient.request(reqOpts);
430
- sideEffects?.onSuccess?.(result);
431
- return renameKeysFromRESTResponseToSDKResponse(transformPaths(result.data, [
432
- {
433
- transformFn: transformRESTImageToSDKImage,
434
- paths: [
435
- { path: 'results.customization.choicesSettings.choices.image' },
436
- ],
437
- },
438
- ]));
439
- }
440
- catch (err) {
441
- const transformedError = sdkTransformError(err, {
442
- spreadPathsToArguments: {},
443
- explicitPathsToArguments: {
444
- customizations: '$[0]',
445
- returnEntity: '$[1].returnEntity',
446
- },
447
- singleArgumentUnchanged: false,
448
- }, ['customizations', 'options']);
449
- sideEffects?.onError?.(err);
450
- throw transformedError;
451
- }
452
- }
453
- /**
454
- * Adds choices to a customization.
455
- * @param customizationId - Customization ID.
456
- * @param choices - Choices to add.
457
- * @public
458
- * @documentationMaturity preview
459
- * @requiredField choices
460
- * @requiredField customizationId
461
- * @permissionId WIX_STORES.CUSTOMIZATION_UPDATE
462
- * @permissionScope Manage Stores - all permissions
463
- * @permissionScopeId SCOPE.DC-STORES-MEGA.MANAGE-STORES
464
- * @permissionScope Manage Stores
465
- * @permissionScopeId SCOPE.STORES.MANAGE-STORES
466
- * @permissionScope Customization write in v3 catalog
467
- * @permissionScopeId SCOPE.STORES.CUSTOMIZATION_WRITE
468
- * @permissionScope Manage Products
469
- * @permissionScopeId SCOPE.DC-STORES.MANAGE-PRODUCTS
470
- * @permissionScope Product write in v3 catalog
471
- * @permissionScopeId SCOPE.STORES.PRODUCT_WRITE
472
- * @permissionScope Manage v3 catalog
473
- * @permissionScopeId SCOPE.STORES.CATALOG_WRITE
474
- * @applicableIdentity APP
475
- * @fqn wix.stores.catalog.customization.v3.CustomizationService.AddCustomizationChoices
476
- */
477
- export async function addCustomizationChoices(customizationId, choices, options) {
478
- // @ts-ignore
479
- const { httpClient, sideEffects } = arguments[3];
480
- const payload = transformPaths(renameKeysFromSDKRequestToRESTRequest({
481
- customizationId: customizationId,
482
- choices: choices,
483
- fields: options?.fields,
484
- }), [
485
- {
486
- transformFn: transformSDKImageToRESTImage,
487
- paths: [{ path: 'choices.image' }],
488
- },
489
- ]);
490
- const reqOpts = ambassadorWixStoresCatalogV3Customization.addCustomizationChoices(payload);
491
- sideEffects?.onSiteCall?.();
492
- try {
493
- const result = await httpClient.request(reqOpts);
494
- sideEffects?.onSuccess?.(result);
495
- return renameKeysFromRESTResponseToSDKResponse(transformPaths(result.data, [
496
- {
497
- transformFn: transformRESTImageToSDKImage,
498
- paths: [{ path: 'customization.choicesSettings.choices.image' }],
499
- },
500
- ]));
501
- }
502
- catch (err) {
503
- const transformedError = sdkTransformError(err, {
504
- spreadPathsToArguments: {},
505
- explicitPathsToArguments: {
506
- customizationId: '$[0]',
507
- choices: '$[1]',
508
- fields: '$[2].fields',
509
- },
510
- singleArgumentUnchanged: false,
511
- }, ['customizationId', 'choices', 'options']);
512
- sideEffects?.onError?.(err);
513
- throw transformedError;
514
- }
515
- }
516
- /**
517
- * Sets a customization's choices. Any and all existing choices will be overridden.
518
- *
519
- * > **Note:** A choice cannot be overridden if it is assigned to one or more products.
520
- * @param customizationId - Customization ID.
521
- * @param choices - Choices to set.
522
- * @public
523
- * @documentationMaturity preview
524
- * @requiredField choices
525
- * @requiredField customizationId
526
- * @permissionId WIX_STORES.CUSTOMIZATION_UPDATE
527
- * @permissionScope Manage Stores - all permissions
528
- * @permissionScopeId SCOPE.DC-STORES-MEGA.MANAGE-STORES
529
- * @permissionScope Manage Stores
530
- * @permissionScopeId SCOPE.STORES.MANAGE-STORES
531
- * @permissionScope Customization write in v3 catalog
532
- * @permissionScopeId SCOPE.STORES.CUSTOMIZATION_WRITE
533
- * @permissionScope Manage Products
534
- * @permissionScopeId SCOPE.DC-STORES.MANAGE-PRODUCTS
535
- * @permissionScope Product write in v3 catalog
536
- * @permissionScopeId SCOPE.STORES.PRODUCT_WRITE
537
- * @permissionScope Manage v3 catalog
538
- * @permissionScopeId SCOPE.STORES.CATALOG_WRITE
539
- * @applicableIdentity APP
540
- * @fqn wix.stores.catalog.customization.v3.CustomizationService.SetCustomizationChoices
541
- */
542
- export async function setCustomizationChoices(customizationId, choices, options) {
543
- // @ts-ignore
544
- const { httpClient, sideEffects } = arguments[3];
545
- const payload = transformPaths(renameKeysFromSDKRequestToRESTRequest({
546
- customizationId: customizationId,
547
- choices: choices,
548
- fields: options?.fields,
549
- }), [
550
- {
551
- transformFn: transformSDKImageToRESTImage,
552
- paths: [{ path: 'choices.image' }],
553
- },
554
- ]);
555
- const reqOpts = ambassadorWixStoresCatalogV3Customization.setCustomizationChoices(payload);
556
- sideEffects?.onSiteCall?.();
557
- try {
558
- const result = await httpClient.request(reqOpts);
559
- sideEffects?.onSuccess?.(result);
560
- return renameKeysFromRESTResponseToSDKResponse(transformPaths(result.data, [
561
- {
562
- transformFn: transformRESTImageToSDKImage,
563
- paths: [{ path: 'customization.choicesSettings.choices.image' }],
564
- },
565
- ]));
566
- }
567
- catch (err) {
568
- const transformedError = sdkTransformError(err, {
569
- spreadPathsToArguments: {},
570
- explicitPathsToArguments: {
571
- customizationId: '$[0]',
572
- choices: '$[1]',
573
- fields: '$[2].fields',
574
- },
575
- singleArgumentUnchanged: false,
576
- }, ['customizationId', 'choices', 'options']);
577
- sideEffects?.onError?.(err);
578
- throw transformedError;
579
- }
580
- }
581
- /**
582
- * Removes choices from a customization.
583
- *
584
- * +> **Note:** A choice cannot be removed if it is assigned to one or more products.
585
- * @param customizationId - Customization ID.
586
- * @param choiceIds - IDs of choices to remove.
587
- * @public
588
- * @documentationMaturity preview
589
- * @requiredField choiceIds
590
- * @requiredField customizationId
591
- * @permissionId WIX_STORES.CUSTOMIZATION_UPDATE
592
- * @permissionScope Manage Stores - all permissions
593
- * @permissionScopeId SCOPE.DC-STORES-MEGA.MANAGE-STORES
594
- * @permissionScope Manage Stores
595
- * @permissionScopeId SCOPE.STORES.MANAGE-STORES
596
- * @permissionScope Customization write in v3 catalog
597
- * @permissionScopeId SCOPE.STORES.CUSTOMIZATION_WRITE
598
- * @permissionScope Manage Products
599
- * @permissionScopeId SCOPE.DC-STORES.MANAGE-PRODUCTS
600
- * @permissionScope Product write in v3 catalog
601
- * @permissionScopeId SCOPE.STORES.PRODUCT_WRITE
602
- * @permissionScope Manage v3 catalog
603
- * @permissionScopeId SCOPE.STORES.CATALOG_WRITE
604
- * @applicableIdentity APP
605
- * @fqn wix.stores.catalog.customization.v3.CustomizationService.RemoveCustomizationChoices
606
- */
607
- export async function removeCustomizationChoices(customizationId, choiceIds, options) {
608
- // @ts-ignore
609
- const { httpClient, sideEffects } = arguments[3];
610
- const payload = renameKeysFromSDKRequestToRESTRequest({
611
- customizationId: customizationId,
612
- choiceIds: choiceIds,
613
- revision: options?.revision,
614
- fields: options?.fields,
615
- });
616
- const reqOpts = ambassadorWixStoresCatalogV3Customization.removeCustomizationChoices(payload);
617
- sideEffects?.onSiteCall?.();
618
- try {
619
- const result = await httpClient.request(reqOpts);
620
- sideEffects?.onSuccess?.(result);
621
- return renameKeysFromRESTResponseToSDKResponse(transformPaths(result.data, [
622
- {
623
- transformFn: transformRESTImageToSDKImage,
624
- paths: [{ path: 'customization.choicesSettings.choices.image' }],
625
- },
626
- ]));
627
- }
628
- catch (err) {
629
- const transformedError = sdkTransformError(err, {
630
- spreadPathsToArguments: {},
631
- explicitPathsToArguments: {
632
- customizationId: '$[0]',
633
- choiceIds: '$[1]',
634
- revision: '$[2].revision',
635
- fields: '$[2].fields',
636
- },
637
- singleArgumentUnchanged: false,
638
- }, ['customizationId', 'choiceIds', 'options']);
639
- sideEffects?.onError?.(err);
640
- throw transformedError;
641
- }
642
- }
643
- /**
644
- * Adds choices to multiple customizations.
645
- * @param customizationsChoices - List of customization IDs and choices.
646
- * @public
647
- * @documentationMaturity preview
648
- * @requiredField customizationsChoices
649
- * @requiredField customizationsChoices.choices
650
- * @requiredField customizationsChoices.customizationId
651
- * @permissionId WIX_STORES.CUSTOMIZATION_UPDATE
652
- * @permissionScope Manage Stores - all permissions
653
- * @permissionScopeId SCOPE.DC-STORES-MEGA.MANAGE-STORES
654
- * @permissionScope Manage Stores
655
- * @permissionScopeId SCOPE.STORES.MANAGE-STORES
656
- * @permissionScope Customization write in v3 catalog
657
- * @permissionScopeId SCOPE.STORES.CUSTOMIZATION_WRITE
658
- * @permissionScope Manage Products
659
- * @permissionScopeId SCOPE.DC-STORES.MANAGE-PRODUCTS
660
- * @permissionScope Product write in v3 catalog
661
- * @permissionScopeId SCOPE.STORES.PRODUCT_WRITE
662
- * @permissionScope Manage v3 catalog
663
- * @permissionScopeId SCOPE.STORES.CATALOG_WRITE
664
- * @applicableIdentity APP
665
- * @fqn wix.stores.catalog.customization.v3.CustomizationService.BulkAddCustomizationChoices
666
- */
667
- export async function bulkAddCustomizationChoices(customizationsChoices, options) {
668
- // @ts-ignore
669
- const { httpClient, sideEffects } = arguments[2];
670
- const payload = transformPaths(renameKeysFromSDKRequestToRESTRequest({
671
- customizationsChoices: customizationsChoices,
672
- returnEntity: options?.returnEntity,
673
- fields: options?.fields,
674
- }), [
675
- {
676
- transformFn: transformSDKImageToRESTImage,
677
- paths: [{ path: 'customizationsChoices.choices.image' }],
678
- },
679
- ]);
680
- const reqOpts = ambassadorWixStoresCatalogV3Customization.bulkAddCustomizationChoices(payload);
681
- sideEffects?.onSiteCall?.();
682
- try {
683
- const result = await httpClient.request(reqOpts);
684
- sideEffects?.onSuccess?.(result);
685
- return renameKeysFromRESTResponseToSDKResponse(transformPaths(result.data, [
686
- {
687
- transformFn: transformRESTImageToSDKImage,
688
- paths: [
689
- { path: 'results.customization.choicesSettings.choices.image' },
690
- ],
691
- },
692
- ]));
693
- }
694
- catch (err) {
695
- const transformedError = sdkTransformError(err, {
696
- spreadPathsToArguments: {},
697
- explicitPathsToArguments: {
698
- customizationsChoices: '$[0]',
699
- returnEntity: '$[1].returnEntity',
700
- fields: '$[1].fields',
701
- },
702
- singleArgumentUnchanged: false,
703
- }, ['customizationsChoices', 'options']);
704
- sideEffects?.onError?.(err);
705
- throw transformedError;
706
- }
707
- }
708
- /**
709
- * Updates multiple customizations.
710
- *
711
- * Each time the customization is updated, `revision` increments by 1.
712
- * The current `revision` must be passed when updating the customization.
713
- * This ensures you're working with the latest customization and prevents unintended overwrites.
714
- * @param customizations - List of customizations to update.
715
- * @public
716
- * @documentationMaturity preview
717
- * @requiredField customizations
718
- * @requiredField customizations.customization._id
719
- * @requiredField customizations.customization.name
720
- * @requiredField customizations.customization.revision
721
- * @permissionId WIX_STORES.CUSTOMIZATION_UPDATE
722
- * @permissionScope Manage Stores - all permissions
723
- * @permissionScopeId SCOPE.DC-STORES-MEGA.MANAGE-STORES
724
- * @permissionScope Manage Stores
725
- * @permissionScopeId SCOPE.STORES.MANAGE-STORES
726
- * @permissionScope Customization write in v3 catalog
727
- * @permissionScopeId SCOPE.STORES.CUSTOMIZATION_WRITE
728
- * @permissionScope Manage Products
729
- * @permissionScopeId SCOPE.DC-STORES.MANAGE-PRODUCTS
730
- * @permissionScope Product write in v3 catalog
731
- * @permissionScopeId SCOPE.STORES.PRODUCT_WRITE
732
- * @permissionScope Manage v3 catalog
733
- * @permissionScopeId SCOPE.STORES.CATALOG_WRITE
734
- * @applicableIdentity APP
735
- * @fqn wix.stores.catalog.customization.v3.CustomizationService.BulkUpdateCustomizations
736
- */
737
- export async function bulkUpdateCustomizations(customizations, options) {
738
- // @ts-ignore
739
- const { httpClient, sideEffects } = arguments[2];
740
- const payload = transformPaths(renameKeysFromSDKRequestToRESTRequest({
741
- customizations: customizations,
742
- returnEntity: options?.returnEntity,
743
- fields: options?.fields,
744
- }), [
745
- {
746
- transformFn: transformSDKImageToRESTImage,
747
- paths: [
748
- {
749
- path: 'customizations.customization.choicesSettings.choices.image',
750
- },
751
- ],
752
- },
753
- ]);
754
- const reqOpts = ambassadorWixStoresCatalogV3Customization.bulkUpdateCustomizations(payload);
755
- sideEffects?.onSiteCall?.();
756
- try {
757
- const result = await httpClient.request(reqOpts);
758
- sideEffects?.onSuccess?.(result);
759
- return renameKeysFromRESTResponseToSDKResponse(transformPaths(result.data, [
760
- {
761
- transformFn: transformRESTImageToSDKImage,
762
- paths: [
763
- { path: 'results.customization.choicesSettings.choices.image' },
764
- ],
765
- },
766
- ]));
767
- }
768
- catch (err) {
769
- const transformedError = sdkTransformError(err, {
770
- spreadPathsToArguments: {},
771
- explicitPathsToArguments: {
772
- customizations: '$[0]',
773
- returnEntity: '$[1].returnEntity',
774
- fields: '$[1].fields',
775
- },
776
- singleArgumentUnchanged: false,
777
- }, ['customizations', 'options']);
778
- sideEffects?.onError?.(err);
779
- throw transformedError;
780
- }
781
- }
782
- //# sourceMappingURL=stores-catalog-v3-customization-customizations-v-3.universal.js.map