@seamapi/types 1.302.0 → 1.302.2

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

@@ -2083,6 +2083,67 @@ export interface Routes {
                 /** Indicates whether the access code is intended for use in offline scenarios. If "true," this code can be created on a device without a network connection. */
                 is_offline_access_code: boolean;
             };
+            access_code: {
+                /** Unique identifier for a group of access codes that share the same code. */
+                common_code_key: string | null;
+                /** Indicates whether the code is set on the device according to a preconfigured schedule. */
+                is_scheduled_on_device?: boolean | undefined;
+                /** Nature of the access code. Values are "ongoing" for access codes that are active continuously until deactivated manually or "time_bound" for access codes that have a specific duration. */
+                type: 'time_bound' | 'ongoing';
+                /** Indicates whether the access code is waiting for a code assignment. */
+                is_waiting_for_code_assignment?: boolean | undefined;
+                /** Unique identifier for the access code. */
+                access_code_id: string;
+                /** Unique identifier for the device associated with the access code. */
+                device_id: string;
+                /** Name of the access code. Enables administrators and users to identify the access code easily, especially when there are numerous access codes. */
+                name: string | null;
+                /** Code used for access. Typically, a numeric or alphanumeric string. */
+                code: string | null;
+                /** Date and time at which the access code was created. */
+                created_at: string;
+                /** Collection of errors associated with the access code, structured in a dictionary format. A unique "error_code" keys each error. Each error entry is an object containing two fields: "message" and "created_at." "message" is a string that describes the error. "created_at" is a date that indicates when the error was generated. This structure enables detailed tracking and timely response to critical issues. */
+                errors: Array<{
+                    message: string;
+                    is_access_code_error: true;
+                    error_code: string;
+                } | {
+                    message: string;
+                    is_device_error: true;
+                    error_code: string;
+                } | {
+                    message: string;
+                    is_connected_account_error: true;
+                    error_code: string;
+                }>;
+                /** Collection of warnings associated with the access code, structured in a dictionary format. A unique "warning_code" keys each warning. Each warning entry is an object containing two fields: "message" and "created_at." "message" is a string that describes the warning. "created_at" is a date that indicates when the warning was generated. This structure enables detailed tracking and timely response to potential issues that are not critical but that may require attention. */
+                warnings: Array<{
+                    message: string;
+                    warning_code: string;
+                }>;
+                /** Indicates whether Seam manages the access code. */
+                is_managed: true;
+                /** Date and time at which the time-bound access code becomes active. */
+                starts_at?: (string | null) | undefined;
+                /** Date and time after which the time-bound access code becomes inactive. */
+                ends_at?: (string | null) | undefined;
+                /**
+                    Current status of the access code within the operational lifecycle. Values are "setting," a transitional phase that indicates that the code is being configured or activated; "set", which indicates that the code is active and operational; "unset," which indicates a deactivated or unused state, either before activation or after deliberate deactivation; "removing," which indicates a transitional period in which the code is being deleted or made inactive; and "unknown," which indicates an indeterminate state, due to reasons such as system errors or incomplete data, that highlights a potential need for system review or troubleshooting.
+                   */
+                status: 'setting' | 'set' | 'unset' | 'removing' | 'unknown';
+                /** Indicates whether a backup access code is available for use if the primary access code is lost or compromised. */
+                is_backup_access_code_available: boolean;
+                /** Indicates whether the access code is a backup code. */
+                is_backup?: boolean | undefined;
+                /** Identifier of the pulled backup access code. Used to associate the pulled backup access code with the original access code. */
+                pulled_backup_access_code_id?: (string | null) | undefined;
+                /** Indicates whether changes to the access code from external sources are permitted. */
+                is_external_modification_allowed: boolean;
+                /** Indicates whether the access code can only be used once. If "true," the code becomes invalid after the first use. */
+                is_one_time_use: boolean;
+                /** Indicates whether the access code is intended for use in offline scenarios. If "true," this code can be created on a device without a network connection. */
+                is_offline_access_code: boolean;
+            };
         };
     };
     '/access_codes/simulate/create_unmanaged_access_code': {
@@ -4498,12 +4559,13 @@ export interface Routes {
             allowed_acs_entrance_ids?: string[];
             /** Visionline-specific metadata for the new credential. */
             visionline_metadata?: {
-                /** DEPRECATED: DO NOT USE */
+                /**
+                 * @deprecated Read-only endpoint references moved to `endpoint`. */
                 assa_abloy_credential_service_mobile_endpoint_id?: string | undefined;
                 card_format?: ('TLCode' | 'rfid48') | undefined;
                 card_function_type?: 'guest' | 'staff';
                 /**
-                 * @deprecated use override. */
+                 * @deprecated Use `override` instead. */
                 is_override_key?: boolean | undefined;
                 override?: boolean | undefined;
                 auto_join?: boolean | undefined;
@@ -10801,7 +10863,7 @@ export interface Routes {
                     nest_metadata?: {
                         nest_device_id: string;
                         device_name: string;
-                        custom_name: string;
+                        device_custom_name: string;
                         display_name?: string | undefined;
                     } | undefined;
                     ecobee_metadata?: {
@@ -11351,7 +11413,7 @@ export interface Routes {
                     nest_metadata?: {
                         nest_device_id: string;
                         device_name: string;
-                        custom_name: string;
+                        device_custom_name: string;
                         display_name?: string | undefined;
                     } | undefined;
                     ecobee_metadata?: {
@@ -12304,7 +12366,7 @@ export interface Routes {
                     nest_metadata?: {
                         nest_device_id: string;
                         device_name: string;
-                        custom_name: string;
+                        device_custom_name: string;
                         display_name?: string | undefined;
                     } | undefined;
                     ecobee_metadata?: {
@@ -12817,7 +12879,7 @@ export interface Routes {
                     nest_metadata?: {
                         nest_device_id: string;
                         device_name: string;
-                        custom_name: string;
+                        device_custom_name: string;
                         display_name?: string | undefined;
                     } | undefined;
                     ecobee_metadata?: {
@@ -13367,7 +13429,7 @@ export interface Routes {
                     nest_metadata?: {
                         nest_device_id: string;
                         device_name: string;
-                        custom_name: string;
+                        device_custom_name: string;
                         display_name?: string | undefined;
                     } | undefined;
                     ecobee_metadata?: {
@@ -13880,7 +13942,7 @@ export interface Routes {
                     nest_metadata?: {
                         nest_device_id: string;
                         device_name: string;
-                        custom_name: string;
+                        device_custom_name: string;
                         display_name?: string | undefined;
                     } | undefined;
                     ecobee_metadata?: {
@@ -16146,7 +16208,7 @@ export interface Routes {
                     nest_metadata?: {
                         nest_device_id: string;
                         device_name: string;
-                        custom_name: string;
+                        device_custom_name: string;
                         display_name?: string | undefined;
                     } | undefined;
                     ecobee_metadata?: {
@@ -16659,7 +16721,7 @@ export interface Routes {
                     nest_metadata?: {
                         nest_device_id: string;
                         device_name: string;
-                        custom_name: string;
+                        device_custom_name: string;
                         display_name?: string | undefined;
                     } | undefined;
                     ecobee_metadata?: {
@@ -21689,7 +21751,7 @@ export interface Routes {
                     nest_metadata?: {
                         nest_device_id: string;
                         device_name: string;
-                        custom_name: string;
+                        device_custom_name: string;
                         display_name?: string | undefined;
                     } | undefined;
                     ecobee_metadata?: {
@@ -23937,7 +23999,7 @@ export interface Routes {
                     nest_metadata?: {
                         nest_device_id: string;
                         device_name: string;
-                        custom_name: string;
+                        device_custom_name: string;
                         display_name?: string | undefined;
                     } | undefined;
                     ecobee_metadata?: {
@@ -24450,7 +24512,7 @@ export interface Routes {
                     nest_metadata?: {
                         nest_device_id: string;
                         device_name: string;
-                        custom_name: string;
+                        device_custom_name: string;
                         display_name?: string | undefined;
                     } | undefined;
                     ecobee_metadata?: {
@@ -27984,7 +28046,7 @@ export interface Routes {
                     nest_metadata?: {
                         nest_device_id: string;
                         device_name: string;
-                        custom_name: string;
+                        device_custom_name: string;
                         display_name?: string | undefined;
                     } | undefined;
                     ecobee_metadata?: {
@@ -28499,7 +28561,7 @@ export interface Routes {
                     nest_metadata?: {
                         nest_device_id: string;
                         device_name: string;
-                        custom_name: string;
+                        device_custom_name: string;
                         display_name?: string | undefined;
                     } | undefined;
                     ecobee_metadata?: {

package/package.json

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

package/src/lib/seam/connect/models/devices/device-metadata.ts

@@ -197,7 +197,7 @@ export const device_metadata = z
     nest_metadata: z.object({
       nest_device_id: z.string(),
       device_name: z.string(), // set by Google
-      custom_name: z.string(), // set by device owner
+      device_custom_name: z.string(), // set by device owner
       display_name: z.string().optional(),
     }),
 

package/src/lib/seam/connect/models/devices/device-provider.ts

@@ -86,7 +86,6 @@ export const PROVIDER_CATEGORY_MAP = {
     'visionline',
     'assa_abloy_credential_service',
     'latch',
-    'akiles',
   ],
 
   consumer_smartlocks: [

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

@@ -4898,7 +4898,7 @@ export default {
                       },
                       nest_metadata: {
                         properties: {
-                          custom_name: { type: 'string' },
+                          device_custom_name: { type: 'string' },
                           device_name: { type: 'string' },
                           display_name: { type: 'string' },
                           nest_device_id: { type: 'string' },
@@ -4906,7 +4906,7 @@ export default {
                         required: [
                           'nest_device_id',
                           'device_name',
-                          'custom_name',
+                          'device_custom_name',
                         ],
                         type: 'object',
                       },
@@ -7153,6 +7153,8 @@ export default {
     },
     '/access_codes/pull_backup_access_code': {
       post: {
+        description:
+          'Retrieves a backup access code for an access code. See also [Managing Backup Access Codes](https://docs.seam.co/latest/capability-guides/smart-locks/access-codes/backup-access-codes).',
         operationId: 'accessCodesPullBackupAccessCodePost',
         requestBody: {
           content: {
@@ -7173,12 +7175,13 @@ export default {
               'application/json': {
                 schema: {
                   properties: {
+                    access_code: { $ref: '#/components/schemas/access_code' },
                     backup_access_code: {
                       $ref: '#/components/schemas/access_code',
                     },
                     ok: { type: 'boolean' },
                   },
-                  required: ['backup_access_code', 'ok'],
+                  required: ['backup_access_code', 'access_code', 'ok'],
                   type: 'object',
                 },
               },
@@ -7198,8 +7201,8 @@ export default {
         tags: ['/access_codes'],
         'x-fern-sdk-group-name': ['access_codes'],
         'x-fern-sdk-method-name': 'pull_backup_access_code',
-        'x-fern-sdk-return-value': 'backup_access_code',
-        'x-response-key': 'backup_access_code',
+        'x-fern-sdk-return-value': 'access_code',
+        'x-response-key': 'access_code',
       },
     },
     '/access_codes/simulate/create_unmanaged_access_code': {
@@ -8934,9 +8937,13 @@ export default {
                       'Visionline-specific metadata for the new credential.',
                     properties: {
                       assa_abloy_credential_service_mobile_endpoint_id: {
-                        description: 'DEPRECATED: DO NOT USE',
+                        deprecated: true,
                         format: 'uuid',
                         type: 'string',
+                        'x-deprecated':
+                          'Read-only endpoint references moved to `endpoint`.',
+                        'x-undocumented':
+                          'Deprecated. Read-only endpoint references moved to `endpoint`.',
                       },
                       auto_join: { type: 'boolean' },
                       card_format: {
@@ -8951,7 +8958,8 @@ export default {
                       is_override_key: {
                         deprecated: true,
                         type: 'boolean',
-                        'x-deprecated': 'use override.',
+                        'x-deprecated': 'Use `override` instead.',
+                        'x-undocumented': 'Use `override` instead.',
                       },
                       joiner_acs_credential_ids: {
                         items: { format: 'uuid', type: 'string' },

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

@@ -2395,6 +2395,71 @@ export interface Routes {
         /** Indicates whether the access code is intended for use in offline scenarios. If "true," this code can be created on a device without a network connection. */
         is_offline_access_code: boolean
       }
+      access_code: {
+        /** Unique identifier for a group of access codes that share the same code. */
+        common_code_key: string | null
+        /** Indicates whether the code is set on the device according to a preconfigured schedule. */
+        is_scheduled_on_device?: boolean | undefined
+        /** Nature of the access code. Values are "ongoing" for access codes that are active continuously until deactivated manually or "time_bound" for access codes that have a specific duration. */
+        type: 'time_bound' | 'ongoing'
+        /** Indicates whether the access code is waiting for a code assignment. */
+        is_waiting_for_code_assignment?: boolean | undefined
+        /** Unique identifier for the access code. */
+        access_code_id: string
+        /** Unique identifier for the device associated with the access code. */
+        device_id: string
+        /** Name of the access code. Enables administrators and users to identify the access code easily, especially when there are numerous access codes. */
+        name: string | null
+        /** Code used for access. Typically, a numeric or alphanumeric string. */
+        code: string | null
+        /** Date and time at which the access code was created. */
+        created_at: string
+        /** Collection of errors associated with the access code, structured in a dictionary format. A unique "error_code" keys each error. Each error entry is an object containing two fields: "message" and "created_at." "message" is a string that describes the error. "created_at" is a date that indicates when the error was generated. This structure enables detailed tracking and timely response to critical issues. */
+        errors: Array<
+          | {
+              message: string
+              is_access_code_error: true
+              error_code: string
+            }
+          | {
+              message: string
+              is_device_error: true
+              error_code: string
+            }
+          | {
+              message: string
+              is_connected_account_error: true
+              error_code: string
+            }
+        >
+        /** Collection of warnings associated with the access code, structured in a dictionary format. A unique "warning_code" keys each warning. Each warning entry is an object containing two fields: "message" and "created_at." "message" is a string that describes the warning. "created_at" is a date that indicates when the warning was generated. This structure enables detailed tracking and timely response to potential issues that are not critical but that may require attention. */
+        warnings: Array<{
+          message: string
+          warning_code: string
+        }>
+        /** Indicates whether Seam manages the access code. */
+        is_managed: true
+        /** Date and time at which the time-bound access code becomes active. */
+        starts_at?: (string | null) | undefined
+        /** Date and time after which the time-bound access code becomes inactive. */
+        ends_at?: (string | null) | undefined
+        /**
+            Current status of the access code within the operational lifecycle. Values are "setting," a transitional phase that indicates that the code is being configured or activated; "set", which indicates that the code is active and operational; "unset," which indicates a deactivated or unused state, either before activation or after deliberate deactivation; "removing," which indicates a transitional period in which the code is being deleted or made inactive; and "unknown," which indicates an indeterminate state, due to reasons such as system errors or incomplete data, that highlights a potential need for system review or troubleshooting.
+           */
+        status: 'setting' | 'set' | 'unset' | 'removing' | 'unknown'
+        /** Indicates whether a backup access code is available for use if the primary access code is lost or compromised. */
+        is_backup_access_code_available: boolean
+        /** Indicates whether the access code is a backup code. */
+        is_backup?: boolean | undefined
+        /** Identifier of the pulled backup access code. Used to associate the pulled backup access code with the original access code. */
+        pulled_backup_access_code_id?: (string | null) | undefined
+        /** Indicates whether changes to the access code from external sources are permitted. */
+        is_external_modification_allowed: boolean
+        /** Indicates whether the access code can only be used once. If "true," the code becomes invalid after the first use. */
+        is_one_time_use: boolean
+        /** Indicates whether the access code is intended for use in offline scenarios. If "true," this code can be created on a device without a network connection. */
+        is_offline_access_code: boolean
+      }
     }
   }
   '/access_codes/simulate/create_unmanaged_access_code': {
@@ -5203,14 +5268,15 @@ export interface Routes {
       /** Visionline-specific metadata for the new credential. */
       visionline_metadata?:
         | {
-            /** DEPRECATED: DO NOT USE */
+            /**
+             * @deprecated Read-only endpoint references moved to `endpoint`. */
             assa_abloy_credential_service_mobile_endpoint_id?:
               | string
               | undefined
             card_format?: ('TLCode' | 'rfid48') | undefined
             card_function_type?: 'guest' | 'staff'
             /**
-             * @deprecated use override. */
+             * @deprecated Use `override` instead. */
             is_override_key?: boolean | undefined
             override?: boolean | undefined
             auto_join?: boolean | undefined
@@ -12711,7 +12777,7 @@ export interface Routes {
             | {
                 nest_device_id: string
                 device_name: string
-                custom_name: string
+                device_custom_name: string
                 display_name?: string | undefined
               }
             | undefined
@@ -13587,7 +13653,7 @@ export interface Routes {
             | {
                 nest_device_id: string
                 device_name: string
-                custom_name: string
+                device_custom_name: string
                 display_name?: string | undefined
               }
             | undefined
@@ -15177,7 +15243,7 @@ export interface Routes {
             | {
                 nest_device_id: string
                 device_name: string
-                custom_name: string
+                device_custom_name: string
                 display_name?: string | undefined
               }
             | undefined
@@ -15872,7 +15938,7 @@ export interface Routes {
             | {
                 nest_device_id: string
                 device_name: string
-                custom_name: string
+                device_custom_name: string
                 display_name?: string | undefined
               }
             | undefined
@@ -16748,7 +16814,7 @@ export interface Routes {
             | {
                 nest_device_id: string
                 device_name: string
-                custom_name: string
+                device_custom_name: string
                 display_name?: string | undefined
               }
             | undefined
@@ -17443,7 +17509,7 @@ export interface Routes {
             | {
                 nest_device_id: string
                 device_name: string
-                custom_name: string
+                device_custom_name: string
                 display_name?: string | undefined
               }
             | undefined
@@ -20327,7 +20393,7 @@ export interface Routes {
             | {
                 nest_device_id: string
                 device_name: string
-                custom_name: string
+                device_custom_name: string
                 display_name?: string | undefined
               }
             | undefined
@@ -21022,7 +21088,7 @@ export interface Routes {
             | {
                 nest_device_id: string
                 device_name: string
-                custom_name: string
+                device_custom_name: string
                 display_name?: string | undefined
               }
             | undefined
@@ -26988,7 +27054,7 @@ export interface Routes {
             | {
                 nest_device_id: string
                 device_name: string
-                custom_name: string
+                device_custom_name: string
                 display_name?: string | undefined
               }
             | undefined
@@ -29854,7 +29920,7 @@ export interface Routes {
             | {
                 nest_device_id: string
                 device_name: string
-                custom_name: string
+                device_custom_name: string
                 display_name?: string | undefined
               }
             | undefined
@@ -30549,7 +30615,7 @@ export interface Routes {
             | {
                 nest_device_id: string
                 device_name: string
-                custom_name: string
+                device_custom_name: string
                 display_name?: string | undefined
               }
             | undefined
@@ -34709,7 +34775,7 @@ export interface Routes {
             | {
                 nest_device_id: string
                 device_name: string
-                custom_name: string
+                device_custom_name: string
                 display_name?: string | undefined
               }
             | undefined
@@ -35406,7 +35472,7 @@ export interface Routes {
             | {
                 nest_device_id: string
                 device_name: string
-                custom_name: string
+                device_custom_name: string
                 display_name?: string | undefined
               }
             | undefined