@seamapi/types 1.382.0 → 1.384.0

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

@@ -30602,6 +30602,9 @@ export interface Routes {
                     /** Unique identifier of the type of error. Enables quick recognition and categorization of the issue. */
                     error_code: 'no_communication_from_bridge';
                 }>;
+                telemetry_token: string | null;
+                telemetry_token_expires_at: string | null;
+                telemetry_url: string | null;
             };
         };
     };
@@ -30646,6 +30649,56 @@ export interface Routes {
                     /** Unique identifier of the type of error. Enables quick recognition and categorization of the issue. */
                     error_code: 'no_communication_from_bridge';
                 }>;
+                telemetry_token: string | null;
+                telemetry_token_expires_at: string | null;
+                telemetry_url: string | null;
+            };
+        };
+    };
+    '/seam/bridge/v1/bridge_client_sessions/refresh_telemetry_token': {
+        route: '/seam/bridge/v1/bridge_client_sessions/refresh_telemetry_token';
+        method: 'POST';
+        queryParams: {};
+        jsonBody: {};
+        commonParams: {};
+        formData: {};
+        jsonResponse: {
+            /**  */
+            bridge_client_session: {
+                created_at: string;
+                bridge_client_session_id: string;
+                bridge_client_session_token: string;
+                pairing_code: string;
+                pairing_code_expires_at: string;
+                tailscale_hostname: string;
+                tailscale_auth_key: string | null;
+                bridge_client_name: string;
+                bridge_client_time_zone: string;
+                bridge_client_machine_identifier_key: string;
+                errors: Array<{
+                    message: string;
+                    created_at: string;
+                    /** Unique identifier of the type of error. Enables quick recognition and categorization of the issue. */
+                    error_code: 'bridge_lan_unreachable';
+                    /** Seam cannot reach the tailscale proxy */
+                    is_tailscale_proxy_reachable: boolean | null;
+                    /** Tailscale proxy's SOCKS server is unhealthy */
+                    is_tailscale_proxy_socks_server_healthy: boolean | null;
+                    /** Tailscale proxy cannot reach the Tailscale network */
+                    can_tailscale_proxy_reach_tailscale_network: boolean | null;
+                    /** Tailscale proxy cannot reach the bridge */
+                    can_tailscale_proxy_reach_bridge: boolean | null;
+                    /** Bridge's SOCKS server is unhealthy */
+                    is_bridge_socks_server_healthy: boolean | null;
+                } | {
+                    message: string;
+                    created_at: string;
+                    /** Unique identifier of the type of error. Enables quick recognition and categorization of the issue. */
+                    error_code: 'no_communication_from_bridge';
+                }>;
+                telemetry_token: string | null;
+                telemetry_token_expires_at: string | null;
+                telemetry_url: string | null;
             };
         };
     };
@@ -30690,6 +30743,9 @@ export interface Routes {
                     /** Unique identifier of the type of error. Enables quick recognition and categorization of the issue. */
                     error_code: 'no_communication_from_bridge';
                 }>;
+                telemetry_token: string | null;
+                telemetry_token_expires_at: string | null;
+                telemetry_url: string | null;
             };
         };
     };
@@ -40529,6 +40585,29 @@ export interface Routes {
             }>;
         };
     };
