@seamapi/types 1.364.0 → 1.365.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 (45) hide show
  1. package/dist/connect.cjs +637 -2
  2. package/dist/connect.cjs.map +1 -1
  3. package/dist/connect.d.cts +1092 -119
  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/acs/acs-access-group.js +1 -2
  8. package/lib/seam/connect/models/acs/acs-access-group.js.map +1 -1
  9. package/lib/seam/connect/models/acs/acs-credential.js +1 -2
  10. package/lib/seam/connect/models/acs/acs-credential.js.map +1 -1
  11. package/lib/seam/connect/models/acs/acs-system.d.ts +1 -1
  12. package/lib/seam/connect/models/acs/acs-system.js +2 -2
  13. package/lib/seam/connect/models/acs/acs-system.js.map +1 -1
  14. package/lib/seam/connect/models/acs/acs-user.js +1 -2
  15. package/lib/seam/connect/models/acs/acs-user.js.map +1 -1
  16. package/lib/seam/connect/models/connected-accounts/connected-account.js +1 -2
  17. package/lib/seam/connect/models/connected-accounts/connected-account.js.map +1 -1
  18. package/lib/seam/connect/models/devices/device.js +1 -2
  19. package/lib/seam/connect/models/devices/device.js.map +1 -1
  20. package/lib/seam/connect/models/index.d.ts +1 -0
  21. package/lib/seam/connect/models/index.js +1 -0
  22. package/lib/seam/connect/models/index.js.map +1 -1
  23. package/lib/seam/connect/models/locations/index.d.ts +1 -0
  24. package/lib/seam/connect/models/locations/index.js +2 -0
  25. package/lib/seam/connect/models/locations/index.js.map +1 -0
  26. package/lib/seam/connect/models/locations/location.d.ts +49 -0
  27. package/lib/seam/connect/models/locations/location.js +25 -0
  28. package/lib/seam/connect/models/locations/location.js.map +1 -0
  29. package/lib/seam/connect/openapi.d.ts +803 -0
  30. package/lib/seam/connect/openapi.js +635 -0
  31. package/lib/seam/connect/openapi.js.map +1 -1
  32. package/lib/seam/connect/route-types.d.ts +170 -0
  33. package/package.json +1 -1
  34. package/src/lib/seam/connect/internal/schemas.ts +2 -0
  35. package/src/lib/seam/connect/models/acs/acs-access-group.ts +1 -2
  36. package/src/lib/seam/connect/models/acs/acs-credential.ts +1 -2
  37. package/src/lib/seam/connect/models/acs/acs-system.ts +2 -2
  38. package/src/lib/seam/connect/models/acs/acs-user.ts +1 -2
  39. package/src/lib/seam/connect/models/connected-accounts/connected-account.ts +1 -2
  40. package/src/lib/seam/connect/models/devices/device.ts +1 -2
  41. package/src/lib/seam/connect/models/index.ts +1 -0
  42. package/src/lib/seam/connect/models/locations/index.ts +1 -0
  43. package/src/lib/seam/connect/models/locations/location.ts +30 -0
  44. package/src/lib/seam/connect/openapi.ts +648 -0
  45. package/src/lib/seam/connect/route-types.ts +182 -0
@@ -14994,6 +14994,8 @@ export interface Routes {
14994
14994
  include_if?: Array<'can_remotely_unlock' | 'can_remotely_lock' | 'can_program_offline_access_codes' | 'can_program_online_access_codes' | 'can_hvac_heat' | 'can_hvac_cool' | 'can_hvac_heat_cool' | 'can_turn_off_hvac' | 'can_simulate_removal' | 'can_simulate_connection' | 'can_simulate_disconnection'> | undefined;
14995
14995
  /** */
14996
14996
  exclude_if?: Array<'can_remotely_unlock' | 'can_remotely_lock' | 'can_program_offline_access_codes' | 'can_program_online_access_codes' | 'can_hvac_heat' | 'can_hvac_cool' | 'can_hvac_heat_cool' | 'can_turn_off_hvac' | 'can_simulate_removal' | 'can_simulate_connection' | 'can_simulate_disconnection'> | undefined;
14997
+ /** */
14998
+ unstable_location_id?: (string | null) | undefined;
14997
14999
  };
