@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.
Files changed (36) hide show
  1. package/dist/connect.cjs +315 -9
  2. package/dist/connect.cjs.map +1 -1
  3. package/dist/connect.d.cts +450 -2
  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/model-types.d.ts +1 -1
  8. package/lib/seam/connect/models/bridges/bridge-client-session.d.ts +9 -0
  9. package/lib/seam/connect/models/bridges/bridge-client-session.js +3 -0
  10. package/lib/seam/connect/models/bridges/bridge-client-session.js.map +1 -1
  11. package/lib/seam/connect/models/index.d.ts +1 -0
  12. package/lib/seam/connect/models/index.js +1 -0
  13. package/lib/seam/connect/models/index.js.map +1 -1
  14. package/lib/seam/connect/models/instant-keys/index.d.ts +1 -0
  15. package/lib/seam/connect/models/instant-keys/index.js +2 -0
  16. package/lib/seam/connect/models/instant-keys/index.js.map +1 -0
  17. package/lib/seam/connect/models/instant-keys/instant-key.d.ts +27 -0
  18. package/lib/seam/connect/models/instant-keys/instant-key.js +16 -0
  19. package/lib/seam/connect/models/instant-keys/instant-key.js.map +1 -0
  20. package/lib/seam/connect/openapi.d.ts +332 -0
  21. package/lib/seam/connect/openapi.js +288 -0
  22. package/lib/seam/connect/openapi.js.map +1 -1
  23. package/lib/seam/connect/route-types.d.ts +79 -0
  24. package/lib/seam/connect/schemas.d.ts +1 -1
  25. package/lib/seam/connect/schemas.js +1 -1
  26. package/lib/seam/connect/schemas.js.map +1 -1
  27. package/package.json +1 -1
  28. package/src/lib/seam/connect/internal/schemas.ts +1 -0
  29. package/src/lib/seam/connect/model-types.ts +1 -0
  30. package/src/lib/seam/connect/models/bridges/bridge-client-session.ts +3 -0
  31. package/src/lib/seam/connect/models/index.ts +1 -0
  32. package/src/lib/seam/connect/models/instant-keys/index.ts +1 -0
  33. package/src/lib/seam/connect/models/instant-keys/instant-key.ts +18 -0
  34. package/src/lib/seam/connect/openapi.ts +303 -0
  35. package/src/lib/seam/connect/route-types.ts +82 -0
  36. package/src/lib/seam/connect/schemas.ts +1 -0
