@seamapi/types 1.1102.0 → 1.1104.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/seam/connect/models/access-grants/access-grant.d.ts +37 -21
- package/lib/seam/connect/models/access-grants/access-grant.js +4 -3
- package/lib/seam/connect/models/access-grants/access-grant.js.map +1 -1
- package/lib/seam/connect/models/acs/acs-access-group.js +2 -2
- package/lib/seam/connect/models/acs/acs-access-group.js.map +1 -1
- package/lib/seam/connect/models/acs/acs-entrance.d.ts +38 -8
- package/lib/seam/connect/models/acs/acs-entrance.js +22 -9
- package/lib/seam/connect/models/acs/acs-entrance.js.map +1 -1
- package/lib/seam/connect/models/acs/acs-users/acs-user.d.ts +75 -4
- package/lib/seam/connect/models/acs/acs-users/acs-user.js +32 -30
- package/lib/seam/connect/models/acs/acs-users/acs-user.js.map +1 -1
- package/lib/seam/connect/models/action-attempts/action-attempt.d.ts +395 -0
- package/lib/seam/connect/models/action-attempts/action-attempt.js +10 -0
- package/lib/seam/connect/models/action-attempts/action-attempt.js.map +1 -1
- package/lib/seam/connect/models/action-attempts/pause-speaker-playback.d.ts +87 -0
- package/lib/seam/connect/models/action-attempts/pause-speaker-playback.js +37 -0
- package/lib/seam/connect/models/action-attempts/pause-speaker-playback.js.map +1 -0
- package/lib/seam/connect/models/action-attempts/play-speaker-chime.d.ts +77 -0
- package/lib/seam/connect/models/action-attempts/play-speaker-chime.js +31 -0
- package/lib/seam/connect/models/action-attempts/play-speaker-chime.js.map +1 -0
- package/lib/seam/connect/models/action-attempts/resume-speaker-playback.d.ts +87 -0
- package/lib/seam/connect/models/action-attempts/resume-speaker-playback.js +37 -0
- package/lib/seam/connect/models/action-attempts/resume-speaker-playback.js.map +1 -0
- package/lib/seam/connect/models/action-attempts/set-speaker-mute.d.ts +77 -0
- package/lib/seam/connect/models/action-attempts/set-speaker-mute.js +31 -0
- package/lib/seam/connect/models/action-attempts/set-speaker-mute.js.map +1 -0
- package/lib/seam/connect/models/action-attempts/set-speaker-volume.d.ts +77 -0
- package/lib/seam/connect/models/action-attempts/set-speaker-volume.js +31 -0
- package/lib/seam/connect/models/action-attempts/set-speaker-volume.js.map +1 -0
- package/lib/seam/connect/models/connect-webviews/connect-webview.d.ts +3 -3
- package/lib/seam/connect/models/connected-accounts/connected-account.d.ts +3 -3
- package/lib/seam/connect/models/devices/capability-properties/index.d.ts +95 -1
- package/lib/seam/connect/models/devices/capability-properties/index.js +4 -2
- package/lib/seam/connect/models/devices/capability-properties/index.js.map +1 -1
- package/lib/seam/connect/models/devices/capability-properties/speaker.d.ts +98 -0
- package/lib/seam/connect/models/devices/capability-properties/speaker.js +61 -0
- package/lib/seam/connect/models/devices/capability-properties/speaker.js.map +1 -0
- package/lib/seam/connect/models/devices/device-metadata.d.ts +33 -0
- package/lib/seam/connect/models/devices/device-metadata.js +26 -0
- package/lib/seam/connect/models/devices/device-metadata.js.map +1 -1
- package/lib/seam/connect/models/devices/device-provider.d.ts +12 -0
- package/lib/seam/connect/models/devices/device-provider.js +1 -0
- package/lib/seam/connect/models/devices/device-provider.js.map +1 -1
- package/lib/seam/connect/models/devices/device-type.d.ts +7 -1
- package/lib/seam/connect/models/devices/device-type.js +8 -0
- package/lib/seam/connect/models/devices/device-type.js.map +1 -1
- package/lib/seam/connect/models/devices/device.d.ts +200 -3
- package/lib/seam/connect/models/devices/device.js +16 -0
- package/lib/seam/connect/models/devices/device.js.map +1 -1
- package/lib/seam/connect/models/devices/phone.d.ts +1126 -22
- package/lib/seam/connect/models/devices/phone.js +4 -19
- package/lib/seam/connect/models/devices/phone.js.map +1 -1
- package/lib/seam/connect/models/devices/unmanaged-device.d.ts +144 -3
- package/lib/seam/connect/models/phones/phone-session.d.ts +28 -26
- package/lib/seam/connect/models/provider-capability.d.ts +1 -1
- package/lib/seam/connect/models/provider-capability.js +1 -0
- package/lib/seam/connect/models/provider-capability.js.map +1 -1
- package/lib/seam/connect/models/user-identities/user-identity.js +4 -4
- package/lib/seam/connect/models/user-identities/user-identity.js.map +1 -1
- package/lib/seam/connect/openapi.js +2006 -136
- package/lib/seam/connect/openapi.js.map +1 -1
- package/lib/seam/connect/route-types.d.ts +8195 -142
- package/package.json +1 -1
- package/src/lib/seam/connect/internal/enums.ts +2 -0
- package/src/lib/seam/connect/internal/schemas.ts +1 -0
- package/src/lib/seam/connect/models/access-grants/access-grant.ts +13 -5
- package/src/lib/seam/connect/models/acs/acs-access-group.ts +2 -2
- package/src/lib/seam/connect/models/acs/acs-entrance.ts +36 -17
- package/src/lib/seam/connect/models/acs/acs-users/acs-user.ts +44 -34
- package/src/lib/seam/connect/models/action-attempts/action-attempt.ts +10 -0
- package/src/lib/seam/connect/models/action-attempts/pause-speaker-playback.ts +54 -0
- package/src/lib/seam/connect/models/action-attempts/play-speaker-chime.ts +46 -0
- package/src/lib/seam/connect/models/action-attempts/resume-speaker-playback.ts +54 -0
- package/src/lib/seam/connect/models/action-attempts/set-speaker-mute.ts +43 -0
- package/src/lib/seam/connect/models/action-attempts/set-speaker-volume.ts +46 -0
- package/src/lib/seam/connect/models/devices/capability-properties/index.ts +9 -1
- package/src/lib/seam/connect/models/devices/capability-properties/speaker.ts +76 -0
- package/src/lib/seam/connect/models/devices/device-metadata.ts +29 -0
- package/src/lib/seam/connect/models/devices/device-provider.ts +1 -0
- package/src/lib/seam/connect/models/devices/device-type.ts +16 -0
- package/src/lib/seam/connect/models/devices/device.ts +18 -0
- package/src/lib/seam/connect/models/devices/phone.ts +4 -27
- package/src/lib/seam/connect/models/provider-capability.ts +1 -0
- package/src/lib/seam/connect/models/user-identities/user-identity.ts +4 -4
- package/src/lib/seam/connect/openapi.ts +2537 -407
- package/src/lib/seam/connect/route-types.ts +9097 -128
package/package.json
CHANGED
|
@@ -94,21 +94,29 @@ const underprovisioned_access = common_access_grant_warning
|
|
|
94
94
|
'Indicates that the access grant should have access to more locations than it currently does. Access methods are being created for the missing locations.',
|
|
95
95
|
)
|
|
96
96
|
|
|
97
|
+
export const access_code_revocation_failure_code = z
|
|
98
|
+
.enum(['offline_access_code_not_revocable'])
|
|
99
|
+
.describe('Reason the access code could not be revoked.')
|
|
100
|
+
|
|
101
|
+
export type AccessCodeRevocationFailureCode = z.infer<
|
|
102
|
+
typeof access_code_revocation_failure_code
|
|
103
|
+
>
|
|
104
|
+
|
|
97
105
|
const overprovisioned_failed_device = z.object({
|
|
98
106
|
device_id: z
|
|
99
107
|
.string()
|
|
100
108
|
.uuid()
|
|
101
109
|
.describe('Device whose access code could not be revoked.'),
|
|
102
|
-
error_code:
|
|
103
|
-
.string()
|
|
104
|
-
.describe(
|
|
105
|
-
'Reason the access code could not be revoked (e.g. `offline_access_code_not_revocable`).',
|
|
106
|
-
),
|
|
110
|
+
error_code: access_code_revocation_failure_code,
|
|
107
111
|
message: z
|
|
108
112
|
.string()
|
|
109
113
|
.describe('Human-readable description of why revocation failed.'),
|
|
110
114
|
})
|
|
111
115
|
|
|
116
|
+
export type AccessGrantOverprovisionedFailedDevice = z.infer<
|
|
117
|
+
typeof overprovisioned_failed_device
|
|
118
|
+
>
|
|
119
|
+
|
|
112
120
|
const overprovisioned_access = common_access_grant_warning
|
|
113
121
|
.extend({
|
|
114
122
|
warning_code: z
|
|
@@ -47,7 +47,7 @@ const acs_access_groups_failed_to_create_on_acs_system =
|
|
|
47
47
|
Indicates that the [access group](https://www.seam.co/docs/low-level-apis/access-systems/user-management/assigning-users-to-access-groups) was not created on the [access system](https://www.seam.co/docs/low-level-apis/access-systems). This is likely due to an internal unexpected error. Contact Seam [support](mailto:support@seam.co).
|
|
48
48
|
`)
|
|
49
49
|
|
|
50
|
-
const
|
|
50
|
+
const acs_access_group_error = z
|
|
51
51
|
.discriminatedUnion('error_code', [
|
|
52
52
|
acs_access_groups_failed_to_create_on_acs_system,
|
|
53
53
|
])
|
|
@@ -148,7 +148,7 @@ const common_acs_access_group = z.object({
|
|
|
148
148
|
'Date and time at which the access group was created.',
|
|
149
149
|
),
|
|
150
150
|
errors: z
|
|
151
|
-
.array(
|
|
151
|
+
.array(acs_access_group_error)
|
|
152
152
|
.describe('Errors associated with the `acs_access_group`.'),
|
|
153
153
|
warnings: z
|
|
154
154
|
.array(acs_access_group_warning)
|
|
@@ -15,6 +15,41 @@ import {
|
|
|
15
15
|
} from './metadata/index.js'
|
|
16
16
|
import { acs_entrance_salto_space_metadata } from './metadata/salto-space.js'
|
|
17
17
|
|
|
18
|
+
const error_code_description =
|
|
19
|
+
'Unique identifier of the type of error. Enables quick recognition and categorization of the issue.'
|
|
20
|
+
|
|
21
|
+
const common_acs_entrance_error = z.object({
|
|
22
|
+
created_at: datetime.describe(
|
|
23
|
+
'Date and time at which Seam created the error.',
|
|
24
|
+
),
|
|
25
|
+
message: z
|
|
26
|
+
.string()
|
|
27
|
+
.describe(
|
|
28
|
+
'Detailed description of the error. Provides insights into the issue and potentially how to rectify it.',
|
|
29
|
+
),
|
|
30
|
+
})
|
|
31
|
+
|
|
32
|
+
const entrance_removed = common_acs_entrance_error.extend({
|
|
33
|
+
error_code: z.literal('entrance_removed').describe(error_code_description),
|
|
34
|
+
}).describe(`
|
|
35
|
+
---
|
|
36
|
+
resource_type: acs_entrance
|
|
37
|
+
---
|
|
38
|
+
Indicates that the [entrance](https://www.seam.co/docs/low-level-apis/access-systems/retrieving-entrance-details) was removed from the connected account, so Seam can no longer sync it.
|
|
39
|
+
`)
|
|
40
|
+
|
|
41
|
+
const acs_entrance_error = z
|
|
42
|
+
.discriminatedUnion('error_code', [entrance_removed])
|
|
43
|
+
.describe(
|
|
44
|
+
'Error associated with the [entrance](https://www.seam.co/docs/low-level-apis/access-systems/retrieving-entrance-details).',
|
|
45
|
+
)
|
|
46
|
+
|
|
47
|
+
const _acs_entrance_error_map = z.object({
|
|
48
|
+
entrance_removed: entrance_removed.optional().nullable(),
|
|
49
|
+
})
|
|
50
|
+
|
|
51
|
+
export type AcsEntranceErrorMap = z.infer<typeof _acs_entrance_error_map>
|
|
52
|
+
|
|
18
53
|
const warning_code_description =
|
|
19
54
|
'Unique identifier of the type of warning. Enables quick recognition and categorization of the issue.'
|
|
20
55
|
|
|
@@ -167,23 +202,7 @@ export const acs_entrance = z
|
|
|
167
202
|
'ID of the [connected account](https://www.seam.co/docs/low-level-apis/access-systems/retrieving-entrance-details) associated with the [entrance](https://www.seam.co/docs/low-level-apis/access-systems/retrieving-entrance-details).',
|
|
168
203
|
),
|
|
169
204
|
errors: z
|
|
170
|
-
.array(
|
|
171
|
-
z.object({
|
|
172
|
-
error_code: z
|
|
173
|
-
.string()
|
|
174
|
-
.describe(
|
|
175
|
-
'Unique identifier of the type of error. Enables quick recognition and categorization of the issue.',
|
|
176
|
-
),
|
|
177
|
-
message: z
|
|
178
|
-
.string()
|
|
179
|
-
.describe(
|
|
180
|
-
'Detailed description of the error. Provides insights into the issue and potentially how to rectify it.',
|
|
181
|
-
),
|
|
182
|
-
created_at: datetime.describe(
|
|
183
|
-
'Date and time at which Seam created the error.',
|
|
184
|
-
),
|
|
185
|
-
}),
|
|
186
|
-
)
|
|
205
|
+
.array(acs_entrance_error)
|
|
187
206
|
.describe(
|
|
188
207
|
'Errors associated with the [entrance](https://www.seam.co/docs/low-level-apis/access-systems/retrieving-entrance-details).',
|
|
189
208
|
),
|
|
@@ -32,7 +32,7 @@ const common_acs_user_error = z.object({
|
|
|
32
32
|
),
|
|
33
33
|
})
|
|
34
34
|
|
|
35
|
-
const
|
|
35
|
+
const acs_user_deleted_externally = common_acs_user_error.extend({
|
|
36
36
|
error_code: z.literal('deleted_externally'),
|
|
37
37
|
}).describe(`
|
|
38
38
|
---
|
|
@@ -41,7 +41,7 @@ const acs_users_deleted_externally = common_acs_user_error.extend({
|
|
|
41
41
|
Indicates that the [access system user](https://www.seam.co/docs/low-level-apis/access-systems/user-management) was deleted from the [access system](https://www.seam.co/docs/low-level-apis/access-systems) outside of Seam.
|
|
42
42
|
`)
|
|
43
43
|
|
|
44
|
-
const
|
|
44
|
+
const acs_user_salto_ks_subscription_limit_exceeded =
|
|
45
45
|
common_acs_user_error.extend({
|
|
46
46
|
error_code: z.literal('salto_ks_subscription_limit_exceeded'),
|
|
47
47
|
}).describe(`
|
|
@@ -51,7 +51,7 @@ const acs_users_salto_ks_subscription_limit_exceeded =
|
|
|
51
51
|
Indicates that the [access system user](https://www.seam.co/docs/low-level-apis/access-systems/user-management) could not be subscribed on Salto KS because the subscription limit has been exceeded.
|
|
52
52
|
`)
|
|
53
53
|
|
|
54
|
-
const
|
|
54
|
+
const acs_user_failed_to_create_on_acs_system = common_acs_user_error.extend({
|
|
55
55
|
error_code: z.literal('failed_to_create_on_acs_system'),
|
|
56
56
|
}).describe(`
|
|
57
57
|
---
|
|
@@ -60,7 +60,7 @@ const acs_users_failed_to_create_on_acs_system = common_acs_user_error.extend({
|
|
|
60
60
|
Indicates that the [access system user](https://www.seam.co/docs/low-level-apis/access-systems/user-management) was not created on the [access system](https://www.seam.co/docs/low-level-apis/access-systems). This is likely due to an internal unexpected error. Contact Seam [support](mailto:support@seam.co).
|
|
61
61
|
`)
|
|
62
62
|
|
|
63
|
-
const
|
|
63
|
+
const acs_user_failed_to_update_on_acs_system = common_acs_user_error.extend({
|
|
64
64
|
error_code: z.literal('failed_to_update_on_acs_system'),
|
|
65
65
|
}).describe(`
|
|
66
66
|
---
|
|
@@ -69,7 +69,7 @@ const acs_users_failed_to_update_on_acs_system = common_acs_user_error.extend({
|
|
|
69
69
|
Indicates that the [access system user](https://www.seam.co/docs/low-level-apis/access-systems/user-management) was not updated on the [access system](https://www.seam.co/docs/low-level-apis/access-systems). This is likely due to an internal unexpected error. Contact Seam [support](mailto:support@seam.co).
|
|
70
70
|
`)
|
|
71
71
|
|
|
72
|
-
const
|
|
72
|
+
const acs_user_failed_to_delete_on_acs_system = common_acs_user_error.extend({
|
|
73
73
|
error_code: z.literal('failed_to_delete_on_acs_system'),
|
|
74
74
|
}).describe(`
|
|
75
75
|
---
|
|
@@ -78,48 +78,52 @@ const acs_users_failed_to_delete_on_acs_system = common_acs_user_error.extend({
|
|
|
78
78
|
Indicates that the [access system user](https://www.seam.co/docs/low-level-apis/access-systems/user-management) was not deleted on the [access system](https://www.seam.co/docs/low-level-apis/access-systems). This is likely due to an internal unexpected error. Contact Seam [support](mailto:support@seam.co).
|
|
79
79
|
`)
|
|
80
80
|
|
|
81
|
-
const
|
|
82
|
-
|
|
81
|
+
const acs_user_latch_conflict_with_resident_user = common_acs_user_error.extend(
|
|
82
|
+
{
|
|
83
83
|
error_code: z.literal('latch_conflict_with_resident_user'),
|
|
84
|
-
}
|
|
84
|
+
},
|
|
85
|
+
).describe(`
|
|
85
86
|
---
|
|
86
87
|
resource_type: acs_user
|
|
87
88
|
---
|
|
88
89
|
Indicates that the [access system user](https://www.seam.co/docs/low-level-apis/access-systems/user-management) was created from the Seam API but also exists on Mission Control. This is unsupported. Contact Seam [support](mailto:support@seam.co).
|
|
89
90
|
`)
|
|
90
91
|
|
|
91
|
-
const
|
|
92
|
+
const acs_user_error = z
|
|
92
93
|
.discriminatedUnion('error_code', [
|
|
93
|
-
|
|
94
|
-
|
|
95
|
-
|
|
96
|
-
|
|
97
|
-
|
|
98
|
-
|
|
94
|
+
acs_user_deleted_externally,
|
|
95
|
+
acs_user_salto_ks_subscription_limit_exceeded,
|
|
96
|
+
acs_user_failed_to_create_on_acs_system,
|
|
97
|
+
acs_user_failed_to_update_on_acs_system,
|
|
98
|
+
acs_user_failed_to_delete_on_acs_system,
|
|
99
|
+
acs_user_latch_conflict_with_resident_user,
|
|
99
100
|
])
|
|
100
101
|
.describe(
|
|
101
102
|
'Errors associated with the [access system user](https://www.seam.co/docs/low-level-apis/access-systems/user-management).',
|
|
102
103
|
)
|
|
103
104
|
|
|
104
|
-
const
|
|
105
|
-
deleted_externally:
|
|
105
|
+
const _acs_user_error_map = z.object({
|
|
106
|
+
deleted_externally: acs_user_deleted_externally.optional().nullable(),
|
|
106
107
|
salto_ks_subscription_limit_exceeded:
|
|
107
|
-
|
|
108
|
-
failed_to_create_on_acs_system:
|
|
108
|
+
acs_user_salto_ks_subscription_limit_exceeded.optional().nullable(),
|
|
109
|
+
failed_to_create_on_acs_system: acs_user_failed_to_create_on_acs_system
|
|
109
110
|
.optional()
|
|
110
111
|
.nullable(),
|
|
111
|
-
failed_to_update_on_acs_system:
|
|
112
|
+
failed_to_update_on_acs_system: acs_user_failed_to_update_on_acs_system
|
|
112
113
|
.optional()
|
|
113
114
|
.nullable(),
|
|
114
|
-
failed_to_delete_on_acs_system:
|
|
115
|
+
failed_to_delete_on_acs_system: acs_user_failed_to_delete_on_acs_system
|
|
115
116
|
.optional()
|
|
116
117
|
.nullable(),
|
|
117
|
-
latch_conflict_with_resident_user:
|
|
118
|
+
latch_conflict_with_resident_user: acs_user_latch_conflict_with_resident_user
|
|
118
119
|
.optional()
|
|
119
120
|
.nullable(),
|
|
120
121
|
})
|
|
121
122
|
|
|
122
|
-
export type
|
|
123
|
+
export type AcsUserErrorMap = z.infer<typeof _acs_user_error_map>
|
|
124
|
+
|
|
125
|
+
/** @deprecated Use AcsUserErrorMap. */
|
|
126
|
+
export type AcsUsersErrorMap = AcsUserErrorMap
|
|
123
127
|
|
|
124
128
|
const common_acs_user_warning = z.object({
|
|
125
129
|
created_at: datetime.describe(
|
|
@@ -132,7 +136,7 @@ const common_acs_user_warning = z.object({
|
|
|
132
136
|
),
|
|
133
137
|
})
|
|
134
138
|
|
|
135
|
-
const
|
|
139
|
+
const acs_user_being_deleted = common_acs_user_warning
|
|
136
140
|
.extend({
|
|
137
141
|
warning_code: z.literal('being_deleted'),
|
|
138
142
|
})
|
|
@@ -140,7 +144,7 @@ const acs_users_being_deleted = common_acs_user_warning
|
|
|
140
144
|
'Indicates that the [access system user](https://www.seam.co/docs/low-level-apis/access-systems/user-management) is being deleted from the [access system](https://www.seam.co/docs/low-level-apis/access-systems). This is a temporary state, and the access system user will be deleted shortly.',
|
|
141
145
|
)
|
|
142
146
|
|
|
143
|
-
const
|
|
147
|
+
const acs_user_salto_ks_user_not_subscribed = common_acs_user_warning
|
|
144
148
|
.extend({
|
|
145
149
|
warning_code: z.literal('salto_ks_user_not_subscribed'),
|
|
146
150
|
})
|
|
@@ -172,9 +176,9 @@ export const latch_resident_user = common_acs_user_warning
|
|
|
172
176
|
'Indicates that the [access system user](https://www.seam.co/docs/low-level-apis/access-systems/user-management) was created on Latch Mission Control. Please use the Latch Mission Control to manage this user.',
|
|
173
177
|
)
|
|
174
178
|
|
|
175
|
-
const
|
|
176
|
-
being_deleted:
|
|
177
|
-
salto_ks_user_not_subscribed:
|
|
179
|
+
const _acs_user_warning_map = z.object({
|
|
180
|
+
being_deleted: acs_user_being_deleted.optional().nullable(),
|
|
181
|
+
salto_ks_user_not_subscribed: acs_user_salto_ks_user_not_subscribed
|
|
178
182
|
.optional()
|
|
179
183
|
.nullable(),
|
|
180
184
|
acs_user_inactive: acs_user_inactive.optional().nullable(),
|
|
@@ -184,10 +188,10 @@ const _acs_users_warning_map = z.object({
|
|
|
184
188
|
latch_resident_user: latch_resident_user.optional().nullable(),
|
|
185
189
|
})
|
|
186
190
|
|
|
187
|
-
export const
|
|
191
|
+
export const acs_user_warning = z
|
|
188
192
|
.discriminatedUnion('warning_code', [
|
|
189
|
-
|
|
190
|
-
|
|
193
|
+
acs_user_being_deleted,
|
|
194
|
+
acs_user_salto_ks_user_not_subscribed,
|
|
191
195
|
acs_user_inactive,
|
|
192
196
|
unknown_issue_with_acs_user,
|
|
193
197
|
latch_resident_user,
|
|
@@ -196,7 +200,13 @@ export const acs_users_warnings = z
|
|
|
196
200
|
'Warnings associated with the [access system user](https://www.seam.co/docs/low-level-apis/access-systems/user-management).',
|
|
197
201
|
)
|
|
198
202
|
|
|
199
|
-
export type
|
|
203
|
+
export type AcsUserWarningMap = z.infer<typeof _acs_user_warning_map>
|
|
204
|
+
|
|
205
|
+
/** @deprecated Use acs_user_warning. */
|
|
206
|
+
export const acs_users_warnings = acs_user_warning
|
|
207
|
+
|
|
208
|
+
/** @deprecated Use AcsUserWarningMap. */
|
|
209
|
+
export type AcsUsersWarningMap = AcsUserWarningMap
|
|
200
210
|
|
|
201
211
|
const user_fields = z.object({
|
|
202
212
|
full_name: z
|
|
@@ -311,12 +321,12 @@ const common_acs_user = z
|
|
|
311
321
|
'Phone number of the user identity associated with the [access system user](https://www.seam.co/docs/low-level-apis/access-systems/user-management) in E.164 format (for example, `+15555550100`).',
|
|
312
322
|
),
|
|
313
323
|
warnings: z
|
|
314
|
-
.array(
|
|
324
|
+
.array(acs_user_warning)
|
|
315
325
|
.describe(
|
|
316
326
|
'Warnings associated with the [access system user](https://www.seam.co/docs/low-level-apis/access-systems/user-management).',
|
|
317
327
|
),
|
|
318
328
|
errors: z
|
|
319
|
-
.array(
|
|
329
|
+
.array(acs_user_error)
|
|
320
330
|
.describe(
|
|
321
331
|
'Errors associated with the [access system user](https://www.seam.co/docs/low-level-apis/access-systems/user-management).',
|
|
322
332
|
),
|
|
@@ -8,12 +8,17 @@ import { convert_access_code_to_managed_action_attempt } from './convert-access-
|
|
|
8
8
|
import { deprecated_action_attempts } from './deprecated.js'
|
|
9
9
|
import { encode_credential_action_attempt } from './encode-credential.js'
|
|
10
10
|
import { lock_door_action_attempt } from './lock-door.js'
|
|
11
|
+
import { pause_speaker_playback_action_attempt } from './pause-speaker-playback.js'
|
|
12
|
+
import { play_speaker_chime_action_attempt } from './play-speaker-chime.js'
|
|
11
13
|
import { push_thermostat_programs_action_attempt } from './push-thermostat-programs.js'
|
|
12
14
|
import { reset_sandbox_workspace_action_attempt } from './reset-sandbox-workspace.js'
|
|
15
|
+
import { resume_speaker_playback_action_attempt } from './resume-speaker-playback.js'
|
|
13
16
|
import { scan_credential_action_attempt } from './scan-credential.js'
|
|
14
17
|
import { scan_to_assign_credential_action_attempt } from './scan-to-assign-credential.js'
|
|
15
18
|
import { set_fan_mode_action_attempt } from './set-fan-mode.js'
|
|
16
19
|
import { set_hvac_mode_action_attempt } from './set-hvac-mode.js'
|
|
20
|
+
import { set_speaker_mute_action_attempt } from './set-speaker-mute.js'
|
|
21
|
+
import { set_speaker_volume_action_attempt } from './set-speaker-volume.js'
|
|
17
22
|
import { simulate_keypad_code_entry_action_attempt } from './simulate-keypad-code-entry.js'
|
|
18
23
|
import { simulate_manual_lock_via_keypad_action_attempt } from './simulate-manual-lock-via-keypad.js'
|
|
19
24
|
import { unlock_door_action_attempt } from './unlock-door.js'
|
|
@@ -35,6 +40,11 @@ export const action_attempt = z.union([
|
|
|
35
40
|
...push_thermostat_programs_action_attempt.options,
|
|
36
41
|
...configure_auto_lock_action_attempt.options,
|
|
37
42
|
...convert_access_code_to_managed_action_attempt.options,
|
|
43
|
+
...set_speaker_volume_action_attempt.options,
|
|
44
|
+
...set_speaker_mute_action_attempt.options,
|
|
45
|
+
...pause_speaker_playback_action_attempt.options,
|
|
46
|
+
...resume_speaker_playback_action_attempt.options,
|
|
47
|
+
...play_speaker_chime_action_attempt.options,
|
|
38
48
|
...deprecated_action_attempts,
|
|
39
49
|
]).describe(`
|
|
40
50
|
---
|
|
@@ -0,0 +1,54 @@
|
|
|
1
|
+
import * as z from 'zod/v3'
|
|
2
|
+
|
|
3
|
+
import {
|
|
4
|
+
common_failed_action_attempt,
|
|
5
|
+
common_pending_action_attempt,
|
|
6
|
+
common_succeeded_action_attempt,
|
|
7
|
+
} from './common.js'
|
|
8
|
+
|
|
9
|
+
const action_type = z
|
|
10
|
+
.literal('PAUSE_SPEAKER_PLAYBACK')
|
|
11
|
+
.describe(
|
|
12
|
+
'Action attempt to track the status of pausing playback on a speaker.',
|
|
13
|
+
)
|
|
14
|
+
|
|
15
|
+
const error = z
|
|
16
|
+
.object({
|
|
17
|
+
type: z.string().describe('Type of the error.'),
|
|
18
|
+
message: z
|
|
19
|
+
.string()
|
|
20
|
+
.describe(
|
|
21
|
+
'Detailed description of the error. Provides insights into the issue and potentially how to rectify it.',
|
|
22
|
+
),
|
|
23
|
+
})
|
|
24
|
+
.describe('Error associated with the action.')
|
|
25
|
+
|
|
26
|
+
const result = z
|
|
27
|
+
.object({
|
|
28
|
+
affected_device_ids: z
|
|
29
|
+
.array(z.string().uuid())
|
|
30
|
+
.describe(
|
|
31
|
+
'IDs of the speakers whose playback was paused, including speakers grouped with the requested speaker.',
|
|
32
|
+
),
|
|
33
|
+
})
|
|
34
|
+
.describe('Result of the action.')
|
|
35
|
+
|
|
36
|
+
export const pause_speaker_playback_action_attempt = z.discriminatedUnion(
|
|
37
|
+
'status',
|
|
38
|
+
[
|
|
39
|
+
common_pending_action_attempt
|
|
40
|
+
.extend({
|
|
41
|
+
action_type,
|
|
42
|
+
})
|
|
43
|
+
.describe('Pausing playback on the speaker is pending.'),
|
|
44
|
+
common_succeeded_action_attempt
|
|
45
|
+
.extend({
|
|
46
|
+
action_type,
|
|
47
|
+
result,
|
|
48
|
+
})
|
|
49
|
+
.describe('Pausing playback on the speaker succeeded.'),
|
|
50
|
+
common_failed_action_attempt
|
|
51
|
+
.extend({ action_type, error })
|
|
52
|
+
.describe('Pausing playback on the speaker failed.'),
|
|
53
|
+
],
|
|
54
|
+
)
|
|
@@ -0,0 +1,46 @@
|
|
|
1
|
+
import * as z from 'zod/v3'
|
|
2
|
+
|
|
3
|
+
import {
|
|
4
|
+
common_failed_action_attempt,
|
|
5
|
+
common_pending_action_attempt,
|
|
6
|
+
common_succeeded_action_attempt,
|
|
7
|
+
} from './common.js'
|
|
8
|
+
|
|
9
|
+
const action_type = z
|
|
10
|
+
.literal('PLAY_SPEAKER_CHIME')
|
|
11
|
+
.describe(
|
|
12
|
+
'Action attempt to track the status of playing a chime on a speaker.',
|
|
13
|
+
)
|
|
14
|
+
|
|
15
|
+
const error = z
|
|
16
|
+
.object({
|
|
17
|
+
type: z.string().describe('Type of the error.'),
|
|
18
|
+
message: z
|
|
19
|
+
.string()
|
|
20
|
+
.describe(
|
|
21
|
+
'Detailed description of the error. Provides insights into the issue and potentially how to rectify it.',
|
|
22
|
+
),
|
|
23
|
+
})
|
|
24
|
+
.describe('Error associated with the action.')
|
|
25
|
+
|
|
26
|
+
const result = z.object({}).describe('Result of the action.')
|
|
27
|
+
|
|
28
|
+
export const play_speaker_chime_action_attempt = z.discriminatedUnion(
|
|
29
|
+
'status',
|
|
30
|
+
[
|
|
31
|
+
common_pending_action_attempt
|
|
32
|
+
.extend({
|
|
33
|
+
action_type,
|
|
34
|
+
})
|
|
35
|
+
.describe('Playing a chime on the speaker is pending.'),
|
|
36
|
+
common_succeeded_action_attempt
|
|
37
|
+
.extend({
|
|
38
|
+
action_type,
|
|
39
|
+
result,
|
|
40
|
+
})
|
|
41
|
+
.describe('Playing a chime on the speaker succeeded.'),
|
|
42
|
+
common_failed_action_attempt
|
|
43
|
+
.extend({ action_type, error })
|
|
44
|
+
.describe('Playing a chime on the speaker failed.'),
|
|
45
|
+
],
|
|
46
|
+
)
|
|
@@ -0,0 +1,54 @@
|
|
|
1
|
+
import * as z from 'zod/v3'
|
|
2
|
+
|
|
3
|
+
import {
|
|
4
|
+
common_failed_action_attempt,
|
|
5
|
+
common_pending_action_attempt,
|
|
6
|
+
common_succeeded_action_attempt,
|
|
7
|
+
} from './common.js'
|
|
8
|
+
|
|
9
|
+
const action_type = z
|
|
10
|
+
.literal('RESUME_SPEAKER_PLAYBACK')
|
|
11
|
+
.describe(
|
|
12
|
+
'Action attempt to track the status of resuming playback on a speaker.',
|
|
13
|
+
)
|
|
14
|
+
|
|
15
|
+
const error = z
|
|
16
|
+
.object({
|
|
17
|
+
type: z.string().describe('Type of the error.'),
|
|
18
|
+
message: z
|
|
19
|
+
.string()
|
|
20
|
+
.describe(
|
|
21
|
+
'Detailed description of the error. Provides insights into the issue and potentially how to rectify it.',
|
|
22
|
+
),
|
|
23
|
+
})
|
|
24
|
+
.describe('Error associated with the action.')
|
|
25
|
+
|
|
26
|
+
const result = z
|
|
27
|
+
.object({
|
|
28
|
+
affected_device_ids: z
|
|
29
|
+
.array(z.string().uuid())
|
|
30
|
+
.describe(
|
|
31
|
+
'IDs of the speakers whose playback was resumed, including speakers grouped with the requested speaker.',
|
|
32
|
+
),
|
|
33
|
+
})
|
|
34
|
+
.describe('Result of the action.')
|
|
35
|
+
|
|
36
|
+
export const resume_speaker_playback_action_attempt = z.discriminatedUnion(
|
|
37
|
+
'status',
|
|
38
|
+
[
|
|
39
|
+
common_pending_action_attempt
|
|
40
|
+
.extend({
|
|
41
|
+
action_type,
|
|
42
|
+
})
|
|
43
|
+
.describe('Resuming playback on the speaker is pending.'),
|
|
44
|
+
common_succeeded_action_attempt
|
|
45
|
+
.extend({
|
|
46
|
+
action_type,
|
|
47
|
+
result,
|
|
48
|
+
})
|
|
49
|
+
.describe('Resuming playback on the speaker succeeded.'),
|
|
50
|
+
common_failed_action_attempt
|
|
51
|
+
.extend({ action_type, error })
|
|
52
|
+
.describe('Resuming playback on the speaker failed.'),
|
|
53
|
+
],
|
|
54
|
+
)
|
|
@@ -0,0 +1,43 @@
|
|
|
1
|
+
import * as z from 'zod/v3'
|
|
2
|
+
|
|
3
|
+
import {
|
|
4
|
+
common_failed_action_attempt,
|
|
5
|
+
common_pending_action_attempt,
|
|
6
|
+
common_succeeded_action_attempt,
|
|
7
|
+
} from './common.js'
|
|
8
|
+
|
|
9
|
+
const action_type = z
|
|
10
|
+
.literal('SET_SPEAKER_MUTE')
|
|
11
|
+
.describe(
|
|
12
|
+
'Action attempt to track the status of muting or unmuting a speaker.',
|
|
13
|
+
)
|
|
14
|
+
|
|
15
|
+
const error = z
|
|
16
|
+
.object({
|
|
17
|
+
type: z.string().describe('Type of the error.'),
|
|
18
|
+
message: z
|
|
19
|
+
.string()
|
|
20
|
+
.describe(
|
|
21
|
+
'Detailed description of the error. Provides insights into the issue and potentially how to rectify it.',
|
|
22
|
+
),
|
|
23
|
+
})
|
|
24
|
+
.describe('Error associated with the action.')
|
|
25
|
+
|
|
26
|
+
const result = z.object({}).describe('Result of the action.')
|
|
27
|
+
|
|
28
|
+
export const set_speaker_mute_action_attempt = z.discriminatedUnion('status', [
|
|
29
|
+
common_pending_action_attempt
|
|
30
|
+
.extend({
|
|
31
|
+
action_type,
|
|
32
|
+
})
|
|
33
|
+
.describe('Muting or unmuting the speaker is pending.'),
|
|
34
|
+
common_succeeded_action_attempt
|
|
35
|
+
.extend({
|
|
36
|
+
action_type,
|
|
37
|
+
result,
|
|
38
|
+
})
|
|
39
|
+
.describe('Muting or unmuting the speaker succeeded.'),
|
|
40
|
+
common_failed_action_attempt
|
|
41
|
+
.extend({ action_type, error })
|
|
42
|
+
.describe('Muting or unmuting the speaker failed.'),
|
|
43
|
+
])
|
|
@@ -0,0 +1,46 @@
|
|
|
1
|
+
import * as z from 'zod/v3'
|
|
2
|
+
|
|
3
|
+
import {
|
|
4
|
+
common_failed_action_attempt,
|
|
5
|
+
common_pending_action_attempt,
|
|
6
|
+
common_succeeded_action_attempt,
|
|
7
|
+
} from './common.js'
|
|
8
|
+
|
|
9
|
+
const action_type = z
|
|
10
|
+
.literal('SET_SPEAKER_VOLUME')
|
|
11
|
+
.describe(
|
|
12
|
+
'Action attempt to track the status of setting the volume on a speaker.',
|
|
13
|
+
)
|
|
14
|
+
|
|
15
|
+
const error = z
|
|
16
|
+
.object({
|
|
17
|
+
type: z.string().describe('Type of the error.'),
|
|
18
|
+
message: z
|
|
19
|
+
.string()
|
|
20
|
+
.describe(
|
|
21
|
+
'Detailed description of the error. Provides insights into the issue and potentially how to rectify it.',
|
|
22
|
+
),
|
|
23
|
+
})
|
|
24
|
+
.describe('Error associated with the action.')
|
|
25
|
+
|
|
26
|
+
const result = z.object({}).describe('Result of the action.')
|
|
27
|
+
|
|
28
|
+
export const set_speaker_volume_action_attempt = z.discriminatedUnion(
|
|
29
|
+
'status',
|
|
30
|
+
[
|
|
31
|
+
common_pending_action_attempt
|
|
32
|
+
.extend({
|
|
33
|
+
action_type,
|
|
34
|
+
})
|
|
35
|
+
.describe('Setting the speaker volume is pending.'),
|
|
36
|
+
common_succeeded_action_attempt
|
|
37
|
+
.extend({
|
|
38
|
+
action_type,
|
|
39
|
+
result,
|
|
40
|
+
})
|
|
41
|
+
.describe('Setting the speaker volume succeeded.'),
|
|
42
|
+
common_failed_action_attempt
|
|
43
|
+
.extend({ action_type, error })
|
|
44
|
+
.describe('Setting the speaker volume failed.'),
|
|
45
|
+
],
|
|
46
|
+
)
|
|
@@ -6,12 +6,18 @@ import {
|
|
|
6
6
|
time_frame_option,
|
|
7
7
|
} from './access-code.js'
|
|
8
8
|
import { lock_capability_properties } from './lock.js'
|
|
9
|
+
import {
|
|
10
|
+
speaker_capability_properties,
|
|
11
|
+
speaker_playback_state,
|
|
12
|
+
} from './speaker.js'
|
|
9
13
|
import { thermostat_capability_properties } from './thermostat.js'
|
|
10
14
|
|
|
11
15
|
export {
|
|
12
16
|
access_code_capability_properties,
|
|
13
17
|
access_code_code_constraint,
|
|
14
18
|
lock_capability_properties,
|
|
19
|
+
speaker_capability_properties,
|
|
20
|
+
speaker_playback_state,
|
|
15
21
|
thermostat_capability_properties,
|
|
16
22
|
time_frame_option,
|
|
17
23
|
}
|
|
@@ -20,8 +26,10 @@ export {
|
|
|
20
26
|
export const capability_properties = z.intersection(
|
|
21
27
|
access_code_capability_properties
|
|
22
28
|
.partial()
|
|
23
|
-
.merge(lock_capability_properties.partial())
|
|
29
|
+
.merge(lock_capability_properties.partial())
|
|
30
|
+
.merge(speaker_capability_properties),
|
|
24
31
|
thermostat_capability_properties,
|
|
25
32
|
)
|
|
26
33
|
|
|
27
34
|
export type { AccessCodeConstraint, TimeFrameOption } from './access-code.js'
|
|
35
|
+
export type { SpeakerPlaybackState } from './speaker.js'
|