@workos/openapi-spec 0.113.0 → 0.115.0

package/dist/services.mjs

@@ -786,6 +786,11 @@ const serviceEndpoints = {
 			"path": "/data-integrations/{slug}",
 			"name": "update_data_integration"
 		},
+		{
+			"method": "POST",
+			"path": "/data-integrations/{slug}/api-key",
+			"name": "create_data_integration_api_key"
+		},
 		{
 			"method": "PUT",
 			"path": "/data-integrations/{slug}/api-key",
@@ -796,6 +801,11 @@ const serviceEndpoints = {
 			"path": "/data-integrations/{slug}/authorize",
 			"name": "authorize_data_integration"
 		},
+		{
+			"method": "POST",
+			"path": "/data-integrations/{slug}/client-credentials",
+			"name": "create_data_integration_client_credential"
+		},
 		{
 			"method": "PUT",
 			"path": "/data-integrations/{slug}/client-credentials",

package/dist/types.d.ts

@@ -1471,10 +1471,14 @@ export interface paths {
         get?: never;
         /**
          * Upsert an API key for a connected account
-         * @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.
+         * @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. To create another connection, use POST.
          */
         put: operations["DataIntegrationsController_upsertApiKey"];
-        post?: never;
+        /**
+         * Create another API key connected account
+         * @description Creates another API key-based connected account for the specified integration, owned by the user or, when `connection_owner` is `organization`, shared by the organization. Requires `connection_intent: add` and does not accept `connected_account_id`; use PUT to create or rotate the compatibility connection or to update an exact connection. Creating an additional connection is not yet available: until it is, this endpoint succeeds only when the owner has no connection for this integration, which creates the compatibility connection, and otherwise returns 404 `multiple_connections_unavailable`.
+         */
+        post: operations["DataIntegrationsController_createApiKeyConnection"];
         delete?: never;
         options?: never;
         head?: never;
@@ -1511,10 +1515,14 @@ export interface paths {
         get?: never;
         /**
          * Upsert client credentials for a connected account
-         * @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.
+         * @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. To create another connection, use POST.
          */
         put: operations["DataIntegrationsController_upsertClientCredentials"];
-        post?: never;
+        /**
+         * Create another client credentials connected account
+         * @description Creates another client credentials-based connected account for the specified integration, owned by the user or, when `connection_owner` is `organization`, shared by the organization. Requires `connection_intent: add` and does not accept `connected_account_id`; use PUT to create or rotate the compatibility connection or to update an exact connection. Creating an additional connection is not yet available: until it is, this endpoint succeeds only when the owner has no connection for this integration, which creates the compatibility connection, and otherwise returns 404 `multiple_connections_unavailable`.
+         */
+        post: operations["DataIntegrationsController_createClientCredentialsConnection"];
         delete?: never;
         options?: never;
         head?: never;
@@ -5566,7 +5574,7 @@ export interface components {
              */
             user_id: string;
             /**
-             * @description Set to `add` to create another connected account. Omit this field for permanent compatibility behavior.
+             * @description Set to `add` to create another connected account. Omit this field for permanent compatibility behavior. Creating an additional connection is not yet available: until it is, `add` succeeds only when the owner has no connection for this integration, which creates the compatibility connection, and otherwise returns 404 `multiple_connections_unavailable`.
              * @example add
              * @constant
              */
@@ -5641,7 +5649,7 @@ export interface components {
              */
             state?: "connected" | "needs_reauthorization";
             /**
-             * @description Set to `add` to create another connected account. Omit this field for permanent compatibility behavior.
+             * @description Set to `add` to create another connected account. Omit this field for permanent compatibility behavior. Creating an additional connection is not yet available: until it is, `add` succeeds only when the owner has no connection for this integration, which creates the compatibility connection, and otherwise returns 404 `multiple_connections_unavailable`.
              * @example add
              * @constant
              */
@@ -28121,6 +28129,30 @@ export interface operations {
                          * @example Request could not be processed.
                          */
                         message: string;
+                    } | {
+                        /**
+                         * @description The error code identifying the type of error.
+                         * @example resource_limit_exceeded
+                         * @constant
+                         */
+                        code: "resource_limit_exceeded";
+                        /**
+                         * @description A human-readable description of the error.
+                         * @example Request could not be processed.
+                         */
+                        message: string;
+                    } | {
+                        /**
+                         * @description The error code identifying the type of error.
+                         * @example too_many_sp_encryption_certs
+                         * @constant
+                         */
+                        code: "too_many_sp_encryption_certs";
+                        /**
+                         * @description A human-readable description of the error.
+                         * @example Request could not be processed.
+                         */
+                        message: string;
                     };
                 };
             };
@@ -29745,34 +29777,6 @@ export interface operations {
                      * @example sk-1234567890abcdef
                      */
                     secret: string;
-                } | {
-                    /**
-                     * @description A [User](/reference/authkit/user) identifier.
-                     * @example user_01EHZNVPK3SFK441A1RGBFSHRT
-                     */
-                    user_id: string;
-                    /**
-                     * @description An [Organization](/reference/organization) identifier. Optional parameter to scope the connection to a specific organization. Required when `connection_owner` is `organization`.
-                     * @example org_01EHZNVPK3SFK441A1RGBFSHRT
-                     */
-                    organization_id?: string;
-                    /**
-                     * @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.
-                     * @example user
-                     * @enum {string}
-                     */
-                    connection_owner?: "user" | "organization";
-                    /**
-                     * @description The API key secret to store for this integration.
-                     * @example sk-1234567890abcdef
-                     */
-                    secret: string;
-                    /**
-                     * @description Create another connection. The first connection for an owner shape fills the compatibility slot; later connections are standard.
-                     * @example add
-                     * @constant
-                     */
-                    connection_intent: "add";
                 } | {
                     /**
                      * @description A [User](/reference/authkit/user) identifier.
@@ -29935,6 +29939,163 @@ export interface operations {
             };
         };
     };
+    DataIntegrationsController_createApiKeyConnection: {
+        parameters: {
+            query?: never;
+            header?: never;
+            path: {
+                /** @description The identifier of the integration. */
+                slug: string;
+            };
+            cookie?: never;
+        };
+        requestBody: {
+            content: {
+                "application/json": {
+                    /**
+                     * @description A [User](/reference/authkit/user) identifier.
+                     * @example user_01EHZNVPK3SFK441A1RGBFSHRT
+                     */
+                    user_id: string;
+                    /**
+                     * @description An [Organization](/reference/organization) identifier. Optional parameter to scope the connection to a specific organization. Required when `connection_owner` is `organization`.
+                     * @example org_01EHZNVPK3SFK441A1RGBFSHRT
+                     */
+                    organization_id?: string;
+                    /**
+                     * @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.
+                     * @example user
+                     * @enum {string}
+                     */
+                    connection_owner?: "user" | "organization";
+                    /**
+                     * @description The API key secret to store for this integration.
+                     * @example sk-1234567890abcdef
+                     */
+                    secret: string;
+                    /**
+                     * @description Must be `add`: this endpoint only creates another connection. The first connection for an owner shape fills the compatibility slot; later connections are standard. Creating an additional connection is not yet available: until it is, `add` succeeds only when the owner has no connection for this integration and otherwise returns 404 `multiple_connections_unavailable`.
+                     * @example add
+                     * @constant
+                     */
+                    connection_intent: "add";
+                };
+            };
+        };
+        responses: {
+            /** @description The connected account that was created. */
+            201: {
+                headers: {
+                    [name: string]: unknown;
+                };
+                content: {
+                    /**
+                     * @example {
+                     *       "object": "connected_account",
+                     *       "id": "data_installation_01EHZNVPK3SFK441A1RGBFSHRT",
+                     *       "connection_role": "standard",
+                     *       "account_identifier": null,
+                     *       "account_display_name": null,
+                     *       "user_id": "user_01EHZNVPK3SFK441A1RGBFSHRT",
+                     *       "organization_id": "org_01EHZNVPK3SFK441A1RGBFSHRT",
+                     *       "scopes": [],
+                     *       "auth_method": "api_key",
+                     *       "api_key_last_4": "cdef",
+                     *       "state": "connected",
+                     *       "created_at": "2024-01-16T14:20:00.000Z",
+                     *       "updated_at": "2024-01-16T14:20:00.000Z"
+                     *     }
+                     */
+                    "application/json": components["schemas"]["ConnectedAccount"];
+                };
+            };
+            /** @description The request is invalid, including a missing `connection_intent: add` or a supplied `connected_account_id`. */
+            400: {
+                headers: {
+                    [name: string]: unknown;
+                };
+                content: {
+                    "application/json": {
+                        /**
+                         * @description A human-readable description of the error.
+                         * @example Organization not found: 'org_01EHQMYV6MBK39QC5PZXHY59C3'.
+                         */
+                        message: string;
+                    };
+                };
+            };
+            /** @description Unauthorized */
+            401: {
+                headers: {
+                    [name: string]: unknown;
+                };
+                content?: never;
+            };
+            /** @description Forbidden */
+            403: {
+                headers: {
+                    [name: string]: unknown;
+                };
+                content: {
+                    "application/json": {
+                        /**
+                         * @description A human-readable description of the error.
+                         * @example Organization not found: 'org_01EHQMYV6MBK39QC5PZXHY59C3'.
+                         */
+                        message: string;
+                    };
+                };
+            };
+            /** @description The data integration was not found, or `multiple_connections_unavailable` when creating an additional connection is not yet available. */
+            404: {
+                headers: {
+                    [name: string]: unknown;
+                };
+                content: {
+                    "application/json": {
+                        /**
+                         * @description The error code identifying the type of error.
+                         * @example multiple_connections_unavailable
+                         * @enum {string}
+                         */
+                        code: "multiple_connections_unavailable" | "entity_not_found";
+                        /**
+                         * @description A human-readable description of the error.
+                         * @example Request could not be processed.
+                         */
+                        message: string;
+                    } | {
+                        /**
+                         * @description A human-readable description of the error.
+                         * @example Organization not found: 'org_01EHQMYV6MBK39QC5PZXHY59C3'.
+                         */
+                        message: string;
+                    };
+                };
+            };
+            /** @description Another connection is being created for this owner and provider. Retry the request. */
+            503: {
+                headers: {
+                    [name: string]: unknown;
+                };
+                content: {
+                    "application/json": {
+                        /**
+                         * @description The error code identifying the type of error.
+                         * @example concurrent_request
+                         * @constant
+                         */
+                        code: "concurrent_request";
+                        /**
+                         * @description A human-readable description of the error.
+                         * @example Request could not be processed.
+                         */
+                        message: string;
+                    };
+                };
+            };
+        };
+    };
     DataIntegrationsController_getDataIntegrationAuthorizeUrl: {
         parameters: {
             query?: never;
@@ -30131,11 +30292,16 @@ export interface operations {
                         [key: string]: string;
                     };
                     /**
-                     * @description Create another connection. The first connection for an owner shape fills the compatibility slot; later connections are standard.
-                     * @example add
+                     * @description Reauthorize exactly the connection named by `connected_account_id`.
+                     * @example reauthorize
                      * @constant
                      */
-                    connection_intent: "add";
+                    connection_intent: "reauthorize";
+                    /**
+                     * @description The exact connected account to reauthorize. Required with `connection_intent: reauthorize`.
+                     * @example data_installation_01EHZNVPK3SFK441A1RGBFSHRT
+                     */
+                    connected_account_id: string;
                 } | {
                     /**
                      * @description A [User](/reference/authkit/user) identifier.
@@ -30173,17 +30339,124 @@ export interface operations {
                         [key: string]: string;
                     };
                     /**
-                     * @description Reauthorize exactly the connection named by `connected_account_id`.
-                     * @example reauthorize
-                     * @constant
-                     */
-                    connection_intent: "reauthorize";
-                    /**
-                     * @description The exact connected account to reauthorize. Required with `connection_intent: reauthorize`.
+                     * @description The exact connected account to reauthorize. The reauthorize intent may be omitted for compatibility.
                      * @example data_installation_01EHZNVPK3SFK441A1RGBFSHRT
                      */
                     connected_account_id: string;
-                } | {
+                };
+            };
+        };
+        responses: {
+            /** @description The resulting connected account after the upsert. */
+            200: {
+                headers: {
+                    [name: string]: unknown;
+                };
+                content: {
+                    /**
+                     * @example {
+                     *       "object": "connected_account",
+                     *       "id": "data_installation_01EHZNVPK3SFK441A1RGBFSHRT",
+                     *       "connection_role": "compatibility",
+                     *       "account_identifier": null,
+                     *       "account_display_name": null,
+                     *       "user_id": "user_01EHZNVPK3SFK441A1RGBFSHRT",
+                     *       "organization_id": "org_01EHZNVPK3SFK441A1RGBFSHRT",
+                     *       "scopes": [],
+                     *       "auth_method": "client_credentials",
+                     *       "state": "connected",
+                     *       "created_at": "2024-01-16T14:20:00.000Z",
+                     *       "updated_at": "2024-01-16T14:20:00.000Z"
+                     *     }
+                     */
+                    "application/json": components["schemas"]["ConnectedAccount"];
+                };
+            };
+            /** @description Bad Request */
+            400: {
+                headers: {
+                    [name: string]: unknown;
+                };
+                content: {
+                    "application/json": {
+                        /**
+                         * @description A human-readable description of the error.
+                         * @example Organization not found: 'org_01EHQMYV6MBK39QC5PZXHY59C3'.
+                         */
+                        message: string;
+                    };
+                };
+            };
+            /** @description Unauthorized */
+            401: {
+                headers: {
+                    [name: string]: unknown;
+                };
+                content?: never;
+            };
+            /** @description Forbidden */
+            403: {
+                headers: {
+                    [name: string]: unknown;
+                };
+                content: {
+                    "application/json": {
+                        /**
+                         * @description A human-readable description of the error.
+                         * @example Organization not found: 'org_01EHQMYV6MBK39QC5PZXHY59C3'.
+                         */
+                        message: string;
+                    };
+                };
+            };
+            /** @description The data integration or selected connected account was not found. */
+            404: {
+                headers: {
+                    [name: string]: unknown;
+                };
+                content: {
+                    "application/json": {
+                        /**
+                         * @description A human-readable description of the error.
+                         * @example Organization not found: 'org_01EHQMYV6MBK39QC5PZXHY59C3'.
+                         */
+                        message: string;
+                    };
+                };
+            };
+            /** @description Several connected accounts match the connection owner for the provider; one must be named. */
+            409: {
+                headers: {
+                    [name: string]: unknown;
+                };
+                content: {
+                    "application/json": components["schemas"]["AccountSelectionRequiredError"];
+                };
+            };
+            /** @description The matched installation uses a different auth method than this endpoint expects. */
+            422: {
+                headers: {
+                    [name: string]: unknown;
+                };
+                content: {
+                    "application/json": components["schemas"]["AuthMethodMismatchError"];
+                };
+            };
+        };
+    };
+    DataIntegrationsController_createClientCredentialsConnection: {
+        parameters: {
+            query?: never;
+            header?: never;
+            path: {
+                /** @description The identifier of the integration. */
+                slug: string;
+            };
+            cookie?: never;
+        };
+        requestBody: {
+            content: {
+                "application/json": {
                     /**
                      * @description A [User](/reference/authkit/user) identifier.
                      * @example user_01EHZNVPK3SFK441A1RGBFSHRT
@@ -30220,16 +30493,17 @@ export interface operations {
                         [key: string]: string;
                     };
                     /**
-                     * @description The exact connected account to reauthorize. The reauthorize intent may be omitted for compatibility.
-                     * @example data_installation_01EHZNVPK3SFK441A1RGBFSHRT
+                     * @description Must be `add`: this endpoint only creates another connection. The first connection for an owner shape fills the compatibility slot; later connections are standard. Creating an additional connection is not yet available: until it is, `add` succeeds only when the owner has no connection for this integration and otherwise returns 404 `multiple_connections_unavailable`.
+                     * @example add
+                     * @constant
                      */
-                    connected_account_id: string;
+                    connection_intent: "add";
                 };
             };
         };
         responses: {
-            /** @description The resulting connected account after the upsert. */
-            200: {
+            /** @description The connected account that was created. */
+            201: {
                 headers: {
                     [name: string]: unknown;
                 };
@@ -30238,7 +30512,7 @@ export interface operations {
                      * @example {
                      *       "object": "connected_account",
                      *       "id": "data_installation_01EHZNVPK3SFK441A1RGBFSHRT",
-                     *       "connection_role": "compatibility",
+                     *       "connection_role": "standard",
                      *       "account_identifier": null,
                      *       "account_display_name": null,
                      *       "user_id": "user_01EHZNVPK3SFK441A1RGBFSHRT",
@@ -30253,7 +30527,7 @@ export interface operations {
                     "application/json": components["schemas"]["ConnectedAccount"];
                 };
             };
-            /** @description Bad Request */
+            /** @description The request is invalid, including a missing `connection_intent: add` or a supplied `connected_account_id`. */
             400: {
                 headers: {
                     [name: string]: unknown;
@@ -30290,13 +30564,25 @@ export interface operations {
                     };
                 };
             };
-            /** @description The data integration or selected connected account was not found. */
+            /** @description The data integration was not found, or `multiple_connections_unavailable` when creating an additional connection is not yet available. */
             404: {
                 headers: {
                     [name: string]: unknown;
                 };
                 content: {
                     "application/json": {
+                        /**
+                         * @description The error code identifying the type of error.
+                         * @example multiple_connections_unavailable
+                         * @enum {string}
+                         */
+                        code: "multiple_connections_unavailable" | "entity_not_found";
+                        /**
+                         * @description A human-readable description of the error.
+                         * @example Request could not be processed.
+                         */
+                        message: string;
+                    } | {
                         /**
                          * @description A human-readable description of the error.
                          * @example Organization not found: 'org_01EHQMYV6MBK39QC5PZXHY59C3'.
@@ -30305,22 +30591,25 @@ export interface operations {
                     };
                 };
             };
-            /** @description Several connected accounts match the connection owner for the provider; one must be named. */
-            409: {
-                headers: {
-                    [name: string]: unknown;
-                };
-                content: {
-                    "application/json": components["schemas"]["AccountSelectionRequiredError"];
-                };
-            };
-            /** @description The matched installation uses a different auth method than this endpoint expects. */
-            422: {
+            /** @description Another connection is being created for this owner and provider. Retry the request. */
+            503: {
                 headers: {
                     [name: string]: unknown;
                 };
                 content: {
-                    "application/json": components["schemas"]["AuthMethodMismatchError"];
+                    "application/json": {
+                        /**
+                         * @description The error code identifying the type of error.
+                         * @example concurrent_request
+                         * @constant
+                         */
+                        code: "concurrent_request";
+                        /**
+                         * @description A human-readable description of the error.
+                         * @example Request could not be processed.
+                         */
+                        message: string;
+                    };
                 };
             };
         };
@@ -30446,7 +30735,7 @@ export interface operations {
                     };
                 };
             };
-            /** @description Several connected accounts match this user for the provider; one must be named. */
+            /** @description Several connected accounts match this user or organization for the provider; one must be named. */
             409: {
                 headers: {
                     [name: string]: unknown;
@@ -30864,7 +31153,7 @@ export interface operations {
                     };
                 };
             };
-            /** @description Several connected accounts match this user for the provider; one must be named. */
+            /** @description Several connected accounts match this user or organization for the provider; one must be named. */
             409: {
                 headers: {
                     [name: string]: unknown;
@@ -33945,13 +34234,25 @@ export interface operations {
                     };
                 };
             };
-            /** @description The organization, user, or data integration was not found. */
+            /** @description The organization, user, or data integration was not found, or `multiple_connections_unavailable` when `connection_intent: add` would create an additional connection before that capability is available. */
             404: {
                 headers: {
                     [name: string]: unknown;
                 };
                 content: {
                     "application/json": {
+                        /**
+                         * @description The error code identifying the type of error.
+                         * @example multiple_connections_unavailable
+                         * @enum {string}
+                         */
+                        code: "multiple_connections_unavailable" | "entity_not_found";
+                        /**
+                         * @description A human-readable description of the error.
+                         * @example Request could not be processed.
+                         */
+                        message: string;
+                    } | {
                         /**
                          * @description A human-readable description of the error.
                          * @example Organization not found: 'org_01EHQMYV6MBK39QC5PZXHY59C3'.
@@ -41492,13 +41793,25 @@ export interface operations {
                 };
                 content?: never;
             };
-            /** @description The user, organization, or data integration was not found. */
+            /** @description The user, organization, or data integration was not found, or `multiple_connections_unavailable` when `connection_intent: add` would create an additional connection before that capability is available. */
             404: {
                 headers: {
                     [name: string]: unknown;
                 };
                 content: {
                     "application/json": {
+                        /**
+                         * @description The error code identifying the type of error.
+                         * @example multiple_connections_unavailable
+                         * @enum {string}
+                         */
+                        code: "multiple_connections_unavailable" | "entity_not_found";
+                        /**
+                         * @description A human-readable description of the error.
+                         * @example Request could not be processed.
+                         */
+                        message: string;
+                    } | {
                         /**
                          * @description A human-readable description of the error.
                          * @example Organization not found: 'org_01EHQMYV6MBK39QC5PZXHY59C3'.

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@workos/openapi-spec",
-  "version": "0.113.0",
+  "version": "0.115.0",
   "type": "module",
   "description": "WorkOS OpenAPI specification, TypeScript types, and SDK resolution policy",
   "license": "MIT",