@wix/auto_sdk_data_scheduled-workflows 1.0.1 → 1.0.3

This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
Files changed (49) hide show
  1. package/build/cjs/index.d.ts +1 -1
  2. package/build/cjs/index.js +344 -19
  3. package/build/cjs/index.js.map +1 -1
  4. package/build/cjs/index.typings.d.ts +759 -59
  5. package/build/cjs/index.typings.js +238 -19
  6. package/build/cjs/index.typings.js.map +1 -1
  7. package/build/cjs/meta.d.ts +758 -58
  8. package/build/cjs/meta.js +238 -19
  9. package/build/cjs/meta.js.map +1 -1
  10. package/build/cjs/schemas.d.ts +1380 -12
  11. package/build/cjs/schemas.js +6437 -707
  12. package/build/cjs/schemas.js.map +1 -1
  13. package/build/es/index.d.mts +1 -1
  14. package/build/es/index.mjs +343 -19
  15. package/build/es/index.mjs.map +1 -1
  16. package/build/es/index.typings.d.mts +759 -59
  17. package/build/es/index.typings.mjs +237 -19
  18. package/build/es/index.typings.mjs.map +1 -1
  19. package/build/es/meta.d.mts +758 -58
  20. package/build/es/meta.mjs +237 -19
  21. package/build/es/meta.mjs.map +1 -1
  22. package/build/es/schemas.d.mts +1380 -12
  23. package/build/es/schemas.mjs +6437 -707
  24. package/build/es/schemas.mjs.map +1 -1
  25. package/build/internal/cjs/index.d.ts +1 -1
  26. package/build/internal/cjs/index.js +344 -19
  27. package/build/internal/cjs/index.js.map +1 -1
  28. package/build/internal/cjs/index.typings.d.ts +759 -59
  29. package/build/internal/cjs/index.typings.js +238 -19
  30. package/build/internal/cjs/index.typings.js.map +1 -1
  31. package/build/internal/cjs/meta.d.ts +758 -58
  32. package/build/internal/cjs/meta.js +238 -19
  33. package/build/internal/cjs/meta.js.map +1 -1
  34. package/build/internal/cjs/schemas.d.ts +1380 -12
  35. package/build/internal/cjs/schemas.js +6437 -707
  36. package/build/internal/cjs/schemas.js.map +1 -1
  37. package/build/internal/es/index.d.mts +1 -1
  38. package/build/internal/es/index.mjs +343 -19
  39. package/build/internal/es/index.mjs.map +1 -1
  40. package/build/internal/es/index.typings.d.mts +759 -59
  41. package/build/internal/es/index.typings.mjs +237 -19
  42. package/build/internal/es/index.typings.mjs.map +1 -1
  43. package/build/internal/es/meta.d.mts +758 -58
  44. package/build/internal/es/meta.mjs +237 -19
  45. package/build/internal/es/meta.mjs.map +1 -1
  46. package/build/internal/es/schemas.d.mts +1380 -12
  47. package/build/internal/es/schemas.mjs +6437 -707
  48. package/build/internal/es/schemas.mjs.map +1 -1
  49. package/package.json +2 -2
@@ -163,6 +163,716 @@ interface SourceSourceOneOf {
163
163
  */
164
164
  file?: FileSource;
165
165
  }
