@seamapi/types 1.413.0 → 1.414.1

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

@@ -14732,6 +14732,10 @@ export interface Routes {
             location_id?: (string | null) | undefined;
             /** ID of the space for which you want to list entrances. */
             space_id?: string | undefined;
+            /** ID of the access grant for which you want to retrieve all entrances. */
+            access_grant_id?: string | undefined;
+            /** ID of the access method for which you want to retrieve all entrances. */
+            access_method_id?: string | undefined;
         };
         formData: {};
         jsonResponse: {
@@ -41876,8 +41880,6 @@ export interface Routes {
                         is_being_activated: boolean;
                     };
                     acs_credentials: Array<{
-                        /** ID of the [credential](https://docs.seam.co/latest/capability-guides/access-systems/managing-credentials). */
-                        acs_credential_id: string;
                         /** ID of the [ACS user](https://docs.seam.co/latest/capability-guides/access-systems/user-management) to whom the [credential](https://docs.seam.co/latest/capability-guides/access-systems/managing-credentials) belongs. */
                         acs_user_id?: string | undefined;
                         acs_credential_pool_id?: string | undefined;
@@ -41987,6 +41989,7 @@ export interface Routes {
                             endpoint_id?: string | undefined;
                         } | undefined;
                         is_managed: true;
+                        acs_credential_id?: (string | undefined) | null;
                         acs_entrances: Array<{
                             /** ID of the [access control system](https://docs.seam.co/latest/capability-guides/access-systems) that contains the [entrance](https://docs.seam.co/latest/capability-guides/access-systems/retrieving-entrance-details). */
                             acs_system_id: string;
@@ -56817,6 +56820,7 @@ export interface Routes {
         commonParams: {};
         formData: {};
         jsonResponse: {
+            /**  */
             location: {
                 /** Unique identifier for the location. */
                 location_id: string;
@@ -56861,6 +56865,7 @@ export interface Routes {
         };
         formData: {};
         jsonResponse: {
+            /**  */
             location: {
                 /** Unique identifier for the location. */
                 location_id: string;
@@ -56959,6 +56964,7 @@ export interface Routes {
         commonParams: {};
         formData: {};
         jsonResponse: {
+            /**  */
             location: {
                 /** Unique identifier for the location. */
                 location_id: string;
@@ -57174,6 +57180,22 @@ export interface Routes {
                 created_at: string;
                 /** ID of the [workspace](https://docs.seam.co/latest/core-concepts/workspaces) that contains the user identity. */
                 workspace_id: string;
+                /** Array of errors associated with the user identity. Each error object within the array contains two fields: "error_code" and "message." "error_code" is a string that uniquely identifies the type of error, enabling quick recognition and categorization of the issue. "message" provides a more detailed description of the error, offering insights into the issue and potentially how to rectify it. */
+                errors: Array<{
+                    /** Date and time at which Seam created the error. */
+                    created_at: string;
+                    /** Detailed description of the error. Provides insights into the issue and potentially how to rectify it. */
+                    message: string;
+                }>;
+                /** Array of warnings associated with the user identity. Each warning object within the array contains two fields: "warning_code" and "message." "warning_code" is a string that uniquely identifies the type of warning, enabling quick recognition and categorization of the issue. "message" provides a more detailed description of the warning, offering insights into the issue and potentially how to rectify it. */
+                warnings: Array<{
+                    /** Date and time at which Seam created the warning. */
+                    created_at: string;
+                    /** Detailed description of the warning. Provides insights into the issue and potentially how to rectify it. */
+                    message: string;
+                    /** Unique identifier of the type of warning. Enables quick recognition and categorization of the issue. */
+                    warning_code: 'being_deleted';
+                }>;
             };
         };
     };
@@ -57246,13 +57268,18 @@ export interface Routes {
         };
         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: {
-                acs_credential_provisioning_automation_id: string;
+                /** 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;
             };
         };
     };
@@ -57335,6 +57362,22 @@ export interface Routes {
                 created_at: string;
                 /** ID of the [workspace](https://docs.seam.co/latest/core-concepts/workspaces) that contains the user identity. */
                 workspace_id: string;
+                /** Array of errors associated with the user identity. Each error object within the array contains two fields: "error_code" and "message." "error_code" is a string that uniquely identifies the type of error, enabling quick recognition and categorization of the issue. "message" provides a more detailed description of the error, offering insights into the issue and potentially how to rectify it. */
+                errors: Array<{
+                    /** Date and time at which Seam created the error. */
+                    created_at: string;
+                    /** Detailed description of the error. Provides insights into the issue and potentially how to rectify it. */
+                    message: string;
+                }>;
+                /** Array of warnings associated with the user identity. Each warning object within the array contains two fields: "warning_code" and "message." "warning_code" is a string that uniquely identifies the type of warning, enabling quick recognition and categorization of the issue. "message" provides a more detailed description of the warning, offering insights into the issue and potentially how to rectify it. */
+                warnings: Array<{
+                    /** Date and time at which Seam created the warning. */
+                    created_at: string;
+                    /** Detailed description of the warning. Provides insights into the issue and potentially how to rectify it. */
+                    message: string;
+                    /** Unique identifier of the type of warning. Enables quick recognition and categorization of the issue. */
+                    warning_code: 'being_deleted';
+                }>;
             };
         };
     };
@@ -57378,6 +57421,22 @@ export interface Routes {
                 created_at: string;
                 /** ID of the [workspace](https://docs.seam.co/latest/core-concepts/workspaces) that contains the user identity. */
                 workspace_id: string;
+                /** Array of errors associated with the user identity. Each error object within the array contains two fields: "error_code" and "message." "error_code" is a string that uniquely identifies the type of error, enabling quick recognition and categorization of the issue. "message" provides a more detailed description of the error, offering insights into the issue and potentially how to rectify it. */
+                errors: Array<{
+                    /** Date and time at which Seam created the error. */
+                    created_at: string;
+                    /** Detailed description of the error. Provides insights into the issue and potentially how to rectify it. */
+                    message: string;
+                }>;
+                /** Array of warnings associated with the user identity. Each warning object within the array contains two fields: "warning_code" and "message." "warning_code" is a string that uniquely identifies the type of warning, enabling quick recognition and categorization of the issue. "message" provides a more detailed description of the warning, offering insights into the issue and potentially how to rectify it. */
+                warnings: Array<{
+                    /** Date and time at which Seam created the warning. */
+                    created_at: string;
+                    /** Detailed description of the warning. Provides insights into the issue and potentially how to rectify it. */
+                    message: string;
+                    /** Unique identifier of the type of warning. Enables quick recognition and categorization of the issue. */
+                    warning_code: 'being_deleted';
+                }>;
             }>;
         };
     };

package/package.json

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

package/src/lib/seam/connect/models/locations/location.ts

@@ -26,6 +26,11 @@ export const location = z.object({
     .string()
     .datetime()
     .describe('Date and time at which the location object was created.'),
-})
+}).describe(`
+  ---
+  undocumented: Will be removed.
+  route_path: /unstable_locations
+  ---
+  `)
 
 export type Location = z.infer<typeof location>

package/src/lib/seam/connect/models/phones/phone-session.ts

@@ -7,7 +7,11 @@ import { phone_registration } from './phone-registration.js'
 const phone_provider_session = z.object({
   phone_registration,
   acs_credentials: acs_credential
+    .omit({
+      acs_credential_id: true,
+    })
     .extend({
+      acs_credential_id: z.string().optional().nullable(),
       acs_entrances: acs_entrance.array(),
     })
     .array(),

package/src/lib/seam/connect/models/thermostats/thermostat-program.ts

@@ -50,7 +50,7 @@ export const thermostat_daily_program = z.object({
     ),
 }).describe(`
   ---
-  route_path: /thermostats/thermostat_daily_programs
+  route_path: /thermostats/daily_programs
   ---
   Represents a thermostat daily program, consisting of a set of periods, each of which has a starting time and the key that identifies the climate preset to apply at the starting time.
 `)

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

@@ -2,6 +2,56 @@ import { z } from 'zod'
 
 import { phone_number } from '../phone-number.js'
 
+const common_user_identity_error = z.object({
+  created_at: z
+    .string()
+    .datetime()
+    .describe('Date and time at which Seam created the error.'),
+  message: z
+    .string()
+    .describe(
+      'Detailed description of the error. Provides insights into the issue and potentially how to rectify it.',
+    ),
+})
+
+const common_user_identity_warning = z.object({
+  created_at: z
+    .string()
+    .datetime()
+    .describe('Date and time at which Seam created the warning.'),
+  message: z
+    .string()
+    .describe(
+      'Detailed description of the warning. Provides insights into the issue and potentially how to rectify it.',
+    ),
+})
+
+const user_identity_being_deleted = common_user_identity_warning
+  .extend({
+    warning_code: z
+      .literal('being_deleted')
+      .describe(
+        'Unique identifier of the type of warning. Enables quick recognition and categorization of the issue.',
+      ),
+  })
+  .describe('Indicates that the user identity is currently being deleted.')
+
+export const user_identity_error_map = z.object({})
+
+export type UserIdentityErrorMap = z.infer<typeof user_identity_error_map>
+
+const user_identity_warnings = z
+  .discriminatedUnion('warning_code', [user_identity_being_deleted])
+  .describe('Warnings associated with the user identity.')
+
+export const user_identity_warning_map = z.object({
+  user_identity_being_deleted: user_identity_being_deleted
+    .optional()
+    .nullable(),
+})
+
+export type UserIdentityWarningMap = z.infer<typeof user_identity_warning_map>
+
 export const user_identity = z.object({
   user_identity_id: z.string().uuid().describe('ID of the user identity.'),
   user_identity_key: z
@@ -31,6 +81,16 @@ export const user_identity = z.object({
     .describe(
       'ID of the [workspace](https://docs.seam.co/latest/core-concepts/workspaces) that contains the user identity.',
     ),
+  errors: z
+    .array(common_user_identity_error)
+    .describe(
+      'Array of errors associated with the user identity. Each error object within the array contains two fields: "error_code" and "message." "error_code" is a string that uniquely identifies the type of error, enabling quick recognition and categorization of the issue. "message" provides a more detailed description of the error, offering insights into the issue and potentially how to rectify it.',
+    ),
+  warnings: z
+    .array(user_identity_warnings)
+    .describe(
+      'Array of warnings associated with the user identity. Each warning object within the array contains two fields: "warning_code" and "message." "warning_code" is a string that uniquely identifies the type of warning, enabling quick recognition and categorization of the issue. "message" provides a more detailed description of the warning, offering insights into the issue and potentially how to rectify it.',
+    ),
 }).describe(`
   ---
   route_path: /user_identities