+    '/user_identities/generate_instant_key': {
+        route: '/user_identities/generate_instant_key';
+        method: 'POST';
+        queryParams: {};
+        jsonBody: {};
+        commonParams: {
+            /** ID of the user identity for which you want to generate an instant key. */
+            user_identity_id: string;
+        };
+        formData: {};
+        jsonResponse: {
+            /**  */
+            instant_key: {
+                instant_key_id: string;
+                workspace_id: string;
+                created_at: string;
+                instant_key_url: string;
+                client_session_id: string;
+                user_identity_id: string;
+                expires_at: string;
+            };
+        };
+    };
     '/user_identities/get': {
         route: '/user_identities/get';
         method: 'GET' | 'POST';

package/lib/seam/connect/schemas.d.ts

@@ -1 +1 @@
-export { access_code, acs_access_group, acs_credential, acs_encoder, acs_entrance, acs_system, acs_user, action_attempt, bridge, bridge_client_session, client_session, common_failed_action_attempt, common_pending_action_attempt, common_succeeded_action_attempt, connect_webview, connected_account, custom_metadata, device, device_provider, noise_threshold, pagination, seam_event, thermostat_schedule, unmanaged_access_code, unmanaged_acs_access_group, unmanaged_acs_credential, unmanaged_acs_user, unmanaged_device, user_identity, webhook, workspace, } from './models/index.js';
+export { access_code, acs_access_group, acs_credential, acs_encoder, acs_entrance, acs_system, acs_user, action_attempt, bridge, bridge_client_session, client_session, common_failed_action_attempt, common_pending_action_attempt, common_succeeded_action_attempt, connect_webview, connected_account, custom_metadata, device, device_provider, instant_key, noise_threshold, pagination, seam_event, thermostat_schedule, unmanaged_access_code, unmanaged_acs_access_group, unmanaged_acs_credential, unmanaged_acs_user, unmanaged_device, user_identity, webhook, workspace, } from './models/index.js';

package/lib/seam/connect/schemas.js

@@ -1,2 +1,2 @@
-export { access_code, acs_access_group, acs_credential, acs_encoder, acs_entrance, acs_system, acs_user, action_attempt, bridge, bridge_client_session, client_session, common_failed_action_attempt, common_pending_action_attempt, common_succeeded_action_attempt, connect_webview, connected_account, custom_metadata, device, device_provider, noise_threshold, pagination, seam_event, thermostat_schedule, unmanaged_access_code, unmanaged_acs_access_group, unmanaged_acs_credential, unmanaged_acs_user, unmanaged_device, user_identity, webhook, workspace, } from './models/index.js';
+export { access_code, acs_access_group, acs_credential, acs_encoder, acs_entrance, acs_system, acs_user, action_attempt, bridge, bridge_client_session, client_session, common_failed_action_attempt, common_pending_action_attempt, common_succeeded_action_attempt, connect_webview, connected_account, custom_metadata, device, device_provider, instant_key, noise_threshold, pagination, seam_event, thermostat_schedule, unmanaged_access_code, unmanaged_acs_access_group, unmanaged_acs_credential, unmanaged_acs_user, unmanaged_device, user_identity, webhook, workspace, } from './models/index.js';
 //# sourceMappingURL=schemas.js.map

package/lib/seam/connect/schemas.js.map

@@ -1 +1 @@
-{"version":3,"file":"schemas.js","sourceRoot":"","sources":["../../../src/lib/seam/connect/schemas.ts"],"names":[],"mappings":"AAAA,OAAO,EACL,WAAW,EACX,gBAAgB,EAChB,cAAc,EACd,WAAW,EACX,YAAY,EACZ,UAAU,EACV,QAAQ,EACR,cAAc,EACd,MAAM,EACN,qBAAqB,EACrB,cAAc,EACd,4BAA4B,EAC5B,6BAA6B,EAC7B,+BAA+B,EAC/B,eAAe,EACf,iBAAiB,EACjB,eAAe,EACf,MAAM,EACN,eAAe,EACf,eAAe,EACf,UAAU,EACV,UAAU,EACV,mBAAmB,EACnB,qBAAqB,EACrB,0BAA0B,EAC1B,wBAAwB,EACxB,kBAAkB,EAClB,gBAAgB,EAChB,aAAa,EACb,OAAO,EACP,SAAS,GACV,MAAM,mBAAmB,CAAA"}
+{"version":3,"file":"schemas.js","sourceRoot":"","sources":["../../../src/lib/seam/connect/schemas.ts"],"names":[],"mappings":"AAAA,OAAO,EACL,WAAW,EACX,gBAAgB,EAChB,cAAc,EACd,WAAW,EACX,YAAY,EACZ,UAAU,EACV,QAAQ,EACR,cAAc,EACd,MAAM,EACN,qBAAqB,EACrB,cAAc,EACd,4BAA4B,EAC5B,6BAA6B,EAC7B,+BAA+B,EAC/B,eAAe,EACf,iBAAiB,EACjB,eAAe,EACf,MAAM,EACN,eAAe,EACf,WAAW,EACX,eAAe,EACf,UAAU,EACV,UAAU,EACV,mBAAmB,EACnB,qBAAqB,EACrB,0BAA0B,EAC1B,wBAAwB,EACxB,kBAAkB,EAClB,gBAAgB,EAChB,aAAa,EACb,OAAO,EACP,SAAS,GACV,MAAM,mBAAmB,CAAA"}

package/package.json

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

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

@@ -38,6 +38,7 @@ export {
   seam_event_type as event_type,
   fan_mode_setting,
   geolocation,
+  instant_key,
   location,
   lock_device_type,
   access_code as managed_access_code,

package/src/lib/seam/connect/model-types.ts

@@ -18,6 +18,7 @@ export type {
   DeviceError,
   DeviceProvider,
   DeviceWarning,
+  InstantKey,
   NoiseThreshold,
   SeamEvent,
   SeamEventType,

package/src/lib/seam/connect/models/bridges/bridge-client-session.ts

@@ -78,6 +78,9 @@ export const bridge_client_session = z.object({
   bridge_client_time_zone: z.string(),
   bridge_client_machine_identifier_key: z.string(),
   errors: z.array(bridge_client_session_error),
+  telemetry_token: z.string().nullable(),
+  telemetry_token_expires_at: z.string().datetime().nullable(),
+  telemetry_url: z.string().nullable(),
 }).describe(`
   ---
   route_path: /seam/bridge/v1/bridge_client_sessions

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

@@ -10,6 +10,7 @@ export * from './connected-accounts/index.js'
 export * from './custom-metadata.js'
 export * from './devices/index.js'
 export * from './events/index.js'
+export * from './instant-keys/index.js'
 export * from './locations/index.js'
 export * from './noise-sensors/index.js'
 export * from './pagination.js'

package/src/lib/seam/connect/models/instant-keys/index.ts

@@ -0,0 +1 @@
+export * from './instant-key.js'

package/src/lib/seam/connect/models/instant-keys/instant-key.ts

@@ -0,0 +1,18 @@
+import { z } from 'zod'
+
+export const instant_key = z.object({
+  instant_key_id: z.string().uuid(),
+  workspace_id: z.string().uuid(),
+  created_at: z.string().datetime(),
+  instant_key_url: z.string().url(),
+  client_session_id: z.string().uuid(),
+  user_identity_id: z.string().uuid(),
+  expires_at: z.string().datetime(),
+}).describe(`
+  ---
+  route_path: /user_identities
+  undocumented: Unreleased.
+  ---
+`)
+
+export type InstantKey = z.infer<typeof instant_key>

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

@@ -13659,6 +13659,29 @@ export default {
         ],
         'x-route-path': '/events',
       },
+      instant_key: {
+        properties: {
+          client_session_id: { format: 'uuid', type: 'string' },
+          created_at: { format: 'date-time', type: 'string' },
+          expires_at: { format: 'date-time', type: 'string' },
+          instant_key_id: { format: 'uuid', type: 'string' },
+          instant_key_url: { format: 'uri', type: 'string' },
+          user_identity_id: { format: 'uuid', type: 'string' },
+          workspace_id: { format: 'uuid', type: 'string' },
+        },
+        required: [
+          'instant_key_id',
+          'workspace_id',
+          'created_at',
+          'instant_key_url',
+          'client_session_id',
+          'user_identity_id',
+          'expires_at',
+        ],
+        type: 'object',
+        'x-route-path': '/user_identities',
+        'x-undocumented': 'Unreleased.',
+      },
       network: {
         properties: {
           created_at: { format: 'date-time', type: 'string' },
@@ -27312,6 +27335,13 @@ export default {
                         },
                         tailscale_auth_key: { nullable: true, type: 'string' },
                         tailscale_hostname: { type: 'string' },
+                        telemetry_token: { nullable: true, type: 'string' },
+                        telemetry_token_expires_at: {
+                          format: 'date-time',
+                          nullable: true,
+                          type: 'string',
+                        },
+                        telemetry_url: { nullable: true, type: 'string' },
                       },
                       required: [
                         'created_at',
@@ -27325,6 +27355,9 @@ export default {
                         'bridge_client_time_zone',
                         'bridge_client_machine_identifier_key',
                         'errors',
+                        'telemetry_token',
+                        'telemetry_token_expires_at',
+                        'telemetry_url',
                       ],
                       type: 'object',
                       'x-route-path': '/seam/bridge/v1/bridge_client_sessions',
@@ -27484,6 +27517,13 @@ export default {
                         },
                         tailscale_auth_key: { nullable: true, type: 'string' },
                         tailscale_hostname: { type: 'string' },
+                        telemetry_token: { nullable: true, type: 'string' },
+                        telemetry_token_expires_at: {
+                          format: 'date-time',
+                          nullable: true,
+                          type: 'string',
+                        },
+                        telemetry_url: { nullable: true, type: 'string' },
                       },
                       required: [
                         'created_at',
@@ -27497,6 +27537,9 @@ export default {
                         'bridge_client_time_zone',
                         'bridge_client_machine_identifier_key',
                         'errors',
+                        'telemetry_token',
+                        'telemetry_token_expires_at',
+                        'telemetry_url',
                       ],
                       type: 'object',
                       'x-route-path': '/seam/bridge/v1/bridge_client_sessions',
@@ -27647,6 +27690,13 @@ export default {
                         },
                         tailscale_auth_key: { nullable: true, type: 'string' },
                         tailscale_hostname: { type: 'string' },
+                        telemetry_token: { nullable: true, type: 'string' },
+                        telemetry_token_expires_at: {
+                          format: 'date-time',
+                          nullable: true,
+                          type: 'string',
+                        },
+                        telemetry_url: { nullable: true, type: 'string' },
                       },
                       required: [
                         'created_at',
@@ -27660,6 +27710,9 @@ export default {
                         'bridge_client_time_zone',
                         'bridge_client_machine_identifier_key',
                         'errors',
+                        'telemetry_token',
+                        'telemetry_token_expires_at',
+                        'telemetry_url',
                       ],
                       type: 'object',
                       'x-route-path': '/seam/bridge/v1/bridge_client_sessions',
@@ -27693,6 +27746,190 @@ export default {
         'x-undocumented': 'Seam Bridge Client only.',
       },
     },
+    '/seam/bridge/v1/bridge_client_sessions/refresh_telemetry_token': {
+      post: {
+        description:
+          'Returns the bridge client session associated with the session token and refreshed telemetry token.',
+        operationId:
+          'seamBridgeV1BridgeClientSessionsRefreshTelemetryTokenPost',
+        responses: {
+          200: {
+            content: {
+              'application/json': {
+                schema: {
+                  properties: {
+                    bridge_client_session: {
+                      properties: {
+                        bridge_client_machine_identifier_key: {
+                          type: 'string',
+                        },
+                        bridge_client_name: { type: 'string' },
+                        bridge_client_session_id: {
+                          format: 'uuid',
+                          type: 'string',
+                        },
+                        bridge_client_session_token: { type: 'string' },
+                        bridge_client_time_zone: { type: 'string' },
+                        created_at: { format: 'date-time', type: 'string' },
+                        errors: {
+                          items: {
+                            description:
+                              'Error associated with the `bridge_client_session`.',
+                            discriminator: { propertyName: 'error_code' },
+                            oneOf: [
+                              {
+                                description:
+                                  "Seam cannot reach the bridge's LAN",
+                                properties: {
+                                  can_tailscale_proxy_reach_bridge: {
+                                    description:
+                                      'Tailscale proxy cannot reach the bridge',
+                                    nullable: true,
+                                    type: 'boolean',
+                                  },
+                                  can_tailscale_proxy_reach_tailscale_network: {
+                                    description:
+                                      'Tailscale proxy cannot reach the Tailscale network',
+                                    nullable: true,
+                                    type: 'boolean',
+                                  },
+                                  created_at: {
+                                    format: 'date-time',
+                                    type: 'string',
+                                  },
+                                  error_code: {
+                                    description:
+                                      'Unique identifier of the type of error. Enables quick recognition and categorization of the issue.',
+                                    enum: ['bridge_lan_unreachable'],
+                                    type: 'string',
+                                  },
+                                  is_bridge_socks_server_healthy: {
+                                    description:
+                                      "Bridge's SOCKS server is unhealthy",
+                                    nullable: true,
+                                    type: 'boolean',
+                                  },
+                                  is_tailscale_proxy_reachable: {
+                                    description:
+                                      'Seam cannot reach the tailscale proxy',
+                                    nullable: true,
+                                    type: 'boolean',
+                                  },
+                                  is_tailscale_proxy_socks_server_healthy: {
+                                    description:
+                                      "Tailscale proxy's SOCKS server is unhealthy",
+                                    nullable: true,
+                                    type: 'boolean',
+                                  },
+                                  message: { type: 'string' },
+                                },
+                                required: [
+                                  'message',
+                                  'created_at',
+                                  'error_code',
+                                  'is_tailscale_proxy_reachable',
+                                  'is_tailscale_proxy_socks_server_healthy',
+                                  'can_tailscale_proxy_reach_tailscale_network',
+                                  'can_tailscale_proxy_reach_bridge',
+                                  'is_bridge_socks_server_healthy',
+                                ],
+                                type: 'object',
+                              },
+                              {
+                                description:
+                                  'Bridge has stopped communicating with Seam',
+                                properties: {
+                                  created_at: {
+                                    format: 'date-time',
+                                    type: 'string',
+                                  },
+                                  error_code: {
+                                    description:
+                                      'Unique identifier of the type of error. Enables quick recognition and categorization of the issue.',
+                                    enum: ['no_communication_from_bridge'],
+                                    type: 'string',
+                                  },
+                                  message: { type: 'string' },
+                                },
+                                required: [
+                                  'message',
+                                  'created_at',
+                                  'error_code',
+                                ],
+                                type: 'object',
+                              },
+                            ],
+                          },
+                          type: 'array',
+                        },
+                        pairing_code: {
+                          maxLength: 6,
+                          minLength: 6,
+                          type: 'string',
+                        },
+                        pairing_code_expires_at: {
+                          format: 'date-time',
+                          type: 'string',
+                        },
+                        tailscale_auth_key: { nullable: true, type: 'string' },
+                        tailscale_hostname: { type: 'string' },
+                        telemetry_token: { nullable: true, type: 'string' },
+                        telemetry_token_expires_at: {
+                          format: 'date-time',
+                          nullable: true,
+                          type: 'string',
+                        },
+                        telemetry_url: { nullable: true, type: 'string' },
+                      },
+                      required: [
+                        'created_at',
+                        'bridge_client_session_id',
+                        'bridge_client_session_token',
+                        'pairing_code',
+                        'pairing_code_expires_at',
+                        'tailscale_hostname',
+                        'tailscale_auth_key',
+                        'bridge_client_name',
+                        'bridge_client_time_zone',
+                        'bridge_client_machine_identifier_key',
+                        'errors',
+                        'telemetry_token',
+                        'telemetry_token_expires_at',
+                        'telemetry_url',
+                      ],
+                      type: 'object',
+                      'x-route-path': '/seam/bridge/v1/bridge_client_sessions',
+                      'x-undocumented': 'Seam Bridge Client only.',
+                    },
+                    ok: { type: 'boolean' },
+                  },
+                  required: ['bridge_client_session', 'ok'],
+                  type: 'object',
+                },
+              },
+            },
+            description: 'OK',
+          },
+          400: { description: 'Bad Request' },
+          401: { description: 'Unauthorized' },
+        },
+        security: [{ bridge_client_session: [] }],
+        summary:
+          '/seam/bridge/v1/bridge_client_sessions/refresh_telemetry_token',
+        tags: [],
+        'x-fern-sdk-group-name': [
+          'seam',
+          'bridge',
+          'v1',
+          'bridge_client_sessions',
+        ],
+        'x-fern-sdk-method-name': 'refresh_telemetry_token',
+        'x-fern-sdk-return-value': 'bridge_client_session',
+        'x-response-key': 'bridge_client_session',
+        'x-title': 'Refresh telemetry token for bridge client session',
+        'x-undocumented': 'Seam Bridge Client only.',
+      },
+    },
     '/seam/bridge/v1/bridge_client_sessions/regenerate_pairing_code': {
       post: {
         description:
@@ -27820,6 +28057,13 @@ export default {
                         },
                         tailscale_auth_key: { nullable: true, type: 'string' },
                         tailscale_hostname: { type: 'string' },
+                        telemetry_token: { nullable: true, type: 'string' },
+                        telemetry_token_expires_at: {
+                          format: 'date-time',
+                          nullable: true,
+                          type: 'string',
+                        },
+                        telemetry_url: { nullable: true, type: 'string' },
                       },
                       required: [
                         'created_at',
@@ -27833,6 +28077,9 @@ export default {
                         'bridge_client_time_zone',
                         'bridge_client_machine_identifier_key',
                         'errors',
+                        'telemetry_token',
+                        'telemetry_token_expires_at',
+                        'telemetry_url',
                       ],
                       type: 'object',
                       'x-route-path': '/seam/bridge/v1/bridge_client_sessions',
@@ -32133,6 +32380,62 @@ export default {
         'x-title': 'List Enrollment Automations',
       },
     },
+    '/user_identities/generate_instant_key': {
+      post: {
+        description:
+          'Generates a new [instant key](https://docs.seam.co/latest/capability-guides/mobile-access-in-development/instant-keys) for a specified [user identity](https://docs.seam.co/latest/capability-guides/mobile-access-in-development/managing-mobile-app-user-accounts-with-user-identities#what-is-a-user-identity).',
+        operationId: 'userIdentitiesGenerateInstantKeyPost',
+        requestBody: {
+          content: {
+            'application/json': {
+              schema: {
+                properties: {
+                  user_identity_id: {
+                    description:
+                      'ID of the user identity for which you want to generate an instant key.',
+                    format: 'uuid',
+                    type: 'string',
+                  },
+                },
+                required: ['user_identity_id'],
+                type: 'object',
+              },
+            },
+          },
+        },
+        responses: {
+          200: {
+            content: {
+              'application/json': {
+                schema: {
+                  properties: {
+                    instant_key: { $ref: '#/components/schemas/instant_key' },
+                    ok: { type: 'boolean' },
+                  },
+                  required: ['instant_key', 'ok'],
+                  type: 'object',
+                },
+              },
+            },
+            description: 'OK',
+          },
+          400: { description: 'Bad Request' },
+          401: { description: 'Unauthorized' },
+        },
+        security: [
+          { api_key: [] },
+          { pat_with_workspace: [] },
+          { console_session_with_workspace: [] },
+        ],
+        summary: '/user_identities/generate_instant_key',
+        tags: ['/user_identities'],
+        'x-fern-sdk-group-name': ['user_identities'],
+        'x-fern-sdk-method-name': 'generate_instant_key',
+        'x-fern-sdk-return-value': 'instant_key',
+        'x-response-key': 'instant_key',
+        'x-title': 'Generate an Instant Key',
+      },
+    },
     '/user_identities/get': {
       post: {
         description: