@seamapi/types 1.803.0 → 1.805.0

package/lib/seam/connect/models/partner/customer-portal.d.ts

@@ -0,0 +1,21 @@
+import { z } from 'zod';
+export declare const customer_portal: z.ZodObject<{
+    url: z.ZodString;
+    customer_key: z.ZodString;
+    expires_at: z.ZodString;
+    workspace_id: z.ZodString;
+    created_at: z.ZodString;
+}, "strip", z.ZodTypeAny, {
+    workspace_id: string;
+    created_at: string;
+    customer_key: string;
+    expires_at: string;
+    url: string;
+}, {
+    workspace_id: string;
+    created_at: string;
+    customer_key: string;
+    expires_at: string;
+    url: string;
+}>;
+export type CustomerPortal = z.infer<typeof customer_portal>;

package/lib/seam/connect/models/partner/customer-portal.js

@@ -0,0 +1,29 @@
+import { z } from 'zod';
+export const customer_portal = z
+    .object({
+    url: z.string().url().describe('URL for the customer portal.'),
+    customer_key: z.string().describe('Customer key for the customer portal.'),
+    expires_at: z
+        .string()
+        .datetime()
+        .describe('Date and time at which the customer portal link expires.'),
+    workspace_id: z
+        .string()
+        .uuid()
+        .describe('ID of the [workspace](https://docs.seam.co/latest/core-concepts/workspaces) associated with the customer portal.'),
+    created_at: z
+        .string()
+        .datetime()
+        .describe('Date and time at which the customer portal link was created.'),
+})
+    .describe(`
+  ---
+  route_path: /customers
+  ---
+  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.
+  `);
+//# sourceMappingURL=customer-portal.js.map

package/lib/seam/connect/models/partner/customer-portal.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"customer-portal.js","sourceRoot":"","sources":["../../../../../src/lib/seam/connect/models/partner/customer-portal.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,CAAC,EAAE,MAAM,KAAK,CAAA;AAEvB,MAAM,CAAC,MAAM,eAAe,GAAG,CAAC;KAC7B,MAAM,CAAC;IACN,GAAG,EAAE,CAAC,CAAC,MAAM,EAAE,CAAC,GAAG,EAAE,CAAC,QAAQ,CAAC,8BAA8B,CAAC;IAC9D,YAAY,EAAE,CAAC,CAAC,MAAM,EAAE,CAAC,QAAQ,CAAC,uCAAuC,CAAC;IAC1E,UAAU,EAAE,CAAC;SACV,MAAM,EAAE;SACR,QAAQ,EAAE;SACV,QAAQ,CAAC,0DAA0D,CAAC;IACvE,YAAY,EAAE,CAAC;SACZ,MAAM,EAAE;SACR,IAAI,EAAE;SACN,QAAQ,CACP,kHAAkH,CACnH;IACH,UAAU,EAAE,CAAC;SACV,MAAM,EAAE;SACR,QAAQ,EAAE;SACV,QAAQ,CAAC,8DAA8D,CAAC;CAC5E,CAAC;KACD,QAAQ,CACP;;;;;;;;;GASD,CACA,CAAA"}

package/lib/seam/connect/models/partner/index.d.ts

@@ -1 +1,2 @@
+export * from './customer-portal.js';
 export * from './magic-link.js';

package/lib/seam/connect/models/partner/index.js

@@ -1,2 +1,3 @@
+export * from './customer-portal.js';
 export * from './magic-link.js';
 //# sourceMappingURL=index.js.map

package/lib/seam/connect/models/partner/index.js.map

@@ -1 +1 @@
-{"version":3,"file":"index.js","sourceRoot":"","sources":["../../../../../src/lib/seam/connect/models/partner/index.ts"],"names":[],"mappings":"AAAA,cAAc,iBAAiB,CAAA"}
+{"version":3,"file":"index.js","sourceRoot":"","sources":["../../../../../src/lib/seam/connect/models/partner/index.ts"],"names":[],"mappings":"AAAA,cAAc,sBAAsB,CAAA;AACpC,cAAc,iBAAiB,CAAA"}

package/lib/seam/connect/openapi.d.ts

@@ -5842,6 +5842,38 @@ declare const _default: {
                 'x-route-path': string;
                 'x-undocumented': string;
             };
+            customer_portal: {
+                description: string;
+                properties: {
+                    created_at: {
+                        description: string;
+                        format: string;
+                        type: string;
+                    };
+                    customer_key: {
+                        description: string;
+                        type: string;
+                    };
+                    expires_at: {
+                        description: string;
+                        format: string;
+                        type: string;
+                    };
+                    url: {
+                        description: string;
+                        format: string;
+                        type: string;
+                    };
+                    workspace_id: {
+                        description: string;
+                        format: string;
+                        type: string;
+                    };
+                };
+                required: string[];
+                type: string;
+                'x-route-path': string;
+            };
             customization_profile: {
                 description: string;
                 properties: {
@@ -40939,6 +40971,9 @@ declare const _default: {
                             'application/json': {
                                 schema: {
                                     properties: {
+                                        customer_portal: {
+                                            $ref: string;
+                                        };
                                         magic_link: {
                                             $ref: string;
                                         };

package/lib/seam/connect/openapi.js

@@ -10024,6 +10024,44 @@ export default {
                 'x-route-path': '/customers',
                 'x-undocumented': 'Internal resource.',
             },
+            customer_portal: {
+                description: "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.\n\nWith 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.\n\nSeam hosts these flows, handling everything from account connection and device mapping to full-featured device control.",
+                properties: {
+                    created_at: {
+                        description: 'Date and time at which the customer portal link was created.',
+                        format: 'date-time',
+                        type: 'string',
+                    },
+                    customer_key: {
+                        description: 'Customer key for the customer portal.',
+                        type: 'string',
+                    },
+                    expires_at: {
+                        description: 'Date and time at which the customer portal link expires.',
+                        format: 'date-time',
+                        type: 'string',
+                    },
+                    url: {
+                        description: 'URL for the customer portal.',
+                        format: 'uri',
+                        type: 'string',
+                    },
+                    workspace_id: {
+                        description: 'ID of the [workspace](https://docs.seam.co/latest/core-concepts/workspaces) associated with the customer portal.',
+                        format: 'uuid',
+                        type: 'string',
+                    },
+                },
+                required: [
+                    'url',
+                    'customer_key',
+                    'expires_at',
+                    'workspace_id',
+                    'created_at',
+                ],
+                type: 'object',
+                'x-route-path': '/customers',
+            },
             customization_profile: {
                 description: 'A customization profile.',
                 properties: {
@@ -46793,10 +46831,13 @@ export default {
                             'application/json': {
                                 schema: {
                                     properties: {
+                                        customer_portal: {
+                                            $ref: '#/components/schemas/customer_portal',
+                                        },
                                         magic_link: { $ref: '#/components/schemas/magic_link' },
                                         ok: { type: 'boolean' },
                                     },
-                                    required: ['magic_link', 'ok'],
+                                    required: ['customer_portal', 'magic_link', 'ok'],
                                     type: 'object',
                                 },
                             },
@@ -46815,8 +46856,8 @@ export default {
                 tags: [],
                 'x-fern-sdk-group-name': ['customers'],
                 'x-fern-sdk-method-name': 'create_portal',
-                'x-fern-sdk-return-value': 'magic_link',
-                'x-response-key': 'magic_link',
+                'x-fern-sdk-return-value': 'customer_portal',
+                'x-response-key': 'customer_portal',
                 'x-title': 'Create Customer Portal',
             },
         },