@seamapi/types 1.529.0 → 1.531.0

package/dist/connect.d.cts

@@ -23592,7 +23592,7 @@ 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;
@@ -23924,6 +23924,7 @@ 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: {
@@ -24155,6 +24156,7 @@ 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: {
@@ -32790,6 +32792,7 @@ 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: {
@@ -36642,6 +36645,7 @@ 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: {
@@ -46506,7 +46510,7 @@ 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;
@@ -46838,6 +46842,7 @@ 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: {
@@ -47069,6 +47074,7 @@ 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: {
@@ -63549,6 +63555,15 @@ declare const _default: {
                         format: string;
                         type: string;
                     };
+                    custom_metadata: {
+                        additionalProperties: {
+                            oneOf: {
+                                type: string;
+                            }[];
+                        };
+                        description: string;
+                        type: string;
+                    };
                     device_id: {
                         description: string;
                         format: string;
@@ -82601,6 +82616,82 @@ declare const _default: {
                 'x-title': string;
             };
         };
+        '/devices/simulate/paid_subscription': {
+            post: {
+                description: string;
+                operationId: string;
+                requestBody: {
+                    content: {
+                        'application/json': {
+                            schema: {
+                                properties: {
+                                    device_id: {
+                                        format: string;
+                                        type: string;
+                                    };
+                                    is_expired: {
+                                        type: string;
+                                    };
+                                };
+                                required: string[];
+                                type: string;
+                            };
+                        };
+                    };
+                };
+                responses: {
+                    200: {
+                        content: {
+                            'application/json': {
+                                schema: {
+                                    properties: {
+                                        ok: {
+                                            type: 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;
+                    client_session_with_customer?: never;
+                } | {
+                    pat_with_workspace: never[];
+                    api_key?: never;
+                    console_session_with_workspace?: never;
+                    client_session_with_customer?: never;
+                } | {
+                    console_session_with_workspace: never[];
+                    api_key?: never;
+                    pat_with_workspace?: never;
+                    client_session_with_customer?: never;
+                } | {
+                    client_session_with_customer: never[];
+                    api_key?: never;
+                    pat_with_workspace?: never;
+                    console_session_with_workspace?: never;
+                })[];
+                summary: string;
+                tags: string[];
+                'x-fern-sdk-group-name': string[];
+                'x-fern-sdk-method-name': string;
+                'x-response-key': null;
+                'x-title': string;
+            };
+        };
         '/devices/simulate/remove': {
             post: {
                 description: string;
@@ -83327,6 +83418,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;
@@ -83396,6 +83501,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;
@@ -118267,6 +118386,10 @@ type Routes = {
                     })[];
                     /** Date and time at which the device object was created. */
                     created_at: string;
+                    /** 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. */
+                    custom_metadata: {
+                        [x: string]: string | boolean;
+                    };
                     is_managed: false;
                     /** properties of the device. */
                     properties: {
@@ -135340,6 +135463,18 @@ type Routes = {
         formData: {};
         jsonResponse: {};
     };
+    '/devices/simulate/paid_subscription': {
+        route: '/devices/simulate/paid_subscription';
+        method: 'POST';
+        queryParams: {};
+        jsonBody: {
+            device_id: string;
+            is_expired: boolean;
+        };
+        commonParams: {};
+        formData: {};
+        jsonResponse: {};
+    };
     '/devices/simulate/remove': {
         route: '/devices/simulate/remove';
         method: 'POST';
@@ -135665,6 +135800,10 @@ type Routes = {
                 })[];
                 /** Date and time at which the device object was created. */
                 created_at: string;
+                /** 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. */
+                custom_metadata: {
+                    [x: string]: string | boolean;
+                };
                 is_managed: false;
                 /** properties of the device. */
                 properties: {
@@ -136104,6 +136243,10 @@ type Routes = {
                 })[];
                 /** Date and time at which the device object was created. */
                 created_at: string;
+                /** 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. */
+                custom_metadata: {
+                    [x: string]: string | boolean;
+                };
                 is_managed: false;
                 /** properties of the device. */
                 properties: {
@@ -136203,7 +136346,11 @@ type Routes = {
             /** ID of the unmanaged device that you want to update. */
             device_id: string;
             /** Indicates whether the device is managed. Set this parameter to `true` to convert an unmanaged device to managed. */
-            is_managed: true;
+            is_managed?: true | undefined;
+            /** Custom metadata that you want to associate with the device. Supports up to 50 JSON key:value pairs. */
+            custom_metadata?: {
+                [x: string]: string | boolean | null;
+            } | undefined;
         };
         formData: {};
         jsonResponse: {};
@@ -184021,6 +184168,10 @@ type Routes = {
                     })[];
                     /** Date and time at which the device object was created. */
                     created_at: string;
+                    /** 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. */
+                    custom_metadata: {
+                        [x: string]: string | boolean;
+                    };
                     is_managed: false;
                     /** properties of the device. */
                     properties: {

package/dist/index.cjs

@@ -1841,7 +1841,8 @@ var unmanaged_device = device.pick({
   workspace_id: true,
   errors: true,
   warnings: true,
-  created_at: true
+  created_at: true,
+  custom_metadata: true
 }).extend({
   is_managed: zod.z.literal(false),
   properties: common_device_properties.pick({
@@ -26787,6 +26788,13 @@ var openapi_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",
@@ -27942,6 +27950,7 @@ var openapi_default = {
           "errors",
           "warnings",
           "created_at",
+          "custom_metadata",
           "is_managed",
           "properties"
         ],
@@ -43460,6 +43469,54 @@ var openapi_default = {
         "x-title": "Simulate Hub Disconnection"
       }
     },
+    "/devices/simulate/paid_subscription": {
+      post: {
+        description: "Toggle the simulated Nuki Smart Hosting subscription for a device (sandbox only).\nSend `is_expired: true` to simulate an expired subscription, or `false` to simulate an active subscription.\nThe actual device error is created/cleared by the poller after this state change.",
+        operationId: "devicesSimulatePaidSubscriptionPost",
+        requestBody: {
+          content: {
+            "application/json": {
+              schema: {
+                properties: {
+                  device_id: { format: "uuid", type: "string" },
+                  is_expired: { type: "boolean" }
+                },
+                required: ["device_id", "is_expired"],
+                type: "object"
+              }
+            }
+          }
+        },
+        responses: {
+          200: {
+            content: {
+              "application/json": {
+                schema: {
+                  properties: { ok: { type: "boolean" } },
+                  required: ["ok"],
+                  type: "object"
+                }
+              }
+            },
+            description: "OK"
+          },
+          400: { description: "Bad Request" },
+          401: { description: "Unauthorized" }
+        },
+        security: [
+          { api_key: [] },
+          { pat_with_workspace: [] },
+          { console_session_with_workspace: [] },
+          { client_session_with_customer: [] }
+        ],
+        summary: "/devices/simulate/paid_subscription",
+        tags: ["/devices"],
+        "x-fern-sdk-group-name": ["devices", "simulate"],
+        "x-fern-sdk-method-name": "paid_subscription",
+        "x-response-key": null,
+        "x-title": "Simulate Paid Subscription"
+      }
+    },
     "/devices/simulate/remove": {
       post: {
         description: "Simulates removing a device from Seam. Only applicable for [sandbox devices](https://docs.seam.co/latest/core-concepts/workspaces#sandbox-workspaces). See also [Testing Your App Against Device Disconnection and Removal](https://docs.seam.co/latest/core-concepts/devices/testing-your-app-against-device-disconnection-and-removal).",
@@ -44384,6 +44441,17 @@ var openapi_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",
@@ -44395,7 +44463,7 @@ var openapi_default = {
                     type: "boolean"
                   }
                 },
-                required: ["device_id", "is_managed"],
+                required: ["device_id"],
                 type: "object"
               }
             }
@@ -44437,6 +44505,17 @@ var openapi_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",
@@ -44448,7 +44527,7 @@ var openapi_default = {
                     type: "boolean"
                   }
                 },
-                required: ["device_id", "is_managed"],
+                required: ["device_id"],
                 type: "object"
               }
             }