@seamapi/types 1.344.1 → 1.344.3

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.
Files changed (40) hide show
  1. package/dist/connect.cjs +1781 -1992
  2. package/dist/connect.cjs.map +1 -1
  3. package/dist/connect.d.cts +532 -633
  4. package/lib/seam/connect/models/access-codes/managed-access-code.d.ts +33 -28
  5. package/lib/seam/connect/models/access-codes/managed-access-code.js +15 -3
  6. package/lib/seam/connect/models/access-codes/managed-access-code.js.map +1 -1
  7. package/lib/seam/connect/models/access-codes/unmanaged-access-code.d.ts +21 -26
  8. package/lib/seam/connect/models/acs/acs-credential.d.ts +2 -2
  9. package/lib/seam/connect/models/acs/acs-credential.js +1 -1
  10. package/lib/seam/connect/models/acs/acs-credential.js.map +1 -1
  11. package/lib/seam/connect/models/acs/acs-system.d.ts +2 -2
  12. package/lib/seam/connect/models/acs/acs-system.js +2 -2
  13. package/lib/seam/connect/models/acs/acs-system.js.map +1 -1
  14. package/lib/seam/connect/models/acs/acs-user.d.ts +5 -5
  15. package/lib/seam/connect/models/acs/acs-user.js +2 -2
  16. package/lib/seam/connect/models/acs/acs-user.js.map +1 -1
  17. package/lib/seam/connect/models/action-attempts/action-attempt.d.ts +4 -4
  18. package/lib/seam/connect/models/action-attempts/encode-credential.d.ts +2 -2
  19. package/lib/seam/connect/models/action-attempts/scan-credential.d.ts +2 -2
  20. package/lib/seam/connect/models/connected-accounts/connected-account.d.ts +4 -4
  21. package/lib/seam/connect/models/connected-accounts/connected-account.js +6 -3
  22. package/lib/seam/connect/models/connected-accounts/connected-account.js.map +1 -1
  23. package/lib/seam/connect/models/devices/device.d.ts +6 -40
  24. package/lib/seam/connect/models/devices/device.js +6 -11
  25. package/lib/seam/connect/models/devices/device.js.map +1 -1
  26. package/lib/seam/connect/models/devices/phone.d.ts +4 -25
  27. package/lib/seam/connect/models/devices/unmanaged-device.d.ts +4 -25
  28. package/lib/seam/connect/openapi.d.ts +271 -223
  29. package/lib/seam/connect/openapi.js +1495 -1720
  30. package/lib/seam/connect/openapi.js.map +1 -1
  31. package/lib/seam/connect/route-types.d.ts +181 -275
  32. package/package.json +1 -1
  33. package/src/lib/seam/connect/models/access-codes/managed-access-code.ts +18 -3
  34. package/src/lib/seam/connect/models/acs/acs-credential.ts +1 -1
  35. package/src/lib/seam/connect/models/acs/acs-system.ts +2 -2
  36. package/src/lib/seam/connect/models/acs/acs-user.ts +2 -2
  37. package/src/lib/seam/connect/models/connected-accounts/connected-account.ts +6 -3
  38. package/src/lib/seam/connect/models/devices/device.ts +8 -12
  39. package/src/lib/seam/connect/openapi.ts +1599 -1832
  40. package/src/lib/seam/connect/route-types.ts +3261 -3494
package/dist/connect.cjs CHANGED
@@ -56,7 +56,7 @@ var common_connected_account_error = zod.z.object({
56
56
  message: zod.z.string(),
57
57
  is_connected_account_error: zod.z.literal(true)
58
58
  });
59
- var error_code_description = "Unique identifier of the type of warning. Enables quick recognition and categorization of the issue.";
59
+ var error_code_description = "Unique identifier of the type of error. Enables quick recognition and categorization of the issue.";
60
60
  var warning_code_description = "Unique identifier of the type of warning. Enables quick recognition and categorization of the issue.";
