@seamapi/types 1.469.0 → 1.471.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 +2 -853
- package/dist/connect.cjs.map +1 -1
- package/dist/connect.d.cts +450 -1847
- package/dist/index.cjs +2 -853
- package/dist/index.cjs.map +1 -1
- package/lib/seam/connect/models/instant-keys/instant-key.js +1 -2
- package/lib/seam/connect/models/instant-keys/instant-key.js.map +1 -1
- package/lib/seam/connect/openapi.d.ts +0 -1084
- package/lib/seam/connect/openapi.js +1 -851
- package/lib/seam/connect/openapi.js.map +1 -1
- package/lib/seam/connect/route-types.d.ts +0 -313
- package/package.json +1 -1
- package/src/lib/seam/connect/models/instant-keys/instant-key.ts +1 -2
- package/src/lib/seam/connect/openapi.ts +1 -877
- package/src/lib/seam/connect/route-types.ts +0 -318
|
@@ -17165,8 +17165,7 @@ export default {
|
|
|
17165
17165
|
'expires_at',
|
|
17166
17166
|
],
|
|
17167
17167
|
type: 'object',
|
|
17168
|
-
'x-route-path': '/
|
|
17169
|
-
'x-undocumented': 'Unreleased.',
|
|
17168
|
+
'x-route-path': '/instant_keys',
|
|
17170
17169
|
},
|
|
17171
17170
|
location: {
|
|
17172
17171
|
properties: {
|
|
@@ -49142,855 +49141,6 @@ export default {
|
|
|
49142
49141
|
'x-title': 'Update the Thermostat Weekly Program',
|
|
49143
49142
|
},
|
|
49144
49143
|
},
|
|
49145
|
-
'/unstable_access_grants/create': {
|
|
49146
|
-
post: {
|
|
49147
|
-
description: 'Creates a new access grant.',
|
|
49148
|
-
operationId: 'unstableAccessGrantsCreatePost',
|
|
49149
|
-
requestBody: {
|
|
49150
|
-
content: {
|
|
49151
|
-
'application/json': {
|
|
49152
|
-
schema: {
|
|
49153
|
-
allOf: [
|
|
49154
|
-
{
|
|
49155
|
-
oneOf: [
|
|
49156
|
-
{
|
|
49157
|
-
properties: {
|
|
49158
|
-
user_identity_id: {
|
|
49159
|
-
description: 'ID of user identity for whom you want to grant access.',
|
|
49160
|
-
format: 'uuid',
|
|
49161
|
-
type: 'string',
|
|
49162
|
-
},
|
|
49163
|
-
},
|
|
49164
|
-
required: ['user_identity_id'],
|
|
49165
|
-
type: 'object',
|
|
49166
|
-
},
|
|
49167
|
-
{
|
|
49168
|
-
properties: {
|
|
49169
|
-
user_identity: {
|
|
49170
|
-
description: 'User identity. When used, creates a new user identity with the specified details and grants them access.',
|
|
49171
|
-
properties: {
|
|
49172
|
-
email_address: {
|
|
49173
|
-
description: 'Unique email address for the user identity.',
|
|
49174
|
-
format: 'email',
|
|
49175
|
-
nullable: true,
|
|
49176
|
-
type: 'string',
|
|
49177
|
-
},
|
|
49178
|
-
full_name: {
|
|
49179
|
-
minLength: 1,
|
|
49180
|
-
nullable: true,
|
|
49181
|
-
type: 'string',
|
|
49182
|
-
},
|
|
49183
|
-
phone_number: {
|
|
49184
|
-
description: 'Unique phone number for the user identity in [E.164 format](https://www.itu.int/rec/T-REC-E.164/en) (for example, +15555550100).',
|
|
49185
|
-
nullable: true,
|
|
49186
|
-
type: 'string',
|
|
49187
|
-
},
|
|
49188
|
-
},
|
|
49189
|
-
type: 'object',
|
|
49190
|
-
},
|
|
49191
|
-
},
|
|
49192
|
-
required: ['user_identity'],
|
|
49193
|
-
type: 'object',
|
|
49194
|
-
},
|
|
49195
|
-
],
|
|
49196
|
-
},
|
|
49197
|
-
{
|
|
49198
|
-
properties: {
|
|
49199
|
-
acs_entrance_ids: {
|
|
49200
|
-
default: [],
|
|
49201
|
-
description: 'IDs of the [entrances](https://docs.seam.co/latest/capability-guides/access-systems/retrieving-entrance-details) to which you want to grant access.',
|
|
49202
|
-
items: { format: 'uuid', type: 'string' },
|
|
49203
|
-
type: 'array',
|
|
49204
|
-
},
|
|
49205
|
-
device_ids: {
|
|
49206
|
-
default: [],
|
|
49207
|
-
description: 'IDs of the devices to which you want to grant access.',
|
|
49208
|
-
items: { format: 'uuid', type: 'string' },
|
|
49209
|
-
type: 'array',
|
|
49210
|
-
},
|
|
49211
|
-
ends_at: {
|
|
49212
|
-
description: 'Date and time at which the validity of the new grant 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`.',
|
|
49213
|
-
format: 'date-time',
|
|
49214
|
-
type: 'string',
|
|
49215
|
-
},
|
|
49216
|
-
location: {
|
|
49217
|
-
description: 'Location. When used, creates a new location with the specified entrances and devices, and gives the user access to this location.',
|
|
49218
|
-
properties: {
|
|
49219
|
-
acs_entrance_ids: {
|
|
49220
|
-
default: [],
|
|
49221
|
-
deprecated: true,
|
|
49222
|
-
items: { format: 'uuid', type: 'string' },
|
|
49223
|
-
type: 'array',
|
|
49224
|
-
'x-deprecated': 'Use `acs_entrance_ids` at the top level.',
|
|
49225
|
-
},
|
|
49226
|
-
device_ids: {
|
|
49227
|
-
default: [],
|
|
49228
|
-
deprecated: true,
|
|
49229
|
-
items: { format: 'uuid', type: 'string' },
|
|
49230
|
-
type: 'array',
|
|
49231
|
-
'x-deprecated': 'Use `device_ids` at the top level.',
|
|
49232
|
-
},
|
|
49233
|
-
name: {
|
|
49234
|
-
description: 'Name of the location.',
|
|
49235
|
-
type: 'string',
|
|
49236
|
-
},
|
|
49237
|
-
},
|
|
49238
|
-
type: 'object',
|
|
49239
|
-
},
|
|
49240
|
-
location_ids: {
|
|
49241
|
-
deprecated: true,
|
|
49242
|
-
items: { format: 'uuid', type: 'string' },
|
|
49243
|
-
type: 'array',
|
|
49244
|
-
'x-deprecated': 'Use `space_ids`.',
|
|
49245
|
-
},
|
|
49246
|
-
requested_access_methods: {
|
|
49247
|
-
items: {
|
|
49248
|
-
properties: {
|
|
49249
|
-
mode: {
|
|
49250
|
-
description: 'Access method mode.',
|
|
49251
|
-
enum: ['code', 'card', 'mobile_key'],
|
|
49252
|
-
type: 'string',
|
|
49253
|
-
},
|
|
49254
|
-
},
|
|
49255
|
-
required: ['mode'],
|
|
49256
|
-
type: 'object',
|
|
49257
|
-
},
|
|
49258
|
-
type: 'array',
|
|
49259
|
-
},
|
|
49260
|
-
space_ids: {
|
|
49261
|
-
description: 'IDs of the existing spaces to which you want to grant access.',
|
|
49262
|
-
items: { format: 'uuid', type: 'string' },
|
|
49263
|
-
type: 'array',
|
|
49264
|
-
},
|
|
49265
|
-
starts_at: {
|
|
49266
|
-
description: '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.',
|
|
49267
|
-
format: 'date-time',
|
|
49268
|
-
type: 'string',
|
|
49269
|
-
},
|
|
49270
|
-
},
|
|
49271
|
-
required: ['requested_access_methods'],
|
|
49272
|
-
type: 'object',
|
|
49273
|
-
},
|
|
49274
|
-
],
|
|
49275
|
-
},
|
|
49276
|
-
},
|
|
49277
|
-
},
|
|
49278
|
-
},
|
|
49279
|
-
responses: {
|
|
49280
|
-
200: {
|
|
49281
|
-
content: {
|
|
49282
|
-
'application/json': {
|
|
49283
|
-
schema: {
|
|
49284
|
-
properties: {
|
|
49285
|
-
access_grant: { $ref: '#/components/schemas/access_grant' },
|
|
49286
|
-
ok: { type: 'boolean' },
|
|
49287
|
-
},
|
|
49288
|
-
required: ['access_grant', 'ok'],
|
|
49289
|
-
type: 'object',
|
|
49290
|
-
},
|
|
49291
|
-
},
|
|
49292
|
-
},
|
|
49293
|
-
description: 'OK',
|
|
49294
|
-
},
|
|
49295
|
-
400: { description: 'Bad Request' },
|
|
49296
|
-
401: { description: 'Unauthorized' },
|
|
49297
|
-
},
|
|
49298
|
-
security: [
|
|
49299
|
-
{ pat_with_workspace: [] },
|
|
49300
|
-
{ console_session_with_workspace: [] },
|
|
49301
|
-
{ api_key: [] },
|
|
49302
|
-
{ client_session_with_customer: [] },
|
|
49303
|
-
],
|
|
49304
|
-
summary: '/unstable_access_grants/create',
|
|
49305
|
-
tags: [],
|
|
49306
|
-
'x-fern-sdk-group-name': ['unstable_access_grants'],
|
|
49307
|
-
'x-fern-sdk-method-name': 'create',
|
|
49308
|
-
'x-fern-sdk-return-value': 'access_grant',
|
|
49309
|
-
'x-response-key': 'access_grant',
|
|
49310
|
-
'x-title': 'Create an Access Grant',
|
|
49311
|
-
'x-undocumented': 'Unreleased.',
|
|
49312
|
-
},
|
|
49313
|
-
},
|
|
49314
|
-
'/unstable_access_grants/delete': {
|
|
49315
|
-
delete: {
|
|
49316
|
-
description: 'Deletes an access grant.',
|
|
49317
|
-
operationId: 'unstableAccessGrantsDeleteDelete',
|
|
49318
|
-
parameters: [
|
|
49319
|
-
{
|
|
49320
|
-
in: 'query',
|
|
49321
|
-
name: 'access_grant_id',
|
|
49322
|
-
required: true,
|
|
49323
|
-
schema: {
|
|
49324
|
-
description: 'ID of access grant that you want to delete.',
|
|
49325
|
-
format: 'uuid',
|
|
49326
|
-
type: 'string',
|
|
49327
|
-
},
|
|
49328
|
-
},
|
|
49329
|
-
],
|
|
49330
|
-
responses: {
|
|
49331
|
-
200: {
|
|
49332
|
-
content: {
|
|
49333
|
-
'application/json': {
|
|
49334
|
-
schema: {
|
|
49335
|
-
properties: { ok: { type: 'boolean' } },
|
|
49336
|
-
required: ['ok'],
|
|
49337
|
-
type: 'object',
|
|
49338
|
-
},
|
|
49339
|
-
},
|
|
49340
|
-
},
|
|
49341
|
-
description: 'OK',
|
|
49342
|
-
},
|
|
49343
|
-
400: { description: 'Bad Request' },
|
|
49344
|
-
401: { description: 'Unauthorized' },
|
|
49345
|
-
},
|
|
49346
|
-
security: [
|
|
49347
|
-
{ pat_with_workspace: [] },
|
|
49348
|
-
{ console_session_with_workspace: [] },
|
|
49349
|
-
{ api_key: [] },
|
|
49350
|
-
{ client_session_with_customer: [] },
|
|
49351
|
-
],
|
|
49352
|
-
summary: '/unstable_access_grants/delete',
|
|
49353
|
-
tags: [],
|
|
49354
|
-
'x-fern-sdk-group-name': ['unstable_access_grants'],
|
|
49355
|
-
'x-fern-sdk-method-name': 'delete',
|
|
49356
|
-
'x-response-key': null,
|
|
49357
|
-
'x-title': 'Delete an Access Grant',
|
|
49358
|
-
'x-undocumented': 'Unreleased.',
|
|
49359
|
-
},
|
|
49360
|
-
post: {
|
|
49361
|
-
description: 'Deletes an access grant.',
|
|
49362
|
-
operationId: 'unstableAccessGrantsDeletePost',
|
|
49363
|
-
requestBody: {
|
|
49364
|
-
content: {
|
|
49365
|
-
'application/json': {
|
|
49366
|
-
schema: {
|
|
49367
|
-
properties: {
|
|
49368
|
-
access_grant_id: {
|
|
49369
|
-
description: 'ID of access grant that you want to delete.',
|
|
49370
|
-
format: 'uuid',
|
|
49371
|
-
type: 'string',
|
|
49372
|
-
},
|
|
49373
|
-
},
|
|
49374
|
-
required: ['access_grant_id'],
|
|
49375
|
-
type: 'object',
|
|
49376
|
-
},
|
|
49377
|
-
},
|
|
49378
|
-
},
|
|
49379
|
-
},
|
|
49380
|
-
responses: {
|
|
49381
|
-
200: {
|
|
49382
|
-
content: {
|
|
49383
|
-
'application/json': {
|
|
49384
|
-
schema: {
|
|
49385
|
-
properties: { ok: { type: 'boolean' } },
|
|
49386
|
-
required: ['ok'],
|
|
49387
|
-
type: 'object',
|
|
49388
|
-
},
|
|
49389
|
-
},
|
|
49390
|
-
},
|
|
49391
|
-
description: 'OK',
|
|
49392
|
-
},
|
|
49393
|
-
400: { description: 'Bad Request' },
|
|
49394
|
-
401: { description: 'Unauthorized' },
|
|
49395
|
-
},
|
|
49396
|
-
security: [
|
|
49397
|
-
{ pat_with_workspace: [] },
|
|
49398
|
-
{ console_session_with_workspace: [] },
|
|
49399
|
-
{ api_key: [] },
|
|
49400
|
-
{ client_session_with_customer: [] },
|
|
49401
|
-
],
|
|
49402
|
-
summary: '/unstable_access_grants/delete',
|
|
49403
|
-
tags: [],
|
|
49404
|
-
'x-fern-sdk-group-name': ['unstable_access_grants'],
|
|
49405
|
-
'x-fern-sdk-method-name': 'delete',
|
|
49406
|
-
'x-response-key': null,
|
|
49407
|
-
'x-title': 'Delete an Access Grant',
|
|
49408
|
-
'x-undocumented': 'Unreleased.',
|
|
49409
|
-
},
|
|
49410
|
-
},
|
|
49411
|
-
'/unstable_access_grants/get': {
|
|
49412
|
-
get: {
|
|
49413
|
-
description: 'Gets an access grant.',
|
|
49414
|
-
operationId: 'unstableAccessGrantsGetGet',
|
|
49415
|
-
parameters: [
|
|
49416
|
-
{
|
|
49417
|
-
in: 'query',
|
|
49418
|
-
name: 'access_grant_id',
|
|
49419
|
-
required: true,
|
|
49420
|
-
schema: {
|
|
49421
|
-
description: 'ID of access grant that you want to get.',
|
|
49422
|
-
format: 'uuid',
|
|
49423
|
-
type: 'string',
|
|
49424
|
-
},
|
|
49425
|
-
},
|
|
49426
|
-
],
|
|
49427
|
-
responses: {
|
|
49428
|
-
200: {
|
|
49429
|
-
content: {
|
|
49430
|
-
'application/json': {
|
|
49431
|
-
schema: {
|
|
49432
|
-
properties: {
|
|
49433
|
-
access_grant: { $ref: '#/components/schemas/access_grant' },
|
|
49434
|
-
ok: { type: 'boolean' },
|
|
49435
|
-
},
|
|
49436
|
-
required: ['access_grant', 'ok'],
|
|
49437
|
-
type: 'object',
|
|
49438
|
-
},
|
|
49439
|
-
},
|
|
49440
|
-
},
|
|
49441
|
-
description: 'OK',
|
|
49442
|
-
},
|
|
49443
|
-
400: { description: 'Bad Request' },
|
|
49444
|
-
401: { description: 'Unauthorized' },
|
|
49445
|
-
},
|
|
49446
|
-
security: [
|
|
49447
|
-
{ pat_with_workspace: [] },
|
|
49448
|
-
{ console_session_with_workspace: [] },
|
|
49449
|
-
{ api_key: [] },
|
|
49450
|
-
{ client_session_with_customer: [] },
|
|
49451
|
-
],
|
|
49452
|
-
summary: '/unstable_access_grants/get',
|
|
49453
|
-
tags: [],
|
|
49454
|
-
'x-fern-sdk-group-name': ['unstable_access_grants'],
|
|
49455
|
-
'x-fern-sdk-method-name': 'get',
|
|
49456
|
-
'x-fern-sdk-return-value': 'access_grant',
|
|
49457
|
-
'x-response-key': 'access_grant',
|
|
49458
|
-
'x-title': 'Get an Access Grant',
|
|
49459
|
-
'x-undocumented': 'Unreleased.',
|
|
49460
|
-
},
|
|
49461
|
-
post: {
|
|
49462
|
-
description: 'Gets an access grant.',
|
|
49463
|
-
operationId: 'unstableAccessGrantsGetPost',
|
|
49464
|
-
requestBody: {
|
|
49465
|
-
content: {
|
|
49466
|
-
'application/json': {
|
|
49467
|
-
schema: {
|
|
49468
|
-
properties: {
|
|
49469
|
-
access_grant_id: {
|
|
49470
|
-
description: 'ID of access grant that you want to get.',
|
|
49471
|
-
format: 'uuid',
|
|
49472
|
-
type: 'string',
|
|
49473
|
-
},
|
|
49474
|
-
},
|
|
49475
|
-
required: ['access_grant_id'],
|
|
49476
|
-
type: 'object',
|
|
49477
|
-
},
|
|
49478
|
-
},
|
|
49479
|
-
},
|
|
49480
|
-
},
|
|
49481
|
-
responses: {
|
|
49482
|
-
200: {
|
|
49483
|
-
content: {
|
|
49484
|
-
'application/json': {
|
|
49485
|
-
schema: {
|
|
49486
|
-
properties: {
|
|
49487
|
-
access_grant: { $ref: '#/components/schemas/access_grant' },
|
|
49488
|
-
ok: { type: 'boolean' },
|
|
49489
|
-
},
|
|
49490
|
-
required: ['access_grant', 'ok'],
|
|
49491
|
-
type: 'object',
|
|
49492
|
-
},
|
|
49493
|
-
},
|
|
49494
|
-
},
|
|
49495
|
-
description: 'OK',
|
|
49496
|
-
},
|
|
49497
|
-
400: { description: 'Bad Request' },
|
|
49498
|
-
401: { description: 'Unauthorized' },
|
|
49499
|
-
},
|
|
49500
|
-
security: [
|
|
49501
|
-
{ pat_with_workspace: [] },
|
|
49502
|
-
{ console_session_with_workspace: [] },
|
|
49503
|
-
{ api_key: [] },
|
|
49504
|
-
{ client_session_with_customer: [] },
|
|
49505
|
-
],
|
|
49506
|
-
summary: '/unstable_access_grants/get',
|
|
49507
|
-
tags: [],
|
|
49508
|
-
'x-fern-sdk-group-name': ['unstable_access_grants'],
|
|
49509
|
-
'x-fern-sdk-method-name': 'get',
|
|
49510
|
-
'x-fern-sdk-return-value': 'access_grant',
|
|
49511
|
-
'x-response-key': 'access_grant',
|
|
49512
|
-
'x-title': 'Get an Access Grant',
|
|
49513
|
-
'x-undocumented': 'Unreleased.',
|
|
49514
|
-
},
|
|
49515
|
-
},
|
|
49516
|
-
'/unstable_access_grants/list': {
|
|
49517
|
-
get: {
|
|
49518
|
-
description: 'Returns a list of all access grants.',
|
|
49519
|
-
operationId: 'unstableAccessGrantsListGet',
|
|
49520
|
-
parameters: [
|
|
49521
|
-
{
|
|
49522
|
-
in: 'query',
|
|
49523
|
-
name: 'user_identity_id',
|
|
49524
|
-
schema: {
|
|
49525
|
-
description: 'ID of the user identity by which you want to filter the list of access grants.',
|
|
49526
|
-
format: 'uuid',
|
|
49527
|
-
type: 'string',
|
|
49528
|
-
},
|
|
49529
|
-
},
|
|
49530
|
-
{
|
|
49531
|
-
in: 'query',
|
|
49532
|
-
name: 'acs_system_id',
|
|
49533
|
-
schema: {
|
|
49534
|
-
description: 'ID of the access system by which you want to filter the list of access grants.',
|
|
49535
|
-
format: 'uuid',
|
|
49536
|
-
type: 'string',
|
|
49537
|
-
},
|
|
49538
|
-
},
|
|
49539
|
-
{
|
|
49540
|
-
in: 'query',
|
|
49541
|
-
name: 'acs_entrance_id',
|
|
49542
|
-
schema: {
|
|
49543
|
-
description: 'ID of the entrance by which you want to filter the list of access grants.',
|
|
49544
|
-
format: 'uuid',
|
|
49545
|
-
type: 'string',
|
|
49546
|
-
},
|
|
49547
|
-
},
|
|
49548
|
-
{
|
|
49549
|
-
in: 'query',
|
|
49550
|
-
name: 'location_id',
|
|
49551
|
-
schema: {
|
|
49552
|
-
deprecated: true,
|
|
49553
|
-
format: 'uuid',
|
|
49554
|
-
type: 'string',
|
|
49555
|
-
'x-deprecated': 'Use `space_id`.',
|
|
49556
|
-
},
|
|
49557
|
-
},
|
|
49558
|
-
{
|
|
49559
|
-
in: 'query',
|
|
49560
|
-
name: 'space_id',
|
|
49561
|
-
schema: {
|
|
49562
|
-
description: 'ID of the space by which you want to filter the list of access grants.',
|
|
49563
|
-
format: 'uuid',
|
|
49564
|
-
type: 'string',
|
|
49565
|
-
},
|
|
49566
|
-
},
|
|
49567
|
-
],
|
|
49568
|
-
responses: {
|
|
49569
|
-
200: {
|
|
49570
|
-
content: {
|
|
49571
|
-
'application/json': {
|
|
49572
|
-
schema: {
|
|
49573
|
-
properties: {
|
|
49574
|
-
access_grants: {
|
|
49575
|
-
items: { $ref: '#/components/schemas/access_grant' },
|
|
49576
|
-
type: 'array',
|
|
49577
|
-
},
|
|
49578
|
-
ok: { type: 'boolean' },
|
|
49579
|
-
},
|
|
49580
|
-
required: ['access_grants', 'ok'],
|
|
49581
|
-
type: 'object',
|
|
49582
|
-
},
|
|
49583
|
-
},
|
|
49584
|
-
},
|
|
49585
|
-
description: 'OK',
|
|
49586
|
-
},
|
|
49587
|
-
400: { description: 'Bad Request' },
|
|
49588
|
-
401: { description: 'Unauthorized' },
|
|
49589
|
-
},
|
|
49590
|
-
security: [
|
|
49591
|
-
{ pat_with_workspace: [] },
|
|
49592
|
-
{ console_session_with_workspace: [] },
|
|
49593
|
-
{ api_key: [] },
|
|
49594
|
-
{ client_session_with_customer: [] },
|
|
49595
|
-
],
|
|
49596
|
-
summary: '/unstable_access_grants/list',
|
|
49597
|
-
tags: [],
|
|
49598
|
-
'x-fern-sdk-group-name': ['unstable_access_grants'],
|
|
49599
|
-
'x-fern-sdk-method-name': 'list',
|
|
49600
|
-
'x-fern-sdk-return-value': 'access_grants',
|
|
49601
|
-
'x-response-key': 'access_grants',
|
|
49602
|
-
'x-title': 'List Access Grants',
|
|
49603
|
-
'x-undocumented': 'Unreleased.',
|
|
49604
|
-
},
|
|
49605
|
-
post: {
|
|
49606
|
-
description: 'Returns a list of all access grants.',
|
|
49607
|
-
operationId: 'unstableAccessGrantsListPost',
|
|
49608
|
-
requestBody: {
|
|
49609
|
-
content: {
|
|
49610
|
-
'application/json': {
|
|
49611
|
-
schema: {
|
|
49612
|
-
properties: {
|
|
49613
|
-
acs_entrance_id: {
|
|
49614
|
-
description: 'ID of the entrance by which you want to filter the list of access grants.',
|
|
49615
|
-
format: 'uuid',
|
|
49616
|
-
type: 'string',
|
|
49617
|
-
},
|
|
49618
|
-
acs_system_id: {
|
|
49619
|
-
description: 'ID of the access system by which you want to filter the list of access grants.',
|
|
49620
|
-
format: 'uuid',
|
|
49621
|
-
type: 'string',
|
|
49622
|
-
},
|
|
49623
|
-
location_id: {
|
|
49624
|
-
deprecated: true,
|
|
49625
|
-
format: 'uuid',
|
|
49626
|
-
type: 'string',
|
|
49627
|
-
'x-deprecated': 'Use `space_id`.',
|
|
49628
|
-
},
|
|
49629
|
-
space_id: {
|
|
49630
|
-
description: 'ID of the space by which you want to filter the list of access grants.',
|
|
49631
|
-
format: 'uuid',
|
|
49632
|
-
type: 'string',
|
|
49633
|
-
},
|
|
49634
|
-
user_identity_id: {
|
|
49635
|
-
description: 'ID of the user identity by which you want to filter the list of access grants.',
|
|
49636
|
-
format: 'uuid',
|
|
49637
|
-
type: 'string',
|
|
49638
|
-
},
|
|
49639
|
-
},
|
|
49640
|
-
type: 'object',
|
|
49641
|
-
},
|
|
49642
|
-
},
|
|
49643
|
-
},
|
|
49644
|
-
},
|
|
49645
|
-
responses: {
|
|
49646
|
-
200: {
|
|
49647
|
-
content: {
|
|
49648
|
-
'application/json': {
|
|
49649
|
-
schema: {
|
|
49650
|
-
properties: {
|
|
49651
|
-
access_grants: {
|
|
49652
|
-
items: { $ref: '#/components/schemas/access_grant' },
|
|
49653
|
-
type: 'array',
|
|
49654
|
-
},
|
|
49655
|
-
ok: { type: 'boolean' },
|
|
49656
|
-
},
|
|
49657
|
-
required: ['access_grants', 'ok'],
|
|
49658
|
-
type: 'object',
|
|
49659
|
-
},
|
|
49660
|
-
},
|
|
49661
|
-
},
|
|
49662
|
-
description: 'OK',
|
|
49663
|
-
},
|
|
49664
|
-
400: { description: 'Bad Request' },
|
|
49665
|
-
401: { description: 'Unauthorized' },
|
|
49666
|
-
},
|
|
49667
|
-
security: [
|
|
49668
|
-
{ pat_with_workspace: [] },
|
|
49669
|
-
{ console_session_with_workspace: [] },
|
|
49670
|
-
{ api_key: [] },
|
|
49671
|
-
{ client_session_with_customer: [] },
|
|
49672
|
-
],
|
|
49673
|
-
summary: '/unstable_access_grants/list',
|
|
49674
|
-
tags: [],
|
|
49675
|
-
'x-fern-sdk-group-name': ['unstable_access_grants'],
|
|
49676
|
-
'x-fern-sdk-method-name': 'list',
|
|
49677
|
-
'x-fern-sdk-return-value': 'access_grants',
|
|
49678
|
-
'x-response-key': 'access_grants',
|
|
49679
|
-
'x-title': 'List Access Grants',
|
|
49680
|
-
'x-undocumented': 'Unreleased.',
|
|
49681
|
-
},
|
|
49682
|
-
},
|
|
49683
|
-
'/unstable_access_methods/delete': {
|
|
49684
|
-
delete: {
|
|
49685
|
-
description: 'Deletes an access method.',
|
|
49686
|
-
operationId: 'unstableAccessMethodsDeleteDelete',
|
|
49687
|
-
parameters: [
|
|
49688
|
-
{
|
|
49689
|
-
in: 'query',
|
|
49690
|
-
name: 'access_method_id',
|
|
49691
|
-
required: true,
|
|
49692
|
-
schema: {
|
|
49693
|
-
description: 'ID of the access method that you want to delete.',
|
|
49694
|
-
format: 'uuid',
|
|
49695
|
-
type: 'string',
|
|
49696
|
-
},
|
|
49697
|
-
},
|
|
49698
|
-
],
|
|
49699
|
-
responses: {
|
|
49700
|
-
200: {
|
|
49701
|
-
content: {
|
|
49702
|
-
'application/json': {
|
|
49703
|
-
schema: {
|
|
49704
|
-
properties: { ok: { type: 'boolean' } },
|
|
49705
|
-
required: ['ok'],
|
|
49706
|
-
type: 'object',
|
|
49707
|
-
},
|
|
49708
|
-
},
|
|
49709
|
-
},
|
|
49710
|
-
description: 'OK',
|
|
49711
|
-
},
|
|
49712
|
-
400: { description: 'Bad Request' },
|
|
49713
|
-
401: { description: 'Unauthorized' },
|
|
49714
|
-
},
|
|
49715
|
-
security: [
|
|
49716
|
-
{ pat_with_workspace: [] },
|
|
49717
|
-
{ console_session_with_workspace: [] },
|
|
49718
|
-
{ api_key: [] },
|
|
49719
|
-
],
|
|
49720
|
-
summary: '/unstable_access_methods/delete',
|
|
49721
|
-
tags: [],
|
|
49722
|
-
'x-fern-sdk-group-name': ['unstable_access_methods'],
|
|
49723
|
-
'x-fern-sdk-method-name': 'delete',
|
|
49724
|
-
'x-response-key': null,
|
|
49725
|
-
'x-title': 'Delete an Access Method',
|
|
49726
|
-
'x-undocumented': 'Unreleased.',
|
|
49727
|
-
},
|
|
49728
|
-
post: {
|
|
49729
|
-
description: 'Deletes an access method.',
|
|
49730
|
-
operationId: 'unstableAccessMethodsDeletePost',
|
|
49731
|
-
requestBody: {
|
|
49732
|
-
content: {
|
|
49733
|
-
'application/json': {
|
|
49734
|
-
schema: {
|
|
49735
|
-
properties: {
|
|
49736
|
-
access_method_id: {
|
|
49737
|
-
description: 'ID of the access method that you want to delete.',
|
|
49738
|
-
format: 'uuid',
|
|
49739
|
-
type: 'string',
|
|
49740
|
-
},
|
|
49741
|
-
},
|
|
49742
|
-
required: ['access_method_id'],
|
|
49743
|
-
type: 'object',
|
|
49744
|
-
},
|
|
49745
|
-
},
|
|
49746
|
-
},
|
|
49747
|
-
},
|
|
49748
|
-
responses: {
|
|
49749
|
-
200: {
|
|
49750
|
-
content: {
|
|
49751
|
-
'application/json': {
|
|
49752
|
-
schema: {
|
|
49753
|
-
properties: { ok: { type: 'boolean' } },
|
|
49754
|
-
required: ['ok'],
|
|
49755
|
-
type: 'object',
|
|
49756
|
-
},
|
|
49757
|
-
},
|
|
49758
|
-
},
|
|
49759
|
-
description: 'OK',
|
|
49760
|
-
},
|
|
49761
|
-
400: { description: 'Bad Request' },
|
|
49762
|
-
401: { description: 'Unauthorized' },
|
|
49763
|
-
},
|
|
49764
|
-
security: [
|
|
49765
|
-
{ pat_with_workspace: [] },
|
|
49766
|
-
{ console_session_with_workspace: [] },
|
|
49767
|
-
{ api_key: [] },
|
|
49768
|
-
],
|
|
49769
|
-
summary: '/unstable_access_methods/delete',
|
|
49770
|
-
tags: [],
|
|
49771
|
-
'x-fern-sdk-group-name': ['unstable_access_methods'],
|
|
49772
|
-
'x-fern-sdk-method-name': 'delete',
|
|
49773
|
-
'x-response-key': null,
|
|
49774
|
-
'x-title': 'Delete an Access Method',
|
|
49775
|
-
'x-undocumented': 'Unreleased.',
|
|
49776
|
-
},
|
|
49777
|
-
},
|
|
49778
|
-
'/unstable_access_methods/get': {
|
|
49779
|
-
get: {
|
|
49780
|
-
description: 'Gets an access method.',
|
|
49781
|
-
operationId: 'unstableAccessMethodsGetGet',
|
|
49782
|
-
parameters: [
|
|
49783
|
-
{
|
|
49784
|
-
in: 'query',
|
|
49785
|
-
name: 'access_method_id',
|
|
49786
|
-
required: true,
|
|
49787
|
-
schema: {
|
|
49788
|
-
description: 'ID of the access method that you want to get.',
|
|
49789
|
-
format: 'uuid',
|
|
49790
|
-
type: 'string',
|
|
49791
|
-
},
|
|
49792
|
-
},
|
|
49793
|
-
],
|
|
49794
|
-
responses: {
|
|
49795
|
-
200: {
|
|
49796
|
-
content: {
|
|
49797
|
-
'application/json': {
|
|
49798
|
-
schema: {
|
|
49799
|
-
properties: {
|
|
49800
|
-
access_method: {
|
|
49801
|
-
$ref: '#/components/schemas/access_method',
|
|
49802
|
-
},
|
|
49803
|
-
ok: { type: 'boolean' },
|
|
49804
|
-
},
|
|
49805
|
-
required: ['access_method', 'ok'],
|
|
49806
|
-
type: 'object',
|
|
49807
|
-
},
|
|
49808
|
-
},
|
|
49809
|
-
},
|
|
49810
|
-
description: 'OK',
|
|
49811
|
-
},
|
|
49812
|
-
400: { description: 'Bad Request' },
|
|
49813
|
-
401: { description: 'Unauthorized' },
|
|
49814
|
-
},
|
|
49815
|
-
security: [
|
|
49816
|
-
{ pat_with_workspace: [] },
|
|
49817
|
-
{ console_session_with_workspace: [] },
|
|
49818
|
-
{ api_key: [] },
|
|
49819
|
-
],
|
|
49820
|
-
summary: '/unstable_access_methods/get',
|
|
49821
|
-
tags: [],
|
|
49822
|
-
'x-fern-sdk-group-name': ['unstable_access_methods'],
|
|
49823
|
-
'x-fern-sdk-method-name': 'get',
|
|
49824
|
-
'x-fern-sdk-return-value': 'access_method',
|
|
49825
|
-
'x-response-key': 'access_method',
|
|
49826
|
-
'x-title': 'Get an Access Method',
|
|
49827
|
-
'x-undocumented': 'Unreleased.',
|
|
49828
|
-
},
|
|
49829
|
-
post: {
|
|
49830
|
-
description: 'Gets an access method.',
|
|
49831
|
-
operationId: 'unstableAccessMethodsGetPost',
|
|
49832
|
-
requestBody: {
|
|
49833
|
-
content: {
|
|
49834
|
-
'application/json': {
|
|
49835
|
-
schema: {
|
|
49836
|
-
properties: {
|
|
49837
|
-
access_method_id: {
|
|
49838
|
-
description: 'ID of the access method that you want to get.',
|
|
49839
|
-
format: 'uuid',
|
|
49840
|
-
type: 'string',
|
|
49841
|
-
},
|
|
49842
|
-
},
|
|
49843
|
-
required: ['access_method_id'],
|
|
49844
|
-
type: 'object',
|
|
49845
|
-
},
|
|
49846
|
-
},
|
|
49847
|
-
},
|
|
49848
|
-
},
|
|
49849
|
-
responses: {
|
|
49850
|
-
200: {
|
|
49851
|
-
content: {
|
|
49852
|
-
'application/json': {
|
|
49853
|
-
schema: {
|
|
49854
|
-
properties: {
|
|
49855
|
-
access_method: {
|
|
49856
|
-
$ref: '#/components/schemas/access_method',
|
|
49857
|
-
},
|
|
49858
|
-
ok: { type: 'boolean' },
|
|
49859
|
-
},
|
|
49860
|
-
required: ['access_method', 'ok'],
|
|
49861
|
-
type: 'object',
|
|
49862
|
-
},
|
|
49863
|
-
},
|
|
49864
|
-
},
|
|
49865
|
-
description: 'OK',
|
|
49866
|
-
},
|
|
49867
|
-
400: { description: 'Bad Request' },
|
|
49868
|
-
401: { description: 'Unauthorized' },
|
|
49869
|
-
},
|
|
49870
|
-
security: [
|
|
49871
|
-
{ pat_with_workspace: [] },
|
|
49872
|
-
{ console_session_with_workspace: [] },
|
|
49873
|
-
{ api_key: [] },
|
|
49874
|
-
],
|
|
49875
|
-
summary: '/unstable_access_methods/get',
|
|
49876
|
-
tags: [],
|
|
49877
|
-
'x-fern-sdk-group-name': ['unstable_access_methods'],
|
|
49878
|
-
'x-fern-sdk-method-name': 'get',
|
|
49879
|
-
'x-fern-sdk-return-value': 'access_method',
|
|
49880
|
-
'x-response-key': 'access_method',
|
|
49881
|
-
'x-title': 'Get an Access Method',
|
|
49882
|
-
'x-undocumented': 'Unreleased.',
|
|
49883
|
-
},
|
|
49884
|
-
},
|
|
49885
|
-
'/unstable_access_methods/list': {
|
|
49886
|
-
get: {
|
|
49887
|
-
description: 'Lists all access methods, usually filtered by access grant.',
|
|
49888
|
-
operationId: 'unstableAccessMethodsListGet',
|
|
49889
|
-
parameters: [
|
|
49890
|
-
{
|
|
49891
|
-
in: 'query',
|
|
49892
|
-
name: 'access_grant_id',
|
|
49893
|
-
required: true,
|
|
49894
|
-
schema: {
|
|
49895
|
-
description: 'ID of the access grant by which to filter the list of access methods.',
|
|
49896
|
-
format: 'uuid',
|
|
49897
|
-
type: 'string',
|
|
49898
|
-
},
|
|
49899
|
-
},
|
|
49900
|
-
],
|
|
49901
|
-
responses: {
|
|
49902
|
-
200: {
|
|
49903
|
-
content: {
|
|
49904
|
-
'application/json': {
|
|
49905
|
-
schema: {
|
|
49906
|
-
properties: {
|
|
49907
|
-
access_methods: {
|
|
49908
|
-
items: { $ref: '#/components/schemas/access_method' },
|
|
49909
|
-
type: 'array',
|
|
49910
|
-
},
|
|
49911
|
-
ok: { type: 'boolean' },
|
|
49912
|
-
},
|
|
49913
|
-
required: ['access_methods', 'ok'],
|
|
49914
|
-
type: 'object',
|
|
49915
|
-
},
|
|
49916
|
-
},
|
|
49917
|
-
},
|
|
49918
|
-
description: 'OK',
|
|
49919
|
-
},
|
|
49920
|
-
400: { description: 'Bad Request' },
|
|
49921
|
-
401: { description: 'Unauthorized' },
|
|
49922
|
-
},
|
|
49923
|
-
security: [
|
|
49924
|
-
{ pat_with_workspace: [] },
|
|
49925
|
-
{ console_session_with_workspace: [] },
|
|
49926
|
-
{ api_key: [] },
|
|
49927
|
-
],
|
|
49928
|
-
summary: '/unstable_access_methods/list',
|
|
49929
|
-
tags: [],
|
|
49930
|
-
'x-fern-sdk-group-name': ['unstable_access_methods'],
|
|
49931
|
-
'x-fern-sdk-method-name': 'list',
|
|
49932
|
-
'x-fern-sdk-return-value': 'access_methods',
|
|
49933
|
-
'x-response-key': 'access_methods',
|
|
49934
|
-
'x-title': 'List Access Methods',
|
|
49935
|
-
'x-undocumented': 'Unreleased.',
|
|
49936
|
-
},
|
|
49937
|
-
post: {
|
|
49938
|
-
description: 'Lists all access methods, usually filtered by access grant.',
|
|
49939
|
-
operationId: 'unstableAccessMethodsListPost',
|
|
49940
|
-
requestBody: {
|
|
49941
|
-
content: {
|
|
49942
|
-
'application/json': {
|
|
49943
|
-
schema: {
|
|
49944
|
-
properties: {
|
|
49945
|
-
access_grant_id: {
|
|
49946
|
-
description: 'ID of the access grant by which to filter the list of access methods.',
|
|
49947
|
-
format: 'uuid',
|
|
49948
|
-
type: 'string',
|
|
49949
|
-
},
|
|
49950
|
-
},
|
|
49951
|
-
required: ['access_grant_id'],
|
|
49952
|
-
type: 'object',
|
|
49953
|
-
},
|
|
49954
|
-
},
|
|
49955
|
-
},
|
|
49956
|
-
},
|
|
49957
|
-
responses: {
|
|
49958
|
-
200: {
|
|
49959
|
-
content: {
|
|
49960
|
-
'application/json': {
|
|
49961
|
-
schema: {
|
|
49962
|
-
properties: {
|
|
49963
|
-
access_methods: {
|
|
49964
|
-
items: { $ref: '#/components/schemas/access_method' },
|
|
49965
|
-
type: 'array',
|
|
49966
|
-
},
|
|
49967
|
-
ok: { type: 'boolean' },
|
|
49968
|
-
},
|
|
49969
|
-
required: ['access_methods', 'ok'],
|
|
49970
|
-
type: 'object',
|
|
49971
|
-
},
|
|
49972
|
-
},
|
|
49973
|
-
},
|
|
49974
|
-
description: 'OK',
|
|
49975
|
-
},
|
|
49976
|
-
400: { description: 'Bad Request' },
|
|
49977
|
-
401: { description: 'Unauthorized' },
|
|
49978
|
-
},
|
|
49979
|
-
security: [
|
|
49980
|
-
{ pat_with_workspace: [] },
|
|
49981
|
-
{ console_session_with_workspace: [] },
|
|
49982
|
-
{ api_key: [] },
|
|
49983
|
-
],
|
|
49984
|
-
summary: '/unstable_access_methods/list',
|
|
49985
|
-
tags: [],
|
|
49986
|
-
'x-fern-sdk-group-name': ['unstable_access_methods'],
|
|
49987
|
-
'x-fern-sdk-method-name': 'list',
|
|
49988
|
-
'x-fern-sdk-return-value': 'access_methods',
|
|
49989
|
-
'x-response-key': 'access_methods',
|
|
49990
|
-
'x-title': 'List Access Methods',
|
|
49991
|
-
'x-undocumented': 'Unreleased.',
|
|
49992
|
-
},
|
|
49993
|
-
},
|
|
49994
49144
|
'/unstable_locations/add_acs_entrances': {
|
|
49995
49145
|
post: {
|
|
49996
49146
|
description: 'Adds [entrances](https://docs.seam.co/latest/capability-guides/access-systems/retrieving-entrance-details) to a specific location.',
|