@codiac.io/codiac-cli 1.2.233 → 1.2.235

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 (44) hide show
  1. package/README.md +1 -1
  2. package/dist/apis/codiac-api/gen/contracts.d.ts +933 -300
  3. package/dist/apis/codiac-api/gen/contracts.js.map +1 -1
  4. package/dist/apis/codiac-relay/gen/client.d.ts +8 -1
  5. package/dist/apis/codiac-relay/gen/client.js +55 -13
  6. package/dist/apis/codiac-relay/gen/client.js.map +1 -1
  7. package/dist/apis/codiac-relay/gen/contracts.d.ts +233 -11
  8. package/dist/apis/codiac-relay/gen/contracts.js +55 -2
  9. package/dist/apis/codiac-relay/gen/contracts.js.map +1 -1
  10. package/dist/command-base-enterprise.d.ts +6 -0
  11. package/dist/command-base-enterprise.js +14 -0
  12. package/dist/command-base-enterprise.js.map +1 -1
  13. package/dist/commands/cluster/scaling/update.d.ts +1 -7
  14. package/dist/commands/cluster/scaling/update.js +46 -72
  15. package/dist/commands/cluster/scaling/update.js.map +1 -1
  16. package/dist/commands/config/add.d.ts +14 -0
  17. package/dist/commands/config/add.js +92 -3
  18. package/dist/commands/config/add.js.map +1 -1
  19. package/dist/commands/noc/cluster/create.d.ts +1 -0
  20. package/dist/commands/noc/cluster/create.js +7 -3
  21. package/dist/commands/noc/cluster/create.js.map +1 -1
  22. package/dist/commands/noc/cluster/forget.js +1 -1
  23. package/dist/commands/noc/cluster/forget.js.map +1 -1
  24. package/dist/relay/relay-container.js +1 -1
  25. package/dist/relay/wsclient/relay-queue-manager.d.ts +21 -0
  26. package/dist/relay/wsclient/relay-queue-manager.js +61 -0
  27. package/dist/relay/wsclient/relay-queue-manager.js.map +1 -0
  28. package/dist/uilogic/builtin-config-schemas.d.ts +12 -0
  29. package/dist/uilogic/builtin-config-schemas.js +96 -0
  30. package/dist/uilogic/builtin-config-schemas.js.map +1 -0
  31. package/dist/uilogic/config-ui-utils.d.ts +4 -1
  32. package/dist/uilogic/config-ui-utils.js +33 -10
  33. package/dist/uilogic/config-ui-utils.js.map +1 -1
  34. package/dist/uilogic/lrp-watcher-predef.d.ts +22 -0
  35. package/dist/uilogic/lrp-watcher-predef.js +157 -0
  36. package/dist/uilogic/lrp-watcher-predef.js.map +1 -0
  37. package/dist/uilogic/lrp-watcher-utils.d.ts +16 -0
  38. package/dist/uilogic/lrp-watcher-utils.js +30 -0
  39. package/dist/uilogic/lrp-watcher-utils.js.map +1 -0
  40. package/dist/uilogic/lrp-watcher.d.ts +22 -0
  41. package/dist/uilogic/lrp-watcher.js +143 -0
  42. package/dist/uilogic/lrp-watcher.js.map +1 -0
  43. package/oclif.manifest.json +14 -2
  44. package/package.json +4 -2
@@ -27,16 +27,28 @@ export interface ActivityCriteriaBase {
27
27
  assetsName?: string | undefined;
28
28
  ids?: string[] | undefined;
29
29
  all?: boolean | undefined;
30
- /** Specification for the sort order of a query.
31
- *
32
- * Example: ```{ "color": "asc", size: OrderEnum.desc }```
33
- *
34
- * Example: ```"color"```
30
+ /** supports a single field name
31
+ * ```json
32
+ * "sort": "name"
33
+ * ```
34
+ * or an array of field names
35
+ * ```json
36
+ * "sort": ["name", "lastModified~desc"]
37
+ * ```
38
+ * or an object dictionary of `fieldName: asc|desc` pairs, eg:
39
+ * ```json
40
+ * "sort": {
41
+ * "name": "asc",
42
+ * "lastModified": "desc"
43
+ * }
44
+ * ```
35
45
  *
36
- * Example: ```[ "color", "lastName" ]``` */
46
+ * NOTE: Regarding sort field order, (aka: `asc|desc`) : Sort field names can be specified as EITHER: field name alone (implies asc order), eg: `"favColor"`, OR field name with order suffix `asc|desc` (delimited by tilde). eg: `"favColor~desc"`. */
37
47
  sort?: string[] | "asc" | "desc" | string | undefined;
38
48
  skip?: number | undefined;
39
49
  take?: number | undefined;
50
+ /** Declares that the data be returned in the opposite order than what is specified by the `sort` property. */
51
+ reverse?: number | boolean | undefined;
40
52
  }
