@seamapi/types 1.694.0 → 1.695.0

package/dist/connect.d.cts

@@ -99158,6 +99158,76 @@ declare const _default: {
                 'x-undocumented': string;
             };
         };
+        '/seam/customer/v1/customers/open_portal': {
+            post: {
+                description: string;
+                operationId: string;
+                requestBody: {
+                    content: {
+                        'application/json': {
+                            schema: {
+                                properties: {
+                                    customer_key: {
+                                        description: string;
+                                        type: string;
+                                    };
+                                };
+                                required: string[];
+                                type: string;
+                            };
+                        };
+                    };
+                };
+                responses: {
+                    200: {
+                        content: {
+                            'application/json': {
+                                schema: {
+                                    properties: {
+                                        magic_link: {
+                                            $ref: string;
+                                        };
+                                        ok: {
+                                            type: string;
+                                        };
+                                    };
+                                    required: string[];
+                                    type: string;
+                                };
+                            };
+                        };
+                        description: string;
+                    };
+                    400: {
+                        description: string;
+                    };
+                    401: {
+                        description: string;
+                    };
+                };
+                security: ({
+                    pat_with_workspace: never[];
+                    console_session_with_workspace?: never;
+                    api_key?: never;
+                } | {
+                    console_session_with_workspace: never[];
+                    pat_with_workspace?: never;
+                    api_key?: never;
+                } | {
+                    api_key: never[];
+                    pat_with_workspace?: never;
+                    console_session_with_workspace?: never;
+                })[];
+                summary: string;
+                tags: never[];
+                'x-fern-sdk-group-name': string[];
+                'x-fern-sdk-method-name': string;
+                'x-fern-sdk-return-value': string;
+                'x-response-key': string;
+                'x-title': string;
+                'x-undocumented': string;
+            };
+        };
         '/seam/customer/v1/events/list': {
             get: {
                 description: string;
@@ -167477,6 +167547,37 @@ type Routes = {
         };
         maxDuration: undefined;
     };
+    '/seam/customer/v1/customers/open_portal': {
+        route: '/seam/customer/v1/customers/open_portal';
+        method: 'POST';
+        queryParams: {};
+        jsonBody: {};
+        commonParams: {
+            /** The customer key to open a portal for. */
+            customer_key: string;
+        };
+        formData: {};
+        jsonResponse: {
+            /** Represents a Customer Portal. Customer Portal is a hosted, customizable interface for managing device access. It enables you to embed secure, pre-authenticated access flows into your product—either by sharing a link with users or embedding a view in an iframe.
+          
+          With Customer Portal, you no longer need to build out frontend experiences for physical access, thermostats, and sensors. Instead, you can ship enterprise-grade access control experiences in a fraction of the time, while maintaining your product's branding and user experience.
+          
+          Seam hosts these flows, handling everything from account connection and device mapping to full-featured device control. */
+            magic_link: {
+                /** URL for the magic link. */
+                url: string;
+                /** Customer key for the magic link. */
+                customer_key: string;
+                /** Date and time at which the magic link expires. */
+                expires_at: string;
+                /** ID of the [workspace](https://docs.seam.co/latest/core-concepts/workspaces) associated with the magic link. */
+                workspace_id: string;
+                /** Date and time at which the magic link was created. */
+                created_at: string;
+            };
+        };
+        maxDuration: undefined;
+    };
     '/seam/customer/v1/events/list': {
         route: '/seam/customer/v1/events/list';
         method: 'GET' | 'POST';

package/dist/index.cjs

@@ -56567,6 +56567,60 @@ var openapi_default = {
         "x-undocumented": "Internal endpoint for Console."
       }
     },
+    "/seam/customer/v1/customers/open_portal": {
+      post: {
+        description: "Opens an existing customer portal or creates a new one if the previous portal has expired.\nReturns an error if no portal was ever created for this customer.",
+        operationId: "seamCustomerV1CustomersOpenPortalPost",
+        requestBody: {
+          content: {
+            "application/json": {
+              schema: {
+                properties: {
+                  customer_key: {
+                    description: "The customer key to open a portal for.",
+                    type: "string"
+                  }
+                },
+                required: ["customer_key"],
+                type: "object"
+              }
+            }
+          }
+        },
+        responses: {
+          200: {
+            content: {
+              "application/json": {
+                schema: {
+                  properties: {
+                    magic_link: { $ref: "#/components/schemas/magic_link" },
+                    ok: { type: "boolean" }
+                  },
+                  required: ["magic_link", "ok"],
+                  type: "object"
+                }
+              }
+            },
+            description: "OK"
+          },
+          400: { description: "Bad Request" },
+          401: { description: "Unauthorized" }
+        },
+        security: [
+          { pat_with_workspace: [] },
+          { console_session_with_workspace: [] },
+          { api_key: [] }
+        ],
+        summary: "/seam/customer/v1/customers/open_portal",
+        tags: [],
+        "x-fern-sdk-group-name": ["seam", "customer", "v1", "customers"],
+        "x-fern-sdk-method-name": "open_portal",
+        "x-fern-sdk-return-value": "magic_link",
+        "x-response-key": "magic_link",
+        "x-title": "Open Customer Portal",
+        "x-undocumented": "Internal endpoint for Console."
+      }
+    },
     "/seam/customer/v1/events/list": {
       get: {
         description: "Returns a list of events for devices in a specific space. This endpoint is designed for customer portals and only supports filtering by space_id.",