@seamapi/types 1.406.6 → 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.
@@ -56207,54 +56207,26 @@ export interface Routes {
56207
56207
  };
56208
56208
  };
56209
56209
  };
56210
- '/unstable_partner/building_blocks/generate_link': {
56211
- route: '/unstable_partner/building_blocks/generate_link';
56212
- method: 'POST';
56210
+ '/unstable_partner/building_blocks/generate_magic_link': {
56211
+ route: '/unstable_partner/building_blocks/generate_magic_link';
56212
+ method: 'POST' | 'GET';
56213
56213
  queryParams: {};
56214
- jsonBody: {
56215
- bridge_client_name: string;
56216
- bridge_client_time_zone: string;
56217
- bridge_client_machine_identifier_key: string;
56214
+ jsonBody: {};
56215
+ commonParams: {
56216
+ building_block_type: 'connect_account' | 'manage_devices';
56217
+ customer_key: string;
56218
56218
  };
56219
- commonParams: {};
56220
56219
  formData: {};
56221
56220
  jsonResponse: {
56222
56221
  /** */
56223
- bridge_client_session: {
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;
56224
56229
  created_at: string;
56225
- bridge_client_session_id: string;
56226
- bridge_client_session_token: string;
56227
- pairing_code: string;
56228
- pairing_code_expires_at: string;
56229
- tailscale_hostname: string;
56230
- tailscale_auth_key: string | null;
56231
- bridge_client_name: string;
56232
- bridge_client_time_zone: string;
56233
- bridge_client_machine_identifier_key: string;
56234
- errors: Array<{
56235
- message: string;
56236
- created_at: string;
56237
- /** Unique identifier of the type of error. Enables quick recognition and categorization of the issue. */
56238
- error_code: 'bridge_lan_unreachable';
56239
- /** Seam cannot reach the tailscale proxy */
56240
- is_tailscale_proxy_reachable: boolean | null;
56241
- /** Tailscale proxy's SOCKS server is unhealthy */
56242
- is_tailscale_proxy_socks_server_healthy: boolean | null;
56243
- /** Tailscale proxy cannot reach the Tailscale network */
56244
- can_tailscale_proxy_reach_tailscale_network: boolean | null;
56245
- /** Tailscale proxy cannot reach the bridge */
56246
- can_tailscale_proxy_reach_bridge: boolean | null;
56247
- /** Bridge's SOCKS server is unhealthy */
56248
- is_bridge_socks_server_healthy: boolean | null;
56249
- } | {
56250
- message: string;
56251
- created_at: string;
56252
- /** Unique identifier of the type of error. Enables quick recognition and categorization of the issue. */
56253
- error_code: 'no_communication_from_bridge';
56254
- }>;
56255
- telemetry_token: string | null;
56256
- telemetry_token_expires_at: string | null;
56257
- telemetry_url: string | null;
56258
56230
  };
56259
56231
  };
56260
56232
  };
package/package.json CHANGED
@@ -1,6 +1,6 @@
1
1
  {
2
2
  "name": "@seamapi/types",
3
- "version": "1.406.6",
3
+ "version": "1.406.7",
4
4
  "description": "TypeScript types for the Seam API.",
5
5
  "type": "module",
6
6
  "main": "index.js",
@@ -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,
@@ -1 +1,2 @@
1
+ export * from './magic-link.js'
1
2
  export * from './resources.js'
@@ -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>
@@ -15900,6 +15900,32 @@ export default {
15900
15900
  'x-route-path': '/user_identities',
15901
15901
  'x-undocumented': 'Unreleased.',
15902
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
+ },
15903
15929
  network: {
15904
15930
  properties: {
15905
15931
  created_at: { format: 'date-time', type: 'string' },
@@ -32904,6 +32930,8 @@ export default {
32904
32930
  'customer_key',
32905
32931
  ],
32906
32932
  type: 'object',
32933
+ 'x-route-path': '/unstable_partner/resources',
32934
+ 'x-undocumented': 'Unreleased.',
32907
32935
  },
32908
32936
  type: 'array',
32909
32937
  },
@@ -37430,24 +37458,22 @@ export default {
37430
37458
  'x-undocumented': 'Experimental locations.',
37431
37459
  },
37432
37460
  },
37433
- '/unstable_partner/building_blocks/generate_link': {
37461
+ '/unstable_partner/building_blocks/generate_magic_link': {
37434
37462
  post: {
37435
- description: 'Creates a new bridge client session.',
37436
- operationId: 'unstablePartnerBuildingBlocksGenerateLinkPost',
37463
+ description: 'Creates a new building block magic link.',
37464
+ operationId: 'unstablePartnerBuildingBlocksGenerateMagicLinkPost',
37437
37465
  requestBody: {
37438
37466
  content: {
37439
37467
  'application/json': {
37440
37468
  schema: {
37441
37469
  properties: {
37442
- bridge_client_machine_identifier_key: { type: 'string' },
37443
- bridge_client_name: { type: 'string' },
37444
- bridge_client_time_zone: { type: 'string' },
37470
+ building_block_type: {
37471
+ enum: ['connect_account', 'manage_devices'],
37472
+ type: 'string',
37473
+ },
37474
+ customer_key: { type: 'string' },
37445
37475
  },
37446
- required: [
37447
- 'bridge_client_name',
37448
- 'bridge_client_time_zone',
37449
- 'bridge_client_machine_identifier_key',
37450
- ],
37476
+ required: ['building_block_type', 'customer_key'],
37451
37477
  type: 'object',
37452
37478
  },
37453
37479
  },
@@ -37459,152 +37485,10 @@ export default {
37459
37485
  'application/json': {
37460
37486
  schema: {
37461
37487
  properties: {
37462
- bridge_client_session: {
37463
- properties: {
37464
- bridge_client_machine_identifier_key: {
37465
- type: 'string',
37466
- },
37467
- bridge_client_name: { type: 'string' },
37468
- bridge_client_session_id: {
37469
- format: 'uuid',
37470
- type: 'string',
37471
- },
37472
- bridge_client_session_token: { type: 'string' },
37473
- bridge_client_time_zone: { type: 'string' },
37474
- created_at: { format: 'date-time', type: 'string' },
37475
- errors: {
37476
- items: {
37477
- description:
37478
- 'Error associated with the `bridge_client_session`.',
37479
- discriminator: { propertyName: 'error_code' },
37480
- oneOf: [
37481
- {
37482
- description:
37483
- "Seam cannot reach the bridge's LAN",
37484
- properties: {
37485
- can_tailscale_proxy_reach_bridge: {
37486
- description:
37487
- 'Tailscale proxy cannot reach the bridge',
37488
- nullable: true,
37489
- type: 'boolean',
37490
- },
37491
- can_tailscale_proxy_reach_tailscale_network: {
37492
- description:
37493
- 'Tailscale proxy cannot reach the Tailscale network',
37494
- nullable: true,
37495
- type: 'boolean',
37496
- },
37497
- created_at: {
37498
- format: 'date-time',
37499
- type: 'string',
37500
- },
37501
- error_code: {
37502
- description:
37503
- 'Unique identifier of the type of error. Enables quick recognition and categorization of the issue.',
37504
- enum: ['bridge_lan_unreachable'],
37505
- type: 'string',
37506
- },
37507
- is_bridge_socks_server_healthy: {
37508
- description:
37509
- "Bridge's SOCKS server is unhealthy",
37510
- nullable: true,
37511
- type: 'boolean',
37512
- },
37513
- is_tailscale_proxy_reachable: {
37514
- description:
37515
- 'Seam cannot reach the tailscale proxy',
37516
- nullable: true,
37517
- type: 'boolean',
37518
- },
37519
- is_tailscale_proxy_socks_server_healthy: {
37520
- description:
37521
- "Tailscale proxy's SOCKS server is unhealthy",
37522
- nullable: true,
37523
- type: 'boolean',
37524
- },
37525
- message: { type: 'string' },
37526
- },
37527
- required: [
37528
- 'message',
37529
- 'created_at',
37530
- 'error_code',
37531
- 'is_tailscale_proxy_reachable',
37532
- 'is_tailscale_proxy_socks_server_healthy',
37533
- 'can_tailscale_proxy_reach_tailscale_network',
37534
- 'can_tailscale_proxy_reach_bridge',
37535
- 'is_bridge_socks_server_healthy',
37536
- ],
37537
- type: 'object',
37538
- },
37539
- {
37540
- description:
37541
- 'Bridge has stopped communicating with Seam',
37542
- properties: {
37543
- created_at: {
37544
- format: 'date-time',
37545
- type: 'string',
37546
- },
37547
- error_code: {
37548
- description:
37549
- 'Unique identifier of the type of error. Enables quick recognition and categorization of the issue.',
37550
- enum: ['no_communication_from_bridge'],
37551
- type: 'string',
37552
- },
37553
- message: { type: 'string' },
37554
- },
37555
- required: [
37556
- 'message',
37557
- 'created_at',
37558
- 'error_code',
37559
- ],
37560
- type: 'object',
37561
- },
37562
- ],
37563
- },
37564
- type: 'array',
37565
- },
37566
- pairing_code: {
37567
- maxLength: 6,
37568
- minLength: 6,
37569
- type: 'string',
37570
- },
37571
- pairing_code_expires_at: {
37572
- format: 'date-time',
37573
- type: 'string',
37574
- },
37575
- tailscale_auth_key: { nullable: true, type: 'string' },
37576
- tailscale_hostname: { type: 'string' },
37577
- telemetry_token: { nullable: true, type: 'string' },
37578
- telemetry_token_expires_at: {
37579
- format: 'date-time',
37580
- nullable: true,
37581
- type: 'string',
37582
- },
37583
- telemetry_url: { nullable: true, type: 'string' },
37584
- },
37585
- required: [
37586
- 'created_at',
37587
- 'bridge_client_session_id',
37588
- 'bridge_client_session_token',
37589
- 'pairing_code',
37590
- 'pairing_code_expires_at',
37591
- 'tailscale_hostname',
37592
- 'tailscale_auth_key',
37593
- 'bridge_client_name',
37594
- 'bridge_client_time_zone',
37595
- 'bridge_client_machine_identifier_key',
37596
- 'errors',
37597
- 'telemetry_token',
37598
- 'telemetry_token_expires_at',
37599
- 'telemetry_url',
37600
- ],
37601
- type: 'object',
37602
- 'x-route-path': '/seam/bridge/v1/bridge_client_sessions',
37603
- 'x-undocumented': 'Seam Bridge Client only.',
37604
- },
37488
+ magic_link: { $ref: '#/components/schemas/magic_link' },
37605
37489
  ok: { type: 'boolean' },
37606
37490
  },
37607
- required: ['bridge_client_session', 'ok'],
37491
+ required: ['magic_link', 'ok'],
37608
37492
  type: 'object',
37609
37493
  },
37610
37494
  },
@@ -37614,13 +37498,13 @@ export default {
37614
37498
  400: { description: 'Bad Request' },
37615
37499
  401: { description: 'Unauthorized' },
37616
37500
  },
37617
- security: [{ certified_client: [] }],
37618
- summary: '/unstable_partner/building_blocks/generate_link',
37501
+ security: [{ api_key: [] }],
37502
+ summary: '/unstable_partner/building_blocks/generate_magic_link',
37619
37503
  tags: [],
37620
37504
  'x-fern-sdk-group-name': ['unstable_partner', 'building_blocks'],
37621
- 'x-fern-sdk-method-name': 'generate_link',
37622
- 'x-fern-sdk-return-value': 'bridge_client_session',
37623
- 'x-response-key': 'bridge_client_session',
37505
+ 'x-fern-sdk-method-name': 'generate_magic_link',
37506
+ 'x-fern-sdk-return-value': 'magic_link',
37507
+ 'x-response-key': 'magic_link',
37624
37508
  'x-title': 'Generate a building block magic link',
37625
37509
  'x-undocumented': 'Experimental partner building blocks.',
37626
37510
  },
@@ -37657,6 +37541,8 @@ export default {
37657
37541
  user_identity_key: { type: 'string' },
37658
37542
  },
37659
37543
  type: 'object',
37544
+ 'x-route-path': '/unstable_partner/resources',
37545
+ 'x-undocumented': 'Unreleased.',
37660
37546
  },
37661
37547
  type: 'array',
37662
37548
  },
@@ -37682,6 +37568,8 @@ export default {
37682
37568
  user_identity_key: { type: 'string' },
37683
37569
  },
37684
37570
  type: 'object',
37571
+ 'x-route-path': '/unstable_partner/resources',
37572
+ 'x-undocumented': 'Unreleased.',
37685
37573
  },
37686
37574
  ],
37687
37575
  },
@@ -66159,57 +66159,26 @@ export interface Routes {
66159
66159
  }
66160
66160
  }
66161
66161
  }
