@seamapi/types 1.409.0 → 1.410.0

package/dist/connect.cjs

@@ -3908,6 +3908,15 @@ var connect_webview_device_selection_mode = zod.z.enum([
   "single",
   "multiple"
 ]);
+var connect_webview_accepted_capabilities = zod.z.enum([
+  "lock",
+  "thermostat",
+  "noise_sensor",
+  "access_control"
+]).describe(`
+  High-level device capabilities that can be restricted in connect webviews.
+  These represent the main device categories that customers can opt into.
+`);
 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(
@@ -3925,6 +3934,9 @@ var connect_webview = zod.z.object({
   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(connect_webview_accepted_capabilities).describe(
+    "List of accepted device capabilities that restrict the types of devices that can be connected through the Connect Webview."
+  ),
   accepted_devices: zod.z.array(zod.z.string()).describe(
     `
       ---
@@ -4163,7 +4175,7 @@ var access_grant_created_event = access_grant_event.extend({
   event_type: zod.z.literal("access_grant.created")
 }).describe(`
     ---
-    route_path: /unstable_access_grants
+    route_path: /access_grants
     ---
     An access grant was created.
   `);
@@ -4171,7 +4183,7 @@ var access_grant_deleted_event = access_grant_event.extend({
   event_type: zod.z.literal("access_grant.deleted")
 }).describe(`
     ---
-    route_path: /unstable_access_grants
+    route_path: /access_grants
     ---
     An access grant was deleted.
   `);
@@ -4179,7 +4191,7 @@ var access_grant_access_granted_to_all_doors_event = access_grant_event.extend({
   event_type: zod.z.literal("access_grant.access_granted_to_all_doors")
 }).describe(`
     ---
-    route_path: /unstable_access_grants
+    route_path: /access_grants
     ---
     All access requested for an access grant was successfully granted.
   `);
@@ -4191,7 +4203,7 @@ var access_grant_access_granted_to_door_event = access_grant_event.extend({
   acs_entrance_id
 }).describe(`
     ---
-    route_path: /unstable_access_grants
+    route_path: /access_grants
     ---
     Access requested as part of an access grant to a particular door was successfully granted.
   `);
@@ -4202,7 +4214,7 @@ var access_grant_access_to_door_lost_event = access_grant_event.extend(
   }
 ).describe(`
     ---
-    route_path: /unstable_access_grants
+    route_path: /access_grants
     ---
     Access to a particular door that was requested as part of an access grant was lost.
   `);
@@ -4220,7 +4232,7 @@ var access_method_issued_event = access_method_event.extend({
   event_type: zod.z.literal("access_method.issued")
 }).describe(`
     ---
-    route_path: /unstable_access_methods
+    route_path: /access_methods
     ---
     An access method was issued.
   `);
@@ -4228,7 +4240,7 @@ var access_method_card_encoding_required_event = access_method_event.extend({
   event_type: zod.z.literal("access_method.card_encoding_required")
 }).describe(`
     ---
-    route_path: /unstable_access_methods
+    route_path: /access_methods
     ---
     An access method representing a physical card requires encoding.
   `);
@@ -4236,7 +4248,7 @@ var access_method_revoked_event = access_method_event.extend({
   event_type: zod.z.literal("access_method.revoked")
 }).describe(`
     ---
-    route_path: /unstable_access_methods
+    route_path: /access_methods
     ---
     An access method was revoked.
   `);
@@ -4244,7 +4256,7 @@ var access_method_deleted_event = access_method_event.extend({
   event_type: zod.z.literal("access_method.deleted")
 }).describe(`
     ---
-    route_path: /unstable_access_methods
+    route_path: /access_methods
     ---
     An access method was deleted.
   `);
@@ -11615,6 +11627,15 @@ var openapi_default = {
       connect_webview: {
         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.",
         properties: {
+          accepted_capabilities: {
+            description: "List of accepted device capabilities that restrict the types of devices that can be connected through the Connect Webview.",
+            items: {
+              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",
+              enum: ["lock", "thermostat", "noise_sensor", "access_control"],
+              type: "string"
+            },
+            type: "array"
+          },
           accepted_devices: {
             deprecated: true,
             items: { type: "string" },
@@ -11723,6 +11744,7 @@ var openapi_default = {
           "url",
           "device_selection_mode",
           "accepted_providers",
+          "accepted_capabilities",
           "accepted_devices",
           "any_device_allowed",
           "any_provider_allowed",
@@ -15998,7 +16020,7 @@ var openapi_default = {
               "event_type"
             ],
             type: "object",
-            "x-route-path": "/unstable_access_grants"
+            "x-route-path": "/access_grants"
           },
           {
             description: "An access grant was deleted.",
@@ -16039,7 +16061,7 @@ var openapi_default = {
               "event_type"
             ],
             type: "object",
-            "x-route-path": "/unstable_access_grants"
+            "x-route-path": "/access_grants"
           },
           {
             description: "All access requested for an access grant was successfully granted.",
@@ -16083,7 +16105,7 @@ var openapi_default = {
               "event_type"
             ],
             type: "object",
-            "x-route-path": "/unstable_access_grants"
+            "x-route-path": "/access_grants"
           },
           {
             description: "Access requested as part of an access grant to a particular door was successfully granted.",
@@ -16133,7 +16155,7 @@ var openapi_default = {
               "acs_entrance_id"
             ],
             type: "object",
-            "x-route-path": "/unstable_access_grants"
+            "x-route-path": "/access_grants"
           },
           {
             description: "Access to a particular door that was requested as part of an access grant was lost.",
@@ -16183,7 +16205,7 @@ var openapi_default = {
               "acs_entrance_id"
             ],
             type: "object",
-            "x-route-path": "/unstable_access_grants"
+            "x-route-path": "/access_grants"
           },
           {
             description: "An access method was issued.",
@@ -16224,7 +16246,7 @@ var openapi_default = {
               "event_type"
             ],
             type: "object",
-            "x-route-path": "/unstable_access_methods"
+            "x-route-path": "/access_methods"
           },
           {
             description: "An access method was revoked.",
@@ -16265,7 +16287,7 @@ var openapi_default = {
               "event_type"
             ],
             type: "object",
-            "x-route-path": "/unstable_access_methods"
+            "x-route-path": "/access_methods"
           },
           {
             description: "An access method representing a physical card requires encoding.",
@@ -16309,7 +16331,7 @@ var openapi_default = {
               "event_type"
             ],
             type: "object",
-            "x-route-path": "/unstable_access_methods"
+            "x-route-path": "/access_methods"
           },
           {
             description: "An access method was deleted.",
@@ -16350,7 +16372,7 @@ var openapi_default = {
               "event_type"
             ],
             type: "object",
-            "x-route-path": "/unstable_access_methods"
+            "x-route-path": "/access_methods"
           },
           {
             description: "An [access system](https://docs.seam.co/latest/capability-guides/access-systems) was connected.",
@@ -26074,12 +26096,12 @@ var openapi_default = {
         ],
         summary: "/access_grants/create",
         tags: [],
+        "x-draft": "Early access.",
         "x-fern-sdk-group-name": ["access_grants"],
         "x-fern-sdk-method-name": "create",
         "x-fern-sdk-return-value": "access_grant",
         "x-response-key": "access_grant",
-        "x-title": "Create an Access Grant",
-        "x-undocumented": "Unreleased."
+        "x-title": "Create an Access Grant"
       }
     },
     "/access_grants/delete": {
@@ -26127,11 +26149,11 @@ var openapi_default = {
         ],
         summary: "/access_grants/delete",
         tags: [],
+        "x-draft": "Early access.",
         "x-fern-sdk-group-name": ["access_grants"],
         "x-fern-sdk-method-name": "delete",
         "x-response-key": null,
-        "x-title": "Delete an Access Grant",
-        "x-undocumented": "Unreleased."
+        "x-title": "Delete an Access Grant"
       }
     },
     "/access_grants/get": {
@@ -26273,12 +26295,12 @@ var openapi_default = {
         ],
         summary: "/access_grants/get",
         tags: [],
+        "x-draft": "Early access.",
         "x-fern-sdk-group-name": ["access_grants"],
         "x-fern-sdk-method-name": "get",
         "x-fern-sdk-return-value": "access_grant",
         "x-response-key": "access_grant",
-        "x-title": "Get an Access Grant",
-        "x-undocumented": "Unreleased."
+        "x-title": "Get an Access Grant"
       }
     },
     "/access_grants/list": {
@@ -26443,12 +26465,12 @@ var openapi_default = {
         ],
         summary: "/access_grants/list",
         tags: [],
+        "x-draft": "Early access.",
         "x-fern-sdk-group-name": ["access_grants"],
         "x-fern-sdk-method-name": "list",
         "x-fern-sdk-return-value": "access_grants",
         "x-response-key": "access_grants",
-        "x-title": "List Access Grants",
-        "x-undocumented": "Unreleased."
+        "x-title": "List Access Grants"
       }
     },
     "/access_methods/delete": {
@@ -26495,11 +26517,11 @@ var openapi_default = {
         ],
         summary: "/access_methods/delete",
         tags: [],
+        "x-draft": "Early access.",
         "x-fern-sdk-group-name": ["access_methods"],
         "x-fern-sdk-method-name": "delete",
         "x-response-key": null,
-        "x-title": "Delete an Access Method",
-        "x-undocumented": "Unreleased."
+        "x-title": "Delete an Access Method"
       }
     },
     "/access_methods/get": {
@@ -26599,12 +26621,12 @@ var openapi_default = {
         ],
         summary: "/access_methods/get",
         tags: [],
+        "x-draft": "Early access.",
         "x-fern-sdk-group-name": ["access_methods"],
         "x-fern-sdk-method-name": "get",
         "x-fern-sdk-return-value": "access_method",
         "x-response-key": "access_method",
-        "x-title": "Get an Access Method",
-        "x-undocumented": "Unreleased."
+        "x-title": "Get an Access Method"
       }
     },
     "/access_methods/list": {
@@ -26707,12 +26729,12 @@ var openapi_default = {
         ],
         summary: "/access_methods/list",
         tags: [],
+        "x-draft": "Early access.",
         "x-fern-sdk-group-name": ["access_methods"],
         "x-fern-sdk-method-name": "list",
         "x-fern-sdk-return-value": "access_methods",
         "x-response-key": "access_methods",
-        "x-title": "List Access Methods",
-        "x-undocumented": "Unreleased."
+        "x-title": "List Access Methods"
       }
     },
     "/acs/access_groups/add_user": {
@@ -31441,6 +31463,20 @@ var openapi_default = {
             "application/json": {
               schema: {
                 properties: {
+                  accepted_capabilities: {
+                    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.",
+                    items: {
+                      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",
+                      enum: [
+                        "lock",
+                        "thermostat",
+                        "noise_sensor",
+                        "access_control"
+                      ],
+                      type: "string"
+                    },
+                    type: "array"
+                  },
                   accepted_providers: {
                     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.",
                     items: {
@@ -36957,6 +36993,7 @@ var openapi_default = {
         ],
         summary: "/spaces/add_acs_entrances",
         tags: [],
+        "x-draft": "Early access.",
         "x-fern-sdk-group-name": ["spaces"],
         "x-fern-sdk-method-name": "add_acs_entrances",
         "x-response-key": null,
@@ -37006,6 +37043,7 @@ var openapi_default = {
         ],
         summary: "/spaces/add_acs_entrances",
         tags: [],
+        "x-draft": "Early access.",
         "x-fern-ignore": true,
         "x-response-key": null,
         "x-title": "Add ACS Entrances"
@@ -37056,6 +37094,7 @@ var openapi_default = {
         ],
         summary: "/spaces/add_devices",
         tags: [],
+        "x-draft": "Early access.",
         "x-fern-sdk-group-name": ["spaces"],
         "x-fern-sdk-method-name": "add_devices",
         "x-response-key": null,
@@ -37105,6 +37144,7 @@ var openapi_default = {
         ],
         summary: "/spaces/add_devices",
         tags: [],
+        "x-draft": "Early access.",
         "x-fern-ignore": true,
         "x-response-key": null,
         "x-title": "Add Space Devices"
@@ -37161,6 +37201,7 @@ var openapi_default = {
         ],
         summary: "/spaces/create",
         tags: [],
+        "x-draft": "Early access.",
         "x-fern-sdk-group-name": ["spaces"],
         "x-fern-sdk-method-name": "create",
         "x-fern-sdk-return-value": "space",
@@ -37293,6 +37334,7 @@ var openapi_default = {
         ],
         summary: "/spaces/list",
         tags: [],
+        "x-draft": "Early access.",
         "x-fern-ignore": true,
         "x-response-key": "spaces",
         "x-title": "List Spaces"
@@ -37329,6 +37371,7 @@ var openapi_default = {
         ],
         summary: "/spaces/list",
         tags: [],
+        "x-draft": "Early access.",
         "x-fern-sdk-group-name": ["spaces"],
         "x-fern-sdk-method-name": "list",
         "x-fern-sdk-return-value": "spaces",
@@ -37380,6 +37423,7 @@ var openapi_default = {
         ],
         summary: "/spaces/remove_acs_entrances",
         tags: [],
+        "x-draft": "Early access.",
         "x-fern-sdk-group-name": ["spaces"],
         "x-fern-sdk-method-name": "remove_acs_entrances",
         "x-response-key": null,
@@ -37430,6 +37474,7 @@ var openapi_default = {
         ],
         summary: "/spaces/remove_devices",
         tags: [],
+        "x-draft": "Early access.",
         "x-fern-sdk-group-name": ["spaces"],
         "x-fern-sdk-method-name": "remove_devices",
         "x-response-key": null,
@@ -37480,6 +37525,7 @@ var openapi_default = {
         ],
         summary: "/spaces/update",
         tags: [],
+        "x-draft": "Early access.",
         "x-fern-ignore": true,
         "x-response-key": "space",
         "x-title": "Update Space"
@@ -37527,6 +37573,7 @@ var openapi_default = {
         ],
         summary: "/spaces/update",
         tags: [],
+        "x-draft": "Early access.",
         "x-fern-sdk-group-name": ["spaces"],
         "x-fern-sdk-method-name": "update",
         "x-fern-sdk-return-value": "space",
@@ -41915,14 +41962,28 @@ var openapi_default = {
                         enum: ["organize_spaces"],
                         type: "string"
                       },
-                      collection_key: { type: "string" },
-                      customer_key: { type: "string" }
+                      customer_key: { type: "string" },
+                      partner_resources: {
+                        description: "Optional list of partner resources to include in the magic link.",
+                        items: {
+                          properties: {
+                            custom_metadata: {
+                              additionalProperties: { type: "string" },
+                              type: "object"
+                            },
+                            description: { type: "string" },
+                            name: { type: "string" },
+                            partner_resource_key: { type: "string" }
+                          },
+                          required: ["partner_resource_key", "name"],
+                          type: "object",
+                          "x-route-path": "/unstable_partner/resources",
+                          "x-undocumented": "Unreleased."
+                        },
+                        type: "array"
+                      }
                     },
-                    required: [
-                      "building_block_type",
-                      "customer_key",
-                      "collection_key"
-                    ],
+                    required: ["building_block_type", "customer_key"],
                     type: "object"
                   }
                 ]
@@ -42039,11 +42100,10 @@ var openapi_default = {
                       "x-route-path": "/unstable_partner/resources",
                       "x-undocumented": "Unreleased."
                     },
-                    minItems: 1,
                     type: "array"
                   }
                 },
-                required: ["customer_key", "partner_resources"],
+                required: ["customer_key"],
                 type: "object"
               }
             }