61
61
  var common_connected_account_warning = zod.z.object({
62
62
  message: zod.z.string()
@@ -67,7 +67,7 @@ var account_disconnected = common_connected_account_error.extend({
67
67
  var invalid_credentials = common_connected_account_error.extend({
68
68
  error_code: zod.z.literal("invalid_credentials").describe(error_code_description)
69
69
  }).describe("Credentials provided were invalid.");
70
- var connected_account_error = zod.z.union([
70
+ var connected_account_error = zod.z.discriminatedUnion("error_code", [
71
71
  account_disconnected,
72
72
  invalid_credentials
73
73
  ]);
@@ -79,7 +79,10 @@ var unknown_issue_with_connected_account = common_connected_account_warning.exte
79
79
  var scheduled_maintenance_window = common_connected_account_warning.extend({
80
80
  warning_code: zod.z.literal("scheduled_maintenance_window").describe(warning_code_description)
81
81
  }).describe("Scheduled downtime for account planned.");
82
- var connected_account_warning = zod.z.union([scheduled_maintenance_window, unknown_issue_with_connected_account]).describe("Warning associated with the `connected_account`.");
82
+ var connected_account_warning = zod.z.discriminatedUnion("warning_code", [
83
+ scheduled_maintenance_window,
84
+ unknown_issue_with_connected_account
85
+ ]).describe("Warning associated with the `connected_account`.");
83
86
  var connected_account = zod.z.object({
84
87
  connected_account_id: zod.z.string().uuid().optional(),
85
88
  created_at: zod.z.string().datetime().optional(),
@@ -835,9 +838,6 @@ var device_offline = common_device_error.extend({
835
838
  var device_removed = common_device_error.extend({
836
839
  error_code: zod.z.literal("device_removed").describe(error_code_description2)
837
840
  }).describe("Device has been removed");
838
- var account_disconnected2 = common_device_error.extend({
839
- error_code: zod.z.literal("account_disconnected").describe(error_code_description2)
840
- }).describe("Account is disconnected");
841
841
  var hub_disconnected = common_device_error.extend({
842
842
  error_code: zod.z.literal("hub_disconnected").describe(error_code_description2)
843
843
  }).describe("Hub is disconnected");
@@ -868,10 +868,9 @@ var auxiliary_heat_running = common_device_error.extend({
868
868
  var subscription_required = common_device_error.extend({
869
869
  error_code: zod.z.literal("subscription_required").describe(error_code_description2)
870
870
  }).describe("Subscription required to connect.");
871
- var device_error = zod.z.union([
871
+ var device_error = zod.z.discriminatedUnion("error_code", [
872
872
  device_offline,
873
873
  device_removed,
874
- account_disconnected2,
875
874
  hub_disconnected,
876
875
  device_disconnected,
877
876
  empty_backup_access_code_pool,
@@ -937,7 +936,7 @@ var unknown_issue_with_phone = common_device_warning.extend({
937
936
  }).describe(
938
937
  "An unknown issue occurred while syncing the state of this phone with the provider. This issue may affect the proper functioning of this phone."
939
938
  );
940
- var device_warning = zod.z.union([
939
+ var device_warning = zod.z.discriminatedUnion("warning_code", [
941
940
  partial_backup_access_code_pool,
942
941
  many_active_backup_codes,
943
942
  salto_unknown_device_type,
@@ -1059,7 +1058,12 @@ var device = zod.z.object({
1059
1058
  workspace_id: zod.z.string().uuid().describe(
1060
1059
  "Unique identifier for the Seam workspace associated with the device."
1061
1060
  ),
1062
- errors: zod.z.array(zod.z.union([device_error, connected_account_error])).describe(
1061
+ errors: zod.z.array(
1062
+ zod.z.discriminatedUnion("error_code", [
1063
+ ...device_error.options,
1064
+ ...connected_account_error.options
1065
+ ])
1066
+ ).describe(
1063
1067
  'Array of errors associated with the device. Each error object within the array contains two fields: "error_code" and "message." "error_code" is a string that uniquely identifies the type of error, enabling quick recognition and categorization of the issue. "message" provides a more detailed description of the error, offering insights into the issue and potentially how to rectify it.'
1064
1068
  ),
1065
1069
  warnings: zod.z.array(device_warning).describe(
@@ -1287,7 +1291,7 @@ var hubitat_device_programming_delay = common_access_code_error.extend({
1287
1291
  var hubitat_no_free_positions_available = common_access_code_error.extend({
1288
1292
  error_code: zod.z.literal("hubitat_no_free_positions_available").describe(error_code_description3)
1289
1293
  }).describe("No free positions available on the device.");
1290
- var access_code_error = zod.z.union([
1294
+ var access_code_error = zod.z.discriminatedUnion("error_code", [
1291
1295
  smartthings_failed_to_set_access_code_error,
1292
1296
  smartthings_failed_to_set_after_multiple_retries,
1293
1297
  failed_to_set_on_device,
@@ -1329,6 +1333,9 @@ var schlage_detected_duplicate = common_access_code_warning.extend({
1329
1333
  var schlage_creation_outage = common_access_code_warning.extend({
1330
1334
  warning_code: zod.z.literal("schlage_creation_outage").describe(warning_code_description3)
1331
1335
  }).describe("Received an error when attempting to create this code.");
1336
+ var salto_office_mode2 = common_access_code_warning.extend({
1337
+ warning_code: zod.z.literal("salto_office_mode").describe(warning_code_description3)
1338
+ }).describe("Lock is in Office Mode. Access Codes will not unlock doors.");
1332
1339
  var delay_in_setting_on_device = common_access_code_warning.extend({
1333
1340
  warning_code: zod.z.literal("delay_in_setting_on_device").describe(warning_code_description3)
1334
1341
  }).describe("Delay in setting code on device.");
@@ -1346,10 +1353,11 @@ var igloo_algopin_must_be_used_within_24_hours = common_access_code_warning.exte
1346
1353
  var management_transferred = common_access_code_warning.extend({
1347
1354
  warning_code: zod.z.literal("management_transferred").describe(warning_code_description3)
1348
1355
  }).describe("Management was transferred to another workspace.");
1349
- var access_code_warning = zod.z.union([
1356
+ var access_code_warning = zod.z.discriminatedUnion("warning_code", [
1350
1357
  smartthings_failed_to_set_access_code_warning,
1351
1358
  schlage_detected_duplicate,
1352
1359
  schlage_creation_outage,
1360
+ salto_office_mode2,
1353
1361
  code_modified_external_to_seam_warning,
1354
1362
  delay_in_setting_on_device,
1355
1363
  delay_in_removing_from_device,
@@ -1382,7 +1390,13 @@ var access_code = zod.z.object({
1382
1390
  "Code used for access. Typically, a numeric or alphanumeric string."
1383
1391
  ),
1384
1392
  created_at: zod.z.string().datetime().describe("Date and time at which the access code was created."),
1385
- errors: zod.z.array(zod.z.union([access_code_error, device_error, connected_account_error])).describe(
1393
+ errors: zod.z.array(
1394
+ zod.z.discriminatedUnion("error_code", [
1395
+ ...access_code_error.options,
1396
+ ...device_error.options,
1397
+ ...connected_account_error.options
1398
+ ])
1399
+ ).describe(
1386
1400
  'Collection of errors associated with the access code, structured in a dictionary format. A unique "error_code" keys each error. Each error entry is an object containing two fields: "message" and "created_at." "message" is a string that describes the error. "created_at" is a date that indicates when the error was generated. This structure enables detailed tracking and timely response to critical issues.'
1387
1401
  ),
1388
1402
  warnings: zod.z.array(access_code_warning).describe(
@@ -1618,7 +1632,7 @@ var needs_to_be_reissued = common_acs_credential_warning.extend({
1618
1632
  }).describe(
1619
1633
  "Access permissions for this [credential](https://docs.seam.co/latest/capability-guides/access-systems/managing-credentials) have changed. [Reissue](https://docs.seam.co/latest/capability-guides/access-systems/working-with-card-encoders-and-scanners/creating-and-encoding-card-based-credentials) (re-encode) this credential. This issue may affect the proper functioning of the credential."
1620
1634
  );
1621
- var acs_credential_warning = zod.z.union([
1635
+ var acs_credential_warning = zod.z.discriminatedUnion("warning_code", [
1622
1636
  waiting_to_be_issued,
1623
1637
  schedule_externally_modified,
1624
1638
  schedule_modified,
@@ -1850,7 +1864,7 @@ var acs_system_disconnected = common_acs_system_error.extend({
1850
1864
  }).describe(
1851
1865
  "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."
1852
1866
  );
1853
- var account_disconnected3 = common_acs_system_error.extend({
1867
+ var account_disconnected2 = common_acs_system_error.extend({
1854
1868
  error_code: zod.z.literal("account_disconnected").describe(error_code_description5)
1855
1869
  }).describe(
1856
1870
  "Indicates that the login credentials are invalid. Reconnect the account using the Connect Webview to restore access."
@@ -1860,12 +1874,12 @@ var salto_ks_certification_expired = common_acs_system_error.extend({
1860
1874
  "Indicates that the access system has lost its Salto KS certification. Please contact support to regain access."
1861
1875
  )
1862
1876
  });
1863
- var acs_system_error = zod.z.union([
1877
+ var acs_system_error = zod.z.discriminatedUnion("error_code", [
1864
1878
  seam_bridge_disconnected,
1865
1879
  visionline_instance_unreachable,
1866
1880
  salto_ks_subscription_limit_exceeded,
1867
1881
  acs_system_disconnected,
1868
- account_disconnected3,
1882
+ account_disconnected2,
1869
1883
  salto_ks_certification_expired
1870
1884
  ]).describe("Error associated with the `acs_system`.");
1871
1885
  zod.z.object({
@@ -1873,7 +1887,7 @@ zod.z.object({
1873
1887
  visionline_instance_unreachable: visionline_instance_unreachable.optional().nullable(),
1874
1888
  salto_ks_subscription_limit_exceeded: salto_ks_subscription_limit_exceeded.optional().nullable(),
1875
1889
  acs_system_disconnected: acs_system_disconnected.optional().nullable(),
1876
- account_disconnected: account_disconnected3.optional().nullable(),
1890
+ account_disconnected: account_disconnected2.optional().nullable(),
1877
1891
  salto_ks_certification_expired: salto_ks_certification_expired.optional().nullable()
1878
1892
  });
1879
1893
  var common_acs_system_warning = zod.z.object({
@@ -1893,7 +1907,7 @@ var time_zone_does_not_match_location = common_acs_system_warning.extend({
1893
1907
  ),
1894
1908
  misconfigured_acs_entrance_ids: zod.z.array(zod.z.string().uuid()).optional()
1895
1909
  });
1896
- var acs_system_warning = zod.z.union([
1910
+ var acs_system_warning = zod.z.discriminatedUnion("warning_code", [
1897
1911
  salto_ks_subscription_limit_almost_reached,
1898
1912
  time_zone_does_not_match_location
1899
1913
  ]).describe("Warning associated with the `acs_system`.");
@@ -2023,7 +2037,7 @@ var acs_users_failed_to_delete_on_acs_system = common_acs_user_error.extend({
2023
2037
  }).describe(
2024
2038
  `Indicates that the user was not deleted on the ACS system. This is likely due to an internal unexpected error. Please contact Seam's support if you encounter this.`
2025
2039
  );
2026
- var acs_user_errors = zod.z.union([
2040
+ var acs_user_errors = zod.z.discriminatedUnion("error_code", [
2027
2041
  acs_users_deleted_externally,
2028
2042
  acs_users_salto_ks_subscription_limit_exceeded,
2029
2043
  acs_users_failed_to_create_on_acs_system,
@@ -2061,7 +2075,7 @@ zod.z.object({
2061
2075
  salto_ks_user_not_subscribed: acs_users_salto_ks_user_not_subscribed.optional().nullable(),
2062
2076
  unknown_issue_with_acs_user: unknown_issue_with_acs_user.optional().nullable()
2063
2077
  });
2064
- var acs_users_warnings = zod.z.union([
2078
+ var acs_users_warnings = zod.z.discriminatedUnion("warning_code", [
2065
2079
  acs_users_being_deleted,
2066
2080
  acs_users_salto_ks_user_not_subscribed,
2067
2081
  unknown_issue_with_acs_user
@@ -3610,730 +3624,564 @@ var openapi_default = {
3610
3624
  errors: {
3611
3625
  description: 'Collection of errors associated with the access code, structured in a dictionary format. A unique "error_code" keys each error. Each error entry is an object containing two fields: "message" and "created_at." "message" is a string that describes the error. "created_at" is a date that indicates when the error was generated. This structure enables detailed tracking and timely response to critical issues.',
3612
3626
  items: {
3627
+ discriminator: { propertyName: "error_code" },
3613
3628
  oneOf: [
3614
3629
  {
3615
- oneOf: [
3616
- {
3617
- description: "Failed to set code on Smart Things device.",
3618
- properties: {
3619
- error_code: {
3620
- description: "Unique identifier of the type of error. Enables quick recognition and categorization of the issue.",
3621
- enum: ["smartthings_failed_to_set_access_code"],
3622
- type: "string"
3623
- },
3624
- is_access_code_error: { enum: [true], type: "boolean" },
3625
- message: { type: "string" }
3626
- },
3627
- required: [
3628
- "message",
3629
- "is_access_code_error",
3630
- "error_code"
3631
- ],
3632
- type: "object"
3630
+ description: "Failed to set code on Smart Things device.",
3631
+ properties: {
3632
+ error_code: {
3633
+ description: "Unique identifier of the type of error. Enables quick recognition and categorization of the issue.",
3634
+ enum: ["smartthings_failed_to_set_access_code"],
3635
+ type: "string"
3633
3636
  },
3634
- {
3635
- description: "Failed to set code after multiple retries.",
3636
- properties: {
3637
- error_code: {
3638
- description: "Unique identifier of the type of error. Enables quick recognition and categorization of the issue.",
3639
- enum: [
3640
- "smartthings_failed_to_set_after_multiple_retries"
3641
- ],
3642
- type: "string"
3643
- },
3644
- is_access_code_error: { enum: [true], type: "boolean" },
3645
- message: { type: "string" }
3646
- },
3647
- required: [
3648
- "message",
3649
- "is_access_code_error",
3650
- "error_code"
3637
+ is_access_code_error: { enum: [true], type: "boolean" },
3638
+ message: { type: "string" }
3639
+ },
3640
+ required: ["message", "is_access_code_error", "error_code"],
3641
+ type: "object"
3642
+ },
3643
+ {
3644
+ description: "Failed to set code after multiple retries.",
3645
+ properties: {
3646
+ error_code: {
3647
+ description: "Unique identifier of the type of error. Enables quick recognition and categorization of the issue.",
3648
+ enum: [
3649
+ "smartthings_failed_to_set_after_multiple_retries"
3651
3650
  ],
3652
- type: "object"
3651
+ type: "string"
3653
3652
  },
3654
- {
3655
- description: "Failed to set code on device.",
3656
- properties: {
3657
- error_code: {
3658
- description: "Unique identifier of the type of error. Enables quick recognition and categorization of the issue.",
3659
- enum: ["failed_to_set_on_device"],
3660
- type: "string"
3661
- },
3662
- is_access_code_error: { enum: [true], type: "boolean" },
3663
- message: { type: "string" }
3664
- },
3665
- required: [
3666
- "message",
3667
- "is_access_code_error",
3668
- "error_code"
3669
- ],
3670
- type: "object"
3653
+ is_access_code_error: { enum: [true], type: "boolean" },
3654
+ message: { type: "string" }
3655
+ },
3656
+ required: ["message", "is_access_code_error", "error_code"],
3657
+ type: "object"
3658
+ },
3659
+ {
3660
+ description: "Failed to set code on device.",
3661
+ properties: {
3662
+ error_code: {
3663
+ description: "Unique identifier of the type of error. Enables quick recognition and categorization of the issue.",
3664
+ enum: ["failed_to_set_on_device"],
3665
+ type: "string"
3671
3666
  },
3672
- {
3673
- description: "Failed to remove code from device.",
3674
- properties: {
3675
- error_code: {
3676
- description: "Unique identifier of the type of error. Enables quick recognition and categorization of the issue.",
3677
- enum: ["failed_to_remove_from_device"],
3678
- type: "string"
3679
- },
3680
- is_access_code_error: { enum: [true], type: "boolean" },
3681
- message: { type: "string" }
3682
- },
3683
- required: [
3684
- "message",
3685
- "is_access_code_error",
3686
- "error_code"
3687
- ],
3688
- type: "object"
3667
+ is_access_code_error: { enum: [true], type: "boolean" },
3668
+ message: { type: "string" }
3669
+ },
3670
+ required: ["message", "is_access_code_error", "error_code"],
3671
+ type: "object"
3672
+ },
3673
+ {
3674
+ description: "Failed to remove code from device.",
3675
+ properties: {
3676
+ error_code: {
3677
+ description: "Unique identifier of the type of error. Enables quick recognition and categorization of the issue.",
3678
+ enum: ["failed_to_remove_from_device"],
3679
+ type: "string"
3689
3680
  },
3690
- {
3691
- description: "Duplicate access code detected on device.",
3692
- properties: {
3693
- error_code: {
3694
- description: "Unique identifier of the type of error. Enables quick recognition and categorization of the issue.",
3695
- enum: ["duplicate_code_on_device"],
3696
- type: "string"
3697
- },
3698
- is_access_code_error: { enum: [true], type: "boolean" },
3699
- message: { type: "string" }
3700
- },
3701
- required: [
3702
- "message",
3703
- "is_access_code_error",
3704
- "error_code"
3705
- ],
3706
- type: "object"
3681
+ is_access_code_error: { enum: [true], type: "boolean" },
3682
+ message: { type: "string" }
3683
+ },
3684
+ required: ["message", "is_access_code_error", "error_code"],
3685
+ type: "object"
3686
+ },
3687
+ {
3688
+ description: "Duplicate access code detected on device.",
3689
+ properties: {
3690
+ error_code: {
3691
+ description: "Unique identifier of the type of error. Enables quick recognition and categorization of the issue.",
3692
+ enum: ["duplicate_code_on_device"],
3693
+ type: "string"
3707
3694
  },
3708
- {
3709
- description: "An attempt to modify this access code was prevented.",
3710
- properties: {
3711
- error_code: {
3712
- description: "Unique identifier of the type of error. Enables quick recognition and categorization of the issue.",
3713
- enum: ["duplicate_code_attempt_prevented"],
3714
- type: "string"
3715
- },
3716
- is_access_code_error: { enum: [true], type: "boolean" },
3717
- message: { type: "string" }
3718
- },
3719
- required: [
3720
- "message",
3721
- "is_access_code_error",
3722
- "error_code"
3723
- ],
3724
- type: "object"
3695
+ is_access_code_error: { enum: [true], type: "boolean" },
3696
+ message: { type: "string" }
3697
+ },
3698
+ required: ["message", "is_access_code_error", "error_code"],
3699
+ type: "object"
3700
+ },
3701
+ {
3702
+ description: "An attempt to modify this access code was prevented.",
3703
+ properties: {
3704
+ error_code: {
3705
+ description: "Unique identifier of the type of error. Enables quick recognition and categorization of the issue.",
3706
+ enum: ["duplicate_code_attempt_prevented"],
3707
+ type: "string"
3725
3708
  },
3726
- {
3727
- description: "Igloohome bridge has too many pending jobs in the queue.",
3728
- properties: {
3729
- error_code: {
3730
- description: "Unique identifier of the type of error. Enables quick recognition and categorization of the issue.",
3731
- enum: ["igloohome_bridge_too_many_pending_jobs"],
3732
- type: "string"
3733
- },
3734
- is_access_code_error: { enum: [true], type: "boolean" },
3735
- message: { type: "string" }
3736
- },
3737
- required: [
3738
- "message",
3739
- "is_access_code_error",
3740
- "error_code"
3741
- ],
3742
- type: "object"
3709
+ is_access_code_error: { enum: [true], type: "boolean" },
3710
+ message: { type: "string" }
3711
+ },
3712
+ required: ["message", "is_access_code_error", "error_code"],
3713
+ type: "object"
3714
+ },
3715
+ {
3716
+ description: "Igloohome bridge has too many pending jobs in the queue.",
3717
+ properties: {
3718
+ error_code: {
3719
+ description: "Unique identifier of the type of error. Enables quick recognition and categorization of the issue.",
3720
+ enum: ["igloohome_bridge_too_many_pending_jobs"],
3721
+ type: "string"
3743
3722
  },
3744
- {
3745
- description: "Igloohome bridge is offline.",
3746
- properties: {
3747
- error_code: {
3748
- description: "Unique identifier of the type of error. Enables quick recognition and categorization of the issue.",
3749
- enum: ["igloohome_bridge_offline"],
3750
- type: "string"
3751
- },
3752
- is_access_code_error: { enum: [true], type: "boolean" },
3753
- message: { type: "string" }
3754
- },
3755
- required: [
3756
- "message",
3757
- "is_access_code_error",
3758
- "error_code"
3759
- ],
3760
- type: "object"
3723
+ is_access_code_error: { enum: [true], type: "boolean" },
3724
+ message: { type: "string" }
3725
+ },
3726
+ required: ["message", "is_access_code_error", "error_code"],
3727
+ type: "object"
3728
+ },
3729
+ {
3730
+ description: "Igloohome bridge is offline.",
3731
+ properties: {
3732
+ error_code: {
3733
+ description: "Unique identifier of the type of error. Enables quick recognition and categorization of the issue.",
3734
+ enum: ["igloohome_bridge_offline"],
3735
+ type: "string"
3761
3736
  },
3762
- {
3763
- description: "Lock as reached max amount of codes.",
3764
- properties: {
3765
- error_code: {
3766
- description: "Unique identifier of the type of error. Enables quick recognition and categorization of the issue.",
3767
- enum: [
3768
- "igloohome_offline_access_code_no_variance_available"
3769
- ],
3770
- type: "string"
3771
- },
3772
- is_access_code_error: { enum: [true], type: "boolean" },
3773
- message: { type: "string" }
3774
- },
3775
- required: [
3776
- "message",
3777
- "is_access_code_error",
3778
- "error_code"
3737
+ is_access_code_error: { enum: [true], type: "boolean" },
3738
+ message: { type: "string" }
3739
+ },
3740
+ required: ["message", "is_access_code_error", "error_code"],
3741
+ type: "object"
3742
+ },
3743
+ {
3744
+ description: "Lock as reached max amount of codes.",
3745
+ properties: {
3746
+ error_code: {
3747
+ description: "Unique identifier of the type of error. Enables quick recognition and categorization of the issue.",
3748
+ enum: [
3749
+ "igloohome_offline_access_code_no_variance_available"
3779
3750
  ],
3780
- type: "object"
3751
+ type: "string"
3781
3752
  },
3782
- {
3783
- description: "Unable to confirm the access code is set on Kwikset device.",
3784
- properties: {
3785
- error_code: {
3786
- description: "Unique identifier of the type of error. Enables quick recognition and categorization of the issue.",
3787
- enum: ["kwikset_unable_to_confirm_code"],
3788
- type: "string"
3789
- },
3790
- is_access_code_error: { enum: [true], type: "boolean" },
3791
- message: { type: "string" }
3792
- },
3793
- required: [
3794
- "message",
3795
- "is_access_code_error",
3796
- "error_code"
3797
- ],
3798
- type: "object"
3753
+ is_access_code_error: { enum: [true], type: "boolean" },
3754
+ message: { type: "string" }
3755
+ },
3756
+ required: ["message", "is_access_code_error", "error_code"],
3757
+ type: "object"
3758
+ },
3759
+ {
3760
+ description: "Unable to confirm the access code is set on Kwikset device.",
3761
+ properties: {
3762
+ error_code: {
3763
+ description: "Unique identifier of the type of error. Enables quick recognition and categorization of the issue.",
3764
+ enum: ["kwikset_unable_to_confirm_code"],
3765
+ type: "string"
3799
3766
  },
3800
- {
3801
- description: "Unable to confirm the deletion of the access code on Kwikset device.",
3802
- properties: {
3803
- error_code: {
3804
- description: "Unique identifier of the type of error. Enables quick recognition and categorization of the issue.",
3805
- enum: ["kwikset_unable_to_confirm_deletion"],
3806
- type: "string"
3807
- },
3808
- is_access_code_error: { enum: [true], type: "boolean" },
3809
- message: { type: "string" }
3810
- },
3811
- required: [
3812
- "message",
3813
- "is_access_code_error",
3814
- "error_code"
3815
- ],
3816
- type: "object"
3767
+ is_access_code_error: { enum: [true], type: "boolean" },
3768
+ message: { type: "string" }
3769
+ },
3770
+ required: ["message", "is_access_code_error", "error_code"],
3771
+ type: "object"
3772
+ },
3773
+ {
3774
+ description: "Unable to confirm the deletion of the access code on Kwikset device.",
3775
+ properties: {
3776
+ error_code: {
3777
+ description: "Unique identifier of the type of error. Enables quick recognition and categorization of the issue.",
3778
+ enum: ["kwikset_unable_to_confirm_deletion"],
3779
+ type: "string"
3817
3780
  },
3818
- {
3819
- description: "Code was modified or removed externally after Seam successfully set it on the device.",
3820
- properties: {
3821
- error_code: {
3822
- description: "Unique identifier of the type of error. Enables quick recognition and categorization of the issue.",
3823
- enum: ["code_modified_external_to_seam"],
3824
- type: "string"
3825
- },
3826
- is_access_code_error: { enum: [true], type: "boolean" },
3827
- message: { type: "string" }
3828
- },
3829
- required: [
3830
- "message",
3831
- "is_access_code_error",
3832
- "error_code"
3833
- ],
3834
- type: "object"
3781
+ is_access_code_error: { enum: [true], type: "boolean" },
3782
+ message: { type: "string" }
3783
+ },
3784
+ required: ["message", "is_access_code_error", "error_code"],
3785
+ type: "object"
3786
+ },
3787
+ {
3788
+ description: "Code was modified or removed externally after Seam successfully set it on the device.",
3789
+ properties: {
3790
+ error_code: {
3791
+ description: "Unique identifier of the type of error. Enables quick recognition and categorization of the issue.",
3792
+ enum: ["code_modified_external_to_seam"],
3793
+ type: "string"
3835
3794
  },
3836
- {
3837
- description: "Invalid code length for August lock.",
3838
- properties: {
3839
- error_code: {
3840
- description: "Unique identifier of the type of error. Enables quick recognition and categorization of the issue.",
3841
- enum: ["august_lock_invalid_code_length"],
3842
- type: "string"
3843
- },
3844
- is_access_code_error: { enum: [true], type: "boolean" },
3845
- message: { type: "string" }
3846
- },
3847
- required: [
3848
- "message",
3849
- "is_access_code_error",
3850
- "error_code"
3851
- ],
3852
- type: "object"
3795
+ is_access_code_error: { enum: [true], type: "boolean" },
3796
+ message: { type: "string" }
3797
+ },
3798
+ required: ["message", "is_access_code_error", "error_code"],
3799
+ type: "object"
3800
+ },
3801
+ {
3802
+ description: "Invalid code length for August lock.",
3803
+ properties: {
3804
+ error_code: {
3805
+ description: "Unique identifier of the type of error. Enables quick recognition and categorization of the issue.",
3806
+ enum: ["august_lock_invalid_code_length"],
3807
+ type: "string"
3853
3808
  },
3854
- {
3855
- description: "Access code has not yet been fully moved to the device.",
3856
- properties: {
3857
- error_code: {
3858
- description: "Unique identifier of the type of error. Enables quick recognition and categorization of the issue.",
3859
- enum: ["august_device_programming_delay"],
3860
- type: "string"
3861
- },
3862
- is_access_code_error: { enum: [true], type: "boolean" },
3863
- message: { type: "string" }
3864
- },
3865
- required: [
3866
- "message",
3867
- "is_access_code_error",
3868
- "error_code"
3869
- ],
3870
- type: "object"
3809
+ is_access_code_error: { enum: [true], type: "boolean" },
3810
+ message: { type: "string" }
3811
+ },
3812
+ required: ["message", "is_access_code_error", "error_code"],
3813
+ type: "object"
3814
+ },
3815
+ {
3816
+ description: "Access code has not yet been fully moved to the device.",
3817
+ properties: {
3818
+ error_code: {
3819
+ description: "Unique identifier of the type of error. Enables quick recognition and categorization of the issue.",
3820
+ enum: ["august_device_programming_delay"],
3821
+ type: "string"
3871
3822
  },
3872
- {
3873
- description: "All access code slots on the device are full.",
3874
- properties: {
3875
- error_code: {
3876
- description: "Unique identifier of the type of error. Enables quick recognition and categorization of the issue.",
3877
- enum: ["august_device_slots_full"],
3878
- type: "string"
3879
- },
3880
- is_access_code_error: { enum: [true], type: "boolean" },
3881
- message: { type: "string" }
3882
- },
3883
- required: [
3884
- "message",
3885
- "is_access_code_error",
3886
- "error_code"
3887
- ],
3888
- type: "object"
3823
+ is_access_code_error: { enum: [true], type: "boolean" },
3824
+ message: { type: "string" }
3825
+ },
3826
+ required: ["message", "is_access_code_error", "error_code"],
3827
+ type: "object"
3828
+ },
3829
+ {
3830
+ description: "All access code slots on the device are full.",
3831
+ properties: {
3832
+ error_code: {
3833
+ description: "Unique identifier of the type of error. Enables quick recognition and categorization of the issue.",
3834
+ enum: ["august_device_slots_full"],
3835
+ type: "string"
3889
3836
  },
3890
- {
3891
- description: "August lock is missing a keypad.",
3892
- properties: {
3893
- error_code: {
3894
- description: "Unique identifier of the type of error. Enables quick recognition and categorization of the issue.",
3895
- enum: ["august_lock_missing_keypad"],
3896
- type: "string"
3897
- },
3898
- is_access_code_error: { enum: [true], type: "boolean" },
3899
- message: { type: "string" }
3900
- },
3901
- required: [
3902
- "message",
3903
- "is_access_code_error",
3904
- "error_code"
3905
- ],
3906
- type: "object"
3907
- },
3908
- {
3909
- description: "Salto site user is not subscribed.",
3910
- properties: {
3911
- error_code: {
3912
- description: "Unique identifier of the type of error. Enables quick recognition and categorization of the issue.",
3913
- enum: ["salto_site_user_not_subscribed"],
3914
- type: "string"
3915
- },
3916
- is_access_code_error: { enum: [true], type: "boolean" },
3917
- message: { type: "string" }
3918
- },
3919
- required: [
3920
- "message",
3921
- "is_access_code_error",
3922
- "error_code"
3923
- ],
3924
- type: "object"
3925
- },
3926
- {
3927
- description: "Access code has not yet been fully moved to the device.",
3928
- properties: {
3929
- error_code: {
3930
- description: "Unique identifier of the type of error. Enables quick recognition and categorization of the issue.",
3931
- enum: ["hubitat_device_programming_delay"],
3932
- type: "string"
3933
- },
3934
- is_access_code_error: { enum: [true], type: "boolean" },
3935
- message: { type: "string" }
3936
- },
3937
- required: [
3938
- "message",
3939
- "is_access_code_error",
3940
- "error_code"
3941
- ],
3942
- type: "object"
3943
- },
3944
- {
3945
- description: "No free positions available on the device.",
3946
- properties: {
3947
- error_code: {
3948
- description: "Unique identifier of the type of error. Enables quick recognition and categorization of the issue.",
3949
- enum: ["hubitat_no_free_positions_available"],
3950
- type: "string"
3951
- },
3952
- is_access_code_error: { enum: [true], type: "boolean" },
3953
- message: { type: "string" }
3954
- },
3955
- required: [
3956
- "message",
3957
- "is_access_code_error",
3958
- "error_code"
3959
- ],
3960
- type: "object"
3961
- }
3962
- ]
3963
- },
3964
- {
3965
- description: "Error associated with the `device`.",
3966
- oneOf: [
3967
- {
3968
- description: "Device is offline",
3969
- properties: {
3970
- error_code: {
3971
- description: "Unique identifier of the type of error. Enables quick recognition and categorization of the issue.",
3972
- enum: ["device_offline"],
3973
- type: "string"
3974
- },
3975
- is_device_error: { enum: [true], type: "boolean" },
3976
- message: { type: "string" }
3977
- },
3978
- required: ["message", "is_device_error", "error_code"],
3979
- type: "object"
3980
- },
3981
- {
3982
- description: "Device has been removed",
3983
- properties: {
3984
- error_code: {
3985
- description: "Unique identifier of the type of error. Enables quick recognition and categorization of the issue.",
3986
- enum: ["device_removed"],
3987
- type: "string"
3988
- },
3989
- is_device_error: { enum: [true], type: "boolean" },
3990
- message: { type: "string" }
3991
- },
3992
- required: ["message", "is_device_error", "error_code"],
3993
- type: "object"
3994
- },
3995
- {
3996
- description: "Account is disconnected",
3997
- properties: {
3998
- error_code: {
3999
- description: "Unique identifier of the type of error. Enables quick recognition and categorization of the issue.",
4000
- enum: ["account_disconnected"],
4001
- type: "string"
4002
- },
4003
- is_device_error: { enum: [true], type: "boolean" },
4004
- message: { type: "string" }
4005
- },
4006
- required: ["message", "is_device_error", "error_code"],
4007
- type: "object"
4008
- },
4009
- {
4010
- description: "Hub is disconnected",
4011
- properties: {
4012
- error_code: {
4013
- description: "Unique identifier of the type of error. Enables quick recognition and categorization of the issue.",
4014
- enum: ["hub_disconnected"],
4015
- type: "string"
4016
- },
4017
- is_device_error: { enum: [true], type: "boolean" },
4018
- message: { type: "string" }
4019
- },
4020
- required: ["message", "is_device_error", "error_code"],
4021
- type: "object"
4022
- },
4023
- {
4024
- description: "Device is disconnected",
4025
- properties: {
4026
- error_code: {
4027
- description: "Unique identifier of the type of error. Enables quick recognition and categorization of the issue.",
4028
- enum: ["device_disconnected"],
4029
- type: "string"
4030
- },
4031
- is_device_error: { enum: [true], type: "boolean" },
4032
- message: { type: "string" }
4033
- },
4034
- required: ["message", "is_device_error", "error_code"],
4035
- type: "object"
4036
- },
4037
- {
4038
- description: "The backup access code pool is empty.",
4039
- properties: {
4040
- error_code: {
4041
- description: "Unique identifier of the type of error. Enables quick recognition and categorization of the issue.",
4042
- enum: ["empty_backup_access_code_pool"],
4043
- type: "string"
4044
- },
4045
- is_device_error: { enum: [true], type: "boolean" },
4046
- message: { type: "string" }
4047
- },
4048
- required: ["message", "is_device_error", "error_code"],
4049
- type: "object"
4050
- },
4051
- {
4052
- description: "User is not authorized to use the August Lock.",
4053
- properties: {
4054
- error_code: {
4055
- description: "Unique identifier of the type of error. Enables quick recognition and categorization of the issue.",
4056
- enum: ["august_lock_not_authorized"],
4057
- type: "string"
4058
- },
4059
- is_device_error: { enum: [true], type: "boolean" },
4060
- message: { type: "string" }
4061
- },
4062
- required: ["message", "is_device_error", "error_code"],
4063
- type: "object"
4064
- },
4065
- {
4066
- description: "Lock is not connected to the Seam Bridge.",
4067
- properties: {
4068
- error_code: {
4069
- description: "Unique identifier of the type of error. Enables quick recognition and categorization of the issue.",
4070
- enum: ["august_lock_missing_bridge"],
4071
- type: "string"
4072
- },
4073
- is_device_error: { enum: [true], type: "boolean" },
4074
- message: { type: "string" }
4075
- },
4076
- required: ["message", "is_device_error", "error_code"],
4077
- type: "object"
4078
- },
4079
- {
4080
- description: "Salto site user limit reached.",
4081
- properties: {
4082
- error_code: {
4083
- description: "Unique identifier of the type of error. Enables quick recognition and categorization of the issue.",
4084
- enum: ["salto_site_user_limit_reached"],
4085
- type: "string"
4086
- },
4087
- is_device_error: { enum: [true], type: "boolean" },
4088
- message: { type: "string" }
4089
- },
4090
- required: ["message", "is_device_error", "error_code"],
4091
- type: "object"
4092
- },
4093
- {
4094
- description: "Lock is not paired with a Gateway.",
4095
- properties: {
4096
- error_code: {
4097
- description: "Unique identifier of the type of error. Enables quick recognition and categorization of the issue.",
4098
- enum: ["ttlock_lock_not_paired_to_gateway"],
4099
- type: "string"
4100
- },
4101
- is_device_error: { enum: [true], type: "boolean" },
4102
- message: { type: "string" }
4103
- },
4104
- required: ["message", "is_device_error", "error_code"],
4105
- type: "object"
4106
- },
4107
- {
4108
- description: "Missing device credentials.",
4109
- properties: {
4110
- error_code: {
4111
- description: "Unique identifier of the type of error. Enables quick recognition and categorization of the issue.",
4112
- enum: ["missing_device_credentials"],
4113
- type: "string"
4114
- },
4115
- is_device_error: { enum: [true], type: "boolean" },
4116
- message: { type: "string" }
4117
- },
4118
- required: ["message", "is_device_error", "error_code"],
4119
- type: "object"
4120
- },
4121
- {
4122
- description: "The auxiliary heat is running.",
4123
- properties: {
4124
- error_code: {
4125
- description: "Unique identifier of the type of error. Enables quick recognition and categorization of the issue.",
4126
- enum: ["auxiliary_heat_running"],
4127
- type: "string"
4128
- },
4129
- is_device_error: { enum: [true], type: "boolean" },
4130
- message: { type: "string" }
4131
- },
4132
- required: ["message", "is_device_error", "error_code"],
4133
- type: "object"
4134
- },
4135
- {
4136
- description: "Subscription required to connect.",
4137
- properties: {
4138
- error_code: {
4139
- description: "Unique identifier of the type of error. Enables quick recognition and categorization of the issue.",
4140
- enum: ["subscription_required"],
4141
- type: "string"
4142
- },
4143
- is_device_error: { enum: [true], type: "boolean" },
4144
- message: { type: "string" }
4145
- },
4146
- required: ["message", "is_device_error", "error_code"],
4147
- type: "object"
4148
- }
4149
- ]
3837
+ is_access_code_error: { enum: [true], type: "boolean" },
3838
+ message: { type: "string" }
3839
+ },
3840
+ required: ["message", "is_access_code_error", "error_code"],
3841
+ type: "object"
4150
3842
  },
4151
3843
  {
4152
- oneOf: [
4153
- {
4154
- description: "Account is disconnected.",
4155
- properties: {
4156
- error_code: {
4157
- description: "Unique identifier of the type of warning. Enables quick recognition and categorization of the issue.",
4158
- enum: ["account_disconnected"],
4159
- type: "string"
4160
- },
4161
- is_connected_account_error: {
4162
- enum: [true],
4163
- type: "boolean"
4164
- },
4165
- message: { type: "string" }
4166
- },
4167
- required: [
4168
- "message",
4169
- "is_connected_account_error",
4170
- "error_code"
4171
- ],
4172
- type: "object"
4173
- },
4174
- {
4175
- description: "Credentials provided were invalid.",
4176
- properties: {
4177
- error_code: {
4178
- description: "Unique identifier of the type of warning. Enables quick recognition and categorization of the issue.",
4179
- enum: ["invalid_credentials"],
4180
- type: "string"
4181
- },
4182
- is_connected_account_error: {
4183
- enum: [true],
4184
- type: "boolean"
4185
- },
4186
- message: { type: "string" }
4187
- },
4188
- required: [
4189
- "message",
4190
- "is_connected_account_error",
4191
- "error_code"
4192
- ],
4193
- type: "object"
4194
- }
4195
- ]
4196
- }
4197
- ]
4198
- },
4199
- type: "array"
4200
- },
4201
- is_backup: {
4202
- description: "Indicates whether the access code is a backup code.",
4203
- type: "boolean"
4204
- },
4205
- is_backup_access_code_available: {
4206
- description: "Indicates whether a backup access code is available for use if the primary access code is lost or compromised.",
4207
- type: "boolean"
4208
- },
4209
- is_external_modification_allowed: {
4210
- description: "Indicates whether changes to the access code from external sources are permitted.",
4211
- type: "boolean"
4212
- },
4213
- is_managed: {
4214
- description: "Indicates whether Seam manages the access code.",
4215
- enum: [true],
4216
- type: "boolean"
4217
- },
4218
- is_offline_access_code: {
4219
- description: 'Indicates whether the access code is intended for use in offline scenarios. If "true," this code can be created on a device without a network connection.',
4220
- type: "boolean"
4221
- },
4222
- is_one_time_use: {
4223
- description: 'Indicates whether the access code can only be used once. If "true," the code becomes invalid after the first use.',
4224
- type: "boolean"
4225
- },
4226
- is_scheduled_on_device: {
4227
- description: "Indicates whether the code is set on the device according to a preconfigured schedule.",
4228
- type: "boolean"
4229
- },
4230
- is_waiting_for_code_assignment: {
4231
- description: "Indicates whether the access code is waiting for a code assignment.",
4232
- type: "boolean"
4233
- },
4234
- name: {
4235
- description: "Name of the access code. Enables administrators and users to identify the access code easily, especially when there are numerous access codes.",
4236
- nullable: true,
4237
- type: "string"
4238
- },
4239
- pulled_backup_access_code_id: {
4240
- description: "Identifier of the pulled backup access code. Used to associate the pulled backup access code with the original access code.",
4241
- format: "uuid",
4242
- nullable: true,
4243
- type: "string"
4244
- },
4245
- starts_at: {
4246
- description: "Date and time at which the time-bound access code becomes active.",
4247
- format: "date-time",
4248
- nullable: true,
4249
- type: "string"
4250
- },
4251
- status: {
4252
- description: '\n Current status of the access code within the operational lifecycle. Values are "setting," a transitional phase that indicates that the code is being configured or activated; "set", which indicates that the code is active and operational; "unset," which indicates a deactivated or unused state, either before activation or after deliberate deactivation; "removing," which indicates a transitional period in which the code is being deleted or made inactive; and "unknown," which indicates an indeterminate state, due to reasons such as system errors or incomplete data, that highlights a potential need for system review or troubleshooting.\n ',
4253
- enum: ["setting", "set", "unset", "removing", "unknown"],
4254
- type: "string"
4255
- },
4256
- type: {
4257
- description: 'Nature of the access code. Values are "ongoing" for access codes that are active continuously until deactivated manually or "time_bound" for access codes that have a specific duration.',
4258
- enum: ["time_bound", "ongoing"],
4259
- type: "string"
4260
- },
4261
- warnings: {
4262
- description: 'Collection of warnings associated with the access code, structured in a dictionary format. A unique "warning_code" keys each warning. Each warning entry is an object containing two fields: "message" and "created_at." "message" is a string that describes the warning. "created_at" is a date that indicates when the warning was generated. This structure enables detailed tracking and timely response to potential issues that are not critical but that may require attention.',
4263
- items: {
4264
- oneOf: [
4265
- {
4266
- description: "Failed to set code on Smart Things device.",
3844
+ description: "August lock is missing a keypad.",
4267
3845
  properties: {
4268
- message: { type: "string" },
4269
- warning_code: {
4270
- description: "Unique identifier of the type of warning. Enables quick recognition and categorization of the issue.",
4271
- enum: ["smartthings_failed_to_set_access_code"],
3846
+ error_code: {
3847
+ description: "Unique identifier of the type of error. Enables quick recognition and categorization of the issue.",
3848
+ enum: ["august_lock_missing_keypad"],
4272
3849
  type: "string"
4273
- }
3850
+ },
3851
+ is_access_code_error: { enum: [true], type: "boolean" },
3852
+ message: { type: "string" }
4274
3853
  },
4275
- required: ["message", "warning_code"],
3854
+ required: ["message", "is_access_code_error", "error_code"],
4276
3855
  type: "object"
4277
3856
  },
4278
3857
  {
4279
- description: "Duplicate access code detected.",
3858
+ description: "Salto site user is not subscribed.",
4280
3859
  properties: {
4281
- message: { type: "string" },
4282
- warning_code: {
4283
- description: "Unique identifier of the type of warning. Enables quick recognition and categorization of the issue.",
4284
- enum: ["schlage_detected_duplicate"],
3860
+ error_code: {
3861
+ description: "Unique identifier of the type of error. Enables quick recognition and categorization of the issue.",
3862
+ enum: ["salto_site_user_not_subscribed"],
4285
3863
  type: "string"
4286
- }
3864
+ },
3865
+ is_access_code_error: { enum: [true], type: "boolean" },
3866
+ message: { type: "string" }
4287
3867
  },
4288
- required: ["message", "warning_code"],
3868
+ required: ["message", "is_access_code_error", "error_code"],
4289
3869
  type: "object"
4290
3870
  },
4291
3871
  {
4292
- description: "Received an error when attempting to create this code.",
3872
+ description: "Access code has not yet been fully moved to the device.",
4293
3873
  properties: {
4294
- message: { type: "string" },
4295
- warning_code: {
4296
- description: "Unique identifier of the type of warning. Enables quick recognition and categorization of the issue.",
4297
- enum: ["schlage_creation_outage"],
3874
+ error_code: {
3875
+ description: "Unique identifier of the type of error. Enables quick recognition and categorization of the issue.",
3876
+ enum: ["hubitat_device_programming_delay"],
4298
3877
  type: "string"
4299
- }
3878
+ },
3879
+ is_access_code_error: { enum: [true], type: "boolean" },
3880
+ message: { type: "string" }
4300
3881
  },
4301
- required: ["message", "warning_code"],
3882
+ required: ["message", "is_access_code_error", "error_code"],
4302
3883
  type: "object"
4303
3884
  },
4304
3885
  {
4305
- description: "Code was modified or removed externally after Seam successfully set it on the device.",
3886
+ description: "No free positions available on the device.",
4306
3887
  properties: {
4307
- message: { type: "string" },
4308
- warning_code: {
4309
- description: "Unique identifier of the type of warning. Enables quick recognition and categorization of the issue.",
4310
- enum: ["code_modified_external_to_seam"],
3888
+ error_code: {
3889
+ description: "Unique identifier of the type of error. Enables quick recognition and categorization of the issue.",
3890
+ enum: ["hubitat_no_free_positions_available"],
4311
3891
  type: "string"
4312
- }
3892
+ },
3893
+ is_access_code_error: { enum: [true], type: "boolean" },
3894
+ message: { type: "string" }
4313
3895
  },
4314
- required: ["message", "warning_code"],
3896
+ required: ["message", "is_access_code_error", "error_code"],
4315
3897
  type: "object"
4316
3898
  },
4317
3899
  {
4318
- description: "Delay in setting code on device.",
3900
+ description: "Device is offline",
4319
3901
  properties: {
4320
- message: { type: "string" },
4321
- warning_code: {
4322
- description: "Unique identifier of the type of warning. Enables quick recognition and categorization of the issue.",
4323
- enum: ["delay_in_setting_on_device"],
3902
+ error_code: {
3903
+ description: "Unique identifier of the type of error. Enables quick recognition and categorization of the issue.",
3904
+ enum: ["device_offline"],
4324
3905
  type: "string"
4325
- }
3906
+ },
3907
+ is_device_error: { enum: [true], type: "boolean" },
3908
+ message: { type: "string" }
4326
3909
  },
4327
- required: ["message", "warning_code"],
3910
+ required: ["message", "is_device_error", "error_code"],
4328
3911
  type: "object"
4329
3912
  },
4330
3913
  {
4331
- description: "Delay in removing code from device.",
3914
+ description: "Device has been removed",
3915
+ properties: {
3916
+ error_code: {
3917
+ description: "Unique identifier of the type of error. Enables quick recognition and categorization of the issue.",
3918
+ enum: ["device_removed"],
3919
+ type: "string"
3920
+ },
3921
+ is_device_error: { enum: [true], type: "boolean" },
3922
+ message: { type: "string" }
3923
+ },
3924
+ required: ["message", "is_device_error", "error_code"],
3925
+ type: "object"
3926
+ },
3927
+ {
3928
+ description: "Hub is disconnected",
3929
+ properties: {
3930
+ error_code: {
3931
+ description: "Unique identifier of the type of error. Enables quick recognition and categorization of the issue.",
3932
+ enum: ["hub_disconnected"],
3933
+ type: "string"
3934
+ },
3935
+ is_device_error: { enum: [true], type: "boolean" },
3936
+ message: { type: "string" }
3937
+ },
3938
+ required: ["message", "is_device_error", "error_code"],
3939
+ type: "object"
3940
+ },
3941
+ {
3942
+ description: "Device is disconnected",
3943
+ properties: {
3944
+ error_code: {
3945
+ description: "Unique identifier of the type of error. Enables quick recognition and categorization of the issue.",
3946
+ enum: ["device_disconnected"],
3947
+ type: "string"
3948
+ },
3949
+ is_device_error: { enum: [true], type: "boolean" },
3950
+ message: { type: "string" }
3951
+ },
3952
+ required: ["message", "is_device_error", "error_code"],
3953
+ type: "object"
3954
+ },
3955
+ {
3956
+ description: "The backup access code pool is empty.",
3957
+ properties: {
3958
+ error_code: {
3959
+ description: "Unique identifier of the type of error. Enables quick recognition and categorization of the issue.",
3960
+ enum: ["empty_backup_access_code_pool"],
3961
+ type: "string"
3962
+ },
3963
+ is_device_error: { enum: [true], type: "boolean" },
3964
+ message: { type: "string" }
3965
+ },
3966
+ required: ["message", "is_device_error", "error_code"],
3967
+ type: "object"
3968
+ },
3969
+ {
3970
+ description: "User is not authorized to use the August Lock.",
3971
+ properties: {
3972
+ error_code: {
3973
+ description: "Unique identifier of the type of error. Enables quick recognition and categorization of the issue.",
3974
+ enum: ["august_lock_not_authorized"],
3975
+ type: "string"
3976
+ },
3977
+ is_device_error: { enum: [true], type: "boolean" },
3978
+ message: { type: "string" }
3979
+ },
3980
+ required: ["message", "is_device_error", "error_code"],
3981
+ type: "object"
3982
+ },
3983
+ {
3984
+ description: "Lock is not connected to the Seam Bridge.",
3985
+ properties: {
3986
+ error_code: {
3987
+ description: "Unique identifier of the type of error. Enables quick recognition and categorization of the issue.",
3988
+ enum: ["august_lock_missing_bridge"],
3989
+ type: "string"
3990
+ },
3991
+ is_device_error: { enum: [true], type: "boolean" },
3992
+ message: { type: "string" }
3993
+ },
3994
+ required: ["message", "is_device_error", "error_code"],
3995
+ type: "object"
3996
+ },
3997
+ {
3998
+ description: "Salto site user limit reached.",
3999
+ properties: {
4000
+ error_code: {
4001
+ description: "Unique identifier of the type of error. Enables quick recognition and categorization of the issue.",
4002
+ enum: ["salto_site_user_limit_reached"],
4003
+ type: "string"
4004
+ },
4005
+ is_device_error: { enum: [true], type: "boolean" },
4006
+ message: { type: "string" }
4007
+ },
4008
+ required: ["message", "is_device_error", "error_code"],
4009
+ type: "object"
4010
+ },
4011
+ {
4012
+ description: "Lock is not paired with a Gateway.",
4013
+ properties: {
4014
+ error_code: {
4015
+ description: "Unique identifier of the type of error. Enables quick recognition and categorization of the issue.",
4016
+ enum: ["ttlock_lock_not_paired_to_gateway"],
4017
+ type: "string"
4018
+ },
4019
+ is_device_error: { enum: [true], type: "boolean" },
4020
+ message: { type: "string" }
4021
+ },
4022
+ required: ["message", "is_device_error", "error_code"],
4023
+ type: "object"
4024
+ },
4025
+ {
4026
+ description: "Missing device credentials.",
4027
+ properties: {
4028
+ error_code: {
4029
+ description: "Unique identifier of the type of error. Enables quick recognition and categorization of the issue.",
4030
+ enum: ["missing_device_credentials"],
4031
+ type: "string"
4032
+ },
4033
+ is_device_error: { enum: [true], type: "boolean" },
4034
+ message: { type: "string" }
4035
+ },
4036
+ required: ["message", "is_device_error", "error_code"],
4037
+ type: "object"
4038
+ },
4039
+ {
4040
+ description: "The auxiliary heat is running.",
4041
+ properties: {
4042
+ error_code: {
4043
+ description: "Unique identifier of the type of error. Enables quick recognition and categorization of the issue.",
4044
+ enum: ["auxiliary_heat_running"],
4045
+ type: "string"
4046
+ },
4047
+ is_device_error: { enum: [true], type: "boolean" },
4048
+ message: { type: "string" }
4049
+ },
4050
+ required: ["message", "is_device_error", "error_code"],
4051
+ type: "object"
4052
+ },
4053
+ {
4054
+ description: "Subscription required to connect.",
4055
+ properties: {
4056
+ error_code: {
4057
+ description: "Unique identifier of the type of error. Enables quick recognition and categorization of the issue.",
4058
+ enum: ["subscription_required"],
4059
+ type: "string"
4060
+ },
4061
+ is_device_error: { enum: [true], type: "boolean" },
4062
+ message: { type: "string" }
4063
+ },
4064
+ required: ["message", "is_device_error", "error_code"],
4065
+ type: "object"
4066
+ },
4067
+ {
4068
+ description: "Account is disconnected.",
4069
+ properties: {
4070
+ error_code: {
4071
+ description: "Unique identifier of the type of error. Enables quick recognition and categorization of the issue.",
4072
+ enum: ["account_disconnected"],
4073
+ type: "string"
4074
+ },
4075
+ is_connected_account_error: {
4076
+ enum: [true],
4077
+ type: "boolean"
4078
+ },
4079
+ message: { type: "string" }
4080
+ },
4081
+ required: [
4082
+ "message",
4083
+ "is_connected_account_error",
4084
+ "error_code"
4085
+ ],
4086
+ type: "object"
4087
+ },
4088
+ {
4089
+ description: "Credentials provided were invalid.",
4090
+ properties: {
4091
+ error_code: {
4092
+ description: "Unique identifier of the type of error. Enables quick recognition and categorization of the issue.",
4093
+ enum: ["invalid_credentials"],
4094
+ type: "string"
4095
+ },
4096
+ is_connected_account_error: {
4097
+ enum: [true],
4098
+ type: "boolean"
4099
+ },
4100
+ message: { type: "string" }
4101
+ },
4102
+ required: [
4103
+ "message",
4104
+ "is_connected_account_error",
4105
+ "error_code"
4106
+ ],
4107
+ type: "object"
4108
+ }
4109
+ ]
4110
+ },
4111
+ type: "array"
4112
+ },
4113
+ is_backup: {
4114
+ description: "Indicates whether the access code is a backup code.",
4115
+ type: "boolean"
4116
+ },
4117
+ is_backup_access_code_available: {
4118
+ description: "Indicates whether a backup access code is available for use if the primary access code is lost or compromised.",
4119
+ type: "boolean"
4120
+ },
4121
+ is_external_modification_allowed: {
4122
+ description: "Indicates whether changes to the access code from external sources are permitted.",
4123
+ type: "boolean"
4124
+ },
4125
+ is_managed: {
4126
+ description: "Indicates whether Seam manages the access code.",
4127
+ enum: [true],
4128
+ type: "boolean"
4129
+ },
4130
+ is_offline_access_code: {
4131
+ description: 'Indicates whether the access code is intended for use in offline scenarios. If "true," this code can be created on a device without a network connection.',
4132
+ type: "boolean"
4133
+ },
4134
+ is_one_time_use: {
4135
+ description: 'Indicates whether the access code can only be used once. If "true," the code becomes invalid after the first use.',
4136
+ type: "boolean"
4137
+ },
4138
+ is_scheduled_on_device: {
4139
+ description: "Indicates whether the code is set on the device according to a preconfigured schedule.",
4140
+ type: "boolean"
4141
+ },
4142
+ is_waiting_for_code_assignment: {
4143
+ description: "Indicates whether the access code is waiting for a code assignment.",
4144
+ type: "boolean"
4145
+ },
4146
+ name: {
4147
+ description: "Name of the access code. Enables administrators and users to identify the access code easily, especially when there are numerous access codes.",
4148
+ nullable: true,
4149
+ type: "string"
4150
+ },
4151
+ pulled_backup_access_code_id: {
4152
+ description: "Identifier of the pulled backup access code. Used to associate the pulled backup access code with the original access code.",
4153
+ format: "uuid",
4154
+ nullable: true,
4155
+ type: "string"
4156
+ },
4157
+ starts_at: {
4158
+ description: "Date and time at which the time-bound access code becomes active.",
4159
+ format: "date-time",
4160
+ nullable: true,
4161
+ type: "string"
4162
+ },
4163
+ status: {
4164
+ description: '\n Current status of the access code within the operational lifecycle. Values are "setting," a transitional phase that indicates that the code is being configured or activated; "set", which indicates that the code is active and operational; "unset," which indicates a deactivated or unused state, either before activation or after deliberate deactivation; "removing," which indicates a transitional period in which the code is being deleted or made inactive; and "unknown," which indicates an indeterminate state, due to reasons such as system errors or incomplete data, that highlights a potential need for system review or troubleshooting.\n ',
4165
+ enum: ["setting", "set", "unset", "removing", "unknown"],
4166
+ type: "string"
4167
+ },
4168
+ type: {
4169
+ description: 'Nature of the access code. Values are "ongoing" for access codes that are active continuously until deactivated manually or "time_bound" for access codes that have a specific duration.',
4170
+ enum: ["time_bound", "ongoing"],
4171
+ type: "string"
4172
+ },
4173
+ warnings: {
4174
+ description: 'Collection of warnings associated with the access code, structured in a dictionary format. A unique "warning_code" keys each warning. Each warning entry is an object containing two fields: "message" and "created_at." "message" is a string that describes the warning. "created_at" is a date that indicates when the warning was generated. This structure enables detailed tracking and timely response to potential issues that are not critical but that may require attention.',
4175
+ items: {
4176
+ discriminator: { propertyName: "warning_code" },
4177
+ oneOf: [
4178
+ {
4179
+ description: "Failed to set code on Smart Things device.",
4332
4180
  properties: {
4333
4181
  message: { type: "string" },
4334
4182
  warning_code: {
4335
4183
  description: "Unique identifier of the type of warning. Enables quick recognition and categorization of the issue.",
4336
- enum: ["delay_in_removing_from_device"],
4184
+ enum: ["smartthings_failed_to_set_access_code"],
4337
4185
  type: "string"
4338
4186
  }
4339
4187
  },
@@ -4341,12 +4189,12 @@ var openapi_default = {
4341
4189
  type: "object"
4342
4190
  },
4343
4191
  {
4344
- description: "Third party integration detected that may cause access codes to fail.",
4192
+ description: "Duplicate access code detected.",
4345
4193
  properties: {
4346
4194
  message: { type: "string" },
4347
4195
  warning_code: {
4348
4196
  description: "Unique identifier of the type of warning. Enables quick recognition and categorization of the issue.",
4349
- enum: ["third_party_integration_detected"],
4197
+ enum: ["schlage_detected_duplicate"],
4350
4198
  type: "string"
4351
4199
  }
4352
4200
  },
@@ -4354,12 +4202,12 @@ var openapi_default = {
4354
4202
  type: "object"
4355
4203
  },
4356
4204
  {
4357
- description: "Access code has not yet been fully moved to the device.",
4205
+ description: "Received an error when attempting to create this code.",
4358
4206
  properties: {
4359
4207
  message: { type: "string" },
4360
4208
  warning_code: {
4361
4209
  description: "Unique identifier of the type of warning. Enables quick recognition and categorization of the issue.",
4362
- enum: ["august_device_programming_delay"],
4210
+ enum: ["schlage_creation_outage"],
4363
4211
  type: "string"
4364
4212
  }
4365
4213
  },
@@ -4367,12 +4215,12 @@ var openapi_default = {
4367
4215
  type: "object"
4368
4216
  },
4369
4217
  {
4370
- description: "Algopins must be used within 24 hours.",
4218
+ description: "Lock is in Office Mode. Access Codes will not unlock doors.",
4371
4219
  properties: {
4372
4220
  message: { type: "string" },
4373
4221
  warning_code: {
4374
4222
  description: "Unique identifier of the type of warning. Enables quick recognition and categorization of the issue.",
4375
- enum: ["igloo_algopin_must_be_used_within_24_hours"],
4223
+ enum: ["salto_office_mode"],
4376
4224
  type: "string"
4377
4225
  }
4378
4226
  },
@@ -4380,34 +4228,112 @@ var openapi_default = {
4380
4228
  type: "object"
4381
4229
  },
4382
4230
  {
4383
- description: "Management was transferred to another workspace.",
4231
+ description: "Code was modified or removed externally after Seam successfully set it on the device.",
4384
4232
  properties: {
4385
4233
  message: { type: "string" },
4386
4234
  warning_code: {
4387
4235
  description: "Unique identifier of the type of warning. Enables quick recognition and categorization of the issue.",
4388
- enum: ["management_transferred"],
4236
+ enum: ["code_modified_external_to_seam"],
4389
4237
  type: "string"
4390
4238
  }
4391
4239
  },
4392
4240
  required: ["message", "warning_code"],
4393
4241
  type: "object"
4394
- }
4395
- ]
4396
- },
4397
- type: "array"
4398
- }
4399
- },
4400
- required: [
4401
- "common_code_key",
4402
- "type",
4403
- "access_code_id",
4404
- "device_id",
4405
- "name",
4406
- "code",
4407
- "created_at",
4408
- "errors",
4409
- "warnings",
4410
- "is_managed",
4242
+ },
4243
+ {
4244
+ description: "Delay in setting code on device.",
4245
+ properties: {
4246
+ message: { type: "string" },
4247
+ warning_code: {
4248
+ description: "Unique identifier of the type of warning. Enables quick recognition and categorization of the issue.",
4249
+ enum: ["delay_in_setting_on_device"],
4250
+ type: "string"
4251
+ }
4252
+ },
4253
+ required: ["message", "warning_code"],
4254
+ type: "object"
4255
+ },
4256
+ {
4257
+ description: "Delay in removing code from device.",
4258
+ properties: {
4259
+ message: { type: "string" },
4260
+ warning_code: {
4261
+ description: "Unique identifier of the type of warning. Enables quick recognition and categorization of the issue.",
4262
+ enum: ["delay_in_removing_from_device"],
4263
+ type: "string"
4264
+ }
4265
+ },
4266
+ required: ["message", "warning_code"],
4267
+ type: "object"
4268
+ },
4269
+ {
4270
+ description: "Third party integration detected that may cause access codes to fail.",
4271
+ properties: {
4272
+ message: { type: "string" },
4273
+ warning_code: {
4274
+ description: "Unique identifier of the type of warning. Enables quick recognition and categorization of the issue.",
4275
+ enum: ["third_party_integration_detected"],
4276
+ type: "string"
4277
+ }
4278
+ },
4279
+ required: ["message", "warning_code"],
4280
+ type: "object"
4281
+ },
4282
+ {
4283
+ description: "Access code has not yet been fully moved to the device.",
4284
+ properties: {
4285
+ message: { type: "string" },
4286
+ warning_code: {
4287
+ description: "Unique identifier of the type of warning. Enables quick recognition and categorization of the issue.",
4288
+ enum: ["august_device_programming_delay"],
4289
+ type: "string"
4290
+ }
4291
+ },
4292
+ required: ["message", "warning_code"],
4293
+ type: "object"
4294
+ },
4295
+ {
4296
+ description: "Algopins must be used within 24 hours.",
4297
+ properties: {
4298
+ message: { type: "string" },
4299
+ warning_code: {
4300
+ description: "Unique identifier of the type of warning. Enables quick recognition and categorization of the issue.",
4301
+ enum: ["igloo_algopin_must_be_used_within_24_hours"],
4302
+ type: "string"
4303
+ }
4304
+ },
4305
+ required: ["message", "warning_code"],
4306
+ type: "object"
4307
+ },
4308
+ {
4309
+ description: "Management was transferred to another workspace.",
4310
+ properties: {
4311
+ message: { type: "string" },
4312
+ warning_code: {
4313
+ description: "Unique identifier of the type of warning. Enables quick recognition and categorization of the issue.",
4314
+ enum: ["management_transferred"],
4315
+ type: "string"
4316
+ }
4317
+ },
4318
+ required: ["message", "warning_code"],
4319
+ type: "object"
4320
+ }
4321
+ ]
4322
+ },
4323
+ type: "array"
4324
+ }
4325
+ },
4326
+ required: [
4327
+ "common_code_key",
4328
+ "type",
4329
+ "access_code_id",
4330
+ "device_id",
4331
+ "name",
4332
+ "code",
4333
+ "created_at",
4334
+ "errors",
4335
+ "warnings",
4336
+ "is_managed",
4411
4337
  "status",
4412
4338
  "is_backup_access_code_available",
4413
4339
  "is_external_modification_allowed",
@@ -4666,6 +4592,7 @@ var openapi_default = {
4666
4592
  description: "Warnings associated with the `acs_credential`.",
4667
4593
  items: {
4668
4594
  description: "Warning associated with the `acs_credential`.",
4595
+ discriminator: { propertyName: "warning_code" },
4669
4596
  oneOf: [
4670
4597
  {
4671
4598
  description: "Indicates that the credential is waiting to be issued.",
@@ -5115,6 +5042,7 @@ var openapi_default = {
5115
5042
  description: "Errors associated with the `acs_system`.",
5116
5043
  items: {
5117
5044
  description: "Error associated with the `acs_system`.",
5045
+ discriminator: { propertyName: "error_code" },
5118
5046
  oneOf: [
5119
5047
  {
5120
5048
  description: "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.\n This error might also occur if the Seam Bridge is connected to the wrong [workspace](https://docs.seam.co/latest/core-concepts/workspaces).\n 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).",
@@ -5339,6 +5267,7 @@ var openapi_default = {
5339
5267
  description: "Warnings associated with the `acs_system`.",
5340
5268
  items: {
5341
5269
  description: "Warning associated with the `acs_system`.",
5270
+ discriminator: { propertyName: "warning_code" },
5342
5271
  oneOf: [
5343
5272
  {
5344
5273
  properties: {
@@ -5466,6 +5395,7 @@ var openapi_default = {
5466
5395
  description: "Errors associated with the `acs_user`.",
5467
5396
  items: {
5468
5397
  description: "Error associated with the `acs_user`.",
5398
+ discriminator: { propertyName: "error_code" },
5469
5399
  oneOf: [
5470
5400
  {
5471
5401
  description: "Indicates that the ACS user was deleted from the ACS system outside of Seam.",
@@ -5636,6 +5566,7 @@ var openapi_default = {
5636
5566
  description: "Warnings associated with the `acs_user`.",
5637
5567
  items: {
5638
5568
  description: "Warning associated with the `acs_user`.",
5569
+ discriminator: { propertyName: "warning_code" },
5639
5570
  oneOf: [
5640
5571
  {
5641
5572
  description: "Indicates that the user is being deleted from the ACS system. This is a temporary state, and the user will be deleted shortly.",
@@ -6127,6 +6058,7 @@ var openapi_default = {
6127
6058
  description: "Warnings associated with the `acs_credential`.",
6128
6059
  items: {
6129
6060
  description: "Warning associated with the `acs_credential`.",
6061
+ discriminator: { propertyName: "warning_code" },
6130
6062
  oneOf: [
6131
6063
  {
6132
6064
  description: "Indicates that the credential is waiting to be issued.",
@@ -6463,6 +6395,7 @@ var openapi_default = {
6463
6395
  description: "Warnings associated with the `acs_credential`.",
6464
6396
  items: {
6465
6397
  description: "Warning associated with the `acs_credential`.",
6398
+ discriminator: { propertyName: "warning_code" },
6466
6399
  oneOf: [
6467
6400
  {
6468
6401
  description: "Indicates that the credential is waiting to be issued.",
@@ -6931,6 +6864,7 @@ var openapi_default = {
6931
6864
  description: "Warnings associated with the `acs_credential`.",
6932
6865
  items: {
6933
6866
  description: "Warning associated with the `acs_credential`.",
6867
+ discriminator: { propertyName: "warning_code" },
6934
6868
  oneOf: [
6935
6869
  {
6936
6870
  description: "Indicates that the credential is waiting to be issued.",
@@ -7265,6 +7199,7 @@ var openapi_default = {
7265
7199
  description: "Warnings associated with the `acs_credential`.",
7266
7200
  items: {
7267
7201
  description: "Warning associated with the `acs_credential`.",
7202
+ discriminator: { propertyName: "warning_code" },
7268
7203
  oneOf: [
7269
7204
  {
7270
7205
  description: "Indicates that the credential is waiting to be issued.",
@@ -8499,12 +8434,13 @@ var openapi_default = {
8499
8434
  },
8500
8435
  errors: {
8501
8436
  items: {
8437
+ discriminator: { propertyName: "error_code" },
8502
8438
  oneOf: [
8503
8439
  {
8504
8440
  description: "Account is disconnected.",
8505
8441
  properties: {
8506
8442
  error_code: {
8507
- description: "Unique identifier of the type of warning. Enables quick recognition and categorization of the issue.",
8443
+ description: "Unique identifier of the type of error. Enables quick recognition and categorization of the issue.",
8508
8444
  enum: ["account_disconnected"],
8509
8445
  type: "string"
8510
8446
  },
@@ -8525,7 +8461,7 @@ var openapi_default = {
8525
8461
  description: "Credentials provided were invalid.",
8526
8462
  properties: {
8527
8463
  error_code: {
8528
- description: "Unique identifier of the type of warning. Enables quick recognition and categorization of the issue.",
8464
+ description: "Unique identifier of the type of error. Enables quick recognition and categorization of the issue.",
8529
8465
  enum: ["invalid_credentials"],
8530
8466
  type: "string"
8531
8467
  },
@@ -8559,6 +8495,7 @@ var openapi_default = {
8559
8495
  warnings: {
8560
8496
  items: {
8561
8497
  description: "Warning associated with the `connected_account`.",
8498
+ discriminator: { propertyName: "warning_code" },
8562
8499
  oneOf: [
8563
8500
  {
8564
8501
  description: "Scheduled downtime for account planned.",
@@ -8708,239 +8645,217 @@ var openapi_default = {
8708
8645
  errors: {
8709
8646
  description: 'Array of errors associated with the device. Each error object within the array contains two fields: "error_code" and "message." "error_code" is a string that uniquely identifies the type of error, enabling quick recognition and categorization of the issue. "message" provides a more detailed description of the error, offering insights into the issue and potentially how to rectify it.',
8710
8647
  items: {
8648
+ discriminator: { propertyName: "error_code" },
8711
8649
  oneOf: [
8712
8650
  {
8713
- description: "Error associated with the `device`.",
8714
- oneOf: [
8715
- {
8716
- description: "Device is offline",
8717
- properties: {
8718
- error_code: {
8719
- description: "Unique identifier of the type of error. Enables quick recognition and categorization of the issue.",
8720
- enum: ["device_offline"],
8721
- type: "string"
8722
- },
8723
- is_device_error: { enum: [true], type: "boolean" },
8724
- message: { type: "string" }
8725
- },
8726
- required: ["message", "is_device_error", "error_code"],
8727
- type: "object"
8728
- },
8729
- {
8730
- description: "Device has been removed",
8731
- properties: {
8732
- error_code: {
8733
- description: "Unique identifier of the type of error. Enables quick recognition and categorization of the issue.",
8734
- enum: ["device_removed"],
8735
- type: "string"
8736
- },
8737
- is_device_error: { enum: [true], type: "boolean" },
8738
- message: { type: "string" }
8739
- },
8740
- required: ["message", "is_device_error", "error_code"],
8741
- type: "object"
8742
- },
8743
- {
8744
- description: "Account is disconnected",
8745
- properties: {
8746
- error_code: {
8747
- description: "Unique identifier of the type of error. Enables quick recognition and categorization of the issue.",
8748
- enum: ["account_disconnected"],
8749
- type: "string"
8750
- },
8751
- is_device_error: { enum: [true], type: "boolean" },
8752
- message: { type: "string" }
8753
- },
8754
- required: ["message", "is_device_error", "error_code"],
8755
- type: "object"
8651
+ description: "Device is offline",
8652
+ properties: {
8653
+ error_code: {
8654
+ description: "Unique identifier of the type of error. Enables quick recognition and categorization of the issue.",
8655
+ enum: ["device_offline"],
8656
+ type: "string"
8756
8657
  },
8757
- {
8758
- description: "Hub is disconnected",
8759
- properties: {
8760
- error_code: {
8761
- description: "Unique identifier of the type of error. Enables quick recognition and categorization of the issue.",
8762
- enum: ["hub_disconnected"],
8763
- type: "string"
8764
- },
8765
- is_device_error: { enum: [true], type: "boolean" },
8766
- message: { type: "string" }
8767
- },
8768
- required: ["message", "is_device_error", "error_code"],
8769
- type: "object"
8658
+ is_device_error: { enum: [true], type: "boolean" },
8659
+ message: { type: "string" }
8660
+ },
8661
+ required: ["message", "is_device_error", "error_code"],
8662
+ type: "object"
8663
+ },
8664
+ {
8665
+ description: "Device has been removed",
8666
+ properties: {
8667
+ error_code: {
8668
+ description: "Unique identifier of the type of error. Enables quick recognition and categorization of the issue.",
8669
+ enum: ["device_removed"],
8670
+ type: "string"
8770
8671
  },
8771
- {
8772
- description: "Device is disconnected",
8773
- properties: {
8774
- error_code: {
8775
- description: "Unique identifier of the type of error. Enables quick recognition and categorization of the issue.",
8776
- enum: ["device_disconnected"],
8777
- type: "string"
8778
- },
8779
- is_device_error: { enum: [true], type: "boolean" },
8780
- message: { type: "string" }
8781
- },
8782
- required: ["message", "is_device_error", "error_code"],
8783
- type: "object"
8672
+ is_device_error: { enum: [true], type: "boolean" },
8673
+ message: { type: "string" }
8674
+ },
8675
+ required: ["message", "is_device_error", "error_code"],
8676
+ type: "object"
8677
+ },
8678
+ {
8679
+ description: "Hub is disconnected",
8680
+ properties: {
8681
+ error_code: {
8682
+ description: "Unique identifier of the type of error. Enables quick recognition and categorization of the issue.",
8683
+ enum: ["hub_disconnected"],
8684
+ type: "string"
8784
8685
  },
8785
- {
8786
- description: "The backup access code pool is empty.",
8787
- properties: {
8788
- error_code: {
8789
- description: "Unique identifier of the type of error. Enables quick recognition and categorization of the issue.",
8790
- enum: ["empty_backup_access_code_pool"],
8791
- type: "string"
8792
- },
8793
- is_device_error: { enum: [true], type: "boolean" },
8794
- message: { type: "string" }
8795
- },
8796
- required: ["message", "is_device_error", "error_code"],
8797
- type: "object"
8686
+ is_device_error: { enum: [true], type: "boolean" },
8687
+ message: { type: "string" }
8688
+ },
8689
+ required: ["message", "is_device_error", "error_code"],
8690
+ type: "object"
8691
+ },
8692
+ {
8693
+ description: "Device is disconnected",
8694
+ properties: {
8695
+ error_code: {
8696
+ description: "Unique identifier of the type of error. Enables quick recognition and categorization of the issue.",
8697
+ enum: ["device_disconnected"],
8698
+ type: "string"
8798
8699
  },
8799
- {
8800
- description: "User is not authorized to use the August Lock.",
8801
- properties: {
8802
- error_code: {
8803
- description: "Unique identifier of the type of error. Enables quick recognition and categorization of the issue.",
8804
- enum: ["august_lock_not_authorized"],
8805
- type: "string"
8806
- },
8807
- is_device_error: { enum: [true], type: "boolean" },
8808
- message: { type: "string" }
8809
- },
8810
- required: ["message", "is_device_error", "error_code"],
8811
- type: "object"
8700
+ is_device_error: { enum: [true], type: "boolean" },
8701
+ message: { type: "string" }
8702
+ },
8703
+ required: ["message", "is_device_error", "error_code"],
8704
+ type: "object"
8705
+ },
8706
+ {
8707
+ description: "The backup access code pool is empty.",
8708
+ properties: {
8709
+ error_code: {
8710
+ description: "Unique identifier of the type of error. Enables quick recognition and categorization of the issue.",
8711
+ enum: ["empty_backup_access_code_pool"],
8712
+ type: "string"
8812
8713
  },
8813
- {
8814
- description: "Lock is not connected to the Seam Bridge.",
8815
- properties: {
8816
- error_code: {
8817
- description: "Unique identifier of the type of error. Enables quick recognition and categorization of the issue.",
8818
- enum: ["august_lock_missing_bridge"],
8819
- type: "string"
8820
- },
8821
- is_device_error: { enum: [true], type: "boolean" },
8822
- message: { type: "string" }
8823
- },
8824
- required: ["message", "is_device_error", "error_code"],
8825
- type: "object"
8714
+ is_device_error: { enum: [true], type: "boolean" },
8715
+ message: { type: "string" }
8716
+ },
8717
+ required: ["message", "is_device_error", "error_code"],
8718
+ type: "object"
8719
+ },
8720
+ {
8721
+ description: "User is not authorized to use the August Lock.",
8722
+ properties: {
8723
+ error_code: {
8724
+ description: "Unique identifier of the type of error. Enables quick recognition and categorization of the issue.",
8725
+ enum: ["august_lock_not_authorized"],
8726
+ type: "string"
8826
8727
  },
8827
- {
8828
- description: "Salto site user limit reached.",
8829
- properties: {
8830
- error_code: {
8831
- description: "Unique identifier of the type of error. Enables quick recognition and categorization of the issue.",
8832
- enum: ["salto_site_user_limit_reached"],
8833
- type: "string"
8834
- },
8835
- is_device_error: { enum: [true], type: "boolean" },
8836
- message: { type: "string" }
8837
- },
8838
- required: ["message", "is_device_error", "error_code"],
8839
- type: "object"
8728
+ is_device_error: { enum: [true], type: "boolean" },
8729
+ message: { type: "string" }
8730
+ },
8731
+ required: ["message", "is_device_error", "error_code"],
8732
+ type: "object"
8733
+ },
8734
+ {
8735
+ description: "Lock is not connected to the Seam Bridge.",
8736
+ properties: {
8737
+ error_code: {
8738
+ description: "Unique identifier of the type of error. Enables quick recognition and categorization of the issue.",
8739
+ enum: ["august_lock_missing_bridge"],
8740
+ type: "string"
8840
8741
  },
8841
- {
8842
- description: "Lock is not paired with a Gateway.",
8843
- properties: {
8844
- error_code: {
8845
- description: "Unique identifier of the type of error. Enables quick recognition and categorization of the issue.",
8846
- enum: ["ttlock_lock_not_paired_to_gateway"],
8847
- type: "string"
8848
- },
8849
- is_device_error: { enum: [true], type: "boolean" },
8850
- message: { type: "string" }
8851
- },
8852
- required: ["message", "is_device_error", "error_code"],
8853
- type: "object"
8742
+ is_device_error: { enum: [true], type: "boolean" },
8743
+ message: { type: "string" }
8744
+ },
8745
+ required: ["message", "is_device_error", "error_code"],
8746
+ type: "object"
8747
+ },
8748
+ {
8749
+ description: "Salto site user limit reached.",
8750
+ properties: {
8751
+ error_code: {
8752
+ description: "Unique identifier of the type of error. Enables quick recognition and categorization of the issue.",
8753
+ enum: ["salto_site_user_limit_reached"],
8754
+ type: "string"
8854
8755
  },
8855
- {
8856
- description: "Missing device credentials.",
8857
- properties: {
8858
- error_code: {
8859
- description: "Unique identifier of the type of error. Enables quick recognition and categorization of the issue.",
8860
- enum: ["missing_device_credentials"],
8861
- type: "string"
8862
- },
8863
- is_device_error: { enum: [true], type: "boolean" },
8864
- message: { type: "string" }
8865
- },
8866
- required: ["message", "is_device_error", "error_code"],
8867
- type: "object"
8756
+ is_device_error: { enum: [true], type: "boolean" },
8757
+ message: { type: "string" }
8758
+ },
8759
+ required: ["message", "is_device_error", "error_code"],
8760
+ type: "object"
8761
+ },
8762
+ {
8763
+ description: "Lock is not paired with a Gateway.",
8764
+ properties: {
8765
+ error_code: {
8766
+ description: "Unique identifier of the type of error. Enables quick recognition and categorization of the issue.",
8767
+ enum: ["ttlock_lock_not_paired_to_gateway"],
8768
+ type: "string"
8868
8769
  },
8869
- {
8870
- description: "The auxiliary heat is running.",
8871
- properties: {
8872
- error_code: {
8873
- description: "Unique identifier of the type of error. Enables quick recognition and categorization of the issue.",
8874
- enum: ["auxiliary_heat_running"],
8875
- type: "string"
8876
- },
8877
- is_device_error: { enum: [true], type: "boolean" },
8878
- message: { type: "string" }
8879
- },
8880
- required: ["message", "is_device_error", "error_code"],
8881
- type: "object"
8770
+ is_device_error: { enum: [true], type: "boolean" },
8771
+ message: { type: "string" }
8772
+ },
8773
+ required: ["message", "is_device_error", "error_code"],
8774
+ type: "object"
8775
+ },
8776
+ {
8777
+ description: "Missing device credentials.",
8778
+ properties: {
8779
+ error_code: {
8780
+ description: "Unique identifier of the type of error. Enables quick recognition and categorization of the issue.",
8781
+ enum: ["missing_device_credentials"],
8782
+ type: "string"
8882
8783
  },
8883
- {
8884
- description: "Subscription required to connect.",
8885
- properties: {
8886
- error_code: {
8887
- description: "Unique identifier of the type of error. Enables quick recognition and categorization of the issue.",
8888
- enum: ["subscription_required"],
8889
- type: "string"
8890
- },
8891
- is_device_error: { enum: [true], type: "boolean" },
8892
- message: { type: "string" }
8893
- },
8894
- required: ["message", "is_device_error", "error_code"],
8895
- type: "object"
8896
- }
8897
- ]
8784
+ is_device_error: { enum: [true], type: "boolean" },
8785
+ message: { type: "string" }
8786
+ },
8787
+ required: ["message", "is_device_error", "error_code"],
8788
+ type: "object"
8898
8789
  },
8899
8790
  {
8900
- oneOf: [
8901
- {
8902
- description: "Account is disconnected.",
8903
- properties: {
8904
- error_code: {
8905
- description: "Unique identifier of the type of warning. Enables quick recognition and categorization of the issue.",
8906
- enum: ["account_disconnected"],
8907
- type: "string"
8908
- },
8909
- is_connected_account_error: {
8910
- enum: [true],
8911
- type: "boolean"
8912
- },
8913
- message: { type: "string" }
8914
- },
8915
- required: [
8916
- "message",
8917
- "is_connected_account_error",
8918
- "error_code"
8919
- ],
8920
- type: "object"
8791
+ description: "The auxiliary heat is running.",
8792
+ properties: {
8793
+ error_code: {
8794
+ description: "Unique identifier of the type of error. Enables quick recognition and categorization of the issue.",
8795
+ enum: ["auxiliary_heat_running"],
8796
+ type: "string"
8921
8797
  },
8922
- {
8923
- description: "Credentials provided were invalid.",
8924
- properties: {
8925
- error_code: {
8926
- description: "Unique identifier of the type of warning. Enables quick recognition and categorization of the issue.",
8927
- enum: ["invalid_credentials"],
8928
- type: "string"
8929
- },
8930
- is_connected_account_error: {
8931
- enum: [true],
8932
- type: "boolean"
8933
- },
8934
- message: { type: "string" }
8935
- },
8936
- required: [
8937
- "message",
8938
- "is_connected_account_error",
8939
- "error_code"
8940
- ],
8941
- type: "object"
8942
- }
8943
- ]
8798
+ is_device_error: { enum: [true], type: "boolean" },
8799
+ message: { type: "string" }
8800
+ },
8801
+ required: ["message", "is_device_error", "error_code"],
8802
+ type: "object"
8803
+ },
8804
+ {
8805
+ description: "Subscription required to connect.",
8806
+ properties: {
8807
+ error_code: {
8808
+ description: "Unique identifier of the type of error. Enables quick recognition and categorization of the issue.",
8809
+ enum: ["subscription_required"],
8810
+ type: "string"
8811
+ },
8812
+ is_device_error: { enum: [true], type: "boolean" },
8813
+ message: { type: "string" }
8814
+ },
8815
+ required: ["message", "is_device_error", "error_code"],
8816
+ type: "object"
8817
+ },
8818
+ {
8819
+ description: "Account is disconnected.",
8820
+ properties: {
8821
+ error_code: {
8822
+ description: "Unique identifier of the type of error. Enables quick recognition and categorization of the issue.",
8823
+ enum: ["account_disconnected"],
8824
+ type: "string"
8825
+ },
8826
+ is_connected_account_error: {
8827
+ enum: [true],
8828
+ type: "boolean"
8829
+ },
8830
+ message: { type: "string" }
8831
+ },
8832
+ required: [
8833
+ "message",
8834
+ "is_connected_account_error",
8835
+ "error_code"
8836
+ ],
8837
+ type: "object"
8838
+ },
8839
+ {
8840
+ description: "Credentials provided were invalid.",
8841
+ properties: {
8842
+ error_code: {
8843
+ description: "Unique identifier of the type of error. Enables quick recognition and categorization of the issue.",
8844
+ enum: ["invalid_credentials"],
8845
+ type: "string"
8846
+ },
8847
+ is_connected_account_error: {
8848
+ enum: [true],
8849
+ type: "boolean"
8850
+ },
8851
+ message: { type: "string" }
8852
+ },
8853
+ required: [
8854
+ "message",
8855
+ "is_connected_account_error",
8856
+ "error_code"
8857
+ ],
8858
+ type: "object"
8944
8859
  }
8945
8860
  ]
8946
8861
  },
@@ -10174,6 +10089,7 @@ var openapi_default = {
10174
10089
  warnings: {
10175
10090
  description: 'Array of warnings associated with the device. Each warning object within the array contains two fields: "warning_code" and "message." "warning_code" is a string that uniquely identifies the type of warning, enabling quick recognition and categorization of the issue. "message" provides a more detailed description of the warning, offering insights into the issue and potentially how to rectify it.',
10176
10091
  items: {
10092
+ discriminator: { propertyName: "warning_code" },
10177
10093
  oneOf: [
10178
10094
  {
10179
10095
  description: "Backup access code unhealthy.",
@@ -14661,319 +14577,298 @@ var openapi_default = {
14661
14577
  errors: {
14662
14578
  description: 'Array of errors associated with the device. Each error object within the array contains two fields: "error_code" and "message." "error_code" is a string that uniquely identifies the type of error, enabling quick recognition and categorization of the issue. "message" provides a more detailed description of the error, offering insights into the issue and potentially how to rectify it.',
14663
14579
  items: {
14580
+ discriminator: { propertyName: "error_code" },
14664
14581
  oneOf: [
14665
14582
  {
14666
- description: "Error associated with the `device`.",
14667
- oneOf: [
14668
- {
14669
- description: "Device is offline",
14670
- properties: {
14671
- error_code: {
14672
- description: "Unique identifier of the type of error. Enables quick recognition and categorization of the issue.",
14673
- enum: ["device_offline"],
14674
- type: "string"
14675
- },
14676
- is_device_error: { enum: [true], type: "boolean" },
14677
- message: { type: "string" }
14678
- },
14679
- required: ["message", "is_device_error", "error_code"],
14680
- type: "object"
14681
- },
14682
- {
14683
- description: "Device has been removed",
14684
- properties: {
14685
- error_code: {
14686
- description: "Unique identifier of the type of error. Enables quick recognition and categorization of the issue.",
14687
- enum: ["device_removed"],
14688
- type: "string"
14689
- },
14690
- is_device_error: { enum: [true], type: "boolean" },
14691
- message: { type: "string" }
14692
- },
14693
- required: ["message", "is_device_error", "error_code"],
14694
- type: "object"
14695
- },
14696
- {
14697
- description: "Account is disconnected",
14698
- properties: {
14699
- error_code: {
14700
- description: "Unique identifier of the type of error. Enables quick recognition and categorization of the issue.",
14701
- enum: ["account_disconnected"],
14702
- type: "string"
14703
- },
14704
- is_device_error: { enum: [true], type: "boolean" },
14705
- message: { type: "string" }
14706
- },
14707
- required: ["message", "is_device_error", "error_code"],
14708
- type: "object"
14709
- },
14710
- {
14711
- description: "Hub is disconnected",
14712
- properties: {
14713
- error_code: {
14714
- description: "Unique identifier of the type of error. Enables quick recognition and categorization of the issue.",
14715
- enum: ["hub_disconnected"],
14716
- type: "string"
14717
- },
14718
- is_device_error: { enum: [true], type: "boolean" },
14719
- message: { type: "string" }
14720
- },
14721
- required: ["message", "is_device_error", "error_code"],
14722
- type: "object"
14723
- },
14724
- {
14725
- description: "Device is disconnected",
14726
- properties: {
14727
- error_code: {
14728
- description: "Unique identifier of the type of error. Enables quick recognition and categorization of the issue.",
14729
- enum: ["device_disconnected"],
14730
- type: "string"
14731
- },
14732
- is_device_error: { enum: [true], type: "boolean" },
14733
- message: { type: "string" }
14734
- },
14735
- required: ["message", "is_device_error", "error_code"],
14736
- type: "object"
14737
- },
14738
- {
14739
- description: "The backup access code pool is empty.",
14740
- properties: {
14741
- error_code: {
14742
- description: "Unique identifier of the type of error. Enables quick recognition and categorization of the issue.",
14743
- enum: ["empty_backup_access_code_pool"],
14744
- type: "string"
14745
- },
14746
- is_device_error: { enum: [true], type: "boolean" },
14747
- message: { type: "string" }
14748
- },
14749
- required: ["message", "is_device_error", "error_code"],
14750
- type: "object"
14751
- },
14752
- {
14753
- description: "User is not authorized to use the August Lock.",
14754
- properties: {
14755
- error_code: {
14756
- description: "Unique identifier of the type of error. Enables quick recognition and categorization of the issue.",
14757
- enum: ["august_lock_not_authorized"],
14758
- type: "string"
14759
- },
14760
- is_device_error: { enum: [true], type: "boolean" },
14761
- message: { type: "string" }
14762
- },
14763
- required: ["message", "is_device_error", "error_code"],
14764
- type: "object"
14765
- },
14766
- {
14767
- description: "Lock is not connected to the Seam Bridge.",
14768
- properties: {
14769
- error_code: {
14770
- description: "Unique identifier of the type of error. Enables quick recognition and categorization of the issue.",
14771
- enum: ["august_lock_missing_bridge"],
14772
- type: "string"
14773
- },
14774
- is_device_error: { enum: [true], type: "boolean" },
14775
- message: { type: "string" }
14776
- },
14777
- required: ["message", "is_device_error", "error_code"],
14778
- type: "object"
14779
- },
14780
- {
14781
- description: "Salto site user limit reached.",
14782
- properties: {
14783
- error_code: {
14784
- description: "Unique identifier of the type of error. Enables quick recognition and categorization of the issue.",
14785
- enum: ["salto_site_user_limit_reached"],
14786
- type: "string"
14787
- },
14788
- is_device_error: { enum: [true], type: "boolean" },
14789
- message: { type: "string" }
14790
- },
14791
- required: ["message", "is_device_error", "error_code"],
14792
- type: "object"
14793
- },
14794
- {
14795
- description: "Lock is not paired with a Gateway.",
14796
- properties: {
14797
- error_code: {
14798
- description: "Unique identifier of the type of error. Enables quick recognition and categorization of the issue.",
14799
- enum: ["ttlock_lock_not_paired_to_gateway"],
14800
- type: "string"
14801
- },
14802
- is_device_error: { enum: [true], type: "boolean" },
14803
- message: { type: "string" }
14804
- },
14805
- required: ["message", "is_device_error", "error_code"],
14806
- type: "object"
14807
- },
14808
- {
14809
- description: "Missing device credentials.",
14810
- properties: {
14811
- error_code: {
14812
- description: "Unique identifier of the type of error. Enables quick recognition and categorization of the issue.",
14813
- enum: ["missing_device_credentials"],
14814
- type: "string"
14815
- },
14816
- is_device_error: { enum: [true], type: "boolean" },
14817
- message: { type: "string" }
14818
- },
14819
- required: ["message", "is_device_error", "error_code"],
14820
- type: "object"
14821
- },
14822
- {
14823
- description: "The auxiliary heat is running.",
14824
- properties: {
14825
- error_code: {
14826
- description: "Unique identifier of the type of error. Enables quick recognition and categorization of the issue.",
14827
- enum: ["auxiliary_heat_running"],
14828
- type: "string"
14829
- },
14830
- is_device_error: { enum: [true], type: "boolean" },
14831
- message: { type: "string" }
14832
- },
14833
- required: ["message", "is_device_error", "error_code"],
14834
- type: "object"
14583
+ description: "Device is offline",
14584
+ properties: {
14585
+ error_code: {
14586
+ description: "Unique identifier of the type of error. Enables quick recognition and categorization of the issue.",
14587
+ enum: ["device_offline"],
14588
+ type: "string"
14835
14589
  },
14836
- {
14837
- description: "Subscription required to connect.",
14838
- properties: {
14839
- error_code: {
14840
- description: "Unique identifier of the type of error. Enables quick recognition and categorization of the issue.",
14841
- enum: ["subscription_required"],
14842
- type: "string"
14843
- },
14844
- is_device_error: { enum: [true], type: "boolean" },
14845
- message: { type: "string" }
14846
- },
14847
- required: ["message", "is_device_error", "error_code"],
14848
- type: "object"
14849
- }
14850
- ]
14590
+ is_device_error: { enum: [true], type: "boolean" },
14591
+ message: { type: "string" }
14592
+ },
14593
+ required: ["message", "is_device_error", "error_code"],
14594
+ type: "object"
14851
14595
  },
14852
14596
  {
14853
- oneOf: [
14854
- {
14855
- description: "Account is disconnected.",
14856
- properties: {
14857
- error_code: {
14858
- description: "Unique identifier of the type of warning. Enables quick recognition and categorization of the issue.",
14859
- enum: ["account_disconnected"],
14860
- type: "string"
14861
- },
14862
- is_connected_account_error: {
14863
- enum: [true],
14864
- type: "boolean"
14865
- },
14866
- message: { type: "string" }
14867
- },
14868
- required: [
14869
- "message",
14870
- "is_connected_account_error",
14871
- "error_code"
14872
- ],
14873
- type: "object"
14874
- },
14875
- {
14876
- description: "Credentials provided were invalid.",
14877
- properties: {
14878
- error_code: {
14879
- description: "Unique identifier of the type of warning. Enables quick recognition and categorization of the issue.",
14880
- enum: ["invalid_credentials"],
14881
- type: "string"
14882
- },
14883
- is_connected_account_error: {
14884
- enum: [true],
14885
- type: "boolean"
14886
- },
14887
- message: { type: "string" }
14888
- },
14889
- required: [
14890
- "message",
14891
- "is_connected_account_error",
14892
- "error_code"
14893
- ],
14894
- type: "object"
14895
- }
14896
- ]
14897
- }
14898
- ]
14899
- },
14900
- type: "array"
14901
- },
14902
- is_managed: {
14903
- description: "Indicates whether Seam manages the device.",
14904
- enum: [true],
14905
- type: "boolean"
14906
- },
14907
- location: {
14908
- description: "Location information for the device.",
14909
- nullable: true,
14910
- properties: {
14911
- location_name: {
14912
- description: "Name of the device location.",
14913
- type: "string"
14914
- },
14915
- timezone: {
14916
- description: "Time zone of the device location.",
14917
- type: "string"
14918
- }
14919
- },
14920
- type: "object"
14921
- },
14922
- nickname: {
14923
- description: "Optional nickname to describe the device, settable through Seam",
14924
- type: "string"
14925
- },
14926
- properties: {
14927
- properties: {
14928
- assa_abloy_credential_service_metadata: {
14929
- properties: {
14930
- endpoints: {
14931
- items: {
14932
- properties: {
14933
- endpoint_id: { type: "string" },
14934
- is_active: { type: "boolean" }
14935
- },
14936
- required: ["endpoint_id", "is_active"],
14937
- type: "object"
14597
+ description: "Device has been removed",
14598
+ properties: {
14599
+ error_code: {
14600
+ description: "Unique identifier of the type of error. Enables quick recognition and categorization of the issue.",
14601
+ enum: ["device_removed"],
14602
+ type: "string"
14938
14603
  },
14939
- type: "array"
14604
+ is_device_error: { enum: [true], type: "boolean" },
14605
+ message: { type: "string" }
14940
14606
  },
14941
- has_active_endpoint: { type: "boolean" }
14607
+ required: ["message", "is_device_error", "error_code"],
14608
+ type: "object"
14942
14609
  },
14943
- required: ["has_active_endpoint", "endpoints"],
14944
- type: "object"
14945
- },
14946
- salto_space_credential_service_metadata: {
14947
- properties: { has_active_phone: { type: "boolean" } },
14948
- required: ["has_active_phone"],
14949
- type: "object"
14950
- }
14951
- },
14952
- type: "object"
14953
- },
14954
- warnings: {
14955
- description: 'Array of warnings associated with the device. Each warning object within the array contains two fields: "warning_code" and "message." "warning_code" is a string that uniquely identifies the type of warning, enabling quick recognition and categorization of the issue. "message" provides a more detailed description of the warning, offering insights into the issue and potentially how to rectify it.',
14956
- items: {
14957
- oneOf: [
14958
14610
  {
14959
- description: "Backup access code unhealthy.",
14611
+ description: "Hub is disconnected",
14960
14612
  properties: {
14961
- message: { type: "string" },
14962
- warning_code: {
14963
- description: "Unique identifier of the type of warning. Enables quick recognition and categorization of the issue.",
14964
- enum: ["partial_backup_access_code_pool"],
14613
+ error_code: {
14614
+ description: "Unique identifier of the type of error. Enables quick recognition and categorization of the issue.",
14615
+ enum: ["hub_disconnected"],
14965
14616
  type: "string"
14966
- }
14617
+ },
14618
+ is_device_error: { enum: [true], type: "boolean" },
14619
+ message: { type: "string" }
14967
14620
  },
14968
- required: ["message", "warning_code"],
14621
+ required: ["message", "is_device_error", "error_code"],
14969
14622
  type: "object"
14970
14623
  },
14971
14624
  {
14972
- description: "Too many backup codes.",
14625
+ description: "Device is disconnected",
14973
14626
  properties: {
14974
- message: { type: "string" },
14975
- warning_code: {
14976
- description: "Unique identifier of the type of warning. Enables quick recognition and categorization of the issue.",
14627
+ error_code: {
14628
+ description: "Unique identifier of the type of error. Enables quick recognition and categorization of the issue.",
14629
+ enum: ["device_disconnected"],
14630
+ type: "string"
14631
+ },
14632
+ is_device_error: { enum: [true], type: "boolean" },
14633
+ message: { type: "string" }
14634
+ },
14635
+ required: ["message", "is_device_error", "error_code"],
14636
+ type: "object"
14637
+ },
14638
+ {
14639
+ description: "The backup access code pool is empty.",
14640
+ properties: {
14641
+ error_code: {
14642
+ description: "Unique identifier of the type of error. Enables quick recognition and categorization of the issue.",
14643
+ enum: ["empty_backup_access_code_pool"],
14644
+ type: "string"
14645
+ },
14646
+ is_device_error: { enum: [true], type: "boolean" },
14647
+ message: { type: "string" }
14648
+ },
14649
+ required: ["message", "is_device_error", "error_code"],
14650
+ type: "object"
14651
+ },
14652
+ {
14653
+ description: "User is not authorized to use the August Lock.",
14654
+ properties: {
14655
+ error_code: {
14656
+ description: "Unique identifier of the type of error. Enables quick recognition and categorization of the issue.",
14657
+ enum: ["august_lock_not_authorized"],
14658
+ type: "string"
14659
+ },
14660
+ is_device_error: { enum: [true], type: "boolean" },
14661
+ message: { type: "string" }
14662
+ },
14663
+ required: ["message", "is_device_error", "error_code"],
14664
+ type: "object"
14665
+ },
14666
+ {
14667
+ description: "Lock is not connected to the Seam Bridge.",
14668
+ properties: {
14669
+ error_code: {
14670
+ description: "Unique identifier of the type of error. Enables quick recognition and categorization of the issue.",
14671
+ enum: ["august_lock_missing_bridge"],
14672
+ type: "string"
14673
+ },
14674
+ is_device_error: { enum: [true], type: "boolean" },
14675
+ message: { type: "string" }
14676
+ },
14677
+ required: ["message", "is_device_error", "error_code"],
14678
+ type: "object"
14679
+ },
14680
+ {
14681
+ description: "Salto site user limit reached.",
14682
+ properties: {
14683
+ error_code: {
14684
+ description: "Unique identifier of the type of error. Enables quick recognition and categorization of the issue.",
14685
+ enum: ["salto_site_user_limit_reached"],
14686
+ type: "string"
14687
+ },
14688
+ is_device_error: { enum: [true], type: "boolean" },
14689
+ message: { type: "string" }
14690
+ },
14691
+ required: ["message", "is_device_error", "error_code"],
14692
+ type: "object"
14693
+ },
14694
+ {
14695
+ description: "Lock is not paired with a Gateway.",
14696
+ properties: {
14697
+ error_code: {
14698
+ description: "Unique identifier of the type of error. Enables quick recognition and categorization of the issue.",
14699
+ enum: ["ttlock_lock_not_paired_to_gateway"],
14700
+ type: "string"
14701
+ },
14702
+ is_device_error: { enum: [true], type: "boolean" },
14703
+ message: { type: "string" }
14704
+ },
14705
+ required: ["message", "is_device_error", "error_code"],
14706
+ type: "object"
14707
+ },
14708
+ {
14709
+ description: "Missing device credentials.",
14710
+ properties: {
14711
+ error_code: {
14712
+ description: "Unique identifier of the type of error. Enables quick recognition and categorization of the issue.",
14713
+ enum: ["missing_device_credentials"],
14714
+ type: "string"
14715
+ },
14716
+ is_device_error: { enum: [true], type: "boolean" },
14717
+ message: { type: "string" }
14718
+ },
14719
+ required: ["message", "is_device_error", "error_code"],
14720
+ type: "object"
14721
+ },
14722
+ {
14723
+ description: "The auxiliary heat is running.",
14724
+ properties: {
14725
+ error_code: {
14726
+ description: "Unique identifier of the type of error. Enables quick recognition and categorization of the issue.",
14727
+ enum: ["auxiliary_heat_running"],
14728
+ type: "string"
14729
+ },
14730
+ is_device_error: { enum: [true], type: "boolean" },
14731
+ message: { type: "string" }
14732
+ },
14733
+ required: ["message", "is_device_error", "error_code"],
14734
+ type: "object"
14735
+ },
14736
+ {
14737
+ description: "Subscription required to connect.",
14738
+ properties: {
14739
+ error_code: {
14740
+ description: "Unique identifier of the type of error. Enables quick recognition and categorization of the issue.",
14741
+ enum: ["subscription_required"],
14742
+ type: "string"
14743
+ },
14744
+ is_device_error: { enum: [true], type: "boolean" },
14745
+ message: { type: "string" }
14746
+ },
14747
+ required: ["message", "is_device_error", "error_code"],
14748
+ type: "object"
14749
+ },
14750
+ {
14751
+ description: "Account is disconnected.",
14752
+ properties: {
14753
+ error_code: {
14754
+ description: "Unique identifier of the type of error. Enables quick recognition and categorization of the issue.",
14755
+ enum: ["account_disconnected"],
14756
+ type: "string"
14757
+ },
14758
+ is_connected_account_error: {
14759
+ enum: [true],
14760
+ type: "boolean"
14761
+ },
14762
+ message: { type: "string" }
14763
+ },
14764
+ required: [
14765
+ "message",
14766
+ "is_connected_account_error",
14767
+ "error_code"
14768
+ ],
14769
+ type: "object"
14770
+ },
14771
+ {
14772
+ description: "Credentials provided were invalid.",
14773
+ properties: {
14774
+ error_code: {
14775
+ description: "Unique identifier of the type of error. Enables quick recognition and categorization of the issue.",
14776
+ enum: ["invalid_credentials"],
14777
+ type: "string"
14778
+ },
14779
+ is_connected_account_error: {
14780
+ enum: [true],
14781
+ type: "boolean"
14782
+ },
14783
+ message: { type: "string" }
14784
+ },
14785
+ required: [
14786
+ "message",
14787
+ "is_connected_account_error",
14788
+ "error_code"
14789
+ ],
14790
+ type: "object"
14791
+ }
14792
+ ]
14793
+ },
14794
+ type: "array"
14795
+ },
14796
+ is_managed: {
14797
+ description: "Indicates whether Seam manages the device.",
14798
+ enum: [true],
14799
+ type: "boolean"
14800
+ },
14801
+ location: {
14802
+ description: "Location information for the device.",
14803
+ nullable: true,
14804
+ properties: {
14805
+ location_name: {
14806
+ description: "Name of the device location.",
14807
+ type: "string"
14808
+ },
14809
+ timezone: {
14810
+ description: "Time zone of the device location.",
14811
+ type: "string"
14812
+ }
14813
+ },
14814
+ type: "object"
14815
+ },
14816
+ nickname: {
14817
+ description: "Optional nickname to describe the device, settable through Seam",
14818
+ type: "string"
14819
+ },
14820
+ properties: {
14821
+ properties: {
14822
+ assa_abloy_credential_service_metadata: {
14823
+ properties: {
14824
+ endpoints: {
14825
+ items: {
14826
+ properties: {
14827
+ endpoint_id: { type: "string" },
14828
+ is_active: { type: "boolean" }
14829
+ },
14830
+ required: ["endpoint_id", "is_active"],
14831
+ type: "object"
14832
+ },
14833
+ type: "array"
14834
+ },
14835
+ has_active_endpoint: { type: "boolean" }
14836
+ },
14837
+ required: ["has_active_endpoint", "endpoints"],
14838
+ type: "object"
14839
+ },
14840
+ salto_space_credential_service_metadata: {
14841
+ properties: { has_active_phone: { type: "boolean" } },
14842
+ required: ["has_active_phone"],
14843
+ type: "object"
14844
+ }
14845
+ },
14846
+ type: "object"
14847
+ },
14848
+ warnings: {
14849
+ description: 'Array of warnings associated with the device. Each warning object within the array contains two fields: "warning_code" and "message." "warning_code" is a string that uniquely identifies the type of warning, enabling quick recognition and categorization of the issue. "message" provides a more detailed description of the warning, offering insights into the issue and potentially how to rectify it.',
14850
+ items: {
14851
+ discriminator: { propertyName: "warning_code" },
14852
+ oneOf: [
14853
+ {
14854
+ description: "Backup access code unhealthy.",
14855
+ properties: {
14856
+ message: { type: "string" },
14857
+ warning_code: {
14858
+ description: "Unique identifier of the type of warning. Enables quick recognition and categorization of the issue.",
14859
+ enum: ["partial_backup_access_code_pool"],
14860
+ type: "string"
14861
+ }
14862
+ },
14863
+ required: ["message", "warning_code"],
14864
+ type: "object"
14865
+ },
14866
+ {
14867
+ description: "Too many backup codes.",
14868
+ properties: {
14869
+ message: { type: "string" },
14870
+ warning_code: {
14871
+ description: "Unique identifier of the type of warning. Enables quick recognition and categorization of the issue.",
14977
14872
  enum: ["many_active_backup_codes"],
14978
14873
  type: "string"
14979
14874
  }
@@ -15303,589 +15198,487 @@ var openapi_default = {
15303
15198
  errors: {
15304
15199
  description: 'Collection of errors associated with the access code, structured in a dictionary format. A unique "error_code" keys each error. Each error entry is an object containing two fields: "message" and "created_at." "message" is a string that describes the error. "created_at" is a date that indicates when the error was generated. This structure enables detailed tracking and timely response to critical issues.',
15305
15200
  items: {
15201
+ discriminator: { propertyName: "error_code" },
15306
15202
  oneOf: [
15307
15203
  {
15308
- oneOf: [
15309
- {
15310
- description: "Failed to set code on Smart Things device.",
15311
- properties: {
15312
- error_code: {
15313
- description: "Unique identifier of the type of error. Enables quick recognition and categorization of the issue.",
15314
- enum: ["smartthings_failed_to_set_access_code"],
15315
- type: "string"
15316
- },
15317
- is_access_code_error: { enum: [true], type: "boolean" },
15318
- message: { type: "string" }
15319
- },
15320
- required: [
15321
- "message",
15322
- "is_access_code_error",
15323
- "error_code"
15324
- ],
15325
- type: "object"
15204
+ description: "Failed to set code on Smart Things device.",
15205
+ properties: {
15206
+ error_code: {
15207
+ description: "Unique identifier of the type of error. Enables quick recognition and categorization of the issue.",
15208
+ enum: ["smartthings_failed_to_set_access_code"],
15209
+ type: "string"
15326
15210
  },
15327
- {
15328
- description: "Failed to set code after multiple retries.",
15329
- properties: {
15330
- error_code: {
15331
- description: "Unique identifier of the type of error. Enables quick recognition and categorization of the issue.",
15332
- enum: [
15333
- "smartthings_failed_to_set_after_multiple_retries"
15334
- ],
15335
- type: "string"
15336
- },
15337
- is_access_code_error: { enum: [true], type: "boolean" },
15338
- message: { type: "string" }
15339
- },
15340
- required: [
15341
- "message",
15342
- "is_access_code_error",
15343
- "error_code"
15211
+ is_access_code_error: { enum: [true], type: "boolean" },
15212
+ message: { type: "string" }
15213
+ },
15214
+ required: ["message", "is_access_code_error", "error_code"],
15215
+ type: "object"
15216
+ },
15217
+ {
15218
+ description: "Failed to set code after multiple retries.",
15219
+ properties: {
15220
+ error_code: {
15221
+ description: "Unique identifier of the type of error. Enables quick recognition and categorization of the issue.",
15222
+ enum: [
15223
+ "smartthings_failed_to_set_after_multiple_retries"
15344
15224
  ],
15345
- type: "object"
15225
+ type: "string"
15346
15226
  },
15347
- {
15348
- description: "Failed to set code on device.",
15349
- properties: {
15350
- error_code: {
15351
- description: "Unique identifier of the type of error. Enables quick recognition and categorization of the issue.",
15352
- enum: ["failed_to_set_on_device"],
15353
- type: "string"
15354
- },
15355
- is_access_code_error: { enum: [true], type: "boolean" },
15356
- message: { type: "string" }
15357
- },
15358
- required: [
15359
- "message",
15360
- "is_access_code_error",
15361
- "error_code"
15362
- ],
15363
- type: "object"
15227
+ is_access_code_error: { enum: [true], type: "boolean" },
15228
+ message: { type: "string" }
15229
+ },
15230
+ required: ["message", "is_access_code_error", "error_code"],
15231
+ type: "object"
15232
+ },
15233
+ {
15234
+ description: "Failed to set code on device.",
15235
+ properties: {
15236
+ error_code: {
15237
+ description: "Unique identifier of the type of error. Enables quick recognition and categorization of the issue.",
15238
+ enum: ["failed_to_set_on_device"],
15239
+ type: "string"
15364
15240
  },
15365
- {
15366
- description: "Failed to remove code from device.",
15367
- properties: {
15368
- error_code: {
15369
- description: "Unique identifier of the type of error. Enables quick recognition and categorization of the issue.",
15370
- enum: ["failed_to_remove_from_device"],
15371
- type: "string"
15372
- },
15373
- is_access_code_error: { enum: [true], type: "boolean" },
15374
- message: { type: "string" }
15375
- },
15376
- required: [
15377
- "message",
15378
- "is_access_code_error",
15379
- "error_code"
15380
- ],
15381
- type: "object"
15241
+ is_access_code_error: { enum: [true], type: "boolean" },
15242
+ message: { type: "string" }
15243
+ },
15244
+ required: ["message", "is_access_code_error", "error_code"],
15245
+ type: "object"
15246
+ },
15247
+ {
15248
+ description: "Failed to remove code from device.",
15249
+ properties: {
15250
+ error_code: {
15251
+ description: "Unique identifier of the type of error. Enables quick recognition and categorization of the issue.",
15252
+ enum: ["failed_to_remove_from_device"],
15253
+ type: "string"
15382
15254
  },
15383
- {
15384
- description: "Duplicate access code detected on device.",
15385
- properties: {
15386
- error_code: {
15387
- description: "Unique identifier of the type of error. Enables quick recognition and categorization of the issue.",
15388
- enum: ["duplicate_code_on_device"],
15389
- type: "string"
15390
- },
15391
- is_access_code_error: { enum: [true], type: "boolean" },
15392
- message: { type: "string" }
15393
- },
15394
- required: [
15395
- "message",
15396
- "is_access_code_error",
15397
- "error_code"
15398
- ],
15399
- type: "object"
15255
+ is_access_code_error: { enum: [true], type: "boolean" },
15256
+ message: { type: "string" }
15257
+ },
15258
+ required: ["message", "is_access_code_error", "error_code"],
15259
+ type: "object"
15260
+ },
15261
+ {
15262
+ description: "Duplicate access code detected on device.",
15263
+ properties: {
15264
+ error_code: {
15265
+ description: "Unique identifier of the type of error. Enables quick recognition and categorization of the issue.",
15266
+ enum: ["duplicate_code_on_device"],
15267
+ type: "string"
15400
15268
  },
15401
- {
15402
- description: "An attempt to modify this access code was prevented.",
15403
- properties: {
15404
- error_code: {
15405
- description: "Unique identifier of the type of error. Enables quick recognition and categorization of the issue.",
15406
- enum: ["duplicate_code_attempt_prevented"],
15407
- type: "string"
15408
- },
15409
- is_access_code_error: { enum: [true], type: "boolean" },
15410
- message: { type: "string" }
15411
- },
15412
- required: [
15413
- "message",
15414
- "is_access_code_error",
15415
- "error_code"
15416
- ],
15417
- type: "object"
15269
+ is_access_code_error: { enum: [true], type: "boolean" },
15270
+ message: { type: "string" }
15271
+ },
15272
+ required: ["message", "is_access_code_error", "error_code"],
15273
+ type: "object"
15274
+ },
15275
+ {
15276
+ description: "An attempt to modify this access code was prevented.",
15277
+ properties: {
15278
+ error_code: {
15279
+ description: "Unique identifier of the type of error. Enables quick recognition and categorization of the issue.",
15280
+ enum: ["duplicate_code_attempt_prevented"],
15281
+ type: "string"
15418
15282
  },
15419
- {
15420
- description: "Igloohome bridge has too many pending jobs in the queue.",
15421
- properties: {
15422
- error_code: {
15423
- description: "Unique identifier of the type of error. Enables quick recognition and categorization of the issue.",
15424
- enum: ["igloohome_bridge_too_many_pending_jobs"],
15425
- type: "string"
15426
- },
15427
- is_access_code_error: { enum: [true], type: "boolean" },
15428
- message: { type: "string" }
15429
- },
15430
- required: [
15431
- "message",
15432
- "is_access_code_error",
15433
- "error_code"
15434
- ],
15435
- type: "object"
15283
+ is_access_code_error: { enum: [true], type: "boolean" },
15284
+ message: { type: "string" }
15285
+ },
15286
+ required: ["message", "is_access_code_error", "error_code"],
15287
+ type: "object"
15288
+ },
15289
+ {
15290
+ description: "Igloohome bridge has too many pending jobs in the queue.",
15291
+ properties: {
15292
+ error_code: {
15293
+ description: "Unique identifier of the type of error. Enables quick recognition and categorization of the issue.",
15294
+ enum: ["igloohome_bridge_too_many_pending_jobs"],
15295
+ type: "string"
15436
15296
  },
15437
- {
15438
- description: "Igloohome bridge is offline.",
15439
- properties: {
15440
- error_code: {
15441
- description: "Unique identifier of the type of error. Enables quick recognition and categorization of the issue.",
15442
- enum: ["igloohome_bridge_offline"],
15443
- type: "string"
15444
- },
15445
- is_access_code_error: { enum: [true], type: "boolean" },
15446
- message: { type: "string" }
15447
- },
15448
- required: [
15449
- "message",
15450
- "is_access_code_error",
15451
- "error_code"
15452
- ],
15453
- type: "object"
15297
+ is_access_code_error: { enum: [true], type: "boolean" },
15298
+ message: { type: "string" }
15299
+ },
15300
+ required: ["message", "is_access_code_error", "error_code"],
15301
+ type: "object"
15302
+ },
15303
+ {
15304
+ description: "Igloohome bridge is offline.",
15305
+ properties: {
15306
+ error_code: {
15307
+ description: "Unique identifier of the type of error. Enables quick recognition and categorization of the issue.",
15308
+ enum: ["igloohome_bridge_offline"],
15309
+ type: "string"
15454
15310
  },
15455
- {
15456
- description: "Lock as reached max amount of codes.",
15457
- properties: {
15458
- error_code: {
15459
- description: "Unique identifier of the type of error. Enables quick recognition and categorization of the issue.",
15460
- enum: [
15461
- "igloohome_offline_access_code_no_variance_available"
15462
- ],
15463
- type: "string"
15464
- },
15465
- is_access_code_error: { enum: [true], type: "boolean" },
15466
- message: { type: "string" }
15467
- },
15468
- required: [
15469
- "message",
15470
- "is_access_code_error",
15471
- "error_code"
15311
+ is_access_code_error: { enum: [true], type: "boolean" },
15312
+ message: { type: "string" }
15313
+ },
15314
+ required: ["message", "is_access_code_error", "error_code"],
15315
+ type: "object"
15316
+ },
15317
+ {
15318
+ description: "Lock as reached max amount of codes.",
15319
+ properties: {
15320
+ error_code: {
15321
+ description: "Unique identifier of the type of error. Enables quick recognition and categorization of the issue.",
15322
+ enum: [
15323
+ "igloohome_offline_access_code_no_variance_available"
15472
15324
  ],
15473
- type: "object"
15325
+ type: "string"
15474
15326
  },
15475
- {
15476
- description: "Unable to confirm the access code is set on Kwikset device.",
15477
- properties: {
15478
- error_code: {
15479
- description: "Unique identifier of the type of error. Enables quick recognition and categorization of the issue.",
15480
- enum: ["kwikset_unable_to_confirm_code"],
15481
- type: "string"
15482
- },
15483
- is_access_code_error: { enum: [true], type: "boolean" },
15484
- message: { type: "string" }
15485
- },
15486
- required: [
15487
- "message",
15488
- "is_access_code_error",
15489
- "error_code"
15490
- ],
15491
- type: "object"
15327
+ is_access_code_error: { enum: [true], type: "boolean" },
15328
+ message: { type: "string" }
15329
+ },
15330
+ required: ["message", "is_access_code_error", "error_code"],
15331
+ type: "object"
15332
+ },
15333
+ {
15334
+ description: "Unable to confirm the access code is set on Kwikset device.",
15335
+ properties: {
15336
+ error_code: {
15337
+ description: "Unique identifier of the type of error. Enables quick recognition and categorization of the issue.",
15338
+ enum: ["kwikset_unable_to_confirm_code"],
15339
+ type: "string"
15492
15340
  },
15493
- {
15494
- description: "Unable to confirm the deletion of the access code on Kwikset device.",
15495
- properties: {
15496
- error_code: {
15497
- description: "Unique identifier of the type of error. Enables quick recognition and categorization of the issue.",
15498
- enum: ["kwikset_unable_to_confirm_deletion"],
15499
- type: "string"
15500
- },
15501
- is_access_code_error: { enum: [true], type: "boolean" },
15502
- message: { type: "string" }
15503
- },
15504
- required: [
15505
- "message",
15506
- "is_access_code_error",
15507
- "error_code"
15508
- ],
15509
- type: "object"
15341
+ is_access_code_error: { enum: [true], type: "boolean" },
15342
+ message: { type: "string" }
15343
+ },
15344
+ required: ["message", "is_access_code_error", "error_code"],
15345
+ type: "object"
15346
+ },
15347
+ {
15348
+ description: "Unable to confirm the deletion of the access code on Kwikset device.",
15349
+ properties: {
15350
+ error_code: {
15351
+ description: "Unique identifier of the type of error. Enables quick recognition and categorization of the issue.",
15352
+ enum: ["kwikset_unable_to_confirm_deletion"],
15353
+ type: "string"
15510
15354
  },
15511
- {
15512
- description: "Code was modified or removed externally after Seam successfully set it on the device.",
15513
- properties: {
15514
- error_code: {
15515
- description: "Unique identifier of the type of error. Enables quick recognition and categorization of the issue.",
15516
- enum: ["code_modified_external_to_seam"],
15517
- type: "string"
15518
- },
15519
- is_access_code_error: { enum: [true], type: "boolean" },
15520
- message: { type: "string" }
15521
- },
15522
- required: [
15523
- "message",
15524
- "is_access_code_error",
15525
- "error_code"
15526
- ],
15527
- type: "object"
15355
+ is_access_code_error: { enum: [true], type: "boolean" },
15356
+ message: { type: "string" }
15357
+ },
15358
+ required: ["message", "is_access_code_error", "error_code"],
15359
+ type: "object"
15360
+ },
15361
+ {
15362
+ description: "Code was modified or removed externally after Seam successfully set it on the device.",
15363
+ properties: {
15364
+ error_code: {
15365
+ description: "Unique identifier of the type of error. Enables quick recognition and categorization of the issue.",
15366
+ enum: ["code_modified_external_to_seam"],
15367
+ type: "string"
15528
15368
  },
15529
- {
15530
- description: "Invalid code length for August lock.",
15531
- properties: {
15532
- error_code: {
15533
- description: "Unique identifier of the type of error. Enables quick recognition and categorization of the issue.",
15534
- enum: ["august_lock_invalid_code_length"],
15535
- type: "string"
15536
- },
15537
- is_access_code_error: { enum: [true], type: "boolean" },
15538
- message: { type: "string" }
15539
- },
15540
- required: [
15541
- "message",
15542
- "is_access_code_error",
15543
- "error_code"
15544
- ],
15545
- type: "object"
15369
+ is_access_code_error: { enum: [true], type: "boolean" },
15370
+ message: { type: "string" }
15371
+ },
15372
+ required: ["message", "is_access_code_error", "error_code"],
15373
+ type: "object"
15374
+ },
15375
+ {
15376
+ description: "Invalid code length for August lock.",
15377
+ properties: {
15378
+ error_code: {
15379
+ description: "Unique identifier of the type of error. Enables quick recognition and categorization of the issue.",
15380
+ enum: ["august_lock_invalid_code_length"],
15381
+ type: "string"
15546
15382
  },
15547
- {
15548
- description: "Access code has not yet been fully moved to the device.",
15549
- properties: {
15550
- error_code: {
15551
- description: "Unique identifier of the type of error. Enables quick recognition and categorization of the issue.",
15552
- enum: ["august_device_programming_delay"],
15553
- type: "string"
15554
- },
15555
- is_access_code_error: { enum: [true], type: "boolean" },
15556
- message: { type: "string" }
15557
- },
15558
- required: [
15559
- "message",
15560
- "is_access_code_error",
15561
- "error_code"
15562
- ],
15563
- type: "object"
15383
+ is_access_code_error: { enum: [true], type: "boolean" },
15384
+ message: { type: "string" }
15385
+ },
15386
+ required: ["message", "is_access_code_error", "error_code"],
15387
+ type: "object"
15388
+ },
15389
+ {
15390
+ description: "Access code has not yet been fully moved to the device.",
15391
+ properties: {
15392
+ error_code: {
15393
+ description: "Unique identifier of the type of error. Enables quick recognition and categorization of the issue.",
15394
+ enum: ["august_device_programming_delay"],
15395
+ type: "string"
15564
15396
  },
15565
- {
15566
- description: "All access code slots on the device are full.",
15567
- properties: {
15568
- error_code: {
15569
- description: "Unique identifier of the type of error. Enables quick recognition and categorization of the issue.",
15570
- enum: ["august_device_slots_full"],
15571
- type: "string"
15572
- },
15573
- is_access_code_error: { enum: [true], type: "boolean" },
15574
- message: { type: "string" }
15575
- },
15576
- required: [
15577
- "message",
15578
- "is_access_code_error",
15579
- "error_code"
15580
- ],
15581
- type: "object"
15397
+ is_access_code_error: { enum: [true], type: "boolean" },
15398
+ message: { type: "string" }
15399
+ },
15400
+ required: ["message", "is_access_code_error", "error_code"],
15401
+ type: "object"
15402
+ },
15403
+ {
15404
+ description: "All access code slots on the device are full.",
15405
+ properties: {
15406
+ error_code: {
15407
+ description: "Unique identifier of the type of error. Enables quick recognition and categorization of the issue.",
15408
+ enum: ["august_device_slots_full"],
15409
+ type: "string"
15582
15410
  },
15583
- {
15584
- description: "August lock is missing a keypad.",
15585
- properties: {
15586
- error_code: {
15587
- description: "Unique identifier of the type of error. Enables quick recognition and categorization of the issue.",
15588
- enum: ["august_lock_missing_keypad"],
15589
- type: "string"
15590
- },
15591
- is_access_code_error: { enum: [true], type: "boolean" },
15592
- message: { type: "string" }
15593
- },
15594
- required: [
15595
- "message",
15596
- "is_access_code_error",
15597
- "error_code"
15598
- ],
15599
- type: "object"
15411
+ is_access_code_error: { enum: [true], type: "boolean" },
15412
+ message: { type: "string" }
15413
+ },
15414
+ required: ["message", "is_access_code_error", "error_code"],
15415
+ type: "object"
15416
+ },
15417
+ {
15418
+ description: "August lock is missing a keypad.",
15419
+ properties: {
15420
+ error_code: {
15421
+ description: "Unique identifier of the type of error. Enables quick recognition and categorization of the issue.",
15422
+ enum: ["august_lock_missing_keypad"],
15423
+ type: "string"
15600
15424
  },
15601
- {
15602
- description: "Salto site user is not subscribed.",
15603
- properties: {
15604
- error_code: {
15605
- description: "Unique identifier of the type of error. Enables quick recognition and categorization of the issue.",
15606
- enum: ["salto_site_user_not_subscribed"],
15607
- type: "string"
15608
- },
15609
- is_access_code_error: { enum: [true], type: "boolean" },
15610
- message: { type: "string" }
15611
- },
15612
- required: [
15613
- "message",
15614
- "is_access_code_error",
15615
- "error_code"
15616
- ],
15617
- type: "object"
15425
+ is_access_code_error: { enum: [true], type: "boolean" },
15426
+ message: { type: "string" }
15427
+ },
15428
+ required: ["message", "is_access_code_error", "error_code"],
15429
+ type: "object"
15430
+ },
15431
+ {
15432
+ description: "Salto site user is not subscribed.",
15433
+ properties: {
15434
+ error_code: {
15435
+ description: "Unique identifier of the type of error. Enables quick recognition and categorization of the issue.",
15436
+ enum: ["salto_site_user_not_subscribed"],
15437
+ type: "string"
15618
15438
  },
15619
- {
15620
- description: "Access code has not yet been fully moved to the device.",
15621
- properties: {
15622
- error_code: {
15623
- description: "Unique identifier of the type of error. Enables quick recognition and categorization of the issue.",
15624
- enum: ["hubitat_device_programming_delay"],
15625
- type: "string"
15626
- },
15627
- is_access_code_error: { enum: [true], type: "boolean" },
15628
- message: { type: "string" }
15629
- },
15630
- required: [
15631
- "message",
15632
- "is_access_code_error",
15633
- "error_code"
15634
- ],
15635
- type: "object"
15439
+ is_access_code_error: { enum: [true], type: "boolean" },
15440
+ message: { type: "string" }
15441
+ },
15442
+ required: ["message", "is_access_code_error", "error_code"],
15443
+ type: "object"
15444
+ },
15445
+ {
15446
+ description: "Access code has not yet been fully moved to the device.",
15447
+ properties: {
15448
+ error_code: {
15449
+ description: "Unique identifier of the type of error. Enables quick recognition and categorization of the issue.",
15450
+ enum: ["hubitat_device_programming_delay"],
15451
+ type: "string"
15636
15452
  },
15637
- {
15638
- description: "No free positions available on the device.",
15639
- properties: {
15640
- error_code: {
15641
- description: "Unique identifier of the type of error. Enables quick recognition and categorization of the issue.",
15642
- enum: ["hubitat_no_free_positions_available"],
15643
- type: "string"
15644
- },
15645
- is_access_code_error: { enum: [true], type: "boolean" },
15646
- message: { type: "string" }
15647
- },
15648
- required: [
15649
- "message",
15650
- "is_access_code_error",
15651
- "error_code"
15652
- ],
15653
- type: "object"
15654
- }
15655
- ]
15453
+ is_access_code_error: { enum: [true], type: "boolean" },
15454
+ message: { type: "string" }
15455
+ },
15456
+ required: ["message", "is_access_code_error", "error_code"],
15457
+ type: "object"
15656
15458
  },
15657
15459
  {
15658
- description: "Error associated with the `device`.",
15659
- oneOf: [
15660
- {
15661
- description: "Device is offline",
15662
- properties: {
15663
- error_code: {
15664
- description: "Unique identifier of the type of error. Enables quick recognition and categorization of the issue.",
15665
- enum: ["device_offline"],
15666
- type: "string"
15667
- },
15668
- is_device_error: { enum: [true], type: "boolean" },
15669
- message: { type: "string" }
15670
- },
15671
- required: ["message", "is_device_error", "error_code"],
15672
- type: "object"
15460
+ description: "No free positions available on the device.",
15461
+ properties: {
15462
+ error_code: {
15463
+ description: "Unique identifier of the type of error. Enables quick recognition and categorization of the issue.",
15464
+ enum: ["hubitat_no_free_positions_available"],
15465
+ type: "string"
15673
15466
  },
15674
- {
15675
- description: "Device has been removed",
15676
- properties: {
15677
- error_code: {
15678
- description: "Unique identifier of the type of error. Enables quick recognition and categorization of the issue.",
15679
- enum: ["device_removed"],
15680
- type: "string"
15681
- },
15682
- is_device_error: { enum: [true], type: "boolean" },
15683
- message: { type: "string" }
15684
- },
15685
- required: ["message", "is_device_error", "error_code"],
15686
- type: "object"
15467
+ is_access_code_error: { enum: [true], type: "boolean" },
15468
+ message: { type: "string" }
15469
+ },
15470
+ required: ["message", "is_access_code_error", "error_code"],
15471
+ type: "object"
15472
+ },
15473
+ {
15474
+ description: "Device is offline",
15475
+ properties: {
15476
+ error_code: {
15477
+ description: "Unique identifier of the type of error. Enables quick recognition and categorization of the issue.",
15478
+ enum: ["device_offline"],
15479
+ type: "string"
15687
15480
  },
15688
- {
15689
- description: "Account is disconnected",
15690
- properties: {
15691
- error_code: {
15692
- description: "Unique identifier of the type of error. Enables quick recognition and categorization of the issue.",
15693
- enum: ["account_disconnected"],
15694
- type: "string"
15695
- },
15696
- is_device_error: { enum: [true], type: "boolean" },
15697
- message: { type: "string" }
15698
- },
15699
- required: ["message", "is_device_error", "error_code"],
15700
- type: "object"
15481
+ is_device_error: { enum: [true], type: "boolean" },
15482
+ message: { type: "string" }
15483
+ },
15484
+ required: ["message", "is_device_error", "error_code"],
15485
+ type: "object"
15486
+ },
15487
+ {
15488
+ description: "Device has been removed",
15489
+ properties: {
15490
+ error_code: {
15491
+ description: "Unique identifier of the type of error. Enables quick recognition and categorization of the issue.",
15492
+ enum: ["device_removed"],
15493
+ type: "string"
15701
15494
  },
15702
- {
15703
- description: "Hub is disconnected",
15704
- properties: {
15705
- error_code: {
15706
- description: "Unique identifier of the type of error. Enables quick recognition and categorization of the issue.",
15707
- enum: ["hub_disconnected"],
15708
- type: "string"
15709
- },
15710
- is_device_error: { enum: [true], type: "boolean" },
15711
- message: { type: "string" }
15712
- },
15713
- required: ["message", "is_device_error", "error_code"],
15714
- type: "object"
15495
+ is_device_error: { enum: [true], type: "boolean" },
15496
+ message: { type: "string" }
15497
+ },
15498
+ required: ["message", "is_device_error", "error_code"],
15499
+ type: "object"
15500
+ },
15501
+ {
15502
+ description: "Hub is disconnected",
15503
+ properties: {
15504
+ error_code: {
15505
+ description: "Unique identifier of the type of error. Enables quick recognition and categorization of the issue.",
15506
+ enum: ["hub_disconnected"],
15507
+ type: "string"
15715
15508
  },
15716
- {
15717
- description: "Device is disconnected",
15718
- properties: {
15719
- error_code: {
15720
- description: "Unique identifier of the type of error. Enables quick recognition and categorization of the issue.",
15721
- enum: ["device_disconnected"],
15722
- type: "string"
15723
- },
15724
- is_device_error: { enum: [true], type: "boolean" },
15725
- message: { type: "string" }
15726
- },
15727
- required: ["message", "is_device_error", "error_code"],
15728
- type: "object"
15509
+ is_device_error: { enum: [true], type: "boolean" },
15510
+ message: { type: "string" }
15511
+ },
15512
+ required: ["message", "is_device_error", "error_code"],
15513
+ type: "object"
15514
+ },
15515
+ {
15516
+ description: "Device is disconnected",
15517
+ properties: {
15518
+ error_code: {
15519
+ description: "Unique identifier of the type of error. Enables quick recognition and categorization of the issue.",
15520
+ enum: ["device_disconnected"],
15521
+ type: "string"
15729
15522
  },
15730
- {
15731
- description: "The backup access code pool is empty.",
15732
- properties: {
15733
- error_code: {
15734
- description: "Unique identifier of the type of error. Enables quick recognition and categorization of the issue.",
15735
- enum: ["empty_backup_access_code_pool"],
15736
- type: "string"
15737
- },
15738
- is_device_error: { enum: [true], type: "boolean" },
15739
- message: { type: "string" }
15740
- },
15741
- required: ["message", "is_device_error", "error_code"],
15742
- type: "object"
15523
+ is_device_error: { enum: [true], type: "boolean" },
15524
+ message: { type: "string" }
15525
+ },
15526
+ required: ["message", "is_device_error", "error_code"],
15527
+ type: "object"
15528
+ },
15529
+ {
15530
+ description: "The backup access code pool is empty.",
15531
+ properties: {
15532
+ error_code: {
15533
+ description: "Unique identifier of the type of error. Enables quick recognition and categorization of the issue.",
15534
+ enum: ["empty_backup_access_code_pool"],
15535
+ type: "string"
15743
15536
  },
15744
- {
15745
- description: "User is not authorized to use the August Lock.",
15746
- properties: {
15747
- error_code: {
15748
- description: "Unique identifier of the type of error. Enables quick recognition and categorization of the issue.",
15749
- enum: ["august_lock_not_authorized"],
15750
- type: "string"
15751
- },
15752
- is_device_error: { enum: [true], type: "boolean" },
15753
- message: { type: "string" }
15754
- },
15755
- required: ["message", "is_device_error", "error_code"],
15756
- type: "object"
15537
+ is_device_error: { enum: [true], type: "boolean" },
15538
+ message: { type: "string" }
15539
+ },
15540
+ required: ["message", "is_device_error", "error_code"],
15541
+ type: "object"
15542
+ },
15543
+ {
15544
+ description: "User is not authorized to use the August Lock.",
15545
+ properties: {
15546
+ error_code: {
15547
+ description: "Unique identifier of the type of error. Enables quick recognition and categorization of the issue.",
15548
+ enum: ["august_lock_not_authorized"],
15549
+ type: "string"
15757
15550
  },
15758
- {
15759
- description: "Lock is not connected to the Seam Bridge.",
15760
- properties: {
15761
- error_code: {
15762
- description: "Unique identifier of the type of error. Enables quick recognition and categorization of the issue.",
15763
- enum: ["august_lock_missing_bridge"],
15764
- type: "string"
15765
- },
15766
- is_device_error: { enum: [true], type: "boolean" },
15767
- message: { type: "string" }
15768
- },
15769
- required: ["message", "is_device_error", "error_code"],
15770
- type: "object"
15551
+ is_device_error: { enum: [true], type: "boolean" },
15552
+ message: { type: "string" }
15553
+ },
15554
+ required: ["message", "is_device_error", "error_code"],
15555
+ type: "object"
15556
+ },
15557
+ {
15558
+ description: "Lock is not connected to the Seam Bridge.",
15559
+ properties: {
15560
+ error_code: {
15561
+ description: "Unique identifier of the type of error. Enables quick recognition and categorization of the issue.",
15562
+ enum: ["august_lock_missing_bridge"],
15563
+ type: "string"
15771
15564
  },
15772
- {
15773
- description: "Salto site user limit reached.",
15774
- properties: {
15775
- error_code: {
15776
- description: "Unique identifier of the type of error. Enables quick recognition and categorization of the issue.",
15777
- enum: ["salto_site_user_limit_reached"],
15778
- type: "string"
15779
- },
15780
- is_device_error: { enum: [true], type: "boolean" },
15781
- message: { type: "string" }
15782
- },
15783
- required: ["message", "is_device_error", "error_code"],
15784
- type: "object"
15565
+ is_device_error: { enum: [true], type: "boolean" },
15566
+ message: { type: "string" }
15567
+ },
15568
+ required: ["message", "is_device_error", "error_code"],
15569
+ type: "object"
15570
+ },
15571
+ {
15572
+ description: "Salto site user limit reached.",
15573
+ properties: {
15574
+ error_code: {
15575
+ description: "Unique identifier of the type of error. Enables quick recognition and categorization of the issue.",
15576
+ enum: ["salto_site_user_limit_reached"],
15577
+ type: "string"
15785
15578
  },
15786
- {
15787
- description: "Lock is not paired with a Gateway.",
15788
- properties: {
15789
- error_code: {
15790
- description: "Unique identifier of the type of error. Enables quick recognition and categorization of the issue.",
15791
- enum: ["ttlock_lock_not_paired_to_gateway"],
15792
- type: "string"
15793
- },
15794
- is_device_error: { enum: [true], type: "boolean" },
15795
- message: { type: "string" }
15796
- },
15797
- required: ["message", "is_device_error", "error_code"],
15798
- type: "object"
15579
+ is_device_error: { enum: [true], type: "boolean" },
15580
+ message: { type: "string" }
15581
+ },
15582
+ required: ["message", "is_device_error", "error_code"],
15583
+ type: "object"
15584
+ },
15585
+ {
15586
+ description: "Lock is not paired with a Gateway.",
15587
+ properties: {
15588
+ error_code: {
15589
+ description: "Unique identifier of the type of error. Enables quick recognition and categorization of the issue.",
15590
+ enum: ["ttlock_lock_not_paired_to_gateway"],
15591
+ type: "string"
15799
15592
  },
15800
- {
15801
- description: "Missing device credentials.",
15802
- properties: {
15803
- error_code: {
15804
- description: "Unique identifier of the type of error. Enables quick recognition and categorization of the issue.",
15805
- enum: ["missing_device_credentials"],
15806
- type: "string"
15807
- },
15808
- is_device_error: { enum: [true], type: "boolean" },
15809
- message: { type: "string" }
15810
- },
15811
- required: ["message", "is_device_error", "error_code"],
15812
- type: "object"
15593
+ is_device_error: { enum: [true], type: "boolean" },
15594
+ message: { type: "string" }
15595
+ },
15596
+ required: ["message", "is_device_error", "error_code"],
15597
+ type: "object"
15598
+ },
15599
+ {
15600
+ description: "Missing device credentials.",
15601
+ properties: {
15602
+ error_code: {
15603
+ description: "Unique identifier of the type of error. Enables quick recognition and categorization of the issue.",
15604
+ enum: ["missing_device_credentials"],
15605
+ type: "string"
15813
15606
  },
15814
- {
15815
- description: "The auxiliary heat is running.",
15816
- properties: {
15817
- error_code: {
15818
- description: "Unique identifier of the type of error. Enables quick recognition and categorization of the issue.",
15819
- enum: ["auxiliary_heat_running"],
15820
- type: "string"
15821
- },
15822
- is_device_error: { enum: [true], type: "boolean" },
15823
- message: { type: "string" }
15824
- },
15825
- required: ["message", "is_device_error", "error_code"],
15826
- type: "object"
15607
+ is_device_error: { enum: [true], type: "boolean" },
15608
+ message: { type: "string" }
15609
+ },
15610
+ required: ["message", "is_device_error", "error_code"],
15611
+ type: "object"
15612
+ },
15613
+ {
15614
+ description: "The auxiliary heat is running.",
15615
+ properties: {
15616
+ error_code: {
15617
+ description: "Unique identifier of the type of error. Enables quick recognition and categorization of the issue.",
15618
+ enum: ["auxiliary_heat_running"],
15619
+ type: "string"
15827
15620
  },
15828
- {
15829
- description: "Subscription required to connect.",
15830
- properties: {
15831
- error_code: {
15832
- description: "Unique identifier of the type of error. Enables quick recognition and categorization of the issue.",
15833
- enum: ["subscription_required"],
15834
- type: "string"
15835
- },
15836
- is_device_error: { enum: [true], type: "boolean" },
15837
- message: { type: "string" }
15838
- },
15839
- required: ["message", "is_device_error", "error_code"],
15840
- type: "object"
15841
- }
15842
- ]
15621
+ is_device_error: { enum: [true], type: "boolean" },
15622
+ message: { type: "string" }
15623
+ },
15624
+ required: ["message", "is_device_error", "error_code"],
15625
+ type: "object"
15843
15626
  },
15844
15627
  {
15845
- oneOf: [
15846
- {
15847
- description: "Account is disconnected.",
15848
- properties: {
15849
- error_code: {
15850
- description: "Unique identifier of the type of warning. Enables quick recognition and categorization of the issue.",
15851
- enum: ["account_disconnected"],
15852
- type: "string"
15853
- },
15854
- is_connected_account_error: {
15855
- enum: [true],
15856
- type: "boolean"
15857
- },
15858
- message: { type: "string" }
15859
- },
15860
- required: [
15861
- "message",
15862
- "is_connected_account_error",
15863
- "error_code"
15864
- ],
15865
- type: "object"
15628
+ description: "Subscription required to connect.",
15629
+ properties: {
15630
+ error_code: {
15631
+ description: "Unique identifier of the type of error. Enables quick recognition and categorization of the issue.",
15632
+ enum: ["subscription_required"],
15633
+ type: "string"
15866
15634
  },
15867
- {
15868
- description: "Credentials provided were invalid.",
15869
- properties: {
15870
- error_code: {
15871
- description: "Unique identifier of the type of warning. Enables quick recognition and categorization of the issue.",
15872
- enum: ["invalid_credentials"],
15873
- type: "string"
15874
- },
15875
- is_connected_account_error: {
15876
- enum: [true],
15877
- type: "boolean"
15878
- },
15879
- message: { type: "string" }
15880
- },
15881
- required: [
15882
- "message",
15883
- "is_connected_account_error",
15884
- "error_code"
15885
- ],
15886
- type: "object"
15887
- }
15888
- ]
15635
+ is_device_error: { enum: [true], type: "boolean" },
15636
+ message: { type: "string" }
15637
+ },
15638
+ required: ["message", "is_device_error", "error_code"],
15639
+ type: "object"
15640
+ },
15641
+ {
15642
+ description: "Account is disconnected.",
15643
+ properties: {
15644
+ error_code: {
15645
+ description: "Unique identifier of the type of error. Enables quick recognition and categorization of the issue.",
15646
+ enum: ["account_disconnected"],
15647
+ type: "string"
15648
+ },
15649
+ is_connected_account_error: {
15650
+ enum: [true],
15651
+ type: "boolean"
15652
+ },
15653
+ message: { type: "string" }
15654
+ },
15655
+ required: [
15656
+ "message",
15657
+ "is_connected_account_error",
15658
+ "error_code"
15659
+ ],
15660
+ type: "object"
15661
+ },
15662
+ {
15663
+ description: "Credentials provided were invalid.",
15664
+ properties: {
15665
+ error_code: {
15666
+ description: "Unique identifier of the type of error. Enables quick recognition and categorization of the issue.",
15667
+ enum: ["invalid_credentials"],
15668
+ type: "string"
15669
+ },
15670
+ is_connected_account_error: {
15671
+ enum: [true],
15672
+ type: "boolean"
15673
+ },
15674
+ message: { type: "string" }
15675
+ },
15676
+ required: [
15677
+ "message",
15678
+ "is_connected_account_error",
15679
+ "error_code"
15680
+ ],
15681
+ type: "object"
15889
15682
  }
15890
15683
  ]
15891
15684
  },
@@ -15912,6 +15705,7 @@ var openapi_default = {
15912
15705
  warnings: {
15913
15706
  description: 'Collection of warnings associated with the access code, structured in a dictionary format. A unique "warning_code" keys each warning. Each warning entry is an object containing two fields: "message" and "created_at." "message" is a string that describes the warning. "created_at" is a date that indicates when the warning was generated. This structure enables detailed tracking and timely response to potential issues that are not critical but that may require attention.',
15914
15707
  items: {
15708
+ discriminator: { propertyName: "warning_code" },
15915
15709
  oneOf: [
15916
15710
  {
15917
15711
  description: "Failed to set code on Smart Things device.",
@@ -15952,6 +15746,19 @@ var openapi_default = {
15952
15746
  required: ["message", "warning_code"],
15953
15747
  type: "object"
15954
15748
  },
15749
+ {
15750
+ description: "Lock is in Office Mode. Access Codes will not unlock doors.",
15751
+ properties: {
15752
+ message: { type: "string" },
15753
+ warning_code: {
15754
+ description: "Unique identifier of the type of warning. Enables quick recognition and categorization of the issue.",
15755
+ enum: ["salto_office_mode"],
15756
+ type: "string"
15757
+ }
15758
+ },
15759
+ required: ["message", "warning_code"],
15760
+ type: "object"
15761
+ },
15955
15762
  {
15956
15763
  description: "Code was modified or removed externally after Seam successfully set it on the device.",
15957
15764
  properties: {
@@ -16311,6 +16118,7 @@ var openapi_default = {
16311
16118
  description: "Warnings associated with the `acs_credential`.",
16312
16119
  items: {
16313
16120
  description: "Warning associated with the `acs_credential`.",
16121
+ discriminator: { propertyName: "warning_code" },
16314
16122
  oneOf: [
16315
16123
  {
16316
16124
  description: "Indicates that the credential is waiting to be issued.",
@@ -16517,6 +16325,7 @@ var openapi_default = {
16517
16325
  description: "Errors associated with the `acs_user`.",
16518
16326
  items: {
16519
16327
  description: "Error associated with the `acs_user`.",
16328
+ discriminator: { propertyName: "error_code" },
16520
16329
  oneOf: [
16521
16330
  {
16522
16331
  description: "Indicates that the ACS user was deleted from the ACS system outside of Seam.",
@@ -16687,6 +16496,7 @@ var openapi_default = {
16687
16496
  description: "Warnings associated with the `acs_user`.",
16688
16497
  items: {
16689
16498
  description: "Warning associated with the `acs_user`.",
16499
+ discriminator: { propertyName: "warning_code" },
16690
16500
  oneOf: [
16691
16501
  {
16692
16502
  description: "Indicates that the user is being deleted from the ACS system. This is a temporary state, and the user will be deleted shortly.",
@@ -16844,239 +16654,217 @@ var openapi_default = {
16844
16654
  errors: {
16845
16655
  description: 'Array of errors associated with the device. Each error object within the array contains two fields: "error_code" and "message." "error_code" is a string that uniquely identifies the type of error, enabling quick recognition and categorization of the issue. "message" provides a more detailed description of the error, offering insights into the issue and potentially how to rectify it.',
16846
16656
  items: {
16657
+ discriminator: { propertyName: "error_code" },
16847
16658
  oneOf: [
16848
16659
  {
16849
- description: "Error associated with the `device`.",
16850
- oneOf: [
16851
- {
16852
- description: "Device is offline",
16853
- properties: {
16854
- error_code: {
16855
- description: "Unique identifier of the type of error. Enables quick recognition and categorization of the issue.",
16856
- enum: ["device_offline"],
16857
- type: "string"
16858
- },
16859
- is_device_error: { enum: [true], type: "boolean" },
16860
- message: { type: "string" }
16861
- },
16862
- required: ["message", "is_device_error", "error_code"],
16863
- type: "object"
16660
+ description: "Device is offline",
16661
+ properties: {
16662
+ error_code: {
16663
+ description: "Unique identifier of the type of error. Enables quick recognition and categorization of the issue.",
16664
+ enum: ["device_offline"],
16665
+ type: "string"
16864
16666
  },
16865
- {
16866
- description: "Device has been removed",
16867
- properties: {
16868
- error_code: {
16869
- description: "Unique identifier of the type of error. Enables quick recognition and categorization of the issue.",
16870
- enum: ["device_removed"],
16871
- type: "string"
16872
- },
16873
- is_device_error: { enum: [true], type: "boolean" },
16874
- message: { type: "string" }
16875
- },
16876
- required: ["message", "is_device_error", "error_code"],
16877
- type: "object"
16667
+ is_device_error: { enum: [true], type: "boolean" },
16668
+ message: { type: "string" }
16669
+ },
16670
+ required: ["message", "is_device_error", "error_code"],
16671
+ type: "object"
16672
+ },
16673
+ {
16674
+ description: "Device has been removed",
16675
+ properties: {
16676
+ error_code: {
16677
+ description: "Unique identifier of the type of error. Enables quick recognition and categorization of the issue.",
16678
+ enum: ["device_removed"],
16679
+ type: "string"
16878
16680
  },
16879
- {
16880
- description: "Account is disconnected",
16881
- properties: {
16882
- error_code: {
16883
- description: "Unique identifier of the type of error. Enables quick recognition and categorization of the issue.",
16884
- enum: ["account_disconnected"],
16885
- type: "string"
16886
- },
16887
- is_device_error: { enum: [true], type: "boolean" },
16888
- message: { type: "string" }
16889
- },
16890
- required: ["message", "is_device_error", "error_code"],
16891
- type: "object"
16681
+ is_device_error: { enum: [true], type: "boolean" },
16682
+ message: { type: "string" }
16683
+ },
16684
+ required: ["message", "is_device_error", "error_code"],
16685
+ type: "object"
16686
+ },
16687
+ {
16688
+ description: "Hub is disconnected",
16689
+ properties: {
16690
+ error_code: {
16691
+ description: "Unique identifier of the type of error. Enables quick recognition and categorization of the issue.",
16692
+ enum: ["hub_disconnected"],
16693
+ type: "string"
16892
16694
  },
16893
- {
16894
- description: "Hub is disconnected",
16895
- properties: {
16896
- error_code: {
16897
- description: "Unique identifier of the type of error. Enables quick recognition and categorization of the issue.",
16898
- enum: ["hub_disconnected"],
16899
- type: "string"
16900
- },
16901
- is_device_error: { enum: [true], type: "boolean" },
16902
- message: { type: "string" }
16903
- },
16904
- required: ["message", "is_device_error", "error_code"],
16905
- type: "object"
16695
+ is_device_error: { enum: [true], type: "boolean" },
16696
+ message: { type: "string" }
16697
+ },
16698
+ required: ["message", "is_device_error", "error_code"],
16699
+ type: "object"
16700
+ },
16701
+ {
16702
+ description: "Device is disconnected",
16703
+ properties: {
16704
+ error_code: {
16705
+ description: "Unique identifier of the type of error. Enables quick recognition and categorization of the issue.",
16706
+ enum: ["device_disconnected"],
16707
+ type: "string"
16906
16708
  },
16907
- {
16908
- description: "Device is disconnected",
16909
- properties: {
16910
- error_code: {
16911
- description: "Unique identifier of the type of error. Enables quick recognition and categorization of the issue.",
16912
- enum: ["device_disconnected"],
16913
- type: "string"
16914
- },
16915
- is_device_error: { enum: [true], type: "boolean" },
16916
- message: { type: "string" }
16917
- },
16918
- required: ["message", "is_device_error", "error_code"],
16919
- type: "object"
16709
+ is_device_error: { enum: [true], type: "boolean" },
16710
+ message: { type: "string" }
16711
+ },
16712
+ required: ["message", "is_device_error", "error_code"],
16713
+ type: "object"
16714
+ },
16715
+ {
16716
+ description: "The backup access code pool is empty.",
16717
+ properties: {
16718
+ error_code: {
16719
+ description: "Unique identifier of the type of error. Enables quick recognition and categorization of the issue.",
16720
+ enum: ["empty_backup_access_code_pool"],
16721
+ type: "string"
16920
16722
  },
16921
- {
16922
- description: "The backup access code pool is empty.",
16923
- properties: {
16924
- error_code: {
16925
- description: "Unique identifier of the type of error. Enables quick recognition and categorization of the issue.",
16926
- enum: ["empty_backup_access_code_pool"],
16927
- type: "string"
16928
- },
16929
- is_device_error: { enum: [true], type: "boolean" },
16930
- message: { type: "string" }
16931
- },
16932
- required: ["message", "is_device_error", "error_code"],
16933
- type: "object"
16723
+ is_device_error: { enum: [true], type: "boolean" },
16724
+ message: { type: "string" }
16725
+ },
16726
+ required: ["message", "is_device_error", "error_code"],
16727
+ type: "object"
16728
+ },
16729
+ {
16730
+ description: "User is not authorized to use the August Lock.",
16731
+ properties: {
16732
+ error_code: {
16733
+ description: "Unique identifier of the type of error. Enables quick recognition and categorization of the issue.",
16734
+ enum: ["august_lock_not_authorized"],
16735
+ type: "string"
16934
16736
  },
16935
- {
16936
- description: "User is not authorized to use the August Lock.",
16937
- properties: {
16938
- error_code: {
16939
- description: "Unique identifier of the type of error. Enables quick recognition and categorization of the issue.",
16940
- enum: ["august_lock_not_authorized"],
16941
- type: "string"
16942
- },
16943
- is_device_error: { enum: [true], type: "boolean" },
16944
- message: { type: "string" }
16945
- },
16946
- required: ["message", "is_device_error", "error_code"],
16947
- type: "object"
16737
+ is_device_error: { enum: [true], type: "boolean" },
16738
+ message: { type: "string" }
16739
+ },
16740
+ required: ["message", "is_device_error", "error_code"],
16741
+ type: "object"
16742
+ },
16743
+ {
16744
+ description: "Lock is not connected to the Seam Bridge.",
16745
+ properties: {
16746
+ error_code: {
16747
+ description: "Unique identifier of the type of error. Enables quick recognition and categorization of the issue.",
16748
+ enum: ["august_lock_missing_bridge"],
16749
+ type: "string"
16948
16750
  },
16949
- {
16950
- description: "Lock is not connected to the Seam Bridge.",
16951
- properties: {
16952
- error_code: {
16953
- description: "Unique identifier of the type of error. Enables quick recognition and categorization of the issue.",
16954
- enum: ["august_lock_missing_bridge"],
16955
- type: "string"
16956
- },
16957
- is_device_error: { enum: [true], type: "boolean" },
16958
- message: { type: "string" }
16959
- },
16960
- required: ["message", "is_device_error", "error_code"],
16961
- type: "object"
16751
+ is_device_error: { enum: [true], type: "boolean" },
16752
+ message: { type: "string" }
16753
+ },
16754
+ required: ["message", "is_device_error", "error_code"],
16755
+ type: "object"
16756
+ },
16757
+ {
16758
+ description: "Salto site user limit reached.",
16759
+ properties: {
16760
+ error_code: {
16761
+ description: "Unique identifier of the type of error. Enables quick recognition and categorization of the issue.",
16762
+ enum: ["salto_site_user_limit_reached"],
16763
+ type: "string"
16962
16764
  },
16963
- {
16964
- description: "Salto site user limit reached.",
16965
- properties: {
16966
- error_code: {
16967
- description: "Unique identifier of the type of error. Enables quick recognition and categorization of the issue.",
16968
- enum: ["salto_site_user_limit_reached"],
16969
- type: "string"
16970
- },
16971
- is_device_error: { enum: [true], type: "boolean" },
16972
- message: { type: "string" }
16973
- },
16974
- required: ["message", "is_device_error", "error_code"],
16975
- type: "object"
16765
+ is_device_error: { enum: [true], type: "boolean" },
16766
+ message: { type: "string" }
16767
+ },
16768
+ required: ["message", "is_device_error", "error_code"],
16769
+ type: "object"
16770
+ },
16771
+ {
16772
+ description: "Lock is not paired with a Gateway.",
16773
+ properties: {
16774
+ error_code: {
16775
+ description: "Unique identifier of the type of error. Enables quick recognition and categorization of the issue.",
16776
+ enum: ["ttlock_lock_not_paired_to_gateway"],
16777
+ type: "string"
16976
16778
  },
16977
- {
16978
- description: "Lock is not paired with a Gateway.",
16979
- properties: {
16980
- error_code: {
16981
- description: "Unique identifier of the type of error. Enables quick recognition and categorization of the issue.",
16982
- enum: ["ttlock_lock_not_paired_to_gateway"],
16983
- type: "string"
16984
- },
16985
- is_device_error: { enum: [true], type: "boolean" },
16986
- message: { type: "string" }
16987
- },
16988
- required: ["message", "is_device_error", "error_code"],
16989
- type: "object"
16779
+ is_device_error: { enum: [true], type: "boolean" },
16780
+ message: { type: "string" }
16781
+ },
16782
+ required: ["message", "is_device_error", "error_code"],
16783
+ type: "object"
16784
+ },
16785
+ {
16786
+ description: "Missing device credentials.",
16787
+ properties: {
16788
+ error_code: {
16789
+ description: "Unique identifier of the type of error. Enables quick recognition and categorization of the issue.",
16790
+ enum: ["missing_device_credentials"],
16791
+ type: "string"
16990
16792
  },
16991
- {
16992
- description: "Missing device credentials.",
16993
- properties: {
16994
- error_code: {
16995
- description: "Unique identifier of the type of error. Enables quick recognition and categorization of the issue.",
16996
- enum: ["missing_device_credentials"],
16997
- type: "string"
16998
- },
16999
- is_device_error: { enum: [true], type: "boolean" },
17000
- message: { type: "string" }
17001
- },
17002
- required: ["message", "is_device_error", "error_code"],
17003
- type: "object"
16793
+ is_device_error: { enum: [true], type: "boolean" },
16794
+ message: { type: "string" }
16795
+ },
16796
+ required: ["message", "is_device_error", "error_code"],
16797
+ type: "object"
16798
+ },
16799
+ {
16800
+ description: "The auxiliary heat is running.",
16801
+ properties: {
16802
+ error_code: {
16803
+ description: "Unique identifier of the type of error. Enables quick recognition and categorization of the issue.",
16804
+ enum: ["auxiliary_heat_running"],
16805
+ type: "string"
17004
16806
  },
17005
- {
17006
- description: "The auxiliary heat is running.",
17007
- properties: {
17008
- error_code: {
17009
- description: "Unique identifier of the type of error. Enables quick recognition and categorization of the issue.",
17010
- enum: ["auxiliary_heat_running"],
17011
- type: "string"
17012
- },
17013
- is_device_error: { enum: [true], type: "boolean" },
17014
- message: { type: "string" }
17015
- },
17016
- required: ["message", "is_device_error", "error_code"],
17017
- type: "object"
16807
+ is_device_error: { enum: [true], type: "boolean" },
16808
+ message: { type: "string" }
16809
+ },
16810
+ required: ["message", "is_device_error", "error_code"],
16811
+ type: "object"
16812
+ },
16813
+ {
16814
+ description: "Subscription required to connect.",
16815
+ properties: {
16816
+ error_code: {
16817
+ description: "Unique identifier of the type of error. Enables quick recognition and categorization of the issue.",
16818
+ enum: ["subscription_required"],
16819
+ type: "string"
17018
16820
  },
17019
- {
17020
- description: "Subscription required to connect.",
17021
- properties: {
17022
- error_code: {
17023
- description: "Unique identifier of the type of error. Enables quick recognition and categorization of the issue.",
17024
- enum: ["subscription_required"],
17025
- type: "string"
17026
- },
17027
- is_device_error: { enum: [true], type: "boolean" },
17028
- message: { type: "string" }
17029
- },
17030
- required: ["message", "is_device_error", "error_code"],
17031
- type: "object"
17032
- }
17033
- ]
16821
+ is_device_error: { enum: [true], type: "boolean" },
16822
+ message: { type: "string" }
16823
+ },
16824
+ required: ["message", "is_device_error", "error_code"],
16825
+ type: "object"
17034
16826
  },
17035
16827
  {
17036
- oneOf: [
17037
- {
17038
- description: "Account is disconnected.",
17039
- properties: {
17040
- error_code: {
17041
- description: "Unique identifier of the type of warning. Enables quick recognition and categorization of the issue.",
17042
- enum: ["account_disconnected"],
17043
- type: "string"
17044
- },
17045
- is_connected_account_error: {
17046
- enum: [true],
17047
- type: "boolean"
17048
- },
17049
- message: { type: "string" }
17050
- },
17051
- required: [
17052
- "message",
17053
- "is_connected_account_error",
17054
- "error_code"
17055
- ],
17056
- type: "object"
16828
+ description: "Account is disconnected.",
16829
+ properties: {
16830
+ error_code: {
16831
+ description: "Unique identifier of the type of error. Enables quick recognition and categorization of the issue.",
16832
+ enum: ["account_disconnected"],
16833
+ type: "string"
17057
16834
  },
17058
- {
17059
- description: "Credentials provided were invalid.",
17060
- properties: {
17061
- error_code: {
17062
- description: "Unique identifier of the type of warning. Enables quick recognition and categorization of the issue.",
17063
- enum: ["invalid_credentials"],
17064
- type: "string"
17065
- },
17066
- is_connected_account_error: {
17067
- enum: [true],
17068
- type: "boolean"
17069
- },
17070
- message: { type: "string" }
17071
- },
17072
- required: [
17073
- "message",
17074
- "is_connected_account_error",
17075
- "error_code"
17076
- ],
17077
- type: "object"
17078
- }
17079
- ]
16835
+ is_connected_account_error: {
16836
+ enum: [true],
16837
+ type: "boolean"
16838
+ },
16839
+ message: { type: "string" }
16840
+ },
16841
+ required: [
16842
+ "message",
16843
+ "is_connected_account_error",
16844
+ "error_code"
16845
+ ],
16846
+ type: "object"
16847
+ },
16848
+ {
16849
+ description: "Credentials provided were invalid.",
16850
+ properties: {
16851
+ error_code: {
16852
+ description: "Unique identifier of the type of error. Enables quick recognition and categorization of the issue.",
16853
+ enum: ["invalid_credentials"],
16854
+ type: "string"
16855
+ },
16856
+ is_connected_account_error: {
16857
+ enum: [true],
16858
+ type: "boolean"
16859
+ },
16860
+ message: { type: "string" }
16861
+ },
16862
+ required: [
16863
+ "message",
16864
+ "is_connected_account_error",
16865
+ "error_code"
16866
+ ],
16867
+ type: "object"
17080
16868
  }
17081
16869
  ]
17082
16870
  },
@@ -17221,6 +17009,7 @@ var openapi_default = {
17221
17009
  warnings: {
17222
17010
  description: 'Array of warnings associated with the device. Each warning object within the array contains two fields: "warning_code" and "message." "warning_code" is a string that uniquely identifies the type of warning, enabling quick recognition and categorization of the issue. "message" provides a more detailed description of the warning, offering insights into the issue and potentially how to rectify it.',
17223
17011
  items: {
17012
+ discriminator: { propertyName: "warning_code" },
17224
17013
  oneOf: [
17225
17014
  {
17226
17015
  description: "Backup access code unhealthy.",