@seamapi/http 2.30.0 → 2.32.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-code.d.ts +15 -15
- package/lib/resources/access-grant.d.ts +4 -4
- package/lib/resources/access-method.d.ts +9 -9
- package/lib/resources/acs-access-group.d.ts +3 -3
- package/lib/resources/acs-credential.d.ts +35 -35
- package/lib/resources/acs-encoder.d.ts +10 -10
- package/lib/resources/acs-entrance.d.ts +20 -20
- package/lib/resources/acs-system.d.ts +37 -37
- package/lib/resources/acs-user.d.ts +35 -35
- package/lib/resources/action-attempt.d.ts +101 -101
- package/lib/resources/client-session.d.ts +12 -12
- package/lib/resources/connect-webview.d.ts +6 -6
- package/lib/resources/connected-account.d.ts +8 -8
- package/lib/resources/device-provider.d.ts +1 -1
- package/lib/resources/device.d.ts +103 -86
- package/lib/resources/event.d.ts +10 -10
- package/lib/resources/noise-threshold.d.ts +2 -2
- package/lib/resources/phone.d.ts +1 -1
- package/lib/resources/thermostat-daily-program.d.ts +1 -1
- package/lib/resources/thermostat-schedule.d.ts +11 -11
- package/lib/resources/unmanaged-access-code.d.ts +12 -12
- package/lib/resources/unmanaged-access-grant.d.ts +4 -4
- package/lib/resources/unmanaged-access-method.d.ts +9 -9
- package/lib/resources/unmanaged-device.d.ts +11 -11
- package/lib/resources/user-identity.d.ts +1 -1
- package/lib/resources/webhook.d.ts +4 -4
- package/lib/resources/workspace.d.ts +12 -12
- package/lib/routes/access-codes/access-codes.d.ts +28 -28
- package/lib/routes/access-codes/access-codes.js +13 -13
- package/lib/routes/access-codes/simulate/simulate.d.ts +1 -1
- package/lib/routes/access-codes/simulate/simulate.js +1 -1
- package/lib/routes/access-codes/unmanaged/unmanaged.d.ts +9 -9
- package/lib/routes/access-codes/unmanaged/unmanaged.js +5 -5
- package/lib/routes/access-grants/access-grants.d.ts +3 -3
- package/lib/routes/access-grants/access-grants.js +1 -1
- package/lib/routes/access-methods/access-methods.d.ts +2 -2
- package/lib/routes/access-methods/access-methods.js +2 -2
- package/lib/routes/acs/access-groups/access-groups.d.ts +7 -7
- package/lib/routes/acs/access-groups/access-groups.js +7 -7
- package/lib/routes/acs/credentials/credentials.d.ts +12 -12
- package/lib/routes/acs/credentials/credentials.js +8 -8
- package/lib/routes/acs/encoders/encoders.d.ts +5 -5
- package/lib/routes/acs/encoders/encoders.js +5 -5
- package/lib/routes/acs/encoders/simulate/simulate.d.ts +4 -4
- package/lib/routes/acs/encoders/simulate/simulate.js +4 -4
- package/lib/routes/acs/entrances/entrances.d.ts +5 -5
- package/lib/routes/acs/entrances/entrances.js +5 -5
- package/lib/routes/acs/systems/systems.d.ts +3 -3
- package/lib/routes/acs/systems/systems.js +3 -3
- package/lib/routes/acs/users/users.d.ts +16 -16
- package/lib/routes/acs/users/users.js +11 -11
- package/lib/routes/action-attempts/action-attempts.d.ts +2 -2
- package/lib/routes/action-attempts/action-attempts.js +2 -2
- package/lib/routes/client-sessions/client-sessions.d.ts +22 -22
- package/lib/routes/client-sessions/client-sessions.js +8 -8
- package/lib/routes/connect-webviews/connect-webviews.d.ts +12 -12
- package/lib/routes/connect-webviews/connect-webviews.js +5 -5
- package/lib/routes/connected-accounts/connected-accounts.d.ts +7 -7
- package/lib/routes/connected-accounts/connected-accounts.js +5 -5
- package/lib/routes/connected-accounts/simulate/simulate.d.ts +1 -1
- package/lib/routes/connected-accounts/simulate/simulate.js +1 -1
- package/lib/routes/devices/devices.d.ts +12 -12
- package/lib/routes/devices/devices.js +6 -6
- package/lib/routes/devices/simulate/simulate.d.ts +3 -3
- package/lib/routes/devices/simulate/simulate.js +3 -3
- package/lib/routes/devices/unmanaged/unmanaged.d.ts +9 -9
- package/lib/routes/devices/unmanaged/unmanaged.js +6 -6
- package/lib/routes/events/events.d.ts +4 -4
- package/lib/routes/events/events.js +2 -2
- package/lib/routes/instant-keys/instant-keys.d.ts +3 -3
- package/lib/routes/instant-keys/instant-keys.js +3 -3
- package/lib/routes/locks/locks.d.ts +5 -5
- package/lib/routes/locks/locks.js +5 -5
- package/lib/routes/locks/simulate/simulate.d.ts +2 -2
- package/lib/routes/locks/simulate/simulate.js +2 -2
- package/lib/routes/noise-sensors/noise-sensors.d.ts +1 -1
- package/lib/routes/noise-sensors/noise-sensors.js +1 -1
- package/lib/routes/noise-sensors/noise-thresholds/noise-thresholds.d.ts +7 -7
- package/lib/routes/noise-sensors/noise-thresholds/noise-thresholds.js +5 -5
- package/lib/routes/noise-sensors/simulate/simulate.d.ts +1 -1
- package/lib/routes/noise-sensors/simulate/simulate.js +1 -1
- package/lib/routes/phones/phones.d.ts +4 -4
- package/lib/routes/phones/phones.js +3 -3
- package/lib/routes/phones/simulate/simulate.d.ts +1 -1
- package/lib/routes/phones/simulate/simulate.js +1 -1
- package/lib/routes/seam-http-endpoints-without-workspace.d.ts +2 -2
- package/lib/routes/seam-http-endpoints-without-workspace.js +2 -2
- package/lib/routes/seam-http-endpoints.d.ts +176 -176
- package/lib/routes/seam-http-endpoints.js +176 -176
- package/lib/routes/spaces/spaces.d.ts +4 -4
- package/lib/routes/spaces/spaces.js +4 -4
- package/lib/routes/thermostats/daily-programs/daily-programs.d.ts +2 -2
- package/lib/routes/thermostats/schedules/schedules.d.ts +11 -11
- package/lib/routes/thermostats/schedules/schedules.js +5 -5
- package/lib/routes/thermostats/simulate/simulate.d.ts +6 -6
- package/lib/routes/thermostats/simulate/simulate.js +2 -2
- package/lib/routes/thermostats/thermostats.d.ts +43 -43
- package/lib/routes/thermostats/thermostats.js +13 -13
- package/lib/routes/user-identities/unmanaged/unmanaged.d.ts +3 -3
- package/lib/routes/user-identities/unmanaged/unmanaged.js +3 -3
- package/lib/routes/user-identities/user-identities.d.ts +15 -15
- package/lib/routes/user-identities/user-identities.js +15 -15
- package/lib/routes/webhooks/webhooks.d.ts +5 -5
- package/lib/routes/webhooks/webhooks.js +5 -5
- package/lib/routes/workspaces/workspaces.d.ts +16 -16
- package/lib/routes/workspaces/workspaces.js +5 -5
- package/lib/version.d.ts +1 -1
- package/lib/version.js +1 -1
- package/package.json +2 -2
- package/src/lib/resources/access-code.ts +15 -15
- package/src/lib/resources/access-grant.ts +4 -4
- package/src/lib/resources/access-method.ts +9 -9
- package/src/lib/resources/acs-access-group.ts +3 -3
- package/src/lib/resources/acs-credential.ts +35 -35
- package/src/lib/resources/acs-encoder.ts +10 -10
- package/src/lib/resources/acs-entrance.ts +20 -20
- package/src/lib/resources/acs-system.ts +37 -37
- package/src/lib/resources/acs-user.ts +35 -35
- package/src/lib/resources/action-attempt.ts +101 -101
- package/src/lib/resources/client-session.ts +12 -12
- package/src/lib/resources/connect-webview.ts +6 -6
- package/src/lib/resources/connected-account.ts +8 -8
- package/src/lib/resources/device-provider.ts +1 -0
- package/src/lib/resources/device.ts +105 -85
- package/src/lib/resources/event.ts +10 -10
- package/src/lib/resources/noise-threshold.ts +2 -2
- package/src/lib/resources/phone.ts +1 -1
- package/src/lib/resources/thermostat-daily-program.ts +1 -1
- package/src/lib/resources/thermostat-schedule.ts +11 -11
- package/src/lib/resources/unmanaged-access-code.ts +12 -12
- package/src/lib/resources/unmanaged-access-grant.ts +4 -4
- package/src/lib/resources/unmanaged-access-method.ts +9 -9
- package/src/lib/resources/unmanaged-device.ts +11 -10
- package/src/lib/resources/user-identity.ts +1 -1
- package/src/lib/resources/webhook.ts +4 -4
- package/src/lib/resources/workspace.ts +12 -12
- package/src/lib/routes/access-codes/access-codes.ts +28 -28
- package/src/lib/routes/access-codes/simulate/simulate.ts +1 -1
- package/src/lib/routes/access-codes/unmanaged/unmanaged.ts +9 -9
- package/src/lib/routes/access-grants/access-grants.ts +3 -3
- package/src/lib/routes/access-methods/access-methods.ts +2 -2
- package/src/lib/routes/acs/access-groups/access-groups.ts +7 -7
- package/src/lib/routes/acs/credentials/credentials.ts +12 -12
- package/src/lib/routes/acs/encoders/encoders.ts +5 -5
- package/src/lib/routes/acs/encoders/simulate/simulate.ts +4 -4
- package/src/lib/routes/acs/entrances/entrances.ts +5 -5
- package/src/lib/routes/acs/systems/systems.ts +3 -3
- package/src/lib/routes/acs/users/users.ts +16 -16
- package/src/lib/routes/action-attempts/action-attempts.ts +2 -2
- package/src/lib/routes/client-sessions/client-sessions.ts +22 -22
- package/src/lib/routes/connect-webviews/connect-webviews.ts +12 -11
- package/src/lib/routes/connected-accounts/connected-accounts.ts +7 -7
- package/src/lib/routes/connected-accounts/simulate/simulate.ts +1 -1
- package/src/lib/routes/devices/devices.ts +12 -9
- package/src/lib/routes/devices/simulate/simulate.ts +3 -3
- package/src/lib/routes/devices/unmanaged/unmanaged.ts +9 -6
- package/src/lib/routes/events/events.ts +4 -4
- package/src/lib/routes/instant-keys/instant-keys.ts +3 -3
- package/src/lib/routes/locks/locks.ts +5 -5
- package/src/lib/routes/locks/simulate/simulate.ts +2 -2
- package/src/lib/routes/noise-sensors/noise-sensors.ts +1 -1
- package/src/lib/routes/noise-sensors/noise-thresholds/noise-thresholds.ts +7 -7
- package/src/lib/routes/noise-sensors/simulate/simulate.ts +1 -1
- package/src/lib/routes/phones/phones.ts +4 -4
- package/src/lib/routes/phones/simulate/simulate.ts +1 -1
- package/src/lib/routes/seam-http-endpoints-without-workspace.ts +2 -2
- package/src/lib/routes/seam-http-endpoints.ts +176 -176
- package/src/lib/routes/spaces/spaces.ts +4 -4
- package/src/lib/routes/thermostats/daily-programs/daily-programs.ts +2 -2
- package/src/lib/routes/thermostats/schedules/schedules.ts +11 -11
- package/src/lib/routes/thermostats/simulate/simulate.ts +6 -6
- package/src/lib/routes/thermostats/thermostats.ts +43 -43
- package/src/lib/routes/user-identities/unmanaged/unmanaged.ts +3 -3
- package/src/lib/routes/user-identities/user-identities.ts +15 -15
- package/src/lib/routes/webhooks/webhooks.ts +5 -5
- package/src/lib/routes/workspaces/workspaces.ts +16 -16
- package/src/lib/version.ts +1 -1
package/lib/resources/event.d.ts
CHANGED
|
@@ -1,5 +1,5 @@
|
|
|
1
1
|
/**
|
|
2
|
-
* An [access code](https://
|
|
2
|
+
* An [access code](https://www.seam.co/docs/low-level-apis/smart-locks/access-codes) was created.
|
|
3
3
|
*/
|
|
4
4
|
export type SeamEvent = {
|
|
5
5
|
/**
|
|
@@ -1605,7 +1605,7 @@ export type SeamEvent = {
|
|
|
1605
1605
|
*/
|
|
1606
1606
|
access_grant_id: string;
|
|
1607
1607
|
/**
|
|
1608
|
-
* ID of the affected [entrance](https://
|
|
1608
|
+
* ID of the affected [entrance](https://www.seam.co/docs/low-level-apis/access-systems/retrieving-entrance-details).
|
|
1609
1609
|
*/
|
|
1610
1610
|
acs_entrance_id: string;
|
|
1611
1611
|
/**
|
|
@@ -1635,7 +1635,7 @@ export type SeamEvent = {
|
|
|
1635
1635
|
*/
|
|
1636
1636
|
access_grant_id: string;
|
|
1637
1637
|
/**
|
|
1638
|
-
* ID of the affected [entrance](https://
|
|
1638
|
+
* ID of the affected [entrance](https://www.seam.co/docs/low-level-apis/access-systems/retrieving-entrance-details).
|
|
1639
1639
|
*/
|
|
1640
1640
|
acs_entrance_id: string;
|
|
1641
1641
|
/**
|
|
@@ -4797,7 +4797,7 @@ export type SeamEvent = {
|
|
|
4797
4797
|
*/
|
|
4798
4798
|
is_via_nfc?: boolean | undefined;
|
|
4799
4799
|
/**
|
|
4800
|
-
* Method by which the lock was unlocked. `keycode`: an [access code](https://
|
|
4800
|
+
* Method by which the lock was unlocked. `keycode`: an [access code](https://www.seam.co/docs/low-level-apis/smart-locks/access-codes) was used (see `access_code_id`). `manual`: a physical action such as a thumbturn or handle press. `remote`: a remote action via an app, Bluetooth, or the Seam API (see `action_attempt_id` if Seam-initiated; see `is_via_bluetooth` or `is_via_nfc` for the transport). `automatic`: triggered automatically, for example by a time-based schedule. `unknown`: could not be determined.
|
|
4801
4801
|
*/
|
|
4802
4802
|
method: 'keycode' | 'manual' | 'automatic' | 'unknown' | 'remote' | 'card' | 'mobile_key';
|
|
4803
4803
|
/**
|
|
@@ -4931,11 +4931,11 @@ export type SeamEvent = {
|
|
|
4931
4931
|
*/
|
|
4932
4932
|
connected_account_id: string;
|
|
4933
4933
|
/**
|
|
4934
|
-
* Temperature to which the thermostat should cool (in °C). See also [Set Points](https://
|
|
4934
|
+
* Temperature to which the thermostat should cool (in °C). See also [Set Points](https://www.seam.co/docs/capability-guides/thermostats/understanding-thermostat-concepts/set-points).
|
|
4935
4935
|
*/
|
|
4936
4936
|
cooling_set_point_celsius?: number | undefined;
|
|
4937
4937
|
/**
|
|
4938
|
-
* Temperature to which the thermostat should cool (in °F). See also [Set Points](https://
|
|
4938
|
+
* Temperature to which the thermostat should cool (in °F). See also [Set Points](https://www.seam.co/docs/capability-guides/thermostats/understanding-thermostat-concepts/set-points).
|
|
4939
4939
|
*/
|
|
4940
4940
|
cooling_set_point_fahrenheit?: number | undefined;
|
|
4941
4941
|
/**
|
|
@@ -4964,19 +4964,19 @@ export type SeamEvent = {
|
|
|
4964
4964
|
event_id: string;
|
|
4965
4965
|
event_type: 'thermostat.manually_adjusted';
|
|
4966
4966
|
/**
|
|
4967
|
-
* Desired [fan mode setting](https://
|
|
4967
|
+
* Desired [fan mode setting](https://www.seam.co/docs/capability-guides/thermostats/configure-current-climate-settings#fan-mode-settings), such as `on`, `auto`, or `circulate`.
|
|
4968
4968
|
*/
|
|
4969
4969
|
fan_mode_setting?: 'auto' | 'on' | 'circulate' | undefined;
|
|
4970
4970
|
/**
|
|
4971
|
-
* Temperature to which the thermostat should heat (in °C). See also [Set Points](https://
|
|
4971
|
+
* Temperature to which the thermostat should heat (in °C). See also [Set Points](https://www.seam.co/docs/capability-guides/thermostats/understanding-thermostat-concepts/set-points).
|
|
4972
4972
|
*/
|
|
4973
4973
|
heating_set_point_celsius?: number | undefined;
|
|
4974
4974
|
/**
|
|
4975
|
-
* Temperature to which the thermostat should heat (in °F). See also [Set Points](https://
|
|
4975
|
+
* Temperature to which the thermostat should heat (in °F). See also [Set Points](https://www.seam.co/docs/capability-guides/thermostats/understanding-thermostat-concepts/set-points).
|
|
4976
4976
|
*/
|
|
4977
4977
|
heating_set_point_fahrenheit?: number | undefined;
|
|
4978
4978
|
/**
|
|
4979
|
-
* Desired [HVAC mode](https://
|
|
4979
|
+
* Desired [HVAC mode](https://www.seam.co/docs/capability-guides/thermostats/understanding-thermostat-concepts/hvac-mode) setting, such as `heat`, `cool`, `heat_cool`, or `off`.
|
|
4980
4980
|
*/
|
|
4981
4981
|
hvac_mode_setting?: 'off' | 'heat' | 'cool' | 'heat_cool' | 'eco' | undefined;
|
|
4982
4982
|
/**
|
|
@@ -1,5 +1,5 @@
|
|
|
1
1
|
/**
|
|
2
|
-
* Represents a [noise threshold](https://
|
|
2
|
+
* Represents a [noise threshold](https://www.seam.co/docs/capability-guides/noise-sensors/configure-noise-threshold-settings) for a [noise sensor](https://www.seam.co/docs/capability-guides/noise-sensors). Thresholds represent the limits of noise tolerated at a property, which can be customized for each hour of the day. Each device has its own default thresholds, but you can use the Seam API to modify them.
|
|
3
3
|
*/
|
|
4
4
|
export type NoiseThreshold = {
|
|
5
5
|
/**
|
|
@@ -23,7 +23,7 @@ export type NoiseThreshold = {
|
|
|
23
23
|
*/
|
|
24
24
|
noise_threshold_id: string;
|
|
25
25
|
/**
|
|
26
|
-
* Noise level in Noiseaware Noise Risk Score (NRS) for the noise threshold. This parameter is only relevant for [Noiseaware sensors](https://
|
|
26
|
+
* Noise level in Noiseaware Noise Risk Score (NRS) for the noise threshold. This parameter is only relevant for [Noiseaware sensors](https://www.seam.co/docs/device-and-system-integration-guides/noiseaware-sensors).
|
|
27
27
|
*/
|
|
28
28
|
noise_threshold_nrs?: number | undefined;
|
|
29
29
|
/**
|
package/lib/resources/phone.d.ts
CHANGED
|
@@ -7,7 +7,7 @@ export type Phone = {
|
|
|
7
7
|
*/
|
|
8
8
|
created_at: string;
|
|
9
9
|
/**
|
|
10
|
-
* Optional [custom metadata](https://
|
|
10
|
+
* Optional [custom metadata](https://www.seam.co/docs/core-concepts/devices/adding-custom-metadata-to-a-device) for the phone.
|
|
11
11
|
*/
|
|
12
12
|
custom_metadata: Record<string, string | boolean>;
|
|
13
13
|
/**
|
|
@@ -19,7 +19,7 @@ export type ThermostatDailyProgram = {
|
|
|
19
19
|
*/
|
|
20
20
|
periods: Array<{
|
|
21
21
|
/**
|
|
22
|
-
* Key of the [climate preset](https://
|
|
22
|
+
* Key of the [climate preset](https://www.seam.co/docs/capability-guides/thermostats/creating-and-managing-climate-presets) to activate at the `starts_at_time`.
|
|
23
23
|
*/
|
|
24
24
|
climate_preset_key: string;
|
|
25
25
|
/**
|
|
@@ -1,25 +1,25 @@
|
|
|
1
1
|
/**
|
|
2
|
-
* Represents a [thermostat schedule](https://
|
|
2
|
+
* Represents a [thermostat schedule](https://www.seam.co/docs/capability-guides/thermostats/creating-and-managing-thermostat-schedules) that activates a configured [climate preset](https://www.seam.co/docs/capability-guides/thermostats/creating-and-managing-climate-presets) on a [thermostat](https://www.seam.co/docs/capability-guides/thermostats) at a specified starting time and deactivates the climate preset at a specified ending time.
|
|
3
3
|
*/
|
|
4
4
|
export type ThermostatSchedule = {
|
|
5
5
|
/**
|
|
6
|
-
* Key of the [climate preset](https://
|
|
6
|
+
* Key of the [climate preset](https://www.seam.co/docs/capability-guides/thermostats/creating-and-managing-climate-presets) to use for the [thermostat schedule](https://www.seam.co/docs/capability-guides/thermostats/creating-and-managing-thermostat-schedules).
|
|
7
7
|
*/
|
|
8
8
|
climate_preset_key: string;
|
|
9
9
|
/**
|
|
10
|
-
* Date and time at which the [thermostat schedule](https://
|
|
10
|
+
* Date and time at which the [thermostat schedule](https://www.seam.co/docs/capability-guides/thermostats/creating-and-managing-thermostat-schedules) was created.
|
|
11
11
|
*/
|
|
12
12
|
created_at: string;
|
|
13
13
|
/**
|
|
14
|
-
* ID of the desired [thermostat](https://
|
|
14
|
+
* ID of the desired [thermostat](https://www.seam.co/docs/capability-guides/thermostats) device.
|
|
15
15
|
*/
|
|
16
16
|
device_id: string;
|
|
17
17
|
/**
|
|
18
|
-
* Date and time at which the [thermostat schedule](https://
|
|
18
|
+
* Date and time at which the [thermostat schedule](https://www.seam.co/docs/capability-guides/thermostats/creating-and-managing-thermostat-schedules) ends, in [ISO 8601](https://www.iso.org/iso-8601-date-and-time-format.html) format.
|
|
19
19
|
*/
|
|
20
20
|
ends_at: string;
|
|
21
21
|
/**
|
|
22
|
-
* Errors associated with the [thermostat schedule](https://
|
|
22
|
+
* Errors associated with the [thermostat schedule](https://www.seam.co/docs/capability-guides/thermostats/creating-and-managing-thermostat-schedules).
|
|
23
23
|
*/
|
|
24
24
|
errors: Array<{
|
|
25
25
|
/**
|
|
@@ -36,23 +36,23 @@ export type ThermostatSchedule = {
|
|
|
36
36
|
message: string;
|
|
37
37
|
}>;
|
|
38
38
|
/**
|
|
39
|
-
* Indicates whether a person at the thermostat can change the thermostat's settings after the [thermostat schedule](https://
|
|
39
|
+
* Indicates whether a person at the thermostat can change the thermostat's settings after the [thermostat schedule](https://www.seam.co/docs/capability-guides/thermostats/creating-and-managing-thermostat-schedules) starts.
|
|
40
40
|
*/
|
|
41
41
|
is_override_allowed?: boolean | undefined;
|
|
42
42
|
/**
|
|
43
|
-
* Number of minutes for which a person at the thermostat can change the thermostat's settings after the activation of the scheduled [climate preset](https://
|
|
43
|
+
* Number of minutes for which a person at the thermostat can change the thermostat's settings after the activation of the scheduled [climate preset](https://www.seam.co/docs/capability-guides/thermostats/creating-and-managing-climate-presets). See also [Specifying Manual Override Permissions](https://www.seam.co/docs/capability-guides/thermostats/creating-and-managing-thermostat-schedules#specifying-manual-override-permissions).
|
|
44
44
|
*/
|
|
45
45
|
max_override_period_minutes?: number | null | undefined;
|
|
46
46
|
/**
|
|
47
|
-
* User-friendly name to identify the [thermostat schedule](https://
|
|
47
|
+
* User-friendly name to identify the [thermostat schedule](https://www.seam.co/docs/capability-guides/thermostats/creating-and-managing-thermostat-schedules).
|
|
48
48
|
*/
|
|
49
49
|
name: string | null;
|
|
50
50
|
/**
|
|
51
|
-
* Date and time at which the [thermostat schedule](https://
|
|
51
|
+
* Date and time at which the [thermostat schedule](https://www.seam.co/docs/capability-guides/thermostats/creating-and-managing-thermostat-schedules) starts, in [ISO 8601](https://www.iso.org/iso-8601-date-and-time-format.html) format.
|
|
52
52
|
*/
|
|
53
53
|
starts_at: string;
|
|
54
54
|
/**
|
|
55
|
-
* ID of the [thermostat schedule](https://
|
|
55
|
+
* ID of the [thermostat schedule](https://www.seam.co/docs/capability-guides/thermostats/creating-and-managing-thermostat-schedules).
|
|
56
56
|
*/
|
|
57
57
|
thermostat_schedule_id: string;
|
|
58
58
|
/**
|
|
@@ -1,5 +1,5 @@
|
|
|
1
1
|
/**
|
|
2
|
-
* Represents an [unmanaged smart lock access code](https://
|
|
2
|
+
* Represents an [unmanaged smart lock access code](https://www.seam.co/docs/low-level-apis/smart-locks/access-codes/migrating-existing-access-codes).
|
|
3
3
|
*
|
|
4
4
|
* An access code is a code used for a keypad or pinpad device. Unlike physical keys, which can easily be lost or duplicated, PIN codes can be customized, tracked, and altered on the fly.
|
|
5
5
|
*
|
|
@@ -9,7 +9,7 @@
|
|
|
9
9
|
*
|
|
10
10
|
* Not all providers support unmanaged access codes. The following providers do not support unmanaged access codes:
|
|
11
11
|
*
|
|
12
|
-
* - [Kwikset](https://
|
|
12
|
+
* - [Kwikset](https://www.seam.co/docs/device-and-system-integration-guides/kwikset-locks)
|
|
13
13
|
*/
|
|
14
14
|
export type UnmanagedAccessCode = {
|
|
15
15
|
/**
|
|
@@ -82,7 +82,7 @@ export type UnmanagedAccessCode = {
|
|
|
82
82
|
*/
|
|
83
83
|
ends_at?: string | null | undefined;
|
|
84
84
|
/**
|
|
85
|
-
* Errors associated with the [access code](https://
|
|
85
|
+
* Errors associated with the [access code](https://www.seam.co/docs/low-level-apis/smart-locks/access-codes).
|
|
86
86
|
*/
|
|
87
87
|
errors: Array<
|
|
88
88
|
/**
|
|
@@ -315,7 +315,7 @@ export type UnmanagedAccessCode = {
|
|
|
315
315
|
/**
|
|
316
316
|
* Unique identifier of the type of error. Enables quick recognition and categorization of the issue.
|
|
317
317
|
*/
|
|
318
|
-
error_code: '
|
|
318
|
+
error_code: 'failed_to_remove';
|
|
319
319
|
/**
|
|
320
320
|
* Indicates that this is an access code error.
|
|
321
321
|
*/
|
|
@@ -336,7 +336,7 @@ export type UnmanagedAccessCode = {
|
|
|
336
336
|
*/
|
|
337
337
|
error_code: 'account_disconnected';
|
|
338
338
|
/**
|
|
339
|
-
* Indicates that the error is a [connected account](https://
|
|
339
|
+
* Indicates that the error is a [connected account](https://www.seam.co/docs/api/connected_accounts/object) error.
|
|
340
340
|
*/
|
|
341
341
|
is_connected_account_error: true;
|
|
342
342
|
/**
|
|
@@ -359,7 +359,7 @@ export type UnmanagedAccessCode = {
|
|
|
359
359
|
*/
|
|
360
360
|
error_code: 'salto_ks_subscription_limit_exceeded';
|
|
361
361
|
/**
|
|
362
|
-
* Indicates that the error is a [connected account](https://
|
|
362
|
+
* Indicates that the error is a [connected account](https://www.seam.co/docs/api/connected_accounts/object) error.
|
|
363
363
|
*/
|
|
364
364
|
is_connected_account_error: true;
|
|
365
365
|
/**
|
|
@@ -382,7 +382,7 @@ export type UnmanagedAccessCode = {
|
|
|
382
382
|
*/
|
|
383
383
|
error_code: 'insufficient_permissions';
|
|
384
384
|
/**
|
|
385
|
-
* Indicates that the error is a [connected account](https://
|
|
385
|
+
* Indicates that the error is a [connected account](https://www.seam.co/docs/api/connected_accounts/object) error.
|
|
386
386
|
*/
|
|
387
387
|
is_connected_account_error: true;
|
|
388
388
|
/**
|
|
@@ -405,7 +405,7 @@ export type UnmanagedAccessCode = {
|
|
|
405
405
|
*/
|
|
406
406
|
error_code: 'dormakaba_sites_disconnected';
|
|
407
407
|
/**
|
|
408
|
-
* Indicates that the error is a [connected account](https://
|
|
408
|
+
* Indicates that the error is a [connected account](https://www.seam.co/docs/api/connected_accounts/object) error.
|
|
409
409
|
*/
|
|
410
410
|
is_connected_account_error: true;
|
|
411
411
|
/**
|
|
@@ -493,7 +493,7 @@ export type UnmanagedAccessCode = {
|
|
|
493
493
|
*/
|
|
494
494
|
message: string;
|
|
495
495
|
} /**
|
|
496
|
-
* Indicates that the [backup access code pool](https://
|
|
496
|
+
* Indicates that the [backup access code pool](https://www.seam.co/docs/low-level-apis/smart-locks/access-codes/backup-access-codes) is empty.
|
|
497
497
|
*/ | {
|
|
498
498
|
/**
|
|
499
499
|
* Date and time at which Seam created the error.
|
|
@@ -588,7 +588,7 @@ export type UnmanagedAccessCode = {
|
|
|
588
588
|
*/
|
|
589
589
|
message: string;
|
|
590
590
|
} /**
|
|
591
|
-
* Indicates that the Seam API cannot communicate with [Seam Bridge](https://
|
|
591
|
+
* Indicates that the Seam API cannot communicate with [Seam Bridge](https://www.seam.co/docs/capability-guides/seam-bridge), for example, if the Seam Bridge executable has stopped or if the computer running the Seam Bridge executable is offline. See also [Troubleshooting Your Access Control System](https://www.seam.co/docs/low-level-apis/access-systems/troubleshooting-your-access-control-system#acs_system-errors-seam_bridge_disconnected).
|
|
592
592
|
*/ | {
|
|
593
593
|
/**
|
|
594
594
|
* Date and time at which Seam created the error.
|
|
@@ -599,7 +599,7 @@ export type UnmanagedAccessCode = {
|
|
|
599
599
|
*/
|
|
600
600
|
error_code: 'bridge_disconnected';
|
|
601
601
|
/**
|
|
602
|
-
* Indicates whether the error is related to [Seam Bridge](https://
|
|
602
|
+
* Indicates whether the error is related to [Seam Bridge](https://www.seam.co/docs/capability-guides/seam-bridge).
|
|
603
603
|
*/
|
|
604
604
|
is_bridge_error?: boolean | undefined;
|
|
605
605
|
/**
|
|
@@ -633,7 +633,7 @@ export type UnmanagedAccessCode = {
|
|
|
633
633
|
*/
|
|
634
634
|
type: 'time_bound' | 'ongoing';
|
|
635
635
|
/**
|
|
636
|
-
* Warnings associated with the [access code](https://
|
|
636
|
+
* Warnings associated with the [access code](https://www.seam.co/docs/low-level-apis/smart-locks/access-codes).
|
|
637
637
|
*/
|
|
638
638
|
warnings: Array<
|
|
639
639
|
/**
|
|
@@ -23,7 +23,7 @@ export type UnmanagedAccessGrant = {
|
|
|
23
23
|
*/
|
|
24
24
|
ends_at: string | null;
|
|
25
25
|
/**
|
|
26
|
-
* Errors associated with the [access grant](https://
|
|
26
|
+
* Errors associated with the [access grant](https://www.seam.co/docs/use-cases/granting-access).
|
|
27
27
|
*/
|
|
28
28
|
errors: Array<
|
|
29
29
|
/**
|
|
@@ -189,11 +189,11 @@ export type UnmanagedAccessGrant = {
|
|
|
189
189
|
*/
|
|
190
190
|
user_identity_id?: string | undefined;
|
|
191
191
|
/**
|
|
192
|
-
* Warnings associated with the [access grant](https://
|
|
192
|
+
* Warnings associated with the [access grant](https://www.seam.co/docs/use-cases/granting-access).
|
|
193
193
|
*/
|
|
194
194
|
warnings: Array<
|
|
195
195
|
/**
|
|
196
|
-
* Indicates that the [access grant](https://
|
|
196
|
+
* Indicates that the [access grant](https://www.seam.co/docs/use-cases/granting-access) is being deleted.
|
|
197
197
|
*/
|
|
198
198
|
{
|
|
199
199
|
/**
|
|
@@ -256,7 +256,7 @@ export type UnmanagedAccessGrant = {
|
|
|
256
256
|
*/
|
|
257
257
|
warning_code: 'overprovisioned_access';
|
|
258
258
|
} /**
|
|
259
|
-
* Indicates that the access times for this [access grant](https://
|
|
259
|
+
* Indicates that the access times for this [access grant](https://www.seam.co/docs/use-cases/granting-access) are being updated.
|
|
260
260
|
*/ | {
|
|
261
261
|
/**
|
|
262
262
|
* IDs of the access methods being updated.
|
|
@@ -23,11 +23,11 @@ export type UnmanagedAccessMethod = {
|
|
|
23
23
|
*/
|
|
24
24
|
display_status: string;
|
|
25
25
|
/**
|
|
26
|
-
* Errors associated with the [access method](https://
|
|
26
|
+
* Errors associated with the [access method](https://www.seam.co/docs/use-cases/granting-access/creating-an-access-grant).
|
|
27
27
|
*/
|
|
28
28
|
errors: Array<
|
|
29
29
|
/**
|
|
30
|
-
* Indicates that Seam was unable to issue this [access method](https://
|
|
30
|
+
* Indicates that Seam was unable to issue this [access method](https://www.seam.co/docs/use-cases/granting-access/creating-an-access-grant) before its access grant started, so the recipient may be unable to access the space. This usually points to a problem that needs attention, such as an offline or disconnected device. Seam keeps retrying, and this error clears automatically if the access method is eventually issued.
|
|
31
31
|
*/
|
|
32
32
|
{
|
|
33
33
|
/**
|
|
@@ -72,7 +72,7 @@ export type UnmanagedAccessMethod = {
|
|
|
72
72
|
*/
|
|
73
73
|
mode: 'code' | 'card' | 'mobile_key' | 'cloud_key';
|
|
74
74
|
/**
|
|
75
|
-
* Pending mutations for the [access method](https://
|
|
75
|
+
* Pending mutations for the [access method](https://www.seam.co/docs/use-cases/granting-access/creating-an-access-grant). Indicates operations that are in progress.
|
|
76
76
|
*/
|
|
77
77
|
pending_mutations: Array<
|
|
78
78
|
/**
|
|
@@ -185,11 +185,11 @@ export type UnmanagedAccessMethod = {
|
|
|
185
185
|
};
|
|
186
186
|
}>;
|
|
187
187
|
/**
|
|
188
|
-
* Warnings associated with the [access method](https://
|
|
188
|
+
* Warnings associated with the [access method](https://www.seam.co/docs/use-cases/granting-access/creating-an-access-grant).
|
|
189
189
|
*/
|
|
190
190
|
warnings: Array<
|
|
191
191
|
/**
|
|
192
|
-
* Indicates that the [access method](https://
|
|
192
|
+
* Indicates that the [access method](https://www.seam.co/docs/use-cases/granting-access/creating-an-access-grant) is being deleted.
|
|
193
193
|
*/
|
|
194
194
|
{
|
|
195
195
|
/**
|
|
@@ -205,7 +205,7 @@ export type UnmanagedAccessMethod = {
|
|
|
205
205
|
*/
|
|
206
206
|
warning_code: 'being_deleted';
|
|
207
207
|
} /**
|
|
208
|
-
* Indicates that the access times for this [access method](https://
|
|
208
|
+
* Indicates that the access times for this [access method](https://www.seam.co/docs/use-cases/granting-access/creating-an-access-grant) are being updated.
|
|
209
209
|
*/ | {
|
|
210
210
|
/**
|
|
211
211
|
* Date and time at which Seam created the warning.
|
|
@@ -239,7 +239,7 @@ export type UnmanagedAccessMethod = {
|
|
|
239
239
|
*/
|
|
240
240
|
warning_code: 'pulled_backup_access_code';
|
|
241
241
|
} /**
|
|
242
|
-
* Indicates that Seam has not yet issued this [access method](https://
|
|
242
|
+
* Indicates that Seam has not yet issued this [access method](https://www.seam.co/docs/use-cases/granting-access/creating-an-access-grant), even though its access grant is about to begin, so access may not be ready when the recipient arrives. Seam is still attempting to issue it, and this warning clears automatically once issuance succeeds.
|
|
243
243
|
*/ | {
|
|
244
244
|
/**
|
|
245
245
|
* Date and time at which Seam created the warning.
|
|
@@ -254,7 +254,7 @@ export type UnmanagedAccessMethod = {
|
|
|
254
254
|
*/
|
|
255
255
|
warning_code: 'delay_in_issuing';
|
|
256
256
|
} /**
|
|
257
|
-
* Indicates that the access system delivers this mobile key through an app invitation sent to the recipient's email address, but the [user identity](https://
|
|
257
|
+
* Indicates that the access system delivers this mobile key through an app invitation sent to the recipient's email address, but the [user identity](https://www.seam.co/docs/capability-guides/mobile-access/managing-mobile-app-user-accounts-with-user-identities) for this [access grant](https://www.seam.co/docs/use-cases/granting-access/creating-an-access-grant) has no email address, so the mobile key cannot be delivered. Set an email address on the user identity when you create the access grant.
|
|
258
258
|
*/ | {
|
|
259
259
|
/**
|
|
260
260
|
* Date and time at which Seam created the warning.
|
|
@@ -269,7 +269,7 @@ export type UnmanagedAccessMethod = {
|
|
|
269
269
|
*/
|
|
270
270
|
warning_code: 'user_identity_missing_email_address';
|
|
271
271
|
} /**
|
|
272
|
-
* Indicates that the access system delivers this mobile key to the recipient's phone number, but the [user identity](https://
|
|
272
|
+
* Indicates that the access system delivers this mobile key to the recipient's phone number, but the [user identity](https://www.seam.co/docs/capability-guides/mobile-access/managing-mobile-app-user-accounts-with-user-identities) for this [access grant](https://www.seam.co/docs/use-cases/granting-access/creating-an-access-grant) has no phone number, so the mobile key cannot be delivered. Set a phone number on the user identity when you create the access grant.
|
|
273
273
|
*/ | {
|
|
274
274
|
/**
|
|
275
275
|
* Date and time at which Seam created the warning.
|
|
@@ -1,5 +1,5 @@
|
|
|
1
1
|
/**
|
|
2
|
-
* Represents an [unmanaged device](https://
|
|
2
|
+
* Represents an [unmanaged device](https://www.seam.co/docs/core-concepts/devices/managed-and-unmanaged-devices). An unmanaged device has a limited set of visible properties and a subset of supported events. You cannot control an unmanaged device. Any [access codes](https://www.seam.co/docs/low-level-apis/smart-locks/access-codes/migrating-existing-access-codes) on an unmanaged device are unmanaged. To control an unmanaged device with Seam, [convert it to a managed device](https://www.seam.co/docs/core-concepts/devices/managed-and-unmanaged-devices#convert-an-unmanaged-device-to-managed).
|
|
3
3
|
*/
|
|
4
4
|
export type UnmanagedDevice = {
|
|
5
5
|
/**
|
|
@@ -83,7 +83,7 @@ export type UnmanagedDevice = {
|
|
|
83
83
|
*/
|
|
84
84
|
can_unlock_with_code?: boolean | undefined;
|
|
85
85
|
/**
|
|
86
|
-
* Collection of capabilities that the device supports when connected to Seam. Values are `access_code`, which indicates that the device can manage and utilize digital PIN codes for secure access; `lock`, which indicates that the device controls a door locking mechanism, enabling the remote opening and closing of doors and other entry points; `noise_detection`, which indicates that the device supports monitoring and responding to ambient noise levels; `thermostat`, which indicates that the device can regulate and adjust indoor temperatures; `battery`, which indicates that the device can manage battery life and health; and `phone`, which indicates that the device is a mobile device, such as a smartphone. **Important:** Superseded by [capability flags](https://
|
|
86
|
+
* Collection of capabilities that the device supports when connected to Seam. Values are `access_code`, which indicates that the device can manage and utilize digital PIN codes for secure access; `lock`, which indicates that the device controls a door locking mechanism, enabling the remote opening and closing of doors and other entry points; `noise_detection`, which indicates that the device supports monitoring and responding to ambient noise levels; `thermostat`, which indicates that the device can regulate and adjust indoor temperatures; `battery`, which indicates that the device can manage battery life and health; and `phone`, which indicates that the device is a mobile device, such as a smartphone. **Important:** Superseded by [capability flags](https://www.seam.co/docs/capability-guides/device-and-system-capabilities#capability-flags).
|
|
87
87
|
*/
|
|
88
88
|
capabilities_supported: Array<'access_code' | 'lock' | 'noise_detection' | 'thermostat' | 'battery' | 'phone'>;
|
|
89
89
|
/**
|
|
@@ -95,7 +95,7 @@ export type UnmanagedDevice = {
|
|
|
95
95
|
*/
|
|
96
96
|
created_at: string;
|
|
97
97
|
/**
|
|
98
|
-
* Set of key:value pairs. Adding custom metadata to a resource, such as a [Connect Webview](https://
|
|
98
|
+
* Set of key:value pairs. Adding custom metadata to a resource, such as a [Connect Webview](https://www.seam.co/docs/core-concepts/connect-webviews/attaching-custom-data-to-the-connect-webview), [connected account](https://www.seam.co/docs/core-concepts/connected-accounts/adding-custom-metadata-to-a-connected-account), or [device](https://www.seam.co/docs/core-concepts/devices/adding-custom-metadata-to-a-device), enables you to store custom information, like customer details or internal IDs from your application. Keys set to `null` or to an empty string are omitted.
|
|
99
99
|
*/
|
|
100
100
|
custom_metadata: Record<string, string | boolean>;
|
|
101
101
|
/**
|
|
@@ -105,7 +105,7 @@ export type UnmanagedDevice = {
|
|
|
105
105
|
/**
|
|
106
106
|
* Type of the device.
|
|
107
107
|
*/
|
|
108
|
-
device_type: 'akuvox_lock' | 'august_lock' | 'brivo_access_point' | 'butterflymx_panel' | 'avigilon_alta_entry' | 'doorking_lock' | 'genie_door' | 'igloo_lock' | 'linear_lock' | 'lockly_lock' | 'kwikset_lock' | 'nuki_lock' | 'salto_lock' | 'schlage_lock' | 'smartthings_lock' | 'wyze_lock' | 'yale_lock' | 'two_n_intercom' | 'controlbyweb_device' | 'ttlock_lock' | 'igloohome_lock' | 'four_suites_door' | 'dormakaba_oracode_door' | 'tedee_lock' | 'akiles_lock' | 'ultraloq_lock' | 'yacan_lock' | 'keyincode_lock' | 'omnitec_lock' | 'kisi_lock' | 'aqara_lock' | 'keynest_key' | 'noiseaware_activity_zone' | 'minut_sensor' | 'ecobee_thermostat' | 'nest_thermostat' | 'honeywell_resideo_thermostat' | 'tado_thermostat' | 'sensi_thermostat' | 'smartthings_thermostat' | 'ios_phone' | 'android_phone' | 'ring_camera';
|
|
108
|
+
device_type: 'akuvox_lock' | 'august_lock' | 'brivo_access_point' | 'butterflymx_panel' | 'avigilon_alta_entry' | 'doorking_lock' | 'genie_door' | 'igloo_lock' | 'linear_lock' | 'lockly_lock' | 'kwikset_lock' | 'nuki_lock' | 'salto_lock' | 'schlage_lock' | 'smartthings_lock' | 'wyze_lock' | 'yale_lock' | 'two_n_intercom' | 'controlbyweb_device' | 'ttlock_lock' | 'igloohome_lock' | 'four_suites_door' | 'dormakaba_oracode_door' | 'tedee_lock' | 'akiles_lock' | 'ultraloq_lock' | 'yacan_lock' | 'keyincode_lock' | 'omnitec_lock' | 'kisi_lock' | 'aqara_lock' | 'keynest_key' | 'noiseaware_activity_zone' | 'minut_sensor' | 'ecobee_thermostat' | 'nest_thermostat' | 'honeywell_resideo_thermostat' | 'tado_thermostat' | 'sensi_thermostat' | 'smartthings_thermostat' | 'ios_phone' | 'android_phone' | 'ring_camera' | 'tapo_camera';
|
|
109
109
|
/**
|
|
110
110
|
* Display name of the device, defaults to nickname (if it is set) or `properties.appearance.name`, otherwise. Enables administrators and users to identify the device easily, especially when there are numerous devices.
|
|
111
111
|
*/
|
|
@@ -127,7 +127,7 @@ export type UnmanagedDevice = {
|
|
|
127
127
|
*/
|
|
128
128
|
error_code: 'account_disconnected';
|
|
129
129
|
/**
|
|
130
|
-
* Indicates that the error is a [connected account](https://
|
|
130
|
+
* Indicates that the error is a [connected account](https://www.seam.co/docs/api/connected_accounts/object) error.
|
|
131
131
|
*/
|
|
132
132
|
is_connected_account_error: true;
|
|
133
133
|
/**
|
|
@@ -150,7 +150,7 @@ export type UnmanagedDevice = {
|
|
|
150
150
|
*/
|
|
151
151
|
error_code: 'salto_ks_subscription_limit_exceeded';
|
|
152
152
|
/**
|
|
153
|
-
* Indicates that the error is a [connected account](https://
|
|
153
|
+
* Indicates that the error is a [connected account](https://www.seam.co/docs/api/connected_accounts/object) error.
|
|
154
154
|
*/
|
|
155
155
|
is_connected_account_error: true;
|
|
156
156
|
/**
|
|
@@ -173,7 +173,7 @@ export type UnmanagedDevice = {
|
|
|
173
173
|
*/
|
|
174
174
|
error_code: 'insufficient_permissions';
|
|
175
175
|
/**
|
|
176
|
-
* Indicates that the error is a [connected account](https://
|
|
176
|
+
* Indicates that the error is a [connected account](https://www.seam.co/docs/api/connected_accounts/object) error.
|
|
177
177
|
*/
|
|
178
178
|
is_connected_account_error: true;
|
|
179
179
|
/**
|
|
@@ -196,7 +196,7 @@ export type UnmanagedDevice = {
|
|
|
196
196
|
*/
|
|
197
197
|
error_code: 'dormakaba_sites_disconnected';
|
|
198
198
|
/**
|
|
199
|
-
* Indicates that the error is a [connected account](https://
|
|
199
|
+
* Indicates that the error is a [connected account](https://www.seam.co/docs/api/connected_accounts/object) error.
|
|
200
200
|
*/
|
|
201
201
|
is_connected_account_error: true;
|
|
202
202
|
/**
|
|
@@ -284,7 +284,7 @@ export type UnmanagedDevice = {
|
|
|
284
284
|
*/
|
|
285
285
|
message: string;
|
|
286
286
|
} /**
|
|
287
|
-
* Indicates that the [backup access code pool](https://
|
|
287
|
+
* Indicates that the [backup access code pool](https://www.seam.co/docs/low-level-apis/smart-locks/access-codes/backup-access-codes) is empty.
|
|
288
288
|
*/ | {
|
|
289
289
|
/**
|
|
290
290
|
* Date and time at which Seam created the error.
|
|
@@ -379,7 +379,7 @@ export type UnmanagedDevice = {
|
|
|
379
379
|
*/
|
|
380
380
|
message: string;
|
|
381
381
|
} /**
|
|
382
|
-
* Indicates that the Seam API cannot communicate with [Seam Bridge](https://
|
|
382
|
+
* Indicates that the Seam API cannot communicate with [Seam Bridge](https://www.seam.co/docs/capability-guides/seam-bridge), for example, if the Seam Bridge executable has stopped or if the computer running the Seam Bridge executable is offline. See also [Troubleshooting Your Access Control System](https://www.seam.co/docs/low-level-apis/access-systems/troubleshooting-your-access-control-system#acs_system-errors-seam_bridge_disconnected).
|
|
383
383
|
*/ | {
|
|
384
384
|
/**
|
|
385
385
|
* Date and time at which Seam created the error.
|
|
@@ -390,7 +390,7 @@ export type UnmanagedDevice = {
|
|
|
390
390
|
*/
|
|
391
391
|
error_code: 'bridge_disconnected';
|
|
392
392
|
/**
|
|
393
|
-
* Indicates whether the error is related to [Seam Bridge](https://
|
|
393
|
+
* Indicates whether the error is related to [Seam Bridge](https://www.seam.co/docs/capability-guides/seam-bridge).
|
|
394
394
|
*/
|
|
395
395
|
is_bridge_error?: boolean | undefined;
|
|
396
396
|
/**
|
|
@@ -1,5 +1,5 @@
|
|
|
1
1
|
/**
|
|
2
|
-
* Represents a [user identity](https://
|
|
2
|
+
* Represents a [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 an application user account.
|
|
3
3
|
*/
|
|
4
4
|
export type UserIdentity = {
|
|
5
5
|
/**
|
|
@@ -1,17 +1,17 @@
|
|
|
1
1
|
/**
|
|
2
|
-
* Represents a [webhook](https://
|
|
2
|
+
* Represents a [webhook](https://www.seam.co/docs/developer-tools/webhooks) that enables you to receive notifications of events. When you create a webhook, specify the endpoint URL at which you want to receive events and the set of event types that you want to receive.
|
|
3
3
|
*/
|
|
4
4
|
export type Webhook = {
|
|
5
5
|
/**
|
|
6
|
-
* Types of events that the [webhook](https://
|
|
6
|
+
* Types of events that the [webhook](https://www.seam.co/docs/developer-tools/webhooks) should receive.
|
|
7
7
|
*/
|
|
8
8
|
event_types?: Array<string> | undefined;
|
|
9
9
|
/**
|
|
10
|
-
* Secret associated with the [webhook](https://
|
|
10
|
+
* Secret associated with the [webhook](https://www.seam.co/docs/developer-tools/webhooks).
|
|
11
11
|
*/
|
|
12
12
|
secret?: string | undefined;
|
|
13
13
|
/**
|
|
14
|
-
* URL for the [webhook](https://
|
|
14
|
+
* URL for the [webhook](https://www.seam.co/docs/developer-tools/webhooks).
|
|
15
15
|
*/
|
|
16
16
|
url: string;
|
|
17
17
|
/**
|
|
@@ -1,35 +1,35 @@
|
|
|
1
1
|
/**
|
|
2
|
-
* Represents a Seam [workspace](https://
|
|
2
|
+
* Represents a Seam [workspace](https://www.seam.co/docs/core-concepts/workspaces). A workspace is a top-level entity that encompasses all other resources below it, such as devices, connected accounts, and Connect Webviews. Seam provides two types of workspaces. A [sandbox workspace](https://www.seam.co/docs/core-concepts/workspaces#sandbox-workspaces) is a special type of workspace designed for testing code. Sandbox workspaces offer test device accounts and virtual devices that you can connect and control. This ability to work with virtual devices is quite handy because it removes the need to own physical devices from multiple brands. To connect real devices and systems to Seam, use a [production workspace](https://www.seam.co/docs/core-concepts/workspaces#production-workspaces).
|
|
3
3
|
*/
|
|
4
4
|
export type Workspace = {
|
|
5
5
|
/**
|
|
6
|
-
* Company name associated with the [workspace](https://
|
|
6
|
+
* Company name associated with the [workspace](https://www.seam.co/docs/core-concepts/workspaces).
|
|
7
7
|
* @deprecated Use `connect_partner_name` instead.
|
|
8
8
|
*/
|
|
9
9
|
company_name: string;
|
|
10
10
|
/**
|
|
11
|
-
* Seam Connect partner name associated with the [workspace](https://
|
|
11
|
+
* Seam Connect partner name associated with the [workspace](https://www.seam.co/docs/core-concepts/workspaces).
|
|
12
12
|
*/
|
|
13
13
|
connect_partner_name: string | null;
|
|
14
14
|
connect_webview_customization: {
|
|
15
15
|
/**
|
|
16
|
-
* URL of the inviter logo for [Connect Webviews](https://
|
|
16
|
+
* URL of the inviter logo for [Connect Webviews](https://www.seam.co/docs/core-concepts/connect-webviews) in the workspace. See also [Customize the Look and Feel of Your Connect Webviews](https://www.seam.co/docs/core-concepts/connect-webviews/customizing-connect-webviews#customize-the-look-and-feel-of-your-connect-webviews).
|
|
17
17
|
*/
|
|
18
18
|
inviter_logo_url?: string | undefined;
|
|
19
19
|
/**
|
|
20
|
-
* Logo shape for [Connect Webviews](https://
|
|
20
|
+
* Logo shape for [Connect Webviews](https://www.seam.co/docs/core-concepts/connect-webviews) in the workspace. See also [Customize the Look and Feel of Your Connect Webviews](https://www.seam.co/docs/core-concepts/connect-webviews/customizing-connect-webviews#customize-the-look-and-feel-of-your-connect-webviews).
|
|
21
21
|
*/
|
|
22
22
|
logo_shape?: 'circle' | 'square' | undefined;
|
|
23
23
|
/**
|
|
24
|
-
* Primary button color for [Connect Webviews](https://
|
|
24
|
+
* Primary button color for [Connect Webviews](https://www.seam.co/docs/core-concepts/connect-webviews) in the workspace. See also [Customize the Look and Feel of Your Connect Webviews](https://www.seam.co/docs/core-concepts/connect-webviews/customizing-connect-webviews#customize-the-look-and-feel-of-your-connect-webviews).
|
|
25
25
|
*/
|
|
26
26
|
primary_button_color?: string | undefined;
|
|
27
27
|
/**
|
|
28
|
-
* Primary button text color for [Connect Webviews](https://
|
|
28
|
+
* Primary button text color for [Connect Webviews](https://www.seam.co/docs/core-concepts/connect-webviews) in the workspace. See also [Customize the Look and Feel of Your Connect Webviews](https://www.seam.co/docs/core-concepts/connect-webviews/customizing-connect-webviews#customize-the-look-and-feel-of-your-connect-webviews).
|
|
29
29
|
*/
|
|
30
30
|
primary_button_text_color?: string | undefined;
|
|
31
31
|
/**
|
|
32
|
-
* Success message for [Connect Webviews](https://
|
|
32
|
+
* Success message for [Connect Webviews](https://www.seam.co/docs/core-concepts/connect-webviews) in the workspace. See also [Customize the Look and Feel of Your Connect Webviews](https://www.seam.co/docs/core-concepts/connect-webviews/customizing-connect-webviews#customize-the-look-and-feel-of-your-connect-webviews).
|
|
33
33
|
*/
|
|
34
34
|
success_message?: string | undefined;
|
|
35
35
|
};
|
|
@@ -38,15 +38,15 @@ export type Workspace = {
|
|
|
38
38
|
*/
|
|
39
39
|
is_publishable_key_auth_enabled: boolean;
|
|
40
40
|
/**
|
|
41
|
-
* Indicates whether the workspace is a [sandbox workspace](https://
|
|
41
|
+
* Indicates whether the workspace is a [sandbox workspace](https://www.seam.co/docs/core-concepts/workspaces#sandbox-workspaces).
|
|
42
42
|
*/
|
|
43
43
|
is_sandbox: boolean;
|
|
44
44
|
/**
|
|
45
|
-
* Indicates whether the [sandbox workspace](https://
|
|
45
|
+
* Indicates whether the [sandbox workspace](https://www.seam.co/docs/core-concepts/workspaces#sandbox-workspaces) is suspended. Seam suspends sandbox workspaces that have not been accessed in 14 days.
|
|
46
46
|
*/
|
|
47
47
|
is_suspended: boolean;
|
|
48
48
|
/**
|
|
49
|
-
* Name of the [workspace](https://
|
|
49
|
+
* Name of the [workspace](https://www.seam.co/docs/core-concepts/workspaces).
|
|
50
50
|
*/
|
|
51
51
|
name: string;
|
|
52
52
|
/**
|
|
@@ -54,7 +54,7 @@ export type Workspace = {
|
|
|
54
54
|
*/
|
|
55
55
|
organization_id: string | null;
|
|
56
56
|
/**
|
|
57
|
-
* Publishable key for the [workspace](https://
|
|
57
|
+
* Publishable key for the [workspace](https://www.seam.co/docs/core-concepts/workspaces). This key is used to identify the workspace in client-side applications.
|
|
58
58
|
*/
|
|
59
59
|
publishable_key?: string | undefined;
|
|
60
60
|
/**
|