@seamapi/types 1.357.1 → 1.359.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 +500 -36
- package/dist/connect.cjs.map +1 -1
- package/dist/connect.d.cts +2325 -833
- package/lib/seam/connect/internal/schemas.d.ts +1 -1
- package/lib/seam/connect/internal/schemas.js +1 -1
- package/lib/seam/connect/internal/schemas.js.map +1 -1
- 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 +128 -128
- package/lib/seam/connect/models/events/seam-event.d.ts +114 -114
- package/lib/seam/connect/models/index.d.ts +1 -0
- package/lib/seam/connect/models/index.js +1 -0
- package/lib/seam/connect/models/index.js.map +1 -1
- package/lib/seam/connect/models/pagination.d.ts +14 -0
- package/lib/seam/connect/models/pagination.js +18 -0
- package/lib/seam/connect/models/pagination.js.map +1 -0
- package/lib/seam/connect/openapi.d.ts +389 -24
- package/lib/seam/connect/openapi.js +438 -28
- package/lib/seam/connect/openapi.js.map +1 -1
- package/lib/seam/connect/route-types.d.ts +567 -0
- package/lib/seam/connect/schemas.d.ts +1 -1
- package/lib/seam/connect/schemas.js +1 -1
- package/lib/seam/connect/schemas.js.map +1 -1
- package/package.json +1 -1
- package/src/lib/seam/connect/internal/schemas.ts +1 -0
- 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/index.ts +1 -0
- package/src/lib/seam/connect/models/pagination.ts +22 -0
- package/src/lib/seam/connect/openapi.ts +470 -31
- package/src/lib/seam/connect/route-types.ts +597 -0
- package/src/lib/seam/connect/schemas.ts +1 -0
package/dist/connect.cjs
CHANGED
|
@@ -31,6 +31,7 @@ __export(schemas_exports, {
|
|
|
31
31
|
device: () => device,
|
|
32
32
|
device_provider: () => device_provider,
|
|
33
33
|
noise_threshold: () => noise_threshold,
|
|
34
|
+
pagination: () => pagination,
|
|
34
35
|
seam_event: () => seam_event,
|
|
35
36
|
thermostat_schedule: () => thermostat_schedule,
|
|
36
37
|
unmanaged_access_code: () => unmanaged_access_code,
|
|
@@ -55,12 +56,14 @@ var custom_metadata = zod.z.record(
|
|
|
55
56
|
|
|
56
57
|
// src/lib/seam/connect/models/connected-accounts/connected-account.ts
|
|
57
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."),
|
|
58
60
|
message: zod.z.string(),
|
|
59
61
|
is_connected_account_error: zod.z.literal(true)
|
|
60
62
|
});
|
|
61
63
|
var error_code_description = "Unique identifier of the type of error. Enables quick recognition and categorization of the issue.";
|
|
62
64
|
var warning_code_description = "Unique identifier of the type of warning. Enables quick recognition and categorization of the issue.";
|
|
63
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."),
|
|
64
67
|
message: zod.z.string()
|
|
65
68
|
});
|
|
66
69
|
var account_disconnected = common_connected_account_error.extend({
|
|
@@ -69,10 +72,31 @@ var account_disconnected = common_connected_account_error.extend({
|
|
|
69
72
|
var invalid_credentials = common_connected_account_error.extend({
|
|
70
73
|
error_code: zod.z.literal("invalid_credentials").describe(error_code_description)
|
|
71
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
|
+
);
|
|
72
90
|
var connected_account_error = zod.z.discriminatedUnion("error_code", [
|
|
73
91
|
account_disconnected,
|
|
74
|
-
invalid_credentials
|
|
92
|
+
invalid_credentials,
|
|
93
|
+
salto_ks_subscription_limit_exceeded
|
|
75
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
|
+
});
|
|
76
100
|
var unknown_issue_with_connected_account = common_connected_account_warning.extend({
|
|
77
101
|
warning_code: zod.z.literal("unknown_issue_with_connected_account").describe(warning_code_description)
|
|
78
102
|
}).describe(
|
|
@@ -81,10 +105,31 @@ var unknown_issue_with_connected_account = common_connected_account_warning.exte
|
|
|
81
105
|
var scheduled_maintenance_window = common_connected_account_warning.extend({
|
|
82
106
|
warning_code: zod.z.literal("scheduled_maintenance_window").describe(warning_code_description)
|
|
83
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
|
+
);
|
|
84
123
|
var connected_account_warning = zod.z.discriminatedUnion("warning_code", [
|
|
85
124
|
scheduled_maintenance_window,
|
|
86
|
-
unknown_issue_with_connected_account
|
|
125
|
+
unknown_issue_with_connected_account,
|
|
126
|
+
salto_ks_subscription_limit_almost_reached
|
|
87
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
|
+
});
|
|
88
133
|
var connected_account = zod.z.object({
|
|
89
134
|
connected_account_id: zod.z.string().uuid().optional(),
|
|
90
135
|
created_at: zod.z.string().datetime().optional(),
|
|
@@ -1865,7 +1910,7 @@ var visionline_instance_unreachable = common_acs_system_error.extend({
|
|
|
1865
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).
|
|
1866
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).
|
|
1867
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).`);
|
|
1868
|
-
var
|
|
1913
|
+
var salto_ks_subscription_limit_exceeded2 = common_acs_system_error.extend({
|
|
1869
1914
|
error_code: zod.z.literal("salto_ks_subscription_limit_exceeded").describe(error_code_description5)
|
|
1870
1915
|
}).describe(
|
|
1871
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."
|
|
@@ -1888,7 +1933,7 @@ var salto_ks_certification_expired = common_acs_system_error.extend({
|
|
|
1888
1933
|
var acs_system_error = zod.z.discriminatedUnion("error_code", [
|
|
1889
1934
|
seam_bridge_disconnected,
|
|
1890
1935
|
visionline_instance_unreachable,
|
|
1891
|
-
|
|
1936
|
+
salto_ks_subscription_limit_exceeded2,
|
|
1892
1937
|
acs_system_disconnected,
|
|
1893
1938
|
account_disconnected2,
|
|
1894
1939
|
salto_ks_certification_expired
|
|
@@ -1896,7 +1941,7 @@ var acs_system_error = zod.z.discriminatedUnion("error_code", [
|
|
|
1896
1941
|
zod.z.object({
|
|
1897
1942
|
seam_bridge_disconnected: seam_bridge_disconnected.optional().nullable(),
|
|
1898
1943
|
visionline_instance_unreachable: visionline_instance_unreachable.optional().nullable(),
|
|
1899
|
-
salto_ks_subscription_limit_exceeded:
|
|
1944
|
+
salto_ks_subscription_limit_exceeded: salto_ks_subscription_limit_exceeded2.optional().nullable(),
|
|
1900
1945
|
acs_system_disconnected: acs_system_disconnected.optional().nullable(),
|
|
1901
1946
|
account_disconnected: account_disconnected2.optional().nullable(),
|
|
1902
1947
|
salto_ks_certification_expired: salto_ks_certification_expired.optional().nullable()
|
|
@@ -1907,7 +1952,7 @@ var common_acs_system_warning = zod.z.object({
|
|
|
1907
1952
|
"Detailed description of the warning. Provides insights into the issue and potentially how to rectify it."
|
|
1908
1953
|
)
|
|
1909
1954
|
});
|
|
1910
|
-
var
|
|
1955
|
+
var salto_ks_subscription_limit_almost_reached2 = common_acs_system_warning.extend({
|
|
1911
1956
|
warning_code: zod.z.literal("salto_ks_subscription_limit_almost_reached").describe(
|
|
1912
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."
|
|
1913
1958
|
)
|
|
@@ -1919,11 +1964,11 @@ var time_zone_does_not_match_location = common_acs_system_warning.extend({
|
|
|
1919
1964
|
misconfigured_acs_entrance_ids: zod.z.array(zod.z.string().uuid()).optional()
|
|
1920
1965
|
});
|
|
1921
1966
|
var acs_system_warning = zod.z.discriminatedUnion("warning_code", [
|
|
1922
|
-
|
|
1967
|
+
salto_ks_subscription_limit_almost_reached2,
|
|
1923
1968
|
time_zone_does_not_match_location
|
|
1924
1969
|
]).describe("Warning associated with the `acs_system`.");
|
|
1925
1970
|
zod.z.object({
|
|
1926
|
-
salto_ks_subscription_limit_almost_reached:
|
|
1971
|
+
salto_ks_subscription_limit_almost_reached: salto_ks_subscription_limit_almost_reached2.optional().nullable(),
|
|
1927
1972
|
time_zone_does_not_match_location: time_zone_does_not_match_location.optional().nullable()
|
|
1928
1973
|
});
|
|
1929
1974
|
var acs_system = zod.z.object({
|
|
@@ -3575,6 +3620,15 @@ var noise_threshold = zod.z.object({
|
|
|
3575
3620
|
route_path: /noise_sensors/noise_thresholds
|
|
3576
3621
|
---
|
|
3577
3622
|
`);
|
|
3623
|
+
var pagination = zod.z.object({
|
|
3624
|
+
next_page_cursor: zod.z.string().nullable().describe(
|
|
3625
|
+
"Opaque value that can be used to select the next page of results via the `page_cursor` parameter."
|
|
3626
|
+
),
|
|
3627
|
+
has_next_page: zod.z.boolean().describe(
|
|
3628
|
+
"Indicates whether there is another page of results after this one."
|
|
3629
|
+
),
|
|
3630
|
+
next_page_url: zod.z.string().url().nullable().describe("URL to get the next page of results.")
|
|
3631
|
+
}).describe("Information about the current page of results.");
|
|
3578
3632
|
var user_identity = zod.z.object({
|
|
3579
3633
|
user_identity_id: zod.z.string().uuid().describe("ID of the user identity."),
|
|
3580
3634
|
user_identity_key: zod.z.string().min(1).nullable().describe("Unique key for the user identity."),
|
|
@@ -4106,6 +4160,11 @@ var openapi_default = {
|
|
|
4106
4160
|
{
|
|
4107
4161
|
description: "Account is disconnected.",
|
|
4108
4162
|
properties: {
|
|
4163
|
+
created_at: {
|
|
4164
|
+
description: "Date and time at which Seam created the error.",
|
|
4165
|
+
format: "date-time",
|
|
4166
|
+
type: "string"
|
|
4167
|
+
},
|
|
4109
4168
|
error_code: {
|
|
4110
4169
|
description: "Unique identifier of the type of error. Enables quick recognition and categorization of the issue.",
|
|
4111
4170
|
enum: ["account_disconnected"],
|
|
@@ -4118,6 +4177,7 @@ var openapi_default = {
|
|
|
4118
4177
|
message: { type: "string" }
|
|
4119
4178
|
},
|
|
4120
4179
|
required: [
|
|
4180
|
+
"created_at",
|
|
4121
4181
|
"message",
|
|
4122
4182
|
"is_connected_account_error",
|
|
4123
4183
|
"error_code"
|
|
@@ -4127,6 +4187,11 @@ var openapi_default = {
|
|
|
4127
4187
|
{
|
|
4128
4188
|
description: "Credentials provided were invalid.",
|
|
4129
4189
|
properties: {
|
|
4190
|
+
created_at: {
|
|
4191
|
+
description: "Date and time at which Seam created the error.",
|
|
4192
|
+
format: "date-time",
|
|
4193
|
+
type: "string"
|
|
4194
|
+
},
|
|
4130
4195
|
error_code: {
|
|
4131
4196
|
description: "Unique identifier of the type of error. Enables quick recognition and categorization of the issue.",
|
|
4132
4197
|
enum: ["invalid_credentials"],
|
|
@@ -4139,11 +4204,70 @@ var openapi_default = {
|
|
|
4139
4204
|
message: { type: "string" }
|
|
4140
4205
|
},
|
|
4141
4206
|
required: [
|
|
4207
|
+
"created_at",
|
|
4142
4208
|
"message",
|
|
4143
4209
|
"is_connected_account_error",
|
|
4144
4210
|
"error_code"
|
|
4145
4211
|
],
|
|
4146
4212
|
type: "object"
|
|
4213
|
+
},
|
|
4214
|
+
{
|
|
4215
|
+
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.",
|
|
4216
|
+
properties: {
|
|
4217
|
+
created_at: {
|
|
4218
|
+
description: "Date and time at which Seam created the error.",
|
|
4219
|
+
format: "date-time",
|
|
4220
|
+
type: "string"
|
|
4221
|
+
},
|
|
4222
|
+
error_code: {
|
|
4223
|
+
description: "Unique identifier of the type of error. Enables quick recognition and categorization of the issue.",
|
|
4224
|
+
enum: ["salto_ks_subscription_limit_exceeded"],
|
|
4225
|
+
type: "string"
|
|
4226
|
+
},
|
|
4227
|
+
is_connected_account_error: {
|
|
4228
|
+
enum: [true],
|
|
4229
|
+
type: "boolean"
|
|
4230
|
+
},
|
|
4231
|
+
message: { type: "string" },
|
|
4232
|
+
salto_ks_metadata: {
|
|
4233
|
+
properties: {
|
|
4234
|
+
sites: {
|
|
4235
|
+
items: {
|
|
4236
|
+
properties: {
|
|
4237
|
+
site_id: { type: "string" },
|
|
4238
|
+
site_name: { type: "string" },
|
|
4239
|
+
site_user_subscription_limit: {
|
|
4240
|
+
minimum: 0,
|
|
4241
|
+
type: "integer"
|
|
4242
|
+
},
|
|
4243
|
+
subscribed_site_user_count: {
|
|
4244
|
+
minimum: 0,
|
|
4245
|
+
type: "integer"
|
|
4246
|
+
}
|
|
4247
|
+
},
|
|
4248
|
+
required: [
|
|
4249
|
+
"site_id",
|
|
4250
|
+
"site_name",
|
|
4251
|
+
"subscribed_site_user_count",
|
|
4252
|
+
"site_user_subscription_limit"
|
|
4253
|
+
],
|
|
4254
|
+
type: "object"
|
|
4255
|
+
},
|
|
4256
|
+
type: "array"
|
|
4257
|
+
}
|
|
4258
|
+
},
|
|
4259
|
+
required: ["sites"],
|
|
4260
|
+
type: "object"
|
|
4261
|
+
}
|
|
4262
|
+
},
|
|
4263
|
+
required: [
|
|
4264
|
+
"created_at",
|
|
4265
|
+
"message",
|
|
4266
|
+
"is_connected_account_error",
|
|
4267
|
+
"error_code",
|
|
4268
|
+
"salto_ks_metadata"
|
|
4269
|
+
],
|
|
4270
|
+
type: "object"
|
|
4147
4271
|
}
|
|
4148
4272
|
]
|
|
4149
4273
|
},
|
|
@@ -8492,6 +8616,11 @@ var openapi_default = {
|
|
|
8492
8616
|
{
|
|
8493
8617
|
description: "Account is disconnected.",
|
|
8494
8618
|
properties: {
|
|
8619
|
+
created_at: {
|
|
8620
|
+
description: "Date and time at which Seam created the error.",
|
|
8621
|
+
format: "date-time",
|
|
8622
|
+
type: "string"
|
|
8623
|
+
},
|
|
8495
8624
|
error_code: {
|
|
8496
8625
|
description: "Unique identifier of the type of error. Enables quick recognition and categorization of the issue.",
|
|
8497
8626
|
enum: ["account_disconnected"],
|
|
@@ -8504,6 +8633,7 @@ var openapi_default = {
|
|
|
8504
8633
|
message: { type: "string" }
|
|
8505
8634
|
},
|
|
8506
8635
|
required: [
|
|
8636
|
+
"created_at",
|
|
8507
8637
|
"message",
|
|
8508
8638
|
"is_connected_account_error",
|
|
8509
8639
|
"error_code"
|
|
@@ -8513,6 +8643,11 @@ var openapi_default = {
|
|
|
8513
8643
|
{
|
|
8514
8644
|
description: "Credentials provided were invalid.",
|
|
8515
8645
|
properties: {
|
|
8646
|
+
created_at: {
|
|
8647
|
+
description: "Date and time at which Seam created the error.",
|
|
8648
|
+
format: "date-time",
|
|
8649
|
+
type: "string"
|
|
8650
|
+
},
|
|
8516
8651
|
error_code: {
|
|
8517
8652
|
description: "Unique identifier of the type of error. Enables quick recognition and categorization of the issue.",
|
|
8518
8653
|
enum: ["invalid_credentials"],
|
|
@@ -8525,11 +8660,70 @@ var openapi_default = {
|
|
|
8525
8660
|
message: { type: "string" }
|
|
8526
8661
|
},
|
|
8527
8662
|
required: [
|
|
8663
|
+
"created_at",
|
|
8528
8664
|
"message",
|
|
8529
8665
|
"is_connected_account_error",
|
|
8530
8666
|
"error_code"
|
|
8531
8667
|
],
|
|
8532
8668
|
type: "object"
|
|
8669
|
+
},
|
|
8670
|
+
{
|
|
8671
|
+
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.",
|
|
8672
|
+
properties: {
|
|
8673
|
+
created_at: {
|
|
8674
|
+
description: "Date and time at which Seam created the error.",
|
|
8675
|
+
format: "date-time",
|
|
8676
|
+
type: "string"
|
|
8677
|
+
},
|
|
8678
|
+
error_code: {
|
|
8679
|
+
description: "Unique identifier of the type of error. Enables quick recognition and categorization of the issue.",
|
|
8680
|
+
enum: ["salto_ks_subscription_limit_exceeded"],
|
|
8681
|
+
type: "string"
|
|
8682
|
+
},
|
|
8683
|
+
is_connected_account_error: {
|
|
8684
|
+
enum: [true],
|
|
8685
|
+
type: "boolean"
|
|
8686
|
+
},
|
|
8687
|
+
message: { type: "string" },
|
|
8688
|
+
salto_ks_metadata: {
|
|
8689
|
+
properties: {
|
|
8690
|
+
sites: {
|
|
8691
|
+
items: {
|
|
8692
|
+
properties: {
|
|
8693
|
+
site_id: { type: "string" },
|
|
8694
|
+
site_name: { type: "string" },
|
|
8695
|
+
site_user_subscription_limit: {
|
|
8696
|
+
minimum: 0,
|
|
8697
|
+
type: "integer"
|
|
8698
|
+
},
|
|
8699
|
+
subscribed_site_user_count: {
|
|
8700
|
+
minimum: 0,
|
|
8701
|
+
type: "integer"
|
|
8702
|
+
}
|
|
8703
|
+
},
|
|
8704
|
+
required: [
|
|
8705
|
+
"site_id",
|
|
8706
|
+
"site_name",
|
|
8707
|
+
"subscribed_site_user_count",
|
|
8708
|
+
"site_user_subscription_limit"
|
|
8709
|
+
],
|
|
8710
|
+
type: "object"
|
|
8711
|
+
},
|
|
8712
|
+
type: "array"
|
|
8713
|
+
}
|
|
8714
|
+
},
|
|
8715
|
+
required: ["sites"],
|
|
8716
|
+
type: "object"
|
|
8717
|
+
}
|
|
8718
|
+
},
|
|
8719
|
+
required: [
|
|
8720
|
+
"created_at",
|
|
8721
|
+
"message",
|
|
8722
|
+
"is_connected_account_error",
|
|
8723
|
+
"error_code",
|
|
8724
|
+
"salto_ks_metadata"
|
|
8725
|
+
],
|
|
8726
|
+
type: "object"
|
|
8533
8727
|
}
|
|
8534
8728
|
]
|
|
8535
8729
|
},
|
|
@@ -8553,6 +8747,11 @@ var openapi_default = {
|
|
|
8553
8747
|
{
|
|
8554
8748
|
description: "Scheduled downtime for account planned.",
|
|
8555
8749
|
properties: {
|
|
8750
|
+
created_at: {
|
|
8751
|
+
description: "Date and time at which Seam created the warning.",
|
|
8752
|
+
format: "date-time",
|
|
8753
|
+
type: "string"
|
|
8754
|
+
},
|
|
8556
8755
|
message: { type: "string" },
|
|
8557
8756
|
warning_code: {
|
|
8558
8757
|
description: "Unique identifier of the type of warning. Enables quick recognition and categorization of the issue.",
|
|
@@ -8560,12 +8759,17 @@ var openapi_default = {
|
|
|
8560
8759
|
type: "string"
|
|
8561
8760
|
}
|
|
8562
8761
|
},
|
|
8563
|
-
required: ["message", "warning_code"],
|
|
8762
|
+
required: ["created_at", "message", "warning_code"],
|
|
8564
8763
|
type: "object"
|
|
8565
8764
|
},
|
|
8566
8765
|
{
|
|
8567
8766
|
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.",
|
|
8568
8767
|
properties: {
|
|
8768
|
+
created_at: {
|
|
8769
|
+
description: "Date and time at which Seam created the warning.",
|
|
8770
|
+
format: "date-time",
|
|
8771
|
+
type: "string"
|
|
8772
|
+
},
|
|
8569
8773
|
message: { type: "string" },
|
|
8570
8774
|
warning_code: {
|
|
8571
8775
|
description: "Unique identifier of the type of warning. Enables quick recognition and categorization of the issue.",
|
|
@@ -8573,7 +8777,60 @@ var openapi_default = {
|
|
|
8573
8777
|
type: "string"
|
|
8574
8778
|
}
|
|
8575
8779
|
},
|
|
8576
|
-
required: ["message", "warning_code"],
|
|
8780
|
+
required: ["created_at", "message", "warning_code"],
|
|
8781
|
+
type: "object"
|
|
8782
|
+
},
|
|
8783
|
+
{
|
|
8784
|
+
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.",
|
|
8785
|
+
properties: {
|
|
8786
|
+
created_at: {
|
|
8787
|
+
description: "Date and time at which Seam created the warning.",
|
|
8788
|
+
format: "date-time",
|
|
8789
|
+
type: "string"
|
|
8790
|
+
},
|
|
8791
|
+
message: { type: "string" },
|
|
8792
|
+
salto_ks_metadata: {
|
|
8793
|
+
properties: {
|
|
8794
|
+
sites: {
|
|
8795
|
+
items: {
|
|
8796
|
+
properties: {
|
|
8797
|
+
site_id: { type: "string" },
|
|
8798
|
+
site_name: { type: "string" },
|
|
8799
|
+
site_user_subscription_limit: {
|
|
8800
|
+
minimum: 0,
|
|
8801
|
+
type: "integer"
|
|
8802
|
+
},
|
|
8803
|
+
subscribed_site_user_count: {
|
|
8804
|
+
minimum: 0,
|
|
8805
|
+
type: "integer"
|
|
8806
|
+
}
|
|
8807
|
+
},
|
|
8808
|
+
required: [
|
|
8809
|
+
"site_id",
|
|
8810
|
+
"site_name",
|
|
8811
|
+
"site_user_subscription_limit",
|
|
8812
|
+
"subscribed_site_user_count"
|
|
8813
|
+
],
|
|
8814
|
+
type: "object"
|
|
8815
|
+
},
|
|
8816
|
+
type: "array"
|
|
8817
|
+
}
|
|
8818
|
+
},
|
|
8819
|
+
required: ["sites"],
|
|
8820
|
+
type: "object"
|
|
8821
|
+
},
|
|
8822
|
+
warning_code: {
|
|
8823
|
+
description: "Unique identifier of the type of warning. Enables quick recognition and categorization of the issue.",
|
|
8824
|
+
enum: ["salto_ks_subscription_limit_almost_reached"],
|
|
8825
|
+
type: "string"
|
|
8826
|
+
}
|
|
8827
|
+
},
|
|
8828
|
+
required: [
|
|
8829
|
+
"created_at",
|
|
8830
|
+
"message",
|
|
8831
|
+
"warning_code",
|
|
8832
|
+
"salto_ks_metadata"
|
|
8833
|
+
],
|
|
8577
8834
|
type: "object"
|
|
8578
8835
|
}
|
|
8579
8836
|
]
|
|
@@ -8875,6 +9132,11 @@ var openapi_default = {
|
|
|
8875
9132
|
{
|
|
8876
9133
|
description: "Account is disconnected.",
|
|
8877
9134
|
properties: {
|
|
9135
|
+
created_at: {
|
|
9136
|
+
description: "Date and time at which Seam created the error.",
|
|
9137
|
+
format: "date-time",
|
|
9138
|
+
type: "string"
|
|
9139
|
+
},
|
|
8878
9140
|
error_code: {
|
|
8879
9141
|
description: "Unique identifier of the type of error. Enables quick recognition and categorization of the issue.",
|
|
8880
9142
|
enum: ["account_disconnected"],
|
|
@@ -8887,6 +9149,7 @@ var openapi_default = {
|
|
|
8887
9149
|
message: { type: "string" }
|
|
8888
9150
|
},
|
|
8889
9151
|
required: [
|
|
9152
|
+
"created_at",
|
|
8890
9153
|
"message",
|
|
8891
9154
|
"is_connected_account_error",
|
|
8892
9155
|
"error_code"
|
|
@@ -8896,6 +9159,11 @@ var openapi_default = {
|
|
|
8896
9159
|
{
|
|
8897
9160
|
description: "Credentials provided were invalid.",
|
|
8898
9161
|
properties: {
|
|
9162
|
+
created_at: {
|
|
9163
|
+
description: "Date and time at which Seam created the error.",
|
|
9164
|
+
format: "date-time",
|
|
9165
|
+
type: "string"
|
|
9166
|
+
},
|
|
8899
9167
|
error_code: {
|
|
8900
9168
|
description: "Unique identifier of the type of error. Enables quick recognition and categorization of the issue.",
|
|
8901
9169
|
enum: ["invalid_credentials"],
|
|
@@ -8908,11 +9176,70 @@ var openapi_default = {
|
|
|
8908
9176
|
message: { type: "string" }
|
|
8909
9177
|
},
|
|
8910
9178
|
required: [
|
|
9179
|
+
"created_at",
|
|
8911
9180
|
"message",
|
|
8912
9181
|
"is_connected_account_error",
|
|
8913
9182
|
"error_code"
|
|
8914
9183
|
],
|
|
8915
9184
|
type: "object"
|
|
9185
|
+
},
|
|
9186
|
+
{
|
|
9187
|
+
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.",
|
|
9188
|
+
properties: {
|
|
9189
|
+
created_at: {
|
|
9190
|
+
description: "Date and time at which Seam created the error.",
|
|
9191
|
+
format: "date-time",
|
|
9192
|
+
type: "string"
|
|
9193
|
+
},
|
|
9194
|
+
error_code: {
|
|
9195
|
+
description: "Unique identifier of the type of error. Enables quick recognition and categorization of the issue.",
|
|
9196
|
+
enum: ["salto_ks_subscription_limit_exceeded"],
|
|
9197
|
+
type: "string"
|
|
9198
|
+
},
|
|
9199
|
+
is_connected_account_error: {
|
|
9200
|
+
enum: [true],
|
|
9201
|
+
type: "boolean"
|
|
9202
|
+
},
|
|
9203
|
+
message: { type: "string" },
|
|
9204
|
+
salto_ks_metadata: {
|
|
9205
|
+
properties: {
|
|
9206
|
+
sites: {
|
|
9207
|
+
items: {
|
|
9208
|
+
properties: {
|
|
9209
|
+
site_id: { type: "string" },
|
|
9210
|
+
site_name: { type: "string" },
|
|
9211
|
+
site_user_subscription_limit: {
|
|
9212
|
+
minimum: 0,
|
|
9213
|
+
type: "integer"
|
|
9214
|
+
},
|
|
9215
|
+
subscribed_site_user_count: {
|
|
9216
|
+
minimum: 0,
|
|
9217
|
+
type: "integer"
|
|
9218
|
+
}
|
|
9219
|
+
},
|
|
9220
|
+
required: [
|
|
9221
|
+
"site_id",
|
|
9222
|
+
"site_name",
|
|
9223
|
+
"subscribed_site_user_count",
|
|
9224
|
+
"site_user_subscription_limit"
|
|
9225
|
+
],
|
|
9226
|
+
type: "object"
|
|
9227
|
+
},
|
|
9228
|
+
type: "array"
|
|
9229
|
+
}
|
|
9230
|
+
},
|
|
9231
|
+
required: ["sites"],
|
|
9232
|
+
type: "object"
|
|
9233
|
+
}
|
|
9234
|
+
},
|
|
9235
|
+
required: [
|
|
9236
|
+
"created_at",
|
|
9237
|
+
"message",
|
|
9238
|
+
"is_connected_account_error",
|
|
9239
|
+
"error_code",
|
|
9240
|
+
"salto_ks_metadata"
|
|
9241
|
+
],
|
|
9242
|
+
type: "object"
|
|
8916
9243
|
}
|
|
8917
9244
|
]
|
|
8918
9245
|
},
|
|
@@ -14598,6 +14925,28 @@ var openapi_default = {
|
|
|
14598
14925
|
type: "object",
|
|
14599
14926
|
"x-route-path": "/noise_sensors/noise_thresholds"
|
|
14600
14927
|
},
|
|
14928
|
+
pagination: {
|
|
14929
|
+
description: "Information about the current page of results.",
|
|
14930
|
+
properties: {
|
|
14931
|
+
has_next_page: {
|
|
14932
|
+
description: "Indicates whether there is another page of results after this one.",
|
|
14933
|
+
type: "boolean"
|
|
14934
|
+
},
|
|
14935
|
+
next_page_cursor: {
|
|
14936
|
+
description: "Opaque value that can be used to select the next page of results via the `page_cursor` parameter.",
|
|
14937
|
+
nullable: true,
|
|
14938
|
+
type: "string"
|
|
14939
|
+
},
|
|
14940
|
+
next_page_url: {
|
|
14941
|
+
description: "URL to get the next page of results.",
|
|
14942
|
+
format: "uri",
|
|
14943
|
+
nullable: true,
|
|
14944
|
+
type: "string"
|
|
14945
|
+
}
|
|
14946
|
+
},
|
|
14947
|
+
required: ["next_page_cursor", "has_next_page", "next_page_url"],
|
|
14948
|
+
type: "object"
|
|
14949
|
+
},
|
|
14601
14950
|
phone: {
|
|
14602
14951
|
description: "Represents an app user's mobile phone.",
|
|
14603
14952
|
properties: {
|
|
@@ -15267,6 +15616,11 @@ var openapi_default = {
|
|
|
15267
15616
|
{
|
|
15268
15617
|
description: "Account is disconnected.",
|
|
15269
15618
|
properties: {
|
|
15619
|
+
created_at: {
|
|
15620
|
+
description: "Date and time at which Seam created the error.",
|
|
15621
|
+
format: "date-time",
|
|
15622
|
+
type: "string"
|
|
15623
|
+
},
|
|
15270
15624
|
error_code: {
|
|
15271
15625
|
description: "Unique identifier of the type of error. Enables quick recognition and categorization of the issue.",
|
|
15272
15626
|
enum: ["account_disconnected"],
|
|
@@ -15279,6 +15633,7 @@ var openapi_default = {
|
|
|
15279
15633
|
message: { type: "string" }
|
|
15280
15634
|
},
|
|
15281
15635
|
required: [
|
|
15636
|
+
"created_at",
|
|
15282
15637
|
"message",
|
|
15283
15638
|
"is_connected_account_error",
|
|
15284
15639
|
"error_code"
|
|
@@ -15288,6 +15643,11 @@ var openapi_default = {
|
|
|
15288
15643
|
{
|
|
15289
15644
|
description: "Credentials provided were invalid.",
|
|
15290
15645
|
properties: {
|
|
15646
|
+
created_at: {
|
|
15647
|
+
description: "Date and time at which Seam created the error.",
|
|
15648
|
+
format: "date-time",
|
|
15649
|
+
type: "string"
|
|
15650
|
+
},
|
|
15291
15651
|
error_code: {
|
|
15292
15652
|
description: "Unique identifier of the type of error. Enables quick recognition and categorization of the issue.",
|
|
15293
15653
|
enum: ["invalid_credentials"],
|
|
@@ -15300,11 +15660,70 @@ var openapi_default = {
|
|
|
15300
15660
|
message: { type: "string" }
|
|
15301
15661
|
},
|
|
15302
15662
|
required: [
|
|
15663
|
+
"created_at",
|
|
15303
15664
|
"message",
|
|
15304
15665
|
"is_connected_account_error",
|
|
15305
15666
|
"error_code"
|
|
15306
15667
|
],
|
|
15307
15668
|
type: "object"
|
|
15669
|
+
},
|
|
15670
|
+
{
|
|
15671
|
+
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.",
|
|
15672
|
+
properties: {
|
|
15673
|
+
created_at: {
|
|
15674
|
+
description: "Date and time at which Seam created the error.",
|
|
15675
|
+
format: "date-time",
|
|
15676
|
+
type: "string"
|
|
15677
|
+
},
|
|
15678
|
+
error_code: {
|
|
15679
|
+
description: "Unique identifier of the type of error. Enables quick recognition and categorization of the issue.",
|
|
15680
|
+
enum: ["salto_ks_subscription_limit_exceeded"],
|
|
15681
|
+
type: "string"
|
|
15682
|
+
},
|
|
15683
|
+
is_connected_account_error: {
|
|
15684
|
+
enum: [true],
|
|
15685
|
+
type: "boolean"
|
|
15686
|
+
},
|
|
15687
|
+
message: { type: "string" },
|
|
15688
|
+
salto_ks_metadata: {
|
|
15689
|
+
properties: {
|
|
15690
|
+
sites: {
|
|
15691
|
+
items: {
|
|
15692
|
+
properties: {
|
|
15693
|
+
site_id: { type: "string" },
|
|
15694
|
+
site_name: { type: "string" },
|
|
15695
|
+
site_user_subscription_limit: {
|
|
15696
|
+
minimum: 0,
|
|
15697
|
+
type: "integer"
|
|
15698
|
+
},
|
|
15699
|
+
subscribed_site_user_count: {
|
|
15700
|
+
minimum: 0,
|
|
15701
|
+
type: "integer"
|
|
15702
|
+
}
|
|
15703
|
+
},
|
|
15704
|
+
required: [
|
|
15705
|
+
"site_id",
|
|
15706
|
+
"site_name",
|
|
15707
|
+
"subscribed_site_user_count",
|
|
15708
|
+
"site_user_subscription_limit"
|
|
15709
|
+
],
|
|
15710
|
+
type: "object"
|
|
15711
|
+
},
|
|
15712
|
+
type: "array"
|
|
15713
|
+
}
|
|
15714
|
+
},
|
|
15715
|
+
required: ["sites"],
|
|
15716
|
+
type: "object"
|
|
15717
|
+
}
|
|
15718
|
+
},
|
|
15719
|
+
required: [
|
|
15720
|
+
"created_at",
|
|
15721
|
+
"message",
|
|
15722
|
+
"is_connected_account_error",
|
|
15723
|
+
"error_code",
|
|
15724
|
+
"salto_ks_metadata"
|
|
15725
|
+
],
|
|
15726
|
+
type: "object"
|
|
15308
15727
|
}
|
|
15309
15728
|
]
|
|
15310
15729
|
},
|
|
@@ -16470,6 +16889,11 @@ var openapi_default = {
|
|
|
16470
16889
|
{
|
|
16471
16890
|
description: "Account is disconnected.",
|
|
16472
16891
|
properties: {
|
|
16892
|
+
created_at: {
|
|
16893
|
+
description: "Date and time at which Seam created the error.",
|
|
16894
|
+
format: "date-time",
|
|
16895
|
+
type: "string"
|
|
16896
|
+
},
|
|
16473
16897
|
error_code: {
|
|
16474
16898
|
description: "Unique identifier of the type of error. Enables quick recognition and categorization of the issue.",
|
|
16475
16899
|
enum: ["account_disconnected"],
|
|
@@ -16482,6 +16906,7 @@ var openapi_default = {
|
|
|
16482
16906
|
message: { type: "string" }
|
|
16483
16907
|
},
|
|
16484
16908
|
required: [
|
|
16909
|
+
"created_at",
|
|
16485
16910
|
"message",
|
|
16486
16911
|
"is_connected_account_error",
|
|
16487
16912
|
"error_code"
|
|
@@ -16491,6 +16916,11 @@ var openapi_default = {
|
|
|
16491
16916
|
{
|
|
16492
16917
|
description: "Credentials provided were invalid.",
|
|
16493
16918
|
properties: {
|
|
16919
|
+
created_at: {
|
|
16920
|
+
description: "Date and time at which Seam created the error.",
|
|
16921
|
+
format: "date-time",
|
|
16922
|
+
type: "string"
|
|
16923
|
+
},
|
|
16494
16924
|
error_code: {
|
|
16495
16925
|
description: "Unique identifier of the type of error. Enables quick recognition and categorization of the issue.",
|
|
16496
16926
|
enum: ["invalid_credentials"],
|
|
@@ -16503,11 +16933,70 @@ var openapi_default = {
|
|
|
16503
16933
|
message: { type: "string" }
|
|
16504
16934
|
},
|
|
16505
16935
|
required: [
|
|
16936
|
+
"created_at",
|
|
16506
16937
|
"message",
|
|
16507
16938
|
"is_connected_account_error",
|
|
16508
16939
|
"error_code"
|
|
16509
16940
|
],
|
|
16510
16941
|
type: "object"
|
|
16942
|
+
},
|
|
16943
|
+
{
|
|
16944
|
+
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.",
|
|
16945
|
+
properties: {
|
|
16946
|
+
created_at: {
|
|
16947
|
+
description: "Date and time at which Seam created the error.",
|
|
16948
|
+
format: "date-time",
|
|
16949
|
+
type: "string"
|
|
16950
|
+
},
|
|
16951
|
+
error_code: {
|
|
16952
|
+
description: "Unique identifier of the type of error. Enables quick recognition and categorization of the issue.",
|
|
16953
|
+
enum: ["salto_ks_subscription_limit_exceeded"],
|
|
16954
|
+
type: "string"
|
|
16955
|
+
},
|
|
16956
|
+
is_connected_account_error: {
|
|
16957
|
+
enum: [true],
|
|
16958
|
+
type: "boolean"
|
|
16959
|
+
},
|
|
16960
|
+
message: { type: "string" },
|
|
16961
|
+
salto_ks_metadata: {
|
|
16962
|
+
properties: {
|
|
16963
|
+
sites: {
|
|
16964
|
+
items: {
|
|
16965
|
+
properties: {
|
|
16966
|
+
site_id: { type: "string" },
|
|
16967
|
+
site_name: { type: "string" },
|
|
16968
|
+
site_user_subscription_limit: {
|
|
16969
|
+
minimum: 0,
|
|
16970
|
+
type: "integer"
|
|
16971
|
+
},
|
|
16972
|
+
subscribed_site_user_count: {
|
|
16973
|
+
minimum: 0,
|
|
16974
|
+
type: "integer"
|
|
16975
|
+
}
|
|
16976
|
+
},
|
|
16977
|
+
required: [
|
|
16978
|
+
"site_id",
|
|
16979
|
+
"site_name",
|
|
16980
|
+
"subscribed_site_user_count",
|
|
16981
|
+
"site_user_subscription_limit"
|
|
16982
|
+
],
|
|
16983
|
+
type: "object"
|
|
16984
|
+
},
|
|
16985
|
+
type: "array"
|
|
16986
|
+
}
|
|
16987
|
+
},
|
|
16988
|
+
required: ["sites"],
|
|
16989
|
+
type: "object"
|
|
16990
|
+
}
|
|
16991
|
+
},
|
|
16992
|
+
required: [
|
|
16993
|
+
"created_at",
|
|
16994
|
+
"message",
|
|
16995
|
+
"is_connected_account_error",
|
|
16996
|
+
"error_code",
|
|
16997
|
+
"salto_ks_metadata"
|
|
16998
|
+
],
|
|
16999
|
+
type: "object"
|
|
16511
17000
|
}
|
|
16512
17001
|
]
|
|
16513
17002
|
},
|
|
@@ -21243,32 +21732,7 @@ var openapi_default = {
|
|
|
21243
21732
|
type: "array"
|
|
21244
21733
|
},
|
|
21245
21734
|
ok: { type: "boolean" },
|
|
21246
|
-
pagination: {
|
|
21247
|
-
description: "Information about the current page of results.",
|
|
21248
|
-
properties: {
|
|
21249
|
-
has_next_page: {
|
|
21250
|
-
description: "Indicates whether there is another page of results after this one.",
|
|
21251
|
-
type: "boolean"
|
|
21252
|
-
},
|
|
21253
|
-
next_page_cursor: {
|
|
21254
|
-
description: "Opaque value that can be used to select the next page of results via the `page_cursor` parameter.",
|
|
21255
|
-
nullable: true,
|
|
21256
|
-
type: "string"
|
|
21257
|
-
},
|
|
21258
|
-
next_page_url: {
|
|
21259
|
-
description: "URL to get the next page of results.",
|
|
21260
|
-
format: "uri",
|
|
21261
|
-
nullable: true,
|
|
21262
|
-
type: "string"
|
|
21263
|
-
}
|
|
21264
|
-
},
|
|
21265
|
-
required: [
|
|
21266
|
-
"next_page_cursor",
|
|
21267
|
-
"has_next_page",
|
|
21268
|
-
"next_page_url"
|
|
21269
|
-
],
|
|
21270
|
-
type: "object"
|
|
21271
|
-
}
|
|
21735
|
+
pagination: { $ref: "#/components/schemas/pagination" }
|
|
21272
21736
|
},
|
|
21273
21737
|
required: ["acs_users", "pagination", "ok"],
|
|
21274
21738
|
type: "object"
|