@seamapi/types 1.412.0 → 1.413.0

package/lib/seam/connect/route-types.d.ts

@@ -18870,8 +18870,11 @@ export interface Routes {
             connect_webview_ids?: string[] | undefined;
             /** IDs of the [connected accounts](https://docs.seam.co/latest/core-concepts/connected-accounts) for which you want to create a client session. */
             connected_account_ids?: string[] | undefined;
-            /** IDs of the [user identities](https://docs.seam.co/latest/capability-guides/mobile-access/managing-mobile-app-user-accounts-with-user-identities#what-is-a-user-identity) for which you want to create a client session. */
+            /** IDs of the [user identities](https://docs.seam.co/latest/capability-guides/mobile-access/managing-mobile-app-user-accounts-with-user-identities#what-is-a-user-identity) that you want to associate with the client session.
+             * @deprecated Use `user_identity_id`. */
             user_identity_ids?: string[] | undefined;
+            /** ID of the [user identity](https://docs.seam.co/latest/capability-guides/mobile-access/managing-mobile-app-user-accounts-with-user-identities#what-is-a-user-identity) for which you want to create a client session. */
+            user_identity_id?: string | undefined;
             /** Date and time at which the client session should expire, in [ISO 8601](https://www.iso.org/iso-8601-date-and-time-format.html) format. */
             expires_at?: Date | undefined;
         };
@@ -18898,7 +18901,9 @@ export interface Routes {
                 customer_id?: string | undefined;
                 connected_account_ids: string[];
                 connect_webview_ids: string[];
+                /** deprecated: Use `user_identity_id`. */
                 user_identity_ids: string[];
+                user_identity_id?: string | undefined;
             };
         };
     };
@@ -18947,7 +18952,9 @@ export interface Routes {
                 customer_id?: string | undefined;
                 connected_account_ids: string[];
                 connect_webview_ids: string[];
+                /** deprecated: Use `user_identity_id`. */
                 user_identity_ids: string[];
+                user_identity_id?: string | undefined;
             };
         };
     };
@@ -18962,8 +18969,11 @@ export interface Routes {
             connect_webview_ids?: string[] | undefined;
             /** IDs of the [connected accounts](https://docs.seam.co/latest/api/connected_accounts) that you want to associate with the client session (or that are already associated with the existing client session). */
             connected_account_ids?: string[] | undefined;
-            /** IDs of the [user identities](https://docs.seam.co/latest/capability-guides/mobile-access/managing-mobile-app-user-accounts-with-user-identities#what-is-a-user-identity) that you want to associate with the client session (or that are already associated with the existing client session). */
+            /** IDs of the [user identities](https://docs.seam.co/latest/capability-guides/mobile-access/managing-mobile-app-user-accounts-with-user-identities#what-is-a-user-identity) that you want to associate with the client session.
+             * @deprecated Use `user_identity_id`. */
             user_identity_ids?: string[] | undefined;
+            /** ID of the [user identity](https://docs.seam.co/latest/capability-guides/mobile-access/managing-mobile-app-user-accounts-with-user-identities#what-is-a-user-identity) that you want to associate with the client session (or that are already associated with the existing client session). */
+            user_identity_id?: string | undefined;
             /** Date and time at which the client session should expire (or at which the existing client session expires), in [ISO 8601](https://www.iso.org/iso-8601-date-and-time-format.html) format. */
             expires_at?: Date | undefined;
         };
@@ -18990,7 +19000,9 @@ export interface Routes {
                 customer_id?: string | undefined;
                 connected_account_ids: string[];
                 connect_webview_ids: string[];
+                /** deprecated: Use `user_identity_id`. */
                 user_identity_ids: string[];
+                user_identity_id?: string | undefined;
             };
         };
     };
@@ -19008,8 +19020,11 @@ export interface Routes {
             connected_account_ids?: string[] | undefined;
             /** IDs of the [Connect Webviews](https://docs.seam.co/latest/core-concepts/connect-webviews) that you want to associate with the client session. */
             connect_webview_ids?: string[] | undefined;
-            /** IDs of the [user identities](https://docs.seam.co/latest/capability-guides/mobile-access/managing-mobile-app-user-accounts-with-user-identities#what-is-a-user-identity) that you want to associate with the client session. */
+            /** IDs of the [user identities](https://docs.seam.co/latest/capability-guides/mobile-access/managing-mobile-app-user-accounts-with-user-identities#what-is-a-user-identity) that you want to associate with the client session.
+             * @deprecated Use `user_identity_id`. */
             user_identity_ids?: string[] | undefined;
+            /** ID of the [user identity](https://docs.seam.co/latest/capability-guides/mobile-access/managing-mobile-app-user-accounts-with-user-identities#what-is-a-user-identity) that you want to associate with the client session. */
+            user_identity_id?: string | undefined;
         };
         formData: {};
         jsonResponse: {
@@ -19033,7 +19048,9 @@ export interface Routes {
                 customer_id?: string | undefined;
                 connected_account_ids: string[];
                 connect_webview_ids: string[];
+                /** deprecated: Use `user_identity_id`. */
                 user_identity_ids: string[];
+                user_identity_id?: string | undefined;
             };
         };
     };
