@seamapi/types 1.344.3 → 1.345.0

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

@@ -13153,14 +13153,21 @@ export interface Routes {
                     /** Array of noise threshold IDs that are currently triggering. */
                     currently_triggering_noise_threshold_ids?: string[] | undefined;
                 } & {
+                    /** ASSA ABLOY Credential Service metadata for the phone. */
                     assa_abloy_credential_service_metadata?: ({
+                        /** Indicates whether the credential service has active endpoints associated with the phone. */
                         has_active_endpoint: boolean;
+                        /** Endpoints associated with the phone. */
                         endpoints: Array<{
+                            /** ID of the associated endpoint. */
                             endpoint_id: string;
+                            /** Indicated whether the endpoint is active. */
                             is_active: boolean;
                         }>;
                     } | undefined) | undefined;
+                    /** Salto Space credential service metadata for the phone. */
                     salto_space_credential_service_metadata?: ({
+                        /** Indicates whether the credential service has an active associated phone. */
                         has_active_phone: boolean;
                     } | undefined) | undefined;
                 }) & {
@@ -13836,14 +13843,21 @@ export interface Routes {
                     /** Array of noise threshold IDs that are currently triggering. */
                     currently_triggering_noise_threshold_ids?: string[] | undefined;
                 } & {
+                    /** ASSA ABLOY Credential Service metadata for the phone. */
                     assa_abloy_credential_service_metadata?: ({
+                        /** Indicates whether the credential service has active endpoints associated with the phone. */
                         has_active_endpoint: boolean;
+                        /** Endpoints associated with the phone. */
                         endpoints: Array<{
+                            /** ID of the associated endpoint. */
                             endpoint_id: string;
+                            /** Indicated whether the endpoint is active. */
                             is_active: boolean;
                         }>;
                     } | undefined) | undefined;
+                    /** Salto Space credential service metadata for the phone. */
                     salto_space_credential_service_metadata?: ({
+                        /** Indicates whether the credential service has an active associated phone. */
                         has_active_phone: boolean;
                     } | undefined) | undefined;
                 }) & {
@@ -17491,14 +17505,21 @@ export interface Routes {
                     /** Array of noise threshold IDs that are currently triggering. */
                     currently_triggering_noise_threshold_ids?: string[] | undefined;
                 } & {
+                    /** ASSA ABLOY Credential Service metadata for the phone. */
                     assa_abloy_credential_service_metadata?: ({
+                        /** Indicates whether the credential service has active endpoints associated with the phone. */
                         has_active_endpoint: boolean;
+                        /** Endpoints associated with the phone. */
                         endpoints: Array<{
+                            /** ID of the associated endpoint. */
                             endpoint_id: string;
+                            /** Indicated whether the endpoint is active. */
                             is_active: boolean;
                         }>;
                     } | undefined) | undefined;
+                    /** Salto Space credential service metadata for the phone. */
                     salto_space_credential_service_metadata?: ({
+                        /** Indicates whether the credential service has an active associated phone. */
                         has_active_phone: boolean;
                     } | undefined) | undefined;
                 }) & {
@@ -18138,14 +18159,21 @@ export interface Routes {
                     /** Array of noise threshold IDs that are currently triggering. */
                     currently_triggering_noise_threshold_ids?: string[] | undefined;
                 } & {
+                    /** ASSA ABLOY Credential Service metadata for the phone. */
                     assa_abloy_credential_service_metadata?: ({
+                        /** Indicates whether the credential service has active endpoints associated with the phone. */
                         has_active_endpoint: boolean;
+                        /** Endpoints associated with the phone. */
                         endpoints: Array<{
+                            /** ID of the associated endpoint. */
                             endpoint_id: string;
+                            /** Indicated whether the endpoint is active. */
                             is_active: boolean;
                         }>;
                     } | undefined) | undefined;
+                    /** Salto Space credential service metadata for the phone. */
                     salto_space_credential_service_metadata?: ({
+                        /** Indicates whether the credential service has an active associated phone. */
                         has_active_phone: boolean;
                     } | undefined) | undefined;
                 }) & {
@@ -18821,14 +18849,21 @@ export interface Routes {
                     /** Array of noise threshold IDs that are currently triggering. */
                     currently_triggering_noise_threshold_ids?: string[] | undefined;
                 } & {
+                    /** ASSA ABLOY Credential Service metadata for the phone. */
                     assa_abloy_credential_service_metadata?: ({
+                        /** Indicates whether the credential service has active endpoints associated with the phone. */
                         has_active_endpoint: boolean;
+                        /** Endpoints associated with the phone. */
                         endpoints: Array<{
+                            /** ID of the associated endpoint. */
                             endpoint_id: string;
+                            /** Indicated whether the endpoint is active. */
                             is_active: boolean;
                         }>;
                     } | undefined) | undefined;
+                    /** Salto Space credential service metadata for the phone. */
                     salto_space_credential_service_metadata?: ({
+                        /** Indicates whether the credential service has an active associated phone. */
                         has_active_phone: boolean;
                     } | undefined) | undefined;
                 }) & {
@@ -19467,14 +19502,21 @@ export interface Routes {
                     /** Array of noise threshold IDs that are currently triggering. */
                     currently_triggering_noise_threshold_ids?: string[] | undefined;
                 } & {
+                    /** ASSA ABLOY Credential Service metadata for the phone. */
                     assa_abloy_credential_service_metadata?: ({
+                        /** Indicates whether the credential service has active endpoints associated with the phone. */
                         has_active_endpoint: boolean;
+                        /** Endpoints associated with the phone. */
                         endpoints: Array<{
+                            /** ID of the associated endpoint. */
                             endpoint_id: string;
+                            /** Indicated whether the endpoint is active. */
                             is_active: boolean;
                         }>;
                     } | undefined) | undefined;
+                    /** Salto Space credential service metadata for the phone. */
                     salto_space_credential_service_metadata?: ({
+                        /** Indicates whether the credential service has an active associated phone. */
                         has_active_phone: boolean;
                     } | undefined) | undefined;
                 }) & {
@@ -21921,14 +21963,21 @@ export interface Routes {
                     /** Array of noise threshold IDs that are currently triggering. */
                     currently_triggering_noise_threshold_ids?: string[] | undefined;
                 } & {
+                    /** ASSA ABLOY Credential Service metadata for the phone. */
                     assa_abloy_credential_service_metadata?: ({
+                        /** Indicates whether the credential service has active endpoints associated with the phone. */
                         has_active_endpoint: boolean;
+                        /** Endpoints associated with the phone. */
                         endpoints: Array<{
+                            /** ID of the associated endpoint. */
                             endpoint_id: string;
+                            /** Indicated whether the endpoint is active. */
                             is_active: boolean;
                         }>;
                     } | undefined) | undefined;
+                    /** Salto Space credential service metadata for the phone. */
                     salto_space_credential_service_metadata?: ({
+                        /** Indicates whether the credential service has an active associated phone. */
                         has_active_phone: boolean;
                     } | undefined) | undefined;
                 }) & {
@@ -22567,14 +22616,21 @@ export interface Routes {
                     /** Array of noise threshold IDs that are currently triggering. */
                     currently_triggering_noise_threshold_ids?: string[] | undefined;
                 } & {
+                    /** ASSA ABLOY Credential Service metadata for the phone. */
                     assa_abloy_credential_service_metadata?: ({
+                        /** Indicates whether the credential service has active endpoints associated with the phone. */
                         has_active_endpoint: boolean;
+                        /** Endpoints associated with the phone. */
                         endpoints: Array<{
+                            /** ID of the associated endpoint. */
                             endpoint_id: string;
+                            /** Indicated whether the endpoint is active. */
                             is_active: boolean;
                         }>;
                     } | undefined) | undefined;
+                    /** Salto Space credential service metadata for the phone. */
                     salto_space_credential_service_metadata?: ({
+                        /** Indicates whether the credential service has an active associated phone. */
                         has_active_phone: boolean;
                     } | undefined) | undefined;
                 }) & {
@@ -25821,6 +25877,7 @@ export interface Routes {
         method: 'DELETE' | 'POST';
         queryParams: {};
         jsonBody: {
+            /** Device ID of the desired phone. */
             device_id: string;
         };
         commonParams: {};
@@ -25833,7 +25890,9 @@ export interface Routes {
         queryParams: {};
         jsonBody: {};
         commonParams: {
+            /** ID of the user identity that represents the owner by which to filter the list of returned phones. */
             owner_user_identity_id?: string | undefined;
+            /** ID of the [credential](https://docs.seam.co/latest/capability-guides/access-systems/managing-credentials) by which to filter the list of returned phones. */
             acs_credential_id?: string | undefined;
         };
         formData: {};
@@ -25841,6 +25900,7 @@ export interface Routes {
             phones: Array<{
                 /** Unique identifier for the device. */
                 device_id: string;
+                /** Type of phone. */
                 device_type: 'android_phone' | 'ios_phone';
                 /** Optional nickname to describe the device, settable through Seam */
                 nickname?: string | undefined;
@@ -25849,14 +25909,21 @@ export interface Routes {
                 /** Collection of capabilities that the device supports when connected to Seam. Values are "access_code," which indicates that the device can manage and utilize digital PIN codes for secure access; "lock," which indicates that the device controls a door locking mechanism, enabling the remote opening and closing of doors and other entry points; "noise_detection," which indicates that the device supports monitoring and responding to ambient noise levels; "thermostat," which indicates that the device can regulate and adjust indoor temperatures; and "battery," which indicates that the device can manage battery life and health. */
                 capabilities_supported: Array<'access_code' | 'lock' | 'noise_detection' | 'thermostat' | 'battery' | 'phone'>;
                 properties: {
+                    /** ASSA ABLOY Credential Service metadata for the phone. */
                     assa_abloy_credential_service_metadata?: {
+                        /** Indicates whether the credential service has active endpoints associated with the phone. */
                         has_active_endpoint: boolean;
+                        /** Endpoints associated with the phone. */
                         endpoints: Array<{
+                            /** ID of the associated endpoint. */
                             endpoint_id: string;
+                            /** Indicated whether the endpoint is active. */
                             is_active: boolean;
                         }>;
                     } | undefined;
+                    /** Salto Space credential service metadata for the phone. */
                     salto_space_credential_service_metadata?: {
+                        /** Indicates whether the credential service has an active associated phone. */
                         has_active_phone: boolean;
                     } | undefined;
                 };
@@ -26031,30 +26098,45 @@ export interface Routes {
         method: 'GET' | 'POST';
         queryParams: {};
         jsonBody: {
+            /** ID of the custom SDK installation to use for the simulated phone. */
             custom_sdk_installation_id?: string | undefined;
+            /** ID of the user identity to associate with the simulated phone. */
             user_identity_id: string;
+            /** Metadata to associate with the simulated phone. */
             phone_metadata?: {
+                /** Mobile operating system that you want to use for the simulated phone. */
                 operating_system?: 'android' | 'ios';
+                /** Mobile operating system version that you want to use for the simulated phone. */
                 os_version?: string;
+                /** Manufacturer that you want to use for the simulated phone. */
                 device_manufacturer?: string;
+                /** Device model that you want to use for the simulated phone. */
                 device_model?: string;
             };
+            /** ASSA ABLOY metadata to associate with the simulated phone. */
             assa_abloy_metadata?: {
+                /** Indicates whether the simulated phone should have Bluetooth low energy (BLE) capability. */
                 ble_capability?: boolean;
+                /** Indicates whether the simulated phone should have host card emulation (HCE) capability. */
                 hce_capability?: boolean;
+                /** Indicates whether the simulated phone should have near-field communication (NFC) capability. */
                 nfc_capability?: boolean;
+                /** Application version that you want to use for the simulated phone. */
                 application_version?: string;
+                /** SEOS applet version that you want to use for the simulated phone. */
                 seos_applet_version?: string;
+                /** ID of the SEOS trusted service manager (TSM) endpoint that you want to use for the simulated phone. */
                 seos_tsm_endpoint_id?: number;
             };
         };
         commonParams: {};
         formData: {};
         jsonResponse: {
-            /**  */
+            /** Properties of the phone. */
             phone: {
                 /** Unique identifier for the device. */
                 device_id: string;
+                /** Type of phone. */
                 device_type: 'android_phone' | 'ios_phone';
                 /** Optional nickname to describe the device, settable through Seam */
                 nickname?: string | undefined;
@@ -26063,14 +26145,21 @@ export interface Routes {
                 /** Collection of capabilities that the device supports when connected to Seam. Values are "access_code," which indicates that the device can manage and utilize digital PIN codes for secure access; "lock," which indicates that the device controls a door locking mechanism, enabling the remote opening and closing of doors and other entry points; "noise_detection," which indicates that the device supports monitoring and responding to ambient noise levels; "thermostat," which indicates that the device can regulate and adjust indoor temperatures; and "battery," which indicates that the device can manage battery life and health. */
                 capabilities_supported: Array<'access_code' | 'lock' | 'noise_detection' | 'thermostat' | 'battery' | 'phone'>;
                 properties: {
+                    /** ASSA ABLOY Credential Service metadata for the phone. */
                     assa_abloy_credential_service_metadata?: {
+                        /** Indicates whether the credential service has active endpoints associated with the phone. */
                         has_active_endpoint: boolean;
+                        /** Endpoints associated with the phone. */
                         endpoints: Array<{
+                            /** ID of the associated endpoint. */
                             endpoint_id: string;
+                            /** Indicated whether the endpoint is active. */
                             is_active: boolean;
                         }>;
                     } | undefined;
+                    /** Salto Space credential service metadata for the phone. */
                     salto_space_credential_service_metadata?: {
+                        /** Indicates whether the credential service has an active associated phone. */
                         has_active_phone: boolean;
                     } | undefined;
                 };
@@ -28123,14 +28212,21 @@ export interface Routes {
                     /** Array of noise threshold IDs that are currently triggering. */
                     currently_triggering_noise_threshold_ids?: string[] | undefined;
                 } & {
+                    /** ASSA ABLOY Credential Service metadata for the phone. */
                     assa_abloy_credential_service_metadata?: ({
+                        /** Indicates whether the credential service has active endpoints associated with the phone. */
                         has_active_endpoint: boolean;
+                        /** Endpoints associated with the phone. */
                         endpoints: Array<{
+                            /** ID of the associated endpoint. */
                             endpoint_id: string;
+                            /** Indicated whether the endpoint is active. */
                             is_active: boolean;
                         }>;
                     } | undefined) | undefined;
+                    /** Salto Space credential service metadata for the phone. */
                     salto_space_credential_service_metadata?: ({
+                        /** Indicates whether the credential service has an active associated phone. */
                         has_active_phone: boolean;
                     } | undefined) | undefined;
                 }) & {
@@ -30558,14 +30654,21 @@ export interface Routes {
                     /** Array of noise threshold IDs that are currently triggering. */
                     currently_triggering_noise_threshold_ids?: string[] | undefined;
                 } & {
+                    /** ASSA ABLOY Credential Service metadata for the phone. */
                     assa_abloy_credential_service_metadata?: ({
+                        /** Indicates whether the credential service has active endpoints associated with the phone. */
                         has_active_endpoint: boolean;
+                        /** Endpoints associated with the phone. */
                         endpoints: Array<{
+                            /** ID of the associated endpoint. */
                             endpoint_id: string;
+                            /** Indicated whether the endpoint is active. */
                             is_active: boolean;
                         }>;
                     } | undefined) | undefined;
+                    /** Salto Space credential service metadata for the phone. */
                     salto_space_credential_service_metadata?: ({
+                        /** Indicates whether the credential service has an active associated phone. */
                         has_active_phone: boolean;
                     } | undefined) | undefined;
                 }) & {
@@ -31204,14 +31307,21 @@ export interface Routes {
                     /** Array of noise threshold IDs that are currently triggering. */
                     currently_triggering_noise_threshold_ids?: string[] | undefined;
                 } & {
+                    /** ASSA ABLOY Credential Service metadata for the phone. */
                     assa_abloy_credential_service_metadata?: ({
+                        /** Indicates whether the credential service has active endpoints associated with the phone. */
                         has_active_endpoint: boolean;
+                        /** Endpoints associated with the phone. */
                         endpoints: Array<{
+                            /** ID of the associated endpoint. */
                             endpoint_id: string;
+                            /** Indicated whether the endpoint is active. */
                             is_active: boolean;
                         }>;
                     } | undefined) | undefined;
+                    /** Salto Space credential service metadata for the phone. */
                     salto_space_credential_service_metadata?: ({
+                        /** Indicates whether the credential service has an active associated phone. */
                         has_active_phone: boolean;
                     } | undefined) | undefined;
                 }) & {
@@ -35024,14 +35134,21 @@ export interface Routes {
                     /** Array of noise threshold IDs that are currently triggering. */
                     currently_triggering_noise_threshold_ids?: string[] | undefined;
                 } & {
+                    /** ASSA ABLOY Credential Service metadata for the phone. */
                     assa_abloy_credential_service_metadata?: ({
+                        /** Indicates whether the credential service has active endpoints associated with the phone. */
                         has_active_endpoint: boolean;
+                        /** Endpoints associated with the phone. */
                         endpoints: Array<{
+                            /** ID of the associated endpoint. */
                             endpoint_id: string;
+                            /** Indicated whether the endpoint is active. */
                             is_active: boolean;
                         }>;
                     } | undefined) | undefined;
+                    /** Salto Space credential service metadata for the phone. */
                     salto_space_credential_service_metadata?: ({
+                        /** Indicates whether the credential service has an active associated phone. */
                         has_active_phone: boolean;
                     } | undefined) | undefined;
                 }) & {
@@ -35672,14 +35789,21 @@ export interface Routes {
                     /** Array of noise threshold IDs that are currently triggering. */
                     currently_triggering_noise_threshold_ids?: string[] | undefined;
                 } & {
+                    /** ASSA ABLOY Credential Service metadata for the phone. */
                     assa_abloy_credential_service_metadata?: ({
+                        /** Indicates whether the credential service has active endpoints associated with the phone. */
                         has_active_endpoint: boolean;
+                        /** Endpoints associated with the phone. */
                         endpoints: Array<{
+                            /** ID of the associated endpoint. */
                             endpoint_id: string;
+                            /** Indicated whether the endpoint is active. */
                             is_active: boolean;
                         }>;
                     } | undefined) | undefined;
+                    /** Salto Space credential service metadata for the phone. */
                     salto_space_credential_service_metadata?: ({
+                        /** Indicates whether the credential service has an active associated phone. */
                         has_active_phone: boolean;
                     } | undefined) | undefined;
                 }) & {

package/package.json

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

package/src/lib/seam/connect/models/devices/phone-properties.ts

@@ -3,19 +3,33 @@ import { z } from 'zod'
 export const phone_specific_properties = z.object({
   assa_abloy_credential_service_metadata: z
     .object({
-      has_active_endpoint: z.boolean(),
-      endpoints: z.array(
-        z.object({
-          endpoint_id: z.string(),
-          is_active: z.boolean(),
-        }),
-      ),
+      has_active_endpoint: z
+        .boolean()
+        .describe(
+          'Indicates whether the credential service has active endpoints associated with the phone.',
+        ),
+      endpoints: z
+        .array(
+          z.object({
+            endpoint_id: z.string().describe('ID of the associated endpoint.'),
+            is_active: z
+              .boolean()
+              .describe('Indicated whether the endpoint is active.'),
+          }),
+        )
+        .describe('Endpoints associated with the phone.'),
     })
-    .optional(),
+    .optional()
+    .describe('ASSA ABLOY Credential Service metadata for the phone.'),
 
   salto_space_credential_service_metadata: z
     .object({
-      has_active_phone: z.boolean(),
+      has_active_phone: z
+        .boolean()
+        .describe(
+          'Indicates whether the credential service has an active associated phone.',
+        ),
     })
-    .optional(),
+    .optional()
+    .describe('Salto Space credential service metadata for the phone.'),
 })

package/src/lib/seam/connect/models/devices/phone.ts

@@ -10,10 +10,13 @@ export const phone = device
     connected_account_id: true,
   })
   .extend({
-    device_type: z.enum(['android_phone', 'ios_phone']),
+    device_type: z
+      .enum(['android_phone', 'ios_phone'])
+      .describe('Type of phone.'),
   })
   .merge(z.object({ properties: phone_specific_properties })).describe(`
     ---
     route_path: /phones
     ---
+    Properties of the phone.
   `)