@seamapi/types 1.462.0 → 1.464.0

package/dist/index.cjs

@@ -1324,14 +1324,6 @@ var functional_offline_device = common_device_warning.extend({
 var third_party_integration_detected = common_device_warning.extend({
   warning_code: zod.z.literal("third_party_integration_detected").describe(warning_code_description2)
 }).describe("Indicates that a third-party integration has been detected.");
-var nest_thermostat_in_manual_eco_mode = common_device_warning.extend({
-  warning_code: zod.z.literal("nest_thermostat_in_manual_eco_mode").describe(warning_code_description2)
-}).describe(`
-    ---
-    variant_group_key: thermostats
-    ---
-    Indicates that the Nest thermostat is in manual eco mode.
-    `);
 var ttlock_lock_gateway_unlocking_not_enabled = common_device_warning.extend({
   warning_code: zod.z.literal("ttlock_lock_gateway_unlocking_not_enabled").describe(warning_code_description2)
 }).describe(`
@@ -1389,7 +1381,6 @@ var device_warning = zod.z.discriminatedUnion("warning_code", [
   wyze_device_missing_gateway,
   functional_offline_device,
   third_party_integration_detected,
-  nest_thermostat_in_manual_eco_mode,
   ttlock_lock_gateway_unlocking_not_enabled,
   ttlock_weak_gateway_signal,
   power_saving_mode,
@@ -1413,7 +1404,6 @@ zod.z.object({
   wyze_device_missing_gateway: wyze_device_missing_gateway.optional().nullable(),
   functional_offline_device: functional_offline_device.optional().nullable(),
   third_party_integration_detected: third_party_integration_detected.optional().nullable(),
-  nest_thermostat_in_manual_eco_mode: nest_thermostat_in_manual_eco_mode.optional().nullable(),
   ttlock_lock_gateway_unlocking_not_enabled: ttlock_lock_gateway_unlocking_not_enabled.optional().nullable(),
   ttlock_weak_gateway_signal: ttlock_weak_gateway_signal.optional().nullable(),
   power_saving_mode: power_saving_mode.optional().nullable(),
@@ -1762,7 +1752,8 @@ var DEVICE_PROVIDERS = {
   SALTO_SPACE: "salto_space",
   SENSI: "sensi",
   KWIKSET2: "kwikset2",
-  KEYNEST: "keynest"
+  KEYNEST: "keynest",
+  DORMAKABA_AMBIANCE: "dormakaba_ambiance"
 };
 var ALL_DEVICE_PROVIDERS = Object.values(DEVICE_PROVIDERS);
 var PROVIDER_CATEGORY_MAP = {
@@ -1817,7 +1808,8 @@ var PROVIDER_CATEGORY_MAP = {
     "latch",
     "salto_ks",
     "assa_abloy_vostio",
-    "salto_space"
+    "salto_space",
+    "dormakaba_ambiance"
   ],
   internal_beta: ALL_DEVICE_PROVIDERS
 };
@@ -2807,6 +2799,7 @@ var acs_system_external_type = zod.z.enum([
   "assa_abloy_credential_service",
   "latch_building",
   "dormakaba_community_site",
+  "dormakaba_ambiance_site",
   "legic_connect_credential_service",
   "assa_abloy_vostio",
   "assa_abloy_vostio_credential_service"
@@ -3844,6 +3837,90 @@ var client_session = zod.z.object({
 
   See also [Get Started with React](https://docs.seam.co/latest/ui-components/overview/getting-started-with-seam-components/get-started-with-react-components-and-client-session-tokens).
 `);
+var connect_webview_device_selection_mode = zod.z.enum([
+  "none",
+  "single",
+  "multiple"
+]);
+var connect_webview = zod.z.object({
+  connect_webview_id: zod.z.string().uuid().describe("ID of the Connect Webview."),
+  workspace_id: zod.z.string().uuid().describe(
+    "ID of the [workspace](https://docs.seam.co/latest/core-concepts/workspaces) that contains the Connect Webview."
+  ),
+  created_at: zod.z.string().datetime().describe("Date and time at which the Connect Webview was created."),
+  connected_account_id: zod.z.string().uuid().nullable().describe(
+    "ID of the [connected account](https://docs.seam.co/latest/core-concepts/connected-accounts) associated with the Connect Webview."
+  ),
+  url: zod.z.string().url().describe(
+    "URL for the Connect Webview. You use the URL to display the Connect Webview flow to your user."
+  ),
+  device_selection_mode: connect_webview_device_selection_mode,
+  // TODO: Use enum value.
+  accepted_providers: zod.z.array(zod.z.string()).describe(
+    "List of accepted [provider keys](https://docs.seam.co/latest/core-concepts/connect-webviews/customizing-connect-webviews#customize-the-brands-to-display-in-your-connect-webviews)."
+  ),
+  accepted_capabilities: zod.z.array(provider_capability).describe(
+    "High-level device capabilities that the Connect Webview can accept. When creating a Connect Webview, you can specify the types of devices that it can connect to Seam. If you do not set custom `accepted_capabilities`, Seam uses a default set of `accepted_capabilities` for each provider. For example, if you create a Connect Webview that accepts SmartThing devices, without specifying `accepted_capabilities`, Seam accepts only SmartThings locks. To connect SmartThings thermostats and locks to Seam, create a Connect Webview and include both `thermostat` and `lock` in the `accepted_capabilities`."
+  ),
+  accepted_devices: zod.z.array(zod.z.string()).describe(
+    `
+      ---
+      undocumented: Unused. Will be removed.
+      deprecated: Unused. Will be removed.
+      ---
+      `
+  ),
+  any_device_allowed: zod.z.boolean().describe(
+    `
+      ---
+      undocumented: Unused. Will be removed.
+      deprecated: Unused. Will be removed.
+      ---
+      `
+  ),
+  any_provider_allowed: zod.z.boolean().describe("Indicates whether any provider is allowed."),
+  login_successful: zod.z.boolean().describe(
+    "Indicates whether the user logged in successfully using the Connect Webview."
+  ),
+  status: zod.z.enum(["pending", "failed", "authorized"]).describe(
+    "Status of the Connect Webview. `authorized` indicates that the user has successfully logged into their device or system account, thereby completing the Connect Webview."
+  ),
+  custom_redirect_url: zod.z.string().url().nullable().describe(
+    "URL to which the Connect Webview should redirect when the user successfully pairs a device or system. If you do not set the `custom_redirect_failure_url`, the Connect Webview redirects to the `custom_redirect_url` when an unexpected error occurs."
+  ),
+  custom_redirect_failure_url: zod.z.string().url().nullable().describe(
+    "URL to which the Connect Webview should redirect when an unexpected error occurs."
+  ),
+  custom_metadata,
+  automatically_manage_new_devices: zod.z.boolean().describe(
+    "Indicates whether Seam should [import all new devices](https://docs.seam.co/latest/core-concepts/connect-webviews/customizing-connect-webviews#automatically_manage_new_devices) for the connected account to make these devices available for use and management by the Seam API."
+  ),
+  wait_for_device_creation: zod.z.boolean().describe(
+    "Indicates whether Seam should [finish syncing all devices](https://docs.seam.co/latest/core-concepts/connect-webviews/customizing-connect-webviews#wait_for_device_creation) in a newly-connected account before completing the associated Connect Webview."
+  ),
+  authorized_at: zod.z.string().datetime().nullable().describe(
+    "Date and time at which the user authorized (through the Connect Webview) the management of their devices."
+  ),
+  selected_provider: zod.z.string().nullable().describe(
+    "Selected provider of the Connect Webview, one of the [provider keys](https://docs.seam.co/latest/core-concepts/connect-webviews/customizing-connect-webviews#customize-the-brands-to-display-in-your-connect-webviews)."
+  ),
+  customer_key: zod.z.string().optional().describe("The customer key associated with this webview, if any.")
+}).describe(`
+  ---
+  route_path: /connect_webviews
+  ---
+  Represents a [Connect Webview](https://docs.seam.co/latest/core-concepts/connect-webviews).
+
+  Connect Webviews are fully-embedded client-side components that you add to your app. Your users interact with your embedded Connect Webviews to link their IoT device or system accounts to Seam. That is, Connect Webviews walk your users through the process of logging in to their device or system accounts. Seam handles all the authentication steps, and\u2014once your user has completed the authorization through your app\u2014you can access and control their devices or systems using the Seam API.
+  
+  Connect Webviews perform credential validation, multifactor authentication (when applicable), and error handling for each brand that Seam supports. Further, Connect Webviews work across all modern browsers and platforms, including Chrome, Safari, and Firefox.
+  
+  To enable a user to connect their device or system account to Seam through your app, first create a \`connect_webview\`. Once created, this \`connect_webview\` includes a URL that you can use to open an [iframe](https://www.w3schools.com/html/html_iframe.asp) or new window containing the Connect Webview for your user.
+
+  When you create a Connect Webview, specify the desired provider category key in the \`provider_category\` parameter. Alternately, to specify a list of providers explicitly, use the \`accepted_providers\` parameter with a list of device provider keys.
+
+  To list all providers within a category, use \`/devices/list_device_providers\` with the desired \`provider_category\` filter. To list all provider keys, use \`/devices/list_device_providers\` with no filters.
+`);
 var space = zod.z.object({
   space_id: zod.z.string().uuid().describe("ID of the space."),
   workspace_id: zod.z.string().uuid().describe(
@@ -4033,7 +4110,8 @@ zod.z.object({
   client_sessions: client_session.array().optional(),
   unmanaged_acs_users: unmanaged_acs_user.array().optional(),
   unmanaged_acs_access_groups: unmanaged_acs_access_group.array().optional(),
-  unmanaged_devices: unmanaged_device.array().optional()
+  unmanaged_devices: unmanaged_device.array().optional(),
+  connect_webviews: connect_webview.array().optional()
 }).describe("A batch of workspace resources.");
 var batch = zod.z.object({
   batch_type: zod.z.enum([
@@ -4055,7 +4133,8 @@ var batch = zod.z.object({
   client_sessions: client_session.array().optional(),
   unmanaged_acs_users: unmanaged_acs_user.array().optional(),
   unmanaged_acs_access_groups: unmanaged_acs_access_group.array().optional(),
-  unmanaged_devices: unmanaged_device.array().optional()
+  unmanaged_devices: unmanaged_device.array().optional(),
+  connect_webviews: connect_webview.array().optional()
 }).describe("A batch of workspace resources.");
 var bridge = zod.z.object({
   bridge_id: zod.z.string().uuid().describe("ID of Seam Bridge."),
@@ -4134,90 +4213,6 @@ var bridge_client_session = zod.z.object({
   ---
   Represents a [Seam Bridge](https://docs.seam.co/latest/capability-guides/seam-bridge) client session.
 `);
-var connect_webview_device_selection_mode = zod.z.enum([
-  "none",
-  "single",
-  "multiple"
-]);
-var connect_webview = zod.z.object({
-  connect_webview_id: zod.z.string().uuid().describe("ID of the Connect Webview."),
-  workspace_id: zod.z.string().uuid().describe(
-    "ID of the [workspace](https://docs.seam.co/latest/core-concepts/workspaces) that contains the Connect Webview."
-  ),
-  created_at: zod.z.string().datetime().describe("Date and time at which the Connect Webview was created."),
-  connected_account_id: zod.z.string().uuid().nullable().describe(
-    "ID of the [connected account](https://docs.seam.co/latest/core-concepts/connected-accounts) associated with the Connect Webview."
-  ),
-  url: zod.z.string().url().describe(
-    "URL for the Connect Webview. You use the URL to display the Connect Webview flow to your user."
-  ),
-  device_selection_mode: connect_webview_device_selection_mode,
-  // TODO: Use enum value.
-  accepted_providers: zod.z.array(zod.z.string()).describe(
-    "List of accepted [provider keys](https://docs.seam.co/latest/core-concepts/connect-webviews/customizing-connect-webviews#customize-the-brands-to-display-in-your-connect-webviews)."
-  ),
-  accepted_capabilities: zod.z.array(provider_capability).describe(
-    "High-level device capabilities that the Connect Webview can accept. When creating a Connect Webview, you can specify the types of devices that it can connect to Seam. If you do not set custom `accepted_capabilities`, Seam uses a default set of `accepted_capabilities` for each provider. For example, if you create a Connect Webview that accepts SmartThing devices, without specifying `accepted_capabilities`, Seam accepts only SmartThings locks. To connect SmartThings thermostats and locks to Seam, create a Connect Webview and include both `thermostat` and `lock` in the `accepted_capabilities`."
-  ),
-  accepted_devices: zod.z.array(zod.z.string()).describe(
-    `
-      ---
-      undocumented: Unused. Will be removed.
-      deprecated: Unused. Will be removed.
-      ---
-      `
-  ),
-  any_device_allowed: zod.z.boolean().describe(
-    `
-      ---
-      undocumented: Unused. Will be removed.
-      deprecated: Unused. Will be removed.
-      ---
-      `
-  ),
-  any_provider_allowed: zod.z.boolean().describe("Indicates whether any provider is allowed."),
-  login_successful: zod.z.boolean().describe(
-    "Indicates whether the user logged in successfully using the Connect Webview."
-  ),
-  status: zod.z.enum(["pending", "failed", "authorized"]).describe(
-    "Status of the Connect Webview. `authorized` indicates that the user has successfully logged into their device or system account, thereby completing the Connect Webview."
-  ),
-  custom_redirect_url: zod.z.string().url().nullable().describe(
-    "URL to which the Connect Webview should redirect when the user successfully pairs a device or system. If you do not set the `custom_redirect_failure_url`, the Connect Webview redirects to the `custom_redirect_url` when an unexpected error occurs."
-  ),
-  custom_redirect_failure_url: zod.z.string().url().nullable().describe(
-    "URL to which the Connect Webview should redirect when an unexpected error occurs."
-  ),
-  custom_metadata,
-  automatically_manage_new_devices: zod.z.boolean().describe(
-    "Indicates whether Seam should [import all new devices](https://docs.seam.co/latest/core-concepts/connect-webviews/customizing-connect-webviews#automatically_manage_new_devices) for the connected account to make these devices available for use and management by the Seam API."
-  ),
-  wait_for_device_creation: zod.z.boolean().describe(
-    "Indicates whether Seam should [finish syncing all devices](https://docs.seam.co/latest/core-concepts/connect-webviews/customizing-connect-webviews#wait_for_device_creation) in a newly-connected account before completing the associated Connect Webview."
-  ),
-  authorized_at: zod.z.string().datetime().nullable().describe(
-    "Date and time at which the user authorized (through the Connect Webview) the management of their devices."
-  ),
-  selected_provider: zod.z.string().nullable().describe(
-    "Selected provider of the Connect Webview, one of the [provider keys](https://docs.seam.co/latest/core-concepts/connect-webviews/customizing-connect-webviews#customize-the-brands-to-display-in-your-connect-webviews)."
-  ),
-  customer_key: zod.z.string().optional().describe("The customer key associated with this webview, if any.")
-}).describe(`
-  ---
-  route_path: /connect_webviews
-  ---
-  Represents a [Connect Webview](https://docs.seam.co/latest/core-concepts/connect-webviews).
-
-  Connect Webviews are fully-embedded client-side components that you add to your app. Your users interact with your embedded Connect Webviews to link their IoT device or system accounts to Seam. That is, Connect Webviews walk your users through the process of logging in to their device or system accounts. Seam handles all the authentication steps, and\u2014once your user has completed the authorization through your app\u2014you can access and control their devices or systems using the Seam API.
-  
-  Connect Webviews perform credential validation, multifactor authentication (when applicable), and error handling for each brand that Seam supports. Further, Connect Webviews work across all modern browsers and platforms, including Chrome, Safari, and Firefox.
-  
-  To enable a user to connect their device or system account to Seam through your app, first create a \`connect_webview\`. Once created, this \`connect_webview\` includes a URL that you can use to open an [iframe](https://www.w3schools.com/html/html_iframe.asp) or new window containing the Connect Webview for your user.
-
-  When you create a Connect Webview, specify the desired provider category key in the \`provider_category\` parameter. Alternately, to specify a list of providers explicitly, use the \`accepted_providers\` parameter with a list of device provider keys.
-
-  To list all providers within a category, use \`/devices/list_device_providers\` with the desired \`provider_category\` filter. To list all provider keys, use \`/devices/list_device_providers\` with no filters.
-`);
 var common_event = zod.z.object({
   event_id: zod.z.string().uuid().describe("ID of the event."),
   workspace_id: zod.z.string().uuid().describe(
@@ -7004,6 +6999,7 @@ var openapi_default = {
           ends_at: {
             description: "Date and time at which the Access Grant ends.",
             format: "date-time",
+            nullable: true,
             type: "string"
           },
           instant_key_url: {
@@ -7087,7 +7083,9 @@ var openapi_default = {
           "access_method_ids",
           "name",
           "display_name",
-          "created_at"
+          "created_at",
+          "starts_at",
+          "ends_at"
         ],
         type: "object",
         "x-draft": "Early access.",
@@ -8208,6 +8206,7 @@ var openapi_default = {
               "assa_abloy_credential_service",
               "latch_building",
               "dormakaba_community_site",
+              "dormakaba_ambiance_site",
               "legic_connect_credential_service",
               "assa_abloy_vostio",
               "assa_abloy_vostio_credential_service"
@@ -8258,6 +8257,7 @@ var openapi_default = {
               "assa_abloy_credential_service",
               "latch_building",
               "dormakaba_community_site",
+              "dormakaba_ambiance_site",
               "legic_connect_credential_service",
               "assa_abloy_vostio",
               "assa_abloy_vostio_credential_service"
@@ -16548,28 +16548,6 @@ var openapi_default = {
                   required: ["message", "created_at", "warning_code"],
                   type: "object"
                 },
-                {
-                  description: "Indicates that the Nest thermostat is in manual eco mode.",
-                  properties: {
-                    created_at: {
-                      description: "Date and time at which Seam created the warning.",
-                      format: "date-time",
-                      type: "string"
-                    },
-                    message: {
-                      description: "Detailed description of the warning. Provides insights into the issue and potentially how to rectify it.",
-                      type: "string"
-                    },
-                    warning_code: {
-                      description: "Unique identifier of the type of warning. Enables quick recognition and categorization of the issue.",
-                      enum: ["nest_thermostat_in_manual_eco_mode"],
-                      type: "string"
-                    }
-                  },
-                  required: ["message", "created_at", "warning_code"],
-                  type: "object",
-                  "x-variant-group-key": "thermostats"
-                },
                 {
                   description: 'Indicates that the Remote Unlock feature is not enabled in the settings."',
                   properties: {
@@ -16936,7 +16914,8 @@ var openapi_default = {
               "salto_space",
               "sensi",
               "kwikset2",
-              "keynest"
+              "keynest",
+              "dormakaba_ambiance"
             ],
             type: "string"
           },
@@ -27473,28 +27452,6 @@ var openapi_default = {
                   required: ["message", "created_at", "warning_code"],
                   type: "object"
                 },
-                {
-                  description: "Indicates that the Nest thermostat is in manual eco mode.",
-                  properties: {
-                    created_at: {
-                      description: "Date and time at which Seam created the warning.",
-                      format: "date-time",
-                      type: "string"
-                    },
-                    message: {
-                      description: "Detailed description of the warning. Provides insights into the issue and potentially how to rectify it.",
-                      type: "string"
-                    },
-                    warning_code: {
-                      description: "Unique identifier of the type of warning. Enables quick recognition and categorization of the issue.",
-                      enum: ["nest_thermostat_in_manual_eco_mode"],
-                      type: "string"
-                    }
-                  },
-                  required: ["message", "created_at", "warning_code"],
-                  type: "object",
-                  "x-variant-group-key": "thermostats"
-                },
                 {
                   description: 'Indicates that the Remote Unlock feature is not enabled in the settings."',
                   properties: {
@@ -30541,7 +30498,9 @@ var openapi_default = {
                         type: "array"
                       },
                       ends_at: {
+                        default: null,
                         description: "Date and time at which the validity of the new grant ends, in [ISO 8601](https://www.iso.org/iso-8601-date-and-time-format.html) format. Must be a time in the future and after `starts_at`.",
+                        nullable: true,
                         type: "string"
                       },
                       location: {
@@ -31297,7 +31256,6 @@ var openapi_default = {
                   starts_at: {
                     description: "Date and time at which the validity of the grant starts, in [ISO 8601](https://www.iso.org/iso-8601-date-and-time-format.html) format.",
                     format: "date-time",
-                    nullable: true,
                     type: "string"
                   }
                 },
@@ -31364,7 +31322,6 @@ var openapi_default = {
                   starts_at: {
                     description: "Date and time at which the validity of the grant starts, in [ISO 8601](https://www.iso.org/iso-8601-date-and-time-format.html) format.",
                     format: "date-time",
-                    nullable: true,
                     type: "string"
                   }
                 },
@@ -31761,6 +31718,12 @@ var openapi_default = {
                           },
                           type: "array"
                         },
+                        connect_webviews: {
+                          items: {
+                            $ref: "#/components/schemas/connect_webview"
+                          },
+                          type: "array"
+                        },
                         devices: {
                           items: { $ref: "#/components/schemas/device" },
                           type: "array"
@@ -31912,6 +31875,12 @@ var openapi_default = {
                           },
                           type: "array"
                         },
+                        connect_webviews: {
+                          items: {
+                            $ref: "#/components/schemas/connect_webview"
+                          },
+                          type: "array"
+                        },
                         devices: {
                           items: { $ref: "#/components/schemas/device" },
                           type: "array"
@@ -39080,6 +39049,7 @@ var openapi_default = {
                         "sensi",
                         "kwikset2",
                         "keynest",
+                        "dormakaba_ambiance",
                         "yale_access",
                         "hid_cm",
                         "google_nest"
@@ -40096,6 +40066,11 @@ var openapi_default = {
                   {
                     default: {
                       features: {
+                        configure: {
+                          allow_access_automation_rule_customization: false,
+                          allow_instant_key_customization: false,
+                          exclude: false
+                        },
                         connect: { exclude: false },
                         manage_devices: { exclude: false },
                         organize: { exclude: false }
@@ -40107,6 +40082,28 @@ var openapi_default = {
                       features: {
                         default: {},
                         properties: {
+                          configure: {
+                            default: {},
+                            description: "Configuration for the configure feature.",
+                            properties: {
+                              allow_access_automation_rule_customization: {
+                                default: false,
+                                description: "Indicates whether the customer can customize the access automation rules for their properties.",
+                                type: "boolean"
+                              },
+                              allow_instant_key_customization: {
+                                default: false,
+                                description: "Indicates whether the customer can customize the Instant Key profile for their properties.",
+                                type: "boolean"
+                              },
+                              exclude: {
+                                default: false,
+                                description: "Whether to exclude this feature from the portal.",
+                                type: "boolean"
+                              }
+                            },
+                            type: "object"
+                          },
                           connect: {
                             default: {},
                             description: "Configuration for the connect accounts feature.",
@@ -48788,6 +48785,18 @@ var openapi_default = {
                         },
                         features: {
                           properties: {
+                            configure: {
+                              properties: {
+                                allow_access_automation_rule_customization: {
+                                  type: "boolean"
+                                },
+                                allow_instant_key_customization: {
+                                  type: "boolean"
+                                },
+                                exclude: { type: "boolean" }
+                              },
+                              type: "object"
+                            },
                             connect: {
                               properties: { exclude: { type: "boolean" } },
                               type: "object"
@@ -48869,6 +48878,18 @@ var openapi_default = {
                         },
                         features: {
                           properties: {
+                            configure: {
+                              properties: {
+                                allow_access_automation_rule_customization: {
+                                  type: "boolean"
+                                },
+                                allow_instant_key_customization: {
+                                  type: "boolean"
+                                },
+                                exclude: { type: "boolean" }
+                              },
+                              type: "object"
+                            },
                             connect: {
                               properties: { exclude: { type: "boolean" } },
                               type: "object"
@@ -58264,6 +58285,12 @@ var openapi_default = {
                           },
                           type: "array"
                         },
+                        connect_webviews: {
+                          items: {
+                            $ref: "#/components/schemas/connect_webview"
+                          },
+                          type: "array"
+                        },
                         devices: {
                           items: { $ref: "#/components/schemas/device" },
                           type: "array"
@@ -58392,6 +58419,12 @@ var openapi_default = {
                           },
                           type: "array"
                         },
+                        connect_webviews: {
+                          items: {
+                            $ref: "#/components/schemas/connect_webview"
+                          },
+                          type: "array"
+                        },
                         devices: {
                           items: { $ref: "#/components/schemas/device" },
                           type: "array"