@wix/auto_sdk_metro_products 1.0.1 → 1.0.3

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 (123) hide show
  1. package/build/cjs/index.d.ts +81 -1
  2. package/build/cjs/index.js +1514 -15
  3. package/build/cjs/index.js.map +1 -1
  4. package/build/cjs/index.typings.d.ts +574 -1
  5. package/build/cjs/index.typings.js +1425 -15
  6. package/build/cjs/index.typings.js.map +1 -1
  7. package/build/cjs/meta.d.ts +447 -1
  8. package/build/cjs/meta.js +940 -15
  9. package/build/cjs/meta.js.map +1 -1
  10. package/build/es/index.d.mts +81 -0
  11. package/build/es/index.mjs +1481 -0
  12. package/build/es/index.mjs.map +1 -0
  13. package/build/es/{src/metroinspector-v1-product-products.universal.d.ts → index.typings.d.mts} +138 -212
  14. package/build/es/index.typings.mjs +1392 -0
  15. package/build/es/index.typings.mjs.map +1 -0
  16. package/build/es/{src/metroinspector-v1-product-products.types.d.ts → meta.d.mts} +92 -259
  17. package/build/es/meta.mjs +907 -0
  18. package/build/es/meta.mjs.map +1 -0
  19. package/build/internal/cjs/index.d.ts +81 -1
  20. package/build/internal/cjs/index.js +1514 -15
  21. package/build/internal/cjs/index.js.map +1 -1
  22. package/build/internal/cjs/index.typings.d.ts +574 -1
  23. package/build/internal/cjs/index.typings.js +1425 -15
  24. package/build/internal/cjs/index.typings.js.map +1 -1
  25. package/build/internal/cjs/meta.d.ts +447 -1
  26. package/build/internal/cjs/meta.js +940 -15
  27. package/build/internal/cjs/meta.js.map +1 -1
  28. package/build/internal/es/index.d.mts +81 -0
  29. package/build/internal/es/index.mjs +1481 -0
  30. package/build/internal/es/index.mjs.map +1 -0
  31. package/build/internal/{cjs/src/metroinspector-v1-product-products.universal.d.ts → es/index.typings.d.mts} +138 -212
  32. package/build/internal/es/index.typings.mjs +1392 -0
  33. package/build/internal/es/index.typings.mjs.map +1 -0
  34. package/build/{cjs/src/metroinspector-v1-product-products.types.d.ts → internal/es/meta.d.mts} +92 -259
  35. package/build/internal/es/meta.mjs +907 -0
  36. package/build/internal/es/meta.mjs.map +1 -0
  37. package/package.json +12 -10
  38. package/build/cjs/src/metroinspector-v1-product-products.context.d.ts +0 -14
  39. package/build/cjs/src/metroinspector-v1-product-products.context.js +0 -22
  40. package/build/cjs/src/metroinspector-v1-product-products.context.js.map +0 -1
  41. package/build/cjs/src/metroinspector-v1-product-products.http.d.ts +0 -16
  42. package/build/cjs/src/metroinspector-v1-product-products.http.js +0 -728
  43. package/build/cjs/src/metroinspector-v1-product-products.http.js.map +0 -1
  44. package/build/cjs/src/metroinspector-v1-product-products.meta.d.ts +0 -30
  45. package/build/cjs/src/metroinspector-v1-product-products.meta.js +0 -218
  46. package/build/cjs/src/metroinspector-v1-product-products.meta.js.map +0 -1
  47. package/build/cjs/src/metroinspector-v1-product-products.public.d.ts +0 -68
  48. package/build/cjs/src/metroinspector-v1-product-products.public.js +0 -72
  49. package/build/cjs/src/metroinspector-v1-product-products.public.js.map +0 -1
  50. package/build/cjs/src/metroinspector-v1-product-products.types.js +0 -61
  51. package/build/cjs/src/metroinspector-v1-product-products.types.js.map +0 -1
  52. package/build/cjs/src/metroinspector-v1-product-products.universal.d.ts +0 -648
  53. package/build/cjs/src/metroinspector-v1-product-products.universal.js +0 -739
  54. package/build/cjs/src/metroinspector-v1-product-products.universal.js.map +0 -1
  55. package/build/es/index.d.ts +0 -1
  56. package/build/es/index.js +0 -2
  57. package/build/es/index.js.map +0 -1
  58. package/build/es/index.typings.d.ts +0 -1
  59. package/build/es/index.typings.js +0 -2
  60. package/build/es/index.typings.js.map +0 -1
  61. package/build/es/meta.d.ts +0 -1
  62. package/build/es/meta.js +0 -2
  63. package/build/es/meta.js.map +0 -1
  64. package/build/es/src/metroinspector-v1-product-products.context.d.ts +0 -14
  65. package/build/es/src/metroinspector-v1-product-products.context.js +0 -14
  66. package/build/es/src/metroinspector-v1-product-products.context.js.map +0 -1
  67. package/build/es/src/metroinspector-v1-product-products.http.d.ts +0 -16
  68. package/build/es/src/metroinspector-v1-product-products.http.js +0 -715
  69. package/build/es/src/metroinspector-v1-product-products.http.js.map +0 -1
  70. package/build/es/src/metroinspector-v1-product-products.meta.d.ts +0 -30
  71. package/build/es/src/metroinspector-v1-product-products.meta.js +0 -182
  72. package/build/es/src/metroinspector-v1-product-products.meta.js.map +0 -1
  73. package/build/es/src/metroinspector-v1-product-products.public.d.ts +0 -68
  74. package/build/es/src/metroinspector-v1-product-products.public.js +0 -54
  75. package/build/es/src/metroinspector-v1-product-products.public.js.map +0 -1
  76. package/build/es/src/metroinspector-v1-product-products.types.js +0 -58
  77. package/build/es/src/metroinspector-v1-product-products.types.js.map +0 -1
  78. package/build/es/src/metroinspector-v1-product-products.universal.js +0 -703
  79. package/build/es/src/metroinspector-v1-product-products.universal.js.map +0 -1
  80. package/build/internal/cjs/src/metroinspector-v1-product-products.context.d.ts +0 -14
  81. package/build/internal/cjs/src/metroinspector-v1-product-products.context.js +0 -22
  82. package/build/internal/cjs/src/metroinspector-v1-product-products.context.js.map +0 -1
  83. package/build/internal/cjs/src/metroinspector-v1-product-products.http.d.ts +0 -16
  84. package/build/internal/cjs/src/metroinspector-v1-product-products.http.js +0 -728
  85. package/build/internal/cjs/src/metroinspector-v1-product-products.http.js.map +0 -1
  86. package/build/internal/cjs/src/metroinspector-v1-product-products.meta.d.ts +0 -30
  87. package/build/internal/cjs/src/metroinspector-v1-product-products.meta.js +0 -218
  88. package/build/internal/cjs/src/metroinspector-v1-product-products.meta.js.map +0 -1
  89. package/build/internal/cjs/src/metroinspector-v1-product-products.public.d.ts +0 -68
  90. package/build/internal/cjs/src/metroinspector-v1-product-products.public.js +0 -72
  91. package/build/internal/cjs/src/metroinspector-v1-product-products.public.js.map +0 -1
  92. package/build/internal/cjs/src/metroinspector-v1-product-products.types.d.ts +0 -614
  93. package/build/internal/cjs/src/metroinspector-v1-product-products.types.js +0 -61
  94. package/build/internal/cjs/src/metroinspector-v1-product-products.types.js.map +0 -1
  95. package/build/internal/cjs/src/metroinspector-v1-product-products.universal.js +0 -739
  96. package/build/internal/cjs/src/metroinspector-v1-product-products.universal.js.map +0 -1
  97. package/build/internal/es/index.d.ts +0 -1
  98. package/build/internal/es/index.js +0 -2
  99. package/build/internal/es/index.js.map +0 -1
  100. package/build/internal/es/index.typings.d.ts +0 -1
  101. package/build/internal/es/index.typings.js +0 -2
  102. package/build/internal/es/index.typings.js.map +0 -1
  103. package/build/internal/es/meta.d.ts +0 -1
  104. package/build/internal/es/meta.js +0 -2
  105. package/build/internal/es/meta.js.map +0 -1
  106. package/build/internal/es/src/metroinspector-v1-product-products.context.d.ts +0 -14
  107. package/build/internal/es/src/metroinspector-v1-product-products.context.js +0 -14
  108. package/build/internal/es/src/metroinspector-v1-product-products.context.js.map +0 -1
  109. package/build/internal/es/src/metroinspector-v1-product-products.http.d.ts +0 -16
  110. package/build/internal/es/src/metroinspector-v1-product-products.http.js +0 -715
  111. package/build/internal/es/src/metroinspector-v1-product-products.http.js.map +0 -1
  112. package/build/internal/es/src/metroinspector-v1-product-products.meta.d.ts +0 -30
  113. package/build/internal/es/src/metroinspector-v1-product-products.meta.js +0 -182
  114. package/build/internal/es/src/metroinspector-v1-product-products.meta.js.map +0 -1
  115. package/build/internal/es/src/metroinspector-v1-product-products.public.d.ts +0 -68
  116. package/build/internal/es/src/metroinspector-v1-product-products.public.js +0 -54
  117. package/build/internal/es/src/metroinspector-v1-product-products.public.js.map +0 -1
  118. package/build/internal/es/src/metroinspector-v1-product-products.types.d.ts +0 -614
  119. package/build/internal/es/src/metroinspector-v1-product-products.types.js +0 -58
  120. package/build/internal/es/src/metroinspector-v1-product-products.types.js.map +0 -1
  121. package/build/internal/es/src/metroinspector-v1-product-products.universal.d.ts +0 -648
  122. package/build/internal/es/src/metroinspector-v1-product-products.universal.js +0 -703
  123. package/build/internal/es/src/metroinspector-v1-product-products.universal.js.map +0 -1
