@seamapi/types 1.916.0 → 1.918.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 +645 -162
- package/dist/connect.cjs.map +1 -1
- package/dist/connect.d.cts +987 -23
- package/dist/index.cjs +645 -162
- 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/events/devices.d.ts +30 -8
- package/lib/seam/connect/models/events/devices.js +25 -0
- package/lib/seam/connect/models/events/devices.js.map +1 -1
- package/lib/seam/connect/models/events/seam-event.d.ts +15 -4
- 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 +514 -97
- package/lib/seam/connect/openapi.js.map +1 -1
- package/lib/seam/connect/route-types.d.ts +972 -19
- 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/events/devices.ts +25 -0
- 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 +665 -97
- package/src/lib/seam/connect/route-types.ts +972 -19
package/dist/connect.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(`
|
|
@@ -6439,7 +6484,28 @@ var lock_unlocked_event = device_event.extend({
|
|
|
6439
6484
|
`);
|
|
6440
6485
|
var lock_access_denied_event = device_event.extend({
|
|
6441
6486
|
event_type: zod.z.literal("lock.access_denied"),
|
|
6442
|
-
access_code_id: zod.z.string().uuid().optional().describe("ID of the access code that was used in the unlock attempts.")
|
|
6487
|
+
access_code_id: zod.z.string().uuid().optional().describe("ID of the access code that was used in the unlock attempts."),
|
|
6488
|
+
user_identity_id: zod.z.string().uuid().optional().describe(`
|
|
6489
|
+
undocumented: Unreleased.
|
|
6490
|
+
---
|
|
6491
|
+
ID of the user identity associated with the access-denied event.
|
|
6492
|
+
`),
|
|
6493
|
+
acs_system_id: zod.z.string().uuid().optional().describe(`
|
|
6494
|
+
undocumented: Unreleased.
|
|
6495
|
+
---
|
|
6496
|
+
ID of the ACS system associated with the access-denied event.
|
|
6497
|
+
`),
|
|
6498
|
+
acs_user_id: zod.z.string().uuid().optional().describe(`
|
|
6499
|
+
undocumented: Unreleased.
|
|
6500
|
+
---
|
|
6501
|
+
ID of the ACS user associated with the access-denied event.
|
|
6502
|
+
`),
|
|
6503
|
+
acs_entrance_id: zod.z.string().uuid().optional().describe(`
|
|
6504
|
+
undocumented: Unreleased.
|
|
6505
|
+
---
|
|
6506
|
+
ID of the ACS entrance associated with the access-denied event.
|
|
6507
|
+
`),
|
|
6508
|
+
device_id: zod.z.string().uuid().optional().describe("ID of the affected device.")
|
|
6443
6509
|
}).describe(`
|
|
6444
6510
|
---
|
|
6445
6511
|
route_path: /locks
|
|
@@ -6869,8 +6935,8 @@ var user_identity = zod.z.object({
|
|
|
6869
6935
|
phone_number: loose_phone_number.nullable().describe(
|
|
6870
6936
|
"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
6937
|
),
|
|
6872
|
-
display_name: zod.z.string().min(1),
|
|
6873
|
-
full_name: zod.z.string().min(1).nullable(),
|
|
6938
|
+
display_name: zod.z.string().min(1).describe("Display name for the user identity."),
|
|
6939
|
+
full_name: zod.z.string().min(1).nullable().describe("Full name of the user associated with the user identity."),
|
|
6874
6940
|
created_at: zod.z.string().datetime().describe("Date and time at which the user identity was created."),
|
|
6875
6941
|
workspace_id: zod.z.string().uuid().describe("ID of the workspace that contains the user identity."),
|
|
6876
6942
|
errors: zod.z.array(user_identity_errors).describe(
|
|
@@ -9777,7 +9843,10 @@ var openapi = {
|
|
|
9777
9843
|
format: "date-time",
|
|
9778
9844
|
type: "string"
|
|
9779
9845
|
},
|
|
9780
|
-
display_name: {
|
|
9846
|
+
display_name: {
|
|
9847
|
+
description: "Display name for the access group.",
|
|
9848
|
+
type: "string"
|
|
9849
|
+
},
|
|
9781
9850
|
errors: {
|
|
9782
9851
|
description: "Errors associated with the `acs_access_group`.",
|
|
9783
9852
|
items: {
|
|
@@ -9827,7 +9896,11 @@ var openapi = {
|
|
|
9827
9896
|
description: "Display name that corresponds to the brand-specific terminology for the access group type.",
|
|
9828
9897
|
type: "string"
|
|
9829
9898
|
},
|
|
9830
|
-
is_managed: {
|
|
9899
|
+
is_managed: {
|
|
9900
|
+
description: "Indicates whether Seam manages the access group.",
|
|
9901
|
+
enum: [true],
|
|
9902
|
+
type: "boolean"
|
|
9903
|
+
},
|
|
9831
9904
|
name: { description: "Name of the access group.", type: "string" },
|
|
9832
9905
|
pending_mutations: {
|
|
9833
9906
|
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 +10321,11 @@ var openapi = {
|
|
|
10248
10321
|
format: "uuid",
|
|
10249
10322
|
type: "string"
|
|
10250
10323
|
},
|
|
10251
|
-
acs_credential_pool_id: {
|
|
10324
|
+
acs_credential_pool_id: {
|
|
10325
|
+
description: "ID of the credential pool to which the credential belongs.",
|
|
10326
|
+
format: "uuid",
|
|
10327
|
+
type: "string"
|
|
10328
|
+
},
|
|
10252
10329
|
acs_system_id: {
|
|
10253
10330
|
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
10331
|
format: "uuid",
|
|
@@ -10363,7 +10440,11 @@ var openapi = {
|
|
|
10363
10440
|
nullable: true,
|
|
10364
10441
|
type: "boolean"
|
|
10365
10442
|
},
|
|
10366
|
-
is_managed: {
|
|
10443
|
+
is_managed: {
|
|
10444
|
+
description: "Indicates whether Seam manages the credential.",
|
|
10445
|
+
enum: [true],
|
|
10446
|
+
type: "boolean"
|
|
10447
|
+
},
|
|
10367
10448
|
is_multi_phone_sync_credential: {
|
|
10368
10449
|
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
10450
|
type: "boolean"
|
|
@@ -11183,13 +11264,21 @@ var openapi = {
|
|
|
11183
11264
|
acs_system: {
|
|
11184
11265
|
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
11266
|
properties: {
|
|
11186
|
-
acs_access_group_count: {
|
|
11267
|
+
acs_access_group_count: {
|
|
11268
|
+
description: "Number of access groups in the [access control system](https://docs.seam.co/low-level-apis/access-systems).",
|
|
11269
|
+
format: "float",
|
|
11270
|
+
type: "number"
|
|
11271
|
+
},
|
|
11187
11272
|
acs_system_id: {
|
|
11188
11273
|
description: "ID of the [access control system](https://docs.seam.co/low-level-apis/access-systems).",
|
|
11189
11274
|
format: "uuid",
|
|
11190
11275
|
type: "string"
|
|
11191
11276
|
},
|
|
11192
|
-
acs_user_count: {
|
|
11277
|
+
acs_user_count: {
|
|
11278
|
+
description: "Number of users in the [access control system](https://docs.seam.co/low-level-apis/access-systems).",
|
|
11279
|
+
format: "float",
|
|
11280
|
+
type: "number"
|
|
11281
|
+
},
|
|
11193
11282
|
connected_account_id: {
|
|
11194
11283
|
description: "ID of the connected account associated with the [access control system](https://docs.seam.co/low-level-apis/access-systems).",
|
|
11195
11284
|
format: "uuid",
|
|
@@ -11253,7 +11342,10 @@ var openapi = {
|
|
|
11253
11342
|
enum: ["bridge_disconnected"],
|
|
11254
11343
|
type: "string"
|
|
11255
11344
|
},
|
|
11256
|
-
is_bridge_error: {
|
|
11345
|
+
is_bridge_error: {
|
|
11346
|
+
description: "Indicates whether the error is related to the [Seam Bridge](https://docs.seam.co/capability-guides/seam-bridge).",
|
|
11347
|
+
type: "boolean"
|
|
11348
|
+
},
|
|
11257
11349
|
message: {
|
|
11258
11350
|
description: "Detailed description of the error. Provides insights into the issue and potentially how to rectify it.",
|
|
11259
11351
|
type: "string"
|
|
@@ -11430,6 +11522,7 @@ var openapi = {
|
|
|
11430
11522
|
type: "boolean"
|
|
11431
11523
|
},
|
|
11432
11524
|
location: {
|
|
11525
|
+
description: "Location information for the [access control system](https://docs.seam.co/low-level-apis/access-systems).",
|
|
11433
11526
|
properties: {
|
|
11434
11527
|
time_zone: {
|
|
11435
11528
|
description: "Time zone in which the [access control system](https://docs.seam.co/low-level-apis/access-systems) is located.",
|
|
@@ -11472,6 +11565,7 @@ var openapi = {
|
|
|
11472
11565
|
"x-deprecated": "Use `external_type_display_name`."
|
|
11473
11566
|
},
|
|
11474
11567
|
visionline_metadata: {
|
|
11568
|
+
description: "Visionline-specific metadata for the [access control system](https://docs.seam.co/low-level-apis/access-systems).",
|
|
11475
11569
|
properties: {
|
|
11476
11570
|
lan_address: {
|
|
11477
11571
|
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 +11894,16 @@ var openapi = {
|
|
|
11800
11894
|
minLength: 1,
|
|
11801
11895
|
type: "string"
|
|
11802
11896
|
},
|
|
11803
|
-
hid_acs_system_id: {
|
|
11804
|
-
|
|
11897
|
+
hid_acs_system_id: {
|
|
11898
|
+
description: "ID of the HID access control system associated with the user.",
|
|
11899
|
+
format: "uuid",
|
|
11900
|
+
type: "string"
|
|
11901
|
+
},
|
|
11902
|
+
is_managed: {
|
|
11903
|
+
description: "Indicates whether Seam manages the access system user.",
|
|
11904
|
+
enum: [true],
|
|
11905
|
+
type: "boolean"
|
|
11906
|
+
},
|
|
11805
11907
|
is_suspended: {
|
|
11806
11908
|
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
11909
|
type: "boolean"
|
|
@@ -12649,7 +12751,11 @@ var openapi = {
|
|
|
12649
12751
|
nullable: true,
|
|
12650
12752
|
type: "string"
|
|
12651
12753
|
},
|
|
12652
|
-
is_issued: {
|
|
12754
|
+
is_issued: {
|
|
12755
|
+
description: "Indicates whether the credential has been issued (encoded onto a card).",
|
|
12756
|
+
nullable: true,
|
|
12757
|
+
type: "boolean"
|
|
12758
|
+
},
|
|
12653
12759
|
starts_at: {
|
|
12654
12760
|
description: "Date and time at which the [credential](https://docs.seam.co/low-level-apis/access-systems/managing-credentials) becomes usable.",
|
|
12655
12761
|
format: "date-time",
|
|
@@ -12752,6 +12858,7 @@ var openapi = {
|
|
|
12752
12858
|
type: "string"
|
|
12753
12859
|
},
|
|
12754
12860
|
acs_credential_pool_id: {
|
|
12861
|
+
description: "ID of the credential pool to which the credential belongs.",
|
|
12755
12862
|
format: "uuid",
|
|
12756
12863
|
type: "string"
|
|
12757
12864
|
},
|
|
@@ -12869,7 +12976,11 @@ var openapi = {
|
|
|
12869
12976
|
nullable: true,
|
|
12870
12977
|
type: "boolean"
|
|
12871
12978
|
},
|
|
12872
|
-
is_managed: {
|
|
12979
|
+
is_managed: {
|
|
12980
|
+
description: "Indicates whether Seam manages the credential.",
|
|
12981
|
+
enum: [true],
|
|
12982
|
+
type: "boolean"
|
|
12983
|
+
},
|
|
12873
12984
|
is_multi_phone_sync_credential: {
|
|
12874
12985
|
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
12986
|
type: "boolean"
|
|
@@ -13144,6 +13255,7 @@ var openapi = {
|
|
|
13144
13255
|
type: "string"
|
|
13145
13256
|
},
|
|
13146
13257
|
acs_credential_pool_id: {
|
|
13258
|
+
description: "ID of the credential pool to which the credential belongs.",
|
|
13147
13259
|
format: "uuid",
|
|
13148
13260
|
type: "string"
|
|
13149
13261
|
},
|
|
@@ -13762,6 +13874,7 @@ var openapi = {
|
|
|
13762
13874
|
type: "string"
|
|
13763
13875
|
},
|
|
13764
13876
|
acs_credential_pool_id: {
|
|
13877
|
+
description: "ID of the credential pool to which the credential belongs.",
|
|
13765
13878
|
format: "uuid",
|
|
13766
13879
|
type: "string"
|
|
13767
13880
|
},
|
|
@@ -13879,7 +13992,11 @@ var openapi = {
|
|
|
13879
13992
|
nullable: true,
|
|
13880
13993
|
type: "boolean"
|
|
13881
13994
|
},
|
|
13882
|
-
is_managed: {
|
|
13995
|
+
is_managed: {
|
|
13996
|
+
description: "Indicates whether Seam manages the credential.",
|
|
13997
|
+
enum: [true],
|
|
13998
|
+
type: "boolean"
|
|
13999
|
+
},
|
|
13883
14000
|
is_multi_phone_sync_credential: {
|
|
13884
14001
|
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
14002
|
type: "boolean"
|
|
@@ -14152,6 +14269,7 @@ var openapi = {
|
|
|
14152
14269
|
type: "string"
|
|
14153
14270
|
},
|
|
14154
14271
|
acs_credential_pool_id: {
|
|
14272
|
+
description: "ID of the credential pool to which the credential belongs.",
|
|
14155
14273
|
format: "uuid",
|
|
14156
14274
|
type: "string"
|
|
14157
14275
|
},
|
|
@@ -14796,7 +14914,11 @@ var openapi = {
|
|
|
14796
14914
|
format: "uuid",
|
|
14797
14915
|
type: "string"
|
|
14798
14916
|
},
|
|
14799
|
-
acs_credential_pool_id: {
|
|
14917
|
+
acs_credential_pool_id: {
|
|
14918
|
+
description: "ID of the credential pool to which the credential belongs.",
|
|
14919
|
+
format: "uuid",
|
|
14920
|
+
type: "string"
|
|
14921
|
+
},
|
|
14800
14922
|
acs_system_id: {
|
|
14801
14923
|
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
14924
|
format: "uuid",
|
|
@@ -14911,7 +15033,11 @@ var openapi = {
|
|
|
14911
15033
|
nullable: true,
|
|
14912
15034
|
type: "boolean"
|
|
14913
15035
|
},
|
|
14914
|
-
is_managed: {
|
|
15036
|
+
is_managed: {
|
|
15037
|
+
description: "Indicates whether Seam manages the credential.",
|
|
15038
|
+
enum: [true],
|
|
15039
|
+
type: "boolean"
|
|
15040
|
+
},
|
|
14915
15041
|
is_multi_phone_sync_credential: {
|
|
14916
15042
|
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
15043
|
type: "boolean"
|
|
@@ -17797,6 +17923,7 @@ var openapi = {
|
|
|
17797
17923
|
type: "string"
|
|
17798
17924
|
},
|
|
17799
17925
|
device_selection_mode: {
|
|
17926
|
+
description: "Device selection mode of the Connect Webview. Supported values: `none`, `single`, `multiple`.",
|
|
17800
17927
|
enum: ["none", "single", "multiple"],
|
|
17801
17928
|
type: "string"
|
|
17802
17929
|
},
|
|
@@ -18475,30 +18602,86 @@ var openapi = {
|
|
|
18475
18602
|
device: {
|
|
18476
18603
|
description: "Represents a [device](https://docs.seam.co/core-concepts/devices) that has been connected to Seam.",
|
|
18477
18604
|
properties: {
|
|
18478
|
-
can_configure_auto_lock: {
|
|
18479
|
-
|
|
18480
|
-
|
|
18481
|
-
|
|
18482
|
-
|
|
18483
|
-
|
|
18605
|
+
can_configure_auto_lock: {
|
|
18606
|
+
description: "Indicates whether the lock supports configuring automatic locking.",
|
|
18607
|
+
type: "boolean"
|
|
18608
|
+
},
|
|
18609
|
+
can_hvac_cool: {
|
|
18610
|
+
description: "Indicates whether the thermostat supports cooling.",
|
|
18611
|
+
type: "boolean"
|
|
18612
|
+
},
|
|
18613
|
+
can_hvac_heat: {
|
|
18614
|
+
description: "Indicates whether the thermostat supports heating.",
|
|
18615
|
+
type: "boolean"
|
|
18616
|
+
},
|
|
18617
|
+
can_hvac_heat_cool: {
|
|
18618
|
+
description: "Indicates whether the thermostat supports simultaneous heating and cooling.",
|
|
18619
|
+
type: "boolean"
|
|
18620
|
+
},
|
|
18621
|
+
can_program_offline_access_codes: {
|
|
18622
|
+
description: "Indicates whether the device supports programming offline access codes.",
|
|
18623
|
+
type: "boolean"
|
|
18624
|
+
},
|
|
18625
|
+
can_program_online_access_codes: {
|
|
18626
|
+
description: "Indicates whether the device supports programming online access codes.",
|
|
18627
|
+
type: "boolean"
|
|
18628
|
+
},
|
|
18484
18629
|
can_program_thermostat_programs_as_different_each_day: {
|
|
18630
|
+
description: "Indicates whether the thermostat supports different climate programs for each day of the week.",
|
|
18631
|
+
type: "boolean"
|
|
18632
|
+
},
|
|
18633
|
+
can_program_thermostat_programs_as_same_each_day: {
|
|
18634
|
+
description: "Indicates whether the thermostat supports a single climate program applied to every day.",
|
|
18485
18635
|
type: "boolean"
|
|
18486
18636
|
},
|
|
18487
|
-
can_program_thermostat_programs_as_same_each_day: { type: "boolean" },
|
|
18488
18637
|
can_program_thermostat_programs_as_weekday_weekend: {
|
|
18638
|
+
description: "Indicates whether the thermostat supports weekday/weekend climate programs.",
|
|
18639
|
+
type: "boolean"
|
|
18640
|
+
},
|
|
18641
|
+
can_remotely_lock: {
|
|
18642
|
+
description: "Indicates whether the device supports remote locking.",
|
|
18643
|
+
type: "boolean"
|
|
18644
|
+
},
|
|
18645
|
+
can_remotely_unlock: {
|
|
18646
|
+
description: "Indicates whether the device supports remote unlocking.",
|
|
18647
|
+
type: "boolean"
|
|
18648
|
+
},
|
|
18649
|
+
can_run_thermostat_programs: {
|
|
18650
|
+
description: "Indicates whether the thermostat supports running climate programs.",
|
|
18651
|
+
type: "boolean"
|
|
18652
|
+
},
|
|
18653
|
+
can_simulate_connection: {
|
|
18654
|
+
description: "Indicates whether the device supports simulating connection in a sandbox.",
|
|
18655
|
+
type: "boolean"
|
|
18656
|
+
},
|
|
18657
|
+
can_simulate_disconnection: {
|
|
18658
|
+
description: "Indicates whether the device supports simulating disconnection in a sandbox.",
|
|
18659
|
+
type: "boolean"
|
|
18660
|
+
},
|
|
18661
|
+
can_simulate_hub_connection: {
|
|
18662
|
+
description: "Indicates whether the hub supports simulating connection in a sandbox.",
|
|
18663
|
+
type: "boolean"
|
|
18664
|
+
},
|
|
18665
|
+
can_simulate_hub_disconnection: {
|
|
18666
|
+
description: "Indicates whether the hub supports simulating disconnection in a sandbox.",
|
|
18667
|
+
type: "boolean"
|
|
18668
|
+
},
|
|
18669
|
+
can_simulate_paid_subscription: {
|
|
18670
|
+
description: "Indicates whether the device supports simulating a paid subscription in a sandbox.",
|
|
18671
|
+
type: "boolean"
|
|
18672
|
+
},
|
|
18673
|
+
can_simulate_removal: {
|
|
18674
|
+
description: "Indicates whether the device supports simulating removal in a sandbox.",
|
|
18675
|
+
type: "boolean"
|
|
18676
|
+
},
|
|
18677
|
+
can_turn_off_hvac: {
|
|
18678
|
+
description: "Indicates whether the thermostat can be turned off.",
|
|
18679
|
+
type: "boolean"
|
|
18680
|
+
},
|
|
18681
|
+
can_unlock_with_code: {
|
|
18682
|
+
description: "Indicates whether the lock supports unlocking with an access code.",
|
|
18489
18683
|
type: "boolean"
|
|
18490
18684
|
},
|
|
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
18685
|
capabilities_supported: {
|
|
18503
18686
|
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
18687
|
items: {
|
|
@@ -20970,6 +21153,7 @@ var openapi = {
|
|
|
20970
21153
|
available_climate_preset_modes: {
|
|
20971
21154
|
description: 'Climate preset modes that the thermostat supports, such as "home", "away", "wake", "sleep", "occupied", and "unoccupied".',
|
|
20972
21155
|
items: {
|
|
21156
|
+
description: "Climate preset mode for the thermostat, such as `home`, `away`, `wake`, `sleep`, `occupied`, or `unoccupied`.",
|
|
20973
21157
|
enum: [
|
|
20974
21158
|
"home",
|
|
20975
21159
|
"away",
|
|
@@ -21103,6 +21287,7 @@ var openapi = {
|
|
|
21103
21287
|
available_fan_mode_settings: {
|
|
21104
21288
|
description: "Fan mode settings that the thermostat supports.",
|
|
21105
21289
|
items: {
|
|
21290
|
+
description: "Fan mode setting for the thermostat, such as `auto`, `on`, or `circulate`.",
|
|
21106
21291
|
enum: ["auto", "on", "circulate"],
|
|
21107
21292
|
type: "string"
|
|
21108
21293
|
},
|
|
@@ -21112,6 +21297,7 @@ var openapi = {
|
|
|
21112
21297
|
available_hvac_mode_settings: {
|
|
21113
21298
|
description: "HVAC mode settings that the thermostat supports.",
|
|
21114
21299
|
items: {
|
|
21300
|
+
description: "HVAC mode setting for the thermostat, such as `heat`, `cool`, `heat_cool`, `eco`, or `off`.",
|
|
21115
21301
|
enum: ["off", "heat", "cool", "heat_cool", "eco"],
|
|
21116
21302
|
type: "string"
|
|
21117
21303
|
},
|
|
@@ -22276,31 +22462,88 @@ var openapi = {
|
|
|
22276
22462
|
},
|
|
22277
22463
|
device_provider: {
|
|
22278
22464
|
properties: {
|
|
22279
|
-
can_configure_auto_lock: {
|
|
22280
|
-
|
|
22281
|
-
|
|
22282
|
-
|
|
22283
|
-
|
|
22284
|
-
|
|
22465
|
+
can_configure_auto_lock: {
|
|
22466
|
+
description: "Indicates whether the lock supports configuring automatic locking.",
|
|
22467
|
+
type: "boolean"
|
|
22468
|
+
},
|
|
22469
|
+
can_hvac_cool: {
|
|
22470
|
+
description: "Indicates whether the thermostat supports cooling.",
|
|
22471
|
+
type: "boolean"
|
|
22472
|
+
},
|
|
22473
|
+
can_hvac_heat: {
|
|
22474
|
+
description: "Indicates whether the thermostat supports heating.",
|
|
22475
|
+
type: "boolean"
|
|
22476
|
+
},
|
|
22477
|
+
can_hvac_heat_cool: {
|
|
22478
|
+
description: "Indicates whether the thermostat supports simultaneous heating and cooling.",
|
|
22479
|
+
type: "boolean"
|
|
22480
|
+
},
|
|
22481
|
+
can_program_offline_access_codes: {
|
|
22482
|
+
description: "Indicates whether the device supports programming offline access codes.",
|
|
22483
|
+
type: "boolean"
|
|
22484
|
+
},
|
|
22485
|
+
can_program_online_access_codes: {
|
|
22486
|
+
description: "Indicates whether the device supports programming online access codes.",
|
|
22487
|
+
type: "boolean"
|
|
22488
|
+
},
|
|
22285
22489
|
can_program_thermostat_programs_as_different_each_day: {
|
|
22490
|
+
description: "Indicates whether the thermostat supports different climate programs for each day of the week.",
|
|
22491
|
+
type: "boolean"
|
|
22492
|
+
},
|
|
22493
|
+
can_program_thermostat_programs_as_same_each_day: {
|
|
22494
|
+
description: "Indicates whether the thermostat supports a single climate program applied to every day.",
|
|
22286
22495
|
type: "boolean"
|
|
22287
22496
|
},
|
|
22288
|
-
can_program_thermostat_programs_as_same_each_day: { type: "boolean" },
|
|
22289
22497
|
can_program_thermostat_programs_as_weekday_weekend: {
|
|
22498
|
+
description: "Indicates whether the thermostat supports weekday/weekend climate programs.",
|
|
22499
|
+
type: "boolean"
|
|
22500
|
+
},
|
|
22501
|
+
can_remotely_lock: {
|
|
22502
|
+
description: "Indicates whether the device supports remote locking.",
|
|
22503
|
+
type: "boolean"
|
|
22504
|
+
},
|
|
22505
|
+
can_remotely_unlock: {
|
|
22506
|
+
description: "Indicates whether the device supports remote unlocking.",
|
|
22507
|
+
type: "boolean"
|
|
22508
|
+
},
|
|
22509
|
+
can_run_thermostat_programs: {
|
|
22510
|
+
description: "Indicates whether the thermostat supports running climate programs.",
|
|
22511
|
+
type: "boolean"
|
|
22512
|
+
},
|
|
22513
|
+
can_simulate_connection: {
|
|
22514
|
+
description: "Indicates whether the device supports simulating connection in a sandbox.",
|
|
22515
|
+
type: "boolean"
|
|
22516
|
+
},
|
|
22517
|
+
can_simulate_disconnection: {
|
|
22518
|
+
description: "Indicates whether the device supports simulating disconnection in a sandbox.",
|
|
22519
|
+
type: "boolean"
|
|
22520
|
+
},
|
|
22521
|
+
can_simulate_hub_connection: {
|
|
22522
|
+
description: "Indicates whether the hub supports simulating connection in a sandbox.",
|
|
22523
|
+
type: "boolean"
|
|
22524
|
+
},
|
|
22525
|
+
can_simulate_hub_disconnection: {
|
|
22526
|
+
description: "Indicates whether the hub supports simulating disconnection in a sandbox.",
|
|
22527
|
+
type: "boolean"
|
|
22528
|
+
},
|
|
22529
|
+
can_simulate_paid_subscription: {
|
|
22530
|
+
description: "Indicates whether the device supports simulating a paid subscription in a sandbox.",
|
|
22531
|
+
type: "boolean"
|
|
22532
|
+
},
|
|
22533
|
+
can_simulate_removal: {
|
|
22534
|
+
description: "Indicates whether the device supports simulating removal in a sandbox.",
|
|
22535
|
+
type: "boolean"
|
|
22536
|
+
},
|
|
22537
|
+
can_turn_off_hvac: {
|
|
22538
|
+
description: "Indicates whether the thermostat can be turned off.",
|
|
22539
|
+
type: "boolean"
|
|
22540
|
+
},
|
|
22541
|
+
can_unlock_with_code: {
|
|
22542
|
+
description: "Indicates whether the lock supports unlocking with an access code.",
|
|
22290
22543
|
type: "boolean"
|
|
22291
22544
|
},
|
|
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
22545
|
device_provider_name: {
|
|
22546
|
+
description: "Name of the device provider.",
|
|
22304
22547
|
enum: [
|
|
22305
22548
|
"hotek",
|
|
22306
22549
|
"dormakaba_community",
|
|
@@ -22365,9 +22608,16 @@ var openapi = {
|
|
|
22365
22608
|
],
|
|
22366
22609
|
type: "string"
|
|
22367
22610
|
},
|
|
22368
|
-
display_name: {
|
|
22369
|
-
|
|
22611
|
+
display_name: {
|
|
22612
|
+
description: "Display name for the device provider.",
|
|
22613
|
+
type: "string"
|
|
22614
|
+
},
|
|
22615
|
+
image_url: {
|
|
22616
|
+
description: "Image URL for the device provider.",
|
|
22617
|
+
type: "string"
|
|
22618
|
+
},
|
|
22370
22619
|
provider_categories: {
|
|
22620
|
+
description: "List of provider categories to which the device provider belongs, such as `stable`, `consumer_smartlocks`, `thermostats`, and so on.",
|
|
22371
22621
|
items: {
|
|
22372
22622
|
enum: [
|
|
22373
22623
|
"stable",
|
|
@@ -22519,6 +22769,7 @@ var openapi = {
|
|
|
22519
22769
|
changed_properties: {
|
|
22520
22770
|
description: "List of properties that changed on the access code.",
|
|
22521
22771
|
items: {
|
|
22772
|
+
description: "Record describing a single changed property.",
|
|
22522
22773
|
properties: {
|
|
22523
22774
|
from: {
|
|
22524
22775
|
description: "Previous value of the property, or null if not set.",
|
|
@@ -23138,6 +23389,7 @@ var openapi = {
|
|
|
23138
23389
|
access_code_errors: {
|
|
23139
23390
|
description: "Errors associated with the access code.",
|
|
23140
23391
|
items: {
|
|
23392
|
+
description: "Error associated with the resource, including the error code, message, and creation timestamp.",
|
|
23141
23393
|
properties: {
|
|
23142
23394
|
created_at: {
|
|
23143
23395
|
description: "Date and time at which Seam created the error.",
|
|
@@ -23166,6 +23418,7 @@ var openapi = {
|
|
|
23166
23418
|
access_code_warnings: {
|
|
23167
23419
|
description: "Warnings associated with the access code.",
|
|
23168
23420
|
items: {
|
|
23421
|
+
description: "Warning associated with the resource, including the warning code, message, and creation timestamp.",
|
|
23169
23422
|
properties: {
|
|
23170
23423
|
created_at: {
|
|
23171
23424
|
description: "Date and time at which Seam created the warning.",
|
|
@@ -23196,6 +23449,7 @@ var openapi = {
|
|
|
23196
23449
|
connected_account_errors: {
|
|
23197
23450
|
description: "Errors associated with the connected account.",
|
|
23198
23451
|
items: {
|
|
23452
|
+
description: "Error associated with the resource, including the error code, message, and creation timestamp.",
|
|
23199
23453
|
properties: {
|
|
23200
23454
|
created_at: {
|
|
23201
23455
|
description: "Date and time at which Seam created the error.",
|
|
@@ -23224,6 +23478,7 @@ var openapi = {
|
|
|
23224
23478
|
connected_account_warnings: {
|
|
23225
23479
|
description: "Warnings associated with the connected account.",
|
|
23226
23480
|
items: {
|
|
23481
|
+
description: "Warning associated with the resource, including the warning code, message, and creation timestamp.",
|
|
23227
23482
|
properties: {
|
|
23228
23483
|
created_at: {
|
|
23229
23484
|
description: "Date and time at which Seam created the warning.",
|
|
@@ -23259,6 +23514,7 @@ var openapi = {
|
|
|
23259
23514
|
device_errors: {
|
|
23260
23515
|
description: "Errors associated with the device.",
|
|
23261
23516
|
items: {
|
|
23517
|
+
description: "Error associated with the resource, including the error code, message, and creation timestamp.",
|
|
23262
23518
|
properties: {
|
|
23263
23519
|
created_at: {
|
|
23264
23520
|
description: "Date and time at which Seam created the error.",
|
|
@@ -23287,6 +23543,7 @@ var openapi = {
|
|
|
23287
23543
|
device_warnings: {
|
|
23288
23544
|
description: "Warnings associated with the device.",
|
|
23289
23545
|
items: {
|
|
23546
|
+
description: "Warning associated with the resource, including the warning code, message, and creation timestamp.",
|
|
23290
23547
|
properties: {
|
|
23291
23548
|
created_at: {
|
|
23292
23549
|
description: "Date and time at which Seam created the warning.",
|
|
@@ -23352,6 +23609,7 @@ var openapi = {
|
|
|
23352
23609
|
access_code_errors: {
|
|
23353
23610
|
description: "Errors associated with the access code.",
|
|
23354
23611
|
items: {
|
|
23612
|
+
description: "Error associated with the resource, including the error code, message, and creation timestamp.",
|
|
23355
23613
|
properties: {
|
|
23356
23614
|
created_at: {
|
|
23357
23615
|
description: "Date and time at which Seam created the error.",
|
|
@@ -23380,6 +23638,7 @@ var openapi = {
|
|
|
23380
23638
|
access_code_warnings: {
|
|
23381
23639
|
description: "Warnings associated with the access code.",
|
|
23382
23640
|
items: {
|
|
23641
|
+
description: "Warning associated with the resource, including the warning code, message, and creation timestamp.",
|
|
23383
23642
|
properties: {
|
|
23384
23643
|
created_at: {
|
|
23385
23644
|
description: "Date and time at which Seam created the warning.",
|
|
@@ -23410,6 +23669,7 @@ var openapi = {
|
|
|
23410
23669
|
connected_account_errors: {
|
|
23411
23670
|
description: "Errors associated with the connected account.",
|
|
23412
23671
|
items: {
|
|
23672
|
+
description: "Error associated with the resource, including the error code, message, and creation timestamp.",
|
|
23413
23673
|
properties: {
|
|
23414
23674
|
created_at: {
|
|
23415
23675
|
description: "Date and time at which Seam created the error.",
|
|
@@ -23438,6 +23698,7 @@ var openapi = {
|
|
|
23438
23698
|
connected_account_warnings: {
|
|
23439
23699
|
description: "Warnings associated with the connected account.",
|
|
23440
23700
|
items: {
|
|
23701
|
+
description: "Warning associated with the resource, including the warning code, message, and creation timestamp.",
|
|
23441
23702
|
properties: {
|
|
23442
23703
|
created_at: {
|
|
23443
23704
|
description: "Date and time at which Seam created the warning.",
|
|
@@ -23473,6 +23734,7 @@ var openapi = {
|
|
|
23473
23734
|
device_errors: {
|
|
23474
23735
|
description: "Errors associated with the device.",
|
|
23475
23736
|
items: {
|
|
23737
|
+
description: "Error associated with the resource, including the error code, message, and creation timestamp.",
|
|
23476
23738
|
properties: {
|
|
23477
23739
|
created_at: {
|
|
23478
23740
|
description: "Date and time at which Seam created the error.",
|
|
@@ -23501,6 +23763,7 @@ var openapi = {
|
|
|
23501
23763
|
device_warnings: {
|
|
23502
23764
|
description: "Warnings associated with the device.",
|
|
23503
23765
|
items: {
|
|
23766
|
+
description: "Warning associated with the resource, including the warning code, message, and creation timestamp.",
|
|
23504
23767
|
properties: {
|
|
23505
23768
|
created_at: {
|
|
23506
23769
|
description: "Date and time at which Seam created the warning.",
|
|
@@ -23639,6 +23902,7 @@ var openapi = {
|
|
|
23639
23902
|
access_code_errors: {
|
|
23640
23903
|
description: "Errors associated with the access code.",
|
|
23641
23904
|
items: {
|
|
23905
|
+
description: "Error associated with the resource, including the error code, message, and creation timestamp.",
|
|
23642
23906
|
properties: {
|
|
23643
23907
|
created_at: {
|
|
23644
23908
|
description: "Date and time at which Seam created the error.",
|
|
@@ -23667,6 +23931,7 @@ var openapi = {
|
|
|
23667
23931
|
access_code_warnings: {
|
|
23668
23932
|
description: "Warnings associated with the access code.",
|
|
23669
23933
|
items: {
|
|
23934
|
+
description: "Warning associated with the resource, including the warning code, message, and creation timestamp.",
|
|
23670
23935
|
properties: {
|
|
23671
23936
|
created_at: {
|
|
23672
23937
|
description: "Date and time at which Seam created the warning.",
|
|
@@ -23697,6 +23962,7 @@ var openapi = {
|
|
|
23697
23962
|
connected_account_errors: {
|
|
23698
23963
|
description: "Errors associated with the connected account.",
|
|
23699
23964
|
items: {
|
|
23965
|
+
description: "Error associated with the resource, including the error code, message, and creation timestamp.",
|
|
23700
23966
|
properties: {
|
|
23701
23967
|
created_at: {
|
|
23702
23968
|
description: "Date and time at which Seam created the error.",
|
|
@@ -23725,6 +23991,7 @@ var openapi = {
|
|
|
23725
23991
|
connected_account_warnings: {
|
|
23726
23992
|
description: "Warnings associated with the connected account.",
|
|
23727
23993
|
items: {
|
|
23994
|
+
description: "Warning associated with the resource, including the warning code, message, and creation timestamp.",
|
|
23728
23995
|
properties: {
|
|
23729
23996
|
created_at: {
|
|
23730
23997
|
description: "Date and time at which Seam created the warning.",
|
|
@@ -23760,6 +24027,7 @@ var openapi = {
|
|
|
23760
24027
|
device_errors: {
|
|
23761
24028
|
description: "Errors associated with the device.",
|
|
23762
24029
|
items: {
|
|
24030
|
+
description: "Error associated with the resource, including the error code, message, and creation timestamp.",
|
|
23763
24031
|
properties: {
|
|
23764
24032
|
created_at: {
|
|
23765
24033
|
description: "Date and time at which Seam created the error.",
|
|
@@ -23788,6 +24056,7 @@ var openapi = {
|
|
|
23788
24056
|
device_warnings: {
|
|
23789
24057
|
description: "Warnings associated with the device.",
|
|
23790
24058
|
items: {
|
|
24059
|
+
description: "Warning associated with the resource, including the warning code, message, and creation timestamp.",
|
|
23791
24060
|
properties: {
|
|
23792
24061
|
created_at: {
|
|
23793
24062
|
description: "Date and time at which Seam created the warning.",
|
|
@@ -23853,6 +24122,7 @@ var openapi = {
|
|
|
23853
24122
|
access_code_errors: {
|
|
23854
24123
|
description: "Errors associated with the access code.",
|
|
23855
24124
|
items: {
|
|
24125
|
+
description: "Error associated with the resource, including the error code, message, and creation timestamp.",
|
|
23856
24126
|
properties: {
|
|
23857
24127
|
created_at: {
|
|
23858
24128
|
description: "Date and time at which Seam created the error.",
|
|
@@ -23881,6 +24151,7 @@ var openapi = {
|
|
|
23881
24151
|
access_code_warnings: {
|
|
23882
24152
|
description: "Warnings associated with the access code.",
|
|
23883
24153
|
items: {
|
|
24154
|
+
description: "Warning associated with the resource, including the warning code, message, and creation timestamp.",
|
|
23884
24155
|
properties: {
|
|
23885
24156
|
created_at: {
|
|
23886
24157
|
description: "Date and time at which Seam created the warning.",
|
|
@@ -23911,6 +24182,7 @@ var openapi = {
|
|
|
23911
24182
|
connected_account_errors: {
|
|
23912
24183
|
description: "Errors associated with the connected account.",
|
|
23913
24184
|
items: {
|
|
24185
|
+
description: "Error associated with the resource, including the error code, message, and creation timestamp.",
|
|
23914
24186
|
properties: {
|
|
23915
24187
|
created_at: {
|
|
23916
24188
|
description: "Date and time at which Seam created the error.",
|
|
@@ -23939,6 +24211,7 @@ var openapi = {
|
|
|
23939
24211
|
connected_account_warnings: {
|
|
23940
24212
|
description: "Warnings associated with the connected account.",
|
|
23941
24213
|
items: {
|
|
24214
|
+
description: "Warning associated with the resource, including the warning code, message, and creation timestamp.",
|
|
23942
24215
|
properties: {
|
|
23943
24216
|
created_at: {
|
|
23944
24217
|
description: "Date and time at which Seam created the warning.",
|
|
@@ -23974,6 +24247,7 @@ var openapi = {
|
|
|
23974
24247
|
device_errors: {
|
|
23975
24248
|
description: "Errors associated with the device.",
|
|
23976
24249
|
items: {
|
|
24250
|
+
description: "Error associated with the resource, including the error code, message, and creation timestamp.",
|
|
23977
24251
|
properties: {
|
|
23978
24252
|
created_at: {
|
|
23979
24253
|
description: "Date and time at which Seam created the error.",
|
|
@@ -24002,6 +24276,7 @@ var openapi = {
|
|
|
24002
24276
|
device_warnings: {
|
|
24003
24277
|
description: "Warnings associated with the device.",
|
|
24004
24278
|
items: {
|
|
24279
|
+
description: "Warning associated with the resource, including the warning code, message, and creation timestamp.",
|
|
24005
24280
|
properties: {
|
|
24006
24281
|
created_at: {
|
|
24007
24282
|
description: "Date and time at which Seam created the warning.",
|
|
@@ -24209,7 +24484,10 @@ var openapi = {
|
|
|
24209
24484
|
format: "uuid",
|
|
24210
24485
|
type: "string"
|
|
24211
24486
|
},
|
|
24212
|
-
backup_access_code_id: {
|
|
24487
|
+
backup_access_code_id: {
|
|
24488
|
+
description: "ID of the backup access code that was pulled from the pool.",
|
|
24489
|
+
type: "string"
|
|
24490
|
+
},
|
|
24213
24491
|
connected_account_custom_metadata: {
|
|
24214
24492
|
additionalProperties: {
|
|
24215
24493
|
oneOf: [{ type: "string" }, { type: "boolean" }]
|
|
@@ -24349,6 +24627,7 @@ var openapi = {
|
|
|
24349
24627
|
access_code_errors: {
|
|
24350
24628
|
description: "Errors associated with the access code.",
|
|
24351
24629
|
items: {
|
|
24630
|
+
description: "Error associated with the resource, including the error code, message, and creation timestamp.",
|
|
24352
24631
|
properties: {
|
|
24353
24632
|
created_at: {
|
|
24354
24633
|
description: "Date and time at which Seam created the error.",
|
|
@@ -24377,6 +24656,7 @@ var openapi = {
|
|
|
24377
24656
|
access_code_warnings: {
|
|
24378
24657
|
description: "Warnings associated with the access code.",
|
|
24379
24658
|
items: {
|
|
24659
|
+
description: "Warning associated with the resource, including the warning code, message, and creation timestamp.",
|
|
24380
24660
|
properties: {
|
|
24381
24661
|
created_at: {
|
|
24382
24662
|
description: "Date and time at which Seam created the warning.",
|
|
@@ -24407,6 +24687,7 @@ var openapi = {
|
|
|
24407
24687
|
connected_account_errors: {
|
|
24408
24688
|
description: "Errors associated with the connected account.",
|
|
24409
24689
|
items: {
|
|
24690
|
+
description: "Error associated with the resource, including the error code, message, and creation timestamp.",
|
|
24410
24691
|
properties: {
|
|
24411
24692
|
created_at: {
|
|
24412
24693
|
description: "Date and time at which Seam created the error.",
|
|
@@ -24435,6 +24716,7 @@ var openapi = {
|
|
|
24435
24716
|
connected_account_warnings: {
|
|
24436
24717
|
description: "Warnings associated with the connected account.",
|
|
24437
24718
|
items: {
|
|
24719
|
+
description: "Warning associated with the resource, including the warning code, message, and creation timestamp.",
|
|
24438
24720
|
properties: {
|
|
24439
24721
|
created_at: {
|
|
24440
24722
|
description: "Date and time at which Seam created the warning.",
|
|
@@ -24470,6 +24752,7 @@ var openapi = {
|
|
|
24470
24752
|
device_errors: {
|
|
24471
24753
|
description: "Errors associated with the device.",
|
|
24472
24754
|
items: {
|
|
24755
|
+
description: "Error associated with the resource, including the error code, message, and creation timestamp.",
|
|
24473
24756
|
properties: {
|
|
24474
24757
|
created_at: {
|
|
24475
24758
|
description: "Date and time at which Seam created the error.",
|
|
@@ -24498,6 +24781,7 @@ var openapi = {
|
|
|
24498
24781
|
device_warnings: {
|
|
24499
24782
|
description: "Warnings associated with the device.",
|
|
24500
24783
|
items: {
|
|
24784
|
+
description: "Warning associated with the resource, including the warning code, message, and creation timestamp.",
|
|
24501
24785
|
properties: {
|
|
24502
24786
|
created_at: {
|
|
24503
24787
|
description: "Date and time at which Seam created the warning.",
|
|
@@ -25464,6 +25748,7 @@ var openapi = {
|
|
|
25464
25748
|
acs_system_errors: {
|
|
25465
25749
|
description: "Errors associated with the access control system.",
|
|
25466
25750
|
items: {
|
|
25751
|
+
description: "Error associated with the resource, including the error code, message, and creation timestamp.",
|
|
25467
25752
|
properties: {
|
|
25468
25753
|
created_at: {
|
|
25469
25754
|
description: "Date and time at which Seam created the error.",
|
|
@@ -25492,6 +25777,7 @@ var openapi = {
|
|
|
25492
25777
|
acs_system_warnings: {
|
|
25493
25778
|
description: "Warnings associated with the access control system.",
|
|
25494
25779
|
items: {
|
|
25780
|
+
description: "Warning associated with the resource, including the warning code, message, and creation timestamp.",
|
|
25495
25781
|
properties: {
|
|
25496
25782
|
created_at: {
|
|
25497
25783
|
description: "Date and time at which Seam created the warning.",
|
|
@@ -25515,6 +25801,7 @@ var openapi = {
|
|
|
25515
25801
|
connected_account_errors: {
|
|
25516
25802
|
description: "Errors associated with the connected account.",
|
|
25517
25803
|
items: {
|
|
25804
|
+
description: "Error associated with the resource, including the error code, message, and creation timestamp.",
|
|
25518
25805
|
properties: {
|
|
25519
25806
|
created_at: {
|
|
25520
25807
|
description: "Date and time at which Seam created the error.",
|
|
@@ -25543,6 +25830,7 @@ var openapi = {
|
|
|
25543
25830
|
connected_account_warnings: {
|
|
25544
25831
|
description: "Warnings associated with the connected account.",
|
|
25545
25832
|
items: {
|
|
25833
|
+
description: "Warning associated with the resource, including the warning code, message, and creation timestamp.",
|
|
25546
25834
|
properties: {
|
|
25547
25835
|
created_at: {
|
|
25548
25836
|
description: "Date and time at which Seam created the warning.",
|
|
@@ -25819,7 +26107,11 @@ var openapi = {
|
|
|
25819
26107
|
format: "uuid",
|
|
25820
26108
|
type: "string"
|
|
25821
26109
|
},
|
|
25822
|
-
acs_user_id: {
|
|
26110
|
+
acs_user_id: {
|
|
26111
|
+
description: "ID of the affected access system user.",
|
|
26112
|
+
format: "uuid",
|
|
26113
|
+
type: "string"
|
|
26114
|
+
},
|
|
25823
26115
|
connected_account_id: {
|
|
25824
26116
|
description: "ID of the connected account.",
|
|
25825
26117
|
format: "uuid",
|
|
@@ -25867,7 +26159,11 @@ var openapi = {
|
|
|
25867
26159
|
format: "uuid",
|
|
25868
26160
|
type: "string"
|
|
25869
26161
|
},
|
|
25870
|
-
acs_user_id: {
|
|
26162
|
+
acs_user_id: {
|
|
26163
|
+
description: "ID of the affected access system user.",
|
|
26164
|
+
format: "uuid",
|
|
26165
|
+
type: "string"
|
|
26166
|
+
},
|
|
25871
26167
|
connected_account_id: {
|
|
25872
26168
|
description: "ID of the connected account.",
|
|
25873
26169
|
format: "uuid",
|
|
@@ -26069,7 +26365,11 @@ var openapi = {
|
|
|
26069
26365
|
{
|
|
26070
26366
|
description: "An [access system entrance](https://docs.seam.co/low-level-apis/access-systems/retrieving-entrance-details) was added.",
|
|
26071
26367
|
properties: {
|
|
26072
|
-
acs_entrance_id: {
|
|
26368
|
+
acs_entrance_id: {
|
|
26369
|
+
description: "ID of the affected entrance.",
|
|
26370
|
+
format: "uuid",
|
|
26371
|
+
type: "string"
|
|
26372
|
+
},
|
|
26073
26373
|
acs_system_id: {
|
|
26074
26374
|
description: "ID of the access system.",
|
|
26075
26375
|
format: "uuid",
|
|
@@ -26117,7 +26417,11 @@ var openapi = {
|
|
|
26117
26417
|
{
|
|
26118
26418
|
description: "An [access system entrance](https://docs.seam.co/low-level-apis/access-systems/retrieving-entrance-details) was removed.",
|
|
26119
26419
|
properties: {
|
|
26120
|
-
acs_entrance_id: {
|
|
26420
|
+
acs_entrance_id: {
|
|
26421
|
+
description: "ID of the affected entrance.",
|
|
26422
|
+
format: "uuid",
|
|
26423
|
+
type: "string"
|
|
26424
|
+
},
|
|
26121
26425
|
acs_system_id: {
|
|
26122
26426
|
description: "ID of the access system.",
|
|
26123
26427
|
format: "uuid",
|
|
@@ -26392,6 +26696,7 @@ var openapi = {
|
|
|
26392
26696
|
connected_account_errors: {
|
|
26393
26697
|
description: "Errors associated with the connected account.",
|
|
26394
26698
|
items: {
|
|
26699
|
+
description: "Error associated with the resource, including the error code, message, and creation timestamp.",
|
|
26395
26700
|
properties: {
|
|
26396
26701
|
created_at: {
|
|
26397
26702
|
description: "Date and time at which Seam created the error.",
|
|
@@ -26420,6 +26725,7 @@ var openapi = {
|
|
|
26420
26725
|
connected_account_warnings: {
|
|
26421
26726
|
description: "Warnings associated with the connected account.",
|
|
26422
26727
|
items: {
|
|
26728
|
+
description: "Warning associated with the resource, including the warning code, message, and creation timestamp.",
|
|
26423
26729
|
properties: {
|
|
26424
26730
|
created_at: {
|
|
26425
26731
|
description: "Date and time at which Seam created the warning.",
|
|
@@ -26654,6 +26960,7 @@ var openapi = {
|
|
|
26654
26960
|
connected_account_errors: {
|
|
26655
26961
|
description: "Errors associated with the connected account.",
|
|
26656
26962
|
items: {
|
|
26963
|
+
description: "Error associated with the resource, including the error code, message, and creation timestamp.",
|
|
26657
26964
|
properties: {
|
|
26658
26965
|
created_at: {
|
|
26659
26966
|
description: "Date and time at which Seam created the error.",
|
|
@@ -26682,6 +26989,7 @@ var openapi = {
|
|
|
26682
26989
|
connected_account_warnings: {
|
|
26683
26990
|
description: "Warnings associated with the connected account.",
|
|
26684
26991
|
items: {
|
|
26992
|
+
description: "Warning associated with the resource, including the warning code, message, and creation timestamp.",
|
|
26685
26993
|
properties: {
|
|
26686
26994
|
created_at: {
|
|
26687
26995
|
description: "Date and time at which Seam created the warning.",
|
|
@@ -27682,6 +27990,7 @@ var openapi = {
|
|
|
27682
27990
|
connected_account_errors: {
|
|
27683
27991
|
description: "Errors associated with the connected account.",
|
|
27684
27992
|
items: {
|
|
27993
|
+
description: "Error associated with the resource, including the error code, message, and creation timestamp.",
|
|
27685
27994
|
properties: {
|
|
27686
27995
|
created_at: {
|
|
27687
27996
|
description: "Date and time at which Seam created the error.",
|
|
@@ -27710,6 +28019,7 @@ var openapi = {
|
|
|
27710
28019
|
connected_account_warnings: {
|
|
27711
28020
|
description: "Warnings associated with the connected account.",
|
|
27712
28021
|
items: {
|
|
28022
|
+
description: "Warning associated with the resource, including the warning code, message, and creation timestamp.",
|
|
27713
28023
|
properties: {
|
|
27714
28024
|
created_at: {
|
|
27715
28025
|
description: "Date and time at which Seam created the warning.",
|
|
@@ -27749,6 +28059,7 @@ var openapi = {
|
|
|
27749
28059
|
device_errors: {
|
|
27750
28060
|
description: "Errors associated with the device.",
|
|
27751
28061
|
items: {
|
|
28062
|
+
description: "Error associated with the resource, including the error code, message, and creation timestamp.",
|
|
27752
28063
|
properties: {
|
|
27753
28064
|
created_at: {
|
|
27754
28065
|
description: "Date and time at which Seam created the error.",
|
|
@@ -27777,6 +28088,7 @@ var openapi = {
|
|
|
27777
28088
|
device_warnings: {
|
|
27778
28089
|
description: "Warnings associated with the device.",
|
|
27779
28090
|
items: {
|
|
28091
|
+
description: "Warning associated with the resource, including the warning code, message, and creation timestamp.",
|
|
27780
28092
|
properties: {
|
|
27781
28093
|
created_at: {
|
|
27782
28094
|
description: "Date and time at which Seam created the warning.",
|
|
@@ -27853,6 +28165,7 @@ var openapi = {
|
|
|
27853
28165
|
connected_account_errors: {
|
|
27854
28166
|
description: "Errors associated with the connected account.",
|
|
27855
28167
|
items: {
|
|
28168
|
+
description: "Error associated with the resource, including the error code, message, and creation timestamp.",
|
|
27856
28169
|
properties: {
|
|
27857
28170
|
created_at: {
|
|
27858
28171
|
description: "Date and time at which Seam created the error.",
|
|
@@ -27881,6 +28194,7 @@ var openapi = {
|
|
|
27881
28194
|
connected_account_warnings: {
|
|
27882
28195
|
description: "Warnings associated with the connected account.",
|
|
27883
28196
|
items: {
|
|
28197
|
+
description: "Warning associated with the resource, including the warning code, message, and creation timestamp.",
|
|
27884
28198
|
properties: {
|
|
27885
28199
|
created_at: {
|
|
27886
28200
|
description: "Date and time at which Seam created the warning.",
|
|
@@ -27920,6 +28234,7 @@ var openapi = {
|
|
|
27920
28234
|
device_errors: {
|
|
27921
28235
|
description: "Errors associated with the device.",
|
|
27922
28236
|
items: {
|
|
28237
|
+
description: "Error associated with the resource, including the error code, message, and creation timestamp.",
|
|
27923
28238
|
properties: {
|
|
27924
28239
|
created_at: {
|
|
27925
28240
|
description: "Date and time at which Seam created the error.",
|
|
@@ -27948,6 +28263,7 @@ var openapi = {
|
|
|
27948
28263
|
device_warnings: {
|
|
27949
28264
|
description: "Warnings associated with the device.",
|
|
27950
28265
|
items: {
|
|
28266
|
+
description: "Warning associated with the resource, including the warning code, message, and creation timestamp.",
|
|
27951
28267
|
properties: {
|
|
27952
28268
|
created_at: {
|
|
27953
28269
|
description: "Date and time at which Seam created the warning.",
|
|
@@ -28654,6 +28970,7 @@ var openapi = {
|
|
|
28654
28970
|
connected_account_errors: {
|
|
28655
28971
|
description: "Errors associated with the connected account.",
|
|
28656
28972
|
items: {
|
|
28973
|
+
description: "Error associated with the resource, including the error code, message, and creation timestamp.",
|
|
28657
28974
|
properties: {
|
|
28658
28975
|
created_at: {
|
|
28659
28976
|
description: "Date and time at which Seam created the error.",
|
|
@@ -28682,6 +28999,7 @@ var openapi = {
|
|
|
28682
28999
|
connected_account_warnings: {
|
|
28683
29000
|
description: "Warnings associated with the connected account.",
|
|
28684
29001
|
items: {
|
|
29002
|
+
description: "Warning associated with the resource, including the warning code, message, and creation timestamp.",
|
|
28685
29003
|
properties: {
|
|
28686
29004
|
created_at: {
|
|
28687
29005
|
description: "Date and time at which Seam created the warning.",
|
|
@@ -28721,6 +29039,7 @@ var openapi = {
|
|
|
28721
29039
|
device_errors: {
|
|
28722
29040
|
description: "Errors associated with the device.",
|
|
28723
29041
|
items: {
|
|
29042
|
+
description: "Error associated with the resource, including the error code, message, and creation timestamp.",
|
|
28724
29043
|
properties: {
|
|
28725
29044
|
created_at: {
|
|
28726
29045
|
description: "Date and time at which Seam created the error.",
|
|
@@ -28749,6 +29068,7 @@ var openapi = {
|
|
|
28749
29068
|
device_warnings: {
|
|
28750
29069
|
description: "Warnings associated with the device.",
|
|
28751
29070
|
items: {
|
|
29071
|
+
description: "Warning associated with the resource, including the warning code, message, and creation timestamp.",
|
|
28752
29072
|
properties: {
|
|
28753
29073
|
created_at: {
|
|
28754
29074
|
description: "Date and time at which Seam created the warning.",
|
|
@@ -28886,6 +29206,7 @@ var openapi = {
|
|
|
28886
29206
|
connected_account_errors: {
|
|
28887
29207
|
description: "Errors associated with the connected account.",
|
|
28888
29208
|
items: {
|
|
29209
|
+
description: "Error associated with the resource, including the error code, message, and creation timestamp.",
|
|
28889
29210
|
properties: {
|
|
28890
29211
|
created_at: {
|
|
28891
29212
|
description: "Date and time at which Seam created the error.",
|
|
@@ -28914,6 +29235,7 @@ var openapi = {
|
|
|
28914
29235
|
connected_account_warnings: {
|
|
28915
29236
|
description: "Warnings associated with the connected account.",
|
|
28916
29237
|
items: {
|
|
29238
|
+
description: "Warning associated with the resource, including the warning code, message, and creation timestamp.",
|
|
28917
29239
|
properties: {
|
|
28918
29240
|
created_at: {
|
|
28919
29241
|
description: "Date and time at which Seam created the warning.",
|
|
@@ -28953,6 +29275,7 @@ var openapi = {
|
|
|
28953
29275
|
device_errors: {
|
|
28954
29276
|
description: "Errors associated with the device.",
|
|
28955
29277
|
items: {
|
|
29278
|
+
description: "Error associated with the resource, including the error code, message, and creation timestamp.",
|
|
28956
29279
|
properties: {
|
|
28957
29280
|
created_at: {
|
|
28958
29281
|
description: "Date and time at which Seam created the error.",
|
|
@@ -28981,6 +29304,7 @@ var openapi = {
|
|
|
28981
29304
|
device_warnings: {
|
|
28982
29305
|
description: "Warnings associated with the device.",
|
|
28983
29306
|
items: {
|
|
29307
|
+
description: "Warning associated with the resource, including the warning code, message, and creation timestamp.",
|
|
28984
29308
|
properties: {
|
|
28985
29309
|
created_at: {
|
|
28986
29310
|
description: "Date and time at which Seam created the warning.",
|
|
@@ -29186,6 +29510,7 @@ var openapi = {
|
|
|
29186
29510
|
connected_account_errors: {
|
|
29187
29511
|
description: "Errors associated with the connected account.",
|
|
29188
29512
|
items: {
|
|
29513
|
+
description: "Error associated with the resource, including the error code, message, and creation timestamp.",
|
|
29189
29514
|
properties: {
|
|
29190
29515
|
created_at: {
|
|
29191
29516
|
description: "Date and time at which Seam created the error.",
|
|
@@ -29214,6 +29539,7 @@ var openapi = {
|
|
|
29214
29539
|
connected_account_warnings: {
|
|
29215
29540
|
description: "Warnings associated with the connected account.",
|
|
29216
29541
|
items: {
|
|
29542
|
+
description: "Warning associated with the resource, including the warning code, message, and creation timestamp.",
|
|
29217
29543
|
properties: {
|
|
29218
29544
|
created_at: {
|
|
29219
29545
|
description: "Date and time at which Seam created the warning.",
|
|
@@ -29253,6 +29579,7 @@ var openapi = {
|
|
|
29253
29579
|
device_errors: {
|
|
29254
29580
|
description: "Errors associated with the device.",
|
|
29255
29581
|
items: {
|
|
29582
|
+
description: "Error associated with the resource, including the error code, message, and creation timestamp.",
|
|
29256
29583
|
properties: {
|
|
29257
29584
|
created_at: {
|
|
29258
29585
|
description: "Date and time at which Seam created the error.",
|
|
@@ -29281,6 +29608,7 @@ var openapi = {
|
|
|
29281
29608
|
device_warnings: {
|
|
29282
29609
|
description: "Warnings associated with the device.",
|
|
29283
29610
|
items: {
|
|
29611
|
+
description: "Warning associated with the resource, including the warning code, message, and creation timestamp.",
|
|
29284
29612
|
properties: {
|
|
29285
29613
|
created_at: {
|
|
29286
29614
|
description: "Date and time at which Seam created the warning.",
|
|
@@ -29647,6 +29975,21 @@ var openapi = {
|
|
|
29647
29975
|
format: "uuid",
|
|
29648
29976
|
type: "string"
|
|
29649
29977
|
},
|
|
29978
|
+
acs_entrance_id: {
|
|
29979
|
+
description: "\n undocumented: Unreleased.\n ---\n ID of the ACS entrance associated with the access-denied event.\n ",
|
|
29980
|
+
format: "uuid",
|
|
29981
|
+
type: "string"
|
|
29982
|
+
},
|
|
29983
|
+
acs_system_id: {
|
|
29984
|
+
description: "\n undocumented: Unreleased.\n ---\n ID of the ACS system associated with the access-denied event.\n ",
|
|
29985
|
+
format: "uuid",
|
|
29986
|
+
type: "string"
|
|
29987
|
+
},
|
|
29988
|
+
acs_user_id: {
|
|
29989
|
+
description: "\n undocumented: Unreleased.\n ---\n ID of the ACS user associated with the access-denied event.\n ",
|
|
29990
|
+
format: "uuid",
|
|
29991
|
+
type: "string"
|
|
29992
|
+
},
|
|
29650
29993
|
connected_account_custom_metadata: {
|
|
29651
29994
|
additionalProperties: {
|
|
29652
29995
|
oneOf: [{ type: "string" }, { type: "boolean" }]
|
|
@@ -29691,6 +30034,11 @@ var openapi = {
|
|
|
29691
30034
|
format: "date-time",
|
|
29692
30035
|
type: "string"
|
|
29693
30036
|
},
|
|
30037
|
+
user_identity_id: {
|
|
30038
|
+
description: "\n undocumented: Unreleased.\n ---\n ID of the user identity associated with the access-denied event.\n ",
|
|
30039
|
+
format: "uuid",
|
|
30040
|
+
type: "string"
|
|
30041
|
+
},
|
|
29694
30042
|
workspace_id: {
|
|
29695
30043
|
description: "ID of the workspace associated with the event.",
|
|
29696
30044
|
format: "uuid",
|
|
@@ -29702,7 +30050,6 @@ var openapi = {
|
|
|
29702
30050
|
"workspace_id",
|
|
29703
30051
|
"created_at",
|
|
29704
30052
|
"occurred_at",
|
|
29705
|
-
"device_id",
|
|
29706
30053
|
"connected_account_id",
|
|
29707
30054
|
"event_type"
|
|
29708
30055
|
],
|
|
@@ -30994,7 +31341,7 @@ var openapi = {
|
|
|
30994
31341
|
type: "string"
|
|
30995
31342
|
},
|
|
30996
31343
|
device_type: {
|
|
30997
|
-
description: "
|
|
31344
|
+
description: "Type of the phone device, such as `ios_phone` or `android_phone`.",
|
|
30998
31345
|
enum: ["ios_phone", "android_phone"],
|
|
30999
31346
|
type: "string"
|
|
31000
31347
|
},
|
|
@@ -31006,8 +31353,14 @@ var openapi = {
|
|
|
31006
31353
|
description: "Errors associated with the phone.",
|
|
31007
31354
|
items: {
|
|
31008
31355
|
properties: {
|
|
31009
|
-
error_code: {
|
|
31010
|
-
|
|
31356
|
+
error_code: {
|
|
31357
|
+
description: "Unique identifier of the type of error.",
|
|
31358
|
+
type: "string"
|
|
31359
|
+
},
|
|
31360
|
+
message: {
|
|
31361
|
+
description: "Detailed description of the error.",
|
|
31362
|
+
type: "string"
|
|
31363
|
+
}
|
|
31011
31364
|
},
|
|
31012
31365
|
required: ["error_code", "message"],
|
|
31013
31366
|
type: "object"
|
|
@@ -31019,7 +31372,7 @@ var openapi = {
|
|
|
31019
31372
|
type: "string"
|
|
31020
31373
|
},
|
|
31021
31374
|
properties: {
|
|
31022
|
-
description: "
|
|
31375
|
+
description: "Properties of the phone.",
|
|
31023
31376
|
properties: {
|
|
31024
31377
|
assa_abloy_credential_service_metadata: {
|
|
31025
31378
|
description: "ASSA ABLOY Credential Service metadata for the phone.",
|
|
@@ -31068,8 +31421,14 @@ var openapi = {
|
|
|
31068
31421
|
description: "Warnings associated with the phone.",
|
|
31069
31422
|
items: {
|
|
31070
31423
|
properties: {
|
|
31071
|
-
message: {
|
|
31072
|
-
|
|
31424
|
+
message: {
|
|
31425
|
+
description: "Detailed description of the warning.",
|
|
31426
|
+
type: "string"
|
|
31427
|
+
},
|
|
31428
|
+
warning_code: {
|
|
31429
|
+
description: "Unique identifier of the type of warning.",
|
|
31430
|
+
type: "string"
|
|
31431
|
+
}
|
|
31073
31432
|
},
|
|
31074
31433
|
required: ["warning_code", "message"],
|
|
31075
31434
|
type: "object"
|
|
@@ -31148,6 +31507,7 @@ var openapi = {
|
|
|
31148
31507
|
},
|
|
31149
31508
|
acs_credential_id: { nullable: true, type: "string" },
|
|
31150
31509
|
acs_credential_pool_id: {
|
|
31510
|
+
description: "ID of the credential pool to which the credential belongs.",
|
|
31151
31511
|
format: "uuid",
|
|
31152
31512
|
type: "string"
|
|
31153
31513
|
},
|
|
@@ -31758,7 +32118,11 @@ var openapi = {
|
|
|
31758
32118
|
nullable: true,
|
|
31759
32119
|
type: "boolean"
|
|
31760
32120
|
},
|
|
31761
|
-
is_managed: {
|
|
32121
|
+
is_managed: {
|
|
32122
|
+
description: "Indicates whether Seam manages the credential.",
|
|
32123
|
+
enum: [true],
|
|
32124
|
+
type: "boolean"
|
|
32125
|
+
},
|
|
31762
32126
|
is_multi_phone_sync_credential: {
|
|
31763
32127
|
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
32128
|
type: "boolean"
|
|
@@ -32068,7 +32432,11 @@ var openapi = {
|
|
|
32068
32432
|
format: "date-time",
|
|
32069
32433
|
type: "string"
|
|
32070
32434
|
},
|
|
32071
|
-
display_name: {
|
|
32435
|
+
display_name: {
|
|
32436
|
+
description: "Display name for the user identity.",
|
|
32437
|
+
minLength: 1,
|
|
32438
|
+
type: "string"
|
|
32439
|
+
},
|
|
32072
32440
|
email_address: {
|
|
32073
32441
|
description: "Unique email address for the user identity.",
|
|
32074
32442
|
format: "email",
|
|
@@ -32122,7 +32490,12 @@ var openapi = {
|
|
|
32122
32490
|
},
|
|
32123
32491
|
type: "array"
|
|
32124
32492
|
},
|
|
32125
|
-
full_name: {
|
|
32493
|
+
full_name: {
|
|
32494
|
+
description: "Full name of the user associated with the user identity.",
|
|
32495
|
+
minLength: 1,
|
|
32496
|
+
nullable: true,
|
|
32497
|
+
type: "string"
|
|
32498
|
+
},
|
|
32126
32499
|
phone_number: {
|
|
32127
32500
|
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
32501
|
nullable: true,
|
|
@@ -33936,7 +34309,10 @@ var openapi = {
|
|
|
33936
34309
|
format: "date-time",
|
|
33937
34310
|
type: "string"
|
|
33938
34311
|
},
|
|
33939
|
-
display_name: {
|
|
34312
|
+
display_name: {
|
|
34313
|
+
description: "Display name for the access group.",
|
|
34314
|
+
type: "string"
|
|
34315
|
+
},
|
|
33940
34316
|
errors: {
|
|
33941
34317
|
description: "Errors associated with the `acs_access_group`.",
|
|
33942
34318
|
items: {
|
|
@@ -34408,7 +34784,11 @@ var openapi = {
|
|
|
34408
34784
|
format: "uuid",
|
|
34409
34785
|
type: "string"
|
|
34410
34786
|
},
|
|
34411
|
-
acs_credential_pool_id: {
|
|
34787
|
+
acs_credential_pool_id: {
|
|
34788
|
+
description: "ID of the credential pool to which the credential belongs.",
|
|
34789
|
+
format: "uuid",
|
|
34790
|
+
type: "string"
|
|
34791
|
+
},
|
|
34412
34792
|
acs_system_id: {
|
|
34413
34793
|
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
34794
|
format: "uuid",
|
|
@@ -34968,7 +35348,11 @@ var openapi = {
|
|
|
34968
35348
|
minLength: 1,
|
|
34969
35349
|
type: "string"
|
|
34970
35350
|
},
|
|
34971
|
-
hid_acs_system_id: {
|
|
35351
|
+
hid_acs_system_id: {
|
|
35352
|
+
description: "ID of the HID access control system associated with the user.",
|
|
35353
|
+
format: "uuid",
|
|
35354
|
+
type: "string"
|
|
35355
|
+
},
|
|
34972
35356
|
is_managed: { enum: [false], type: "boolean" },
|
|
34973
35357
|
is_suspended: {
|
|
34974
35358
|
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 +35909,86 @@ var openapi = {
|
|
|
35525
35909
|
unmanaged_device: {
|
|
35526
35910
|
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
35911
|
properties: {
|
|
35528
|
-
can_configure_auto_lock: {
|
|
35529
|
-
|
|
35530
|
-
|
|
35531
|
-
|
|
35532
|
-
|
|
35533
|
-
|
|
35912
|
+
can_configure_auto_lock: {
|
|
35913
|
+
description: "Indicates whether the lock supports configuring automatic locking.",
|
|
35914
|
+
type: "boolean"
|
|
35915
|
+
},
|
|
35916
|
+
can_hvac_cool: {
|
|
35917
|
+
description: "Indicates whether the thermostat supports cooling.",
|
|
35918
|
+
type: "boolean"
|
|
35919
|
+
},
|
|
35920
|
+
can_hvac_heat: {
|
|
35921
|
+
description: "Indicates whether the thermostat supports heating.",
|
|
35922
|
+
type: "boolean"
|
|
35923
|
+
},
|
|
35924
|
+
can_hvac_heat_cool: {
|
|
35925
|
+
description: "Indicates whether the thermostat supports simultaneous heating and cooling.",
|
|
35926
|
+
type: "boolean"
|
|
35927
|
+
},
|
|
35928
|
+
can_program_offline_access_codes: {
|
|
35929
|
+
description: "Indicates whether the device supports programming offline access codes.",
|
|
35930
|
+
type: "boolean"
|
|
35931
|
+
},
|
|
35932
|
+
can_program_online_access_codes: {
|
|
35933
|
+
description: "Indicates whether the device supports programming online access codes.",
|
|
35934
|
+
type: "boolean"
|
|
35935
|
+
},
|
|
35534
35936
|
can_program_thermostat_programs_as_different_each_day: {
|
|
35937
|
+
description: "Indicates whether the thermostat supports different climate programs for each day of the week.",
|
|
35938
|
+
type: "boolean"
|
|
35939
|
+
},
|
|
35940
|
+
can_program_thermostat_programs_as_same_each_day: {
|
|
35941
|
+
description: "Indicates whether the thermostat supports a single climate program applied to every day.",
|
|
35535
35942
|
type: "boolean"
|
|
35536
35943
|
},
|
|
35537
|
-
can_program_thermostat_programs_as_same_each_day: { type: "boolean" },
|
|
35538
35944
|
can_program_thermostat_programs_as_weekday_weekend: {
|
|
35945
|
+
description: "Indicates whether the thermostat supports weekday/weekend climate programs.",
|
|
35946
|
+
type: "boolean"
|
|
35947
|
+
},
|
|
35948
|
+
can_remotely_lock: {
|
|
35949
|
+
description: "Indicates whether the device supports remote locking.",
|
|
35950
|
+
type: "boolean"
|
|
35951
|
+
},
|
|
35952
|
+
can_remotely_unlock: {
|
|
35953
|
+
description: "Indicates whether the device supports remote unlocking.",
|
|
35954
|
+
type: "boolean"
|
|
35955
|
+
},
|
|
35956
|
+
can_run_thermostat_programs: {
|
|
35957
|
+
description: "Indicates whether the thermostat supports running climate programs.",
|
|
35958
|
+
type: "boolean"
|
|
35959
|
+
},
|
|
35960
|
+
can_simulate_connection: {
|
|
35961
|
+
description: "Indicates whether the device supports simulating connection in a sandbox.",
|
|
35962
|
+
type: "boolean"
|
|
35963
|
+
},
|
|
35964
|
+
can_simulate_disconnection: {
|
|
35965
|
+
description: "Indicates whether the device supports simulating disconnection in a sandbox.",
|
|
35966
|
+
type: "boolean"
|
|
35967
|
+
},
|
|
35968
|
+
can_simulate_hub_connection: {
|
|
35969
|
+
description: "Indicates whether the hub supports simulating connection in a sandbox.",
|
|
35970
|
+
type: "boolean"
|
|
35971
|
+
},
|
|
35972
|
+
can_simulate_hub_disconnection: {
|
|
35973
|
+
description: "Indicates whether the hub supports simulating disconnection in a sandbox.",
|
|
35974
|
+
type: "boolean"
|
|
35975
|
+
},
|
|
35976
|
+
can_simulate_paid_subscription: {
|
|
35977
|
+
description: "Indicates whether the device supports simulating a paid subscription in a sandbox.",
|
|
35978
|
+
type: "boolean"
|
|
35979
|
+
},
|
|
35980
|
+
can_simulate_removal: {
|
|
35981
|
+
description: "Indicates whether the device supports simulating removal in a sandbox.",
|
|
35982
|
+
type: "boolean"
|
|
35983
|
+
},
|
|
35984
|
+
can_turn_off_hvac: {
|
|
35985
|
+
description: "Indicates whether the thermostat can be turned off.",
|
|
35986
|
+
type: "boolean"
|
|
35987
|
+
},
|
|
35988
|
+
can_unlock_with_code: {
|
|
35989
|
+
description: "Indicates whether the lock supports unlocking with an access code.",
|
|
35539
35990
|
type: "boolean"
|
|
35540
35991
|
},
|
|
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
35992
|
capabilities_supported: {
|
|
35553
35993
|
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
35994
|
items: {
|
|
@@ -36193,7 +36633,11 @@ var openapi = {
|
|
|
36193
36633
|
thermostats: { name: "Thermostats" }
|
|
36194
36634
|
}
|
|
36195
36635
|
},
|
|
36196
|
-
is_managed: {
|
|
36636
|
+
is_managed: {
|
|
36637
|
+
description: "Indicates that Seam does not manage the device.",
|
|
36638
|
+
enum: [false],
|
|
36639
|
+
type: "boolean"
|
|
36640
|
+
},
|
|
36197
36641
|
location: {
|
|
36198
36642
|
description: "Location information for the device.",
|
|
36199
36643
|
properties: {
|
|
@@ -37002,7 +37446,11 @@ var openapi = {
|
|
|
37002
37446
|
format: "date-time",
|
|
37003
37447
|
type: "string"
|
|
37004
37448
|
},
|
|
37005
|
-
display_name: {
|
|
37449
|
+
display_name: {
|
|
37450
|
+
description: "Display name for the user identity.",
|
|
37451
|
+
minLength: 1,
|
|
37452
|
+
type: "string"
|
|
37453
|
+
},
|
|
37006
37454
|
email_address: {
|
|
37007
37455
|
description: "Unique email address for the user identity.",
|
|
37008
37456
|
format: "email",
|
|
@@ -37056,7 +37504,12 @@ var openapi = {
|
|
|
37056
37504
|
},
|
|
37057
37505
|
type: "array"
|
|
37058
37506
|
},
|
|
37059
|
-
full_name: {
|
|
37507
|
+
full_name: {
|
|
37508
|
+
description: "Full name of the user associated with the user identity.",
|
|
37509
|
+
minLength: 1,
|
|
37510
|
+
nullable: true,
|
|
37511
|
+
type: "string"
|
|
37512
|
+
},
|
|
37060
37513
|
phone_number: {
|
|
37061
37514
|
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
37515
|
nullable: true,
|
|
@@ -40169,6 +40622,7 @@ var openapi = {
|
|
|
40169
40622
|
type: "string"
|
|
40170
40623
|
},
|
|
40171
40624
|
full_name: {
|
|
40625
|
+
description: "Full name of the user associated with the user identity.",
|
|
40172
40626
|
minLength: 1,
|
|
40173
40627
|
nullable: true,
|
|
40174
40628
|
type: "string"
|
|
@@ -52448,7 +52902,11 @@ var openapi = {
|
|
|
52448
52902
|
minLength: 1,
|
|
52449
52903
|
type: "string"
|
|
52450
52904
|
},
|
|
52451
|
-
hid_acs_system_id: {
|
|
52905
|
+
hid_acs_system_id: {
|
|
52906
|
+
description: "ID of the HID access control system associated with the user.",
|
|
52907
|
+
format: "uuid",
|
|
52908
|
+
type: "string"
|
|
52909
|
+
},
|
|
52452
52910
|
phone_number: {
|
|
52453
52911
|
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
52912
|
type: "string"
|
|
@@ -52544,7 +53002,11 @@ var openapi = {
|
|
|
52544
53002
|
minLength: 1,
|
|
52545
53003
|
type: "string"
|
|
52546
53004
|
},
|
|
52547
|
-
hid_acs_system_id: {
|
|
53005
|
+
hid_acs_system_id: {
|
|
53006
|
+
description: "ID of the HID access control system associated with the user.",
|
|
53007
|
+
format: "uuid",
|
|
53008
|
+
type: "string"
|
|
53009
|
+
},
|
|
52548
53010
|
phone_number: {
|
|
52549
53011
|
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
53012
|
type: "string"
|
|
@@ -82353,6 +82815,7 @@ var openapi = {
|
|
|
82353
82815
|
},
|
|
82354
82816
|
fan_mode: {
|
|
82355
82817
|
deprecated: true,
|
|
82818
|
+
description: "Fan mode setting for the thermostat, such as `auto`, `on`, or `circulate`.",
|
|
82356
82819
|
enum: ["auto", "on", "circulate"],
|
|
82357
82820
|
type: "string",
|
|
82358
82821
|
"x-deprecated": "Use `fan_mode_setting` instead."
|
|
@@ -85642,7 +86105,11 @@ var openapi = {
|
|
|
85642
86105
|
format: "date-time",
|
|
85643
86106
|
type: "string"
|
|
85644
86107
|
},
|
|
85645
|
-
display_name: {
|
|
86108
|
+
display_name: {
|
|
86109
|
+
description: "Display name for the user identity.",
|
|
86110
|
+
minLength: 1,
|
|
86111
|
+
type: "string"
|
|
86112
|
+
},
|
|
85646
86113
|
email_address: {
|
|
85647
86114
|
description: "Unique email address for the user identity.",
|
|
85648
86115
|
format: "email",
|
|
@@ -85697,6 +86164,7 @@ var openapi = {
|
|
|
85697
86164
|
type: "array"
|
|
85698
86165
|
},
|
|
85699
86166
|
full_name: {
|
|
86167
|
+
description: "Full name of the user associated with the user identity.",
|
|
85700
86168
|
minLength: 1,
|
|
85701
86169
|
nullable: true,
|
|
85702
86170
|
type: "string"
|
|
@@ -85859,7 +86327,11 @@ var openapi = {
|
|
|
85859
86327
|
format: "date-time",
|
|
85860
86328
|
type: "string"
|
|
85861
86329
|
},
|
|
85862
|
-
display_name: {
|
|
86330
|
+
display_name: {
|
|
86331
|
+
description: "Display name for the user identity.",
|
|
86332
|
+
minLength: 1,
|
|
86333
|
+
type: "string"
|
|
86334
|
+
},
|
|
85863
86335
|
email_address: {
|
|
85864
86336
|
description: "Unique email address for the user identity.",
|
|
85865
86337
|
format: "email",
|
|
@@ -85914,6 +86386,7 @@ var openapi = {
|
|
|
85914
86386
|
type: "array"
|
|
85915
86387
|
},
|
|
85916
86388
|
full_name: {
|
|
86389
|
+
description: "Full name of the user associated with the user identity.",
|
|
85917
86390
|
minLength: 1,
|
|
85918
86391
|
nullable: true,
|
|
85919
86392
|
type: "string"
|
|
@@ -86102,7 +86575,11 @@ var openapi = {
|
|
|
86102
86575
|
format: "date-time",
|
|
86103
86576
|
type: "string"
|
|
86104
86577
|
},
|
|
86105
|
-
display_name: {
|
|
86578
|
+
display_name: {
|
|
86579
|
+
description: "Display name for the user identity.",
|
|
86580
|
+
minLength: 1,
|
|
86581
|
+
type: "string"
|
|
86582
|
+
},
|
|
86106
86583
|
email_address: {
|
|
86107
86584
|
description: "Unique email address for the user identity.",
|
|
86108
86585
|
format: "email",
|
|
@@ -86157,6 +86634,7 @@ var openapi = {
|
|
|
86157
86634
|
type: "array"
|
|
86158
86635
|
},
|
|
86159
86636
|
full_name: {
|
|
86637
|
+
description: "Full name of the user associated with the user identity.",
|
|
86160
86638
|
minLength: 1,
|
|
86161
86639
|
nullable: true,
|
|
86162
86640
|
type: "string"
|
|
@@ -86339,7 +86817,11 @@ var openapi = {
|
|
|
86339
86817
|
format: "date-time",
|
|
86340
86818
|
type: "string"
|
|
86341
86819
|
},
|
|
86342
|
-
display_name: {
|
|
86820
|
+
display_name: {
|
|
86821
|
+
description: "Display name for the user identity.",
|
|
86822
|
+
minLength: 1,
|
|
86823
|
+
type: "string"
|
|
86824
|
+
},
|
|
86343
86825
|
email_address: {
|
|
86344
86826
|
description: "Unique email address for the user identity.",
|
|
86345
86827
|
format: "email",
|
|
@@ -86394,6 +86876,7 @@ var openapi = {
|
|
|
86394
86876
|
type: "array"
|
|
86395
86877
|
},
|
|
86396
86878
|
full_name: {
|
|
86879
|
+
description: "Full name of the user associated with the user identity.",
|
|
86397
86880
|
minLength: 1,
|
|
86398
86881
|
nullable: true,
|
|
86399
86882
|
type: "string"
|