@confighub/rtk-query 0.8.10 → 0.8.12

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.
package/dist/index.d.cts CHANGED
@@ -2380,7 +2380,7 @@ type BulkDeleteChangeOrdersApiArg = {
2380
2380
  An example conjunction is:
2381
2381
  `CreatedAt >= '2025-01-07' AND Slug = 'test' AND Labels.mykey = 'myvalue'`.
2382
2382
 
2383
- Supported attributes for filtering on ChangeOrder: AbortedReason, AdoptedEndTagID, Annotations, ChangeOrderID, ChangeWorkflow, ChangeWorkflowID, CreatedAt, DeleteGates, Description, DisplayName, EndTagID, HiddenReason, InScopeSpaceIDs, InvocationID, Labels, OrganizationID, Parameters, Permissions, PromotionFailures, PromotionOverrides, Promotions, ReleasedRestoredSpaceIDs, ReleasedSpaceIDs, Releases, ResolvedSpaceIDs, RestoreTagID, RestoredSpaceIDs, SkippedUnits, Slug, SpaceFilterID, SpaceID, Stage, StartTagID, State, UnitFilterID, UpdateType, UpdatedAt, WhereSpace, WhereUnit.
2383
+ Supported attributes for filtering on ChangeOrder: AbortedReason, AdoptedEndTagID, Annotations, ChangeOrderID, ChangeWorkflow, ChangeWorkflowID, CreatedAt, DeleteGates, Description, DisplayName, EndTagID, HiddenReason, InScopeSpaceIDs, InvocationID, Labels, OrganizationID, Parameters, Permissions, PriorRevisions, PromotionFailures, PromotionOverrides, Promotions, ReleasePriorRevisions, ReleaseTagID, ReleasedRestoredSpaceIDs, ReleasedSpaceIDs, Releases, ResolvedSpaceIDs, RestoreTagID, RestoredSpaceIDs, SkippedUnits, Slug, SpaceFilterID, SpaceID, Stage, StartTagID, State, UnitFilterID, UpdateType, UpdatedAt, UserID, WhereSpace, WhereUnit.
2384
2384
 
2385
2385
  The whole string must be query-encoded. */
2386
2386
  where?: string;
@@ -2424,7 +2424,7 @@ type BulkDeleteChangeOrdersApiArg = {
2424
2424
  The attribute names are case-sensitive, PascalCase, and
2425
2425
  expected in a comma-separated list format as in the JSON encoding.
2426
2426
 
2427
- Supported attributes for ChangeOrder are EndTagID, InvocationID, OrganizationID, RestoreTagID, SpaceFilterID, SpaceID, StartTagID, UnitFilterID.
2427
+ Supported attributes for ChangeOrder are EndTagID, InvocationID, OrganizationID, ReleaseTagID, RestoreTagID, SpaceFilterID, SpaceID, StartTagID, UnitFilterID.
2428
2428
 
2429
2429
  The whole string must be query-encoded. */
2430
2430
  include?: string;
@@ -2472,7 +2472,7 @@ type ListAllChangeOrdersApiArg = {
2472
2472
  An example conjunction is:
2473
2473
  `CreatedAt >= '2025-01-07' AND Slug = 'test' AND Labels.mykey = 'myvalue'`.
2474
2474
 
2475
- Supported attributes for filtering on ChangeOrder: AbortedReason, AdoptedEndTagID, Annotations, ChangeOrderID, ChangeWorkflow, ChangeWorkflowID, CreatedAt, DeleteGates, Description, DisplayName, EndTagID, HiddenReason, InScopeSpaceIDs, InvocationID, Labels, OrganizationID, Parameters, Permissions, PromotionFailures, PromotionOverrides, Promotions, ReleasedRestoredSpaceIDs, ReleasedSpaceIDs, Releases, ResolvedSpaceIDs, RestoreTagID, RestoredSpaceIDs, SkippedUnits, Slug, SpaceFilterID, SpaceID, Stage, StartTagID, State, UnitFilterID, UpdateType, UpdatedAt, WhereSpace, WhereUnit.
2475
+ Supported attributes for filtering on ChangeOrder: AbortedReason, AdoptedEndTagID, Annotations, ChangeOrderID, ChangeWorkflow, ChangeWorkflowID, CreatedAt, DeleteGates, Description, DisplayName, EndTagID, HiddenReason, InScopeSpaceIDs, InvocationID, Labels, OrganizationID, Parameters, Permissions, PriorRevisions, PromotionFailures, PromotionOverrides, Promotions, ReleasePriorRevisions, ReleaseTagID, ReleasedRestoredSpaceIDs, ReleasedSpaceIDs, Releases, ResolvedSpaceIDs, RestoreTagID, RestoredSpaceIDs, SkippedUnits, Slug, SpaceFilterID, SpaceID, Stage, StartTagID, State, UnitFilterID, UpdateType, UpdatedAt, UserID, WhereSpace, WhereUnit.
2476
2476
 
2477
2477
  The whole string must be query-encoded. */
2478
2478
  where?: string;
@@ -2508,7 +2508,7 @@ type ListAllChangeOrdersApiArg = {
2508
2508
  The attribute names are case-sensitive, PascalCase, and
2509
2509
  expected in a comma-separated list format as in the JSON encoding.
2510
2510
 
2511
- Supported attributes for ChangeOrder are EndTagID, InvocationID, OrganizationID, RestoreTagID, SpaceFilterID, SpaceID, StartTagID, UnitFilterID.
2511
+ Supported attributes for ChangeOrder are EndTagID, InvocationID, OrganizationID, ReleaseTagID, RestoreTagID, SpaceFilterID, SpaceID, StartTagID, UnitFilterID.
2512
2512
 
2513
2513
  The whole string must be query-encoded. */
2514
2514
  include?: string;
@@ -2535,7 +2535,7 @@ type ListAllChangeOrdersApiArg = {
2535
2535
 
2536
2536
  Field names are case-sensitive and PascalCase, as in the JSON encoding. Sort direction defaults to ASC when the 'DIRECTION:' prefix is omitted.
2537
2537
 
2538
- Supported attributes for ordering ChangeOrder: AbortedReason, AdoptedEndTagID, ChangeOrderID, ChangeWorkflowID, CreatedAt, Description, DisplayName, EndTagID, HiddenReason, InvocationID, OrganizationID, RestoreTagID, Slug, SpaceFilterID, SpaceID, Stage, StartTagID, UnitFilterID, UpdateType, UpdatedAt, WhereSpace, WhereUnit.
2538
+ Supported attributes for ordering ChangeOrder: AbortedReason, AdoptedEndTagID, ChangeOrderID, ChangeWorkflowID, CreatedAt, Description, DisplayName, EndTagID, HiddenReason, InvocationID, OrganizationID, PriorRevisions, ReleasePriorRevisions, ReleaseTagID, RestoreTagID, Slug, SpaceFilterID, SpaceID, Stage, StartTagID, UnitFilterID, UpdateType, UpdatedAt, UserID, WhereSpace, WhereUnit.
2539
2539
 
2540
2540
  Example: 'DESC:CreatedAt' or 'DisplayName,DESC:CreatedAt'.
2541
2541
 
@@ -2586,7 +2586,7 @@ type BulkPatchChangeOrdersApiArg = {
2586
2586
  An example conjunction is:
2587
2587
  `CreatedAt >= '2025-01-07' AND Slug = 'test' AND Labels.mykey = 'myvalue'`.
2588
2588
 
2589
- Supported attributes for filtering on ChangeOrder: AbortedReason, AdoptedEndTagID, Annotations, ChangeOrderID, ChangeWorkflow, ChangeWorkflowID, CreatedAt, DeleteGates, Description, DisplayName, EndTagID, HiddenReason, InScopeSpaceIDs, InvocationID, Labels, OrganizationID, Parameters, Permissions, PromotionFailures, PromotionOverrides, Promotions, ReleasedRestoredSpaceIDs, ReleasedSpaceIDs, Releases, ResolvedSpaceIDs, RestoreTagID, RestoredSpaceIDs, SkippedUnits, Slug, SpaceFilterID, SpaceID, Stage, StartTagID, State, UnitFilterID, UpdateType, UpdatedAt, WhereSpace, WhereUnit.
2589
+ Supported attributes for filtering on ChangeOrder: AbortedReason, AdoptedEndTagID, Annotations, ChangeOrderID, ChangeWorkflow, ChangeWorkflowID, CreatedAt, DeleteGates, Description, DisplayName, EndTagID, HiddenReason, InScopeSpaceIDs, InvocationID, Labels, OrganizationID, Parameters, Permissions, PriorRevisions, PromotionFailures, PromotionOverrides, Promotions, ReleasePriorRevisions, ReleaseTagID, ReleasedRestoredSpaceIDs, ReleasedSpaceIDs, Releases, ResolvedSpaceIDs, RestoreTagID, RestoredSpaceIDs, SkippedUnits, Slug, SpaceFilterID, SpaceID, Stage, StartTagID, State, UnitFilterID, UpdateType, UpdatedAt, UserID, WhereSpace, WhereUnit.
2590
2590
 
2591
2591
  The whole string must be query-encoded. */
2592
2592
  where?: string;
@@ -2630,7 +2630,7 @@ type BulkPatchChangeOrdersApiArg = {
2630
2630
  The attribute names are case-sensitive, PascalCase, and
2631
2631
  expected in a comma-separated list format as in the JSON encoding.
2632
2632
 
2633
- Supported attributes for ChangeOrder are EndTagID, InvocationID, OrganizationID, RestoreTagID, SpaceFilterID, SpaceID, StartTagID, UnitFilterID.
2633
+ Supported attributes for ChangeOrder are EndTagID, InvocationID, OrganizationID, ReleaseTagID, RestoreTagID, SpaceFilterID, SpaceID, StartTagID, UnitFilterID.
2634
2634
 
2635
2635
  The whole string must be query-encoded. */
2636
2636
  include?: string;
@@ -2669,6 +2669,8 @@ type BulkPatchChangeOrdersApiArg = {
2669
2669
  Permissions?: {
2670
2670
  [key: string]: object | null;
2671
2671
  } | null;
2672
+ PriorRevisions?: string | null;
2673
+ ReleasePriorRevisions?: string | null;
2672
2674
  /** Unique URL-safe identifier for the entity. */
2673
2675
  Slug?: string | null;
2674
2676
  SpaceFilterID?: string | null;
@@ -2716,7 +2718,7 @@ type BulkCreateChangeOrdersApiArg = {
2716
2718
  An example conjunction is:
2717
2719
  `CreatedAt >= '2025-01-07' AND Slug = 'test' AND Labels.mykey = 'myvalue'`.
2718
2720
 
2719
- Supported attributes for filtering on ChangeOrder: AbortedReason, AdoptedEndTagID, Annotations, ChangeOrderID, ChangeWorkflow, ChangeWorkflowID, CreatedAt, DeleteGates, Description, DisplayName, EndTagID, HiddenReason, InScopeSpaceIDs, InvocationID, Labels, OrganizationID, Parameters, Permissions, PromotionFailures, PromotionOverrides, Promotions, ReleasedRestoredSpaceIDs, ReleasedSpaceIDs, Releases, ResolvedSpaceIDs, RestoreTagID, RestoredSpaceIDs, SkippedUnits, Slug, SpaceFilterID, SpaceID, Stage, StartTagID, State, UnitFilterID, UpdateType, UpdatedAt, WhereSpace, WhereUnit.
2721
+ Supported attributes for filtering on ChangeOrder: AbortedReason, AdoptedEndTagID, Annotations, ChangeOrderID, ChangeWorkflow, ChangeWorkflowID, CreatedAt, DeleteGates, Description, DisplayName, EndTagID, HiddenReason, InScopeSpaceIDs, InvocationID, Labels, OrganizationID, Parameters, Permissions, PriorRevisions, PromotionFailures, PromotionOverrides, Promotions, ReleasePriorRevisions, ReleaseTagID, ReleasedRestoredSpaceIDs, ReleasedSpaceIDs, Releases, ResolvedSpaceIDs, RestoreTagID, RestoredSpaceIDs, SkippedUnits, Slug, SpaceFilterID, SpaceID, Stage, StartTagID, State, UnitFilterID, UpdateType, UpdatedAt, UserID, WhereSpace, WhereUnit.
2720
2722
 
2721
2723
  The whole string must be query-encoded. */
2722
2724
  where?: string;
@@ -2760,7 +2762,7 @@ type BulkCreateChangeOrdersApiArg = {
2760
2762
  The attribute names are case-sensitive, PascalCase, and
2761
2763
  expected in a comma-separated list format as in the JSON encoding.
2762
2764
 
2763
- Supported attributes for ChangeOrder are EndTagID, InvocationID, OrganizationID, RestoreTagID, SpaceFilterID, SpaceID, StartTagID, UnitFilterID.
2765
+ Supported attributes for ChangeOrder are EndTagID, InvocationID, OrganizationID, ReleaseTagID, RestoreTagID, SpaceFilterID, SpaceID, StartTagID, UnitFilterID.
2764
2766
 
2765
2767
  The whole string must be query-encoded. */
2766
2768
  include?: string;
@@ -2857,6 +2859,8 @@ type BulkCreateChangeOrdersApiArg = {
2857
2859
  Permissions?: {
2858
2860
  [key: string]: object | null;
2859
2861
  } | null;
2862
+ PriorRevisions?: string | null;
2863
+ ReleasePriorRevisions?: string | null;
2860
2864
  /** Unique URL-safe identifier for the entity. */
2861
2865
  Slug?: string | null;
2862
2866
  SpaceFilterID?: string | null;
@@ -6837,7 +6841,7 @@ type ListAllReleasesApiArg = {
6837
6841
  An example conjunction is:
6838
6842
  `CreatedAt >= '2025-01-07' AND Slug = 'test' AND Labels.mykey = 'myvalue'`.
6839
6843
 
6840
- Supported attributes for filtering on Release: Annotations, ChangeOrderID, CreatedAt, DeleteGates, Digest, HiddenReason, Labels, LiveStatus, ManifestDigest, OrganizationID, Permissions, Published, ReleaseID, ReleaseNum, SpaceID, TagID, TargetID, UnitCount, UpdatedAt, UserID.
6844
+ Supported attributes for filtering on Release: Annotations, ChangeOrderID, CreatedAt, DeleteGates, Digest, HiddenReason, Labels, LiveStatus, ManifestDigest, OrganizationID, Permissions, Published, ReleaseID, ReleaseNum, SkippedUnits, SpaceID, TagID, TargetID, UnitCount, UpdatedAt, UserID.
6841
6845
 
6842
6846
  The whole string must be query-encoded. */
6843
6847
  where?: string;
@@ -8857,7 +8861,7 @@ type ListChangeOrdersApiArg = {
8857
8861
  An example conjunction is:
8858
8862
  `CreatedAt >= '2025-01-07' AND Slug = 'test' AND Labels.mykey = 'myvalue'`.
8859
8863
 
8860
- Supported attributes for filtering on ChangeOrder: AbortedReason, AdoptedEndTagID, Annotations, ChangeOrderID, ChangeWorkflow, ChangeWorkflowID, CreatedAt, DeleteGates, Description, DisplayName, EndTagID, HiddenReason, InScopeSpaceIDs, InvocationID, Labels, OrganizationID, Parameters, Permissions, PromotionFailures, PromotionOverrides, Promotions, ReleasedRestoredSpaceIDs, ReleasedSpaceIDs, Releases, ResolvedSpaceIDs, RestoreTagID, RestoredSpaceIDs, SkippedUnits, Slug, SpaceFilterID, SpaceID, Stage, StartTagID, State, UnitFilterID, UpdateType, UpdatedAt, WhereSpace, WhereUnit.
8864
+ Supported attributes for filtering on ChangeOrder: AbortedReason, AdoptedEndTagID, Annotations, ChangeOrderID, ChangeWorkflow, ChangeWorkflowID, CreatedAt, DeleteGates, Description, DisplayName, EndTagID, HiddenReason, InScopeSpaceIDs, InvocationID, Labels, OrganizationID, Parameters, Permissions, PriorRevisions, PromotionFailures, PromotionOverrides, Promotions, ReleasePriorRevisions, ReleaseTagID, ReleasedRestoredSpaceIDs, ReleasedSpaceIDs, Releases, ResolvedSpaceIDs, RestoreTagID, RestoredSpaceIDs, SkippedUnits, Slug, SpaceFilterID, SpaceID, Stage, StartTagID, State, UnitFilterID, UpdateType, UpdatedAt, UserID, WhereSpace, WhereUnit.
8861
8865
 
8862
8866
  The whole string must be query-encoded. */
8863
8867
  where?: string;
@@ -8893,7 +8897,7 @@ type ListChangeOrdersApiArg = {
8893
8897
  The attribute names are case-sensitive, PascalCase, and
8894
8898
  expected in a comma-separated list format as in the JSON encoding.
8895
8899
 
8896
- Supported attributes for ChangeOrder are EndTagID, InvocationID, OrganizationID, RestoreTagID, SpaceFilterID, SpaceID, StartTagID, UnitFilterID.
8900
+ Supported attributes for ChangeOrder are EndTagID, InvocationID, OrganizationID, ReleaseTagID, RestoreTagID, SpaceFilterID, SpaceID, StartTagID, UnitFilterID.
8897
8901
 
8898
8902
  The whole string must be query-encoded. */
8899
8903
  include?: string;
@@ -8920,7 +8924,7 @@ type ListChangeOrdersApiArg = {
8920
8924
 
8921
8925
  Field names are case-sensitive and PascalCase, as in the JSON encoding. Sort direction defaults to ASC when the 'DIRECTION:' prefix is omitted.
8922
8926
 
8923
- Supported attributes for ordering ChangeOrder: AbortedReason, AdoptedEndTagID, ChangeOrderID, ChangeWorkflowID, CreatedAt, Description, DisplayName, EndTagID, HiddenReason, InvocationID, OrganizationID, RestoreTagID, Slug, SpaceFilterID, SpaceID, Stage, StartTagID, UnitFilterID, UpdateType, UpdatedAt, WhereSpace, WhereUnit.
8927
+ Supported attributes for ordering ChangeOrder: AbortedReason, AdoptedEndTagID, ChangeOrderID, ChangeWorkflowID, CreatedAt, Description, DisplayName, EndTagID, HiddenReason, InvocationID, OrganizationID, PriorRevisions, ReleasePriorRevisions, ReleaseTagID, RestoreTagID, Slug, SpaceFilterID, SpaceID, Stage, StartTagID, UnitFilterID, UpdateType, UpdatedAt, UserID, WhereSpace, WhereUnit.
8924
8928
 
8925
8929
  Example: 'DESC:CreatedAt' or 'DisplayName,DESC:CreatedAt'.
8926
8930
 
@@ -8965,7 +8969,7 @@ type GetChangeOrderApiArg = {
8965
8969
  The attribute names are case-sensitive, PascalCase, and
8966
8970
  expected in a comma-separated list format as in the JSON encoding.
8967
8971
 
8968
- Supported attributes for ChangeOrder are EndTagID, InvocationID, OrganizationID, RestoreTagID, SpaceFilterID, SpaceID, StartTagID, UnitFilterID.
8972
+ Supported attributes for ChangeOrder are EndTagID, InvocationID, OrganizationID, ReleaseTagID, RestoreTagID, SpaceFilterID, SpaceID, StartTagID, UnitFilterID.
8969
8973
 
8970
8974
  The whole string must be query-encoded. */
8971
8975
  include?: string;
@@ -9021,6 +9025,8 @@ type PatchChangeOrderApiArg = {
9021
9025
  Permissions?: {
9022
9026
  [key: string]: object | null;
9023
9027
  } | null;
9028
+ PriorRevisions?: string | null;
9029
+ ReleasePriorRevisions?: string | null;
9024
9030
  /** Unique URL-safe identifier for the entity. */
9025
9031
  Slug?: string | null;
9026
9032
  SpaceFilterID?: string | null;
@@ -10428,7 +10434,7 @@ type ListExtendedReleasesApiArg = {
10428
10434
  An example conjunction is:
10429
10435
  `CreatedAt >= '2025-01-07' AND Slug = 'test' AND Labels.mykey = 'myvalue'`.
10430
10436
 
10431
- Supported attributes for filtering on Release: Annotations, ChangeOrderID, CreatedAt, DeleteGates, Digest, HiddenReason, Labels, LiveStatus, ManifestDigest, OrganizationID, Permissions, Published, ReleaseID, ReleaseNum, SpaceID, TagID, TargetID, UnitCount, UpdatedAt, UserID.
10437
+ Supported attributes for filtering on Release: Annotations, ChangeOrderID, CreatedAt, DeleteGates, Digest, HiddenReason, Labels, LiveStatus, ManifestDigest, OrganizationID, Permissions, Published, ReleaseID, ReleaseNum, SkippedUnits, SpaceID, TagID, TargetID, UnitCount, UpdatedAt, UserID.
10432
10438
 
10433
10439
  The whole string must be query-encoded. */
10434
10440
  where?: string;
@@ -11615,7 +11621,7 @@ type PatchUnitApiArg = {
11615
11621
  changeSetId?: string;
11616
11622
  /** ChangeOrder to promote, with upgrade or resolve, or to undo, with restore. The change order fixed the range when it was created -- the interval on each source Unit, marked with its Tags -- so it supplies both ends of the merge and merge_end is refused alongside it. A Unit whose source the change order does not cover is passed over rather than failed, which is what lets a bulk upgrade name a whole Space and take only the Units the change is in. A Unit whose last merged revision is past where the change order starts is an error, since merging anyway would replay what it already has; one that is short of it is handled as prior_revisions says. With resolve a selected Link whose UpdateType the change order does not follow is an error too. The revisions the promotion creates carry the ChangeOrder, and its start Tag is placed on the revision before them and its end Tag on the one it arrives at, so 'restore Before:ChangeOrder:uuid' undoes it whether it landed as one revision or as one per source revision. With restore the change order is being undone rather than promoted: the restore must be 'Before:ChangeOrder:' the same change order, the change order must have an AbortedReason -- undoing a change nobody has said is not coming is a race with whoever is still promoting it -- and a Unit the change order never marked is an error rather than passed over, since naming it says the Unit is part of the undoing. The first restore mints the change order's restore Tag and records it as RestoreTagID; every restore after that marks with the same Tag, which is what RestoredSpaceIDs is read off. A Unit the change order carried nothing for takes the restore Tag on the revision its start and end Tags are already on, and no revision is made. A Unit already carrying the restore Tag has had the change order taken back out of it and is passed over, since undoing one in a Unit happens once as promoting it into one does -- so the revisions a Unit has taken since it was undone are its own work rather than this undoing's to drop. Restoring also advances the merge pointers of the Links of the change order's UpdateType that follow the restored Unit onto the revision the restore made, so a later upgrade does not replay the change that was just taken out; the downstream Units are not restored with it, since each has to be restored and released on its own account. */
11617
11623
  changeOrder?: string;
11618
- /** With change_order, when promoting it by upgrade or resolve: what to do for a Unit whose last merged revision of its source is before the revision the change order starts at there -- typically because a Link in the source's Space, such as a TransformPaths Link, wrote revisions after the Unit last merged, and those revisions are not the change order's. Include (the default) merges them first, walking them one source revision at a time even with squash, as revisions that do not carry the change order, and places the change order's start Tag on the revision they leave, so 'restore Before:ChangeOrder:uuid' keeps them. Skip merges only the change order's range, as though the Unit's merge pointer had already been advanced to the change order's start, so what those revisions changed does not reach the Unit. Error refuses, naming the Unit, the Link, and each of those revisions with the operation and Link that made it. A Unit that has already merged past the change order's start is an error whatever this says. */
11624
+ /** With change_order, when promoting it by upgrade or resolve: what to do for a Unit whose last merged revision of its source is before the revision the change order starts at there -- typically because a Link in the source's Space, such as a TransformPaths Link, wrote revisions after the Unit last merged, and those revisions are not the change order's. Include (the default) merges them first, walking them one source revision at a time even with squash, as revisions that do not carry the change order, and places the change order's start Tag on the revision they leave, so 'restore Before:ChangeOrder:uuid' keeps them. Skip merges only the change order's range, as though the Unit's merge pointer had already been advanced to the change order's start, so what those revisions changed does not reach the Unit. Error refuses, naming the Unit, the Link, and each of those revisions with the operation and Link that made it. All merges them as Include does. A Unit that has already merged past the change order's start is an error whatever this says. Defaults to the change order's PriorRevisions. */
11619
11625
  priorRevisions?: string;
11620
11626
  /** User-defined category for the Mutation. Must be alphanumeric, at most 64 characters. The prefix 'ConfigHub' is reserved. */
11621
11627
  subgroup?: string;
@@ -11753,7 +11759,7 @@ type UpdateUnitApiArg = {
11753
11759
  changeSetId?: string;
11754
11760
  /** ChangeOrder to promote, with upgrade or resolve, or to undo, with restore. The change order fixed the range when it was created -- the interval on each source Unit, marked with its Tags -- so it supplies both ends of the merge and merge_end is refused alongside it. A Unit whose source the change order does not cover is passed over rather than failed, which is what lets a bulk upgrade name a whole Space and take only the Units the change is in. A Unit whose last merged revision is past where the change order starts is an error, since merging anyway would replay what it already has; one that is short of it is handled as prior_revisions says. With resolve a selected Link whose UpdateType the change order does not follow is an error too. The revisions the promotion creates carry the ChangeOrder, and its start Tag is placed on the revision before them and its end Tag on the one it arrives at, so 'restore Before:ChangeOrder:uuid' undoes it whether it landed as one revision or as one per source revision. With restore the change order is being undone rather than promoted: the restore must be 'Before:ChangeOrder:' the same change order, the change order must have an AbortedReason -- undoing a change nobody has said is not coming is a race with whoever is still promoting it -- and a Unit the change order never marked is an error rather than passed over, since naming it says the Unit is part of the undoing. The first restore mints the change order's restore Tag and records it as RestoreTagID; every restore after that marks with the same Tag, which is what RestoredSpaceIDs is read off. A Unit the change order carried nothing for takes the restore Tag on the revision its start and end Tags are already on, and no revision is made. A Unit already carrying the restore Tag has had the change order taken back out of it and is passed over, since undoing one in a Unit happens once as promoting it into one does -- so the revisions a Unit has taken since it was undone are its own work rather than this undoing's to drop. Restoring also advances the merge pointers of the Links of the change order's UpdateType that follow the restored Unit onto the revision the restore made, so a later upgrade does not replay the change that was just taken out; the downstream Units are not restored with it, since each has to be restored and released on its own account. */
11755
11761
  changeOrder?: string;
11756
- /** With change_order, when promoting it by upgrade or resolve: what to do for a Unit whose last merged revision of its source is before the revision the change order starts at there -- typically because a Link in the source's Space, such as a TransformPaths Link, wrote revisions after the Unit last merged, and those revisions are not the change order's. Include (the default) merges them first, walking them one source revision at a time even with squash, as revisions that do not carry the change order, and places the change order's start Tag on the revision they leave, so 'restore Before:ChangeOrder:uuid' keeps them. Skip merges only the change order's range, as though the Unit's merge pointer had already been advanced to the change order's start, so what those revisions changed does not reach the Unit. Error refuses, naming the Unit, the Link, and each of those revisions with the operation and Link that made it. A Unit that has already merged past the change order's start is an error whatever this says. */
11762
+ /** With change_order, when promoting it by upgrade or resolve: what to do for a Unit whose last merged revision of its source is before the revision the change order starts at there -- typically because a Link in the source's Space, such as a TransformPaths Link, wrote revisions after the Unit last merged, and those revisions are not the change order's. Include (the default) merges them first, walking them one source revision at a time even with squash, as revisions that do not carry the change order, and places the change order's start Tag on the revision they leave, so 'restore Before:ChangeOrder:uuid' keeps them. Skip merges only the change order's range, as though the Unit's merge pointer had already been advanced to the change order's start, so what those revisions changed does not reach the Unit. Error refuses, naming the Unit, the Link, and each of those revisions with the operation and Link that made it. All merges them as Include does. A Unit that has already merged past the change order's start is an error whatever this says. Defaults to the change order's PriorRevisions. */
11757
11763
  priorRevisions?: string;
11758
11764
  /** User-defined category for the Mutation. Must be alphanumeric, at most 64 characters. The prefix 'ConfigHub' is reserved. */
11759
11765
  subgroup?: string;
@@ -15310,7 +15316,7 @@ type BulkPatchUnitsApiArg = {
15310
15316
  changeSetId?: string;
15311
15317
  /** ChangeOrder to promote, with upgrade or resolve, or to undo, with restore. The change order fixed the range when it was created -- the interval on each source Unit, marked with its Tags -- so it supplies both ends of the merge and merge_end is refused alongside it. A Unit whose source the change order does not cover is passed over rather than failed, which is what lets a bulk upgrade name a whole Space and take only the Units the change is in. A Unit whose last merged revision is past where the change order starts is an error, since merging anyway would replay what it already has; one that is short of it is handled as prior_revisions says. With resolve a selected Link whose UpdateType the change order does not follow is an error too. The revisions the promotion creates carry the ChangeOrder, and its start Tag is placed on the revision before them and its end Tag on the one it arrives at, so 'restore Before:ChangeOrder:uuid' undoes it whether it landed as one revision or as one per source revision. With restore the change order is being undone rather than promoted: the restore must be 'Before:ChangeOrder:' the same change order, the change order must have an AbortedReason -- undoing a change nobody has said is not coming is a race with whoever is still promoting it -- and a Unit the change order never marked is an error rather than passed over, since naming it says the Unit is part of the undoing. The first restore mints the change order's restore Tag and records it as RestoreTagID; every restore after that marks with the same Tag, which is what RestoredSpaceIDs is read off. A Unit the change order carried nothing for takes the restore Tag on the revision its start and end Tags are already on, and no revision is made. A Unit already carrying the restore Tag has had the change order taken back out of it and is passed over, since undoing one in a Unit happens once as promoting it into one does -- so the revisions a Unit has taken since it was undone are its own work rather than this undoing's to drop. Restoring also advances the merge pointers of the Links of the change order's UpdateType that follow the restored Unit onto the revision the restore made, so a later upgrade does not replay the change that was just taken out; the downstream Units are not restored with it, since each has to be restored and released on its own account. */
15312
15318
  changeOrder?: string;
15313
- /** With change_order, when promoting it by upgrade or resolve: what to do for a Unit whose last merged revision of its source is before the revision the change order starts at there -- typically because a Link in the source's Space, such as a TransformPaths Link, wrote revisions after the Unit last merged, and those revisions are not the change order's. Include (the default) merges them first, walking them one source revision at a time even with squash, as revisions that do not carry the change order, and places the change order's start Tag on the revision they leave, so 'restore Before:ChangeOrder:uuid' keeps them. Skip merges only the change order's range, as though the Unit's merge pointer had already been advanced to the change order's start, so what those revisions changed does not reach the Unit. Error refuses, naming the Unit, the Link, and each of those revisions with the operation and Link that made it. A Unit that has already merged past the change order's start is an error whatever this says. */
15319
+ /** With change_order, when promoting it by upgrade or resolve: what to do for a Unit whose last merged revision of its source is before the revision the change order starts at there -- typically because a Link in the source's Space, such as a TransformPaths Link, wrote revisions after the Unit last merged, and those revisions are not the change order's. Include (the default) merges them first, walking them one source revision at a time even with squash, as revisions that do not carry the change order, and places the change order's start Tag on the revision they leave, so 'restore Before:ChangeOrder:uuid' keeps them. Skip merges only the change order's range, as though the Unit's merge pointer had already been advanced to the change order's start, so what those revisions changed does not reach the Unit. Error refuses, naming the Unit, the Link, and each of those revisions with the operation and Link that made it. All merges them as Include does. A Unit that has already merged past the change order's start is an error whatever this says. Defaults to the change order's PriorRevisions. */
15314
15320
  priorRevisions?: string;
15315
15321
  /** User-defined category for the Mutation. Must be alphanumeric, at most 64 characters. The prefix 'ConfigHub' is reserved. */
15316
15322
  subgroup?: string;
@@ -18411,6 +18417,10 @@ type ChangeOrder = {
18411
18417
  };
18412
18418
  /** Permissions to access this change order. */
18413
18419
  Permissions?: Permissions;
18420
+ /** How the ChangeOrder marks the Units its change does not change, and the default PriorRevisions for its promotions. Include (the default), Skip and Error mark such a Unit at the Revision its followers have taken, or at its LastReleasedRevisionNum when that is later, or at its head if it has neither, so promoting the change does not move it; a promotion then merges a changed Unit's Revisions from before the change (Include), passes over them for good (Skip), or refuses (Error). All marks every such Unit at its head, so promoting the change brings every Unit up to the Space it takes from. Immutable: the ChangeOrder's own Space is marked when it is created. */
18421
+ PriorRevisions?: "Include" | "Skip" | "Error" | "All";
18422
+ /** What a Release of the ChangeOrder does with a bundled Unit's Revisions from before the change: those after its LastReleasedRevisionNum, up to the one the start Tag marks. Include (the default) releases them; Error refuses the publish, naming them and the ChangeOrders they belong to. A publish's PriorRevisions overrides it. */
18423
+ ReleasePriorRevisions?: "Include" | "Error";
18414
18424
  /** Unique URL-safe identifier for the entity. */
18415
18425
  Slug: string;
18416
18426
  /** SpaceFilterID references a Filter (with From=Space) selecting where the ChangeOrder is headed, ANDed with WhereSpace when both are set. While either is set, the server evaluates the selection into InScopeSpaceIDs. */
@@ -18501,7 +18511,7 @@ type ChangeWorkflowFinalStage = {
18501
18511
  type ChangeWorkflowStage = {
18502
18512
  /** Identifies the stage within the workflow, and is what a promotion reports the change as having entered. Unique within a workflow. */
18503
18513
  Name: string;
18504
- /** The stage's entry gates, each naming a built-in check or one declared in CustomPrerequisites. Evaluated over every Space of the stage ahead of this one, so the first stage's are never evaluated. */
18514
+ /** The stage's entry gates, each naming a built-in check or one declared in CustomPrerequisites. Evaluated over every Space of the stage before this one; the first stage's are evaluated over the Space the ChangeOrder resides in, and refused for Invoke and fan-out ChangeOrders, whose change is in no Space before it is promoted. */
18505
18515
  Prerequisites?: string[];
18506
18516
  /** Gates on publishing a Release for a change order in one of the stage's Spaces, each naming one declared in AttestationPrerequisites. Evaluated over the Revisions the Release bundles. */
18507
18517
  ReleasePrerequisites?: string[];
@@ -18643,12 +18653,18 @@ type ChangeOrderRead = {
18643
18653
  };
18644
18654
  /** Permissions to access this change order. */
18645
18655
  Permissions?: Permissions;
18656
+ /** How the ChangeOrder marks the Units its change does not change, and the default PriorRevisions for its promotions. Include (the default), Skip and Error mark such a Unit at the Revision its followers have taken, or at its LastReleasedRevisionNum when that is later, or at its head if it has neither, so promoting the change does not move it; a promotion then merges a changed Unit's Revisions from before the change (Include), passes over them for good (Skip), or refuses (Error). All marks every such Unit at its head, so promoting the change brings every Unit up to the Space it takes from. Immutable: the ChangeOrder's own Space is marked when it is created. */
18657
+ PriorRevisions?: "Include" | "Skip" | "Error" | "All";
18646
18658
  /** PromotionFailures records each promotion that did not complete: who ran it, when, into which Stage, and each Space it failed or was blocked in, with the Space's error or reason and the error of each Unit and Link whose write failed. The most recent entries are kept. Set by the server. (readonly) */
18647
18659
  PromotionFailures?: ChangeOrderPromotionFailure[];
18648
18660
  /** PromotionOverrides records each promotion forced into a Stage whose gates did not hold: who forced it, when, into which Stage and Spaces, why, and which gates failed. The most recent entries are kept. Set by the server. (readonly) */
18649
18661
  PromotionOverrides?: ChangeOrderPromotionOverride[];
18650
18662
  /** Promotions records each promotion that wrote the change into Spaces: who ran it, when, into which Stage, and which Spaces. A promotion entering several Stages records one entry per Stage. The most recent entries are kept. Set by the server. (readonly) */
18651
18663
  Promotions?: ChangeOrderPromotion[];
18664
+ /** What a Release of the ChangeOrder does with a bundled Unit's Revisions from before the change: those after its LastReleasedRevisionNum, up to the one the start Tag marks. Include (the default) releases them; Error refuses the publish, naming them and the ChangeOrders they belong to. A publish's PriorRevisions overrides it. */
18665
+ ReleasePriorRevisions?: "Include" | "Error";
18666
+ /** ReleaseTagID is the Tag a Release of the ChangeOrder is published at. It marks one Revision of each releasable Unit (ProviderType empty or OCI) in every Space the change is in: the Revision the end Tag marks, or the head where the Unit does not carry it. It follows Revisions the resolve processor makes after the promotion, and can be moved with a tag move, until a Release in the Space has been published at it. Empty on ChangeOrders created before it existed. */
18667
+ ReleaseTagID?: string;
18652
18668
  /** ReleasedRestoredSpaceIDs is where the undoing has been released: the Spaces in RestoredSpaceIDs whose Units are released at or past the Revision the restore Tag marks. Covering ReleasedSpaceIDs is what State reports as RestoreReleased. Derived when the ChangeOrder is read. */
18653
18669
  ReleasedRestoredSpaceIDs?: Uuid[];
18654
18670
  /** ReleasedSpaceIDs is where the ChangeOrder has been released: the Spaces in scope whose Units in the Space's release are applied at or past the Revision the end Tag marks. A Space with no ReleaseTargetID is never here, since nothing releases it. Derived when the ChangeOrder is read. */
@@ -18685,6 +18701,8 @@ type ChangeOrderRead = {
18685
18701
  UpdateType?: string;
18686
18702
  /** The timestamp when the entity was last updated in "2023-01-01T12:00:00Z" format. */
18687
18703
  UpdatedAt?: string;
18704
+ /** The User who created the ChangeOrder. Absent for ChangeOrders created before it was recorded. (readonly) */
18705
+ UserID?: string;
18688
18706
  /** An entity-specific sequence number used for optimistic concurrency control. The value read must be sent in calls to Update. */
18689
18707
  Version?: number;
18690
18708
  /** Filter expression selecting where the ChangeOrder is headed, ANDed with SpaceFilterID when both are set. While either is set, the server evaluates the selection into InScopeSpaceIDs when the ChangeOrder is created, when either field changes, and on an update or patch with refresh_spaces. The specified string is an expression for the purpose of filtering
@@ -19022,6 +19040,7 @@ type ExtendedChangeOrder = {
19022
19040
  Error?: ResponseError;
19023
19041
  Invocation?: Invocation;
19024
19042
  Organization?: Organization;
19043
+ ReleaseTag?: Tag;
19025
19044
  RestoreTag?: Tag;
19026
19045
  Space?: Space;
19027
19046
  SpaceFilter?: Filter;
@@ -19034,6 +19053,7 @@ type ExtendedChangeOrderRead = {
19034
19053
  Error?: ResponseError;
19035
19054
  Invocation?: InvocationRead;
19036
19055
  Organization?: OrganizationRead;
19056
+ ReleaseTag?: TagRead;
19037
19057
  RestoreTag?: TagRead;
19038
19058
  Space?: SpaceRead;
19039
19059
  SpaceFilter?: FilterRead;
@@ -20331,7 +20351,7 @@ type PromoteUnitResult = {
20331
20351
  Mutations?: ResourceMutationList;
20332
20352
  PreviousHeadMutationNum?: number;
20333
20353
  PreviousHeadRevisionNum?: number;
20334
- /** For Skip and Unchanged: NotCovered, CreatedAfterChangeOrder, AlreadyTaken, or, for a Unit created in this Space, why the ChangeOrder does not cover it. For Mark: CreatedInSpace, when the Unit was created in this Space and the ChangeOrder is scoped over it. For an applied Upgrade or Resolve: NoChange, when the Unit already held the change, so no Revision was made and the ChangeOrder's Tags mark its head. */
20354
+ /** For Skip and Unchanged: NotCovered, CreatedAfterChangeOrder, AlreadyTaken, NotChanged when the change does not change the Unit, or CreatedInSpace when the Unit was created in this Space rather than cloned into it. A Unit in the Space that the change does not change is marked once the Space's writes are done, with both Tags on the Revision the ChangeOrder's PriorRevisions names. For an applied Upgrade or Resolve: NoChange, when the Unit already held the change, so no Revision was made and the ChangeOrder's Tags mark its head. */
20335
20355
  Reason?: string;
20336
20356
  Slug?: string;
20337
20357
  /** Absent for a clone a dry run would create. */
@@ -20406,8 +20426,8 @@ type PromoteRequest = {
20406
20426
  ForceReason?: string;
20407
20427
  /** Reasons to record on the paths each Unit write changes. A later operation must be cleared for them before overwriting those paths. Clearance must cover them, since a write is withheld by guards it is not cleared for, its own included. */
20408
20428
  Guards?: GuardStamp;
20409
- /** With a ChangeOrder, what to do for a Unit whose last merged upstream Revision is before the ChangeOrder's start there -- typically because a Link in the upstream Space, such as a TransformPaths Link, wrote Revisions after the Unit last merged. Include (the default) merges those Revisions first, as Revisions of their own that do not carry the ChangeOrder, and then the ChangeOrder's range; Skip merges only the ChangeOrder's range, as though the Unit had already merged as far as its start; Error refuses, naming the Revisions. A Unit that has merged past the ChangeOrder's start is an error whatever this says. Refused with an Insert, Upsert, or TransformPaths ChangeOrder, whose Links read their sources as they are at its end rather than merging a range. */
20410
- PriorRevisions?: "Include" | "Skip" | "Error";
20429
+ /** With a ChangeOrder, what to do for a Unit whose last merged upstream Revision is before the ChangeOrder's start there -- typically because a Link in the upstream Space, such as a TransformPaths Link, wrote Revisions after the Unit last merged. Include merges those Revisions first, as Revisions of their own that do not carry the ChangeOrder, and then the ChangeOrder's range; Skip merges only the ChangeOrder's range, as though the Unit had already merged as far as its start, and those Revisions do not arrive later; Error refuses, naming the Revisions; All merges them as Include does, and also marks every Unit in the Space the change does not change at its head, so the next promotion brings it up to this Space. Defaults to the ChangeOrder's PriorRevisions, or Include. A Unit that has merged past the ChangeOrder's start is an error whatever this says. Refused with an Insert, Upsert, or TransformPaths ChangeOrder, whose Links read their sources as they are at its end rather than merging a range. */
20430
+ PriorRevisions?: "Include" | "Skip" | "Error" | "All";
20411
20431
  /** Record the paths each Unit write changes as protected local overrides, so a later merge from upstream does not overwrite them. By default a write claims nothing and each path keeps the protection it already had. Accepted only for an Invoke ChangeOrder and for one that follows Insert, Upsert, or TransformPaths Links: refused for a promotion that merges, which protection holds paths against. */
20412
20432
  Protect?: boolean;
20413
20433
  /** A Filter over Spaces selecting the Spaces to promote. Intersected with the other selectors. */
@@ -20510,6 +20530,10 @@ type ReleaseRead = {
20510
20530
  ReleaseID?: string;
20511
20531
  /** Monotonically increasing sequence number of the Release within its Target, assigned at publish time. The highest ReleaseNum is the latest Release for the Target. */
20512
20532
  ReleaseNum?: number;
20533
+ /** SkippedUnits names the Units assigned to the Release's Target that the Release does not bundle, mapped to the reason. Publishing with a TagID leaves out a Unit that has never been released and that the Tag marks no Revision of; a Unit that has been released must be marked. (readonly) */
20534
+ SkippedUnits?: {
20535
+ [key: string]: string;
20536
+ };
20513
20537
  SpaceID?: string;
20514
20538
  /** Slug of the Space this entity belongs to. */
20515
20539
  SpaceSlug?: string;
@@ -21531,19 +21555,23 @@ type ReleasePublishRequest = {
21531
21555
  };
21532
21556
  /** Optional override of the name of the Release's tar.gz bundle. */
21533
21557
  BundleBaseName?: string;
21534
- /** Optional ID of the ChangeOrder the Release is published for. It is recorded as the Release's ChangeOrderID, and the ChangeOrder's Stage is advanced in the same transaction. */
21558
+ /** Optional ID of the ChangeOrder the Release is published for. It is recorded as the Release's ChangeOrderID, and the ChangeOrder's Stage is advanced in the same transaction. The Release is bundled at the ChangeOrder's release Tag (ReleaseTagID): TagID may be omitted, or name that Tag or the ChangeOrder's end Tag, which is taken to mean it; any other TagID is refused. Naming a ChangeOrder's release Tag as TagID without ChangeOrderID publishes for that ChangeOrder. */
21535
21559
  ChangeOrderID?: string;
21536
21560
  /** An optional set of gates that, if any is present, will block deletion */
21537
21561
  DeleteGates?: {
21538
21562
  [key: string]: boolean;
21539
21563
  };
21564
+ /** Publish in a transaction that is rolled back, returning the Release that would be published, or the error publishing would return: the same ChangeSet, validation and ReleasePrerequisites checks run against the Revisions it would bundle. No event is emitted and no Stage is advanced. */
21565
+ DryRun?: boolean;
21540
21566
  /** An optional map of Label key/value pairs to specify identifying attributes of entities for the purpose of grouping and filtering them. */
21541
21567
  Labels?: {
21542
21568
  [key: string]: string;
21543
21569
  };
21544
21570
  /** Optional Permissions to access the Release. Its publisher is granted Manage in addition. */
21545
21571
  Permissions?: Permissions;
21546
- /** Optional Tag ID identifying the tagged Revision to bundle. For each Unit assigned to the Space's ReleaseTarget, the highest-numbered Revision carrying this Tag is bundled at that Revision instead of the Unit's head Revision. A Unit with no matching tagged Revision falls back to its head Revision. When omitted, each Unit is bundled at its head Revision and publishing creates a Tag named release-<ReleaseNum>, applies it to each bundled Revision, and sets it as the Release's TagID. */
21572
+ /** For a Release of a ChangeOrder, what to do with a bundled Unit's Revisions from before the change: those after its LastReleasedRevisionNum up to the one the ChangeOrder's start Tag marks. Include releases them; Error refuses the publish, naming them and the ChangeOrders they belong to. Defaults to the ChangeOrder's ReleasePriorRevisions, or Include. */
21573
+ PriorRevisions?: "Include" | "Error";
21574
+ /** Optional Tag ID identifying the tagged Revision to bundle. For each Unit assigned to the Space's ReleaseTarget, the highest-numbered Revision carrying this Tag is bundled at that Revision instead of the Unit's head Revision. A Unit with no matching tagged Revision is left out of the bundle and listed in the Release's SkippedUnits when it has never been released, and refuses the publish when it has. When omitted, each Unit is bundled at its head Revision and publishing creates a Tag named release-<ReleaseNum>, applies it to each bundled Revision, and sets it as the Release's TagID. */
21547
21575
  TagID?: string;
21548
21576
  };
21549
21577
  type ExtendedTag = {
@@ -22072,6 +22100,8 @@ type UnitTagResponse = {
22072
22100
  Message?: string;
22073
22101
  };
22074
22102
  type UnitTagRequest = {
22103
+ /** Move the Tag from the Revision it marks on each Unit to the one Revision names, refusing a Unit it marks no Revision of. Tags owned by a ChangeSet, ChangeOrder or Release cannot be added or removed; a ChangeOrder's release Tag can be moved, to a Revision at or after the one its end Tag marks and the Unit's LastReleasedRevisionNum, with no ValidationErrors, while no Release in the Space has been published at it. */
22104
+ Move?: boolean;
22075
22105
  /** Which Unit revision to tag: a named revision ('HeadRevisionNum', 'LastReleasedRevisionNum'), a revision number, an entity reference ('Tag:uuid', 'ChangeSet:uuid', 'Revision:uuid'), any of those prefixed with 'Before:', or 'Remove' to remove the tag from the unit */
22076
22106
  Revision?: string;
22077
22107
  TagID?: string;