@workos/openapi-spec 0.82.0 → 0.84.0

package/dist/open-api-spec.yaml

@@ -10984,6 +10984,14 @@ paths:
                     Optional parameter to scope the connection to a specific
                     organization.
                   example: org_01EHZNVPK3SFK441A1RGBFSHRT
+                connected_account_id:
+                  type: string
+                  minLength: 1
+                  description: >-
+                    A [connected account](/reference/pipes/connected-account)
+                    identifier. Use this to select a specific connection when
+                    the user has several for this provider.
+                  example: data_installation_01EHZNVPK3SFK441A1RGBFSHRT
               required:
                 - user_id
       responses:
@@ -11020,7 +11028,7 @@ paths:
         '401':
           description: Unauthorized
         '404':
-          description: Data integration not found for the given provider slug.
+          description: The data integration or selected connected account was not found.
           content:
             application/json:
               schema:
@@ -11098,6 +11106,14 @@ paths:
                     Optional parameter to scope the connection to a specific
                     organization.
                   example: org_01EHZNVPK3SFK441A1RGBFSHRT
+                connected_account_id:
+                  type: string
+                  minLength: 1
+                  description: >-
+                    A [connected account](/reference/pipes/connected-account)
+                    identifier. Use this to select a specific connection when
+                    the user has several for this provider.
+                  example: data_installation_01EHZNVPK3SFK441A1RGBFSHRT
               required:
                 - user_id
       responses:
@@ -11123,7 +11139,7 @@ paths:
         '401':
           description: Unauthorized
         '404':
-          description: Data integration not found for the given provider slug.
+          description: The data integration or selected connected account was not found.
           content:
             application/json:
               schema:
@@ -22156,6 +22172,17 @@ paths:
           schema:
             example: org_01EHZNVPK3SFK441A1RGBFSHRT
             type: string
+        - name: connected_account_id
+          required: false
+          in: query
+          description: >-
+            A [connected account](/reference/pipes/connected-account)
+            identifier. Use this to select a specific connection when the user
+            has several for this provider.
+          schema:
+            minLength: 1
+            example: data_installation_01EHZNVPK3SFK441A1RGBFSHRT
+            type: string
       responses:
         '200':
           description: The connected account was retrieved successfully.
@@ -22163,6 +22190,19 @@ paths:
             application/json:
               schema:
                 $ref: '#/components/schemas/ConnectedAccount'
+        '400':
+          description: The connected account selector is malformed.
+          content:
+            application/json:
+              schema:
+                type: object
+                properties:
+                  message:
+                    type: string
+                    description: A human-readable description of the error.
+                    example: 'Organization not found: ''org_01EHQMYV6MBK39QC5PZXHY59C3''.'
+                required:
+                  - message
         '401':
           description: The request is missing a valid API key.
         '404':
@@ -22228,9 +22268,32 @@ paths:
           schema:
             example: org_01EHZNVPK3SFK441A1RGBFSHRT
             type: string
+        - name: connected_account_id
+          required: false
+          in: query
+          description: >-
+            A [connected account](/reference/pipes/connected-account)
+            identifier. Use this to select the connection to delete.
+          schema:
+            minLength: 1
+            example: data_installation_01EHZNVPK3SFK441A1RGBFSHRT
+            type: string
       responses:
         '204':
           description: The connected account was deleted successfully.
+        '400':
+          description: The connected account selector is malformed.
+          content:
+            application/json:
+              schema:
+                type: object
+                properties:
+                  message:
+                    type: string
+                    description: A human-readable description of the error.
+                    example: 'Organization not found: ''org_01EHQMYV6MBK39QC5PZXHY59C3''.'
+                required:
+                  - message
         '401':
           description: The request is missing a valid API key.
         '404':
@@ -22389,6 +22452,16 @@ paths:
           schema:
             example: org_01EHZNVPK3SFK441A1RGBFSHRT
             type: string
+        - name: connected_account_id
+          required: false
+          in: query
+          description: >-
+            A [connected account](/reference/pipes/connected-account)
+            identifier. Use this to select the connection to update.
+          schema:
+            minLength: 1
+            example: data_installation_01EHZNVPK3SFK441A1RGBFSHRT
+            type: string
       requestBody:
         required: true
         content:
@@ -22402,6 +22475,19 @@ paths:
             application/json:
               schema:
                 $ref: '#/components/schemas/ConnectedAccount'
+        '400':
+          description: The connected account selector is malformed.
+          content:
+            application/json:
+              schema:
+                type: object
+                properties:
+                  message:
+                    type: string
+                    description: A human-readable description of the error.
+                    example: 'Organization not found: ''org_01EHQMYV6MBK39QC5PZXHY59C3''.'
+                required:
+                  - message
         '401':
           description: The request is missing a valid API key.
         '404':
@@ -26545,16 +26631,16 @@ components:
           type: string
           description: >-
             The URL to go to when an admin clicks on your logo in the Admin