package/dist/connect.cjs CHANGED
@@ -30,6 +30,7 @@ __export(schemas_exports, {
30
30
  custom_metadata: () => custom_metadata,
31
31
  device: () => device,
32
32
  device_provider: () => device_provider,
33
+ instant_key: () => instant_key,
33
34
  noise_threshold: () => noise_threshold,
34
35
  pagination: () => pagination,
35
36
  seam_event: () => seam_event,
@@ -3086,7 +3087,10 @@ var bridge_client_session = zod.z.object({
3086
3087
  bridge_client_name: zod.z.string(),
3087
3088
  bridge_client_time_zone: zod.z.string(),
3088
3089
  bridge_client_machine_identifier_key: zod.z.string(),
3089
- errors: zod.z.array(bridge_client_session_error)
3090
+ errors: zod.z.array(bridge_client_session_error),
3091
+ telemetry_token: zod.z.string().nullable(),
3092
+ telemetry_token_expires_at: zod.z.string().datetime().nullable(),
3093
+ telemetry_url: zod.z.string().nullable()
3090
3094
  }).describe(`
3091
3095
  ---
3092
3096
  route_path: /seam/bridge/v1/bridge_client_sessions
@@ -4167,6 +4171,20 @@ var event_types = seam_event.options.map(
4167
4171
  zod.z.enum(
4168
4172
  event_types
4169
4173
  );
4174
+ var instant_key = zod.z.object({
4175
+ instant_key_id: zod.z.string().uuid(),
4176
+ workspace_id: zod.z.string().uuid(),
4177
+ created_at: zod.z.string().datetime(),
4178
+ instant_key_url: zod.z.string().url(),
4179
+ client_session_id: zod.z.string().uuid(),
4180
+ user_identity_id: zod.z.string().uuid(),
4181
+ expires_at: zod.z.string().datetime()
4182
+ }).describe(`
4183
+ ---
4184
+ route_path: /user_identities
4185
+ undocumented: Unreleased.
4186
+ ---
4187
+ `);
4170
4188
  var noise_threshold = zod.z.object({
4171
4189
  noise_threshold_id: zod.z.string().uuid(),
4172
4190
  device_id: zod.z.string().uuid(),
@@ -16744,6 +16762,29 @@ var openapi_default = {
16744
16762
  ],
16745
16763
  "x-route-path": "/events"
16746
16764
  },
16765
+ instant_key: {
16766
+ properties: {
16767
+ client_session_id: { format: "uuid", type: "string" },
16768
+ created_at: { format: "date-time", type: "string" },
16769
+ expires_at: { format: "date-time", type: "string" },
16770
+ instant_key_id: { format: "uuid", type: "string" },
16771
+ instant_key_url: { format: "uri", type: "string" },
16772
+ user_identity_id: { format: "uuid", type: "string" },
16773
+ workspace_id: { format: "uuid", type: "string" }
16774
+ },
16775
+ required: [
16776
+ "instant_key_id",
16777
+ "workspace_id",
16778
+ "created_at",
16779
+ "instant_key_url",
16780
+ "client_session_id",
16781
+ "user_identity_id",
16782
+ "expires_at"
16783
+ ],
16784
+ type: "object",
16785
+ "x-route-path": "/user_identities",
16786
+ "x-undocumented": "Unreleased."
16787
+ },
16747
16788
  network: {
16748
16789
  properties: {
16749
16790
  created_at: { format: "date-time", type: "string" },
@@ -29688,7 +29729,14 @@ var openapi_default = {
29688
29729
  type: "string"
29689
29730
  },
29690
29731
  tailscale_auth_key: { nullable: true, type: "string" },
29691
- tailscale_hostname: { type: "string" }
29732
+ tailscale_hostname: { type: "string" },
29733
+ telemetry_token: { nullable: true, type: "string" },
29734
+ telemetry_token_expires_at: {
29735
+ format: "date-time",
29736
+ nullable: true,
29737
+ type: "string"
29738
+ },
29739
+ telemetry_url: { nullable: true, type: "string" }
29692
29740
  },
29693
29741
  required: [
29694
29742
  "created_at",
@@ -29701,7 +29749,10 @@ var openapi_default = {
29701
29749
  "bridge_client_name",
29702
29750
  "bridge_client_time_zone",
29703
29751
  "bridge_client_machine_identifier_key",
29704
- "errors"
29752
+ "errors",
29753
+ "telemetry_token",
29754
+ "telemetry_token_expires_at",
29755
+ "telemetry_url"
29705
29756
  ],
29706
29757
  type: "object",
29707
29758
  "x-route-path": "/seam/bridge/v1/bridge_client_sessions",
@@ -29849,7 +29900,14 @@ var openapi_default = {
29849
29900
  type: "string"
29850
29901
  },
29851
29902
  tailscale_auth_key: { nullable: true, type: "string" },
29852
- tailscale_hostname: { type: "string" }
29903
+ tailscale_hostname: { type: "string" },
29904
+ telemetry_token: { nullable: true, type: "string" },
29905
+ telemetry_token_expires_at: {
29906
+ format: "date-time",
29907
+ nullable: true,
29908
+ type: "string"
29909
+ },
29910
+ telemetry_url: { nullable: true, type: "string" }
29853
29911
  },
29854
29912
  required: [
29855
29913
  "created_at",
@@ -29862,7 +29920,10 @@ var openapi_default = {
29862
29920
  "bridge_client_name",
29863
29921
  "bridge_client_time_zone",
29864
29922
  "bridge_client_machine_identifier_key",
29865
- "errors"
29923
+ "errors",
29924
+ "telemetry_token",
29925
+ "telemetry_token_expires_at",
29926
+ "telemetry_url"
29866
29927
  ],
29867
29928
  type: "object",
29868
29929
  "x-route-path": "/seam/bridge/v1/bridge_client_sessions",
@@ -30001,7 +30062,14 @@ var openapi_default = {
30001
30062
  type: "string"
30002
30063
  },
30003
30064
  tailscale_auth_key: { nullable: true, type: "string" },
30004
- tailscale_hostname: { type: "string" }
30065
+ tailscale_hostname: { type: "string" },
30066
+ telemetry_token: { nullable: true, type: "string" },
30067
+ telemetry_token_expires_at: {
30068
+ format: "date-time",
30069
+ nullable: true,
30070
+ type: "string"
30071
+ },
30072
+ telemetry_url: { nullable: true, type: "string" }
30005
30073
  },
30006
30074
  required: [
30007
30075
  "created_at",
@@ -30014,7 +30082,10 @@ var openapi_default = {
30014
30082
  "bridge_client_name",
30015
30083
  "bridge_client_time_zone",
30016
30084
  "bridge_client_machine_identifier_key",
30017
- "errors"
30085
+ "errors",
30086
+ "telemetry_token",
30087
+ "telemetry_token_expires_at",
30088
+ "telemetry_url"
30018
30089
  ],
30019
30090
  type: "object",
30020
30091
  "x-route-path": "/seam/bridge/v1/bridge_client_sessions",
@@ -30048,6 +30119,177 @@ var openapi_default = {
30048
30119
  "x-undocumented": "Seam Bridge Client only."
30049
30120
  }
30050
30121
  },
30122
+ "/seam/bridge/v1/bridge_client_sessions/refresh_telemetry_token": {
30123
+ post: {
30124
+ description: "Returns the bridge client session associated with the session token and refreshed telemetry token.",
30125
+ operationId: "seamBridgeV1BridgeClientSessionsRefreshTelemetryTokenPost",
30126
+ responses: {
30127
+ 200: {
30128
+ content: {
30129
+ "application/json": {
30130
+ schema: {
30131
+ properties: {
30132
+ bridge_client_session: {
30133
+ properties: {
30134
+ bridge_client_machine_identifier_key: {
30135
+ type: "string"
30136
+ },
30137
+ bridge_client_name: { type: "string" },
30138
+ bridge_client_session_id: {
30139
+ format: "uuid",
30140
+ type: "string"
30141
+ },
30142
+ bridge_client_session_token: { type: "string" },
30143
+ bridge_client_time_zone: { type: "string" },
30144
+ created_at: { format: "date-time", type: "string" },
30145
+ errors: {
30146
+ items: {
30147
+ description: "Error associated with the `bridge_client_session`.",
30148
+ discriminator: { propertyName: "error_code" },
30149
+ oneOf: [
30150
+ {
30151
+ description: "Seam cannot reach the bridge's LAN",
30152
+ properties: {
30153
+ can_tailscale_proxy_reach_bridge: {
30154
+ description: "Tailscale proxy cannot reach the bridge",
30155
+ nullable: true,
30156
+ type: "boolean"
30157
+ },
30158
+ can_tailscale_proxy_reach_tailscale_network: {
30159
+ description: "Tailscale proxy cannot reach the Tailscale network",
30160
+ nullable: true,
30161
+ type: "boolean"
30162
+ },
30163
+ created_at: {
30164
+ format: "date-time",
30165
+ type: "string"
30166
+ },
30167
+ error_code: {
30168
+ description: "Unique identifier of the type of error. Enables quick recognition and categorization of the issue.",
30169
+ enum: ["bridge_lan_unreachable"],
30170
+ type: "string"
30171
+ },
30172
+ is_bridge_socks_server_healthy: {
30173
+ description: "Bridge's SOCKS server is unhealthy",
30174
+ nullable: true,
30175
+ type: "boolean"
30176
+ },
30177
+ is_tailscale_proxy_reachable: {
30178
+ description: "Seam cannot reach the tailscale proxy",
30179
+ nullable: true,
30180
+ type: "boolean"
30181
+ },
30182
+ is_tailscale_proxy_socks_server_healthy: {
30183
+ description: "Tailscale proxy's SOCKS server is unhealthy",
30184
+ nullable: true,
30185
+ type: "boolean"
30186
+ },
30187
+ message: { type: "string" }
30188
+ },
30189
+ required: [
30190
+ "message",
30191
+ "created_at",
30192
+ "error_code",
30193
+ "is_tailscale_proxy_reachable",
30194
+ "is_tailscale_proxy_socks_server_healthy",
30195
+ "can_tailscale_proxy_reach_tailscale_network",
30196
+ "can_tailscale_proxy_reach_bridge",
30197
+ "is_bridge_socks_server_healthy"
30198
+ ],
30199
+ type: "object"
30200
+ },
30201
+ {
30202
+ description: "Bridge has stopped communicating with Seam",
30203
+ properties: {
30204
+ created_at: {
30205
+ format: "date-time",
30206
+ type: "string"
30207
+ },
30208
+ error_code: {
30209
+ description: "Unique identifier of the type of error. Enables quick recognition and categorization of the issue.",
30210
+ enum: ["no_communication_from_bridge"],
30211
+ type: "string"
30212
+ },
30213
+ message: { type: "string" }
30214
+ },
30215
+ required: [
30216
+ "message",
30217
+ "created_at",
30218
+ "error_code"
30219
+ ],
30220
+ type: "object"
30221
+ }
30222
+ ]
30223
+ },
30224
+ type: "array"
30225
+ },
30226
+ pairing_code: {
30227
+ maxLength: 6,
30228
+ minLength: 6,
30229
+ type: "string"
30230
+ },
30231
+ pairing_code_expires_at: {
30232
+ format: "date-time",
30233
+ type: "string"
30234
+ },
30235
+ tailscale_auth_key: { nullable: true, type: "string" },
30236
+ tailscale_hostname: { type: "string" },
30237
+ telemetry_token: { nullable: true, type: "string" },
30238
+ telemetry_token_expires_at: {
30239
+ format: "date-time",
30240
+ nullable: true,
30241
+ type: "string"
30242
+ },
30243
+ telemetry_url: { nullable: true, type: "string" }
30244
+ },
30245
+ required: [
30246
+ "created_at",
30247
+ "bridge_client_session_id",
30248
+ "bridge_client_session_token",
30249
+ "pairing_code",
30250
+ "pairing_code_expires_at",
30251
+ "tailscale_hostname",
30252
+ "tailscale_auth_key",
30253
+ "bridge_client_name",
30254
+ "bridge_client_time_zone",
30255
+ "bridge_client_machine_identifier_key",
30256
+ "errors",
30257
+ "telemetry_token",
30258
+ "telemetry_token_expires_at",
30259
+ "telemetry_url"
30260
+ ],
30261
+ type: "object",
30262
+ "x-route-path": "/seam/bridge/v1/bridge_client_sessions",
30263
+ "x-undocumented": "Seam Bridge Client only."
30264
+ },
30265
+ ok: { type: "boolean" }
30266
+ },
30267
+ required: ["bridge_client_session", "ok"],
30268
+ type: "object"
30269
+ }
30270
+ }
30271
+ },
30272
+ description: "OK"
30273
+ },
30274
+ 400: { description: "Bad Request" },
30275
+ 401: { description: "Unauthorized" }
30276
+ },
30277
+ security: [{ bridge_client_session: [] }],
30278
+ summary: "/seam/bridge/v1/bridge_client_sessions/refresh_telemetry_token",
30279
+ tags: [],
30280
+ "x-fern-sdk-group-name": [
30281
+ "seam",
30282
+ "bridge",
30283
+ "v1",
30284
+ "bridge_client_sessions"
30285
+ ],
30286
+ "x-fern-sdk-method-name": "refresh_telemetry_token",
30287
+ "x-fern-sdk-return-value": "bridge_client_session",
30288
+ "x-response-key": "bridge_client_session",
30289
+ "x-title": "Refresh telemetry token for bridge client session",
30290
+ "x-undocumented": "Seam Bridge Client only."
30291
+ }
30292
+ },
30051
30293
  "/seam/bridge/v1/bridge_client_sessions/regenerate_pairing_code": {
30052
30294
  post: {
30053
30295
  description: "Generate a new pairing code and return the updated bridge client session.",
@@ -30162,7 +30404,14 @@ var openapi_default = {
30162
30404
  type: "string"
30163
30405
  },
30164
30406
  tailscale_auth_key: { nullable: true, type: "string" },
30165
- tailscale_hostname: { type: "string" }
30407
+ tailscale_hostname: { type: "string" },
30408
+ telemetry_token: { nullable: true, type: "string" },
30409
+ telemetry_token_expires_at: {
30410
+ format: "date-time",
30411
+ nullable: true,
30412
+ type: "string"
30413
+ },
30414
+ telemetry_url: { nullable: true, type: "string" }
30166
30415
  },
30167
30416
  required: [
30168
30417
  "created_at",
@@ -30175,7 +30424,10 @@ var openapi_default = {
30175
30424
  "bridge_client_name",
30176
30425
  "bridge_client_time_zone",
30177
30426
  "bridge_client_machine_identifier_key",
30178
- "errors"
30427
+ "errors",
30428
+ "telemetry_token",
30429
+ "telemetry_token_expires_at",
30430
+ "telemetry_url"
30179
30431
  ],
30180
30432
  type: "object",
30181
30433
  "x-route-path": "/seam/bridge/v1/bridge_client_sessions",
@@ -34268,6 +34520,60 @@ var openapi_default = {
34268
34520
  "x-title": "List Enrollment Automations"
34269
34521
  }
34270
34522
  },
34523
+ "/user_identities/generate_instant_key": {
34524
+ post: {
34525
+ 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).",
34526
+ operationId: "userIdentitiesGenerateInstantKeyPost",
34527
+ requestBody: {
34528
+ content: {
34529
+ "application/json": {
34530
+ schema: {
34531
+ properties: {
34532
+ user_identity_id: {
34533
+ description: "ID of the user identity for which you want to generate an instant key.",
34534
+ format: "uuid",
34535
+ type: "string"
34536
+ }
34537
+ },
34538
+ required: ["user_identity_id"],
34539
+ type: "object"
34540
+ }
34541
+ }
34542
+ }
34543
+ },
34544
+ responses: {
34545
+ 200: {
34546
+ content: {
34547
+ "application/json": {
34548
+ schema: {
34549
+ properties: {
34550
+ instant_key: { $ref: "#/components/schemas/instant_key" },
34551
+ ok: { type: "boolean" }
34552
+ },
34553
+ required: ["instant_key", "ok"],
34554
+ type: "object"
34555
+ }
34556
+ }
34557
+ },
34558
+ description: "OK"
34559
+ },
34560
+ 400: { description: "Bad Request" },
34561
+ 401: { description: "Unauthorized" }
34562
+ },
34563
+ security: [
34564
+ { api_key: [] },
34565
+ { pat_with_workspace: [] },
34566
+ { console_session_with_workspace: [] }
34567
+ ],
34568
+ summary: "/user_identities/generate_instant_key",
34569
+ tags: ["/user_identities"],
34570
+ "x-fern-sdk-group-name": ["user_identities"],
34571
+ "x-fern-sdk-method-name": "generate_instant_key",
34572
+ "x-fern-sdk-return-value": "instant_key",
34573
+ "x-response-key": "instant_key",
34574
+ "x-title": "Generate an Instant Key"
34575
+ }
34576
+ },
34271
34577
  "/user_identities/get": {
34272
34578
  post: {
34273
34579
  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).",