@confighub/api 0.9.7 → 0.9.9

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
@@ -298,6 +298,26 @@ interface paths {
298
298
  patch: operations["BulkPatchChangeOrders"];
299
299
  trace?: never;
300
300
  };
301
+ "/change_order/refresh_stage": {
302
+ parameters: {
303
+ query?: never;
304
+ header?: never;
305
+ path?: never;
306
+ cookie?: never;
307
+ };
308
+ get?: never;
309
+ put?: never;
310
+ /**
311
+ * Refresh the Stage of multiple change orders
312
+ * @description Work out the ChangeOrder's Stage again from the Releases, live status, Attestations and validation results it depends on, for when one of them changed without the Stage being worked out, such as a Space taking the change by an upgrade or a resolve rather than a promotion. Requires Use permission on the ChangeOrder. Each ChangeOrder selected by query parameters is refreshed on its own.
313
+ */
314
+ post: operations["BulkRefreshChangeOrderStages"];
315
+ delete?: never;
316
+ options?: never;
317
+ head?: never;
318
+ patch?: never;
319
+ trace?: never;
320
+ };
301
321
  "/change_set": {
302
322
  parameters: {
303
323
  query?: never;
@@ -1728,6 +1748,26 @@ interface paths {
1728
1748
  patch: operations["PatchChangeOrder"];
1729
1749
  trace?: never;
1730
1750
  };
1751
+ "/space/{space_id}/change_order/{change_order_id}/refresh_stage": {
1752
+ parameters: {
1753
+ query?: never;
1754
+ header?: never;
1755
+ path?: never;
1756
+ cookie?: never;
1757
+ };
1758
+ get?: never;
1759
+ put?: never;
1760
+ /**
1761
+ * Refresh the selected ChangeOrder's Stage
1762
+ * @description Work out the ChangeOrder's Stage again from the Releases, live status, Attestations and validation results it depends on, for when one of them changed without the Stage being worked out, such as a Space taking the change by an upgrade or a resolve rather than a promotion. Requires Use permission on the ChangeOrder.
1763
+ */
1764
+ post: operations["RefreshChangeOrderStage"];
1765
+ delete?: never;
1766
+ options?: never;
1767
+ head?: never;
1768
+ patch?: never;
1769
+ trace?: never;
1770
+ };
1731
1771
  "/space/{space_id}/change_set": {
1732
1772
  parameters: {
1733
1773
  query?: never;
@@ -2437,7 +2477,7 @@ interface paths {
2437
2477
  post?: never;
2438
2478
  /**
2439
2479
  * Delete the selected Release
2440
- * @description Delete the selected Release, removing it and its stored bundle
2480
+ * @description Delete the selected Release, removing it and its stored bundle. Deleting changes what is served to the cluster behind the release Target, so it requires TargetEditChildren on the Release's Space as well as Edit on the Release.
2441
2481
  */
2442
2482
  delete: operations["DeleteRelease"];
2443
2483
  options?: never;
@@ -2480,7 +2520,7 @@ interface paths {
2480
2520
  put?: never;
2481
2521
  /**
2482
2522
  * Withdraw the selected Release
2483
- * @description Withdraw the selected Release, clearing its Published flag so it is no longer available for download. The Release itself is retained; delete it to remove it entirely.
2523
+ * @description Withdraw the selected Release, clearing its Published flag so it is no longer available for download. The Release itself is retained; delete it to remove it entirely. Withdrawing changes what is served to the cluster behind the release Target, so it requires TargetEditChildren on the Release's Space as well as Edit on the Release.
2484
2524
  */
2485
2525
  post: operations["WithdrawRelease"];
2486
2526
  delete?: never;
@@ -15027,6 +15067,199 @@ interface operations {
15027
15067
  };
15028
15068
  };
15029
15069
  };
15070
+ BulkRefreshChangeOrderStages: {
15071
+ parameters: {
15072
+ query?: {
15073
+ /**
15074
+ * @description The specified string is an expression for the purpose of filtering
15075
+ * the list of ChangeOrders returned. The expression syntax was inspired by SQL.
15076
+ * It supports conjunctions using `AND` of relational expressions of the form *attribute*
15077
+ * *operator* *attribute_or_literal*. The attribute names are case-sensitive and PascalCase,
15078
+ * as in the JSON encoding.
15079
+ * Strings support the following operators: `<`, `>`, `<=`, `>=`, `=`, `!=`, `LIKE`, `NOT LIKE`, `ILIKE`, `~~`, `!~~`, `~`, `~*`, `!~`, `!~*`, `IN`, `NOT IN`.
15080
+ * String pattern operators: `LIKE` and `~~` for pattern matching with `%` and `_` wildcards,
15081
+ * `ILIKE` for case-insensitive pattern matching, `NOT LIKE` and `!~~` for negated pattern matching.
15082
+ * String regex operators: `~` for regex matching, `~*` for case-insensitive regex,
15083
+ * `!~` and `!~*` for regex not matching (case-sensitive and insensitive).
15084
+ * Integers support the following operators: `<`, `>`, `<=`, `>=`, `=`, `!=`, `IN`, `NOT IN`.
15085
+ * UUIDs and boolean attributes support equality and inequality only.
15086
+ * UUID and time literals must be quoted as string literals.
15087
+ * String literals are quoted with single quotes, such as `'string'`.
15088
+ * Time literals use the same form as when serialized as JSON,
15089
+ * such as: `CreatedAt > '2025-02-18T23:16:34'`.
15090
+ * Integer and boolean literals are also supported for attributes of those types.
15091
+ * Arrays support the `?` operator to to match any element of the array,
15092
+ * as in `FromLinkID ? '7c61626f-ddbe-41af-93f6-b69f4ab6d308'`.
15093
+ * Arrays can perform LEN() to check for length, as in `LEN(FromLinkID) > 0`.
15094
+ * An attribute naming a list of other entities can be filtered on their attributes with a `*` segment,
15095
+ * as in `FromLink.*.Slug = 'upgrade-app'`, which holds when any element satisfies it.
15096
+ * Without the `*` such a reference is an error, since it names no single value to compare.
15097
+ * Map support the dot notation to specify a particular map key, as in `Labels.tier = 'Backend'`.
15098
+ * Maps support `IS NULL` and `IS NOT NULL` with dot notation to check for key absence or presence,
15099
+ * as in `Labels.tier IS NULL` (key doesn't exist) or `Labels.tier IS NOT NULL` (key exists).
15100
+ * Comparison results can be tested with `IS TRUE`, `IS FALSE`, `IS NOT TRUE`, and `IS NOT FALSE`.
15101
+ * These are useful for nullable columns: `MergeSourceID = '<uuid>' IS NOT FALSE` matches rows where MergeSourceID equals the value OR is NULL.
15102
+ * The `IN` and `NOT IN` operators accept a comma-separated list of values in parentheses,
15103
+ * such as `Slug IN ('slugone', 'slugtwo')` or `Labels.environment IN ('prod', 'staging')`.
15104
+ * Conjunctions are supported using the `AND` operator.
15105
+ * An example conjunction is:
15106
+ * `CreatedAt >= '2025-01-07' AND Slug = 'test' AND Labels.mykey = 'myvalue'`.
15107
+ *
15108
+ * 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, ReviewRequests, SkippedUnits, Slug, SpaceFilterID, SpaceID, Stage, StartTagID, State, UnitFilterID, UpdateType, UpdatedAt, UserID, WhereSpace, WhereUnit.
15109
+ *
15110
+ * The whole string must be query-encoded.
15111
+ */
15112
+ where?: string;
15113
+ /**
15114
+ * @description UUID of a Filter entity to apply to the ChangeOrder list.
15115
+ *
15116
+ * The Filter must be in the same Organization as the user credentials.
15117
+ *
15118
+ * The Filter's From field must match the entity type being filtered (ChangeOrder).
15119
+ *
15120
+ * For Space-resident entities, if the Filter has a FromSpaceID, it must match the operation's SpaceID.
15121
+ *
15122
+ * The Filter's Where clause will be combined with any explicit 'where' parameter using AND logic.
15123
+ *
15124
+ * If both 'filter' and 'where' parameters are specified, they are combined with AND logic.
15125
+ */
15126
+ filter?: string;
15127
+ /**
15128
+ * @description Free text search that approximately matches the specified string against string fields and map keys/values.
15129
+ *
15130
+ * The search is case-insensitive and uses pattern matching to find entities containing the text.
15131
+ *
15132
+ * Searchable string fields include attributes like Slug, DisplayName, and string-typed custom fields.
15133
+ *
15134
+ * For map fields (like Labels and Annotations), the search matches both map keys and values.
15135
+ *
15136
+ * The search uses OR logic across all searchable fields, so matching any field will return the entity.
15137
+ *
15138
+ * If both 'where' and 'contains' parameters are specified, they are combined with AND logic.
15139
+ *
15140
+ * Searchable fields for ChangeOrder include string and map-type attributes from the queryable attributes list.
15141
+ *
15142
+ * The whole string must be query-encoded.
15143
+ */
15144
+ contains?: string;
15145
+ /**
15146
+ * @description Hidden ChangeOrder entities, those with a HiddenReason, are left out of the results, or of what a bulk operation acts on, unless this names their HiddenReason.
15147
+ *
15148
+ * It is a comma-separated list of HiddenReasons, or `*` for all of them.
15149
+ *
15150
+ * 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.
15151
+ *
15152
+ * ConfigHub/YAML Units, which hold the configuration of entities, are hidden with the HiddenReason `BackingUnit`.
15153
+ */
15154
+ include_hidden?: string;
15155
+ /**
15156
+ * @description Include clause for expanding related entities in the response for ChangeOrder.
15157
+ * The attribute names are case-sensitive, PascalCase, and
15158
+ * expected in a comma-separated list format as in the JSON encoding.
15159
+ *
15160
+ * Supported attributes for ChangeOrder are EndTagID, InvocationID, OrganizationID, ReleaseTagID, RestoreTagID, SpaceFilterID, SpaceID, StartTagID, UnitFilterID.
15161
+ *
15162
+ * The whole string must be query-encoded.
15163
+ */
15164
+ include?: string;
15165
+ /** @description Maximum number of ChangeOrder 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. */
15166
+ limit?: number;
15167
+ /** @description The token from the ConfigHub-Continue header of the previous request, to act on the ChangeOrder 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. */
15168
+ continue?: string;
15169
+ /** @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. */
15170
+ dry_run?: boolean;
15171
+ };
15172
+ header?: never;
15173
+ path?: never;
15174
+ cookie?: never;
15175
+ };
15176
+ requestBody?: never;
15177
+ responses: {
15178
+ /** @description OK */
15179
+ 200: {
15180
+ headers: {
15181
+ /** @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. */
15182
+ "ConfigHub-Continue"?: string;
15183
+ [name: string]: unknown;
15184
+ };
15185
+ content: {
15186
+ "application/json": components["schemas"]["ChangeOrderCreateOrUpdateResponse"][];
15187
+ };
15188
+ };
15189
+ /** @description Multi-Status: Mixed success and failure results */
15190
+ 207: {
15191
+ headers: {
15192
+ [name: string]: unknown;
15193
+ };
15194
+ content: {
15195
+ "application/json": components["schemas"]["ChangeOrderCreateOrUpdateResponse"][];
15196
+ };
15197
+ };
15198
+ /** @description ChangeOrder request is invalid (Bad Request). */
15199
+ 400: {
15200
+ headers: {
15201
+ [name: string]: unknown;
15202
+ };
15203
+ content: {
15204
+ "application/json": components["schemas"]["StandardErrorResponse"];
15205
+ };
15206
+ };
15207
+ /** @description Unauthorized access. */
15208
+ 401: {
15209
+ headers: {
15210
+ [name: string]: unknown;
15211
+ };
15212
+ content: {
15213
+ "application/json": components["schemas"]["StandardErrorResponse"];
15214
+ };
15215
+ };
15216
+ /** @description Forbidden access. */
15217
+ 403: {
15218
+ headers: {
15219
+ [name: string]: unknown;
15220
+ };
15221
+ content: {
15222
+ "application/json": components["schemas"]["StandardErrorResponse"];
15223
+ };
15224
+ };
15225
+ /** @description ChangeOrder not found. */
15226
+ 404: {
15227
+ headers: {
15228
+ [name: string]: unknown;
15229
+ };
15230
+ content: {
15231
+ "application/json": components["schemas"]["StandardErrorResponse"];
15232
+ };
15233
+ };
15234
+ /** @description ChangeOrder data conflict. Data has changed since last read. */
15235
+ 409: {
15236
+ headers: {
15237
+ [name: string]: unknown;
15238
+ };
15239
+ content: {
15240
+ "application/json": components["schemas"]["StandardErrorResponse"];
15241
+ };
15242
+ };
15243
+ /** @description Something went wrong while processing ChangeOrder. */
15244
+ 500: {
15245
+ headers: {
15246
+ [name: string]: unknown;
15247
+ };
15248
+ content: {
15249
+ "application/json": components["schemas"]["StandardErrorResponse"];
15250
+ };
15251
+ };
15252
+ /** @description Unexpected error. */
15253
+ default: {
15254
+ headers: {
15255
+ [name: string]: unknown;
15256
+ };
15257
+ content: {
15258
+ "application/json": components["schemas"]["StandardErrorResponse"];
15259
+ };
15260
+ };
15261
+ };
15262
+ };
15030
15263
  ListAllChangeSets: {
15031
15264
  parameters: {
15032
15265
  query?: {
@@ -33267,6 +33500,97 @@ interface operations {
33267
33500
  };
33268
33501
  };
33269
33502
  };
33503
+ RefreshChangeOrderStage: {
33504
+ parameters: {
33505
+ query?: {
33506
+ /** @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. */
33507
+ dry_run?: boolean;
33508
+ };
33509
+ header?: never;
33510
+ path: {
33511
+ /** @description Unique identifier for a space_id */
33512
+ space_id: string;
33513
+ /** @description Unique identifier for a change_order_id */
33514
+ change_order_id: string;
33515
+ };
33516
+ cookie?: never;
33517
+ };
33518
+ requestBody?: never;
33519
+ responses: {
33520
+ /** @description Defines a change's identity as it moves between Spaces. */
33521
+ 200: {
33522
+ headers: {
33523
+ [name: string]: unknown;
33524
+ };
33525
+ content: {
33526
+ "application/json": components["schemas"]["ChangeOrder"];
33527
+ };
33528
+ };
33529
+ /** @description ChangeOrder request is invalid (Bad Request). */
33530
+ 400: {
33531
+ headers: {
33532
+ [name: string]: unknown;
33533
+ };
33534
+ content: {
33535
+ "application/json": components["schemas"]["StandardErrorResponse"];
33536
+ };
33537
+ };
33538
+ /** @description Unauthorized access. */
33539
+ 401: {
33540
+ headers: {
33541
+ [name: string]: unknown;
33542
+ };
33543
+ content: {
33544
+ "application/json": components["schemas"]["StandardErrorResponse"];
33545
+ };
33546
+ };
33547
+ /** @description Forbidden access. */
33548
+ 403: {
33549
+ headers: {
33550
+ [name: string]: unknown;
33551
+ };
33552
+ content: {
33553
+ "application/json": components["schemas"]["StandardErrorResponse"];
33554
+ };
33555
+ };
33556
+ /** @description ChangeOrder not found. */
33557
+ 404: {
33558
+ headers: {
33559
+ [name: string]: unknown;
33560
+ };
33561
+ content: {
33562
+ "application/json": components["schemas"]["StandardErrorResponse"];
33563
+ };
33564
+ };
33565
+ /** @description ChangeOrder data conflict. Data has changed since last read. */
33566
+ 409: {
33567
+ headers: {
33568
+ [name: string]: unknown;
33569
+ };
33570
+ content: {
33571
+ "application/json": components["schemas"]["StandardErrorResponse"];
33572
+ };
33573
+ };
33574
+ /** @description Something went wrong while processing ChangeOrder. */
33575
+ 500: {
33576
+ headers: {
33577
+ [name: string]: unknown;
33578
+ };
33579
+ content: {
33580
+ "application/json": components["schemas"]["StandardErrorResponse"];
33581
+ };
33582
+ };
33583
+ /** @description Unexpected error. */
33584
+ default: {
33585
+ headers: {
33586
+ [name: string]: unknown;
33587
+ };
33588
+ content: {
33589
+ "application/json": components["schemas"]["StandardErrorResponse"];
33590
+ };
33591
+ };
33592
+ };
33593
+ };
33270
33594
  ListChangeSets: {
33271
33595
  parameters: {
33272
33596
  query?: {
package/dist/index.d.ts CHANGED
@@ -298,6 +298,26 @@ interface paths {
298
298
  patch: operations["BulkPatchChangeOrders"];
299
299
  trace?: never;
300
300
  };
301
+ "/change_order/refresh_stage": {
302
+ parameters: {
303
+ query?: never;
304
+ header?: never;
305
+ path?: never;
306
+ cookie?: never;
307
+ };
308
+ get?: never;
309
+ put?: never;
310
+ /**
311
+ * Refresh the Stage of multiple change orders
312
+ * @description Work out the ChangeOrder's Stage again from the Releases, live status, Attestations and validation results it depends on, for when one of them changed without the Stage being worked out, such as a Space taking the change by an upgrade or a resolve rather than a promotion. Requires Use permission on the ChangeOrder. Each ChangeOrder selected by query parameters is refreshed on its own.
313
+ */
314
+ post: operations["BulkRefreshChangeOrderStages"];
315
+ delete?: never;
316
+ options?: never;
317
+ head?: never;
318
+ patch?: never;
319
+ trace?: never;
320
+ };
301
321
  "/change_set": {
302
322
  parameters: {
303
323
  query?: never;
@@ -1728,6 +1748,26 @@ interface paths {
1728
1748
  patch: operations["PatchChangeOrder"];
1729
1749
  trace?: never;
1730
1750
  };
1751
+ "/space/{space_id}/change_order/{change_order_id}/refresh_stage": {
1752
+ parameters: {
1753
+ query?: never;
1754
+ header?: never;
1755
+ path?: never;
1756
+ cookie?: never;
1757
+ };
1758
+ get?: never;
1759
+ put?: never;
1760
+ /**
1761
+ * Refresh the selected ChangeOrder's Stage
1762
+ * @description Work out the ChangeOrder's Stage again from the Releases, live status, Attestations and validation results it depends on, for when one of them changed without the Stage being worked out, such as a Space taking the change by an upgrade or a resolve rather than a promotion. Requires Use permission on the ChangeOrder.
1763
+ */
1764
+ post: operations["RefreshChangeOrderStage"];
1765
+ delete?: never;
1766
+ options?: never;
1767
+ head?: never;
1768
+ patch?: never;
1769
+ trace?: never;
1770
+ };
1731
1771
  "/space/{space_id}/change_set": {
1732
1772
  parameters: {
1733
1773
  query?: never;
@@ -2437,7 +2477,7 @@ interface paths {
2437
2477
  post?: never;
2438
2478
  /**
2439
2479
  * Delete the selected Release
2440
- * @description Delete the selected Release, removing it and its stored bundle
2480
+ * @description Delete the selected Release, removing it and its stored bundle. Deleting changes what is served to the cluster behind the release Target, so it requires TargetEditChildren on the Release's Space as well as Edit on the Release.
2441
2481
  */
2442
2482
  delete: operations["DeleteRelease"];
2443
2483
  options?: never;
@@ -2480,7 +2520,7 @@ interface paths {
2480
2520
  put?: never;
2481
2521
  /**
2482
2522
  * Withdraw the selected Release
2483
- * @description Withdraw the selected Release, clearing its Published flag so it is no longer available for download. The Release itself is retained; delete it to remove it entirely.
2523
+ * @description Withdraw the selected Release, clearing its Published flag so it is no longer available for download. The Release itself is retained; delete it to remove it entirely. Withdrawing changes what is served to the cluster behind the release Target, so it requires TargetEditChildren on the Release's Space as well as Edit on the Release.
2484
2524
  */
2485
2525
  post: operations["WithdrawRelease"];
2486
2526
  delete?: never;
@@ -15027,6 +15067,199 @@ interface operations {
15027
15067
  };
15028
15068
  };
15029
15069
  };
15070
+ BulkRefreshChangeOrderStages: {
15071
+ parameters: {
15072
+ query?: {
15073
+ /**
15074
+ * @description The specified string is an expression for the purpose of filtering
15075
+ * the list of ChangeOrders returned. The expression syntax was inspired by SQL.
15076
+ * It supports conjunctions using `AND` of relational expressions of the form *attribute*
15077
+ * *operator* *attribute_or_literal*. The attribute names are case-sensitive and PascalCase,
15078
+ * as in the JSON encoding.
15079
+ * Strings support the following operators: `<`, `>`, `<=`, `>=`, `=`, `!=`, `LIKE`, `NOT LIKE`, `ILIKE`, `~~`, `!~~`, `~`, `~*`, `!~`, `!~*`, `IN`, `NOT IN`.
15080
+ * String pattern operators: `LIKE` and `~~` for pattern matching with `%` and `_` wildcards,
15081
+ * `ILIKE` for case-insensitive pattern matching, `NOT LIKE` and `!~~` for negated pattern matching.
15082
+ * String regex operators: `~` for regex matching, `~*` for case-insensitive regex,
15083
+ * `!~` and `!~*` for regex not matching (case-sensitive and insensitive).
15084
+ * Integers support the following operators: `<`, `>`, `<=`, `>=`, `=`, `!=`, `IN`, `NOT IN`.
15085
+ * UUIDs and boolean attributes support equality and inequality only.
15086
+ * UUID and time literals must be quoted as string literals.
15087
+ * String literals are quoted with single quotes, such as `'string'`.
15088
+ * Time literals use the same form as when serialized as JSON,
15089
+ * such as: `CreatedAt > '2025-02-18T23:16:34'`.
15090
+ * Integer and boolean literals are also supported for attributes of those types.
15091
+ * Arrays support the `?` operator to to match any element of the array,
15092
+ * as in `FromLinkID ? '7c61626f-ddbe-41af-93f6-b69f4ab6d308'`.
15093
+ * Arrays can perform LEN() to check for length, as in `LEN(FromLinkID) > 0`.
15094
+ * An attribute naming a list of other entities can be filtered on their attributes with a `*` segment,
15095
+ * as in `FromLink.*.Slug = 'upgrade-app'`, which holds when any element satisfies it.
15096
+ * Without the `*` such a reference is an error, since it names no single value to compare.
15097
+ * Map support the dot notation to specify a particular map key, as in `Labels.tier = 'Backend'`.
15098
+ * Maps support `IS NULL` and `IS NOT NULL` with dot notation to check for key absence or presence,
15099
+ * as in `Labels.tier IS NULL` (key doesn't exist) or `Labels.tier IS NOT NULL` (key exists).
15100
+ * Comparison results can be tested with `IS TRUE`, `IS FALSE`, `IS NOT TRUE`, and `IS NOT FALSE`.
15101
+ * These are useful for nullable columns: `MergeSourceID = '<uuid>' IS NOT FALSE` matches rows where MergeSourceID equals the value OR is NULL.
15102
+ * The `IN` and `NOT IN` operators accept a comma-separated list of values in parentheses,
15103
+ * such as `Slug IN ('slugone', 'slugtwo')` or `Labels.environment IN ('prod', 'staging')`.
15104
+ * Conjunctions are supported using the `AND` operator.
15105
+ * An example conjunction is:
15106
+ * `CreatedAt >= '2025-01-07' AND Slug = 'test' AND Labels.mykey = 'myvalue'`.
15107
+ *
15108
+ * 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, ReviewRequests, SkippedUnits, Slug, SpaceFilterID, SpaceID, Stage, StartTagID, State, UnitFilterID, UpdateType, UpdatedAt, UserID, WhereSpace, WhereUnit.
15109
+ *
15110
+ * The whole string must be query-encoded.
15111
+ */
15112
+ where?: string;
15113
+ /**
15114
+ * @description UUID of a Filter entity to apply to the ChangeOrder list.
15115
+ *
15116
+ * The Filter must be in the same Organization as the user credentials.
15117
+ *
15118
+ * The Filter's From field must match the entity type being filtered (ChangeOrder).
15119
+ *
15120
+ * For Space-resident entities, if the Filter has a FromSpaceID, it must match the operation's SpaceID.
15121
+ *
15122
+ * The Filter's Where clause will be combined with any explicit 'where' parameter using AND logic.
15123
+ *
15124
+ * If both 'filter' and 'where' parameters are specified, they are combined with AND logic.
15125
+ */
15126
+ filter?: string;
15127
+ /**
15128
+ * @description Free text search that approximately matches the specified string against string fields and map keys/values.
15129
+ *
15130
+ * The search is case-insensitive and uses pattern matching to find entities containing the text.
15131
+ *
15132
+ * Searchable string fields include attributes like Slug, DisplayName, and string-typed custom fields.
15133
+ *
15134
+ * For map fields (like Labels and Annotations), the search matches both map keys and values.
15135
+ *
15136
+ * The search uses OR logic across all searchable fields, so matching any field will return the entity.
15137
+ *
15138
+ * If both 'where' and 'contains' parameters are specified, they are combined with AND logic.
15139
+ *
15140
+ * Searchable fields for ChangeOrder include string and map-type attributes from the queryable attributes list.
15141
+ *
15142
+ * The whole string must be query-encoded.
15143
+ */
15144
+ contains?: string;
15145
+ /**
15146
+ * @description Hidden ChangeOrder entities, those with a HiddenReason, are left out of the results, or of what a bulk operation acts on, unless this names their HiddenReason.
15147
+ *
15148
+ * It is a comma-separated list of HiddenReasons, or `*` for all of them.
15149
+ *
15150
+ * 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.
15151
+ *
15152
+ * ConfigHub/YAML Units, which hold the configuration of entities, are hidden with the HiddenReason `BackingUnit`.
15153
+ */
15154
+ include_hidden?: string;
15155
+ /**
15156
+ * @description Include clause for expanding related entities in the response for ChangeOrder.
15157
+ * The attribute names are case-sensitive, PascalCase, and
15158
+ * expected in a comma-separated list format as in the JSON encoding.
15159
+ *
15160
+ * Supported attributes for ChangeOrder are EndTagID, InvocationID, OrganizationID, ReleaseTagID, RestoreTagID, SpaceFilterID, SpaceID, StartTagID, UnitFilterID.
15161
+ *
15162
+ * The whole string must be query-encoded.
15163
+ */
15164
+ include?: string;
15165
+ /** @description Maximum number of ChangeOrder 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. */
15166
+ limit?: number;
15167
+ /** @description The token from the ConfigHub-Continue header of the previous request, to act on the ChangeOrder 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. */
15168
+ continue?: string;
15169
+ /** @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. */
15170
+ dry_run?: boolean;
15171
+ };
15172
+ header?: never;
15173
+ path?: never;
15174
+ cookie?: never;
15175
+ };
15176
+ requestBody?: never;
15177
+ responses: {
15178
+ /** @description OK */
15179
+ 200: {
15180
+ headers: {
15181
+ /** @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. */
15182
+ "ConfigHub-Continue"?: string;
15183
+ [name: string]: unknown;
15184
+ };
15185
+ content: {
15186
+ "application/json": components["schemas"]["ChangeOrderCreateOrUpdateResponse"][];
15187
+ };
15188
+ };
15189
+ /** @description Multi-Status: Mixed success and failure results */
15190
+ 207: {
15191
+ headers: {
15192
+ [name: string]: unknown;
15193
+ };
15194
+ content: {
15195
+ "application/json": components["schemas"]["ChangeOrderCreateOrUpdateResponse"][];
15196
+ };
15197
+ };
15198
+ /** @description ChangeOrder request is invalid (Bad Request). */
15199
+ 400: {
15200
+ headers: {
15201
+ [name: string]: unknown;
15202
+ };
15203
+ content: {
15204
+ "application/json": components["schemas"]["StandardErrorResponse"];
15205
+ };
15206
+ };
15207
+ /** @description Unauthorized access. */
15208
+ 401: {
15209
+ headers: {
15210
+ [name: string]: unknown;
15211
+ };
15212
+ content: {
15213
+ "application/json": components["schemas"]["StandardErrorResponse"];
15214
+ };
15215
+ };
15216
+ /** @description Forbidden access. */
15217
+ 403: {
15218
+ headers: {
15219
+ [name: string]: unknown;
15220
+ };
15221
+ content: {
15222
+ "application/json": components["schemas"]["StandardErrorResponse"];
15223
+ };
15224
+ };
15225
+ /** @description ChangeOrder not found. */
15226
+ 404: {
15227
+ headers: {
15228
+ [name: string]: unknown;
15229
+ };
15230
+ content: {
15231
+ "application/json": components["schemas"]["StandardErrorResponse"];
15232
+ };
15233
+ };
15234
+ /** @description ChangeOrder data conflict. Data has changed since last read. */
15235
+ 409: {
15236
+ headers: {
15237
+ [name: string]: unknown;
15238
+ };
15239
+ content: {
15240
+ "application/json": components["schemas"]["StandardErrorResponse"];
15241
+ };
15242
+ };
15243
+ /** @description Something went wrong while processing ChangeOrder. */
15244
+ 500: {
15245
+ headers: {
15246
+ [name: string]: unknown;
15247
+ };
15248
+ content: {
15249
+ "application/json": components["schemas"]["StandardErrorResponse"];
15250
+ };
15251
+ };
15252
+ /** @description Unexpected error. */
15253
+ default: {
15254
+ headers: {
15255
+ [name: string]: unknown;
15256
+ };
15257
+ content: {
15258
+ "application/json": components["schemas"]["StandardErrorResponse"];
15259
+ };
15260
+ };
15261
+ };
15262
+ };
15030
15263
  ListAllChangeSets: {
15031
15264
  parameters: {
15032
15265
  query?: {
@@ -33267,6 +33500,97 @@ interface operations {
33267
33500
  };
33268
33501
  };
33269
33502
  };
33503
+ RefreshChangeOrderStage: {
33504
+ parameters: {
33505
+ query?: {
33506
+ /** @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. */
33507
+ dry_run?: boolean;
33508
+ };
33509
+ header?: never;
33510
+ path: {
33511
+ /** @description Unique identifier for a space_id */
33512
+ space_id: string;
33513
+ /** @description Unique identifier for a change_order_id */
33514
+ change_order_id: string;
33515
+ };
33516
+ cookie?: never;
33517
+ };
33518
+ requestBody?: never;
33519
+ responses: {
33520
+ /** @description Defines a change's identity as it moves between Spaces. */
33521
+ 200: {
33522
+ headers: {
33523
+ [name: string]: unknown;
33524
+ };
33525
+ content: {
33526
+ "application/json": components["schemas"]["ChangeOrder"];
33527
+ };
33528
+ };
33529
+ /** @description ChangeOrder request is invalid (Bad Request). */
33530
+ 400: {
33531
+ headers: {
33532
+ [name: string]: unknown;
33533
+ };
33534
+ content: {
33535
+ "application/json": components["schemas"]["StandardErrorResponse"];
33536
+ };
33537
+ };
33538
+ /** @description Unauthorized access. */
33539
+ 401: {
33540
+ headers: {
33541
+ [name: string]: unknown;
33542
+ };
33543
+ content: {
33544
+ "application/json": components["schemas"]["StandardErrorResponse"];
33545
+ };
33546
+ };
33547
+ /** @description Forbidden access. */
33548
+ 403: {
33549
+ headers: {
33550
+ [name: string]: unknown;
33551
+ };
33552
+ content: {
33553
+ "application/json": components["schemas"]["StandardErrorResponse"];
33554
+ };
33555
+ };
33556
+ /** @description ChangeOrder not found. */
33557
+ 404: {
33558
+ headers: {
33559
+ [name: string]: unknown;
33560
+ };
33561
+ content: {
33562
+ "application/json": components["schemas"]["StandardErrorResponse"];
33563
+ };
33564
+ };
33565
+ /** @description ChangeOrder data conflict. Data has changed since last read. */
33566
+ 409: {
33567
+ headers: {
33568
+ [name: string]: unknown;
33569
+ };
33570
+ content: {
33571
+ "application/json": components["schemas"]["StandardErrorResponse"];
33572
+ };
33573
+ };
33574
+ /** @description Something went wrong while processing ChangeOrder. */
33575
+ 500: {
33576
+ headers: {
33577
+ [name: string]: unknown;
33578
+ };
33579
+ content: {
33580
+ "application/json": components["schemas"]["StandardErrorResponse"];
33581
+ };
33582
+ };
33583
+ /** @description Unexpected error. */
33584
+ default: {
33585
+ headers: {
33586
+ [name: string]: unknown;
33587
+ };
33588
+ content: {
33589
+ "application/json": components["schemas"]["StandardErrorResponse"];
33590
+ };
33591
+ };
33592
+ };
33593
+ };
33270
33594
  ListChangeSets: {
33271
33595
  parameters: {
33272
33596
  query?: {
package/package.json CHANGED
@@ -1,6 +1,6 @@
1
1
  {
2
2
  "name": "@confighub/api",
3
- "version": "0.9.7",
3
+ "version": "0.9.9",
4
4
  "description": "Typed, framework-agnostic client for the ConfigHub API",
5
5
  "license": "MIT",
6
6
  "repository": {