@codiac.io/codiac-cli 1.2.232 → 1.2.234

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.
@@ -27,14 +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;
48
+ skip?: number | undefined;
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;
38
52
  }
39
53
  export declare enum ActivityTypeEnum {
40
54
  cabinetCreate = "cabinetCreate",
@@ -191,14 +205,28 @@ export interface AssetCriteria {
191
205
  hasIngress?: boolean | undefined;
192
206
  ids?: string[] | undefined;
193
207
  all?: boolean | undefined;
194
- /** Specification for the sort order of a query.
195
- *
196
- * Example: ```{ "color": "asc", size: OrderEnum.desc }```
197
- *
198
- * 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
+ * ```
199
223
  *
200
- * 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"`. */
201
225
  sort?: string[] | "asc" | "desc" | string | undefined;
226
+ skip?: number | undefined;
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;
202
230
  }
203
231
  /** Abstract declarations of folder paths inside the image
204
232
  * that are to be later mapped (at configuration time) to file store definitions. */
@@ -271,14 +299,28 @@ export interface AssetVersionConfigCriteria {
271
299
  labels?: object | undefined;
272
300
  ids?: string[] | undefined;
273
301
  all?: boolean | undefined;
274
- /** Specification for the sort order of a query.
275
- *
276
- * Example: ```{ "color": "asc", size: OrderEnum.desc }```
277
- *
278
- * 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
+ * ```
279
317
  *
280
- * 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"`. */
281
319
  sort?: string[] | "asc" | "desc" | string | undefined;
320
+ skip?: number | undefined;
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;
282
324
  }
283
325
  export interface AuthenticationRequest {
284
326
  login: string;
@@ -382,14 +424,28 @@ export interface BuildCriteria {
382
424
  name?: StringFilter | undefined;
383
425
  ids?: string[] | undefined;
384
426
  all?: boolean | undefined;
385
- /** Specification for the sort order of a query.
386
- *
387
- * Example: ```{ "color": "asc", size: OrderEnum.desc }```
388
- *
389
- * 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
+ * ```
390
442
  *
391
- * 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"`. */
392
444
  sort?: string[] | "asc" | "desc" | string | undefined;
445
+ skip?: number | undefined;
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;
393
449
  }
394
450
  export interface BuildPipeline {
395
451
  name: string;
@@ -403,14 +459,28 @@ export interface BuildPipelineCriteria {
403
459
  name?: StringFilter | undefined;
404
460
  ids?: string[] | undefined;
405
461
  all?: boolean | undefined;
406
- /** Specification for the sort order of a query.
407
- *
408
- * Example: ```{ "color": "asc", size: OrderEnum.desc }```
409
- *
410
- * 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
+ * ```
411
477
  *
412
- * 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"`. */
413
479
  sort?: string[] | "asc" | "desc" | string | undefined;
480
+ skip?: number | undefined;
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;
414
484
  }
415
485
  /** A placeholder configuring an isolated instance of a fully functional,
416
486
  * independent implementation of the customer's service inventory.
@@ -524,14 +594,28 @@ export interface CabinetCreateActivityCriteria {
524
594
  assetsName?: string | undefined;
525
595
  ids?: string[] | undefined;
526
596
  all?: boolean | undefined;
527
- /** Specification for the sort order of a query.
528
- *
529
- * Example: ```{ "color": "asc", size: OrderEnum.desc }```
530
- *
531
- * 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
+ * ```
532
612
  *
533
- * 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"`. */
534
614
  sort?: string[] | "asc" | "desc" | string | undefined;
615
+ skip?: number | undefined;
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;
535
619
  }
536
620
  export interface CabinetCriteria {
537
621
  name?: StringFilter | undefined;
@@ -541,14 +625,28 @@ export interface CabinetCriteria {
541
625
  branch?: StringFilter | undefined;
542
626
  ids?: string[] | undefined;
543
627
  all?: boolean | undefined;
544
- /** Specification for the sort order of a query.
545
- *
546
- * Example: ```{ "color": "asc", size: OrderEnum.desc }```
547
- *
548
- * 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
+ * ```
549
643
  *
550
- * 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"`. */
551
645
  sort?: string[] | "asc" | "desc" | string | undefined;
646
+ skip?: number | undefined;
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;
552
650
  }
553
651
  /** The host naming strategies applicable in a given cabinet.
554
652
  *
@@ -568,14 +666,28 @@ export interface CabinetHostNameConfigCriteria {
568
666
  strategy?: string | undefined;
569
667
  ids?: string[] | undefined;
570
668
  all?: boolean | undefined;
571
- /** Specification for the sort order of a query.
572
- *
573
- * Example: ```{ "color": "asc", size: OrderEnum.desc }```
574
- *
575
- * 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
+ * ```
576
684
  *
577
- * 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"`. */
578
686
  sort?: string[] | "asc" | "desc" | string | undefined;
687
+ skip?: number | undefined;
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;
579
691
  }
580
692
  /** Attributes for referencing and creating actual running resources that comprise the infrastructure for a cabinet.
581
693
  * That is, this is the pertinent information required to manage an actual physical implementation of a cabinet. */
@@ -617,14 +729,28 @@ export interface CabinetScopesCriteria {
617
729
  scope?: Scope | undefined;
618
730
  ids?: string[] | undefined;
619
731
  all?: boolean | undefined;
620
- /** Specification for the sort order of a query.
621
- *
622
- * Example: ```{ "color": "asc", size: OrderEnum.desc }```
623
- *
624
- * 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
+ * ```
625
747
  *
626
- * 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"`. */
627
749
  sort?: string[] | "asc" | "desc" | string | undefined;
750
+ skip?: number | undefined;
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;
628
754
  }
629
755
  export interface ChangePasswordRequest {
630
756
  login: string;
@@ -665,14 +791,28 @@ export interface ClusterCriteria {
665
791
  managedResourceGroupName?: StringFilter | undefined;
666
792
  ids?: string[] | undefined;
667
793
  all?: boolean | undefined;
668
- /** Specification for the sort order of a query.
669
- *
670
- * Example: ```{ "color": "asc", size: OrderEnum.desc }```
671
- *
672
- * 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
+ * ```
673
809
  *
674
- * 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"`. */
675
811
  sort?: string[] | "asc" | "desc" | string | undefined;
812
+ skip?: number | undefined;
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;
676
816
  }
677
817
  /** The specs for a kubernetes cluster to be managed by the Codiac team.
678
818
  * This class is used to programmatically put up and take down clusters. */
@@ -735,14 +875,28 @@ export interface ClusterDefCriteria {
735
875
  privateOwner?: string | undefined;
736
876
  ids?: string[] | undefined;
737
877
  all?: boolean | undefined;
738
- /** Specification for the sort order of a query.
739
- *
740
- * Example: ```{ "color": "asc", size: OrderEnum.desc }```
741
- *
742
- * 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
+ * ```
743
893
  *
744
- * 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"`. */
745
895
  sort?: string[] | "asc" | "desc" | string | undefined;
896
+ skip?: number | undefined;
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;
746
900
  }
747
901
  /** Similar to an ACL for a cluster: declares an access level for a user on a cluster. */
748
902
  export interface ClusterGrant {
@@ -761,14 +915,28 @@ export interface ClusterGrantCriteria {
761
915
  accessLevel?: string | undefined;
762
916
  ids?: string[] | undefined;
763
917
  all?: boolean | undefined;
764
- /** Specification for the sort order of a query.
765
- *
766
- * Example: ```{ "color": "asc", size: OrderEnum.desc }```
767
- *
768
- * 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
+ * ```
769
933
  *
770
- * 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"`. */
771
935
  sort?: string[] | "asc" | "desc" | string | undefined;
936
+ skip?: number | undefined;
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;
772
940
  }
773
941
  export interface ClusterWithIngress {
774
942
  name: string;
@@ -860,14 +1028,28 @@ export interface CommentCriteria {
860
1028
  createdBy?: string | undefined;
861
1029
  ids?: string[] | undefined;
862
1030
  all?: boolean | undefined;
863
- /** Specification for the sort order of a query.
864
- *
865
- * Example: ```{ "color": "asc", size: OrderEnum.desc }```
866
- *
867
- * 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
+ * ```
868
1046
  *
869
- * 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"`. */
870
1048
  sort?: string[] | "asc" | "desc" | string | undefined;
1049
+ skip?: number | undefined;
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;
871
1053
  }
872
1054
  /** An historical record of a change made to the the configuration of the an enterprise for a given cabinet,
873
1055
  * to be used, together with the latest preceeding snapshot and other change events, as the specification for a deployment.
@@ -887,14 +1069,28 @@ export interface ConfigChangeCriteria {
887
1069
  cabinet?: StringFilter | undefined;
888
1070
  ids?: string[] | undefined;
889
1071
  all?: boolean | undefined;
890
- /** Specification for the sort order of a query.
891
- *
892
- * Example: ```{ "color": "asc", size: OrderEnum.desc }```
893
- *
894
- * 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
+ * ```
895
1087
  *
896
- * 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"`. */
897
1089
  sort?: string[] | "asc" | "desc" | string | undefined;
1090
+ skip?: number | undefined;
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;
898
1094
  }
899
1095
  export interface ConfigDef {
900
1096
  enterprise: string;
@@ -916,14 +1112,28 @@ export interface ConfigDefCriteria {
916
1112
  format?: string | undefined;
917
1113
  ids?: string[] | undefined;
918
1114
  all?: boolean | undefined;
919
- /** Specification for the sort order of a query.
920
- *
921
- * Example: ```{ "color": "asc", size: OrderEnum.desc }```
922
- *
923
- * 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
+ * ```
924
1130
  *
925
- * 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"`. */
926
1132
  sort?: string[] | "asc" | "desc" | string | undefined;
1133
+ skip?: number | undefined;
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;
927
1137
  }
928
1138
  /** Values of ScopedSetting.targetFile for NON-FILE configs. */
929
1139
  export declare enum ConfigDefTypesEnum {
@@ -982,14 +1192,28 @@ export interface ConfigDeploymentActivityCriteria {
982
1192
  assetsName?: string | undefined;
983
1193
  ids?: string[] | undefined;
984
1194
  all?: boolean | undefined;
985
- /** Specification for the sort order of a query.
986
- *
987
- * Example: ```{ "color": "asc", size: OrderEnum.desc }```
988
- *
989
- * 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
+ * ```
990
1210
  *
991
- * 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"`. */
992
1212
  sort?: string[] | "asc" | "desc" | string | undefined;
1213
+ skip?: number | undefined;
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;
993
1217
  }
994
1218
  /** An object representation of a config file, assembled from ScopedSettings.
995
1219
  * This document can take any form, and is constructed solely from settings and values,
@@ -1006,14 +1230,28 @@ export interface ConfigDocSpecForOne {
1006
1230
  cabinet: string;
1007
1231
  ids?: string[] | undefined;
1008
1232
  all?: boolean | undefined;
1009
- /** Specification for the sort order of a query.
1010
- *
1011
- * Example: ```{ "color": "asc", size: OrderEnum.desc }```
1012
- *
1013
- * 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
+ * ```
1014
1248
  *
1015
- * 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"`. */
1016
1250
  sort?: string[] | "asc" | "desc" | string | undefined;
1251
+ skip?: number | undefined;
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;
1017
1255
  }
1018
1256
  /** Serializer declaration for a data document. */
1019
1257
  export declare enum ConfigFormatsEnum {
@@ -1062,14 +1300,28 @@ export interface ContainerFootprintCriteria {
1062
1300
  componentName?: StringFilter | undefined;
1063
1301
  ids?: string[] | undefined;
1064
1302
  all?: boolean | undefined;
1065
- /** Specification for the sort order of a query.
1066
- *
1067
- * Example: ```{ "color": "asc", size: OrderEnum.desc }```
1068
- *
1069
- * 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
+ * ```
1070
1318
  *
1071
- * 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"`. */
1072
1320
  sort?: string[] | "asc" | "desc" | string | undefined;
1321
+ skip?: number | undefined;
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;
1073
1325
  }
1074
1326
  export interface CspTenantProfile {
1075
1327
  provider: CloudProviderEnum;
@@ -1089,14 +1341,28 @@ export interface CspTenantProfileCriteria {
1089
1341
  cspTenantId?: string | undefined;
1090
1342
  ids?: string[] | undefined;
1091
1343
  all?: boolean | undefined;
1092
- /** Specification for the sort order of a query.
1093
- *
1094
- * Example: ```{ "color": "asc", size: OrderEnum.desc }```
1095
- *
1096
- * 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
+ * ```
1097
1359
  *
1098
- * 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"`. */
1099
1361
  sort?: string[] | "asc" | "desc" | string | undefined;
1362
+ skip?: number | undefined;
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;
1100
1366
  }
1101
1367
  export interface DeployAttempt {
1102
1368
  name: string;
@@ -1112,14 +1378,28 @@ export interface DeployAttemptCriteria {
1112
1378
  name?: StringFilter | undefined;
1113
1379
  ids?: string[] | undefined;
1114
1380
  all?: boolean | undefined;
1115
- /** Specification for the sort order of a query.
1116
- *
1117
- * Example: ```{ "color": "asc", size: OrderEnum.desc }```
1118
- *
1119
- * 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
+ * ```
1120
1396
  *
1121
- * 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"`. */
1122
1398
  sort?: string[] | "asc" | "desc" | string | undefined;
1399
+ skip?: number | undefined;
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;
1123
1403
  }
1124
1404
  /** The specification for a deployment of an enterprise to a cabinet.
1125
1405
  * NOTE:
@@ -1176,14 +1456,28 @@ export interface DeploymentActivityCriteria {
1176
1456
  assetsName?: string | undefined;
1177
1457
  ids?: string[] | undefined;
1178
1458
  all?: boolean | undefined;
1179
- /** Specification for the sort order of a query.
1180
- *
1181
- * Example: ```{ "color": "asc", size: OrderEnum.desc }```
1182
- *
1183
- * 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
+ * ```
1184
1474
  *
1185
- * 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"`. */
1186
1476
  sort?: string[] | "asc" | "desc" | string | undefined;
1477
+ skip?: number | undefined;
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;
1187
1481
  }
1188
1482
  export interface DeploymentCriteria {
1189
1483
  id?: StringFilter | undefined;
@@ -1192,14 +1486,28 @@ export interface DeploymentCriteria {
1192
1486
  cabinet?: StringFilter | undefined;
1193
1487
  ids?: string[] | undefined;
1194
1488
  all?: boolean | undefined;
1195
- /** Specification for the sort order of a query.
1196
- *
1197
- * Example: ```{ "color": "asc", size: OrderEnum.desc }```
1198
- *
1199
- * 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
+ * ```
1200
1504
  *
1201
- * 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"`. */
1202
1506
  sort?: string[] | "asc" | "desc" | string | undefined;
1507
+ skip?: number | undefined;
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;
1203
1511
  }
1204
1512
  export interface DeployPipeline {
1205
1513
  name: string;
@@ -1213,14 +1521,28 @@ export interface DeployPipelineCriteria {
1213
1521
  name?: StringFilter | undefined;
1214
1522
  ids?: string[] | undefined;
1215
1523
  all?: boolean | undefined;
1216
- /** Specification for the sort order of a query.
1217
- *
1218
- * Example: ```{ "color": "asc", size: OrderEnum.desc }```
1219
- *
1220
- * 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
+ * ```
1221
1539
  *
1222
- * 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"`. */
1223
1541
  sort?: string[] | "asc" | "desc" | string | undefined;
1542
+ skip?: number | undefined;
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;
1224
1546
  }
1225
1547
  /** Defines a discriminated (tagged) union of different record types.
1226
1548
  *
@@ -1267,14 +1589,28 @@ export interface EnterpriseCriteria {
1267
1589
  subscription?: string | undefined;
1268
1590
  ids?: string[] | undefined;
1269
1591
  all?: boolean | undefined;
1270
- /** Specification for the sort order of a query.
1271
- *
1272
- * Example: ```{ "color": "asc", size: OrderEnum.desc }```
1273
- *
1274
- * 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
+ * ```
1275
1607
  *
1276
- * 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"`. */
1277
1609
  sort?: string[] | "asc" | "desc" | string | undefined;
1610
+ skip?: number | undefined;
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;
1278
1614
  }
1279
1615
  export interface EnterpriseRoot {
1280
1616
  name: string;
@@ -1311,14 +1647,28 @@ export interface EnterpriseRunStateCriteria {
1311
1647
  contentHash?: string | undefined;
1312
1648
  ids?: string[] | undefined;
1313
1649
  all?: boolean | undefined;
1314
- /** Specification for the sort order of a query.
1315
- *
1316
- * Example: ```{ "color": "asc", size: OrderEnum.desc }```
1317
- *
1318
- * 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
+ * ```
1319
1665
  *
1320
- * 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"`. */
1321
1667
  sort?: string[] | "asc" | "desc" | string | undefined;
1668
+ skip?: number | undefined;
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;
1322
1672
  }
1323
1673
  /** A reference to an enterprise and its environment scopes. */
1324
1674
  export interface EnterpriseScope {
@@ -1355,14 +1705,28 @@ export interface EnterpriseVersionConfigCriteria {
1355
1705
  labels?: object | undefined;
1356
1706
  ids?: string[] | undefined;
1357
1707
  all?: boolean | undefined;
1358
- /** Specification for the sort order of a query.
1359
- *
1360
- * Example: ```{ "color": "asc", size: OrderEnum.desc }```
1361
- *
1362
- * 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
+ * ```
1363
1723
  *
1364
- * 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"`. */
1365
1725
  sort?: string[] | "asc" | "desc" | string | undefined;
1726
+ skip?: number | undefined;
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;
1366
1730
  }
1367
1731
  /** Access Control List (ACL) for a single securable object.
1368
1732
  * A list of permissions declared on a single, identifiable concrete entity. */
@@ -1442,14 +1806,28 @@ export interface EnvironmentCriteria {
1442
1806
  subscription?: string | undefined;
1443
1807
  ids?: string[] | undefined;
1444
1808
  all?: boolean | undefined;
1445
- /** Specification for the sort order of a query.
1446
- *
1447
- * Example: ```{ "color": "asc", size: OrderEnum.desc }```
1448
- *
1449
- * 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
+ * ```
1450
1824
  *
1451
- * 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"`. */
1452
1826
  sort?: string[] | "asc" | "desc" | string | undefined;
1827
+ skip?: number | undefined;
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;
1453
1831
  }
1454
1832
  /** A reference to an environment and its cabinets. */
1455
1833
  export interface EnvironmentRoot {
@@ -1501,14 +1879,28 @@ export interface FileStoreDefCriteria {
1501
1879
  providerSubscriptionId?: StringFilter | undefined;
1502
1880
  ids?: string[] | undefined;
1503
1881
  all?: boolean | undefined;
1504
- /** Specification for the sort order of a query.
1505
- *
1506
- * Example: ```{ "color": "asc", size: OrderEnum.desc }```
1507
- *
1508
- * 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
+ * ```
1509
1897
  *
1510
- * 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"`. */
1511
1899
  sort?: string[] | "asc" | "desc" | string | undefined;
1900
+ skip?: number | undefined;
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;
1512
1904
  }
1513
1905
  /** Metadata describing an existing concrete instance
1514
1906
  * of a FileStoreDef resource within a cloud provider. */
@@ -1673,14 +2065,28 @@ export interface ImageCriteria {
1673
2065
  name?: StringFilter | undefined;
1674
2066
  ids?: string[] | undefined;
1675
2067
  all?: boolean | undefined;
1676
- /** Specification for the sort order of a query.
1677
- *
1678
- * Example: ```{ "color": "asc", size: OrderEnum.desc }```
1679
- *
1680
- * 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
+ * ```
1681
2083
  *
1682
- * 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"`. */
1683
2085
  sort?: string[] | "asc" | "desc" | string | undefined;
2086
+ skip?: number | undefined;
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;
1684
2090
  }
1685
2091
  export interface ImageRegistry {
1686
2092
  id?: string | undefined;
@@ -1710,14 +2116,28 @@ export interface ImageRegistryCriteria {
1710
2116
  url?: StringFilter | undefined;
1711
2117
  ids?: string[] | undefined;
1712
2118
  all?: boolean | undefined;
1713
- /** Specification for the sort order of a query.
1714
- *
1715
- * Example: ```{ "color": "asc", size: OrderEnum.desc }```
1716
- *
1717
- * 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
+ * ```
1718
2134
  *
1719
- * 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"`. */
1720
2136
  sort?: string[] | "asc" | "desc" | string | undefined;
2137
+ skip?: number | undefined;
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;
1721
2141
  }
1722
2142
  /** Matches an ImageRegistry entity, just isnt a domain entity or auditable.
1723
2143
  * This class is for use as a request: it is NOT A DOMAIN ENTITY. */
@@ -1917,14 +2337,28 @@ export interface KitCriteria {
1917
2337
  tags?: StringListFilter | undefined;
1918
2338
  ids?: string[] | undefined;
1919
2339
  all?: boolean | undefined;
1920
- /** Specification for the sort order of a query.
1921
- *
1922
- * Example: ```{ "color": "asc", size: OrderEnum.desc }```
1923
- *
1924
- * 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
+ * ```
1925
2355
  *
1926
- * 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"`. */
1927
2357
  sort?: string[] | "asc" | "desc" | string | undefined;
2358
+ skip?: number | undefined;
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;
1928
2362
  }
1929
2363
  /** The information needed to access an individual key value pair
1930
2364
  * from a predefined data store. */
@@ -1964,14 +2398,28 @@ export interface KvpStoreDefCriteria {
1964
2398
  type?: "awsKeyVault" | "azBlob" | "azKeyVault" | "etcd" | "mongoCollection" | "mongoDocument" | undefined;
1965
2399
  ids?: string[] | undefined;
1966
2400
  all?: boolean | undefined;
1967
- /** Specification for the sort order of a query.
1968
- *
1969
- * Example: ```{ "color": "asc", size: OrderEnum.desc }```
1970
- *
1971
- * 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
+ * ```
1972
2416
  *
1973
- * 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"`. */
1974
2418
  sort?: string[] | "asc" | "desc" | string | undefined;
2419
+ skip?: number | undefined;
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;
1975
2423
  }
1976
2424
  export interface KvpStoreInfrx {
1977
2425
  type: KvpStoreTypesEnum;
@@ -2021,14 +2469,28 @@ export interface LabelCriteria {
2021
2469
  createdBy?: string | undefined;
2022
2470
  ids?: string[] | undefined;
2023
2471
  all?: boolean | undefined;
2024
- /** Specification for the sort order of a query.
2025
- *
2026
- * Example: ```{ "color": "asc", size: OrderEnum.desc }```
2027
- *
2028
- * 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
+ * ```
2029
2487
  *
2030
- * 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"`. */
2031
2489
  sort?: string[] | "asc" | "desc" | string | undefined;
2490
+ skip?: number | undefined;
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;
2032
2494
  }
2033
2495
  export interface MyTenantRequest {
2034
2496
  }
@@ -2098,14 +2560,28 @@ export interface NodePoolDefCriteria {
2098
2560
  isWindows?: boolean | undefined;
2099
2561
  ids?: string[] | undefined;
2100
2562
  all?: boolean | undefined;
2101
- /** Specification for the sort order of a query.
2102
- *
2103
- * Example: ```{ "color": "asc", size: OrderEnum.desc }```
2104
- *
2105
- * 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
+ * ```
2106
2578
  *
2107
- * 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"`. */
2108
2580
  sort?: string[] | "asc" | "desc" | string | undefined;
2581
+ skip?: number | undefined;
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;
2109
2585
  }
2110
2586
  /** AUTHOR NOTE:
2111
2587
  * This filter approach does NOT provide for:
@@ -2256,14 +2732,28 @@ export interface ProbeCriteria {
2256
2732
  disabled?: boolean | undefined;
2257
2733
  ids?: string[] | undefined;
2258
2734
  all?: boolean | undefined;
2259
- /** Specification for the sort order of a query.
2260
- *
2261
- * Example: ```{ "color": "asc", size: OrderEnum.desc }```
2262
- *
2263
- * 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
+ * ```
2264
2750
  *
2265
- * 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"`. */
2266
2752
  sort?: string[] | "asc" | "desc" | string | undefined;
2753
+ skip?: number | undefined;
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;
2267
2757
  }
2268
2758
  /** Declaration of what purpose the probe serves,
2269
2759
  * ie: where a probe is fired in the runtime lifecycle of an asset. */
@@ -2290,14 +2780,28 @@ export interface ProductCriteria {
2290
2780
  assetCodes?: StringListFilter | undefined;
2291
2781
  ids?: string[] | undefined;
2292
2782
  all?: boolean | undefined;
2293
- /** Specification for the sort order of a query.
2294
- *
2295
- * Example: ```{ "color": "asc", size: OrderEnum.desc }```
2296
- *
2297
- * 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
+ * ```
2298
2798
  *
2299
- * 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"`. */
2300
2800
  sort?: string[] | "asc" | "desc" | string | undefined;
2801
+ skip?: number | undefined;
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;
2301
2805
  }
2302
2806
  export interface ProductVersionConfig {
2303
2807
  productName: string;
@@ -2330,14 +2834,28 @@ export interface ProductVersionConfigCriteria {
2330
2834
  multi?: object[] | undefined;
2331
2835
  ids?: string[] | undefined;
2332
2836
  all?: boolean | undefined;
2333
- /** Specification for the sort order of a query.
2334
- *
2335
- * Example: ```{ "color": "asc", size: OrderEnum.desc }```
2336
- *
2337
- * 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
+ * ```
2338
2852
  *
2339
- * 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"`. */
2340
2854
  sort?: string[] | "asc" | "desc" | string | undefined;
2855
+ skip?: number | undefined;
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;
2341
2859
  }
2342
2860
  /** Defines an object with required and optional properties
2343
2861
  *
@@ -2430,14 +2948,28 @@ export interface RootMapCriteria {
2430
2948
  cluster?: string | undefined;
2431
2949
  ids?: string[] | undefined;
2432
2950
  all?: boolean | undefined;
2433
- /** Specification for the sort order of a query.
2434
- *
2435
- * Example: ```{ "color": "asc", size: OrderEnum.desc }```
2436
- *
2437
- * 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
+ * ```
2438
2966
  *
2439
- * 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"`. */
2440
2968
  sort?: string[] | "asc" | "desc" | string | undefined;
2969
+ skip?: number | undefined;
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;
2441
2973
  }
2442
2974
  export interface Scope {
2443
2975
  /** The level of the scope (eg: enterprise, environment, cluster, cabinet, asset, etc).
@@ -2476,14 +3008,28 @@ export interface ScopedConfigCriteria {
2476
3008
  targetFile?: StringFilter | undefined;
2477
3009
  ids?: string[] | undefined;
2478
3010
  all?: boolean | undefined;
2479
- /** Specification for the sort order of a query.
2480
- *
2481
- * Example: ```{ "color": "asc", size: OrderEnum.desc }```
2482
- *
2483
- * 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
+ * ```
2484
3026
  *
2485
- * 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"`. */
2486
3028
  sort?: string[] | "asc" | "desc" | string | undefined;
3029
+ skip?: number | undefined;
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;
2487
3033
  }
2488
3034
  /** An assignment of a HostNameStrategy for a single domain at a specific scope. */
2489
3035
  export interface ScopedHostNameConfig {
@@ -2517,14 +3063,28 @@ export interface ScopedHostNameConfigCriteria {
2517
3063
  applicableTo?: HostNameConfigCabinetScopeFilter | undefined;
2518
3064
  ids?: string[] | undefined;
2519
3065
  all?: boolean | undefined;
2520
- /** Specification for the sort order of a query.
2521
- *
2522
- * Example: ```{ "color": "asc", size: OrderEnum.desc }```
2523
- *
2524
- * 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
+ * ```
2525
3081
  *
2526
- * 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"`. */
2527
3083
  sort?: string[] | "asc" | "desc" | string | undefined;
3084
+ skip?: number | undefined;
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;
2528
3088
  }
2529
3089
  /** A single key-value setting within a config for an asset, scoped for its ultimate deployment context.
2530
3090
  * That is, this is the value of one setting within a config file (the targetFile param);
@@ -2561,14 +3121,28 @@ export interface ScopedSettingCriteria {
2561
3121
  targetCabinet?: ScopeFilter | undefined;
2562
3122
  ids?: string[] | undefined;
2563
3123
  all?: boolean | undefined;
2564
- /** Specification for the sort order of a query.
2565
- *
2566
- * Example: ```{ "color": "asc", size: OrderEnum.desc }```
2567
- *
2568
- * 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
+ * ```
2569
3139
  *
2570
- * 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"`. */
2571
3141
  sort?: string[] | "asc" | "desc" | string | undefined;
3142
+ skip?: number | undefined;
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;
2572
3146
  }
2573
3147
  /** Creates a filter expression that includes
2574
3148
  * all entities whose scopes are relevant input for a smash-merge
@@ -2654,14 +3228,28 @@ export interface SetupJournalCriteria {
2654
3228
  resourceId?: string | undefined;
2655
3229
  ids?: string[] | undefined;
2656
3230
  all?: boolean | undefined;
2657
- /** Specification for the sort order of a query.
2658
- *
2659
- * Example: ```{ "color": "asc", size: OrderEnum.desc }```
2660
- *
2661
- * 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
+ * ```
2662
3246
  *
2663
- * 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"`. */
2664
3248
  sort?: string[] | "asc" | "desc" | string | undefined;
3249
+ skip?: number | undefined;
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;
2665
3253
  }
2666
3254
  export interface SetupJournalEntry {
2667
3255
  name: string;
@@ -2703,14 +3291,28 @@ export interface SnapshotCriteria {
2703
3291
  cabinet?: StringFilter | undefined;
2704
3292
  ids?: string[] | undefined;
2705
3293
  all?: boolean | undefined;
2706
- /** Specification for the sort order of a query.
2707
- *
2708
- * Example: ```{ "color": "asc", size: OrderEnum.desc }```
2709
- *
2710
- * 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
+ * ```
2711
3309
  *
2712
- * 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"`. */
2713
3311
  sort?: string[] | "asc" | "desc" | string | undefined;
3312
+ skip?: number | undefined;
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;
2714
3316
  }
2715
3317
  export interface SourceRepo {
2716
3318
  name: string;
@@ -2724,14 +3326,28 @@ export interface SourceRepoCriteria {
2724
3326
  name?: StringFilter | undefined;
2725
3327
  ids?: string[] | undefined;
2726
3328
  all?: boolean | undefined;
2727
- /** Specification for the sort order of a query.
2728
- *
2729
- * Example: ```{ "color": "asc", size: OrderEnum.desc }```
2730
- *
2731
- * 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
+ * ```
2732
3344
  *
2733
- * 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"`. */
2734
3346
  sort?: string[] | "asc" | "desc" | string | undefined;
3347
+ skip?: number | undefined;
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;
2735
3351
  }
2736
3352
  export interface StringFilter {
2737
3353
  /** property of the target object to compare (conventional default to the name of the criteria property) */
@@ -2787,14 +3403,28 @@ export interface SubscriptionCriteria {
2787
3403
  tenantCode?: string | undefined;
2788
3404
  ids?: string[] | undefined;
2789
3405
  all?: boolean | undefined;
2790
- /** Specification for the sort order of a query.
2791
- *
2792
- * Example: ```{ "color": "asc", size: OrderEnum.desc }```
2793
- *
2794
- * 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
+ * ```
2795
3421
  *
2796
- * 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"`. */
2797
3423
  sort?: string[] | "asc" | "desc" | string | undefined;
3424
+ skip?: number | undefined;
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;
2798
3428
  }
2799
3429
  export declare enum SubscriptionStatus {
2800
3430
  cancelled = "cancelled",
@@ -2828,14 +3458,28 @@ export interface TagCriteria {
2828
3458
  createdBy?: string | undefined;
2829
3459
  ids?: string[] | undefined;
2830
3460
  all?: boolean | undefined;
2831
- /** Specification for the sort order of a query.
2832
- *
2833
- * Example: ```{ "color": "asc", size: OrderEnum.desc }```
2834
- *
2835
- * 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
+ * ```
2836
3476
  *
2837
- * 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"`. */
2838
3478
  sort?: string[] | "asc" | "desc" | string | undefined;
3479
+ skip?: number | undefined;
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;
2839
3483
  }
2840
3484
  export interface TenantRegistrationRequest {
2841
3485
  tenantName: string;
@@ -2927,14 +3571,28 @@ export interface VersionConfigCriteria {
2927
3571
  assetVersion?: StringFilter | undefined;
2928
3572
  ids?: string[] | undefined;
2929
3573
  all?: boolean | undefined;
2930
- /** Specification for the sort order of a query.
2931
- *
2932
- * Example: ```{ "color": "asc", size: OrderEnum.desc }```
2933
- *
2934
- * 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
+ * ```
2935
3589
  *
2936
- * 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"`. */
2937
3591
  sort?: string[] | "asc" | "desc" | string | undefined;
3592
+ skip?: number | undefined;
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;
2938
3596
  }
2939
3597
  export interface VersionCreateActivity {
2940
3598
  enterpriseVersion: string;
@@ -2960,14 +3618,28 @@ export interface VersionCreateActivityCriteria {
2960
3618
  assetsName?: string | undefined;
2961
3619
  ids?: string[] | undefined;
2962
3620
  all?: boolean | undefined;
2963
- /** Specification for the sort order of a query.
2964
- *
2965
- * Example: ```{ "color": "asc", size: OrderEnum.desc }```
2966
- *
2967
- * 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
+ * ```
2968
3636
  *
2969
- * 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"`. */
2970
3638
  sort?: string[] | "asc" | "desc" | string | undefined;
3639
+ skip?: number | undefined;
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;
2971
3643
  }
2972
3644
  export interface VersionGetsertRequest {
2973
3645
  overlays: AssetVersion[];
@@ -3011,14 +3683,28 @@ export interface WorkFlowStrategyCriteria {
3011
3683
  name?: StringFilter | undefined;
3012
3684
  ids?: string[] | undefined;
3013
3685
  all?: boolean | undefined;
3014
- /** Specification for the sort order of a query.
3015
- *
3016
- * Example: ```{ "color": "asc", size: OrderEnum.desc }```
3017
- *
3018
- * 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
+ * ```
3019
3701
  *
3020
- * 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"`. */
3021
3703
  sort?: string[] | "asc" | "desc" | string | undefined;
3704
+ skip?: number | undefined;
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;
3022
3708
  }
3023
3709
  /** A declaration of a template for a weekly timespan during which the given scope target will be in zombie mode. */
3024
3710
  export interface ZombiePeriod {
@@ -3042,12 +3728,30 @@ export interface ZombiePeriodCriteria {
3042
3728
  name?: string | undefined;
3043
3729
  ids?: string[] | undefined;
3044
3730
  all?: boolean | undefined;
3045
- /** Specification for the sort order of a query.
3046
- *
3047
- * Example: ```{ "color": "asc", size: OrderEnum.desc }```
3048
- *
3049
- * 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
+ * ```
3050
3746
  *
3051
- * 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"`. */
3052
3748
  sort?: string[] | "asc" | "desc" | string | undefined;
3749
+ skip?: number | undefined;
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;
3753
+ }
3754
+ export interface UpdatePartialWhereRequest<T, TCriteria> {
3755
+ criteria: TCriteria;
3756
+ operation: Partial<T>;
3053
3757
  }