@seamapi/types 1.345.1 → 1.346.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.
Files changed (42) hide show
  1. package/dist/connect.cjs +327 -687
  2. package/dist/connect.cjs.map +1 -1
  3. package/dist/connect.d.cts +269 -484
  4. package/lib/seam/connect/internal/schemas.d.ts +1 -1
  5. package/lib/seam/connect/internal/schemas.js +1 -1
  6. package/lib/seam/connect/internal/schemas.js.map +1 -1
  7. package/lib/seam/connect/model-types.d.ts +1 -1
  8. package/lib/seam/connect/models/bridges/bridge.d.ts +15 -0
  9. package/lib/seam/connect/models/bridges/bridge.js +12 -0
  10. package/lib/seam/connect/models/bridges/bridge.js.map +1 -0
  11. package/lib/seam/connect/models/bridges/index.d.ts +1 -0
  12. package/lib/seam/connect/models/bridges/index.js +2 -0
  13. package/lib/seam/connect/models/bridges/index.js.map +1 -0
  14. package/lib/seam/connect/models/devices/device-type.js +3 -1
  15. package/lib/seam/connect/models/devices/device-type.js.map +1 -1
  16. package/lib/seam/connect/models/devices/phone-properties.js +7 -3
  17. package/lib/seam/connect/models/devices/phone-properties.js.map +1 -1
  18. package/lib/seam/connect/models/devices/phone.d.ts +29 -2450
  19. package/lib/seam/connect/models/devices/phone.js +36 -15
  20. package/lib/seam/connect/models/devices/phone.js.map +1 -1
  21. package/lib/seam/connect/models/index.d.ts +1 -0
  22. package/lib/seam/connect/models/index.js +1 -0
  23. package/lib/seam/connect/models/index.js.map +1 -1
  24. package/lib/seam/connect/openapi.d.ts +188 -141
  25. package/lib/seam/connect/openapi.js +273 -642
  26. package/lib/seam/connect/openapi.js.map +1 -1
  27. package/lib/seam/connect/route-types.d.ts +63 -341
  28. package/lib/seam/connect/schemas.d.ts +1 -1
  29. package/lib/seam/connect/schemas.js +1 -1
  30. package/lib/seam/connect/schemas.js.map +1 -1
  31. package/package.json +2 -2
  32. package/src/lib/seam/connect/internal/schemas.ts +1 -0
  33. package/src/lib/seam/connect/model-types.ts +1 -0
  34. package/src/lib/seam/connect/models/bridges/bridge.ts +13 -0
  35. package/src/lib/seam/connect/models/bridges/index.ts +1 -0
  36. package/src/lib/seam/connect/models/devices/device-type.ts +3 -3
  37. package/src/lib/seam/connect/models/devices/phone-properties.ts +36 -32
  38. package/src/lib/seam/connect/models/devices/phone.ts +53 -15
  39. package/src/lib/seam/connect/models/index.ts +1 -0
  40. package/src/lib/seam/connect/openapi.ts +269 -676
  41. package/src/lib/seam/connect/route-types.ts +63 -419
  42. package/src/lib/seam/connect/schemas.ts +1 -0
@@ -7591,6 +7591,21 @@ declare const common_failed_action_attempt: z.ZodObject<z.objectUtil.extendShape
7591
7591
  result: null;
7592
7592
  }>;
7593
7593
 
