@confighub/api 0.8.25 → 0.8.27

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 (3) hide show
  1. package/dist/index.d.cts +1618 -358
  2. package/dist/index.d.ts +1618 -358
  3. package/package.json +1 -1
package/dist/index.d.cts CHANGED
@@ -415,7 +415,11 @@ interface paths {
415
415
  */
416
416
  get: operations["ListAllChannels"];
417
417
  put?: never;
418
- post?: never;
418
+ /**
419
+ * Bulk create (clone) multiple channels
420
+ * @description Clone multiple channels selected by query parameters with optional name prefixes and destination spaces
421
+ */
422
+ post: operations["BulkCreateChannels"];
419
423
  /**
420
424
  * Bulk delete multiple channels
421
425
  * @description Delete multiple channels selected by query parameters
@@ -430,6 +434,26 @@ interface paths {
430
434
  patch: operations["BulkPatchChannels"];
431
435
  trace?: never;
432
436
  };
437
+ "/channel/move": {
438
+ parameters: {
439
+ query?: never;
440
+ header?: never;
441
+ path?: never;
442
+ cookie?: never;
443
+ };
444
+ get?: never;
445
+ put?: never;
446
+ /**
447
+ * Move channels to another space
448
+ * @description Move the selected Channels, with their command runs, to another Space. A Channel a client holds the lease of is not moved: its polls name the Space it is in. Requires Manage permission on each one moved and CreateChildren permission on the destination Space. Every check runs over the whole selection before anything is moved.
449
+ */
450
+ post: operations["BulkMoveChannels"];
451
+ delete?: never;
452
+ options?: never;
453
+ head?: never;
454
+ patch?: never;
455
+ trace?: never;
456
+ };
433
457
  "/command": {
434
458
  parameters: {
435
459
  query?: never;
@@ -1888,6 +1912,30 @@ interface paths {
1888
1912
  patch?: never;
1889
1913
  trace?: never;
1890
1914
  };
1915
+ "/space/{space_id}/channel/{channel_id}/document": {
1916
+ parameters: {
1917
+ query?: never;
1918
+ header?: never;
1919
+ path?: never;
1920
+ cookie?: never;
1921
+ };
1922
+ /**
1923
+ * Get the document of a Channel to edit
1924
+ * @description Returns the Channel as the document its backing Unit would hold: the fields a write can set, with the entities it refers to named rather than identified by ID, and its Version.
1925
+ */
1926
+ get: operations["GetChannelDocument"];
1927
+ put?: never;
1928
+ /**
1929
+ * Update a Channel from an edit of its document
1930
+ * @description Applies the change from Base, the document as read, to Document, as edited, as a patch of the Channel: a field the edit leaves alone keeps what the Channel holds, and a field it removes is cleared. A Version other than the Channel's is a conflict.
1931
+ */
1932
+ post: operations["UpdateChannelDocument"];
1933
+ delete?: never;
1934
+ options?: never;
1935
+ head?: never;
1936
+ patch?: never;
1937
+ trace?: never;
1938
+ };
1891
1939
  "/space/{space_id}/channel/{channel_id}/lease": {
1892
1940
  parameters: {
1893
1941
  query?: never;
@@ -4452,8 +4500,6 @@ interface components {
4452
4500
  * @example 248df4b7-aa70-47b8-a036-33ac447e668d
4453
4501
  */
4454
4502
  ChangeWorkflowID?: string;
4455
- /** @description ContainerImages lists, for each Space the ChangeOrder has landed in, the container images it changed there: in each Unit the end Tag marks, the images get-container-image finds that differ from those at the Revision the start Tag marks. Derived only when a single ChangeOrder is read with container_images=true, never in a list. Spaces and Units the reader cannot view are left out. */
4456
- readonly ContainerImages?: components["schemas"]["ChangeOrderSpaceContainerImages"][];
4457
4503
  /**
4458
4504
  * Format: date-time
4459
4505
  * @description The timestamp when the entity was created in "2023-01-01T12:00:00Z" format.
@@ -4640,36 +4686,6 @@ interface components {
4640
4686
  /** @description WhereUnit narrows which Units of each Space in scope an Invoke ChangeOrder covers, and is refused on the other UpdateTypes. It takes what the where parameter of the Unit list does, attributes of what a Unit refers to included, as in `Space.Labels.Environment = 'prod'`. Empty covers every Unit. Unlike InScopeSpaceIDs it is asked again on every read, so a Unit added to a Space afterwards counts against that Space. Immutable. */
4641
4687
  WhereUnit?: string;
4642
4688
  };
4643
- ChangeOrderContainerImageChange: {
4644
- /** @description The image before the change; absent for a container the change added. */
4645
- FromImage?: string;
4646
- /**
4647
- * Format: int64
4648
- * @description The Revision the start Tag marks; absent for a Unit the change added.
4649
- */
4650
- FromRevisionNum?: number;
4651
- /** @description The path of the image within the resource. */
4652
- Path?: string;
4653
- /** @description The name of the resource the container is in, as it is at the end Tag's Revision. */
4654
- ResourceName?: string;
4655
- /** @description The type of the resource the container is in. */
4656
- ResourceType?: string;
4657
- /** @description The image after the change; absent for a container the change removed. */
4658
- ToImage?: string;
4659
- /**
4660
- * Format: int64
4661
- * @description The Revision the end Tag marks.
4662
- */
4663
- ToRevisionNum?: number;
4664
- /**
4665
- * Format: uuid
4666
- * @description The Unit the image is in.
4667
- * @example 248df4b7-aa70-47b8-a036-33ac447e668d
4668
- */
4669
- UnitID?: string;
4670
- /** @description The Unit's slug. */
4671
- UnitSlug?: string;
4672
- };
4673
4689
  ChangeOrderCreateOrUpdateResponse: {
4674
4690
  ChangeOrder?: components["schemas"]["ChangeOrder"];
4675
4691
  Error?: components["schemas"]["ResponseError"];
@@ -4792,18 +4808,6 @@ interface components {
4792
4808
  */
4793
4809
  UserID: string;
4794
4810
  };
4795
- ChangeOrderSpaceContainerImages: {
4796
- /** @description The images that changed, by Unit, resource, and path. */
4797
- Images?: components["schemas"]["ChangeOrderContainerImageChange"][] | null;
4798
- /**
4799
- * Format: uuid
4800
- * @description The Space the images changed in.
4801
- * @example 248df4b7-aa70-47b8-a036-33ac447e668d
4802
- */
4803
- SpaceID?: string;
4804
- /** @description The Space's slug. */
4805
- SpaceSlug?: string;
4806
- };
4807
4811
  /** @description Defines an entity changeset. */
4808
4812
  ChangeSet: {
4809
4813
  /** @description An optional map of Annotation key/value pairs for tools to attach information to entities. */
@@ -5034,6 +5038,11 @@ interface components {
5034
5038
  Annotations?: {
5035
5039
  [key: string]: string;
5036
5040
  };
5041
+ /**
5042
+ * Format: uuid
5043
+ * @example 248df4b7-aa70-47b8-a036-33ac447e668d
5044
+ */
5045
+ readonly BackingUnitID?: string;
5037
5046
  /**
5038
5047
  * Format: uuid
5039
5048
  * @description ChannelID uniquely identifies a channel.
@@ -5073,7 +5082,7 @@ interface components {
5073
5082
  readonly EntityType?: string;
5074
5083
  /**
5075
5084
  * Format: int64
5076
- * @description The channel's bookmark into the event log. Set to the log's tail at creation; change it to replay or skip.
5085
+ * @description The channel's bookmark into the event log. Set to the log's tail at creation, a clone's too; change it to replay or skip.
5077
5086
  */
5078
5087
  EventPosition: number;
5079
5088
  /** @description The reason the entity is hidden, if it is. A hidden entity is left out of List and Search results, and of what bulk operations act on, unless the include_hidden parameter names its reason or is *, or the where parameter names the entity by Slug or ID. ConfigHub/YAML Units are created hidden with the reason BackingUnit unless given another. */
@@ -5118,6 +5127,12 @@ interface components {
5118
5127
  * @example 2025-04-04T11:50:02.95102-07:00
5119
5128
  */
5120
5129
  readonly UpdatedAt?: string;
5130
+ /**
5131
+ * Format: uuid
5132
+ * @description The Channel this Channel was cloned from, if any.
5133
+ * @example 248df4b7-aa70-47b8-a036-33ac447e668d
5134
+ */
5135
+ readonly UpstreamChannelID?: string;
5121
5136
  /**
5122
5137
  * Format: int64
5123
5138
  * @description An entity-specific sequence number used for optimistic concurrency control. The value read must be sent in calls to Update.
@@ -5646,14 +5661,17 @@ interface components {
5646
5661
  Version?: number;
5647
5662
  };
5648
5663
  EventSubscription: {
5664
+ /** @description The event types to deliver, such as release.published. Empty means all. */
5649
5665
  EventTypes?: string[];
5650
5666
  /**
5651
5667
  * Format: uuid
5668
+ * @description Restricts delivery to events about one Space. It has to name a Space when the Channel is written; a Space deleted later leaves the subscription matching nothing.
5652
5669
  * @example 248df4b7-aa70-47b8-a036-33ac447e668d
5653
5670
  */
5654
5671
  SpaceID?: string;
5655
5672
  /**
5656
5673
  * Format: uuid
5674
+ * @description Restricts delivery to events about one Target. It has to name a Target when the Channel is written; a Target deleted later leaves the subscription matching nothing.
5657
5675
  * @example 248df4b7-aa70-47b8-a036-33ac447e668d
5658
5676
  */
5659
5677
  TargetID?: string;
@@ -5665,18 +5683,24 @@ interface components {
5665
5683
  Organization?: components["schemas"]["Organization"];
5666
5684
  /** @description The Space the Attestation belongs to. */
5667
5685
  Space?: components["schemas"]["Space"];
5686
+ /** @description The values of the columns of the View named by the view parameter, in the View's column order. A column that selects several values, such as one with a wildcard, has an entry for each, all with the column's Name. */
5687
+ ViewColumns?: components["schemas"]["ViewColumn"][];
5668
5688
  };
5669
5689
  ExtendedAttribute: {
5670
5690
  Attribute?: components["schemas"]["Attribute"];
5671
5691
  Error?: components["schemas"]["ResponseError"];
5672
5692
  Organization?: components["schemas"]["Organization"];
5673
5693
  Space?: components["schemas"]["Space"];
5694
+ /** @description The values of the columns of the View named by the view parameter, in the View's column order. A column that selects several values, such as one with a wildcard, has an entry for each, all with the column's Name. */
5695
+ ViewColumns?: components["schemas"]["ViewColumn"][];
5674
5696
  };
5675
5697
  ExtendedBridgeWorker: {
5676
5698
  BridgeWorker?: components["schemas"]["BridgeWorker"];
5677
5699
  Error?: components["schemas"]["ResponseError"];
5678
5700
  Organization?: components["schemas"]["Organization"];
5679
5701
  Space?: components["schemas"]["Space"];
5702
+ /** @description The values of the columns of the View named by the view parameter, in the View's column order. A column that selects several values, such as one with a wildcard, has an entry for each, all with the column's Name. */
5703
+ ViewColumns?: components["schemas"]["ViewColumn"][];
5680
5704
  };
5681
5705
  ExtendedChangeOrder: {
5682
5706
  ChangeOrder?: components["schemas"]["ChangeOrder"];
@@ -5690,6 +5714,8 @@ interface components {
5690
5714
  SpaceFilter?: components["schemas"]["Filter"];
5691
5715
  StartTag?: components["schemas"]["Tag"];
5692
5716
  UnitFilter?: components["schemas"]["Filter"];
5717
+ /** @description The values of the columns of the View named by the view parameter, in the View's column order. A column that selects several values, such as one with a wildcard, has an entry for each, all with the column's Name. */
5718
+ ViewColumns?: components["schemas"]["ViewColumn"][];
5693
5719
  };
5694
5720
  ExtendedChangeSet: {
5695
5721
  ChangeSet?: components["schemas"]["ChangeSet"];
@@ -5698,23 +5724,31 @@ interface components {
5698
5724
  Organization?: components["schemas"]["Organization"];
5699
5725
  Space?: components["schemas"]["Space"];
5700
5726
  StartTag?: components["schemas"]["Tag"];
5727
+ /** @description The values of the columns of the View named by the view parameter, in the View's column order. A column that selects several values, such as one with a wildcard, has an entry for each, all with the column's Name. */
5728
+ ViewColumns?: components["schemas"]["ViewColumn"][];
5701
5729
  };
5702
5730
  ExtendedChangeWorkflow: {
5703
5731
  ChangeWorkflow?: components["schemas"]["ChangeWorkflow"];
5704
5732
  Error?: components["schemas"]["ResponseError"];
5705
5733
  Organization?: components["schemas"]["Organization"];
5706
5734
  Space?: components["schemas"]["Space"];
5735
+ /** @description The values of the columns of the View named by the view parameter, in the View's column order. A column that selects several values, such as one with a wildcard, has an entry for each, all with the column's Name. */
5736
+ ViewColumns?: components["schemas"]["ViewColumn"][];
5707
5737
  };
5708
5738
  ExtendedChannel: {
5709
5739
  Channel?: components["schemas"]["Channel"];
5710
5740
  Error?: components["schemas"]["ResponseError"];
5711
5741
  Organization?: components["schemas"]["Organization"];
5712
5742
  Space?: components["schemas"]["Space"];
5743
+ /** @description The values of the columns of the View named by the view parameter, in the View's column order. A column that selects several values, such as one with a wildcard, has an entry for each, all with the column's Name. */
5744
+ ViewColumns?: components["schemas"]["ViewColumn"][];
5713
5745
  };
5714
5746
  ExtendedComponent: {
5715
5747
  Component?: components["schemas"]["Component"];
5716
5748
  Error?: components["schemas"]["ResponseError"];
5717
5749
  Organization?: components["schemas"]["Organization"];
5750
+ /** @description The values of the columns of the View named by the view parameter, in the View's column order. A column that selects several values, such as one with a wildcard, has an entry for each, all with the column's Name. */
5751
+ ViewColumns?: components["schemas"]["ViewColumn"][];
5718
5752
  };
5719
5753
  ExtendedFilter: {
5720
5754
  Error?: components["schemas"]["ResponseError"];
@@ -5722,12 +5756,16 @@ interface components {
5722
5756
  FromSpace?: components["schemas"]["Space"];
5723
5757
  Organization?: components["schemas"]["Organization"];
5724
5758
  Space?: components["schemas"]["Space"];
5759
+ /** @description The values of the columns of the View named by the view parameter, in the View's column order. A column that selects several values, such as one with a wildcard, has an entry for each, all with the column's Name. */
5760
+ ViewColumns?: components["schemas"]["ViewColumn"][];
5725
5761
  };
5726
5762
  /** @description Group with additional related entities expanded based on the request's include parameter. */
5727
5763
  ExtendedGroup: {
5728
5764
  Error?: components["schemas"]["ResponseError"];
5729
5765
  /** @description The Group. */
5730
5766
  Group?: components["schemas"]["Group"];
5767
+ /** @description The values of the columns of the View named by the view parameter, in the View's column order. A column that selects several values, such as one with a wildcard, has an entry for each, all with the column's Name. */
5768
+ ViewColumns?: components["schemas"]["ViewColumn"][];
5731
5769
  };
5732
5770
  ExtendedInvocation: {
5733
5771
  BridgeWorker?: components["schemas"]["BridgeWorker"];
@@ -5735,6 +5773,8 @@ interface components {
5735
5773
  Invocation?: components["schemas"]["Invocation"];
5736
5774
  Organization?: components["schemas"]["Organization"];
5737
5775
  Space?: components["schemas"]["Space"];
5776
+ /** @description The values of the columns of the View named by the view parameter, in the View's column order. A column that selects several values, such as one with a wildcard, has an entry for each, all with the column's Name. */
5777
+ ViewColumns?: components["schemas"]["ViewColumn"][];
5738
5778
  };
5739
5779
  ExtendedLink: {
5740
5780
  Error?: components["schemas"]["ResponseError"];
@@ -5745,6 +5785,8 @@ interface components {
5745
5785
  ToSpace?: components["schemas"]["Space"];
5746
5786
  ToUnit?: components["schemas"]["Unit"];
5747
5787
  TransformInvocation?: components["schemas"]["Invocation"];
5788
+ /** @description The values of the columns of the View named by the view parameter, in the View's column order. A column that selects several values, such as one with a wildcard, has an entry for each, all with the column's Name. */
5789
+ ViewColumns?: components["schemas"]["ViewColumn"][];
5748
5790
  };
5749
5791
  ExtendedMutation: {
5750
5792
  Error?: components["schemas"]["ResponseError"];
@@ -5757,14 +5799,20 @@ interface components {
5757
5799
  Space?: components["schemas"]["Space"];
5758
5800
  Trigger?: components["schemas"]["Trigger"];
5759
5801
  Unit?: components["schemas"]["Unit"];
5802
+ /** @description The values of the columns of the View named by the view parameter, in the View's column order. A column that selects several values, such as one with a wildcard, has an entry for each, all with the column's Name. */
5803
+ ViewColumns?: components["schemas"]["ViewColumn"][];
5760
5804
  };
5761
5805
  ExtendedOrganization: {
5762
5806
  Error?: components["schemas"]["ResponseError"];
5763
5807
  Organization?: components["schemas"]["Organization"];
5808
+ /** @description The values of the columns of the View named by the view parameter, in the View's column order. A column that selects several values, such as one with a wildcard, has an entry for each, all with the column's Name. */
5809
+ ViewColumns?: components["schemas"]["ViewColumn"][];
5764
5810
  };
5765
5811
  ExtendedOrganizationMember: {
5766
5812
  Error?: components["schemas"]["ResponseError"];
5767
5813
  OrganizationMember?: components["schemas"]["OrganizationMember"];
5814
+ /** @description The values of the columns of the View named by the view parameter, in the View's column order. A column that selects several values, such as one with a wildcard, has an entry for each, all with the column's Name. */
5815
+ ViewColumns?: components["schemas"]["ViewColumn"][];
5768
5816
  };
5769
5817
  /** @description Release with additional related entities expanded based on the request's include parameter. */
5770
5818
  ExtendedRelease: {
@@ -5781,6 +5829,8 @@ interface components {
5781
5829
  Target?: components["schemas"]["Target"];
5782
5830
  /** @description The User who published the Release. Expanded when requested via the include parameter. */
5783
5831
  User?: components["schemas"]["User"];
5832
+ /** @description The values of the columns of the View named by the view parameter, in the View's column order. A column that selects several values, such as one with a wildcard, has an entry for each, all with the column's Name. */
5833
+ ViewColumns?: components["schemas"]["ViewColumn"][];
5784
5834
  };
5785
5835
  ExtendedResource: {
5786
5836
  Error?: components["schemas"]["ResponseError"];
@@ -5794,16 +5844,19 @@ interface components {
5794
5844
  Space?: components["schemas"]["Space"];
5795
5845
  Target?: components["schemas"]["Target"];
5796
5846
  Unit?: components["schemas"]["Unit"];
5797
- View?: components["schemas"]["View"];
5847
+ /** @description The values of the columns of the View named by the view parameter, in the View's column order. A column that selects several values, such as one with a wildcard, has an entry for each, all with the column's Name. */
5798
5848
  ViewColumns?: components["schemas"]["ViewColumn"][];
5799
5849
  };
5800
5850
  ExtendedReviewComment: {
5851
+ ChangeOrder?: components["schemas"]["ChangeOrder"];
5801
5852
  Error?: components["schemas"]["ResponseError"];
5802
5853
  Organization?: components["schemas"]["Organization"];
5803
5854
  ReviewComment?: components["schemas"]["ReviewComment"];
5804
5855
  Revision?: components["schemas"]["Revision"];
5805
5856
  Space?: components["schemas"]["Space"];
5806
5857
  Unit?: components["schemas"]["Unit"];
5858
+ /** @description The values of the columns of the View named by the view parameter, in the View's column order. A column that selects several values, such as one with a wildcard, has an entry for each, all with the column's Name. */
5859
+ ViewColumns?: components["schemas"]["ViewColumn"][];
5807
5860
  };
5808
5861
  ExtendedRevision: {
5809
5862
  Attestations?: components["schemas"]["Attestation"][];
@@ -5817,11 +5870,15 @@ interface components {
5817
5870
  Tags?: components["schemas"]["Tag"][];
5818
5871
  Unit?: components["schemas"]["Unit"];
5819
5872
  User?: components["schemas"]["User"];
5873
+ /** @description The values of the columns of the View named by the view parameter, in the View's column order. A column that selects several values, such as one with a wildcard, has an entry for each, all with the column's Name. */
5874
+ ViewColumns?: components["schemas"]["ViewColumn"][];
5820
5875
  };
5821
5876
  ExtendedServiceAccount: {
5822
5877
  Error?: components["schemas"]["ResponseError"];
5823
5878
  Organization?: components["schemas"]["Organization"];
5824
5879
  ServiceAccount?: components["schemas"]["ServiceAccount"];
5880
+ /** @description The values of the columns of the View named by the view parameter, in the View's column order. A column that selects several values, such as one with a wildcard, has an entry for each, all with the column's Name. */
5881
+ ViewColumns?: components["schemas"]["ViewColumn"][];
5825
5882
  };
5826
5883
  ExtendedSpace: {
5827
5884
  AttributeFilter?: components["schemas"]["Filter"];
@@ -5844,6 +5901,8 @@ interface components {
5844
5901
  /** Format: int64 */
5845
5902
  TotalChangeWorkflowCount?: number;
5846
5903
  /** Format: int64 */
5904
+ TotalChannelCount?: number;
5905
+ /** Format: int64 */
5847
5906
  TotalFilterCount?: number;
5848
5907
  /** Format: int64 */
5849
5908
  TotalInvocationCount?: number;
@@ -5870,6 +5929,8 @@ interface components {
5870
5929
  UnreleasedUnitCount?: number;
5871
5930
  /** Format: int64 */
5872
5931
  UpgradableUnitCount?: number;
5932
+ /** @description The values of the columns of the View named by the view parameter, in the View's column order. A column that selects several values, such as one with a wildcard, has an entry for each, all with the column's Name. */
5933
+ ViewColumns?: components["schemas"]["ViewColumn"][];
5873
5934
  /** Format: int64 */
5874
5935
  WarnedUnitCount?: number;
5875
5936
  };
@@ -5879,6 +5940,8 @@ interface components {
5879
5940
  Organization?: components["schemas"]["Organization"];
5880
5941
  Space?: components["schemas"]["Space"];
5881
5942
  Tag?: components["schemas"]["Tag"];
5943
+ /** @description The values of the columns of the View named by the view parameter, in the View's column order. A column that selects several values, such as one with a wildcard, has an entry for each, all with the column's Name. */
5944
+ ViewColumns?: components["schemas"]["ViewColumn"][];
5882
5945
  };
5883
5946
  ExtendedTarget: {
5884
5947
  Error?: components["schemas"]["ResponseError"];
@@ -5887,6 +5950,8 @@ interface components {
5887
5950
  Target?: components["schemas"]["Target"];
5888
5951
  TriggerFilter?: components["schemas"]["Filter"];
5889
5952
  Triggers?: components["schemas"]["Trigger"][];
5953
+ /** @description The values of the columns of the View named by the view parameter, in the View's column order. A column that selects several values, such as one with a wildcard, has an entry for each, all with the column's Name. */
5954
+ ViewColumns?: components["schemas"]["ViewColumn"][];
5890
5955
  };
5891
5956
  ExtendedTrigger: {
5892
5957
  BridgeWorker?: components["schemas"]["BridgeWorker"];
@@ -5896,6 +5961,8 @@ interface components {
5896
5961
  Space?: components["schemas"]["Space"];
5897
5962
  Trigger?: components["schemas"]["Trigger"];
5898
5963
  UnitFilter?: components["schemas"]["Filter"];
5964
+ /** @description The values of the columns of the View named by the view parameter, in the View's column order. A column that selects several values, such as one with a wildcard, has an entry for each, all with the column's Name. */
5965
+ ViewColumns?: components["schemas"]["ViewColumn"][];
5899
5966
  };
5900
5967
  /** @description Unit with capability to extend additional related entities. */
5901
5968
  ExtendedUnit: {
@@ -5922,12 +5989,14 @@ interface components {
5922
5989
  UpstreamSpace?: components["schemas"]["Space"];
5923
5990
  /** @description If this Unit is a clone, the Upstream Unit it was cloned from. Optional. */
5924
5991
  UpstreamUnit?: components["schemas"]["Unit"];
5925
- View?: components["schemas"]["View"];
5992
+ /** @description The values of the columns of the View named by the view parameter, in the View's column order. A column that selects several values, such as one with a wildcard, has an entry for each, all with the column's Name. */
5926
5993
  ViewColumns?: components["schemas"]["ViewColumn"][];
5927
5994
  };
5928
5995
  ExtendedUser: {
5929
5996
  Error?: components["schemas"]["ResponseError"];
5930
5997
  User?: components["schemas"]["User"];
5998
+ /** @description The values of the columns of the View named by the view parameter, in the View's column order. A column that selects several values, such as one with a wildcard, has an entry for each, all with the column's Name. */
5999
+ ViewColumns?: components["schemas"]["ViewColumn"][];
5931
6000
  };
5932
6001
  ExtendedView: {
5933
6002
  Error?: components["schemas"]["ResponseError"];
@@ -5935,6 +6004,8 @@ interface components {
5935
6004
  Organization?: components["schemas"]["Organization"];
5936
6005
  Space?: components["schemas"]["Space"];
5937
6006
  View?: components["schemas"]["View"];
6007
+ /** @description The values of the columns of the View named by the view parameter, in the View's column order. A column that selects several values, such as one with a wildcard, has an entry for each, all with the column's Name. */
6008
+ ViewColumns?: components["schemas"]["ViewColumn"][];
5938
6009
  };
5939
6010
  /** @description Defines an entity filter. */
5940
6011
  Filter: {
@@ -5967,7 +6038,7 @@ interface components {
5967
6038
  * @example 248df4b7-aa70-47b8-a036-33ac447e668d
5968
6039
  */
5969
6040
  FilterID?: string;
5970
- /** @description From specifies the type of entity (Unit, Space, etc.) to filter, in PascalCase. */
6041
+ /** @description From specifies the type of entity (Unit, Space, etc.) to filter, in PascalCase. Required on create, and immutable. */
5971
6042
  From: string;
5972
6043
  /**
5973
6044
  * Format: uuid
@@ -7638,6 +7709,12 @@ interface components {
7638
7709
  };
7639
7710
  /** @description ReviewComment is a remark made in review of a Revision of a Unit, optionally about one resource or path in it. */
7640
7711
  ReviewComment: {
7712
+ /**
7713
+ * Format: uuid
7714
+ * @description Unique identifier of the ChangeOrder the comment was made in review of, which may be in another Space. Optional; requires Use permission on the ChangeOrder. A reply takes the ChangeOrderID of the comment it answers, and may not name another. Immutable.
7715
+ * @example 248df4b7-aa70-47b8-a036-33ac447e668d
7716
+ */
7717
+ ChangeOrderID?: string;
7641
7718
  /**
7642
7719
  * Format: date-time
7643
7720
  * @description The timestamp when the entity was created in "2023-01-01T12:00:00Z" format.
@@ -11422,7 +11499,7 @@ interface operations {
11422
11499
  * expected in a comma-separated list format as in the JSON encoding.
11423
11500
  * If not specified, all fields are returned.
11424
11501
  * Entity and parent IDs (like OrganizationID, SpaceID, AttestationID) and Slug are always returned regardless of the select parameter.
11425
- * Fields used in where and contains filters, and fields named by order_by, are also automatically included.
11502
+ * Fields used in where and contains filters, fields named by order_by, and fields read by the columns of the View named by view are also automatically included.
11426
11503
  * Example: 'DisplayName,CreatedAt,Labels' will return only those fields plus the required ID and Slug fields.
11427
11504
  * The whole string must be query-encoded.
11428
11505
  */
@@ -11437,6 +11514,16 @@ interface operations {
11437
11514
  * ConfigHub/YAML Units, which hold the configuration of entities, are hidden with the HiddenReason `BackingUnit`.
11438
11515
  */
11439
11516
  include_hidden?: string;
11517
+ /**
11518
+ * @description UUID of a View whose columns to compute for each Attestation, returned as ViewColumns.
11519
+ *
11520
+ * The View must be in the same Organization as the user credentials, and be a View of Attestation: its Of, or the From of its Filter, must be Attestation.
11521
+ *
11522
+ * If the View has a Filter, the Filter selects the entities as the filter parameter does, so the two may not both be specified.
11523
+ *
11524
+ * The related entities and fields the View's columns read are included and selected automatically, so neither include nor select has to name them.
11525
+ */
11526
+ view?: string;
11440
11527
  /** @description Maximum number of Attestation entities to return. If not specified, all matching entities are returned. Values greater than 1000 are rejected with 400. When there may be more entities, the response has a ConfigHub-Continue header to pass as the continue parameter of the next request. */
11441
11528
  limit?: number;
11442
11529
  /**
@@ -11626,7 +11713,7 @@ interface operations {
11626
11713
  * expected in a comma-separated list format as in the JSON encoding.
11627
11714
  * If not specified, all fields are returned.
11628
11715
  * Entity and parent IDs (like OrganizationID, SpaceID, AttributeID) and Slug are always returned regardless of the select parameter.
11629
- * Fields used in where and contains filters, and fields named by order_by, are also automatically included.
11716
+ * Fields used in where and contains filters, fields named by order_by, and fields read by the columns of the View named by view are also automatically included.
11630
11717
  * Example: 'DisplayName,CreatedAt,Labels' will return only those fields plus the required ID and Slug fields.
11631
11718
  * The whole string must be query-encoded.
11632
11719
  */
@@ -11641,6 +11728,16 @@ interface operations {
11641
11728
  * ConfigHub/YAML Units, which hold the configuration of entities, are hidden with the HiddenReason `BackingUnit`.
11642
11729
  */
11643
11730
  include_hidden?: string;
11731
+ /**
11732
+ * @description UUID of a View whose columns to compute for each Attribute, returned as ViewColumns.
11733
+ *
11734
+ * The View must be in the same Organization as the user credentials, and be a View of Attribute: its Of, or the From of its Filter, must be Attribute.
11735
+ *
11736
+ * If the View has a Filter, the Filter selects the entities as the filter parameter does, so the two may not both be specified.
11737
+ *
11738
+ * The related entities and fields the View's columns read are included and selected automatically, so neither include nor select has to name them.
11739
+ */
11740
+ view?: string;
11644
11741
  /** @description Maximum number of Attribute entities to return. If not specified, all matching entities are returned. Values greater than 1000 are rejected with 400. When there may be more entities, the response has a ConfigHub-Continue header to pass as the continue parameter of the next request. */
11645
11742
  limit?: number;
11646
11743
  /**
@@ -12805,7 +12902,7 @@ interface operations {
12805
12902
  * expected in a comma-separated list format as in the JSON encoding.
12806
12903
  * If not specified, all fields are returned.
12807
12904
  * Entity and parent IDs (like OrganizationID, SpaceID, BridgeWorkerID) and Slug are always returned regardless of the select parameter.
12808
- * Fields used in where and contains filters, and fields named by order_by, are also automatically included.
12905
+ * Fields used in where and contains filters, fields named by order_by, and fields read by the columns of the View named by view are also automatically included.
12809
12906
  * Example: 'DisplayName,CreatedAt,Labels' will return only those fields plus the required ID and Slug fields.
12810
12907
  * The whole string must be query-encoded.
12811
12908
  */
@@ -12820,6 +12917,16 @@ interface operations {
12820
12917
  * ConfigHub/YAML Units, which hold the configuration of entities, are hidden with the HiddenReason `BackingUnit`.
12821
12918
  */
12822
12919
  include_hidden?: string;
12920
+ /**
12921
+ * @description UUID of a View whose columns to compute for each BridgeWorker, returned as ViewColumns.
12922
+ *
12923
+ * The View must be in the same Organization as the user credentials, and be a View of BridgeWorker: its Of, or the From of its Filter, must be BridgeWorker.
12924
+ *
12925
+ * If the View has a Filter, the Filter selects the entities as the filter parameter does, so the two may not both be specified.
12926
+ *
12927
+ * The related entities and fields the View's columns read are included and selected automatically, so neither include nor select has to name them.
12928
+ */
12929
+ view?: string;
12823
12930
  /** @description Maximum number of BridgeWorker entities to return. If not specified, all matching entities are returned. Values greater than 1000 are rejected with 400. When there may be more entities, the response has a ConfigHub-Continue header to pass as the continue parameter of the next request. */
12824
12931
  limit?: number;
12825
12932
  /**
@@ -13781,7 +13888,7 @@ interface operations {
13781
13888
  * expected in a comma-separated list format as in the JSON encoding.
13782
13889
  * If not specified, all fields are returned.
13783
13890
  * Entity and parent IDs (like OrganizationID, SpaceID, ChangeOrderID) and Slug are always returned regardless of the select parameter.
13784
- * Fields used in where and contains filters, and fields named by order_by, are also automatically included.
13891
+ * Fields used in where and contains filters, fields named by order_by, and fields read by the columns of the View named by view are also automatically included.
13785
13892
  * Example: 'DisplayName,CreatedAt,Labels' will return only those fields plus the required ID and Slug fields.
13786
13893
  * The whole string must be query-encoded.
13787
13894
  */
@@ -13796,6 +13903,16 @@ interface operations {
13796
13903
  * ConfigHub/YAML Units, which hold the configuration of entities, are hidden with the HiddenReason `BackingUnit`.
13797
13904
  */
13798
13905
  include_hidden?: string;
13906
+ /**
13907
+ * @description UUID of a View whose columns to compute for each ChangeOrder, returned as ViewColumns.
13908
+ *
13909
+ * The View must be in the same Organization as the user credentials, and be a View of ChangeOrder: its Of, or the From of its Filter, must be ChangeOrder.
13910
+ *
13911
+ * If the View has a Filter, the Filter selects the entities as the filter parameter does, so the two may not both be specified.
13912
+ *
13913
+ * The related entities and fields the View's columns read are included and selected automatically, so neither include nor select has to name them.
13914
+ */
13915
+ view?: string;
13799
13916
  /** @description Maximum number of ChangeOrder entities to return. If not specified, all matching entities are returned. Values greater than 1000 are rejected with 400. When there may be more entities, the response has a ConfigHub-Continue header to pass as the continue parameter of the next request. */
13800
13917
  limit?: number;
13801
13918
  /**
@@ -14735,7 +14852,7 @@ interface operations {
14735
14852
  * expected in a comma-separated list format as in the JSON encoding.
14736
14853
  * If not specified, all fields are returned.
14737
14854
  * Entity and parent IDs (like OrganizationID, SpaceID, ChangeSetID) and Slug are always returned regardless of the select parameter.
14738
- * Fields used in where and contains filters, and fields named by order_by, are also automatically included.
14855
+ * Fields used in where and contains filters, fields named by order_by, and fields read by the columns of the View named by view are also automatically included.
14739
14856
  * Example: 'DisplayName,CreatedAt,Labels' will return only those fields plus the required ID and Slug fields.
14740
14857
  * The whole string must be query-encoded.
14741
14858
  */
@@ -14750,6 +14867,16 @@ interface operations {
14750
14867
  * ConfigHub/YAML Units, which hold the configuration of entities, are hidden with the HiddenReason `BackingUnit`.
14751
14868
  */
14752
14869
  include_hidden?: string;
14870
+ /**
14871
+ * @description UUID of a View whose columns to compute for each ChangeSet, returned as ViewColumns.
14872
+ *
14873
+ * The View must be in the same Organization as the user credentials, and be a View of ChangeSet: its Of, or the From of its Filter, must be ChangeSet.
14874
+ *
14875
+ * If the View has a Filter, the Filter selects the entities as the filter parameter does, so the two may not both be specified.
14876
+ *
14877
+ * The related entities and fields the View's columns read are included and selected automatically, so neither include nor select has to name them.
14878
+ */
14879
+ view?: string;
14753
14880
  /** @description Maximum number of ChangeSet entities to return. If not specified, all matching entities are returned. Values greater than 1000 are rejected with 400. When there may be more entities, the response has a ConfigHub-Continue header to pass as the continue parameter of the next request. */
14754
14881
  limit?: number;
14755
14882
  /**
@@ -15840,7 +15967,7 @@ interface operations {
15840
15967
  * expected in a comma-separated list format as in the JSON encoding.
15841
15968
  * If not specified, all fields are returned.
15842
15969
  * Entity and parent IDs (like OrganizationID, SpaceID, ChangeWorkflowID) and Slug are always returned regardless of the select parameter.
15843
- * Fields used in where and contains filters, and fields named by order_by, are also automatically included.
15970
+ * Fields used in where and contains filters, fields named by order_by, and fields read by the columns of the View named by view are also automatically included.
15844
15971
  * Example: 'DisplayName,CreatedAt,Labels' will return only those fields plus the required ID and Slug fields.
15845
15972
  * The whole string must be query-encoded.
15846
15973
  */
@@ -15855,6 +15982,16 @@ interface operations {
15855
15982
  * ConfigHub/YAML Units, which hold the configuration of entities, are hidden with the HiddenReason `BackingUnit`.
15856
15983
  */
15857
15984
  include_hidden?: string;
15985
+ /**
15986
+ * @description UUID of a View whose columns to compute for each ChangeWorkflow, returned as ViewColumns.
15987
+ *
15988
+ * The View must be in the same Organization as the user credentials, and be a View of ChangeWorkflow: its Of, or the From of its Filter, must be ChangeWorkflow.
15989
+ *
15990
+ * If the View has a Filter, the Filter selects the entities as the filter parameter does, so the two may not both be specified.
15991
+ *
15992
+ * The related entities and fields the View's columns read are included and selected automatically, so neither include nor select has to name them.
15993
+ */
15994
+ view?: string;
15858
15995
  /** @description Maximum number of ChangeWorkflow entities to return. If not specified, all matching entities are returned. Values greater than 1000 are rejected with 400. When there may be more entities, the response has a ConfigHub-Continue header to pass as the continue parameter of the next request. */
15859
15996
  limit?: number;
15860
15997
  /**
@@ -16978,7 +17115,7 @@ interface operations {
16978
17115
  * An example conjunction is:
16979
17116
  * `CreatedAt >= '2025-01-07' AND Slug = 'test' AND Labels.mykey = 'myvalue'`.
16980
17117
  *
16981
- * Supported attributes for filtering on Channel: Annotations, ChannelID, Commands, Condition, CreatedAt, DeleteGates, DisplayName, EventPosition, HiddenReason, IPAddress, Labels, LastMessage, LastSeenAt, OrganizationID, Permissions, Slug, SpaceID, Subscriptions, UpdatedAt.
17118
+ * Supported attributes for filtering on Channel: Annotations, BackingUnitID, ChannelID, Commands, Condition, CreatedAt, DeleteGates, DisplayName, EventPosition, HiddenReason, IPAddress, Labels, LastMessage, LastSeenAt, OrganizationID, Permissions, Slug, SpaceID, Subscriptions, UpdatedAt, UpstreamChannelID.
16982
17119
  *
16983
17120
  * The whole string must be query-encoded.
16984
17121
  */
@@ -17031,7 +17168,7 @@ interface operations {
17031
17168
  * expected in a comma-separated list format as in the JSON encoding.
17032
17169
  * If not specified, all fields are returned.
17033
17170
  * Entity and parent IDs (like OrganizationID, SpaceID, ChannelID) and Slug are always returned regardless of the select parameter.
17034
- * Fields used in where and contains filters, and fields named by order_by, are also automatically included.
17171
+ * Fields used in where and contains filters, fields named by order_by, and fields read by the columns of the View named by view are also automatically included.
17035
17172
  * Example: 'DisplayName,CreatedAt,Labels' will return only those fields plus the required ID and Slug fields.
17036
17173
  * The whole string must be query-encoded.
17037
17174
  */
@@ -17046,6 +17183,16 @@ interface operations {
17046
17183
  * ConfigHub/YAML Units, which hold the configuration of entities, are hidden with the HiddenReason `BackingUnit`.
17047
17184
  */
17048
17185
  include_hidden?: string;
17186
+ /**
17187
+ * @description UUID of a View whose columns to compute for each Channel, returned as ViewColumns.
17188
+ *
17189
+ * The View must be in the same Organization as the user credentials, and be a View of Channel: its Of, or the From of its Filter, must be Channel.
17190
+ *
17191
+ * If the View has a Filter, the Filter selects the entities as the filter parameter does, so the two may not both be specified.
17192
+ *
17193
+ * The related entities and fields the View's columns read are included and selected automatically, so neither include nor select has to name them.
17194
+ */
17195
+ view?: string;
17049
17196
  /** @description Maximum number of Channel entities to return. If not specified, all matching entities are returned. Values greater than 1000 are rejected with 400. When there may be more entities, the response has a ConfigHub-Continue header to pass as the continue parameter of the next request. */
17050
17197
  limit?: number;
17051
17198
  /**
@@ -17053,7 +17200,7 @@ interface operations {
17053
17200
  *
17054
17201
  * Field names are case-sensitive and PascalCase, as in the JSON encoding. Sort direction defaults to ASC when the 'DIRECTION:' prefix is omitted.
17055
17202
  *
17056
- * Supported attributes for ordering Channel: ChannelID, Condition, CreatedAt, DisplayName, EventPosition, HiddenReason, IPAddress, LastMessage, LastSeenAt, OrganizationID, Slug, SpaceID, UpdatedAt.
17203
+ * Supported attributes for ordering Channel: BackingUnitID, ChannelID, Condition, CreatedAt, DisplayName, EventPosition, HiddenReason, IPAddress, LastMessage, LastSeenAt, OrganizationID, Slug, SpaceID, UpdatedAt, UpstreamChannelID.
17057
17204
  *
17058
17205
  * Example: 'DESC:CreatedAt' or 'DisplayName,DESC:CreatedAt'.
17059
17206
  *
@@ -17144,7 +17291,7 @@ interface operations {
17144
17291
  };
17145
17292
  };
17146
17293
  };
17147
- BulkDeleteChannels: {
17294
+ BulkCreateChannels: {
17148
17295
  parameters: {
17149
17296
  query?: {
17150
17297
  /**
@@ -17182,7 +17329,7 @@ interface operations {
17182
17329
  * An example conjunction is:
17183
17330
  * `CreatedAt >= '2025-01-07' AND Slug = 'test' AND Labels.mykey = 'myvalue'`.
17184
17331
  *
17185
- * Supported attributes for filtering on Channel: Annotations, ChannelID, Commands, Condition, CreatedAt, DeleteGates, DisplayName, EventPosition, HiddenReason, IPAddress, Labels, LastMessage, LastSeenAt, OrganizationID, Permissions, Slug, SpaceID, Subscriptions, UpdatedAt.
17332
+ * Supported attributes for filtering on Channel: Annotations, BackingUnitID, ChannelID, Commands, Condition, CreatedAt, DeleteGates, DisplayName, EventPosition, HiddenReason, IPAddress, Labels, LastMessage, LastSeenAt, OrganizationID, Permissions, Slug, SpaceID, Subscriptions, UpdatedAt, UpstreamChannelID.
17186
17333
  *
17187
17334
  * The whole string must be query-encoded.
17188
17335
  */
@@ -17243,113 +17390,15 @@ interface operations {
17243
17390
  limit?: number;
17244
17391
  /** @description The token from the ConfigHub-Continue header of the previous request, to act on the Channel entities after the last one it acted on. The request's other parameters, except limit, must be the same as those of the request that returned the token. */
17245
17392
  continue?: string;
17246
- };
17247
- header?: never;
17248
- path?: never;
17249
- cookie?: never;
17250
- };
17251
- requestBody?: never;
17252
- responses: {
17253
- /** @description OK */
17254
- 200: {
17255
- headers: {
17256
- /** @description The token to pass as the continue parameter of the next request, when there may be more entities after this page. It is absent on the last page. A page can hold fewer entities than the limit, or none, and still have one. */
17257
- "ConfigHub-Continue"?: string;
17258
- [name: string]: unknown;
17259
- };
17260
- content: {
17261
- "application/json": components["schemas"]["DeleteResponse"][];
17262
- };
17263
- };
17264
- /** @description Multi-Status: Mixed success and failure results */
17265
- 207: {
17266
- headers: {
17267
- [name: string]: unknown;
17268
- };
17269
- content: {
17270
- "application/json": components["schemas"]["DeleteResponse"][];
17271
- };
17272
- };
17273
- /** @description Channel request is invalid (Bad Request). */
17274
- 400: {
17275
- headers: {
17276
- [name: string]: unknown;
17277
- };
17278
- content: {
17279
- "application/json": components["schemas"]["StandardErrorResponse"];
17280
- };
17281
- };
17282
- /** @description Unauthorized access. */
17283
- 401: {
17284
- headers: {
17285
- [name: string]: unknown;
17286
- };
17287
- content: {
17288
- "application/json": components["schemas"]["StandardErrorResponse"];
17289
- };
17290
- };
17291
- /** @description Forbidden access. */
17292
- 403: {
17293
- headers: {
17294
- [name: string]: unknown;
17295
- };
17296
- content: {
17297
- "application/json": components["schemas"]["StandardErrorResponse"];
17298
- };
17299
- };
17300
- /** @description Channel not found. */
17301
- 404: {
17302
- headers: {
17303
- [name: string]: unknown;
17304
- };
17305
- content: {
17306
- "application/json": components["schemas"]["StandardErrorResponse"];
17307
- };
17308
- };
17309
- /** @description Channel is still in use: it has DeleteGates, or other entities still reference it. Or data has changed since last read. */
17310
- 409: {
17311
- headers: {
17312
- [name: string]: unknown;
17313
- };
17314
- content: {
17315
- "application/json": components["schemas"]["StandardErrorResponse"];
17316
- };
17317
- };
17318
- /** @description Unable to delete entity */
17319
- 422: {
17320
- headers: {
17321
- [name: string]: unknown;
17322
- };
17323
- content: {
17324
- "application/json": components["schemas"]["StandardErrorResponse"];
17325
- };
17326
- };
17327
- /** @description Something went wrong while processing Channel. */
17328
- 500: {
17329
- headers: {
17330
- [name: string]: unknown;
17331
- };
17332
- content: {
17333
- "application/json": components["schemas"]["StandardErrorResponse"];
17334
- };
17335
- };
17336
- /** @description Unexpected error. */
17337
- default: {
17338
- headers: {
17339
- [name: string]: unknown;
17340
- };
17341
- content: {
17342
- "application/json": components["schemas"]["StandardErrorResponse"];
17343
- };
17344
- };
17345
- };
17346
- };
17347
- BulkPatchChannels: {
17348
- parameters: {
17349
- query?: {
17393
+ /** @description Comma-separated list of prefixes to apply to cloned Channel names */
17394
+ name_prefixes?: string;
17395
+ /** @description Comma-separated list of labels with multiple values for cloned Channel labels, in the format of key1=value1|value2,key2=value1|value2|value3 */
17396
+ variant_labels?: string;
17397
+ /** @description A string for clone names, use the prefix 'template:' for a Go-template with .SourceEntitySlug to access the original entity's slug and .Labels to access variant labels, example: 'template:{{.SourceEntitySlug}}-{{.Labels.env}}' */
17398
+ name_pattern?: string;
17350
17399
  /**
17351
17400
  * @description The specified string is an expression for the purpose of filtering
17352
- * the list of Channels returned. The expression syntax was inspired by SQL.
17401
+ * the list of Spaces returned. The expression syntax was inspired by SQL.
17353
17402
  * It supports conjunctions using `AND` of relational expressions of the form *attribute*
17354
17403
  * *operator* *attribute_or_literal*. The attribute names are case-sensitive and PascalCase,
17355
17404
  * as in the JSON encoding.
@@ -17382,7 +17431,456 @@ interface operations {
17382
17431
  * An example conjunction is:
17383
17432
  * `CreatedAt >= '2025-01-07' AND Slug = 'test' AND Labels.mykey = 'myvalue'`.
17384
17433
  *
17385
- * Supported attributes for filtering on Channel: Annotations, ChannelID, Commands, Condition, CreatedAt, DeleteGates, DisplayName, EventPosition, HiddenReason, IPAddress, Labels, LastMessage, LastSeenAt, OrganizationID, Permissions, Slug, SpaceID, Subscriptions, UpdatedAt.
17434
+ * Supported attributes for filtering on Space: Annotations, AttributeFilterID, AttributeHash, AttributeIDs, BackingUnitID, ComponentID, CreatedAt, DeleteGates, DisplayName, HiddenReason, Labels, OrganizationID, Permissions, ReleaseTargetID, Slug, SpaceID, TriggerFilterID, TriggerHash, TriggerIDs, UpdatedAt, UpstreamSpaceID.
17435
+ *
17436
+ * Where expression to select destination spaces for cloning channels
17437
+ *
17438
+ * The whole string must be query-encoded.
17439
+ */
17440
+ where_space?: string;
17441
+ /**
17442
+ * @description UUID of a Filter entity to apply to the Space list.
17443
+ *
17444
+ * The Filter must be in the same Organization as the user credentials.
17445
+ *
17446
+ * The Filter's From field must match the entity type being filtered (Space).
17447
+ *
17448
+ * For Space-resident entities, if the Filter has a FromSpaceID, it must match the operation's SpaceID.
17449
+ *
17450
+ * The Filter's Where clause will be combined with any explicit 'where' parameter using AND logic.
17451
+ *
17452
+ * If both 'filter' and 'where' parameters are specified, they are combined with AND logic.
17453
+ */
17454
+ filter_space?: string;
17455
+ /** @description Allowed values are true and false. Default is false. When true, reports success when an entity already exists and returns the existing entity */
17456
+ allow_exists?: string;
17457
+ /** @description Give each Channel written a backing Unit if it has none: a ConfigHub/YAML Unit holding the Channel's configuration, which is then kept in step with it. */
17458
+ with_backing_units?: boolean;
17459
+ /** @description Create Channels from the ConfigHub/YAML Units where_unit and filter_unit select, each in its Unit's Space, and each with its Unit as its backing Unit. The request body is applied after the Unit's document. Units of other toolchains or describing other entity types are passed over; outstanding ValidationErrors on a Unit are an error. Takes none of the parameters that select entities to clone, name the clones or choose their Spaces. */
17460
+ from_backing_units?: boolean;
17461
+ /**
17462
+ * @description The specified string is an expression for the purpose of filtering
17463
+ * the list of Units returned. The expression syntax was inspired by SQL.
17464
+ * It supports conjunctions using `AND` of relational expressions of the form *attribute*
17465
+ * *operator* *attribute_or_literal*. The attribute names are case-sensitive and PascalCase,
17466
+ * as in the JSON encoding.
17467
+ * Strings support the following operators: `<`, `>`, `<=`, `>=`, `=`, `!=`, `LIKE`, `NOT LIKE`, `ILIKE`, `~~`, `!~~`, `~`, `~*`, `!~`, `!~*`, `IN`, `NOT IN`.
17468
+ * String pattern operators: `LIKE` and `~~` for pattern matching with `%` and `_` wildcards,
17469
+ * `ILIKE` for case-insensitive pattern matching, `NOT LIKE` and `!~~` for negated pattern matching.
17470
+ * String regex operators: `~` for regex matching, `~*` for case-insensitive regex,
17471
+ * `!~` and `!~*` for regex not matching (case-sensitive and insensitive).
17472
+ * Integers support the following operators: `<`, `>`, `<=`, `>=`, `=`, `!=`, `IN`, `NOT IN`.
17473
+ * UUIDs and boolean attributes support equality and inequality only.
17474
+ * UUID and time literals must be quoted as string literals.
17475
+ * String literals are quoted with single quotes, such as `'string'`.
17476
+ * Time literals use the same form as when serialized as JSON,
17477
+ * such as: `CreatedAt > '2025-02-18T23:16:34'`.
17478
+ * Integer and boolean literals are also supported for attributes of those types.
17479
+ * Arrays support the `?` operator to to match any element of the array,
17480
+ * as in `FromLinkID ? '7c61626f-ddbe-41af-93f6-b69f4ab6d308'`.
17481
+ * Arrays can perform LEN() to check for length, as in `LEN(FromLinkID) > 0`.
17482
+ * An attribute naming a list of other entities can be filtered on their attributes with a `*` segment,
17483
+ * as in `FromLink.*.Slug = 'upgrade-app'`, which holds when any element satisfies it.
17484
+ * Without the `*` such a reference is an error, since it names no single value to compare.
17485
+ * Map support the dot notation to specify a particular map key, as in `Labels.tier = 'Backend'`.
17486
+ * Maps support `IS NULL` and `IS NOT NULL` with dot notation to check for key absence or presence,
17487
+ * as in `Labels.tier IS NULL` (key doesn't exist) or `Labels.tier IS NOT NULL` (key exists).
17488
+ * Comparison results can be tested with `IS TRUE`, `IS FALSE`, `IS NOT TRUE`, and `IS NOT FALSE`.
17489
+ * These are useful for nullable columns: `MergeSourceID = '<uuid>' IS NOT FALSE` matches rows where MergeSourceID equals the value OR is NULL.
17490
+ * The `IN` and `NOT IN` operators accept a comma-separated list of values in parentheses,
17491
+ * such as `Slug IN ('slugone', 'slugtwo')` or `Labels.environment IN ('prod', 'staging')`.
17492
+ * Conjunctions are supported using the `AND` operator.
17493
+ * An example conjunction is:
17494
+ * `CreatedAt >= '2025-01-07' AND Slug = 'test' AND Labels.mykey = 'myvalue'`.
17495
+ *
17496
+ * Supported attributes for filtering on Unit: Annotations, ApplyGates, ApplyWarnings, ChangeSetID, Conflicts, CreatedAt, DataHash, DeleteGates, DestroyGates, DisplayName, FromLinkID, HeadRevisionID, HeadRevisionNum, HeadUnitActionNum, HeadUnitEventNum, HiddenReason, Labels, LastChangeDescription, LastReleasedRevisionNum, LinkFindings, NeededPaths, OrganizationID, Permissions, ProvidedPaths, ProviderType, Slug, SpaceID, TargetID, ToolchainType, UnitID, UpdatedAt, UpstreamRevisionNum, UpstreamSpaceID, UpstreamUnitID, ValidationErrors, ValidationTriggerIDs, ValidationWarnings, ValueTriggerIDs, Values.
17497
+ *
17498
+ * The Units to create entities from, with from_backing_units.
17499
+ *
17500
+ * The whole string must be query-encoded.
17501
+ */
17502
+ where_unit?: string;
17503
+ /** @description A Filter, by ID, over the Units to create entities from, with from_backing_units. */
17504
+ filter_unit?: string;
17505
+ /** @description With from_backing_units, patch a Channel a selected Unit already backs with what the Unit holds that it has not taken yet, as a bulk patch with from_backing_units does, rather than report that the Unit backs it. The request body is applied after it. Without it, such a Unit is an error, or with allow_exists the Channel is returned as it is. */
17506
+ patch_existing?: boolean;
17507
+ /** @description If true, report what the write would do without doing it: the write runs, including every check it makes, and is then rolled back. The response is the one the write would return, with the entities as they would be written. An entity a dry run creates is given an ID that the real create will not reuse. */
17508
+ dry_run?: boolean;
17509
+ };
17510
+ header?: never;
17511
+ path?: never;
17512
+ cookie?: never;
17513
+ };
17514
+ requestBody?: {
17515
+ content: {
17516
+ "application/merge-patch+json": {
17517
+ /** @description An optional map of Annotation key/value pairs for tools to attach information to entities. */
17518
+ Annotations?: {
17519
+ [key: string]: string | null;
17520
+ } | null;
17521
+ Commands?: {
17522
+ [key: string]: Record<string, never> | null;
17523
+ } | null;
17524
+ /** @description An optional set of gates that, if any is present, will block deletion */
17525
+ DeleteGates?: {
17526
+ [key: string]: boolean | null;
17527
+ } | null;
17528
+ /** @description Friendly name for the entity. */
17529
+ DisplayName?: string | null;
17530
+ EventPosition?: number | null;
17531
+ /** @description The reason the entity is hidden, if it is. A hidden entity is left out of List and Search results, and of what bulk operations act on, unless the include_hidden parameter names its reason or is *, or the where parameter names the entity by Slug or ID. ConfigHub/YAML Units are created hidden with the reason BackingUnit unless given another. */
17532
+ HiddenReason?: string | null;
17533
+ /** @description An optional map of Label key/value pairs to specify identifying attributes of entities for the purpose of grouping and filtering them. */
17534
+ Labels?: {
17535
+ [key: string]: string | null;
17536
+ } | null;
17537
+ Permissions?: {
17538
+ [key: string]: Record<string, never> | null;
17539
+ } | null;
17540
+ /** @description Unique URL-safe identifier for the entity. */
17541
+ Slug?: string | null;
17542
+ Subscriptions?: (Record<string, never> | null)[] | null;
17543
+ /** @description An entity-specific sequence number used for optimistic concurrency control. The value read must be sent in calls to Update. */
17544
+ Version?: number | null;
17545
+ };
17546
+ };
17547
+ };
17548
+ responses: {
17549
+ /** @description OK */
17550
+ 200: {
17551
+ headers: {
17552
+ /** @description The token to pass as the continue parameter of the next request, when there may be more entities after this page. It is absent on the last page. A page can hold fewer entities than the limit, or none, and still have one. */
17553
+ "ConfigHub-Continue"?: string;
17554
+ [name: string]: unknown;
17555
+ };
17556
+ content: {
17557
+ "application/json": components["schemas"]["ChannelCreateOrUpdateResponse"][];
17558
+ };
17559
+ };
17560
+ /** @description Multi-Status (partial success) */
17561
+ 207: {
17562
+ headers: {
17563
+ [name: string]: unknown;
17564
+ };
17565
+ content: {
17566
+ "application/json": components["schemas"]["ChannelCreateOrUpdateResponse"][];
17567
+ };
17568
+ };
17569
+ /** @description Channel request is invalid (Bad Request). */
17570
+ 400: {
17571
+ headers: {
17572
+ [name: string]: unknown;
17573
+ };
17574
+ content: {
17575
+ "application/json": components["schemas"]["StandardErrorResponse"];
17576
+ };
17577
+ };
17578
+ /** @description Unauthorized access. */
17579
+ 401: {
17580
+ headers: {
17581
+ [name: string]: unknown;
17582
+ };
17583
+ content: {
17584
+ "application/json": components["schemas"]["StandardErrorResponse"];
17585
+ };
17586
+ };
17587
+ /** @description Forbidden access. */
17588
+ 403: {
17589
+ headers: {
17590
+ [name: string]: unknown;
17591
+ };
17592
+ content: {
17593
+ "application/json": components["schemas"]["StandardErrorResponse"];
17594
+ };
17595
+ };
17596
+ /** @description Channel not found. */
17597
+ 404: {
17598
+ headers: {
17599
+ [name: string]: unknown;
17600
+ };
17601
+ content: {
17602
+ "application/json": components["schemas"]["StandardErrorResponse"];
17603
+ };
17604
+ };
17605
+ /** @description Channel data conflict. Data has changed since last read. */
17606
+ 409: {
17607
+ headers: {
17608
+ [name: string]: unknown;
17609
+ };
17610
+ content: {
17611
+ "application/json": components["schemas"]["StandardErrorResponse"];
17612
+ };
17613
+ };
17614
+ /** @description A backing Unit has outstanding ValidationErrors */
17615
+ 422: {
17616
+ headers: {
17617
+ [name: string]: unknown;
17618
+ };
17619
+ content: {
17620
+ "application/json": components["schemas"]["StandardErrorResponse"];
17621
+ };
17622
+ };
17623
+ /** @description Something went wrong while processing Channel. */
17624
+ 500: {
17625
+ headers: {
17626
+ [name: string]: unknown;
17627
+ };
17628
+ content: {
17629
+ "application/json": components["schemas"]["StandardErrorResponse"];
17630
+ };
17631
+ };
17632
+ /** @description Unexpected error. */
17633
+ default: {
17634
+ headers: {
17635
+ [name: string]: unknown;
17636
+ };
17637
+ content: {
17638
+ "application/json": components["schemas"]["StandardErrorResponse"];
17639
+ };
17640
+ };
17641
+ };
17642
+ };
17643
+ BulkDeleteChannels: {
17644
+ parameters: {
17645
+ query?: {
17646
+ /**
17647
+ * @description The specified string is an expression for the purpose of filtering
17648
+ * the list of Channels returned. The expression syntax was inspired by SQL.
17649
+ * It supports conjunctions using `AND` of relational expressions of the form *attribute*
17650
+ * *operator* *attribute_or_literal*. The attribute names are case-sensitive and PascalCase,
17651
+ * as in the JSON encoding.
17652
+ * Strings support the following operators: `<`, `>`, `<=`, `>=`, `=`, `!=`, `LIKE`, `NOT LIKE`, `ILIKE`, `~~`, `!~~`, `~`, `~*`, `!~`, `!~*`, `IN`, `NOT IN`.
17653
+ * String pattern operators: `LIKE` and `~~` for pattern matching with `%` and `_` wildcards,
17654
+ * `ILIKE` for case-insensitive pattern matching, `NOT LIKE` and `!~~` for negated pattern matching.
17655
+ * String regex operators: `~` for regex matching, `~*` for case-insensitive regex,
17656
+ * `!~` and `!~*` for regex not matching (case-sensitive and insensitive).
17657
+ * Integers support the following operators: `<`, `>`, `<=`, `>=`, `=`, `!=`, `IN`, `NOT IN`.
17658
+ * UUIDs and boolean attributes support equality and inequality only.
17659
+ * UUID and time literals must be quoted as string literals.
17660
+ * String literals are quoted with single quotes, such as `'string'`.
17661
+ * Time literals use the same form as when serialized as JSON,
17662
+ * such as: `CreatedAt > '2025-02-18T23:16:34'`.
17663
+ * Integer and boolean literals are also supported for attributes of those types.
17664
+ * Arrays support the `?` operator to to match any element of the array,
17665
+ * as in `FromLinkID ? '7c61626f-ddbe-41af-93f6-b69f4ab6d308'`.
17666
+ * Arrays can perform LEN() to check for length, as in `LEN(FromLinkID) > 0`.
17667
+ * An attribute naming a list of other entities can be filtered on their attributes with a `*` segment,
17668
+ * as in `FromLink.*.Slug = 'upgrade-app'`, which holds when any element satisfies it.
17669
+ * Without the `*` such a reference is an error, since it names no single value to compare.
17670
+ * Map support the dot notation to specify a particular map key, as in `Labels.tier = 'Backend'`.
17671
+ * Maps support `IS NULL` and `IS NOT NULL` with dot notation to check for key absence or presence,
17672
+ * as in `Labels.tier IS NULL` (key doesn't exist) or `Labels.tier IS NOT NULL` (key exists).
17673
+ * Comparison results can be tested with `IS TRUE`, `IS FALSE`, `IS NOT TRUE`, and `IS NOT FALSE`.
17674
+ * These are useful for nullable columns: `MergeSourceID = '<uuid>' IS NOT FALSE` matches rows where MergeSourceID equals the value OR is NULL.
17675
+ * The `IN` and `NOT IN` operators accept a comma-separated list of values in parentheses,
17676
+ * such as `Slug IN ('slugone', 'slugtwo')` or `Labels.environment IN ('prod', 'staging')`.
17677
+ * Conjunctions are supported using the `AND` operator.
17678
+ * An example conjunction is:
17679
+ * `CreatedAt >= '2025-01-07' AND Slug = 'test' AND Labels.mykey = 'myvalue'`.
17680
+ *
17681
+ * Supported attributes for filtering on Channel: Annotations, BackingUnitID, ChannelID, Commands, Condition, CreatedAt, DeleteGates, DisplayName, EventPosition, HiddenReason, IPAddress, Labels, LastMessage, LastSeenAt, OrganizationID, Permissions, Slug, SpaceID, Subscriptions, UpdatedAt, UpstreamChannelID.
17682
+ *
17683
+ * The whole string must be query-encoded.
17684
+ */
17685
+ where?: string;
17686
+ /**
17687
+ * @description UUID of a Filter entity to apply to the Channel list.
17688
+ *
17689
+ * The Filter must be in the same Organization as the user credentials.
17690
+ *
17691
+ * The Filter's From field must match the entity type being filtered (Channel).
17692
+ *
17693
+ * For Space-resident entities, if the Filter has a FromSpaceID, it must match the operation's SpaceID.
17694
+ *
17695
+ * The Filter's Where clause will be combined with any explicit 'where' parameter using AND logic.
17696
+ *
17697
+ * If both 'filter' and 'where' parameters are specified, they are combined with AND logic.
17698
+ */
17699
+ filter?: string;
17700
+ /**
17701
+ * @description Free text search that approximately matches the specified string against string fields and map keys/values.
17702
+ *
17703
+ * The search is case-insensitive and uses pattern matching to find entities containing the text.
17704
+ *
17705
+ * Searchable string fields include attributes like Slug, DisplayName, and string-typed custom fields.
17706
+ *
17707
+ * For map fields (like Labels and Annotations), the search matches both map keys and values.
17708
+ *
17709
+ * The search uses OR logic across all searchable fields, so matching any field will return the entity.
17710
+ *
17711
+ * If both 'where' and 'contains' parameters are specified, they are combined with AND logic.
17712
+ *
17713
+ * Searchable fields for Channel include string and map-type attributes from the queryable attributes list.
17714
+ *
17715
+ * The whole string must be query-encoded.
17716
+ */
17717
+ contains?: string;
17718
+ /**
17719
+ * @description Hidden Channel entities, those with a HiddenReason, are left out of the results, or of what a bulk operation acts on, unless this names their HiddenReason.
17720
+ *
17721
+ * It is a comma-separated list of HiddenReasons, or `*` for all of them.
17722
+ *
17723
+ * A where clause naming the entities, by their Slug or ID with `=` or `IN`, or naming HiddenReason at all, also returns hidden entities it selects.
17724
+ *
17725
+ * ConfigHub/YAML Units, which hold the configuration of entities, are hidden with the HiddenReason `BackingUnit`.
17726
+ */
17727
+ include_hidden?: string;
17728
+ /**
17729
+ * @description Include clause for expanding related entities in the response for Channel.
17730
+ * The attribute names are case-sensitive, PascalCase, and
17731
+ * expected in a comma-separated list format as in the JSON encoding.
17732
+ *
17733
+ * Supported attributes for Channel are OrganizationID, SpaceID.
17734
+ *
17735
+ * The whole string must be query-encoded.
17736
+ */
17737
+ include?: string;
17738
+ /** @description Maximum number of Channel entities to act on, in ID order. A request that names limit or continue also stops when it runs short of time, and returns a ConfigHub-Continue header to pass as the continue parameter of the next request; keep sending requests until a response has none. If neither is specified, the request acts on every selected entity. */
17739
+ limit?: number;
17740
+ /** @description The token from the ConfigHub-Continue header of the previous request, to act on the Channel entities after the last one it acted on. The request's other parameters, except limit, must be the same as those of the request that returned the token. */
17741
+ continue?: string;
17742
+ /** @description Prune: of the Channels selected, delete those whose backing Unit is empty, which says the Channel should not exist, and keep the Unit, empty and backing nothing, so that it keeps the Channel's history and a document that comes back revives it. The others are left alone and are not in the response, so a broad selection deletes only what was emptied. */
17743
+ from_backing_units?: boolean;
17744
+ };
17745
+ header?: never;
17746
+ path?: never;
17747
+ cookie?: never;
17748
+ };
17749
+ requestBody?: never;
17750
+ responses: {
17751
+ /** @description OK */
17752
+ 200: {
17753
+ headers: {
17754
+ /** @description The token to pass as the continue parameter of the next request, when there may be more entities after this page. It is absent on the last page. A page can hold fewer entities than the limit, or none, and still have one. */
17755
+ "ConfigHub-Continue"?: string;
17756
+ [name: string]: unknown;
17757
+ };
17758
+ content: {
17759
+ "application/json": components["schemas"]["DeleteResponse"][];
17760
+ };
17761
+ };
17762
+ /** @description Multi-Status: Mixed success and failure results */
17763
+ 207: {
17764
+ headers: {
17765
+ [name: string]: unknown;
17766
+ };
17767
+ content: {
17768
+ "application/json": components["schemas"]["DeleteResponse"][];
17769
+ };
17770
+ };
17771
+ /** @description Channel request is invalid (Bad Request). */
17772
+ 400: {
17773
+ headers: {
17774
+ [name: string]: unknown;
17775
+ };
17776
+ content: {
17777
+ "application/json": components["schemas"]["StandardErrorResponse"];
17778
+ };
17779
+ };
17780
+ /** @description Unauthorized access. */
17781
+ 401: {
17782
+ headers: {
17783
+ [name: string]: unknown;
17784
+ };
17785
+ content: {
17786
+ "application/json": components["schemas"]["StandardErrorResponse"];
17787
+ };
17788
+ };
17789
+ /** @description Forbidden access. */
17790
+ 403: {
17791
+ headers: {
17792
+ [name: string]: unknown;
17793
+ };
17794
+ content: {
17795
+ "application/json": components["schemas"]["StandardErrorResponse"];
17796
+ };
17797
+ };
17798
+ /** @description Channel not found. */
17799
+ 404: {
17800
+ headers: {
17801
+ [name: string]: unknown;
17802
+ };
17803
+ content: {
17804
+ "application/json": components["schemas"]["StandardErrorResponse"];
17805
+ };
17806
+ };
17807
+ /** @description Channel is still in use: it has DeleteGates, or other entities still reference it. Or data has changed since last read. */
17808
+ 409: {
17809
+ headers: {
17810
+ [name: string]: unknown;
17811
+ };
17812
+ content: {
17813
+ "application/json": components["schemas"]["StandardErrorResponse"];
17814
+ };
17815
+ };
17816
+ /** @description Unable to delete entity */
17817
+ 422: {
17818
+ headers: {
17819
+ [name: string]: unknown;
17820
+ };
17821
+ content: {
17822
+ "application/json": components["schemas"]["StandardErrorResponse"];
17823
+ };
17824
+ };
17825
+ /** @description Something went wrong while processing Channel. */
17826
+ 500: {
17827
+ headers: {
17828
+ [name: string]: unknown;
17829
+ };
17830
+ content: {
17831
+ "application/json": components["schemas"]["StandardErrorResponse"];
17832
+ };
17833
+ };
17834
+ /** @description Unexpected error. */
17835
+ default: {
17836
+ headers: {
17837
+ [name: string]: unknown;
17838
+ };
17839
+ content: {
17840
+ "application/json": components["schemas"]["StandardErrorResponse"];
17841
+ };
17842
+ };
17843
+ };
17844
+ };
17845
+ BulkPatchChannels: {
17846
+ parameters: {
17847
+ query?: {
17848
+ /**
17849
+ * @description The specified string is an expression for the purpose of filtering
17850
+ * the list of Channels returned. The expression syntax was inspired by SQL.
17851
+ * It supports conjunctions using `AND` of relational expressions of the form *attribute*
17852
+ * *operator* *attribute_or_literal*. The attribute names are case-sensitive and PascalCase,
17853
+ * as in the JSON encoding.
17854
+ * Strings support the following operators: `<`, `>`, `<=`, `>=`, `=`, `!=`, `LIKE`, `NOT LIKE`, `ILIKE`, `~~`, `!~~`, `~`, `~*`, `!~`, `!~*`, `IN`, `NOT IN`.
17855
+ * String pattern operators: `LIKE` and `~~` for pattern matching with `%` and `_` wildcards,
17856
+ * `ILIKE` for case-insensitive pattern matching, `NOT LIKE` and `!~~` for negated pattern matching.
17857
+ * String regex operators: `~` for regex matching, `~*` for case-insensitive regex,
17858
+ * `!~` and `!~*` for regex not matching (case-sensitive and insensitive).
17859
+ * Integers support the following operators: `<`, `>`, `<=`, `>=`, `=`, `!=`, `IN`, `NOT IN`.
17860
+ * UUIDs and boolean attributes support equality and inequality only.
17861
+ * UUID and time literals must be quoted as string literals.
17862
+ * String literals are quoted with single quotes, such as `'string'`.
17863
+ * Time literals use the same form as when serialized as JSON,
17864
+ * such as: `CreatedAt > '2025-02-18T23:16:34'`.
17865
+ * Integer and boolean literals are also supported for attributes of those types.
17866
+ * Arrays support the `?` operator to to match any element of the array,
17867
+ * as in `FromLinkID ? '7c61626f-ddbe-41af-93f6-b69f4ab6d308'`.
17868
+ * Arrays can perform LEN() to check for length, as in `LEN(FromLinkID) > 0`.
17869
+ * An attribute naming a list of other entities can be filtered on their attributes with a `*` segment,
17870
+ * as in `FromLink.*.Slug = 'upgrade-app'`, which holds when any element satisfies it.
17871
+ * Without the `*` such a reference is an error, since it names no single value to compare.
17872
+ * Map support the dot notation to specify a particular map key, as in `Labels.tier = 'Backend'`.
17873
+ * Maps support `IS NULL` and `IS NOT NULL` with dot notation to check for key absence or presence,
17874
+ * as in `Labels.tier IS NULL` (key doesn't exist) or `Labels.tier IS NOT NULL` (key exists).
17875
+ * Comparison results can be tested with `IS TRUE`, `IS FALSE`, `IS NOT TRUE`, and `IS NOT FALSE`.
17876
+ * These are useful for nullable columns: `MergeSourceID = '<uuid>' IS NOT FALSE` matches rows where MergeSourceID equals the value OR is NULL.
17877
+ * The `IN` and `NOT IN` operators accept a comma-separated list of values in parentheses,
17878
+ * such as `Slug IN ('slugone', 'slugtwo')` or `Labels.environment IN ('prod', 'staging')`.
17879
+ * Conjunctions are supported using the `AND` operator.
17880
+ * An example conjunction is:
17881
+ * `CreatedAt >= '2025-01-07' AND Slug = 'test' AND Labels.mykey = 'myvalue'`.
17882
+ *
17883
+ * Supported attributes for filtering on Channel: Annotations, BackingUnitID, ChannelID, Commands, Condition, CreatedAt, DeleteGates, DisplayName, EventPosition, HiddenReason, IPAddress, Labels, LastMessage, LastSeenAt, OrganizationID, Permissions, Slug, SpaceID, Subscriptions, UpdatedAt, UpstreamChannelID.
17386
17884
  *
17387
17885
  * The whole string must be query-encoded.
17388
17886
  */
@@ -17443,6 +17941,10 @@ interface operations {
17443
17941
  limit?: number;
17444
17942
  /** @description The token from the ConfigHub-Continue header of the previous request, to act on the Channel entities after the last one it acted on. The request's other parameters, except limit, must be the same as those of the request that returned the token. */
17445
17943
  continue?: string;
17944
+ /** @description Give each Channel written a backing Unit if it has none: a ConfigHub/YAML Unit holding the Channel's configuration, which is then kept in step with it. */
17945
+ with_backing_units?: boolean;
17946
+ /** @description Patch each selected Channel with what its backing Unit holds that it has not taken yet: the change to the Unit since its LastReleasedRevisionNum. The request body is applied after it. Selecting one with no backing Unit is an error, and so are outstanding ValidationErrors on a backing Unit. */
17947
+ from_backing_units?: boolean;
17446
17948
  /** @description If true, report what the write would do without doing it: the write runs, including every check it makes, and is then rolled back. The response is the one the write would return, with the entities as they would be written. An entity a dry run creates is given an ID that the real create will not reuse. */
17447
17949
  dry_run?: boolean;
17448
17950
  };
@@ -17550,6 +18052,206 @@ interface operations {
17550
18052
  "application/json": components["schemas"]["StandardErrorResponse"];
17551
18053
  };
17552
18054
  };
18055
+ /** @description A backing Unit has outstanding ValidationErrors */
18056
+ 422: {
18057
+ headers: {
18058
+ [name: string]: unknown;
18059
+ };
18060
+ content: {
18061
+ "application/json": components["schemas"]["StandardErrorResponse"];
18062
+ };
18063
+ };
18064
+ /** @description Something went wrong while processing Channel. */
18065
+ 500: {
18066
+ headers: {
18067
+ [name: string]: unknown;
18068
+ };
18069
+ content: {
18070
+ "application/json": components["schemas"]["StandardErrorResponse"];
18071
+ };
18072
+ };
18073
+ /** @description Unexpected error. */
18074
+ default: {
18075
+ headers: {
18076
+ [name: string]: unknown;
18077
+ };
18078
+ content: {
18079
+ "application/json": components["schemas"]["StandardErrorResponse"];
18080
+ };
18081
+ };
18082
+ };
18083
+ };
18084
+ BulkMoveChannels: {
18085
+ parameters: {
18086
+ query?: {
18087
+ /**
18088
+ * @description The specified string is an expression for the purpose of filtering
18089
+ * the list of Channels returned. The expression syntax was inspired by SQL.
18090
+ * It supports conjunctions using `AND` of relational expressions of the form *attribute*
18091
+ * *operator* *attribute_or_literal*. The attribute names are case-sensitive and PascalCase,
18092
+ * as in the JSON encoding.
18093
+ * Strings support the following operators: `<`, `>`, `<=`, `>=`, `=`, `!=`, `LIKE`, `NOT LIKE`, `ILIKE`, `~~`, `!~~`, `~`, `~*`, `!~`, `!~*`, `IN`, `NOT IN`.
18094
+ * String pattern operators: `LIKE` and `~~` for pattern matching with `%` and `_` wildcards,
18095
+ * `ILIKE` for case-insensitive pattern matching, `NOT LIKE` and `!~~` for negated pattern matching.
18096
+ * String regex operators: `~` for regex matching, `~*` for case-insensitive regex,
18097
+ * `!~` and `!~*` for regex not matching (case-sensitive and insensitive).
18098
+ * Integers support the following operators: `<`, `>`, `<=`, `>=`, `=`, `!=`, `IN`, `NOT IN`.
18099
+ * UUIDs and boolean attributes support equality and inequality only.
18100
+ * UUID and time literals must be quoted as string literals.
18101
+ * String literals are quoted with single quotes, such as `'string'`.
18102
+ * Time literals use the same form as when serialized as JSON,
18103
+ * such as: `CreatedAt > '2025-02-18T23:16:34'`.
18104
+ * Integer and boolean literals are also supported for attributes of those types.
18105
+ * Arrays support the `?` operator to to match any element of the array,
18106
+ * as in `FromLinkID ? '7c61626f-ddbe-41af-93f6-b69f4ab6d308'`.
18107
+ * Arrays can perform LEN() to check for length, as in `LEN(FromLinkID) > 0`.
18108
+ * An attribute naming a list of other entities can be filtered on their attributes with a `*` segment,
18109
+ * as in `FromLink.*.Slug = 'upgrade-app'`, which holds when any element satisfies it.
18110
+ * Without the `*` such a reference is an error, since it names no single value to compare.
18111
+ * Map support the dot notation to specify a particular map key, as in `Labels.tier = 'Backend'`.
18112
+ * Maps support `IS NULL` and `IS NOT NULL` with dot notation to check for key absence or presence,
18113
+ * as in `Labels.tier IS NULL` (key doesn't exist) or `Labels.tier IS NOT NULL` (key exists).
18114
+ * Comparison results can be tested with `IS TRUE`, `IS FALSE`, `IS NOT TRUE`, and `IS NOT FALSE`.
18115
+ * These are useful for nullable columns: `MergeSourceID = '<uuid>' IS NOT FALSE` matches rows where MergeSourceID equals the value OR is NULL.
18116
+ * The `IN` and `NOT IN` operators accept a comma-separated list of values in parentheses,
18117
+ * such as `Slug IN ('slugone', 'slugtwo')` or `Labels.environment IN ('prod', 'staging')`.
18118
+ * Conjunctions are supported using the `AND` operator.
18119
+ * An example conjunction is:
18120
+ * `CreatedAt >= '2025-01-07' AND Slug = 'test' AND Labels.mykey = 'myvalue'`.
18121
+ *
18122
+ * Supported attributes for filtering on Channel: Annotations, BackingUnitID, ChannelID, Commands, Condition, CreatedAt, DeleteGates, DisplayName, EventPosition, HiddenReason, IPAddress, Labels, LastMessage, LastSeenAt, OrganizationID, Permissions, Slug, SpaceID, Subscriptions, UpdatedAt, UpstreamChannelID.
18123
+ *
18124
+ * The whole string must be query-encoded.
18125
+ */
18126
+ where?: string;
18127
+ /**
18128
+ * @description UUID of a Filter entity to apply to the Channel list.
18129
+ *
18130
+ * The Filter must be in the same Organization as the user credentials.
18131
+ *
18132
+ * The Filter's From field must match the entity type being filtered (Channel).
18133
+ *
18134
+ * For Space-resident entities, if the Filter has a FromSpaceID, it must match the operation's SpaceID.
18135
+ *
18136
+ * The Filter's Where clause will be combined with any explicit 'where' parameter using AND logic.
18137
+ *
18138
+ * If both 'filter' and 'where' parameters are specified, they are combined with AND logic.
18139
+ */
18140
+ filter?: string;
18141
+ /**
18142
+ * @description Free text search that approximately matches the specified string against string fields and map keys/values.
18143
+ *
18144
+ * The search is case-insensitive and uses pattern matching to find entities containing the text.
18145
+ *
18146
+ * Searchable string fields include attributes like Slug, DisplayName, and string-typed custom fields.
18147
+ *
18148
+ * For map fields (like Labels and Annotations), the search matches both map keys and values.
18149
+ *
18150
+ * The search uses OR logic across all searchable fields, so matching any field will return the entity.
18151
+ *
18152
+ * If both 'where' and 'contains' parameters are specified, they are combined with AND logic.
18153
+ *
18154
+ * Searchable fields for Channel include string and map-type attributes from the queryable attributes list.
18155
+ *
18156
+ * The whole string must be query-encoded.
18157
+ */
18158
+ contains?: string;
18159
+ /**
18160
+ * @description Hidden Channel entities, those with a HiddenReason, are left out of the results, or of what a bulk operation acts on, unless this names their HiddenReason.
18161
+ *
18162
+ * It is a comma-separated list of HiddenReasons, or `*` for all of them.
18163
+ *
18164
+ * A where clause naming the entities, by their Slug or ID with `=` or `IN`, or naming HiddenReason at all, also returns hidden entities it selects.
18165
+ *
18166
+ * ConfigHub/YAML Units, which hold the configuration of entities, are hidden with the HiddenReason `BackingUnit`.
18167
+ */
18168
+ include_hidden?: string;
18169
+ /**
18170
+ * @description Include clause for expanding related entities in the response for Channel.
18171
+ * The attribute names are case-sensitive, PascalCase, and
18172
+ * expected in a comma-separated list format as in the JSON encoding.
18173
+ *
18174
+ * Supported attributes for Channel are OrganizationID, SpaceID.
18175
+ *
18176
+ * The whole string must be query-encoded.
18177
+ */
18178
+ include?: string;
18179
+ /** @description Report what the move would do, and what would stop it, without moving anything */
18180
+ dry_run?: boolean;
18181
+ };
18182
+ header?: never;
18183
+ path?: never;
18184
+ cookie?: never;
18185
+ };
18186
+ requestBody?: {
18187
+ content: {
18188
+ "application/json": components["schemas"]["MoveRequest"];
18189
+ };
18190
+ };
18191
+ responses: {
18192
+ /** @description OK */
18193
+ 200: {
18194
+ headers: {
18195
+ [name: string]: unknown;
18196
+ };
18197
+ content: {
18198
+ "application/json": components["schemas"]["MoveResponse"][];
18199
+ };
18200
+ };
18201
+ /** @description Multi-Status: nothing was moved, or some moved and others did not */
18202
+ 207: {
18203
+ headers: {
18204
+ [name: string]: unknown;
18205
+ };
18206
+ content: {
18207
+ "application/json": components["schemas"]["MoveResponse"][];
18208
+ };
18209
+ };
18210
+ /** @description Channel request is invalid (Bad Request). */
18211
+ 400: {
18212
+ headers: {
18213
+ [name: string]: unknown;
18214
+ };
18215
+ content: {
18216
+ "application/json": components["schemas"]["StandardErrorResponse"];
18217
+ };
18218
+ };
18219
+ /** @description Unauthorized access. */
18220
+ 401: {
18221
+ headers: {
18222
+ [name: string]: unknown;
18223
+ };
18224
+ content: {
18225
+ "application/json": components["schemas"]["StandardErrorResponse"];
18226
+ };
18227
+ };
18228
+ /** @description Forbidden access. */
18229
+ 403: {
18230
+ headers: {
18231
+ [name: string]: unknown;
18232
+ };
18233
+ content: {
18234
+ "application/json": components["schemas"]["StandardErrorResponse"];
18235
+ };
18236
+ };
18237
+ /** @description Channel not found. */
18238
+ 404: {
18239
+ headers: {
18240
+ [name: string]: unknown;
18241
+ };
18242
+ content: {
18243
+ "application/json": components["schemas"]["StandardErrorResponse"];
18244
+ };
18245
+ };
18246
+ /** @description Channel data conflict. Data has changed since last read. */
18247
+ 409: {
18248
+ headers: {
18249
+ [name: string]: unknown;
18250
+ };
18251
+ content: {
18252
+ "application/json": components["schemas"]["StandardErrorResponse"];
18253
+ };
18254
+ };
17553
18255
  /** @description Something went wrong while processing Channel. */
17554
18256
  500: {
17555
18257
  headers: {
@@ -17738,7 +18440,7 @@ interface operations {
17738
18440
  * expected in a comma-separated list format as in the JSON encoding.
17739
18441
  * If not specified, all fields are returned.
17740
18442
  * Entity and parent IDs (like OrganizationID, SpaceID, CommandRunID) and Slug are always returned regardless of the select parameter.
17741
- * Fields used in where and contains filters, and fields named by order_by, are also automatically included.
18443
+ * Fields used in where and contains filters, fields named by order_by, and fields read by the columns of the View named by view are also automatically included.
17742
18444
  * Example: 'DisplayName,CreatedAt,Labels' will return only those fields plus the required ID and Slug fields.
17743
18445
  * The whole string must be query-encoded.
17744
18446
  */
@@ -17750,7 +18452,7 @@ interface operations {
17750
18452
  *
17751
18453
  * Field names are case-sensitive and PascalCase, as in the JSON encoding. Sort direction defaults to ASC when the 'DIRECTION:' prefix is omitted.
17752
18454
  *
17753
- * Supported attributes for ordering CommandRun: ChannelID, Command, CommandRunID, CompletedAt, CreatedAt, CreatedBy, Deadline, DeliveredAt, OrganizationID, SpaceID, Status, TargetID, TimeoutAt, UnitID.
18455
+ * Supported attributes for ordering CommandRun: ChannelID, Command, CommandRunID, CompletedAt, CreatedAt, CreatedBy, Deadline, DeliveredAt, OrganizationID, Status, TargetID, TimeoutAt, UnitID.
17754
18456
  *
17755
18457
  * Example: 'DESC:CreatedAt' or 'DisplayName,DESC:CreatedAt'.
17756
18458
  *
@@ -17932,7 +18634,7 @@ interface operations {
17932
18634
  * expected in a comma-separated list format as in the JSON encoding.
17933
18635
  * If not specified, all fields are returned.
17934
18636
  * Entity and parent IDs (like OrganizationID, SpaceID, ComponentID) and Slug are always returned regardless of the select parameter.
17935
- * Fields used in where and contains filters, and fields named by order_by, are also automatically included.
18637
+ * Fields used in where and contains filters, fields named by order_by, and fields read by the columns of the View named by view are also automatically included.
17936
18638
  * Example: 'DisplayName,CreatedAt,Labels' will return only those fields plus the required ID and Slug fields.
17937
18639
  * The whole string must be query-encoded.
17938
18640
  */
@@ -17947,6 +18649,16 @@ interface operations {
17947
18649
  * ConfigHub/YAML Units, which hold the configuration of entities, are hidden with the HiddenReason `BackingUnit`.
17948
18650
  */
17949
18651
  include_hidden?: string;
18652
+ /**
18653
+ * @description UUID of a View whose columns to compute for each Component, returned as ViewColumns.
18654
+ *
18655
+ * The View must be in the same Organization as the user credentials, and be a View of Component: its Of, or the From of its Filter, must be Component.
18656
+ *
18657
+ * If the View has a Filter, the Filter selects the entities as the filter parameter does, so the two may not both be specified.
18658
+ *
18659
+ * The related entities and fields the View's columns read are included and selected automatically, so neither include nor select has to name them.
18660
+ */
18661
+ view?: string;
17950
18662
  /** @description Maximum number of Component entities to return. If not specified, all matching entities are returned. Values greater than 1000 are rejected with 400. When there may be more entities, the response has a ConfigHub-Continue header to pass as the continue parameter of the next request. */
17951
18663
  limit?: number;
17952
18664
  /**
@@ -18160,7 +18872,7 @@ interface operations {
18160
18872
  * expected in a comma-separated list format as in the JSON encoding.
18161
18873
  * If not specified, all fields are returned.
18162
18874
  * Entity and parent IDs (like OrganizationID, SpaceID, ComponentID) and Slug are always returned regardless of the select parameter.
18163
- * Fields used in where and contains filters, and fields named by order_by, are also automatically included.
18875
+ * Fields used in where and contains filters, fields named by order_by, and fields read by the columns of the View named by view are also automatically included.
18164
18876
  * Example: 'DisplayName,CreatedAt,Labels' will return only those fields plus the required ID and Slug fields.
18165
18877
  * The whole string must be query-encoded.
18166
18878
  */
@@ -18723,9 +19435,9 @@ interface operations {
18723
19435
  /** @description Plan the demotion and return the same response without writing anything. */
18724
19436
  dry_run?: boolean;
18725
19437
  /**
18726
- * @description Comma-separated parts of the result to return in addition to the actions: Mutations for what each restore changed, or on a dry run would change, as entries of its MutationSources, and Diff for the same change path by path with the values on both sides.
19438
+ * @description Comma-separated parts of the result to return in addition to the actions: Mutations for what each restore changed, or on a dry run would change, as entries of its MutationSources, and Diff for the same change path by path with the values on both sides. Context, with Diff, adds to each Diff the unchanged paths around the changes: every unchanged child of each map or array that holds a change, up to the resource, as ChangeType None.
18727
19439
  *
18728
- * Supported values: Mutations, Diff.
19440
+ * Supported values: Mutations, Diff, Context.
18729
19441
  */
18730
19442
  include?: string;
18731
19443
  };
@@ -19018,7 +19730,7 @@ interface operations {
19018
19730
  * expected in a comma-separated list format as in the JSON encoding.
19019
19731
  * If not specified, all fields are returned.
19020
19732
  * Entity and parent IDs (like OrganizationID, SpaceID, FilterID) and Slug are always returned regardless of the select parameter.
19021
- * Fields used in where and contains filters, and fields named by order_by, are also automatically included.
19733
+ * Fields used in where and contains filters, fields named by order_by, and fields read by the columns of the View named by view are also automatically included.
19022
19734
  * Example: 'DisplayName,CreatedAt,Labels' will return only those fields plus the required ID and Slug fields.
19023
19735
  * The whole string must be query-encoded.
19024
19736
  */
@@ -19033,6 +19745,16 @@ interface operations {
19033
19745
  * ConfigHub/YAML Units, which hold the configuration of entities, are hidden with the HiddenReason `BackingUnit`.
19034
19746
  */
19035
19747
  include_hidden?: string;
19748
+ /**
19749
+ * @description UUID of a View whose columns to compute for each Filter, returned as ViewColumns.
19750
+ *
19751
+ * The View must be in the same Organization as the user credentials, and be a View of Filter: its Of, or the From of its Filter, must be Filter.
19752
+ *
19753
+ * If the View has a Filter, the Filter selects the entities as the filter parameter does, so the two may not both be specified.
19754
+ *
19755
+ * The related entities and fields the View's columns read are included and selected automatically, so neither include nor select has to name them.
19756
+ */
19757
+ view?: string;
19036
19758
  /** @description Maximum number of Filter entities to return. If not specified, all matching entities are returned. Values greater than 1000 are rejected with 400. When there may be more entities, the response has a ConfigHub-Continue header to pass as the continue parameter of the next request. */
19037
19759
  limit?: number;
19038
19760
  /**
@@ -20346,7 +21068,7 @@ interface operations {
20346
21068
  trigger_filter?: string;
20347
21069
  /** @description When true, return units that pass trigger validation; when false (default), return units that fail. Only applies when where_trigger or trigger_filter is specified. */
20348
21070
  triggers_passed?: boolean;
20349
- /** @description View slug or UUID. Applies the View's column definitions to extract values for each unit. If the View has a FilterID, its filter is ANDed with other filters. The View must have Of=Unit or a Filter with From=Unit. */
21071
+ /** @description UUID of a View of Unit. Its Filter selects the Units as the filter parameter does, so the two may not both be specified. */
20350
21072
  view?: string;
20351
21073
  };
20352
21074
  header?: never;
@@ -20559,7 +21281,7 @@ interface operations {
20559
21281
  * expected in a comma-separated list format as in the JSON encoding.
20560
21282
  * If not specified, all fields are returned.
20561
21283
  * Entity and parent IDs (like OrganizationID, SpaceID, GroupID) and Slug are always returned regardless of the select parameter.
20562
- * Fields used in where and contains filters, and fields named by order_by, are also automatically included.
21284
+ * Fields used in where and contains filters, fields named by order_by, and fields read by the columns of the View named by view are also automatically included.
20563
21285
  * Example: 'DisplayName,CreatedAt,Labels' will return only those fields plus the required ID and Slug fields.
20564
21286
  * The whole string must be query-encoded.
20565
21287
  */
@@ -20574,6 +21296,16 @@ interface operations {
20574
21296
  * ConfigHub/YAML Units, which hold the configuration of entities, are hidden with the HiddenReason `BackingUnit`.
20575
21297
  */
20576
21298
  include_hidden?: string;
21299
+ /**
21300
+ * @description UUID of a View whose columns to compute for each Group, returned as ViewColumns.
21301
+ *
21302
+ * The View must be in the same Organization as the user credentials, and be a View of Group: its Of, or the From of its Filter, must be Group.
21303
+ *
21304
+ * If the View has a Filter, the Filter selects the entities as the filter parameter does, so the two may not both be specified.
21305
+ *
21306
+ * The related entities and fields the View's columns read are included and selected automatically, so neither include nor select has to name them.
21307
+ */
21308
+ view?: string;
20577
21309
  /** @description Maximum number of Group entities to return. If not specified, all matching entities are returned. Values greater than 1000 are rejected with 400. When there may be more entities, the response has a ConfigHub-Continue header to pass as the continue parameter of the next request. */
20578
21310
  limit?: number;
20579
21311
  /**
@@ -20681,7 +21413,7 @@ interface operations {
20681
21413
  * expected in a comma-separated list format as in the JSON encoding.
20682
21414
  * If not specified, all fields are returned.
20683
21415
  * Entity and parent IDs (like OrganizationID, SpaceID, GroupID) and Slug are always returned regardless of the select parameter.
20684
- * Fields used in where and contains filters, and fields named by order_by, are also automatically included.
21416
+ * Fields used in where and contains filters, fields named by order_by, and fields read by the columns of the View named by view are also automatically included.
20685
21417
  * Example: 'DisplayName,CreatedAt,Labels' will return only those fields plus the required ID and Slug fields.
20686
21418
  * The whole string must be query-encoded.
20687
21419
  */
@@ -21059,7 +21791,7 @@ interface operations {
21059
21791
  * expected in a comma-separated list format as in the JSON encoding.
21060
21792
  * If not specified, all fields are returned.
21061
21793
  * Entity and parent IDs (like OrganizationID, SpaceID, InvocationID) and Slug are always returned regardless of the select parameter.
21062
- * Fields used in where and contains filters, and fields named by order_by, are also automatically included.
21794
+ * Fields used in where and contains filters, fields named by order_by, and fields read by the columns of the View named by view are also automatically included.
21063
21795
  * Example: 'DisplayName,CreatedAt,Labels' will return only those fields plus the required ID and Slug fields.
21064
21796
  * The whole string must be query-encoded.
21065
21797
  */
@@ -21074,6 +21806,16 @@ interface operations {
21074
21806
  * ConfigHub/YAML Units, which hold the configuration of entities, are hidden with the HiddenReason `BackingUnit`.
21075
21807
  */
21076
21808
  include_hidden?: string;
21809
+ /**
21810
+ * @description UUID of a View whose columns to compute for each Invocation, returned as ViewColumns.
21811
+ *
21812
+ * The View must be in the same Organization as the user credentials, and be a View of Invocation: its Of, or the From of its Filter, must be Invocation.
21813
+ *
21814
+ * If the View has a Filter, the Filter selects the entities as the filter parameter does, so the two may not both be specified.
21815
+ *
21816
+ * The related entities and fields the View's columns read are included and selected automatically, so neither include nor select has to name them.
21817
+ */
21818
+ view?: string;
21077
21819
  /** @description Maximum number of Invocation entities to return. If not specified, all matching entities are returned. Values greater than 1000 are rejected with 400. When there may be more entities, the response has a ConfigHub-Continue header to pass as the continue parameter of the next request. */
21078
21820
  limit?: number;
21079
21821
  /**
@@ -22250,7 +22992,7 @@ interface operations {
22250
22992
  * expected in a comma-separated list format as in the JSON encoding.
22251
22993
  * If not specified, all fields are returned.
22252
22994
  * Entity and parent IDs (like OrganizationID, SpaceID, LinkID) and Slug are always returned regardless of the select parameter.
22253
- * Fields used in where and contains filters, and fields named by order_by, are also automatically included.
22995
+ * Fields used in where and contains filters, fields named by order_by, and fields read by the columns of the View named by view are also automatically included.
22254
22996
  * Example: 'DisplayName,CreatedAt,Labels' will return only those fields plus the required ID and Slug fields.
22255
22997
  * The whole string must be query-encoded.
22256
22998
  */
@@ -22265,6 +23007,16 @@ interface operations {
22265
23007
  * ConfigHub/YAML Units, which hold the configuration of entities, are hidden with the HiddenReason `BackingUnit`.
22266
23008
  */
22267
23009
  include_hidden?: string;
23010
+ /**
23011
+ * @description UUID of a View whose columns to compute for each Link, returned as ViewColumns.
23012
+ *
23013
+ * The View must be in the same Organization as the user credentials, and be a View of Link: its Of, or the From of its Filter, must be Link.
23014
+ *
23015
+ * If the View has a Filter, the Filter selects the entities as the filter parameter does, so the two may not both be specified.
23016
+ *
23017
+ * The related entities and fields the View's columns read are included and selected automatically, so neither include nor select has to name them.
23018
+ */
23019
+ view?: string;
22268
23020
  /** @description Maximum number of Link entities to return. If not specified, all matching entities are returned. Values greater than 1000 are rejected with 400. When there may be more entities, the response has a ConfigHub-Continue header to pass as the continue parameter of the next request. */
22269
23021
  limit?: number;
22270
23022
  /**
@@ -23772,7 +24524,7 @@ interface operations {
23772
24524
  * expected in a comma-separated list format as in the JSON encoding.
23773
24525
  * If not specified, all fields are returned.
23774
24526
  * Entity and parent IDs (like OrganizationID, SpaceID, OrganizationID) and Slug are always returned regardless of the select parameter.
23775
- * Fields used in where and contains filters, and fields named by order_by, are also automatically included.
24527
+ * Fields used in where and contains filters, fields named by order_by, and fields read by the columns of the View named by view are also automatically included.
23776
24528
  * Example: 'DisplayName,CreatedAt,Labels' will return only those fields plus the required ID and Slug fields.
23777
24529
  * The whole string must be query-encoded.
23778
24530
  */
@@ -23787,6 +24539,16 @@ interface operations {
23787
24539
  * ConfigHub/YAML Units, which hold the configuration of entities, are hidden with the HiddenReason `BackingUnit`.
23788
24540
  */
23789
24541
  include_hidden?: string;
24542
+ /**
24543
+ * @description UUID of a View whose columns to compute for each Organization, returned as ViewColumns.
24544
+ *
24545
+ * The View must be in the same Organization as the user credentials, and be a View of Organization: its Of, or the From of its Filter, must be Organization.
24546
+ *
24547
+ * If the View has a Filter, the Filter selects the entities as the filter parameter does, so the two may not both be specified.
24548
+ *
24549
+ * The related entities and fields the View's columns read are included and selected automatically, so neither include nor select has to name them.
24550
+ */
24551
+ view?: string;
23790
24552
  };
23791
24553
  header?: never;
23792
24554
  path?: never;
@@ -23968,7 +24730,7 @@ interface operations {
23968
24730
  * expected in a comma-separated list format as in the JSON encoding.
23969
24731
  * If not specified, all fields are returned.
23970
24732
  * Entity and parent IDs (like OrganizationID, SpaceID, OrganizationID) and Slug are always returned regardless of the select parameter.
23971
- * Fields used in where and contains filters, and fields named by order_by, are also automatically included.
24733
+ * Fields used in where and contains filters, fields named by order_by, and fields read by the columns of the View named by view are also automatically included.
23972
24734
  * Example: 'DisplayName,CreatedAt,Labels' will return only those fields plus the required ID and Slug fields.
23973
24735
  * The whole string must be query-encoded.
23974
24736
  */
@@ -24311,6 +25073,16 @@ interface operations {
24311
25073
  * The whole string must be query-encoded.
24312
25074
  */
24313
25075
  contains?: string;
25076
+ /**
25077
+ * @description UUID of a View whose columns to compute for each OrganizationMember, returned as ViewColumns.
25078
+ *
25079
+ * The View must be in the same Organization as the user credentials, and be a View of OrganizationMember: its Of, or the From of its Filter, must be OrganizationMember.
25080
+ *
25081
+ * If the View has a Filter, the Filter selects the entities as the filter parameter does, so the two may not both be specified.
25082
+ *
25083
+ * The related entities and fields the View's columns read are included and selected automatically, so neither include nor select has to name them.
25084
+ */
25085
+ view?: string;
24314
25086
  };
24315
25087
  header?: never;
24316
25088
  path: {
@@ -24661,9 +25433,9 @@ interface operations {
24661
25433
  */
24662
25434
  dry_run?: boolean;
24663
25435
  /**
24664
- * @description Comma-separated parts of the result to return in addition to the actions: Mutations for what each Unit write changed, or on a dry run would change, as entries of its MutationSources, and Diff for the same change path by path with the values on both sides, and ConfigData for the configuration each Unit write produced, or on a dry run would produce. On a dry run any of them runs the merges a plan otherwise skips, so they are returned only when named.
25436
+ * @description Comma-separated parts of the result to return in addition to the actions: Mutations for what each Unit write changed, or on a dry run would change, as entries of its MutationSources, and Diff for the same change path by path with the values on both sides, and ConfigData for the configuration each Unit write produced, or on a dry run would produce. On a dry run any of them runs the merges a plan otherwise skips, so they are returned only when named. Context, with Diff, adds to each Diff the unchanged paths around the changes: every unchanged child of each map or array that holds a change, up to the resource, as ChangeType None.
24665
25437
  *
24666
- * Supported values: Mutations, Diff, ConfigData.
25438
+ * Supported values: Mutations, Diff, Context, ConfigData.
24667
25439
  */
24668
25440
  include?: string;
24669
25441
  };
@@ -24860,7 +25632,7 @@ interface operations {
24860
25632
  * expected in a comma-separated list format as in the JSON encoding.
24861
25633
  * If not specified, all fields are returned.
24862
25634
  * Entity and parent IDs (like OrganizationID, SpaceID, ReleaseID) and Slug are always returned regardless of the select parameter.
24863
- * Fields used in where and contains filters, and fields named by order_by, are also automatically included.
25635
+ * Fields used in where and contains filters, fields named by order_by, and fields read by the columns of the View named by view are also automatically included.
24864
25636
  * Example: 'DisplayName,CreatedAt,Labels' will return only those fields plus the required ID and Slug fields.
24865
25637
  * The whole string must be query-encoded.
24866
25638
  */
@@ -24875,6 +25647,16 @@ interface operations {
24875
25647
  * ConfigHub/YAML Units, which hold the configuration of entities, are hidden with the HiddenReason `BackingUnit`.
24876
25648
  */
24877
25649
  include_hidden?: string;
25650
+ /**
25651
+ * @description UUID of a View whose columns to compute for each Release, returned as ViewColumns.
25652
+ *
25653
+ * The View must be in the same Organization as the user credentials, and be a View of Release: its Of, or the From of its Filter, must be Release.
25654
+ *
25655
+ * If the View has a Filter, the Filter selects the entities as the filter parameter does, so the two may not both be specified.
25656
+ *
25657
+ * The related entities and fields the View's columns read are included and selected automatically, so neither include nor select has to name them.
25658
+ */
25659
+ view?: string;
24878
25660
  /** @description Maximum number of Release entities to return. If not specified, all matching entities are returned. Values greater than 1000 are rejected with 400. When there may be more entities, the response has a ConfigHub-Continue header to pass as the continue parameter of the next request. */
24879
25661
  limit?: number;
24880
25662
  /**
@@ -25076,7 +25858,7 @@ interface operations {
25076
25858
  * expected in a comma-separated list format as in the JSON encoding.
25077
25859
  * If not specified, all fields are returned.
25078
25860
  * Entity and parent IDs (like OrganizationID, SpaceID, ResourceID) and Slug are always returned regardless of the select parameter.
25079
- * Fields used in where and contains filters, and fields named by order_by, are also automatically included.
25861
+ * Fields used in where and contains filters, fields named by order_by, and fields read by the columns of the View named by view are also automatically included.
25080
25862
  * Example: 'DisplayName,CreatedAt,Labels' will return only those fields plus the required ID and Slug fields.
25081
25863
  * The whole string must be query-encoded.
25082
25864
  */
@@ -25091,6 +25873,16 @@ interface operations {
25091
25873
  * ConfigHub/YAML Units, which hold the configuration of entities, are hidden with the HiddenReason `BackingUnit`.
25092
25874
  */
25093
25875
  include_hidden?: string;
25876
+ /**
25877
+ * @description UUID of a View whose columns to compute for each Resource, returned as ViewColumns.
25878
+ *
25879
+ * The View must be in the same Organization as the user credentials, and be a View of Resource: its Of, or the From of its Filter, must be Resource.
25880
+ *
25881
+ * If the View has a Filter, the Filter selects the entities as the filter parameter does, so the two may not both be specified.
25882
+ *
25883
+ * The related entities and fields the View's columns read are included and selected automatically, so neither include nor select has to name them.
25884
+ */
25885
+ view?: string;
25094
25886
  /** @description Maximum number of Resource entities to return. If not specified, all matching entities are returned. Values greater than 1000 are rejected with 400. When there may be more entities, the response has a ConfigHub-Continue header to pass as the continue parameter of the next request. */
25095
25887
  limit?: number;
25096
25888
  /**
@@ -25120,8 +25912,6 @@ interface operations {
25120
25912
  * @description Deprecated: use continue. Number of Resource entities to skip before returning results. Cannot be combined with continue.
25121
25913
  */
25122
25914
  offset?: number;
25123
- /** @description UUID of a View whose columns to extract for each resource, returned as ViewColumns. DataPath columns are read from the stored JSON rather than by invoking a function. */
25124
- view?: string;
25125
25915
  /** @description Return each resource's configuration in its original toolchain-native form, as RawData on the response envelope. Off by default: the bodies are bulk, and a table view needs only the queryable Data projection. */
25126
25916
  raw_data?: boolean;
25127
25917
  };
@@ -25236,7 +26026,7 @@ interface operations {
25236
26026
  * An example conjunction is:
25237
26027
  * `CreatedAt >= '2025-01-07' AND Slug = 'test' AND Labels.mykey = 'myvalue'`.
25238
26028
  *
25239
- * Supported attributes for filtering on ReviewComment: CreatedAt, HiddenReason, OrganizationID, Path, ReplyToID, ReviewCommentID, RevisionID, RevisionNum, SpaceID, Text, UnitID, UpdatedAt, UserAgent, UserID.
26029
+ * Supported attributes for filtering on ReviewComment: ChangeOrderID, CreatedAt, HiddenReason, OrganizationID, Path, ReplyToID, ReviewCommentID, RevisionID, RevisionNum, SpaceID, Text, UnitID, UpdatedAt, UserAgent, UserID.
25240
26030
  *
25241
26031
  * The whole string must be query-encoded.
25242
26032
  */
@@ -25278,7 +26068,7 @@ interface operations {
25278
26068
  * The attribute names are case-sensitive, PascalCase, and
25279
26069
  * expected in a comma-separated list format as in the JSON encoding.
25280
26070
  *
25281
- * Supported attributes for ReviewComment are OrganizationID, RevisionID, SpaceID, UnitID.
26071
+ * Supported attributes for ReviewComment are ChangeOrderID, OrganizationID, RevisionID, SpaceID, UnitID.
25282
26072
  *
25283
26073
  * The whole string must be query-encoded.
25284
26074
  */
@@ -25289,7 +26079,7 @@ interface operations {
25289
26079
  * expected in a comma-separated list format as in the JSON encoding.
25290
26080
  * If not specified, all fields are returned.
25291
26081
  * Entity and parent IDs (like OrganizationID, SpaceID, ReviewCommentID) and Slug are always returned regardless of the select parameter.
25292
- * Fields used in where and contains filters, and fields named by order_by, are also automatically included.
26082
+ * Fields used in where and contains filters, fields named by order_by, and fields read by the columns of the View named by view are also automatically included.
25293
26083
  * Example: 'DisplayName,CreatedAt,Labels' will return only those fields plus the required ID and Slug fields.
25294
26084
  * The whole string must be query-encoded.
25295
26085
  */
@@ -25304,6 +26094,16 @@ interface operations {
25304
26094
  * ConfigHub/YAML Units, which hold the configuration of entities, are hidden with the HiddenReason `BackingUnit`.
25305
26095
  */
25306
26096
  include_hidden?: string;
26097
+ /**
26098
+ * @description UUID of a View whose columns to compute for each ReviewComment, returned as ViewColumns.
26099
+ *
26100
+ * The View must be in the same Organization as the user credentials, and be a View of ReviewComment: its Of, or the From of its Filter, must be ReviewComment.
26101
+ *
26102
+ * If the View has a Filter, the Filter selects the entities as the filter parameter does, so the two may not both be specified.
26103
+ *
26104
+ * The related entities and fields the View's columns read are included and selected automatically, so neither include nor select has to name them.
26105
+ */
26106
+ view?: string;
25307
26107
  /** @description Maximum number of ReviewComment entities to return. If not specified, all matching entities are returned. Values greater than 1000 are rejected with 400. When there may be more entities, the response has a ConfigHub-Continue header to pass as the continue parameter of the next request. */
25308
26108
  limit?: number;
25309
26109
  /**
@@ -25311,7 +26111,7 @@ interface operations {
25311
26111
  *
25312
26112
  * Field names are case-sensitive and PascalCase, as in the JSON encoding. Sort direction defaults to ASC when the 'DIRECTION:' prefix is omitted.
25313
26113
  *
25314
- * Supported attributes for ordering ReviewComment: CreatedAt, HiddenReason, OrganizationID, Path, ReplyToID, ReviewCommentID, RevisionID, RevisionNum, Text, UnitID, UpdatedAt, UserAgent, UserID.
26114
+ * Supported attributes for ordering ReviewComment: ChangeOrderID, CreatedAt, HiddenReason, OrganizationID, Path, ReplyToID, ReviewCommentID, RevisionID, RevisionNum, Text, UnitID, UpdatedAt, UserAgent, UserID.
25315
26115
  *
25316
26116
  * Example: 'DESC:CreatedAt' or 'DisplayName,DESC:CreatedAt'.
25317
26117
  *
@@ -25440,7 +26240,7 @@ interface operations {
25440
26240
  * An example conjunction is:
25441
26241
  * `CreatedAt >= '2025-01-07' AND Slug = 'test' AND Labels.mykey = 'myvalue'`.
25442
26242
  *
25443
- * Supported attributes for filtering on ReviewComment: CreatedAt, HiddenReason, OrganizationID, Path, ReplyToID, ReviewCommentID, RevisionID, RevisionNum, SpaceID, Text, UnitID, UpdatedAt, UserAgent, UserID.
26243
+ * Supported attributes for filtering on ReviewComment: ChangeOrderID, CreatedAt, HiddenReason, OrganizationID, Path, ReplyToID, ReviewCommentID, RevisionID, RevisionNum, SpaceID, Text, UnitID, UpdatedAt, UserAgent, UserID.
25444
26244
  *
25445
26245
  * The whole string must be query-encoded.
25446
26246
  */
@@ -25492,7 +26292,7 @@ interface operations {
25492
26292
  * The attribute names are case-sensitive, PascalCase, and
25493
26293
  * expected in a comma-separated list format as in the JSON encoding.
25494
26294
  *
25495
- * Supported attributes for ReviewComment are OrganizationID, RevisionID, SpaceID, UnitID.
26295
+ * Supported attributes for ReviewComment are ChangeOrderID, OrganizationID, RevisionID, SpaceID, UnitID.
25496
26296
  *
25497
26297
  * The whole string must be query-encoded.
25498
26298
  */
@@ -25640,7 +26440,7 @@ interface operations {
25640
26440
  * An example conjunction is:
25641
26441
  * `CreatedAt >= '2025-01-07' AND Slug = 'test' AND Labels.mykey = 'myvalue'`.
25642
26442
  *
25643
- * Supported attributes for filtering on ReviewComment: CreatedAt, HiddenReason, OrganizationID, Path, ReplyToID, ReviewCommentID, RevisionID, RevisionNum, SpaceID, Text, UnitID, UpdatedAt, UserAgent, UserID.
26443
+ * Supported attributes for filtering on ReviewComment: ChangeOrderID, CreatedAt, HiddenReason, OrganizationID, Path, ReplyToID, ReviewCommentID, RevisionID, RevisionNum, SpaceID, Text, UnitID, UpdatedAt, UserAgent, UserID.
25644
26444
  *
25645
26445
  * The whole string must be query-encoded.
25646
26446
  */
@@ -25692,7 +26492,7 @@ interface operations {
25692
26492
  * The attribute names are case-sensitive, PascalCase, and
25693
26493
  * expected in a comma-separated list format as in the JSON encoding.
25694
26494
  *
25695
- * Supported attributes for ReviewComment are OrganizationID, RevisionID, SpaceID, UnitID.
26495
+ * Supported attributes for ReviewComment are ChangeOrderID, OrganizationID, RevisionID, SpaceID, UnitID.
25696
26496
  *
25697
26497
  * The whole string must be query-encoded.
25698
26498
  */
@@ -25711,6 +26511,8 @@ interface operations {
25711
26511
  requestBody?: {
25712
26512
  content: {
25713
26513
  "application/merge-patch+json": {
26514
+ /** Format: uuid */
26515
+ ChangeOrderID?: string | null;
25714
26516
  /** @description The reason the entity is hidden, if it is. A hidden entity is left out of List and Search results, and of what bulk operations act on, unless the include_hidden parameter names its reason or is *, or the where parameter names the entity by Slug or ID. ConfigHub/YAML Units are created hidden with the reason BackingUnit unless given another. */
25715
26517
  HiddenReason?: string | null;
25716
26518
  /** @description Path to which the remark is attached; optional */
@@ -25907,7 +26709,7 @@ interface operations {
25907
26709
  * expected in a comma-separated list format as in the JSON encoding.
25908
26710
  * If not specified, all fields are returned.
25909
26711
  * Entity and parent IDs (like OrganizationID, SpaceID, RevisionID) and Slug are always returned regardless of the select parameter.
25910
- * Fields used in where and contains filters, and fields named by order_by, are also automatically included.
26712
+ * Fields used in where and contains filters, fields named by order_by, and fields read by the columns of the View named by view are also automatically included.
25911
26713
  * Example: 'DisplayName,CreatedAt,Labels' will return only those fields plus the required ID and Slug fields.
25912
26714
  * The whole string must be query-encoded.
25913
26715
  */
@@ -25922,6 +26724,16 @@ interface operations {
25922
26724
  * ConfigHub/YAML Units, which hold the configuration of entities, are hidden with the HiddenReason `BackingUnit`.
25923
26725
  */
25924
26726
  include_hidden?: string;
26727
+ /**
26728
+ * @description UUID of a View whose columns to compute for each Revision, returned as ViewColumns.
26729
+ *
26730
+ * The View must be in the same Organization as the user credentials, and be a View of Revision: its Of, or the From of its Filter, must be Revision.
26731
+ *
26732
+ * If the View has a Filter, the Filter selects the entities as the filter parameter does, so the two may not both be specified.
26733
+ *
26734
+ * The related entities and fields the View's columns read are included and selected automatically, so neither include nor select has to name them.
26735
+ */
26736
+ view?: string;
25925
26737
  /** @description Maximum number of Revision entities to return. If not specified, all matching entities are returned. Values greater than 1000 are rejected with 400. When there may be more entities, the response has a ConfigHub-Continue header to pass as the continue parameter of the next request. */
25926
26738
  limit?: number;
25927
26739
  /**
@@ -26128,7 +26940,7 @@ interface operations {
26128
26940
  * expected in a comma-separated list format as in the JSON encoding.
26129
26941
  * If not specified, all fields are returned.
26130
26942
  * Entity and parent IDs (like OrganizationID, SpaceID, RevisionID) and Slug are always returned regardless of the select parameter.
26131
- * Fields used in where and contains filters, and fields named by order_by, are also automatically included.
26943
+ * Fields used in where and contains filters, fields named by order_by, and fields read by the columns of the View named by view are also automatically included.
26132
26944
  * Example: 'DisplayName,CreatedAt,Labels' will return only those fields plus the required ID and Slug fields.
26133
26945
  * The whole string must be query-encoded.
26134
26946
  */
@@ -26349,7 +27161,7 @@ interface operations {
26349
27161
  * expected in a comma-separated list format as in the JSON encoding.
26350
27162
  * If not specified, all fields are returned.
26351
27163
  * Entity and parent IDs (like OrganizationID, SpaceID, RevisionID) and Slug are always returned regardless of the select parameter.
26352
- * Fields used in where and contains filters, and fields named by order_by, are also automatically included.
27164
+ * Fields used in where and contains filters, fields named by order_by, and fields read by the columns of the View named by view are also automatically included.
26353
27165
  * Example: 'DisplayName,CreatedAt,Labels' will return only those fields plus the required ID and Slug fields.
26354
27166
  * The whole string must be query-encoded.
26355
27167
  */
@@ -26568,7 +27380,7 @@ interface operations {
26568
27380
  * expected in a comma-separated list format as in the JSON encoding.
26569
27381
  * If not specified, all fields are returned.
26570
27382
  * Entity and parent IDs (like OrganizationID, SpaceID, ServiceAccountID) and Slug are always returned regardless of the select parameter.
26571
- * Fields used in where and contains filters, and fields named by order_by, are also automatically included.
27383
+ * Fields used in where and contains filters, fields named by order_by, and fields read by the columns of the View named by view are also automatically included.
26572
27384
  * Example: 'DisplayName,CreatedAt,Labels' will return only those fields plus the required ID and Slug fields.
26573
27385
  * The whole string must be query-encoded.
26574
27386
  */
@@ -26583,6 +27395,16 @@ interface operations {
26583
27395
  * ConfigHub/YAML Units, which hold the configuration of entities, are hidden with the HiddenReason `BackingUnit`.
26584
27396
  */
26585
27397
  include_hidden?: string;
27398
+ /**
27399
+ * @description UUID of a View whose columns to compute for each ServiceAccount, returned as ViewColumns.
27400
+ *
27401
+ * The View must be in the same Organization as the user credentials, and be a View of ServiceAccount: its Of, or the From of its Filter, must be ServiceAccount.
27402
+ *
27403
+ * If the View has a Filter, the Filter selects the entities as the filter parameter does, so the two may not both be specified.
27404
+ *
27405
+ * The related entities and fields the View's columns read are included and selected automatically, so neither include nor select has to name them.
27406
+ */
27407
+ view?: string;
26586
27408
  /** @description Maximum number of ServiceAccount entities to return. If not specified, all matching entities are returned. Values greater than 1000 are rejected with 400. When there may be more entities, the response has a ConfigHub-Continue header to pass as the continue parameter of the next request. */
26587
27409
  limit?: number;
26588
27410
  /**
@@ -26792,7 +27614,7 @@ interface operations {
26792
27614
  * expected in a comma-separated list format as in the JSON encoding.
26793
27615
  * If not specified, all fields are returned.
26794
27616
  * Entity and parent IDs (like OrganizationID, SpaceID, ServiceAccountID) and Slug are always returned regardless of the select parameter.
26795
- * Fields used in where and contains filters, and fields named by order_by, are also automatically included.
27617
+ * Fields used in where and contains filters, fields named by order_by, and fields read by the columns of the View named by view are also automatically included.
26796
27618
  * Example: 'DisplayName,CreatedAt,Labels' will return only those fields plus the required ID and Slug fields.
26797
27619
  * The whole string must be query-encoded.
26798
27620
  */
@@ -27803,7 +28625,7 @@ interface operations {
27803
28625
  * expected in a comma-separated list format as in the JSON encoding.
27804
28626
  * If not specified, all fields are returned.
27805
28627
  * Entity and parent IDs (like OrganizationID, SpaceID, SpaceID) and Slug are always returned regardless of the select parameter.
27806
- * Fields used in where and contains filters, and fields named by order_by, are also automatically included.
28628
+ * Fields used in where and contains filters, fields named by order_by, and fields read by the columns of the View named by view are also automatically included.
27807
28629
  * Example: 'DisplayName,CreatedAt,Labels' will return only those fields plus the required ID and Slug fields.
27808
28630
  * The whole string must be query-encoded.
27809
28631
  */
@@ -27818,6 +28640,16 @@ interface operations {
27818
28640
  * ConfigHub/YAML Units, which hold the configuration of entities, are hidden with the HiddenReason `BackingUnit`.
27819
28641
  */
27820
28642
  include_hidden?: string;
28643
+ /**
28644
+ * @description UUID of a View whose columns to compute for each Space, returned as ViewColumns.
28645
+ *
28646
+ * The View must be in the same Organization as the user credentials, and be a View of Space: its Of, or the From of its Filter, must be Space.
28647
+ *
28648
+ * If the View has a Filter, the Filter selects the entities as the filter parameter does, so the two may not both be specified.
28649
+ *
28650
+ * The related entities and fields the View's columns read are included and selected automatically, so neither include nor select has to name them.
28651
+ */
28652
+ view?: string;
27821
28653
  /** @description Maximum number of Space entities to return. If not specified, all matching entities are returned. Values greater than 1000 are rejected with 400. When there may be more entities, the response has a ConfigHub-Continue header to pass as the continue parameter of the next request. */
27822
28654
  limit?: number;
27823
28655
  /**
@@ -28033,7 +28865,7 @@ interface operations {
28033
28865
  * expected in a comma-separated list format as in the JSON encoding.
28034
28866
  * If not specified, all fields are returned.
28035
28867
  * Entity and parent IDs (like OrganizationID, SpaceID, SpaceID) and Slug are always returned regardless of the select parameter.
28036
- * Fields used in where and contains filters, and fields named by order_by, are also automatically included.
28868
+ * Fields used in where and contains filters, fields named by order_by, and fields read by the columns of the View named by view are also automatically included.
28037
28869
  * Example: 'DisplayName,CreatedAt,Labels' will return only those fields plus the required ID and Slug fields.
28038
28870
  * The whole string must be query-encoded.
28039
28871
  */
@@ -28532,7 +29364,7 @@ interface operations {
28532
29364
  * expected in a comma-separated list format as in the JSON encoding.
28533
29365
  * If not specified, all fields are returned.
28534
29366
  * Entity and parent IDs (like OrganizationID, SpaceID, AttestationID) and Slug are always returned regardless of the select parameter.
28535
- * Fields used in where and contains filters, and fields named by order_by, are also automatically included.
29367
+ * Fields used in where and contains filters, fields named by order_by, and fields read by the columns of the View named by view are also automatically included.
28536
29368
  * Example: 'DisplayName,CreatedAt,Labels' will return only those fields plus the required ID and Slug fields.
28537
29369
  * The whole string must be query-encoded.
28538
29370
  */
@@ -28547,6 +29379,16 @@ interface operations {
28547
29379
  * ConfigHub/YAML Units, which hold the configuration of entities, are hidden with the HiddenReason `BackingUnit`.
28548
29380
  */
28549
29381
  include_hidden?: string;
29382
+ /**
29383
+ * @description UUID of a View whose columns to compute for each Attestation, returned as ViewColumns.
29384
+ *
29385
+ * The View must be in the same Organization as the user credentials, and be a View of Attestation: its Of, or the From of its Filter, must be Attestation.
29386
+ *
29387
+ * If the View has a Filter, the Filter selects the entities as the filter parameter does, so the two may not both be specified.
29388
+ *
29389
+ * The related entities and fields the View's columns read are included and selected automatically, so neither include nor select has to name them.
29390
+ */
29391
+ view?: string;
28550
29392
  /** @description Maximum number of Attestation entities to return. If not specified, all matching entities are returned. Values greater than 1000 are rejected with 400. When there may be more entities, the response has a ConfigHub-Continue header to pass as the continue parameter of the next request. */
28551
29393
  limit?: number;
28552
29394
  /**
@@ -28760,7 +29602,7 @@ interface operations {
28760
29602
  * expected in a comma-separated list format as in the JSON encoding.
28761
29603
  * If not specified, all fields are returned.
28762
29604
  * Entity and parent IDs (like OrganizationID, SpaceID, AttestationID) and Slug are always returned regardless of the select parameter.
28763
- * Fields used in where and contains filters, and fields named by order_by, are also automatically included.
29605
+ * Fields used in where and contains filters, fields named by order_by, and fields read by the columns of the View named by view are also automatically included.
28764
29606
  * Example: 'DisplayName,CreatedAt,Labels' will return only those fields plus the required ID and Slug fields.
28765
29607
  * The whole string must be query-encoded.
28766
29608
  */
@@ -28933,7 +29775,7 @@ interface operations {
28933
29775
  * expected in a comma-separated list format as in the JSON encoding.
28934
29776
  * If not specified, all fields are returned.
28935
29777
  * Entity and parent IDs (like OrganizationID, SpaceID, AttributeID) and Slug are always returned regardless of the select parameter.
28936
- * Fields used in where and contains filters, and fields named by order_by, are also automatically included.
29778
+ * Fields used in where and contains filters, fields named by order_by, and fields read by the columns of the View named by view are also automatically included.
28937
29779
  * Example: 'DisplayName,CreatedAt,Labels' will return only those fields plus the required ID and Slug fields.
28938
29780
  * The whole string must be query-encoded.
28939
29781
  */
@@ -28948,6 +29790,16 @@ interface operations {
28948
29790
  * ConfigHub/YAML Units, which hold the configuration of entities, are hidden with the HiddenReason `BackingUnit`.
28949
29791
  */
28950
29792
  include_hidden?: string;
29793
+ /**
29794
+ * @description UUID of a View whose columns to compute for each Attribute, returned as ViewColumns.
29795
+ *
29796
+ * The View must be in the same Organization as the user credentials, and be a View of Attribute: its Of, or the From of its Filter, must be Attribute.
29797
+ *
29798
+ * If the View has a Filter, the Filter selects the entities as the filter parameter does, so the two may not both be specified.
29799
+ *
29800
+ * The related entities and fields the View's columns read are included and selected automatically, so neither include nor select has to name them.
29801
+ */
29802
+ view?: string;
28951
29803
  /** @description Maximum number of Attribute entities to return. If not specified, all matching entities are returned. Values greater than 1000 are rejected with 400. When there may be more entities, the response has a ConfigHub-Continue header to pass as the continue parameter of the next request. */
28952
29804
  limit?: number;
28953
29805
  /**
@@ -29170,7 +30022,7 @@ interface operations {
29170
30022
  * expected in a comma-separated list format as in the JSON encoding.
29171
30023
  * If not specified, all fields are returned.
29172
30024
  * Entity and parent IDs (like OrganizationID, SpaceID, AttributeID) and Slug are always returned regardless of the select parameter.
29173
- * Fields used in where and contains filters, and fields named by order_by, are also automatically included.
30025
+ * Fields used in where and contains filters, fields named by order_by, and fields read by the columns of the View named by view are also automatically included.
29174
30026
  * Example: 'DisplayName,CreatedAt,Labels' will return only those fields plus the required ID and Slug fields.
29175
30027
  * The whole string must be query-encoded.
29176
30028
  */
@@ -29848,7 +30700,7 @@ interface operations {
29848
30700
  * expected in a comma-separated list format as in the JSON encoding.
29849
30701
  * If not specified, all fields are returned.
29850
30702
  * Entity and parent IDs (like OrganizationID, SpaceID, BridgeWorkerID) and Slug are always returned regardless of the select parameter.
29851
- * Fields used in where and contains filters, and fields named by order_by, are also automatically included.
30703
+ * Fields used in where and contains filters, fields named by order_by, and fields read by the columns of the View named by view are also automatically included.
29852
30704
  * Example: 'DisplayName,CreatedAt,Labels' will return only those fields plus the required ID and Slug fields.
29853
30705
  * The whole string must be query-encoded.
29854
30706
  */
@@ -29863,6 +30715,16 @@ interface operations {
29863
30715
  * ConfigHub/YAML Units, which hold the configuration of entities, are hidden with the HiddenReason `BackingUnit`.
29864
30716
  */
29865
30717
  include_hidden?: string;
30718
+ /**
30719
+ * @description UUID of a View whose columns to compute for each BridgeWorker, returned as ViewColumns.
30720
+ *
30721
+ * The View must be in the same Organization as the user credentials, and be a View of BridgeWorker: its Of, or the From of its Filter, must be BridgeWorker.
30722
+ *
30723
+ * If the View has a Filter, the Filter selects the entities as the filter parameter does, so the two may not both be specified.
30724
+ *
30725
+ * The related entities and fields the View's columns read are included and selected automatically, so neither include nor select has to name them.
30726
+ */
30727
+ view?: string;
29866
30728
  /** @description Maximum number of BridgeWorker entities to return. If not specified, all matching entities are returned. Values greater than 1000 are rejected with 400. When there may be more entities, the response has a ConfigHub-Continue header to pass as the continue parameter of the next request. */
29867
30729
  limit?: number;
29868
30730
  /**
@@ -30087,7 +30949,7 @@ interface operations {
30087
30949
  * expected in a comma-separated list format as in the JSON encoding.
30088
30950
  * If not specified, all fields are returned.
30089
30951
  * Entity and parent IDs (like OrganizationID, SpaceID, BridgeWorkerID) and Slug are always returned regardless of the select parameter.
30090
- * Fields used in where and contains filters, and fields named by order_by, are also automatically included.
30952
+ * Fields used in where and contains filters, fields named by order_by, and fields read by the columns of the View named by view are also automatically included.
30091
30953
  * Example: 'DisplayName,CreatedAt,Labels' will return only those fields plus the required ID and Slug fields.
30092
30954
  * The whole string must be query-encoded.
30093
30955
  */
@@ -30783,7 +31645,7 @@ interface operations {
30783
31645
  * expected in a comma-separated list format as in the JSON encoding.
30784
31646
  * If not specified, all fields are returned.
30785
31647
  * Entity and parent IDs (like OrganizationID, SpaceID, ChangeOrderID) and Slug are always returned regardless of the select parameter.
30786
- * Fields used in where and contains filters, and fields named by order_by, are also automatically included.
31648
+ * Fields used in where and contains filters, fields named by order_by, and fields read by the columns of the View named by view are also automatically included.
30787
31649
  * Example: 'DisplayName,CreatedAt,Labels' will return only those fields plus the required ID and Slug fields.
30788
31650
  * The whole string must be query-encoded.
30789
31651
  */
@@ -30798,6 +31660,16 @@ interface operations {
30798
31660
  * ConfigHub/YAML Units, which hold the configuration of entities, are hidden with the HiddenReason `BackingUnit`.
30799
31661
  */
30800
31662
  include_hidden?: string;
31663
+ /**
31664
+ * @description UUID of a View whose columns to compute for each ChangeOrder, returned as ViewColumns.
31665
+ *
31666
+ * The View must be in the same Organization as the user credentials, and be a View of ChangeOrder: its Of, or the From of its Filter, must be ChangeOrder.
31667
+ *
31668
+ * If the View has a Filter, the Filter selects the entities as the filter parameter does, so the two may not both be specified.
31669
+ *
31670
+ * The related entities and fields the View's columns read are included and selected automatically, so neither include nor select has to name them.
31671
+ */
31672
+ view?: string;
30801
31673
  /** @description Maximum number of ChangeOrder entities to return. If not specified, all matching entities are returned. Values greater than 1000 are rejected with 400. When there may be more entities, the response has a ConfigHub-Continue header to pass as the continue parameter of the next request. */
30802
31674
  limit?: number;
30803
31675
  /**
@@ -31013,13 +31885,11 @@ interface operations {
31013
31885
  * expected in a comma-separated list format as in the JSON encoding.
31014
31886
  * If not specified, all fields are returned.
31015
31887
  * Entity and parent IDs (like OrganizationID, SpaceID, ChangeOrderID) and Slug are always returned regardless of the select parameter.
31016
- * Fields used in where and contains filters, and fields named by order_by, are also automatically included.
31888
+ * Fields used in where and contains filters, fields named by order_by, and fields read by the columns of the View named by view are also automatically included.
31017
31889
  * Example: 'DisplayName,CreatedAt,Labels' will return only those fields plus the required ID and Slug fields.
31018
31890
  * The whole string must be query-encoded.
31019
31891
  */
31020
31892
  select?: string;
31021
- /** @description If true, fill in ContainerImages: for each Space the ChangeOrder has landed in, the container images get-container-image finds at the Revisions its end Tag marks that differ from those at the Revisions its start Tag marks. */
31022
- container_images?: boolean;
31023
31893
  };
31024
31894
  header?: never;
31025
31895
  path: {
@@ -31526,7 +32396,7 @@ interface operations {
31526
32396
  * expected in a comma-separated list format as in the JSON encoding.
31527
32397
  * If not specified, all fields are returned.
31528
32398
  * Entity and parent IDs (like OrganizationID, SpaceID, ChangeSetID) and Slug are always returned regardless of the select parameter.
31529
- * Fields used in where and contains filters, and fields named by order_by, are also automatically included.
32399
+ * Fields used in where and contains filters, fields named by order_by, and fields read by the columns of the View named by view are also automatically included.
31530
32400
  * Example: 'DisplayName,CreatedAt,Labels' will return only those fields plus the required ID and Slug fields.
31531
32401
  * The whole string must be query-encoded.
31532
32402
  */
@@ -31541,6 +32411,16 @@ interface operations {
31541
32411
  * ConfigHub/YAML Units, which hold the configuration of entities, are hidden with the HiddenReason `BackingUnit`.
31542
32412
  */
31543
32413
  include_hidden?: string;
32414
+ /**
32415
+ * @description UUID of a View whose columns to compute for each ChangeSet, returned as ViewColumns.
32416
+ *
32417
+ * The View must be in the same Organization as the user credentials, and be a View of ChangeSet: its Of, or the From of its Filter, must be ChangeSet.
32418
+ *
32419
+ * If the View has a Filter, the Filter selects the entities as the filter parameter does, so the two may not both be specified.
32420
+ *
32421
+ * The related entities and fields the View's columns read are included and selected automatically, so neither include nor select has to name them.
32422
+ */
32423
+ view?: string;
31544
32424
  /** @description Maximum number of ChangeSet entities to return. If not specified, all matching entities are returned. Values greater than 1000 are rejected with 400. When there may be more entities, the response has a ConfigHub-Continue header to pass as the continue parameter of the next request. */
31545
32425
  limit?: number;
31546
32426
  /**
@@ -31756,7 +32636,7 @@ interface operations {
31756
32636
  * expected in a comma-separated list format as in the JSON encoding.
31757
32637
  * If not specified, all fields are returned.
31758
32638
  * Entity and parent IDs (like OrganizationID, SpaceID, ChangeSetID) and Slug are always returned regardless of the select parameter.
31759
- * Fields used in where and contains filters, and fields named by order_by, are also automatically included.
32639
+ * Fields used in where and contains filters, fields named by order_by, and fields read by the columns of the View named by view are also automatically included.
31760
32640
  * Example: 'DisplayName,CreatedAt,Labels' will return only those fields plus the required ID and Slug fields.
31761
32641
  * The whole string must be query-encoded.
31762
32642
  */
@@ -32244,7 +33124,7 @@ interface operations {
32244
33124
  * expected in a comma-separated list format as in the JSON encoding.
32245
33125
  * If not specified, all fields are returned.
32246
33126
  * Entity and parent IDs (like OrganizationID, SpaceID, ChangeWorkflowID) and Slug are always returned regardless of the select parameter.
32247
- * Fields used in where and contains filters, and fields named by order_by, are also automatically included.
33127
+ * Fields used in where and contains filters, fields named by order_by, and fields read by the columns of the View named by view are also automatically included.
32248
33128
  * Example: 'DisplayName,CreatedAt,Labels' will return only those fields plus the required ID and Slug fields.
32249
33129
  * The whole string must be query-encoded.
32250
33130
  */
@@ -32259,6 +33139,16 @@ interface operations {
32259
33139
  * ConfigHub/YAML Units, which hold the configuration of entities, are hidden with the HiddenReason `BackingUnit`.
32260
33140
  */
32261
33141
  include_hidden?: string;
33142
+ /**
33143
+ * @description UUID of a View whose columns to compute for each ChangeWorkflow, returned as ViewColumns.
33144
+ *
33145
+ * The View must be in the same Organization as the user credentials, and be a View of ChangeWorkflow: its Of, or the From of its Filter, must be ChangeWorkflow.
33146
+ *
33147
+ * If the View has a Filter, the Filter selects the entities as the filter parameter does, so the two may not both be specified.
33148
+ *
33149
+ * The related entities and fields the View's columns read are included and selected automatically, so neither include nor select has to name them.
33150
+ */
33151
+ view?: string;
32262
33152
  /** @description Maximum number of ChangeWorkflow entities to return. If not specified, all matching entities are returned. Values greater than 1000 are rejected with 400. When there may be more entities, the response has a ConfigHub-Continue header to pass as the continue parameter of the next request. */
32263
33153
  limit?: number;
32264
33154
  /**
@@ -32476,7 +33366,7 @@ interface operations {
32476
33366
  * expected in a comma-separated list format as in the JSON encoding.
32477
33367
  * If not specified, all fields are returned.
32478
33368
  * Entity and parent IDs (like OrganizationID, SpaceID, ChangeWorkflowID) and Slug are always returned regardless of the select parameter.
32479
- * Fields used in where and contains filters, and fields named by order_by, are also automatically included.
33369
+ * Fields used in where and contains filters, fields named by order_by, and fields read by the columns of the View named by view are also automatically included.
32480
33370
  * Example: 'DisplayName,CreatedAt,Labels' will return only those fields plus the required ID and Slug fields.
32481
33371
  * The whole string must be query-encoded.
32482
33372
  */
@@ -33089,7 +33979,7 @@ interface operations {
33089
33979
  * An example conjunction is:
33090
33980
  * `CreatedAt >= '2025-01-07' AND Slug = 'test' AND Labels.mykey = 'myvalue'`.
33091
33981
  *
33092
- * Supported attributes for filtering on Channel: Annotations, ChannelID, Commands, Condition, CreatedAt, DeleteGates, DisplayName, EventPosition, HiddenReason, IPAddress, Labels, LastMessage, LastSeenAt, OrganizationID, Permissions, Slug, SpaceID, Subscriptions, UpdatedAt.
33982
+ * Supported attributes for filtering on Channel: Annotations, BackingUnitID, ChannelID, Commands, Condition, CreatedAt, DeleteGates, DisplayName, EventPosition, HiddenReason, IPAddress, Labels, LastMessage, LastSeenAt, OrganizationID, Permissions, Slug, SpaceID, Subscriptions, UpdatedAt, UpstreamChannelID.
33093
33983
  *
33094
33984
  * The whole string must be query-encoded.
33095
33985
  */
@@ -33142,7 +34032,7 @@ interface operations {
33142
34032
  * expected in a comma-separated list format as in the JSON encoding.
33143
34033
  * If not specified, all fields are returned.
33144
34034
  * Entity and parent IDs (like OrganizationID, SpaceID, ChannelID) and Slug are always returned regardless of the select parameter.
33145
- * Fields used in where and contains filters, and fields named by order_by, are also automatically included.
34035
+ * Fields used in where and contains filters, fields named by order_by, and fields read by the columns of the View named by view are also automatically included.
33146
34036
  * Example: 'DisplayName,CreatedAt,Labels' will return only those fields plus the required ID and Slug fields.
33147
34037
  * The whole string must be query-encoded.
33148
34038
  */
@@ -33157,6 +34047,16 @@ interface operations {
33157
34047
  * ConfigHub/YAML Units, which hold the configuration of entities, are hidden with the HiddenReason `BackingUnit`.
33158
34048
  */
33159
34049
  include_hidden?: string;
34050
+ /**
34051
+ * @description UUID of a View whose columns to compute for each Channel, returned as ViewColumns.
34052
+ *
34053
+ * The View must be in the same Organization as the user credentials, and be a View of Channel: its Of, or the From of its Filter, must be Channel.
34054
+ *
34055
+ * If the View has a Filter, the Filter selects the entities as the filter parameter does, so the two may not both be specified.
34056
+ *
34057
+ * The related entities and fields the View's columns read are included and selected automatically, so neither include nor select has to name them.
34058
+ */
34059
+ view?: string;
33160
34060
  /** @description Maximum number of Channel entities to return. If not specified, all matching entities are returned. Values greater than 1000 are rejected with 400. When there may be more entities, the response has a ConfigHub-Continue header to pass as the continue parameter of the next request. */
33161
34061
  limit?: number;
33162
34062
  /**
@@ -33164,7 +34064,7 @@ interface operations {
33164
34064
  *
33165
34065
  * Field names are case-sensitive and PascalCase, as in the JSON encoding. Sort direction defaults to ASC when the 'DIRECTION:' prefix is omitted.
33166
34066
  *
33167
- * Supported attributes for ordering Channel: ChannelID, Condition, CreatedAt, DisplayName, EventPosition, HiddenReason, IPAddress, LastMessage, LastSeenAt, OrganizationID, Slug, SpaceID, UpdatedAt.
34067
+ * Supported attributes for ordering Channel: BackingUnitID, ChannelID, Condition, CreatedAt, DisplayName, EventPosition, HiddenReason, IPAddress, LastMessage, LastSeenAt, OrganizationID, Slug, SpaceID, UpdatedAt, UpstreamChannelID.
33168
34068
  *
33169
34069
  * Example: 'DESC:CreatedAt' or 'DisplayName,DESC:CreatedAt'.
33170
34070
  *
@@ -33261,6 +34161,8 @@ interface operations {
33261
34161
  CreateChannel: {
33262
34162
  parameters: {
33263
34163
  query?: {
34164
+ /** @description Give each Channel written a backing Unit if it has none: a ConfigHub/YAML Unit holding the Channel's configuration, which is then kept in step with it. */
34165
+ with_backing_units?: boolean;
33264
34166
  /** @description Allowed values are true and false. Default is false. When true, reports success when an entity already exists and returns the existing entity */
33265
34167
  allow_exists?: string;
33266
34168
  /** @description If true, report what the write would do without doing it: the write runs, including every check it makes, and is then rolled back. The response is the one the write would return, with the entities as they would be written. An entity a dry run creates is given an ID that the real create will not reuse. */
@@ -33372,7 +34274,7 @@ interface operations {
33372
34274
  * expected in a comma-separated list format as in the JSON encoding.
33373
34275
  * If not specified, all fields are returned.
33374
34276
  * Entity and parent IDs (like OrganizationID, SpaceID, ChannelID) and Slug are always returned regardless of the select parameter.
33375
- * Fields used in where and contains filters, and fields named by order_by, are also automatically included.
34277
+ * Fields used in where and contains filters, fields named by order_by, and fields read by the columns of the View named by view are also automatically included.
33376
34278
  * Example: 'DisplayName,CreatedAt,Labels' will return only those fields plus the required ID and Slug fields.
33377
34279
  * The whole string must be query-encoded.
33378
34280
  */
@@ -33454,7 +34356,199 @@ interface operations {
33454
34356
  };
33455
34357
  };
33456
34358
  };
33457
- UpdateChannel: {
34359
+ UpdateChannel: {
34360
+ parameters: {
34361
+ query?: {
34362
+ /** @description If true, report what the write would do without doing it: the write runs, including every check it makes, and is then rolled back. The response is the one the write would return, with the entities as they would be written. An entity a dry run creates is given an ID that the real create will not reuse. */
34363
+ dry_run?: boolean;
34364
+ };
34365
+ header?: never;
34366
+ path: {
34367
+ /** @description Unique identifier for a space_id */
34368
+ space_id: string;
34369
+ /** @description Unique identifier for a channel_id */
34370
+ channel_id: string;
34371
+ };
34372
+ cookie?: never;
34373
+ };
34374
+ requestBody?: {
34375
+ content: {
34376
+ "application/json": components["schemas"]["Channel"];
34377
+ };
34378
+ };
34379
+ responses: {
34380
+ /** @description A Channel is a mailbox between ConfigHub and one bot. A client claims it and polls it; callers run the commands it declares on it, each as a CommandRun; it subscribes to events and bookmarks how far it has read. It owns no identity: a ServiceAccount claims it by holding Claim on it. Its Commands and Subscriptions are set by whoever manages it, not by the client. */
34381
+ 200: {
34382
+ headers: {
34383
+ [name: string]: unknown;
34384
+ };
34385
+ content: {
34386
+ "application/json": components["schemas"]["Channel"];
34387
+ };
34388
+ };
34389
+ /** @description Channel request is invalid (Bad Request). */
34390
+ 400: {
34391
+ headers: {
34392
+ [name: string]: unknown;
34393
+ };
34394
+ content: {
34395
+ "application/json": components["schemas"]["StandardErrorResponse"];
34396
+ };
34397
+ };
34398
+ /** @description Unauthorized access. */
34399
+ 401: {
34400
+ headers: {
34401
+ [name: string]: unknown;
34402
+ };
34403
+ content: {
34404
+ "application/json": components["schemas"]["StandardErrorResponse"];
34405
+ };
34406
+ };
34407
+ /** @description Forbidden access. */
34408
+ 403: {
34409
+ headers: {
34410
+ [name: string]: unknown;
34411
+ };
34412
+ content: {
34413
+ "application/json": components["schemas"]["StandardErrorResponse"];
34414
+ };
34415
+ };
34416
+ /** @description Channel not found. */
34417
+ 404: {
34418
+ headers: {
34419
+ [name: string]: unknown;
34420
+ };
34421
+ content: {
34422
+ "application/json": components["schemas"]["StandardErrorResponse"];
34423
+ };
34424
+ };
34425
+ /** @description Channel data conflict. Data has changed since last read. */
34426
+ 409: {
34427
+ headers: {
34428
+ [name: string]: unknown;
34429
+ };
34430
+ content: {
34431
+ "application/json": components["schemas"]["StandardErrorResponse"];
34432
+ };
34433
+ };
34434
+ /** @description Something went wrong while processing Channel. */
34435
+ 500: {
34436
+ headers: {
34437
+ [name: string]: unknown;
34438
+ };
34439
+ content: {
34440
+ "application/json": components["schemas"]["StandardErrorResponse"];
34441
+ };
34442
+ };
34443
+ /** @description Unexpected error. */
34444
+ default: {
34445
+ headers: {
34446
+ [name: string]: unknown;
34447
+ };
34448
+ content: {
34449
+ "application/json": components["schemas"]["StandardErrorResponse"];
34450
+ };
34451
+ };
34452
+ };
34453
+ };
34454
+ DeleteChannel: {
34455
+ parameters: {
34456
+ query?: never;
34457
+ header?: never;
34458
+ path: {
34459
+ /** @description Unique identifier for a space_id */
34460
+ space_id: string;
34461
+ /** @description Unique identifier for a channel_id */
34462
+ channel_id: string;
34463
+ };
34464
+ cookie?: never;
34465
+ };
34466
+ requestBody?: never;
34467
+ responses: {
34468
+ /** @description Response for successful delete operation */
34469
+ 200: {
34470
+ headers: {
34471
+ [name: string]: unknown;
34472
+ };
34473
+ content: {
34474
+ "application/json": components["schemas"]["DeleteResponse"];
34475
+ };
34476
+ };
34477
+ /** @description Channel request is invalid (Bad Request). */
34478
+ 400: {
34479
+ headers: {
34480
+ [name: string]: unknown;
34481
+ };
34482
+ content: {
34483
+ "application/json": components["schemas"]["StandardErrorResponse"];
34484
+ };
34485
+ };
34486
+ /** @description Unauthorized access. */
34487
+ 401: {
34488
+ headers: {
34489
+ [name: string]: unknown;
34490
+ };
34491
+ content: {
34492
+ "application/json": components["schemas"]["StandardErrorResponse"];
34493
+ };
34494
+ };
34495
+ /** @description Forbidden access. */
34496
+ 403: {
34497
+ headers: {
34498
+ [name: string]: unknown;
34499
+ };
34500
+ content: {
34501
+ "application/json": components["schemas"]["StandardErrorResponse"];
34502
+ };
34503
+ };
34504
+ /** @description Channel not found. */
34505
+ 404: {
34506
+ headers: {
34507
+ [name: string]: unknown;
34508
+ };
34509
+ content: {
34510
+ "application/json": components["schemas"]["StandardErrorResponse"];
34511
+ };
34512
+ };
34513
+ /** @description Channel is still in use: it has DeleteGates, or other entities still reference it. Or data has changed since last read. */
34514
+ 409: {
34515
+ headers: {
34516
+ [name: string]: unknown;
34517
+ };
34518
+ content: {
34519
+ "application/json": components["schemas"]["StandardErrorResponse"];
34520
+ };
34521
+ };
34522
+ /** @description Channel could not be deleted. */
34523
+ 422: {
34524
+ headers: {
34525
+ [name: string]: unknown;
34526
+ };
34527
+ content: {
34528
+ "application/json": components["schemas"]["StandardErrorResponse"];
34529
+ };
34530
+ };
34531
+ /** @description Something went wrong while processing Channel. */
34532
+ 500: {
34533
+ headers: {
34534
+ [name: string]: unknown;
34535
+ };
34536
+ content: {
34537
+ "application/json": components["schemas"]["StandardErrorResponse"];
34538
+ };
34539
+ };
34540
+ /** @description Unexpected error. */
34541
+ default: {
34542
+ headers: {
34543
+ [name: string]: unknown;
34544
+ };
34545
+ content: {
34546
+ "application/json": components["schemas"]["StandardErrorResponse"];
34547
+ };
34548
+ };
34549
+ };
34550
+ };
34551
+ PatchChannel: {
33458
34552
  parameters: {
33459
34553
  query?: {
33460
34554
  /** @description If true, report what the write would do without doing it: the write runs, including every check it makes, and is then rolled back. The response is the one the write would return, with the entities as they would be written. An entity a dry run creates is given an ID that the real create will not reuse. */
@@ -33471,7 +34565,36 @@ interface operations {
33471
34565
  };
33472
34566
  requestBody?: {
33473
34567
  content: {
33474
- "application/json": components["schemas"]["Channel"];
34568
+ "application/merge-patch+json": {
34569
+ /** @description An optional map of Annotation key/value pairs for tools to attach information to entities. */
34570
+ Annotations?: {
34571
+ [key: string]: string | null;
34572
+ } | null;
34573
+ Commands?: {
34574
+ [key: string]: Record<string, never> | null;
34575
+ } | null;
34576
+ /** @description An optional set of gates that, if any is present, will block deletion */
34577
+ DeleteGates?: {
34578
+ [key: string]: boolean | null;
34579
+ } | null;
34580
+ /** @description Friendly name for the entity. */
34581
+ DisplayName?: string | null;
34582
+ EventPosition?: number | null;
34583
+ /** @description The reason the entity is hidden, if it is. A hidden entity is left out of List and Search results, and of what bulk operations act on, unless the include_hidden parameter names its reason or is *, or the where parameter names the entity by Slug or ID. ConfigHub/YAML Units are created hidden with the reason BackingUnit unless given another. */
34584
+ HiddenReason?: string | null;
34585
+ /** @description An optional map of Label key/value pairs to specify identifying attributes of entities for the purpose of grouping and filtering them. */
34586
+ Labels?: {
34587
+ [key: string]: string | null;
34588
+ } | null;
34589
+ Permissions?: {
34590
+ [key: string]: Record<string, never> | null;
34591
+ } | null;
34592
+ /** @description Unique URL-safe identifier for the entity. */
34593
+ Slug?: string | null;
34594
+ Subscriptions?: (Record<string, never> | null)[] | null;
34595
+ /** @description An entity-specific sequence number used for optimistic concurrency control. The value read must be sent in calls to Update. */
34596
+ Version?: number | null;
34597
+ };
33475
34598
  };
33476
34599
  };
33477
34600
  responses: {
@@ -33549,7 +34672,7 @@ interface operations {
33549
34672
  };
33550
34673
  };
33551
34674
  };
33552
- DeleteChannel: {
34675
+ ReportCommandRunResult: {
33553
34676
  parameters: {
33554
34677
  query?: never;
33555
34678
  header?: never;
@@ -33558,21 +34681,27 @@ interface operations {
33558
34681
  space_id: string;
33559
34682
  /** @description Unique identifier for a channel_id */
33560
34683
  channel_id: string;
34684
+ /** @description Unique identifier for a command_run_id */
34685
+ command_run_id: string;
33561
34686
  };
33562
34687
  cookie?: never;
33563
34688
  };
33564
- requestBody?: never;
34689
+ requestBody?: {
34690
+ content: {
34691
+ "application/json": components["schemas"]["CommandRunResult"];
34692
+ };
34693
+ };
33565
34694
  responses: {
33566
- /** @description Response for successful delete operation */
34695
+ /** @description CommandRun is one execution of a command on a Channel: the request, from the caller, and the outcome, from the channel's client. Create one at the Space, naming the command and optionally the Channel; without a Channel, the command is resolved to the one Channel in the Space that declares it. A Pending run waits for the client until its Deadline; a Delivered run has a fixed time to its outcome. */
33567
34696
  200: {
33568
34697
  headers: {
33569
34698
  [name: string]: unknown;
33570
34699
  };
33571
34700
  content: {
33572
- "application/json": components["schemas"]["DeleteResponse"];
34701
+ "application/json": components["schemas"]["CommandRun"];
33573
34702
  };
33574
34703
  };
33575
- /** @description Channel request is invalid (Bad Request). */
34704
+ /** @description CommandRun request is invalid (Bad Request). */
33576
34705
  400: {
33577
34706
  headers: {
33578
34707
  [name: string]: unknown;
@@ -33599,7 +34728,7 @@ interface operations {
33599
34728
  "application/json": components["schemas"]["StandardErrorResponse"];
33600
34729
  };
33601
34730
  };
33602
- /** @description Channel not found. */
34731
+ /** @description CommandRun not found. */
33603
34732
  404: {
33604
34733
  headers: {
33605
34734
  [name: string]: unknown;
@@ -33608,7 +34737,7 @@ interface operations {
33608
34737
  "application/json": components["schemas"]["StandardErrorResponse"];
33609
34738
  };
33610
34739
  };
33611
- /** @description Channel is still in use: it has DeleteGates, or other entities still reference it. Or data has changed since last read. */
34740
+ /** @description CommandRun data conflict. Data has changed since last read. */
33612
34741
  409: {
33613
34742
  headers: {
33614
34743
  [name: string]: unknown;
@@ -33617,16 +34746,7 @@ interface operations {
33617
34746
  "application/json": components["schemas"]["StandardErrorResponse"];
33618
34747
  };
33619
34748
  };
33620
- /** @description Channel could not be deleted. */
33621
- 422: {
33622
- headers: {
33623
- [name: string]: unknown;
33624
- };
33625
- content: {
33626
- "application/json": components["schemas"]["StandardErrorResponse"];
33627
- };
33628
- };
33629
- /** @description Something went wrong while processing Channel. */
34749
+ /** @description Something went wrong while processing CommandRun. */
33630
34750
  500: {
33631
34751
  headers: {
33632
34752
  [name: string]: unknown;
@@ -33646,12 +34766,9 @@ interface operations {
33646
34766
  };
33647
34767
  };
33648
34768
  };
33649
- PatchChannel: {
34769
+ GetChannelDocument: {
33650
34770
  parameters: {
33651
- query?: {
33652
- /** @description If true, report what the write would do without doing it: the write runs, including every check it makes, and is then rolled back. The response is the one the write would return, with the entities as they would be written. An entity a dry run creates is given an ID that the real create will not reuse. */
33653
- dry_run?: boolean;
33654
- };
34771
+ query?: never;
33655
34772
  header?: never;
33656
34773
  path: {
33657
34774
  /** @description Unique identifier for a space_id */
@@ -33661,48 +34778,15 @@ interface operations {
33661
34778
  };
33662
34779
  cookie?: never;
33663
34780
  };
33664
- requestBody?: {
33665
- content: {
33666
- "application/merge-patch+json": {
33667
- /** @description An optional map of Annotation key/value pairs for tools to attach information to entities. */
33668
- Annotations?: {
33669
- [key: string]: string | null;
33670
- } | null;
33671
- Commands?: {
33672
- [key: string]: Record<string, never> | null;
33673
- } | null;
33674
- /** @description An optional set of gates that, if any is present, will block deletion */
33675
- DeleteGates?: {
33676
- [key: string]: boolean | null;
33677
- } | null;
33678
- /** @description Friendly name for the entity. */
33679
- DisplayName?: string | null;
33680
- EventPosition?: number | null;
33681
- /** @description The reason the entity is hidden, if it is. A hidden entity is left out of List and Search results, and of what bulk operations act on, unless the include_hidden parameter names its reason or is *, or the where parameter names the entity by Slug or ID. ConfigHub/YAML Units are created hidden with the reason BackingUnit unless given another. */
33682
- HiddenReason?: string | null;
33683
- /** @description An optional map of Label key/value pairs to specify identifying attributes of entities for the purpose of grouping and filtering them. */
33684
- Labels?: {
33685
- [key: string]: string | null;
33686
- } | null;
33687
- Permissions?: {
33688
- [key: string]: Record<string, never> | null;
33689
- } | null;
33690
- /** @description Unique URL-safe identifier for the entity. */
33691
- Slug?: string | null;
33692
- Subscriptions?: (Record<string, never> | null)[] | null;
33693
- /** @description An entity-specific sequence number used for optimistic concurrency control. The value read must be sent in calls to Update. */
33694
- Version?: number | null;
33695
- };
33696
- };
33697
- };
34781
+ requestBody?: never;
33698
34782
  responses: {
33699
- /** @description A Channel is a mailbox between ConfigHub and one bot. A client claims it and polls it; callers run the commands it declares on it, each as a CommandRun; it subscribes to events and bookmarks how far it has read. It owns no identity: a ServiceAccount claims it by holding Claim on it. Its Commands and Subscriptions are set by whoever manages it, not by the client. */
34783
+ /** @description OK */
33700
34784
  200: {
33701
34785
  headers: {
33702
34786
  [name: string]: unknown;
33703
34787
  };
33704
34788
  content: {
33705
- "application/json": components["schemas"]["Channel"];
34789
+ "application/json": components["schemas"]["EntityDocument"];
33706
34790
  };
33707
34791
  };
33708
34792
  /** @description Channel request is invalid (Bad Request). */
@@ -33741,15 +34825,6 @@ interface operations {
33741
34825
  "application/json": components["schemas"]["StandardErrorResponse"];
33742
34826
  };
33743
34827
  };
33744
- /** @description Channel data conflict. Data has changed since last read. */
33745
- 409: {
33746
- headers: {
33747
- [name: string]: unknown;
33748
- };
33749
- content: {
33750
- "application/json": components["schemas"]["StandardErrorResponse"];
33751
- };
33752
- };
33753
34828
  /** @description Something went wrong while processing Channel. */
33754
34829
  500: {
33755
34830
  headers: {
@@ -33770,36 +34845,37 @@ interface operations {
33770
34845
  };
33771
34846
  };
33772
34847
  };
33773
- ReportCommandRunResult: {
34848
+ UpdateChannelDocument: {
33774
34849
  parameters: {
33775
- query?: never;
34850
+ query?: {
34851
+ /** @description If true, report what the write would do without doing it: the write runs, including every check it makes, and is then rolled back. The response is the one the write would return, with the entities as they would be written. An entity a dry run creates is given an ID that the real create will not reuse. */
34852
+ dry_run?: boolean;
34853
+ };
33776
34854
  header?: never;
33777
34855
  path: {
33778
34856
  /** @description Unique identifier for a space_id */
33779
34857
  space_id: string;
33780
34858
  /** @description Unique identifier for a channel_id */
33781
34859
  channel_id: string;
33782
- /** @description Unique identifier for a command_run_id */
33783
- command_run_id: string;
33784
34860
  };
33785
34861
  cookie?: never;
33786
34862
  };
33787
34863
  requestBody?: {
33788
34864
  content: {
33789
- "application/json": components["schemas"]["CommandRunResult"];
34865
+ "application/json": components["schemas"]["EntityDocumentEdit"];
33790
34866
  };
33791
34867
  };
33792
34868
  responses: {
33793
- /** @description CommandRun is one execution of a command on a Channel: the request, from the caller, and the outcome, from the channel's client. Create one at the Space, naming the command and optionally the Channel; without a Channel, the command is resolved to the one Channel in the Space that declares it. A Pending run waits for the client until its Deadline; a Delivered run has a fixed time to its outcome. */
34869
+ /** @description A Channel is a mailbox between ConfigHub and one bot. A client claims it and polls it; callers run the commands it declares on it, each as a CommandRun; it subscribes to events and bookmarks how far it has read. It owns no identity: a ServiceAccount claims it by holding Claim on it. Its Commands and Subscriptions are set by whoever manages it, not by the client. */
33794
34870
  200: {
33795
34871
  headers: {
33796
34872
  [name: string]: unknown;
33797
34873
  };
33798
34874
  content: {
33799
- "application/json": components["schemas"]["CommandRun"];
34875
+ "application/json": components["schemas"]["Channel"];
33800
34876
  };
33801
34877
  };
33802
- /** @description CommandRun request is invalid (Bad Request). */
34878
+ /** @description Channel request is invalid (Bad Request). */
33803
34879
  400: {
33804
34880
  headers: {
33805
34881
  [name: string]: unknown;
@@ -33826,7 +34902,7 @@ interface operations {
33826
34902
  "application/json": components["schemas"]["StandardErrorResponse"];
33827
34903
  };
33828
34904
  };
33829
- /** @description CommandRun not found. */
34905
+ /** @description Channel not found. */
33830
34906
  404: {
33831
34907
  headers: {
33832
34908
  [name: string]: unknown;
@@ -33835,7 +34911,7 @@ interface operations {
33835
34911
  "application/json": components["schemas"]["StandardErrorResponse"];
33836
34912
  };
33837
34913
  };
33838
- /** @description CommandRun data conflict. Data has changed since last read. */
34914
+ /** @description The Channel changed since the document was read. */
33839
34915
  409: {
33840
34916
  headers: {
33841
34917
  [name: string]: unknown;
@@ -33844,7 +34920,7 @@ interface operations {
33844
34920
  "application/json": components["schemas"]["StandardErrorResponse"];
33845
34921
  };
33846
34922
  };
33847
- /** @description Something went wrong while processing CommandRun. */
34923
+ /** @description Something went wrong while processing Channel. */
33848
34924
  500: {
33849
34925
  headers: {
33850
34926
  [name: string]: unknown;
@@ -34315,7 +35391,7 @@ interface operations {
34315
35391
  * expected in a comma-separated list format as in the JSON encoding.
34316
35392
  * If not specified, all fields are returned.
34317
35393
  * Entity and parent IDs (like OrganizationID, SpaceID, CommandRunID) and Slug are always returned regardless of the select parameter.
34318
- * Fields used in where and contains filters, and fields named by order_by, are also automatically included.
35394
+ * Fields used in where and contains filters, fields named by order_by, and fields read by the columns of the View named by view are also automatically included.
34319
35395
  * Example: 'DisplayName,CreatedAt,Labels' will return only those fields plus the required ID and Slug fields.
34320
35396
  * The whole string must be query-encoded.
34321
35397
  */
@@ -34327,7 +35403,7 @@ interface operations {
34327
35403
  *
34328
35404
  * Field names are case-sensitive and PascalCase, as in the JSON encoding. Sort direction defaults to ASC when the 'DIRECTION:' prefix is omitted.
34329
35405
  *
34330
- * Supported attributes for ordering CommandRun: ChannelID, Command, CommandRunID, CompletedAt, CreatedAt, CreatedBy, Deadline, DeliveredAt, OrganizationID, SpaceID, Status, TargetID, TimeoutAt, UnitID.
35406
+ * Supported attributes for ordering CommandRun: ChannelID, Command, CommandRunID, CompletedAt, CreatedAt, CreatedBy, Deadline, DeliveredAt, OrganizationID, Status, TargetID, TimeoutAt, UnitID.
34331
35407
  *
34332
35408
  * Example: 'DESC:CreatedAt' or 'DisplayName,DESC:CreatedAt'.
34333
35409
  *
@@ -34525,7 +35601,7 @@ interface operations {
34525
35601
  * expected in a comma-separated list format as in the JSON encoding.
34526
35602
  * If not specified, all fields are returned.
34527
35603
  * Entity and parent IDs (like OrganizationID, SpaceID, CommandRunID) and Slug are always returned regardless of the select parameter.
34528
- * Fields used in where and contains filters, and fields named by order_by, are also automatically included.
35604
+ * Fields used in where and contains filters, fields named by order_by, and fields read by the columns of the View named by view are also automatically included.
34529
35605
  * Example: 'DisplayName,CreatedAt,Labels' will return only those fields plus the required ID and Slug fields.
34530
35606
  * The whole string must be query-encoded.
34531
35607
  */
@@ -34956,7 +36032,7 @@ interface operations {
34956
36032
  * expected in a comma-separated list format as in the JSON encoding.
34957
36033
  * If not specified, all fields are returned.
34958
36034
  * Entity and parent IDs (like OrganizationID, SpaceID, FilterID) and Slug are always returned regardless of the select parameter.
34959
- * Fields used in where and contains filters, and fields named by order_by, are also automatically included.
36035
+ * Fields used in where and contains filters, fields named by order_by, and fields read by the columns of the View named by view are also automatically included.
34960
36036
  * Example: 'DisplayName,CreatedAt,Labels' will return only those fields plus the required ID and Slug fields.
34961
36037
  * The whole string must be query-encoded.
34962
36038
  */
@@ -34971,6 +36047,16 @@ interface operations {
34971
36047
  * ConfigHub/YAML Units, which hold the configuration of entities, are hidden with the HiddenReason `BackingUnit`.
34972
36048
  */
34973
36049
  include_hidden?: string;
36050
+ /**
36051
+ * @description UUID of a View whose columns to compute for each Filter, returned as ViewColumns.
36052
+ *
36053
+ * The View must be in the same Organization as the user credentials, and be a View of Filter: its Of, or the From of its Filter, must be Filter.
36054
+ *
36055
+ * If the View has a Filter, the Filter selects the entities as the filter parameter does, so the two may not both be specified.
36056
+ *
36057
+ * The related entities and fields the View's columns read are included and selected automatically, so neither include nor select has to name them.
36058
+ */
36059
+ view?: string;
34974
36060
  /** @description Maximum number of Filter entities to return. If not specified, all matching entities are returned. Values greater than 1000 are rejected with 400. When there may be more entities, the response has a ConfigHub-Continue header to pass as the continue parameter of the next request. */
34975
36061
  limit?: number;
34976
36062
  /**
@@ -35192,7 +36278,7 @@ interface operations {
35192
36278
  * expected in a comma-separated list format as in the JSON encoding.
35193
36279
  * If not specified, all fields are returned.
35194
36280
  * Entity and parent IDs (like OrganizationID, SpaceID, FilterID) and Slug are always returned regardless of the select parameter.
35195
- * Fields used in where and contains filters, and fields named by order_by, are also automatically included.
36281
+ * Fields used in where and contains filters, fields named by order_by, and fields read by the columns of the View named by view are also automatically included.
35196
36282
  * Example: 'DisplayName,CreatedAt,Labels' will return only those fields plus the required ID and Slug fields.
35197
36283
  * The whole string must be query-encoded.
35198
36284
  */
@@ -35999,7 +37085,7 @@ interface operations {
35999
37085
  trigger_filter?: string;
36000
37086
  /** @description When true, return units that pass trigger validation; when false (default), return units that fail. Only applies when where_trigger or trigger_filter is specified. */
36001
37087
  triggers_passed?: boolean;
36002
- /** @description View slug or UUID. Applies the View's column definitions to extract values for each unit. If the View has a FilterID, its filter is ANDed with other filters. The View must have Of=Unit or a Filter with From=Unit. */
37088
+ /** @description UUID of a View of Unit. Its Filter selects the Units as the filter parameter does, so the two may not both be specified. */
36003
37089
  view?: string;
36004
37090
  };
36005
37091
  header?: never;
@@ -36227,7 +37313,7 @@ interface operations {
36227
37313
  * expected in a comma-separated list format as in the JSON encoding.
36228
37314
  * If not specified, all fields are returned.
36229
37315
  * Entity and parent IDs (like OrganizationID, SpaceID, InvocationID) and Slug are always returned regardless of the select parameter.
36230
- * Fields used in where and contains filters, and fields named by order_by, are also automatically included.
37316
+ * Fields used in where and contains filters, fields named by order_by, and fields read by the columns of the View named by view are also automatically included.
36231
37317
  * Example: 'DisplayName,CreatedAt,Labels' will return only those fields plus the required ID and Slug fields.
36232
37318
  * The whole string must be query-encoded.
36233
37319
  */
@@ -36242,6 +37328,16 @@ interface operations {
36242
37328
  * ConfigHub/YAML Units, which hold the configuration of entities, are hidden with the HiddenReason `BackingUnit`.
36243
37329
  */
36244
37330
  include_hidden?: string;
37331
+ /**
37332
+ * @description UUID of a View whose columns to compute for each Invocation, returned as ViewColumns.
37333
+ *
37334
+ * The View must be in the same Organization as the user credentials, and be a View of Invocation: its Of, or the From of its Filter, must be Invocation.
37335
+ *
37336
+ * If the View has a Filter, the Filter selects the entities as the filter parameter does, so the two may not both be specified.
37337
+ *
37338
+ * The related entities and fields the View's columns read are included and selected automatically, so neither include nor select has to name them.
37339
+ */
37340
+ view?: string;
36245
37341
  /** @description Maximum number of Invocation entities to return. If not specified, all matching entities are returned. Values greater than 1000 are rejected with 400. When there may be more entities, the response has a ConfigHub-Continue header to pass as the continue parameter of the next request. */
36246
37342
  limit?: number;
36247
37343
  /**
@@ -36459,7 +37555,7 @@ interface operations {
36459
37555
  * expected in a comma-separated list format as in the JSON encoding.
36460
37556
  * If not specified, all fields are returned.
36461
37557
  * Entity and parent IDs (like OrganizationID, SpaceID, InvocationID) and Slug are always returned regardless of the select parameter.
36462
- * Fields used in where and contains filters, and fields named by order_by, are also automatically included.
37558
+ * Fields used in where and contains filters, fields named by order_by, and fields read by the columns of the View named by view are also automatically included.
36463
37559
  * Example: 'DisplayName,CreatedAt,Labels' will return only those fields plus the required ID and Slug fields.
36464
37560
  * The whole string must be query-encoded.
36465
37561
  */
@@ -37122,7 +38218,7 @@ interface operations {
37122
38218
  * expected in a comma-separated list format as in the JSON encoding.
37123
38219
  * If not specified, all fields are returned.
37124
38220
  * Entity and parent IDs (like OrganizationID, SpaceID, LinkID) and Slug are always returned regardless of the select parameter.
37125
- * Fields used in where and contains filters, and fields named by order_by, are also automatically included.
38221
+ * Fields used in where and contains filters, fields named by order_by, and fields read by the columns of the View named by view are also automatically included.
37126
38222
  * Example: 'DisplayName,CreatedAt,Labels' will return only those fields plus the required ID and Slug fields.
37127
38223
  * The whole string must be query-encoded.
37128
38224
  */
@@ -37137,6 +38233,16 @@ interface operations {
37137
38233
  * ConfigHub/YAML Units, which hold the configuration of entities, are hidden with the HiddenReason `BackingUnit`.
37138
38234
  */
37139
38235
  include_hidden?: string;
38236
+ /**
38237
+ * @description UUID of a View whose columns to compute for each Link, returned as ViewColumns.
38238
+ *
38239
+ * The View must be in the same Organization as the user credentials, and be a View of Link: its Of, or the From of its Filter, must be Link.
38240
+ *
38241
+ * If the View has a Filter, the Filter selects the entities as the filter parameter does, so the two may not both be specified.
38242
+ *
38243
+ * The related entities and fields the View's columns read are included and selected automatically, so neither include nor select has to name them.
38244
+ */
38245
+ view?: string;
37140
38246
  /** @description Maximum number of Link entities to return. If not specified, all matching entities are returned. Values greater than 1000 are rejected with 400. When there may be more entities, the response has a ConfigHub-Continue header to pass as the continue parameter of the next request. */
37141
38247
  limit?: number;
37142
38248
  /**
@@ -37359,7 +38465,7 @@ interface operations {
37359
38465
  * expected in a comma-separated list format as in the JSON encoding.
37360
38466
  * If not specified, all fields are returned.
37361
38467
  * Entity and parent IDs (like OrganizationID, SpaceID, LinkID) and Slug are always returned regardless of the select parameter.
37362
- * Fields used in where and contains filters, and fields named by order_by, are also automatically included.
38468
+ * Fields used in where and contains filters, fields named by order_by, and fields read by the columns of the View named by view are also automatically included.
37363
38469
  * Example: 'DisplayName,CreatedAt,Labels' will return only those fields plus the required ID and Slug fields.
37364
38470
  * The whole string must be query-encoded.
37365
38471
  */
@@ -38061,7 +39167,7 @@ interface operations {
38061
39167
  * expected in a comma-separated list format as in the JSON encoding.
38062
39168
  * If not specified, all fields are returned.
38063
39169
  * Entity and parent IDs (like OrganizationID, SpaceID, ReleaseID) and Slug are always returned regardless of the select parameter.
38064
- * Fields used in where and contains filters, and fields named by order_by, are also automatically included.
39170
+ * Fields used in where and contains filters, fields named by order_by, and fields read by the columns of the View named by view are also automatically included.
38065
39171
  * Example: 'DisplayName,CreatedAt,Labels' will return only those fields plus the required ID and Slug fields.
38066
39172
  * The whole string must be query-encoded.
38067
39173
  */
@@ -38076,6 +39182,16 @@ interface operations {
38076
39182
  * ConfigHub/YAML Units, which hold the configuration of entities, are hidden with the HiddenReason `BackingUnit`.
38077
39183
  */
38078
39184
  include_hidden?: string;
39185
+ /**
39186
+ * @description UUID of a View whose columns to compute for each Release, returned as ViewColumns.
39187
+ *
39188
+ * The View must be in the same Organization as the user credentials, and be a View of Release: its Of, or the From of its Filter, must be Release.
39189
+ *
39190
+ * If the View has a Filter, the Filter selects the entities as the filter parameter does, so the two may not both be specified.
39191
+ *
39192
+ * The related entities and fields the View's columns read are included and selected automatically, so neither include nor select has to name them.
39193
+ */
39194
+ view?: string;
38079
39195
  /** @description Maximum number of Release entities to return. If not specified, all matching entities are returned. Values greater than 1000 are rejected with 400. When there may be more entities, the response has a ConfigHub-Continue header to pass as the continue parameter of the next request. */
38080
39196
  limit?: number;
38081
39197
  /**
@@ -38295,7 +39411,7 @@ interface operations {
38295
39411
  * expected in a comma-separated list format as in the JSON encoding.
38296
39412
  * If not specified, all fields are returned.
38297
39413
  * Entity and parent IDs (like OrganizationID, SpaceID, ReleaseID) and Slug are always returned regardless of the select parameter.
38298
- * Fields used in where and contains filters, and fields named by order_by, are also automatically included.
39414
+ * Fields used in where and contains filters, fields named by order_by, and fields read by the columns of the View named by view are also automatically included.
38299
39415
  * Example: 'DisplayName,CreatedAt,Labels' will return only those fields plus the required ID and Slug fields.
38300
39416
  * The whole string must be query-encoded.
38301
39417
  */
@@ -38955,7 +40071,7 @@ interface operations {
38955
40071
  * expected in a comma-separated list format as in the JSON encoding.
38956
40072
  * If not specified, all fields are returned.
38957
40073
  * Entity and parent IDs (like OrganizationID, SpaceID, TagID) and Slug are always returned regardless of the select parameter.
38958
- * Fields used in where and contains filters, and fields named by order_by, are also automatically included.
40074
+ * Fields used in where and contains filters, fields named by order_by, and fields read by the columns of the View named by view are also automatically included.
38959
40075
  * Example: 'DisplayName,CreatedAt,Labels' will return only those fields plus the required ID and Slug fields.
38960
40076
  * The whole string must be query-encoded.
38961
40077
  */
@@ -38970,6 +40086,16 @@ interface operations {
38970
40086
  * ConfigHub/YAML Units, which hold the configuration of entities, are hidden with the HiddenReason `BackingUnit`.
38971
40087
  */
38972
40088
  include_hidden?: string;
40089
+ /**
40090
+ * @description UUID of a View whose columns to compute for each Tag, returned as ViewColumns.
40091
+ *
40092
+ * The View must be in the same Organization as the user credentials, and be a View of Tag: its Of, or the From of its Filter, must be Tag.
40093
+ *
40094
+ * If the View has a Filter, the Filter selects the entities as the filter parameter does, so the two may not both be specified.
40095
+ *
40096
+ * The related entities and fields the View's columns read are included and selected automatically, so neither include nor select has to name them.
40097
+ */
40098
+ view?: string;
38973
40099
  /** @description Maximum number of Tag entities to return. If not specified, all matching entities are returned. Values greater than 1000 are rejected with 400. When there may be more entities, the response has a ConfigHub-Continue header to pass as the continue parameter of the next request. */
38974
40100
  limit?: number;
38975
40101
  /**
@@ -39185,7 +40311,7 @@ interface operations {
39185
40311
  * expected in a comma-separated list format as in the JSON encoding.
39186
40312
  * If not specified, all fields are returned.
39187
40313
  * Entity and parent IDs (like OrganizationID, SpaceID, TagID) and Slug are always returned regardless of the select parameter.
39188
- * Fields used in where and contains filters, and fields named by order_by, are also automatically included.
40314
+ * Fields used in where and contains filters, fields named by order_by, and fields read by the columns of the View named by view are also automatically included.
39189
40315
  * Example: 'DisplayName,CreatedAt,Labels' will return only those fields plus the required ID and Slug fields.
39190
40316
  * The whole string must be query-encoded.
39191
40317
  */
@@ -39672,7 +40798,7 @@ interface operations {
39672
40798
  * expected in a comma-separated list format as in the JSON encoding.
39673
40799
  * If not specified, all fields are returned.
39674
40800
  * Entity and parent IDs (like OrganizationID, SpaceID, TargetID) and Slug are always returned regardless of the select parameter.
39675
- * Fields used in where and contains filters, and fields named by order_by, are also automatically included.
40801
+ * Fields used in where and contains filters, fields named by order_by, and fields read by the columns of the View named by view are also automatically included.
39676
40802
  * Example: 'DisplayName,CreatedAt,Labels' will return only those fields plus the required ID and Slug fields.
39677
40803
  * The whole string must be query-encoded.
39678
40804
  */
@@ -39687,6 +40813,16 @@ interface operations {
39687
40813
  * ConfigHub/YAML Units, which hold the configuration of entities, are hidden with the HiddenReason `BackingUnit`.
39688
40814
  */
39689
40815
  include_hidden?: string;
40816
+ /**
40817
+ * @description UUID of a View whose columns to compute for each Target, returned as ViewColumns.
40818
+ *
40819
+ * The View must be in the same Organization as the user credentials, and be a View of Target: its Of, or the From of its Filter, must be Target.
40820
+ *
40821
+ * If the View has a Filter, the Filter selects the entities as the filter parameter does, so the two may not both be specified.
40822
+ *
40823
+ * The related entities and fields the View's columns read are included and selected automatically, so neither include nor select has to name them.
40824
+ */
40825
+ view?: string;
39690
40826
  /** @description Maximum number of Target entities to return. If not specified, all matching entities are returned. Values greater than 1000 are rejected with 400. When there may be more entities, the response has a ConfigHub-Continue header to pass as the continue parameter of the next request. */
39691
40827
  limit?: number;
39692
40828
  /**
@@ -39904,7 +41040,7 @@ interface operations {
39904
41040
  * expected in a comma-separated list format as in the JSON encoding.
39905
41041
  * If not specified, all fields are returned.
39906
41042
  * Entity and parent IDs (like OrganizationID, SpaceID, TargetID) and Slug are always returned regardless of the select parameter.
39907
- * Fields used in where and contains filters, and fields named by order_by, are also automatically included.
41043
+ * Fields used in where and contains filters, fields named by order_by, and fields read by the columns of the View named by view are also automatically included.
39908
41044
  * Example: 'DisplayName,CreatedAt,Labels' will return only those fields plus the required ID and Slug fields.
39909
41045
  * The whole string must be query-encoded.
39910
41046
  */
@@ -40577,7 +41713,7 @@ interface operations {
40577
41713
  * expected in a comma-separated list format as in the JSON encoding.
40578
41714
  * If not specified, all fields are returned.
40579
41715
  * Entity and parent IDs (like OrganizationID, SpaceID, TriggerID) and Slug are always returned regardless of the select parameter.
40580
- * Fields used in where and contains filters, and fields named by order_by, are also automatically included.
41716
+ * Fields used in where and contains filters, fields named by order_by, and fields read by the columns of the View named by view are also automatically included.
40581
41717
  * Example: 'DisplayName,CreatedAt,Labels' will return only those fields plus the required ID and Slug fields.
40582
41718
  * The whole string must be query-encoded.
40583
41719
  */
@@ -40592,6 +41728,16 @@ interface operations {
40592
41728
  * ConfigHub/YAML Units, which hold the configuration of entities, are hidden with the HiddenReason `BackingUnit`.
40593
41729
  */
40594
41730
  include_hidden?: string;
41731
+ /**
41732
+ * @description UUID of a View whose columns to compute for each Trigger, returned as ViewColumns.
41733
+ *
41734
+ * The View must be in the same Organization as the user credentials, and be a View of Trigger: its Of, or the From of its Filter, must be Trigger.
41735
+ *
41736
+ * If the View has a Filter, the Filter selects the entities as the filter parameter does, so the two may not both be specified.
41737
+ *
41738
+ * The related entities and fields the View's columns read are included and selected automatically, so neither include nor select has to name them.
41739
+ */
41740
+ view?: string;
40595
41741
  /** @description Maximum number of Trigger entities to return. If not specified, all matching entities are returned. Values greater than 1000 are rejected with 400. When there may be more entities, the response has a ConfigHub-Continue header to pass as the continue parameter of the next request. */
40596
41742
  limit?: number;
40597
41743
  /**
@@ -40819,7 +41965,7 @@ interface operations {
40819
41965
  * expected in a comma-separated list format as in the JSON encoding.
40820
41966
  * If not specified, all fields are returned.
40821
41967
  * Entity and parent IDs (like OrganizationID, SpaceID, TriggerID) and Slug are always returned regardless of the select parameter.
40822
- * Fields used in where and contains filters, and fields named by order_by, are also automatically included.
41968
+ * Fields used in where and contains filters, fields named by order_by, and fields read by the columns of the View named by view are also automatically included.
40823
41969
  * Example: 'DisplayName,CreatedAt,Labels' will return only those fields plus the required ID and Slug fields.
40824
41970
  * The whole string must be query-encoded.
40825
41971
  */
@@ -41535,7 +42681,7 @@ interface operations {
41535
42681
  * expected in a comma-separated list format as in the JSON encoding.
41536
42682
  * If not specified, all fields are returned.
41537
42683
  * Entity and parent IDs (like OrganizationID, SpaceID, UnitID) and Slug are always returned regardless of the select parameter.
41538
- * Fields used in where and contains filters, and fields named by order_by, are also automatically included.
42684
+ * Fields used in where and contains filters, fields named by order_by, and fields read by the columns of the View named by view are also automatically included.
41539
42685
  * Example: 'DisplayName,CreatedAt,Labels' will return only those fields plus the required ID and Slug fields.
41540
42686
  * The whole string must be query-encoded.
41541
42687
  */
@@ -41550,6 +42696,16 @@ interface operations {
41550
42696
  * ConfigHub/YAML Units, which hold the configuration of entities, are hidden with the HiddenReason `BackingUnit`.
41551
42697
  */
41552
42698
  include_hidden?: string;
42699
+ /**
42700
+ * @description UUID of a View whose columns to compute for each Unit, returned as ViewColumns.
42701
+ *
42702
+ * The View must be in the same Organization as the user credentials, and be a View of Unit: its Of, or the From of its Filter, must be Unit.
42703
+ *
42704
+ * If the View has a Filter, the Filter selects the entities as the filter parameter does, so the two may not both be specified.
42705
+ *
42706
+ * The related entities and fields the View's columns read are included and selected automatically, so neither include nor select has to name them.
42707
+ */
42708
+ view?: string;
41553
42709
  /** @description Maximum number of Unit entities to return. If not specified, all matching entities are returned. Values greater than 1000 are rejected with 400. When there may be more entities, the response has a ConfigHub-Continue header to pass as the continue parameter of the next request. */
41554
42710
  limit?: number;
41555
42711
  /**
@@ -41586,8 +42742,6 @@ interface operations {
41586
42742
  trigger_filter?: string;
41587
42743
  /** @description When true, return units that pass trigger validation; when false (default), return units that fail. Only applies when where_trigger or trigger_filter is specified. */
41588
42744
  triggers_passed?: boolean;
41589
- /** @description View slug or UUID. Applies the View's column definitions to extract values for each unit. If the View has a FilterID, its filter is ANDed with other filters. The View must have Of=Unit or a Filter with From=Unit. */
41590
- view?: string;
41591
42745
  };
41592
42746
  header?: never;
41593
42747
  path: {
@@ -41804,7 +42958,7 @@ interface operations {
41804
42958
  * expected in a comma-separated list format as in the JSON encoding.
41805
42959
  * If not specified, all fields are returned.
41806
42960
  * Entity and parent IDs (like OrganizationID, SpaceID, UnitID) and Slug are always returned regardless of the select parameter.
41807
- * Fields used in where and contains filters, and fields named by order_by, are also automatically included.
42961
+ * Fields used in where and contains filters, fields named by order_by, and fields read by the columns of the View named by view are also automatically included.
41808
42962
  * Example: 'DisplayName,CreatedAt,Labels' will return only those fields plus the required ID and Slug fields.
41809
42963
  * The whole string must be query-encoded.
41810
42964
  */
@@ -43014,7 +44168,7 @@ interface operations {
43014
44168
  * expected in a comma-separated list format as in the JSON encoding.
43015
44169
  * If not specified, all fields are returned.
43016
44170
  * Entity and parent IDs (like OrganizationID, SpaceID, MutationID) and Slug are always returned regardless of the select parameter.
43017
- * Fields used in where and contains filters, and fields named by order_by, are also automatically included.
44171
+ * Fields used in where and contains filters, fields named by order_by, and fields read by the columns of the View named by view are also automatically included.
43018
44172
  * Example: 'DisplayName,CreatedAt,Labels' will return only those fields plus the required ID and Slug fields.
43019
44173
  * The whole string must be query-encoded.
43020
44174
  */
@@ -43029,6 +44183,16 @@ interface operations {
43029
44183
  * ConfigHub/YAML Units, which hold the configuration of entities, are hidden with the HiddenReason `BackingUnit`.
43030
44184
  */
43031
44185
  include_hidden?: string;
44186
+ /**
44187
+ * @description UUID of a View whose columns to compute for each Mutation, returned as ViewColumns.
44188
+ *
44189
+ * The View must be in the same Organization as the user credentials, and be a View of Mutation: its Of, or the From of its Filter, must be Mutation.
44190
+ *
44191
+ * If the View has a Filter, the Filter selects the entities as the filter parameter does, so the two may not both be specified.
44192
+ *
44193
+ * The related entities and fields the View's columns read are included and selected automatically, so neither include nor select has to name them.
44194
+ */
44195
+ view?: string;
43032
44196
  /** @description Maximum number of Mutation entities to return. If not specified, all matching entities are returned. Values greater than 1000 are rejected with 400. When there may be more entities, the response has a ConfigHub-Continue header to pass as the continue parameter of the next request. */
43033
44197
  limit?: number;
43034
44198
  /**
@@ -43151,7 +44315,7 @@ interface operations {
43151
44315
  * expected in a comma-separated list format as in the JSON encoding.
43152
44316
  * If not specified, all fields are returned.
43153
44317
  * Entity and parent IDs (like OrganizationID, SpaceID, MutationID) and Slug are always returned regardless of the select parameter.
43154
- * Fields used in where and contains filters, and fields named by order_by, are also automatically included.
44318
+ * Fields used in where and contains filters, fields named by order_by, and fields read by the columns of the View named by view are also automatically included.
43155
44319
  * Example: 'DisplayName,CreatedAt,Labels' will return only those fields plus the required ID and Slug fields.
43156
44320
  * The whole string must be query-encoded.
43157
44321
  */
@@ -43499,7 +44663,7 @@ interface operations {
43499
44663
  * expected in a comma-separated list format as in the JSON encoding.
43500
44664
  * If not specified, all fields are returned.
43501
44665
  * Entity and parent IDs (like OrganizationID, SpaceID, ResourceID) and Slug are always returned regardless of the select parameter.
43502
- * Fields used in where and contains filters, and fields named by order_by, are also automatically included.
44666
+ * Fields used in where and contains filters, fields named by order_by, and fields read by the columns of the View named by view are also automatically included.
43503
44667
  * Example: 'DisplayName,CreatedAt,Labels' will return only those fields plus the required ID and Slug fields.
43504
44668
  * The whole string must be query-encoded.
43505
44669
  */
@@ -43514,6 +44678,16 @@ interface operations {
43514
44678
  * ConfigHub/YAML Units, which hold the configuration of entities, are hidden with the HiddenReason `BackingUnit`.
43515
44679
  */
43516
44680
  include_hidden?: string;
44681
+ /**
44682
+ * @description UUID of a View whose columns to compute for each Resource, returned as ViewColumns.
44683
+ *
44684
+ * The View must be in the same Organization as the user credentials, and be a View of Resource: its Of, or the From of its Filter, must be Resource.
44685
+ *
44686
+ * If the View has a Filter, the Filter selects the entities as the filter parameter does, so the two may not both be specified.
44687
+ *
44688
+ * The related entities and fields the View's columns read are included and selected automatically, so neither include nor select has to name them.
44689
+ */
44690
+ view?: string;
43517
44691
  /** @description Maximum number of Resource entities to return. If not specified, all matching entities are returned. Values greater than 1000 are rejected with 400. When there may be more entities, the response has a ConfigHub-Continue header to pass as the continue parameter of the next request. */
43518
44692
  limit?: number;
43519
44693
  /**
@@ -43543,8 +44717,6 @@ interface operations {
43543
44717
  * @description Deprecated: use continue. Number of Resource entities to skip before returning results. Cannot be combined with continue.
43544
44718
  */
43545
44719
  offset?: number;
43546
- /** @description UUID of a View whose columns to extract for each resource, returned as ViewColumns. DataPath columns are read from the stored JSON rather than by invoking a function. */
43547
- view?: string;
43548
44720
  /** @description Return each resource's configuration in its original toolchain-native form, as RawData on the response envelope. Off by default: the bodies are bulk, and a table view needs only the queryable Data projection. */
43549
44721
  raw_data?: boolean;
43550
44722
  };
@@ -43645,13 +44817,11 @@ interface operations {
43645
44817
  * expected in a comma-separated list format as in the JSON encoding.
43646
44818
  * If not specified, all fields are returned.
43647
44819
  * Entity and parent IDs (like OrganizationID, SpaceID, ResourceID) and Slug are always returned regardless of the select parameter.
43648
- * Fields used in where and contains filters, and fields named by order_by, are also automatically included.
44820
+ * Fields used in where and contains filters, fields named by order_by, and fields read by the columns of the View named by view are also automatically included.
43649
44821
  * Example: 'DisplayName,CreatedAt,Labels' will return only those fields plus the required ID and Slug fields.
43650
44822
  * The whole string must be query-encoded.
43651
44823
  */
43652
44824
  select?: string;
43653
- /** @description UUID of a View whose columns to extract for each resource, returned as ViewColumns. DataPath columns are read from the stored JSON rather than by invoking a function. */
43654
- view?: string;
43655
44825
  /** @description Return each resource's configuration in its original toolchain-native form, as RawData on the response envelope. Off by default: the bodies are bulk, and a table view needs only the queryable Data projection. */
43656
44826
  raw_data?: boolean;
43657
44827
  };
@@ -43771,7 +44941,7 @@ interface operations {
43771
44941
  * An example conjunction is:
43772
44942
  * `CreatedAt >= '2025-01-07' AND Slug = 'test' AND Labels.mykey = 'myvalue'`.
43773
44943
  *
43774
- * Supported attributes for filtering on ReviewComment: CreatedAt, HiddenReason, OrganizationID, Path, ReplyToID, ReviewCommentID, RevisionID, RevisionNum, SpaceID, Text, UnitID, UpdatedAt, UserAgent, UserID.
44944
+ * Supported attributes for filtering on ReviewComment: ChangeOrderID, CreatedAt, HiddenReason, OrganizationID, Path, ReplyToID, ReviewCommentID, RevisionID, RevisionNum, SpaceID, Text, UnitID, UpdatedAt, UserAgent, UserID.
43775
44945
  *
43776
44946
  * The whole string must be query-encoded.
43777
44947
  */
@@ -43813,7 +44983,7 @@ interface operations {
43813
44983
  * The attribute names are case-sensitive, PascalCase, and
43814
44984
  * expected in a comma-separated list format as in the JSON encoding.
43815
44985
  *
43816
- * Supported attributes for ReviewComment are OrganizationID, RevisionID, SpaceID, UnitID.
44986
+ * Supported attributes for ReviewComment are ChangeOrderID, OrganizationID, RevisionID, SpaceID, UnitID.
43817
44987
  *
43818
44988
  * The whole string must be query-encoded.
43819
44989
  */
@@ -43824,7 +44994,7 @@ interface operations {
43824
44994
  * expected in a comma-separated list format as in the JSON encoding.
43825
44995
  * If not specified, all fields are returned.
43826
44996
  * Entity and parent IDs (like OrganizationID, SpaceID, ReviewCommentID) and Slug are always returned regardless of the select parameter.
43827
- * Fields used in where and contains filters, and fields named by order_by, are also automatically included.
44997
+ * Fields used in where and contains filters, fields named by order_by, and fields read by the columns of the View named by view are also automatically included.
43828
44998
  * Example: 'DisplayName,CreatedAt,Labels' will return only those fields plus the required ID and Slug fields.
43829
44999
  * The whole string must be query-encoded.
43830
45000
  */
@@ -43839,6 +45009,16 @@ interface operations {
43839
45009
  * ConfigHub/YAML Units, which hold the configuration of entities, are hidden with the HiddenReason `BackingUnit`.
43840
45010
  */
43841
45011
  include_hidden?: string;
45012
+ /**
45013
+ * @description UUID of a View whose columns to compute for each ReviewComment, returned as ViewColumns.
45014
+ *
45015
+ * The View must be in the same Organization as the user credentials, and be a View of ReviewComment: its Of, or the From of its Filter, must be ReviewComment.
45016
+ *
45017
+ * If the View has a Filter, the Filter selects the entities as the filter parameter does, so the two may not both be specified.
45018
+ *
45019
+ * The related entities and fields the View's columns read are included and selected automatically, so neither include nor select has to name them.
45020
+ */
45021
+ view?: string;
43842
45022
  /** @description Maximum number of ReviewComment entities to return. If not specified, all matching entities are returned. Values greater than 1000 are rejected with 400. When there may be more entities, the response has a ConfigHub-Continue header to pass as the continue parameter of the next request. */
43843
45023
  limit?: number;
43844
45024
  /**
@@ -43846,7 +45026,7 @@ interface operations {
43846
45026
  *
43847
45027
  * Field names are case-sensitive and PascalCase, as in the JSON encoding. Sort direction defaults to ASC when the 'DIRECTION:' prefix is omitted.
43848
45028
  *
43849
- * Supported attributes for ordering ReviewComment: CreatedAt, HiddenReason, OrganizationID, Path, ReplyToID, ReviewCommentID, RevisionID, RevisionNum, Text, UnitID, UpdatedAt, UserAgent, UserID.
45029
+ * Supported attributes for ordering ReviewComment: ChangeOrderID, CreatedAt, HiddenReason, OrganizationID, Path, ReplyToID, ReviewCommentID, RevisionID, RevisionNum, Text, UnitID, UpdatedAt, UserAgent, UserID.
43850
45030
  *
43851
45031
  * Example: 'DESC:CreatedAt' or 'DisplayName,DESC:CreatedAt'.
43852
45032
  *
@@ -44045,7 +45225,7 @@ interface operations {
44045
45225
  * The attribute names are case-sensitive, PascalCase, and
44046
45226
  * expected in a comma-separated list format as in the JSON encoding.
44047
45227
  *
44048
- * Supported attributes for ReviewComment are OrganizationID, RevisionID, SpaceID, UnitID.
45228
+ * Supported attributes for ReviewComment are ChangeOrderID, OrganizationID, RevisionID, SpaceID, UnitID.
44049
45229
  *
44050
45230
  * The whole string must be query-encoded.
44051
45231
  */
@@ -44056,7 +45236,7 @@ interface operations {
44056
45236
  * expected in a comma-separated list format as in the JSON encoding.
44057
45237
  * If not specified, all fields are returned.
44058
45238
  * Entity and parent IDs (like OrganizationID, SpaceID, ReviewCommentID) and Slug are always returned regardless of the select parameter.
44059
- * Fields used in where and contains filters, and fields named by order_by, are also automatically included.
45239
+ * Fields used in where and contains filters, fields named by order_by, and fields read by the columns of the View named by view are also automatically included.
44060
45240
  * Example: 'DisplayName,CreatedAt,Labels' will return only those fields plus the required ID and Slug fields.
44061
45241
  * The whole string must be query-encoded.
44062
45242
  */
@@ -44356,6 +45536,8 @@ interface operations {
44356
45536
  requestBody?: {
44357
45537
  content: {
44358
45538
  "application/merge-patch+json": {
45539
+ /** Format: uuid */
45540
+ ChangeOrderID?: string | null;
44359
45541
  /** @description The reason the entity is hidden, if it is. A hidden entity is left out of List and Search results, and of what bulk operations act on, unless the include_hidden parameter names its reason or is *, or the where parameter names the entity by Slug or ID. ConfigHub/YAML Units are created hidden with the reason BackingUnit unless given another. */
44360
45542
  HiddenReason?: string | null;
44361
45543
  /** @description Path to which the remark is attached; optional */
@@ -44541,7 +45723,7 @@ interface operations {
44541
45723
  * expected in a comma-separated list format as in the JSON encoding.
44542
45724
  * If not specified, all fields are returned.
44543
45725
  * Entity and parent IDs (like OrganizationID, SpaceID, RevisionID) and Slug are always returned regardless of the select parameter.
44544
- * Fields used in where and contains filters, and fields named by order_by, are also automatically included.
45726
+ * Fields used in where and contains filters, fields named by order_by, and fields read by the columns of the View named by view are also automatically included.
44545
45727
  * Example: 'DisplayName,CreatedAt,Labels' will return only those fields plus the required ID and Slug fields.
44546
45728
  * The whole string must be query-encoded.
44547
45729
  */
@@ -44556,6 +45738,16 @@ interface operations {
44556
45738
  * ConfigHub/YAML Units, which hold the configuration of entities, are hidden with the HiddenReason `BackingUnit`.
44557
45739
  */
44558
45740
  include_hidden?: string;
45741
+ /**
45742
+ * @description UUID of a View whose columns to compute for each Revision, returned as ViewColumns.
45743
+ *
45744
+ * The View must be in the same Organization as the user credentials, and be a View of Revision: its Of, or the From of its Filter, must be Revision.
45745
+ *
45746
+ * If the View has a Filter, the Filter selects the entities as the filter parameter does, so the two may not both be specified.
45747
+ *
45748
+ * The related entities and fields the View's columns read are included and selected automatically, so neither include nor select has to name them.
45749
+ */
45750
+ view?: string;
44559
45751
  /** @description Maximum number of Revision entities to return. If not specified, all matching entities are returned. Values greater than 1000 are rejected with 400. When there may be more entities, the response has a ConfigHub-Continue header to pass as the continue parameter of the next request. */
44560
45752
  limit?: number;
44561
45753
  /**
@@ -44683,7 +45875,7 @@ interface operations {
44683
45875
  * expected in a comma-separated list format as in the JSON encoding.
44684
45876
  * If not specified, all fields are returned.
44685
45877
  * Entity and parent IDs (like OrganizationID, SpaceID, RevisionID) and Slug are always returned regardless of the select parameter.
44686
- * Fields used in where and contains filters, and fields named by order_by, are also automatically included.
45878
+ * Fields used in where and contains filters, fields named by order_by, and fields read by the columns of the View named by view are also automatically included.
44687
45879
  * Example: 'DisplayName,CreatedAt,Labels' will return only those fields plus the required ID and Slug fields.
44688
45880
  * The whole string must be query-encoded.
44689
45881
  */
@@ -45561,7 +46753,7 @@ interface operations {
45561
46753
  * expected in a comma-separated list format as in the JSON encoding.
45562
46754
  * If not specified, all fields are returned.
45563
46755
  * Entity and parent IDs (like OrganizationID, SpaceID, ViewID) and Slug are always returned regardless of the select parameter.
45564
- * Fields used in where and contains filters, and fields named by order_by, are also automatically included.
46756
+ * Fields used in where and contains filters, fields named by order_by, and fields read by the columns of the View named by view are also automatically included.
45565
46757
  * Example: 'DisplayName,CreatedAt,Labels' will return only those fields plus the required ID and Slug fields.
45566
46758
  * The whole string must be query-encoded.
45567
46759
  */
@@ -45576,6 +46768,16 @@ interface operations {
45576
46768
  * ConfigHub/YAML Units, which hold the configuration of entities, are hidden with the HiddenReason `BackingUnit`.
45577
46769
  */
45578
46770
  include_hidden?: string;
46771
+ /**
46772
+ * @description UUID of a View whose columns to compute for each View, returned as ViewColumns.
46773
+ *
46774
+ * The View must be in the same Organization as the user credentials, and be a View of View: its Of, or the From of its Filter, must be View.
46775
+ *
46776
+ * If the View has a Filter, the Filter selects the entities as the filter parameter does, so the two may not both be specified.
46777
+ *
46778
+ * The related entities and fields the View's columns read are included and selected automatically, so neither include nor select has to name them.
46779
+ */
46780
+ view?: string;
45579
46781
  /** @description Maximum number of View entities to return. If not specified, all matching entities are returned. Values greater than 1000 are rejected with 400. When there may be more entities, the response has a ConfigHub-Continue header to pass as the continue parameter of the next request. */
45580
46782
  limit?: number;
45581
46783
  /**
@@ -45793,7 +46995,7 @@ interface operations {
45793
46995
  * expected in a comma-separated list format as in the JSON encoding.
45794
46996
  * If not specified, all fields are returned.
45795
46997
  * Entity and parent IDs (like OrganizationID, SpaceID, ViewID) and Slug are always returned regardless of the select parameter.
45796
- * Fields used in where and contains filters, and fields named by order_by, are also automatically included.
46998
+ * Fields used in where and contains filters, fields named by order_by, and fields read by the columns of the View named by view are also automatically included.
45797
46999
  * Example: 'DisplayName,CreatedAt,Labels' will return only those fields plus the required ID and Slug fields.
45798
47000
  * The whole string must be query-encoded.
45799
47001
  */
@@ -46458,7 +47660,7 @@ interface operations {
46458
47660
  * expected in a comma-separated list format as in the JSON encoding.
46459
47661
  * If not specified, all fields are returned.
46460
47662
  * Entity and parent IDs (like OrganizationID, SpaceID, TagID) and Slug are always returned regardless of the select parameter.
46461
- * Fields used in where and contains filters, and fields named by order_by, are also automatically included.
47663
+ * Fields used in where and contains filters, fields named by order_by, and fields read by the columns of the View named by view are also automatically included.
46462
47664
  * Example: 'DisplayName,CreatedAt,Labels' will return only those fields plus the required ID and Slug fields.
46463
47665
  * The whole string must be query-encoded.
46464
47666
  */
@@ -46473,6 +47675,16 @@ interface operations {
46473
47675
  * ConfigHub/YAML Units, which hold the configuration of entities, are hidden with the HiddenReason `BackingUnit`.
46474
47676
  */
46475
47677
  include_hidden?: string;
47678
+ /**
47679
+ * @description UUID of a View whose columns to compute for each Tag, returned as ViewColumns.
47680
+ *
47681
+ * The View must be in the same Organization as the user credentials, and be a View of Tag: its Of, or the From of its Filter, must be Tag.
47682
+ *
47683
+ * If the View has a Filter, the Filter selects the entities as the filter parameter does, so the two may not both be specified.
47684
+ *
47685
+ * The related entities and fields the View's columns read are included and selected automatically, so neither include nor select has to name them.
47686
+ */
47687
+ view?: string;
46476
47688
  /** @description Maximum number of Tag entities to return. If not specified, all matching entities are returned. Values greater than 1000 are rejected with 400. When there may be more entities, the response has a ConfigHub-Continue header to pass as the continue parameter of the next request. */
46477
47689
  limit?: number;
46478
47690
  /**
@@ -47561,7 +48773,7 @@ interface operations {
47561
48773
  * expected in a comma-separated list format as in the JSON encoding.
47562
48774
  * If not specified, all fields are returned.
47563
48775
  * Entity and parent IDs (like OrganizationID, SpaceID, TargetID) and Slug are always returned regardless of the select parameter.
47564
- * Fields used in where and contains filters, and fields named by order_by, are also automatically included.
48776
+ * Fields used in where and contains filters, fields named by order_by, and fields read by the columns of the View named by view are also automatically included.
47565
48777
  * Example: 'DisplayName,CreatedAt,Labels' will return only those fields plus the required ID and Slug fields.
47566
48778
  * The whole string must be query-encoded.
47567
48779
  */
@@ -47576,6 +48788,16 @@ interface operations {
47576
48788
  * ConfigHub/YAML Units, which hold the configuration of entities, are hidden with the HiddenReason `BackingUnit`.
47577
48789
  */
47578
48790
  include_hidden?: string;
48791
+ /**
48792
+ * @description UUID of a View whose columns to compute for each Target, returned as ViewColumns.
48793
+ *
48794
+ * The View must be in the same Organization as the user credentials, and be a View of Target: its Of, or the From of its Filter, must be Target.
48795
+ *
48796
+ * If the View has a Filter, the Filter selects the entities as the filter parameter does, so the two may not both be specified.
48797
+ *
48798
+ * The related entities and fields the View's columns read are included and selected automatically, so neither include nor select has to name them.
48799
+ */
48800
+ view?: string;
47579
48801
  /** @description Maximum number of Target entities to return. If not specified, all matching entities are returned. Values greater than 1000 are rejected with 400. When there may be more entities, the response has a ConfigHub-Continue header to pass as the continue parameter of the next request. */
47580
48802
  limit?: number;
47581
48803
  /**
@@ -48754,7 +49976,7 @@ interface operations {
48754
49976
  * expected in a comma-separated list format as in the JSON encoding.
48755
49977
  * If not specified, all fields are returned.
48756
49978
  * Entity and parent IDs (like OrganizationID, SpaceID, TriggerID) and Slug are always returned regardless of the select parameter.
48757
- * Fields used in where and contains filters, and fields named by order_by, are also automatically included.
49979
+ * Fields used in where and contains filters, fields named by order_by, and fields read by the columns of the View named by view are also automatically included.
48758
49980
  * Example: 'DisplayName,CreatedAt,Labels' will return only those fields plus the required ID and Slug fields.
48759
49981
  * The whole string must be query-encoded.
48760
49982
  */
@@ -48769,6 +49991,16 @@ interface operations {
48769
49991
  * ConfigHub/YAML Units, which hold the configuration of entities, are hidden with the HiddenReason `BackingUnit`.
48770
49992
  */
48771
49993
  include_hidden?: string;
49994
+ /**
49995
+ * @description UUID of a View whose columns to compute for each Trigger, returned as ViewColumns.
49996
+ *
49997
+ * The View must be in the same Organization as the user credentials, and be a View of Trigger: its Of, or the From of its Filter, must be Trigger.
49998
+ *
49999
+ * If the View has a Filter, the Filter selects the entities as the filter parameter does, so the two may not both be specified.
50000
+ *
50001
+ * The related entities and fields the View's columns read are included and selected automatically, so neither include nor select has to name them.
50002
+ */
50003
+ view?: string;
48772
50004
  /** @description Maximum number of Trigger entities to return. If not specified, all matching entities are returned. Values greater than 1000 are rejected with 400. When there may be more entities, the response has a ConfigHub-Continue header to pass as the continue parameter of the next request. */
48773
50005
  limit?: number;
48774
50006
  /**
@@ -49989,7 +51221,7 @@ interface operations {
49989
51221
  * expected in a comma-separated list format as in the JSON encoding.
49990
51222
  * If not specified, all fields are returned.
49991
51223
  * Entity and parent IDs (like OrganizationID, SpaceID, UnitID) and Slug are always returned regardless of the select parameter.
49992
- * Fields used in where and contains filters, and fields named by order_by, are also automatically included.
51224
+ * Fields used in where and contains filters, fields named by order_by, and fields read by the columns of the View named by view are also automatically included.
49993
51225
  * Example: 'DisplayName,CreatedAt,Labels' will return only those fields plus the required ID and Slug fields.
49994
51226
  * The whole string must be query-encoded.
49995
51227
  */
@@ -50004,6 +51236,16 @@ interface operations {
50004
51236
  * ConfigHub/YAML Units, which hold the configuration of entities, are hidden with the HiddenReason `BackingUnit`.
50005
51237
  */
50006
51238
  include_hidden?: string;
51239
+ /**
51240
+ * @description UUID of a View whose columns to compute for each Unit, returned as ViewColumns.
51241
+ *
51242
+ * The View must be in the same Organization as the user credentials, and be a View of Unit: its Of, or the From of its Filter, must be Unit.
51243
+ *
51244
+ * If the View has a Filter, the Filter selects the entities as the filter parameter does, so the two may not both be specified.
51245
+ *
51246
+ * The related entities and fields the View's columns read are included and selected automatically, so neither include nor select has to name them.
51247
+ */
51248
+ view?: string;
50007
51249
  /** @description Maximum number of Unit entities to return. If not specified, all matching entities are returned. Values greater than 1000 are rejected with 400. When there may be more entities, the response has a ConfigHub-Continue header to pass as the continue parameter of the next request. */
50008
51250
  limit?: number;
50009
51251
  /**
@@ -50040,8 +51282,6 @@ interface operations {
50040
51282
  trigger_filter?: string;
50041
51283
  /** @description When true, return units that pass trigger validation; when false (default), return units that fail. Only applies when where_trigger or trigger_filter is specified. */
50042
51284
  triggers_passed?: boolean;
50043
- /** @description View slug or UUID. Applies the View's column definitions to extract values for each unit. If the View has a FilterID, its filter is ANDed with other filters. The View must have Of=Unit or a Filter with From=Unit. */
50044
- view?: string;
50045
51285
  };
50046
51286
  header?: never;
50047
51287
  path?: never;
@@ -51894,7 +53134,7 @@ interface operations {
51894
53134
  * expected in a comma-separated list format as in the JSON encoding.
51895
53135
  * If not specified, all fields are returned.
51896
53136
  * Entity and parent IDs (like OrganizationID, SpaceID, UnitID) and Slug are always returned regardless of the select parameter.
51897
- * Fields used in where and contains filters, and fields named by order_by, are also automatically included.
53137
+ * Fields used in where and contains filters, fields named by order_by, and fields read by the columns of the View named by view are also automatically included.
51898
53138
  * Example: 'DisplayName,CreatedAt,Labels' will return only those fields plus the required ID and Slug fields.
51899
53139
  * The whole string must be query-encoded.
51900
53140
  */
@@ -51909,6 +53149,8 @@ interface operations {
51909
53149
  * ConfigHub/YAML Units, which hold the configuration of entities, are hidden with the HiddenReason `BackingUnit`.
51910
53150
  */
51911
53151
  include_hidden?: string;
53152
+ /** @description UUID of a View of Unit. Its Filter selects the Units as the filter parameter does, so the two may not both be specified. */
53153
+ view?: string;
51912
53154
  /** @description Maximum number of Unit entities to return. If not specified, all matching entities are returned. Values greater than 1000 are rejected with 400. When there may be more entities, the response has a ConfigHub-Continue header to pass as the continue parameter of the next request. */
51913
53155
  limit?: number;
51914
53156
  /**
@@ -51945,8 +53187,6 @@ interface operations {
51945
53187
  trigger_filter?: string;
51946
53188
  /** @description When true, return units that pass trigger validation; when false (default), return units that fail. Only applies when where_trigger or trigger_filter is specified. */
51947
53189
  triggers_passed?: boolean;
51948
- /** @description View slug or UUID. Applies the View's column definitions to extract values for each unit. If the View has a FilterID, its filter is ANDed with other filters. The View must have Of=Unit or a Filter with From=Unit. */
51949
- view?: string;
51950
53190
  };
51951
53191
  header?: never;
51952
53192
  path?: never;
@@ -52108,6 +53348,8 @@ interface operations {
52108
53348
  * ConfigHub/YAML Units, which hold the configuration of entities, are hidden with the HiddenReason `BackingUnit`.
52109
53349
  */
52110
53350
  include_hidden?: string;
53351
+ /** @description UUID of a View of Unit. Its Filter selects the Units as the filter parameter does, so the two may not both be specified. */
53352
+ view?: string;
52111
53353
  /** @description Maximum number of Unit entities to return. If not specified, all matching entities are returned. Values greater than 1000 are rejected with 400. When there may be more entities, the response has a ConfigHub-Continue header to pass as the continue parameter of the next request. */
52112
53354
  limit?: number;
52113
53355
  /**
@@ -52144,8 +53386,6 @@ interface operations {
52144
53386
  trigger_filter?: string;
52145
53387
  /** @description When true, return units that pass trigger validation; when false (default), return units that fail. Only applies when where_trigger or trigger_filter is specified. */
52146
53388
  triggers_passed?: boolean;
52147
- /** @description View slug or UUID. Applies the View's column definitions to extract values for each unit. If the View has a FilterID, its filter is ANDed with other filters. The View must have Of=Unit or a Filter with From=Unit. */
52148
- view?: string;
52149
53389
  /** @description The Revision on the From side: a number, a Revision ID, HeadRevisionNum, LastReleasedRevisionNum, Tag:<id>, ChangeSet:<id>, or ChangeOrder:<id>, any of them optionally prefixed with Before:. */
52150
53390
  from?: string;
52151
53391
  /** @description The Revision on the To side, in the same syntax as from. */
@@ -52523,7 +53763,7 @@ interface operations {
52523
53763
  * expected in a comma-separated list format as in the JSON encoding.
52524
53764
  * If not specified, all fields are returned.
52525
53765
  * Entity and parent IDs (like OrganizationID, SpaceID, UnitID) and Slug are always returned regardless of the select parameter.
52526
- * Fields used in where and contains filters, and fields named by order_by, are also automatically included.
53766
+ * Fields used in where and contains filters, fields named by order_by, and fields read by the columns of the View named by view are also automatically included.
52527
53767
  * Example: 'DisplayName,CreatedAt,Labels' will return only those fields plus the required ID and Slug fields.
52528
53768
  * The whole string must be query-encoded.
52529
53769
  */
@@ -52538,6 +53778,8 @@ interface operations {
52538
53778
  * ConfigHub/YAML Units, which hold the configuration of entities, are hidden with the HiddenReason `BackingUnit`.
52539
53779
  */
52540
53780
  include_hidden?: string;
53781
+ /** @description UUID of a View of Unit. Its Filter selects the Units as the filter parameter does, so the two may not both be specified. */
53782
+ view?: string;
52541
53783
  /** @description Maximum number of Unit entities to return. If not specified, all matching entities are returned. Values greater than 1000 are rejected with 400. When there may be more entities, the response has a ConfigHub-Continue header to pass as the continue parameter of the next request. */
52542
53784
  limit?: number;
52543
53785
  /**
@@ -52574,8 +53816,6 @@ interface operations {
52574
53816
  trigger_filter?: string;
52575
53817
  /** @description When true, return units that pass trigger validation; when false (default), return units that fail. Only applies when where_trigger or trigger_filter is specified. */
52576
53818
  triggers_passed?: boolean;
52577
- /** @description View slug or UUID. Applies the View's column definitions to extract values for each unit. If the View has a FilterID, its filter is ANDed with other filters. The View must have Of=Unit or a Filter with From=Unit. */
52578
- view?: string;
52579
53819
  };
52580
53820
  header?: never;
52581
53821
  path?: never;
@@ -52659,9 +53899,9 @@ interface operations {
52659
53899
  */
52660
53900
  dry_run?: boolean;
52661
53901
  /**
52662
- * @description Comma-separated parts of the result to return in addition to the actions: Mutations for what each Unit write changed, or on a dry run would change, as entries of its MutationSources, and Diff for the same change path by path with the values on both sides. They cost something to return, and on a dry run either one runs the merges a plan otherwise skips, so they are returned only when named.
53902
+ * @description Comma-separated parts of the result to return in addition to the actions: Mutations for what each Unit write changed, or on a dry run would change, as entries of its MutationSources, and Diff for the same change path by path with the values on both sides. They cost something to return, and on a dry run either one runs the merges a plan otherwise skips, so they are returned only when named. Context, with Diff, adds to each Diff the unchanged paths around the changes: every unchanged child of each map or array that holds a change, up to the resource, as ChangeType None.
52663
53903
  *
52664
- * Supported values: Mutations, Diff.
53904
+ * Supported values: Mutations, Diff, Context.
52665
53905
  */
52666
53906
  include?: string;
52667
53907
  };
@@ -52857,7 +54097,7 @@ interface operations {
52857
54097
  * expected in a comma-separated list format as in the JSON encoding.
52858
54098
  * If not specified, all fields are returned.
52859
54099
  * Entity and parent IDs (like OrganizationID, SpaceID, UserID) and Slug are always returned regardless of the select parameter.
52860
- * Fields used in where and contains filters, and fields named by order_by, are also automatically included.
54100
+ * Fields used in where and contains filters, fields named by order_by, and fields read by the columns of the View named by view are also automatically included.
52861
54101
  * Example: 'DisplayName,CreatedAt,Labels' will return only those fields plus the required ID and Slug fields.
52862
54102
  * The whole string must be query-encoded.
52863
54103
  */
@@ -52872,6 +54112,16 @@ interface operations {
52872
54112
  * ConfigHub/YAML Units, which hold the configuration of entities, are hidden with the HiddenReason `BackingUnit`.
52873
54113
  */
52874
54114
  include_hidden?: string;
54115
+ /**
54116
+ * @description UUID of a View whose columns to compute for each User, returned as ViewColumns.
54117
+ *
54118
+ * The View must be in the same Organization as the user credentials, and be a View of User: its Of, or the From of its Filter, must be User.
54119
+ *
54120
+ * If the View has a Filter, the Filter selects the entities as the filter parameter does, so the two may not both be specified.
54121
+ *
54122
+ * The related entities and fields the View's columns read are included and selected automatically, so neither include nor select has to name them.
54123
+ */
54124
+ view?: string;
52875
54125
  /** @description Maximum number of User entities to return. If not specified, all matching entities are returned. Values greater than 1000 are rejected with 400. When there may be more entities, the response has a ConfigHub-Continue header to pass as the continue parameter of the next request. */
52876
54126
  limit?: number;
52877
54127
  /**
@@ -52979,7 +54229,7 @@ interface operations {
52979
54229
  * expected in a comma-separated list format as in the JSON encoding.
52980
54230
  * If not specified, all fields are returned.
52981
54231
  * Entity and parent IDs (like OrganizationID, SpaceID, UserID) and Slug are always returned regardless of the select parameter.
52982
- * Fields used in where and contains filters, and fields named by order_by, are also automatically included.
54232
+ * Fields used in where and contains filters, fields named by order_by, and fields read by the columns of the View named by view are also automatically included.
52983
54233
  * Example: 'DisplayName,CreatedAt,Labels' will return only those fields plus the required ID and Slug fields.
52984
54234
  * The whole string must be query-encoded.
52985
54235
  */
@@ -53417,7 +54667,7 @@ interface operations {
53417
54667
  * expected in a comma-separated list format as in the JSON encoding.
53418
54668
  * If not specified, all fields are returned.
53419
54669
  * Entity and parent IDs (like OrganizationID, SpaceID, ViewID) and Slug are always returned regardless of the select parameter.
53420
- * Fields used in where and contains filters, and fields named by order_by, are also automatically included.
54670
+ * Fields used in where and contains filters, fields named by order_by, and fields read by the columns of the View named by view are also automatically included.
53421
54671
  * Example: 'DisplayName,CreatedAt,Labels' will return only those fields plus the required ID and Slug fields.
53422
54672
  * The whole string must be query-encoded.
53423
54673
  */
@@ -53432,6 +54682,16 @@ interface operations {
53432
54682
  * ConfigHub/YAML Units, which hold the configuration of entities, are hidden with the HiddenReason `BackingUnit`.
53433
54683
  */
53434
54684
  include_hidden?: string;
54685
+ /**
54686
+ * @description UUID of a View whose columns to compute for each View, returned as ViewColumns.
54687
+ *
54688
+ * The View must be in the same Organization as the user credentials, and be a View of View: its Of, or the From of its Filter, must be View.
54689
+ *
54690
+ * If the View has a Filter, the Filter selects the entities as the filter parameter does, so the two may not both be specified.
54691
+ *
54692
+ * The related entities and fields the View's columns read are included and selected automatically, so neither include nor select has to name them.
54693
+ */
54694
+ view?: string;
53435
54695
  /** @description Maximum number of View entities to return. If not specified, all matching entities are returned. Values greater than 1000 are rejected with 400. When there may be more entities, the response has a ConfigHub-Continue header to pass as the continue parameter of the next request. */
53436
54696
  limit?: number;
53437
54697
  /**