@seamapi/types 1.358.0 → 1.360.0
This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
- package/dist/connect.cjs +532 -11
- package/dist/connect.cjs.map +1 -1
- package/dist/connect.d.cts +2726 -1075
- package/lib/seam/connect/model-types.d.ts +1 -1
- package/lib/seam/connect/models/access-codes/managed-access-code.d.ts +100 -0
- package/lib/seam/connect/models/access-codes/unmanaged-access-code.d.ts +100 -0
- package/lib/seam/connect/models/acs/acs-access-group.d.ts +14 -14
- package/lib/seam/connect/models/acs/acs-credential.d.ts +74 -74
- package/lib/seam/connect/models/acs/acs-encoder.d.ts +8 -8
- package/lib/seam/connect/models/acs/acs-system.d.ts +72 -72
- package/lib/seam/connect/models/acs/acs-user.d.ts +104 -104
- package/lib/seam/connect/models/action-attempts/action-attempt.d.ts +168 -168
- package/lib/seam/connect/models/action-attempts/encode-credential.d.ts +72 -72
- package/lib/seam/connect/models/action-attempts/scan-credential.d.ts +96 -96
- package/lib/seam/connect/models/connect-webviews/connect-webview.d.ts +2 -2
- package/lib/seam/connect/models/connected-accounts/connected-account.d.ts +634 -21
- package/lib/seam/connect/models/connected-accounts/connected-account.js +56 -0
- package/lib/seam/connect/models/connected-accounts/connected-account.js.map +1 -1
- package/lib/seam/connect/models/devices/device-metadata.d.ts +24 -24
- package/lib/seam/connect/models/devices/device.d.ts +146 -46
- package/lib/seam/connect/models/devices/unmanaged-device.d.ts +127 -27
- package/lib/seam/connect/models/events/access-codes.d.ts +68 -68
- package/lib/seam/connect/models/events/connect-webviews.d.ts +4 -4
- package/lib/seam/connect/models/events/connected-accounts.d.ts +28 -28
- package/lib/seam/connect/models/events/devices.d.ts +188 -128
- package/lib/seam/connect/models/events/devices.js +10 -0
- package/lib/seam/connect/models/events/devices.js.map +1 -1
- package/lib/seam/connect/models/events/seam-event.d.ts +144 -115
- package/lib/seam/connect/openapi.d.ts +482 -4
- package/lib/seam/connect/openapi.js +469 -2
- package/lib/seam/connect/openapi.js.map +1 -1
- package/lib/seam/connect/route-types.d.ts +601 -2
- package/package.json +2 -2
- package/src/lib/seam/connect/model-types.ts +0 -2
- package/src/lib/seam/connect/models/connected-accounts/connected-account.ts +77 -2
- package/src/lib/seam/connect/models/events/devices.ts +13 -0
- package/src/lib/seam/connect/openapi.ts +502 -2
- package/src/lib/seam/connect/route-types.ts +633 -0
package/dist/connect.cjs
CHANGED
|
@@ -56,12 +56,14 @@ var custom_metadata = zod.z.record(
|
|
|
56
56
|
|
|
57
57
|
// src/lib/seam/connect/models/connected-accounts/connected-account.ts
|
|
58
58
|
var common_connected_account_error = zod.z.object({
|
|
59
|
+
created_at: zod.z.string().datetime().describe("Date and time at which Seam created the error."),
|
|
59
60
|
message: zod.z.string(),
|
|
60
61
|
is_connected_account_error: zod.z.literal(true)
|
|
61
62
|
});
|
|
62
63
|
var error_code_description = "Unique identifier of the type of error. Enables quick recognition and categorization of the issue.";
|
|
63
64
|
var warning_code_description = "Unique identifier of the type of warning. Enables quick recognition and categorization of the issue.";
|
|
64
65
|
var common_connected_account_warning = zod.z.object({
|
|
66
|
+
created_at: zod.z.string().datetime().describe("Date and time at which Seam created the warning."),
|
|
65
67
|
message: zod.z.string()
|
|
66
68
|
});
|
|
67
69
|
var account_disconnected = common_connected_account_error.extend({
|
|
@@ -70,10 +72,31 @@ var account_disconnected = common_connected_account_error.extend({
|
|
|
70
72
|
var invalid_credentials = common_connected_account_error.extend({
|
|
71
73
|
error_code: zod.z.literal("invalid_credentials").describe(error_code_description)
|
|
72
74
|
}).describe("Credentials provided were invalid.");
|
|
75
|
+
var salto_ks_subscription_limit_exceeded = common_connected_account_error.extend({
|
|
76
|
+
error_code: zod.z.literal("salto_ks_subscription_limit_exceeded").describe(error_code_description),
|
|
77
|
+
salto_ks_metadata: zod.z.object({
|
|
78
|
+
sites: zod.z.array(
|
|
79
|
+
zod.z.object({
|
|
80
|
+
site_id: zod.z.string(),
|
|
81
|
+
site_name: zod.z.string(),
|
|
82
|
+
subscribed_site_user_count: zod.z.number().int().min(0),
|
|
83
|
+
site_user_subscription_limit: zod.z.number().int().min(0)
|
|
84
|
+
})
|
|
85
|
+
)
|
|
86
|
+
})
|
|
87
|
+
}).describe(
|
|
88
|
+
"Indicates that the maximum number of users allowed for the site has been reached. This means that new access codes cannot be created. Contact Salto support to increase the user limit."
|
|
89
|
+
);
|
|
73
90
|
var connected_account_error = zod.z.discriminatedUnion("error_code", [
|
|
74
91
|
account_disconnected,
|
|
75
|
-
invalid_credentials
|
|
92
|
+
invalid_credentials,
|
|
93
|
+
salto_ks_subscription_limit_exceeded
|
|
76
94
|
]);
|
|
95
|
+
zod.z.object({
|
|
96
|
+
account_disconnected: account_disconnected.nullable().optional(),
|
|
97
|
+
invalid_credentials: invalid_credentials.nullable().optional(),
|
|
98
|
+
salto_ks_subscription_limit_exceeded: salto_ks_subscription_limit_exceeded.nullable().optional()
|
|
99
|
+
});
|
|
77
100
|
var unknown_issue_with_connected_account = common_connected_account_warning.extend({
|
|
78
101
|
warning_code: zod.z.literal("unknown_issue_with_connected_account").describe(warning_code_description)
|
|
79
102
|
}).describe(
|
|
@@ -82,10 +105,31 @@ var unknown_issue_with_connected_account = common_connected_account_warning.exte
|
|
|
82
105
|
var scheduled_maintenance_window = common_connected_account_warning.extend({
|
|
83
106
|
warning_code: zod.z.literal("scheduled_maintenance_window").describe(warning_code_description)
|
|
84
107
|
}).describe("Scheduled downtime for account planned.");
|
|
108
|
+
var salto_ks_subscription_limit_almost_reached = common_connected_account_warning.extend({
|
|
109
|
+
warning_code: zod.z.literal("salto_ks_subscription_limit_almost_reached").describe(warning_code_description),
|
|
110
|
+
salto_ks_metadata: zod.z.object({
|
|
111
|
+
sites: zod.z.array(
|
|
112
|
+
zod.z.object({
|
|
113
|
+
site_id: zod.z.string(),
|
|
114
|
+
site_name: zod.z.string(),
|
|
115
|
+
site_user_subscription_limit: zod.z.number().int().min(0),
|
|
116
|
+
subscribed_site_user_count: zod.z.number().int().min(0)
|
|
117
|
+
})
|
|
118
|
+
)
|
|
119
|
+
})
|
|
120
|
+
}).describe(
|
|
121
|
+
"Indicates that the Salto KS site has exceeded 80% of the maximum number of allowed users. Please increase your subscription limit, or delete some users from your site to rectify this."
|
|
122
|
+
);
|
|
85
123
|
var connected_account_warning = zod.z.discriminatedUnion("warning_code", [
|
|
86
124
|
scheduled_maintenance_window,
|
|
87
|
-
unknown_issue_with_connected_account
|
|
125
|
+
unknown_issue_with_connected_account,
|
|
126
|
+
salto_ks_subscription_limit_almost_reached
|
|
88
127
|
]).describe("Warning associated with the `connected_account`.");
|
|
128
|
+
zod.z.object({
|
|
129
|
+
scheduled_maintenance_window: scheduled_maintenance_window.nullable().optional(),
|
|
130
|
+
unknown_issue_with_connected_account: unknown_issue_with_connected_account.nullable().optional(),
|
|
131
|
+
salto_ks_subscription_limit_almost_reached: salto_ks_subscription_limit_almost_reached.nullable().optional()
|
|
132
|
+
});
|
|
89
133
|
var connected_account = zod.z.object({
|
|
90
134
|
connected_account_id: zod.z.string().uuid().optional(),
|
|
91
135
|
created_at: zod.z.string().datetime().optional(),
|
|
@@ -1866,7 +1910,7 @@ var visionline_instance_unreachable = common_acs_system_error.extend({
|
|
|
1866
1910
|
}).describe(`Indicates that the Seam Bridge is functioning correctly and the Seam API can communicate with the Seam Bridge, but the Seam API cannot connect to the on-premises [Visionline access control system](https://docs.seam.co/latest/device-and-system-integration-guides/assa-abloy-visionline-access-control-system).
|
|
1867
1911
|
For example, the IP address of the on-premises access control system may be set incorrectly within the Seam [workspace](https://docs.seam.co/latest/core-concepts/workspaces).
|
|
1868
1912
|
See also [Troubleshooting Your Access Control System](https://docs.seam.co/latest/capability-guides/capability-guides/access-systems/troubleshooting-your-access-control-system#acs_system.errors.visionline_instance_unreachable).`);
|
|
1869
|
-
var
|
|
1913
|
+
var salto_ks_subscription_limit_exceeded2 = common_acs_system_error.extend({
|
|
1870
1914
|
error_code: zod.z.literal("salto_ks_subscription_limit_exceeded").describe(error_code_description5)
|
|
1871
1915
|
}).describe(
|
|
1872
1916
|
"Indicates that the maximum number of users allowed for the site has been reached. This means that new access codes cannot be created. Contact Salto support to increase the user limit."
|
|
@@ -1889,7 +1933,7 @@ var salto_ks_certification_expired = common_acs_system_error.extend({
|
|
|
1889
1933
|
var acs_system_error = zod.z.discriminatedUnion("error_code", [
|
|
1890
1934
|
seam_bridge_disconnected,
|
|
1891
1935
|
visionline_instance_unreachable,
|
|
1892
|
-
|
|
1936
|
+
salto_ks_subscription_limit_exceeded2,
|
|
1893
1937
|
acs_system_disconnected,
|
|
1894
1938
|
account_disconnected2,
|
|
1895
1939
|
salto_ks_certification_expired
|
|
@@ -1897,7 +1941,7 @@ var acs_system_error = zod.z.discriminatedUnion("error_code", [
|
|
|
1897
1941
|
zod.z.object({
|
|
1898
1942
|
seam_bridge_disconnected: seam_bridge_disconnected.optional().nullable(),
|
|
1899
1943
|
visionline_instance_unreachable: visionline_instance_unreachable.optional().nullable(),
|
|
1900
|
-
salto_ks_subscription_limit_exceeded:
|
|
1944
|
+
salto_ks_subscription_limit_exceeded: salto_ks_subscription_limit_exceeded2.optional().nullable(),
|
|
1901
1945
|
acs_system_disconnected: acs_system_disconnected.optional().nullable(),
|
|
1902
1946
|
account_disconnected: account_disconnected2.optional().nullable(),
|
|
1903
1947
|
salto_ks_certification_expired: salto_ks_certification_expired.optional().nullable()
|
|
@@ -1908,7 +1952,7 @@ var common_acs_system_warning = zod.z.object({
|
|
|
1908
1952
|
"Detailed description of the warning. Provides insights into the issue and potentially how to rectify it."
|
|
1909
1953
|
)
|
|
1910
1954
|
});
|
|
1911
|
-
var
|
|
1955
|
+
var salto_ks_subscription_limit_almost_reached2 = common_acs_system_warning.extend({
|
|
1912
1956
|
warning_code: zod.z.literal("salto_ks_subscription_limit_almost_reached").describe(
|
|
1913
1957
|
"Indicates that the Salto KS site has exceeded 80% of the maximum number of allowed users. Please increase your subscription limit, or delete some users from your site to rectify this."
|
|
1914
1958
|
)
|
|
@@ -1920,11 +1964,11 @@ var time_zone_does_not_match_location = common_acs_system_warning.extend({
|
|
|
1920
1964
|
misconfigured_acs_entrance_ids: zod.z.array(zod.z.string().uuid()).optional()
|
|
1921
1965
|
});
|
|
1922
1966
|
var acs_system_warning = zod.z.discriminatedUnion("warning_code", [
|
|
1923
|
-
|
|
1967
|
+
salto_ks_subscription_limit_almost_reached2,
|
|
1924
1968
|
time_zone_does_not_match_location
|
|
1925
1969
|
]).describe("Warning associated with the `acs_system`.");
|
|
1926
1970
|
zod.z.object({
|
|
1927
|
-
salto_ks_subscription_limit_almost_reached:
|
|
1971
|
+
salto_ks_subscription_limit_almost_reached: salto_ks_subscription_limit_almost_reached2.optional().nullable(),
|
|
1928
1972
|
time_zone_does_not_match_location: time_zone_does_not_match_location.optional().nullable()
|
|
1929
1973
|
});
|
|
1930
1974
|
var acs_system = zod.z.object({
|
|
@@ -3474,6 +3518,15 @@ var temperature_changed_event = device_event.extend({
|
|
|
3474
3518
|
---
|
|
3475
3519
|
A [thermostat's](https://docs.seam.co/latest/capability-guides/thermostats) reported temperature changed by at least 1 \xB0C.
|
|
3476
3520
|
`);
|
|
3521
|
+
var device_name_changed_event = device_event.extend({
|
|
3522
|
+
event_type: zod.z.literal("device.name_changed"),
|
|
3523
|
+
new_name: zod.z.string().describe("The new name of the device.")
|
|
3524
|
+
}).describe(`
|
|
3525
|
+
---
|
|
3526
|
+
route_path: /devices
|
|
3527
|
+
---
|
|
3528
|
+
The name of a [device](https://docs.seam.co/latest/core-concepts/devices) was changed.
|
|
3529
|
+
`);
|
|
3477
3530
|
var device_events = [
|
|
3478
3531
|
device_connected_event,
|
|
3479
3532
|
device_added_event,
|
|
@@ -3506,7 +3559,8 @@ var device_events = [
|
|
|
3506
3559
|
temperature_threshold_exceeded_event,
|
|
3507
3560
|
temperature_threshold_no_longer_exceeded_event,
|
|
3508
3561
|
temperature_reached_set_point_event,
|
|
3509
|
-
temperature_changed_event
|
|
3562
|
+
temperature_changed_event,
|
|
3563
|
+
device_name_changed_event
|
|
3510
3564
|
];
|
|
3511
3565
|
var enrollment_automation_event = common_event.extend({
|
|
3512
3566
|
enrollment_automation_id: zod.z.string().uuid().describe(
|
|
@@ -4116,6 +4170,11 @@ var openapi_default = {
|
|
|
4116
4170
|
{
|
|
4117
4171
|
description: "Account is disconnected.",
|
|
4118
4172
|
properties: {
|
|
4173
|
+
created_at: {
|
|
4174
|
+
description: "Date and time at which Seam created the error.",
|
|
4175
|
+
format: "date-time",
|
|
4176
|
+
type: "string"
|
|
4177
|
+
},
|
|
4119
4178
|
error_code: {
|
|
4120
4179
|
description: "Unique identifier of the type of error. Enables quick recognition and categorization of the issue.",
|
|
4121
4180
|
enum: ["account_disconnected"],
|
|
@@ -4128,6 +4187,7 @@ var openapi_default = {
|
|
|
4128
4187
|
message: { type: "string" }
|
|
4129
4188
|
},
|
|
4130
4189
|
required: [
|
|
4190
|
+
"created_at",
|
|
4131
4191
|
"message",
|
|
4132
4192
|
"is_connected_account_error",
|
|
4133
4193
|
"error_code"
|
|
@@ -4137,6 +4197,11 @@ var openapi_default = {
|
|
|
4137
4197
|
{
|
|
4138
4198
|
description: "Credentials provided were invalid.",
|
|
4139
4199
|
properties: {
|
|
4200
|
+
created_at: {
|
|
4201
|
+
description: "Date and time at which Seam created the error.",
|
|
4202
|
+
format: "date-time",
|
|
4203
|
+
type: "string"
|
|
4204
|
+
},
|
|
4140
4205
|
error_code: {
|
|
4141
4206
|
description: "Unique identifier of the type of error. Enables quick recognition and categorization of the issue.",
|
|
4142
4207
|
enum: ["invalid_credentials"],
|
|
@@ -4149,11 +4214,70 @@ var openapi_default = {
|
|
|
4149
4214
|
message: { type: "string" }
|
|
4150
4215
|
},
|
|
4151
4216
|
required: [
|
|
4217
|
+
"created_at",
|
|
4152
4218
|
"message",
|
|
4153
4219
|
"is_connected_account_error",
|
|
4154
4220
|
"error_code"
|
|
4155
4221
|
],
|
|
4156
4222
|
type: "object"
|
|
4223
|
+
},
|
|
4224
|
+
{
|
|
4225
|
+
description: "Indicates that the maximum number of users allowed for the site has been reached. This means that new access codes cannot be created. Contact Salto support to increase the user limit.",
|
|
4226
|
+
properties: {
|
|
4227
|
+
created_at: {
|
|
4228
|
+
description: "Date and time at which Seam created the error.",
|
|
4229
|
+
format: "date-time",
|
|
4230
|
+
type: "string"
|
|
4231
|
+
},
|
|
4232
|
+
error_code: {
|
|
4233
|
+
description: "Unique identifier of the type of error. Enables quick recognition and categorization of the issue.",
|
|
4234
|
+
enum: ["salto_ks_subscription_limit_exceeded"],
|
|
4235
|
+
type: "string"
|
|
4236
|
+
},
|
|
4237
|
+
is_connected_account_error: {
|
|
4238
|
+
enum: [true],
|
|
4239
|
+
type: "boolean"
|
|
4240
|
+
},
|
|
4241
|
+
message: { type: "string" },
|
|
4242
|
+
salto_ks_metadata: {
|
|
4243
|
+
properties: {
|
|
4244
|
+
sites: {
|
|
4245
|
+
items: {
|
|
4246
|
+
properties: {
|
|
4247
|
+
site_id: { type: "string" },
|
|
4248
|
+
site_name: { type: "string" },
|
|
4249
|
+
site_user_subscription_limit: {
|
|
4250
|
+
minimum: 0,
|
|
4251
|
+
type: "integer"
|
|
4252
|
+
},
|
|
4253
|
+
subscribed_site_user_count: {
|
|
4254
|
+
minimum: 0,
|
|
4255
|
+
type: "integer"
|
|
4256
|
+
}
|
|
4257
|
+
},
|
|
4258
|
+
required: [
|
|
4259
|
+
"site_id",
|
|
4260
|
+
"site_name",
|
|
4261
|
+
"subscribed_site_user_count",
|
|
4262
|
+
"site_user_subscription_limit"
|
|
4263
|
+
],
|
|
4264
|
+
type: "object"
|
|
4265
|
+
},
|
|
4266
|
+
type: "array"
|
|
4267
|
+
}
|
|
4268
|
+
},
|
|
4269
|
+
required: ["sites"],
|
|
4270
|
+
type: "object"
|
|
4271
|
+
}
|
|
4272
|
+
},
|
|
4273
|
+
required: [
|
|
4274
|
+
"created_at",
|
|
4275
|
+
"message",
|
|
4276
|
+
"is_connected_account_error",
|
|
4277
|
+
"error_code",
|
|
4278
|
+
"salto_ks_metadata"
|
|
4279
|
+
],
|
|
4280
|
+
type: "object"
|
|
4157
4281
|
}
|
|
4158
4282
|
]
|
|
4159
4283
|
},
|
|
@@ -8502,6 +8626,11 @@ var openapi_default = {
|
|
|
8502
8626
|
{
|
|
8503
8627
|
description: "Account is disconnected.",
|
|
8504
8628
|
properties: {
|
|
8629
|
+
created_at: {
|
|
8630
|
+
description: "Date and time at which Seam created the error.",
|
|
8631
|
+
format: "date-time",
|
|
8632
|
+
type: "string"
|
|
8633
|
+
},
|
|
8505
8634
|
error_code: {
|
|
8506
8635
|
description: "Unique identifier of the type of error. Enables quick recognition and categorization of the issue.",
|
|
8507
8636
|
enum: ["account_disconnected"],
|
|
@@ -8514,6 +8643,7 @@ var openapi_default = {
|
|
|
8514
8643
|
message: { type: "string" }
|
|
8515
8644
|
},
|
|
8516
8645
|
required: [
|
|
8646
|
+
"created_at",
|
|
8517
8647
|
"message",
|
|
8518
8648
|
"is_connected_account_error",
|
|
8519
8649
|
"error_code"
|
|
@@ -8523,6 +8653,11 @@ var openapi_default = {
|
|
|
8523
8653
|
{
|
|
8524
8654
|
description: "Credentials provided were invalid.",
|
|
8525
8655
|
properties: {
|
|
8656
|
+
created_at: {
|
|
8657
|
+
description: "Date and time at which Seam created the error.",
|
|
8658
|
+
format: "date-time",
|
|
8659
|
+
type: "string"
|
|
8660
|
+
},
|
|
8526
8661
|
error_code: {
|
|
8527
8662
|
description: "Unique identifier of the type of error. Enables quick recognition and categorization of the issue.",
|
|
8528
8663
|
enum: ["invalid_credentials"],
|
|
@@ -8535,11 +8670,70 @@ var openapi_default = {
|
|
|
8535
8670
|
message: { type: "string" }
|
|
8536
8671
|
},
|
|
8537
8672
|
required: [
|
|
8673
|
+
"created_at",
|
|
8538
8674
|
"message",
|
|
8539
8675
|
"is_connected_account_error",
|
|
8540
8676
|
"error_code"
|
|
8541
8677
|
],
|
|
8542
8678
|
type: "object"
|
|
8679
|
+
},
|
|
8680
|
+
{
|
|
8681
|
+
description: "Indicates that the maximum number of users allowed for the site has been reached. This means that new access codes cannot be created. Contact Salto support to increase the user limit.",
|
|
8682
|
+
properties: {
|
|
8683
|
+
created_at: {
|
|
8684
|
+
description: "Date and time at which Seam created the error.",
|
|
8685
|
+
format: "date-time",
|
|
8686
|
+
type: "string"
|
|
8687
|
+
},
|
|
8688
|
+
error_code: {
|
|
8689
|
+
description: "Unique identifier of the type of error. Enables quick recognition and categorization of the issue.",
|
|
8690
|
+
enum: ["salto_ks_subscription_limit_exceeded"],
|
|
8691
|
+
type: "string"
|
|
8692
|
+
},
|
|
8693
|
+
is_connected_account_error: {
|
|
8694
|
+
enum: [true],
|
|
8695
|
+
type: "boolean"
|
|
8696
|
+
},
|
|
8697
|
+
message: { type: "string" },
|
|
8698
|
+
salto_ks_metadata: {
|
|
8699
|
+
properties: {
|
|
8700
|
+
sites: {
|
|
8701
|
+
items: {
|
|
8702
|
+
properties: {
|
|
8703
|
+
site_id: { type: "string" },
|
|
8704
|
+
site_name: { type: "string" },
|
|
8705
|
+
site_user_subscription_limit: {
|
|
8706
|
+
minimum: 0,
|
|
8707
|
+
type: "integer"
|
|
8708
|
+
},
|
|
8709
|
+
subscribed_site_user_count: {
|
|
8710
|
+
minimum: 0,
|
|
8711
|
+
type: "integer"
|
|
8712
|
+
}
|
|
8713
|
+
},
|
|
8714
|
+
required: [
|
|
8715
|
+
"site_id",
|
|
8716
|
+
"site_name",
|
|
8717
|
+
"subscribed_site_user_count",
|
|
8718
|
+
"site_user_subscription_limit"
|
|
8719
|
+
],
|
|
8720
|
+
type: "object"
|
|
8721
|
+
},
|
|
8722
|
+
type: "array"
|
|
8723
|
+
}
|
|
8724
|
+
},
|
|
8725
|
+
required: ["sites"],
|
|
8726
|
+
type: "object"
|
|
8727
|
+
}
|
|
8728
|
+
},
|
|
8729
|
+
required: [
|
|
8730
|
+
"created_at",
|
|
8731
|
+
"message",
|
|
8732
|
+
"is_connected_account_error",
|
|
8733
|
+
"error_code",
|
|
8734
|
+
"salto_ks_metadata"
|
|
8735
|
+
],
|
|
8736
|
+
type: "object"
|
|
8543
8737
|
}
|
|
8544
8738
|
]
|
|
8545
8739
|
},
|
|
@@ -8563,6 +8757,11 @@ var openapi_default = {
|
|
|
8563
8757
|
{
|
|
8564
8758
|
description: "Scheduled downtime for account planned.",
|
|
8565
8759
|
properties: {
|
|
8760
|
+
created_at: {
|
|
8761
|
+
description: "Date and time at which Seam created the warning.",
|
|
8762
|
+
format: "date-time",
|
|
8763
|
+
type: "string"
|
|
8764
|
+
},
|
|
8566
8765
|
message: { type: "string" },
|
|
8567
8766
|
warning_code: {
|
|
8568
8767
|
description: "Unique identifier of the type of warning. Enables quick recognition and categorization of the issue.",
|
|
@@ -8570,12 +8769,17 @@ var openapi_default = {
|
|
|
8570
8769
|
type: "string"
|
|
8571
8770
|
}
|
|
8572
8771
|
},
|
|
8573
|
-
required: ["message", "warning_code"],
|
|
8772
|
+
required: ["created_at", "message", "warning_code"],
|
|
8574
8773
|
type: "object"
|
|
8575
8774
|
},
|
|
8576
8775
|
{
|
|
8577
8776
|
description: "An unknown issue occurred while syncing the state of this connected account with the provider. This issue may affect the proper functioning of one or more resources in this account.",
|
|
8578
8777
|
properties: {
|
|
8778
|
+
created_at: {
|
|
8779
|
+
description: "Date and time at which Seam created the warning.",
|
|
8780
|
+
format: "date-time",
|
|
8781
|
+
type: "string"
|
|
8782
|
+
},
|
|
8579
8783
|
message: { type: "string" },
|
|
8580
8784
|
warning_code: {
|
|
8581
8785
|
description: "Unique identifier of the type of warning. Enables quick recognition and categorization of the issue.",
|
|
@@ -8583,7 +8787,60 @@ var openapi_default = {
|
|
|
8583
8787
|
type: "string"
|
|
8584
8788
|
}
|
|
8585
8789
|
},
|
|
8586
|
-
required: ["message", "warning_code"],
|
|
8790
|
+
required: ["created_at", "message", "warning_code"],
|
|
8791
|
+
type: "object"
|
|
8792
|
+
},
|
|
8793
|
+
{
|
|
8794
|
+
description: "Indicates that the Salto KS site has exceeded 80% of the maximum number of allowed users. Please increase your subscription limit, or delete some users from your site to rectify this.",
|
|
8795
|
+
properties: {
|
|
8796
|
+
created_at: {
|
|
8797
|
+
description: "Date and time at which Seam created the warning.",
|
|
8798
|
+
format: "date-time",
|
|
8799
|
+
type: "string"
|
|
8800
|
+
},
|
|
8801
|
+
message: { type: "string" },
|
|
8802
|
+
salto_ks_metadata: {
|
|
8803
|
+
properties: {
|
|
8804
|
+
sites: {
|
|
8805
|
+
items: {
|
|
8806
|
+
properties: {
|
|
8807
|
+
site_id: { type: "string" },
|
|
8808
|
+
site_name: { type: "string" },
|
|
8809
|
+
site_user_subscription_limit: {
|
|
8810
|
+
minimum: 0,
|
|
8811
|
+
type: "integer"
|
|
8812
|
+
},
|
|
8813
|
+
subscribed_site_user_count: {
|
|
8814
|
+
minimum: 0,
|
|
8815
|
+
type: "integer"
|
|
8816
|
+
}
|
|
8817
|
+
},
|
|
8818
|
+
required: [
|
|
8819
|
+
"site_id",
|
|
8820
|
+
"site_name",
|
|
8821
|
+
"site_user_subscription_limit",
|
|
8822
|
+
"subscribed_site_user_count"
|
|
8823
|
+
],
|
|
8824
|
+
type: "object"
|
|
8825
|
+
},
|
|
8826
|
+
type: "array"
|
|
8827
|
+
}
|
|
8828
|
+
},
|
|
8829
|
+
required: ["sites"],
|
|
8830
|
+
type: "object"
|
|
8831
|
+
},
|
|
8832
|
+
warning_code: {
|
|
8833
|
+
description: "Unique identifier of the type of warning. Enables quick recognition and categorization of the issue.",
|
|
8834
|
+
enum: ["salto_ks_subscription_limit_almost_reached"],
|
|
8835
|
+
type: "string"
|
|
8836
|
+
}
|
|
8837
|
+
},
|
|
8838
|
+
required: [
|
|
8839
|
+
"created_at",
|
|
8840
|
+
"message",
|
|
8841
|
+
"warning_code",
|
|
8842
|
+
"salto_ks_metadata"
|
|
8843
|
+
],
|
|
8587
8844
|
type: "object"
|
|
8588
8845
|
}
|
|
8589
8846
|
]
|
|
@@ -8885,6 +9142,11 @@ var openapi_default = {
|
|
|
8885
9142
|
{
|
|
8886
9143
|
description: "Account is disconnected.",
|
|
8887
9144
|
properties: {
|
|
9145
|
+
created_at: {
|
|
9146
|
+
description: "Date and time at which Seam created the error.",
|
|
9147
|
+
format: "date-time",
|
|
9148
|
+
type: "string"
|
|
9149
|
+
},
|
|
8888
9150
|
error_code: {
|
|
8889
9151
|
description: "Unique identifier of the type of error. Enables quick recognition and categorization of the issue.",
|
|
8890
9152
|
enum: ["account_disconnected"],
|
|
@@ -8897,6 +9159,7 @@ var openapi_default = {
|
|
|
8897
9159
|
message: { type: "string" }
|
|
8898
9160
|
},
|
|
8899
9161
|
required: [
|
|
9162
|
+
"created_at",
|
|
8900
9163
|
"message",
|
|
8901
9164
|
"is_connected_account_error",
|
|
8902
9165
|
"error_code"
|
|
@@ -8906,6 +9169,11 @@ var openapi_default = {
|
|
|
8906
9169
|
{
|
|
8907
9170
|
description: "Credentials provided were invalid.",
|
|
8908
9171
|
properties: {
|
|
9172
|
+
created_at: {
|
|
9173
|
+
description: "Date and time at which Seam created the error.",
|
|
9174
|
+
format: "date-time",
|
|
9175
|
+
type: "string"
|
|
9176
|
+
},
|
|
8909
9177
|
error_code: {
|
|
8910
9178
|
description: "Unique identifier of the type of error. Enables quick recognition and categorization of the issue.",
|
|
8911
9179
|
enum: ["invalid_credentials"],
|
|
@@ -8918,11 +9186,70 @@ var openapi_default = {
|
|
|
8918
9186
|
message: { type: "string" }
|
|
8919
9187
|
},
|
|
8920
9188
|
required: [
|
|
9189
|
+
"created_at",
|
|
8921
9190
|
"message",
|
|
8922
9191
|
"is_connected_account_error",
|
|
8923
9192
|
"error_code"
|
|
8924
9193
|
],
|
|
8925
9194
|
type: "object"
|
|
9195
|
+
},
|
|
9196
|
+
{
|
|
9197
|
+
description: "Indicates that the maximum number of users allowed for the site has been reached. This means that new access codes cannot be created. Contact Salto support to increase the user limit.",
|
|
9198
|
+
properties: {
|
|
9199
|
+
created_at: {
|
|
9200
|
+
description: "Date and time at which Seam created the error.",
|
|
9201
|
+
format: "date-time",
|
|
9202
|
+
type: "string"
|
|
9203
|
+
},
|
|
9204
|
+
error_code: {
|
|
9205
|
+
description: "Unique identifier of the type of error. Enables quick recognition and categorization of the issue.",
|
|
9206
|
+
enum: ["salto_ks_subscription_limit_exceeded"],
|
|
9207
|
+
type: "string"
|
|
9208
|
+
},
|
|
9209
|
+
is_connected_account_error: {
|
|
9210
|
+
enum: [true],
|
|
9211
|
+
type: "boolean"
|
|
9212
|
+
},
|
|
9213
|
+
message: { type: "string" },
|
|
9214
|
+
salto_ks_metadata: {
|
|
9215
|
+
properties: {
|
|
9216
|
+
sites: {
|
|
9217
|
+
items: {
|
|
9218
|
+
properties: {
|
|
9219
|
+
site_id: { type: "string" },
|
|
9220
|
+
site_name: { type: "string" },
|
|
9221
|
+
site_user_subscription_limit: {
|
|
9222
|
+
minimum: 0,
|
|
9223
|
+
type: "integer"
|
|
9224
|
+
},
|
|
9225
|
+
subscribed_site_user_count: {
|
|
9226
|
+
minimum: 0,
|
|
9227
|
+
type: "integer"
|
|
9228
|
+
}
|
|
9229
|
+
},
|
|
9230
|
+
required: [
|
|
9231
|
+
"site_id",
|
|
9232
|
+
"site_name",
|
|
9233
|
+
"subscribed_site_user_count",
|
|
9234
|
+
"site_user_subscription_limit"
|
|
9235
|
+
],
|
|
9236
|
+
type: "object"
|
|
9237
|
+
},
|
|
9238
|
+
type: "array"
|
|
9239
|
+
}
|
|
9240
|
+
},
|
|
9241
|
+
required: ["sites"],
|
|
9242
|
+
type: "object"
|
|
9243
|
+
}
|
|
9244
|
+
},
|
|
9245
|
+
required: [
|
|
9246
|
+
"created_at",
|
|
9247
|
+
"message",
|
|
9248
|
+
"is_connected_account_error",
|
|
9249
|
+
"error_code",
|
|
9250
|
+
"salto_ks_metadata"
|
|
9251
|
+
],
|
|
9252
|
+
type: "object"
|
|
8926
9253
|
}
|
|
8927
9254
|
]
|
|
8928
9255
|
},
|
|
@@ -14488,6 +14815,58 @@ var openapi_default = {
|
|
|
14488
14815
|
type: "object",
|
|
14489
14816
|
"x-route-path": "/thermostats"
|
|
14490
14817
|
},
|
|
14818
|
+
{
|
|
14819
|
+
description: "The name of a [device](https://docs.seam.co/latest/core-concepts/devices) was changed.",
|
|
14820
|
+
properties: {
|
|
14821
|
+
connected_account_id: {
|
|
14822
|
+
description: "ID of the [connected account](https://docs.seam.co/latest/core-concepts/connected-accounts).",
|
|
14823
|
+
format: "uuid",
|
|
14824
|
+
type: "string"
|
|
14825
|
+
},
|
|
14826
|
+
created_at: {
|
|
14827
|
+
description: "Date and time at which the event was created.",
|
|
14828
|
+
format: "date-time",
|
|
14829
|
+
type: "string"
|
|
14830
|
+
},
|
|
14831
|
+
device_id: {
|
|
14832
|
+
description: "ID of the device.",
|
|
14833
|
+
format: "uuid",
|
|
14834
|
+
type: "string"
|
|
14835
|
+
},
|
|
14836
|
+
event_id: {
|
|
14837
|
+
description: "ID of the event.",
|
|
14838
|
+
format: "uuid",
|
|
14839
|
+
type: "string"
|
|
14840
|
+
},
|
|
14841
|
+
event_type: { enum: ["device.name_changed"], type: "string" },
|
|
14842
|
+
new_name: {
|
|
14843
|
+
description: "The new name of the device.",
|
|
14844
|
+
type: "string"
|
|
14845
|
+
},
|
|
14846
|
+
occurred_at: {
|
|
14847
|
+
description: "Date and time at which the event occurred.",
|
|
14848
|
+
format: "date-time",
|
|
14849
|
+
type: "string"
|
|
14850
|
+
},
|
|
14851
|
+
workspace_id: {
|
|
14852
|
+
description: "ID of the [workspace](https://docs.seam.co/latest/core-concepts/workspaces).",
|
|
14853
|
+
format: "uuid",
|
|
14854
|
+
type: "string"
|
|
14855
|
+
}
|
|
14856
|
+
},
|
|
14857
|
+
required: [
|
|
14858
|
+
"event_id",
|
|
14859
|
+
"workspace_id",
|
|
14860
|
+
"created_at",
|
|
14861
|
+
"occurred_at",
|
|
14862
|
+
"device_id",
|
|
14863
|
+
"connected_account_id",
|
|
14864
|
+
"event_type",
|
|
14865
|
+
"new_name"
|
|
14866
|
+
],
|
|
14867
|
+
type: "object",
|
|
14868
|
+
"x-route-path": "/devices"
|
|
14869
|
+
},
|
|
14491
14870
|
{
|
|
14492
14871
|
description: "An [enrollment automation](https://docs.seam.co/latest/capability-guides/mobile-access/issuing-mobile-credentials-from-an-access-control-system#prepare-the-phones-for-a-user-identity-to-start-receiving-mobile-credentials-using-an-enrollment-aut) was deleted.",
|
|
14493
14872
|
properties: {
|
|
@@ -15299,6 +15678,11 @@ var openapi_default = {
|
|
|
15299
15678
|
{
|
|
15300
15679
|
description: "Account is disconnected.",
|
|
15301
15680
|
properties: {
|
|
15681
|
+
created_at: {
|
|
15682
|
+
description: "Date and time at which Seam created the error.",
|
|
15683
|
+
format: "date-time",
|
|
15684
|
+
type: "string"
|
|
15685
|
+
},
|
|
15302
15686
|
error_code: {
|
|
15303
15687
|
description: "Unique identifier of the type of error. Enables quick recognition and categorization of the issue.",
|
|
15304
15688
|
enum: ["account_disconnected"],
|
|
@@ -15311,6 +15695,7 @@ var openapi_default = {
|
|
|
15311
15695
|
message: { type: "string" }
|
|
15312
15696
|
},
|
|
15313
15697
|
required: [
|
|
15698
|
+
"created_at",
|
|
15314
15699
|
"message",
|
|
15315
15700
|
"is_connected_account_error",
|
|
15316
15701
|
"error_code"
|
|
@@ -15320,6 +15705,11 @@ var openapi_default = {
|
|
|
15320
15705
|
{
|
|
15321
15706
|
description: "Credentials provided were invalid.",
|
|
15322
15707
|
properties: {
|
|
15708
|
+
created_at: {
|
|
15709
|
+
description: "Date and time at which Seam created the error.",
|
|
15710
|
+
format: "date-time",
|
|
15711
|
+
type: "string"
|
|
15712
|
+
},
|
|
15323
15713
|
error_code: {
|
|
15324
15714
|
description: "Unique identifier of the type of error. Enables quick recognition and categorization of the issue.",
|
|
15325
15715
|
enum: ["invalid_credentials"],
|
|
@@ -15332,11 +15722,70 @@ var openapi_default = {
|
|
|
15332
15722
|
message: { type: "string" }
|
|
15333
15723
|
},
|
|
15334
15724
|
required: [
|
|
15725
|
+
"created_at",
|
|
15335
15726
|
"message",
|
|
15336
15727
|
"is_connected_account_error",
|
|
15337
15728
|
"error_code"
|
|
15338
15729
|
],
|
|
15339
15730
|
type: "object"
|
|
15731
|
+
},
|
|
15732
|
+
{
|
|
15733
|
+
description: "Indicates that the maximum number of users allowed for the site has been reached. This means that new access codes cannot be created. Contact Salto support to increase the user limit.",
|
|
15734
|
+
properties: {
|
|
15735
|
+
created_at: {
|
|
15736
|
+
description: "Date and time at which Seam created the error.",
|
|
15737
|
+
format: "date-time",
|
|
15738
|
+
type: "string"
|
|
15739
|
+
},
|
|
15740
|
+
error_code: {
|
|
15741
|
+
description: "Unique identifier of the type of error. Enables quick recognition and categorization of the issue.",
|
|
15742
|
+
enum: ["salto_ks_subscription_limit_exceeded"],
|
|
15743
|
+
type: "string"
|
|
15744
|
+
},
|
|
15745
|
+
is_connected_account_error: {
|
|
15746
|
+
enum: [true],
|
|
15747
|
+
type: "boolean"
|
|
15748
|
+
},
|
|
15749
|
+
message: { type: "string" },
|
|
15750
|
+
salto_ks_metadata: {
|
|
15751
|
+
properties: {
|
|
15752
|
+
sites: {
|
|
15753
|
+
items: {
|
|
15754
|
+
properties: {
|
|
15755
|
+
site_id: { type: "string" },
|
|
15756
|
+
site_name: { type: "string" },
|
|
15757
|
+
site_user_subscription_limit: {
|
|
15758
|
+
minimum: 0,
|
|
15759
|
+
type: "integer"
|
|
15760
|
+
},
|
|
15761
|
+
subscribed_site_user_count: {
|
|
15762
|
+
minimum: 0,
|
|
15763
|
+
type: "integer"
|
|
15764
|
+
}
|
|
15765
|
+
},
|
|
15766
|
+
required: [
|
|
15767
|
+
"site_id",
|
|
15768
|
+
"site_name",
|
|
15769
|
+
"subscribed_site_user_count",
|
|
15770
|
+
"site_user_subscription_limit"
|
|
15771
|
+
],
|
|
15772
|
+
type: "object"
|
|
15773
|
+
},
|
|
15774
|
+
type: "array"
|
|
15775
|
+
}
|
|
15776
|
+
},
|
|
15777
|
+
required: ["sites"],
|
|
15778
|
+
type: "object"
|
|
15779
|
+
}
|
|
15780
|
+
},
|
|
15781
|
+
required: [
|
|
15782
|
+
"created_at",
|
|
15783
|
+
"message",
|
|
15784
|
+
"is_connected_account_error",
|
|
15785
|
+
"error_code",
|
|
15786
|
+
"salto_ks_metadata"
|
|
15787
|
+
],
|
|
15788
|
+
type: "object"
|
|
15340
15789
|
}
|
|
15341
15790
|
]
|
|
15342
15791
|
},
|
|
@@ -16502,6 +16951,11 @@ var openapi_default = {
|
|
|
16502
16951
|
{
|
|
16503
16952
|
description: "Account is disconnected.",
|
|
16504
16953
|
properties: {
|
|
16954
|
+
created_at: {
|
|
16955
|
+
description: "Date and time at which Seam created the error.",
|
|
16956
|
+
format: "date-time",
|
|
16957
|
+
type: "string"
|
|
16958
|
+
},
|
|
16505
16959
|
error_code: {
|
|
16506
16960
|
description: "Unique identifier of the type of error. Enables quick recognition and categorization of the issue.",
|
|
16507
16961
|
enum: ["account_disconnected"],
|
|
@@ -16514,6 +16968,7 @@ var openapi_default = {
|
|
|
16514
16968
|
message: { type: "string" }
|
|
16515
16969
|
},
|
|
16516
16970
|
required: [
|
|
16971
|
+
"created_at",
|
|
16517
16972
|
"message",
|
|
16518
16973
|
"is_connected_account_error",
|
|
16519
16974
|
"error_code"
|
|
@@ -16523,6 +16978,11 @@ var openapi_default = {
|
|
|
16523
16978
|
{
|
|
16524
16979
|
description: "Credentials provided were invalid.",
|
|
16525
16980
|
properties: {
|
|
16981
|
+
created_at: {
|
|
16982
|
+
description: "Date and time at which Seam created the error.",
|
|
16983
|
+
format: "date-time",
|
|
16984
|
+
type: "string"
|
|
16985
|
+
},
|
|
16526
16986
|
error_code: {
|
|
16527
16987
|
description: "Unique identifier of the type of error. Enables quick recognition and categorization of the issue.",
|
|
16528
16988
|
enum: ["invalid_credentials"],
|
|
@@ -16535,11 +16995,70 @@ var openapi_default = {
|
|
|
16535
16995
|
message: { type: "string" }
|
|
16536
16996
|
},
|
|
16537
16997
|
required: [
|
|
16998
|
+
"created_at",
|
|
16538
16999
|
"message",
|
|
16539
17000
|
"is_connected_account_error",
|
|
16540
17001
|
"error_code"
|
|
16541
17002
|
],
|
|
16542
17003
|
type: "object"
|
|
17004
|
+
},
|
|
17005
|
+
{
|
|
17006
|
+
description: "Indicates that the maximum number of users allowed for the site has been reached. This means that new access codes cannot be created. Contact Salto support to increase the user limit.",
|
|
17007
|
+
properties: {
|
|
17008
|
+
created_at: {
|
|
17009
|
+
description: "Date and time at which Seam created the error.",
|
|
17010
|
+
format: "date-time",
|
|
17011
|
+
type: "string"
|
|
17012
|
+
},
|
|
17013
|
+
error_code: {
|
|
17014
|
+
description: "Unique identifier of the type of error. Enables quick recognition and categorization of the issue.",
|
|
17015
|
+
enum: ["salto_ks_subscription_limit_exceeded"],
|
|
17016
|
+
type: "string"
|
|
17017
|
+
},
|
|
17018
|
+
is_connected_account_error: {
|
|
17019
|
+
enum: [true],
|
|
17020
|
+
type: "boolean"
|
|
17021
|
+
},
|
|
17022
|
+
message: { type: "string" },
|
|
17023
|
+
salto_ks_metadata: {
|
|
17024
|
+
properties: {
|
|
17025
|
+
sites: {
|
|
17026
|
+
items: {
|
|
17027
|
+
properties: {
|
|
17028
|
+
site_id: { type: "string" },
|
|
17029
|
+
site_name: { type: "string" },
|
|
17030
|
+
site_user_subscription_limit: {
|
|
17031
|
+
minimum: 0,
|
|
17032
|
+
type: "integer"
|
|
17033
|
+
},
|
|
17034
|
+
subscribed_site_user_count: {
|
|
17035
|
+
minimum: 0,
|
|
17036
|
+
type: "integer"
|
|
17037
|
+
}
|
|
17038
|
+
},
|
|
17039
|
+
required: [
|
|
17040
|
+
"site_id",
|
|
17041
|
+
"site_name",
|
|
17042
|
+
"subscribed_site_user_count",
|
|
17043
|
+
"site_user_subscription_limit"
|
|
17044
|
+
],
|
|
17045
|
+
type: "object"
|
|
17046
|
+
},
|
|
17047
|
+
type: "array"
|
|
17048
|
+
}
|
|
17049
|
+
},
|
|
17050
|
+
required: ["sites"],
|
|
17051
|
+
type: "object"
|
|
17052
|
+
}
|
|
17053
|
+
},
|
|
17054
|
+
required: [
|
|
17055
|
+
"created_at",
|
|
17056
|
+
"message",
|
|
17057
|
+
"is_connected_account_error",
|
|
17058
|
+
"error_code",
|
|
17059
|
+
"salto_ks_metadata"
|
|
17060
|
+
],
|
|
17061
|
+
type: "object"
|
|
16543
17062
|
}
|
|
16544
17063
|
]
|
|
16545
17064
|
},
|
|
@@ -24333,6 +24852,7 @@ var openapi_default = {
|
|
|
24333
24852
|
"thermostat.temperature_threshold_no_longer_exceeded",
|
|
24334
24853
|
"thermostat.temperature_reached_set_point",
|
|
24335
24854
|
"thermostat.temperature_changed",
|
|
24855
|
+
"device.name_changed",
|
|
24336
24856
|
"enrollment_automation.deleted",
|
|
24337
24857
|
"phone.deactivated"
|
|
24338
24858
|
],
|
|
@@ -24414,6 +24934,7 @@ var openapi_default = {
|
|
|
24414
24934
|
"thermostat.temperature_threshold_no_longer_exceeded",
|
|
24415
24935
|
"thermostat.temperature_reached_set_point",
|
|
24416
24936
|
"thermostat.temperature_changed",
|
|
24937
|
+
"device.name_changed",
|
|
24417
24938
|
"enrollment_automation.deleted",
|
|
24418
24939
|
"phone.deactivated"
|
|
24419
24940
|
],
|