@workos/openapi-spec 0.86.0 → 0.88.0

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.
@@ -10588,8 +10588,9 @@ paths:
10588
10588
  put:
10589
10589
  description: >-
10590
10590
  Creates or updates an API-key-based installation for the specified
10591
- integration and user. If an installation already exists, the stored API
10592
- key is rotated to the new value.
10591
+ integration, owned by the user or, when `connection_owner` is
10592
+ `organization`, shared by the organization. If an installation already
10593
+ exists, the stored API key is rotated to the new value.
10593
10594
  operationId: DataIntegrationsController_upsertApiKey
10594
10595
  parameters:
10595
10596
  - name: slug
@@ -10615,7 +10616,8 @@ paths:
10615
10616
  description: >-
10616
10617
  An [Organization](/reference/organization) identifier.
10617
10618
  Optional parameter to scope the connection to a specific
10618
- organization.
10619
+ organization. Required when `connection_owner` is
10620
+ `organization`.
10619
10621
  example: org_01EHZNVPK3SFK441A1RGBFSHRT
10620
10622
  connected_account_id:
10621
10623
  type: string
@@ -10625,6 +10627,19 @@ paths:
10625
10627
  identifier. Use this to rotate a specific existing
10626
10628
  connection.
10627
10629
  example: data_installation_01EHZNVPK3SFK441A1RGBFSHRT
10630
+ connection_owner:
10631
+ type: string
10632
+ enum:
10633
+ - user
10634
+ - organization
10635
+ description: >-
10636
+ Whose connection to create or rotate. `user` (the default)
10637
+ addresses the connection owned by `user_id`. `organization`
10638
+ addresses the connection shared by every member of
10639
+ `organization_id`; `user_id` then identifies the member
10640
+ performing the request and must be an active member of the
10641
+ organization.
10642
+ example: user
10628
10643
  secret:
10629
10644
  type: string
10630
10645
  minLength: 1
@@ -10694,8 +10709,8 @@ paths:
10694
10709
  - message
10695
10710
  '409':
10696
10711
  description: >-
10697
- Several connected accounts match this user for the provider; one
10698
- must be named.
10712
+ Several connected accounts match the connection owner for the
10713
+ provider; one must be named.
10699
10714
  content:
10700
10715
  application/json:
10701
10716
  schema:
@@ -10819,8 +10834,9 @@ paths:
10819
10834
  put:
10820
10835
  description: >-
10821
10836
  Creates or updates a client-credentials-based installation for the
10822
- specified integration and user. If an installation already exists, the
10823
- stored client credentials are rotated to the new values.
10837
+ specified integration, owned by the user or, when `connection_owner` is
10838
+ `organization`, shared by the organization. If an installation already
10839
+ exists, the stored client credentials are rotated to the new values.
10824
10840
  operationId: DataIntegrationsController_upsertClientCredentials
10825
10841
  parameters:
10826
10842
  - name: slug
@@ -10846,7 +10862,8 @@ paths:
10846
10862
  description: >-
10847
10863
  An [Organization](/reference/organization) identifier.
10848
10864
  Optional parameter to scope the connection to a specific
10849
- organization.
10865
+ organization. Required when `connection_owner` is
10866
+ `organization`.
10850
10867
  example: org_01EHZNVPK3SFK441A1RGBFSHRT
10851
10868
  connected_account_id:
10852
10869
  type: string
@@ -10856,6 +10873,19 @@ paths:
10856
10873
  identifier. Use this to rotate a specific existing
10857
10874
  connection.
10858
10875
  example: data_installation_01EHZNVPK3SFK441A1RGBFSHRT
10876
+ connection_owner:
10877
+ type: string
10878
+ enum:
10879
+ - user
10880
+ - organization
10881
+ description: >-
10882
+ Whose connection to create or rotate. `user` (the default)
10883
+ addresses the connection owned by `user_id`. `organization`
10884
+ addresses the connection shared by every member of
10885
+ `organization_id`; `user_id` then identifies the member
10886
+ performing the request and must be an active member of the
10887
+ organization.
10888
+ example: user
10859
10889
  client_id:
10860
10890
  type: string
10861
10891
  minLength: 1
@@ -10940,8 +10970,8 @@ paths:
10940
10970
  - message
10941
10971
  '409':
10942
10972
  description: >-
