@seamapi/types 1.803.0 → 1.805.0

package/dist/connect.d.cts

@@ -62938,6 +62938,26 @@ declare const pagination: z.ZodObject<{
 }>;
 type Pagination = z.infer<typeof pagination>;
 
+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;
+}>;
+
 declare const magic_link: z.ZodObject<{
     url: z.ZodString;
     customer_key: z.ZodString;
@@ -63402,6 +63422,7 @@ declare const schemas_common_succeeded_action_attempt: typeof common_succeeded_a
 declare const schemas_connect_webview: typeof connect_webview;
 declare const schemas_connected_account: typeof connected_account;
 declare const schemas_custom_metadata: typeof custom_metadata;
+declare const schemas_customer_portal: typeof customer_portal;
 declare const schemas_customization_profile: typeof customization_profile;
 declare const schemas_device: typeof device;
 declare const schemas_device_provider: typeof device_provider;
@@ -63423,7 +63444,7 @@ declare const schemas_user_identity: typeof user_identity;
 declare const schemas_webhook: typeof webhook;
 declare const schemas_workspace: typeof workspace;
 declare namespace schemas {
-  export { schemas_access_code as access_code, schemas_acs_access_group as acs_access_group, schemas_acs_credential as acs_credential, schemas_acs_encoder as acs_encoder, schemas_acs_entrance as acs_entrance, schemas_acs_system as acs_system, schemas_acs_user as acs_user, schemas_action_attempt as action_attempt, schemas_batch as batch, schemas_bridge as bridge, schemas_bridge_client_session as bridge_client_session, schemas_client_session as client_session, schemas_common_failed_action_attempt as common_failed_action_attempt, schemas_common_pending_action_attempt as common_pending_action_attempt, schemas_common_succeeded_action_attempt as common_succeeded_action_attempt, schemas_connect_webview as connect_webview, schemas_connected_account as connected_account, schemas_custom_metadata as custom_metadata, schemas_customization_profile as customization_profile, schemas_device as device, schemas_device_provider as device_provider, schemas_instant_key as instant_key, schemas_magic_link as magic_link, schemas_noise_threshold as noise_threshold, schemas_pagination as pagination, schemas_seam_event as seam_event, schemas_staff_member_resource as staff_member_resource, schemas_thermostat_daily_program as thermostat_daily_program, schemas_thermostat_schedule as thermostat_schedule, schemas_thermostat_weekly_program as thermostat_weekly_program, schemas_unmanaged_access_code as unmanaged_access_code, schemas_unmanaged_acs_access_group as unmanaged_acs_access_group, schemas_unmanaged_acs_credential as unmanaged_acs_credential, schemas_unmanaged_acs_user as unmanaged_acs_user, schemas_unmanaged_device as unmanaged_device, schemas_user_identity as user_identity, schemas_webhook as webhook, schemas_workspace as workspace };
+  export { schemas_access_code as access_code, schemas_acs_access_group as acs_access_group, schemas_acs_credential as acs_credential, schemas_acs_encoder as acs_encoder, schemas_acs_entrance as acs_entrance, schemas_acs_system as acs_system, schemas_acs_user as acs_user, schemas_action_attempt as action_attempt, schemas_batch as batch, schemas_bridge as bridge, schemas_bridge_client_session as bridge_client_session, schemas_client_session as client_session, schemas_common_failed_action_attempt as common_failed_action_attempt, schemas_common_pending_action_attempt as common_pending_action_attempt, schemas_common_succeeded_action_attempt as common_succeeded_action_attempt, schemas_connect_webview as connect_webview, schemas_connected_account as connected_account, schemas_custom_metadata as custom_metadata, schemas_customer_portal as customer_portal, schemas_customization_profile as customization_profile, schemas_device as device, schemas_device_provider as device_provider, schemas_instant_key as instant_key, schemas_magic_link as magic_link, schemas_noise_threshold as noise_threshold, schemas_pagination as pagination, schemas_seam_event as seam_event, schemas_staff_member_resource as staff_member_resource, schemas_thermostat_daily_program as thermostat_daily_program, schemas_thermostat_schedule as thermostat_schedule, schemas_thermostat_weekly_program as thermostat_weekly_program, schemas_unmanaged_access_code as unmanaged_access_code, schemas_unmanaged_acs_access_group as unmanaged_acs_access_group, schemas_unmanaged_acs_credential as unmanaged_acs_credential, schemas_unmanaged_acs_user as unmanaged_acs_user, schemas_unmanaged_device as unmanaged_device, schemas_user_identity as user_identity, schemas_webhook as webhook, schemas_workspace as workspace };
 }
 
 declare const _default: {
@@ -69270,6 +69291,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: {
@@ -104367,6 +104420,9 @@ declare const _default: {
                             'application/json': {
                                 schema: {
                                     properties: {
+                                        customer_portal: {
+                                            $ref: string;
+                                        };
                                         magic_link: {
                                             $ref: string;
                                         };
@@ -169443,6 +169499,23 @@ type Routes = {
           
           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. */
+            customer_portal: {
+                /** URL for the customer portal. */
+                url: string;
+                /** Customer key for the customer portal. */
+                customer_key: string;
+                /** Date and time at which the customer portal link expires. */
+                expires_at: string;
+                /** ID of the [workspace](https://docs.seam.co/latest/core-concepts/workspaces) associated with the customer portal. */
+                workspace_id: string;
+                /** Date and time at which the customer portal link was created. */
+                created_at: string;
+            };
+            /** 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. */

package/dist/index.cjs

@@ -29,6 +29,7 @@ __export(schemas_exports, {
   connect_webview: () => connect_webview,
   connected_account: () => connected_account,
   custom_metadata: () => custom_metadata,
+  customer_portal: () => customer_portal,
   customization_profile: () => customization_profile,
   device: () => device,
   device_provider: () => device_provider,
@@ -6781,6 +6782,26 @@ var pagination = zod.z.object({
   ),
   next_page_url: zod.z.string().url().nullable().describe("URL to get the next page of results.")
 }).describe("Information about the current page of results.");
+var customer_portal = zod.z.object({
+  url: zod.z.string().url().describe("URL for the customer portal."),
+  customer_key: zod.z.string().describe("Customer key for the customer portal."),
+  expires_at: zod.z.string().datetime().describe("Date and time at which the customer portal link expires."),
+  workspace_id: zod.z.string().uuid().describe(
+    "ID of the [workspace](https://docs.seam.co/latest/core-concepts/workspaces) associated with the customer portal."
+  ),
+  created_at: zod.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\u2014either 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.
+  `
+);
 var magic_link = zod.z.object({
   url: zod.z.string().url().describe("URL for the magic link."),
   customer_key: zod.z.string().describe("Customer key for the magic link."),
@@ -16847,6 +16868,44 @@ var openapi_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\u2014either 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: {
@@ -53616,10 +53675,13 @@ var openapi_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"
                 }
               }
@@ -53638,8 +53700,8 @@ var openapi_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"
       }
     },