@seamapi/types 1.382.0 → 1.384.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 +315 -9
- package/dist/connect.cjs.map +1 -1
- package/dist/connect.d.cts +450 -2
- 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/bridges/bridge-client-session.d.ts +9 -0
- package/lib/seam/connect/models/bridges/bridge-client-session.js +3 -0
- package/lib/seam/connect/models/bridges/bridge-client-session.js.map +1 -1
- 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 +332 -0
- package/lib/seam/connect/openapi.js +288 -0
- package/lib/seam/connect/openapi.js.map +1 -1
- package/lib/seam/connect/route-types.d.ts +79 -0
- 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/bridges/bridge-client-session.ts +3 -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 +303 -0
- package/src/lib/seam/connect/route-types.ts +82 -0
- package/src/lib/seam/connect/schemas.ts +1 -0
|
@@ -12502,6 +12502,29 @@ export default {
|
|
|
12502
12502
|
],
|
|
12503
12503
|
'x-route-path': '/events',
|
|
12504
12504
|
},
|
|
12505
|
+
instant_key: {
|
|
12506
|
+
properties: {
|
|
12507
|
+
client_session_id: { format: 'uuid', type: 'string' },
|
|
12508
|
+
created_at: { format: 'date-time', type: 'string' },
|
|
12509
|
+
expires_at: { format: 'date-time', type: 'string' },
|
|
12510
|
+
instant_key_id: { format: 'uuid', type: 'string' },
|
|
12511
|
+
instant_key_url: { format: 'uri', type: 'string' },
|
|
12512
|
+
user_identity_id: { format: 'uuid', type: 'string' },
|
|
12513
|
+
workspace_id: { format: 'uuid', type: 'string' },
|
|
12514
|
+
},
|
|
12515
|
+
required: [
|
|
12516
|
+
'instant_key_id',
|
|
12517
|
+
'workspace_id',
|
|
12518
|
+
'created_at',
|
|
12519
|
+
'instant_key_url',
|
|
12520
|
+
'client_session_id',
|
|
12521
|
+
'user_identity_id',
|
|
12522
|
+
'expires_at',
|
|
12523
|
+
],
|
|
12524
|
+
type: 'object',
|
|
12525
|
+
'x-route-path': '/user_identities',
|
|
12526
|
+
'x-undocumented': 'Unreleased.',
|
|
12527
|
+
},
|
|
12505
12528
|
network: {
|
|
12506
12529
|
properties: {
|
|
12507
12530
|
created_at: { format: 'date-time', type: 'string' },
|
|
@@ -25447,6 +25470,13 @@ export default {
|
|
|
25447
25470
|
},
|
|
25448
25471
|
tailscale_auth_key: { nullable: true, type: 'string' },
|
|
25449
25472
|
tailscale_hostname: { type: 'string' },
|
|
25473
|
+
telemetry_token: { nullable: true, type: 'string' },
|
|
25474
|
+
telemetry_token_expires_at: {
|
|
25475
|
+
format: 'date-time',
|
|
25476
|
+
nullable: true,
|
|
25477
|
+
type: 'string',
|
|
25478
|
+
},
|
|
25479
|
+
telemetry_url: { nullable: true, type: 'string' },
|
|
25450
25480
|
},
|
|
25451
25481
|
required: [
|
|
25452
25482
|
'created_at',
|
|
@@ -25460,6 +25490,9 @@ export default {
|
|
|
25460
25490
|
'bridge_client_time_zone',
|
|
25461
25491
|
'bridge_client_machine_identifier_key',
|
|
25462
25492
|
'errors',
|
|
25493
|
+
'telemetry_token',
|
|
25494
|
+
'telemetry_token_expires_at',
|
|
25495
|
+
'telemetry_url',
|
|
25463
25496
|
],
|
|
25464
25497
|
type: 'object',
|
|
25465
25498
|
'x-route-path': '/seam/bridge/v1/bridge_client_sessions',
|
|
@@ -25608,6 +25641,13 @@ export default {
|
|
|
25608
25641
|
},
|
|
25609
25642
|
tailscale_auth_key: { nullable: true, type: 'string' },
|
|
25610
25643
|
tailscale_hostname: { type: 'string' },
|
|
25644
|
+
telemetry_token: { nullable: true, type: 'string' },
|
|
25645
|
+
telemetry_token_expires_at: {
|
|
25646
|
+
format: 'date-time',
|
|
25647
|
+
nullable: true,
|
|
25648
|
+
type: 'string',
|
|
25649
|
+
},
|
|
25650
|
+
telemetry_url: { nullable: true, type: 'string' },
|
|
25611
25651
|
},
|
|
25612
25652
|
required: [
|
|
25613
25653
|
'created_at',
|
|
@@ -25621,6 +25661,9 @@ export default {
|
|
|
25621
25661
|
'bridge_client_time_zone',
|
|
25622
25662
|
'bridge_client_machine_identifier_key',
|
|
25623
25663
|
'errors',
|
|
25664
|
+
'telemetry_token',
|
|
25665
|
+
'telemetry_token_expires_at',
|
|
25666
|
+
'telemetry_url',
|
|
25624
25667
|
],
|
|
25625
25668
|
type: 'object',
|
|
25626
25669
|
'x-route-path': '/seam/bridge/v1/bridge_client_sessions',
|
|
@@ -25760,6 +25803,13 @@ export default {
|
|
|
25760
25803
|
},
|
|
25761
25804
|
tailscale_auth_key: { nullable: true, type: 'string' },
|
|
25762
25805
|
tailscale_hostname: { type: 'string' },
|
|
25806
|
+
telemetry_token: { nullable: true, type: 'string' },
|
|
25807
|
+
telemetry_token_expires_at: {
|
|
25808
|
+
format: 'date-time',
|
|
25809
|
+
nullable: true,
|
|
25810
|
+
type: 'string',
|
|
25811
|
+
},
|
|
25812
|
+
telemetry_url: { nullable: true, type: 'string' },
|
|
25763
25813
|
},
|
|
25764
25814
|
required: [
|
|
25765
25815
|
'created_at',
|
|
@@ -25773,6 +25823,9 @@ export default {
|
|
|
25773
25823
|
'bridge_client_time_zone',
|
|
25774
25824
|
'bridge_client_machine_identifier_key',
|
|
25775
25825
|
'errors',
|
|
25826
|
+
'telemetry_token',
|
|
25827
|
+
'telemetry_token_expires_at',
|
|
25828
|
+
'telemetry_url',
|
|
25776
25829
|
],
|
|
25777
25830
|
type: 'object',
|
|
25778
25831
|
'x-route-path': '/seam/bridge/v1/bridge_client_sessions',
|
|
@@ -25806,6 +25859,177 @@ export default {
|
|
|
25806
25859
|
'x-undocumented': 'Seam Bridge Client only.',
|
|
25807
25860
|
},
|
|
25808
25861
|
},
|
|
25862
|
+
'/seam/bridge/v1/bridge_client_sessions/refresh_telemetry_token': {
|
|
25863
|
+
post: {
|
|
25864
|
+
description: 'Returns the bridge client session associated with the session token and refreshed telemetry token.',
|
|
25865
|
+
operationId: 'seamBridgeV1BridgeClientSessionsRefreshTelemetryTokenPost',
|
|
25866
|
+
responses: {
|
|
25867
|
+
200: {
|
|
25868
|
+
content: {
|
|
25869
|
+
'application/json': {
|
|
25870
|
+
schema: {
|
|
25871
|
+
properties: {
|
|
25872
|
+
bridge_client_session: {
|
|
25873
|
+
properties: {
|
|
25874
|
+
bridge_client_machine_identifier_key: {
|
|
25875
|
+
type: 'string',
|
|
25876
|
+
},
|
|
25877
|
+
bridge_client_name: { type: 'string' },
|
|
25878
|
+
bridge_client_session_id: {
|
|
25879
|
+
format: 'uuid',
|
|
25880
|
+
type: 'string',
|
|
25881
|
+
},
|
|
25882
|
+
bridge_client_session_token: { type: 'string' },
|
|
25883
|
+
bridge_client_time_zone: { type: 'string' },
|
|
25884
|
+
created_at: { format: 'date-time', type: 'string' },
|
|
25885
|
+
errors: {
|
|
25886
|
+
items: {
|
|
25887
|
+
description: 'Error associated with the `bridge_client_session`.',
|
|
25888
|
+
discriminator: { propertyName: 'error_code' },
|
|
25889
|
+
oneOf: [
|
|
25890
|
+
{
|
|
25891
|
+
description: "Seam cannot reach the bridge's LAN",
|
|
25892
|
+
properties: {
|
|
25893
|
+
can_tailscale_proxy_reach_bridge: {
|
|
25894
|
+
description: 'Tailscale proxy cannot reach the bridge',
|
|
25895
|
+
nullable: true,
|
|
25896
|
+
type: 'boolean',
|
|
25897
|
+
},
|
|
25898
|
+
can_tailscale_proxy_reach_tailscale_network: {
|
|
25899
|
+
description: 'Tailscale proxy cannot reach the Tailscale network',
|
|
25900
|
+
nullable: true,
|
|
25901
|
+
type: 'boolean',
|
|
25902
|
+
},
|
|
25903
|
+
created_at: {
|
|
25904
|
+
format: 'date-time',
|
|
25905
|
+
type: 'string',
|
|
25906
|
+
},
|
|
25907
|
+
error_code: {
|
|
25908
|
+
description: 'Unique identifier of the type of error. Enables quick recognition and categorization of the issue.',
|
|
25909
|
+
enum: ['bridge_lan_unreachable'],
|
|
25910
|
+
type: 'string',
|
|
25911
|
+
},
|
|
25912
|
+
is_bridge_socks_server_healthy: {
|
|
25913
|
+
description: "Bridge's SOCKS server is unhealthy",
|
|
25914
|
+
nullable: true,
|
|
25915
|
+
type: 'boolean',
|
|
25916
|
+
},
|
|
25917
|
+
is_tailscale_proxy_reachable: {
|
|
25918
|
+
description: 'Seam cannot reach the tailscale proxy',
|
|
25919
|
+
nullable: true,
|
|
25920
|
+
type: 'boolean',
|
|
25921
|
+
},
|
|
25922
|
+
is_tailscale_proxy_socks_server_healthy: {
|
|
25923
|
+
description: "Tailscale proxy's SOCKS server is unhealthy",
|
|
25924
|
+
nullable: true,
|
|
25925
|
+
type: 'boolean',
|
|
25926
|
+
},
|
|
25927
|
+
message: { type: 'string' },
|
|
25928
|
+
},
|
|
25929
|
+
required: [
|
|
25930
|
+
'message',
|
|
25931
|
+
'created_at',
|
|
25932
|
+
'error_code',
|
|
25933
|
+
'is_tailscale_proxy_reachable',
|
|
25934
|
+
'is_tailscale_proxy_socks_server_healthy',
|
|
25935
|
+
'can_tailscale_proxy_reach_tailscale_network',
|
|
25936
|
+
'can_tailscale_proxy_reach_bridge',
|
|
25937
|
+
'is_bridge_socks_server_healthy',
|
|
25938
|
+
],
|
|
25939
|
+
type: 'object',
|
|
25940
|
+
},
|
|
25941
|
+
{
|
|
25942
|
+
description: 'Bridge has stopped communicating with Seam',
|
|
25943
|
+
properties: {
|
|
25944
|
+
created_at: {
|
|
25945
|
+
format: 'date-time',
|
|
25946
|
+
type: 'string',
|
|
25947
|
+
},
|
|
25948
|
+
error_code: {
|
|
25949
|
+
description: 'Unique identifier of the type of error. Enables quick recognition and categorization of the issue.',
|
|
25950
|
+
enum: ['no_communication_from_bridge'],
|
|
25951
|
+
type: 'string',
|
|
25952
|
+
},
|
|
25953
|
+
message: { type: 'string' },
|
|
25954
|
+
},
|
|
25955
|
+
required: [
|
|
25956
|
+
'message',
|
|
25957
|
+
'created_at',
|
|
25958
|
+
'error_code',
|
|
25959
|
+
],
|
|
25960
|
+
type: 'object',
|
|
25961
|
+
},
|
|
25962
|
+
],
|
|
25963
|
+
},
|
|
25964
|
+
type: 'array',
|
|
25965
|
+
},
|
|
25966
|
+
pairing_code: {
|
|
25967
|
+
maxLength: 6,
|
|
25968
|
+
minLength: 6,
|
|
25969
|
+
type: 'string',
|
|
25970
|
+
},
|
|
25971
|
+
pairing_code_expires_at: {
|
|
25972
|
+
format: 'date-time',
|
|
25973
|
+
type: 'string',
|
|
25974
|
+
},
|
|
25975
|
+
tailscale_auth_key: { nullable: true, type: 'string' },
|
|
25976
|
+
tailscale_hostname: { type: 'string' },
|
|
25977
|
+
telemetry_token: { nullable: true, type: 'string' },
|
|
25978
|
+
telemetry_token_expires_at: {
|
|
25979
|
+
format: 'date-time',
|
|
25980
|
+
nullable: true,
|
|
25981
|
+
type: 'string',
|
|
25982
|
+
},
|
|
25983
|
+
telemetry_url: { nullable: true, type: 'string' },
|
|
25984
|
+
},
|
|
25985
|
+
required: [
|
|
25986
|
+
'created_at',
|
|
25987
|
+
'bridge_client_session_id',
|
|
25988
|
+
'bridge_client_session_token',
|
|
25989
|
+
'pairing_code',
|
|
25990
|
+
'pairing_code_expires_at',
|
|
25991
|
+
'tailscale_hostname',
|
|
25992
|
+
'tailscale_auth_key',
|
|
25993
|
+
'bridge_client_name',
|
|
25994
|
+
'bridge_client_time_zone',
|
|
25995
|
+
'bridge_client_machine_identifier_key',
|
|
25996
|
+
'errors',
|
|
25997
|
+
'telemetry_token',
|
|
25998
|
+
'telemetry_token_expires_at',
|
|
25999
|
+
'telemetry_url',
|
|
26000
|
+
],
|
|
26001
|
+
type: 'object',
|
|
26002
|
+
'x-route-path': '/seam/bridge/v1/bridge_client_sessions',
|
|
26003
|
+
'x-undocumented': 'Seam Bridge Client only.',
|
|
26004
|
+
},
|
|
26005
|
+
ok: { type: 'boolean' },
|
|
26006
|
+
},
|
|
26007
|
+
required: ['bridge_client_session', 'ok'],
|
|
26008
|
+
type: 'object',
|
|
26009
|
+
},
|
|
26010
|
+
},
|
|
26011
|
+
},
|
|
26012
|
+
description: 'OK',
|
|
26013
|
+
},
|
|
26014
|
+
400: { description: 'Bad Request' },
|
|
26015
|
+
401: { description: 'Unauthorized' },
|
|
26016
|
+
},
|
|
26017
|
+
security: [{ bridge_client_session: [] }],
|
|
26018
|
+
summary: '/seam/bridge/v1/bridge_client_sessions/refresh_telemetry_token',
|
|
26019
|
+
tags: [],
|
|
26020
|
+
'x-fern-sdk-group-name': [
|
|
26021
|
+
'seam',
|
|
26022
|
+
'bridge',
|
|
26023
|
+
'v1',
|
|
26024
|
+
'bridge_client_sessions',
|
|
26025
|
+
],
|
|
26026
|
+
'x-fern-sdk-method-name': 'refresh_telemetry_token',
|
|
26027
|
+
'x-fern-sdk-return-value': 'bridge_client_session',
|
|
26028
|
+
'x-response-key': 'bridge_client_session',
|
|
26029
|
+
'x-title': 'Refresh telemetry token for bridge client session',
|
|
26030
|
+
'x-undocumented': 'Seam Bridge Client only.',
|
|
26031
|
+
},
|
|
26032
|
+
},
|
|
25809
26033
|
'/seam/bridge/v1/bridge_client_sessions/regenerate_pairing_code': {
|
|
25810
26034
|
post: {
|
|
25811
26035
|
description: 'Generate a new pairing code and return the updated bridge client session.',
|
|
@@ -25921,6 +26145,13 @@ export default {
|
|
|
25921
26145
|
},
|
|
25922
26146
|
tailscale_auth_key: { nullable: true, type: 'string' },
|
|
25923
26147
|
tailscale_hostname: { type: 'string' },
|
|
26148
|
+
telemetry_token: { nullable: true, type: 'string' },
|
|
26149
|
+
telemetry_token_expires_at: {
|
|
26150
|
+
format: 'date-time',
|
|
26151
|
+
nullable: true,
|
|
26152
|
+
type: 'string',
|
|
26153
|
+
},
|
|
26154
|
+
telemetry_url: { nullable: true, type: 'string' },
|
|
25924
26155
|
},
|
|
25925
26156
|
required: [
|
|
25926
26157
|
'created_at',
|
|
@@ -25934,6 +26165,9 @@ export default {
|
|
|
25934
26165
|
'bridge_client_time_zone',
|
|
25935
26166
|
'bridge_client_machine_identifier_key',
|
|
25936
26167
|
'errors',
|
|
26168
|
+
'telemetry_token',
|
|
26169
|
+
'telemetry_token_expires_at',
|
|
26170
|
+
'telemetry_url',
|
|
25937
26171
|
],
|
|
25938
26172
|
type: 'object',
|
|
25939
26173
|
'x-route-path': '/seam/bridge/v1/bridge_client_sessions',
|
|
@@ -30026,6 +30260,60 @@ export default {
|
|
|
30026
30260
|
'x-title': 'List Enrollment Automations',
|
|
30027
30261
|
},
|
|
30028
30262
|
},
|
|
30263
|
+
'/user_identities/generate_instant_key': {
|
|
30264
|
+
post: {
|
|
30265
|
+
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).',
|
|
30266
|
+
operationId: 'userIdentitiesGenerateInstantKeyPost',
|
|
30267
|
+
requestBody: {
|
|
30268
|
+
content: {
|
|
30269
|
+
'application/json': {
|
|
30270
|
+
schema: {
|
|
30271
|
+
properties: {
|
|
30272
|
+
user_identity_id: {
|
|
30273
|
+
description: 'ID of the user identity for which you want to generate an instant key.',
|
|
30274
|
+
format: 'uuid',
|
|
30275
|
+
type: 'string',
|
|
30276
|
+
},
|
|
30277
|
+
},
|
|
30278
|
+
required: ['user_identity_id'],
|
|
30279
|
+
type: 'object',
|
|
30280
|
+
},
|
|
30281
|
+
},
|
|
30282
|
+
},
|
|
30283
|
+
},
|
|
30284
|
+
responses: {
|
|
30285
|
+
200: {
|
|
30286
|
+
content: {
|
|
30287
|
+
'application/json': {
|
|
30288
|
+
schema: {
|
|
30289
|
+
properties: {
|
|
30290
|
+
instant_key: { $ref: '#/components/schemas/instant_key' },
|
|
30291
|
+
ok: { type: 'boolean' },
|
|
30292
|
+
},
|
|
30293
|
+
required: ['instant_key', 'ok'],
|
|
30294
|
+
type: 'object',
|
|
30295
|
+
},
|
|
30296
|
+
},
|
|
30297
|
+
},
|
|
30298
|
+
description: 'OK',
|
|
30299
|
+
},
|
|
30300
|
+
400: { description: 'Bad Request' },
|
|
30301
|
+
401: { description: 'Unauthorized' },
|
|
30302
|
+
},
|
|
30303
|
+
security: [
|
|
30304
|
+
{ api_key: [] },
|
|
30305
|
+
{ pat_with_workspace: [] },
|
|
30306
|
+
{ console_session_with_workspace: [] },
|
|
30307
|
+
],
|
|
30308
|
+
summary: '/user_identities/generate_instant_key',
|
|
30309
|
+
tags: ['/user_identities'],
|
|
30310
|
+
'x-fern-sdk-group-name': ['user_identities'],
|
|
30311
|
+
'x-fern-sdk-method-name': 'generate_instant_key',
|
|
30312
|
+
'x-fern-sdk-return-value': 'instant_key',
|
|
30313
|
+
'x-response-key': 'instant_key',
|
|
30314
|
+
'x-title': 'Generate an Instant Key',
|
|
30315
|
+
},
|
|
30316
|
+
},
|
|
30029
30317
|
'/user_identities/get': {
|
|
30030
30318
|
post: {
|
|
30031
30319
|
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).',
|