@seamapi/types 1.1187.0 → 1.1189.0

This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
package/package.json CHANGED
@@ -1,6 +1,6 @@
1
1
  {
2
2
  "name": "@seamapi/types",
3
- "version": "1.1187.0",
3
+ "version": "1.1189.0",
4
4
  "description": "TypeScript types for the Seam API.",
5
5
  "type": "module",
6
6
  "main": "index.js",
@@ -133,6 +133,12 @@ const base_configure_feature = base_feature.extend({
133
133
  .describe(
134
134
  'Indicates whether the customer can customize their notification settings, such as the low-battery alert threshold.',
135
135
  ),
136
+ allow_bridge_replacement: z
137
+ .boolean()
138
+ .default(false)
139
+ .describe(
140
+ 'Indicates whether the customer can move a connected account to a new Seam Bridge when its current bridge is disconnected.',
141
+ ),
136
142
  })
137
143
 
138
144
  const base_features = z.object({
@@ -315,6 +321,7 @@ export const portal_configuration = portal_configuration_base
315
321
  allow_sound_automation_rule_customization: false,
316
322
  allow_sensor_automation_rule_customization: false,
317
323
  allow_notification_customization: false,
324
+ allow_bridge_replacement: false,
318
325
  },
319
326
  },
320
327
  is_embedded: false,
@@ -1239,10 +1239,25 @@ export const device = z
1239
1239
  capabilities_supported: z.array(capabilities).describe(`
1240
1240
  Collection of capabilities that the device supports when connected to Seam. Values are \`access_code\`, which indicates that the device can manage and utilize digital PIN codes for secure access; \`lock\`, which indicates that the device controls a door locking mechanism, enabling the remote opening and closing of doors and other entry points; \`noise_detection\`, which indicates that the device supports monitoring and responding to ambient noise levels; \`thermostat\`, which indicates that the device can regulate and adjust indoor temperatures; \`battery\`, which indicates that the device can manage battery life and health; and \`phone\`, which indicates that the device is a mobile device, such as a smartphone. **Important:** Superseded by [capability flags](https://www.seam.co/docs/capability-guides/device-and-system-capabilities#capability-flags).
1241
1241
  `),
1242
+ is_online: z.boolean().describe(`
1243
+ ---
1244
+ undocumented: Unreleased.
1245
+ property_group_key: hardware
1246
+ ---
1247
+ Indicates whether the device is online.
1248
+ `),
1249
+ is_door_locked: z.boolean().optional().describe(`
1250
+ ---
1251
+ undocumented: Unreleased.
1252
+ property_group_key: locks
1253
+ ---
1254
+ Indicates whether the lock is locked.
1255
+ `),
1242
1256
  properties: common_device_properties
1243
1257
  .and(phone_specific_properties.partial())
1244
1258
  .and(device_metadata)
1245
- .and(capability_properties).describe(`
1259
+ .and(capability_properties)
1260
+ .optional().describe(`
1246
1261
  ---
1247
1262
  property_groups:
1248
1263
  locks:
@@ -1412,4 +1427,8 @@ export const device = z
1412
1427
  Represents a [device](https://www.seam.co/docs/core-concepts/devices) that has been connected to Seam.
1413
1428
  `)
1414
1429
 
1415
- export type Device = z.infer<typeof device>
1430
+ type DeviceFromSchema = z.infer<typeof device>
1431
+
1432
+ export type Device = Omit<DeviceFromSchema, 'properties'> & {
1433
+ properties: NonNullable<DeviceFromSchema['properties']>
1434
+ }
@@ -19,24 +19,27 @@ export const unmanaged_device = device
19
19
  created_at: true,
20
20
  custom_metadata: true,
21
21
  display_name: true,
22
+ is_online: true,
22
23
  })
23
24
  .extend({
24
25
  is_managed: z
25
26
  .literal(false)
26
27
  .describe('Indicates that Seam does not manage the device.'),
27
- properties: common_device_properties.pick({
28
- accessory_keypad: true,
29
- name: true,
30
- online: true,
31
- manufacturer: true,
32
- image_url: true,
33
- image_alt_text: true,
34
- battery_level: true,
35
- battery: true,
36
- online_access_codes_enabled: true,
37
- offline_access_codes_enabled: true,
38
- model: true,
39
- }).describe(`
28
+ properties: common_device_properties
29
+ .pick({
30
+ accessory_keypad: true,
31
+ name: true,
32
+ online: true,
33
+ manufacturer: true,
34
+ image_url: true,
35
+ image_alt_text: true,
36
+ battery_level: true,
37
+ battery: true,
38
+ online_access_codes_enabled: true,
39
+ offline_access_codes_enabled: true,
40
+ model: true,
41
+ })
42
+ .optional().describe(`
40
43
  ---
41
44
  property_groups:
42
45
  locks:
@@ -79,4 +82,8 @@ export const unmanaged_device = device
79
82
  Represents an [unmanaged device](https://www.seam.co/docs/core-concepts/devices/managed-and-unmanaged-devices). An unmanaged device has a limited set of visible properties and a subset of supported events. You cannot control an unmanaged device. Any [access codes](https://www.seam.co/docs/low-level-apis/smart-locks/access-codes/migrating-existing-access-codes) on an unmanaged device are unmanaged. To control an unmanaged device with Seam, [convert it to a managed device](https://www.seam.co/docs/core-concepts/devices/managed-and-unmanaged-devices#convert-an-unmanaged-device-to-managed).
80
83
  `)
81
84
 
82
- export type UnmanagedDevice = z.infer<typeof unmanaged_device>
85
+ type UnmanagedDeviceFromSchema = z.infer<typeof unmanaged_device>
86
+
87
+ export type UnmanagedDevice = Omit<UnmanagedDeviceFromSchema, 'properties'> & {
88
+ properties: NonNullable<UnmanagedDeviceFromSchema['properties']>
89
+ }
@@ -15172,6 +15172,12 @@ const openapi: OpenAPISpec = {
15172
15172
  'Indicates whether the customer can customize the access automation rules for their properties.',
15173
15173
  type: 'boolean',
15174
15174
  },
15175
+ allow_bridge_replacement: {
15176
+ default: false,
15177
+ description:
15178
+ 'Indicates whether the customer can move a connected account to a new Seam Bridge when its current bridge is disconnected.',
15179
+ type: 'boolean',
15180
+ },
15175
15181
  allow_climate_automation_rule_customization: {
15176
15182
  default: false,
15177
15183
  description:
@@ -16637,6 +16643,12 @@ const openapi: OpenAPISpec = {
16637
16643
  thermostats: { name: 'Thermostats' },
16638
16644
  },
16639
16645
  },
16646
+ is_door_locked: {
16647
+ description: 'Indicates whether the lock is locked.',
16648
+ type: 'boolean',
16649
+ 'x-property-group-key': 'locks',
16650
+ 'x-undocumented': 'Unreleased.',
16651
+ },
16640
16652
  is_managed: {
16641
16653
  description:
16642
16654
  'Indicates whether Seam manages the device. See also [Managed and Unmanaged Devices](https://www.seam.co/docs/core-concepts/devices/managed-and-unmanaged-devices).',
@@ -16649,6 +16661,12 @@ const openapi: OpenAPISpec = {
16649
16661
  type: 'boolean',
16650
16662
  'x-property-group-key': 'sensors',
16651
16663
  },
16664
+ is_online: {
16665
+ description: 'Indicates whether the device is online.',
16666
+ type: 'boolean',
16667
+ 'x-property-group-key': 'hardware',
16668
+ 'x-undocumented': 'Unreleased.',
16669
+ },
16652
16670
  is_smoking_detected: {
16653
16671
  description:
16654
16672
  'Indicates whether the device detects smoking, if the device measures it.',
@@ -20858,7 +20876,7 @@ const openapi: OpenAPISpec = {
20858
20876
  'space_ids',
20859
20877
  'display_name',
20860
20878
  'capabilities_supported',
20861
- 'properties',
20879
+ 'is_online',
20862
20880
  'connected_account_id',
20863
20881
  'workspace_id',
20864
20882
  'errors',
@@ -42160,6 +42178,12 @@ const openapi: OpenAPISpec = {
42160
42178
  enum: [false],
42161
42179
  type: 'boolean',
42162
42180
  },
42181
+ is_online: {
42182
+ description: 'Indicates whether the device is online.',
42183
+ type: 'boolean',
42184
+ 'x-property-group-key': 'hardware',
42185
+ 'x-undocumented': 'Unreleased.',
42186
+ },
42163
42187
  location: {
42164
42188
  description: 'Location information for the device.',
42165
42189
  properties: {
@@ -43151,8 +43175,8 @@ const openapi: OpenAPISpec = {
43151
43175
  'created_at',
43152
43176
  'custom_metadata',
43153
43177
  'display_name',
43178
+ 'is_online',
43154
43179
  'is_managed',
43155
- 'properties',
43156
43180
  ],
43157
43181
  type: 'object',
43158
43182
  'x-property-groups': {
@@ -53426,6 +53450,12 @@ const openapi: OpenAPISpec = {
53426
53450
  'Indicates whether the customer can customize the access automation rules for their properties.',
53427
53451
  type: 'boolean',
53428
53452
  },
53453
+ allow_bridge_replacement: {
53454
+ default: false,
53455
+ description:
53456
+ 'Indicates whether the customer can move a connected account to a new Seam Bridge when its current bridge is disconnected.',
53457
+ type: 'boolean',
53458
+ },
53429
53459
  allow_climate_automation_rule_customization: {
53430
53460
  default: false,
53431
53461
  description:
@@ -62280,6 +62310,66 @@ const openapi: OpenAPISpec = {
62280
62310
  'x-undocumented': 'Internal endpoint for Console',
62281
62311
  },
62282
62312
  },
62313
+ '/seam/console/v1/connected_accounts/replace_bridge': {
62314
+ post: {
62315
+ description:
62316
+ "Moves a [connected account](https://www.seam.co/docs/core-concepts/connected-accounts) whose [Seam Bridge](https://www.seam.co/docs/capability-guides/seam-bridge) is disconnected onto a newly installed Seam Bridge, identified by the pairing code it shows. The connected account, its devices and its ID stay the same, and no provider sign-in is needed. Seam first checks that it can reach the provider through the new bridge. Only available for providers whose account doesn't depend on the bridge, such as Salto Space.",
62317
+ operationId: 'seamConsoleV1ConnectedAccountsReplaceBridgePost',
62318
+ requestBody: {
62319
+ content: {
62320
+ 'application/json': {
62321
+ schema: {
62322
+ properties: {
62323
+ connected_account_id: {
62324
+ description:
62325
+ 'ID of the connected account whose Seam Bridge you want to replace.',
62326
+ format: 'uuid',
62327
+ type: 'string',
62328
+ },
62329
+ pairing_code: {
62330
+ description:
62331
+ 'Pairing code shown in the new Seam Bridge app.',
62332
+ minLength: 1,
62333
+ type: 'string',
62334
+ },
62335
+ },
62336
+ required: ['connected_account_id', 'pairing_code'],
62337
+ type: 'object',
62338
+ },
62339
+ },
62340
+ },
62341
+ },
62342
+ responses: {
62343
+ '200': {
62344
+ content: {
62345
+ 'application/json': {
62346
+ schema: {
62347
+ properties: { ok: { type: 'boolean' } },
62348
+ required: ['ok'],
62349
+ type: 'object',
62350
+ },
62351
+ },
62352
+ },
62353
+ description: 'OK',
62354
+ },
62355
+ '400': { description: 'Bad Request' },
62356
+ '401': { description: 'Unauthorized' },
62357
+ },
62358
+ security: [{ console_session_with_workspace: [] }],
62359
+ summary: '/seam/console/v1/connected_accounts/replace_bridge',
62360
+ tags: ['/connected_accounts'],
62361
+ 'x-fern-sdk-group-name': [
62362
+ 'seam',
62363
+ 'console',
62364
+ 'v1',
62365
+ 'connected_accounts',
62366
+ ],
62367
+ 'x-fern-sdk-method-name': 'replace_bridge',
62368
+ 'x-response-key': null,
62369
+ 'x-title': 'Replace the Seam Bridge of a Connected Account',
62370
+ 'x-undocumented': 'Internal endpoint for Console.',
62371
+ },
62372
+ },
62283
62373
  '/seam/console/v1/credits/checkout/start': {
62284
62374
  post: {
62285
62375
  description:
@@ -69004,6 +69094,66 @@ const openapi: OpenAPISpec = {
69004
69094
  'x-undocumented': 'Internal endpoint for customer portals.',
69005
69095
  },
69006
69096
  },
69097
+ '/seam/customer/v1/connected_accounts/replace_bridge': {
69098
+ post: {
69099
+ description:
69100
+ "Moves one of the authenticated customer's connected accounts whose Seam Bridge is disconnected onto a newly installed Seam Bridge, identified by the pairing code it shows. No provider sign-in is needed. Requires a customer portal with `features.configure.allow_bridge_replacement` enabled.",
69101
+ operationId: 'seamCustomerV1ConnectedAccountsReplaceBridgePost',
69102
+ requestBody: {
69103
+ content: {
69104
+ 'application/json': {
69105
+ schema: {
69106
+ properties: {
69107
+ connected_account_id: {
69108
+ description:
69109
+ 'ID of the connected account whose Seam Bridge you want to replace.',
69110
+ format: 'uuid',
69111
+ type: 'string',
69112
+ },
69113
+ pairing_code: {
69114
+ description:
69115
+ 'Pairing code shown in the new Seam Bridge app.',
69116
+ minLength: 1,
69117
+ type: 'string',
69118
+ },
69119
+ },
69120
+ required: ['connected_account_id', 'pairing_code'],
69121
+ type: 'object',
69122
+ },
69123
+ },
69124
+ },
69125
+ },
69126
+ responses: {
69127
+ '200': {
69128
+ content: {
69129
+ 'application/json': {
69130
+ schema: {
69131
+ properties: { ok: { type: 'boolean' } },
69132
+ required: ['ok'],
69133
+ type: 'object',
69134
+ },
69135
+ },
69136
+ },
69137
+ description: 'OK',
69138
+ },
69139
+ '400': { description: 'Bad Request' },
69140
+ '401': { description: 'Unauthorized' },
69141
+ },
69142
+ security: [{ client_session_with_customer: [] }],
69143
+ summary: '/seam/customer/v1/connected_accounts/replace_bridge',
69144
+ tags: ['/connected_accounts'],
69145
+ 'x-fern-sdk-group-name': [
69146
+ 'seam',
69147
+ 'customer',
69148
+ 'v1',
69149
+ 'connected_accounts',
69150
+ ],
69151
+ 'x-fern-sdk-method-name': 'replace_bridge',
69152
+ 'x-response-key': null,
69153
+ 'x-title': "Replace the Seam Bridge of a Customer's Connected Account",
69154
+ 'x-undocumented': 'Internal endpoint for customer portals.',
69155
+ },
69156
+ },
69007
69157
  '/seam/customer/v1/connector_customers/list': {
69008
69158
  get: {
69009
69159
  description: 'Lists connector customers for a given connector.',
@@ -71929,6 +72079,12 @@ const openapi: OpenAPISpec = {
71929
72079
  'Indicates whether the customer can customize the access automation rules for their properties.',
71930
72080
  type: 'boolean',
71931
72081
  },
72082
+ allow_bridge_replacement: {
72083
+ default: false,
72084
+ description:
72085
+ 'Indicates whether the customer can move a connected account to a new Seam Bridge when its current bridge is disconnected.',
72086
+ type: 'boolean',
72087
+ },
71932
72088
  allow_climate_automation_rule_customization: {
71933
72089
  default: false,
71934
72090
  description:
@@ -72417,6 +72573,12 @@ const openapi: OpenAPISpec = {
72417
72573
  'Indicates whether the customer can customize the access automation rules for their properties.',
72418
72574
  type: 'boolean',
72419
72575
  },
72576
+ allow_bridge_replacement: {
72577
+ default: false,
72578
+ description:
72579
+ 'Indicates whether the customer can move a connected account to a new Seam Bridge when its current bridge is disconnected.',
72580
+ type: 'boolean',
72581
+ },
72420
72582
  allow_climate_automation_rule_customization: {
72421
72583
  default: false,
72422
72584
  description:
@@ -81925,6 +82087,12 @@ const openapi: OpenAPISpec = {
81925
82087
  'Indicates whether the customer can customize the access automation rules for their properties.',
81926
82088
  type: 'boolean',
81927
82089
  },
82090
+ allow_bridge_replacement: {
82091
+ default: false,
82092
+ description:
82093
+ 'Indicates whether the customer can move a connected account to a new Seam Bridge when its current bridge is disconnected.',
82094
+ type: 'boolean',
82095
+ },
81928
82096
  allow_climate_automation_rule_customization: {
81929
82097
  default: false,
81930
82098
  description:
@@ -82606,6 +82774,12 @@ const openapi: OpenAPISpec = {
82606
82774
  'Indicates whether the customer can customize the access automation rules for their properties.',
82607
82775
  type: 'boolean',
82608
82776
  },
82777
+ allow_bridge_replacement: {
82778
+ default: false,
82779
+ description:
82780
+ 'Indicates whether the customer can move a connected account to a new Seam Bridge when its current bridge is disconnected.',
82781
+ type: 'boolean',
82782
+ },
82609
82783
  allow_climate_automation_rule_customization: {
82610
82784
  default: false,
82611
82785
  description: