@seamapi/types 1.915.0 → 1.917.0
This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
- package/dist/connect.cjs +938 -540
- package/dist/connect.cjs.map +1 -1
- package/dist/connect.d.cts +1928 -1071
- package/dist/index.cjs +938 -540
- package/dist/index.cjs.map +1 -1
- package/lib/seam/connect/models/acs/acs-access-group.js +6 -4
- package/lib/seam/connect/models/acs/acs-access-group.js.map +1 -1
- package/lib/seam/connect/models/acs/acs-credential-provisioning-automation.js +1 -1
- package/lib/seam/connect/models/acs/acs-credential-provisioning-automation.js.map +1 -1
- package/lib/seam/connect/models/acs/acs-credential.js +13 -4
- package/lib/seam/connect/models/acs/acs-credential.js.map +1 -1
- package/lib/seam/connect/models/acs/acs-encoder.js +2 -2
- package/lib/seam/connect/models/acs/acs-encoder.js.map +1 -1
- package/lib/seam/connect/models/acs/acs-system.js +17 -7
- package/lib/seam/connect/models/acs/acs-system.js.map +1 -1
- package/lib/seam/connect/models/acs/acs-users/acs-user.js +10 -4
- package/lib/seam/connect/models/acs/acs-users/acs-user.js.map +1 -1
- package/lib/seam/connect/models/bridges/bridge-connected-system.js +1 -1
- package/lib/seam/connect/models/bridges/bridge-connected-system.js.map +1 -1
- package/lib/seam/connect/models/bridges/bridge.js +1 -1
- package/lib/seam/connect/models/bridges/bridge.js.map +1 -1
- package/lib/seam/connect/models/client-sessions/client-session.js +2 -5
- package/lib/seam/connect/models/client-sessions/client-session.js.map +1 -1
- package/lib/seam/connect/models/connect-webviews/connect-webview.js +3 -3
- package/lib/seam/connect/models/connect-webviews/connect-webview.js.map +1 -1
- package/lib/seam/connect/models/customer/customer.js +1 -1
- package/lib/seam/connect/models/customer/customer.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 +11 -7
- 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 +8 -4
- 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/action-attempts.js +8 -8
- package/lib/seam/connect/models/events/client-sessions.js +1 -1
- package/lib/seam/connect/models/events/common.js +9 -5
- package/lib/seam/connect/models/events/common.js.map +1 -1
- package/lib/seam/connect/models/events/connect-webviews.js +4 -4
- package/lib/seam/connect/models/events/connect-webviews.js.map +1 -1
- package/lib/seam/connect/models/events/connected-accounts.js +10 -10
- package/lib/seam/connect/models/events/connected-accounts.js.map +1 -1
- package/lib/seam/connect/models/events/devices.js +20 -20
- package/lib/seam/connect/models/events/devices.js.map +1 -1
- package/lib/seam/connect/models/events/seam-event.js +1 -1
- package/lib/seam/connect/models/instant-keys/instant-key.js +2 -2
- package/lib/seam/connect/models/instant-keys/instant-key.js.map +1 -1
- package/lib/seam/connect/models/partner/customer-portal.js +1 -1
- package/lib/seam/connect/models/partner/customer-portal.js.map +1 -1
- package/lib/seam/connect/models/partner/magic-link.js +1 -1
- package/lib/seam/connect/models/partner/magic-link.js.map +1 -1
- package/lib/seam/connect/models/spaces/space.js +1 -1
- package/lib/seam/connect/models/spaces/space.js.map +1 -1
- package/lib/seam/connect/models/thermostats/modes.js +9 -16
- package/lib/seam/connect/models/thermostats/modes.js.map +1 -1
- package/lib/seam/connect/models/thermostats/thermostat-program.js +1 -1
- package/lib/seam/connect/models/thermostats/thermostat-program.js.map +1 -1
- package/lib/seam/connect/models/thermostats/thermostat-schedule.js +1 -1
- package/lib/seam/connect/models/thermostats/thermostat-schedule.js.map +1 -1
- package/lib/seam/connect/models/user-identities/user-identity.js +10 -3
- package/lib/seam/connect/models/user-identities/user-identity.js.map +1 -1
- package/lib/seam/connect/models/webhooks/webhook.js +1 -3
- package/lib/seam/connect/models/webhooks/webhook.js.map +1 -1
- package/lib/seam/connect/models/workspaces/workspace.js +2 -5
- package/lib/seam/connect/models/workspaces/workspace.js.map +1 -1
- package/lib/seam/connect/openapi.js +758 -363
- package/lib/seam/connect/openapi.js.map +1 -1
- package/lib/seam/connect/route-types.d.ts +1928 -1071
- package/package.json +1 -1
- package/src/lib/seam/connect/models/acs/acs-access-group.ts +6 -8
- package/src/lib/seam/connect/models/acs/acs-credential-provisioning-automation.ts +1 -3
- package/src/lib/seam/connect/models/acs/acs-credential.ts +15 -4
- package/src/lib/seam/connect/models/acs/acs-encoder.ts +2 -2
- package/src/lib/seam/connect/models/acs/acs-system.ts +27 -7
- package/src/lib/seam/connect/models/acs/acs-users/acs-user.ts +12 -4
- package/src/lib/seam/connect/models/bridges/bridge-connected-system.ts +1 -3
- package/src/lib/seam/connect/models/bridges/bridge.ts +1 -3
- package/src/lib/seam/connect/models/client-sessions/client-session.ts +2 -9
- package/src/lib/seam/connect/models/connect-webviews/connect-webview.ts +5 -5
- package/src/lib/seam/connect/models/customer/customer.ts +1 -3
- 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 +13 -7
- package/src/lib/seam/connect/models/devices/unmanaged-device.ts +3 -1
- package/src/lib/seam/connect/models/events/access-codes.ts +19 -15
- 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/action-attempts.ts +8 -8
- package/src/lib/seam/connect/models/events/client-sessions.ts +1 -1
- package/src/lib/seam/connect/models/events/common.ts +33 -27
- package/src/lib/seam/connect/models/events/connect-webviews.ts +4 -8
- package/src/lib/seam/connect/models/events/connected-accounts.ts +10 -14
- package/src/lib/seam/connect/models/events/devices.ts +20 -22
- package/src/lib/seam/connect/models/events/seam-event.ts +1 -1
- package/src/lib/seam/connect/models/instant-keys/instant-key.ts +2 -6
- package/src/lib/seam/connect/models/partner/customer-portal.ts +1 -3
- package/src/lib/seam/connect/models/partner/magic-link.ts +1 -3
- package/src/lib/seam/connect/models/spaces/space.ts +1 -3
- package/src/lib/seam/connect/models/thermostats/modes.ts +15 -16
- package/src/lib/seam/connect/models/thermostats/thermostat-program.ts +1 -1
- package/src/lib/seam/connect/models/thermostats/thermostat-schedule.ts +1 -3
- package/src/lib/seam/connect/models/user-identities/user-identity.ts +10 -5
- package/src/lib/seam/connect/models/webhooks/webhook.ts +1 -5
- package/src/lib/seam/connect/models/workspaces/workspace.ts +2 -7
- package/src/lib/seam/connect/openapi.ts +905 -507
- package/src/lib/seam/connect/route-types.ts +1928 -1071
package/dist/index.cjs
CHANGED
|
@@ -164,23 +164,16 @@ var lock_capability_properties = zod.z.object({
|
|
|
164
164
|
The delay in seconds before the lock automatically locks after being unlocked.
|
|
165
165
|
`)
|
|
166
166
|
});
|
|
167
|
-
var hvac_mode_setting = zod.z.enum([
|
|
168
|
-
"off"
|
|
169
|
-
|
|
170
|
-
|
|
171
|
-
"
|
|
172
|
-
|
|
173
|
-
]);
|
|
174
|
-
var fan_mode_setting = zod.z.enum(["auto", "on", "circulate"]);
|
|
167
|
+
var hvac_mode_setting = zod.z.enum(["off", "heat", "cool", "heat_cool", "eco"]).describe(
|
|
168
|
+
"HVAC mode setting for the thermostat, such as `heat`, `cool`, `heat_cool`, `eco`, or `off`."
|
|
169
|
+
);
|
|
170
|
+
var fan_mode_setting = zod.z.enum(["auto", "on", "circulate"]).describe(
|
|
171
|
+
"Fan mode setting for the thermostat, such as `auto`, `on`, or `circulate`."
|
|
172
|
+
);
|
|
175
173
|
zod.z.array(fan_mode_setting);
|
|
176
|
-
var climate_preset_mode = zod.z.enum([
|
|
177
|
-
"home"
|
|
178
|
-
|
|
179
|
-
"wake",
|
|
180
|
-
"sleep",
|
|
181
|
-
"occupied",
|
|
182
|
-
"unoccupied"
|
|
183
|
-
]);
|
|
174
|
+
var climate_preset_mode = zod.z.enum(["home", "away", "wake", "sleep", "occupied", "unoccupied"]).describe(
|
|
175
|
+
"Climate preset mode for the thermostat, such as `home`, `away`, `wake`, `sleep`, `occupied`, or `unoccupied`."
|
|
176
|
+
);
|
|
184
177
|
|
|
185
178
|
// src/lib/seam/connect/models/thermostats/climate-preset.ts
|
|
186
179
|
var climate_preset = zod.z.object({
|
|
@@ -259,7 +252,7 @@ var thermostat_daily_program = zod.z.object({
|
|
|
259
252
|
name: zod.z.string().nullable().describe("User-friendly name to identify the thermostat daily program."),
|
|
260
253
|
periods: zod.z.array(thermostat_daily_program_period).describe("Array of thermostat daily program periods."),
|
|
261
254
|
workspace_id: zod.z.string().uuid().describe(
|
|
262
|
-
"ID of the
|
|
255
|
+
"ID of the workspace that contains the thermostat daily program."
|
|
263
256
|
),
|
|
264
257
|
created_at: zod.z.string().datetime().describe(
|
|
265
258
|
"Date and time at which the thermostat daily program was created."
|
|
@@ -307,9 +300,7 @@ var thermostat_schedule = zod.z.object({
|
|
|
307
300
|
ends_at: zod.z.string().datetime().describe(
|
|
308
301
|
"Date and time at which the [thermostat schedule](https://docs.seam.co/capability-guides/thermostats/creating-and-managing-thermostat-schedules) ends, in [ISO 8601](https://www.iso.org/iso-8601-date-and-time-format.html) format."
|
|
309
302
|
),
|
|
310
|
-
workspace_id: zod.z.string().uuid().describe(
|
|
311
|
-
"ID of the [workspace](https://docs.seam.co/core-concepts/workspaces) that contains the thermostat schedule."
|
|
312
|
-
),
|
|
303
|
+
workspace_id: zod.z.string().uuid().describe("ID of the workspace that contains the thermostat schedule."),
|
|
313
304
|
created_at: zod.z.string().datetime().describe(
|
|
314
305
|
"Date and time at which the [thermostat schedule](https://docs.seam.co/capability-guides/thermostats/creating-and-managing-thermostat-schedules) was created."
|
|
315
306
|
),
|
|
@@ -1301,26 +1292,56 @@ var phone_specific_properties = zod.z.object({
|
|
|
1301
1292
|
|
|
1302
1293
|
// src/lib/seam/connect/models/devices/device.ts
|
|
1303
1294
|
var device_capability_flags = zod.z.object({
|
|
1304
|
-
can_remotely_unlock: zod.z.boolean(),
|
|
1305
|
-
can_remotely_lock: zod.z.boolean(),
|
|
1306
|
-
can_program_offline_access_codes: zod.z.boolean()
|
|
1307
|
-
|
|
1308
|
-
|
|
1309
|
-
|
|
1310
|
-
|
|
1311
|
-
|
|
1312
|
-
|
|
1313
|
-
|
|
1314
|
-
|
|
1315
|
-
|
|
1316
|
-
|
|
1317
|
-
|
|
1318
|
-
|
|
1319
|
-
|
|
1320
|
-
|
|
1321
|
-
|
|
1322
|
-
|
|
1323
|
-
|
|
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
|
+
)
|
|
1324
1345
|
}).partial();
|
|
1325
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.
|
|
1326
1347
|
`);
|
|
@@ -2183,10 +2204,12 @@ var PROVIDER_CATEGORY_MAP = {
|
|
|
2183
2204
|
var PROVIDER_CATEGORIES = Object.keys(PROVIDER_CATEGORY_MAP);
|
|
2184
2205
|
var PUBLIC_PROVIDER_CATEGORIES = PROVIDER_CATEGORIES.filter((category) => category !== "internal_beta");
|
|
2185
2206
|
var device_provider = zod.z.object({
|
|
2186
|
-
device_provider_name: zod.z.enum(ALL_DEVICE_PROVIDERS),
|
|
2187
|
-
display_name: zod.z.string(),
|
|
2188
|
-
image_url: zod.z.string(),
|
|
2189
|
-
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
|
+
)
|
|
2190
2213
|
}).extend(device_capability_flags.shape).describe(`
|
|
2191
2214
|
---
|
|
2192
2215
|
route_path: /devices
|
|
@@ -2204,7 +2227,7 @@ var unmanaged_device = device.pick({
|
|
|
2204
2227
|
created_at: true,
|
|
2205
2228
|
custom_metadata: true
|
|
2206
2229
|
}).extend({
|
|
2207
|
-
is_managed: zod.z.literal(false),
|
|
2230
|
+
is_managed: zod.z.literal(false).describe("Indicates that Seam does not manage the device."),
|
|
2208
2231
|
properties: common_device_properties.pick({
|
|
2209
2232
|
accessory_keypad: true,
|
|
2210
2233
|
name: true,
|
|
@@ -3310,12 +3333,8 @@ var common_acs_access_group = zod.z.object({
|
|
|
3310
3333
|
acs_system_id: zod.z.string().uuid().describe(
|
|
3311
3334
|
"ID of the access control system that contains the access group."
|
|
3312
3335
|
),
|
|
3313
|
-
workspace_id: zod.z.string().uuid().describe(
|
|
3314
|
-
|
|
3315
|
-
),
|
|
3316
|
-
connected_account_id: zod.z.string().uuid().describe(
|
|
3317
|
-
"ID of the [connected account](https://docs.seam.co/core-concepts/connected-accounts) that contains the access group."
|
|
3318
|
-
),
|
|
3336
|
+
workspace_id: zod.z.string().uuid().describe("ID of the workspace that contains the access group."),
|
|
3337
|
+
connected_account_id: zod.z.string().uuid().describe("ID of the connected account that contains the access group."),
|
|
3319
3338
|
name: zod.z.string().describe("Name of the access group."),
|
|
3320
3339
|
access_group_type: acs_access_group_external_type.describe(`
|
|
3321
3340
|
---
|
|
@@ -3327,7 +3346,7 @@ var common_acs_access_group = zod.z.object({
|
|
|
3327
3346
|
deprecated: Use \`external_type_display_name\`.
|
|
3328
3347
|
---
|
|
3329
3348
|
`),
|
|
3330
|
-
display_name: zod.z.string(),
|
|
3349
|
+
display_name: zod.z.string().describe("Display name for the access group."),
|
|
3331
3350
|
external_type: acs_access_group_external_type.describe(
|
|
3332
3351
|
"Brand-specific terminology for the access group type."
|
|
3333
3352
|
),
|
|
@@ -3345,7 +3364,7 @@ var common_acs_access_group = zod.z.object({
|
|
|
3345
3364
|
)
|
|
3346
3365
|
});
|
|
3347
3366
|
var acs_access_group = common_acs_access_group.extend({
|
|
3348
|
-
is_managed: zod.z.literal(true)
|
|
3367
|
+
is_managed: zod.z.literal(true).describe("Indicates whether Seam manages the access group.")
|
|
3349
3368
|
}).describe(`
|
|
3350
3369
|
---
|
|
3351
3370
|
route_path: /acs/access_groups
|
|
@@ -3560,7 +3579,7 @@ var common_acs_credential = zod.z.object({
|
|
|
3560
3579
|
connected_account_id: zod.z.string().uuid().describe(
|
|
3561
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."
|
|
3562
3581
|
),
|
|
3563
|
-
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."),
|
|
3564
3583
|
acs_system_id: zod.z.string().uuid().describe(
|
|
3565
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)."
|
|
3566
3585
|
),
|
|
@@ -3598,7 +3617,7 @@ var common_acs_credential = zod.z.object({
|
|
|
3598
3617
|
"Date and time at which the [credential](https://docs.seam.co/low-level-apis/access-systems/managing-credentials) was created."
|
|
3599
3618
|
),
|
|
3600
3619
|
workspace_id: zod.z.string().uuid().describe(
|
|
3601
|
-
"ID of the
|
|
3620
|
+
"ID of the workspace that contains the [credential](https://docs.seam.co/low-level-apis/access-systems/managing-credentials)."
|
|
3602
3621
|
),
|
|
3603
3622
|
starts_at: zod.z.string().optional().describe(
|
|
3604
3623
|
"Date and time at which the [credential](https://docs.seam.co/low-level-apis/access-systems/managing-credentials) validity starts, in [ISO 8601](https://www.iso.org/iso-8601-date-and-time-format.html) format."
|
|
@@ -3635,7 +3654,7 @@ var common_acs_credential = zod.z.object({
|
|
|
3635
3654
|
});
|
|
3636
3655
|
var acs_credential = common_acs_credential.merge(
|
|
3637
3656
|
zod.z.object({
|
|
3638
|
-
is_managed: zod.z.literal(true)
|
|
3657
|
+
is_managed: zod.z.literal(true).describe("Indicates whether Seam manages the credential.")
|
|
3639
3658
|
})
|
|
3640
3659
|
).describe(`
|
|
3641
3660
|
---
|
|
@@ -3664,7 +3683,9 @@ var acs_credential_on_encoder = zod.z.object({
|
|
|
3664
3683
|
created_at: zod.z.string().datetime().nullable().describe(
|
|
3665
3684
|
"Date and time at which the [credential](https://docs.seam.co/low-level-apis/access-systems/managing-credentials) was created."
|
|
3666
3685
|
),
|
|
3667
|
-
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
|
+
),
|
|
3668
3689
|
starts_at: zod.z.string().datetime().nullable().describe(
|
|
3669
3690
|
"Date and time at which the [credential](https://docs.seam.co/low-level-apis/access-systems/managing-credentials) becomes usable."
|
|
3670
3691
|
),
|
|
@@ -3743,10 +3764,10 @@ var acs_encoder = zod.z.object({
|
|
|
3743
3764
|
"ID of the [access control system](https://docs.seam.co/low-level-apis/access-systems) that contains the [encoder](https://docs.seam.co/low-level-apis/access-systems/working-with-card-encoders-and-scanners)."
|
|
3744
3765
|
),
|
|
3745
3766
|
connected_account_id: zod.z.string().uuid().describe(
|
|
3746
|
-
"ID of the
|
|
3767
|
+
"ID of the connected account that contains the [encoder](https://docs.seam.co/low-level-apis/access-systems/working-with-card-encoders-and-scanners)."
|
|
3747
3768
|
),
|
|
3748
3769
|
workspace_id: zod.z.string().uuid().describe(
|
|
3749
|
-
"ID of the
|
|
3770
|
+
"ID of the workspace that contains the [encoder](https://docs.seam.co/low-level-apis/access-systems/working-with-card-encoders-and-scanners)."
|
|
3750
3771
|
),
|
|
3751
3772
|
errors: zod.z.array(acs_encoder_error).describe(
|
|
3752
3773
|
"Errors associated with the [encoder](https://docs.seam.co/low-level-apis/access-systems/working-with-card-encoders-and-scanners)."
|
|
@@ -3959,7 +3980,9 @@ var seam_bridge_disconnected = common_acs_system_error.extend({
|
|
|
3959
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).`);
|
|
3960
3981
|
var bridge_disconnected2 = common_acs_system_error.extend({
|
|
3961
3982
|
error_code: zod.z.literal("bridge_disconnected").describe(error_code_description7),
|
|
3962
|
-
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
|
+
)
|
|
3963
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.
|
|
3964
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).`);
|
|
3965
3988
|
var visionline_instance_unreachable = common_acs_system_error.extend({
|
|
@@ -4061,8 +4084,12 @@ var acs_system = zod.z.object({
|
|
|
4061
4084
|
acs_system_id: zod.z.string().uuid().describe(
|
|
4062
4085
|
"ID of the [access control system](https://docs.seam.co/low-level-apis/access-systems)."
|
|
4063
4086
|
),
|
|
4064
|
-
acs_user_count: zod.z.number().optional()
|
|
4065
|
-
|
|
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
|
+
),
|
|
4066
4093
|
external_type: acs_system_external_type.describe(
|
|
4067
4094
|
"Brand-specific terminology for the [access control system](https://docs.seam.co/low-level-apis/access-systems) type."
|
|
4068
4095
|
).optional(),
|
|
@@ -4080,7 +4107,9 @@ var acs_system = zod.z.object({
|
|
|
4080
4107
|
lan_address: zod.z.string().describe(
|
|
4081
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."
|
|
4082
4109
|
)
|
|
4083
|
-
}).optional()
|
|
4110
|
+
}).optional().describe(
|
|
4111
|
+
"Visionline-specific metadata for the [access control system](https://docs.seam.co/low-level-apis/access-systems)."
|
|
4112
|
+
),
|
|
4084
4113
|
system_type: acs_system_external_type.describe(
|
|
4085
4114
|
`
|
|
4086
4115
|
---
|
|
@@ -4093,7 +4122,9 @@ var acs_system = zod.z.object({
|
|
|
4093
4122
|
deprecated: Use \`external_type_display_name\`.
|
|
4094
4123
|
---
|
|
4095
4124
|
`),
|
|
4096
|
-
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
|
+
),
|
|
4097
4128
|
name: zod.z.string().describe(
|
|
4098
4129
|
"Name of the [access control system](https://docs.seam.co/low-level-apis/access-systems)."
|
|
4099
4130
|
),
|
|
@@ -4101,7 +4132,7 @@ var acs_system = zod.z.object({
|
|
|
4101
4132
|
"Date and time at which the [access control system](https://docs.seam.co/low-level-apis/access-systems) was created."
|
|
4102
4133
|
),
|
|
4103
4134
|
workspace_id: zod.z.string().uuid().describe(
|
|
4104
|
-
"ID of the
|
|
4135
|
+
"ID of the workspace that contains the [access control system](https://docs.seam.co/low-level-apis/access-systems)."
|
|
4105
4136
|
),
|
|
4106
4137
|
connected_account_ids: zod.z.array(zod.z.string().uuid()).describe(`
|
|
4107
4138
|
---
|
|
@@ -4110,7 +4141,7 @@ var acs_system = zod.z.object({
|
|
|
4110
4141
|
IDs of the [connected accounts](https://docs.seam.co/core-concepts/connected-accounts) associated with the [access control system](https://docs.seam.co/low-level-apis/access-systems).
|
|
4111
4142
|
`),
|
|
4112
4143
|
connected_account_id: zod.z.string().uuid().describe(
|
|
4113
|
-
"ID of the
|
|
4144
|
+
"ID of the connected account associated with the [access control system](https://docs.seam.co/low-level-apis/access-systems)."
|
|
4114
4145
|
),
|
|
4115
4146
|
image_url: zod.z.string().describe(
|
|
4116
4147
|
"URL for the image that represents the [access control system](https://docs.seam.co/low-level-apis/access-systems)."
|
|
@@ -4420,9 +4451,11 @@ var common_acs_user = zod.z.object({
|
|
|
4420
4451
|
acs_system_id: zod.z.string().uuid().describe(
|
|
4421
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)."
|
|
4422
4453
|
),
|
|
4423
|
-
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
|
+
),
|
|
4424
4457
|
workspace_id: zod.z.string().uuid().describe(
|
|
4425
|
-
"ID of the
|
|
4458
|
+
"ID of the workspace that contains the [access system user](https://docs.seam.co/low-level-apis/access-systems/user-management)."
|
|
4426
4459
|
),
|
|
4427
4460
|
created_at: zod.z.string().datetime().describe(
|
|
4428
4461
|
"Date and time at which the [access system user](https://docs.seam.co/low-level-apis/access-systems/user-management) was created."
|
|
@@ -4470,7 +4503,7 @@ var common_acs_user = zod.z.object({
|
|
|
4470
4503
|
The last time an internal sync job completed for this access system user.
|
|
4471
4504
|
`),
|
|
4472
4505
|
connected_account_id: zod.z.string().uuid().describe(`
|
|
4473
|
-
The ID of the
|
|
4506
|
+
The ID of the connected account that is associated with the [access system user](https://docs.seam.co/low-level-apis/access-systems/user-management).
|
|
4474
4507
|
`),
|
|
4475
4508
|
salto_space_metadata: acs_user_salto_space_metadata.optional().describe(
|
|
4476
4509
|
"Salto Space-specific metadata associated with the [access system user](https://docs.seam.co/low-level-apis/access-systems/user-management)."
|
|
@@ -4478,7 +4511,7 @@ var common_acs_user = zod.z.object({
|
|
|
4478
4511
|
}).merge(user_fields);
|
|
4479
4512
|
var acs_user = common_acs_user.merge(
|
|
4480
4513
|
zod.z.object({
|
|
4481
|
-
is_managed: zod.z.literal(true)
|
|
4514
|
+
is_managed: zod.z.literal(true).describe("Indicates whether Seam manages the access system user.")
|
|
4482
4515
|
})
|
|
4483
4516
|
).describe(`
|
|
4484
4517
|
---
|
|
@@ -5145,12 +5178,8 @@ var action_attempt = zod.z.union([
|
|
|
5145
5178
|
See also [Action Attempts](https://docs.seam.co/core-concepts/action-attempts).
|
|
5146
5179
|
`);
|
|
5147
5180
|
var client_session = zod.z.object({
|
|
5148
|
-
client_session_id: zod.z.string().uuid().describe(
|
|
5149
|
-
|
|
5150
|
-
),
|
|
5151
|
-
workspace_id: zod.z.string().uuid().describe(
|
|
5152
|
-
"ID of the [workspace](https://docs.seam.co/core-concepts/workspaces) associated with the [client session](https://docs.seam.co/core-concepts/authentication/client-session-tokens)."
|
|
5153
|
-
),
|
|
5181
|
+
client_session_id: zod.z.string().uuid().describe("ID of the client session."),
|
|
5182
|
+
workspace_id: zod.z.string().uuid().describe("ID of the workspace associated with the client session."),
|
|
5154
5183
|
created_at: zod.z.string().datetime().describe(
|
|
5155
5184
|
"Date and time at which the [client session](https://docs.seam.co/core-concepts/authentication/client-session-tokens) was created."
|
|
5156
5185
|
),
|
|
@@ -5205,17 +5234,17 @@ var connect_webview_device_selection_mode = zod.z.enum([
|
|
|
5205
5234
|
]);
|
|
5206
5235
|
var connect_webview = zod.z.object({
|
|
5207
5236
|
connect_webview_id: zod.z.string().uuid().describe("ID of the Connect Webview."),
|
|
5208
|
-
workspace_id: zod.z.string().uuid().describe(
|
|
5209
|
-
"ID of the [workspace](https://docs.seam.co/core-concepts/workspaces) that contains the Connect Webview."
|
|
5210
|
-
),
|
|
5237
|
+
workspace_id: zod.z.string().uuid().describe("ID of the workspace that contains the Connect Webview."),
|
|
5211
5238
|
created_at: zod.z.string().datetime().describe("Date and time at which the Connect Webview was created."),
|
|
5212
5239
|
connected_account_id: zod.z.string().uuid().nullable().describe(
|
|
5213
|
-
"ID of the
|
|
5240
|
+
"ID of the connected account associated with the Connect Webview."
|
|
5214
5241
|
),
|
|
5215
5242
|
url: zod.z.string().url().describe(
|
|
5216
5243
|
"URL for the Connect Webview. You use the URL to display the Connect Webview flow to your user."
|
|
5217
5244
|
),
|
|
5218
|
-
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
|
+
),
|
|
5219
5248
|
// TODO: Use enum value.
|
|
5220
5249
|
accepted_providers: zod.z.array(zod.z.string()).describe(
|
|
5221
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,9 +5351,7 @@ var customization_profile = zod.z.object({
|
|
|
5322
5351
|
`);
|
|
5323
5352
|
var common_event = zod.z.object({
|
|
5324
5353
|
event_id: zod.z.string().uuid().describe("ID of the event."),
|
|
5325
|
-
workspace_id: zod.z.string().uuid().describe(
|
|
5326
|
-
"ID of the [workspace](https://docs.seam.co/core-concepts/workspaces) associated with the event."
|
|
5327
|
-
),
|
|
5354
|
+
workspace_id: zod.z.string().uuid().describe("ID of the workspace associated with the event."),
|
|
5328
5355
|
created_at: zod.z.string().datetime().describe("Date and time at which the event was created."),
|
|
5329
5356
|
occurred_at: zod.z.string().datetime().describe("Date and time at which the event occurred.")
|
|
5330
5357
|
});
|
|
@@ -5336,21 +5363,25 @@ var common_event_error = zod.z.object({
|
|
|
5336
5363
|
"Detailed description of the error. Provides insights into the issue and potentially how to rectify it."
|
|
5337
5364
|
),
|
|
5338
5365
|
error_code: zod.z.string().describe(error_code_description8)
|
|
5339
|
-
})
|
|
5366
|
+
}).describe(
|
|
5367
|
+
"Error associated with the resource, including the error code, message, and creation timestamp."
|
|
5368
|
+
);
|
|
5340
5369
|
var common_event_warning = zod.z.object({
|
|
5341
5370
|
created_at: zod.z.string().datetime().describe("Date and time at which Seam created the warning."),
|
|
5342
5371
|
message: zod.z.string().describe(
|
|
5343
5372
|
"Detailed description of the warning. Provides insights into the issue and potentially how to rectify it."
|
|
5344
5373
|
),
|
|
5345
5374
|
warning_code: zod.z.string().describe(warning_code_description10)
|
|
5346
|
-
})
|
|
5375
|
+
}).describe(
|
|
5376
|
+
"Warning associated with the resource, including the warning code, message, and creation timestamp."
|
|
5377
|
+
);
|
|
5347
5378
|
|
|
5348
5379
|
// src/lib/seam/connect/models/events/access-codes.ts
|
|
5349
5380
|
var access_code_event = common_event.extend({
|
|
5350
5381
|
access_code_id: zod.z.string().uuid().describe("ID of the affected access code."),
|
|
5351
5382
|
device_id: zod.z.string().uuid().describe("ID of the device associated with the affected access code."),
|
|
5352
5383
|
connected_account_id: zod.z.string().uuid().describe(
|
|
5353
|
-
"ID of the
|
|
5384
|
+
"ID of the connected account associated with the affected access code."
|
|
5354
5385
|
),
|
|
5355
5386
|
device_custom_metadata: custom_metadata.optional().describe(
|
|
5356
5387
|
"Custom metadata of the device, present when device_id is provided."
|
|
@@ -5383,7 +5414,7 @@ var access_code_changed_event = access_code_event.extend({
|
|
|
5383
5414
|
property: zod.z.string().describe("Name of the property that changed (e.g. `code`)."),
|
|
5384
5415
|
from: zod.z.string().nullable().describe("Previous value of the property, or null if not set."),
|
|
5385
5416
|
to: zod.z.string().nullable().describe("New value of the property, or null if cleared.")
|
|
5386
|
-
})
|
|
5417
|
+
}).describe("Record describing a single changed property.")
|
|
5387
5418
|
).optional().describe("List of properties that changed on the access code."),
|
|
5388
5419
|
change_reason: zod.z.string().optional().describe(
|
|
5389
5420
|
"Human-readable reason for the change (e.g. `ongoing code auto-renewed`)."
|
|
@@ -5526,7 +5557,7 @@ var access_code_deleted_external_to_seam_event = access_code_event.extend({
|
|
|
5526
5557
|
`);
|
|
5527
5558
|
var access_code_backup_access_code_pulled_event = access_code_event.extend({
|
|
5528
5559
|
event_type: zod.z.literal("access_code.backup_access_code_pulled"),
|
|
5529
|
-
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.")
|
|
5530
5561
|
}).describe(`
|
|
5531
5562
|
---
|
|
5532
5563
|
route_path: /access_codes
|
|
@@ -5826,8 +5857,8 @@ var acs_encoder_events = [
|
|
|
5826
5857
|
acs_encoder_removed_event
|
|
5827
5858
|
];
|
|
5828
5859
|
var acs_entrance_event = common_acs_event.extend({
|
|
5829
|
-
acs_entrance_id: zod.z.string().uuid()
|
|
5830
|
-
})
|
|
5860
|
+
acs_entrance_id: zod.z.string().uuid().describe("ID of the affected entrance.")
|
|
5861
|
+
});
|
|
5831
5862
|
var acs_entrance_added_event = acs_entrance_event.extend({
|
|
5832
5863
|
event_type: zod.z.literal("acs_entrance.added")
|
|
5833
5864
|
}).describe(`
|
|
@@ -5885,8 +5916,8 @@ var acs_system_events = [
|
|
|
5885
5916
|
acs_system_disconnected_event
|
|
5886
5917
|
];
|
|
5887
5918
|
var acs_user_event = common_acs_event.extend({
|
|
5888
|
-
acs_user_id: zod.z.string().uuid()
|
|
5889
|
-
})
|
|
5919
|
+
acs_user_id: zod.z.string().uuid().describe("ID of the affected access system user.")
|
|
5920
|
+
});
|
|
5890
5921
|
var acs_user_deleted_event = acs_user_event.extend({
|
|
5891
5922
|
event_type: zod.z.literal("acs_user.deleted")
|
|
5892
5923
|
}).describe(`
|
|
@@ -5934,7 +5965,7 @@ var action_attempt_lock_door_succeeded_event = action_attempt_event.extend({
|
|
|
5934
5965
|
---
|
|
5935
5966
|
route_path: /action_attempts
|
|
5936
5967
|
---
|
|
5937
|
-
A lock door
|
|
5968
|
+
A lock door action attempt succeeded.
|
|
5938
5969
|
`);
|
|
5939
5970
|
var action_attempt_lock_door_failed_event = action_attempt_event.extend({
|
|
5940
5971
|
event_type: zod.z.literal("action_attempt.lock_door.failed")
|
|
@@ -5942,7 +5973,7 @@ var action_attempt_lock_door_failed_event = action_attempt_event.extend({
|
|
|
5942
5973
|
---
|
|
5943
5974
|
route_path: /action_attempts
|
|
5944
5975
|
---
|
|
5945
|
-
A lock door
|
|
5976
|
+
A lock door action attempt failed.
|
|
5946
5977
|
`);
|
|
5947
5978
|
var action_attempt_unlock_door_succeeded_event = action_attempt_event.extend({
|
|
5948
5979
|
event_type: zod.z.literal("action_attempt.unlock_door.succeeded")
|
|
@@ -5950,7 +5981,7 @@ var action_attempt_unlock_door_succeeded_event = action_attempt_event.extend({
|
|
|
5950
5981
|
---
|
|
5951
5982
|
route_path: /action_attempts
|
|
5952
5983
|
---
|
|
5953
|
-
An unlock door
|
|
5984
|
+
An unlock door action attempt succeeded.
|
|
5954
5985
|
`);
|
|
5955
5986
|
var action_attempt_unlock_door_failed_event = action_attempt_event.extend({
|
|
5956
5987
|
event_type: zod.z.literal("action_attempt.unlock_door.failed")
|
|
@@ -5958,7 +5989,7 @@ var action_attempt_unlock_door_failed_event = action_attempt_event.extend({
|
|
|
5958
5989
|
---
|
|
5959
5990
|
route_path: /action_attempts
|
|
5960
5991
|
---
|
|
5961
|
-
An unlock door
|
|
5992
|
+
An unlock door action attempt failed.
|
|
5962
5993
|
`);
|
|
5963
5994
|
var action_attempt_simulate_keypad_code_entry_succeeded_event = action_attempt_event.extend({
|
|
5964
5995
|
event_type: zod.z.literal(
|
|
@@ -5968,7 +5999,7 @@ var action_attempt_simulate_keypad_code_entry_succeeded_event = action_attempt_e
|
|
|
5968
5999
|
---
|
|
5969
6000
|
route_path: /action_attempts
|
|
5970
6001
|
---
|
|
5971
|
-
A simulate keypad code entry
|
|
6002
|
+
A simulate keypad code entry action attempt succeeded.
|
|
5972
6003
|
`);
|
|
5973
6004
|
var action_attempt_simulate_keypad_code_entry_failed_event = action_attempt_event.extend({
|
|
5974
6005
|
event_type: zod.z.literal("action_attempt.simulate_keypad_code_entry.failed")
|
|
@@ -5976,7 +6007,7 @@ var action_attempt_simulate_keypad_code_entry_failed_event = action_attempt_even
|
|
|
5976
6007
|
---
|
|
5977
6008
|
route_path: /action_attempts
|
|
5978
6009
|
---
|
|
5979
|
-
A simulate keypad code entry
|
|
6010
|
+
A simulate keypad code entry action attempt failed.
|
|
5980
6011
|
`);
|
|
5981
6012
|
var action_attempt_simulate_manual_lock_via_keypad_succeeded_event = action_attempt_event.extend({
|
|
5982
6013
|
event_type: zod.z.literal(
|
|
@@ -5986,7 +6017,7 @@ var action_attempt_simulate_manual_lock_via_keypad_succeeded_event = action_atte
|
|
|
5986
6017
|
---
|
|
5987
6018
|
route_path: /action_attempts
|
|
5988
6019
|
---
|
|
5989
|
-
A simulate manual lock via keypad
|
|
6020
|
+
A simulate manual lock via keypad action attempt succeeded.
|
|
5990
6021
|
`);
|
|
5991
6022
|
var action_attempt_simulate_manual_lock_via_keypad_failed_event = action_attempt_event.extend({
|
|
5992
6023
|
event_type: zod.z.literal(
|
|
@@ -5996,7 +6027,7 @@ var action_attempt_simulate_manual_lock_via_keypad_failed_event = action_attempt
|
|
|
5996
6027
|
---
|
|
5997
6028
|
route_path: /action_attempts
|
|
5998
6029
|
---
|
|
5999
|
-
A simulate manual lock via keypad
|
|
6030
|
+
A simulate manual lock via keypad action attempt failed.
|
|
6000
6031
|
`);
|
|
6001
6032
|
var action_attempt_events = [
|
|
6002
6033
|
action_attempt_lock_door_succeeded_event,
|
|
@@ -6017,17 +6048,13 @@ var client_session_deleted_event = client_session_event.extend({
|
|
|
6017
6048
|
---
|
|
6018
6049
|
route_path: /client_sessions
|
|
6019
6050
|
---
|
|
6020
|
-
A
|
|
6051
|
+
A client session was deleted.
|
|
6021
6052
|
`);
|
|
6022
6053
|
var client_session_events = [client_session_deleted_event];
|
|
6023
6054
|
var connect_webview_event = common_event.extend({
|
|
6024
|
-
connect_webview_id: zod.z.string().uuid().describe(
|
|
6025
|
-
"ID of the affected [Connect Webview](https://docs.seam.co/core-concepts/connect-webviews)."
|
|
6026
|
-
)
|
|
6055
|
+
connect_webview_id: zod.z.string().uuid().describe("ID of the affected Connect Webview.")
|
|
6027
6056
|
});
|
|
6028
|
-
var connected_account_id = zod.z.string().uuid().describe(
|
|
6029
|
-
"ID of the [connected account](https://docs.seam.co/core-concepts/connected-accounts) associated with the event."
|
|
6030
|
-
);
|
|
6057
|
+
var connected_account_id = zod.z.string().uuid().describe("ID of the connected account associated with the event.");
|
|
6031
6058
|
var connected_account_custom_metadata = custom_metadata.optional().describe(
|
|
6032
6059
|
"Custom metadata of the connected account; present when connected_account_id is provided."
|
|
6033
6060
|
);
|
|
@@ -6042,7 +6069,7 @@ var connect_webview_login_succeeded_event = connect_webview_event.extend({
|
|
|
6042
6069
|
---
|
|
6043
6070
|
route_path: /connect_webviews
|
|
6044
6071
|
---
|
|
6045
|
-
A
|
|
6072
|
+
A Connect Webview login succeeded.
|
|
6046
6073
|
`);
|
|
6047
6074
|
var connect_webview_login_failed_event = connect_webview_event.extend({
|
|
6048
6075
|
event_type: zod.z.literal("connect_webview.login_failed")
|
|
@@ -6050,23 +6077,19 @@ var connect_webview_login_failed_event = connect_webview_event.extend({
|
|
|
6050
6077
|
---
|
|
6051
6078
|
route_path: /connect_webviews
|
|
6052
6079
|
---
|
|
6053
|
-
A
|
|
6080
|
+
A Connect Webview login failed.
|
|
6054
6081
|
`);
|
|
6055
6082
|
var connect_webview_events = [
|
|
6056
6083
|
connect_webview_login_succeeded_event,
|
|
6057
6084
|
connect_webview_login_failed_event
|
|
6058
6085
|
];
|
|
6059
6086
|
var connected_account_event = common_event.extend({
|
|
6060
|
-
connected_account_id: zod.z.string().uuid().describe(
|
|
6061
|
-
"ID of the affected [connected account](https://docs.seam.co/core-concepts/connected-accounts)."
|
|
6062
|
-
),
|
|
6087
|
+
connected_account_id: zod.z.string().uuid().describe("ID of the affected connected account."),
|
|
6063
6088
|
connected_account_custom_metadata: custom_metadata.optional().describe(
|
|
6064
6089
|
"Custom metadata of the connected account, present when connected_account_id is provided."
|
|
6065
6090
|
)
|
|
6066
6091
|
});
|
|
6067
|
-
var connect_webview_id = zod.z.string().uuid().describe(
|
|
6068
|
-
"ID of the [Connect Webview](https://docs.seam.co/core-concepts/connect-webviews) associated with the event."
|
|
6069
|
-
);
|
|
6092
|
+
var connect_webview_id = zod.z.string().uuid().describe("ID of the Connect Webview associated with the event.");
|
|
6070
6093
|
var connected_account_event_issue_properties = {
|
|
6071
6094
|
connected_account_errors: zod.z.array(common_event_error).describe("Errors associated with the connected account."),
|
|
6072
6095
|
connected_account_warnings: zod.z.array(common_event_warning).describe("Warnings associated with the connected account.")
|
|
@@ -6083,7 +6106,7 @@ var connected_account_connected_event = connected_account_event.extend(
|
|
|
6083
6106
|
---
|
|
6084
6107
|
route_path: /connected_accounts
|
|
6085
6108
|
---
|
|
6086
|
-
A
|
|
6109
|
+
A connected account was connected for the first time or was reconnected after being disconnected.
|
|
6087
6110
|
`);
|
|
6088
6111
|
var connected_account_created_event = connected_account_event.extend({
|
|
6089
6112
|
event_type: zod.z.literal("connected_account.created"),
|
|
@@ -6092,7 +6115,7 @@ var connected_account_created_event = connected_account_event.extend({
|
|
|
6092
6115
|
---
|
|
6093
6116
|
route_path: /connected_accounts
|
|
6094
6117
|
---
|
|
6095
|
-
A
|
|
6118
|
+
A connected account was created.
|
|
6096
6119
|
`);
|
|
6097
6120
|
var connected_account_successful_login_event = connected_account_event.extend({
|
|
6098
6121
|
event_type: zod.z.literal("connected_account.successful_login"),
|
|
@@ -6102,7 +6125,7 @@ var connected_account_successful_login_event = connected_account_event.extend({
|
|
|
6102
6125
|
deprecated: Use \`connect_webview.login_succeeded\`.
|
|
6103
6126
|
route_path: /connected_accounts
|
|
6104
6127
|
---
|
|
6105
|
-
A
|
|
6128
|
+
A connected account had a successful login using a Connect Webview.
|
|
6106
6129
|
`);
|
|
6107
6130
|
var connected_account_disconnected_event = connected_account_event.extend({
|
|
6108
6131
|
event_type: zod.z.literal("connected_account.disconnected")
|
|
@@ -6110,7 +6133,7 @@ var connected_account_disconnected_event = connected_account_event.extend({
|
|
|
6110
6133
|
---
|
|
6111
6134
|
route_path: /connected_accounts
|
|
6112
6135
|
---
|
|
6113
|
-
A
|
|
6136
|
+
A connected account was disconnected.
|
|
6114
6137
|
`);
|
|
6115
6138
|
var connected_account_completed_first_sync_event = connected_account_event.extend({
|
|
6116
6139
|
event_type: zod.z.literal("connected_account.completed_first_sync")
|
|
@@ -6118,7 +6141,7 @@ var connected_account_completed_first_sync_event = connected_account_event.exten
|
|
|
6118
6141
|
---
|
|
6119
6142
|
route_path: /connected_accounts
|
|
6120
6143
|
---
|
|
6121
|
-
A
|
|
6144
|
+
A connected account completed the first sync with Seam, and the corresponding devices or systems are now available.
|
|
6122
6145
|
`);
|
|
6123
6146
|
var connected_account_deleted_event = connected_account_event.extend({
|
|
6124
6147
|
event_type: zod.z.literal("connected_account.deleted"),
|
|
@@ -6130,7 +6153,7 @@ var connected_account_deleted_event = connected_account_event.extend({
|
|
|
6130
6153
|
---
|
|
6131
6154
|
route_path: /connected_accounts
|
|
6132
6155
|
---
|
|
6133
|
-
A
|
|
6156
|
+
A connected account was deleted.
|
|
6134
6157
|
`);
|
|
6135
6158
|
var connected_account_completed_first_sync_after_reconnection_event = connected_account_event.extend({
|
|
6136
6159
|
event_type: zod.z.literal(
|
|
@@ -6140,7 +6163,7 @@ var connected_account_completed_first_sync_after_reconnection_event = connected_
|
|
|
6140
6163
|
---
|
|
6141
6164
|
route_path: /connected_accounts
|
|
6142
6165
|
---
|
|
6143
|
-
A
|
|
6166
|
+
A connected account completed the first sync after reconnection with Seam, and the corresponding devices or systems are now available.
|
|
6144
6167
|
`);
|
|
6145
6168
|
var connected_account_reauthorization_requested_event = connected_account_event.extend({
|
|
6146
6169
|
event_type: zod.z.literal("connected_account.reauthorization_requested")
|
|
@@ -6148,7 +6171,7 @@ var connected_account_reauthorization_requested_event = connected_account_event.
|
|
|
6148
6171
|
---
|
|
6149
6172
|
route_path: /connected_accounts
|
|
6150
6173
|
---
|
|
6151
|
-
A
|
|
6174
|
+
A connected account requires reauthorization using a new Connect Webview. The account is still connected, but cannot access new features. Delaying reauthorization too long will eventually cause the Connected Account to become disconnected.
|
|
6152
6175
|
`);
|
|
6153
6176
|
var connected_account_events = [
|
|
6154
6177
|
connected_account_connected_event,
|
|
@@ -6162,9 +6185,7 @@ var connected_account_events = [
|
|
|
6162
6185
|
];
|
|
6163
6186
|
var device_event = common_event.extend({
|
|
6164
6187
|
device_id: zod.z.string().uuid().describe("ID of the affected device."),
|
|
6165
|
-
connected_account_id: zod.z.string().uuid().describe(
|
|
6166
|
-
"ID of the [connected account](https://docs.seam.co/core-concepts/connected-accounts) associated with the event."
|
|
6167
|
-
),
|
|
6188
|
+
connected_account_id: zod.z.string().uuid().describe("ID of the connected account associated with the event."),
|
|
6168
6189
|
customer_key: zod.z.string().optional().describe("The customer key associated with the device, if any."),
|
|
6169
6190
|
device_custom_metadata: custom_metadata.optional().describe(
|
|
6170
6191
|
"Custom metadata of the device, present when device_id is provided."
|
|
@@ -6195,7 +6216,7 @@ var device_connected_event = device_event.extend({
|
|
|
6195
6216
|
---
|
|
6196
6217
|
route_path: /devices
|
|
6197
6218
|
---
|
|
6198
|
-
The status of a
|
|
6219
|
+
The status of a device changed from offline to online. That is, the \`device.properties.online\` property changed from \`false\` to \`true\`. Note that some devices operate entirely in offline mode, so Seam never emits a \`device.connected\` event for these devices.
|
|
6199
6220
|
`);
|
|
6200
6221
|
var device_added_event = device_event.extend({
|
|
6201
6222
|
event_type: zod.z.literal("device.added")
|
|
@@ -6203,7 +6224,7 @@ var device_added_event = device_event.extend({
|
|
|
6203
6224
|
---
|
|
6204
6225
|
route_path: /devices
|
|
6205
6226
|
---
|
|
6206
|
-
A
|
|
6227
|
+
A device was added to Seam or was re-added to Seam after having been removed.
|
|
6207
6228
|
`);
|
|
6208
6229
|
var device_converted_to_unmanaged_event = device_event.extend({
|
|
6209
6230
|
event_type: zod.z.literal("device.converted_to_unmanaged")
|
|
@@ -6236,7 +6257,7 @@ var device_disconnected_event = device_event.extend({
|
|
|
6236
6257
|
---
|
|
6237
6258
|
route_path: /devices
|
|
6238
6259
|
---
|
|
6239
|
-
The status of a
|
|
6260
|
+
The status of a device changed from online to offline. That is, the \`device.properties.online\` property changed from \`true\` to \`false\`.
|
|
6240
6261
|
`);
|
|
6241
6262
|
var unmanaged_device_disconnected_event = device_event.extend({
|
|
6242
6263
|
event_type: zod.z.literal("device.unmanaged.disconnected"),
|
|
@@ -6253,7 +6274,7 @@ var device_tampered_event = device_event.extend({
|
|
|
6253
6274
|
---
|
|
6254
6275
|
route_path: /devices
|
|
6255
6276
|
---
|
|
6256
|
-
A
|
|
6277
|
+
A device detected that it was tampered with, for example, opened or moved.
|
|
6257
6278
|
`);
|
|
6258
6279
|
var device_low_battery_event = device_event.extend({
|
|
6259
6280
|
event_type: zod.z.literal("device.low_battery"),
|
|
@@ -6262,7 +6283,7 @@ var device_low_battery_event = device_event.extend({
|
|
|
6262
6283
|
---
|
|
6263
6284
|
route_path: /devices
|
|
6264
6285
|
---
|
|
6265
|
-
A
|
|
6286
|
+
A device battery level dropped below the low threshold.
|
|
6266
6287
|
`);
|
|
6267
6288
|
var device_battery_status_changed_event = device_event.extend({
|
|
6268
6289
|
event_type: zod.z.literal("device.battery_status_changed"),
|
|
@@ -6272,7 +6293,7 @@ var device_battery_status_changed_event = device_event.extend({
|
|
|
6272
6293
|
---
|
|
6273
6294
|
route_path: /devices
|
|
6274
6295
|
---
|
|
6275
|
-
A
|
|
6296
|
+
A device battery status changed since the last \`battery_status_changed\` event.
|
|
6276
6297
|
`);
|
|
6277
6298
|
var device_removed_event = device_event.extend({
|
|
6278
6299
|
event_type: zod.z.literal("device.removed")
|
|
@@ -6280,7 +6301,7 @@ var device_removed_event = device_event.extend({
|
|
|
6280
6301
|
---
|
|
6281
6302
|
route_path: /devices
|
|
6282
6303
|
---
|
|
6283
|
-
A
|
|
6304
|
+
A device was removed externally from the connected account.
|
|
6284
6305
|
`);
|
|
6285
6306
|
var device_deleted_event = device_event.extend({
|
|
6286
6307
|
event_type: zod.z.literal("device.deleted"),
|
|
@@ -6291,7 +6312,7 @@ var device_deleted_event = device_event.extend({
|
|
|
6291
6312
|
---
|
|
6292
6313
|
route_path: /devices
|
|
6293
6314
|
---
|
|
6294
|
-
A
|
|
6315
|
+
A device was deleted.
|
|
6295
6316
|
`);
|
|
6296
6317
|
var device_third_party_integration_detected_event = device_event.extend({
|
|
6297
6318
|
event_type: zod.z.literal("device.third_party_integration_detected")
|
|
@@ -6299,7 +6320,7 @@ var device_third_party_integration_detected_event = device_event.extend({
|
|
|
6299
6320
|
---
|
|
6300
6321
|
route_path: /devices
|
|
6301
6322
|
---
|
|
6302
|
-
Seam detected that a
|
|
6323
|
+
Seam detected that a device is using a third-party integration that will interfere with Seam device management.
|
|
6303
6324
|
`);
|
|
6304
6325
|
var device_third_party_integration_no_longer_detected_event = device_event.extend({
|
|
6305
6326
|
event_type: zod.z.literal("device.third_party_integration_no_longer_detected")
|
|
@@ -6307,7 +6328,7 @@ var device_third_party_integration_no_longer_detected_event = device_event.exten
|
|
|
6307
6328
|
---
|
|
6308
6329
|
route_path: /devices
|
|
6309
6330
|
---
|
|
6310
|
-
Seam detected that a
|
|
6331
|
+
Seam detected that a device is no longer using a third-party integration that was interfering with Seam device management.
|
|
6311
6332
|
`);
|
|
6312
6333
|
var device_salto_privacy_mode_activated_event = device_event.extend({
|
|
6313
6334
|
event_type: zod.z.literal("device.salto.privacy_mode_activated")
|
|
@@ -6331,7 +6352,7 @@ var device_connection_became_flaky_event = device_event.extend({
|
|
|
6331
6352
|
---
|
|
6332
6353
|
route_path: /devices
|
|
6333
6354
|
---
|
|
6334
|
-
Seam detected a flaky
|
|
6355
|
+
Seam detected a flaky device connection.
|
|
6335
6356
|
`);
|
|
6336
6357
|
var device_connection_stabilized_event = device_event.extend({
|
|
6337
6358
|
event_type: zod.z.literal("device.connection_stabilized")
|
|
@@ -6339,7 +6360,7 @@ var device_connection_stabilized_event = device_event.extend({
|
|
|
6339
6360
|
---
|
|
6340
6361
|
route_path: /devices
|
|
6341
6362
|
---
|
|
6342
|
-
Seam detected that a previously-flaky
|
|
6363
|
+
Seam detected that a previously-flaky device connection stabilized.
|
|
6343
6364
|
`);
|
|
6344
6365
|
var device_error_subscription_required_event = device_event.extend({
|
|
6345
6366
|
event_type: zod.z.literal("device.error.subscription_required")
|
|
@@ -6347,7 +6368,7 @@ var device_error_subscription_required_event = device_event.extend({
|
|
|
6347
6368
|
---
|
|
6348
6369
|
route_path: /devices
|
|
6349
6370
|
---
|
|
6350
|
-
A third-party subscription is required to use all
|
|
6371
|
+
A third-party subscription is required to use all device features.
|
|
6351
6372
|
`);
|
|
6352
6373
|
var device_error_subscription_required_resolved_event = device_event.extend({
|
|
6353
6374
|
event_type: zod.z.literal("device.error.subscription_required.resolved")
|
|
@@ -6355,7 +6376,7 @@ var device_error_subscription_required_resolved_event = device_event.extend({
|
|
|
6355
6376
|
---
|
|
6356
6377
|
route_path: /devices
|
|
6357
6378
|
---
|
|
6358
|
-
A third-party subscription is active or no longer required to use all
|
|
6379
|
+
A third-party subscription is active or no longer required to use all device features.
|
|
6359
6380
|
`);
|
|
6360
6381
|
var device_accessory_keypad_connected_event = device_event.extend({
|
|
6361
6382
|
event_type: zod.z.literal("device.accessory_keypad_connected")
|
|
@@ -6363,7 +6384,7 @@ var device_accessory_keypad_connected_event = device_event.extend({
|
|
|
6363
6384
|
---
|
|
6364
6385
|
route_path: /devices
|
|
6365
6386
|
---
|
|
6366
|
-
An accessory keypad was connected to a
|
|
6387
|
+
An accessory keypad was connected to a device.
|
|
6367
6388
|
`);
|
|
6368
6389
|
var device_accessory_keypad_disconnected_event = device_event.extend({
|
|
6369
6390
|
event_type: zod.z.literal("device.accessory_keypad_disconnected")
|
|
@@ -6371,7 +6392,7 @@ var device_accessory_keypad_disconnected_event = device_event.extend({
|
|
|
6371
6392
|
---
|
|
6372
6393
|
route_path: /devices
|
|
6373
6394
|
---
|
|
6374
|
-
An accessory keypad was disconnected from a
|
|
6395
|
+
An accessory keypad was disconnected from a device.
|
|
6375
6396
|
`);
|
|
6376
6397
|
var noise_sensor_noise_threshold_triggered_event = device_event.extend(
|
|
6377
6398
|
{
|
|
@@ -6577,7 +6598,7 @@ var device_name_changed_event = device_event.extend({
|
|
|
6577
6598
|
---
|
|
6578
6599
|
route_path: /devices
|
|
6579
6600
|
---
|
|
6580
|
-
The name of a
|
|
6601
|
+
The name of a device was changed.
|
|
6581
6602
|
`);
|
|
6582
6603
|
var camera_activated_event = device_event.extend({
|
|
6583
6604
|
event_type: zod.z.literal("camera.activated"),
|
|
@@ -6589,7 +6610,7 @@ var camera_activated_event = device_event.extend({
|
|
|
6589
6610
|
---
|
|
6590
6611
|
route_path: /devices
|
|
6591
6612
|
---
|
|
6592
|
-
A
|
|
6613
|
+
A camera was activated, for example, by motion detection.
|
|
6593
6614
|
`);
|
|
6594
6615
|
var device_doorbell_rang_event = device_event.extend({
|
|
6595
6616
|
event_type: zod.z.literal("device.doorbell_rang"),
|
|
@@ -6603,7 +6624,7 @@ var device_doorbell_rang_event = device_event.extend({
|
|
|
6603
6624
|
---
|
|
6604
6625
|
route_path: /devices
|
|
6605
6626
|
---
|
|
6606
|
-
A doorbell button was pressed on a
|
|
6627
|
+
A doorbell button was pressed on a device.
|
|
6607
6628
|
`);
|
|
6608
6629
|
var device_events = [
|
|
6609
6630
|
device_connected_event,
|
|
@@ -6737,7 +6758,7 @@ var seam_event = zod.z.discriminatedUnion("event_type", [
|
|
|
6737
6758
|
---
|
|
6738
6759
|
Represents an event. Events let you know when something interesting happens in your workspace. For example, when a lock is unlocked, Seam creates a \`lock.unlocked\` event. When a device's battery level is low, Seam creates a \`device.battery_low\` event.
|
|
6739
6760
|
|
|
6740
|
-
As with other API resources, you can retrieve an individual event or a list of events. Seam also provides a separate
|
|
6761
|
+
As with other API resources, you can retrieve an individual event or a list of events. Seam also provides a separate webhook system for sending the event objects directly to an endpoint on your sever. Manage webhooks through [Seam Console](https://console.seam.co). You can also use the webhooks sandbox in Seam Console to see the different payloads for each event and test them against your own endpoints.
|
|
6741
6762
|
`);
|
|
6742
6763
|
var event_types = seam_event.options.map(
|
|
6743
6764
|
(schema) => schema.shape.event_type.value
|
|
@@ -6747,16 +6768,12 @@ zod.z.enum(
|
|
|
6747
6768
|
);
|
|
6748
6769
|
var instant_key = zod.z.object({
|
|
6749
6770
|
instant_key_id: zod.z.string().uuid().describe("ID of the Instant Key."),
|
|
6750
|
-
workspace_id: zod.z.string().uuid().describe(
|
|
6751
|
-
"ID of the [workspace](https://docs.seam.co/core-concepts/workspaces) that contains the Instant Key."
|
|
6752
|
-
),
|
|
6771
|
+
workspace_id: zod.z.string().uuid().describe("ID of the workspace that contains the Instant Key."),
|
|
6753
6772
|
created_at: zod.z.string().datetime().describe("Date and time at which the Instant Key was created."),
|
|
6754
6773
|
instant_key_url: zod.z.string().url().describe(
|
|
6755
6774
|
"Shareable URL for the Instant Key. Use the URL to deliver the Instant Key to your user through a link in a text message or email or by embedding it in your web app."
|
|
6756
6775
|
),
|
|
6757
|
-
client_session_id: zod.z.string().uuid().describe(
|
|
6758
|
-
"ID of the [client session](https://docs.seam.co/core-concepts/authentication/client-session-tokens) associated with the Instant Key."
|
|
6759
|
-
),
|
|
6776
|
+
client_session_id: zod.z.string().uuid().describe("ID of the client session associated with the Instant Key."),
|
|
6760
6777
|
user_identity_id: zod.z.string().uuid().describe("ID of the user identity associated with the Instant Key."),
|
|
6761
6778
|
expires_at: zod.z.string().datetime().describe("Date and time at which the Instant Key expires."),
|
|
6762
6779
|
customization_profile_id: zod.z.string().uuid().optional().describe(
|
|
@@ -6814,9 +6831,7 @@ var space_geolocation = zod.z.object({
|
|
|
6814
6831
|
}).describe("Geographic coordinates of the space.");
|
|
6815
6832
|
var space = zod.z.object({
|
|
6816
6833
|
space_id: zod.z.string().uuid().describe("ID of the space."),
|
|
6817
|
-
workspace_id: zod.z.string().uuid().describe(
|
|
6818
|
-
"ID of the [workspace](https://docs.seam.co/core-concepts/workspaces) associated with the space."
|
|
6819
|
-
),
|
|
6834
|
+
workspace_id: zod.z.string().uuid().describe("ID of the workspace associated with the space."),
|
|
6820
6835
|
space_key: zod.z.string().optional().describe("Unique key for the space within the workspace."),
|
|
6821
6836
|
name: zod.z.string().describe("Name of the space."),
|
|
6822
6837
|
display_name: zod.z.string().describe("Display name for the space."),
|
|
@@ -6899,12 +6914,10 @@ var user_identity = zod.z.object({
|
|
|
6899
6914
|
phone_number: loose_phone_number.nullable().describe(
|
|
6900
6915
|
"Unique phone number for the user identity in [E.164 format](https://www.itu.int/rec/T-REC-E.164/en) (for example, +15555550100)."
|
|
6901
6916
|
),
|
|
6902
|
-
display_name: zod.z.string().min(1),
|
|
6903
|
-
full_name: zod.z.string().min(1).nullable(),
|
|
6917
|
+
display_name: zod.z.string().min(1).describe("Display name for the user identity."),
|
|
6918
|
+
full_name: zod.z.string().min(1).nullable().describe("Full name of the user associated with the user identity."),
|
|
6904
6919
|
created_at: zod.z.string().datetime().describe("Date and time at which the user identity was created."),
|
|
6905
|
-
workspace_id: zod.z.string().uuid().describe(
|
|
6906
|
-
"ID of the [workspace](https://docs.seam.co/core-concepts/workspaces) that contains the user identity."
|
|
6907
|
-
),
|
|
6920
|
+
workspace_id: zod.z.string().uuid().describe("ID of the workspace that contains the user identity."),
|
|
6908
6921
|
errors: zod.z.array(user_identity_errors).describe(
|
|
6909
6922
|
'Array of errors associated with the user identity. Each error object within the array contains fields like "error_code" and "message." "error_code" is a string that uniquely identifies the type of error, enabling quick recognition and categorization of the issue. "message" provides a more detailed description of the error, offering insights into the issue and potentially how to rectify it.'
|
|
6910
6923
|
),
|
|
@@ -6930,9 +6943,7 @@ user_identity.omit({
|
|
|
6930
6943
|
Represents an unmanaged user identity. Unmanaged user identities do not have keys.
|
|
6931
6944
|
`);
|
|
6932
6945
|
var workspace = zod.z.object({
|
|
6933
|
-
workspace_id: zod.z.string().uuid().describe(
|
|
6934
|
-
"ID of the [workspace](https://docs.seam.co/core-concepts/workspaces)."
|
|
6935
|
-
),
|
|
6946
|
+
workspace_id: zod.z.string().uuid().describe("ID of the workspace."),
|
|
6936
6947
|
name: zod.z.string().describe(
|
|
6937
6948
|
"Name of the [workspace](https://docs.seam.co/core-concepts/workspaces)."
|
|
6938
6949
|
),
|
|
@@ -6976,7 +6987,7 @@ var workspace = zod.z.object({
|
|
|
6976
6987
|
"Indicates whether publishable key authentication is enabled for this workspace."
|
|
6977
6988
|
),
|
|
6978
6989
|
organization_id: zod.z.string().uuid().nullable().describe(
|
|
6979
|
-
"ID of the organization to which the
|
|
6990
|
+
"ID of the organization to which the workspace belongs, or `null` if the workspace is not assigned to an organization."
|
|
6980
6991
|
)
|
|
6981
6992
|
}).describe(`
|
|
6982
6993
|
---
|
|
@@ -7023,9 +7034,7 @@ A batch of workspace resources.
|
|
|
7023
7034
|
`);
|
|
7024
7035
|
var bridge = zod.z.object({
|
|
7025
7036
|
bridge_id: zod.z.string().uuid().describe("ID of Seam Bridge."),
|
|
7026
|
-
workspace_id: zod.z.string().uuid().describe(
|
|
7027
|
-
"ID of the [workspace](https://docs.seam.co/core-concepts/workspaces) that contains Seam Bridge."
|
|
7028
|
-
),
|
|
7037
|
+
workspace_id: zod.z.string().uuid().describe("ID of the workspace that contains Seam Bridge."),
|
|
7029
7038
|
created_at: zod.z.string().datetime().describe("Date and time at which Seam Bridge was created.")
|
|
7030
7039
|
}).describe(`
|
|
7031
7040
|
---
|
|
@@ -7195,9 +7204,7 @@ var customer_portal = zod.z.object({
|
|
|
7195
7204
|
url: zod.z.string().url().describe("URL for the customer portal."),
|
|
7196
7205
|
customer_key: zod.z.string().describe("Customer key for the customer portal."),
|
|
7197
7206
|
expires_at: zod.z.string().datetime().describe("Date and time at which the customer portal link expires."),
|
|
7198
|
-
workspace_id: zod.z.string().uuid().describe(
|
|
7199
|
-
"ID of the [workspace](https://docs.seam.co/core-concepts/workspaces) associated with the customer portal."
|
|
7200
|
-
),
|
|
7207
|
+
workspace_id: zod.z.string().uuid().describe("ID of the workspace associated with the customer portal."),
|
|
7201
7208
|
created_at: zod.z.string().datetime().describe("Date and time at which the customer portal link was created.")
|
|
7202
7209
|
}).describe(
|
|
7203
7210
|
`
|
|
@@ -7215,9 +7222,7 @@ var magic_link = zod.z.object({
|
|
|
7215
7222
|
url: zod.z.string().url().describe("URL for the magic link."),
|
|
7216
7223
|
customer_key: zod.z.string().describe("Customer key for the magic link."),
|
|
7217
7224
|
expires_at: zod.z.string().datetime().describe("Date and time at which the magic link expires."),
|
|
7218
|
-
workspace_id: zod.z.string().uuid().describe(
|
|
7219
|
-
"ID of the [workspace](https://docs.seam.co/core-concepts/workspaces) associated with the magic link."
|
|
7220
|
-
),
|
|
7225
|
+
workspace_id: zod.z.string().uuid().describe("ID of the workspace associated with the magic link."),
|
|
7221
7226
|
created_at: zod.z.string().datetime().describe("Date and time at which the magic link was created.")
|
|
7222
7227
|
}).describe(`
|
|
7223
7228
|
---
|
|
@@ -7231,9 +7236,7 @@ var magic_link = zod.z.object({
|
|
|
7231
7236
|
Seam hosts these flows, handling everything from account connection and device mapping to full-featured device control.
|
|
7232
7237
|
`);
|
|
7233
7238
|
var webhook = zod.z.object({
|
|
7234
|
-
webhook_id: zod.z.string().describe(
|
|
7235
|
-
"ID of the [webhook](https://docs.seam.co/developer-tools/webhooks)."
|
|
7236
|
-
),
|
|
7239
|
+
webhook_id: zod.z.string().describe("ID of the webhook."),
|
|
7237
7240
|
url: zod.z.string().describe(
|
|
7238
7241
|
"URL for the [webhook](https://docs.seam.co/developer-tools/webhooks)."
|
|
7239
7242
|
),
|
|
@@ -9810,7 +9813,7 @@ var openapi = {
|
|
|
9810
9813
|
type: "string"
|
|
9811
9814
|
},
|
|
9812
9815
|
connected_account_id: {
|
|
9813
|
-
description: "ID of the
|
|
9816
|
+
description: "ID of the connected account that contains the access group.",
|
|
9814
9817
|
format: "uuid",
|
|
9815
9818
|
type: "string"
|
|
9816
9819
|
},
|
|
@@ -9819,7 +9822,10 @@ var openapi = {
|
|
|
9819
9822
|
format: "date-time",
|
|
9820
9823
|
type: "string"
|
|
9821
9824
|
},
|
|
9822
|
-
display_name: {
|
|
9825
|
+
display_name: {
|
|
9826
|
+
description: "Display name for the access group.",
|
|
9827
|
+
type: "string"
|
|
9828
|
+
},
|
|
9823
9829
|
errors: {
|
|
9824
9830
|
description: "Errors associated with the `acs_access_group`.",
|
|
9825
9831
|
items: {
|
|
@@ -9869,7 +9875,11 @@ var openapi = {
|
|
|
9869
9875
|
description: "Display name that corresponds to the brand-specific terminology for the access group type.",
|
|
9870
9876
|
type: "string"
|
|
9871
9877
|
},
|
|
9872
|
-
is_managed: {
|
|
9878
|
+
is_managed: {
|
|
9879
|
+
description: "Indicates whether Seam manages the access group.",
|
|
9880
|
+
enum: [true],
|
|
9881
|
+
type: "boolean"
|
|
9882
|
+
},
|
|
9873
9883
|
name: { description: "Name of the access group.", type: "string" },
|
|
9874
9884
|
pending_mutations: {
|
|
9875
9885
|
description: "Collection of pending mutations for the access group. Represents operations that have been requested but not yet completed on the integrated access system.",
|
|
@@ -10252,7 +10262,7 @@ var openapi = {
|
|
|
10252
10262
|
type: "array"
|
|
10253
10263
|
},
|
|
10254
10264
|
workspace_id: {
|
|
10255
|
-
description: "ID of the
|
|
10265
|
+
description: "ID of the workspace that contains the access group.",
|
|
10256
10266
|
format: "uuid",
|
|
10257
10267
|
type: "string"
|
|
10258
10268
|
}
|
|
@@ -10290,7 +10300,11 @@ var openapi = {
|
|
|
10290
10300
|
format: "uuid",
|
|
10291
10301
|
type: "string"
|
|
10292
10302
|
},
|
|
10293
|
-
acs_credential_pool_id: {
|
|
10303
|
+
acs_credential_pool_id: {
|
|
10304
|
+
description: "ID of the credential pool to which the credential belongs.",
|
|
10305
|
+
format: "uuid",
|
|
10306
|
+
type: "string"
|
|
10307
|
+
},
|
|
10294
10308
|
acs_system_id: {
|
|
10295
10309
|
description: "ID of the [access control system](https://docs.seam.co/low-level-apis/access-systems) that contains the [credential](https://docs.seam.co/low-level-apis/access-systems/managing-credentials).",
|
|
10296
10310
|
format: "uuid",
|
|
@@ -10405,7 +10419,11 @@ var openapi = {
|
|
|
10405
10419
|
nullable: true,
|
|
10406
10420
|
type: "boolean"
|
|
10407
10421
|
},
|
|
10408
|
-
is_managed: {
|
|
10422
|
+
is_managed: {
|
|
10423
|
+
description: "Indicates whether Seam manages the credential.",
|
|
10424
|
+
enum: [true],
|
|
10425
|
+
type: "boolean"
|
|
10426
|
+
},
|
|
10409
10427
|
is_multi_phone_sync_credential: {
|
|
10410
10428
|
description: "Indicates whether the [credential](https://docs.seam.co/low-level-apis/access-systems/managing-credentials) is a [multi-phone sync credential](https://docs.seam.co/capability-guides/mobile-access/issuing-mobile-credentials-from-an-access-control-system#what-are-multi-phone-sync-credentials).",
|
|
10411
10429
|
type: "boolean"
|
|
@@ -10620,7 +10638,7 @@ var openapi = {
|
|
|
10620
10638
|
type: "array"
|
|
10621
10639
|
},
|
|
10622
10640
|
workspace_id: {
|
|
10623
|
-
description: "ID of the
|
|
10641
|
+
description: "ID of the workspace that contains the [credential](https://docs.seam.co/low-level-apis/access-systems/managing-credentials).",
|
|
10624
10642
|
format: "uuid",
|
|
10625
10643
|
type: "string"
|
|
10626
10644
|
}
|
|
@@ -10703,7 +10721,7 @@ var openapi = {
|
|
|
10703
10721
|
type: "string"
|
|
10704
10722
|
},
|
|
10705
10723
|
connected_account_id: {
|
|
10706
|
-
description: "ID of the
|
|
10724
|
+
description: "ID of the connected account that contains the [encoder](https://docs.seam.co/low-level-apis/access-systems/working-with-card-encoders-and-scanners).",
|
|
10707
10725
|
format: "uuid",
|
|
10708
10726
|
type: "string"
|
|
10709
10727
|
},
|
|
@@ -10742,7 +10760,7 @@ var openapi = {
|
|
|
10742
10760
|
type: "array"
|
|
10743
10761
|
},
|
|
10744
10762
|
workspace_id: {
|
|
10745
|
-
description: "ID of the
|
|
10763
|
+
description: "ID of the workspace that contains the [encoder](https://docs.seam.co/low-level-apis/access-systems/working-with-card-encoders-and-scanners).",
|
|
10746
10764
|
format: "uuid",
|
|
10747
10765
|
type: "string"
|
|
10748
10766
|
}
|
|
@@ -11225,15 +11243,23 @@ var openapi = {
|
|
|
11225
11243
|
acs_system: {
|
|
11226
11244
|
description: "Represents an [access control system](https://docs.seam.co/low-level-apis/access-systems).\n\nWithin an `acs_system`, create [`acs_user`s](https://docs.seam.co/api/acs/users#acs_user) and [`acs_credential`s](https://docs.seam.co/api/acs/credentials#acs_credential) to grant access to the `acs_user`s.\n\nFor details about the resources associated with an access control system, see the [access control systems namespace](https://docs.seam.co/api/acs).",
|
|
11227
11245
|
properties: {
|
|
11228
|
-
acs_access_group_count: {
|
|
11246
|
+
acs_access_group_count: {
|
|
11247
|
+
description: "Number of access groups in the [access control system](https://docs.seam.co/low-level-apis/access-systems).",
|
|
11248
|
+
format: "float",
|
|
11249
|
+
type: "number"
|
|
11250
|
+
},
|
|
11229
11251
|
acs_system_id: {
|
|
11230
11252
|
description: "ID of the [access control system](https://docs.seam.co/low-level-apis/access-systems).",
|
|
11231
11253
|
format: "uuid",
|
|
11232
11254
|
type: "string"
|
|
11233
11255
|
},
|
|
11234
|
-
acs_user_count: {
|
|
11256
|
+
acs_user_count: {
|
|
11257
|
+
description: "Number of users in the [access control system](https://docs.seam.co/low-level-apis/access-systems).",
|
|
11258
|
+
format: "float",
|
|
11259
|
+
type: "number"
|
|
11260
|
+
},
|
|
11235
11261
|
connected_account_id: {
|
|
11236
|
-
description: "ID of the
|
|
11262
|
+
description: "ID of the connected account associated with the [access control system](https://docs.seam.co/low-level-apis/access-systems).",
|
|
11237
11263
|
format: "uuid",
|
|
11238
11264
|
type: "string"
|
|
11239
11265
|
},
|
|
@@ -11295,7 +11321,10 @@ var openapi = {
|
|
|
11295
11321
|
enum: ["bridge_disconnected"],
|
|
11296
11322
|
type: "string"
|
|
11297
11323
|
},
|
|
11298
|
-
is_bridge_error: {
|
|
11324
|
+
is_bridge_error: {
|
|
11325
|
+
description: "Indicates whether the error is related to the [Seam Bridge](https://docs.seam.co/capability-guides/seam-bridge).",
|
|
11326
|
+
type: "boolean"
|
|
11327
|
+
},
|
|
11299
11328
|
message: {
|
|
11300
11329
|
description: "Detailed description of the error. Provides insights into the issue and potentially how to rectify it.",
|
|
11301
11330
|
type: "string"
|
|
@@ -11472,6 +11501,7 @@ var openapi = {
|
|
|
11472
11501
|
type: "boolean"
|
|
11473
11502
|
},
|
|
11474
11503
|
location: {
|
|
11504
|
+
description: "Location information for the [access control system](https://docs.seam.co/low-level-apis/access-systems).",
|
|
11475
11505
|
properties: {
|
|
11476
11506
|
time_zone: {
|
|
11477
11507
|
description: "Time zone in which the [access control system](https://docs.seam.co/low-level-apis/access-systems) is located.",
|
|
@@ -11514,6 +11544,7 @@ var openapi = {
|
|
|
11514
11544
|
"x-deprecated": "Use `external_type_display_name`."
|
|
11515
11545
|
},
|
|
11516
11546
|
visionline_metadata: {
|
|
11547
|
+
description: "Visionline-specific metadata for the [access control system](https://docs.seam.co/low-level-apis/access-systems).",
|
|
11517
11548
|
properties: {
|
|
11518
11549
|
lan_address: {
|
|
11519
11550
|
description: "IP address or hostname of the main Visionline server relative to [Seam Bridge](https://docs.seam.co/capability-guides/seam-bridge) on the local network.",
|
|
@@ -11611,7 +11642,7 @@ var openapi = {
|
|
|
11611
11642
|
type: "array"
|
|
11612
11643
|
},
|
|
11613
11644
|
workspace_id: {
|
|
11614
|
-
description: "ID of the
|
|
11645
|
+
description: "ID of the workspace that contains the [access control system](https://docs.seam.co/low-level-apis/access-systems).",
|
|
11615
11646
|
format: "uuid",
|
|
11616
11647
|
type: "string"
|
|
11617
11648
|
}
|
|
@@ -11665,7 +11696,7 @@ var openapi = {
|
|
|
11665
11696
|
type: "string"
|
|
11666
11697
|
},
|
|
11667
11698
|
connected_account_id: {
|
|
11668
|
-
description: "\n The ID of the
|
|
11699
|
+
description: "\n The ID of the connected account that is associated with the [access system user](https://docs.seam.co/low-level-apis/access-systems/user-management).\n ",
|
|
11669
11700
|
format: "uuid",
|
|
11670
11701
|
type: "string"
|
|
11671
11702
|
},
|
|
@@ -11842,8 +11873,16 @@ var openapi = {
|
|
|
11842
11873
|
minLength: 1,
|
|
11843
11874
|
type: "string"
|
|
11844
11875
|
},
|
|
11845
|
-
hid_acs_system_id: {
|
|
11846
|
-
|
|
11876
|
+
hid_acs_system_id: {
|
|
11877
|
+
description: "ID of the HID access control system associated with the user.",
|
|
11878
|
+
format: "uuid",
|
|
11879
|
+
type: "string"
|
|
11880
|
+
},
|
|
11881
|
+
is_managed: {
|
|
11882
|
+
description: "Indicates whether Seam manages the access system user.",
|
|
11883
|
+
enum: [true],
|
|
11884
|
+
type: "boolean"
|
|
11885
|
+
},
|
|
11847
11886
|
is_suspended: {
|
|
11848
11887
|
description: "Indicates whether the [access system user](https://docs.seam.co/low-level-apis/access-systems/user-management) is currently [suspended](https://docs.seam.co/low-level-apis/access-systems/user-management/suspending-and-unsuspending-users).",
|
|
11849
11888
|
type: "boolean"
|
|
@@ -12375,7 +12414,7 @@ var openapi = {
|
|
|
12375
12414
|
type: "array"
|
|
12376
12415
|
},
|
|
12377
12416
|
workspace_id: {
|
|
12378
|
-
description: "ID of the
|
|
12417
|
+
description: "ID of the workspace that contains the [access system user](https://docs.seam.co/low-level-apis/access-systems/user-management).",
|
|
12379
12418
|
format: "uuid",
|
|
12380
12419
|
type: "string"
|
|
12381
12420
|
}
|
|
@@ -12691,7 +12730,11 @@ var openapi = {
|
|
|
12691
12730
|
nullable: true,
|
|
12692
12731
|
type: "string"
|
|
12693
12732
|
},
|
|
12694
|
-
is_issued: {
|
|
12733
|
+
is_issued: {
|
|
12734
|
+
description: "Indicates whether the credential has been issued (encoded onto a card).",
|
|
12735
|
+
nullable: true,
|
|
12736
|
+
type: "boolean"
|
|
12737
|
+
},
|
|
12695
12738
|
starts_at: {
|
|
12696
12739
|
description: "Date and time at which the [credential](https://docs.seam.co/low-level-apis/access-systems/managing-credentials) becomes usable.",
|
|
12697
12740
|
format: "date-time",
|
|
@@ -12794,6 +12837,7 @@ var openapi = {
|
|
|
12794
12837
|
type: "string"
|
|
12795
12838
|
},
|
|
12796
12839
|
acs_credential_pool_id: {
|
|
12840
|
+
description: "ID of the credential pool to which the credential belongs.",
|
|
12797
12841
|
format: "uuid",
|
|
12798
12842
|
type: "string"
|
|
12799
12843
|
},
|
|
@@ -12911,7 +12955,11 @@ var openapi = {
|
|
|
12911
12955
|
nullable: true,
|
|
12912
12956
|
type: "boolean"
|
|
12913
12957
|
},
|
|
12914
|
-
is_managed: {
|
|
12958
|
+
is_managed: {
|
|
12959
|
+
description: "Indicates whether Seam manages the credential.",
|
|
12960
|
+
enum: [true],
|
|
12961
|
+
type: "boolean"
|
|
12962
|
+
},
|
|
12915
12963
|
is_multi_phone_sync_credential: {
|
|
12916
12964
|
description: "Indicates whether the [credential](https://docs.seam.co/low-level-apis/access-systems/managing-credentials) is a [multi-phone sync credential](https://docs.seam.co/capability-guides/mobile-access/issuing-mobile-credentials-from-an-access-control-system#what-are-multi-phone-sync-credentials).",
|
|
12917
12965
|
type: "boolean"
|
|
@@ -13152,7 +13200,7 @@ var openapi = {
|
|
|
13152
13200
|
type: "array"
|
|
13153
13201
|
},
|
|
13154
13202
|
workspace_id: {
|
|
13155
|
-
description: "ID of the
|
|
13203
|
+
description: "ID of the workspace that contains the [credential](https://docs.seam.co/low-level-apis/access-systems/managing-credentials).",
|
|
13156
13204
|
format: "uuid",
|
|
13157
13205
|
type: "string"
|
|
13158
13206
|
}
|
|
@@ -13186,6 +13234,7 @@ var openapi = {
|
|
|
13186
13234
|
type: "string"
|
|
13187
13235
|
},
|
|
13188
13236
|
acs_credential_pool_id: {
|
|
13237
|
+
description: "ID of the credential pool to which the credential belongs.",
|
|
13189
13238
|
format: "uuid",
|
|
13190
13239
|
type: "string"
|
|
13191
13240
|
},
|
|
@@ -13544,7 +13593,7 @@ var openapi = {
|
|
|
13544
13593
|
type: "array"
|
|
13545
13594
|
},
|
|
13546
13595
|
workspace_id: {
|
|
13547
|
-
description: "ID of the
|
|
13596
|
+
description: "ID of the workspace that contains the [credential](https://docs.seam.co/low-level-apis/access-systems/managing-credentials).",
|
|
13548
13597
|
format: "uuid",
|
|
13549
13598
|
type: "string"
|
|
13550
13599
|
}
|
|
@@ -13804,6 +13853,7 @@ var openapi = {
|
|
|
13804
13853
|
type: "string"
|
|
13805
13854
|
},
|
|
13806
13855
|
acs_credential_pool_id: {
|
|
13856
|
+
description: "ID of the credential pool to which the credential belongs.",
|
|
13807
13857
|
format: "uuid",
|
|
13808
13858
|
type: "string"
|
|
13809
13859
|
},
|
|
@@ -13921,7 +13971,11 @@ var openapi = {
|
|
|
13921
13971
|
nullable: true,
|
|
13922
13972
|
type: "boolean"
|
|
13923
13973
|
},
|
|
13924
|
-
is_managed: {
|
|
13974
|
+
is_managed: {
|
|
13975
|
+
description: "Indicates whether Seam manages the credential.",
|
|
13976
|
+
enum: [true],
|
|
13977
|
+
type: "boolean"
|
|
13978
|
+
},
|
|
13925
13979
|
is_multi_phone_sync_credential: {
|
|
13926
13980
|
description: "Indicates whether the [credential](https://docs.seam.co/low-level-apis/access-systems/managing-credentials) is a [multi-phone sync credential](https://docs.seam.co/capability-guides/mobile-access/issuing-mobile-credentials-from-an-access-control-system#what-are-multi-phone-sync-credentials).",
|
|
13927
13981
|
type: "boolean"
|
|
@@ -14160,7 +14214,7 @@ var openapi = {
|
|
|
14160
14214
|
type: "array"
|
|
14161
14215
|
},
|
|
14162
14216
|
workspace_id: {
|
|
14163
|
-
description: "ID of the
|
|
14217
|
+
description: "ID of the workspace that contains the [credential](https://docs.seam.co/low-level-apis/access-systems/managing-credentials).",
|
|
14164
14218
|
format: "uuid",
|
|
14165
14219
|
type: "string"
|
|
14166
14220
|
}
|
|
@@ -14194,6 +14248,7 @@ var openapi = {
|
|
|
14194
14248
|
type: "string"
|
|
14195
14249
|
},
|
|
14196
14250
|
acs_credential_pool_id: {
|
|
14251
|
+
description: "ID of the credential pool to which the credential belongs.",
|
|
14197
14252
|
format: "uuid",
|
|
14198
14253
|
type: "string"
|
|
14199
14254
|
},
|
|
@@ -14550,7 +14605,7 @@ var openapi = {
|
|
|
14550
14605
|
type: "array"
|
|
14551
14606
|
},
|
|
14552
14607
|
workspace_id: {
|
|
14553
|
-
description: "ID of the
|
|
14608
|
+
description: "ID of the workspace that contains the [credential](https://docs.seam.co/low-level-apis/access-systems/managing-credentials).",
|
|
14554
14609
|
format: "uuid",
|
|
14555
14610
|
type: "string"
|
|
14556
14611
|
}
|
|
@@ -14838,7 +14893,11 @@ var openapi = {
|
|
|
14838
14893
|
format: "uuid",
|
|
14839
14894
|
type: "string"
|
|
14840
14895
|
},
|
|
14841
|
-
acs_credential_pool_id: {
|
|
14896
|
+
acs_credential_pool_id: {
|
|
14897
|
+
description: "ID of the credential pool to which the credential belongs.",
|
|
14898
|
+
format: "uuid",
|
|
14899
|
+
type: "string"
|
|
14900
|
+
},
|
|
14842
14901
|
acs_system_id: {
|
|
14843
14902
|
description: "ID of the [access control system](https://docs.seam.co/low-level-apis/access-systems) that contains the [credential](https://docs.seam.co/low-level-apis/access-systems/managing-credentials).",
|
|
14844
14903
|
format: "uuid",
|
|
@@ -14953,7 +15012,11 @@ var openapi = {
|
|
|
14953
15012
|
nullable: true,
|
|
14954
15013
|
type: "boolean"
|
|
14955
15014
|
},
|
|
14956
|
-
is_managed: {
|
|
15015
|
+
is_managed: {
|
|
15016
|
+
description: "Indicates whether Seam manages the credential.",
|
|
15017
|
+
enum: [true],
|
|
15018
|
+
type: "boolean"
|
|
15019
|
+
},
|
|
14957
15020
|
is_multi_phone_sync_credential: {
|
|
14958
15021
|
description: "Indicates whether the [credential](https://docs.seam.co/low-level-apis/access-systems/managing-credentials) is a [multi-phone sync credential](https://docs.seam.co/capability-guides/mobile-access/issuing-mobile-credentials-from-an-access-control-system#what-are-multi-phone-sync-credentials).",
|
|
14959
15022
|
type: "boolean"
|
|
@@ -15168,7 +15231,7 @@ var openapi = {
|
|
|
15168
15231
|
type: "array"
|
|
15169
15232
|
},
|
|
15170
15233
|
workspace_id: {
|
|
15171
|
-
description: "ID of the
|
|
15234
|
+
description: "ID of the workspace that contains the [credential](https://docs.seam.co/low-level-apis/access-systems/managing-credentials).",
|
|
15172
15235
|
format: "uuid",
|
|
15173
15236
|
type: "string"
|
|
15174
15237
|
}
|
|
@@ -17651,7 +17714,7 @@ var openapi = {
|
|
|
17651
17714
|
type: "string"
|
|
17652
17715
|
},
|
|
17653
17716
|
workspace_id: {
|
|
17654
|
-
description: "ID of the
|
|
17717
|
+
description: "ID of the workspace with which Seam Bridge is paired.",
|
|
17655
17718
|
format: "uuid",
|
|
17656
17719
|
type: "string"
|
|
17657
17720
|
}
|
|
@@ -17674,7 +17737,7 @@ var openapi = {
|
|
|
17674
17737
|
description: "Represents a [client session](https://docs.seam.co/core-concepts/authentication/client-session-tokens). If you want to restrict your users' access to their own devices, use client sessions.\n\nYou create each client session with a custom `user_identifier_key`. Normally, the `user_identifier_key` is a user ID that your application provides.\n\nWhen calling the Seam API from your backend using an API key, you can pass the `user_identifier_key` as a parameter to limit results to the associated client session. For example, `/devices/list?user_identifier_key=123` only returns devices associated with the client session created with the `user_identifier_key` `123`.\n\nA client session has a token that you can use with the Seam JavaScript SDK to make requests from the client (browser) directly to the Seam API. The token restricts the user's access to only the devices that they own.\n\nSee also [Get Started with React](https://docs.seam.co/ui-components/overview/getting-started-with-seam-components/get-started-with-react-components-and-client-session-tokens).",
|
|
17675
17738
|
properties: {
|
|
17676
17739
|
client_session_id: {
|
|
17677
|
-
description: "ID of the
|
|
17740
|
+
description: "ID of the client session.",
|
|
17678
17741
|
format: "uuid",
|
|
17679
17742
|
type: "string"
|
|
17680
17743
|
},
|
|
@@ -17729,7 +17792,7 @@ var openapi = {
|
|
|
17729
17792
|
"x-deprecated": "Use `user_identity_id` instead."
|
|
17730
17793
|
},
|
|
17731
17794
|
workspace_id: {
|
|
17732
|
-
description: "ID of the
|
|
17795
|
+
description: "ID of the workspace associated with the client session.",
|
|
17733
17796
|
format: "uuid",
|
|
17734
17797
|
type: "string"
|
|
17735
17798
|
}
|
|
@@ -17805,7 +17868,7 @@ var openapi = {
|
|
|
17805
17868
|
type: "string"
|
|
17806
17869
|
},
|
|
17807
17870
|
connected_account_id: {
|
|
17808
|
-
description: "ID of the
|
|
17871
|
+
description: "ID of the connected account associated with the Connect Webview.",
|
|
17809
17872
|
format: "uuid",
|
|
17810
17873
|
nullable: true,
|
|
17811
17874
|
type: "string"
|
|
@@ -17839,6 +17902,7 @@ var openapi = {
|
|
|
17839
17902
|
type: "string"
|
|
17840
17903
|
},
|
|
17841
17904
|
device_selection_mode: {
|
|
17905
|
+
description: "Device selection mode of the Connect Webview. Supported values: `none`, `single`, `multiple`.",
|
|
17842
17906
|
enum: ["none", "single", "multiple"],
|
|
17843
17907
|
type: "string"
|
|
17844
17908
|
},
|
|
@@ -17866,7 +17930,7 @@ var openapi = {
|
|
|
17866
17930
|
type: "boolean"
|
|
17867
17931
|
},
|
|
17868
17932
|
workspace_id: {
|
|
17869
|
-
description: "ID of the
|
|
17933
|
+
description: "ID of the workspace that contains the Connect Webview.",
|
|
17870
17934
|
format: "uuid",
|
|
17871
17935
|
type: "string"
|
|
17872
17936
|
}
|
|
@@ -18426,7 +18490,7 @@ var openapi = {
|
|
|
18426
18490
|
type: "string"
|
|
18427
18491
|
},
|
|
18428
18492
|
workspace_id: {
|
|
18429
|
-
description: "ID of the
|
|
18493
|
+
description: "ID of the workspace associated with the customer.",
|
|
18430
18494
|
format: "uuid",
|
|
18431
18495
|
type: "string"
|
|
18432
18496
|
}
|
|
@@ -18459,7 +18523,7 @@ var openapi = {
|
|
|
18459
18523
|
type: "string"
|
|
18460
18524
|
},
|
|
18461
18525
|
workspace_id: {
|
|
18462
|
-
description: "ID of the
|
|
18526
|
+
description: "ID of the workspace associated with the customer portal.",
|
|
18463
18527
|
format: "uuid",
|
|
18464
18528
|
type: "string"
|
|
18465
18529
|
}
|
|
@@ -18517,30 +18581,86 @@ var openapi = {
|
|
|
18517
18581
|
device: {
|
|
18518
18582
|
description: "Represents a [device](https://docs.seam.co/core-concepts/devices) that has been connected to Seam.",
|
|
18519
18583
|
properties: {
|
|
18520
|
-
can_configure_auto_lock: {
|
|
18521
|
-
|
|
18522
|
-
|
|
18523
|
-
|
|
18524
|
-
|
|
18525
|
-
|
|
18584
|
+
can_configure_auto_lock: {
|
|
18585
|
+
description: "Indicates whether the lock supports configuring automatic locking.",
|
|
18586
|
+
type: "boolean"
|
|
18587
|
+
},
|
|
18588
|
+
can_hvac_cool: {
|
|
18589
|
+
description: "Indicates whether the thermostat supports cooling.",
|
|
18590
|
+
type: "boolean"
|
|
18591
|
+
},
|
|
18592
|
+
can_hvac_heat: {
|
|
18593
|
+
description: "Indicates whether the thermostat supports heating.",
|
|
18594
|
+
type: "boolean"
|
|
18595
|
+
},
|
|
18596
|
+
can_hvac_heat_cool: {
|
|
18597
|
+
description: "Indicates whether the thermostat supports simultaneous heating and cooling.",
|
|
18598
|
+
type: "boolean"
|
|
18599
|
+
},
|
|
18600
|
+
can_program_offline_access_codes: {
|
|
18601
|
+
description: "Indicates whether the device supports programming offline access codes.",
|
|
18602
|
+
type: "boolean"
|
|
18603
|
+
},
|
|
18604
|
+
can_program_online_access_codes: {
|
|
18605
|
+
description: "Indicates whether the device supports programming online access codes.",
|
|
18606
|
+
type: "boolean"
|
|
18607
|
+
},
|
|
18526
18608
|
can_program_thermostat_programs_as_different_each_day: {
|
|
18609
|
+
description: "Indicates whether the thermostat supports different climate programs for each day of the week.",
|
|
18610
|
+
type: "boolean"
|
|
18611
|
+
},
|
|
18612
|
+
can_program_thermostat_programs_as_same_each_day: {
|
|
18613
|
+
description: "Indicates whether the thermostat supports a single climate program applied to every day.",
|
|
18527
18614
|
type: "boolean"
|
|
18528
18615
|
},
|
|
18529
|
-
can_program_thermostat_programs_as_same_each_day: { type: "boolean" },
|
|
18530
18616
|
can_program_thermostat_programs_as_weekday_weekend: {
|
|
18617
|
+
description: "Indicates whether the thermostat supports weekday/weekend climate programs.",
|
|
18618
|
+
type: "boolean"
|
|
18619
|
+
},
|
|
18620
|
+
can_remotely_lock: {
|
|
18621
|
+
description: "Indicates whether the device supports remote locking.",
|
|
18622
|
+
type: "boolean"
|
|
18623
|
+
},
|
|
18624
|
+
can_remotely_unlock: {
|
|
18625
|
+
description: "Indicates whether the device supports remote unlocking.",
|
|
18626
|
+
type: "boolean"
|
|
18627
|
+
},
|
|
18628
|
+
can_run_thermostat_programs: {
|
|
18629
|
+
description: "Indicates whether the thermostat supports running climate programs.",
|
|
18630
|
+
type: "boolean"
|
|
18631
|
+
},
|
|
18632
|
+
can_simulate_connection: {
|
|
18633
|
+
description: "Indicates whether the device supports simulating connection in a sandbox.",
|
|
18634
|
+
type: "boolean"
|
|
18635
|
+
},
|
|
18636
|
+
can_simulate_disconnection: {
|
|
18637
|
+
description: "Indicates whether the device supports simulating disconnection in a sandbox.",
|
|
18638
|
+
type: "boolean"
|
|
18639
|
+
},
|
|
18640
|
+
can_simulate_hub_connection: {
|
|
18641
|
+
description: "Indicates whether the hub supports simulating connection in a sandbox.",
|
|
18642
|
+
type: "boolean"
|
|
18643
|
+
},
|
|
18644
|
+
can_simulate_hub_disconnection: {
|
|
18645
|
+
description: "Indicates whether the hub supports simulating disconnection in a sandbox.",
|
|
18646
|
+
type: "boolean"
|
|
18647
|
+
},
|
|
18648
|
+
can_simulate_paid_subscription: {
|
|
18649
|
+
description: "Indicates whether the device supports simulating a paid subscription in a sandbox.",
|
|
18650
|
+
type: "boolean"
|
|
18651
|
+
},
|
|
18652
|
+
can_simulate_removal: {
|
|
18653
|
+
description: "Indicates whether the device supports simulating removal in a sandbox.",
|
|
18654
|
+
type: "boolean"
|
|
18655
|
+
},
|
|
18656
|
+
can_turn_off_hvac: {
|
|
18657
|
+
description: "Indicates whether the thermostat can be turned off.",
|
|
18658
|
+
type: "boolean"
|
|
18659
|
+
},
|
|
18660
|
+
can_unlock_with_code: {
|
|
18661
|
+
description: "Indicates whether the lock supports unlocking with an access code.",
|
|
18531
18662
|
type: "boolean"
|
|
18532
18663
|
},
|
|
18533
|
-
can_remotely_lock: { type: "boolean" },
|
|
18534
|
-
can_remotely_unlock: { type: "boolean" },
|
|
18535
|
-
can_run_thermostat_programs: { type: "boolean" },
|
|
18536
|
-
can_simulate_connection: { type: "boolean" },
|
|
18537
|
-
can_simulate_disconnection: { type: "boolean" },
|
|
18538
|
-
can_simulate_hub_connection: { type: "boolean" },
|
|
18539
|
-
can_simulate_hub_disconnection: { type: "boolean" },
|
|
18540
|
-
can_simulate_paid_subscription: { type: "boolean" },
|
|
18541
|
-
can_simulate_removal: { type: "boolean" },
|
|
18542
|
-
can_turn_off_hvac: { type: "boolean" },
|
|
18543
|
-
can_unlock_with_code: { type: "boolean" },
|
|
18544
18664
|
capabilities_supported: {
|
|
18545
18665
|
description: "\n Collection of capabilities that the device supports when connected to Seam. Values are `access_code`, which indicates that the device can manage and utilize digital PIN codes for secure access; `lock`, which indicates that the device controls a door locking mechanism, enabling the remote opening and closing of doors and other entry points; `noise_detection`, which indicates that the device supports monitoring and responding to ambient noise levels; `thermostat`, which indicates that the device can regulate and adjust indoor temperatures; `battery`, which indicates that the device can manage battery life and health; and `phone`, which indicates that the device is a mobile device, such as a smartphone. **Important:** Superseded by [capability flags](https://docs.seam.co/capability-guides/device-and-system-capabilities#capability-flags).\n ",
|
|
18546
18666
|
items: {
|
|
@@ -20981,7 +21101,7 @@ var openapi = {
|
|
|
20981
21101
|
type: "string"
|
|
20982
21102
|
},
|
|
20983
21103
|
workspace_id: {
|
|
20984
|
-
description: "ID of the
|
|
21104
|
+
description: "ID of the workspace that contains the thermostat schedule.",
|
|
20985
21105
|
format: "uuid",
|
|
20986
21106
|
type: "string"
|
|
20987
21107
|
}
|
|
@@ -21012,6 +21132,7 @@ var openapi = {
|
|
|
21012
21132
|
available_climate_preset_modes: {
|
|
21013
21133
|
description: 'Climate preset modes that the thermostat supports, such as "home", "away", "wake", "sleep", "occupied", and "unoccupied".',
|
|
21014
21134
|
items: {
|
|
21135
|
+
description: "Climate preset mode for the thermostat, such as `home`, `away`, `wake`, `sleep`, `occupied`, or `unoccupied`.",
|
|
21015
21136
|
enum: [
|
|
21016
21137
|
"home",
|
|
21017
21138
|
"away",
|
|
@@ -21145,6 +21266,7 @@ var openapi = {
|
|
|
21145
21266
|
available_fan_mode_settings: {
|
|
21146
21267
|
description: "Fan mode settings that the thermostat supports.",
|
|
21147
21268
|
items: {
|
|
21269
|
+
description: "Fan mode setting for the thermostat, such as `auto`, `on`, or `circulate`.",
|
|
21148
21270
|
enum: ["auto", "on", "circulate"],
|
|
21149
21271
|
type: "string"
|
|
21150
21272
|
},
|
|
@@ -21154,6 +21276,7 @@ var openapi = {
|
|
|
21154
21276
|
available_hvac_mode_settings: {
|
|
21155
21277
|
description: "HVAC mode settings that the thermostat supports.",
|
|
21156
21278
|
items: {
|
|
21279
|
+
description: "HVAC mode setting for the thermostat, such as `heat`, `cool`, `heat_cool`, `eco`, or `off`.",
|
|
21157
21280
|
enum: ["off", "heat", "cool", "heat_cool", "eco"],
|
|
21158
21281
|
type: "string"
|
|
21159
21282
|
},
|
|
@@ -21581,7 +21704,7 @@ var openapi = {
|
|
|
21581
21704
|
type: "string"
|
|
21582
21705
|
},
|
|
21583
21706
|
workspace_id: {
|
|
21584
|
-
description: "ID of the
|
|
21707
|
+
description: "ID of the workspace that contains the thermostat daily program.",
|
|
21585
21708
|
format: "uuid",
|
|
21586
21709
|
type: "string"
|
|
21587
21710
|
}
|
|
@@ -22318,31 +22441,88 @@ var openapi = {
|
|
|
22318
22441
|
},
|
|
22319
22442
|
device_provider: {
|
|
22320
22443
|
properties: {
|
|
22321
|
-
can_configure_auto_lock: {
|
|
22322
|
-
|
|
22323
|
-
|
|
22324
|
-
|
|
22325
|
-
|
|
22326
|
-
|
|
22444
|
+
can_configure_auto_lock: {
|
|
22445
|
+
description: "Indicates whether the lock supports configuring automatic locking.",
|
|
22446
|
+
type: "boolean"
|
|
22447
|
+
},
|
|
22448
|
+
can_hvac_cool: {
|
|
22449
|
+
description: "Indicates whether the thermostat supports cooling.",
|
|
22450
|
+
type: "boolean"
|
|
22451
|
+
},
|
|
22452
|
+
can_hvac_heat: {
|
|
22453
|
+
description: "Indicates whether the thermostat supports heating.",
|
|
22454
|
+
type: "boolean"
|
|
22455
|
+
},
|
|
22456
|
+
can_hvac_heat_cool: {
|
|
22457
|
+
description: "Indicates whether the thermostat supports simultaneous heating and cooling.",
|
|
22458
|
+
type: "boolean"
|
|
22459
|
+
},
|
|
22460
|
+
can_program_offline_access_codes: {
|
|
22461
|
+
description: "Indicates whether the device supports programming offline access codes.",
|
|
22462
|
+
type: "boolean"
|
|
22463
|
+
},
|
|
22464
|
+
can_program_online_access_codes: {
|
|
22465
|
+
description: "Indicates whether the device supports programming online access codes.",
|
|
22466
|
+
type: "boolean"
|
|
22467
|
+
},
|
|
22327
22468
|
can_program_thermostat_programs_as_different_each_day: {
|
|
22469
|
+
description: "Indicates whether the thermostat supports different climate programs for each day of the week.",
|
|
22470
|
+
type: "boolean"
|
|
22471
|
+
},
|
|
22472
|
+
can_program_thermostat_programs_as_same_each_day: {
|
|
22473
|
+
description: "Indicates whether the thermostat supports a single climate program applied to every day.",
|
|
22328
22474
|
type: "boolean"
|
|
22329
22475
|
},
|
|
22330
|
-
can_program_thermostat_programs_as_same_each_day: { type: "boolean" },
|
|
22331
22476
|
can_program_thermostat_programs_as_weekday_weekend: {
|
|
22477
|
+
description: "Indicates whether the thermostat supports weekday/weekend climate programs.",
|
|
22478
|
+
type: "boolean"
|
|
22479
|
+
},
|
|
22480
|
+
can_remotely_lock: {
|
|
22481
|
+
description: "Indicates whether the device supports remote locking.",
|
|
22482
|
+
type: "boolean"
|
|
22483
|
+
},
|
|
22484
|
+
can_remotely_unlock: {
|
|
22485
|
+
description: "Indicates whether the device supports remote unlocking.",
|
|
22486
|
+
type: "boolean"
|
|
22487
|
+
},
|
|
22488
|
+
can_run_thermostat_programs: {
|
|
22489
|
+
description: "Indicates whether the thermostat supports running climate programs.",
|
|
22490
|
+
type: "boolean"
|
|
22491
|
+
},
|
|
22492
|
+
can_simulate_connection: {
|
|
22493
|
+
description: "Indicates whether the device supports simulating connection in a sandbox.",
|
|
22494
|
+
type: "boolean"
|
|
22495
|
+
},
|
|
22496
|
+
can_simulate_disconnection: {
|
|
22497
|
+
description: "Indicates whether the device supports simulating disconnection in a sandbox.",
|
|
22498
|
+
type: "boolean"
|
|
22499
|
+
},
|
|
22500
|
+
can_simulate_hub_connection: {
|
|
22501
|
+
description: "Indicates whether the hub supports simulating connection in a sandbox.",
|
|
22502
|
+
type: "boolean"
|
|
22503
|
+
},
|
|
22504
|
+
can_simulate_hub_disconnection: {
|
|
22505
|
+
description: "Indicates whether the hub supports simulating disconnection in a sandbox.",
|
|
22506
|
+
type: "boolean"
|
|
22507
|
+
},
|
|
22508
|
+
can_simulate_paid_subscription: {
|
|
22509
|
+
description: "Indicates whether the device supports simulating a paid subscription in a sandbox.",
|
|
22510
|
+
type: "boolean"
|
|
22511
|
+
},
|
|
22512
|
+
can_simulate_removal: {
|
|
22513
|
+
description: "Indicates whether the device supports simulating removal in a sandbox.",
|
|
22514
|
+
type: "boolean"
|
|
22515
|
+
},
|
|
22516
|
+
can_turn_off_hvac: {
|
|
22517
|
+
description: "Indicates whether the thermostat can be turned off.",
|
|
22518
|
+
type: "boolean"
|
|
22519
|
+
},
|
|
22520
|
+
can_unlock_with_code: {
|
|
22521
|
+
description: "Indicates whether the lock supports unlocking with an access code.",
|
|
22332
22522
|
type: "boolean"
|
|
22333
22523
|
},
|
|
22334
|
-
can_remotely_lock: { type: "boolean" },
|
|
22335
|
-
can_remotely_unlock: { type: "boolean" },
|
|
22336
|
-
can_run_thermostat_programs: { type: "boolean" },
|
|
22337
|
-
can_simulate_connection: { type: "boolean" },
|
|
22338
|
-
can_simulate_disconnection: { type: "boolean" },
|
|
22339
|
-
can_simulate_hub_connection: { type: "boolean" },
|
|
22340
|
-
can_simulate_hub_disconnection: { type: "boolean" },
|
|
22341
|
-
can_simulate_paid_subscription: { type: "boolean" },
|
|
22342
|
-
can_simulate_removal: { type: "boolean" },
|
|
22343
|
-
can_turn_off_hvac: { type: "boolean" },
|
|
22344
|
-
can_unlock_with_code: { type: "boolean" },
|
|
22345
22524
|
device_provider_name: {
|
|
22525
|
+
description: "Name of the device provider.",
|
|
22346
22526
|
enum: [
|
|
22347
22527
|
"hotek",
|
|
22348
22528
|
"dormakaba_community",
|
|
@@ -22407,9 +22587,16 @@ var openapi = {
|
|
|
22407
22587
|
],
|
|
22408
22588
|
type: "string"
|
|
22409
22589
|
},
|
|
22410
|
-
display_name: {
|
|
22411
|
-
|
|
22590
|
+
display_name: {
|
|
22591
|
+
description: "Display name for the device provider.",
|
|
22592
|
+
type: "string"
|
|
22593
|
+
},
|
|
22594
|
+
image_url: {
|
|
22595
|
+
description: "Image URL for the device provider.",
|
|
22596
|
+
type: "string"
|
|
22597
|
+
},
|
|
22412
22598
|
provider_categories: {
|
|
22599
|
+
description: "List of provider categories to which the device provider belongs, such as `stable`, `consumer_smartlocks`, `thermostats`, and so on.",
|
|
22413
22600
|
items: {
|
|
22414
22601
|
enum: [
|
|
22415
22602
|
"stable",
|
|
@@ -22459,7 +22646,7 @@ var openapi = {
|
|
|
22459
22646
|
type: "string"
|
|
22460
22647
|
},
|
|
22461
22648
|
workspace_id: {
|
|
22462
|
-
description: "ID of the
|
|
22649
|
+
description: "ID of the workspace that contains the enrollment automation.",
|
|
22463
22650
|
format: "uuid",
|
|
22464
22651
|
type: "string"
|
|
22465
22652
|
}
|
|
@@ -22476,7 +22663,7 @@ var openapi = {
|
|
|
22476
22663
|
"x-undocumented": "Will be removed."
|
|
22477
22664
|
},
|
|
22478
22665
|
event: {
|
|
22479
|
-
description: "Represents an event. Events let you know when something interesting happens in your workspace. For example, when a lock is unlocked, Seam creates a `lock.unlocked` event. When a device's battery level is low, Seam creates a `device.battery_low` event.\n\nAs with other API resources, you can retrieve an individual event or a list of events. Seam also provides a separate
|
|
22666
|
+
description: "Represents an event. Events let you know when something interesting happens in your workspace. For example, when a lock is unlocked, Seam creates a `lock.unlocked` event. When a device's battery level is low, Seam creates a `device.battery_low` event.\n\nAs with other API resources, you can retrieve an individual event or a list of events. Seam also provides a separate webhook system for sending the event objects directly to an endpoint on your sever. Manage webhooks through [Seam Console](https://console.seam.co). You can also use the webhooks sandbox in Seam Console to see the different payloads for each event and test them against your own endpoints.",
|
|
22480
22667
|
discriminator: { propertyName: "event_type" },
|
|
22481
22668
|
oneOf: [
|
|
22482
22669
|
{
|
|
@@ -22495,7 +22682,7 @@ var openapi = {
|
|
|
22495
22682
|
type: "object"
|
|
22496
22683
|
},
|
|
22497
22684
|
connected_account_id: {
|
|
22498
|
-
description: "ID of the
|
|
22685
|
+
description: "ID of the connected account associated with the affected access code.",
|
|
22499
22686
|
format: "uuid",
|
|
22500
22687
|
type: "string"
|
|
22501
22688
|
},
|
|
@@ -22528,7 +22715,7 @@ var openapi = {
|
|
|
22528
22715
|
type: "string"
|
|
22529
22716
|
},
|
|
22530
22717
|
workspace_id: {
|
|
22531
|
-
description: "ID of the
|
|
22718
|
+
description: "ID of the workspace associated with the event.",
|
|
22532
22719
|
format: "uuid",
|
|
22533
22720
|
type: "string"
|
|
22534
22721
|
}
|
|
@@ -22561,6 +22748,7 @@ var openapi = {
|
|
|
22561
22748
|
changed_properties: {
|
|
22562
22749
|
description: "List of properties that changed on the access code.",
|
|
22563
22750
|
items: {
|
|
22751
|
+
description: "Record describing a single changed property.",
|
|
22564
22752
|
properties: {
|
|
22565
22753
|
from: {
|
|
22566
22754
|
description: "Previous value of the property, or null if not set.",
|
|
@@ -22590,7 +22778,7 @@ var openapi = {
|
|
|
22590
22778
|
type: "object"
|
|
22591
22779
|
},
|
|
22592
22780
|
connected_account_id: {
|
|
22593
|
-
description: "ID of the
|
|
22781
|
+
description: "ID of the connected account associated with the affected access code.",
|
|
22594
22782
|
format: "uuid",
|
|
22595
22783
|
type: "string"
|
|
22596
22784
|
},
|
|
@@ -22623,7 +22811,7 @@ var openapi = {
|
|
|
22623
22811
|
type: "string"
|
|
22624
22812
|
},
|
|
22625
22813
|
workspace_id: {
|
|
22626
|
-
description: "ID of the
|
|
22814
|
+
description: "ID of the workspace associated with the event.",
|
|
22627
22815
|
format: "uuid",
|
|
22628
22816
|
type: "string"
|
|
22629
22817
|
}
|
|
@@ -22657,7 +22845,7 @@ var openapi = {
|
|
|
22657
22845
|
type: "object"
|
|
22658
22846
|
},
|
|
22659
22847
|
connected_account_id: {
|
|
22660
|
-
description: "ID of the
|
|
22848
|
+
description: "ID of the connected account associated with the affected access code.",
|
|
22661
22849
|
format: "uuid",
|
|
22662
22850
|
type: "string"
|
|
22663
22851
|
},
|
|
@@ -22721,7 +22909,7 @@ var openapi = {
|
|
|
22721
22909
|
type: "object"
|
|
22722
22910
|
},
|
|
22723
22911
|
workspace_id: {
|
|
22724
|
-
description: "ID of the
|
|
22912
|
+
description: "ID of the workspace associated with the event.",
|
|
22725
22913
|
format: "uuid",
|
|
22726
22914
|
type: "string"
|
|
22727
22915
|
}
|
|
@@ -22758,7 +22946,7 @@ var openapi = {
|
|
|
22758
22946
|
type: "object"
|
|
22759
22947
|
},
|
|
22760
22948
|
connected_account_id: {
|
|
22761
|
-
description: "ID of the
|
|
22949
|
+
description: "ID of the connected account associated with the affected access code.",
|
|
22762
22950
|
format: "uuid",
|
|
22763
22951
|
type: "string"
|
|
22764
22952
|
},
|
|
@@ -22822,7 +23010,7 @@ var openapi = {
|
|
|
22822
23010
|
type: "object"
|
|
22823
23011
|
},
|
|
22824
23012
|
workspace_id: {
|
|
22825
|
-
description: "ID of the
|
|
23013
|
+
description: "ID of the workspace associated with the event.",
|
|
22826
23014
|
format: "uuid",
|
|
22827
23015
|
type: "string"
|
|
22828
23016
|
}
|
|
@@ -22859,7 +23047,7 @@ var openapi = {
|
|
|
22859
23047
|
type: "object"
|
|
22860
23048
|
},
|
|
22861
23049
|
connected_account_id: {
|
|
22862
|
-
description: "ID of the
|
|
23050
|
+
description: "ID of the connected account associated with the affected access code.",
|
|
22863
23051
|
format: "uuid",
|
|
22864
23052
|
type: "string"
|
|
22865
23053
|
},
|
|
@@ -22933,7 +23121,7 @@ var openapi = {
|
|
|
22933
23121
|
type: "object"
|
|
22934
23122
|
},
|
|
22935
23123
|
workspace_id: {
|
|
22936
|
-
description: "ID of the
|
|
23124
|
+
description: "ID of the workspace associated with the event.",
|
|
22937
23125
|
format: "uuid",
|
|
22938
23126
|
type: "string"
|
|
22939
23127
|
}
|
|
@@ -22974,7 +23162,7 @@ var openapi = {
|
|
|
22974
23162
|
type: "object"
|
|
22975
23163
|
},
|
|
22976
23164
|
connected_account_id: {
|
|
22977
|
-
description: "ID of the
|
|
23165
|
+
description: "ID of the connected account associated with the affected access code.",
|
|
22978
23166
|
format: "uuid",
|
|
22979
23167
|
type: "string"
|
|
22980
23168
|
},
|
|
@@ -23010,7 +23198,7 @@ var openapi = {
|
|
|
23010
23198
|
type: "string"
|
|
23011
23199
|
},
|
|
23012
23200
|
workspace_id: {
|
|
23013
|
-
description: "ID of the
|
|
23201
|
+
description: "ID of the workspace associated with the event.",
|
|
23014
23202
|
format: "uuid",
|
|
23015
23203
|
type: "string"
|
|
23016
23204
|
}
|
|
@@ -23049,7 +23237,7 @@ var openapi = {
|
|
|
23049
23237
|
type: "object"
|
|
23050
23238
|
},
|
|
23051
23239
|
connected_account_id: {
|
|
23052
|
-
description: "ID of the
|
|
23240
|
+
description: "ID of the connected account associated with the affected access code.",
|
|
23053
23241
|
format: "uuid",
|
|
23054
23242
|
type: "string"
|
|
23055
23243
|
},
|
|
@@ -23085,7 +23273,7 @@ var openapi = {
|
|
|
23085
23273
|
type: "string"
|
|
23086
23274
|
},
|
|
23087
23275
|
workspace_id: {
|
|
23088
|
-
description: "ID of the
|
|
23276
|
+
description: "ID of the workspace associated with the event.",
|
|
23089
23277
|
format: "uuid",
|
|
23090
23278
|
type: "string"
|
|
23091
23279
|
}
|
|
@@ -23120,7 +23308,7 @@ var openapi = {
|
|
|
23120
23308
|
type: "object"
|
|
23121
23309
|
},
|
|
23122
23310
|
connected_account_id: {
|
|
23123
|
-
description: "ID of the
|
|
23311
|
+
description: "ID of the connected account associated with the affected access code.",
|
|
23124
23312
|
format: "uuid",
|
|
23125
23313
|
type: "string"
|
|
23126
23314
|
},
|
|
@@ -23156,7 +23344,7 @@ var openapi = {
|
|
|
23156
23344
|
type: "string"
|
|
23157
23345
|
},
|
|
23158
23346
|
workspace_id: {
|
|
23159
|
-
description: "ID of the
|
|
23347
|
+
description: "ID of the workspace associated with the event.",
|
|
23160
23348
|
format: "uuid",
|
|
23161
23349
|
type: "string"
|
|
23162
23350
|
}
|
|
@@ -23180,6 +23368,7 @@ var openapi = {
|
|
|
23180
23368
|
access_code_errors: {
|
|
23181
23369
|
description: "Errors associated with the access code.",
|
|
23182
23370
|
items: {
|
|
23371
|
+
description: "Error associated with the resource, including the error code, message, and creation timestamp.",
|
|
23183
23372
|
properties: {
|
|
23184
23373
|
created_at: {
|
|
23185
23374
|
description: "Date and time at which Seam created the error.",
|
|
@@ -23208,6 +23397,7 @@ var openapi = {
|
|
|
23208
23397
|
access_code_warnings: {
|
|
23209
23398
|
description: "Warnings associated with the access code.",
|
|
23210
23399
|
items: {
|
|
23400
|
+
description: "Warning associated with the resource, including the warning code, message, and creation timestamp.",
|
|
23211
23401
|
properties: {
|
|
23212
23402
|
created_at: {
|
|
23213
23403
|
description: "Date and time at which Seam created the warning.",
|
|
@@ -23238,6 +23428,7 @@ var openapi = {
|
|
|
23238
23428
|
connected_account_errors: {
|
|
23239
23429
|
description: "Errors associated with the connected account.",
|
|
23240
23430
|
items: {
|
|
23431
|
+
description: "Error associated with the resource, including the error code, message, and creation timestamp.",
|
|
23241
23432
|
properties: {
|
|
23242
23433
|
created_at: {
|
|
23243
23434
|
description: "Date and time at which Seam created the error.",
|
|
@@ -23259,13 +23450,14 @@ var openapi = {
|
|
|
23259
23450
|
type: "array"
|
|
23260
23451
|
},
|
|
23261
23452
|
connected_account_id: {
|
|
23262
|
-
description: "ID of the
|
|
23453
|
+
description: "ID of the connected account associated with the affected access code.",
|
|
23263
23454
|
format: "uuid",
|
|
23264
23455
|
type: "string"
|
|
23265
23456
|
},
|
|
23266
23457
|
connected_account_warnings: {
|
|
23267
23458
|
description: "Warnings associated with the connected account.",
|
|
23268
23459
|
items: {
|
|
23460
|
+
description: "Warning associated with the resource, including the warning code, message, and creation timestamp.",
|
|
23269
23461
|
properties: {
|
|
23270
23462
|
created_at: {
|
|
23271
23463
|
description: "Date and time at which Seam created the warning.",
|
|
@@ -23301,6 +23493,7 @@ var openapi = {
|
|
|
23301
23493
|
device_errors: {
|
|
23302
23494
|
description: "Errors associated with the device.",
|
|
23303
23495
|
items: {
|
|
23496
|
+
description: "Error associated with the resource, including the error code, message, and creation timestamp.",
|
|
23304
23497
|
properties: {
|
|
23305
23498
|
created_at: {
|
|
23306
23499
|
description: "Date and time at which Seam created the error.",
|
|
@@ -23329,6 +23522,7 @@ var openapi = {
|
|
|
23329
23522
|
device_warnings: {
|
|
23330
23523
|
description: "Warnings associated with the device.",
|
|
23331
23524
|
items: {
|
|
23525
|
+
description: "Warning associated with the resource, including the warning code, message, and creation timestamp.",
|
|
23332
23526
|
properties: {
|
|
23333
23527
|
created_at: {
|
|
23334
23528
|
description: "Date and time at which Seam created the warning.",
|
|
@@ -23364,7 +23558,7 @@ var openapi = {
|
|
|
23364
23558
|
type: "string"
|
|
23365
23559
|
},
|
|
23366
23560
|
workspace_id: {
|
|
23367
|
-
description: "ID of the
|
|
23561
|
+
description: "ID of the workspace associated with the event.",
|
|
23368
23562
|
format: "uuid",
|
|
23369
23563
|
type: "string"
|
|
23370
23564
|
}
|
|
@@ -23394,6 +23588,7 @@ var openapi = {
|
|
|
23394
23588
|
access_code_errors: {
|
|
23395
23589
|
description: "Errors associated with the access code.",
|
|
23396
23590
|
items: {
|
|
23591
|
+
description: "Error associated with the resource, including the error code, message, and creation timestamp.",
|
|
23397
23592
|
properties: {
|
|
23398
23593
|
created_at: {
|
|
23399
23594
|
description: "Date and time at which Seam created the error.",
|
|
@@ -23422,6 +23617,7 @@ var openapi = {
|
|
|
23422
23617
|
access_code_warnings: {
|
|
23423
23618
|
description: "Warnings associated with the access code.",
|
|
23424
23619
|
items: {
|
|
23620
|
+
description: "Warning associated with the resource, including the warning code, message, and creation timestamp.",
|
|
23425
23621
|
properties: {
|
|
23426
23622
|
created_at: {
|
|
23427
23623
|
description: "Date and time at which Seam created the warning.",
|
|
@@ -23452,6 +23648,7 @@ var openapi = {
|
|
|
23452
23648
|
connected_account_errors: {
|
|
23453
23649
|
description: "Errors associated with the connected account.",
|
|
23454
23650
|
items: {
|
|
23651
|
+
description: "Error associated with the resource, including the error code, message, and creation timestamp.",
|
|
23455
23652
|
properties: {
|
|
23456
23653
|
created_at: {
|
|
23457
23654
|
description: "Date and time at which Seam created the error.",
|
|
@@ -23473,13 +23670,14 @@ var openapi = {
|
|
|
23473
23670
|
type: "array"
|
|
23474
23671
|
},
|
|
23475
23672
|
connected_account_id: {
|
|
23476
|
-
description: "ID of the
|
|
23673
|
+
description: "ID of the connected account associated with the affected access code.",
|
|
23477
23674
|
format: "uuid",
|
|
23478
23675
|
type: "string"
|
|
23479
23676
|
},
|
|
23480
23677
|
connected_account_warnings: {
|
|
23481
23678
|
description: "Warnings associated with the connected account.",
|
|
23482
23679
|
items: {
|
|
23680
|
+
description: "Warning associated with the resource, including the warning code, message, and creation timestamp.",
|
|
23483
23681
|
properties: {
|
|
23484
23682
|
created_at: {
|
|
23485
23683
|
description: "Date and time at which Seam created the warning.",
|
|
@@ -23515,6 +23713,7 @@ var openapi = {
|
|
|
23515
23713
|
device_errors: {
|
|
23516
23714
|
description: "Errors associated with the device.",
|
|
23517
23715
|
items: {
|
|
23716
|
+
description: "Error associated with the resource, including the error code, message, and creation timestamp.",
|
|
23518
23717
|
properties: {
|
|
23519
23718
|
created_at: {
|
|
23520
23719
|
description: "Date and time at which Seam created the error.",
|
|
@@ -23543,6 +23742,7 @@ var openapi = {
|
|
|
23543
23742
|
device_warnings: {
|
|
23544
23743
|
description: "Warnings associated with the device.",
|
|
23545
23744
|
items: {
|
|
23745
|
+
description: "Warning associated with the resource, including the warning code, message, and creation timestamp.",
|
|
23546
23746
|
properties: {
|
|
23547
23747
|
created_at: {
|
|
23548
23748
|
description: "Date and time at which Seam created the warning.",
|
|
@@ -23578,7 +23778,7 @@ var openapi = {
|
|
|
23578
23778
|
type: "string"
|
|
23579
23779
|
},
|
|
23580
23780
|
workspace_id: {
|
|
23581
|
-
description: "ID of the
|
|
23781
|
+
description: "ID of the workspace associated with the event.",
|
|
23582
23782
|
format: "uuid",
|
|
23583
23783
|
type: "string"
|
|
23584
23784
|
}
|
|
@@ -23623,7 +23823,7 @@ var openapi = {
|
|
|
23623
23823
|
type: "object"
|
|
23624
23824
|
},
|
|
23625
23825
|
connected_account_id: {
|
|
23626
|
-
description: "ID of the
|
|
23826
|
+
description: "ID of the connected account associated with the affected access code.",
|
|
23627
23827
|
format: "uuid",
|
|
23628
23828
|
type: "string"
|
|
23629
23829
|
},
|
|
@@ -23656,7 +23856,7 @@ var openapi = {
|
|
|
23656
23856
|
type: "string"
|
|
23657
23857
|
},
|
|
23658
23858
|
workspace_id: {
|
|
23659
|
-
description: "ID of the
|
|
23859
|
+
description: "ID of the workspace associated with the event.",
|
|
23660
23860
|
format: "uuid",
|
|
23661
23861
|
type: "string"
|
|
23662
23862
|
}
|
|
@@ -23681,6 +23881,7 @@ var openapi = {
|
|
|
23681
23881
|
access_code_errors: {
|
|
23682
23882
|
description: "Errors associated with the access code.",
|
|
23683
23883
|
items: {
|
|
23884
|
+
description: "Error associated with the resource, including the error code, message, and creation timestamp.",
|
|
23684
23885
|
properties: {
|
|
23685
23886
|
created_at: {
|
|
23686
23887
|
description: "Date and time at which Seam created the error.",
|
|
@@ -23709,6 +23910,7 @@ var openapi = {
|
|
|
23709
23910
|
access_code_warnings: {
|
|
23710
23911
|
description: "Warnings associated with the access code.",
|
|
23711
23912
|
items: {
|
|
23913
|
+
description: "Warning associated with the resource, including the warning code, message, and creation timestamp.",
|
|
23712
23914
|
properties: {
|
|
23713
23915
|
created_at: {
|
|
23714
23916
|
description: "Date and time at which Seam created the warning.",
|
|
@@ -23739,6 +23941,7 @@ var openapi = {
|
|
|
23739
23941
|
connected_account_errors: {
|
|
23740
23942
|
description: "Errors associated with the connected account.",
|
|
23741
23943
|
items: {
|
|
23944
|
+
description: "Error associated with the resource, including the error code, message, and creation timestamp.",
|
|
23742
23945
|
properties: {
|
|
23743
23946
|
created_at: {
|
|
23744
23947
|
description: "Date and time at which Seam created the error.",
|
|
@@ -23760,13 +23963,14 @@ var openapi = {
|
|
|
23760
23963
|
type: "array"
|
|
23761
23964
|
},
|
|
23762
23965
|
connected_account_id: {
|
|
23763
|
-
description: "ID of the
|
|
23966
|
+
description: "ID of the connected account associated with the affected access code.",
|
|
23764
23967
|
format: "uuid",
|
|
23765
23968
|
type: "string"
|
|
23766
23969
|
},
|
|
23767
23970
|
connected_account_warnings: {
|
|
23768
23971
|
description: "Warnings associated with the connected account.",
|
|
23769
23972
|
items: {
|
|
23973
|
+
description: "Warning associated with the resource, including the warning code, message, and creation timestamp.",
|
|
23770
23974
|
properties: {
|
|
23771
23975
|
created_at: {
|
|
23772
23976
|
description: "Date and time at which Seam created the warning.",
|
|
@@ -23802,6 +24006,7 @@ var openapi = {
|
|
|
23802
24006
|
device_errors: {
|
|
23803
24007
|
description: "Errors associated with the device.",
|
|
23804
24008
|
items: {
|
|
24009
|
+
description: "Error associated with the resource, including the error code, message, and creation timestamp.",
|
|
23805
24010
|
properties: {
|
|
23806
24011
|
created_at: {
|
|
23807
24012
|
description: "Date and time at which Seam created the error.",
|
|
@@ -23830,6 +24035,7 @@ var openapi = {
|
|
|
23830
24035
|
device_warnings: {
|
|
23831
24036
|
description: "Warnings associated with the device.",
|
|
23832
24037
|
items: {
|
|
24038
|
+
description: "Warning associated with the resource, including the warning code, message, and creation timestamp.",
|
|
23833
24039
|
properties: {
|
|
23834
24040
|
created_at: {
|
|
23835
24041
|
description: "Date and time at which Seam created the warning.",
|
|
@@ -23865,7 +24071,7 @@ var openapi = {
|
|
|
23865
24071
|
type: "string"
|
|
23866
24072
|
},
|
|
23867
24073
|
workspace_id: {
|
|
23868
|
-
description: "ID of the
|
|
24074
|
+
description: "ID of the workspace associated with the event.",
|
|
23869
24075
|
format: "uuid",
|
|
23870
24076
|
type: "string"
|
|
23871
24077
|
}
|
|
@@ -23895,6 +24101,7 @@ var openapi = {
|
|
|
23895
24101
|
access_code_errors: {
|
|
23896
24102
|
description: "Errors associated with the access code.",
|
|
23897
24103
|
items: {
|
|
24104
|
+
description: "Error associated with the resource, including the error code, message, and creation timestamp.",
|
|
23898
24105
|
properties: {
|
|
23899
24106
|
created_at: {
|
|
23900
24107
|
description: "Date and time at which Seam created the error.",
|
|
@@ -23923,6 +24130,7 @@ var openapi = {
|
|
|
23923
24130
|
access_code_warnings: {
|
|
23924
24131
|
description: "Warnings associated with the access code.",
|
|
23925
24132
|
items: {
|
|
24133
|
+
description: "Warning associated with the resource, including the warning code, message, and creation timestamp.",
|
|
23926
24134
|
properties: {
|
|
23927
24135
|
created_at: {
|
|
23928
24136
|
description: "Date and time at which Seam created the warning.",
|
|
@@ -23953,6 +24161,7 @@ var openapi = {
|
|
|
23953
24161
|
connected_account_errors: {
|
|
23954
24162
|
description: "Errors associated with the connected account.",
|
|
23955
24163
|
items: {
|
|
24164
|
+
description: "Error associated with the resource, including the error code, message, and creation timestamp.",
|
|
23956
24165
|
properties: {
|
|
23957
24166
|
created_at: {
|
|
23958
24167
|
description: "Date and time at which Seam created the error.",
|
|
@@ -23974,13 +24183,14 @@ var openapi = {
|
|
|
23974
24183
|
type: "array"
|
|
23975
24184
|
},
|
|
23976
24185
|
connected_account_id: {
|
|
23977
|
-
description: "ID of the
|
|
24186
|
+
description: "ID of the connected account associated with the affected access code.",
|
|
23978
24187
|
format: "uuid",
|
|
23979
24188
|
type: "string"
|
|
23980
24189
|
},
|
|
23981
24190
|
connected_account_warnings: {
|
|
23982
24191
|
description: "Warnings associated with the connected account.",
|
|
23983
24192
|
items: {
|
|
24193
|
+
description: "Warning associated with the resource, including the warning code, message, and creation timestamp.",
|
|
23984
24194
|
properties: {
|
|
23985
24195
|
created_at: {
|
|
23986
24196
|
description: "Date and time at which Seam created the warning.",
|
|
@@ -24016,6 +24226,7 @@ var openapi = {
|
|
|
24016
24226
|
device_errors: {
|
|
24017
24227
|
description: "Errors associated with the device.",
|
|
24018
24228
|
items: {
|
|
24229
|
+
description: "Error associated with the resource, including the error code, message, and creation timestamp.",
|
|
24019
24230
|
properties: {
|
|
24020
24231
|
created_at: {
|
|
24021
24232
|
description: "Date and time at which Seam created the error.",
|
|
@@ -24044,6 +24255,7 @@ var openapi = {
|
|
|
24044
24255
|
device_warnings: {
|
|
24045
24256
|
description: "Warnings associated with the device.",
|
|
24046
24257
|
items: {
|
|
24258
|
+
description: "Warning associated with the resource, including the warning code, message, and creation timestamp.",
|
|
24047
24259
|
properties: {
|
|
24048
24260
|
created_at: {
|
|
24049
24261
|
description: "Date and time at which Seam created the warning.",
|
|
@@ -24079,7 +24291,7 @@ var openapi = {
|
|
|
24079
24291
|
type: "string"
|
|
24080
24292
|
},
|
|
24081
24293
|
workspace_id: {
|
|
24082
|
-
description: "ID of the
|
|
24294
|
+
description: "ID of the workspace associated with the event.",
|
|
24083
24295
|
format: "uuid",
|
|
24084
24296
|
type: "string"
|
|
24085
24297
|
}
|
|
@@ -24119,7 +24331,7 @@ var openapi = {
|
|
|
24119
24331
|
type: "object"
|
|
24120
24332
|
},
|
|
24121
24333
|
connected_account_id: {
|
|
24122
|
-
description: "ID of the
|
|
24334
|
+
description: "ID of the connected account associated with the affected access code.",
|
|
24123
24335
|
format: "uuid",
|
|
24124
24336
|
type: "string"
|
|
24125
24337
|
},
|
|
@@ -24155,7 +24367,7 @@ var openapi = {
|
|
|
24155
24367
|
type: "string"
|
|
24156
24368
|
},
|
|
24157
24369
|
workspace_id: {
|
|
24158
|
-
description: "ID of the
|
|
24370
|
+
description: "ID of the workspace associated with the event.",
|
|
24159
24371
|
format: "uuid",
|
|
24160
24372
|
type: "string"
|
|
24161
24373
|
}
|
|
@@ -24189,7 +24401,7 @@ var openapi = {
|
|
|
24189
24401
|
type: "object"
|
|
24190
24402
|
},
|
|
24191
24403
|
connected_account_id: {
|
|
24192
|
-
description: "ID of the
|
|
24404
|
+
description: "ID of the connected account associated with the affected access code.",
|
|
24193
24405
|
format: "uuid",
|
|
24194
24406
|
type: "string"
|
|
24195
24407
|
},
|
|
@@ -24225,7 +24437,7 @@ var openapi = {
|
|
|
24225
24437
|
type: "string"
|
|
24226
24438
|
},
|
|
24227
24439
|
workspace_id: {
|
|
24228
|
-
description: "ID of the
|
|
24440
|
+
description: "ID of the workspace associated with the event.",
|
|
24229
24441
|
format: "uuid",
|
|
24230
24442
|
type: "string"
|
|
24231
24443
|
}
|
|
@@ -24251,7 +24463,10 @@ var openapi = {
|
|
|
24251
24463
|
format: "uuid",
|
|
24252
24464
|
type: "string"
|
|
24253
24465
|
},
|
|
24254
|
-
backup_access_code_id: {
|
|
24466
|
+
backup_access_code_id: {
|
|
24467
|
+
description: "ID of the backup access code that was pulled from the pool.",
|
|
24468
|
+
type: "string"
|
|
24469
|
+
},
|
|
24255
24470
|
connected_account_custom_metadata: {
|
|
24256
24471
|
additionalProperties: {
|
|
24257
24472
|
oneOf: [{ type: "string" }, { type: "boolean" }]
|
|
@@ -24260,7 +24475,7 @@ var openapi = {
|
|
|
24260
24475
|
type: "object"
|
|
24261
24476
|
},
|
|
24262
24477
|
connected_account_id: {
|
|
24263
|
-
description: "ID of the
|
|
24478
|
+
description: "ID of the connected account associated with the affected access code.",
|
|
24264
24479
|
format: "uuid",
|
|
24265
24480
|
type: "string"
|
|
24266
24481
|
},
|
|
@@ -24296,7 +24511,7 @@ var openapi = {
|
|
|
24296
24511
|
type: "string"
|
|
24297
24512
|
},
|
|
24298
24513
|
workspace_id: {
|
|
24299
|
-
description: "ID of the
|
|
24514
|
+
description: "ID of the workspace associated with the event.",
|
|
24300
24515
|
format: "uuid",
|
|
24301
24516
|
type: "string"
|
|
24302
24517
|
}
|
|
@@ -24331,7 +24546,7 @@ var openapi = {
|
|
|
24331
24546
|
type: "object"
|
|
24332
24547
|
},
|
|
24333
24548
|
connected_account_id: {
|
|
24334
|
-
description: "ID of the
|
|
24549
|
+
description: "ID of the connected account associated with the affected access code.",
|
|
24335
24550
|
format: "uuid",
|
|
24336
24551
|
type: "string"
|
|
24337
24552
|
},
|
|
@@ -24367,7 +24582,7 @@ var openapi = {
|
|
|
24367
24582
|
type: "string"
|
|
24368
24583
|
},
|
|
24369
24584
|
workspace_id: {
|
|
24370
|
-
description: "ID of the
|
|
24585
|
+
description: "ID of the workspace associated with the event.",
|
|
24371
24586
|
format: "uuid",
|
|
24372
24587
|
type: "string"
|
|
24373
24588
|
}
|
|
@@ -24391,6 +24606,7 @@ var openapi = {
|
|
|
24391
24606
|
access_code_errors: {
|
|
24392
24607
|
description: "Errors associated with the access code.",
|
|
24393
24608
|
items: {
|
|
24609
|
+
description: "Error associated with the resource, including the error code, message, and creation timestamp.",
|
|
24394
24610
|
properties: {
|
|
24395
24611
|
created_at: {
|
|
24396
24612
|
description: "Date and time at which Seam created the error.",
|
|
@@ -24419,6 +24635,7 @@ var openapi = {
|
|
|
24419
24635
|
access_code_warnings: {
|
|
24420
24636
|
description: "Warnings associated with the access code.",
|
|
24421
24637
|
items: {
|
|
24638
|
+
description: "Warning associated with the resource, including the warning code, message, and creation timestamp.",
|
|
24422
24639
|
properties: {
|
|
24423
24640
|
created_at: {
|
|
24424
24641
|
description: "Date and time at which Seam created the warning.",
|
|
@@ -24449,6 +24666,7 @@ var openapi = {
|
|
|
24449
24666
|
connected_account_errors: {
|
|
24450
24667
|
description: "Errors associated with the connected account.",
|
|
24451
24668
|
items: {
|
|
24669
|
+
description: "Error associated with the resource, including the error code, message, and creation timestamp.",
|
|
24452
24670
|
properties: {
|
|
24453
24671
|
created_at: {
|
|
24454
24672
|
description: "Date and time at which Seam created the error.",
|
|
@@ -24470,13 +24688,14 @@ var openapi = {
|
|
|
24470
24688
|
type: "array"
|
|
24471
24689
|
},
|
|
24472
24690
|
connected_account_id: {
|
|
24473
|
-
description: "ID of the
|
|
24691
|
+
description: "ID of the connected account associated with the affected access code.",
|
|
24474
24692
|
format: "uuid",
|
|
24475
24693
|
type: "string"
|
|
24476
24694
|
},
|
|
24477
24695
|
connected_account_warnings: {
|
|
24478
24696
|
description: "Warnings associated with the connected account.",
|
|
24479
24697
|
items: {
|
|
24698
|
+
description: "Warning associated with the resource, including the warning code, message, and creation timestamp.",
|
|
24480
24699
|
properties: {
|
|
24481
24700
|
created_at: {
|
|
24482
24701
|
description: "Date and time at which Seam created the warning.",
|
|
@@ -24512,6 +24731,7 @@ var openapi = {
|
|
|
24512
24731
|
device_errors: {
|
|
24513
24732
|
description: "Errors associated with the device.",
|
|
24514
24733
|
items: {
|
|
24734
|
+
description: "Error associated with the resource, including the error code, message, and creation timestamp.",
|
|
24515
24735
|
properties: {
|
|
24516
24736
|
created_at: {
|
|
24517
24737
|
description: "Date and time at which Seam created the error.",
|
|
@@ -24540,6 +24760,7 @@ var openapi = {
|
|
|
24540
24760
|
device_warnings: {
|
|
24541
24761
|
description: "Warnings associated with the device.",
|
|
24542
24762
|
items: {
|
|
24763
|
+
description: "Warning associated with the resource, including the warning code, message, and creation timestamp.",
|
|
24543
24764
|
properties: {
|
|
24544
24765
|
created_at: {
|
|
24545
24766
|
description: "Date and time at which Seam created the warning.",
|
|
@@ -24575,7 +24796,7 @@ var openapi = {
|
|
|
24575
24796
|
type: "string"
|
|
24576
24797
|
},
|
|
24577
24798
|
workspace_id: {
|
|
24578
|
-
description: "ID of the
|
|
24799
|
+
description: "ID of the workspace associated with the event.",
|
|
24579
24800
|
format: "uuid",
|
|
24580
24801
|
type: "string"
|
|
24581
24802
|
}
|
|
@@ -24615,7 +24836,7 @@ var openapi = {
|
|
|
24615
24836
|
type: "object"
|
|
24616
24837
|
},
|
|
24617
24838
|
connected_account_id: {
|
|
24618
|
-
description: "ID of the
|
|
24839
|
+
description: "ID of the connected account associated with the affected access code.",
|
|
24619
24840
|
format: "uuid",
|
|
24620
24841
|
type: "string"
|
|
24621
24842
|
},
|
|
@@ -24651,7 +24872,7 @@ var openapi = {
|
|
|
24651
24872
|
type: "string"
|
|
24652
24873
|
},
|
|
24653
24874
|
workspace_id: {
|
|
24654
|
-
description: "ID of the
|
|
24875
|
+
description: "ID of the workspace associated with the event.",
|
|
24655
24876
|
format: "uuid",
|
|
24656
24877
|
type: "string"
|
|
24657
24878
|
}
|
|
@@ -24685,7 +24906,7 @@ var openapi = {
|
|
|
24685
24906
|
type: "object"
|
|
24686
24907
|
},
|
|
24687
24908
|
connected_account_id: {
|
|
24688
|
-
description: "ID of the
|
|
24909
|
+
description: "ID of the connected account associated with the affected access code.",
|
|
24689
24910
|
format: "uuid",
|
|
24690
24911
|
type: "string"
|
|
24691
24912
|
},
|
|
@@ -24721,7 +24942,7 @@ var openapi = {
|
|
|
24721
24942
|
type: "string"
|
|
24722
24943
|
},
|
|
24723
24944
|
workspace_id: {
|
|
24724
|
-
description: "ID of the
|
|
24945
|
+
description: "ID of the workspace associated with the event.",
|
|
24725
24946
|
format: "uuid",
|
|
24726
24947
|
type: "string"
|
|
24727
24948
|
}
|
|
@@ -24764,7 +24985,7 @@ var openapi = {
|
|
|
24764
24985
|
type: "string"
|
|
24765
24986
|
},
|
|
24766
24987
|
workspace_id: {
|
|
24767
|
-
description: "ID of the
|
|
24988
|
+
description: "ID of the workspace associated with the event.",
|
|
24768
24989
|
format: "uuid",
|
|
24769
24990
|
type: "string"
|
|
24770
24991
|
}
|
|
@@ -24805,7 +25026,7 @@ var openapi = {
|
|
|
24805
25026
|
type: "string"
|
|
24806
25027
|
},
|
|
24807
25028
|
workspace_id: {
|
|
24808
|
-
description: "ID of the
|
|
25029
|
+
description: "ID of the workspace associated with the event.",
|
|
24809
25030
|
format: "uuid",
|
|
24810
25031
|
type: "string"
|
|
24811
25032
|
}
|
|
@@ -24849,7 +25070,7 @@ var openapi = {
|
|
|
24849
25070
|
type: "string"
|
|
24850
25071
|
},
|
|
24851
25072
|
workspace_id: {
|
|
24852
|
-
description: "ID of the
|
|
25073
|
+
description: "ID of the workspace associated with the event.",
|
|
24853
25074
|
format: "uuid",
|
|
24854
25075
|
type: "string"
|
|
24855
25076
|
}
|
|
@@ -24898,7 +25119,7 @@ var openapi = {
|
|
|
24898
25119
|
type: "string"
|
|
24899
25120
|
},
|
|
24900
25121
|
workspace_id: {
|
|
24901
|
-
description: "ID of the
|
|
25122
|
+
description: "ID of the workspace associated with the event.",
|
|
24902
25123
|
format: "uuid",
|
|
24903
25124
|
type: "string"
|
|
24904
25125
|
}
|
|
@@ -24948,7 +25169,7 @@ var openapi = {
|
|
|
24948
25169
|
type: "string"
|
|
24949
25170
|
},
|
|
24950
25171
|
workspace_id: {
|
|
24951
|
-
description: "ID of the
|
|
25172
|
+
description: "ID of the workspace associated with the event.",
|
|
24952
25173
|
format: "uuid",
|
|
24953
25174
|
type: "string"
|
|
24954
25175
|
}
|
|
@@ -25005,7 +25226,7 @@ var openapi = {
|
|
|
25005
25226
|
type: "string"
|
|
25006
25227
|
},
|
|
25007
25228
|
workspace_id: {
|
|
25008
|
-
description: "ID of the
|
|
25229
|
+
description: "ID of the workspace associated with the event.",
|
|
25009
25230
|
format: "uuid",
|
|
25010
25231
|
type: "string"
|
|
25011
25232
|
}
|
|
@@ -25060,7 +25281,7 @@ var openapi = {
|
|
|
25060
25281
|
type: "string"
|
|
25061
25282
|
},
|
|
25062
25283
|
workspace_id: {
|
|
25063
|
-
description: "ID of the
|
|
25284
|
+
description: "ID of the workspace associated with the event.",
|
|
25064
25285
|
format: "uuid",
|
|
25065
25286
|
type: "string"
|
|
25066
25287
|
}
|
|
@@ -25120,7 +25341,7 @@ var openapi = {
|
|
|
25120
25341
|
type: "string"
|
|
25121
25342
|
},
|
|
25122
25343
|
workspace_id: {
|
|
25123
|
-
description: "ID of the
|
|
25344
|
+
description: "ID of the workspace associated with the event.",
|
|
25124
25345
|
format: "uuid",
|
|
25125
25346
|
type: "string"
|
|
25126
25347
|
}
|
|
@@ -25172,7 +25393,7 @@ var openapi = {
|
|
|
25172
25393
|
type: "string"
|
|
25173
25394
|
},
|
|
25174
25395
|
workspace_id: {
|
|
25175
|
-
description: "ID of the
|
|
25396
|
+
description: "ID of the workspace associated with the event.",
|
|
25176
25397
|
format: "uuid",
|
|
25177
25398
|
type: "string"
|
|
25178
25399
|
}
|
|
@@ -25227,7 +25448,7 @@ var openapi = {
|
|
|
25227
25448
|
type: "string"
|
|
25228
25449
|
},
|
|
25229
25450
|
workspace_id: {
|
|
25230
|
-
description: "ID of the
|
|
25451
|
+
description: "ID of the workspace associated with the event.",
|
|
25231
25452
|
format: "uuid",
|
|
25232
25453
|
type: "string"
|
|
25233
25454
|
}
|
|
@@ -25279,7 +25500,7 @@ var openapi = {
|
|
|
25279
25500
|
type: "string"
|
|
25280
25501
|
},
|
|
25281
25502
|
workspace_id: {
|
|
25282
|
-
description: "ID of the
|
|
25503
|
+
description: "ID of the workspace associated with the event.",
|
|
25283
25504
|
format: "uuid",
|
|
25284
25505
|
type: "string"
|
|
25285
25506
|
}
|
|
@@ -25339,7 +25560,7 @@ var openapi = {
|
|
|
25339
25560
|
type: "string"
|
|
25340
25561
|
},
|
|
25341
25562
|
workspace_id: {
|
|
25342
|
-
description: "ID of the
|
|
25563
|
+
description: "ID of the workspace associated with the event.",
|
|
25343
25564
|
format: "uuid",
|
|
25344
25565
|
type: "string"
|
|
25345
25566
|
}
|
|
@@ -25391,7 +25612,7 @@ var openapi = {
|
|
|
25391
25612
|
type: "string"
|
|
25392
25613
|
},
|
|
25393
25614
|
workspace_id: {
|
|
25394
|
-
description: "ID of the
|
|
25615
|
+
description: "ID of the workspace associated with the event.",
|
|
25395
25616
|
format: "uuid",
|
|
25396
25617
|
type: "string"
|
|
25397
25618
|
}
|
|
@@ -25438,7 +25659,7 @@ var openapi = {
|
|
|
25438
25659
|
type: "string"
|
|
25439
25660
|
},
|
|
25440
25661
|
workspace_id: {
|
|
25441
|
-
description: "ID of the
|
|
25662
|
+
description: "ID of the workspace associated with the event.",
|
|
25442
25663
|
format: "uuid",
|
|
25443
25664
|
type: "string"
|
|
25444
25665
|
}
|
|
@@ -25484,7 +25705,7 @@ var openapi = {
|
|
|
25484
25705
|
type: "string"
|
|
25485
25706
|
},
|
|
25486
25707
|
workspace_id: {
|
|
25487
|
-
description: "ID of the
|
|
25708
|
+
description: "ID of the workspace associated with the event.",
|
|
25488
25709
|
format: "uuid",
|
|
25489
25710
|
type: "string"
|
|
25490
25711
|
}
|
|
@@ -25506,6 +25727,7 @@ var openapi = {
|
|
|
25506
25727
|
acs_system_errors: {
|
|
25507
25728
|
description: "Errors associated with the access control system.",
|
|
25508
25729
|
items: {
|
|
25730
|
+
description: "Error associated with the resource, including the error code, message, and creation timestamp.",
|
|
25509
25731
|
properties: {
|
|
25510
25732
|
created_at: {
|
|
25511
25733
|
description: "Date and time at which Seam created the error.",
|
|
@@ -25534,6 +25756,7 @@ var openapi = {
|
|
|
25534
25756
|
acs_system_warnings: {
|
|
25535
25757
|
description: "Warnings associated with the access control system.",
|
|
25536
25758
|
items: {
|
|
25759
|
+
description: "Warning associated with the resource, including the warning code, message, and creation timestamp.",
|
|
25537
25760
|
properties: {
|
|
25538
25761
|
created_at: {
|
|
25539
25762
|
description: "Date and time at which Seam created the warning.",
|
|
@@ -25557,6 +25780,7 @@ var openapi = {
|
|
|
25557
25780
|
connected_account_errors: {
|
|
25558
25781
|
description: "Errors associated with the connected account.",
|
|
25559
25782
|
items: {
|
|
25783
|
+
description: "Error associated with the resource, including the error code, message, and creation timestamp.",
|
|
25560
25784
|
properties: {
|
|
25561
25785
|
created_at: {
|
|
25562
25786
|
description: "Date and time at which Seam created the error.",
|
|
@@ -25585,6 +25809,7 @@ var openapi = {
|
|
|
25585
25809
|
connected_account_warnings: {
|
|
25586
25810
|
description: "Warnings associated with the connected account.",
|
|
25587
25811
|
items: {
|
|
25812
|
+
description: "Warning associated with the resource, including the warning code, message, and creation timestamp.",
|
|
25588
25813
|
properties: {
|
|
25589
25814
|
created_at: {
|
|
25590
25815
|
description: "Date and time at which Seam created the warning.",
|
|
@@ -25622,7 +25847,7 @@ var openapi = {
|
|
|
25622
25847
|
type: "string"
|
|
25623
25848
|
},
|
|
25624
25849
|
workspace_id: {
|
|
25625
|
-
description: "ID of the
|
|
25850
|
+
description: "ID of the workspace associated with the event.",
|
|
25626
25851
|
format: "uuid",
|
|
25627
25852
|
type: "string"
|
|
25628
25853
|
}
|
|
@@ -25677,7 +25902,7 @@ var openapi = {
|
|
|
25677
25902
|
type: "string"
|
|
25678
25903
|
},
|
|
25679
25904
|
workspace_id: {
|
|
25680
|
-
description: "ID of the
|
|
25905
|
+
description: "ID of the workspace associated with the event.",
|
|
25681
25906
|
format: "uuid",
|
|
25682
25907
|
type: "string"
|
|
25683
25908
|
}
|
|
@@ -25729,7 +25954,7 @@ var openapi = {
|
|
|
25729
25954
|
type: "string"
|
|
25730
25955
|
},
|
|
25731
25956
|
workspace_id: {
|
|
25732
|
-
description: "ID of the
|
|
25957
|
+
description: "ID of the workspace associated with the event.",
|
|
25733
25958
|
format: "uuid",
|
|
25734
25959
|
type: "string"
|
|
25735
25960
|
}
|
|
@@ -25781,7 +26006,7 @@ var openapi = {
|
|
|
25781
26006
|
type: "string"
|
|
25782
26007
|
},
|
|
25783
26008
|
workspace_id: {
|
|
25784
|
-
description: "ID of the
|
|
26009
|
+
description: "ID of the workspace associated with the event.",
|
|
25785
26010
|
format: "uuid",
|
|
25786
26011
|
type: "string"
|
|
25787
26012
|
}
|
|
@@ -25836,7 +26061,7 @@ var openapi = {
|
|
|
25836
26061
|
type: "string"
|
|
25837
26062
|
},
|
|
25838
26063
|
workspace_id: {
|
|
25839
|
-
description: "ID of the
|
|
26064
|
+
description: "ID of the workspace associated with the event.",
|
|
25840
26065
|
format: "uuid",
|
|
25841
26066
|
type: "string"
|
|
25842
26067
|
}
|
|
@@ -25861,7 +26086,11 @@ var openapi = {
|
|
|
25861
26086
|
format: "uuid",
|
|
25862
26087
|
type: "string"
|
|
25863
26088
|
},
|
|
25864
|
-
acs_user_id: {
|
|
26089
|
+
acs_user_id: {
|
|
26090
|
+
description: "ID of the affected access system user.",
|
|
26091
|
+
format: "uuid",
|
|
26092
|
+
type: "string"
|
|
26093
|
+
},
|
|
25865
26094
|
connected_account_id: {
|
|
25866
26095
|
description: "ID of the connected account.",
|
|
25867
26096
|
format: "uuid",
|
|
@@ -25884,7 +26113,7 @@ var openapi = {
|
|
|
25884
26113
|
type: "string"
|
|
25885
26114
|
},
|
|
25886
26115
|
workspace_id: {
|
|
25887
|
-
description: "ID of the
|
|
26116
|
+
description: "ID of the workspace associated with the event.",
|
|
25888
26117
|
format: "uuid",
|
|
25889
26118
|
type: "string"
|
|
25890
26119
|
}
|
|
@@ -25909,7 +26138,11 @@ var openapi = {
|
|
|
25909
26138
|
format: "uuid",
|
|
25910
26139
|
type: "string"
|
|
25911
26140
|
},
|
|
25912
|
-
acs_user_id: {
|
|
26141
|
+
acs_user_id: {
|
|
26142
|
+
description: "ID of the affected access system user.",
|
|
26143
|
+
format: "uuid",
|
|
26144
|
+
type: "string"
|
|
26145
|
+
},
|
|
25913
26146
|
connected_account_id: {
|
|
25914
26147
|
description: "ID of the connected account.",
|
|
25915
26148
|
format: "uuid",
|
|
@@ -25932,7 +26165,7 @@ var openapi = {
|
|
|
25932
26165
|
type: "string"
|
|
25933
26166
|
},
|
|
25934
26167
|
workspace_id: {
|
|
25935
|
-
description: "ID of the
|
|
26168
|
+
description: "ID of the workspace associated with the event.",
|
|
25936
26169
|
format: "uuid",
|
|
25937
26170
|
type: "string"
|
|
25938
26171
|
}
|
|
@@ -25984,7 +26217,7 @@ var openapi = {
|
|
|
25984
26217
|
type: "string"
|
|
25985
26218
|
},
|
|
25986
26219
|
workspace_id: {
|
|
25987
|
-
description: "ID of the
|
|
26220
|
+
description: "ID of the workspace associated with the event.",
|
|
25988
26221
|
format: "uuid",
|
|
25989
26222
|
type: "string"
|
|
25990
26223
|
}
|
|
@@ -26036,7 +26269,7 @@ var openapi = {
|
|
|
26036
26269
|
type: "string"
|
|
26037
26270
|
},
|
|
26038
26271
|
workspace_id: {
|
|
26039
|
-
description: "ID of the
|
|
26272
|
+
description: "ID of the workspace associated with the event.",
|
|
26040
26273
|
format: "uuid",
|
|
26041
26274
|
type: "string"
|
|
26042
26275
|
}
|
|
@@ -26091,7 +26324,7 @@ var openapi = {
|
|
|
26091
26324
|
type: "string"
|
|
26092
26325
|
},
|
|
26093
26326
|
workspace_id: {
|
|
26094
|
-
description: "ID of the
|
|
26327
|
+
description: "ID of the workspace associated with the event.",
|
|
26095
26328
|
format: "uuid",
|
|
26096
26329
|
type: "string"
|
|
26097
26330
|
}
|
|
@@ -26111,7 +26344,11 @@ var openapi = {
|
|
|
26111
26344
|
{
|
|
26112
26345
|
description: "An [access system entrance](https://docs.seam.co/low-level-apis/access-systems/retrieving-entrance-details) was added.",
|
|
26113
26346
|
properties: {
|
|
26114
|
-
acs_entrance_id: {
|
|
26347
|
+
acs_entrance_id: {
|
|
26348
|
+
description: "ID of the affected entrance.",
|
|
26349
|
+
format: "uuid",
|
|
26350
|
+
type: "string"
|
|
26351
|
+
},
|
|
26115
26352
|
acs_system_id: {
|
|
26116
26353
|
description: "ID of the access system.",
|
|
26117
26354
|
format: "uuid",
|
|
@@ -26139,7 +26376,7 @@ var openapi = {
|
|
|
26139
26376
|
type: "string"
|
|
26140
26377
|
},
|
|
26141
26378
|
workspace_id: {
|
|
26142
|
-
description: "ID of the
|
|
26379
|
+
description: "ID of the workspace associated with the event.",
|
|
26143
26380
|
format: "uuid",
|
|
26144
26381
|
type: "string"
|
|
26145
26382
|
}
|
|
@@ -26159,7 +26396,11 @@ var openapi = {
|
|
|
26159
26396
|
{
|
|
26160
26397
|
description: "An [access system entrance](https://docs.seam.co/low-level-apis/access-systems/retrieving-entrance-details) was removed.",
|
|
26161
26398
|
properties: {
|
|
26162
|
-
acs_entrance_id: {
|
|
26399
|
+
acs_entrance_id: {
|
|
26400
|
+
description: "ID of the affected entrance.",
|
|
26401
|
+
format: "uuid",
|
|
26402
|
+
type: "string"
|
|
26403
|
+
},
|
|
26163
26404
|
acs_system_id: {
|
|
26164
26405
|
description: "ID of the access system.",
|
|
26165
26406
|
format: "uuid",
|
|
@@ -26187,7 +26428,7 @@ var openapi = {
|
|
|
26187
26428
|
type: "string"
|
|
26188
26429
|
},
|
|
26189
26430
|
workspace_id: {
|
|
26190
|
-
description: "ID of the
|
|
26431
|
+
description: "ID of the workspace associated with the event.",
|
|
26191
26432
|
format: "uuid",
|
|
26192
26433
|
type: "string"
|
|
26193
26434
|
}
|
|
@@ -26205,7 +26446,7 @@ var openapi = {
|
|
|
26205
26446
|
"x-route-path": "/acs/entrances"
|
|
26206
26447
|
},
|
|
26207
26448
|
{
|
|
26208
|
-
description: "A
|
|
26449
|
+
description: "A client session was deleted.",
|
|
26209
26450
|
properties: {
|
|
26210
26451
|
client_session_id: {
|
|
26211
26452
|
description: "ID of the affected client session.",
|
|
@@ -26229,7 +26470,7 @@ var openapi = {
|
|
|
26229
26470
|
type: "string"
|
|
26230
26471
|
},
|
|
26231
26472
|
workspace_id: {
|
|
26232
|
-
description: "ID of the
|
|
26473
|
+
description: "ID of the workspace associated with the event.",
|
|
26233
26474
|
format: "uuid",
|
|
26234
26475
|
type: "string"
|
|
26235
26476
|
}
|
|
@@ -26246,10 +26487,10 @@ var openapi = {
|
|
|
26246
26487
|
"x-route-path": "/client_sessions"
|
|
26247
26488
|
},
|
|
26248
26489
|
{
|
|
26249
|
-
description: "A
|
|
26490
|
+
description: "A connected account was connected for the first time or was reconnected after being disconnected.",
|
|
26250
26491
|
properties: {
|
|
26251
26492
|
connect_webview_id: {
|
|
26252
|
-
description: "ID of the
|
|
26493
|
+
description: "ID of the Connect Webview associated with the event.",
|
|
26253
26494
|
format: "uuid",
|
|
26254
26495
|
type: "string"
|
|
26255
26496
|
},
|
|
@@ -26261,7 +26502,7 @@ var openapi = {
|
|
|
26261
26502
|
type: "object"
|
|
26262
26503
|
},
|
|
26263
26504
|
connected_account_id: {
|
|
26264
|
-
description: "ID of the affected
|
|
26505
|
+
description: "ID of the affected connected account.",
|
|
26265
26506
|
format: "uuid",
|
|
26266
26507
|
type: "string"
|
|
26267
26508
|
},
|
|
@@ -26289,7 +26530,7 @@ var openapi = {
|
|
|
26289
26530
|
type: "string"
|
|
26290
26531
|
},
|
|
26291
26532
|
workspace_id: {
|
|
26292
|
-
description: "ID of the
|
|
26533
|
+
description: "ID of the workspace associated with the event.",
|
|
26293
26534
|
format: "uuid",
|
|
26294
26535
|
type: "string"
|
|
26295
26536
|
}
|
|
@@ -26306,10 +26547,10 @@ var openapi = {
|
|
|
26306
26547
|
"x-route-path": "/connected_accounts"
|
|
26307
26548
|
},
|
|
26308
26549
|
{
|
|
26309
|
-
description: "A
|
|
26550
|
+
description: "A connected account was created.",
|
|
26310
26551
|
properties: {
|
|
26311
26552
|
connect_webview_id: {
|
|
26312
|
-
description: "ID of the
|
|
26553
|
+
description: "ID of the Connect Webview associated with the event.",
|
|
26313
26554
|
format: "uuid",
|
|
26314
26555
|
type: "string"
|
|
26315
26556
|
},
|
|
@@ -26321,7 +26562,7 @@ var openapi = {
|
|
|
26321
26562
|
type: "object"
|
|
26322
26563
|
},
|
|
26323
26564
|
connected_account_id: {
|
|
26324
|
-
description: "ID of the affected
|
|
26565
|
+
description: "ID of the affected connected account.",
|
|
26325
26566
|
format: "uuid",
|
|
26326
26567
|
type: "string"
|
|
26327
26568
|
},
|
|
@@ -26345,7 +26586,7 @@ var openapi = {
|
|
|
26345
26586
|
type: "string"
|
|
26346
26587
|
},
|
|
26347
26588
|
workspace_id: {
|
|
26348
|
-
description: "ID of the
|
|
26589
|
+
description: "ID of the workspace associated with the event.",
|
|
26349
26590
|
format: "uuid",
|
|
26350
26591
|
type: "string"
|
|
26351
26592
|
}
|
|
@@ -26364,10 +26605,10 @@ var openapi = {
|
|
|
26364
26605
|
},
|
|
26365
26606
|
{
|
|
26366
26607
|
deprecated: true,
|
|
26367
|
-
description: "A
|
|
26608
|
+
description: "A connected account had a successful login using a Connect Webview.",
|
|
26368
26609
|
properties: {
|
|
26369
26610
|
connect_webview_id: {
|
|
26370
|
-
description: "ID of the
|
|
26611
|
+
description: "ID of the Connect Webview associated with the event.",
|
|
26371
26612
|
format: "uuid",
|
|
26372
26613
|
type: "string"
|
|
26373
26614
|
},
|
|
@@ -26379,7 +26620,7 @@ var openapi = {
|
|
|
26379
26620
|
type: "object"
|
|
26380
26621
|
},
|
|
26381
26622
|
connected_account_id: {
|
|
26382
|
-
description: "ID of the affected
|
|
26623
|
+
description: "ID of the affected connected account.",
|
|
26383
26624
|
format: "uuid",
|
|
26384
26625
|
type: "string"
|
|
26385
26626
|
},
|
|
@@ -26403,7 +26644,7 @@ var openapi = {
|
|
|
26403
26644
|
type: "string"
|
|
26404
26645
|
},
|
|
26405
26646
|
workspace_id: {
|
|
26406
|
-
description: "ID of the
|
|
26647
|
+
description: "ID of the workspace associated with the event.",
|
|
26407
26648
|
format: "uuid",
|
|
26408
26649
|
type: "string"
|
|
26409
26650
|
}
|
|
@@ -26422,7 +26663,7 @@ var openapi = {
|
|
|
26422
26663
|
"x-route-path": "/connected_accounts"
|
|
26423
26664
|
},
|
|
26424
26665
|
{
|
|
26425
|
-
description: "A
|
|
26666
|
+
description: "A connected account was disconnected.",
|
|
26426
26667
|
properties: {
|
|
26427
26668
|
connected_account_custom_metadata: {
|
|
26428
26669
|
additionalProperties: {
|
|
@@ -26434,6 +26675,7 @@ var openapi = {
|
|
|
26434
26675
|
connected_account_errors: {
|
|
26435
26676
|
description: "Errors associated with the connected account.",
|
|
26436
26677
|
items: {
|
|
26678
|
+
description: "Error associated with the resource, including the error code, message, and creation timestamp.",
|
|
26437
26679
|
properties: {
|
|
26438
26680
|
created_at: {
|
|
26439
26681
|
description: "Date and time at which Seam created the error.",
|
|
@@ -26455,13 +26697,14 @@ var openapi = {
|
|
|
26455
26697
|
type: "array"
|
|
26456
26698
|
},
|
|
26457
26699
|
connected_account_id: {
|
|
26458
|
-
description: "ID of the affected
|
|
26700
|
+
description: "ID of the affected connected account.",
|
|
26459
26701
|
format: "uuid",
|
|
26460
26702
|
type: "string"
|
|
26461
26703
|
},
|
|
26462
26704
|
connected_account_warnings: {
|
|
26463
26705
|
description: "Warnings associated with the connected account.",
|
|
26464
26706
|
items: {
|
|
26707
|
+
description: "Warning associated with the resource, including the warning code, message, and creation timestamp.",
|
|
26465
26708
|
properties: {
|
|
26466
26709
|
created_at: {
|
|
26467
26710
|
description: "Date and time at which Seam created the warning.",
|
|
@@ -26502,7 +26745,7 @@ var openapi = {
|
|
|
26502
26745
|
type: "string"
|
|
26503
26746
|
},
|
|
26504
26747
|
workspace_id: {
|
|
26505
|
-
description: "ID of the
|
|
26748
|
+
description: "ID of the workspace associated with the event.",
|
|
26506
26749
|
format: "uuid",
|
|
26507
26750
|
type: "string"
|
|
26508
26751
|
}
|
|
@@ -26521,7 +26764,7 @@ var openapi = {
|
|
|
26521
26764
|
"x-route-path": "/connected_accounts"
|
|
26522
26765
|
},
|
|
26523
26766
|
{
|
|
26524
|
-
description: "A
|
|
26767
|
+
description: "A connected account completed the first sync with Seam, and the corresponding devices or systems are now available.",
|
|
26525
26768
|
properties: {
|
|
26526
26769
|
connected_account_custom_metadata: {
|
|
26527
26770
|
additionalProperties: {
|
|
@@ -26531,7 +26774,7 @@ var openapi = {
|
|
|
26531
26774
|
type: "object"
|
|
26532
26775
|
},
|
|
26533
26776
|
connected_account_id: {
|
|
26534
|
-
description: "ID of the affected
|
|
26777
|
+
description: "ID of the affected connected account.",
|
|
26535
26778
|
format: "uuid",
|
|
26536
26779
|
type: "string"
|
|
26537
26780
|
},
|
|
@@ -26555,7 +26798,7 @@ var openapi = {
|
|
|
26555
26798
|
type: "string"
|
|
26556
26799
|
},
|
|
26557
26800
|
workspace_id: {
|
|
26558
|
-
description: "ID of the
|
|
26801
|
+
description: "ID of the workspace associated with the event.",
|
|
26559
26802
|
format: "uuid",
|
|
26560
26803
|
type: "string"
|
|
26561
26804
|
}
|
|
@@ -26572,7 +26815,7 @@ var openapi = {
|
|
|
26572
26815
|
"x-route-path": "/connected_accounts"
|
|
26573
26816
|
},
|
|
26574
26817
|
{
|
|
26575
|
-
description: "A
|
|
26818
|
+
description: "A connected account was deleted.",
|
|
26576
26819
|
properties: {
|
|
26577
26820
|
connected_account_custom_metadata: {
|
|
26578
26821
|
additionalProperties: {
|
|
@@ -26582,7 +26825,7 @@ var openapi = {
|
|
|
26582
26825
|
type: "object"
|
|
26583
26826
|
},
|
|
26584
26827
|
connected_account_id: {
|
|
26585
|
-
description: "ID of the affected
|
|
26828
|
+
description: "ID of the affected connected account.",
|
|
26586
26829
|
format: "uuid",
|
|
26587
26830
|
type: "string"
|
|
26588
26831
|
},
|
|
@@ -26614,7 +26857,7 @@ var openapi = {
|
|
|
26614
26857
|
type: "string"
|
|
26615
26858
|
},
|
|
26616
26859
|
workspace_id: {
|
|
26617
|
-
description: "ID of the
|
|
26860
|
+
description: "ID of the workspace associated with the event.",
|
|
26618
26861
|
format: "uuid",
|
|
26619
26862
|
type: "string"
|
|
26620
26863
|
}
|
|
@@ -26631,7 +26874,7 @@ var openapi = {
|
|
|
26631
26874
|
"x-route-path": "/connected_accounts"
|
|
26632
26875
|
},
|
|
26633
26876
|
{
|
|
26634
|
-
description: "A
|
|
26877
|
+
description: "A connected account completed the first sync after reconnection with Seam, and the corresponding devices or systems are now available.",
|
|
26635
26878
|
properties: {
|
|
26636
26879
|
connected_account_custom_metadata: {
|
|
26637
26880
|
additionalProperties: {
|
|
@@ -26641,7 +26884,7 @@ var openapi = {
|
|
|
26641
26884
|
type: "object"
|
|
26642
26885
|
},
|
|
26643
26886
|
connected_account_id: {
|
|
26644
|
-
description: "ID of the affected
|
|
26887
|
+
description: "ID of the affected connected account.",
|
|
26645
26888
|
format: "uuid",
|
|
26646
26889
|
type: "string"
|
|
26647
26890
|
},
|
|
@@ -26667,7 +26910,7 @@ var openapi = {
|
|
|
26667
26910
|
type: "string"
|
|
26668
26911
|
},
|
|
26669
26912
|
workspace_id: {
|
|
26670
|
-
description: "ID of the
|
|
26913
|
+
description: "ID of the workspace associated with the event.",
|
|
26671
26914
|
format: "uuid",
|
|
26672
26915
|
type: "string"
|
|
26673
26916
|
}
|
|
@@ -26684,7 +26927,7 @@ var openapi = {
|
|
|
26684
26927
|
"x-route-path": "/connected_accounts"
|
|
26685
26928
|
},
|
|
26686
26929
|
{
|
|
26687
|
-
description: "A
|
|
26930
|
+
description: "A connected account requires reauthorization using a new Connect Webview. The account is still connected, but cannot access new features. Delaying reauthorization too long will eventually cause the Connected Account to become disconnected.",
|
|
26688
26931
|
properties: {
|
|
26689
26932
|
connected_account_custom_metadata: {
|
|
26690
26933
|
additionalProperties: {
|
|
@@ -26696,6 +26939,7 @@ var openapi = {
|
|
|
26696
26939
|
connected_account_errors: {
|
|
26697
26940
|
description: "Errors associated with the connected account.",
|
|
26698
26941
|
items: {
|
|
26942
|
+
description: "Error associated with the resource, including the error code, message, and creation timestamp.",
|
|
26699
26943
|
properties: {
|
|
26700
26944
|
created_at: {
|
|
26701
26945
|
description: "Date and time at which Seam created the error.",
|
|
@@ -26717,13 +26961,14 @@ var openapi = {
|
|
|
26717
26961
|
type: "array"
|
|
26718
26962
|
},
|
|
26719
26963
|
connected_account_id: {
|
|
26720
|
-
description: "ID of the affected
|
|
26964
|
+
description: "ID of the affected connected account.",
|
|
26721
26965
|
format: "uuid",
|
|
26722
26966
|
type: "string"
|
|
26723
26967
|
},
|
|
26724
26968
|
connected_account_warnings: {
|
|
26725
26969
|
description: "Warnings associated with the connected account.",
|
|
26726
26970
|
items: {
|
|
26971
|
+
description: "Warning associated with the resource, including the warning code, message, and creation timestamp.",
|
|
26727
26972
|
properties: {
|
|
26728
26973
|
created_at: {
|
|
26729
26974
|
description: "Date and time at which Seam created the warning.",
|
|
@@ -26764,7 +27009,7 @@ var openapi = {
|
|
|
26764
27009
|
type: "string"
|
|
26765
27010
|
},
|
|
26766
27011
|
workspace_id: {
|
|
26767
|
-
description: "ID of the
|
|
27012
|
+
description: "ID of the workspace associated with the event.",
|
|
26768
27013
|
format: "uuid",
|
|
26769
27014
|
type: "string"
|
|
26770
27015
|
}
|
|
@@ -26783,7 +27028,7 @@ var openapi = {
|
|
|
26783
27028
|
"x-route-path": "/connected_accounts"
|
|
26784
27029
|
},
|
|
26785
27030
|
{
|
|
26786
|
-
description: "A lock door
|
|
27031
|
+
description: "A lock door action attempt succeeded.",
|
|
26787
27032
|
properties: {
|
|
26788
27033
|
action_attempt_id: {
|
|
26789
27034
|
description: "ID of the affected action attempt.",
|
|
@@ -26825,7 +27070,7 @@ var openapi = {
|
|
|
26825
27070
|
},
|
|
26826
27071
|
status: { description: "Status of the action.", type: "string" },
|
|
26827
27072
|
workspace_id: {
|
|
26828
|
-
description: "ID of the
|
|
27073
|
+
description: "ID of the workspace associated with the event.",
|
|
26829
27074
|
format: "uuid",
|
|
26830
27075
|
type: "string"
|
|
26831
27076
|
}
|
|
@@ -26844,7 +27089,7 @@ var openapi = {
|
|
|
26844
27089
|
"x-route-path": "/action_attempts"
|
|
26845
27090
|
},
|
|
26846
27091
|
{
|
|
26847
|
-
description: "A lock door
|
|
27092
|
+
description: "A lock door action attempt failed.",
|
|
26848
27093
|
properties: {
|
|
26849
27094
|
action_attempt_id: {
|
|
26850
27095
|
description: "ID of the affected action attempt.",
|
|
@@ -26886,7 +27131,7 @@ var openapi = {
|
|
|
26886
27131
|
},
|
|
26887
27132
|
status: { description: "Status of the action.", type: "string" },
|
|
26888
27133
|
workspace_id: {
|
|
26889
|
-
description: "ID of the
|
|
27134
|
+
description: "ID of the workspace associated with the event.",
|
|
26890
27135
|
format: "uuid",
|
|
26891
27136
|
type: "string"
|
|
26892
27137
|
}
|
|
@@ -26905,7 +27150,7 @@ var openapi = {
|
|
|
26905
27150
|
"x-route-path": "/action_attempts"
|
|
26906
27151
|
},
|
|
26907
27152
|
{
|
|
26908
|
-
description: "An unlock door
|
|
27153
|
+
description: "An unlock door action attempt succeeded.",
|
|
26909
27154
|
properties: {
|
|
26910
27155
|
action_attempt_id: {
|
|
26911
27156
|
description: "ID of the affected action attempt.",
|
|
@@ -26947,7 +27192,7 @@ var openapi = {
|
|
|
26947
27192
|
},
|
|
26948
27193
|
status: { description: "Status of the action.", type: "string" },
|
|
26949
27194
|
workspace_id: {
|
|
26950
|
-
description: "ID of the
|
|
27195
|
+
description: "ID of the workspace associated with the event.",
|
|
26951
27196
|
format: "uuid",
|
|
26952
27197
|
type: "string"
|
|
26953
27198
|
}
|
|
@@ -26966,7 +27211,7 @@ var openapi = {
|
|
|
26966
27211
|
"x-route-path": "/action_attempts"
|
|
26967
27212
|
},
|
|
26968
27213
|
{
|
|
26969
|
-
description: "An unlock door
|
|
27214
|
+
description: "An unlock door action attempt failed.",
|
|
26970
27215
|
properties: {
|
|
26971
27216
|
action_attempt_id: {
|
|
26972
27217
|
description: "ID of the affected action attempt.",
|
|
@@ -27008,7 +27253,7 @@ var openapi = {
|
|
|
27008
27253
|
},
|
|
27009
27254
|
status: { description: "Status of the action.", type: "string" },
|
|
27010
27255
|
workspace_id: {
|
|
27011
|
-
description: "ID of the
|
|
27256
|
+
description: "ID of the workspace associated with the event.",
|
|
27012
27257
|
format: "uuid",
|
|
27013
27258
|
type: "string"
|
|
27014
27259
|
}
|
|
@@ -27027,7 +27272,7 @@ var openapi = {
|
|
|
27027
27272
|
"x-route-path": "/action_attempts"
|
|
27028
27273
|
},
|
|
27029
27274
|
{
|
|
27030
|
-
description: "A simulate keypad code entry
|
|
27275
|
+
description: "A simulate keypad code entry action attempt succeeded.",
|
|
27031
27276
|
properties: {
|
|
27032
27277
|
action_attempt_id: {
|
|
27033
27278
|
description: "ID of the affected action attempt.",
|
|
@@ -27069,7 +27314,7 @@ var openapi = {
|
|
|
27069
27314
|
},
|
|
27070
27315
|
status: { description: "Status of the action.", type: "string" },
|
|
27071
27316
|
workspace_id: {
|
|
27072
|
-
description: "ID of the
|
|
27317
|
+
description: "ID of the workspace associated with the event.",
|
|
27073
27318
|
format: "uuid",
|
|
27074
27319
|
type: "string"
|
|
27075
27320
|
}
|
|
@@ -27088,7 +27333,7 @@ var openapi = {
|
|
|
27088
27333
|
"x-route-path": "/action_attempts"
|
|
27089
27334
|
},
|
|
27090
27335
|
{
|
|
27091
|
-
description: "A simulate keypad code entry
|
|
27336
|
+
description: "A simulate keypad code entry action attempt failed.",
|
|
27092
27337
|
properties: {
|
|
27093
27338
|
action_attempt_id: {
|
|
27094
27339
|
description: "ID of the affected action attempt.",
|
|
@@ -27130,7 +27375,7 @@ var openapi = {
|
|
|
27130
27375
|
},
|
|
27131
27376
|
status: { description: "Status of the action.", type: "string" },
|
|
27132
27377
|
workspace_id: {
|
|
27133
|
-
description: "ID of the
|
|
27378
|
+
description: "ID of the workspace associated with the event.",
|
|
27134
27379
|
format: "uuid",
|
|
27135
27380
|
type: "string"
|
|
27136
27381
|
}
|
|
@@ -27149,7 +27394,7 @@ var openapi = {
|
|
|
27149
27394
|
"x-route-path": "/action_attempts"
|
|
27150
27395
|
},
|
|
27151
27396
|
{
|
|
27152
|
-
description: "A simulate manual lock via keypad
|
|
27397
|
+
description: "A simulate manual lock via keypad action attempt succeeded.",
|
|
27153
27398
|
properties: {
|
|
27154
27399
|
action_attempt_id: {
|
|
27155
27400
|
description: "ID of the affected action attempt.",
|
|
@@ -27193,7 +27438,7 @@ var openapi = {
|
|
|
27193
27438
|
},
|
|
27194
27439
|
status: { description: "Status of the action.", type: "string" },
|
|
27195
27440
|
workspace_id: {
|
|
27196
|
-
description: "ID of the
|
|
27441
|
+
description: "ID of the workspace associated with the event.",
|
|
27197
27442
|
format: "uuid",
|
|
27198
27443
|
type: "string"
|
|
27199
27444
|
}
|
|
@@ -27212,7 +27457,7 @@ var openapi = {
|
|
|
27212
27457
|
"x-route-path": "/action_attempts"
|
|
27213
27458
|
},
|
|
27214
27459
|
{
|
|
27215
|
-
description: "A simulate manual lock via keypad
|
|
27460
|
+
description: "A simulate manual lock via keypad action attempt failed.",
|
|
27216
27461
|
properties: {
|
|
27217
27462
|
action_attempt_id: {
|
|
27218
27463
|
description: "ID of the affected action attempt.",
|
|
@@ -27254,7 +27499,7 @@ var openapi = {
|
|
|
27254
27499
|
},
|
|
27255
27500
|
status: { description: "Status of the action.", type: "string" },
|
|
27256
27501
|
workspace_id: {
|
|
27257
|
-
description: "ID of the
|
|
27502
|
+
description: "ID of the workspace associated with the event.",
|
|
27258
27503
|
format: "uuid",
|
|
27259
27504
|
type: "string"
|
|
27260
27505
|
}
|
|
@@ -27273,10 +27518,10 @@ var openapi = {
|
|
|
27273
27518
|
"x-route-path": "/action_attempts"
|
|
27274
27519
|
},
|
|
27275
27520
|
{
|
|
27276
|
-
description: "A
|
|
27521
|
+
description: "A Connect Webview login succeeded.",
|
|
27277
27522
|
properties: {
|
|
27278
27523
|
connect_webview_id: {
|
|
27279
|
-
description: "ID of the affected
|
|
27524
|
+
description: "ID of the affected Connect Webview.",
|
|
27280
27525
|
format: "uuid",
|
|
27281
27526
|
type: "string"
|
|
27282
27527
|
},
|
|
@@ -27288,7 +27533,7 @@ var openapi = {
|
|
|
27288
27533
|
type: "object"
|
|
27289
27534
|
},
|
|
27290
27535
|
connected_account_id: {
|
|
27291
|
-
description: "ID of the
|
|
27536
|
+
description: "ID of the connected account associated with the event.",
|
|
27292
27537
|
format: "uuid",
|
|
27293
27538
|
type: "string"
|
|
27294
27539
|
},
|
|
@@ -27316,7 +27561,7 @@ var openapi = {
|
|
|
27316
27561
|
type: "string"
|
|
27317
27562
|
},
|
|
27318
27563
|
workspace_id: {
|
|
27319
|
-
description: "ID of the
|
|
27564
|
+
description: "ID of the workspace associated with the event.",
|
|
27320
27565
|
format: "uuid",
|
|
27321
27566
|
type: "string"
|
|
27322
27567
|
}
|
|
@@ -27334,10 +27579,10 @@ var openapi = {
|
|
|
27334
27579
|
"x-route-path": "/connect_webviews"
|
|
27335
27580
|
},
|
|
27336
27581
|
{
|
|
27337
|
-
description: "A
|
|
27582
|
+
description: "A Connect Webview login failed.",
|
|
27338
27583
|
properties: {
|
|
27339
27584
|
connect_webview_id: {
|
|
27340
|
-
description: "ID of the affected
|
|
27585
|
+
description: "ID of the affected Connect Webview.",
|
|
27341
27586
|
format: "uuid",
|
|
27342
27587
|
type: "string"
|
|
27343
27588
|
},
|
|
@@ -27361,7 +27606,7 @@ var openapi = {
|
|
|
27361
27606
|
type: "string"
|
|
27362
27607
|
},
|
|
27363
27608
|
workspace_id: {
|
|
27364
|
-
description: "ID of the
|
|
27609
|
+
description: "ID of the workspace associated with the event.",
|
|
27365
27610
|
format: "uuid",
|
|
27366
27611
|
type: "string"
|
|
27367
27612
|
}
|
|
@@ -27378,7 +27623,7 @@ var openapi = {
|
|
|
27378
27623
|
"x-route-path": "/connect_webviews"
|
|
27379
27624
|
},
|
|
27380
27625
|
{
|
|
27381
|
-
description: "The status of a
|
|
27626
|
+
description: "The status of a device changed from offline to online. That is, the `device.properties.online` property changed from `false` to `true`. Note that some devices operate entirely in offline mode, so Seam never emits a `device.connected` event for these devices.",
|
|
27382
27627
|
properties: {
|
|
27383
27628
|
connected_account_custom_metadata: {
|
|
27384
27629
|
additionalProperties: {
|
|
@@ -27388,7 +27633,7 @@ var openapi = {
|
|
|
27388
27633
|
type: "object"
|
|
27389
27634
|
},
|
|
27390
27635
|
connected_account_id: {
|
|
27391
|
-
description: "ID of the
|
|
27636
|
+
description: "ID of the connected account associated with the event.",
|
|
27392
27637
|
format: "uuid",
|
|
27393
27638
|
type: "string"
|
|
27394
27639
|
},
|
|
@@ -27425,7 +27670,7 @@ var openapi = {
|
|
|
27425
27670
|
type: "string"
|
|
27426
27671
|
},
|
|
27427
27672
|
workspace_id: {
|
|
27428
|
-
description: "ID of the
|
|
27673
|
+
description: "ID of the workspace associated with the event.",
|
|
27429
27674
|
format: "uuid",
|
|
27430
27675
|
type: "string"
|
|
27431
27676
|
}
|
|
@@ -27443,7 +27688,7 @@ var openapi = {
|
|
|
27443
27688
|
"x-route-path": "/devices"
|
|
27444
27689
|
},
|
|
27445
27690
|
{
|
|
27446
|
-
description: "A
|
|
27691
|
+
description: "A device was added to Seam or was re-added to Seam after having been removed.",
|
|
27447
27692
|
properties: {
|
|
27448
27693
|
connected_account_custom_metadata: {
|
|
27449
27694
|
additionalProperties: {
|
|
@@ -27453,7 +27698,7 @@ var openapi = {
|
|
|
27453
27698
|
type: "object"
|
|
27454
27699
|
},
|
|
27455
27700
|
connected_account_id: {
|
|
27456
|
-
description: "ID of the
|
|
27701
|
+
description: "ID of the connected account associated with the event.",
|
|
27457
27702
|
format: "uuid",
|
|
27458
27703
|
type: "string"
|
|
27459
27704
|
},
|
|
@@ -27490,7 +27735,7 @@ var openapi = {
|
|
|
27490
27735
|
type: "string"
|
|
27491
27736
|
},
|
|
27492
27737
|
workspace_id: {
|
|
27493
|
-
description: "ID of the
|
|
27738
|
+
description: "ID of the workspace associated with the event.",
|
|
27494
27739
|
format: "uuid",
|
|
27495
27740
|
type: "string"
|
|
27496
27741
|
}
|
|
@@ -27518,7 +27763,7 @@ var openapi = {
|
|
|
27518
27763
|
type: "object"
|
|
27519
27764
|
},
|
|
27520
27765
|
connected_account_id: {
|
|
27521
|
-
description: "ID of the
|
|
27766
|
+
description: "ID of the connected account associated with the event.",
|
|
27522
27767
|
format: "uuid",
|
|
27523
27768
|
type: "string"
|
|
27524
27769
|
},
|
|
@@ -27558,7 +27803,7 @@ var openapi = {
|
|
|
27558
27803
|
type: "string"
|
|
27559
27804
|
},
|
|
27560
27805
|
workspace_id: {
|
|
27561
|
-
description: "ID of the
|
|
27806
|
+
description: "ID of the workspace associated with the event.",
|
|
27562
27807
|
format: "uuid",
|
|
27563
27808
|
type: "string"
|
|
27564
27809
|
}
|
|
@@ -27586,7 +27831,7 @@ var openapi = {
|
|
|
27586
27831
|
type: "object"
|
|
27587
27832
|
},
|
|
27588
27833
|
connected_account_id: {
|
|
27589
|
-
description: "ID of the
|
|
27834
|
+
description: "ID of the connected account associated with the event.",
|
|
27590
27835
|
format: "uuid",
|
|
27591
27836
|
type: "string"
|
|
27592
27837
|
},
|
|
@@ -27626,7 +27871,7 @@ var openapi = {
|
|
|
27626
27871
|
type: "string"
|
|
27627
27872
|
},
|
|
27628
27873
|
workspace_id: {
|
|
27629
|
-
description: "ID of the
|
|
27874
|
+
description: "ID of the workspace associated with the event.",
|
|
27630
27875
|
format: "uuid",
|
|
27631
27876
|
type: "string"
|
|
27632
27877
|
}
|
|
@@ -27654,7 +27899,7 @@ var openapi = {
|
|
|
27654
27899
|
type: "object"
|
|
27655
27900
|
},
|
|
27656
27901
|
connected_account_id: {
|
|
27657
|
-
description: "ID of the
|
|
27902
|
+
description: "ID of the connected account associated with the event.",
|
|
27658
27903
|
format: "uuid",
|
|
27659
27904
|
type: "string"
|
|
27660
27905
|
},
|
|
@@ -27694,7 +27939,7 @@ var openapi = {
|
|
|
27694
27939
|
type: "string"
|
|
27695
27940
|
},
|
|
27696
27941
|
workspace_id: {
|
|
27697
|
-
description: "ID of the
|
|
27942
|
+
description: "ID of the workspace associated with the event.",
|
|
27698
27943
|
format: "uuid",
|
|
27699
27944
|
type: "string"
|
|
27700
27945
|
}
|
|
@@ -27712,7 +27957,7 @@ var openapi = {
|
|
|
27712
27957
|
"x-route-path": "/devices/unmanaged"
|
|
27713
27958
|
},
|
|
27714
27959
|
{
|
|
27715
|
-
description: "The status of a
|
|
27960
|
+
description: "The status of a device changed from online to offline. That is, the `device.properties.online` property changed from `true` to `false`.",
|
|
27716
27961
|
properties: {
|
|
27717
27962
|
connected_account_custom_metadata: {
|
|
27718
27963
|
additionalProperties: {
|
|
@@ -27724,6 +27969,7 @@ var openapi = {
|
|
|
27724
27969
|
connected_account_errors: {
|
|
27725
27970
|
description: "Errors associated with the connected account.",
|
|
27726
27971
|
items: {
|
|
27972
|
+
description: "Error associated with the resource, including the error code, message, and creation timestamp.",
|
|
27727
27973
|
properties: {
|
|
27728
27974
|
created_at: {
|
|
27729
27975
|
description: "Date and time at which Seam created the error.",
|
|
@@ -27745,13 +27991,14 @@ var openapi = {
|
|
|
27745
27991
|
type: "array"
|
|
27746
27992
|
},
|
|
27747
27993
|
connected_account_id: {
|
|
27748
|
-
description: "ID of the
|
|
27994
|
+
description: "ID of the connected account associated with the event.",
|
|
27749
27995
|
format: "uuid",
|
|
27750
27996
|
type: "string"
|
|
27751
27997
|
},
|
|
27752
27998
|
connected_account_warnings: {
|
|
27753
27999
|
description: "Warnings associated with the connected account.",
|
|
27754
28000
|
items: {
|
|
28001
|
+
description: "Warning associated with the resource, including the warning code, message, and creation timestamp.",
|
|
27755
28002
|
properties: {
|
|
27756
28003
|
created_at: {
|
|
27757
28004
|
description: "Date and time at which Seam created the warning.",
|
|
@@ -27791,6 +28038,7 @@ var openapi = {
|
|
|
27791
28038
|
device_errors: {
|
|
27792
28039
|
description: "Errors associated with the device.",
|
|
27793
28040
|
items: {
|
|
28041
|
+
description: "Error associated with the resource, including the error code, message, and creation timestamp.",
|
|
27794
28042
|
properties: {
|
|
27795
28043
|
created_at: {
|
|
27796
28044
|
description: "Date and time at which Seam created the error.",
|
|
@@ -27819,6 +28067,7 @@ var openapi = {
|
|
|
27819
28067
|
device_warnings: {
|
|
27820
28068
|
description: "Warnings associated with the device.",
|
|
27821
28069
|
items: {
|
|
28070
|
+
description: "Warning associated with the resource, including the warning code, message, and creation timestamp.",
|
|
27822
28071
|
properties: {
|
|
27823
28072
|
created_at: {
|
|
27824
28073
|
description: "Date and time at which Seam created the warning.",
|
|
@@ -27860,7 +28109,7 @@ var openapi = {
|
|
|
27860
28109
|
type: "string"
|
|
27861
28110
|
},
|
|
27862
28111
|
workspace_id: {
|
|
27863
|
-
description: "ID of the
|
|
28112
|
+
description: "ID of the workspace associated with the event.",
|
|
27864
28113
|
format: "uuid",
|
|
27865
28114
|
type: "string"
|
|
27866
28115
|
}
|
|
@@ -27895,6 +28144,7 @@ var openapi = {
|
|
|
27895
28144
|
connected_account_errors: {
|
|
27896
28145
|
description: "Errors associated with the connected account.",
|
|
27897
28146
|
items: {
|
|
28147
|
+
description: "Error associated with the resource, including the error code, message, and creation timestamp.",
|
|
27898
28148
|
properties: {
|
|
27899
28149
|
created_at: {
|
|
27900
28150
|
description: "Date and time at which Seam created the error.",
|
|
@@ -27916,13 +28166,14 @@ var openapi = {
|
|
|
27916
28166
|
type: "array"
|
|
27917
28167
|
},
|
|
27918
28168
|
connected_account_id: {
|
|
27919
|
-
description: "ID of the
|
|
28169
|
+
description: "ID of the connected account associated with the event.",
|
|
27920
28170
|
format: "uuid",
|
|
27921
28171
|
type: "string"
|
|
27922
28172
|
},
|
|
27923
28173
|
connected_account_warnings: {
|
|
27924
28174
|
description: "Warnings associated with the connected account.",
|
|
27925
28175
|
items: {
|
|
28176
|
+
description: "Warning associated with the resource, including the warning code, message, and creation timestamp.",
|
|
27926
28177
|
properties: {
|
|
27927
28178
|
created_at: {
|
|
27928
28179
|
description: "Date and time at which Seam created the warning.",
|
|
@@ -27962,6 +28213,7 @@ var openapi = {
|
|
|
27962
28213
|
device_errors: {
|
|
27963
28214
|
description: "Errors associated with the device.",
|
|
27964
28215
|
items: {
|
|
28216
|
+
description: "Error associated with the resource, including the error code, message, and creation timestamp.",
|
|
27965
28217
|
properties: {
|
|
27966
28218
|
created_at: {
|
|
27967
28219
|
description: "Date and time at which Seam created the error.",
|
|
@@ -27990,6 +28242,7 @@ var openapi = {
|
|
|
27990
28242
|
device_warnings: {
|
|
27991
28243
|
description: "Warnings associated with the device.",
|
|
27992
28244
|
items: {
|
|
28245
|
+
description: "Warning associated with the resource, including the warning code, message, and creation timestamp.",
|
|
27993
28246
|
properties: {
|
|
27994
28247
|
created_at: {
|
|
27995
28248
|
description: "Date and time at which Seam created the warning.",
|
|
@@ -28034,7 +28287,7 @@ var openapi = {
|
|
|
28034
28287
|
type: "string"
|
|
28035
28288
|
},
|
|
28036
28289
|
workspace_id: {
|
|
28037
|
-
description: "ID of the
|
|
28290
|
+
description: "ID of the workspace associated with the event.",
|
|
28038
28291
|
format: "uuid",
|
|
28039
28292
|
type: "string"
|
|
28040
28293
|
}
|
|
@@ -28057,7 +28310,7 @@ var openapi = {
|
|
|
28057
28310
|
"x-route-path": "/devices/unmanaged"
|
|
28058
28311
|
},
|
|
28059
28312
|
{
|
|
28060
|
-
description: "A
|
|
28313
|
+
description: "A device detected that it was tampered with, for example, opened or moved.",
|
|
28061
28314
|
properties: {
|
|
28062
28315
|
connected_account_custom_metadata: {
|
|
28063
28316
|
additionalProperties: {
|
|
@@ -28067,7 +28320,7 @@ var openapi = {
|
|
|
28067
28320
|
type: "object"
|
|
28068
28321
|
},
|
|
28069
28322
|
connected_account_id: {
|
|
28070
|
-
description: "ID of the
|
|
28323
|
+
description: "ID of the connected account associated with the event.",
|
|
28071
28324
|
format: "uuid",
|
|
28072
28325
|
type: "string"
|
|
28073
28326
|
},
|
|
@@ -28104,7 +28357,7 @@ var openapi = {
|
|
|
28104
28357
|
type: "string"
|
|
28105
28358
|
},
|
|
28106
28359
|
workspace_id: {
|
|
28107
|
-
description: "ID of the
|
|
28360
|
+
description: "ID of the workspace associated with the event.",
|
|
28108
28361
|
format: "uuid",
|
|
28109
28362
|
type: "string"
|
|
28110
28363
|
}
|
|
@@ -28122,7 +28375,7 @@ var openapi = {
|
|
|
28122
28375
|
"x-route-path": "/devices"
|
|
28123
28376
|
},
|
|
28124
28377
|
{
|
|
28125
|
-
description: "A
|
|
28378
|
+
description: "A device battery level dropped below the low threshold.",
|
|
28126
28379
|
properties: {
|
|
28127
28380
|
battery_level: {
|
|
28128
28381
|
description: "Number in the range 0 to 1.0 indicating the amount of battery in the affected device, as reported by the device.",
|
|
@@ -28139,7 +28392,7 @@ var openapi = {
|
|
|
28139
28392
|
type: "object"
|
|
28140
28393
|
},
|
|
28141
28394
|
connected_account_id: {
|
|
28142
|
-
description: "ID of the
|
|
28395
|
+
description: "ID of the connected account associated with the event.",
|
|
28143
28396
|
format: "uuid",
|
|
28144
28397
|
type: "string"
|
|
28145
28398
|
},
|
|
@@ -28176,7 +28429,7 @@ var openapi = {
|
|
|
28176
28429
|
type: "string"
|
|
28177
28430
|
},
|
|
28178
28431
|
workspace_id: {
|
|
28179
|
-
description: "ID of the
|
|
28432
|
+
description: "ID of the workspace associated with the event.",
|
|
28180
28433
|
format: "uuid",
|
|
28181
28434
|
type: "string"
|
|
28182
28435
|
}
|
|
@@ -28195,7 +28448,7 @@ var openapi = {
|
|
|
28195
28448
|
"x-route-path": "/devices"
|
|
28196
28449
|
},
|
|
28197
28450
|
{
|
|
28198
|
-
description: "A
|
|
28451
|
+
description: "A device battery status changed since the last `battery_status_changed` event.",
|
|
28199
28452
|
properties: {
|
|
28200
28453
|
battery_level: {
|
|
28201
28454
|
description: "Number in the range 0 to 1.0 indicating the amount of battery in the affected device, as reported by the device.",
|
|
@@ -28217,7 +28470,7 @@ var openapi = {
|
|
|
28217
28470
|
type: "object"
|
|
28218
28471
|
},
|
|
28219
28472
|
connected_account_id: {
|
|
28220
|
-
description: "ID of the
|
|
28473
|
+
description: "ID of the connected account associated with the event.",
|
|
28221
28474
|
format: "uuid",
|
|
28222
28475
|
type: "string"
|
|
28223
28476
|
},
|
|
@@ -28257,7 +28510,7 @@ var openapi = {
|
|
|
28257
28510
|
type: "string"
|
|
28258
28511
|
},
|
|
28259
28512
|
workspace_id: {
|
|
28260
|
-
description: "ID of the
|
|
28513
|
+
description: "ID of the workspace associated with the event.",
|
|
28261
28514
|
format: "uuid",
|
|
28262
28515
|
type: "string"
|
|
28263
28516
|
}
|
|
@@ -28277,7 +28530,7 @@ var openapi = {
|
|
|
28277
28530
|
"x-route-path": "/devices"
|
|
28278
28531
|
},
|
|
28279
28532
|
{
|
|
28280
|
-
description: "A
|
|
28533
|
+
description: "A device was removed externally from the connected account.",
|
|
28281
28534
|
properties: {
|
|
28282
28535
|
connected_account_custom_metadata: {
|
|
28283
28536
|
additionalProperties: {
|
|
@@ -28287,7 +28540,7 @@ var openapi = {
|
|
|
28287
28540
|
type: "object"
|
|
28288
28541
|
},
|
|
28289
28542
|
connected_account_id: {
|
|
28290
|
-
description: "ID of the
|
|
28543
|
+
description: "ID of the connected account associated with the event.",
|
|
28291
28544
|
format: "uuid",
|
|
28292
28545
|
type: "string"
|
|
28293
28546
|
},
|
|
@@ -28324,7 +28577,7 @@ var openapi = {
|
|
|
28324
28577
|
type: "string"
|
|
28325
28578
|
},
|
|
28326
28579
|
workspace_id: {
|
|
28327
|
-
description: "ID of the
|
|
28580
|
+
description: "ID of the workspace associated with the event.",
|
|
28328
28581
|
format: "uuid",
|
|
28329
28582
|
type: "string"
|
|
28330
28583
|
}
|
|
@@ -28342,7 +28595,7 @@ var openapi = {
|
|
|
28342
28595
|
"x-route-path": "/devices"
|
|
28343
28596
|
},
|
|
28344
28597
|
{
|
|
28345
|
-
description: "A
|
|
28598
|
+
description: "A device was deleted.",
|
|
28346
28599
|
properties: {
|
|
28347
28600
|
connected_account_custom_metadata: {
|
|
28348
28601
|
additionalProperties: {
|
|
@@ -28352,7 +28605,7 @@ var openapi = {
|
|
|
28352
28605
|
type: "object"
|
|
28353
28606
|
},
|
|
28354
28607
|
connected_account_id: {
|
|
28355
|
-
description: "ID of the
|
|
28608
|
+
description: "ID of the connected account associated with the event.",
|
|
28356
28609
|
format: "uuid",
|
|
28357
28610
|
type: "string"
|
|
28358
28611
|
},
|
|
@@ -28394,7 +28647,7 @@ var openapi = {
|
|
|
28394
28647
|
type: "string"
|
|
28395
28648
|
},
|
|
28396
28649
|
workspace_id: {
|
|
28397
|
-
description: "ID of the
|
|
28650
|
+
description: "ID of the workspace associated with the event.",
|
|
28398
28651
|
format: "uuid",
|
|
28399
28652
|
type: "string"
|
|
28400
28653
|
}
|
|
@@ -28412,7 +28665,7 @@ var openapi = {
|
|
|
28412
28665
|
"x-route-path": "/devices"
|
|
28413
28666
|
},
|
|
28414
28667
|
{
|
|
28415
|
-
description: "Seam detected that a
|
|
28668
|
+
description: "Seam detected that a device is using a third-party integration that will interfere with Seam device management.",
|
|
28416
28669
|
properties: {
|
|
28417
28670
|
connected_account_custom_metadata: {
|
|
28418
28671
|
additionalProperties: {
|
|
@@ -28422,7 +28675,7 @@ var openapi = {
|
|
|
28422
28675
|
type: "object"
|
|
28423
28676
|
},
|
|
28424
28677
|
connected_account_id: {
|
|
28425
|
-
description: "ID of the
|
|
28678
|
+
description: "ID of the connected account associated with the event.",
|
|
28426
28679
|
format: "uuid",
|
|
28427
28680
|
type: "string"
|
|
28428
28681
|
},
|
|
@@ -28462,7 +28715,7 @@ var openapi = {
|
|
|
28462
28715
|
type: "string"
|
|
28463
28716
|
},
|
|
28464
28717
|
workspace_id: {
|
|
28465
|
-
description: "ID of the
|
|
28718
|
+
description: "ID of the workspace associated with the event.",
|
|
28466
28719
|
format: "uuid",
|
|
28467
28720
|
type: "string"
|
|
28468
28721
|
}
|
|
@@ -28480,7 +28733,7 @@ var openapi = {
|
|
|
28480
28733
|
"x-route-path": "/devices"
|
|
28481
28734
|
},
|
|
28482
28735
|
{
|
|
28483
|
-
description: "Seam detected that a
|
|
28736
|
+
description: "Seam detected that a device is no longer using a third-party integration that was interfering with Seam device management.",
|
|
28484
28737
|
properties: {
|
|
28485
28738
|
connected_account_custom_metadata: {
|
|
28486
28739
|
additionalProperties: {
|
|
@@ -28490,7 +28743,7 @@ var openapi = {
|
|
|
28490
28743
|
type: "object"
|
|
28491
28744
|
},
|
|
28492
28745
|
connected_account_id: {
|
|
28493
|
-
description: "ID of the
|
|
28746
|
+
description: "ID of the connected account associated with the event.",
|
|
28494
28747
|
format: "uuid",
|
|
28495
28748
|
type: "string"
|
|
28496
28749
|
},
|
|
@@ -28530,7 +28783,7 @@ var openapi = {
|
|
|
28530
28783
|
type: "string"
|
|
28531
28784
|
},
|
|
28532
28785
|
workspace_id: {
|
|
28533
|
-
description: "ID of the
|
|
28786
|
+
description: "ID of the workspace associated with the event.",
|
|
28534
28787
|
format: "uuid",
|
|
28535
28788
|
type: "string"
|
|
28536
28789
|
}
|
|
@@ -28558,7 +28811,7 @@ var openapi = {
|
|
|
28558
28811
|
type: "object"
|
|
28559
28812
|
},
|
|
28560
28813
|
connected_account_id: {
|
|
28561
|
-
description: "ID of the
|
|
28814
|
+
description: "ID of the connected account associated with the event.",
|
|
28562
28815
|
format: "uuid",
|
|
28563
28816
|
type: "string"
|
|
28564
28817
|
},
|
|
@@ -28598,7 +28851,7 @@ var openapi = {
|
|
|
28598
28851
|
type: "string"
|
|
28599
28852
|
},
|
|
28600
28853
|
workspace_id: {
|
|
28601
|
-
description: "ID of the
|
|
28854
|
+
description: "ID of the workspace associated with the event.",
|
|
28602
28855
|
format: "uuid",
|
|
28603
28856
|
type: "string"
|
|
28604
28857
|
}
|
|
@@ -28626,7 +28879,7 @@ var openapi = {
|
|
|
28626
28879
|
type: "object"
|
|
28627
28880
|
},
|
|
28628
28881
|
connected_account_id: {
|
|
28629
|
-
description: "ID of the
|
|
28882
|
+
description: "ID of the connected account associated with the event.",
|
|
28630
28883
|
format: "uuid",
|
|
28631
28884
|
type: "string"
|
|
28632
28885
|
},
|
|
@@ -28666,7 +28919,7 @@ var openapi = {
|
|
|
28666
28919
|
type: "string"
|
|
28667
28920
|
},
|
|
28668
28921
|
workspace_id: {
|
|
28669
|
-
description: "ID of the
|
|
28922
|
+
description: "ID of the workspace associated with the event.",
|
|
28670
28923
|
format: "uuid",
|
|
28671
28924
|
type: "string"
|
|
28672
28925
|
}
|
|
@@ -28684,7 +28937,7 @@ var openapi = {
|
|
|
28684
28937
|
"x-route-path": "/devices"
|
|
28685
28938
|
},
|
|
28686
28939
|
{
|
|
28687
|
-
description: "Seam detected a flaky
|
|
28940
|
+
description: "Seam detected a flaky device connection.",
|
|
28688
28941
|
properties: {
|
|
28689
28942
|
connected_account_custom_metadata: {
|
|
28690
28943
|
additionalProperties: {
|
|
@@ -28696,6 +28949,7 @@ var openapi = {
|
|
|
28696
28949
|
connected_account_errors: {
|
|
28697
28950
|
description: "Errors associated with the connected account.",
|
|
28698
28951
|
items: {
|
|
28952
|
+
description: "Error associated with the resource, including the error code, message, and creation timestamp.",
|
|
28699
28953
|
properties: {
|
|
28700
28954
|
created_at: {
|
|
28701
28955
|
description: "Date and time at which Seam created the error.",
|
|
@@ -28717,13 +28971,14 @@ var openapi = {
|
|
|
28717
28971
|
type: "array"
|
|
28718
28972
|
},
|
|
28719
28973
|
connected_account_id: {
|
|
28720
|
-
description: "ID of the
|
|
28974
|
+
description: "ID of the connected account associated with the event.",
|
|
28721
28975
|
format: "uuid",
|
|
28722
28976
|
type: "string"
|
|
28723
28977
|
},
|
|
28724
28978
|
connected_account_warnings: {
|
|
28725
28979
|
description: "Warnings associated with the connected account.",
|
|
28726
28980
|
items: {
|
|
28981
|
+
description: "Warning associated with the resource, including the warning code, message, and creation timestamp.",
|
|
28727
28982
|
properties: {
|
|
28728
28983
|
created_at: {
|
|
28729
28984
|
description: "Date and time at which Seam created the warning.",
|
|
@@ -28763,6 +29018,7 @@ var openapi = {
|
|
|
28763
29018
|
device_errors: {
|
|
28764
29019
|
description: "Errors associated with the device.",
|
|
28765
29020
|
items: {
|
|
29021
|
+
description: "Error associated with the resource, including the error code, message, and creation timestamp.",
|
|
28766
29022
|
properties: {
|
|
28767
29023
|
created_at: {
|
|
28768
29024
|
description: "Date and time at which Seam created the error.",
|
|
@@ -28791,6 +29047,7 @@ var openapi = {
|
|
|
28791
29047
|
device_warnings: {
|
|
28792
29048
|
description: "Warnings associated with the device.",
|
|
28793
29049
|
items: {
|
|
29050
|
+
description: "Warning associated with the resource, including the warning code, message, and creation timestamp.",
|
|
28794
29051
|
properties: {
|
|
28795
29052
|
created_at: {
|
|
28796
29053
|
description: "Date and time at which Seam created the warning.",
|
|
@@ -28826,7 +29083,7 @@ var openapi = {
|
|
|
28826
29083
|
type: "string"
|
|
28827
29084
|
},
|
|
28828
29085
|
workspace_id: {
|
|
28829
|
-
description: "ID of the
|
|
29086
|
+
description: "ID of the workspace associated with the event.",
|
|
28830
29087
|
format: "uuid",
|
|
28831
29088
|
type: "string"
|
|
28832
29089
|
}
|
|
@@ -28848,7 +29105,7 @@ var openapi = {
|
|
|
28848
29105
|
"x-route-path": "/devices"
|
|
28849
29106
|
},
|
|
28850
29107
|
{
|
|
28851
|
-
description: "Seam detected that a previously-flaky
|
|
29108
|
+
description: "Seam detected that a previously-flaky device connection stabilized.",
|
|
28852
29109
|
properties: {
|
|
28853
29110
|
connected_account_custom_metadata: {
|
|
28854
29111
|
additionalProperties: {
|
|
@@ -28858,7 +29115,7 @@ var openapi = {
|
|
|
28858
29115
|
type: "object"
|
|
28859
29116
|
},
|
|
28860
29117
|
connected_account_id: {
|
|
28861
|
-
description: "ID of the
|
|
29118
|
+
description: "ID of the connected account associated with the event.",
|
|
28862
29119
|
format: "uuid",
|
|
28863
29120
|
type: "string"
|
|
28864
29121
|
},
|
|
@@ -28898,7 +29155,7 @@ var openapi = {
|
|
|
28898
29155
|
type: "string"
|
|
28899
29156
|
},
|
|
28900
29157
|
workspace_id: {
|
|
28901
|
-
description: "ID of the
|
|
29158
|
+
description: "ID of the workspace associated with the event.",
|
|
28902
29159
|
format: "uuid",
|
|
28903
29160
|
type: "string"
|
|
28904
29161
|
}
|
|
@@ -28916,7 +29173,7 @@ var openapi = {
|
|
|
28916
29173
|
"x-route-path": "/devices"
|
|
28917
29174
|
},
|
|
28918
29175
|
{
|
|
28919
|
-
description: "A third-party subscription is required to use all
|
|
29176
|
+
description: "A third-party subscription is required to use all device features.",
|
|
28920
29177
|
properties: {
|
|
28921
29178
|
connected_account_custom_metadata: {
|
|
28922
29179
|
additionalProperties: {
|
|
@@ -28928,6 +29185,7 @@ var openapi = {
|
|
|
28928
29185
|
connected_account_errors: {
|
|
28929
29186
|
description: "Errors associated with the connected account.",
|
|
28930
29187
|
items: {
|
|
29188
|
+
description: "Error associated with the resource, including the error code, message, and creation timestamp.",
|
|
28931
29189
|
properties: {
|
|
28932
29190
|
created_at: {
|
|
28933
29191
|
description: "Date and time at which Seam created the error.",
|
|
@@ -28949,13 +29207,14 @@ var openapi = {
|
|
|
28949
29207
|
type: "array"
|
|
28950
29208
|
},
|
|
28951
29209
|
connected_account_id: {
|
|
28952
|
-
description: "ID of the
|
|
29210
|
+
description: "ID of the connected account associated with the event.",
|
|
28953
29211
|
format: "uuid",
|
|
28954
29212
|
type: "string"
|
|
28955
29213
|
},
|
|
28956
29214
|
connected_account_warnings: {
|
|
28957
29215
|
description: "Warnings associated with the connected account.",
|
|
28958
29216
|
items: {
|
|
29217
|
+
description: "Warning associated with the resource, including the warning code, message, and creation timestamp.",
|
|
28959
29218
|
properties: {
|
|
28960
29219
|
created_at: {
|
|
28961
29220
|
description: "Date and time at which Seam created the warning.",
|
|
@@ -28995,6 +29254,7 @@ var openapi = {
|
|
|
28995
29254
|
device_errors: {
|
|
28996
29255
|
description: "Errors associated with the device.",
|
|
28997
29256
|
items: {
|
|
29257
|
+
description: "Error associated with the resource, including the error code, message, and creation timestamp.",
|
|
28998
29258
|
properties: {
|
|
28999
29259
|
created_at: {
|
|
29000
29260
|
description: "Date and time at which Seam created the error.",
|
|
@@ -29023,6 +29283,7 @@ var openapi = {
|
|
|
29023
29283
|
device_warnings: {
|
|
29024
29284
|
description: "Warnings associated with the device.",
|
|
29025
29285
|
items: {
|
|
29286
|
+
description: "Warning associated with the resource, including the warning code, message, and creation timestamp.",
|
|
29026
29287
|
properties: {
|
|
29027
29288
|
created_at: {
|
|
29028
29289
|
description: "Date and time at which Seam created the warning.",
|
|
@@ -29058,7 +29319,7 @@ var openapi = {
|
|
|
29058
29319
|
type: "string"
|
|
29059
29320
|
},
|
|
29060
29321
|
workspace_id: {
|
|
29061
|
-
description: "ID of the
|
|
29322
|
+
description: "ID of the workspace associated with the event.",
|
|
29062
29323
|
format: "uuid",
|
|
29063
29324
|
type: "string"
|
|
29064
29325
|
}
|
|
@@ -29080,7 +29341,7 @@ var openapi = {
|
|
|
29080
29341
|
"x-route-path": "/devices"
|
|
29081
29342
|
},
|
|
29082
29343
|
{
|
|
29083
|
-
description: "A third-party subscription is active or no longer required to use all
|
|
29344
|
+
description: "A third-party subscription is active or no longer required to use all device features.",
|
|
29084
29345
|
properties: {
|
|
29085
29346
|
connected_account_custom_metadata: {
|
|
29086
29347
|
additionalProperties: {
|
|
@@ -29090,7 +29351,7 @@ var openapi = {
|
|
|
29090
29351
|
type: "object"
|
|
29091
29352
|
},
|
|
29092
29353
|
connected_account_id: {
|
|
29093
|
-
description: "ID of the
|
|
29354
|
+
description: "ID of the connected account associated with the event.",
|
|
29094
29355
|
format: "uuid",
|
|
29095
29356
|
type: "string"
|
|
29096
29357
|
},
|
|
@@ -29130,7 +29391,7 @@ var openapi = {
|
|
|
29130
29391
|
type: "string"
|
|
29131
29392
|
},
|
|
29132
29393
|
workspace_id: {
|
|
29133
|
-
description: "ID of the
|
|
29394
|
+
description: "ID of the workspace associated with the event.",
|
|
29134
29395
|
format: "uuid",
|
|
29135
29396
|
type: "string"
|
|
29136
29397
|
}
|
|
@@ -29148,7 +29409,7 @@ var openapi = {
|
|
|
29148
29409
|
"x-route-path": "/devices"
|
|
29149
29410
|
},
|
|
29150
29411
|
{
|
|
29151
|
-
description: "An accessory keypad was connected to a
|
|
29412
|
+
description: "An accessory keypad was connected to a device.",
|
|
29152
29413
|
properties: {
|
|
29153
29414
|
connected_account_custom_metadata: {
|
|
29154
29415
|
additionalProperties: {
|
|
@@ -29158,7 +29419,7 @@ var openapi = {
|
|
|
29158
29419
|
type: "object"
|
|
29159
29420
|
},
|
|
29160
29421
|
connected_account_id: {
|
|
29161
|
-
description: "ID of the
|
|
29422
|
+
description: "ID of the connected account associated with the event.",
|
|
29162
29423
|
format: "uuid",
|
|
29163
29424
|
type: "string"
|
|
29164
29425
|
},
|
|
@@ -29198,7 +29459,7 @@ var openapi = {
|
|
|
29198
29459
|
type: "string"
|
|
29199
29460
|
},
|
|
29200
29461
|
workspace_id: {
|
|
29201
|
-
description: "ID of the
|
|
29462
|
+
description: "ID of the workspace associated with the event.",
|
|
29202
29463
|
format: "uuid",
|
|
29203
29464
|
type: "string"
|
|
29204
29465
|
}
|
|
@@ -29216,7 +29477,7 @@ var openapi = {
|
|
|
29216
29477
|
"x-route-path": "/devices"
|
|
29217
29478
|
},
|
|
29218
29479
|
{
|
|
29219
|
-
description: "An accessory keypad was disconnected from a
|
|
29480
|
+
description: "An accessory keypad was disconnected from a device.",
|
|
29220
29481
|
properties: {
|
|
29221
29482
|
connected_account_custom_metadata: {
|
|
29222
29483
|
additionalProperties: {
|
|
@@ -29228,6 +29489,7 @@ var openapi = {
|
|
|
29228
29489
|
connected_account_errors: {
|
|
29229
29490
|
description: "Errors associated with the connected account.",
|
|
29230
29491
|
items: {
|
|
29492
|
+
description: "Error associated with the resource, including the error code, message, and creation timestamp.",
|
|
29231
29493
|
properties: {
|
|
29232
29494
|
created_at: {
|
|
29233
29495
|
description: "Date and time at which Seam created the error.",
|
|
@@ -29249,13 +29511,14 @@ var openapi = {
|
|
|
29249
29511
|
type: "array"
|
|
29250
29512
|
},
|
|
29251
29513
|
connected_account_id: {
|
|
29252
|
-
description: "ID of the
|
|
29514
|
+
description: "ID of the connected account associated with the event.",
|
|
29253
29515
|
format: "uuid",
|
|
29254
29516
|
type: "string"
|
|
29255
29517
|
},
|
|
29256
29518
|
connected_account_warnings: {
|
|
29257
29519
|
description: "Warnings associated with the connected account.",
|
|
29258
29520
|
items: {
|
|
29521
|
+
description: "Warning associated with the resource, including the warning code, message, and creation timestamp.",
|
|
29259
29522
|
properties: {
|
|
29260
29523
|
created_at: {
|
|
29261
29524
|
description: "Date and time at which Seam created the warning.",
|
|
@@ -29295,6 +29558,7 @@ var openapi = {
|
|
|
29295
29558
|
device_errors: {
|
|
29296
29559
|
description: "Errors associated with the device.",
|
|
29297
29560
|
items: {
|
|
29561
|
+
description: "Error associated with the resource, including the error code, message, and creation timestamp.",
|
|
29298
29562
|
properties: {
|
|
29299
29563
|
created_at: {
|
|
29300
29564
|
description: "Date and time at which Seam created the error.",
|
|
@@ -29323,6 +29587,7 @@ var openapi = {
|
|
|
29323
29587
|
device_warnings: {
|
|
29324
29588
|
description: "Warnings associated with the device.",
|
|
29325
29589
|
items: {
|
|
29590
|
+
description: "Warning associated with the resource, including the warning code, message, and creation timestamp.",
|
|
29326
29591
|
properties: {
|
|
29327
29592
|
created_at: {
|
|
29328
29593
|
description: "Date and time at which Seam created the warning.",
|
|
@@ -29358,7 +29623,7 @@ var openapi = {
|
|
|
29358
29623
|
type: "string"
|
|
29359
29624
|
},
|
|
29360
29625
|
workspace_id: {
|
|
29361
|
-
description: "ID of the
|
|
29626
|
+
description: "ID of the workspace associated with the event.",
|
|
29362
29627
|
format: "uuid",
|
|
29363
29628
|
type: "string"
|
|
29364
29629
|
}
|
|
@@ -29390,7 +29655,7 @@ var openapi = {
|
|
|
29390
29655
|
type: "object"
|
|
29391
29656
|
},
|
|
29392
29657
|
connected_account_id: {
|
|
29393
|
-
description: "ID of the
|
|
29658
|
+
description: "ID of the connected account associated with the event.",
|
|
29394
29659
|
format: "uuid",
|
|
29395
29660
|
type: "string"
|
|
29396
29661
|
},
|
|
@@ -29459,7 +29724,7 @@ var openapi = {
|
|
|
29459
29724
|
type: "string"
|
|
29460
29725
|
},
|
|
29461
29726
|
workspace_id: {
|
|
29462
|
-
description: "ID of the
|
|
29727
|
+
description: "ID of the workspace associated with the event.",
|
|
29463
29728
|
format: "uuid",
|
|
29464
29729
|
type: "string"
|
|
29465
29730
|
}
|
|
@@ -29501,7 +29766,7 @@ var openapi = {
|
|
|
29501
29766
|
type: "object"
|
|
29502
29767
|
},
|
|
29503
29768
|
connected_account_id: {
|
|
29504
|
-
description: "ID of the
|
|
29769
|
+
description: "ID of the connected account associated with the event.",
|
|
29505
29770
|
format: "uuid",
|
|
29506
29771
|
type: "string"
|
|
29507
29772
|
},
|
|
@@ -29551,7 +29816,7 @@ var openapi = {
|
|
|
29551
29816
|
type: "string"
|
|
29552
29817
|
},
|
|
29553
29818
|
workspace_id: {
|
|
29554
|
-
description: "ID of the
|
|
29819
|
+
description: "ID of the workspace associated with the event.",
|
|
29555
29820
|
format: "uuid",
|
|
29556
29821
|
type: "string"
|
|
29557
29822
|
}
|
|
@@ -29609,7 +29874,7 @@ var openapi = {
|
|
|
29609
29874
|
type: "object"
|
|
29610
29875
|
},
|
|
29611
29876
|
connected_account_id: {
|
|
29612
|
-
description: "ID of the
|
|
29877
|
+
description: "ID of the connected account associated with the event.",
|
|
29613
29878
|
format: "uuid",
|
|
29614
29879
|
type: "string"
|
|
29615
29880
|
},
|
|
@@ -29664,7 +29929,7 @@ var openapi = {
|
|
|
29664
29929
|
type: "string"
|
|
29665
29930
|
},
|
|
29666
29931
|
workspace_id: {
|
|
29667
|
-
description: "ID of the
|
|
29932
|
+
description: "ID of the workspace associated with the event.",
|
|
29668
29933
|
format: "uuid",
|
|
29669
29934
|
type: "string"
|
|
29670
29935
|
}
|
|
@@ -29697,7 +29962,7 @@ var openapi = {
|
|
|
29697
29962
|
type: "object"
|
|
29698
29963
|
},
|
|
29699
29964
|
connected_account_id: {
|
|
29700
|
-
description: "ID of the
|
|
29965
|
+
description: "ID of the connected account associated with the event.",
|
|
29701
29966
|
format: "uuid",
|
|
29702
29967
|
type: "string"
|
|
29703
29968
|
},
|
|
@@ -29734,7 +29999,7 @@ var openapi = {
|
|
|
29734
29999
|
type: "string"
|
|
29735
30000
|
},
|
|
29736
30001
|
workspace_id: {
|
|
29737
|
-
description: "ID of the
|
|
30002
|
+
description: "ID of the workspace associated with the event.",
|
|
29738
30003
|
format: "uuid",
|
|
29739
30004
|
type: "string"
|
|
29740
30005
|
}
|
|
@@ -29766,7 +30031,7 @@ var openapi = {
|
|
|
29766
30031
|
type: "object"
|
|
29767
30032
|
},
|
|
29768
30033
|
connected_account_id: {
|
|
29769
|
-
description: "ID of the
|
|
30034
|
+
description: "ID of the connected account associated with the event.",
|
|
29770
30035
|
format: "uuid",
|
|
29771
30036
|
type: "string"
|
|
29772
30037
|
},
|
|
@@ -29816,7 +30081,7 @@ var openapi = {
|
|
|
29816
30081
|
type: "string"
|
|
29817
30082
|
},
|
|
29818
30083
|
workspace_id: {
|
|
29819
|
-
description: "ID of the
|
|
30084
|
+
description: "ID of the workspace associated with the event.",
|
|
29820
30085
|
format: "uuid",
|
|
29821
30086
|
type: "string"
|
|
29822
30087
|
}
|
|
@@ -29847,7 +30112,7 @@ var openapi = {
|
|
|
29847
30112
|
type: "object"
|
|
29848
30113
|
},
|
|
29849
30114
|
connected_account_id: {
|
|
29850
|
-
description: "ID of the
|
|
30115
|
+
description: "ID of the connected account associated with the event.",
|
|
29851
30116
|
format: "uuid",
|
|
29852
30117
|
type: "string"
|
|
29853
30118
|
},
|
|
@@ -29922,7 +30187,7 @@ var openapi = {
|
|
|
29922
30187
|
type: "string"
|
|
29923
30188
|
},
|
|
29924
30189
|
workspace_id: {
|
|
29925
|
-
description: "ID of the
|
|
30190
|
+
description: "ID of the workspace associated with the event.",
|
|
29926
30191
|
format: "uuid",
|
|
29927
30192
|
type: "string"
|
|
29928
30193
|
}
|
|
@@ -29951,7 +30216,7 @@ var openapi = {
|
|
|
29951
30216
|
type: "object"
|
|
29952
30217
|
},
|
|
29953
30218
|
connected_account_id: {
|
|
29954
|
-
description: "ID of the
|
|
30219
|
+
description: "ID of the connected account associated with the event.",
|
|
29955
30220
|
format: "uuid",
|
|
29956
30221
|
type: "string"
|
|
29957
30222
|
},
|
|
@@ -30025,7 +30290,7 @@ var openapi = {
|
|
|
30025
30290
|
type: "number"
|
|
30026
30291
|
},
|
|
30027
30292
|
workspace_id: {
|
|
30028
|
-
description: "ID of the
|
|
30293
|
+
description: "ID of the workspace associated with the event.",
|
|
30029
30294
|
format: "uuid",
|
|
30030
30295
|
type: "string"
|
|
30031
30296
|
}
|
|
@@ -30059,7 +30324,7 @@ var openapi = {
|
|
|
30059
30324
|
type: "object"
|
|
30060
30325
|
},
|
|
30061
30326
|
connected_account_id: {
|
|
30062
|
-
description: "ID of the
|
|
30327
|
+
description: "ID of the connected account associated with the event.",
|
|
30063
30328
|
format: "uuid",
|
|
30064
30329
|
type: "string"
|
|
30065
30330
|
},
|
|
@@ -30133,7 +30398,7 @@ var openapi = {
|
|
|
30133
30398
|
type: "number"
|
|
30134
30399
|
},
|
|
30135
30400
|
workspace_id: {
|
|
30136
|
-
description: "ID of the
|
|
30401
|
+
description: "ID of the workspace associated with the event.",
|
|
30137
30402
|
format: "uuid",
|
|
30138
30403
|
type: "string"
|
|
30139
30404
|
}
|
|
@@ -30167,7 +30432,7 @@ var openapi = {
|
|
|
30167
30432
|
type: "object"
|
|
30168
30433
|
},
|
|
30169
30434
|
connected_account_id: {
|
|
30170
|
-
description: "ID of the
|
|
30435
|
+
description: "ID of the connected account associated with the event.",
|
|
30171
30436
|
format: "uuid",
|
|
30172
30437
|
type: "string"
|
|
30173
30438
|
},
|
|
@@ -30227,7 +30492,7 @@ var openapi = {
|
|
|
30227
30492
|
type: "number"
|
|
30228
30493
|
},
|
|
30229
30494
|
workspace_id: {
|
|
30230
|
-
description: "ID of the
|
|
30495
|
+
description: "ID of the workspace associated with the event.",
|
|
30231
30496
|
format: "uuid",
|
|
30232
30497
|
type: "string"
|
|
30233
30498
|
}
|
|
@@ -30257,7 +30522,7 @@ var openapi = {
|
|
|
30257
30522
|
type: "object"
|
|
30258
30523
|
},
|
|
30259
30524
|
connected_account_id: {
|
|
30260
|
-
description: "ID of the
|
|
30525
|
+
description: "ID of the connected account associated with the event.",
|
|
30261
30526
|
format: "uuid",
|
|
30262
30527
|
type: "string"
|
|
30263
30528
|
},
|
|
@@ -30307,7 +30572,7 @@ var openapi = {
|
|
|
30307
30572
|
type: "number"
|
|
30308
30573
|
},
|
|
30309
30574
|
workspace_id: {
|
|
30310
|
-
description: "ID of the
|
|
30575
|
+
description: "ID of the workspace associated with the event.",
|
|
30311
30576
|
format: "uuid",
|
|
30312
30577
|
type: "string"
|
|
30313
30578
|
}
|
|
@@ -30327,7 +30592,7 @@ var openapi = {
|
|
|
30327
30592
|
"x-route-path": "/thermostats"
|
|
30328
30593
|
},
|
|
30329
30594
|
{
|
|
30330
|
-
description: "The name of a
|
|
30595
|
+
description: "The name of a device was changed.",
|
|
30331
30596
|
properties: {
|
|
30332
30597
|
connected_account_custom_metadata: {
|
|
30333
30598
|
additionalProperties: {
|
|
@@ -30337,7 +30602,7 @@ var openapi = {
|
|
|
30337
30602
|
type: "object"
|
|
30338
30603
|
},
|
|
30339
30604
|
connected_account_id: {
|
|
30340
|
-
description: "ID of the
|
|
30605
|
+
description: "ID of the connected account associated with the event.",
|
|
30341
30606
|
format: "uuid",
|
|
30342
30607
|
type: "string"
|
|
30343
30608
|
},
|
|
@@ -30378,7 +30643,7 @@ var openapi = {
|
|
|
30378
30643
|
type: "string"
|
|
30379
30644
|
},
|
|
30380
30645
|
workspace_id: {
|
|
30381
|
-
description: "ID of the
|
|
30646
|
+
description: "ID of the workspace associated with the event.",
|
|
30382
30647
|
format: "uuid",
|
|
30383
30648
|
type: "string"
|
|
30384
30649
|
}
|
|
@@ -30397,7 +30662,7 @@ var openapi = {
|
|
|
30397
30662
|
"x-route-path": "/devices"
|
|
30398
30663
|
},
|
|
30399
30664
|
{
|
|
30400
|
-
description: "A
|
|
30665
|
+
description: "A camera was activated, for example, by motion detection.",
|
|
30401
30666
|
properties: {
|
|
30402
30667
|
activation_reason: {
|
|
30403
30668
|
description: "The reason the camera was activated.",
|
|
@@ -30412,7 +30677,7 @@ var openapi = {
|
|
|
30412
30677
|
type: "object"
|
|
30413
30678
|
},
|
|
30414
30679
|
connected_account_id: {
|
|
30415
|
-
description: "ID of the
|
|
30680
|
+
description: "ID of the connected account associated with the event.",
|
|
30416
30681
|
format: "uuid",
|
|
30417
30682
|
type: "string"
|
|
30418
30683
|
},
|
|
@@ -30464,7 +30729,7 @@ var openapi = {
|
|
|
30464
30729
|
type: "string"
|
|
30465
30730
|
},
|
|
30466
30731
|
workspace_id: {
|
|
30467
|
-
description: "ID of the
|
|
30732
|
+
description: "ID of the workspace associated with the event.",
|
|
30468
30733
|
format: "uuid",
|
|
30469
30734
|
type: "string"
|
|
30470
30735
|
}
|
|
@@ -30483,7 +30748,7 @@ var openapi = {
|
|
|
30483
30748
|
"x-route-path": "/devices"
|
|
30484
30749
|
},
|
|
30485
30750
|
{
|
|
30486
|
-
description: "A doorbell button was pressed on a
|
|
30751
|
+
description: "A doorbell button was pressed on a device.",
|
|
30487
30752
|
properties: {
|
|
30488
30753
|
connected_account_custom_metadata: {
|
|
30489
30754
|
additionalProperties: {
|
|
@@ -30493,7 +30758,7 @@ var openapi = {
|
|
|
30493
30758
|
type: "object"
|
|
30494
30759
|
},
|
|
30495
30760
|
connected_account_id: {
|
|
30496
|
-
description: "ID of the
|
|
30761
|
+
description: "ID of the connected account associated with the event.",
|
|
30497
30762
|
format: "uuid",
|
|
30498
30763
|
type: "string"
|
|
30499
30764
|
},
|
|
@@ -30540,7 +30805,7 @@ var openapi = {
|
|
|
30540
30805
|
type: "string"
|
|
30541
30806
|
},
|
|
30542
30807
|
workspace_id: {
|
|
30543
|
-
description: "ID of the
|
|
30808
|
+
description: "ID of the workspace associated with the event.",
|
|
30544
30809
|
format: "uuid",
|
|
30545
30810
|
type: "string"
|
|
30546
30811
|
}
|
|
@@ -30585,7 +30850,7 @@ var openapi = {
|
|
|
30585
30850
|
type: "string"
|
|
30586
30851
|
},
|
|
30587
30852
|
workspace_id: {
|
|
30588
|
-
description: "ID of the
|
|
30853
|
+
description: "ID of the workspace associated with the event.",
|
|
30589
30854
|
format: "uuid",
|
|
30590
30855
|
type: "string"
|
|
30591
30856
|
}
|
|
@@ -30633,7 +30898,7 @@ var openapi = {
|
|
|
30633
30898
|
type: "string"
|
|
30634
30899
|
},
|
|
30635
30900
|
workspace_id: {
|
|
30636
|
-
description: "ID of the
|
|
30901
|
+
description: "ID of the workspace associated with the event.",
|
|
30637
30902
|
format: "uuid",
|
|
30638
30903
|
type: "string"
|
|
30639
30904
|
}
|
|
@@ -30692,7 +30957,7 @@ var openapi = {
|
|
|
30692
30957
|
type: "string"
|
|
30693
30958
|
},
|
|
30694
30959
|
workspace_id: {
|
|
30695
|
-
description: "ID of the
|
|
30960
|
+
description: "ID of the workspace associated with the event.",
|
|
30696
30961
|
format: "uuid",
|
|
30697
30962
|
type: "string"
|
|
30698
30963
|
}
|
|
@@ -30753,7 +31018,7 @@ var openapi = {
|
|
|
30753
31018
|
type: "string"
|
|
30754
31019
|
},
|
|
30755
31020
|
workspace_id: {
|
|
30756
|
-
description: "ID of the
|
|
31021
|
+
description: "ID of the workspace associated with the event.",
|
|
30757
31022
|
format: "uuid",
|
|
30758
31023
|
type: "string"
|
|
30759
31024
|
}
|
|
@@ -30814,7 +31079,7 @@ var openapi = {
|
|
|
30814
31079
|
type: "string"
|
|
30815
31080
|
},
|
|
30816
31081
|
workspace_id: {
|
|
30817
|
-
description: "ID of the
|
|
31082
|
+
description: "ID of the workspace associated with the event.",
|
|
30818
31083
|
format: "uuid",
|
|
30819
31084
|
type: "string"
|
|
30820
31085
|
}
|
|
@@ -30839,7 +31104,7 @@ var openapi = {
|
|
|
30839
31104
|
description: "Represents a Seam Instant Key. For issuing Bluetooth mobile keys, Instant Keys are the fastest way to share access. With a single API call, you can create a mobile key and send it through text or email or embed it in your own app.\n\nThere\u2019s no app to install, nor account to create. Your user just taps a link and gets a lightweight, native-feeling experience using iOS App Clip or Instant Apps on Android. Further, Instant Keys work offline, so even in areas with poor cellular or Wi-Fi, like elevator banks or concrete-walled hallways, the Instant Keys still work.",
|
|
30840
31105
|
properties: {
|
|
30841
31106
|
client_session_id: {
|
|
30842
|
-
description: "ID of the
|
|
31107
|
+
description: "ID of the client session associated with the Instant Key.",
|
|
30843
31108
|
format: "uuid",
|
|
30844
31109
|
type: "string"
|
|
30845
31110
|
},
|
|
@@ -30893,7 +31158,7 @@ var openapi = {
|
|
|
30893
31158
|
type: "string"
|
|
30894
31159
|
},
|
|
30895
31160
|
workspace_id: {
|
|
30896
|
-
description: "ID of the
|
|
31161
|
+
description: "ID of the workspace that contains the Instant Key.",
|
|
30897
31162
|
format: "uuid",
|
|
30898
31163
|
type: "string"
|
|
30899
31164
|
}
|
|
@@ -30933,7 +31198,7 @@ var openapi = {
|
|
|
30933
31198
|
type: "string"
|
|
30934
31199
|
},
|
|
30935
31200
|
workspace_id: {
|
|
30936
|
-
description: "ID of the
|
|
31201
|
+
description: "ID of the workspace associated with the magic link.",
|
|
30937
31202
|
format: "uuid",
|
|
30938
31203
|
type: "string"
|
|
30939
31204
|
}
|
|
@@ -31036,7 +31301,7 @@ var openapi = {
|
|
|
31036
31301
|
type: "string"
|
|
31037
31302
|
},
|
|
31038
31303
|
device_type: {
|
|
31039
|
-
description: "
|
|
31304
|
+
description: "Type of the phone device, such as `ios_phone` or `android_phone`.",
|
|
31040
31305
|
enum: ["ios_phone", "android_phone"],
|
|
31041
31306
|
type: "string"
|
|
31042
31307
|
},
|
|
@@ -31048,8 +31313,14 @@ var openapi = {
|
|
|
31048
31313
|
description: "Errors associated with the phone.",
|
|
31049
31314
|
items: {
|
|
31050
31315
|
properties: {
|
|
31051
|
-
error_code: {
|
|
31052
|
-
|
|
31316
|
+
error_code: {
|
|
31317
|
+
description: "Unique identifier of the type of error.",
|
|
31318
|
+
type: "string"
|
|
31319
|
+
},
|
|
31320
|
+
message: {
|
|
31321
|
+
description: "Detailed description of the error.",
|
|
31322
|
+
type: "string"
|
|
31323
|
+
}
|
|
31053
31324
|
},
|
|
31054
31325
|
required: ["error_code", "message"],
|
|
31055
31326
|
type: "object"
|
|
@@ -31061,7 +31332,7 @@ var openapi = {
|
|
|
31061
31332
|
type: "string"
|
|
31062
31333
|
},
|
|
31063
31334
|
properties: {
|
|
31064
|
-
description: "
|
|
31335
|
+
description: "Properties of the phone.",
|
|
31065
31336
|
properties: {
|
|
31066
31337
|
assa_abloy_credential_service_metadata: {
|
|
31067
31338
|
description: "ASSA ABLOY Credential Service metadata for the phone.",
|
|
@@ -31110,8 +31381,14 @@ var openapi = {
|
|
|
31110
31381
|
description: "Warnings associated with the phone.",
|
|
31111
31382
|
items: {
|
|
31112
31383
|
properties: {
|
|
31113
|
-
message: {
|
|
31114
|
-
|
|
31384
|
+
message: {
|
|
31385
|
+
description: "Detailed description of the warning.",
|
|
31386
|
+
type: "string"
|
|
31387
|
+
},
|
|
31388
|
+
warning_code: {
|
|
31389
|
+
description: "Unique identifier of the type of warning.",
|
|
31390
|
+
type: "string"
|
|
31391
|
+
}
|
|
31115
31392
|
},
|
|
31116
31393
|
required: ["warning_code", "message"],
|
|
31117
31394
|
type: "object"
|
|
@@ -31119,7 +31396,7 @@ var openapi = {
|
|
|
31119
31396
|
type: "array"
|
|
31120
31397
|
},
|
|
31121
31398
|
workspace_id: {
|
|
31122
|
-
description: "ID of the
|
|
31399
|
+
description: "ID of the workspace that contains the phone.\n ",
|
|
31123
31400
|
format: "uuid",
|
|
31124
31401
|
type: "string"
|
|
31125
31402
|
}
|
|
@@ -31190,6 +31467,7 @@ var openapi = {
|
|
|
31190
31467
|
},
|
|
31191
31468
|
acs_credential_id: { nullable: true, type: "string" },
|
|
31192
31469
|
acs_credential_pool_id: {
|
|
31470
|
+
description: "ID of the credential pool to which the credential belongs.",
|
|
31193
31471
|
format: "uuid",
|
|
31194
31472
|
type: "string"
|
|
31195
31473
|
},
|
|
@@ -31800,7 +32078,11 @@ var openapi = {
|
|
|
31800
32078
|
nullable: true,
|
|
31801
32079
|
type: "boolean"
|
|
31802
32080
|
},
|
|
31803
|
-
is_managed: {
|
|
32081
|
+
is_managed: {
|
|
32082
|
+
description: "Indicates whether Seam manages the credential.",
|
|
32083
|
+
enum: [true],
|
|
32084
|
+
type: "boolean"
|
|
32085
|
+
},
|
|
31804
32086
|
is_multi_phone_sync_credential: {
|
|
31805
32087
|
description: "Indicates whether the [credential](https://docs.seam.co/low-level-apis/access-systems/managing-credentials) is a [multi-phone sync credential](https://docs.seam.co/capability-guides/mobile-access/issuing-mobile-credentials-from-an-access-control-system#what-are-multi-phone-sync-credentials).",
|
|
31806
32088
|
type: "boolean"
|
|
@@ -32039,7 +32321,7 @@ var openapi = {
|
|
|
32039
32321
|
type: "array"
|
|
32040
32322
|
},
|
|
32041
32323
|
workspace_id: {
|
|
32042
|
-
description: "ID of the
|
|
32324
|
+
description: "ID of the workspace that contains the [credential](https://docs.seam.co/low-level-apis/access-systems/managing-credentials).",
|
|
32043
32325
|
format: "uuid",
|
|
32044
32326
|
type: "string"
|
|
32045
32327
|
}
|
|
@@ -32110,7 +32392,11 @@ var openapi = {
|
|
|
32110
32392
|
format: "date-time",
|
|
32111
32393
|
type: "string"
|
|
32112
32394
|
},
|
|
32113
|
-
display_name: {
|
|
32395
|
+
display_name: {
|
|
32396
|
+
description: "Display name for the user identity.",
|
|
32397
|
+
minLength: 1,
|
|
32398
|
+
type: "string"
|
|
32399
|
+
},
|
|
32114
32400
|
email_address: {
|
|
32115
32401
|
description: "Unique email address for the user identity.",
|
|
32116
32402
|
format: "email",
|
|
@@ -32164,7 +32450,12 @@ var openapi = {
|
|
|
32164
32450
|
},
|
|
32165
32451
|
type: "array"
|
|
32166
32452
|
},
|
|
32167
|
-
full_name: {
|
|
32453
|
+
full_name: {
|
|
32454
|
+
description: "Full name of the user associated with the user identity.",
|
|
32455
|
+
minLength: 1,
|
|
32456
|
+
nullable: true,
|
|
32457
|
+
type: "string"
|
|
32458
|
+
},
|
|
32168
32459
|
phone_number: {
|
|
32169
32460
|
description: "Unique phone number for the user identity in [E.164 format](https://www.itu.int/rec/T-REC-E.164/en) (for example, +15555550100).",
|
|
32170
32461
|
nullable: true,
|
|
@@ -32236,7 +32527,7 @@ var openapi = {
|
|
|
32236
32527
|
type: "array"
|
|
32237
32528
|
},
|
|
32238
32529
|
workspace_id: {
|
|
32239
|
-
description: "ID of the
|
|
32530
|
+
description: "ID of the workspace that contains the user identity.",
|
|
32240
32531
|
format: "uuid",
|
|
32241
32532
|
type: "string"
|
|
32242
32533
|
}
|
|
@@ -32360,7 +32651,7 @@ var openapi = {
|
|
|
32360
32651
|
type: "string"
|
|
32361
32652
|
},
|
|
32362
32653
|
workspace_id: {
|
|
32363
|
-
description: "ID of the
|
|
32654
|
+
description: "ID of the workspace associated with the space.",
|
|
32364
32655
|
format: "uuid",
|
|
32365
32656
|
type: "string"
|
|
32366
32657
|
}
|
|
@@ -32497,7 +32788,7 @@ var openapi = {
|
|
|
32497
32788
|
type: "string"
|
|
32498
32789
|
},
|
|
32499
32790
|
workspace_id: {
|
|
32500
|
-
description: "ID of the
|
|
32791
|
+
description: "ID of the workspace that contains the thermostat daily program.",
|
|
32501
32792
|
format: "uuid",
|
|
32502
32793
|
type: "string"
|
|
32503
32794
|
}
|
|
@@ -32580,7 +32871,7 @@ var openapi = {
|
|
|
32580
32871
|
type: "string"
|
|
32581
32872
|
},
|
|
32582
32873
|
workspace_id: {
|
|
32583
|
-
description: "ID of the
|
|
32874
|
+
description: "ID of the workspace that contains the thermostat schedule.",
|
|
32584
32875
|
format: "uuid",
|
|
32585
32876
|
type: "string"
|
|
32586
32877
|
}
|
|
@@ -33969,7 +34260,7 @@ var openapi = {
|
|
|
33969
34260
|
type: "string"
|
|
33970
34261
|
},
|
|
33971
34262
|
connected_account_id: {
|
|
33972
|
-
description: "ID of the
|
|
34263
|
+
description: "ID of the connected account that contains the access group.",
|
|
33973
34264
|
format: "uuid",
|
|
33974
34265
|
type: "string"
|
|
33975
34266
|
},
|
|
@@ -33978,7 +34269,10 @@ var openapi = {
|
|
|
33978
34269
|
format: "date-time",
|
|
33979
34270
|
type: "string"
|
|
33980
34271
|
},
|
|
33981
|
-
display_name: {
|
|
34272
|
+
display_name: {
|
|
34273
|
+
description: "Display name for the access group.",
|
|
34274
|
+
type: "string"
|
|
34275
|
+
},
|
|
33982
34276
|
errors: {
|
|
33983
34277
|
description: "Errors associated with the `acs_access_group`.",
|
|
33984
34278
|
items: {
|
|
@@ -34411,7 +34705,7 @@ var openapi = {
|
|
|
34411
34705
|
type: "array"
|
|
34412
34706
|
},
|
|
34413
34707
|
workspace_id: {
|
|
34414
|
-
description: "ID of the
|
|
34708
|
+
description: "ID of the workspace that contains the access group.",
|
|
34415
34709
|
format: "uuid",
|
|
34416
34710
|
type: "string"
|
|
34417
34711
|
}
|
|
@@ -34450,7 +34744,11 @@ var openapi = {
|
|
|
34450
34744
|
format: "uuid",
|
|
34451
34745
|
type: "string"
|
|
34452
34746
|
},
|
|
34453
|
-
acs_credential_pool_id: {
|
|
34747
|
+
acs_credential_pool_id: {
|
|
34748
|
+
description: "ID of the credential pool to which the credential belongs.",
|
|
34749
|
+
format: "uuid",
|
|
34750
|
+
type: "string"
|
|
34751
|
+
},
|
|
34454
34752
|
acs_system_id: {
|
|
34455
34753
|
description: "ID of the [access control system](https://docs.seam.co/low-level-apis/access-systems) that contains the [credential](https://docs.seam.co/low-level-apis/access-systems/managing-credentials).",
|
|
34456
34754
|
format: "uuid",
|
|
@@ -34780,7 +35078,7 @@ var openapi = {
|
|
|
34780
35078
|
type: "array"
|
|
34781
35079
|
},
|
|
34782
35080
|
workspace_id: {
|
|
34783
|
-
description: "ID of the
|
|
35081
|
+
description: "ID of the workspace that contains the [credential](https://docs.seam.co/low-level-apis/access-systems/managing-credentials).",
|
|
34784
35082
|
format: "uuid",
|
|
34785
35083
|
type: "string"
|
|
34786
35084
|
}
|
|
@@ -34833,7 +35131,7 @@ var openapi = {
|
|
|
34833
35131
|
type: "string"
|
|
34834
35132
|
},
|
|
34835
35133
|
connected_account_id: {
|
|
34836
|
-
description: "\n The ID of the
|
|
35134
|
+
description: "\n The ID of the connected account that is associated with the [access system user](https://docs.seam.co/low-level-apis/access-systems/user-management).\n ",
|
|
34837
35135
|
format: "uuid",
|
|
34838
35136
|
type: "string"
|
|
34839
35137
|
},
|
|
@@ -35010,7 +35308,11 @@ var openapi = {
|
|
|
35010
35308
|
minLength: 1,
|
|
35011
35309
|
type: "string"
|
|
35012
35310
|
},
|
|
35013
|
-
hid_acs_system_id: {
|
|
35311
|
+
hid_acs_system_id: {
|
|
35312
|
+
description: "ID of the HID access control system associated with the user.",
|
|
35313
|
+
format: "uuid",
|
|
35314
|
+
type: "string"
|
|
35315
|
+
},
|
|
35014
35316
|
is_managed: { enum: [false], type: "boolean" },
|
|
35015
35317
|
is_suspended: {
|
|
35016
35318
|
description: "Indicates whether the [access system user](https://docs.seam.co/low-level-apis/access-systems/user-management) is currently [suspended](https://docs.seam.co/low-level-apis/access-systems/user-management/suspending-and-unsuspending-users).",
|
|
@@ -35543,7 +35845,7 @@ var openapi = {
|
|
|
35543
35845
|
type: "array"
|
|
35544
35846
|
},
|
|
35545
35847
|
workspace_id: {
|
|
35546
|
-
description: "ID of the
|
|
35848
|
+
description: "ID of the workspace that contains the [access system user](https://docs.seam.co/low-level-apis/access-systems/user-management).",
|
|
35547
35849
|
format: "uuid",
|
|
35548
35850
|
type: "string"
|
|
35549
35851
|
}
|
|
@@ -35567,30 +35869,86 @@ var openapi = {
|
|
|
35567
35869
|
unmanaged_device: {
|
|
35568
35870
|
description: "Represents an [unmanaged device](https://docs.seam.co/core-concepts/devices/managed-and-unmanaged-devices). An unmanaged device has a limited set of visible properties and a subset of supported events. You cannot control an unmanaged device. Any [access codes](https://docs.seam.co/low-level-apis/smart-locks/access-codes/migrating-existing-access-codes) on an unmanaged device are unmanaged. To control an unmanaged device with Seam, [convert it to a managed device](https://docs.seam.co/core-concepts/devices/managed-and-unmanaged-devices#convert-an-unmanaged-device-to-managed).",
|
|
35569
35871
|
properties: {
|
|
35570
|
-
can_configure_auto_lock: {
|
|
35571
|
-
|
|
35572
|
-
|
|
35573
|
-
|
|
35574
|
-
|
|
35575
|
-
|
|
35872
|
+
can_configure_auto_lock: {
|
|
35873
|
+
description: "Indicates whether the lock supports configuring automatic locking.",
|
|
35874
|
+
type: "boolean"
|
|
35875
|
+
},
|
|
35876
|
+
can_hvac_cool: {
|
|
35877
|
+
description: "Indicates whether the thermostat supports cooling.",
|
|
35878
|
+
type: "boolean"
|
|
35879
|
+
},
|
|
35880
|
+
can_hvac_heat: {
|
|
35881
|
+
description: "Indicates whether the thermostat supports heating.",
|
|
35882
|
+
type: "boolean"
|
|
35883
|
+
},
|
|
35884
|
+
can_hvac_heat_cool: {
|
|
35885
|
+
description: "Indicates whether the thermostat supports simultaneous heating and cooling.",
|
|
35886
|
+
type: "boolean"
|
|
35887
|
+
},
|
|
35888
|
+
can_program_offline_access_codes: {
|
|
35889
|
+
description: "Indicates whether the device supports programming offline access codes.",
|
|
35890
|
+
type: "boolean"
|
|
35891
|
+
},
|
|
35892
|
+
can_program_online_access_codes: {
|
|
35893
|
+
description: "Indicates whether the device supports programming online access codes.",
|
|
35894
|
+
type: "boolean"
|
|
35895
|
+
},
|
|
35576
35896
|
can_program_thermostat_programs_as_different_each_day: {
|
|
35897
|
+
description: "Indicates whether the thermostat supports different climate programs for each day of the week.",
|
|
35898
|
+
type: "boolean"
|
|
35899
|
+
},
|
|
35900
|
+
can_program_thermostat_programs_as_same_each_day: {
|
|
35901
|
+
description: "Indicates whether the thermostat supports a single climate program applied to every day.",
|
|
35577
35902
|
type: "boolean"
|
|
35578
35903
|
},
|
|
35579
|
-
can_program_thermostat_programs_as_same_each_day: { type: "boolean" },
|
|
35580
35904
|
can_program_thermostat_programs_as_weekday_weekend: {
|
|
35905
|
+
description: "Indicates whether the thermostat supports weekday/weekend climate programs.",
|
|
35906
|
+
type: "boolean"
|
|
35907
|
+
},
|
|
35908
|
+
can_remotely_lock: {
|
|
35909
|
+
description: "Indicates whether the device supports remote locking.",
|
|
35910
|
+
type: "boolean"
|
|
35911
|
+
},
|
|
35912
|
+
can_remotely_unlock: {
|
|
35913
|
+
description: "Indicates whether the device supports remote unlocking.",
|
|
35914
|
+
type: "boolean"
|
|
35915
|
+
},
|
|
35916
|
+
can_run_thermostat_programs: {
|
|
35917
|
+
description: "Indicates whether the thermostat supports running climate programs.",
|
|
35918
|
+
type: "boolean"
|
|
35919
|
+
},
|
|
35920
|
+
can_simulate_connection: {
|
|
35921
|
+
description: "Indicates whether the device supports simulating connection in a sandbox.",
|
|
35922
|
+
type: "boolean"
|
|
35923
|
+
},
|
|
35924
|
+
can_simulate_disconnection: {
|
|
35925
|
+
description: "Indicates whether the device supports simulating disconnection in a sandbox.",
|
|
35926
|
+
type: "boolean"
|
|
35927
|
+
},
|
|
35928
|
+
can_simulate_hub_connection: {
|
|
35929
|
+
description: "Indicates whether the hub supports simulating connection in a sandbox.",
|
|
35930
|
+
type: "boolean"
|
|
35931
|
+
},
|
|
35932
|
+
can_simulate_hub_disconnection: {
|
|
35933
|
+
description: "Indicates whether the hub supports simulating disconnection in a sandbox.",
|
|
35934
|
+
type: "boolean"
|
|
35935
|
+
},
|
|
35936
|
+
can_simulate_paid_subscription: {
|
|
35937
|
+
description: "Indicates whether the device supports simulating a paid subscription in a sandbox.",
|
|
35938
|
+
type: "boolean"
|
|
35939
|
+
},
|
|
35940
|
+
can_simulate_removal: {
|
|
35941
|
+
description: "Indicates whether the device supports simulating removal in a sandbox.",
|
|
35942
|
+
type: "boolean"
|
|
35943
|
+
},
|
|
35944
|
+
can_turn_off_hvac: {
|
|
35945
|
+
description: "Indicates whether the thermostat can be turned off.",
|
|
35946
|
+
type: "boolean"
|
|
35947
|
+
},
|
|
35948
|
+
can_unlock_with_code: {
|
|
35949
|
+
description: "Indicates whether the lock supports unlocking with an access code.",
|
|
35581
35950
|
type: "boolean"
|
|
35582
35951
|
},
|
|
35583
|
-
can_remotely_lock: { type: "boolean" },
|
|
35584
|
-
can_remotely_unlock: { type: "boolean" },
|
|
35585
|
-
can_run_thermostat_programs: { type: "boolean" },
|
|
35586
|
-
can_simulate_connection: { type: "boolean" },
|
|
35587
|
-
can_simulate_disconnection: { type: "boolean" },
|
|
35588
|
-
can_simulate_hub_connection: { type: "boolean" },
|
|
35589
|
-
can_simulate_hub_disconnection: { type: "boolean" },
|
|
35590
|
-
can_simulate_paid_subscription: { type: "boolean" },
|
|
35591
|
-
can_simulate_removal: { type: "boolean" },
|
|
35592
|
-
can_turn_off_hvac: { type: "boolean" },
|
|
35593
|
-
can_unlock_with_code: { type: "boolean" },
|
|
35594
35952
|
capabilities_supported: {
|
|
35595
35953
|
description: "\n Collection of capabilities that the device supports when connected to Seam. Values are `access_code`, which indicates that the device can manage and utilize digital PIN codes for secure access; `lock`, which indicates that the device controls a door locking mechanism, enabling the remote opening and closing of doors and other entry points; `noise_detection`, which indicates that the device supports monitoring and responding to ambient noise levels; `thermostat`, which indicates that the device can regulate and adjust indoor temperatures; `battery`, which indicates that the device can manage battery life and health; and `phone`, which indicates that the device is a mobile device, such as a smartphone. **Important:** Superseded by [capability flags](https://docs.seam.co/capability-guides/device-and-system-capabilities#capability-flags).\n ",
|
|
35596
35954
|
items: {
|
|
@@ -36235,7 +36593,11 @@ var openapi = {
|
|
|
36235
36593
|
thermostats: { name: "Thermostats" }
|
|
36236
36594
|
}
|
|
36237
36595
|
},
|
|
36238
|
-
is_managed: {
|
|
36596
|
+
is_managed: {
|
|
36597
|
+
description: "Indicates that Seam does not manage the device.",
|
|
36598
|
+
enum: [false],
|
|
36599
|
+
type: "boolean"
|
|
36600
|
+
},
|
|
36239
36601
|
location: {
|
|
36240
36602
|
description: "Location information for the device.",
|
|
36241
36603
|
properties: {
|
|
@@ -37044,7 +37406,11 @@ var openapi = {
|
|
|
37044
37406
|
format: "date-time",
|
|
37045
37407
|
type: "string"
|
|
37046
37408
|
},
|
|
37047
|
-
display_name: {
|
|
37409
|
+
display_name: {
|
|
37410
|
+
description: "Display name for the user identity.",
|
|
37411
|
+
minLength: 1,
|
|
37412
|
+
type: "string"
|
|
37413
|
+
},
|
|
37048
37414
|
email_address: {
|
|
37049
37415
|
description: "Unique email address for the user identity.",
|
|
37050
37416
|
format: "email",
|
|
@@ -37098,7 +37464,12 @@ var openapi = {
|
|
|
37098
37464
|
},
|
|
37099
37465
|
type: "array"
|
|
37100
37466
|
},
|
|
37101
|
-
full_name: {
|
|
37467
|
+
full_name: {
|
|
37468
|
+
description: "Full name of the user associated with the user identity.",
|
|
37469
|
+
minLength: 1,
|
|
37470
|
+
nullable: true,
|
|
37471
|
+
type: "string"
|
|
37472
|
+
},
|
|
37102
37473
|
phone_number: {
|
|
37103
37474
|
description: "Unique phone number for the user identity in [E.164 format](https://www.itu.int/rec/T-REC-E.164/en) (for example, +15555550100).",
|
|
37104
37475
|
nullable: true,
|
|
@@ -37168,7 +37539,7 @@ var openapi = {
|
|
|
37168
37539
|
type: "array"
|
|
37169
37540
|
},
|
|
37170
37541
|
workspace_id: {
|
|
37171
|
-
description: "ID of the
|
|
37542
|
+
description: "ID of the workspace that contains the user identity.",
|
|
37172
37543
|
format: "uuid",
|
|
37173
37544
|
type: "string"
|
|
37174
37545
|
}
|
|
@@ -37205,10 +37576,7 @@ var openapi = {
|
|
|
37205
37576
|
description: "URL for the [webhook](https://docs.seam.co/developer-tools/webhooks).",
|
|
37206
37577
|
type: "string"
|
|
37207
37578
|
},
|
|
37208
|
-
webhook_id: {
|
|
37209
|
-
description: "ID of the [webhook](https://docs.seam.co/developer-tools/webhooks).",
|
|
37210
|
-
type: "string"
|
|
37211
|
-
}
|
|
37579
|
+
webhook_id: { description: "ID of the webhook.", type: "string" }
|
|
37212
37580
|
},
|
|
37213
37581
|
required: ["webhook_id", "url"],
|
|
37214
37582
|
type: "object",
|
|
@@ -37270,7 +37638,7 @@ var openapi = {
|
|
|
37270
37638
|
type: "string"
|
|
37271
37639
|
},
|
|
37272
37640
|
organization_id: {
|
|
37273
|
-
description: "ID of the organization to which the
|
|
37641
|
+
description: "ID of the organization to which the workspace belongs, or `null` if the workspace is not assigned to an organization.",
|
|
37274
37642
|
format: "uuid",
|
|
37275
37643
|
nullable: true,
|
|
37276
37644
|
type: "string"
|
|
@@ -37280,7 +37648,7 @@ var openapi = {
|
|
|
37280
37648
|
type: "string"
|
|
37281
37649
|
},
|
|
37282
37650
|
workspace_id: {
|
|
37283
|
-
description: "ID of the
|
|
37651
|
+
description: "ID of the workspace.",
|
|
37284
37652
|
format: "uuid",
|
|
37285
37653
|
type: "string"
|
|
37286
37654
|
}
|
|
@@ -40214,6 +40582,7 @@ var openapi = {
|
|
|
40214
40582
|
type: "string"
|
|
40215
40583
|
},
|
|
40216
40584
|
full_name: {
|
|
40585
|
+
description: "Full name of the user associated with the user identity.",
|
|
40217
40586
|
minLength: 1,
|
|
40218
40587
|
nullable: true,
|
|
40219
40588
|
type: "string"
|
|
@@ -52493,7 +52862,11 @@ var openapi = {
|
|
|
52493
52862
|
minLength: 1,
|
|
52494
52863
|
type: "string"
|
|
52495
52864
|
},
|
|
52496
|
-
hid_acs_system_id: {
|
|
52865
|
+
hid_acs_system_id: {
|
|
52866
|
+
description: "ID of the HID access control system associated with the user.",
|
|
52867
|
+
format: "uuid",
|
|
52868
|
+
type: "string"
|
|
52869
|
+
},
|
|
52497
52870
|
phone_number: {
|
|
52498
52871
|
description: "Phone number of the [access system user](https://docs.seam.co/low-level-apis/access-systems/user-management) in E.164 format (for example, `+15555550100`).",
|
|
52499
52872
|
type: "string"
|
|
@@ -52589,7 +52962,11 @@ var openapi = {
|
|
|
52589
52962
|
minLength: 1,
|
|
52590
52963
|
type: "string"
|
|
52591
52964
|
},
|
|
52592
|
-
hid_acs_system_id: {
|
|
52965
|
+
hid_acs_system_id: {
|
|
52966
|
+
description: "ID of the HID access control system associated with the user.",
|
|
52967
|
+
format: "uuid",
|
|
52968
|
+
type: "string"
|
|
52969
|
+
},
|
|
52593
52970
|
phone_number: {
|
|
52594
52971
|
description: "Phone number of the [access system user](https://docs.seam.co/low-level-apis/access-systems/user-management) in E.164 format (for example, `+15555550100`).",
|
|
52595
52972
|
type: "string"
|
|
@@ -52932,7 +53309,7 @@ var openapi = {
|
|
|
52932
53309
|
type: "string"
|
|
52933
53310
|
},
|
|
52934
53311
|
workspace_id: {
|
|
52935
|
-
description: "ID of the
|
|
53312
|
+
description: "ID of the workspace that contains Seam Bridge.",
|
|
52936
53313
|
format: "uuid",
|
|
52937
53314
|
type: "string"
|
|
52938
53315
|
}
|
|
@@ -53008,7 +53385,7 @@ var openapi = {
|
|
|
53008
53385
|
type: "string"
|
|
53009
53386
|
},
|
|
53010
53387
|
workspace_id: {
|
|
53011
|
-
description: "ID of the
|
|
53388
|
+
description: "ID of the workspace that contains Seam Bridge.",
|
|
53012
53389
|
format: "uuid",
|
|
53013
53390
|
type: "string"
|
|
53014
53391
|
}
|
|
@@ -53071,7 +53448,7 @@ var openapi = {
|
|
|
53071
53448
|
type: "string"
|
|
53072
53449
|
},
|
|
53073
53450
|
workspace_id: {
|
|
53074
|
-
description: "ID of the
|
|
53451
|
+
description: "ID of the workspace that contains Seam Bridge.",
|
|
53075
53452
|
format: "uuid",
|
|
53076
53453
|
type: "string"
|
|
53077
53454
|
}
|
|
@@ -53138,7 +53515,7 @@ var openapi = {
|
|
|
53138
53515
|
type: "string"
|
|
53139
53516
|
},
|
|
53140
53517
|
workspace_id: {
|
|
53141
|
-
description: "ID of the
|
|
53518
|
+
description: "ID of the workspace that contains Seam Bridge.",
|
|
53142
53519
|
format: "uuid",
|
|
53143
53520
|
type: "string"
|
|
53144
53521
|
}
|
|
@@ -82398,6 +82775,7 @@ var openapi = {
|
|
|
82398
82775
|
},
|
|
82399
82776
|
fan_mode: {
|
|
82400
82777
|
deprecated: true,
|
|
82778
|
+
description: "Fan mode setting for the thermostat, such as `auto`, `on`, or `circulate`.",
|
|
82401
82779
|
enum: ["auto", "on", "circulate"],
|
|
82402
82780
|
type: "string",
|
|
82403
82781
|
"x-deprecated": "Use `fan_mode_setting` instead."
|
|
@@ -85687,7 +86065,11 @@ var openapi = {
|
|
|
85687
86065
|
format: "date-time",
|
|
85688
86066
|
type: "string"
|
|
85689
86067
|
},
|
|
85690
|
-
display_name: {
|
|
86068
|
+
display_name: {
|
|
86069
|
+
description: "Display name for the user identity.",
|
|
86070
|
+
minLength: 1,
|
|
86071
|
+
type: "string"
|
|
86072
|
+
},
|
|
85691
86073
|
email_address: {
|
|
85692
86074
|
description: "Unique email address for the user identity.",
|
|
85693
86075
|
format: "email",
|
|
@@ -85742,6 +86124,7 @@ var openapi = {
|
|
|
85742
86124
|
type: "array"
|
|
85743
86125
|
},
|
|
85744
86126
|
full_name: {
|
|
86127
|
+
description: "Full name of the user associated with the user identity.",
|
|
85745
86128
|
minLength: 1,
|
|
85746
86129
|
nullable: true,
|
|
85747
86130
|
type: "string"
|
|
@@ -85819,7 +86202,7 @@ var openapi = {
|
|
|
85819
86202
|
type: "array"
|
|
85820
86203
|
},
|
|
85821
86204
|
workspace_id: {
|
|
85822
|
-
description: "ID of the
|
|
86205
|
+
description: "ID of the workspace that contains the user identity.",
|
|
85823
86206
|
format: "uuid",
|
|
85824
86207
|
type: "string"
|
|
85825
86208
|
}
|
|
@@ -85904,7 +86287,11 @@ var openapi = {
|
|
|
85904
86287
|
format: "date-time",
|
|
85905
86288
|
type: "string"
|
|
85906
86289
|
},
|
|
85907
|
-
display_name: {
|
|
86290
|
+
display_name: {
|
|
86291
|
+
description: "Display name for the user identity.",
|
|
86292
|
+
minLength: 1,
|
|
86293
|
+
type: "string"
|
|
86294
|
+
},
|
|
85908
86295
|
email_address: {
|
|
85909
86296
|
description: "Unique email address for the user identity.",
|
|
85910
86297
|
format: "email",
|
|
@@ -85959,6 +86346,7 @@ var openapi = {
|
|
|
85959
86346
|
type: "array"
|
|
85960
86347
|
},
|
|
85961
86348
|
full_name: {
|
|
86349
|
+
description: "Full name of the user associated with the user identity.",
|
|
85962
86350
|
minLength: 1,
|
|
85963
86351
|
nullable: true,
|
|
85964
86352
|
type: "string"
|
|
@@ -86036,7 +86424,7 @@ var openapi = {
|
|
|
86036
86424
|
type: "array"
|
|
86037
86425
|
},
|
|
86038
86426
|
workspace_id: {
|
|
86039
|
-
description: "ID of the
|
|
86427
|
+
description: "ID of the workspace that contains the user identity.",
|
|
86040
86428
|
format: "uuid",
|
|
86041
86429
|
type: "string"
|
|
86042
86430
|
}
|
|
@@ -86147,7 +86535,11 @@ var openapi = {
|
|
|
86147
86535
|
format: "date-time",
|
|
86148
86536
|
type: "string"
|
|
86149
86537
|
},
|
|
86150
|
-
display_name: {
|
|
86538
|
+
display_name: {
|
|
86539
|
+
description: "Display name for the user identity.",
|
|
86540
|
+
minLength: 1,
|
|
86541
|
+
type: "string"
|
|
86542
|
+
},
|
|
86151
86543
|
email_address: {
|
|
86152
86544
|
description: "Unique email address for the user identity.",
|
|
86153
86545
|
format: "email",
|
|
@@ -86202,6 +86594,7 @@ var openapi = {
|
|
|
86202
86594
|
type: "array"
|
|
86203
86595
|
},
|
|
86204
86596
|
full_name: {
|
|
86597
|
+
description: "Full name of the user associated with the user identity.",
|
|
86205
86598
|
minLength: 1,
|
|
86206
86599
|
nullable: true,
|
|
86207
86600
|
type: "string"
|
|
@@ -86279,7 +86672,7 @@ var openapi = {
|
|
|
86279
86672
|
type: "array"
|
|
86280
86673
|
},
|
|
86281
86674
|
workspace_id: {
|
|
86282
|
-
description: "ID of the
|
|
86675
|
+
description: "ID of the workspace that contains the user identity.",
|
|
86283
86676
|
format: "uuid",
|
|
86284
86677
|
type: "string"
|
|
86285
86678
|
}
|
|
@@ -86384,7 +86777,11 @@ var openapi = {
|
|
|
86384
86777
|
format: "date-time",
|
|
86385
86778
|
type: "string"
|
|
86386
86779
|
},
|
|
86387
|
-
display_name: {
|
|
86780
|
+
display_name: {
|
|
86781
|
+
description: "Display name for the user identity.",
|
|
86782
|
+
minLength: 1,
|
|
86783
|
+
type: "string"
|
|
86784
|
+
},
|
|
86388
86785
|
email_address: {
|
|
86389
86786
|
description: "Unique email address for the user identity.",
|
|
86390
86787
|
format: "email",
|
|
@@ -86439,6 +86836,7 @@ var openapi = {
|
|
|
86439
86836
|
type: "array"
|
|
86440
86837
|
},
|
|
86441
86838
|
full_name: {
|
|
86839
|
+
description: "Full name of the user associated with the user identity.",
|
|
86442
86840
|
minLength: 1,
|
|
86443
86841
|
nullable: true,
|
|
86444
86842
|
type: "string"
|
|
@@ -86516,7 +86914,7 @@ var openapi = {
|
|
|
86516
86914
|
type: "array"
|
|
86517
86915
|
},
|
|
86518
86916
|
workspace_id: {
|
|
86519
|
-
description: "ID of the
|
|
86917
|
+
description: "ID of the workspace that contains the user identity.",
|
|
86520
86918
|
format: "uuid",
|
|
86521
86919
|
type: "string"
|
|
86522
86920
|
}
|