@wix/motion 1.0.65 → 1.0.66

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.
@@ -1,1086 +0,0 @@
1
- interface AlarmMessage$1 {
2
- id?: string;
3
- seconds?: number;
4
- }
5
- interface AlarmTestRequest$1 {
6
- }
7
- interface AlarmTestResponse$1 {
8
- }
9
- interface AlarmRequest$1 {
10
- seconds: number;
11
- someString?: string;
12
- someOtherString?: string;
13
- someOtherField?: string;
14
- }
15
- interface AlarmResponse$1 {
16
- time?: Date | null;
17
- }
18
- interface UpdateAlarmRequest$1 {
19
- alarm: AlarmMessage$1;
20
- }
21
- interface UpdateAlarmResponse$1 {
22
- alarm?: AlarmMessage$1;
23
- }
24
- interface AlarmMessageNonNullableFields$1 {
25
- id: string;
26
- seconds: number;
27
- }
28
- interface UpdateAlarmResponseNonNullableFields$1 {
29
- alarm?: AlarmMessageNonNullableFields$1;
30
- }
31
-
32
- interface AlarmMessage {
33
- _id?: string;
34
- seconds?: number;
35
- }
36
- interface AlarmTestRequest {
37
- }
38
- interface AlarmTestResponse {
39
- }
40
- interface AlarmRequest {
41
- seconds: number;
42
- someString?: string;
43
- someOtherString?: string;
44
- someOtherField?: string;
45
- }
46
- interface AlarmResponse {
47
- time?: Date | null;
48
- }
49
- interface UpdateAlarmRequest {
50
- alarm: AlarmMessage;
51
- }
52
- interface UpdateAlarmResponse {
53
- alarm?: AlarmMessage;
54
- }
55
- interface AlarmMessageNonNullableFields {
56
- _id: string;
57
- seconds: number;
58
- }
59
- interface UpdateAlarmResponseNonNullableFields {
60
- alarm?: AlarmMessageNonNullableFields;
61
- }
62
-
63
- type __PublicMethodMetaInfo$2<K = string, M = unknown, T = unknown, S = unknown, Q = unknown, R = unknown> = {
64
- getUrl: (context: any) => string;
65
- httpMethod: K;
66
- path: string;
67
- pathParams: M;
68
- __requestType: T;
69
- __originalRequestType: S;
70
- __responseType: Q;
71
- __originalResponseType: R;
72
- };
73
- declare function alarmTest(): __PublicMethodMetaInfo$2<'POST', {}, AlarmTestRequest, AlarmTestRequest$1, AlarmTestResponse, AlarmTestResponse$1>;
74
- declare function alarm(): __PublicMethodMetaInfo$2<'POST', {
75
- seconds: string;
76
- }, AlarmRequest, AlarmRequest$1, AlarmResponse, AlarmResponse$1>;
77
- declare function updateAlarm(): __PublicMethodMetaInfo$2<'PATCH', {
78
- alarmId: string;
79
- }, UpdateAlarmRequest, UpdateAlarmRequest$1, UpdateAlarmResponse & UpdateAlarmResponseNonNullableFields, UpdateAlarmResponse$1 & UpdateAlarmResponseNonNullableFields$1>;
80
-
81
- declare const meta$2_alarm: typeof alarm;
82
- declare const meta$2_alarmTest: typeof alarmTest;
83
- declare const meta$2_updateAlarm: typeof updateAlarm;
84
- declare namespace meta$2 {
85
- export { type __PublicMethodMetaInfo$2 as __PublicMethodMetaInfo, meta$2_alarm as alarm, meta$2_alarmTest as alarmTest, meta$2_updateAlarm as updateAlarm };
86
- }
87
-
88
- interface EchoMessage$1 {
89
- /** message comment from EchoMessage proto def, with special comment */
90
- message?: string;
91
- /** messages_list comment from EchoMessage proto def */
92
- messagesList?: MessageItem[];
93
- id?: string;
94
- }
95
- interface MessageItem {
96
- /** inner_message comment from EchoMessage proto def */
97
- innerMessage?: string;
98
- }
99
- interface EchoRequest$1 {
100
- /** 1st part of the message */
101
- arg1: string;
102
- /** 2nd part of the message */
103
- arg2?: string;
104
- /** this field test translatable annotation */
105
- titleField?: string;
106
- someInt32?: number;
107
- someDate?: Date | null;
108
- }
109
- interface EchoResponse$1 {
110
- /** message result as EchoMessage */
111
- echoMessage?: EchoMessage$1;
112
- /** messge reseult as string */
113
- message?: string;
114
- }
115
- interface MessageItemNonNullableFields$1 {
116
- innerMessage: string;
117
- }
118
- interface EchoMessageNonNullableFields$1 {
119
- message: string;
120
- messagesList: MessageItemNonNullableFields$1[];
121
- id: string;
122
- }
123
- interface EchoResponseNonNullableFields$1 {
124
- echoMessage?: EchoMessageNonNullableFields$1;
125
- message: string;
126
- }
127
-
128
- interface EchoRequest {
129
- /** 1st part of the message */
130
- arg1: string;
131
- /** 2nd part of the message */
132
- arg2?: string;
133
- /** this field test translatable annotation */
134
- titleField?: string;
135
- someInt32?: number;
136
- someDate?: Date | null;
137
- }
138
- interface EchoResponse {
139
- /** message result as EchoMessage */
140
- echoMessage?: EchoMessage;
141
- /** messge reseult as string */
142
- message?: string;
143
- }
144
- interface MessageItemNonNullableFields {
145
- innerMessage: string;
146
- }
147
- interface EchoMessageNonNullableFields {
148
- message: string;
149
- messagesList: MessageItemNonNullableFields[];
150
- _id: string;
151
- }
152
- interface EchoResponseNonNullableFields {
153
- echoMessage?: EchoMessageNonNullableFields;
154
- message: string;
155
- }
156
- interface EchoMessage {
157
- veloMessage: string;
158
- id: string;
159
- }
160
-
161
- type __PublicMethodMetaInfo$1<K = string, M = unknown, T = unknown, S = unknown, Q = unknown, R = unknown> = {
162
- getUrl: (context: any) => string;
163
- httpMethod: K;
164
- path: string;
165
- pathParams: M;
166
- __requestType: T;
167
- __originalRequestType: S;
168
- __responseType: Q;
169
- __originalResponseType: R;
170
- };
171
- declare function echo(): __PublicMethodMetaInfo$1<'POST', {
172
- arg1: string;
173
- }, EchoRequest, EchoRequest$1, EchoResponse & EchoResponseNonNullableFields, EchoResponse$1 & EchoResponseNonNullableFields$1>;
174
-
175
- declare const meta$1_echo: typeof echo;
176
- declare namespace meta$1 {
177
- export { type __PublicMethodMetaInfo$1 as __PublicMethodMetaInfo, meta$1_echo as echo };
178
- }
179
-
180
- interface Product$1 {
181
- title?: string | null;
182
- id?: string;
183
- collectionId?: string;
184
- createdDate?: Date | null;
185
- modifiedDate?: Date | null;
186
- image?: Image;
187
- address?: Address$1;
188
- document?: Document;
189
- video?: VideoV2;
190
- pageLink?: PageLink$1;
191
- audio?: Audio;
192
- color?: string | null;
193
- localDate?: string | null;
194
- localTime?: string | null;
195
- localDateTime?: string | null;
196
- variants?: Variant$1[];
197
- mainVariant?: Variant$1;
198
- customAddress?: MyAddress$1;
199
- /** @readonly */
200
- guid?: string;
201
- }
202
- interface Image {
203
- /** WixMedia image ID. */
204
- id?: string;
205
- /** Image URL. */
206
- url?: string;
207
- /**
208
- * Original image height.
209
- * @readonly
210
- */
211
- height?: number;
212
- /**
213
- * Original image width.
214
- * @readonly
215
- */
216
- width?: number;
217
- /** Image alt text. */
218
- altText?: string | null;
219
- /**
220
- * Image filename.
221
- * @readonly
222
- */
223
- filename?: string | null;
224
- }
225
- /** Physical address */
226
- interface Address$1 extends AddressStreetOneOf$1 {
227
- /** Street name and number. */
228
- streetAddress?: StreetAddress$1;
229
- /** Main address line, usually street and number as free text. */
230
- addressLine?: string | null;
231
- /** Country code. */
232
- country?: string | null;
233
- /** Subdivision shorthand. Usually, a short code (2 or 3 letters) that represents a state, region, prefecture, or province. e.g. NY */
234
- subdivision?: string | null;
235
- /** City name. */
236
- city?: string | null;
237
- /** Zip/postal code. */
238
- postalCode?: string | null;
239
- /** Free text providing more detailed address info. Usually contains Apt, Suite, and Floor. */
240
- addressLine2?: string | null;
241
- }
242
- /** @oneof */
243
- interface AddressStreetOneOf$1 {
244
- /** Street name and number. */
245
- streetAddress?: StreetAddress$1;
246
- /** Main address line, usually street and number as free text. */
247
- addressLine?: string | null;
248
- }
249
- interface StreetAddress$1 {
250
- /** Street number. */
251
- number?: string;
252
- /** Street name. */
253
- name?: string;
254
- }
255
- declare enum SubdivisionType {
256
- UNKNOWN_SUBDIVISION_TYPE = "UNKNOWN_SUBDIVISION_TYPE",
257
- /** State */
258
- ADMINISTRATIVE_AREA_LEVEL_1 = "ADMINISTRATIVE_AREA_LEVEL_1",
259
- /** County */
260
- ADMINISTRATIVE_AREA_LEVEL_2 = "ADMINISTRATIVE_AREA_LEVEL_2",
261
- /** City/town */
262
- ADMINISTRATIVE_AREA_LEVEL_3 = "ADMINISTRATIVE_AREA_LEVEL_3",
263
- /** Neighborhood/quarter */
264
- ADMINISTRATIVE_AREA_LEVEL_4 = "ADMINISTRATIVE_AREA_LEVEL_4",
265
- /** Street/block */
266
- ADMINISTRATIVE_AREA_LEVEL_5 = "ADMINISTRATIVE_AREA_LEVEL_5",
267
- /** ADMINISTRATIVE_AREA_LEVEL_0. Indicates the national political entity, and is typically the highest order type returned by the Geocoder. */
268
- COUNTRY = "COUNTRY"
269
- }
270
- interface Document {
271
- /** WixMedia ID. */
272
- id?: string;
273
- /** Document URL. */
274
- url?: string;
275
- /** Document filename. */
276
- filename?: string | null;
277
- }
278
- interface VideoV2 {
279
- /** WixMedia ID. */
280
- id?: string;
281
- /**
282
- * Available resolutions for the video, starting with the optimal resolution.
283
- * @readonly
284
- */
285
- resolutions?: VideoResolution[];
286
- /**
287
- * Video filename.
288
- * @readonly
289
- */
290
- filename?: string | null;
291
- }
292
- interface VideoResolution {
293
- /** Video URL. */
294
- url?: string;
295
- /** Video height. */
296
- height?: number;
297
- /** Video width. */
298
- width?: number;
299
- /** Video format for example, mp4, hls. */
300
- format?: string;
301
- }
302
- interface PageLink$1 {
303
- /** The page id we want from the site */
304
- pageId?: string;
305
- /** Where this link should open, supports _self and _blank or any name the user chooses. _self means same page, _blank means new page. */
306
- target?: string | null;
307
- /** rel of link */
308
- rel?: LinkRel$1[];
309
- }
310
- /**
311
- * The 'rel' attribute of the link. The rel attribute defines the relationship between a linked resource and the current document.
312
- * Further reading (also about different possible rel types): https://developer.mozilla.org/en-US/docs/Web/HTML/Attributes/rel
313
- * Following are the accepted 'rel' types by Wix applications.
314
- */
315
- declare enum LinkRel$1 {
316
- /** default (not implemented) */
317
- unknown_link_rel = "unknown_link_rel",
318
- /** Indicates that the current document's original author or publisher does not endorse the referenced document. */
319
- nofollow = "nofollow",
320
- /** Instructs the browser to navigate to the target resource without granting the new browsing context access to the document that opened it. */
321
- noopener = "noopener",
322
- /** No Referer header will be included. Additionally, has the same effect as noopener. */
323
- noreferrer = "noreferrer",
324
- /** Indicates a link that resulted from advertisements or paid placements. */
325
- sponsored = "sponsored"
326
- }
327
- interface Audio {
328
- /** WixMedia ID. */
329
- id?: string;
330
- /** Audio URL. */
331
- url?: string;
332
- /**
333
- * Audio filename.
334
- * @readonly
335
- */
336
- filename?: string | null;
337
- }
338
- interface Variant$1 {
339
- name?: string;
340
- value?: string;
341
- image?: Image;
342
- }
343
- interface MyAddress$1 {
344
- country?: string | null;
345
- subdivision?: string | null;
346
- city?: string | null;
347
- postalCode?: string | null;
348
- streetAddress?: StreetAddress$1;
349
- }
350
- interface CreateProductRequest$1 {
351
- product?: Product$1;
352
- }
353
- interface CreateProductResponse$1 {
354
- product?: Product$1;
355
- }
356
- interface DeleteProductRequest$1 {
357
- productId: string;
358
- }
359
- interface DeleteProductResponse$1 {
360
- }
361
- interface UpdateProductRequest$1 {
362
- productId: string;
363
- product?: Product$1;
364
- }
365
- interface UpdateProductResponse$1 {
366
- product?: Product$1;
367
- }
368
- interface GetProductRequest$1 {
369
- productId: string;
370
- }
371
- interface GetProductResponse$1 {
372
- product?: Product$1;
373
- }
374
- interface CountProductsRequest$1 {
375
- filter?: Record<string, any> | null;
376
- }
377
- interface CountProductsResponse$1 {
378
- count?: number;
379
- }
380
- interface GetProductsStartWithRequest$1 {
381
- title: string;
382
- addressLine2?: string | null;
383
- }
384
- interface GetProductsStartWithResponse$1 {
385
- products?: Product$1[];
386
- }
387
- interface QueryProductsRequest$1 {
388
- query?: QueryV2$1;
389
- /** Whether variants should be included in the response. */
390
- includeVariants?: boolean;
391
- /** Whether hidden products should be included in the response. Requires permissions to manage products. */
392
- includeHiddenProducts?: boolean;
393
- /** Whether merchant specific data should be included in the response. Requires permissions to manage products. */
394
- includeMerchantSpecificData?: boolean;
395
- }
396
- interface QueryV2$1 extends QueryV2PagingMethodOneOf$1 {
397
- /** Paging options to limit and skip the number of items. */
398
- paging?: Paging$1;
399
- /** 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`. */
400
- cursorPaging?: CursorPaging$1;
401
- /**
402
- * Filter object.
403
- *
404
- * Learn more about the [filter section](https://dev.wix.com/docs/rest/articles/getting-started/api-query-language#the-filter-section).
405
- */
406
- filter?: Record<string, any> | null;
407
- /**
408
- * Sort object.
409
- *
410
- * Learn more about the [sort section](https://dev.wix.com/docs/rest/articles/getting-started/api-query-language#the-sort-section).
411
- */
412
- sort?: Sorting$1[];
413
- /** 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. */
414
- fields?: string[];
415
- /** 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. */
416
- fieldsets?: string[];
417
- }
418
- /** @oneof */
419
- interface QueryV2PagingMethodOneOf$1 {
420
- /** Paging options to limit and skip the number of items. */
421
- paging?: Paging$1;
422
- /** 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`. */
423
- cursorPaging?: CursorPaging$1;
424
- }
425
- interface Sorting$1 {
426
- /** Name of the field to sort by. */
427
- fieldName?: string;
428
- /** Sort order. */
429
- order?: SortOrder$1;
430
- }
431
- declare enum SortOrder$1 {
432
- ASC = "ASC",
433
- DESC = "DESC"
434
- }
435
- interface Paging$1 {
436
- /** Number of items to load. */
437
- limit?: number | null;
438
- /** Number of items to skip in the current sort order. */
439
- offset?: number | null;
440
- }
441
- interface CursorPaging$1 {
442
- /** Maximum number of items to return in the results. */
443
- limit?: number | null;
444
- /**
445
- * Pointer to the next or previous page in the list of results.
446
- *
447
- * Pass the relevant cursor token from the `pagingMetadata` object in the previous call's response.
448
- * Not relevant for the first request.
449
- */
450
- cursor?: string | null;
451
- }
452
- interface QueryProductsResponse$1 {
453
- products?: Product$1[];
454
- metadata?: PagingMetadataV2$1;
455
- }
456
- interface PagingMetadataV2$1 {
457
- /** Number of items returned in the response. */
458
- count?: number | null;
459
- /** Offset that was requested. */
460
- offset?: number | null;
461
- /** Total number of items that match the query. Returned if offset paging is used and the `tooManyToCount` flag is not set. */
462
- total?: number | null;
463
- /** Flag that indicates the server failed to calculate the `total` field. */
464
- tooManyToCount?: boolean | null;
465
- /** Cursors to navigate through the result pages using `next` and `prev`. Returned if cursor paging is used. */
466
- cursors?: Cursors$1;
467
- }
468
- interface Cursors$1 {
469
- /** Cursor string pointing to the next page in the list of results. */
470
- next?: string | null;
471
- /** Cursor pointing to the previous page in the list of results. */
472
- prev?: string | null;
473
- }
474
- interface BulkCreateProductsRequest$1 {
475
- products: Product$1[];
476
- /** set to `true` if you wish to receive back the created products in the response */
477
- returnEntity?: boolean;
478
- }
479
- interface BulkCreateProductsResponse$1 {
480
- results?: BulkProductResult$1[];
481
- bulkActionMetadata?: BulkActionMetadata$1;
482
- }
483
- interface ItemMetadata$1 {
484
- /** Item ID. Should always be available, unless it's impossible (for example, when failing to create an item). */
485
- id?: string | null;
486
- /** Index of the item within the request array. Allows for correlation between request and response items. */
487
- originalIndex?: number;
488
- /** Whether the requested action was successful for this item. When `false`, the `error` field is populated. */
489
- success?: boolean;
490
- /** Details about the error in case of failure. */
491
- error?: ApplicationError$1;
492
- }
493
- interface ApplicationError$1 {
494
- /** Error code. */
495
- code?: string;
496
- /** Description of the error. */
497
- description?: string;
498
- /** Data related to the error. */
499
- data?: Record<string, any> | null;
500
- }
501
- interface BulkProductResult$1 {
502
- /** Defined in wix.commons */
503
- itemMetadata?: ItemMetadata$1;
504
- /** Only exists if `returnEntity` was set to true in the request */
505
- item?: Product$1;
506
- }
507
- interface BulkActionMetadata$1 {
508
- /** Number of items that were successfully processed. */
509
- totalSuccesses?: number;
510
- /** Number of items that couldn't be processed. */
511
- totalFailures?: number;
512
- /** Number of failures without details because detailed failure threshold was exceeded. */
513
- undetailedFailures?: number;
514
- }
515
- interface BulkUpdateProductsRequest$1 {
516
- products: MaskedProduct$1[];
517
- /** set to `true` if you wish to receive back the updated products in the response */
518
- returnEntity?: boolean;
519
- }
520
- interface MaskedProduct$1 {
521
- /** Product to be updated, may be partial */
522
- product?: Product$1;
523
- }
524
- interface BulkUpdateProductsResponse$1 {
525
- results?: BulkUpdateProductsResponseBulkProductResult$1[];
526
- bulkActionMetadata?: BulkActionMetadata$1;
527
- }
528
- interface BulkUpdateProductsResponseBulkProductResult$1 {
529
- itemMetadata?: ItemMetadata$1;
530
- /** Only exists if `returnEntity` was set to true in the request */
531
- item?: Product$1;
532
- }
533
- interface BulkDeleteProductsRequest$1 {
534
- productIds: string[];
535
- }
536
- interface BulkDeleteProductsResponse$1 {
537
- results?: BulkDeleteProductsResponseBulkProductResult$1[];
538
- bulkActionMetadata?: BulkActionMetadata$1;
539
- }
540
- interface BulkDeleteProductsResponseBulkProductResult$1 {
541
- itemMetadata?: ItemMetadata$1;
542
- }
543
- interface FocalPointNonNullableFields {
544
- x: number;
545
- y: number;
546
- }
547
- interface ImageNonNullableFields {
548
- id: string;
549
- url: string;
550
- height: number;
551
- width: number;
552
- focalPoint?: FocalPointNonNullableFields;
553
- }
554
- interface StreetAddressNonNullableFields$1 {
555
- number: string;
556
- name: string;
557
- apt: string;
558
- }
559
- interface SubdivisionNonNullableFields {
560
- code: string;
561
- name: string;
562
- type: SubdivisionType;
563
- }
564
- interface AddressNonNullableFields$1 {
565
- streetAddress?: StreetAddressNonNullableFields$1;
566
- subdivisions: SubdivisionNonNullableFields[];
567
- }
568
- interface DocumentNonNullableFields {
569
- id: string;
570
- url: string;
571
- }
572
- interface VideoResolutionNonNullableFields {
573
- url: string;
574
- height: number;
575
- width: number;
576
- poster?: ImageNonNullableFields;
577
- format: string;
578
- }
579
- interface VideoV2NonNullableFields {
580
- id: string;
581
- url: string;
582
- resolutions: VideoResolutionNonNullableFields[];
583
- posters: ImageNonNullableFields[];
584
- }
585
- interface PageLinkNonNullableFields$1 {
586
- pageId: string;
587
- rel: LinkRel$1[];
588
- }
589
- interface AudioNonNullableFields {
590
- id: string;
591
- url: string;
592
- }
593
- interface VariantNonNullableFields$1 {
594
- name: string;
595
- value: string;
596
- image?: ImageNonNullableFields;
597
- }
598
- interface MyAddressNonNullableFields$1 {
599
- streetAddress?: StreetAddressNonNullableFields$1;
600
- }
601
- interface ProductNonNullableFields$1 {
602
- id: string;
603
- collectionId: string;
604
- image?: ImageNonNullableFields;
605
- address?: AddressNonNullableFields$1;
606
- document?: DocumentNonNullableFields;
607
- video?: VideoV2NonNullableFields;
608
- pageLink?: PageLinkNonNullableFields$1;
609
- audio?: AudioNonNullableFields;
610
- variants: VariantNonNullableFields$1[];
611
- mainVariant?: VariantNonNullableFields$1;
612
- customAddress?: MyAddressNonNullableFields$1;
613
- guid: string;
614
- }
615
- interface CreateProductResponseNonNullableFields$1 {
616
- product?: ProductNonNullableFields$1;
617
- }
618
- interface UpdateProductResponseNonNullableFields$1 {
619
- product?: ProductNonNullableFields$1;
620
- }
621
- interface GetProductResponseNonNullableFields$1 {
622
- product?: ProductNonNullableFields$1;
623
- }
624
- interface CountProductsResponseNonNullableFields$1 {
625
- count: number;
626
- }
627
- interface GetProductsStartWithResponseNonNullableFields$1 {
628
- products: ProductNonNullableFields$1[];
629
- }
630
- interface QueryProductsResponseNonNullableFields$1 {
631
- products: ProductNonNullableFields$1[];
632
- }
633
- interface ApplicationErrorNonNullableFields$1 {
634
- code: string;
635
- description: string;
636
- }
637
- interface ItemMetadataNonNullableFields$1 {
638
- originalIndex: number;
639
- success: boolean;
640
- error?: ApplicationErrorNonNullableFields$1;
641
- }
642
- interface BulkProductResultNonNullableFields$1 {
643
- itemMetadata?: ItemMetadataNonNullableFields$1;
644
- item?: ProductNonNullableFields$1;
645
- }
646
- interface BulkActionMetadataNonNullableFields$1 {
647
- totalSuccesses: number;
648
- totalFailures: number;
649
- undetailedFailures: number;
650
- }
651
- interface BulkCreateProductsResponseNonNullableFields$1 {
652
- results: BulkProductResultNonNullableFields$1[];
653
- bulkActionMetadata?: BulkActionMetadataNonNullableFields$1;
654
- }
655
- interface BulkUpdateProductsResponseBulkProductResultNonNullableFields$1 {
656
- itemMetadata?: ItemMetadataNonNullableFields$1;
657
- item?: ProductNonNullableFields$1;
658
- }
659
- interface BulkUpdateProductsResponseNonNullableFields$1 {
660
- results: BulkUpdateProductsResponseBulkProductResultNonNullableFields$1[];
661
- bulkActionMetadata?: BulkActionMetadataNonNullableFields$1;
662
- }
663
- interface BulkDeleteProductsResponseBulkProductResultNonNullableFields$1 {
664
- itemMetadata?: ItemMetadataNonNullableFields$1;
665
- }
666
- interface BulkDeleteProductsResponseNonNullableFields$1 {
667
- results: BulkDeleteProductsResponseBulkProductResultNonNullableFields$1[];
668
- bulkActionMetadata?: BulkActionMetadataNonNullableFields$1;
669
- }
670
-
671
- /** Physical address */
672
- interface Address extends AddressStreetOneOf {
673
- /** Street name and number. */
674
- streetAddress?: StreetAddress;
675
- /** Main address line, usually street and number as free text. */
676
- addressLine1?: string | null;
677
- /** Country code. */
678
- country?: string | null;
679
- /** Subdivision shorthand. Usually, a short code (2 or 3 letters) that represents a state, region, prefecture, or province. e.g. NY */
680
- subdivision?: string | null;
681
- /** City name. */
682
- city?: string | null;
683
- /** Zip/postal code. */
684
- postalCode?: string | null;
685
- /** Free text providing more detailed address info. Usually contains Apt, Suite, and Floor. */
686
- addressLine2?: string | null;
687
- }
688
- /** @oneof */
689
- interface AddressStreetOneOf {
690
- /** Street name and number. */
691
- streetAddress?: StreetAddress;
692
- /** Main address line, usually street and number as free text. */
693
- addressLine?: string | null;
694
- }
695
- interface StreetAddress {
696
- /** Street number. */
697
- number?: string;
698
- /** Street name. */
699
- name?: string;
700
- }
701
- interface PageLink {
702
- /** The page id we want from the site */
703
- pageId?: string;
704
- /** Where this link should open, supports _self and _blank or any name the user chooses. _self means same page, _blank means new page. */
705
- target?: string | null;
706
- /** rel of link */
707
- rel?: LinkRel[];
708
- }
709
- /**
710
- * The 'rel' attribute of the link. The rel attribute defines the relationship between a linked resource and the current document.
711
- * Further reading (also about different possible rel types): https://developer.mozilla.org/en-US/docs/Web/HTML/Attributes/rel
712
- * Following are the accepted 'rel' types by Wix applications.
713
- */
714
- declare enum LinkRel {
715
- /** default (not implemented) */
716
- unknown_link_rel = "unknown_link_rel",
717
- /** Indicates that the current document's original author or publisher does not endorse the referenced document. */
718
- nofollow = "nofollow",
719
- /** Instructs the browser to navigate to the target resource without granting the new browsing context access to the document that opened it. */
720
- noopener = "noopener",
721
- /** No Referer header will be included. Additionally, has the same effect as noopener. */
722
- noreferrer = "noreferrer",
723
- /** Indicates a link that resulted from advertisements or paid placements. */
724
- sponsored = "sponsored"
725
- }
726
- interface Variant {
727
- name?: string;
728
- value?: string;
729
- image?: string;
730
- }
731
- interface MyAddress {
732
- country?: string | null;
733
- subdivision?: string | null;
734
- city?: string | null;
735
- postalCode?: string | null;
736
- streetAddress?: StreetAddress;
737
- }
738
- interface CreateProductRequest {
739
- product?: Product;
740
- }
741
- interface CreateProductResponse {
742
- product?: Product;
743
- }
744
- interface DeleteProductRequest {
745
- productId: string;
746
- }
747
- interface DeleteProductResponse {
748
- }
749
- interface UpdateProductRequest {
750
- productId: string;
751
- product?: Product;
752
- }
753
- interface UpdateProductResponse {
754
- product?: Product;
755
- }
756
- interface GetProductRequest {
757
- productId: string;
758
- }
759
- interface GetProductResponse {
760
- product?: Product;
761
- }
762
- interface CountProductsRequest {
763
- filter?: Record<string, any> | null;
764
- }
765
- interface CountProductsResponse {
766
- count?: number;
767
- }
768
- interface GetProductsStartWithRequest {
769
- title: string;
770
- addressLine2?: string | null;
771
- }
772
- interface GetProductsStartWithResponse {
773
- products?: Product[];
774
- }
775
- interface QueryProductsRequest {
776
- query?: QueryV2;
777
- /** Whether variants should be included in the response. */
778
- includeVariants?: boolean;
779
- /** Whether hidden products should be included in the response. Requires permissions to manage products. */
780
- includeHiddenProducts?: boolean;
781
- /** Whether merchant specific data should be included in the response. Requires permissions to manage products. */
782
- includeMerchantSpecificData?: boolean;
783
- }
784
- interface QueryV2 extends QueryV2PagingMethodOneOf {
785
- /** Paging options to limit and skip the number of items. */
786
- paging?: Paging;
787
- /** 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`. */
788
- cursorPaging?: CursorPaging;
789
- /**
790
- * Filter object.
791
- *
792
- * Learn more about the [filter section](https://dev.wix.com/docs/rest/articles/getting-started/api-query-language#the-filter-section).
793
- */
794
- filter?: Record<string, any> | null;
795
- /**
796
- * Sort object.
797
- *
798
- * Learn more about the [sort section](https://dev.wix.com/docs/rest/articles/getting-started/api-query-language#the-sort-section).
799
- */
800
- sort?: Sorting[];
801
- /** 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. */
802
- fields?: string[];
803
- /** 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. */
804
- fieldsets?: string[];
805
- }
806
- /** @oneof */
807
- interface QueryV2PagingMethodOneOf {
808
- /** Paging options to limit and skip the number of items. */
809
- paging?: Paging;
810
- /** 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`. */
811
- cursorPaging?: CursorPaging;
812
- }
813
- interface Sorting {
814
- /** Name of the field to sort by. */
815
- fieldName?: string;
816
- /** Sort order. */
817
- order?: SortOrder;
818
- }
819
- declare enum SortOrder {
820
- ASC = "ASC",
821
- DESC = "DESC"
822
- }
823
- interface Paging {
824
- /** Number of items to load. */
825
- limit?: number | null;
826
- /** Number of items to skip in the current sort order. */
827
- offset?: number | null;
828
- }
829
- interface CursorPaging {
830
- /** Maximum number of items to return in the results. */
831
- limit?: number | null;
832
- /**
833
- * Pointer to the next or previous page in the list of results.
834
- *
835
- * Pass the relevant cursor token from the `pagingMetadata` object in the previous call's response.
836
- * Not relevant for the first request.
837
- */
838
- cursor?: string | null;
839
- }
840
- interface QueryProductsResponse {
841
- products?: Product[];
842
- metadata?: PagingMetadataV2;
843
- }
844
- interface PagingMetadataV2 {
845
- /** Number of items returned in the response. */
846
- count?: number | null;
847
- /** Offset that was requested. */
848
- offset?: number | null;
849
- /** Total number of items that match the query. Returned if offset paging is used and the `tooManyToCount` flag is not set. */
850
- total?: number | null;
851
- /** Flag that indicates the server failed to calculate the `total` field. */
852
- tooManyToCount?: boolean | null;
853
- /** Cursors to navigate through the result pages using `next` and `prev`. Returned if cursor paging is used. */
854
- cursors?: Cursors;
855
- }
856
- interface Cursors {
857
- /** Cursor string pointing to the next page in the list of results. */
858
- next?: string | null;
859
- /** Cursor pointing to the previous page in the list of results. */
860
- prev?: string | null;
861
- }
862
- interface BulkCreateProductsRequest {
863
- products: Product[];
864
- /** set to `true` if you wish to receive back the created products in the response */
865
- returnEntity?: boolean;
866
- }
867
- interface BulkCreateProductsResponse {
868
- results?: BulkProductResult[];
869
- bulkActionMetadata?: BulkActionMetadata;
870
- }
871
- interface ItemMetadata {
872
- /** Item ID. Should always be available, unless it's impossible (for example, when failing to create an item). */
873
- _id?: string | null;
874
- /** Index of the item within the request array. Allows for correlation between request and response items. */
875
- originalIndex?: number;
876
- /** Whether the requested action was successful for this item. When `false`, the `error` field is populated. */
877
- success?: boolean;
878
- /** Details about the error in case of failure. */
879
- error?: ApplicationError;
880
- }
881
- interface ApplicationError {
882
- /** Error code. */
883
- code?: string;
884
- /** Description of the error. */
885
- description?: string;
886
- /** Data related to the error. */
887
- data?: Record<string, any> | null;
888
- }
889
- interface BulkProductResult {
890
- /** Defined in wix.commons */
891
- itemMetadata?: ItemMetadata;
892
- /** Only exists if `returnEntity` was set to true in the request */
893
- item?: Product;
894
- }
895
- interface BulkActionMetadata {
896
- /** Number of items that were successfully processed. */
897
- totalSuccesses?: number;
898
- /** Number of items that couldn't be processed. */
899
- totalFailures?: number;
900
- /** Number of failures without details because detailed failure threshold was exceeded. */
901
- undetailedFailures?: number;
902
- }
903
- interface BulkUpdateProductsRequest {
904
- products: MaskedProduct[];
905
- /** set to `true` if you wish to receive back the updated products in the response */
906
- returnEntity?: boolean;
907
- }
908
- interface MaskedProduct {
909
- /** Product to be updated, may be partial */
910
- product?: Product;
911
- }
912
- interface BulkUpdateProductsResponse {
913
- results?: BulkUpdateProductsResponseBulkProductResult[];
914
- bulkActionMetadata?: BulkActionMetadata;
915
- }
916
- interface BulkUpdateProductsResponseBulkProductResult {
917
- itemMetadata?: ItemMetadata;
918
- /** Only exists if `returnEntity` was set to true in the request */
919
- item?: Product;
920
- }
921
- interface BulkDeleteProductsRequest {
922
- productIds: string[];
923
- }
924
- interface BulkDeleteProductsResponse {
925
- results?: BulkDeleteProductsResponseBulkProductResult[];
926
- bulkActionMetadata?: BulkActionMetadata;
927
- }
928
- interface BulkDeleteProductsResponseBulkProductResult {
929
- itemMetadata?: ItemMetadata;
930
- }
931
- interface StreetAddressNonNullableFields {
932
- number: string;
933
- name: string;
934
- apt: string;
935
- }
936
- interface AddressNonNullableFields {
937
- streetAddress?: StreetAddressNonNullableFields;
938
- }
939
- interface PageLinkNonNullableFields {
940
- pageId: string;
941
- rel: LinkRel[];
942
- }
943
- interface VariantNonNullableFields {
944
- name: string;
945
- value: string;
946
- image: string;
947
- }
948
- interface MyAddressNonNullableFields {
949
- streetAddress?: StreetAddressNonNullableFields;
950
- }
951
- interface ProductNonNullableFields {
952
- _id: string;
953
- collectionId: string;
954
- image: string;
955
- address?: AddressNonNullableFields;
956
- document: string;
957
- video: string;
958
- pageLink?: PageLinkNonNullableFields;
959
- audio: string;
960
- variants: VariantNonNullableFields[];
961
- mainVariant?: VariantNonNullableFields;
962
- customAddress?: MyAddressNonNullableFields;
963
- guid: string;
964
- }
965
- interface CreateProductResponseNonNullableFields {
966
- product?: ProductNonNullableFields;
967
- }
968
- interface UpdateProductResponseNonNullableFields {
969
- product?: ProductNonNullableFields;
970
- }
971
- interface GetProductResponseNonNullableFields {
972
- product?: ProductNonNullableFields;
973
- }
974
- interface CountProductsResponseNonNullableFields {
975
- count: number;
976
- }
977
- interface GetProductsStartWithResponseNonNullableFields {
978
- products: ProductNonNullableFields[];
979
- }
980
- interface QueryProductsResponseNonNullableFields {
981
- products: ProductNonNullableFields[];
982
- }
983
- interface ApplicationErrorNonNullableFields {
984
- code: string;
985
- description: string;
986
- }
987
- interface ItemMetadataNonNullableFields {
988
- originalIndex: number;
989
- success: boolean;
990
- error?: ApplicationErrorNonNullableFields;
991
- }
992
- interface BulkProductResultNonNullableFields {
993
- itemMetadata?: ItemMetadataNonNullableFields;
994
- item?: ProductNonNullableFields;
995
- }
996
- interface BulkActionMetadataNonNullableFields {
997
- totalSuccesses: number;
998
- totalFailures: number;
999
- undetailedFailures: number;
1000
- }
1001
- interface BulkCreateProductsResponseNonNullableFields {
1002
- results: BulkProductResultNonNullableFields[];
1003
- bulkActionMetadata?: BulkActionMetadataNonNullableFields;
1004
- }
1005
- interface BulkUpdateProductsResponseBulkProductResultNonNullableFields {
1006
- itemMetadata?: ItemMetadataNonNullableFields;
1007
- item?: ProductNonNullableFields;
1008
- }
1009
- interface BulkUpdateProductsResponseNonNullableFields {
1010
- results: BulkUpdateProductsResponseBulkProductResultNonNullableFields[];
1011
- bulkActionMetadata?: BulkActionMetadataNonNullableFields;
1012
- }
1013
- interface BulkDeleteProductsResponseBulkProductResultNonNullableFields {
1014
- itemMetadata?: ItemMetadataNonNullableFields;
1015
- }
1016
- interface BulkDeleteProductsResponseNonNullableFields {
1017
- results: BulkDeleteProductsResponseBulkProductResultNonNullableFields[];
1018
- bulkActionMetadata?: BulkActionMetadataNonNullableFields;
1019
- }
1020
- interface Product {
1021
- _id: string;
1022
- name: string | null;
1023
- collectionId: string;
1024
- _createdDate: Date | null;
1025
- modifiedDate: Date | null;
1026
- image: string;
1027
- address: Address;
1028
- document: string;
1029
- video: string;
1030
- pageLink: PageLink;
1031
- audio: string;
1032
- color: string | null;
1033
- localDate: string | null;
1034
- localTime: string | null;
1035
- localDateTime: string | null;
1036
- variants: Variant[];
1037
- mainVariant: Variant;
1038
- customAddress: MyAddress;
1039
- guid: string;
1040
- }
1041
-
1042
- type __PublicMethodMetaInfo<K = string, M = unknown, T = unknown, S = unknown, Q = unknown, R = unknown> = {
1043
- getUrl: (context: any) => string;
1044
- httpMethod: K;
1045
- path: string;
1046
- pathParams: M;
1047
- __requestType: T;
1048
- __originalRequestType: S;
1049
- __responseType: Q;
1050
- __originalResponseType: R;
1051
- };
1052
- declare function createProduct(): __PublicMethodMetaInfo<'POST', {}, CreateProductRequest, CreateProductRequest$1, CreateProductResponse & CreateProductResponseNonNullableFields, CreateProductResponse$1 & CreateProductResponseNonNullableFields$1>;
1053
- declare function deleteProduct(): __PublicMethodMetaInfo<'DELETE', {
1054
- productId: string;
1055
- }, DeleteProductRequest, DeleteProductRequest$1, DeleteProductResponse, DeleteProductResponse$1>;
1056
- declare function updateProduct(): __PublicMethodMetaInfo<'PUT', {
1057
- productId: string;
1058
- }, UpdateProductRequest, UpdateProductRequest$1, UpdateProductResponse & UpdateProductResponseNonNullableFields, UpdateProductResponse$1 & UpdateProductResponseNonNullableFields$1>;
1059
- declare function getProduct(): __PublicMethodMetaInfo<'GET', {
1060
- productId: string;
1061
- }, GetProductRequest, GetProductRequest$1, GetProductResponse & GetProductResponseNonNullableFields, GetProductResponse$1 & GetProductResponseNonNullableFields$1>;
1062
- declare function countProducts(): __PublicMethodMetaInfo<'POST', {}, CountProductsRequest, CountProductsRequest$1, CountProductsResponse & CountProductsResponseNonNullableFields, CountProductsResponse$1 & CountProductsResponseNonNullableFields$1>;
1063
- declare function getProductsStartWith(): __PublicMethodMetaInfo<'GET', {
1064
- title: string;
1065
- }, GetProductsStartWithRequest, GetProductsStartWithRequest$1, GetProductsStartWithResponse & GetProductsStartWithResponseNonNullableFields, GetProductsStartWithResponse$1 & GetProductsStartWithResponseNonNullableFields$1>;
1066
- declare function queryProducts(): __PublicMethodMetaInfo<'GET', {}, QueryProductsRequest, QueryProductsRequest$1, QueryProductsResponse & QueryProductsResponseNonNullableFields, QueryProductsResponse$1 & QueryProductsResponseNonNullableFields$1>;
1067
- declare function bulkCreateProducts(): __PublicMethodMetaInfo<'POST', {}, BulkCreateProductsRequest, BulkCreateProductsRequest$1, BulkCreateProductsResponse & BulkCreateProductsResponseNonNullableFields, BulkCreateProductsResponse$1 & BulkCreateProductsResponseNonNullableFields$1>;
1068
- declare function bulkUpdateProducts(): __PublicMethodMetaInfo<'PATCH', {}, BulkUpdateProductsRequest, BulkUpdateProductsRequest$1, BulkUpdateProductsResponse & BulkUpdateProductsResponseNonNullableFields, BulkUpdateProductsResponse$1 & BulkUpdateProductsResponseNonNullableFields$1>;
1069
- declare function bulkDeleteProducts(): __PublicMethodMetaInfo<'POST', {}, BulkDeleteProductsRequest, BulkDeleteProductsRequest$1, BulkDeleteProductsResponse & BulkDeleteProductsResponseNonNullableFields, BulkDeleteProductsResponse$1 & BulkDeleteProductsResponseNonNullableFields$1>;
1070
-
1071
- type meta___PublicMethodMetaInfo<K = string, M = unknown, T = unknown, S = unknown, Q = unknown, R = unknown> = __PublicMethodMetaInfo<K, M, T, S, Q, R>;
1072
- declare const meta_bulkCreateProducts: typeof bulkCreateProducts;
1073
- declare const meta_bulkDeleteProducts: typeof bulkDeleteProducts;
1074
- declare const meta_bulkUpdateProducts: typeof bulkUpdateProducts;
1075
- declare const meta_countProducts: typeof countProducts;
1076
- declare const meta_createProduct: typeof createProduct;
1077
- declare const meta_deleteProduct: typeof deleteProduct;
1078
- declare const meta_getProduct: typeof getProduct;
1079
- declare const meta_getProductsStartWith: typeof getProductsStartWith;
1080
- declare const meta_queryProducts: typeof queryProducts;
1081
- declare const meta_updateProduct: typeof updateProduct;
1082
- declare namespace meta {
1083
- export { type meta___PublicMethodMetaInfo as __PublicMethodMetaInfo, meta_bulkCreateProducts as bulkCreateProducts, meta_bulkDeleteProducts as bulkDeleteProducts, meta_bulkUpdateProducts as bulkUpdateProducts, meta_countProducts as countProducts, meta_createProduct as createProduct, meta_deleteProduct as deleteProduct, meta_getProduct as getProduct, meta_getProductsStartWith as getProductsStartWith, meta_queryProducts as queryProducts, meta_updateProduct as updateProduct };
1084
- }
1085
-
1086
- export { meta$2 as alarms, meta$1 as metroinspector, meta as products };