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