@seamapi/types 1.369.2 → 1.370.0

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

@@ -29277,6 +29277,26 @@ export interface Routes {
             };
         };
     };
+    '/seam/bridge/v1/bridge_connected_systems/list': {
+        route: '/seam/bridge/v1/bridge_connected_systems/list';
+        method: 'GET' | 'POST';
+        queryParams: {};
+        jsonBody: {};
+        commonParams: {};
+        formData: {};
+        jsonResponse: {
+            bridge_connected_systems: Array<{
+                bridge_id: string;
+                bridge_created_at: string;
+                connected_account_id: string;
+                connected_account_created_at: string;
+                acs_system_id: string;
+                acs_system_display_name: string;
+                workspace_id: string;
+                workspace_display_name: string;
+            }>;
+        };
+    };
     '/thermostats/activate_climate_preset': {
         route: '/thermostats/activate_climate_preset';
         method: 'POST';
@@ -38541,6 +38561,74 @@ export interface Routes {
         formData: {};
         jsonResponse: {};
     };
+    '/unstable_access_grants/create': {
+        route: '/unstable_access_grants/create';
+        method: 'POST';
+        queryParams: {};
+        jsonBody: {};
+        commonParams: ({
+            /** ID of user identity for whom access is being granted. */
+            user_identity_id?: string | undefined;
+        } | {
+            /** When used, creates a new user identity with the given details, and grants them access. */
+            user_identity?: {
+                /** Unique email address for the user identity. */
+                email_address?: (string | null) | undefined;
+                /** Unique phone number for the user identity in [E.164 format](https://www.itu.int/rec/T-REC-E.164/en) (for example, +15555550100). */
+                phone_number?: (string | null) | undefined;
+                full_name?: (string | null) | undefined;
+            } | undefined;
+        }) & {
+            /** Set of IDs of existing locations to which access is being granted. */
+            location_ids?: string[] | undefined;
+            /** When used, creates a new location with the given entrances and devices, and gives the user access to this location. */
+            location?: {
+                /** Set of IDs of the [entrances](https://docs.seam.co/latest/api/acs/systems/list) to add to the location to which access is being granted. */
+                acs_entrance_ids?: string[];
+                /** Set of IDs of the [devices](https://docs.seam.co/latest/api/devices/list) to add to the location to which access is being granted. */
+                device_ids?: string[];
+            } | undefined;
+            desired_access_methods: Array<{
+                /** Access method mode. Supported values: `code`, `card`, `mobile_key`. */
+                mode: 'code' | 'card' | 'mobile_key';
+            }>;
+            /** Date and time at which the validity of the new grant starts, in [ISO 8601](https://www.iso.org/iso-8601-date-and-time-format.html) format. */
+            starts_at?: string | undefined;
+            /** Date and time at which the validity of the new grant ends, in [ISO 8601](https://www.iso.org/iso-8601-date-and-time-format.html) format. Must be a time in the future and after `starts_at`. */
+            ends_at?: string | undefined;
+        };
+        formData: {};
+        jsonResponse: {
+            /**  */
+            access_grant: {
+                /** Unique identifier for the Seam workspace associated with the access grant. */
+                workspace_id: string;
+                /** ID of the access grant. */
+                access_grant_id: string;
+                /** ID of user identity to which access is being granted. */
+                user_identity_id: string;
+                /** IDs of the locations to which access is being given. */
+                location_ids: string[];
+                /** Access methods associated with this access grant. */
+                access_methods: Array<{
+                    /** Key for the access method - unique within an access grant. */
+                    access_method_key: string;
+                    /** Display name of the access method. */
+                    display_name: string;
+                    /** Access method mode. Supported values: `code`, `card`, `mobile_key`. */
+                    mode: 'code' | 'card' | 'mobile_key';
+                    /** Date and time at which the access method was created. */
+                    created_at: string;
+                    /** Date and time at which the access method was issued. */
+                    issued_at: string | null;
+                }>;
+                /** Display name of the access grant. */
+                display_name: string;
+                /** Date and time at which the access grant was created. */
+                created_at: string;
+            };
+        };
+    };
     '/unstable_locations/add_devices': {
         route: '/unstable_locations/add_devices';
         method: 'POST' | 'PUT';
@@ -40757,6 +40845,7 @@ export interface Routes {
             webview_primary_button_color?: string | undefined;
             webview_primary_button_text_color?: string | undefined;
             webview_logo_shape?: ('circle' | 'square') | undefined;
+            webview_success_message?: string | undefined;
         };
         commonParams: {};
         formData: {};

package/package.json

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

package/src/lib/seam/connect/internal/schemas.ts

@@ -1,5 +1,7 @@
 export {
   access_code_code_constraint,
+  access_grant,
+  access_method,
   acs_access_group,
   acs_access_group_external_type,
   acs_credential,
@@ -18,6 +20,7 @@ export {
   battery_status,
   bridge,
   bridge_client_session,
+  bridge_connected_system,
   capabilities,
   climate_preset,
   climate_setting,

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

@@ -0,0 +1,34 @@
+import { z } from 'zod'
+
+import { access_method } from './access-method.js'
+
+export const access_grant = z.object({
+  workspace_id: z
+    .string()
+    .uuid()
+    .describe(
+      'Unique identifier for the Seam workspace associated with the access grant.',
+    ),
+  access_grant_id: z.string().uuid().describe('ID of the access grant.'),
+  user_identity_id: z
+    .string()
+    .uuid()
+    .describe('ID of user identity to which access is being granted.'),
+  location_ids: z
+    .array(z.string().uuid())
+    .describe('IDs of the locations to which access is being given.'),
+  access_methods: z
+    .array(access_method)
+    .describe('Access methods associated with this access grant.'),
+  display_name: z.string().describe('Display name of the access grant.'),
+  created_at: z
+    .string()
+    .datetime()
+    .describe('Date and time at which the access grant was created.'),
+}).describe(`
+  ---
+  undocumented: Unreleased.
+  ---
+  `)
+
+export type AccessGrant = z.infer<typeof access_grant>

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

@@ -0,0 +1,28 @@
+import { z } from 'zod'
+
+export const access_method = z.object({
+  access_method_key: z
+    .string()
+    .describe('Key for the access method - unique within an access grant.'),
+  display_name: z.string().describe('Display name of the access method.'),
+  mode: z
+    .enum(['code', 'card', 'mobile_key'])
+    .describe(
+      'Access method mode. Supported values: `code`, `card`, `mobile_key`.',
+    ),
+  created_at: z
+    .string()
+    .datetime()
+    .describe('Date and time at which the access method was created.'),
+  issued_at: z
+    .string()
+    .datetime()
+    .nullable()
+    .describe('Date and time at which the access method was issued.'),
+}).describe(`
+  ---
+  undocumented: Unreleased.
+  ---
+  `)
+
+export type AccessMethod = z.infer<typeof access_method>

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

@@ -0,0 +1,2 @@
+export * from './access-grant.js'
+export * from './access-method.js'

package/src/lib/seam/connect/models/bridges/bridge-connected-system.ts

@@ -0,0 +1,19 @@
+import { z } from 'zod'
+
+export const bridge_connected_system = z.object({
+  bridge_id: z.string().uuid(),
+  bridge_created_at: z.string().datetime(),
+  connected_account_id: z.string().uuid(),
+  connected_account_created_at: z.string().datetime(),
+  acs_system_id: z.string().uuid(),
+  acs_system_display_name: z.string(),
+  workspace_id: z.string().uuid(),
+  workspace_display_name: z.string(),
+}).describe(`
+  ---
+  route_path: /seam/bridge/v1/bridge_connected_systems
+  undocumented: Seam Bridge Client only.
+  ---
+`)
+
+export type BridgeConnectedSystem = z.infer<typeof bridge_connected_system>

package/src/lib/seam/connect/models/bridges/index.ts

@@ -1,2 +1,3 @@
 export * from './bridge.js'
-export * from './bridge_client_session.js'
+export * from './bridge-client-session.js'
+export * from './bridge-connected-system.js'

package/src/lib/seam/connect/models/index.ts

@@ -1,4 +1,5 @@
 export * from './access-codes/index.js'
+export * from './access-grants/index.js'
 export * from './acs/index.js'
 export * from './action-attempts/index.js'
 export * from './bridges/index.js'

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

@@ -26200,6 +26200,151 @@ export default {
         'x-undocumented': 'Seam Bridge Client only.',
       },
     },
+    '/seam/bridge/v1/bridge_connected_systems/list': {
+      get: {
+        description:
+          'Returns the bridge connected systems associated with the session token used.',
+        operationId: 'seamBridgeV1BridgeConnectedSystemsListGet',
+        responses: {
+          200: {
+            content: {
+              'application/json': {
+                schema: {
+                  properties: {
+                    bridge_connected_systems: {
+                      items: {
+                        properties: {
+                          acs_system_display_name: { type: 'string' },
+                          acs_system_id: { format: 'uuid', type: 'string' },
+                          bridge_created_at: {
+                            format: 'date-time',
+                            type: 'string',
+                          },
+                          bridge_id: { format: 'uuid', type: 'string' },
+                          connected_account_created_at: {
+                            format: 'date-time',
+                            type: 'string',
+                          },
+                          connected_account_id: {
+                            format: 'uuid',
+                            type: 'string',
+                          },
+                          workspace_display_name: { type: 'string' },
+                          workspace_id: { format: 'uuid', type: 'string' },
+                        },
+                        required: [
+                          'bridge_id',
+                          'bridge_created_at',
+                          'connected_account_id',
+                          'connected_account_created_at',
+                          'acs_system_id',
+                          'acs_system_display_name',
+                          'workspace_id',
+                          'workspace_display_name',
+                        ],
+                        type: 'object',
+                        'x-route-path':
+                          '/seam/bridge/v1/bridge_connected_systems',
+                        'x-undocumented': 'Seam Bridge Client only.',
+                      },
+                      type: 'array',
+                    },
+                    ok: { type: 'boolean' },
+                  },
+                  required: ['bridge_connected_systems', 'ok'],
+                  type: 'object',
+                },
+              },
+            },
+            description: 'OK',
+          },
+          400: { description: 'Bad Request' },
+          401: { description: 'Unauthorized' },
+        },
+        security: [{ bridge_client_session: [] }],
+        summary: '/seam/bridge/v1/bridge_connected_systems/list',
+        tags: [],
+        'x-fern-ignore': true,
+        'x-response-key': 'bridge_connected_systems',
+        'x-title': 'List Bridge Connected Systems',
+        'x-undocumented': 'Seam Bridge Client only.',
+      },
+      post: {
+        description:
+          'Returns the bridge connected systems associated with the session token used.',
+        operationId: 'seamBridgeV1BridgeConnectedSystemsListPost',
+        responses: {
+          200: {
+            content: {
+              'application/json': {
+                schema: {
+                  properties: {
+                    bridge_connected_systems: {
+                      items: {
+                        properties: {
+                          acs_system_display_name: { type: 'string' },
+                          acs_system_id: { format: 'uuid', type: 'string' },
+                          bridge_created_at: {
+                            format: 'date-time',
+                            type: 'string',
+                          },
+                          bridge_id: { format: 'uuid', type: 'string' },
+                          connected_account_created_at: {
+                            format: 'date-time',
+                            type: 'string',
+                          },
+                          connected_account_id: {
+                            format: 'uuid',
+                            type: 'string',
+                          },
+                          workspace_display_name: { type: 'string' },
+                          workspace_id: { format: 'uuid', type: 'string' },
+                        },
+                        required: [
+                          'bridge_id',
+                          'bridge_created_at',
+                          'connected_account_id',
+                          'connected_account_created_at',
+                          'acs_system_id',
+                          'acs_system_display_name',
+                          'workspace_id',
+                          'workspace_display_name',
+                        ],
+                        type: 'object',
+                        'x-route-path':
+                          '/seam/bridge/v1/bridge_connected_systems',
+                        'x-undocumented': 'Seam Bridge Client only.',
+                      },
+                      type: 'array',
+                    },
+                    ok: { type: 'boolean' },
+                  },
+                  required: ['bridge_connected_systems', 'ok'],
+                  type: 'object',
+                },
+              },
+            },
+            description: 'OK',
+          },
+          400: { description: 'Bad Request' },
+          401: { description: 'Unauthorized' },
+        },
+        security: [{ bridge_client_session: [] }],
+        summary: '/seam/bridge/v1/bridge_connected_systems/list',
+        tags: [],
+        'x-fern-sdk-group-name': [
+          'seam',
+          'bridge',
+          'v1',
+          'bridge_connected_systems',
+        ],
+        'x-fern-sdk-method-name': 'list',
+        'x-fern-sdk-return-value': 'bridge_connected_systems',
+        'x-response-key': 'bridge_connected_systems',
+        'x-title': 'List Bridge Connected Systems',
+        'x-undocumented': 'Seam Bridge Client only.',
+      },
+    },
     '/thermostats/activate_climate_preset': {
       post: {
         description:
@@ -28426,6 +28571,254 @@ export default {
         'x-title': 'Update a Climate Preset',
       },
     },
+    '/unstable_access_grants/create': {
+      post: {
+        description: 'Creates a new access grant.',
+        operationId: 'unstableAccessGrantsCreatePost',
+        requestBody: {
+          content: {
+            'application/json': {
+              schema: {
+                allOf: [
+                  {
+                    oneOf: [
+                      {
+                        properties: {
+                          user_identity_id: {
+                            description:
+                              'ID of user identity for whom access is being granted.',
+                            format: 'uuid',
+                            type: 'string',
+                          },
+                        },
+                        type: 'object',
+                      },
+                      {
+                        properties: {
+                          user_identity: {
+                            description:
+                              'When used, creates a new user identity with the given details, and grants them access.',
+                            properties: {
+                              email_address: {
+                                description:
+                                  'Unique email address for the user identity.',
+                                format: 'email',
+                                nullable: true,
+                                type: 'string',
+                              },
+                              full_name: {
+                                minLength: 1,
+                                nullable: true,
+                                type: 'string',
+                              },
+                              phone_number: {
+                                description:
+                                  'Unique phone number for the user identity in [E.164 format](https://www.itu.int/rec/T-REC-E.164/en) (for example, +15555550100).',
+                                nullable: true,
+                                type: 'string',
+                              },
+                            },
+                            type: 'object',
+                            'x-route-path': '/user_identities',
+                          },
+                        },
+                        type: 'object',
+                      },
+                    ],
+                  },
+                  {
+                    properties: {
+                      desired_access_methods: {
+                        items: {
+                          properties: {
+                            mode: {
+                              description:
+                                'Access method mode. Supported values: `code`, `card`, `mobile_key`.',
+                              enum: ['code', 'card', 'mobile_key'],
+                              type: 'string',
+                            },
+                          },
+                          required: ['mode'],
+                          type: 'object',
+                        },
+                        type: 'array',
+                      },
+                      ends_at: {
+                        description:
+                          'Date and time at which the validity of the new grant ends, in [ISO 8601](https://www.iso.org/iso-8601-date-and-time-format.html) format. Must be a time in the future and after `starts_at`.',
+                        format: 'date-time',
+                        type: 'string',
+                      },
+                      location: {
+                        description:
+                          'When used, creates a new location with the given entrances and devices, and gives the user access to this location.',
+                        properties: {
+                          acs_entrance_ids: {
+                            default: [],
+                            description:
+                              'Set of IDs of the [entrances](https://docs.seam.co/latest/api/acs/systems/list) to add to the location to which access is being granted.',
+                            items: { format: 'uuid', type: 'string' },
+                            type: 'array',
+                          },
+                          device_ids: {
+                            default: [],
+                            description:
+                              'Set of IDs of the [devices](https://docs.seam.co/latest/api/devices/list) to add to the location to which access is being granted.',
+                            items: { format: 'uuid', type: 'string' },
+                            type: 'array',
+                          },
+                        },
+                        type: 'object',
+                      },
+                      location_ids: {
+                        description:
+                          'Set of IDs of existing locations to which access is being granted.',
+                        items: { format: 'uuid', type: 'string' },
+                        type: 'array',
+                      },
+                      starts_at: {
+                        description:
+                          'Date and time at which the validity of the new grant starts, in [ISO 8601](https://www.iso.org/iso-8601-date-and-time-format.html) format.',
+                        format: 'date-time',
+                        type: 'string',
+                      },
+                    },
+                    required: ['desired_access_methods'],
+                    type: 'object',
+                  },
+                ],
+              },
+            },
+          },
+        },
+        responses: {
+          200: {
+            content: {
+              'application/json': {
+                schema: {
+                  properties: {
+                    access_grant: {
+                      properties: {
+                        access_grant_id: {
+                          description: 'ID of the access grant.',
+                          format: 'uuid',
+                          type: 'string',
+                        },
+                        access_methods: {
+                          description:
+                            'Access methods associated with this access grant.',
+                          items: {
+                            properties: {
+                              access_method_key: {
+                                description:
+                                  'Key for the access method - unique within an access grant.',
+                                type: 'string',
+                              },
+                              created_at: {
+                                description:
+                                  'Date and time at which the access method was created.',
+                                format: 'date-time',
+                                type: 'string',
+                              },
+                              display_name: {
+                                description:
+                                  'Display name of the access method.',
+                                type: 'string',
+                              },
+                              issued_at: {
+                                description:
+                                  'Date and time at which the access method was issued.',
+                                format: 'date-time',
+                                nullable: true,
+                                type: 'string',
+                              },
+                              mode: {
+                                description:
+                                  'Access method mode. Supported values: `code`, `card`, `mobile_key`.',
+                                enum: ['code', 'card', 'mobile_key'],
+                                type: 'string',
+                              },
+                            },
+                            required: [
+                              'access_method_key',
+                              'display_name',
+                              'mode',
+                              'created_at',
+                              'issued_at',
+                            ],
+                            type: 'object',
+                            'x-undocumented': 'Unreleased.',
+                          },
+                          type: 'array',
+                        },
+                        created_at: {
+                          description:
+                            'Date and time at which the access grant was created.',
+                          format: 'date-time',
+                          type: 'string',
+                        },
+                        display_name: {
+                          description: 'Display name of the access grant.',
+                          type: 'string',
+                        },
+                        location_ids: {
+                          description:
+                            'IDs of the locations to which access is being given.',
+                          items: { format: 'uuid', type: 'string' },
+                          type: 'array',
+                        },
+                        user_identity_id: {
+                          description:
+                            'ID of user identity to which access is being granted.',
+                          format: 'uuid',
+                          type: 'string',
+                        },
+                        workspace_id: {
+                          description:
+                            'Unique identifier for the Seam workspace associated with the access grant.',
+                          format: 'uuid',
+                          type: 'string',
+                        },
+                      },
+                      required: [
+                        'workspace_id',
+                        'access_grant_id',
+                        'user_identity_id',
+                        'location_ids',
+                        'access_methods',
+                        'display_name',
+                        'created_at',
+                      ],
+                      type: 'object',
+                      'x-undocumented': 'Unreleased.',
+                    },
+                    ok: { type: 'boolean' },
+                  },
+                  required: ['access_grant', 'ok'],
+                  type: 'object',
+                },
+              },
+            },
+            description: 'OK',
+          },
+          400: { description: 'Bad Request' },
+          401: { description: 'Unauthorized' },
+        },
+        security: [
+          { pat_with_workspace: [] },
+          { console_session_with_workspace: [] },
+          { api_key: [] },
+        ],
+        summary: '/unstable_access_grants/create',
+        tags: [],
+        'x-fern-sdk-group-name': ['unstable_access_grants'],
+        'x-fern-sdk-method-name': 'create',
+        'x-fern-sdk-return-value': 'access_grant',
+        'x-response-key': 'access_grant',
+        'x-title': 'Create an Access Grant',
+        'x-undocumented': 'Unreleased.',
+      },
+    },
     '/unstable_locations/add_devices': {
       post: {
         description:
@@ -30725,6 +31118,7 @@ export default {
                   },
                   webview_primary_button_color: { type: 'string' },
                   webview_primary_button_text_color: { type: 'string' },
+                  webview_success_message: { type: 'string' },
                 },
                 required: ['name'],
                 type: 'object',