@seamapi/types 1.383.0 → 1.385.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 +548 -137
- package/dist/connect.cjs.map +1 -1
- package/dist/connect.d.cts +2068 -451
- package/lib/seam/connect/internal/schemas.d.ts +1 -1
- package/lib/seam/connect/internal/schemas.js +1 -1
- package/lib/seam/connect/internal/schemas.js.map +1 -1
- package/lib/seam/connect/model-types.d.ts +1 -1
- package/lib/seam/connect/models/access-grants/access-grant.d.ts +8 -5
- package/lib/seam/connect/models/access-grants/access-grant.js +3 -0
- package/lib/seam/connect/models/access-grants/access-grant.js.map +1 -1
- package/lib/seam/connect/models/access-grants/requested-access-method.d.ts +3 -3
- package/lib/seam/connect/models/access-grants/requested-access-method.js +2 -2
- package/lib/seam/connect/models/access-grants/requested-access-method.js.map +1 -1
- package/lib/seam/connect/models/action-attempts/action-attempt.d.ts +156 -0
- package/lib/seam/connect/models/action-attempts/action-attempt.js +4 -0
- package/lib/seam/connect/models/action-attempts/action-attempt.js.map +1 -1
- package/lib/seam/connect/models/action-attempts/simulate-keypad-code-entry.d.ts +80 -0
- package/lib/seam/connect/models/action-attempts/simulate-keypad-code-entry.js +28 -0
- package/lib/seam/connect/models/action-attempts/simulate-keypad-code-entry.js.map +1 -0
- package/lib/seam/connect/models/action-attempts/simulate-manual-lock-via-keypad.d.ts +80 -0
- package/lib/seam/connect/models/action-attempts/simulate-manual-lock-via-keypad.js +28 -0
- package/lib/seam/connect/models/action-attempts/simulate-manual-lock-via-keypad.js.map +1 -0
- package/lib/seam/connect/models/index.d.ts +1 -0
- package/lib/seam/connect/models/index.js +1 -0
- package/lib/seam/connect/models/index.js.map +1 -1
- package/lib/seam/connect/models/instant-keys/index.d.ts +1 -0
- package/lib/seam/connect/models/instant-keys/index.js +2 -0
- package/lib/seam/connect/models/instant-keys/index.js.map +1 -0
- package/lib/seam/connect/models/instant-keys/instant-key.d.ts +27 -0
- package/lib/seam/connect/models/instant-keys/instant-key.js +16 -0
- package/lib/seam/connect/models/instant-keys/instant-key.js.map +1 -0
- package/lib/seam/connect/openapi.d.ts +420 -223
- package/lib/seam/connect/openapi.js +485 -132
- package/lib/seam/connect/openapi.js.map +1 -1
- package/lib/seam/connect/route-types.d.ts +1269 -33
- package/lib/seam/connect/schemas.d.ts +1 -1
- package/lib/seam/connect/schemas.js +1 -1
- package/lib/seam/connect/schemas.js.map +1 -1
- package/package.json +1 -1
- package/src/lib/seam/connect/internal/schemas.ts +1 -0
- package/src/lib/seam/connect/model-types.ts +1 -0
- package/src/lib/seam/connect/models/access-grants/access-grant.ts +5 -0
- package/src/lib/seam/connect/models/access-grants/requested-access-method.ts +4 -2
- package/src/lib/seam/connect/models/action-attempts/action-attempt.ts +4 -0
- package/src/lib/seam/connect/models/action-attempts/simulate-keypad-code-entry.ts +39 -0
- package/src/lib/seam/connect/models/action-attempts/simulate-manual-lock-via-keypad.ts +37 -0
- package/src/lib/seam/connect/models/index.ts +1 -0
- package/src/lib/seam/connect/models/instant-keys/index.ts +1 -0
- package/src/lib/seam/connect/models/instant-keys/instant-key.ts +18 -0
- package/src/lib/seam/connect/openapi.ts +535 -166
- package/src/lib/seam/connect/route-types.ts +1395 -33
- package/src/lib/seam/connect/schemas.ts +1 -0
package/dist/connect.cjs
CHANGED
|
@@ -30,6 +30,7 @@ __export(schemas_exports, {
|
|
|
30
30
|
custom_metadata: () => custom_metadata,
|
|
31
31
|
device: () => device,
|
|
32
32
|
device_provider: () => device_provider,
|
|
33
|
+
instant_key: () => instant_key,
|
|
33
34
|
noise_threshold: () => noise_threshold,
|
|
34
35
|
pagination: () => pagination,
|
|
35
36
|
seam_event: () => seam_event,
|
|
@@ -3008,21 +3009,62 @@ var set_hvac_mode_action_attempt = zod.z.discriminatedUnion("status", [
|
|
|
3008
3009
|
}).describe("Setting HVAC mode succeeded."),
|
|
3009
3010
|
common_failed_action_attempt.extend({ action_type: action_type7, error: error8 }).describe("Setting HVAC mode failed.")
|
|
3010
3011
|
]);
|
|
3011
|
-
var action_type8 = zod.z.literal("
|
|
3012
|
+
var action_type8 = zod.z.literal("SIMULATE_KEYPAD_CODE_ENTRY");
|
|
3012
3013
|
var error9 = zod.z.object({
|
|
3013
3014
|
type: zod.z.string(),
|
|
3014
3015
|
message: zod.z.string()
|
|
3015
3016
|
});
|
|
3016
3017
|
var result9 = zod.z.object({});
|
|
3018
|
+
var simulate_keypad_code_entry_action_attempt = zod.z.discriminatedUnion(
|
|
3019
|
+
"status",
|
|
3020
|
+
[
|
|
3021
|
+
common_pending_action_attempt.extend({
|
|
3022
|
+
action_type: action_type8
|
|
3023
|
+
}).describe("Simulating keypad code entry."),
|
|
3024
|
+
common_succeeded_action_attempt.extend({
|
|
3025
|
+
action_type: action_type8,
|
|
3026
|
+
result: result9
|
|
3027
|
+
}).describe("Simulating keypad code entry succeeded."),
|
|
3028
|
+
common_failed_action_attempt.extend({
|
|
3029
|
+
action_type: action_type8,
|
|
3030
|
+
error: error9
|
|
3031
|
+
}).describe("Simulating keypad code entry failed.")
|
|
3032
|
+
]
|
|
3033
|
+
);
|
|
3034
|
+
var action_type9 = zod.z.literal("SIMULATE_MANUAL_LOCK_VIA_KEYPAD");
|
|
3035
|
+
var error10 = zod.z.object({
|
|
3036
|
+
type: zod.z.string(),
|
|
3037
|
+
message: zod.z.string()
|
|
3038
|
+
});
|
|
3039
|
+
var result10 = zod.z.object({});
|
|
3040
|
+
var simulate_manual_lock_via_keypad_action_attempt = zod.z.discriminatedUnion("status", [
|
|
3041
|
+
common_pending_action_attempt.extend({
|
|
3042
|
+
action_type: action_type9
|
|
3043
|
+
}).describe("Simulating manual lock via keypad."),
|
|
3044
|
+
common_succeeded_action_attempt.extend({
|
|
3045
|
+
action_type: action_type9,
|
|
3046
|
+
result: result10
|
|
3047
|
+
}).describe("Simulating manual lock via keypad succeeded."),
|
|
3048
|
+
common_failed_action_attempt.extend({
|
|
3049
|
+
action_type: action_type9,
|
|
3050
|
+
error: error10
|
|
3051
|
+
}).describe("Simulating manual lock via keypad failed.")
|
|
3052
|
+
]);
|
|
3053
|
+
var action_type10 = zod.z.literal("UNLOCK_DOOR");
|
|
3054
|
+
var error11 = zod.z.object({
|
|
3055
|
+
type: zod.z.string(),
|
|
3056
|
+
message: zod.z.string()
|
|
3057
|
+
});
|
|
3058
|
+
var result11 = zod.z.object({});
|
|
3017
3059
|
var unlock_door_action_attempt = zod.z.discriminatedUnion("status", [
|
|
3018
3060
|
common_pending_action_attempt.extend({
|
|
3019
|
-
action_type:
|
|
3061
|
+
action_type: action_type10
|
|
3020
3062
|
}).describe("Unlocking door."),
|
|
3021
3063
|
common_succeeded_action_attempt.extend({
|
|
3022
|
-
action_type:
|
|
3023
|
-
result:
|
|
3064
|
+
action_type: action_type10,
|
|
3065
|
+
result: result11
|
|
3024
3066
|
}).describe("Unlocking door succeeded."),
|
|
3025
|
-
common_failed_action_attempt.extend({ action_type:
|
|
3067
|
+
common_failed_action_attempt.extend({ action_type: action_type10, error: error11 }).describe("Unlocking door failed.")
|
|
3026
3068
|
]);
|
|
3027
3069
|
|
|
3028
3070
|
// src/lib/seam/connect/models/action-attempts/action-attempt.ts
|
|
@@ -3035,6 +3077,8 @@ var action_attempt = zod.z.union([
|
|
|
3035
3077
|
...set_fan_mode_action_attempt.options,
|
|
3036
3078
|
...set_hvac_mode_action_attempt.options,
|
|
3037
3079
|
...activate_climate_preset_action_attempt.options,
|
|
3080
|
+
...simulate_keypad_code_entry_action_attempt.options,
|
|
3081
|
+
...simulate_manual_lock_via_keypad_action_attempt.options,
|
|
3038
3082
|
...deprecated_action_attempts
|
|
3039
3083
|
]).describe(`
|
|
3040
3084
|
---
|
|
@@ -4170,6 +4214,20 @@ var event_types = seam_event.options.map(
|
|
|
4170
4214
|
zod.z.enum(
|
|
4171
4215
|
event_types
|
|
4172
4216
|
);
|
|
4217
|
+
var instant_key = zod.z.object({
|
|
4218
|
+
instant_key_id: zod.z.string().uuid(),
|
|
4219
|
+
workspace_id: zod.z.string().uuid(),
|
|
4220
|
+
created_at: zod.z.string().datetime(),
|
|
4221
|
+
instant_key_url: zod.z.string().url(),
|
|
4222
|
+
client_session_id: zod.z.string().uuid(),
|
|
4223
|
+
user_identity_id: zod.z.string().uuid(),
|
|
4224
|
+
expires_at: zod.z.string().datetime()
|
|
4225
|
+
}).describe(`
|
|
4226
|
+
---
|
|
4227
|
+
route_path: /user_identities
|
|
4228
|
+
undocumented: Unreleased.
|
|
4229
|
+
---
|
|
4230
|
+
`);
|
|
4173
4231
|
var noise_threshold = zod.z.object({
|
|
4174
4232
|
noise_threshold_id: zod.z.string().uuid(),
|
|
4175
4233
|
device_id: zod.z.string().uuid(),
|
|
@@ -9451,6 +9509,194 @@ var openapi_default = {
|
|
|
9451
9509
|
],
|
|
9452
9510
|
type: "object"
|
|
9453
9511
|
},
|
|
9512
|
+
{
|
|
9513
|
+
description: "Simulating keypad code entry.",
|
|
9514
|
+
properties: {
|
|
9515
|
+
action_attempt_id: {
|
|
9516
|
+
description: "ID of the action attempt.",
|
|
9517
|
+
format: "uuid",
|
|
9518
|
+
type: "string"
|
|
9519
|
+
},
|
|
9520
|
+
action_type: {
|
|
9521
|
+
enum: ["SIMULATE_KEYPAD_CODE_ENTRY"],
|
|
9522
|
+
type: "string"
|
|
9523
|
+
},
|
|
9524
|
+
error: {
|
|
9525
|
+
description: "Errors associated with the action attempt. Null for pending action attempts.",
|
|
9526
|
+
nullable: true
|
|
9527
|
+
},
|
|
9528
|
+
result: {
|
|
9529
|
+
description: "Result of the action attempt. Null for pending action attempts.",
|
|
9530
|
+
nullable: true
|
|
9531
|
+
},
|
|
9532
|
+
status: { enum: ["pending"], type: "string" }
|
|
9533
|
+
},
|
|
9534
|
+
required: [
|
|
9535
|
+
"action_attempt_id",
|
|
9536
|
+
"status",
|
|
9537
|
+
"result",
|
|
9538
|
+
"error",
|
|
9539
|
+
"action_type"
|
|
9540
|
+
],
|
|
9541
|
+
type: "object"
|
|
9542
|
+
},
|
|
9543
|
+
{
|
|
9544
|
+
description: "Simulating keypad code entry succeeded.",
|
|
9545
|
+
properties: {
|
|
9546
|
+
action_attempt_id: {
|
|
9547
|
+
description: "ID of the action attempt.",
|
|
9548
|
+
format: "uuid",
|
|
9549
|
+
type: "string"
|
|
9550
|
+
},
|
|
9551
|
+
action_type: {
|
|
9552
|
+
enum: ["SIMULATE_KEYPAD_CODE_ENTRY"],
|
|
9553
|
+
type: "string"
|
|
9554
|
+
},
|
|
9555
|
+
error: {
|
|
9556
|
+
description: "Errors associated with the action attempt. Null for successful action attempts.",
|
|
9557
|
+
nullable: true
|
|
9558
|
+
},
|
|
9559
|
+
result: { properties: {}, type: "object" },
|
|
9560
|
+
status: { enum: ["success"], type: "string" }
|
|
9561
|
+
},
|
|
9562
|
+
required: [
|
|
9563
|
+
"action_attempt_id",
|
|
9564
|
+
"status",
|
|
9565
|
+
"error",
|
|
9566
|
+
"action_type",
|
|
9567
|
+
"result"
|
|
9568
|
+
],
|
|
9569
|
+
type: "object"
|
|
9570
|
+
},
|
|
9571
|
+
{
|
|
9572
|
+
description: "Simulating keypad code entry failed.",
|
|
9573
|
+
properties: {
|
|
9574
|
+
action_attempt_id: {
|
|
9575
|
+
description: "ID of the action attempt.",
|
|
9576
|
+
format: "uuid",
|
|
9577
|
+
type: "string"
|
|
9578
|
+
},
|
|
9579
|
+
action_type: {
|
|
9580
|
+
enum: ["SIMULATE_KEYPAD_CODE_ENTRY"],
|
|
9581
|
+
type: "string"
|
|
9582
|
+
},
|
|
9583
|
+
error: {
|
|
9584
|
+
properties: {
|
|
9585
|
+
message: { type: "string" },
|
|
9586
|
+
type: { type: "string" }
|
|
9587
|
+
},
|
|
9588
|
+
required: ["type", "message"],
|
|
9589
|
+
type: "object"
|
|
9590
|
+
},
|
|
9591
|
+
result: {
|
|
9592
|
+
description: "Result of the action attempt. Null for failed action attempts.",
|
|
9593
|
+
nullable: true
|
|
9594
|
+
},
|
|
9595
|
+
status: { enum: ["error"], type: "string" }
|
|
9596
|
+
},
|
|
9597
|
+
required: [
|
|
9598
|
+
"action_attempt_id",
|
|
9599
|
+
"status",
|
|
9600
|
+
"result",
|
|
9601
|
+
"action_type",
|
|
9602
|
+
"error"
|
|
9603
|
+
],
|
|
9604
|
+
type: "object"
|
|
9605
|
+
},
|
|
9606
|
+
{
|
|
9607
|
+
description: "Simulating manual lock via keypad.",
|
|
9608
|
+
properties: {
|
|
9609
|
+
action_attempt_id: {
|
|
9610
|
+
description: "ID of the action attempt.",
|
|
9611
|
+
format: "uuid",
|
|
9612
|
+
type: "string"
|
|
9613
|
+
},
|
|
9614
|
+
action_type: {
|
|
9615
|
+
enum: ["SIMULATE_MANUAL_LOCK_VIA_KEYPAD"],
|
|
9616
|
+
type: "string"
|
|
9617
|
+
},
|
|
9618
|
+
error: {
|
|
9619
|
+
description: "Errors associated with the action attempt. Null for pending action attempts.",
|
|
9620
|
+
nullable: true
|
|
9621
|
+
},
|
|
9622
|
+
result: {
|
|
9623
|
+
description: "Result of the action attempt. Null for pending action attempts.",
|
|
9624
|
+
nullable: true
|
|
9625
|
+
},
|
|
9626
|
+
status: { enum: ["pending"], type: "string" }
|
|
9627
|
+
},
|
|
9628
|
+
required: [
|
|
9629
|
+
"action_attempt_id",
|
|
9630
|
+
"status",
|
|
9631
|
+
"result",
|
|
9632
|
+
"error",
|
|
9633
|
+
"action_type"
|
|
9634
|
+
],
|
|
9635
|
+
type: "object"
|
|
9636
|
+
},
|
|
9637
|
+
{
|
|
9638
|
+
description: "Simulating manual lock via keypad succeeded.",
|
|
9639
|
+
properties: {
|
|
9640
|
+
action_attempt_id: {
|
|
9641
|
+
description: "ID of the action attempt.",
|
|
9642
|
+
format: "uuid",
|
|
9643
|
+
type: "string"
|
|
9644
|
+
},
|
|
9645
|
+
action_type: {
|
|
9646
|
+
enum: ["SIMULATE_MANUAL_LOCK_VIA_KEYPAD"],
|
|
9647
|
+
type: "string"
|
|
9648
|
+
},
|
|
9649
|
+
error: {
|
|
9650
|
+
description: "Errors associated with the action attempt. Null for successful action attempts.",
|
|
9651
|
+
nullable: true
|
|
9652
|
+
},
|
|
9653
|
+
result: { properties: {}, type: "object" },
|
|
9654
|
+
status: { enum: ["success"], type: "string" }
|
|
9655
|
+
},
|
|
9656
|
+
required: [
|
|
9657
|
+
"action_attempt_id",
|
|
9658
|
+
"status",
|
|
9659
|
+
"error",
|
|
9660
|
+
"action_type",
|
|
9661
|
+
"result"
|
|
9662
|
+
],
|
|
9663
|
+
type: "object"
|
|
9664
|
+
},
|
|
9665
|
+
{
|
|
9666
|
+
description: "Simulating manual lock via keypad failed.",
|
|
9667
|
+
properties: {
|
|
9668
|
+
action_attempt_id: {
|
|
9669
|
+
description: "ID of the action attempt.",
|
|
9670
|
+
format: "uuid",
|
|
9671
|
+
type: "string"
|
|
9672
|
+
},
|
|
9673
|
+
action_type: {
|
|
9674
|
+
enum: ["SIMULATE_MANUAL_LOCK_VIA_KEYPAD"],
|
|
9675
|
+
type: "string"
|
|
9676
|
+
},
|
|
9677
|
+
error: {
|
|
9678
|
+
properties: {
|
|
9679
|
+
message: { type: "string" },
|
|
9680
|
+
type: { type: "string" }
|
|
9681
|
+
},
|
|
9682
|
+
required: ["type", "message"],
|
|
9683
|
+
type: "object"
|
|
9684
|
+
},
|
|
9685
|
+
result: {
|
|
9686
|
+
description: "Result of the action attempt. Null for failed action attempts.",
|
|
9687
|
+
nullable: true
|
|
9688
|
+
},
|
|
9689
|
+
status: { enum: ["error"], type: "string" }
|
|
9690
|
+
},
|
|
9691
|
+
required: [
|
|
9692
|
+
"action_attempt_id",
|
|
9693
|
+
"status",
|
|
9694
|
+
"result",
|
|
9695
|
+
"action_type",
|
|
9696
|
+
"error"
|
|
9697
|
+
],
|
|
9698
|
+
type: "object"
|
|
9699
|
+
},
|
|
9454
9700
|
{
|
|
9455
9701
|
properties: {
|
|
9456
9702
|
action_attempt_id: {
|
|
@@ -16747,6 +16993,29 @@ var openapi_default = {
|
|
|
16747
16993
|
],
|
|
16748
16994
|
"x-route-path": "/events"
|
|
16749
16995
|
},
|
|
16996
|
+
instant_key: {
|
|
16997
|
+
properties: {
|
|
16998
|
+
client_session_id: { format: "uuid", type: "string" },
|
|
16999
|
+
created_at: { format: "date-time", type: "string" },
|
|
17000
|
+
expires_at: { format: "date-time", type: "string" },
|
|
17001
|
+
instant_key_id: { format: "uuid", type: "string" },
|
|
17002
|
+
instant_key_url: { format: "uri", type: "string" },
|
|
17003
|
+
user_identity_id: { format: "uuid", type: "string" },
|
|
17004
|
+
workspace_id: { format: "uuid", type: "string" }
|
|
17005
|
+
},
|
|
17006
|
+
required: [
|
|
17007
|
+
"instant_key_id",
|
|
17008
|
+
"workspace_id",
|
|
17009
|
+
"created_at",
|
|
17010
|
+
"instant_key_url",
|
|
17011
|
+
"client_session_id",
|
|
17012
|
+
"user_identity_id",
|
|
17013
|
+
"expires_at"
|
|
17014
|
+
],
|
|
17015
|
+
type: "object",
|
|
17016
|
+
"x-route-path": "/user_identities",
|
|
17017
|
+
"x-undocumented": "Unreleased."
|
|
17018
|
+
},
|
|
16750
17019
|
network: {
|
|
16751
17020
|
properties: {
|
|
16752
17021
|
created_at: { format: "date-time", type: "string" },
|
|
@@ -27120,98 +27389,6 @@ var openapi_default = {
|
|
|
27120
27389
|
"x-response-key": "device_providers"
|
|
27121
27390
|
}
|
|
27122
27391
|
},
|
|
27123
|
-
"/devices/simulate/access_code_lock": {
|
|
27124
|
-
post: {
|
|
27125
|
-
operationId: "devicesSimulateAccessCodeLockPost",
|
|
27126
|
-
requestBody: {
|
|
27127
|
-
content: {
|
|
27128
|
-
"application/json": {
|
|
27129
|
-
schema: {
|
|
27130
|
-
properties: {
|
|
27131
|
-
access_code_id: { format: "uuid", type: "string" },
|
|
27132
|
-
device_id: { format: "uuid", type: "string" }
|
|
27133
|
-
},
|
|
27134
|
-
required: ["device_id", "access_code_id"],
|
|
27135
|
-
type: "object"
|
|
27136
|
-
}
|
|
27137
|
-
}
|
|
27138
|
-
}
|
|
27139
|
-
},
|
|
27140
|
-
responses: {
|
|
27141
|
-
200: {
|
|
27142
|
-
content: {
|
|
27143
|
-
"application/json": {
|
|
27144
|
-
schema: {
|
|
27145
|
-
properties: { ok: { type: "boolean" } },
|
|
27146
|
-
required: ["ok"],
|
|
27147
|
-
type: "object"
|
|
27148
|
-
}
|
|
27149
|
-
}
|
|
27150
|
-
},
|
|
27151
|
-
description: "OK"
|
|
27152
|
-
},
|
|
27153
|
-
400: { description: "Bad Request" },
|
|
27154
|
-
401: { description: "Unauthorized" }
|
|
27155
|
-
},
|
|
27156
|
-
security: [
|
|
27157
|
-
{ api_key: [] },
|
|
27158
|
-
{ pat_with_workspace: [] },
|
|
27159
|
-
{ console_session_with_workspace: [] }
|
|
27160
|
-
],
|
|
27161
|
-
summary: "/devices/simulate/access_code_lock",
|
|
27162
|
-
tags: ["/devices"],
|
|
27163
|
-
"x-fern-sdk-group-name": ["devices", "simulate"],
|
|
27164
|
-
"x-fern-sdk-method-name": "access_code_lock",
|
|
27165
|
-
"x-response-key": null,
|
|
27166
|
-
"x-undocumented": "Unreleased."
|
|
27167
|
-
}
|
|
27168
|
-
},
|
|
27169
|
-
"/devices/simulate/access_code_unlock": {
|
|
27170
|
-
post: {
|
|
27171
|
-
operationId: "devicesSimulateAccessCodeUnlockPost",
|
|
27172
|
-
requestBody: {
|
|
27173
|
-
content: {
|
|
27174
|
-
"application/json": {
|
|
27175
|
-
schema: {
|
|
27176
|
-
properties: {
|
|
27177
|
-
access_code_id: { format: "uuid", type: "string" },
|
|
27178
|
-
device_id: { format: "uuid", type: "string" }
|
|
27179
|
-
},
|
|
27180
|
-
required: ["device_id", "access_code_id"],
|
|
27181
|
-
type: "object"
|
|
27182
|
-
}
|
|
27183
|
-
}
|
|
27184
|
-
}
|
|
27185
|
-
},
|
|
27186
|
-
responses: {
|
|
27187
|
-
200: {
|
|
27188
|
-
content: {
|
|
27189
|
-
"application/json": {
|
|
27190
|
-
schema: {
|
|
27191
|
-
properties: { ok: { type: "boolean" } },
|
|
27192
|
-
required: ["ok"],
|
|
27193
|
-
type: "object"
|
|
27194
|
-
}
|
|
27195
|
-
}
|
|
27196
|
-
},
|
|
27197
|
-
description: "OK"
|
|
27198
|
-
},
|
|
27199
|
-
400: { description: "Bad Request" },
|
|
27200
|
-
401: { description: "Unauthorized" }
|
|
27201
|
-
},
|
|
27202
|
-
security: [
|
|
27203
|
-
{ api_key: [] },
|
|
27204
|
-
{ pat_with_workspace: [] },
|
|
27205
|
-
{ console_session_with_workspace: [] }
|
|
27206
|
-
],
|
|
27207
|
-
summary: "/devices/simulate/access_code_unlock",
|
|
27208
|
-
tags: ["/devices"],
|
|
27209
|
-
"x-fern-sdk-group-name": ["devices", "simulate"],
|
|
27210
|
-
"x-fern-sdk-method-name": "access_code_unlock",
|
|
27211
|
-
"x-response-key": null,
|
|
27212
|
-
"x-undocumented": "Unreleased."
|
|
27213
|
-
}
|
|
27214
|
-
},
|
|
27215
27392
|
"/devices/simulate/connect": {
|
|
27216
27393
|
post: {
|
|
27217
27394
|
operationId: "devicesSimulateConnectPost",
|
|
@@ -28545,6 +28722,108 @@ var openapi_default = {
|
|
|
28545
28722
|
"x-response-key": "action_attempt"
|
|
28546
28723
|
}
|
|
28547
28724
|
},
|
|
28725
|
+
"/locks/simulate/keypad_code_entry": {
|
|
28726
|
+
post: {
|
|
28727
|
+
operationId: "locksSimulateKeypadCodeEntryPost",
|
|
28728
|
+
requestBody: {
|
|
28729
|
+
content: {
|
|
28730
|
+
"application/json": {
|
|
28731
|
+
schema: {
|
|
28732
|
+
properties: {
|
|
28733
|
+
code: { type: "string" },
|
|
28734
|
+
device_id: { format: "uuid", type: "string" }
|
|
28735
|
+
},
|
|
28736
|
+
required: ["device_id", "code"],
|
|
28737
|
+
type: "object"
|
|
28738
|
+
}
|
|
28739
|
+
}
|
|
28740
|
+
}
|
|
28741
|
+
},
|
|
28742
|
+
responses: {
|
|
28743
|
+
200: {
|
|
28744
|
+
content: {
|
|
28745
|
+
"application/json": {
|
|
28746
|
+
schema: {
|
|
28747
|
+
properties: {
|
|
28748
|
+
action_attempt: {
|
|
28749
|
+
$ref: "#/components/schemas/access_code"
|
|
28750
|
+
},
|
|
28751
|
+
ok: { type: "boolean" }
|
|
28752
|
+
},
|
|
28753
|
+
required: ["ok"],
|
|
28754
|
+
type: "object"
|
|
28755
|
+
}
|
|
28756
|
+
}
|
|
28757
|
+
},
|
|
28758
|
+
description: "OK"
|
|
28759
|
+
},
|
|
28760
|
+
400: { description: "Bad Request" },
|
|
28761
|
+
401: { description: "Unauthorized" }
|
|
28762
|
+
},
|
|
28763
|
+
security: [
|
|
28764
|
+
{ api_key: [] },
|
|
28765
|
+
{ pat_with_workspace: [] },
|
|
28766
|
+
{ console_session_with_workspace: [] }
|
|
28767
|
+
],
|
|
28768
|
+
summary: "/locks/simulate/keypad_code_entry",
|
|
28769
|
+
tags: ["/locks"],
|
|
28770
|
+
"x-action-attempt-type": "SIMULATE_KEYPAD_CODE_ENTRY",
|
|
28771
|
+
"x-fern-sdk-group-name": ["locks", "simulate"],
|
|
28772
|
+
"x-fern-sdk-method-name": "keypad_code_entry",
|
|
28773
|
+
"x-fern-sdk-return-value": "action_attempt",
|
|
28774
|
+
"x-response-key": "action_attempt",
|
|
28775
|
+
"x-undocumented": "Unreleased."
|
|
28776
|
+
}
|
|
28777
|
+
},
|
|
28778
|
+
"/locks/simulate/manual_lock_via_keypad": {
|
|
28779
|
+
post: {
|
|
28780
|
+
operationId: "locksSimulateManualLockViaKeypadPost",
|
|
28781
|
+
requestBody: {
|
|
28782
|
+
content: {
|
|
28783
|
+
"application/json": {
|
|
28784
|
+
schema: {
|
|
28785
|
+
properties: { device_id: { format: "uuid", type: "string" } },
|
|
28786
|
+
required: ["device_id"],
|
|
28787
|
+
type: "object"
|
|
28788
|
+
}
|
|
28789
|
+
}
|
|
28790
|
+
}
|
|
28791
|
+
},
|
|
28792
|
+
responses: {
|
|
28793
|
+
200: {
|
|
28794
|
+
content: {
|
|
28795
|
+
"application/json": {
|
|
28796
|
+
schema: {
|
|
28797
|
+
properties: {
|
|
28798
|
+
action_attempt: {
|
|
28799
|
+
$ref: "#/components/schemas/access_code"
|
|
28800
|
+
},
|
|
28801
|
+
ok: { type: "boolean" }
|
|
28802
|
+
},
|
|
28803
|
+
required: ["ok"],
|
|
28804
|
+
type: "object"
|
|
28805
|
+
}
|
|
28806
|
+
}
|
|
28807
|
+
},
|
|
28808
|
+
description: "OK"
|
|
28809
|
+
},
|
|
28810
|
+
400: { description: "Bad Request" },
|
|
28811
|
+
401: { description: "Unauthorized" }
|
|
28812
|
+
},
|
|
28813
|
+
security: [
|
|
28814
|
+
{ api_key: [] },
|
|
28815
|
+
{ pat_with_workspace: [] },
|
|
28816
|
+
{ console_session_with_workspace: [] }
|
|
28817
|
+
],
|
|
28818
|
+
summary: "/locks/simulate/manual_lock_via_keypad",
|
|
28819
|
+
tags: ["/locks"],
|
|
28820
|
+
"x-action-attempt-type": "SIMULATE_MANUAL_LOCK_VIA_KEYPAD",
|
|
28821
|
+
"x-fern-sdk-group-name": ["locks", "simulate"],
|
|
28822
|
+
"x-fern-sdk-method-name": "manual_lock_via_keypad",
|
|
28823
|
+
"x-response-key": null,
|
|
28824
|
+
"x-undocumented": "Unreleased."
|
|
28825
|
+
}
|
|
28826
|
+
},
|
|
28548
28827
|
"/locks/unlock_door": {
|
|
28549
28828
|
post: {
|
|
28550
28829
|
operationId: "locksUnlockDoorPost",
|
|
@@ -30613,6 +30892,62 @@ var openapi_default = {
|
|
|
30613
30892
|
"x-undocumented": "Seam Bridge Client only."
|
|
30614
30893
|
}
|
|
30615
30894
|
},
|
|
30895
|
+
"/seam/instant_key/v1/client_sessions/exchange_short_code": {
|
|
30896
|
+
post: {
|
|
30897
|
+
description: "Exchanges a short code for a Client Session Token (CST).\nThis endpoint is used by mobile apps to securely retrieve a client session token \nusing a short code obtained from an instant key URL.",
|
|
30898
|
+
operationId: "seamInstantKeyV1ClientSessionsExchangeShortCodePost",
|
|
30899
|
+
requestBody: {
|
|
30900
|
+
content: {
|
|
30901
|
+
"application/json": {
|
|
30902
|
+
schema: {
|
|
30903
|
+
properties: {
|
|
30904
|
+
short_code: {
|
|
30905
|
+
description: "The short code to exchange for a client session token",
|
|
30906
|
+
type: "string"
|
|
30907
|
+
}
|
|
30908
|
+
},
|
|
30909
|
+
required: ["short_code"],
|
|
30910
|
+
type: "object"
|
|
30911
|
+
}
|
|
30912
|
+
}
|
|
30913
|
+
}
|
|
30914
|
+
},
|
|
30915
|
+
responses: {
|
|
30916
|
+
200: {
|
|
30917
|
+
content: {
|
|
30918
|
+
"application/json": {
|
|
30919
|
+
schema: {
|
|
30920
|
+
properties: {
|
|
30921
|
+
client_session: {
|
|
30922
|
+
$ref: "#/components/schemas/client_session"
|
|
30923
|
+
},
|
|
30924
|
+
ok: { type: "boolean" }
|
|
30925
|
+
},
|
|
30926
|
+
required: ["client_session", "ok"],
|
|
30927
|
+
type: "object"
|
|
30928
|
+
}
|
|
30929
|
+
}
|
|
30930
|
+
},
|
|
30931
|
+
description: "OK"
|
|
30932
|
+
},
|
|
30933
|
+
400: { description: "Bad Request" },
|
|
30934
|
+
401: { description: "Unauthorized" }
|
|
30935
|
+
},
|
|
30936
|
+
security: [{ certified_client: [] }],
|
|
30937
|
+
summary: "/seam/instant_key/v1/client_sessions/exchange_short_code",
|
|
30938
|
+
tags: ["/client_sessions"],
|
|
30939
|
+
"x-fern-sdk-group-name": [
|
|
30940
|
+
"seam",
|
|
30941
|
+
"instant_key",
|
|
30942
|
+
"v1",
|
|
30943
|
+
"client_sessions"
|
|
30944
|
+
],
|
|
30945
|
+
"x-fern-sdk-method-name": "exchange_short_code",
|
|
30946
|
+
"x-fern-sdk-return-value": "client_session",
|
|
30947
|
+
"x-response-key": "client_session",
|
|
30948
|
+
"x-title": "Exchange Instant Key Short Code"
|
|
30949
|
+
}
|
|
30950
|
+
},
|
|
30616
30951
|
"/thermostats/activate_climate_preset": {
|
|
30617
30952
|
post: {
|
|
30618
30953
|
description: "Activates a specified [climate preset](https://docs.seam.co/latest/capability-guides/thermostats/creating-and-managing-climate-presets) for a specified [thermostat](https://docs.seam.co/latest/capability-guides/thermostats).",
|
|
@@ -32646,20 +32981,6 @@ var openapi_default = {
|
|
|
32646
32981
|
},
|
|
32647
32982
|
{
|
|
32648
32983
|
properties: {
|
|
32649
|
-
desired_access_methods: {
|
|
32650
|
-
items: {
|
|
32651
|
-
properties: {
|
|
32652
|
-
mode: {
|
|
32653
|
-
description: "Access method mode. Supported values: `code`, `card`, `mobile_key`.",
|
|
32654
|
-
enum: ["code", "card", "mobile_key"],
|
|
32655
|
-
type: "string"
|
|
32656
|
-
}
|
|
32657
|
-
},
|
|
32658
|
-
required: ["mode"],
|
|
32659
|
-
type: "object"
|
|
32660
|
-
},
|
|
32661
|
-
type: "array"
|
|
32662
|
-
},
|
|
32663
32984
|
ends_at: {
|
|
32664
32985
|
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`.",
|
|
32665
32986
|
format: "date-time",
|
|
@@ -32679,6 +33000,10 @@ var openapi_default = {
|
|
|
32679
33000
|
description: "Set of IDs of the [devices](https://docs.seam.co/latest/api/devices/list) to add to the location to which access is being granted.",
|
|
32680
33001
|
items: { format: "uuid", type: "string" },
|
|
32681
33002
|
type: "array"
|
|
33003
|
+
},
|
|
33004
|
+
name: {
|
|
33005
|
+
description: "Name of the location.",
|
|
33006
|
+
type: "string"
|
|
32682
33007
|
}
|
|
32683
33008
|
},
|
|
32684
33009
|
type: "object"
|
|
@@ -32688,13 +33013,27 @@ var openapi_default = {
|
|
|
32688
33013
|
items: { format: "uuid", type: "string" },
|
|
32689
33014
|
type: "array"
|
|
32690
33015
|
},
|
|
33016
|
+
requested_access_methods: {
|
|
33017
|
+
items: {
|
|
33018
|
+
properties: {
|
|
33019
|
+
mode: {
|
|
33020
|
+
description: "Access method mode. Supported values: `code`, `card`, `mobile_key`.",
|
|
33021
|
+
enum: ["code", "card", "mobile_key"],
|
|
33022
|
+
type: "string"
|
|
33023
|
+
}
|
|
33024
|
+
},
|
|
33025
|
+
required: ["mode"],
|
|
33026
|
+
type: "object"
|
|
33027
|
+
},
|
|
33028
|
+
type: "array"
|
|
33029
|
+
},
|
|
32691
33030
|
starts_at: {
|
|
32692
33031
|
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.",
|
|
32693
33032
|
format: "date-time",
|
|
32694
33033
|
type: "string"
|
|
32695
33034
|
}
|
|
32696
33035
|
},
|
|
32697
|
-
required: ["
|
|
33036
|
+
required: ["requested_access_methods"],
|
|
32698
33037
|
type: "object"
|
|
32699
33038
|
}
|
|
32700
33039
|
]
|
|
@@ -32715,6 +33054,11 @@ var openapi_default = {
|
|
|
32715
33054
|
format: "uuid",
|
|
32716
33055
|
type: "string"
|
|
32717
33056
|
},
|
|
33057
|
+
access_method_ids: {
|
|
33058
|
+
description: "IDs of the access methods that were created for this access grant.",
|
|
33059
|
+
items: { format: "uuid", type: "string" },
|
|
33060
|
+
type: "array"
|
|
33061
|
+
},
|
|
32718
33062
|
created_at: {
|
|
32719
33063
|
description: "Date and time at which the access grant was created.",
|
|
32720
33064
|
format: "date-time",
|
|
@@ -32733,6 +33077,11 @@ var openapi_default = {
|
|
|
32733
33077
|
description: "Access methods that the user requested for this access grant.",
|
|
32734
33078
|
items: {
|
|
32735
33079
|
properties: {
|
|
33080
|
+
created_access_method_ids: {
|
|
33081
|
+
description: "IDs of the access methods that were created for this requested access method.",
|
|
33082
|
+
items: { format: "uuid", type: "string" },
|
|
33083
|
+
type: "array"
|
|
33084
|
+
},
|
|
32736
33085
|
created_at: {
|
|
32737
33086
|
description: "Date and time at which the requested access method was added to this access grant.",
|
|
32738
33087
|
format: "date-time",
|
|
@@ -32746,18 +33095,13 @@ var openapi_default = {
|
|
|
32746
33095
|
description: "Access method mode. Supported values: `code`, `card`, `mobile_key`.",
|
|
32747
33096
|
enum: ["code", "card", "mobile_key"],
|
|
32748
33097
|
type: "string"
|
|
32749
|
-
},
|
|
32750
|
-
provisioned_access_method_ids: {
|
|
32751
|
-
description: "IDs of the locations to which access is being given.",
|
|
32752
|
-
items: { format: "uuid", type: "string" },
|
|
32753
|
-
type: "array"
|
|
32754
33098
|
}
|
|
32755
33099
|
},
|
|
32756
33100
|
required: [
|
|
32757
33101
|
"display_name",
|
|
32758
33102
|
"mode",
|
|
32759
33103
|
"created_at",
|
|
32760
|
-
"
|
|
33104
|
+
"created_access_method_ids"
|
|
32761
33105
|
],
|
|
32762
33106
|
type: "object",
|
|
32763
33107
|
"x-undocumented": "Unreleased."
|
|
@@ -32781,6 +33125,7 @@ var openapi_default = {
|
|
|
32781
33125
|
"user_identity_id",
|
|
32782
33126
|
"location_ids",
|
|
32783
33127
|
"requested_access_methods",
|
|
33128
|
+
"access_method_ids",
|
|
32784
33129
|
"display_name",
|
|
32785
33130
|
"created_at"
|
|
32786
33131
|
],
|
|
@@ -32848,6 +33193,11 @@ var openapi_default = {
|
|
|
32848
33193
|
format: "uuid",
|
|
32849
33194
|
type: "string"
|
|
32850
33195
|
},
|
|
33196
|
+
access_method_ids: {
|
|
33197
|
+
description: "IDs of the access methods that were created for this access grant.",
|
|
33198
|
+
items: { format: "uuid", type: "string" },
|
|
33199
|
+
type: "array"
|
|
33200
|
+
},
|
|
32851
33201
|
created_at: {
|
|
32852
33202
|
description: "Date and time at which the access grant was created.",
|
|
32853
33203
|
format: "date-time",
|
|
@@ -32866,6 +33216,11 @@ var openapi_default = {
|
|
|
32866
33216
|
description: "Access methods that the user requested for this access grant.",
|
|
32867
33217
|
items: {
|
|
32868
33218
|
properties: {
|
|
33219
|
+
created_access_method_ids: {
|
|
33220
|
+
description: "IDs of the access methods that were created for this requested access method.",
|
|
33221
|
+
items: { format: "uuid", type: "string" },
|
|
33222
|
+
type: "array"
|
|
33223
|
+
},
|
|
32869
33224
|
created_at: {
|
|
32870
33225
|
description: "Date and time at which the requested access method was added to this access grant.",
|
|
32871
33226
|
format: "date-time",
|
|
@@ -32879,18 +33234,13 @@ var openapi_default = {
|
|
|
32879
33234
|
description: "Access method mode. Supported values: `code`, `card`, `mobile_key`.",
|
|
32880
33235
|
enum: ["code", "card", "mobile_key"],
|
|
32881
33236
|
type: "string"
|
|
32882
|
-
},
|
|
32883
|
-
provisioned_access_method_ids: {
|
|
32884
|
-
description: "IDs of the locations to which access is being given.",
|
|
32885
|
-
items: { format: "uuid", type: "string" },
|
|
32886
|
-
type: "array"
|
|
32887
33237
|
}
|
|
32888
33238
|
},
|
|
32889
33239
|
required: [
|
|
32890
33240
|
"display_name",
|
|
32891
33241
|
"mode",
|
|
32892
33242
|
"created_at",
|
|
32893
|
-
"
|
|
33243
|
+
"created_access_method_ids"
|
|
32894
33244
|
],
|
|
32895
33245
|
type: "object",
|
|
32896
33246
|
"x-undocumented": "Unreleased."
|
|
@@ -32914,6 +33264,7 @@ var openapi_default = {
|
|
|
32914
33264
|
"user_identity_id",
|
|
32915
33265
|
"location_ids",
|
|
32916
33266
|
"requested_access_methods",
|
|
33267
|
+
"access_method_ids",
|
|
32917
33268
|
"display_name",
|
|
32918
33269
|
"created_at"
|
|
32919
33270
|
],
|
|
@@ -32996,6 +33347,11 @@ var openapi_default = {
|
|
|
32996
33347
|
format: "uuid",
|
|
32997
33348
|
type: "string"
|
|
32998
33349
|
},
|
|
33350
|
+
access_method_ids: {
|
|
33351
|
+
description: "IDs of the access methods that were created for this access grant.",
|
|
33352
|
+
items: { format: "uuid", type: "string" },
|
|
33353
|
+
type: "array"
|
|
33354
|
+
},
|
|
32999
33355
|
created_at: {
|
|
33000
33356
|
description: "Date and time at which the access grant was created.",
|
|
33001
33357
|
format: "date-time",
|
|
@@ -33014,6 +33370,11 @@ var openapi_default = {
|
|
|
33014
33370
|
description: "Access methods that the user requested for this access grant.",
|
|
33015
33371
|
items: {
|
|
33016
33372
|
properties: {
|
|
33373
|
+
created_access_method_ids: {
|
|
33374
|
+
description: "IDs of the access methods that were created for this requested access method.",
|
|
33375
|
+
items: { format: "uuid", type: "string" },
|
|
33376
|
+
type: "array"
|
|
33377
|
+
},
|
|
33017
33378
|
created_at: {
|
|
33018
33379
|
description: "Date and time at which the requested access method was added to this access grant.",
|
|
33019
33380
|
format: "date-time",
|
|
@@ -33027,18 +33388,13 @@ var openapi_default = {
|
|
|
33027
33388
|
description: "Access method mode. Supported values: `code`, `card`, `mobile_key`.",
|
|
33028
33389
|
enum: ["code", "card", "mobile_key"],
|
|
33029
33390
|
type: "string"
|
|
33030
|
-
},
|
|
33031
|
-
provisioned_access_method_ids: {
|
|
33032
|
-
description: "IDs of the locations to which access is being given.",
|
|
33033
|
-
items: { format: "uuid", type: "string" },
|
|
33034
|
-
type: "array"
|
|
33035
33391
|
}
|
|
33036
33392
|
},
|
|
33037
33393
|
required: [
|
|
33038
33394
|
"display_name",
|
|
33039
33395
|
"mode",
|
|
33040
33396
|
"created_at",
|
|
33041
|
-
"
|
|
33397
|
+
"created_access_method_ids"
|
|
33042
33398
|
],
|
|
33043
33399
|
type: "object",
|
|
33044
33400
|
"x-undocumented": "Unreleased."
|
|
@@ -33062,6 +33418,7 @@ var openapi_default = {
|
|
|
33062
33418
|
"user_identity_id",
|
|
33063
33419
|
"location_ids",
|
|
33064
33420
|
"requested_access_methods",
|
|
33421
|
+
"access_method_ids",
|
|
33065
33422
|
"display_name",
|
|
33066
33423
|
"created_at"
|
|
33067
33424
|
],
|
|
@@ -33097,10 +33454,10 @@ var openapi_default = {
|
|
|
33097
33454
|
"x-undocumented": "Unreleased."
|
|
33098
33455
|
}
|
|
33099
33456
|
},
|
|
33100
|
-
"/
|
|
33457
|
+
"/unstable_access_methods/list": {
|
|
33101
33458
|
post: {
|
|
33102
|
-
description: "List all access methods
|
|
33103
|
-
operationId: "
|
|
33459
|
+
description: "List all access methods, usually filtered by access grant.",
|
|
33460
|
+
operationId: "unstableAccessMethodsListPost",
|
|
33104
33461
|
requestBody: {
|
|
33105
33462
|
content: {
|
|
33106
33463
|
"application/json": {
|
|
@@ -33188,13 +33545,13 @@ var openapi_default = {
|
|
|
33188
33545
|
{ console_session_with_workspace: [] },
|
|
33189
33546
|
{ api_key: [] }
|
|
33190
33547
|
],
|
|
33191
|
-
summary: "/
|
|
33548
|
+
summary: "/unstable_access_methods/list",
|
|
33192
33549
|
tags: [],
|
|
33193
|
-
"x-fern-sdk-group-name": ["
|
|
33194
|
-
"x-fern-sdk-method-name": "
|
|
33550
|
+
"x-fern-sdk-group-name": ["unstable_access_methods"],
|
|
33551
|
+
"x-fern-sdk-method-name": "list",
|
|
33195
33552
|
"x-fern-sdk-return-value": "access_methods",
|
|
33196
33553
|
"x-response-key": "access_methods",
|
|
33197
|
-
"x-title": "
|
|
33554
|
+
"x-title": "List Access Methods",
|
|
33198
33555
|
"x-undocumented": "Unreleased."
|
|
33199
33556
|
}
|
|
33200
33557
|
},
|
|
@@ -34482,6 +34839,60 @@ var openapi_default = {
|
|
|
34482
34839
|
"x-title": "List Enrollment Automations"
|
|
34483
34840
|
}
|
|
34484
34841
|
},
|
|
34842
|
+
"/user_identities/generate_instant_key": {
|
|
34843
|
+
post: {
|
|
34844
|
+
description: "Generates a new [instant key](https://docs.seam.co/latest/capability-guides/mobile-access-in-development/instant-keys) for a specified [user identity](https://docs.seam.co/latest/capability-guides/mobile-access-in-development/managing-mobile-app-user-accounts-with-user-identities#what-is-a-user-identity).",
|
|
34845
|
+
operationId: "userIdentitiesGenerateInstantKeyPost",
|
|
34846
|
+
requestBody: {
|
|
34847
|
+
content: {
|
|
34848
|
+
"application/json": {
|
|
34849
|
+
schema: {
|
|
34850
|
+
properties: {
|
|
34851
|
+
user_identity_id: {
|
|
34852
|
+
description: "ID of the user identity for which you want to generate an instant key.",
|
|
34853
|
+
format: "uuid",
|
|
34854
|
+
type: "string"
|
|
34855
|
+
}
|
|
34856
|
+
},
|
|
34857
|
+
required: ["user_identity_id"],
|
|
34858
|
+
type: "object"
|
|
34859
|
+
}
|
|
34860
|
+
}
|
|
34861
|
+
}
|
|
34862
|
+
},
|
|
34863
|
+
responses: {
|
|
34864
|
+
200: {
|
|
34865
|
+
content: {
|
|
34866
|
+
"application/json": {
|
|
34867
|
+
schema: {
|
|
34868
|
+
properties: {
|
|
34869
|
+
instant_key: { $ref: "#/components/schemas/instant_key" },
|
|
34870
|
+
ok: { type: "boolean" }
|
|
34871
|
+
},
|
|
34872
|
+
required: ["instant_key", "ok"],
|
|
34873
|
+
type: "object"
|
|
34874
|
+
}
|
|
34875
|
+
}
|
|
34876
|
+
},
|
|
34877
|
+
description: "OK"
|
|
34878
|
+
},
|
|
34879
|
+
400: { description: "Bad Request" },
|
|
34880
|
+
401: { description: "Unauthorized" }
|
|
34881
|
+
},
|
|
34882
|
+
security: [
|
|
34883
|
+
{ api_key: [] },
|
|
34884
|
+
{ pat_with_workspace: [] },
|
|
34885
|
+
{ console_session_with_workspace: [] }
|
|
34886
|
+
],
|
|
34887
|
+
summary: "/user_identities/generate_instant_key",
|
|
34888
|
+
tags: ["/user_identities"],
|
|
34889
|
+
"x-fern-sdk-group-name": ["user_identities"],
|
|
34890
|
+
"x-fern-sdk-method-name": "generate_instant_key",
|
|
34891
|
+
"x-fern-sdk-return-value": "instant_key",
|
|
34892
|
+
"x-response-key": "instant_key",
|
|
34893
|
+
"x-title": "Generate an Instant Key"
|
|
34894
|
+
}
|
|
34895
|
+
},
|
|
34485
34896
|
"/user_identities/get": {
|
|
34486
34897
|
post: {
|
|
34487
34898
|
description: "Returns a specified [user identity](https://docs.seam.co/latest/capability-guides/mobile-access-in-development/managing-mobile-app-user-accounts-with-user-identities#what-is-a-user-identity).",
|