@seamapi/types 1.379.1 → 1.380.1
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 +408 -36
- package/dist/connect.cjs.map +1 -1
- package/dist/connect.d.cts +573 -86
- package/lib/seam/connect/models/access-grants/access-grant.d.ts +8 -13
- package/lib/seam/connect/models/access-grants/access-grant.js +4 -4
- package/lib/seam/connect/models/access-grants/access-grant.js.map +1 -1
- package/lib/seam/connect/models/access-grants/access-method.d.ts +6 -3
- package/lib/seam/connect/models/access-grants/access-method.js +4 -2
- package/lib/seam/connect/models/access-grants/access-method.js.map +1 -1
- package/lib/seam/connect/models/access-grants/requested-access-method.d.ts +18 -0
- package/lib/seam/connect/models/access-grants/requested-access-method.js +19 -0
- package/lib/seam/connect/models/access-grants/requested-access-method.js.map +1 -0
- package/lib/seam/connect/models/devices/capability-properties/index.d.ts +5 -5
- package/lib/seam/connect/models/devices/capability-properties/thermostat.d.ts +5 -5
- package/lib/seam/connect/models/devices/device-metadata.d.ts +0 -5
- package/lib/seam/connect/models/devices/device-metadata.js +0 -1
- package/lib/seam/connect/models/devices/device-metadata.js.map +1 -1
- package/lib/seam/connect/models/devices/device.d.ts +7 -14
- package/lib/seam/connect/models/devices/unmanaged-device.d.ts +5 -10
- package/lib/seam/connect/models/thermostats/thermostat-schedule.d.ts +3 -3
- package/lib/seam/connect/models/thermostats/thermostat-schedule.js +2 -0
- package/lib/seam/connect/models/thermostats/thermostat-schedule.js.map +1 -1
- package/lib/seam/connect/openapi.d.ts +421 -17
- package/lib/seam/connect/openapi.js +406 -33
- package/lib/seam/connect/openapi.js.map +1 -1
- package/lib/seam/connect/route-types.d.ts +137 -42
- package/package.json +1 -1
- package/src/lib/seam/connect/models/access-grants/access-grant.ts +4 -4
- package/src/lib/seam/connect/models/access-grants/access-method.ts +6 -2
- package/src/lib/seam/connect/models/access-grants/requested-access-method.ts +25 -0
- package/src/lib/seam/connect/models/devices/device-metadata.ts +0 -1
- package/src/lib/seam/connect/models/thermostats/thermostat-schedule.ts +2 -0
- package/src/lib/seam/connect/openapi.ts +434 -35
- package/src/lib/seam/connect/route-types.ts +142 -49
package/dist/connect.cjs
CHANGED
|
@@ -161,7 +161,7 @@ var thermostat_schedule = zod.z.object({
|
|
|
161
161
|
climate_preset_key: zod.z.string().describe(
|
|
162
162
|
"Key of the [climate preset](https://docs.seam.co/latest/capability-guides/thermostats/creating-and-managing-climate-presets) to use for the [thermostat schedule](https://docs.seam.co/latest/capability-guides/thermostats/creating-and-managing-thermostat-schedules)."
|
|
163
163
|
),
|
|
164
|
-
max_override_period_minutes: zod.z.number().int().nonnegative().describe(
|
|
164
|
+
max_override_period_minutes: zod.z.number().int().nonnegative().nullable().optional().describe(
|
|
165
165
|
"Number of minutes for which a person at the thermostat can change the thermostat's settings after the activation of the scheduled [climate preset](https://docs.seam.co/latest/capability-guides/thermostats/creating-and-managing-climate-presets). See also [Specifying Manual Override Permissions](https://docs.seam.co/latest/capability-guides/thermostats/creating-and-managing-thermostat-schedules#specifying-manual-override-permissions)."
|
|
166
166
|
),
|
|
167
167
|
starts_at: zod.z.string().datetime().describe(
|
|
@@ -618,7 +618,6 @@ var device_metadata = zod.z.object({
|
|
|
618
618
|
schlage_metadata: zod.z.object({
|
|
619
619
|
device_id: zod.z.string(),
|
|
620
620
|
device_name: zod.z.string(),
|
|
621
|
-
access_code_length: zod.z.number().nullable(),
|
|
622
621
|
model: zod.z.string().optional()
|
|
623
622
|
}),
|
|
624
623
|
smartthings_metadata: zod.z.object({
|
|
@@ -11431,20 +11430,11 @@ var openapi_default = {
|
|
|
11431
11430
|
},
|
|
11432
11431
|
schlage_metadata: {
|
|
11433
11432
|
properties: {
|
|
11434
|
-
access_code_length: {
|
|
11435
|
-
format: "float",
|
|
11436
|
-
nullable: true,
|
|
11437
|
-
type: "number"
|
|
11438
|
-
},
|
|
11439
11433
|
device_id: { type: "string" },
|
|
11440
11434
|
device_name: { type: "string" },
|
|
11441
11435
|
model: { type: "string" }
|
|
11442
11436
|
},
|
|
11443
|
-
required: [
|
|
11444
|
-
"device_id",
|
|
11445
|
-
"device_name",
|
|
11446
|
-
"access_code_length"
|
|
11447
|
-
],
|
|
11437
|
+
required: ["device_id", "device_name"],
|
|
11448
11438
|
type: "object"
|
|
11449
11439
|
},
|
|
11450
11440
|
seam_bridge_metadata: {
|
|
@@ -11716,6 +11706,7 @@ var openapi_default = {
|
|
|
11716
11706
|
max_override_period_minutes: {
|
|
11717
11707
|
description: "Number of minutes for which a person at the thermostat can change the thermostat's settings after the activation of the scheduled [climate preset](https://docs.seam.co/latest/capability-guides/thermostats/creating-and-managing-climate-presets). See also [Specifying Manual Override Permissions](https://docs.seam.co/latest/capability-guides/thermostats/creating-and-managing-thermostat-schedules#specifying-manual-override-permissions).",
|
|
11718
11708
|
minimum: 0,
|
|
11709
|
+
nullable: true,
|
|
11719
11710
|
type: "integer"
|
|
11720
11711
|
},
|
|
11721
11712
|
name: {
|
|
@@ -11742,7 +11733,6 @@ var openapi_default = {
|
|
|
11742
11733
|
"thermostat_schedule_id",
|
|
11743
11734
|
"device_id",
|
|
11744
11735
|
"climate_preset_key",
|
|
11745
|
-
"max_override_period_minutes",
|
|
11746
11736
|
"starts_at",
|
|
11747
11737
|
"ends_at",
|
|
11748
11738
|
"created_at",
|
|
@@ -16915,6 +16905,7 @@ var openapi_default = {
|
|
|
16915
16905
|
max_override_period_minutes: {
|
|
16916
16906
|
description: "Number of minutes for which a person at the thermostat can change the thermostat's settings after the activation of the scheduled [climate preset](https://docs.seam.co/latest/capability-guides/thermostats/creating-and-managing-climate-presets). See also [Specifying Manual Override Permissions](https://docs.seam.co/latest/capability-guides/thermostats/creating-and-managing-thermostat-schedules#specifying-manual-override-permissions).",
|
|
16917
16907
|
minimum: 0,
|
|
16908
|
+
nullable: true,
|
|
16918
16909
|
type: "integer"
|
|
16919
16910
|
},
|
|
16920
16911
|
name: {
|
|
@@ -16941,7 +16932,6 @@ var openapi_default = {
|
|
|
16941
16932
|
"thermostat_schedule_id",
|
|
16942
16933
|
"device_id",
|
|
16943
16934
|
"climate_preset_key",
|
|
16944
|
-
"max_override_period_minutes",
|
|
16945
16935
|
"starts_at",
|
|
16946
16936
|
"ends_at",
|
|
16947
16937
|
"created_at",
|
|
@@ -31066,9 +31056,10 @@ var openapi_default = {
|
|
|
31066
31056
|
type: "boolean"
|
|
31067
31057
|
},
|
|
31068
31058
|
max_override_period_minutes: {
|
|
31069
|
-
default:
|
|
31059
|
+
default: null,
|
|
31070
31060
|
description: "Number of minutes for which a person at the thermostat or using the API can change the thermostat's settings after the activation of the scheduled climate preset. See also [Specifying Manual Override Permissions](https://docs.seam.co/latest/capability-guides/thermostats/creating-and-managing-thermostat-schedules#specifying-manual-override-permissions).",
|
|
31071
31061
|
minimum: 0,
|
|
31062
|
+
nullable: true,
|
|
31072
31063
|
type: "integer"
|
|
31073
31064
|
},
|
|
31074
31065
|
name: {
|
|
@@ -31323,6 +31314,7 @@ var openapi_default = {
|
|
|
31323
31314
|
max_override_period_minutes: {
|
|
31324
31315
|
description: "Number of minutes for which a person at the thermostat or using the API can change the thermostat's settings after the activation of the scheduled climate preset. See also [Specifying Manual Override Permissions](https://docs.seam.co/latest/capability-guides/thermostats/creating-and-managing-thermostat-schedules#specifying-manual-override-permissions).",
|
|
31325
31316
|
minimum: 0,
|
|
31317
|
+
nullable: true,
|
|
31326
31318
|
type: "integer"
|
|
31327
31319
|
},
|
|
31328
31320
|
name: {
|
|
@@ -31396,6 +31388,7 @@ var openapi_default = {
|
|
|
31396
31388
|
max_override_period_minutes: {
|
|
31397
31389
|
description: "Number of minutes for which a person at the thermostat or using the API can change the thermostat's settings after the activation of the scheduled climate preset. See also [Specifying Manual Override Permissions](https://docs.seam.co/latest/capability-guides/thermostats/creating-and-managing-thermostat-schedules#specifying-manual-override-permissions).",
|
|
31398
31390
|
minimum: 0,
|
|
31391
|
+
nullable: true,
|
|
31399
31392
|
type: "integer"
|
|
31400
31393
|
},
|
|
31401
31394
|
name: {
|
|
@@ -32294,6 +32287,7 @@ var openapi_default = {
|
|
|
32294
32287
|
type: "string"
|
|
32295
32288
|
}
|
|
32296
32289
|
},
|
|
32290
|
+
required: ["user_identity_id"],
|
|
32297
32291
|
type: "object"
|
|
32298
32292
|
},
|
|
32299
32293
|
{
|
|
@@ -32318,10 +32312,10 @@ var openapi_default = {
|
|
|
32318
32312
|
type: "string"
|
|
32319
32313
|
}
|
|
32320
32314
|
},
|
|
32321
|
-
type: "object"
|
|
32322
|
-
"x-route-path": "/user_identities"
|
|
32315
|
+
type: "object"
|
|
32323
32316
|
}
|
|
32324
32317
|
},
|
|
32318
|
+
required: ["user_identity"],
|
|
32325
32319
|
type: "object"
|
|
32326
32320
|
}
|
|
32327
32321
|
]
|
|
@@ -32397,16 +32391,26 @@ var openapi_default = {
|
|
|
32397
32391
|
format: "uuid",
|
|
32398
32392
|
type: "string"
|
|
32399
32393
|
},
|
|
32400
|
-
|
|
32401
|
-
description: "
|
|
32394
|
+
created_at: {
|
|
32395
|
+
description: "Date and time at which the access grant was created.",
|
|
32396
|
+
format: "date-time",
|
|
32397
|
+
type: "string"
|
|
32398
|
+
},
|
|
32399
|
+
display_name: {
|
|
32400
|
+
description: "Display name of the access grant.",
|
|
32401
|
+
type: "string"
|
|
32402
|
+
},
|
|
32403
|
+
location_ids: {
|
|
32404
|
+
description: "IDs of the locations to which access is being given.",
|
|
32405
|
+
items: { format: "uuid", type: "string" },
|
|
32406
|
+
type: "array"
|
|
32407
|
+
},
|
|
32408
|
+
requested_access_methods: {
|
|
32409
|
+
description: "Access methods that the user requested for this access grant.",
|
|
32402
32410
|
items: {
|
|
32403
32411
|
properties: {
|
|
32404
|
-
access_method_key: {
|
|
32405
|
-
description: "Key for the access method - unique within an access grant.",
|
|
32406
|
-
type: "string"
|
|
32407
|
-
},
|
|
32408
32412
|
created_at: {
|
|
32409
|
-
description: "Date and time at which the access method was
|
|
32413
|
+
description: "Date and time at which the requested access method was added to this access grant.",
|
|
32410
32414
|
format: "date-time",
|
|
32411
32415
|
type: "string"
|
|
32412
32416
|
},
|
|
@@ -32414,30 +32418,112 @@ var openapi_default = {
|
|
|
32414
32418
|
description: "Display name of the access method.",
|
|
32415
32419
|
type: "string"
|
|
32416
32420
|
},
|
|
32417
|
-
issued_at: {
|
|
32418
|
-
description: "Date and time at which the access method was issued.",
|
|
32419
|
-
format: "date-time",
|
|
32420
|
-
nullable: true,
|
|
32421
|
-
type: "string"
|
|
32422
|
-
},
|
|
32423
32421
|
mode: {
|
|
32424
32422
|
description: "Access method mode. Supported values: `code`, `card`, `mobile_key`.",
|
|
32425
32423
|
enum: ["code", "card", "mobile_key"],
|
|
32426
32424
|
type: "string"
|
|
32425
|
+
},
|
|
32426
|
+
provisioned_access_method_ids: {
|
|
32427
|
+
description: "IDs of the locations to which access is being given.",
|
|
32428
|
+
items: { format: "uuid", type: "string" },
|
|
32429
|
+
type: "array"
|
|
32427
32430
|
}
|
|
32428
32431
|
},
|
|
32429
32432
|
required: [
|
|
32430
|
-
"access_method_key",
|
|
32431
32433
|
"display_name",
|
|
32432
32434
|
"mode",
|
|
32433
32435
|
"created_at",
|
|
32434
|
-
"
|
|
32436
|
+
"provisioned_access_method_ids"
|
|
32435
32437
|
],
|
|
32436
32438
|
type: "object",
|
|
32437
32439
|
"x-undocumented": "Unreleased."
|
|
32438
32440
|
},
|
|
32439
32441
|
type: "array"
|
|
32440
32442
|
},
|
|
32443
|
+
user_identity_id: {
|
|
32444
|
+
description: "ID of user identity to which access is being granted.",
|
|
32445
|
+
format: "uuid",
|
|
32446
|
+
type: "string"
|
|
32447
|
+
},
|
|
32448
|
+
workspace_id: {
|
|
32449
|
+
description: "Unique identifier for the Seam workspace associated with the access grant.",
|
|
32450
|
+
format: "uuid",
|
|
32451
|
+
type: "string"
|
|
32452
|
+
}
|
|
32453
|
+
},
|
|
32454
|
+
required: [
|
|
32455
|
+
"workspace_id",
|
|
32456
|
+
"access_grant_id",
|
|
32457
|
+
"user_identity_id",
|
|
32458
|
+
"location_ids",
|
|
32459
|
+
"requested_access_methods",
|
|
32460
|
+
"display_name",
|
|
32461
|
+
"created_at"
|
|
32462
|
+
],
|
|
32463
|
+
type: "object",
|
|
32464
|
+
"x-undocumented": "Unreleased."
|
|
32465
|
+
},
|
|
32466
|
+
ok: { type: "boolean" }
|
|
32467
|
+
},
|
|
32468
|
+
required: ["access_grant", "ok"],
|
|
32469
|
+
type: "object"
|
|
32470
|
+
}
|
|
32471
|
+
}
|
|
32472
|
+
},
|
|
32473
|
+
description: "OK"
|
|
32474
|
+
},
|
|
32475
|
+
400: { description: "Bad Request" },
|
|
32476
|
+
401: { description: "Unauthorized" }
|
|
32477
|
+
},
|
|
32478
|
+
security: [
|
|
32479
|
+
{ pat_with_workspace: [] },
|
|
32480
|
+
{ console_session_with_workspace: [] },
|
|
32481
|
+
{ api_key: [] }
|
|
32482
|
+
],
|
|
32483
|
+
summary: "/unstable_access_grants/create",
|
|
32484
|
+
tags: [],
|
|
32485
|
+
"x-fern-sdk-group-name": ["unstable_access_grants"],
|
|
32486
|
+
"x-fern-sdk-method-name": "create",
|
|
32487
|
+
"x-fern-sdk-return-value": "access_grant",
|
|
32488
|
+
"x-response-key": "access_grant",
|
|
32489
|
+
"x-title": "Create an Access Grant",
|
|
32490
|
+
"x-undocumented": "Unreleased."
|
|
32491
|
+
}
|
|
32492
|
+
},
|
|
32493
|
+
"/unstable_access_grants/get": {
|
|
32494
|
+
post: {
|
|
32495
|
+
description: "Get an access grant.",
|
|
32496
|
+
operationId: "unstableAccessGrantsGetPost",
|
|
32497
|
+
requestBody: {
|
|
32498
|
+
content: {
|
|
32499
|
+
"application/json": {
|
|
32500
|
+
schema: {
|
|
32501
|
+
properties: {
|
|
32502
|
+
access_grant_id: {
|
|
32503
|
+
description: "ID of access grant to get.",
|
|
32504
|
+
format: "uuid",
|
|
32505
|
+
type: "string"
|
|
32506
|
+
}
|
|
32507
|
+
},
|
|
32508
|
+
required: ["access_grant_id"],
|
|
32509
|
+
type: "object"
|
|
32510
|
+
}
|
|
32511
|
+
}
|
|
32512
|
+
}
|
|
32513
|
+
},
|
|
32514
|
+
responses: {
|
|
32515
|
+
200: {
|
|
32516
|
+
content: {
|
|
32517
|
+
"application/json": {
|
|
32518
|
+
schema: {
|
|
32519
|
+
properties: {
|
|
32520
|
+
access_grant: {
|
|
32521
|
+
properties: {
|
|
32522
|
+
access_grant_id: {
|
|
32523
|
+
description: "ID of the access grant.",
|
|
32524
|
+
format: "uuid",
|
|
32525
|
+
type: "string"
|
|
32526
|
+
},
|
|
32441
32527
|
created_at: {
|
|
32442
32528
|
description: "Date and time at which the access grant was created.",
|
|
32443
32529
|
format: "date-time",
|
|
@@ -32452,6 +32538,41 @@ var openapi_default = {
|
|
|
32452
32538
|
items: { format: "uuid", type: "string" },
|
|
32453
32539
|
type: "array"
|
|
32454
32540
|
},
|
|
32541
|
+
requested_access_methods: {
|
|
32542
|
+
description: "Access methods that the user requested for this access grant.",
|
|
32543
|
+
items: {
|
|
32544
|
+
properties: {
|
|
32545
|
+
created_at: {
|
|
32546
|
+
description: "Date and time at which the requested access method was added to this access grant.",
|
|
32547
|
+
format: "date-time",
|
|
32548
|
+
type: "string"
|
|
32549
|
+
},
|
|
32550
|
+
display_name: {
|
|
32551
|
+
description: "Display name of the access method.",
|
|
32552
|
+
type: "string"
|
|
32553
|
+
},
|
|
32554
|
+
mode: {
|
|
32555
|
+
description: "Access method mode. Supported values: `code`, `card`, `mobile_key`.",
|
|
32556
|
+
enum: ["code", "card", "mobile_key"],
|
|
32557
|
+
type: "string"
|
|
32558
|
+
},
|
|
32559
|
+
provisioned_access_method_ids: {
|
|
32560
|
+
description: "IDs of the locations to which access is being given.",
|
|
32561
|
+
items: { format: "uuid", type: "string" },
|
|
32562
|
+
type: "array"
|
|
32563
|
+
}
|
|
32564
|
+
},
|
|
32565
|
+
required: [
|
|
32566
|
+
"display_name",
|
|
32567
|
+
"mode",
|
|
32568
|
+
"created_at",
|
|
32569
|
+
"provisioned_access_method_ids"
|
|
32570
|
+
],
|
|
32571
|
+
type: "object",
|
|
32572
|
+
"x-undocumented": "Unreleased."
|
|
32573
|
+
},
|
|
32574
|
+
type: "array"
|
|
32575
|
+
},
|
|
32455
32576
|
user_identity_id: {
|
|
32456
32577
|
description: "ID of user identity to which access is being granted.",
|
|
32457
32578
|
format: "uuid",
|
|
@@ -32468,7 +32589,7 @@ var openapi_default = {
|
|
|
32468
32589
|
"access_grant_id",
|
|
32469
32590
|
"user_identity_id",
|
|
32470
32591
|
"location_ids",
|
|
32471
|
-
"
|
|
32592
|
+
"requested_access_methods",
|
|
32472
32593
|
"display_name",
|
|
32473
32594
|
"created_at"
|
|
32474
32595
|
],
|
|
@@ -32492,13 +32613,264 @@ var openapi_default = {
|
|
|
32492
32613
|
{ console_session_with_workspace: [] },
|
|
32493
32614
|
{ api_key: [] }
|
|
32494
32615
|
],
|
|
32495
|
-
summary: "/unstable_access_grants/
|
|
32616
|
+
summary: "/unstable_access_grants/get",
|
|
32496
32617
|
tags: [],
|
|
32497
32618
|
"x-fern-sdk-group-name": ["unstable_access_grants"],
|
|
32498
|
-
"x-fern-sdk-method-name": "
|
|
32619
|
+
"x-fern-sdk-method-name": "get",
|
|
32499
32620
|
"x-fern-sdk-return-value": "access_grant",
|
|
32500
32621
|
"x-response-key": "access_grant",
|
|
32501
|
-
"x-title": "
|
|
32622
|
+
"x-title": "Get an Access Grant",
|
|
32623
|
+
"x-undocumented": "Unreleased."
|
|
32624
|
+
}
|
|
32625
|
+
},
|
|
32626
|
+
"/unstable_access_grants/list": {
|
|
32627
|
+
post: {
|
|
32628
|
+
description: "Get an access grant.",
|
|
32629
|
+
operationId: "unstableAccessGrantsListPost",
|
|
32630
|
+
requestBody: {
|
|
32631
|
+
content: {
|
|
32632
|
+
"application/json": {
|
|
32633
|
+
schema: {
|
|
32634
|
+
properties: {
|
|
32635
|
+
acs_entrance_id: {
|
|
32636
|
+
description: "ID of entrance to filter list of access grants by.",
|
|
32637
|
+
format: "uuid",
|
|
32638
|
+
type: "string"
|
|
32639
|
+
},
|
|
32640
|
+
acs_system_id: {
|
|
32641
|
+
description: "ID of system to filter list of access grants by.",
|
|
32642
|
+
format: "uuid",
|
|
32643
|
+
type: "string"
|
|
32644
|
+
},
|
|
32645
|
+
location_id: {
|
|
32646
|
+
description: "ID of location to filter list of access grants by.",
|
|
32647
|
+
format: "uuid",
|
|
32648
|
+
type: "string"
|
|
32649
|
+
},
|
|
32650
|
+
user_identity_id: {
|
|
32651
|
+
description: "ID of user identity to filter list of access grants by.",
|
|
32652
|
+
format: "uuid",
|
|
32653
|
+
type: "string"
|
|
32654
|
+
}
|
|
32655
|
+
},
|
|
32656
|
+
type: "object"
|
|
32657
|
+
}
|
|
32658
|
+
}
|
|
32659
|
+
}
|
|
32660
|
+
},
|
|
32661
|
+
responses: {
|
|
32662
|
+
200: {
|
|
32663
|
+
content: {
|
|
32664
|
+
"application/json": {
|
|
32665
|
+
schema: {
|
|
32666
|
+
properties: {
|
|
32667
|
+
access_grants: {
|
|
32668
|
+
items: {
|
|
32669
|
+
properties: {
|
|
32670
|
+
access_grant_id: {
|
|
32671
|
+
description: "ID of the access grant.",
|
|
32672
|
+
format: "uuid",
|
|
32673
|
+
type: "string"
|
|
32674
|
+
},
|
|
32675
|
+
created_at: {
|
|
32676
|
+
description: "Date and time at which the access grant was created.",
|
|
32677
|
+
format: "date-time",
|
|
32678
|
+
type: "string"
|
|
32679
|
+
},
|
|
32680
|
+
display_name: {
|
|
32681
|
+
description: "Display name of the access grant.",
|
|
32682
|
+
type: "string"
|
|
32683
|
+
},
|
|
32684
|
+
location_ids: {
|
|
32685
|
+
description: "IDs of the locations to which access is being given.",
|
|
32686
|
+
items: { format: "uuid", type: "string" },
|
|
32687
|
+
type: "array"
|
|
32688
|
+
},
|
|
32689
|
+
requested_access_methods: {
|
|
32690
|
+
description: "Access methods that the user requested for this access grant.",
|
|
32691
|
+
items: {
|
|
32692
|
+
properties: {
|
|
32693
|
+
created_at: {
|
|
32694
|
+
description: "Date and time at which the requested access method was added to this access grant.",
|
|
32695
|
+
format: "date-time",
|
|
32696
|
+
type: "string"
|
|
32697
|
+
},
|
|
32698
|
+
display_name: {
|
|
32699
|
+
description: "Display name of the access method.",
|
|
32700
|
+
type: "string"
|
|
32701
|
+
},
|
|
32702
|
+
mode: {
|
|
32703
|
+
description: "Access method mode. Supported values: `code`, `card`, `mobile_key`.",
|
|
32704
|
+
enum: ["code", "card", "mobile_key"],
|
|
32705
|
+
type: "string"
|
|
32706
|
+
},
|
|
32707
|
+
provisioned_access_method_ids: {
|
|
32708
|
+
description: "IDs of the locations to which access is being given.",
|
|
32709
|
+
items: { format: "uuid", type: "string" },
|
|
32710
|
+
type: "array"
|
|
32711
|
+
}
|
|
32712
|
+
},
|
|
32713
|
+
required: [
|
|
32714
|
+
"display_name",
|
|
32715
|
+
"mode",
|
|
32716
|
+
"created_at",
|
|
32717
|
+
"provisioned_access_method_ids"
|
|
32718
|
+
],
|
|
32719
|
+
type: "object",
|
|
32720
|
+
"x-undocumented": "Unreleased."
|
|
32721
|
+
},
|
|
32722
|
+
type: "array"
|
|
32723
|
+
},
|
|
32724
|
+
user_identity_id: {
|
|
32725
|
+
description: "ID of user identity to which access is being granted.",
|
|
32726
|
+
format: "uuid",
|
|
32727
|
+
type: "string"
|
|
32728
|
+
},
|
|
32729
|
+
workspace_id: {
|
|
32730
|
+
description: "Unique identifier for the Seam workspace associated with the access grant.",
|
|
32731
|
+
format: "uuid",
|
|
32732
|
+
type: "string"
|
|
32733
|
+
}
|
|
32734
|
+
},
|
|
32735
|
+
required: [
|
|
32736
|
+
"workspace_id",
|
|
32737
|
+
"access_grant_id",
|
|
32738
|
+
"user_identity_id",
|
|
32739
|
+
"location_ids",
|
|
32740
|
+
"requested_access_methods",
|
|
32741
|
+
"display_name",
|
|
32742
|
+
"created_at"
|
|
32743
|
+
],
|
|
32744
|
+
type: "object",
|
|
32745
|
+
"x-undocumented": "Unreleased."
|
|
32746
|
+
},
|
|
32747
|
+
type: "array"
|
|
32748
|
+
},
|
|
32749
|
+
ok: { type: "boolean" }
|
|
32750
|
+
},
|
|
32751
|
+
required: ["access_grants", "ok"],
|
|
32752
|
+
type: "object"
|
|
32753
|
+
}
|
|
32754
|
+
}
|
|
32755
|
+
},
|
|
32756
|
+
description: "OK"
|
|
32757
|
+
},
|
|
32758
|
+
400: { description: "Bad Request" },
|
|
32759
|
+
401: { description: "Unauthorized" }
|
|
32760
|
+
},
|
|
32761
|
+
security: [
|
|
32762
|
+
{ pat_with_workspace: [] },
|
|
32763
|
+
{ console_session_with_workspace: [] },
|
|
32764
|
+
{ api_key: [] }
|
|
32765
|
+
],
|
|
32766
|
+
summary: "/unstable_access_grants/list",
|
|
32767
|
+
tags: [],
|
|
32768
|
+
"x-fern-sdk-group-name": ["unstable_access_grants"],
|
|
32769
|
+
"x-fern-sdk-method-name": "list",
|
|
32770
|
+
"x-fern-sdk-return-value": "access_grants",
|
|
32771
|
+
"x-response-key": "access_grants",
|
|
32772
|
+
"x-title": "List Access Grants",
|
|
32773
|
+
"x-undocumented": "Unreleased."
|
|
32774
|
+
}
|
|
32775
|
+
},
|
|
32776
|
+
"/unstable_access_grants/list_access_methods": {
|
|
32777
|
+
post: {
|
|
32778
|
+
description: "List all access methods for an access grant.",
|
|
32779
|
+
operationId: "unstableAccessGrantsListAccessMethodsPost",
|
|
32780
|
+
requestBody: {
|
|
32781
|
+
content: {
|
|
32782
|
+
"application/json": {
|
|
32783
|
+
schema: {
|
|
32784
|
+
properties: {
|
|
32785
|
+
access_grant_id: {
|
|
32786
|
+
description: "ID of access grant to list access methods for.",
|
|
32787
|
+
format: "uuid",
|
|
32788
|
+
type: "string"
|
|
32789
|
+
}
|
|
32790
|
+
},
|
|
32791
|
+
required: ["access_grant_id"],
|
|
32792
|
+
type: "object"
|
|
32793
|
+
}
|
|
32794
|
+
}
|
|
32795
|
+
}
|
|
32796
|
+
},
|
|
32797
|
+
responses: {
|
|
32798
|
+
200: {
|
|
32799
|
+
content: {
|
|
32800
|
+
"application/json": {
|
|
32801
|
+
schema: {
|
|
32802
|
+
properties: {
|
|
32803
|
+
access_methods: {
|
|
32804
|
+
items: {
|
|
32805
|
+
properties: {
|
|
32806
|
+
access_method_id: {
|
|
32807
|
+
description: "ID of the access method.",
|
|
32808
|
+
format: "uuid",
|
|
32809
|
+
type: "string"
|
|
32810
|
+
},
|
|
32811
|
+
created_at: {
|
|
32812
|
+
description: "Date and time at which the access method was created.",
|
|
32813
|
+
format: "date-time",
|
|
32814
|
+
type: "string"
|
|
32815
|
+
},
|
|
32816
|
+
display_name: {
|
|
32817
|
+
description: "Display name of the access method.",
|
|
32818
|
+
type: "string"
|
|
32819
|
+
},
|
|
32820
|
+
issued_at: {
|
|
32821
|
+
description: "Date and time at which the access method was issued.",
|
|
32822
|
+
format: "date-time",
|
|
32823
|
+
nullable: true,
|
|
32824
|
+
type: "string"
|
|
32825
|
+
},
|
|
32826
|
+
mode: {
|
|
32827
|
+
description: "Access method mode. Supported values: `code`, `card`, `mobile_key`.",
|
|
32828
|
+
enum: ["code", "card", "mobile_key"],
|
|
32829
|
+
type: "string"
|
|
32830
|
+
},
|
|
32831
|
+
workspace_id: {
|
|
32832
|
+
description: "Unique identifier for the Seam workspace associated with the access grant.",
|
|
32833
|
+
format: "uuid",
|
|
32834
|
+
type: "string"
|
|
32835
|
+
}
|
|
32836
|
+
},
|
|
32837
|
+
required: [
|
|
32838
|
+
"workspace_id",
|
|
32839
|
+
"access_method_id",
|
|
32840
|
+
"display_name",
|
|
32841
|
+
"mode",
|
|
32842
|
+
"created_at",
|
|
32843
|
+
"issued_at"
|
|
32844
|
+
],
|
|
32845
|
+
type: "object",
|
|
32846
|
+
"x-undocumented": "Unreleased."
|
|
32847
|
+
},
|
|
32848
|
+
type: "array"
|
|
32849
|
+
},
|
|
32850
|
+
ok: { type: "boolean" }
|
|
32851
|
+
},
|
|
32852
|
+
required: ["access_methods", "ok"],
|
|
32853
|
+
type: "object"
|
|
32854
|
+
}
|
|
32855
|
+
}
|
|
32856
|
+
},
|
|
32857
|
+
description: "OK"
|
|
32858
|
+
},
|
|
32859
|
+
400: { description: "Bad Request" },
|
|
32860
|
+
401: { description: "Unauthorized" }
|
|
32861
|
+
},
|
|
32862
|
+
security: [
|
|
32863
|
+
{ pat_with_workspace: [] },
|
|
32864
|
+
{ console_session_with_workspace: [] },
|
|
32865
|
+
{ api_key: [] }
|
|
32866
|
+
],
|
|
32867
|
+
summary: "/unstable_access_grants/list_access_methods",
|
|
32868
|
+
tags: [],
|
|
32869
|
+
"x-fern-sdk-group-name": ["unstable_access_grants"],
|
|
32870
|
+
"x-fern-sdk-method-name": "list_access_methods",
|
|
32871
|
+
"x-fern-sdk-return-value": "access_methods",
|
|
32872
|
+
"x-response-key": "access_methods",
|
|
32873
|
+
"x-title": "Get the Access Methods for an Access Grant",
|
|
32502
32874
|
"x-undocumented": "Unreleased."
|
|
32503
32875
|
}
|
|
32504
32876
|
},
|