@seamapi/types 1.448.0 → 1.450.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.
@@ -9994,6 +9994,8 @@ export interface Routes {
9994
9994
  }>;
9995
9995
  /** IDs of the access methods created for the Access Grant. */
9996
9996
  access_method_ids: string[];
9997
+ /** Client Session Token. Only returned if the Access Grant has a mobile_key access method. */
9998
+ client_session_token?: string | undefined;
9997
9999
  /** Display name of the Access Grant. */
9998
10000
  display_name: string;
9999
10001
  /** Instant Key URL. Only returned if the Access Grant has a single mobile_key access_method. */
@@ -10061,6 +10063,8 @@ export interface Routes {
10061
10063
  }>;
10062
10064
  /** IDs of the access methods created for the Access Grant. */
10063
10065
  access_method_ids: string[];
10066
+ /** Client Session Token. Only returned if the Access Grant has a mobile_key access method. */
10067
+ client_session_token?: string | undefined;
10064
10068
  /** Display name of the Access Grant. */
10065
10069
  display_name: string;
10066
10070
  /** Instant Key URL. Only returned if the Access Grant has a single mobile_key access_method. */
@@ -10123,6 +10127,8 @@ export interface Routes {
10123
10127
  }>;
10124
10128
  /** IDs of the access methods created for the Access Grant. */
10125
10129
  access_method_ids: string[];
10130
+ /** Client Session Token. Only returned if the Access Grant has a mobile_key access method. */
10131
+ client_session_token?: string | undefined;
10126
10132
  /** Display name of the Access Grant. */
10127
10133
  display_name: string;
10128
10134
  /** Instant Key URL. Only returned if the Access Grant has a single mobile_key access_method. */
@@ -22005,6 +22011,8 @@ export interface Routes {
22005
22011
  automatically_manage_new_devices?: boolean | undefined;
22006
22012
  /** Custom metadata that you want to associate with the connected account. Supports up to 50 JSON key:value pairs. [Adding custom metadata to a connected account](https://docs.seam.co/latest/core-concepts/connected-accounts/adding-custom-metadata-to-a-connected-account) enables you to store custom information, like customer details or internal IDs from your application. Then, you can [filter connected accounts by the desired metadata](https://docs.seam.co/latest/core-concepts/connected-accounts/filtering-connected-accounts-by-custom-metadata). */
22007
22013
  custom_metadata?: Record<string, string | boolean | null> | undefined;
22014
+ /** List of accepted device capabilities that restrict the types of devices that can be connected through this connected account. Valid values are `lock`, `thermostat`, `noise_sensor`, and `access_control`. */
22015
+ accepted_capabilities?: Array<'lock' | 'thermostat' | 'noise_sensor' | 'access_control'> | undefined;
22008
22016
  };
22009
22017
  commonParams: {};
22010
22018
  formData: {};
@@ -46550,6 +46558,7 @@ export interface Routes {
46550
46558
  name: string;
46551
46559
  }>;
46552
46560
  needs_review?: boolean | undefined;
46561
+ is_draft?: boolean | undefined;
46553
46562
  }>;
46554
46563
  };
46555
46564
  };
