@seamapi/types 1.631.0 → 1.633.0

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

@@ -11399,6 +11399,13 @@ export type Routes = {
                         created_at: string;
                         /** Unique identifier of the type of warning. Enables quick recognition and categorization of the issue. */
                         warning_code: 'lockly_time_zone_not_configured';
+                    } | {
+                        /** Detailed description of the warning. Provides insights into the issue and potentially how to rectify it. */
+                        message: string;
+                        /** Date and time at which Seam created the warning. */
+                        created_at: string;
+                        /** Unique identifier of the type of warning. Enables quick recognition and categorization of the issue. */
+                        warning_code: 'hub_required_for_addtional_capabilities';
                     })[];
                     /** Date and time at which the device object was created. */
                     created_at: string;
@@ -14837,6 +14844,13 @@ export type Routes = {
                         created_at: string;
                         /** Unique identifier of the type of warning. Enables quick recognition and categorization of the issue. */
                         warning_code: 'lockly_time_zone_not_configured';
+                    } | {
+                        /** Detailed description of the warning. Provides insights into the issue and potentially how to rectify it. */
+                        message: string;
+                        /** Date and time at which Seam created the warning. */
+                        created_at: string;
+                        /** Unique identifier of the type of warning. Enables quick recognition and categorization of the issue. */
+                        warning_code: 'hub_required_for_addtional_capabilities';
                     })[];
                     /** Date and time at which the device object was created. */
                     created_at: string;
@@ -17456,6 +17470,13 @@ export type Routes = {
                         created_at: string;
                         /** Unique identifier of the type of warning. Enables quick recognition and categorization of the issue. */
                         warning_code: 'lockly_time_zone_not_configured';
+                    } | {
+                        /** Detailed description of the warning. Provides insights into the issue and potentially how to rectify it. */
+                        message: string;
+                        /** Date and time at which Seam created the warning. */
+                        created_at: string;
+                        /** Unique identifier of the type of warning. Enables quick recognition and categorization of the issue. */
+                        warning_code: 'hub_required_for_addtional_capabilities';
                     })[];
                     /** Date and time at which the device object was created. */
                     created_at: string;
@@ -33734,6 +33755,13 @@ export type Routes = {
                     created_at: string;
                     /** Unique identifier of the type of warning. Enables quick recognition and categorization of the issue. */
                     warning_code: 'lockly_time_zone_not_configured';
+                } | {
+                    /** Detailed description of the warning. Provides insights into the issue and potentially how to rectify it. */
+                    message: string;
+                    /** Date and time at which Seam created the warning. */
+                    created_at: string;
+                    /** Unique identifier of the type of warning. Enables quick recognition and categorization of the issue. */
+                    warning_code: 'hub_required_for_addtional_capabilities';
                 })[];
                 /** Date and time at which the device object was created. */
                 created_at: string;
@@ -34997,6 +35025,13 @@ export type Routes = {
                     created_at: string;
                     /** Unique identifier of the type of warning. Enables quick recognition and categorization of the issue. */
                     warning_code: 'lockly_time_zone_not_configured';
+                } | {
+                    /** Detailed description of the warning. Provides insights into the issue and potentially how to rectify it. */
+                    message: string;
+                    /** Date and time at which Seam created the warning. */
+                    created_at: string;
+                    /** Unique identifier of the type of warning. Enables quick recognition and categorization of the issue. */
+                    warning_code: 'hub_required_for_addtional_capabilities';
                 })[];
                 /** Date and time at which the device object was created. */
                 created_at: string;
@@ -35446,6 +35481,13 @@ export type Routes = {
                     created_at: string;
                     /** Unique identifier of the type of warning. Enables quick recognition and categorization of the issue. */
                     warning_code: 'lockly_time_zone_not_configured';
+                } | {
+                    /** Detailed description of the warning. Provides insights into the issue and potentially how to rectify it. */
+                    message: string;
+                    /** Date and time at which Seam created the warning. */
+                    created_at: string;
+                    /** Unique identifier of the type of warning. Enables quick recognition and categorization of the issue. */
+                    warning_code: 'hub_required_for_addtional_capabilities';
                 })[];
                 /** Date and time at which the device object was created. */
                 created_at: string;
