@seamapi/types 1.1101.0 → 1.1103.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 (29) hide show
  1. package/lib/seam/connect/models/access-grants/access-grant.d.ts +37 -21
  2. package/lib/seam/connect/models/access-grants/access-grant.js +4 -3
  3. package/lib/seam/connect/models/access-grants/access-grant.js.map +1 -1
  4. package/lib/seam/connect/models/acs/acs-access-group.js +2 -2
  5. package/lib/seam/connect/models/acs/acs-access-group.js.map +1 -1
  6. package/lib/seam/connect/models/acs/acs-entrance.d.ts +38 -8
  7. package/lib/seam/connect/models/acs/acs-entrance.js +22 -9
  8. package/lib/seam/connect/models/acs/acs-entrance.js.map +1 -1
  9. package/lib/seam/connect/models/acs/acs-users/acs-user.d.ts +75 -4
  10. package/lib/seam/connect/models/acs/acs-users/acs-user.js +32 -30
  11. package/lib/seam/connect/models/acs/acs-users/acs-user.js.map +1 -1
  12. package/lib/seam/connect/models/devices/phone.d.ts +1126 -22
  13. package/lib/seam/connect/models/devices/phone.js +4 -19
  14. package/lib/seam/connect/models/devices/phone.js.map +1 -1
  15. package/lib/seam/connect/models/phones/phone-session.d.ts +28 -26
  16. package/lib/seam/connect/models/user-identities/user-identity.js +4 -4
  17. package/lib/seam/connect/models/user-identities/user-identity.js.map +1 -1
  18. package/lib/seam/connect/openapi.js +1329 -214
  19. package/lib/seam/connect/openapi.js.map +1 -1
  20. package/lib/seam/connect/route-types.d.ts +1319 -353
  21. package/package.json +1 -1
  22. package/src/lib/seam/connect/models/access-grants/access-grant.ts +13 -5
  23. package/src/lib/seam/connect/models/acs/acs-access-group.ts +2 -2
  24. package/src/lib/seam/connect/models/acs/acs-entrance.ts +36 -17
  25. package/src/lib/seam/connect/models/acs/acs-users/acs-user.ts +44 -34
  26. package/src/lib/seam/connect/models/devices/phone.ts +4 -27
  27. package/src/lib/seam/connect/models/user-identities/user-identity.ts +4 -4
  28. package/src/lib/seam/connect/openapi.ts +1505 -203
  29. package/src/lib/seam/connect/route-types.ts +1526 -428
@@ -1943,7 +1943,8 @@ const openapi = {
1943
1943
  type: 'string',
1944
1944
  },
1945
1945
  error_code: {
1946
- description: 'Reason the access code could not be revoked (e.g. `offline_access_code_not_revocable`).',
1946
+ description: 'Reason the access code could not be revoked.',
1947
+ enum: ['offline_access_code_not_revocable'],
1947
1948
  type: 'string',
1948
1949
  },