-            Portal. If not specified, the return URL configured on the
-            [Redirects](https://dashboard.workos.com/redirects) page will be
+            Portal. If not specified, the return URL configured on the [Admin
+            Portal](https://dashboard.workos.com/admin-portal) page will be
             used.
           example: https://example.com/admin-portal/return
         success_url:
           type: string
           description: >-
             The URL to redirect the admin to when they finish setup. If not
-            specified, the success URL configured on the
-            [Redirects](https://dashboard.workos.com/redirects) page will be
+            specified, the success URL configured on the [Admin
+            Portal](https://dashboard.workos.com/admin-portal) page will be
             used.
           example: https://example.com/admin-portal/success
         organization:

package/dist/types.d.ts

@@ -5431,12 +5431,12 @@ export interface components {
         };
         GenerateLinkDto: {
             /**
-             * @description The URL to go to when an admin clicks on your logo in the Admin Portal. If not specified, the return URL configured on the [Redirects](https://dashboard.workos.com/redirects) page will be used.
+             * @description The URL to go to when an admin clicks on your logo in the Admin Portal. If not specified, the return URL configured on the [Admin Portal](https://dashboard.workos.com/admin-portal) page will be used.
              * @example https://example.com/admin-portal/return
              */
             return_url?: string;
             /**
-             * @description The URL to redirect the admin to when they finish setup. If not specified, the success URL configured on the [Redirects](https://dashboard.workos.com/redirects) page will be used.
+             * @description The URL to redirect the admin to when they finish setup. If not specified, the success URL configured on the [Admin Portal](https://dashboard.workos.com/admin-portal) page will be used.
              * @example https://example.com/admin-portal/success
              */
             success_url?: string;
@@ -29198,6 +29198,11 @@ export interface operations {
                      * @example org_01EHZNVPK3SFK441A1RGBFSHRT
                      */
                     organization_id?: string;
+                    /**
+                     * @description A [connected account](/reference/pipes/connected-account) identifier. Use this to select a specific connection when the user has several for this provider.
+                     * @example data_installation_01EHZNVPK3SFK441A1RGBFSHRT
+                     */
+                    connected_account_id?: string;
                 };
             };
         };
@@ -29249,7 +29254,7 @@ export interface operations {
                 };
                 content?: never;
             };
-            /** @description Data integration not found for the given provider slug. */
+            /** @description The data integration or selected connected account was not found. */
             404: {
                 headers: {
                     [name: string]: unknown;
@@ -29319,6 +29324,11 @@ export interface operations {
                      * @example org_01EHZNVPK3SFK441A1RGBFSHRT
                      */
                     organization_id?: string;
+                    /**
+                     * @description A [connected account](/reference/pipes/connected-account) identifier. Use this to select a specific connection when the user has several for this provider.
+                     * @example data_installation_01EHZNVPK3SFK441A1RGBFSHRT
+                     */
+                    connected_account_id?: string;
                 };
             };
         };
@@ -29354,7 +29364,7 @@ export interface operations {
                 };
                 content?: never;
             };
-            /** @description Data integration not found for the given provider slug. */
+            /** @description The data integration or selected connected account was not found. */
             404: {
                 headers: {
                     [name: string]: unknown;
@@ -38845,6 +38855,8 @@ export interface operations {
             query?: {
                 /** @description An [Organization](/reference/organization) identifier. Optional parameter if the connection is scoped to an organization. */
                 organization_id?: string;
+                /** @description A [connected account](/reference/pipes/connected-account) identifier. Use this to select a specific connection when the user has several for this provider. */
+                connected_account_id?: string;
             };
             header?: never;
             path: {
@@ -38866,6 +38878,21 @@ export interface operations {
                     "application/json": components["schemas"]["ConnectedAccount"];
                 };
             };
+            /** @description The connected account selector is malformed. */
+            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 The request is missing a valid API key. */
             401: {
                 headers: {
@@ -38910,6 +38937,8 @@ export interface operations {
             query?: {
                 /** @description An [Organization](/reference/organization) identifier. Optional parameter if the connection is scoped to an organization. */
                 organization_id?: string;
+                /** @description A [connected account](/reference/pipes/connected-account) identifier. Use this to select the connection to update. */
+                connected_account_id?: string;
             };
             header?: never;
             path: {
@@ -38935,6 +38964,21 @@ export interface operations {
                     "application/json": components["schemas"]["ConnectedAccount"];
                 };
             };
+            /** @description The connected account selector is malformed. */
+            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 The request is missing a valid API key. */
             401: {
                 headers: {
@@ -39063,6 +39107,8 @@ export interface operations {
             query?: {
                 /** @description An [Organization](/reference/organization) identifier. Optional parameter if the connection is scoped to an organization. */
                 organization_id?: string;
+                /** @description A [connected account](/reference/pipes/connected-account) identifier. Use this to select the connection to delete. */
+                connected_account_id?: string;
             };
             header?: never;
             path: {
@@ -39082,6 +39128,21 @@ export interface operations {
                 };
                 content?: never;
             };
+            /** @description The connected account selector is malformed. */
+            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 The request is missing a valid API key. */
             401: {
                 headers: {

package/package.json

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