@wix/motion 1.0.31 → 1.0.33

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 (115) hide show
  1. package/build/cjs/context.d.ts +3 -0
  2. package/build/cjs/{index.typings.js → context.js} +9 -5
  3. package/build/cjs/context.js.map +1 -0
  4. package/build/cjs/index.d.ts +3 -3
  5. package/build/cjs/index.js +8 -4
  6. package/build/cjs/index.js.map +1 -1
  7. package/build/cjs/meta.d.ts +3 -3
  8. package/build/cjs/meta.js +8 -4
  9. package/build/cjs/meta.js.map +1 -1
  10. package/build/es/context.d.ts +3 -0
  11. package/build/es/context.js +4 -0
  12. package/build/es/context.js.map +1 -0
  13. package/build/es/index.d.ts +3 -3
  14. package/build/es/index.js +3 -3
  15. package/build/es/index.js.map +1 -1
  16. package/build/es/meta.d.ts +3 -3
  17. package/build/es/meta.js +3 -3
  18. package/build/es/meta.js.map +1 -1
  19. package/context/package.json +6 -0
  20. package/package.json +15 -10
  21. package/build/cjs/index.typings.d.ts +0 -3
  22. package/build/cjs/index.typings.js.map +0 -1
  23. package/build/cjs/src/alarm-v1-alarm.http.d.ts +0 -6
  24. package/build/cjs/src/alarm-v1-alarm.http.js +0 -105
  25. package/build/cjs/src/alarm-v1-alarm.http.js.map +0 -1
  26. package/build/cjs/src/alarm-v1-alarm.meta.d.ts +0 -18
  27. package/build/cjs/src/alarm-v1-alarm.meta.js +0 -62
  28. package/build/cjs/src/alarm-v1-alarm.meta.js.map +0 -1
  29. package/build/cjs/src/alarm-v1-alarm.public.d.ts +0 -8
  30. package/build/cjs/src/alarm-v1-alarm.public.js +0 -18
  31. package/build/cjs/src/alarm-v1-alarm.public.js.map +0 -1
  32. package/build/cjs/src/alarm-v1-alarm.types.d.ts +0 -37
  33. package/build/cjs/src/alarm-v1-alarm.types.js +0 -3
  34. package/build/cjs/src/alarm-v1-alarm.types.js.map +0 -1
  35. package/build/cjs/src/alarm-v1-alarm.universal.d.ts +0 -65
  36. package/build/cjs/src/alarm-v1-alarm.universal.js +0 -159
  37. package/build/cjs/src/alarm-v1-alarm.universal.js.map +0 -1
  38. package/build/cjs/src/metroinspector-v1-echo.http.d.ts +0 -4
  39. package/build/cjs/src/metroinspector-v1-echo.http.js +0 -79
  40. package/build/cjs/src/metroinspector-v1-echo.http.js.map +0 -1
  41. package/build/cjs/src/metroinspector-v1-echo.meta.d.ts +0 -15
  42. package/build/cjs/src/metroinspector-v1-echo.meta.js +0 -43
  43. package/build/cjs/src/metroinspector-v1-echo.meta.js.map +0 -1
  44. package/build/cjs/src/metroinspector-v1-echo.public.d.ts +0 -7
  45. package/build/cjs/src/metroinspector-v1-echo.public.js +0 -12
  46. package/build/cjs/src/metroinspector-v1-echo.public.js.map +0 -1
  47. package/build/cjs/src/metroinspector-v1-echo.types.d.ts +0 -44
  48. package/build/cjs/src/metroinspector-v1-echo.types.js +0 -3
  49. package/build/cjs/src/metroinspector-v1-echo.types.js.map +0 -1
  50. package/build/cjs/src/metroinspector-v1-echo.universal.d.ts +0 -65
  51. package/build/cjs/src/metroinspector-v1-echo.universal.js +0 -111
  52. package/build/cjs/src/metroinspector-v1-echo.universal.js.map +0 -1
  53. package/build/cjs/src/metroinspector-v1-product.http.d.ts +0 -9
  54. package/build/cjs/src/metroinspector-v1-product.http.js +0 -314
  55. package/build/cjs/src/metroinspector-v1-product.http.js.map +0 -1
  56. package/build/cjs/src/metroinspector-v1-product.meta.d.ts +0 -26
  57. package/build/cjs/src/metroinspector-v1-product.meta.js +0 -138
  58. package/build/cjs/src/metroinspector-v1-product.meta.js.map +0 -1
  59. package/build/cjs/src/metroinspector-v1-product.public.d.ts +0 -76
  60. package/build/cjs/src/metroinspector-v1-product.public.js +0 -45
  61. package/build/cjs/src/metroinspector-v1-product.public.js.map +0 -1
  62. package/build/cjs/src/metroinspector-v1-product.types.d.ts +0 -731
  63. package/build/cjs/src/metroinspector-v1-product.types.js +0 -25
  64. package/build/cjs/src/metroinspector-v1-product.types.js.map +0 -1
  65. package/build/cjs/src/metroinspector-v1-product.universal.d.ts +0 -494
  66. package/build/cjs/src/metroinspector-v1-product.universal.js +0 -442
  67. package/build/cjs/src/metroinspector-v1-product.universal.js.map +0 -1
  68. package/build/es/index.typings.d.ts +0 -3
  69. package/build/es/index.typings.js +0 -4
  70. package/build/es/index.typings.js.map +0 -1
  71. package/build/es/src/alarm-v1-alarm.http.d.ts +0 -6
  72. package/build/es/src/alarm-v1-alarm.http.js +0 -100
  73. package/build/es/src/alarm-v1-alarm.http.js.map +0 -1
  74. package/build/es/src/alarm-v1-alarm.meta.d.ts +0 -18
  75. package/build/es/src/alarm-v1-alarm.meta.js +0 -38
  76. package/build/es/src/alarm-v1-alarm.meta.js.map +0 -1
  77. package/build/es/src/alarm-v1-alarm.public.d.ts +0 -8
  78. package/build/es/src/alarm-v1-alarm.public.js +0 -13
  79. package/build/es/src/alarm-v1-alarm.public.js.map +0 -1
  80. package/build/es/src/alarm-v1-alarm.types.d.ts +0 -37
  81. package/build/es/src/alarm-v1-alarm.types.js +0 -2
  82. package/build/es/src/alarm-v1-alarm.types.js.map +0 -1
  83. package/build/es/src/alarm-v1-alarm.universal.d.ts +0 -65
  84. package/build/es/src/alarm-v1-alarm.universal.js +0 -135
  85. package/build/es/src/alarm-v1-alarm.universal.js.map +0 -1
  86. package/build/es/src/metroinspector-v1-echo.http.d.ts +0 -4
  87. package/build/es/src/metroinspector-v1-echo.http.js +0 -75
  88. package/build/es/src/metroinspector-v1-echo.http.js.map +0 -1
  89. package/build/es/src/metroinspector-v1-echo.meta.d.ts +0 -15
  90. package/build/es/src/metroinspector-v1-echo.meta.js +0 -20
  91. package/build/es/src/metroinspector-v1-echo.meta.js.map +0 -1
  92. package/build/es/src/metroinspector-v1-echo.public.d.ts +0 -7
  93. package/build/es/src/metroinspector-v1-echo.public.js +0 -8
  94. package/build/es/src/metroinspector-v1-echo.public.js.map +0 -1
  95. package/build/es/src/metroinspector-v1-echo.types.d.ts +0 -44
  96. package/build/es/src/metroinspector-v1-echo.types.js +0 -2
  97. package/build/es/src/metroinspector-v1-echo.types.js.map +0 -1
  98. package/build/es/src/metroinspector-v1-echo.universal.d.ts +0 -65
  99. package/build/es/src/metroinspector-v1-echo.universal.js +0 -88
  100. package/build/es/src/metroinspector-v1-echo.universal.js.map +0 -1
  101. package/build/es/src/metroinspector-v1-product.http.d.ts +0 -9
  102. package/build/es/src/metroinspector-v1-product.http.js +0 -305
  103. package/build/es/src/metroinspector-v1-product.http.js.map +0 -1
  104. package/build/es/src/metroinspector-v1-product.meta.d.ts +0 -26
  105. package/build/es/src/metroinspector-v1-product.meta.js +0 -110
  106. package/build/es/src/metroinspector-v1-product.meta.js.map +0 -1
  107. package/build/es/src/metroinspector-v1-product.public.d.ts +0 -76
  108. package/build/es/src/metroinspector-v1-product.public.js +0 -34
  109. package/build/es/src/metroinspector-v1-product.public.js.map +0 -1
  110. package/build/es/src/metroinspector-v1-product.types.d.ts +0 -731
  111. package/build/es/src/metroinspector-v1-product.types.js +0 -22
  112. package/build/es/src/metroinspector-v1-product.types.js.map +0 -1
  113. package/build/es/src/metroinspector-v1-product.universal.d.ts +0 -494
  114. package/build/es/src/metroinspector-v1-product.universal.js +0 -414
  115. package/build/es/src/metroinspector-v1-product.universal.js.map +0 -1