7594
+ declare const bridge: z.ZodObject<{
7595
+ bridge_id: z.ZodString;
7596
+ workspace_id: z.ZodString;
7597
+ created_at: z.ZodString;
7598
+ }, "strip", z.ZodTypeAny, {
7599
+ created_at: string;
7600
+ bridge_id: string;
7601
+ workspace_id: string;
7602
+ }, {
7603
+ created_at: string;
7604
+ bridge_id: string;
7605
+ workspace_id: string;
7606
+ }>;
7607
+ type Bridge = z.infer<typeof bridge>;
7608
+
7594
7609
  declare const client_session: z.ZodObject<{
7595
7610
  client_session_id: z.ZodString;
7596
7611
  workspace_id: z.ZodString;
@@ -16559,6 +16574,7 @@ declare const schemas_acs_entrance: typeof acs_entrance;
16559
16574
  declare const schemas_acs_system: typeof acs_system;
16560
16575
  declare const schemas_acs_user: typeof acs_user;
16561
16576
  declare const schemas_action_attempt: typeof action_attempt;
16577
+ declare const schemas_bridge: typeof bridge;
16562
16578
  declare const schemas_client_session: typeof client_session;
16563
16579
  declare const schemas_common_failed_action_attempt: typeof common_failed_action_attempt;
16564
16580
  declare const schemas_common_pending_action_attempt: typeof common_pending_action_attempt;
@@ -16580,7 +16596,7 @@ declare const schemas_user_identity: typeof user_identity;
16580
16596
  declare const schemas_webhook: typeof webhook;
16581
16597
  declare const schemas_workspace: typeof workspace;
16582
16598
  declare namespace schemas {
16583
- export { schemas_access_code as access_code, schemas_acs_access_group as acs_access_group, schemas_acs_credential as acs_credential, schemas_acs_encoder as acs_encoder, schemas_acs_entrance as acs_entrance, schemas_acs_system as acs_system, schemas_acs_user as acs_user, schemas_action_attempt as action_attempt, schemas_client_session as client_session, schemas_common_failed_action_attempt as common_failed_action_attempt, schemas_common_pending_action_attempt as common_pending_action_attempt, schemas_common_succeeded_action_attempt as common_succeeded_action_attempt, schemas_connect_webview as connect_webview, schemas_connected_account as connected_account, schemas_custom_metadata as custom_metadata, schemas_device as device, schemas_device_provider as device_provider, schemas_noise_threshold as noise_threshold, schemas_seam_event as seam_event, schemas_thermostat_schedule as thermostat_schedule, schemas_unmanaged_access_code as unmanaged_access_code, schemas_unmanaged_acs_access_group as unmanaged_acs_access_group, schemas_unmanaged_acs_credential as unmanaged_acs_credential, schemas_unmanaged_acs_user as unmanaged_acs_user, schemas_unmanaged_device as unmanaged_device, schemas_user_identity as user_identity, schemas_webhook as webhook, schemas_workspace as workspace };
16599
+ export { schemas_access_code as access_code, schemas_acs_access_group as acs_access_group, schemas_acs_credential as acs_credential, schemas_acs_encoder as acs_encoder, schemas_acs_entrance as acs_entrance, schemas_acs_system as acs_system, schemas_acs_user as acs_user, schemas_action_attempt as action_attempt, schemas_bridge as bridge, schemas_client_session as client_session, schemas_common_failed_action_attempt as common_failed_action_attempt, schemas_common_pending_action_attempt as common_pending_action_attempt, schemas_common_succeeded_action_attempt as common_succeeded_action_attempt, schemas_connect_webview as connect_webview, schemas_connected_account as connected_account, schemas_custom_metadata as custom_metadata, schemas_device as device, schemas_device_provider as device_provider, schemas_noise_threshold as noise_threshold, schemas_seam_event as seam_event, schemas_thermostat_schedule as thermostat_schedule, schemas_unmanaged_access_code as unmanaged_access_code, schemas_unmanaged_acs_access_group as unmanaged_acs_access_group, schemas_unmanaged_acs_credential as unmanaged_acs_credential, schemas_unmanaged_acs_user as unmanaged_acs_user, schemas_unmanaged_device as unmanaged_device, schemas_user_identity as user_identity, schemas_webhook as webhook, schemas_workspace as workspace };
16584
16600
  }
16585
16601
 
16586
16602
  declare const _default: {
@@ -19119,10 +19135,15 @@ declare const _default: {
19119
19135
  };
19120
19136
  device_type: {
19121
19137
  description: string;
19122
- oneOf: {
19138
+ oneOf: ({
19139
+ enum: string[];
19140
+ type: string;
19141
+ description?: never;
19142
+ } | {
19143
+ description: string;
19123
19144
  enum: string[];
19124
19145
  type: string;
19125
- }[];
19146
+ })[];
19126
19147
  };
19127
19148
  display_name: {
19128
19149
  description: string;
@@ -19364,7 +19385,9 @@ declare const _default: {
19364
19385
  };
19365
19386
  required: string[];
19366
19387
  type: string;
19388
+ description?: never;
19367
19389
  } | {
19390
+ description: string;
19368
19391
  properties: {
19369
19392
  assa_abloy_credential_service_metadata: {
19370
19393
  description: string;
@@ -23370,47 +23393,6 @@ declare const _default: {
23370
23393
  phone: {
23371
23394
  description: string;
23372
23395
  properties: {
23373
- can_hvac_cool: {
23374
- type: string;
23375
- };
23376
- can_hvac_heat: {
23377
- type: string;
23378
- };
23379
- can_hvac_heat_cool: {
23380
- type: string;
23381
- };
23382
- can_program_offline_access_codes: {
23383
- type: string;
23384
- };
23385
- can_program_online_access_codes: {
23386
- type: string;
23387
- };
23388
- can_remotely_lock: {
23389
- type: string;
23390
- };
23391
- can_remotely_unlock: {
23392
- type: string;
23393
- };
23394
- can_simulate_connection: {
23395
- type: string;
23396
- };
23397
- can_simulate_disconnection: {
23398
- type: string;
23399
- };
23400
- can_simulate_removal: {
23401
- type: string;
23402
- };
23403
- can_turn_off_hvac: {
23404
- type: string;
23405
- };
23406
- capabilities_supported: {
23407
- description: string;
23408
- items: {
23409
- enum: string[];
23410
- type: string;
23411
- };
23412
- type: string;
23413
- };
23414
23396
  created_at: {
23415
23397
  description: string;
23416
23398
  format: string;
@@ -23422,6 +23404,7 @@ declare const _default: {
23422
23404
  type: string;
23423
23405
  }[];
23424
23406
  };
23407
+ description: string;
23425
23408
  type: string;
23426
23409
  };
23427
23410
  device_id: {
@@ -23441,68 +23424,16 @@ declare const _default: {
23441
23424
  errors: {
23442
23425
  description: string;
23443
23426
  items: {
23444
- discriminator: {
23445
- propertyName: string;
23446
- };
23447
- oneOf: ({
23448
- description: string;
23449
- properties: {
23450
- error_code: {
23451
- description: string;
23452
- enum: string[];
23453
- type: string;
23454
- };
23455
- is_device_error: {
23456
- enum: boolean[];
23457
- type: string;
23458
- };
23459
- message: {
23460
- type: string;
23461
- };
23462
- is_connected_account_error?: never;
23427
+ properties: {
23428
+ error_code: {
23429
+ type: string;
23463
23430
  };
23464
- required: string[];
23465
- type: string;
23466
- } | {
23467
- description: string;
23468
- properties: {
23469
- error_code: {
23470
- description: string;
23471
- enum: string[];
23472
- type: string;
23473
- };
23474
- is_connected_account_error: {
23475
- enum: boolean[];
23476
- type: string;
23477
- };
23478
- message: {
23479
- type: string;
23480
- };
23481
- is_device_error?: never;
23431
+ message: {
23432
+ type: string;
23482
23433
  };
23483
- required: string[];
23484
- type: string;
23485
- })[];
23486
- };
23487
- type: string;
23488
- };
23489
- is_managed: {
23490
- description: string;
23491
- enum: boolean[];
23492
- type: string;
23493
- };
23494
- location: {
23495
- description: string;
23496
- nullable: boolean;
23497
- properties: {
23498
- location_name: {
23499
- description: string;
23500
- type: string;
23501
- };
23502
- timezone: {
23503
- description: string;
23504
- type: string;
23505
23434
  };
23435
+ required: string[];
23436
+ type: string;
23506
23437
  };
23507
23438
  type: string;
23508
23439
  };
@@ -23511,6 +23442,7 @@ declare const _default: {
23511
23442
  type: string;
23512
23443
  };
23513
23444
  properties: {
23445
+ description: string;
23514
23446
  properties: {
23515
23447
  assa_abloy_credential_service_metadata: {
23516
23448
  description: string;
@@ -23558,24 +23490,16 @@ declare const _default: {
23558
23490
  warnings: {
23559
23491
  description: string;
23560
23492
  items: {
23561
- discriminator: {
23562
- propertyName: string;
23563
- };
23564
- oneOf: {
23565
- description: string;
23566
- properties: {
23567
- message: {
23568
- type: string;
23569
- };
23570
- warning_code: {
23571
- description: string;
23572
- enum: string[];
23573
- type: string;
23574
- };
23493
+ properties: {
23494
+ message: {
23495
+ type: string;
23575
23496
  };
23576
- required: string[];
23577
- type: string;
23578
- }[];
23497
+ warning_code: {
23498
+ type: string;
23499
+ };
23500
+ };
23501
+ required: string[];
23502
+ type: string;
23579
23503
  };
23580
23504
  type: string;
23581
23505
  };
@@ -24355,10 +24279,15 @@ declare const _default: {
24355
24279
  };
24356
24280
  device_type: {
24357
24281
  description: string;
24358
- oneOf: {
24282
+ oneOf: ({
24283
+ enum: string[];
24284
+ type: string;
24285
+ description?: never;
24286
+ } | {
24287
+ description: string;
24359
24288
  enum: string[];
24360
24289
  type: string;
24361
- }[];
24290
+ })[];
24362
24291
  };
24363
24292
  errors: {
24364
24293
  description: string;
@@ -31365,6 +31294,90 @@ declare const _default: {
31365
31294
  'x-response-key': string;
31366
31295
  };
31367
31296
  };
31297
+ '/bridges/get': {
31298
+ post: {
31299
+ operationId: string;
31300
+ requestBody: {
31301
+ content: {
31302
+ 'application/json': {
31303
+ schema: {
31304
+ properties: {
31305
+ bridge_id: {
31306
+ format: string;
31307
+ type: string;
31308
+ };
31309
+ };
31310
+ required: string[];
31311
+ type: string;
31312
+ };
31313
+ };
31314
+ };
31315
+ };
31316
+ responses: {
31317
+ 200: {
31318
+ content: {
31319
+ 'application/json': {
31320
+ schema: {
31321
+ properties: {
31322
+ bridge: {
31323
+ properties: {
31324
+ bridge_id: {
31325
+ format: string;
31326
+ type: string;
31327
+ };
31328
+ created_at: {
31329
+ format: string;
31330
+ type: string;
31331
+ };
31332
+ workspace_id: {
31333
+ format: string;
31334
+ type: string;
31335
+ };
31336
+ };
31337
+ required: string[];
31338
+ type: string;
31339
+ 'x-route-path': string;
31340
+ 'x-undocumented': string;
31341
+ };
31342
+ ok: {
31343
+ type: string;
31344
+ };
31345
+ };
31346
+ required: string[];
31347
+ type: string;
31348
+ };
31349
+ };
31350
+ };
31351
+ description: string;
31352
+ };
31353
+ 400: {
31354
+ description: string;
31355
+ };
31356
+ 401: {
31357
+ description: string;
31358
+ };
31359
+ };
31360
+ security: ({
31361
+ pat_with_workspace: never[];
31362
+ console_session_with_workspace?: never;
31363
+ api_key?: never;
31364
+ } | {
31365
+ console_session_with_workspace: never[];
31366
+ pat_with_workspace?: never;
31367
+ api_key?: never;
31368
+ } | {
31369
+ api_key: never[];
31370
+ pat_with_workspace?: never;
31371
+ console_session_with_workspace?: never;
31372
+ })[];
31373
+ summary: string;
31374
+ tags: never[];
31375
+ 'x-fern-sdk-group-name': string[];
31376
+ 'x-fern-sdk-method-name': string;
31377
+ 'x-fern-sdk-return-value': string;
31378
+ 'x-response-key': string;
31379
+ };
31380
+ };
31368
31381
  '/client_sessions/create': {
31369
31382
  post: {
31370
31383
  operationId: string;
@@ -32947,18 +32960,28 @@ declare const _default: {
32947
32960
  };
32948
32961
  device_type: {
32949
32962
  description: string;
32950
- oneOf: {
32963
+ oneOf: ({
32964
+ enum: string[];
32965
+ type: string;
32966
+ description?: never;
32967
+ } | {
32968
+ description: string;
32951
32969
  enum: string[];
32952
32970
  type: string;
32953
- }[];
32971
+ })[];
32954
32972
  };
32955
32973
  device_types: {
32956
32974
  description: string;
32957
32975
  items: {
32958
- oneOf: {
32976
+ oneOf: ({
32959
32977
  enum: string[];
32960
32978
  type: string;
32961
- }[];
32979
+ description?: never;
32980
+ } | {
32981
+ description: string;
32982
+ enum: string[];
32983
+ type: string;
32984
+ })[];
32962
32985
  };
32963
32986
  type: string;
32964
32987
  };
@@ -33452,18 +33475,28 @@ declare const _default: {
33452
33475
  };
33453
33476
  device_type: {
33454
33477
  description: string;
33455
- oneOf: {
33478
+ oneOf: ({
33479
+ enum: string[];
33480
+ type: string;
33481
+ description?: never;
33482
+ } | {
33483
+ description: string;
33456
33484
  enum: string[];
33457
33485
  type: string;
33458
- }[];
33486
+ })[];
33459
33487
  };
33460
33488
  device_types: {
33461
33489
  description: string;
33462
33490
  items: {
33463
- oneOf: {
33491
+ oneOf: ({
33464
33492
  enum: string[];
33465
33493
  type: string;
33466
- }[];
33494
+ description?: never;
33495
+ } | {
33496
+ description: string;
33497
+ enum: string[];
33498
+ type: string;
33499
+ })[];
33467
33500
  };
33468
33501
  type: string;
33469
33502
  };
@@ -34251,18 +34284,28 @@ declare const _default: {
34251
34284
  };
34252
34285
  device_type: {
34253
34286
  description: string;
34254
- oneOf: {
34287
+ oneOf: ({
34255
34288
  enum: string[];
34256
34289
  type: string;
34257
- }[];
34290
+ description?: never;
34291
+ } | {
34292
+ description: string;
34293
+ enum: string[];
34294
+ type: string;
34295
+ })[];
34258
34296
  };
34259
34297
  device_types: {
34260
34298
  description: string;
34261
34299
  items: {
34262
- oneOf: {
34300
+ oneOf: ({
34263
34301
  enum: string[];
34264
34302
  type: string;
34265
- }[];
34303
+ description?: never;
34304
+ } | {
34305
+ description: string;
34306
+ enum: string[];
34307
+ type: string;
34308
+ })[];
34266
34309
  };
34267
34310
  type: string;
34268
34311
  };
@@ -34709,18 +34752,28 @@ declare const _default: {
34709
34752
  };
34710
34753
  device_type: {
34711
34754
  description: string;
34712
- oneOf: {
34755
+ oneOf: ({
34756
+ enum: string[];
34757
+ type: string;
34758
+ description?: never;
34759
+ } | {
34760
+ description: string;
34713
34761
  enum: string[];
34714
34762
  type: string;
34715
- }[];
34763
+ })[];
34716
34764
  };
34717
34765
  device_types: {
34718
34766
  description: string;
34719
34767
  items: {
34720
- oneOf: {
34768
+ oneOf: ({
34721
34769
  enum: string[];
34722
34770
  type: string;
34723
- }[];
34771
+ description?: never;
34772
+ } | {
34773
+ description: string;
34774
+ enum: string[];
34775
+ type: string;
34776
+ })[];
34724
34777
  };
34725
34778
  type: string;
34726
34779
  };
@@ -36448,18 +36501,28 @@ declare const _default: {
36448
36501
  };
36449
36502
  device_type: {
36450
36503
  description: string;
36451
- oneOf: {
36504
+ oneOf: ({
36505
+ enum: string[];
36506
+ type: string;
36507
+ description?: never;
36508
+ } | {
36509
+ description: string;
36452
36510
  enum: string[];
36453
36511
  type: string;
36454
- }[];
36512
+ })[];
36455
36513
  };
36456
36514
  device_types: {
36457
36515
  description: string;
36458
36516
  items: {
36459
- oneOf: {
36517
+ oneOf: ({
36460
36518
  enum: string[];
36461
36519
  type: string;
36462
- }[];
36520
+ description?: never;
36521
+ } | {
36522
+ description: string;
36523
+ enum: string[];
36524
+ type: string;
36525
+ })[];
36463
36526
  };
36464
36527
  type: string;
36465
36528
  };
@@ -53120,6 +53183,24 @@ interface Routes {
53120
53183
  }>;
53121
53184
  };
53122
53185
  };
53186
+ '/bridges/get': {
53187
+ route: '/bridges/get';
53188
+ method: 'GET' | 'POST';
53189
+ queryParams: {};
53190
+ jsonBody: {};
53191
+ commonParams: {
53192
+ bridge_id: string;
53193
+ };
53194
+ formData: {};
53195
+ jsonResponse: {
53196
+ /** */
53197
+ bridge: {
53198
+ bridge_id: string;
53199
+ workspace_id: string;
53200
+ created_at: string;
53201
+ };
53202
+ };
53203
+ };
53123
53204
  '/client_sessions/create': {
53124
53205
  route: '/client_sessions/create';
53125
53206
  method: 'POST' | 'PUT';
@@ -66428,16 +66509,31 @@ interface Routes {
66428
66509
  formData: {};
66429
66510
  jsonResponse: {
66430
66511
  phones: Array<{
66431
- /** Unique identifier for the device. */
66512
+ /** ID of the `phone`. */
66432
66513
  device_id: string;
66433
- /** Type of phone. */
66434
- device_type: 'android_phone' | 'ios_phone';
66435
- /** Optional nickname to describe the device, settable through Seam */
66514
+ /** Optional nickname to describe the phone, settable through Seam. */
66436
66515
  nickname?: string | undefined;
66437
- /** Display name of the device, defaults to nickname (if it is set) or properties.appearance.name otherwise. Enables administrators and users to identify the device easily, especially when there are numerous devices. */
66516
+ /** Display name of the phone. Defaults to `nickname` (if it is set) or `properties.appearance.name` otherwise. Enables administrators and users to identify the phone easily, especially when there are numerous phones. */
66438
66517
  display_name: string;
66439
- /** 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; and "battery," which indicates that the device can manage battery life and health. */
66440
- capabilities_supported: Array<'access_code' | 'lock' | 'noise_detection' | 'thermostat' | 'battery' | 'phone'>;
66518
+ /** ID of the [workspace](https://docs.seam.co/latest/core-concepts/workspaces) that contains the `phone`. */
66519
+ workspace_id: string;
66520
+ /** Date and time at which the `phone` was created. */
66521
+ created_at: string;
66522
+ /** Optional [custom metadata](https://docs.seam.co/latest/core-concepts/devices/adding-custom-metadata-to-a-device) for the phone. */
66523
+ custom_metadata: Record<string, string | boolean>;
66524
+ /** Errors associated with the `phone`. */
66525
+ errors: Array<{
66526
+ error_code: string;
66527
+ message: string;
66528
+ }>;
66529
+ /** Warnings associated with the `phone`. */
66530
+ warnings: Array<{
66531
+ warning_code: string;
66532
+ message: string;
66533
+ }>;
66534
+ /** Type of phone. */
66535
+ device_type: 'ios_phone' | 'android_phone';
66536
+ /** Properties of the phone. */
66441
66537
  properties: {
66442
66538
  /** ASSA ABLOY Credential Service metadata for the phone. */
66443
66539
  assa_abloy_credential_service_metadata?: {
@@ -66457,169 +66553,6 @@ interface Routes {
66457
66553
  has_active_phone: boolean;
66458
66554
  } | undefined;
66459
66555
  };
66460
- /** Location information for the device. */
66461
- location: {
66462
- /** Name of the device location. */
66463
- location_name?: string | undefined;
66464
- /** Time zone of the device location. */
66465
- timezone?: string | undefined;
66466
- } | null;
66467
- /** Unique identifier for the Seam workspace associated with the device. */
66468
- workspace_id: string;
66469
- /** Array of errors associated with the device. Each error object within the array contains two fields: "error_code" and "message." "error_code" is a string that uniquely identifies the type of error, enabling quick recognition and categorization of the issue. "message" provides a more detailed description of the error, offering insights into the issue and potentially how to rectify it. */
66470
- errors: Array<{
66471
- message: string;
66472
- is_device_error: true;
66473
- /** Unique identifier of the type of error. Enables quick recognition and categorization of the issue. */
66474
- error_code: 'device_offline';
66475
- } | {
66476
- message: string;
66477
- is_device_error: true;
66478
- /** Unique identifier of the type of error. Enables quick recognition and categorization of the issue. */
66479
- error_code: 'device_removed';
66480
- } | {
66481
- message: string;
66482
- is_device_error: true;
66483
- /** Unique identifier of the type of error. Enables quick recognition and categorization of the issue. */
66484
- error_code: 'hub_disconnected';
66485
- } | {
66486
- message: string;
66487
- is_device_error: true;
66488
- /** Unique identifier of the type of error. Enables quick recognition and categorization of the issue. */
66489
- error_code: 'device_disconnected';
66490
- } | {
66491
- message: string;
66492
- is_device_error: true;
66493
- /** Unique identifier of the type of error. Enables quick recognition and categorization of the issue. */
66494
- error_code: 'empty_backup_access_code_pool';
66495
- } | {
66496
- message: string;
66497
- is_device_error: true;
66498
- /** Unique identifier of the type of error. Enables quick recognition and categorization of the issue. */
66499
- error_code: 'august_lock_not_authorized';
66500
- } | {
66501
- message: string;
66502
- is_device_error: true;
66503
- /** Unique identifier of the type of error. Enables quick recognition and categorization of the issue. */
66504
- error_code: 'august_lock_missing_bridge';
66505
- } | {
66506
- message: string;
66507
- is_device_error: true;
66508
- /** Unique identifier of the type of error. Enables quick recognition and categorization of the issue. */
66509
- error_code: 'salto_site_user_limit_reached';
66510
- } | {
66511
- message: string;
66512
- is_device_error: true;
66513
- /** Unique identifier of the type of error. Enables quick recognition and categorization of the issue. */
66514
- error_code: 'ttlock_lock_not_paired_to_gateway';
66515
- } | {
66516
- message: string;
66517
- is_device_error: true;
66518
- /** Unique identifier of the type of error. Enables quick recognition and categorization of the issue. */
66519
- error_code: 'missing_device_credentials';
66520
- } | {
66521
- message: string;
66522
- is_device_error: true;
66523
- /** Unique identifier of the type of error. Enables quick recognition and categorization of the issue. */
66524
- error_code: 'auxiliary_heat_running';
66525
- } | {
66526
- message: string;
66527
- is_device_error: true;
66528
- /** Unique identifier of the type of error. Enables quick recognition and categorization of the issue. */
66529
- error_code: 'subscription_required';
66530
- } | {
66531
- message: string;
66532
- is_connected_account_error: true;
66533
- /** Unique identifier of the type of error. Enables quick recognition and categorization of the issue. */
66534
- error_code: 'account_disconnected';
66535
- } | {
66536
- message: string;
66537
- is_connected_account_error: true;
66538
- /** Unique identifier of the type of error. Enables quick recognition and categorization of the issue. */
66539
- error_code: 'invalid_credentials';
66540
- }>;
66541
- /** Array of warnings associated with the device. Each warning object within the array contains two fields: "warning_code" and "message." "warning_code" is a string that uniquely identifies the type of warning, enabling quick recognition and categorization of the issue. "message" provides a more detailed description of the warning, offering insights into the issue and potentially how to rectify it. */
66542
- warnings: Array<{
66543
- message: string;
66544
- /** Unique identifier of the type of warning. Enables quick recognition and categorization of the issue. */
66545
- warning_code: 'partial_backup_access_code_pool';
66546
- } | {
66547
- message: string;
66548
- /** Unique identifier of the type of warning. Enables quick recognition and categorization of the issue. */
66549
- warning_code: 'many_active_backup_codes';
66550
- } | {
66551
- message: string;
66552
- /** Unique identifier of the type of warning. Enables quick recognition and categorization of the issue. */
66553
- warning_code: 'salto_unknown_device_type';
66554
- } | {
66555
- message: string;
66556
- /** Unique identifier of the type of warning. Enables quick recognition and categorization of the issue. */
66557
- warning_code: 'wyze_device_missing_gateway';
66558
- } | {
66559
- message: string;
66560
- /** Unique identifier of the type of warning. Enables quick recognition and categorization of the issue. */
66561
- warning_code: 'functional_offline_device';
66562
- } | {
66563
- message: string;
66564
- /** Unique identifier of the type of warning. Enables quick recognition and categorization of the issue. */
66565
- warning_code: 'third_party_integration_detected';
66566
- } | {
66567
- message: string;
66568
- /** Unique identifier of the type of warning. Enables quick recognition and categorization of the issue. */
66569
- warning_code: 'nest_thermostat_in_manual_eco_mode';
66570
- } | {
66571
- message: string;
66572
- /** Unique identifier of the type of warning. Enables quick recognition and categorization of the issue. */
66573
- warning_code: 'ttlock_lock_gateway_unlocking_not_enabled';
66574
- } | {
66575
- message: string;
66576
- /** Unique identifier of the type of warning. Enables quick recognition and categorization of the issue. */
66577
- warning_code: 'ttlock_weak_gateway_signal';
66578
- } | {
66579
- message: string;
66580
- /** Unique identifier of the type of warning. Enables quick recognition and categorization of the issue. */
66581
- warning_code: 'temperature_threshold_exceeded';
66582
- } | {
66583
- message: string;
66584
- /** Unique identifier of the type of warning. Enables quick recognition and categorization of the issue. */
66585
- warning_code: 'device_communication_degraded';
66586
- } | {
66587
- message: string;
66588
- /** Unique identifier of the type of warning. Enables quick recognition and categorization of the issue. */
66589
- warning_code: 'scheduled_maintenance_window';
66590
- } | {
66591
- message: string;
66592
- /** Unique identifier of the type of warning. Enables quick recognition and categorization of the issue. */
66593
- warning_code: 'device_has_flaky_connection';
66594
- } | {
66595
- message: string;
66596
- /** Unique identifier of the type of warning. Enables quick recognition and categorization of the issue. */
66597
- warning_code: 'salto_office_mode';
66598
- } | {
66599
- message: string;
66600
- /** Unique identifier of the type of warning. Enables quick recognition and categorization of the issue. */
66601
- warning_code: 'salto_privacy_mode';
66602
- } | {
66603
- message: string;
66604
- /** Unique identifier of the type of warning. Enables quick recognition and categorization of the issue. */
66605
- warning_code: 'unknown_issue_with_phone';
66606
- }>;
66607
- /** Date and time at which the device object was created. */
66608
- created_at: string;
66609
- /** Indicates whether Seam manages the device. */
66610
- is_managed: true;
66611
- custom_metadata: Record<string, string | boolean>;
66612
- can_remotely_unlock?: boolean | undefined;
66613
- can_remotely_lock?: boolean | undefined;
66614
- can_program_offline_access_codes?: boolean | undefined;
66615
- can_program_online_access_codes?: boolean | undefined;
66616
- can_hvac_heat?: boolean | undefined;
66617
- can_hvac_cool?: boolean | undefined;
66618
- can_hvac_heat_cool?: boolean | undefined;
66619
- can_turn_off_hvac?: boolean | undefined;
66620
- can_simulate_removal?: boolean | undefined;
66621
- can_simulate_connection?: boolean | undefined;
66622
- can_simulate_disconnection?: boolean | undefined;
66623
66556
  }>;
66624
66557
  };
66625
66558
  };
@@ -66662,18 +66595,33 @@ interface Routes {
66662
66595
  commonParams: {};
66663
66596
  formData: {};
66664
66597
  jsonResponse: {
66665
- /** Properties of the phone. */
66598
+ /** Represents an app user's mobile phone. */
66666
66599
  phone: {
66667
- /** Unique identifier for the device. */
66600
+ /** ID of the `phone`. */
66668
66601
  device_id: string;
66669
- /** Type of phone. */
66670
- device_type: 'android_phone' | 'ios_phone';
66671
- /** Optional nickname to describe the device, settable through Seam */
66602
+ /** Optional nickname to describe the phone, settable through Seam. */
66672
66603
  nickname?: string | undefined;
66673
- /** Display name of the device, defaults to nickname (if it is set) or properties.appearance.name otherwise. Enables administrators and users to identify the device easily, especially when there are numerous devices. */
66604
+ /** Display name of the phone. Defaults to `nickname` (if it is set) or `properties.appearance.name` otherwise. Enables administrators and users to identify the phone easily, especially when there are numerous phones. */
66674
66605
  display_name: string;
66675
- /** 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; and "battery," which indicates that the device can manage battery life and health. */
66676
- capabilities_supported: Array<'access_code' | 'lock' | 'noise_detection' | 'thermostat' | 'battery' | 'phone'>;
66606
+ /** ID of the [workspace](https://docs.seam.co/latest/core-concepts/workspaces) that contains the `phone`. */
66607
+ workspace_id: string;
66608
+ /** Date and time at which the `phone` was created. */
66609
+ created_at: string;
66610
+ /** Optional [custom metadata](https://docs.seam.co/latest/core-concepts/devices/adding-custom-metadata-to-a-device) for the phone. */
66611
+ custom_metadata: Record<string, string | boolean>;
66612
+ /** Errors associated with the `phone`. */
66613
+ errors: Array<{
66614
+ error_code: string;
66615
+ message: string;
66616
+ }>;
66617
+ /** Warnings associated with the `phone`. */
66618
+ warnings: Array<{
66619
+ warning_code: string;
66620
+ message: string;
66621
+ }>;
66622
+ /** Type of phone. */
66623
+ device_type: 'ios_phone' | 'android_phone';
66624
+ /** Properties of the phone. */
66677
66625
  properties: {
66678
66626
  /** ASSA ABLOY Credential Service metadata for the phone. */
66679
66627
  assa_abloy_credential_service_metadata?: {
@@ -66693,169 +66641,6 @@ interface Routes {
66693
66641
  has_active_phone: boolean;
66694
66642
  } | undefined;
66695
66643
  };
66696
- /** Location information for the device. */
66697
- location: {
66698
- /** Name of the device location. */
66699
- location_name?: string | undefined;
66700
- /** Time zone of the device location. */
66701
- timezone?: string | undefined;
66702
- } | null;
66703
- /** Unique identifier for the Seam workspace associated with the device. */
66704
- workspace_id: string;
66705
- /** Array of errors associated with the device. Each error object within the array contains two fields: "error_code" and "message." "error_code" is a string that uniquely identifies the type of error, enabling quick recognition and categorization of the issue. "message" provides a more detailed description of the error, offering insights into the issue and potentially how to rectify it. */
66706
- errors: Array<{
66707
- message: string;
66708
- is_device_error: true;
66709
- /** Unique identifier of the type of error. Enables quick recognition and categorization of the issue. */
66710
- error_code: 'device_offline';
66711
- } | {
66712
- message: string;
66713
- is_device_error: true;
66714
- /** Unique identifier of the type of error. Enables quick recognition and categorization of the issue. */
66715
- error_code: 'device_removed';
66716
- } | {
66717
- message: string;
66718
- is_device_error: true;
66719
- /** Unique identifier of the type of error. Enables quick recognition and categorization of the issue. */
66720
- error_code: 'hub_disconnected';
66721
- } | {
66722
- message: string;
66723
- is_device_error: true;
66724
- /** Unique identifier of the type of error. Enables quick recognition and categorization of the issue. */
66725
- error_code: 'device_disconnected';
66726
- } | {
66727
- message: string;
66728
- is_device_error: true;
66729
- /** Unique identifier of the type of error. Enables quick recognition and categorization of the issue. */
66730
- error_code: 'empty_backup_access_code_pool';
66731
- } | {
66732
- message: string;
66733
- is_device_error: true;
66734
- /** Unique identifier of the type of error. Enables quick recognition and categorization of the issue. */
66735
- error_code: 'august_lock_not_authorized';
66736
- } | {
66737
- message: string;
66738
- is_device_error: true;
66739
- /** Unique identifier of the type of error. Enables quick recognition and categorization of the issue. */
66740
- error_code: 'august_lock_missing_bridge';
66741
- } | {
66742
- message: string;
66743
- is_device_error: true;
66744
- /** Unique identifier of the type of error. Enables quick recognition and categorization of the issue. */
66745
- error_code: 'salto_site_user_limit_reached';
66746
- } | {
66747
- message: string;
66748
- is_device_error: true;
66749
- /** Unique identifier of the type of error. Enables quick recognition and categorization of the issue. */
66750
- error_code: 'ttlock_lock_not_paired_to_gateway';
66751
- } | {
66752
- message: string;
66753
- is_device_error: true;
66754
- /** Unique identifier of the type of error. Enables quick recognition and categorization of the issue. */
66755
- error_code: 'missing_device_credentials';
66756
- } | {
66757
- message: string;
66758
- is_device_error: true;
66759
- /** Unique identifier of the type of error. Enables quick recognition and categorization of the issue. */
66760
- error_code: 'auxiliary_heat_running';
66761
- } | {
66762
- message: string;
66763
- is_device_error: true;
66764
- /** Unique identifier of the type of error. Enables quick recognition and categorization of the issue. */
66765
- error_code: 'subscription_required';
66766
- } | {
66767
- message: string;
66768
- is_connected_account_error: true;
66769
- /** Unique identifier of the type of error. Enables quick recognition and categorization of the issue. */
66770
- error_code: 'account_disconnected';
66771
- } | {
66772
- message: string;
66773
- is_connected_account_error: true;
66774
- /** Unique identifier of the type of error. Enables quick recognition and categorization of the issue. */
66775
- error_code: 'invalid_credentials';
66776
- }>;
66777
- /** Array of warnings associated with the device. Each warning object within the array contains two fields: "warning_code" and "message." "warning_code" is a string that uniquely identifies the type of warning, enabling quick recognition and categorization of the issue. "message" provides a more detailed description of the warning, offering insights into the issue and potentially how to rectify it. */
66778
- warnings: Array<{
66779
- message: string;
66780
- /** Unique identifier of the type of warning. Enables quick recognition and categorization of the issue. */
66781
- warning_code: 'partial_backup_access_code_pool';
66782
- } | {
66783
- message: string;
66784
- /** Unique identifier of the type of warning. Enables quick recognition and categorization of the issue. */
66785
- warning_code: 'many_active_backup_codes';
66786
- } | {
66787
- message: string;
66788
- /** Unique identifier of the type of warning. Enables quick recognition and categorization of the issue. */
66789
- warning_code: 'salto_unknown_device_type';
66790
- } | {
66791
- message: string;
66792
- /** Unique identifier of the type of warning. Enables quick recognition and categorization of the issue. */
66793
- warning_code: 'wyze_device_missing_gateway';
66794
- } | {
66795
- message: string;
66796
- /** Unique identifier of the type of warning. Enables quick recognition and categorization of the issue. */
66797
- warning_code: 'functional_offline_device';
66798
- } | {
66799
- message: string;
66800
- /** Unique identifier of the type of warning. Enables quick recognition and categorization of the issue. */
66801
- warning_code: 'third_party_integration_detected';
66802
- } | {
66803
- message: string;
66804
- /** Unique identifier of the type of warning. Enables quick recognition and categorization of the issue. */
66805
- warning_code: 'nest_thermostat_in_manual_eco_mode';
66806
- } | {
66807
- message: string;
66808
- /** Unique identifier of the type of warning. Enables quick recognition and categorization of the issue. */
66809
- warning_code: 'ttlock_lock_gateway_unlocking_not_enabled';
66810
- } | {
66811
- message: string;
66812
- /** Unique identifier of the type of warning. Enables quick recognition and categorization of the issue. */
66813
- warning_code: 'ttlock_weak_gateway_signal';
66814
- } | {
66815
- message: string;
66816
- /** Unique identifier of the type of warning. Enables quick recognition and categorization of the issue. */
66817
- warning_code: 'temperature_threshold_exceeded';
66818
- } | {
66819
- message: string;
66820
- /** Unique identifier of the type of warning. Enables quick recognition and categorization of the issue. */
66821
- warning_code: 'device_communication_degraded';
66822
- } | {
66823
- message: string;
66824
- /** Unique identifier of the type of warning. Enables quick recognition and categorization of the issue. */
66825
- warning_code: 'scheduled_maintenance_window';
66826
- } | {
66827
- message: string;
66828
- /** Unique identifier of the type of warning. Enables quick recognition and categorization of the issue. */
66829
- warning_code: 'device_has_flaky_connection';
66830
- } | {
66831
- message: string;
66832
- /** Unique identifier of the type of warning. Enables quick recognition and categorization of the issue. */
66833
- warning_code: 'salto_office_mode';
66834
- } | {
66835
- message: string;
66836
- /** Unique identifier of the type of warning. Enables quick recognition and categorization of the issue. */
66837
- warning_code: 'salto_privacy_mode';
66838
- } | {
66839
- message: string;
66840
- /** Unique identifier of the type of warning. Enables quick recognition and categorization of the issue. */
66841
- warning_code: 'unknown_issue_with_phone';
66842
- }>;
66843
- /** Date and time at which the device object was created. */
66844
- created_at: string;
66845
- /** Indicates whether Seam manages the device. */
66846
- is_managed: true;
66847
- custom_metadata: Record<string, string | boolean>;
66848
- can_remotely_unlock?: boolean | undefined;
66849
- can_remotely_lock?: boolean | undefined;
66850
- can_program_offline_access_codes?: boolean | undefined;
66851
- can_program_online_access_codes?: boolean | undefined;
66852
- can_hvac_heat?: boolean | undefined;
66853
- can_hvac_cool?: boolean | undefined;
66854
- can_hvac_heat_cool?: boolean | undefined;
66855
- can_turn_off_hvac?: boolean | undefined;
66856
- can_simulate_removal?: boolean | undefined;
66857
- can_simulate_connection?: boolean | undefined;
66858
- can_simulate_disconnection?: boolean | undefined;
66859
66644
  };
66860
66645
  };
66861
66646
  };
@@ -78194,4 +77979,4 @@ type RouteRequestParams<Path extends keyof Routes> = Routes[Path]['queryParams']
78194
77979
 
78195
77980
  declare const routes: {};
78196
77981
 
78197
- export { type AccessCode, type AccessCodeError, type AccessCodeWarning, type AcsAccessGroup, type AcsCredential, type AcsEncoder, type AcsEntrance, type AcsSystem, type AcsUser, type ActionAttempt, type ClientSession, type ConnectWebview, type ConnectedAccount, type ConnectedAccountError, type ConnectedAccountWarning, type CustomMetadata, type Device, type DeviceError, type DeviceProvider, type DeviceWarning, type NoiseThreshold, type RouteRequestBody, type RouteRequestParams, type RouteResponse, type Routes, type SeamEvent, type SeamEventType, type ThermostatSchedule, type UnmanagedAccessCode, type UnmanagedDevice, type UserIdentity, type Webhook, type Workspace, _default as openapi, routes, schemas };
77982
+ export { type AccessCode, type AccessCodeError, type AccessCodeWarning, type AcsAccessGroup, type AcsCredential, type AcsEncoder, type AcsEntrance, type AcsSystem, type AcsUser, type ActionAttempt, type Bridge, type ClientSession, type ConnectWebview, type ConnectedAccount, type ConnectedAccountError, type ConnectedAccountWarning, type CustomMetadata, type Device, type DeviceError, type DeviceProvider, type DeviceWarning, type NoiseThreshold, type RouteRequestBody, type RouteRequestParams, type RouteResponse, type Routes, type SeamEvent, type SeamEventType, type ThermostatSchedule, type UnmanagedAccessCode, type UnmanagedDevice, type UserIdentity, type Webhook, type Workspace, _default as openapi, routes, schemas };