14998
15000
  formData: {};
14999
15001
  jsonResponse: {
@@ -16049,6 +16051,8 @@ export interface Routes {
16049
16051
  include_if?: Array<'can_remotely_unlock' | 'can_remotely_lock' | 'can_program_offline_access_codes' | 'can_program_online_access_codes' | 'can_hvac_heat' | 'can_hvac_cool' | 'can_hvac_heat_cool' | 'can_turn_off_hvac' | 'can_simulate_removal' | 'can_simulate_connection' | 'can_simulate_disconnection'> | undefined;
16050
16052
  /** */
16051
16053
  exclude_if?: Array<'can_remotely_unlock' | 'can_remotely_lock' | 'can_program_offline_access_codes' | 'can_program_online_access_codes' | 'can_hvac_heat' | 'can_hvac_cool' | 'can_hvac_heat_cool' | 'can_turn_off_hvac' | 'can_simulate_removal' | 'can_simulate_connection' | 'can_simulate_disconnection'> | undefined;
16054
+ /** */
16055
+ unstable_location_id?: (string | null) | undefined;
16052
16056
  };
16053
16057
  formData: {};
16054
16058
  jsonResponse: {
@@ -20264,6 +20268,8 @@ export interface Routes {
20264
20268
  include_if?: Array<'can_remotely_unlock' | 'can_remotely_lock' | 'can_program_offline_access_codes' | 'can_program_online_access_codes' | 'can_hvac_heat' | 'can_hvac_cool' | 'can_hvac_heat_cool' | 'can_turn_off_hvac' | 'can_simulate_removal' | 'can_simulate_connection' | 'can_simulate_disconnection'> | undefined;
20265
20269
  /** */
20266
20270
  exclude_if?: Array<'can_remotely_unlock' | 'can_remotely_lock' | 'can_program_offline_access_codes' | 'can_program_online_access_codes' | 'can_hvac_heat' | 'can_hvac_cool' | 'can_hvac_heat_cool' | 'can_turn_off_hvac' | 'can_simulate_removal' | 'can_simulate_connection' | 'can_simulate_disconnection'> | undefined;
20271
+ /** */
20272
+ unstable_location_id?: (string | null) | undefined;
20267
20273
  };
20268
20274
  formData: {};
20269
20275
  jsonResponse: {
@@ -23496,6 +23502,8 @@ export interface Routes {
23496
23502
  include_if?: Array<'can_remotely_unlock' | 'can_remotely_lock' | 'can_program_offline_access_codes' | 'can_program_online_access_codes' | 'can_hvac_heat' | 'can_hvac_cool' | 'can_hvac_heat_cool' | 'can_turn_off_hvac' | 'can_simulate_removal' | 'can_simulate_connection' | 'can_simulate_disconnection'> | undefined;
23497
23503
  /** */
23498
23504
  exclude_if?: Array<'can_remotely_unlock' | 'can_remotely_lock' | 'can_program_offline_access_codes' | 'can_program_online_access_codes' | 'can_hvac_heat' | 'can_hvac_cool' | 'can_hvac_heat_cool' | 'can_turn_off_hvac' | 'can_simulate_removal' | 'can_simulate_connection' | 'can_simulate_disconnection'> | undefined;
23505
+ /** */
23506
+ unstable_location_id?: (string | null) | undefined;
23499
23507
  };
23500
23508
  formData: {};
23501
23509
  jsonResponse: {
@@ -32297,6 +32305,8 @@ export interface Routes {
32297
32305
  include_if?: Array<'can_remotely_unlock' | 'can_remotely_lock' | 'can_program_offline_access_codes' | 'can_program_online_access_codes' | 'can_hvac_heat' | 'can_hvac_cool' | 'can_hvac_heat_cool' | 'can_turn_off_hvac' | 'can_simulate_removal' | 'can_simulate_connection' | 'can_simulate_disconnection'> | undefined;
32298
32306
  /** */
32299
32307
  exclude_if?: Array<'can_remotely_unlock' | 'can_remotely_lock' | 'can_program_offline_access_codes' | 'can_program_online_access_codes' | 'can_hvac_heat' | 'can_hvac_cool' | 'can_hvac_heat_cool' | 'can_turn_off_hvac' | 'can_simulate_removal' | 'can_simulate_connection' | 'can_simulate_disconnection'> | undefined;
32308
+ /** */
32309
+ unstable_location_id?: (string | null) | undefined;
32300
32310
  };
32301
32311
  formData: {};
32302
32312
  jsonResponse: {
@@ -36689,6 +36699,166 @@ export interface Routes {
36689
36699
  formData: {};
36690
36700
  jsonResponse: {};
36691
36701
  };
36702
+ '/unstable_locations/add_devices': {
36703
+ route: '/unstable_locations/add_devices';
36704
+ method: 'POST';
36705
+ queryParams: {};
36706
+ jsonBody: {
36707
+ location_id: string;
36708
+ device_ids: string[];
36709
+ };
36710
+ commonParams: {};
36711
+ formData: {};
36712
+ jsonResponse: {};
36713
+ };
36714
+ '/unstable_locations/create': {
36715
+ route: '/unstable_locations/create';
36716
+ method: 'POST';
36717
+ queryParams: {};
36718
+ jsonBody: {
36719
+ name: string;
36720
+ geolocation?: {
36721
+ latitude: number;
36722
+ longitude: number;
36723
+ } | undefined;
36724
+ time_zone?: string | undefined;
36725
+ };
36726
+ commonParams: {};
36727
+ formData: {};
36728
+ jsonResponse: {
36729
+ location: {
36730
+ /** Unique identifier for the location. */
36731
+ location_id: string;
36732
+ /** Unique identifier for the Seam workspace associated with the location. */
36733
+ workspace_id: string;
36734
+ /** Display name of the location. */
36735
+ display_name: string;
36736
+ /** Geographical location of the location. */
36737
+ geolocation?: {
36738
+ latitude: number;
36739
+ longitude: number;
36740
+ } | undefined;
36741
+ /** Time zone of the location. */
36742
+ time_zone?: string | undefined;
36743
+ /** Date and time at which the location object was created. */
36744
+ created_at: string;
36745
+ };
36746
+ };
36747
+ };
36748
+ '/unstable_locations/delete': {
36749
+ route: '/unstable_locations/delete';
36750
+ method: 'DELETE' | 'POST';
36751
+ queryParams: {};
36752
+ jsonBody: {
36753
+ location_id: string;
36754
+ };
36755
+ commonParams: {};
36756
+ formData: {};
36757
+ jsonResponse: {};
36758
+ };
36759
+ '/unstable_locations/get': {
36760
+ route: '/unstable_locations/get';
36761
+ method: 'GET' | 'POST';
36762
+ queryParams: {};
36763
+ jsonBody: {};
36764
+ commonParams: {
36765
+ location_id: string;
36766
+ };
36767
+ formData: {};
36768
+ jsonResponse: {
36769
+ location: {
36770
+ /** Unique identifier for the location. */
36771
+ location_id: string;
36772
+ /** Unique identifier for the Seam workspace associated with the location. */
36773
+ workspace_id: string;
36774
+ /** Display name of the location. */
36775
+ display_name: string;
36776
+ /** Geographical location of the location. */
36777
+ geolocation?: {
36778
+ latitude: number;
36779
+ longitude: number;
36780
+ } | undefined;
36781
+ /** Time zone of the location. */
36782
+ time_zone?: string | undefined;
36783
+ /** Date and time at which the location object was created. */
36784
+ created_at: string;
36785
+ };
36786
+ };
36787
+ };
36788
+ '/unstable_locations/list': {
36789
+ route: '/unstable_locations/list';
36790
+ method: 'GET' | 'POST';
36791
+ queryParams: {};
36792
+ jsonBody: {};
36793
+ commonParams: {};
36794
+ formData: {};
36795
+ jsonResponse: {
36796
+ locations: Array<{
36797
+ /** Unique identifier for the location. */
36798
+ location_id: string;
36799
+ /** Unique identifier for the Seam workspace associated with the location. */
36800
+ workspace_id: string;
36801
+ /** Display name of the location. */
36802
+ display_name: string;
36803
+ /** Geographical location of the location. */
36804
+ geolocation?: {
36805
+ latitude: number;
36806
+ longitude: number;
36807
+ } | undefined;
36808
+ /** Time zone of the location. */
36809
+ time_zone?: string | undefined;
36810
+ /** Date and time at which the location object was created. */
36811
+ created_at: string;
36812
+ }>;
36813
+ };
36814
+ };
36815
+ '/unstable_locations/remove_devices': {
36816
+ route: '/unstable_locations/remove_devices';
36817
+ method: 'POST';
36818
+ queryParams: {};
36819
+ jsonBody: {
36820
+ location_id: string;
36821
+ device_ids: string[];
36822
+ };
36823
+ commonParams: {};
36824
+ formData: {};
36825
+ jsonResponse: {};
36826
+ };
36827
+ '/unstable_locations/update': {
36828
+ route: '/unstable_locations/update';
36829
+ method: 'POST';
36830
+ queryParams: {};
36831
+ jsonBody: {
36832
+ location_id: string;
36833
+ name?: string | undefined;
36834
+ geolocation?: {
36835
+ latitude: number;
36836
+ longitude: number;
36837
+ } | undefined;
36838
+ time_zone?: string | undefined;
36839
+ };
36840
+ commonParams: {};
36841
+ formData: {};
36842
+ jsonResponse: {
36843
+ location: {
36844
+ /** Unique identifier for the location. */
36845
+ location_id: string;
36846
+ /** Unique identifier for the Seam workspace associated with the location. */
36847
+ workspace_id: string;
36848
+ /** Display name of the location. */
36849
+ display_name: string;
36850
+ /** Geographical location of the location. */
36851
+ geolocation?: {
36852
+ latitude: number;
36853
+ longitude: number;
36854
+ } | undefined;
36855
+ /** Time zone of the location. */
36856
+ time_zone?: string | undefined;
36857
+ /** Date and time at which the location object was created. */
36858
+ created_at: string;
36859
+ };
36860
+ };
36861
+ };
36692
36862
  '/user_identities/add_acs_user': {
36693
36863
  route: '/user_identities/add_acs_user';
36694
36864
  method: 'POST' | 'PUT';
package/package.json CHANGED
@@ -1,6 +1,6 @@
1
1
  {
2
2
  "name": "@seamapi/types",
3
- "version": "1.364.0",
3
+ "version": "1.365.0",
4
4
  "description": "TypeScript types for the Seam API.",
5
5
  "type": "module",
6
6
  "main": "index.js",
@@ -34,6 +34,8 @@ export {
34
34
  seam_event as event,
35
35
  seam_event_type as event_type,
36
36
  fan_mode_setting,
37
+ geolocation,
38
+ location,
37
39
  lock_device_type,
38
40
  access_code as managed_access_code,
39
41
  device as managed_device,
@@ -37,8 +37,7 @@ export const unknown_issue_with_acs_access_group =
37
37
  .describe(warning_code_description),
38
38
  })
39
39
  .describe(
40
- 'An unknown issue occurred while syncing the state of this access group with the provider. ' +
41
- 'This issue may affect the proper functioning of this access group.',
40
+ 'An unknown issue occurred while syncing the state of this access group with the provider. This issue may affect the proper functioning of this access group.',
42
41
  )
43
42
 
44
43
  const acs_access_group_warning = unknown_issue_with_acs_access_group.describe(
@@ -86,8 +86,7 @@ export const unknown_issue_with_acs_credential = common_acs_credential_warning
86
86
  .describe(warning_code_description),
87
87
  })
88
88
  .describe(
89
- 'An unknown issue occurred while syncing the state of the [credential](https://docs.seam.co/latest/capability-guides/access-systems/managing-credentials) with the provider. ' +
90
- 'This issue may affect the proper functioning of the credential.',
89
+ 'An unknown issue occurred while syncing the state of the [credential](https://docs.seam.co/latest/capability-guides/access-systems/managing-credentials) with the provider. This issue may affect the proper functioning of the credential.',
91
90
  )
92
91
 
93
92
  const needs_to_be_reissued = common_acs_credential_warning
@@ -27,7 +27,7 @@ export const acs_system_capability_flags = z.object({
27
27
  ),
28
28
  })
29
29
 
30
- export const location = z.object({
30
+ export const acs_location = z.object({
31
31
  time_zone: z
32
32
  .string()
33
33
  .nullable()
@@ -274,7 +274,7 @@ export const acs_system = z
274
274
  deprecated: Use \`external_type_display_name\`.
275
275
  ---
276
276
  `),
277
- location,
277
+ location: acs_location,
278
278
  name: z
279
279
  .string()
280
280
  .describe(
@@ -129,8 +129,7 @@ export const unknown_issue_with_acs_user = common_acs_user_warning
129
129
  warning_code: z.literal('unknown_issue_with_acs_user'),
130
130
  })
131
131
  .describe(
132
- 'An unknown issue occurred while syncing the state of this [ACS user](https://docs.seam.co/latest/capability-guides/access-systems/user-management) with the provider. ' +
133
- 'This issue may affect the proper functioning of this user.',
132
+ 'An unknown issue occurred while syncing the state of this [ACS user](https://docs.seam.co/latest/capability-guides/access-systems/user-management) with the provider. This issue may affect the proper functioning of this user.',
134
133
  )
135
134
 
136
135
  export const acs_users_warning_map = z.object({
@@ -88,8 +88,7 @@ export const unknown_issue_with_connected_account =
88
88
  .describe(warning_code_description),
89
89
  })
90
90
  .describe(
91
- 'An unknown issue occurred while syncing the state of this connected account with the provider. ' +
92
- 'This issue may affect the proper functioning of one or more resources in this account.',
91
+ 'An unknown issue occurred while syncing the state of this connected account with the provider. This issue may affect the proper functioning of one or more resources in this account.',
93
92
  )
94
93
 
95
94
  const scheduled_maintenance_window = common_connected_account_warning
@@ -313,8 +313,7 @@ export const unknown_issue_with_phone = common_device_warning
313
313
  .describe(warning_code_description),
314
314
  })
315
315
  .describe(
316
- 'An unknown issue occurred while syncing the state of this phone with the provider. ' +
317
- 'This issue may affect the proper functioning of this phone.',
316
+ 'An unknown issue occurred while syncing the state of this phone with the provider. This issue may affect the proper functioning of this phone.',
318
317
  )
319
318
 
320
319
  const device_warning = z.discriminatedUnion('warning_code', [
@@ -9,6 +9,7 @@ export * from './connected-accounts/index.js'
9
9
  export * from './custom-metadata.js'
10
10
  export * from './devices/index.js'
11
11
  export * from './events/index.js'
12
+ export * from './locations/index.js'
12
13
  export * from './noise-sensors/index.js'
13
14
  export * from './pagination.js'
14
15
  export * from './phone-number.js'
@@ -0,0 +1 @@
1
+ export * from './location.js'
@@ -0,0 +1,30 @@
1
+ import { z } from 'zod'
2
+
3
+ export const geolocation = z.object({
4
+ latitude: z.number(),
5
+ longitude: z.number(),
6
+ })
7
+
8
+ export const location = z.object({
9
+ location_id: z
10
+ .string()
11
+ .uuid()
12
+ .describe('Unique identifier for the location.'),
13
+ workspace_id: z
14
+ .string()
15
+ .uuid()
16
+ .describe(
17
+ 'Unique identifier for the Seam workspace associated with the location.',
18
+ ),
19
+ display_name: z.string().describe('Display name of the location.'),
20
+ geolocation: geolocation
21
+ .optional()
22
+ .describe('Geographical location of the location.'),
23
+ time_zone: z.string().optional().describe('Time zone of the location.'),
24
+ created_at: z
25
+ .string()
26
+ .datetime()
27
+ .describe('Date and time at which the location object was created.'),
28
+ })
29
+
30
+ export type Location = z.infer<typeof location>