@seamapi/types 1.408.0 → 1.409.0

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

@@ -41992,6 +41992,7 @@ export interface Routes {
         commonParams: {};
         formData: {};
         jsonResponse: {
+            /**  */
             space: {
                 /** Unique identifier for the space. */
                 space_id: string;
@@ -42027,6 +42028,7 @@ export interface Routes {
         };
         formData: {};
         jsonResponse: {
+            /**  */
             space: {
                 /** Unique identifier for the space. */
                 space_id: string;
@@ -42098,6 +42100,7 @@ export interface Routes {
         commonParams: {};
         formData: {};
         jsonResponse: {
+            /**  */
             space: {
                 /** Unique identifier for the space. */
                 space_id: string;

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, instant_key, noise_threshold, pagination, seam_event, thermostat_daily_program, thermostat_schedule, thermostat_weekly_program, 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, building_block_type, 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, magic_link, noise_threshold, pagination, seam_event, thermostat_daily_program, thermostat_schedule, thermostat_weekly_program, 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, instant_key, noise_threshold, pagination, seam_event, thermostat_daily_program, thermostat_schedule, thermostat_weekly_program, 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, building_block_type, 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, magic_link, noise_threshold, pagination, seam_event, thermostat_daily_program, thermostat_schedule, thermostat_weekly_program, 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,WAAW,EACX,eAAe,EACf,UAAU,EACV,UAAU,EACV,wBAAwB,EACxB,mBAAmB,EACnB,yBAAyB,EACzB,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,mBAAmB,EACnB,cAAc,EACd,4BAA4B,EAC5B,6BAA6B,EAC7B,+BAA+B,EAC/B,eAAe,EACf,iBAAiB,EACjB,eAAe,EACf,MAAM,EACN,eAAe,EACf,WAAW,EACX,UAAU,EACV,eAAe,EACf,UAAU,EACV,UAAU,EACV,wBAAwB,EACxB,mBAAmB,EACnB,yBAAyB,EACzB,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.408.0",
+  "version": "1.409.0",
   "description": "TypeScript types for the Seam API.",
   "type": "module",
   "main": "index.js",

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

@@ -2,6 +2,8 @@ export type {
   AccessCode,
   AccessCodeError,
   AccessCodeWarning,
+  AccessGrant,
+  AccessMethod,
   AcsAccessGroup,
   AcsCredential,
   AcsEncoder,
@@ -10,6 +12,7 @@ export type {
   AcsUser,
   ActionAttempt,
   Bridge,
+  BuildingBlockType,
   ClientSession,
   ConnectedAccount,
   ConnectedAccountError,
@@ -21,9 +24,12 @@ export type {
   DeviceProvider,
   DeviceWarning,
   InstantKey,
+  MagicLink,
   NoiseThreshold,
+  Pagination,
   SeamEvent,
   SeamEventType,
+  Space,
   ThermostatSchedule,
   UnmanagedAccessCode,
   UnmanagedDevice,

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

@@ -37,7 +37,8 @@ export const access_grant = z.object({
     .describe('Date and time at which the access grant was created.'),
 }).describe(`
   ---
-  undocumented: Unreleased.
+  draft: Early access.
+  route_path: /access_grants
   ---
   `)
 

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

@@ -35,7 +35,8 @@ export const access_method = z.object({
     ),
 }).describe(`
   ---
-  undocumented: Unreleased.
+  draft: Early access.
+  route_path: /access_methods
   ---
   `)
 

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

@@ -18,10 +18,6 @@ export const requested_access_method = z.object({
     .describe(
       'IDs of the access methods that were created for this requested access method.',
     ),
-}).describe(`
-  ---
-  undocumented: Unreleased.
-  ---
-  `)
+})
 
 export type RequestedAccessMethod = z.infer<typeof requested_access_method>

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

@@ -21,3 +21,5 @@ export const pagination = z
       .describe('URL to get the next page of results.'),
   })
   .describe('Information about the current page of results.')
+
+export type Pagination = z.infer<typeof pagination>

package/src/lib/seam/connect/models/spaces/space.ts

@@ -14,6 +14,11 @@ export const space = z.object({
     .string()
     .datetime()
     .describe('Date and time at which the space object was created.'),
-})
+}).describe(`
+  ---
+  draft: Early access.
+  route_path: /spaces
+  ---
+  `)
 
 export type Space = z.infer<typeof space>

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

@@ -15979,17 +15979,6 @@ export default {
         'x-route-path': '/unstable_partner/building_blocks',
         'x-undocumented': 'Unreleased.',
       },
-      network: {
-        properties: {
-          created_at: { format: 'date-time', type: 'string' },
-          display_name: { type: 'string' },
-          network_id: { format: 'uuid', type: 'string' },
-          workspace_id: { format: 'uuid', type: 'string' },
-        },
-        required: ['network_id', 'workspace_id', 'display_name', 'created_at'],
-        type: 'object',
-        'x-route-path': '/networks',
-      },
       noise_threshold: {
         description:
           'Represents a [noise threshold](https://docs.seam.co/latest/capability-guides/noise-sensors/configure-noise-threshold-settings) for a [noise sensor](https://docs.seam.co/latest/capability-guides/noise-sensors). Thresholds represent the limits of noise tolerated at a property, which can be customized for each hour of the day. Each device has its own default thresholds, but you can use the Seam API to modify them.',
@@ -16826,6 +16815,41 @@ export default {
         'x-route-path': '/seam/mobile_sdk/v1/phone_sessions',
         'x-undocumented': 'Seam Mobile SDK only.',
       },
+      space: {
+        properties: {
+          created_at: {
+            description: 'Date and time at which the space object was created.',
+            format: 'date-time',
+            type: 'string',
+          },
+          display_name: {
+            description: 'Display name of the space.',
+            type: 'string',
+          },
+          name: { description: 'Name of the space.', type: 'string' },
+          space_id: {
+            description: 'Unique identifier for the space.',
+            format: 'uuid',
+            type: 'string',
+          },
+          workspace_id: {
+            description:
+              'Unique identifier for the Seam workspace associated with the space.',
+            format: 'uuid',
+            type: 'string',
+          },
+        },
+        required: [
+          'space_id',
+          'workspace_id',
+          'name',
+          'display_name',
+          'created_at',
+        ],
+        type: 'object',
+        'x-draft': 'Early access.',
+        'x-route-path': '/spaces',
+      },
       thermostat_schedule: {
         description:
           'Represents a [thermostat schedule](https://docs.seam.co/latest/capability-guides/thermostats/creating-and-managing-thermostat-schedules) that activates a configured [climate preset](https://docs.seam.co/latest/capability-guides/thermostats/creating-and-managing-climate-presets) on a [thermostat](https://docs.seam.co/latest/capability-guides/thermostats) at a specified starting time and deactivates the climate preset at a specified ending time.',
@@ -22875,7 +22899,6 @@ export default {
                               'created_access_method_ids',
                             ],
                             type: 'object',
-                            'x-undocumented': 'Unreleased.',
                           },
                           type: 'array',
                         },
@@ -22910,7 +22933,8 @@ export default {
                         'created_at',
                       ],
                       type: 'object',
-                      'x-undocumented': 'Unreleased.',
+                      'x-draft': 'Early access.',
+                      'x-route-path': '/access_grants',
                     },
                     ok: { type: 'boolean' },
                   },
@@ -23084,7 +23108,6 @@ export default {
                               'created_access_method_ids',
                             ],
                             type: 'object',
-                            'x-undocumented': 'Unreleased.',
                           },
                           type: 'array',
                         },
