@seamapi/types 1.409.1 → 1.410.0

This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
package/dist/connect.cjs CHANGED
@@ -3908,6 +3908,15 @@ var connect_webview_device_selection_mode = zod.z.enum([
3908
3908
  "single",
3909
3909
  "multiple"
3910
3910
  ]);
3911
+ var connect_webview_accepted_capabilities = zod.z.enum([
3912
+ "lock",
3913
+ "thermostat",
3914
+ "noise_sensor",
3915
+ "access_control"
3916
+ ]).describe(`
3917
+ High-level device capabilities that can be restricted in connect webviews.
3918
+ These represent the main device categories that customers can opt into.
3919
+ `);
3911
3920
  var connect_webview = zod.z.object({
3912
3921
  connect_webview_id: zod.z.string().uuid().describe("ID of the Connect Webview."),
3913
3922
  workspace_id: zod.z.string().uuid().describe(
@@ -3925,6 +3934,9 @@ var connect_webview = zod.z.object({
3925
3934
  accepted_providers: zod.z.array(zod.z.string()).describe(
3926
3935
  "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)."
3927
3936
  ),
3937
+ accepted_capabilities: zod.z.array(connect_webview_accepted_capabilities).describe(
3938
+ "List of accepted device capabilities that restrict the types of devices that can be connected through the Connect Webview."
3939
+ ),
3928
3940
  accepted_devices: zod.z.array(zod.z.string()).describe(
3929
3941
  `
3930
3942
  ---
@@ -11615,6 +11627,15 @@ var openapi_default = {
11615
11627
  connect_webview: {
11616
11628
  description: "Represents a [Connect Webview](https://docs.seam.co/latest/core-concepts/connect-webviews).\n\nConnect 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.\n\nConnect 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.\n\nTo 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.\n\nWhen 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.\n\nTo 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.",
11617
11629
  properties: {
11630
+ accepted_capabilities: {
11631
+ description: "List of accepted device capabilities that restrict the types of devices that can be connected through the Connect Webview.",
11632
+ items: {
11633
+ description: "\n High-level device capabilities that can be restricted in connect webviews.\n These represent the main device categories that customers can opt into.\n",
11634
+ enum: ["lock", "thermostat", "noise_sensor", "access_control"],
11635
+ type: "string"
11636
+ },
11637
+ type: "array"
11638
+ },
11618
11639
  accepted_devices: {
11619
11640
  deprecated: true,
11620
11641
  items: { type: "string" },
@@ -11723,6 +11744,7 @@ var openapi_default = {
11723
11744
  "url",
11724
11745
  "device_selection_mode",
11725
11746
  "accepted_providers",
11747
+ "accepted_capabilities",
11726
11748
  "accepted_devices",
11727
11749
  "any_device_allowed",
11728
11750
  "any_provider_allowed",
@@ -31441,6 +31463,20 @@ var openapi_default = {
31441
31463
  "application/json": {
31442
31464
  schema: {
31443
31465
  properties: {
31466
+ accepted_capabilities: {
31467
+ description: "List of accepted device capabilities that restrict the types of devices that can be connected through the Connect Webview. If not provided, defaults will be determined based on the accepted providers.",
31468
+ items: {
31469
+ description: "\n High-level device capabilities that can be restricted in connect webviews.\n These represent the main device categories that customers can opt into.\n",
31470
+ enum: [
31471
+ "lock",
31472
+ "thermostat",
31473
+ "noise_sensor",
31474
+ "access_control"
31475
+ ],
31476
+ type: "string"
31477
+ },
31478
+ type: "array"
31479
+ },
31444
31480
  accepted_providers: {
31445
31481
  description: "Accepted device provider keys as an alternative to `provider_category`. Use this parameter to specify accepted providers explicitly. See [Customize the Brands to Display in Your Connect Webviews](https://docs.seam.co/latest/core-concepts/connect-webviews/customizing-connect-webviews#customize-the-brands-to-display-in-your-connect-webviews). To list all provider keys, use [`/devices/list_device_providers`](https://docs.seam.co/latest/api/devices/list_device_providers) with no filters.",
31446
31482
  items: {