@@ -35879,6 +35921,13 @@ export type Routes = {
                     created_at: string;
                     /** Unique identifier of the type of warning. Enables quick recognition and categorization of the issue. */
                     warning_code: 'lockly_time_zone_not_configured';
+                } | {
+                    /** Detailed description of the warning. Provides insights into the issue and potentially how to rectify it. */
+                    message: string;
+                    /** Date and time at which Seam created the warning. */
+                    created_at: string;
+                    /** Unique identifier of the type of warning. Enables quick recognition and categorization of the issue. */
+                    warning_code: 'hub_required_for_addtional_capabilities';
                 })[];
                 /** Date and time at which the device object was created. */
                 created_at: string;
@@ -41219,6 +41268,13 @@ export type Routes = {
                     created_at: string;
                     /** Unique identifier of the type of warning. Enables quick recognition and categorization of the issue. */
                     warning_code: 'lockly_time_zone_not_configured';
+                } | {
+                    /** Detailed description of the warning. Provides insights into the issue and potentially how to rectify it. */
+                    message: string;
+                    /** Date and time at which Seam created the warning. */
+                    created_at: string;
+                    /** Unique identifier of the type of warning. Enables quick recognition and categorization of the issue. */
+                    warning_code: 'hub_required_for_addtional_capabilities';
                 })[];
                 /** Date and time at which the device object was created. */
                 created_at: string;
@@ -42433,6 +42489,13 @@ export type Routes = {
                     created_at: string;
                     /** Unique identifier of the type of warning. Enables quick recognition and categorization of the issue. */
                     warning_code: 'lockly_time_zone_not_configured';
+                } | {
+                    /** Detailed description of the warning. Provides insights into the issue and potentially how to rectify it. */
+                    message: string;
+                    /** Date and time at which Seam created the warning. */
+                    created_at: string;
+                    /** Unique identifier of the type of warning. Enables quick recognition and categorization of the issue. */
+                    warning_code: 'hub_required_for_addtional_capabilities';
                 })[];
                 /** Date and time at which the device object was created. */
                 created_at: string;
@@ -43696,6 +43759,13 @@ export type Routes = {
                     created_at: string;
                     /** Unique identifier of the type of warning. Enables quick recognition and categorization of the issue. */
                     warning_code: 'lockly_time_zone_not_configured';
+                } | {
+                    /** Detailed description of the warning. Provides insights into the issue and potentially how to rectify it. */
+                    message: string;
+                    /** Date and time at which Seam created the warning. */
+                    created_at: string;
+                    /** Unique identifier of the type of warning. Enables quick recognition and categorization of the issue. */
+                    warning_code: 'hub_required_for_addtional_capabilities';
                 })[];
                 /** Date and time at which the device object was created. */
                 created_at: string;
@@ -44909,6 +44979,13 @@ export type Routes = {
                     created_at: string;
                     /** Unique identifier of the type of warning. Enables quick recognition and categorization of the issue. */
                     warning_code: 'lockly_time_zone_not_configured';
+                } | {
+                    /** Detailed description of the warning. Provides insights into the issue and potentially how to rectify it. */
+                    message: string;
+                    /** Date and time at which Seam created the warning. */
+                    created_at: string;
+                    /** Unique identifier of the type of warning. Enables quick recognition and categorization of the issue. */
+                    warning_code: 'hub_required_for_addtional_capabilities';
                 })[];
                 /** Date and time at which the device object was created. */
                 created_at: string;
@@ -51250,6 +51327,13 @@ export type Routes = {
                     created_at: string;
                     /** Unique identifier of the type of warning. Enables quick recognition and categorization of the issue. */
                     warning_code: 'lockly_time_zone_not_configured';
+                } | {
+                    /** Detailed description of the warning. Provides insights into the issue and potentially how to rectify it. */
+                    message: string;
+                    /** Date and time at which Seam created the warning. */
+                    created_at: string;
+                    /** Unique identifier of the type of warning. Enables quick recognition and categorization of the issue. */
+                    warning_code: 'hub_required_for_addtional_capabilities';
                 })[];
                 /** Date and time at which the device object was created. */
                 created_at: string;
