@seamapi/types 1.344.3 → 1.345.0

package/dist/connect.d.cts

@@ -19367,14 +19367,18 @@ declare const _default: {
                                 } | {
                                     properties: {
                                         assa_abloy_credential_service_metadata: {
+                                            description: string;
                                             properties: {
                                                 endpoints: {
+                                                    description: string;
                                                     items: {
                                                         properties: {
                                                             endpoint_id: {
+                                                                description: string;
                                                                 type: string;
                                                             };
                                                             is_active: {
+                                                                description: string;
                                                                 type: string;
                                                             };
                                                         };
@@ -19384,6 +19388,7 @@ declare const _default: {
                                                     type: string;
                                                 };
                                                 has_active_endpoint: {
+                                                    description: string;
                                                     type: string;
                                                 };
                                             };
@@ -19391,8 +19396,10 @@ declare const _default: {
                                             type: string;
                                         };
                                         salto_space_credential_service_metadata: {
+                                            description: string;
                                             properties: {
                                                 has_active_phone: {
+                                                    description: string;
                                                     type: string;
                                                 };
                                             };
@@ -23361,6 +23368,7 @@ declare const _default: {
                 'x-route-path': string;
             };
             phone: {
+                description: string;
                 properties: {
                     can_hvac_cool: {
                         type: string;
@@ -23422,6 +23430,7 @@ declare const _default: {
                         type: string;
                     };
                     device_type: {
+                        description: string;
                         enum: string[];
                         type: string;
                     };
@@ -23504,14 +23513,18 @@ declare const _default: {
                     properties: {
                         properties: {
                             assa_abloy_credential_service_metadata: {
+                                description: string;
                                 properties: {
                                     endpoints: {
+                                        description: string;
                                         items: {
                                             properties: {
                                                 endpoint_id: {
+                                                    description: string;
                                                     type: string;
                                                 };
                                                 is_active: {
+                                                    description: string;
                                                     type: string;
                                                 };
                                             };
@@ -23521,6 +23534,7 @@ declare const _default: {
                                         type: string;
                                     };
                                     has_active_endpoint: {
+                                        description: string;
                                         type: string;
                                     };
                                 };
@@ -23528,8 +23542,10 @@ declare const _default: {
                                 type: string;
                             };
                             salto_space_credential_service_metadata: {
+                                description: string;
                                 properties: {
                                     has_active_phone: {
+                                        description: string;
                                         type: string;
                                     };
                                 };
@@ -35477,6 +35493,7 @@ declare const _default: {
         };
         '/phones/deactivate': {
             post: {
+                description: string;
                 operationId: string;
                 requestBody: {
                     content: {
@@ -35484,6 +35501,7 @@ declare const _default: {
                             schema: {
                                 properties: {
                                     device_id: {
+                                        description: string;
                                         type: string;
                                     };
                                 };
@@ -35543,10 +35561,12 @@ declare const _default: {
                 'x-fern-sdk-group-name': string[];
                 'x-fern-sdk-method-name': string;
                 'x-response-key': null;
+                'x-title': string;
             };
         };
         '/phones/list': {
             post: {
+                description: string;
                 operationId: string;
                 requestBody: {
                     content: {
@@ -35554,10 +35574,12 @@ declare const _default: {
                             schema: {
                                 properties: {
                                     acs_credential_id: {
+                                        description: string;
                                         format: string;
                                         type: string;
                                     };
                                     owner_user_identity_id: {
+                                        description: string;
                                         format: string;
                                         type: string;
                                     };
@@ -35616,10 +35638,12 @@ declare const _default: {
                 'x-fern-sdk-method-name': string;
                 'x-fern-sdk-return-value': string;
                 'x-response-key': string;
+                'x-title': string;
             };
         };
         '/phones/simulate/create_sandbox_phone': {
             post: {
+                description: string;
                 operationId: string;
                 requestBody: {
                     content: {
@@ -35628,29 +35652,36 @@ declare const _default: {
                                 properties: {
                                     assa_abloy_metadata: {
                                         default: {};
+                                        description: string;
                                         properties: {
                                             application_version: {
                                                 default: string;
+                                                description: string;
                                                 type: string;
                                             };
                                             ble_capability: {
                                                 default: boolean;
+                                                description: string;
                                                 type: string;
                                             };
                                             hce_capability: {
                                                 default: boolean;
+                                                description: string;
                                                 type: string;
                                             };
                                             nfc_capability: {
                                                 default: boolean;
+                                                description: string;
                                                 type: string;
                                             };
                                             seos_applet_version: {
                                                 default: string;
+                                                description: string;
                                                 type: string;
                                             };
                                             seos_tsm_endpoint_id: {
                                                 default: number;
+                                                description: string;
                                                 format: string;
                                                 type: string;
                                             };
@@ -35658,32 +35689,39 @@ declare const _default: {
                                         type: string;
                                     };
                                     custom_sdk_installation_id: {
+                                        description: string;
                                         type: string;
                                     };
                                     phone_metadata: {
                                         default: {};
+                                        description: string;
                                         properties: {
                                             device_manufacturer: {
                                                 default: string;
+                                                description: string;
                                                 type: string;
                                             };
                                             device_model: {
                                                 default: string;
+                                                description: string;
                                                 type: string;
                                             };
                                             operating_system: {
                                                 default: string;
+                                                description: string;
                                                 enum: string[];
                                                 type: string;
                                             };
                                             os_version: {
                                                 default: string;
+                                                description: string;
                                                 type: string;
                                             };
                                         };
                                         type: string;
                                     };
                                     user_identity_id: {
+                                        description: string;
                                         format: string;
                                         type: string;
                                     };
@@ -35740,6 +35778,7 @@ declare const _default: {
                 'x-fern-sdk-method-name': string;
                 'x-fern-sdk-return-value': string;
                 'x-response-key': string;
+                'x-title': string;
             };
         };
         '/thermostats/activate_climate_preset': {
@@ -53661,14 +53700,21 @@ 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;
                 }) & {
@@ -54344,14 +54390,21 @@ 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;
                 }) & {
@@ -57999,14 +58052,21 @@ 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;
                 }) & {
@@ -58646,14 +58706,21 @@ 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;
                 }) & {
@@ -59329,14 +59396,21 @@ 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;
                 }) & {
@@ -59975,14 +60049,21 @@ 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;
                 }) & {
@@ -62429,14 +62510,21 @@ 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;
                 }) & {
@@ -63075,14 +63163,21 @@ 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;
                 }) & {
@@ -66329,6 +66424,7 @@ interface Routes {
         method: 'DELETE' | 'POST';
         queryParams: {};
         jsonBody: {
+            /** Device ID of the desired phone. */
             device_id: string;
         };
         commonParams: {};
@@ -66341,7 +66437,9 @@ 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: {};
@@ -66349,6 +66447,7 @@ 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;
@@ -66357,14 +66456,21 @@ 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;
                 };
@@ -66539,30 +66645,45 @@ 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;
@@ -66571,14 +66692,21 @@ 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;
                 };
@@ -68631,14 +68759,21 @@ 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;
                 }) & {
@@ -71066,14 +71201,21 @@ 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;
                 }) & {
@@ -71712,14 +71854,21 @@ 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;
                 }) & {
@@ -75532,14 +75681,21 @@ 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;
                 }) & {
@@ -76180,14 +76336,21 @@ 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;
                 }) & {