@@ -1,20 +1,35 @@
1
- export declare enum TextDetection {
2
- /** No detection was made */
3
- UNKNOWN_TEXT_DETECTION = "UNKNOWN_TEXT_DETECTION",
4
- /** The image contains text */
5
- CONTAINS_TEXT = "CONTAINS_TEXT",
6
- /** The image does not contain text */
7
- NO_TEXT = "NO_TEXT"
8
- }
9
- export declare enum AnimationDetection {
10
- /** No detection was made */
11
- UNKNOWN_ANIMATION_DETECTION = "UNKNOWN_ANIMATION_DETECTION",
12
- /** The image contains animation */
13
- CONTAINS_ANIMATION = "CONTAINS_ANIMATION",
14
- /** The image does not contain animation */
15
- NO_ANIMATION = "NO_ANIMATION"
16
- }
17
- export interface FocalPoint {
1
+ import { NonNullablePaths } from '@wix/sdk-types';
2
+
3
+ interface Product {
4
+ title?: string | null;
5
+ _id?: string;
6
+ collectionId?: string;
7
+ _createdDate?: Date | null;
8
+ modifiedDate?: Date | null;
9
+ image?: string;
10
+ address?: Address;
11
+ document?: string;
12
+ video?: string;
13
+ pageLink?: PageLink;
14
+ audio?: string;
15
+ /** @format COLOR_HEX */
16
+ color?: string | null;
17
+ /** @format LOCAL_DATE */
18
+ localDate?: string | null;
19
+ /** @format LOCAL_TIME */
20
+ localTime?: string | null;
21
+ /** @format LOCAL_DATE_TIME */
22
+ localDateTime?: string | null;
23
+ variants?: Variant[];
24
+ mainVariant?: Variant;
25
+ customAddress?: MyAddress;
26
+ /**
27
+ * @readonly
28
+ * @format GUID
29
+ */
30
+ guid?: string;
31
+ }
32
+ interface FocalPoint {
18
33
  /** X-coordinate of the focal point. */
19
34
  x?: number;
20
35
  /** Y-coordinate of the focal point. */
@@ -24,14 +39,8 @@ export interface FocalPoint {
24
39
  /** crop by width */
25
40
  width?: number | null;
26
41
  }
27
- export interface ImageContent {
28
- /** Text detection */
29
- text?: TextDetection;
30
- /** Animation detection */
31
- animation?: AnimationDetection;
32
- }
33
42
  /** Physical address */
34
- export interface Address extends AddressStreetOneOf {
43
+ interface Address extends AddressStreetOneOf {
35
44
  /** Street name and number. */
36
45
  streetAddress?: StreetAddress;
37
46
  /** Main address line, usually street and number as free text. */
@@ -51,31 +60,31 @@ export interface Address extends AddressStreetOneOf {
51
60
  addressLine2?: string | null;
52
61
  }
53
62
  /** @oneof */
54
- export interface AddressStreetOneOf {
63
+ interface AddressStreetOneOf {
55
64
  /** Street name and number. */
56
65
  streetAddress?: StreetAddress;
57
66
  /** Main address line, usually street and number as free text. */
58
67
  addressLine?: string | null;
59
68
  }
60
- export interface StreetAddress {
69
+ interface StreetAddress {
61
70
  /** Street number. */
62
71
  number?: string;
63
72
  /** Street name. */
64
73
  name?: string;
65
74
  }
66
- export interface AddressLocation {
75
+ interface AddressLocation {
67
76
  /** Address latitude. */
68
77
  latitude?: number | null;
69
78
  /** Address longitude. */
70
79
  longitude?: number | null;
71
80
  }
72
- export interface Subdivision {
81
+ interface Subdivision {
73
82
  /** Short subdivision code. */
74
83
  code?: string;
75
84
  /** Subdivision full name. */
76
85
  name?: string;
77
86
  }
78
- export declare enum SubdivisionType {
87
+ declare enum SubdivisionType {
79
88
  UNKNOWN_SUBDIVISION_TYPE = "UNKNOWN_SUBDIVISION_TYPE",
80
89
  /** State */
81
90
  ADMINISTRATIVE_AREA_LEVEL_1 = "ADMINISTRATIVE_AREA_LEVEL_1",
@@ -90,15 +99,17 @@ export declare enum SubdivisionType {
90
99
  /** ADMINISTRATIVE_AREA_LEVEL_0. Indicates the national political entity, and is typically the highest order type returned by the Geocoder. */
91
100
  COUNTRY = "COUNTRY"
92
101
  }
102
+ /** @enumType */
103
+ type SubdivisionTypeWithLiterals = SubdivisionType | 'UNKNOWN_SUBDIVISION_TYPE' | 'ADMINISTRATIVE_AREA_LEVEL_1' | 'ADMINISTRATIVE_AREA_LEVEL_2' | 'ADMINISTRATIVE_AREA_LEVEL_3' | 'ADMINISTRATIVE_AREA_LEVEL_4' | 'ADMINISTRATIVE_AREA_LEVEL_5' | 'COUNTRY';
93
104
  /** Subdivision Concordance values */
94
- export interface StandardDetails {
105
+ interface StandardDetails {
95
106
  /**
96
107
  * subdivision iso-3166-2 code according to [ISO 3166-2](https://en.wikipedia.org/wiki/ISO_3166-2). e.g. US-NY, GB-SCT, NO-30
97
108
  * @maxLength 20
98
109
  */
99
110
  iso31662?: string | null;
100
111
  }
101
- export interface VideoResolution {
112
+ interface VideoResolution {
102
113
  /** Video URL. */
103
114
  url?: string;
104
115
  /** Video height. */
@@ -108,7 +119,7 @@ export interface VideoResolution {
108
119
  /** Video format for example, mp4, hls. */
109
120
  format?: string;
110
121
  }
111
- export interface PageLink {
122
+ interface PageLink {
112
123
  /** The page id we want from the site */
113
124
  pageId?: string;
114
125
  /** Where this link should open, supports _self and _blank or any name the user chooses. _self means same page, _blank means new page. */
@@ -117,14 +128,14 @@ export interface PageLink {
117
128
  * rel of link
118
129
  * @maxSize 20
119
130
  */
120
- rel?: LinkRel[];
131
+ rel?: LinkRelWithLiterals[];
121
132
  }
122
133
  /**
123
134
  * The 'rel' attribute of the link. The rel attribute defines the relationship between a linked resource and the current document.
124
135
  * Further reading (also about different possible rel types): https://developer.mozilla.org/en-US/docs/Web/HTML/Attributes/rel
125
136
  * Following are the accepted 'rel' types by Wix applications.
126
137
  */
127
- export declare enum LinkRel {
138
+ declare enum LinkRel {
128
139
  /** default (not implemented) */
129
140
  unknown_link_rel = "unknown_link_rel",
130
141
  /** Indicates that the current document's original author or publisher does not endorse the referenced document. */
@@ -136,12 +147,14 @@ export declare enum LinkRel {
136
147
  /** Indicates a link that resulted from advertisements or paid placements. */
137
148
  sponsored = "sponsored"
138
149
  }
139
- export interface Variant {
150
+ /** @enumType */
151
+ type LinkRelWithLiterals = LinkRel | 'unknown_link_rel' | 'nofollow' | 'noopener' | 'noreferrer' | 'sponsored';
152
+ interface Variant {
140
153
  name?: string;
141
154
  value?: string;
142
155
  image?: string;
143
156
  }
144
- export interface MyAddress {
157
+ interface MyAddress {
145
158
  /** @format COUNTRY */
146
159
  country?: string | null;
147
160
  subdivision?: string | null;
@@ -149,33 +162,33 @@ export interface MyAddress {
149
162
  postalCode?: string | null;
150
163
  streetAddress?: StreetAddress;
151
164
  }
152
- export interface CreateProductRequest {
165
+ interface CreateProductRequest {
153
166
  product?: Product;
154
167
  }
155
- export interface CreateProductResponse {
168
+ interface CreateProductResponse {
156
169
  product?: Product;
157
170
  }
158
- export interface DeleteProductRequest {
171
+ interface DeleteProductRequest {
159
172
  productId: string;
160
173
  }
161
- export interface DeleteProductResponse {
174
+ interface DeleteProductResponse {
162
175
  }
163
- export interface UpdateProductRequest {
176
+ interface UpdateProductRequest {
164
177
  productId: string;
165
178
  product?: Product;
166
179
  /** Explicit list of fields to update. */
167
180
  mask?: string[];
168
181
  }
169
- export interface UpdateProductResponse {
182
+ interface UpdateProductResponse {
170
183
  product?: Product;
171
184
  }
172
- export interface GetProductRequest {
185
+ interface GetProductRequest {
173
186
  productId: string;
174
187
  }
175
- export interface GetProductResponse {
188
+ interface GetProductResponse {
176
189
  product?: Product;
177
190
  }
178
- export interface CountProductsRequest {
191
+ interface CountProductsRequest {
179
192
  filter?: Record<string, any> | null;
180
193
  /** Whether variants should be included in the response. */
181
194
  includeVariants?: boolean;
@@ -184,17 +197,17 @@ export interface CountProductsRequest {
184
197
  /** Whether merchant specific data should be included in the response. Requires permissions to manage products. */
185
198
  includeMerchantSpecificData?: boolean;
186
199
  }
187
- export interface CountProductsResponse {
200
+ interface CountProductsResponse {
188
201
  count?: number;
189
202
  }
190
- export interface GetProductsStartWithRequest {
203
+ interface GetProductsStartWithRequest {
191
204
  title: string;
192
205
  addressLine2?: string | null;
193
206
  }
194
- export interface GetProductsStartWithResponse {
207
+ interface GetProductsStartWithResponse {
195
208
  products?: Product[];
196
209
  }
197
- export interface QueryProductsRequest {
210
+ interface QueryProductsRequest {
198
211
  query?: QueryV2;
199
212
  /** Whether variants should be included in the response. */
200
213
  includeVariants?: boolean;
@@ -203,21 +216,21 @@ export interface QueryProductsRequest {
203
216
  /** Whether merchant specific data should be included in the response. Requires permissions to manage products. */
204
217
  includeMerchantSpecificData?: boolean;
205
218
  }
206
- export interface QueryV2 extends QueryV2PagingMethodOneOf {
207
- /** Paging options to limit and skip the number of items. */
219
+ interface QueryV2 extends QueryV2PagingMethodOneOf {
220
+ /** Paging options to limit and offset the number of items. */
208
221
  paging?: Paging;
209
222
  /** Cursor token pointing to a page of results. Not used in the first request. Following requests use the cursor token and not `filter` or `sort`. */
210
223
  cursorPaging?: CursorPaging;
211
224
  /**
212
225
  * Filter object.
213
226
  *
214
- * Learn more about the [filter section](https://dev.wix.com/docs/rest/articles/getting-started/api-query-language#the-filter-section).
227
+ * Learn more about [filtering](https://dev.wix.com/docs/rest/articles/getting-started/api-query-language#filters).
215
228
  */
216
229
  filter?: Record<string, any> | null;
217
230
  /**
218
231
  * Sort object.
219
232
  *
220
- * Learn more about the [sort section](https://dev.wix.com/docs/rest/articles/getting-started/api-query-language#the-sort-section).
233
+ * Learn more about [sorting](https://dev.wix.com/docs/rest/articles/getting-started/api-query-language#sorting).
221
234
  */
222
235
  sort?: Sorting[];
223
236
  /** Array of projected fields. A list of specific field names to return. If `fieldsets` are also specified, the union of `fieldsets` and `fields` is returned. */
@@ -226,32 +239,34 @@ export interface QueryV2 extends QueryV2PagingMethodOneOf {
226
239
  fieldsets?: string[];
227
240
  }
228
241
  /** @oneof */
229
- export interface QueryV2PagingMethodOneOf {
230
- /** Paging options to limit and skip the number of items. */
242
+ interface QueryV2PagingMethodOneOf {
243
+ /** Paging options to limit and offset the number of items. */
231
244
  paging?: Paging;
232
245
  /** Cursor token pointing to a page of results. Not used in the first request. Following requests use the cursor token and not `filter` or `sort`. */
233
246
  cursorPaging?: CursorPaging;
234
247
  }
235
- export interface Sorting {
248
+ interface Sorting {
236
249
  /**
237
250
  * Name of the field to sort by.
238
251
  * @maxLength 512
239
252
  */
240
253
  fieldName?: string;
241
254
  /** Sort order. */
242
- order?: SortOrder;
255
+ order?: SortOrderWithLiterals;
243
256
  }
244
- export declare enum SortOrder {
257
+ declare enum SortOrder {
245
258
  ASC = "ASC",
246
259
  DESC = "DESC"
247
260
  }
248
- export interface Paging {
261
+ /** @enumType */
262
+ type SortOrderWithLiterals = SortOrder | 'ASC' | 'DESC';
263
+ interface Paging {
249
264
  /** Number of items to load. */
250
265
  limit?: number | null;
251
266
  /** Number of items to skip in the current sort order. */
252
267
  offset?: number | null;
253
268
  }
254
- export interface CursorPaging {
269
+ interface CursorPaging {
255
270
  /**
256
271
  * Maximum number of items to return in the results.
257
272
  * @max 100
@@ -266,11 +281,11 @@ export interface CursorPaging {
266
281
  */
267
282
  cursor?: string | null;
268
283
  }
269
- export interface QueryProductsResponse {
284
+ interface QueryProductsResponse {
270
285
  products?: Product[];
271
286
  metadata?: PagingMetadataV2;
272
287
  }
273
- export interface PagingMetadataV2 {
288
+ interface PagingMetadataV2 {
274
289
  /** Number of items returned in the response. */
275
290
  count?: number | null;
276
291
  /** Offset that was requested. */
@@ -282,7 +297,7 @@ export interface PagingMetadataV2 {
282
297
  /** Cursors to navigate through the result pages using `next` and `prev`. Returned if cursor paging is used. */
283
298
  cursors?: Cursors;
284
299
  }
285
- export interface Cursors {
300
+ interface Cursors {
286
301
  /**
287
302
  * Cursor string pointing to the next page in the list of results.
288
303
  * @maxLength 16000
@@ -294,7 +309,7 @@ export interface Cursors {
294
309
  */
295
310
  prev?: string | null;
296
311
  }
297
- export interface BulkCreateProductsRequest {
312
+ interface BulkCreateProductsRequest {
298
313
  /**
299
314
  * @minSize 1
300
315
  * @maxSize 100
@@ -303,7 +318,7 @@ export interface BulkCreateProductsRequest {
303
318
  /** set to `true` if you wish to receive back the created products in the response */
304
319
  returnEntity?: boolean;
305
320
  }
306
- export interface BulkCreateProductsResponse {
321
+ interface BulkCreateProductsResponse {
307
322
  /**
308
323
  * @minSize 1
309
324
  * @maxSize 100
@@ -311,7 +326,7 @@ export interface BulkCreateProductsResponse {
311
326
  results?: BulkProductResult[];
312
327
  bulkActionMetadata?: BulkActionMetadata;
313
328
  }
314
- export interface ItemMetadata {
329
+ interface ItemMetadata {
315
330
  /** Item ID. Should always be available, unless it's impossible (for example, when failing to create an item). */
316
331
  _id?: string | null;
317
332
  /** Index of the item within the request array. Allows for correlation between request and response items. */
@@ -321,7 +336,7 @@ export interface ItemMetadata {
321
336
  /** Details about the error in case of failure. */
322
337
  error?: ApplicationError;
323
338
  }
324
- export interface ApplicationError {
339
+ interface ApplicationError {
325
340
  /** Error code. */
326
341
  code?: string;
327
342
  /** Description of the error. */
@@ -329,13 +344,13 @@ export interface ApplicationError {
329
344
  /** Data related to the error. */
330
345
  data?: Record<string, any> | null;
331
346
  }
332
- export interface BulkProductResult {
347
+ interface BulkProductResult {
333
348
  /** Defined in wix.commons */
334
349
  itemMetadata?: ItemMetadata;
335
350
  /** Only exists if `returnEntity` was set to true in the request */
336
351
  item?: Product;
337
352
  }
338
- export interface BulkActionMetadata {
353
+ interface BulkActionMetadata {
339
354
  /** Number of items that were successfully processed. */
340
355
  totalSuccesses?: number;
341
356
  /** Number of items that couldn't be processed. */
@@ -343,7 +358,7 @@ export interface BulkActionMetadata {
343
358
  /** Number of failures without details because detailed failure threshold was exceeded. */
344
359
  undetailedFailures?: number;
345
360
  }
346
- export interface BulkUpdateProductsRequest {
361
+ interface BulkUpdateProductsRequest {
347
362
  /**
348
363
  * @minSize 1
349
364
  * @maxSize 100
@@ -352,11 +367,11 @@ export interface BulkUpdateProductsRequest {
352
367
  /** set to `true` if you wish to receive back the updated products in the response */
353
368
  returnEntity?: boolean;
354
369
  }
355
- export interface MaskedProduct {
370
+ interface MaskedProduct {
356
371
  /** Product to be updated, may be partial */
357
372
  product?: Product;
358
373
  }
359
- export interface BulkUpdateProductsResponse {
374
+ interface BulkUpdateProductsResponse {
360
375
  /**
361
376
  * @minSize 1
362
377
  * @maxSize 100
@@ -364,12 +379,12 @@ export interface BulkUpdateProductsResponse {
364
379
  results?: BulkUpdateProductsResponseBulkProductResult[];
365
380
  bulkActionMetadata?: BulkActionMetadata;
366
381
  }
367
- export interface BulkUpdateProductsResponseBulkProductResult {
382
+ interface BulkUpdateProductsResponseBulkProductResult {
368
383
  itemMetadata?: ItemMetadata;
369
384
  /** Only exists if `returnEntity` was set to true in the request */
370
385
  item?: Product;
371
386
  }
372
- export interface BulkDeleteProductsRequest {
387
+ interface BulkDeleteProductsRequest {
373
388
  /**
374
389
  * @minSize 1
375
390
  * @maxSize 100
@@ -377,7 +392,7 @@ export interface BulkDeleteProductsRequest {
377
392
  */
378
393
  productIds: string[];
379
394
  }
380
- export interface BulkDeleteProductsResponse {
395
+ interface BulkDeleteProductsResponse {
381
396
  /**
382
397
  * @minSize 1
383
398
  * @maxSize 100
@@ -385,149 +400,43 @@ export interface BulkDeleteProductsResponse {
385
400
  results?: BulkDeleteProductsResponseBulkProductResult[];
386
401
  bulkActionMetadata?: BulkActionMetadata;
387
402
  }
388
- export interface BulkDeleteProductsResponseBulkProductResult {
403
+ interface BulkDeleteProductsResponseBulkProductResult {
389
404
  itemMetadata?: ItemMetadata;
390
405
  }
391
- export interface ResetProductsDbRequest {
406
+ interface ResetProductsDbRequest {
392
407
  }
393
- export interface ResetProductsDbResponse {
394
- }
395
- interface StreetAddressNonNullableFields {
396
- number: string;
397
- name: string;
398
- apt: string;
399
- }
400
- interface SubdivisionNonNullableFields {
401
- name: string;
402
- }
403
- interface AddressNonNullableFields {
404
- streetAddress?: StreetAddressNonNullableFields;
405
- subdivisions: SubdivisionNonNullableFields[];
406
- }
407
- interface PageLinkNonNullableFields {
408
- pageId: string;
409
- rel: LinkRel[];
410
- }
411
- interface VariantNonNullableFields {
412
- name: string;
413
- value: string;
414
- image: string;
415
- }
416
- interface MyAddressNonNullableFields {
417
- streetAddress?: StreetAddressNonNullableFields;
418
- }
419
- export interface ProductNonNullableFields {
420
- _id: string;
421
- collectionId: string;
422
- image: string;
423
- address?: AddressNonNullableFields;
424
- document: string;
425
- video: string;
426
- pageLink?: PageLinkNonNullableFields;
427
- audio: string;
428
- variants: VariantNonNullableFields[];
429
- mainVariant?: VariantNonNullableFields;
430
- customAddress?: MyAddressNonNullableFields;
431
- guid: string;
432
- }
433
- export interface CreateProductResponseNonNullableFields {
434
- product?: ProductNonNullableFields;
435
- }
436
- export interface UpdateProductResponseNonNullableFields {
437
- product?: ProductNonNullableFields;
438
- }
439
- export interface GetProductResponseNonNullableFields {
440
- product?: ProductNonNullableFields;
441
- }
442
- export interface CountProductsResponseNonNullableFields {
443
- count: number;
444
- }
445
- export interface GetProductsStartWithResponseNonNullableFields {
446
- products: ProductNonNullableFields[];
447
- }
448
- export interface QueryProductsResponseNonNullableFields {
449
- products: ProductNonNullableFields[];
450
- }
451
- interface ApplicationErrorNonNullableFields {
452
- code: string;
453
- description: string;
454
- }
455
- interface ItemMetadataNonNullableFields {
456
- originalIndex: number;
457
- success: boolean;
458
- error?: ApplicationErrorNonNullableFields;
459
- }
460
- interface BulkProductResultNonNullableFields {
461
- itemMetadata?: ItemMetadataNonNullableFields;
462
- item?: ProductNonNullableFields;
463
- }
464
- interface BulkActionMetadataNonNullableFields {
465
- totalSuccesses: number;
466
- totalFailures: number;
467
- undetailedFailures: number;
468
- }
469
- export interface BulkCreateProductsResponseNonNullableFields {
470
- results: BulkProductResultNonNullableFields[];
471
- bulkActionMetadata?: BulkActionMetadataNonNullableFields;
472
- }
473
- interface BulkUpdateProductsResponseBulkProductResultNonNullableFields {
474
- itemMetadata?: ItemMetadataNonNullableFields;
475
- item?: ProductNonNullableFields;
476
- }
477
- export interface BulkUpdateProductsResponseNonNullableFields {
478
- results: BulkUpdateProductsResponseBulkProductResultNonNullableFields[];
479
- bulkActionMetadata?: BulkActionMetadataNonNullableFields;
480
- }
481
- interface BulkDeleteProductsResponseBulkProductResultNonNullableFields {
482
- itemMetadata?: ItemMetadataNonNullableFields;
483
- }
484
- export interface BulkDeleteProductsResponseNonNullableFields {
485
- results: BulkDeleteProductsResponseBulkProductResultNonNullableFields[];
486
- bulkActionMetadata?: BulkActionMetadataNonNullableFields;
487
- }
488
- export interface Product {
489
- _id: string;
490
- name: string | null;
491
- collectionId: string;
492
- _createdDate: Date | null;
493
- modifiedDate: Date | null;
494
- image: string;
495
- address: Address;
496
- document: string;
497
- video: string;
498
- pageLink: PageLink;
499
- audio: string;
500
- color: string | null;
501
- localDate: string | null;
502
- localTime: string | null;
503
- localDateTime: string | null;
504
- variants: Variant[];
505
- mainVariant: Variant;
506
- customAddress: MyAddress;
507
- guid: string;
408
+ interface ResetProductsDbResponse {
508
409
  }
410
+ /** @docsIgnore */
411
+ type CreateProductApplicationErrors = {
412
+ code?: 'PRODUCT_EXISTS';
413
+ description?: string;
414
+ data?: Record<string, any>;
415
+ };
509
416
  /**
510
417
  * Creating a product
511
418
  * @public
512
419
  * @requiredField options.product.title
513
420
  * @fqn wix.coreservices.metroinspector.v1.products.ProductsService.CreateProduct
514
421
  */
515
- export declare function createProduct(options?: CreateProductOptions): Promise<Product & ProductNonNullableFields>;
516
- export interface CreateProductOptions {
422
+ declare function createProduct(options?: NonNullablePaths<CreateProductOptions, `product.title`, 3>): Promise<NonNullablePaths<Product, `_id` | `collectionId` | `address.streetAddress.number` | `address.streetAddress.name` | `pageLink.pageId` | `pageLink.rel` | `variants` | `variants.${number}.name` | `variants.${number}.value` | `guid`, 4> & {
423
+ __applicationErrorsType?: CreateProductApplicationErrors;
424
+ }>;
425
+ interface CreateProductOptions {
517
426
  product?: Product;
518
427
  }
519
428
  /** @public
520
429
  * @requiredField productId
521
430
  * @fqn wix.coreservices.metroinspector.v1.products.ProductsService.DeleteProduct
522
431
  */
523
- export declare function deleteProduct(productId: string): Promise<void>;
432
+ declare function deleteProduct(productId: string): Promise<void>;
524
433
  /** @public
525
434
  * @requiredField options.product._id
526
435
  * @requiredField productId
527
436
  * @fqn wix.coreservices.metroinspector.v1.products.ProductsService.UpdateProduct
528
437
  */
529
- export declare function updateProduct(productId: string, options?: UpdateProductOptions): Promise<Product & ProductNonNullableFields>;
530
- export interface UpdateProductOptions {
438
+ declare function updateProduct(productId: string, options?: NonNullablePaths<UpdateProductOptions, `product._id`, 3>): Promise<NonNullablePaths<Product, `_id` | `collectionId` | `address.streetAddress.number` | `address.streetAddress.name` | `pageLink.pageId` | `pageLink.rel` | `variants` | `variants.${number}.name` | `variants.${number}.value` | `guid`, 4>>;
439
+ interface UpdateProductOptions {
531
440
  product?: Product;
532
441
  /** Explicit list of fields to update. */
533
442
  mask?: string[];
@@ -540,12 +449,12 @@ export interface UpdateProductOptions {
540
449
  * @returns ## override return
541
450
  * @fqn wix.coreservices.metroinspector.v1.products.ProductsService.GetProduct
542
451
  */
543
- export declare function getProduct(productId: string): Promise<Product & ProductNonNullableFields>;
452
+ declare function getProduct(productId: string): Promise<NonNullablePaths<Product, `_id` | `collectionId` | `address.streetAddress.number` | `address.streetAddress.name` | `pageLink.pageId` | `pageLink.rel` | `variants` | `variants.${number}.name` | `variants.${number}.value` | `guid`, 4>>;
544
453
  /** @public
545
454
  * @fqn wix.coreservices.metroinspector.v1.products.ProductsService.CountProducts
546
455
  */
547
- export declare function countProducts(options?: CountProductsOptions): Promise<CountProductsResponse & CountProductsResponseNonNullableFields>;
548
- export interface CountProductsOptions {
456
+ declare function countProducts(options?: CountProductsOptions): Promise<NonNullablePaths<CountProductsResponse, `count`, 2>>;
457
+ interface CountProductsOptions {
549
458
  filter?: Record<string, any> | null;
550
459
  /** Whether variants should be included in the response. */
551
460
  includeVariants?: boolean;
@@ -558,15 +467,15 @@ export interface CountProductsOptions {
558
467
  * @requiredField title
559
468
  * @fqn wix.coreservices.metroinspector.v1.products.ProductsService.GetProductsStartWith
560
469
  */
561
- export declare function getProductsStartWith(title: string, options?: GetProductsStartWithOptions): Promise<GetProductsStartWithResponse & GetProductsStartWithResponseNonNullableFields>;
562
- export interface GetProductsStartWithOptions {
470
+ declare function getProductsStartWith(title: string, options?: GetProductsStartWithOptions): Promise<NonNullablePaths<GetProductsStartWithResponse, `products` | `products.${number}._id` | `products.${number}.collectionId` | `products.${number}.address.streetAddress.number` | `products.${number}.address.streetAddress.name` | `products.${number}.pageLink.pageId` | `products.${number}.guid`, 6>>;
471
+ interface GetProductsStartWithOptions {
563
472
  addressLine2?: string | null;
564
473
  }
565
474
  /** @public
566
475
  * @fqn wix.coreservices.metroinspector.v1.products.ProductsService.QueryProducts
567
476
  */
568
- export declare function queryProducts(options?: QueryProductsOptions): ProductsQueryBuilder;
569
- export interface QueryProductsOptions {
477
+ declare function queryProducts(options?: QueryProductsOptions): ProductsQueryBuilder;
478
+ interface QueryProductsOptions {
570
479
  /** Whether variants should be included in the response. */
571
480
  includeVariants?: boolean | undefined;
572
481
  /** Whether hidden products should be included in the response. Requires permissions to manage products. */
@@ -581,13 +490,13 @@ interface QueryCursorResult {
581
490
  length: number;
582
491
  pageSize: number;
583
492
  }
584
- export interface ProductsQueryResult extends QueryCursorResult {
493
+ interface ProductsQueryResult extends QueryCursorResult {
585
494
  items: Product[];
586
495
  query: ProductsQueryBuilder;
587
496
  next: () => Promise<ProductsQueryResult>;
588
497
  prev: () => Promise<ProductsQueryResult>;
589
498
  }
590
- export interface ProductsQueryBuilder {
499
+ interface ProductsQueryBuilder {
591
500
  /** @param propertyName - Property whose value is compared with `value`.
592
501
  * @param value - Value to compare against.
593
502
  */
@@ -596,6 +505,22 @@ export interface ProductsQueryBuilder {
596
505
  * @param value - Value to compare against.
597
506
  */
598
507
  ne: (propertyName: 'title' | 'guid', value: any) => ProductsQueryBuilder;
508
+ /** @param propertyName - Property whose value is compared with `value`.
509
+ * @param value - Value to compare against.
510
+ */
511
+ ge: (propertyName: 'title' | 'guid', value: any) => ProductsQueryBuilder;
512
+ /** @param propertyName - Property whose value is compared with `value`.
513
+ * @param value - Value to compare against.
514
+ */
515
+ gt: (propertyName: 'title' | 'guid', value: any) => ProductsQueryBuilder;
516
+ /** @param propertyName - Property whose value is compared with `value`.
517
+ * @param value - Value to compare against.
518
+ */
519
+ le: (propertyName: 'title' | 'guid', value: any) => ProductsQueryBuilder;
520
+ /** @param propertyName - Property whose value is compared with `value`.
521
+ * @param value - Value to compare against.
522
+ */
523
+ lt: (propertyName: 'title' | 'guid', value: any) => ProductsQueryBuilder;
599
524
  /** @param propertyName - Property whose value is compared with `string`.
600
525
  * @param string - String to compare against. Case-insensitive.
601
526
  */
@@ -622,8 +547,8 @@ export interface ProductsQueryBuilder {
622
547
  * @requiredField products
623
548
  * @fqn wix.coreservices.metroinspector.v1.products.ProductsService.BulkCreateProducts
624
549
  */
625
- export declare function bulkCreateProducts(products: Product[], options?: BulkCreateProductsOptions): Promise<BulkCreateProductsResponse & BulkCreateProductsResponseNonNullableFields>;
626
- export interface BulkCreateProductsOptions {
550
+ declare function bulkCreateProducts(products: Product[], options?: BulkCreateProductsOptions): Promise<NonNullablePaths<BulkCreateProductsResponse, `results` | `results.${number}.itemMetadata.originalIndex` | `results.${number}.itemMetadata.success` | `results.${number}.itemMetadata.error.code` | `results.${number}.itemMetadata.error.description` | `results.${number}.item._id` | `results.${number}.item.collectionId` | `results.${number}.item.pageLink.pageId` | `results.${number}.item.guid` | `bulkActionMetadata.totalSuccesses` | `bulkActionMetadata.totalFailures` | `bulkActionMetadata.undetailedFailures`, 6>>;
551
+ interface BulkCreateProductsOptions {
627
552
  /** set to `true` if you wish to receive back the created products in the response */
628
553
  returnEntity?: boolean;
629
554
  }
@@ -633,8 +558,8 @@ export interface BulkCreateProductsOptions {
633
558
  * @requiredField products
634
559
  * @fqn wix.coreservices.metroinspector.v1.products.ProductsService.BulkUpdateProducts
635
560
  */
636
- export declare function bulkUpdateProducts(products: MaskedProduct[], options?: BulkUpdateProductsOptions): Promise<BulkUpdateProductsResponse & BulkUpdateProductsResponseNonNullableFields>;
637
- export interface BulkUpdateProductsOptions {
561
+ declare function bulkUpdateProducts(products: MaskedProduct[], options?: BulkUpdateProductsOptions): Promise<NonNullablePaths<BulkUpdateProductsResponse, `results` | `results.${number}.itemMetadata.originalIndex` | `results.${number}.itemMetadata.success` | `results.${number}.itemMetadata.error.code` | `results.${number}.itemMetadata.error.description` | `results.${number}.item._id` | `results.${number}.item.collectionId` | `results.${number}.item.pageLink.pageId` | `results.${number}.item.guid` | `bulkActionMetadata.totalSuccesses` | `bulkActionMetadata.totalFailures` | `bulkActionMetadata.undetailedFailures`, 6>>;
562
+ interface BulkUpdateProductsOptions {
638
563
  /** set to `true` if you wish to receive back the updated products in the response */
639
564
  returnEntity?: boolean;
640
565
  }
@@ -644,5 +569,6 @@ export interface BulkUpdateProductsOptions {
644
569
  * @requiredField productIds
645
570
  * @fqn wix.coreservices.metroinspector.v1.products.ProductsService.BulkDeleteProducts
646
571
  */
647
- export declare function bulkDeleteProducts(productIds: string[]): Promise<BulkDeleteProductsResponse & BulkDeleteProductsResponseNonNullableFields>;
648
- export {};
572
+ declare function bulkDeleteProducts(productIds: string[]): Promise<NonNullablePaths<BulkDeleteProductsResponse, `results` | `results.${number}.itemMetadata.originalIndex` | `results.${number}.itemMetadata.success` | `results.${number}.itemMetadata.error.code` | `results.${number}.itemMetadata.error.description` | `bulkActionMetadata.totalSuccesses` | `bulkActionMetadata.totalFailures` | `bulkActionMetadata.undetailedFailures`, 6>>;
573
+
574
+ export { type Address, type AddressLocation, type AddressStreetOneOf, type ApplicationError, type BulkActionMetadata, type BulkCreateProductsOptions, type BulkCreateProductsRequest, type BulkCreateProductsResponse, type BulkDeleteProductsRequest, type BulkDeleteProductsResponse, type BulkDeleteProductsResponseBulkProductResult, type BulkProductResult, type BulkUpdateProductsOptions, type BulkUpdateProductsRequest, type BulkUpdateProductsResponse, type BulkUpdateProductsResponseBulkProductResult, type CountProductsOptions, type CountProductsRequest, type CountProductsResponse, type CreateProductApplicationErrors, type CreateProductOptions, type CreateProductRequest, type CreateProductResponse, type CursorPaging, type Cursors, type DeleteProductRequest, type DeleteProductResponse, type FocalPoint, type GetProductRequest, type GetProductResponse, type GetProductsStartWithOptions, type GetProductsStartWithRequest, type GetProductsStartWithResponse, type ItemMetadata, LinkRel, type LinkRelWithLiterals, type MaskedProduct, type MyAddress, type PageLink, type Paging, type PagingMetadataV2, type Product, type ProductsQueryBuilder, type ProductsQueryResult, type QueryProductsOptions, type QueryProductsRequest, type QueryProductsResponse, type QueryV2, type QueryV2PagingMethodOneOf, type ResetProductsDbRequest, type ResetProductsDbResponse, SortOrder, type SortOrderWithLiterals, type Sorting, type StandardDetails, type StreetAddress, type Subdivision, SubdivisionType, type SubdivisionTypeWithLiterals, type UpdateProductOptions, type UpdateProductRequest, type UpdateProductResponse, type Variant, type VideoResolution, bulkCreateProducts, bulkDeleteProducts, bulkUpdateProducts, countProducts, createProduct, deleteProduct, getProduct, getProductsStartWith, queryProducts, updateProduct };