66162
- '/unstable_partner/building_blocks/generate_link': {
66163
- route: '/unstable_partner/building_blocks/generate_link'
66164
- method: 'POST'
66162
+ '/unstable_partner/building_blocks/generate_magic_link': {
66163
+ route: '/unstable_partner/building_blocks/generate_magic_link'
66164
+ method: 'POST' | 'GET'
66165
66165
  queryParams: {}
66166
- jsonBody: {
66167
- bridge_client_name: string
66168
- bridge_client_time_zone: string
66169
- bridge_client_machine_identifier_key: string
66166
+ jsonBody: {}
66167
+ commonParams: {
66168
+ building_block_type: 'connect_account' | 'manage_devices'
66169
+ customer_key: string
66170
66170
  }
66171
- commonParams: {}
66172
66171
  formData: {}
66173
66172
  jsonResponse: {
66174
66173
  /** */
66175
- bridge_client_session: {
66174
+ magic_link: {
66175
+ url: string
66176
+ building_block_type: 'connect_account' | 'manage_devices'
66177
+ customer_id: string
66178
+ customer_key: string
66179
+ expires_at: string
66180
+ workspace_id: string
66176
66181
  created_at: string
66177
- bridge_client_session_id: string
66178
- bridge_client_session_token: string
66179
- pairing_code: string
66180
- pairing_code_expires_at: string
66181
- tailscale_hostname: string
66182
- tailscale_auth_key: string | null
66183
- bridge_client_name: string
66184
- bridge_client_time_zone: string
66185
- bridge_client_machine_identifier_key: string
66186
- errors: Array<
66187
- | {
66188
- message: string
66189
- created_at: string
66190
- /** Unique identifier of the type of error. Enables quick recognition and categorization of the issue. */
66191
- error_code: 'bridge_lan_unreachable'
66192
- /** Seam cannot reach the tailscale proxy */
66193
- is_tailscale_proxy_reachable: boolean | null
66194
- /** Tailscale proxy's SOCKS server is unhealthy */
66195
- is_tailscale_proxy_socks_server_healthy: boolean | null
66196
- /** Tailscale proxy cannot reach the Tailscale network */
66197
- can_tailscale_proxy_reach_tailscale_network: boolean | null
66198
- /** Tailscale proxy cannot reach the bridge */
66199
- can_tailscale_proxy_reach_bridge: boolean | null
66200
- /** Bridge's SOCKS server is unhealthy */
66201
- is_bridge_socks_server_healthy: boolean | null
66202
- }
66203
- | {
66204
- message: string
66205
- created_at: string
66206
- /** Unique identifier of the type of error. Enables quick recognition and categorization of the issue. */
66207
- error_code: 'no_communication_from_bridge'
66208
- }
66209
- >
66210
- telemetry_token: string | null
66211
- telemetry_token_expires_at: string | null
66212
- telemetry_url: string | null
66213
66182
  }
66214
66183
  }
66215
66184
  }