@seamapi/types 1.345.0 → 1.345.2

package/lib/seam/connect/models/devices/phone.js

@@ -1,20 +1,41 @@
 import { z } from 'zod';
 import { device } from './device.js';
+import { phone_device_type } from './device-type.js';
 import { phone_specific_properties } from './phone-properties.js';
 export { phone_specific_properties } from './phone-properties.js';
-export const phone = device
-    .omit({
-    connected_account_id: true,
-})
-    .extend({
-    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.
-  `);
+const basePhoneDeviceSchema = device.pick({
+    device_id: true,
+    nickname: true,
+    display_name: true,
+    workspace_id: true,
+    created_at: true,
+    custom_metadata: true,
+});
+export const phone = z.object({
+    device_id: basePhoneDeviceSchema.shape.device_id.describe('ID of the `phone`.'),
+    nickname: basePhoneDeviceSchema.shape.nickname.describe('Optional nickname to describe the phone, settable through Seam.'),
+    display_name: basePhoneDeviceSchema.shape.display_name.describe('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.'),
+    workspace_id: basePhoneDeviceSchema.shape.workspace_id.describe('ID of the [workspace](https://docs.seam.co/latest/core-concepts/workspaces) that contains the `phone`.'),
+    created_at: basePhoneDeviceSchema.shape.created_at.describe('Date and time at which the `phone` was created.'),
+    custom_metadata: basePhoneDeviceSchema.shape.custom_metadata.describe('Optional [custom metadata](https://docs.seam.co/latest/core-concepts/devices/adding-custom-metadata-to-a-device) for the phone.'),
+    errors: z
+        .array(z.object({
+        error_code: z.string(),
+        message: z.string(),
+    }))
+        .describe('Errors associated with the `phone`.'),
+    warnings: z
+        .array(z.object({
+        warning_code: z.string(),
+        message: z.string(),
+    }))
+        .describe('Warnings associated with the `phone`.'),
+    device_type: phone_device_type,
+    properties: phone_specific_properties,
+}).describe(`
+  ---
+  route_path: /phones
+  ---
+  Represents an app user's mobile phone.
+`);
 //# sourceMappingURL=phone.js.map

package/lib/seam/connect/models/devices/phone.js.map

@@ -1 +1 @@
-{"version":3,"file":"phone.js","sourceRoot":"","sources":["../../../../../src/lib/seam/connect/models/devices/phone.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,CAAC,EAAE,MAAM,KAAK,CAAA;AAEvB,OAAO,EAAE,MAAM,EAAE,MAAM,aAAa,CAAA;AACpC,OAAO,EAAE,yBAAyB,EAAE,MAAM,uBAAuB,CAAA;AAEjE,OAAO,EAAE,yBAAyB,EAAE,MAAM,uBAAuB,CAAA;AAEjE,MAAM,CAAC,MAAM,KAAK,GAAG,MAAM;KACxB,IAAI,CAAC;IACJ,oBAAoB,EAAE,IAAI;CAC3B,CAAC;KACD,MAAM,CAAC;IACN,WAAW,EAAE,CAAC;SACX,IAAI,CAAC,CAAC,eAAe,EAAE,WAAW,CAAC,CAAC;SACpC,QAAQ,CAAC,gBAAgB,CAAC;CAC9B,CAAC;KACD,KAAK,CAAC,CAAC,CAAC,MAAM,CAAC,EAAE,UAAU,EAAE,yBAAyB,EAAE,CAAC,CAAC,CAAC,QAAQ,CAAC;;;;;GAKpE,CAAC,CAAA"}
+{"version":3,"file":"phone.js","sourceRoot":"","sources":["../../../../../src/lib/seam/connect/models/devices/phone.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,CAAC,EAAE,MAAM,KAAK,CAAA;AAEvB,OAAO,EAAE,MAAM,EAAE,MAAM,aAAa,CAAA;AACpC,OAAO,EAAE,iBAAiB,EAAE,MAAM,kBAAkB,CAAA;AACpD,OAAO,EAAE,yBAAyB,EAAE,MAAM,uBAAuB,CAAA;AAEjE,OAAO,EAAE,yBAAyB,EAAE,MAAM,uBAAuB,CAAA;AAEjE,MAAM,qBAAqB,GAAG,MAAM,CAAC,IAAI,CAAC;IACxC,SAAS,EAAE,IAAI;IACf,QAAQ,EAAE,IAAI;IACd,YAAY,EAAE,IAAI;IAClB,YAAY,EAAE,IAAI;IAClB,UAAU,EAAE,IAAI;IAChB,eAAe,EAAE,IAAI;CACtB,CAAC,CAAA;AAEF,MAAM,CAAC,MAAM,KAAK,GAAG,CAAC,CAAC,MAAM,CAAC;IAC5B,SAAS,EACP,qBAAqB,CAAC,KAAK,CAAC,SAAS,CAAC,QAAQ,CAAC,oBAAoB,CAAC;IACtE,QAAQ,EAAE,qBAAqB,CAAC,KAAK,CAAC,QAAQ,CAAC,QAAQ,CACrD,iEAAiE,CAClE;IACD,YAAY,EAAE,qBAAqB,CAAC,KAAK,CAAC,YAAY,CAAC,QAAQ,CAC7D,uNAAuN,CACxN;IACD,YAAY,EAAE,qBAAqB,CAAC,KAAK,CAAC,YAAY,CAAC,QAAQ,CAC7D,wGAAwG,CACzG;IACD,UAAU,EAAE,qBAAqB,CAAC,KAAK,CAAC,UAAU,CAAC,QAAQ,CACzD,iDAAiD,CAClD;IACD,eAAe,EAAE,qBAAqB,CAAC,KAAK,CAAC,eAAe,CAAC,QAAQ,CACnE,iIAAiI,CAClI;IAED,MAAM,EAAE,CAAC;SACN,KAAK,CACJ,CAAC,CAAC,MAAM,CAAC;QACP,UAAU,EAAE,CAAC,CAAC,MAAM,EAAE;QACtB,OAAO,EAAE,CAAC,CAAC,MAAM,EAAE;KACpB,CAAC,CACH;SACA,QAAQ,CAAC,qCAAqC,CAAC;IAClD,QAAQ,EAAE,CAAC;SACR,KAAK,CACJ,CAAC,CAAC,MAAM,CAAC;QACP,YAAY,EAAE,CAAC,CAAC,MAAM,EAAE;QACxB,OAAO,EAAE,CAAC,CAAC,MAAM,EAAE;KACpB,CAAC,CACH;SACA,QAAQ,CAAC,uCAAuC,CAAC;IACpD,WAAW,EAAE,iBAAiB;IAC9B,UAAU,EAAE,yBAAyB;CACtC,CAAC,CAAC,QAAQ,CAAC;;;;;CAKX,CAAC,CAAA"}

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

@@ -2534,10 +2534,15 @@ declare const _default: {
                     };
                     device_type: {
                         description: string;
-                        oneOf: {
+                        oneOf: ({
                             enum: string[];
                             type: string;
-                        }[];
+                            description?: never;
+                        } | {
+                            description: string;
+                            enum: string[];
+                            type: string;
+                        })[];
                     };
                     display_name: {
                         description: string;
@@ -2779,7 +2784,9 @@ declare const _default: {
                                     };
                                     required: string[];
                                     type: string;
+                                    description?: never;
                                 } | {
+                                    description: string;
                                     properties: {
                                         assa_abloy_credential_service_metadata: {
                                             description: string;
@@ -6785,47 +6792,6 @@ declare const _default: {
             phone: {
                 description: string;
                 properties: {
-                    can_hvac_cool: {
-                        type: string;
-                    };
-                    can_hvac_heat: {
-                        type: string;
-                    };
-                    can_hvac_heat_cool: {
-                        type: string;
-                    };
-                    can_program_offline_access_codes: {
-                        type: string;
-                    };
-                    can_program_online_access_codes: {
-                        type: string;
-                    };
-                    can_remotely_lock: {
-                        type: string;
-                    };
-                    can_remotely_unlock: {
-                        type: string;
-                    };
-                    can_simulate_connection: {
-                        type: string;
-                    };
-                    can_simulate_disconnection: {
-                        type: string;
-                    };
-                    can_simulate_removal: {
-                        type: string;
-                    };
-                    can_turn_off_hvac: {
-                        type: string;
-                    };
-                    capabilities_supported: {
-                        description: string;
-                        items: {
-                            enum: string[];
-                            type: string;
-                        };
-                        type: string;
-                    };
                     created_at: {
                         description: string;
                         format: string;
@@ -6837,6 +6803,7 @@ declare const _default: {
                                 type: string;
                             }[];
                         };
+                        description: string;
                         type: string;
                     };
                     device_id: {
@@ -6856,68 +6823,16 @@ declare const _default: {
                     errors: {
                         description: string;
                         items: {
-                            discriminator: {
-                                propertyName: string;
-                            };
-                            oneOf: ({
-                                description: string;
-                                properties: {
-                                    error_code: {
-                                        description: string;
-                                        enum: string[];
-                                        type: string;
-                                    };
-                                    is_device_error: {
-                                        enum: boolean[];
-                                        type: string;
-                                    };
-                                    message: {
-                                        type: string;
-                                    };
-                                    is_connected_account_error?: never;
+                            properties: {
+                                error_code: {
+                                    type: string;
                                 };
-                                required: string[];
-                                type: string;
-                            } | {
-                                description: string;
-                                properties: {
-                                    error_code: {
-                                        description: string;
-                                        enum: string[];
-                                        type: string;
-                                    };
-                                    is_connected_account_error: {
-                                        enum: boolean[];
-                                        type: string;
-                                    };
-                                    message: {
-                                        type: string;
-                                    };
-                                    is_device_error?: never;
+                                message: {
+                                    type: string;
                                 };
-                                required: string[];
-                                type: string;
-                            })[];
-                        };
-                        type: string;
-                    };
-                    is_managed: {
-                        description: string;
-                        enum: boolean[];
-                        type: string;
-                    };
-                    location: {
-                        description: string;
-                        nullable: boolean;
-                        properties: {
-                            location_name: {
-                                description: string;
-                                type: string;
-                            };
-                            timezone: {
-                                description: string;
-                                type: string;
                             };
+                            required: string[];
+                            type: string;
                         };
                         type: string;
                     };
@@ -6926,6 +6841,7 @@ declare const _default: {
                         type: string;
                     };
                     properties: {
+                        description: string;
                         properties: {
                             assa_abloy_credential_service_metadata: {
                                 description: string;
@@ -6973,24 +6889,16 @@ declare const _default: {
                     warnings: {
                         description: string;
                         items: {
-                            discriminator: {
-                                propertyName: string;
-                            };
-                            oneOf: {
-                                description: string;
-                                properties: {
-                                    message: {
-                                        type: string;
-                                    };
-                                    warning_code: {
-                                        description: string;
-                                        enum: string[];
-                                        type: string;
-                                    };
+                            properties: {
+                                message: {
+                                    type: string;
                                 };
-                                required: string[];
-                                type: string;
-                            }[];
+                                warning_code: {
+                                    type: string;
+                                };
+                            };
+                            required: string[];
+                            type: string;
                         };
                         type: string;
                     };
@@ -7004,23 +6912,6 @@ declare const _default: {
                 type: string;
                 'x-route-path': string;
             };
-            service_health: {
-                properties: {
-                    description: {
-                        type: string;
-                    };
-                    service: {
-                        type: string;
-                    };
-                    status: {
-                        enum: string[];
-                        type: string;
-                    };
-                };
-                required: string[];
-                type: string;
-                'x-route-path': string;
-            };
             thermostat_schedule: {
                 description: string;
                 properties: {
@@ -7787,10 +7678,15 @@ declare const _default: {
                     };
                     device_type: {
                         description: string;
-                        oneOf: {
+                        oneOf: ({
                             enum: string[];
                             type: string;
-                        }[];
+                            description?: never;
+                        } | {
+                            description: string;
+                            enum: string[];
+                            type: string;
+                        })[];
                     };
                     errors: {
                         description: string;
@@ -16379,18 +16275,28 @@ declare const _default: {
                                     };
                                     device_type: {
                                         description: string;
-                                        oneOf: {
+                                        oneOf: ({
+                                            enum: string[];
+                                            type: string;
+                                            description?: never;
+                                        } | {
+                                            description: string;
                                             enum: string[];
                                             type: string;
-                                        }[];
+                                        })[];
                                     };
                                     device_types: {
                                         description: string;
                                         items: {
-                                            oneOf: {
+                                            oneOf: ({
                                                 enum: string[];
                                                 type: string;
-                                            }[];
+                                                description?: never;
+                                            } | {
+                                                description: string;
+                                                enum: string[];
+                                                type: string;
+                                            })[];
                                         };
                                         type: string;
                                     };
@@ -16884,18 +16790,28 @@ declare const _default: {
                                     };
                                     device_type: {
                                         description: string;
-                                        oneOf: {
+                                        oneOf: ({
                                             enum: string[];
                                             type: string;
-                                        }[];
+                                            description?: never;
+                                        } | {
+                                            description: string;
+                                            enum: string[];
+                                            type: string;
+                                        })[];
                                     };
                                     device_types: {
                                         description: string;
                                         items: {
-                                            oneOf: {
+                                            oneOf: ({
                                                 enum: string[];
                                                 type: string;
-                                            }[];
+                                                description?: never;
+                                            } | {
+                                                description: string;
+                                                enum: string[];
+                                                type: string;
+                                            })[];
                                         };
                                         type: string;
                                     };
@@ -17683,18 +17599,28 @@ declare const _default: {
                                     };
                                     device_type: {
                                         description: string;
-                                        oneOf: {
+                                        oneOf: ({
                                             enum: string[];
                                             type: string;
-                                        }[];
+                                            description?: never;
+                                        } | {
+                                            description: string;
+                                            enum: string[];
+                                            type: string;
+                                        })[];
                                     };
                                     device_types: {
                                         description: string;
                                         items: {
-                                            oneOf: {
+                                            oneOf: ({
                                                 enum: string[];
                                                 type: string;
-                                            }[];
+                                                description?: never;
+                                            } | {
+                                                description: string;
+                                                enum: string[];
+                                                type: string;
+                                            })[];
                                         };
                                         type: string;
                                     };
@@ -18141,18 +18067,28 @@ declare const _default: {
                                     };
                                     device_type: {
                                         description: string;
-                                        oneOf: {
+                                        oneOf: ({
+                                            enum: string[];
+                                            type: string;
+                                            description?: never;
+                                        } | {
+                                            description: string;
                                             enum: string[];
                                             type: string;
-                                        }[];
+                                        })[];
                                     };
                                     device_types: {
                                         description: string;
                                         items: {
-                                            oneOf: {
+                                            oneOf: ({
                                                 enum: string[];
                                                 type: string;
-                                            }[];
+                                                description?: never;
+                                            } | {
+                                                description: string;
+                                                enum: string[];
+                                                type: string;
+                                            })[];
                                         };
                                         type: string;
                                     };
@@ -19880,18 +19816,28 @@ declare const _default: {
                                     };
                                     device_type: {
                                         description: string;
-                                        oneOf: {
+                                        oneOf: ({
                                             enum: string[];
                                             type: string;
-                                        }[];
+                                            description?: never;
+                                        } | {
+                                            description: string;
+                                            enum: string[];
+                                            type: string;
+                                        })[];
                                     };
                                     device_types: {
                                         description: string;
                                         items: {
-                                            oneOf: {
+                                            oneOf: ({
                                                 enum: string[];
                                                 type: string;
-                                            }[];
+                                                description?: never;
+                                            } | {
+                                                description: string;
+                                                enum: string[];
+                                                type: string;
+                                            })[];
                                         };
                                         type: string;
                                     };