@seamapi/types 1.406.5 → 1.406.7
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 +75 -175
- package/dist/connect.cjs.map +1 -1
- package/dist/connect.d.cts +140 -241
- 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/models/client-sessions/client-session.d.ts +3 -0
- package/lib/seam/connect/models/client-sessions/client-session.js +4 -3
- package/lib/seam/connect/models/client-sessions/client-session.js.map +1 -1
- package/lib/seam/connect/models/partner/index.d.ts +1 -0
- package/lib/seam/connect/models/partner/index.js +1 -0
- package/lib/seam/connect/models/partner/index.js.map +1 -1
- package/lib/seam/connect/models/partner/magic-link.d.ts +27 -0
- package/lib/seam/connect/models/partner/magic-link.js +16 -0
- package/lib/seam/connect/models/partner/magic-link.js.map +1 -0
- package/lib/seam/connect/models/partner/resources.d.ts +2 -2
- package/lib/seam/connect/models/partner/resources.js +6 -1
- package/lib/seam/connect/models/partner/resources.js.map +1 -1
- package/lib/seam/connect/openapi.d.ts +116 -198
- package/lib/seam/connect/openapi.js +68 -169
- package/lib/seam/connect/openapi.js.map +1 -1
- package/lib/seam/connect/route-types.d.ts +21 -43
- package/package.json +1 -1
- package/src/lib/seam/connect/internal/schemas.ts +2 -0
- package/src/lib/seam/connect/models/client-sessions/client-session.ts +4 -3
- package/src/lib/seam/connect/models/partner/index.ts +1 -0
- package/src/lib/seam/connect/models/partner/magic-link.ts +18 -0
- package/src/lib/seam/connect/models/partner/resources.ts +6 -1
- package/src/lib/seam/connect/openapi.ts +68 -179
- package/src/lib/seam/connect/route-types.ts +21 -46
|
@@ -18560,6 +18560,7 @@ export interface Routes {
|
|
|
18560
18560
|
token: string;
|
|
18561
18561
|
user_identifier_key: string | null;
|
|
18562
18562
|
device_count: number;
|
|
18563
|
+
customer_id?: string | undefined;
|
|
18563
18564
|
connected_account_ids: string[];
|
|
18564
18565
|
connect_webview_ids: string[];
|
|
18565
18566
|
user_identity_ids: string[];
|
|
@@ -18608,6 +18609,7 @@ export interface Routes {
|
|
|
18608
18609
|
token: string;
|
|
18609
18610
|
user_identifier_key: string | null;
|
|
18610
18611
|
device_count: number;
|
|
18612
|
+
customer_id?: string | undefined;
|
|
18611
18613
|
connected_account_ids: string[];
|
|
18612
18614
|
connect_webview_ids: string[];
|
|
18613
18615
|
user_identity_ids: string[];
|
|
@@ -18650,6 +18652,7 @@ export interface Routes {
|
|
|
18650
18652
|
token: string;
|
|
18651
18653
|
user_identifier_key: string | null;
|
|
18652
18654
|
device_count: number;
|
|
18655
|
+
customer_id?: string | undefined;
|
|
18653
18656
|
connected_account_ids: string[];
|
|
18654
18657
|
connect_webview_ids: string[];
|
|
18655
18658
|
user_identity_ids: string[];
|
|
@@ -18692,6 +18695,7 @@ export interface Routes {
|
|
|
18692
18695
|
token: string;
|
|
18693
18696
|
user_identifier_key: string | null;
|
|
18694
18697
|
device_count: number;
|
|
18698
|
+
customer_id?: string | undefined;
|
|
18695
18699
|
connected_account_ids: string[];
|
|
18696
18700
|
connect_webview_ids: string[];
|
|
18697
18701
|
user_identity_ids: string[];
|
|
@@ -18725,6 +18729,7 @@ export interface Routes {
|
|
|
18725
18729
|
token: string;
|
|
18726
18730
|
user_identifier_key: string | null;
|
|
18727
18731
|
device_count: number;
|
|
18732
|
+
customer_id?: string | undefined;
|
|
18728
18733
|
connected_account_ids: string[];
|
|
18729
18734
|
connect_webview_ids: string[];
|
|
18730
18735
|
user_identity_ids: string[];
|
|
@@ -18906,7 +18911,7 @@ export interface Routes {
|
|
|
18906
18911
|
queryParams: {};
|
|
18907
18912
|
jsonBody: {};
|
|
18908
18913
|
commonParams: {
|
|
18909
|
-
|
|
18914
|
+
customer_ids?: string[] | undefined;
|
|
18910
18915
|
/** Your user ID for the user by which you want to filter Connect Webviews. */
|
|
18911
18916
|
user_identifier_key?: string | undefined;
|
|
18912
18917
|
/** Custom metadata pairs by which you want to [filter Connect Webviews](https://docs.seam.co/latest/core-concepts/connect-webviews/filtering-connect-webviews-by-custom-metadata). Returns Connect Webviews with `custom_metadata` that contains all of the provided key:value pairs. */
|
|
@@ -41203,6 +41208,7 @@ export interface Routes {
|
|
|
41203
41208
|
token: string;
|
|
41204
41209
|
user_identifier_key: string | null;
|
|
41205
41210
|
device_count: number;
|
|
41211
|
+
customer_id?: string | undefined;
|
|
41206
41212
|
connected_account_ids: string[];
|
|
41207
41213
|
connect_webview_ids: string[];
|
|
41208
41214
|
user_identity_ids: string[];
|
|
@@ -56201,54 +56207,26 @@ export interface Routes {
|
|
|
56201
56207
|
};
|
|
56202
56208
|
};
|
|
56203
56209
|
};
|
|
56204
|
-
'/unstable_partner/building_blocks/
|
|
56205
|
-
route: '/unstable_partner/building_blocks/
|
|
56206
|
-
method: 'POST';
|
|
56210
|
+
'/unstable_partner/building_blocks/generate_magic_link': {
|
|
56211
|
+
route: '/unstable_partner/building_blocks/generate_magic_link';
|
|
56212
|
+
method: 'POST' | 'GET';
|
|
56207
56213
|
queryParams: {};
|
|
56208
|
-
jsonBody: {
|
|
56209
|
-
|
|
56210
|
-
|
|
56211
|
-
|
|
56214
|
+
jsonBody: {};
|
|
56215
|
+
commonParams: {
|
|
56216
|
+
building_block_type: 'connect_account' | 'manage_devices';
|
|
56217
|
+
customer_key: string;
|
|
56212
56218
|
};
|
|
56213
|
-
commonParams: {};
|
|
56214
56219
|
formData: {};
|
|
56215
56220
|
jsonResponse: {
|
|
56216
56221
|
/** */
|
|
56217
|
-
|
|
56222
|
+
magic_link: {
|
|
56223
|
+
url: string;
|
|
56224
|
+
building_block_type: 'connect_account' | 'manage_devices';
|
|
56225
|
+
customer_id: string;
|
|
56226
|
+
customer_key: string;
|
|
56227
|
+
expires_at: string;
|
|
56228
|
+
workspace_id: string;
|
|
56218
56229
|
created_at: string;
|
|
56219
|
-
bridge_client_session_id: string;
|
|
56220
|
-
bridge_client_session_token: string;
|
|
56221
|
-
pairing_code: string;
|
|
56222
|
-
pairing_code_expires_at: string;
|
|
56223
|
-
tailscale_hostname: string;
|
|
56224
|
-
tailscale_auth_key: string | null;
|
|
56225
|
-
bridge_client_name: string;
|
|
56226
|
-
bridge_client_time_zone: string;
|
|
56227
|
-
bridge_client_machine_identifier_key: string;
|
|
56228
|
-
errors: Array<{
|
|
56229
|
-
message: string;
|
|
56230
|
-
created_at: string;
|
|
56231
|
-
/** Unique identifier of the type of error. Enables quick recognition and categorization of the issue. */
|
|
56232
|
-
error_code: 'bridge_lan_unreachable';
|
|
56233
|
-
/** Seam cannot reach the tailscale proxy */
|
|
56234
|
-
is_tailscale_proxy_reachable: boolean | null;
|
|
56235
|
-
/** Tailscale proxy's SOCKS server is unhealthy */
|
|
56236
|
-
is_tailscale_proxy_socks_server_healthy: boolean | null;
|
|
56237
|
-
/** Tailscale proxy cannot reach the Tailscale network */
|
|
56238
|
-
can_tailscale_proxy_reach_tailscale_network: boolean | null;
|
|
56239
|
-
/** Tailscale proxy cannot reach the bridge */
|
|
56240
|
-
can_tailscale_proxy_reach_bridge: boolean | null;
|
|
56241
|
-
/** Bridge's SOCKS server is unhealthy */
|
|
56242
|
-
is_bridge_socks_server_healthy: boolean | null;
|
|
56243
|
-
} | {
|
|
56244
|
-
message: string;
|
|
56245
|
-
created_at: string;
|
|
56246
|
-
/** Unique identifier of the type of error. Enables quick recognition and categorization of the issue. */
|
|
56247
|
-
error_code: 'no_communication_from_bridge';
|
|
56248
|
-
}>;
|
|
56249
|
-
telemetry_token: string | null;
|
|
56250
|
-
telemetry_token_expires_at: string | null;
|
|
56251
|
-
telemetry_url: string | null;
|
|
56252
56230
|
};
|
|
56253
56231
|
};
|
|
56254
56232
|
};
|
package/package.json
CHANGED
|
@@ -41,11 +41,13 @@ export {
|
|
|
41
41
|
instant_key,
|
|
42
42
|
location,
|
|
43
43
|
lock_device_type,
|
|
44
|
+
magic_link,
|
|
44
45
|
access_code as managed_access_code,
|
|
45
46
|
device as managed_device,
|
|
46
47
|
noise_sensor_device_type,
|
|
47
48
|
noise_threshold,
|
|
48
49
|
pagination,
|
|
50
|
+
partner_resource,
|
|
49
51
|
phone,
|
|
50
52
|
phone_number,
|
|
51
53
|
phone_registration,
|
|
@@ -8,6 +8,7 @@ export const client_session = z.object({
|
|
|
8
8
|
token: z.string(),
|
|
9
9
|
user_identifier_key: z.string().nullable(),
|
|
10
10
|
device_count: z.number(),
|
|
11
|
+
customer_id: z.string().uuid().optional(),
|
|
11
12
|
connected_account_ids: z.array(z.string().uuid()),
|
|
12
13
|
connect_webview_ids: z.array(z.string().uuid()),
|
|
13
14
|
user_identity_ids: z.array(z.string().uuid()),
|
|
@@ -16,11 +17,11 @@ export const client_session = z.object({
|
|
|
16
17
|
route_path: /client_sessions
|
|
17
18
|
---
|
|
18
19
|
Represents a [client session](https://docs.seam.co/latest/core-concepts/authentication/client-session-tokens). If you want to restrict your users' access to their own devices, use client sessions.
|
|
19
|
-
|
|
20
|
+
|
|
20
21
|
You create each client session with a custom \`user_identifier_key\`. Normally, the \`user_identifier_key\` is a user ID that your application provides.
|
|
21
|
-
|
|
22
|
+
|
|
22
23
|
When calling the Seam API from your backend using an API key, you can pass the \`user_identifier_key\` as a parameter to limit results to the associated client session. For example, \`/devices/list?user_identifier_key=123\` only returns devices associated with the client session created with the \`user_identifier_key\` \`123\`.
|
|
23
|
-
|
|
24
|
+
|
|
24
25
|
A client session has a token that you can use with the Seam JavaScript SDK to make requests from the client (browser) directly to the Seam API. The token restricts the user's access to only the devices that they own.
|
|
25
26
|
|
|
26
27
|
See also [Get Started with React](https://docs.seam.co/latest/ui-components/overview/getting-started-with-seam-components/get-started-with-react-components-and-client-session-tokens).
|
|
@@ -0,0 +1,18 @@
|
|
|
1
|
+
import { z } from 'zod'
|
|
2
|
+
|
|
3
|
+
export const magic_link = z.object({
|
|
4
|
+
url: z.string().url(),
|
|
5
|
+
building_block_type: z.enum(['connect_account', 'manage_devices']),
|
|
6
|
+
customer_id: z.string().uuid(),
|
|
7
|
+
customer_key: z.string(),
|
|
8
|
+
expires_at: z.string().datetime(),
|
|
9
|
+
workspace_id: z.string().uuid(),
|
|
10
|
+
created_at: z.string().datetime(),
|
|
11
|
+
}).describe(`
|
|
12
|
+
---
|
|
13
|
+
undocumented: Unreleased.
|
|
14
|
+
route_path: /unstable_partner/building_blocks
|
|
15
|
+
---
|
|
16
|
+
`)
|
|
17
|
+
|
|
18
|
+
export type MagicLink = z.infer<typeof magic_link>
|
|
@@ -19,6 +19,11 @@ export const partner_resource = z.object({
|
|
|
19
19
|
name: z.string().optional(),
|
|
20
20
|
description: z.string().optional(),
|
|
21
21
|
custom_metadata: z.record(z.string(), z.string()).optional(),
|
|
22
|
-
})
|
|
22
|
+
}).describe(`
|
|
23
|
+
---
|
|
24
|
+
undocumented: Unreleased.
|
|
25
|
+
route_path: /unstable_partner/resources
|
|
26
|
+
---
|
|
27
|
+
`)
|
|
23
28
|
|
|
24
29
|
export type PartnerResource = z.infer<typeof partner_resource>
|
|
@@ -7142,6 +7142,7 @@ export default {
|
|
|
7142
7142
|
type: 'array',
|
|
7143
7143
|
},
|
|
7144
7144
|
created_at: { format: 'date-time', type: 'string' },
|
|
7145
|
+
customer_id: { format: 'uuid', type: 'string' },
|
|
7145
7146
|
device_count: { format: 'float', type: 'number' },
|
|
7146
7147
|
expires_at: { format: 'date-time', type: 'string' },
|
|
7147
7148
|
token: { type: 'string' },
|
|
@@ -15899,6 +15900,32 @@ export default {
|
|
|
15899
15900
|
'x-route-path': '/user_identities',
|
|
15900
15901
|
'x-undocumented': 'Unreleased.',
|
|
15901
15902
|
},
|
|
15903
|
+
magic_link: {
|
|
15904
|
+
properties: {
|
|
15905
|
+
building_block_type: {
|
|
15906
|
+
enum: ['connect_account', 'manage_devices'],
|
|
15907
|
+
type: 'string',
|
|
15908
|
+
},
|
|
15909
|
+
created_at: { format: 'date-time', type: 'string' },
|
|
15910
|
+
customer_id: { format: 'uuid', type: 'string' },
|
|
15911
|
+
customer_key: { type: 'string' },
|
|
15912
|
+
expires_at: { format: 'date-time', type: 'string' },
|
|
15913
|
+
url: { format: 'uri', type: 'string' },
|
|
15914
|
+
workspace_id: { format: 'uuid', type: 'string' },
|
|
15915
|
+
},
|
|
15916
|
+
required: [
|
|
15917
|
+
'url',
|
|
15918
|
+
'building_block_type',
|
|
15919
|
+
'customer_id',
|
|
15920
|
+
'customer_key',
|
|
15921
|
+
'expires_at',
|
|
15922
|
+
'workspace_id',
|
|
15923
|
+
'created_at',
|
|
15924
|
+
],
|
|
15925
|
+
type: 'object',
|
|
15926
|
+
'x-route-path': '/unstable_partner/building_blocks',
|
|
15927
|
+
'x-undocumented': 'Unreleased.',
|
|
15928
|
+
},
|
|
15902
15929
|
network: {
|
|
15903
15930
|
properties: {
|
|
15904
15931
|
created_at: { format: 'date-time', type: 'string' },
|
|
@@ -20540,18 +20567,18 @@ export default {
|
|
|
20540
20567
|
name: 'client-session-token',
|
|
20541
20568
|
type: 'apiKey',
|
|
20542
20569
|
},
|
|
20543
|
-
|
|
20544
|
-
bearerFormat: '
|
|
20570
|
+
client_session_with_customer: {
|
|
20571
|
+
bearerFormat: 'Customer Client Session Token',
|
|
20545
20572
|
scheme: 'bearer',
|
|
20546
20573
|
type: 'http',
|
|
20547
20574
|
},
|
|
20548
|
-
|
|
20575
|
+
console_session_with_workspace: {
|
|
20549
20576
|
bearerFormat: 'Console Session Token',
|
|
20550
20577
|
scheme: 'bearer',
|
|
20551
20578
|
type: 'http',
|
|
20552
20579
|
},
|
|
20553
|
-
|
|
20554
|
-
bearerFormat: '
|
|
20580
|
+
console_session_without_workspace: {
|
|
20581
|
+
bearerFormat: 'Console Session Token',
|
|
20555
20582
|
scheme: 'bearer',
|
|
20556
20583
|
type: 'http',
|
|
20557
20584
|
},
|
|
@@ -27681,7 +27708,7 @@ export default {
|
|
|
27681
27708
|
},
|
|
27682
27709
|
security: [
|
|
27683
27710
|
{ client_session: [] },
|
|
27684
|
-
{
|
|
27711
|
+
{ client_session_with_customer: [] },
|
|
27685
27712
|
{ pat_with_workspace: [] },
|
|
27686
27713
|
{ console_session_with_workspace: [] },
|
|
27687
27714
|
{ api_key: [] },
|
|
@@ -27793,7 +27820,7 @@ export default {
|
|
|
27793
27820
|
},
|
|
27794
27821
|
security: [
|
|
27795
27822
|
{ client_session: [] },
|
|
27796
|
-
{
|
|
27823
|
+
{ client_session_with_customer: [] },
|
|
27797
27824
|
{ pat_with_workspace: [] },
|
|
27798
27825
|
{ console_session_with_workspace: [] },
|
|
27799
27826
|
{ api_key: [] },
|
|
@@ -27825,7 +27852,7 @@ export default {
|
|
|
27825
27852
|
'Custom metadata pairs by which you want to [filter Connect Webviews](https://docs.seam.co/latest/core-concepts/connect-webviews/filtering-connect-webviews-by-custom-metadata). Returns Connect Webviews with `custom_metadata` that contains all of the provided key:value pairs.',
|
|
27826
27853
|
type: 'object',
|
|
27827
27854
|
},
|
|
27828
|
-
|
|
27855
|
+
customer_ids: { items: { type: 'string' }, type: 'array' },
|
|
27829
27856
|
limit: {
|
|
27830
27857
|
default: 500,
|
|
27831
27858
|
description:
|
|
@@ -27868,7 +27895,7 @@ export default {
|
|
|
27868
27895
|
},
|
|
27869
27896
|
security: [
|
|
27870
27897
|
{ client_session: [] },
|
|
27871
|
-
{
|
|
27898
|
+
{ client_session_with_customer: [] },
|
|
27872
27899
|
{ pat_with_workspace: [] },
|
|
27873
27900
|
{ console_session_with_workspace: [] },
|
|
27874
27901
|
{ api_key: [] },
|
|
@@ -27930,7 +27957,7 @@ export default {
|
|
|
27930
27957
|
{ api_key: [] },
|
|
27931
27958
|
{ pat_with_workspace: [] },
|
|
27932
27959
|
{ console_session_with_workspace: [] },
|
|
27933
|
-
{
|
|
27960
|
+
{ client_session_with_customer: [] },
|
|
27934
27961
|
],
|
|
27935
27962
|
summary: '/connected_accounts/delete',
|
|
27936
27963
|
tags: ['/connected_accounts'],
|
|
@@ -28089,7 +28116,7 @@ export default {
|
|
|
28089
28116
|
{ api_key: [] },
|
|
28090
28117
|
{ pat_with_workspace: [] },
|
|
28091
28118
|
{ console_session_with_workspace: [] },
|
|
28092
|
-
{
|
|
28119
|
+
{ client_session_with_customer: [] },
|
|
28093
28120
|
],
|
|
28094
28121
|
summary: '/connected_accounts/list',
|
|
28095
28122
|
tags: ['/connected_accounts'],
|
|
@@ -28327,7 +28354,7 @@ export default {
|
|
|
28327
28354
|
},
|
|
28328
28355
|
security: [
|
|
28329
28356
|
{ client_session: [] },
|
|
28330
|
-
{
|
|
28357
|
+
{ client_session_with_customer: [] },
|
|
28331
28358
|
{ pat_with_workspace: [] },
|
|
28332
28359
|
{ console_session_with_workspace: [] },
|
|
28333
28360
|
{ api_key: [] },
|
|
@@ -28664,7 +28691,7 @@ export default {
|
|
|
28664
28691
|
401: { description: 'Unauthorized' },
|
|
28665
28692
|
},
|
|
28666
28693
|
security: [
|
|
28667
|
-
{
|
|
28694
|
+
{ client_session_with_customer: [] },
|
|
28668
28695
|
{ client_session: [] },
|
|
28669
28696
|
{ pat_with_workspace: [] },
|
|
28670
28697
|
{ console_session_with_workspace: [] },
|
|
@@ -29966,7 +29993,7 @@ export default {
|
|
|
29966
29993
|
{ api_key: [] },
|
|
29967
29994
|
{ pat_with_workspace: [] },
|
|
29968
29995
|
{ console_session_with_workspace: [] },
|
|
29969
|
-
{
|
|
29996
|
+
{ client_session_with_customer: [] },
|
|
29970
29997
|
],
|
|
29971
29998
|
summary: '/events/list',
|
|
29972
29999
|
tags: ['/events'],
|
|
@@ -32903,6 +32930,8 @@ export default {
|
|
|
32903
32930
|
'customer_key',
|
|
32904
32931
|
],
|
|
32905
32932
|
type: 'object',
|
|
32933
|
+
'x-route-path': '/unstable_partner/resources',
|
|
32934
|
+
'x-undocumented': 'Unreleased.',
|
|
32906
32935
|
},
|
|
32907
32936
|
type: 'array',
|
|
32908
32937
|
},
|
|
@@ -32917,7 +32946,7 @@ export default {
|
|
|
32917
32946
|
400: { description: 'Bad Request' },
|
|
32918
32947
|
401: { description: 'Unauthorized' },
|
|
32919
32948
|
},
|
|
32920
|
-
security: [{
|
|
32949
|
+
security: [{ client_session_with_customer: [] }],
|
|
32921
32950
|
summary: '/seam/partner/v1/resources/list',
|
|
32922
32951
|
tags: [],
|
|
32923
32952
|
'x-fern-sdk-group-name': ['seam', 'partner', 'v1', 'resources'],
|
|
@@ -35810,7 +35839,7 @@ export default {
|
|
|
35810
35839
|
{ pat_with_workspace: [] },
|
|
35811
35840
|
{ console_session_with_workspace: [] },
|
|
35812
35841
|
{ api_key: [] },
|
|
35813
|
-
{
|
|
35842
|
+
{ client_session_with_customer: [] },
|
|
35814
35843
|
],
|
|
35815
35844
|
summary: '/unstable_access_grants/create',
|
|
35816
35845
|
tags: [],
|
|
@@ -35863,7 +35892,7 @@ export default {
|
|
|
35863
35892
|
{ pat_with_workspace: [] },
|
|
35864
35893
|
{ console_session_with_workspace: [] },
|
|
35865
35894
|
{ api_key: [] },
|
|
35866
|
-
{
|
|
35895
|
+
{ client_session_with_customer: [] },
|
|
35867
35896
|
],
|
|
35868
35897
|
summary: '/unstable_access_grants/delete',
|
|
35869
35898
|
tags: [],
|
|
@@ -36012,7 +36041,7 @@ export default {
|
|
|
36012
36041
|
{ pat_with_workspace: [] },
|
|
36013
36042
|
{ console_session_with_workspace: [] },
|
|
36014
36043
|
{ api_key: [] },
|
|
36015
|
-
{
|
|
36044
|
+
{ client_session_with_customer: [] },
|
|
36016
36045
|
],
|
|
36017
36046
|
summary: '/unstable_access_grants/get',
|
|
36018
36047
|
tags: [],
|
|
@@ -36183,7 +36212,7 @@ export default {
|
|
|
36183
36212
|
{ pat_with_workspace: [] },
|
|
36184
36213
|
{ console_session_with_workspace: [] },
|
|
36185
36214
|
{ api_key: [] },
|
|
36186
|
-
{
|
|
36215
|
+
{ client_session_with_customer: [] },
|
|
36187
36216
|
],
|
|
36188
36217
|
summary: '/unstable_access_grants/list',
|
|
36189
36218
|
tags: [],
|
|
@@ -37429,24 +37458,22 @@ export default {
|
|
|
37429
37458
|
'x-undocumented': 'Experimental locations.',
|
|
37430
37459
|
},
|
|
37431
37460
|
},
|
|
37432
|
-
'/unstable_partner/building_blocks/
|
|
37461
|
+
'/unstable_partner/building_blocks/generate_magic_link': {
|
|
37433
37462
|
post: {
|
|
37434
|
-
description: 'Creates a new
|
|
37435
|
-
operationId: '
|
|
37463
|
+
description: 'Creates a new building block magic link.',
|
|
37464
|
+
operationId: 'unstablePartnerBuildingBlocksGenerateMagicLinkPost',
|
|
37436
37465
|
requestBody: {
|
|
37437
37466
|
content: {
|
|
37438
37467
|
'application/json': {
|
|
37439
37468
|
schema: {
|
|
37440
37469
|
properties: {
|
|
37441
|
-
|
|
37442
|
-
|
|
37443
|
-
|
|
37470
|
+
building_block_type: {
|
|
37471
|
+
enum: ['connect_account', 'manage_devices'],
|
|
37472
|
+
type: 'string',
|
|
37473
|
+
},
|
|
37474
|
+
customer_key: { type: 'string' },
|
|
37444
37475
|
},
|
|
37445
|
-
required: [
|
|
37446
|
-
'bridge_client_name',
|
|
37447
|
-
'bridge_client_time_zone',
|
|
37448
|
-
'bridge_client_machine_identifier_key',
|
|
37449
|
-
],
|
|
37476
|
+
required: ['building_block_type', 'customer_key'],
|
|
37450
37477
|
type: 'object',
|
|
37451
37478
|
},
|
|
37452
37479
|
},
|
|
@@ -37458,152 +37485,10 @@ export default {
|
|
|
37458
37485
|
'application/json': {
|
|
37459
37486
|
schema: {
|
|
37460
37487
|
properties: {
|
|
37461
|
-
|
|
37462
|
-
properties: {
|
|
37463
|
-
bridge_client_machine_identifier_key: {
|
|
37464
|
-
type: 'string',
|
|
37465
|
-
},
|
|
37466
|
-
bridge_client_name: { type: 'string' },
|
|
37467
|
-
bridge_client_session_id: {
|
|
37468
|
-
format: 'uuid',
|
|
37469
|
-
type: 'string',
|
|
37470
|
-
},
|
|
37471
|
-
bridge_client_session_token: { type: 'string' },
|
|
37472
|
-
bridge_client_time_zone: { type: 'string' },
|
|
37473
|
-
created_at: { format: 'date-time', type: 'string' },
|
|
37474
|
-
errors: {
|
|
37475
|
-
items: {
|
|
37476
|
-
description:
|
|
37477
|
-
'Error associated with the `bridge_client_session`.',
|
|
37478
|
-
discriminator: { propertyName: 'error_code' },
|
|
37479
|
-
oneOf: [
|
|
37480
|
-
{
|
|
37481
|
-
description:
|
|
37482
|
-
"Seam cannot reach the bridge's LAN",
|
|
37483
|
-
properties: {
|
|
37484
|
-
can_tailscale_proxy_reach_bridge: {
|
|
37485
|
-
description:
|
|
37486
|
-
'Tailscale proxy cannot reach the bridge',
|
|
37487
|
-
nullable: true,
|
|
37488
|
-
type: 'boolean',
|
|
37489
|
-
},
|
|
37490
|
-
can_tailscale_proxy_reach_tailscale_network: {
|
|
37491
|
-
description:
|
|
37492
|
-
'Tailscale proxy cannot reach the Tailscale network',
|
|
37493
|
-
nullable: true,
|
|
37494
|
-
type: 'boolean',
|
|
37495
|
-
},
|
|
37496
|
-
created_at: {
|
|
37497
|
-
format: 'date-time',
|
|
37498
|
-
type: 'string',
|
|
37499
|
-
},
|
|
37500
|
-
error_code: {
|
|
37501
|
-
description:
|
|
37502
|
-
'Unique identifier of the type of error. Enables quick recognition and categorization of the issue.',
|
|
37503
|
-
enum: ['bridge_lan_unreachable'],
|
|
37504
|
-
type: 'string',
|
|
37505
|
-
},
|
|
37506
|
-
is_bridge_socks_server_healthy: {
|
|
37507
|
-
description:
|
|
37508
|
-
"Bridge's SOCKS server is unhealthy",
|
|
37509
|
-
nullable: true,
|
|
37510
|
-
type: 'boolean',
|
|
37511
|
-
},
|
|
37512
|
-
is_tailscale_proxy_reachable: {
|
|
37513
|
-
description:
|
|
37514
|
-
'Seam cannot reach the tailscale proxy',
|
|
37515
|
-
nullable: true,
|
|
37516
|
-
type: 'boolean',
|
|
37517
|
-
},
|
|
37518
|
-
is_tailscale_proxy_socks_server_healthy: {
|
|
37519
|
-
description:
|
|
37520
|
-
"Tailscale proxy's SOCKS server is unhealthy",
|
|
37521
|
-
nullable: true,
|
|
37522
|
-
type: 'boolean',
|
|
37523
|
-
},
|
|
37524
|
-
message: { type: 'string' },
|
|
37525
|
-
},
|
|
37526
|
-
required: [
|
|
37527
|
-
'message',
|
|
37528
|
-
'created_at',
|
|
37529
|
-
'error_code',
|
|
37530
|
-
'is_tailscale_proxy_reachable',
|
|
37531
|
-
'is_tailscale_proxy_socks_server_healthy',
|
|
37532
|
-
'can_tailscale_proxy_reach_tailscale_network',
|
|
37533
|
-
'can_tailscale_proxy_reach_bridge',
|
|
37534
|
-
'is_bridge_socks_server_healthy',
|
|
37535
|
-
],
|
|
37536
|
-
type: 'object',
|
|
37537
|
-
},
|
|
37538
|
-
{
|
|
37539
|
-
description:
|
|
37540
|
-
'Bridge has stopped communicating with Seam',
|
|
37541
|
-
properties: {
|
|
37542
|
-
created_at: {
|
|
37543
|
-
format: 'date-time',
|
|
37544
|
-
type: 'string',
|
|
37545
|
-
},
|
|
37546
|
-
error_code: {
|
|
37547
|
-
description:
|
|
37548
|
-
'Unique identifier of the type of error. Enables quick recognition and categorization of the issue.',
|
|
37549
|
-
enum: ['no_communication_from_bridge'],
|
|
37550
|
-
type: 'string',
|
|
37551
|
-
},
|
|
37552
|
-
message: { type: 'string' },
|
|
37553
|
-
},
|
|
37554
|
-
required: [
|
|
37555
|
-
'message',
|
|
37556
|
-
'created_at',
|
|
37557
|
-
'error_code',
|
|
37558
|
-
],
|
|
37559
|
-
type: 'object',
|
|
37560
|
-
},
|
|
37561
|
-
],
|
|
37562
|
-
},
|
|
37563
|
-
type: 'array',
|
|
37564
|
-
},
|
|
37565
|
-
pairing_code: {
|
|
37566
|
-
maxLength: 6,
|
|
37567
|
-
minLength: 6,
|
|
37568
|
-
type: 'string',
|
|
37569
|
-
},
|
|
37570
|
-
pairing_code_expires_at: {
|
|
37571
|
-
format: 'date-time',
|
|
37572
|
-
type: 'string',
|
|
37573
|
-
},
|
|
37574
|
-
tailscale_auth_key: { nullable: true, type: 'string' },
|
|
37575
|
-
tailscale_hostname: { type: 'string' },
|
|
37576
|
-
telemetry_token: { nullable: true, type: 'string' },
|
|
37577
|
-
telemetry_token_expires_at: {
|
|
37578
|
-
format: 'date-time',
|
|
37579
|
-
nullable: true,
|
|
37580
|
-
type: 'string',
|
|
37581
|
-
},
|
|
37582
|
-
telemetry_url: { nullable: true, type: 'string' },
|
|
37583
|
-
},
|
|
37584
|
-
required: [
|
|
37585
|
-
'created_at',
|
|
37586
|
-
'bridge_client_session_id',
|
|
37587
|
-
'bridge_client_session_token',
|
|
37588
|
-
'pairing_code',
|
|
37589
|
-
'pairing_code_expires_at',
|
|
37590
|
-
'tailscale_hostname',
|
|
37591
|
-
'tailscale_auth_key',
|
|
37592
|
-
'bridge_client_name',
|
|
37593
|
-
'bridge_client_time_zone',
|
|
37594
|
-
'bridge_client_machine_identifier_key',
|
|
37595
|
-
'errors',
|
|
37596
|
-
'telemetry_token',
|
|
37597
|
-
'telemetry_token_expires_at',
|
|
37598
|
-
'telemetry_url',
|
|
37599
|
-
],
|
|
37600
|
-
type: 'object',
|
|
37601
|
-
'x-route-path': '/seam/bridge/v1/bridge_client_sessions',
|
|
37602
|
-
'x-undocumented': 'Seam Bridge Client only.',
|
|
37603
|
-
},
|
|
37488
|
+
magic_link: { $ref: '#/components/schemas/magic_link' },
|
|
37604
37489
|
ok: { type: 'boolean' },
|
|
37605
37490
|
},
|
|
37606
|
-
required: ['
|
|
37491
|
+
required: ['magic_link', 'ok'],
|
|
37607
37492
|
type: 'object',
|
|
37608
37493
|
},
|
|
37609
37494
|
},
|
|
@@ -37613,13 +37498,13 @@ export default {
|
|
|
37613
37498
|
400: { description: 'Bad Request' },
|
|
37614
37499
|
401: { description: 'Unauthorized' },
|
|
37615
37500
|
},
|
|
37616
|
-
security: [{
|
|
37617
|
-
summary: '/unstable_partner/building_blocks/
|
|
37501
|
+
security: [{ api_key: [] }],
|
|
37502
|
+
summary: '/unstable_partner/building_blocks/generate_magic_link',
|
|
37618
37503
|
tags: [],
|
|
37619
37504
|
'x-fern-sdk-group-name': ['unstable_partner', 'building_blocks'],
|
|
37620
|
-
'x-fern-sdk-method-name': '
|
|
37621
|
-
'x-fern-sdk-return-value': '
|
|
37622
|
-
'x-response-key': '
|
|
37505
|
+
'x-fern-sdk-method-name': 'generate_magic_link',
|
|
37506
|
+
'x-fern-sdk-return-value': 'magic_link',
|
|
37507
|
+
'x-response-key': 'magic_link',
|
|
37623
37508
|
'x-title': 'Generate a building block magic link',
|
|
37624
37509
|
'x-undocumented': 'Experimental partner building blocks.',
|
|
37625
37510
|
},
|
|
@@ -37656,6 +37541,8 @@ export default {
|
|
|
37656
37541
|
user_identity_key: { type: 'string' },
|
|
37657
37542
|
},
|
|
37658
37543
|
type: 'object',
|
|
37544
|
+
'x-route-path': '/unstable_partner/resources',
|
|
37545
|
+
'x-undocumented': 'Unreleased.',
|
|
37659
37546
|
},
|
|
37660
37547
|
type: 'array',
|
|
37661
37548
|
},
|
|
@@ -37681,6 +37568,8 @@ export default {
|
|
|
37681
37568
|
user_identity_key: { type: 'string' },
|
|
37682
37569
|
},
|
|
37683
37570
|
type: 'object',
|
|
37571
|
+
'x-route-path': '/unstable_partner/resources',
|
|
37572
|
+
'x-undocumented': 'Unreleased.',
|
|
37684
37573
|
},
|
|
37685
37574
|
],
|
|
37686
37575
|
},
|