@seamapi/types 1.1077.0 → 1.1078.1
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/seam/connect/models/access-codes/managed-access-code.d.ts +16 -16
- package/lib/seam/connect/models/access-codes/managed-access-code.js +13 -13
- package/lib/seam/connect/models/access-codes/managed-access-code.js.map +1 -1
- package/lib/seam/connect/models/access-codes/unmanaged-access-code.d.ts +5 -5
- package/lib/seam/connect/models/access-codes/unmanaged-access-code.js +2 -2
- package/lib/seam/connect/models/access-grants/access-grant.js +5 -5
- package/lib/seam/connect/models/access-grants/access-grant.js.map +1 -1
- package/lib/seam/connect/models/access-grants/access-method.js +11 -11
- package/lib/seam/connect/models/access-grants/access-method.js.map +1 -1
- package/lib/seam/connect/models/acs/acs-access-group.js +3 -3
- package/lib/seam/connect/models/acs/acs-credential-provisioning-automation.js +3 -3
- package/lib/seam/connect/models/acs/acs-credential-provisioning-automation.js.map +1 -1
- package/lib/seam/connect/models/acs/acs-credential.js +54 -54
- package/lib/seam/connect/models/acs/acs-credential.js.map +1 -1
- package/lib/seam/connect/models/acs/acs-encoder.js +11 -11
- package/lib/seam/connect/models/acs/acs-encoder.js.map +1 -1
- package/lib/seam/connect/models/acs/acs-entrance.js +21 -21
- package/lib/seam/connect/models/acs/acs-entrance.js.map +1 -1
- package/lib/seam/connect/models/acs/acs-system.js +39 -39
- package/lib/seam/connect/models/acs/acs-system.js.map +1 -1
- package/lib/seam/connect/models/acs/acs-users/acs-user.js +38 -38
- package/lib/seam/connect/models/acs/acs-users/acs-user.js.map +1 -1
- package/lib/seam/connect/models/action-attempts/action-attempt.js +1 -1
- package/lib/seam/connect/models/bridges/bridge-client-session.js +1 -1
- package/lib/seam/connect/models/bridges/bridge-connected-system.js +4 -4
- package/lib/seam/connect/models/bridges/bridge-connected-system.js.map +1 -1
- package/lib/seam/connect/models/bridges/bridge.js +1 -1
- package/lib/seam/connect/models/client-sessions/client-session.js +12 -12
- package/lib/seam/connect/models/client-sessions/client-session.js.map +1 -1
- package/lib/seam/connect/models/connect-webviews/connect-webview.js +5 -5
- package/lib/seam/connect/models/connect-webviews/connect-webview.js.map +1 -1
- package/lib/seam/connect/models/connected-accounts/connected-account.js +4 -4
- package/lib/seam/connect/models/connected-accounts/connected-account.js.map +1 -1
- package/lib/seam/connect/models/custom-metadata.js +2 -2
- package/lib/seam/connect/models/custom-metadata.js.map +1 -1
- package/lib/seam/connect/models/devices/capabilities-supported.js +1 -1
- package/lib/seam/connect/models/devices/capability-properties/access-code.js +2 -2
- package/lib/seam/connect/models/devices/capability-properties/access-code.js.map +1 -1
- package/lib/seam/connect/models/devices/capability-properties/thermostat.js +21 -21
- package/lib/seam/connect/models/devices/device.js +8 -8
- package/lib/seam/connect/models/devices/device.js.map +1 -1
- package/lib/seam/connect/models/devices/phone.js +1 -1
- package/lib/seam/connect/models/devices/unmanaged-device.js +1 -1
- package/lib/seam/connect/models/events/access-codes.d.ts +8 -8
- package/lib/seam/connect/models/events/access-codes.js +29 -29
- package/lib/seam/connect/models/events/access-grants.js +1 -1
- package/lib/seam/connect/models/events/access-grants.js.map +1 -1
- package/lib/seam/connect/models/events/acs/credentials.js +4 -4
- package/lib/seam/connect/models/events/acs/encoders.js +2 -2
- package/lib/seam/connect/models/events/acs/entrances.js +2 -2
- package/lib/seam/connect/models/events/acs/systems.js +3 -3
- package/lib/seam/connect/models/events/acs/users.js +2 -2
- package/lib/seam/connect/models/events/devices.js +17 -17
- package/lib/seam/connect/models/events/devices.js.map +1 -1
- package/lib/seam/connect/models/events/enrollment-automations.js +1 -1
- package/lib/seam/connect/models/events/seam-event.d.ts +4 -4
- package/lib/seam/connect/models/noise-sensors/noise-threshold.js +2 -2
- package/lib/seam/connect/models/noise-sensors/noise-threshold.js.map +1 -1
- package/lib/seam/connect/models/thermostats/climate-preset.js +13 -13
- package/lib/seam/connect/models/thermostats/climate-preset.js.map +1 -1
- package/lib/seam/connect/models/thermostats/thermostat-program.js +1 -1
- package/lib/seam/connect/models/thermostats/thermostat-program.js.map +1 -1
- package/lib/seam/connect/models/thermostats/thermostat-schedule.js +11 -11
- package/lib/seam/connect/models/thermostats/thermostat-schedule.js.map +1 -1
- package/lib/seam/connect/models/user-identities/user-identity.js +1 -1
- package/lib/seam/connect/models/webhooks/webhook.js +4 -4
- package/lib/seam/connect/models/webhooks/webhook.js.map +1 -1
- package/lib/seam/connect/models/workspaces/workspace.js +12 -12
- package/lib/seam/connect/models/workspaces/workspace.js.map +1 -1
- package/lib/seam/connect/openapi.js +1074 -1074
- package/lib/seam/connect/openapi.js.map +1 -1
- package/lib/seam/connect/route-types.d.ts +8191 -8191
- package/package.json +1 -1
- package/src/lib/seam/connect/models/access-codes/managed-access-code.ts +13 -13
- package/src/lib/seam/connect/models/access-codes/unmanaged-access-code.ts +2 -2
- package/src/lib/seam/connect/models/access-grants/access-grant.ts +5 -5
- package/src/lib/seam/connect/models/access-grants/access-method.ts +11 -11
- package/src/lib/seam/connect/models/acs/acs-access-group.ts +3 -3
- package/src/lib/seam/connect/models/acs/acs-credential-provisioning-automation.ts +3 -3
- package/src/lib/seam/connect/models/acs/acs-credential.ts +54 -54
- package/src/lib/seam/connect/models/acs/acs-encoder.ts +11 -11
- package/src/lib/seam/connect/models/acs/acs-entrance.ts +21 -21
- package/src/lib/seam/connect/models/acs/acs-system.ts +39 -39
- package/src/lib/seam/connect/models/acs/acs-users/acs-user.ts +38 -38
- package/src/lib/seam/connect/models/action-attempts/action-attempt.ts +1 -1
- package/src/lib/seam/connect/models/bridges/bridge-client-session.ts +1 -1
- package/src/lib/seam/connect/models/bridges/bridge-connected-system.ts +4 -4
- package/src/lib/seam/connect/models/bridges/bridge.ts +1 -1
- package/src/lib/seam/connect/models/client-sessions/client-session.ts +12 -12
- package/src/lib/seam/connect/models/connect-webviews/connect-webview.ts +5 -5
- package/src/lib/seam/connect/models/connected-accounts/connected-account.ts +4 -4
- package/src/lib/seam/connect/models/custom-metadata.ts +2 -2
- package/src/lib/seam/connect/models/devices/capabilities-supported.ts +1 -1
- package/src/lib/seam/connect/models/devices/capability-properties/access-code.ts +2 -2
- package/src/lib/seam/connect/models/devices/capability-properties/thermostat.ts +21 -21
- package/src/lib/seam/connect/models/devices/device.ts +8 -8
- package/src/lib/seam/connect/models/devices/phone.ts +1 -1
- package/src/lib/seam/connect/models/devices/unmanaged-device.ts +1 -1
- package/src/lib/seam/connect/models/events/access-codes.ts +31 -31
- package/src/lib/seam/connect/models/events/access-grants.ts +1 -1
- package/src/lib/seam/connect/models/events/acs/credentials.ts +4 -4
- package/src/lib/seam/connect/models/events/acs/encoders.ts +2 -2
- package/src/lib/seam/connect/models/events/acs/entrances.ts +2 -2
- package/src/lib/seam/connect/models/events/acs/systems.ts +3 -3
- package/src/lib/seam/connect/models/events/acs/users.ts +2 -2
- package/src/lib/seam/connect/models/events/devices.ts +17 -17
- package/src/lib/seam/connect/models/events/enrollment-automations.ts +1 -1
- package/src/lib/seam/connect/models/noise-sensors/noise-threshold.ts +2 -2
- package/src/lib/seam/connect/models/thermostats/climate-preset.ts +13 -13
- package/src/lib/seam/connect/models/thermostats/thermostat-program.ts +1 -1
- package/src/lib/seam/connect/models/thermostats/thermostat-schedule.ts +11 -11
- package/src/lib/seam/connect/models/user-identities/user-identity.ts +1 -1
- package/src/lib/seam/connect/models/webhooks/webhook.ts +4 -4
- package/src/lib/seam/connect/models/workspaces/workspace.ts +12 -12
- package/src/lib/seam/connect/openapi.ts +1074 -1074
- package/src/lib/seam/connect/route-types.ts +8191 -8191
|
@@ -9,61 +9,61 @@ export const client_session = z.object({
|
|
|
9
9
|
.uuid()
|
|
10
10
|
.describe('ID of the workspace associated with the client session.'),
|
|
11
11
|
created_at: datetime.describe(
|
|
12
|
-
'Date and time at which the [client session](https://
|
|
12
|
+
'Date and time at which the [client session](https://www.seam.co/docs/core-concepts/authentication/client-session-tokens) was created.',
|
|
13
13
|
),
|
|
14
14
|
expires_at: datetime.describe(
|
|
15
|
-
'Date and time at which the [client session](https://
|
|
15
|
+
'Date and time at which the [client session](https://www.seam.co/docs/core-concepts/authentication/client-session-tokens) expires.',
|
|
16
16
|
),
|
|
17
17
|
token: z
|
|
18
18
|
.string()
|
|
19
19
|
.describe(
|
|
20
|
-
'Client session token associated with the [client session](https://
|
|
20
|
+
'Client session token associated with the [client session](https://www.seam.co/docs/core-concepts/authentication/client-session-tokens).',
|
|
21
21
|
),
|
|
22
22
|
user_identifier_key: z
|
|
23
23
|
.string()
|
|
24
24
|
.nullable()
|
|
25
25
|
.describe(
|
|
26
|
-
'Your user ID for the user associated with the [client session](https://
|
|
26
|
+
'Your user ID for the user associated with the [client session](https://www.seam.co/docs/core-concepts/authentication/client-session-tokens).',
|
|
27
27
|
),
|
|
28
28
|
device_count: z
|
|
29
29
|
.number()
|
|
30
30
|
.describe(
|
|
31
|
-
'Number of devices associated with the [client session](https://
|
|
31
|
+
'Number of devices associated with the [client session](https://www.seam.co/docs/core-concepts/authentication/client-session-tokens).',
|
|
32
32
|
),
|
|
33
33
|
customer_key: z
|
|
34
34
|
.string()
|
|
35
35
|
.optional()
|
|
36
36
|
.describe(
|
|
37
|
-
'Customer key associated with the [client session](https://
|
|
37
|
+
'Customer key associated with the [client session](https://www.seam.co/docs/core-concepts/authentication/client-session-tokens).',
|
|
38
38
|
),
|
|
39
39
|
connected_account_ids: z
|
|
40
40
|
.array(z.string().uuid())
|
|
41
41
|
.describe(
|
|
42
|
-
'IDs of the [connected accounts](https://
|
|
42
|
+
'IDs of the [connected accounts](https://www.seam.co/docs/core-concepts/connected-accounts) associated with the [client session](https://www.seam.co/docs/core-concepts/authentication/client-session-tokens).',
|
|
43
43
|
),
|
|
44
44
|
connect_webview_ids: z
|
|
45
45
|
.array(z.string().uuid())
|
|
46
46
|
.describe(
|
|
47
|
-
'IDs of the [Connect Webviews](https://
|
|
47
|
+
'IDs of the [Connect Webviews](https://www.seam.co/docs/core-concepts/connect-webviews) associated with the [client session](https://www.seam.co/docs/core-concepts/authentication/client-session-tokens).',
|
|
48
48
|
),
|
|
49
49
|
user_identity_ids: z.array(z.string().uuid()).describe(`
|
|
50
50
|
---
|
|
51
51
|
deprecated: Use \`user_identity_id\` instead.
|
|
52
52
|
---
|
|
53
|
-
IDs of the [user identities](https://
|
|
53
|
+
IDs of the [user identities](https://www.seam.co/docs/capability-guides/mobile-access/managing-mobile-app-user-accounts-with-user-identities#what-is-a-user-identity) associated with the client session.
|
|
54
54
|
`),
|
|
55
55
|
user_identity_id: z
|
|
56
56
|
.string()
|
|
57
57
|
.uuid()
|
|
58
58
|
.optional()
|
|
59
59
|
.describe(
|
|
60
|
-
'ID of the [user identity](https://
|
|
60
|
+
'ID of the [user identity](https://www.seam.co/docs/capability-guides/mobile-access/managing-mobile-app-user-accounts-with-user-identities#what-is-a-user-identity) associated with the client session.',
|
|
61
61
|
),
|
|
62
62
|
}).describe(`
|
|
63
63
|
---
|
|
64
64
|
route_path: /client_sessions
|
|
65
65
|
---
|
|
66
|
-
Represents a [client session](https://
|
|
66
|
+
Represents a [client session](https://www.seam.co/docs/core-concepts/authentication/client-session-tokens). If you want to restrict your users' access to their own devices, use client sessions.
|
|
67
67
|
|
|
68
68
|
You create each client session with a custom \`user_identifier_key\`. Normally, the \`user_identifier_key\` is a user ID that your application provides.
|
|
69
69
|
|
|
@@ -71,7 +71,7 @@ export const client_session = z.object({
|
|
|
71
71
|
|
|
72
72
|
A client session has a token that you can use with the Seam JavaScript SDK to make requests from the client (browser) directly to the Seam API. The token restricts the user's access to only the devices that they own.
|
|
73
73
|
|
|
74
|
-
See also [Get Started with React](https://
|
|
74
|
+
See also [Get Started with React](https://www.seam.co/docs/ui-components/overview/getting-started-with-seam-components/get-started-with-react-components-and-client-session-tokens).
|
|
75
75
|
`)
|
|
76
76
|
|
|
77
77
|
export type ClientSession = z.infer<typeof client_session>
|
|
@@ -40,7 +40,7 @@ export const connect_webview = z.object({
|
|
|
40
40
|
accepted_providers: z
|
|
41
41
|
.array(z.string())
|
|
42
42
|
.describe(
|
|
43
|
-
'List of accepted [provider keys](https://
|
|
43
|
+
'List of accepted [provider keys](https://www.seam.co/docs/core-concepts/connect-webviews/customizing-connect-webviews#customize-the-brands-to-display-in-your-connect-webviews).',
|
|
44
44
|
),
|
|
45
45
|
|
|
46
46
|
accepted_capabilities: z
|
|
@@ -97,12 +97,12 @@ export const connect_webview = z.object({
|
|
|
97
97
|
automatically_manage_new_devices: z
|
|
98
98
|
.boolean()
|
|
99
99
|
.describe(
|
|
100
|
-
'Indicates whether Seam should [import all new devices](https://
|
|
100
|
+
'Indicates whether Seam should [import all new devices](https://www.seam.co/docs/core-concepts/connect-webviews/customizing-connect-webviews#automatically_manage_new_devices) for the connected account to make these devices available for use and management by the Seam API.',
|
|
101
101
|
),
|
|
102
102
|
wait_for_device_creation: z
|
|
103
103
|
.boolean()
|
|
104
104
|
.describe(
|
|
105
|
-
'Indicates whether Seam should [finish syncing all devices](https://
|
|
105
|
+
'Indicates whether Seam should [finish syncing all devices](https://www.seam.co/docs/core-concepts/connect-webviews/customizing-connect-webviews#wait_for_device_creation) in a newly-connected account before completing the associated Connect Webview.',
|
|
106
106
|
),
|
|
107
107
|
authorized_at: datetime
|
|
108
108
|
.nullable()
|
|
@@ -113,7 +113,7 @@ export const connect_webview = z.object({
|
|
|
113
113
|
.string()
|
|
114
114
|
.nullable()
|
|
115
115
|
.describe(
|
|
116
|
-
'Selected provider of the Connect Webview, one of the [provider keys](https://
|
|
116
|
+
'Selected provider of the Connect Webview, one of the [provider keys](https://www.seam.co/docs/core-concepts/connect-webviews/customizing-connect-webviews#customize-the-brands-to-display-in-your-connect-webviews).',
|
|
117
117
|
),
|
|
118
118
|
customer_key: z
|
|
119
119
|
.string()
|
|
@@ -123,7 +123,7 @@ export const connect_webview = z.object({
|
|
|
123
123
|
---
|
|
124
124
|
route_path: /connect_webviews
|
|
125
125
|
---
|
|
126
|
-
Represents a [Connect Webview](https://
|
|
126
|
+
Represents a [Connect Webview](https://www.seam.co/docs/core-concepts/connect-webviews).
|
|
127
127
|
|
|
128
128
|
Connect Webviews are fully-embedded client-side components that you add to your app. Your users interact with your embedded Connect Webviews to link their IoT device or system accounts to Seam. That is, Connect Webviews walk your users through the process of logging in to their device or system accounts. Seam handles all the authentication steps, and—once your user has completed the authorization through your app—you can access and control their devices or systems using the Seam API.
|
|
129
129
|
|
|
@@ -23,7 +23,7 @@ const common_connected_account_error = z.object({
|
|
|
23
23
|
.boolean()
|
|
24
24
|
.optional()
|
|
25
25
|
.describe(
|
|
26
|
-
'Indicates whether the error is related to [Seam Bridge](https://
|
|
26
|
+
'Indicates whether the error is related to [Seam Bridge](https://www.seam.co/docs/capability-guides/seam-bridge).',
|
|
27
27
|
),
|
|
28
28
|
})
|
|
29
29
|
|
|
@@ -61,7 +61,7 @@ export const bridge_disconnected = common_connected_account_error.extend({
|
|
|
61
61
|
---
|
|
62
62
|
resource_type: connected_account
|
|
63
63
|
---
|
|
64
|
-
Indicates that the Seam API cannot communicate with [Seam Bridge](https://
|
|
64
|
+
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).
|
|
65
65
|
`)
|
|
66
66
|
|
|
67
67
|
export const salto_ks_subscription_limit_exceeded =
|
|
@@ -396,7 +396,7 @@ export const connected_account = z.object({
|
|
|
396
396
|
automatically_manage_new_devices: z
|
|
397
397
|
.boolean()
|
|
398
398
|
.describe(
|
|
399
|
-
'Indicates whether Seam should [import all new devices](https://
|
|
399
|
+
'Indicates whether Seam should [import all new devices](https://www.seam.co/docs/core-concepts/connect-webviews/customizing-connect-webviews#automatically_manage_new_devices) for the connected account to make these devices available for management by the Seam API.',
|
|
400
400
|
),
|
|
401
401
|
customer_key: z
|
|
402
402
|
.string()
|
|
@@ -443,7 +443,7 @@ export const connected_account = z.object({
|
|
|
443
443
|
---
|
|
444
444
|
route_path: /connected_accounts
|
|
445
445
|
---
|
|
446
|
-
Represents a [connected account](https://
|
|
446
|
+
Represents a [connected account](https://www.seam.co/docs/core-concepts/connected-accounts). A connected account is an external third-party account to which your user has authorized Seam to get access, for example, an August account with a list of door locks.
|
|
447
447
|
`)
|
|
448
448
|
|
|
449
449
|
export type ConnectedAccount = z.infer<typeof connected_account>
|
|
@@ -24,7 +24,7 @@ export const custom_metadata_input = z
|
|
|
24
24
|
message: 'Custom metadata is limited to a maximum of 50 keys',
|
|
25
25
|
})
|
|
26
26
|
.describe(
|
|
27
|
-
'Set of up to 50 key:value pairs, with key names up to 40 characters long that cannot contain a period (.). Accepts string or Boolean values. Strings are limited to 500 characters. Adding custom metadata to a resource, such as a [Connect Webview](https://
|
|
27
|
+
'Set of up to 50 key:value pairs, with key names up to 40 characters long that cannot contain a period (.). Accepts string or Boolean values. Strings are limited to 500 characters. 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. Set a key to `null` or to an empty string to remove that key from the custom metadata.',
|
|
28
28
|
)
|
|
29
29
|
|
|
30
30
|
export const custom_metadata_has = z
|
|
@@ -43,7 +43,7 @@ export const custom_metadata_has = z
|
|
|
43
43
|
export const custom_metadata = z
|
|
44
44
|
.record(z.string(), z.union([z.string(), z.boolean()]))
|
|
45
45
|
.describe(
|
|
46
|
-
'Set of key:value pairs. Adding custom metadata to a resource, such as a [Connect Webview](https://
|
|
46
|
+
'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.',
|
|
47
47
|
)
|
|
48
48
|
|
|
49
49
|
export type CustomMetadata = z.output<typeof custom_metadata>
|
|
@@ -8,7 +8,7 @@ export const capabilities = z.enum([
|
|
|
8
8
|
'battery',
|
|
9
9
|
'phone',
|
|
10
10
|
]).describe(`
|
|
11
|
-
Collection of capabilities that the device supports when connected to Seam. **Important:** Superseded by [capability flags](https://
|
|
11
|
+
Collection of capabilities that the device supports when connected to Seam. **Important:** Superseded by [capability flags](https://www.seam.co/docs/capability-guides/device-and-system-capabilities#capability-flags).
|
|
12
12
|
`)
|
|
13
13
|
|
|
14
14
|
export type Capabilities = z.infer<typeof capabilities>
|
|
@@ -145,12 +145,12 @@ export const access_code_capability_properties = z.object({
|
|
|
145
145
|
---
|
|
146
146
|
property_group_key: access_codes
|
|
147
147
|
---
|
|
148
|
-
Indicates whether the device supports a [backup access code pool](https://
|
|
148
|
+
Indicates whether the device supports a [backup access code pool](https://www.seam.co/docs/low-level-apis/smart-locks/access-codes/backup-access-codes).`),
|
|
149
149
|
backup_access_code_pool_enabled: z.boolean().optional().describe(`
|
|
150
150
|
---
|
|
151
151
|
property_group_key: access_codes
|
|
152
152
|
---
|
|
153
|
-
Indicates whether the [backup access code pool](https://
|
|
153
|
+
Indicates whether the [backup access code pool](https://www.seam.co/docs/low-level-apis/smart-locks/access-codes/backup-access-codes) is currently enabled for the device. To disable it, set this to \`false\` using [/devices/update](https://www.seam.co/docs/api/devices/update).`),
|
|
154
154
|
has_native_entry_events: z.boolean().optional().describe(`
|
|
155
155
|
---
|
|
156
156
|
property_group_key: access_codes
|
|
@@ -98,121 +98,121 @@ export const thermostat_capability_properties = z
|
|
|
98
98
|
---
|
|
99
99
|
property_group_key: thermostats
|
|
100
100
|
---
|
|
101
|
-
Available [climate presets](https://
|
|
101
|
+
Available [climate presets](https://www.seam.co/docs/capability-guides/thermostats/creating-and-managing-climate-presets) for the thermostat.
|
|
102
102
|
`),
|
|
103
103
|
fallback_climate_preset_key: z.string().min(1).nullable().describe(`
|
|
104
104
|
---
|
|
105
105
|
property_group_key: thermostats
|
|
106
106
|
---
|
|
107
|
-
Key of the [fallback climate preset](https://
|
|
107
|
+
Key of the [fallback climate preset](https://www.seam.co/docs/capability-guides/thermostats/creating-and-managing-climate-presets/setting-the-fallback-climate-preset) for the thermostat.
|
|
108
108
|
`),
|
|
109
109
|
active_thermostat_schedule: thermostat_schedule.nullable().describe(`
|
|
110
110
|
---
|
|
111
111
|
property_group_key: thermostats
|
|
112
112
|
deprecated: Use \`active_thermostat_schedule_id\` with \`/thermostats/schedules/get\` instead.
|
|
113
113
|
---
|
|
114
|
-
Active [thermostat schedule](https://
|
|
114
|
+
Active [thermostat schedule](https://www.seam.co/docs/capability-guides/thermostats/creating-and-managing-thermostat-schedules).
|
|
115
115
|
`),
|
|
116
116
|
active_thermostat_schedule_id: z.string().uuid().nullable().describe(`
|
|
117
117
|
---
|
|
118
118
|
property_group_key: thermostats
|
|
119
119
|
---
|
|
120
|
-
ID of the active [thermostat schedule](https://
|
|
120
|
+
ID of the active [thermostat schedule](https://www.seam.co/docs/capability-guides/thermostats/creating-and-managing-thermostat-schedules).
|
|
121
121
|
`),
|
|
122
122
|
thermostat_daily_programs: z.array(thermostat_daily_program).optional()
|
|
123
123
|
.describe(`
|
|
124
124
|
---
|
|
125
125
|
property_group_key: thermostats
|
|
126
126
|
---
|
|
127
|
-
Configured [daily programs](https://
|
|
127
|
+
Configured [daily programs](https://www.seam.co/docs/capability-guides/thermostats/creating-and-managing-thermostat-programs) for the thermostat.
|
|
128
128
|
`),
|
|
129
129
|
thermostat_weekly_program: thermostat_weekly_program.nullable().optional()
|
|
130
130
|
.describe(`
|
|
131
131
|
---
|
|
132
132
|
property_group_key: thermostats
|
|
133
133
|
---
|
|
134
|
-
Current [weekly program](https://
|
|
134
|
+
Current [weekly program](https://www.seam.co/docs/capability-guides/thermostats/creating-and-managing-thermostat-programs) for the thermostat.
|
|
135
135
|
`),
|
|
136
136
|
min_cooling_set_point_celsius: z.number().describe(`
|
|
137
137
|
---
|
|
138
138
|
property_group_key: thermostats
|
|
139
139
|
---
|
|
140
|
-
Minimum [cooling set point](https://
|
|
140
|
+
Minimum [cooling set point](https://www.seam.co/docs/capability-guides/thermostats/understanding-thermostat-concepts/set-points#cooling-set-point) in °C.
|
|
141
141
|
`),
|
|
142
142
|
min_cooling_set_point_fahrenheit: z.number().describe(`
|
|
143
143
|
---
|
|
144
144
|
property_group_key: thermostats
|
|
145
145
|
---
|
|
146
|
-
Minimum [cooling set point](https://
|
|
146
|
+
Minimum [cooling set point](https://www.seam.co/docs/capability-guides/thermostats/understanding-thermostat-concepts/set-points#cooling-set-point) in °F.
|
|
147
147
|
`),
|
|
148
148
|
max_cooling_set_point_celsius: z.number().describe(`
|
|
149
149
|
---
|
|
150
150
|
property_group_key: thermostats
|
|
151
151
|
---
|
|
152
|
-
Maximum [cooling set point](https://
|
|
152
|
+
Maximum [cooling set point](https://www.seam.co/docs/capability-guides/thermostats/understanding-thermostat-concepts/set-points#cooling-set-point) in °C.
|
|
153
153
|
`),
|
|
154
154
|
max_cooling_set_point_fahrenheit: z.number().describe(`
|
|
155
155
|
---
|
|
156
156
|
property_group_key: thermostats
|
|
157
157
|
---
|
|
158
|
-
Maximum [cooling set point](https://
|
|
158
|
+
Maximum [cooling set point](https://www.seam.co/docs/capability-guides/thermostats/understanding-thermostat-concepts/set-points#cooling-set-point) in °F.
|
|
159
159
|
`),
|
|
160
160
|
min_heating_set_point_celsius: z.number().describe(`
|
|
161
161
|
---
|
|
162
162
|
property_group_key: thermostats
|
|
163
163
|
---
|
|
164
|
-
Minimum [heating set point](https://
|
|
164
|
+
Minimum [heating set point](https://www.seam.co/docs/capability-guides/thermostats/understanding-thermostat-concepts/set-points#heating-set-point) in °C.
|
|
165
165
|
`),
|
|
166
166
|
min_heating_set_point_fahrenheit: z.number().describe(`
|
|
167
167
|
---
|
|
168
168
|
property_group_key: thermostats
|
|
169
169
|
---
|
|
170
|
-
Minimum [heating set point](https://
|
|
170
|
+
Minimum [heating set point](https://www.seam.co/docs/capability-guides/thermostats/understanding-thermostat-concepts/set-points#heating-set-point) in °F.
|
|
171
171
|
`),
|
|
172
172
|
max_heating_set_point_celsius: z.number().describe(`
|
|
173
173
|
---
|
|
174
174
|
property_group_key: thermostats
|
|
175
175
|
---
|
|
176
|
-
Maximum [heating set point](https://
|
|
176
|
+
Maximum [heating set point](https://www.seam.co/docs/capability-guides/thermostats/understanding-thermostat-concepts/set-points#heating-set-point) in °C.
|
|
177
177
|
`),
|
|
178
178
|
max_heating_set_point_fahrenheit: z.number().describe(`
|
|
179
179
|
---
|
|
180
180
|
property_group_key: thermostats
|
|
181
181
|
---
|
|
182
|
-
Maximum [heating set point](https://
|
|
182
|
+
Maximum [heating set point](https://www.seam.co/docs/capability-guides/thermostats/understanding-thermostat-concepts/set-points#heating-set-point) in °F.
|
|
183
183
|
`),
|
|
184
184
|
min_heating_cooling_delta_celsius: z.number().describe(`
|
|
185
185
|
---
|
|
186
186
|
property_group_key: thermostats
|
|
187
187
|
---
|
|
188
|
-
Minimum [temperature difference](https://
|
|
188
|
+
Minimum [temperature difference](https://www.seam.co/docs/capability-guides/thermostats/understanding-thermostat-concepts/set-points#minimum-heating-cooling-temperature-delta) in °C between the cooling and heating set points when in heat-cool (auto) mode.
|
|
189
189
|
`),
|
|
190
190
|
min_heating_cooling_delta_fahrenheit: z.number().describe(`
|
|
191
191
|
---
|
|
192
192
|
property_group_key: thermostats
|
|
193
193
|
---
|
|
194
|
-
Minimum [temperature difference](https://
|
|
194
|
+
Minimum [temperature difference](https://www.seam.co/docs/capability-guides/thermostats/understanding-thermostat-concepts/set-points#minimum-heating-cooling-temperature-delta) in °F between the cooling and heating set points when in heat-cool (auto) mode.
|
|
195
195
|
`),
|
|
196
196
|
temperature_threshold: z
|
|
197
197
|
.object({
|
|
198
198
|
lower_limit_celsius: z.number().nullable()
|
|
199
|
-
.describe(`Lower limit in °C within the current [temperature threshold](https://
|
|
199
|
+
.describe(`Lower limit in °C within the current [temperature threshold](https://www.seam.co/docs/capability-guides/thermostats/setting-and-monitoring-temperature-thresholds) set for the thermostat.
|
|
200
200
|
`),
|
|
201
201
|
lower_limit_fahrenheit: z.number().nullable()
|
|
202
|
-
.describe(`Lower limit in °F within the current [temperature threshold](https://
|
|
202
|
+
.describe(`Lower limit in °F within the current [temperature threshold](https://www.seam.co/docs/capability-guides/thermostats/setting-and-monitoring-temperature-thresholds) set for the thermostat.
|
|
203
203
|
`),
|
|
204
204
|
upper_limit_celsius: z.number().nullable()
|
|
205
|
-
.describe(`Upper limit in °C within the current [temperature threshold](https://
|
|
205
|
+
.describe(`Upper limit in °C within the current [temperature threshold](https://www.seam.co/docs/capability-guides/thermostats/setting-and-monitoring-temperature-thresholds) set for the thermostat.
|
|
206
206
|
`),
|
|
207
207
|
upper_limit_fahrenheit: z.number().nullable()
|
|
208
|
-
.describe(`Upper limit in °F within the current [temperature threshold](https://
|
|
208
|
+
.describe(`Upper limit in °F within the current [temperature threshold](https://www.seam.co/docs/capability-guides/thermostats/setting-and-monitoring-temperature-thresholds) set for the thermostat.
|
|
209
209
|
`),
|
|
210
210
|
})
|
|
211
211
|
.optional().describe(`
|
|
212
212
|
---
|
|
213
213
|
property_group_key: thermostats
|
|
214
214
|
---
|
|
215
|
-
Current [temperature threshold](https://
|
|
215
|
+
Current [temperature threshold](https://www.seam.co/docs/capability-guides/thermostats/setting-and-monitoring-temperature-thresholds) set for the thermostat.
|
|
216
216
|
`),
|
|
217
217
|
thermostat_daily_program_period_precision_minutes: z.number().optional()
|
|
218
218
|
.describe(`
|
|
@@ -175,7 +175,7 @@ const account_disconnected = common_device_error.extend({
|
|
|
175
175
|
is_connected_account_error: z
|
|
176
176
|
.literal(true)
|
|
177
177
|
.describe(
|
|
178
|
-
'Indicates that the error is a [connected account](https://
|
|
178
|
+
'Indicates that the error is a [connected account](https://www.seam.co/docs/api/connected_accounts/object) error.',
|
|
179
179
|
),
|
|
180
180
|
is_device_error: z
|
|
181
181
|
.literal(false)
|
|
@@ -196,7 +196,7 @@ const empty_backup_access_code_pool = common_device_error.extend({
|
|
|
196
196
|
resource_type: device
|
|
197
197
|
variant_group_key: access_codes
|
|
198
198
|
---
|
|
199
|
-
Indicates that the [backup access code pool](https://
|
|
199
|
+
Indicates that the [backup access code pool](https://www.seam.co/docs/low-level-apis/smart-locks/access-codes/backup-access-codes) is empty.
|
|
200
200
|
`)
|
|
201
201
|
|
|
202
202
|
const august_lock_not_authorized = common_device_error.extend({
|
|
@@ -218,7 +218,7 @@ const salto_ks_subscription_limit_exceeded = common_device_error.extend({
|
|
|
218
218
|
is_connected_account_error: z
|
|
219
219
|
.literal(true)
|
|
220
220
|
.describe(
|
|
221
|
-
'Indicates that the error is a [connected account](https://
|
|
221
|
+
'Indicates that the error is a [connected account](https://www.seam.co/docs/api/connected_accounts/object) error.',
|
|
222
222
|
),
|
|
223
223
|
is_device_error: z
|
|
224
224
|
.literal(false)
|
|
@@ -238,7 +238,7 @@ const dormakaba_sites_disconnected = common_device_error.extend({
|
|
|
238
238
|
is_connected_account_error: z
|
|
239
239
|
.literal(true)
|
|
240
240
|
.describe(
|
|
241
|
-
'Indicates that the error is a [connected account](https://
|
|
241
|
+
'Indicates that the error is a [connected account](https://www.seam.co/docs/api/connected_accounts/object) error.',
|
|
242
242
|
),
|
|
243
243
|
is_device_error: z
|
|
244
244
|
.literal(false)
|
|
@@ -292,7 +292,7 @@ const insufficient_permissions = common_device_error.extend({
|
|
|
292
292
|
is_connected_account_error: z
|
|
293
293
|
.literal(true)
|
|
294
294
|
.describe(
|
|
295
|
-
'Indicates that the error is a [connected account](https://
|
|
295
|
+
'Indicates that the error is a [connected account](https://www.seam.co/docs/api/connected_accounts/object) error.',
|
|
296
296
|
),
|
|
297
297
|
is_device_error: z
|
|
298
298
|
.literal(false)
|
|
@@ -1030,7 +1030,7 @@ export const device = z
|
|
|
1030
1030
|
'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.',
|
|
1031
1031
|
),
|
|
1032
1032
|
capabilities_supported: z.array(capabilities).describe(`
|
|
1033
|
-
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://
|
|
1033
|
+
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).
|
|
1034
1034
|
`),
|
|
1035
1035
|
properties: common_device_properties
|
|
1036
1036
|
.and(phone_specific_properties.partial())
|
|
@@ -1149,7 +1149,7 @@ export const device = z
|
|
|
1149
1149
|
is_managed: z
|
|
1150
1150
|
.literal(true)
|
|
1151
1151
|
.describe(
|
|
1152
|
-
'Indicates whether Seam manages the device. See also [Managed and Unmanaged Devices](https://
|
|
1152
|
+
'Indicates whether Seam manages the device. See also [Managed and Unmanaged Devices](https://www.seam.co/docs/core-concepts/devices/managed-and-unmanaged-devices).',
|
|
1153
1153
|
),
|
|
1154
1154
|
custom_metadata,
|
|
1155
1155
|
device_provider: device_provider_info.optional().describe(`
|
|
@@ -1184,7 +1184,7 @@ export const device = z
|
|
|
1184
1184
|
provider_metadata:
|
|
1185
1185
|
name: Provider Metadata
|
|
1186
1186
|
---
|
|
1187
|
-
Represents a [device](https://
|
|
1187
|
+
Represents a [device](https://www.seam.co/docs/core-concepts/devices) that has been connected to Seam.
|
|
1188
1188
|
`)
|
|
1189
1189
|
|
|
1190
1190
|
export type Device = z.infer<typeof device>
|
|
@@ -32,7 +32,7 @@ export const phone = z.object({
|
|
|
32
32
|
.describe(`Date and time at which the phone was created.
|
|
33
33
|
`),
|
|
34
34
|
custom_metadata: basePhoneDeviceSchema.shape.custom_metadata
|
|
35
|
-
.describe(`Optional [custom metadata](https://
|
|
35
|
+
.describe(`Optional [custom metadata](https://www.seam.co/docs/core-concepts/devices/adding-custom-metadata-to-a-device) for the phone.
|
|
36
36
|
`),
|
|
37
37
|
|
|
38
38
|
errors: z
|
|
@@ -76,7 +76,7 @@ export const unmanaged_device = device
|
|
|
76
76
|
provider_metadata:
|
|
77
77
|
name: Provider Metadata
|
|
78
78
|
---
|
|
79
|
-
Represents an [unmanaged device](https://
|
|
79
|
+
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).
|
|
80
80
|
`)
|
|
81
81
|
|
|
82
82
|
export type UnmanagedDevice = z.infer<typeof unmanaged_device>
|