41
53
  export declare enum ActivityTypeEnum {
42
54
  cabinetCreate = "cabinetCreate",
@@ -193,16 +205,28 @@ export interface AssetCriteria {
193
205
  hasIngress?: boolean | undefined;
194
206
  ids?: string[] | undefined;
195
207
  all?: boolean | undefined;
196
- /** Specification for the sort order of a query.
197
- *
198
- * Example: ```{ "color": "asc", size: OrderEnum.desc }```
199
- *
200
- * Example: ```"color"```
208
+ /** supports a single field name
209
+ * ```json
210
+ * "sort": "name"
211
+ * ```
212
+ * or an array of field names
213
+ * ```json
214
+ * "sort": ["name", "lastModified~desc"]
215
+ * ```
216
+ * or an object dictionary of `fieldName: asc|desc` pairs, eg:
217
+ * ```json
218
+ * "sort": {
219
+ * "name": "asc",
220
+ * "lastModified": "desc"
221
+ * }
222
+ * ```
201
223
  *
202
- * Example: ```[ "color", "lastName" ]``` */
224
+ * NOTE: Regarding sort field order, (aka: `asc|desc`) : Sort field names can be specified as EITHER: field name alone (implies asc order), eg: `"favColor"`, OR field name with order suffix `asc|desc` (delimited by tilde). eg: `"favColor~desc"`. */
203
225
  sort?: string[] | "asc" | "desc" | string | undefined;
204
226
  skip?: number | undefined;
205
227
  take?: number | undefined;
228
+ /** Declares that the data be returned in the opposite order than what is specified by the `sort` property. */
229
+ reverse?: number | boolean | undefined;
206
230
  }
207
231
  /** Abstract declarations of folder paths inside the image
208
232
  * that are to be later mapped (at configuration time) to file store definitions. */
@@ -275,16 +299,28 @@ export interface AssetVersionConfigCriteria {
275
299
  labels?: object | undefined;
276
300
  ids?: string[] | undefined;
277
301
  all?: boolean | undefined;
278
- /** Specification for the sort order of a query.
279
- *
280
- * Example: ```{ "color": "asc", size: OrderEnum.desc }```
281
- *
282
- * Example: ```"color"```
302
+ /** supports a single field name
303
+ * ```json
304
+ * "sort": "name"
305
+ * ```
306
+ * or an array of field names
307
+ * ```json
308
+ * "sort": ["name", "lastModified~desc"]
309
+ * ```
310
+ * or an object dictionary of `fieldName: asc|desc` pairs, eg:
311
+ * ```json
312
+ * "sort": {
313
+ * "name": "asc",
314
+ * "lastModified": "desc"
315
+ * }
316
+ * ```
283
317
  *
284
- * Example: ```[ "color", "lastName" ]``` */
318
+ * NOTE: Regarding sort field order, (aka: `asc|desc`) : Sort field names can be specified as EITHER: field name alone (implies asc order), eg: `"favColor"`, OR field name with order suffix `asc|desc` (delimited by tilde). eg: `"favColor~desc"`. */
285
319
  sort?: string[] | "asc" | "desc" | string | undefined;
286
320
  skip?: number | undefined;
287
321
  take?: number | undefined;
322
+ /** Declares that the data be returned in the opposite order than what is specified by the `sort` property. */
323
+ reverse?: number | boolean | undefined;
288
324
  }
289
325
  export interface AuthenticationRequest {
290
326
  login: string;
@@ -341,6 +377,39 @@ export interface AuthTenant {
341
377
  id?: string | undefined;
342
378
  Users?: TenantUser[] | undefined;
343
379
  }
380
+ export interface AwsTenantProfile {
381
+ provider: CloudProviderEnum;
382
+ /** Id code for the tenant account with the cloud service provider
383
+ * (This is NOT the Codiac tenant code). */
384
+ cspTenantId: string;
385
+ notes?: string | undefined;
386
+ id?: string | undefined;
387
+ createdBy: string;
388
+ modifiedBy: string;
389
+ created: Date;
390
+ modified: Date;
391
+ }
392
+ export interface AzureClientSecret {
393
+ id: string;
394
+ value: string;
395
+ expires: string;
396
+ }
397
+ export interface AzureTenantProfile {
398
+ /** The ApplicationId assigned to Codiac when it was registered in AzureAD. */
399
+ clientId: string;
400
+ authority: string;
401
+ clientSecret: AzureClientSecret;
402
+ provider: CloudProviderEnum;
403
+ /** Id code for the tenant account with the cloud service provider
404
+ * (This is NOT the Codiac tenant code). */
405
+ cspTenantId: string;
406
+ notes?: string | undefined;
407
+ id?: string | undefined;
408
+ createdBy: string;
409
+ modifiedBy: string;
410
+ created: Date;
411
+ modified: Date;
412
+ }
344
413
  export interface Buffer {
345
414
  }
346
415
  export interface Build {
@@ -355,16 +424,28 @@ export interface BuildCriteria {
355
424
  name?: StringFilter | undefined;
356
425
  ids?: string[] | undefined;
357
426
  all?: boolean | undefined;
358
- /** Specification for the sort order of a query.
359
- *
360
- * Example: ```{ "color": "asc", size: OrderEnum.desc }```
361
- *
362
- * Example: ```"color"```
427
+ /** supports a single field name
428
+ * ```json
429
+ * "sort": "name"
430
+ * ```
431
+ * or an array of field names
432
+ * ```json
433
+ * "sort": ["name", "lastModified~desc"]
434
+ * ```
435
+ * or an object dictionary of `fieldName: asc|desc` pairs, eg:
436
+ * ```json
437
+ * "sort": {
438
+ * "name": "asc",
439
+ * "lastModified": "desc"
440
+ * }
441
+ * ```
363
442
  *
364
- * Example: ```[ "color", "lastName" ]``` */
443
+ * NOTE: Regarding sort field order, (aka: `asc|desc`) : Sort field names can be specified as EITHER: field name alone (implies asc order), eg: `"favColor"`, OR field name with order suffix `asc|desc` (delimited by tilde). eg: `"favColor~desc"`. */
365
444
  sort?: string[] | "asc" | "desc" | string | undefined;
366
445
  skip?: number | undefined;
367
446
  take?: number | undefined;
447
+ /** Declares that the data be returned in the opposite order than what is specified by the `sort` property. */
448
+ reverse?: number | boolean | undefined;
368
449
  }
369
450
  export interface BuildPipeline {
370
451
  name: string;
@@ -378,16 +459,28 @@ export interface BuildPipelineCriteria {
378
459
  name?: StringFilter | undefined;
379
460
  ids?: string[] | undefined;
380
461
  all?: boolean | undefined;
381
- /** Specification for the sort order of a query.
382
- *
383
- * Example: ```{ "color": "asc", size: OrderEnum.desc }```
384
- *
385
- * Example: ```"color"```
462
+ /** supports a single field name
463
+ * ```json
464
+ * "sort": "name"
465
+ * ```
466
+ * or an array of field names
467
+ * ```json
468
+ * "sort": ["name", "lastModified~desc"]
469
+ * ```
470
+ * or an object dictionary of `fieldName: asc|desc` pairs, eg:
471
+ * ```json
472
+ * "sort": {
473
+ * "name": "asc",
474
+ * "lastModified": "desc"
475
+ * }
476
+ * ```
386
477
  *
387
- * Example: ```[ "color", "lastName" ]``` */
478
+ * NOTE: Regarding sort field order, (aka: `asc|desc`) : Sort field names can be specified as EITHER: field name alone (implies asc order), eg: `"favColor"`, OR field name with order suffix `asc|desc` (delimited by tilde). eg: `"favColor~desc"`. */
388
479
  sort?: string[] | "asc" | "desc" | string | undefined;
389
480
  skip?: number | undefined;
390
481
  take?: number | undefined;
482
+ /** Declares that the data be returned in the opposite order than what is specified by the `sort` property. */
483
+ reverse?: number | boolean | undefined;
391
484
  }
392
485
  /** A placeholder configuring an isolated instance of a fully functional,
393
486
  * independent implementation of the customer's service inventory.
@@ -501,16 +594,28 @@ export interface CabinetCreateActivityCriteria {
501
594
  assetsName?: string | undefined;
502
595
  ids?: string[] | undefined;
503
596
  all?: boolean | undefined;
504
- /** Specification for the sort order of a query.
505
- *
506
- * Example: ```{ "color": "asc", size: OrderEnum.desc }```
507
- *
508
- * Example: ```"color"```
597
+ /** supports a single field name
598
+ * ```json
599
+ * "sort": "name"
600
+ * ```
601
+ * or an array of field names
602
+ * ```json
603
+ * "sort": ["name", "lastModified~desc"]
604
+ * ```
605
+ * or an object dictionary of `fieldName: asc|desc` pairs, eg:
606
+ * ```json
607
+ * "sort": {
608
+ * "name": "asc",
609
+ * "lastModified": "desc"
610
+ * }
611
+ * ```
509
612
  *
510
- * Example: ```[ "color", "lastName" ]``` */
613
+ * NOTE: Regarding sort field order, (aka: `asc|desc`) : Sort field names can be specified as EITHER: field name alone (implies asc order), eg: `"favColor"`, OR field name with order suffix `asc|desc` (delimited by tilde). eg: `"favColor~desc"`. */
511
614
  sort?: string[] | "asc" | "desc" | string | undefined;
512
615
  skip?: number | undefined;
513
616
  take?: number | undefined;
617
+ /** Declares that the data be returned in the opposite order than what is specified by the `sort` property. */
618
+ reverse?: number | boolean | undefined;
514
619
  }
515
620
  export interface CabinetCriteria {
516
621
  name?: StringFilter | undefined;
@@ -520,16 +625,28 @@ export interface CabinetCriteria {
520
625
  branch?: StringFilter | undefined;
521
626
  ids?: string[] | undefined;
522
627
  all?: boolean | undefined;
523
- /** Specification for the sort order of a query.
524
- *
525
- * Example: ```{ "color": "asc", size: OrderEnum.desc }```
526
- *
527
- * Example: ```"color"```
628
+ /** supports a single field name
629
+ * ```json
630
+ * "sort": "name"
631
+ * ```
632
+ * or an array of field names
633
+ * ```json
634
+ * "sort": ["name", "lastModified~desc"]
635
+ * ```
636
+ * or an object dictionary of `fieldName: asc|desc` pairs, eg:
637
+ * ```json
638
+ * "sort": {
639
+ * "name": "asc",
640
+ * "lastModified": "desc"
641
+ * }
642
+ * ```
528
643
  *
529
- * Example: ```[ "color", "lastName" ]``` */
644
+ * NOTE: Regarding sort field order, (aka: `asc|desc`) : Sort field names can be specified as EITHER: field name alone (implies asc order), eg: `"favColor"`, OR field name with order suffix `asc|desc` (delimited by tilde). eg: `"favColor~desc"`. */
530
645
  sort?: string[] | "asc" | "desc" | string | undefined;
531
646
  skip?: number | undefined;
532
647
  take?: number | undefined;
648
+ /** Declares that the data be returned in the opposite order than what is specified by the `sort` property. */
649
+ reverse?: number | boolean | undefined;
533
650
  }
534
651
  /** The host naming strategies applicable in a given cabinet.
535
652
  *
@@ -549,16 +666,28 @@ export interface CabinetHostNameConfigCriteria {
549
666
  strategy?: string | undefined;
550
667
  ids?: string[] | undefined;
551
668
  all?: boolean | undefined;
552
- /** Specification for the sort order of a query.
553
- *
554
- * Example: ```{ "color": "asc", size: OrderEnum.desc }```
555
- *
556
- * Example: ```"color"```
669
+ /** supports a single field name
670
+ * ```json
671
+ * "sort": "name"
672
+ * ```
673
+ * or an array of field names
674
+ * ```json
675
+ * "sort": ["name", "lastModified~desc"]
676
+ * ```
677
+ * or an object dictionary of `fieldName: asc|desc` pairs, eg:
678
+ * ```json
679
+ * "sort": {
680
+ * "name": "asc",
681
+ * "lastModified": "desc"
682
+ * }
683
+ * ```
557
684
  *
558
- * Example: ```[ "color", "lastName" ]``` */
685
+ * NOTE: Regarding sort field order, (aka: `asc|desc`) : Sort field names can be specified as EITHER: field name alone (implies asc order), eg: `"favColor"`, OR field name with order suffix `asc|desc` (delimited by tilde). eg: `"favColor~desc"`. */
559
686
  sort?: string[] | "asc" | "desc" | string | undefined;
560
687
  skip?: number | undefined;
561
688
  take?: number | undefined;
689
+ /** Declares that the data be returned in the opposite order than what is specified by the `sort` property. */
690
+ reverse?: number | boolean | undefined;
562
691
  }
563
692
  /** Attributes for referencing and creating actual running resources that comprise the infrastructure for a cabinet.
564
693
  * That is, this is the pertinent information required to manage an actual physical implementation of a cabinet. */
@@ -600,16 +729,28 @@ export interface CabinetScopesCriteria {
600
729
  scope?: Scope | undefined;
601
730
  ids?: string[] | undefined;
602
731
  all?: boolean | undefined;
603
- /** Specification for the sort order of a query.
604
- *
605
- * Example: ```{ "color": "asc", size: OrderEnum.desc }```
606
- *
607
- * Example: ```"color"```
732
+ /** supports a single field name
733
+ * ```json
734
+ * "sort": "name"
735
+ * ```
736
+ * or an array of field names
737
+ * ```json
738
+ * "sort": ["name", "lastModified~desc"]
739
+ * ```
740
+ * or an object dictionary of `fieldName: asc|desc` pairs, eg:
741
+ * ```json
742
+ * "sort": {
743
+ * "name": "asc",
744
+ * "lastModified": "desc"
745
+ * }
746
+ * ```
608
747
  *
609
- * Example: ```[ "color", "lastName" ]``` */
748
+ * NOTE: Regarding sort field order, (aka: `asc|desc`) : Sort field names can be specified as EITHER: field name alone (implies asc order), eg: `"favColor"`, OR field name with order suffix `asc|desc` (delimited by tilde). eg: `"favColor~desc"`. */
610
749
  sort?: string[] | "asc" | "desc" | string | undefined;
611
750
  skip?: number | undefined;
612
751
  take?: number | undefined;
752
+ /** Declares that the data be returned in the opposite order than what is specified by the `sort` property. */
753
+ reverse?: number | boolean | undefined;
613
754
  }
614
755
  export interface ChangePasswordRequest {
615
756
  login: string;
@@ -650,16 +791,28 @@ export interface ClusterCriteria {
650
791
  managedResourceGroupName?: StringFilter | undefined;
651
792
  ids?: string[] | undefined;
652
793
  all?: boolean | undefined;
653
- /** Specification for the sort order of a query.
654
- *
655
- * Example: ```{ "color": "asc", size: OrderEnum.desc }```
656
- *
657
- * Example: ```"color"```
794
+ /** supports a single field name
795
+ * ```json
796
+ * "sort": "name"
797
+ * ```
798
+ * or an array of field names
799
+ * ```json
800
+ * "sort": ["name", "lastModified~desc"]
801
+ * ```
802
+ * or an object dictionary of `fieldName: asc|desc` pairs, eg:
803
+ * ```json
804
+ * "sort": {
805
+ * "name": "asc",
806
+ * "lastModified": "desc"
807
+ * }
808
+ * ```
658
809
  *
659
- * Example: ```[ "color", "lastName" ]``` */
810
+ * NOTE: Regarding sort field order, (aka: `asc|desc`) : Sort field names can be specified as EITHER: field name alone (implies asc order), eg: `"favColor"`, OR field name with order suffix `asc|desc` (delimited by tilde). eg: `"favColor~desc"`. */
660
811
  sort?: string[] | "asc" | "desc" | string | undefined;
661
812
  skip?: number | undefined;
662
813
  take?: number | undefined;
814
+ /** Declares that the data be returned in the opposite order than what is specified by the `sort` property. */
815
+ reverse?: number | boolean | undefined;
663
816
  }
664
817
  /** The specs for a kubernetes cluster to be managed by the Codiac team.
665
818
  * This class is used to programmatically put up and take down clusters. */
@@ -722,16 +875,28 @@ export interface ClusterDefCriteria {
722
875
  privateOwner?: string | undefined;
723
876
  ids?: string[] | undefined;
724
877
  all?: boolean | undefined;
725
- /** Specification for the sort order of a query.
726
- *
727
- * Example: ```{ "color": "asc", size: OrderEnum.desc }```
728
- *
729
- * Example: ```"color"```
878
+ /** supports a single field name
879
+ * ```json
880
+ * "sort": "name"
881
+ * ```
882
+ * or an array of field names
883
+ * ```json
884
+ * "sort": ["name", "lastModified~desc"]
885
+ * ```
886
+ * or an object dictionary of `fieldName: asc|desc` pairs, eg:
887
+ * ```json
888
+ * "sort": {
889
+ * "name": "asc",
890
+ * "lastModified": "desc"
891
+ * }
892
+ * ```
730
893
  *
731
- * Example: ```[ "color", "lastName" ]``` */
894
+ * NOTE: Regarding sort field order, (aka: `asc|desc`) : Sort field names can be specified as EITHER: field name alone (implies asc order), eg: `"favColor"`, OR field name with order suffix `asc|desc` (delimited by tilde). eg: `"favColor~desc"`. */
732
895
  sort?: string[] | "asc" | "desc" | string | undefined;
733
896
  skip?: number | undefined;
734
897
  take?: number | undefined;
898
+ /** Declares that the data be returned in the opposite order than what is specified by the `sort` property. */
899
+ reverse?: number | boolean | undefined;
735
900
  }
736
901
  /** Similar to an ACL for a cluster: declares an access level for a user on a cluster. */
737
902
  export interface ClusterGrant {
@@ -750,16 +915,28 @@ export interface ClusterGrantCriteria {
750
915
  accessLevel?: string | undefined;
751
916
  ids?: string[] | undefined;
752
917
  all?: boolean | undefined;
753
- /** Specification for the sort order of a query.
754
- *
755
- * Example: ```{ "color": "asc", size: OrderEnum.desc }```
756
- *
757
- * Example: ```"color"```
918
+ /** supports a single field name
919
+ * ```json
920
+ * "sort": "name"
921
+ * ```
922
+ * or an array of field names
923
+ * ```json
924
+ * "sort": ["name", "lastModified~desc"]
925
+ * ```
926
+ * or an object dictionary of `fieldName: asc|desc` pairs, eg:
927
+ * ```json
928
+ * "sort": {
929
+ * "name": "asc",
930
+ * "lastModified": "desc"
931
+ * }
932
+ * ```
758
933
  *
759
- * Example: ```[ "color", "lastName" ]``` */
934
+ * NOTE: Regarding sort field order, (aka: `asc|desc`) : Sort field names can be specified as EITHER: field name alone (implies asc order), eg: `"favColor"`, OR field name with order suffix `asc|desc` (delimited by tilde). eg: `"favColor~desc"`. */
760
935
  sort?: string[] | "asc" | "desc" | string | undefined;
761
936
  skip?: number | undefined;
762
937
  take?: number | undefined;
938
+ /** Declares that the data be returned in the opposite order than what is specified by the `sort` property. */
939
+ reverse?: number | boolean | undefined;
763
940
  }
764
941
  export interface ClusterWithIngress {
765
942
  name: string;
@@ -851,16 +1028,28 @@ export interface CommentCriteria {
851
1028
  createdBy?: string | undefined;
852
1029
  ids?: string[] | undefined;
853
1030
  all?: boolean | undefined;
854
- /** Specification for the sort order of a query.
855
- *
856
- * Example: ```{ "color": "asc", size: OrderEnum.desc }```
857
- *
858
- * Example: ```"color"```
1031
+ /** supports a single field name
1032
+ * ```json
1033
+ * "sort": "name"
1034
+ * ```
1035
+ * or an array of field names
1036
+ * ```json
1037
+ * "sort": ["name", "lastModified~desc"]
1038
+ * ```
1039
+ * or an object dictionary of `fieldName: asc|desc` pairs, eg:
1040
+ * ```json
1041
+ * "sort": {
1042
+ * "name": "asc",
1043
+ * "lastModified": "desc"
1044
+ * }
1045
+ * ```
859
1046
  *
860
- * Example: ```[ "color", "lastName" ]``` */
1047
+ * NOTE: Regarding sort field order, (aka: `asc|desc`) : Sort field names can be specified as EITHER: field name alone (implies asc order), eg: `"favColor"`, OR field name with order suffix `asc|desc` (delimited by tilde). eg: `"favColor~desc"`. */
861
1048
  sort?: string[] | "asc" | "desc" | string | undefined;
862
1049
  skip?: number | undefined;
863
1050
  take?: number | undefined;
1051
+ /** Declares that the data be returned in the opposite order than what is specified by the `sort` property. */
1052
+ reverse?: number | boolean | undefined;
864
1053
  }
865
1054
  /** An historical record of a change made to the the configuration of the an enterprise for a given cabinet,
866
1055
  * to be used, together with the latest preceeding snapshot and other change events, as the specification for a deployment.
@@ -880,16 +1069,28 @@ export interface ConfigChangeCriteria {
880
1069
  cabinet?: StringFilter | undefined;
881
1070
  ids?: string[] | undefined;
882
1071
  all?: boolean | undefined;
883
- /** Specification for the sort order of a query.
884
- *
885
- * Example: ```{ "color": "asc", size: OrderEnum.desc }```
886
- *
887
- * Example: ```"color"```
1072
+ /** supports a single field name
1073
+ * ```json
1074
+ * "sort": "name"
1075
+ * ```
1076
+ * or an array of field names
1077
+ * ```json
1078
+ * "sort": ["name", "lastModified~desc"]
1079
+ * ```
1080
+ * or an object dictionary of `fieldName: asc|desc` pairs, eg:
1081
+ * ```json
1082
+ * "sort": {
1083
+ * "name": "asc",
1084
+ * "lastModified": "desc"
1085
+ * }
1086
+ * ```
888
1087
  *
889
- * Example: ```[ "color", "lastName" ]``` */
1088
+ * NOTE: Regarding sort field order, (aka: `asc|desc`) : Sort field names can be specified as EITHER: field name alone (implies asc order), eg: `"favColor"`, OR field name with order suffix `asc|desc` (delimited by tilde). eg: `"favColor~desc"`. */
890
1089
  sort?: string[] | "asc" | "desc" | string | undefined;
891
1090
  skip?: number | undefined;
892
1091
  take?: number | undefined;
1092
+ /** Declares that the data be returned in the opposite order than what is specified by the `sort` property. */
1093
+ reverse?: number | boolean | undefined;
893
1094
  }
894
1095
  export interface ConfigDef {
895
1096
  enterprise: string;
@@ -911,16 +1112,28 @@ export interface ConfigDefCriteria {
911
1112
  format?: string | undefined;
912
1113
  ids?: string[] | undefined;
913
1114
  all?: boolean | undefined;
914
- /** Specification for the sort order of a query.
915
- *
916
- * Example: ```{ "color": "asc", size: OrderEnum.desc }```
917
- *
918
- * Example: ```"color"```
1115
+ /** supports a single field name
1116
+ * ```json
1117
+ * "sort": "name"
1118
+ * ```
1119
+ * or an array of field names
1120
+ * ```json
1121
+ * "sort": ["name", "lastModified~desc"]
1122
+ * ```
1123
+ * or an object dictionary of `fieldName: asc|desc` pairs, eg:
1124
+ * ```json
1125
+ * "sort": {
1126
+ * "name": "asc",
1127
+ * "lastModified": "desc"
1128
+ * }
1129
+ * ```
919
1130
  *
920
- * Example: ```[ "color", "lastName" ]``` */
1131
+ * NOTE: Regarding sort field order, (aka: `asc|desc`) : Sort field names can be specified as EITHER: field name alone (implies asc order), eg: `"favColor"`, OR field name with order suffix `asc|desc` (delimited by tilde). eg: `"favColor~desc"`. */
921
1132
  sort?: string[] | "asc" | "desc" | string | undefined;
922
1133
  skip?: number | undefined;
923
1134
  take?: number | undefined;
1135
+ /** Declares that the data be returned in the opposite order than what is specified by the `sort` property. */
1136
+ reverse?: number | boolean | undefined;
924
1137
  }
925
1138
  /** Values of ScopedSetting.targetFile for NON-FILE configs. */
926
1139
  export declare enum ConfigDefTypesEnum {
@@ -979,16 +1192,28 @@ export interface ConfigDeploymentActivityCriteria {
979
1192
  assetsName?: string | undefined;
980
1193
  ids?: string[] | undefined;
981
1194
  all?: boolean | undefined;
982
- /** Specification for the sort order of a query.
983
- *
984
- * Example: ```{ "color": "asc", size: OrderEnum.desc }```
985
- *
986
- * Example: ```"color"```
1195
+ /** supports a single field name
1196
+ * ```json
1197
+ * "sort": "name"
1198
+ * ```
1199
+ * or an array of field names
1200
+ * ```json
1201
+ * "sort": ["name", "lastModified~desc"]
1202
+ * ```
1203
+ * or an object dictionary of `fieldName: asc|desc` pairs, eg:
1204
+ * ```json
1205
+ * "sort": {
1206
+ * "name": "asc",
1207
+ * "lastModified": "desc"
1208
+ * }
1209
+ * ```
987
1210
  *
988
- * Example: ```[ "color", "lastName" ]``` */
1211
+ * NOTE: Regarding sort field order, (aka: `asc|desc`) : Sort field names can be specified as EITHER: field name alone (implies asc order), eg: `"favColor"`, OR field name with order suffix `asc|desc` (delimited by tilde). eg: `"favColor~desc"`. */
989
1212
  sort?: string[] | "asc" | "desc" | string | undefined;
990
1213
  skip?: number | undefined;
991
1214
  take?: number | undefined;
1215
+ /** Declares that the data be returned in the opposite order than what is specified by the `sort` property. */
1216
+ reverse?: number | boolean | undefined;
992
1217
  }
993
1218
  /** An object representation of a config file, assembled from ScopedSettings.
994
1219
  * This document can take any form, and is constructed solely from settings and values,
@@ -1005,16 +1230,28 @@ export interface ConfigDocSpecForOne {
1005
1230
  cabinet: string;
1006
1231
  ids?: string[] | undefined;
1007
1232
  all?: boolean | undefined;
1008
- /** Specification for the sort order of a query.
1009
- *
1010
- * Example: ```{ "color": "asc", size: OrderEnum.desc }```
1011
- *
1012
- * Example: ```"color"```
1233
+ /** supports a single field name
1234
+ * ```json
1235
+ * "sort": "name"
1236
+ * ```
1237
+ * or an array of field names
1238
+ * ```json
1239
+ * "sort": ["name", "lastModified~desc"]
1240
+ * ```
1241
+ * or an object dictionary of `fieldName: asc|desc` pairs, eg:
1242
+ * ```json
1243
+ * "sort": {
1244
+ * "name": "asc",
1245
+ * "lastModified": "desc"
1246
+ * }
1247
+ * ```
1013
1248
  *
1014
- * Example: ```[ "color", "lastName" ]``` */
1249
+ * NOTE: Regarding sort field order, (aka: `asc|desc`) : Sort field names can be specified as EITHER: field name alone (implies asc order), eg: `"favColor"`, OR field name with order suffix `asc|desc` (delimited by tilde). eg: `"favColor~desc"`. */
1015
1250
  sort?: string[] | "asc" | "desc" | string | undefined;
1016
1251
  skip?: number | undefined;
1017
1252
  take?: number | undefined;
1253
+ /** Declares that the data be returned in the opposite order than what is specified by the `sort` property. */
1254
+ reverse?: number | boolean | undefined;
1018
1255
  }
1019
1256
  /** Serializer declaration for a data document. */
1020
1257
  export declare enum ConfigFormatsEnum {
@@ -1063,16 +1300,28 @@ export interface ContainerFootprintCriteria {
1063
1300
  componentName?: StringFilter | undefined;
1064
1301
  ids?: string[] | undefined;
1065
1302
  all?: boolean | undefined;
1066
- /** Specification for the sort order of a query.
1067
- *
1068
- * Example: ```{ "color": "asc", size: OrderEnum.desc }```
1069
- *
1070
- * Example: ```"color"```
1303
+ /** supports a single field name
1304
+ * ```json
1305
+ * "sort": "name"
1306
+ * ```
1307
+ * or an array of field names
1308
+ * ```json
1309
+ * "sort": ["name", "lastModified~desc"]
1310
+ * ```
1311
+ * or an object dictionary of `fieldName: asc|desc` pairs, eg:
1312
+ * ```json
1313
+ * "sort": {
1314
+ * "name": "asc",
1315
+ * "lastModified": "desc"
1316
+ * }
1317
+ * ```
1071
1318
  *
1072
- * Example: ```[ "color", "lastName" ]``` */
1319
+ * NOTE: Regarding sort field order, (aka: `asc|desc`) : Sort field names can be specified as EITHER: field name alone (implies asc order), eg: `"favColor"`, OR field name with order suffix `asc|desc` (delimited by tilde). eg: `"favColor~desc"`. */
1073
1320
  sort?: string[] | "asc" | "desc" | string | undefined;
1074
1321
  skip?: number | undefined;
1075
1322
  take?: number | undefined;
1323
+ /** Declares that the data be returned in the opposite order than what is specified by the `sort` property. */
1324
+ reverse?: number | boolean | undefined;
1076
1325
  }
1077
1326
  export interface CspTenantProfile {
1078
1327
  provider: CloudProviderEnum;
@@ -1092,16 +1341,28 @@ export interface CspTenantProfileCriteria {
1092
1341
  cspTenantId?: string | undefined;
1093
1342
  ids?: string[] | undefined;
1094
1343
  all?: boolean | undefined;
1095
- /** Specification for the sort order of a query.
1096
- *
1097
- * Example: ```{ "color": "asc", size: OrderEnum.desc }```
1098
- *
1099
- * Example: ```"color"```
1344
+ /** supports a single field name
1345
+ * ```json
1346
+ * "sort": "name"
1347
+ * ```
1348
+ * or an array of field names
1349
+ * ```json
1350
+ * "sort": ["name", "lastModified~desc"]
1351
+ * ```
1352
+ * or an object dictionary of `fieldName: asc|desc` pairs, eg:
1353
+ * ```json
1354
+ * "sort": {
1355
+ * "name": "asc",
1356
+ * "lastModified": "desc"
1357
+ * }
1358
+ * ```
1100
1359
  *
1101
- * Example: ```[ "color", "lastName" ]``` */
1360
+ * NOTE: Regarding sort field order, (aka: `asc|desc`) : Sort field names can be specified as EITHER: field name alone (implies asc order), eg: `"favColor"`, OR field name with order suffix `asc|desc` (delimited by tilde). eg: `"favColor~desc"`. */
1102
1361
  sort?: string[] | "asc" | "desc" | string | undefined;
1103
1362
  skip?: number | undefined;
1104
1363
  take?: number | undefined;
1364
+ /** Declares that the data be returned in the opposite order than what is specified by the `sort` property. */
1365
+ reverse?: number | boolean | undefined;
1105
1366
  }
1106
1367
  export interface DeployAttempt {
1107
1368
  name: string;
@@ -1117,16 +1378,28 @@ export interface DeployAttemptCriteria {
1117
1378
  name?: StringFilter | undefined;
1118
1379
  ids?: string[] | undefined;
1119
1380
  all?: boolean | undefined;
1120
- /** Specification for the sort order of a query.
1121
- *
1122
- * Example: ```{ "color": "asc", size: OrderEnum.desc }```
1123
- *
1124
- * Example: ```"color"```
1381
+ /** supports a single field name
1382
+ * ```json
1383
+ * "sort": "name"
1384
+ * ```
1385
+ * or an array of field names
1386
+ * ```json
1387
+ * "sort": ["name", "lastModified~desc"]
1388
+ * ```
1389
+ * or an object dictionary of `fieldName: asc|desc` pairs, eg:
1390
+ * ```json
1391
+ * "sort": {
1392
+ * "name": "asc",
1393
+ * "lastModified": "desc"
1394
+ * }
1395
+ * ```
1125
1396
  *
1126
- * Example: ```[ "color", "lastName" ]``` */
1397
+ * NOTE: Regarding sort field order, (aka: `asc|desc`) : Sort field names can be specified as EITHER: field name alone (implies asc order), eg: `"favColor"`, OR field name with order suffix `asc|desc` (delimited by tilde). eg: `"favColor~desc"`. */
1127
1398
  sort?: string[] | "asc" | "desc" | string | undefined;
1128
1399
  skip?: number | undefined;
1129
1400
  take?: number | undefined;
1401
+ /** Declares that the data be returned in the opposite order than what is specified by the `sort` property. */
1402
+ reverse?: number | boolean | undefined;
1130
1403
  }
1131
1404
  /** The specification for a deployment of an enterprise to a cabinet.
1132
1405
  * NOTE:
@@ -1183,16 +1456,28 @@ export interface DeploymentActivityCriteria {
1183
1456
  assetsName?: string | undefined;
1184
1457
  ids?: string[] | undefined;
1185
1458
  all?: boolean | undefined;
1186
- /** Specification for the sort order of a query.
1187
- *
1188
- * Example: ```{ "color": "asc", size: OrderEnum.desc }```
1189
- *
1190
- * Example: ```"color"```
1459
+ /** supports a single field name
1460
+ * ```json
1461
+ * "sort": "name"
1462
+ * ```
1463
+ * or an array of field names
1464
+ * ```json
1465
+ * "sort": ["name", "lastModified~desc"]
1466
+ * ```
1467
+ * or an object dictionary of `fieldName: asc|desc` pairs, eg:
1468
+ * ```json
1469
+ * "sort": {
1470
+ * "name": "asc",
1471
+ * "lastModified": "desc"
1472
+ * }
1473
+ * ```
1191
1474
  *
1192
- * Example: ```[ "color", "lastName" ]``` */
1475
+ * NOTE: Regarding sort field order, (aka: `asc|desc`) : Sort field names can be specified as EITHER: field name alone (implies asc order), eg: `"favColor"`, OR field name with order suffix `asc|desc` (delimited by tilde). eg: `"favColor~desc"`. */
1193
1476
  sort?: string[] | "asc" | "desc" | string | undefined;
1194
1477
  skip?: number | undefined;
1195
1478
  take?: number | undefined;
1479
+ /** Declares that the data be returned in the opposite order than what is specified by the `sort` property. */
1480
+ reverse?: number | boolean | undefined;
1196
1481
  }
1197
1482
  export interface DeploymentCriteria {
1198
1483
  id?: StringFilter | undefined;
@@ -1201,16 +1486,28 @@ export interface DeploymentCriteria {
1201
1486
  cabinet?: StringFilter | undefined;
1202
1487
  ids?: string[] | undefined;
1203
1488
  all?: boolean | undefined;
1204
- /** Specification for the sort order of a query.
1205
- *
1206
- * Example: ```{ "color": "asc", size: OrderEnum.desc }```
1207
- *
1208
- * Example: ```"color"```
1489
+ /** supports a single field name
1490
+ * ```json
1491
+ * "sort": "name"
1492
+ * ```
1493
+ * or an array of field names
1494
+ * ```json
1495
+ * "sort": ["name", "lastModified~desc"]
1496
+ * ```
1497
+ * or an object dictionary of `fieldName: asc|desc` pairs, eg:
1498
+ * ```json
1499
+ * "sort": {
1500
+ * "name": "asc",
1501
+ * "lastModified": "desc"
1502
+ * }
1503
+ * ```
1209
1504
  *
1210
- * Example: ```[ "color", "lastName" ]``` */
1505
+ * NOTE: Regarding sort field order, (aka: `asc|desc`) : Sort field names can be specified as EITHER: field name alone (implies asc order), eg: `"favColor"`, OR field name with order suffix `asc|desc` (delimited by tilde). eg: `"favColor~desc"`. */
1211
1506
  sort?: string[] | "asc" | "desc" | string | undefined;
1212
1507
  skip?: number | undefined;
1213
1508
  take?: number | undefined;
1509
+ /** Declares that the data be returned in the opposite order than what is specified by the `sort` property. */
1510
+ reverse?: number | boolean | undefined;
1214
1511
  }
1215
1512
  export interface DeployPipeline {
1216
1513
  name: string;
@@ -1224,16 +1521,28 @@ export interface DeployPipelineCriteria {
1224
1521
  name?: StringFilter | undefined;
1225
1522
  ids?: string[] | undefined;
1226
1523
  all?: boolean | undefined;
1227
- /** Specification for the sort order of a query.
1228
- *
1229
- * Example: ```{ "color": "asc", size: OrderEnum.desc }```
1230
- *
1231
- * Example: ```"color"```
1524
+ /** supports a single field name
1525
+ * ```json
1526
+ * "sort": "name"
1527
+ * ```
1528
+ * or an array of field names
1529
+ * ```json
1530
+ * "sort": ["name", "lastModified~desc"]
1531
+ * ```
1532
+ * or an object dictionary of `fieldName: asc|desc` pairs, eg:
1533
+ * ```json
1534
+ * "sort": {
1535
+ * "name": "asc",
1536
+ * "lastModified": "desc"
1537
+ * }
1538
+ * ```
1232
1539
  *
1233
- * Example: ```[ "color", "lastName" ]``` */
1540
+ * NOTE: Regarding sort field order, (aka: `asc|desc`) : Sort field names can be specified as EITHER: field name alone (implies asc order), eg: `"favColor"`, OR field name with order suffix `asc|desc` (delimited by tilde). eg: `"favColor~desc"`. */
1234
1541
  sort?: string[] | "asc" | "desc" | string | undefined;
1235
1542
  skip?: number | undefined;
1236
1543
  take?: number | undefined;
1544
+ /** Declares that the data be returned in the opposite order than what is specified by the `sort` property. */
1545
+ reverse?: number | boolean | undefined;
1237
1546
  }
1238
1547
  /** Defines a discriminated (tagged) union of different record types.
1239
1548
  *
@@ -1280,16 +1589,28 @@ export interface EnterpriseCriteria {
1280
1589
  subscription?: string | undefined;
1281
1590
  ids?: string[] | undefined;
1282
1591
  all?: boolean | undefined;
1283
- /** Specification for the sort order of a query.
1284
- *
1285
- * Example: ```{ "color": "asc", size: OrderEnum.desc }```
1286
- *
1287
- * Example: ```"color"```
1592
+ /** supports a single field name
1593
+ * ```json
1594
+ * "sort": "name"
1595
+ * ```
1596
+ * or an array of field names
1597
+ * ```json
1598
+ * "sort": ["name", "lastModified~desc"]
1599
+ * ```
1600
+ * or an object dictionary of `fieldName: asc|desc` pairs, eg:
1601
+ * ```json
1602
+ * "sort": {
1603
+ * "name": "asc",
1604
+ * "lastModified": "desc"
1605
+ * }
1606
+ * ```
1288
1607
  *
1289
- * Example: ```[ "color", "lastName" ]``` */
1608
+ * NOTE: Regarding sort field order, (aka: `asc|desc`) : Sort field names can be specified as EITHER: field name alone (implies asc order), eg: `"favColor"`, OR field name with order suffix `asc|desc` (delimited by tilde). eg: `"favColor~desc"`. */
1290
1609
  sort?: string[] | "asc" | "desc" | string | undefined;
1291
1610
  skip?: number | undefined;
1292
1611
  take?: number | undefined;
1612
+ /** Declares that the data be returned in the opposite order than what is specified by the `sort` property. */
1613
+ reverse?: number | boolean | undefined;
1293
1614
  }
1294
1615
  export interface EnterpriseRoot {
1295
1616
  name: string;
@@ -1326,16 +1647,28 @@ export interface EnterpriseRunStateCriteria {
1326
1647
  contentHash?: string | undefined;
1327
1648
  ids?: string[] | undefined;
1328
1649
  all?: boolean | undefined;
1329
- /** Specification for the sort order of a query.
1330
- *
1331
- * Example: ```{ "color": "asc", size: OrderEnum.desc }```
1332
- *
1333
- * Example: ```"color"```
1650
+ /** supports a single field name
1651
+ * ```json
1652
+ * "sort": "name"
1653
+ * ```
1654
+ * or an array of field names
1655
+ * ```json
1656
+ * "sort": ["name", "lastModified~desc"]
1657
+ * ```
1658
+ * or an object dictionary of `fieldName: asc|desc` pairs, eg:
1659
+ * ```json
1660
+ * "sort": {
1661
+ * "name": "asc",
1662
+ * "lastModified": "desc"
1663
+ * }
1664
+ * ```
1334
1665
  *
1335
- * Example: ```[ "color", "lastName" ]``` */
1666
+ * NOTE: Regarding sort field order, (aka: `asc|desc`) : Sort field names can be specified as EITHER: field name alone (implies asc order), eg: `"favColor"`, OR field name with order suffix `asc|desc` (delimited by tilde). eg: `"favColor~desc"`. */
1336
1667
  sort?: string[] | "asc" | "desc" | string | undefined;
1337
1668
  skip?: number | undefined;
1338
1669
  take?: number | undefined;
1670
+ /** Declares that the data be returned in the opposite order than what is specified by the `sort` property. */
1671
+ reverse?: number | boolean | undefined;
1339
1672
  }
1340
1673
  /** A reference to an enterprise and its environment scopes. */
1341
1674
  export interface EnterpriseScope {
@@ -1372,16 +1705,28 @@ export interface EnterpriseVersionConfigCriteria {
1372
1705
  labels?: object | undefined;
1373
1706
  ids?: string[] | undefined;
1374
1707
  all?: boolean | undefined;
1375
- /** Specification for the sort order of a query.
1376
- *
1377
- * Example: ```{ "color": "asc", size: OrderEnum.desc }```
1378
- *
1379
- * Example: ```"color"```
1708
+ /** supports a single field name
1709
+ * ```json
1710
+ * "sort": "name"
1711
+ * ```
1712
+ * or an array of field names
1713
+ * ```json
1714
+ * "sort": ["name", "lastModified~desc"]
1715
+ * ```
1716
+ * or an object dictionary of `fieldName: asc|desc` pairs, eg:
1717
+ * ```json
1718
+ * "sort": {
1719
+ * "name": "asc",
1720
+ * "lastModified": "desc"
1721
+ * }
1722
+ * ```
1380
1723
  *
1381
- * Example: ```[ "color", "lastName" ]``` */
1724
+ * NOTE: Regarding sort field order, (aka: `asc|desc`) : Sort field names can be specified as EITHER: field name alone (implies asc order), eg: `"favColor"`, OR field name with order suffix `asc|desc` (delimited by tilde). eg: `"favColor~desc"`. */
1382
1725
  sort?: string[] | "asc" | "desc" | string | undefined;
1383
1726
  skip?: number | undefined;
1384
1727
  take?: number | undefined;
1728
+ /** Declares that the data be returned in the opposite order than what is specified by the `sort` property. */
1729
+ reverse?: number | boolean | undefined;
1385
1730
  }
1386
1731
  /** Access Control List (ACL) for a single securable object.
1387
1732
  * A list of permissions declared on a single, identifiable concrete entity. */
@@ -1461,16 +1806,28 @@ export interface EnvironmentCriteria {
1461
1806
  subscription?: string | undefined;
1462
1807
  ids?: string[] | undefined;
1463
1808
  all?: boolean | undefined;
1464
- /** Specification for the sort order of a query.
1465
- *
1466
- * Example: ```{ "color": "asc", size: OrderEnum.desc }```
1467
- *
1468
- * Example: ```"color"```
1809
+ /** supports a single field name
1810
+ * ```json
1811
+ * "sort": "name"
1812
+ * ```
1813
+ * or an array of field names
1814
+ * ```json
1815
+ * "sort": ["name", "lastModified~desc"]
1816
+ * ```
1817
+ * or an object dictionary of `fieldName: asc|desc` pairs, eg:
1818
+ * ```json
1819
+ * "sort": {
1820
+ * "name": "asc",
1821
+ * "lastModified": "desc"
1822
+ * }
1823
+ * ```
1469
1824
  *
1470
- * Example: ```[ "color", "lastName" ]``` */
1825
+ * NOTE: Regarding sort field order, (aka: `asc|desc`) : Sort field names can be specified as EITHER: field name alone (implies asc order), eg: `"favColor"`, OR field name with order suffix `asc|desc` (delimited by tilde). eg: `"favColor~desc"`. */
1471
1826
  sort?: string[] | "asc" | "desc" | string | undefined;
1472
1827
  skip?: number | undefined;
1473
1828
  take?: number | undefined;
1829
+ /** Declares that the data be returned in the opposite order than what is specified by the `sort` property. */
1830
+ reverse?: number | boolean | undefined;
1474
1831
  }
1475
1832
  /** A reference to an environment and its cabinets. */
1476
1833
  export interface EnvironmentRoot {
@@ -1522,16 +1879,28 @@ export interface FileStoreDefCriteria {
1522
1879
  providerSubscriptionId?: StringFilter | undefined;
1523
1880
  ids?: string[] | undefined;
1524
1881
  all?: boolean | undefined;
1525
- /** Specification for the sort order of a query.
1526
- *
1527
- * Example: ```{ "color": "asc", size: OrderEnum.desc }```
1528
- *
1529
- * Example: ```"color"```
1882
+ /** supports a single field name
1883
+ * ```json
1884
+ * "sort": "name"
1885
+ * ```
1886
+ * or an array of field names
1887
+ * ```json
1888
+ * "sort": ["name", "lastModified~desc"]
1889
+ * ```
1890
+ * or an object dictionary of `fieldName: asc|desc` pairs, eg:
1891
+ * ```json
1892
+ * "sort": {
1893
+ * "name": "asc",
1894
+ * "lastModified": "desc"
1895
+ * }
1896
+ * ```
1530
1897
  *
1531
- * Example: ```[ "color", "lastName" ]``` */
1898
+ * NOTE: Regarding sort field order, (aka: `asc|desc`) : Sort field names can be specified as EITHER: field name alone (implies asc order), eg: `"favColor"`, OR field name with order suffix `asc|desc` (delimited by tilde). eg: `"favColor~desc"`. */
1532
1899
  sort?: string[] | "asc" | "desc" | string | undefined;
1533
1900
  skip?: number | undefined;
1534
1901
  take?: number | undefined;
1902
+ /** Declares that the data be returned in the opposite order than what is specified by the `sort` property. */
1903
+ reverse?: number | boolean | undefined;
1535
1904
  }
1536
1905
  /** Metadata describing an existing concrete instance
1537
1906
  * of a FileStoreDef resource within a cloud provider. */
@@ -1696,16 +2065,28 @@ export interface ImageCriteria {
1696
2065
  name?: StringFilter | undefined;
1697
2066
  ids?: string[] | undefined;
1698
2067
  all?: boolean | undefined;
1699
- /** Specification for the sort order of a query.
1700
- *
1701
- * Example: ```{ "color": "asc", size: OrderEnum.desc }```
1702
- *
1703
- * Example: ```"color"```
2068
+ /** supports a single field name
2069
+ * ```json
2070
+ * "sort": "name"
2071
+ * ```
2072
+ * or an array of field names
2073
+ * ```json
2074
+ * "sort": ["name", "lastModified~desc"]
2075
+ * ```
2076
+ * or an object dictionary of `fieldName: asc|desc` pairs, eg:
2077
+ * ```json
2078
+ * "sort": {
2079
+ * "name": "asc",
2080
+ * "lastModified": "desc"
2081
+ * }
2082
+ * ```
1704
2083
  *
1705
- * Example: ```[ "color", "lastName" ]``` */
2084
+ * NOTE: Regarding sort field order, (aka: `asc|desc`) : Sort field names can be specified as EITHER: field name alone (implies asc order), eg: `"favColor"`, OR field name with order suffix `asc|desc` (delimited by tilde). eg: `"favColor~desc"`. */
1706
2085
  sort?: string[] | "asc" | "desc" | string | undefined;
1707
2086
  skip?: number | undefined;
1708
2087
  take?: number | undefined;
2088
+ /** Declares that the data be returned in the opposite order than what is specified by the `sort` property. */
2089
+ reverse?: number | boolean | undefined;
1709
2090
  }
1710
2091
  export interface ImageRegistry {
1711
2092
  id?: string | undefined;
@@ -1735,16 +2116,28 @@ export interface ImageRegistryCriteria {
1735
2116
  url?: StringFilter | undefined;
1736
2117
  ids?: string[] | undefined;
1737
2118
  all?: boolean | undefined;
1738
- /** Specification for the sort order of a query.
1739
- *
1740
- * Example: ```{ "color": "asc", size: OrderEnum.desc }```
1741
- *
1742
- * Example: ```"color"```
2119
+ /** supports a single field name
2120
+ * ```json
2121
+ * "sort": "name"
2122
+ * ```
2123
+ * or an array of field names
2124
+ * ```json
2125
+ * "sort": ["name", "lastModified~desc"]
2126
+ * ```
2127
+ * or an object dictionary of `fieldName: asc|desc` pairs, eg:
2128
+ * ```json
2129
+ * "sort": {
2130
+ * "name": "asc",
2131
+ * "lastModified": "desc"
2132
+ * }
2133
+ * ```
1743
2134
  *
1744
- * Example: ```[ "color", "lastName" ]``` */
2135
+ * NOTE: Regarding sort field order, (aka: `asc|desc`) : Sort field names can be specified as EITHER: field name alone (implies asc order), eg: `"favColor"`, OR field name with order suffix `asc|desc` (delimited by tilde). eg: `"favColor~desc"`. */
1745
2136
  sort?: string[] | "asc" | "desc" | string | undefined;
1746
2137
  skip?: number | undefined;
1747
2138
  take?: number | undefined;
2139
+ /** Declares that the data be returned in the opposite order than what is specified by the `sort` property. */
2140
+ reverse?: number | boolean | undefined;
1748
2141
  }
1749
2142
  /** Matches an ImageRegistry entity, just isnt a domain entity or auditable.
1750
2143
  * This class is for use as a request: it is NOT A DOMAIN ENTITY. */
@@ -1944,16 +2337,28 @@ export interface KitCriteria {
1944
2337
  tags?: StringListFilter | undefined;
1945
2338
  ids?: string[] | undefined;
1946
2339
  all?: boolean | undefined;
1947
- /** Specification for the sort order of a query.
1948
- *
1949
- * Example: ```{ "color": "asc", size: OrderEnum.desc }```
1950
- *
1951
- * Example: ```"color"```
2340
+ /** supports a single field name
2341
+ * ```json
2342
+ * "sort": "name"
2343
+ * ```
2344
+ * or an array of field names
2345
+ * ```json
2346
+ * "sort": ["name", "lastModified~desc"]
2347
+ * ```
2348
+ * or an object dictionary of `fieldName: asc|desc` pairs, eg:
2349
+ * ```json
2350
+ * "sort": {
2351
+ * "name": "asc",
2352
+ * "lastModified": "desc"
2353
+ * }
2354
+ * ```
1952
2355
  *
1953
- * Example: ```[ "color", "lastName" ]``` */
2356
+ * NOTE: Regarding sort field order, (aka: `asc|desc`) : Sort field names can be specified as EITHER: field name alone (implies asc order), eg: `"favColor"`, OR field name with order suffix `asc|desc` (delimited by tilde). eg: `"favColor~desc"`. */
1954
2357
  sort?: string[] | "asc" | "desc" | string | undefined;
1955
2358
  skip?: number | undefined;
1956
2359
  take?: number | undefined;
2360
+ /** Declares that the data be returned in the opposite order than what is specified by the `sort` property. */
2361
+ reverse?: number | boolean | undefined;
1957
2362
  }
1958
2363
  /** The information needed to access an individual key value pair
1959
2364
  * from a predefined data store. */
@@ -1993,16 +2398,28 @@ export interface KvpStoreDefCriteria {
1993
2398
  type?: "awsKeyVault" | "azBlob" | "azKeyVault" | "etcd" | "mongoCollection" | "mongoDocument" | undefined;
1994
2399
  ids?: string[] | undefined;
1995
2400
  all?: boolean | undefined;
1996
- /** Specification for the sort order of a query.
1997
- *
1998
- * Example: ```{ "color": "asc", size: OrderEnum.desc }```
1999
- *
2000
- * Example: ```"color"```
2401
+ /** supports a single field name
2402
+ * ```json
2403
+ * "sort": "name"
2404
+ * ```
2405
+ * or an array of field names
2406
+ * ```json
2407
+ * "sort": ["name", "lastModified~desc"]
2408
+ * ```
2409
+ * or an object dictionary of `fieldName: asc|desc` pairs, eg:
2410
+ * ```json
2411
+ * "sort": {
2412
+ * "name": "asc",
2413
+ * "lastModified": "desc"
2414
+ * }
2415
+ * ```
2001
2416
  *
2002
- * Example: ```[ "color", "lastName" ]``` */
2417
+ * NOTE: Regarding sort field order, (aka: `asc|desc`) : Sort field names can be specified as EITHER: field name alone (implies asc order), eg: `"favColor"`, OR field name with order suffix `asc|desc` (delimited by tilde). eg: `"favColor~desc"`. */
2003
2418
  sort?: string[] | "asc" | "desc" | string | undefined;
2004
2419
  skip?: number | undefined;
2005
2420
  take?: number | undefined;
2421
+ /** Declares that the data be returned in the opposite order than what is specified by the `sort` property. */
2422
+ reverse?: number | boolean | undefined;
2006
2423
  }
2007
2424
  export interface KvpStoreInfrx {
2008
2425
  type: KvpStoreTypesEnum;
@@ -2052,16 +2469,28 @@ export interface LabelCriteria {
2052
2469
  createdBy?: string | undefined;
2053
2470
  ids?: string[] | undefined;
2054
2471
  all?: boolean | undefined;
2055
- /** Specification for the sort order of a query.
2056
- *
2057
- * Example: ```{ "color": "asc", size: OrderEnum.desc }```
2058
- *
2059
- * Example: ```"color"```
2472
+ /** supports a single field name
2473
+ * ```json
2474
+ * "sort": "name"
2475
+ * ```
2476
+ * or an array of field names
2477
+ * ```json
2478
+ * "sort": ["name", "lastModified~desc"]
2479
+ * ```
2480
+ * or an object dictionary of `fieldName: asc|desc` pairs, eg:
2481
+ * ```json
2482
+ * "sort": {
2483
+ * "name": "asc",
2484
+ * "lastModified": "desc"
2485
+ * }
2486
+ * ```
2060
2487
  *
2061
- * Example: ```[ "color", "lastName" ]``` */
2488
+ * NOTE: Regarding sort field order, (aka: `asc|desc`) : Sort field names can be specified as EITHER: field name alone (implies asc order), eg: `"favColor"`, OR field name with order suffix `asc|desc` (delimited by tilde). eg: `"favColor~desc"`. */
2062
2489
  sort?: string[] | "asc" | "desc" | string | undefined;
2063
2490
  skip?: number | undefined;
2064
2491
  take?: number | undefined;
2492
+ /** Declares that the data be returned in the opposite order than what is specified by the `sort` property. */
2493
+ reverse?: number | boolean | undefined;
2065
2494
  }
2066
2495
  export interface MyTenantRequest {
2067
2496
  }
@@ -2131,16 +2560,28 @@ export interface NodePoolDefCriteria {
2131
2560
  isWindows?: boolean | undefined;
2132
2561
  ids?: string[] | undefined;
2133
2562
  all?: boolean | undefined;
2134
- /** Specification for the sort order of a query.
2135
- *
2136
- * Example: ```{ "color": "asc", size: OrderEnum.desc }```
2137
- *
2138
- * Example: ```"color"```
2563
+ /** supports a single field name
2564
+ * ```json
2565
+ * "sort": "name"
2566
+ * ```
2567
+ * or an array of field names
2568
+ * ```json
2569
+ * "sort": ["name", "lastModified~desc"]
2570
+ * ```
2571
+ * or an object dictionary of `fieldName: asc|desc` pairs, eg:
2572
+ * ```json
2573
+ * "sort": {
2574
+ * "name": "asc",
2575
+ * "lastModified": "desc"
2576
+ * }
2577
+ * ```
2139
2578
  *
2140
- * Example: ```[ "color", "lastName" ]``` */
2579
+ * NOTE: Regarding sort field order, (aka: `asc|desc`) : Sort field names can be specified as EITHER: field name alone (implies asc order), eg: `"favColor"`, OR field name with order suffix `asc|desc` (delimited by tilde). eg: `"favColor~desc"`. */
2141
2580
  sort?: string[] | "asc" | "desc" | string | undefined;
2142
2581
  skip?: number | undefined;
2143
2582
  take?: number | undefined;
2583
+ /** Declares that the data be returned in the opposite order than what is specified by the `sort` property. */
2584
+ reverse?: number | boolean | undefined;
2144
2585
  }
2145
2586
  /** AUTHOR NOTE:
2146
2587
  * This filter approach does NOT provide for:
@@ -2291,16 +2732,28 @@ export interface ProbeCriteria {
2291
2732
  disabled?: boolean | undefined;
2292
2733
  ids?: string[] | undefined;
2293
2734
  all?: boolean | undefined;
2294
- /** Specification for the sort order of a query.
2295
- *
2296
- * Example: ```{ "color": "asc", size: OrderEnum.desc }```
2297
- *
2298
- * Example: ```"color"```
2735
+ /** supports a single field name
2736
+ * ```json
2737
+ * "sort": "name"
2738
+ * ```
2739
+ * or an array of field names
2740
+ * ```json
2741
+ * "sort": ["name", "lastModified~desc"]
2742
+ * ```
2743
+ * or an object dictionary of `fieldName: asc|desc` pairs, eg:
2744
+ * ```json
2745
+ * "sort": {
2746
+ * "name": "asc",
2747
+ * "lastModified": "desc"
2748
+ * }
2749
+ * ```
2299
2750
  *
2300
- * Example: ```[ "color", "lastName" ]``` */
2751
+ * NOTE: Regarding sort field order, (aka: `asc|desc`) : Sort field names can be specified as EITHER: field name alone (implies asc order), eg: `"favColor"`, OR field name with order suffix `asc|desc` (delimited by tilde). eg: `"favColor~desc"`. */
2301
2752
  sort?: string[] | "asc" | "desc" | string | undefined;
2302
2753
  skip?: number | undefined;
2303
2754
  take?: number | undefined;
2755
+ /** Declares that the data be returned in the opposite order than what is specified by the `sort` property. */
2756
+ reverse?: number | boolean | undefined;
2304
2757
  }
2305
2758
  /** Declaration of what purpose the probe serves,
2306
2759
  * ie: where a probe is fired in the runtime lifecycle of an asset. */
@@ -2327,16 +2780,28 @@ export interface ProductCriteria {
2327
2780
  assetCodes?: StringListFilter | undefined;
2328
2781
  ids?: string[] | undefined;
2329
2782
  all?: boolean | undefined;
2330
- /** Specification for the sort order of a query.
2331
- *
2332
- * Example: ```{ "color": "asc", size: OrderEnum.desc }```
2333
- *
2334
- * Example: ```"color"```
2783
+ /** supports a single field name
2784
+ * ```json
2785
+ * "sort": "name"
2786
+ * ```
2787
+ * or an array of field names
2788
+ * ```json
2789
+ * "sort": ["name", "lastModified~desc"]
2790
+ * ```
2791
+ * or an object dictionary of `fieldName: asc|desc` pairs, eg:
2792
+ * ```json
2793
+ * "sort": {
2794
+ * "name": "asc",
2795
+ * "lastModified": "desc"
2796
+ * }
2797
+ * ```
2335
2798
  *
2336
- * Example: ```[ "color", "lastName" ]``` */
2799
+ * NOTE: Regarding sort field order, (aka: `asc|desc`) : Sort field names can be specified as EITHER: field name alone (implies asc order), eg: `"favColor"`, OR field name with order suffix `asc|desc` (delimited by tilde). eg: `"favColor~desc"`. */
2337
2800
  sort?: string[] | "asc" | "desc" | string | undefined;
2338
2801
  skip?: number | undefined;
2339
2802
  take?: number | undefined;
2803
+ /** Declares that the data be returned in the opposite order than what is specified by the `sort` property. */
2804
+ reverse?: number | boolean | undefined;
2340
2805
  }
2341
2806
  export interface ProductVersionConfig {
2342
2807
  productName: string;
@@ -2369,16 +2834,28 @@ export interface ProductVersionConfigCriteria {
2369
2834
  multi?: object[] | undefined;
2370
2835
  ids?: string[] | undefined;
2371
2836
  all?: boolean | undefined;
2372
- /** Specification for the sort order of a query.
2373
- *
2374
- * Example: ```{ "color": "asc", size: OrderEnum.desc }```
2375
- *
2376
- * Example: ```"color"```
2837
+ /** supports a single field name
2838
+ * ```json
2839
+ * "sort": "name"
2840
+ * ```
2841
+ * or an array of field names
2842
+ * ```json
2843
+ * "sort": ["name", "lastModified~desc"]
2844
+ * ```
2845
+ * or an object dictionary of `fieldName: asc|desc` pairs, eg:
2846
+ * ```json
2847
+ * "sort": {
2848
+ * "name": "asc",
2849
+ * "lastModified": "desc"
2850
+ * }
2851
+ * ```
2377
2852
  *
2378
- * Example: ```[ "color", "lastName" ]``` */
2853
+ * NOTE: Regarding sort field order, (aka: `asc|desc`) : Sort field names can be specified as EITHER: field name alone (implies asc order), eg: `"favColor"`, OR field name with order suffix `asc|desc` (delimited by tilde). eg: `"favColor~desc"`. */
2379
2854
  sort?: string[] | "asc" | "desc" | string | undefined;
2380
2855
  skip?: number | undefined;
2381
2856
  take?: number | undefined;
2857
+ /** Declares that the data be returned in the opposite order than what is specified by the `sort` property. */
2858
+ reverse?: number | boolean | undefined;
2382
2859
  }
2383
2860
  /** Defines an object with required and optional properties
2384
2861
  *
@@ -2471,16 +2948,28 @@ export interface RootMapCriteria {
2471
2948
  cluster?: string | undefined;
2472
2949
  ids?: string[] | undefined;
2473
2950
  all?: boolean | undefined;
2474
- /** Specification for the sort order of a query.
2475
- *
2476
- * Example: ```{ "color": "asc", size: OrderEnum.desc }```
2477
- *
2478
- * Example: ```"color"```
2951
+ /** supports a single field name
2952
+ * ```json
2953
+ * "sort": "name"
2954
+ * ```
2955
+ * or an array of field names
2956
+ * ```json
2957
+ * "sort": ["name", "lastModified~desc"]
2958
+ * ```
2959
+ * or an object dictionary of `fieldName: asc|desc` pairs, eg:
2960
+ * ```json
2961
+ * "sort": {
2962
+ * "name": "asc",
2963
+ * "lastModified": "desc"
2964
+ * }
2965
+ * ```
2479
2966
  *
2480
- * Example: ```[ "color", "lastName" ]``` */
2967
+ * NOTE: Regarding sort field order, (aka: `asc|desc`) : Sort field names can be specified as EITHER: field name alone (implies asc order), eg: `"favColor"`, OR field name with order suffix `asc|desc` (delimited by tilde). eg: `"favColor~desc"`. */
2481
2968
  sort?: string[] | "asc" | "desc" | string | undefined;
2482
2969
  skip?: number | undefined;
2483
2970
  take?: number | undefined;
2971
+ /** Declares that the data be returned in the opposite order than what is specified by the `sort` property. */
2972
+ reverse?: number | boolean | undefined;
2484
2973
  }
2485
2974
  export interface Scope {
2486
2975
  /** The level of the scope (eg: enterprise, environment, cluster, cabinet, asset, etc).
@@ -2519,16 +3008,28 @@ export interface ScopedConfigCriteria {
2519
3008
  targetFile?: StringFilter | undefined;
2520
3009
  ids?: string[] | undefined;
2521
3010
  all?: boolean | undefined;
2522
- /** Specification for the sort order of a query.
2523
- *
2524
- * Example: ```{ "color": "asc", size: OrderEnum.desc }```
2525
- *
2526
- * Example: ```"color"```
3011
+ /** supports a single field name
3012
+ * ```json
3013
+ * "sort": "name"
3014
+ * ```
3015
+ * or an array of field names
3016
+ * ```json
3017
+ * "sort": ["name", "lastModified~desc"]
3018
+ * ```
3019
+ * or an object dictionary of `fieldName: asc|desc` pairs, eg:
3020
+ * ```json
3021
+ * "sort": {
3022
+ * "name": "asc",
3023
+ * "lastModified": "desc"
3024
+ * }
3025
+ * ```
2527
3026
  *
2528
- * Example: ```[ "color", "lastName" ]``` */
3027
+ * NOTE: Regarding sort field order, (aka: `asc|desc`) : Sort field names can be specified as EITHER: field name alone (implies asc order), eg: `"favColor"`, OR field name with order suffix `asc|desc` (delimited by tilde). eg: `"favColor~desc"`. */
2529
3028
  sort?: string[] | "asc" | "desc" | string | undefined;
2530
3029
  skip?: number | undefined;
2531
3030
  take?: number | undefined;
3031
+ /** Declares that the data be returned in the opposite order than what is specified by the `sort` property. */
3032
+ reverse?: number | boolean | undefined;
2532
3033
  }
2533
3034
  /** An assignment of a HostNameStrategy for a single domain at a specific scope. */
2534
3035
  export interface ScopedHostNameConfig {
@@ -2562,16 +3063,28 @@ export interface ScopedHostNameConfigCriteria {
2562
3063
  applicableTo?: HostNameConfigCabinetScopeFilter | undefined;
2563
3064
  ids?: string[] | undefined;
2564
3065
  all?: boolean | undefined;
2565
- /** Specification for the sort order of a query.
2566
- *
2567
- * Example: ```{ "color": "asc", size: OrderEnum.desc }```
2568
- *
2569
- * Example: ```"color"```
3066
+ /** supports a single field name
3067
+ * ```json
3068
+ * "sort": "name"
3069
+ * ```
3070
+ * or an array of field names
3071
+ * ```json
3072
+ * "sort": ["name", "lastModified~desc"]
3073
+ * ```
3074
+ * or an object dictionary of `fieldName: asc|desc` pairs, eg:
3075
+ * ```json
3076
+ * "sort": {
3077
+ * "name": "asc",
3078
+ * "lastModified": "desc"
3079
+ * }
3080
+ * ```
2570
3081
  *
2571
- * Example: ```[ "color", "lastName" ]``` */
3082
+ * NOTE: Regarding sort field order, (aka: `asc|desc`) : Sort field names can be specified as EITHER: field name alone (implies asc order), eg: `"favColor"`, OR field name with order suffix `asc|desc` (delimited by tilde). eg: `"favColor~desc"`. */
2572
3083
  sort?: string[] | "asc" | "desc" | string | undefined;
2573
3084
  skip?: number | undefined;
2574
3085
  take?: number | undefined;
3086
+ /** Declares that the data be returned in the opposite order than what is specified by the `sort` property. */
3087
+ reverse?: number | boolean | undefined;
2575
3088
  }
2576
3089
  /** A single key-value setting within a config for an asset, scoped for its ultimate deployment context.
2577
3090
  * That is, this is the value of one setting within a config file (the targetFile param);
@@ -2608,16 +3121,28 @@ export interface ScopedSettingCriteria {
2608
3121
  targetCabinet?: ScopeFilter | undefined;
2609
3122
  ids?: string[] | undefined;
2610
3123
  all?: boolean | undefined;
2611
- /** Specification for the sort order of a query.
2612
- *
2613
- * Example: ```{ "color": "asc", size: OrderEnum.desc }```
2614
- *
2615
- * Example: ```"color"```
3124
+ /** supports a single field name
3125
+ * ```json
3126
+ * "sort": "name"
3127
+ * ```
3128
+ * or an array of field names
3129
+ * ```json
3130
+ * "sort": ["name", "lastModified~desc"]
3131
+ * ```
3132
+ * or an object dictionary of `fieldName: asc|desc` pairs, eg:
3133
+ * ```json
3134
+ * "sort": {
3135
+ * "name": "asc",
3136
+ * "lastModified": "desc"
3137
+ * }
3138
+ * ```
2616
3139
  *
2617
- * Example: ```[ "color", "lastName" ]``` */
3140
+ * NOTE: Regarding sort field order, (aka: `asc|desc`) : Sort field names can be specified as EITHER: field name alone (implies asc order), eg: `"favColor"`, OR field name with order suffix `asc|desc` (delimited by tilde). eg: `"favColor~desc"`. */
2618
3141
  sort?: string[] | "asc" | "desc" | string | undefined;
2619
3142
  skip?: number | undefined;
2620
3143
  take?: number | undefined;
3144
+ /** Declares that the data be returned in the opposite order than what is specified by the `sort` property. */
3145
+ reverse?: number | boolean | undefined;
2621
3146
  }
2622
3147
  /** Creates a filter expression that includes
2623
3148
  * all entities whose scopes are relevant input for a smash-merge
@@ -2703,16 +3228,28 @@ export interface SetupJournalCriteria {
2703
3228
  resourceId?: string | undefined;
2704
3229
  ids?: string[] | undefined;
2705
3230
  all?: boolean | undefined;
2706
- /** Specification for the sort order of a query.
2707
- *
2708
- * Example: ```{ "color": "asc", size: OrderEnum.desc }```
2709
- *
2710
- * Example: ```"color"```
3231
+ /** supports a single field name
3232
+ * ```json
3233
+ * "sort": "name"
3234
+ * ```
3235
+ * or an array of field names
3236
+ * ```json
3237
+ * "sort": ["name", "lastModified~desc"]
3238
+ * ```
3239
+ * or an object dictionary of `fieldName: asc|desc` pairs, eg:
3240
+ * ```json
3241
+ * "sort": {
3242
+ * "name": "asc",
3243
+ * "lastModified": "desc"
3244
+ * }
3245
+ * ```
2711
3246
  *
2712
- * Example: ```[ "color", "lastName" ]``` */
3247
+ * NOTE: Regarding sort field order, (aka: `asc|desc`) : Sort field names can be specified as EITHER: field name alone (implies asc order), eg: `"favColor"`, OR field name with order suffix `asc|desc` (delimited by tilde). eg: `"favColor~desc"`. */
2713
3248
  sort?: string[] | "asc" | "desc" | string | undefined;
2714
3249
  skip?: number | undefined;
2715
3250
  take?: number | undefined;
3251
+ /** Declares that the data be returned in the opposite order than what is specified by the `sort` property. */
3252
+ reverse?: number | boolean | undefined;
2716
3253
  }
2717
3254
  export interface SetupJournalEntry {
2718
3255
  name: string;
@@ -2754,16 +3291,28 @@ export interface SnapshotCriteria {
2754
3291
  cabinet?: StringFilter | undefined;
2755
3292
  ids?: string[] | undefined;
2756
3293
  all?: boolean | undefined;
2757
- /** Specification for the sort order of a query.
2758
- *
2759
- * Example: ```{ "color": "asc", size: OrderEnum.desc }```
2760
- *
2761
- * Example: ```"color"```
3294
+ /** supports a single field name
3295
+ * ```json
3296
+ * "sort": "name"
3297
+ * ```
3298
+ * or an array of field names
3299
+ * ```json
3300
+ * "sort": ["name", "lastModified~desc"]
3301
+ * ```
3302
+ * or an object dictionary of `fieldName: asc|desc` pairs, eg:
3303
+ * ```json
3304
+ * "sort": {
3305
+ * "name": "asc",
3306
+ * "lastModified": "desc"
3307
+ * }
3308
+ * ```
2762
3309
  *
2763
- * Example: ```[ "color", "lastName" ]``` */
3310
+ * NOTE: Regarding sort field order, (aka: `asc|desc`) : Sort field names can be specified as EITHER: field name alone (implies asc order), eg: `"favColor"`, OR field name with order suffix `asc|desc` (delimited by tilde). eg: `"favColor~desc"`. */
2764
3311
  sort?: string[] | "asc" | "desc" | string | undefined;
2765
3312
  skip?: number | undefined;
2766
3313
  take?: number | undefined;
3314
+ /** Declares that the data be returned in the opposite order than what is specified by the `sort` property. */
3315
+ reverse?: number | boolean | undefined;
2767
3316
  }
2768
3317
  export interface SourceRepo {
2769
3318
  name: string;
@@ -2777,16 +3326,28 @@ export interface SourceRepoCriteria {
2777
3326
  name?: StringFilter | undefined;
2778
3327
  ids?: string[] | undefined;
2779
3328
  all?: boolean | undefined;
2780
- /** Specification for the sort order of a query.
2781
- *
2782
- * Example: ```{ "color": "asc", size: OrderEnum.desc }```
2783
- *
2784
- * Example: ```"color"```
3329
+ /** supports a single field name
3330
+ * ```json
3331
+ * "sort": "name"
3332
+ * ```
3333
+ * or an array of field names
3334
+ * ```json
3335
+ * "sort": ["name", "lastModified~desc"]
3336
+ * ```
3337
+ * or an object dictionary of `fieldName: asc|desc` pairs, eg:
3338
+ * ```json
3339
+ * "sort": {
3340
+ * "name": "asc",
3341
+ * "lastModified": "desc"
3342
+ * }
3343
+ * ```
2785
3344
  *
2786
- * Example: ```[ "color", "lastName" ]``` */
3345
+ * NOTE: Regarding sort field order, (aka: `asc|desc`) : Sort field names can be specified as EITHER: field name alone (implies asc order), eg: `"favColor"`, OR field name with order suffix `asc|desc` (delimited by tilde). eg: `"favColor~desc"`. */
2787
3346
  sort?: string[] | "asc" | "desc" | string | undefined;
2788
3347
  skip?: number | undefined;
2789
3348
  take?: number | undefined;
3349
+ /** Declares that the data be returned in the opposite order than what is specified by the `sort` property. */
3350
+ reverse?: number | boolean | undefined;
2790
3351
  }
2791
3352
  export interface StringFilter {
2792
3353
  /** property of the target object to compare (conventional default to the name of the criteria property) */
@@ -2842,16 +3403,28 @@ export interface SubscriptionCriteria {
2842
3403
  tenantCode?: string | undefined;
2843
3404
  ids?: string[] | undefined;
2844
3405
  all?: boolean | undefined;
2845
- /** Specification for the sort order of a query.
2846
- *
2847
- * Example: ```{ "color": "asc", size: OrderEnum.desc }```
2848
- *
2849
- * Example: ```"color"```
3406
+ /** supports a single field name
3407
+ * ```json
3408
+ * "sort": "name"
3409
+ * ```
3410
+ * or an array of field names
3411
+ * ```json
3412
+ * "sort": ["name", "lastModified~desc"]
3413
+ * ```
3414
+ * or an object dictionary of `fieldName: asc|desc` pairs, eg:
3415
+ * ```json
3416
+ * "sort": {
3417
+ * "name": "asc",
3418
+ * "lastModified": "desc"
3419
+ * }
3420
+ * ```
2850
3421
  *
2851
- * Example: ```[ "color", "lastName" ]``` */
3422
+ * NOTE: Regarding sort field order, (aka: `asc|desc`) : Sort field names can be specified as EITHER: field name alone (implies asc order), eg: `"favColor"`, OR field name with order suffix `asc|desc` (delimited by tilde). eg: `"favColor~desc"`. */
2852
3423
  sort?: string[] | "asc" | "desc" | string | undefined;
2853
3424
  skip?: number | undefined;
2854
3425
  take?: number | undefined;
3426
+ /** Declares that the data be returned in the opposite order than what is specified by the `sort` property. */
3427
+ reverse?: number | boolean | undefined;
2855
3428
  }
2856
3429
  export declare enum SubscriptionStatus {
2857
3430
  cancelled = "cancelled",
@@ -2885,16 +3458,28 @@ export interface TagCriteria {
2885
3458
  createdBy?: string | undefined;
2886
3459
  ids?: string[] | undefined;
2887
3460
  all?: boolean | undefined;
2888
- /** Specification for the sort order of a query.
2889
- *
2890
- * Example: ```{ "color": "asc", size: OrderEnum.desc }```
2891
- *
2892
- * Example: ```"color"```
3461
+ /** supports a single field name
3462
+ * ```json
3463
+ * "sort": "name"
3464
+ * ```
3465
+ * or an array of field names
3466
+ * ```json
3467
+ * "sort": ["name", "lastModified~desc"]
3468
+ * ```
3469
+ * or an object dictionary of `fieldName: asc|desc` pairs, eg:
3470
+ * ```json
3471
+ * "sort": {
3472
+ * "name": "asc",
3473
+ * "lastModified": "desc"
3474
+ * }
3475
+ * ```
2893
3476
  *
2894
- * Example: ```[ "color", "lastName" ]``` */
3477
+ * NOTE: Regarding sort field order, (aka: `asc|desc`) : Sort field names can be specified as EITHER: field name alone (implies asc order), eg: `"favColor"`, OR field name with order suffix `asc|desc` (delimited by tilde). eg: `"favColor~desc"`. */
2895
3478
  sort?: string[] | "asc" | "desc" | string | undefined;
2896
3479
  skip?: number | undefined;
2897
3480
  take?: number | undefined;
3481
+ /** Declares that the data be returned in the opposite order than what is specified by the `sort` property. */
3482
+ reverse?: number | boolean | undefined;
2898
3483
  }
2899
3484
  export interface TenantRegistrationRequest {
2900
3485
  tenantName: string;
@@ -2986,16 +3571,28 @@ export interface VersionConfigCriteria {
2986
3571
  assetVersion?: StringFilter | undefined;
2987
3572
  ids?: string[] | undefined;
2988
3573
  all?: boolean | undefined;
2989
- /** Specification for the sort order of a query.
2990
- *
2991
- * Example: ```{ "color": "asc", size: OrderEnum.desc }```
2992
- *
2993
- * Example: ```"color"```
3574
+ /** supports a single field name
3575
+ * ```json
3576
+ * "sort": "name"
3577
+ * ```
3578
+ * or an array of field names
3579
+ * ```json
3580
+ * "sort": ["name", "lastModified~desc"]
3581
+ * ```
3582
+ * or an object dictionary of `fieldName: asc|desc` pairs, eg:
3583
+ * ```json
3584
+ * "sort": {
3585
+ * "name": "asc",
3586
+ * "lastModified": "desc"
3587
+ * }
3588
+ * ```
2994
3589
  *
2995
- * Example: ```[ "color", "lastName" ]``` */
3590
+ * NOTE: Regarding sort field order, (aka: `asc|desc`) : Sort field names can be specified as EITHER: field name alone (implies asc order), eg: `"favColor"`, OR field name with order suffix `asc|desc` (delimited by tilde). eg: `"favColor~desc"`. */
2996
3591
  sort?: string[] | "asc" | "desc" | string | undefined;
2997
3592
  skip?: number | undefined;
2998
3593
  take?: number | undefined;
3594
+ /** Declares that the data be returned in the opposite order than what is specified by the `sort` property. */
3595
+ reverse?: number | boolean | undefined;
2999
3596
  }
3000
3597
  export interface VersionCreateActivity {
3001
3598
  enterpriseVersion: string;
@@ -3021,16 +3618,28 @@ export interface VersionCreateActivityCriteria {
3021
3618
  assetsName?: string | undefined;
3022
3619
  ids?: string[] | undefined;
3023
3620
  all?: boolean | undefined;
3024
- /** Specification for the sort order of a query.
3025
- *
3026
- * Example: ```{ "color": "asc", size: OrderEnum.desc }```
3027
- *
3028
- * Example: ```"color"```
3621
+ /** supports a single field name
3622
+ * ```json
3623
+ * "sort": "name"
3624
+ * ```
3625
+ * or an array of field names
3626
+ * ```json
3627
+ * "sort": ["name", "lastModified~desc"]
3628
+ * ```
3629
+ * or an object dictionary of `fieldName: asc|desc` pairs, eg:
3630
+ * ```json
3631
+ * "sort": {
3632
+ * "name": "asc",
3633
+ * "lastModified": "desc"
3634
+ * }
3635
+ * ```
3029
3636
  *
3030
- * Example: ```[ "color", "lastName" ]``` */
3637
+ * NOTE: Regarding sort field order, (aka: `asc|desc`) : Sort field names can be specified as EITHER: field name alone (implies asc order), eg: `"favColor"`, OR field name with order suffix `asc|desc` (delimited by tilde). eg: `"favColor~desc"`. */
3031
3638
  sort?: string[] | "asc" | "desc" | string | undefined;
3032
3639
  skip?: number | undefined;
3033
3640
  take?: number | undefined;
3641
+ /** Declares that the data be returned in the opposite order than what is specified by the `sort` property. */
3642
+ reverse?: number | boolean | undefined;
3034
3643
  }
3035
3644
  export interface VersionGetsertRequest {
3036
3645
  overlays: AssetVersion[];
@@ -3074,16 +3683,28 @@ export interface WorkFlowStrategyCriteria {
3074
3683
  name?: StringFilter | undefined;
3075
3684
  ids?: string[] | undefined;
3076
3685
  all?: boolean | undefined;
3077
- /** Specification for the sort order of a query.
3078
- *
3079
- * Example: ```{ "color": "asc", size: OrderEnum.desc }```
3080
- *
3081
- * Example: ```"color"```
3686
+ /** supports a single field name
3687
+ * ```json
3688
+ * "sort": "name"
3689
+ * ```
3690
+ * or an array of field names
3691
+ * ```json
3692
+ * "sort": ["name", "lastModified~desc"]
3693
+ * ```
3694
+ * or an object dictionary of `fieldName: asc|desc` pairs, eg:
3695
+ * ```json
3696
+ * "sort": {
3697
+ * "name": "asc",
3698
+ * "lastModified": "desc"
3699
+ * }
3700
+ * ```
3082
3701
  *
3083
- * Example: ```[ "color", "lastName" ]``` */
3702
+ * NOTE: Regarding sort field order, (aka: `asc|desc`) : Sort field names can be specified as EITHER: field name alone (implies asc order), eg: `"favColor"`, OR field name with order suffix `asc|desc` (delimited by tilde). eg: `"favColor~desc"`. */
3084
3703
  sort?: string[] | "asc" | "desc" | string | undefined;
3085
3704
  skip?: number | undefined;
3086
3705
  take?: number | undefined;
3706
+ /** Declares that the data be returned in the opposite order than what is specified by the `sort` property. */
3707
+ reverse?: number | boolean | undefined;
3087
3708
  }
3088
3709
  /** A declaration of a template for a weekly timespan during which the given scope target will be in zombie mode. */
3089
3710
  export interface ZombiePeriod {
@@ -3107,16 +3728,28 @@ export interface ZombiePeriodCriteria {
3107
3728
  name?: string | undefined;
3108
3729
  ids?: string[] | undefined;
3109
3730
  all?: boolean | undefined;
3110
- /** Specification for the sort order of a query.
3111
- *
3112
- * Example: ```{ "color": "asc", size: OrderEnum.desc }```
3113
- *
3114
- * Example: ```"color"```
3731
+ /** supports a single field name
3732
+ * ```json
3733
+ * "sort": "name"
3734
+ * ```
3735
+ * or an array of field names
3736
+ * ```json
3737
+ * "sort": ["name", "lastModified~desc"]
3738
+ * ```
3739
+ * or an object dictionary of `fieldName: asc|desc` pairs, eg:
3740
+ * ```json
3741
+ * "sort": {
3742
+ * "name": "asc",
3743
+ * "lastModified": "desc"
3744
+ * }
3745
+ * ```
3115
3746
  *
3116
- * Example: ```[ "color", "lastName" ]``` */
3747
+ * NOTE: Regarding sort field order, (aka: `asc|desc`) : Sort field names can be specified as EITHER: field name alone (implies asc order), eg: `"favColor"`, OR field name with order suffix `asc|desc` (delimited by tilde). eg: `"favColor~desc"`. */
3117
3748
  sort?: string[] | "asc" | "desc" | string | undefined;
3118
3749
  skip?: number | undefined;
3119
3750
  take?: number | undefined;
3751
+ /** Declares that the data be returned in the opposite order than what is specified by the `sort` property. */
3752
+ reverse?: number | boolean | undefined;
3120
3753
  }
3121
3754
  export interface UpdatePartialWhereRequest<T, TCriteria> {
3122
3755
  criteria: TCriteria;