@seamapi/types 1.350.0 → 1.351.1

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

@@ -25917,6 +25917,66 @@ export interface Routes {
         formData: {};
         jsonResponse: {};
     };
+    '/phones/get': {
+        route: '/phones/get';
+        method: 'GET' | 'POST';
+        queryParams: {};
+        jsonBody: {};
+        commonParams: {
+            /** Device ID of the desired phone. */
+            device_id: string;
+        };
+        formData: {};
+        jsonResponse: {
+            /** Represents an app user's mobile phone. */
+            phone: {
+                /** ID of the `phone`. */
+                device_id: string;
+                /** Optional nickname to describe the phone, settable through Seam. */
+                nickname?: string | undefined;
+                /** Display name of the phone. Defaults to `nickname` (if it is set) or `properties.appearance.name` otherwise. Enables administrators and users to identify the phone easily, especially when there are numerous phones. */
+                display_name: string;
+                /** ID of the [workspace](https://docs.seam.co/latest/core-concepts/workspaces) that contains the `phone`. */
+                workspace_id: string;
+                /** Date and time at which the `phone` was created. */
+                created_at: string;
+                /** Optional [custom metadata](https://docs.seam.co/latest/core-concepts/devices/adding-custom-metadata-to-a-device) for the phone. */
+                custom_metadata: Record<string, string | boolean>;
+                /** Errors associated with the `phone`. */
+                errors: Array<{
+                    error_code: string;
+                    message: string;
+                }>;
+                /** Warnings associated with the `phone`. */
+                warnings: Array<{
+                    warning_code: string;
+                    message: string;
+                }>;
+                /** Type of phone. */
+                device_type: 'ios_phone' | 'android_phone';
+                /** Properties of the 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;
+                };
+            };
+        };
+    };
     '/phones/list': {
         route: '/phones/list';
         method: 'GET' | 'POST';

package/package.json

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

package/src/lib/seam/connect/models/bridges/bridge_client_session.ts

@@ -14,6 +14,7 @@ export const bridge_client_session = z.object({
 }).describe(`
   ---
   route_path: /seam/bridge/v1/bridge_client_sessions
+  undocumented: Seam Bridge Client only.
   ---
 `)
 

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

@@ -23280,6 +23280,61 @@ export default {
         'x-title': 'Deactivate a Phone',
       },
     },
+    '/phones/get': {
+      post: {
+        description:
+          'Returns a single phone entry matching the provided `device_id`.',
+        operationId: 'phonesGetPost',
+        requestBody: {
+          content: {
+            'application/json': {
+              schema: {
+                properties: {
+                  device_id: {
+                    description: 'Device ID of the desired phone.',
+                    format: 'uuid',
+                    type: 'string',
+                  },
+                },
+                required: ['device_id'],
+                type: 'object',
+              },
+            },
+          },
+        },
+        responses: {
+          200: {
+            content: {
+              'application/json': {
+                schema: {
+                  properties: {
+                    ok: { type: 'boolean' },
+                    phone: { $ref: '#/components/schemas/phone' },
+                  },
+                  required: ['phone', 'ok'],
+                  type: 'object',
+                },
+              },
+            },
+            description: 'OK',
+          },
+          400: { description: 'Bad Request' },
+          401: { description: 'Unauthorized' },
+        },
+        security: [
+          { api_key: [] },
+          { pat_with_workspace: [] },
+          { console_session_with_workspace: [] },
+        ],
+        summary: '/phones/get',
+        tags: ['/phones'],
+        'x-fern-sdk-group-name': ['phones'],
+        'x-fern-sdk-method-name': 'get',
+        'x-fern-sdk-return-value': 'phone',
+        'x-response-key': 'phone',
+        'x-title': 'Get Phone',
+      },
+    },
     '/phones/list': {
       post: {
         description:
@@ -23551,6 +23606,7 @@ export default {
                       ],
                       type: 'object',
                       'x-route-path': '/seam/bridge/v1/bridge_client_sessions',
+                      'x-undocumented': 'Seam Bridge Client only.',
                     },
                     ok: { type: 'boolean' },
                   },
@@ -23577,6 +23633,7 @@ export default {
         'x-fern-sdk-return-value': 'bridge_client_session',
         'x-response-key': 'bridge_client_session',
         'x-title': 'Create a Bridge Client Session',
+        'x-undocumented': 'Seam Bridge Client only.',
       },
     },
     '/seam/bridge/v1/bridge_client_sessions/get': {
@@ -23629,6 +23686,7 @@ export default {
                       ],
                       type: 'object',
                       'x-route-path': '/seam/bridge/v1/bridge_client_sessions',
+                      'x-undocumented': 'Seam Bridge Client only.',
                     },
                     ok: { type: 'boolean' },
                   },
@@ -23648,6 +23706,7 @@ export default {
         'x-fern-ignore': true,
         'x-response-key': 'bridge_client_session',
         'x-title': 'Get a Bridge Client Session',
+        'x-undocumented': 'Seam Bridge Client only.',
       },
       post: {
         description:
@@ -23698,6 +23757,7 @@ export default {
                       ],
                       type: 'object',
                       'x-route-path': '/seam/bridge/v1/bridge_client_sessions',
+                      'x-undocumented': 'Seam Bridge Client only.',
                     },
                     ok: { type: 'boolean' },
                   },
@@ -23724,6 +23784,7 @@ export default {
         'x-fern-sdk-return-value': 'bridge_client_session',
         'x-response-key': 'bridge_client_session',
         'x-title': 'Get a Bridge Client Session',
+        'x-undocumented': 'Seam Bridge Client only.',
       },
     },
     '/seam/bridge/v1/bridge_client_sessions/regenerate_pairing_code': {
@@ -23777,6 +23838,7 @@ export default {
                       ],
                       type: 'object',
                       'x-route-path': '/seam/bridge/v1/bridge_client_sessions',
+                      'x-undocumented': 'Seam Bridge Client only.',
                     },
                     ok: { type: 'boolean' },
                   },
@@ -23804,6 +23866,7 @@ export default {
         'x-fern-sdk-return-value': 'bridge_client_session',
         'x-response-key': 'bridge_client_session',
         'x-title': 'Regenerate a Bridge Client Session Pairing Code',
+        'x-undocumented': 'Seam Bridge Client only.',
       },
     },
     '/thermostats/activate_climate_preset': {

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

@@ -32241,6 +32241,70 @@ export interface Routes {
     formData: {}
     jsonResponse: {}
   }
+  '/phones/get': {
+    route: '/phones/get'
+    method: 'GET' | 'POST'
+    queryParams: {}
+    jsonBody: {}
+    commonParams: {
+      /** Device ID of the desired phone. */
+      device_id: string
+    }
+    formData: {}
+    jsonResponse: {
+      /** Represents an app user's mobile phone. */
+      phone: {
+        /** ID of the `phone`. */
+        device_id: string
+        /** Optional nickname to describe the phone, settable through Seam. */
+        nickname?: string | undefined
+        /** Display name of the phone. Defaults to `nickname` (if it is set) or `properties.appearance.name` otherwise. Enables administrators and users to identify the phone easily, especially when there are numerous phones. */
+        display_name: string
+        /** ID of the [workspace](https://docs.seam.co/latest/core-concepts/workspaces) that contains the `phone`. */
+        workspace_id: string
+        /** Date and time at which the `phone` was created. */
+        created_at: string
+        /** Optional [custom metadata](https://docs.seam.co/latest/core-concepts/devices/adding-custom-metadata-to-a-device) for the phone. */
+        custom_metadata: Record<string, string | boolean>
+        /** Errors associated with the `phone`. */
+        errors: Array<{
+          error_code: string
+          message: string
+        }>
+        /** Warnings associated with the `phone`. */
+        warnings: Array<{
+          warning_code: string
+          message: string
+        }>
+        /** Type of phone. */
+        device_type: 'ios_phone' | 'android_phone'
+        /** Properties of the 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
+        }
+      }
+    }
+  }
   '/phones/list': {
     route: '/phones/list'
     method: 'GET' | 'POST'