@seamapi/types 1.694.0 → 1.696.0

package/dist/connect.d.cts

@@ -3716,6 +3716,20 @@ declare const access_grant: z.ZodObject<{
         created_at: string;
         warning_code: "being_deleted";
     }>]>, "many">;
+    errors: z.ZodArray<z.ZodDiscriminatedUnion<"error_code", [z.ZodObject<{
+        created_at: z.ZodString;
+        message: z.ZodString;
+    } & {
+        error_code: z.ZodLiteral<"cannot_create_requested_access_methods">;
+    }, "strip", z.ZodTypeAny, {
+        message: string;
+        created_at: string;
+        error_code: "cannot_create_requested_access_methods";
+    }, {
+        message: string;
+        created_at: string;
+        error_code: "cannot_create_requested_access_methods";
+    }>]>, "many">;
     customization_profile_id: z.ZodOptional<z.ZodString>;
 }, "strip", z.ZodTypeAny, {
     name: string | null;
@@ -3724,6 +3738,11 @@ declare const access_grant: z.ZodObject<{
     created_at: string;
     starts_at: string;
     ends_at: string | null;
+    errors: {
+        message: string;
+        created_at: string;
+        error_code: "cannot_create_requested_access_methods";
+    }[];
     warnings: {
         message: string;
         created_at: string;
@@ -3753,6 +3772,11 @@ declare const access_grant: z.ZodObject<{
     created_at: string;
     starts_at: string;
     ends_at: string | null;
+    errors: {
+        message: string;
+        created_at: string;
+        error_code: "cannot_create_requested_access_methods";
+    }[];
     warnings: {
         message: string;
         created_at: string;
@@ -25693,6 +25717,20 @@ declare const batch: z.ZodObject<{
             created_at: string;
             warning_code: "being_deleted";
         }>]>, "many">;
+        errors: z.ZodArray<z.ZodDiscriminatedUnion<"error_code", [z.ZodObject<{
+            created_at: z.ZodString;
+            message: z.ZodString;
+        } & {
+            error_code: z.ZodLiteral<"cannot_create_requested_access_methods">;
+        }, "strip", z.ZodTypeAny, {
+            message: string;
+            created_at: string;
+            error_code: "cannot_create_requested_access_methods";
+        }, {
+            message: string;
+            created_at: string;
+            error_code: "cannot_create_requested_access_methods";
+        }>]>, "many">;
         customization_profile_id: z.ZodOptional<z.ZodString>;
     }, "strip", z.ZodTypeAny, {
         name: string | null;
@@ -25701,6 +25739,11 @@ declare const batch: z.ZodObject<{
         created_at: string;
         starts_at: string;
         ends_at: string | null;
+        errors: {
+            message: string;
+            created_at: string;
+            error_code: "cannot_create_requested_access_methods";
+        }[];
         warnings: {
             message: string;
             created_at: string;
@@ -25730,6 +25773,11 @@ declare const batch: z.ZodObject<{
         created_at: string;
         starts_at: string;
         ends_at: string | null;
+        errors: {
+            message: string;
+            created_at: string;
+            error_code: "cannot_create_requested_access_methods";
+        }[];
         warnings: {
             message: string;
             created_at: string;
@@ -34558,6 +34606,11 @@ declare const batch: z.ZodObject<{
         created_at: string;
         starts_at: string;
         ends_at: string | null;
+        errors: {
+            message: string;
+            created_at: string;
+            error_code: "cannot_create_requested_access_methods";
+        }[];
         warnings: {
             message: string;
             created_at: string;
@@ -38635,6 +38688,11 @@ declare const batch: z.ZodObject<{
         created_at: string;
         starts_at: string;
         ends_at: string | null;
+        errors: {
+            message: string;
+            created_at: string;
+            error_code: "cannot_create_requested_access_methods";
+        }[];
         warnings: {
             message: string;
             created_at: string;
@@ -53717,6 +53775,35 @@ declare const _default: {
                         nullable: boolean;
                         type: string;
                     };
+                    errors: {
+                        description: string;
+                        items: {
+                            discriminator: {
+                                propertyName: string;
+                            };
+                            oneOf: {
+                                properties: {
+                                    created_at: {
+                                        description: string;
+                                        format: string;
+                                        type: string;
+                                    };
+                                    error_code: {
+                                        description: string;
+                                        enum: string[];
+                                        type: string;
+                                    };
+                                    message: {
+                                        description: string;
+                                        type: string;
+                                    };
+                                };
+                                required: string[];
+                                type: string;
+                            }[];
+                        };
+                        type: string;
+                    };
                     instant_key_url: {
                         description: string;
                         format: string;
@@ -73079,6 +73166,35 @@ declare const _default: {
                                                     nullable: boolean;
                                                     type: string;
                                                 };
+                                                errors: {
+                                                    description: string;
+                                                    items: {
+                                                        discriminator: {
+                                                            propertyName: string;
+                                                        };
+                                                        oneOf: {
+                                                            properties: {
+                                                                created_at: {
+                                                                    description: string;
+                                                                    format: string;
+                                                                    type: string;
+                                                                };
+                                                                error_code: {
+                                                                    description: string;
+                                                                    enum: string[];
+                                                                    type: string;
+                                                                };
+                                                                message: {
+                                                                    description: string;
+                                                                    type: string;
+                                                                };
+                                                            };
+                                                            required: string[];
+                                                            type: string;
+                                                        }[];
+                                                    };
+                                                    type: string;
+                                                };
                                                 location_ids: {
                                                     deprecated: boolean;
                                                     items: {
@@ -73301,6 +73417,35 @@ declare const _default: {
                                                     nullable: boolean;
                                                     type: string;
                                                 };
+                                                errors: {
+                                                    description: string;
+                                                    items: {
+                                                        discriminator: {
+                                                            propertyName: string;
+                                                        };
+                                                        oneOf: {
+                                                            properties: {
+                                                                created_at: {
+                                                                    description: string;
+                                                                    format: string;
+                                                                    type: string;
+                                                                };
+                                                                error_code: {
+                                                                    description: string;
+                                                                    enum: string[];
+                                                                    type: string;
+                                                                };
+                                                                message: {
+                                                                    description: string;
+                                                                    type: string;
+                                                                };
+                                                            };
+                                                            required: string[];
+                                                            type: string;
+                                                        }[];
+                                                    };
+                                                    type: string;
+                                                };
                                                 location_ids: {
                                                     deprecated: boolean;
                                                     items: {
@@ -73526,6 +73671,35 @@ declare const _default: {
                                                         nullable: boolean;
                                                         type: string;
                                                     };
+                                                    errors: {
+                                                        description: string;
+                                                        items: {
+                                                            discriminator: {
+                                                                propertyName: string;
+                                                            };
+                                                            oneOf: {
+                                                                properties: {
+                                                                    created_at: {
+                                                                        description: string;
+                                                                        format: string;
+                                                                        type: string;
+                                                                    };
+                                                                    error_code: {
+                                                                        description: string;
+                                                                        enum: string[];
+                                                                        type: string;
+                                                                    };
+                                                                    message: {
+                                                                        description: string;
+                                                                        type: string;
+                                                                    };
+                                                                };
+                                                                required: string[];
+                                                                type: string;
+                                                            }[];
+                                                        };
+                                                        type: string;
+                                                    };
                                                     location_ids: {
                                                         deprecated: boolean;
                                                         items: {
@@ -73764,6 +73938,35 @@ declare const _default: {
                                                         nullable: boolean;
                                                         type: string;
                                                     };
+                                                    errors: {
+                                                        description: string;
+                                                        items: {
+                                                            discriminator: {
+                                                                propertyName: string;
+                                                            };
+                                                            oneOf: {
+                                                                properties: {
+                                                                    created_at: {
+                                                                        description: string;
+                                                                        format: string;
+                                                                        type: string;
+                                                                    };
+                                                                    error_code: {
+                                                                        description: string;
+                                                                        enum: string[];
+                                                                        type: string;
+                                                                    };
+                                                                    message: {
+                                                                        description: string;
+                                                                        type: string;
+                                                                    };
+                                                                };
+                                                                required: string[];
+                                                                type: string;
+                                                            }[];
+                                                        };
+                                                        type: string;
+                                                    };
                                                     location_ids: {
                                                         deprecated: boolean;
                                                         items: {
@@ -99158,6 +99361,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;
@@ -124751,6 +125024,15 @@ type Routes = {
                     /** Unique identifier of the type of warning. Enables quick recognition and categorization of the issue. */
                     warning_code: 'being_deleted';
                 }[];
+                /** Errors associated with the [access grant](https://docs.seam.co/latest/capability-guides/access-grants). */
+                errors: {
+                    /** Date and time at which Seam created the error. */
+                    created_at: string;
+                    /** Detailed description of the error. Provides insights into the issue and potentially how to rectify it. */
+                    message: string;
+                    /** Unique identifier of the type of error. Enables quick recognition and categorization of the issue. */
+                    error_code: 'cannot_create_requested_access_methods';
+                }[];
                 /** ID of the customization profile associated with the Access Grant. */
                 customization_profile_id?: string | undefined;
             };
@@ -124839,6 +125121,15 @@ type Routes = {
                     /** Unique identifier of the type of warning. Enables quick recognition and categorization of the issue. */
                     warning_code: 'being_deleted';
                 }[];
+                /** Errors associated with the [access grant](https://docs.seam.co/latest/capability-guides/access-grants). */
+                errors: {
+                    /** Date and time at which Seam created the error. */
+                    created_at: string;
+                    /** Detailed description of the error. Provides insights into the issue and potentially how to rectify it. */
+                    message: string;
+                    /** Unique identifier of the type of error. Enables quick recognition and categorization of the issue. */
+                    error_code: 'cannot_create_requested_access_methods';
+                }[];
                 /** ID of the customization profile associated with the Access Grant. */
                 customization_profile_id?: string | undefined;
             };
@@ -126667,6 +126958,15 @@ type Routes = {
                     /** Unique identifier of the type of warning. Enables quick recognition and categorization of the issue. */
                     warning_code: 'being_deleted';
                 }[];
+                /** Errors associated with the [access grant](https://docs.seam.co/latest/capability-guides/access-grants). */
+                errors: {
+                    /** Date and time at which Seam created the error. */
+                    created_at: string;
+                    /** Detailed description of the error. Provides insights into the issue and potentially how to rectify it. */
+                    message: string;
+                    /** Unique identifier of the type of error. Enables quick recognition and categorization of the issue. */
+                    error_code: 'cannot_create_requested_access_methods';
+                }[];
                 /** ID of the customization profile associated with the Access Grant. */
                 customization_profile_id?: string | undefined;
             }[];
@@ -126746,6 +127046,15 @@ type Routes = {
                     /** Unique identifier of the type of warning. Enables quick recognition and categorization of the issue. */
                     warning_code: 'being_deleted';
                 }[];
+                /** Errors associated with the [access grant](https://docs.seam.co/latest/capability-guides/access-grants). */
+                errors: {
+                    /** Date and time at which Seam created the error. */
+                    created_at: string;
+                    /** Detailed description of the error. Provides insights into the issue and potentially how to rectify it. */
+                    message: string;
+                    /** Unique identifier of the type of error. Enables quick recognition and categorization of the issue. */
+                    error_code: 'cannot_create_requested_access_methods';
+                }[];
                 /** ID of the customization profile associated with the Access Grant. */
                 customization_profile_id?: string | undefined;
             };
@@ -126810,6 +127119,15 @@ type Routes = {
                     /** Unique identifier of the type of warning. Enables quick recognition and categorization of the issue. */
                     warning_code: 'being_deleted';
                 }[];
+                /** Errors associated with the [access grant](https://docs.seam.co/latest/capability-guides/access-grants). */
+                errors: {
+                    /** Date and time at which Seam created the error. */
+                    created_at: string;
+                    /** Detailed description of the error. Provides insights into the issue and potentially how to rectify it. */
+                    message: string;
+                    /** Unique identifier of the type of error. Enables quick recognition and categorization of the issue. */
+                    error_code: 'cannot_create_requested_access_methods';
+                }[];
                 /** ID of user identity to which the Access Grant gives access. */
                 user_identity_id?: string | undefined;
             };
@@ -126879,6 +127197,15 @@ type Routes = {
                     /** Unique identifier of the type of warning. Enables quick recognition and categorization of the issue. */
                     warning_code: 'being_deleted';
                 }[];
+                /** Errors associated with the [access grant](https://docs.seam.co/latest/capability-guides/access-grants). */
+                errors: {
+                    /** Date and time at which Seam created the error. */
+                    created_at: string;
+                    /** Detailed description of the error. Provides insights into the issue and potentially how to rectify it. */
+                    message: string;
+                    /** Unique identifier of the type of error. Enables quick recognition and categorization of the issue. */
+                    error_code: 'cannot_create_requested_access_methods';
+                }[];
                 /** ID of user identity to which the Access Grant gives access. */
                 user_identity_id?: string | undefined;
             }[];
@@ -129711,6 +130038,15 @@ type Routes = {
                         /** Unique identifier of the type of warning. Enables quick recognition and categorization of the issue. */
                         warning_code: 'being_deleted';
                     }[];
+                    /** Errors associated with the [access grant](https://docs.seam.co/latest/capability-guides/access-grants). */
+                    errors: {
+                        /** Date and time at which Seam created the error. */
+                        created_at: string;
+                        /** Detailed description of the error. Provides insights into the issue and potentially how to rectify it. */
+                        message: string;
+                        /** Unique identifier of the type of error. Enables quick recognition and categorization of the issue. */
+                        error_code: 'cannot_create_requested_access_methods';
+                    }[];
                     /** ID of the customization profile associated with the Access Grant. */
                     customization_profile_id?: string | undefined;
                 }[] | undefined;
@@ -167009,6 +167345,15 @@ type Routes = {
                     /** Unique identifier of the type of warning. Enables quick recognition and categorization of the issue. */
                     warning_code: 'being_deleted';
                 }[];
+                /** Errors associated with the [access grant](https://docs.seam.co/latest/capability-guides/access-grants). */
+                errors: {
+                    /** Date and time at which Seam created the error. */
+                    created_at: string;
+                    /** Detailed description of the error. Provides insights into the issue and potentially how to rectify it. */
+                    message: string;
+                    /** Unique identifier of the type of error. Enables quick recognition and categorization of the issue. */
+                    error_code: 'cannot_create_requested_access_methods';
+                }[];
                 /** ID of the customization profile associated with the Access Grant. */
                 customization_profile_id?: string | undefined;
             }[];
@@ -167477,6 +167822,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';
@@ -169852,6 +170228,15 @@ type Routes = {
                     /** Unique identifier of the type of warning. Enables quick recognition and categorization of the issue. */
                     warning_code: 'being_deleted';
                 }[];
+                /** Errors associated with the [access grant](https://docs.seam.co/latest/capability-guides/access-grants). */
+                errors: {
+                    /** Date and time at which Seam created the error. */
+                    created_at: string;
+                    /** Detailed description of the error. Provides insights into the issue and potentially how to rectify it. */
+                    message: string;
+                    /** Unique identifier of the type of error. Enables quick recognition and categorization of the issue. */
+                    error_code: 'cannot_create_requested_access_methods';
+                }[];
                 /** ID of the customization profile associated with the Access Grant. */
                 customization_profile_id?: string | undefined;
             };
@@ -196093,6 +196478,15 @@ type Routes = {
                         /** Unique identifier of the type of warning. Enables quick recognition and categorization of the issue. */
                         warning_code: 'being_deleted';
                     }[];
+                    /** Errors associated with the [access grant](https://docs.seam.co/latest/capability-guides/access-grants). */
+                    errors: {
+                        /** Date and time at which Seam created the error. */
+                        created_at: string;
+                        /** Detailed description of the error. Provides insights into the issue and potentially how to rectify it. */
+                        message: string;
+                        /** Unique identifier of the type of error. Enables quick recognition and categorization of the issue. */
+                        error_code: 'cannot_create_requested_access_methods';
+                    }[];
                     /** ID of the customization profile associated with the Access Grant. */
                     customization_profile_id?: string | undefined;
                 }[] | undefined;