@seamapi/types 1.1007.0 → 1.1008.0

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

@@ -13956,6 +13956,10 @@ export type Routes = {
                     display_name: string;
                     /** Full name of the user associated with the user identity. */
                     full_name: string | null;
+                    /** IDs that other user identities used to have before they were merged into this user identity. Looking up any of them returns this user identity. */
+                    merged_user_identity_ids: string[];
+                    /** Keys that other user identities used to have before they were merged into this user identity. Looking up any of them returns this user identity. */
+                    merged_user_identity_keys: string[];
                     /** Date and time at which the user identity was created. */
                     created_at: string;
                     /** ID of the workspace that contains the user identity. */
@@ -86875,6 +86879,10 @@ export type Routes = {
                     display_name: string;
                     /** Full name of the user associated with the user identity. */
                     full_name: string | null;
+                    /** IDs that other user identities used to have before they were merged into this user identity. Looking up any of them returns this user identity. */
+                    merged_user_identity_ids: string[];
+                    /** Keys that other user identities used to have before they were merged into this user identity. Looking up any of them returns this user identity. */
+                    merged_user_identity_keys: string[];
                     /** Date and time at which the user identity was created. */
                     created_at: string;
                     /** ID of the workspace that contains the user identity. */
@@ -111054,6 +111062,10 @@ export type Routes = {
                 display_name: string;
                 /** Full name of the user associated with the user identity. */
                 full_name: string | null;
+                /** IDs that other user identities used to have before they were merged into this user identity. Looking up any of them returns this user identity. */
+                merged_user_identity_ids: string[];
+                /** Keys that other user identities used to have before they were merged into this user identity. Looking up any of them returns this user identity. */
+                merged_user_identity_keys: string[];
                 /** Date and time at which the user identity was created. */
                 created_at: string;
                 /** ID of the workspace that contains the user identity. */
@@ -111281,6 +111293,10 @@ export type Routes = {
                 display_name: string;
                 /** Full name of the user associated with the user identity. */
                 full_name: string | null;
+                /** IDs that other user identities used to have before they were merged into this user identity. Looking up any of them returns this user identity. */
+                merged_user_identity_ids: string[];
+                /** Keys that other user identities used to have before they were merged into this user identity. Looking up any of them returns this user identity. */
+                merged_user_identity_keys: string[];
                 /** Date and time at which the user identity was created. */
                 created_at: string;
                 /** ID of the workspace that contains the user identity. */
@@ -111369,6 +111385,10 @@ export type Routes = {
                 display_name: string;
                 /** Full name of the user associated with the user identity. */
                 full_name: string | null;
+                /** IDs that other user identities used to have before they were merged into this user identity. Looking up any of them returns this user identity. */
+                merged_user_identity_ids: string[];
+                /** Keys that other user identities used to have before they were merged into this user identity. Looking up any of them returns this user identity. */
+                merged_user_identity_keys: string[];
                 /** Date and time at which the user identity was created. */
                 created_at: string;
                 /** ID of the workspace that contains the user identity. */
@@ -115076,6 +115096,26 @@ export type Routes = {
         };
         maxDuration: undefined;
     };
+    '/user_identities/merge': {
+        route: '/user_identities/merge';
+        method: 'POST';
+        queryParams: {};
+        jsonBody: {
+            /** ID of the primary user identity to keep. */
+            user_identity_id: string;
+            /** IDs of the user identities to merge into the primary user identity. These user identities are deleted. */
+            merged_user_identity_ids: string[];
+        } | {
+            /** Key of the primary user identity to keep. */
+            user_identity_key: string;
+            /** Keys of the user identities to merge into the primary user identity. These user identities are deleted. */
+            merged_user_identity_keys: string[];
+        };
+        commonParams: {};
+        formData: {};
+        jsonResponse: {};
+        maxDuration: undefined;
+    };
     '/user_identities/remove_acs_user': {
         route: '/user_identities/remove_acs_user';
         method: 'DELETE' | 'POST';
@@ -115129,6 +115169,10 @@ export type Routes = {
                 display_name: string;
                 /** Full name of the user associated with the user identity. */
                 full_name: string | null;
+                /** IDs that other user identities used to have before they were merged into this user identity. Looking up any of them returns this user identity. */
+                merged_user_identity_ids: string[];
+                /** Keys that other user identities used to have before they were merged into this user identity. Looking up any of them returns this user identity. */
+                merged_user_identity_keys: string[];
                 /** Date and time at which the user identity was created. */
                 created_at: string;
                 /** ID of the workspace that contains the user identity. */
@@ -115196,6 +115240,10 @@ export type Routes = {
                 display_name: string;
                 /** Full name of the user associated with the user identity. */
                 full_name: string | null;
+                /** IDs that other user identities used to have before they were merged into this user identity. Looking up any of them returns this user identity. */
+                merged_user_identity_ids: string[];
+                /** Keys that other user identities used to have before they were merged into this user identity. Looking up any of them returns this user identity. */
+                merged_user_identity_keys: string[];
                 /** Date and time at which the user identity was created. */
                 created_at: string;
                 /** ID of the workspace that contains the user identity. */
@@ -115648,6 +115696,10 @@ export type Routes = {
                     display_name: string;
                     /** Full name of the user associated with the user identity. */
                     full_name: string | null;
+                    /** IDs that other user identities used to have before they were merged into this user identity. Looking up any of them returns this user identity. */
+                    merged_user_identity_ids: string[];
+                    /** Keys that other user identities used to have before they were merged into this user identity. Looking up any of them returns this user identity. */
+                    merged_user_identity_keys: string[];
                     /** Date and time at which the user identity was created. */
                     created_at: string;
                     /** ID of the workspace that contains the user identity. */

package/package.json

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

package/src/lib/seam/connect/models/user-identities/user-identity.ts

@@ -129,6 +129,16 @@ export const user_identity = z.object({
     .min(1)
     .nullable()
     .describe('Full name of the user associated with the user identity.'),
+  merged_user_identity_ids: z
+    .array(z.string().uuid())
+    .describe(
+      'IDs that other user identities used to have before they were merged into this user identity. Looking up any of them returns this user identity.',
+    ),
+  merged_user_identity_keys: z
+    .array(z.string())
+    .describe(
+      'Keys that other user identities used to have before they were merged into this user identity. Looking up any of them returns this user identity.',
+    ),
   created_at: z
     .string()
     .datetime()

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

@@ -29602,6 +29602,18 @@ const openapi: OpenAPISpec = {
                 nullable: true,
                 type: 'string',
               },
+              merged_user_identity_ids: {
+                description:
+                  'IDs that other user identities used to have before they were merged into this user identity. Looking up any of them returns this user identity.',
+                items: { format: 'uuid', type: 'string' },
+                type: 'array',
+              },
+              merged_user_identity_keys: {
+                description:
+                  'Keys that other user identities used to have before they were merged into this user identity. Looking up any of them returns this user identity.',
+                items: { type: 'string' },
+                type: 'array',
+              },
               phone_number: {
                 description:
                   'Unique phone number for the user identity in [E.164 format](https://www.itu.int/rec/T-REC-E.164/en) (for example, +15555550100).',
@@ -29696,6 +29708,8 @@ const openapi: OpenAPISpec = {
               'phone_number',
               'display_name',
               'full_name',
+              'merged_user_identity_ids',
+              'merged_user_identity_keys',
               'created_at',
               'workspace_id',
               'errors',
@@ -36228,6 +36242,18 @@ const openapi: OpenAPISpec = {
             nullable: true,
             type: 'string',
           },
+          merged_user_identity_ids: {
+            description:
+              'IDs that other user identities used to have before they were merged into this user identity. Looking up any of them returns this user identity.',
+            items: { format: 'uuid', type: 'string' },
+            type: 'array',
+          },
+          merged_user_identity_keys: {
+            description:
+              'Keys that other user identities used to have before they were merged into this user identity. Looking up any of them returns this user identity.',
+            items: { type: 'string' },
+            type: 'array',
+          },
           phone_number: {
             description:
               'Unique phone number for the user identity in [E.164 format](https://www.itu.int/rec/T-REC-E.164/en) (for example, +15555550100).',
@@ -36312,6 +36338,8 @@ const openapi: OpenAPISpec = {
           'phone_number',
           'display_name',
           'full_name',
+          'merged_user_identity_ids',
+          'merged_user_identity_keys',
           'created_at',
           'workspace_id',
           'errors',
@@ -36411,6 +36439,18 @@ const openapi: OpenAPISpec = {
             nullable: true,
             type: 'string',
           },
+          merged_user_identity_ids: {
+            description:
+              'IDs that other user identities used to have before they were merged into this user identity. Looking up any of them returns this user identity.',
+            items: { format: 'uuid', type: 'string' },
+            type: 'array',
+          },
+          merged_user_identity_keys: {
+            description:
+              'Keys that other user identities used to have before they were merged into this user identity. Looking up any of them returns this user identity.',
+            items: { type: 'string' },
+            type: 'array',
+          },
           phone_number: {
             description:
               'Unique phone number for the user identity in [E.164 format](https://www.itu.int/rec/T-REC-E.164/en) (for example, +15555550100).',
@@ -36502,6 +36542,8 @@ const openapi: OpenAPISpec = {
           'phone_number',
           'display_name',
           'full_name',
+          'merged_user_identity_ids',
+          'merged_user_identity_keys',
           'created_at',
           'workspace_id',
           'errors',
@@ -85732,6 +85774,92 @@ const openapi: OpenAPISpec = {
         'x-title': 'List ACS Users Associated with a User Identity',
       },
     },
+    '/user_identities/merge': {
+      post: {
+        description:
+          'Merges one or more [user identities](https://docs.seam.co/capability-guides/mobile-access/managing-mobile-app-user-accounts-with-user-identities#what-is-a-user-identity) into a primary user identity, for when the same person ended up with more than one user identity.\n\nThe primary user identity takes on any email address or phone number it was missing from the user identities merged into it, and the merged user identities are then deleted. Their IDs and keys keep working: looking one up returns the primary user identity, and they are listed on it as `merged_user_identity_ids` and `merged_user_identity_keys`.\n\nAccess grants, access system users, client sessions and other resources belonging to the merged user identities are moved to the primary user identity.\n\nIdentify the user identities either by ID or by key, but not both in the same request. Repeating a merge that has already been applied makes no further changes.',
+        operationId: 'userIdentitiesMergePost',
+        requestBody: {
+          content: {
+            'application/json': {
+              schema: {
+                oneOf: [
+                  {
+                    properties: {
+                      merged_user_identity_ids: {
+                        description:
+                          'IDs of the user identities to merge into the primary user identity. These user identities are deleted.',
+                        items: { format: 'uuid', type: 'string' },
+                        maxItems: 20,
+                        minItems: 1,
+                        type: 'array',
+                      },
+                      user_identity_id: {
+                        description: 'ID of the primary user identity to keep.',
+                        format: 'uuid',
+                        type: 'string',
+                      },
+                    },
+                    required: ['user_identity_id', 'merged_user_identity_ids'],
+                    type: 'object',
+                  },
+                  {
+                    properties: {
+                      merged_user_identity_keys: {
+                        description:
+                          'Keys of the user identities to merge into the primary user identity. These user identities are deleted.',
+                        items: { minLength: 1, type: 'string' },
+                        maxItems: 20,
+                        minItems: 1,
+                        type: 'array',
+                      },
+                      user_identity_key: {
+                        description:
+                          'Key of the primary user identity to keep.',
+                        minLength: 1,
+                        type: 'string',
+                      },
+                    },
+                    required: [
+                      'user_identity_key',
+                      'merged_user_identity_keys',
+                    ],
+                    type: 'object',
+                  },
+                ],
+              },
+            },
+          },
+        },
+        responses: {
+          '200': {
+            content: {
+              'application/json': {
+                schema: {
+                  properties: { ok: { type: 'boolean' } },
+                  required: ['ok'],
+                  type: 'object',
+                },
+              },
+            },
+            description: 'OK',
+          },
+          '400': { description: 'Bad Request' },
+          '401': { description: 'Unauthorized' },
+        },
+        security: [
+          { api_key: [] },
+          { pat_with_workspace: [] },
+          { console_session_with_workspace: [] },
+        ],
+        summary: '/user_identities/merge',
+        tags: ['/user_identities'],
+        'x-fern-sdk-group-name': ['user_identities'],
+        'x-fern-sdk-method-name': 'merge',
+        'x-response-key': null,
+        'x-title': 'Merge User Identities',
+      },
+    },
     '/user_identities/remove_acs_user': {
       delete: {
         description:

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

@@ -16281,6 +16281,10 @@ export type Routes = {
               display_name: string
               /** Full name of the user associated with the user identity. */
               full_name: string | null
+              /** IDs that other user identities used to have before they were merged into this user identity. Looking up any of them returns this user identity. */
+              merged_user_identity_ids: string[]
+              /** Keys that other user identities used to have before they were merged into this user identity. Looking up any of them returns this user identity. */
+              merged_user_identity_keys: string[]
               /** Date and time at which the user identity was created. */
               created_at: string
               /** ID of the workspace that contains the user identity. */
@@ -104306,6 +104310,10 @@ export type Routes = {
           display_name: string
           /** Full name of the user associated with the user identity. */
           full_name: string | null
+          /** IDs that other user identities used to have before they were merged into this user identity. Looking up any of them returns this user identity. */
+          merged_user_identity_ids: string[]
+          /** Keys that other user identities used to have before they were merged into this user identity. Looking up any of them returns this user identity. */
+          merged_user_identity_keys: string[]
           /** Date and time at which the user identity was created. */
           created_at: string
           /** ID of the workspace that contains the user identity. */
@@ -133039,6 +133047,10 @@ export type Routes = {
         display_name: string
         /** Full name of the user associated with the user identity. */
         full_name: string | null
+        /** IDs that other user identities used to have before they were merged into this user identity. Looking up any of them returns this user identity. */
+        merged_user_identity_ids: string[]
+        /** Keys that other user identities used to have before they were merged into this user identity. Looking up any of them returns this user identity. */
+        merged_user_identity_keys: string[]
         /** Date and time at which the user identity was created. */
         created_at: string
         /** ID of the workspace that contains the user identity. */
@@ -133273,6 +133285,10 @@ export type Routes = {
         display_name: string
         /** Full name of the user associated with the user identity. */
         full_name: string | null
+        /** IDs that other user identities used to have before they were merged into this user identity. Looking up any of them returns this user identity. */
+        merged_user_identity_ids: string[]
+        /** Keys that other user identities used to have before they were merged into this user identity. Looking up any of them returns this user identity. */
+        merged_user_identity_keys: string[]
         /** Date and time at which the user identity was created. */
         created_at: string
         /** ID of the workspace that contains the user identity. */
@@ -133364,6 +133380,10 @@ export type Routes = {
         display_name: string
         /** Full name of the user associated with the user identity. */
         full_name: string | null
+        /** IDs that other user identities used to have before they were merged into this user identity. Looking up any of them returns this user identity. */
+        merged_user_identity_ids: string[]
+        /** Keys that other user identities used to have before they were merged into this user identity. Looking up any of them returns this user identity. */
+        merged_user_identity_keys: string[]
         /** Date and time at which the user identity was created. */
         created_at: string
         /** ID of the workspace that contains the user identity. */
@@ -137973,6 +137993,28 @@ export type Routes = {
     }
     maxDuration: undefined
   }
+  '/user_identities/merge': {
+    route: '/user_identities/merge'
+    method: 'POST'
+    queryParams: {}
+    jsonBody:
+      | {
+          /** ID of the primary user identity to keep. */
+          user_identity_id: string
+          /** IDs of the user identities to merge into the primary user identity. These user identities are deleted. */
+          merged_user_identity_ids: string[]
+        }
+      | {
+          /** Key of the primary user identity to keep. */
+          user_identity_key: string
+          /** Keys of the user identities to merge into the primary user identity. These user identities are deleted. */
+          merged_user_identity_keys: string[]
+        }
+    commonParams: {}
+    formData: {}
+    jsonResponse: {}
+    maxDuration: undefined
+  }
   '/user_identities/remove_acs_user': {
     route: '/user_identities/remove_acs_user'
     method: 'DELETE' | 'POST'
@@ -138026,6 +138068,10 @@ export type Routes = {
         display_name: string
         /** Full name of the user associated with the user identity. */
         full_name: string | null
+        /** IDs that other user identities used to have before they were merged into this user identity. Looking up any of them returns this user identity. */
+        merged_user_identity_ids: string[]
+        /** Keys that other user identities used to have before they were merged into this user identity. Looking up any of them returns this user identity. */
+        merged_user_identity_keys: string[]
         /** Date and time at which the user identity was created. */
         created_at: string
         /** ID of the workspace that contains the user identity. */
@@ -138096,6 +138142,10 @@ export type Routes = {
         display_name: string
         /** Full name of the user associated with the user identity. */
         full_name: string | null
+        /** IDs that other user identities used to have before they were merged into this user identity. Looking up any of them returns this user identity. */
+        merged_user_identity_ids: string[]
+        /** Keys that other user identities used to have before they were merged into this user identity. Looking up any of them returns this user identity. */
+        merged_user_identity_keys: string[]
         /** Date and time at which the user identity was created. */
         created_at: string
         /** ID of the workspace that contains the user identity. */
@@ -138580,6 +138630,10 @@ export type Routes = {
               display_name: string
               /** Full name of the user associated with the user identity. */
               full_name: string | null
+              /** IDs that other user identities used to have before they were merged into this user identity. Looking up any of them returns this user identity. */
+              merged_user_identity_ids: string[]
+              /** Keys that other user identities used to have before they were merged into this user identity. Looking up any of them returns this user identity. */
+              merged_user_identity_keys: string[]
               /** Date and time at which the user identity was created. */
               created_at: string
               /** ID of the workspace that contains the user identity. */