@@ -23119,7 +23142,8 @@ export default {
                         'created_at',
                       ],
                       type: 'object',
-                      'x-undocumented': 'Unreleased.',
+                      'x-draft': 'Early access.',
+                      'x-route-path': '/access_grants',
                     },
                     ok: { type: 'boolean' },
                   },
@@ -23266,7 +23290,6 @@ export default {
                                 'created_access_method_ids',
                               ],
                               type: 'object',
-                              'x-undocumented': 'Unreleased.',
                             },
                             type: 'array',
                           },
@@ -23301,7 +23324,8 @@ export default {
                           'created_at',
                         ],
                         type: 'object',
-                        'x-undocumented': 'Unreleased.',
+                        'x-draft': 'Early access.',
+                        'x-route-path': '/access_grants',
                       },
                       type: 'array',
                     },
@@ -23465,7 +23489,8 @@ export default {
                         'created_at',
                       ],
                       type: 'object',
-                      'x-undocumented': 'Unreleased.',
+                      'x-draft': 'Early access.',
+                      'x-route-path': '/access_methods',
                     },
                     ok: { type: 'boolean' },
                   },
@@ -23578,7 +23603,8 @@ export default {
                           'created_at',
                         ],
                         type: 'object',
-                        'x-undocumented': 'Unreleased.',
+                        'x-draft': 'Early access.',
+                        'x-route-path': '/access_methods',
                       },
                       type: 'array',
                     },
