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