@@ -52463,6 +52547,13 @@ export type Routes = {
                     created_at: string;
                     /** Unique identifier of the type of warning. Enables quick recognition and categorization of the issue. */
                     warning_code: 'lockly_time_zone_not_configured';
+                } | {
+                    /** Detailed description of the warning. Provides insights into the issue and potentially how to rectify it. */
+                    message: string;
+                    /** Date and time at which Seam created the warning. */
+                    created_at: string;
+                    /** Unique identifier of the type of warning. Enables quick recognition and categorization of the issue. */
+                    warning_code: 'hub_required_for_addtional_capabilities';
                 })[];
                 /** Date and time at which the device object was created. */
                 created_at: string;
@@ -57078,6 +57169,73 @@ export type Routes = {
             };
         };
     };
+    '/seam/customer/v1/access_grants/list': {
+        route: '/seam/customer/v1/access_grants/list';
+        method: 'GET' | 'POST';
+        queryParams: {};
+        jsonBody: {};
+        commonParams: {};
+        formData: {};
+        jsonResponse: {
+            access_grants: {
+                /** ID of the Seam workspace associated with the Access Grant. */
+                workspace_id: string;
+                /** ID of the Access Grant. */
+                access_grant_id: string;
+                /** Unique key for the access grant within the workspace. */
+                access_grant_key?: string | undefined;
+                /** Reservation key for the access grant. */
+                reservation_key?: string | undefined;
+                /** ID of user identity to which the Access Grant gives access. */
+                user_identity_id: string;
+                /**
+                 * @deprecated Use `space_ids`.*/
+                location_ids: string[];
+                /** IDs of the spaces to which the Access Grant gives access. */
+                space_ids: string[];
+                /** Access methods that the user requested for the Access Grant. */
+                requested_access_methods: {
+                    /** Display name of the access method. */
+                    display_name: string;
+                    /** Access method mode. Supported values: `code`, `card`, `mobile_key`. */
+                    mode: 'code' | 'card' | 'mobile_key';
+                    /** Specific PIN code to use for this access method. Only applicable when mode is 'code'. */
+                    code?: string | undefined;
+                    /** Date and time at which the requested access method was added to the Access Grant. */
+                    created_at: string;
+                    /** IDs of the access methods created for the requested access method. */
+                    created_access_method_ids: string[];
+                }[];
+                /** IDs of the access methods created for the Access Grant. */
+                access_method_ids: string[];
+                /** Client Session Token. Only returned if the Access Grant has a mobile_key access method. */
+                client_session_token?: string | undefined;
+                /** Name of the Access Grant. If not provided, the display name will be computed. */
+                name: string | null;
+                /** Display name of the Access Grant. */
+                display_name: string;
+                /** Instant Key URL. Only returned if the Access Grant has a single mobile_key access_method.  */
+                instant_key_url?: string | undefined;
+                /** Date and time at which the Access Grant was created. */
+                created_at: string;
+                /** Date and time at which the Access Grant starts. */
+                starts_at: string;
+                /** Date and time at which the Access Grant ends. */
+                ends_at: string | null;
+                /** Warnings associated with the [access grant](https://docs.seam.co/latest/capability-guides/access-grants). */
+                warnings: {
+                    /** Date and time at which Seam created the warning. */
+                    created_at: string;
+                    /** Detailed description of the warning. Provides insights into the issue and potentially how to rectify it. */
+                    message: string;
+                    /** Unique identifier of the type of warning. Enables quick recognition and categorization of the issue. */
+                    warning_code: 'being_deleted';
+                }[];
+                /** ID of the customization profile associated with the Access Grant. */
+                customization_profile_id?: string | undefined;
+            }[];
+        };
+    };
     '/seam/customer/v1/automation_runs/list': {
         route: '/seam/customer/v1/automation_runs/list';
         method: 'GET' | 'POST';
@@ -61703,6 +61861,13 @@ export type Routes = {
                         created_at: string;
                         /** Unique identifier of the type of warning. Enables quick recognition and categorization of the issue. */
                         warning_code: 'lockly_time_zone_not_configured';
+                    } | {
+                        /** Detailed description of the warning. Provides insights into the issue and potentially how to rectify it. */
+                        message: string;
+                        /** Date and time at which Seam created the warning. */
+                        created_at: string;
+                        /** Unique identifier of the type of warning. Enables quick recognition and categorization of the issue. */
+                        warning_code: 'hub_required_for_addtional_capabilities';
                     })[];
                     /** Date and time at which the device object was created. */
                     created_at: string;
