@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
|
@@ -5845,6 +5845,202 @@ export default {
|
|
|
5845
5845
|
],
|
|
5846
5846
|
type: 'object',
|
|
5847
5847
|
},
|
|
5848
|
+
{
|
|
5849
|
+
description: 'Simulating keypad code entry.',
|
|
5850
|
+
properties: {
|
|
5851
|
+
action_attempt_id: {
|
|
5852
|
+
description: 'ID of the action attempt.',
|
|
5853
|
+
format: 'uuid',
|
|
5854
|
+
type: 'string',
|
|
5855
|
+
},
|
|
5856
|
+
action_type: {
|
|
5857
|
+
enum: ['SIMULATE_KEYPAD_CODE_ENTRY'],
|
|
5858
|
+
type: 'string',
|
|
5859
|
+
},
|
|
5860
|
+
error: {
|
|
5861
|
+
description:
|
|
5862
|
+
'Errors associated with the action attempt. Null for pending action attempts.',
|
|
5863
|
+
nullable: true,
|
|
5864
|
+
},
|
|
5865
|
+
result: {
|
|
5866
|
+
description:
|
|
5867
|
+
'Result of the action attempt. Null for pending action attempts.',
|
|
5868
|
+
nullable: true,
|
|
5869
|
+
},
|
|
5870
|
+
status: { enum: ['pending'], type: 'string' },
|
|
5871
|
+
},
|
|
5872
|
+
required: [
|
|
5873
|
+
'action_attempt_id',
|
|
5874
|
+
'status',
|
|
5875
|
+
'result',
|
|
5876
|
+
'error',
|
|
5877
|
+
'action_type',
|
|
5878
|
+
],
|
|
5879
|
+
type: 'object',
|
|
5880
|
+
},
|
|
5881
|
+
{
|
|
5882
|
+
description: 'Simulating keypad code entry succeeded.',
|
|
5883
|
+
properties: {
|
|
5884
|
+
action_attempt_id: {
|
|
5885
|
+
description: 'ID of the action attempt.',
|
|
5886
|
+
format: 'uuid',
|
|
5887
|
+
type: 'string',
|
|
5888
|
+
},
|
|
5889
|
+
action_type: {
|
|
5890
|
+
enum: ['SIMULATE_KEYPAD_CODE_ENTRY'],
|
|
5891
|
+
type: 'string',
|
|
5892
|
+
},
|
|
5893
|
+
error: {
|
|
5894
|
+
description:
|
|
5895
|
+
'Errors associated with the action attempt. Null for successful action attempts.',
|
|
5896
|
+
nullable: true,
|
|
5897
|
+
},
|
|
5898
|
+
result: { properties: {}, type: 'object' },
|
|
5899
|
+
status: { enum: ['success'], type: 'string' },
|
|
5900
|
+
},
|
|
5901
|
+
required: [
|
|
5902
|
+
'action_attempt_id',
|
|
5903
|
+
'status',
|
|
5904
|
+
'error',
|
|
5905
|
+
'action_type',
|
|
5906
|
+
'result',
|
|
5907
|
+
],
|
|
5908
|
+
type: 'object',
|
|
5909
|
+
},
|
|
5910
|
+
{
|
|
5911
|
+
description: 'Simulating keypad code entry failed.',
|
|
5912
|
+
properties: {
|
|
5913
|
+
action_attempt_id: {
|
|
5914
|
+
description: 'ID of the action attempt.',
|
|
5915
|
+
format: 'uuid',
|
|
5916
|
+
type: 'string',
|
|
5917
|
+
},
|
|
5918
|
+
action_type: {
|
|
5919
|
+
enum: ['SIMULATE_KEYPAD_CODE_ENTRY'],
|
|
5920
|
+
type: 'string',
|
|
5921
|
+
},
|
|
5922
|
+
error: {
|
|
5923
|
+
properties: {
|
|
5924
|
+
message: { type: 'string' },
|
|
5925
|
+
type: { type: 'string' },
|
|
5926
|
+
},
|
|
5927
|
+
required: ['type', 'message'],
|
|
5928
|
+
type: 'object',
|
|
5929
|
+
},
|
|
5930
|
+
result: {
|
|
5931
|
+
description:
|
|
5932
|
+
'Result of the action attempt. Null for failed action attempts.',
|
|
5933
|
+
nullable: true,
|
|
5934
|
+
},
|
|
5935
|
+
status: { enum: ['error'], type: 'string' },
|
|
5936
|
+
},
|
|
5937
|
+
required: [
|
|
5938
|
+
'action_attempt_id',
|
|
5939
|
+
'status',
|
|
5940
|
+
'result',
|
|
5941
|
+
'action_type',
|
|
5942
|
+
'error',
|
|
5943
|
+
],
|
|
5944
|
+
type: 'object',
|
|
5945
|
+
},
|
|
5946
|
+
{
|
|
5947
|
+
description: 'Simulating manual lock via keypad.',
|
|
5948
|
+
properties: {
|
|
5949
|
+
action_attempt_id: {
|
|
5950
|
+
description: 'ID of the action attempt.',
|
|
5951
|
+
format: 'uuid',
|
|
5952
|
+
type: 'string',
|
|
5953
|
+
},
|
|
5954
|
+
action_type: {
|
|
5955
|
+
enum: ['SIMULATE_MANUAL_LOCK_VIA_KEYPAD'],
|
|
5956
|
+
type: 'string',
|
|
5957
|
+
},
|
|
5958
|
+
error: {
|
|
5959
|
+
description:
|
|
5960
|
+
'Errors associated with the action attempt. Null for pending action attempts.',
|
|
5961
|
+
nullable: true,
|
|
5962
|
+
},
|
|
5963
|
+
result: {
|
|
5964
|
+
description:
|
|
5965
|
+
'Result of the action attempt. Null for pending action attempts.',
|
|
5966
|
+
nullable: true,
|
|
5967
|
+
},
|
|
5968
|
+
status: { enum: ['pending'], type: 'string' },
|
|
5969
|
+
},
|
|
5970
|
+
required: [
|
|
5971
|
+
'action_attempt_id',
|
|
5972
|
+
'status',
|
|
5973
|
+
'result',
|
|
5974
|
+
'error',
|
|
5975
|
+
'action_type',
|
|
5976
|
+
],
|
|
5977
|
+
type: 'object',
|
|
5978
|
+
},
|
|
5979
|
+
{
|
|
5980
|
+
description: 'Simulating manual lock via keypad succeeded.',
|
|
5981
|
+
properties: {
|
|
5982
|
+
action_attempt_id: {
|
|
5983
|
+
description: 'ID of the action attempt.',
|
|
5984
|
+
format: 'uuid',
|
|
5985
|
+
type: 'string',
|
|
5986
|
+
},
|
|
5987
|
+
action_type: {
|
|
5988
|
+
enum: ['SIMULATE_MANUAL_LOCK_VIA_KEYPAD'],
|
|
5989
|
+
type: 'string',
|
|
5990
|
+
},
|
|
5991
|
+
error: {
|
|
5992
|
+
description:
|
|
5993
|
+
'Errors associated with the action attempt. Null for successful action attempts.',
|
|
5994
|
+
nullable: true,
|
|
5995
|
+
},
|
|
5996
|
+
result: { properties: {}, type: 'object' },
|
|
5997
|
+
status: { enum: ['success'], type: 'string' },
|
|
5998
|
+
},
|
|
5999
|
+
required: [
|
|
6000
|
+
'action_attempt_id',
|
|
6001
|
+
'status',
|
|
6002
|
+
'error',
|
|
6003
|
+
'action_type',
|
|
6004
|
+
'result',
|
|
6005
|
+
],
|
|
6006
|
+
type: 'object',
|
|
6007
|
+
},
|
|
6008
|
+
{
|
|
6009
|
+
description: 'Simulating manual lock via keypad failed.',
|
|
6010
|
+
properties: {
|
|
6011
|
+
action_attempt_id: {
|
|
6012
|
+
description: 'ID of the action attempt.',
|
|
6013
|
+
format: 'uuid',
|
|
6014
|
+
type: 'string',
|
|
6015
|
+
},
|
|
6016
|
+
action_type: {
|
|
6017
|
+
enum: ['SIMULATE_MANUAL_LOCK_VIA_KEYPAD'],
|
|
6018
|
+
type: 'string',
|
|
6019
|
+
},
|
|
6020
|
+
error: {
|
|
6021
|
+
properties: {
|
|
6022
|
+
message: { type: 'string' },
|
|
6023
|
+
type: { type: 'string' },
|
|
6024
|
+
},
|
|
6025
|
+
required: ['type', 'message'],
|
|
6026
|
+
type: 'object',
|
|
6027
|
+
},
|
|
6028
|
+
result: {
|
|
6029
|
+
description:
|
|
6030
|
+
'Result of the action attempt. Null for failed action attempts.',
|
|
6031
|
+
nullable: true,
|
|
6032
|
+
},
|
|
6033
|
+
status: { enum: ['error'], type: 'string' },
|
|
6034
|
+
},
|
|
6035
|
+
required: [
|
|
6036
|
+
'action_attempt_id',
|
|
6037
|
+
'status',
|
|
6038
|
+
'result',
|
|
6039
|
+
'action_type',
|
|
6040
|
+
'error',
|
|
6041
|
+
],
|
|
6042
|
+
type: 'object',
|
|
6043
|
+
},
|
|
5848
6044
|
{
|
|
5849
6045
|
properties: {
|
|
5850
6046
|
action_attempt_id: {
|
|
@@ -13659,6 +13855,29 @@ export default {
|
|
|
13659
13855
|
],
|
|
13660
13856
|
'x-route-path': '/events',
|
|
13661
13857
|
},
|
|
13858
|
+
instant_key: {
|
|
13859
|
+
properties: {
|
|
13860
|
+
client_session_id: { format: 'uuid', type: 'string' },
|
|
13861
|
+
created_at: { format: 'date-time', type: 'string' },
|
|
13862
|
+
expires_at: { format: 'date-time', type: 'string' },
|
|
13863
|
+
instant_key_id: { format: 'uuid', type: 'string' },
|
|
13864
|
+
instant_key_url: { format: 'uri', type: 'string' },
|
|
13865
|
+
user_identity_id: { format: 'uuid', type: 'string' },
|
|
13866
|
+
workspace_id: { format: 'uuid', type: 'string' },
|
|
13867
|
+
},
|
|
13868
|
+
required: [
|
|
13869
|
+
'instant_key_id',
|
|
13870
|
+
'workspace_id',
|
|
13871
|
+
'created_at',
|
|
13872
|
+
'instant_key_url',
|
|
13873
|
+
'client_session_id',
|
|
13874
|
+
'user_identity_id',
|
|
13875
|
+
'expires_at',
|
|
13876
|
+
],
|
|
13877
|
+
type: 'object',
|
|
13878
|
+
'x-route-path': '/user_identities',
|
|
13879
|
+
'x-undocumented': 'Unreleased.',
|
|
13880
|
+
},
|
|
13662
13881
|
network: {
|
|
13663
13882
|
properties: {
|
|
13664
13883
|
created_at: { format: 'date-time', type: 'string' },
|
|
@@ -24683,18 +24902,15 @@ export default {
|
|
|
24683
24902
|
'x-response-key': 'device_providers',
|
|
24684
24903
|
},
|
|
24685
24904
|
},
|
|
24686
|
-
'/devices/simulate/
|
|
24905
|
+
'/devices/simulate/connect': {
|
|
24687
24906
|
post: {
|
|
24688
|
-
operationId: '
|
|
24907
|
+
operationId: 'devicesSimulateConnectPost',
|
|
24689
24908
|
requestBody: {
|
|
24690
24909
|
content: {
|
|
24691
24910
|
'application/json': {
|
|
24692
24911
|
schema: {
|
|
24693
|
-
properties: {
|
|
24694
|
-
|
|
24695
|
-
device_id: { format: 'uuid', type: 'string' },
|
|
24696
|
-
},
|
|
24697
|
-
required: ['device_id', 'access_code_id'],
|
|
24912
|
+
properties: { device_id: { format: 'uuid', type: 'string' } },
|
|
24913
|
+
required: ['device_id'],
|
|
24698
24914
|
type: 'object',
|
|
24699
24915
|
},
|
|
24700
24916
|
},
|
|
@@ -24721,26 +24937,22 @@ export default {
|
|
|
24721
24937
|
{ pat_with_workspace: [] },
|
|
24722
24938
|
{ console_session_with_workspace: [] },
|
|
24723
24939
|
],
|
|
24724
|
-
summary: '/devices/simulate/
|
|
24940
|
+
summary: '/devices/simulate/connect',
|
|
24725
24941
|
tags: ['/devices'],
|
|
24726
24942
|
'x-fern-sdk-group-name': ['devices', 'simulate'],
|
|
24727
|
-
'x-fern-sdk-method-name': '
|
|
24943
|
+
'x-fern-sdk-method-name': 'connect',
|
|
24728
24944
|
'x-response-key': null,
|
|
24729
|
-
'x-undocumented': 'Unreleased.',
|
|
24730
24945
|
},
|
|
24731
24946
|
},
|
|
24732
|
-
'/devices/simulate/
|
|
24947
|
+
'/devices/simulate/disconnect': {
|
|
24733
24948
|
post: {
|
|
24734
|
-
operationId: '
|
|
24949
|
+
operationId: 'devicesSimulateDisconnectPost',
|
|
24735
24950
|
requestBody: {
|
|
24736
24951
|
content: {
|
|
24737
24952
|
'application/json': {
|
|
24738
24953
|
schema: {
|
|
24739
|
-
properties: {
|
|
24740
|
-
|
|
24741
|
-
device_id: { format: 'uuid', type: 'string' },
|
|
24742
|
-
},
|
|
24743
|
-
required: ['device_id', 'access_code_id'],
|
|
24954
|
+
properties: { device_id: { format: 'uuid', type: 'string' } },
|
|
24955
|
+
required: ['device_id'],
|
|
24744
24956
|
type: 'object',
|
|
24745
24957
|
},
|
|
24746
24958
|
},
|
|
@@ -24767,17 +24979,16 @@ export default {
|
|
|
24767
24979
|
{ pat_with_workspace: [] },
|
|
24768
24980
|
{ console_session_with_workspace: [] },
|
|
24769
24981
|
],
|
|
24770
|
-
summary: '/devices/simulate/
|
|
24982
|
+
summary: '/devices/simulate/disconnect',
|
|
24771
24983
|
tags: ['/devices'],
|
|
24772
24984
|
'x-fern-sdk-group-name': ['devices', 'simulate'],
|
|
24773
|
-
'x-fern-sdk-method-name': '
|
|
24985
|
+
'x-fern-sdk-method-name': 'disconnect',
|
|
24774
24986
|
'x-response-key': null,
|
|
24775
|
-
'x-undocumented': 'Unreleased.',
|
|
24776
24987
|
},
|
|
24777
24988
|
},
|
|
24778
|
-
'/devices/simulate/
|
|
24989
|
+
'/devices/simulate/remove': {
|
|
24779
24990
|
post: {
|
|
24780
|
-
operationId: '
|
|
24991
|
+
operationId: 'devicesSimulateRemovePost',
|
|
24781
24992
|
requestBody: {
|
|
24782
24993
|
content: {
|
|
24783
24994
|
'application/json': {
|
|
@@ -24810,22 +25021,24 @@ export default {
|
|
|
24810
25021
|
{ pat_with_workspace: [] },
|
|
24811
25022
|
{ console_session_with_workspace: [] },
|
|
24812
25023
|
],
|
|
24813
|
-
summary: '/devices/simulate/
|
|
25024
|
+
summary: '/devices/simulate/remove',
|
|
24814
25025
|
tags: ['/devices'],
|
|
24815
25026
|
'x-fern-sdk-group-name': ['devices', 'simulate'],
|
|
24816
|
-
'x-fern-sdk-method-name': '
|
|
25027
|
+
'x-fern-sdk-method-name': 'remove',
|
|
24817
25028
|
'x-response-key': null,
|
|
24818
25029
|
},
|
|
24819
25030
|
},
|
|
24820
|
-
'/devices/
|
|
25031
|
+
'/devices/unmanaged/get': {
|
|
24821
25032
|
post: {
|
|
24822
|
-
operationId: '
|
|
25033
|
+
operationId: 'devicesUnmanagedGetPost',
|
|
24823
25034
|
requestBody: {
|
|
24824
25035
|
content: {
|
|
24825
25036
|
'application/json': {
|
|
24826
25037
|
schema: {
|
|
24827
|
-
properties: {
|
|
24828
|
-
|
|
25038
|
+
properties: {
|
|
25039
|
+
device_id: { format: 'uuid', type: 'string' },
|
|
25040
|
+
name: { type: 'string' },
|
|
25041
|
+
},
|
|
24829
25042
|
type: 'object',
|
|
24830
25043
|
},
|
|
24831
25044
|
},
|
|
@@ -24836,8 +25049,11 @@ export default {
|
|
|
24836
25049
|
content: {
|
|
24837
25050
|
'application/json': {
|
|
24838
25051
|
schema: {
|
|
24839
|
-
properties: {
|
|
24840
|
-
|
|
25052
|
+
properties: {
|
|
25053
|
+
device: { $ref: '#/components/schemas/unmanaged_device' },
|
|
25054
|
+
ok: { type: 'boolean' },
|
|
25055
|
+
},
|
|
25056
|
+
required: ['device', 'ok'],
|
|
24841
25057
|
type: 'object',
|
|
24842
25058
|
},
|
|
24843
25059
|
},
|
|
@@ -24848,101 +25064,12 @@ export default {
|
|
|
24848
25064
|
401: { description: 'Unauthorized' },
|
|
24849
25065
|
},
|
|
24850
25066
|
security: [
|
|
24851
|
-
{
|
|
25067
|
+
{ client_session: [] },
|
|
24852
25068
|
{ pat_with_workspace: [] },
|
|
24853
25069
|
{ console_session_with_workspace: [] },
|
|
25070
|
+
{ api_key: [] },
|
|
24854
25071
|
],
|
|
24855
|
-
summary: '/devices/
|
|
24856
|
-
tags: ['/devices'],
|
|
24857
|
-
'x-fern-sdk-group-name': ['devices', 'simulate'],
|
|
24858
|
-
'x-fern-sdk-method-name': 'disconnect',
|
|
24859
|
-
'x-response-key': null,
|
|
24860
|
-
},
|
|
24861
|
-
},
|
|
24862
|
-
'/devices/simulate/remove': {
|
|
24863
|
-
post: {
|
|
24864
|
-
operationId: 'devicesSimulateRemovePost',
|
|
24865
|
-
requestBody: {
|
|
24866
|
-
content: {
|
|
24867
|
-
'application/json': {
|
|
24868
|
-
schema: {
|
|
24869
|
-
properties: { device_id: { format: 'uuid', type: 'string' } },
|
|
24870
|
-
required: ['device_id'],
|
|
24871
|
-
type: 'object',
|
|
24872
|
-
},
|
|
24873
|
-
},
|
|
24874
|
-
},
|
|
24875
|
-
},
|
|
24876
|
-
responses: {
|
|
24877
|
-
200: {
|
|
24878
|
-
content: {
|
|
24879
|
-
'application/json': {
|
|
24880
|
-
schema: {
|
|
24881
|
-
properties: { ok: { type: 'boolean' } },
|
|
24882
|
-
required: ['ok'],
|
|
24883
|
-
type: 'object',
|
|
24884
|
-
},
|
|
24885
|
-
},
|
|
24886
|
-
},
|
|
24887
|
-
description: 'OK',
|
|
24888
|
-
},
|
|
24889
|
-
400: { description: 'Bad Request' },
|
|
24890
|
-
401: { description: 'Unauthorized' },
|
|
24891
|
-
},
|
|
24892
|
-
security: [
|
|
24893
|
-
{ api_key: [] },
|
|
24894
|
-
{ pat_with_workspace: [] },
|
|
24895
|
-
{ console_session_with_workspace: [] },
|
|
24896
|
-
],
|
|
24897
|
-
summary: '/devices/simulate/remove',
|
|
24898
|
-
tags: ['/devices'],
|
|
24899
|
-
'x-fern-sdk-group-name': ['devices', 'simulate'],
|
|
24900
|
-
'x-fern-sdk-method-name': 'remove',
|
|
24901
|
-
'x-response-key': null,
|
|
24902
|
-
},
|
|
24903
|
-
},
|
|
24904
|
-
'/devices/unmanaged/get': {
|
|
24905
|
-
post: {
|
|
24906
|
-
operationId: 'devicesUnmanagedGetPost',
|
|
24907
|
-
requestBody: {
|
|
24908
|
-
content: {
|
|
24909
|
-
'application/json': {
|
|
24910
|
-
schema: {
|
|
24911
|
-
properties: {
|
|
24912
|
-
device_id: { format: 'uuid', type: 'string' },
|
|
24913
|
-
name: { type: 'string' },
|
|
24914
|
-
},
|
|
24915
|
-
type: 'object',
|
|
24916
|
-
},
|
|
24917
|
-
},
|
|
24918
|
-
},
|
|
24919
|
-
},
|
|
24920
|
-
responses: {
|
|
24921
|
-
200: {
|
|
24922
|
-
content: {
|
|
24923
|
-
'application/json': {
|
|
24924
|
-
schema: {
|
|
24925
|
-
properties: {
|
|
24926
|
-
device: { $ref: '#/components/schemas/unmanaged_device' },
|
|
24927
|
-
ok: { type: 'boolean' },
|
|
24928
|
-
},
|
|
24929
|
-
required: ['device', 'ok'],
|
|
24930
|
-
type: 'object',
|
|
24931
|
-
},
|
|
24932
|
-
},
|
|
24933
|
-
},
|
|
24934
|
-
description: 'OK',
|
|
24935
|
-
},
|
|
24936
|
-
400: { description: 'Bad Request' },
|
|
24937
|
-
401: { description: 'Unauthorized' },
|
|
24938
|
-
},
|
|
24939
|
-
security: [
|
|
24940
|
-
{ client_session: [] },
|
|
24941
|
-
{ pat_with_workspace: [] },
|
|
24942
|
-
{ console_session_with_workspace: [] },
|
|
24943
|
-
{ api_key: [] },
|
|
24944
|
-
],
|
|
24945
|
-
summary: '/devices/unmanaged/get',
|
|
25072
|
+
summary: '/devices/unmanaged/get',
|
|
24946
25073
|
tags: ['/devices'],
|
|
24947
25074
|
'x-fern-sdk-group-name': ['devices', 'unmanaged'],
|
|
24948
25075
|
'x-fern-sdk-method-name': 'get',
|
|
@@ -26126,6 +26253,108 @@ export default {
|
|
|
26126
26253
|
'x-response-key': 'action_attempt',
|
|
26127
26254
|
},
|
|
26128
26255
|
},
|
|
26256
|
+
'/locks/simulate/keypad_code_entry': {
|
|
26257
|
+
post: {
|
|
26258
|
+
operationId: 'locksSimulateKeypadCodeEntryPost',
|
|
26259
|
+
requestBody: {
|
|
26260
|
+
content: {
|
|
26261
|
+
'application/json': {
|
|
26262
|
+
schema: {
|
|
26263
|
+
properties: {
|
|
26264
|
+
code: { type: 'string' },
|
|
26265
|
+
device_id: { format: 'uuid', type: 'string' },
|
|
26266
|
+
},
|
|
26267
|
+
required: ['device_id', 'code'],
|
|
26268
|
+
type: 'object',
|
|
26269
|
+
},
|
|
26270
|
+
},
|
|
26271
|
+
},
|
|
26272
|
+
},
|
|
26273
|
+
responses: {
|
|
26274
|
+
200: {
|
|
26275
|
+
content: {
|
|
26276
|
+
'application/json': {
|
|
26277
|
+
schema: {
|
|
26278
|
+
properties: {
|
|
26279
|
+
action_attempt: {
|
|
26280
|
+
$ref: '#/components/schemas/access_code',
|
|
26281
|
+
},
|
|
26282
|
+
ok: { type: 'boolean' },
|
|
26283
|
+
},
|
|
26284
|
+
required: ['ok'],
|
|
26285
|
+
type: 'object',
|
|
26286
|
+
},
|
|
26287
|
+
},
|
|
26288
|
+
},
|
|
26289
|
+
description: 'OK',
|
|
26290
|
+
},
|
|
26291
|
+
400: { description: 'Bad Request' },
|
|
26292
|
+
401: { description: 'Unauthorized' },
|
|
26293
|
+
},
|
|
26294
|
+
security: [
|
|
26295
|
+
{ api_key: [] },
|
|
26296
|
+
{ pat_with_workspace: [] },
|
|
26297
|
+
{ console_session_with_workspace: [] },
|
|
26298
|
+
],
|
|
26299
|
+
summary: '/locks/simulate/keypad_code_entry',
|
|
26300
|
+
tags: ['/locks'],
|
|
26301
|
+
'x-action-attempt-type': 'SIMULATE_KEYPAD_CODE_ENTRY',
|
|
26302
|
+
'x-fern-sdk-group-name': ['locks', 'simulate'],
|
|
26303
|
+
'x-fern-sdk-method-name': 'keypad_code_entry',
|
|
26304
|
+
'x-fern-sdk-return-value': 'action_attempt',
|
|
26305
|
+
'x-response-key': 'action_attempt',
|
|
26306
|
+
'x-undocumented': 'Unreleased.',
|
|
26307
|
+
},
|
|
26308
|
+
},
|
|
26309
|
+
'/locks/simulate/manual_lock_via_keypad': {
|
|
26310
|
+
post: {
|
|
26311
|
+
operationId: 'locksSimulateManualLockViaKeypadPost',
|
|
26312
|
+
requestBody: {
|
|
26313
|
+
content: {
|
|
26314
|
+
'application/json': {
|
|
26315
|
+
schema: {
|
|
26316
|
+
properties: { device_id: { format: 'uuid', type: 'string' } },
|
|
26317
|
+
required: ['device_id'],
|
|
26318
|
+
type: 'object',
|
|
26319
|
+
},
|
|
26320
|
+
},
|
|
26321
|
+
},
|
|
26322
|
+
},
|
|
26323
|
+
responses: {
|
|
26324
|
+
200: {
|
|
26325
|
+
content: {
|
|
26326
|
+
'application/json': {
|
|
26327
|
+
schema: {
|
|
26328
|
+
properties: {
|
|
26329
|
+
action_attempt: {
|
|
26330
|
+
$ref: '#/components/schemas/access_code',
|
|
26331
|
+
},
|
|
26332
|
+
ok: { type: 'boolean' },
|
|
26333
|
+
},
|
|
26334
|
+
required: ['ok'],
|
|
26335
|
+
type: 'object',
|
|
26336
|
+
},
|
|
26337
|
+
},
|
|
26338
|
+
},
|
|
26339
|
+
description: 'OK',
|
|
26340
|
+
},
|
|
26341
|
+
400: { description: 'Bad Request' },
|
|
26342
|
+
401: { description: 'Unauthorized' },
|
|
26343
|
+
},
|
|
26344
|
+
security: [
|
|
26345
|
+
{ api_key: [] },
|
|
26346
|
+
{ pat_with_workspace: [] },
|
|
26347
|
+
{ console_session_with_workspace: [] },
|
|
26348
|
+
],
|
|
26349
|
+
summary: '/locks/simulate/manual_lock_via_keypad',
|
|
26350
|
+
tags: ['/locks'],
|
|
26351
|
+
'x-action-attempt-type': 'SIMULATE_MANUAL_LOCK_VIA_KEYPAD',
|
|
26352
|
+
'x-fern-sdk-group-name': ['locks', 'simulate'],
|
|
26353
|
+
'x-fern-sdk-method-name': 'manual_lock_via_keypad',
|
|
26354
|
+
'x-response-key': null,
|
|
26355
|
+
'x-undocumented': 'Unreleased.',
|
|
26356
|
+
},
|
|
26357
|
+
},
|
|
26129
26358
|
'/locks/unlock_door': {
|
|
26130
26359
|
post: {
|
|
26131
26360
|
operationId: 'locksUnlockDoorPost',
|
|
@@ -28285,6 +28514,64 @@ export default {
|
|
|
28285
28514
|
'x-undocumented': 'Seam Bridge Client only.',
|
|
28286
28515
|
},
|
|
28287
28516
|
},
|
|
28517
|
+
'/seam/instant_key/v1/client_sessions/exchange_short_code': {
|
|
28518
|
+
post: {
|
|
28519
|
+
description:
|
|
28520
|
+
'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.',
|
|
28521
|
+
operationId: 'seamInstantKeyV1ClientSessionsExchangeShortCodePost',
|
|
28522
|
+
requestBody: {
|
|
28523
|
+
content: {
|
|
28524
|
+
'application/json': {
|
|
28525
|
+
schema: {
|
|
28526
|
+
properties: {
|
|
28527
|
+
short_code: {
|
|
28528
|
+
description:
|
|
28529
|
+
'The short code to exchange for a client session token',
|
|
28530
|
+
type: 'string',
|
|
28531
|
+
},
|
|
28532
|
+
},
|
|
28533
|
+
required: ['short_code'],
|
|
28534
|
+
type: 'object',
|
|
28535
|
+
},
|
|
28536
|
+
},
|
|
28537
|
+
},
|
|
28538
|
+
},
|
|
28539
|
+
responses: {
|
|
28540
|
+
200: {
|
|
28541
|
+
content: {
|
|
28542
|
+
'application/json': {
|
|
28543
|
+
schema: {
|
|
28544
|
+
properties: {
|
|
28545
|
+
client_session: {
|
|
28546
|
+
$ref: '#/components/schemas/client_session',
|
|
28547
|
+
},
|
|
28548
|
+
ok: { type: 'boolean' },
|
|
28549
|
+
},
|
|
28550
|
+
required: ['client_session', 'ok'],
|
|
28551
|
+
type: 'object',
|
|
28552
|
+
},
|
|
28553
|
+
},
|
|
28554
|
+
},
|
|
28555
|
+
description: 'OK',
|
|
28556
|
+
},
|
|
28557
|
+
400: { description: 'Bad Request' },
|
|
28558
|
+
401: { description: 'Unauthorized' },
|
|
28559
|
+
},
|
|
28560
|
+
security: [{ certified_client: [] }],
|
|
28561
|
+
summary: '/seam/instant_key/v1/client_sessions/exchange_short_code',
|
|
28562
|
+
tags: ['/client_sessions'],
|
|
28563
|
+
'x-fern-sdk-group-name': [
|
|
28564
|
+
'seam',
|
|
28565
|
+
'instant_key',
|
|
28566
|
+
'v1',
|
|
28567
|
+
'client_sessions',
|
|
28568
|
+
],
|
|
28569
|
+
'x-fern-sdk-method-name': 'exchange_short_code',
|
|
28570
|
+
'x-fern-sdk-return-value': 'client_session',
|
|
28571
|
+
'x-response-key': 'client_session',
|
|
28572
|
+
'x-title': 'Exchange Instant Key Short Code',
|
|
28573
|
+
},
|
|
28574
|
+
},
|
|
28288
28575
|
'/thermostats/activate_climate_preset': {
|
|
28289
28576
|
post: {
|
|
28290
28577
|
description:
|
|
@@ -30447,21 +30734,6 @@ export default {
|
|
|
30447
30734
|
},
|
|
30448
30735
|
{
|
|
30449
30736
|
properties: {
|
|
30450
|
-
desired_access_methods: {
|
|
30451
|
-
items: {
|
|
30452
|
-
properties: {
|
|
30453
|
-
mode: {
|
|
30454
|
-
description:
|
|
30455
|
-
'Access method mode. Supported values: `code`, `card`, `mobile_key`.',
|
|
30456
|
-
enum: ['code', 'card', 'mobile_key'],
|
|
30457
|
-
type: 'string',
|
|
30458
|
-
},
|
|
30459
|
-
},
|
|
30460
|
-
required: ['mode'],
|
|
30461
|
-
type: 'object',
|
|
30462
|
-
},
|
|
30463
|
-
type: 'array',
|
|
30464
|
-
},
|
|
30465
30737
|
ends_at: {
|
|
30466
30738
|
description:
|
|
30467
30739
|
'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`.',
|
|
@@ -30486,6 +30758,10 @@ export default {
|
|
|
30486
30758
|
items: { format: 'uuid', type: 'string' },
|
|
30487
30759
|
type: 'array',
|
|
30488
30760
|
},
|
|
30761
|
+
name: {
|
|
30762
|
+
description: 'Name of the location.',
|
|
30763
|
+
type: 'string',
|
|
30764
|
+
},
|
|
30489
30765
|
},
|
|
30490
30766
|
type: 'object',
|
|
30491
30767
|
},
|
|
@@ -30495,6 +30771,21 @@ export default {
|
|
|
30495
30771
|
items: { format: 'uuid', type: 'string' },
|
|
30496
30772
|
type: 'array',
|
|
30497
30773
|
},
|
|
30774
|
+
requested_access_methods: {
|
|
30775
|
+
items: {
|
|
30776
|
+
properties: {
|
|
30777
|
+
mode: {
|
|
30778
|
+
description:
|
|
30779
|
+
'Access method mode. Supported values: `code`, `card`, `mobile_key`.',
|
|
30780
|
+
enum: ['code', 'card', 'mobile_key'],
|
|
30781
|
+
type: 'string',
|
|
30782
|
+
},
|
|
30783
|
+
},
|
|
30784
|
+
required: ['mode'],
|
|
30785
|
+
type: 'object',
|
|
30786
|
+
},
|
|
30787
|
+
type: 'array',
|
|
30788
|
+
},
|
|
30498
30789
|
starts_at: {
|
|
30499
30790
|
description:
|
|
30500
30791
|
'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.',
|
|
@@ -30502,7 +30793,7 @@ export default {
|
|
|
30502
30793
|
type: 'string',
|
|
30503
30794
|
},
|
|
30504
30795
|
},
|
|
30505
|
-
required: ['
|
|
30796
|
+
required: ['requested_access_methods'],
|
|
30506
30797
|
type: 'object',
|
|
30507
30798
|
},
|
|
30508
30799
|
],
|
|
@@ -30523,6 +30814,12 @@ export default {
|
|
|
30523
30814
|
format: 'uuid',
|
|
30524
30815
|
type: 'string',
|
|
30525
30816
|
},
|
|
30817
|
+
access_method_ids: {
|
|
30818
|
+
description:
|
|
30819
|
+
'IDs of the access methods that were created for this access grant.',
|
|
30820
|
+
items: { format: 'uuid', type: 'string' },
|
|
30821
|
+
type: 'array',
|
|
30822
|
+
},
|
|
30526
30823
|
created_at: {
|
|
30527
30824
|
description:
|
|
30528
30825
|
'Date and time at which the access grant was created.',
|
|
@@ -30544,6 +30841,12 @@ export default {
|
|
|
30544
30841
|
'Access methods that the user requested for this access grant.',
|
|
30545
30842
|
items: {
|
|
30546
30843
|
properties: {
|
|
30844
|
+
created_access_method_ids: {
|
|
30845
|
+
description:
|
|
30846
|
+
'IDs of the access methods that were created for this requested access method.',
|
|
30847
|
+
items: { format: 'uuid', type: 'string' },
|
|
30848
|
+
type: 'array',
|
|
30849
|
+
},
|
|
30547
30850
|
created_at: {
|
|
30548
30851
|
description:
|
|
30549
30852
|
'Date and time at which the requested access method was added to this access grant.',
|
|
@@ -30561,18 +30864,12 @@ export default {
|
|
|
30561
30864
|
enum: ['code', 'card', 'mobile_key'],
|
|
30562
30865
|
type: 'string',
|
|
30563
30866
|
},
|
|
30564
|
-
provisioned_access_method_ids: {
|
|
30565
|
-
description:
|
|
30566
|
-
'IDs of the locations to which access is being given.',
|
|
30567
|
-
items: { format: 'uuid', type: 'string' },
|
|
30568
|
-
type: 'array',
|
|
30569
|
-
},
|
|
30570
30867
|
},
|
|
30571
30868
|
required: [
|
|
30572
30869
|
'display_name',
|
|
30573
30870
|
'mode',
|
|
30574
30871
|
'created_at',
|
|
30575
|
-
'
|
|
30872
|
+
'created_access_method_ids',
|
|
30576
30873
|
],
|
|
30577
30874
|
type: 'object',
|
|
30578
30875
|
'x-undocumented': 'Unreleased.',
|
|
@@ -30598,6 +30895,7 @@ export default {
|
|
|
30598
30895
|
'user_identity_id',
|
|
30599
30896
|
'location_ids',
|
|
30600
30897
|
'requested_access_methods',
|
|
30898
|
+
'access_method_ids',
|
|
30601
30899
|
'display_name',
|
|
30602
30900
|
'created_at',
|
|
30603
30901
|
],
|
|
@@ -30665,6 +30963,12 @@ export default {
|
|
|
30665
30963
|
format: 'uuid',
|
|
30666
30964
|
type: 'string',
|
|
30667
30965
|
},
|
|
30966
|
+
access_method_ids: {
|
|
30967
|
+
description:
|
|
30968
|
+
'IDs of the access methods that were created for this access grant.',
|
|
30969
|
+
items: { format: 'uuid', type: 'string' },
|
|
30970
|
+
type: 'array',
|
|
30971
|
+
},
|
|
30668
30972
|
created_at: {
|
|
30669
30973
|
description:
|
|
30670
30974
|
'Date and time at which the access grant was created.',
|
|
@@ -30686,6 +30990,12 @@ export default {
|
|
|
30686
30990
|
'Access methods that the user requested for this access grant.',
|
|
30687
30991
|
items: {
|
|
30688
30992
|
properties: {
|
|
30993
|
+
created_access_method_ids: {
|
|
30994
|
+
description:
|
|
30995
|
+
'IDs of the access methods that were created for this requested access method.',
|
|
30996
|
+
items: { format: 'uuid', type: 'string' },
|
|
30997
|
+
type: 'array',
|
|
30998
|
+
},
|
|
30689
30999
|
created_at: {
|
|
30690
31000
|
description:
|
|
30691
31001
|
'Date and time at which the requested access method was added to this access grant.',
|
|
@@ -30703,18 +31013,12 @@ export default {
|
|
|
30703
31013
|
enum: ['code', 'card', 'mobile_key'],
|
|
30704
31014
|
type: 'string',
|
|
30705
31015
|
},
|
|
30706
|
-
provisioned_access_method_ids: {
|
|
30707
|
-
description:
|
|
30708
|
-
'IDs of the locations to which access is being given.',
|
|
30709
|
-
items: { format: 'uuid', type: 'string' },
|
|
30710
|
-
type: 'array',
|
|
30711
|
-
},
|
|
30712
31016
|
},
|
|
30713
31017
|
required: [
|
|
30714
31018
|
'display_name',
|
|
30715
31019
|
'mode',
|
|
30716
31020
|
'created_at',
|
|
30717
|
-
'
|
|
31021
|
+
'created_access_method_ids',
|
|
30718
31022
|
],
|
|
30719
31023
|
type: 'object',
|
|
30720
31024
|
'x-undocumented': 'Unreleased.',
|
|
@@ -30740,6 +31044,7 @@ export default {
|
|
|
30740
31044
|
'user_identity_id',
|
|
30741
31045
|
'location_ids',
|
|
30742
31046
|
'requested_access_methods',
|
|
31047
|
+
'access_method_ids',
|
|
30743
31048
|
'display_name',
|
|
30744
31049
|
'created_at',
|
|
30745
31050
|
],
|
|
@@ -30826,6 +31131,12 @@ export default {
|
|
|
30826
31131
|
format: 'uuid',
|
|
30827
31132
|
type: 'string',
|
|
30828
31133
|
},
|
|
31134
|
+
access_method_ids: {
|
|
31135
|
+
description:
|
|
31136
|
+
'IDs of the access methods that were created for this access grant.',
|
|
31137
|
+
items: { format: 'uuid', type: 'string' },
|
|
31138
|
+
type: 'array',
|
|
31139
|
+
},
|
|
30829
31140
|
created_at: {
|
|
30830
31141
|
description:
|
|
30831
31142
|
'Date and time at which the access grant was created.',
|
|
@@ -30847,6 +31158,12 @@ export default {
|
|
|
30847
31158
|
'Access methods that the user requested for this access grant.',
|
|
30848
31159
|
items: {
|
|
30849
31160
|
properties: {
|
|
31161
|
+
created_access_method_ids: {
|
|
31162
|
+
description:
|
|
31163
|
+
'IDs of the access methods that were created for this requested access method.',
|
|
31164
|
+
items: { format: 'uuid', type: 'string' },
|
|
31165
|
+
type: 'array',
|
|
31166
|
+
},
|
|
30850
31167
|
created_at: {
|
|
30851
31168
|
description:
|
|
30852
31169
|
'Date and time at which the requested access method was added to this access grant.',
|
|
@@ -30864,18 +31181,12 @@ export default {
|
|
|
30864
31181
|
enum: ['code', 'card', 'mobile_key'],
|
|
30865
31182
|
type: 'string',
|
|
30866
31183
|
},
|
|
30867
|
-
provisioned_access_method_ids: {
|
|
30868
|
-
description:
|
|
30869
|
-
'IDs of the locations to which access is being given.',
|
|
30870
|
-
items: { format: 'uuid', type: 'string' },
|
|
30871
|
-
type: 'array',
|
|
30872
|
-
},
|
|
30873
31184
|
},
|
|
30874
31185
|
required: [
|
|
30875
31186
|
'display_name',
|
|
30876
31187
|
'mode',
|
|
30877
31188
|
'created_at',
|
|
30878
|
-
'
|
|
31189
|
+
'created_access_method_ids',
|
|
30879
31190
|
],
|
|
30880
31191
|
type: 'object',
|
|
30881
31192
|
'x-undocumented': 'Unreleased.',
|
|
@@ -30901,6 +31212,7 @@ export default {
|
|
|
30901
31212
|
'user_identity_id',
|
|
30902
31213
|
'location_ids',
|
|
30903
31214
|
'requested_access_methods',
|
|
31215
|
+
'access_method_ids',
|
|
30904
31216
|
'display_name',
|
|
30905
31217
|
'created_at',
|
|
30906
31218
|
],
|
|
@@ -30936,10 +31248,11 @@ export default {
|
|
|
30936
31248
|
'x-undocumented': 'Unreleased.',
|
|
30937
31249
|
},
|
|
30938
31250
|
},
|
|
30939
|
-
'/
|
|
31251
|
+
'/unstable_access_methods/list': {
|
|
30940
31252
|
post: {
|
|
30941
|
-
description:
|
|
30942
|
-
|
|
31253
|
+
description:
|
|
31254
|
+
'List all access methods, usually filtered by access grant.',
|
|
31255
|
+
operationId: 'unstableAccessMethodsListPost',
|
|
30943
31256
|
requestBody: {
|
|
30944
31257
|
content: {
|
|
30945
31258
|
'application/json': {
|
|
@@ -31032,13 +31345,13 @@ export default {
|
|
|
31032
31345
|
{ console_session_with_workspace: [] },
|
|
31033
31346
|
{ api_key: [] },
|
|
31034
31347
|
],
|
|
31035
|
-
summary: '/
|
|
31348
|
+
summary: '/unstable_access_methods/list',
|
|
31036
31349
|
tags: [],
|
|
31037
|
-
'x-fern-sdk-group-name': ['
|
|
31038
|
-
'x-fern-sdk-method-name': '
|
|
31350
|
+
'x-fern-sdk-group-name': ['unstable_access_methods'],
|
|
31351
|
+
'x-fern-sdk-method-name': 'list',
|
|
31039
31352
|
'x-fern-sdk-return-value': 'access_methods',
|
|
31040
31353
|
'x-response-key': 'access_methods',
|
|
31041
|
-
'x-title': '
|
|
31354
|
+
'x-title': 'List Access Methods',
|
|
31042
31355
|
'x-undocumented': 'Unreleased.',
|
|
31043
31356
|
},
|
|
31044
31357
|
},
|
|
@@ -32357,6 +32670,62 @@ export default {
|
|
|
32357
32670
|
'x-title': 'List Enrollment Automations',
|
|
32358
32671
|
},
|
|
32359
32672
|
},
|
|
32673
|
+
'/user_identities/generate_instant_key': {
|
|
32674
|
+
post: {
|
|
32675
|
+
description:
|
|
32676
|
+
'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).',
|
|
32677
|
+
operationId: 'userIdentitiesGenerateInstantKeyPost',
|
|
32678
|
+
requestBody: {
|
|
32679
|
+
content: {
|
|
32680
|
+
'application/json': {
|
|
32681
|
+
schema: {
|
|
32682
|
+
properties: {
|
|
32683
|
+
user_identity_id: {
|
|
32684
|
+
description:
|
|
32685
|
+
'ID of the user identity for which you want to generate an instant key.',
|
|
32686
|
+
format: 'uuid',
|
|
32687
|
+
type: 'string',
|
|
32688
|
+
},
|
|
32689
|
+
},
|
|
32690
|
+
required: ['user_identity_id'],
|
|
32691
|
+
type: 'object',
|
|
32692
|
+
},
|
|
32693
|
+
},
|
|
32694
|
+
},
|
|
32695
|
+
},
|
|
32696
|
+
responses: {
|
|
32697
|
+
200: {
|
|
32698
|
+
content: {
|
|
32699
|
+
'application/json': {
|
|
32700
|
+
schema: {
|
|
32701
|
+
properties: {
|
|
32702
|
+
instant_key: { $ref: '#/components/schemas/instant_key' },
|
|
32703
|
+
ok: { type: 'boolean' },
|
|
32704
|
+
},
|
|
32705
|
+
required: ['instant_key', 'ok'],
|
|
32706
|
+
type: 'object',
|
|
32707
|
+
},
|
|
32708
|
+
},
|
|
32709
|
+
},
|
|
32710
|
+
description: 'OK',
|
|
32711
|
+
},
|
|
32712
|
+
400: { description: 'Bad Request' },
|
|
32713
|
+
401: { description: 'Unauthorized' },
|
|
32714
|
+
},
|
|
32715
|
+
security: [
|
|
32716
|
+
{ api_key: [] },
|
|
32717
|
+
{ pat_with_workspace: [] },
|
|
32718
|
+
{ console_session_with_workspace: [] },
|
|
32719
|
+
],
|
|
32720
|
+
summary: '/user_identities/generate_instant_key',
|
|
32721
|
+
tags: ['/user_identities'],
|
|
32722
|
+
'x-fern-sdk-group-name': ['user_identities'],
|
|
32723
|
+
'x-fern-sdk-method-name': 'generate_instant_key',
|
|
32724
|
+
'x-fern-sdk-return-value': 'instant_key',
|
|
32725
|
+
'x-response-key': 'instant_key',
|
|
32726
|
+
'x-title': 'Generate an Instant Key',
|
|
32727
|
+
},
|
|
32728
|
+
},
|
|
32360
32729
|
'/user_identities/get': {
|
|
32361
32730
|
post: {
|
|
32362
32731
|
description:
|