@seamapi/http 2.31.0 → 2.33.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 +102 -85
- 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 +6 -6
- 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 +104 -84
- 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 +13 -9
- package/src/lib/routes/devices/simulate/simulate.ts +3 -3
- package/src/lib/routes/devices/unmanaged/unmanaged.ts +10 -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 +6 -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
|
@@ -4,7 +4,7 @@
|
|
|
4
4
|
*/
|
|
5
5
|
|
|
6
6
|
/**
|
|
7
|
-
* An [access code](https://
|
|
7
|
+
* An [access code](https://www.seam.co/docs/low-level-apis/smart-locks/access-codes) was created.
|
|
8
8
|
*/
|
|
9
9
|
export type SeamEvent =
|
|
10
10
|
| {
|
|
@@ -1932,7 +1932,7 @@ export type SeamEvent =
|
|
|
1932
1932
|
access_grant_id: string
|
|
1933
1933
|
|
|
1934
1934
|
/**
|
|
1935
|
-
* ID of the affected [entrance](https://
|
|
1935
|
+
* ID of the affected [entrance](https://www.seam.co/docs/low-level-apis/access-systems/retrieving-entrance-details).
|
|
1936
1936
|
*/
|
|
1937
1937
|
acs_entrance_id: string
|
|
1938
1938
|
|
|
@@ -1969,7 +1969,7 @@ export type SeamEvent =
|
|
|
1969
1969
|
access_grant_id: string
|
|
1970
1970
|
|
|
1971
1971
|
/**
|
|
1972
|
-
* ID of the affected [entrance](https://
|
|
1972
|
+
* ID of the affected [entrance](https://www.seam.co/docs/low-level-apis/access-systems/retrieving-entrance-details).
|
|
1973
1973
|
*/
|
|
1974
1974
|
acs_entrance_id: string
|
|
1975
1975
|
|
|
@@ -5739,7 +5739,7 @@ export type SeamEvent =
|
|
|
5739
5739
|
*/
|
|
5740
5740
|
is_via_nfc?: boolean | undefined
|
|
5741
5741
|
/**
|
|
5742
|
-
* Method by which the lock was unlocked. `keycode`: an [access code](https://
|
|
5742
|
+
* 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.
|
|
5743
5743
|
*/
|
|
5744
5744
|
method:
|
|
5745
5745
|
| 'keycode'
|
|
@@ -5911,11 +5911,11 @@ export type SeamEvent =
|
|
|
5911
5911
|
connected_account_id: string
|
|
5912
5912
|
|
|
5913
5913
|
/**
|
|
5914
|
-
* Temperature to which the thermostat should cool (in °C). See also [Set Points](https://
|
|
5914
|
+
* 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).
|
|
5915
5915
|
*/
|
|
5916
5916
|
cooling_set_point_celsius?: number | undefined
|
|
5917
5917
|
/**
|
|
5918
|
-
* Temperature to which the thermostat should cool (in °F). See also [Set Points](https://
|
|
5918
|
+
* 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).
|
|
5919
5919
|
*/
|
|
5920
5920
|
cooling_set_point_fahrenheit?: number | undefined
|
|
5921
5921
|
/**
|
|
@@ -5948,19 +5948,19 @@ export type SeamEvent =
|
|
|
5948
5948
|
event_type: 'thermostat.manually_adjusted'
|
|
5949
5949
|
|
|
5950
5950
|
/**
|
|
5951
|
-
* Desired [fan mode setting](https://
|
|
5951
|
+
* 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`.
|
|
5952
5952
|
*/
|
|
5953
5953
|
fan_mode_setting?: 'auto' | 'on' | 'circulate' | undefined
|
|
5954
5954
|
/**
|
|
5955
|
-
* Temperature to which the thermostat should heat (in °C). See also [Set Points](https://
|
|
5955
|
+
* 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).
|
|
5956
5956
|
*/
|
|
5957
5957
|
heating_set_point_celsius?: number | undefined
|
|
5958
5958
|
/**
|
|
5959
|
-
* Temperature to which the thermostat should heat (in °F). See also [Set Points](https://
|
|
5959
|
+
* 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).
|
|
5960
5960
|
*/
|
|
5961
5961
|
heating_set_point_fahrenheit?: number | undefined
|
|
5962
5962
|
/**
|
|
5963
|
-
* Desired [HVAC mode](https://
|
|
5963
|
+
* 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`.
|
|
5964
5964
|
*/
|
|
5965
5965
|
hvac_mode_setting?:
|
|
5966
5966
|
'off' | 'heat' | 'cool' | 'heat_cool' | 'eco' | undefined
|
|
@@ -4,7 +4,7 @@
|
|
|
4
4
|
*/
|
|
5
5
|
|
|
6
6
|
/**
|
|
7
|
-
* Represents a [noise threshold](https://
|
|
7
|
+
* 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.
|
|
8
8
|
*/
|
|
9
9
|
export type NoiseThreshold = {
|
|
10
10
|
/**
|
|
@@ -33,7 +33,7 @@ export type NoiseThreshold = {
|
|
|
33
33
|
noise_threshold_id: string
|
|
34
34
|
|
|
35
35
|
/**
|
|
36
|
-
* Noise level in Noiseaware Noise Risk Score (NRS) for the noise threshold. This parameter is only relevant for [Noiseaware sensors](https://
|
|
36
|
+
* 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).
|
|
37
37
|
*/
|
|
38
38
|
noise_threshold_nrs?: number | undefined
|
|
39
39
|
/**
|
|
@@ -13,7 +13,7 @@ export type Phone = {
|
|
|
13
13
|
created_at: string
|
|
14
14
|
|
|
15
15
|
/**
|
|
16
|
-
* Optional [custom metadata](https://
|
|
16
|
+
* Optional [custom metadata](https://www.seam.co/docs/core-concepts/devices/adding-custom-metadata-to-a-device) for the phone.
|
|
17
17
|
*/
|
|
18
18
|
custom_metadata: Record<string, string | boolean>
|
|
19
19
|
|
|
@@ -26,7 +26,7 @@ export type ThermostatDailyProgram = {
|
|
|
26
26
|
*/
|
|
27
27
|
periods: Array<{
|
|
28
28
|
/**
|
|
29
|
-
* Key of the [climate preset](https://
|
|
29
|
+
* 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`.
|
|
30
30
|
*/
|
|
31
31
|
climate_preset_key: string
|
|
32
32
|
|
|
@@ -4,31 +4,31 @@
|
|
|
4
4
|
*/
|
|
5
5
|
|
|
6
6
|
/**
|
|
7
|
-
* Represents a [thermostat schedule](https://
|
|
7
|
+
* 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.
|
|
8
8
|
*/
|
|
9
9
|
export type ThermostatSchedule = {
|
|
10
10
|
/**
|
|
11
|
-
* Key of the [climate preset](https://
|
|
11
|
+
* 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).
|
|
12
12
|
*/
|
|
13
13
|
climate_preset_key: string
|
|
14
14
|
|
|
15
15
|
/**
|
|
16
|
-
* Date and time at which the [thermostat schedule](https://
|
|
16
|
+
* Date and time at which the [thermostat schedule](https://www.seam.co/docs/capability-guides/thermostats/creating-and-managing-thermostat-schedules) was created.
|
|
17
17
|
*/
|
|
18
18
|
created_at: string
|
|
19
19
|
|
|
20
20
|
/**
|
|
21
|
-
* ID of the desired [thermostat](https://
|
|
21
|
+
* ID of the desired [thermostat](https://www.seam.co/docs/capability-guides/thermostats) device.
|
|
22
22
|
*/
|
|
23
23
|
device_id: string
|
|
24
24
|
|
|
25
25
|
/**
|
|
26
|
-
* Date and time at which the [thermostat schedule](https://
|
|
26
|
+
* 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.
|
|
27
27
|
*/
|
|
28
28
|
ends_at: string
|
|
29
29
|
|
|
30
30
|
/**
|
|
31
|
-
* Errors associated with the [thermostat schedule](https://
|
|
31
|
+
* Errors associated with the [thermostat schedule](https://www.seam.co/docs/capability-guides/thermostats/creating-and-managing-thermostat-schedules).
|
|
32
32
|
*/
|
|
33
33
|
errors: Array<{
|
|
34
34
|
/**
|
|
@@ -48,24 +48,24 @@ export type ThermostatSchedule = {
|
|
|
48
48
|
}>
|
|
49
49
|
|
|
50
50
|
/**
|
|
51
|
-
* Indicates whether a person at the thermostat can change the thermostat's settings after the [thermostat schedule](https://
|
|
51
|
+
* 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.
|
|
52
52
|
*/
|
|
53
53
|
is_override_allowed?: boolean | undefined
|
|
54
54
|
/**
|
|
55
|
-
* 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://
|
|
55
|
+
* 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).
|
|
56
56
|
*/
|
|
57
57
|
max_override_period_minutes?: number | null | undefined
|
|
58
58
|
/**
|
|
59
|
-
* User-friendly name to identify the [thermostat schedule](https://
|
|
59
|
+
* User-friendly name to identify the [thermostat schedule](https://www.seam.co/docs/capability-guides/thermostats/creating-and-managing-thermostat-schedules).
|
|
60
60
|
*/
|
|
61
61
|
name: string | null
|
|
62
62
|
/**
|
|
63
|
-
* Date and time at which the [thermostat schedule](https://
|
|
63
|
+
* 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.
|
|
64
64
|
*/
|
|
65
65
|
starts_at: string
|
|
66
66
|
|
|
67
67
|
/**
|
|
68
|
-
* ID of the [thermostat schedule](https://
|
|
68
|
+
* ID of the [thermostat schedule](https://www.seam.co/docs/capability-guides/thermostats/creating-and-managing-thermostat-schedules).
|
|
69
69
|
*/
|
|
70
70
|
thermostat_schedule_id: string
|
|
71
71
|
|
|
@@ -4,7 +4,7 @@
|
|
|
4
4
|
*/
|
|
5
5
|
|
|
6
6
|
/**
|
|
7
|
-
* Represents an [unmanaged smart lock access code](https://
|
|
7
|
+
* Represents an [unmanaged smart lock access code](https://www.seam.co/docs/low-level-apis/smart-locks/access-codes/migrating-existing-access-codes).
|
|
8
8
|
*
|
|
9
9
|
* 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.
|
|
10
10
|
*
|
|
@@ -14,7 +14,7 @@
|
|
|
14
14
|
*
|
|
15
15
|
* Not all providers support unmanaged access codes. The following providers do not support unmanaged access codes:
|
|
16
16
|
*
|
|
17
|
-
* - [Kwikset](https://
|
|
17
|
+
* - [Kwikset](https://www.seam.co/docs/device-and-system-integration-guides/kwikset-locks)
|
|
18
18
|
*/
|
|
19
19
|
export type UnmanagedAccessCode = {
|
|
20
20
|
/**
|
|
@@ -94,7 +94,7 @@ export type UnmanagedAccessCode = {
|
|
|
94
94
|
*/
|
|
95
95
|
ends_at?: string | null | undefined
|
|
96
96
|
/**
|
|
97
|
-
* Errors associated with the [access code](https://
|
|
97
|
+
* Errors associated with the [access code](https://www.seam.co/docs/low-level-apis/smart-locks/access-codes).
|
|
98
98
|
*/
|
|
99
99
|
errors: Array<
|
|
100
100
|
/**
|
|
@@ -362,7 +362,7 @@ export type UnmanagedAccessCode = {
|
|
|
362
362
|
/**
|
|
363
363
|
* Unique identifier of the type of error. Enables quick recognition and categorization of the issue.
|
|
364
364
|
*/
|
|
365
|
-
error_code: '
|
|
365
|
+
error_code: 'failed_to_remove'
|
|
366
366
|
|
|
367
367
|
/**
|
|
368
368
|
* Indicates that this is an access code error.
|
|
@@ -388,7 +388,7 @@ export type UnmanagedAccessCode = {
|
|
|
388
388
|
error_code: 'account_disconnected'
|
|
389
389
|
|
|
390
390
|
/**
|
|
391
|
-
* Indicates that the error is a [connected account](https://
|
|
391
|
+
* Indicates that the error is a [connected account](https://www.seam.co/docs/api/connected_accounts/object) error.
|
|
392
392
|
*/
|
|
393
393
|
is_connected_account_error: true
|
|
394
394
|
|
|
@@ -416,7 +416,7 @@ export type UnmanagedAccessCode = {
|
|
|
416
416
|
error_code: 'salto_ks_subscription_limit_exceeded'
|
|
417
417
|
|
|
418
418
|
/**
|
|
419
|
-
* Indicates that the error is a [connected account](https://
|
|
419
|
+
* Indicates that the error is a [connected account](https://www.seam.co/docs/api/connected_accounts/object) error.
|
|
420
420
|
*/
|
|
421
421
|
is_connected_account_error: true
|
|
422
422
|
|
|
@@ -444,7 +444,7 @@ export type UnmanagedAccessCode = {
|
|
|
444
444
|
error_code: 'insufficient_permissions'
|
|
445
445
|
|
|
446
446
|
/**
|
|
447
|
-
* Indicates that the error is a [connected account](https://
|
|
447
|
+
* Indicates that the error is a [connected account](https://www.seam.co/docs/api/connected_accounts/object) error.
|
|
448
448
|
*/
|
|
449
449
|
is_connected_account_error: true
|
|
450
450
|
|
|
@@ -472,7 +472,7 @@ export type UnmanagedAccessCode = {
|
|
|
472
472
|
error_code: 'dormakaba_sites_disconnected'
|
|
473
473
|
|
|
474
474
|
/**
|
|
475
|
-
* Indicates that the error is a [connected account](https://
|
|
475
|
+
* Indicates that the error is a [connected account](https://www.seam.co/docs/api/connected_accounts/object) error.
|
|
476
476
|
*/
|
|
477
477
|
is_connected_account_error: true
|
|
478
478
|
|
|
@@ -578,7 +578,7 @@ export type UnmanagedAccessCode = {
|
|
|
578
578
|
*/
|
|
579
579
|
message: string
|
|
580
580
|
} /**
|
|
581
|
-
* Indicates that the [backup access code pool](https://
|
|
581
|
+
* Indicates that the [backup access code pool](https://www.seam.co/docs/low-level-apis/smart-locks/access-codes/backup-access-codes) is empty.
|
|
582
582
|
*/
|
|
583
583
|
| {
|
|
584
584
|
/**
|
|
@@ -693,7 +693,7 @@ export type UnmanagedAccessCode = {
|
|
|
693
693
|
*/
|
|
694
694
|
message: string
|
|
695
695
|
} /**
|
|
696
|
-
* Indicates that the Seam API cannot communicate with [Seam Bridge](https://
|
|
696
|
+
* 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).
|
|
697
697
|
*/
|
|
698
698
|
| {
|
|
699
699
|
/**
|
|
@@ -707,7 +707,7 @@ export type UnmanagedAccessCode = {
|
|
|
707
707
|
error_code: 'bridge_disconnected'
|
|
708
708
|
|
|
709
709
|
/**
|
|
710
|
-
* Indicates whether the error is related to [Seam Bridge](https://
|
|
710
|
+
* Indicates whether the error is related to [Seam Bridge](https://www.seam.co/docs/capability-guides/seam-bridge).
|
|
711
711
|
*/
|
|
712
712
|
is_bridge_error?: boolean | undefined
|
|
713
713
|
/**
|
|
@@ -746,7 +746,7 @@ export type UnmanagedAccessCode = {
|
|
|
746
746
|
type: 'time_bound' | 'ongoing'
|
|
747
747
|
|
|
748
748
|
/**
|
|
749
|
-
* Warnings associated with the [access code](https://
|
|
749
|
+
* Warnings associated with the [access code](https://www.seam.co/docs/low-level-apis/smart-locks/access-codes).
|
|
750
750
|
*/
|
|
751
751
|
warnings: Array<
|
|
752
752
|
/**
|
|
@@ -32,7 +32,7 @@ export type UnmanagedAccessGrant = {
|
|
|
32
32
|
*/
|
|
33
33
|
ends_at: string | null
|
|
34
34
|
/**
|
|
35
|
-
* Errors associated with the [access grant](https://
|
|
35
|
+
* Errors associated with the [access grant](https://www.seam.co/docs/use-cases/granting-access).
|
|
36
36
|
*/
|
|
37
37
|
errors: Array<
|
|
38
38
|
/**
|
|
@@ -222,11 +222,11 @@ export type UnmanagedAccessGrant = {
|
|
|
222
222
|
*/
|
|
223
223
|
user_identity_id?: string | undefined
|
|
224
224
|
/**
|
|
225
|
-
* Warnings associated with the [access grant](https://
|
|
225
|
+
* Warnings associated with the [access grant](https://www.seam.co/docs/use-cases/granting-access).
|
|
226
226
|
*/
|
|
227
227
|
warnings: Array<
|
|
228
228
|
/**
|
|
229
|
-
* Indicates that the [access grant](https://
|
|
229
|
+
* Indicates that the [access grant](https://www.seam.co/docs/use-cases/granting-access) is being deleted.
|
|
230
230
|
*/
|
|
231
231
|
| {
|
|
232
232
|
/**
|
|
@@ -301,7 +301,7 @@ export type UnmanagedAccessGrant = {
|
|
|
301
301
|
*/
|
|
302
302
|
warning_code: 'overprovisioned_access'
|
|
303
303
|
} /**
|
|
304
|
-
* Indicates that the access times for this [access grant](https://
|
|
304
|
+
* Indicates that the access times for this [access grant](https://www.seam.co/docs/use-cases/granting-access) are being updated.
|
|
305
305
|
*/
|
|
306
306
|
| {
|
|
307
307
|
/**
|
|
@@ -32,11 +32,11 @@ export type UnmanagedAccessMethod = {
|
|
|
32
32
|
display_status: string
|
|
33
33
|
|
|
34
34
|
/**
|
|
35
|
-
* Errors associated with the [access method](https://
|
|
35
|
+
* Errors associated with the [access method](https://www.seam.co/docs/use-cases/granting-access/creating-an-access-grant).
|
|
36
36
|
*/
|
|
37
37
|
errors: Array<
|
|
38
38
|
/**
|
|
39
|
-
* Indicates that Seam was unable to issue this [access method](https://
|
|
39
|
+
* 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.
|
|
40
40
|
*/
|
|
41
41
|
{
|
|
42
42
|
/**
|
|
@@ -87,7 +87,7 @@ export type UnmanagedAccessMethod = {
|
|
|
87
87
|
mode: 'code' | 'card' | 'mobile_key' | 'cloud_key'
|
|
88
88
|
|
|
89
89
|
/**
|
|
90
|
-
* Pending mutations for the [access method](https://
|
|
90
|
+
* 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.
|
|
91
91
|
*/
|
|
92
92
|
pending_mutations: Array<
|
|
93
93
|
/**
|
|
@@ -216,11 +216,11 @@ export type UnmanagedAccessMethod = {
|
|
|
216
216
|
>
|
|
217
217
|
|
|
218
218
|
/**
|
|
219
|
-
* Warnings associated with the [access method](https://
|
|
219
|
+
* Warnings associated with the [access method](https://www.seam.co/docs/use-cases/granting-access/creating-an-access-grant).
|
|
220
220
|
*/
|
|
221
221
|
warnings: Array<
|
|
222
222
|
/**
|
|
223
|
-
* Indicates that the [access method](https://
|
|
223
|
+
* Indicates that the [access method](https://www.seam.co/docs/use-cases/granting-access/creating-an-access-grant) is being deleted.
|
|
224
224
|
*/
|
|
225
225
|
| {
|
|
226
226
|
/**
|
|
@@ -238,7 +238,7 @@ export type UnmanagedAccessMethod = {
|
|
|
238
238
|
*/
|
|
239
239
|
warning_code: 'being_deleted'
|
|
240
240
|
} /**
|
|
241
|
-
* Indicates that the access times for this [access method](https://
|
|
241
|
+
* 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.
|
|
242
242
|
*/
|
|
243
243
|
| {
|
|
244
244
|
/**
|
|
@@ -278,7 +278,7 @@ export type UnmanagedAccessMethod = {
|
|
|
278
278
|
*/
|
|
279
279
|
warning_code: 'pulled_backup_access_code'
|
|
280
280
|
} /**
|
|
281
|
-
* Indicates that Seam has not yet issued this [access method](https://
|
|
281
|
+
* 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.
|
|
282
282
|
*/
|
|
283
283
|
| {
|
|
284
284
|
/**
|
|
@@ -296,7 +296,7 @@ export type UnmanagedAccessMethod = {
|
|
|
296
296
|
*/
|
|
297
297
|
warning_code: 'delay_in_issuing'
|
|
298
298
|
} /**
|
|
299
|
-
* 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://
|
|
299
|
+
* 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.
|
|
300
300
|
*/
|
|
301
301
|
| {
|
|
302
302
|
/**
|
|
@@ -314,7 +314,7 @@ export type UnmanagedAccessMethod = {
|
|
|
314
314
|
*/
|
|
315
315
|
warning_code: 'user_identity_missing_email_address'
|
|
316
316
|
} /**
|
|
317
|
-
* Indicates that the access system delivers this mobile key to the recipient's phone number, but the [user identity](https://
|
|
317
|
+
* 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.
|
|
318
318
|
*/
|
|
319
319
|
| {
|
|
320
320
|
/**
|
|
@@ -4,7 +4,7 @@
|
|
|
4
4
|
*/
|
|
5
5
|
|
|
6
6
|
/**
|
|
7
|
-
* Represents an [unmanaged device](https://
|
|
7
|
+
* 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).
|
|
8
8
|
*/
|
|
9
9
|
export type UnmanagedDevice = {
|
|
10
10
|
/**
|
|
@@ -88,7 +88,7 @@ export type UnmanagedDevice = {
|
|
|
88
88
|
*/
|
|
89
89
|
can_unlock_with_code?: boolean | undefined
|
|
90
90
|
/**
|
|
91
|
-
* 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://
|
|
91
|
+
* 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).
|
|
92
92
|
*/
|
|
93
93
|
capabilities_supported: Array<
|
|
94
94
|
| 'access_code'
|
|
@@ -110,7 +110,7 @@ export type UnmanagedDevice = {
|
|
|
110
110
|
created_at: string
|
|
111
111
|
|
|
112
112
|
/**
|
|
113
|
-
* Set of key:value pairs. Adding custom metadata to a resource, such as a [Connect Webview](https://
|
|
113
|
+
* 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.
|
|
114
114
|
*/
|
|
115
115
|
custom_metadata: Record<string, string | boolean>
|
|
116
116
|
|
|
@@ -166,6 +166,7 @@ export type UnmanagedDevice = {
|
|
|
166
166
|
| 'ios_phone'
|
|
167
167
|
| 'android_phone'
|
|
168
168
|
| 'ring_camera'
|
|
169
|
+
| 'tapo_camera'
|
|
169
170
|
|
|
170
171
|
/**
|
|
171
172
|
* 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.
|
|
@@ -191,7 +192,7 @@ export type UnmanagedDevice = {
|
|
|
191
192
|
error_code: 'account_disconnected'
|
|
192
193
|
|
|
193
194
|
/**
|
|
194
|
-
* Indicates that the error is a [connected account](https://
|
|
195
|
+
* Indicates that the error is a [connected account](https://www.seam.co/docs/api/connected_accounts/object) error.
|
|
195
196
|
*/
|
|
196
197
|
is_connected_account_error: true
|
|
197
198
|
|
|
@@ -219,7 +220,7 @@ export type UnmanagedDevice = {
|
|
|
219
220
|
error_code: 'salto_ks_subscription_limit_exceeded'
|
|
220
221
|
|
|
221
222
|
/**
|
|
222
|
-
* Indicates that the error is a [connected account](https://
|
|
223
|
+
* Indicates that the error is a [connected account](https://www.seam.co/docs/api/connected_accounts/object) error.
|
|
223
224
|
*/
|
|
224
225
|
is_connected_account_error: true
|
|
225
226
|
|
|
@@ -247,7 +248,7 @@ export type UnmanagedDevice = {
|
|
|
247
248
|
error_code: 'insufficient_permissions'
|
|
248
249
|
|
|
249
250
|
/**
|
|
250
|
-
* Indicates that the error is a [connected account](https://
|
|
251
|
+
* Indicates that the error is a [connected account](https://www.seam.co/docs/api/connected_accounts/object) error.
|
|
251
252
|
*/
|
|
252
253
|
is_connected_account_error: true
|
|
253
254
|
|
|
@@ -275,7 +276,7 @@ export type UnmanagedDevice = {
|
|
|
275
276
|
error_code: 'dormakaba_sites_disconnected'
|
|
276
277
|
|
|
277
278
|
/**
|
|
278
|
-
* Indicates that the error is a [connected account](https://
|
|
279
|
+
* Indicates that the error is a [connected account](https://www.seam.co/docs/api/connected_accounts/object) error.
|
|
279
280
|
*/
|
|
280
281
|
is_connected_account_error: true
|
|
281
282
|
|
|
@@ -381,7 +382,7 @@ export type UnmanagedDevice = {
|
|
|
381
382
|
*/
|
|
382
383
|
message: string
|
|
383
384
|
} /**
|
|
384
|
-
* Indicates that the [backup access code pool](https://
|
|
385
|
+
* Indicates that the [backup access code pool](https://www.seam.co/docs/low-level-apis/smart-locks/access-codes/backup-access-codes) is empty.
|
|
385
386
|
*/
|
|
386
387
|
| {
|
|
387
388
|
/**
|
|
@@ -496,7 +497,7 @@ export type UnmanagedDevice = {
|
|
|
496
497
|
*/
|
|
497
498
|
message: string
|
|
498
499
|
} /**
|
|
499
|
-
* Indicates that the Seam API cannot communicate with [Seam Bridge](https://
|
|
500
|
+
* 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).
|
|
500
501
|
*/
|
|
501
502
|
| {
|
|
502
503
|
/**
|
|
@@ -510,7 +511,7 @@ export type UnmanagedDevice = {
|
|
|
510
511
|
error_code: 'bridge_disconnected'
|
|
511
512
|
|
|
512
513
|
/**
|
|
513
|
-
* Indicates whether the error is related to [Seam Bridge](https://
|
|
514
|
+
* Indicates whether the error is related to [Seam Bridge](https://www.seam.co/docs/capability-guides/seam-bridge).
|
|
514
515
|
*/
|
|
515
516
|
is_bridge_error?: boolean | undefined
|
|
516
517
|
/**
|
|
@@ -4,7 +4,7 @@
|
|
|
4
4
|
*/
|
|
5
5
|
|
|
6
6
|
/**
|
|
7
|
-
* Represents a [user identity](https://
|
|
7
|
+
* 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.
|
|
8
8
|
*/
|
|
9
9
|
export type UserIdentity = {
|
|
10
10
|
/**
|
|
@@ -4,19 +4,19 @@
|
|
|
4
4
|
*/
|
|
5
5
|
|
|
6
6
|
/**
|
|
7
|
-
* Represents a [webhook](https://
|
|
7
|
+
* 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.
|
|
8
8
|
*/
|
|
9
9
|
export type Webhook = {
|
|
10
10
|
/**
|
|
11
|
-
* Types of events that the [webhook](https://
|
|
11
|
+
* Types of events that the [webhook](https://www.seam.co/docs/developer-tools/webhooks) should receive.
|
|
12
12
|
*/
|
|
13
13
|
event_types?: Array<string> | undefined
|
|
14
14
|
/**
|
|
15
|
-
* Secret associated with the [webhook](https://
|
|
15
|
+
* Secret associated with the [webhook](https://www.seam.co/docs/developer-tools/webhooks).
|
|
16
16
|
*/
|
|
17
17
|
secret?: string | undefined
|
|
18
18
|
/**
|
|
19
|
-
* URL for the [webhook](https://
|
|
19
|
+
* URL for the [webhook](https://www.seam.co/docs/developer-tools/webhooks).
|
|
20
20
|
*/
|
|
21
21
|
url: string
|
|
22
22
|
|
|
@@ -4,39 +4,39 @@
|
|
|
4
4
|
*/
|
|
5
5
|
|
|
6
6
|
/**
|
|
7
|
-
* Represents a Seam [workspace](https://
|
|
7
|
+
* 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).
|
|
8
8
|
*/
|
|
9
9
|
export type Workspace = {
|
|
10
10
|
/**
|
|
11
|
-
* Company name associated with the [workspace](https://
|
|
11
|
+
* Company name associated with the [workspace](https://www.seam.co/docs/core-concepts/workspaces).
|
|
12
12
|
* @deprecated Use `connect_partner_name` instead.
|
|
13
13
|
*/
|
|
14
14
|
company_name: string
|
|
15
15
|
|
|
16
16
|
/**
|
|
17
|
-
* Seam Connect partner name associated with the [workspace](https://
|
|
17
|
+
* Seam Connect partner name associated with the [workspace](https://www.seam.co/docs/core-concepts/workspaces).
|
|
18
18
|
*/
|
|
19
19
|
connect_partner_name: string | null
|
|
20
20
|
|
|
21
21
|
connect_webview_customization: {
|
|
22
22
|
/**
|
|
23
|
-
* URL of the inviter logo for [Connect Webviews](https://
|
|
23
|
+
* 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).
|
|
24
24
|
*/
|
|
25
25
|
inviter_logo_url?: string | undefined
|
|
26
26
|
/**
|
|
27
|
-
* Logo shape for [Connect Webviews](https://
|
|
27
|
+
* 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).
|
|
28
28
|
*/
|
|
29
29
|
logo_shape?: 'circle' | 'square' | undefined
|
|
30
30
|
/**
|
|
31
|
-
* Primary button color for [Connect Webviews](https://
|
|
31
|
+
* 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).
|
|
32
32
|
*/
|
|
33
33
|
primary_button_color?: string | undefined
|
|
34
34
|
/**
|
|
35
|
-
* Primary button text color for [Connect Webviews](https://
|
|
35
|
+
* 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).
|
|
36
36
|
*/
|
|
37
37
|
primary_button_text_color?: string | undefined
|
|
38
38
|
/**
|
|
39
|
-
* Success message for [Connect Webviews](https://
|
|
39
|
+
* 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).
|
|
40
40
|
*/
|
|
41
41
|
success_message?: string | undefined
|
|
42
42
|
}
|
|
@@ -47,17 +47,17 @@ export type Workspace = {
|
|
|
47
47
|
is_publishable_key_auth_enabled: boolean
|
|
48
48
|
|
|
49
49
|
/**
|
|
50
|
-
* Indicates whether the workspace is a [sandbox workspace](https://
|
|
50
|
+
* Indicates whether the workspace is a [sandbox workspace](https://www.seam.co/docs/core-concepts/workspaces#sandbox-workspaces).
|
|
51
51
|
*/
|
|
52
52
|
is_sandbox: boolean
|
|
53
53
|
|
|
54
54
|
/**
|
|
55
|
-
* Indicates whether the [sandbox workspace](https://
|
|
55
|
+
* 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.
|
|
56
56
|
*/
|
|
57
57
|
is_suspended: boolean
|
|
58
58
|
|
|
59
59
|
/**
|
|
60
|
-
* Name of the [workspace](https://
|
|
60
|
+
* Name of the [workspace](https://www.seam.co/docs/core-concepts/workspaces).
|
|
61
61
|
*/
|
|
62
62
|
name: string
|
|
63
63
|
|
|
@@ -66,7 +66,7 @@ export type Workspace = {
|
|
|
66
66
|
*/
|
|
67
67
|
organization_id: string | null
|
|
68
68
|
/**
|
|
69
|
-
* Publishable key for the [workspace](https://
|
|
69
|
+
* 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.
|
|
70
70
|
*/
|
|
71
71
|
publishable_key?: string | undefined
|
|
72
72
|
/**
|