@seamapi/types 1.293.1 → 1.294.1

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

@@ -24212,7 +24212,9 @@ export interface Routes {
         queryParams: {};
         jsonBody: {};
         commonParams: {
+            /** ID of the desired user identity. */
             user_identity_id: string;
+            /** ID of the desired ACS user. */
             acs_user_id: string;
         };
         formData: {};
@@ -24224,21 +24226,32 @@ export interface Routes {
         queryParams: {};
         jsonBody: {};
         commonParams: {
+            /** Unique key for the user identity. */
             user_identity_key?: (string | null) | undefined;
+            /** Unique email address for the user identity. */
             email_address?: (string | null) | undefined;
+            /** Unique phone number for the user identity in E.164 format (for example, +15555550100). */
             phone_number?: (string | null) | undefined;
+            /** Full name of the user associated with the user identity. */
             full_name?: (string | null) | undefined;
         };
         formData: {};
         jsonResponse: {
+            /** Represents a [user identity](https://docs.seam.co/latest/capability-guides/mobile-access-in-development/managing-mobile-app-user-accounts-with-user-identities#what-is-a-user-identity) associated with an application user account. */
             user_identity: {
+                /** ID of the user identity. */
                 user_identity_id: string;
+                /** Unique key for the user identity. */
                 user_identity_key: string | null;
+                /** Unique email address for the user identity. */
                 email_address: string | null;
+                /** Unique phone number for the user identity in [E.164 format](https://www.itu.int/rec/T-REC-E.164/en) (for example, +15555550100). */
                 phone_number: string | null;
                 display_name: string;
                 full_name: string | null;
+                /** Date and time at which the user identity was created. */
                 created_at: string;
+                /** ID of the [workspace](https://docs.seam.co/latest/core-concepts/workspaces) that contains the user identity. */
                 workspace_id: string;
             };
         };
@@ -24249,6 +24262,7 @@ export interface Routes {
         queryParams: {};
         jsonBody: {};
         commonParams: {
+            /** ID of the desired user identity. */
             user_identity_id: string;
         };
         formData: {};
@@ -24260,6 +24274,7 @@ export interface Routes {
         queryParams: {};
         jsonBody: {};
         commonParams: {
+            /** ID of the desired enrollment automation. */
             enrollment_automation_id: string;
         };
         formData: {};
@@ -24271,16 +24286,23 @@ export interface Routes {
         queryParams: {};
         jsonBody: {};
         commonParams: {
+            /** ID of the desired enrollment automation. */
             enrollment_automation_id: string;
         };
         formData: {};
         jsonResponse: {
+            /** Represents an [enrollment automation](https://docs.seam.co/latest/capability-guides/mobile-access-in-development/issuing-mobile-credentials-from-an-access-control-system) within the [Seam mobile access solution](https://docs.seam.co/latest/capability-guides/mobile-access-in-development). */
             enrollment_automation: {
+                /** ID of the enrollment automation. */
+                enrollment_automation_id: string;
+                /** ID of the associated [ACS system](https://docs.seam.co/latest/capability-guides/access-systems) that serves as the credential manager. */
                 credential_manager_acs_system_id: string;
+                /** ID of the associated [user identity](https://docs.seam.co/latest/capability-guides/mobile-access-in-development/managing-mobile-app-user-accounts-with-user-identities#what-is-a-user-identity). */
                 user_identity_id: string;
+                /** Date and time at which the enrollment automation was created. */
                 created_at: string;
+                /** ID of the [workspace](https://docs.seam.co/latest/core-concepts/workspaces) that contains the enrollment automation. */
                 workspace_id: string;
-                enrollment_automation_id: string;
             };
         };
     };
@@ -24290,10 +24312,15 @@ export interface Routes {
         queryParams: {};
         jsonBody: {};
         commonParams: {
+            /** ID of the desired user identity. */
             user_identity_id: string;
+            /** ID of the desired ACS system that serves as the credential manager. */
             credential_manager_acs_system_id: string;
+            /** ID of the ACS credential pool from which to obtain credentials for the user identity. */
             acs_credential_pool_id?: string | undefined;
+            /** Indicates whether to create an associated credential manager user. If you set `create_credential_manager_user` to `true`, you cannot specify a `credential_manager_acs_user_id`. */
             create_credential_manager_user?: boolean | undefined;
+            /** ID of the associated ACS user within the credential manager. If you specify a `credential_manager_acs_user_id`, you cannot set `create_credential_manager_user` to `true`. */
             credential_manager_acs_user_id?: string | undefined;
         };
         formData: {};
@@ -24314,16 +24341,22 @@ export interface Routes {
         queryParams: {};
         jsonBody: {};
         commonParams: {
+            /** ID of the user identity for which you want to retrieve all enrollment automations. */
             user_identity_id: string;
         };
         formData: {};
         jsonResponse: {
             enrollment_automations: Array<{
+                /** ID of the enrollment automation. */
+                enrollment_automation_id: string;
+                /** ID of the associated [ACS system](https://docs.seam.co/latest/capability-guides/access-systems) that serves as the credential manager. */
                 credential_manager_acs_system_id: string;
+                /** ID of the associated [user identity](https://docs.seam.co/latest/capability-guides/mobile-access-in-development/managing-mobile-app-user-accounts-with-user-identities#what-is-a-user-identity). */
                 user_identity_id: string;
+                /** Date and time at which the enrollment automation was created. */
                 created_at: string;
+                /** ID of the [workspace](https://docs.seam.co/latest/core-concepts/workspaces) that contains the enrollment automation. */
                 workspace_id: string;
-                enrollment_automation_id: string;
             }>;
         };
     };
@@ -24333,20 +24366,28 @@ export interface Routes {
         queryParams: {};
         jsonBody: {};
         commonParams: {
+            /** ID of the desired user identity. */
             user_identity_id: string;
         } | {
             user_identity_key: string;
         };
         formData: {};
         jsonResponse: {
+            /** Represents a [user identity](https://docs.seam.co/latest/capability-guides/mobile-access-in-development/managing-mobile-app-user-accounts-with-user-identities#what-is-a-user-identity) associated with an application user account. */
             user_identity: {
+                /** ID of the user identity. */
                 user_identity_id: string;
+                /** Unique key for the user identity. */
                 user_identity_key: string | null;
+                /** Unique email address for the user identity. */
                 email_address: string | null;
+                /** Unique phone number for the user identity in [E.164 format](https://www.itu.int/rec/T-REC-E.164/en) (for example, +15555550100). */
                 phone_number: string | null;
                 display_name: string;
                 full_name: string | null;
+                /** Date and time at which the user identity was created. */
                 created_at: string;
+                /** ID of the [workspace](https://docs.seam.co/latest/core-concepts/workspaces) that contains the user identity. */
                 workspace_id: string;
             };
         };
@@ -24357,7 +24398,9 @@ export interface Routes {
         queryParams: {};
         jsonBody: {};
         commonParams: {
+            /** ID of the desired user identity. */
             user_identity_id: string;
+            /** ID of the desired managed device. */
             device_id: string;
         };
         formData: {};
@@ -24374,13 +24417,19 @@ export interface Routes {
         formData: {};
         jsonResponse: {
             user_identities: Array<{
+                /** ID of the user identity. */
                 user_identity_id: string;
+                /** Unique key for the user identity. */
                 user_identity_key: string | null;
+                /** Unique email address for the user identity. */
                 email_address: string | null;
+                /** Unique phone number for the user identity in [E.164 format](https://www.itu.int/rec/T-REC-E.164/en) (for example, +15555550100). */
                 phone_number: string | null;
                 display_name: string;
                 full_name: string | null;
+                /** Date and time at which the user identity was created. */
                 created_at: string;
+                /** ID of the [workspace](https://docs.seam.co/latest/core-concepts/workspaces) that contains the user identity. */
                 workspace_id: string;
             }>;
         };
@@ -24391,6 +24440,7 @@ export interface Routes {
         queryParams: {};
         jsonBody: {};
         commonParams: {
+            /** ID of the user identity for which you want to retrieve all accessible devices. */
             user_identity_id: string;
         };
         formData: {};
@@ -25431,6 +25481,7 @@ export interface Routes {
         queryParams: {};
         jsonBody: {};
         commonParams: {
+            /** ID of the user identity for which you want to retrieve all access control systems. */
             user_identity_id: string;
         };
         formData: {};
@@ -25539,6 +25590,7 @@ export interface Routes {
         queryParams: {};
         jsonBody: {};
         commonParams: {
+            /** ID of the user identity for which you want to retrieve all ACS users. */
             user_identity_id: string;
         };
         formData: {};
@@ -25641,7 +25693,9 @@ export interface Routes {
         queryParams: {};
         jsonBody: {};
         commonParams: {
+            /** ID of the desired user identity. */
             user_identity_id: string;
+            /** ID of the ACS user. */
             acs_user_id: string;
         };
         formData: {};
@@ -25653,7 +25707,9 @@ export interface Routes {
         queryParams: {};
         jsonBody: {};
         commonParams: {
+            /** ID of the desired user identity. */
             user_identity_id: string;
+            /** ID of the desired managed device. */
             device_id: string;
         };
         formData: {};
@@ -25664,9 +25720,13 @@ export interface Routes {
         method: 'PATCH' | 'POST';
         queryParams: {};
         jsonBody: {
+            /** ID of the user identity. */
             user_identity_id: string;
+            /** Unique key for the user identity. */
             user_identity_key?: (string | null) | undefined;
+            /** Unique email address for the user identity. */
             email_address?: (string | null) | undefined;
+            /** Unique phone number for the user identity in [E.164 format](https://www.itu.int/rec/T-REC-E.164/en) (for example, +15555550100). */
             phone_number?: (string | null) | undefined;
             full_name?: (string | null) | undefined;
         };

package/package.json

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

package/src/lib/seam/connect/models/acs/acs-credential-provisioning-automation.ts

@@ -8,14 +8,39 @@ export const acs_credential_provisioning_automation = z.object({
   workspace_id: z.string().uuid(),
 })
 
-export const enrollment_automation = acs_credential_provisioning_automation
-  .omit({
-    acs_credential_provisioning_automation_id: true,
+export const enrollment_automation = z
+  .object({
+    enrollment_automation_id: z
+      .string()
+      .uuid()
+      .describe('ID of the enrollment automation.'),
+    credential_manager_acs_system_id: z
+      .string()
+      .uuid()
+      .describe(
+        'ID of the associated [ACS system](https://docs.seam.co/latest/capability-guides/access-systems) that serves as the credential manager.',
+      ),
+    user_identity_id: z
+      .string()
+      .uuid()
+      .describe(
+        'ID of the associated [user identity](https://docs.seam.co/latest/capability-guides/mobile-access-in-development/managing-mobile-app-user-accounts-with-user-identities#what-is-a-user-identity).',
+      ),
+    created_at: z
+      .string()
+      .datetime()
+      .describe(
+        'Date and time at which the enrollment automation was created.',
+      ),
+    workspace_id: z
+      .string()
+      .uuid()
+      .describe(
+        'ID of the [workspace](https://docs.seam.co/latest/core-concepts/workspaces) that contains the enrollment automation.',
+      ),
   })
-  .merge(
-    z.object({
-      enrollment_automation_id: z.string().uuid(),
-    }),
+  .describe(
+    'Represents an [enrollment automation](https://docs.seam.co/latest/capability-guides/mobile-access-in-development/issuing-mobile-credentials-from-an-access-control-system) within the [Seam mobile access solution](https://docs.seam.co/latest/capability-guides/mobile-access-in-development).',
   )
 
 export type EnrollmentAutomation = z.output<typeof enrollment_automation>

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

@@ -2,15 +2,39 @@ import { z } from 'zod'
 
 import { phone_number } from '../phone-number.js'
 
-export const user_identity = z.object({
-  user_identity_id: z.string().uuid(),
-  user_identity_key: z.string().min(1).nullable(),
-  email_address: z.string().email().nullable(),
-  phone_number: phone_number.nullable(),
-  display_name: z.string().min(1),
-  full_name: z.string().min(1).nullable(),
-  created_at: z.string().datetime(),
-  workspace_id: z.string().uuid(),
-})
+export const user_identity = z
+  .object({
+    user_identity_id: z.string().uuid().describe('ID of the user identity.'),
+    user_identity_key: z
+      .string()
+      .min(1)
+      .nullable()
+      .describe('Unique key for the user identity.'),
+    email_address: z
+      .string()
+      .email()
+      .nullable()
+      .describe('Unique email address for the user identity.'),
+    phone_number: phone_number
+      .nullable()
+      .describe(
+        'Unique phone number for the user identity in [E.164 format](https://www.itu.int/rec/T-REC-E.164/en) (for example, +15555550100).',
+      ),
+    display_name: z.string().min(1),
+    full_name: z.string().min(1).nullable(),
+    created_at: z
+      .string()
+      .datetime()
+      .describe('Date and time at which the user identity was created.'),
+    workspace_id: z
+      .string()
+      .uuid()
+      .describe(
+        'ID of the [workspace](https://docs.seam.co/latest/core-concepts/workspaces) that contains the user identity.',
+      ),
+  })
+  .describe(
+    'Represents a [user identity](https://docs.seam.co/latest/capability-guides/mobile-access-in-development/managing-mobile-app-user-accounts-with-user-identities#what-is-a-user-identity) associated with an application user account.',
+  )
 
 export type UserIdentity = z.output<typeof user_identity>