@@ -1,22 +0,0 @@
1
- export var SubdivisionType;
2
- (function (SubdivisionType) {
3
- SubdivisionType["UNKNOWN_SUBDIVISION_TYPE"] = "UNKNOWN_SUBDIVISION_TYPE";
4
- /** State */
5
- SubdivisionType["ADMINISTRATIVE_AREA_LEVEL_1"] = "ADMINISTRATIVE_AREA_LEVEL_1";
6
- /** County */
7
- SubdivisionType["ADMINISTRATIVE_AREA_LEVEL_2"] = "ADMINISTRATIVE_AREA_LEVEL_2";
8
- /** City/town */
9
- SubdivisionType["ADMINISTRATIVE_AREA_LEVEL_3"] = "ADMINISTRATIVE_AREA_LEVEL_3";
10
- /** Neighborhood/quarter */
11
- SubdivisionType["ADMINISTRATIVE_AREA_LEVEL_4"] = "ADMINISTRATIVE_AREA_LEVEL_4";
12
- /** Street/block */
13
- SubdivisionType["ADMINISTRATIVE_AREA_LEVEL_5"] = "ADMINISTRATIVE_AREA_LEVEL_5";
14
- /** ADMINISTRATIVE_AREA_LEVEL_0. Indicates the national political entity, and is typically the highest order type returned by the Geocoder. */
15
- SubdivisionType["COUNTRY"] = "COUNTRY";
16
- })(SubdivisionType || (SubdivisionType = {}));
17
- export var SortOrder;
18
- (function (SortOrder) {
19
- SortOrder["ASC"] = "ASC";
20
- SortOrder["DESC"] = "DESC";
21
- })(SortOrder || (SortOrder = {}));
22
- //# sourceMappingURL=metroinspector-v1-product.types.js.map
@@ -1 +0,0 @@
1
- {"version":3,"file":"metroinspector-v1-product.types.js","sourceRoot":"","sources":["../../../src/metroinspector-v1-product.types.ts"],"names":[],"mappings":"AA8FA,MAAM,CAAN,IAAY,eAcX;AAdD,WAAY,eAAe;IACzB,wEAAqD,CAAA;IACrD,YAAY;IACZ,8EAA2D,CAAA;IAC3D,aAAa;IACb,8EAA2D,CAAA;IAC3D,gBAAgB;IAChB,8EAA2D,CAAA;IAC3D,2BAA2B;IAC3B,8EAA2D,CAAA;IAC3D,mBAAmB;IACnB,8EAA2D,CAAA;IAC3D,8IAA8I;IAC9I,sCAAmB,CAAA;AACrB,CAAC,EAdW,eAAe,KAAf,eAAe,QAc1B;AAkKD,MAAM,CAAN,IAAY,SAGX;AAHD,WAAY,SAAS;IACnB,wBAAW,CAAA;IACX,0BAAa,CAAA;AACf,CAAC,EAHW,SAAS,KAAT,SAAS,QAGpB"}
@@ -1,494 +0,0 @@
1
- export declare const __debug: {
2
- verboseLogging: {
3
- on: () => boolean;
4
- off: () => boolean;
5
- };
6
- };
7
- /** Physical address */
8
- export interface Address extends AddressStreetOneOf {
9
- /** Street name and number. */
10
- streetAddress?: StreetAddress;
11
- /** Main address line, usually street and number as free text. */
12
- addressLine1?: string | null;
13
- /** Country code. */
14
- country?: string | null;
15
- /** Subdivision. Usually a state, region, prefecture, or province code, according to [ISO 3166-2](https://en.wikipedia.org/wiki/ISO_3166-2). */
16
- subdivision?: string | null;
17
- /** City name. */
18
- city?: string | null;
19
- /** Zip/postal code. */
20
- postalCode?: string | null;
21
- /** Free text providing more detailed address info. Usually contains Apt, Suite, and Floor. */
22
- addressLine2?: string | null;
23
- }
24
- /** @oneof */
25
- export interface AddressStreetOneOf {
26
- /** Street name and number. */
27
- streetAddress?: StreetAddress;
28
- /** Main address line, usually street and number as free text. */
29
- addressLine?: string | null;
30
- }
31
- export interface StreetAddress {
32
- /** Street number. */
33
- number?: string;
34
- /** Street name. */
35
- name?: string;
36
- }
37
- export interface AddressLocation {
38
- /** Address latitude. */
39
- latitude?: number | null;
40
- /** Address longitude. */
41
- longitude?: number | null;
42
- }
43
- export interface Subdivision {
44
- /** Short subdivision code. */
45
- code?: string;
46
- /** Subdivision full name. */
47
- name?: string;
48
- }
49
- export declare enum SubdivisionType {
50
- UNKNOWN_SUBDIVISION_TYPE = "UNKNOWN_SUBDIVISION_TYPE",
51
- /** State */
52
- ADMINISTRATIVE_AREA_LEVEL_1 = "ADMINISTRATIVE_AREA_LEVEL_1",
53
- /** County */
54
- ADMINISTRATIVE_AREA_LEVEL_2 = "ADMINISTRATIVE_AREA_LEVEL_2",
55
- /** City/town */
56
- ADMINISTRATIVE_AREA_LEVEL_3 = "ADMINISTRATIVE_AREA_LEVEL_3",
57
- /** Neighborhood/quarter */
58
- ADMINISTRATIVE_AREA_LEVEL_4 = "ADMINISTRATIVE_AREA_LEVEL_4",
59
- /** Street/block */
60
- ADMINISTRATIVE_AREA_LEVEL_5 = "ADMINISTRATIVE_AREA_LEVEL_5",
61
- /** ADMINISTRATIVE_AREA_LEVEL_0. Indicates the national political entity, and is typically the highest order type returned by the Geocoder. */
62
- COUNTRY = "COUNTRY"
63
- }
64
- export interface VideoResolution {
65
- /** Video URL. */
66
- url?: string;
67
- /** Video height. */
68
- height?: number;
69
- /** Video width. */
70
- width?: number;
71
- /** Video format for example, mp4, hls. */
72
- format?: string;
73
- }
74
- export interface PageLink {
75
- /** The page id we want from the site */
76
- pageId?: string;
77
- /** Where this link should open, supports _self and _blank or any name the user chooses. _self means same page, _blank means new page. */
78
- target?: string | null;
79
- }
80
- export interface Variant {
81
- name?: string;
82
- value?: string;
83
- image?: string;
84
- }
85
- export interface MyAddress {
86
- country?: string | null;
87
- subdivision?: string | null;
88
- city?: string | null;
89
- postalCode?: string | null;
90
- streetAddress?: StreetAddress;
91
- }
92
- export interface CreateProductRequest {
93
- product?: Product;
94
- }
95
- export interface CreateProductResponse {
96
- product?: Product;
97
- }
98
- export interface DeleteProductRequest {
99
- productId: string;
100
- }
101
- export interface DeleteProductResponse {
102
- }
103
- export interface UpdateProductRequest {
104
- productId: string;
105
- product?: Product;
106
- /** Explicit list of fields to update. */
107
- mask?: string[];
108
- }
109
- export interface UpdateProductResponse {
110
- product?: Product;
111
- }
112
- export interface GetProductRequest {
113
- productId: string;
114
- }
115
- export interface GetProductResponse {
116
- product?: Product;
117
- }
118
- export interface GetProductsStartWithRequest {
119
- title: string;
120
- addressLine2?: string | null;
121
- }
122
- export interface GetProductsStartWithResponse {
123
- products?: Product[];
124
- }
125
- export interface QueryProductsRequest {
126
- query?: QueryV2;
127
- /** Whether variants should be included in the response. */
128
- includeVariants?: boolean;
129
- /** Whether hidden products should be included in the response. Requires permissions to manage products. */
130
- includeHiddenProducts?: boolean;
131
- /** Whether merchant specific data should be included in the response. Requires permissions to manage products. */
132
- includeMerchantSpecificData?: boolean;
133
- }
134
- export interface QueryV2 extends QueryV2PagingMethodOneOf {
135
- /** Paging options to limit and skip the number of items. */
136
- paging?: Paging;
137
- /** 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`. */
138
- cursorPaging?: CursorPaging;
139
- /**
140
- * Filter object in the following format:
141
- * `"filter" : {
142
- * "fieldName1": "value1",
143
- * "fieldName2":{"$operator":"value2"}
144
- * }`
145
- * Example of operators: `$eq`, `$ne`, `$lt`, `$lte`, `$gt`, `$gte`, `$in`, `$hasSome`, `$hasAll`, `$startsWith`, `$contains`
146
- */
147
- filter?: Record<string, any> | null;
148
- /**
149
- * Sort object in the following format:
150
- * `[{"fieldName":"sortField1","order":"ASC"},{"fieldName":"sortField2","order":"DESC"}]`
151
- */
152
- sort?: Sorting[];
153
- /** 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. */
154
- fields?: string[];
155
- /** Array of named, predefined sets of projected fields. A array of predefined named sets of fields to be returned. Specifying multiple `fieldsets` will return the union of fields from all sets. If `fields` are also specified, the union of `fieldsets` and `fields` is returned. */
156
- fieldsets?: string[];
157
- }
158
- /** @oneof */
159
- export interface QueryV2PagingMethodOneOf {
160
- /** Paging options to limit and skip the number of items. */
161
- paging?: Paging;
162
- /** 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`. */
163
- cursorPaging?: CursorPaging;
164
- }
165
- export interface Sorting {
166
- /** Name of the field to sort by. */
167
- fieldName?: string;
168
- /** Sort order. */
169
- order?: SortOrder;
170
- }
171
- export declare enum SortOrder {
172
- ASC = "ASC",
173
- DESC = "DESC"
174
- }
175
- export interface Paging {
176
- /** Number of items to load. */
177
- limit?: number | null;
178
- /** Number of items to skip in the current sort order. */
179
- offset?: number | null;
180
- }
181
- export interface CursorPaging {
182
- /** Number of items to load. */
183
- limit?: number | null;
184
- /**
185
- * Pointer to the next or previous page in the list of results.
186
- *
187
- * You can get the relevant cursor token
188
- * from the `pagingMetadata` object in the previous call's response.
189
- * Not relevant for the first request.
190
- */
191
- cursor?: string | null;
192
- }
193
- export interface QueryProductsResponse {
194
- products?: Product[];
195
- metadata?: PagingMetadataV2;
196
- }
197
- export interface PagingMetadataV2 {
198
- /** Number of items returned in the response. */
199
- count?: number | null;
200
- /** Offset that was requested. */
201
- offset?: number | null;
202
- /** Total number of items that match the query. Returned if offset paging is used and the `tooManyToCount` flag is not set. */
203
- total?: number | null;
204
- /** Flag that indicates the server failed to calculate the `total` field. */
205
- tooManyToCount?: boolean | null;
206
- /** Cursors to navigate through the result pages using `next` and `prev`. Returned if cursor paging is used. */
207
- cursors?: Cursors;
208
- }
209
- export interface Cursors {
210
- /** Cursor pointing to next page in the list of results. */
211
- next?: string | null;
212
- /** Cursor pointing to previous page in the list of results. */
213
- prev?: string | null;
214
- }
215
- export interface CreateProductRequestRequiredFields {
216
- product?: {
217
- title: string;
218
- };
219
- }
220
- export interface CreateProductResponseNonNullableFields {
221
- product?: {
222
- _id: string;
223
- collectionId: string;
224
- image: string;
225
- document: string;
226
- video: string;
227
- pageLink?: {
228
- pageId: string;
229
- };
230
- audio: string;
231
- variants: {
232
- name: string;
233
- value: string;
234
- image: string;
235
- }[];
236
- mainVariant?: {
237
- name: string;
238
- value: string;
239
- image: string;
240
- };
241
- guid: string;
242
- };
243
- }
244
- export interface DeleteProductRequestRequiredFields {
245
- productId: string;
246
- }
247
- export interface UpdateProductRequestRequiredFields {
248
- product?: {
249
- _id: string;
250
- };
251
- productId: string;
252
- }
253
- export interface UpdateProductResponseNonNullableFields {
254
- product?: {
255
- _id: string;
256
- collectionId: string;
257
- image: string;
258
- document: string;
259
- video: string;
260
- pageLink?: {
261
- pageId: string;
262
- };
263
- audio: string;
264
- variants: {
265
- name: string;
266
- value: string;
267
- image: string;
268
- }[];
269
- mainVariant?: {
270
- name: string;
271
- value: string;
272
- image: string;
273
- };
274
- guid: string;
275
- };
276
- }
277
- export interface GetProductRequestRequiredFields {
278
- productId: string;
279
- }
280
- export interface GetProductResponseNonNullableFields {
281
- product?: {
282
- _id: string;
283
- collectionId: string;
284
- image: string;
285
- document: string;
286
- video: string;
287
- pageLink?: {
288
- pageId: string;
289
- };
290
- audio: string;
291
- variants: {
292
- name: string;
293
- value: string;
294
- image: string;
295
- }[];
296
- mainVariant?: {
297
- name: string;
298
- value: string;
299
- image: string;
300
- };
301
- guid: string;
302
- };
303
- }
304
- export interface GetProductsStartWithRequestRequiredFields {
305
- title: string;
306
- }
307
- export interface GetProductsStartWithResponseNonNullableFields {
308
- products: {
309
- _id: string;
310
- collectionId: string;
311
- image: string;
312
- document: string;
313
- video: string;
314
- pageLink?: {
315
- pageId: string;
316
- };
317
- audio: string;
318
- variants: {
319
- name: string;
320
- value: string;
321
- image: string;
322
- }[];
323
- mainVariant?: {
324
- name: string;
325
- value: string;
326
- image: string;
327
- };
328
- guid: string;
329
- }[];
330
- }
331
- export interface QueryProductsResponseNonNullableFields {
332
- products: {
333
- _id: string;
334
- collectionId: string;
335
- image: string;
336
- document: string;
337
- video: string;
338
- pageLink?: {
339
- pageId: string;
340
- };
341
- audio: string;
342
- variants: {
343
- name: string;
344
- value: string;
345
- image: string;
346
- }[];
347
- mainVariant?: {
348
- name: string;
349
- value: string;
350
- image: string;
351
- };
352
- guid: string;
353
- }[];
354
- }
355
- export interface Product {
356
- _id: string;
357
- name: string | null;
358
- collectionId: string;
359
- _createdDate: Date;
360
- modifiedDate: Date;
361
- image: string;
362
- address: Address;
363
- document: string;
364
- video: string;
365
- pageLink: PageLink;
366
- audio: string;
367
- color: string | null;
368
- localDate: string | null;
369
- localTime: string | null;
370
- localDateTime: string | null;
371
- variants: Variant[];
372
- mainVariant: Variant;
373
- customAddress: MyAddress;
374
- guid: string;
375
- }
376
- /**
377
- * Creating a product
378
- * @public
379
- * @documentationMaturity preview
380
- * @requiredField options.product.title
381
- */
382
- export declare function createProduct(options?: CreateProductOptions & CreateProductOptionsRequiredFields): Promise<Product & NonNullable<CreateProductResponseNonNullableFields>['product']>;
383
- export interface CreateProductOptionsRequiredFields {
384
- product?: {
385
- title: unknown;
386
- };
387
- }
388
- export interface CreateProductOptions {
389
- product?: Product;
390
- }
391
- /** @public
392
- * @documentationMaturity preview
393
- * @requiredField productId
394
- */
395
- export declare function deleteProduct(productId: string): Promise<void>;
396
- /** @public
397
- * @documentationMaturity preview
398
- * @requiredField options.product._id
399
- * @requiredField productId
400
- */
401
- export declare function updateProduct(productId: string, options?: UpdateProductOptions & UpdateProductOptionsRequiredFields): Promise<Product & NonNullable<UpdateProductResponseNonNullableFields>['product']>;
402
- export interface UpdateProductOptionsRequiredFields {
403
- product?: {
404
- _id: string;
405
- };
406
- }
407
- export interface UpdateProductOptions {
408
- product?: Product;
409
- /** Explicit list of fields to update. */
410
- mask?: string[];
411
- }
412
- /** @public
413
- * @documentationMaturity preview
414
- * @requiredField productId
415
- */
416
- export declare function getProduct(productId: string): Promise<Product & NonNullable<GetProductResponseNonNullableFields>['product']>;
417
- /** @public
418
- * @documentationMaturity preview
419
- * @requiredField title
420
- */
421
- export declare function getProductsStartWith(title: string, options?: GetProductsStartWithOptions): Promise<GetProductsStartWithResponse & GetProductsStartWithResponseNonNullableFields>;
422
- export interface GetProductsStartWithOptions {
423
- addressLine2?: string | null;
424
- }
425
- /** @public
426
- * @documentationMaturity preview
427
- */
428
- export declare function queryProducts(options?: QueryProductsOptions): ProductsQueryBuilder;
429
- export interface QueryProductsOptions {
430
- /** Whether variants should be included in the response. */
431
- includeVariants?: boolean | undefined;
432
- /** Whether hidden products should be included in the response. Requires permissions to manage products. */
433
- includeHiddenProducts?: boolean | undefined;
434
- /** Whether merchant specific data should be included in the response. Requires permissions to manage products. */
435
- includeMerchantSpecificData?: boolean | undefined;
436
- }
437
- interface QueryCursorResult {
438
- cursors: Cursors;
439
- hasNext: () => boolean;
440
- hasPrev: () => boolean;
441
- length: number;
442
- pageSize: number;
443
- }
444
- export interface ProductsQueryResult extends QueryCursorResult {
445
- items: Product[];
446
- query: ProductsQueryBuilder;
447
- next: () => Promise<ProductsQueryResult>;
448
- prev: () => Promise<ProductsQueryResult>;
449
- }
450
- export interface ProductsQueryBuilder {
451
- /** @param propertyName - Property whose value is compared with `value`.
452
- * @param value - Value to compare against.
453
- * @documentationMaturity preview
454
- */
455
- eq: (propertyName: 'title' | 'collectionId' | 'guid', value: any) => ProductsQueryBuilder;
456
- /** @param propertyName - Property whose value is compared with `value`.
457
- * @param value - Value to compare against.
458
- * @documentationMaturity preview
459
- */
460
- ne: (propertyName: 'title' | 'guid', value: any) => ProductsQueryBuilder;
461
- /** @param propertyName - Property whose value is compared with `string`.
462
- * @param string - String to compare against. Case-insensitive.
463
- * @documentationMaturity preview
464
- */
465
- startsWith: (propertyName: 'title' | 'guid', value: string) => ProductsQueryBuilder;
466
- /** @param propertyName - Property whose value is compared with `values`.
467
- * @param values - List of values to compare against.
468
- * @documentationMaturity preview
469
- */
470
- hasSome: (propertyName: 'title' | 'guid', value: any[]) => ProductsQueryBuilder;
471
- /** @documentationMaturity preview */
472
- in: (propertyName: 'title' | 'guid', value: any) => ProductsQueryBuilder;
473
- /** @documentationMaturity preview */
474
- exists: (propertyName: 'title' | 'guid', value: boolean) => ProductsQueryBuilder;
475
- /** @param propertyNames - Properties used in the sort. To sort by multiple properties, pass properties as additional arguments.
476
- * @documentationMaturity preview
477
- */
478
- ascending: (...propertyNames: Array<'title' | 'collectionId' | 'guid'>) => ProductsQueryBuilder;
479
- /** @param propertyNames - Properties used in the sort. To sort by multiple properties, pass properties as additional arguments.
480
- * @documentationMaturity preview
481
- */
482
- descending: (...propertyNames: Array<'title' | 'collectionId' | 'guid'>) => ProductsQueryBuilder;
483
- /** @param limit - Number of items to return, which is also the `pageSize` of the results object.
484
- * @documentationMaturity preview
485
- */
486
- limit: (limit: number) => ProductsQueryBuilder;
487
- /** @param cursor - A pointer to specific record
488
- * @documentationMaturity preview
489
- */
490
- skipTo: (cursor: string) => ProductsQueryBuilder;
491
- /** @documentationMaturity preview */
492
- find: () => Promise<ProductsQueryResult>;
493
- }
494
- export {};