@seamapi/types 1.324.0 → 1.325.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 +991 -49
- package/dist/connect.cjs.map +1 -1
- package/dist/connect.d.cts +3076 -281
- 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/openapi.d.ts +124 -79
- package/lib/seam/connect/openapi.js +925 -35
- package/lib/seam/connect/openapi.js.map +1 -1
- package/lib/seam/connect/route-types.d.ts +1630 -44
- package/package.json +1 -1
- package/src/lib/seam/connect/models/devices/device.ts +118 -3
- package/src/lib/seam/connect/openapi.ts +995 -35
- package/src/lib/seam/connect/route-types.ts +2080 -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({
|
|
@@ -2975,13 +3027,191 @@ var openapi_default = {
|
|
|
2975
3027
|
type: "object"
|
|
2976
3028
|
},
|
|
2977
3029
|
{
|
|
2978
|
-
|
|
2979
|
-
|
|
2980
|
-
|
|
2981
|
-
|
|
2982
|
-
|
|
2983
|
-
|
|
2984
|
-
|
|
3030
|
+
description: "Error associated with the `device`.",
|
|
3031
|
+
oneOf: [
|
|
3032
|
+
{
|
|
3033
|
+
description: "Device is offline",
|
|
3034
|
+
properties: {
|
|
3035
|
+
error_code: {
|
|
3036
|
+
description: "Unique identifier of the type of error. Enables quick recognition and categorization of the issue.",
|
|
3037
|
+
enum: ["device_offline"],
|
|
3038
|
+
type: "string"
|
|
3039
|
+
},
|
|
3040
|
+
is_device_error: { enum: [true], type: "boolean" },
|
|
3041
|
+
message: { type: "string" }
|
|
3042
|
+
},
|
|
3043
|
+
required: ["message", "is_device_error", "error_code"],
|
|
3044
|
+
type: "object"
|
|
3045
|
+
},
|
|
3046
|
+
{
|
|
3047
|
+
description: "Device has been removed",
|
|
3048
|
+
properties: {
|
|
3049
|
+
error_code: {
|
|
3050
|
+
description: "Unique identifier of the type of error. Enables quick recognition and categorization of the issue.",
|
|
3051
|
+
enum: ["device_removed"],
|
|
3052
|
+
type: "string"
|
|
3053
|
+
},
|
|
3054
|
+
is_device_error: { enum: [true], type: "boolean" },
|
|
3055
|
+
message: { type: "string" }
|
|
3056
|
+
},
|
|
3057
|
+
required: ["message", "is_device_error", "error_code"],
|
|
3058
|
+
type: "object"
|
|
3059
|
+
},
|
|
3060
|
+
{
|
|
3061
|
+
description: "Account is disconnected",
|
|
3062
|
+
properties: {
|
|
3063
|
+
error_code: {
|
|
3064
|
+
description: "Unique identifier of the type of error. Enables quick recognition and categorization of the issue.",
|
|
3065
|
+
enum: ["account_disconnected"],
|
|
3066
|
+
type: "string"
|
|
3067
|
+
},
|
|
3068
|
+
is_device_error: { enum: [true], type: "boolean" },
|
|
3069
|
+
message: { type: "string" }
|
|
3070
|
+
},
|
|
3071
|
+
required: ["message", "is_device_error", "error_code"],
|
|
3072
|
+
type: "object"
|
|
3073
|
+
},
|
|
3074
|
+
{
|
|
3075
|
+
description: "Hub is disconnected",
|
|
3076
|
+
properties: {
|
|
3077
|
+
error_code: {
|
|
3078
|
+
description: "Unique identifier of the type of error. Enables quick recognition and categorization of the issue.",
|
|
3079
|
+
enum: ["hub_disconnected"],
|
|
3080
|
+
type: "string"
|
|
3081
|
+
},
|
|
3082
|
+
is_device_error: { enum: [true], type: "boolean" },
|
|
3083
|
+
message: { type: "string" }
|
|
3084
|
+
},
|
|
3085
|
+
required: ["message", "is_device_error", "error_code"],
|
|
3086
|
+
type: "object"
|
|
3087
|
+
},
|
|
3088
|
+
{
|
|
3089
|
+
description: "Device is disconnected",
|
|
3090
|
+
properties: {
|
|
3091
|
+
error_code: {
|
|
3092
|
+
description: "Unique identifier of the type of error. Enables quick recognition and categorization of the issue.",
|
|
3093
|
+
enum: ["device_disconnected"],
|
|
3094
|
+
type: "string"
|
|
3095
|
+
},
|
|
3096
|
+
is_device_error: { enum: [true], type: "boolean" },
|
|
3097
|
+
message: { type: "string" }
|
|
3098
|
+
},
|
|
3099
|
+
required: ["message", "is_device_error", "error_code"],
|
|
3100
|
+
type: "object"
|
|
3101
|
+
},
|
|
3102
|
+
{
|
|
3103
|
+
description: "The backup access code pool is empty.",
|
|
3104
|
+
properties: {
|
|
3105
|
+
error_code: {
|
|
3106
|
+
description: "Unique identifier of the type of error. Enables quick recognition and categorization of the issue.",
|
|
3107
|
+
enum: ["empty_backup_access_code_pool"],
|
|
3108
|
+
type: "string"
|
|
3109
|
+
},
|
|
3110
|
+
is_device_error: { enum: [true], type: "boolean" },
|
|
3111
|
+
message: { type: "string" }
|
|
3112
|
+
},
|
|
3113
|
+
required: ["message", "is_device_error", "error_code"],
|
|
3114
|
+
type: "object"
|
|
3115
|
+
},
|
|
3116
|
+
{
|
|
3117
|
+
description: "User is not authorized to use the August Lock.",
|
|
3118
|
+
properties: {
|
|
3119
|
+
error_code: {
|
|
3120
|
+
description: "Unique identifier of the type of error. Enables quick recognition and categorization of the issue.",
|
|
3121
|
+
enum: ["august_lock_not_authorized"],
|
|
3122
|
+
type: "string"
|
|
3123
|
+
},
|
|
3124
|
+
is_device_error: { enum: [true], type: "boolean" },
|
|
3125
|
+
message: { type: "string" }
|
|
3126
|
+
},
|
|
3127
|
+
required: ["message", "is_device_error", "error_code"],
|
|
3128
|
+
type: "object"
|
|
3129
|
+
},
|
|
3130
|
+
{
|
|
3131
|
+
description: "Lock is not connected to the Seam Bridge.",
|
|
3132
|
+
properties: {
|
|
3133
|
+
error_code: {
|
|
3134
|
+
description: "Unique identifier of the type of error. Enables quick recognition and categorization of the issue.",
|
|
3135
|
+
enum: ["august_lock_missing_bridge"],
|
|
3136
|
+
type: "string"
|
|
3137
|
+
},
|
|
3138
|
+
is_device_error: { enum: [true], type: "boolean" },
|
|
3139
|
+
message: { type: "string" }
|
|
3140
|
+
},
|
|
3141
|
+
required: ["message", "is_device_error", "error_code"],
|
|
3142
|
+
type: "object"
|
|
3143
|
+
},
|
|
3144
|
+
{
|
|
3145
|
+
description: "Salto site user limit reached.",
|
|
3146
|
+
properties: {
|
|
3147
|
+
error_code: {
|
|
3148
|
+
description: "Unique identifier of the type of error. Enables quick recognition and categorization of the issue.",
|
|
3149
|
+
enum: ["salto_site_user_limit_reached"],
|
|
3150
|
+
type: "string"
|
|
3151
|
+
},
|
|
3152
|
+
is_device_error: { enum: [true], type: "boolean" },
|
|
3153
|
+
message: { type: "string" }
|
|
3154
|
+
},
|
|
3155
|
+
required: ["message", "is_device_error", "error_code"],
|
|
3156
|
+
type: "object"
|
|
3157
|
+
},
|
|
3158
|
+
{
|
|
3159
|
+
description: "Lock is not paired with a Gateway.",
|
|
3160
|
+
properties: {
|
|
3161
|
+
error_code: {
|
|
3162
|
+
description: "Unique identifier of the type of error. Enables quick recognition and categorization of the issue.",
|
|
3163
|
+
enum: ["ttlock_lock_not_paired_to_gateway"],
|
|
3164
|
+
type: "string"
|
|
3165
|
+
},
|
|
3166
|
+
is_device_error: { enum: [true], type: "boolean" },
|
|
3167
|
+
message: { type: "string" }
|
|
3168
|
+
},
|
|
3169
|
+
required: ["message", "is_device_error", "error_code"],
|
|
3170
|
+
type: "object"
|
|
3171
|
+
},
|
|
3172
|
+
{
|
|
3173
|
+
description: "Missing device credentials.",
|
|
3174
|
+
properties: {
|
|
3175
|
+
error_code: {
|
|
3176
|
+
description: "Unique identifier of the type of error. Enables quick recognition and categorization of the issue.",
|
|
3177
|
+
enum: ["missing_device_credentials"],
|
|
3178
|
+
type: "string"
|
|
3179
|
+
},
|
|
3180
|
+
is_device_error: { enum: [true], type: "boolean" },
|
|
3181
|
+
message: { type: "string" }
|
|
3182
|
+
},
|
|
3183
|
+
required: ["message", "is_device_error", "error_code"],
|
|
3184
|
+
type: "object"
|
|
3185
|
+
},
|
|
3186
|
+
{
|
|
3187
|
+
description: "The auxiliary heat is running.",
|
|
3188
|
+
properties: {
|
|
3189
|
+
error_code: {
|
|
3190
|
+
description: "Unique identifier of the type of error. Enables quick recognition and categorization of the issue.",
|
|
3191
|
+
enum: ["auxiliary_heat_running"],
|
|
3192
|
+
type: "string"
|
|
3193
|
+
},
|
|
3194
|
+
is_device_error: { enum: [true], type: "boolean" },
|
|
3195
|
+
message: { type: "string" }
|
|
3196
|
+
},
|
|
3197
|
+
required: ["message", "is_device_error", "error_code"],
|
|
3198
|
+
type: "object"
|
|
3199
|
+
},
|
|
3200
|
+
{
|
|
3201
|
+
description: "Subscription required to connect.",
|
|
3202
|
+
properties: {
|
|
3203
|
+
error_code: {
|
|
3204
|
+
description: "Unique identifier of the type of error. Enables quick recognition and categorization of the issue.",
|
|
3205
|
+
enum: ["subscription_required"],
|
|
3206
|
+
type: "string"
|
|
3207
|
+
},
|
|
3208
|
+
is_device_error: { enum: [true], type: "boolean" },
|
|
3209
|
+
message: { type: "string" }
|
|
3210
|
+
},
|
|
3211
|
+
required: ["message", "is_device_error", "error_code"],
|
|
3212
|
+
type: "object"
|
|
3213
|
+
}
|
|
3214
|
+
]
|
|
2985
3215
|
},
|
|
2986
3216
|
{
|
|
2987
3217
|
properties: {
|
|
@@ -7031,13 +7261,191 @@ var openapi_default = {
|
|
|
7031
7261
|
items: {
|
|
7032
7262
|
oneOf: [
|
|
7033
7263
|
{
|
|
7034
|
-
|
|
7035
|
-
|
|
7036
|
-
|
|
7037
|
-
|
|
7038
|
-
|
|
7039
|
-
|
|
7040
|
-
|
|
7264
|
+
description: "Error associated with the `device`.",
|
|
7265
|
+
oneOf: [
|
|
7266
|
+
{
|
|
7267
|
+
description: "Device is offline",
|
|
7268
|
+
properties: {
|
|
7269
|
+
error_code: {
|
|
7270
|
+
description: "Unique identifier of the type of error. Enables quick recognition and categorization of the issue.",
|
|
7271
|
+
enum: ["device_offline"],
|
|
7272
|
+
type: "string"
|
|
7273
|
+
},
|
|
7274
|
+
is_device_error: { enum: [true], type: "boolean" },
|
|
7275
|
+
message: { type: "string" }
|
|
7276
|
+
},
|
|
7277
|
+
required: ["message", "is_device_error", "error_code"],
|
|
7278
|
+
type: "object"
|
|
7279
|
+
},
|
|
7280
|
+
{
|
|
7281
|
+
description: "Device has been removed",
|
|
7282
|
+
properties: {
|
|
7283
|
+
error_code: {
|
|
7284
|
+
description: "Unique identifier of the type of error. Enables quick recognition and categorization of the issue.",
|
|
7285
|
+
enum: ["device_removed"],
|
|
7286
|
+
type: "string"
|
|
7287
|
+
},
|
|
7288
|
+
is_device_error: { enum: [true], type: "boolean" },
|
|
7289
|
+
message: { type: "string" }
|
|
7290
|
+
},
|
|
7291
|
+
required: ["message", "is_device_error", "error_code"],
|
|
7292
|
+
type: "object"
|
|
7293
|
+
},
|
|
7294
|
+
{
|
|
7295
|
+
description: "Account is disconnected",
|
|
7296
|
+
properties: {
|
|
7297
|
+
error_code: {
|
|
7298
|
+
description: "Unique identifier of the type of error. Enables quick recognition and categorization of the issue.",
|
|
7299
|
+
enum: ["account_disconnected"],
|
|
7300
|
+
type: "string"
|
|
7301
|
+
},
|
|
7302
|
+
is_device_error: { enum: [true], type: "boolean" },
|
|
7303
|
+
message: { type: "string" }
|
|
7304
|
+
},
|
|
7305
|
+
required: ["message", "is_device_error", "error_code"],
|
|
7306
|
+
type: "object"
|
|
7307
|
+
},
|
|
7308
|
+
{
|
|
7309
|
+
description: "Hub is disconnected",
|
|
7310
|
+
properties: {
|
|
7311
|
+
error_code: {
|
|
7312
|
+
description: "Unique identifier of the type of error. Enables quick recognition and categorization of the issue.",
|
|
7313
|
+
enum: ["hub_disconnected"],
|
|
7314
|
+
type: "string"
|
|
7315
|
+
},
|
|
7316
|
+
is_device_error: { enum: [true], type: "boolean" },
|
|
7317
|
+
message: { type: "string" }
|
|
7318
|
+
},
|
|
7319
|
+
required: ["message", "is_device_error", "error_code"],
|
|
7320
|
+
type: "object"
|
|
7321
|
+
},
|
|
7322
|
+
{
|
|
7323
|
+
description: "Device is disconnected",
|
|
7324
|
+
properties: {
|
|
7325
|
+
error_code: {
|
|
7326
|
+
description: "Unique identifier of the type of error. Enables quick recognition and categorization of the issue.",
|
|
7327
|
+
enum: ["device_disconnected"],
|
|
7328
|
+
type: "string"
|
|
7329
|
+
},
|
|
7330
|
+
is_device_error: { enum: [true], type: "boolean" },
|
|
7331
|
+
message: { type: "string" }
|
|
7332
|
+
},
|
|
7333
|
+
required: ["message", "is_device_error", "error_code"],
|
|
7334
|
+
type: "object"
|
|
7335
|
+
},
|
|
7336
|
+
{
|
|
7337
|
+
description: "The backup access code pool is empty.",
|
|
7338
|
+
properties: {
|
|
7339
|
+
error_code: {
|
|
7340
|
+
description: "Unique identifier of the type of error. Enables quick recognition and categorization of the issue.",
|
|
7341
|
+
enum: ["empty_backup_access_code_pool"],
|
|
7342
|
+
type: "string"
|
|
7343
|
+
},
|
|
7344
|
+
is_device_error: { enum: [true], type: "boolean" },
|
|
7345
|
+
message: { type: "string" }
|
|
7346
|
+
},
|
|
7347
|
+
required: ["message", "is_device_error", "error_code"],
|
|
7348
|
+
type: "object"
|
|
7349
|
+
},
|
|
7350
|
+
{
|
|
7351
|
+
description: "User is not authorized to use the August Lock.",
|
|
7352
|
+
properties: {
|
|
7353
|
+
error_code: {
|
|
7354
|
+
description: "Unique identifier of the type of error. Enables quick recognition and categorization of the issue.",
|
|
7355
|
+
enum: ["august_lock_not_authorized"],
|
|
7356
|
+
type: "string"
|
|
7357
|
+
},
|
|
7358
|
+
is_device_error: { enum: [true], type: "boolean" },
|
|
7359
|
+
message: { type: "string" }
|
|
7360
|
+
},
|
|
7361
|
+
required: ["message", "is_device_error", "error_code"],
|
|
7362
|
+
type: "object"
|
|
7363
|
+
},
|
|
7364
|
+
{
|
|
7365
|
+
description: "Lock is not connected to the Seam Bridge.",
|
|
7366
|
+
properties: {
|
|
7367
|
+
error_code: {
|
|
7368
|
+
description: "Unique identifier of the type of error. Enables quick recognition and categorization of the issue.",
|
|
7369
|
+
enum: ["august_lock_missing_bridge"],
|
|
7370
|
+
type: "string"
|
|
7371
|
+
},
|
|
7372
|
+
is_device_error: { enum: [true], type: "boolean" },
|
|
7373
|
+
message: { type: "string" }
|
|
7374
|
+
},
|
|
7375
|
+
required: ["message", "is_device_error", "error_code"],
|
|
7376
|
+
type: "object"
|
|
7377
|
+
},
|
|
7378
|
+
{
|
|
7379
|
+
description: "Salto site user limit reached.",
|
|
7380
|
+
properties: {
|
|
7381
|
+
error_code: {
|
|
7382
|
+
description: "Unique identifier of the type of error. Enables quick recognition and categorization of the issue.",
|
|
7383
|
+
enum: ["salto_site_user_limit_reached"],
|
|
7384
|
+
type: "string"
|
|
7385
|
+
},
|
|
7386
|
+
is_device_error: { enum: [true], type: "boolean" },
|
|
7387
|
+
message: { type: "string" }
|
|
7388
|
+
},
|
|
7389
|
+
required: ["message", "is_device_error", "error_code"],
|
|
7390
|
+
type: "object"
|
|
7391
|
+
},
|
|
7392
|
+
{
|
|
7393
|
+
description: "Lock is not paired with a Gateway.",
|
|
7394
|
+
properties: {
|
|
7395
|
+
error_code: {
|
|
7396
|
+
description: "Unique identifier of the type of error. Enables quick recognition and categorization of the issue.",
|
|
7397
|
+
enum: ["ttlock_lock_not_paired_to_gateway"],
|
|
7398
|
+
type: "string"
|
|
7399
|
+
},
|
|
7400
|
+
is_device_error: { enum: [true], type: "boolean" },
|
|
7401
|
+
message: { type: "string" }
|
|
7402
|
+
},
|
|
7403
|
+
required: ["message", "is_device_error", "error_code"],
|
|
7404
|
+
type: "object"
|
|
7405
|
+
},
|
|
7406
|
+
{
|
|
7407
|
+
description: "Missing device credentials.",
|
|
7408
|
+
properties: {
|
|
7409
|
+
error_code: {
|
|
7410
|
+
description: "Unique identifier of the type of error. Enables quick recognition and categorization of the issue.",
|
|
7411
|
+
enum: ["missing_device_credentials"],
|
|
7412
|
+
type: "string"
|
|
7413
|
+
},
|
|
7414
|
+
is_device_error: { enum: [true], type: "boolean" },
|
|
7415
|
+
message: { type: "string" }
|
|
7416
|
+
},
|
|
7417
|
+
required: ["message", "is_device_error", "error_code"],
|
|
7418
|
+
type: "object"
|
|
7419
|
+
},
|
|
7420
|
+
{
|
|
7421
|
+
description: "The auxiliary heat is running.",
|
|
7422
|
+
properties: {
|
|
7423
|
+
error_code: {
|
|
7424
|
+
description: "Unique identifier of the type of error. Enables quick recognition and categorization of the issue.",
|
|
7425
|
+
enum: ["auxiliary_heat_running"],
|
|
7426
|
+
type: "string"
|
|
7427
|
+
},
|
|
7428
|
+
is_device_error: { enum: [true], type: "boolean" },
|
|
7429
|
+
message: { type: "string" }
|
|
7430
|
+
},
|
|
7431
|
+
required: ["message", "is_device_error", "error_code"],
|
|
7432
|
+
type: "object"
|
|
7433
|
+
},
|
|
7434
|
+
{
|
|
7435
|
+
description: "Subscription required to connect.",
|
|
7436
|
+
properties: {
|
|
7437
|
+
error_code: {
|
|
7438
|
+
description: "Unique identifier of the type of error. Enables quick recognition and categorization of the issue.",
|
|
7439
|
+
enum: ["subscription_required"],
|
|
7440
|
+
type: "string"
|
|
7441
|
+
},
|
|
7442
|
+
is_device_error: { enum: [true], type: "boolean" },
|
|
7443
|
+
message: { type: "string" }
|
|
7444
|
+
},
|
|
7445
|
+
required: ["message", "is_device_error", "error_code"],
|
|
7446
|
+
type: "object"
|
|
7447
|
+
}
|
|
7448
|
+
]
|
|
7041
7449
|
},
|
|
7042
7450
|
{
|
|
7043
7451
|
properties: {
|
|
@@ -12254,13 +12662,191 @@ var openapi_default = {
|
|
|
12254
12662
|
items: {
|
|
12255
12663
|
oneOf: [
|
|
12256
12664
|
{
|
|
12257
|
-
|
|
12258
|
-
|
|
12259
|
-
|
|
12260
|
-
|
|
12261
|
-
|
|
12262
|
-
|
|
12263
|
-
|
|
12665
|
+
description: "Error associated with the `device`.",
|
|
12666
|
+
oneOf: [
|
|
12667
|
+
{
|
|
12668
|
+
description: "Device is offline",
|
|
12669
|
+
properties: {
|
|
12670
|
+
error_code: {
|
|
12671
|
+
description: "Unique identifier of the type of error. Enables quick recognition and categorization of the issue.",
|
|
12672
|
+
enum: ["device_offline"],
|
|
12673
|
+
type: "string"
|
|
12674
|
+
},
|
|
12675
|
+
is_device_error: { enum: [true], type: "boolean" },
|
|
12676
|
+
message: { type: "string" }
|
|
12677
|
+
},
|
|
12678
|
+
required: ["message", "is_device_error", "error_code"],
|
|
12679
|
+
type: "object"
|
|
12680
|
+
},
|
|
12681
|
+
{
|
|
12682
|
+
description: "Device has been removed",
|
|
12683
|
+
properties: {
|
|
12684
|
+
error_code: {
|
|
12685
|
+
description: "Unique identifier of the type of error. Enables quick recognition and categorization of the issue.",
|
|
12686
|
+
enum: ["device_removed"],
|
|
12687
|
+
type: "string"
|
|
12688
|
+
},
|
|
12689
|
+
is_device_error: { enum: [true], type: "boolean" },
|
|
12690
|
+
message: { type: "string" }
|
|
12691
|
+
},
|
|
12692
|
+
required: ["message", "is_device_error", "error_code"],
|
|
12693
|
+
type: "object"
|
|
12694
|
+
},
|
|
12695
|
+
{
|
|
12696
|
+
description: "Account is disconnected",
|
|
12697
|
+
properties: {
|
|
12698
|
+
error_code: {
|
|
12699
|
+
description: "Unique identifier of the type of error. Enables quick recognition and categorization of the issue.",
|
|
12700
|
+
enum: ["account_disconnected"],
|
|
12701
|
+
type: "string"
|
|
12702
|
+
},
|
|
12703
|
+
is_device_error: { enum: [true], type: "boolean" },
|
|
12704
|
+
message: { type: "string" }
|
|
12705
|
+
},
|
|
12706
|
+
required: ["message", "is_device_error", "error_code"],
|
|
12707
|
+
type: "object"
|
|
12708
|
+
},
|
|
12709
|
+
{
|
|
12710
|
+
description: "Hub is disconnected",
|
|
12711
|
+
properties: {
|
|
12712
|
+
error_code: {
|
|
12713
|
+
description: "Unique identifier of the type of error. Enables quick recognition and categorization of the issue.",
|
|
12714
|
+
enum: ["hub_disconnected"],
|
|
12715
|
+
type: "string"
|
|
12716
|
+
},
|
|
12717
|
+
is_device_error: { enum: [true], type: "boolean" },
|
|
12718
|
+
message: { type: "string" }
|
|
12719
|
+
},
|
|
12720
|
+
required: ["message", "is_device_error", "error_code"],
|
|
12721
|
+
type: "object"
|
|
12722
|
+
},
|
|
12723
|
+
{
|
|
12724
|
+
description: "Device is disconnected",
|
|
12725
|
+
properties: {
|
|
12726
|
+
error_code: {
|
|
12727
|
+
description: "Unique identifier of the type of error. Enables quick recognition and categorization of the issue.",
|
|
12728
|
+
enum: ["device_disconnected"],
|
|
12729
|
+
type: "string"
|
|
12730
|
+
},
|
|
12731
|
+
is_device_error: { enum: [true], type: "boolean" },
|
|
12732
|
+
message: { type: "string" }
|
|
12733
|
+
},
|
|
12734
|
+
required: ["message", "is_device_error", "error_code"],
|
|
12735
|
+
type: "object"
|
|
12736
|
+
},
|
|
12737
|
+
{
|
|
12738
|
+
description: "The backup access code pool is empty.",
|
|
12739
|
+
properties: {
|
|
12740
|
+
error_code: {
|
|
12741
|
+
description: "Unique identifier of the type of error. Enables quick recognition and categorization of the issue.",
|
|
12742
|
+
enum: ["empty_backup_access_code_pool"],
|
|
12743
|
+
type: "string"
|
|
12744
|
+
},
|
|
12745
|
+
is_device_error: { enum: [true], type: "boolean" },
|
|
12746
|
+
message: { type: "string" }
|
|
12747
|
+
},
|
|
12748
|
+
required: ["message", "is_device_error", "error_code"],
|
|
12749
|
+
type: "object"
|
|
12750
|
+
},
|
|
12751
|
+
{
|
|
12752
|
+
description: "User is not authorized to use the August Lock.",
|
|
12753
|
+
properties: {
|
|
12754
|
+
error_code: {
|
|
12755
|
+
description: "Unique identifier of the type of error. Enables quick recognition and categorization of the issue.",
|
|
12756
|
+
enum: ["august_lock_not_authorized"],
|
|
12757
|
+
type: "string"
|
|
12758
|
+
},
|
|
12759
|
+
is_device_error: { enum: [true], type: "boolean" },
|
|
12760
|
+
message: { type: "string" }
|
|
12761
|
+
},
|
|
12762
|
+
required: ["message", "is_device_error", "error_code"],
|
|
12763
|
+
type: "object"
|
|
12764
|
+
},
|
|
12765
|
+
{
|
|
12766
|
+
description: "Lock is not connected to the Seam Bridge.",
|
|
12767
|
+
properties: {
|
|
12768
|
+
error_code: {
|
|
12769
|
+
description: "Unique identifier of the type of error. Enables quick recognition and categorization of the issue.",
|
|
12770
|
+
enum: ["august_lock_missing_bridge"],
|
|
12771
|
+
type: "string"
|
|
12772
|
+
},
|
|
12773
|
+
is_device_error: { enum: [true], type: "boolean" },
|
|
12774
|
+
message: { type: "string" }
|
|
12775
|
+
},
|
|
12776
|
+
required: ["message", "is_device_error", "error_code"],
|
|
12777
|
+
type: "object"
|
|
12778
|
+
},
|
|
12779
|
+
{
|
|
12780
|
+
description: "Salto site user limit reached.",
|
|
12781
|
+
properties: {
|
|
12782
|
+
error_code: {
|
|
12783
|
+
description: "Unique identifier of the type of error. Enables quick recognition and categorization of the issue.",
|
|
12784
|
+
enum: ["salto_site_user_limit_reached"],
|
|
12785
|
+
type: "string"
|
|
12786
|
+
},
|
|
12787
|
+
is_device_error: { enum: [true], type: "boolean" },
|
|
12788
|
+
message: { type: "string" }
|
|
12789
|
+
},
|
|
12790
|
+
required: ["message", "is_device_error", "error_code"],
|
|
12791
|
+
type: "object"
|
|
12792
|
+
},
|
|
12793
|
+
{
|
|
12794
|
+
description: "Lock is not paired with a Gateway.",
|
|
12795
|
+
properties: {
|
|
12796
|
+
error_code: {
|
|
12797
|
+
description: "Unique identifier of the type of error. Enables quick recognition and categorization of the issue.",
|
|
12798
|
+
enum: ["ttlock_lock_not_paired_to_gateway"],
|
|
12799
|
+
type: "string"
|
|
12800
|
+
},
|
|
12801
|
+
is_device_error: { enum: [true], type: "boolean" },
|
|
12802
|
+
message: { type: "string" }
|
|
12803
|
+
},
|
|
12804
|
+
required: ["message", "is_device_error", "error_code"],
|
|
12805
|
+
type: "object"
|
|
12806
|
+
},
|
|
12807
|
+
{
|
|
12808
|
+
description: "Missing device credentials.",
|
|
12809
|
+
properties: {
|
|
12810
|
+
error_code: {
|
|
12811
|
+
description: "Unique identifier of the type of error. Enables quick recognition and categorization of the issue.",
|
|
12812
|
+
enum: ["missing_device_credentials"],
|
|
12813
|
+
type: "string"
|
|
12814
|
+
},
|
|
12815
|
+
is_device_error: { enum: [true], type: "boolean" },
|
|
12816
|
+
message: { type: "string" }
|
|
12817
|
+
},
|
|
12818
|
+
required: ["message", "is_device_error", "error_code"],
|
|
12819
|
+
type: "object"
|
|
12820
|
+
},
|
|
12821
|
+
{
|
|
12822
|
+
description: "The auxiliary heat is running.",
|
|
12823
|
+
properties: {
|
|
12824
|
+
error_code: {
|
|
12825
|
+
description: "Unique identifier of the type of error. Enables quick recognition and categorization of the issue.",
|
|
12826
|
+
enum: ["auxiliary_heat_running"],
|
|
12827
|
+
type: "string"
|
|
12828
|
+
},
|
|
12829
|
+
is_device_error: { enum: [true], type: "boolean" },
|
|
12830
|
+
message: { type: "string" }
|
|
12831
|
+
},
|
|
12832
|
+
required: ["message", "is_device_error", "error_code"],
|
|
12833
|
+
type: "object"
|
|
12834
|
+
},
|
|
12835
|
+
{
|
|
12836
|
+
description: "Subscription required to connect.",
|
|
12837
|
+
properties: {
|
|
12838
|
+
error_code: {
|
|
12839
|
+
description: "Unique identifier of the type of error. Enables quick recognition and categorization of the issue.",
|
|
12840
|
+
enum: ["subscription_required"],
|
|
12841
|
+
type: "string"
|
|
12842
|
+
},
|
|
12843
|
+
is_device_error: { enum: [true], type: "boolean" },
|
|
12844
|
+
message: { type: "string" }
|
|
12845
|
+
},
|
|
12846
|
+
required: ["message", "is_device_error", "error_code"],
|
|
12847
|
+
type: "object"
|
|
12848
|
+
}
|
|
12849
|
+
]
|
|
12264
12850
|
},
|
|
12265
12851
|
{
|
|
12266
12852
|
properties: {
|
|
@@ -12485,13 +13071,191 @@ var openapi_default = {
|
|
|
12485
13071
|
type: "object"
|
|
12486
13072
|
},
|
|
12487
13073
|
{
|
|
12488
|
-
|
|
12489
|
-
|
|
12490
|
-
|
|
12491
|
-
|
|
12492
|
-
|
|
12493
|
-
|
|
12494
|
-
|
|
13074
|
+
description: "Error associated with the `device`.",
|
|
13075
|
+
oneOf: [
|
|
13076
|
+
{
|
|
13077
|
+
description: "Device is offline",
|
|
13078
|
+
properties: {
|
|
13079
|
+
error_code: {
|
|
13080
|
+
description: "Unique identifier of the type of error. Enables quick recognition and categorization of the issue.",
|
|
13081
|
+
enum: ["device_offline"],
|
|
13082
|
+
type: "string"
|
|
13083
|
+
},
|
|
13084
|
+
is_device_error: { enum: [true], type: "boolean" },
|
|
13085
|
+
message: { type: "string" }
|
|
13086
|
+
},
|
|
13087
|
+
required: ["message", "is_device_error", "error_code"],
|
|
13088
|
+
type: "object"
|
|
13089
|
+
},
|
|
13090
|
+
{
|
|
13091
|
+
description: "Device has been removed",
|
|
13092
|
+
properties: {
|
|
13093
|
+
error_code: {
|
|
13094
|
+
description: "Unique identifier of the type of error. Enables quick recognition and categorization of the issue.",
|
|
13095
|
+
enum: ["device_removed"],
|
|
13096
|
+
type: "string"
|
|
13097
|
+
},
|
|
13098
|
+
is_device_error: { enum: [true], type: "boolean" },
|
|
13099
|
+
message: { type: "string" }
|
|
13100
|
+
},
|
|
13101
|
+
required: ["message", "is_device_error", "error_code"],
|
|
13102
|
+
type: "object"
|
|
13103
|
+
},
|
|
13104
|
+
{
|
|
13105
|
+
description: "Account is disconnected",
|
|
13106
|
+
properties: {
|
|
13107
|
+
error_code: {
|
|
13108
|
+
description: "Unique identifier of the type of error. Enables quick recognition and categorization of the issue.",
|
|
13109
|
+
enum: ["account_disconnected"],
|
|
13110
|
+
type: "string"
|
|
13111
|
+
},
|
|
13112
|
+
is_device_error: { enum: [true], type: "boolean" },
|
|
13113
|
+
message: { type: "string" }
|
|
13114
|
+
},
|
|
13115
|
+
required: ["message", "is_device_error", "error_code"],
|
|
13116
|
+
type: "object"
|
|
13117
|
+
},
|
|
13118
|
+
{
|
|
13119
|
+
description: "Hub is disconnected",
|
|
13120
|
+
properties: {
|
|
13121
|
+
error_code: {
|
|
13122
|
+
description: "Unique identifier of the type of error. Enables quick recognition and categorization of the issue.",
|
|
13123
|
+
enum: ["hub_disconnected"],
|
|
13124
|
+
type: "string"
|
|
13125
|
+
},
|
|
13126
|
+
is_device_error: { enum: [true], type: "boolean" },
|
|
13127
|
+
message: { type: "string" }
|
|
13128
|
+
},
|
|
13129
|
+
required: ["message", "is_device_error", "error_code"],
|
|
13130
|
+
type: "object"
|
|
13131
|
+
},
|
|
13132
|
+
{
|
|
13133
|
+
description: "Device is disconnected",
|
|
13134
|
+
properties: {
|
|
13135
|
+
error_code: {
|
|
13136
|
+
description: "Unique identifier of the type of error. Enables quick recognition and categorization of the issue.",
|
|
13137
|
+
enum: ["device_disconnected"],
|
|
13138
|
+
type: "string"
|
|
13139
|
+
},
|
|
13140
|
+
is_device_error: { enum: [true], type: "boolean" },
|
|
13141
|
+
message: { type: "string" }
|
|
13142
|
+
},
|
|
13143
|
+
required: ["message", "is_device_error", "error_code"],
|
|
13144
|
+
type: "object"
|
|
13145
|
+
},
|
|
13146
|
+
{
|
|
13147
|
+
description: "The backup access code pool is empty.",
|
|
13148
|
+
properties: {
|
|
13149
|
+
error_code: {
|
|
13150
|
+
description: "Unique identifier of the type of error. Enables quick recognition and categorization of the issue.",
|
|
13151
|
+
enum: ["empty_backup_access_code_pool"],
|
|
13152
|
+
type: "string"
|
|
13153
|
+
},
|
|
13154
|
+
is_device_error: { enum: [true], type: "boolean" },
|
|
13155
|
+
message: { type: "string" }
|
|
13156
|
+
},
|
|
13157
|
+
required: ["message", "is_device_error", "error_code"],
|
|
13158
|
+
type: "object"
|
|
13159
|
+
},
|
|
13160
|
+
{
|
|
13161
|
+
description: "User is not authorized to use the August Lock.",
|
|
13162
|
+
properties: {
|
|
13163
|
+
error_code: {
|
|
13164
|
+
description: "Unique identifier of the type of error. Enables quick recognition and categorization of the issue.",
|
|
13165
|
+
enum: ["august_lock_not_authorized"],
|
|
13166
|
+
type: "string"
|
|
13167
|
+
},
|
|
13168
|
+
is_device_error: { enum: [true], type: "boolean" },
|
|
13169
|
+
message: { type: "string" }
|
|
13170
|
+
},
|
|
13171
|
+
required: ["message", "is_device_error", "error_code"],
|
|
13172
|
+
type: "object"
|
|
13173
|
+
},
|
|
13174
|
+
{
|
|
13175
|
+
description: "Lock is not connected to the Seam Bridge.",
|
|
13176
|
+
properties: {
|
|
13177
|
+
error_code: {
|
|
13178
|
+
description: "Unique identifier of the type of error. Enables quick recognition and categorization of the issue.",
|
|
13179
|
+
enum: ["august_lock_missing_bridge"],
|
|
13180
|
+
type: "string"
|
|
13181
|
+
},
|
|
13182
|
+
is_device_error: { enum: [true], type: "boolean" },
|
|
13183
|
+
message: { type: "string" }
|
|
13184
|
+
},
|
|
13185
|
+
required: ["message", "is_device_error", "error_code"],
|
|
13186
|
+
type: "object"
|
|
13187
|
+
},
|
|
13188
|
+
{
|
|
13189
|
+
description: "Salto site user limit reached.",
|
|
13190
|
+
properties: {
|
|
13191
|
+
error_code: {
|
|
13192
|
+
description: "Unique identifier of the type of error. Enables quick recognition and categorization of the issue.",
|
|
13193
|
+
enum: ["salto_site_user_limit_reached"],
|
|
13194
|
+
type: "string"
|
|
13195
|
+
},
|
|
13196
|
+
is_device_error: { enum: [true], type: "boolean" },
|
|
13197
|
+
message: { type: "string" }
|
|
13198
|
+
},
|
|
13199
|
+
required: ["message", "is_device_error", "error_code"],
|
|
13200
|
+
type: "object"
|
|
13201
|
+
},
|
|
13202
|
+
{
|
|
13203
|
+
description: "Lock is not paired with a Gateway.",
|
|
13204
|
+
properties: {
|
|
13205
|
+
error_code: {
|
|
13206
|
+
description: "Unique identifier of the type of error. Enables quick recognition and categorization of the issue.",
|
|
13207
|
+
enum: ["ttlock_lock_not_paired_to_gateway"],
|
|
13208
|
+
type: "string"
|
|
13209
|
+
},
|
|
13210
|
+
is_device_error: { enum: [true], type: "boolean" },
|
|
13211
|
+
message: { type: "string" }
|
|
13212
|
+
},
|
|
13213
|
+
required: ["message", "is_device_error", "error_code"],
|
|
13214
|
+
type: "object"
|
|
13215
|
+
},
|
|
13216
|
+
{
|
|
13217
|
+
description: "Missing device credentials.",
|
|
13218
|
+
properties: {
|
|
13219
|
+
error_code: {
|
|
13220
|
+
description: "Unique identifier of the type of error. Enables quick recognition and categorization of the issue.",
|
|
13221
|
+
enum: ["missing_device_credentials"],
|
|
13222
|
+
type: "string"
|
|
13223
|
+
},
|
|
13224
|
+
is_device_error: { enum: [true], type: "boolean" },
|
|
13225
|
+
message: { type: "string" }
|
|
13226
|
+
},
|
|
13227
|
+
required: ["message", "is_device_error", "error_code"],
|
|
13228
|
+
type: "object"
|
|
13229
|
+
},
|
|
13230
|
+
{
|
|
13231
|
+
description: "The auxiliary heat is running.",
|
|
13232
|
+
properties: {
|
|
13233
|
+
error_code: {
|
|
13234
|
+
description: "Unique identifier of the type of error. Enables quick recognition and categorization of the issue.",
|
|
13235
|
+
enum: ["auxiliary_heat_running"],
|
|
13236
|
+
type: "string"
|
|
13237
|
+
},
|
|
13238
|
+
is_device_error: { enum: [true], type: "boolean" },
|
|
13239
|
+
message: { type: "string" }
|
|
13240
|
+
},
|
|
13241
|
+
required: ["message", "is_device_error", "error_code"],
|
|
13242
|
+
type: "object"
|
|
13243
|
+
},
|
|
13244
|
+
{
|
|
13245
|
+
description: "Subscription required to connect.",
|
|
13246
|
+
properties: {
|
|
13247
|
+
error_code: {
|
|
13248
|
+
description: "Unique identifier of the type of error. Enables quick recognition and categorization of the issue.",
|
|
13249
|
+
enum: ["subscription_required"],
|
|
13250
|
+
type: "string"
|
|
13251
|
+
},
|
|
13252
|
+
is_device_error: { enum: [true], type: "boolean" },
|
|
13253
|
+
message: { type: "string" }
|
|
13254
|
+
},
|
|
13255
|
+
required: ["message", "is_device_error", "error_code"],
|
|
13256
|
+
type: "object"
|
|
13257
|
+
}
|
|
13258
|
+
]
|
|
12495
13259
|
},
|
|
12496
13260
|
{
|
|
12497
13261
|
properties: {
|
|
@@ -12657,13 +13421,191 @@ var openapi_default = {
|
|
|
12657
13421
|
items: {
|
|
12658
13422
|
oneOf: [
|
|
12659
13423
|
{
|
|
12660
|
-
|
|
12661
|
-
|
|
12662
|
-
|
|
12663
|
-
|
|
12664
|
-
|
|
12665
|
-
|
|
12666
|
-
|
|
13424
|
+
description: "Error associated with the `device`.",
|
|
13425
|
+
oneOf: [
|
|
13426
|
+
{
|
|
13427
|
+
description: "Device is offline",
|
|
13428
|
+
properties: {
|
|
13429
|
+
error_code: {
|
|
13430
|
+
description: "Unique identifier of the type of error. Enables quick recognition and categorization of the issue.",
|
|
13431
|
+
enum: ["device_offline"],
|
|
13432
|
+
type: "string"
|
|
13433
|
+
},
|
|
13434
|
+
is_device_error: { enum: [true], type: "boolean" },
|
|
13435
|
+
message: { type: "string" }
|
|
13436
|
+
},
|
|
13437
|
+
required: ["message", "is_device_error", "error_code"],
|
|
13438
|
+
type: "object"
|
|
13439
|
+
},
|
|
13440
|
+
{
|
|
13441
|
+
description: "Device has been removed",
|
|
13442
|
+
properties: {
|
|
13443
|
+
error_code: {
|
|
13444
|
+
description: "Unique identifier of the type of error. Enables quick recognition and categorization of the issue.",
|
|
13445
|
+
enum: ["device_removed"],
|
|
13446
|
+
type: "string"
|
|
13447
|
+
},
|
|
13448
|
+
is_device_error: { enum: [true], type: "boolean" },
|
|
13449
|
+
message: { type: "string" }
|
|
13450
|
+
},
|
|
13451
|
+
required: ["message", "is_device_error", "error_code"],
|
|
13452
|
+
type: "object"
|
|
13453
|
+
},
|
|
13454
|
+
{
|
|
13455
|
+
description: "Account is disconnected",
|
|
13456
|
+
properties: {
|
|
13457
|
+
error_code: {
|
|
13458
|
+
description: "Unique identifier of the type of error. Enables quick recognition and categorization of the issue.",
|
|
13459
|
+
enum: ["account_disconnected"],
|
|
13460
|
+
type: "string"
|
|
13461
|
+
},
|
|
13462
|
+
is_device_error: { enum: [true], type: "boolean" },
|
|
13463
|
+
message: { type: "string" }
|
|
13464
|
+
},
|
|
13465
|
+
required: ["message", "is_device_error", "error_code"],
|
|
13466
|
+
type: "object"
|
|
13467
|
+
},
|
|
13468
|
+
{
|
|
13469
|
+
description: "Hub is disconnected",
|
|
13470
|
+
properties: {
|
|
13471
|
+
error_code: {
|
|
13472
|
+
description: "Unique identifier of the type of error. Enables quick recognition and categorization of the issue.",
|
|
13473
|
+
enum: ["hub_disconnected"],
|
|
13474
|
+
type: "string"
|
|
13475
|
+
},
|
|
13476
|
+
is_device_error: { enum: [true], type: "boolean" },
|
|
13477
|
+
message: { type: "string" }
|
|
13478
|
+
},
|
|
13479
|
+
required: ["message", "is_device_error", "error_code"],
|
|
13480
|
+
type: "object"
|
|
13481
|
+
},
|
|
13482
|
+
{
|
|
13483
|
+
description: "Device is disconnected",
|
|
13484
|
+
properties: {
|
|
13485
|
+
error_code: {
|
|
13486
|
+
description: "Unique identifier of the type of error. Enables quick recognition and categorization of the issue.",
|
|
13487
|
+
enum: ["device_disconnected"],
|
|
13488
|
+
type: "string"
|
|
13489
|
+
},
|
|
13490
|
+
is_device_error: { enum: [true], type: "boolean" },
|
|
13491
|
+
message: { type: "string" }
|
|
13492
|
+
},
|
|
13493
|
+
required: ["message", "is_device_error", "error_code"],
|
|
13494
|
+
type: "object"
|
|
13495
|
+
},
|
|
13496
|
+
{
|
|
13497
|
+
description: "The backup access code pool is empty.",
|
|
13498
|
+
properties: {
|
|
13499
|
+
error_code: {
|
|
13500
|
+
description: "Unique identifier of the type of error. Enables quick recognition and categorization of the issue.",
|
|
13501
|
+
enum: ["empty_backup_access_code_pool"],
|
|
13502
|
+
type: "string"
|
|
13503
|
+
},
|
|
13504
|
+
is_device_error: { enum: [true], type: "boolean" },
|
|
13505
|
+
message: { type: "string" }
|
|
13506
|
+
},
|
|
13507
|
+
required: ["message", "is_device_error", "error_code"],
|
|
13508
|
+
type: "object"
|
|
13509
|
+
},
|
|
13510
|
+
{
|
|
13511
|
+
description: "User is not authorized to use the August Lock.",
|
|
13512
|
+
properties: {
|
|
13513
|
+
error_code: {
|
|
13514
|
+
description: "Unique identifier of the type of error. Enables quick recognition and categorization of the issue.",
|
|
13515
|
+
enum: ["august_lock_not_authorized"],
|
|
13516
|
+
type: "string"
|
|
13517
|
+
},
|
|
13518
|
+
is_device_error: { enum: [true], type: "boolean" },
|
|
13519
|
+
message: { type: "string" }
|
|
13520
|
+
},
|
|
13521
|
+
required: ["message", "is_device_error", "error_code"],
|
|
13522
|
+
type: "object"
|
|
13523
|
+
},
|
|
13524
|
+
{
|
|
13525
|
+
description: "Lock is not connected to the Seam Bridge.",
|
|
13526
|
+
properties: {
|
|
13527
|
+
error_code: {
|
|
13528
|
+
description: "Unique identifier of the type of error. Enables quick recognition and categorization of the issue.",
|
|
13529
|
+
enum: ["august_lock_missing_bridge"],
|
|
13530
|
+
type: "string"
|
|
13531
|
+
},
|
|
13532
|
+
is_device_error: { enum: [true], type: "boolean" },
|
|
13533
|
+
message: { type: "string" }
|
|
13534
|
+
},
|
|
13535
|
+
required: ["message", "is_device_error", "error_code"],
|
|
13536
|
+
type: "object"
|
|
13537
|
+
},
|
|
13538
|
+
{
|
|
13539
|
+
description: "Salto site user limit reached.",
|
|
13540
|
+
properties: {
|
|
13541
|
+
error_code: {
|
|
13542
|
+
description: "Unique identifier of the type of error. Enables quick recognition and categorization of the issue.",
|
|
13543
|
+
enum: ["salto_site_user_limit_reached"],
|
|
13544
|
+
type: "string"
|
|
13545
|
+
},
|
|
13546
|
+
is_device_error: { enum: [true], type: "boolean" },
|
|
13547
|
+
message: { type: "string" }
|
|
13548
|
+
},
|
|
13549
|
+
required: ["message", "is_device_error", "error_code"],
|
|
13550
|
+
type: "object"
|
|
13551
|
+
},
|
|
13552
|
+
{
|
|
13553
|
+
description: "Lock is not paired with a Gateway.",
|
|
13554
|
+
properties: {
|
|
13555
|
+
error_code: {
|
|
13556
|
+
description: "Unique identifier of the type of error. Enables quick recognition and categorization of the issue.",
|
|
13557
|
+
enum: ["ttlock_lock_not_paired_to_gateway"],
|
|
13558
|
+
type: "string"
|
|
13559
|
+
},
|
|
13560
|
+
is_device_error: { enum: [true], type: "boolean" },
|
|
13561
|
+
message: { type: "string" }
|
|
13562
|
+
},
|
|
13563
|
+
required: ["message", "is_device_error", "error_code"],
|
|
13564
|
+
type: "object"
|
|
13565
|
+
},
|
|
13566
|
+
{
|
|
13567
|
+
description: "Missing device credentials.",
|
|
13568
|
+
properties: {
|
|
13569
|
+
error_code: {
|
|
13570
|
+
description: "Unique identifier of the type of error. Enables quick recognition and categorization of the issue.",
|
|
13571
|
+
enum: ["missing_device_credentials"],
|
|
13572
|
+
type: "string"
|
|
13573
|
+
},
|
|
13574
|
+
is_device_error: { enum: [true], type: "boolean" },
|
|
13575
|
+
message: { type: "string" }
|
|
13576
|
+
},
|
|
13577
|
+
required: ["message", "is_device_error", "error_code"],
|
|
13578
|
+
type: "object"
|
|
13579
|
+
},
|
|
13580
|
+
{
|
|
13581
|
+
description: "The auxiliary heat is running.",
|
|
13582
|
+
properties: {
|
|
13583
|
+
error_code: {
|
|
13584
|
+
description: "Unique identifier of the type of error. Enables quick recognition and categorization of the issue.",
|
|
13585
|
+
enum: ["auxiliary_heat_running"],
|
|
13586
|
+
type: "string"
|
|
13587
|
+
},
|
|
13588
|
+
is_device_error: { enum: [true], type: "boolean" },
|
|
13589
|
+
message: { type: "string" }
|
|
13590
|
+
},
|
|
13591
|
+
required: ["message", "is_device_error", "error_code"],
|
|
13592
|
+
type: "object"
|
|
13593
|
+
},
|
|
13594
|
+
{
|
|
13595
|
+
description: "Subscription required to connect.",
|
|
13596
|
+
properties: {
|
|
13597
|
+
error_code: {
|
|
13598
|
+
description: "Unique identifier of the type of error. Enables quick recognition and categorization of the issue.",
|
|
13599
|
+
enum: ["subscription_required"],
|
|
13600
|
+
type: "string"
|
|
13601
|
+
},
|
|
13602
|
+
is_device_error: { enum: [true], type: "boolean" },
|
|
13603
|
+
message: { type: "string" }
|
|
13604
|
+
},
|
|
13605
|
+
required: ["message", "is_device_error", "error_code"],
|
|
13606
|
+
type: "object"
|
|
13607
|
+
}
|
|
13608
|
+
]
|
|
12667
13609
|
},
|
|
12668
13610
|
{
|
|
12669
13611
|
properties: {
|