@seamapi/types 1.401.0 → 1.402.0
This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
- package/dist/connect.cjs +638 -4
- package/dist/connect.cjs.map +1 -1
- package/dist/connect.d.cts +834 -71
- package/lib/seam/connect/internal/schemas.d.ts +1 -1
- package/lib/seam/connect/internal/schemas.js +1 -1
- package/lib/seam/connect/internal/schemas.js.map +1 -1
- package/lib/seam/connect/models/index.d.ts +1 -0
- package/lib/seam/connect/models/index.js +1 -0
- package/lib/seam/connect/models/index.js.map +1 -1
- package/lib/seam/connect/models/phones/index.d.ts +2 -0
- package/lib/seam/connect/models/phones/index.js +3 -0
- package/lib/seam/connect/models/phones/index.js.map +1 -0
- package/lib/seam/connect/models/phones/phone-registration.d.ts +18 -0
- package/lib/seam/connect/models/phones/phone-registration.js +13 -0
- package/lib/seam/connect/models/phones/phone-registration.js.map +1 -0
- package/lib/seam/connect/models/phones/phone-session.d.ts +2060 -0
- package/lib/seam/connect/models/phones/phone-session.js +21 -0
- package/lib/seam/connect/models/phones/phone-session.js.map +1 -0
- package/lib/seam/connect/openapi.d.ts +556 -0
- package/lib/seam/connect/openapi.js +638 -4
- package/lib/seam/connect/openapi.js.map +1 -1
- package/lib/seam/connect/route-types.d.ts +209 -2
- package/package.json +1 -1
- package/src/lib/seam/connect/internal/schemas.ts +2 -0
- package/src/lib/seam/connect/models/index.ts +1 -0
- package/src/lib/seam/connect/models/phones/index.ts +2 -0
- package/src/lib/seam/connect/models/phones/phone-registration.ts +15 -0
- package/src/lib/seam/connect/models/phones/phone-session.ts +27 -0
- package/src/lib/seam/connect/openapi.ts +704 -4
- package/src/lib/seam/connect/route-types.ts +263 -2
|
@@ -15116,6 +15116,636 @@ export default {
|
|
|
15116
15116
|
type: 'object',
|
|
15117
15117
|
'x-route-path': '/phones',
|
|
15118
15118
|
},
|
|
15119
|
+
phone_registration: {
|
|
15120
|
+
properties: {
|
|
15121
|
+
is_being_activated: { type: 'boolean' },
|
|
15122
|
+
phone_registration_id: { type: 'string' },
|
|
15123
|
+
provider_name: { nullable: true, type: 'string' },
|
|
15124
|
+
provider_state: {},
|
|
15125
|
+
},
|
|
15126
|
+
required: [
|
|
15127
|
+
'phone_registration_id',
|
|
15128
|
+
'provider_name',
|
|
15129
|
+
'is_being_activated',
|
|
15130
|
+
],
|
|
15131
|
+
type: 'object',
|
|
15132
|
+
'x-route-path': '/seam/mobile_sdk/v1/phone_sessions',
|
|
15133
|
+
'x-undocumented': 'Seam Mobile SDK only.',
|
|
15134
|
+
},
|
|
15135
|
+
phone_session: {
|
|
15136
|
+
properties: {
|
|
15137
|
+
provider_sessions: {
|
|
15138
|
+
items: {
|
|
15139
|
+
properties: {
|
|
15140
|
+
acs_credentials: {
|
|
15141
|
+
items: {
|
|
15142
|
+
description:
|
|
15143
|
+
'Means by which an [access control system user](https://docs.seam.co/latest/capability-guides/access-systems/user-management) gains access at an [entrance](https://docs.seam.co/latest/capability-guides/access-systems/retrieving-entrance-details). The `acs_credential` object represents a [credential](https://docs.seam.co/latest/capability-guides/access-systems/managing-credentials) that provides an ACS user access within an [access control system](https://docs.seam.co/latest/capability-guides/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.',
|
|
15144
|
+
properties: {
|
|
15145
|
+
access_method: {
|
|
15146
|
+
description:
|
|
15147
|
+
'Access method for the [credential](https://docs.seam.co/latest/capability-guides/access-systems/managing-credentials). Supported values: `code`, `card`, `mobile_key`.',
|
|
15148
|
+
enum: ['code', 'card', 'mobile_key'],
|
|
15149
|
+
type: 'string',
|
|
15150
|
+
},
|
|
15151
|
+
acs_credential_id: {
|
|
15152
|
+
description:
|
|
15153
|
+
'ID of the [credential](https://docs.seam.co/latest/capability-guides/access-systems/managing-credentials).',
|
|
15154
|
+
format: 'uuid',
|
|
15155
|
+
type: 'string',
|
|
15156
|
+
},
|
|
15157
|
+
acs_credential_pool_id: {
|
|
15158
|
+
format: 'uuid',
|
|
15159
|
+
type: 'string',
|
|
15160
|
+
},
|
|
15161
|
+
acs_entrances: {
|
|
15162
|
+
items: {
|
|
15163
|
+
description:
|
|
15164
|
+
'Represents an [entrance](https://docs.seam.co/latest/capability-guides/access-systems/retrieving-entrance-details) within an [access control system](https://docs.seam.co/latest/capability-guides/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.',
|
|
15165
|
+
properties: {
|
|
15166
|
+
acs_entrance_id: {
|
|
15167
|
+
description:
|
|
15168
|
+
'ID of the [entrance](https://docs.seam.co/latest/capability-guides/access-systems/retrieving-entrance-details).',
|
|
15169
|
+
format: 'uuid',
|
|
15170
|
+
type: 'string',
|
|
15171
|
+
},
|
|
15172
|
+
acs_system_id: {
|
|
15173
|
+
description:
|
|
15174
|
+
'ID of the [access control system](https://docs.seam.co/latest/capability-guides/access-systems) that contains the [entrance](https://docs.seam.co/latest/capability-guides/access-systems/retrieving-entrance-details).',
|
|
15175
|
+
format: 'uuid',
|
|
15176
|
+
type: 'string',
|
|
15177
|
+
},
|
|
15178
|
+
assa_abloy_vostio_metadata: {
|
|
15179
|
+
description:
|
|
15180
|
+
'ASSA ABLOY Vostio-specific metadata associated with the [entrance](https://docs.seam.co/latest/capability-guides/access-systems/retrieving-entrance-details).',
|
|
15181
|
+
properties: {
|
|
15182
|
+
door_name: { type: 'string' },
|
|
15183
|
+
door_number: {
|
|
15184
|
+
format: 'float',
|
|
15185
|
+
type: 'number',
|
|
15186
|
+
},
|
|
15187
|
+
door_type: {
|
|
15188
|
+
enum: [
|
|
15189
|
+
'CommonDoor',
|
|
15190
|
+
'EntranceDoor',
|
|
15191
|
+
'GuestDoor',
|
|
15192
|
+
'Elevator',
|
|
15193
|
+
],
|
|
15194
|
+
type: 'string',
|
|
15195
|
+
},
|
|
15196
|
+
pms_id: { type: 'string' },
|
|
15197
|
+
stand_open: { type: 'boolean' },
|
|
15198
|
+
},
|
|
15199
|
+
required: ['door_type', 'door_name'],
|
|
15200
|
+
type: 'object',
|
|
15201
|
+
},
|
|
15202
|
+
created_at: {
|
|
15203
|
+
description:
|
|
15204
|
+
'Date and time at which the [entrance](https://docs.seam.co/latest/capability-guides/access-systems/retrieving-entrance-details) was created.',
|
|
15205
|
+
format: 'date-time',
|
|
15206
|
+
type: 'string',
|
|
15207
|
+
},
|
|
15208
|
+
display_name: {
|
|
15209
|
+
description:
|
|
15210
|
+
'Display name for the [entrance](https://docs.seam.co/latest/capability-guides/access-systems/retrieving-entrance-details).',
|
|
15211
|
+
type: 'string',
|
|
15212
|
+
},
|
|
15213
|
+
dormakaba_community_metadata: {
|
|
15214
|
+
description:
|
|
15215
|
+
'dormakaba Community-specific metadata associated with the [entrance](https://docs.seam.co/latest/capability-guides/access-systems/retrieving-entrance-details).',
|
|
15216
|
+
properties: {
|
|
15217
|
+
access_point_name: { type: 'string' },
|
|
15218
|
+
},
|
|
15219
|
+
required: ['access_point_name'],
|
|
15220
|
+
type: 'object',
|
|
15221
|
+
},
|
|
15222
|
+
errors: {
|
|
15223
|
+
description:
|
|
15224
|
+
'Errors associated with the [entrance](https://docs.seam.co/latest/capability-guides/access-systems/retrieving-entrance-details).',
|
|
15225
|
+
items: {
|
|
15226
|
+
properties: {
|
|
15227
|
+
error_code: {
|
|
15228
|
+
description:
|
|
15229
|
+
'Unique identifier of the type of error. Enables quick recognition and categorization of the issue.',
|
|
15230
|
+
type: 'string',
|
|
15231
|
+
},
|
|
15232
|
+
message: {
|
|
15233
|
+
description:
|
|
15234
|
+
'Detailed description of the error. Provides insights into the issue and potentially how to rectify it.',
|
|
15235
|
+
type: 'string',
|
|
15236
|
+
},
|
|
15237
|
+
},
|
|
15238
|
+
required: ['error_code', 'message'],
|
|
15239
|
+
type: 'object',
|
|
15240
|
+
},
|
|
15241
|
+
type: 'array',
|
|
15242
|
+
},
|
|
15243
|
+
latch_metadata: {
|
|
15244
|
+
description:
|
|
15245
|
+
'Latch-specific metadata associated with the [entrance](https://docs.seam.co/latest/capability-guides/access-systems/retrieving-entrance-details).',
|
|
15246
|
+
properties: {
|
|
15247
|
+
accessibility_type: { type: 'string' },
|
|
15248
|
+
door_name: { type: 'string' },
|
|
15249
|
+
door_type: { type: 'string' },
|
|
15250
|
+
is_connected: { type: 'boolean' },
|
|
15251
|
+
},
|
|
15252
|
+
required: [
|
|
15253
|
+
'accessibility_type',
|
|
15254
|
+
'door_name',
|
|
15255
|
+
'door_type',
|
|
15256
|
+
'is_connected',
|
|
15257
|
+
],
|
|
15258
|
+
type: 'object',
|
|
15259
|
+
},
|
|
15260
|
+
salto_ks_metadata: {
|
|
15261
|
+
description:
|
|
15262
|
+
'Salto KS-specific metadata associated with the [entrance](https://docs.seam.co/latest/capability-guides/access-systems/retrieving-entrance-details).',
|
|
15263
|
+
properties: {
|
|
15264
|
+
battery_level: { type: 'string' },
|
|
15265
|
+
door_name: { type: 'string' },
|
|
15266
|
+
intrusion_alarm: { type: 'boolean' },
|
|
15267
|
+
left_open_alarm: { type: 'boolean' },
|
|
15268
|
+
lock_type: { type: 'string' },
|
|
15269
|
+
locked_state: { type: 'string' },
|
|
15270
|
+
online: { type: 'boolean' },
|
|
15271
|
+
privacy_mode: { type: 'boolean' },
|
|
15272
|
+
},
|
|
15273
|
+
required: [
|
|
15274
|
+
'door_name',
|
|
15275
|
+
'locked_state',
|
|
15276
|
+
'lock_type',
|
|
15277
|
+
'battery_level',
|
|
15278
|
+
],
|
|
15279
|
+
type: 'object',
|
|
15280
|
+
},
|
|
15281
|
+
salto_space_metadata: {
|
|
15282
|
+
description:
|
|
15283
|
+
'Salto Space-specific metadata associated with the [entrance](https://docs.seam.co/latest/capability-guides/access-systems/retrieving-entrance-details).',
|
|
15284
|
+
properties: {
|
|
15285
|
+
door_description: { type: 'string' },
|
|
15286
|
+
door_name: { type: 'string' },
|
|
15287
|
+
ext_door_id: { type: 'string' },
|
|
15288
|
+
},
|
|
15289
|
+
required: ['door_name', 'ext_door_id'],
|
|
15290
|
+
type: 'object',
|
|
15291
|
+
},
|
|
15292
|
+
visionline_metadata: {
|
|
15293
|
+
description:
|
|
15294
|
+
'Visionline-specific metadata associated with the [entrance](https://docs.seam.co/latest/capability-guides/access-systems/retrieving-entrance-details).',
|
|
15295
|
+
properties: {
|
|
15296
|
+
door_category: {
|
|
15297
|
+
enum: [
|
|
15298
|
+
'entrance',
|
|
15299
|
+
'guest',
|
|
15300
|
+
'elevator reader',
|
|
15301
|
+
'common',
|
|
15302
|
+
'common (PMS)',
|
|
15303
|
+
],
|
|
15304
|
+
type: 'string',
|
|
15305
|
+
},
|
|
15306
|
+
door_name: { type: 'string' },
|
|
15307
|
+
profiles: {
|
|
15308
|
+
items: {
|
|
15309
|
+
properties: {
|
|
15310
|
+
visionline_door_profile_id: {
|
|
15311
|
+
type: 'string',
|
|
15312
|
+
},
|
|
15313
|
+
visionline_door_profile_type: {
|
|
15314
|
+
enum: ['BLE', 'commonDoor', 'touch'],
|
|
15315
|
+
type: 'string',
|
|
15316
|
+
},
|
|
15317
|
+
},
|
|
15318
|
+
required: [
|
|
15319
|
+
'visionline_door_profile_id',
|
|
15320
|
+
'visionline_door_profile_type',
|
|
15321
|
+
],
|
|
15322
|
+
type: 'object',
|
|
15323
|
+
},
|
|
15324
|
+
type: 'array',
|
|
15325
|
+
},
|
|
15326
|
+
},
|
|
15327
|
+
required: ['door_name', 'door_category'],
|
|
15328
|
+
type: 'object',
|
|
15329
|
+
},
|
|
15330
|
+
},
|
|
15331
|
+
required: [
|
|
15332
|
+
'acs_system_id',
|
|
15333
|
+
'acs_entrance_id',
|
|
15334
|
+
'created_at',
|
|
15335
|
+
'display_name',
|
|
15336
|
+
'errors',
|
|
15337
|
+
],
|
|
15338
|
+
type: 'object',
|
|
15339
|
+
'x-route-path': '/acs/entrances',
|
|
15340
|
+
},
|
|
15341
|
+
type: 'array',
|
|
15342
|
+
},
|
|
15343
|
+
acs_system_id: {
|
|
15344
|
+
description:
|
|
15345
|
+
'ID of the [access control system](https://docs.seam.co/latest/capability-guides/access-systems) that contains the [credential](https://docs.seam.co/latest/capability-guides/access-systems/managing-credentials).',
|
|
15346
|
+
format: 'uuid',
|
|
15347
|
+
type: 'string',
|
|
15348
|
+
},
|
|
15349
|
+
acs_user_id: {
|
|
15350
|
+
description:
|
|
15351
|
+
'ID of the [ACS user](https://docs.seam.co/latest/capability-guides/access-systems/user-management) to whom the [credential](https://docs.seam.co/latest/capability-guides/access-systems/managing-credentials) belongs.',
|
|
15352
|
+
format: 'uuid',
|
|
15353
|
+
type: 'string',
|
|
15354
|
+
},
|
|
15355
|
+
assa_abloy_vostio_metadata: {
|
|
15356
|
+
description:
|
|
15357
|
+
'Vostio-specific metadata for the [credential](https://docs.seam.co/latest/capability-guides/access-systems/managing-credentials).',
|
|
15358
|
+
properties: {
|
|
15359
|
+
auto_join: { type: 'boolean' },
|
|
15360
|
+
door_names: {
|
|
15361
|
+
items: { type: 'string' },
|
|
15362
|
+
type: 'array',
|
|
15363
|
+
},
|
|
15364
|
+
endpoint_id: { type: 'string' },
|
|
15365
|
+
key_id: { type: 'string' },
|
|
15366
|
+
key_issuing_request_id: { type: 'string' },
|
|
15367
|
+
override_guest_acs_entrance_ids: {
|
|
15368
|
+
items: { type: 'string' },
|
|
15369
|
+
type: 'array',
|
|
15370
|
+
},
|
|
15371
|
+
},
|
|
15372
|
+
type: 'object',
|
|
15373
|
+
},
|
|
15374
|
+
card_number: {
|
|
15375
|
+
description:
|
|
15376
|
+
'Number of the card associated with the [credential](https://docs.seam.co/latest/capability-guides/access-systems/managing-credentials).',
|
|
15377
|
+
nullable: true,
|
|
15378
|
+
type: 'string',
|
|
15379
|
+
},
|
|
15380
|
+
code: {
|
|
15381
|
+
description:
|
|
15382
|
+
'Access (PIN) code for the [credential](https://docs.seam.co/latest/capability-guides/access-systems/managing-credentials).',
|
|
15383
|
+
nullable: true,
|
|
15384
|
+
type: 'string',
|
|
15385
|
+
},
|
|
15386
|
+
created_at: {
|
|
15387
|
+
description:
|
|
15388
|
+
'Date and time at which the [credential](https://docs.seam.co/latest/capability-guides/access-systems/managing-credentials) was created.',
|
|
15389
|
+
format: 'date-time',
|
|
15390
|
+
type: 'string',
|
|
15391
|
+
},
|
|
15392
|
+
display_name: {
|
|
15393
|
+
description:
|
|
15394
|
+
'Display name that corresponds to the [credential](https://docs.seam.co/latest/capability-guides/access-systems/managing-credentials) type.',
|
|
15395
|
+
minLength: 1,
|
|
15396
|
+
type: 'string',
|
|
15397
|
+
},
|
|
15398
|
+
ends_at: {
|
|
15399
|
+
description:
|
|
15400
|
+
'Date and time at which the [credential](https://docs.seam.co/latest/capability-guides/access-systems/managing-credentials) validity ends, in [ISO 8601](https://www.iso.org/iso-8601-date-and-time-format.html) format. Must be a time in the future and after `starts_at`.',
|
|
15401
|
+
type: 'string',
|
|
15402
|
+
},
|
|
15403
|
+
errors: {
|
|
15404
|
+
description:
|
|
15405
|
+
'Errors associated with the [credential](https://docs.seam.co/latest/capability-guides/access-systems/managing-credentials).',
|
|
15406
|
+
items: {
|
|
15407
|
+
properties: {
|
|
15408
|
+
error_code: { type: 'string' },
|
|
15409
|
+
message: { type: 'string' },
|
|
15410
|
+
},
|
|
15411
|
+
required: ['error_code', 'message'],
|
|
15412
|
+
type: 'object',
|
|
15413
|
+
},
|
|
15414
|
+
type: 'array',
|
|
15415
|
+
},
|
|
15416
|
+
external_type: {
|
|
15417
|
+
description:
|
|
15418
|
+
'Brand-specific terminology for the [credential](https://docs.seam.co/latest/capability-guides/access-systems/managing-credentials) type. Supported values: `pti_card`, `brivo_credential`, `hid_credential`, `visionline_card`.',
|
|
15419
|
+
enum: [
|
|
15420
|
+
'pti_card',
|
|
15421
|
+
'brivo_credential',
|
|
15422
|
+
'hid_credential',
|
|
15423
|
+
'visionline_card',
|
|
15424
|
+
'salto_ks_credential',
|
|
15425
|
+
'assa_abloy_vostio_key',
|
|
15426
|
+
'salto_space_key',
|
|
15427
|
+
'latch_access',
|
|
15428
|
+
],
|
|
15429
|
+
type: 'string',
|
|
15430
|
+
},
|
|
15431
|
+
external_type_display_name: {
|
|
15432
|
+
description:
|
|
15433
|
+
'Display name that corresponds to the brand-specific terminology for the [credential](https://docs.seam.co/latest/capability-guides/access-systems/managing-credentials) type.',
|
|
15434
|
+
type: 'string',
|
|
15435
|
+
},
|
|
15436
|
+
is_issued: {
|
|
15437
|
+
description:
|
|
15438
|
+
'Indicates whether the [credential](https://docs.seam.co/latest/capability-guides/access-systems/managing-credentials) has been encoded onto a card.',
|
|
15439
|
+
type: 'boolean',
|
|
15440
|
+
},
|
|
15441
|
+
is_latest_desired_state_synced_with_provider: {
|
|
15442
|
+
description:
|
|
15443
|
+
'Indicates whether the latest state of the [credential](https://docs.seam.co/latest/capability-guides/access-systems/managing-credentials) has been synced from Seam to the provider.',
|
|
15444
|
+
nullable: true,
|
|
15445
|
+
type: 'boolean',
|
|
15446
|
+
},
|
|
15447
|
+
is_managed: { enum: [true], type: 'boolean' },
|
|
15448
|
+
is_multi_phone_sync_credential: {
|
|
15449
|
+
description:
|
|
15450
|
+
'Indicates whether the [credential](https://docs.seam.co/latest/capability-guides/access-systems/managing-credentials) is a [multi-phone sync credential](https://docs.seam.co/latest/capability-guides/mobile-access-in-development/issuing-mobile-credentials-from-an-access-control-system#what-are-multi-phone-sync-credentials).',
|
|
15451
|
+
type: 'boolean',
|
|
15452
|
+
},
|
|
15453
|
+
is_one_time_use: {
|
|
15454
|
+
description:
|
|
15455
|
+
'Indicates whether the [credential](https://docs.seam.co/latest/capability-guides/access-systems/managing-credentials) can only be used once. If `true`, the code becomes invalid after the first use.',
|
|
15456
|
+
type: 'boolean',
|
|
15457
|
+
},
|
|
15458
|
+
issued_at: {
|
|
15459
|
+
description:
|
|
15460
|
+
'Date and time at which the [credential](https://docs.seam.co/latest/capability-guides/access-systems/managing-credentials) was encoded onto a card.',
|
|
15461
|
+
format: 'date-time',
|
|
15462
|
+
nullable: true,
|
|
15463
|
+
type: 'string',
|
|
15464
|
+
},
|
|
15465
|
+
latest_desired_state_synced_with_provider_at: {
|
|
15466
|
+
description:
|
|
15467
|
+
'Date and time at which the state of the [credential](https://docs.seam.co/latest/capability-guides/access-systems/managing-credentials) was most recently synced from Seam to the provider.',
|
|
15468
|
+
format: 'date-time',
|
|
15469
|
+
nullable: true,
|
|
15470
|
+
type: 'string',
|
|
15471
|
+
},
|
|
15472
|
+
parent_acs_credential_id: {
|
|
15473
|
+
description:
|
|
15474
|
+
'ID of the parent [credential](https://docs.seam.co/latest/capability-guides/access-systems/managing-credentials).',
|
|
15475
|
+
format: 'uuid',
|
|
15476
|
+
type: 'string',
|
|
15477
|
+
},
|
|
15478
|
+
starts_at: {
|
|
15479
|
+
description:
|
|
15480
|
+
'Date and time at which the [credential](https://docs.seam.co/latest/capability-guides/access-systems/managing-credentials) validity starts, in [ISO 8601](https://www.iso.org/iso-8601-date-and-time-format.html) format.',
|
|
15481
|
+
type: 'string',
|
|
15482
|
+
},
|
|
15483
|
+
visionline_metadata: {
|
|
15484
|
+
description:
|
|
15485
|
+
'Visionline-specific metadata for the [credential](https://docs.seam.co/latest/capability-guides/access-systems/managing-credentials).',
|
|
15486
|
+
properties: {
|
|
15487
|
+
auto_join: { type: 'boolean' },
|
|
15488
|
+
card_function_type: {
|
|
15489
|
+
enum: ['guest', 'staff'],
|
|
15490
|
+
type: 'string',
|
|
15491
|
+
},
|
|
15492
|
+
card_id: { type: 'string' },
|
|
15493
|
+
common_acs_entrance_ids: {
|
|
15494
|
+
items: { format: 'uuid', type: 'string' },
|
|
15495
|
+
type: 'array',
|
|
15496
|
+
},
|
|
15497
|
+
credential_id: { type: 'string' },
|
|
15498
|
+
guest_acs_entrance_ids: {
|
|
15499
|
+
items: { format: 'uuid', type: 'string' },
|
|
15500
|
+
type: 'array',
|
|
15501
|
+
},
|
|
15502
|
+
is_valid: { type: 'boolean' },
|
|
15503
|
+
joiner_acs_credential_ids: {
|
|
15504
|
+
items: { format: 'uuid', type: 'string' },
|
|
15505
|
+
type: 'array',
|
|
15506
|
+
},
|
|
15507
|
+
},
|
|
15508
|
+
required: ['card_function_type'],
|
|
15509
|
+
type: 'object',
|
|
15510
|
+
},
|
|
15511
|
+
warnings: {
|
|
15512
|
+
description:
|
|
15513
|
+
'Warnings associated with the [credential](https://docs.seam.co/latest/capability-guides/access-systems/managing-credentials).',
|
|
15514
|
+
items: {
|
|
15515
|
+
description:
|
|
15516
|
+
'Warning associated with the [credential](https://docs.seam.co/latest/capability-guides/access-systems/managing-credentials).',
|
|
15517
|
+
discriminator: { propertyName: 'warning_code' },
|
|
15518
|
+
oneOf: [
|
|
15519
|
+
{
|
|
15520
|
+
description:
|
|
15521
|
+
'Indicates that the [credential](https://docs.seam.co/latest/capability-guides/access-systems/managing-credentials) is waiting to be issued.',
|
|
15522
|
+
properties: {
|
|
15523
|
+
created_at: {
|
|
15524
|
+
description:
|
|
15525
|
+
'Date and time at which Seam created the warning.',
|
|
15526
|
+
format: 'date-time',
|
|
15527
|
+
type: 'string',
|
|
15528
|
+
},
|
|
15529
|
+
message: {
|
|
15530
|
+
description:
|
|
15531
|
+
'Detailed description of the warning. Provides insights into the issue and potentially how to rectify it.',
|
|
15532
|
+
type: 'string',
|
|
15533
|
+
},
|
|
15534
|
+
warning_code: {
|
|
15535
|
+
description:
|
|
15536
|
+
'Unique identifier of the type of warning. Enables quick recognition and categorization of the issue.',
|
|
15537
|
+
enum: ['waiting_to_be_issued'],
|
|
15538
|
+
type: 'string',
|
|
15539
|
+
},
|
|
15540
|
+
},
|
|
15541
|
+
required: [
|
|
15542
|
+
'created_at',
|
|
15543
|
+
'message',
|
|
15544
|
+
'warning_code',
|
|
15545
|
+
],
|
|
15546
|
+
type: 'object',
|
|
15547
|
+
},
|
|
15548
|
+
{
|
|
15549
|
+
description:
|
|
15550
|
+
"Indicates that the schedule of one of the [credential](https://docs.seam.co/latest/capability-guides/access-systems/managing-credentials)'s children was modified externally.",
|
|
15551
|
+
properties: {
|
|
15552
|
+
created_at: {
|
|
15553
|
+
description:
|
|
15554
|
+
'Date and time at which Seam created the warning.',
|
|
15555
|
+
format: 'date-time',
|
|
15556
|
+
type: 'string',
|
|
15557
|
+
},
|
|
15558
|
+
message: {
|
|
15559
|
+
description:
|
|
15560
|
+
'Detailed description of the warning. Provides insights into the issue and potentially how to rectify it.',
|
|
15561
|
+
type: 'string',
|
|
15562
|
+
},
|
|
15563
|
+
warning_code: {
|
|
15564
|
+
description:
|
|
15565
|
+
'Unique identifier of the type of warning. Enables quick recognition and categorization of the issue.',
|
|
15566
|
+
enum: ['schedule_externally_modified'],
|
|
15567
|
+
type: 'string',
|
|
15568
|
+
},
|
|
15569
|
+
},
|
|
15570
|
+
required: [
|
|
15571
|
+
'created_at',
|
|
15572
|
+
'message',
|
|
15573
|
+
'warning_code',
|
|
15574
|
+
],
|
|
15575
|
+
type: 'object',
|
|
15576
|
+
},
|
|
15577
|
+
{
|
|
15578
|
+
description:
|
|
15579
|
+
'Indicates that the schedule of the [credential](https://docs.seam.co/latest/capability-guides/access-systems/managing-credentials) was modified to avoid creating a credential with a start date in the past.',
|
|
15580
|
+
properties: {
|
|
15581
|
+
created_at: {
|
|
15582
|
+
description:
|
|
15583
|
+
'Date and time at which Seam created the warning.',
|
|
15584
|
+
format: 'date-time',
|
|
15585
|
+
type: 'string',
|
|
15586
|
+
},
|
|
15587
|
+
message: {
|
|
15588
|
+
description:
|
|
15589
|
+
'Detailed description of the warning. Provides insights into the issue and potentially how to rectify it.',
|
|
15590
|
+
type: 'string',
|
|
15591
|
+
},
|
|
15592
|
+
warning_code: {
|
|
15593
|
+
description:
|
|
15594
|
+
'Unique identifier of the type of warning. Enables quick recognition and categorization of the issue.',
|
|
15595
|
+
enum: ['schedule_modified'],
|
|
15596
|
+
type: 'string',
|
|
15597
|
+
},
|
|
15598
|
+
},
|
|
15599
|
+
required: [
|
|
15600
|
+
'created_at',
|
|
15601
|
+
'message',
|
|
15602
|
+
'warning_code',
|
|
15603
|
+
],
|
|
15604
|
+
type: 'object',
|
|
15605
|
+
},
|
|
15606
|
+
{
|
|
15607
|
+
description:
|
|
15608
|
+
'Indicates that the [credential](https://docs.seam.co/latest/capability-guides/access-systems/managing-credentials) is being deleted.',
|
|
15609
|
+
properties: {
|
|
15610
|
+
created_at: {
|
|
15611
|
+
description:
|
|
15612
|
+
'Date and time at which Seam created the warning.',
|
|
15613
|
+
format: 'date-time',
|
|
15614
|
+
type: 'string',
|
|
15615
|
+
},
|
|
15616
|
+
message: {
|
|
15617
|
+
description:
|
|
15618
|
+
'Detailed description of the warning. Provides insights into the issue and potentially how to rectify it.',
|
|
15619
|
+
type: 'string',
|
|
15620
|
+
},
|
|
15621
|
+
warning_code: {
|
|
15622
|
+
description:
|
|
15623
|
+
'Unique identifier of the type of warning. Enables quick recognition and categorization of the issue.',
|
|
15624
|
+
enum: ['being_deleted'],
|
|
15625
|
+
type: 'string',
|
|
15626
|
+
},
|
|
15627
|
+
},
|
|
15628
|
+
required: [
|
|
15629
|
+
'created_at',
|
|
15630
|
+
'message',
|
|
15631
|
+
'warning_code',
|
|
15632
|
+
],
|
|
15633
|
+
type: 'object',
|
|
15634
|
+
},
|
|
15635
|
+
{
|
|
15636
|
+
description:
|
|
15637
|
+
'An unknown issue occurred while syncing the state of the [credential](https://docs.seam.co/latest/capability-guides/access-systems/managing-credentials) with the provider. This issue may affect the proper functioning of the credential.',
|
|
15638
|
+
properties: {
|
|
15639
|
+
created_at: {
|
|
15640
|
+
description:
|
|
15641
|
+
'Date and time at which Seam created the warning.',
|
|
15642
|
+
format: 'date-time',
|
|
15643
|
+
type: 'string',
|
|
15644
|
+
},
|
|
15645
|
+
message: {
|
|
15646
|
+
description:
|
|
15647
|
+
'Detailed description of the warning. Provides insights into the issue and potentially how to rectify it.',
|
|
15648
|
+
type: 'string',
|
|
15649
|
+
},
|
|
15650
|
+
warning_code: {
|
|
15651
|
+
description:
|
|
15652
|
+
'Unique identifier of the type of warning. Enables quick recognition and categorization of the issue.',
|
|
15653
|
+
enum: ['unknown_issue_with_acs_credential'],
|
|
15654
|
+
type: 'string',
|
|
15655
|
+
},
|
|
15656
|
+
},
|
|
15657
|
+
required: [
|
|
15658
|
+
'created_at',
|
|
15659
|
+
'message',
|
|
15660
|
+
'warning_code',
|
|
15661
|
+
],
|
|
15662
|
+
type: 'object',
|
|
15663
|
+
},
|
|
15664
|
+
{
|
|
15665
|
+
description:
|
|
15666
|
+
'Access permissions for the [credential](https://docs.seam.co/latest/capability-guides/access-systems/managing-credentials) have changed. [Reissue](https://docs.seam.co/latest/capability-guides/access-systems/working-with-card-encoders-and-scanners/creating-and-encoding-card-based-credentials) (re-encode) the credential. This issue may affect the proper functioning of the credential.',
|
|
15667
|
+
properties: {
|
|
15668
|
+
created_at: {
|
|
15669
|
+
description:
|
|
15670
|
+
'Date and time at which Seam created the warning.',
|
|
15671
|
+
format: 'date-time',
|
|
15672
|
+
type: 'string',
|
|
15673
|
+
},
|
|
15674
|
+
message: {
|
|
15675
|
+
description:
|
|
15676
|
+
'Detailed description of the warning. Provides insights into the issue and potentially how to rectify it.',
|
|
15677
|
+
type: 'string',
|
|
15678
|
+
},
|
|
15679
|
+
warning_code: {
|
|
15680
|
+
description:
|
|
15681
|
+
'Unique identifier of the type of warning. Enables quick recognition and categorization of the issue.',
|
|
15682
|
+
enum: ['needs_to_be_reissued'],
|
|
15683
|
+
type: 'string',
|
|
15684
|
+
},
|
|
15685
|
+
},
|
|
15686
|
+
required: [
|
|
15687
|
+
'created_at',
|
|
15688
|
+
'message',
|
|
15689
|
+
'warning_code',
|
|
15690
|
+
],
|
|
15691
|
+
type: 'object',
|
|
15692
|
+
},
|
|
15693
|
+
],
|
|
15694
|
+
},
|
|
15695
|
+
type: 'array',
|
|
15696
|
+
},
|
|
15697
|
+
workspace_id: {
|
|
15698
|
+
description:
|
|
15699
|
+
'ID of the [workspace](https://docs.seam.co/latest/core-concepts/workspaces) that contains the [credential](https://docs.seam.co/latest/capability-guides/access-systems/managing-credentials).',
|
|
15700
|
+
format: 'uuid',
|
|
15701
|
+
type: 'string',
|
|
15702
|
+
},
|
|
15703
|
+
},
|
|
15704
|
+
required: [
|
|
15705
|
+
'acs_credential_id',
|
|
15706
|
+
'acs_system_id',
|
|
15707
|
+
'display_name',
|
|
15708
|
+
'access_method',
|
|
15709
|
+
'created_at',
|
|
15710
|
+
'workspace_id',
|
|
15711
|
+
'errors',
|
|
15712
|
+
'warnings',
|
|
15713
|
+
'is_managed',
|
|
15714
|
+
'acs_entrances',
|
|
15715
|
+
],
|
|
15716
|
+
type: 'object',
|
|
15717
|
+
'x-route-path': '/acs/credentials',
|
|
15718
|
+
},
|
|
15719
|
+
type: 'array',
|
|
15720
|
+
},
|
|
15721
|
+
phone_registration: {
|
|
15722
|
+
properties: {
|
|
15723
|
+
is_being_activated: { type: 'boolean' },
|
|
15724
|
+
phone_registration_id: { type: 'string' },
|
|
15725
|
+
provider_name: { nullable: true, type: 'string' },
|
|
15726
|
+
provider_state: {},
|
|
15727
|
+
},
|
|
15728
|
+
required: [
|
|
15729
|
+
'phone_registration_id',
|
|
15730
|
+
'provider_name',
|
|
15731
|
+
'is_being_activated',
|
|
15732
|
+
],
|
|
15733
|
+
type: 'object',
|
|
15734
|
+
'x-route-path': '/seam/mobile_sdk/v1/phone_sessions',
|
|
15735
|
+
'x-undocumented': 'Seam Mobile SDK only.',
|
|
15736
|
+
},
|
|
15737
|
+
},
|
|
15738
|
+
required: ['phone_registration', 'acs_credentials'],
|
|
15739
|
+
type: 'object',
|
|
15740
|
+
},
|
|
15741
|
+
type: 'array',
|
|
15742
|
+
},
|
|
15743
|
+
},
|
|
15744
|
+
required: ['provider_sessions'],
|
|
15745
|
+
type: 'object',
|
|
15746
|
+
'x-route-path': '/seam/mobile_sdk/v1/phone_sessions',
|
|
15747
|
+
'x-undocumented': 'Seam Mobile SDK only.',
|
|
15748
|
+
},
|
|
15119
15749
|
thermostat_schedule: {
|
|
15120
15750
|
description:
|
|
15121
15751
|
'Represents a [thermostat schedule](https://docs.seam.co/latest/capability-guides/thermostats/creating-and-managing-thermostat-schedules) that activates a configured [climate preset](https://docs.seam.co/latest/capability-guides/thermostats/creating-and-managing-climate-presets) on a [thermostat](https://docs.seam.co/latest/capability-guides/thermostats) at a specified starting time and deactivates the climate preset at a specified ending time.',
|
|
@@ -22260,12 +22890,18 @@ export default {
|
|
|
22260
22890
|
},
|
|
22261
22891
|
acs_user_id: {
|
|
22262
22892
|
description:
|
|
22263
|
-
'ID of the access system user from which you want to unassign a credential.',
|
|
22893
|
+
'ID of the access system user from which you want to unassign a credential. You can only provide one of acs_user_id or user_identity_id.',
|
|
22894
|
+
format: 'uuid',
|
|
22895
|
+
type: 'string',
|
|
22896
|
+
},
|
|
22897
|
+
user_identity_id: {
|
|
22898
|
+
description:
|
|
22899
|
+
'ID of the user identity from which you want to unassign a credential. You can only provide one of acs_user_id or user_identity_id.',
|
|
22264
22900
|
format: 'uuid',
|
|
22265
22901
|
type: 'string',
|
|
22266
22902
|
},
|
|
22267
22903
|
},
|
|
22268
|
-
required: ['
|
|
22904
|
+
required: ['acs_credential_id'],
|
|
22269
22905
|
type: 'object',
|
|
22270
22906
|
},
|
|
22271
22907
|
},
|
|
@@ -22320,12 +22956,18 @@ export default {
|
|
|
22320
22956
|
},
|
|
22321
22957
|
acs_user_id: {
|
|
22322
22958
|
description:
|
|
22323
|
-
'ID of the access system user from which you want to unassign a credential.',
|
|
22959
|
+
'ID of the access system user from which you want to unassign a credential. You can only provide one of acs_user_id or user_identity_id.',
|
|
22960
|
+
format: 'uuid',
|
|
22961
|
+
type: 'string',
|
|
22962
|
+
},
|
|
22963
|
+
user_identity_id: {
|
|
22964
|
+
description:
|
|
22965
|
+
'ID of the user identity from which you want to unassign a credential. You can only provide one of acs_user_id or user_identity_id.',
|
|
22324
22966
|
format: 'uuid',
|
|
22325
22967
|
type: 'string',
|
|
22326
22968
|
},
|
|
22327
22969
|
},
|
|
22328
|
-
required: ['
|
|
22970
|
+
required: ['acs_credential_id'],
|
|
22329
22971
|
type: 'object',
|
|
22330
22972
|
},
|
|
22331
22973
|
},
|
|
@@ -30758,6 +31400,64 @@ export default {
|
|
|
30758
31400
|
'x-undocumented': 'Mobile SDK only.',
|
|
30759
31401
|
},
|
|
30760
31402
|
},
|
|
31403
|
+
'/seam/mobile_sdk/v1/phone_sessions/get_or_create': {
|
|
31404
|
+
post: {
|
|
31405
|
+
description: 'Get or create a session for a mobile SDK phone.',
|
|
31406
|
+
operationId: 'seamMobileSdkV1PhoneSessionsGetOrCreatePost',
|
|
31407
|
+
requestBody: {
|
|
31408
|
+
content: {
|
|
31409
|
+
'application/json': {
|
|
31410
|
+
schema: {
|
|
31411
|
+
properties: {
|
|
31412
|
+
custom_sdk_installation_id: { type: 'string' },
|
|
31413
|
+
phone_device_metadata: {
|
|
31414
|
+
properties: {
|
|
31415
|
+
manufacturer: { type: 'string' },
|
|
31416
|
+
model: { type: 'string' },
|
|
31417
|
+
os_version: { type: 'string' },
|
|
31418
|
+
},
|
|
31419
|
+
type: 'object',
|
|
31420
|
+
},
|
|
31421
|
+
phone_os: { enum: ['ios', 'android'], type: 'string' },
|
|
31422
|
+
},
|
|
31423
|
+
required: ['custom_sdk_installation_id', 'phone_os'],
|
|
31424
|
+
type: 'object',
|
|
31425
|
+
},
|
|
31426
|
+
},
|
|
31427
|
+
},
|
|
31428
|
+
},
|
|
31429
|
+
responses: {
|
|
31430
|
+
200: {
|
|
31431
|
+
content: {
|
|
31432
|
+
'application/json': {
|
|
31433
|
+
schema: {
|
|
31434
|
+
properties: {
|
|
31435
|
+
ok: { type: 'boolean' },
|
|
31436
|
+
phone_session: {
|
|
31437
|
+
$ref: '#/components/schemas/phone_session',
|
|
31438
|
+
},
|
|
31439
|
+
},
|
|
31440
|
+
required: ['phone_session', 'ok'],
|
|
31441
|
+
type: 'object',
|
|
31442
|
+
},
|
|
31443
|
+
},
|
|
31444
|
+
},
|
|
31445
|
+
description: 'OK',
|
|
31446
|
+
},
|
|
31447
|
+
400: { description: 'Bad Request' },
|
|
31448
|
+
401: { description: 'Unauthorized' },
|
|
31449
|
+
},
|
|
31450
|
+
security: [{ client_session: [] }],
|
|
31451
|
+
summary: '/seam/mobile_sdk/v1/phone_sessions/get_or_create',
|
|
31452
|
+
tags: [],
|
|
31453
|
+
'x-fern-sdk-group-name': ['seam', 'mobile_sdk', 'v1', 'phone_sessions'],
|
|
31454
|
+
'x-fern-sdk-method-name': 'get_or_create',
|
|
31455
|
+
'x-fern-sdk-return-value': 'phone_session',
|
|
31456
|
+
'x-response-key': 'phone_session',
|
|
31457
|
+
'x-title': 'Get or Create a Phone Session',
|
|
31458
|
+
'x-undocumented': 'Mobile SDK only.',
|
|
31459
|
+
},
|
|
31460
|
+
},
|
|
30761
31461
|
'/thermostats/activate_climate_preset': {
|
|
30762
31462
|
post: {
|
|
30763
31463
|
description:
|