@@ -67348,6 +67513,13 @@ export type Routes = {
                     created_at: string;
                     /** Unique identifier of the type of warning. Enables quick recognition and categorization of the issue. */
                     warning_code: 'lockly_time_zone_not_configured';
+                } | {
+                    /** Detailed description of the warning. Provides insights into the issue and potentially how to rectify it. */
+                    message: string;
+                    /** Date and time at which Seam created the warning. */
+                    created_at: string;
+                    /** Unique identifier of the type of warning. Enables quick recognition and categorization of the issue. */
+                    warning_code: 'hub_required_for_addtional_capabilities';
                 })[];
                 /** Date and time at which the device object was created. */
                 created_at: string;
@@ -71163,6 +71335,13 @@ export type Routes = {
                     created_at: string;
                     /** Unique identifier of the type of warning. Enables quick recognition and categorization of the issue. */
                     warning_code: 'lockly_time_zone_not_configured';
+                } | {
+                    /** Detailed description of the warning. Provides insights into the issue and potentially how to rectify it. */
+                    message: string;
+                    /** Date and time at which Seam created the warning. */
+                    created_at: string;
+                    /** Unique identifier of the type of warning. Enables quick recognition and categorization of the issue. */
+                    warning_code: 'hub_required_for_addtional_capabilities';
                 })[];
                 /** Date and time at which the device object was created. */
                 created_at: string;
@@ -72376,6 +72555,13 @@ export type Routes = {
                     created_at: string;
                     /** Unique identifier of the type of warning. Enables quick recognition and categorization of the issue. */
                     warning_code: 'lockly_time_zone_not_configured';
+                } | {
+                    /** Detailed description of the warning. Provides insights into the issue and potentially how to rectify it. */
+                    message: string;
+                    /** Date and time at which Seam created the warning. */
+                    created_at: string;
+                    /** Unique identifier of the type of warning. Enables quick recognition and categorization of the issue. */
+                    warning_code: 'hub_required_for_addtional_capabilities';
                 })[];
                 /** Date and time at which the device object was created. */
                 created_at: string;
@@ -79587,6 +79773,13 @@ export type Routes = {
                     created_at: string;
                     /** Unique identifier of the type of warning. Enables quick recognition and categorization of the issue. */
                     warning_code: 'lockly_time_zone_not_configured';
+                } | {
+                    /** Detailed description of the warning. Provides insights into the issue and potentially how to rectify it. */
+                    message: string;
+                    /** Date and time at which Seam created the warning. */
+                    created_at: string;
+                    /** Unique identifier of the type of warning. Enables quick recognition and categorization of the issue. */
+                    warning_code: 'hub_required_for_addtional_capabilities';
                 })[];
                 /** Date and time at which the device object was created. */
                 created_at: string;
@@ -80802,6 +80995,13 @@ export type Routes = {
                     created_at: string;
                     /** Unique identifier of the type of warning. Enables quick recognition and categorization of the issue. */
                     warning_code: 'lockly_time_zone_not_configured';
+                } | {
+                    /** Detailed description of the warning. Provides insights into the issue and potentially how to rectify it. */
+                    message: string;
+                    /** Date and time at which Seam created the warning. */
+                    created_at: string;
+                    /** Unique identifier of the type of warning. Enables quick recognition and categorization of the issue. */
+                    warning_code: 'hub_required_for_addtional_capabilities';
                 })[];
                 /** Date and time at which the device object was created. */
                 created_at: string;