166
+ interface AggregationPipeline extends AggregationPipelinePagingMethodOneOf {
167
+ /**
168
+ * Paging options to limit and skip the number of results.
169
+ *
170
+ * Learn more about [sorting and paging](https://dev.wix.com/docs/rest/articles/get-started/sorting-and-paging).
171
+ */
172
+ paging?: Paging;
173
+ /**
174
+ * Cursor token referring to a page of results.
175
+ *
176
+ * Not used in the first request. Subsequent requests use the cursor token and not `filter` or `sort`.
177
+ */
178
+ cursorPaging?: CursorPaging;
179
+ /**
180
+ * Sequence of aggregation operations to apply to the data.
181
+ *
182
+ * Stages are processed in order, with each stage operating on the output of the previous stage.
183
+ * @maxSize 100
184
+ */
185
+ stages?: Stage[];
186
+ }
187
+ /** @oneof */
188
+ interface AggregationPipelinePagingMethodOneOf {
189
+ /**
190
+ * Paging options to limit and skip the number of results.
191
+ *
192
+ * Learn more about [sorting and paging](https://dev.wix.com/docs/rest/articles/get-started/sorting-and-paging).
193
+ */
194
+ paging?: Paging;
195
+ /**
196
+ * Cursor token referring to a page of results.
197
+ *
198
+ * Not used in the first request. Subsequent requests use the cursor token and not `filter` or `sort`.
199
+ */
200
+ cursorPaging?: CursorPaging;
201
+ }
202
+ interface Stage extends StageStageOneOf {
203
+ /** Groups aggregated items to new result items. */
204
+ group?: Group;
205
+ /**
206
+ * Aggregation filter. Only items that match the filter are processed.
207
+ *
208
+ * Learn more about [filters in API Query Language](https://dev.wix.com/docs/rest/articles/get-started/api-query-language#filters).
209
+ *
210
+ * > **Note:** The values you provide for each filter field must adhere to that field's data type. For example, when filtering by a field whose type is Date and Time, use an object in the following format: `"someDateAndTimeFieldKey": { "$date": "YYYY-MM-DDTHH:mm:ss.sssZ"}`. Learn more about [data types in Wix Data](https://dev.wix.com/docs/rest/business-solutions/cms/data-items/data-types-in-wix-data).
211
+ */
212
+ filter?: Record<string, any> | null;
213
+ /**
214
+ * Sorting preferences.
215
+ *
216
+ * Learn more about [sorting and paging](https://dev.wix.com/docs/rest/articles/get-started/sorting-and-paging).
217
+ */
218
+ sort?: Sorting;
219
+ /** Transforms items by including, excluding, or reshaping fields. */
220
+ projection?: Projection;
221
+ /** Transforms an object into an array where each object property becomes a new array element containing the property's key and value, as well as all other properties from the original object. */
222
+ objectToArray?: ObjectToArray;
223
+ /** Creates a result item for each array element. Each result contains the full original item, with the array field replaced by an element whose key is the array name and whose value is the array element. */
224
+ unwindArray?: UnwindArray;
225
+ /** Number of results to skip from the beginning of the result set. */
226
+ skip?: number;
227
+ /** Maximum number of results to return. */
228
+ limit?: number;
229
+ }
230
+ /** @oneof */
231
+ interface StageStageOneOf {
232
+ /** Groups aggregated items to new result items. */
233
+ group?: Group;
234
+ /**
235
+ * Aggregation filter. Only items that match the filter are processed.
236
+ *
237
+ * Learn more about [filters in API Query Language](https://dev.wix.com/docs/rest/articles/get-started/api-query-language#filters).
238
+ *
239
+ * > **Note:** The values you provide for each filter field must adhere to that field's data type. For example, when filtering by a field whose type is Date and Time, use an object in the following format: `"someDateAndTimeFieldKey": { "$date": "YYYY-MM-DDTHH:mm:ss.sssZ"}`. Learn more about [data types in Wix Data](https://dev.wix.com/docs/rest/business-solutions/cms/data-items/data-types-in-wix-data).
240
+ */
241
+ filter?: Record<string, any> | null;
242
+ /**
243
+ * Sorting preferences.
244
+ *
245
+ * Learn more about [sorting and paging](https://dev.wix.com/docs/rest/articles/get-started/sorting-and-paging).
246
+ */
247
+ sort?: Sorting;
248
+ /** Transforms items by including, excluding, or reshaping fields. */
249
+ projection?: Projection;
250
+ /** Transforms an object into an array where each object property becomes a new array element containing the property's key and value, as well as all other properties from the original object. */
251
+ objectToArray?: ObjectToArray;
252
+ /** Creates a result item for each array element. Each result contains the full original item, with the array field replaced by an element whose key is the array name and whose value is the array element. */
253
+ unwindArray?: UnwindArray;
254
+ /** Number of results to skip from the beginning of the result set. */
255
+ skip?: number;
256
+ /** Maximum number of results to return. */
257
+ limit?: number;
258
+ }
259
+ interface Group {
260
+ /**
261
+ * Grouping criteria by which to organize items.
262
+ *
263
+ * Each `groupId` specifies a field by which to group items, and serves as the result item's unique `_id` property.
264
+ *
265
+ * Items with identical values for the specified `expression` are placed in the same group based on the specified `key`. If empty, all items are treated as a single group.
266
+ * @maxSize 1000
267
+ */
268
+ groupIds?: GroupId[];
269
+ /**
270
+ * Accumulation operations to run on each group.
271
+ *
272
+ * Accumulators aggregate data across all items in the group and return the result in a new field.
273
+ *
274
+ * > **Note:** When using accumulators, the type of expression must be compatible with the operation type. For example, when using the `sum` accumulator, the specified expression must resolve to a number.
275
+ * @maxSize 1000
276
+ */
277
+ accumulators?: Accumulator[];
278
+ }
279
+ interface Expression extends ExpressionValueOneOf {
280
+ /**
281
+ * Path to the field containing the value to resolve.
282
+ *
283
+ * Use dot notation to specify nested fields. For example, `user.name` or `product.price`.
284
+ * @maxLength 1000
285
+ */
286
+ fieldPath?: string;
287
+ /**
288
+ * Text value.
289
+ * @maxLength 1000
290
+ */
291
+ text?: string;
292
+ /** Number value. */
293
+ numeric?: number;
294
+ /** Adds the specified expressions together. */
295
+ add?: AddOperation;
296
+ /** Calculates the total sum of multiple expressions. */
297
+ sum?: SumOperation;
298
+ /** Subtracts 1 expression from another. */
299
+ subtract?: SubtractOperation;
300
+ /** Multiplies multiple expressions together. */
301
+ multiply?: MultiplyOperation;
302
+ /** Divides 1 expression by another. */
303
+ divide?: DivideOperation;
304
+ /** Finds the absolute value of an expression. */
305
+ abs?: AbsOperation;
306
+ /** Finds the remainder when dividing 1 expression by another. */
307
+ mod?: ModOperation;
308
+ /** Rounds an expression down to the nearest whole number. */
309
+ floor?: FloorOperation;
310
+ /** Rounds an expression up to the nearest whole number. */
311
+ ceil?: CeilOperation;
312
+ /** Joins multiple expressions together to create a string. */
313
+ concat?: ConcatOperation;
314
+ /** Converts an expression to a string. */
315
+ stringify?: StringifyOperation;
316
+ /** Converts an expression to lowercase. */
317
+ toLower?: ToLowerOperation;
318
+ /** Converts an expression to uppercase. */
319
+ toUpper?: ToUpperOperation;
320
+ /** Extracts a portion of a string expression. */
321
+ substring?: SubstringOperation;
322
+ /** Finds the length of a string expression. */
323
+ length?: LengthOperation;
324
+ }
325
+ /** @oneof */
326
+ interface ExpressionValueOneOf {
327
+ /**
328
+ * Path to the field containing the value to resolve.
329
+ *
330
+ * Use dot notation to specify nested fields. For example, `user.name` or `product.price`.
331
+ * @maxLength 1000
332
+ */
333
+ fieldPath?: string;
334
+ /**
335
+ * Text value.
336
+ * @maxLength 1000
337
+ */
338
+ text?: string;
339
+ /** Number value. */
340
+ numeric?: number;
341
+ /** Adds the specified expressions together. */
342
+ add?: AddOperation;
343
+ /** Calculates the total sum of multiple expressions. */
344
+ sum?: SumOperation;
345
+ /** Subtracts 1 expression from another. */
346
+ subtract?: SubtractOperation;
347
+ /** Multiplies multiple expressions together. */
348
+ multiply?: MultiplyOperation;
349
+ /** Divides 1 expression by another. */
350
+ divide?: DivideOperation;
351
+ /** Finds the absolute value of an expression. */
352
+ abs?: AbsOperation;
353
+ /** Finds the remainder when dividing 1 expression by another. */
354
+ mod?: ModOperation;
355
+ /** Rounds an expression down to the nearest whole number. */
356
+ floor?: FloorOperation;
357
+ /** Rounds an expression up to the nearest whole number. */
358
+ ceil?: CeilOperation;
359
+ /** Joins multiple expressions together to create a string. */
360
+ concat?: ConcatOperation;
361
+ /** Converts an expression to a string. */
362
+ stringify?: StringifyOperation;
363
+ /** Converts an expression to lowercase. */
364
+ toLower?: ToLowerOperation;
365
+ /** Converts an expression to uppercase. */
366
+ toUpper?: ToUpperOperation;
367
+ /** Extracts a portion of a string expression. */
368
+ substring?: SubstringOperation;
369
+ /** Finds the length of a string expression. */
370
+ length?: LengthOperation;
371
+ }
372
+ interface AddOperation {
373
+ /**
374
+ * Expressions to add together.
375
+ *
376
+ * All expressions must resolve to numbers.
377
+ * @maxSize 1000
378
+ */
379
+ expressions?: Expression[];
380
+ }
381
+ interface SumOperation {
382
+ /**
383
+ * Expressions to calculate the total sum of.
384
+ *
385
+ * All expressions must resolve to numbers.
386
+ * @maxSize 1000
387
+ */
388
+ expressions?: Expression[];
389
+ }
390
+ interface SubtractOperation {
391
+ /**
392
+ * Expression to subtract `secondExpression` from.
393
+ *
394
+ * Expression must resolve to a number.
395
+ */
396
+ firstExpression?: Expression;
397
+ /**
398
+ * Expression to subtract from `firstExpression`.
399
+ *
400
+ * Expression must resolve to a number.
401
+ */
402
+ secondExpression?: Expression;
403
+ }
404
+ interface MultiplyOperation {
405
+ /**
406
+ * Expressions to multiply.
407
+ *
408
+ * All expressions must resolve to numbers.
409
+ * @maxSize 1000
410
+ */
411
+ expressions?: Expression[];
412
+ }
413
+ interface DivideOperation {
414
+ /**
415
+ * Expression to divide by `secondExpression`.
416
+ *
417
+ * Expression must resolve to a number.
418
+ */
419
+ firstExpression?: Expression;
420
+ /**
421
+ * Expression to divide `firstExpression` by.
422
+ *
423
+ * Expression must resolve to a non-zero number.
424
+ */
425
+ secondExpression?: Expression;
426
+ }
427
+ interface AbsOperation {
428
+ /**
429
+ * Expression to find the absolute value of.
430
+ *
431
+ * Expression must resolve to a number.
432
+ */
433
+ expression?: Expression;
434
+ }
435
+ interface ModOperation {
436
+ /**
437
+ * Expression to divide by `secondExpression` to find the remainder.
438
+ *
439
+ * Expression must resolve to a number.
440
+ */
441
+ firstExpression?: Expression;
442
+ /**
443
+ * Expression to divide `firstExpression` by.
444
+ *
445
+ * Expression must resolve to a non-zero number.
446
+ */
447
+ secondExpression?: Expression;
448
+ }
449
+ interface FloorOperation {
450
+ /**
451
+ * Expression to round down to the nearest whole number.
452
+ *
453
+ * Expression must resolve to a number.
454
+ */
455
+ expression?: Expression;
456
+ }
457
+ interface CeilOperation {
458
+ /**
459
+ * Expression to round up to the nearest whole number.
460
+ *
461
+ * Expression must resolve to a number.
462
+ */
463
+ expression?: Expression;
464
+ }
465
+ interface ConcatOperation {
466
+ /**
467
+ * Expressions to join together.
468
+ *
469
+ * All expressions must resolve to strings.
470
+ * @maxSize 1000
471
+ */
472
+ expressions?: Expression[];
473
+ }
474
+ interface StringifyOperation {
475
+ /** Expression to convert to a string. */
476
+ expression?: Expression;
477
+ }
478
+ interface ToLowerOperation {
479
+ /**
480
+ * Expression to convert to lowercase.
481
+ *
482
+ * Expression must resolve to a string.
483
+ */
484
+ expression?: Expression;
485
+ }
486
+ interface ToUpperOperation {
487
+ /**
488
+ * Expression to convert to uppercase.
489
+ *
490
+ * Expression must resolve to a string.
491
+ */
492
+ expression?: Expression;
493
+ }
494
+ interface SubstringOperation {
495
+ /**
496
+ * Expression to extract a substring from.
497
+ *
498
+ * Expression must resolve to a string.
499
+ */
500
+ expression?: Expression;
501
+ /**
502
+ * Starting position of the substring to extract, specified in zero-based indexing.
503
+ *
504
+ * Expression must resolve to a number.
505
+ */
506
+ startExpression?: Expression;
507
+ /**
508
+ * Number of characters to extract from the starting position.
509
+ *
510
+ * Expression must resolve to a number.
511
+ */
512
+ lengthExpression?: Expression;
513
+ }
514
+ interface LengthOperation {
515
+ /**
516
+ * Expression to count the total number of characters of.
517
+ *
518
+ * Expression must resolve to a string.
519
+ */
520
+ expression?: Expression;
521
+ }
522
+ interface ConditionOperation {
523
+ /** Expression to evaluate as a condition. */
524
+ ifExpression?: Expression;
525
+ /** Expression to return when `ifExpression` resolves to `true`. */
526
+ whenTrue?: Expression;
527
+ /** Expression to return when `ifExpression` resolves to `false`. */
528
+ whenFalse?: Expression;
529
+ }
530
+ interface GreaterThanOperation {
531
+ /** Expression on the left side of the comparison. */
532
+ firstExpression?: Expression;
533
+ /** Expression on the right side of the comparison. */
534
+ secondExpression?: Expression;
535
+ }
536
+ interface SizeOperation {
537
+ /** Expression containing the array whose size to return. */
538
+ expression?: Expression;
539
+ }
540
+ interface GroupId {
541
+ /**
542
+ * Name of the field to group items by.
543
+ *
544
+ * This becomes the field name in the result's `_id` property.
545
+ * @maxLength 1000
546
+ */
547
+ key?: string;
548
+ /** Expression to determine the grouping value. Items whose expression resolves to the same value are grouped together in the result item's `_id` property. */
549
+ expression?: Expression;
550
+ }
551
+ interface Accumulator extends AccumulatorExpressionOneOf {
552
+ /** Calculates the average value across all items in the group based on the specified expression. */
553
+ avg?: Avg;
554
+ /** Finds the minimum value across all items in the group. */
555
+ min?: Min;
556
+ /** Finds the maximum value across all items in the group. */
557
+ max?: Max;
558
+ /** Calculates the sum of the specified expression across all items in the group. */
559
+ sum?: Sum;
560
+ /** Finds the first item in the group. */
561
+ first?: First;
562
+ /** Finds the last item in the group. */
563
+ last?: Last;
564
+ /** Collects values from all items in the group into an array. */
565
+ push?: Push;
566
+ /**
567
+ * Field key in the output item to store the result in.
568
+ * @maxLength 1000
569
+ */
570
+ resultFieldName?: string;
571
+ }
572
+ /** @oneof */
573
+ interface AccumulatorExpressionOneOf {
574
+ /** Calculates the average value across all items in the group based on the specified expression. */
575
+ avg?: Avg;
576
+ /** Finds the minimum value across all items in the group. */
577
+ min?: Min;
578
+ /** Finds the maximum value across all items in the group. */
579
+ max?: Max;
580
+ /** Calculates the sum of the specified expression across all items in the group. */
581
+ sum?: Sum;
582
+ /** Finds the first item in the group. */
583
+ first?: First;
584
+ /** Finds the last item in the group. */
585
+ last?: Last;
586
+ /** Collects values from all items in the group into an array. */
587
+ push?: Push;
588
+ }
589
+ interface Avg {
590
+ /**
591
+ * Expression to calculate the group's average value.
592
+ *
593
+ * Expression must resolve to a number.
594
+ */
595
+ expression?: Expression;
596
+ }
597
+ interface Min {
598
+ /**
599
+ * Expression to find the group's minimum value.
600
+ *
601
+ * Expression must resolve to a comparable value, such as a number or string.
602
+ */
603
+ expression?: Expression;
604
+ }
605
+ interface Max {
606
+ /**
607
+ * Expression to find the group's maximum value.
608
+ *
609
+ * Expression must resolve to a comparable value, such as a number or string.
610
+ */
611
+ expression?: Expression;
612
+ }
613
+ interface Sum {
614
+ /**
615
+ * Expression to calculate the group's total sum.
616
+ *
617
+ * Expression must resolve to a number.
618
+ */
619
+ expression?: Expression;
620
+ }
621
+ interface First {
622
+ /** Expression to find the first item in the group. */
623
+ expression?: Expression;
624
+ }
625
+ interface Last {
626
+ /** Expression to find the last item in the group. */
627
+ expression?: Expression;
628
+ }
629
+ interface Push {
630
+ /** Expression to collect items into an array. */
631
+ expression?: Expression;
632
+ }
633
+ interface Sorting {
634
+ /**
635
+ * Fields to sort the results by.
636
+ * @maxSize 1000
637
+ */
638
+ values?: CommonSorting[];
639
+ }
640
+ interface CommonSorting {
641
+ /**
642
+ * Name of the field to sort by.
643
+ * @minLength 1
644
+ * @maxLength 1000
645
+ */
646
+ fieldName?: string;
647
+ /** Sort order. */
648
+ order?: SortOrderWithLiterals;
649
+ }
650
+ declare enum SortOrder {
651
+ ASC = "ASC",
652
+ DESC = "DESC"
653
+ }
654
+ /** @enumType */
655
+ type SortOrderWithLiterals = SortOrder | 'ASC' | 'DESC';
656
+ /** Transforms collection items by including, excluding, or reshaping fields. */
657
+ interface Projection {
658
+ /**
659
+ * Fields to include, exclude, or reshape.
660
+ * @maxSize 1000
661
+ */
662
+ fields?: Field[];
663
+ }
664
+ interface Include {
665
+ /**
666
+ * Key of the field to include in the result.
667
+ *
668
+ * Use dot notation to specify nested fields. For example, `user.name` or `product.price`. Learn more about [field keys](https://support.wix.com/en/article/cms-formerly-content-manager-about-your-collection-fields#field-id-velo-by-wix-only).
669
+ * @maxLength 1000
670
+ */
671
+ fieldName?: string;
672
+ }
673
+ interface Exclude {
674
+ /**
675
+ * Key of the field to exclude from the result.
676
+ *
677
+ * Use dot notation to specify nested fields. For example, `user.name` or `product.price`. Learn more about [field keys](https://support.wix.com/en/article/cms-formerly-content-manager-about-your-collection-fields#field-id-velo-by-wix-only).
678
+ * @maxLength 1000
679
+ */
680
+ fieldName?: string;
681
+ }
682
+ interface Reshape {
683
+ /**
684
+ * Key of the field to create in the result item.
685
+ *
686
+ * Learn more about [field keys](https://support.wix.com/en/article/cms-formerly-content-manager-about-your-collection-fields#field-id-velo-by-wix-only).
687
+ * @maxLength 1000
688
+ */
689
+ resultFieldName?: string;
690
+ /** Expression to resolve. The result of the expression becomes the value of the new field. */
691
+ expression?: Expression;
692
+ }
693
+ interface ProjectNested {
694
+ /**
695
+ * Key of the parent field for the nested fields.
696
+ *
697
+ * Learn more about [field keys](https://support.wix.com/en/article/cms-formerly-content-manager-about-your-collection-fields#field-id-velo-by-wix-only).
698
+ * @maxLength 1000
699
+ */
700
+ resultFieldName?: string;
701
+ /**
702
+ * Nested fields to include, exclude, or reshape.
703
+ * @maxSize 1000
704
+ */
705
+ fields?: Field[];
706
+ }
707
+ interface Field extends FieldProjectionOneOf {
708
+ /** When specified, includes only the specified field in the result. All other fields are excluded. */
709
+ include?: Include;
710
+ /** When specified, excludes the specified field from the result. All other fields are included. */
711
+ exclude?: Exclude;
712
+ /** Reshapes a new field based on the specified expression. The field used by the expression is not included in the result. */
713
+ reshape?: Reshape;
714
+ /** Creates nested fields by including, excluding, or reshaping fields. */
715
+ projectNested?: ProjectNested;
716
+ }
717
+ /** @oneof */
718
+ interface FieldProjectionOneOf {
719
+ /** When specified, includes only the specified field in the result. All other fields are excluded. */
720
+ include?: Include;
721
+ /** When specified, excludes the specified field from the result. All other fields are included. */
722
+ exclude?: Exclude;
723
+ /** Reshapes a new field based on the specified expression. The field used by the expression is not included in the result. */
724
+ reshape?: Reshape;
725
+ /** Creates nested fields by including, excluding, or reshaping fields. */
726
+ projectNested?: ProjectNested;
727
+ }
728
+ /** Converts an object to an array. */
729
+ interface ObjectToArray {
730
+ /**
731
+ * Key of the object field to convert to an array.
732
+ *
733
+ * Use dot notation to specify nested fields. For example, `user.name` or `product.price`. Learn more about [field keys](https://support.wix.com/en/article/cms-formerly-content-manager-about-your-collection-fields#field-id-velo-by-wix-only).
734
+ * @maxLength 1000
735
+ */
736
+ objectFieldName?: string;
737
+ /**
738
+ * Key of the new array to create in the result item.
739
+ *
740
+ * Learn more about [field keys](https://support.wix.com/en/article/cms-formerly-content-manager-about-your-collection-fields#field-id-velo-by-wix-only).
741
+ * @maxLength 1000
742
+ */
743
+ destinationFieldName?: string;
744
+ }
745
+ /** Unwinds an array. */
746
+ interface UnwindArray {
747
+ /**
748
+ * Key of the array field to unwind.
749
+ *
750
+ * Use dot notation to specify a nested array. For example, `user.products` or `product.colors`. Learn more about [field keys](https://support.wix.com/en/article/cms-formerly-content-manager-about-your-collection-fields#field-id-velo-by-wix-only).
751
+ * @maxLength 1000
752
+ */
753
+ arrayFieldName?: string;
754
+ }
755
+ interface AddFields {
756
+ /**
757
+ * Fields to add or replace in the result items.
758
+ * @maxSize 1000
759
+ */
760
+ fields?: AddField[];
761
+ }
762
+ interface AddField {
763
+ /**
764
+ * Key of the field to add or replace in the result item.
765
+ * @maxLength 1000
766
+ */
767
+ fieldName?: string;
768
+ /** Expression to resolve. The result of the expression becomes the value of the field. */
769
+ expression?: Expression;
770
+ }
771
+ interface Lookup {
772
+ /**
773
+ * ID of the collection to join with.
774
+ * @maxLength 256
775
+ */
776
+ dataCollectionId?: string;
777
+ /**
778
+ * Key of the local field whose value is used for matching items in the joined collection.
779
+ * @maxLength 1000
780
+ */
781
+ localField?: string;
782
+ /**
783
+ * Key of the field in the joined collection to match against the local field value.
784
+ * @maxLength 1000
785
+ */
786
+ foreignField?: string;
787
+ /**
788
+ * Key of the array field where matching joined items are stored.
789
+ * @maxLength 1000
790
+ */
791
+ asField?: string;
792
+ }
793
+ interface UnionWith {
794
+ /**
795
+ * ID of the collection whose results are appended to the current pipeline results.
796
+ * @maxLength 256
797
+ */
798
+ dataCollectionId?: string;
799
+ /** Pipeline to run on the union collection before appending its results. */
800
+ pipeline?: AggregationPipeline;
801
+ }
802
+ interface Paging {
803
+ /** Number of items to load. */
804
+ limit?: number | null;
805
+ /** Number of items to skip in the current sort order. */
806
+ offset?: number | null;
807
+ }
808
+ interface CursorPaging {
809
+ /**
810
+ * Number of items to load.
811
+ * @max 1000
812
+ */
813
+ limit?: number | null;
814
+ /**
815
+ * Pointer to the next or previous page in the list of results.
816
+ *
817
+ * You can get the relevant cursor token
818
+ * from the `pagingMetadata` object in the previous call's response.
819
+ * Not relevant for the first request.
820
+ * @maxLength 150000
821
+ */
822
+ cursor?: string | null;
823
+ }
824
+ interface V1Field {
825
+ /**
826
+ * Field ID.
827
+ *
828
+ * If the field type is `Array`, specify the item index. If the field type is `Object`, specify the field path. Use dot notation to specify nested fields, for example: `data.address.city`.
829
+ * @maxLength 1024
830
+ */
831
+ key?: string;
832
+ /**
833
+ * Field display name.
834
+ *
835
+ * When moving items to CSV files, use this to set the header of the target column.
836
+ * @maxLength 1024
837
+ */
838
+ displayName?: string;
839
+ /**
840
+ * Field data type. Default: `ANY`.
841
+ *
842
+ * Learn more about [data types in Wix Data](https://dev.wix.com/docs/rest/business-solutions/cms/data-types-in-wix-data).
843
+ */
844
+ fieldType?: FieldTypeWithLiterals;
845
+ }
846
+ declare enum FieldType {
847
+ /** Any data type. */
848
+ ANY = "ANY",
849
+ /** String. */
850
+ STRING = "STRING",
851
+ /** Number. */
852
+ NUMBER = "NUMBER",
853
+ /** Boolean. */
854
+ BOOLEAN = "BOOLEAN",
855
+ /** Date string in ISO 8601 date format: `YYYY-MM-DD`. */
856
+ DATE = "DATE",
857
+ /** [Date object](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/Date) (SDK) or an object in the following format: `"someFieldKey": { "$date": "YYYY-MM-DDTHH:mm:ss.sssZ"}`. */
858
+ DATETIME = "DATETIME",
859
+ /** Binary file. */
860
+ BINARY = "BINARY",
861
+ /** object. */
862
+ OBJECT = "OBJECT",
863
+ /** Array. */
864
+ ARRAY = "ARRAY",
865
+ /** Web URL. */
866
+ URL = "URL",
867
+ WIX_MEDIA_URL = "WIX_MEDIA_URL",
868
+ WIX_MEDIA_IMAGE_URL = "WIX_MEDIA_IMAGE_URL",
869
+ WIX_MEDIA_VIDEO_URL = "WIX_MEDIA_VIDEO_URL",
870
+ WIX_MEDIA_DOCUMENT_URL = "WIX_MEDIA_DOCUMENT_URL",
871
+ IMAGE_URL = "IMAGE_URL",
872
+ VIDEO_URL = "VIDEO_URL"
873
+ }
874
+ /** @enumType */
875
+ type FieldTypeWithLiterals = FieldType | 'ANY' | 'STRING' | 'NUMBER' | 'BOOLEAN' | 'DATE' | 'DATETIME' | 'BINARY' | 'OBJECT' | 'ARRAY' | 'URL' | 'WIX_MEDIA_URL' | 'WIX_MEDIA_IMAGE_URL' | 'WIX_MEDIA_VIDEO_URL' | 'WIX_MEDIA_DOCUMENT_URL' | 'IMAGE_URL' | 'VIDEO_URL';
166
876
  declare enum WixDataEnvironment {
167
877
  /** Collection's [live environment](https://support.wix.com/en/article/cms-about-sandbox-and-live-collections-and-syncing#sandbox-collections). */
168
878
  LIVE = "LIVE",
@@ -171,6 +881,28 @@ declare enum WixDataEnvironment {
171
881
  }
172
882
  /** @enumType */
173
883
  type WixDataEnvironmentWithLiterals = WixDataEnvironment | 'LIVE' | 'SANDBOX';
884
+ /** Filter and field selection query. */
885
+ interface FilterQuery {
886
+ /**
887
+ * Filter to apply to the items. Only items that pass the filter are moved.
888
+ *
889
+ * Learn more about building a query filter using [API Query Language](https://dev.wix.com/docs/rest/articles/getting-started/api-query-language#filters).
890
+ */
891
+ filter?: Record<string, any> | null;
892
+ /** Item fields to move. If not set, the method moves the full items. */
893
+ fields?: string[];
894
+ }
895
+ interface AggregationQuery {
896
+ /** Aggregation pipeline to run on the collection. */
897
+ aggregationPipeline?: AggregationPipeline;
898
+ /**
899
+ * Fields, will be used to map aggregation pipeline result to export result.
900
+ * Fields in the aggregation pipeline results that are not in the provided list will be ignored.
901
+ * If no fields provided, data will be exported as is, without transformation or field name mapping.
902
+ * @maxSize 1000
903
+ */
904
+ fields?: V1Field[];
905
+ }
174
906
  declare enum FileFormat {
175
907
  /** Unknown format. */
176
908
  UNKNOWN = "UNKNOWN",
@@ -196,7 +928,11 @@ declare enum MediaType {
196
928
  /** @enumType */
197
929
  type MediaTypeWithLiterals = MediaType | 'ALL' | 'IMAGE' | 'VIDEO' | 'AUDIO' | 'DOCUMENT';
198
930
  /** Wix data collection. */
199
- interface WixDataSource {
931
+ interface WixDataSource extends WixDataSourceQueryOneOf {
932
+ /** Filter and field selection to apply to the collection items. */
933
+ filterQuery?: FilterQuery;
934
+ /** Aggregation pipeline to run on the collection. */
935
+ aggregationQuery?: AggregationQuery;
200
936
  /**
201
937
  * ID of the data collection.
202
938
  * @minLength 1
@@ -207,11 +943,27 @@ interface WixDataSource {
207
943
  * Filter to apply to the items. Only items that pass the filter are moved.
208
944
  *
209
945
  * Learn more about building a query filter using [API Query Language](https://dev.wix.com/docs/rest/articles/getting-started/api-query-language#filters).
946
+ * Deprecated: Use `filter_query.filter` instead.
947
+ * @deprecated
948
+ * @replacedBy filter_query
949
+ * @targetRemovalDate 2027-01-01
210
950
  */
211
951
  filter?: Record<string, any> | null;
212
- /** Item fields to move. If not set, the method moves the full items. */
952
+ /**
953
+ * Deprecated: Use `filter_query.fields` instead.
954
+ * @deprecated
955
+ * @replacedBy filter_query
956
+ * @targetRemovalDate 2027-01-01
957
+ */
213
958
  fields?: string[];
214
959
  }
960
+ /** @oneof */
961
+ interface WixDataSourceQueryOneOf {
962
+ /** Filter and field selection to apply to the collection items. */
963
+ filterQuery?: FilterQuery;
964
+ /** Aggregation pipeline to run on the collection. */
965
+ aggregationQuery?: AggregationQuery;
966
+ }
215
967
  interface LocalizationSource {
216
968
  /**
217
969
  * Translated CMS content in the specified languages. Content in these languages is exported to the destination, with the first specified language treated as the main one.
@@ -418,60 +1170,8 @@ interface Schema {
418
1170
  * Item fields to move to the destination file.
419
1171
  * @maxSize 1000
420
1172
  */
421
- fields?: Field[];
1173
+ fields?: V1Field[];
422
1174
  }
423
- interface Field {
424
- /**
425
- * Field ID.
426
- *
427
- * If the field type is `Array`, specify the item index. If the field type is `Object`, specify the field path. Use dot notation to specify nested fields, for example: `data.address.city`.
428
- * @maxLength 1024
429
- */
430
- key?: string;
431
- /**
432
- * Field display name.
433
- *
434
- * When moving items to CSV files, use this to set the header of the target column.
435
- * @maxLength 1024
436
- */
437
- displayName?: string;
438
- /**
439
- * Field data type. Default: `ANY`.
440
- *
441
- * Learn more about [data types in Wix Data](https://dev.wix.com/docs/rest/business-solutions/cms/data-types-in-wix-data).
442
- */
443
- fieldType?: FieldTypeWithLiterals;
444
- }
445
- declare enum FieldType {
446
- /** Any data type. */
447
- ANY = "ANY",
448
- /** String. */
449
- STRING = "STRING",
450
- /** Number. */
451
- NUMBER = "NUMBER",
452
- /** Boolean. */
453
- BOOLEAN = "BOOLEAN",
454
- /** Date string in ISO 8601 date format: `YYYY-MM-DD`. */
455
- DATE = "DATE",
456
- /** [Date object](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/Date) (SDK) or an object in the following format: `"someFieldKey": { "$date": "YYYY-MM-DDTHH:mm:ss.sssZ"}`. */
457
- DATETIME = "DATETIME",
458
- /** Binary file. */
459
- BINARY = "BINARY",
460
- /** object. */
461
- OBJECT = "OBJECT",
462
- /** Array. */
463
- ARRAY = "ARRAY",
464
- /** Web URL. */
465
- URL = "URL",
466
- WIX_MEDIA_URL = "WIX_MEDIA_URL",
467
- WIX_MEDIA_IMAGE_URL = "WIX_MEDIA_IMAGE_URL",
468
- WIX_MEDIA_VIDEO_URL = "WIX_MEDIA_VIDEO_URL",
469
- WIX_MEDIA_DOCUMENT_URL = "WIX_MEDIA_DOCUMENT_URL",
470
- IMAGE_URL = "IMAGE_URL",
471
- VIDEO_URL = "VIDEO_URL"
472
- }
473
- /** @enumType */
474
- type FieldTypeWithLiterals = FieldType | 'ANY' | 'STRING' | 'NUMBER' | 'BOOLEAN' | 'DATE' | 'DATETIME' | 'BINARY' | 'OBJECT' | 'ARRAY' | 'URL' | 'WIX_MEDIA_URL' | 'WIX_MEDIA_IMAGE_URL' | 'WIX_MEDIA_VIDEO_URL' | 'WIX_MEDIA_DOCUMENT_URL' | 'IMAGE_URL' | 'VIDEO_URL';
475
1175
  interface StoresCatalogProductsDestination {
476
1176
  }
477
1177
  /** Wix Media Manager destination. */
@@ -614,11 +1314,11 @@ interface ListScheduledDataWorkflowsRequest {
614
1314
  */
615
1315
  fields?: FieldsWithLiterals[];
616
1316
  /** Reserved for future server-side paging support. Currently ignored. */
617
- paging?: CursorPaging;
1317
+ paging?: CommonCursorPaging;
618
1318
  /** Reserved for future server-side filtering support. Currently ignored. */
619
1319
  filter?: Record<string, any> | null;
620
1320
  }
621
- interface CursorPaging {
1321
+ interface CommonCursorPaging {
622
1322
  /**
623
1323
  * Maximum number of items to return in the results.
624
1324
  * @max 100
@@ -1038,9 +1738,9 @@ interface ListScheduledDataWorkflowsOptions {
1038
1738
  */
1039
1739
  fields?: FieldsWithLiterals[];
1040
1740
  /** Reserved for future server-side paging support. Currently ignored. */
1041
- paging?: CursorPaging;
1741
+ paging?: CommonCursorPaging;
1042
1742
  /** Reserved for future server-side filtering support. Currently ignored. */
1043
1743
  filter?: Record<string, any> | null;
1044
1744
  }
1045
1745
 
1046
- export { type AccountInfo, type AccountInfoMetadata, type ActionEvent, type BaseEventMetadata, type CreateScheduledDataWorkflowOptions, type CreateScheduledDataWorkflowRequest, type CreateScheduledDataWorkflowResponse, type CursorPaging, type CursorPagingMetadata, type Cursors, type DataMovementJobLogs, type DeleteScheduledDataWorkflowRequest, type DeleteScheduledDataWorkflowResponse, type Destination, type DestinationDestinationOneOf, type DomainEvent, type DomainEventBodyOneOf, type EntityCreatedEvent, type EntityDeletedEvent, type EntityUpdatedEvent, type EventMetadata, type ExternalFileSource, type Field, FieldType, type FieldTypeWithLiterals, Fields, type FieldsWithLiterals, type FileDestination, FileFormat, type FileFormatWithLiterals, type FileSource, type GetScheduledDataWorkflowOptions, type GetScheduledDataWorkflowRequest, type GetScheduledDataWorkflowResponse, type GoogleSheetsSource, type IdentificationData, type IdentificationDataIdOneOf, type JobSpec, type JobSpecSiteOverrideOneOf, type JobsCreatedEnvelope, type JobsDeletedEnvelope, type JobsUpdatedEnvelope, type ListScheduledDataWorkflowsOptions, type ListScheduledDataWorkflowsRequest, type ListScheduledDataWorkflowsResponse, type LocalizationDestination, type LocalizationSource, MediaType, type MediaTypeWithLiterals, type MessageEnvelope, type RescheduleScheduledDataWorkflowOptions, type RescheduleScheduledDataWorkflowRequest, type RescheduleScheduledDataWorkflowResponse, type RestoreInfo, type ScheduledDataWorkflow, type ScheduledDataWorkflowSpec, type Schema, type Source, type SourceSourceOneOf, type StoresCatalogInventoryDestination, type StoresCatalogProductsDestination, type TestDestination, type TestSource, type TestTransformation, type Transformation, type TransformationTransformationOneOf, type TriggerScheduledDataWorkflowNowRequest, type TriggerScheduledDataWorkflowNowResponse, type UpdateScheduledDataWorkflowOptions, type UpdateScheduledDataWorkflowRequest, type UpdateScheduledDataWorkflowResponse, WebhookIdentityType, type WebhookIdentityTypeWithLiterals, type WixDataCollectionDefinitionDestination, type WixDataCollectionDefinitionSource, type WixDataDestination, WixDataDestinationWritePolicy, type WixDataDestinationWritePolicyWithLiterals, WixDataEnvironment, type WixDataEnvironmentWithLiterals, type WixDataSource, type WixMediaDestination, WixMediaDestinationWritePolicy, type WixMediaDestinationWritePolicyWithLiterals, type WixMediaSource, WritePolicy, type WritePolicyWithLiterals, createScheduledDataWorkflow, deleteScheduledDataWorkflow, getScheduledDataWorkflow, listScheduledDataWorkflows, onJobsCreated, onJobsDeleted, onJobsUpdated, rescheduleScheduledDataWorkflow, triggerScheduledDataWorkflowNow, updateScheduledDataWorkflow };
1746
+ export { type AbsOperation, type AccountInfo, type AccountInfoMetadata, type Accumulator, type AccumulatorExpressionOneOf, type ActionEvent, type AddField, type AddFields, type AddOperation, type AggregationPipeline, type AggregationPipelinePagingMethodOneOf, type AggregationQuery, type Avg, type BaseEventMetadata, type CeilOperation, type CommonCursorPaging, type CommonSorting, type ConcatOperation, type ConditionOperation, type CreateScheduledDataWorkflowOptions, type CreateScheduledDataWorkflowRequest, type CreateScheduledDataWorkflowResponse, type CursorPaging, type CursorPagingMetadata, type Cursors, type DataMovementJobLogs, type DeleteScheduledDataWorkflowRequest, type DeleteScheduledDataWorkflowResponse, type Destination, type DestinationDestinationOneOf, type DivideOperation, type DomainEvent, type DomainEventBodyOneOf, type EntityCreatedEvent, type EntityDeletedEvent, type EntityUpdatedEvent, type EventMetadata, type Exclude, type Expression, type ExpressionValueOneOf, type ExternalFileSource, type Field, type FieldProjectionOneOf, FieldType, type FieldTypeWithLiterals, Fields, type FieldsWithLiterals, type FileDestination, FileFormat, type FileFormatWithLiterals, type FileSource, type FilterQuery, type First, type FloorOperation, type GetScheduledDataWorkflowOptions, type GetScheduledDataWorkflowRequest, type GetScheduledDataWorkflowResponse, type GoogleSheetsSource, type GreaterThanOperation, type Group, type GroupId, type IdentificationData, type IdentificationDataIdOneOf, type Include, type JobSpec, type JobSpecSiteOverrideOneOf, type JobsCreatedEnvelope, type JobsDeletedEnvelope, type JobsUpdatedEnvelope, type Last, type LengthOperation, type ListScheduledDataWorkflowsOptions, type ListScheduledDataWorkflowsRequest, type ListScheduledDataWorkflowsResponse, type LocalizationDestination, type LocalizationSource, type Lookup, type Max, MediaType, type MediaTypeWithLiterals, type MessageEnvelope, type Min, type ModOperation, type MultiplyOperation, type ObjectToArray, type Paging, type ProjectNested, type Projection, type Push, type RescheduleScheduledDataWorkflowOptions, type RescheduleScheduledDataWorkflowRequest, type RescheduleScheduledDataWorkflowResponse, type Reshape, type RestoreInfo, type ScheduledDataWorkflow, type ScheduledDataWorkflowSpec, type Schema, type SizeOperation, SortOrder, type SortOrderWithLiterals, type Sorting, type Source, type SourceSourceOneOf, type Stage, type StageStageOneOf, type StoresCatalogInventoryDestination, type StoresCatalogProductsDestination, type StringifyOperation, type SubstringOperation, type SubtractOperation, type Sum, type SumOperation, type TestDestination, type TestSource, type TestTransformation, type ToLowerOperation, type ToUpperOperation, type Transformation, type TransformationTransformationOneOf, type TriggerScheduledDataWorkflowNowRequest, type TriggerScheduledDataWorkflowNowResponse, type UnionWith, type UnwindArray, type UpdateScheduledDataWorkflowOptions, type UpdateScheduledDataWorkflowRequest, type UpdateScheduledDataWorkflowResponse, type V1Field, WebhookIdentityType, type WebhookIdentityTypeWithLiterals, type WixDataCollectionDefinitionDestination, type WixDataCollectionDefinitionSource, type WixDataDestination, WixDataDestinationWritePolicy, type WixDataDestinationWritePolicyWithLiterals, WixDataEnvironment, type WixDataEnvironmentWithLiterals, type WixDataSource, type WixDataSourceQueryOneOf, type WixMediaDestination, WixMediaDestinationWritePolicy, type WixMediaDestinationWritePolicyWithLiterals, type WixMediaSource, WritePolicy, type WritePolicyWithLiterals, createScheduledDataWorkflow, deleteScheduledDataWorkflow, getScheduledDataWorkflow, listScheduledDataWorkflows, onJobsCreated, onJobsDeleted, onJobsUpdated, rescheduleScheduledDataWorkflow, triggerScheduledDataWorkflowNow, updateScheduledDataWorkflow };