@@ -31680,7 +31706,22 @@ export default {
               'application/json': {
                 schema: {
                   properties: {
-                    network: { $ref: '#/components/schemas/network' },
+                    network: {
+                      properties: {
+                        created_at: { format: 'date-time', type: 'string' },
+                        display_name: { type: 'string' },
+                        network_id: { format: 'uuid', type: 'string' },
+                        workspace_id: { format: 'uuid', type: 'string' },
+                      },
+                      required: [
+                        'network_id',
+                        'workspace_id',
+                        'display_name',
+                        'created_at',
+                      ],
+                      type: 'object',
+                      'x-route-path': '/networks',
+                    },
                     ok: { type: 'boolean' },
                   },
                   required: ['network', 'ok'],
@@ -31723,7 +31764,22 @@ export default {
                 schema: {
                   properties: {
                     networks: {
-                      items: { $ref: '#/components/schemas/network' },
+                      items: {
+                        properties: {
+                          created_at: { format: 'date-time', type: 'string' },
+                          display_name: { type: 'string' },
+                          network_id: { format: 'uuid', type: 'string' },
+                          workspace_id: { format: 'uuid', type: 'string' },
+                        },
+                        required: [
+                          'network_id',
+                          'workspace_id',
+                          'display_name',
+                          'created_at',
+                        ],
+                        type: 'object',
+                        'x-route-path': '/networks',
+                      },
                       type: 'array',
                     },
                     ok: { type: 'boolean' },
@@ -34562,43 +34618,7 @@ export default {
                 schema: {
                   properties: {
                     ok: { type: 'boolean' },
-                    space: {
-                      properties: {
-                        created_at: {
-                          description:
-                            'Date and time at which the space object was created.',
-                          format: 'date-time',
-                          type: 'string',
-                        },
-                        display_name: {
-                          description: 'Display name of the space.',
-                          type: 'string',
-                        },
-                        name: {
-                          description: 'Name of the space.',
-                          type: 'string',
-                        },
-                        space_id: {
-                          description: 'Unique identifier for the space.',
-                          format: 'uuid',
-                          type: 'string',
-                        },
-                        workspace_id: {
-                          description:
-                            'Unique identifier for the Seam workspace associated with the space.',
-                          format: 'uuid',
-                          type: 'string',
-                        },
-                      },
-                      required: [
-                        'space_id',
-                        'workspace_id',
-                        'name',
-                        'display_name',
-                        'created_at',
-                      ],
-                      type: 'object',
-                    },
+                    space: { $ref: '#/components/schemas/space' },
                   },
                   required: ['space', 'ok'],
                   type: 'object',
@@ -34690,43 +34710,7 @@ export default {
                 schema: {
                   properties: {
                     ok: { type: 'boolean' },
-                    space: {
-                      properties: {
-                        created_at: {
-                          description:
-                            'Date and time at which the space object was created.',
-                          format: 'date-time',
-                          type: 'string',
-                        },
-                        display_name: {
-                          description: 'Display name of the space.',
-                          type: 'string',
-                        },
-                        name: {
-                          description: 'Name of the space.',
-                          type: 'string',
-                        },
-                        space_id: {
-                          description: 'Unique identifier for the space.',
-                          format: 'uuid',
-                          type: 'string',
-                        },
-                        workspace_id: {
-                          description:
-                            'Unique identifier for the Seam workspace associated with the space.',
-                          format: 'uuid',
-                          type: 'string',
-                        },
-                      },
-                      required: [
-                        'space_id',
-                        'workspace_id',
-                        'name',
-                        'display_name',
-                        'created_at',
-                      ],
-                      type: 'object',
-                    },
+                    space: { $ref: '#/components/schemas/space' },
                   },
                   required: ['space', 'ok'],
                   type: 'object',
@@ -34764,43 +34748,7 @@ export default {
                   properties: {
                     ok: { type: 'boolean' },
                     spaces: {
-                      items: {
-                        properties: {
-                          created_at: {
-                            description:
-                              'Date and time at which the space object was created.',
-                            format: 'date-time',
-                            type: 'string',
-                          },
-                          display_name: {
-                            description: 'Display name of the space.',
-                            type: 'string',
-                          },
-                          name: {
-                            description: 'Name of the space.',
-                            type: 'string',
-                          },
-                          space_id: {
-                            description: 'Unique identifier for the space.',
-                            format: 'uuid',
-                            type: 'string',
-                          },
-                          workspace_id: {
-                            description:
-                              'Unique identifier for the Seam workspace associated with the space.',
-                            format: 'uuid',
-                            type: 'string',
-                          },
-                        },
-                        required: [
-                          'space_id',
-                          'workspace_id',
-                          'name',
-                          'display_name',
-                          'created_at',
-                        ],
-                        type: 'object',
-                      },
+                      items: { $ref: '#/components/schemas/space' },
                       type: 'array',
                     },
                   },
@@ -34836,43 +34784,7 @@ export default {
                   properties: {
                     ok: { type: 'boolean' },
                     spaces: {
-                      items: {
-                        properties: {
-                          created_at: {
-                            description:
-                              'Date and time at which the space object was created.',
-                            format: 'date-time',
-                            type: 'string',
-                          },
-                          display_name: {
-                            description: 'Display name of the space.',
-                            type: 'string',
-                          },
-                          name: {
-                            description: 'Name of the space.',
-                            type: 'string',
-                          },
-                          space_id: {
-                            description: 'Unique identifier for the space.',
-                            format: 'uuid',
-                            type: 'string',
-                          },
-                          workspace_id: {
-                            description:
-                              'Unique identifier for the Seam workspace associated with the space.',
-                            format: 'uuid',
-                            type: 'string',
-                          },
-                        },
-                        required: [
-                          'space_id',
-                          'workspace_id',
-                          'name',
-                          'display_name',
-                          'created_at',
-                        ],
-                        type: 'object',
-                      },
+                      items: { $ref: '#/components/schemas/space' },
                       type: 'array',
                     },
                   },
@@ -35025,43 +34937,7 @@ export default {
                 schema: {
                   properties: {
                     ok: { type: 'boolean' },
-                    space: {
-                      properties: {
-                        created_at: {
-                          description:
-                            'Date and time at which the space object was created.',
-                          format: 'date-time',
-                          type: 'string',
-                        },
-                        display_name: {
-                          description: 'Display name of the space.',
-                          type: 'string',
-                        },
-                        name: {
-                          description: 'Name of the space.',
-                          type: 'string',
-                        },
-                        space_id: {
-                          description: 'Unique identifier for the space.',
-                          format: 'uuid',
-                          type: 'string',
-                        },
-                        workspace_id: {
-                          description:
-                            'Unique identifier for the Seam workspace associated with the space.',
-                          format: 'uuid',
-                          type: 'string',
-                        },
-                      },
-                      required: [
-                        'space_id',
-                        'workspace_id',
-                        'name',
-                        'display_name',
-                        'created_at',
-                      ],
-                      type: 'object',
-                    },
+                    space: { $ref: '#/components/schemas/space' },
                   },
                   required: ['space', 'ok'],
                   type: 'object',
@@ -35108,43 +34984,7 @@ export default {
                 schema: {
                   properties: {
                     ok: { type: 'boolean' },
-                    space: {
-                      properties: {
-                        created_at: {
-                          description:
-                            'Date and time at which the space object was created.',
-                          format: 'date-time',
-                          type: 'string',
-                        },
-                        display_name: {
-                          description: 'Display name of the space.',
-                          type: 'string',
-                        },
-                        name: {
-                          description: 'Name of the space.',
-                          type: 'string',
-                        },
-                        space_id: {
-                          description: 'Unique identifier for the space.',
-                          format: 'uuid',
-                          type: 'string',
-                        },
-                        workspace_id: {
-                          description:
-                            'Unique identifier for the Seam workspace associated with the space.',
-                          format: 'uuid',
-                          type: 'string',
-                        },
-                      },
-                      required: [
-                        'space_id',
-                        'workspace_id',
-                        'name',
-                        'display_name',
-                        'created_at',
-                      ],
-                      type: 'object',
-                    },
+                    space: { $ref: '#/components/schemas/space' },
                   },
                   required: ['space', 'ok'],
                   type: 'object',
@@ -38033,7 +37873,6 @@ export default {
                               'created_access_method_ids',
                             ],
                             type: 'object',
-                            'x-undocumented': 'Unreleased.',
                           },
                           type: 'array',
                         },
@@ -38068,7 +37907,8 @@ export default {
                         'created_at',
                       ],
                       type: 'object',
-                      'x-undocumented': 'Unreleased.',
+                      'x-draft': 'Early access.',
+                      'x-route-path': '/access_grants',
                     },
                     ok: { type: 'boolean' },
                   },
@@ -38242,7 +38082,6 @@ export default {
                               'created_access_method_ids',
                             ],
                             type: 'object',
-                            'x-undocumented': 'Unreleased.',
                           },
                           type: 'array',
                         },
@@ -38277,7 +38116,8 @@ export default {
                         'created_at',
                       ],
                       type: 'object',
-                      'x-undocumented': 'Unreleased.',
+                      'x-draft': 'Early access.',
+                      'x-route-path': '/access_grants',
                     },
                     ok: { type: 'boolean' },
                   },
@@ -38424,7 +38264,6 @@ export default {
                                 'created_access_method_ids',
                               ],
                               type: 'object',
-                              'x-undocumented': 'Unreleased.',
                             },
                             type: 'array',
                           },
@@ -38459,7 +38298,8 @@ export default {
                           'created_at',
                         ],
                         type: 'object',
-                        'x-undocumented': 'Unreleased.',
+                        'x-draft': 'Early access.',
+                        'x-route-path': '/access_grants',
                       },
                       type: 'array',
                     },
@@ -38623,7 +38463,8 @@ export default {
                         'created_at',
                       ],
                       type: 'object',
-                      'x-undocumented': 'Unreleased.',
+                      'x-draft': 'Early access.',
+                      'x-route-path': '/access_methods',
                     },
                     ok: { type: 'boolean' },
                   },
@@ -38736,7 +38577,8 @@ export default {
                           'created_at',
                         ],
                         type: 'object',
-                        'x-undocumented': 'Unreleased.',
+                        'x-draft': 'Early access.',
+                        'x-route-path': '/access_methods',
                       },
                       type: 'array',
                     },