@@ -82948,6 +83148,13 @@ export type Routes = {
                         created_at: string;
                         /** Unique identifier of the type of warning. Enables quick recognition and categorization of the issue. */
                         warning_code: 'lockly_time_zone_not_configured';
+                    } | {
+                        /** Detailed description of the warning. Provides insights into the issue and potentially how to rectify it. */
+                        message: string;
+                        /** Date and time at which Seam created the warning. */
+                        created_at: string;
+                        /** Unique identifier of the type of warning. Enables quick recognition and categorization of the issue. */
+                        warning_code: 'hub_required_for_addtional_capabilities';
                     })[];
                     /** Date and time at which the device object was created. */
                     created_at: string;
@@ -85567,6 +85774,13 @@ export type Routes = {
                         created_at: string;
                         /** Unique identifier of the type of warning. Enables quick recognition and categorization of the issue. */
                         warning_code: 'lockly_time_zone_not_configured';
+                    } | {
+                        /** Detailed description of the warning. Provides insights into the issue and potentially how to rectify it. */
+                        message: string;
+                        /** Date and time at which Seam created the warning. */
+                        created_at: string;
+                        /** Unique identifier of the type of warning. Enables quick recognition and categorization of the issue. */
+                        warning_code: 'hub_required_for_addtional_capabilities';
                     })[];
                     /** Date and time at which the device object was created. */
                     created_at: string;

package/package.json

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

package/src/lib/seam/connect/models/devices/device.ts

