@seamapi/types 1.530.0 → 1.531.0

package/lib/seam/connect/models/batch.d.ts

@@ -32851,7 +32851,7 @@ export declare const workspaces_batch: z.ZodObject<{
         can_simulate_hub_connection: z.ZodOptional<z.ZodBoolean>;
         can_simulate_hub_disconnection: z.ZodOptional<z.ZodBoolean>;
         can_simulate_paid_subscription: z.ZodOptional<z.ZodBoolean>;
-    }, "device_id" | "workspace_id" | "created_at" | "errors" | "connected_account_id" | "warnings" | "device_type" | "capabilities_supported" | "location"> & {
+    }, "device_id" | "workspace_id" | "created_at" | "errors" | "connected_account_id" | "warnings" | "custom_metadata" | "device_type" | "capabilities_supported" | "location"> & {
         is_managed: z.ZodLiteral<false>;
         properties: z.ZodObject<Pick<{
             online: z.ZodBoolean;
@@ -33183,6 +33183,7 @@ export declare const workspaces_batch: z.ZodObject<{
             created_at: string;
             warning_code: "unknown_issue_with_phone";
         })[];
+        custom_metadata: Record<string, string | boolean>;
         device_type: ("akuvox_lock" | "august_lock" | "brivo_access_point" | "butterflymx_panel" | "avigilon_alta_entry" | "doorking_lock" | "genie_door" | "igloo_lock" | "linear_lock" | "lockly_lock" | "kwikset_lock" | "nuki_lock" | "salto_lock" | "schlage_lock" | "seam_relay" | "smartthings_lock" | "wyze_lock" | "yale_lock" | "two_n_intercom" | "controlbyweb_device" | "ttlock_lock" | "igloohome_lock" | "hubitat_lock" | "four_suites_door" | "dormakaba_oracode_door" | "tedee_lock" | "akiles_lock") | ("noiseaware_activity_zone" | "minut_sensor") | ("ecobee_thermostat" | "nest_thermostat" | "honeywell_resideo_thermostat" | "tado_thermostat" | "sensi_thermostat" | "smartthings_thermostat") | ("ios_phone" | "android_phone");
         capabilities_supported: ("access_code" | "lock" | "noise_detection" | "thermostat" | "battery" | "phone")[];
         properties: {
@@ -33414,6 +33415,7 @@ export declare const workspaces_batch: z.ZodObject<{
             created_at: string;
             warning_code: "unknown_issue_with_phone";
         })[];
+        custom_metadata: Record<string, string | boolean>;
         device_type: ("akuvox_lock" | "august_lock" | "brivo_access_point" | "butterflymx_panel" | "avigilon_alta_entry" | "doorking_lock" | "genie_door" | "igloo_lock" | "linear_lock" | "lockly_lock" | "kwikset_lock" | "nuki_lock" | "salto_lock" | "schlage_lock" | "seam_relay" | "smartthings_lock" | "wyze_lock" | "yale_lock" | "two_n_intercom" | "controlbyweb_device" | "ttlock_lock" | "igloohome_lock" | "hubitat_lock" | "four_suites_door" | "dormakaba_oracode_door" | "tedee_lock" | "akiles_lock") | ("noiseaware_activity_zone" | "minut_sensor") | ("ecobee_thermostat" | "nest_thermostat" | "honeywell_resideo_thermostat" | "tado_thermostat" | "sensi_thermostat" | "smartthings_thermostat") | ("ios_phone" | "android_phone");
         capabilities_supported: ("access_code" | "lock" | "noise_detection" | "thermostat" | "battery" | "phone")[];
         properties: {
@@ -42502,6 +42504,7 @@ export declare const workspaces_batch: z.ZodObject<{
             created_at: string;
             warning_code: "unknown_issue_with_phone";
         })[];
+        custom_metadata: Record<string, string | boolean>;
         device_type: ("akuvox_lock" | "august_lock" | "brivo_access_point" | "butterflymx_panel" | "avigilon_alta_entry" | "doorking_lock" | "genie_door" | "igloo_lock" | "linear_lock" | "lockly_lock" | "kwikset_lock" | "nuki_lock" | "salto_lock" | "schlage_lock" | "seam_relay" | "smartthings_lock" | "wyze_lock" | "yale_lock" | "two_n_intercom" | "controlbyweb_device" | "ttlock_lock" | "igloohome_lock" | "hubitat_lock" | "four_suites_door" | "dormakaba_oracode_door" | "tedee_lock" | "akiles_lock") | ("noiseaware_activity_zone" | "minut_sensor") | ("ecobee_thermostat" | "nest_thermostat" | "honeywell_resideo_thermostat" | "tado_thermostat" | "sensi_thermostat" | "smartthings_thermostat") | ("ios_phone" | "android_phone");
         capabilities_supported: ("access_code" | "lock" | "noise_detection" | "thermostat" | "battery" | "phone")[];
         properties: {
@@ -46425,6 +46428,7 @@ export declare const workspaces_batch: z.ZodObject<{
             created_at: string;
             warning_code: "unknown_issue_with_phone";
         })[];
+        custom_metadata: Record<string, string | boolean>;
         device_type: ("akuvox_lock" | "august_lock" | "brivo_access_point" | "butterflymx_panel" | "avigilon_alta_entry" | "doorking_lock" | "genie_door" | "igloo_lock" | "linear_lock" | "lockly_lock" | "kwikset_lock" | "nuki_lock" | "salto_lock" | "schlage_lock" | "seam_relay" | "smartthings_lock" | "wyze_lock" | "yale_lock" | "two_n_intercom" | "controlbyweb_device" | "ttlock_lock" | "igloohome_lock" | "hubitat_lock" | "four_suites_door" | "dormakaba_oracode_door" | "tedee_lock" | "akiles_lock") | ("noiseaware_activity_zone" | "minut_sensor") | ("ecobee_thermostat" | "nest_thermostat" | "honeywell_resideo_thermostat" | "tado_thermostat" | "sensi_thermostat" | "smartthings_thermostat") | ("ios_phone" | "android_phone");
         capabilities_supported: ("access_code" | "lock" | "noise_detection" | "thermostat" | "battery" | "phone")[];
         properties: {
@@ -61465,7 +61469,7 @@ export declare const batch: z.ZodObject<{
         can_simulate_hub_connection: z.ZodOptional<z.ZodBoolean>;
         can_simulate_hub_disconnection: z.ZodOptional<z.ZodBoolean>;
         can_simulate_paid_subscription: z.ZodOptional<z.ZodBoolean>;
-    }, "device_id" | "workspace_id" | "created_at" | "errors" | "connected_account_id" | "warnings" | "device_type" | "capabilities_supported" | "location"> & {
+    }, "device_id" | "workspace_id" | "created_at" | "errors" | "connected_account_id" | "warnings" | "custom_metadata" | "device_type" | "capabilities_supported" | "location"> & {
         is_managed: z.ZodLiteral<false>;
         properties: z.ZodObject<Pick<{
             online: z.ZodBoolean;
@@ -61797,6 +61801,7 @@ export declare const batch: z.ZodObject<{
             created_at: string;
             warning_code: "unknown_issue_with_phone";
         })[];
+        custom_metadata: Record<string, string | boolean>;
         device_type: ("akuvox_lock" | "august_lock" | "brivo_access_point" | "butterflymx_panel" | "avigilon_alta_entry" | "doorking_lock" | "genie_door" | "igloo_lock" | "linear_lock" | "lockly_lock" | "kwikset_lock" | "nuki_lock" | "salto_lock" | "schlage_lock" | "seam_relay" | "smartthings_lock" | "wyze_lock" | "yale_lock" | "two_n_intercom" | "controlbyweb_device" | "ttlock_lock" | "igloohome_lock" | "hubitat_lock" | "four_suites_door" | "dormakaba_oracode_door" | "tedee_lock" | "akiles_lock") | ("noiseaware_activity_zone" | "minut_sensor") | ("ecobee_thermostat" | "nest_thermostat" | "honeywell_resideo_thermostat" | "tado_thermostat" | "sensi_thermostat" | "smartthings_thermostat") | ("ios_phone" | "android_phone");
         capabilities_supported: ("access_code" | "lock" | "noise_detection" | "thermostat" | "battery" | "phone")[];
         properties: {
@@ -62028,6 +62033,7 @@ export declare const batch: z.ZodObject<{
             created_at: string;
             warning_code: "unknown_issue_with_phone";
         })[];
+        custom_metadata: Record<string, string | boolean>;
         device_type: ("akuvox_lock" | "august_lock" | "brivo_access_point" | "butterflymx_panel" | "avigilon_alta_entry" | "doorking_lock" | "genie_door" | "igloo_lock" | "linear_lock" | "lockly_lock" | "kwikset_lock" | "nuki_lock" | "salto_lock" | "schlage_lock" | "seam_relay" | "smartthings_lock" | "wyze_lock" | "yale_lock" | "two_n_intercom" | "controlbyweb_device" | "ttlock_lock" | "igloohome_lock" | "hubitat_lock" | "four_suites_door" | "dormakaba_oracode_door" | "tedee_lock" | "akiles_lock") | ("noiseaware_activity_zone" | "minut_sensor") | ("ecobee_thermostat" | "nest_thermostat" | "honeywell_resideo_thermostat" | "tado_thermostat" | "sensi_thermostat" | "smartthings_thermostat") | ("ios_phone" | "android_phone");
         capabilities_supported: ("access_code" | "lock" | "noise_detection" | "thermostat" | "battery" | "phone")[];
         properties: {
@@ -70663,6 +70669,7 @@ export declare const batch: z.ZodObject<{
             created_at: string;
             warning_code: "unknown_issue_with_phone";
         })[];
+        custom_metadata: Record<string, string | boolean>;
         device_type: ("akuvox_lock" | "august_lock" | "brivo_access_point" | "butterflymx_panel" | "avigilon_alta_entry" | "doorking_lock" | "genie_door" | "igloo_lock" | "linear_lock" | "lockly_lock" | "kwikset_lock" | "nuki_lock" | "salto_lock" | "schlage_lock" | "seam_relay" | "smartthings_lock" | "wyze_lock" | "yale_lock" | "two_n_intercom" | "controlbyweb_device" | "ttlock_lock" | "igloohome_lock" | "hubitat_lock" | "four_suites_door" | "dormakaba_oracode_door" | "tedee_lock" | "akiles_lock") | ("noiseaware_activity_zone" | "minut_sensor") | ("ecobee_thermostat" | "nest_thermostat" | "honeywell_resideo_thermostat" | "tado_thermostat" | "sensi_thermostat" | "smartthings_thermostat") | ("ios_phone" | "android_phone");
         capabilities_supported: ("access_code" | "lock" | "noise_detection" | "thermostat" | "battery" | "phone")[];
         properties: {
@@ -74515,6 +74522,7 @@ export declare const batch: z.ZodObject<{
             created_at: string;
             warning_code: "unknown_issue_with_phone";
         })[];
+        custom_metadata: Record<string, string | boolean>;
         device_type: ("akuvox_lock" | "august_lock" | "brivo_access_point" | "butterflymx_panel" | "avigilon_alta_entry" | "doorking_lock" | "genie_door" | "igloo_lock" | "linear_lock" | "lockly_lock" | "kwikset_lock" | "nuki_lock" | "salto_lock" | "schlage_lock" | "seam_relay" | "smartthings_lock" | "wyze_lock" | "yale_lock" | "two_n_intercom" | "controlbyweb_device" | "ttlock_lock" | "igloohome_lock" | "hubitat_lock" | "four_suites_door" | "dormakaba_oracode_door" | "tedee_lock" | "akiles_lock") | ("noiseaware_activity_zone" | "minut_sensor") | ("ecobee_thermostat" | "nest_thermostat" | "honeywell_resideo_thermostat" | "tado_thermostat" | "sensi_thermostat" | "smartthings_thermostat") | ("ios_phone" | "android_phone");
         capabilities_supported: ("access_code" | "lock" | "noise_detection" | "thermostat" | "battery" | "phone")[];
         properties: {

package/lib/seam/connect/models/devices/unmanaged-device.d.ts

@@ -2753,7 +2753,7 @@ export declare const unmanaged_device: z.ZodObject<Pick<{
     can_simulate_hub_connection: z.ZodOptional<z.ZodBoolean>;
     can_simulate_hub_disconnection: z.ZodOptional<z.ZodBoolean>;
     can_simulate_paid_subscription: z.ZodOptional<z.ZodBoolean>;
-}, "device_id" | "workspace_id" | "created_at" | "errors" | "connected_account_id" | "warnings" | "device_type" | "capabilities_supported" | "location"> & {
+}, "device_id" | "workspace_id" | "created_at" | "errors" | "connected_account_id" | "warnings" | "custom_metadata" | "device_type" | "capabilities_supported" | "location"> & {
     is_managed: z.ZodLiteral<false>;
     properties: z.ZodObject<Pick<{
         online: z.ZodBoolean;
@@ -3085,6 +3085,7 @@ export declare const unmanaged_device: z.ZodObject<Pick<{
         created_at: string;
         warning_code: "unknown_issue_with_phone";
     })[];
+    custom_metadata: Record<string, string | boolean>;
     device_type: ("akuvox_lock" | "august_lock" | "brivo_access_point" | "butterflymx_panel" | "avigilon_alta_entry" | "doorking_lock" | "genie_door" | "igloo_lock" | "linear_lock" | "lockly_lock" | "kwikset_lock" | "nuki_lock" | "salto_lock" | "schlage_lock" | "seam_relay" | "smartthings_lock" | "wyze_lock" | "yale_lock" | "two_n_intercom" | "controlbyweb_device" | "ttlock_lock" | "igloohome_lock" | "hubitat_lock" | "four_suites_door" | "dormakaba_oracode_door" | "tedee_lock" | "akiles_lock") | ("noiseaware_activity_zone" | "minut_sensor") | ("ecobee_thermostat" | "nest_thermostat" | "honeywell_resideo_thermostat" | "tado_thermostat" | "sensi_thermostat" | "smartthings_thermostat") | ("ios_phone" | "android_phone");
     capabilities_supported: ("access_code" | "lock" | "noise_detection" | "thermostat" | "battery" | "phone")[];
     properties: {
@@ -3316,6 +3317,7 @@ export declare const unmanaged_device: z.ZodObject<Pick<{
         created_at: string;
         warning_code: "unknown_issue_with_phone";
     })[];
+    custom_metadata: Record<string, string | boolean>;
     device_type: ("akuvox_lock" | "august_lock" | "brivo_access_point" | "butterflymx_panel" | "avigilon_alta_entry" | "doorking_lock" | "genie_door" | "igloo_lock" | "linear_lock" | "lockly_lock" | "kwikset_lock" | "nuki_lock" | "salto_lock" | "schlage_lock" | "seam_relay" | "smartthings_lock" | "wyze_lock" | "yale_lock" | "two_n_intercom" | "controlbyweb_device" | "ttlock_lock" | "igloohome_lock" | "hubitat_lock" | "four_suites_door" | "dormakaba_oracode_door" | "tedee_lock" | "akiles_lock") | ("noiseaware_activity_zone" | "minut_sensor") | ("ecobee_thermostat" | "nest_thermostat" | "honeywell_resideo_thermostat" | "tado_thermostat" | "sensi_thermostat" | "smartthings_thermostat") | ("ios_phone" | "android_phone");
     capabilities_supported: ("access_code" | "lock" | "noise_detection" | "thermostat" | "battery" | "phone")[];
     properties: {

package/lib/seam/connect/models/devices/unmanaged-device.js

@@ -11,6 +11,7 @@ export const unmanaged_device = device
     errors: true,
     warnings: true,
     created_at: true,
+    custom_metadata: true,
 })
     .extend({
     is_managed: z.literal(false),

package/lib/seam/connect/models/devices/unmanaged-device.js.map

@@ -1 +1 @@
-{"version":3,"file":"unmanaged-device.js","sourceRoot":"","sources":["../../../../../src/lib/seam/connect/models/devices/unmanaged-device.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,CAAC,EAAE,MAAM,KAAK,CAAA;AAEvB,OAAO,EACL,wBAAwB,EACxB,MAAM,EACN,uBAAuB,GACxB,MAAM,aAAa,CAAA;AAEpB,MAAM,CAAC,MAAM,gBAAgB,GAAG,MAAM;KACnC,IAAI,CAAC;IACJ,SAAS,EAAE,IAAI;IACf,WAAW,EAAE,IAAI;IACjB,oBAAoB,EAAE,IAAI;IAC1B,QAAQ,EAAE,IAAI;IACd,sBAAsB,EAAE,IAAI;IAC5B,YAAY,EAAE,IAAI;IAClB,MAAM,EAAE,IAAI;IACZ,QAAQ,EAAE,IAAI;IACd,UAAU,EAAE,IAAI;CACjB,CAAC;KACD,MAAM,CAAC;IACN,UAAU,EAAE,CAAC,CAAC,OAAO,CAAC,KAAK,CAAC;IAC5B,UAAU,EAAE,wBAAwB,CAAC,IAAI,CAAC;QACxC,gBAAgB,EAAE,IAAI;QACtB,IAAI,EAAE,IAAI;QACV,MAAM,EAAE,IAAI;QACZ,YAAY,EAAE,IAAI;QAClB,SAAS,EAAE,IAAI;QACf,cAAc,EAAE,IAAI;QACpB,aAAa,EAAE,IAAI;QACnB,OAAO,EAAE,IAAI;QACb,2BAA2B,EAAE,IAAI;QACjC,4BAA4B,EAAE,IAAI;QAClC,KAAK,EAAE,IAAI;KACZ,CAAC,CAAC,QAAQ,CAAC;;;;;;;;;;;;;;;;;;;GAmBb,CAAC;CACD,CAAC;KACD,KAAK,CAAC,uBAAuB,CAAC,CAAC,QAAQ,CAAC;;;;;;;;;;;;;;;;;;;;GAoBxC,CAAC,CAAA"}
+{"version":3,"file":"unmanaged-device.js","sourceRoot":"","sources":["../../../../../src/lib/seam/connect/models/devices/unmanaged-device.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,CAAC,EAAE,MAAM,KAAK,CAAA;AAEvB,OAAO,EACL,wBAAwB,EACxB,MAAM,EACN,uBAAuB,GACxB,MAAM,aAAa,CAAA;AAEpB,MAAM,CAAC,MAAM,gBAAgB,GAAG,MAAM;KACnC,IAAI,CAAC;IACJ,SAAS,EAAE,IAAI;IACf,WAAW,EAAE,IAAI;IACjB,oBAAoB,EAAE,IAAI;IAC1B,QAAQ,EAAE,IAAI;IACd,sBAAsB,EAAE,IAAI;IAC5B,YAAY,EAAE,IAAI;IAClB,MAAM,EAAE,IAAI;IACZ,QAAQ,EAAE,IAAI;IACd,UAAU,EAAE,IAAI;IAChB,eAAe,EAAE,IAAI;CACtB,CAAC;KACD,MAAM,CAAC;IACN,UAAU,EAAE,CAAC,CAAC,OAAO,CAAC,KAAK,CAAC;IAC5B,UAAU,EAAE,wBAAwB,CAAC,IAAI,CAAC;QACxC,gBAAgB,EAAE,IAAI;QACtB,IAAI,EAAE,IAAI;QACV,MAAM,EAAE,IAAI;QACZ,YAAY,EAAE,IAAI;QAClB,SAAS,EAAE,IAAI;QACf,cAAc,EAAE,IAAI;QACpB,aAAa,EAAE,IAAI;QACnB,OAAO,EAAE,IAAI;QACb,2BAA2B,EAAE,IAAI;QACjC,4BAA4B,EAAE,IAAI;QAClC,KAAK,EAAE,IAAI;KACZ,CAAC,CAAC,QAAQ,CAAC;;;;;;;;;;;;;;;;;;;GAmBb,CAAC;CACD,CAAC;KACD,KAAK,CAAC,uBAAuB,CAAC,CAAC,QAAQ,CAAC;;;;;;;;;;;;;;;;;;;;GAoBxC,CAAC,CAAA"}

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

@@ -12912,6 +12912,15 @@ declare const _default: {
                         format: string;
                         type: string;
                     };
+                    custom_metadata: {
+                        additionalProperties: {
+                            oneOf: {
+                                type: string;
+                            }[];
+                        };
+                        description: string;
+                        type: string;
+                    };
                     device_id: {
                         description: string;
                         format: string;
@@ -32766,6 +32775,20 @@ declare const _default: {
                         'application/json': {
                             schema: {
                                 properties: {
+                                    custom_metadata: {
+                                        additionalProperties: {
+                                            nullable: boolean;
+                                            oneOf: ({
+                                                maxLength: number;
+                                                type: string;
+                                            } | {
+                                                type: string;
+                                                maxLength?: never;
+                                            })[];
+                                        };
+                                        description: string;
+                                        type: string;
+                                    };
                                     device_id: {
                                         description: string;
                                         format: string;
@@ -32835,6 +32858,20 @@ declare const _default: {
                         'application/json': {
                             schema: {
                                 properties: {
+                                    custom_metadata: {
+                                        additionalProperties: {
+                                            nullable: boolean;
+                                            oneOf: ({
+                                                maxLength: number;
+                                                type: string;
+                                            } | {
+                                                type: string;
+                                                maxLength?: never;
+                                            })[];
+                                        };
+                                        description: string;
+                                        type: string;
+                                    };
                                     device_id: {
                                         description: string;
                                         format: string;

package/lib/seam/connect/openapi.js

@@ -21229,6 +21229,13 @@ export default {
                         format: 'date-time',
                         type: 'string',
                     },
+                    custom_metadata: {
+                        additionalProperties: {
+                            oneOf: [{ type: 'string' }, { type: 'boolean' }],
+                        },
+                        description: 'Set of key:value pairs. Adding custom metadata to a resource, such as a [Connect Webview](https://docs.seam.co/latest/core-concepts/connect-webviews/attaching-custom-data-to-the-connect-webview), [connected account](https://docs.seam.co/latest/core-concepts/connected-accounts/adding-custom-metadata-to-a-connected-account), or [device](https://docs.seam.co/latest/core-concepts/devices/adding-custom-metadata-to-a-device), enables you to store custom information, like customer details or internal IDs from your application.',
+                        type: 'object',
+                    },
                     device_id: {
                         description: 'ID of the device.',
                         format: 'uuid',
@@ -22384,6 +22391,7 @@ export default {
                     'errors',
                     'warnings',
                     'created_at',
+                    'custom_metadata',
                     'is_managed',
                     'properties',
                 ],
@@ -38874,6 +38882,17 @@ export default {
                         'application/json': {
                             schema: {
                                 properties: {
+                                    custom_metadata: {
+                                        additionalProperties: {
+                                            nullable: true,
+                                            oneOf: [
+                                                { maxLength: 500, type: 'string' },
+                                                { type: 'boolean' },
+                                            ],
+                                        },
+                                        description: 'Custom metadata that you want to associate with the device. Supports up to 50 JSON key:value pairs.',
+                                        type: 'object',
+                                    },
                                     device_id: {
                                         description: 'ID of the unmanaged device that you want to update.',
                                         format: 'uuid',
@@ -38885,7 +38904,7 @@ export default {
                                         type: 'boolean',
                                     },
                                 },
-                                required: ['device_id', 'is_managed'],
+                                required: ['device_id'],
                                 type: 'object',
                             },
                         },
@@ -38927,6 +38946,17 @@ export default {
                         'application/json': {
                             schema: {
                                 properties: {
+                                    custom_metadata: {
+                                        additionalProperties: {
+                                            nullable: true,
+                                            oneOf: [
+                                                { maxLength: 500, type: 'string' },
+                                                { type: 'boolean' },
+                                            ],
+                                        },
+                                        description: 'Custom metadata that you want to associate with the device. Supports up to 50 JSON key:value pairs.',
+                                        type: 'object',
+                                    },
                                     device_id: {
                                         description: 'ID of the unmanaged device that you want to update.',
                                         format: 'uuid',
@@ -38938,7 +38968,7 @@ export default {
                                         type: 'boolean',
                                     },
                                 },
-                                required: ['device_id', 'is_managed'],
+                                required: ['device_id'],
                                 type: 'object',
                             },
                         },