@seamapi/types 1.331.0 → 1.332.1
This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
- package/dist/connect.cjs +865 -228
- package/dist/connect.cjs.map +1 -1
- package/dist/connect.d.cts +1645 -73
- package/lib/seam/connect/models/devices/device.d.ts +380 -16
- package/lib/seam/connect/models/devices/device.js +125 -5
- package/lib/seam/connect/models/devices/device.js.map +1 -1
- package/lib/seam/connect/models/devices/phone.d.ts +235 -11
- package/lib/seam/connect/models/devices/unmanaged-device.d.ts +235 -11
- package/lib/seam/connect/models/events/acs/{access_groups.js → access-groups.js} +1 -1
- package/lib/seam/connect/models/events/acs/{access_groups.js.map → access-groups.js.map} +1 -1
- package/lib/seam/connect/models/events/acs/index.js +1 -1
- package/lib/seam/connect/models/events/index.d.ts +1 -0
- package/lib/seam/connect/models/events/index.js +1 -0
- package/lib/seam/connect/models/events/index.js.map +1 -1
- package/lib/seam/connect/models/events/seam-event.d.ts +1 -0
- package/lib/seam/connect/models/events/seam-event.js +2 -0
- package/lib/seam/connect/models/events/seam-event.js.map +1 -1
- package/lib/seam/connect/openapi.d.ts +42 -27
- package/lib/seam/connect/openapi.js +795 -222
- package/lib/seam/connect/openapi.js.map +1 -1
- package/lib/seam/connect/route-types.d.ts +1027 -58
- package/package.json +1 -1
- package/src/lib/seam/connect/models/devices/device.ts +143 -6
- package/src/lib/seam/connect/models/events/acs/index.ts +1 -1
- package/src/lib/seam/connect/models/events/index.ts +1 -0
- package/src/lib/seam/connect/models/events/seam-event.ts +10 -0
- package/src/lib/seam/connect/openapi.ts +835 -205
- package/src/lib/seam/connect/route-types.ts +1404 -163
- /package/lib/seam/connect/models/events/acs/{access_groups.d.ts → access-groups.d.ts} +0 -0
- /package/src/lib/seam/connect/models/events/acs/{access_groups.ts → access-groups.ts} +0 -0
package/dist/connect.cjs
CHANGED
|
@@ -820,9 +820,6 @@ var common_device_error = zod.z.object({
|
|
|
820
820
|
is_device_error: zod.z.literal(true)
|
|
821
821
|
});
|
|
822
822
|
var error_code_description = "Unique identifier of the type of error. Enables quick recognition and categorization of the issue.";
|
|
823
|
-
var common_device_warning = zod.z.object({
|
|
824
|
-
message: zod.z.string()
|
|
825
|
-
});
|
|
826
823
|
var device_offline = common_device_error.extend({
|
|
827
824
|
error_code: zod.z.literal("device_offline").describe(error_code_description)
|
|
828
825
|
}).describe("Device is offline");
|
|
@@ -877,9 +874,72 @@ var device_error = zod.z.union([
|
|
|
877
874
|
auxiliary_heat_running,
|
|
878
875
|
subscription_required
|
|
879
876
|
]).describe("Error associated with the `device`.");
|
|
880
|
-
var
|
|
881
|
-
|
|
877
|
+
var warning_code_description2 = "Unique identifier of the type of warning. Enables quick recognition and categorization of the issue.";
|
|
878
|
+
var common_device_warning = zod.z.object({
|
|
879
|
+
message: zod.z.string()
|
|
882
880
|
});
|
|
881
|
+
var partial_backup_access_code_pool = common_device_warning.extend({
|
|
882
|
+
warning_code: zod.z.literal("partial_backup_access_code_pool").describe(warning_code_description2)
|
|
883
|
+
}).describe("Backup access code unhealthy.");
|
|
884
|
+
var many_active_backup_codes = common_device_warning.extend({
|
|
885
|
+
warning_code: zod.z.literal("many_active_backup_codes").describe(warning_code_description2)
|
|
886
|
+
}).describe("Too many backup codes.");
|
|
887
|
+
var salto_unknown_device_type = common_device_warning.extend({
|
|
888
|
+
warning_code: zod.z.literal("salto_unknown_device_type").describe(warning_code_description2)
|
|
889
|
+
}).describe("A Salto Lock displaying an unknown device type.");
|
|
890
|
+
var salto_office_mode = common_device_warning.extend({
|
|
891
|
+
warning_code: zod.z.literal("salto_office_mode").describe(warning_code_description2)
|
|
892
|
+
}).describe("Lock is in Office Mode. Access Codes will not unlock doors.");
|
|
893
|
+
var salto_privacy_mode = common_device_warning.extend({
|
|
894
|
+
warning_code: zod.z.literal("salto_privacy_mode").describe(warning_code_description2)
|
|
895
|
+
}).describe("Lock is in Privacy Mode. Access Codes will not unlock doors.");
|
|
896
|
+
var wyze_device_missing_gateway = common_device_warning.extend({
|
|
897
|
+
warning_code: zod.z.literal("wyze_device_missing_gateway").describe(warning_code_description2)
|
|
898
|
+
}).describe("Wyze Lock is not connected to a gateway.");
|
|
899
|
+
var functional_offline_device = common_device_warning.extend({
|
|
900
|
+
warning_code: zod.z.literal("functional_offline_device").describe(warning_code_description2)
|
|
901
|
+
}).describe("Device is offline, but has some functionality available.");
|
|
902
|
+
var third_party_integration_detected = common_device_warning.extend({
|
|
903
|
+
warning_code: zod.z.literal("third_party_integration_detected").describe(warning_code_description2)
|
|
904
|
+
}).describe("Third-party integration detected.");
|
|
905
|
+
var nest_thermostat_in_manual_eco_mode = common_device_warning.extend({
|
|
906
|
+
warning_code: zod.z.literal("nest_thermostat_in_manual_eco_mode").describe(warning_code_description2)
|
|
907
|
+
}).describe("Nest thermostat in manual eco mode.");
|
|
908
|
+
var ttlock_lock_gateway_unlocking_not_enabled = common_device_warning.extend({
|
|
909
|
+
warning_code: zod.z.literal("ttlock_lock_gateway_unlocking_not_enabled").describe(warning_code_description2)
|
|
910
|
+
}).describe("Remote Unlock feature not enabled in settings.");
|
|
911
|
+
var ttlock_weak_gateway_signal = common_device_warning.extend({
|
|
912
|
+
warning_code: zod.z.literal("ttlock_weak_gateway_signal").describe(warning_code_description2)
|
|
913
|
+
}).describe("Gateway signal is weak.");
|
|
914
|
+
var temperature_threshold_exceeded = common_device_warning.extend({
|
|
915
|
+
warning_code: zod.z.literal("temperature_threshold_exceeded").describe(warning_code_description2)
|
|
916
|
+
}).describe("Temperature threshold exceeded.");
|
|
917
|
+
var device_communication_degraded = common_device_warning.extend({
|
|
918
|
+
warning_code: zod.z.literal("device_communication_degraded").describe(warning_code_description2)
|
|
919
|
+
}).describe("Device appears to be unresponsive.");
|
|
920
|
+
var scheduled_maintenance_window = common_device_warning.extend({
|
|
921
|
+
warning_code: zod.z.literal("scheduled_maintenance_window").describe(warning_code_description2)
|
|
922
|
+
}).describe("Scheduled maintenance window detected.");
|
|
923
|
+
var device_has_flaky_connection = common_device_warning.extend({
|
|
924
|
+
warning_code: zod.z.literal("device_has_flaky_connection").describe(warning_code_description2)
|
|
925
|
+
}).describe("Device has flaky connection.");
|
|
926
|
+
var device_warning = zod.z.union([
|
|
927
|
+
partial_backup_access_code_pool,
|
|
928
|
+
many_active_backup_codes,
|
|
929
|
+
salto_unknown_device_type,
|
|
930
|
+
wyze_device_missing_gateway,
|
|
931
|
+
functional_offline_device,
|
|
932
|
+
third_party_integration_detected,
|
|
933
|
+
nest_thermostat_in_manual_eco_mode,
|
|
934
|
+
ttlock_lock_gateway_unlocking_not_enabled,
|
|
935
|
+
ttlock_weak_gateway_signal,
|
|
936
|
+
temperature_threshold_exceeded,
|
|
937
|
+
device_communication_degraded,
|
|
938
|
+
scheduled_maintenance_window,
|
|
939
|
+
device_has_flaky_connection,
|
|
940
|
+
salto_office_mode,
|
|
941
|
+
salto_privacy_mode
|
|
942
|
+
]);
|
|
883
943
|
var common_device_properties = zod.z.object({
|
|
884
944
|
online: zod.z.boolean().describe("Indicates whether the device is online."),
|
|
885
945
|
name: zod.z.string().describe(`
|
|
@@ -1254,9 +1314,9 @@ var common_acs_access_group_warning = zod.z.object({
|
|
|
1254
1314
|
"Detailed description of the warning. Provides insights into the issue and potentially how to rectify it."
|
|
1255
1315
|
)
|
|
1256
1316
|
});
|
|
1257
|
-
var
|
|
1317
|
+
var warning_code_description3 = "Unique identifier of the type of warning. Enables quick recognition and categorization of the issue.";
|
|
1258
1318
|
var unknown_issue_with_acs_access_group = common_acs_access_group_warning.extend({
|
|
1259
|
-
warning_code: zod.z.literal("unknown_issue_with_acs_access_group").describe(
|
|
1319
|
+
warning_code: zod.z.literal("unknown_issue_with_acs_access_group").describe(warning_code_description3)
|
|
1260
1320
|
}).describe(
|
|
1261
1321
|
"An unknown issue occurred while syncing the state of this access group with the provider. This issue may affect the proper functioning of this access group."
|
|
1262
1322
|
);
|
|
@@ -1381,30 +1441,30 @@ var common_acs_credential_warning = zod.z.object({
|
|
|
1381
1441
|
"Detailed description of the warning. Provides insights into the issue and potentially how to rectify it."
|
|
1382
1442
|
)
|
|
1383
1443
|
});
|
|
1384
|
-
var
|
|
1444
|
+
var warning_code_description4 = "Unique identifier of the type of warning. Enables quick recognition and categorization of the issue.";
|
|
1385
1445
|
var waiting_to_be_issued = common_acs_credential_warning.extend({
|
|
1386
|
-
warning_code: zod.z.literal("waiting_to_be_issued").describe(
|
|
1446
|
+
warning_code: zod.z.literal("waiting_to_be_issued").describe(warning_code_description4)
|
|
1387
1447
|
}).describe("Indicates that the credential is waiting to be issued.");
|
|
1388
1448
|
var schedule_externally_modified = common_acs_credential_warning.extend({
|
|
1389
|
-
warning_code: zod.z.literal("schedule_externally_modified").describe(
|
|
1449
|
+
warning_code: zod.z.literal("schedule_externally_modified").describe(warning_code_description4)
|
|
1390
1450
|
}).describe(
|
|
1391
1451
|
"Indicates that the schedule of one of the credential's children was modified externally."
|
|
1392
1452
|
);
|
|
1393
1453
|
var schedule_modified = common_acs_credential_warning.extend({
|
|
1394
|
-
warning_code: zod.z.literal("schedule_modified").describe(
|
|
1454
|
+
warning_code: zod.z.literal("schedule_modified").describe(warning_code_description4)
|
|
1395
1455
|
}).describe(
|
|
1396
1456
|
"Indicates that the schedule of this credential was modified to avoid creating a credential with a start date in the past."
|
|
1397
1457
|
);
|
|
1398
1458
|
var being_deleted = common_acs_credential_warning.extend({
|
|
1399
|
-
warning_code: zod.z.literal("being_deleted").describe(
|
|
1459
|
+
warning_code: zod.z.literal("being_deleted").describe(warning_code_description4)
|
|
1400
1460
|
}).describe("Indicates that this credential is being deleted.");
|
|
1401
1461
|
var unknown_issue_with_acs_credential = common_acs_credential_warning.extend({
|
|
1402
|
-
warning_code: zod.z.literal("unknown_issue_with_acs_credential").describe(
|
|
1462
|
+
warning_code: zod.z.literal("unknown_issue_with_acs_credential").describe(warning_code_description4)
|
|
1403
1463
|
}).describe(
|
|
1404
1464
|
"An unknown issue occurred while syncing the state of this credential with the provider. This issue may affect the proper functioning of this credential."
|
|
1405
1465
|
);
|
|
1406
1466
|
var needs_to_be_reissued = common_acs_credential_warning.extend({
|
|
1407
|
-
warning_code: zod.z.literal("needs_to_be_reissued").describe(
|
|
1467
|
+
warning_code: zod.z.literal("needs_to_be_reissued").describe(warning_code_description4)
|
|
1408
1468
|
}).describe(
|
|
1409
1469
|
"Access permissions for this [credential](https://docs.seam.co/latest/capability-guides/access-systems/managing-credentials) have changed. [Reissue](https://docs.seam.co/latest/capability-guides/access-systems/working-with-card-encoders-and-scanners/creating-and-encoding-card-based-credentials) (re-encode) this credential. This issue may affect the proper functioning of the credential."
|
|
1410
1470
|
);
|
|
@@ -2330,8 +2390,6 @@ var common_event = zod.z.object({
|
|
|
2330
2390
|
created_at: zod.z.string().datetime().describe("Date and time at which the event was created."),
|
|
2331
2391
|
occurred_at: zod.z.string().datetime().describe("Date and time at which the event occurred.")
|
|
2332
2392
|
});
|
|
2333
|
-
|
|
2334
|
-
// src/lib/seam/connect/models/events/access-codes.ts
|
|
2335
2393
|
var access_code_event = common_event.extend({
|
|
2336
2394
|
access_code_id: zod.z.string().uuid().describe(
|
|
2337
2395
|
"ID of the [access code](https://docs.seam.co/latest/capability-guides/smart-locks/access-codes)."
|
|
@@ -2514,7 +2572,7 @@ var common_acs_event = common_event.extend({
|
|
|
2514
2572
|
)
|
|
2515
2573
|
});
|
|
2516
2574
|
|
|
2517
|
-
// src/lib/seam/connect/models/events/acs/
|
|
2575
|
+
// src/lib/seam/connect/models/events/acs/access-groups.ts
|
|
2518
2576
|
var acs_access_group_event = common_acs_event.extend({
|
|
2519
2577
|
acs_access_group_id: zod.z.string().uuid()
|
|
2520
2578
|
});
|
|
@@ -3258,6 +3316,12 @@ var seam_event = zod.z.discriminatedUnion("event_type", [
|
|
|
3258
3316
|
route_path: /events
|
|
3259
3317
|
---
|
|
3260
3318
|
`);
|
|
3319
|
+
var event_types = seam_event.options.map(
|
|
3320
|
+
(schema) => schema.shape.event_type.value
|
|
3321
|
+
);
|
|
3322
|
+
zod.z.enum(
|
|
3323
|
+
event_types
|
|
3324
|
+
);
|
|
3261
3325
|
var noise_threshold = zod.z.object({
|
|
3262
3326
|
noise_threshold_id: zod.z.string().uuid(),
|
|
3263
3327
|
device_id: zod.z.string().uuid(),
|
|
@@ -9184,12 +9248,203 @@ var openapi_default = {
|
|
|
9184
9248
|
warnings: {
|
|
9185
9249
|
description: 'Array of warnings associated with the device. Each warning object within the array contains two fields: "warning_code" and "message." "warning_code" is a string that uniquely identifies the type of warning, enabling quick recognition and categorization of the issue. "message" provides a more detailed description of the warning, offering insights into the issue and potentially how to rectify it.',
|
|
9186
9250
|
items: {
|
|
9187
|
-
|
|
9188
|
-
|
|
9189
|
-
|
|
9190
|
-
|
|
9191
|
-
|
|
9192
|
-
|
|
9251
|
+
oneOf: [
|
|
9252
|
+
{
|
|
9253
|
+
description: "Backup access code unhealthy.",
|
|
9254
|
+
properties: {
|
|
9255
|
+
message: { type: "string" },
|
|
9256
|
+
warning_code: {
|
|
9257
|
+
description: "Unique identifier of the type of warning. Enables quick recognition and categorization of the issue.",
|
|
9258
|
+
enum: ["partial_backup_access_code_pool"],
|
|
9259
|
+
type: "string"
|
|
9260
|
+
}
|
|
9261
|
+
},
|
|
9262
|
+
required: ["message", "warning_code"],
|
|
9263
|
+
type: "object"
|
|
9264
|
+
},
|
|
9265
|
+
{
|
|
9266
|
+
description: "Too many backup codes.",
|
|
9267
|
+
properties: {
|
|
9268
|
+
message: { type: "string" },
|
|
9269
|
+
warning_code: {
|
|
9270
|
+
description: "Unique identifier of the type of warning. Enables quick recognition and categorization of the issue.",
|
|
9271
|
+
enum: ["many_active_backup_codes"],
|
|
9272
|
+
type: "string"
|
|
9273
|
+
}
|
|
9274
|
+
},
|
|
9275
|
+
required: ["message", "warning_code"],
|
|
9276
|
+
type: "object"
|
|
9277
|
+
},
|
|
9278
|
+
{
|
|
9279
|
+
description: "A Salto Lock displaying an unknown device type.",
|
|
9280
|
+
properties: {
|
|
9281
|
+
message: { type: "string" },
|
|
9282
|
+
warning_code: {
|
|
9283
|
+
description: "Unique identifier of the type of warning. Enables quick recognition and categorization of the issue.",
|
|
9284
|
+
enum: ["salto_unknown_device_type"],
|
|
9285
|
+
type: "string"
|
|
9286
|
+
}
|
|
9287
|
+
},
|
|
9288
|
+
required: ["message", "warning_code"],
|
|
9289
|
+
type: "object"
|
|
9290
|
+
},
|
|
9291
|
+
{
|
|
9292
|
+
description: "Wyze Lock is not connected to a gateway.",
|
|
9293
|
+
properties: {
|
|
9294
|
+
message: { type: "string" },
|
|
9295
|
+
warning_code: {
|
|
9296
|
+
description: "Unique identifier of the type of warning. Enables quick recognition and categorization of the issue.",
|
|
9297
|
+
enum: ["wyze_device_missing_gateway"],
|
|
9298
|
+
type: "string"
|
|
9299
|
+
}
|
|
9300
|
+
},
|
|
9301
|
+
required: ["message", "warning_code"],
|
|
9302
|
+
type: "object"
|
|
9303
|
+
},
|
|
9304
|
+
{
|
|
9305
|
+
description: "Device is offline, but has some functionality available.",
|
|
9306
|
+
properties: {
|
|
9307
|
+
message: { type: "string" },
|
|
9308
|
+
warning_code: {
|
|
9309
|
+
description: "Unique identifier of the type of warning. Enables quick recognition and categorization of the issue.",
|
|
9310
|
+
enum: ["functional_offline_device"],
|
|
9311
|
+
type: "string"
|
|
9312
|
+
}
|
|
9313
|
+
},
|
|
9314
|
+
required: ["message", "warning_code"],
|
|
9315
|
+
type: "object"
|
|
9316
|
+
},
|
|
9317
|
+
{
|
|
9318
|
+
description: "Third-party integration detected.",
|
|
9319
|
+
properties: {
|
|
9320
|
+
message: { type: "string" },
|
|
9321
|
+
warning_code: {
|
|
9322
|
+
description: "Unique identifier of the type of warning. Enables quick recognition and categorization of the issue.",
|
|
9323
|
+
enum: ["third_party_integration_detected"],
|
|
9324
|
+
type: "string"
|
|
9325
|
+
}
|
|
9326
|
+
},
|
|
9327
|
+
required: ["message", "warning_code"],
|
|
9328
|
+
type: "object"
|
|
9329
|
+
},
|
|
9330
|
+
{
|
|
9331
|
+
description: "Nest thermostat in manual eco mode.",
|
|
9332
|
+
properties: {
|
|
9333
|
+
message: { type: "string" },
|
|
9334
|
+
warning_code: {
|
|
9335
|
+
description: "Unique identifier of the type of warning. Enables quick recognition and categorization of the issue.",
|
|
9336
|
+
enum: ["nest_thermostat_in_manual_eco_mode"],
|
|
9337
|
+
type: "string"
|
|
9338
|
+
}
|
|
9339
|
+
},
|
|
9340
|
+
required: ["message", "warning_code"],
|
|
9341
|
+
type: "object"
|
|
9342
|
+
},
|
|
9343
|
+
{
|
|
9344
|
+
description: "Remote Unlock feature not enabled in settings.",
|
|
9345
|
+
properties: {
|
|
9346
|
+
message: { type: "string" },
|
|
9347
|
+
warning_code: {
|
|
9348
|
+
description: "Unique identifier of the type of warning. Enables quick recognition and categorization of the issue.",
|
|
9349
|
+
enum: ["ttlock_lock_gateway_unlocking_not_enabled"],
|
|
9350
|
+
type: "string"
|
|
9351
|
+
}
|
|
9352
|
+
},
|
|
9353
|
+
required: ["message", "warning_code"],
|
|
9354
|
+
type: "object"
|
|
9355
|
+
},
|
|
9356
|
+
{
|
|
9357
|
+
description: "Gateway signal is weak.",
|
|
9358
|
+
properties: {
|
|
9359
|
+
message: { type: "string" },
|
|
9360
|
+
warning_code: {
|
|
9361
|
+
description: "Unique identifier of the type of warning. Enables quick recognition and categorization of the issue.",
|
|
9362
|
+
enum: ["ttlock_weak_gateway_signal"],
|
|
9363
|
+
type: "string"
|
|
9364
|
+
}
|
|
9365
|
+
},
|
|
9366
|
+
required: ["message", "warning_code"],
|
|
9367
|
+
type: "object"
|
|
9368
|
+
},
|
|
9369
|
+
{
|
|
9370
|
+
description: "Temperature threshold exceeded.",
|
|
9371
|
+
properties: {
|
|
9372
|
+
message: { type: "string" },
|
|
9373
|
+
warning_code: {
|
|
9374
|
+
description: "Unique identifier of the type of warning. Enables quick recognition and categorization of the issue.",
|
|
9375
|
+
enum: ["temperature_threshold_exceeded"],
|
|
9376
|
+
type: "string"
|
|
9377
|
+
}
|
|
9378
|
+
},
|
|
9379
|
+
required: ["message", "warning_code"],
|
|
9380
|
+
type: "object"
|
|
9381
|
+
},
|
|
9382
|
+
{
|
|
9383
|
+
description: "Device appears to be unresponsive.",
|
|
9384
|
+
properties: {
|
|
9385
|
+
message: { type: "string" },
|
|
9386
|
+
warning_code: {
|
|
9387
|
+
description: "Unique identifier of the type of warning. Enables quick recognition and categorization of the issue.",
|
|
9388
|
+
enum: ["device_communication_degraded"],
|
|
9389
|
+
type: "string"
|
|
9390
|
+
}
|
|
9391
|
+
},
|
|
9392
|
+
required: ["message", "warning_code"],
|
|
9393
|
+
type: "object"
|
|
9394
|
+
},
|
|
9395
|
+
{
|
|
9396
|
+
description: "Scheduled maintenance window detected.",
|
|
9397
|
+
properties: {
|
|
9398
|
+
message: { type: "string" },
|
|
9399
|
+
warning_code: {
|
|
9400
|
+
description: "Unique identifier of the type of warning. Enables quick recognition and categorization of the issue.",
|
|
9401
|
+
enum: ["scheduled_maintenance_window"],
|
|
9402
|
+
type: "string"
|
|
9403
|
+
}
|
|
9404
|
+
},
|
|
9405
|
+
required: ["message", "warning_code"],
|
|
9406
|
+
type: "object"
|
|
9407
|
+
},
|
|
9408
|
+
{
|
|
9409
|
+
description: "Device has flaky connection.",
|
|
9410
|
+
properties: {
|
|
9411
|
+
message: { type: "string" },
|
|
9412
|
+
warning_code: {
|
|
9413
|
+
description: "Unique identifier of the type of warning. Enables quick recognition and categorization of the issue.",
|
|
9414
|
+
enum: ["device_has_flaky_connection"],
|
|
9415
|
+
type: "string"
|
|
9416
|
+
}
|
|
9417
|
+
},
|
|
9418
|
+
required: ["message", "warning_code"],
|
|
9419
|
+
type: "object"
|
|
9420
|
+
},
|
|
9421
|
+
{
|
|
9422
|
+
description: "Lock is in Office Mode. Access Codes will not unlock doors.",
|
|
9423
|
+
properties: {
|
|
9424
|
+
message: { type: "string" },
|
|
9425
|
+
warning_code: {
|
|
9426
|
+
description: "Unique identifier of the type of warning. Enables quick recognition and categorization of the issue.",
|
|
9427
|
+
enum: ["salto_office_mode"],
|
|
9428
|
+
type: "string"
|
|
9429
|
+
}
|
|
9430
|
+
},
|
|
9431
|
+
required: ["message", "warning_code"],
|
|
9432
|
+
type: "object"
|
|
9433
|
+
},
|
|
9434
|
+
{
|
|
9435
|
+
description: "Lock is in Privacy Mode. Access Codes will not unlock doors.",
|
|
9436
|
+
properties: {
|
|
9437
|
+
message: { type: "string" },
|
|
9438
|
+
warning_code: {
|
|
9439
|
+
description: "Unique identifier of the type of warning. Enables quick recognition and categorization of the issue.",
|
|
9440
|
+
enum: ["salto_privacy_mode"],
|
|
9441
|
+
type: "string"
|
|
9442
|
+
}
|
|
9443
|
+
},
|
|
9444
|
+
required: ["message", "warning_code"],
|
|
9445
|
+
type: "object"
|
|
9446
|
+
}
|
|
9447
|
+
]
|
|
9193
9448
|
},
|
|
9194
9449
|
type: "array"
|
|
9195
9450
|
},
|
|
@@ -13662,75 +13917,266 @@ var openapi_default = {
|
|
|
13662
13917
|
warnings: {
|
|
13663
13918
|
description: 'Array of warnings associated with the device. Each warning object within the array contains two fields: "warning_code" and "message." "warning_code" is a string that uniquely identifies the type of warning, enabling quick recognition and categorization of the issue. "message" provides a more detailed description of the warning, offering insights into the issue and potentially how to rectify it.',
|
|
13664
13919
|
items: {
|
|
13665
|
-
|
|
13666
|
-
|
|
13667
|
-
|
|
13668
|
-
|
|
13669
|
-
|
|
13670
|
-
|
|
13671
|
-
|
|
13672
|
-
|
|
13673
|
-
|
|
13674
|
-
|
|
13675
|
-
|
|
13676
|
-
|
|
13677
|
-
|
|
13678
|
-
|
|
13679
|
-
|
|
13680
|
-
|
|
13681
|
-
|
|
13682
|
-
|
|
13683
|
-
|
|
13684
|
-
|
|
13685
|
-
|
|
13686
|
-
|
|
13687
|
-
|
|
13688
|
-
|
|
13689
|
-
|
|
13690
|
-
|
|
13691
|
-
|
|
13692
|
-
|
|
13693
|
-
|
|
13694
|
-
|
|
13695
|
-
|
|
13696
|
-
|
|
13697
|
-
|
|
13698
|
-
|
|
13699
|
-
|
|
13700
|
-
|
|
13701
|
-
|
|
13702
|
-
|
|
13703
|
-
|
|
13704
|
-
|
|
13705
|
-
|
|
13706
|
-
|
|
13707
|
-
|
|
13708
|
-
|
|
13709
|
-
|
|
13710
|
-
|
|
13711
|
-
|
|
13712
|
-
|
|
13713
|
-
|
|
13714
|
-
|
|
13715
|
-
|
|
13716
|
-
|
|
13717
|
-
|
|
13718
|
-
|
|
13719
|
-
|
|
13720
|
-
|
|
13721
|
-
|
|
13722
|
-
|
|
13723
|
-
|
|
13724
|
-
|
|
13725
|
-
|
|
13726
|
-
|
|
13727
|
-
|
|
13728
|
-
|
|
13729
|
-
|
|
13730
|
-
|
|
13731
|
-
|
|
13732
|
-
|
|
13733
|
-
|
|
13920
|
+
oneOf: [
|
|
13921
|
+
{
|
|
13922
|
+
description: "Backup access code unhealthy.",
|
|
13923
|
+
properties: {
|
|
13924
|
+
message: { type: "string" },
|
|
13925
|
+
warning_code: {
|
|
13926
|
+
description: "Unique identifier of the type of warning. Enables quick recognition and categorization of the issue.",
|
|
13927
|
+
enum: ["partial_backup_access_code_pool"],
|
|
13928
|
+
type: "string"
|
|
13929
|
+
}
|
|
13930
|
+
},
|
|
13931
|
+
required: ["message", "warning_code"],
|
|
13932
|
+
type: "object"
|
|
13933
|
+
},
|
|
13934
|
+
{
|
|
13935
|
+
description: "Too many backup codes.",
|
|
13936
|
+
properties: {
|
|
13937
|
+
message: { type: "string" },
|
|
13938
|
+
warning_code: {
|
|
13939
|
+
description: "Unique identifier of the type of warning. Enables quick recognition and categorization of the issue.",
|
|
13940
|
+
enum: ["many_active_backup_codes"],
|
|
13941
|
+
type: "string"
|
|
13942
|
+
}
|
|
13943
|
+
},
|
|
13944
|
+
required: ["message", "warning_code"],
|
|
13945
|
+
type: "object"
|
|
13946
|
+
},
|
|
13947
|
+
{
|
|
13948
|
+
description: "A Salto Lock displaying an unknown device type.",
|
|
13949
|
+
properties: {
|
|
13950
|
+
message: { type: "string" },
|
|
13951
|
+
warning_code: {
|
|
13952
|
+
description: "Unique identifier of the type of warning. Enables quick recognition and categorization of the issue.",
|
|
13953
|
+
enum: ["salto_unknown_device_type"],
|
|
13954
|
+
type: "string"
|
|
13955
|
+
}
|
|
13956
|
+
},
|
|
13957
|
+
required: ["message", "warning_code"],
|
|
13958
|
+
type: "object"
|
|
13959
|
+
},
|
|
13960
|
+
{
|
|
13961
|
+
description: "Wyze Lock is not connected to a gateway.",
|
|
13962
|
+
properties: {
|
|
13963
|
+
message: { type: "string" },
|
|
13964
|
+
warning_code: {
|
|
13965
|
+
description: "Unique identifier of the type of warning. Enables quick recognition and categorization of the issue.",
|
|
13966
|
+
enum: ["wyze_device_missing_gateway"],
|
|
13967
|
+
type: "string"
|
|
13968
|
+
}
|
|
13969
|
+
},
|
|
13970
|
+
required: ["message", "warning_code"],
|
|
13971
|
+
type: "object"
|
|
13972
|
+
},
|
|
13973
|
+
{
|
|
13974
|
+
description: "Device is offline, but has some functionality available.",
|
|
13975
|
+
properties: {
|
|
13976
|
+
message: { type: "string" },
|
|
13977
|
+
warning_code: {
|
|
13978
|
+
description: "Unique identifier of the type of warning. Enables quick recognition and categorization of the issue.",
|
|
13979
|
+
enum: ["functional_offline_device"],
|
|
13980
|
+
type: "string"
|
|
13981
|
+
}
|
|
13982
|
+
},
|
|
13983
|
+
required: ["message", "warning_code"],
|
|
13984
|
+
type: "object"
|
|
13985
|
+
},
|
|
13986
|
+
{
|
|
13987
|
+
description: "Third-party integration detected.",
|
|
13988
|
+
properties: {
|
|
13989
|
+
message: { type: "string" },
|
|
13990
|
+
warning_code: {
|
|
13991
|
+
description: "Unique identifier of the type of warning. Enables quick recognition and categorization of the issue.",
|
|
13992
|
+
enum: ["third_party_integration_detected"],
|
|
13993
|
+
type: "string"
|
|
13994
|
+
}
|
|
13995
|
+
},
|
|
13996
|
+
required: ["message", "warning_code"],
|
|
13997
|
+
type: "object"
|
|
13998
|
+
},
|
|
13999
|
+
{
|
|
14000
|
+
description: "Nest thermostat in manual eco mode.",
|
|
14001
|
+
properties: {
|
|
14002
|
+
message: { type: "string" },
|
|
14003
|
+
warning_code: {
|
|
14004
|
+
description: "Unique identifier of the type of warning. Enables quick recognition and categorization of the issue.",
|
|
14005
|
+
enum: ["nest_thermostat_in_manual_eco_mode"],
|
|
14006
|
+
type: "string"
|
|
14007
|
+
}
|
|
14008
|
+
},
|
|
14009
|
+
required: ["message", "warning_code"],
|
|
14010
|
+
type: "object"
|
|
14011
|
+
},
|
|
14012
|
+
{
|
|
14013
|
+
description: "Remote Unlock feature not enabled in settings.",
|
|
14014
|
+
properties: {
|
|
14015
|
+
message: { type: "string" },
|
|
14016
|
+
warning_code: {
|
|
14017
|
+
description: "Unique identifier of the type of warning. Enables quick recognition and categorization of the issue.",
|
|
14018
|
+
enum: ["ttlock_lock_gateway_unlocking_not_enabled"],
|
|
14019
|
+
type: "string"
|
|
14020
|
+
}
|
|
14021
|
+
},
|
|
14022
|
+
required: ["message", "warning_code"],
|
|
14023
|
+
type: "object"
|
|
14024
|
+
},
|
|
14025
|
+
{
|
|
14026
|
+
description: "Gateway signal is weak.",
|
|
14027
|
+
properties: {
|
|
14028
|
+
message: { type: "string" },
|
|
14029
|
+
warning_code: {
|
|
14030
|
+
description: "Unique identifier of the type of warning. Enables quick recognition and categorization of the issue.",
|
|
14031
|
+
enum: ["ttlock_weak_gateway_signal"],
|
|
14032
|
+
type: "string"
|
|
14033
|
+
}
|
|
14034
|
+
},
|
|
14035
|
+
required: ["message", "warning_code"],
|
|
14036
|
+
type: "object"
|
|
14037
|
+
},
|
|
14038
|
+
{
|
|
14039
|
+
description: "Temperature threshold exceeded.",
|
|
14040
|
+
properties: {
|
|
14041
|
+
message: { type: "string" },
|
|
14042
|
+
warning_code: {
|
|
14043
|
+
description: "Unique identifier of the type of warning. Enables quick recognition and categorization of the issue.",
|
|
14044
|
+
enum: ["temperature_threshold_exceeded"],
|
|
14045
|
+
type: "string"
|
|
14046
|
+
}
|
|
14047
|
+
},
|
|
14048
|
+
required: ["message", "warning_code"],
|
|
14049
|
+
type: "object"
|
|
14050
|
+
},
|
|
14051
|
+
{
|
|
14052
|
+
description: "Device appears to be unresponsive.",
|
|
14053
|
+
properties: {
|
|
14054
|
+
message: { type: "string" },
|
|
14055
|
+
warning_code: {
|
|
14056
|
+
description: "Unique identifier of the type of warning. Enables quick recognition and categorization of the issue.",
|
|
14057
|
+
enum: ["device_communication_degraded"],
|
|
14058
|
+
type: "string"
|
|
14059
|
+
}
|
|
14060
|
+
},
|
|
14061
|
+
required: ["message", "warning_code"],
|
|
14062
|
+
type: "object"
|
|
14063
|
+
},
|
|
14064
|
+
{
|
|
14065
|
+
description: "Scheduled maintenance window detected.",
|
|
14066
|
+
properties: {
|
|
14067
|
+
message: { type: "string" },
|
|
14068
|
+
warning_code: {
|
|
14069
|
+
description: "Unique identifier of the type of warning. Enables quick recognition and categorization of the issue.",
|
|
14070
|
+
enum: ["scheduled_maintenance_window"],
|
|
14071
|
+
type: "string"
|
|
14072
|
+
}
|
|
14073
|
+
},
|
|
14074
|
+
required: ["message", "warning_code"],
|
|
14075
|
+
type: "object"
|
|
14076
|
+
},
|
|
14077
|
+
{
|
|
14078
|
+
description: "Device has flaky connection.",
|
|
14079
|
+
properties: {
|
|
14080
|
+
message: { type: "string" },
|
|
14081
|
+
warning_code: {
|
|
14082
|
+
description: "Unique identifier of the type of warning. Enables quick recognition and categorization of the issue.",
|
|
14083
|
+
enum: ["device_has_flaky_connection"],
|
|
14084
|
+
type: "string"
|
|
14085
|
+
}
|
|
14086
|
+
},
|
|
14087
|
+
required: ["message", "warning_code"],
|
|
14088
|
+
type: "object"
|
|
14089
|
+
},
|
|
14090
|
+
{
|
|
14091
|
+
description: "Lock is in Office Mode. Access Codes will not unlock doors.",
|
|
14092
|
+
properties: {
|
|
14093
|
+
message: { type: "string" },
|
|
14094
|
+
warning_code: {
|
|
14095
|
+
description: "Unique identifier of the type of warning. Enables quick recognition and categorization of the issue.",
|
|
14096
|
+
enum: ["salto_office_mode"],
|
|
14097
|
+
type: "string"
|
|
14098
|
+
}
|
|
14099
|
+
},
|
|
14100
|
+
required: ["message", "warning_code"],
|
|
14101
|
+
type: "object"
|
|
14102
|
+
},
|
|
14103
|
+
{
|
|
14104
|
+
description: "Lock is in Privacy Mode. Access Codes will not unlock doors.",
|
|
14105
|
+
properties: {
|
|
14106
|
+
message: { type: "string" },
|
|
14107
|
+
warning_code: {
|
|
14108
|
+
description: "Unique identifier of the type of warning. Enables quick recognition and categorization of the issue.",
|
|
14109
|
+
enum: ["salto_privacy_mode"],
|
|
14110
|
+
type: "string"
|
|
14111
|
+
}
|
|
14112
|
+
},
|
|
14113
|
+
required: ["message", "warning_code"],
|
|
14114
|
+
type: "object"
|
|
14115
|
+
}
|
|
14116
|
+
]
|
|
14117
|
+
},
|
|
14118
|
+
type: "array"
|
|
14119
|
+
},
|
|
14120
|
+
workspace_id: {
|
|
14121
|
+
description: "Unique identifier for the Seam workspace associated with the device.",
|
|
14122
|
+
format: "uuid",
|
|
14123
|
+
type: "string"
|
|
14124
|
+
}
|
|
14125
|
+
},
|
|
14126
|
+
required: [
|
|
14127
|
+
"device_id",
|
|
14128
|
+
"device_type",
|
|
14129
|
+
"display_name",
|
|
14130
|
+
"capabilities_supported",
|
|
14131
|
+
"properties",
|
|
14132
|
+
"location",
|
|
14133
|
+
"workspace_id",
|
|
14134
|
+
"errors",
|
|
14135
|
+
"warnings",
|
|
14136
|
+
"created_at",
|
|
14137
|
+
"is_managed",
|
|
14138
|
+
"custom_metadata"
|
|
14139
|
+
],
|
|
14140
|
+
type: "object",
|
|
14141
|
+
"x-route-path": "/phones"
|
|
14142
|
+
},
|
|
14143
|
+
service_health: {
|
|
14144
|
+
properties: {
|
|
14145
|
+
description: { type: "string" },
|
|
14146
|
+
service: { type: "string" },
|
|
14147
|
+
status: { enum: ["healthy", "degraded", "down"], type: "string" }
|
|
14148
|
+
},
|
|
14149
|
+
required: ["service", "status", "description"],
|
|
14150
|
+
type: "object",
|
|
14151
|
+
"x-route-path": "/health"
|
|
14152
|
+
},
|
|
14153
|
+
thermostat_schedule: {
|
|
14154
|
+
description: "Represents a [thermostat schedule](https://docs.seam.co/latest/capability-guides/thermostats/creating-and-managing-thermostat-schedules) that activates a configured [climate preset](https://docs.seam.co/latest/capability-guides/thermostats/creating-and-managing-climate-presets) on a [thermostat](https://docs.seam.co/latest/capability-guides/thermostats) at a specified starting time and deactivates the climate preset at a specified ending time.",
|
|
14155
|
+
properties: {
|
|
14156
|
+
climate_preset_key: {
|
|
14157
|
+
description: "Key of the [climate preset](https://docs.seam.co/latest/capability-guides/thermostats/creating-and-managing-climate-presets) to use for the thermostat schedule.",
|
|
14158
|
+
type: "string"
|
|
14159
|
+
},
|
|
14160
|
+
created_at: {
|
|
14161
|
+
description: "Date and time at which the thermostat schedule was created.",
|
|
14162
|
+
format: "date-time",
|
|
14163
|
+
type: "string"
|
|
14164
|
+
},
|
|
14165
|
+
device_id: {
|
|
14166
|
+
description: "ID of the desired thermostat device.",
|
|
14167
|
+
format: "uuid",
|
|
14168
|
+
type: "string"
|
|
14169
|
+
},
|
|
14170
|
+
ends_at: {
|
|
14171
|
+
description: "Date and time at which the thermostat schedule ends, in [ISO 8601](https://www.iso.org/iso-8601-date-and-time-format.html) format.",
|
|
14172
|
+
format: "date-time",
|
|
14173
|
+
type: "string"
|
|
14174
|
+
},
|
|
14175
|
+
errors: {
|
|
14176
|
+
description: "Array of errors associated with the thermostat schedule. Each error object within the array contains two fields: `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.",
|
|
14177
|
+
items: {
|
|
14178
|
+
properties: {
|
|
14179
|
+
error_code: { type: "string" },
|
|
13734
14180
|
message: { type: "string" }
|
|
13735
14181
|
},
|
|
13736
14182
|
required: ["error_code", "message"],
|
|
@@ -14473,53 +14919,244 @@ var openapi_default = {
|
|
|
14473
14919
|
description: "Indicates whether the device has a built in accessory keypad.",
|
|
14474
14920
|
type: "boolean"
|
|
14475
14921
|
},
|
|
14476
|
-
manufacturer_display_name: {
|
|
14477
|
-
description: "Display name that corresponds to the manufacturer-specific terminology for the device.",
|
|
14478
|
-
type: "string"
|
|
14922
|
+
manufacturer_display_name: {
|
|
14923
|
+
description: "Display name that corresponds to the manufacturer-specific terminology for the device.",
|
|
14924
|
+
type: "string"
|
|
14925
|
+
},
|
|
14926
|
+
offline_access_codes_supported: {
|
|
14927
|
+
description: "Indicates whether the device supports offline access codes.",
|
|
14928
|
+
type: "boolean"
|
|
14929
|
+
},
|
|
14930
|
+
online_access_codes_supported: {
|
|
14931
|
+
description: "Indicates whether the device supports online access codes.",
|
|
14932
|
+
type: "boolean"
|
|
14933
|
+
}
|
|
14934
|
+
},
|
|
14935
|
+
required: ["display_name", "manufacturer_display_name"],
|
|
14936
|
+
type: "object"
|
|
14937
|
+
},
|
|
14938
|
+
name: {
|
|
14939
|
+
deprecated: true,
|
|
14940
|
+
description: "Name of the device.",
|
|
14941
|
+
type: "string",
|
|
14942
|
+
"x-deprecated": "use device.display_name instead"
|
|
14943
|
+
},
|
|
14944
|
+
offline_access_codes_enabled: {
|
|
14945
|
+
description: "Indicates whether it is currently possible to use offline access codes for the device.",
|
|
14946
|
+
type: "boolean"
|
|
14947
|
+
},
|
|
14948
|
+
online: {
|
|
14949
|
+
description: "Indicates whether the device is online.",
|
|
14950
|
+
type: "boolean"
|
|
14951
|
+
},
|
|
14952
|
+
online_access_codes_enabled: {
|
|
14953
|
+
description: "Indicates whether it is currently possible to use online access codes for the device.",
|
|
14954
|
+
type: "boolean"
|
|
14955
|
+
}
|
|
14956
|
+
},
|
|
14957
|
+
required: ["name", "online", "model"],
|
|
14958
|
+
type: "object"
|
|
14959
|
+
},
|
|
14960
|
+
warnings: {
|
|
14961
|
+
description: 'Array of warnings associated with the device. Each warning object within the array contains two fields: "warning_code" and "message." "warning_code" is a string that uniquely identifies the type of warning, enabling quick recognition and categorization of the issue. "message" provides a more detailed description of the warning, offering insights into the issue and potentially how to rectify it.',
|
|
14962
|
+
items: {
|
|
14963
|
+
oneOf: [
|
|
14964
|
+
{
|
|
14965
|
+
description: "Backup access code unhealthy.",
|
|
14966
|
+
properties: {
|
|
14967
|
+
message: { type: "string" },
|
|
14968
|
+
warning_code: {
|
|
14969
|
+
description: "Unique identifier of the type of warning. Enables quick recognition and categorization of the issue.",
|
|
14970
|
+
enum: ["partial_backup_access_code_pool"],
|
|
14971
|
+
type: "string"
|
|
14972
|
+
}
|
|
14973
|
+
},
|
|
14974
|
+
required: ["message", "warning_code"],
|
|
14975
|
+
type: "object"
|
|
14976
|
+
},
|
|
14977
|
+
{
|
|
14978
|
+
description: "Too many backup codes.",
|
|
14979
|
+
properties: {
|
|
14980
|
+
message: { type: "string" },
|
|
14981
|
+
warning_code: {
|
|
14982
|
+
description: "Unique identifier of the type of warning. Enables quick recognition and categorization of the issue.",
|
|
14983
|
+
enum: ["many_active_backup_codes"],
|
|
14984
|
+
type: "string"
|
|
14985
|
+
}
|
|
14986
|
+
},
|
|
14987
|
+
required: ["message", "warning_code"],
|
|
14988
|
+
type: "object"
|
|
14989
|
+
},
|
|
14990
|
+
{
|
|
14991
|
+
description: "A Salto Lock displaying an unknown device type.",
|
|
14992
|
+
properties: {
|
|
14993
|
+
message: { type: "string" },
|
|
14994
|
+
warning_code: {
|
|
14995
|
+
description: "Unique identifier of the type of warning. Enables quick recognition and categorization of the issue.",
|
|
14996
|
+
enum: ["salto_unknown_device_type"],
|
|
14997
|
+
type: "string"
|
|
14998
|
+
}
|
|
14999
|
+
},
|
|
15000
|
+
required: ["message", "warning_code"],
|
|
15001
|
+
type: "object"
|
|
15002
|
+
},
|
|
15003
|
+
{
|
|
15004
|
+
description: "Wyze Lock is not connected to a gateway.",
|
|
15005
|
+
properties: {
|
|
15006
|
+
message: { type: "string" },
|
|
15007
|
+
warning_code: {
|
|
15008
|
+
description: "Unique identifier of the type of warning. Enables quick recognition and categorization of the issue.",
|
|
15009
|
+
enum: ["wyze_device_missing_gateway"],
|
|
15010
|
+
type: "string"
|
|
15011
|
+
}
|
|
15012
|
+
},
|
|
15013
|
+
required: ["message", "warning_code"],
|
|
15014
|
+
type: "object"
|
|
15015
|
+
},
|
|
15016
|
+
{
|
|
15017
|
+
description: "Device is offline, but has some functionality available.",
|
|
15018
|
+
properties: {
|
|
15019
|
+
message: { type: "string" },
|
|
15020
|
+
warning_code: {
|
|
15021
|
+
description: "Unique identifier of the type of warning. Enables quick recognition and categorization of the issue.",
|
|
15022
|
+
enum: ["functional_offline_device"],
|
|
15023
|
+
type: "string"
|
|
15024
|
+
}
|
|
15025
|
+
},
|
|
15026
|
+
required: ["message", "warning_code"],
|
|
15027
|
+
type: "object"
|
|
15028
|
+
},
|
|
15029
|
+
{
|
|
15030
|
+
description: "Third-party integration detected.",
|
|
15031
|
+
properties: {
|
|
15032
|
+
message: { type: "string" },
|
|
15033
|
+
warning_code: {
|
|
15034
|
+
description: "Unique identifier of the type of warning. Enables quick recognition and categorization of the issue.",
|
|
15035
|
+
enum: ["third_party_integration_detected"],
|
|
15036
|
+
type: "string"
|
|
15037
|
+
}
|
|
15038
|
+
},
|
|
15039
|
+
required: ["message", "warning_code"],
|
|
15040
|
+
type: "object"
|
|
15041
|
+
},
|
|
15042
|
+
{
|
|
15043
|
+
description: "Nest thermostat in manual eco mode.",
|
|
15044
|
+
properties: {
|
|
15045
|
+
message: { type: "string" },
|
|
15046
|
+
warning_code: {
|
|
15047
|
+
description: "Unique identifier of the type of warning. Enables quick recognition and categorization of the issue.",
|
|
15048
|
+
enum: ["nest_thermostat_in_manual_eco_mode"],
|
|
15049
|
+
type: "string"
|
|
15050
|
+
}
|
|
15051
|
+
},
|
|
15052
|
+
required: ["message", "warning_code"],
|
|
15053
|
+
type: "object"
|
|
15054
|
+
},
|
|
15055
|
+
{
|
|
15056
|
+
description: "Remote Unlock feature not enabled in settings.",
|
|
15057
|
+
properties: {
|
|
15058
|
+
message: { type: "string" },
|
|
15059
|
+
warning_code: {
|
|
15060
|
+
description: "Unique identifier of the type of warning. Enables quick recognition and categorization of the issue.",
|
|
15061
|
+
enum: ["ttlock_lock_gateway_unlocking_not_enabled"],
|
|
15062
|
+
type: "string"
|
|
15063
|
+
}
|
|
15064
|
+
},
|
|
15065
|
+
required: ["message", "warning_code"],
|
|
15066
|
+
type: "object"
|
|
15067
|
+
},
|
|
15068
|
+
{
|
|
15069
|
+
description: "Gateway signal is weak.",
|
|
15070
|
+
properties: {
|
|
15071
|
+
message: { type: "string" },
|
|
15072
|
+
warning_code: {
|
|
15073
|
+
description: "Unique identifier of the type of warning. Enables quick recognition and categorization of the issue.",
|
|
15074
|
+
enum: ["ttlock_weak_gateway_signal"],
|
|
15075
|
+
type: "string"
|
|
15076
|
+
}
|
|
15077
|
+
},
|
|
15078
|
+
required: ["message", "warning_code"],
|
|
15079
|
+
type: "object"
|
|
15080
|
+
},
|
|
15081
|
+
{
|
|
15082
|
+
description: "Temperature threshold exceeded.",
|
|
15083
|
+
properties: {
|
|
15084
|
+
message: { type: "string" },
|
|
15085
|
+
warning_code: {
|
|
15086
|
+
description: "Unique identifier of the type of warning. Enables quick recognition and categorization of the issue.",
|
|
15087
|
+
enum: ["temperature_threshold_exceeded"],
|
|
15088
|
+
type: "string"
|
|
15089
|
+
}
|
|
15090
|
+
},
|
|
15091
|
+
required: ["message", "warning_code"],
|
|
15092
|
+
type: "object"
|
|
15093
|
+
},
|
|
15094
|
+
{
|
|
15095
|
+
description: "Device appears to be unresponsive.",
|
|
15096
|
+
properties: {
|
|
15097
|
+
message: { type: "string" },
|
|
15098
|
+
warning_code: {
|
|
15099
|
+
description: "Unique identifier of the type of warning. Enables quick recognition and categorization of the issue.",
|
|
15100
|
+
enum: ["device_communication_degraded"],
|
|
15101
|
+
type: "string"
|
|
15102
|
+
}
|
|
15103
|
+
},
|
|
15104
|
+
required: ["message", "warning_code"],
|
|
15105
|
+
type: "object"
|
|
15106
|
+
},
|
|
15107
|
+
{
|
|
15108
|
+
description: "Scheduled maintenance window detected.",
|
|
15109
|
+
properties: {
|
|
15110
|
+
message: { type: "string" },
|
|
15111
|
+
warning_code: {
|
|
15112
|
+
description: "Unique identifier of the type of warning. Enables quick recognition and categorization of the issue.",
|
|
15113
|
+
enum: ["scheduled_maintenance_window"],
|
|
15114
|
+
type: "string"
|
|
15115
|
+
}
|
|
15116
|
+
},
|
|
15117
|
+
required: ["message", "warning_code"],
|
|
15118
|
+
type: "object"
|
|
15119
|
+
},
|
|
15120
|
+
{
|
|
15121
|
+
description: "Device has flaky connection.",
|
|
15122
|
+
properties: {
|
|
15123
|
+
message: { type: "string" },
|
|
15124
|
+
warning_code: {
|
|
15125
|
+
description: "Unique identifier of the type of warning. Enables quick recognition and categorization of the issue.",
|
|
15126
|
+
enum: ["device_has_flaky_connection"],
|
|
15127
|
+
type: "string"
|
|
15128
|
+
}
|
|
14479
15129
|
},
|
|
14480
|
-
|
|
14481
|
-
|
|
14482
|
-
|
|
15130
|
+
required: ["message", "warning_code"],
|
|
15131
|
+
type: "object"
|
|
15132
|
+
},
|
|
15133
|
+
{
|
|
15134
|
+
description: "Lock is in Office Mode. Access Codes will not unlock doors.",
|
|
15135
|
+
properties: {
|
|
15136
|
+
message: { type: "string" },
|
|
15137
|
+
warning_code: {
|
|
15138
|
+
description: "Unique identifier of the type of warning. Enables quick recognition and categorization of the issue.",
|
|
15139
|
+
enum: ["salto_office_mode"],
|
|
15140
|
+
type: "string"
|
|
15141
|
+
}
|
|
14483
15142
|
},
|
|
14484
|
-
|
|
14485
|
-
|
|
14486
|
-
type: "boolean"
|
|
14487
|
-
}
|
|
15143
|
+
required: ["message", "warning_code"],
|
|
15144
|
+
type: "object"
|
|
14488
15145
|
},
|
|
14489
|
-
|
|
14490
|
-
|
|
14491
|
-
|
|
14492
|
-
|
|
14493
|
-
|
|
14494
|
-
|
|
14495
|
-
|
|
14496
|
-
|
|
14497
|
-
|
|
14498
|
-
|
|
14499
|
-
|
|
14500
|
-
|
|
14501
|
-
|
|
14502
|
-
|
|
14503
|
-
description: "Indicates whether the device is online.",
|
|
14504
|
-
type: "boolean"
|
|
14505
|
-
},
|
|
14506
|
-
online_access_codes_enabled: {
|
|
14507
|
-
description: "Indicates whether it is currently possible to use online access codes for the device.",
|
|
14508
|
-
type: "boolean"
|
|
14509
|
-
}
|
|
14510
|
-
},
|
|
14511
|
-
required: ["name", "online", "model"],
|
|
14512
|
-
type: "object"
|
|
14513
|
-
},
|
|
14514
|
-
warnings: {
|
|
14515
|
-
description: 'Array of warnings associated with the device. Each warning object within the array contains two fields: "warning_code" and "message." "warning_code" is a string that uniquely identifies the type of warning, enabling quick recognition and categorization of the issue. "message" provides a more detailed description of the warning, offering insights into the issue and potentially how to rectify it.',
|
|
14516
|
-
items: {
|
|
14517
|
-
properties: {
|
|
14518
|
-
message: { type: "string" },
|
|
14519
|
-
warning_code: { type: "string" }
|
|
14520
|
-
},
|
|
14521
|
-
required: ["message", "warning_code"],
|
|
14522
|
-
type: "object"
|
|
15146
|
+
{
|
|
15147
|
+
description: "Lock is in Privacy Mode. Access Codes will not unlock doors.",
|
|
15148
|
+
properties: {
|
|
15149
|
+
message: { type: "string" },
|
|
15150
|
+
warning_code: {
|
|
15151
|
+
description: "Unique identifier of the type of warning. Enables quick recognition and categorization of the issue.",
|
|
15152
|
+
enum: ["salto_privacy_mode"],
|
|
15153
|
+
type: "string"
|
|
15154
|
+
}
|
|
15155
|
+
},
|
|
15156
|
+
required: ["message", "warning_code"],
|
|
15157
|
+
type: "object"
|
|
15158
|
+
}
|
|
15159
|
+
]
|
|
14523
15160
|
},
|
|
14524
15161
|
type: "array"
|
|
14525
15162
|
},
|
|
@@ -23265,160 +23902,160 @@ var openapi_default = {
|
|
|
23265
23902
|
},
|
|
23266
23903
|
event_type: {
|
|
23267
23904
|
enum: [
|
|
23268
|
-
"device.accessory_keypad_connected",
|
|
23269
|
-
"device.accessory_keypad_disconnected",
|
|
23270
|
-
"device.added",
|
|
23271
|
-
"device.connected",
|
|
23272
|
-
"device.unmanaged.connected",
|
|
23273
|
-
"device.disconnected",
|
|
23274
|
-
"device.unmanaged.disconnected",
|
|
23275
|
-
"device.converted_to_unmanaged",
|
|
23276
|
-
"device.unmanaged.converted_to_managed",
|
|
23277
|
-
"device.removed",
|
|
23278
|
-
"device.deleted",
|
|
23279
|
-
"device.tampered",
|
|
23280
|
-
"device.low_battery",
|
|
23281
|
-
"device.battery_status_changed",
|
|
23282
|
-
"device.third_party_integration_detected",
|
|
23283
|
-
"device.third_party_integration_no_longer_detected",
|
|
23284
|
-
"device.salto.privacy_mode_activated",
|
|
23285
|
-
"device.salto.privacy_mode_deactivated",
|
|
23286
|
-
"device.connection_became_flaky",
|
|
23287
|
-
"device.connection_stabilized",
|
|
23288
|
-
"device.error.subscription_required",
|
|
23289
|
-
"device.error.subscription_required.resolved",
|
|
23290
23905
|
"access_code.created",
|
|
23291
23906
|
"access_code.changed",
|
|
23292
23907
|
"access_code.scheduled_on_device",
|
|
23293
23908
|
"access_code.set_on_device",
|
|
23294
|
-
"access_code.deleted",
|
|
23295
23909
|
"access_code.removed_from_device",
|
|
23296
|
-
"access_code.failed_to_set_on_device",
|
|
23297
23910
|
"access_code.delay_in_setting_on_device",
|
|
23298
|
-
"access_code.
|
|
23911
|
+
"access_code.failed_to_set_on_device",
|
|
23912
|
+
"access_code.deleted",
|
|
23299
23913
|
"access_code.delay_in_removing_from_device",
|
|
23300
|
-
"access_code.
|
|
23914
|
+
"access_code.failed_to_remove_from_device",
|
|
23301
23915
|
"access_code.modified_external_to_seam",
|
|
23916
|
+
"access_code.deleted_external_to_seam",
|
|
23917
|
+
"access_code.backup_access_code_pulled",
|
|
23302
23918
|
"access_code.unmanaged.converted_to_managed",
|
|
23303
23919
|
"access_code.unmanaged.failed_to_convert_to_managed",
|
|
23304
23920
|
"access_code.unmanaged.created",
|
|
23305
23921
|
"access_code.unmanaged.removed",
|
|
23306
|
-
"lock.locked",
|
|
23307
|
-
"lock.unlocked",
|
|
23308
|
-
"lock.access_denied",
|
|
23309
|
-
"phone.deactivated",
|
|
23310
|
-
"connected_account.connected",
|
|
23311
|
-
"connected_account.successful_login",
|
|
23312
|
-
"connected_account.created",
|
|
23313
|
-
"connected_account.deleted",
|
|
23314
|
-
"connected_account.disconnected",
|
|
23315
|
-
"connected_account.completed_first_sync",
|
|
23316
|
-
"connected_account.completed_first_sync_after_reconnection",
|
|
23317
|
-
"connect_webview.login_succeeded",
|
|
23318
|
-
"connect_webview.login_failed",
|
|
23319
|
-
"noise_sensor.noise_threshold_triggered",
|
|
23320
|
-
"access_code.backup_access_code_pulled",
|
|
23321
|
-
"acs_system.added",
|
|
23322
23922
|
"acs_system.connected",
|
|
23923
|
+
"acs_system.added",
|
|
23323
23924
|
"acs_system.disconnected",
|
|
23324
|
-
"acs_access_group.deleted",
|
|
23325
|
-
"acs_user.deleted",
|
|
23326
23925
|
"acs_credential.deleted",
|
|
23327
23926
|
"acs_credential.issued",
|
|
23328
23927
|
"acs_credential.reissued",
|
|
23928
|
+
"acs_user.deleted",
|
|
23329
23929
|
"acs_encoder.added",
|
|
23330
23930
|
"acs_encoder.removed",
|
|
23331
|
-
"
|
|
23931
|
+
"acs_access_group.deleted",
|
|
23332
23932
|
"client_session.deleted",
|
|
23933
|
+
"connected_account.connected",
|
|
23934
|
+
"connected_account.created",
|
|
23935
|
+
"connected_account.successful_login",
|
|
23936
|
+
"connected_account.disconnected",
|
|
23937
|
+
"connected_account.completed_first_sync",
|
|
23938
|
+
"connected_account.deleted",
|
|
23939
|
+
"connected_account.completed_first_sync_after_reconnection",
|
|
23333
23940
|
"action_attempt.lock_door.succeeded",
|
|
23334
23941
|
"action_attempt.lock_door.failed",
|
|
23335
23942
|
"action_attempt.unlock_door.succeeded",
|
|
23336
23943
|
"action_attempt.unlock_door.failed",
|
|
23944
|
+
"connect_webview.login_succeeded",
|
|
23945
|
+
"connect_webview.login_failed",
|
|
23946
|
+
"device.connected",
|
|
23947
|
+
"device.added",
|
|
23948
|
+
"device.converted_to_unmanaged",
|
|
23949
|
+
"device.unmanaged.converted_to_managed",
|
|
23950
|
+
"device.unmanaged.connected",
|
|
23951
|
+
"device.disconnected",
|
|
23952
|
+
"device.unmanaged.disconnected",
|
|
23953
|
+
"device.tampered",
|
|
23954
|
+
"device.low_battery",
|
|
23955
|
+
"device.battery_status_changed",
|
|
23956
|
+
"device.removed",
|
|
23957
|
+
"device.deleted",
|
|
23958
|
+
"device.third_party_integration_detected",
|
|
23959
|
+
"device.third_party_integration_no_longer_detected",
|
|
23960
|
+
"device.salto.privacy_mode_activated",
|
|
23961
|
+
"device.salto.privacy_mode_deactivated",
|
|
23962
|
+
"device.connection_became_flaky",
|
|
23963
|
+
"device.connection_stabilized",
|
|
23964
|
+
"device.error.subscription_required",
|
|
23965
|
+
"device.error.subscription_required.resolved",
|
|
23966
|
+
"device.accessory_keypad_connected",
|
|
23967
|
+
"device.accessory_keypad_disconnected",
|
|
23968
|
+
"noise_sensor.noise_threshold_triggered",
|
|
23969
|
+
"lock.locked",
|
|
23970
|
+
"lock.unlocked",
|
|
23971
|
+
"lock.access_denied",
|
|
23337
23972
|
"thermostat.climate_preset_activated",
|
|
23338
23973
|
"thermostat.manually_adjusted",
|
|
23339
23974
|
"thermostat.temperature_threshold_exceeded",
|
|
23340
23975
|
"thermostat.temperature_threshold_no_longer_exceeded",
|
|
23341
|
-
"thermostat.temperature_reached_set_point"
|
|
23976
|
+
"thermostat.temperature_reached_set_point",
|
|
23977
|
+
"enrollment_automation.deleted",
|
|
23978
|
+
"phone.deactivated"
|
|
23342
23979
|
],
|
|
23343
23980
|
type: "string"
|
|
23344
23981
|
},
|
|
23345
23982
|
event_types: {
|
|
23346
23983
|
items: {
|
|
23347
23984
|
enum: [
|
|
23348
|
-
"device.accessory_keypad_connected",
|
|
23349
|
-
"device.accessory_keypad_disconnected",
|
|
23350
|
-
"device.added",
|
|
23351
|
-
"device.connected",
|
|
23352
|
-
"device.unmanaged.connected",
|
|
23353
|
-
"device.disconnected",
|
|
23354
|
-
"device.unmanaged.disconnected",
|
|
23355
|
-
"device.converted_to_unmanaged",
|
|
23356
|
-
"device.unmanaged.converted_to_managed",
|
|
23357
|
-
"device.removed",
|
|
23358
|
-
"device.deleted",
|
|
23359
|
-
"device.tampered",
|
|
23360
|
-
"device.low_battery",
|
|
23361
|
-
"device.battery_status_changed",
|
|
23362
|
-
"device.third_party_integration_detected",
|
|
23363
|
-
"device.third_party_integration_no_longer_detected",
|
|
23364
|
-
"device.salto.privacy_mode_activated",
|
|
23365
|
-
"device.salto.privacy_mode_deactivated",
|
|
23366
|
-
"device.connection_became_flaky",
|
|
23367
|
-
"device.connection_stabilized",
|
|
23368
|
-
"device.error.subscription_required",
|
|
23369
|
-
"device.error.subscription_required.resolved",
|
|
23370
23985
|
"access_code.created",
|
|
23371
23986
|
"access_code.changed",
|
|
23372
23987
|
"access_code.scheduled_on_device",
|
|
23373
23988
|
"access_code.set_on_device",
|
|
23374
|
-
"access_code.deleted",
|
|
23375
23989
|
"access_code.removed_from_device",
|
|
23376
|
-
"access_code.failed_to_set_on_device",
|
|
23377
23990
|
"access_code.delay_in_setting_on_device",
|
|
23378
|
-
"access_code.
|
|
23991
|
+
"access_code.failed_to_set_on_device",
|
|
23992
|
+
"access_code.deleted",
|
|
23379
23993
|
"access_code.delay_in_removing_from_device",
|
|
23380
|
-
"access_code.
|
|
23994
|
+
"access_code.failed_to_remove_from_device",
|
|
23381
23995
|
"access_code.modified_external_to_seam",
|
|
23996
|
+
"access_code.deleted_external_to_seam",
|
|
23997
|
+
"access_code.backup_access_code_pulled",
|
|
23382
23998
|
"access_code.unmanaged.converted_to_managed",
|
|
23383
23999
|
"access_code.unmanaged.failed_to_convert_to_managed",
|
|
23384
24000
|
"access_code.unmanaged.created",
|
|
23385
24001
|
"access_code.unmanaged.removed",
|
|
23386
|
-
"lock.locked",
|
|
23387
|
-
"lock.unlocked",
|
|
23388
|
-
"lock.access_denied",
|
|
23389
|
-
"phone.deactivated",
|
|
23390
|
-
"connected_account.connected",
|
|
23391
|
-
"connected_account.successful_login",
|
|
23392
|
-
"connected_account.created",
|
|
23393
|
-
"connected_account.deleted",
|
|
23394
|
-
"connected_account.disconnected",
|
|
23395
|
-
"connected_account.completed_first_sync",
|
|
23396
|
-
"connected_account.completed_first_sync_after_reconnection",
|
|
23397
|
-
"connect_webview.login_succeeded",
|
|
23398
|
-
"connect_webview.login_failed",
|
|
23399
|
-
"noise_sensor.noise_threshold_triggered",
|
|
23400
|
-
"access_code.backup_access_code_pulled",
|
|
23401
|
-
"acs_system.added",
|
|
23402
24002
|
"acs_system.connected",
|
|
24003
|
+
"acs_system.added",
|
|
23403
24004
|
"acs_system.disconnected",
|
|
23404
|
-
"acs_access_group.deleted",
|
|
23405
|
-
"acs_user.deleted",
|
|
23406
24005
|
"acs_credential.deleted",
|
|
23407
24006
|
"acs_credential.issued",
|
|
23408
24007
|
"acs_credential.reissued",
|
|
24008
|
+
"acs_user.deleted",
|
|
23409
24009
|
"acs_encoder.added",
|
|
23410
24010
|
"acs_encoder.removed",
|
|
23411
|
-
"
|
|
24011
|
+
"acs_access_group.deleted",
|
|
23412
24012
|
"client_session.deleted",
|
|
24013
|
+
"connected_account.connected",
|
|
24014
|
+
"connected_account.created",
|
|
24015
|
+
"connected_account.successful_login",
|
|
24016
|
+
"connected_account.disconnected",
|
|
24017
|
+
"connected_account.completed_first_sync",
|
|
24018
|
+
"connected_account.deleted",
|
|
24019
|
+
"connected_account.completed_first_sync_after_reconnection",
|
|
23413
24020
|
"action_attempt.lock_door.succeeded",
|
|
23414
24021
|
"action_attempt.lock_door.failed",
|
|
23415
24022
|
"action_attempt.unlock_door.succeeded",
|
|
23416
24023
|
"action_attempt.unlock_door.failed",
|
|
24024
|
+
"connect_webview.login_succeeded",
|
|
24025
|
+
"connect_webview.login_failed",
|
|
24026
|
+
"device.connected",
|
|
24027
|
+
"device.added",
|
|
24028
|
+
"device.converted_to_unmanaged",
|
|
24029
|
+
"device.unmanaged.converted_to_managed",
|
|
24030
|
+
"device.unmanaged.connected",
|
|
24031
|
+
"device.disconnected",
|
|
24032
|
+
"device.unmanaged.disconnected",
|
|
24033
|
+
"device.tampered",
|
|
24034
|
+
"device.low_battery",
|
|
24035
|
+
"device.battery_status_changed",
|
|
24036
|
+
"device.removed",
|
|
24037
|
+
"device.deleted",
|
|
24038
|
+
"device.third_party_integration_detected",
|
|
24039
|
+
"device.third_party_integration_no_longer_detected",
|
|
24040
|
+
"device.salto.privacy_mode_activated",
|
|
24041
|
+
"device.salto.privacy_mode_deactivated",
|
|
24042
|
+
"device.connection_became_flaky",
|
|
24043
|
+
"device.connection_stabilized",
|
|
24044
|
+
"device.error.subscription_required",
|
|
24045
|
+
"device.error.subscription_required.resolved",
|
|
24046
|
+
"device.accessory_keypad_connected",
|
|
24047
|
+
"device.accessory_keypad_disconnected",
|
|
24048
|
+
"noise_sensor.noise_threshold_triggered",
|
|
24049
|
+
"lock.locked",
|
|
24050
|
+
"lock.unlocked",
|
|
24051
|
+
"lock.access_denied",
|
|
23417
24052
|
"thermostat.climate_preset_activated",
|
|
23418
24053
|
"thermostat.manually_adjusted",
|
|
23419
24054
|
"thermostat.temperature_threshold_exceeded",
|
|
23420
24055
|
"thermostat.temperature_threshold_no_longer_exceeded",
|
|
23421
|
-
"thermostat.temperature_reached_set_point"
|
|
24056
|
+
"thermostat.temperature_reached_set_point",
|
|
24057
|
+
"enrollment_automation.deleted",
|
|
24058
|
+
"phone.deactivated"
|
|
23422
24059
|
],
|
|
23423
24060
|
type: "string"
|
|
23424
24061
|
},
|