10943
- Several connected accounts match this user for the provider; one
10944
- must be named.
10973
+ Several connected accounts match the connection owner for the
10974
+ provider; one must be named.
10945
10975
  content:
10946
10976
  application/json:
10947
10977
  schema:
@@ -39957,6 +39987,7 @@ components:
39957
39987
  - events
39958
39988
  - sessions
39959
39989
  - auditLogEvents
39990
+ - connections
39960
39991
  description: The type of resource being exported.
39961
39992
  example: users
39962
39993
  required:
@@ -40004,6 +40035,7 @@ components:
40004
40035
  - events
40005
40036
  - sessions
40006
40037
  - auditLogEvents
40038
+ - connections
40007
40039
  description: The type of resource being exported.
40008
40040
  example: users
40009
40041
  required:
@@ -40051,6 +40083,7 @@ components:
40051
40083
  - events
40052
40084
  - sessions
40053
40085
  - auditLogEvents
40086
+ - connections
40054
40087
  description: The type of resource being exported.
40055
40088
  example: users
40056
40089
  required:
@@ -40098,6 +40131,7 @@ components:
40098
40131
  - events
40099
40132
  - sessions
40100
40133
  - auditLogEvents
40134
+ - connections
40101
40135
  description: The type of resource being exported.
40102
40136
  example: users
40103
40137
  required:
package/dist/types.d.ts CHANGED
@@ -1471,7 +1471,7 @@ export interface paths {
1471
1471
  get?: never;
1472
1472
  /**
1473
1473
  * Upsert an API key for a connected account
1474
- * @description Creates or updates an API-key-based installation for the specified integration and user. If an installation already exists, the stored API key is rotated to the new value.
1474
+ * @description Creates or updates an API-key-based installation for the specified integration, owned by the user or, when `connection_owner` is `organization`, shared by the organization. If an installation already exists, the stored API key is rotated to the new value.
1475
1475
  */
1476
1476
  put: operations["DataIntegrationsController_upsertApiKey"];
1477
1477
  post?: never;
@@ -1511,7 +1511,7 @@ export interface paths {
1511
1511
  get?: never;
1512
1512
  /**
1513
1513
  * Upsert client credentials for a connected account
1514
- * @description Creates or updates a client-credentials-based installation for the specified integration and user. If an installation already exists, the stored client credentials are rotated to the new values.
1514
+ * @description Creates or updates a client-credentials-based installation for the specified integration, owned by the user or, when `connection_owner` is `organization`, shared by the organization. If an installation already exists, the stored client credentials are rotated to the new values.
1515
1515
  */
1516
1516
  put: operations["DataIntegrationsController_upsertClientCredentials"];
1517
1517
  post?: never;
@@ -15424,7 +15424,7 @@ export interface components {
15424
15424
  * @example users
15425
15425
  * @enum {string}
15426
15426
  */
15427
- resource_type: "users" | "organizations" | "events" | "sessions" | "auditLogEvents";
15427
+ resource_type: "users" | "organizations" | "events" | "sessions" | "auditLogEvents" | "connections";
15428
15428
  };
15429
15429
  /**
15430
15430
  * Format: date-time
@@ -15458,7 +15458,7 @@ export interface components {
15458
15458
  * @example users
15459
15459
  * @enum {string}
15460
15460
  */
15461
- resource_type: "users" | "organizations" | "events" | "sessions" | "auditLogEvents";
15461
+ resource_type: "users" | "organizations" | "events" | "sessions" | "auditLogEvents" | "connections";
15462
15462
  };
15463
15463
  /**
15464
15464
  * Format: date-time
@@ -15492,7 +15492,7 @@ export interface components {
15492
15492
  * @example users
15493
15493
  * @enum {string}
15494
15494
  */
15495
- resource_type: "users" | "organizations" | "events" | "sessions" | "auditLogEvents";
15495
+ resource_type: "users" | "organizations" | "events" | "sessions" | "auditLogEvents" | "connections";
15496
15496
  };
15497
15497
  /**
15498
15498
  * Format: date-time
@@ -15526,7 +15526,7 @@ export interface components {
15526
15526
  * @example users
15527
15527
  * @enum {string}
15528
15528
  */
15529
- resource_type: "users" | "organizations" | "events" | "sessions" | "auditLogEvents";
15529
+ resource_type: "users" | "organizations" | "events" | "sessions" | "auditLogEvents" | "connections";
15530
15530
  };