@@ -19067,7 +19084,9 @@ export interface Routes {
                 customer_id?: string | undefined;
                 connected_account_ids: string[];
                 connect_webview_ids: string[];
+                /** deprecated: Use `user_identity_id`. */
                 user_identity_ids: string[];
+                user_identity_id?: string | undefined;
             }>;
         };
     };
@@ -41698,7 +41717,9 @@ export interface Routes {
                 customer_id?: string | undefined;
                 connected_account_ids: string[];
                 connect_webview_ids: string[];
+                /** deprecated: Use `user_identity_id`. */
                 user_identity_ids: string[];
+                user_identity_id?: string | undefined;
             };
         };
     };

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@seamapi/types",
-  "version": "1.412.0",
+  "version": "1.413.0",
   "description": "TypeScript types for the Seam API.",
   "type": "module",
   "main": "index.js",

package/src/lib/seam/connect/models/client-sessions/client-session.ts

@@ -11,7 +11,10 @@ export const client_session = z.object({
   customer_id: z.string().uuid().optional(),
   connected_account_ids: z.array(z.string().uuid()),
   connect_webview_ids: z.array(z.string().uuid()),
-  user_identity_ids: z.array(z.string().uuid()),
+  user_identity_ids: z
+    .array(z.string().uuid())
+    .describe('deprecated: Use `user_identity_id`.'),
+  user_identity_id: z.string().uuid().optional(),
 }).describe(`
   ---
   route_path: /client_sessions

package/src/lib/seam/connect/openapi.ts

@@ -7337,7 +7337,9 @@ export default {
           expires_at: { format: 'date-time', type: 'string' },
           token: { type: 'string' },
           user_identifier_key: { nullable: true, type: 'string' },
+          user_identity_id: { format: 'uuid', type: 'string' },
           user_identity_ids: {
+            description: 'deprecated: Use `user_identity_id`.',
             items: { format: 'uuid', type: 'string' },
             type: 'array',
           },
@@ -27878,11 +27880,20 @@ export default {
                     minLength: 1,
                     type: 'string',
                   },
+                  user_identity_id: {
+                    description:
+                      'ID of the [user identity](https://docs.seam.co/latest/capability-guides/mobile-access/managing-mobile-app-user-accounts-with-user-identities#what-is-a-user-identity) for which you want to create a client session.',
+                    type: 'string',
+                  },
                   user_identity_ids: {
+                    deprecated: true,
                     description:
-                      'IDs of the [user identities](https://docs.seam.co/latest/capability-guides/mobile-access/managing-mobile-app-user-accounts-with-user-identities#what-is-a-user-identity) for which you want to create a client session.',
+                      'IDs of the [user identities](https://docs.seam.co/latest/capability-guides/mobile-access/managing-mobile-app-user-accounts-with-user-identities#what-is-a-user-identity) that you want to associate with the client session.',
                     items: { type: 'string' },
+                    maxItems: 1,
+                    minItems: 1,
                     type: 'array',
+                    'x-deprecated': 'Use `user_identity_id`.',
                   },
                 },
                 type: 'object',
@@ -27960,11 +27971,20 @@ export default {
                     minLength: 1,
                     type: 'string',
                   },
+                  user_identity_id: {
+                    description:
+                      'ID of the [user identity](https://docs.seam.co/latest/capability-guides/mobile-access/managing-mobile-app-user-accounts-with-user-identities#what-is-a-user-identity) for which you want to create a client session.',
+                    type: 'string',
+                  },
                   user_identity_ids: {
+                    deprecated: true,
                     description:
-                      'IDs of the [user identities](https://docs.seam.co/latest/capability-guides/mobile-access/managing-mobile-app-user-accounts-with-user-identities#what-is-a-user-identity) for which you want to create a client session.',
+                      'IDs of the [user identities](https://docs.seam.co/latest/capability-guides/mobile-access/managing-mobile-app-user-accounts-with-user-identities#what-is-a-user-identity) that you want to associate with the client session.',
                     items: { type: 'string' },
+                    maxItems: 1,
+                    minItems: 1,
                     type: 'array',
+                    'x-deprecated': 'Use `user_identity_id`.',
                   },
                 },
                 type: 'object',
@@ -28154,11 +28174,20 @@ export default {
                     minLength: 1,
                     type: 'string',
                   },
+                  user_identity_id: {
+                    description:
+                      'ID of the [user identity](https://docs.seam.co/latest/capability-guides/mobile-access/managing-mobile-app-user-accounts-with-user-identities#what-is-a-user-identity) that you want to associate with the client session (or that are already associated with the existing client session).',
+                    type: 'string',
+                  },
                   user_identity_ids: {
+                    deprecated: true,
                     description:
-                      'IDs of the [user identities](https://docs.seam.co/latest/capability-guides/mobile-access/managing-mobile-app-user-accounts-with-user-identities#what-is-a-user-identity) that you want to associate with the client session (or that are already associated with the existing client session).',
+                      'IDs of the [user identities](https://docs.seam.co/latest/capability-guides/mobile-access/managing-mobile-app-user-accounts-with-user-identities#what-is-a-user-identity) that you want to associate with the client session.',
                     items: { type: 'string' },
+                    maxItems: 1,
+                    minItems: 1,
                     type: 'array',
+                    'x-deprecated': 'Use `user_identity_id`.',
                   },
                 },
                 type: 'object',
@@ -28234,11 +28263,20 @@ export default {
                       'Your user ID for the user that you want to associate with the client session.',
                     type: 'string',
                   },
+                  user_identity_id: {
+                    description:
+                      'ID of the [user identity](https://docs.seam.co/latest/capability-guides/mobile-access/managing-mobile-app-user-accounts-with-user-identities#what-is-a-user-identity) that you want to associate with the client session.',
+                    type: 'string',
+                  },
                   user_identity_ids: {
+                    deprecated: true,
                     description:
                       'IDs of the [user identities](https://docs.seam.co/latest/capability-guides/mobile-access/managing-mobile-app-user-accounts-with-user-identities#what-is-a-user-identity) that you want to associate with the client session.',
                     items: { type: 'string' },
+                    maxItems: 1,
+                    minItems: 1,
                     type: 'array',
+                    'x-deprecated': 'Use `user_identity_id`.',
                   },
                 },
                 type: 'object',
@@ -28309,11 +28347,20 @@ export default {
                       'Your user ID for the user that you want to associate with the client session.',
                     type: 'string',
                   },
+                  user_identity_id: {
+                    description:
+                      'ID of the [user identity](https://docs.seam.co/latest/capability-guides/mobile-access/managing-mobile-app-user-accounts-with-user-identities#what-is-a-user-identity) that you want to associate with the client session.',
+                    type: 'string',
+                  },
                   user_identity_ids: {
+                    deprecated: true,
                     description:
                       'IDs of the [user identities](https://docs.seam.co/latest/capability-guides/mobile-access/managing-mobile-app-user-accounts-with-user-identities#what-is-a-user-identity) that you want to associate with the client session.',
                     items: { type: 'string' },
+                    maxItems: 1,
+                    minItems: 1,
                     type: 'array',
+                    'x-deprecated': 'Use `user_identity_id`.',
                   },
                 },
                 type: 'object',

package/src/lib/seam/connect/route-types.ts

@@ -21862,8 +21862,11 @@ export interface Routes {
       connect_webview_ids?: string[] | undefined
       /** IDs of the [connected accounts](https://docs.seam.co/latest/core-concepts/connected-accounts) for which you want to create a client session. */
       connected_account_ids?: string[] | undefined
-      /** IDs of the [user identities](https://docs.seam.co/latest/capability-guides/mobile-access/managing-mobile-app-user-accounts-with-user-identities#what-is-a-user-identity) for which you want to create a client session. */
+      /** IDs of the [user identities](https://docs.seam.co/latest/capability-guides/mobile-access/managing-mobile-app-user-accounts-with-user-identities#what-is-a-user-identity) that you want to associate with the client session.
+       * @deprecated Use `user_identity_id`. */
       user_identity_ids?: string[] | undefined
+      /** ID of the [user identity](https://docs.seam.co/latest/capability-guides/mobile-access/managing-mobile-app-user-accounts-with-user-identities#what-is-a-user-identity) for which you want to create a client session. */
+      user_identity_id?: string | undefined
       /** Date and time at which the client session should expire, in [ISO 8601](https://www.iso.org/iso-8601-date-and-time-format.html) format. */
       expires_at?: Date | undefined
     }
@@ -21890,7 +21893,9 @@ export interface Routes {
         customer_id?: string | undefined
         connected_account_ids: string[]
         connect_webview_ids: string[]
+        /** deprecated: Use `user_identity_id`. */
         user_identity_ids: string[]
+        user_identity_id?: string | undefined
       }
     }
   }
@@ -21939,7 +21944,9 @@ export interface Routes {
         customer_id?: string | undefined
         connected_account_ids: string[]
         connect_webview_ids: string[]
+        /** deprecated: Use `user_identity_id`. */
         user_identity_ids: string[]
+        user_identity_id?: string | undefined
       }
     }
   }
@@ -21954,8 +21961,11 @@ export interface Routes {
       connect_webview_ids?: string[] | undefined
       /** IDs of the [connected accounts](https://docs.seam.co/latest/api/connected_accounts) that you want to associate with the client session (or that are already associated with the existing client session). */
       connected_account_ids?: string[] | undefined
-      /** IDs of the [user identities](https://docs.seam.co/latest/capability-guides/mobile-access/managing-mobile-app-user-accounts-with-user-identities#what-is-a-user-identity) that you want to associate with the client session (or that are already associated with the existing client session). */
+      /** IDs of the [user identities](https://docs.seam.co/latest/capability-guides/mobile-access/managing-mobile-app-user-accounts-with-user-identities#what-is-a-user-identity) that you want to associate with the client session.
+       * @deprecated Use `user_identity_id`. */
       user_identity_ids?: string[] | undefined
+      /** ID of the [user identity](https://docs.seam.co/latest/capability-guides/mobile-access/managing-mobile-app-user-accounts-with-user-identities#what-is-a-user-identity) that you want to associate with the client session (or that are already associated with the existing client session). */
+      user_identity_id?: string | undefined
       /** Date and time at which the client session should expire (or at which the existing client session expires), in [ISO 8601](https://www.iso.org/iso-8601-date-and-time-format.html) format. */
       expires_at?: Date | undefined
     }
@@ -21982,7 +21992,9 @@ export interface Routes {
         customer_id?: string | undefined
         connected_account_ids: string[]
         connect_webview_ids: string[]
+        /** deprecated: Use `user_identity_id`. */
         user_identity_ids: string[]
+        user_identity_id?: string | undefined
       }
     }
   }
@@ -22000,8 +22012,11 @@ export interface Routes {
       connected_account_ids?: string[] | undefined
       /** IDs of the [Connect Webviews](https://docs.seam.co/latest/core-concepts/connect-webviews) that you want to associate with the client session. */
       connect_webview_ids?: string[] | undefined
-      /** IDs of the [user identities](https://docs.seam.co/latest/capability-guides/mobile-access/managing-mobile-app-user-accounts-with-user-identities#what-is-a-user-identity) that you want to associate with the client session. */
+      /** IDs of the [user identities](https://docs.seam.co/latest/capability-guides/mobile-access/managing-mobile-app-user-accounts-with-user-identities#what-is-a-user-identity) that you want to associate with the client session.
+       * @deprecated Use `user_identity_id`. */
       user_identity_ids?: string[] | undefined
+      /** ID of the [user identity](https://docs.seam.co/latest/capability-guides/mobile-access/managing-mobile-app-user-accounts-with-user-identities#what-is-a-user-identity) that you want to associate with the client session. */
+      user_identity_id?: string | undefined
     }
     formData: {}
     jsonResponse: {
@@ -22025,7 +22040,9 @@ export interface Routes {
         customer_id?: string | undefined
         connected_account_ids: string[]
         connect_webview_ids: string[]
+        /** deprecated: Use `user_identity_id`. */
         user_identity_ids: string[]
+        user_identity_id?: string | undefined
       }
     }
   }
@@ -22059,7 +22076,9 @@ export interface Routes {
         customer_id?: string | undefined
         connected_account_ids: string[]
         connect_webview_ids: string[]
+        /** deprecated: Use `user_identity_id`. */
         user_identity_ids: string[]
+        user_identity_id?: string | undefined
       }>
     }
   }
@@ -49120,7 +49139,9 @@ export interface Routes {
         customer_id?: string | undefined
         connected_account_ids: string[]
         connect_webview_ids: string[]
+        /** deprecated: Use `user_identity_id`. */
         user_identity_ids: string[]
+        user_identity_id?: string | undefined
       }
     }
   }