@seamapi/types 1.460.0 → 1.461.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 +441 -120
- package/dist/connect.cjs.map +1 -1
- package/dist/connect.d.cts +1135 -352
- package/dist/index.cjs +441 -120
- package/dist/index.cjs.map +1 -1
- package/lib/seam/connect/models/batch.d.ts +2338 -276
- package/lib/seam/connect/models/batch.js +7 -0
- package/lib/seam/connect/models/batch.js.map +1 -1
- package/lib/seam/connect/models/customer/access-grant-resources.d.ts +18 -18
- package/lib/seam/connect/models/customer/access-grant-resources.js +2 -1
- package/lib/seam/connect/models/customer/access-grant-resources.js.map +1 -1
- package/lib/seam/connect/models/customer/customer-data.d.ts +15 -15
- package/lib/seam/connect/models/phones/phone-session.d.ts +167 -0
- package/lib/seam/connect/models/phones/phone-session.js +3 -0
- package/lib/seam/connect/models/phones/phone-session.js.map +1 -1
- package/lib/seam/connect/openapi.d.ts +341 -33
- package/lib/seam/connect/openapi.js +429 -113
- package/lib/seam/connect/openapi.js.map +1 -1
- package/lib/seam/connect/route-types.d.ts +650 -175
- package/package.json +1 -1
- package/src/lib/seam/connect/internal/schemas.ts +1 -0
- package/src/lib/seam/connect/models/batch.ts +7 -0
- package/src/lib/seam/connect/models/customer/access-grant-resources.ts +2 -1
- package/src/lib/seam/connect/models/phones/phone-session.ts +5 -0
- package/src/lib/seam/connect/openapi.ts +456 -113
- package/src/lib/seam/connect/route-types.ts +820 -189
|
@@ -20214,8 +20214,188 @@ export default {
|
|
|
20214
20214
|
},
|
|
20215
20215
|
type: 'array',
|
|
20216
20216
|
},
|
|
20217
|
+
user_identity: {
|
|
20218
|
+
description: 'User identity.',
|
|
20219
|
+
properties: {
|
|
20220
|
+
acs_user_ids: {
|
|
20221
|
+
description:
|
|
20222
|
+
'Array of access system user IDs associated with the user identity.',
|
|
20223
|
+
items: { format: 'uuid', type: 'string' },
|
|
20224
|
+
type: 'array',
|
|
20225
|
+
},
|
|
20226
|
+
created_at: {
|
|
20227
|
+
description:
|
|
20228
|
+
'Date and time at which the user identity was created.',
|
|
20229
|
+
format: 'date-time',
|
|
20230
|
+
type: 'string',
|
|
20231
|
+
},
|
|
20232
|
+
display_name: { minLength: 1, type: 'string' },
|
|
20233
|
+
email_address: {
|
|
20234
|
+
description: 'Unique email address for the user identity.',
|
|
20235
|
+
format: 'email',
|
|
20236
|
+
nullable: true,
|
|
20237
|
+
type: 'string',
|
|
20238
|
+
},
|
|
20239
|
+
errors: {
|
|
20240
|
+
description:
|
|
20241
|
+
'Array of errors associated with the user identity. Each error object within the array contains fields like "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.',
|
|
20242
|
+
items: {
|
|
20243
|
+
description: 'Errors associated with the user identity.',
|
|
20244
|
+
discriminator: { propertyName: 'error_code' },
|
|
20245
|
+
oneOf: [
|
|
20246
|
+
{
|
|
20247
|
+
description:
|
|
20248
|
+
'Indicates that there is an issue with an access system user associated with this user identity.',
|
|
20249
|
+
properties: {
|
|
20250
|
+
acs_system_id: {
|
|
20251
|
+
description:
|
|
20252
|
+
'ID of the access system that the user identity is associated with.',
|
|
20253
|
+
format: 'uuid',
|
|
20254
|
+
type: 'string',
|
|
20255
|
+
},
|
|
20256
|
+
acs_user_id: {
|
|
20257
|
+
description:
|
|
20258
|
+
'ID of the access system user that has an issue.',
|
|
20259
|
+
format: 'uuid',
|
|
20260
|
+
type: 'string',
|
|
20261
|
+
},
|
|
20262
|
+
created_at: {
|
|
20263
|
+
description:
|
|
20264
|
+
'Date and time at which Seam created the error.',
|
|
20265
|
+
format: 'date-time',
|
|
20266
|
+
type: 'string',
|
|
20267
|
+
},
|
|
20268
|
+
error_code: {
|
|
20269
|
+
description:
|
|
20270
|
+
'Unique identifier of the type of error. Enables quick recognition and categorization of the issue.',
|
|
20271
|
+
enum: ['issue_with_acs_user'],
|
|
20272
|
+
type: 'string',
|
|
20273
|
+
},
|
|
20274
|
+
message: {
|
|
20275
|
+
description:
|
|
20276
|
+
'Detailed description of the error. Provides insights into the issue and potentially how to rectify it.',
|
|
20277
|
+
type: 'string',
|
|
20278
|
+
},
|
|
20279
|
+
},
|
|
20280
|
+
required: [
|
|
20281
|
+
'created_at',
|
|
20282
|
+
'message',
|
|
20283
|
+
'error_code',
|
|
20284
|
+
'acs_user_id',
|
|
20285
|
+
'acs_system_id',
|
|
20286
|
+
],
|
|
20287
|
+
type: 'object',
|
|
20288
|
+
},
|
|
20289
|
+
],
|
|
20290
|
+
},
|
|
20291
|
+
type: 'array',
|
|
20292
|
+
},
|
|
20293
|
+
full_name: { minLength: 1, nullable: true, type: 'string' },
|
|
20294
|
+
phone_number: {
|
|
20295
|
+
description:
|
|
20296
|
+
'Unique phone number for the user identity in [E.164 format](https://www.itu.int/rec/T-REC-E.164/en) (for example, +15555550100).',
|
|
20297
|
+
nullable: true,
|
|
20298
|
+
type: 'string',
|
|
20299
|
+
},
|
|
20300
|
+
user_identity_id: {
|
|
20301
|
+
description: 'ID of the user identity.',
|
|
20302
|
+
format: 'uuid',
|
|
20303
|
+
type: 'string',
|
|
20304
|
+
},
|
|
20305
|
+
user_identity_key: {
|
|
20306
|
+
description: 'Unique key for the user identity.',
|
|
20307
|
+
minLength: 1,
|
|
20308
|
+
nullable: true,
|
|
20309
|
+
type: 'string',
|
|
20310
|
+
},
|
|
20311
|
+
warnings: {
|
|
20312
|
+
description:
|
|
20313
|
+
'Array of warnings associated with the user identity. 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.',
|
|
20314
|
+
items: {
|
|
20315
|
+
description: 'Warnings associated with the user identity.',
|
|
20316
|
+
discriminator: { propertyName: 'warning_code' },
|
|
20317
|
+
oneOf: [
|
|
20318
|
+
{
|
|
20319
|
+
description:
|
|
20320
|
+
'Indicates that the user identity is currently being deleted.',
|
|
20321
|
+
properties: {
|
|
20322
|
+
created_at: {
|
|
20323
|
+
description:
|
|
20324
|
+
'Date and time at which Seam created the warning.',
|
|
20325
|
+
format: 'date-time',
|
|
20326
|
+
type: 'string',
|
|
20327
|
+
},
|
|
20328
|
+
message: {
|
|
20329
|
+
description:
|
|
20330
|
+
'Detailed description of the warning. Provides insights into the issue and potentially how to rectify it.',
|
|
20331
|
+
type: 'string',
|
|
20332
|
+
},
|
|
20333
|
+
warning_code: {
|
|
20334
|
+
description:
|
|
20335
|
+
'Unique identifier of the type of warning. Enables quick recognition and categorization of the issue.',
|
|
20336
|
+
enum: ['being_deleted'],
|
|
20337
|
+
type: 'string',
|
|
20338
|
+
},
|
|
20339
|
+
},
|
|
20340
|
+
required: ['created_at', 'message', 'warning_code'],
|
|
20341
|
+
type: 'object',
|
|
20342
|
+
},
|
|
20343
|
+
{
|
|
20344
|
+
description:
|
|
20345
|
+
"Indicates that the ACS user's profile does not match the user identity's profile",
|
|
20346
|
+
properties: {
|
|
20347
|
+
created_at: {
|
|
20348
|
+
description:
|
|
20349
|
+
'Date and time at which Seam created the warning.',
|
|
20350
|
+
format: 'date-time',
|
|
20351
|
+
type: 'string',
|
|
20352
|
+
},
|
|
20353
|
+
message: {
|
|
20354
|
+
description:
|
|
20355
|
+
'Detailed description of the warning. Provides insights into the issue and potentially how to rectify it.',
|
|
20356
|
+
type: 'string',
|
|
20357
|
+
},
|
|
20358
|
+
warning_code: {
|
|
20359
|
+
description:
|
|
20360
|
+
'Unique identifier of the type of warning. Enables quick recognition and categorization of the issue.',
|
|
20361
|
+
enum: [
|
|
20362
|
+
'acs_user_profile_does_not_match_user_identity',
|
|
20363
|
+
],
|
|
20364
|
+
type: 'string',
|
|
20365
|
+
},
|
|
20366
|
+
},
|
|
20367
|
+
required: ['created_at', 'message', 'warning_code'],
|
|
20368
|
+
type: 'object',
|
|
20369
|
+
},
|
|
20370
|
+
],
|
|
20371
|
+
},
|
|
20372
|
+
type: 'array',
|
|
20373
|
+
},
|
|
20374
|
+
workspace_id: {
|
|
20375
|
+
description:
|
|
20376
|
+
'ID of the [workspace](https://docs.seam.co/latest/core-concepts/workspaces) that contains the user identity.',
|
|
20377
|
+
format: 'uuid',
|
|
20378
|
+
type: 'string',
|
|
20379
|
+
},
|
|
20380
|
+
},
|
|
20381
|
+
required: [
|
|
20382
|
+
'user_identity_id',
|
|
20383
|
+
'user_identity_key',
|
|
20384
|
+
'email_address',
|
|
20385
|
+
'phone_number',
|
|
20386
|
+
'display_name',
|
|
20387
|
+
'full_name',
|
|
20388
|
+
'created_at',
|
|
20389
|
+
'workspace_id',
|
|
20390
|
+
'errors',
|
|
20391
|
+
'warnings',
|
|
20392
|
+
'acs_user_ids',
|
|
20393
|
+
],
|
|
20394
|
+
type: 'object',
|
|
20395
|
+
},
|
|
20396
|
+
workspace_id: { description: 'Workspace ID.', type: 'string' },
|
|
20217
20397
|
},
|
|
20218
|
-
required: ['provider_sessions'],
|
|
20398
|
+
required: ['provider_sessions', 'user_identity', 'workspace_id'],
|
|
20219
20399
|
type: 'object',
|
|
20220
20400
|
'x-route-path': '/seam/mobile_sdk/v1/phone_sessions',
|
|
20221
20401
|
'x-undocumented': 'Seam Mobile SDK only.',
|
|
@@ -27874,6 +28054,12 @@ export default {
|
|
|
27874
28054
|
items: { format: 'uuid', type: 'string' },
|
|
27875
28055
|
type: 'array',
|
|
27876
28056
|
},
|
|
28057
|
+
space_keys: {
|
|
28058
|
+
description:
|
|
28059
|
+
'Set of keys of existing spaces to which access is being granted.',
|
|
28060
|
+
items: { type: 'string' },
|
|
28061
|
+
type: 'array',
|
|
28062
|
+
},
|
|
27877
28063
|
starts_at: {
|
|
27878
28064
|
description:
|
|
27879
28065
|
'Date and time at which the validity of the new grant starts, in [ISO 8601](https://www.iso.org/iso-8601-date-and-time-format.html) format.',
|
|
@@ -28150,7 +28336,14 @@ export default {
|
|
|
28150
28336
|
required: false,
|
|
28151
28337
|
schema: {
|
|
28152
28338
|
items: {
|
|
28153
|
-
enum: [
|
|
28339
|
+
enum: [
|
|
28340
|
+
'spaces',
|
|
28341
|
+
'devices',
|
|
28342
|
+
'acs_entrances',
|
|
28343
|
+
'connected_accounts',
|
|
28344
|
+
'acs_systems',
|
|
28345
|
+
'user_identity',
|
|
28346
|
+
],
|
|
28154
28347
|
type: 'string',
|
|
28155
28348
|
},
|
|
28156
28349
|
type: 'array',
|
|
@@ -28162,7 +28355,14 @@ export default {
|
|
|
28162
28355
|
required: false,
|
|
28163
28356
|
schema: {
|
|
28164
28357
|
items: {
|
|
28165
|
-
enum: [
|
|
28358
|
+
enum: [
|
|
28359
|
+
'spaces',
|
|
28360
|
+
'devices',
|
|
28361
|
+
'acs_entrances',
|
|
28362
|
+
'connected_accounts',
|
|
28363
|
+
'acs_systems',
|
|
28364
|
+
'user_identity',
|
|
28365
|
+
],
|
|
28166
28366
|
type: 'string',
|
|
28167
28367
|
},
|
|
28168
28368
|
type: 'array',
|
|
@@ -28176,20 +28376,21 @@ export default {
|
|
|
28176
28376
|
schema: {
|
|
28177
28377
|
properties: {
|
|
28178
28378
|
batch: {
|
|
28179
|
-
description: 'Represents a resource batch.',
|
|
28180
28379
|
properties: {
|
|
28181
28380
|
acs_entrances: {
|
|
28182
28381
|
items: { $ref: '#/components/schemas/acs_entrance' },
|
|
28183
28382
|
type: 'array',
|
|
28184
28383
|
},
|
|
28185
|
-
|
|
28186
|
-
|
|
28187
|
-
|
|
28188
|
-
|
|
28189
|
-
|
|
28190
|
-
|
|
28191
|
-
|
|
28192
|
-
|
|
28384
|
+
acs_systems: {
|
|
28385
|
+
items: { $ref: '#/components/schemas/acs_system' },
|
|
28386
|
+
type: 'array',
|
|
28387
|
+
},
|
|
28388
|
+
batch_type: { enum: ['access_grants'], type: 'string' },
|
|
28389
|
+
connected_accounts: {
|
|
28390
|
+
items: {
|
|
28391
|
+
$ref: '#/components/schemas/connected_account',
|
|
28392
|
+
},
|
|
28393
|
+
type: 'array',
|
|
28193
28394
|
},
|
|
28194
28395
|
devices: {
|
|
28195
28396
|
items: { $ref: '#/components/schemas/device' },
|
|
@@ -28203,14 +28404,9 @@ export default {
|
|
|
28203
28404
|
items: { $ref: '#/components/schemas/user_identity' },
|
|
28204
28405
|
type: 'array',
|
|
28205
28406
|
},
|
|
28206
|
-
workspaces: {
|
|
28207
|
-
items: { $ref: '#/components/schemas/workspace' },
|
|
28208
|
-
type: 'array',
|
|
28209
|
-
},
|
|
28210
28407
|
},
|
|
28211
28408
|
required: ['batch_type'],
|
|
28212
28409
|
type: 'object',
|
|
28213
|
-
'x-route-path': '/',
|
|
28214
28410
|
},
|
|
28215
28411
|
ok: { type: 'boolean' },
|
|
28216
28412
|
},
|
|
@@ -28256,14 +28452,28 @@ export default {
|
|
|
28256
28452
|
},
|
|
28257
28453
|
exclude: {
|
|
28258
28454
|
items: {
|
|
28259
|
-
enum: [
|
|
28455
|
+
enum: [
|
|
28456
|
+
'spaces',
|
|
28457
|
+
'devices',
|
|
28458
|
+
'acs_entrances',
|
|
28459
|
+
'connected_accounts',
|
|
28460
|
+
'acs_systems',
|
|
28461
|
+
'user_identity',
|
|
28462
|
+
],
|
|
28260
28463
|
type: 'string',
|
|
28261
28464
|
},
|
|
28262
28465
|
type: 'array',
|
|
28263
28466
|
},
|
|
28264
28467
|
include: {
|
|
28265
28468
|
items: {
|
|
28266
|
-
enum: [
|
|
28469
|
+
enum: [
|
|
28470
|
+
'spaces',
|
|
28471
|
+
'devices',
|
|
28472
|
+
'acs_entrances',
|
|
28473
|
+
'connected_accounts',
|
|
28474
|
+
'acs_systems',
|
|
28475
|
+
'user_identity',
|
|
28476
|
+
],
|
|
28267
28477
|
type: 'string',
|
|
28268
28478
|
},
|
|
28269
28479
|
type: 'array',
|
|
@@ -28282,20 +28492,21 @@ export default {
|
|
|
28282
28492
|
schema: {
|
|
28283
28493
|
properties: {
|
|
28284
28494
|
batch: {
|
|
28285
|
-
description: 'Represents a resource batch.',
|
|
28286
28495
|
properties: {
|
|
28287
28496
|
acs_entrances: {
|
|
28288
28497
|
items: { $ref: '#/components/schemas/acs_entrance' },
|
|
28289
28498
|
type: 'array',
|
|
28290
28499
|
},
|
|
28291
|
-
|
|
28292
|
-
|
|
28293
|
-
|
|
28294
|
-
|
|
28295
|
-
|
|
28296
|
-
|
|
28297
|
-
|
|
28298
|
-
|
|
28500
|
+
acs_systems: {
|
|
28501
|
+
items: { $ref: '#/components/schemas/acs_system' },
|
|
28502
|
+
type: 'array',
|
|
28503
|
+
},
|
|
28504
|
+
batch_type: { enum: ['access_grants'], type: 'string' },
|
|
28505
|
+
connected_accounts: {
|
|
28506
|
+
items: {
|
|
28507
|
+
$ref: '#/components/schemas/connected_account',
|
|
28508
|
+
},
|
|
28509
|
+
type: 'array',
|
|
28299
28510
|
},
|
|
28300
28511
|
devices: {
|
|
28301
28512
|
items: { $ref: '#/components/schemas/device' },
|
|
@@ -28309,14 +28520,9 @@ export default {
|
|
|
28309
28520
|
items: { $ref: '#/components/schemas/user_identity' },
|
|
28310
28521
|
type: 'array',
|
|
28311
28522
|
},
|
|
28312
|
-
workspaces: {
|
|
28313
|
-
items: { $ref: '#/components/schemas/workspace' },
|
|
28314
|
-
type: 'array',
|
|
28315
|
-
},
|
|
28316
28523
|
},
|
|
28317
28524
|
required: ['batch_type'],
|
|
28318
28525
|
type: 'object',
|
|
28319
|
-
'x-route-path': '/',
|
|
28320
28526
|
},
|
|
28321
28527
|
ok: { type: 'boolean' },
|
|
28322
28528
|
},
|
|
@@ -37860,7 +38066,7 @@ export default {
|
|
|
37860
38066
|
},
|
|
37861
38067
|
name: {
|
|
37862
38068
|
description:
|
|
37863
|
-
'Your
|
|
38069
|
+
'Your name for this access grant resource.',
|
|
37864
38070
|
type: 'string',
|
|
37865
38071
|
},
|
|
37866
38072
|
property_keys: {
|
|
@@ -37913,7 +38119,7 @@ export default {
|
|
|
37913
38119
|
type: 'string',
|
|
37914
38120
|
},
|
|
37915
38121
|
},
|
|
37916
|
-
required: ['
|
|
38122
|
+
required: ['access_grant_key'],
|
|
37917
38123
|
type: 'object',
|
|
37918
38124
|
},
|
|
37919
38125
|
type: 'array',
|
|
@@ -37963,7 +38169,7 @@ export default {
|
|
|
37963
38169
|
},
|
|
37964
38170
|
name: {
|
|
37965
38171
|
description:
|
|
37966
|
-
'Your
|
|
38172
|
+
'Your name for this access grant resource.',
|
|
37967
38173
|
type: 'string',
|
|
37968
38174
|
},
|
|
37969
38175
|
property_keys: {
|
|
@@ -38016,7 +38222,7 @@ export default {
|
|
|
38016
38222
|
type: 'string',
|
|
38017
38223
|
},
|
|
38018
38224
|
},
|
|
38019
|
-
required: ['
|
|
38225
|
+
required: ['booking_key'],
|
|
38020
38226
|
type: 'object',
|
|
38021
38227
|
},
|
|
38022
38228
|
type: 'array',
|
|
@@ -38217,7 +38423,7 @@ export default {
|
|
|
38217
38423
|
},
|
|
38218
38424
|
name: {
|
|
38219
38425
|
description:
|
|
38220
|
-
'Your
|
|
38426
|
+
'Your name for this access grant resource.',
|
|
38221
38427
|
type: 'string',
|
|
38222
38428
|
},
|
|
38223
38429
|
property_keys: {
|
|
@@ -38275,7 +38481,7 @@ export default {
|
|
|
38275
38481
|
type: 'string',
|
|
38276
38482
|
},
|
|
38277
38483
|
},
|
|
38278
|
-
required: ['
|
|
38484
|
+
required: ['reservation_key'],
|
|
38279
38485
|
type: 'object',
|
|
38280
38486
|
},
|
|
38281
38487
|
type: 'array',
|
|
@@ -38561,7 +38767,7 @@ export default {
|
|
|
38561
38767
|
},
|
|
38562
38768
|
name: {
|
|
38563
38769
|
description:
|
|
38564
|
-
'Your
|
|
38770
|
+
'Your name for this access grant resource.',
|
|
38565
38771
|
type: 'string',
|
|
38566
38772
|
},
|
|
38567
38773
|
property_keys: {
|
|
@@ -38614,7 +38820,7 @@ export default {
|
|
|
38614
38820
|
type: 'string',
|
|
38615
38821
|
},
|
|
38616
38822
|
},
|
|
38617
|
-
required: ['
|
|
38823
|
+
required: ['access_grant_key'],
|
|
38618
38824
|
type: 'object',
|
|
38619
38825
|
},
|
|
38620
38826
|
type: 'array',
|
|
@@ -38664,7 +38870,7 @@ export default {
|
|
|
38664
38870
|
},
|
|
38665
38871
|
name: {
|
|
38666
38872
|
description:
|
|
38667
|
-
'Your
|
|
38873
|
+
'Your name for this access grant resource.',
|
|
38668
38874
|
type: 'string',
|
|
38669
38875
|
},
|
|
38670
38876
|
property_keys: {
|
|
@@ -38717,7 +38923,7 @@ export default {
|
|
|
38717
38923
|
type: 'string',
|
|
38718
38924
|
},
|
|
38719
38925
|
},
|
|
38720
|
-
required: ['
|
|
38926
|
+
required: ['booking_key'],
|
|
38721
38927
|
type: 'object',
|
|
38722
38928
|
},
|
|
38723
38929
|
type: 'array',
|
|
@@ -38915,7 +39121,7 @@ export default {
|
|
|
38915
39121
|
},
|
|
38916
39122
|
name: {
|
|
38917
39123
|
description:
|
|
38918
|
-
'Your
|
|
39124
|
+
'Your name for this access grant resource.',
|
|
38919
39125
|
type: 'string',
|
|
38920
39126
|
},
|
|
38921
39127
|
property_keys: {
|
|
@@ -38973,7 +39179,7 @@ export default {
|
|
|
38973
39179
|
type: 'string',
|
|
38974
39180
|
},
|
|
38975
39181
|
},
|
|
38976
|
-
required: ['
|
|
39182
|
+
required: ['reservation_key'],
|
|
38977
39183
|
type: 'object',
|
|
38978
39184
|
},
|
|
38979
39185
|
type: 'array',
|
|
@@ -40468,7 +40674,7 @@ export default {
|
|
|
40468
40674
|
'/devices/simulate/disconnect_from_hub': {
|
|
40469
40675
|
post: {
|
|
40470
40676
|
description:
|
|
40471
|
-
'Simulates taking the Wi
|
|
40677
|
+
'Simulates taking the Wi‑Fi hub (bridge) offline for a device.\nOnly applicable for sandbox workspaces and currently\nimplemented for August and TTLock locks.\nThis will set the corresponding `hub_disconnected` or\n`ttlock_lock_not_paired_to_gateway` error on the device.',
|
|
40472
40678
|
operationId: 'devicesSimulateDisconnectFromHubPost',
|
|
40473
40679
|
requestBody: {
|
|
40474
40680
|
content: {
|
|
@@ -42606,6 +42812,115 @@ export default {
|
|
|
42606
42812
|
'x-title': 'List Events',
|
|
42607
42813
|
},
|
|
42608
42814
|
},
|
|
42815
|
+
'/instant_keys/list': {
|
|
42816
|
+
get: {
|
|
42817
|
+
description:
|
|
42818
|
+
'Returns a list of all [instant keys](https://docs.seam.co/latest/capability-guides/mobile-access/instant-keys).',
|
|
42819
|
+
operationId: 'instantKeysListGet',
|
|
42820
|
+
parameters: [
|
|
42821
|
+
{
|
|
42822
|
+
in: 'query',
|
|
42823
|
+
name: 'user_identity_id',
|
|
42824
|
+
schema: {
|
|
42825
|
+
description:
|
|
42826
|
+
'ID of the user identity by which you want to filter the list of Instant Keys.',
|
|
42827
|
+
format: 'uuid',
|
|
42828
|
+
type: 'string',
|
|
42829
|
+
},
|
|
42830
|
+
},
|
|
42831
|
+
],
|
|
42832
|
+
responses: {
|
|
42833
|
+
200: {
|
|
42834
|
+
content: {
|
|
42835
|
+
'application/json': {
|
|
42836
|
+
schema: {
|
|
42837
|
+
properties: {
|
|
42838
|
+
instant_keys: {
|
|
42839
|
+
items: { $ref: '#/components/schemas/instant_key' },
|
|
42840
|
+
type: 'array',
|
|
42841
|
+
},
|
|
42842
|
+
ok: { type: 'boolean' },
|
|
42843
|
+
},
|
|
42844
|
+
required: ['instant_keys', 'ok'],
|
|
42845
|
+
type: 'object',
|
|
42846
|
+
},
|
|
42847
|
+
},
|
|
42848
|
+
},
|
|
42849
|
+
description: 'OK',
|
|
42850
|
+
},
|
|
42851
|
+
400: { description: 'Bad Request' },
|
|
42852
|
+
401: { description: 'Unauthorized' },
|
|
42853
|
+
},
|
|
42854
|
+
security: [
|
|
42855
|
+
{ api_key: [] },
|
|
42856
|
+
{ pat_with_workspace: [] },
|
|
42857
|
+
{ console_session_with_workspace: [] },
|
|
42858
|
+
],
|
|
42859
|
+
summary: '/instant_keys/list',
|
|
42860
|
+
tags: [],
|
|
42861
|
+
'x-fern-sdk-group-name': ['instant_keys'],
|
|
42862
|
+
'x-fern-sdk-method-name': 'list',
|
|
42863
|
+
'x-fern-sdk-return-value': 'instant_keys',
|
|
42864
|
+
'x-response-key': 'instant_keys',
|
|
42865
|
+
'x-title': 'List Instant Keys',
|
|
42866
|
+
},
|
|
42867
|
+
post: {
|
|
42868
|
+
description:
|
|
42869
|
+
'Returns a list of all [instant keys](https://docs.seam.co/latest/capability-guides/mobile-access/instant-keys).',
|
|
42870
|
+
operationId: 'instantKeysListPost',
|
|
42871
|
+
requestBody: {
|
|
42872
|
+
content: {
|
|
42873
|
+
'application/json': {
|
|
42874
|
+
schema: {
|
|
42875
|
+
properties: {
|
|
42876
|
+
user_identity_id: {
|
|
42877
|
+
description:
|
|
42878
|
+
'ID of the user identity by which you want to filter the list of Instant Keys.',
|
|
42879
|
+
format: 'uuid',
|
|
42880
|
+
type: 'string',
|
|
42881
|
+
},
|
|
42882
|
+
},
|
|
42883
|
+
type: 'object',
|
|
42884
|
+
},
|
|
42885
|
+
},
|
|
42886
|
+
},
|
|
42887
|
+
},
|
|
42888
|
+
responses: {
|
|
42889
|
+
200: {
|
|
42890
|
+
content: {
|
|
42891
|
+
'application/json': {
|
|
42892
|
+
schema: {
|
|
42893
|
+
properties: {
|
|
42894
|
+
instant_keys: {
|
|
42895
|
+
items: { $ref: '#/components/schemas/instant_key' },
|
|
42896
|
+
type: 'array',
|
|
42897
|
+
},
|
|
42898
|
+
ok: { type: 'boolean' },
|
|
42899
|
+
},
|
|
42900
|
+
required: ['instant_keys', 'ok'],
|
|
42901
|
+
type: 'object',
|
|
42902
|
+
},
|
|
42903
|
+
},
|
|
42904
|
+
},
|
|
42905
|
+
description: 'OK',
|
|
42906
|
+
},
|
|
42907
|
+
400: { description: 'Bad Request' },
|
|
42908
|
+
401: { description: 'Unauthorized' },
|
|
42909
|
+
},
|
|
42910
|
+
security: [
|
|
42911
|
+
{ api_key: [] },
|
|
42912
|
+
{ pat_with_workspace: [] },
|
|
42913
|
+
{ console_session_with_workspace: [] },
|
|
42914
|
+
],
|
|
42915
|
+
summary: '/instant_keys/list',
|
|
42916
|
+
tags: [],
|
|
42917
|
+
'x-fern-sdk-group-name': ['instant_keys'],
|
|
42918
|
+
'x-fern-sdk-method-name': 'list',
|
|
42919
|
+
'x-fern-sdk-return-value': 'instant_keys',
|
|
42920
|
+
'x-response-key': 'instant_keys',
|
|
42921
|
+
'x-title': 'List Instant Keys',
|
|
42922
|
+
},
|
|
42923
|
+
},
|
|
42609
42924
|
'/locks/get': {
|
|
42610
42925
|
get: {
|
|
42611
42926
|
description:
|
|
@@ -45763,10 +46078,11 @@ export default {
|
|
|
45763
46078
|
'x-undocumented': 'Seam Bridge Client only.',
|
|
45764
46079
|
},
|
|
45765
46080
|
},
|
|
45766
|
-
'/seam/console/v1/
|
|
46081
|
+
'/seam/console/v1/get_resource_locator': {
|
|
45767
46082
|
get: {
|
|
45768
|
-
description:
|
|
45769
|
-
|
|
46083
|
+
description:
|
|
46084
|
+
'Returns the type and system information of a resource given its UUID.',
|
|
46085
|
+
operationId: 'seamConsoleV1GetResourceLocatorGet',
|
|
45770
46086
|
parameters: [
|
|
45771
46087
|
{
|
|
45772
46088
|
in: 'query',
|
|
@@ -45782,9 +46098,17 @@ export default {
|
|
|
45782
46098
|
schema: {
|
|
45783
46099
|
properties: {
|
|
45784
46100
|
ok: { type: 'boolean' },
|
|
45785
|
-
|
|
46101
|
+
resource_locator: {
|
|
46102
|
+
properties: {
|
|
46103
|
+
acs_system_id: { format: 'uuid', type: 'string' },
|
|
46104
|
+
device_id: { format: 'uuid', type: 'string' },
|
|
46105
|
+
resource_type: { type: 'string' },
|
|
46106
|
+
},
|
|
46107
|
+
required: ['resource_type'],
|
|
46108
|
+
type: 'object',
|
|
46109
|
+
},
|
|
45786
46110
|
},
|
|
45787
|
-
required: ['
|
|
46111
|
+
required: ['resource_locator', 'ok'],
|
|
45788
46112
|
type: 'object',
|
|
45789
46113
|
},
|
|
45790
46114
|
},
|
|
@@ -45800,18 +46124,19 @@ export default {
|
|
|
45800
46124
|
{ console_session_with_workspace: [] },
|
|
45801
46125
|
{ api_key: [] },
|
|
45802
46126
|
],
|
|
45803
|
-
summary: '/seam/console/v1/
|
|
46127
|
+
summary: '/seam/console/v1/get_resource_locator',
|
|
45804
46128
|
tags: [],
|
|
45805
46129
|
'x-fern-sdk-group-name': ['seam', 'console', 'v1'],
|
|
45806
|
-
'x-fern-sdk-method-name': '
|
|
45807
|
-
'x-fern-sdk-return-value': '
|
|
45808
|
-
'x-response-key': '
|
|
45809
|
-
'x-title': 'Get Resource
|
|
46130
|
+
'x-fern-sdk-method-name': 'get_resource_locator',
|
|
46131
|
+
'x-fern-sdk-return-value': 'resource_locator',
|
|
46132
|
+
'x-response-key': 'resource_locator',
|
|
46133
|
+
'x-title': 'Get Resource Locator',
|
|
45810
46134
|
'x-undocumented': 'Internal endpoint for Console',
|
|
45811
46135
|
},
|
|
45812
46136
|
post: {
|
|
45813
|
-
description:
|
|
45814
|
-
|
|
46137
|
+
description:
|
|
46138
|
+
'Returns the type and system information of a resource given its UUID.',
|
|
46139
|
+
operationId: 'seamConsoleV1GetResourceLocatorPost',
|
|
45815
46140
|
parameters: [
|
|
45816
46141
|
{
|
|
45817
46142
|
in: 'query',
|
|
@@ -45827,9 +46152,17 @@ export default {
|
|
|
45827
46152
|
schema: {
|
|
45828
46153
|
properties: {
|
|
45829
46154
|
ok: { type: 'boolean' },
|
|
45830
|
-
|
|
46155
|
+
resource_locator: {
|
|
46156
|
+
properties: {
|
|
46157
|
+
acs_system_id: { format: 'uuid', type: 'string' },
|
|
46158
|
+
device_id: { format: 'uuid', type: 'string' },
|
|
46159
|
+
resource_type: { type: 'string' },
|
|
46160
|
+
},
|
|
46161
|
+
required: ['resource_type'],
|
|
46162
|
+
type: 'object',
|
|
46163
|
+
},
|
|
45831
46164
|
},
|
|
45832
|
-
required: ['
|
|
46165
|
+
required: ['resource_locator', 'ok'],
|
|
45833
46166
|
type: 'object',
|
|
45834
46167
|
},
|
|
45835
46168
|
},
|
|
@@ -45845,13 +46178,13 @@ export default {
|
|
|
45845
46178
|
{ console_session_with_workspace: [] },
|
|
45846
46179
|
{ api_key: [] },
|
|
45847
46180
|
],
|
|
45848
|
-
summary: '/seam/console/v1/
|
|
46181
|
+
summary: '/seam/console/v1/get_resource_locator',
|
|
45849
46182
|
tags: [],
|
|
45850
46183
|
'x-fern-sdk-group-name': ['seam', 'console', 'v1'],
|
|
45851
|
-
'x-fern-sdk-method-name': '
|
|
45852
|
-
'x-fern-sdk-return-value': '
|
|
45853
|
-
'x-response-key': '
|
|
45854
|
-
'x-title': 'Get Resource
|
|
46184
|
+
'x-fern-sdk-method-name': 'get_resource_locator',
|
|
46185
|
+
'x-fern-sdk-return-value': 'resource_locator',
|
|
46186
|
+
'x-response-key': 'resource_locator',
|
|
46187
|
+
'x-title': 'Get Resource Locator',
|
|
45855
46188
|
'x-undocumented': 'Internal endpoint for Console',
|
|
45856
46189
|
},
|
|
45857
46190
|
},
|
|
@@ -46321,7 +46654,7 @@ export default {
|
|
|
46321
46654
|
type: 'string',
|
|
46322
46655
|
},
|
|
46323
46656
|
},
|
|
46324
|
-
required: ['rule'
|
|
46657
|
+
required: ['rule'],
|
|
46325
46658
|
type: 'object',
|
|
46326
46659
|
},
|
|
46327
46660
|
reservation_time_updated: {
|
|
@@ -46334,7 +46667,7 @@ export default {
|
|
|
46334
46667
|
type: 'string',
|
|
46335
46668
|
},
|
|
46336
46669
|
},
|
|
46337
|
-
required: ['rule'
|
|
46670
|
+
required: ['rule'],
|
|
46338
46671
|
type: 'object',
|
|
46339
46672
|
},
|
|
46340
46673
|
},
|
|
@@ -46422,7 +46755,7 @@ export default {
|
|
|
46422
46755
|
type: 'string',
|
|
46423
46756
|
},
|
|
46424
46757
|
},
|
|
46425
|
-
required: ['rule'
|
|
46758
|
+
required: ['rule'],
|
|
46426
46759
|
type: 'object',
|
|
46427
46760
|
},
|
|
46428
46761
|
reservation_time_updated: {
|
|
@@ -46435,7 +46768,7 @@ export default {
|
|
|
46435
46768
|
type: 'string',
|
|
46436
46769
|
},
|
|
46437
46770
|
},
|
|
46438
|
-
required: ['rule'
|
|
46771
|
+
required: ['rule'],
|
|
46439
46772
|
type: 'object',
|
|
46440
46773
|
},
|
|
46441
46774
|
},
|
|
@@ -46523,7 +46856,7 @@ export default {
|
|
|
46523
46856
|
type: 'string',
|
|
46524
46857
|
},
|
|
46525
46858
|
},
|
|
46526
|
-
required: ['rule'
|
|
46859
|
+
required: ['rule'],
|
|
46527
46860
|
type: 'object',
|
|
46528
46861
|
},
|
|
46529
46862
|
reservation_time_updated: {
|
|
@@ -46534,7 +46867,7 @@ export default {
|
|
|
46534
46867
|
type: 'string',
|
|
46535
46868
|
},
|
|
46536
46869
|
},
|
|
46537
|
-
required: ['rule'
|
|
46870
|
+
required: ['rule'],
|
|
46538
46871
|
type: 'object',
|
|
46539
46872
|
},
|
|
46540
46873
|
},
|
|
@@ -46630,7 +46963,7 @@ export default {
|
|
|
46630
46963
|
type: 'string',
|
|
46631
46964
|
},
|
|
46632
46965
|
},
|
|
46633
|
-
required: ['rule'
|
|
46966
|
+
required: ['rule'],
|
|
46634
46967
|
type: 'object',
|
|
46635
46968
|
},
|
|
46636
46969
|
reservation_time_updated: {
|
|
@@ -46641,7 +46974,7 @@ export default {
|
|
|
46641
46974
|
type: 'string',
|
|
46642
46975
|
},
|
|
46643
46976
|
},
|
|
46644
|
-
required: ['rule'
|
|
46977
|
+
required: ['rule'],
|
|
46645
46978
|
type: 'object',
|
|
46646
46979
|
},
|
|
46647
46980
|
},
|
|
@@ -47893,7 +48226,13 @@ export default {
|
|
|
47893
48226
|
required: false,
|
|
47894
48227
|
schema: {
|
|
47895
48228
|
items: {
|
|
47896
|
-
enum: [
|
|
48229
|
+
enum: [
|
|
48230
|
+
'spaces',
|
|
48231
|
+
'devices',
|
|
48232
|
+
'acs_entrances',
|
|
48233
|
+
'connected_accounts',
|
|
48234
|
+
'acs_systems',
|
|
48235
|
+
],
|
|
47897
48236
|
type: 'string',
|
|
47898
48237
|
},
|
|
47899
48238
|
type: 'array',
|
|
@@ -47905,7 +48244,13 @@ export default {
|
|
|
47905
48244
|
required: false,
|
|
47906
48245
|
schema: {
|
|
47907
48246
|
items: {
|
|
47908
|
-
enum: [
|
|
48247
|
+
enum: [
|
|
48248
|
+
'spaces',
|
|
48249
|
+
'devices',
|
|
48250
|
+
'acs_entrances',
|
|
48251
|
+
'connected_accounts',
|
|
48252
|
+
'acs_systems',
|
|
48253
|
+
],
|
|
47909
48254
|
type: 'string',
|
|
47910
48255
|
},
|
|
47911
48256
|
type: 'array',
|
|
@@ -47919,20 +48264,22 @@ export default {
|
|
|
47919
48264
|
schema: {
|
|
47920
48265
|
properties: {
|
|
47921
48266
|
batch: {
|
|
47922
|
-
description: '
|
|
48267
|
+
description: 'ID of the affected access system user.',
|
|
47923
48268
|
properties: {
|
|
47924
48269
|
acs_entrances: {
|
|
47925
48270
|
items: { $ref: '#/components/schemas/acs_entrance' },
|
|
47926
48271
|
type: 'array',
|
|
47927
48272
|
},
|
|
47928
|
-
|
|
47929
|
-
|
|
47930
|
-
|
|
47931
|
-
|
|
47932
|
-
|
|
47933
|
-
|
|
47934
|
-
|
|
47935
|
-
|
|
48273
|
+
acs_systems: {
|
|
48274
|
+
items: { $ref: '#/components/schemas/acs_system' },
|
|
48275
|
+
type: 'array',
|
|
48276
|
+
},
|
|
48277
|
+
batch_type: { enum: ['spaces'], type: 'string' },
|
|
48278
|
+
connected_accounts: {
|
|
48279
|
+
items: {
|
|
48280
|
+
$ref: '#/components/schemas/connected_account',
|
|
48281
|
+
},
|
|
48282
|
+
type: 'array',
|
|
47936
48283
|
},
|
|
47937
48284
|
devices: {
|
|
47938
48285
|
items: { $ref: '#/components/schemas/device' },
|
|
@@ -47942,18 +48289,9 @@ export default {
|
|
|
47942
48289
|
items: { $ref: '#/components/schemas/space' },
|
|
47943
48290
|
type: 'array',
|
|
47944
48291
|
},
|
|
47945
|
-
user_identities: {
|
|
47946
|
-
items: { $ref: '#/components/schemas/user_identity' },
|
|
47947
|
-
type: 'array',
|
|
47948
|
-
},
|
|
47949
|
-
workspaces: {
|
|
47950
|
-
items: { $ref: '#/components/schemas/workspace' },
|
|
47951
|
-
type: 'array',
|
|
47952
|
-
},
|
|
47953
48292
|
},
|
|
47954
48293
|
required: ['batch_type'],
|
|
47955
48294
|
type: 'object',
|
|
47956
|
-
'x-route-path': '/',
|
|
47957
48295
|
},
|
|
47958
48296
|
ok: { type: 'boolean' },
|
|
47959
48297
|
},
|
|
@@ -47992,14 +48330,26 @@ export default {
|
|
|
47992
48330
|
properties: {
|
|
47993
48331
|
exclude: {
|
|
47994
48332
|
items: {
|
|
47995
|
-
enum: [
|
|
48333
|
+
enum: [
|
|
48334
|
+
'spaces',
|
|
48335
|
+
'devices',
|
|
48336
|
+
'acs_entrances',
|
|
48337
|
+
'connected_accounts',
|
|
48338
|
+
'acs_systems',
|
|
48339
|
+
],
|
|
47996
48340
|
type: 'string',
|
|
47997
48341
|
},
|
|
47998
48342
|
type: 'array',
|
|
47999
48343
|
},
|
|
48000
48344
|
include: {
|
|
48001
48345
|
items: {
|
|
48002
|
-
enum: [
|
|
48346
|
+
enum: [
|
|
48347
|
+
'spaces',
|
|
48348
|
+
'devices',
|
|
48349
|
+
'acs_entrances',
|
|
48350
|
+
'connected_accounts',
|
|
48351
|
+
'acs_systems',
|
|
48352
|
+
],
|
|
48003
48353
|
type: 'string',
|
|
48004
48354
|
},
|
|
48005
48355
|
type: 'array',
|
|
@@ -48024,20 +48374,22 @@ export default {
|
|
|
48024
48374
|
schema: {
|
|
48025
48375
|
properties: {
|
|
48026
48376
|
batch: {
|
|
48027
|
-
description: '
|
|
48377
|
+
description: 'ID of the affected access system user.',
|
|
48028
48378
|
properties: {
|
|
48029
48379
|
acs_entrances: {
|
|
48030
48380
|
items: { $ref: '#/components/schemas/acs_entrance' },
|
|
48031
48381
|
type: 'array',
|
|
48032
48382
|
},
|
|
48033
|
-
|
|
48034
|
-
|
|
48035
|
-
|
|
48036
|
-
|
|
48037
|
-
|
|
48038
|
-
|
|
48039
|
-
|
|
48040
|
-
|
|
48383
|
+
acs_systems: {
|
|
48384
|
+
items: { $ref: '#/components/schemas/acs_system' },
|
|
48385
|
+
type: 'array',
|
|
48386
|
+
},
|
|
48387
|
+
batch_type: { enum: ['spaces'], type: 'string' },
|
|
48388
|
+
connected_accounts: {
|
|
48389
|
+
items: {
|
|
48390
|
+
$ref: '#/components/schemas/connected_account',
|
|
48391
|
+
},
|
|
48392
|
+
type: 'array',
|
|
48041
48393
|
},
|
|
48042
48394
|
devices: {
|
|
48043
48395
|
items: { $ref: '#/components/schemas/device' },
|
|
@@ -48047,18 +48399,9 @@ export default {
|
|
|
48047
48399
|
items: { $ref: '#/components/schemas/space' },
|
|
48048
48400
|
type: 'array',
|
|
48049
48401
|
},
|
|
48050
|
-
user_identities: {
|
|
48051
|
-
items: { $ref: '#/components/schemas/user_identity' },
|
|
48052
|
-
type: 'array',
|
|
48053
|
-
},
|
|
48054
|
-
workspaces: {
|
|
48055
|
-
items: { $ref: '#/components/schemas/workspace' },
|
|
48056
|
-
type: 'array',
|
|
48057
|
-
},
|
|
48058
48402
|
},
|
|
48059
48403
|
required: ['batch_type'],
|
|
48060
48404
|
type: 'object',
|
|
48061
|
-
'x-route-path': '/',
|
|
48062
48405
|
},
|
|
48063
48406
|
ok: { type: 'boolean' },
|
|
48064
48407
|
},
|