15531
15531
  /**
15532
15532
  * Format: date-time
@@ -28835,7 +28835,7 @@ export interface operations {
28835
28835
  */
28836
28836
  user_id: string;
28837
28837
  /**
28838
- * @description An [Organization](/reference/organization) identifier. Optional parameter to scope the connection to a specific organization.
28838
+ * @description An [Organization](/reference/organization) identifier. Optional parameter to scope the connection to a specific organization. Required when `connection_owner` is `organization`.
28839
28839
  * @example org_01EHZNVPK3SFK441A1RGBFSHRT
28840
28840
  */
28841
28841
  organization_id?: string;
@@ -28844,6 +28844,12 @@ export interface operations {
28844
28844
  * @example data_installation_01EHZNVPK3SFK441A1RGBFSHRT
28845
28845
  */
28846
28846
  connected_account_id?: string;
28847
+ /**
28848
+ * @description Whose connection to create or rotate. `user` (the default) addresses the connection owned by `user_id`. `organization` addresses the connection shared by every member of `organization_id`; `user_id` then identifies the member performing the request and must be an active member of the organization.
28849
+ * @example user
28850
+ * @enum {string}
28851
+ */
28852
+ connection_owner?: "user" | "organization";
28847
28853
  /**
28848
28854
  * @description The API key secret to store for this integration.
28849
28855
  * @example sk-1234567890abcdef
@@ -28928,7 +28934,7 @@ export interface operations {
28928
28934
  };
28929
28935
  };
28930
28936
  };
28931
- /** @description Several connected accounts match this user for the provider; one must be named. */
28937
+ /** @description Several connected accounts match the connection owner for the provider; one must be named. */
28932
28938
  409: {
28933
28939
  headers: {
28934
28940
  [name: string]: unknown;
@@ -29072,7 +29078,7 @@ export interface operations {
29072
29078
  */
29073
29079
  user_id: string;
29074
29080
  /**
29075
- * @description An [Organization](/reference/organization) identifier. Optional parameter to scope the connection to a specific organization.
29081
+ * @description An [Organization](/reference/organization) identifier. Optional parameter to scope the connection to a specific organization. Required when `connection_owner` is `organization`.
29076
29082
  * @example org_01EHZNVPK3SFK441A1RGBFSHRT
29077
29083
  */
29078
29084
  organization_id?: string;
@@ -29081,6 +29087,12 @@ export interface operations {
29081
29087
  * @example data_installation_01EHZNVPK3SFK441A1RGBFSHRT
29082
29088
  */
29083
29089
  connected_account_id?: string;
29090
+ /**
29091
+ * @description Whose connection to create or rotate. `user` (the default) addresses the connection owned by `user_id`. `organization` addresses the connection shared by every member of `organization_id`; `user_id` then identifies the member performing the request and must be an active member of the organization.
29092
+ * @example user
29093
+ * @enum {string}
29094
+ */
29095
+ connection_owner?: "user" | "organization";
29084
29096
  /**
29085
29097
  * @description The OAuth client ID to store for this integration.
29086
29098
  * @example 3MVG9...
@@ -29178,7 +29190,7 @@ export interface operations {
29178
29190
  };
29179
29191
  };
29180
29192
  };
29181
- /** @description Several connected accounts match this user for the provider; one must be named. */
29193
+ /** @description Several connected accounts match the connection owner for the provider; one must be named. */
29182
29194
  409: {
29183
29195
  headers: {
29184
29196
  [name: string]: unknown;
package/package.json CHANGED
@@ -1,6 +1,6 @@
1
1
  {
2
2
  "name": "@workos/openapi-spec",
3
- "version": "0.86.0",
3
+ "version": "0.88.0",
4
4
  "type": "module",
5
5
  "description": "WorkOS OpenAPI specification, TypeScript types, and SDK resolution policy",
6
6
  "license": "MIT",
@@ -57,8 +57,8 @@
57
57
  },
58
58
  "devDependencies": {
59
59
  "@types/node": "^26.5.0",
60
- "@workos/oagen": "^0.30.1",
61
- "@workos/oagen-emitters": "^0.24.11",
60
+ "@workos/oagen": "^0.30.2",
61
+ "@workos/oagen-emitters": "^0.24.12",
62
62
  "diff2html": "^3.4.56",
63
63
  "husky": "^9.1.7",
64
64
  "js-yaml": "^5.4.1",