@seamapi/types 1.383.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 (32) hide show
  1. package/dist/connect.cjs +92 -0
  2. package/dist/connect.cjs.map +1 -1
  3. package/dist/connect.d.cts +159 -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/index.d.ts +1 -0
  9. package/lib/seam/connect/models/index.js +1 -0
  10. package/lib/seam/connect/models/index.js.map +1 -1
  11. package/lib/seam/connect/models/instant-keys/index.d.ts +1 -0
  12. package/lib/seam/connect/models/instant-keys/index.js +2 -0
  13. package/lib/seam/connect/models/instant-keys/index.js.map +1 -0
  14. package/lib/seam/connect/models/instant-keys/instant-key.d.ts +27 -0
  15. package/lib/seam/connect/models/instant-keys/instant-key.js +16 -0
  16. package/lib/seam/connect/models/instant-keys/instant-key.js.map +1 -0
  17. package/lib/seam/connect/openapi.d.ts +106 -0
  18. package/lib/seam/connect/openapi.js +77 -0
  19. package/lib/seam/connect/openapi.js.map +1 -1
  20. package/lib/seam/connect/route-types.d.ts +23 -0
  21. package/lib/seam/connect/schemas.d.ts +1 -1
  22. package/lib/seam/connect/schemas.js +1 -1
  23. package/lib/seam/connect/schemas.js.map +1 -1
  24. package/package.json +1 -1
  25. package/src/lib/seam/connect/internal/schemas.ts +1 -0
  26. package/src/lib/seam/connect/model-types.ts +1 -0
  27. package/src/lib/seam/connect/models/index.ts +1 -0
  28. package/src/lib/seam/connect/models/instant-keys/index.ts +1 -0
  29. package/src/lib/seam/connect/models/instant-keys/instant-key.ts +18 -0
  30. package/src/lib/seam/connect/openapi.ts +79 -0
  31. package/src/lib/seam/connect/route-types.ts +23 -0
  32. package/src/lib/seam/connect/schemas.ts +1 -0
@@ -40585,6 +40585,29 @@ export interface Routes {
40585
40585
  }>;
40586
40586
  };
40587
40587
  };
