@seamapi/types 1.324.0 → 1.326.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 +1078 -52
- package/dist/connect.cjs.map +1 -1
- package/dist/connect.d.cts +3242 -217
- package/lib/seam/connect/models/access-codes/managed-access-code.d.ts +257 -5
- package/lib/seam/connect/models/access-codes/unmanaged-access-code.d.ts +257 -5
- package/lib/seam/connect/models/acs/acs-system.d.ts +10 -10
- package/lib/seam/connect/models/devices/device.d.ts +419 -11
- package/lib/seam/connect/models/devices/device.js +103 -3
- package/lib/seam/connect/models/devices/device.js.map +1 -1
- package/lib/seam/connect/models/devices/phone.d.ts +258 -6
- package/lib/seam/connect/models/devices/unmanaged-device.d.ts +258 -6
- package/lib/seam/connect/models/events/devices.d.ts +78 -0
- package/lib/seam/connect/models/events/devices.js +18 -0
- package/lib/seam/connect/models/events/devices.js.map +1 -1
- package/lib/seam/connect/models/events/seam-event.d.ts +38 -0
- package/lib/seam/connect/openapi.d.ts +272 -79
- package/lib/seam/connect/openapi.js +997 -35
- package/lib/seam/connect/openapi.js.map +1 -1
- package/lib/seam/connect/route-types.d.ts +1677 -47
- package/package.json +1 -1
- package/src/lib/seam/connect/models/devices/device.ts +118 -3
- package/src/lib/seam/connect/models/events/devices.ts +27 -0
- package/src/lib/seam/connect/openapi.ts +1095 -59
- package/src/lib/seam/connect/route-types.ts +2128 -130
package/dist/connect.cjs
CHANGED
|
@@ -812,12 +812,64 @@ var common_device_error = zod.z.object({
|
|
|
812
812
|
message: zod.z.string(),
|
|
813
813
|
is_device_error: zod.z.literal(true)
|
|
814
814
|
});
|
|
815
|
+
var error_code_description = "Unique identifier of the type of error. Enables quick recognition and categorization of the issue.";
|
|
815
816
|
var common_device_warning = zod.z.object({
|
|
816
817
|
message: zod.z.string()
|
|
817
818
|
});
|
|
818
|
-
var
|
|
819
|
-
error_code: zod.z.
|
|
820
|
-
});
|
|
819
|
+
var device_offline = common_device_error.extend({
|
|
820
|
+
error_code: zod.z.literal("device_offline").describe(error_code_description)
|
|
821
|
+
}).describe("Device is offline");
|
|
822
|
+
var device_removed = common_device_error.extend({
|
|
823
|
+
error_code: zod.z.literal("device_removed").describe(error_code_description)
|
|
824
|
+
}).describe("Device has been removed");
|
|
825
|
+
var account_disconnected = common_device_error.extend({
|
|
826
|
+
error_code: zod.z.literal("account_disconnected").describe(error_code_description)
|
|
827
|
+
}).describe("Account is disconnected");
|
|
828
|
+
var hub_disconnected = common_device_error.extend({
|
|
829
|
+
error_code: zod.z.literal("hub_disconnected").describe(error_code_description)
|
|
830
|
+
}).describe("Hub is disconnected");
|
|
831
|
+
var device_disconnected = common_device_error.extend({
|
|
832
|
+
error_code: zod.z.literal("device_disconnected").describe(error_code_description)
|
|
833
|
+
}).describe("Device is disconnected");
|
|
834
|
+
var empty_backup_access_code_pool = common_device_error.extend({
|
|
835
|
+
error_code: zod.z.literal("empty_backup_access_code_pool").describe(error_code_description)
|
|
836
|
+
}).describe("The backup access code pool is empty.");
|
|
837
|
+
var august_lock_not_authorized = common_device_error.extend({
|
|
838
|
+
error_code: zod.z.literal("august_lock_not_authorized").describe(error_code_description)
|
|
839
|
+
}).describe("User is not authorized to use the August Lock.");
|
|
840
|
+
var august_lock_missing_bridge = common_device_error.extend({
|
|
841
|
+
error_code: zod.z.literal("august_lock_missing_bridge").describe(error_code_description)
|
|
842
|
+
}).describe("Lock is not connected to the Seam Bridge.");
|
|
843
|
+
var salto_site_user_limit_reached = common_device_error.extend({
|
|
844
|
+
error_code: zod.z.literal("salto_site_user_limit_reached").describe(error_code_description)
|
|
845
|
+
}).describe("Salto site user limit reached.");
|
|
846
|
+
var ttlock_lock_not_paired_to_gateway = common_device_error.extend({
|
|
847
|
+
error_code: zod.z.literal("ttlock_lock_not_paired_to_gateway").describe(error_code_description)
|
|
848
|
+
}).describe("Lock is not paired with a Gateway.");
|
|
849
|
+
var missing_device_credentials = common_device_error.extend({
|
|
850
|
+
error_code: zod.z.literal("missing_device_credentials").describe(error_code_description)
|
|
851
|
+
}).describe("Missing device credentials.");
|
|
852
|
+
var auxiliary_heat_running = common_device_error.extend({
|
|
853
|
+
error_code: zod.z.literal("auxiliary_heat_running").describe(error_code_description)
|
|
854
|
+
}).describe("The auxiliary heat is running.");
|
|
855
|
+
var subscription_required = common_device_error.extend({
|
|
856
|
+
error_code: zod.z.literal("subscription_required").describe(error_code_description)
|
|
857
|
+
}).describe("Subscription required to connect.");
|
|
858
|
+
var device_error = zod.z.union([
|
|
859
|
+
device_offline,
|
|
860
|
+
device_removed,
|
|
861
|
+
account_disconnected,
|
|
862
|
+
hub_disconnected,
|
|
863
|
+
device_disconnected,
|
|
864
|
+
empty_backup_access_code_pool,
|
|
865
|
+
august_lock_not_authorized,
|
|
866
|
+
august_lock_missing_bridge,
|
|
867
|
+
salto_site_user_limit_reached,
|
|
868
|
+
ttlock_lock_not_paired_to_gateway,
|
|
869
|
+
missing_device_credentials,
|
|
870
|
+
auxiliary_heat_running,
|
|
871
|
+
subscription_required
|
|
872
|
+
]).describe("Error associated with the `device`.");
|
|
821
873
|
var device_warning = common_device_warning.extend({
|
|
822
874
|
warning_code: zod.z.string()
|
|
823
875
|
});
|
|
@@ -1427,9 +1479,9 @@ var common_acs_encoder_error = zod.z.object({
|
|
|
1427
1479
|
"Detailed description of the error. Provides insights into the issue and potentially how to rectify it."
|
|
1428
1480
|
)
|
|
1429
1481
|
});
|
|
1430
|
-
var
|
|
1482
|
+
var error_code_description2 = "Unique identifier of the type of error. Enables quick recognition and categorization of the issue.";
|
|
1431
1483
|
var acs_encoder_removed = common_acs_encoder_error.extend({
|
|
1432
|
-
error_code: zod.z.literal("acs_encoder_removed").describe(
|
|
1484
|
+
error_code: zod.z.literal("acs_encoder_removed").describe(error_code_description2)
|
|
1433
1485
|
});
|
|
1434
1486
|
var acs_encoder_error = (
|
|
1435
1487
|
// z.union([
|
|
@@ -1515,29 +1567,29 @@ var common_acs_system_error = zod.z.object({
|
|
|
1515
1567
|
"Detailed description of the error. Provides insights into the issue and potentially how to rectify it."
|
|
1516
1568
|
)
|
|
1517
1569
|
});
|
|
1518
|
-
var
|
|
1570
|
+
var error_code_description3 = "Unique identifier of the type of error. Enables quick recognition and categorization of the issue.";
|
|
1519
1571
|
var seam_bridge_disconnected = common_acs_system_error.extend({
|
|
1520
|
-
error_code: zod.z.literal("seam_bridge_disconnected").describe(
|
|
1572
|
+
error_code: zod.z.literal("seam_bridge_disconnected").describe(error_code_description3)
|
|
1521
1573
|
}).describe(`Indicates that the Seam API cannot communicate with the [Seam Bridge](https://docs.seam.co/latest/capability-guides/seam-bridge), for example, if the Seam Bridge executable has stopped or if the computer running the Seam Bridge executable is offline.
|
|
1522
1574
|
This error might also occur if the Seam Bridge is connected to the wrong [workspace](https://docs.seam.co/latest/core-concepts/workspaces).
|
|
1523
1575
|
See also [Troubleshooting Your Access Control System](https://docs.seam.co/latest/capability-guides/capability-guides/access-systems/troubleshooting-your-access-control-system#acs_system.errors.seam_bridge_disconnected).`);
|
|
1524
1576
|
var visionline_instance_unreachable = common_acs_system_error.extend({
|
|
1525
|
-
error_code: zod.z.literal("visionline_instance_unreachable").describe(
|
|
1577
|
+
error_code: zod.z.literal("visionline_instance_unreachable").describe(error_code_description3)
|
|
1526
1578
|
}).describe(`Indicates that the Seam Bridge is functioning correctly and the Seam API can communicate with the Seam Bridge, but the Seam API cannot connect to the on-premises [Visionline access control system](https://docs.seam.co/latest/device-and-system-integration-guides/assa-abloy-visionline-access-control-system).
|
|
1527
1579
|
For example, the IP address of the on-premises access control system may be set incorrectly within the Seam [workspace](https://docs.seam.co/latest/core-concepts/workspaces).
|
|
1528
1580
|
See also [Troubleshooting Your Access Control System](https://docs.seam.co/latest/capability-guides/capability-guides/access-systems/troubleshooting-your-access-control-system#acs_system.errors.visionline_instance_unreachable).`);
|
|
1529
1581
|
var salto_ks_subscription_limit_exceeded = common_acs_system_error.extend({
|
|
1530
|
-
error_code: zod.z.literal("salto_ks_subscription_limit_exceeded").describe(
|
|
1582
|
+
error_code: zod.z.literal("salto_ks_subscription_limit_exceeded").describe(error_code_description3)
|
|
1531
1583
|
}).describe(
|
|
1532
1584
|
"Indicates that the maximum number of users allowed for the site has been reached. This means that new access codes cannot be created. Contact Salto support to increase the user limit."
|
|
1533
1585
|
);
|
|
1534
1586
|
var acs_system_disconnected = common_acs_system_error.extend({
|
|
1535
|
-
error_code: zod.z.literal("acs_system_disconnected").describe(
|
|
1587
|
+
error_code: zod.z.literal("acs_system_disconnected").describe(error_code_description3)
|
|
1536
1588
|
}).describe(
|
|
1537
1589
|
"Indicates that the access system has been disconnected. See [this guide](https://docs.seam.co/latest/capability-guides/access-systems/troubleshooting-your-access-control-system guide) to resolve the issue."
|
|
1538
1590
|
);
|
|
1539
|
-
var
|
|
1540
|
-
error_code: zod.z.literal("account_disconnected").describe(
|
|
1591
|
+
var account_disconnected2 = common_acs_system_error.extend({
|
|
1592
|
+
error_code: zod.z.literal("account_disconnected").describe(error_code_description3)
|
|
1541
1593
|
}).describe(
|
|
1542
1594
|
"Indicates that the login credentials are invalid. Reconnect the account using the Connect Webview to restore access."
|
|
1543
1595
|
);
|
|
@@ -1551,7 +1603,7 @@ var acs_system_error = zod.z.union([
|
|
|
1551
1603
|
visionline_instance_unreachable,
|
|
1552
1604
|
salto_ks_subscription_limit_exceeded,
|
|
1553
1605
|
acs_system_disconnected,
|
|
1554
|
-
|
|
1606
|
+
account_disconnected2,
|
|
1555
1607
|
salto_ks_certification_expired
|
|
1556
1608
|
]).describe("Error associated with the `acs_system`.");
|
|
1557
1609
|
zod.z.object({
|
|
@@ -1559,7 +1611,7 @@ zod.z.object({
|
|
|
1559
1611
|
visionline_instance_unreachable: visionline_instance_unreachable.optional().nullable(),
|
|
1560
1612
|
salto_ks_subscription_limit_exceeded: salto_ks_subscription_limit_exceeded.optional().nullable(),
|
|
1561
1613
|
acs_system_disconnected: acs_system_disconnected.optional().nullable(),
|
|
1562
|
-
account_disconnected:
|
|
1614
|
+
account_disconnected: account_disconnected2.optional().nullable(),
|
|
1563
1615
|
salto_ks_certification_expired: salto_ks_certification_expired.optional().nullable()
|
|
1564
1616
|
});
|
|
1565
1617
|
var common_acs_system_warning = zod.z.object({
|
|
@@ -2810,6 +2862,17 @@ var temperature_threshold_no_longer_exceeded_event = device_event.extend({
|
|
|
2810
2862
|
}).describe(
|
|
2811
2863
|
"A [thermostat's](https://docs.seam.co/latest/capability-guides/thermostats) temperature reading no longer exceeds the set [threshold](https://docs.seam.co/latest/capability-guides/thermostats/setting-and-monitoring-temperature-thresholds)."
|
|
2812
2864
|
);
|
|
2865
|
+
var temperature_reached_set_point_event = device_event.extend({
|
|
2866
|
+
event_type: zod.z.literal("thermostat.temperature_reached_set_point"),
|
|
2867
|
+
temperature_celsius: zod.z.number().describe("Temperature, in \xB0C, reported by the thermostat."),
|
|
2868
|
+
temperature_fahrenheit: zod.z.number().describe("Temperature, in \xB0F, reported by the thermostat."),
|
|
2869
|
+
desired_temperature_celsius: zod.z.number().optional().describe(
|
|
2870
|
+
"Desired temperature, in \xB0C, set by the thermostat's cooling or heating set point."
|
|
2871
|
+
),
|
|
2872
|
+
desired_temperature_fahrenheit: zod.z.number().optional().describe(
|
|
2873
|
+
"Desired temperature, in \xB0F, set by the thermostat's cooling or heating set point."
|
|
2874
|
+
)
|
|
2875
|
+
});
|
|
2813
2876
|
var device_events = [
|
|
2814
2877
|
device_connected_event,
|
|
2815
2878
|
device_added_event,
|
|
@@ -2840,7 +2903,8 @@ var device_events = [
|
|
|
2840
2903
|
thermostat_climate_preset_activated_event,
|
|
2841
2904
|
thermostat_manually_adjusted_event,
|
|
2842
2905
|
temperature_threshold_exceeded_event,
|
|
2843
|
-
temperature_threshold_no_longer_exceeded_event
|
|
2906
|
+
temperature_threshold_no_longer_exceeded_event,
|
|
2907
|
+
temperature_reached_set_point_event
|
|
2844
2908
|
];
|
|
2845
2909
|
var enrollment_automation_event = common_event.extend({
|
|
2846
2910
|
enrollment_automation_id: zod.z.string().uuid().describe(
|
|
@@ -2975,13 +3039,191 @@ var openapi_default = {
|
|
|
2975
3039
|
type: "object"
|
|
2976
3040
|
},
|
|
2977
3041
|
{
|
|
2978
|
-
|
|
2979
|
-
|
|
2980
|
-
|
|
2981
|
-
|
|
2982
|
-
|
|
2983
|
-
|
|
2984
|
-
|
|
3042
|
+
description: "Error associated with the `device`.",
|
|
3043
|
+
oneOf: [
|
|
3044
|
+
{
|
|
3045
|
+
description: "Device is offline",
|
|
3046
|
+
properties: {
|
|
3047
|
+
error_code: {
|
|
3048
|
+
description: "Unique identifier of the type of error. Enables quick recognition and categorization of the issue.",
|
|
3049
|
+
enum: ["device_offline"],
|
|
3050
|
+
type: "string"
|
|
3051
|
+
},
|
|
3052
|
+
is_device_error: { enum: [true], type: "boolean" },
|
|
3053
|
+
message: { type: "string" }
|
|
3054
|
+
},
|
|
3055
|
+
required: ["message", "is_device_error", "error_code"],
|
|
3056
|
+
type: "object"
|
|
3057
|
+
},
|
|
3058
|
+
{
|
|
3059
|
+
description: "Device has been removed",
|
|
3060
|
+
properties: {
|
|
3061
|
+
error_code: {
|
|
3062
|
+
description: "Unique identifier of the type of error. Enables quick recognition and categorization of the issue.",
|
|
3063
|
+
enum: ["device_removed"],
|
|
3064
|
+
type: "string"
|
|
3065
|
+
},
|
|
3066
|
+
is_device_error: { enum: [true], type: "boolean" },
|
|
3067
|
+
message: { type: "string" }
|
|
3068
|
+
},
|
|
3069
|
+
required: ["message", "is_device_error", "error_code"],
|
|
3070
|
+
type: "object"
|
|
3071
|
+
},
|
|
3072
|
+
{
|
|
3073
|
+
description: "Account is disconnected",
|
|
3074
|
+
properties: {
|
|
3075
|
+
error_code: {
|
|
3076
|
+
description: "Unique identifier of the type of error. Enables quick recognition and categorization of the issue.",
|
|
3077
|
+
enum: ["account_disconnected"],
|
|
3078
|
+
type: "string"
|
|
3079
|
+
},
|
|
3080
|
+
is_device_error: { enum: [true], type: "boolean" },
|
|
3081
|
+
message: { type: "string" }
|
|
3082
|
+
},
|
|
3083
|
+
required: ["message", "is_device_error", "error_code"],
|
|
3084
|
+
type: "object"
|
|
3085
|
+
},
|
|
3086
|
+
{
|
|
3087
|
+
description: "Hub is disconnected",
|
|
3088
|
+
properties: {
|
|
3089
|
+
error_code: {
|
|
3090
|
+
description: "Unique identifier of the type of error. Enables quick recognition and categorization of the issue.",
|
|
3091
|
+
enum: ["hub_disconnected"],
|
|
3092
|
+
type: "string"
|
|
3093
|
+
},
|
|
3094
|
+
is_device_error: { enum: [true], type: "boolean" },
|
|
3095
|
+
message: { type: "string" }
|
|
3096
|
+
},
|
|
3097
|
+
required: ["message", "is_device_error", "error_code"],
|
|
3098
|
+
type: "object"
|
|
3099
|
+
},
|
|
3100
|
+
{
|
|
3101
|
+
description: "Device is disconnected",
|
|
3102
|
+
properties: {
|
|
3103
|
+
error_code: {
|
|
3104
|
+
description: "Unique identifier of the type of error. Enables quick recognition and categorization of the issue.",
|
|
3105
|
+
enum: ["device_disconnected"],
|
|
3106
|
+
type: "string"
|
|
3107
|
+
},
|
|
3108
|
+
is_device_error: { enum: [true], type: "boolean" },
|
|
3109
|
+
message: { type: "string" }
|
|
3110
|
+
},
|
|
3111
|
+
required: ["message", "is_device_error", "error_code"],
|
|
3112
|
+
type: "object"
|
|
3113
|
+
},
|
|
3114
|
+
{
|
|
3115
|
+
description: "The backup access code pool is empty.",
|
|
3116
|
+
properties: {
|
|
3117
|
+
error_code: {
|
|
3118
|
+
description: "Unique identifier of the type of error. Enables quick recognition and categorization of the issue.",
|
|
3119
|
+
enum: ["empty_backup_access_code_pool"],
|
|
3120
|
+
type: "string"
|
|
3121
|
+
},
|
|
3122
|
+
is_device_error: { enum: [true], type: "boolean" },
|
|
3123
|
+
message: { type: "string" }
|
|
3124
|
+
},
|
|
3125
|
+
required: ["message", "is_device_error", "error_code"],
|
|
3126
|
+
type: "object"
|
|
3127
|
+
},
|
|
3128
|
+
{
|
|
3129
|
+
description: "User is not authorized to use the August Lock.",
|
|
3130
|
+
properties: {
|
|
3131
|
+
error_code: {
|
|
3132
|
+
description: "Unique identifier of the type of error. Enables quick recognition and categorization of the issue.",
|
|
3133
|
+
enum: ["august_lock_not_authorized"],
|
|
3134
|
+
type: "string"
|
|
3135
|
+
},
|
|
3136
|
+
is_device_error: { enum: [true], type: "boolean" },
|
|
3137
|
+
message: { type: "string" }
|
|
3138
|
+
},
|
|
3139
|
+
required: ["message", "is_device_error", "error_code"],
|
|
3140
|
+
type: "object"
|
|
3141
|
+
},
|
|
3142
|
+
{
|
|
3143
|
+
description: "Lock is not connected to the Seam Bridge.",
|
|
3144
|
+
properties: {
|
|
3145
|
+
error_code: {
|
|
3146
|
+
description: "Unique identifier of the type of error. Enables quick recognition and categorization of the issue.",
|
|
3147
|
+
enum: ["august_lock_missing_bridge"],
|
|
3148
|
+
type: "string"
|
|
3149
|
+
},
|
|
3150
|
+
is_device_error: { enum: [true], type: "boolean" },
|
|
3151
|
+
message: { type: "string" }
|
|
3152
|
+
},
|
|
3153
|
+
required: ["message", "is_device_error", "error_code"],
|
|
3154
|
+
type: "object"
|
|
3155
|
+
},
|
|
3156
|
+
{
|
|
3157
|
+
description: "Salto site user limit reached.",
|
|
3158
|
+
properties: {
|
|
3159
|
+
error_code: {
|
|
3160
|
+
description: "Unique identifier of the type of error. Enables quick recognition and categorization of the issue.",
|
|
3161
|
+
enum: ["salto_site_user_limit_reached"],
|
|
3162
|
+
type: "string"
|
|
3163
|
+
},
|
|
3164
|
+
is_device_error: { enum: [true], type: "boolean" },
|
|
3165
|
+
message: { type: "string" }
|
|
3166
|
+
},
|
|
3167
|
+
required: ["message", "is_device_error", "error_code"],
|
|
3168
|
+
type: "object"
|
|
3169
|
+
},
|
|
3170
|
+
{
|
|
3171
|
+
description: "Lock is not paired with a Gateway.",
|
|
3172
|
+
properties: {
|
|
3173
|
+
error_code: {
|
|
3174
|
+
description: "Unique identifier of the type of error. Enables quick recognition and categorization of the issue.",
|
|
3175
|
+
enum: ["ttlock_lock_not_paired_to_gateway"],
|
|
3176
|
+
type: "string"
|
|
3177
|
+
},
|
|
3178
|
+
is_device_error: { enum: [true], type: "boolean" },
|
|
3179
|
+
message: { type: "string" }
|
|
3180
|
+
},
|
|
3181
|
+
required: ["message", "is_device_error", "error_code"],
|
|
3182
|
+
type: "object"
|
|
3183
|
+
},
|
|
3184
|
+
{
|
|
3185
|
+
description: "Missing device credentials.",
|
|
3186
|
+
properties: {
|
|
3187
|
+
error_code: {
|
|
3188
|
+
description: "Unique identifier of the type of error. Enables quick recognition and categorization of the issue.",
|
|
3189
|
+
enum: ["missing_device_credentials"],
|
|
3190
|
+
type: "string"
|
|
3191
|
+
},
|
|
3192
|
+
is_device_error: { enum: [true], type: "boolean" },
|
|
3193
|
+
message: { type: "string" }
|
|
3194
|
+
},
|
|
3195
|
+
required: ["message", "is_device_error", "error_code"],
|
|
3196
|
+
type: "object"
|
|
3197
|
+
},
|
|
3198
|
+
{
|
|
3199
|
+
description: "The auxiliary heat is running.",
|
|
3200
|
+
properties: {
|
|
3201
|
+
error_code: {
|
|
3202
|
+
description: "Unique identifier of the type of error. Enables quick recognition and categorization of the issue.",
|
|
3203
|
+
enum: ["auxiliary_heat_running"],
|
|
3204
|
+
type: "string"
|
|
3205
|
+
},
|
|
3206
|
+
is_device_error: { enum: [true], type: "boolean" },
|
|
3207
|
+
message: { type: "string" }
|
|
3208
|
+
},
|
|
3209
|
+
required: ["message", "is_device_error", "error_code"],
|
|
3210
|
+
type: "object"
|
|
3211
|
+
},
|
|
3212
|
+
{
|
|
3213
|
+
description: "Subscription required to connect.",
|
|
3214
|
+
properties: {
|
|
3215
|
+
error_code: {
|
|
3216
|
+
description: "Unique identifier of the type of error. Enables quick recognition and categorization of the issue.",
|
|
3217
|
+
enum: ["subscription_required"],
|
|
3218
|
+
type: "string"
|
|
3219
|
+
},
|
|
3220
|
+
is_device_error: { enum: [true], type: "boolean" },
|
|
3221
|
+
message: { type: "string" }
|
|
3222
|
+
},
|
|
3223
|
+
required: ["message", "is_device_error", "error_code"],
|
|
3224
|
+
type: "object"
|
|
3225
|
+
}
|
|
3226
|
+
]
|
|
2985
3227
|
},
|
|
2986
3228
|
{
|
|
2987
3229
|
properties: {
|
|
@@ -7031,13 +7273,191 @@ var openapi_default = {
|
|
|
7031
7273
|
items: {
|
|
7032
7274
|
oneOf: [
|
|
7033
7275
|
{
|
|
7034
|
-
|
|
7035
|
-
|
|
7036
|
-
|
|
7037
|
-
|
|
7038
|
-
|
|
7039
|
-
|
|
7040
|
-
|
|
7276
|
+
description: "Error associated with the `device`.",
|
|
7277
|
+
oneOf: [
|
|
7278
|
+
{
|
|
7279
|
+
description: "Device is offline",
|
|
7280
|
+
properties: {
|
|
7281
|
+
error_code: {
|
|
7282
|
+
description: "Unique identifier of the type of error. Enables quick recognition and categorization of the issue.",
|
|
7283
|
+
enum: ["device_offline"],
|
|
7284
|
+
type: "string"
|
|
7285
|
+
},
|
|
7286
|
+
is_device_error: { enum: [true], type: "boolean" },
|
|
7287
|
+
message: { type: "string" }
|
|
7288
|
+
},
|
|
7289
|
+
required: ["message", "is_device_error", "error_code"],
|
|
7290
|
+
type: "object"
|
|
7291
|
+
},
|
|
7292
|
+
{
|
|
7293
|
+
description: "Device has been removed",
|
|
7294
|
+
properties: {
|
|
7295
|
+
error_code: {
|
|
7296
|
+
description: "Unique identifier of the type of error. Enables quick recognition and categorization of the issue.",
|
|
7297
|
+
enum: ["device_removed"],
|
|
7298
|
+
type: "string"
|
|
7299
|
+
},
|
|
7300
|
+
is_device_error: { enum: [true], type: "boolean" },
|
|
7301
|
+
message: { type: "string" }
|
|
7302
|
+
},
|
|
7303
|
+
required: ["message", "is_device_error", "error_code"],
|
|
7304
|
+
type: "object"
|
|
7305
|
+
},
|
|
7306
|
+
{
|
|
7307
|
+
description: "Account is disconnected",
|
|
7308
|
+
properties: {
|
|
7309
|
+
error_code: {
|
|
7310
|
+
description: "Unique identifier of the type of error. Enables quick recognition and categorization of the issue.",
|
|
7311
|
+
enum: ["account_disconnected"],
|
|
7312
|
+
type: "string"
|
|
7313
|
+
},
|
|
7314
|
+
is_device_error: { enum: [true], type: "boolean" },
|
|
7315
|
+
message: { type: "string" }
|
|
7316
|
+
},
|
|
7317
|
+
required: ["message", "is_device_error", "error_code"],
|
|
7318
|
+
type: "object"
|
|
7319
|
+
},
|
|
7320
|
+
{
|
|
7321
|
+
description: "Hub is disconnected",
|
|
7322
|
+
properties: {
|
|
7323
|
+
error_code: {
|
|
7324
|
+
description: "Unique identifier of the type of error. Enables quick recognition and categorization of the issue.",
|
|
7325
|
+
enum: ["hub_disconnected"],
|
|
7326
|
+
type: "string"
|
|
7327
|
+
},
|
|
7328
|
+
is_device_error: { enum: [true], type: "boolean" },
|
|
7329
|
+
message: { type: "string" }
|
|
7330
|
+
},
|
|
7331
|
+
required: ["message", "is_device_error", "error_code"],
|
|
7332
|
+
type: "object"
|
|
7333
|
+
},
|
|
7334
|
+
{
|
|
7335
|
+
description: "Device is disconnected",
|
|
7336
|
+
properties: {
|
|
7337
|
+
error_code: {
|
|
7338
|
+
description: "Unique identifier of the type of error. Enables quick recognition and categorization of the issue.",
|
|
7339
|
+
enum: ["device_disconnected"],
|
|
7340
|
+
type: "string"
|
|
7341
|
+
},
|
|
7342
|
+
is_device_error: { enum: [true], type: "boolean" },
|
|
7343
|
+
message: { type: "string" }
|
|
7344
|
+
},
|
|
7345
|
+
required: ["message", "is_device_error", "error_code"],
|
|
7346
|
+
type: "object"
|
|
7347
|
+
},
|
|
7348
|
+
{
|
|
7349
|
+
description: "The backup access code pool is empty.",
|
|
7350
|
+
properties: {
|
|
7351
|
+
error_code: {
|
|
7352
|
+
description: "Unique identifier of the type of error. Enables quick recognition and categorization of the issue.",
|
|
7353
|
+
enum: ["empty_backup_access_code_pool"],
|
|
7354
|
+
type: "string"
|
|
7355
|
+
},
|
|
7356
|
+
is_device_error: { enum: [true], type: "boolean" },
|
|
7357
|
+
message: { type: "string" }
|
|
7358
|
+
},
|
|
7359
|
+
required: ["message", "is_device_error", "error_code"],
|
|
7360
|
+
type: "object"
|
|
7361
|
+
},
|
|
7362
|
+
{
|
|
7363
|
+
description: "User is not authorized to use the August Lock.",
|
|
7364
|
+
properties: {
|
|
7365
|
+
error_code: {
|
|
7366
|
+
description: "Unique identifier of the type of error. Enables quick recognition and categorization of the issue.",
|
|
7367
|
+
enum: ["august_lock_not_authorized"],
|
|
7368
|
+
type: "string"
|
|
7369
|
+
},
|
|
7370
|
+
is_device_error: { enum: [true], type: "boolean" },
|
|
7371
|
+
message: { type: "string" }
|
|
7372
|
+
},
|
|
7373
|
+
required: ["message", "is_device_error", "error_code"],
|
|
7374
|
+
type: "object"
|
|
7375
|
+
},
|
|
7376
|
+
{
|
|
7377
|
+
description: "Lock is not connected to the Seam Bridge.",
|
|
7378
|
+
properties: {
|
|
7379
|
+
error_code: {
|
|
7380
|
+
description: "Unique identifier of the type of error. Enables quick recognition and categorization of the issue.",
|
|
7381
|
+
enum: ["august_lock_missing_bridge"],
|
|
7382
|
+
type: "string"
|
|
7383
|
+
},
|
|
7384
|
+
is_device_error: { enum: [true], type: "boolean" },
|
|
7385
|
+
message: { type: "string" }
|
|
7386
|
+
},
|
|
7387
|
+
required: ["message", "is_device_error", "error_code"],
|
|
7388
|
+
type: "object"
|
|
7389
|
+
},
|
|
7390
|
+
{
|
|
7391
|
+
description: "Salto site user limit reached.",
|
|
7392
|
+
properties: {
|
|
7393
|
+
error_code: {
|
|
7394
|
+
description: "Unique identifier of the type of error. Enables quick recognition and categorization of the issue.",
|
|
7395
|
+
enum: ["salto_site_user_limit_reached"],
|
|
7396
|
+
type: "string"
|
|
7397
|
+
},
|
|
7398
|
+
is_device_error: { enum: [true], type: "boolean" },
|
|
7399
|
+
message: { type: "string" }
|
|
7400
|
+
},
|
|
7401
|
+
required: ["message", "is_device_error", "error_code"],
|
|
7402
|
+
type: "object"
|
|
7403
|
+
},
|
|
7404
|
+
{
|
|
7405
|
+
description: "Lock is not paired with a Gateway.",
|
|
7406
|
+
properties: {
|
|
7407
|
+
error_code: {
|
|
7408
|
+
description: "Unique identifier of the type of error. Enables quick recognition and categorization of the issue.",
|
|
7409
|
+
enum: ["ttlock_lock_not_paired_to_gateway"],
|
|
7410
|
+
type: "string"
|
|
7411
|
+
},
|
|
7412
|
+
is_device_error: { enum: [true], type: "boolean" },
|
|
7413
|
+
message: { type: "string" }
|
|
7414
|
+
},
|
|
7415
|
+
required: ["message", "is_device_error", "error_code"],
|
|
7416
|
+
type: "object"
|
|
7417
|
+
},
|
|
7418
|
+
{
|
|
7419
|
+
description: "Missing device credentials.",
|
|
7420
|
+
properties: {
|
|
7421
|
+
error_code: {
|
|
7422
|
+
description: "Unique identifier of the type of error. Enables quick recognition and categorization of the issue.",
|
|
7423
|
+
enum: ["missing_device_credentials"],
|
|
7424
|
+
type: "string"
|
|
7425
|
+
},
|
|
7426
|
+
is_device_error: { enum: [true], type: "boolean" },
|
|
7427
|
+
message: { type: "string" }
|
|
7428
|
+
},
|
|
7429
|
+
required: ["message", "is_device_error", "error_code"],
|
|
7430
|
+
type: "object"
|
|
7431
|
+
},
|
|
7432
|
+
{
|
|
7433
|
+
description: "The auxiliary heat is running.",
|
|
7434
|
+
properties: {
|
|
7435
|
+
error_code: {
|
|
7436
|
+
description: "Unique identifier of the type of error. Enables quick recognition and categorization of the issue.",
|
|
7437
|
+
enum: ["auxiliary_heat_running"],
|
|
7438
|
+
type: "string"
|
|
7439
|
+
},
|
|
7440
|
+
is_device_error: { enum: [true], type: "boolean" },
|
|
7441
|
+
message: { type: "string" }
|
|
7442
|
+
},
|
|
7443
|
+
required: ["message", "is_device_error", "error_code"],
|
|
7444
|
+
type: "object"
|
|
7445
|
+
},
|
|
7446
|
+
{
|
|
7447
|
+
description: "Subscription required to connect.",
|
|
7448
|
+
properties: {
|
|
7449
|
+
error_code: {
|
|
7450
|
+
description: "Unique identifier of the type of error. Enables quick recognition and categorization of the issue.",
|
|
7451
|
+
enum: ["subscription_required"],
|
|
7452
|
+
type: "string"
|
|
7453
|
+
},
|
|
7454
|
+
is_device_error: { enum: [true], type: "boolean" },
|
|
7455
|
+
message: { type: "string" }
|
|
7456
|
+
},
|
|
7457
|
+
required: ["message", "is_device_error", "error_code"],
|
|
7458
|
+
type: "object"
|
|
7459
|
+
}
|
|
7460
|
+
]
|
|
7041
7461
|
},
|
|
7042
7462
|
{
|
|
7043
7463
|
properties: {
|
|
@@ -12085,6 +12505,76 @@ var openapi_default = {
|
|
|
12085
12505
|
],
|
|
12086
12506
|
type: "object"
|
|
12087
12507
|
},
|
|
12508
|
+
{
|
|
12509
|
+
properties: {
|
|
12510
|
+
connected_account_id: {
|
|
12511
|
+
description: "ID of the [connected account](https://docs.seam.co/latest/core-concepts/connected-accounts).",
|
|
12512
|
+
format: "uuid",
|
|
12513
|
+
type: "string"
|
|
12514
|
+
},
|
|
12515
|
+
created_at: {
|
|
12516
|
+
description: "Date and time at which the event was created.",
|
|
12517
|
+
format: "date-time",
|
|
12518
|
+
type: "string"
|
|
12519
|
+
},
|
|
12520
|
+
desired_temperature_celsius: {
|
|
12521
|
+
description: "Desired temperature, in \xB0C, set by the thermostat's cooling or heating set point.",
|
|
12522
|
+
format: "float",
|
|
12523
|
+
type: "number"
|
|
12524
|
+
},
|
|
12525
|
+
desired_temperature_fahrenheit: {
|
|
12526
|
+
description: "Desired temperature, in \xB0F, set by the thermostat's cooling or heating set point.",
|
|
12527
|
+
format: "float",
|
|
12528
|
+
type: "number"
|
|
12529
|
+
},
|
|
12530
|
+
device_id: {
|
|
12531
|
+
description: "ID of the device.",
|
|
12532
|
+
format: "uuid",
|
|
12533
|
+
type: "string"
|
|
12534
|
+
},
|
|
12535
|
+
event_id: {
|
|
12536
|
+
description: "ID of the event.",
|
|
12537
|
+
format: "uuid",
|
|
12538
|
+
type: "string"
|
|
12539
|
+
},
|
|
12540
|
+
event_type: {
|
|
12541
|
+
enum: ["thermostat.temperature_reached_set_point"],
|
|
12542
|
+
type: "string"
|
|
12543
|
+
},
|
|
12544
|
+
occurred_at: {
|
|
12545
|
+
description: "Date and time at which the event occurred.",
|
|
12546
|
+
format: "date-time",
|
|
12547
|
+
type: "string"
|
|
12548
|
+
},
|
|
12549
|
+
temperature_celsius: {
|
|
12550
|
+
description: "Temperature, in \xB0C, reported by the thermostat.",
|
|
12551
|
+
format: "float",
|
|
12552
|
+
type: "number"
|
|
12553
|
+
},
|
|
12554
|
+
temperature_fahrenheit: {
|
|
12555
|
+
description: "Temperature, in \xB0F, reported by the thermostat.",
|
|
12556
|
+
format: "float",
|
|
12557
|
+
type: "number"
|
|
12558
|
+
},
|
|
12559
|
+
workspace_id: {
|
|
12560
|
+
description: "ID of the [workspace](https://docs.seam.co/latest/core-concepts/workspaces).",
|
|
12561
|
+
format: "uuid",
|
|
12562
|
+
type: "string"
|
|
12563
|
+
}
|
|
12564
|
+
},
|
|
12565
|
+
required: [
|
|
12566
|
+
"event_id",
|
|
12567
|
+
"workspace_id",
|
|
12568
|
+
"created_at",
|
|
12569
|
+
"occurred_at",
|
|
12570
|
+
"device_id",
|
|
12571
|
+
"connected_account_id",
|
|
12572
|
+
"event_type",
|
|
12573
|
+
"temperature_celsius",
|
|
12574
|
+
"temperature_fahrenheit"
|
|
12575
|
+
],
|
|
12576
|
+
type: "object"
|
|
12577
|
+
},
|
|
12088
12578
|
{
|
|
12089
12579
|
description: "An [enrollment automation](https://docs.seam.co/latest/capability-guides/mobile-access/issuing-mobile-credentials-from-an-access-control-system#prepare-the-phones-for-a-user-identity-to-start-receiving-mobile-credentials-using-an-enrollment-aut) was deleted.",
|
|
12090
12580
|
properties: {
|
|
@@ -12254,13 +12744,191 @@ var openapi_default = {
|
|
|
12254
12744
|
items: {
|
|
12255
12745
|
oneOf: [
|
|
12256
12746
|
{
|
|
12257
|
-
|
|
12258
|
-
|
|
12259
|
-
|
|
12260
|
-
|
|
12261
|
-
|
|
12262
|
-
|
|
12263
|
-
|
|
12747
|
+
description: "Error associated with the `device`.",
|
|
12748
|
+
oneOf: [
|
|
12749
|
+
{
|
|
12750
|
+
description: "Device is offline",
|
|
12751
|
+
properties: {
|
|
12752
|
+
error_code: {
|
|
12753
|
+
description: "Unique identifier of the type of error. Enables quick recognition and categorization of the issue.",
|
|
12754
|
+
enum: ["device_offline"],
|
|
12755
|
+
type: "string"
|
|
12756
|
+
},
|
|
12757
|
+
is_device_error: { enum: [true], type: "boolean" },
|
|
12758
|
+
message: { type: "string" }
|
|
12759
|
+
},
|
|
12760
|
+
required: ["message", "is_device_error", "error_code"],
|
|
12761
|
+
type: "object"
|
|
12762
|
+
},
|
|
12763
|
+
{
|
|
12764
|
+
description: "Device has been removed",
|
|
12765
|
+
properties: {
|
|
12766
|
+
error_code: {
|
|
12767
|
+
description: "Unique identifier of the type of error. Enables quick recognition and categorization of the issue.",
|
|
12768
|
+
enum: ["device_removed"],
|
|
12769
|
+
type: "string"
|
|
12770
|
+
},
|
|
12771
|
+
is_device_error: { enum: [true], type: "boolean" },
|
|
12772
|
+
message: { type: "string" }
|
|
12773
|
+
},
|
|
12774
|
+
required: ["message", "is_device_error", "error_code"],
|
|
12775
|
+
type: "object"
|
|
12776
|
+
},
|
|
12777
|
+
{
|
|
12778
|
+
description: "Account is disconnected",
|
|
12779
|
+
properties: {
|
|
12780
|
+
error_code: {
|
|
12781
|
+
description: "Unique identifier of the type of error. Enables quick recognition and categorization of the issue.",
|
|
12782
|
+
enum: ["account_disconnected"],
|
|
12783
|
+
type: "string"
|
|
12784
|
+
},
|
|
12785
|
+
is_device_error: { enum: [true], type: "boolean" },
|
|
12786
|
+
message: { type: "string" }
|
|
12787
|
+
},
|
|
12788
|
+
required: ["message", "is_device_error", "error_code"],
|
|
12789
|
+
type: "object"
|
|
12790
|
+
},
|
|
12791
|
+
{
|
|
12792
|
+
description: "Hub is disconnected",
|
|
12793
|
+
properties: {
|
|
12794
|
+
error_code: {
|
|
12795
|
+
description: "Unique identifier of the type of error. Enables quick recognition and categorization of the issue.",
|
|
12796
|
+
enum: ["hub_disconnected"],
|
|
12797
|
+
type: "string"
|
|
12798
|
+
},
|
|
12799
|
+
is_device_error: { enum: [true], type: "boolean" },
|
|
12800
|
+
message: { type: "string" }
|
|
12801
|
+
},
|
|
12802
|
+
required: ["message", "is_device_error", "error_code"],
|
|
12803
|
+
type: "object"
|
|
12804
|
+
},
|
|
12805
|
+
{
|
|
12806
|
+
description: "Device is disconnected",
|
|
12807
|
+
properties: {
|
|
12808
|
+
error_code: {
|
|
12809
|
+
description: "Unique identifier of the type of error. Enables quick recognition and categorization of the issue.",
|
|
12810
|
+
enum: ["device_disconnected"],
|
|
12811
|
+
type: "string"
|
|
12812
|
+
},
|
|
12813
|
+
is_device_error: { enum: [true], type: "boolean" },
|
|
12814
|
+
message: { type: "string" }
|
|
12815
|
+
},
|
|
12816
|
+
required: ["message", "is_device_error", "error_code"],
|
|
12817
|
+
type: "object"
|
|
12818
|
+
},
|
|
12819
|
+
{
|
|
12820
|
+
description: "The backup access code pool is empty.",
|
|
12821
|
+
properties: {
|
|
12822
|
+
error_code: {
|
|
12823
|
+
description: "Unique identifier of the type of error. Enables quick recognition and categorization of the issue.",
|
|
12824
|
+
enum: ["empty_backup_access_code_pool"],
|
|
12825
|
+
type: "string"
|
|
12826
|
+
},
|
|
12827
|
+
is_device_error: { enum: [true], type: "boolean" },
|
|
12828
|
+
message: { type: "string" }
|
|
12829
|
+
},
|
|
12830
|
+
required: ["message", "is_device_error", "error_code"],
|
|
12831
|
+
type: "object"
|
|
12832
|
+
},
|
|
12833
|
+
{
|
|
12834
|
+
description: "User is not authorized to use the August Lock.",
|
|
12835
|
+
properties: {
|
|
12836
|
+
error_code: {
|
|
12837
|
+
description: "Unique identifier of the type of error. Enables quick recognition and categorization of the issue.",
|
|
12838
|
+
enum: ["august_lock_not_authorized"],
|
|
12839
|
+
type: "string"
|
|
12840
|
+
},
|
|
12841
|
+
is_device_error: { enum: [true], type: "boolean" },
|
|
12842
|
+
message: { type: "string" }
|
|
12843
|
+
},
|
|
12844
|
+
required: ["message", "is_device_error", "error_code"],
|
|
12845
|
+
type: "object"
|
|
12846
|
+
},
|
|
12847
|
+
{
|
|
12848
|
+
description: "Lock is not connected to the Seam Bridge.",
|
|
12849
|
+
properties: {
|
|
12850
|
+
error_code: {
|
|
12851
|
+
description: "Unique identifier of the type of error. Enables quick recognition and categorization of the issue.",
|
|
12852
|
+
enum: ["august_lock_missing_bridge"],
|
|
12853
|
+
type: "string"
|
|
12854
|
+
},
|
|
12855
|
+
is_device_error: { enum: [true], type: "boolean" },
|
|
12856
|
+
message: { type: "string" }
|
|
12857
|
+
},
|
|
12858
|
+
required: ["message", "is_device_error", "error_code"],
|
|
12859
|
+
type: "object"
|
|
12860
|
+
},
|
|
12861
|
+
{
|
|
12862
|
+
description: "Salto site user limit reached.",
|
|
12863
|
+
properties: {
|
|
12864
|
+
error_code: {
|
|
12865
|
+
description: "Unique identifier of the type of error. Enables quick recognition and categorization of the issue.",
|
|
12866
|
+
enum: ["salto_site_user_limit_reached"],
|
|
12867
|
+
type: "string"
|
|
12868
|
+
},
|
|
12869
|
+
is_device_error: { enum: [true], type: "boolean" },
|
|
12870
|
+
message: { type: "string" }
|
|
12871
|
+
},
|
|
12872
|
+
required: ["message", "is_device_error", "error_code"],
|
|
12873
|
+
type: "object"
|
|
12874
|
+
},
|
|
12875
|
+
{
|
|
12876
|
+
description: "Lock is not paired with a Gateway.",
|
|
12877
|
+
properties: {
|
|
12878
|
+
error_code: {
|
|
12879
|
+
description: "Unique identifier of the type of error. Enables quick recognition and categorization of the issue.",
|
|
12880
|
+
enum: ["ttlock_lock_not_paired_to_gateway"],
|
|
12881
|
+
type: "string"
|
|
12882
|
+
},
|
|
12883
|
+
is_device_error: { enum: [true], type: "boolean" },
|
|
12884
|
+
message: { type: "string" }
|
|
12885
|
+
},
|
|
12886
|
+
required: ["message", "is_device_error", "error_code"],
|
|
12887
|
+
type: "object"
|
|
12888
|
+
},
|
|
12889
|
+
{
|
|
12890
|
+
description: "Missing device credentials.",
|
|
12891
|
+
properties: {
|
|
12892
|
+
error_code: {
|
|
12893
|
+
description: "Unique identifier of the type of error. Enables quick recognition and categorization of the issue.",
|
|
12894
|
+
enum: ["missing_device_credentials"],
|
|
12895
|
+
type: "string"
|
|
12896
|
+
},
|
|
12897
|
+
is_device_error: { enum: [true], type: "boolean" },
|
|
12898
|
+
message: { type: "string" }
|
|
12899
|
+
},
|
|
12900
|
+
required: ["message", "is_device_error", "error_code"],
|
|
12901
|
+
type: "object"
|
|
12902
|
+
},
|
|
12903
|
+
{
|
|
12904
|
+
description: "The auxiliary heat is running.",
|
|
12905
|
+
properties: {
|
|
12906
|
+
error_code: {
|
|
12907
|
+
description: "Unique identifier of the type of error. Enables quick recognition and categorization of the issue.",
|
|
12908
|
+
enum: ["auxiliary_heat_running"],
|
|
12909
|
+
type: "string"
|
|
12910
|
+
},
|
|
12911
|
+
is_device_error: { enum: [true], type: "boolean" },
|
|
12912
|
+
message: { type: "string" }
|
|
12913
|
+
},
|
|
12914
|
+
required: ["message", "is_device_error", "error_code"],
|
|
12915
|
+
type: "object"
|
|
12916
|
+
},
|
|
12917
|
+
{
|
|
12918
|
+
description: "Subscription required to connect.",
|
|
12919
|
+
properties: {
|
|
12920
|
+
error_code: {
|
|
12921
|
+
description: "Unique identifier of the type of error. Enables quick recognition and categorization of the issue.",
|
|
12922
|
+
enum: ["subscription_required"],
|
|
12923
|
+
type: "string"
|
|
12924
|
+
},
|
|
12925
|
+
is_device_error: { enum: [true], type: "boolean" },
|
|
12926
|
+
message: { type: "string" }
|
|
12927
|
+
},
|
|
12928
|
+
required: ["message", "is_device_error", "error_code"],
|
|
12929
|
+
type: "object"
|
|
12930
|
+
}
|
|
12931
|
+
]
|
|
12264
12932
|
},
|
|
12265
12933
|
{
|
|
12266
12934
|
properties: {
|
|
@@ -12485,13 +13153,191 @@ var openapi_default = {
|
|
|
12485
13153
|
type: "object"
|
|
12486
13154
|
},
|
|
12487
13155
|
{
|
|
12488
|
-
|
|
12489
|
-
|
|
12490
|
-
|
|
12491
|
-
|
|
12492
|
-
|
|
12493
|
-
|
|
12494
|
-
|
|
13156
|
+
description: "Error associated with the `device`.",
|
|
13157
|
+
oneOf: [
|
|
13158
|
+
{
|
|
13159
|
+
description: "Device is offline",
|
|
13160
|
+
properties: {
|
|
13161
|
+
error_code: {
|
|
13162
|
+
description: "Unique identifier of the type of error. Enables quick recognition and categorization of the issue.",
|
|
13163
|
+
enum: ["device_offline"],
|
|
13164
|
+
type: "string"
|
|
13165
|
+
},
|
|
13166
|
+
is_device_error: { enum: [true], type: "boolean" },
|
|
13167
|
+
message: { type: "string" }
|
|
13168
|
+
},
|
|
13169
|
+
required: ["message", "is_device_error", "error_code"],
|
|
13170
|
+
type: "object"
|
|
13171
|
+
},
|
|
13172
|
+
{
|
|
13173
|
+
description: "Device has been removed",
|
|
13174
|
+
properties: {
|
|
13175
|
+
error_code: {
|
|
13176
|
+
description: "Unique identifier of the type of error. Enables quick recognition and categorization of the issue.",
|
|
13177
|
+
enum: ["device_removed"],
|
|
13178
|
+
type: "string"
|
|
13179
|
+
},
|
|
13180
|
+
is_device_error: { enum: [true], type: "boolean" },
|
|
13181
|
+
message: { type: "string" }
|
|
13182
|
+
},
|
|
13183
|
+
required: ["message", "is_device_error", "error_code"],
|
|
13184
|
+
type: "object"
|
|
13185
|
+
},
|
|
13186
|
+
{
|
|
13187
|
+
description: "Account is disconnected",
|
|
13188
|
+
properties: {
|
|
13189
|
+
error_code: {
|
|
13190
|
+
description: "Unique identifier of the type of error. Enables quick recognition and categorization of the issue.",
|
|
13191
|
+
enum: ["account_disconnected"],
|
|
13192
|
+
type: "string"
|
|
13193
|
+
},
|
|
13194
|
+
is_device_error: { enum: [true], type: "boolean" },
|
|
13195
|
+
message: { type: "string" }
|
|
13196
|
+
},
|
|
13197
|
+
required: ["message", "is_device_error", "error_code"],
|
|
13198
|
+
type: "object"
|
|
13199
|
+
},
|
|
13200
|
+
{
|
|
13201
|
+
description: "Hub is disconnected",
|
|
13202
|
+
properties: {
|
|
13203
|
+
error_code: {
|
|
13204
|
+
description: "Unique identifier of the type of error. Enables quick recognition and categorization of the issue.",
|
|
13205
|
+
enum: ["hub_disconnected"],
|
|
13206
|
+
type: "string"
|
|
13207
|
+
},
|
|
13208
|
+
is_device_error: { enum: [true], type: "boolean" },
|
|
13209
|
+
message: { type: "string" }
|
|
13210
|
+
},
|
|
13211
|
+
required: ["message", "is_device_error", "error_code"],
|
|
13212
|
+
type: "object"
|
|
13213
|
+
},
|
|
13214
|
+
{
|
|
13215
|
+
description: "Device is disconnected",
|
|
13216
|
+
properties: {
|
|
13217
|
+
error_code: {
|
|
13218
|
+
description: "Unique identifier of the type of error. Enables quick recognition and categorization of the issue.",
|
|
13219
|
+
enum: ["device_disconnected"],
|
|
13220
|
+
type: "string"
|
|
13221
|
+
},
|
|
13222
|
+
is_device_error: { enum: [true], type: "boolean" },
|
|
13223
|
+
message: { type: "string" }
|
|
13224
|
+
},
|
|
13225
|
+
required: ["message", "is_device_error", "error_code"],
|
|
13226
|
+
type: "object"
|
|
13227
|
+
},
|
|
13228
|
+
{
|
|
13229
|
+
description: "The backup access code pool is empty.",
|
|
13230
|
+
properties: {
|
|
13231
|
+
error_code: {
|
|
13232
|
+
description: "Unique identifier of the type of error. Enables quick recognition and categorization of the issue.",
|
|
13233
|
+
enum: ["empty_backup_access_code_pool"],
|
|
13234
|
+
type: "string"
|
|
13235
|
+
},
|
|
13236
|
+
is_device_error: { enum: [true], type: "boolean" },
|
|
13237
|
+
message: { type: "string" }
|
|
13238
|
+
},
|
|
13239
|
+
required: ["message", "is_device_error", "error_code"],
|
|
13240
|
+
type: "object"
|
|
13241
|
+
},
|
|
13242
|
+
{
|
|
13243
|
+
description: "User is not authorized to use the August Lock.",
|
|
13244
|
+
properties: {
|
|
13245
|
+
error_code: {
|
|
13246
|
+
description: "Unique identifier of the type of error. Enables quick recognition and categorization of the issue.",
|
|
13247
|
+
enum: ["august_lock_not_authorized"],
|
|
13248
|
+
type: "string"
|
|
13249
|
+
},
|
|
13250
|
+
is_device_error: { enum: [true], type: "boolean" },
|
|
13251
|
+
message: { type: "string" }
|
|
13252
|
+
},
|
|
13253
|
+
required: ["message", "is_device_error", "error_code"],
|
|
13254
|
+
type: "object"
|
|
13255
|
+
},
|
|
13256
|
+
{
|
|
13257
|
+
description: "Lock is not connected to the Seam Bridge.",
|
|
13258
|
+
properties: {
|
|
13259
|
+
error_code: {
|
|
13260
|
+
description: "Unique identifier of the type of error. Enables quick recognition and categorization of the issue.",
|
|
13261
|
+
enum: ["august_lock_missing_bridge"],
|
|
13262
|
+
type: "string"
|
|
13263
|
+
},
|
|
13264
|
+
is_device_error: { enum: [true], type: "boolean" },
|
|
13265
|
+
message: { type: "string" }
|
|
13266
|
+
},
|
|
13267
|
+
required: ["message", "is_device_error", "error_code"],
|
|
13268
|
+
type: "object"
|
|
13269
|
+
},
|
|
13270
|
+
{
|
|
13271
|
+
description: "Salto site user limit reached.",
|
|
13272
|
+
properties: {
|
|
13273
|
+
error_code: {
|
|
13274
|
+
description: "Unique identifier of the type of error. Enables quick recognition and categorization of the issue.",
|
|
13275
|
+
enum: ["salto_site_user_limit_reached"],
|
|
13276
|
+
type: "string"
|
|
13277
|
+
},
|
|
13278
|
+
is_device_error: { enum: [true], type: "boolean" },
|
|
13279
|
+
message: { type: "string" }
|
|
13280
|
+
},
|
|
13281
|
+
required: ["message", "is_device_error", "error_code"],
|
|
13282
|
+
type: "object"
|
|
13283
|
+
},
|
|
13284
|
+
{
|
|
13285
|
+
description: "Lock is not paired with a Gateway.",
|
|
13286
|
+
properties: {
|
|
13287
|
+
error_code: {
|
|
13288
|
+
description: "Unique identifier of the type of error. Enables quick recognition and categorization of the issue.",
|
|
13289
|
+
enum: ["ttlock_lock_not_paired_to_gateway"],
|
|
13290
|
+
type: "string"
|
|
13291
|
+
},
|
|
13292
|
+
is_device_error: { enum: [true], type: "boolean" },
|
|
13293
|
+
message: { type: "string" }
|
|
13294
|
+
},
|
|
13295
|
+
required: ["message", "is_device_error", "error_code"],
|
|
13296
|
+
type: "object"
|
|
13297
|
+
},
|
|
13298
|
+
{
|
|
13299
|
+
description: "Missing device credentials.",
|
|
13300
|
+
properties: {
|
|
13301
|
+
error_code: {
|
|
13302
|
+
description: "Unique identifier of the type of error. Enables quick recognition and categorization of the issue.",
|
|
13303
|
+
enum: ["missing_device_credentials"],
|
|
13304
|
+
type: "string"
|
|
13305
|
+
},
|
|
13306
|
+
is_device_error: { enum: [true], type: "boolean" },
|
|
13307
|
+
message: { type: "string" }
|
|
13308
|
+
},
|
|
13309
|
+
required: ["message", "is_device_error", "error_code"],
|
|
13310
|
+
type: "object"
|
|
13311
|
+
},
|
|
13312
|
+
{
|
|
13313
|
+
description: "The auxiliary heat is running.",
|
|
13314
|
+
properties: {
|
|
13315
|
+
error_code: {
|
|
13316
|
+
description: "Unique identifier of the type of error. Enables quick recognition and categorization of the issue.",
|
|
13317
|
+
enum: ["auxiliary_heat_running"],
|
|
13318
|
+
type: "string"
|
|
13319
|
+
},
|
|
13320
|
+
is_device_error: { enum: [true], type: "boolean" },
|
|
13321
|
+
message: { type: "string" }
|
|
13322
|
+
},
|
|
13323
|
+
required: ["message", "is_device_error", "error_code"],
|
|
13324
|
+
type: "object"
|
|
13325
|
+
},
|
|
13326
|
+
{
|
|
13327
|
+
description: "Subscription required to connect.",
|
|
13328
|
+
properties: {
|
|
13329
|
+
error_code: {
|
|
13330
|
+
description: "Unique identifier of the type of error. Enables quick recognition and categorization of the issue.",
|
|
13331
|
+
enum: ["subscription_required"],
|
|
13332
|
+
type: "string"
|
|
13333
|
+
},
|
|
13334
|
+
is_device_error: { enum: [true], type: "boolean" },
|
|
13335
|
+
message: { type: "string" }
|
|
13336
|
+
},
|
|
13337
|
+
required: ["message", "is_device_error", "error_code"],
|
|
13338
|
+
type: "object"
|
|
13339
|
+
}
|
|
13340
|
+
]
|
|
12495
13341
|
},
|
|
12496
13342
|
{
|
|
12497
13343
|
properties: {
|
|
@@ -12657,13 +13503,191 @@ var openapi_default = {
|
|
|
12657
13503
|
items: {
|
|
12658
13504
|
oneOf: [
|
|
12659
13505
|
{
|
|
12660
|
-
|
|
12661
|
-
|
|
12662
|
-
|
|
12663
|
-
|
|
12664
|
-
|
|
12665
|
-
|
|
12666
|
-
|
|
13506
|
+
description: "Error associated with the `device`.",
|
|
13507
|
+
oneOf: [
|
|
13508
|
+
{
|
|
13509
|
+
description: "Device is offline",
|
|
13510
|
+
properties: {
|
|
13511
|
+
error_code: {
|
|
13512
|
+
description: "Unique identifier of the type of error. Enables quick recognition and categorization of the issue.",
|
|
13513
|
+
enum: ["device_offline"],
|
|
13514
|
+
type: "string"
|
|
13515
|
+
},
|
|
13516
|
+
is_device_error: { enum: [true], type: "boolean" },
|
|
13517
|
+
message: { type: "string" }
|
|
13518
|
+
},
|
|
13519
|
+
required: ["message", "is_device_error", "error_code"],
|
|
13520
|
+
type: "object"
|
|
13521
|
+
},
|
|
13522
|
+
{
|
|
13523
|
+
description: "Device has been removed",
|
|
13524
|
+
properties: {
|
|
13525
|
+
error_code: {
|
|
13526
|
+
description: "Unique identifier of the type of error. Enables quick recognition and categorization of the issue.",
|
|
13527
|
+
enum: ["device_removed"],
|
|
13528
|
+
type: "string"
|
|
13529
|
+
},
|
|
13530
|
+
is_device_error: { enum: [true], type: "boolean" },
|
|
13531
|
+
message: { type: "string" }
|
|
13532
|
+
},
|
|
13533
|
+
required: ["message", "is_device_error", "error_code"],
|
|
13534
|
+
type: "object"
|
|
13535
|
+
},
|
|
13536
|
+
{
|
|
13537
|
+
description: "Account is disconnected",
|
|
13538
|
+
properties: {
|
|
13539
|
+
error_code: {
|
|
13540
|
+
description: "Unique identifier of the type of error. Enables quick recognition and categorization of the issue.",
|
|
13541
|
+
enum: ["account_disconnected"],
|
|
13542
|
+
type: "string"
|
|
13543
|
+
},
|
|
13544
|
+
is_device_error: { enum: [true], type: "boolean" },
|
|
13545
|
+
message: { type: "string" }
|
|
13546
|
+
},
|
|
13547
|
+
required: ["message", "is_device_error", "error_code"],
|
|
13548
|
+
type: "object"
|
|
13549
|
+
},
|
|
13550
|
+
{
|
|
13551
|
+
description: "Hub is disconnected",
|
|
13552
|
+
properties: {
|
|
13553
|
+
error_code: {
|
|
13554
|
+
description: "Unique identifier of the type of error. Enables quick recognition and categorization of the issue.",
|
|
13555
|
+
enum: ["hub_disconnected"],
|
|
13556
|
+
type: "string"
|
|
13557
|
+
},
|
|
13558
|
+
is_device_error: { enum: [true], type: "boolean" },
|
|
13559
|
+
message: { type: "string" }
|
|
13560
|
+
},
|
|
13561
|
+
required: ["message", "is_device_error", "error_code"],
|
|
13562
|
+
type: "object"
|
|
13563
|
+
},
|
|
13564
|
+
{
|
|
13565
|
+
description: "Device is disconnected",
|
|
13566
|
+
properties: {
|
|
13567
|
+
error_code: {
|
|
13568
|
+
description: "Unique identifier of the type of error. Enables quick recognition and categorization of the issue.",
|
|
13569
|
+
enum: ["device_disconnected"],
|
|
13570
|
+
type: "string"
|
|
13571
|
+
},
|
|
13572
|
+
is_device_error: { enum: [true], type: "boolean" },
|
|
13573
|
+
message: { type: "string" }
|
|
13574
|
+
},
|
|
13575
|
+
required: ["message", "is_device_error", "error_code"],
|
|
13576
|
+
type: "object"
|
|
13577
|
+
},
|
|
13578
|
+
{
|
|
13579
|
+
description: "The backup access code pool is empty.",
|
|
13580
|
+
properties: {
|
|
13581
|
+
error_code: {
|
|
13582
|
+
description: "Unique identifier of the type of error. Enables quick recognition and categorization of the issue.",
|
|
13583
|
+
enum: ["empty_backup_access_code_pool"],
|
|
13584
|
+
type: "string"
|
|
13585
|
+
},
|
|
13586
|
+
is_device_error: { enum: [true], type: "boolean" },
|
|
13587
|
+
message: { type: "string" }
|
|
13588
|
+
},
|
|
13589
|
+
required: ["message", "is_device_error", "error_code"],
|
|
13590
|
+
type: "object"
|
|
13591
|
+
},
|
|
13592
|
+
{
|
|
13593
|
+
description: "User is not authorized to use the August Lock.",
|
|
13594
|
+
properties: {
|
|
13595
|
+
error_code: {
|
|
13596
|
+
description: "Unique identifier of the type of error. Enables quick recognition and categorization of the issue.",
|
|
13597
|
+
enum: ["august_lock_not_authorized"],
|
|
13598
|
+
type: "string"
|
|
13599
|
+
},
|
|
13600
|
+
is_device_error: { enum: [true], type: "boolean" },
|
|
13601
|
+
message: { type: "string" }
|
|
13602
|
+
},
|
|
13603
|
+
required: ["message", "is_device_error", "error_code"],
|
|
13604
|
+
type: "object"
|
|
13605
|
+
},
|
|
13606
|
+
{
|
|
13607
|
+
description: "Lock is not connected to the Seam Bridge.",
|
|
13608
|
+
properties: {
|
|
13609
|
+
error_code: {
|
|
13610
|
+
description: "Unique identifier of the type of error. Enables quick recognition and categorization of the issue.",
|
|
13611
|
+
enum: ["august_lock_missing_bridge"],
|
|
13612
|
+
type: "string"
|
|
13613
|
+
},
|
|
13614
|
+
is_device_error: { enum: [true], type: "boolean" },
|
|
13615
|
+
message: { type: "string" }
|
|
13616
|
+
},
|
|
13617
|
+
required: ["message", "is_device_error", "error_code"],
|
|
13618
|
+
type: "object"
|
|
13619
|
+
},
|
|
13620
|
+
{
|
|
13621
|
+
description: "Salto site user limit reached.",
|
|
13622
|
+
properties: {
|
|
13623
|
+
error_code: {
|
|
13624
|
+
description: "Unique identifier of the type of error. Enables quick recognition and categorization of the issue.",
|
|
13625
|
+
enum: ["salto_site_user_limit_reached"],
|
|
13626
|
+
type: "string"
|
|
13627
|
+
},
|
|
13628
|
+
is_device_error: { enum: [true], type: "boolean" },
|
|
13629
|
+
message: { type: "string" }
|
|
13630
|
+
},
|
|
13631
|
+
required: ["message", "is_device_error", "error_code"],
|
|
13632
|
+
type: "object"
|
|
13633
|
+
},
|
|
13634
|
+
{
|
|
13635
|
+
description: "Lock is not paired with a Gateway.",
|
|
13636
|
+
properties: {
|
|
13637
|
+
error_code: {
|
|
13638
|
+
description: "Unique identifier of the type of error. Enables quick recognition and categorization of the issue.",
|
|
13639
|
+
enum: ["ttlock_lock_not_paired_to_gateway"],
|
|
13640
|
+
type: "string"
|
|
13641
|
+
},
|
|
13642
|
+
is_device_error: { enum: [true], type: "boolean" },
|
|
13643
|
+
message: { type: "string" }
|
|
13644
|
+
},
|
|
13645
|
+
required: ["message", "is_device_error", "error_code"],
|
|
13646
|
+
type: "object"
|
|
13647
|
+
},
|
|
13648
|
+
{
|
|
13649
|
+
description: "Missing device credentials.",
|
|
13650
|
+
properties: {
|
|
13651
|
+
error_code: {
|
|
13652
|
+
description: "Unique identifier of the type of error. Enables quick recognition and categorization of the issue.",
|
|
13653
|
+
enum: ["missing_device_credentials"],
|
|
13654
|
+
type: "string"
|
|
13655
|
+
},
|
|
13656
|
+
is_device_error: { enum: [true], type: "boolean" },
|
|
13657
|
+
message: { type: "string" }
|
|
13658
|
+
},
|
|
13659
|
+
required: ["message", "is_device_error", "error_code"],
|
|
13660
|
+
type: "object"
|
|
13661
|
+
},
|
|
13662
|
+
{
|
|
13663
|
+
description: "The auxiliary heat is running.",
|
|
13664
|
+
properties: {
|
|
13665
|
+
error_code: {
|
|
13666
|
+
description: "Unique identifier of the type of error. Enables quick recognition and categorization of the issue.",
|
|
13667
|
+
enum: ["auxiliary_heat_running"],
|
|
13668
|
+
type: "string"
|
|
13669
|
+
},
|
|
13670
|
+
is_device_error: { enum: [true], type: "boolean" },
|
|
13671
|
+
message: { type: "string" }
|
|
13672
|
+
},
|
|
13673
|
+
required: ["message", "is_device_error", "error_code"],
|
|
13674
|
+
type: "object"
|
|
13675
|
+
},
|
|
13676
|
+
{
|
|
13677
|
+
description: "Subscription required to connect.",
|
|
13678
|
+
properties: {
|
|
13679
|
+
error_code: {
|
|
13680
|
+
description: "Unique identifier of the type of error. Enables quick recognition and categorization of the issue.",
|
|
13681
|
+
enum: ["subscription_required"],
|
|
13682
|
+
type: "string"
|
|
13683
|
+
},
|
|
13684
|
+
is_device_error: { enum: [true], type: "boolean" },
|
|
13685
|
+
message: { type: "string" }
|
|
13686
|
+
},
|
|
13687
|
+
required: ["message", "is_device_error", "error_code"],
|
|
13688
|
+
type: "object"
|
|
13689
|
+
}
|
|
13690
|
+
]
|
|
12667
13691
|
},
|
|
12668
13692
|
{
|
|
12669
13693
|
properties: {
|
|
@@ -21547,7 +22571,8 @@ var openapi_default = {
|
|
|
21547
22571
|
"thermostat.climate_preset_activated",
|
|
21548
22572
|
"thermostat.manually_adjusted",
|
|
21549
22573
|
"thermostat.temperature_threshold_exceeded",
|
|
21550
|
-
"thermostat.temperature_threshold_no_longer_exceeded"
|
|
22574
|
+
"thermostat.temperature_threshold_no_longer_exceeded",
|
|
22575
|
+
"thermostat.temperature_reached_set_point"
|
|
21551
22576
|
],
|
|
21552
22577
|
type: "string"
|
|
21553
22578
|
},
|
|
@@ -21624,7 +22649,8 @@ var openapi_default = {
|
|
|
21624
22649
|
"thermostat.climate_preset_activated",
|
|
21625
22650
|
"thermostat.manually_adjusted",
|
|
21626
22651
|
"thermostat.temperature_threshold_exceeded",
|
|
21627
|
-
"thermostat.temperature_threshold_no_longer_exceeded"
|
|
22652
|
+
"thermostat.temperature_threshold_no_longer_exceeded",
|
|
22653
|
+
"thermostat.temperature_reached_set_point"
|
|
21628
22654
|
],
|
|
21629
22655
|
type: "string"
|
|
21630
22656
|
},
|