@seamapi/types 1.350.0 → 1.351.0

package/dist/connect.d.cts

@@ -35692,6 +35692,76 @@ declare const _default: {
                 'x-title': string;
             };
         };
+        '/phones/get': {
+            post: {
+                description: string;
+                operationId: string;
+                requestBody: {
+                    content: {
+                        'application/json': {
+                            schema: {
+                                properties: {
+                                    device_id: {
+                                        description: string;
+                                        format: string;
+                                        type: string;
+                                    };
+                                };
+                                required: string[];
+                                type: string;
+                            };
+                        };
+                    };
+                };
+                responses: {
+                    200: {
+                        content: {
+                            'application/json': {
+                                schema: {
+                                    properties: {
+                                        ok: {
+                                            type: string;
+                                        };
+                                        phone: {
+                                            $ref: string;
+                                        };
+                                    };
+                                    required: string[];
+                                    type: string;
+                                };
+                            };
+                        };
+                        description: string;
+                    };
+                    400: {
+                        description: string;
+                    };
+                    401: {
+                        description: string;
+                    };
+                };
+                security: ({
+                    api_key: never[];
+                    pat_with_workspace?: never;
+                    console_session_with_workspace?: never;
+                } | {
+                    pat_with_workspace: never[];
+                    api_key?: never;
+                    console_session_with_workspace?: never;
+                } | {
+                    console_session_with_workspace: never[];
+                    api_key?: never;
+                    pat_with_workspace?: never;
+                })[];
+                summary: string;
+                tags: string[];
+                'x-fern-sdk-group-name': string[];
+                'x-fern-sdk-method-name': string;
+                'x-fern-sdk-return-value': string;
+                'x-response-key': string;
+                'x-title': string;
+            };
+        };
         '/phones/list': {
             post: {
                 description: string;
@@ -66951,6 +67021,66 @@ 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/lib/seam/connect/openapi.d.ts

@@ -19091,6 +19091,76 @@ declare const _default: {
                 'x-title': string;
             };
         };
+        '/phones/get': {
+            post: {
+                description: string;
+                operationId: string;
+                requestBody: {
+                    content: {
+                        'application/json': {
+                            schema: {
+                                properties: {
+                                    device_id: {
+                                        description: string;
+                                        format: string;
+                                        type: string;
+                                    };
+                                };
+                                required: string[];
+                                type: string;
+                            };
+                        };
+                    };
+                };
+                responses: {
+                    200: {
+                        content: {
+                            'application/json': {
+                                schema: {
+                                    properties: {
+                                        ok: {
+                                            type: string;
+                                        };
+                                        phone: {
+                                            $ref: string;
+                                        };
+                                    };
+                                    required: string[];
+                                    type: string;
+                                };
+                            };
+                        };
+                        description: string;
+                    };
+                    400: {
+                        description: string;
+                    };
+                    401: {
+                        description: string;
+                    };
+                };
+                security: ({
+                    api_key: never[];
+                    pat_with_workspace?: never;
+                    console_session_with_workspace?: never;
+                } | {
+                    pat_with_workspace: never[];
+                    api_key?: never;
+                    console_session_with_workspace?: never;
+                } | {
+                    console_session_with_workspace: never[];
+                    api_key?: never;
+                    pat_with_workspace?: never;
+                })[];
+                summary: string;
+                tags: string[];
+                'x-fern-sdk-group-name': string[];
+                'x-fern-sdk-method-name': string;
+                'x-fern-sdk-return-value': string;
+                'x-response-key': string;
+                'x-title': string;
+            };
+        };
         '/phones/list': {
             post: {
                 description: string;

package/lib/seam/connect/openapi.js

@@ -22056,6 +22056,60 @@ 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: 'Returns a list of all phones. To filter the list of returned phones by a specific owner user identity or credential, include the `owner_user_identity_id` or `acs_credential_id`, respectively, in the request body.',