@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
@@ -5048,7 +5048,11 @@ export default {
5048
5048
  ],
5049
5049
  type: 'string',
5050
5050
  },
5051
- { enum: ['ios_phone', 'android_phone'], type: 'string' },
5051
+ {
5052
+ description: 'Type of phone.',
5053
+ enum: ['ios_phone', 'android_phone'],
5054
+ type: 'string',
5055
+ },
5052
5056
  ],
5053
5057
  },
5054
5058
  display_name: {
@@ -5466,6 +5470,7 @@ export default {
5466
5470
  type: 'object',
5467
5471
  },
5468
5472
  {
5473
+ description: 'Properties of the phone.',
5469
5474
  properties: {
5470
5475
  assa_abloy_credential_service_metadata: {
5471
5476
  description: 'ASSA ABLOY Credential Service metadata for the phone.',
@@ -10876,661 +10881,202 @@ export default {
10876
10881
  ],
10877
10882
  type: 'object',
10878
10883
  'x-route-path': '/user_identities/enrollment_automations',
10879
- },
10880
- {
10881
- description: 'A phone device was deactivated.',
10882
- properties: {
10883
- created_at: {
10884
- description: 'Date and time at which the event was created.',
10885
- format: 'date-time',
10886
- type: 'string',
10887
- },
10888
- device_id: {
10889
- description: 'ID of the [device](https://docs.seam.co/latest/core-concepts/devices).',
10890
- format: 'uuid',
10891
- type: 'string',
10892
- },
10893
- event_id: {
10894
- description: 'ID of the event.',
10895
- format: 'uuid',
10896
- type: 'string',
10897
- },
10898
- event_type: { enum: ['phone.deactivated'], type: 'string' },
10899
- occurred_at: {
10900
- description: 'Date and time at which the event occurred.',
10901
- format: 'date-time',
10902
- type: 'string',
10903
- },
10904
- workspace_id: {
10905
- description: 'ID of the [workspace](https://docs.seam.co/latest/core-concepts/workspaces).',
10906
- format: 'uuid',
10907
- type: 'string',
10908
- },
10909
- },
10910
- required: [
10911
- 'event_id',
10912
- 'workspace_id',
10913
- 'created_at',
10914
- 'occurred_at',
10915
- 'device_id',
10916
- 'event_type',
10917
- ],
10918
- type: 'object',
10919
- 'x-route-path': '/phones',
10920
- },
10921
- ],
10922
- 'x-route-path': '/events',
10923
- },
10924
- network: {
10925
- properties: {
10926
- created_at: { format: 'date-time', type: 'string' },
10927
- display_name: { type: 'string' },
10928
- network_id: { format: 'uuid', type: 'string' },
10929
- workspace_id: { format: 'uuid', type: 'string' },
10930
- },
10931
- required: ['network_id', 'workspace_id', 'display_name', 'created_at'],
10932
- type: 'object',
10933
- 'x-route-path': '/networks',
10934
- },
10935
- noise_threshold: {
10936
- properties: {
10937
- device_id: { format: 'uuid', type: 'string' },
10938
- ends_daily_at: { type: 'string' },
10939
- name: { type: 'string' },
10940
- noise_threshold_decibels: { format: 'float', type: 'number' },
10941
- noise_threshold_id: { format: 'uuid', type: 'string' },
10942
- noise_threshold_nrs: { format: 'float', type: 'number' },
10943
- starts_daily_at: { type: 'string' },
10944
- },
10945
- required: [
10946
- 'noise_threshold_id',
10947
- 'device_id',
10948
- 'name',
10949
- 'starts_daily_at',
10950
- 'ends_daily_at',
10951
- 'noise_threshold_decibels',
10952
- ],
10953
- type: 'object',
10954
- 'x-route-path': '/noise_sensors/noise_thresholds',
10955
- },
10956
- phone: {
10957
- description: 'Properties of the phone.',
10958
- properties: {
10959
- can_hvac_cool: { type: 'boolean' },
10960
- can_hvac_heat: { type: 'boolean' },
10961
- can_hvac_heat_cool: { type: 'boolean' },
10962
- can_program_offline_access_codes: { type: 'boolean' },
10963
- can_program_online_access_codes: { type: 'boolean' },
10964
- can_remotely_lock: { type: 'boolean' },
10965
- can_remotely_unlock: { type: 'boolean' },
10966
- can_simulate_connection: { type: 'boolean' },
10967
- can_simulate_disconnection: { type: 'boolean' },
10968
- can_simulate_removal: { type: 'boolean' },
10969
- can_turn_off_hvac: { type: 'boolean' },
10970
- capabilities_supported: {
10971
- description: '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.',
10972
- items: {
10973
- enum: [
10974
- 'access_code',
10975
- 'lock',
10976
- 'noise_detection',
10977
- 'thermostat',
10978
- 'battery',
10979
- 'phone',
10980
- ],
10981
- type: 'string',
10982
- },
10983
- type: 'array',
10984
- },
10985
- created_at: {
10986
- description: 'Date and time at which the device object was created.',
10987
- format: 'date-time',
10988
- type: 'string',
10989
- },
10990
- custom_metadata: {
10991
- additionalProperties: {
10992
- oneOf: [{ type: 'string' }, { type: 'boolean' }],
10993
- },
10994
- type: 'object',
10995
- },
10996
- device_id: {
10997
- description: 'Unique identifier for the device.',
10998
- format: 'uuid',
10999
- type: 'string',
11000
- },
11001
- device_type: {
11002
- description: 'Type of phone.',
11003
- enum: ['android_phone', 'ios_phone'],
11004
- type: 'string',
11005
- },
11006
- display_name: {
11007
- description: '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.',
11008
- type: 'string',
11009
- },
11010
- errors: {
11011
- description: '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.',
11012
- items: {
11013
- discriminator: { propertyName: 'error_code' },
11014
- oneOf: [
11015
- {
11016
- description: 'Device is offline',
11017
- properties: {
11018
- error_code: {
11019
- description: 'Unique identifier of the type of error. Enables quick recognition and categorization of the issue.',
11020
- enum: ['device_offline'],
11021
- type: 'string',
11022
- },
11023
- is_device_error: { enum: [true], type: 'boolean' },
11024
- message: { type: 'string' },
11025
- },
11026
- required: ['message', 'is_device_error', 'error_code'],
11027
- type: 'object',
11028
- },
11029
- {
11030
- description: 'Device has been removed',
11031
- properties: {
11032
- error_code: {
11033
- description: 'Unique identifier of the type of error. Enables quick recognition and categorization of the issue.',
11034
- enum: ['device_removed'],
11035
- type: 'string',
11036
- },
11037
- is_device_error: { enum: [true], type: 'boolean' },
11038
- message: { type: 'string' },
11039
- },
11040
- required: ['message', 'is_device_error', 'error_code'],
11041
- type: 'object',
11042
- },
11043
- {
11044
- description: 'Hub is disconnected',
11045
- properties: {
11046
- error_code: {
11047
- description: 'Unique identifier of the type of error. Enables quick recognition and categorization of the issue.',
11048
- enum: ['hub_disconnected'],
11049
- type: 'string',
11050
- },
11051
- is_device_error: { enum: [true], type: 'boolean' },
11052
- message: { type: 'string' },
11053
- },
11054
- required: ['message', 'is_device_error', 'error_code'],
11055
- type: 'object',
11056
- },
11057
- {
11058
- description: 'Device is disconnected',
11059
- properties: {
11060
- error_code: {
11061
- description: 'Unique identifier of the type of error. Enables quick recognition and categorization of the issue.',
11062
- enum: ['device_disconnected'],
11063
- type: 'string',
11064
- },
11065
- is_device_error: { enum: [true], type: 'boolean' },
11066
- message: { type: 'string' },
11067
- },
11068
- required: ['message', 'is_device_error', 'error_code'],
11069
- type: 'object',
11070
- },
11071
- {
11072
- description: 'The backup access code pool is empty.',
11073
- properties: {
11074
- error_code: {
11075
- description: 'Unique identifier of the type of error. Enables quick recognition and categorization of the issue.',
11076
- enum: ['empty_backup_access_code_pool'],
11077
- type: 'string',
11078
- },
11079
- is_device_error: { enum: [true], type: 'boolean' },
11080
- message: { type: 'string' },
11081
- },
11082
- required: ['message', 'is_device_error', 'error_code'],
11083
- type: 'object',
11084
- },
11085
- {
11086
- description: 'User is not authorized to use the August Lock.',
11087
- properties: {
11088
- error_code: {
11089
- description: 'Unique identifier of the type of error. Enables quick recognition and categorization of the issue.',
11090
- enum: ['august_lock_not_authorized'],
11091
- type: 'string',
11092
- },
11093
- is_device_error: { enum: [true], type: 'boolean' },
11094
- message: { type: 'string' },
11095
- },
11096
- required: ['message', 'is_device_error', 'error_code'],
11097
- type: 'object',
11098
- },
11099
- {
11100
- description: 'Lock is not connected to the Seam Bridge.',
11101
- properties: {
11102
- error_code: {
11103
- description: 'Unique identifier of the type of error. Enables quick recognition and categorization of the issue.',
11104
- enum: ['august_lock_missing_bridge'],
11105
- type: 'string',
11106
- },
11107
- is_device_error: { enum: [true], type: 'boolean' },
11108
- message: { type: 'string' },
11109
- },
11110
- required: ['message', 'is_device_error', 'error_code'],
11111
- type: 'object',
11112
- },
11113
- {
11114
- description: 'Salto site user limit reached.',
11115
- properties: {
11116
- error_code: {
11117
- description: 'Unique identifier of the type of error. Enables quick recognition and categorization of the issue.',
11118
- enum: ['salto_site_user_limit_reached'],
11119
- type: 'string',
11120
- },
11121
- is_device_error: { enum: [true], type: 'boolean' },
11122
- message: { type: 'string' },
11123
- },
11124
- required: ['message', 'is_device_error', 'error_code'],
11125
- type: 'object',
11126
- },
11127
- {
11128
- description: 'Lock is not paired with a Gateway.',
11129
- properties: {
11130
- error_code: {
11131
- description: 'Unique identifier of the type of error. Enables quick recognition and categorization of the issue.',
11132
- enum: ['ttlock_lock_not_paired_to_gateway'],
11133
- type: 'string',
11134
- },
11135
- is_device_error: { enum: [true], type: 'boolean' },
11136
- message: { type: 'string' },
11137
- },
11138
- required: ['message', 'is_device_error', 'error_code'],
11139
- type: 'object',
11140
- },
11141
- {
11142
- description: 'Missing device credentials.',
11143
- properties: {
11144
- error_code: {
11145
- description: 'Unique identifier of the type of error. Enables quick recognition and categorization of the issue.',
11146
- enum: ['missing_device_credentials'],
11147
- type: 'string',
11148
- },
11149
- is_device_error: { enum: [true], type: 'boolean' },
11150
- message: { type: 'string' },
11151
- },
11152
- required: ['message', 'is_device_error', 'error_code'],
11153
- type: 'object',
11154
- },
11155
- {
11156
- description: 'The auxiliary heat is running.',
11157
- properties: {
11158
- error_code: {
11159
- description: 'Unique identifier of the type of error. Enables quick recognition and categorization of the issue.',
11160
- enum: ['auxiliary_heat_running'],
11161
- type: 'string',
11162
- },
11163
- is_device_error: { enum: [true], type: 'boolean' },
11164
- message: { type: 'string' },
11165
- },
11166
- required: ['message', 'is_device_error', 'error_code'],
11167
- type: 'object',
11168
- },
11169
- {
11170
- description: 'Subscription required to connect.',
11171
- properties: {
11172
- error_code: {
11173
- description: 'Unique identifier of the type of error. Enables quick recognition and categorization of the issue.',
11174
- enum: ['subscription_required'],
11175
- type: 'string',
11176
- },
11177
- is_device_error: { enum: [true], type: 'boolean' },
11178
- message: { type: 'string' },
11179
- },
11180
- required: ['message', 'is_device_error', 'error_code'],
11181
- type: 'object',
11182
- },
11183
- {
11184
- description: 'Account is disconnected.',
11185
- properties: {
11186
- error_code: {
11187
- description: 'Unique identifier of the type of error. Enables quick recognition and categorization of the issue.',
11188
- enum: ['account_disconnected'],
11189
- type: 'string',
11190
- },
11191
- is_connected_account_error: {
11192
- enum: [true],
11193
- type: 'boolean',
11194
- },
11195
- message: { type: 'string' },
11196
- },
11197
- required: [
11198
- 'message',
11199
- 'is_connected_account_error',
11200
- 'error_code',
11201
- ],
11202
- type: 'object',
11203
- },
11204
- {
11205
- description: 'Credentials provided were invalid.',
11206
- properties: {
11207
- error_code: {
11208
- description: 'Unique identifier of the type of error. Enables quick recognition and categorization of the issue.',
11209
- enum: ['invalid_credentials'],
11210
- type: 'string',
11211
- },
11212
- is_connected_account_error: {
11213
- enum: [true],
11214
- type: 'boolean',
11215
- },
11216
- message: { type: 'string' },
11217
- },
11218
- required: [
11219
- 'message',
11220
- 'is_connected_account_error',
11221
- 'error_code',
11222
- ],
11223
- type: 'object',
11224
- },
11225
- ],
11226
- },
11227
- type: 'array',
11228
- },
11229
- is_managed: {
11230
- description: 'Indicates whether Seam manages the device.',
11231
- enum: [true],
11232
- type: 'boolean',
11233
- },
11234
- location: {
11235
- description: 'Location information for the device.',
11236
- nullable: true,
11237
- properties: {
11238
- location_name: {
11239
- description: 'Name of the device location.',
11240
- type: 'string',
11241
- },
11242
- timezone: {
11243
- description: 'Time zone of the device location.',
11244
- type: 'string',
11245
- },
11246
- },
11247
- type: 'object',
11248
- },
11249
- nickname: {
11250
- description: 'Optional nickname to describe the device, settable through Seam',
11251
- type: 'string',
11252
- },
11253
- properties: {
11254
- properties: {
11255
- assa_abloy_credential_service_metadata: {
11256
- description: 'ASSA ABLOY Credential Service metadata for the phone.',
11257
- properties: {
11258
- endpoints: {
11259
- description: 'Endpoints associated with the phone.',
11260
- items: {
11261
- properties: {
11262
- endpoint_id: {
11263
- description: 'ID of the associated endpoint.',
11264
- type: 'string',
11265
- },
11266
- is_active: {
11267
- description: 'Indicated whether the endpoint is active.',
11268
- type: 'boolean',
11269
- },
11270
- },
11271
- required: ['endpoint_id', 'is_active'],
11272
- type: 'object',
11273
- },
11274
- type: 'array',
11275
- },
11276
- has_active_endpoint: {
11277
- description: 'Indicates whether the credential service has active endpoints associated with the phone.',
11278
- type: 'boolean',
11279
- },
11280
- },
11281
- required: ['has_active_endpoint', 'endpoints'],
11282
- type: 'object',
11283
- },
11284
- salto_space_credential_service_metadata: {
11285
- description: 'Salto Space credential service metadata for the phone.',
11286
- properties: {
11287
- has_active_phone: {
11288
- description: 'Indicates whether the credential service has an active associated phone.',
11289
- type: 'boolean',
11290
- },
11291
- },
11292
- required: ['has_active_phone'],
11293
- type: 'object',
11294
- },
11295
- },
11296
- type: 'object',
11297
- },
11298
- warnings: {
11299
- description: '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.',
11300
- items: {
11301
- discriminator: { propertyName: 'warning_code' },
11302
- oneOf: [
11303
- {
11304
- description: 'Backup access code unhealthy.',
11305
- properties: {
11306
- message: { type: 'string' },
11307
- warning_code: {
11308
- description: 'Unique identifier of the type of warning. Enables quick recognition and categorization of the issue.',
11309
- enum: ['partial_backup_access_code_pool'],
11310
- type: 'string',
11311
- },
11312
- },
11313
- required: ['message', 'warning_code'],
11314
- type: 'object',
11315
- },
11316
- {
11317
- description: 'Too many backup codes.',
11318
- properties: {
11319
- message: { type: 'string' },
11320
- warning_code: {
11321
- description: 'Unique identifier of the type of warning. Enables quick recognition and categorization of the issue.',
11322
- enum: ['many_active_backup_codes'],
11323
- type: 'string',
11324
- },
11325
- },
11326
- required: ['message', 'warning_code'],
11327
- type: 'object',
11328
- },
11329
- {
11330
- description: 'A Salto Lock displaying an unknown device type.',
11331
- properties: {
11332
- message: { type: 'string' },
11333
- warning_code: {
11334
- description: 'Unique identifier of the type of warning. Enables quick recognition and categorization of the issue.',
11335
- enum: ['salto_unknown_device_type'],
11336
- type: 'string',
11337
- },
11338
- },
11339
- required: ['message', 'warning_code'],
11340
- type: 'object',
11341
- },
11342
- {
11343
- description: 'Wyze Lock is not connected to a gateway.',
11344
- properties: {
11345
- message: { type: 'string' },
11346
- warning_code: {
11347
- description: 'Unique identifier of the type of warning. Enables quick recognition and categorization of the issue.',
11348
- enum: ['wyze_device_missing_gateway'],
11349
- type: 'string',
11350
- },
11351
- },
11352
- required: ['message', 'warning_code'],
11353
- type: 'object',
11354
- },
11355
- {
11356
- description: 'Device is offline, but has some functionality available.',
11357
- properties: {
11358
- message: { type: 'string' },
11359
- warning_code: {
11360
- description: 'Unique identifier of the type of warning. Enables quick recognition and categorization of the issue.',
11361
- enum: ['functional_offline_device'],
11362
- type: 'string',
11363
- },
11364
- },
11365
- required: ['message', 'warning_code'],
11366
- type: 'object',
11367
- },
11368
- {
11369
- description: 'Third-party integration detected.',
11370
- properties: {
11371
- message: { type: 'string' },
11372
- warning_code: {
11373
- description: 'Unique identifier of the type of warning. Enables quick recognition and categorization of the issue.',
11374
- enum: ['third_party_integration_detected'],
11375
- type: 'string',
11376
- },
11377
- },
11378
- required: ['message', 'warning_code'],
11379
- type: 'object',
11380
- },
11381
- {
11382
- description: 'Nest thermostat in manual eco mode.',
11383
- properties: {
11384
- message: { type: 'string' },
11385
- warning_code: {
11386
- description: 'Unique identifier of the type of warning. Enables quick recognition and categorization of the issue.',
11387
- enum: ['nest_thermostat_in_manual_eco_mode'],
11388
- type: 'string',
11389
- },
11390
- },
11391
- required: ['message', 'warning_code'],
11392
- type: 'object',
11393
- },
11394
- {
11395
- description: 'Remote Unlock feature not enabled in settings.',
11396
- properties: {
11397
- message: { type: 'string' },
11398
- warning_code: {
11399
- description: 'Unique identifier of the type of warning. Enables quick recognition and categorization of the issue.',
11400
- enum: ['ttlock_lock_gateway_unlocking_not_enabled'],
11401
- type: 'string',
11402
- },
11403
- },
11404
- required: ['message', 'warning_code'],
11405
- type: 'object',
11406
- },
11407
- {
11408
- description: 'Gateway signal is weak.',
11409
- properties: {
11410
- message: { type: 'string' },
11411
- warning_code: {
11412
- description: 'Unique identifier of the type of warning. Enables quick recognition and categorization of the issue.',
11413
- enum: ['ttlock_weak_gateway_signal'],
11414
- type: 'string',
11415
- },
11416
- },
11417
- required: ['message', 'warning_code'],
11418
- type: 'object',
11419
- },
11420
- {
11421
- description: 'Temperature threshold exceeded.',
11422
- properties: {
11423
- message: { type: 'string' },
11424
- warning_code: {
11425
- description: 'Unique identifier of the type of warning. Enables quick recognition and categorization of the issue.',
11426
- enum: ['temperature_threshold_exceeded'],
11427
- type: 'string',
11428
- },
11429
- },
11430
- required: ['message', 'warning_code'],
11431
- type: 'object',
11432
- },
11433
- {
11434
- description: 'Device appears to be unresponsive.',
11435
- properties: {
11436
- message: { type: 'string' },
11437
- warning_code: {
11438
- description: 'Unique identifier of the type of warning. Enables quick recognition and categorization of the issue.',
11439
- enum: ['device_communication_degraded'],
11440
- type: 'string',
11441
- },
11442
- },
11443
- required: ['message', 'warning_code'],
11444
- type: 'object',
11445
- },
11446
- {
11447
- description: 'Scheduled maintenance window detected.',
11448
- properties: {
11449
- message: { type: 'string' },
11450
- warning_code: {
11451
- description: 'Unique identifier of the type of warning. Enables quick recognition and categorization of the issue.',
11452
- enum: ['scheduled_maintenance_window'],
11453
- type: 'string',
11454
- },
11455
- },
11456
- required: ['message', 'warning_code'],
11457
- type: 'object',
11458
- },
11459
- {
11460
- description: 'Device has flaky connection.',
11461
- properties: {
11462
- message: { type: 'string' },
11463
- warning_code: {
11464
- description: 'Unique identifier of the type of warning. Enables quick recognition and categorization of the issue.',
11465
- enum: ['device_has_flaky_connection'],
11466
- type: 'string',
11467
- },
11468
- },
11469
- required: ['message', 'warning_code'],
11470
- type: 'object',
11471
- },
11472
- {
11473
- description: 'Lock is in Office Mode. Access Codes will not unlock doors.',
11474
- properties: {
11475
- message: { type: 'string' },
11476
- warning_code: {
11477
- description: 'Unique identifier of the type of warning. Enables quick recognition and categorization of the issue.',
11478
- enum: ['salto_office_mode'],
11479
- type: 'string',
10884
+ },
10885
+ {
10886
+ description: 'A phone device was deactivated.',
10887
+ properties: {
10888
+ created_at: {
10889
+ description: 'Date and time at which the event was created.',
10890
+ format: 'date-time',
10891
+ type: 'string',
10892
+ },
10893
+ device_id: {
10894
+ description: 'ID of the [device](https://docs.seam.co/latest/core-concepts/devices).',
10895
+ format: 'uuid',
10896
+ type: 'string',
10897
+ },
10898
+ event_id: {
10899
+ description: 'ID of the event.',
10900
+ format: 'uuid',
10901
+ type: 'string',
10902
+ },
10903
+ event_type: { enum: ['phone.deactivated'], type: 'string' },
10904
+ occurred_at: {
10905
+ description: 'Date and time at which the event occurred.',
10906
+ format: 'date-time',
10907
+ type: 'string',
10908
+ },
10909
+ workspace_id: {
10910
+ description: 'ID of the [workspace](https://docs.seam.co/latest/core-concepts/workspaces).',
10911
+ format: 'uuid',
10912
+ type: 'string',
10913
+ },
10914
+ },
10915
+ required: [
10916
+ 'event_id',
10917
+ 'workspace_id',
10918
+ 'created_at',
10919
+ 'occurred_at',
10920
+ 'device_id',
10921
+ 'event_type',
10922
+ ],
10923
+ type: 'object',
10924
+ 'x-route-path': '/phones',
10925
+ },
10926
+ ],
10927
+ 'x-route-path': '/events',
10928
+ },
10929
+ network: {
10930
+ properties: {
10931
+ created_at: { format: 'date-time', type: 'string' },
10932
+ display_name: { type: 'string' },
10933
+ network_id: { format: 'uuid', type: 'string' },
10934
+ workspace_id: { format: 'uuid', type: 'string' },
10935
+ },
10936
+ required: ['network_id', 'workspace_id', 'display_name', 'created_at'],
10937
+ type: 'object',
10938
+ 'x-route-path': '/networks',
10939
+ },
10940
+ noise_threshold: {
10941
+ properties: {
10942
+ device_id: { format: 'uuid', type: 'string' },
10943
+ ends_daily_at: { type: 'string' },
10944
+ name: { type: 'string' },
10945
+ noise_threshold_decibels: { format: 'float', type: 'number' },
10946
+ noise_threshold_id: { format: 'uuid', type: 'string' },
10947
+ noise_threshold_nrs: { format: 'float', type: 'number' },
10948
+ starts_daily_at: { type: 'string' },
10949
+ },
10950
+ required: [
10951
+ 'noise_threshold_id',
10952
+ 'device_id',
10953
+ 'name',
10954
+ 'starts_daily_at',
10955
+ 'ends_daily_at',
10956
+ 'noise_threshold_decibels',
10957
+ ],
10958
+ type: 'object',
10959
+ 'x-route-path': '/noise_sensors/noise_thresholds',
10960
+ },
10961
+ phone: {
10962
+ description: "Represents an app user's mobile phone.",
10963
+ properties: {
10964
+ created_at: {
10965
+ description: 'Date and time at which the `phone` was created.',
10966
+ format: 'date-time',
10967
+ type: 'string',
10968
+ },
10969
+ custom_metadata: {
10970
+ additionalProperties: {
10971
+ oneOf: [{ type: 'string' }, { type: 'boolean' }],
10972
+ },
10973
+ description: 'Optional [custom metadata](https://docs.seam.co/latest/core-concepts/devices/adding-custom-metadata-to-a-device) for the phone.',
10974
+ type: 'object',
10975
+ },
10976
+ device_id: {
10977
+ description: 'ID of the `phone`.',
10978
+ format: 'uuid',
10979
+ type: 'string',
10980
+ },
10981
+ device_type: {
10982
+ description: 'Type of phone.',
10983
+ enum: ['ios_phone', 'android_phone'],
10984
+ type: 'string',
10985
+ },
10986
+ display_name: {
10987
+ description: '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.',
10988
+ type: 'string',
10989
+ },
10990
+ errors: {
10991
+ description: 'Errors associated with the `phone`.',
10992
+ items: {
10993
+ properties: {
10994
+ error_code: { type: 'string' },
10995
+ message: { type: 'string' },
10996
+ },
10997
+ required: ['error_code', 'message'],
10998
+ type: 'object',
10999
+ },
11000
+ type: 'array',
11001
+ },
11002
+ nickname: {
11003
+ description: 'Optional nickname to describe the phone, settable through Seam.',
11004
+ type: 'string',
11005
+ },
11006
+ properties: {
11007
+ description: 'Properties of the phone.',
11008
+ properties: {
11009
+ assa_abloy_credential_service_metadata: {
11010
+ description: 'ASSA ABLOY Credential Service metadata for the phone.',
11011
+ properties: {
11012
+ endpoints: {
11013
+ description: 'Endpoints associated with the phone.',
11014
+ items: {
11015
+ properties: {
11016
+ endpoint_id: {
11017
+ description: 'ID of the associated endpoint.',
11018
+ type: 'string',
11019
+ },
11020
+ is_active: {
11021
+ description: 'Indicated whether the endpoint is active.',
11022
+ type: 'boolean',
11023
+ },
11024
+ },
11025
+ required: ['endpoint_id', 'is_active'],
11026
+ type: 'object',
11480
11027
  },
11028
+ type: 'array',
11481
11029
  },
11482
- required: ['message', 'warning_code'],
11483
- type: 'object',
11484
- },
11485
- {
11486
- description: 'Lock is in Privacy Mode. Access Codes will not unlock doors.',
11487
- properties: {
11488
- message: { type: 'string' },
11489
- warning_code: {
11490
- description: 'Unique identifier of the type of warning. Enables quick recognition and categorization of the issue.',
11491
- enum: ['salto_privacy_mode'],
11492
- type: 'string',
11493
- },
11030
+ has_active_endpoint: {
11031
+ description: 'Indicates whether the credential service has active endpoints associated with the phone.',
11032
+ type: 'boolean',
11494
11033
  },
11495
- required: ['message', 'warning_code'],
11496
- type: 'object',
11497
11034
  },
11498
- {
11499
- description: 'An unknown issue occurred while syncing the state of this phone with the provider. This issue may affect the proper functioning of this phone.',
11500
- properties: {
11501
- message: { type: 'string' },
11502
- warning_code: {
11503
- description: 'Unique identifier of the type of warning. Enables quick recognition and categorization of the issue.',
11504
- enum: ['unknown_issue_with_phone'],
11505
- type: 'string',
11506
- },
11035
+ required: ['has_active_endpoint', 'endpoints'],
11036
+ type: 'object',
11037
+ },
11038
+ salto_space_credential_service_metadata: {
11039
+ description: 'Salto Space credential service metadata for the phone.',
11040
+ properties: {
11041
+ has_active_phone: {
11042
+ description: 'Indicates whether the credential service has an active associated phone.',
11043
+ type: 'boolean',
11507
11044
  },
11508
- required: ['message', 'warning_code'],
11509
- type: 'object',
11510
11045
  },
11511
- ],
11046
+ required: ['has_active_phone'],
11047
+ type: 'object',
11048
+ },
11049
+ },
11050
+ type: 'object',
11051
+ },
11052
+ warnings: {
11053
+ description: 'Warnings associated with the `phone`.',
11054
+ items: {
11055
+ properties: {
11056
+ message: { type: 'string' },
11057
+ warning_code: { type: 'string' },
11058
+ },
11059
+ required: ['warning_code', 'message'],
11060
+ type: 'object',
11512
11061
  },
11513
11062
  type: 'array',
11514
11063
  },
11515
11064
  workspace_id: {
11516
- description: 'Unique identifier for the Seam workspace associated with the device.',
11065
+ description: 'ID of the [workspace](https://docs.seam.co/latest/core-concepts/workspaces) that contains the `phone`.',
11517
11066
  format: 'uuid',
11518
11067
  type: 'string',
11519
11068
  },
11520
11069
  },
11521
11070
  required: [
11522
11071
  'device_id',
11523
- 'device_type',
11524
11072
  'display_name',
11525
- 'capabilities_supported',
11526
- 'properties',
11527
- 'location',
11528
11073
  'workspace_id',
11529
- 'errors',
11530
- 'warnings',
11531
11074
  'created_at',
11532
- 'is_managed',
11533
11075
  'custom_metadata',
11076
+ 'errors',
11077
+ 'warnings',
11078
+ 'device_type',
11079
+ 'properties',
11534
11080
  ],
11535
11081
  type: 'object',
11536
11082
  'x-route-path': '/phones',
@@ -13088,7 +12634,11 @@ export default {
13088
12634
  ],
13089
12635
  type: 'string',
13090
12636
  },
13091
- { enum: ['ios_phone', 'android_phone'], type: 'string' },
12637
+ {
12638
+ description: 'Type of phone.',
12639
+ enum: ['ios_phone', 'android_phone'],
12640
+ type: 'string',
12641
+ },
13092
12642
  ],
13093
12643
  },
13094
12644
  errors: {
@@ -18666,6 +18216,62 @@ export default {
18666
18216
  'x-response-key': 'action_attempts',
18667
18217
  },
18668
18218
  },
18219
+ '/bridges/get': {
18220
+ post: {
18221
+ operationId: 'bridgesGetPost',
18222
+ requestBody: {
18223
+ content: {
18224
+ 'application/json': {
18225
+ schema: {
18226
+ properties: { bridge_id: { format: 'uuid', type: 'string' } },
18227
+ required: ['bridge_id'],
18228
+ type: 'object',
18229
+ },
18230
+ },
18231
+ },
18232
+ },
18233
+ responses: {
18234
+ 200: {
18235
+ content: {
18236
+ 'application/json': {
18237
+ schema: {
18238
+ properties: {
18239
+ bridge: {
18240
+ properties: {
18241
+ bridge_id: { format: 'uuid', type: 'string' },
18242
+ created_at: { format: 'date-time', type: 'string' },
18243
+ workspace_id: { format: 'uuid', type: 'string' },
18244
+ },
18245
+ required: ['bridge_id', 'workspace_id', 'created_at'],
18246
+ type: 'object',
18247
+ 'x-route-path': '/bridges',
18248
+ 'x-undocumented': 'Unreleased.',
18249
+ },
18250
+ ok: { type: 'boolean' },
18251
+ },
18252
+ required: ['bridge', 'ok'],
18253
+ type: 'object',
18254
+ },
18255
+ },
18256
+ },
18257
+ description: 'OK',
18258
+ },
18259
+ 400: { description: 'Bad Request' },
18260
+ 401: { description: 'Unauthorized' },
18261
+ },
18262
+ security: [
18263
+ { pat_with_workspace: [] },
18264
+ { console_session_with_workspace: [] },
18265
+ { api_key: [] },
18266
+ ],
18267
+ summary: '/bridges/get',
18268
+ tags: [],
18269
+ 'x-fern-sdk-group-name': ['bridges'],
18270
+ 'x-fern-sdk-method-name': 'get',
18271
+ 'x-fern-sdk-return-value': 'bridge',
18272
+ 'x-response-key': 'bridge',
18273
+ },
18274
+ },
18669
18275
  '/client_sessions/create': {
18670
18276
  post: {
18671
18277
  operationId: 'clientSessionsCreatePost',
@@ -19864,7 +19470,11 @@ export default {
19864
19470
  ],
19865
19471
  type: 'string',
19866
19472
  },
19867
- { enum: ['ios_phone', 'android_phone'], type: 'string' },
19473
+ {
19474
+ description: 'Type of phone.',
19475
+ enum: ['ios_phone', 'android_phone'],
19476
+ type: 'string',
19477
+ },
19868
19478
  ],
19869
19479
  },
19870
19480
  device_types: {
@@ -19917,6 +19527,7 @@ export default {
19917
19527
  type: 'string',
19918
19528
  },
19919
19529
  {
19530
+ description: 'Type of phone.',
19920
19531
  enum: ['ios_phone', 'android_phone'],
19921
19532
  type: 'string',
19922
19533
  },
@@ -20382,7 +19993,11 @@ export default {
20382
19993
  ],
20383
19994
  type: 'string',
20384
19995
  },
20385
- { enum: ['ios_phone', 'android_phone'], type: 'string' },
19996
+ {
19997
+ description: 'Type of phone.',
19998
+ enum: ['ios_phone', 'android_phone'],
19999
+ type: 'string',
20000
+ },
20386
20001
  ],
20387
20002
  },
20388
20003
  device_types: {
@@ -20435,6 +20050,7 @@ export default {
20435
20050
  type: 'string',
20436
20051
  },
20437
20052
  {
20053
+ description: 'Type of phone.',
20438
20054
  enum: ['ios_phone', 'android_phone'],
20439
20055
  type: 'string',
20440
20056
  },
@@ -21215,7 +20831,11 @@ export default {
21215
20831
  ],
21216
20832
  type: 'string',
21217
20833
  },
21218
- { enum: ['ios_phone', 'android_phone'], type: 'string' },
20834
+ {
20835
+ description: 'Type of phone.',
20836
+ enum: ['ios_phone', 'android_phone'],
20837
+ type: 'string',
20838
+ },
21219
20839
  ],
21220
20840
  },
21221
20841
  device_types: {
@@ -21268,6 +20888,7 @@ export default {
21268
20888
  type: 'string',
21269
20889
  },
21270
20890
  {
20891
+ description: 'Type of phone.',
21271
20892
  enum: ['ios_phone', 'android_phone'],
21272
20893
  type: 'string',
21273
20894
  },
@@ -21696,7 +21317,11 @@ export default {
21696
21317
  ],
21697
21318
  type: 'string',
21698
21319
  },
21699
- { enum: ['ios_phone', 'android_phone'], type: 'string' },
21320
+ {
21321
+ description: 'Type of phone.',
21322
+ enum: ['ios_phone', 'android_phone'],
21323
+ type: 'string',
21324
+ },
21700
21325
  ],
21701
21326
  },
21702
21327
  device_types: {
@@ -21749,6 +21374,7 @@ export default {
21749
21374
  type: 'string',
21750
21375
  },
21751
21376
  {
21377
+ description: 'Type of phone.',
21752
21378
  enum: ['ios_phone', 'android_phone'],
21753
21379
  type: 'string',
21754
21380
  },
@@ -23141,7 +22767,11 @@ export default {
23141
22767
  ],
23142
22768
  type: 'string',
23143
22769
  },
23144
- { enum: ['ios_phone', 'android_phone'], type: 'string' },
22770
+ {
22771
+ description: 'Type of phone.',
22772
+ enum: ['ios_phone', 'android_phone'],
22773
+ type: 'string',
22774
+ },
23145
22775
  ],
23146
22776
  },
23147
22777
  device_types: {
@@ -23194,6 +22824,7 @@ export default {
23194
22824
  type: 'string',
23195
22825
  },
23196
22826
  {
22827
+ description: 'Type of phone.',
23197
22828
  enum: ['ios_phone', 'android_phone'],
23198
22829
  type: 'string',
23199
22830
  },