@seamapi/http 2.50.0 → 2.51.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.
- package/lib/resources/access-grant.d.ts +0 -4
- package/lib/resources/acs-access-group.d.ts +0 -8
- package/lib/resources/acs-system.d.ts +14 -16
- package/lib/resources/acs-user.d.ts +0 -4
- package/lib/resources/client-session.d.ts +0 -5
- package/lib/resources/connect-webview.d.ts +1 -1
- package/lib/resources/connected-account.d.ts +1 -27
- package/lib/resources/device-provider.d.ts +1 -1
- package/lib/resources/device.d.ts +112 -254
- package/lib/resources/event.d.ts +4 -43
- package/lib/resources/phone.d.ts +30 -0
- package/lib/resources/unmanaged-access-grant.d.ts +0 -4
- package/lib/resources/unmanaged-device.d.ts +34 -31
- package/lib/resources/workspace.d.ts +0 -5
- package/lib/routes/access-codes/access-codes.d.ts +0 -4
- package/lib/routes/access-grants/access-grants.d.ts +0 -25
- package/lib/routes/acs/entrances/entrances.d.ts +0 -4
- package/lib/routes/acs/users/users.d.ts +1 -9
- package/lib/routes/acs/users/users.js +0 -1
- package/lib/routes/acs/users/users.js.map +1 -1
- package/lib/routes/client-sessions/client-sessions.d.ts +1 -16
- package/lib/routes/client-sessions/client-sessions.js +0 -1
- package/lib/routes/client-sessions/client-sessions.js.map +1 -1
- package/lib/routes/connect-webviews/connect-webviews.d.ts +2 -2
- package/lib/routes/connected-accounts/connected-accounts.d.ts +1 -1
- package/lib/routes/customers/customers.d.ts +4 -12
- package/lib/routes/devices/devices.d.ts +3 -7
- package/lib/routes/devices/unmanaged/unmanaged.d.ts +3 -3
- package/lib/routes/locks/locks.d.ts +3 -3
- package/lib/routes/spaces/spaces.d.ts +13 -0
- package/lib/routes/thermostats/thermostats.d.ts +3 -13
- package/lib/routes/workspaces/workspaces.d.ts +0 -21
- package/lib/version.d.ts +1 -1
- package/lib/version.js +1 -1
- package/package.json +2 -2
- package/src/lib/resources/access-grant.ts +0 -5
- package/src/lib/resources/acs-access-group.ts +0 -20
- package/src/lib/resources/acs-system.ts +17 -35
- package/src/lib/resources/acs-user.ts +0 -4
- package/src/lib/resources/client-session.ts +0 -6
- package/src/lib/resources/connect-webview.ts +1 -0
- package/src/lib/resources/connected-account.ts +1 -28
- package/src/lib/resources/device-provider.ts +3 -0
- package/src/lib/resources/device.ts +2297 -2448
- package/src/lib/resources/event.ts +4 -53
- package/src/lib/resources/phone.ts +36 -0
- package/src/lib/resources/unmanaged-access-grant.ts +0 -5
- package/src/lib/resources/unmanaged-device.ts +118 -105
- package/src/lib/resources/workspace.ts +0 -6
- package/src/lib/routes/access-codes/access-codes.ts +0 -4
- package/src/lib/routes/access-grants/access-grants.ts +0 -27
- package/src/lib/routes/acs/entrances/entrances.ts +0 -4
- package/src/lib/routes/acs/users/users.ts +0 -10
- package/src/lib/routes/client-sessions/client-sessions.ts +0 -17
- package/src/lib/routes/connect-webviews/connect-webviews.ts +4 -0
- package/src/lib/routes/connected-accounts/connected-accounts.ts +1 -0
- package/src/lib/routes/customers/customers.ts +4 -14
- package/src/lib/routes/devices/devices.ts +11 -4
- package/src/lib/routes/devices/unmanaged/unmanaged.ts +11 -0
- package/src/lib/routes/locks/locks.ts +3 -0
- package/src/lib/routes/spaces/spaces.ts +16 -0
- package/src/lib/routes/thermostats/thermostats.ts +3 -10
- package/src/lib/routes/workspaces/workspaces.ts +0 -21
- package/src/lib/version.ts +1 -1
|
@@ -82,10 +82,6 @@ export type AccessGrant = {
|
|
|
82
82
|
* Instant Key URL. Only returned if the Access Grant has a single mobile_key access_method.
|
|
83
83
|
*/
|
|
84
84
|
instant_key_url?: string | undefined;
|
|
85
|
-
/**
|
|
86
|
-
* @deprecated Use `space_ids`.
|
|
87
|
-
*/
|
|
88
|
-
location_ids: Array<string>;
|
|
89
85
|
/**
|
|
90
86
|
* Name of the Access Grant. If not provided, the display name will be computed.
|
|
91
87
|
*/
|
|
@@ -6,14 +6,6 @@
|
|
|
6
6
|
* To learn whether your access control system supports access groups, see the corresponding [system integration guide](https://www.seam.co/docs/device-and-system-integration-guides#access-control-systems).
|
|
7
7
|
*/
|
|
8
8
|
export type AcsAccessGroup = {
|
|
9
|
-
/**
|
|
10
|
-
* @deprecated Use `external_type`.
|
|
11
|
-
*/
|
|
12
|
-
access_group_type: 'pti_unit' | 'pti_access_level' | 'salto_ks_access_group' | 'brivo_group' | 'salto_space_group' | 'dormakaba_community_access_group' | 'dormakaba_ambiance_access_group' | 'avigilon_alta_group' | 'kisi_access_group' | 'akiles_member_group';
|
|
13
|
-
/**
|
|
14
|
-
* @deprecated Use `external_type_display_name`.
|
|
15
|
-
*/
|
|
16
|
-
access_group_type_display_name: string;
|
|
17
9
|
/**
|
|
18
10
|
* `starts_at` and `ends_at` timestamps for the access group's access.
|
|
19
11
|
*/
|
|
@@ -22,11 +22,6 @@ export type AcsSystem = {
|
|
|
22
22
|
* ID of the connected account associated with the [access control system](https://www.seam.co/docs/low-level-apis/access-systems).
|
|
23
23
|
*/
|
|
24
24
|
connected_account_id: string;
|
|
25
|
-
/**
|
|
26
|
-
* IDs of the [connected accounts](https://www.seam.co/docs/core-concepts/connected-accounts) associated with the [access control system](https://www.seam.co/docs/low-level-apis/access-systems).
|
|
27
|
-
* @deprecated Use `connected_account_id`.
|
|
28
|
-
*/
|
|
29
|
-
connected_account_ids: Array<string>;
|
|
30
25
|
/**
|
|
31
26
|
* Date and time at which the [access control system](https://www.seam.co/docs/low-level-apis/access-systems) was created.
|
|
32
27
|
*/
|
|
@@ -233,14 +228,6 @@ export type AcsSystem = {
|
|
|
233
228
|
* Name of the [access control system](https://www.seam.co/docs/low-level-apis/access-systems).
|
|
234
229
|
*/
|
|
235
230
|
name: string;
|
|
236
|
-
/**
|
|
237
|
-
* @deprecated Use `external_type`.
|
|
238
|
-
*/
|
|
239
|
-
system_type?: 'pti_site' | 'avigilon_alta_org' | 'salto_ks_site' | 'salto_space_system' | 'brivo_account' | 'hid_credential_manager_organization' | 'visionline_system' | 'assa_abloy_credential_service' | 'latch_building' | 'dormakaba_community_site' | 'dormakaba_ambiance_site' | 'legic_connect_credential_service' | 'assa_abloy_vostio' | 'assa_abloy_vostio_credential_service' | 'hotek_site' | 'kisi_organization' | 'akiles_organization' | undefined;
|
|
240
|
-
/**
|
|
241
|
-
* @deprecated Use `external_type_display_name`.
|
|
242
|
-
*/
|
|
243
|
-
system_type_display_name?: string | undefined;
|
|
244
231
|
/**
|
|
245
232
|
* Visionline-specific metadata for the [access control system](https://www.seam.co/docs/low-level-apis/access-systems).
|
|
246
233
|
*/
|
|
@@ -279,7 +266,7 @@ export type AcsSystem = {
|
|
|
279
266
|
*/
|
|
280
267
|
warning_code: 'salto_ks_subscription_limit_almost_reached';
|
|
281
268
|
} /**
|
|
282
|
-
* Indicates the
|
|
269
|
+
* Indicates that the Salto KS site does not accept custom PIN codes, either because its Salto subscription does not include the Custom PIN feature or because Custom PIN is turned off in the site's settings. Salto KS generates every PIN on the site, so a PIN code requested on an access grant or reservation is replaced with a Salto-generated one. The message says which of the two applies.
|
|
283
270
|
*/ | {
|
|
284
271
|
/**
|
|
285
272
|
* Date and time at which Seam created the warning.
|
|
@@ -290,9 +277,20 @@ export type AcsSystem = {
|
|
|
290
277
|
*/
|
|
291
278
|
message: string;
|
|
292
279
|
/**
|
|
293
|
-
*
|
|
280
|
+
* Unique identifier of the type of warning. Enables quick recognition and categorization of the issue.
|
|
294
281
|
*/
|
|
295
|
-
|
|
282
|
+
warning_code: 'salto_ks_custom_pins_not_supported';
|
|
283
|
+
} /**
|
|
284
|
+
* Indicates the [access control system](https://www.seam.co/docs/low-level-apis/access-systems) time zone could not be determined because the reported physical location does not match the time zone configured on the physical [ACS entrances](https://www.seam.co/docs/low-level-apis/access-systems/retrieving-entrance-details).
|
|
285
|
+
*/ | {
|
|
286
|
+
/**
|
|
287
|
+
* Date and time at which Seam created the warning.
|
|
288
|
+
*/
|
|
289
|
+
created_at: string;
|
|
290
|
+
/**
|
|
291
|
+
* Detailed description of the warning. Provides insights into the issue and potentially how to rectify it.
|
|
292
|
+
*/
|
|
293
|
+
message: string;
|
|
296
294
|
/**
|
|
297
295
|
* Unique identifier of the type of warning. Enables quick recognition and categorization of the issue.
|
|
298
296
|
*/
|
|
@@ -39,10 +39,6 @@ export type AcsUser = {
|
|
|
39
39
|
* Display name for the [access system user](https://www.seam.co/docs/low-level-apis/access-systems/user-management).
|
|
40
40
|
*/
|
|
41
41
|
display_name: string;
|
|
42
|
-
/**
|
|
43
|
-
* @deprecated use email_address.
|
|
44
|
-
*/
|
|
45
|
-
email?: string | undefined;
|
|
46
42
|
/**
|
|
47
43
|
* Email address of the [access system user](https://www.seam.co/docs/low-level-apis/access-systems/user-management).
|
|
48
44
|
*/
|
|
@@ -50,11 +50,6 @@ export type ClientSession = {
|
|
|
50
50
|
* ID of the [user identity](https://www.seam.co/docs/capability-guides/mobile-access/managing-mobile-app-user-accounts-with-user-identities#what-is-a-user-identity) associated with the client session.
|
|
51
51
|
*/
|
|
52
52
|
user_identity_id?: string | undefined;
|
|
53
|
-
/**
|
|
54
|
-
* IDs of the [user identities](https://www.seam.co/docs/capability-guides/mobile-access/managing-mobile-app-user-accounts-with-user-identities#what-is-a-user-identity) associated with the client session.
|
|
55
|
-
* @deprecated Use `user_identity_id` instead.
|
|
56
|
-
*/
|
|
57
|
-
user_identity_ids: Array<string>;
|
|
58
53
|
/**
|
|
59
54
|
* ID of the workspace associated with the client session.
|
|
60
55
|
*/
|
|
@@ -15,7 +15,7 @@ export type ConnectWebview = {
|
|
|
15
15
|
/**
|
|
16
16
|
* High-level device capabilities that the Connect Webview can accept. When creating a Connect Webview, you can specify the types of devices that it can connect to Seam. If you do not set custom `accepted_capabilities`, Seam uses a default set of `accepted_capabilities` for each provider. For example, if you create a Connect Webview that accepts SmartThing devices, without specifying `accepted_capabilities`, Seam accepts only SmartThings locks. To connect SmartThings thermostats and locks to Seam, create a Connect Webview and include both `thermostat` and `lock` in the `accepted_capabilities`.
|
|
17
17
|
*/
|
|
18
|
-
accepted_capabilities: Array<'lock' | 'thermostat' | 'noise_sensor' | 'access_control' | 'camera' | 'speaker'>;
|
|
18
|
+
accepted_capabilities: Array<'lock' | 'thermostat' | 'noise_sensor' | 'access_control' | 'camera' | 'speaker' | 'pool'>;
|
|
19
19
|
/**
|
|
20
20
|
* List of accepted [provider keys](https://www.seam.co/docs/core-concepts/connect-webviews/customizing-connect-webviews#customize-the-brands-to-display-in-your-connect-webviews).
|
|
21
21
|
*/
|
|
@@ -5,7 +5,7 @@ export type ConnectedAccount = {
|
|
|
5
5
|
/**
|
|
6
6
|
* List of capabilities that were accepted during the account connection process.
|
|
7
7
|
*/
|
|
8
|
-
accepted_capabilities: Array<'lock' | 'thermostat' | 'noise_sensor' | 'access_control' | 'camera' | 'speaker'>;
|
|
8
|
+
accepted_capabilities: Array<'lock' | 'thermostat' | 'noise_sensor' | 'access_control' | 'camera' | 'speaker' | 'pool'>;
|
|
9
9
|
/**
|
|
10
10
|
* Type of connected account.
|
|
11
11
|
*/
|
|
@@ -186,32 +186,6 @@ export type ConnectedAccount = {
|
|
|
186
186
|
* IANA time zone (e.g. America/Los_Angeles) for this connected account. Sourced from the connector configuration.
|
|
187
187
|
*/
|
|
188
188
|
time_zone?: string | undefined;
|
|
189
|
-
/**
|
|
190
|
-
* User identifier associated with the connected account.
|
|
191
|
-
* @deprecated Use `display_name` instead.
|
|
192
|
-
*/
|
|
193
|
-
user_identifier?: {
|
|
194
|
-
/**
|
|
195
|
-
* API URL for the user identifier associated with the connected account.
|
|
196
|
-
*/
|
|
197
|
-
api_url?: string | undefined;
|
|
198
|
-
/**
|
|
199
|
-
* Email address of the user identifier associated with the connected account.
|
|
200
|
-
*/
|
|
201
|
-
email?: string | undefined;
|
|
202
|
-
/**
|
|
203
|
-
* Indicates whether the user identifier associated with the connected account is exclusive.
|
|
204
|
-
*/
|
|
205
|
-
exclusive?: boolean | undefined;
|
|
206
|
-
/**
|
|
207
|
-
* Phone number of the user identifier associated with the connected account.
|
|
208
|
-
*/
|
|
209
|
-
phone?: string | undefined;
|
|
210
|
-
/**
|
|
211
|
-
* Username of the user identifier associated with the connected account.
|
|
212
|
-
*/
|
|
213
|
-
username?: string | undefined;
|
|
214
|
-
} | undefined;
|
|
215
189
|
/**
|
|
216
190
|
* Warnings associated with the connected account.
|
|
217
191
|
*/
|
|
@@ -90,7 +90,7 @@ export type DeviceProvider = {
|
|
|
90
90
|
/**
|
|
91
91
|
* Name of the device provider.
|
|
92
92
|
*/
|
|
93
|
-
device_provider_name: 'hotek' | 'dormakaba_community' | 'legic_connect' | 'akuvox' | 'august' | 'avigilon_alta' | 'brivo' | 'butterflymx' | 'schlage' | 'smartthings' | 'yale' | 'yale_access' | 'yale_home' | 'genie' | 'doorking' | 'salto' | 'salto_ks' | 'salto_ks_accept' | 'lockly' | 'ttlock' | 'linear' | 'noiseaware' | 'nuki' | 'igloo' | 'kwikset' | 'minut' | 'my_2n' | 'controlbyweb' | 'nest' | 'igloohome' | 'ecobee' | 'four_suites' | 'dormakaba_oracode' | 'dormakaba_oracode_iho' | 'pti' | 'wyze' | 'seam_passport' | 'visionline' | 'assa_abloy_credential_service' | 'tedee' | 'honeywell_resideo' | 'first_alert' | 'latch' | 'akiles' | 'assa_abloy_vostio' | 'assa_abloy_vostio_credential_service' | 'tado' | 'salto_space' | 'sensi' | 'keynest' | 'korelock' | 'keyincode' | 'dormakaba_ambiance' | 'ultraloq' | 'yacan' | 'dusaw' | 'sifely' | 'thirty_three_lock' | 'ring' | 'tapo' | 'arlo' | 'reolink' | 'unifi_protect' | 'yale_connect' | 'alertify' | 'ical' | 'lodgify' | 'hostaway' | 'guesty' | 'acuity_scheduling' | 'omnitec' | 'kisi' | 'aqara' | 'eufy' | 'sonos';
|
|
93
|
+
device_provider_name: 'hotek' | 'dormakaba_community' | 'legic_connect' | 'akuvox' | 'august' | 'avigilon_alta' | 'brivo' | 'butterflymx' | 'schlage' | 'smartthings' | 'yale' | 'yale_access' | 'yale_home' | 'genie' | 'doorking' | 'salto' | 'salto_ks' | 'salto_ks_accept' | 'lockly' | 'ttlock' | 'linear' | 'noiseaware' | 'nuki' | 'igloo' | 'kwikset' | 'minut' | 'my_2n' | 'controlbyweb' | 'nest' | 'igloohome' | 'ecobee' | 'four_suites' | 'dormakaba_oracode' | 'dormakaba_oracode_iho' | 'pti' | 'wyze' | 'seam_passport' | 'visionline' | 'assa_abloy_credential_service' | 'tedee' | 'honeywell_resideo' | 'first_alert' | 'latch' | 'akiles' | 'assa_abloy_vostio' | 'assa_abloy_vostio_credential_service' | 'tado' | 'salto_space' | 'sensi' | 'sensibo' | 'keynest' | 'korelock' | 'keyincode' | 'dormakaba_ambiance' | 'ultraloq' | 'yacan' | 'dusaw' | 'sifely' | 'thirty_three_lock' | 'ring' | 'tapo' | 'arlo' | 'reolink' | 'unifi_protect' | 'yale_connect' | 'alertify' | 'ical' | 'lodgify' | 'hostaway' | 'guesty' | 'acuity_scheduling' | 'omnitec' | 'kisi' | 'aqara' | 'eufy' | 'sonos' | 'hayward_omnilogic' | 'tuya';
|
|
94
94
|
/**
|
|
95
95
|
* Display name for the device provider.
|
|
96
96
|
*/
|