1949
1950
  message: {
@@ -3893,23 +3894,32 @@ const openapi = {
3893
3894
  errors: {
3894
3895
  description: 'Errors associated with the [entrance](https://www.seam.co/docs/low-level-apis/access-systems/retrieving-entrance-details).',
3895
3896
  items: {
3896
- properties: {
3897
- created_at: {
3898
- description: 'Date and time at which Seam created the error.',
3899
- format: 'date-time',
3900
- type: 'string',
3901
- },
3902
- error_code: {
3903
- description: 'Unique identifier of the type of error. Enables quick recognition and categorization of the issue.',
3904
- type: 'string',
3905
- },
3906
- message: {
3907
- description: 'Detailed description of the error. Provides insights into the issue and potentially how to rectify it.',
3908
- type: 'string',
3897
+ description: 'Error associated with the [entrance](https://www.seam.co/docs/low-level-apis/access-systems/retrieving-entrance-details).',
3898
+ discriminator: { propertyName: 'error_code' },
3899
+ oneOf: [
3900
+ {
3901
+ description: 'Indicates that the [entrance](https://www.seam.co/docs/low-level-apis/access-systems/retrieving-entrance-details) was removed from the connected account, so Seam can no longer sync it.',
3902
+ properties: {
3903
+ created_at: {
3904
+ description: 'Date and time at which Seam created the error.',
3905
+ format: 'date-time',
3906
+ type: 'string',
3907
+ },
3908
+ error_code: {
3909
+ description: 'Unique identifier of the type of error. Enables quick recognition and categorization of the issue.',
3910
+ enum: ['entrance_removed'],
3911
+ type: 'string',
3912
+ },
3913
+ message: {
3914
+ description: 'Detailed description of the error. Provides insights into the issue and potentially how to rectify it.',
3915
+ type: 'string',
3916
+ },
3917
+ },
3918
+ required: ['created_at', 'message', 'error_code'],
3919
+ type: 'object',
3920
+ 'x-resource-type': 'acs_entrance',
3909
3921
  },
3910
- },
3911
- required: ['error_code', 'message', 'created_at'],
3912
- type: 'object',
3922
+ ],
3913
3923
  },
3914
3924
  type: 'array',
3915
3925
  },
@@ -27087,195 +27097,1290 @@ const openapi = {
27087
27097
  type: 'string',
27088
27098
  },
27089
27099
  errors: {
27090
- description: 'Errors associated with the phone.',
27100
+ 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.',
27091
27101
  items: {
27092
- properties: {
27093
- created_at: {
27094
- description: 'Date and time at which Seam created the error.',
27095
- format: 'date-time',
27096
- type: 'string',
27102
+ discriminator: { propertyName: 'error_code' },
27103
+ oneOf: [
27104
+ {
27105
+ description: 'Indicates that the account is disconnected.',
27106
+ properties: {
27107
+ created_at: {
27108
+ description: 'Date and time at which Seam created the error.',
27109
+ format: 'date-time',
27110
+ type: 'string',
27111
+ },
27112
+ error_code: {
27113
+ description: 'Unique identifier of the type of error. Enables quick recognition and categorization of the issue.',
27114
+ enum: ['account_disconnected'],
27115
+ type: 'string',
27116
+ },
27117
+ is_connected_account_error: {
27118
+ description: 'Indicates that the error is a [connected account](https://www.seam.co/docs/api/connected_accounts/object) error.',
27119
+ enum: [true],
27120
+ type: 'boolean',
27121
+ },
27122
+ is_device_error: {
27123
+ description: 'Indicates that the error is not a device error.',
27124
+ enum: [false],
27125
+ type: 'boolean',
27126
+ },
27127
+ message: {
27128
+ description: 'Detailed description of the error. Provides insights into the issue and potentially how to rectify it.',
27129
+ type: 'string',
27130
+ },
27131
+ },
27132
+ required: [
27133
+ 'message',
27134
+ 'is_device_error',
27135
+ 'created_at',
27136
+ 'error_code',
27137
+ 'is_connected_account_error',
27138
+ ],
27139
+ type: 'object',
27140
+ 'x-resource-type': 'connected_account',
27097
27141
  },
27098
- error_code: {
27099
- description: 'Unique identifier of the type of error.',
27100
- type: 'string',
27142
+ {
27143
+ description: 'Indicates that the Salto site user limit has been reached.',
27144
+ properties: {
27145
+ created_at: {
27146
+ description: 'Date and time at which Seam created the error.',
27147
+ format: 'date-time',
27148
+ type: 'string',
27149
+ },
27150
+ error_code: {
27151
+ description: 'Unique identifier of the type of error. Enables quick recognition and categorization of the issue.',
27152
+ enum: ['salto_ks_subscription_limit_exceeded'],
27153
+ type: 'string',
27154
+ },
27155
+ is_connected_account_error: {
27156
+ description: 'Indicates that the error is a [connected account](https://www.seam.co/docs/api/connected_accounts/object) error.',
27157
+ enum: [true],
27158
+ type: 'boolean',
27159
+ },
27160
+ is_device_error: {
27161
+ description: 'Indicates that the error is not a device error.',
27162
+ enum: [false],
27163
+ type: 'boolean',
27164
+ },
27165
+ message: {
27166
+ description: 'Detailed description of the error. Provides insights into the issue and potentially how to rectify it.',
27167
+ type: 'string',
27168
+ },
27169
+ },
27170
+ required: [
27171
+ 'message',
27172
+ 'is_device_error',
27173
+ 'created_at',
27174
+ 'error_code',
27175
+ 'is_connected_account_error',
27176
+ ],
27177
+ type: 'object',
27178
+ 'x-resource-type': 'connected_account',
27179
+ 'x-variant-group-key': 'locks',
27101
27180
  },
27102
- message: {
27103
- description: 'Detailed description of the error.',
27104
- type: 'string',
27181
+ {
27182
+ description: "Indicates that the provider's system to which this device belongs is not letting Seam act on it, so Seam cannot manage access codes or unlock the device. The error message says which of three causes applies. Seam's integration user may not have sufficient permissions on the provider's system, or may have been suspended there: grant the integration user the required permissions in the provider's system, or reauthorize the connected account in Seam. The provider account or site may not have a valid subscription with the provider: set up or renew that subscription with the provider. Or the provider may have rejected the credential Seam uses to operate the device's hub: contact Seam support to re-activate it.",
27183
+ properties: {
27184
+ created_at: {
27185
+ description: 'Date and time at which Seam created the error.',
27186
+ format: 'date-time',
27187
+ type: 'string',
27188
+ },
27189
+ error_code: {
27190
+ description: 'Unique identifier of the type of error. Enables quick recognition and categorization of the issue.',
27191
+ enum: ['insufficient_permissions'],
27192
+ type: 'string',
27193
+ },
27194
+ is_connected_account_error: {
27195
+ description: 'Indicates that the error is a [connected account](https://www.seam.co/docs/api/connected_accounts/object) error.',
27196
+ enum: [true],
27197
+ type: 'boolean',
27198
+ },
27199
+ is_device_error: {
27200
+ description: 'Indicates that the error is not a device error.',
27201
+ enum: [false],
27202
+ type: 'boolean',
27203
+ },
27204
+ message: {
27205
+ description: 'Detailed description of the error. Provides insights into the issue and potentially how to rectify it.',
27206
+ type: 'string',
27207
+ },
27208
+ },
27209
+ required: [
27210
+ 'message',
27211
+ 'is_device_error',
27212
+ 'created_at',
27213
+ 'error_code',
27214
+ 'is_connected_account_error',
27215
+ ],
27216
+ type: 'object',
27217
+ 'x-resource-type': 'connected_account',
27105
27218
  },
27106
- },
27107
- required: ['error_code', 'message', 'created_at'],
27108
- type: 'object',
27109
- },
27110
- type: 'array',
27111
- },
27112
- nickname: {
27113
- description: 'Optional nickname to describe the phone, settable through Seam.\n ',
27114
- type: 'string',
27115
- },
27116
- properties: {
27117
- description: 'Properties of the phone.',
27118
- properties: {
27119
- assa_abloy_credential_service_metadata: {
27120
- description: 'ASSA ABLOY Credential Service metadata for the phone.',
27121
- properties: {
27122
- endpoints: {
27123
- description: 'Endpoints associated with the phone.',
27124
- items: {
27125
- properties: {
27126
- endpoint_id: {
27127
- description: 'ID of the associated endpoint.',
27128
- type: 'string',
27129
- },
27130
- is_active: {
27131
- description: 'Indicated whether the endpoint is active.',
27132
- type: 'boolean',
27133
- },
27134
- },
27135
- type: 'object',
27219
+ {
27220
+ description: 'Indicates that one or more dormakaba sites associated with the connected account could not be connected. Contact dormakaba support.',
27221
+ properties: {
27222
+ created_at: {
27223
+ description: 'Date and time at which Seam created the error.',
27224
+ format: 'date-time',
27225
+ type: 'string',
27226
+ },
27227
+ error_code: {
27228
+ description: 'Unique identifier of the type of error. Enables quick recognition and categorization of the issue.',
27229
+ enum: ['dormakaba_sites_disconnected'],
27230
+ type: 'string',
27231
+ },
27232
+ is_connected_account_error: {
27233
+ description: 'Indicates that the error is a [connected account](https://www.seam.co/docs/api/connected_accounts/object) error.',
27234
+ enum: [true],
27235
+ type: 'boolean',
27236
+ },
27237
+ is_device_error: {
27238
+ description: 'Indicates that the error is not a device error.',
27239
+ enum: [false],
27240
+ type: 'boolean',
27241
+ },
27242
+ message: {
27243
+ description: 'Detailed description of the error. Provides insights into the issue and potentially how to rectify it.',
27244
+ type: 'string',
27136
27245
  },
27137
- type: 'array',
27138
27246
  },
27139
- has_active_endpoint: {
27140
- description: 'Indicates whether the credential service has active endpoints associated with the phone.',
27141
- type: 'boolean',
27247
+ required: [
27248
+ 'message',
27249
+ 'is_device_error',
27250
+ 'created_at',
27251
+ 'error_code',
27252
+ 'is_connected_account_error',
27253
+ ],
27254
+ type: 'object',
27255
+ 'x-resource-type': 'connected_account',
27256
+ 'x-variant-group-key': 'locks',
27257
+ },
27258
+ {
27259
+ deprecated: true,
27260
+ description: 'Indicates that the device is offline.',
27261
+ properties: {
27262
+ created_at: {
27263
+ description: 'Date and time at which Seam created the error.',
27264
+ format: 'date-time',
27265
+ type: 'string',
27266
+ },
27267
+ error_code: {
27268
+ description: 'Unique identifier of the type of error. Enables quick recognition and categorization of the issue.',
27269
+ enum: ['device_offline'],
27270
+ type: 'string',
27271
+ },
27272
+ is_device_error: {
27273
+ description: 'Indicates that the error is a device error.',
27274
+ enum: [true],
27275
+ type: 'boolean',
27276
+ },
27277
+ message: {
27278
+ description: 'Detailed description of the error. Provides insights into the issue and potentially how to rectify it.',
27279
+ type: 'string',
27280
+ },
27142
27281
  },
27282
+ required: [
27283
+ 'message',
27284
+ 'is_device_error',
27285
+ 'created_at',
27286
+ 'error_code',
27287
+ ],
27288
+ type: 'object',
27289
+ 'x-deprecated': 'Use `device_disconnected` instead.',
27290
+ 'x-resource-type': 'device',
27143
27291
  },
27144
- type: 'object',
27145
- },
27146
- salto_space_credential_service_metadata: {
27147
- description: 'Salto Space credential service metadata for the phone.',
27148
- properties: {
27149
- has_active_phone: {
27150
- description: 'Indicates whether the credential service has an active associated phone.',
27151
- type: 'boolean',
27292
+ {
27293
+ description: 'Indicates that the device has been removed.',
27294
+ properties: {
27295
+ created_at: {
27296
+ description: 'Date and time at which Seam created the error.',
27297
+ format: 'date-time',
27298
+ type: 'string',
27299
+ },
27300
+ error_code: {
27301
+ description: 'Unique identifier of the type of error. Enables quick recognition and categorization of the issue.',
27302
+ enum: ['device_removed'],
27303
+ type: 'string',
27304
+ },
27305
+ is_device_error: {
27306
+ description: 'Indicates that the error is a device error.',
27307
+ enum: [true],
27308
+ type: 'boolean',
27309
+ },
27310
+ message: {
27311
+ description: 'Detailed description of the error. Provides insights into the issue and potentially how to rectify it.',
27312
+ type: 'string',
27313
+ },
27152
27314
  },
27315
+ required: [
27316
+ 'message',
27317
+ 'is_device_error',
27318
+ 'created_at',
27319
+ 'error_code',
27320
+ ],
27321
+ type: 'object',
27322
+ 'x-resource-type': 'device',
27153
27323
  },
27154
- type: 'object',
27155
- },
27156
- },
27157
- type: 'object',
27158
- },
27159
- warnings: {
27160
- description: 'Warnings associated with the phone.',
27161
- items: {
27162
- properties: {
27163
- created_at: {
27164
- description: 'Date and time at which Seam created the warning.',
27165
- format: 'date-time',
27166
- type: 'string',
27324
+ {
27325
+ description: 'Indicates that the hub is disconnected.',
27326
+ properties: {
27327
+ created_at: {
27328
+ description: 'Date and time at which Seam created the error.',
27329
+ format: 'date-time',
27330
+ type: 'string',
27331
+ },
27332
+ error_code: {
27333
+ description: 'Unique identifier of the type of error. Enables quick recognition and categorization of the issue.',
27334
+ enum: ['hub_disconnected'],
27335
+ type: 'string',
27336
+ },
27337
+ is_device_error: {
27338
+ description: 'Indicates that the error is a device error.',
27339
+ enum: [true],
27340
+ type: 'boolean',
27341
+ },
27342
+ message: {
27343
+ description: 'Detailed description of the error. Provides insights into the issue and potentially how to rectify it.',
27344
+ type: 'string',
27345
+ },
27346
+ },
27347
+ required: [
27348
+ 'message',
27349
+ 'is_device_error',
27350
+ 'created_at',
27351
+ 'error_code',
27352
+ ],
27353
+ type: 'object',
27354
+ 'x-resource-type': 'device',
27167
27355
  },
27168
- message: {
27169
- description: 'Detailed description of the warning.',
27170
- type: 'string',
27356
+ {
27357
+ description: 'Indicates that the device is disconnected.',
27358
+ properties: {
27359
+ created_at: {
27360
+ description: 'Date and time at which Seam created the error.',
27361
+ format: 'date-time',
27362
+ type: 'string',
27363
+ },
27364
+ error_code: {
27365
+ description: 'Unique identifier of the type of error. Enables quick recognition and categorization of the issue.',
27366
+ enum: ['device_disconnected'],
27367
+ type: 'string',
27368
+ },
27369
+ is_device_error: {
27370
+ description: 'Indicates that the error is a device error.',
27371
+ enum: [true],
27372
+ type: 'boolean',
27373
+ },
27374
+ message: {
27375
+ description: 'Detailed description of the error. Provides insights into the issue and potentially how to rectify it.',
27376
+ type: 'string',
27377
+ },
27378
+ },
27379
+ required: [
27380
+ 'message',
27381
+ 'is_device_error',
27382
+ 'created_at',
27383
+ 'error_code',
27384
+ ],
27385
+ type: 'object',
27386
+ 'x-resource-type': 'device',
27171
27387
  },
27172
- warning_code: {
27173
- description: 'Unique identifier of the type of warning.',
27174
- type: 'string',
27388
+ {
27389
+ description: 'Indicates that the [backup access code pool](https://www.seam.co/docs/low-level-apis/smart-locks/access-codes/backup-access-codes) is empty.',
27390
+ properties: {
27391
+ created_at: {
27392
+ description: 'Date and time at which Seam created the error.',
27393
+ format: 'date-time',
27394
+ type: 'string',
27395
+ },
27396
+ error_code: {
27397
+ description: 'Unique identifier of the type of error. Enables quick recognition and categorization of the issue.',
27398
+ enum: ['empty_backup_access_code_pool'],
27399
+ type: 'string',
27400
+ },
27401
+ is_device_error: {
27402
+ description: 'Indicates that the error is a device error.',
27403
+ enum: [true],
27404
+ type: 'boolean',
27405
+ },
27406
+ message: {
27407
+ description: 'Detailed description of the error. Provides insights into the issue and potentially how to rectify it.',
27408
+ type: 'string',
27409
+ },
27410
+ },
27411
+ required: [
27412
+ 'message',
27413
+ 'is_device_error',
27414
+ 'created_at',
27415
+ 'error_code',
27416
+ ],
27417
+ type: 'object',
27418
+ 'x-resource-type': 'device',
27419
+ 'x-variant-group-key': 'access_codes',
27175
27420
  },
27176
- },
27177
- required: ['warning_code', 'message', 'created_at'],
27178
- type: 'object',
27179
- },
27180
- type: 'array',
27181
- },
27182
- workspace_id: {
27183
- description: 'ID of the workspace that contains the phone.\n ',
27184
- format: 'uuid',
27185
- type: 'string',
27186
- },
27187
- },
27188
- required: [
27189
- 'device_id',
27190
- 'display_name',
27191
- 'workspace_id',
27192
- 'created_at',
27193
- 'custom_metadata',
27194
- 'errors',
27195
- 'warnings',
27196
- 'device_type',
27197
- 'properties',
27198
- ],
27199
- type: 'object',
27200
- 'x-property-groups': { phones: { name: 'Phones' } },
27201
- 'x-route-path': '/phones',
27202
- },
27203
- phone_registration: {
27204
- description: 'Represents a mobile phone registration.',
27205
- properties: {
27206
- is_being_activated: {
27207
- description: 'Indicates whether the phone is being activated.',
27208
- type: 'boolean',
27209
- },
27210
- phone_registration_id: {
27211
- description: 'Registration ID for the phone.',
27212
- type: 'string',
27213
- },
27214
- provider_name: {
27215
- description: 'Provider name for the phone.',
27216
- nullable: true,
27217
- type: 'string',
27218
- },
27219
- provider_state: {
27220
- additionalProperties: {},
27221
- description: 'Provider state for the phone.',
27222
- nullable: true,
27223
- type: 'object',
27224
- },
27225
- },
27226
- required: [
27227
- 'phone_registration_id',
27228
- 'provider_state',
27229
- 'provider_name',
27230
- 'is_being_activated',
27231
- ],
27232
- type: 'object',
27233
- 'x-route-path': '/seam/mobile_sdk/v1/phone_sessions',
27234
- 'x-undocumented': 'Seam Mobile SDK only.',
27235
- },
27236
- phone_session: {
27237
- description: 'Represents a mobile phone session.',
27238
- properties: {
27239
- is_sandbox_workspace: {
27240
- description: 'Whether the workspace is in sandbox mode.',
27241
- type: 'boolean',
27242
- },
27243
- provider_sessions: {
27244
- description: 'Phone provider sessions.',
27245
- items: {
27246
- description: 'Phone provider session.',
27247
- properties: {
27248
- acs_credentials: {
27249
- description: 'Access system credentials associated with the phone provider session.',
27250
- items: {
27251
- description: 'Means by which an [access control system user](https://www.seam.co/docs/low-level-apis/access-systems/user-management) gains access at an [entrance](https://www.seam.co/docs/low-level-apis/access-systems/retrieving-entrance-details). The `acs_credential` object represents a [credential](https://www.seam.co/docs/low-level-apis/access-systems/managing-credentials) that provides an ACS user access within an [access control system](https://www.seam.co/docs/low-level-apis/access-systems).\n\nAn access control system generally uses digital means of access to authorize a user trying to get through a specific entrance. Examples of credentials include plastic key cards, mobile keys, biometric identifiers, and PIN codes. The electronic nature of these credentials, as well as the fact that access is centralized, enables both the rapid provisioning and rescinding of access and the ability to compile access audit logs.\n\nFor each `acs_credential`, you define the access method. You can also specify additional properties, such as a PIN code, depending on the credential type.\n\nFor granting a person access to a space, [Access Grants](https://www.seam.co/docs/use-cases/granting-access) are the default and recommended approach. Use the lower-level ACS credential API directly only when you specifically need to manage individual credentials.',
27252
- properties: {
27253
- access_method: {
27254
- description: 'Access method for the [credential](https://www.seam.co/docs/low-level-apis/access-systems/managing-credentials). Supported values: `code`, `card`, `mobile_key`, `cloud_key`.',
27255
- enum: ['code', 'card', 'mobile_key', 'cloud_key'],
27256
- type: 'string',
27257
- },
27258
- acs_credential_id: { nullable: true, type: 'string' },
27259
- acs_credential_pool_id: {
27260
- description: 'ID of the credential pool to which the credential belongs.',
27261
- format: 'uuid',
27262
- type: 'string',
27263
- },
27264
- acs_entrances: {
27265
- items: {
27266
- description: 'Represents an [entrance](https://www.seam.co/docs/low-level-apis/access-systems/retrieving-entrance-details) within an [access control system](https://www.seam.co/docs/low-level-apis/access-systems).\n\nIn an access control system, an entrance is a secured door, gate, zone, or other method of entry. You can list details for all the `acs_entrance` resources in your workspace or get these details for a specific `acs_entrance`. You can also list all entrances associated with a specific credential, and you can list all credentials associated with a specific entrance.',
27267
- properties: {
27268
- acs_entrance_id: {
27269
- description: 'ID of the [entrance](https://www.seam.co/docs/low-level-apis/access-systems/retrieving-entrance-details).',
27270
- format: 'uuid',
27271
- type: 'string',
27272
- },
27273
- acs_system_id: {
27274
- description: 'ID of the [access control system](https://www.seam.co/docs/low-level-apis/access-systems) that contains the [entrance](https://www.seam.co/docs/low-level-apis/access-systems/retrieving-entrance-details).',
27275
- format: 'uuid',
27276
- type: 'string',
27277
- },
27278
- akiles_metadata: {
27421
+ {
27422
+ description: 'Indicates that the user is not authorized to use the August lock.',
27423
+ properties: {
27424
+ created_at: {
27425
+ description: 'Date and time at which Seam created the error.',
27426
+ format: 'date-time',
27427
+ type: 'string',
27428
+ },
27429
+ error_code: {
27430
+ description: 'Unique identifier of the type of error. Enables quick recognition and categorization of the issue.',
27431
+ enum: ['august_lock_not_authorized'],
27432
+ type: 'string',
27433
+ },
27434
+ is_device_error: {
27435
+ description: 'Indicates that the error is a device error.',
27436
+ enum: [true],
27437
+ type: 'boolean',
27438
+ },
27439
+ message: {
27440
+ description: 'Detailed description of the error. Provides insights into the issue and potentially how to rectify it.',
27441
+ type: 'string',
27442
+ },
27443
+ },
27444
+ required: [
27445
+ 'message',
27446
+ 'is_device_error',
27447
+ 'created_at',
27448
+ 'error_code',
27449
+ ],
27450
+ type: 'object',
27451
+ 'x-resource-type': 'device',
27452
+ 'x-variant-group-key': 'locks',
27453
+ },
27454
+ {
27455
+ description: 'Indicates that device credentials are missing.',
27456
+ properties: {
27457
+ created_at: {
27458
+ description: 'Date and time at which Seam created the error.',
27459
+ format: 'date-time',
27460
+ type: 'string',
27461
+ },
27462
+ error_code: {
27463
+ description: 'Unique identifier of the type of error. Enables quick recognition and categorization of the issue.',
27464
+ enum: ['missing_device_credentials'],
27465
+ type: 'string',
27466
+ },
27467
+ is_device_error: {
27468
+ description: 'Indicates that the error is a device error.',
27469
+ enum: [true],
27470
+ type: 'boolean',
27471
+ },
27472
+ message: {
27473
+ description: 'Detailed description of the error. Provides insights into the issue and potentially how to rectify it.',
27474
+ type: 'string',
27475
+ },
27476
+ },
27477
+ required: [
27478
+ 'message',
27479
+ 'is_device_error',
27480
+ 'created_at',
27481
+ 'error_code',
27482
+ ],
27483
+ type: 'object',
27484
+ 'x-resource-type': 'device',
27485
+ },
27486
+ {
27487
+ description: 'Indicates that the auxiliary heat is running.',
27488
+ properties: {
27489
+ created_at: {
27490
+ description: 'Date and time at which Seam created the error.',
27491
+ format: 'date-time',
27492
+ type: 'string',
27493
+ },
27494
+ error_code: {
27495
+ description: 'Unique identifier of the type of error. Enables quick recognition and categorization of the issue.',
27496
+ enum: ['auxiliary_heat_running'],
27497
+ type: 'string',
27498
+ },
27499
+ is_device_error: {
27500
+ description: 'Indicates that the error is a device error.',
27501
+ enum: [true],
27502
+ type: 'boolean',
27503
+ },
27504
+ message: {
27505
+ description: 'Detailed description of the error. Provides insights into the issue and potentially how to rectify it.',
27506
+ type: 'string',
27507
+ },
27508
+ },
27509
+ required: [
27510
+ 'message',
27511
+ 'is_device_error',
27512
+ 'created_at',
27513
+ 'error_code',
27514
+ ],
27515
+ type: 'object',
27516
+ 'x-resource-type': 'device',
27517
+ 'x-variant-group-key': 'thermostats',
27518
+ },
27519
+ {
27520
+ description: 'Indicates that a subscription is required to connect.',
27521
+ properties: {
27522
+ created_at: {
27523
+ description: 'Date and time at which Seam created the error.',
27524
+ format: 'date-time',
27525
+ type: 'string',
27526
+ },
27527
+ error_code: {
27528
+ description: 'Unique identifier of the type of error. Enables quick recognition and categorization of the issue.',
27529
+ enum: ['subscription_required'],
27530
+ type: 'string',
27531
+ },
27532
+ is_device_error: {
27533
+ description: 'Indicates that the error is a device error.',
27534
+ enum: [true],
27535
+ type: 'boolean',
27536
+ },
27537
+ message: {
27538
+ description: 'Detailed description of the error. Provides insights into the issue and potentially how to rectify it.',
27539
+ type: 'string',
27540
+ },
27541
+ },
27542
+ required: [
27543
+ 'message',
27544
+ 'is_device_error',
27545
+ 'created_at',
27546
+ 'error_code',
27547
+ ],
27548
+ type: 'object',
27549
+ 'x-resource-type': 'device',
27550
+ },
27551
+ {
27552
+ description: 'Indicates that the Seam API cannot communicate with [Seam Bridge](https://www.seam.co/docs/capability-guides/seam-bridge), for example, if the Seam Bridge executable has stopped or if the computer running the Seam Bridge executable is offline. See also [Troubleshooting Your Access Control System](https://www.seam.co/docs/low-level-apis/access-systems/troubleshooting-your-access-control-system#acs_system-errors-seam_bridge_disconnected).',
27553
+ properties: {
27554
+ created_at: {
27555
+ description: 'Date and time at which Seam created the error.',
27556
+ format: 'date-time',
27557
+ type: 'string',
27558
+ },
27559
+ error_code: {
27560
+ description: 'Unique identifier of the type of error. Enables quick recognition and categorization of the issue.',
27561
+ enum: ['bridge_disconnected'],
27562
+ type: 'string',
27563
+ },
27564
+ is_bridge_error: {
27565
+ description: 'Indicates whether the error is related to [Seam Bridge](https://www.seam.co/docs/capability-guides/seam-bridge).',
27566
+ type: 'boolean',
27567
+ },
27568
+ is_connected_account_error: {
27569
+ description: 'Indicates whether the error is related specifically to the connected account.',
27570
+ type: 'boolean',
27571
+ },
27572
+ message: {
27573
+ description: 'Detailed description of the error. Provides insights into the issue and potentially how to rectify it.',
27574
+ type: 'string',
27575
+ },
27576
+ },
27577
+ required: ['created_at', 'message', 'error_code'],
27578
+ type: 'object',
27579
+ 'x-resource-type': 'connected_account',
27580
+ },
27581
+ ],
27582
+ },
27583
+ type: 'array',
27584
+ 'x-variant-groups': {
27585
+ access_codes: { name: 'Access Codes' },
27586
+ hardware: { name: 'Hardware' },
27587
+ locks: { name: 'Locks' },
27588
+ noise_sensors: { name: 'Noise Sensors' },
27589
+ phones: { name: 'Phones' },
27590
+ provider_metadata: { name: 'Provider Metadata' },
27591
+ thermostats: { name: 'Thermostats' },
27592
+ },
27593
+ },
27594
+ nickname: {
27595
+ description: 'Optional nickname to describe the phone, settable through Seam.\n ',
27596
+ type: 'string',
27597
+ },
27598
+ properties: {
27599
+ description: 'Properties of the phone.',
27600
+ properties: {
27601
+ assa_abloy_credential_service_metadata: {
27602
+ description: 'ASSA ABLOY Credential Service metadata for the phone.',
27603
+ properties: {
27604
+ endpoints: {
27605
+ description: 'Endpoints associated with the phone.',
27606
+ items: {
27607
+ properties: {
27608
+ endpoint_id: {
27609
+ description: 'ID of the associated endpoint.',
27610
+ type: 'string',
27611
+ },
27612
+ is_active: {
27613
+ description: 'Indicated whether the endpoint is active.',
27614
+ type: 'boolean',
27615
+ },
27616
+ },
27617
+ type: 'object',
27618
+ },
27619
+ type: 'array',
27620
+ },
27621
+ has_active_endpoint: {
27622
+ description: 'Indicates whether the credential service has active endpoints associated with the phone.',
27623
+ type: 'boolean',
27624
+ },
27625
+ },
27626
+ type: 'object',
27627
+ },
27628
+ salto_space_credential_service_metadata: {
27629
+ description: 'Salto Space credential service metadata for the phone.',
27630
+ properties: {
27631
+ has_active_phone: {
27632
+ description: 'Indicates whether the credential service has an active associated phone.',
27633
+ type: 'boolean',
27634
+ },
27635
+ },
27636
+ type: 'object',
27637
+ },
27638
+ },
27639
+ type: 'object',
27640
+ },
27641
+ warnings: {
27642
+ 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.',
27643
+ items: {
27644
+ discriminator: { propertyName: 'warning_code' },
27645
+ oneOf: [
27646
+ {
27647
+ description: 'Indicates that the backup access code is unhealthy.',
27648
+ properties: {
27649
+ created_at: {
27650
+ description: 'Date and time at which Seam created the warning.',
27651
+ format: 'date-time',
27652
+ type: 'string',
27653
+ },
27654
+ message: {
27655
+ description: 'Detailed description of the warning. Provides insights into the issue and potentially how to rectify it.',
27656
+ type: 'string',
27657
+ },
27658
+ warning_code: {
27659
+ description: 'Unique identifier of the type of warning. Enables quick recognition and categorization of the issue.',
27660
+ enum: ['partial_backup_access_code_pool'],
27661
+ type: 'string',
27662
+ },
27663
+ },
27664
+ required: ['message', 'created_at', 'warning_code'],
27665
+ type: 'object',
27666
+ 'x-variant-group-key': 'access_codes',
27667
+ },
27668
+ {
27669
+ description: 'Indicates that there are too many backup codes.',
27670
+ properties: {
27671
+ created_at: {
27672
+ description: 'Date and time at which Seam created the warning.',
27673
+ format: 'date-time',
27674
+ type: 'string',
27675
+ },
27676
+ message: {
27677
+ description: 'Detailed description of the warning. Provides insights into the issue and potentially how to rectify it.',
27678
+ type: 'string',
27679
+ },
27680
+ warning_code: {
27681
+ description: 'Unique identifier of the type of warning. Enables quick recognition and categorization of the issue.',
27682
+ enum: ['many_active_backup_codes'],
27683
+ type: 'string',
27684
+ },
27685
+ },
27686
+ required: ['message', 'created_at', 'warning_code'],
27687
+ type: 'object',
27688
+ 'x-variant-group-key': 'access_codes',
27689
+ },
27690
+ {
27691
+ description: 'Indicates that a third-party integration has been detected.',
27692
+ properties: {
27693
+ created_at: {
27694
+ description: 'Date and time at which Seam created the warning.',
27695
+ format: 'date-time',
27696
+ type: 'string',
27697
+ },
27698
+ message: {
27699
+ description: 'Detailed description of the warning. Provides insights into the issue and potentially how to rectify it.',
27700
+ type: 'string',
27701
+ },
27702
+ warning_code: {
27703
+ description: 'Unique identifier of the type of warning. Enables quick recognition and categorization of the issue.',
27704
+ enum: ['third_party_integration_detected'],
27705
+ type: 'string',
27706
+ },
27707
+ },
27708
+ required: ['message', 'created_at', 'warning_code'],
27709
+ type: 'object',
27710
+ },
27711
+ {
27712
+ description: 'Indicates that the Remote Unlock feature is not enabled in the settings."',
27713
+ properties: {
27714
+ created_at: {
27715
+ description: 'Date and time at which Seam created the warning.',
27716
+ format: 'date-time',
27717
+ type: 'string',
27718
+ },
27719
+ message: {
27720
+ description: 'Detailed description of the warning. Provides insights into the issue and potentially how to rectify it.',
27721
+ type: 'string',
27722
+ },
27723
+ warning_code: {
27724
+ description: 'Unique identifier of the type of warning. Enables quick recognition and categorization of the issue.',
27725
+ enum: ['ttlock_lock_gateway_unlocking_not_enabled'],
27726
+ type: 'string',
27727
+ },
27728
+ },
27729
+ required: ['message', 'created_at', 'warning_code'],
27730
+ type: 'object',
27731
+ 'x-variant-group-key': 'locks',
27732
+ },
27733
+ {
27734
+ description: 'Indicates that the gateway signal is weak.',
27735
+ properties: {
27736
+ created_at: {
27737
+ description: 'Date and time at which Seam created the warning.',
27738
+ format: 'date-time',
27739
+ type: 'string',
27740
+ },
27741
+ message: {
27742
+ description: 'Detailed description of the warning. Provides insights into the issue and potentially how to rectify it.',
27743
+ type: 'string',
27744
+ },
27745
+ warning_code: {
27746
+ description: 'Unique identifier of the type of warning. Enables quick recognition and categorization of the issue.',
27747
+ enum: ['ttlock_weak_gateway_signal'],
27748
+ type: 'string',
27749
+ },
27750
+ },
27751
+ required: ['message', 'created_at', 'warning_code'],
27752
+ type: 'object',
27753
+ 'x-variant-group-key': 'locks',
27754
+ },
27755
+ {
27756
+ description: 'Indicates that the device is in power saving mode and may have limited functionality.',
27757
+ properties: {
27758
+ created_at: {
27759
+ description: 'Date and time at which Seam created the warning.',
27760
+ format: 'date-time',
27761
+ type: 'string',
27762
+ },
27763
+ message: {
27764
+ description: 'Detailed description of the warning. Provides insights into the issue and potentially how to rectify it.',
27765
+ type: 'string',
27766
+ },
27767
+ warning_code: {
27768
+ description: 'Unique identifier of the type of warning. Enables quick recognition and categorization of the issue.',
27769
+ enum: ['power_saving_mode'],
27770
+ type: 'string',
27771
+ },
27772
+ },
27773
+ required: ['message', 'created_at', 'warning_code'],
27774
+ type: 'object',
27775
+ 'x-variant-group-key': 'locks',
27776
+ },
27777
+ {
27778
+ description: 'Indicates that the temperature threshold has been exceeded.',
27779
+ properties: {
27780
+ created_at: {
27781
+ description: 'Date and time at which Seam created the warning.',
27782
+ format: 'date-time',
27783
+ type: 'string',
27784
+ },
27785
+ message: {
27786
+ description: 'Detailed description of the warning. Provides insights into the issue and potentially how to rectify it.',
27787
+ type: 'string',
27788
+ },
27789
+ warning_code: {
27790
+ description: 'Unique identifier of the type of warning. Enables quick recognition and categorization of the issue.',
27791
+ enum: ['temperature_threshold_exceeded'],
27792
+ type: 'string',
27793
+ },
27794
+ },
27795
+ required: ['message', 'created_at', 'warning_code'],
27796
+ type: 'object',
27797
+ 'x-variant-group-key': 'thermostats',
27798
+ },
27799
+ {
27800
+ description: 'Indicates that the device appears to be unresponsive.',
27801
+ properties: {
27802
+ created_at: {
27803
+ description: 'Date and time at which Seam created the warning.',
27804
+ format: 'date-time',
27805
+ type: 'string',
27806
+ },
27807
+ message: {
27808
+ description: 'Detailed description of the warning. Provides insights into the issue and potentially how to rectify it.',
27809
+ type: 'string',
27810
+ },
27811
+ warning_code: {
27812
+ description: 'Unique identifier of the type of warning. Enables quick recognition and categorization of the issue.',
27813
+ enum: ['device_communication_degraded'],
27814
+ type: 'string',
27815
+ },
27816
+ },
27817
+ required: ['message', 'created_at', 'warning_code'],
27818
+ type: 'object',
27819
+ },
27820
+ {
27821
+ description: 'Indicates that a scheduled maintenance window has been detected.',
27822
+ properties: {
27823
+ created_at: {
27824
+ description: 'Date and time at which Seam created the warning.',
27825
+ format: 'date-time',
27826
+ type: 'string',
27827
+ },
27828
+ message: {
27829
+ description: 'Detailed description of the warning. Provides insights into the issue and potentially how to rectify it.',
27830
+ type: 'string',
27831
+ },
27832
+ warning_code: {
27833
+ description: 'Unique identifier of the type of warning. Enables quick recognition and categorization of the issue.',
27834
+ enum: ['scheduled_maintenance_window'],
27835
+ type: 'string',
27836
+ },
27837
+ },
27838
+ required: ['message', 'created_at', 'warning_code'],
27839
+ type: 'object',
27840
+ },
27841
+ {
27842
+ description: 'Indicates that the device has a flaky connection.',
27843
+ properties: {
27844
+ created_at: {
27845
+ description: 'Date and time at which Seam created the warning.',
27846
+ format: 'date-time',
27847
+ type: 'string',
27848
+ },
27849
+ message: {
27850
+ description: 'Detailed description of the warning. Provides insights into the issue and potentially how to rectify it.',
27851
+ type: 'string',
27852
+ },
27853
+ warning_code: {
27854
+ description: 'Unique identifier of the type of warning. Enables quick recognition and categorization of the issue.',
27855
+ enum: ['device_has_flaky_connection'],
27856
+ type: 'string',
27857
+ },
27858
+ },
27859
+ required: ['message', 'created_at', 'warning_code'],
27860
+ type: 'object',
27861
+ },
27862
+ {
27863
+ description: 'Indicates that the Salto KS lock is in Office Mode. Access Codes will not unlock doors.',
27864
+ properties: {
27865
+ created_at: {
27866
+ description: 'Date and time at which Seam created the warning.',
27867
+ format: 'date-time',
27868
+ type: 'string',
27869
+ },
27870
+ message: {
27871
+ description: 'Detailed description of the warning. Provides insights into the issue and potentially how to rectify it.',
27872
+ type: 'string',
27873
+ },
27874
+ warning_code: {
27875
+ description: 'Unique identifier of the type of warning. Enables quick recognition and categorization of the issue.',
27876
+ enum: ['salto_ks_office_mode'],
27877
+ type: 'string',
27878
+ },
27879
+ },
27880
+ required: ['message', 'created_at', 'warning_code'],
27881
+ type: 'object',
27882
+ 'x-variant-group-key': 'access_codes',
27883
+ },
27884
+ {
27885
+ deprecated: true,
27886
+ description: 'Indicates that the Salto KS lock is in Privacy Mode. Access Codes will not unlock doors.',
27887
+ properties: {
27888
+ created_at: {
27889
+ description: 'Date and time at which Seam created the warning.',
27890
+ format: 'date-time',
27891
+ type: 'string',
27892
+ },
27893
+ message: {
27894
+ description: 'Detailed description of the warning. Provides insights into the issue and potentially how to rectify it.',
27895
+ type: 'string',
27896
+ },
27897
+ warning_code: {
27898
+ description: 'Unique identifier of the type of warning. Enables quick recognition and categorization of the issue.',
27899
+ enum: ['salto_ks_privacy_mode'],
27900
+ type: 'string',
27901
+ },
27902
+ },
27903
+ required: ['message', 'created_at', 'warning_code'],
27904
+ type: 'object',
27905
+ 'x-deprecated': 'Use `privacy_mode` instead.',
27906
+ 'x-variant-group-key': 'access_codes',
27907
+ },
27908
+ {
27909
+ description: 'Indicates that the lock is in Privacy Mode. Access codes and remote unlock are blocked until Privacy Mode is disabled.',
27910
+ properties: {
27911
+ created_at: {
27912
+ description: 'Date and time at which Seam created the warning.',
27913
+ format: 'date-time',
27914
+ type: 'string',
27915
+ },
27916
+ message: {
27917
+ description: 'Detailed description of the warning. Provides insights into the issue and potentially how to rectify it.',
27918
+ type: 'string',
27919
+ },
27920
+ warning_code: {
27921
+ description: 'Unique identifier of the type of warning. Enables quick recognition and categorization of the issue.',
27922
+ enum: ['privacy_mode'],
27923
+ type: 'string',
27924
+ },
27925
+ },
27926
+ required: ['message', 'created_at', 'warning_code'],
27927
+ type: 'object',
27928
+ 'x-variant-group-key': 'access_codes',
27929
+ },
27930
+ {
27931
+ description: 'Indicates that the Salto KS site has exceeded 80% of the maximum number of allowed users. Increase your subscription limit or delete some users from your site.',
27932
+ properties: {
27933
+ created_at: {
27934
+ description: 'Date and time at which Seam created the warning.',
27935
+ format: 'date-time',
27936
+ type: 'string',
27937
+ },
27938
+ message: {
27939
+ description: 'Detailed description of the warning. Provides insights into the issue and potentially how to rectify it.',
27940
+ type: 'string',
27941
+ },
27942
+ warning_code: {
27943
+ description: 'Unique identifier of the type of warning. Enables quick recognition and categorization of the issue.',
27944
+ enum: ['salto_ks_subscription_limit_almost_reached'],
27945
+ type: 'string',
27946
+ },
27947
+ },
27948
+ required: ['message', 'created_at', 'warning_code'],
27949
+ type: 'object',
27950
+ 'x-variant-group-key': 'locks',
27951
+ },
27952
+ {
27953
+ description: 'Indicates that a change in the reported device model has been detected for this Salto KS lock, which may occur after an IQ hub reset. Access code support may be affected. See https://help.getseam.com/articles/5098842588-salto-ks-lock-loses-access-code-support for troubleshooting steps.',
27954
+ properties: {
27955
+ created_at: {
27956
+ description: 'Date and time at which Seam created the warning.',
27957
+ format: 'date-time',
27958
+ type: 'string',
27959
+ },
27960
+ message: {
27961
+ description: 'Detailed description of the warning. Provides insights into the issue and potentially how to rectify it.',
27962
+ type: 'string',
27963
+ },
27964
+ warning_code: {
27965
+ description: 'Unique identifier of the type of warning. Enables quick recognition and categorization of the issue.',
27966
+ enum: ['salto_ks_lock_access_code_support_removed'],
27967
+ type: 'string',
27968
+ },
27969
+ },
27970
+ required: ['message', 'created_at', 'warning_code'],
27971
+ type: 'object',
27972
+ 'x-variant-group-key': 'access_codes',
27973
+ },
27974
+ {
27975
+ description: 'Indicates that an unknown issue occurred while syncing the state of the phone with the provider. This issue may affect the proper functioning of the phone.',
27976
+ properties: {
27977
+ created_at: {
27978
+ description: 'Date and time at which Seam created the warning.',
27979
+ format: 'date-time',
27980
+ type: 'string',
27981
+ },
27982
+ message: {
27983
+ description: 'Detailed description of the warning. Provides insights into the issue and potentially how to rectify it.',
27984
+ type: 'string',
27985
+ },
27986
+ warning_code: {
27987
+ description: 'Unique identifier of the type of warning. Enables quick recognition and categorization of the issue.',
27988
+ enum: ['unknown_issue_with_phone'],
27989
+ type: 'string',
27990
+ },
27991
+ },
27992
+ required: ['message', 'created_at', 'warning_code'],
27993
+ type: 'object',
27994
+ 'x-variant-group-key': 'phones',
27995
+ },
27996
+ {
27997
+ description: 'Indicates that Seam detected that the Lockly device does not have a time zone configured. Time-bound codes may not work as expected.',
27998
+ properties: {
27999
+ created_at: {
28000
+ description: 'Date and time at which Seam created the warning.',
28001
+ format: 'date-time',
28002
+ type: 'string',
28003
+ },
28004
+ message: {
28005
+ description: 'Detailed description of the warning. Provides insights into the issue and potentially how to rectify it.',
28006
+ type: 'string',
28007
+ },
28008
+ warning_code: {
28009
+ description: 'Unique identifier of the type of warning. Enables quick recognition and categorization of the issue.',
28010
+ enum: ['lockly_time_zone_not_configured'],
28011
+ type: 'string',
28012
+ },
28013
+ },
28014
+ required: ['message', 'created_at', 'warning_code'],
28015
+ type: 'object',
28016
+ 'x-variant-group-key': 'locks',
28017
+ },
28018
+ {
28019
+ description: 'Indicates that Seam does not know the time zone of the Ultraloq device. Set a time zone to enable time-bound access codes.',
28020
+ properties: {
28021
+ created_at: {
28022
+ description: 'Date and time at which Seam created the warning.',
28023
+ format: 'date-time',
28024
+ type: 'string',
28025
+ },
28026
+ message: {
28027
+ description: 'Detailed description of the warning. Provides insights into the issue and potentially how to rectify it.',
28028
+ type: 'string',
28029
+ },
28030
+ warning_code: {
28031
+ description: 'Unique identifier of the type of warning. Enables quick recognition and categorization of the issue.',
28032
+ enum: ['ultraloq_time_zone_unknown'],
28033
+ type: 'string',
28034
+ },
28035
+ },
28036
+ required: ['message', 'created_at', 'warning_code'],
28037
+ type: 'object',
28038
+ 'x-variant-group-key': 'locks',
28039
+ },
28040
+ {
28041
+ description: "Indicates that Seam does not know the device's time zone. Set a time zone to enable time-bound access codes.",
28042
+ properties: {
28043
+ created_at: {
28044
+ description: 'Date and time at which Seam created the warning.',
28045
+ format: 'date-time',
28046
+ type: 'string',
28047
+ },
28048
+ message: {
28049
+ description: 'Detailed description of the warning. Provides insights into the issue and potentially how to rectify it.',
28050
+ type: 'string',
28051
+ },
28052
+ warning_code: {
28053
+ description: 'Unique identifier of the type of warning. Enables quick recognition and categorization of the issue.',
28054
+ enum: ['time_zone_unknown'],
28055
+ type: 'string',
28056
+ },
28057
+ },
28058
+ required: ['message', 'created_at', 'warning_code'],
28059
+ type: 'object',
28060
+ 'x-variant-group-key': 'locks',
28061
+ },
28062
+ {
28063
+ description: "Indicates that the device's configured time zone does not match its hardware UTC offset. Time-bound access codes may activate at the wrong local time.",
28064
+ properties: {
28065
+ created_at: {
28066
+ description: 'Date and time at which Seam created the warning.',
28067
+ format: 'date-time',
28068
+ type: 'string',
28069
+ },
28070
+ message: {
28071
+ description: 'Detailed description of the warning. Provides insights into the issue and potentially how to rectify it.',
28072
+ type: 'string',
28073
+ },
28074
+ warning_code: {
28075
+ description: 'Unique identifier of the type of warning. Enables quick recognition and categorization of the issue.',
28076
+ enum: ['time_zone_mismatch'],
28077
+ type: 'string',
28078
+ },
28079
+ },
28080
+ required: ['message', 'created_at', 'warning_code'],
28081
+ type: 'object',
28082
+ 'x-variant-group-key': 'locks',
28083
+ },
28084
+ {
28085
+ description: 'Indicates that the 2N device does not have a time zone configured. Configure a time zone on the device to enable access codes.',
28086
+ properties: {
28087
+ created_at: {
28088
+ description: 'Date and time at which Seam created the warning.',
28089
+ format: 'date-time',
28090
+ type: 'string',
28091
+ },
28092
+ message: {
28093
+ description: 'Detailed description of the warning. Provides insights into the issue and potentially how to rectify it.',
28094
+ type: 'string',
28095
+ },
28096
+ warning_code: {
28097
+ description: 'Unique identifier of the type of warning. Enables quick recognition and categorization of the issue.',
28098
+ enum: ['two_n_device_missing_timezone'],
28099
+ type: 'string',
28100
+ },
28101
+ },
28102
+ required: ['message', 'created_at', 'warning_code'],
28103
+ type: 'object',
28104
+ 'x-variant-group-key': 'locks',
28105
+ },
28106
+ {
28107
+ description: 'Indicates that a hub or relay must be connected to unlock additional capabilities such as remote unlock.',
28108
+ properties: {
28109
+ created_at: {
28110
+ description: 'Date and time at which Seam created the warning.',
28111
+ format: 'date-time',
28112
+ type: 'string',
28113
+ },
28114
+ message: {
28115
+ description: 'Detailed description of the warning. Provides insights into the issue and potentially how to rectify it.',
28116
+ type: 'string',
28117
+ },
28118
+ warning_code: {
28119
+ description: 'Unique identifier of the type of warning. Enables quick recognition and categorization of the issue.',
28120
+ enum: ['hub_required_for_additional_capabilities'],
28121
+ type: 'string',
28122
+ },
28123
+ },
28124
+ required: ['message', 'created_at', 'warning_code'],
28125
+ type: 'object',
28126
+ 'x-variant-group-key': 'locks',
28127
+ },
28128
+ {
28129
+ description: 'Indicates a provider-specific issue that may affect device functionality.',
28130
+ properties: {
28131
+ created_at: {
28132
+ description: 'Date and time at which Seam created the warning.',
28133
+ format: 'date-time',
28134
+ type: 'string',
28135
+ },
28136
+ message: {
28137
+ description: 'Detailed description of the warning. Provides insights into the issue and potentially how to rectify it.',
28138
+ type: 'string',
28139
+ },
28140
+ warning_code: {
28141
+ description: 'Unique identifier of the type of warning. Enables quick recognition and categorization of the issue.',
28142
+ enum: ['provider_issue'],
28143
+ type: 'string',
28144
+ },
28145
+ },
28146
+ required: ['message', 'created_at', 'warning_code'],
28147
+ type: 'object',
28148
+ 'x-variant-group-key': 'access_codes',
28149
+ },
28150
+ {
28151
+ description: 'Indicates that the key is in a locker that does not support the access codes API.',
28152
+ properties: {
28153
+ created_at: {
28154
+ description: 'Date and time at which Seam created the warning.',
28155
+ format: 'date-time',
28156
+ type: 'string',
28157
+ },
28158
+ message: {
28159
+ description: 'Detailed description of the warning. Provides insights into the issue and potentially how to rectify it.',
28160
+ type: 'string',
28161
+ },
28162
+ warning_code: {
28163
+ description: 'Unique identifier of the type of warning. Enables quick recognition and categorization of the issue.',
28164
+ enum: ['keynest_unsupported_locker'],
28165
+ type: 'string',
28166
+ },
28167
+ },
28168
+ required: ['message', 'created_at', 'warning_code'],
28169
+ type: 'object',
28170
+ 'x-variant-group-key': 'locks',
28171
+ },
28172
+ {
28173
+ description: 'Indicates that the accessory keypad exists, but is not linked to the Igloohome Bridge. Online access code programming will fail until the keypad is linked to the Igloohome Bridge in the Igloohome app.',
28174
+ properties: {
28175
+ created_at: {
28176
+ description: 'Date and time at which Seam created the warning.',
28177
+ format: 'date-time',
28178
+ type: 'string',
28179
+ },
28180
+ message: {
28181
+ description: 'Detailed description of the warning. Provides insights into the issue and potentially how to rectify it.',
28182
+ type: 'string',
28183
+ },
28184
+ warning_code: {
28185
+ description: 'Unique identifier of the type of warning. Enables quick recognition and categorization of the issue.',
28186
+ enum: ['accessory_keypad_setup_required'],
28187
+ type: 'string',
28188
+ },
28189
+ },
28190
+ required: ['message', 'created_at', 'warning_code'],
28191
+ type: 'object',
28192
+ 'x-variant-group-key': 'locks',
28193
+ },
28194
+ {
28195
+ description: 'Indicates that the accessory keypad paired with this lock has a low or critically low battery. Replace its batteries so guests can keep entering their access codes.',
28196
+ properties: {
28197
+ created_at: {
28198
+ description: 'Date and time at which Seam created the warning.',
28199
+ format: 'date-time',
28200
+ type: 'string',
28201
+ },
28202
+ message: {
28203
+ description: 'Detailed description of the warning. Provides insights into the issue and potentially how to rectify it.',
28204
+ type: 'string',
28205
+ },
28206
+ warning_code: {
28207
+ description: 'Unique identifier of the type of warning. Enables quick recognition and categorization of the issue.',
28208
+ enum: ['accessory_keypad_low_battery'],
28209
+ type: 'string',
28210
+ },
28211
+ },
28212
+ required: ['message', 'created_at', 'warning_code'],
28213
+ type: 'object',
28214
+ 'x-variant-group-key': 'locks',
28215
+ },
28216
+ {
28217
+ description: 'Indicates that the device may optimistically be reported as online because the provider does not reliably report its online status.',
28218
+ properties: {
28219
+ created_at: {
28220
+ description: 'Date and time at which Seam created the warning.',
28221
+ format: 'date-time',
28222
+ type: 'string',
28223
+ },
28224
+ message: {
28225
+ description: 'Detailed description of the warning. Provides insights into the issue and potentially how to rectify it.',
28226
+ type: 'string',
28227
+ },
28228
+ warning_code: {
28229
+ description: 'Unique identifier of the type of warning. Enables quick recognition and categorization of the issue.',
28230
+ enum: ['unreliable_online_status'],
28231
+ type: 'string',
28232
+ },
28233
+ },
28234
+ required: ['message', 'created_at', 'warning_code'],
28235
+ type: 'object',
28236
+ 'x-variant-group-key': 'locks',
28237
+ },
28238
+ {
28239
+ description: 'Indicates that the device has reached its maximum number of active access codes. Delete existing codes before creating new ones.',
28240
+ properties: {
28241
+ active_access_code_count: {
28242
+ description: 'Number of active access codes on the device when the warning was set.',
28243
+ type: 'integer',
28244
+ },
28245
+ created_at: {
28246
+ description: 'Date and time at which Seam created the warning.',
28247
+ format: 'date-time',
28248
+ type: 'string',
28249
+ },
28250
+ max_active_access_code_count: {
28251
+ description: 'Maximum number of active access codes supported by the device.',
28252
+ type: 'integer',
28253
+ },
28254
+ message: {
28255
+ description: 'Detailed description of the warning. Provides insights into the issue and potentially how to rectify it.',
28256
+ type: 'string',
28257
+ },
28258
+ warning_code: {
28259
+ description: 'Unique identifier of the type of warning. Enables quick recognition and categorization of the issue.',
28260
+ enum: ['max_access_codes_reached'],
28261
+ type: 'string',
28262
+ },
28263
+ },
28264
+ required: [
28265
+ 'message',
28266
+ 'created_at',
28267
+ 'warning_code',
28268
+ 'active_access_code_count',
28269
+ 'max_active_access_code_count',
28270
+ ],
28271
+ type: 'object',
28272
+ 'x-variant-group-key': 'access_codes',
28273
+ },
28274
+ ],
28275
+ },
28276
+ type: 'array',
28277
+ 'x-variant-groups': {
28278
+ access_codes: { name: 'Access Codes' },
28279
+ hardware: { name: 'Hardware' },
28280
+ locks: { name: 'Locks' },
28281
+ noise_sensors: { name: 'Noise Sensors' },
28282
+ phones: { name: 'Phones' },
28283
+ provider_metadata: { name: 'Provider Metadata' },
28284
+ thermostats: { name: 'Thermostats' },
28285
+ },
28286
+ },
28287
+ workspace_id: {
28288
+ description: 'ID of the workspace that contains the phone.\n ',
28289
+ format: 'uuid',
28290
+ type: 'string',
28291
+ },
28292
+ },
28293
+ required: [
28294
+ 'device_id',
28295
+ 'display_name',
28296
+ 'workspace_id',
28297
+ 'created_at',
28298
+ 'custom_metadata',
28299
+ 'errors',
28300
+ 'warnings',
28301
+ 'device_type',
28302
+ 'properties',
28303
+ ],
28304
+ type: 'object',
28305
+ 'x-property-groups': { phones: { name: 'Phones' } },
28306
+ 'x-route-path': '/phones',
28307
+ },
28308
+ phone_registration: {
28309
+ description: 'Represents a mobile phone registration.',
28310
+ properties: {
28311
+ is_being_activated: {
28312
+ description: 'Indicates whether the phone is being activated.',
28313
+ type: 'boolean',
28314
+ },
28315
+ phone_registration_id: {
28316
+ description: 'Registration ID for the phone.',
28317
+ type: 'string',
28318
+ },
28319
+ provider_name: {
28320
+ description: 'Provider name for the phone.',
28321
+ nullable: true,
28322
+ type: 'string',
28323
+ },
28324
+ provider_state: {
28325
+ additionalProperties: {},
28326
+ description: 'Provider state for the phone.',
28327
+ nullable: true,
28328
+ type: 'object',
28329
+ },
28330
+ },
28331
+ required: [
28332
+ 'phone_registration_id',
28333
+ 'provider_state',
28334
+ 'provider_name',
28335
+ 'is_being_activated',
28336
+ ],
28337
+ type: 'object',
28338
+ 'x-route-path': '/seam/mobile_sdk/v1/phone_sessions',
28339
+ 'x-undocumented': 'Seam Mobile SDK only.',
28340
+ },
28341
+ phone_session: {
28342
+ description: 'Represents a mobile phone session.',
28343
+ properties: {
28344
+ is_sandbox_workspace: {
28345
+ description: 'Whether the workspace is in sandbox mode.',
28346
+ type: 'boolean',
28347
+ },
28348
+ provider_sessions: {
28349
+ description: 'Phone provider sessions.',
28350
+ items: {
28351
+ description: 'Phone provider session.',
28352
+ properties: {
28353
+ acs_credentials: {
28354
+ description: 'Access system credentials associated with the phone provider session.',
28355
+ items: {
28356
+ description: 'Means by which an [access control system user](https://www.seam.co/docs/low-level-apis/access-systems/user-management) gains access at an [entrance](https://www.seam.co/docs/low-level-apis/access-systems/retrieving-entrance-details). The `acs_credential` object represents a [credential](https://www.seam.co/docs/low-level-apis/access-systems/managing-credentials) that provides an ACS user access within an [access control system](https://www.seam.co/docs/low-level-apis/access-systems).\n\nAn access control system generally uses digital means of access to authorize a user trying to get through a specific entrance. Examples of credentials include plastic key cards, mobile keys, biometric identifiers, and PIN codes. The electronic nature of these credentials, as well as the fact that access is centralized, enables both the rapid provisioning and rescinding of access and the ability to compile access audit logs.\n\nFor each `acs_credential`, you define the access method. You can also specify additional properties, such as a PIN code, depending on the credential type.\n\nFor granting a person access to a space, [Access Grants](https://www.seam.co/docs/use-cases/granting-access) are the default and recommended approach. Use the lower-level ACS credential API directly only when you specifically need to manage individual credentials.',
28357
+ properties: {
28358
+ access_method: {
28359
+ description: 'Access method for the [credential](https://www.seam.co/docs/low-level-apis/access-systems/managing-credentials). Supported values: `code`, `card`, `mobile_key`, `cloud_key`.',
28360
+ enum: ['code', 'card', 'mobile_key', 'cloud_key'],
28361
+ type: 'string',
28362
+ },
28363
+ acs_credential_id: { nullable: true, type: 'string' },
28364
+ acs_credential_pool_id: {
28365
+ description: 'ID of the credential pool to which the credential belongs.',
28366
+ format: 'uuid',
28367
+ type: 'string',
28368
+ },
28369
+ acs_entrances: {
28370
+ items: {
28371
+ description: 'Represents an [entrance](https://www.seam.co/docs/low-level-apis/access-systems/retrieving-entrance-details) within an [access control system](https://www.seam.co/docs/low-level-apis/access-systems).\n\nIn an access control system, an entrance is a secured door, gate, zone, or other method of entry. You can list details for all the `acs_entrance` resources in your workspace or get these details for a specific `acs_entrance`. You can also list all entrances associated with a specific credential, and you can list all credentials associated with a specific entrance.',
28372
+ properties: {
28373
+ acs_entrance_id: {
28374
+ description: 'ID of the [entrance](https://www.seam.co/docs/low-level-apis/access-systems/retrieving-entrance-details).',
28375
+ format: 'uuid',
28376
+ type: 'string',
28377
+ },
28378
+ acs_system_id: {
28379
+ description: 'ID of the [access control system](https://www.seam.co/docs/low-level-apis/access-systems) that contains the [entrance](https://www.seam.co/docs/low-level-apis/access-systems/retrieving-entrance-details).',
28380
+ format: 'uuid',
28381
+ type: 'string',
28382
+ },
28383
+ akiles_metadata: {
27279
28384
  description: 'Akiles-specific metadata associated with the [entrance](https://www.seam.co/docs/low-level-apis/access-systems/retrieving-entrance-details).',
27280
28385
  properties: {
27281
28386
  actions: {
@@ -27456,27 +28561,36 @@ const openapi = {
27456
28561
  errors: {
27457
28562
  description: 'Errors associated with the [entrance](https://www.seam.co/docs/low-level-apis/access-systems/retrieving-entrance-details).',
27458
28563
  items: {
27459
- properties: {
27460
- created_at: {
27461
- description: 'Date and time at which Seam created the error.',
27462
- format: 'date-time',
27463
- type: 'string',
27464
- },
27465
- error_code: {
27466
- description: 'Unique identifier of the type of error. Enables quick recognition and categorization of the issue.',
27467
- type: 'string',
27468
- },
27469
- message: {
27470
- description: 'Detailed description of the error. Provides insights into the issue and potentially how to rectify it.',
27471
- type: 'string',
28564
+ description: 'Error associated with the [entrance](https://www.seam.co/docs/low-level-apis/access-systems/retrieving-entrance-details).',
28565
+ discriminator: { propertyName: 'error_code' },
28566
+ oneOf: [
28567
+ {
28568
+ description: 'Indicates that the [entrance](https://www.seam.co/docs/low-level-apis/access-systems/retrieving-entrance-details) was removed from the connected account, so Seam can no longer sync it.',
28569
+ properties: {
28570
+ created_at: {
28571
+ description: 'Date and time at which Seam created the error.',
28572
+ format: 'date-time',
28573
+ type: 'string',
28574
+ },
28575
+ error_code: {
28576
+ description: 'Unique identifier of the type of error. Enables quick recognition and categorization of the issue.',
28577
+ enum: ['entrance_removed'],
28578
+ type: 'string',
28579
+ },
28580
+ message: {
28581
+ description: 'Detailed description of the error. Provides insights into the issue and potentially how to rectify it.',
28582
+ type: 'string',
28583
+ },
28584
+ },
28585
+ required: [
28586
+ 'created_at',
28587
+ 'message',
28588
+ 'error_code',
28589
+ ],
28590
+ type: 'object',
28591
+ 'x-resource-type': 'acs_entrance',
27472
28592
  },
27473
- },
27474
- required: [
27475
- 'error_code',
27476
- 'message',
27477
- 'created_at',
27478
28593
  ],
27479
- type: 'object',
27480
28594
  },
27481
28595
  type: 'array',
27482
28596
  },
@@ -30459,7 +31573,8 @@ const openapi = {
30459
31573
  type: 'string',
30460
31574
  },
30461
31575
  error_code: {
30462
- description: 'Reason the access code could not be revoked (e.g. `offline_access_code_not_revocable`).',
31576
+ description: 'Reason the access code could not be revoked.',
31577
+ enum: ['offline_access_code_not_revocable'],
30463
31578
  type: 'string',
30464
31579
  },
30465
31580
  message: {
@@ -45207,7 +46322,7 @@ const openapi = {
45207
46322
  },
45208
46323
  '/customers/delete_data': {
45209
46324
  delete: {
45210
- description: 'Deletes customer data including resources like spaces, properties, rooms, users, etc.\nThis will delete the partner resources and any related Seam resources (user identities, access grants, spaces).',
46325
+ description: 'Deletes customer data including resources like spaces, properties, rooms, users, etc.\nThis will delete the partner resources and any related Seam resources (user identities, access grants, spaces).\nSpace keys also match spaces created directly with a `space_key` (for example, through `/spaces/create`).',
45211
46326
  operationId: 'customersDeleteDataDelete',
45212
46327
  parameters: [
45213
46328
  {