@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.
Files changed (30) hide show
  1. package/dist/connect.cjs +75 -175
  2. package/dist/connect.cjs.map +1 -1
  3. package/dist/connect.d.cts +140 -241
  4. package/lib/seam/connect/internal/schemas.d.ts +1 -1
  5. package/lib/seam/connect/internal/schemas.js +1 -1
  6. package/lib/seam/connect/internal/schemas.js.map +1 -1
  7. package/lib/seam/connect/models/client-sessions/client-session.d.ts +3 -0
  8. package/lib/seam/connect/models/client-sessions/client-session.js +4 -3
  9. package/lib/seam/connect/models/client-sessions/client-session.js.map +1 -1
  10. package/lib/seam/connect/models/partner/index.d.ts +1 -0
  11. package/lib/seam/connect/models/partner/index.js +1 -0
  12. package/lib/seam/connect/models/partner/index.js.map +1 -1
  13. package/lib/seam/connect/models/partner/magic-link.d.ts +27 -0
  14. package/lib/seam/connect/models/partner/magic-link.js +16 -0
  15. package/lib/seam/connect/models/partner/magic-link.js.map +1 -0
  16. package/lib/seam/connect/models/partner/resources.d.ts +2 -2
  17. package/lib/seam/connect/models/partner/resources.js +6 -1
  18. package/lib/seam/connect/models/partner/resources.js.map +1 -1
  19. package/lib/seam/connect/openapi.d.ts +116 -198
  20. package/lib/seam/connect/openapi.js +68 -169
  21. package/lib/seam/connect/openapi.js.map +1 -1
  22. package/lib/seam/connect/route-types.d.ts +21 -43
  23. package/package.json +1 -1
  24. package/src/lib/seam/connect/internal/schemas.ts +2 -0
  25. package/src/lib/seam/connect/models/client-sessions/client-session.ts +4 -3
  26. package/src/lib/seam/connect/models/partner/index.ts +1 -0
  27. package/src/lib/seam/connect/models/partner/magic-link.ts +18 -0
  28. package/src/lib/seam/connect/models/partner/resources.ts +6 -1
  29. package/src/lib/seam/connect/openapi.ts +68 -179
  30. package/src/lib/seam/connect/route-types.ts +21 -46
