@confighub/api 0.9.8 → 0.9.10

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
@@ -989,11 +989,7 @@ interface paths {
989
989
  */
990
990
  get: operations["ListOrganizations"];
991
991
  put?: never;
992
- /**
993
- * Create Organization
994
- * @description Create Organization
995
- */
996
- post: operations["CreateOrganization"];
992
+ post?: never;
997
993
  delete?: never;
998
994
  options?: never;
999
995
  head?: never;
@@ -1018,14 +1014,14 @@ interface paths {
1018
1014
  */
1019
1015
  put: operations["UpdateOrganization"];
1020
1016
  post?: never;
1021
- /**
1022
- * Delete Organization
1023
- * @description Delete Organization
1024
- */
1025
- delete: operations["DeleteOrganization"];
1017
+ delete?: never;
1026
1018
  options?: never;
1027
1019
  head?: never;
1028
- patch?: never;
1020
+ /**
1021
+ * Patch Organization
1022
+ * @description Patch Organization
1023
+ */
1024
+ patch: operations["PatchOrganization"];
1029
1025
  trace?: never;
1030
1026
  };
1031
1027
  "/organization/{organization_id}/organization_member": {
@@ -7065,6 +7061,8 @@ interface components {
7065
7061
  * @example 248df4b7-aa70-47b8-a036-33ac447e668d
7066
7062
  */
7067
7063
  OrganizationID?: string;
7064
+ /** @description Permissions to access this organization. Its Children categories apply to the spaces and the other entities that belong to the organization rather than to a space. */
7065
+ Permissions?: components["schemas"]["Permissions"];
7068
7066
  /** @description Unique URL-safe identifier for the entity. */
7069
7067
  Slug: string;
7070
7068
  /**
@@ -25072,7 +25070,7 @@ interface operations {
25072
25070
  * An example conjunction is:
25073
25071
  * `CreatedAt >= '2025-01-07' AND Slug = 'test' AND Labels.mykey = 'myvalue'`.
25074
25072
  *
25075
- * Supported attributes for filtering on Organization: Annotations, CreatedAt, DeleteGates, DisplayName, EmailDomain, ExternalID, HiddenReason, Labels, OrganizationID, Slug, UpdatedAt.
25073
+ * Supported attributes for filtering on Organization: Annotations, CreatedAt, DeleteGates, DisplayName, EmailDomain, ExternalID, HiddenReason, Labels, OrganizationID, Permissions, Slug, UpdatedAt.
25076
25074
  *
25077
25075
  * The whole string must be query-encoded.
25078
25076
  */
@@ -25135,7 +25133,7 @@ interface operations {
25135
25133
  *
25136
25134
  * A list made to choose an entity to act on can name the permission the action needs, such as Edit to change it or Use to refer to it from another entity, so that it leaves out the entities the action would be refused on.
25137
25135
  *
25138
- * Supported values: Manage, Edit, Use, View.
25136
+ * Supported values: Manage, Edit, Use, View, ManageChildren, EditChildren, UseChildren, ViewChildren, CreateChildren.
25139
25137
  */
25140
25138
  where_permission?: PathsOrganizationGetParametersQueryWhere_permission;
25141
25139
  /**
@@ -25230,96 +25228,6 @@ interface operations {
25230
25228
  };
25231
25229
  };
25232
25230
  };
25233
- CreateOrganization: {
25234
- parameters: {
25235
- query?: {
25236
- /** @description Allowed values are true and false. Default is false. When true, reports success when an entity already exists and returns the existing entity */
25237
- allow_exists?: string;
25238
- };
25239
- header?: never;
25240
- path?: never;
25241
- cookie?: never;
25242
- };
25243
- requestBody?: {
25244
- content: {
25245
- "application/json": components["schemas"]["Organization"];
25246
- };
25247
- };
25248
- responses: {
25249
- /** @description The top-level container for an organization using ConfigHub. */
25250
- 200: {
25251
- headers: {
25252
- [name: string]: unknown;
25253
- };
25254
- content: {
25255
- "application/json": components["schemas"]["Organization"];
25256
- };
25257
- };
25258
- /** @description Organization request is invalid (Bad Request). */
25259
- 400: {
25260
- headers: {
25261
- [name: string]: unknown;
25262
- };
25263
- content: {
25264
- "application/json": components["schemas"]["StandardErrorResponse"];
25265
- };
25266
- };
25267
- /** @description Unauthorized access. */
25268
- 401: {
25269
- headers: {
25270
- [name: string]: unknown;
25271
- };
25272
- content: {
25273
- "application/json": components["schemas"]["StandardErrorResponse"];
25274
- };
25275
- };
25276
- /** @description Forbidden access. */
25277
- 403: {
25278
- headers: {
25279
- [name: string]: unknown;
25280
- };
25281
- content: {
25282
- "application/json": components["schemas"]["StandardErrorResponse"];
25283
- };
25284
- };
25285
- /** @description Organization not found. */
25286
- 404: {
25287
- headers: {
25288
- [name: string]: unknown;
25289
- };
25290
- content: {
25291
- "application/json": components["schemas"]["StandardErrorResponse"];
25292
- };
25293
- };
25294
- /** @description Organization data conflict. Data has changed since last read. */
25295
- 409: {
25296
- headers: {
25297
- [name: string]: unknown;
25298
- };
25299
- content: {
25300
- "application/json": components["schemas"]["StandardErrorResponse"];
25301
- };
25302
- };
25303
- /** @description Something went wrong while processing Organization. */
25304
- 500: {
25305
- headers: {
25306
- [name: string]: unknown;
25307
- };
25308
- content: {
25309
- "application/json": components["schemas"]["StandardErrorResponse"];
25310
- };
25311
- };
25312
- /** @description Unexpected error. */
25313
- default: {
25314
- headers: {
25315
- [name: string]: unknown;
25316
- };
25317
- content: {
25318
- "application/json": components["schemas"]["StandardErrorResponse"];
25319
- };
25320
- };
25321
- };
25322
- };
25323
25231
  GetOrganization: {
25324
25232
  parameters: {
25325
25233
  query?: {
@@ -25512,9 +25420,12 @@ interface operations {
25512
25420
  };
25513
25421
  };
25514
25422
  };
25515
- DeleteOrganization: {
25423
+ PatchOrganization: {
25516
25424
  parameters: {
25517
- query?: never;
25425
+ query?: {
25426
+ /** @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. */
25427
+ dry_run?: boolean;
25428
+ };
25518
25429
  header?: never;
25519
25430
  path: {
25520
25431
  /** @description Unique identifier for a organization_id */
@@ -25522,15 +25433,44 @@ interface operations {
25522
25433
  };
25523
25434
  cookie?: never;
25524
25435
  };
25525
- requestBody?: never;
25436
+ requestBody?: {
25437
+ content: {
25438
+ "application/merge-patch+json": {
25439
+ /** @description An optional map of Annotation key/value pairs for tools to attach information to entities. */
25440
+ Annotations?: {
25441
+ [key: string]: string | null;
25442
+ } | null;
25443
+ /** @description An optional set of gates that, if any is present, will block deletion */
25444
+ DeleteGates?: {
25445
+ [key: string]: boolean | null;
25446
+ } | null;
25447
+ /** @description Friendly name for the entity. */
25448
+ DisplayName?: string | null;
25449
+ EmailDomain?: string | null;
25450
+ /** @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. */
25451
+ HiddenReason?: string | null;
25452
+ /** @description An optional map of Label key/value pairs to specify identifying attributes of entities for the purpose of grouping and filtering them. */
25453
+ Labels?: {
25454
+ [key: string]: string | null;
25455
+ } | null;
25456
+ Permissions?: {
25457
+ [key: string]: Record<string, never> | null;
25458
+ } | null;
25459
+ /** @description Unique URL-safe identifier for the entity. */
25460
+ Slug?: string | null;
25461
+ /** @description An entity-specific sequence number used for optimistic concurrency control. The value read must be sent in calls to Update. */
25462
+ Version?: number | null;
25463
+ };
25464
+ };
25465
+ };
25526
25466
  responses: {
25527
- /** @description Response for successful delete operation */
25467
+ /** @description The top-level container for an organization using ConfigHub. */
25528
25468
  200: {
25529
25469
  headers: {
25530
25470
  [name: string]: unknown;
25531
25471
  };
25532
25472
  content: {
25533
- "application/json": components["schemas"]["DeleteResponse"];
25473
+ "application/json": components["schemas"]["Organization"];
25534
25474
  };
25535
25475
  };
25536
25476
  /** @description Organization request is invalid (Bad Request). */
@@ -25569,7 +25509,7 @@ interface operations {
25569
25509
  "application/json": components["schemas"]["StandardErrorResponse"];
25570
25510
  };
25571
25511
  };
25572
- /** @description Organization is still in use: it has DeleteGates, or other entities still reference it. Or data has changed since last read. */
25512
+ /** @description Organization data conflict. Data has changed since last read. */
25573
25513
  409: {
25574
25514
  headers: {
25575
25515
  [name: string]: unknown;
@@ -25578,15 +25518,6 @@ interface operations {
25578
25518
  "application/json": components["schemas"]["StandardErrorResponse"];
25579
25519
  };
25580
25520
  };
25581
- /** @description Organization could not be deleted. */
25582
- 422: {
25583
- headers: {
25584
- [name: string]: unknown;
25585
- };
25586
- content: {
25587
- "application/json": components["schemas"]["StandardErrorResponse"];
25588
- };
25589
- };
25590
25521
  /** @description Something went wrong while processing Organization. */
25591
25522
  500: {
25592
25523
  headers: {
@@ -57464,7 +57395,12 @@ declare enum PathsOrganizationGetParametersQueryWhere_permission {
57464
57395
  Manage = "Manage",
57465
57396
  Edit = "Edit",
57466
57397
  Use = "Use",
57467
- View = "View"
57398
+ View = "View",
57399
+ ManageChildren = "ManageChildren",
57400
+ EditChildren = "EditChildren",
57401
+ UseChildren = "UseChildren",
57402
+ ViewChildren = "ViewChildren",
57403
+ CreateChildren = "CreateChildren"
57468
57404
  }
57469
57405
  declare enum PathsOrganizationOrganization_idOrganization_memberGetParametersQueryWhere_permission {
57470
57406
  Manage = "Manage",
package/dist/index.d.ts CHANGED
@@ -989,11 +989,7 @@ interface paths {
989
989
  */
990
990
  get: operations["ListOrganizations"];
991
991
  put?: never;
992
- /**
993
- * Create Organization
994
- * @description Create Organization
995
- */
996
- post: operations["CreateOrganization"];
992
+ post?: never;
997
993
  delete?: never;
998
994
  options?: never;
999
995
  head?: never;
@@ -1018,14 +1014,14 @@ interface paths {
1018
1014
  */
1019
1015
  put: operations["UpdateOrganization"];
1020
1016
  post?: never;
1021
- /**
1022
- * Delete Organization
1023
- * @description Delete Organization
1024
- */
1025
- delete: operations["DeleteOrganization"];
1017
+ delete?: never;
1026
1018
  options?: never;
1027
1019
  head?: never;
1028
- patch?: never;
1020
+ /**
1021
+ * Patch Organization
1022
+ * @description Patch Organization
1023
+ */
1024
+ patch: operations["PatchOrganization"];
1029
1025
  trace?: never;
1030
1026
  };
1031
1027
  "/organization/{organization_id}/organization_member": {
@@ -7065,6 +7061,8 @@ interface components {
7065
7061
  * @example 248df4b7-aa70-47b8-a036-33ac447e668d
7066
7062
  */
7067
7063
  OrganizationID?: string;
7064
+ /** @description Permissions to access this organization. Its Children categories apply to the spaces and the other entities that belong to the organization rather than to a space. */
7065
+ Permissions?: components["schemas"]["Permissions"];
7068
7066
  /** @description Unique URL-safe identifier for the entity. */
7069
7067
  Slug: string;
7070
7068
  /**
@@ -25072,7 +25070,7 @@ interface operations {
25072
25070
  * An example conjunction is:
25073
25071
  * `CreatedAt >= '2025-01-07' AND Slug = 'test' AND Labels.mykey = 'myvalue'`.
25074
25072
  *
25075
- * Supported attributes for filtering on Organization: Annotations, CreatedAt, DeleteGates, DisplayName, EmailDomain, ExternalID, HiddenReason, Labels, OrganizationID, Slug, UpdatedAt.
25073
+ * Supported attributes for filtering on Organization: Annotations, CreatedAt, DeleteGates, DisplayName, EmailDomain, ExternalID, HiddenReason, Labels, OrganizationID, Permissions, Slug, UpdatedAt.
25076
25074
  *
25077
25075
  * The whole string must be query-encoded.
25078
25076
  */
@@ -25135,7 +25133,7 @@ interface operations {
25135
25133
  *
25136
25134
  * A list made to choose an entity to act on can name the permission the action needs, such as Edit to change it or Use to refer to it from another entity, so that it leaves out the entities the action would be refused on.
25137
25135
  *
25138
- * Supported values: Manage, Edit, Use, View.
25136
+ * Supported values: Manage, Edit, Use, View, ManageChildren, EditChildren, UseChildren, ViewChildren, CreateChildren.
25139
25137
  */
25140
25138
  where_permission?: PathsOrganizationGetParametersQueryWhere_permission;
25141
25139
  /**
@@ -25230,96 +25228,6 @@ interface operations {
25230
25228
  };
25231
25229
  };
25232
25230
  };
25233
- CreateOrganization: {
25234
- parameters: {
25235
- query?: {
25236
- /** @description Allowed values are true and false. Default is false. When true, reports success when an entity already exists and returns the existing entity */
25237
- allow_exists?: string;
25238
- };
25239
- header?: never;
25240
- path?: never;
25241
- cookie?: never;
25242
- };
25243
- requestBody?: {
25244
- content: {
25245
- "application/json": components["schemas"]["Organization"];
25246
- };
25247
- };
25248
- responses: {
25249
- /** @description The top-level container for an organization using ConfigHub. */
25250
- 200: {
25251
- headers: {
25252
- [name: string]: unknown;
25253
- };
25254
- content: {
25255
- "application/json": components["schemas"]["Organization"];
25256
- };
25257
- };
25258
- /** @description Organization request is invalid (Bad Request). */
25259
- 400: {
25260
- headers: {
25261
- [name: string]: unknown;
25262
- };
25263
- content: {
25264
- "application/json": components["schemas"]["StandardErrorResponse"];
25265
- };
25266
- };
25267
- /** @description Unauthorized access. */
25268
- 401: {
25269
- headers: {
25270
- [name: string]: unknown;
25271
- };
25272
- content: {
25273
- "application/json": components["schemas"]["StandardErrorResponse"];
25274
- };
25275
- };
25276
- /** @description Forbidden access. */
25277
- 403: {
25278
- headers: {
25279
- [name: string]: unknown;
25280
- };
25281
- content: {
25282
- "application/json": components["schemas"]["StandardErrorResponse"];
25283
- };
25284
- };
25285
- /** @description Organization not found. */
25286
- 404: {
25287
- headers: {
25288
- [name: string]: unknown;
25289
- };
25290
- content: {
25291
- "application/json": components["schemas"]["StandardErrorResponse"];
25292
- };
25293
- };
25294
- /** @description Organization data conflict. Data has changed since last read. */
25295
- 409: {
25296
- headers: {
25297
- [name: string]: unknown;
25298
- };
25299
- content: {
25300
- "application/json": components["schemas"]["StandardErrorResponse"];
25301
- };
25302
- };
25303
- /** @description Something went wrong while processing Organization. */
25304
- 500: {
25305
- headers: {
25306
- [name: string]: unknown;
25307
- };
25308
- content: {
25309
- "application/json": components["schemas"]["StandardErrorResponse"];
25310
- };
25311
- };
25312
- /** @description Unexpected error. */
25313
- default: {
25314
- headers: {
25315
- [name: string]: unknown;
25316
- };
25317
- content: {
25318
- "application/json": components["schemas"]["StandardErrorResponse"];
25319
- };
25320
- };
25321
- };
25322
- };
25323
25231
  GetOrganization: {
25324
25232
  parameters: {
25325
25233
  query?: {
@@ -25512,9 +25420,12 @@ interface operations {
25512
25420
  };
25513
25421
  };
25514
25422
  };
25515
- DeleteOrganization: {
25423
+ PatchOrganization: {
25516
25424
  parameters: {
25517
- query?: never;
25425
+ query?: {
25426
+ /** @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. */
25427
+ dry_run?: boolean;
25428
+ };
25518
25429
  header?: never;
25519
25430
  path: {
25520
25431
  /** @description Unique identifier for a organization_id */
@@ -25522,15 +25433,44 @@ interface operations {
25522
25433
  };
25523
25434
  cookie?: never;
25524
25435
  };
25525
- requestBody?: never;
25436
+ requestBody?: {
25437
+ content: {
25438
+ "application/merge-patch+json": {
25439
+ /** @description An optional map of Annotation key/value pairs for tools to attach information to entities. */
25440
+ Annotations?: {
25441
+ [key: string]: string | null;
25442
+ } | null;
25443
+ /** @description An optional set of gates that, if any is present, will block deletion */
25444
+ DeleteGates?: {
25445
+ [key: string]: boolean | null;
25446
+ } | null;
25447
+ /** @description Friendly name for the entity. */
25448
+ DisplayName?: string | null;
25449
+ EmailDomain?: string | null;
25450
+ /** @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. */
25451
+ HiddenReason?: string | null;
25452
+ /** @description An optional map of Label key/value pairs to specify identifying attributes of entities for the purpose of grouping and filtering them. */
25453
+ Labels?: {
25454
+ [key: string]: string | null;
25455
+ } | null;
25456
+ Permissions?: {
25457
+ [key: string]: Record<string, never> | null;
25458
+ } | null;
25459
+ /** @description Unique URL-safe identifier for the entity. */
25460
+ Slug?: string | null;
25461
+ /** @description An entity-specific sequence number used for optimistic concurrency control. The value read must be sent in calls to Update. */
25462
+ Version?: number | null;
25463
+ };
25464
+ };
25465
+ };
25526
25466
  responses: {
25527
- /** @description Response for successful delete operation */
25467
+ /** @description The top-level container for an organization using ConfigHub. */
25528
25468
  200: {
25529
25469
  headers: {
25530
25470
  [name: string]: unknown;
25531
25471
  };
25532
25472
  content: {
25533
- "application/json": components["schemas"]["DeleteResponse"];
25473
+ "application/json": components["schemas"]["Organization"];
25534
25474
  };
25535
25475
  };
25536
25476
  /** @description Organization request is invalid (Bad Request). */
@@ -25569,7 +25509,7 @@ interface operations {
25569
25509
  "application/json": components["schemas"]["StandardErrorResponse"];
25570
25510
  };
25571
25511
  };
25572
- /** @description Organization is still in use: it has DeleteGates, or other entities still reference it. Or data has changed since last read. */
25512
+ /** @description Organization data conflict. Data has changed since last read. */
25573
25513
  409: {
25574
25514
  headers: {
25575
25515
  [name: string]: unknown;
@@ -25578,15 +25518,6 @@ interface operations {
25578
25518
  "application/json": components["schemas"]["StandardErrorResponse"];
25579
25519
  };
25580
25520
  };
25581
- /** @description Organization could not be deleted. */
25582
- 422: {
25583
- headers: {
25584
- [name: string]: unknown;
25585
- };
25586
- content: {
25587
- "application/json": components["schemas"]["StandardErrorResponse"];
25588
- };
25589
- };
25590
25521
  /** @description Something went wrong while processing Organization. */
25591
25522
  500: {
25592
25523
  headers: {
@@ -57464,7 +57395,12 @@ declare enum PathsOrganizationGetParametersQueryWhere_permission {
57464
57395
  Manage = "Manage",
57465
57396
  Edit = "Edit",
57466
57397
  Use = "Use",
57467
- View = "View"
57398
+ View = "View",
57399
+ ManageChildren = "ManageChildren",
57400
+ EditChildren = "EditChildren",
57401
+ UseChildren = "UseChildren",
57402
+ ViewChildren = "ViewChildren",
57403
+ CreateChildren = "CreateChildren"
57468
57404
  }
57469
57405
  declare enum PathsOrganizationOrganization_idOrganization_memberGetParametersQueryWhere_permission {
57470
57406
  Manage = "Manage",
package/package.json CHANGED
@@ -1,6 +1,6 @@
1
1
  {
2
2
  "name": "@confighub/api",
3
- "version": "0.9.8",
3
+ "version": "0.9.10",
4
4
  "description": "Typed, framework-agnostic client for the ConfigHub API",
5
5
  "license": "MIT",
6
6
  "repository": {