@seamapi/types 1.694.0 → 1.696.0

package/lib/seam/connect/route-types.d.ts

@@ -10166,6 +10166,15 @@ export 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;
             };
@@ -10254,6 +10263,15 @@ export 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;
             };
@@ -12082,6 +12100,15 @@ export 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;
             }[];
@@ -12161,6 +12188,15 @@ export 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;
             };
@@ -12225,6 +12261,15 @@ export 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;
             };
@@ -12294,6 +12339,15 @@ export 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;
             }[];
@@ -15126,6 +15180,15 @@ export 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;
@@ -52424,6 +52487,15 @@ export 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;
             }[];
@@ -52892,6 +52964,37 @@ export 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';
@@ -55267,6 +55370,15 @@ export 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;
             };
@@ -81508,6 +81620,15 @@ export 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;

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@seamapi/types",
-  "version": "1.694.0",
+  "version": "1.696.0",
   "description": "TypeScript types for the Seam API.",
   "type": "module",
   "main": "index.js",

package/src/lib/seam/connect/models/access-grants/access-grant.ts

@@ -2,6 +2,28 @@ import { z } from 'zod'
 
 import { requested_access_method } from './requested-access-method.js'
 
+const common_access_grant_error = z.object({
+  created_at: z
+    .string()
+    .datetime()
+    .describe('Date and time at which Seam created the error.'),
+  message: z
+    .string()
+    .describe(
+      'Detailed description of the error. Provides insights into the issue and potentially how to rectify it.',
+    ),
+})
+
+const error_code_description =
+  'Unique identifier of the type of error. Enables quick recognition and categorization of the issue.'
+
+const cannot_create_requested_access_methods_error =
+  common_access_grant_error.extend({
+    error_code: z
+      .literal('cannot_create_requested_access_methods')
+      .describe(error_code_description),
+  })
+
 const common_access_grant_warning = z.object({
   created_at: z
     .string()
@@ -17,6 +39,19 @@ const common_access_grant_warning = z.object({
 const warning_code_description =
   'Unique identifier of the type of warning. Enables quick recognition and categorization of the issue.'
 
+const access_grant_error = z.discriminatedUnion('error_code', [
+  cannot_create_requested_access_methods_error,
+])
+
+export type AccessGrantError = z.infer<typeof access_grant_error>
+
+export const _access_grant_error_map = z.object({
+  cannot_create_requested_access_methods:
+    cannot_create_requested_access_methods_error.optional().nullable(),
+})
+
+export type AccessGrantErrorMap = z.infer<typeof _access_grant_error_map>
+
 const being_deleted = common_access_grant_warning
   .extend({
     warning_code: z.literal('being_deleted').describe(warning_code_description),
@@ -107,6 +142,11 @@ export const access_grant = z.object({
     .describe(
       'Warnings associated with the [access grant](https://docs.seam.co/latest/capability-guides/access-grants).',
     ),
+  errors: z
+    .array(access_grant_error)
+    .describe(
+      'Errors associated with the [access grant](https://docs.seam.co/latest/capability-guides/access-grants).',
+    ),
   customization_profile_id: z
     .string()
     .uuid()

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

@@ -1888,6 +1888,39 @@ export default {
             nullable: true,
             type: 'string',
           },
+          errors: {
+            description:
+              'Errors associated with the [access grant](https://docs.seam.co/latest/capability-guides/access-grants).',
+            items: {
+              discriminator: { propertyName: 'error_code' },
+              oneOf: [
+                {
+                  properties: {
+                    created_at: {
+                      description:
+                        'Date and time at which Seam created the error.',
+                      format: 'date-time',
+                      type: 'string',
+                    },
+                    error_code: {
+                      description:
+                        'Unique identifier of the type of error. Enables quick recognition and categorization of the issue.',
+                      enum: ['cannot_create_requested_access_methods'],
+                      type: 'string',
+                    },
+                    message: {
+                      description:
+                        'Detailed description of the error. Provides insights into the issue and potentially how to rectify it.',
+                      type: 'string',
+                    },
+                  },
+                  required: ['created_at', 'message', 'error_code'],
+                  type: 'object',
+                },
+              ],
+            },
+            type: 'array',
+          },
           instant_key_url: {
             description:
               'Instant Key URL. Only returned if the Access Grant has a single mobile_key access_method. ',
@@ -2031,6 +2064,7 @@ export default {
           'starts_at',
           'ends_at',
           'warnings',
+          'errors',
         ],
         type: 'object',
         'x-draft': 'Early access.',
@@ -30156,6 +30190,45 @@ export default {
                           nullable: true,
                           type: 'string',
                         },
+                        errors: {
+                          description:
+                            'Errors associated with the [access grant](https://docs.seam.co/latest/capability-guides/access-grants).',
+                          items: {
+                            discriminator: { propertyName: 'error_code' },
+                            oneOf: [
+                              {
+                                properties: {
+                                  created_at: {
+                                    description:
+                                      'Date and time at which Seam created the error.',
+                                    format: 'date-time',
+                                    type: 'string',
+                                  },
+                                  error_code: {
+                                    description:
+                                      'Unique identifier of the type of error. Enables quick recognition and categorization of the issue.',
+                                    enum: [
+                                      'cannot_create_requested_access_methods',
+                                    ],
+                                    type: 'string',
+                                  },
+                                  message: {
+                                    description:
+                                      'Detailed description of the error. Provides insights into the issue and potentially how to rectify it.',
+                                    type: 'string',
+                                  },
+                                },
+                                required: [
+                                  'created_at',
+                                  'message',
+                                  'error_code',
+                                ],
+                                type: 'object',
+                              },
+                            ],
+                          },
+                          type: 'array',
+                        },
                         location_ids: {
                           deprecated: true,
                           items: { format: 'uuid', type: 'string' },
@@ -30298,6 +30371,7 @@ export default {
                         'starts_at',
                         'ends_at',
                         'warnings',
+                        'errors',
                       ],
                       type: 'object',
                       'x-draft': 'Early access.',
@@ -30389,6 +30463,45 @@ export default {
                           nullable: true,
                           type: 'string',
                         },
+                        errors: {
+                          description:
+                            'Errors associated with the [access grant](https://docs.seam.co/latest/capability-guides/access-grants).',
+                          items: {
+                            discriminator: { propertyName: 'error_code' },
+                            oneOf: [
+                              {
+                                properties: {
+                                  created_at: {
+                                    description:
+                                      'Date and time at which Seam created the error.',
+                                    format: 'date-time',
+                                    type: 'string',
+                                  },
+                                  error_code: {
+                                    description:
+                                      'Unique identifier of the type of error. Enables quick recognition and categorization of the issue.',
+                                    enum: [
+                                      'cannot_create_requested_access_methods',
+                                    ],
+                                    type: 'string',
+                                  },
+                                  message: {
+                                    description:
+                                      'Detailed description of the error. Provides insights into the issue and potentially how to rectify it.',
+                                    type: 'string',
+                                  },
+                                },
+                                required: [
+                                  'created_at',
+                                  'message',
+                                  'error_code',
+                                ],
+                                type: 'object',
+                              },
+                            ],
+                          },
+                          type: 'array',
+                        },
                         location_ids: {
                           deprecated: true,
                           items: { format: 'uuid', type: 'string' },
@@ -30531,6 +30644,7 @@ export default {
                         'starts_at',
                         'ends_at',
                         'warnings',
+                        'errors',
                       ],
                       type: 'object',
                       'x-draft': 'Early access.',
@@ -30647,6 +30761,45 @@ export default {
                             nullable: true,
                             type: 'string',
                           },
+                          errors: {
+                            description:
+                              'Errors associated with the [access grant](https://docs.seam.co/latest/capability-guides/access-grants).',
+                            items: {
+                              discriminator: { propertyName: 'error_code' },
+                              oneOf: [
+                                {
+                                  properties: {
+                                    created_at: {
+                                      description:
+                                        'Date and time at which Seam created the error.',
+                                      format: 'date-time',
+                                      type: 'string',
+                                    },
+                                    error_code: {
+                                      description:
+                                        'Unique identifier of the type of error. Enables quick recognition and categorization of the issue.',
+                                      enum: [
+                                        'cannot_create_requested_access_methods',
+                                      ],
+                                      type: 'string',
+                                    },
+                                    message: {
+                                      description:
+                                        'Detailed description of the error. Provides insights into the issue and potentially how to rectify it.',
+                                      type: 'string',
+                                    },
+                                  },
+                                  required: [
+                                    'created_at',
+                                    'message',
+                                    'error_code',
+                                  ],
+                                  type: 'object',
+                                },
+                              ],
+                            },
+                            type: 'array',
+                          },
                           location_ids: {
                             deprecated: true,
                             items: { format: 'uuid', type: 'string' },
@@ -30790,6 +30943,7 @@ export default {
                           'starts_at',
                           'ends_at',
                           'warnings',
+                          'errors',
                         ],
                         type: 'object',
                         'x-draft': 'Early access.',
@@ -30900,6 +31054,45 @@ export default {
                             nullable: true,
                             type: 'string',
                           },
+                          errors: {
+                            description:
+                              'Errors associated with the [access grant](https://docs.seam.co/latest/capability-guides/access-grants).',
+                            items: {
+                              discriminator: { propertyName: 'error_code' },
+                              oneOf: [
+                                {
+                                  properties: {
+                                    created_at: {
+                                      description:
+                                        'Date and time at which Seam created the error.',
+                                      format: 'date-time',
+                                      type: 'string',
+                                    },
+                                    error_code: {
+                                      description:
+                                        'Unique identifier of the type of error. Enables quick recognition and categorization of the issue.',
+                                      enum: [
+                                        'cannot_create_requested_access_methods',
+                                      ],
+                                      type: 'string',
+                                    },
+                                    message: {
+                                      description:
+                                        'Detailed description of the error. Provides insights into the issue and potentially how to rectify it.',
+                                      type: 'string',
+                                    },
+                                  },
+                                  required: [
+                                    'created_at',
+                                    'message',
+                                    'error_code',
+                                  ],
+                                  type: 'object',
+                                },
+                              ],
+                            },
+                            type: 'array',
+                          },
                           location_ids: {
                             deprecated: true,
                             items: { format: 'uuid', type: 'string' },
@@ -31043,6 +31236,7 @@ export default {
                           'starts_at',
                           'ends_at',
                           'warnings',
+                          'errors',
                         ],
                         type: 'object',
                         'x-draft': 'Early access.',
@@ -54937,6 +55131,61 @@ export 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: