@seamapi/types 1.345.0 → 1.345.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.
- package/dist/connect.cjs +262 -699
- package/dist/connect.cjs.map +1 -1
- package/dist/connect.d.cts +149 -499
- package/lib/seam/connect/models/devices/device-type.js +3 -1
- package/lib/seam/connect/models/devices/device-type.js.map +1 -1
- package/lib/seam/connect/models/devices/phone-properties.js +7 -3
- package/lib/seam/connect/models/devices/phone-properties.js.map +1 -1
- package/lib/seam/connect/models/devices/phone.d.ts +29 -2450
- package/lib/seam/connect/models/devices/phone.js +36 -15
- package/lib/seam/connect/models/devices/phone.js.map +1 -1
- package/lib/seam/connect/openapi.d.ts +104 -158
- package/lib/seam/connect/openapi.js +68 -503
- package/lib/seam/connect/openapi.js.map +1 -1
- package/lib/seam/connect/route-types.d.ts +45 -341
- package/package.json +2 -2
- package/src/lib/seam/connect/models/devices/device-type.ts +3 -3
- package/src/lib/seam/connect/models/devices/phone-properties.ts +36 -32
- package/src/lib/seam/connect/models/devices/phone.ts +53 -15
- package/src/lib/seam/connect/openapi.ts +250 -723
- package/src/lib/seam/connect/route-types.ts +45 -419
package/dist/connect.cjs
CHANGED
|
@@ -796,9 +796,7 @@ var PHONE_DEVICE_TYPE = {
|
|
|
796
796
|
var PHONE_DEVICE_TYPE_LIST = Object.values(
|
|
797
797
|
PHONE_DEVICE_TYPE
|
|
798
798
|
);
|
|
799
|
-
var phone_device_type = zod.z.enum(
|
|
800
|
-
Object.values(PHONE_DEVICE_TYPE_LIST)
|
|
801
|
-
);
|
|
799
|
+
var phone_device_type = zod.z.enum(Object.values(PHONE_DEVICE_TYPE_LIST)).describe("Type of phone.");
|
|
802
800
|
var any_device_type = zod.z.union([
|
|
803
801
|
lock_device_type,
|
|
804
802
|
noise_sensor_device_type,
|
|
@@ -822,7 +820,7 @@ var phone_specific_properties = zod.z.object({
|
|
|
822
820
|
"Indicates whether the credential service has an active associated phone."
|
|
823
821
|
)
|
|
824
822
|
}).optional().describe("Salto Space credential service metadata for the phone.")
|
|
825
|
-
});
|
|
823
|
+
}).describe("Properties of the phone.");
|
|
826
824
|
|
|
827
825
|
// src/lib/seam/connect/models/devices/device.ts
|
|
828
826
|
var device_capability_flags2 = models_exports.device_capability_flags.extend({
|
|
@@ -8639,7 +8637,11 @@ var openapi_default = {
|
|
|
8639
8637
|
],
|
|
8640
8638
|
type: "string"
|
|
8641
8639
|
},
|
|
8642
|
-
{
|
|
8640
|
+
{
|
|
8641
|
+
description: "Type of phone.",
|
|
8642
|
+
enum: ["ios_phone", "android_phone"],
|
|
8643
|
+
type: "string"
|
|
8644
|
+
}
|
|
8643
8645
|
]
|
|
8644
8646
|
},
|
|
8645
8647
|
display_name: {
|
|
@@ -9057,6 +9059,7 @@ var openapi_default = {
|
|
|
9057
9059
|
type: "object"
|
|
9058
9060
|
},
|
|
9059
9061
|
{
|
|
9062
|
+
description: "Properties of the phone.",
|
|
9060
9063
|
properties: {
|
|
9061
9064
|
assa_abloy_credential_service_metadata: {
|
|
9062
9065
|
description: "ASSA ABLOY Credential Service metadata for the phone.",
|
|
@@ -14545,36 +14548,10 @@ var openapi_default = {
|
|
|
14545
14548
|
"x-route-path": "/noise_sensors/noise_thresholds"
|
|
14546
14549
|
},
|
|
14547
14550
|
phone: {
|
|
14548
|
-
description: "
|
|
14551
|
+
description: "Represents an app user's mobile phone.",
|
|
14549
14552
|
properties: {
|
|
14550
|
-
can_hvac_cool: { type: "boolean" },
|
|
14551
|
-
can_hvac_heat: { type: "boolean" },
|
|
14552
|
-
can_hvac_heat_cool: { type: "boolean" },
|
|
14553
|
-
can_program_offline_access_codes: { type: "boolean" },
|
|
14554
|
-
can_program_online_access_codes: { type: "boolean" },
|
|
14555
|
-
can_remotely_lock: { type: "boolean" },
|
|
14556
|
-
can_remotely_unlock: { type: "boolean" },
|
|
14557
|
-
can_simulate_connection: { type: "boolean" },
|
|
14558
|
-
can_simulate_disconnection: { type: "boolean" },
|
|
14559
|
-
can_simulate_removal: { type: "boolean" },
|
|
14560
|
-
can_turn_off_hvac: { type: "boolean" },
|
|
14561
|
-
capabilities_supported: {
|
|
14562
|
-
description: 'Collection of capabilities that the device supports when connected to Seam. Values are "access_code," which indicates that the device can manage and utilize digital PIN codes for secure access; "lock," which indicates that the device controls a door locking mechanism, enabling the remote opening and closing of doors and other entry points; "noise_detection," which indicates that the device supports monitoring and responding to ambient noise levels; "thermostat," which indicates that the device can regulate and adjust indoor temperatures; and "battery," which indicates that the device can manage battery life and health.',
|
|
14563
|
-
items: {
|
|
14564
|
-
enum: [
|
|
14565
|
-
"access_code",
|
|
14566
|
-
"lock",
|
|
14567
|
-
"noise_detection",
|
|
14568
|
-
"thermostat",
|
|
14569
|
-
"battery",
|
|
14570
|
-
"phone"
|
|
14571
|
-
],
|
|
14572
|
-
type: "string"
|
|
14573
|
-
},
|
|
14574
|
-
type: "array"
|
|
14575
|
-
},
|
|
14576
14553
|
created_at: {
|
|
14577
|
-
description: "Date and time at which the
|
|
14554
|
+
description: "Date and time at which the `phone` was created.",
|
|
14578
14555
|
format: "date-time",
|
|
14579
14556
|
type: "string"
|
|
14580
14557
|
},
|
|
@@ -14582,721 +14559,278 @@ var openapi_default = {
|
|
|
14582
14559
|
additionalProperties: {
|
|
14583
14560
|
oneOf: [{ type: "string" }, { type: "boolean" }]
|
|
14584
14561
|
},
|
|
14562
|
+
description: "Optional [custom metadata](https://docs.seam.co/latest/core-concepts/devices/adding-custom-metadata-to-a-device) for the phone.",
|
|
14585
14563
|
type: "object"
|
|
14586
14564
|
},
|
|
14587
14565
|
device_id: {
|
|
14588
|
-
description: "
|
|
14566
|
+
description: "ID of the `phone`.",
|
|
14589
14567
|
format: "uuid",
|
|
14590
14568
|
type: "string"
|
|
14591
14569
|
},
|
|
14592
14570
|
device_type: {
|
|
14593
14571
|
description: "Type of phone.",
|
|
14594
|
-
enum: ["
|
|
14572
|
+
enum: ["ios_phone", "android_phone"],
|
|
14595
14573
|
type: "string"
|
|
14596
14574
|
},
|
|
14597
14575
|
display_name: {
|
|
14598
|
-
description: "Display name of the
|
|
14576
|
+
description: "Display name of the phone. Defaults to `nickname` (if it is set) or `properties.appearance.name` otherwise. Enables administrators and users to identify the phone easily, especially when there are numerous phones.",
|
|
14599
14577
|
type: "string"
|
|
14600
14578
|
},
|
|
14601
14579
|
errors: {
|
|
14602
|
-
description:
|
|
14580
|
+
description: "Errors associated with the `phone`.",
|
|
14581
|
+
items: {
|
|
14582
|
+
properties: {
|
|
14583
|
+
error_code: { type: "string" },
|
|
14584
|
+
message: { type: "string" }
|
|
14585
|
+
},
|
|
14586
|
+
required: ["error_code", "message"],
|
|
14587
|
+
type: "object"
|
|
14588
|
+
},
|
|
14589
|
+
type: "array"
|
|
14590
|
+
},
|
|
14591
|
+
nickname: {
|
|
14592
|
+
description: "Optional nickname to describe the phone, settable through Seam.",
|
|
14593
|
+
type: "string"
|
|
14594
|
+
},
|
|
14595
|
+
properties: {
|
|
14596
|
+
description: "Properties of the phone.",
|
|
14597
|
+
properties: {
|
|
14598
|
+
assa_abloy_credential_service_metadata: {
|
|
14599
|
+
description: "ASSA ABLOY Credential Service metadata for the phone.",
|
|
14600
|
+
properties: {
|
|
14601
|
+
endpoints: {
|
|
14602
|
+
description: "Endpoints associated with the phone.",
|
|
14603
|
+
items: {
|
|
14604
|
+
properties: {
|
|
14605
|
+
endpoint_id: {
|
|
14606
|
+
description: "ID of the associated endpoint.",
|
|
14607
|
+
type: "string"
|
|
14608
|
+
},
|
|
14609
|
+
is_active: {
|
|
14610
|
+
description: "Indicated whether the endpoint is active.",
|
|
14611
|
+
type: "boolean"
|
|
14612
|
+
}
|
|
14613
|
+
},
|
|
14614
|
+
required: ["endpoint_id", "is_active"],
|
|
14615
|
+
type: "object"
|
|
14616
|
+
},
|
|
14617
|
+
type: "array"
|
|
14618
|
+
},
|
|
14619
|
+
has_active_endpoint: {
|
|
14620
|
+
description: "Indicates whether the credential service has active endpoints associated with the phone.",
|
|
14621
|
+
type: "boolean"
|
|
14622
|
+
}
|
|
14623
|
+
},
|
|
14624
|
+
required: ["has_active_endpoint", "endpoints"],
|
|
14625
|
+
type: "object"
|
|
14626
|
+
},
|
|
14627
|
+
salto_space_credential_service_metadata: {
|
|
14628
|
+
description: "Salto Space credential service metadata for the phone.",
|
|
14629
|
+
properties: {
|
|
14630
|
+
has_active_phone: {
|
|
14631
|
+
description: "Indicates whether the credential service has an active associated phone.",
|
|
14632
|
+
type: "boolean"
|
|
14633
|
+
}
|
|
14634
|
+
},
|
|
14635
|
+
required: ["has_active_phone"],
|
|
14636
|
+
type: "object"
|
|
14637
|
+
}
|
|
14638
|
+
},
|
|
14639
|
+
type: "object"
|
|
14640
|
+
},
|
|
14641
|
+
warnings: {
|
|
14642
|
+
description: "Warnings associated with the `phone`.",
|
|
14643
|
+
items: {
|
|
14644
|
+
properties: {
|
|
14645
|
+
message: { type: "string" },
|
|
14646
|
+
warning_code: { type: "string" }
|
|
14647
|
+
},
|
|
14648
|
+
required: ["warning_code", "message"],
|
|
14649
|
+
type: "object"
|
|
14650
|
+
},
|
|
14651
|
+
type: "array"
|
|
14652
|
+
},
|
|
14653
|
+
workspace_id: {
|
|
14654
|
+
description: "ID of the [workspace](https://docs.seam.co/latest/core-concepts/workspaces) that contains the `phone`.",
|
|
14655
|
+
format: "uuid",
|
|
14656
|
+
type: "string"
|
|
14657
|
+
}
|
|
14658
|
+
},
|
|
14659
|
+
required: [
|
|
14660
|
+
"device_id",
|
|
14661
|
+
"display_name",
|
|
14662
|
+
"workspace_id",
|
|
14663
|
+
"created_at",
|
|
14664
|
+
"custom_metadata",
|
|
14665
|
+
"errors",
|
|
14666
|
+
"warnings",
|
|
14667
|
+
"device_type",
|
|
14668
|
+
"properties"
|
|
14669
|
+
],
|
|
14670
|
+
type: "object",
|
|
14671
|
+
"x-route-path": "/phones"
|
|
14672
|
+
},
|
|
14673
|
+
thermostat_schedule: {
|
|
14674
|
+
description: "Represents a [thermostat schedule](https://docs.seam.co/latest/capability-guides/thermostats/creating-and-managing-thermostat-schedules) that activates a configured [climate preset](https://docs.seam.co/latest/capability-guides/thermostats/creating-and-managing-climate-presets) on a [thermostat](https://docs.seam.co/latest/capability-guides/thermostats) at a specified starting time and deactivates the climate preset at a specified ending time.",
|
|
14675
|
+
properties: {
|
|
14676
|
+
climate_preset_key: {
|
|
14677
|
+
description: "Key of the [climate preset](https://docs.seam.co/latest/capability-guides/thermostats/creating-and-managing-climate-presets) to use for the thermostat schedule.",
|
|
14678
|
+
type: "string"
|
|
14679
|
+
},
|
|
14680
|
+
created_at: {
|
|
14681
|
+
description: "Date and time at which the thermostat schedule was created.",
|
|
14682
|
+
format: "date-time",
|
|
14683
|
+
type: "string"
|
|
14684
|
+
},
|
|
14685
|
+
device_id: {
|
|
14686
|
+
description: "ID of the desired thermostat device.",
|
|
14687
|
+
format: "uuid",
|
|
14688
|
+
type: "string"
|
|
14689
|
+
},
|
|
14690
|
+
ends_at: {
|
|
14691
|
+
description: "Date and time at which the thermostat schedule ends, in [ISO 8601](https://www.iso.org/iso-8601-date-and-time-format.html) format.",
|
|
14692
|
+
format: "date-time",
|
|
14693
|
+
type: "string"
|
|
14694
|
+
},
|
|
14695
|
+
errors: {
|
|
14696
|
+
description: "Array of errors associated with the thermostat schedule. Each error object within the array contains two fields: `error_code` and `message`. `error_code` is a string that uniquely identifies the type of error, enabling quick recognition and categorization of the issue. `message` provides a more detailed description of the error, offering insights into the issue and potentially how to rectify it.",
|
|
14697
|
+
items: {
|
|
14698
|
+
properties: {
|
|
14699
|
+
error_code: { type: "string" },
|
|
14700
|
+
message: { type: "string" }
|
|
14701
|
+
},
|
|
14702
|
+
required: ["error_code", "message"],
|
|
14703
|
+
type: "object"
|
|
14704
|
+
},
|
|
14705
|
+
type: "array"
|
|
14706
|
+
},
|
|
14707
|
+
max_override_period_minutes: {
|
|
14708
|
+
description: "Number of minutes for which a person at the thermostat can change the thermostat's settings after the activation of the scheduled climate preset. See also [Specifying Manual Override Permissions](https://docs.seam.co/latest/capability-guides/thermostats/creating-and-managing-thermostat-schedules#specifying-manual-override-permissions).",
|
|
14709
|
+
minimum: 0,
|
|
14710
|
+
type: "integer"
|
|
14711
|
+
},
|
|
14712
|
+
name: {
|
|
14713
|
+
description: "User-friendly name to identify the thermostat schedule.",
|
|
14714
|
+
type: "string"
|
|
14715
|
+
},
|
|
14716
|
+
starts_at: {
|
|
14717
|
+
description: "Date and time at which the thermostat schedule starts, in [ISO 8601](https://www.iso.org/iso-8601-date-and-time-format.html) format.",
|
|
14718
|
+
format: "date-time",
|
|
14719
|
+
type: "string"
|
|
14720
|
+
},
|
|
14721
|
+
thermostat_schedule_id: {
|
|
14722
|
+
description: "ID of the thermostat schedule.",
|
|
14723
|
+
format: "uuid",
|
|
14724
|
+
type: "string"
|
|
14725
|
+
},
|
|
14726
|
+
unstable_is_override_allowed: {
|
|
14727
|
+
description: "Indicates whether a person at the thermostat can change the thermostat's settings.",
|
|
14728
|
+
type: "boolean",
|
|
14729
|
+
"x-undocumented": "Unstable"
|
|
14730
|
+
}
|
|
14731
|
+
},
|
|
14732
|
+
required: [
|
|
14733
|
+
"thermostat_schedule_id",
|
|
14734
|
+
"device_id",
|
|
14735
|
+
"climate_preset_key",
|
|
14736
|
+
"max_override_period_minutes",
|
|
14737
|
+
"starts_at",
|
|
14738
|
+
"ends_at",
|
|
14739
|
+
"created_at",
|
|
14740
|
+
"errors"
|
|
14741
|
+
],
|
|
14742
|
+
type: "object",
|
|
14743
|
+
"x-route-path": "/thermostats/schedules"
|
|
14744
|
+
},
|
|
14745
|
+
unmanaged_access_code: {
|
|
14746
|
+
properties: {
|
|
14747
|
+
access_code_id: {
|
|
14748
|
+
description: "Unique identifier for the access code.",
|
|
14749
|
+
format: "uuid",
|
|
14750
|
+
type: "string"
|
|
14751
|
+
},
|
|
14752
|
+
code: {
|
|
14753
|
+
description: "Code used for access. Typically, a numeric or alphanumeric string.",
|
|
14754
|
+
nullable: true,
|
|
14755
|
+
type: "string"
|
|
14756
|
+
},
|
|
14757
|
+
created_at: {
|
|
14758
|
+
description: "Date and time at which the access code was created.",
|
|
14759
|
+
format: "date-time",
|
|
14760
|
+
type: "string"
|
|
14761
|
+
},
|
|
14762
|
+
device_id: {
|
|
14763
|
+
description: "Unique identifier for the device associated with the access code.",
|
|
14764
|
+
format: "uuid",
|
|
14765
|
+
type: "string"
|
|
14766
|
+
},
|
|
14767
|
+
ends_at: {
|
|
14768
|
+
description: "Date and time after which the time-bound access code becomes inactive.",
|
|
14769
|
+
format: "date-time",
|
|
14770
|
+
nullable: true,
|
|
14771
|
+
type: "string"
|
|
14772
|
+
},
|
|
14773
|
+
errors: {
|
|
14774
|
+
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.',
|
|
14603
14775
|
items: {
|
|
14604
14776
|
discriminator: { propertyName: "error_code" },
|
|
14605
14777
|
oneOf: [
|
|
14606
14778
|
{
|
|
14607
|
-
description: "
|
|
14779
|
+
description: "Failed to set code on Smart Things device.",
|
|
14608
14780
|
properties: {
|
|
14609
14781
|
error_code: {
|
|
14610
14782
|
description: "Unique identifier of the type of error. Enables quick recognition and categorization of the issue.",
|
|
14611
|
-
enum: ["
|
|
14783
|
+
enum: ["smartthings_failed_to_set_access_code"],
|
|
14612
14784
|
type: "string"
|
|
14613
14785
|
},
|
|
14614
|
-
|
|
14786
|
+
is_access_code_error: { enum: [true], type: "boolean" },
|
|
14615
14787
|
message: { type: "string" }
|
|
14616
14788
|
},
|
|
14617
|
-
required: ["message", "
|
|
14789
|
+
required: ["message", "is_access_code_error", "error_code"],
|
|
14618
14790
|
type: "object"
|
|
14619
14791
|
},
|
|
14620
14792
|
{
|
|
14621
|
-
description: "
|
|
14793
|
+
description: "Failed to set code after multiple retries.",
|
|
14622
14794
|
properties: {
|
|
14623
14795
|
error_code: {
|
|
14624
14796
|
description: "Unique identifier of the type of error. Enables quick recognition and categorization of the issue.",
|
|
14625
|
-
enum: [
|
|
14797
|
+
enum: [
|
|
14798
|
+
"smartthings_failed_to_set_after_multiple_retries"
|
|
14799
|
+
],
|
|
14626
14800
|
type: "string"
|
|
14627
14801
|
},
|
|
14628
|
-
|
|
14802
|
+
is_access_code_error: { enum: [true], type: "boolean" },
|
|
14629
14803
|
message: { type: "string" }
|
|
14630
14804
|
},
|
|
14631
|
-
required: ["message", "
|
|
14805
|
+
required: ["message", "is_access_code_error", "error_code"],
|
|
14632
14806
|
type: "object"
|
|
14633
14807
|
},
|
|
14634
14808
|
{
|
|
14635
|
-
description: "
|
|
14809
|
+
description: "Failed to set code on device.",
|
|
14636
14810
|
properties: {
|
|
14637
14811
|
error_code: {
|
|
14638
14812
|
description: "Unique identifier of the type of error. Enables quick recognition and categorization of the issue.",
|
|
14639
|
-
enum: ["
|
|
14813
|
+
enum: ["failed_to_set_on_device"],
|
|
14640
14814
|
type: "string"
|
|
14641
14815
|
},
|
|
14642
|
-
|
|
14816
|
+
is_access_code_error: { enum: [true], type: "boolean" },
|
|
14643
14817
|
message: { type: "string" }
|
|
14644
14818
|
},
|
|
14645
|
-
required: ["message", "
|
|
14819
|
+
required: ["message", "is_access_code_error", "error_code"],
|
|
14646
14820
|
type: "object"
|
|
14647
14821
|
},
|
|
14648
14822
|
{
|
|
14649
|
-
description: "
|
|
14823
|
+
description: "Failed to remove code from device.",
|
|
14650
14824
|
properties: {
|
|
14651
14825
|
error_code: {
|
|
14652
14826
|
description: "Unique identifier of the type of error. Enables quick recognition and categorization of the issue.",
|
|
14653
|
-
enum: ["
|
|
14827
|
+
enum: ["failed_to_remove_from_device"],
|
|
14654
14828
|
type: "string"
|
|
14655
14829
|
},
|
|
14656
|
-
|
|
14830
|
+
is_access_code_error: { enum: [true], type: "boolean" },
|
|
14657
14831
|
message: { type: "string" }
|
|
14658
14832
|
},
|
|
14659
|
-
required: ["message", "
|
|
14660
|
-
type: "object"
|
|
14661
|
-
},
|
|
14662
|
-
{
|
|
14663
|
-
description: "The backup access code pool is empty.",
|
|
14664
|
-
properties: {
|
|
14665
|
-
error_code: {
|
|
14666
|
-
description: "Unique identifier of the type of error. Enables quick recognition and categorization of the issue.",
|
|
14667
|
-
enum: ["empty_backup_access_code_pool"],
|
|
14668
|
-
type: "string"
|
|
14669
|
-
},
|
|
14670
|
-
is_device_error: { enum: [true], type: "boolean" },
|
|
14671
|
-
message: { type: "string" }
|
|
14672
|
-
},
|
|
14673
|
-
required: ["message", "is_device_error", "error_code"],
|
|
14674
|
-
type: "object"
|
|
14675
|
-
},
|
|
14676
|
-
{
|
|
14677
|
-
description: "User is not authorized to use the August Lock.",
|
|
14678
|
-
properties: {
|
|
14679
|
-
error_code: {
|
|
14680
|
-
description: "Unique identifier of the type of error. Enables quick recognition and categorization of the issue.",
|
|
14681
|
-
enum: ["august_lock_not_authorized"],
|
|
14682
|
-
type: "string"
|
|
14683
|
-
},
|
|
14684
|
-
is_device_error: { enum: [true], type: "boolean" },
|
|
14685
|
-
message: { type: "string" }
|
|
14686
|
-
},
|
|
14687
|
-
required: ["message", "is_device_error", "error_code"],
|
|
14688
|
-
type: "object"
|
|
14689
|
-
},
|
|
14690
|
-
{
|
|
14691
|
-
description: "Lock is not connected to the Seam Bridge.",
|
|
14692
|
-
properties: {
|
|
14693
|
-
error_code: {
|
|
14694
|
-
description: "Unique identifier of the type of error. Enables quick recognition and categorization of the issue.",
|
|
14695
|
-
enum: ["august_lock_missing_bridge"],
|
|
14696
|
-
type: "string"
|
|
14697
|
-
},
|
|
14698
|
-
is_device_error: { enum: [true], type: "boolean" },
|
|
14699
|
-
message: { type: "string" }
|
|
14700
|
-
},
|
|
14701
|
-
required: ["message", "is_device_error", "error_code"],
|
|
14702
|
-
type: "object"
|
|
14703
|
-
},
|
|
14704
|
-
{
|
|
14705
|
-
description: "Salto site user limit reached.",
|
|
14706
|
-
properties: {
|
|
14707
|
-
error_code: {
|
|
14708
|
-
description: "Unique identifier of the type of error. Enables quick recognition and categorization of the issue.",
|
|
14709
|
-
enum: ["salto_site_user_limit_reached"],
|
|
14710
|
-
type: "string"
|
|
14711
|
-
},
|
|
14712
|
-
is_device_error: { enum: [true], type: "boolean" },
|
|
14713
|
-
message: { type: "string" }
|
|
14714
|
-
},
|
|
14715
|
-
required: ["message", "is_device_error", "error_code"],
|
|
14716
|
-
type: "object"
|
|
14717
|
-
},
|
|
14718
|
-
{
|
|
14719
|
-
description: "Lock is not paired with a Gateway.",
|
|
14720
|
-
properties: {
|
|
14721
|
-
error_code: {
|
|
14722
|
-
description: "Unique identifier of the type of error. Enables quick recognition and categorization of the issue.",
|
|
14723
|
-
enum: ["ttlock_lock_not_paired_to_gateway"],
|
|
14724
|
-
type: "string"
|
|
14725
|
-
},
|
|
14726
|
-
is_device_error: { enum: [true], type: "boolean" },
|
|
14727
|
-
message: { type: "string" }
|
|
14728
|
-
},
|
|
14729
|
-
required: ["message", "is_device_error", "error_code"],
|
|
14730
|
-
type: "object"
|
|
14731
|
-
},
|
|
14732
|
-
{
|
|
14733
|
-
description: "Missing device credentials.",
|
|
14734
|
-
properties: {
|
|
14735
|
-
error_code: {
|
|
14736
|
-
description: "Unique identifier of the type of error. Enables quick recognition and categorization of the issue.",
|
|
14737
|
-
enum: ["missing_device_credentials"],
|
|
14738
|
-
type: "string"
|
|
14739
|
-
},
|
|
14740
|
-
is_device_error: { enum: [true], type: "boolean" },
|
|
14741
|
-
message: { type: "string" }
|
|
14742
|
-
},
|
|
14743
|
-
required: ["message", "is_device_error", "error_code"],
|
|
14744
|
-
type: "object"
|
|
14745
|
-
},
|
|
14746
|
-
{
|
|
14747
|
-
description: "The auxiliary heat is running.",
|
|
14748
|
-
properties: {
|
|
14749
|
-
error_code: {
|
|
14750
|
-
description: "Unique identifier of the type of error. Enables quick recognition and categorization of the issue.",
|
|
14751
|
-
enum: ["auxiliary_heat_running"],
|
|
14752
|
-
type: "string"
|
|
14753
|
-
},
|
|
14754
|
-
is_device_error: { enum: [true], type: "boolean" },
|
|
14755
|
-
message: { type: "string" }
|
|
14756
|
-
},
|
|
14757
|
-
required: ["message", "is_device_error", "error_code"],
|
|
14758
|
-
type: "object"
|
|
14759
|
-
},
|
|
14760
|
-
{
|
|
14761
|
-
description: "Subscription required to connect.",
|
|
14762
|
-
properties: {
|
|
14763
|
-
error_code: {
|
|
14764
|
-
description: "Unique identifier of the type of error. Enables quick recognition and categorization of the issue.",
|
|
14765
|
-
enum: ["subscription_required"],
|
|
14766
|
-
type: "string"
|
|
14767
|
-
},
|
|
14768
|
-
is_device_error: { enum: [true], type: "boolean" },
|
|
14769
|
-
message: { type: "string" }
|
|
14770
|
-
},
|
|
14771
|
-
required: ["message", "is_device_error", "error_code"],
|
|
14772
|
-
type: "object"
|
|
14773
|
-
},
|
|
14774
|
-
{
|
|
14775
|
-
description: "Account is disconnected.",
|
|
14776
|
-
properties: {
|
|
14777
|
-
error_code: {
|
|
14778
|
-
description: "Unique identifier of the type of error. Enables quick recognition and categorization of the issue.",
|
|
14779
|
-
enum: ["account_disconnected"],
|
|
14780
|
-
type: "string"
|
|
14781
|
-
},
|
|
14782
|
-
is_connected_account_error: {
|
|
14783
|
-
enum: [true],
|
|
14784
|
-
type: "boolean"
|
|
14785
|
-
},
|
|
14786
|
-
message: { type: "string" }
|
|
14787
|
-
},
|
|
14788
|
-
required: [
|
|
14789
|
-
"message",
|
|
14790
|
-
"is_connected_account_error",
|
|
14791
|
-
"error_code"
|
|
14792
|
-
],
|
|
14793
|
-
type: "object"
|
|
14794
|
-
},
|
|
14795
|
-
{
|
|
14796
|
-
description: "Credentials provided were invalid.",
|
|
14797
|
-
properties: {
|
|
14798
|
-
error_code: {
|
|
14799
|
-
description: "Unique identifier of the type of error. Enables quick recognition and categorization of the issue.",
|
|
14800
|
-
enum: ["invalid_credentials"],
|
|
14801
|
-
type: "string"
|
|
14802
|
-
},
|
|
14803
|
-
is_connected_account_error: {
|
|
14804
|
-
enum: [true],
|
|
14805
|
-
type: "boolean"
|
|
14806
|
-
},
|
|
14807
|
-
message: { type: "string" }
|
|
14808
|
-
},
|
|
14809
|
-
required: [
|
|
14810
|
-
"message",
|
|
14811
|
-
"is_connected_account_error",
|
|
14812
|
-
"error_code"
|
|
14813
|
-
],
|
|
14814
|
-
type: "object"
|
|
14815
|
-
}
|
|
14816
|
-
]
|
|
14817
|
-
},
|
|
14818
|
-
type: "array"
|
|
14819
|
-
},
|
|
14820
|
-
is_managed: {
|
|
14821
|
-
description: "Indicates whether Seam manages the device.",
|
|
14822
|
-
enum: [true],
|
|
14823
|
-
type: "boolean"
|
|
14824
|
-
},
|
|
14825
|
-
location: {
|
|
14826
|
-
description: "Location information for the device.",
|
|
14827
|
-
nullable: true,
|
|
14828
|
-
properties: {
|
|
14829
|
-
location_name: {
|
|
14830
|
-
description: "Name of the device location.",
|
|
14831
|
-
type: "string"
|
|
14832
|
-
},
|
|
14833
|
-
timezone: {
|
|
14834
|
-
description: "Time zone of the device location.",
|
|
14835
|
-
type: "string"
|
|
14836
|
-
}
|
|
14837
|
-
},
|
|
14838
|
-
type: "object"
|
|
14839
|
-
},
|
|
14840
|
-
nickname: {
|
|
14841
|
-
description: "Optional nickname to describe the device, settable through Seam",
|
|
14842
|
-
type: "string"
|
|
14843
|
-
},
|
|
14844
|
-
properties: {
|
|
14845
|
-
properties: {
|
|
14846
|
-
assa_abloy_credential_service_metadata: {
|
|
14847
|
-
description: "ASSA ABLOY Credential Service metadata for the phone.",
|
|
14848
|
-
properties: {
|
|
14849
|
-
endpoints: {
|
|
14850
|
-
description: "Endpoints associated with the phone.",
|
|
14851
|
-
items: {
|
|
14852
|
-
properties: {
|
|
14853
|
-
endpoint_id: {
|
|
14854
|
-
description: "ID of the associated endpoint.",
|
|
14855
|
-
type: "string"
|
|
14856
|
-
},
|
|
14857
|
-
is_active: {
|
|
14858
|
-
description: "Indicated whether the endpoint is active.",
|
|
14859
|
-
type: "boolean"
|
|
14860
|
-
}
|
|
14861
|
-
},
|
|
14862
|
-
required: ["endpoint_id", "is_active"],
|
|
14863
|
-
type: "object"
|
|
14864
|
-
},
|
|
14865
|
-
type: "array"
|
|
14866
|
-
},
|
|
14867
|
-
has_active_endpoint: {
|
|
14868
|
-
description: "Indicates whether the credential service has active endpoints associated with the phone.",
|
|
14869
|
-
type: "boolean"
|
|
14870
|
-
}
|
|
14871
|
-
},
|
|
14872
|
-
required: ["has_active_endpoint", "endpoints"],
|
|
14873
|
-
type: "object"
|
|
14874
|
-
},
|
|
14875
|
-
salto_space_credential_service_metadata: {
|
|
14876
|
-
description: "Salto Space credential service metadata for the phone.",
|
|
14877
|
-
properties: {
|
|
14878
|
-
has_active_phone: {
|
|
14879
|
-
description: "Indicates whether the credential service has an active associated phone.",
|
|
14880
|
-
type: "boolean"
|
|
14881
|
-
}
|
|
14882
|
-
},
|
|
14883
|
-
required: ["has_active_phone"],
|
|
14884
|
-
type: "object"
|
|
14885
|
-
}
|
|
14886
|
-
},
|
|
14887
|
-
type: "object"
|
|
14888
|
-
},
|
|
14889
|
-
warnings: {
|
|
14890
|
-
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.',
|
|
14891
|
-
items: {
|
|
14892
|
-
discriminator: { propertyName: "warning_code" },
|
|
14893
|
-
oneOf: [
|
|
14894
|
-
{
|
|
14895
|
-
description: "Backup access code unhealthy.",
|
|
14896
|
-
properties: {
|
|
14897
|
-
message: { type: "string" },
|
|
14898
|
-
warning_code: {
|
|
14899
|
-
description: "Unique identifier of the type of warning. Enables quick recognition and categorization of the issue.",
|
|
14900
|
-
enum: ["partial_backup_access_code_pool"],
|
|
14901
|
-
type: "string"
|
|
14902
|
-
}
|
|
14903
|
-
},
|
|
14904
|
-
required: ["message", "warning_code"],
|
|
14905
|
-
type: "object"
|
|
14906
|
-
},
|
|
14907
|
-
{
|
|
14908
|
-
description: "Too many backup codes.",
|
|
14909
|
-
properties: {
|
|
14910
|
-
message: { type: "string" },
|
|
14911
|
-
warning_code: {
|
|
14912
|
-
description: "Unique identifier of the type of warning. Enables quick recognition and categorization of the issue.",
|
|
14913
|
-
enum: ["many_active_backup_codes"],
|
|
14914
|
-
type: "string"
|
|
14915
|
-
}
|
|
14916
|
-
},
|
|
14917
|
-
required: ["message", "warning_code"],
|
|
14918
|
-
type: "object"
|
|
14919
|
-
},
|
|
14920
|
-
{
|
|
14921
|
-
description: "A Salto Lock displaying an unknown device type.",
|
|
14922
|
-
properties: {
|
|
14923
|
-
message: { type: "string" },
|
|
14924
|
-
warning_code: {
|
|
14925
|
-
description: "Unique identifier of the type of warning. Enables quick recognition and categorization of the issue.",
|
|
14926
|
-
enum: ["salto_unknown_device_type"],
|
|
14927
|
-
type: "string"
|
|
14928
|
-
}
|
|
14929
|
-
},
|
|
14930
|
-
required: ["message", "warning_code"],
|
|
14931
|
-
type: "object"
|
|
14932
|
-
},
|
|
14933
|
-
{
|
|
14934
|
-
description: "Wyze Lock is not connected to a gateway.",
|
|
14935
|
-
properties: {
|
|
14936
|
-
message: { type: "string" },
|
|
14937
|
-
warning_code: {
|
|
14938
|
-
description: "Unique identifier of the type of warning. Enables quick recognition and categorization of the issue.",
|
|
14939
|
-
enum: ["wyze_device_missing_gateway"],
|
|
14940
|
-
type: "string"
|
|
14941
|
-
}
|
|
14942
|
-
},
|
|
14943
|
-
required: ["message", "warning_code"],
|
|
14944
|
-
type: "object"
|
|
14945
|
-
},
|
|
14946
|
-
{
|
|
14947
|
-
description: "Device is offline, but has some functionality available.",
|
|
14948
|
-
properties: {
|
|
14949
|
-
message: { type: "string" },
|
|
14950
|
-
warning_code: {
|
|
14951
|
-
description: "Unique identifier of the type of warning. Enables quick recognition and categorization of the issue.",
|
|
14952
|
-
enum: ["functional_offline_device"],
|
|
14953
|
-
type: "string"
|
|
14954
|
-
}
|
|
14955
|
-
},
|
|
14956
|
-
required: ["message", "warning_code"],
|
|
14957
|
-
type: "object"
|
|
14958
|
-
},
|
|
14959
|
-
{
|
|
14960
|
-
description: "Third-party integration detected.",
|
|
14961
|
-
properties: {
|
|
14962
|
-
message: { type: "string" },
|
|
14963
|
-
warning_code: {
|
|
14964
|
-
description: "Unique identifier of the type of warning. Enables quick recognition and categorization of the issue.",
|
|
14965
|
-
enum: ["third_party_integration_detected"],
|
|
14966
|
-
type: "string"
|
|
14967
|
-
}
|
|
14968
|
-
},
|
|
14969
|
-
required: ["message", "warning_code"],
|
|
14970
|
-
type: "object"
|
|
14971
|
-
},
|
|
14972
|
-
{
|
|
14973
|
-
description: "Nest thermostat in manual eco mode.",
|
|
14974
|
-
properties: {
|
|
14975
|
-
message: { type: "string" },
|
|
14976
|
-
warning_code: {
|
|
14977
|
-
description: "Unique identifier of the type of warning. Enables quick recognition and categorization of the issue.",
|
|
14978
|
-
enum: ["nest_thermostat_in_manual_eco_mode"],
|
|
14979
|
-
type: "string"
|
|
14980
|
-
}
|
|
14981
|
-
},
|
|
14982
|
-
required: ["message", "warning_code"],
|
|
14983
|
-
type: "object"
|
|
14984
|
-
},
|
|
14985
|
-
{
|
|
14986
|
-
description: "Remote Unlock feature not enabled in settings.",
|
|
14987
|
-
properties: {
|
|
14988
|
-
message: { type: "string" },
|
|
14989
|
-
warning_code: {
|
|
14990
|
-
description: "Unique identifier of the type of warning. Enables quick recognition and categorization of the issue.",
|
|
14991
|
-
enum: ["ttlock_lock_gateway_unlocking_not_enabled"],
|
|
14992
|
-
type: "string"
|
|
14993
|
-
}
|
|
14994
|
-
},
|
|
14995
|
-
required: ["message", "warning_code"],
|
|
14996
|
-
type: "object"
|
|
14997
|
-
},
|
|
14998
|
-
{
|
|
14999
|
-
description: "Gateway signal is weak.",
|
|
15000
|
-
properties: {
|
|
15001
|
-
message: { type: "string" },
|
|
15002
|
-
warning_code: {
|
|
15003
|
-
description: "Unique identifier of the type of warning. Enables quick recognition and categorization of the issue.",
|
|
15004
|
-
enum: ["ttlock_weak_gateway_signal"],
|
|
15005
|
-
type: "string"
|
|
15006
|
-
}
|
|
15007
|
-
},
|
|
15008
|
-
required: ["message", "warning_code"],
|
|
15009
|
-
type: "object"
|
|
15010
|
-
},
|
|
15011
|
-
{
|
|
15012
|
-
description: "Temperature threshold exceeded.",
|
|
15013
|
-
properties: {
|
|
15014
|
-
message: { type: "string" },
|
|
15015
|
-
warning_code: {
|
|
15016
|
-
description: "Unique identifier of the type of warning. Enables quick recognition and categorization of the issue.",
|
|
15017
|
-
enum: ["temperature_threshold_exceeded"],
|
|
15018
|
-
type: "string"
|
|
15019
|
-
}
|
|
15020
|
-
},
|
|
15021
|
-
required: ["message", "warning_code"],
|
|
15022
|
-
type: "object"
|
|
15023
|
-
},
|
|
15024
|
-
{
|
|
15025
|
-
description: "Device appears to be unresponsive.",
|
|
15026
|
-
properties: {
|
|
15027
|
-
message: { type: "string" },
|
|
15028
|
-
warning_code: {
|
|
15029
|
-
description: "Unique identifier of the type of warning. Enables quick recognition and categorization of the issue.",
|
|
15030
|
-
enum: ["device_communication_degraded"],
|
|
15031
|
-
type: "string"
|
|
15032
|
-
}
|
|
15033
|
-
},
|
|
15034
|
-
required: ["message", "warning_code"],
|
|
15035
|
-
type: "object"
|
|
15036
|
-
},
|
|
15037
|
-
{
|
|
15038
|
-
description: "Scheduled maintenance window detected.",
|
|
15039
|
-
properties: {
|
|
15040
|
-
message: { type: "string" },
|
|
15041
|
-
warning_code: {
|
|
15042
|
-
description: "Unique identifier of the type of warning. Enables quick recognition and categorization of the issue.",
|
|
15043
|
-
enum: ["scheduled_maintenance_window"],
|
|
15044
|
-
type: "string"
|
|
15045
|
-
}
|
|
15046
|
-
},
|
|
15047
|
-
required: ["message", "warning_code"],
|
|
15048
|
-
type: "object"
|
|
15049
|
-
},
|
|
15050
|
-
{
|
|
15051
|
-
description: "Device has flaky connection.",
|
|
15052
|
-
properties: {
|
|
15053
|
-
message: { type: "string" },
|
|
15054
|
-
warning_code: {
|
|
15055
|
-
description: "Unique identifier of the type of warning. Enables quick recognition and categorization of the issue.",
|
|
15056
|
-
enum: ["device_has_flaky_connection"],
|
|
15057
|
-
type: "string"
|
|
15058
|
-
}
|
|
15059
|
-
},
|
|
15060
|
-
required: ["message", "warning_code"],
|
|
15061
|
-
type: "object"
|
|
15062
|
-
},
|
|
15063
|
-
{
|
|
15064
|
-
description: "Lock is in Office Mode. Access Codes will not unlock doors.",
|
|
15065
|
-
properties: {
|
|
15066
|
-
message: { type: "string" },
|
|
15067
|
-
warning_code: {
|
|
15068
|
-
description: "Unique identifier of the type of warning. Enables quick recognition and categorization of the issue.",
|
|
15069
|
-
enum: ["salto_office_mode"],
|
|
15070
|
-
type: "string"
|
|
15071
|
-
}
|
|
15072
|
-
},
|
|
15073
|
-
required: ["message", "warning_code"],
|
|
15074
|
-
type: "object"
|
|
15075
|
-
},
|
|
15076
|
-
{
|
|
15077
|
-
description: "Lock is in Privacy Mode. Access Codes will not unlock doors.",
|
|
15078
|
-
properties: {
|
|
15079
|
-
message: { type: "string" },
|
|
15080
|
-
warning_code: {
|
|
15081
|
-
description: "Unique identifier of the type of warning. Enables quick recognition and categorization of the issue.",
|
|
15082
|
-
enum: ["salto_privacy_mode"],
|
|
15083
|
-
type: "string"
|
|
15084
|
-
}
|
|
15085
|
-
},
|
|
15086
|
-
required: ["message", "warning_code"],
|
|
15087
|
-
type: "object"
|
|
15088
|
-
},
|
|
15089
|
-
{
|
|
15090
|
-
description: "An unknown issue occurred while syncing the state of this phone with the provider. This issue may affect the proper functioning of this phone.",
|
|
15091
|
-
properties: {
|
|
15092
|
-
message: { type: "string" },
|
|
15093
|
-
warning_code: {
|
|
15094
|
-
description: "Unique identifier of the type of warning. Enables quick recognition and categorization of the issue.",
|
|
15095
|
-
enum: ["unknown_issue_with_phone"],
|
|
15096
|
-
type: "string"
|
|
15097
|
-
}
|
|
15098
|
-
},
|
|
15099
|
-
required: ["message", "warning_code"],
|
|
15100
|
-
type: "object"
|
|
15101
|
-
}
|
|
15102
|
-
]
|
|
15103
|
-
},
|
|
15104
|
-
type: "array"
|
|
15105
|
-
},
|
|
15106
|
-
workspace_id: {
|
|
15107
|
-
description: "Unique identifier for the Seam workspace associated with the device.",
|
|
15108
|
-
format: "uuid",
|
|
15109
|
-
type: "string"
|
|
15110
|
-
}
|
|
15111
|
-
},
|
|
15112
|
-
required: [
|
|
15113
|
-
"device_id",
|
|
15114
|
-
"device_type",
|
|
15115
|
-
"display_name",
|
|
15116
|
-
"capabilities_supported",
|
|
15117
|
-
"properties",
|
|
15118
|
-
"location",
|
|
15119
|
-
"workspace_id",
|
|
15120
|
-
"errors",
|
|
15121
|
-
"warnings",
|
|
15122
|
-
"created_at",
|
|
15123
|
-
"is_managed",
|
|
15124
|
-
"custom_metadata"
|
|
15125
|
-
],
|
|
15126
|
-
type: "object",
|
|
15127
|
-
"x-route-path": "/phones"
|
|
15128
|
-
},
|
|
15129
|
-
service_health: {
|
|
15130
|
-
properties: {
|
|
15131
|
-
description: { type: "string" },
|
|
15132
|
-
service: { type: "string" },
|
|
15133
|
-
status: { enum: ["healthy", "degraded", "down"], type: "string" }
|
|
15134
|
-
},
|
|
15135
|
-
required: ["service", "status", "description"],
|
|
15136
|
-
type: "object",
|
|
15137
|
-
"x-route-path": "/health"
|
|
15138
|
-
},
|
|
15139
|
-
thermostat_schedule: {
|
|
15140
|
-
description: "Represents a [thermostat schedule](https://docs.seam.co/latest/capability-guides/thermostats/creating-and-managing-thermostat-schedules) that activates a configured [climate preset](https://docs.seam.co/latest/capability-guides/thermostats/creating-and-managing-climate-presets) on a [thermostat](https://docs.seam.co/latest/capability-guides/thermostats) at a specified starting time and deactivates the climate preset at a specified ending time.",
|
|
15141
|
-
properties: {
|
|
15142
|
-
climate_preset_key: {
|
|
15143
|
-
description: "Key of the [climate preset](https://docs.seam.co/latest/capability-guides/thermostats/creating-and-managing-climate-presets) to use for the thermostat schedule.",
|
|
15144
|
-
type: "string"
|
|
15145
|
-
},
|
|
15146
|
-
created_at: {
|
|
15147
|
-
description: "Date and time at which the thermostat schedule was created.",
|
|
15148
|
-
format: "date-time",
|
|
15149
|
-
type: "string"
|
|
15150
|
-
},
|
|
15151
|
-
device_id: {
|
|
15152
|
-
description: "ID of the desired thermostat device.",
|
|
15153
|
-
format: "uuid",
|
|
15154
|
-
type: "string"
|
|
15155
|
-
},
|
|
15156
|
-
ends_at: {
|
|
15157
|
-
description: "Date and time at which the thermostat schedule ends, in [ISO 8601](https://www.iso.org/iso-8601-date-and-time-format.html) format.",
|
|
15158
|
-
format: "date-time",
|
|
15159
|
-
type: "string"
|
|
15160
|
-
},
|
|
15161
|
-
errors: {
|
|
15162
|
-
description: "Array of errors associated with the thermostat schedule. Each error object within the array contains two fields: `error_code` and `message`. `error_code` is a string that uniquely identifies the type of error, enabling quick recognition and categorization of the issue. `message` provides a more detailed description of the error, offering insights into the issue and potentially how to rectify it.",
|
|
15163
|
-
items: {
|
|
15164
|
-
properties: {
|
|
15165
|
-
error_code: { type: "string" },
|
|
15166
|
-
message: { type: "string" }
|
|
15167
|
-
},
|
|
15168
|
-
required: ["error_code", "message"],
|
|
15169
|
-
type: "object"
|
|
15170
|
-
},
|
|
15171
|
-
type: "array"
|
|
15172
|
-
},
|
|
15173
|
-
max_override_period_minutes: {
|
|
15174
|
-
description: "Number of minutes for which a person at the thermostat can change the thermostat's settings after the activation of the scheduled climate preset. See also [Specifying Manual Override Permissions](https://docs.seam.co/latest/capability-guides/thermostats/creating-and-managing-thermostat-schedules#specifying-manual-override-permissions).",
|
|
15175
|
-
minimum: 0,
|
|
15176
|
-
type: "integer"
|
|
15177
|
-
},
|
|
15178
|
-
name: {
|
|
15179
|
-
description: "User-friendly name to identify the thermostat schedule.",
|
|
15180
|
-
type: "string"
|
|
15181
|
-
},
|
|
15182
|
-
starts_at: {
|
|
15183
|
-
description: "Date and time at which the thermostat schedule starts, in [ISO 8601](https://www.iso.org/iso-8601-date-and-time-format.html) format.",
|
|
15184
|
-
format: "date-time",
|
|
15185
|
-
type: "string"
|
|
15186
|
-
},
|
|
15187
|
-
thermostat_schedule_id: {
|
|
15188
|
-
description: "ID of the thermostat schedule.",
|
|
15189
|
-
format: "uuid",
|
|
15190
|
-
type: "string"
|
|
15191
|
-
},
|
|
15192
|
-
unstable_is_override_allowed: {
|
|
15193
|
-
description: "Indicates whether a person at the thermostat can change the thermostat's settings.",
|
|
15194
|
-
type: "boolean",
|
|
15195
|
-
"x-undocumented": "Unstable"
|
|
15196
|
-
}
|
|
15197
|
-
},
|
|
15198
|
-
required: [
|
|
15199
|
-
"thermostat_schedule_id",
|
|
15200
|
-
"device_id",
|
|
15201
|
-
"climate_preset_key",
|
|
15202
|
-
"max_override_period_minutes",
|
|
15203
|
-
"starts_at",
|
|
15204
|
-
"ends_at",
|
|
15205
|
-
"created_at",
|
|
15206
|
-
"errors"
|
|
15207
|
-
],
|
|
15208
|
-
type: "object",
|
|
15209
|
-
"x-route-path": "/thermostats/schedules"
|
|
15210
|
-
},
|
|
15211
|
-
unmanaged_access_code: {
|
|
15212
|
-
properties: {
|
|
15213
|
-
access_code_id: {
|
|
15214
|
-
description: "Unique identifier for the access code.",
|
|
15215
|
-
format: "uuid",
|
|
15216
|
-
type: "string"
|
|
15217
|
-
},
|
|
15218
|
-
code: {
|
|
15219
|
-
description: "Code used for access. Typically, a numeric or alphanumeric string.",
|
|
15220
|
-
nullable: true,
|
|
15221
|
-
type: "string"
|
|
15222
|
-
},
|
|
15223
|
-
created_at: {
|
|
15224
|
-
description: "Date and time at which the access code was created.",
|
|
15225
|
-
format: "date-time",
|
|
15226
|
-
type: "string"
|
|
15227
|
-
},
|
|
15228
|
-
device_id: {
|
|
15229
|
-
description: "Unique identifier for the device associated with the access code.",
|
|
15230
|
-
format: "uuid",
|
|
15231
|
-
type: "string"
|
|
15232
|
-
},
|
|
15233
|
-
ends_at: {
|
|
15234
|
-
description: "Date and time after which the time-bound access code becomes inactive.",
|
|
15235
|
-
format: "date-time",
|
|
15236
|
-
nullable: true,
|
|
15237
|
-
type: "string"
|
|
15238
|
-
},
|
|
15239
|
-
errors: {
|
|
15240
|
-
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.',
|
|
15241
|
-
items: {
|
|
15242
|
-
discriminator: { propertyName: "error_code" },
|
|
15243
|
-
oneOf: [
|
|
15244
|
-
{
|
|
15245
|
-
description: "Failed to set code on Smart Things 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: ["smartthings_failed_to_set_access_code"],
|
|
15250
|
-
type: "string"
|
|
15251
|
-
},
|
|
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: "Failed to set code after multiple retries.",
|
|
15260
|
-
properties: {
|
|
15261
|
-
error_code: {
|
|
15262
|
-
description: "Unique identifier of the type of error. Enables quick recognition and categorization of the issue.",
|
|
15263
|
-
enum: [
|
|
15264
|
-
"smartthings_failed_to_set_after_multiple_retries"
|
|
15265
|
-
],
|
|
15266
|
-
type: "string"
|
|
15267
|
-
},
|
|
15268
|
-
is_access_code_error: { enum: [true], type: "boolean" },
|
|
15269
|
-
message: { type: "string" }
|
|
15270
|
-
},
|
|
15271
|
-
required: ["message", "is_access_code_error", "error_code"],
|
|
15272
|
-
type: "object"
|
|
15273
|
-
},
|
|
15274
|
-
{
|
|
15275
|
-
description: "Failed to set code on device.",
|
|
15276
|
-
properties: {
|
|
15277
|
-
error_code: {
|
|
15278
|
-
description: "Unique identifier of the type of error. Enables quick recognition and categorization of the issue.",
|
|
15279
|
-
enum: ["failed_to_set_on_device"],
|
|
15280
|
-
type: "string"
|
|
15281
|
-
},
|
|
15282
|
-
is_access_code_error: { enum: [true], type: "boolean" },
|
|
15283
|
-
message: { type: "string" }
|
|
15284
|
-
},
|
|
15285
|
-
required: ["message", "is_access_code_error", "error_code"],
|
|
15286
|
-
type: "object"
|
|
15287
|
-
},
|
|
15288
|
-
{
|
|
15289
|
-
description: "Failed to remove code from device.",
|
|
15290
|
-
properties: {
|
|
15291
|
-
error_code: {
|
|
15292
|
-
description: "Unique identifier of the type of error. Enables quick recognition and categorization of the issue.",
|
|
15293
|
-
enum: ["failed_to_remove_from_device"],
|
|
15294
|
-
type: "string"
|
|
15295
|
-
},
|
|
15296
|
-
is_access_code_error: { enum: [true], type: "boolean" },
|
|
15297
|
-
message: { type: "string" }
|
|
15298
|
-
},
|
|
15299
|
-
required: ["message", "is_access_code_error", "error_code"],
|
|
14833
|
+
required: ["message", "is_access_code_error", "error_code"],
|
|
15300
14834
|
type: "object"
|
|
15301
14835
|
},
|
|
15302
14836
|
{
|
|
@@ -16689,7 +16223,11 @@ var openapi_default = {
|
|
|
16689
16223
|
],
|
|
16690
16224
|
type: "string"
|
|
16691
16225
|
},
|
|
16692
|
-
{
|
|
16226
|
+
{
|
|
16227
|
+
description: "Type of phone.",
|
|
16228
|
+
enum: ["ios_phone", "android_phone"],
|
|
16229
|
+
type: "string"
|
|
16230
|
+
}
|
|
16693
16231
|
]
|
|
16694
16232
|
},
|
|
16695
16233
|
errors: {
|
|
@@ -23465,7 +23003,11 @@ var openapi_default = {
|
|
|
23465
23003
|
],
|
|
23466
23004
|
type: "string"
|
|
23467
23005
|
},
|
|
23468
|
-
{
|
|
23006
|
+
{
|
|
23007
|
+
description: "Type of phone.",
|
|
23008
|
+
enum: ["ios_phone", "android_phone"],
|
|
23009
|
+
type: "string"
|
|
23010
|
+
}
|
|
23469
23011
|
]
|
|
23470
23012
|
},
|
|
23471
23013
|
device_types: {
|
|
@@ -23518,6 +23060,7 @@ var openapi_default = {
|
|
|
23518
23060
|
type: "string"
|
|
23519
23061
|
},
|
|
23520
23062
|
{
|
|
23063
|
+
description: "Type of phone.",
|
|
23521
23064
|
enum: ["ios_phone", "android_phone"],
|
|
23522
23065
|
type: "string"
|
|
23523
23066
|
}
|
|
@@ -23983,7 +23526,11 @@ var openapi_default = {
|
|
|
23983
23526
|
],
|
|
23984
23527
|
type: "string"
|
|
23985
23528
|
},
|
|
23986
|
-
{
|
|
23529
|
+
{
|
|
23530
|
+
description: "Type of phone.",
|
|
23531
|
+
enum: ["ios_phone", "android_phone"],
|
|
23532
|
+
type: "string"
|
|
23533
|
+
}
|
|
23987
23534
|
]
|
|
23988
23535
|
},
|
|
23989
23536
|
device_types: {
|
|
@@ -24036,6 +23583,7 @@ var openapi_default = {
|
|
|
24036
23583
|
type: "string"
|
|
24037
23584
|
},
|
|
24038
23585
|
{
|
|
23586
|
+
description: "Type of phone.",
|
|
24039
23587
|
enum: ["ios_phone", "android_phone"],
|
|
24040
23588
|
type: "string"
|
|
24041
23589
|
}
|
|
@@ -24816,7 +24364,11 @@ var openapi_default = {
|
|
|
24816
24364
|
],
|
|
24817
24365
|
type: "string"
|
|
24818
24366
|
},
|
|
24819
|
-
{
|
|
24367
|
+
{
|
|
24368
|
+
description: "Type of phone.",
|
|
24369
|
+
enum: ["ios_phone", "android_phone"],
|
|
24370
|
+
type: "string"
|
|
24371
|
+
}
|
|
24820
24372
|
]
|
|
24821
24373
|
},
|
|
24822
24374
|
device_types: {
|
|
@@ -24869,6 +24421,7 @@ var openapi_default = {
|
|
|
24869
24421
|
type: "string"
|
|
24870
24422
|
},
|
|
24871
24423
|
{
|
|
24424
|
+
description: "Type of phone.",
|
|
24872
24425
|
enum: ["ios_phone", "android_phone"],
|
|
24873
24426
|
type: "string"
|
|
24874
24427
|
}
|
|
@@ -25297,7 +24850,11 @@ var openapi_default = {
|
|
|
25297
24850
|
],
|
|
25298
24851
|
type: "string"
|
|
25299
24852
|
},
|
|
25300
|
-
{
|
|
24853
|
+
{
|
|
24854
|
+
description: "Type of phone.",
|
|
24855
|
+
enum: ["ios_phone", "android_phone"],
|
|
24856
|
+
type: "string"
|
|
24857
|
+
}
|
|
25301
24858
|
]
|
|
25302
24859
|
},
|
|
25303
24860
|
device_types: {
|
|
@@ -25350,6 +24907,7 @@ var openapi_default = {
|
|
|
25350
24907
|
type: "string"
|
|
25351
24908
|
},
|
|
25352
24909
|
{
|
|
24910
|
+
description: "Type of phone.",
|
|
25353
24911
|
enum: ["ios_phone", "android_phone"],
|
|
25354
24912
|
type: "string"
|
|
25355
24913
|
}
|
|
@@ -26742,7 +26300,11 @@ var openapi_default = {
|
|
|
26742
26300
|
],
|
|
26743
26301
|
type: "string"
|
|
26744
26302
|
},
|
|
26745
|
-
{
|
|
26303
|
+
{
|
|
26304
|
+
description: "Type of phone.",
|
|
26305
|
+
enum: ["ios_phone", "android_phone"],
|
|
26306
|
+
type: "string"
|
|
26307
|
+
}
|
|
26746
26308
|
]
|
|
26747
26309
|
},
|
|
26748
26310
|
device_types: {
|
|
@@ -26795,6 +26357,7 @@ var openapi_default = {
|
|
|
26795
26357
|
type: "string"
|
|
26796
26358
|
},
|
|
26797
26359
|
{
|
|
26360
|
+
description: "Type of phone.",
|
|
26798
26361
|
enum: ["ios_phone", "android_phone"],
|
|
26799
26362
|
type: "string"
|
|
26800
26363
|
}
|