@seamapi/types 1.1078.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.js +9 -9
- package/lib/seam/connect/models/access-codes/managed-access-code.js.map +1 -1
- 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.js +26 -26
- 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/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 +1063 -1063
- package/lib/seam/connect/openapi.js.map +1 -1
- package/lib/seam/connect/route-types.d.ts +8167 -8167
- package/package.json +1 -1
- package/src/lib/seam/connect/models/access-codes/managed-access-code.ts +9 -9
- 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 +26 -26
- 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 +1063 -1063
- package/src/lib/seam/connect/route-types.ts +8167 -8167
|
@@ -13,7 +13,7 @@ export const thermostat_daily_program_period = z
|
|
|
13
13
|
climate_preset_key: z
|
|
14
14
|
.string()
|
|
15
15
|
.describe(
|
|
16
|
-
'Key of the [climate preset](https://
|
|
16
|
+
'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`.',
|
|
17
17
|
),
|
|
18
18
|
})
|
|
19
19
|
.describe(
|
|
@@ -7,24 +7,24 @@ export const thermostat_schedule = z.object({
|
|
|
7
7
|
.string()
|
|
8
8
|
.uuid()
|
|
9
9
|
.describe(
|
|
10
|
-
'ID of the [thermostat schedule](https://
|
|
10
|
+
'ID of the [thermostat schedule](https://www.seam.co/docs/capability-guides/thermostats/creating-and-managing-thermostat-schedules).',
|
|
11
11
|
),
|
|
12
12
|
device_id: z
|
|
13
13
|
.string()
|
|
14
14
|
.uuid()
|
|
15
15
|
.describe(
|
|
16
|
-
'ID of the desired [thermostat](https://
|
|
16
|
+
'ID of the desired [thermostat](https://www.seam.co/docs/capability-guides/thermostats) device.',
|
|
17
17
|
),
|
|
18
18
|
name: z
|
|
19
19
|
.string()
|
|
20
20
|
.nullable()
|
|
21
21
|
.describe(
|
|
22
|
-
'User-friendly name to identify the [thermostat schedule](https://
|
|
22
|
+
'User-friendly name to identify the [thermostat schedule](https://www.seam.co/docs/capability-guides/thermostats/creating-and-managing-thermostat-schedules).',
|
|
23
23
|
),
|
|
24
24
|
climate_preset_key: z
|
|
25
25
|
.string()
|
|
26
26
|
.describe(
|
|
27
|
-
'Key of the [climate preset](https://
|
|
27
|
+
'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).',
|
|
28
28
|
),
|
|
29
29
|
max_override_period_minutes: z
|
|
30
30
|
.number()
|
|
@@ -33,26 +33,26 @@ export const thermostat_schedule = z.object({
|
|
|
33
33
|
.nullable()
|
|
34
34
|
.optional()
|
|
35
35
|
.describe(
|
|
36
|
-
"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://
|
|
36
|
+
"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).",
|
|
37
37
|
),
|
|
38
38
|
starts_at: datetime.describe(
|
|
39
|
-
'Date and time at which the [thermostat schedule](https://
|
|
39
|
+
'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.',
|
|
40
40
|
),
|
|
41
41
|
is_override_allowed: z
|
|
42
42
|
.boolean()
|
|
43
43
|
.optional()
|
|
44
44
|
.describe(
|
|
45
|
-
"Indicates whether a person at the thermostat can change the thermostat's settings after the [thermostat schedule](https://
|
|
45
|
+
"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.",
|
|
46
46
|
),
|
|
47
47
|
ends_at: datetime.describe(
|
|
48
|
-
'Date and time at which the [thermostat schedule](https://
|
|
48
|
+
'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.',
|
|
49
49
|
),
|
|
50
50
|
workspace_id: z
|
|
51
51
|
.string()
|
|
52
52
|
.uuid()
|
|
53
53
|
.describe('ID of the workspace that contains the thermostat schedule.'),
|
|
54
54
|
created_at: datetime.describe(
|
|
55
|
-
'Date and time at which the [thermostat schedule](https://
|
|
55
|
+
'Date and time at which the [thermostat schedule](https://www.seam.co/docs/capability-guides/thermostats/creating-and-managing-thermostat-schedules) was created.',
|
|
56
56
|
),
|
|
57
57
|
errors: z
|
|
58
58
|
.array(
|
|
@@ -73,13 +73,13 @@ export const thermostat_schedule = z.object({
|
|
|
73
73
|
}),
|
|
74
74
|
)
|
|
75
75
|
.describe(
|
|
76
|
-
'Errors associated with the [thermostat schedule](https://
|
|
76
|
+
'Errors associated with the [thermostat schedule](https://www.seam.co/docs/capability-guides/thermostats/creating-and-managing-thermostat-schedules).',
|
|
77
77
|
),
|
|
78
78
|
}).describe(`
|
|
79
79
|
---
|
|
80
80
|
route_path: /thermostats/schedules
|
|
81
81
|
---
|
|
82
|
-
Represents a [thermostat schedule](https://
|
|
82
|
+
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.
|
|
83
83
|
`)
|
|
84
84
|
|
|
85
85
|
export type ThermostatSchedule = z.infer<typeof thermostat_schedule>
|
|
@@ -164,7 +164,7 @@ export const user_identity = z.object({
|
|
|
164
164
|
---
|
|
165
165
|
route_path: /user_identities
|
|
166
166
|
---
|
|
167
|
-
Represents a [user identity](https://
|
|
167
|
+
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.
|
|
168
168
|
`)
|
|
169
169
|
|
|
170
170
|
export type UserIdentity = z.output<typeof user_identity>
|
|
@@ -5,25 +5,25 @@ export const webhook = z.object({
|
|
|
5
5
|
url: z
|
|
6
6
|
.string()
|
|
7
7
|
.describe(
|
|
8
|
-
'URL for the [webhook](https://
|
|
8
|
+
'URL for the [webhook](https://www.seam.co/docs/developer-tools/webhooks).',
|
|
9
9
|
),
|
|
10
10
|
event_types: z
|
|
11
11
|
.array(z.string())
|
|
12
12
|
.optional()
|
|
13
13
|
.describe(
|
|
14
|
-
'Types of events that the [webhook](https://
|
|
14
|
+
'Types of events that the [webhook](https://www.seam.co/docs/developer-tools/webhooks) should receive.',
|
|
15
15
|
),
|
|
16
16
|
secret: z
|
|
17
17
|
.string()
|
|
18
18
|
.optional()
|
|
19
19
|
.describe(
|
|
20
|
-
'Secret associated with the [webhook](https://
|
|
20
|
+
'Secret associated with the [webhook](https://www.seam.co/docs/developer-tools/webhooks).',
|
|
21
21
|
),
|
|
22
22
|
}).describe(`
|
|
23
23
|
---
|
|
24
24
|
route_path: /webhooks
|
|
25
25
|
---
|
|
26
|
-
Represents a [webhook](https://
|
|
26
|
+
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.
|
|
27
27
|
`)
|
|
28
28
|
|
|
29
29
|
export type Webhook = z.infer<typeof webhook>
|
|
@@ -7,65 +7,65 @@ export const workspace = z.object({
|
|
|
7
7
|
name: z
|
|
8
8
|
.string()
|
|
9
9
|
.describe(
|
|
10
|
-
'Name of the [workspace](https://
|
|
10
|
+
'Name of the [workspace](https://www.seam.co/docs/core-concepts/workspaces).',
|
|
11
11
|
),
|
|
12
12
|
company_name: z.string().describe(`
|
|
13
13
|
---
|
|
14
14
|
deprecated: Use \`connect_partner_name\` instead.
|
|
15
15
|
---
|
|
16
|
-
Company name associated with the [workspace](https://
|
|
16
|
+
Company name associated with the [workspace](https://www.seam.co/docs/core-concepts/workspaces).
|
|
17
17
|
`),
|
|
18
18
|
is_sandbox: z
|
|
19
19
|
.boolean()
|
|
20
20
|
.describe(
|
|
21
|
-
'Indicates whether the workspace is a [sandbox workspace](https://
|
|
21
|
+
'Indicates whether the workspace is a [sandbox workspace](https://www.seam.co/docs/core-concepts/workspaces#sandbox-workspaces).',
|
|
22
22
|
),
|
|
23
23
|
connect_webview_customization: z.object({
|
|
24
24
|
primary_button_color: hex_color_code
|
|
25
25
|
.optional()
|
|
26
26
|
.describe(
|
|
27
|
-
'Primary button color for [Connect Webviews](https://
|
|
27
|
+
'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).',
|
|
28
28
|
),
|
|
29
29
|
primary_button_text_color: hex_color_code
|
|
30
30
|
.optional()
|
|
31
31
|
.describe(
|
|
32
|
-
'Primary button text color for [Connect Webviews](https://
|
|
32
|
+
'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).',
|
|
33
33
|
),
|
|
34
34
|
success_message: z
|
|
35
35
|
.string()
|
|
36
36
|
.optional()
|
|
37
37
|
.describe(
|
|
38
|
-
'Success message for [Connect Webviews](https://
|
|
38
|
+
'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).',
|
|
39
39
|
),
|
|
40
40
|
logo_shape: z
|
|
41
41
|
.enum(['circle', 'square'])
|
|
42
42
|
.optional()
|
|
43
43
|
.describe(
|
|
44
|
-
'Logo shape for [Connect Webviews](https://
|
|
44
|
+
'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).',
|
|
45
45
|
),
|
|
46
46
|
inviter_logo_url: z
|
|
47
47
|
.string()
|
|
48
48
|
.optional()
|
|
49
49
|
.describe(
|
|
50
|
-
'URL of the inviter logo for [Connect Webviews](https://
|
|
50
|
+
'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).',
|
|
51
51
|
),
|
|
52
52
|
}),
|
|
53
53
|
is_suspended: z
|
|
54
54
|
.boolean()
|
|
55
55
|
.describe(
|
|
56
|
-
'Indicates whether the [sandbox workspace](https://
|
|
56
|
+
'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.',
|
|
57
57
|
),
|
|
58
58
|
connect_partner_name: z
|
|
59
59
|
.string()
|
|
60
60
|
.nullable()
|
|
61
61
|
.describe(
|
|
62
|
-
'Seam Connect partner name associated with the [workspace](https://
|
|
62
|
+
'Seam Connect partner name associated with the [workspace](https://www.seam.co/docs/core-concepts/workspaces).',
|
|
63
63
|
),
|
|
64
64
|
publishable_key: z
|
|
65
65
|
.string()
|
|
66
66
|
.optional()
|
|
67
67
|
.describe(
|
|
68
|
-
'Publishable key for the [workspace](https://
|
|
68
|
+
'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.',
|
|
69
69
|
),
|
|
70
70
|
is_publishable_key_auth_enabled: z
|
|
71
71
|
.boolean()
|
|
@@ -83,7 +83,7 @@ export const workspace = z.object({
|
|
|
83
83
|
---
|
|
84
84
|
route_path: /workspaces
|
|
85
85
|
---
|
|
86
|
-
Represents a Seam [workspace](https://
|
|
86
|
+
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).
|
|
87
87
|
`)
|
|
88
88
|
|
|
89
89
|
export type Workspace = z.infer<typeof workspace>
|