@seamapi/types 1.916.0 → 1.917.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/dist/connect.cjs +603 -160
- package/dist/connect.cjs.map +1 -1
- package/dist/connect.d.cts +872 -15
- package/dist/index.cjs +603 -160
- package/dist/index.cjs.map +1 -1
- package/lib/seam/connect/models/acs/acs-access-group.js +4 -2
- package/lib/seam/connect/models/acs/acs-access-group.js.map +1 -1
- package/lib/seam/connect/models/acs/acs-credential.js +12 -3
- package/lib/seam/connect/models/acs/acs-credential.js.map +1 -1
- package/lib/seam/connect/models/acs/acs-system.js +15 -5
- package/lib/seam/connect/models/acs/acs-system.js.map +1 -1
- package/lib/seam/connect/models/acs/acs-users/acs-user.js +8 -2
- package/lib/seam/connect/models/acs/acs-users/acs-user.js.map +1 -1
- package/lib/seam/connect/models/connect-webviews/connect-webview.js +1 -1
- package/lib/seam/connect/models/connect-webviews/connect-webview.js.map +1 -1
- package/lib/seam/connect/models/devices/device-provider.js +8 -4
- package/lib/seam/connect/models/devices/device-provider.js.map +1 -1
- package/lib/seam/connect/models/devices/device.js +60 -20
- package/lib/seam/connect/models/devices/device.js.map +1 -1
- package/lib/seam/connect/models/devices/phone.js +10 -6
- package/lib/seam/connect/models/devices/phone.js.map +1 -1
- package/lib/seam/connect/models/devices/unmanaged-device.js +3 -1
- package/lib/seam/connect/models/devices/unmanaged-device.js.map +1 -1
- package/lib/seam/connect/models/events/access-codes.js +7 -3
- package/lib/seam/connect/models/events/access-codes.js.map +1 -1
- package/lib/seam/connect/models/events/acs/entrances.js +3 -5
- package/lib/seam/connect/models/events/acs/entrances.js.map +1 -1
- package/lib/seam/connect/models/events/acs/users.js +6 -5
- package/lib/seam/connect/models/events/acs/users.js.map +1 -1
- package/lib/seam/connect/models/events/common.js +8 -4
- package/lib/seam/connect/models/events/common.js.map +1 -1
- package/lib/seam/connect/models/thermostats/modes.js +9 -16
- package/lib/seam/connect/models/thermostats/modes.js.map +1 -1
- package/lib/seam/connect/models/user-identities/user-identity.js +9 -2
- package/lib/seam/connect/models/user-identities/user-identity.js.map +1 -1
- package/lib/seam/connect/openapi.js +494 -96
- package/lib/seam/connect/openapi.js.map +1 -1
- package/lib/seam/connect/route-types.d.ts +872 -15
- package/package.json +1 -1
- package/src/lib/seam/connect/models/acs/acs-access-group.ts +4 -2
- package/src/lib/seam/connect/models/acs/acs-credential.ts +14 -3
- package/src/lib/seam/connect/models/acs/acs-system.ts +25 -5
- package/src/lib/seam/connect/models/acs/acs-users/acs-user.ts +10 -2
- package/src/lib/seam/connect/models/connect-webviews/connect-webview.ts +3 -1
- package/src/lib/seam/connect/models/devices/device-provider.ts +10 -4
- package/src/lib/seam/connect/models/devices/device.ts +90 -20
- package/src/lib/seam/connect/models/devices/phone.ts +12 -6
- package/src/lib/seam/connect/models/devices/unmanaged-device.ts +3 -1
- package/src/lib/seam/connect/models/events/access-codes.ts +18 -14
- package/src/lib/seam/connect/models/events/acs/entrances.ts +3 -5
- package/src/lib/seam/connect/models/events/acs/users.ts +6 -5
- package/src/lib/seam/connect/models/events/common.ts +32 -24
- package/src/lib/seam/connect/models/thermostats/modes.ts +15 -16
- package/src/lib/seam/connect/models/user-identities/user-identity.ts +9 -2
- package/src/lib/seam/connect/openapi.ts +641 -96
- package/src/lib/seam/connect/route-types.ts +872 -15
package/dist/index.cjs
CHANGED
|
@@ -164,23 +164,16 @@ var lock_capability_properties = zod.z.object({
|
|
|
164
164
|
The delay in seconds before the lock automatically locks after being unlocked.
|
|
165
165
|
`)
|
|
166
166
|
});
|
|
167
|
-
var hvac_mode_setting = zod.z.enum([
|
|
168
|
-
"off"
|
|
169
|
-
|
|
170
|
-
|
|
171
|
-
"
|
|
172
|
-
|
|
173
|
-
]);
|
|
174
|
-
var fan_mode_setting = zod.z.enum(["auto", "on", "circulate"]);
|
|
167
|
+
var hvac_mode_setting = zod.z.enum(["off", "heat", "cool", "heat_cool", "eco"]).describe(
|
|
168
|
+
"HVAC mode setting for the thermostat, such as `heat`, `cool`, `heat_cool`, `eco`, or `off`."
|
|
169
|
+
);
|
|
170
|
+
var fan_mode_setting = zod.z.enum(["auto", "on", "circulate"]).describe(
|
|
171
|
+
"Fan mode setting for the thermostat, such as `auto`, `on`, or `circulate`."
|
|
172
|
+
);
|
|
175
173
|
zod.z.array(fan_mode_setting);
|
|
176
|
-
var climate_preset_mode = zod.z.enum([
|
|
177
|
-
"home"
|
|
178
|
-
|
|
179
|
-
"wake",
|
|
180
|
-
"sleep",
|
|
181
|
-
"occupied",
|
|
182
|
-
"unoccupied"
|
|
183
|
-
]);
|
|
174
|
+
var climate_preset_mode = zod.z.enum(["home", "away", "wake", "sleep", "occupied", "unoccupied"]).describe(
|
|
175
|
+
"Climate preset mode for the thermostat, such as `home`, `away`, `wake`, `sleep`, `occupied`, or `unoccupied`."
|
|
176
|
+
);
|
|
184
177
|
|
|
185
178
|
// src/lib/seam/connect/models/thermostats/climate-preset.ts
|
|
186
179
|
var climate_preset = zod.z.object({
|
|
@@ -1299,26 +1292,56 @@ var phone_specific_properties = zod.z.object({
|
|
|
1299
1292
|
|
|
1300
1293
|
// src/lib/seam/connect/models/devices/device.ts
|
|
1301
1294
|
var device_capability_flags = zod.z.object({
|
|
1302
|
-
can_remotely_unlock: zod.z.boolean(),
|
|
1303
|
-
can_remotely_lock: zod.z.boolean(),
|
|
1304
|
-
can_program_offline_access_codes: zod.z.boolean()
|
|
1305
|
-
|
|
1306
|
-
|
|
1307
|
-
|
|
1308
|
-
|
|
1309
|
-
|
|
1310
|
-
|
|
1311
|
-
|
|
1312
|
-
|
|
1313
|
-
|
|
1314
|
-
|
|
1315
|
-
|
|
1316
|
-
|
|
1317
|
-
|
|
1318
|
-
|
|
1319
|
-
|
|
1320
|
-
|
|
1321
|
-
|
|
1295
|
+
can_remotely_unlock: zod.z.boolean().describe("Indicates whether the device supports remote unlocking."),
|
|
1296
|
+
can_remotely_lock: zod.z.boolean().describe("Indicates whether the device supports remote locking."),
|
|
1297
|
+
can_program_offline_access_codes: zod.z.boolean().describe(
|
|
1298
|
+
"Indicates whether the device supports programming offline access codes."
|
|
1299
|
+
),
|
|
1300
|
+
can_program_online_access_codes: zod.z.boolean().describe(
|
|
1301
|
+
"Indicates whether the device supports programming online access codes."
|
|
1302
|
+
),
|
|
1303
|
+
can_hvac_heat: zod.z.boolean().describe("Indicates whether the thermostat supports heating."),
|
|
1304
|
+
can_hvac_cool: zod.z.boolean().describe("Indicates whether the thermostat supports cooling."),
|
|
1305
|
+
can_hvac_heat_cool: zod.z.boolean().describe(
|
|
1306
|
+
"Indicates whether the thermostat supports simultaneous heating and cooling."
|
|
1307
|
+
),
|
|
1308
|
+
can_turn_off_hvac: zod.z.boolean().describe("Indicates whether the thermostat can be turned off."),
|
|
1309
|
+
can_simulate_removal: zod.z.boolean().describe(
|
|
1310
|
+
"Indicates whether the device supports simulating removal in a sandbox."
|
|
1311
|
+
),
|
|
1312
|
+
can_simulate_connection: zod.z.boolean().describe(
|
|
1313
|
+
"Indicates whether the device supports simulating connection in a sandbox."
|
|
1314
|
+
),
|
|
1315
|
+
can_simulate_disconnection: zod.z.boolean().describe(
|
|
1316
|
+
"Indicates whether the device supports simulating disconnection in a sandbox."
|
|
1317
|
+
),
|
|
1318
|
+
can_unlock_with_code: zod.z.boolean().describe(
|
|
1319
|
+
"Indicates whether the lock supports unlocking with an access code."
|
|
1320
|
+
),
|
|
1321
|
+
can_run_thermostat_programs: zod.z.boolean().describe(
|
|
1322
|
+
"Indicates whether the thermostat supports running climate programs."
|
|
1323
|
+
),
|
|
1324
|
+
can_program_thermostat_programs_as_weekday_weekend: zod.z.boolean().describe(
|
|
1325
|
+
"Indicates whether the thermostat supports weekday/weekend climate programs."
|
|
1326
|
+
),
|
|
1327
|
+
can_program_thermostat_programs_as_different_each_day: zod.z.boolean().describe(
|
|
1328
|
+
"Indicates whether the thermostat supports different climate programs for each day of the week."
|
|
1329
|
+
),
|
|
1330
|
+
can_program_thermostat_programs_as_same_each_day: zod.z.boolean().describe(
|
|
1331
|
+
"Indicates whether the thermostat supports a single climate program applied to every day."
|
|
1332
|
+
),
|
|
1333
|
+
can_simulate_hub_connection: zod.z.boolean().describe(
|
|
1334
|
+
"Indicates whether the hub supports simulating connection in a sandbox."
|
|
1335
|
+
),
|
|
1336
|
+
can_simulate_hub_disconnection: zod.z.boolean().describe(
|
|
1337
|
+
"Indicates whether the hub supports simulating disconnection in a sandbox."
|
|
1338
|
+
),
|
|
1339
|
+
can_simulate_paid_subscription: zod.z.boolean().describe(
|
|
1340
|
+
"Indicates whether the device supports simulating a paid subscription in a sandbox."
|
|
1341
|
+
),
|
|
1342
|
+
can_configure_auto_lock: zod.z.boolean().describe(
|
|
1343
|
+
"Indicates whether the lock supports configuring automatic locking."
|
|
1344
|
+
)
|
|
1322
1345
|
}).partial();
|
|
1323
1346
|
var battery_status = zod.z.enum(["critical", "low", "good", "full"]).describe(`Represents the current status of the battery charge level. Values are \`critical\`, which indicates an extremely low level, suggesting imminent shutdown or an urgent need for charging; \`low\`, which signifies that the battery is under the preferred threshold and should be charged soon; \`good\`, which denotes a satisfactory charge level, adequate for normal use without the immediate need for recharging; and \`full\`, which represents a battery that is fully charged, providing the maximum duration of usage.
|
|
1324
1347
|
`);
|
|
@@ -2181,10 +2204,12 @@ var PROVIDER_CATEGORY_MAP = {
|
|
|
2181
2204
|
var PROVIDER_CATEGORIES = Object.keys(PROVIDER_CATEGORY_MAP);
|
|
2182
2205
|
var PUBLIC_PROVIDER_CATEGORIES = PROVIDER_CATEGORIES.filter((category) => category !== "internal_beta");
|
|
2183
2206
|
var device_provider = zod.z.object({
|
|
2184
|
-
device_provider_name: zod.z.enum(ALL_DEVICE_PROVIDERS),
|
|
2185
|
-
display_name: zod.z.string(),
|
|
2186
|
-
image_url: zod.z.string(),
|
|
2187
|
-
provider_categories: zod.z.array(zod.z.enum(PUBLIC_PROVIDER_CATEGORIES))
|
|
2207
|
+
device_provider_name: zod.z.enum(ALL_DEVICE_PROVIDERS).describe("Name of the device provider."),
|
|
2208
|
+
display_name: zod.z.string().describe("Display name for the device provider."),
|
|
2209
|
+
image_url: zod.z.string().describe("Image URL for the device provider."),
|
|
2210
|
+
provider_categories: zod.z.array(zod.z.enum(PUBLIC_PROVIDER_CATEGORIES)).describe(
|
|
2211
|
+
"List of provider categories to which the device provider belongs, such as `stable`, `consumer_smartlocks`, `thermostats`, and so on."
|
|
2212
|
+
)
|
|
2188
2213
|
}).extend(device_capability_flags.shape).describe(`
|
|
2189
2214
|
---
|
|
2190
2215
|
route_path: /devices
|
|
@@ -2202,7 +2227,7 @@ var unmanaged_device = device.pick({
|
|
|
2202
2227
|
created_at: true,
|
|
2203
2228
|
custom_metadata: true
|
|
2204
2229
|
}).extend({
|
|
2205
|
-
is_managed: zod.z.literal(false),
|
|
2230
|
+
is_managed: zod.z.literal(false).describe("Indicates that Seam does not manage the device."),
|
|
2206
2231
|
properties: common_device_properties.pick({
|
|
2207
2232
|
accessory_keypad: true,
|
|
2208
2233
|
name: true,
|
|
@@ -3321,7 +3346,7 @@ var common_acs_access_group = zod.z.object({
|
|
|
3321
3346
|
deprecated: Use \`external_type_display_name\`.
|
|
3322
3347
|
---
|
|
3323
3348
|
`),
|
|
3324
|
-
display_name: zod.z.string(),
|
|
3349
|
+
display_name: zod.z.string().describe("Display name for the access group."),
|
|
3325
3350
|
external_type: acs_access_group_external_type.describe(
|
|
3326
3351
|
"Brand-specific terminology for the access group type."
|
|
3327
3352
|
),
|
|
@@ -3339,7 +3364,7 @@ var common_acs_access_group = zod.z.object({
|
|
|
3339
3364
|
)
|
|
3340
3365
|
});
|
|
3341
3366
|
var acs_access_group = common_acs_access_group.extend({
|
|
3342
|
-
is_managed: zod.z.literal(true)
|
|
3367
|
+
is_managed: zod.z.literal(true).describe("Indicates whether Seam manages the access group.")
|
|
3343
3368
|
}).describe(`
|
|
3344
3369
|
---
|
|
3345
3370
|
route_path: /acs/access_groups
|
|
@@ -3554,7 +3579,7 @@ var common_acs_credential = zod.z.object({
|
|
|
3554
3579
|
connected_account_id: zod.z.string().uuid().describe(
|
|
3555
3580
|
"ID of the [connected account](https://docs.seam.co/low-level-apis/access-systems/managing-credentials#connected-accounts) to which the [credential](https://docs.seam.co/low-level-apis/access-systems/managing-credentials) belongs."
|
|
3556
3581
|
),
|
|
3557
|
-
acs_credential_pool_id: zod.z.string().uuid().optional(),
|
|
3582
|
+
acs_credential_pool_id: zod.z.string().uuid().optional().describe("ID of the credential pool to which the credential belongs."),
|
|
3558
3583
|
acs_system_id: zod.z.string().uuid().describe(
|
|
3559
3584
|
"ID of the [access control system](https://docs.seam.co/low-level-apis/access-systems) that contains the [credential](https://docs.seam.co/low-level-apis/access-systems/managing-credentials)."
|
|
3560
3585
|
),
|
|
@@ -3629,7 +3654,7 @@ var common_acs_credential = zod.z.object({
|
|
|
3629
3654
|
});
|
|
3630
3655
|
var acs_credential = common_acs_credential.merge(
|
|
3631
3656
|
zod.z.object({
|
|
3632
|
-
is_managed: zod.z.literal(true)
|
|
3657
|
+
is_managed: zod.z.literal(true).describe("Indicates whether Seam manages the credential.")
|
|
3633
3658
|
})
|
|
3634
3659
|
).describe(`
|
|
3635
3660
|
---
|
|
@@ -3658,7 +3683,9 @@ var acs_credential_on_encoder = zod.z.object({
|
|
|
3658
3683
|
created_at: zod.z.string().datetime().nullable().describe(
|
|
3659
3684
|
"Date and time at which the [credential](https://docs.seam.co/low-level-apis/access-systems/managing-credentials) was created."
|
|
3660
3685
|
),
|
|
3661
|
-
is_issued: zod.z.boolean().nullable()
|
|
3686
|
+
is_issued: zod.z.boolean().nullable().describe(
|
|
3687
|
+
"Indicates whether the credential has been issued (encoded onto a card)."
|
|
3688
|
+
),
|
|
3662
3689
|
starts_at: zod.z.string().datetime().nullable().describe(
|
|
3663
3690
|
"Date and time at which the [credential](https://docs.seam.co/low-level-apis/access-systems/managing-credentials) becomes usable."
|
|
3664
3691
|
),
|
|
@@ -3953,7 +3980,9 @@ var seam_bridge_disconnected = common_acs_system_error.extend({
|
|
|
3953
3980
|
See also [Troubleshooting Your Access Control System](https://docs.seam.co/low-level-apis/access-systems/troubleshooting-your-access-control-system#acs_system.errors.seam_bridge_disconnected).`);
|
|
3954
3981
|
var bridge_disconnected2 = common_acs_system_error.extend({
|
|
3955
3982
|
error_code: zod.z.literal("bridge_disconnected").describe(error_code_description7),
|
|
3956
|
-
is_bridge_error: zod.z.boolean().optional()
|
|
3983
|
+
is_bridge_error: zod.z.boolean().optional().describe(
|
|
3984
|
+
"Indicates whether the error is related to the [Seam Bridge](https://docs.seam.co/capability-guides/seam-bridge)."
|
|
3985
|
+
)
|
|
3957
3986
|
}).describe(`Indicates that the Seam API cannot communicate with [Seam Bridge](https://docs.seam.co/capability-guides/seam-bridge), for example, if Seam Bridge executable has stopped or if the computer running the Seam Bridge executable is offline.
|
|
3958
3987
|
See also [Troubleshooting Your Access Control System](https://docs.seam.co/low-level-apis/access-systems/troubleshooting-your-access-control-system#acs_system.errors.seam_bridge_disconnected).`);
|
|
3959
3988
|
var visionline_instance_unreachable = common_acs_system_error.extend({
|
|
@@ -4055,8 +4084,12 @@ var acs_system = zod.z.object({
|
|
|
4055
4084
|
acs_system_id: zod.z.string().uuid().describe(
|
|
4056
4085
|
"ID of the [access control system](https://docs.seam.co/low-level-apis/access-systems)."
|
|
4057
4086
|
),
|
|
4058
|
-
acs_user_count: zod.z.number().optional()
|
|
4059
|
-
|
|
4087
|
+
acs_user_count: zod.z.number().optional().describe(
|
|
4088
|
+
"Number of users in the [access control system](https://docs.seam.co/low-level-apis/access-systems)."
|
|
4089
|
+
),
|
|
4090
|
+
acs_access_group_count: zod.z.number().optional().describe(
|
|
4091
|
+
"Number of access groups in the [access control system](https://docs.seam.co/low-level-apis/access-systems)."
|
|
4092
|
+
),
|
|
4060
4093
|
external_type: acs_system_external_type.describe(
|
|
4061
4094
|
"Brand-specific terminology for the [access control system](https://docs.seam.co/low-level-apis/access-systems) type."
|
|
4062
4095
|
).optional(),
|
|
@@ -4074,7 +4107,9 @@ var acs_system = zod.z.object({
|
|
|
4074
4107
|
lan_address: zod.z.string().describe(
|
|
4075
4108
|
"IP address or hostname of the main Visionline server relative to [Seam Bridge](https://docs.seam.co/capability-guides/seam-bridge) on the local network."
|
|
4076
4109
|
)
|
|
4077
|
-
}).optional()
|
|
4110
|
+
}).optional().describe(
|
|
4111
|
+
"Visionline-specific metadata for the [access control system](https://docs.seam.co/low-level-apis/access-systems)."
|
|
4112
|
+
),
|
|
4078
4113
|
system_type: acs_system_external_type.describe(
|
|
4079
4114
|
`
|
|
4080
4115
|
---
|
|
@@ -4087,7 +4122,9 @@ var acs_system = zod.z.object({
|
|
|
4087
4122
|
deprecated: Use \`external_type_display_name\`.
|
|
4088
4123
|
---
|
|
4089
4124
|
`),
|
|
4090
|
-
location: acs_location
|
|
4125
|
+
location: acs_location.describe(
|
|
4126
|
+
"Location information for the [access control system](https://docs.seam.co/low-level-apis/access-systems)."
|
|
4127
|
+
),
|
|
4091
4128
|
name: zod.z.string().describe(
|
|
4092
4129
|
"Name of the [access control system](https://docs.seam.co/low-level-apis/access-systems)."
|
|
4093
4130
|
),
|
|
@@ -4414,7 +4451,9 @@ var common_acs_user = zod.z.object({
|
|
|
4414
4451
|
acs_system_id: zod.z.string().uuid().describe(
|
|
4415
4452
|
"ID of the [access system](https://docs.seam.co/low-level-apis/access-systems) that contains the [access system user](https://docs.seam.co/low-level-apis/access-systems/user-management)."
|
|
4416
4453
|
),
|
|
4417
|
-
hid_acs_system_id: zod.z.string().uuid().optional()
|
|
4454
|
+
hid_acs_system_id: zod.z.string().uuid().optional().describe(
|
|
4455
|
+
"ID of the HID access control system associated with the user."
|
|
4456
|
+
),
|
|
4418
4457
|
workspace_id: zod.z.string().uuid().describe(
|
|
4419
4458
|
"ID of the workspace that contains the [access system user](https://docs.seam.co/low-level-apis/access-systems/user-management)."
|
|
4420
4459
|
),
|
|
@@ -4472,7 +4511,7 @@ var common_acs_user = zod.z.object({
|
|
|
4472
4511
|
}).merge(user_fields);
|
|
4473
4512
|
var acs_user = common_acs_user.merge(
|
|
4474
4513
|
zod.z.object({
|
|
4475
|
-
is_managed: zod.z.literal(true)
|
|
4514
|
+
is_managed: zod.z.literal(true).describe("Indicates whether Seam manages the access system user.")
|
|
4476
4515
|
})
|
|
4477
4516
|
).describe(`
|
|
4478
4517
|
---
|
|
@@ -5203,7 +5242,9 @@ var connect_webview = zod.z.object({
|
|
|
5203
5242
|
url: zod.z.string().url().describe(
|
|
5204
5243
|
"URL for the Connect Webview. You use the URL to display the Connect Webview flow to your user."
|
|
5205
5244
|
),
|
|
5206
|
-
device_selection_mode: connect_webview_device_selection_mode
|
|
5245
|
+
device_selection_mode: connect_webview_device_selection_mode.describe(
|
|
5246
|
+
"Device selection mode of the Connect Webview. Supported values: `none`, `single`, `multiple`."
|
|
5247
|
+
),
|
|
5207
5248
|
// TODO: Use enum value.
|
|
5208
5249
|
accepted_providers: zod.z.array(zod.z.string()).describe(
|
|
5209
5250
|
"List of accepted [provider keys](https://docs.seam.co/core-concepts/connect-webviews/customizing-connect-webviews#customize-the-brands-to-display-in-your-connect-webviews)."
|
|
@@ -5322,14 +5363,18 @@ var common_event_error = zod.z.object({
|
|
|
5322
5363
|
"Detailed description of the error. Provides insights into the issue and potentially how to rectify it."
|
|
5323
5364
|
),
|
|
5324
5365
|
error_code: zod.z.string().describe(error_code_description8)
|
|
5325
|
-
})
|
|
5366
|
+
}).describe(
|
|
5367
|
+
"Error associated with the resource, including the error code, message, and creation timestamp."
|
|
5368
|
+
);
|
|
5326
5369
|
var common_event_warning = zod.z.object({
|
|
5327
5370
|
created_at: zod.z.string().datetime().describe("Date and time at which Seam created the warning."),
|
|
5328
5371
|
message: zod.z.string().describe(
|
|
5329
5372
|
"Detailed description of the warning. Provides insights into the issue and potentially how to rectify it."
|
|
5330
5373
|
),
|
|
5331
5374
|
warning_code: zod.z.string().describe(warning_code_description10)
|
|
5332
|
-
})
|
|
5375
|
+
}).describe(
|
|
5376
|
+
"Warning associated with the resource, including the warning code, message, and creation timestamp."
|
|
5377
|
+
);
|
|
5333
5378
|
|
|
5334
5379
|
// src/lib/seam/connect/models/events/access-codes.ts
|
|
5335
5380
|
var access_code_event = common_event.extend({
|
|
@@ -5369,7 +5414,7 @@ var access_code_changed_event = access_code_event.extend({
|
|
|
5369
5414
|
property: zod.z.string().describe("Name of the property that changed (e.g. `code`)."),
|
|
5370
5415
|
from: zod.z.string().nullable().describe("Previous value of the property, or null if not set."),
|
|
5371
5416
|
to: zod.z.string().nullable().describe("New value of the property, or null if cleared.")
|
|
5372
|
-
})
|
|
5417
|
+
}).describe("Record describing a single changed property.")
|
|
5373
5418
|
).optional().describe("List of properties that changed on the access code."),
|
|
5374
5419
|
change_reason: zod.z.string().optional().describe(
|
|
5375
5420
|
"Human-readable reason for the change (e.g. `ongoing code auto-renewed`)."
|
|
@@ -5512,7 +5557,7 @@ var access_code_deleted_external_to_seam_event = access_code_event.extend({
|
|
|
5512
5557
|
`);
|
|
5513
5558
|
var access_code_backup_access_code_pulled_event = access_code_event.extend({
|
|
5514
5559
|
event_type: zod.z.literal("access_code.backup_access_code_pulled"),
|
|
5515
|
-
backup_access_code_id: zod.z.string()
|
|
5560
|
+
backup_access_code_id: zod.z.string().describe("ID of the backup access code that was pulled from the pool.")
|
|
5516
5561
|
}).describe(`
|
|
5517
5562
|
---
|
|
5518
5563
|
route_path: /access_codes
|
|
@@ -5812,8 +5857,8 @@ var acs_encoder_events = [
|
|
|
5812
5857
|
acs_encoder_removed_event
|
|
5813
5858
|
];
|
|
5814
5859
|
var acs_entrance_event = common_acs_event.extend({
|
|
5815
|
-
acs_entrance_id: zod.z.string().uuid()
|
|
5816
|
-
})
|
|
5860
|
+
acs_entrance_id: zod.z.string().uuid().describe("ID of the affected entrance.")
|
|
5861
|
+
});
|
|
5817
5862
|
var acs_entrance_added_event = acs_entrance_event.extend({
|
|
5818
5863
|
event_type: zod.z.literal("acs_entrance.added")
|
|
5819
5864
|
}).describe(`
|
|
@@ -5871,8 +5916,8 @@ var acs_system_events = [
|
|
|
5871
5916
|
acs_system_disconnected_event
|
|
5872
5917
|
];
|
|
5873
5918
|
var acs_user_event = common_acs_event.extend({
|
|
5874
|
-
acs_user_id: zod.z.string().uuid()
|
|
5875
|
-
})
|
|
5919
|
+
acs_user_id: zod.z.string().uuid().describe("ID of the affected access system user.")
|
|
5920
|
+
});
|
|
5876
5921
|
var acs_user_deleted_event = acs_user_event.extend({
|
|
5877
5922
|
event_type: zod.z.literal("acs_user.deleted")
|
|
5878
5923
|
}).describe(`
|
|
@@ -6869,8 +6914,8 @@ var user_identity = zod.z.object({
|
|
|
6869
6914
|
phone_number: loose_phone_number.nullable().describe(
|
|
6870
6915
|
"Unique phone number for the user identity in [E.164 format](https://www.itu.int/rec/T-REC-E.164/en) (for example, +15555550100)."
|
|
6871
6916
|
),
|
|
6872
|
-
display_name: zod.z.string().min(1),
|
|
6873
|
-
full_name: zod.z.string().min(1).nullable(),
|
|
6917
|
+
display_name: zod.z.string().min(1).describe("Display name for the user identity."),
|
|
6918
|
+
full_name: zod.z.string().min(1).nullable().describe("Full name of the user associated with the user identity."),
|
|
6874
6919
|
created_at: zod.z.string().datetime().describe("Date and time at which the user identity was created."),
|
|
6875
6920
|
workspace_id: zod.z.string().uuid().describe("ID of the workspace that contains the user identity."),
|
|
6876
6921
|
errors: zod.z.array(user_identity_errors).describe(
|
|
@@ -9777,7 +9822,10 @@ var openapi = {
|
|
|
9777
9822
|
format: "date-time",
|
|
9778
9823
|
type: "string"
|
|
9779
9824
|
},
|
|
9780
|
-
display_name: {
|
|
9825
|
+
display_name: {
|
|
9826
|
+
description: "Display name for the access group.",
|
|
9827
|
+
type: "string"
|
|
9828
|
+
},
|
|
9781
9829
|
errors: {
|
|
9782
9830
|
description: "Errors associated with the `acs_access_group`.",
|
|
9783
9831
|
items: {
|
|
@@ -9827,7 +9875,11 @@ var openapi = {
|
|
|
9827
9875
|
description: "Display name that corresponds to the brand-specific terminology for the access group type.",
|
|
9828
9876
|
type: "string"
|
|
9829
9877
|
},
|
|
9830
|
-
is_managed: {
|
|
9878
|
+
is_managed: {
|
|
9879
|
+
description: "Indicates whether Seam manages the access group.",
|
|
9880
|
+
enum: [true],
|
|
9881
|
+
type: "boolean"
|
|
9882
|
+
},
|
|
9831
9883
|
name: { description: "Name of the access group.", type: "string" },
|
|
9832
9884
|
pending_mutations: {
|
|
9833
9885
|
description: "Collection of pending mutations for the access group. Represents operations that have been requested but not yet completed on the integrated access system.",
|
|
@@ -10248,7 +10300,11 @@ var openapi = {
|
|
|
10248
10300
|
format: "uuid",
|
|
10249
10301
|
type: "string"
|
|
10250
10302
|
},
|
|
10251
|
-
acs_credential_pool_id: {
|
|
10303
|
+
acs_credential_pool_id: {
|
|
10304
|
+
description: "ID of the credential pool to which the credential belongs.",
|
|
10305
|
+
format: "uuid",
|
|
10306
|
+
type: "string"
|
|
10307
|
+
},
|
|
10252
10308
|
acs_system_id: {
|
|
10253
10309
|
description: "ID of the [access control system](https://docs.seam.co/low-level-apis/access-systems) that contains the [credential](https://docs.seam.co/low-level-apis/access-systems/managing-credentials).",
|
|
10254
10310
|
format: "uuid",
|
|
@@ -10363,7 +10419,11 @@ var openapi = {
|
|
|
10363
10419
|
nullable: true,
|
|
10364
10420
|
type: "boolean"
|
|
10365
10421
|
},
|
|
10366
|
-
is_managed: {
|
|
10422
|
+
is_managed: {
|
|
10423
|
+
description: "Indicates whether Seam manages the credential.",
|
|
10424
|
+
enum: [true],
|
|
10425
|
+
type: "boolean"
|
|
10426
|
+
},
|
|
10367
10427
|
is_multi_phone_sync_credential: {
|
|
10368
10428
|
description: "Indicates whether the [credential](https://docs.seam.co/low-level-apis/access-systems/managing-credentials) is a [multi-phone sync credential](https://docs.seam.co/capability-guides/mobile-access/issuing-mobile-credentials-from-an-access-control-system#what-are-multi-phone-sync-credentials).",
|
|
10369
10429
|
type: "boolean"
|
|
@@ -11183,13 +11243,21 @@ var openapi = {
|
|
|
11183
11243
|
acs_system: {
|
|
11184
11244
|
description: "Represents an [access control system](https://docs.seam.co/low-level-apis/access-systems).\n\nWithin an `acs_system`, create [`acs_user`s](https://docs.seam.co/api/acs/users#acs_user) and [`acs_credential`s](https://docs.seam.co/api/acs/credentials#acs_credential) to grant access to the `acs_user`s.\n\nFor details about the resources associated with an access control system, see the [access control systems namespace](https://docs.seam.co/api/acs).",
|
|
11185
11245
|
properties: {
|
|
11186
|
-
acs_access_group_count: {
|
|
11246
|
+
acs_access_group_count: {
|
|
11247
|
+
description: "Number of access groups in the [access control system](https://docs.seam.co/low-level-apis/access-systems).",
|
|
11248
|
+
format: "float",
|
|
11249
|
+
type: "number"
|
|
11250
|
+
},
|
|
11187
11251
|
acs_system_id: {
|
|
11188
11252
|
description: "ID of the [access control system](https://docs.seam.co/low-level-apis/access-systems).",
|
|
11189
11253
|
format: "uuid",
|
|
11190
11254
|
type: "string"
|
|
11191
11255
|
},
|
|
11192
|
-
acs_user_count: {
|
|
11256
|
+
acs_user_count: {
|
|
11257
|
+
description: "Number of users in the [access control system](https://docs.seam.co/low-level-apis/access-systems).",
|
|
11258
|
+
format: "float",
|
|
11259
|
+
type: "number"
|
|
11260
|
+
},
|
|
11193
11261
|
connected_account_id: {
|
|
11194
11262
|
description: "ID of the connected account associated with the [access control system](https://docs.seam.co/low-level-apis/access-systems).",
|
|
11195
11263
|
format: "uuid",
|
|
@@ -11253,7 +11321,10 @@ var openapi = {
|
|
|
11253
11321
|
enum: ["bridge_disconnected"],
|
|
11254
11322
|
type: "string"
|
|
11255
11323
|
},
|
|
11256
|
-
is_bridge_error: {
|
|
11324
|
+
is_bridge_error: {
|
|
11325
|
+
description: "Indicates whether the error is related to the [Seam Bridge](https://docs.seam.co/capability-guides/seam-bridge).",
|
|
11326
|
+
type: "boolean"
|
|
11327
|
+
},
|
|
11257
11328
|
message: {
|
|
11258
11329
|
description: "Detailed description of the error. Provides insights into the issue and potentially how to rectify it.",
|
|
11259
11330
|
type: "string"
|
|
@@ -11430,6 +11501,7 @@ var openapi = {
|
|
|
11430
11501
|
type: "boolean"
|
|
11431
11502
|
},
|
|
11432
11503
|
location: {
|
|
11504
|
+
description: "Location information for the [access control system](https://docs.seam.co/low-level-apis/access-systems).",
|
|
11433
11505
|
properties: {
|
|
11434
11506
|
time_zone: {
|
|
11435
11507
|
description: "Time zone in which the [access control system](https://docs.seam.co/low-level-apis/access-systems) is located.",
|
|
@@ -11472,6 +11544,7 @@ var openapi = {
|
|
|
11472
11544
|
"x-deprecated": "Use `external_type_display_name`."
|
|
11473
11545
|
},
|
|
11474
11546
|
visionline_metadata: {
|
|
11547
|
+
description: "Visionline-specific metadata for the [access control system](https://docs.seam.co/low-level-apis/access-systems).",
|
|
11475
11548
|
properties: {
|
|
11476
11549
|
lan_address: {
|
|
11477
11550
|
description: "IP address or hostname of the main Visionline server relative to [Seam Bridge](https://docs.seam.co/capability-guides/seam-bridge) on the local network.",
|
|
@@ -11800,8 +11873,16 @@ var openapi = {
|
|
|
11800
11873
|
minLength: 1,
|
|
11801
11874
|
type: "string"
|
|
11802
11875
|
},
|
|
11803
|
-
hid_acs_system_id: {
|
|
11804
|
-
|
|
11876
|
+
hid_acs_system_id: {
|
|
11877
|
+
description: "ID of the HID access control system associated with the user.",
|
|
11878
|
+
format: "uuid",
|
|
11879
|
+
type: "string"
|
|
11880
|
+
},
|
|
11881
|
+
is_managed: {
|
|
11882
|
+
description: "Indicates whether Seam manages the access system user.",
|
|
11883
|
+
enum: [true],
|
|
11884
|
+
type: "boolean"
|
|
11885
|
+
},
|
|
11805
11886
|
is_suspended: {
|
|
11806
11887
|
description: "Indicates whether the [access system user](https://docs.seam.co/low-level-apis/access-systems/user-management) is currently [suspended](https://docs.seam.co/low-level-apis/access-systems/user-management/suspending-and-unsuspending-users).",
|
|
11807
11888
|
type: "boolean"
|
|
@@ -12649,7 +12730,11 @@ var openapi = {
|
|
|
12649
12730
|
nullable: true,
|
|
12650
12731
|
type: "string"
|
|
12651
12732
|
},
|
|
12652
|
-
is_issued: {
|
|
12733
|
+
is_issued: {
|
|
12734
|
+
description: "Indicates whether the credential has been issued (encoded onto a card).",
|
|
12735
|
+
nullable: true,
|
|
12736
|
+
type: "boolean"
|
|
12737
|
+
},
|
|
12653
12738
|
starts_at: {
|
|
12654
12739
|
description: "Date and time at which the [credential](https://docs.seam.co/low-level-apis/access-systems/managing-credentials) becomes usable.",
|
|
12655
12740
|
format: "date-time",
|
|
@@ -12752,6 +12837,7 @@ var openapi = {
|
|
|
12752
12837
|
type: "string"
|
|
12753
12838
|
},
|
|
12754
12839
|
acs_credential_pool_id: {
|
|
12840
|
+
description: "ID of the credential pool to which the credential belongs.",
|
|
12755
12841
|
format: "uuid",
|
|
12756
12842
|
type: "string"
|
|
12757
12843
|
},
|
|
@@ -12869,7 +12955,11 @@ var openapi = {
|
|
|
12869
12955
|
nullable: true,
|
|
12870
12956
|
type: "boolean"
|
|
12871
12957
|
},
|
|
12872
|
-
is_managed: {
|
|
12958
|
+
is_managed: {
|
|
12959
|
+
description: "Indicates whether Seam manages the credential.",
|
|
12960
|
+
enum: [true],
|
|
12961
|
+
type: "boolean"
|
|
12962
|
+
},
|
|
12873
12963
|
is_multi_phone_sync_credential: {
|
|
12874
12964
|
description: "Indicates whether the [credential](https://docs.seam.co/low-level-apis/access-systems/managing-credentials) is a [multi-phone sync credential](https://docs.seam.co/capability-guides/mobile-access/issuing-mobile-credentials-from-an-access-control-system#what-are-multi-phone-sync-credentials).",
|
|
12875
12965
|
type: "boolean"
|
|
@@ -13144,6 +13234,7 @@ var openapi = {
|
|
|
13144
13234
|
type: "string"
|
|
13145
13235
|
},
|
|
13146
13236
|
acs_credential_pool_id: {
|
|
13237
|
+
description: "ID of the credential pool to which the credential belongs.",
|
|
13147
13238
|
format: "uuid",
|
|
13148
13239
|
type: "string"
|
|
13149
13240
|
},
|
|
@@ -13762,6 +13853,7 @@ var openapi = {
|
|
|
13762
13853
|
type: "string"
|
|
13763
13854
|
},
|
|
13764
13855
|
acs_credential_pool_id: {
|
|
13856
|
+
description: "ID of the credential pool to which the credential belongs.",
|
|
13765
13857
|
format: "uuid",
|
|
13766
13858
|
type: "string"
|
|
13767
13859
|
},
|
|
@@ -13879,7 +13971,11 @@ var openapi = {
|
|
|
13879
13971
|
nullable: true,
|
|
13880
13972
|
type: "boolean"
|
|
13881
13973
|
},
|
|
13882
|
-
is_managed: {
|
|
13974
|
+
is_managed: {
|
|
13975
|
+
description: "Indicates whether Seam manages the credential.",
|
|
13976
|
+
enum: [true],
|
|
13977
|
+
type: "boolean"
|
|
13978
|
+
},
|
|
13883
13979
|
is_multi_phone_sync_credential: {
|
|
13884
13980
|
description: "Indicates whether the [credential](https://docs.seam.co/low-level-apis/access-systems/managing-credentials) is a [multi-phone sync credential](https://docs.seam.co/capability-guides/mobile-access/issuing-mobile-credentials-from-an-access-control-system#what-are-multi-phone-sync-credentials).",
|
|
13885
13981
|
type: "boolean"
|
|
@@ -14152,6 +14248,7 @@ var openapi = {
|
|
|
14152
14248
|
type: "string"
|
|
14153
14249
|
},
|
|
14154
14250
|
acs_credential_pool_id: {
|
|
14251
|
+
description: "ID of the credential pool to which the credential belongs.",
|
|
14155
14252
|
format: "uuid",
|
|
14156
14253
|
type: "string"
|
|
14157
14254
|
},
|
|
@@ -14796,7 +14893,11 @@ var openapi = {
|
|
|
14796
14893
|
format: "uuid",
|
|
14797
14894
|
type: "string"
|
|
14798
14895
|
},
|
|
14799
|
-
acs_credential_pool_id: {
|
|
14896
|
+
acs_credential_pool_id: {
|
|
14897
|
+
description: "ID of the credential pool to which the credential belongs.",
|
|
14898
|
+
format: "uuid",
|
|
14899
|
+
type: "string"
|
|
14900
|
+
},
|
|
14800
14901
|
acs_system_id: {
|
|
14801
14902
|
description: "ID of the [access control system](https://docs.seam.co/low-level-apis/access-systems) that contains the [credential](https://docs.seam.co/low-level-apis/access-systems/managing-credentials).",
|
|
14802
14903
|
format: "uuid",
|
|
@@ -14911,7 +15012,11 @@ var openapi = {
|
|
|
14911
15012
|
nullable: true,
|
|
14912
15013
|
type: "boolean"
|
|
14913
15014
|
},
|
|
14914
|
-
is_managed: {
|
|
15015
|
+
is_managed: {
|
|
15016
|
+
description: "Indicates whether Seam manages the credential.",
|
|
15017
|
+
enum: [true],
|
|
15018
|
+
type: "boolean"
|
|
15019
|
+
},
|
|
14915
15020
|
is_multi_phone_sync_credential: {
|
|
14916
15021
|
description: "Indicates whether the [credential](https://docs.seam.co/low-level-apis/access-systems/managing-credentials) is a [multi-phone sync credential](https://docs.seam.co/capability-guides/mobile-access/issuing-mobile-credentials-from-an-access-control-system#what-are-multi-phone-sync-credentials).",
|
|
14917
15022
|
type: "boolean"
|
|
@@ -17797,6 +17902,7 @@ var openapi = {
|
|
|
17797
17902
|
type: "string"
|
|
17798
17903
|
},
|
|
17799
17904
|
device_selection_mode: {
|
|
17905
|
+
description: "Device selection mode of the Connect Webview. Supported values: `none`, `single`, `multiple`.",
|
|
17800
17906
|
enum: ["none", "single", "multiple"],
|
|
17801
17907
|
type: "string"
|
|
17802
17908
|
},
|
|
@@ -18475,30 +18581,86 @@ var openapi = {
|
|
|
18475
18581
|
device: {
|
|
18476
18582
|
description: "Represents a [device](https://docs.seam.co/core-concepts/devices) that has been connected to Seam.",
|
|
18477
18583
|
properties: {
|
|
18478
|
-
can_configure_auto_lock: {
|
|
18479
|
-
|
|
18480
|
-
|
|
18481
|
-
|
|
18482
|
-
|
|
18483
|
-
|
|
18584
|
+
can_configure_auto_lock: {
|
|
18585
|
+
description: "Indicates whether the lock supports configuring automatic locking.",
|
|
18586
|
+
type: "boolean"
|
|
18587
|
+
},
|
|
18588
|
+
can_hvac_cool: {
|
|
18589
|
+
description: "Indicates whether the thermostat supports cooling.",
|
|
18590
|
+
type: "boolean"
|
|
18591
|
+
},
|
|
18592
|
+
can_hvac_heat: {
|
|
18593
|
+
description: "Indicates whether the thermostat supports heating.",
|
|
18594
|
+
type: "boolean"
|
|
18595
|
+
},
|
|
18596
|
+
can_hvac_heat_cool: {
|
|
18597
|
+
description: "Indicates whether the thermostat supports simultaneous heating and cooling.",
|
|
18598
|
+
type: "boolean"
|
|
18599
|
+
},
|
|
18600
|
+
can_program_offline_access_codes: {
|
|
18601
|
+
description: "Indicates whether the device supports programming offline access codes.",
|
|
18602
|
+
type: "boolean"
|
|
18603
|
+
},
|
|
18604
|
+
can_program_online_access_codes: {
|
|
18605
|
+
description: "Indicates whether the device supports programming online access codes.",
|
|
18606
|
+
type: "boolean"
|
|
18607
|
+
},
|
|
18484
18608
|
can_program_thermostat_programs_as_different_each_day: {
|
|
18609
|
+
description: "Indicates whether the thermostat supports different climate programs for each day of the week.",
|
|
18610
|
+
type: "boolean"
|
|
18611
|
+
},
|
|
18612
|
+
can_program_thermostat_programs_as_same_each_day: {
|
|
18613
|
+
description: "Indicates whether the thermostat supports a single climate program applied to every day.",
|
|
18485
18614
|
type: "boolean"
|
|
18486
18615
|
},
|
|
18487
|
-
can_program_thermostat_programs_as_same_each_day: { type: "boolean" },
|
|
18488
18616
|
can_program_thermostat_programs_as_weekday_weekend: {
|
|
18617
|
+
description: "Indicates whether the thermostat supports weekday/weekend climate programs.",
|
|
18618
|
+
type: "boolean"
|
|
18619
|
+
},
|
|
18620
|
+
can_remotely_lock: {
|
|
18621
|
+
description: "Indicates whether the device supports remote locking.",
|
|
18622
|
+
type: "boolean"
|
|
18623
|
+
},
|
|
18624
|
+
can_remotely_unlock: {
|
|
18625
|
+
description: "Indicates whether the device supports remote unlocking.",
|
|
18626
|
+
type: "boolean"
|
|
18627
|
+
},
|
|
18628
|
+
can_run_thermostat_programs: {
|
|
18629
|
+
description: "Indicates whether the thermostat supports running climate programs.",
|
|
18630
|
+
type: "boolean"
|
|
18631
|
+
},
|
|
18632
|
+
can_simulate_connection: {
|
|
18633
|
+
description: "Indicates whether the device supports simulating connection in a sandbox.",
|
|
18634
|
+
type: "boolean"
|
|
18635
|
+
},
|
|
18636
|
+
can_simulate_disconnection: {
|
|
18637
|
+
description: "Indicates whether the device supports simulating disconnection in a sandbox.",
|
|
18638
|
+
type: "boolean"
|
|
18639
|
+
},
|
|
18640
|
+
can_simulate_hub_connection: {
|
|
18641
|
+
description: "Indicates whether the hub supports simulating connection in a sandbox.",
|
|
18642
|
+
type: "boolean"
|
|
18643
|
+
},
|
|
18644
|
+
can_simulate_hub_disconnection: {
|
|
18645
|
+
description: "Indicates whether the hub supports simulating disconnection in a sandbox.",
|
|
18646
|
+
type: "boolean"
|
|
18647
|
+
},
|
|
18648
|
+
can_simulate_paid_subscription: {
|
|
18649
|
+
description: "Indicates whether the device supports simulating a paid subscription in a sandbox.",
|
|
18650
|
+
type: "boolean"
|
|
18651
|
+
},
|
|
18652
|
+
can_simulate_removal: {
|
|
18653
|
+
description: "Indicates whether the device supports simulating removal in a sandbox.",
|
|
18654
|
+
type: "boolean"
|
|
18655
|
+
},
|
|
18656
|
+
can_turn_off_hvac: {
|
|
18657
|
+
description: "Indicates whether the thermostat can be turned off.",
|
|
18658
|
+
type: "boolean"
|
|
18659
|
+
},
|
|
18660
|
+
can_unlock_with_code: {
|
|
18661
|
+
description: "Indicates whether the lock supports unlocking with an access code.",
|
|
18489
18662
|
type: "boolean"
|
|
18490
18663
|
},
|
|
18491
|
-
can_remotely_lock: { type: "boolean" },
|
|
18492
|
-
can_remotely_unlock: { type: "boolean" },
|
|
18493
|
-
can_run_thermostat_programs: { type: "boolean" },
|
|
18494
|
-
can_simulate_connection: { type: "boolean" },
|
|
18495
|
-
can_simulate_disconnection: { type: "boolean" },
|
|
18496
|
-
can_simulate_hub_connection: { type: "boolean" },
|
|
18497
|
-
can_simulate_hub_disconnection: { type: "boolean" },
|
|
18498
|
-
can_simulate_paid_subscription: { type: "boolean" },
|
|
18499
|
-
can_simulate_removal: { type: "boolean" },
|
|
18500
|
-
can_turn_off_hvac: { type: "boolean" },
|
|
18501
|
-
can_unlock_with_code: { type: "boolean" },
|
|
18502
18664
|
capabilities_supported: {
|
|
18503
18665
|
description: "\n 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://docs.seam.co/capability-guides/device-and-system-capabilities#capability-flags).\n ",
|
|
18504
18666
|
items: {
|
|
@@ -20970,6 +21132,7 @@ var openapi = {
|
|
|
20970
21132
|
available_climate_preset_modes: {
|
|
20971
21133
|
description: 'Climate preset modes that the thermostat supports, such as "home", "away", "wake", "sleep", "occupied", and "unoccupied".',
|
|
20972
21134
|
items: {
|
|
21135
|
+
description: "Climate preset mode for the thermostat, such as `home`, `away`, `wake`, `sleep`, `occupied`, or `unoccupied`.",
|
|
20973
21136
|
enum: [
|
|
20974
21137
|
"home",
|
|
20975
21138
|
"away",
|
|
@@ -21103,6 +21266,7 @@ var openapi = {
|
|
|
21103
21266
|
available_fan_mode_settings: {
|
|
21104
21267
|
description: "Fan mode settings that the thermostat supports.",
|
|
21105
21268
|
items: {
|
|
21269
|
+
description: "Fan mode setting for the thermostat, such as `auto`, `on`, or `circulate`.",
|
|
21106
21270
|
enum: ["auto", "on", "circulate"],
|
|
21107
21271
|
type: "string"
|
|
21108
21272
|
},
|
|
@@ -21112,6 +21276,7 @@ var openapi = {
|
|
|
21112
21276
|
available_hvac_mode_settings: {
|
|
21113
21277
|
description: "HVAC mode settings that the thermostat supports.",
|
|
21114
21278
|
items: {
|
|
21279
|
+
description: "HVAC mode setting for the thermostat, such as `heat`, `cool`, `heat_cool`, `eco`, or `off`.",
|
|
21115
21280
|
enum: ["off", "heat", "cool", "heat_cool", "eco"],
|
|
21116
21281
|
type: "string"
|
|
21117
21282
|
},
|
|
@@ -22276,31 +22441,88 @@ var openapi = {
|
|
|
22276
22441
|
},
|
|
22277
22442
|
device_provider: {
|
|
22278
22443
|
properties: {
|
|
22279
|
-
can_configure_auto_lock: {
|
|
22280
|
-
|
|
22281
|
-
|
|
22282
|
-
|
|
22283
|
-
|
|
22284
|
-
|
|
22444
|
+
can_configure_auto_lock: {
|
|
22445
|
+
description: "Indicates whether the lock supports configuring automatic locking.",
|
|
22446
|
+
type: "boolean"
|
|
22447
|
+
},
|
|
22448
|
+
can_hvac_cool: {
|
|
22449
|
+
description: "Indicates whether the thermostat supports cooling.",
|
|
22450
|
+
type: "boolean"
|
|
22451
|
+
},
|
|
22452
|
+
can_hvac_heat: {
|
|
22453
|
+
description: "Indicates whether the thermostat supports heating.",
|
|
22454
|
+
type: "boolean"
|
|
22455
|
+
},
|
|
22456
|
+
can_hvac_heat_cool: {
|
|
22457
|
+
description: "Indicates whether the thermostat supports simultaneous heating and cooling.",
|
|
22458
|
+
type: "boolean"
|
|
22459
|
+
},
|
|
22460
|
+
can_program_offline_access_codes: {
|
|
22461
|
+
description: "Indicates whether the device supports programming offline access codes.",
|
|
22462
|
+
type: "boolean"
|
|
22463
|
+
},
|
|
22464
|
+
can_program_online_access_codes: {
|
|
22465
|
+
description: "Indicates whether the device supports programming online access codes.",
|
|
22466
|
+
type: "boolean"
|
|
22467
|
+
},
|
|
22285
22468
|
can_program_thermostat_programs_as_different_each_day: {
|
|
22469
|
+
description: "Indicates whether the thermostat supports different climate programs for each day of the week.",
|
|
22470
|
+
type: "boolean"
|
|
22471
|
+
},
|
|
22472
|
+
can_program_thermostat_programs_as_same_each_day: {
|
|
22473
|
+
description: "Indicates whether the thermostat supports a single climate program applied to every day.",
|
|
22286
22474
|
type: "boolean"
|
|
22287
22475
|
},
|
|
22288
|
-
can_program_thermostat_programs_as_same_each_day: { type: "boolean" },
|
|
22289
22476
|
can_program_thermostat_programs_as_weekday_weekend: {
|
|
22477
|
+
description: "Indicates whether the thermostat supports weekday/weekend climate programs.",
|
|
22478
|
+
type: "boolean"
|
|
22479
|
+
},
|
|
22480
|
+
can_remotely_lock: {
|
|
22481
|
+
description: "Indicates whether the device supports remote locking.",
|
|
22482
|
+
type: "boolean"
|
|
22483
|
+
},
|
|
22484
|
+
can_remotely_unlock: {
|
|
22485
|
+
description: "Indicates whether the device supports remote unlocking.",
|
|
22486
|
+
type: "boolean"
|
|
22487
|
+
},
|
|
22488
|
+
can_run_thermostat_programs: {
|
|
22489
|
+
description: "Indicates whether the thermostat supports running climate programs.",
|
|
22490
|
+
type: "boolean"
|
|
22491
|
+
},
|
|
22492
|
+
can_simulate_connection: {
|
|
22493
|
+
description: "Indicates whether the device supports simulating connection in a sandbox.",
|
|
22494
|
+
type: "boolean"
|
|
22495
|
+
},
|
|
22496
|
+
can_simulate_disconnection: {
|
|
22497
|
+
description: "Indicates whether the device supports simulating disconnection in a sandbox.",
|
|
22498
|
+
type: "boolean"
|
|
22499
|
+
},
|
|
22500
|
+
can_simulate_hub_connection: {
|
|
22501
|
+
description: "Indicates whether the hub supports simulating connection in a sandbox.",
|
|
22502
|
+
type: "boolean"
|
|
22503
|
+
},
|
|
22504
|
+
can_simulate_hub_disconnection: {
|
|
22505
|
+
description: "Indicates whether the hub supports simulating disconnection in a sandbox.",
|
|
22506
|
+
type: "boolean"
|
|
22507
|
+
},
|
|
22508
|
+
can_simulate_paid_subscription: {
|
|
22509
|
+
description: "Indicates whether the device supports simulating a paid subscription in a sandbox.",
|
|
22510
|
+
type: "boolean"
|
|
22511
|
+
},
|
|
22512
|
+
can_simulate_removal: {
|
|
22513
|
+
description: "Indicates whether the device supports simulating removal in a sandbox.",
|
|
22514
|
+
type: "boolean"
|
|
22515
|
+
},
|
|
22516
|
+
can_turn_off_hvac: {
|
|
22517
|
+
description: "Indicates whether the thermostat can be turned off.",
|
|
22518
|
+
type: "boolean"
|
|
22519
|
+
},
|
|
22520
|
+
can_unlock_with_code: {
|
|
22521
|
+
description: "Indicates whether the lock supports unlocking with an access code.",
|
|
22290
22522
|
type: "boolean"
|
|
22291
22523
|
},
|
|
22292
|
-
can_remotely_lock: { type: "boolean" },
|
|
22293
|
-
can_remotely_unlock: { type: "boolean" },
|
|
22294
|
-
can_run_thermostat_programs: { type: "boolean" },
|
|
22295
|
-
can_simulate_connection: { type: "boolean" },
|
|
22296
|
-
can_simulate_disconnection: { type: "boolean" },
|
|
22297
|
-
can_simulate_hub_connection: { type: "boolean" },
|
|
22298
|
-
can_simulate_hub_disconnection: { type: "boolean" },
|
|
22299
|
-
can_simulate_paid_subscription: { type: "boolean" },
|
|
22300
|
-
can_simulate_removal: { type: "boolean" },
|
|
22301
|
-
can_turn_off_hvac: { type: "boolean" },
|
|
22302
|
-
can_unlock_with_code: { type: "boolean" },
|
|
22303
22524
|
device_provider_name: {
|
|
22525
|
+
description: "Name of the device provider.",
|
|
22304
22526
|
enum: [
|
|
22305
22527
|
"hotek",
|
|
22306
22528
|
"dormakaba_community",
|
|
@@ -22365,9 +22587,16 @@ var openapi = {
|
|
|
22365
22587
|
],
|
|
22366
22588
|
type: "string"
|
|
22367
22589
|
},
|
|
22368
|
-
display_name: {
|
|
22369
|
-
|
|
22590
|
+
display_name: {
|
|
22591
|
+
description: "Display name for the device provider.",
|
|
22592
|
+
type: "string"
|
|
22593
|
+
},
|
|
22594
|
+
image_url: {
|
|
22595
|
+
description: "Image URL for the device provider.",
|
|
22596
|
+
type: "string"
|
|
22597
|
+
},
|
|
22370
22598
|
provider_categories: {
|
|
22599
|
+
description: "List of provider categories to which the device provider belongs, such as `stable`, `consumer_smartlocks`, `thermostats`, and so on.",
|
|
22371
22600
|
items: {
|
|
22372
22601
|
enum: [
|
|
22373
22602
|
"stable",
|
|
@@ -22519,6 +22748,7 @@ var openapi = {
|
|
|
22519
22748
|
changed_properties: {
|
|
22520
22749
|
description: "List of properties that changed on the access code.",
|
|
22521
22750
|
items: {
|
|
22751
|
+
description: "Record describing a single changed property.",
|
|
22522
22752
|
properties: {
|
|
22523
22753
|
from: {
|
|
22524
22754
|
description: "Previous value of the property, or null if not set.",
|
|
@@ -23138,6 +23368,7 @@ var openapi = {
|
|
|
23138
23368
|
access_code_errors: {
|
|
23139
23369
|
description: "Errors associated with the access code.",
|
|
23140
23370
|
items: {
|
|
23371
|
+
description: "Error associated with the resource, including the error code, message, and creation timestamp.",
|
|
23141
23372
|
properties: {
|
|
23142
23373
|
created_at: {
|
|
23143
23374
|
description: "Date and time at which Seam created the error.",
|
|
@@ -23166,6 +23397,7 @@ var openapi = {
|
|
|
23166
23397
|
access_code_warnings: {
|
|
23167
23398
|
description: "Warnings associated with the access code.",
|
|
23168
23399
|
items: {
|
|
23400
|
+
description: "Warning associated with the resource, including the warning code, message, and creation timestamp.",
|
|
23169
23401
|
properties: {
|
|
23170
23402
|
created_at: {
|
|
23171
23403
|
description: "Date and time at which Seam created the warning.",
|
|
@@ -23196,6 +23428,7 @@ var openapi = {
|
|
|
23196
23428
|
connected_account_errors: {
|
|
23197
23429
|
description: "Errors associated with the connected account.",
|
|
23198
23430
|
items: {
|
|
23431
|
+
description: "Error associated with the resource, including the error code, message, and creation timestamp.",
|
|
23199
23432
|
properties: {
|
|
23200
23433
|
created_at: {
|
|
23201
23434
|
description: "Date and time at which Seam created the error.",
|
|
@@ -23224,6 +23457,7 @@ var openapi = {
|
|
|
23224
23457
|
connected_account_warnings: {
|
|
23225
23458
|
description: "Warnings associated with the connected account.",
|
|
23226
23459
|
items: {
|
|
23460
|
+
description: "Warning associated with the resource, including the warning code, message, and creation timestamp.",
|
|
23227
23461
|
properties: {
|
|
23228
23462
|
created_at: {
|
|
23229
23463
|
description: "Date and time at which Seam created the warning.",
|
|
@@ -23259,6 +23493,7 @@ var openapi = {
|
|
|
23259
23493
|
device_errors: {
|
|
23260
23494
|
description: "Errors associated with the device.",
|
|
23261
23495
|
items: {
|
|
23496
|
+
description: "Error associated with the resource, including the error code, message, and creation timestamp.",
|
|
23262
23497
|
properties: {
|
|
23263
23498
|
created_at: {
|
|
23264
23499
|
description: "Date and time at which Seam created the error.",
|
|
@@ -23287,6 +23522,7 @@ var openapi = {
|
|
|
23287
23522
|
device_warnings: {
|
|
23288
23523
|
description: "Warnings associated with the device.",
|
|
23289
23524
|
items: {
|
|
23525
|
+
description: "Warning associated with the resource, including the warning code, message, and creation timestamp.",
|
|
23290
23526
|
properties: {
|
|
23291
23527
|
created_at: {
|
|
23292
23528
|
description: "Date and time at which Seam created the warning.",
|
|
@@ -23352,6 +23588,7 @@ var openapi = {
|
|
|
23352
23588
|
access_code_errors: {
|
|
23353
23589
|
description: "Errors associated with the access code.",
|
|
23354
23590
|
items: {
|
|
23591
|
+
description: "Error associated with the resource, including the error code, message, and creation timestamp.",
|
|
23355
23592
|
properties: {
|
|
23356
23593
|
created_at: {
|
|
23357
23594
|
description: "Date and time at which Seam created the error.",
|
|
@@ -23380,6 +23617,7 @@ var openapi = {
|
|
|
23380
23617
|
access_code_warnings: {
|
|
23381
23618
|
description: "Warnings associated with the access code.",
|
|
23382
23619
|
items: {
|
|
23620
|
+
description: "Warning associated with the resource, including the warning code, message, and creation timestamp.",
|
|
23383
23621
|
properties: {
|
|
23384
23622
|
created_at: {
|
|
23385
23623
|
description: "Date and time at which Seam created the warning.",
|
|
@@ -23410,6 +23648,7 @@ var openapi = {
|
|
|
23410
23648
|
connected_account_errors: {
|
|
23411
23649
|
description: "Errors associated with the connected account.",
|
|
23412
23650
|
items: {
|
|
23651
|
+
description: "Error associated with the resource, including the error code, message, and creation timestamp.",
|
|
23413
23652
|
properties: {
|
|
23414
23653
|
created_at: {
|
|
23415
23654
|
description: "Date and time at which Seam created the error.",
|
|
@@ -23438,6 +23677,7 @@ var openapi = {
|
|
|
23438
23677
|
connected_account_warnings: {
|
|
23439
23678
|
description: "Warnings associated with the connected account.",
|
|
23440
23679
|
items: {
|
|
23680
|
+
description: "Warning associated with the resource, including the warning code, message, and creation timestamp.",
|
|
23441
23681
|
properties: {
|
|
23442
23682
|
created_at: {
|
|
23443
23683
|
description: "Date and time at which Seam created the warning.",
|
|
@@ -23473,6 +23713,7 @@ var openapi = {
|
|
|
23473
23713
|
device_errors: {
|
|
23474
23714
|
description: "Errors associated with the device.",
|
|
23475
23715
|
items: {
|
|
23716
|
+
description: "Error associated with the resource, including the error code, message, and creation timestamp.",
|
|
23476
23717
|
properties: {
|
|
23477
23718
|
created_at: {
|
|
23478
23719
|
description: "Date and time at which Seam created the error.",
|
|
@@ -23501,6 +23742,7 @@ var openapi = {
|
|
|
23501
23742
|
device_warnings: {
|
|
23502
23743
|
description: "Warnings associated with the device.",
|
|
23503
23744
|
items: {
|
|
23745
|
+
description: "Warning associated with the resource, including the warning code, message, and creation timestamp.",
|
|
23504
23746
|
properties: {
|
|
23505
23747
|
created_at: {
|
|
23506
23748
|
description: "Date and time at which Seam created the warning.",
|
|
@@ -23639,6 +23881,7 @@ var openapi = {
|
|
|
23639
23881
|
access_code_errors: {
|
|
23640
23882
|
description: "Errors associated with the access code.",
|
|
23641
23883
|
items: {
|
|
23884
|
+
description: "Error associated with the resource, including the error code, message, and creation timestamp.",
|
|
23642
23885
|
properties: {
|
|
23643
23886
|
created_at: {
|
|
23644
23887
|
description: "Date and time at which Seam created the error.",
|
|
@@ -23667,6 +23910,7 @@ var openapi = {
|
|
|
23667
23910
|
access_code_warnings: {
|
|
23668
23911
|
description: "Warnings associated with the access code.",
|
|
23669
23912
|
items: {
|
|
23913
|
+
description: "Warning associated with the resource, including the warning code, message, and creation timestamp.",
|
|
23670
23914
|
properties: {
|
|
23671
23915
|
created_at: {
|
|
23672
23916
|
description: "Date and time at which Seam created the warning.",
|
|
@@ -23697,6 +23941,7 @@ var openapi = {
|
|
|
23697
23941
|
connected_account_errors: {
|
|
23698
23942
|
description: "Errors associated with the connected account.",
|
|
23699
23943
|
items: {
|
|
23944
|
+
description: "Error associated with the resource, including the error code, message, and creation timestamp.",
|
|
23700
23945
|
properties: {
|
|
23701
23946
|
created_at: {
|
|
23702
23947
|
description: "Date and time at which Seam created the error.",
|
|
@@ -23725,6 +23970,7 @@ var openapi = {
|
|
|
23725
23970
|
connected_account_warnings: {
|
|
23726
23971
|
description: "Warnings associated with the connected account.",
|
|
23727
23972
|
items: {
|
|
23973
|
+
description: "Warning associated with the resource, including the warning code, message, and creation timestamp.",
|
|
23728
23974
|
properties: {
|
|
23729
23975
|
created_at: {
|
|
23730
23976
|
description: "Date and time at which Seam created the warning.",
|
|
@@ -23760,6 +24006,7 @@ var openapi = {
|
|
|
23760
24006
|
device_errors: {
|
|
23761
24007
|
description: "Errors associated with the device.",
|
|
23762
24008
|
items: {
|
|
24009
|
+
description: "Error associated with the resource, including the error code, message, and creation timestamp.",
|
|
23763
24010
|
properties: {
|
|
23764
24011
|
created_at: {
|
|
23765
24012
|
description: "Date and time at which Seam created the error.",
|
|
@@ -23788,6 +24035,7 @@ var openapi = {
|
|
|
23788
24035
|
device_warnings: {
|
|
23789
24036
|
description: "Warnings associated with the device.",
|
|
23790
24037
|
items: {
|
|
24038
|
+
description: "Warning associated with the resource, including the warning code, message, and creation timestamp.",
|
|
23791
24039
|
properties: {
|
|
23792
24040
|
created_at: {
|
|
23793
24041
|
description: "Date and time at which Seam created the warning.",
|
|
@@ -23853,6 +24101,7 @@ var openapi = {
|
|
|
23853
24101
|
access_code_errors: {
|
|
23854
24102
|
description: "Errors associated with the access code.",
|
|
23855
24103
|
items: {
|
|
24104
|
+
description: "Error associated with the resource, including the error code, message, and creation timestamp.",
|
|
23856
24105
|
properties: {
|
|
23857
24106
|
created_at: {
|
|
23858
24107
|
description: "Date and time at which Seam created the error.",
|
|
@@ -23881,6 +24130,7 @@ var openapi = {
|
|
|
23881
24130
|
access_code_warnings: {
|
|
23882
24131
|
description: "Warnings associated with the access code.",
|
|
23883
24132
|
items: {
|
|
24133
|
+
description: "Warning associated with the resource, including the warning code, message, and creation timestamp.",
|
|
23884
24134
|
properties: {
|
|
23885
24135
|
created_at: {
|
|
23886
24136
|
description: "Date and time at which Seam created the warning.",
|
|
@@ -23911,6 +24161,7 @@ var openapi = {
|
|
|
23911
24161
|
connected_account_errors: {
|
|
23912
24162
|
description: "Errors associated with the connected account.",
|
|
23913
24163
|
items: {
|
|
24164
|
+
description: "Error associated with the resource, including the error code, message, and creation timestamp.",
|
|
23914
24165
|
properties: {
|
|
23915
24166
|
created_at: {
|
|
23916
24167
|
description: "Date and time at which Seam created the error.",
|
|
@@ -23939,6 +24190,7 @@ var openapi = {
|
|
|
23939
24190
|
connected_account_warnings: {
|
|
23940
24191
|
description: "Warnings associated with the connected account.",
|
|
23941
24192
|
items: {
|
|
24193
|
+
description: "Warning associated with the resource, including the warning code, message, and creation timestamp.",
|
|
23942
24194
|
properties: {
|
|
23943
24195
|
created_at: {
|
|
23944
24196
|
description: "Date and time at which Seam created the warning.",
|
|
@@ -23974,6 +24226,7 @@ var openapi = {
|
|
|
23974
24226
|
device_errors: {
|
|
23975
24227
|
description: "Errors associated with the device.",
|
|
23976
24228
|
items: {
|
|
24229
|
+
description: "Error associated with the resource, including the error code, message, and creation timestamp.",
|
|
23977
24230
|
properties: {
|
|
23978
24231
|
created_at: {
|
|
23979
24232
|
description: "Date and time at which Seam created the error.",
|
|
@@ -24002,6 +24255,7 @@ var openapi = {
|
|
|
24002
24255
|
device_warnings: {
|
|
24003
24256
|
description: "Warnings associated with the device.",
|
|
24004
24257
|
items: {
|
|
24258
|
+
description: "Warning associated with the resource, including the warning code, message, and creation timestamp.",
|
|
24005
24259
|
properties: {
|
|
24006
24260
|
created_at: {
|
|
24007
24261
|
description: "Date and time at which Seam created the warning.",
|
|
@@ -24209,7 +24463,10 @@ var openapi = {
|
|
|
24209
24463
|
format: "uuid",
|
|
24210
24464
|
type: "string"
|
|
24211
24465
|
},
|
|
24212
|
-
backup_access_code_id: {
|
|
24466
|
+
backup_access_code_id: {
|
|
24467
|
+
description: "ID of the backup access code that was pulled from the pool.",
|
|
24468
|
+
type: "string"
|
|
24469
|
+
},
|
|
24213
24470
|
connected_account_custom_metadata: {
|
|
24214
24471
|
additionalProperties: {
|
|
24215
24472
|
oneOf: [{ type: "string" }, { type: "boolean" }]
|
|
@@ -24349,6 +24606,7 @@ var openapi = {
|
|
|
24349
24606
|
access_code_errors: {
|
|
24350
24607
|
description: "Errors associated with the access code.",
|
|
24351
24608
|
items: {
|
|
24609
|
+
description: "Error associated with the resource, including the error code, message, and creation timestamp.",
|
|
24352
24610
|
properties: {
|
|
24353
24611
|
created_at: {
|
|
24354
24612
|
description: "Date and time at which Seam created the error.",
|
|
@@ -24377,6 +24635,7 @@ var openapi = {
|
|
|
24377
24635
|
access_code_warnings: {
|
|
24378
24636
|
description: "Warnings associated with the access code.",
|
|
24379
24637
|
items: {
|
|
24638
|
+
description: "Warning associated with the resource, including the warning code, message, and creation timestamp.",
|
|
24380
24639
|
properties: {
|
|
24381
24640
|
created_at: {
|
|
24382
24641
|
description: "Date and time at which Seam created the warning.",
|
|
@@ -24407,6 +24666,7 @@ var openapi = {
|
|
|
24407
24666
|
connected_account_errors: {
|
|
24408
24667
|
description: "Errors associated with the connected account.",
|
|
24409
24668
|
items: {
|
|
24669
|
+
description: "Error associated with the resource, including the error code, message, and creation timestamp.",
|
|
24410
24670
|
properties: {
|
|
24411
24671
|
created_at: {
|
|
24412
24672
|
description: "Date and time at which Seam created the error.",
|
|
@@ -24435,6 +24695,7 @@ var openapi = {
|
|
|
24435
24695
|
connected_account_warnings: {
|
|
24436
24696
|
description: "Warnings associated with the connected account.",
|
|
24437
24697
|
items: {
|
|
24698
|
+
description: "Warning associated with the resource, including the warning code, message, and creation timestamp.",
|
|
24438
24699
|
properties: {
|
|
24439
24700
|
created_at: {
|
|
24440
24701
|
description: "Date and time at which Seam created the warning.",
|
|
@@ -24470,6 +24731,7 @@ var openapi = {
|
|
|
24470
24731
|
device_errors: {
|
|
24471
24732
|
description: "Errors associated with the device.",
|
|
24472
24733
|
items: {
|
|
24734
|
+
description: "Error associated with the resource, including the error code, message, and creation timestamp.",
|
|
24473
24735
|
properties: {
|
|
24474
24736
|
created_at: {
|
|
24475
24737
|
description: "Date and time at which Seam created the error.",
|
|
@@ -24498,6 +24760,7 @@ var openapi = {
|
|
|
24498
24760
|
device_warnings: {
|
|
24499
24761
|
description: "Warnings associated with the device.",
|
|
24500
24762
|
items: {
|
|
24763
|
+
description: "Warning associated with the resource, including the warning code, message, and creation timestamp.",
|
|
24501
24764
|
properties: {
|
|
24502
24765
|
created_at: {
|
|
24503
24766
|
description: "Date and time at which Seam created the warning.",
|
|
@@ -25464,6 +25727,7 @@ var openapi = {
|
|
|
25464
25727
|
acs_system_errors: {
|
|
25465
25728
|
description: "Errors associated with the access control system.",
|
|
25466
25729
|
items: {
|
|
25730
|
+
description: "Error associated with the resource, including the error code, message, and creation timestamp.",
|
|
25467
25731
|
properties: {
|
|
25468
25732
|
created_at: {
|
|
25469
25733
|
description: "Date and time at which Seam created the error.",
|
|
@@ -25492,6 +25756,7 @@ var openapi = {
|
|
|
25492
25756
|
acs_system_warnings: {
|
|
25493
25757
|
description: "Warnings associated with the access control system.",
|
|
25494
25758
|
items: {
|
|
25759
|
+
description: "Warning associated with the resource, including the warning code, message, and creation timestamp.",
|
|
25495
25760
|
properties: {
|
|
25496
25761
|
created_at: {
|
|
25497
25762
|
description: "Date and time at which Seam created the warning.",
|
|
@@ -25515,6 +25780,7 @@ var openapi = {
|
|
|
25515
25780
|
connected_account_errors: {
|
|
25516
25781
|
description: "Errors associated with the connected account.",
|
|
25517
25782
|
items: {
|
|
25783
|
+
description: "Error associated with the resource, including the error code, message, and creation timestamp.",
|
|
25518
25784
|
properties: {
|
|
25519
25785
|
created_at: {
|
|
25520
25786
|
description: "Date and time at which Seam created the error.",
|
|
@@ -25543,6 +25809,7 @@ var openapi = {
|
|
|
25543
25809
|
connected_account_warnings: {
|
|
25544
25810
|
description: "Warnings associated with the connected account.",
|
|
25545
25811
|
items: {
|
|
25812
|
+
description: "Warning associated with the resource, including the warning code, message, and creation timestamp.",
|
|
25546
25813
|
properties: {
|
|
25547
25814
|
created_at: {
|
|
25548
25815
|
description: "Date and time at which Seam created the warning.",
|
|
@@ -25819,7 +26086,11 @@ var openapi = {
|
|
|
25819
26086
|
format: "uuid",
|
|
25820
26087
|
type: "string"
|
|
25821
26088
|
},
|
|
25822
|
-
acs_user_id: {
|
|
26089
|
+
acs_user_id: {
|
|
26090
|
+
description: "ID of the affected access system user.",
|
|
26091
|
+
format: "uuid",
|
|
26092
|
+
type: "string"
|
|
26093
|
+
},
|
|
25823
26094
|
connected_account_id: {
|
|
25824
26095
|
description: "ID of the connected account.",
|
|
25825
26096
|
format: "uuid",
|
|
@@ -25867,7 +26138,11 @@ var openapi = {
|
|
|
25867
26138
|
format: "uuid",
|
|
25868
26139
|
type: "string"
|
|
25869
26140
|
},
|
|
25870
|
-
acs_user_id: {
|
|
26141
|
+
acs_user_id: {
|
|
26142
|
+
description: "ID of the affected access system user.",
|
|
26143
|
+
format: "uuid",
|
|
26144
|
+
type: "string"
|
|
26145
|
+
},
|
|
25871
26146
|
connected_account_id: {
|
|
25872
26147
|
description: "ID of the connected account.",
|
|
25873
26148
|
format: "uuid",
|
|
@@ -26069,7 +26344,11 @@ var openapi = {
|
|
|
26069
26344
|
{
|
|
26070
26345
|
description: "An [access system entrance](https://docs.seam.co/low-level-apis/access-systems/retrieving-entrance-details) was added.",
|
|
26071
26346
|
properties: {
|
|
26072
|
-
acs_entrance_id: {
|
|
26347
|
+
acs_entrance_id: {
|
|
26348
|
+
description: "ID of the affected entrance.",
|
|
26349
|
+
format: "uuid",
|
|
26350
|
+
type: "string"
|
|
26351
|
+
},
|
|
26073
26352
|
acs_system_id: {
|
|
26074
26353
|
description: "ID of the access system.",
|
|
26075
26354
|
format: "uuid",
|
|
@@ -26117,7 +26396,11 @@ var openapi = {
|
|
|
26117
26396
|
{
|
|
26118
26397
|
description: "An [access system entrance](https://docs.seam.co/low-level-apis/access-systems/retrieving-entrance-details) was removed.",
|
|
26119
26398
|
properties: {
|
|
26120
|
-
acs_entrance_id: {
|
|
26399
|
+
acs_entrance_id: {
|
|
26400
|
+
description: "ID of the affected entrance.",
|
|
26401
|
+
format: "uuid",
|
|
26402
|
+
type: "string"
|
|
26403
|
+
},
|
|
26121
26404
|
acs_system_id: {
|
|
26122
26405
|
description: "ID of the access system.",
|
|
26123
26406
|
format: "uuid",
|
|
@@ -26392,6 +26675,7 @@ var openapi = {
|
|
|
26392
26675
|
connected_account_errors: {
|
|
26393
26676
|
description: "Errors associated with the connected account.",
|
|
26394
26677
|
items: {
|
|
26678
|
+
description: "Error associated with the resource, including the error code, message, and creation timestamp.",
|
|
26395
26679
|
properties: {
|
|
26396
26680
|
created_at: {
|
|
26397
26681
|
description: "Date and time at which Seam created the error.",
|
|
@@ -26420,6 +26704,7 @@ var openapi = {
|
|
|
26420
26704
|
connected_account_warnings: {
|
|
26421
26705
|
description: "Warnings associated with the connected account.",
|
|
26422
26706
|
items: {
|
|
26707
|
+
description: "Warning associated with the resource, including the warning code, message, and creation timestamp.",
|
|
26423
26708
|
properties: {
|
|
26424
26709
|
created_at: {
|
|
26425
26710
|
description: "Date and time at which Seam created the warning.",
|
|
@@ -26654,6 +26939,7 @@ var openapi = {
|
|
|
26654
26939
|
connected_account_errors: {
|
|
26655
26940
|
description: "Errors associated with the connected account.",
|
|
26656
26941
|
items: {
|
|
26942
|
+
description: "Error associated with the resource, including the error code, message, and creation timestamp.",
|
|
26657
26943
|
properties: {
|
|
26658
26944
|
created_at: {
|
|
26659
26945
|
description: "Date and time at which Seam created the error.",
|
|
@@ -26682,6 +26968,7 @@ var openapi = {
|
|
|
26682
26968
|
connected_account_warnings: {
|
|
26683
26969
|
description: "Warnings associated with the connected account.",
|
|
26684
26970
|
items: {
|
|
26971
|
+
description: "Warning associated with the resource, including the warning code, message, and creation timestamp.",
|
|
26685
26972
|
properties: {
|
|
26686
26973
|
created_at: {
|
|
26687
26974
|
description: "Date and time at which Seam created the warning.",
|
|
@@ -27682,6 +27969,7 @@ var openapi = {
|
|
|
27682
27969
|
connected_account_errors: {
|
|
27683
27970
|
description: "Errors associated with the connected account.",
|
|
27684
27971
|
items: {
|
|
27972
|
+
description: "Error associated with the resource, including the error code, message, and creation timestamp.",
|
|
27685
27973
|
properties: {
|
|
27686
27974
|
created_at: {
|
|
27687
27975
|
description: "Date and time at which Seam created the error.",
|
|
@@ -27710,6 +27998,7 @@ var openapi = {
|
|
|
27710
27998
|
connected_account_warnings: {
|
|
27711
27999
|
description: "Warnings associated with the connected account.",
|
|
27712
28000
|
items: {
|
|
28001
|
+
description: "Warning associated with the resource, including the warning code, message, and creation timestamp.",
|
|
27713
28002
|
properties: {
|
|
27714
28003
|
created_at: {
|
|
27715
28004
|
description: "Date and time at which Seam created the warning.",
|
|
@@ -27749,6 +28038,7 @@ var openapi = {
|
|
|
27749
28038
|
device_errors: {
|
|
27750
28039
|
description: "Errors associated with the device.",
|
|
27751
28040
|
items: {
|
|
28041
|
+
description: "Error associated with the resource, including the error code, message, and creation timestamp.",
|
|
27752
28042
|
properties: {
|
|
27753
28043
|
created_at: {
|
|
27754
28044
|
description: "Date and time at which Seam created the error.",
|
|
@@ -27777,6 +28067,7 @@ var openapi = {
|
|
|
27777
28067
|
device_warnings: {
|
|
27778
28068
|
description: "Warnings associated with the device.",
|
|
27779
28069
|
items: {
|
|
28070
|
+
description: "Warning associated with the resource, including the warning code, message, and creation timestamp.",
|
|
27780
28071
|
properties: {
|
|
27781
28072
|
created_at: {
|
|
27782
28073
|
description: "Date and time at which Seam created the warning.",
|
|
@@ -27853,6 +28144,7 @@ var openapi = {
|
|
|
27853
28144
|
connected_account_errors: {
|
|
27854
28145
|
description: "Errors associated with the connected account.",
|
|
27855
28146
|
items: {
|
|
28147
|
+
description: "Error associated with the resource, including the error code, message, and creation timestamp.",
|
|
27856
28148
|
properties: {
|
|
27857
28149
|
created_at: {
|
|
27858
28150
|
description: "Date and time at which Seam created the error.",
|
|
@@ -27881,6 +28173,7 @@ var openapi = {
|
|
|
27881
28173
|
connected_account_warnings: {
|
|
27882
28174
|
description: "Warnings associated with the connected account.",
|
|
27883
28175
|
items: {
|
|
28176
|
+
description: "Warning associated with the resource, including the warning code, message, and creation timestamp.",
|
|
27884
28177
|
properties: {
|
|
27885
28178
|
created_at: {
|
|
27886
28179
|
description: "Date and time at which Seam created the warning.",
|
|
@@ -27920,6 +28213,7 @@ var openapi = {
|
|
|
27920
28213
|
device_errors: {
|
|
27921
28214
|
description: "Errors associated with the device.",
|
|
27922
28215
|
items: {
|
|
28216
|
+
description: "Error associated with the resource, including the error code, message, and creation timestamp.",
|
|
27923
28217
|
properties: {
|
|
27924
28218
|
created_at: {
|
|
27925
28219
|
description: "Date and time at which Seam created the error.",
|
|
@@ -27948,6 +28242,7 @@ var openapi = {
|
|
|
27948
28242
|
device_warnings: {
|
|
27949
28243
|
description: "Warnings associated with the device.",
|
|
27950
28244
|
items: {
|
|
28245
|
+
description: "Warning associated with the resource, including the warning code, message, and creation timestamp.",
|
|
27951
28246
|
properties: {
|
|
27952
28247
|
created_at: {
|
|
27953
28248
|
description: "Date and time at which Seam created the warning.",
|
|
@@ -28654,6 +28949,7 @@ var openapi = {
|
|
|
28654
28949
|
connected_account_errors: {
|
|
28655
28950
|
description: "Errors associated with the connected account.",
|
|
28656
28951
|
items: {
|
|
28952
|
+
description: "Error associated with the resource, including the error code, message, and creation timestamp.",
|
|
28657
28953
|
properties: {
|
|
28658
28954
|
created_at: {
|
|
28659
28955
|
description: "Date and time at which Seam created the error.",
|
|
@@ -28682,6 +28978,7 @@ var openapi = {
|
|
|
28682
28978
|
connected_account_warnings: {
|
|
28683
28979
|
description: "Warnings associated with the connected account.",
|
|
28684
28980
|
items: {
|
|
28981
|
+
description: "Warning associated with the resource, including the warning code, message, and creation timestamp.",
|
|
28685
28982
|
properties: {
|
|
28686
28983
|
created_at: {
|
|
28687
28984
|
description: "Date and time at which Seam created the warning.",
|
|
@@ -28721,6 +29018,7 @@ var openapi = {
|
|
|
28721
29018
|
device_errors: {
|
|
28722
29019
|
description: "Errors associated with the device.",
|
|
28723
29020
|
items: {
|
|
29021
|
+
description: "Error associated with the resource, including the error code, message, and creation timestamp.",
|
|
28724
29022
|
properties: {
|
|
28725
29023
|
created_at: {
|
|
28726
29024
|
description: "Date and time at which Seam created the error.",
|
|
@@ -28749,6 +29047,7 @@ var openapi = {
|
|
|
28749
29047
|
device_warnings: {
|
|
28750
29048
|
description: "Warnings associated with the device.",
|
|
28751
29049
|
items: {
|
|
29050
|
+
description: "Warning associated with the resource, including the warning code, message, and creation timestamp.",
|
|
28752
29051
|
properties: {
|
|
28753
29052
|
created_at: {
|
|
28754
29053
|
description: "Date and time at which Seam created the warning.",
|
|
@@ -28886,6 +29185,7 @@ var openapi = {
|
|
|
28886
29185
|
connected_account_errors: {
|
|
28887
29186
|
description: "Errors associated with the connected account.",
|
|
28888
29187
|
items: {
|
|
29188
|
+
description: "Error associated with the resource, including the error code, message, and creation timestamp.",
|
|
28889
29189
|
properties: {
|
|
28890
29190
|
created_at: {
|
|
28891
29191
|
description: "Date and time at which Seam created the error.",
|
|
@@ -28914,6 +29214,7 @@ var openapi = {
|
|
|
28914
29214
|
connected_account_warnings: {
|
|
28915
29215
|
description: "Warnings associated with the connected account.",
|
|
28916
29216
|
items: {
|
|
29217
|
+
description: "Warning associated with the resource, including the warning code, message, and creation timestamp.",
|
|
28917
29218
|
properties: {
|
|
28918
29219
|
created_at: {
|
|
28919
29220
|
description: "Date and time at which Seam created the warning.",
|
|
@@ -28953,6 +29254,7 @@ var openapi = {
|
|
|
28953
29254
|
device_errors: {
|
|
28954
29255
|
description: "Errors associated with the device.",
|
|
28955
29256
|
items: {
|
|
29257
|
+
description: "Error associated with the resource, including the error code, message, and creation timestamp.",
|
|
28956
29258
|
properties: {
|
|
28957
29259
|
created_at: {
|
|
28958
29260
|
description: "Date and time at which Seam created the error.",
|
|
@@ -28981,6 +29283,7 @@ var openapi = {
|
|
|
28981
29283
|
device_warnings: {
|
|
28982
29284
|
description: "Warnings associated with the device.",
|
|
28983
29285
|
items: {
|
|
29286
|
+
description: "Warning associated with the resource, including the warning code, message, and creation timestamp.",
|
|
28984
29287
|
properties: {
|
|
28985
29288
|
created_at: {
|
|
28986
29289
|
description: "Date and time at which Seam created the warning.",
|
|
@@ -29186,6 +29489,7 @@ var openapi = {
|
|
|
29186
29489
|
connected_account_errors: {
|
|
29187
29490
|
description: "Errors associated with the connected account.",
|
|
29188
29491
|
items: {
|
|
29492
|
+
description: "Error associated with the resource, including the error code, message, and creation timestamp.",
|
|
29189
29493
|
properties: {
|
|
29190
29494
|
created_at: {
|
|
29191
29495
|
description: "Date and time at which Seam created the error.",
|
|
@@ -29214,6 +29518,7 @@ var openapi = {
|
|
|
29214
29518
|
connected_account_warnings: {
|
|
29215
29519
|
description: "Warnings associated with the connected account.",
|
|
29216
29520
|
items: {
|
|
29521
|
+
description: "Warning associated with the resource, including the warning code, message, and creation timestamp.",
|
|
29217
29522
|
properties: {
|
|
29218
29523
|
created_at: {
|
|
29219
29524
|
description: "Date and time at which Seam created the warning.",
|
|
@@ -29253,6 +29558,7 @@ var openapi = {
|
|
|
29253
29558
|
device_errors: {
|
|
29254
29559
|
description: "Errors associated with the device.",
|
|
29255
29560
|
items: {
|
|
29561
|
+
description: "Error associated with the resource, including the error code, message, and creation timestamp.",
|
|
29256
29562
|
properties: {
|
|
29257
29563
|
created_at: {
|
|
29258
29564
|
description: "Date and time at which Seam created the error.",
|
|
@@ -29281,6 +29587,7 @@ var openapi = {
|
|
|
29281
29587
|
device_warnings: {
|
|
29282
29588
|
description: "Warnings associated with the device.",
|
|
29283
29589
|
items: {
|
|
29590
|
+
description: "Warning associated with the resource, including the warning code, message, and creation timestamp.",
|
|
29284
29591
|
properties: {
|
|
29285
29592
|
created_at: {
|
|
29286
29593
|
description: "Date and time at which Seam created the warning.",
|
|
@@ -30994,7 +31301,7 @@ var openapi = {
|
|
|
30994
31301
|
type: "string"
|
|
30995
31302
|
},
|
|
30996
31303
|
device_type: {
|
|
30997
|
-
description: "
|
|
31304
|
+
description: "Type of the phone device, such as `ios_phone` or `android_phone`.",
|
|
30998
31305
|
enum: ["ios_phone", "android_phone"],
|
|
30999
31306
|
type: "string"
|
|
31000
31307
|
},
|
|
@@ -31006,8 +31313,14 @@ var openapi = {
|
|
|
31006
31313
|
description: "Errors associated with the phone.",
|
|
31007
31314
|
items: {
|
|
31008
31315
|
properties: {
|
|
31009
|
-
error_code: {
|
|
31010
|
-
|
|
31316
|
+
error_code: {
|
|
31317
|
+
description: "Unique identifier of the type of error.",
|
|
31318
|
+
type: "string"
|
|
31319
|
+
},
|
|
31320
|
+
message: {
|
|
31321
|
+
description: "Detailed description of the error.",
|
|
31322
|
+
type: "string"
|
|
31323
|
+
}
|
|
31011
31324
|
},
|
|
31012
31325
|
required: ["error_code", "message"],
|
|
31013
31326
|
type: "object"
|
|
@@ -31019,7 +31332,7 @@ var openapi = {
|
|
|
31019
31332
|
type: "string"
|
|
31020
31333
|
},
|
|
31021
31334
|
properties: {
|
|
31022
|
-
description: "
|
|
31335
|
+
description: "Properties of the phone.",
|
|
31023
31336
|
properties: {
|
|
31024
31337
|
assa_abloy_credential_service_metadata: {
|
|
31025
31338
|
description: "ASSA ABLOY Credential Service metadata for the phone.",
|
|
@@ -31068,8 +31381,14 @@ var openapi = {
|
|
|
31068
31381
|
description: "Warnings associated with the phone.",
|
|
31069
31382
|
items: {
|
|
31070
31383
|
properties: {
|
|
31071
|
-
message: {
|
|
31072
|
-
|
|
31384
|
+
message: {
|
|
31385
|
+
description: "Detailed description of the warning.",
|
|
31386
|
+
type: "string"
|
|
31387
|
+
},
|
|
31388
|
+
warning_code: {
|
|
31389
|
+
description: "Unique identifier of the type of warning.",
|
|
31390
|
+
type: "string"
|
|
31391
|
+
}
|
|
31073
31392
|
},
|
|
31074
31393
|
required: ["warning_code", "message"],
|
|
31075
31394
|
type: "object"
|
|
@@ -31148,6 +31467,7 @@ var openapi = {
|
|
|
31148
31467
|
},
|
|
31149
31468
|
acs_credential_id: { nullable: true, type: "string" },
|
|
31150
31469
|
acs_credential_pool_id: {
|
|
31470
|
+
description: "ID of the credential pool to which the credential belongs.",
|
|
31151
31471
|
format: "uuid",
|
|
31152
31472
|
type: "string"
|
|
31153
31473
|
},
|
|
@@ -31758,7 +32078,11 @@ var openapi = {
|
|
|
31758
32078
|
nullable: true,
|
|
31759
32079
|
type: "boolean"
|
|
31760
32080
|
},
|
|
31761
|
-
is_managed: {
|
|
32081
|
+
is_managed: {
|
|
32082
|
+
description: "Indicates whether Seam manages the credential.",
|
|
32083
|
+
enum: [true],
|
|
32084
|
+
type: "boolean"
|
|
32085
|
+
},
|
|
31762
32086
|
is_multi_phone_sync_credential: {
|
|
31763
32087
|
description: "Indicates whether the [credential](https://docs.seam.co/low-level-apis/access-systems/managing-credentials) is a [multi-phone sync credential](https://docs.seam.co/capability-guides/mobile-access/issuing-mobile-credentials-from-an-access-control-system#what-are-multi-phone-sync-credentials).",
|
|
31764
32088
|
type: "boolean"
|
|
@@ -32068,7 +32392,11 @@ var openapi = {
|
|
|
32068
32392
|
format: "date-time",
|
|
32069
32393
|
type: "string"
|
|
32070
32394
|
},
|
|
32071
|
-
display_name: {
|
|
32395
|
+
display_name: {
|
|
32396
|
+
description: "Display name for the user identity.",
|
|
32397
|
+
minLength: 1,
|
|
32398
|
+
type: "string"
|
|
32399
|
+
},
|
|
32072
32400
|
email_address: {
|
|
32073
32401
|
description: "Unique email address for the user identity.",
|
|
32074
32402
|
format: "email",
|
|
@@ -32122,7 +32450,12 @@ var openapi = {
|
|
|
32122
32450
|
},
|
|
32123
32451
|
type: "array"
|
|
32124
32452
|
},
|
|
32125
|
-
full_name: {
|
|
32453
|
+
full_name: {
|
|
32454
|
+
description: "Full name of the user associated with the user identity.",
|
|
32455
|
+
minLength: 1,
|
|
32456
|
+
nullable: true,
|
|
32457
|
+
type: "string"
|
|
32458
|
+
},
|
|
32126
32459
|
phone_number: {
|
|
32127
32460
|
description: "Unique phone number for the user identity in [E.164 format](https://www.itu.int/rec/T-REC-E.164/en) (for example, +15555550100).",
|
|
32128
32461
|
nullable: true,
|
|
@@ -33936,7 +34269,10 @@ var openapi = {
|
|
|
33936
34269
|
format: "date-time",
|
|
33937
34270
|
type: "string"
|
|
33938
34271
|
},
|
|
33939
|
-
display_name: {
|
|
34272
|
+
display_name: {
|
|
34273
|
+
description: "Display name for the access group.",
|
|
34274
|
+
type: "string"
|
|
34275
|
+
},
|
|
33940
34276
|
errors: {
|
|
33941
34277
|
description: "Errors associated with the `acs_access_group`.",
|
|
33942
34278
|
items: {
|
|
@@ -34408,7 +34744,11 @@ var openapi = {
|
|
|
34408
34744
|
format: "uuid",
|
|
34409
34745
|
type: "string"
|
|
34410
34746
|
},
|
|
34411
|
-
acs_credential_pool_id: {
|
|
34747
|
+
acs_credential_pool_id: {
|
|
34748
|
+
description: "ID of the credential pool to which the credential belongs.",
|
|
34749
|
+
format: "uuid",
|
|
34750
|
+
type: "string"
|
|
34751
|
+
},
|
|
34412
34752
|
acs_system_id: {
|
|
34413
34753
|
description: "ID of the [access control system](https://docs.seam.co/low-level-apis/access-systems) that contains the [credential](https://docs.seam.co/low-level-apis/access-systems/managing-credentials).",
|
|
34414
34754
|
format: "uuid",
|
|
@@ -34968,7 +35308,11 @@ var openapi = {
|
|
|
34968
35308
|
minLength: 1,
|
|
34969
35309
|
type: "string"
|
|
34970
35310
|
},
|
|
34971
|
-
hid_acs_system_id: {
|
|
35311
|
+
hid_acs_system_id: {
|
|
35312
|
+
description: "ID of the HID access control system associated with the user.",
|
|
35313
|
+
format: "uuid",
|
|
35314
|
+
type: "string"
|
|
35315
|
+
},
|
|
34972
35316
|
is_managed: { enum: [false], type: "boolean" },
|
|
34973
35317
|
is_suspended: {
|
|
34974
35318
|
description: "Indicates whether the [access system user](https://docs.seam.co/low-level-apis/access-systems/user-management) is currently [suspended](https://docs.seam.co/low-level-apis/access-systems/user-management/suspending-and-unsuspending-users).",
|
|
@@ -35525,30 +35869,86 @@ var openapi = {
|
|
|
35525
35869
|
unmanaged_device: {
|
|
35526
35870
|
description: "Represents an [unmanaged device](https://docs.seam.co/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://docs.seam.co/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://docs.seam.co/core-concepts/devices/managed-and-unmanaged-devices#convert-an-unmanaged-device-to-managed).",
|
|
35527
35871
|
properties: {
|
|
35528
|
-
can_configure_auto_lock: {
|
|
35529
|
-
|
|
35530
|
-
|
|
35531
|
-
|
|
35532
|
-
|
|
35533
|
-
|
|
35872
|
+
can_configure_auto_lock: {
|
|
35873
|
+
description: "Indicates whether the lock supports configuring automatic locking.",
|
|
35874
|
+
type: "boolean"
|
|
35875
|
+
},
|
|
35876
|
+
can_hvac_cool: {
|
|
35877
|
+
description: "Indicates whether the thermostat supports cooling.",
|
|
35878
|
+
type: "boolean"
|
|
35879
|
+
},
|
|
35880
|
+
can_hvac_heat: {
|
|
35881
|
+
description: "Indicates whether the thermostat supports heating.",
|
|
35882
|
+
type: "boolean"
|
|
35883
|
+
},
|
|
35884
|
+
can_hvac_heat_cool: {
|
|
35885
|
+
description: "Indicates whether the thermostat supports simultaneous heating and cooling.",
|
|
35886
|
+
type: "boolean"
|
|
35887
|
+
},
|
|
35888
|
+
can_program_offline_access_codes: {
|
|
35889
|
+
description: "Indicates whether the device supports programming offline access codes.",
|
|
35890
|
+
type: "boolean"
|
|
35891
|
+
},
|
|
35892
|
+
can_program_online_access_codes: {
|
|
35893
|
+
description: "Indicates whether the device supports programming online access codes.",
|
|
35894
|
+
type: "boolean"
|
|
35895
|
+
},
|
|
35534
35896
|
can_program_thermostat_programs_as_different_each_day: {
|
|
35897
|
+
description: "Indicates whether the thermostat supports different climate programs for each day of the week.",
|
|
35898
|
+
type: "boolean"
|
|
35899
|
+
},
|
|
35900
|
+
can_program_thermostat_programs_as_same_each_day: {
|
|
35901
|
+
description: "Indicates whether the thermostat supports a single climate program applied to every day.",
|
|
35535
35902
|
type: "boolean"
|
|
35536
35903
|
},
|
|
35537
|
-
can_program_thermostat_programs_as_same_each_day: { type: "boolean" },
|
|
35538
35904
|
can_program_thermostat_programs_as_weekday_weekend: {
|
|
35905
|
+
description: "Indicates whether the thermostat supports weekday/weekend climate programs.",
|
|
35906
|
+
type: "boolean"
|
|
35907
|
+
},
|
|
35908
|
+
can_remotely_lock: {
|
|
35909
|
+
description: "Indicates whether the device supports remote locking.",
|
|
35910
|
+
type: "boolean"
|
|
35911
|
+
},
|
|
35912
|
+
can_remotely_unlock: {
|
|
35913
|
+
description: "Indicates whether the device supports remote unlocking.",
|
|
35914
|
+
type: "boolean"
|
|
35915
|
+
},
|
|
35916
|
+
can_run_thermostat_programs: {
|
|
35917
|
+
description: "Indicates whether the thermostat supports running climate programs.",
|
|
35918
|
+
type: "boolean"
|
|
35919
|
+
},
|
|
35920
|
+
can_simulate_connection: {
|
|
35921
|
+
description: "Indicates whether the device supports simulating connection in a sandbox.",
|
|
35922
|
+
type: "boolean"
|
|
35923
|
+
},
|
|
35924
|
+
can_simulate_disconnection: {
|
|
35925
|
+
description: "Indicates whether the device supports simulating disconnection in a sandbox.",
|
|
35926
|
+
type: "boolean"
|
|
35927
|
+
},
|
|
35928
|
+
can_simulate_hub_connection: {
|
|
35929
|
+
description: "Indicates whether the hub supports simulating connection in a sandbox.",
|
|
35930
|
+
type: "boolean"
|
|
35931
|
+
},
|
|
35932
|
+
can_simulate_hub_disconnection: {
|
|
35933
|
+
description: "Indicates whether the hub supports simulating disconnection in a sandbox.",
|
|
35934
|
+
type: "boolean"
|
|
35935
|
+
},
|
|
35936
|
+
can_simulate_paid_subscription: {
|
|
35937
|
+
description: "Indicates whether the device supports simulating a paid subscription in a sandbox.",
|
|
35938
|
+
type: "boolean"
|
|
35939
|
+
},
|
|
35940
|
+
can_simulate_removal: {
|
|
35941
|
+
description: "Indicates whether the device supports simulating removal in a sandbox.",
|
|
35942
|
+
type: "boolean"
|
|
35943
|
+
},
|
|
35944
|
+
can_turn_off_hvac: {
|
|
35945
|
+
description: "Indicates whether the thermostat can be turned off.",
|
|
35946
|
+
type: "boolean"
|
|
35947
|
+
},
|
|
35948
|
+
can_unlock_with_code: {
|
|
35949
|
+
description: "Indicates whether the lock supports unlocking with an access code.",
|
|
35539
35950
|
type: "boolean"
|
|
35540
35951
|
},
|
|
35541
|
-
can_remotely_lock: { type: "boolean" },
|
|
35542
|
-
can_remotely_unlock: { type: "boolean" },
|
|
35543
|
-
can_run_thermostat_programs: { type: "boolean" },
|
|
35544
|
-
can_simulate_connection: { type: "boolean" },
|
|
35545
|
-
can_simulate_disconnection: { type: "boolean" },
|
|
35546
|
-
can_simulate_hub_connection: { type: "boolean" },
|
|
35547
|
-
can_simulate_hub_disconnection: { type: "boolean" },
|
|
35548
|
-
can_simulate_paid_subscription: { type: "boolean" },
|
|
35549
|
-
can_simulate_removal: { type: "boolean" },
|
|
35550
|
-
can_turn_off_hvac: { type: "boolean" },
|
|
35551
|
-
can_unlock_with_code: { type: "boolean" },
|
|
35552
35952
|
capabilities_supported: {
|
|
35553
35953
|
description: "\n 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://docs.seam.co/capability-guides/device-and-system-capabilities#capability-flags).\n ",
|
|
35554
35954
|
items: {
|
|
@@ -36193,7 +36593,11 @@ var openapi = {
|
|
|
36193
36593
|
thermostats: { name: "Thermostats" }
|
|
36194
36594
|
}
|
|
36195
36595
|
},
|
|
36196
|
-
is_managed: {
|
|
36596
|
+
is_managed: {
|
|
36597
|
+
description: "Indicates that Seam does not manage the device.",
|
|
36598
|
+
enum: [false],
|
|
36599
|
+
type: "boolean"
|
|
36600
|
+
},
|
|
36197
36601
|
location: {
|
|
36198
36602
|
description: "Location information for the device.",
|
|
36199
36603
|
properties: {
|
|
@@ -37002,7 +37406,11 @@ var openapi = {
|
|
|
37002
37406
|
format: "date-time",
|
|
37003
37407
|
type: "string"
|
|
37004
37408
|
},
|
|
37005
|
-
display_name: {
|
|
37409
|
+
display_name: {
|
|
37410
|
+
description: "Display name for the user identity.",
|
|
37411
|
+
minLength: 1,
|
|
37412
|
+
type: "string"
|
|
37413
|
+
},
|
|
37006
37414
|
email_address: {
|
|
37007
37415
|
description: "Unique email address for the user identity.",
|
|
37008
37416
|
format: "email",
|
|
@@ -37056,7 +37464,12 @@ var openapi = {
|
|
|
37056
37464
|
},
|
|
37057
37465
|
type: "array"
|
|
37058
37466
|
},
|
|
37059
|
-
full_name: {
|
|
37467
|
+
full_name: {
|
|
37468
|
+
description: "Full name of the user associated with the user identity.",
|
|
37469
|
+
minLength: 1,
|
|
37470
|
+
nullable: true,
|
|
37471
|
+
type: "string"
|
|
37472
|
+
},
|
|
37060
37473
|
phone_number: {
|
|
37061
37474
|
description: "Unique phone number for the user identity in [E.164 format](https://www.itu.int/rec/T-REC-E.164/en) (for example, +15555550100).",
|
|
37062
37475
|
nullable: true,
|
|
@@ -40169,6 +40582,7 @@ var openapi = {
|
|
|
40169
40582
|
type: "string"
|
|
40170
40583
|
},
|
|
40171
40584
|
full_name: {
|
|
40585
|
+
description: "Full name of the user associated with the user identity.",
|
|
40172
40586
|
minLength: 1,
|
|
40173
40587
|
nullable: true,
|
|
40174
40588
|
type: "string"
|
|
@@ -52448,7 +52862,11 @@ var openapi = {
|
|
|
52448
52862
|
minLength: 1,
|
|
52449
52863
|
type: "string"
|
|
52450
52864
|
},
|
|
52451
|
-
hid_acs_system_id: {
|
|
52865
|
+
hid_acs_system_id: {
|
|
52866
|
+
description: "ID of the HID access control system associated with the user.",
|
|
52867
|
+
format: "uuid",
|
|
52868
|
+
type: "string"
|
|
52869
|
+
},
|
|
52452
52870
|
phone_number: {
|
|
52453
52871
|
description: "Phone number of the [access system user](https://docs.seam.co/low-level-apis/access-systems/user-management) in E.164 format (for example, `+15555550100`).",
|
|
52454
52872
|
type: "string"
|
|
@@ -52544,7 +52962,11 @@ var openapi = {
|
|
|
52544
52962
|
minLength: 1,
|
|
52545
52963
|
type: "string"
|
|
52546
52964
|
},
|
|
52547
|
-
hid_acs_system_id: {
|
|
52965
|
+
hid_acs_system_id: {
|
|
52966
|
+
description: "ID of the HID access control system associated with the user.",
|
|
52967
|
+
format: "uuid",
|
|
52968
|
+
type: "string"
|
|
52969
|
+
},
|
|
52548
52970
|
phone_number: {
|
|
52549
52971
|
description: "Phone number of the [access system user](https://docs.seam.co/low-level-apis/access-systems/user-management) in E.164 format (for example, `+15555550100`).",
|
|
52550
52972
|
type: "string"
|
|
@@ -82353,6 +82775,7 @@ var openapi = {
|
|
|
82353
82775
|
},
|
|
82354
82776
|
fan_mode: {
|
|
82355
82777
|
deprecated: true,
|
|
82778
|
+
description: "Fan mode setting for the thermostat, such as `auto`, `on`, or `circulate`.",
|
|
82356
82779
|
enum: ["auto", "on", "circulate"],
|
|
82357
82780
|
type: "string",
|
|
82358
82781
|
"x-deprecated": "Use `fan_mode_setting` instead."
|
|
@@ -85642,7 +86065,11 @@ var openapi = {
|
|
|
85642
86065
|
format: "date-time",
|
|
85643
86066
|
type: "string"
|
|
85644
86067
|
},
|
|
85645
|
-
display_name: {
|
|
86068
|
+
display_name: {
|
|
86069
|
+
description: "Display name for the user identity.",
|
|
86070
|
+
minLength: 1,
|
|
86071
|
+
type: "string"
|
|
86072
|
+
},
|
|
85646
86073
|
email_address: {
|
|
85647
86074
|
description: "Unique email address for the user identity.",
|
|
85648
86075
|
format: "email",
|
|
@@ -85697,6 +86124,7 @@ var openapi = {
|
|
|
85697
86124
|
type: "array"
|
|
85698
86125
|
},
|
|
85699
86126
|
full_name: {
|
|
86127
|
+
description: "Full name of the user associated with the user identity.",
|
|
85700
86128
|
minLength: 1,
|
|
85701
86129
|
nullable: true,
|
|
85702
86130
|
type: "string"
|
|
@@ -85859,7 +86287,11 @@ var openapi = {
|
|
|
85859
86287
|
format: "date-time",
|
|
85860
86288
|
type: "string"
|
|
85861
86289
|
},
|
|
85862
|
-
display_name: {
|
|
86290
|
+
display_name: {
|
|
86291
|
+
description: "Display name for the user identity.",
|
|
86292
|
+
minLength: 1,
|
|
86293
|
+
type: "string"
|
|
86294
|
+
},
|
|
85863
86295
|
email_address: {
|
|
85864
86296
|
description: "Unique email address for the user identity.",
|
|
85865
86297
|
format: "email",
|
|
@@ -85914,6 +86346,7 @@ var openapi = {
|
|
|
85914
86346
|
type: "array"
|
|
85915
86347
|
},
|
|
85916
86348
|
full_name: {
|
|
86349
|
+
description: "Full name of the user associated with the user identity.",
|
|
85917
86350
|
minLength: 1,
|
|
85918
86351
|
nullable: true,
|
|
85919
86352
|
type: "string"
|
|
@@ -86102,7 +86535,11 @@ var openapi = {
|
|
|
86102
86535
|
format: "date-time",
|
|
86103
86536
|
type: "string"
|
|
86104
86537
|
},
|
|
86105
|
-
display_name: {
|
|
86538
|
+
display_name: {
|
|
86539
|
+
description: "Display name for the user identity.",
|
|
86540
|
+
minLength: 1,
|
|
86541
|
+
type: "string"
|
|
86542
|
+
},
|
|
86106
86543
|
email_address: {
|
|
86107
86544
|
description: "Unique email address for the user identity.",
|
|
86108
86545
|
format: "email",
|
|
@@ -86157,6 +86594,7 @@ var openapi = {
|
|
|
86157
86594
|
type: "array"
|
|
86158
86595
|
},
|
|
86159
86596
|
full_name: {
|
|
86597
|
+
description: "Full name of the user associated with the user identity.",
|
|
86160
86598
|
minLength: 1,
|
|
86161
86599
|
nullable: true,
|
|
86162
86600
|
type: "string"
|
|
@@ -86339,7 +86777,11 @@ var openapi = {
|
|
|
86339
86777
|
format: "date-time",
|
|
86340
86778
|
type: "string"
|
|
86341
86779
|
},
|
|
86342
|
-
display_name: {
|
|
86780
|
+
display_name: {
|
|
86781
|
+
description: "Display name for the user identity.",
|
|
86782
|
+
minLength: 1,
|
|
86783
|
+
type: "string"
|
|
86784
|
+
},
|
|
86343
86785
|
email_address: {
|
|
86344
86786
|
description: "Unique email address for the user identity.",
|
|
86345
86787
|
format: "email",
|
|
@@ -86394,6 +86836,7 @@ var openapi = {
|
|
|
86394
86836
|
type: "array"
|
|
86395
86837
|
},
|
|
86396
86838
|
full_name: {
|
|
86839
|
+
description: "Full name of the user associated with the user identity.",
|
|
86397
86840
|
minLength: 1,
|
|
86398
86841
|
nullable: true,
|
|
86399
86842
|
type: "string"
|