package/dist/connect.cjs CHANGED
@@ -3876,6 +3876,7 @@ var client_session = zod.z.object({
3876
3876
  token: zod.z.string(),
3877
3877
  user_identifier_key: zod.z.string().nullable(),
3878
3878
  device_count: zod.z.number(),
3879
+ customer_id: zod.z.string().uuid().optional(),
3879
3880
  connected_account_ids: zod.z.array(zod.z.string().uuid()),
3880
3881
  connect_webview_ids: zod.z.array(zod.z.string().uuid()),
3881
3882
  user_identity_ids: zod.z.array(zod.z.string().uuid())
@@ -3884,11 +3885,11 @@ var client_session = zod.z.object({
3884
3885
  route_path: /client_sessions
3885
3886
  ---
3886
3887
  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.
3887
-
3888
+
3888
3889
  You create each client session with a custom \`user_identifier_key\`. Normally, the \`user_identifier_key\` is a user ID that your application provides.
3889
-
3890
+
3890
3891
  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\`.
3891
-
3892
+
3892
3893
  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.
3893
3894
 
3894
3895
  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).
@@ -11530,6 +11531,7 @@ var openapi_default = {
11530
11531
  type: "array"
11531
11532
  },
11532
11533
  created_at: { format: "date-time", type: "string" },
11534
+ customer_id: { format: "uuid", type: "string" },
11533
11535
  device_count: { format: "float", type: "number" },
11534
11536
  expires_at: { format: "date-time", type: "string" },
11535
11537
  token: { type: "string" },
@@ -19631,6 +19633,32 @@ var openapi_default = {
19631
19633
  "x-route-path": "/user_identities",
19632
19634
  "x-undocumented": "Unreleased."
19633
19635
  },
19636
+ magic_link: {
19637
+ properties: {
19638
+ building_block_type: {
19639
+ enum: ["connect_account", "manage_devices"],
19640
+ type: "string"
19641
+ },
19642
+ created_at: { format: "date-time", type: "string" },
19643
+ customer_id: { format: "uuid", type: "string" },
19644
+ customer_key: { type: "string" },
19645
+ expires_at: { format: "date-time", type: "string" },
19646
+ url: { format: "uri", type: "string" },
19647
+ workspace_id: { format: "uuid", type: "string" }
19648
+ },
19649
+ required: [
19650
+ "url",
19651
+ "building_block_type",
19652
+ "customer_id",
19653
+ "customer_key",
19654
+ "expires_at",
19655
+ "workspace_id",
19656
+ "created_at"
19657
+ ],
19658
+ type: "object",
19659
+ "x-route-path": "/unstable_partner/building_blocks",
19660
+ "x-undocumented": "Unreleased."
19661
+ },
19634
19662
  network: {
19635
19663
  properties: {
19636
19664
  created_at: { format: "date-time", type: "string" },
@@ -23799,18 +23827,18 @@ var openapi_default = {
23799
23827
  name: "client-session-token",
23800
23828
  type: "apiKey"
23801
23829
  },
23802
- console_session_with_workspace: {
23803
- bearerFormat: "Console Session Token",
23830
+ client_session_with_customer: {
23831
+ bearerFormat: "Customer Client Session Token",
23804
23832
  scheme: "bearer",
23805
23833
  type: "http"
23806
23834
  },
23807
- console_session_without_workspace: {
23835
+ console_session_with_workspace: {
23808
23836
  bearerFormat: "Console Session Token",
23809
23837
  scheme: "bearer",
23810
23838
  type: "http"
23811
23839
  },
23812
- customer_client_session: {
23813
- bearerFormat: "Customer Client Session Token",
23840
+ console_session_without_workspace: {
23841
+ bearerFormat: "Console Session Token",
23814
23842
  scheme: "bearer",
23815
23843
  type: "http"
23816
23844
  },
@@ -30496,7 +30524,7 @@ var openapi_default = {
30496
30524
  },
30497
30525
  security: [
30498
30526
  { client_session: [] },
30499
- { customer_client_session: [] },
30527
+ { client_session_with_customer: [] },
30500
30528
  { pat_with_workspace: [] },
30501
30529
  { console_session_with_workspace: [] },
30502
30530
  { api_key: [] }
@@ -30604,7 +30632,7 @@ var openapi_default = {
30604
30632
  },
30605
30633
  security: [
30606
30634
  { client_session: [] },
30607
- { customer_client_session: [] },
30635
+ { client_session_with_customer: [] },
30608
30636
  { pat_with_workspace: [] },
30609
30637
  { console_session_with_workspace: [] },
30610
30638
  { api_key: [] }
@@ -30634,7 +30662,7 @@ var openapi_default = {
30634
30662
  description: "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.",
30635
30663
  type: "object"
30636
30664
  },
30637
- customer_id: { type: "string" },
30665
+ customer_ids: { items: { type: "string" }, type: "array" },
30638
30666
  limit: {
30639
30667
  default: 500,
30640
30668
  description: "Maximum number of records to return per page.",
@@ -30675,7 +30703,7 @@ var openapi_default = {
30675
30703
  },
30676
30704
  security: [
30677
30705
  { client_session: [] },
30678
- { customer_client_session: [] },
30706
+ { client_session_with_customer: [] },
30679
30707
  { pat_with_workspace: [] },
30680
30708
  { console_session_with_workspace: [] },
30681
30709
  { api_key: [] }
@@ -30735,7 +30763,7 @@ var openapi_default = {
30735
30763
  { api_key: [] },
30736
30764
  { pat_with_workspace: [] },
30737
30765
  { console_session_with_workspace: [] },
30738
- { customer_client_session: [] }
30766
+ { client_session_with_customer: [] }
30739
30767
  ],
30740
30768
  summary: "/connected_accounts/delete",
30741
30769
  tags: ["/connected_accounts"],
@@ -30886,7 +30914,7 @@ var openapi_default = {
30886
30914
  { api_key: [] },
30887
30915
  { pat_with_workspace: [] },
30888
30916
  { console_session_with_workspace: [] },
30889
- { customer_client_session: [] }
30917
+ { client_session_with_customer: [] }
30890
30918
  ],
30891
30919
  summary: "/connected_accounts/list",
30892
30920
  tags: ["/connected_accounts"],
@@ -31114,7 +31142,7 @@ var openapi_default = {
31114
31142
  },
31115
31143
  security: [
31116
31144
  { client_session: [] },
31117
- { customer_client_session: [] },
31145
+ { client_session_with_customer: [] },
31118
31146
  { pat_with_workspace: [] },
31119
31147
  { console_session_with_workspace: [] },
31120
31148
  { api_key: [] }
@@ -31433,7 +31461,7 @@ var openapi_default = {
31433
31461
  401: { description: "Unauthorized" }
31434
31462
  },
31435
31463
  security: [
31436
- { customer_client_session: [] },
31464
+ { client_session_with_customer: [] },
31437
31465
  { client_session: [] },
31438
31466
  { pat_with_workspace: [] },
31439
31467
  { console_session_with_workspace: [] },
@@ -32678,7 +32706,7 @@ var openapi_default = {
32678
32706
  { api_key: [] },
32679
32707
  { pat_with_workspace: [] },
32680
32708
  { console_session_with_workspace: [] },
32681
- { customer_client_session: [] }
32709
+ { client_session_with_customer: [] }
32682
32710
  ],
32683
32711
  summary: "/events/list",
32684
32712
  tags: ["/events"],
@@ -35497,7 +35525,9 @@ var openapi_default = {
35497
35525
  "partner_resource_key",
35498
35526
  "customer_key"
35499
35527
  ],
35500
- type: "object"
35528
+ type: "object",
35529
+ "x-route-path": "/unstable_partner/resources",
35530
+ "x-undocumented": "Unreleased."
35501
35531
  },
35502
35532
  type: "array"
35503
35533
  }
@@ -35512,7 +35542,7 @@ var openapi_default = {
35512
35542
  400: { description: "Bad Request" },
35513
35543
  401: { description: "Unauthorized" }
35514
35544
  },
35515
- security: [{ customer_client_session: [] }],
35545
+ security: [{ client_session_with_customer: [] }],
35516
35546
  summary: "/seam/partner/v1/resources/list",
35517
35547
  tags: [],
35518
35548
  "x-fern-sdk-group-name": ["seam", "partner", "v1", "resources"],
@@ -38197,7 +38227,7 @@ var openapi_default = {
38197
38227
  { pat_with_workspace: [] },
38198
38228
  { console_session_with_workspace: [] },
38199
38229
  { api_key: [] },
38200
- { customer_client_session: [] }
38230
+ { client_session_with_customer: [] }
38201
38231
  ],
38202
38232
  summary: "/unstable_access_grants/create",
38203
38233
  tags: [],
@@ -38250,7 +38280,7 @@ var openapi_default = {
38250
38280
  { pat_with_workspace: [] },
38251
38281
  { console_session_with_workspace: [] },
38252
38282
  { api_key: [] },
38253
- { customer_client_session: [] }
38283
+ { client_session_with_customer: [] }
38254
38284
  ],
38255
38285
  summary: "/unstable_access_grants/delete",
38256
38286
  tags: [],
@@ -38389,7 +38419,7 @@ var openapi_default = {
38389
38419
  { pat_with_workspace: [] },
38390
38420
  { console_session_with_workspace: [] },
38391
38421
  { api_key: [] },
38392
- { customer_client_session: [] }
38422
+ { client_session_with_customer: [] }
38393
38423
  ],
38394
38424
  summary: "/unstable_access_grants/get",
38395
38425
  tags: [],
@@ -38546,7 +38576,7 @@ var openapi_default = {
38546
38576
  { pat_with_workspace: [] },
38547
38577
  { console_session_with_workspace: [] },
38548
38578
  { api_key: [] },
38549
- { customer_client_session: [] }
38579
+ { client_session_with_customer: [] }
38550
38580
  ],
38551
38581
  summary: "/unstable_access_grants/list",
38552
38582
  tags: [],
@@ -39764,24 +39794,22 @@ var openapi_default = {
39764
39794
  "x-undocumented": "Experimental locations."
39765
39795
  }
39766
39796
  },
39767
- "/unstable_partner/building_blocks/generate_link": {
39797
+ "/unstable_partner/building_blocks/generate_magic_link": {
39768
39798
  post: {
39769
- description: "Creates a new bridge client session.",
39770
- operationId: "unstablePartnerBuildingBlocksGenerateLinkPost",
39799
+ description: "Creates a new building block magic link.",
39800
+ operationId: "unstablePartnerBuildingBlocksGenerateMagicLinkPost",
39771
39801
  requestBody: {
39772
39802
  content: {
39773
39803
  "application/json": {
39774
39804
  schema: {
39775
39805
  properties: {
39776
- bridge_client_machine_identifier_key: { type: "string" },
39777
- bridge_client_name: { type: "string" },
39778
- bridge_client_time_zone: { type: "string" }
39806
+ building_block_type: {
39807
+ enum: ["connect_account", "manage_devices"],
39808
+ type: "string"
39809
+ },
39810
+ customer_key: { type: "string" }
39779
39811
  },
39780
- required: [
39781
- "bridge_client_name",
39782
- "bridge_client_time_zone",
39783
- "bridge_client_machine_identifier_key"
39784
- ],
39812
+ required: ["building_block_type", "customer_key"],
39785
39813
  type: "object"
39786
39814
  }
39787
39815
  }
@@ -39793,142 +39821,10 @@ var openapi_default = {
39793
39821
  "application/json": {
39794
39822
  schema: {
39795
39823
  properties: {
39796
- bridge_client_session: {
39797
- properties: {
39798
- bridge_client_machine_identifier_key: {
39799
- type: "string"
39800
- },
39801
- bridge_client_name: { type: "string" },
39802
- bridge_client_session_id: {
39803
- format: "uuid",
39804
- type: "string"
39805
- },
39806
- bridge_client_session_token: { type: "string" },
39807
- bridge_client_time_zone: { type: "string" },
39808
- created_at: { format: "date-time", type: "string" },
39809
- errors: {
39810
- items: {
39811
- description: "Error associated with the `bridge_client_session`.",
39812
- discriminator: { propertyName: "error_code" },
39813
- oneOf: [
39814
- {
39815
- description: "Seam cannot reach the bridge's LAN",
39816
- properties: {
39817
- can_tailscale_proxy_reach_bridge: {
39818
- description: "Tailscale proxy cannot reach the bridge",
39819
- nullable: true,
39820
- type: "boolean"
39821
- },
39822
- can_tailscale_proxy_reach_tailscale_network: {
39823
- description: "Tailscale proxy cannot reach the Tailscale network",
39824
- nullable: true,
39825
- type: "boolean"
39826
- },
39827
- created_at: {
39828
- format: "date-time",
39829
- type: "string"
39830
- },
39831
- error_code: {
39832
- description: "Unique identifier of the type of error. Enables quick recognition and categorization of the issue.",
39833
- enum: ["bridge_lan_unreachable"],
39834
- type: "string"
39835
- },
39836
- is_bridge_socks_server_healthy: {
39837
- description: "Bridge's SOCKS server is unhealthy",
39838
- nullable: true,
39839
- type: "boolean"
39840
- },
39841
- is_tailscale_proxy_reachable: {
39842
- description: "Seam cannot reach the tailscale proxy",
39843
- nullable: true,
39844
- type: "boolean"
39845
- },
39846
- is_tailscale_proxy_socks_server_healthy: {
39847
- description: "Tailscale proxy's SOCKS server is unhealthy",
39848
- nullable: true,
39849
- type: "boolean"
39850
- },
39851
- message: { type: "string" }
39852
- },
39853
- required: [
39854
- "message",
39855
- "created_at",
39856
- "error_code",
39857
- "is_tailscale_proxy_reachable",
39858
- "is_tailscale_proxy_socks_server_healthy",
39859
- "can_tailscale_proxy_reach_tailscale_network",
39860
- "can_tailscale_proxy_reach_bridge",
39861
- "is_bridge_socks_server_healthy"
39862
- ],
39863
- type: "object"
39864
- },
39865
- {
39866
- description: "Bridge has stopped communicating with Seam",
39867
- properties: {
39868
- created_at: {
39869
- format: "date-time",
39870
- type: "string"
39871
- },
39872
- error_code: {
39873
- description: "Unique identifier of the type of error. Enables quick recognition and categorization of the issue.",
39874
- enum: ["no_communication_from_bridge"],
39875
- type: "string"
39876
- },
39877
- message: { type: "string" }
39878
- },
39879
- required: [
39880
- "message",
39881
- "created_at",
39882
- "error_code"
39883
- ],
39884
- type: "object"
39885
- }
39886
- ]
39887
- },
39888
- type: "array"
39889
- },
39890
- pairing_code: {
39891
- maxLength: 6,
39892
- minLength: 6,
39893
- type: "string"
39894
- },
39895
- pairing_code_expires_at: {
39896
- format: "date-time",
39897
- type: "string"
39898
- },
39899
- tailscale_auth_key: { nullable: true, type: "string" },
39900
- tailscale_hostname: { type: "string" },
39901
- telemetry_token: { nullable: true, type: "string" },
39902
- telemetry_token_expires_at: {
39903
- format: "date-time",
39904
- nullable: true,
39905
- type: "string"
39906
- },
39907
- telemetry_url: { nullable: true, type: "string" }
39908
- },
39909
- required: [
39910
- "created_at",
39911
- "bridge_client_session_id",
39912
- "bridge_client_session_token",
39913
- "pairing_code",
39914
- "pairing_code_expires_at",
39915
- "tailscale_hostname",
39916
- "tailscale_auth_key",
39917
- "bridge_client_name",
39918
- "bridge_client_time_zone",
39919
- "bridge_client_machine_identifier_key",
39920
- "errors",
39921
- "telemetry_token",
39922
- "telemetry_token_expires_at",
39923
- "telemetry_url"
39924
- ],
39925
- type: "object",
39926
- "x-route-path": "/seam/bridge/v1/bridge_client_sessions",
39927
- "x-undocumented": "Seam Bridge Client only."
39928
- },
39824
+ magic_link: { $ref: "#/components/schemas/magic_link" },
39929
39825
  ok: { type: "boolean" }
39930
39826
  },
39931
- required: ["bridge_client_session", "ok"],
39827
+ required: ["magic_link", "ok"],
39932
39828
  type: "object"
39933
39829
  }
39934
39830
  }
@@ -39938,13 +39834,13 @@ var openapi_default = {
39938
39834
  400: { description: "Bad Request" },
39939
39835
  401: { description: "Unauthorized" }
39940
39836
  },
39941
- security: [{ certified_client: [] }],
39942
- summary: "/unstable_partner/building_blocks/generate_link",
39837
+ security: [{ api_key: [] }],
39838
+ summary: "/unstable_partner/building_blocks/generate_magic_link",
39943
39839
  tags: [],
39944
39840
  "x-fern-sdk-group-name": ["unstable_partner", "building_blocks"],
39945
- "x-fern-sdk-method-name": "generate_link",
39946
- "x-fern-sdk-return-value": "bridge_client_session",
39947
- "x-response-key": "bridge_client_session",
39841
+ "x-fern-sdk-method-name": "generate_magic_link",
39842
+ "x-fern-sdk-return-value": "magic_link",
39843
+ "x-response-key": "magic_link",
39948
39844
  "x-title": "Generate a building block magic link",
39949
39845
  "x-undocumented": "Experimental partner building blocks."
39950
39846
  }
@@ -39980,7 +39876,9 @@ var openapi_default = {
39980
39876
  starts_at: { type: "string" },
39981
39877
  user_identity_key: { type: "string" }
39982
39878
  },
39983
- type: "object"
39879
+ type: "object",
39880
+ "x-route-path": "/unstable_partner/resources",
39881
+ "x-undocumented": "Unreleased."
39984
39882
  },
39985
39883
  type: "array"
39986
39884
  },
@@ -40005,7 +39903,9 @@ var openapi_default = {
40005
39903
  starts_at: { type: "string" },
40006
39904
  user_identity_key: { type: "string" }
40007
39905
  },
40008
- type: "object"
39906
+ type: "object",
39907
+ "x-route-path": "/unstable_partner/resources",
39908
+ "x-undocumented": "Unreleased."
40009
39909
  }
40010
39910
  ]
40011
39911
  }