@seamapi/types 1.344.1 → 1.344.2

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 +1764 -2005
  2. package/dist/connect.cjs.map +1 -1
  3. package/dist/connect.d.cts +454 -633
  4. package/lib/seam/connect/models/access-codes/managed-access-code.d.ts +7 -28
  5. package/lib/seam/connect/models/access-codes/managed-access-code.js +7 -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 +5 -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 +1465 -1716
  30. package/lib/seam/connect/openapi.js.map +1 -1
  31. package/lib/seam/connect/route-types.d.ts +145 -275
  32. package/package.json +1 -1
  33. package/src/lib/seam/connect/models/access-codes/managed-access-code.ts +9 -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 +1566 -1829
  40. package/src/lib/seam/connect/route-types.ts +3216 -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,
@@ -1346,7 +1350,7 @@ var igloo_algopin_must_be_used_within_24_hours = common_access_code_warning.exte
1346
1350
  var management_transferred = common_access_code_warning.extend({
1347
1351
  warning_code: zod.z.literal("management_transferred").describe(warning_code_description3)
1348
1352
  }).describe("Management was transferred to another workspace.");
1349
- var access_code_warning = zod.z.union([
1353
+ var access_code_warning = zod.z.discriminatedUnion("warning_code", [
1350
1354
  smartthings_failed_to_set_access_code_warning,
1351
1355
  schlage_detected_duplicate,
1352
1356
  schlage_creation_outage,
@@ -1382,7 +1386,13 @@ var access_code = zod.z.object({
1382
1386
  "Code used for access. Typically, a numeric or alphanumeric string."
1383
1387
  ),
1384
1388
  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(
1389
+ errors: zod.z.array(
1390
+ zod.z.discriminatedUnion("error_code", [
1391
+ ...access_code_error.options,
1392
+ ...device_error.options,
1393
+ ...connected_account_error.options
1394
+ ])
1395
+ ).describe(
1386
1396
  '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
1397
  ),
1388
1398
  warnings: zod.z.array(access_code_warning).describe(
@@ -1618,7 +1628,7 @@ var needs_to_be_reissued = common_acs_credential_warning.extend({
1618
1628
  }).describe(
1619
1629
  "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
1630
  );
1621
- var acs_credential_warning = zod.z.union([
1631
+ var acs_credential_warning = zod.z.discriminatedUnion("warning_code", [
1622
1632
  waiting_to_be_issued,
1623
1633
  schedule_externally_modified,
1624
1634
  schedule_modified,
@@ -1850,7 +1860,7 @@ var acs_system_disconnected = common_acs_system_error.extend({
1850
1860
  }).describe(
1851
1861
  "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
1862
  );
1853
- var account_disconnected3 = common_acs_system_error.extend({
1863
+ var account_disconnected2 = common_acs_system_error.extend({
1854
1864
  error_code: zod.z.literal("account_disconnected").describe(error_code_description5)
1855
1865
  }).describe(
1856
1866
  "Indicates that the login credentials are invalid. Reconnect the account using the Connect Webview to restore access."
@@ -1860,12 +1870,12 @@ var salto_ks_certification_expired = common_acs_system_error.extend({
1860
1870
  "Indicates that the access system has lost its Salto KS certification. Please contact support to regain access."
1861
1871
  )
1862
1872
  });
1863
- var acs_system_error = zod.z.union([
1873
+ var acs_system_error = zod.z.discriminatedUnion("error_code", [
1864
1874
  seam_bridge_disconnected,
1865
1875
  visionline_instance_unreachable,
1866
1876
  salto_ks_subscription_limit_exceeded,
1867
1877
  acs_system_disconnected,
1868
- account_disconnected3,
1878
+ account_disconnected2,
1869
1879
  salto_ks_certification_expired
1870
1880
  ]).describe("Error associated with the `acs_system`.");
1871
1881
  zod.z.object({
@@ -1873,7 +1883,7 @@ zod.z.object({
1873
1883
  visionline_instance_unreachable: visionline_instance_unreachable.optional().nullable(),
1874
1884
  salto_ks_subscription_limit_exceeded: salto_ks_subscription_limit_exceeded.optional().nullable(),
1875
1885
  acs_system_disconnected: acs_system_disconnected.optional().nullable(),
1876
- account_disconnected: account_disconnected3.optional().nullable(),
1886
+ account_disconnected: account_disconnected2.optional().nullable(),
1877
1887
  salto_ks_certification_expired: salto_ks_certification_expired.optional().nullable()
1878
1888
  });
1879
1889
  var common_acs_system_warning = zod.z.object({
@@ -1893,7 +1903,7 @@ var time_zone_does_not_match_location = common_acs_system_warning.extend({
1893
1903
  ),
1894
1904
  misconfigured_acs_entrance_ids: zod.z.array(zod.z.string().uuid()).optional()
1895
1905
  });
1896
- var acs_system_warning = zod.z.union([
1906
+ var acs_system_warning = zod.z.discriminatedUnion("warning_code", [
1897
1907
  salto_ks_subscription_limit_almost_reached,
1898
1908
  time_zone_does_not_match_location
1899
1909
  ]).describe("Warning associated with the `acs_system`.");
@@ -2023,7 +2033,7 @@ var acs_users_failed_to_delete_on_acs_system = common_acs_user_error.extend({
2023
2033
  }).describe(
2024
2034
  `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
2035
  );
2026
- var acs_user_errors = zod.z.union([
2036
+ var acs_user_errors = zod.z.discriminatedUnion("error_code", [
2027
2037
  acs_users_deleted_externally,
2028
2038
  acs_users_salto_ks_subscription_limit_exceeded,
2029
2039
  acs_users_failed_to_create_on_acs_system,
@@ -2061,7 +2071,7 @@ zod.z.object({
2061
2071
  salto_ks_user_not_subscribed: acs_users_salto_ks_user_not_subscribed.optional().nullable(),
2062
2072
  unknown_issue_with_acs_user: unknown_issue_with_acs_user.optional().nullable()
2063
2073
  });
2064
- var acs_users_warnings = zod.z.union([
2074
+ var acs_users_warnings = zod.z.discriminatedUnion("warning_code", [
2065
2075
  acs_users_being_deleted,
2066
2076
  acs_users_salto_ks_user_not_subscribed,
2067
2077
  unknown_issue_with_acs_user
@@ -3610,730 +3620,564 @@ var openapi_default = {
3610
3620
  errors: {
3611
3621
  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
3622
  items: {
3623
+ discriminator: { propertyName: "error_code" },
3613
3624
  oneOf: [
3614
3625
  {
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"
3626
+ description: "Failed to set code on Smart Things device.",
3627
+ properties: {
3628
+ error_code: {
3629
+ description: "Unique identifier of the type of error. Enables quick recognition and categorization of the issue.",
3630
+ enum: ["smartthings_failed_to_set_access_code"],
3631
+ type: "string"
3633
3632
  },
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"
3633
+ is_access_code_error: { enum: [true], type: "boolean" },
3634
+ message: { type: "string" }
3635
+ },
3636
+ required: ["message", "is_access_code_error", "error_code"],
3637
+ type: "object"
3638
+ },
3639
+ {
3640
+ description: "Failed to set code after multiple retries.",
3641
+ properties: {
3642
+ error_code: {
3643
+ description: "Unique identifier of the type of error. Enables quick recognition and categorization of the issue.",
3644
+ enum: [
3645
+ "smartthings_failed_to_set_after_multiple_retries"
3651
3646
  ],
3652
- type: "object"
3647
+ type: "string"
3653
3648
  },
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"
3649
+ is_access_code_error: { enum: [true], type: "boolean" },
3650
+ message: { type: "string" }
3651
+ },
3652
+ required: ["message", "is_access_code_error", "error_code"],
3653
+ type: "object"
3654
+ },
3655
+ {
3656
+ description: "Failed to set code on device.",
3657
+ properties: {
3658
+ error_code: {
3659
+ description: "Unique identifier of the type of error. Enables quick recognition and categorization of the issue.",
3660
+ enum: ["failed_to_set_on_device"],
3661
+ type: "string"
3671
3662
  },
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"
3663
+ is_access_code_error: { enum: [true], type: "boolean" },
3664
+ message: { type: "string" }
3665
+ },
3666
+ required: ["message", "is_access_code_error", "error_code"],
3667
+ type: "object"
3668
+ },
3669
+ {
3670
+ description: "Failed to remove code from device.",
3671
+ properties: {
3672
+ error_code: {
3673
+ description: "Unique identifier of the type of error. Enables quick recognition and categorization of the issue.",
3674
+ enum: ["failed_to_remove_from_device"],
3675
+ type: "string"
3689
3676
  },
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"
3677
+ is_access_code_error: { enum: [true], type: "boolean" },
3678
+ message: { type: "string" }
3679
+ },
3680
+ required: ["message", "is_access_code_error", "error_code"],
3681
+ type: "object"
3682
+ },
3683
+ {
3684
+ description: "Duplicate access code detected on device.",
3685
+ properties: {
3686
+ error_code: {
3687
+ description: "Unique identifier of the type of error. Enables quick recognition and categorization of the issue.",
3688
+ enum: ["duplicate_code_on_device"],
3689
+ type: "string"
3707
3690
  },
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"
3691
+ is_access_code_error: { enum: [true], type: "boolean" },
3692
+ message: { type: "string" }
3693
+ },
3694
+ required: ["message", "is_access_code_error", "error_code"],
3695
+ type: "object"
3696
+ },
3697
+ {
3698
+ description: "An attempt to modify this access code was prevented.",
3699
+ properties: {
3700
+ error_code: {
3701
+ description: "Unique identifier of the type of error. Enables quick recognition and categorization of the issue.",
3702
+ enum: ["duplicate_code_attempt_prevented"],
3703
+ type: "string"
3725
3704
  },
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"
3705
+ is_access_code_error: { enum: [true], type: "boolean" },
3706
+ message: { type: "string" }
3707
+ },
3708
+ required: ["message", "is_access_code_error", "error_code"],
3709
+ type: "object"
3710
+ },
3711
+ {
3712
+ description: "Igloohome bridge has too many pending jobs in the queue.",
3713
+ properties: {
3714
+ error_code: {
3715
+ description: "Unique identifier of the type of error. Enables quick recognition and categorization of the issue.",
3716
+ enum: ["igloohome_bridge_too_many_pending_jobs"],
3717
+ type: "string"
3743
3718
  },
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"
3719
+ is_access_code_error: { enum: [true], type: "boolean" },
3720
+ message: { type: "string" }
3721
+ },
3722
+ required: ["message", "is_access_code_error", "error_code"],
3723
+ type: "object"
3724
+ },
3725
+ {
3726
+ description: "Igloohome bridge is offline.",
3727
+ properties: {
3728
+ error_code: {
3729
+ description: "Unique identifier of the type of error. Enables quick recognition and categorization of the issue.",
3730
+ enum: ["igloohome_bridge_offline"],
3731
+ type: "string"
3761
3732
  },
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"
3733
+ is_access_code_error: { enum: [true], type: "boolean" },
3734
+ message: { type: "string" }
3735
+ },
3736
+ required: ["message", "is_access_code_error", "error_code"],
3737
+ type: "object"
3738
+ },
3739
+ {
3740
+ description: "Lock as reached max amount of codes.",
3741
+ properties: {
3742
+ error_code: {
3743
+ description: "Unique identifier of the type of error. Enables quick recognition and categorization of the issue.",
3744
+ enum: [
3745
+ "igloohome_offline_access_code_no_variance_available"
3779
3746
  ],
3780
- type: "object"
3747
+ type: "string"
3781
3748
  },
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"
3749
+ is_access_code_error: { enum: [true], type: "boolean" },
3750
+ message: { type: "string" }
3751
+ },
3752
+ required: ["message", "is_access_code_error", "error_code"],
3753
+ type: "object"
3754
+ },
3755
+ {
3756
+ description: "Unable to confirm the access code is set on Kwikset device.",
3757
+ properties: {
3758
+ error_code: {
3759
+ description: "Unique identifier of the type of error. Enables quick recognition and categorization of the issue.",
3760
+ enum: ["kwikset_unable_to_confirm_code"],
3761
+ type: "string"
3799
3762
  },
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"
3763
+ is_access_code_error: { enum: [true], type: "boolean" },
3764
+ message: { type: "string" }
3765
+ },
3766
+ required: ["message", "is_access_code_error", "error_code"],
3767
+ type: "object"
3768
+ },
3769
+ {
3770
+ description: "Unable to confirm the deletion of the access code on Kwikset device.",
3771
+ properties: {
3772
+ error_code: {
3773
+ description: "Unique identifier of the type of error. Enables quick recognition and categorization of the issue.",
3774
+ enum: ["kwikset_unable_to_confirm_deletion"],
3775
+ type: "string"
3817
3776
  },
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"
3777
+ is_access_code_error: { enum: [true], type: "boolean" },
3778
+ message: { type: "string" }
3779
+ },
3780
+ required: ["message", "is_access_code_error", "error_code"],
3781
+ type: "object"
3782
+ },
3783
+ {
3784
+ description: "Code was modified or removed externally after Seam successfully set it on the device.",
3785
+ properties: {
3786
+ error_code: {
3787
+ description: "Unique identifier of the type of error. Enables quick recognition and categorization of the issue.",
3788
+ enum: ["code_modified_external_to_seam"],
3789
+ type: "string"
3835
3790
  },
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"
3791
+ is_access_code_error: { enum: [true], type: "boolean" },
3792
+ message: { type: "string" }
3793
+ },
3794
+ required: ["message", "is_access_code_error", "error_code"],
3795
+ type: "object"
3796
+ },
3797
+ {
3798
+ description: "Invalid code length for August lock.",
3799
+ properties: {
3800
+ error_code: {
3801
+ description: "Unique identifier of the type of error. Enables quick recognition and categorization of the issue.",
3802
+ enum: ["august_lock_invalid_code_length"],
3803
+ type: "string"
3853
3804
  },
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"
3805
+ is_access_code_error: { enum: [true], type: "boolean" },
3806
+ message: { type: "string" }
3807
+ },
3808
+ required: ["message", "is_access_code_error", "error_code"],
3809
+ type: "object"
3810
+ },
3811
+ {
3812
+ description: "Access code has not yet been fully moved to the device.",
3813
+ properties: {
3814
+ error_code: {
3815
+ description: "Unique identifier of the type of error. Enables quick recognition and categorization of the issue.",
3816
+ enum: ["august_device_programming_delay"],
3817
+ type: "string"
3871
3818
  },
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"
3819
+ is_access_code_error: { enum: [true], type: "boolean" },
3820
+ message: { type: "string" }
3821
+ },
3822
+ required: ["message", "is_access_code_error", "error_code"],
3823
+ type: "object"
3824
+ },
3825
+ {
3826
+ description: "All access code slots on the device are full.",
3827
+ properties: {
3828
+ error_code: {
3829
+ description: "Unique identifier of the type of error. Enables quick recognition and categorization of the issue.",
3830
+ enum: ["august_device_slots_full"],
3831
+ type: "string"
3889
3832
  },
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
- ]
3833
+ is_access_code_error: { enum: [true], type: "boolean" },
3834
+ message: { type: "string" }
3835
+ },
3836
+ required: ["message", "is_access_code_error", "error_code"],
3837
+ type: "object"
4150
3838
  },
4151
3839
  {
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.",
3840
+ description: "August lock is missing a keypad.",
4267
3841
  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"],
3842
+ error_code: {
3843
+ description: "Unique identifier of the type of error. Enables quick recognition and categorization of the issue.",
3844
+ enum: ["august_lock_missing_keypad"],
4272
3845
  type: "string"
4273
- }
3846
+ },
3847
+ is_access_code_error: { enum: [true], type: "boolean" },
3848
+ message: { type: "string" }
4274
3849
  },
4275
- required: ["message", "warning_code"],
3850
+ required: ["message", "is_access_code_error", "error_code"],
4276
3851
  type: "object"
4277
3852
  },
4278
3853
  {
4279
- description: "Duplicate access code detected.",
3854
+ description: "Salto site user is not subscribed.",
4280
3855
  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"],
3856
+ error_code: {
3857
+ description: "Unique identifier of the type of error. Enables quick recognition and categorization of the issue.",
3858
+ enum: ["salto_site_user_not_subscribed"],
4285
3859
  type: "string"
4286
- }
3860
+ },
3861
+ is_access_code_error: { enum: [true], type: "boolean" },
3862
+ message: { type: "string" }
4287
3863
  },
4288
- required: ["message", "warning_code"],
3864
+ required: ["message", "is_access_code_error", "error_code"],
4289
3865
  type: "object"
4290
3866
  },
4291
3867
  {
4292
- description: "Received an error when attempting to create this code.",
3868
+ description: "Access code has not yet been fully moved to the device.",
4293
3869
  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"],
3870
+ error_code: {
3871
+ description: "Unique identifier of the type of error. Enables quick recognition and categorization of the issue.",
3872
+ enum: ["hubitat_device_programming_delay"],
4298
3873
  type: "string"
4299
- }
3874
+ },
3875
+ is_access_code_error: { enum: [true], type: "boolean" },
3876
+ message: { type: "string" }
4300
3877
  },
4301
- required: ["message", "warning_code"],
3878
+ required: ["message", "is_access_code_error", "error_code"],
4302
3879
  type: "object"
4303
3880
  },
4304
3881
  {
4305
- description: "Code was modified or removed externally after Seam successfully set it on the device.",
3882
+ description: "No free positions available on the device.",
4306
3883
  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"],
3884
+ error_code: {
3885
+ description: "Unique identifier of the type of error. Enables quick recognition and categorization of the issue.",
3886
+ enum: ["hubitat_no_free_positions_available"],
4311
3887
  type: "string"
4312
- }
3888
+ },
3889
+ is_access_code_error: { enum: [true], type: "boolean" },
3890
+ message: { type: "string" }
4313
3891
  },
4314
- required: ["message", "warning_code"],
3892
+ required: ["message", "is_access_code_error", "error_code"],
4315
3893
  type: "object"
4316
3894
  },
4317
3895
  {
4318
- description: "Delay in setting code on device.",
3896
+ description: "Device is offline",
4319
3897
  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"],
3898
+ error_code: {
3899
+ description: "Unique identifier of the type of error. Enables quick recognition and categorization of the issue.",
3900
+ enum: ["device_offline"],
4324
3901
  type: "string"
4325
- }
3902
+ },
3903
+ is_device_error: { enum: [true], type: "boolean" },
3904
+ message: { type: "string" }
4326
3905
  },
4327
- required: ["message", "warning_code"],
3906
+ required: ["message", "is_device_error", "error_code"],
4328
3907
  type: "object"
4329
3908
  },
4330
3909
  {
4331
- description: "Delay in removing code from device.",
3910
+ description: "Device has been removed",
4332
3911
  properties: {
4333
- message: { type: "string" },
3912
+ error_code: {
3913
+ description: "Unique identifier of the type of error. Enables quick recognition and categorization of the issue.",
3914
+ enum: ["device_removed"],
3915
+ type: "string"
3916
+ },
3917
+ is_device_error: { enum: [true], type: "boolean" },
3918
+ message: { type: "string" }
3919
+ },
3920
+ required: ["message", "is_device_error", "error_code"],
3921
+ type: "object"
3922
+ },
3923
+ {
3924
+ description: "Hub is disconnected",
3925
+ properties: {
3926
+ error_code: {
3927
+ description: "Unique identifier of the type of error. Enables quick recognition and categorization of the issue.",
3928
+ enum: ["hub_disconnected"],
3929
+ type: "string"
3930
+ },
3931
+ is_device_error: { enum: [true], type: "boolean" },
3932
+ message: { type: "string" }
3933
+ },
3934
+ required: ["message", "is_device_error", "error_code"],
3935
+ type: "object"
3936
+ },
3937
+ {
3938
+ description: "Device is disconnected",
3939
+ properties: {
3940
+ error_code: {
3941
+ description: "Unique identifier of the type of error. Enables quick recognition and categorization of the issue.",
3942
+ enum: ["device_disconnected"],
3943
+ type: "string"
3944
+ },
3945
+ is_device_error: { enum: [true], type: "boolean" },
3946
+ message: { type: "string" }
3947
+ },
3948
+ required: ["message", "is_device_error", "error_code"],
3949
+ type: "object"
3950
+ },
3951
+ {
3952
+ description: "The backup access code pool is empty.",
3953
+ properties: {
3954
+ error_code: {
3955
+ description: "Unique identifier of the type of error. Enables quick recognition and categorization of the issue.",
3956
+ enum: ["empty_backup_access_code_pool"],
3957
+ type: "string"
3958
+ },
3959
+ is_device_error: { enum: [true], type: "boolean" },
3960
+ message: { type: "string" }
3961
+ },
3962
+ required: ["message", "is_device_error", "error_code"],
3963
+ type: "object"
3964
+ },
3965
+ {
3966
+ description: "User is not authorized to use the August Lock.",
3967
+ properties: {
3968
+ error_code: {
3969
+ description: "Unique identifier of the type of error. Enables quick recognition and categorization of the issue.",
3970
+ enum: ["august_lock_not_authorized"],
3971
+ type: "string"
3972
+ },
3973
+ is_device_error: { enum: [true], type: "boolean" },
3974
+ message: { type: "string" }
3975
+ },
3976
+ required: ["message", "is_device_error", "error_code"],
3977
+ type: "object"
3978
+ },
3979
+ {
3980
+ description: "Lock is not connected to the Seam Bridge.",
3981
+ properties: {
3982
+ error_code: {
3983
+ description: "Unique identifier of the type of error. Enables quick recognition and categorization of the issue.",
3984
+ enum: ["august_lock_missing_bridge"],
3985
+ type: "string"
3986
+ },
3987
+ is_device_error: { enum: [true], type: "boolean" },
3988
+ message: { type: "string" }
3989
+ },
3990
+ required: ["message", "is_device_error", "error_code"],
3991
+ type: "object"
3992
+ },
3993
+ {
3994
+ description: "Salto site user limit reached.",
3995
+ properties: {
3996
+ error_code: {
3997
+ description: "Unique identifier of the type of error. Enables quick recognition and categorization of the issue.",
3998
+ enum: ["salto_site_user_limit_reached"],
3999
+ type: "string"
4000
+ },
4001
+ is_device_error: { enum: [true], type: "boolean" },
4002
+ message: { type: "string" }
4003
+ },
4004
+ required: ["message", "is_device_error", "error_code"],
4005
+ type: "object"
4006
+ },
4007
+ {
4008
+ description: "Lock is not paired with a Gateway.",
4009
+ properties: {
4010
+ error_code: {
4011
+ description: "Unique identifier of the type of error. Enables quick recognition and categorization of the issue.",
4012
+ enum: ["ttlock_lock_not_paired_to_gateway"],
4013
+ type: "string"
4014
+ },
4015
+ is_device_error: { enum: [true], type: "boolean" },
4016
+ message: { type: "string" }
4017
+ },
4018
+ required: ["message", "is_device_error", "error_code"],
4019
+ type: "object"
4020
+ },
4021
+ {
4022
+ description: "Missing device credentials.",
4023
+ properties: {
4024
+ error_code: {
4025
+ description: "Unique identifier of the type of error. Enables quick recognition and categorization of the issue.",
4026
+ enum: ["missing_device_credentials"],
4027
+ type: "string"
4028
+ },
4029
+ is_device_error: { enum: [true], type: "boolean" },
4030
+ message: { type: "string" }
4031
+ },
4032
+ required: ["message", "is_device_error", "error_code"],
4033
+ type: "object"
4034
+ },
4035
+ {
4036
+ description: "The auxiliary heat is running.",
4037
+ properties: {
4038
+ error_code: {
4039
+ description: "Unique identifier of the type of error. Enables quick recognition and categorization of the issue.",
4040
+ enum: ["auxiliary_heat_running"],
4041
+ type: "string"
4042
+ },
4043
+ is_device_error: { enum: [true], type: "boolean" },
4044
+ message: { type: "string" }
4045
+ },
4046
+ required: ["message", "is_device_error", "error_code"],
4047
+ type: "object"
4048
+ },
4049
+ {
4050
+ description: "Subscription required to connect.",
4051
+ properties: {
4052
+ error_code: {
4053
+ description: "Unique identifier of the type of error. Enables quick recognition and categorization of the issue.",
4054
+ enum: ["subscription_required"],
4055
+ type: "string"
4056
+ },
4057
+ is_device_error: { enum: [true], type: "boolean" },
4058
+ message: { type: "string" }
4059
+ },
4060
+ required: ["message", "is_device_error", "error_code"],
4061
+ type: "object"
4062
+ },
4063
+ {
4064
+ description: "Account is disconnected.",
4065
+ properties: {
4066
+ error_code: {
4067
+ description: "Unique identifier of the type of error. Enables quick recognition and categorization of the issue.",
4068
+ enum: ["account_disconnected"],
4069
+ type: "string"
4070
+ },
4071
+ is_connected_account_error: {
4072
+ enum: [true],
4073
+ type: "boolean"
4074
+ },
4075
+ message: { type: "string" }
4076
+ },
4077
+ required: [
4078
+ "message",
4079
+ "is_connected_account_error",
4080
+ "error_code"
4081
+ ],
4082
+ type: "object"
4083
+ },
4084
+ {
4085
+ description: "Credentials provided were invalid.",
4086
+ properties: {
4087
+ error_code: {
4088
+ description: "Unique identifier of the type of error. Enables quick recognition and categorization of the issue.",
4089
+ enum: ["invalid_credentials"],
4090
+ type: "string"
4091
+ },
4092
+ is_connected_account_error: {
4093
+ enum: [true],
4094
+ type: "boolean"
4095
+ },
4096
+ message: { type: "string" }
4097
+ },
4098
+ required: [
4099
+ "message",
4100
+ "is_connected_account_error",
4101
+ "error_code"
4102
+ ],
4103
+ type: "object"
4104
+ }
4105
+ ]
4106
+ },
4107
+ type: "array"
4108
+ },
4109
+ is_backup: {
4110
+ description: "Indicates whether the access code is a backup code.",
4111
+ type: "boolean"
4112
+ },
4113
+ is_backup_access_code_available: {
4114
+ description: "Indicates whether a backup access code is available for use if the primary access code is lost or compromised.",
4115
+ type: "boolean"
4116
+ },
4117
+ is_external_modification_allowed: {
4118
+ description: "Indicates whether changes to the access code from external sources are permitted.",
4119
+ type: "boolean"
4120
+ },
4121
+ is_managed: {
4122
+ description: "Indicates whether Seam manages the access code.",
4123
+ enum: [true],
4124
+ type: "boolean"
4125
+ },
4126
+ is_offline_access_code: {
4127
+ 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.',
4128
+ type: "boolean"
4129
+ },
4130
+ is_one_time_use: {
4131
+ description: 'Indicates whether the access code can only be used once. If "true," the code becomes invalid after the first use.',
4132
+ type: "boolean"
4133
+ },
4134
+ is_scheduled_on_device: {
4135
+ description: "Indicates whether the code is set on the device according to a preconfigured schedule.",
4136
+ type: "boolean"
4137
+ },
4138
+ is_waiting_for_code_assignment: {
4139
+ description: "Indicates whether the access code is waiting for a code assignment.",
4140
+ type: "boolean"
4141
+ },
4142
+ name: {
4143
+ description: "Name of the access code. Enables administrators and users to identify the access code easily, especially when there are numerous access codes.",
4144
+ nullable: true,
4145
+ type: "string"
4146
+ },
4147
+ pulled_backup_access_code_id: {
4148
+ description: "Identifier of the pulled backup access code. Used to associate the pulled backup access code with the original access code.",
4149
+ format: "uuid",
4150
+ nullable: true,
4151
+ type: "string"
4152
+ },
4153
+ starts_at: {
4154
+ description: "Date and time at which the time-bound access code becomes active.",
4155
+ format: "date-time",
4156
+ nullable: true,
4157
+ type: "string"
4158
+ },
4159
+ status: {
4160
+ 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 ',
4161
+ enum: ["setting", "set", "unset", "removing", "unknown"],
4162
+ type: "string"
4163
+ },
4164
+ type: {
4165
+ 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.',
4166
+ enum: ["time_bound", "ongoing"],
4167
+ type: "string"
4168
+ },
4169
+ warnings: {
4170
+ 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.',
4171
+ items: {
4172
+ discriminator: { propertyName: "warning_code" },
4173
+ oneOf: [
4174
+ {
4175
+ description: "Failed to set code on Smart Things device.",
4176
+ properties: {
4177
+ message: { type: "string" },
4334
4178
  warning_code: {
4335
4179
  description: "Unique identifier of the type of warning. Enables quick recognition and categorization of the issue.",
4336
- enum: ["delay_in_removing_from_device"],
4180
+ enum: ["smartthings_failed_to_set_access_code"],
4337
4181
  type: "string"
4338
4182
  }
4339
4183
  },
@@ -4341,12 +4185,12 @@ var openapi_default = {
4341
4185
  type: "object"
4342
4186
  },
4343
4187
  {
4344
- description: "Third party integration detected that may cause access codes to fail.",
4188
+ description: "Duplicate access code detected.",
4345
4189
  properties: {
4346
4190
  message: { type: "string" },
4347
4191
  warning_code: {
4348
4192
  description: "Unique identifier of the type of warning. Enables quick recognition and categorization of the issue.",
4349
- enum: ["third_party_integration_detected"],
4193
+ enum: ["schlage_detected_duplicate"],
4350
4194
  type: "string"
4351
4195
  }
4352
4196
  },
@@ -4354,12 +4198,12 @@ var openapi_default = {
4354
4198
  type: "object"
4355
4199
  },
4356
4200
  {
4357
- description: "Access code has not yet been fully moved to the device.",
4201
+ description: "Received an error when attempting to create this code.",
4358
4202
  properties: {
4359
4203
  message: { type: "string" },
4360
4204
  warning_code: {
4361
4205
  description: "Unique identifier of the type of warning. Enables quick recognition and categorization of the issue.",
4362
- enum: ["august_device_programming_delay"],
4206
+ enum: ["schlage_creation_outage"],
4363
4207
  type: "string"
4364
4208
  }
4365
4209
  },
@@ -4367,12 +4211,12 @@ var openapi_default = {
4367
4211
  type: "object"
4368
4212
  },
4369
4213
  {
4370
- description: "Algopins must be used within 24 hours.",
4214
+ description: "Code was modified or removed externally after Seam successfully set it on the device.",
4371
4215
  properties: {
4372
4216
  message: { type: "string" },
4373
4217
  warning_code: {
4374
4218
  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"],
4219
+ enum: ["code_modified_external_to_seam"],
4376
4220
  type: "string"
4377
4221
  }
4378
4222
  },
@@ -4380,33 +4224,98 @@ var openapi_default = {
4380
4224
  type: "object"
4381
4225
  },
4382
4226
  {
4383
- description: "Management was transferred to another workspace.",
4227
+ description: "Delay in setting code on device.",
4384
4228
  properties: {
4385
4229
  message: { type: "string" },
4386
4230
  warning_code: {
4387
4231
  description: "Unique identifier of the type of warning. Enables quick recognition and categorization of the issue.",
4388
- enum: ["management_transferred"],
4232
+ enum: ["delay_in_setting_on_device"],
4389
4233
  type: "string"
4390
4234
  }
4391
4235
  },
4392
4236
  required: ["message", "warning_code"],
4393
4237
  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",
4238
+ },
4239
+ {
4240
+ description: "Delay in removing code from device.",
4241
+ properties: {
4242
+ message: { type: "string" },
4243
+ warning_code: {
4244
+ description: "Unique identifier of the type of warning. Enables quick recognition and categorization of the issue.",
4245
+ enum: ["delay_in_removing_from_device"],
4246
+ type: "string"
4247
+ }
4248
+ },
4249
+ required: ["message", "warning_code"],
4250
+ type: "object"
4251
+ },
4252
+ {
4253
+ description: "Third party integration detected that may cause access codes to fail.",
4254
+ properties: {
4255
+ message: { type: "string" },
4256
+ warning_code: {
4257
+ description: "Unique identifier of the type of warning. Enables quick recognition and categorization of the issue.",
4258
+ enum: ["third_party_integration_detected"],
4259
+ type: "string"
4260
+ }
4261
+ },
4262
+ required: ["message", "warning_code"],
4263
+ type: "object"
4264
+ },
4265
+ {
4266
+ description: "Access code has not yet been fully moved to the device.",
4267
+ 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: ["august_device_programming_delay"],
4272
+ type: "string"
4273
+ }
4274
+ },
4275
+ required: ["message", "warning_code"],
4276
+ type: "object"
4277
+ },
4278
+ {
4279
+ description: "Algopins must be used within 24 hours.",
4280
+ 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: ["igloo_algopin_must_be_used_within_24_hours"],
4285
+ type: "string"
4286
+ }
4287
+ },
4288
+ required: ["message", "warning_code"],
4289
+ type: "object"
4290
+ },
4291
+ {
4292
+ description: "Management was transferred to another workspace.",
4293
+ 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: ["management_transferred"],
4298
+ type: "string"
4299
+ }
4300
+ },
4301
+ required: ["message", "warning_code"],
4302
+ type: "object"
4303
+ }
4304
+ ]
4305
+ },
4306
+ type: "array"
4307
+ }
4308
+ },
4309
+ required: [
4310
+ "common_code_key",
4311
+ "type",
4312
+ "access_code_id",
4313
+ "device_id",
4314
+ "name",
4315
+ "code",
4316
+ "created_at",
4317
+ "errors",
4318
+ "warnings",
4410
4319
  "is_managed",
4411
4320
  "status",
4412
4321
  "is_backup_access_code_available",
@@ -4666,6 +4575,7 @@ var openapi_default = {
4666
4575
  description: "Warnings associated with the `acs_credential`.",
4667
4576
  items: {
4668
4577
  description: "Warning associated with the `acs_credential`.",
4578
+ discriminator: { propertyName: "warning_code" },
4669
4579
  oneOf: [
4670
4580
  {
4671
4581
  description: "Indicates that the credential is waiting to be issued.",
@@ -5115,6 +5025,7 @@ var openapi_default = {
5115
5025
  description: "Errors associated with the `acs_system`.",
5116
5026
  items: {
5117
5027
  description: "Error associated with the `acs_system`.",
5028
+ discriminator: { propertyName: "error_code" },
5118
5029
  oneOf: [
5119
5030
  {
5120
5031
  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 +5250,7 @@ var openapi_default = {
5339
5250
  description: "Warnings associated with the `acs_system`.",
5340
5251
  items: {
5341
5252
  description: "Warning associated with the `acs_system`.",
5253
+ discriminator: { propertyName: "warning_code" },
5342
5254
  oneOf: [
5343
5255
  {
5344
5256
  properties: {
@@ -5466,6 +5378,7 @@ var openapi_default = {
5466
5378
  description: "Errors associated with the `acs_user`.",
5467
5379
  items: {
5468
5380
  description: "Error associated with the `acs_user`.",
5381
+ discriminator: { propertyName: "error_code" },
5469
5382
  oneOf: [
5470
5383
  {
5471
5384
  description: "Indicates that the ACS user was deleted from the ACS system outside of Seam.",
@@ -5636,6 +5549,7 @@ var openapi_default = {
5636
5549
  description: "Warnings associated with the `acs_user`.",
5637
5550
  items: {
5638
5551
  description: "Warning associated with the `acs_user`.",
5552
+ discriminator: { propertyName: "warning_code" },
5639
5553
  oneOf: [
5640
5554
  {
5641
5555
  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 +6041,7 @@ var openapi_default = {
6127
6041
  description: "Warnings associated with the `acs_credential`.",
6128
6042
  items: {
6129
6043
  description: "Warning associated with the `acs_credential`.",
6044
+ discriminator: { propertyName: "warning_code" },
6130
6045
  oneOf: [
6131
6046
  {
6132
6047
  description: "Indicates that the credential is waiting to be issued.",
@@ -6463,6 +6378,7 @@ var openapi_default = {
6463
6378
  description: "Warnings associated with the `acs_credential`.",
6464
6379
  items: {
6465
6380
  description: "Warning associated with the `acs_credential`.",
6381
+ discriminator: { propertyName: "warning_code" },
6466
6382
  oneOf: [
6467
6383
  {
6468
6384
  description: "Indicates that the credential is waiting to be issued.",
@@ -6931,6 +6847,7 @@ var openapi_default = {
6931
6847
  description: "Warnings associated with the `acs_credential`.",
6932
6848
  items: {
6933
6849
  description: "Warning associated with the `acs_credential`.",
6850
+ discriminator: { propertyName: "warning_code" },
6934
6851
  oneOf: [
6935
6852
  {
6936
6853
  description: "Indicates that the credential is waiting to be issued.",
@@ -7265,6 +7182,7 @@ var openapi_default = {
7265
7182
  description: "Warnings associated with the `acs_credential`.",
7266
7183
  items: {
7267
7184
  description: "Warning associated with the `acs_credential`.",
7185
+ discriminator: { propertyName: "warning_code" },
7268
7186
  oneOf: [
7269
7187
  {
7270
7188
  description: "Indicates that the credential is waiting to be issued.",
@@ -8499,12 +8417,13 @@ var openapi_default = {
8499
8417
  },
8500
8418
  errors: {
8501
8419
  items: {
8420
+ discriminator: { propertyName: "error_code" },
8502
8421
  oneOf: [
8503
8422
  {
8504
8423
  description: "Account is disconnected.",
8505
8424
  properties: {
8506
8425
  error_code: {
8507
- description: "Unique identifier of the type of warning. Enables quick recognition and categorization of the issue.",
8426
+ description: "Unique identifier of the type of error. Enables quick recognition and categorization of the issue.",
8508
8427
  enum: ["account_disconnected"],
8509
8428
  type: "string"
8510
8429
  },
@@ -8525,7 +8444,7 @@ var openapi_default = {
8525
8444
  description: "Credentials provided were invalid.",
8526
8445
  properties: {
8527
8446
  error_code: {
8528
- description: "Unique identifier of the type of warning. Enables quick recognition and categorization of the issue.",
8447
+ description: "Unique identifier of the type of error. Enables quick recognition and categorization of the issue.",
8529
8448
  enum: ["invalid_credentials"],
8530
8449
  type: "string"
8531
8450
  },
@@ -8559,6 +8478,7 @@ var openapi_default = {
8559
8478
  warnings: {
8560
8479
  items: {
8561
8480
  description: "Warning associated with the `connected_account`.",
8481
+ discriminator: { propertyName: "warning_code" },
8562
8482
  oneOf: [
8563
8483
  {
8564
8484
  description: "Scheduled downtime for account planned.",
@@ -8708,239 +8628,217 @@ var openapi_default = {
8708
8628
  errors: {
8709
8629
  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
8630
  items: {
8631
+ discriminator: { propertyName: "error_code" },
8711
8632
  oneOf: [
8712
8633
  {
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"
8634
+ description: "Device is offline",
8635
+ properties: {
8636
+ error_code: {
8637
+ description: "Unique identifier of the type of error. Enables quick recognition and categorization of the issue.",
8638
+ enum: ["device_offline"],
8639
+ type: "string"
8756
8640
  },
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"
8641
+ is_device_error: { enum: [true], type: "boolean" },
8642
+ message: { type: "string" }
8643
+ },
8644
+ required: ["message", "is_device_error", "error_code"],
8645
+ type: "object"
8646
+ },
8647
+ {
8648
+ description: "Device has been removed",
8649
+ properties: {
8650
+ error_code: {
8651
+ description: "Unique identifier of the type of error. Enables quick recognition and categorization of the issue.",
8652
+ enum: ["device_removed"],
8653
+ type: "string"
8770
8654
  },
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"
8655
+ is_device_error: { enum: [true], type: "boolean" },
8656
+ message: { type: "string" }
8657
+ },
8658
+ required: ["message", "is_device_error", "error_code"],
8659
+ type: "object"
8660
+ },
8661
+ {
8662
+ description: "Hub is disconnected",
8663
+ properties: {
8664
+ error_code: {
8665
+ description: "Unique identifier of the type of error. Enables quick recognition and categorization of the issue.",
8666
+ enum: ["hub_disconnected"],
8667
+ type: "string"
8784
8668
  },
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"
8669
+ is_device_error: { enum: [true], type: "boolean" },
8670
+ message: { type: "string" }
8671
+ },
8672
+ required: ["message", "is_device_error", "error_code"],
8673
+ type: "object"
8674
+ },
8675
+ {
8676
+ description: "Device is disconnected",
8677
+ properties: {
8678
+ error_code: {
8679
+ description: "Unique identifier of the type of error. Enables quick recognition and categorization of the issue.",
8680
+ enum: ["device_disconnected"],
8681
+ type: "string"
8798
8682
  },
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"
8683
+ is_device_error: { enum: [true], type: "boolean" },
8684
+ message: { type: "string" }
8685
+ },
8686
+ required: ["message", "is_device_error", "error_code"],
8687
+ type: "object"
8688
+ },
8689
+ {
8690
+ description: "The backup access code pool is empty.",
8691
+ properties: {
8692
+ error_code: {
8693
+ description: "Unique identifier of the type of error. Enables quick recognition and categorization of the issue.",
8694
+ enum: ["empty_backup_access_code_pool"],
8695
+ type: "string"
8812
8696
  },
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"
8697
+ is_device_error: { enum: [true], type: "boolean" },
8698
+ message: { type: "string" }
8699
+ },
8700
+ required: ["message", "is_device_error", "error_code"],
8701
+ type: "object"
8702
+ },
8703
+ {
8704
+ description: "User is not authorized to use the August Lock.",
8705
+ properties: {
8706
+ error_code: {
8707
+ description: "Unique identifier of the type of error. Enables quick recognition and categorization of the issue.",
8708
+ enum: ["august_lock_not_authorized"],
8709
+ type: "string"
8826
8710
  },
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"
8711
+ is_device_error: { enum: [true], type: "boolean" },
8712
+ message: { type: "string" }
8713
+ },
8714
+ required: ["message", "is_device_error", "error_code"],
8715
+ type: "object"
8716
+ },
8717
+ {
8718
+ description: "Lock is not connected to the Seam Bridge.",
8719
+ properties: {
8720
+ error_code: {
8721
+ description: "Unique identifier of the type of error. Enables quick recognition and categorization of the issue.",
8722
+ enum: ["august_lock_missing_bridge"],
8723
+ type: "string"
8840
8724
  },
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"
8725
+ is_device_error: { enum: [true], type: "boolean" },
8726
+ message: { type: "string" }
8727
+ },
8728
+ required: ["message", "is_device_error", "error_code"],
8729
+ type: "object"
8730
+ },
8731
+ {
8732
+ description: "Salto site user limit reached.",
8733
+ properties: {
8734
+ error_code: {
8735
+ description: "Unique identifier of the type of error. Enables quick recognition and categorization of the issue.",
8736
+ enum: ["salto_site_user_limit_reached"],
8737
+ type: "string"
8854
8738
  },
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"
8739
+ is_device_error: { enum: [true], type: "boolean" },
8740
+ message: { type: "string" }
8741
+ },
8742
+ required: ["message", "is_device_error", "error_code"],
8743
+ type: "object"
8744
+ },
8745
+ {
8746
+ description: "Lock is not paired with a Gateway.",
8747
+ properties: {
8748
+ error_code: {
8749
+ description: "Unique identifier of the type of error. Enables quick recognition and categorization of the issue.",
8750
+ enum: ["ttlock_lock_not_paired_to_gateway"],
8751
+ type: "string"
8868
8752
  },
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"
8753
+ is_device_error: { enum: [true], type: "boolean" },
8754
+ message: { type: "string" }
8755
+ },
8756
+ required: ["message", "is_device_error", "error_code"],
8757
+ type: "object"
8758
+ },
8759
+ {
8760
+ description: "Missing device credentials.",
8761
+ properties: {
8762
+ error_code: {
8763
+ description: "Unique identifier of the type of error. Enables quick recognition and categorization of the issue.",
8764
+ enum: ["missing_device_credentials"],
8765
+ type: "string"
8882
8766
  },
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
- ]
8767
+ is_device_error: { enum: [true], type: "boolean" },
8768
+ message: { type: "string" }
8769
+ },
8770
+ required: ["message", "is_device_error", "error_code"],
8771
+ type: "object"
8898
8772
  },
8899
8773
  {
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"
8774
+ description: "The auxiliary heat is running.",
8775
+ properties: {
8776
+ error_code: {
8777
+ description: "Unique identifier of the type of error. Enables quick recognition and categorization of the issue.",
8778
+ enum: ["auxiliary_heat_running"],
8779
+ type: "string"
8921
8780
  },
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
- ]
8781
+ is_device_error: { enum: [true], type: "boolean" },
8782
+ message: { type: "string" }
8783
+ },
8784
+ required: ["message", "is_device_error", "error_code"],
8785
+ type: "object"
8786
+ },
8787
+ {
8788
+ description: "Subscription required to connect.",
8789
+ properties: {
8790
+ error_code: {
8791
+ description: "Unique identifier of the type of error. Enables quick recognition and categorization of the issue.",
8792
+ enum: ["subscription_required"],
8793
+ type: "string"
8794
+ },
8795
+ is_device_error: { enum: [true], type: "boolean" },
8796
+ message: { type: "string" }
8797
+ },
8798
+ required: ["message", "is_device_error", "error_code"],
8799
+ type: "object"
8800
+ },
8801
+ {
8802
+ description: "Account is disconnected.",
8803
+ properties: {
8804
+ error_code: {
8805
+ description: "Unique identifier of the type of error. Enables quick recognition and categorization of the issue.",
8806
+ enum: ["account_disconnected"],
8807
+ type: "string"
8808
+ },
8809
+ is_connected_account_error: {
8810
+ enum: [true],
8811
+ type: "boolean"
8812
+ },
8813
+ message: { type: "string" }
8814
+ },
8815
+ required: [
8816
+ "message",
8817
+ "is_connected_account_error",
8818
+ "error_code"
8819
+ ],
8820
+ type: "object"
8821
+ },
8822
+ {
8823
+ description: "Credentials provided were invalid.",
8824
+ properties: {
8825
+ error_code: {
8826
+ description: "Unique identifier of the type of error. Enables quick recognition and categorization of the issue.",
8827
+ enum: ["invalid_credentials"],
8828
+ type: "string"
8829
+ },
8830
+ is_connected_account_error: {
8831
+ enum: [true],
8832
+ type: "boolean"
8833
+ },
8834
+ message: { type: "string" }
8835
+ },
8836
+ required: [
8837
+ "message",
8838
+ "is_connected_account_error",
8839
+ "error_code"
8840
+ ],
8841
+ type: "object"
8944
8842
  }
8945
8843
  ]
8946
8844
  },
@@ -10174,6 +10072,7 @@ var openapi_default = {
10174
10072
  warnings: {
10175
10073
  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
10074
  items: {
10075
+ discriminator: { propertyName: "warning_code" },
10177
10076
  oneOf: [
10178
10077
  {
10179
10078
  description: "Backup access code unhealthy.",
@@ -14661,337 +14560,316 @@ var openapi_default = {
14661
14560
  errors: {
14662
14561
  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
14562
  items: {
14563
+ discriminator: { propertyName: "error_code" },
14664
14564
  oneOf: [
14665
14565
  {
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"
14835
- },
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
- ]
14851
- },
14852
- {
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"
14566
+ description: "Device is offline",
14567
+ properties: {
14568
+ error_code: {
14569
+ description: "Unique identifier of the type of error. Enables quick recognition and categorization of the issue.",
14570
+ enum: ["device_offline"],
14571
+ type: "string"
14938
14572
  },
14939
- type: "array"
14573
+ is_device_error: { enum: [true], type: "boolean" },
14574
+ message: { type: "string" }
14940
14575
  },
14941
- has_active_endpoint: { type: "boolean" }
14576
+ required: ["message", "is_device_error", "error_code"],
14577
+ type: "object"
14942
14578
  },
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
14579
  {
14959
- description: "Backup access code unhealthy.",
14580
+ description: "Device has been removed",
14960
14581
  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"],
14582
+ error_code: {
14583
+ description: "Unique identifier of the type of error. Enables quick recognition and categorization of the issue.",
14584
+ enum: ["device_removed"],
14965
14585
  type: "string"
14966
- }
14586
+ },
14587
+ is_device_error: { enum: [true], type: "boolean" },
14588
+ message: { type: "string" }
14967
14589
  },
14968
- required: ["message", "warning_code"],
14590
+ required: ["message", "is_device_error", "error_code"],
14969
14591
  type: "object"
14970
14592
  },
14971
14593
  {
14972
- description: "Too many backup codes.",
14594
+ description: "Hub is disconnected",
14973
14595
  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.",
14977
- enum: ["many_active_backup_codes"],
14596
+ error_code: {
14597
+ description: "Unique identifier of the type of error. Enables quick recognition and categorization of the issue.",
14598
+ enum: ["hub_disconnected"],
14978
14599
  type: "string"
14979
- }
14600
+ },
14601
+ is_device_error: { enum: [true], type: "boolean" },
14602
+ message: { type: "string" }
14980
14603
  },
14981
- required: ["message", "warning_code"],
14604
+ required: ["message", "is_device_error", "error_code"],
14982
14605
  type: "object"
14983
14606
  },
14984
14607
  {
14985
- description: "A Salto Lock displaying an unknown device type.",
14608
+ description: "Device is disconnected",
14986
14609
  properties: {
14987
- message: { type: "string" },
14988
- warning_code: {
14989
- description: "Unique identifier of the type of warning. Enables quick recognition and categorization of the issue.",
14990
- enum: ["salto_unknown_device_type"],
14610
+ error_code: {
14611
+ description: "Unique identifier of the type of error. Enables quick recognition and categorization of the issue.",
14612
+ enum: ["device_disconnected"],
14991
14613
  type: "string"
14992
- }
14614
+ },
14615
+ is_device_error: { enum: [true], type: "boolean" },
14616
+ message: { type: "string" }
14993
14617
  },
14994
- required: ["message", "warning_code"],
14618
+ required: ["message", "is_device_error", "error_code"],
14619
+ type: "object"
14620
+ },
14621
+ {
14622
+ description: "The backup access code pool is empty.",
14623
+ properties: {
14624
+ error_code: {
14625
+ description: "Unique identifier of the type of error. Enables quick recognition and categorization of the issue.",
14626
+ enum: ["empty_backup_access_code_pool"],
14627
+ type: "string"
14628
+ },
14629
+ is_device_error: { enum: [true], type: "boolean" },
14630
+ message: { type: "string" }
14631
+ },
14632
+ required: ["message", "is_device_error", "error_code"],
14633
+ type: "object"
14634
+ },
14635
+ {
14636
+ description: "User is not authorized to use the August Lock.",
14637
+ properties: {
14638
+ error_code: {
14639
+ description: "Unique identifier of the type of error. Enables quick recognition and categorization of the issue.",
14640
+ enum: ["august_lock_not_authorized"],
14641
+ type: "string"
14642
+ },
14643
+ is_device_error: { enum: [true], type: "boolean" },
14644
+ message: { type: "string" }
14645
+ },
14646
+ required: ["message", "is_device_error", "error_code"],
14647
+ type: "object"
14648
+ },
14649
+ {
14650
+ description: "Lock is not connected to the Seam Bridge.",
14651
+ properties: {
14652
+ error_code: {
14653
+ description: "Unique identifier of the type of error. Enables quick recognition and categorization of the issue.",
14654
+ enum: ["august_lock_missing_bridge"],
14655
+ type: "string"
14656
+ },
14657
+ is_device_error: { enum: [true], type: "boolean" },
14658
+ message: { type: "string" }
14659
+ },
14660
+ required: ["message", "is_device_error", "error_code"],
14661
+ type: "object"
14662
+ },
14663
+ {
14664
+ description: "Salto site user limit reached.",
14665
+ properties: {
14666
+ error_code: {
14667
+ description: "Unique identifier of the type of error. Enables quick recognition and categorization of the issue.",
14668
+ enum: ["salto_site_user_limit_reached"],
14669
+ type: "string"
14670
+ },
14671
+ is_device_error: { enum: [true], type: "boolean" },
14672
+ message: { type: "string" }
14673
+ },
14674
+ required: ["message", "is_device_error", "error_code"],
14675
+ type: "object"
14676
+ },
14677
+ {
14678
+ description: "Lock is not paired with a Gateway.",
14679
+ properties: {
14680
+ error_code: {
14681
+ description: "Unique identifier of the type of error. Enables quick recognition and categorization of the issue.",
14682
+ enum: ["ttlock_lock_not_paired_to_gateway"],
14683
+ type: "string"
14684
+ },
14685
+ is_device_error: { enum: [true], type: "boolean" },
14686
+ message: { type: "string" }
14687
+ },
14688
+ required: ["message", "is_device_error", "error_code"],
14689
+ type: "object"
14690
+ },
14691
+ {
14692
+ description: "Missing device credentials.",
14693
+ properties: {
14694
+ error_code: {
14695
+ description: "Unique identifier of the type of error. Enables quick recognition and categorization of the issue.",
14696
+ enum: ["missing_device_credentials"],
14697
+ type: "string"
14698
+ },
14699
+ is_device_error: { enum: [true], type: "boolean" },
14700
+ message: { type: "string" }
14701
+ },
14702
+ required: ["message", "is_device_error", "error_code"],
14703
+ type: "object"
14704
+ },
14705
+ {
14706
+ description: "The auxiliary heat is running.",
14707
+ properties: {
14708
+ error_code: {
14709
+ description: "Unique identifier of the type of error. Enables quick recognition and categorization of the issue.",
14710
+ enum: ["auxiliary_heat_running"],
14711
+ type: "string"
14712
+ },
14713
+ is_device_error: { enum: [true], type: "boolean" },
14714
+ message: { type: "string" }
14715
+ },
14716
+ required: ["message", "is_device_error", "error_code"],
14717
+ type: "object"
14718
+ },
14719
+ {
14720
+ description: "Subscription required to connect.",
14721
+ properties: {
14722
+ error_code: {
14723
+ description: "Unique identifier of the type of error. Enables quick recognition and categorization of the issue.",
14724
+ enum: ["subscription_required"],
14725
+ type: "string"
14726
+ },
14727
+ is_device_error: { enum: [true], type: "boolean" },
14728
+ message: { type: "string" }
14729
+ },
14730
+ required: ["message", "is_device_error", "error_code"],
14731
+ type: "object"
14732
+ },
14733
+ {
14734
+ description: "Account is disconnected.",
14735
+ properties: {
14736
+ error_code: {
14737
+ description: "Unique identifier of the type of error. Enables quick recognition and categorization of the issue.",
14738
+ enum: ["account_disconnected"],
14739
+ type: "string"
14740
+ },
14741
+ is_connected_account_error: {
14742
+ enum: [true],
14743
+ type: "boolean"
14744
+ },
14745
+ message: { type: "string" }
14746
+ },
14747
+ required: [
14748
+ "message",
14749
+ "is_connected_account_error",
14750
+ "error_code"
14751
+ ],
14752
+ type: "object"
14753
+ },
14754
+ {
14755
+ description: "Credentials provided were invalid.",
14756
+ properties: {
14757
+ error_code: {
14758
+ description: "Unique identifier of the type of error. Enables quick recognition and categorization of the issue.",
14759
+ enum: ["invalid_credentials"],
14760
+ type: "string"
14761
+ },
14762
+ is_connected_account_error: {
14763
+ enum: [true],
14764
+ type: "boolean"
14765
+ },
14766
+ message: { type: "string" }
14767
+ },
14768
+ required: [
14769
+ "message",
14770
+ "is_connected_account_error",
14771
+ "error_code"
14772
+ ],
14773
+ type: "object"
14774
+ }
14775
+ ]
14776
+ },
14777
+ type: "array"
14778
+ },
14779
+ is_managed: {
14780
+ description: "Indicates whether Seam manages the device.",
14781
+ enum: [true],
14782
+ type: "boolean"
14783
+ },
14784
+ location: {
14785
+ description: "Location information for the device.",
14786
+ nullable: true,
14787
+ properties: {
14788
+ location_name: {
14789
+ description: "Name of the device location.",
14790
+ type: "string"
14791
+ },
14792
+ timezone: {
14793
+ description: "Time zone of the device location.",
14794
+ type: "string"
14795
+ }
14796
+ },
14797
+ type: "object"
14798
+ },
14799
+ nickname: {
14800
+ description: "Optional nickname to describe the device, settable through Seam",
14801
+ type: "string"
14802
+ },
14803
+ properties: {
14804
+ properties: {
14805
+ assa_abloy_credential_service_metadata: {
14806
+ properties: {
14807
+ endpoints: {
14808
+ items: {
14809
+ properties: {
14810
+ endpoint_id: { type: "string" },
14811
+ is_active: { type: "boolean" }
14812
+ },
14813
+ required: ["endpoint_id", "is_active"],
14814
+ type: "object"
14815
+ },
14816
+ type: "array"
14817
+ },
14818
+ has_active_endpoint: { type: "boolean" }
14819
+ },
14820
+ required: ["has_active_endpoint", "endpoints"],
14821
+ type: "object"
14822
+ },
14823
+ salto_space_credential_service_metadata: {
14824
+ properties: { has_active_phone: { type: "boolean" } },
14825
+ required: ["has_active_phone"],
14826
+ type: "object"
14827
+ }
14828
+ },
14829
+ type: "object"
14830
+ },
14831
+ warnings: {
14832
+ 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.',
14833
+ items: {
14834
+ discriminator: { propertyName: "warning_code" },
14835
+ oneOf: [
14836
+ {
14837
+ description: "Backup access code unhealthy.",
14838
+ properties: {
14839
+ message: { type: "string" },
14840
+ warning_code: {
14841
+ description: "Unique identifier of the type of warning. Enables quick recognition and categorization of the issue.",
14842
+ enum: ["partial_backup_access_code_pool"],
14843
+ type: "string"
14844
+ }
14845
+ },
14846
+ required: ["message", "warning_code"],
14847
+ type: "object"
14848
+ },
14849
+ {
14850
+ description: "Too many backup codes.",
14851
+ properties: {
14852
+ message: { type: "string" },
14853
+ warning_code: {
14854
+ description: "Unique identifier of the type of warning. Enables quick recognition and categorization of the issue.",
14855
+ enum: ["many_active_backup_codes"],
14856
+ type: "string"
14857
+ }
14858
+ },
14859
+ required: ["message", "warning_code"],
14860
+ type: "object"
14861
+ },
14862
+ {
14863
+ description: "A Salto Lock displaying an unknown device type.",
14864
+ properties: {
14865
+ message: { type: "string" },
14866
+ warning_code: {
14867
+ description: "Unique identifier of the type of warning. Enables quick recognition and categorization of the issue.",
14868
+ enum: ["salto_unknown_device_type"],
14869
+ type: "string"
14870
+ }
14871
+ },
14872
+ required: ["message", "warning_code"],
14995
14873
  type: "object"
14996
14874
  },
14997
14875
  {
@@ -15303,589 +15181,487 @@ var openapi_default = {
15303
15181
  errors: {
15304
15182
  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
15183
  items: {
15184
+ discriminator: { propertyName: "error_code" },
15306
15185
  oneOf: [
15307
15186
  {
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"
15187
+ description: "Failed to set code on Smart Things device.",
15188
+ properties: {
15189
+ error_code: {
15190
+ description: "Unique identifier of the type of error. Enables quick recognition and categorization of the issue.",
15191
+ enum: ["smartthings_failed_to_set_access_code"],
15192
+ type: "string"
15326
15193
  },
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"
15194
+ is_access_code_error: { enum: [true], type: "boolean" },
15195
+ message: { type: "string" }
15196
+ },
15197
+ required: ["message", "is_access_code_error", "error_code"],
15198
+ type: "object"
15199
+ },
15200
+ {
15201
+ description: "Failed to set code after multiple retries.",
15202
+ properties: {
15203
+ error_code: {
15204
+ description: "Unique identifier of the type of error. Enables quick recognition and categorization of the issue.",
15205
+ enum: [
15206
+ "smartthings_failed_to_set_after_multiple_retries"
15344
15207
  ],
15345
- type: "object"
15208
+ type: "string"
15346
15209
  },
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"
15210
+ is_access_code_error: { enum: [true], type: "boolean" },
15211
+ message: { type: "string" }
15212
+ },
15213
+ required: ["message", "is_access_code_error", "error_code"],
15214
+ type: "object"
15215
+ },
15216
+ {
15217
+ description: "Failed to set code on device.",
15218
+ properties: {
15219
+ error_code: {
15220
+ description: "Unique identifier of the type of error. Enables quick recognition and categorization of the issue.",
15221
+ enum: ["failed_to_set_on_device"],
15222
+ type: "string"
15364
15223
  },
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"
15224
+ is_access_code_error: { enum: [true], type: "boolean" },
15225
+ message: { type: "string" }
15226
+ },
15227
+ required: ["message", "is_access_code_error", "error_code"],
15228
+ type: "object"
15229
+ },
15230
+ {
15231
+ description: "Failed to remove code from device.",
15232
+ properties: {
15233
+ error_code: {
15234
+ description: "Unique identifier of the type of error. Enables quick recognition and categorization of the issue.",
15235
+ enum: ["failed_to_remove_from_device"],
15236
+ type: "string"
15382
15237
  },
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"
15238
+ is_access_code_error: { enum: [true], type: "boolean" },
15239
+ message: { type: "string" }
15240
+ },
15241
+ required: ["message", "is_access_code_error", "error_code"],
15242
+ type: "object"
15243
+ },
15244
+ {
15245
+ description: "Duplicate access code detected on device.",
15246
+ properties: {
15247
+ error_code: {
15248
+ description: "Unique identifier of the type of error. Enables quick recognition and categorization of the issue.",
15249
+ enum: ["duplicate_code_on_device"],
15250
+ type: "string"
15400
15251
  },
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"
15252
+ is_access_code_error: { enum: [true], type: "boolean" },
15253
+ message: { type: "string" }
15254
+ },
15255
+ required: ["message", "is_access_code_error", "error_code"],
15256
+ type: "object"
15257
+ },
15258
+ {
15259
+ description: "An attempt to modify this access code was prevented.",
15260
+ properties: {
15261
+ error_code: {
15262
+ description: "Unique identifier of the type of error. Enables quick recognition and categorization of the issue.",
15263
+ enum: ["duplicate_code_attempt_prevented"],
15264
+ type: "string"
15418
15265
  },
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"
15266
+ is_access_code_error: { enum: [true], type: "boolean" },
15267
+ message: { type: "string" }
15268
+ },
15269
+ required: ["message", "is_access_code_error", "error_code"],
15270
+ type: "object"
15271
+ },
15272
+ {
15273
+ description: "Igloohome bridge has too many pending jobs in the queue.",
15274
+ properties: {
15275
+ error_code: {
15276
+ description: "Unique identifier of the type of error. Enables quick recognition and categorization of the issue.",
15277
+ enum: ["igloohome_bridge_too_many_pending_jobs"],
15278
+ type: "string"
15436
15279
  },
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"
15280
+ is_access_code_error: { enum: [true], type: "boolean" },
15281
+ message: { type: "string" }
15282
+ },
15283
+ required: ["message", "is_access_code_error", "error_code"],
15284
+ type: "object"
15285
+ },
15286
+ {
15287
+ description: "Igloohome bridge is offline.",
15288
+ properties: {
15289
+ error_code: {
15290
+ description: "Unique identifier of the type of error. Enables quick recognition and categorization of the issue.",
15291
+ enum: ["igloohome_bridge_offline"],
15292
+ type: "string"
15454
15293
  },
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"
15294
+ is_access_code_error: { enum: [true], type: "boolean" },
15295
+ message: { type: "string" }
15296
+ },
15297
+ required: ["message", "is_access_code_error", "error_code"],
15298
+ type: "object"
15299
+ },
15300
+ {
15301
+ description: "Lock as reached max amount of codes.",
15302
+ properties: {
15303
+ error_code: {
15304
+ description: "Unique identifier of the type of error. Enables quick recognition and categorization of the issue.",
15305
+ enum: [
15306
+ "igloohome_offline_access_code_no_variance_available"
15472
15307
  ],
15473
- type: "object"
15308
+ type: "string"
15474
15309
  },
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"
15310
+ is_access_code_error: { enum: [true], type: "boolean" },
15311
+ message: { type: "string" }
15312
+ },
15313
+ required: ["message", "is_access_code_error", "error_code"],
15314
+ type: "object"
15315
+ },
15316
+ {
15317
+ description: "Unable to confirm the access code is set on Kwikset device.",
15318
+ properties: {
15319
+ error_code: {
15320
+ description: "Unique identifier of the type of error. Enables quick recognition and categorization of the issue.",
15321
+ enum: ["kwikset_unable_to_confirm_code"],
15322
+ type: "string"
15492
15323
  },
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"
15324
+ is_access_code_error: { enum: [true], type: "boolean" },
15325
+ message: { type: "string" }
15326
+ },
15327
+ required: ["message", "is_access_code_error", "error_code"],
15328
+ type: "object"
15329
+ },
15330
+ {
15331
+ description: "Unable to confirm the deletion of the access code on Kwikset device.",
15332
+ properties: {
15333
+ error_code: {
15334
+ description: "Unique identifier of the type of error. Enables quick recognition and categorization of the issue.",
15335
+ enum: ["kwikset_unable_to_confirm_deletion"],
15336
+ type: "string"
15510
15337
  },
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"
15338
+ is_access_code_error: { enum: [true], type: "boolean" },
15339
+ message: { type: "string" }
15340
+ },
15341
+ required: ["message", "is_access_code_error", "error_code"],
15342
+ type: "object"
15343
+ },
15344
+ {
15345
+ description: "Code was modified or removed externally after Seam successfully set it on the device.",
15346
+ properties: {
15347
+ error_code: {
15348
+ description: "Unique identifier of the type of error. Enables quick recognition and categorization of the issue.",
15349
+ enum: ["code_modified_external_to_seam"],
15350
+ type: "string"
15528
15351
  },
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"
15352
+ is_access_code_error: { enum: [true], type: "boolean" },
15353
+ message: { type: "string" }
15354
+ },
15355
+ required: ["message", "is_access_code_error", "error_code"],
15356
+ type: "object"
15357
+ },
15358
+ {
15359
+ description: "Invalid code length for August lock.",
15360
+ properties: {
15361
+ error_code: {
15362
+ description: "Unique identifier of the type of error. Enables quick recognition and categorization of the issue.",
15363
+ enum: ["august_lock_invalid_code_length"],
15364
+ type: "string"
15546
15365
  },
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"
15366
+ is_access_code_error: { enum: [true], type: "boolean" },
15367
+ message: { type: "string" }
15368
+ },
15369
+ required: ["message", "is_access_code_error", "error_code"],
15370
+ type: "object"
15371
+ },
15372
+ {
15373
+ description: "Access code has not yet been fully moved to the device.",
15374
+ properties: {
15375
+ error_code: {
15376
+ description: "Unique identifier of the type of error. Enables quick recognition and categorization of the issue.",
15377
+ enum: ["august_device_programming_delay"],
15378
+ type: "string"
15564
15379
  },
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"
15380
+ is_access_code_error: { enum: [true], type: "boolean" },
15381
+ message: { type: "string" }
15382
+ },
15383
+ required: ["message", "is_access_code_error", "error_code"],
15384
+ type: "object"
15385
+ },
15386
+ {
15387
+ description: "All access code slots on the device are full.",
15388
+ properties: {
15389
+ error_code: {
15390
+ description: "Unique identifier of the type of error. Enables quick recognition and categorization of the issue.",
15391
+ enum: ["august_device_slots_full"],
15392
+ type: "string"
15582
15393
  },
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"
15394
+ is_access_code_error: { enum: [true], type: "boolean" },
15395
+ message: { type: "string" }
15396
+ },
15397
+ required: ["message", "is_access_code_error", "error_code"],
15398
+ type: "object"
15399
+ },
15400
+ {
15401
+ description: "August lock is missing a keypad.",
15402
+ properties: {
15403
+ error_code: {
15404
+ description: "Unique identifier of the type of error. Enables quick recognition and categorization of the issue.",
15405
+ enum: ["august_lock_missing_keypad"],
15406
+ type: "string"
15600
15407
  },
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"
15408
+ is_access_code_error: { enum: [true], type: "boolean" },
15409
+ message: { type: "string" }
15410
+ },
15411
+ required: ["message", "is_access_code_error", "error_code"],
15412
+ type: "object"
15413
+ },
15414
+ {
15415
+ description: "Salto site user is not subscribed.",
15416
+ properties: {
15417
+ error_code: {
15418
+ description: "Unique identifier of the type of error. Enables quick recognition and categorization of the issue.",
15419
+ enum: ["salto_site_user_not_subscribed"],
15420
+ type: "string"
15618
15421
  },
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"
15422
+ is_access_code_error: { enum: [true], type: "boolean" },
15423
+ message: { type: "string" }
15424
+ },
15425
+ required: ["message", "is_access_code_error", "error_code"],
15426
+ type: "object"
15427
+ },
15428
+ {
15429
+ description: "Access code has not yet been fully moved to the device.",
15430
+ properties: {
15431
+ error_code: {
15432
+ description: "Unique identifier of the type of error. Enables quick recognition and categorization of the issue.",
15433
+ enum: ["hubitat_device_programming_delay"],
15434
+ type: "string"
15636
15435
  },
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
- ]
15436
+ is_access_code_error: { enum: [true], type: "boolean" },
15437
+ message: { type: "string" }
15438
+ },
15439
+ required: ["message", "is_access_code_error", "error_code"],
15440
+ type: "object"
15656
15441
  },
15657
15442
  {
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"
15443
+ description: "No free positions available on the device.",
15444
+ properties: {
15445
+ error_code: {
15446
+ description: "Unique identifier of the type of error. Enables quick recognition and categorization of the issue.",
15447
+ enum: ["hubitat_no_free_positions_available"],
15448
+ type: "string"
15673
15449
  },
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"
15450
+ is_access_code_error: { enum: [true], type: "boolean" },
15451
+ message: { type: "string" }
15452
+ },
15453
+ required: ["message", "is_access_code_error", "error_code"],
15454
+ type: "object"
15455
+ },
15456
+ {
15457
+ description: "Device is offline",
15458
+ properties: {
15459
+ error_code: {
15460
+ description: "Unique identifier of the type of error. Enables quick recognition and categorization of the issue.",
15461
+ enum: ["device_offline"],
15462
+ type: "string"
15687
15463
  },
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"
15464
+ is_device_error: { enum: [true], type: "boolean" },
15465
+ message: { type: "string" }
15466
+ },
15467
+ required: ["message", "is_device_error", "error_code"],
15468
+ type: "object"
15469
+ },
15470
+ {
15471
+ description: "Device has been removed",
15472
+ properties: {
15473
+ error_code: {
15474
+ description: "Unique identifier of the type of error. Enables quick recognition and categorization of the issue.",
15475
+ enum: ["device_removed"],
15476
+ type: "string"
15701
15477
  },
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"
15478
+ is_device_error: { enum: [true], type: "boolean" },
15479
+ message: { type: "string" }
15480
+ },
15481
+ required: ["message", "is_device_error", "error_code"],
15482
+ type: "object"
15483
+ },
15484
+ {
15485
+ description: "Hub is disconnected",
15486
+ properties: {
15487
+ error_code: {
15488
+ description: "Unique identifier of the type of error. Enables quick recognition and categorization of the issue.",
15489
+ enum: ["hub_disconnected"],
15490
+ type: "string"
15715
15491
  },
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"
15492
+ is_device_error: { enum: [true], type: "boolean" },
15493
+ message: { type: "string" }
15494
+ },
15495
+ required: ["message", "is_device_error", "error_code"],
15496
+ type: "object"
15497
+ },
15498
+ {
15499
+ description: "Device is disconnected",
15500
+ properties: {
15501
+ error_code: {
15502
+ description: "Unique identifier of the type of error. Enables quick recognition and categorization of the issue.",
15503
+ enum: ["device_disconnected"],
15504
+ type: "string"
15729
15505
  },
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"
15506
+ is_device_error: { enum: [true], type: "boolean" },
15507
+ message: { type: "string" }
15508
+ },
15509
+ required: ["message", "is_device_error", "error_code"],
15510
+ type: "object"
15511
+ },
15512
+ {
15513
+ description: "The backup access code pool is empty.",
15514
+ properties: {
15515
+ error_code: {
15516
+ description: "Unique identifier of the type of error. Enables quick recognition and categorization of the issue.",
15517
+ enum: ["empty_backup_access_code_pool"],
15518
+ type: "string"
15743
15519
  },
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"
15520
+ is_device_error: { enum: [true], type: "boolean" },
15521
+ message: { type: "string" }
15522
+ },
15523
+ required: ["message", "is_device_error", "error_code"],
15524
+ type: "object"
15525
+ },
15526
+ {
15527
+ description: "User is not authorized to use the August Lock.",
15528
+ properties: {
15529
+ error_code: {
15530
+ description: "Unique identifier of the type of error. Enables quick recognition and categorization of the issue.",
15531
+ enum: ["august_lock_not_authorized"],
15532
+ type: "string"
15757
15533
  },
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"
15534
+ is_device_error: { enum: [true], type: "boolean" },
15535
+ message: { type: "string" }
15536
+ },
15537
+ required: ["message", "is_device_error", "error_code"],
15538
+ type: "object"
15539
+ },
15540
+ {
15541
+ description: "Lock is not connected to the Seam Bridge.",
15542
+ properties: {
15543
+ error_code: {
15544
+ description: "Unique identifier of the type of error. Enables quick recognition and categorization of the issue.",
15545
+ enum: ["august_lock_missing_bridge"],
15546
+ type: "string"
15771
15547
  },
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"
15548
+ is_device_error: { enum: [true], type: "boolean" },
15549
+ message: { type: "string" }
15550
+ },
15551
+ required: ["message", "is_device_error", "error_code"],
15552
+ type: "object"
15553
+ },
15554
+ {
15555
+ description: "Salto site user limit reached.",
15556
+ properties: {
15557
+ error_code: {
15558
+ description: "Unique identifier of the type of error. Enables quick recognition and categorization of the issue.",
15559
+ enum: ["salto_site_user_limit_reached"],
15560
+ type: "string"
15785
15561
  },
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"
15562
+ is_device_error: { enum: [true], type: "boolean" },
15563
+ message: { type: "string" }
15564
+ },
15565
+ required: ["message", "is_device_error", "error_code"],
15566
+ type: "object"
15567
+ },
15568
+ {
15569
+ description: "Lock is not paired with a Gateway.",
15570
+ properties: {
15571
+ error_code: {
15572
+ description: "Unique identifier of the type of error. Enables quick recognition and categorization of the issue.",
15573
+ enum: ["ttlock_lock_not_paired_to_gateway"],
15574
+ type: "string"
15799
15575
  },
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"
15576
+ is_device_error: { enum: [true], type: "boolean" },
15577
+ message: { type: "string" }
15578
+ },
15579
+ required: ["message", "is_device_error", "error_code"],
15580
+ type: "object"
15581
+ },
15582
+ {
15583
+ description: "Missing device credentials.",
15584
+ properties: {
15585
+ error_code: {
15586
+ description: "Unique identifier of the type of error. Enables quick recognition and categorization of the issue.",
15587
+ enum: ["missing_device_credentials"],
15588
+ type: "string"
15813
15589
  },
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"
15590
+ is_device_error: { enum: [true], type: "boolean" },
15591
+ message: { type: "string" }
15592
+ },
15593
+ required: ["message", "is_device_error", "error_code"],
15594
+ type: "object"
15595
+ },
15596
+ {
15597
+ description: "The auxiliary heat is running.",
15598
+ properties: {
15599
+ error_code: {
15600
+ description: "Unique identifier of the type of error. Enables quick recognition and categorization of the issue.",
15601
+ enum: ["auxiliary_heat_running"],
15602
+ type: "string"
15827
15603
  },
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
- ]
15604
+ is_device_error: { enum: [true], type: "boolean" },
15605
+ message: { type: "string" }
15606
+ },
15607
+ required: ["message", "is_device_error", "error_code"],
15608
+ type: "object"
15843
15609
  },
15844
15610
  {
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"
15611
+ description: "Subscription required to connect.",
15612
+ properties: {
15613
+ error_code: {
15614
+ description: "Unique identifier of the type of error. Enables quick recognition and categorization of the issue.",
15615
+ enum: ["subscription_required"],
15616
+ type: "string"
15617
+ },
15618
+ is_device_error: { enum: [true], type: "boolean" },
15619
+ message: { type: "string" }
15620
+ },
15621
+ required: ["message", "is_device_error", "error_code"],
15622
+ type: "object"
15623
+ },
15624
+ {
15625
+ description: "Account is disconnected.",
15626
+ properties: {
15627
+ error_code: {
15628
+ description: "Unique identifier of the type of error. Enables quick recognition and categorization of the issue.",
15629
+ enum: ["account_disconnected"],
15630
+ type: "string"
15631
+ },
15632
+ is_connected_account_error: {
15633
+ enum: [true],
15634
+ type: "boolean"
15635
+ },
15636
+ message: { type: "string" }
15637
+ },
15638
+ required: [
15639
+ "message",
15640
+ "is_connected_account_error",
15641
+ "error_code"
15642
+ ],
15643
+ type: "object"
15644
+ },
15645
+ {
15646
+ description: "Credentials provided were invalid.",
15647
+ properties: {
15648
+ error_code: {
15649
+ description: "Unique identifier of the type of error. Enables quick recognition and categorization of the issue.",
15650
+ enum: ["invalid_credentials"],
15651
+ type: "string"
15866
15652
  },
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
- ]
15653
+ is_connected_account_error: {
15654
+ enum: [true],
15655
+ type: "boolean"
15656
+ },
15657
+ message: { type: "string" }
15658
+ },
15659
+ required: [
15660
+ "message",
15661
+ "is_connected_account_error",
15662
+ "error_code"
15663
+ ],
15664
+ type: "object"
15889
15665
  }
15890
15666
  ]
15891
15667
  },
@@ -15912,6 +15688,7 @@ var openapi_default = {
15912
15688
  warnings: {
15913
15689
  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
15690
  items: {
15691
+ discriminator: { propertyName: "warning_code" },
15915
15692
  oneOf: [
15916
15693
  {
15917
15694
  description: "Failed to set code on Smart Things device.",
@@ -16311,6 +16088,7 @@ var openapi_default = {
16311
16088
  description: "Warnings associated with the `acs_credential`.",
16312
16089
  items: {
16313
16090
  description: "Warning associated with the `acs_credential`.",
16091
+ discriminator: { propertyName: "warning_code" },
16314
16092
  oneOf: [
16315
16093
  {
16316
16094
  description: "Indicates that the credential is waiting to be issued.",
@@ -16517,6 +16295,7 @@ var openapi_default = {
16517
16295
  description: "Errors associated with the `acs_user`.",
16518
16296
  items: {
16519
16297
  description: "Error associated with the `acs_user`.",
16298
+ discriminator: { propertyName: "error_code" },
16520
16299
  oneOf: [
16521
16300
  {
16522
16301
  description: "Indicates that the ACS user was deleted from the ACS system outside of Seam.",
@@ -16687,6 +16466,7 @@ var openapi_default = {
16687
16466
  description: "Warnings associated with the `acs_user`.",
16688
16467
  items: {
16689
16468
  description: "Warning associated with the `acs_user`.",
16469
+ discriminator: { propertyName: "warning_code" },
16690
16470
  oneOf: [
16691
16471
  {
16692
16472
  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 +16624,217 @@ var openapi_default = {
16844
16624
  errors: {
16845
16625
  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
16626
  items: {
16627
+ discriminator: { propertyName: "error_code" },
16847
16628
  oneOf: [
16848
16629
  {
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"
16630
+ description: "Device is offline",
16631
+ properties: {
16632
+ error_code: {
16633
+ description: "Unique identifier of the type of error. Enables quick recognition and categorization of the issue.",
16634
+ enum: ["device_offline"],
16635
+ type: "string"
16864
16636
  },
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"
16637
+ is_device_error: { enum: [true], type: "boolean" },
16638
+ message: { type: "string" }
16639
+ },
16640
+ required: ["message", "is_device_error", "error_code"],
16641
+ type: "object"
16642
+ },
16643
+ {
16644
+ description: "Device has been removed",
16645
+ properties: {
16646
+ error_code: {
16647
+ description: "Unique identifier of the type of error. Enables quick recognition and categorization of the issue.",
16648
+ enum: ["device_removed"],
16649
+ type: "string"
16878
16650
  },
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"
16651
+ is_device_error: { enum: [true], type: "boolean" },
16652
+ message: { type: "string" }
16653
+ },
16654
+ required: ["message", "is_device_error", "error_code"],
16655
+ type: "object"
16656
+ },
16657
+ {
16658
+ description: "Hub is disconnected",
16659
+ properties: {
16660
+ error_code: {
16661
+ description: "Unique identifier of the type of error. Enables quick recognition and categorization of the issue.",
16662
+ enum: ["hub_disconnected"],
16663
+ type: "string"
16892
16664
  },
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"
16665
+ is_device_error: { enum: [true], type: "boolean" },
16666
+ message: { type: "string" }
16667
+ },
16668
+ required: ["message", "is_device_error", "error_code"],
16669
+ type: "object"
16670
+ },
16671
+ {
16672
+ description: "Device is disconnected",
16673
+ properties: {
16674
+ error_code: {
16675
+ description: "Unique identifier of the type of error. Enables quick recognition and categorization of the issue.",
16676
+ enum: ["device_disconnected"],
16677
+ type: "string"
16906
16678
  },
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"
16679
+ is_device_error: { enum: [true], type: "boolean" },
16680
+ message: { type: "string" }
16681
+ },
16682
+ required: ["message", "is_device_error", "error_code"],
16683
+ type: "object"
16684
+ },
16685
+ {
16686
+ description: "The backup access code pool is empty.",
16687
+ properties: {
16688
+ error_code: {
16689
+ description: "Unique identifier of the type of error. Enables quick recognition and categorization of the issue.",
16690
+ enum: ["empty_backup_access_code_pool"],
16691
+ type: "string"
16920
16692
  },
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"
16693
+ is_device_error: { enum: [true], type: "boolean" },
16694
+ message: { type: "string" }
16695
+ },
16696
+ required: ["message", "is_device_error", "error_code"],
16697
+ type: "object"
16698
+ },
16699
+ {
16700
+ description: "User is not authorized to use the August Lock.",
16701
+ properties: {
16702
+ error_code: {
16703
+ description: "Unique identifier of the type of error. Enables quick recognition and categorization of the issue.",
16704
+ enum: ["august_lock_not_authorized"],
16705
+ type: "string"
16934
16706
  },
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"
16707
+ is_device_error: { enum: [true], type: "boolean" },
16708
+ message: { type: "string" }
16709
+ },
16710
+ required: ["message", "is_device_error", "error_code"],
16711
+ type: "object"
16712
+ },
16713
+ {
16714
+ description: "Lock is not connected to the Seam Bridge.",
16715
+ properties: {
16716
+ error_code: {
16717
+ description: "Unique identifier of the type of error. Enables quick recognition and categorization of the issue.",
16718
+ enum: ["august_lock_missing_bridge"],
16719
+ type: "string"
16948
16720
  },
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"
16721
+ is_device_error: { enum: [true], type: "boolean" },
16722
+ message: { type: "string" }
16723
+ },
16724
+ required: ["message", "is_device_error", "error_code"],
16725
+ type: "object"
16726
+ },
16727
+ {
16728
+ description: "Salto site user limit reached.",
16729
+ properties: {
16730
+ error_code: {
16731
+ description: "Unique identifier of the type of error. Enables quick recognition and categorization of the issue.",
16732
+ enum: ["salto_site_user_limit_reached"],
16733
+ type: "string"
16962
16734
  },
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"
16735
+ is_device_error: { enum: [true], type: "boolean" },
16736
+ message: { type: "string" }
16737
+ },
16738
+ required: ["message", "is_device_error", "error_code"],
16739
+ type: "object"
16740
+ },
16741
+ {
16742
+ description: "Lock is not paired with a Gateway.",
16743
+ properties: {
16744
+ error_code: {
16745
+ description: "Unique identifier of the type of error. Enables quick recognition and categorization of the issue.",
16746
+ enum: ["ttlock_lock_not_paired_to_gateway"],
16747
+ type: "string"
16976
16748
  },
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"
16749
+ is_device_error: { enum: [true], type: "boolean" },
16750
+ message: { type: "string" }
16751
+ },
16752
+ required: ["message", "is_device_error", "error_code"],
16753
+ type: "object"
16754
+ },
16755
+ {
16756
+ description: "Missing device credentials.",
16757
+ properties: {
16758
+ error_code: {
16759
+ description: "Unique identifier of the type of error. Enables quick recognition and categorization of the issue.",
16760
+ enum: ["missing_device_credentials"],
16761
+ type: "string"
16990
16762
  },
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"
16763
+ is_device_error: { enum: [true], type: "boolean" },
16764
+ message: { type: "string" }
16765
+ },
16766
+ required: ["message", "is_device_error", "error_code"],
16767
+ type: "object"
16768
+ },
16769
+ {
16770
+ description: "The auxiliary heat is running.",
16771
+ properties: {
16772
+ error_code: {
16773
+ description: "Unique identifier of the type of error. Enables quick recognition and categorization of the issue.",
16774
+ enum: ["auxiliary_heat_running"],
16775
+ type: "string"
17004
16776
  },
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"
16777
+ is_device_error: { enum: [true], type: "boolean" },
16778
+ message: { type: "string" }
16779
+ },
16780
+ required: ["message", "is_device_error", "error_code"],
16781
+ type: "object"
16782
+ },
16783
+ {
16784
+ description: "Subscription required to connect.",
16785
+ properties: {
16786
+ error_code: {
16787
+ description: "Unique identifier of the type of error. Enables quick recognition and categorization of the issue.",
16788
+ enum: ["subscription_required"],
16789
+ type: "string"
17018
16790
  },
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
- ]
16791
+ is_device_error: { enum: [true], type: "boolean" },
16792
+ message: { type: "string" }
16793
+ },
16794
+ required: ["message", "is_device_error", "error_code"],
16795
+ type: "object"
17034
16796
  },
17035
16797
  {
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"
16798
+ description: "Account is disconnected.",
16799
+ properties: {
16800
+ error_code: {
16801
+ description: "Unique identifier of the type of error. Enables quick recognition and categorization of the issue.",
16802
+ enum: ["account_disconnected"],
16803
+ type: "string"
17057
16804
  },
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
- ]
16805
+ is_connected_account_error: {
16806
+ enum: [true],
16807
+ type: "boolean"
16808
+ },
16809
+ message: { type: "string" }
16810
+ },
16811
+ required: [
16812
+ "message",
16813
+ "is_connected_account_error",
16814
+ "error_code"
16815
+ ],
16816
+ type: "object"
16817
+ },
16818
+ {
16819
+ description: "Credentials provided were invalid.",
16820
+ properties: {
16821
+ error_code: {
16822
+ description: "Unique identifier of the type of error. Enables quick recognition and categorization of the issue.",
16823
+ enum: ["invalid_credentials"],
16824
+ type: "string"
16825
+ },
16826
+ is_connected_account_error: {
16827
+ enum: [true],
16828
+ type: "boolean"
16829
+ },
16830
+ message: { type: "string" }
16831
+ },
16832
+ required: [
16833
+ "message",
16834
+ "is_connected_account_error",
16835
+ "error_code"
16836
+ ],
16837
+ type: "object"
17080
16838
  }
17081
16839
  ]
17082
16840
  },
@@ -17221,6 +16979,7 @@ var openapi_default = {
17221
16979
  warnings: {
17222
16980
  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
16981
  items: {
16982
+ discriminator: { propertyName: "warning_code" },
17224
16983
  oneOf: [
17225
16984
  {
17226
16985
  description: "Backup access code unhealthy.",