40588
+ '/user_identities/generate_instant_key': {
40589
+ route: '/user_identities/generate_instant_key';
40590
+ method: 'POST';
40591
+ queryParams: {};
40592
+ jsonBody: {};
40593
+ commonParams: {
40594
+ /** ID of the user identity for which you want to generate an instant key. */
40595
+ user_identity_id: string;
40596
+ };
40597
+ formData: {};
40598
+ jsonResponse: {
40599
+ /** */
40600
+ instant_key: {
40601
+ instant_key_id: string;
40602
+ workspace_id: string;
40603
+ created_at: string;
40604
+ instant_key_url: string;
40605
+ client_session_id: string;
40606
+ user_identity_id: string;
40607
+ expires_at: string;
40608
+ };
40609
+ };
40610
+ };
40588
40611
  '/user_identities/get': {
40589
40612
  route: '/user_identities/get';
40590
40613
  method: 'GET' | 'POST';
@@ -1 +1 @@
1
- export { access_code, acs_access_group, acs_credential, acs_encoder, acs_entrance, acs_system, acs_user, action_attempt, bridge, bridge_client_session, client_session, common_failed_action_attempt, common_pending_action_attempt, common_succeeded_action_attempt, connect_webview, connected_account, custom_metadata, device, device_provider, noise_threshold, pagination, seam_event, thermostat_schedule, unmanaged_access_code, unmanaged_acs_access_group, unmanaged_acs_credential, unmanaged_acs_user, unmanaged_device, user_identity, webhook, workspace, } from './models/index.js';
1
+ export { access_code, acs_access_group, acs_credential, acs_encoder, acs_entrance, acs_system, acs_user, action_attempt, bridge, bridge_client_session, client_session, common_failed_action_attempt, common_pending_action_attempt, common_succeeded_action_attempt, connect_webview, connected_account, custom_metadata, device, device_provider, instant_key, noise_threshold, pagination, seam_event, thermostat_schedule, unmanaged_access_code, unmanaged_acs_access_group, unmanaged_acs_credential, unmanaged_acs_user, unmanaged_device, user_identity, webhook, workspace, } from './models/index.js';
@@ -1,2 +1,2 @@
1
- export { access_code, acs_access_group, acs_credential, acs_encoder, acs_entrance, acs_system, acs_user, action_attempt, bridge, bridge_client_session, client_session, common_failed_action_attempt, common_pending_action_attempt, common_succeeded_action_attempt, connect_webview, connected_account, custom_metadata, device, device_provider, noise_threshold, pagination, seam_event, thermostat_schedule, unmanaged_access_code, unmanaged_acs_access_group, unmanaged_acs_credential, unmanaged_acs_user, unmanaged_device, user_identity, webhook, workspace, } from './models/index.js';
1
+ export { access_code, acs_access_group, acs_credential, acs_encoder, acs_entrance, acs_system, acs_user, action_attempt, bridge, bridge_client_session, client_session, common_failed_action_attempt, common_pending_action_attempt, common_succeeded_action_attempt, connect_webview, connected_account, custom_metadata, device, device_provider, instant_key, noise_threshold, pagination, seam_event, thermostat_schedule, unmanaged_access_code, unmanaged_acs_access_group, unmanaged_acs_credential, unmanaged_acs_user, unmanaged_device, user_identity, webhook, workspace, } from './models/index.js';
2
2
  //# sourceMappingURL=schemas.js.map
@@ -1 +1 @@
1
- {"version":3,"file":"schemas.js","sourceRoot":"","sources":["../../../src/lib/seam/connect/schemas.ts"],"names":[],"mappings":"AAAA,OAAO,EACL,WAAW,EACX,gBAAgB,EAChB,cAAc,EACd,WAAW,EACX,YAAY,EACZ,UAAU,EACV,QAAQ,EACR,cAAc,EACd,MAAM,EACN,qBAAqB,EACrB,cAAc,EACd,4BAA4B,EAC5B,6BAA6B,EAC7B,+BAA+B,EAC/B,eAAe,EACf,iBAAiB,EACjB,eAAe,EACf,MAAM,EACN,eAAe,EACf,eAAe,EACf,UAAU,EACV,UAAU,EACV,mBAAmB,EACnB,qBAAqB,EACrB,0BAA0B,EAC1B,wBAAwB,EACxB,kBAAkB,EAClB,gBAAgB,EAChB,aAAa,EACb,OAAO,EACP,SAAS,GACV,MAAM,mBAAmB,CAAA"}
1
+ {"version":3,"file":"schemas.js","sourceRoot":"","sources":["../../../src/lib/seam/connect/schemas.ts"],"names":[],"mappings":"AAAA,OAAO,EACL,WAAW,EACX,gBAAgB,EAChB,cAAc,EACd,WAAW,EACX,YAAY,EACZ,UAAU,EACV,QAAQ,EACR,cAAc,EACd,MAAM,EACN,qBAAqB,EACrB,cAAc,EACd,4BAA4B,EAC5B,6BAA6B,EAC7B,+BAA+B,EAC/B,eAAe,EACf,iBAAiB,EACjB,eAAe,EACf,MAAM,EACN,eAAe,EACf,WAAW,EACX,eAAe,EACf,UAAU,EACV,UAAU,EACV,mBAAmB,EACnB,qBAAqB,EACrB,0BAA0B,EAC1B,wBAAwB,EACxB,kBAAkB,EAClB,gBAAgB,EAChB,aAAa,EACb,OAAO,EACP,SAAS,GACV,MAAM,mBAAmB,CAAA"}
package/package.json CHANGED
@@ -1,6 +1,6 @@
1
1
  {
2
2
  "name": "@seamapi/types",
3
- "version": "1.383.0",
3
+ "version": "1.384.0",
4
4
  "description": "TypeScript types for the Seam API.",
5
5
  "type": "module",
6
6
  "main": "index.js",
@@ -38,6 +38,7 @@ export {
38
38
  seam_event_type as event_type,
39
39
  fan_mode_setting,
40
40
  geolocation,
41
+ instant_key,
41
42
  location,
42
43
  lock_device_type,
43
44
  access_code as managed_access_code,
@@ -18,6 +18,7 @@ export type {
18
18
  DeviceError,
19
19
  DeviceProvider,
20
20
  DeviceWarning,
21
+ InstantKey,
21
22
  NoiseThreshold,
22
23
  SeamEvent,
23
24
  SeamEventType,
@@ -10,6 +10,7 @@ export * from './connected-accounts/index.js'
10
10
  export * from './custom-metadata.js'
11
11
  export * from './devices/index.js'
12
12
  export * from './events/index.js'
13
+ export * from './instant-keys/index.js'
13
14
  export * from './locations/index.js'
14
15
  export * from './noise-sensors/index.js'
15
16
  export * from './pagination.js'
@@ -0,0 +1 @@
1
+ export * from './instant-key.js'
@@ -0,0 +1,18 @@
1
+ import { z } from 'zod'
2
+
3
+ export const instant_key = z.object({
4
+ instant_key_id: z.string().uuid(),
5
+ workspace_id: z.string().uuid(),
6
+ created_at: z.string().datetime(),
7
+ instant_key_url: z.string().url(),
8
+ client_session_id: z.string().uuid(),
9
+ user_identity_id: z.string().uuid(),
10
+ expires_at: z.string().datetime(),
11
+ }).describe(`
12
+ ---
13
+ route_path: /user_identities
14
+ undocumented: Unreleased.
15
+ ---
16
+ `)
17
+
18
+ export type InstantKey = z.infer<typeof instant_key>
@@ -13659,6 +13659,29 @@ export default {
13659
13659
  ],
13660
13660
  'x-route-path': '/events',
13661
13661
  },
13662
+ instant_key: {
13663
+ properties: {
13664
+ client_session_id: { format: 'uuid', type: 'string' },
13665
+ created_at: { format: 'date-time', type: 'string' },
13666
+ expires_at: { format: 'date-time', type: 'string' },
13667
+ instant_key_id: { format: 'uuid', type: 'string' },
13668
+ instant_key_url: { format: 'uri', type: 'string' },
13669
+ user_identity_id: { format: 'uuid', type: 'string' },
13670
+ workspace_id: { format: 'uuid', type: 'string' },
13671
+ },
13672
+ required: [
13673
+ 'instant_key_id',
13674
+ 'workspace_id',
13675
+ 'created_at',
13676
+ 'instant_key_url',
13677
+ 'client_session_id',
13678
+ 'user_identity_id',
13679
+ 'expires_at',
13680
+ ],
13681
+ type: 'object',
13682
+ 'x-route-path': '/user_identities',
13683
+ 'x-undocumented': 'Unreleased.',
13684
+ },
13662
13685
  network: {
13663
13686
  properties: {
13664
13687
  created_at: { format: 'date-time', type: 'string' },
@@ -32357,6 +32380,62 @@ export default {
32357
32380
  'x-title': 'List Enrollment Automations',
32358
32381
  },
32359
32382
  },
32383
+ '/user_identities/generate_instant_key': {
32384
+ post: {
32385
+ description:
32386
+ '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).',
32387
+ operationId: 'userIdentitiesGenerateInstantKeyPost',
32388
+ requestBody: {
32389
+ content: {
32390
+ 'application/json': {
32391
+ schema: {
32392
+ properties: {
32393
+ user_identity_id: {
32394
+ description:
32395
+ 'ID of the user identity for which you want to generate an instant key.',
32396
+ format: 'uuid',
32397
+ type: 'string',
32398
+ },
32399
+ },
32400
+ required: ['user_identity_id'],
32401
+ type: 'object',
32402
+ },
32403
+ },
32404
+ },
32405
+ },
32406
+ responses: {
32407
+ 200: {
32408
+ content: {
32409
+ 'application/json': {
32410
+ schema: {
32411
+ properties: {
32412
+ instant_key: { $ref: '#/components/schemas/instant_key' },
32413
+ ok: { type: 'boolean' },
32414
+ },
32415
+ required: ['instant_key', 'ok'],
32416
+ type: 'object',
32417
+ },
32418
+ },
32419
+ },
32420
+ description: 'OK',
32421
+ },
32422
+ 400: { description: 'Bad Request' },
32423
+ 401: { description: 'Unauthorized' },
32424
+ },
32425
+ security: [
32426
+ { api_key: [] },
32427
+ { pat_with_workspace: [] },
32428
+ { console_session_with_workspace: [] },
32429
+ ],
32430
+ summary: '/user_identities/generate_instant_key',
32431
+ tags: ['/user_identities'],
32432
+ 'x-fern-sdk-group-name': ['user_identities'],
32433
+ 'x-fern-sdk-method-name': 'generate_instant_key',
32434
+ 'x-fern-sdk-return-value': 'instant_key',
32435
+ 'x-response-key': 'instant_key',
32436
+ 'x-title': 'Generate an Instant Key',
32437
+ },
32438
+ },
32360
32439
  '/user_identities/get': {
32361
32440
  post: {
32362
32441
  description:
@@ -48896,6 +48896,29 @@ export interface Routes {
48896
48896
  }>
48897
48897
  }
48898
48898
  }
48899
+ '/user_identities/generate_instant_key': {
48900
+ route: '/user_identities/generate_instant_key'
48901
+ method: 'POST'
48902
+ queryParams: {}
48903
+ jsonBody: {}
48904
+ commonParams: {
48905
+ /** ID of the user identity for which you want to generate an instant key. */
48906
+ user_identity_id: string
48907
+ }
48908
+ formData: {}
48909
+ jsonResponse: {
48910
+ /** */
48911
+ instant_key: {
48912
+ instant_key_id: string
48913
+ workspace_id: string
48914
+ created_at: string
48915
+ instant_key_url: string
48916
+ client_session_id: string
48917
+ user_identity_id: string
48918
+ expires_at: string
48919
+ }
48920
+ }
48921
+ }
48899
48922
  '/user_identities/get': {
48900
48923
  route: '/user_identities/get'
48901
48924
  method: 'GET' | 'POST'
@@ -18,6 +18,7 @@ export {
18
18
  custom_metadata,
19
19
  device,
20
20
  device_provider,
21
+ instant_key,
21
22
  noise_threshold,
22
23
  pagination,
23
24
  seam_event,