@seamapi/types 1.468.0 → 1.470.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 +10 -872
- package/dist/connect.cjs.map +1 -1
- package/dist/connect.d.cts +450 -1856
- package/dist/index.cjs +10 -872
- package/dist/index.cjs.map +1 -1
- package/lib/seam/connect/models/devices/capability-properties/thermostat.js +0 -2
- package/lib/seam/connect/models/devices/capability-properties/thermostat.js.map +1 -1
- package/lib/seam/connect/models/thermostats/thermostat-program.js +0 -1
- package/lib/seam/connect/models/thermostats/thermostat-program.js.map +1 -1
- package/lib/seam/connect/openapi.d.ts +0 -1093
- package/lib/seam/connect/openapi.js +0 -859
- 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/devices/capability-properties/thermostat.ts +0 -2
- package/src/lib/seam/connect/models/thermostats/thermostat-program.ts +0 -1
- package/src/lib/seam/connect/openapi.ts +0 -885
- package/src/lib/seam/connect/route-types.ts +0 -318
|
@@ -12371,11 +12371,9 @@ export default {
|
|
|
12371
12371
|
],
|
|
12372
12372
|
type: 'object',
|
|
12373
12373
|
'x-route-path': '/thermostats/daily_programs',
|
|
12374
|
-
'x-undocumented': 'Unreleased.',
|
|
12375
12374
|
},
|
|
12376
12375
|
type: 'array',
|
|
12377
12376
|
'x-property-group-key': 'thermostats',
|
|
12378
|
-
'x-undocumented': 'Unreleased.',
|
|
12379
12377
|
},
|
|
12380
12378
|
thermostat_weekly_program: {
|
|
12381
12379
|
description:
|
|
@@ -12450,7 +12448,6 @@ export default {
|
|
|
12450
12448
|
],
|
|
12451
12449
|
type: 'object',
|
|
12452
12450
|
'x-property-group-key': 'thermostats',
|
|
12453
|
-
'x-undocumented': 'Unreleased.',
|
|
12454
12451
|
},
|
|
12455
12452
|
},
|
|
12456
12453
|
type: 'object',
|
|
@@ -20517,7 +20514,6 @@ export default {
|
|
|
20517
20514
|
],
|
|
20518
20515
|
type: 'object',
|
|
20519
20516
|
'x-route-path': '/thermostats/daily_programs',
|
|
20520
|
-
'x-undocumented': 'Unreleased.',
|
|
20521
20517
|
},
|
|
20522
20518
|
thermostat_schedule: {
|
|
20523
20519
|
description:
|
|
@@ -50335,7 +50331,6 @@ export default {
|
|
|
50335
50331
|
'x-fern-sdk-return-value': 'thermostat_daily_program',
|
|
50336
50332
|
'x-response-key': 'thermostat_daily_program',
|
|
50337
50333
|
'x-title': 'Create a Thermostat Daily Program',
|
|
50338
|
-
'x-undocumented': 'Unreleased.',
|
|
50339
50334
|
},
|
|
50340
50335
|
},
|
|
50341
50336
|
'/thermostats/daily_programs/delete': {
|
|
@@ -50383,7 +50378,6 @@ export default {
|
|
|
50383
50378
|
'x-fern-sdk-method-name': 'delete',
|
|
50384
50379
|
'x-response-key': null,
|
|
50385
50380
|
'x-title': 'Delete a Thermostat Daily Program',
|
|
50386
|
-
'x-undocumented': 'Unreleased.',
|
|
50387
50381
|
},
|
|
50388
50382
|
post: {
|
|
50389
50383
|
description: 'Deletes a thermostat daily program.',
|
|
@@ -50434,7 +50428,6 @@ export default {
|
|
|
50434
50428
|
'x-fern-sdk-method-name': 'delete',
|
|
50435
50429
|
'x-response-key': null,
|
|
50436
50430
|
'x-title': 'Delete a Thermostat Daily Program',
|
|
50437
|
-
'x-undocumented': 'Unreleased.',
|
|
50438
50431
|
},
|
|
50439
50432
|
},
|
|
50440
50433
|
'/thermostats/daily_programs/update': {
|
|
@@ -50524,7 +50517,6 @@ export default {
|
|
|
50524
50517
|
'x-fern-sdk-return-value': 'action_attempt',
|
|
50525
50518
|
'x-response-key': 'action_attempt',
|
|
50526
50519
|
'x-title': 'Update a Thermostat Daily Program',
|
|
50527
|
-
'x-undocumented': 'Unreleased.',
|
|
50528
50520
|
},
|
|
50529
50521
|
post: {
|
|
50530
50522
|
description:
|
|
@@ -50612,7 +50604,6 @@ export default {
|
|
|
50612
50604
|
'x-fern-sdk-return-value': 'action_attempt',
|
|
50613
50605
|
'x-response-key': 'action_attempt',
|
|
50614
50606
|
'x-title': 'Update a Thermostat Daily Program',
|
|
50615
|
-
'x-undocumented': 'Unreleased.',
|
|
50616
50607
|
},
|
|
50617
50608
|
},
|
|
50618
50609
|
'/thermostats/delete_climate_preset': {
|
|
@@ -53301,882 +53292,6 @@ export default {
|
|
|
53301
53292
|
'x-fern-sdk-return-value': 'action_attempt',
|
|
53302
53293
|
'x-response-key': 'action_attempt',
|
|
53303
53294
|
'x-title': 'Update the Thermostat Weekly Program',
|
|
53304
|
-
'x-undocumented': 'Unreleased.',
|
|
53305
|
-
},
|
|
53306
|
-
},
|
|
53307
|
-
'/unstable_access_grants/create': {
|
|
53308
|
-
post: {
|
|
53309
|
-
description: 'Creates a new access grant.',
|
|
53310
|
-
operationId: 'unstableAccessGrantsCreatePost',
|
|
53311
|
-
requestBody: {
|
|
53312
|
-
content: {
|
|
53313
|
-
'application/json': {
|
|
53314
|
-
schema: {
|
|
53315
|
-
allOf: [
|
|
53316
|
-
{
|
|
53317
|
-
oneOf: [
|
|
53318
|
-
{
|
|
53319
|
-
properties: {
|
|
53320
|
-
user_identity_id: {
|
|
53321
|
-
description:
|
|
53322
|
-
'ID of user identity for whom you want to grant access.',
|
|
53323
|
-
format: 'uuid',
|
|
53324
|
-
type: 'string',
|
|
53325
|
-
},
|
|
53326
|
-
},
|
|
53327
|
-
required: ['user_identity_id'],
|
|
53328
|
-
type: 'object',
|
|
53329
|
-
},
|
|
53330
|
-
{
|
|
53331
|
-
properties: {
|
|
53332
|
-
user_identity: {
|
|
53333
|
-
description:
|
|
53334
|
-
'User identity. When used, creates a new user identity with the specified details and grants them access.',
|
|
53335
|
-
properties: {
|
|
53336
|
-
email_address: {
|
|
53337
|
-
description:
|
|
53338
|
-
'Unique email address for the user identity.',
|
|
53339
|
-
format: 'email',
|
|
53340
|
-
nullable: true,
|
|
53341
|
-
type: 'string',
|
|
53342
|
-
},
|
|
53343
|
-
full_name: {
|
|
53344
|
-
minLength: 1,
|
|
53345
|
-
nullable: true,
|
|
53346
|
-
type: 'string',
|
|
53347
|
-
},
|
|
53348
|
-
phone_number: {
|
|
53349
|
-
description:
|
|
53350
|
-
'Unique phone number for the user identity in [E.164 format](https://www.itu.int/rec/T-REC-E.164/en) (for example, +15555550100).',
|
|
53351
|
-
nullable: true,
|
|
53352
|
-
type: 'string',
|
|
53353
|
-
},
|
|
53354
|
-
},
|
|
53355
|
-
type: 'object',
|
|
53356
|
-
},
|
|
53357
|
-
},
|
|
53358
|
-
required: ['user_identity'],
|
|
53359
|
-
type: 'object',
|
|
53360
|
-
},
|
|
53361
|
-
],
|
|
53362
|
-
},
|
|
53363
|
-
{
|
|
53364
|
-
properties: {
|
|
53365
|
-
acs_entrance_ids: {
|
|
53366
|
-
default: [],
|
|
53367
|
-
description:
|
|
53368
|
-
'IDs of the [entrances](https://docs.seam.co/latest/capability-guides/access-systems/retrieving-entrance-details) to which you want to grant access.',
|
|
53369
|
-
items: { format: 'uuid', type: 'string' },
|
|
53370
|
-
type: 'array',
|
|
53371
|
-
},
|
|
53372
|
-
device_ids: {
|
|
53373
|
-
default: [],
|
|
53374
|
-
description:
|
|
53375
|
-
'IDs of the devices to which you want to grant access.',
|
|
53376
|
-
items: { format: 'uuid', type: 'string' },
|
|
53377
|
-
type: 'array',
|
|
53378
|
-
},
|
|
53379
|
-
ends_at: {
|
|
53380
|
-
description:
|
|
53381
|
-
'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`.',
|
|
53382
|
-
format: 'date-time',
|
|
53383
|
-
type: 'string',
|
|
53384
|
-
},
|
|
53385
|
-
location: {
|
|
53386
|
-
description:
|
|
53387
|
-
'Location. When used, creates a new location with the specified entrances and devices, and gives the user access to this location.',
|
|
53388
|
-
properties: {
|
|
53389
|
-
acs_entrance_ids: {
|
|
53390
|
-
default: [],
|
|
53391
|
-
deprecated: true,
|
|
53392
|
-
items: { format: 'uuid', type: 'string' },
|
|
53393
|
-
type: 'array',
|
|
53394
|
-
'x-deprecated':
|
|
53395
|
-
'Use `acs_entrance_ids` at the top level.',
|
|
53396
|
-
},
|
|
53397
|
-
device_ids: {
|
|
53398
|
-
default: [],
|
|
53399
|
-
deprecated: true,
|
|
53400
|
-
items: { format: 'uuid', type: 'string' },
|
|
53401
|
-
type: 'array',
|
|
53402
|
-
'x-deprecated':
|
|
53403
|
-
'Use `device_ids` at the top level.',
|
|
53404
|
-
},
|
|
53405
|
-
name: {
|
|
53406
|
-
description: 'Name of the location.',
|
|
53407
|
-
type: 'string',
|
|
53408
|
-
},
|
|
53409
|
-
},
|
|
53410
|
-
type: 'object',
|
|
53411
|
-
},
|
|
53412
|
-
location_ids: {
|
|
53413
|
-
deprecated: true,
|
|
53414
|
-
items: { format: 'uuid', type: 'string' },
|
|
53415
|
-
type: 'array',
|
|
53416
|
-
'x-deprecated': 'Use `space_ids`.',
|
|
53417
|
-
},
|
|
53418
|
-
requested_access_methods: {
|
|
53419
|
-
items: {
|
|
53420
|
-
properties: {
|
|
53421
|
-
mode: {
|
|
53422
|
-
description: 'Access method mode.',
|
|
53423
|
-
enum: ['code', 'card', 'mobile_key'],
|
|
53424
|
-
type: 'string',
|
|
53425
|
-
},
|
|
53426
|
-
},
|
|
53427
|
-
required: ['mode'],
|
|
53428
|
-
type: 'object',
|
|
53429
|
-
},
|
|
53430
|
-
type: 'array',
|
|
53431
|
-
},
|
|
53432
|
-
space_ids: {
|
|
53433
|
-
description:
|
|
53434
|
-
'IDs of the existing spaces to which you want to grant access.',
|
|
53435
|
-
items: { format: 'uuid', type: 'string' },
|
|
53436
|
-
type: 'array',
|
|
53437
|
-
},
|
|
53438
|
-
starts_at: {
|
|
53439
|
-
description:
|
|
53440
|
-
'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.',
|
|
53441
|
-
format: 'date-time',
|
|
53442
|
-
type: 'string',
|
|
53443
|
-
},
|
|
53444
|
-
},
|
|
53445
|
-
required: ['requested_access_methods'],
|
|
53446
|
-
type: 'object',
|
|
53447
|
-
},
|
|
53448
|
-
],
|
|
53449
|
-
},
|
|
53450
|
-
},
|
|
53451
|
-
},
|
|
53452
|
-
},
|
|
53453
|
-
responses: {
|
|
53454
|
-
200: {
|
|
53455
|
-
content: {
|
|
53456
|
-
'application/json': {
|
|
53457
|
-
schema: {
|
|
53458
|
-
properties: {
|
|
53459
|
-
access_grant: { $ref: '#/components/schemas/access_grant' },
|
|
53460
|
-
ok: { type: 'boolean' },
|
|
53461
|
-
},
|
|
53462
|
-
required: ['access_grant', 'ok'],
|
|
53463
|
-
type: 'object',
|
|
53464
|
-
},
|
|
53465
|
-
},
|
|
53466
|
-
},
|
|
53467
|
-
description: 'OK',
|
|
53468
|
-
},
|
|
53469
|
-
400: { description: 'Bad Request' },
|
|
53470
|
-
401: { description: 'Unauthorized' },
|
|
53471
|
-
},
|
|
53472
|
-
security: [
|
|
53473
|
-
{ pat_with_workspace: [] },
|
|
53474
|
-
{ console_session_with_workspace: [] },
|
|
53475
|
-
{ api_key: [] },
|
|
53476
|
-
{ client_session_with_customer: [] },
|
|
53477
|
-
],
|
|
53478
|
-
summary: '/unstable_access_grants/create',
|
|
53479
|
-
tags: [],
|
|
53480
|
-
'x-fern-sdk-group-name': ['unstable_access_grants'],
|
|
53481
|
-
'x-fern-sdk-method-name': 'create',
|
|
53482
|
-
'x-fern-sdk-return-value': 'access_grant',
|
|
53483
|
-
'x-response-key': 'access_grant',
|
|
53484
|
-
'x-title': 'Create an Access Grant',
|
|
53485
|
-
'x-undocumented': 'Unreleased.',
|
|
53486
|
-
},
|
|
53487
|
-
},
|
|
53488
|
-
'/unstable_access_grants/delete': {
|
|
53489
|
-
delete: {
|
|
53490
|
-
description: 'Deletes an access grant.',
|
|
53491
|
-
operationId: 'unstableAccessGrantsDeleteDelete',
|
|
53492
|
-
parameters: [
|
|
53493
|
-
{
|
|
53494
|
-
in: 'query',
|
|
53495
|
-
name: 'access_grant_id',
|
|
53496
|
-
required: true,
|
|
53497
|
-
schema: {
|
|
53498
|
-
description: 'ID of access grant that you want to delete.',
|
|
53499
|
-
format: 'uuid',
|
|
53500
|
-
type: 'string',
|
|
53501
|
-
},
|
|
53502
|
-
},
|
|
53503
|
-
],
|
|
53504
|
-
responses: {
|
|
53505
|
-
200: {
|
|
53506
|
-
content: {
|
|
53507
|
-
'application/json': {
|
|
53508
|
-
schema: {
|
|
53509
|
-
properties: { ok: { type: 'boolean' } },
|
|
53510
|
-
required: ['ok'],
|
|
53511
|
-
type: 'object',
|
|
53512
|
-
},
|
|
53513
|
-
},
|
|
53514
|
-
},
|
|
53515
|
-
description: 'OK',
|
|
53516
|
-
},
|
|
53517
|
-
400: { description: 'Bad Request' },
|
|
53518
|
-
401: { description: 'Unauthorized' },
|
|
53519
|
-
},
|
|
53520
|
-
security: [
|
|
53521
|
-
{ pat_with_workspace: [] },
|
|
53522
|
-
{ console_session_with_workspace: [] },
|
|
53523
|
-
{ api_key: [] },
|
|
53524
|
-
{ client_session_with_customer: [] },
|
|
53525
|
-
],
|
|
53526
|
-
summary: '/unstable_access_grants/delete',
|
|
53527
|
-
tags: [],
|
|
53528
|
-
'x-fern-sdk-group-name': ['unstable_access_grants'],
|
|
53529
|
-
'x-fern-sdk-method-name': 'delete',
|
|
53530
|
-
'x-response-key': null,
|
|
53531
|
-
'x-title': 'Delete an Access Grant',
|
|
53532
|
-
'x-undocumented': 'Unreleased.',
|
|
53533
|
-
},
|
|
53534
|
-
post: {
|
|
53535
|
-
description: 'Deletes an access grant.',
|
|
53536
|
-
operationId: 'unstableAccessGrantsDeletePost',
|
|
53537
|
-
requestBody: {
|
|
53538
|
-
content: {
|
|
53539
|
-
'application/json': {
|
|
53540
|
-
schema: {
|
|
53541
|
-
properties: {
|
|
53542
|
-
access_grant_id: {
|
|
53543
|
-
description: 'ID of access grant that you want to delete.',
|
|
53544
|
-
format: 'uuid',
|
|
53545
|
-
type: 'string',
|
|
53546
|
-
},
|
|
53547
|
-
},
|
|
53548
|
-
required: ['access_grant_id'],
|
|
53549
|
-
type: 'object',
|
|
53550
|
-
},
|
|
53551
|
-
},
|
|
53552
|
-
},
|
|
53553
|
-
},
|
|
53554
|
-
responses: {
|
|
53555
|
-
200: {
|
|
53556
|
-
content: {
|
|
53557
|
-
'application/json': {
|
|
53558
|
-
schema: {
|
|
53559
|
-
properties: { ok: { type: 'boolean' } },
|
|
53560
|
-
required: ['ok'],
|
|
53561
|
-
type: 'object',
|
|
53562
|
-
},
|
|
53563
|
-
},
|
|
53564
|
-
},
|
|
53565
|
-
description: 'OK',
|
|
53566
|
-
},
|
|
53567
|
-
400: { description: 'Bad Request' },
|
|
53568
|
-
401: { description: 'Unauthorized' },
|
|
53569
|
-
},
|
|
53570
|
-
security: [
|
|
53571
|
-
{ pat_with_workspace: [] },
|
|
53572
|
-
{ console_session_with_workspace: [] },
|
|
53573
|
-
{ api_key: [] },
|
|
53574
|
-
{ client_session_with_customer: [] },
|
|
53575
|
-
],
|
|
53576
|
-
summary: '/unstable_access_grants/delete',
|
|
53577
|
-
tags: [],
|
|
53578
|
-
'x-fern-sdk-group-name': ['unstable_access_grants'],
|
|
53579
|
-
'x-fern-sdk-method-name': 'delete',
|
|
53580
|
-
'x-response-key': null,
|
|
53581
|
-
'x-title': 'Delete an Access Grant',
|
|
53582
|
-
'x-undocumented': 'Unreleased.',
|
|
53583
|
-
},
|
|
53584
|
-
},
|
|
53585
|
-
'/unstable_access_grants/get': {
|
|
53586
|
-
get: {
|
|
53587
|
-
description: 'Gets an access grant.',
|
|
53588
|
-
operationId: 'unstableAccessGrantsGetGet',
|
|
53589
|
-
parameters: [
|
|
53590
|
-
{
|
|
53591
|
-
in: 'query',
|
|
53592
|
-
name: 'access_grant_id',
|
|
53593
|
-
required: true,
|
|
53594
|
-
schema: {
|
|
53595
|
-
description: 'ID of access grant that you want to get.',
|
|
53596
|
-
format: 'uuid',
|
|
53597
|
-
type: 'string',
|
|
53598
|
-
},
|
|
53599
|
-
},
|
|
53600
|
-
],
|
|
53601
|
-
responses: {
|
|
53602
|
-
200: {
|
|
53603
|
-
content: {
|
|
53604
|
-
'application/json': {
|
|
53605
|
-
schema: {
|
|
53606
|
-
properties: {
|
|
53607
|
-
access_grant: { $ref: '#/components/schemas/access_grant' },
|
|
53608
|
-
ok: { type: 'boolean' },
|
|
53609
|
-
},
|
|
53610
|
-
required: ['access_grant', 'ok'],
|
|
53611
|
-
type: 'object',
|
|
53612
|
-
},
|
|
53613
|
-
},
|
|
53614
|
-
},
|
|
53615
|
-
description: 'OK',
|
|
53616
|
-
},
|
|
53617
|
-
400: { description: 'Bad Request' },
|
|
53618
|
-
401: { description: 'Unauthorized' },
|
|
53619
|
-
},
|
|
53620
|
-
security: [
|
|
53621
|
-
{ pat_with_workspace: [] },
|
|
53622
|
-
{ console_session_with_workspace: [] },
|
|
53623
|
-
{ api_key: [] },
|
|
53624
|
-
{ client_session_with_customer: [] },
|
|
53625
|
-
],
|
|
53626
|
-
summary: '/unstable_access_grants/get',
|
|
53627
|
-
tags: [],
|
|
53628
|
-
'x-fern-sdk-group-name': ['unstable_access_grants'],
|
|
53629
|
-
'x-fern-sdk-method-name': 'get',
|
|
53630
|
-
'x-fern-sdk-return-value': 'access_grant',
|
|
53631
|
-
'x-response-key': 'access_grant',
|
|
53632
|
-
'x-title': 'Get an Access Grant',
|
|
53633
|
-
'x-undocumented': 'Unreleased.',
|
|
53634
|
-
},
|
|
53635
|
-
post: {
|
|
53636
|
-
description: 'Gets an access grant.',
|
|
53637
|
-
operationId: 'unstableAccessGrantsGetPost',
|
|
53638
|
-
requestBody: {
|
|
53639
|
-
content: {
|
|
53640
|
-
'application/json': {
|
|
53641
|
-
schema: {
|
|
53642
|
-
properties: {
|
|
53643
|
-
access_grant_id: {
|
|
53644
|
-
description: 'ID of access grant that you want to get.',
|
|
53645
|
-
format: 'uuid',
|
|
53646
|
-
type: 'string',
|
|
53647
|
-
},
|
|
53648
|
-
},
|
|
53649
|
-
required: ['access_grant_id'],
|
|
53650
|
-
type: 'object',
|
|
53651
|
-
},
|
|
53652
|
-
},
|
|
53653
|
-
},
|
|
53654
|
-
},
|
|
53655
|
-
responses: {
|
|
53656
|
-
200: {
|
|
53657
|
-
content: {
|
|
53658
|
-
'application/json': {
|
|
53659
|
-
schema: {
|
|
53660
|
-
properties: {
|
|
53661
|
-
access_grant: { $ref: '#/components/schemas/access_grant' },
|
|
53662
|
-
ok: { type: 'boolean' },
|
|
53663
|
-
},
|
|
53664
|
-
required: ['access_grant', 'ok'],
|
|
53665
|
-
type: 'object',
|
|
53666
|
-
},
|
|
53667
|
-
},
|
|
53668
|
-
},
|
|
53669
|
-
description: 'OK',
|
|
53670
|
-
},
|
|
53671
|
-
400: { description: 'Bad Request' },
|
|
53672
|
-
401: { description: 'Unauthorized' },
|
|
53673
|
-
},
|
|
53674
|
-
security: [
|
|
53675
|
-
{ pat_with_workspace: [] },
|
|
53676
|
-
{ console_session_with_workspace: [] },
|
|
53677
|
-
{ api_key: [] },
|
|
53678
|
-
{ client_session_with_customer: [] },
|
|
53679
|
-
],
|
|
53680
|
-
summary: '/unstable_access_grants/get',
|
|
53681
|
-
tags: [],
|
|
53682
|
-
'x-fern-sdk-group-name': ['unstable_access_grants'],
|
|
53683
|
-
'x-fern-sdk-method-name': 'get',
|
|
53684
|
-
'x-fern-sdk-return-value': 'access_grant',
|
|
53685
|
-
'x-response-key': 'access_grant',
|
|
53686
|
-
'x-title': 'Get an Access Grant',
|
|
53687
|
-
'x-undocumented': 'Unreleased.',
|
|
53688
|
-
},
|
|
53689
|
-
},
|
|
53690
|
-
'/unstable_access_grants/list': {
|
|
53691
|
-
get: {
|
|
53692
|
-
description: 'Returns a list of all access grants.',
|
|
53693
|
-
operationId: 'unstableAccessGrantsListGet',
|
|
53694
|
-
parameters: [
|
|
53695
|
-
{
|
|
53696
|
-
in: 'query',
|
|
53697
|
-
name: 'user_identity_id',
|
|
53698
|
-
schema: {
|
|
53699
|
-
description:
|
|
53700
|
-
'ID of the user identity by which you want to filter the list of access grants.',
|
|
53701
|
-
format: 'uuid',
|
|
53702
|
-
type: 'string',
|
|
53703
|
-
},
|
|
53704
|
-
},
|
|
53705
|
-
{
|
|
53706
|
-
in: 'query',
|
|
53707
|
-
name: 'acs_system_id',
|
|
53708
|
-
schema: {
|
|
53709
|
-
description:
|
|
53710
|
-
'ID of the access system by which you want to filter the list of access grants.',
|
|
53711
|
-
format: 'uuid',
|
|
53712
|
-
type: 'string',
|
|
53713
|
-
},
|
|
53714
|
-
},
|
|
53715
|
-
{
|
|
53716
|
-
in: 'query',
|
|
53717
|
-
name: 'acs_entrance_id',
|
|
53718
|
-
schema: {
|
|
53719
|
-
description:
|
|
53720
|
-
'ID of the entrance by which you want to filter the list of access grants.',
|
|
53721
|
-
format: 'uuid',
|
|
53722
|
-
type: 'string',
|
|
53723
|
-
},
|
|
53724
|
-
},
|
|
53725
|
-
{
|
|
53726
|
-
in: 'query',
|
|
53727
|
-
name: 'location_id',
|
|
53728
|
-
schema: {
|
|
53729
|
-
deprecated: true,
|
|
53730
|
-
format: 'uuid',
|
|
53731
|
-
type: 'string',
|
|
53732
|
-
'x-deprecated': 'Use `space_id`.',
|
|
53733
|
-
},
|
|
53734
|
-
},
|
|
53735
|
-
{
|
|
53736
|
-
in: 'query',
|
|
53737
|
-
name: 'space_id',
|
|
53738
|
-
schema: {
|
|
53739
|
-
description:
|
|
53740
|
-
'ID of the space by which you want to filter the list of access grants.',
|
|
53741
|
-
format: 'uuid',
|
|
53742
|
-
type: 'string',
|
|
53743
|
-
},
|
|
53744
|
-
},
|
|
53745
|
-
],
|
|
53746
|
-
responses: {
|
|
53747
|
-
200: {
|
|
53748
|
-
content: {
|
|
53749
|
-
'application/json': {
|
|
53750
|
-
schema: {
|
|
53751
|
-
properties: {
|
|
53752
|
-
access_grants: {
|
|
53753
|
-
items: { $ref: '#/components/schemas/access_grant' },
|
|
53754
|
-
type: 'array',
|
|
53755
|
-
},
|
|
53756
|
-
ok: { type: 'boolean' },
|
|
53757
|
-
},
|
|
53758
|
-
required: ['access_grants', 'ok'],
|
|
53759
|
-
type: 'object',
|
|
53760
|
-
},
|
|
53761
|
-
},
|
|
53762
|
-
},
|
|
53763
|
-
description: 'OK',
|
|
53764
|
-
},
|
|
53765
|
-
400: { description: 'Bad Request' },
|
|
53766
|
-
401: { description: 'Unauthorized' },
|
|
53767
|
-
},
|
|
53768
|
-
security: [
|
|
53769
|
-
{ pat_with_workspace: [] },
|
|
53770
|
-
{ console_session_with_workspace: [] },
|
|
53771
|
-
{ api_key: [] },
|
|
53772
|
-
{ client_session_with_customer: [] },
|
|
53773
|
-
],
|
|
53774
|
-
summary: '/unstable_access_grants/list',
|
|
53775
|
-
tags: [],
|
|
53776
|
-
'x-fern-sdk-group-name': ['unstable_access_grants'],
|
|
53777
|
-
'x-fern-sdk-method-name': 'list',
|
|
53778
|
-
'x-fern-sdk-return-value': 'access_grants',
|
|
53779
|
-
'x-response-key': 'access_grants',
|
|
53780
|
-
'x-title': 'List Access Grants',
|
|
53781
|
-
'x-undocumented': 'Unreleased.',
|
|
53782
|
-
},
|
|
53783
|
-
post: {
|
|
53784
|
-
description: 'Returns a list of all access grants.',
|
|
53785
|
-
operationId: 'unstableAccessGrantsListPost',
|
|
53786
|
-
requestBody: {
|
|
53787
|
-
content: {
|
|
53788
|
-
'application/json': {
|
|
53789
|
-
schema: {
|
|
53790
|
-
properties: {
|
|
53791
|
-
acs_entrance_id: {
|
|
53792
|
-
description:
|
|
53793
|
-
'ID of the entrance by which you want to filter the list of access grants.',
|
|
53794
|
-
format: 'uuid',
|
|
53795
|
-
type: 'string',
|
|
53796
|
-
},
|
|
53797
|
-
acs_system_id: {
|
|
53798
|
-
description:
|
|
53799
|
-
'ID of the access system by which you want to filter the list of access grants.',
|
|
53800
|
-
format: 'uuid',
|
|
53801
|
-
type: 'string',
|
|
53802
|
-
},
|
|
53803
|
-
location_id: {
|
|
53804
|
-
deprecated: true,
|
|
53805
|
-
format: 'uuid',
|
|
53806
|
-
type: 'string',
|
|
53807
|
-
'x-deprecated': 'Use `space_id`.',
|
|
53808
|
-
},
|
|
53809
|
-
space_id: {
|
|
53810
|
-
description:
|
|
53811
|
-
'ID of the space by which you want to filter the list of access grants.',
|
|
53812
|
-
format: 'uuid',
|
|
53813
|
-
type: 'string',
|
|
53814
|
-
},
|
|
53815
|
-
user_identity_id: {
|
|
53816
|
-
description:
|
|
53817
|
-
'ID of the user identity by which you want to filter the list of access grants.',
|
|
53818
|
-
format: 'uuid',
|
|
53819
|
-
type: 'string',
|
|
53820
|
-
},
|
|
53821
|
-
},
|
|
53822
|
-
type: 'object',
|
|
53823
|
-
},
|
|
53824
|
-
},
|
|
53825
|
-
},
|
|
53826
|
-
},
|
|
53827
|
-
responses: {
|
|
53828
|
-
200: {
|
|
53829
|
-
content: {
|
|
53830
|
-
'application/json': {
|
|
53831
|
-
schema: {
|
|
53832
|
-
properties: {
|
|
53833
|
-
access_grants: {
|
|
53834
|
-
items: { $ref: '#/components/schemas/access_grant' },
|
|
53835
|
-
type: 'array',
|
|
53836
|
-
},
|
|
53837
|
-
ok: { type: 'boolean' },
|
|
53838
|
-
},
|
|
53839
|
-
required: ['access_grants', 'ok'],
|
|
53840
|
-
type: 'object',
|
|
53841
|
-
},
|
|
53842
|
-
},
|
|
53843
|
-
},
|
|
53844
|
-
description: 'OK',
|
|
53845
|
-
},
|
|
53846
|
-
400: { description: 'Bad Request' },
|
|
53847
|
-
401: { description: 'Unauthorized' },
|
|
53848
|
-
},
|
|
53849
|
-
security: [
|
|
53850
|
-
{ pat_with_workspace: [] },
|
|
53851
|
-
{ console_session_with_workspace: [] },
|
|
53852
|
-
{ api_key: [] },
|
|
53853
|
-
{ client_session_with_customer: [] },
|
|
53854
|
-
],
|
|
53855
|
-
summary: '/unstable_access_grants/list',
|
|
53856
|
-
tags: [],
|
|
53857
|
-
'x-fern-sdk-group-name': ['unstable_access_grants'],
|
|
53858
|
-
'x-fern-sdk-method-name': 'list',
|
|
53859
|
-
'x-fern-sdk-return-value': 'access_grants',
|
|
53860
|
-
'x-response-key': 'access_grants',
|
|
53861
|
-
'x-title': 'List Access Grants',
|
|
53862
|
-
'x-undocumented': 'Unreleased.',
|
|
53863
|
-
},
|
|
53864
|
-
},
|
|
53865
|
-
'/unstable_access_methods/delete': {
|
|
53866
|
-
delete: {
|
|
53867
|
-
description: 'Deletes an access method.',
|
|
53868
|
-
operationId: 'unstableAccessMethodsDeleteDelete',
|
|
53869
|
-
parameters: [
|
|
53870
|
-
{
|
|
53871
|
-
in: 'query',
|
|
53872
|
-
name: 'access_method_id',
|
|
53873
|
-
required: true,
|
|
53874
|
-
schema: {
|
|
53875
|
-
description: 'ID of the access method that you want to delete.',
|
|
53876
|
-
format: 'uuid',
|
|
53877
|
-
type: 'string',
|
|
53878
|
-
},
|
|
53879
|
-
},
|
|
53880
|
-
],
|
|
53881
|
-
responses: {
|
|
53882
|
-
200: {
|
|
53883
|
-
content: {
|
|
53884
|
-
'application/json': {
|
|
53885
|
-
schema: {
|
|
53886
|
-
properties: { ok: { type: 'boolean' } },
|
|
53887
|
-
required: ['ok'],
|
|
53888
|
-
type: 'object',
|
|
53889
|
-
},
|
|
53890
|
-
},
|
|
53891
|
-
},
|
|
53892
|
-
description: 'OK',
|
|
53893
|
-
},
|
|
53894
|
-
400: { description: 'Bad Request' },
|
|
53895
|
-
401: { description: 'Unauthorized' },
|
|
53896
|
-
},
|
|
53897
|
-
security: [
|
|
53898
|
-
{ pat_with_workspace: [] },
|
|
53899
|
-
{ console_session_with_workspace: [] },
|
|
53900
|
-
{ api_key: [] },
|
|
53901
|
-
],
|
|
53902
|
-
summary: '/unstable_access_methods/delete',
|
|
53903
|
-
tags: [],
|
|
53904
|
-
'x-fern-sdk-group-name': ['unstable_access_methods'],
|
|
53905
|
-
'x-fern-sdk-method-name': 'delete',
|
|
53906
|
-
'x-response-key': null,
|
|
53907
|
-
'x-title': 'Delete an Access Method',
|
|
53908
|
-
'x-undocumented': 'Unreleased.',
|
|
53909
|
-
},
|
|
53910
|
-
post: {
|
|
53911
|
-
description: 'Deletes an access method.',
|
|
53912
|
-
operationId: 'unstableAccessMethodsDeletePost',
|
|
53913
|
-
requestBody: {
|
|
53914
|
-
content: {
|
|
53915
|
-
'application/json': {
|
|
53916
|
-
schema: {
|
|
53917
|
-
properties: {
|
|
53918
|
-
access_method_id: {
|
|
53919
|
-
description:
|
|
53920
|
-
'ID of the access method that you want to delete.',
|
|
53921
|
-
format: 'uuid',
|
|
53922
|
-
type: 'string',
|
|
53923
|
-
},
|
|
53924
|
-
},
|
|
53925
|
-
required: ['access_method_id'],
|
|
53926
|
-
type: 'object',
|
|
53927
|
-
},
|
|
53928
|
-
},
|
|
53929
|
-
},
|
|
53930
|
-
},
|
|
53931
|
-
responses: {
|
|
53932
|
-
200: {
|
|
53933
|
-
content: {
|
|
53934
|
-
'application/json': {
|
|
53935
|
-
schema: {
|
|
53936
|
-
properties: { ok: { type: 'boolean' } },
|
|
53937
|
-
required: ['ok'],
|
|
53938
|
-
type: 'object',
|
|
53939
|
-
},
|
|
53940
|
-
},
|
|
53941
|
-
},
|
|
53942
|
-
description: 'OK',
|
|
53943
|
-
},
|
|
53944
|
-
400: { description: 'Bad Request' },
|
|
53945
|
-
401: { description: 'Unauthorized' },
|
|
53946
|
-
},
|
|
53947
|
-
security: [
|
|
53948
|
-
{ pat_with_workspace: [] },
|
|
53949
|
-
{ console_session_with_workspace: [] },
|
|
53950
|
-
{ api_key: [] },
|
|
53951
|
-
],
|
|
53952
|
-
summary: '/unstable_access_methods/delete',
|
|
53953
|
-
tags: [],
|
|
53954
|
-
'x-fern-sdk-group-name': ['unstable_access_methods'],
|
|
53955
|
-
'x-fern-sdk-method-name': 'delete',
|
|
53956
|
-
'x-response-key': null,
|
|
53957
|
-
'x-title': 'Delete an Access Method',
|
|
53958
|
-
'x-undocumented': 'Unreleased.',
|
|
53959
|
-
},
|
|
53960
|
-
},
|
|
53961
|
-
'/unstable_access_methods/get': {
|
|
53962
|
-
get: {
|
|
53963
|
-
description: 'Gets an access method.',
|
|
53964
|
-
operationId: 'unstableAccessMethodsGetGet',
|
|
53965
|
-
parameters: [
|
|
53966
|
-
{
|
|
53967
|
-
in: 'query',
|
|
53968
|
-
name: 'access_method_id',
|
|
53969
|
-
required: true,
|
|
53970
|
-
schema: {
|
|
53971
|
-
description: 'ID of the access method that you want to get.',
|
|
53972
|
-
format: 'uuid',
|
|
53973
|
-
type: 'string',
|
|
53974
|
-
},
|
|
53975
|
-
},
|
|
53976
|
-
],
|
|
53977
|
-
responses: {
|
|
53978
|
-
200: {
|
|
53979
|
-
content: {
|
|
53980
|
-
'application/json': {
|
|
53981
|
-
schema: {
|
|
53982
|
-
properties: {
|
|
53983
|
-
access_method: {
|
|
53984
|
-
$ref: '#/components/schemas/access_method',
|
|
53985
|
-
},
|
|
53986
|
-
ok: { type: 'boolean' },
|
|
53987
|
-
},
|
|
53988
|
-
required: ['access_method', 'ok'],
|
|
53989
|
-
type: 'object',
|
|
53990
|
-
},
|
|
53991
|
-
},
|
|
53992
|
-
},
|
|
53993
|
-
description: 'OK',
|
|
53994
|
-
},
|
|
53995
|
-
400: { description: 'Bad Request' },
|
|
53996
|
-
401: { description: 'Unauthorized' },
|
|
53997
|
-
},
|
|
53998
|
-
security: [
|
|
53999
|
-
{ pat_with_workspace: [] },
|
|
54000
|
-
{ console_session_with_workspace: [] },
|
|
54001
|
-
{ api_key: [] },
|
|
54002
|
-
],
|
|
54003
|
-
summary: '/unstable_access_methods/get',
|
|
54004
|
-
tags: [],
|
|
54005
|
-
'x-fern-sdk-group-name': ['unstable_access_methods'],
|
|
54006
|
-
'x-fern-sdk-method-name': 'get',
|
|
54007
|
-
'x-fern-sdk-return-value': 'access_method',
|
|
54008
|
-
'x-response-key': 'access_method',
|
|
54009
|
-
'x-title': 'Get an Access Method',
|
|
54010
|
-
'x-undocumented': 'Unreleased.',
|
|
54011
|
-
},
|
|
54012
|
-
post: {
|
|
54013
|
-
description: 'Gets an access method.',
|
|
54014
|
-
operationId: 'unstableAccessMethodsGetPost',
|
|
54015
|
-
requestBody: {
|
|
54016
|
-
content: {
|
|
54017
|
-
'application/json': {
|
|
54018
|
-
schema: {
|
|
54019
|
-
properties: {
|
|
54020
|
-
access_method_id: {
|
|
54021
|
-
description:
|
|
54022
|
-
'ID of the access method that you want to get.',
|
|
54023
|
-
format: 'uuid',
|
|
54024
|
-
type: 'string',
|
|
54025
|
-
},
|
|
54026
|
-
},
|
|
54027
|
-
required: ['access_method_id'],
|
|
54028
|
-
type: 'object',
|
|
54029
|
-
},
|
|
54030
|
-
},
|
|
54031
|
-
},
|
|
54032
|
-
},
|
|
54033
|
-
responses: {
|
|
54034
|
-
200: {
|
|
54035
|
-
content: {
|
|
54036
|
-
'application/json': {
|
|
54037
|
-
schema: {
|
|
54038
|
-
properties: {
|
|
54039
|
-
access_method: {
|
|
54040
|
-
$ref: '#/components/schemas/access_method',
|
|
54041
|
-
},
|
|
54042
|
-
ok: { type: 'boolean' },
|
|
54043
|
-
},
|
|
54044
|
-
required: ['access_method', 'ok'],
|
|
54045
|
-
type: 'object',
|
|
54046
|
-
},
|
|
54047
|
-
},
|
|
54048
|
-
},
|
|
54049
|
-
description: 'OK',
|
|
54050
|
-
},
|
|
54051
|
-
400: { description: 'Bad Request' },
|
|
54052
|
-
401: { description: 'Unauthorized' },
|
|
54053
|
-
},
|
|
54054
|
-
security: [
|
|
54055
|
-
{ pat_with_workspace: [] },
|
|
54056
|
-
{ console_session_with_workspace: [] },
|
|
54057
|
-
{ api_key: [] },
|
|
54058
|
-
],
|
|
54059
|
-
summary: '/unstable_access_methods/get',
|
|
54060
|
-
tags: [],
|
|
54061
|
-
'x-fern-sdk-group-name': ['unstable_access_methods'],
|
|
54062
|
-
'x-fern-sdk-method-name': 'get',
|
|
54063
|
-
'x-fern-sdk-return-value': 'access_method',
|
|
54064
|
-
'x-response-key': 'access_method',
|
|
54065
|
-
'x-title': 'Get an Access Method',
|
|
54066
|
-
'x-undocumented': 'Unreleased.',
|
|
54067
|
-
},
|
|
54068
|
-
},
|
|
54069
|
-
'/unstable_access_methods/list': {
|
|
54070
|
-
get: {
|
|
54071
|
-
description:
|
|
54072
|
-
'Lists all access methods, usually filtered by access grant.',
|
|
54073
|
-
operationId: 'unstableAccessMethodsListGet',
|
|
54074
|
-
parameters: [
|
|
54075
|
-
{
|
|
54076
|
-
in: 'query',
|
|
54077
|
-
name: 'access_grant_id',
|
|
54078
|
-
required: true,
|
|
54079
|
-
schema: {
|
|
54080
|
-
description:
|
|
54081
|
-
'ID of the access grant by which to filter the list of access methods.',
|
|
54082
|
-
format: 'uuid',
|
|
54083
|
-
type: 'string',
|
|
54084
|
-
},
|
|
54085
|
-
},
|
|
54086
|
-
],
|
|
54087
|
-
responses: {
|
|
54088
|
-
200: {
|
|
54089
|
-
content: {
|
|
54090
|
-
'application/json': {
|
|
54091
|
-
schema: {
|
|
54092
|
-
properties: {
|
|
54093
|
-
access_methods: {
|
|
54094
|
-
items: { $ref: '#/components/schemas/access_method' },
|
|
54095
|
-
type: 'array',
|
|
54096
|
-
},
|
|
54097
|
-
ok: { type: 'boolean' },
|
|
54098
|
-
},
|
|
54099
|
-
required: ['access_methods', 'ok'],
|
|
54100
|
-
type: 'object',
|
|
54101
|
-
},
|
|
54102
|
-
},
|
|
54103
|
-
},
|
|
54104
|
-
description: 'OK',
|
|
54105
|
-
},
|
|
54106
|
-
400: { description: 'Bad Request' },
|
|
54107
|
-
401: { description: 'Unauthorized' },
|
|
54108
|
-
},
|
|
54109
|
-
security: [
|
|
54110
|
-
{ pat_with_workspace: [] },
|
|
54111
|
-
{ console_session_with_workspace: [] },
|
|
54112
|
-
{ api_key: [] },
|
|
54113
|
-
],
|
|
54114
|
-
summary: '/unstable_access_methods/list',
|
|
54115
|
-
tags: [],
|
|
54116
|
-
'x-fern-sdk-group-name': ['unstable_access_methods'],
|
|
54117
|
-
'x-fern-sdk-method-name': 'list',
|
|
54118
|
-
'x-fern-sdk-return-value': 'access_methods',
|
|
54119
|
-
'x-response-key': 'access_methods',
|
|
54120
|
-
'x-title': 'List Access Methods',
|
|
54121
|
-
'x-undocumented': 'Unreleased.',
|
|
54122
|
-
},
|
|
54123
|
-
post: {
|
|
54124
|
-
description:
|
|
54125
|
-
'Lists all access methods, usually filtered by access grant.',
|
|
54126
|
-
operationId: 'unstableAccessMethodsListPost',
|
|
54127
|
-
requestBody: {
|
|
54128
|
-
content: {
|
|
54129
|
-
'application/json': {
|
|
54130
|
-
schema: {
|
|
54131
|
-
properties: {
|
|
54132
|
-
access_grant_id: {
|
|
54133
|
-
description:
|
|
54134
|
-
'ID of the access grant by which to filter the list of access methods.',
|
|
54135
|
-
format: 'uuid',
|
|
54136
|
-
type: 'string',
|
|
54137
|
-
},
|
|
54138
|
-
},
|
|
54139
|
-
required: ['access_grant_id'],
|
|
54140
|
-
type: 'object',
|
|
54141
|
-
},
|
|
54142
|
-
},
|
|
54143
|
-
},
|
|
54144
|
-
},
|
|
54145
|
-
responses: {
|
|
54146
|
-
200: {
|
|
54147
|
-
content: {
|
|
54148
|
-
'application/json': {
|
|
54149
|
-
schema: {
|
|
54150
|
-
properties: {
|
|
54151
|
-
access_methods: {
|
|
54152
|
-
items: { $ref: '#/components/schemas/access_method' },
|
|
54153
|
-
type: 'array',
|
|
54154
|
-
},
|
|
54155
|
-
ok: { type: 'boolean' },
|
|
54156
|
-
},
|
|
54157
|
-
required: ['access_methods', 'ok'],
|
|
54158
|
-
type: 'object',
|
|
54159
|
-
},
|
|
54160
|
-
},
|
|
54161
|
-
},
|
|
54162
|
-
description: 'OK',
|
|
54163
|
-
},
|
|
54164
|
-
400: { description: 'Bad Request' },
|
|
54165
|
-
401: { description: 'Unauthorized' },
|
|
54166
|
-
},
|
|
54167
|
-
security: [
|
|
54168
|
-
{ pat_with_workspace: [] },
|
|
54169
|
-
{ console_session_with_workspace: [] },
|
|
54170
|
-
{ api_key: [] },
|
|
54171
|
-
],
|
|
54172
|
-
summary: '/unstable_access_methods/list',
|
|
54173
|
-
tags: [],
|
|
54174
|
-
'x-fern-sdk-group-name': ['unstable_access_methods'],
|
|
54175
|
-
'x-fern-sdk-method-name': 'list',
|
|
54176
|
-
'x-fern-sdk-return-value': 'access_methods',
|
|
54177
|
-
'x-response-key': 'access_methods',
|
|
54178
|
-
'x-title': 'List Access Methods',
|
|
54179
|
-
'x-undocumented': 'Unreleased.',
|
|
54180
53295
|
},
|
|
54181
53296
|
},
|
|
54182
53297
|
'/unstable_locations/add_acs_entrances': {
|