@@ -47967,6 +47976,8 @@ export interface Routes {
47967
47976
  commonParams: {
47968
47977
  /** String for which to search. Filters returned spaces to include all records that satisfy a partial match using `name`. */
47969
47978
  search?: string | undefined;
47979
+ /** Filter spaces to only include those that contain devices or access control systems belonging to the specified connected account. */
47980
+ connected_account_id?: string | undefined;
47970
47981
  /** Filter spaces by space_key. */
47971
47982
  space_key?: string | undefined;
47972
47983
  };
@@ -63516,6 +63527,8 @@ export interface Routes {
63516
63527
  }>;
63517
63528
  /** IDs of the access methods created for the Access Grant. */
63518
63529
  access_method_ids: string[];
63530
+ /** Client Session Token. Only returned if the Access Grant has a mobile_key access method. */
63531
+ client_session_token?: string | undefined;
63519
63532
  /** Display name of the Access Grant. */
63520
63533
  display_name: string;
63521
63534
  /** Instant Key URL. Only returned if the Access Grant has a single mobile_key access_method. */
@@ -63580,6 +63593,8 @@ export interface Routes {
63580
63593
  }>;
63581
63594
  /** IDs of the access methods created for the Access Grant. */
63582
63595
  access_method_ids: string[];
63596
+ /** Client Session Token. Only returned if the Access Grant has a mobile_key access method. */
63597
+ client_session_token?: string | undefined;
63583
63598
  /** Display name of the Access Grant. */
63584
63599
  display_name: string;
63585
63600
  /** Instant Key URL. Only returned if the Access Grant has a single mobile_key access_method. */
@@ -63640,6 +63655,8 @@ export interface Routes {
63640
63655
  }>;
63641
63656
  /** IDs of the access methods created for the Access Grant. */
63642
63657
  access_method_ids: string[];
63658
+ /** Client Session Token. Only returned if the Access Grant has a mobile_key access method. */
63659
+ client_session_token?: string | undefined;
63643
63660
  /** Display name of the Access Grant. */
63644
63661
  display_name: string;
63645
63662
  /** Instant Key URL. Only returned if the Access Grant has a single mobile_key access_method. */
package/package.json CHANGED
@@ -1,6 +1,6 @@
1
1
  {
2
2
  "name": "@seamapi/types",
3
- "version": "1.448.0",
3
+ "version": "1.450.0",
4
4
  "description": "TypeScript types for the Seam API.",
5
5
  "type": "module",
6
6
  "main": "index.js",
@@ -30,6 +30,12 @@ export const access_grant = z.object({
30
30
  access_method_ids: z
31
31
  .array(z.string().uuid())
32
32
  .describe('IDs of the access methods created for the Access Grant.'),
33
+ client_session_token: z
34
+ .string()
35
+ .optional()
36
+ .describe(
37
+ 'Client Session Token. Only returned if the Access Grant has a mobile_key access method.',
38
+ ),
33
39
  display_name: z.string().describe('Display name of the Access Grant.'),
34
40
  instant_key_url: z
35
41
  .string()
@@ -1833,6 +1833,11 @@ export default {
1833
1833
  items: { format: 'uuid', type: 'string' },
1834
1834
  type: 'array',
1835
1835
  },
1836
+ client_session_token: {
1837
+ description:
1838
+ 'Client Session Token. Only returned if the Access Grant has a mobile_key access method.',
1839
+ type: 'string',
1840
+ },
1836
1841
  created_at: {
1837
1842
  description: 'Date and time at which the Access Grant was created.',
1838
1843
  format: 'date-time',
@@ -36975,6 +36980,22 @@ export default {
36975
36980
  'application/json': {
36976
36981
  schema: {
36977
36982
  properties: {
36983
+ accepted_capabilities: {
36984
+ description:
36985
+ 'List of accepted device capabilities that restrict the types of devices that can be connected through this connected account. Valid values are `lock`, `thermostat`, `noise_sensor`, and `access_control`.',
36986
+ items: {
36987
+ description:
36988
+ '\n High-level device capabilities that can be restricted in connect webviews.\n These represent the main device categories that customers can opt into.\n',
36989
+ enum: [
36990
+ 'lock',
36991
+ 'thermostat',
36992
+ 'noise_sensor',
36993
+ 'access_control',
36994
+ ],
36995
+ type: 'string',
36996
+ },
36997
+ type: 'array',
36998
+ },
36978
36999
  automatically_manage_new_devices: {
36979
37000
  description:
36980
37001
  'Indicates whether newly-added devices should appear as [managed devices](https://docs.seam.co/latest/core-concepts/devices/managed-and-unmanaged-devices).',
@@ -46658,6 +46679,7 @@ export default {
46658
46679
  },
46659
46680
  type: 'array',
46660
46681
  },
46682
+ is_draft: { type: 'boolean' },
46661
46683
  name: { type: 'string' },
46662
46684
  needs_review: { type: 'boolean' },
46663
46685
  partner_resource_key: { type: 'string' },
@@ -46754,6 +46776,7 @@ export default {
46754
46776
  },
46755
46777
  type: 'array',
46756
46778
  },
46779
+ is_draft: { type: 'boolean' },
46757
46780
  name: { type: 'string' },
46758
46781
  needs_review: { type: 'boolean' },
46759
46782
  partner_resource_key: { type: 'string' },
@@ -46846,6 +46869,7 @@ export default {
46846
46869
  { pat_with_workspace: [] },
46847
46870
  { console_session_with_workspace: [] },
46848
46871
  { api_key: [] },
46872
+ { client_session_with_customer: [] },
46849
46873
  ],
46850
46874
  summary: '/spaces/add_acs_entrances',
46851
46875
  tags: [],
@@ -46904,6 +46928,7 @@ export default {
46904
46928
  { pat_with_workspace: [] },
46905
46929
  { console_session_with_workspace: [] },
46906
46930
  { api_key: [] },
46931
+ { client_session_with_customer: [] },
46907
46932
  ],
46908
46933
  summary: '/spaces/add_acs_entrances',
46909
46934
  tags: [],
@@ -46963,6 +46988,7 @@ export default {
46963
46988
  { pat_with_workspace: [] },
46964
46989
  { console_session_with_workspace: [] },
46965
46990
  { api_key: [] },
46991
+ { client_session_with_customer: [] },
46966
46992
  ],
46967
46993
  summary: '/spaces/add_devices',
46968
46994
  tags: [],
@@ -47020,6 +47046,7 @@ export default {
47020
47046
  { pat_with_workspace: [] },
47021
47047
  { console_session_with_workspace: [] },
47022
47048
  { api_key: [] },
47049
+ { client_session_with_customer: [] },
47023
47050
  ],
47024
47051
  summary: '/spaces/add_devices',
47025
47052
  tags: [],
@@ -47090,6 +47117,7 @@ export default {
47090
47117
  { pat_with_workspace: [] },
47091
47118
  { console_session_with_workspace: [] },
47092
47119
  { api_key: [] },
47120
+ { client_session_with_customer: [] },
47093
47121
  ],
47094
47122
  summary: '/spaces/create',
47095
47123
  tags: [],
@@ -47507,6 +47535,18 @@ export default {
47507
47535
  type: 'string',
47508
47536
  },
47509
47537
  },
47538
+ {
47539
+ in: 'query',
47540
+ name: 'connected_account_id',
47541
+ schema: {
47542
+ description:
47543
+ 'Filter spaces to only include those that contain devices or access control systems belonging to the specified connected account.',
47544
+ format: 'uuid',
47545
+ type: 'string',
47546
+ 'x-draft': 'Needs review.',
47547
+ 'x-undocumented': 'Only used internally.',
47548
+ },
47549
+ },
47510
47550
  {
47511
47551
  in: 'query',
47512
47552
  name: 'space_key',
@@ -47542,6 +47582,7 @@ export default {
47542
47582
  { pat_with_workspace: [] },
47543
47583
  { console_session_with_workspace: [] },
47544
47584
  { api_key: [] },
47585
+ { client_session_with_customer: [] },
47545
47586
  ],
47546
47587
  summary: '/spaces/list',
47547
47588
  tags: [],
@@ -47560,6 +47601,14 @@ export default {
47560
47601
  'application/json': {
47561
47602
  schema: {
47562
47603
  properties: {
47604
+ connected_account_id: {
47605
+ description:
47606
+ 'Filter spaces to only include those that contain devices or access control systems belonging to the specified connected account.',
47607
+ format: 'uuid',
47608
+ type: 'string',
47609
+ 'x-draft': 'Needs review.',
47610
+ 'x-undocumented': 'Only used internally.',
47611
+ },
47563
47612
  search: {
47564
47613
  description:
47565
47614
  'String for which to search. Filters returned spaces to include all records that satisfy a partial match using `name`.',
@@ -47602,6 +47651,7 @@ export default {
47602
47651
  { pat_with_workspace: [] },
47603
47652
  { console_session_with_workspace: [] },
47604
47653
  { api_key: [] },
47654
+ { client_session_with_customer: [] },
47605
47655
  ],
47606
47656
  summary: '/spaces/list',
47607
47657
  tags: [],
@@ -11218,6 +11218,8 @@ export interface Routes {
11218
11218
  }>
11219
11219
  /** IDs of the access methods created for the Access Grant. */
11220
11220
  access_method_ids: string[]
11221
+ /** Client Session Token. Only returned if the Access Grant has a mobile_key access method. */
11222
+ client_session_token?: string | undefined
11221
11223
  /** Display name of the Access Grant. */
11222
11224
  display_name: string
11223
11225
  /** Instant Key URL. Only returned if the Access Grant has a single mobile_key access_method. */
@@ -11287,6 +11289,8 @@ export interface Routes {
11287
11289
  }>
11288
11290
  /** IDs of the access methods created for the Access Grant. */
11289
11291
  access_method_ids: string[]
11292
+ /** Client Session Token. Only returned if the Access Grant has a mobile_key access method. */
11293
+ client_session_token?: string | undefined
11290
11294
  /** Display name of the Access Grant. */
11291
11295
  display_name: string
11292
11296
  /** Instant Key URL. Only returned if the Access Grant has a single mobile_key access_method. */
@@ -11349,6 +11353,8 @@ export interface Routes {
11349
11353
  }>
11350
11354
  /** IDs of the access methods created for the Access Grant. */
11351
11355
  access_method_ids: string[]
11356
+ /** Client Session Token. Only returned if the Access Grant has a mobile_key access method. */
11357
+ client_session_token?: string | undefined
11352
11358
  /** Display name of the Access Grant. */
11353
11359
  display_name: string
11354
11360
  /** Instant Key URL. Only returned if the Access Grant has a single mobile_key access_method. */
@@ -25025,6 +25031,10 @@ export interface Routes {
25025
25031
  automatically_manage_new_devices?: boolean | undefined
25026
25032
  /** Custom metadata that you want to associate with the connected account. Supports up to 50 JSON key:value pairs. [Adding custom metadata to a connected account](https://docs.seam.co/latest/core-concepts/connected-accounts/adding-custom-metadata-to-a-connected-account) enables you to store custom information, like customer details or internal IDs from your application. Then, you can [filter connected accounts by the desired metadata](https://docs.seam.co/latest/core-concepts/connected-accounts/filtering-connected-accounts-by-custom-metadata). */
25027
25033
  custom_metadata?: Record<string, string | boolean | null> | undefined
25034
+ /** List of accepted device capabilities that restrict the types of devices that can be connected through this connected account. Valid values are `lock`, `thermostat`, `noise_sensor`, and `access_control`. */
25035
+ accepted_capabilities?:
25036
+ | Array<'lock' | 'thermostat' | 'noise_sensor' | 'access_control'>
25037
+ | undefined
25028
25038
  }
25029
25039
  commonParams: {}
25030
25040
  formData: {}
@@ -54960,6 +54970,7 @@ export interface Routes {
54960
54970
  name: string
54961
54971
  }>
54962
54972
  needs_review?: boolean | undefined
54973
+ is_draft?: boolean | undefined
54963
54974
  }>
54964
54975
  }
54965
54976
  }
@@ -56724,6 +56735,8 @@ export interface Routes {
56724
56735
  commonParams: {
56725
56736
  /** String for which to search. Filters returned spaces to include all records that satisfy a partial match using `name`. */
56726
56737
  search?: string | undefined
56738
+ /** Filter spaces to only include those that contain devices or access control systems belonging to the specified connected account. */
56739
+ connected_account_id?: string | undefined
56727
56740
  /** Filter spaces by space_key. */
56728
56741
  space_key?: string | undefined
56729
56742
  }
@@ -74860,6 +74873,8 @@ export interface Routes {
74860
74873
  }>
74861
74874
  /** IDs of the access methods created for the Access Grant. */
74862
74875
  access_method_ids: string[]
74876
+ /** Client Session Token. Only returned if the Access Grant has a mobile_key access method. */
74877
+ client_session_token?: string | undefined
74863
74878
  /** Display name of the Access Grant. */
74864
74879
  display_name: string
74865
74880
  /** Instant Key URL. Only returned if the Access Grant has a single mobile_key access_method. */
@@ -74924,6 +74939,8 @@ export interface Routes {
74924
74939
  }>
74925
74940
  /** IDs of the access methods created for the Access Grant. */
74926
74941
  access_method_ids: string[]
74942
+ /** Client Session Token. Only returned if the Access Grant has a mobile_key access method. */
74943
+ client_session_token?: string | undefined
74927
74944
  /** Display name of the Access Grant. */
74928
74945
  display_name: string
74929
74946
  /** Instant Key URL. Only returned if the Access Grant has a single mobile_key access_method. */
@@ -74984,6 +75001,8 @@ export interface Routes {
74984
75001
  }>
74985
75002
  /** IDs of the access methods created for the Access Grant. */
74986
75003
  access_method_ids: string[]
75004
+ /** Client Session Token. Only returned if the Access Grant has a mobile_key access method. */
75005
+ client_session_token?: string | undefined
74987
75006
  /** Display name of the Access Grant. */
74988
75007
  display_name: string
74989
75008
  /** Instant Key URL. Only returned if the Access Grant has a single mobile_key access_method. */