@@ -420,6 +420,17 @@ export const unknown_issue_with_phone = common_device_warning.extend({
     Indicates that an unknown issue occurred while syncing the state of the phone with the provider. This issue may affect the proper functioning of the phone.
     `)
 
+const hub_required_for_addtional_capabilities = common_device_warning.extend({
+  warning_code: z
+    .literal('hub_required_for_addtional_capabilities')
+    .describe(warning_code_description),
+}).describe(`
+    ---
+    variant_group_key: locks
+    ---
+    Indicates that a hub or relay must be connected to unlock additional capabilities such as remote unlock.
+    `)
+
 const device_warning = z.discriminatedUnion('warning_code', [
   partial_backup_access_code_pool,
   many_active_backup_codes,
@@ -438,6 +449,7 @@ const device_warning = z.discriminatedUnion('warning_code', [
   salto_ks_subscription_limit_almost_reached,
   unknown_issue_with_phone,
   lockly_time_zone_not_configured,
+  hub_required_for_addtional_capabilities,
 ])
 
 export type DeviceWarning = z.infer<typeof device_warning>
@@ -482,6 +494,8 @@ const _device_warning_map = z.object({
   lockly_time_zone_not_configured: lockly_time_zone_not_configured
     .optional()
     .nullable(),
+  hub_required_for_addtional_capabilities:
+    hub_required_for_addtional_capabilities.optional().nullable(),
 })
 
 export type DeviceWarningMap = z.infer<typeof _device_warning_map>

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

@@ -13145,6 +13145,32 @@ export default {
                   required: ['message', 'created_at', 'warning_code'],
                   type: 'object',
                 },
+                {
+                  description:
+                    'Indicates that a hub or relay must be connected to unlock additional capabilities such as remote unlock.',
+                  properties: {
+                    created_at: {
+                      description:
+                        'Date and time at which Seam created the warning.',
+                      format: 'date-time',
+                      type: 'string',
+                    },
+                    message: {
+                      description:
+                        'Detailed description of the warning. Provides insights into the issue and potentially how to rectify it.',
+                      type: 'string',
+                    },
+                    warning_code: {
+                      description:
+                        'Unique identifier of the type of warning. Enables quick recognition and categorization of the issue.',
+                      enum: ['hub_required_for_addtional_capabilities'],
+                      type: 'string',
+                    },
+                  },
+                  required: ['message', 'created_at', 'warning_code'],
+                  type: 'object',
+                  'x-variant-group-key': 'locks',
+                },
               ],
             },
             type: 'array',
@@ -25620,6 +25646,32 @@ export default {
                   required: ['message', 'created_at', 'warning_code'],
                   type: 'object',
                 },
+                {
+                  description:
+                    'Indicates that a hub or relay must be connected to unlock additional capabilities such as remote unlock.',
+                  properties: {
+                    created_at: {
+                      description:
+                        'Date and time at which Seam created the warning.',
+                      format: 'date-time',
+                      type: 'string',
+                    },
+                    message: {
+                      description:
+                        'Detailed description of the warning. Provides insights into the issue and potentially how to rectify it.',
+                      type: 'string',
+                    },
+                    warning_code: {
+                      description:
+                        'Unique identifier of the type of warning. Enables quick recognition and categorization of the issue.',
+                      enum: ['hub_required_for_addtional_capabilities'],
+                      type: 'string',
+                    },
+                  },
+                  required: ['message', 'created_at', 'warning_code'],
+                  type: 'object',
+                  'x-variant-group-key': 'locks',
+                },
               ],
             },
             type: 'array',
@@ -31292,6 +31344,7 @@ export default {
           { pat_with_workspace: [] },
           { console_session_with_workspace: [] },
           { api_key: [] },
+          { client_session_with_customer: [] },
         ],
         summary: '/access_methods/get_related',
         tags: [],
@@ -31529,6 +31582,7 @@ export default {
           { pat_with_workspace: [] },
           { console_session_with_workspace: [] },
           { api_key: [] },
+          { client_session_with_customer: [] },
         ],
         summary: '/access_methods/get_related',
         tags: [],
@@ -51160,6 +51214,84 @@ export default {
         'x-undocumented': 'Internal endpoint for Console',
       },
     },
+    '/seam/customer/v1/access_grants/list': {
+      get: {
+        description: 'Gets an Access Grant.',
+        operationId: 'seamCustomerV1AccessGrantsListGet',
+        parameters: [],
+        responses: {
+          200: {
+            content: {
+              'application/json': {
+                schema: {
+                  properties: {
+                    access_grants: {
+                      items: { $ref: '#/components/schemas/access_grant' },
+                      type: 'array',
+                    },
+                    ok: { type: 'boolean' },
+                  },
+                  required: ['access_grants', 'ok'],
+                  type: 'object',
+                },
+              },
+            },
+            description: 'OK',
+          },
+          400: { description: 'Bad Request' },
+          401: { description: 'Unauthorized' },
+        },
+        security: [{ client_session_with_customer: [] }],
+        summary: '/seam/customer/v1/access_grants/list',
+        tags: [],
+        'x-fern-sdk-group-name': ['seam', 'customer', 'v1', 'access_grants'],
+        'x-fern-sdk-method-name': 'list',
+        'x-fern-sdk-return-value': 'access_grants',
+        'x-response-key': 'access_grants',
+        'x-title': 'List Access Grants (Other Access)',
+        'x-undocumented': 'Internal endpoint for customer portals.',
+      },
+      post: {
+        description: 'Gets an Access Grant.',
+        operationId: 'seamCustomerV1AccessGrantsListPost',
+        requestBody: {
+          content: {
+            'application/json': { schema: { properties: {}, type: 'object' } },
+          },
+        },
+        responses: {
+          200: {
+            content: {
+              'application/json': {
+                schema: {
+                  properties: {
+                    access_grants: {
+                      items: { $ref: '#/components/schemas/access_grant' },
+                      type: 'array',
+                    },
+                    ok: { type: 'boolean' },
+                  },
+                  required: ['access_grants', 'ok'],
+                  type: 'object',
+                },
+              },
+            },
+            description: 'OK',
+          },
+          400: { description: 'Bad Request' },
+          401: { description: 'Unauthorized' },
+        },
+        security: [{ client_session_with_customer: [] }],
+        summary: '/seam/customer/v1/access_grants/list',
+        tags: [],
+        'x-fern-sdk-group-name': ['seam', 'customer', 'v1', 'access_grants'],
+        'x-fern-sdk-method-name': 'list',
+        'x-fern-sdk-return-value': 'access_grants',
+        'x-response-key': 'access_grants',
+        'x-title': 'List Access Grants (Other Access)',
+        'x-undocumented': 'Internal endpoint for customer portals.',
+      },
+    },
     '/seam/customer/v1/automation_runs/list': {
       get: {
         description: