@seamapi/types 1.376.0 → 1.377.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 +1579 -385
- package/dist/connect.cjs.map +1 -1
- package/dist/connect.d.cts +1527 -355
- package/lib/seam/connect/models/access-codes/managed-access-code.js +48 -23
- package/lib/seam/connect/models/access-codes/managed-access-code.js.map +1 -1
- package/lib/seam/connect/models/access-codes/unmanaged-access-code.js +13 -2
- package/lib/seam/connect/models/access-codes/unmanaged-access-code.js.map +1 -1
- package/lib/seam/connect/openapi.d.ts +201 -2
- package/lib/seam/connect/openapi.js +1508 -338
- package/lib/seam/connect/openapi.js.map +1 -1
- package/lib/seam/connect/route-types.d.ts +1036 -63
- package/package.json +1 -1
- package/src/lib/seam/connect/models/access-codes/managed-access-code.ts +95 -60
- package/src/lib/seam/connect/models/access-codes/unmanaged-access-code.ts +15 -2
- package/src/lib/seam/connect/openapi.ts +1850 -350
- package/src/lib/seam/connect/route-types.ts +1036 -63
package/dist/connect.cjs
CHANGED
|
@@ -1380,14 +1380,16 @@ var unmanaged_device = device.pick({
|
|
|
1380
1380
|
|
|
1381
1381
|
// src/lib/seam/connect/models/access-codes/managed-access-code.ts
|
|
1382
1382
|
var common_access_code_error = zod.z.object({
|
|
1383
|
-
message: zod.z.string()
|
|
1384
|
-
|
|
1385
|
-
|
|
1383
|
+
message: zod.z.string().describe(
|
|
1384
|
+
"Detailed description of the error. Provides insights into the issue and potentially how to rectify it."
|
|
1385
|
+
),
|
|
1386
|
+
is_access_code_error: zod.z.literal(true).describe("Indicates that this is an access code error."),
|
|
1387
|
+
created_at: zod.z.string().datetime().optional().describe("Date and time at which Seam created the error.")
|
|
1386
1388
|
});
|
|
1387
1389
|
var error_code_description3 = "Unique identifier of the type of error. Enables quick recognition and categorization of the issue.";
|
|
1388
1390
|
var smartthings_failed_to_set_access_code_error = common_access_code_error.extend({
|
|
1389
1391
|
error_code: zod.z.literal("smartthings_failed_to_set_access_code").describe(error_code_description3)
|
|
1390
|
-
}).describe("Failed to set code on
|
|
1392
|
+
}).describe("Failed to set code on SmartThings device.");
|
|
1391
1393
|
var smartthings_failed_to_set_after_multiple_retries = common_access_code_error.extend({
|
|
1392
1394
|
error_code: zod.z.literal("smartthings_failed_to_set_after_multiple_retries").describe(error_code_description3)
|
|
1393
1395
|
}).describe("Failed to set code after multiple retries.");
|
|
@@ -1416,7 +1418,7 @@ var igloohome_bridge_offline = common_access_code_error.extend({
|
|
|
1416
1418
|
}).describe("Igloohome bridge is offline.");
|
|
1417
1419
|
var kwikset_unable_to_confirm_code = common_access_code_error.extend({
|
|
1418
1420
|
error_code: zod.z.literal("kwikset_unable_to_confirm_code").describe(error_code_description3)
|
|
1419
|
-
}).describe("Unable to confirm the access code is set on Kwikset device.");
|
|
1421
|
+
}).describe("Unable to confirm that the access code is set on Kwikset device.");
|
|
1420
1422
|
var kwikset_unable_to_confirm_deletion = common_access_code_error.extend({
|
|
1421
1423
|
error_code: zod.z.literal("kwikset_unable_to_confirm_deletion").describe(error_code_description3)
|
|
1422
1424
|
}).describe(
|
|
@@ -1424,7 +1426,7 @@ var kwikset_unable_to_confirm_deletion = common_access_code_error.extend({
|
|
|
1424
1426
|
);
|
|
1425
1427
|
var igloohome_offline_access_code_no_variance_available = common_access_code_error.extend({
|
|
1426
1428
|
error_code: zod.z.literal("igloohome_offline_access_code_no_variance_available").describe(error_code_description3)
|
|
1427
|
-
}).describe("Lock
|
|
1429
|
+
}).describe("Lock has reached maximum amount of codes.");
|
|
1428
1430
|
var august_lock_invalid_code_length = common_access_code_error.extend({
|
|
1429
1431
|
error_code: zod.z.literal("august_lock_invalid_code_length").describe(error_code_description3)
|
|
1430
1432
|
}).describe("Invalid code length for August lock.");
|
|
@@ -1486,7 +1488,9 @@ var access_code_error = zod.z.discriminatedUnion("error_code", [
|
|
|
1486
1488
|
wyze_duplicate_code_name,
|
|
1487
1489
|
wyze_potential_duplicate_code,
|
|
1488
1490
|
dormakaba_oracode_no_valid_user_level
|
|
1489
|
-
])
|
|
1491
|
+
]).describe(
|
|
1492
|
+
"Errors associated with the [access code](https://docs.seam.co/latest/capability-guides/smart-locks/access-codes)."
|
|
1493
|
+
);
|
|
1490
1494
|
zod.z.object({
|
|
1491
1495
|
smartthings_failed_to_set_access_code: smartthings_failed_to_set_access_code_error.optional().nullable(),
|
|
1492
1496
|
smartthings_failed_to_set_after_multiple_retries: smartthings_failed_to_set_after_multiple_retries.optional().nullable(),
|
|
@@ -1514,13 +1518,15 @@ zod.z.object({
|
|
|
1514
1518
|
dormakaba_oracode_no_valid_user_level: dormakaba_oracode_no_valid_user_level.optional().nullable()
|
|
1515
1519
|
});
|
|
1516
1520
|
var common_access_code_warning = zod.z.object({
|
|
1517
|
-
message: zod.z.string()
|
|
1518
|
-
|
|
1521
|
+
message: zod.z.string().describe(
|
|
1522
|
+
"Detailed description of the warning. Provides insights into the issue and potentially how to rectify it."
|
|
1523
|
+
),
|
|
1524
|
+
created_at: zod.z.string().datetime().optional().describe("Date and time at which Seam created the warning.")
|
|
1519
1525
|
});
|
|
1520
1526
|
var warning_code_description3 = "Unique identifier of the type of warning. Enables quick recognition and categorization of the issue.";
|
|
1521
1527
|
var smartthings_failed_to_set_access_code_warning = common_access_code_warning.extend({
|
|
1522
1528
|
warning_code: zod.z.literal("smartthings_failed_to_set_access_code").describe(warning_code_description3)
|
|
1523
|
-
}).describe("Failed to set code on
|
|
1529
|
+
}).describe("Failed to set code on SmartThings device.");
|
|
1524
1530
|
var august_device_programming_delay_warning = common_access_code_warning.extend({
|
|
1525
1531
|
warning_code: zod.z.literal("august_device_programming_delay").describe(warning_code_description3)
|
|
1526
1532
|
}).describe("Access code has not yet been fully moved to the device.");
|
|
@@ -1547,7 +1553,7 @@ var delay_in_removing_from_device = common_access_code_warning.extend({
|
|
|
1547
1553
|
var third_party_integration_detected2 = common_access_code_warning.extend({
|
|
1548
1554
|
warning_code: zod.z.literal("third_party_integration_detected").describe(warning_code_description3)
|
|
1549
1555
|
}).describe(
|
|
1550
|
-
"Third
|
|
1556
|
+
"Third-party integration detected that may cause access codes to fail."
|
|
1551
1557
|
);
|
|
1552
1558
|
var igloo_algopin_must_be_used_within_24_hours = common_access_code_warning.extend({
|
|
1553
1559
|
warning_code: zod.z.literal("igloo_algopin_must_be_used_within_24_hours").describe(warning_code_description3)
|
|
@@ -1557,7 +1563,7 @@ var management_transferred = common_access_code_warning.extend({
|
|
|
1557
1563
|
}).describe("Management was transferred to another workspace.");
|
|
1558
1564
|
var kwikset_unable_to_confirm_code_warning = common_access_code_warning.extend({
|
|
1559
1565
|
warning_code: zod.z.literal("kwikset_unable_to_confirm_code").describe(warning_code_description3)
|
|
1560
|
-
}).describe("Unable to confirm the access code is set on Kwikset device.");
|
|
1566
|
+
}).describe("Unable to confirm that the access code is set on Kwikset device.");
|
|
1561
1567
|
var access_code_warning = zod.z.discriminatedUnion("warning_code", [
|
|
1562
1568
|
smartthings_failed_to_set_access_code_warning,
|
|
1563
1569
|
schlage_detected_duplicate,
|
|
@@ -1571,7 +1577,9 @@ var access_code_warning = zod.z.discriminatedUnion("warning_code", [
|
|
|
1571
1577
|
igloo_algopin_must_be_used_within_24_hours,
|
|
1572
1578
|
management_transferred,
|
|
1573
1579
|
kwikset_unable_to_confirm_code_warning
|
|
1574
|
-
])
|
|
1580
|
+
]).describe(
|
|
1581
|
+
"Warnings associated with the [access code](https://docs.seam.co/latest/capability-guides/smart-locks/access-codes)."
|
|
1582
|
+
);
|
|
1575
1583
|
zod.z.object({
|
|
1576
1584
|
smartthings_failed_to_set_access_code: smartthings_failed_to_set_access_code_warning.optional().nullable(),
|
|
1577
1585
|
schlage_detected_duplicate: schlage_detected_duplicate.optional().nullable(),
|
|
@@ -1594,7 +1602,7 @@ var access_code = zod.z.object({
|
|
|
1594
1602
|
"Indicates whether the code is set on the device according to a preconfigured schedule."
|
|
1595
1603
|
),
|
|
1596
1604
|
type: zod.z.enum(["time_bound", "ongoing"]).describe(
|
|
1597
|
-
|
|
1605
|
+
"Nature of the access code. Values are `ongoing` for access codes that are active continuously until deactivated manually or `time_bound` for access codes that have a specific duration."
|
|
1598
1606
|
),
|
|
1599
1607
|
is_waiting_for_code_assignment: zod.z.boolean().optional().describe(
|
|
1600
1608
|
"Indicates whether the access code is waiting for a code assignment."
|
|
@@ -1616,10 +1624,10 @@ var access_code = zod.z.object({
|
|
|
1616
1624
|
...device_and_connected_account_error_options
|
|
1617
1625
|
])
|
|
1618
1626
|
).describe(
|
|
1619
|
-
|
|
1627
|
+
"Errors associated with the [access code](https://docs.seam.co/latest/capability-guides/smart-locks/access-codes)."
|
|
1620
1628
|
),
|
|
1621
1629
|
warnings: zod.z.array(access_code_warning).describe(
|
|
1622
|
-
|
|
1630
|
+
"Warnings associated with the [access code](https://docs.seam.co/latest/capability-guides/smart-locks/access-codes)."
|
|
1623
1631
|
),
|
|
1624
1632
|
is_managed: zod.z.literal(true).describe("Indicates whether Seam manages the access code."),
|
|
1625
1633
|
starts_at: zod.z.string().datetime().nullable().optional().describe(
|
|
@@ -1628,9 +1636,9 @@ var access_code = zod.z.object({
|
|
|
1628
1636
|
ends_at: zod.z.string().datetime().nullable().optional().describe(
|
|
1629
1637
|
"Date and time after which the time-bound access code becomes inactive."
|
|
1630
1638
|
),
|
|
1631
|
-
status: zod.z.enum(["setting", "set", "unset", "removing", "unknown"]).describe(
|
|
1632
|
-
Current status of the access code within the operational lifecycle. Values are
|
|
1633
|
-
|
|
1639
|
+
status: zod.z.enum(["setting", "set", "unset", "removing", "unknown"]).describe(
|
|
1640
|
+
"Current status of the access code within the operational lifecycle. Values are `setting`, a transitional phase that indicates that the code is being configured or activated; `set`, which indicates that the code is active and operational; `unset`, which indicates a deactivated or unused state, either before activation or after deliberate deactivation; `removing`, which indicates a transitional period in which the code is being deleted or made inactive; and `unknown`, which indicates an indeterminate state, due to reasons such as system errors or incomplete data, that highlights a potential need for system review or troubleshooting."
|
|
1641
|
+
),
|
|
1634
1642
|
is_backup_access_code_available: zod.z.boolean().describe(
|
|
1635
1643
|
"Indicates whether a backup access code is available for use if the primary access code is lost or compromised."
|
|
1636
1644
|
),
|
|
@@ -1642,15 +1650,22 @@ var access_code = zod.z.object({
|
|
|
1642
1650
|
"Indicates whether changes to the access code from external sources are permitted."
|
|
1643
1651
|
),
|
|
1644
1652
|
is_one_time_use: zod.z.boolean().describe(
|
|
1645
|
-
|
|
1653
|
+
"Indicates whether the access code can only be used once. If `true`, the code becomes invalid after the first use."
|
|
1646
1654
|
),
|
|
1647
1655
|
is_offline_access_code: zod.z.boolean().describe(
|
|
1648
|
-
|
|
1656
|
+
"Indicates whether the access code is intended for use in offline scenarios. If `true`, this code can be created on a device without a network connection."
|
|
1649
1657
|
)
|
|
1650
1658
|
}).describe(`
|
|
1651
1659
|
---
|
|
1652
1660
|
route_path: /access_codes
|
|
1653
1661
|
---
|
|
1662
|
+
Represents a smart lock [access code](https://docs.seam.co/latest/capability-guides/smart-locks/access-codes).
|
|
1663
|
+
|
|
1664
|
+
An access code is a code used for a keypad or pinpad device. Unlike physical keys, which can easily be lost or duplicated, PIN codes can be customized, tracked, and altered on the fly. Using the Seam Access Code API, you can easily generate access codes on the hundreds of door lock models with which we integrate.
|
|
1665
|
+
|
|
1666
|
+
Seam supports programming two types of access codes: [ongoing](https://docs.seam.co/latest/capability-guides/smart-locks/access-codes#ongoing-access-codes) and [time-bound](https://docs.seam.co/latest/capability-guides/smart-locks/access-codes#time-bound-access-codes). To differentiate between the two, refer to the \`type\` property of the access code. Ongoing codes display as \`ongoing\`, whereas time-bound codes are labeled \`time_bound\`.
|
|
1667
|
+
|
|
1668
|
+
In addition, for certain devices, Seam also supports [offline access codes](https://docs.seam.co/latest/capability-guides/smart-locks/access-codes#offline-access-codes). Offline access (PIN) codes are designed for door locks that might not always maintain an internet connection. For this type of access code, the device manufacturer uses encryption keys (tokens) to create server-based registries of algorithmically-generated offline PIN codes. Because the tokens remain synchronized with the managed devices, the locks do not require an active internet connection\u2014and you do not need to be near the locks\u2014to create an offline access code. Then, owners or managers can share these offline codes with users through a variety of mechanisms, such as messaging applications. That is, lock users do not need to install a smartphone application to receive an offline access code.
|
|
1654
1669
|
`);
|
|
1655
1670
|
var unmanaged_access_code = access_code.pick({
|
|
1656
1671
|
type: true,
|
|
@@ -1665,12 +1680,21 @@ var unmanaged_access_code = access_code.pick({
|
|
|
1665
1680
|
starts_at: true,
|
|
1666
1681
|
ends_at: true
|
|
1667
1682
|
}).extend({
|
|
1668
|
-
is_managed: zod.z.literal(false),
|
|
1669
|
-
status: zod.z.enum(["set"])
|
|
1683
|
+
is_managed: zod.z.literal(false).describe("Indicates that Seam does not manage the access code."),
|
|
1684
|
+
status: zod.z.enum(["set"]).describe(
|
|
1685
|
+
"Current status of the access code within the operational lifecycle. `set` indicates that the code is active and operational."
|
|
1686
|
+
)
|
|
1670
1687
|
}).describe(`
|
|
1671
1688
|
---
|
|
1672
1689
|
route_path: /access_codes/unmanaged
|
|
1673
1690
|
---
|
|
1691
|
+
Represents an [unmanaged smart lock access code](https://docs.seam.co/latest/capability-guides/smart-locks/access-codes/migrating-existing-access-codes).
|
|
1692
|
+
|
|
1693
|
+
An access code is a code used for a keypad or pinpad device. Unlike physical keys, which can easily be lost or duplicated, PIN codes can be customized, tracked, and altered on the fly.
|
|
1694
|
+
|
|
1695
|
+
When you create an access code on a device in Seam, it is created as a managed access code. Access codes that exist on a device that were not created through Seam are considered unmanaged codes. We strictly limit the operations that can be performed on unmanaged codes.
|
|
1696
|
+
|
|
1697
|
+
Prior to using Seam to manage your devices, you may have used another lock management system to manage the access codes on your devices. Where possible, we help you keep any existing access codes on devices and transition those codes to ones managed by your Seam workspace.
|
|
1674
1698
|
`);
|
|
1675
1699
|
var acs_access_group_external_type = zod.z.enum([
|
|
1676
1700
|
"pti_unit",
|
|
@@ -4201,6 +4225,7 @@ var openapi_default = {
|
|
|
4201
4225
|
components: {
|
|
4202
4226
|
schemas: {
|
|
4203
4227
|
access_code: {
|
|
4228
|
+
description: "Represents a smart lock [access code](https://docs.seam.co/latest/capability-guides/smart-locks/access-codes).\n\nAn access code is a code used for a keypad or pinpad device. Unlike physical keys, which can easily be lost or duplicated, PIN codes can be customized, tracked, and altered on the fly. Using the Seam Access Code API, you can easily generate access codes on the hundreds of door lock models with which we integrate.\n\nSeam supports programming two types of access codes: [ongoing](https://docs.seam.co/latest/capability-guides/smart-locks/access-codes#ongoing-access-codes) and [time-bound](https://docs.seam.co/latest/capability-guides/smart-locks/access-codes#time-bound-access-codes). To differentiate between the two, refer to the `type` property of the access code. Ongoing codes display as `ongoing`, whereas time-bound codes are labeled `time_bound`.\n\nIn addition, for certain devices, Seam also supports [offline access codes](https://docs.seam.co/latest/capability-guides/smart-locks/access-codes#offline-access-codes). Offline access (PIN) codes are designed for door locks that might not always maintain an internet connection. For this type of access code, the device manufacturer uses encryption keys (tokens) to create server-based registries of algorithmically-generated offline PIN codes. Because the tokens remain synchronized with the managed devices, the locks do not require an active internet connection\u2014and you do not need to be near the locks\u2014to create an offline access code. Then, owners or managers can share these offline codes with users through a variety of mechanisms, such as messaging applications. That is, lock users do not need to install a smartphone application to receive an offline access code.",
|
|
4204
4229
|
properties: {
|
|
4205
4230
|
access_code_id: {
|
|
4206
4231
|
description: "Unique identifier for the access code.",
|
|
@@ -4234,21 +4259,32 @@ var openapi_default = {
|
|
|
4234
4259
|
type: "string"
|
|
4235
4260
|
},
|
|
4236
4261
|
errors: {
|
|
4237
|
-
description:
|
|
4262
|
+
description: "Errors associated with the [access code](https://docs.seam.co/latest/capability-guides/smart-locks/access-codes).",
|
|
4238
4263
|
items: {
|
|
4239
4264
|
discriminator: { propertyName: "error_code" },
|
|
4240
4265
|
oneOf: [
|
|
4241
4266
|
{
|
|
4242
|
-
description: "Failed to set code on
|
|
4267
|
+
description: "Failed to set code on SmartThings device.",
|
|
4243
4268
|
properties: {
|
|
4244
|
-
created_at: {
|
|
4269
|
+
created_at: {
|
|
4270
|
+
description: "Date and time at which Seam created the error.",
|
|
4271
|
+
format: "date-time",
|
|
4272
|
+
type: "string"
|
|
4273
|
+
},
|
|
4245
4274
|
error_code: {
|
|
4246
4275
|
description: "Unique identifier of the type of error. Enables quick recognition and categorization of the issue.",
|
|
4247
4276
|
enum: ["smartthings_failed_to_set_access_code"],
|
|
4248
4277
|
type: "string"
|
|
4249
4278
|
},
|
|
4250
|
-
is_access_code_error: {
|
|
4251
|
-
|
|
4279
|
+
is_access_code_error: {
|
|
4280
|
+
description: "Indicates that this is an access code error.",
|
|
4281
|
+
enum: [true],
|
|
4282
|
+
type: "boolean"
|
|
4283
|
+
},
|
|
4284
|
+
message: {
|
|
4285
|
+
description: "Detailed description of the error. Provides insights into the issue and potentially how to rectify it.",
|
|
4286
|
+
type: "string"
|
|
4287
|
+
}
|
|
4252
4288
|
},
|
|
4253
4289
|
required: ["message", "is_access_code_error", "error_code"],
|
|
4254
4290
|
type: "object"
|
|
@@ -4256,7 +4292,11 @@ var openapi_default = {
|
|
|
4256
4292
|
{
|
|
4257
4293
|
description: "Failed to set code after multiple retries.",
|
|
4258
4294
|
properties: {
|
|
4259
|
-
created_at: {
|
|
4295
|
+
created_at: {
|
|
4296
|
+
description: "Date and time at which Seam created the error.",
|
|
4297
|
+
format: "date-time",
|
|
4298
|
+
type: "string"
|
|
4299
|
+
},
|
|
4260
4300
|
error_code: {
|
|
4261
4301
|
description: "Unique identifier of the type of error. Enables quick recognition and categorization of the issue.",
|
|
4262
4302
|
enum: [
|
|
@@ -4264,8 +4304,15 @@ var openapi_default = {
|
|
|
4264
4304
|
],
|
|
4265
4305
|
type: "string"
|
|
4266
4306
|
},
|
|
4267
|
-
is_access_code_error: {
|
|
4268
|
-
|
|
4307
|
+
is_access_code_error: {
|
|
4308
|
+
description: "Indicates that this is an access code error.",
|
|
4309
|
+
enum: [true],
|
|
4310
|
+
type: "boolean"
|
|
4311
|
+
},
|
|
4312
|
+
message: {
|
|
4313
|
+
description: "Detailed description of the error. Provides insights into the issue and potentially how to rectify it.",
|
|
4314
|
+
type: "string"
|
|
4315
|
+
}
|
|
4269
4316
|
},
|
|
4270
4317
|
required: ["message", "is_access_code_error", "error_code"],
|
|
4271
4318
|
type: "object"
|
|
@@ -4273,14 +4320,25 @@ var openapi_default = {
|
|
|
4273
4320
|
{
|
|
4274
4321
|
description: "No free slots available on the device.",
|
|
4275
4322
|
properties: {
|
|
4276
|
-
created_at: {
|
|
4323
|
+
created_at: {
|
|
4324
|
+
description: "Date and time at which Seam created the error.",
|
|
4325
|
+
format: "date-time",
|
|
4326
|
+
type: "string"
|
|
4327
|
+
},
|
|
4277
4328
|
error_code: {
|
|
4278
4329
|
description: "Unique identifier of the type of error. Enables quick recognition and categorization of the issue.",
|
|
4279
4330
|
enum: ["smartthings_no_free_slots_available"],
|
|
4280
4331
|
type: "string"
|
|
4281
4332
|
},
|
|
4282
|
-
is_access_code_error: {
|
|
4283
|
-
|
|
4333
|
+
is_access_code_error: {
|
|
4334
|
+
description: "Indicates that this is an access code error.",
|
|
4335
|
+
enum: [true],
|
|
4336
|
+
type: "boolean"
|
|
4337
|
+
},
|
|
4338
|
+
message: {
|
|
4339
|
+
description: "Detailed description of the error. Provides insights into the issue and potentially how to rectify it.",
|
|
4340
|
+
type: "string"
|
|
4341
|
+
}
|
|
4284
4342
|
},
|
|
4285
4343
|
required: ["message", "is_access_code_error", "error_code"],
|
|
4286
4344
|
type: "object"
|
|
@@ -4288,14 +4346,25 @@ var openapi_default = {
|
|
|
4288
4346
|
{
|
|
4289
4347
|
description: "Failed to set code on device.",
|
|
4290
4348
|
properties: {
|
|
4291
|
-
created_at: {
|
|
4349
|
+
created_at: {
|
|
4350
|
+
description: "Date and time at which Seam created the error.",
|
|
4351
|
+
format: "date-time",
|
|
4352
|
+
type: "string"
|
|
4353
|
+
},
|
|
4292
4354
|
error_code: {
|
|
4293
4355
|
description: "Unique identifier of the type of error. Enables quick recognition and categorization of the issue.",
|
|
4294
4356
|
enum: ["failed_to_set_on_device"],
|
|
4295
4357
|
type: "string"
|
|
4296
4358
|
},
|
|
4297
|
-
is_access_code_error: {
|
|
4298
|
-
|
|
4359
|
+
is_access_code_error: {
|
|
4360
|
+
description: "Indicates that this is an access code error.",
|
|
4361
|
+
enum: [true],
|
|
4362
|
+
type: "boolean"
|
|
4363
|
+
},
|
|
4364
|
+
message: {
|
|
4365
|
+
description: "Detailed description of the error. Provides insights into the issue and potentially how to rectify it.",
|
|
4366
|
+
type: "string"
|
|
4367
|
+
}
|
|
4299
4368
|
},
|
|
4300
4369
|
required: ["message", "is_access_code_error", "error_code"],
|
|
4301
4370
|
type: "object"
|
|
@@ -4303,14 +4372,25 @@ var openapi_default = {
|
|
|
4303
4372
|
{
|
|
4304
4373
|
description: "Failed to remove code from device.",
|
|
4305
4374
|
properties: {
|
|
4306
|
-
created_at: {
|
|
4375
|
+
created_at: {
|
|
4376
|
+
description: "Date and time at which Seam created the error.",
|
|
4377
|
+
format: "date-time",
|
|
4378
|
+
type: "string"
|
|
4379
|
+
},
|
|
4307
4380
|
error_code: {
|
|
4308
4381
|
description: "Unique identifier of the type of error. Enables quick recognition and categorization of the issue.",
|
|
4309
4382
|
enum: ["failed_to_remove_from_device"],
|
|
4310
4383
|
type: "string"
|
|
4311
4384
|
},
|
|
4312
|
-
is_access_code_error: {
|
|
4313
|
-
|
|
4385
|
+
is_access_code_error: {
|
|
4386
|
+
description: "Indicates that this is an access code error.",
|
|
4387
|
+
enum: [true],
|
|
4388
|
+
type: "boolean"
|
|
4389
|
+
},
|
|
4390
|
+
message: {
|
|
4391
|
+
description: "Detailed description of the error. Provides insights into the issue and potentially how to rectify it.",
|
|
4392
|
+
type: "string"
|
|
4393
|
+
}
|
|
4314
4394
|
},
|
|
4315
4395
|
required: ["message", "is_access_code_error", "error_code"],
|
|
4316
4396
|
type: "object"
|
|
@@ -4318,14 +4398,25 @@ var openapi_default = {
|
|
|
4318
4398
|
{
|
|
4319
4399
|
description: "Duplicate access code detected on device.",
|
|
4320
4400
|
properties: {
|
|
4321
|
-
created_at: {
|
|
4401
|
+
created_at: {
|
|
4402
|
+
description: "Date and time at which Seam created the error.",
|
|
4403
|
+
format: "date-time",
|
|
4404
|
+
type: "string"
|
|
4405
|
+
},
|
|
4322
4406
|
error_code: {
|
|
4323
4407
|
description: "Unique identifier of the type of error. Enables quick recognition and categorization of the issue.",
|
|
4324
4408
|
enum: ["duplicate_code_on_device"],
|
|
4325
4409
|
type: "string"
|
|
4326
4410
|
},
|
|
4327
|
-
is_access_code_error: {
|
|
4328
|
-
|
|
4411
|
+
is_access_code_error: {
|
|
4412
|
+
description: "Indicates that this is an access code error.",
|
|
4413
|
+
enum: [true],
|
|
4414
|
+
type: "boolean"
|
|
4415
|
+
},
|
|
4416
|
+
message: {
|
|
4417
|
+
description: "Detailed description of the error. Provides insights into the issue and potentially how to rectify it.",
|
|
4418
|
+
type: "string"
|
|
4419
|
+
}
|
|
4329
4420
|
},
|
|
4330
4421
|
required: ["message", "is_access_code_error", "error_code"],
|
|
4331
4422
|
type: "object"
|
|
@@ -4333,14 +4424,25 @@ var openapi_default = {
|
|
|
4333
4424
|
{
|
|
4334
4425
|
description: "An attempt to modify this access code was prevented.",
|
|
4335
4426
|
properties: {
|
|
4336
|
-
created_at: {
|
|
4427
|
+
created_at: {
|
|
4428
|
+
description: "Date and time at which Seam created the error.",
|
|
4429
|
+
format: "date-time",
|
|
4430
|
+
type: "string"
|
|
4431
|
+
},
|
|
4337
4432
|
error_code: {
|
|
4338
4433
|
description: "Unique identifier of the type of error. Enables quick recognition and categorization of the issue.",
|
|
4339
4434
|
enum: ["duplicate_code_attempt_prevented"],
|
|
4340
4435
|
type: "string"
|
|
4341
4436
|
},
|
|
4342
|
-
is_access_code_error: {
|
|
4343
|
-
|
|
4437
|
+
is_access_code_error: {
|
|
4438
|
+
description: "Indicates that this is an access code error.",
|
|
4439
|
+
enum: [true],
|
|
4440
|
+
type: "boolean"
|
|
4441
|
+
},
|
|
4442
|
+
message: {
|
|
4443
|
+
description: "Detailed description of the error. Provides insights into the issue and potentially how to rectify it.",
|
|
4444
|
+
type: "string"
|
|
4445
|
+
}
|
|
4344
4446
|
},
|
|
4345
4447
|
required: ["message", "is_access_code_error", "error_code"],
|
|
4346
4448
|
type: "object"
|
|
@@ -4348,14 +4450,25 @@ var openapi_default = {
|
|
|
4348
4450
|
{
|
|
4349
4451
|
description: "Igloohome bridge has too many pending jobs in the queue.",
|
|
4350
4452
|
properties: {
|
|
4351
|
-
created_at: {
|
|
4453
|
+
created_at: {
|
|
4454
|
+
description: "Date and time at which Seam created the error.",
|
|
4455
|
+
format: "date-time",
|
|
4456
|
+
type: "string"
|
|
4457
|
+
},
|
|
4352
4458
|
error_code: {
|
|
4353
4459
|
description: "Unique identifier of the type of error. Enables quick recognition and categorization of the issue.",
|
|
4354
4460
|
enum: ["igloohome_bridge_too_many_pending_jobs"],
|
|
4355
4461
|
type: "string"
|
|
4356
4462
|
},
|
|
4357
|
-
is_access_code_error: {
|
|
4358
|
-
|
|
4463
|
+
is_access_code_error: {
|
|
4464
|
+
description: "Indicates that this is an access code error.",
|
|
4465
|
+
enum: [true],
|
|
4466
|
+
type: "boolean"
|
|
4467
|
+
},
|
|
4468
|
+
message: {
|
|
4469
|
+
description: "Detailed description of the error. Provides insights into the issue and potentially how to rectify it.",
|
|
4470
|
+
type: "string"
|
|
4471
|
+
}
|
|
4359
4472
|
},
|
|
4360
4473
|
required: ["message", "is_access_code_error", "error_code"],
|
|
4361
4474
|
type: "object"
|
|
@@ -4363,22 +4476,37 @@ var openapi_default = {
|
|
|
4363
4476
|
{
|
|
4364
4477
|
description: "Igloohome bridge is offline.",
|
|
4365
4478
|
properties: {
|
|
4366
|
-
created_at: {
|
|
4479
|
+
created_at: {
|
|
4480
|
+
description: "Date and time at which Seam created the error.",
|
|
4481
|
+
format: "date-time",
|
|
4482
|
+
type: "string"
|
|
4483
|
+
},
|
|
4367
4484
|
error_code: {
|
|
4368
4485
|
description: "Unique identifier of the type of error. Enables quick recognition and categorization of the issue.",
|
|
4369
4486
|
enum: ["igloohome_bridge_offline"],
|
|
4370
4487
|
type: "string"
|
|
4371
4488
|
},
|
|
4372
|
-
is_access_code_error: {
|
|
4373
|
-
|
|
4489
|
+
is_access_code_error: {
|
|
4490
|
+
description: "Indicates that this is an access code error.",
|
|
4491
|
+
enum: [true],
|
|
4492
|
+
type: "boolean"
|
|
4493
|
+
},
|
|
4494
|
+
message: {
|
|
4495
|
+
description: "Detailed description of the error. Provides insights into the issue and potentially how to rectify it.",
|
|
4496
|
+
type: "string"
|
|
4497
|
+
}
|
|
4374
4498
|
},
|
|
4375
4499
|
required: ["message", "is_access_code_error", "error_code"],
|
|
4376
4500
|
type: "object"
|
|
4377
4501
|
},
|
|
4378
4502
|
{
|
|
4379
|
-
description: "Lock
|
|
4503
|
+
description: "Lock has reached maximum amount of codes.",
|
|
4380
4504
|
properties: {
|
|
4381
|
-
created_at: {
|
|
4505
|
+
created_at: {
|
|
4506
|
+
description: "Date and time at which Seam created the error.",
|
|
4507
|
+
format: "date-time",
|
|
4508
|
+
type: "string"
|
|
4509
|
+
},
|
|
4382
4510
|
error_code: {
|
|
4383
4511
|
description: "Unique identifier of the type of error. Enables quick recognition and categorization of the issue.",
|
|
4384
4512
|
enum: [
|
|
@@ -4386,23 +4514,41 @@ var openapi_default = {
|
|
|
4386
4514
|
],
|
|
4387
4515
|
type: "string"
|
|
4388
4516
|
},
|
|
4389
|
-
is_access_code_error: {
|
|
4390
|
-
|
|
4517
|
+
is_access_code_error: {
|
|
4518
|
+
description: "Indicates that this is an access code error.",
|
|
4519
|
+
enum: [true],
|
|
4520
|
+
type: "boolean"
|
|
4521
|
+
},
|
|
4522
|
+
message: {
|
|
4523
|
+
description: "Detailed description of the error. Provides insights into the issue and potentially how to rectify it.",
|
|
4524
|
+
type: "string"
|
|
4525
|
+
}
|
|
4391
4526
|
},
|
|
4392
4527
|
required: ["message", "is_access_code_error", "error_code"],
|
|
4393
4528
|
type: "object"
|
|
4394
4529
|
},
|
|
4395
4530
|
{
|
|
4396
|
-
description: "Unable to confirm the access code is set on Kwikset device.",
|
|
4531
|
+
description: "Unable to confirm that the access code is set on Kwikset device.",
|
|
4397
4532
|
properties: {
|
|
4398
|
-
created_at: {
|
|
4533
|
+
created_at: {
|
|
4534
|
+
description: "Date and time at which Seam created the error.",
|
|
4535
|
+
format: "date-time",
|
|
4536
|
+
type: "string"
|
|
4537
|
+
},
|
|
4399
4538
|
error_code: {
|
|
4400
4539
|
description: "Unique identifier of the type of error. Enables quick recognition and categorization of the issue.",
|
|
4401
4540
|
enum: ["kwikset_unable_to_confirm_code"],
|
|
4402
4541
|
type: "string"
|
|
4403
4542
|
},
|
|
4404
|
-
is_access_code_error: {
|
|
4405
|
-
|
|
4543
|
+
is_access_code_error: {
|
|
4544
|
+
description: "Indicates that this is an access code error.",
|
|
4545
|
+
enum: [true],
|
|
4546
|
+
type: "boolean"
|
|
4547
|
+
},
|
|
4548
|
+
message: {
|
|
4549
|
+
description: "Detailed description of the error. Provides insights into the issue and potentially how to rectify it.",
|
|
4550
|
+
type: "string"
|
|
4551
|
+
}
|
|
4406
4552
|
},
|
|
4407
4553
|
required: ["message", "is_access_code_error", "error_code"],
|
|
4408
4554
|
type: "object"
|
|
@@ -4410,14 +4556,25 @@ var openapi_default = {
|
|
|
4410
4556
|
{
|
|
4411
4557
|
description: "Unable to confirm the deletion of the access code on Kwikset device.",
|
|
4412
4558
|
properties: {
|
|
4413
|
-
created_at: {
|
|
4559
|
+
created_at: {
|
|
4560
|
+
description: "Date and time at which Seam created the error.",
|
|
4561
|
+
format: "date-time",
|
|
4562
|
+
type: "string"
|
|
4563
|
+
},
|
|
4414
4564
|
error_code: {
|
|
4415
4565
|
description: "Unique identifier of the type of error. Enables quick recognition and categorization of the issue.",
|
|
4416
4566
|
enum: ["kwikset_unable_to_confirm_deletion"],
|
|
4417
4567
|
type: "string"
|
|
4418
4568
|
},
|
|
4419
|
-
is_access_code_error: {
|
|
4420
|
-
|
|
4569
|
+
is_access_code_error: {
|
|
4570
|
+
description: "Indicates that this is an access code error.",
|
|
4571
|
+
enum: [true],
|
|
4572
|
+
type: "boolean"
|
|
4573
|
+
},
|
|
4574
|
+
message: {
|
|
4575
|
+
description: "Detailed description of the error. Provides insights into the issue and potentially how to rectify it.",
|
|
4576
|
+
type: "string"
|
|
4577
|
+
}
|
|
4421
4578
|
},
|
|
4422
4579
|
required: ["message", "is_access_code_error", "error_code"],
|
|
4423
4580
|
type: "object"
|
|
@@ -4425,14 +4582,25 @@ var openapi_default = {
|
|
|
4425
4582
|
{
|
|
4426
4583
|
description: "Code was modified or removed externally after Seam successfully set it on the device.",
|
|
4427
4584
|
properties: {
|
|
4428
|
-
created_at: {
|
|
4585
|
+
created_at: {
|
|
4586
|
+
description: "Date and time at which Seam created the error.",
|
|
4587
|
+
format: "date-time",
|
|
4588
|
+
type: "string"
|
|
4589
|
+
},
|
|
4429
4590
|
error_code: {
|
|
4430
4591
|
description: "Unique identifier of the type of error. Enables quick recognition and categorization of the issue.",
|
|
4431
4592
|
enum: ["code_modified_external_to_seam"],
|
|
4432
4593
|
type: "string"
|
|
4433
4594
|
},
|
|
4434
|
-
is_access_code_error: {
|
|
4435
|
-
|
|
4595
|
+
is_access_code_error: {
|
|
4596
|
+
description: "Indicates that this is an access code error.",
|
|
4597
|
+
enum: [true],
|
|
4598
|
+
type: "boolean"
|
|
4599
|
+
},
|
|
4600
|
+
message: {
|
|
4601
|
+
description: "Detailed description of the error. Provides insights into the issue and potentially how to rectify it.",
|
|
4602
|
+
type: "string"
|
|
4603
|
+
}
|
|
4436
4604
|
},
|
|
4437
4605
|
required: ["message", "is_access_code_error", "error_code"],
|
|
4438
4606
|
type: "object"
|
|
@@ -4440,14 +4608,25 @@ var openapi_default = {
|
|
|
4440
4608
|
{
|
|
4441
4609
|
description: "Invalid code length for August lock.",
|
|
4442
4610
|
properties: {
|
|
4443
|
-
created_at: {
|
|
4611
|
+
created_at: {
|
|
4612
|
+
description: "Date and time at which Seam created the error.",
|
|
4613
|
+
format: "date-time",
|
|
4614
|
+
type: "string"
|
|
4615
|
+
},
|
|
4444
4616
|
error_code: {
|
|
4445
4617
|
description: "Unique identifier of the type of error. Enables quick recognition and categorization of the issue.",
|
|
4446
4618
|
enum: ["august_lock_invalid_code_length"],
|
|
4447
4619
|
type: "string"
|
|
4448
4620
|
},
|
|
4449
|
-
is_access_code_error: {
|
|
4450
|
-
|
|
4621
|
+
is_access_code_error: {
|
|
4622
|
+
description: "Indicates that this is an access code error.",
|
|
4623
|
+
enum: [true],
|
|
4624
|
+
type: "boolean"
|
|
4625
|
+
},
|
|
4626
|
+
message: {
|
|
4627
|
+
description: "Detailed description of the error. Provides insights into the issue and potentially how to rectify it.",
|
|
4628
|
+
type: "string"
|
|
4629
|
+
}
|
|
4451
4630
|
},
|
|
4452
4631
|
required: ["message", "is_access_code_error", "error_code"],
|
|
4453
4632
|
type: "object"
|
|
@@ -4455,14 +4634,25 @@ var openapi_default = {
|
|
|
4455
4634
|
{
|
|
4456
4635
|
description: "Access code has not yet been fully moved to the device.",
|
|
4457
4636
|
properties: {
|
|
4458
|
-
created_at: {
|
|
4637
|
+
created_at: {
|
|
4638
|
+
description: "Date and time at which Seam created the error.",
|
|
4639
|
+
format: "date-time",
|
|
4640
|
+
type: "string"
|
|
4641
|
+
},
|
|
4459
4642
|
error_code: {
|
|
4460
4643
|
description: "Unique identifier of the type of error. Enables quick recognition and categorization of the issue.",
|
|
4461
4644
|
enum: ["august_device_programming_delay"],
|
|
4462
4645
|
type: "string"
|
|
4463
4646
|
},
|
|
4464
|
-
is_access_code_error: {
|
|
4465
|
-
|
|
4647
|
+
is_access_code_error: {
|
|
4648
|
+
description: "Indicates that this is an access code error.",
|
|
4649
|
+
enum: [true],
|
|
4650
|
+
type: "boolean"
|
|
4651
|
+
},
|
|
4652
|
+
message: {
|
|
4653
|
+
description: "Detailed description of the error. Provides insights into the issue and potentially how to rectify it.",
|
|
4654
|
+
type: "string"
|
|
4655
|
+
}
|
|
4466
4656
|
},
|
|
4467
4657
|
required: ["message", "is_access_code_error", "error_code"],
|
|
4468
4658
|
type: "object"
|
|
@@ -4470,14 +4660,25 @@ var openapi_default = {
|
|
|
4470
4660
|
{
|
|
4471
4661
|
description: "All access code slots on the device are full.",
|
|
4472
4662
|
properties: {
|
|
4473
|
-
created_at: {
|
|
4663
|
+
created_at: {
|
|
4664
|
+
description: "Date and time at which Seam created the error.",
|
|
4665
|
+
format: "date-time",
|
|
4666
|
+
type: "string"
|
|
4667
|
+
},
|
|
4474
4668
|
error_code: {
|
|
4475
4669
|
description: "Unique identifier of the type of error. Enables quick recognition and categorization of the issue.",
|
|
4476
4670
|
enum: ["august_device_slots_full"],
|
|
4477
4671
|
type: "string"
|
|
4478
4672
|
},
|
|
4479
|
-
is_access_code_error: {
|
|
4480
|
-
|
|
4673
|
+
is_access_code_error: {
|
|
4674
|
+
description: "Indicates that this is an access code error.",
|
|
4675
|
+
enum: [true],
|
|
4676
|
+
type: "boolean"
|
|
4677
|
+
},
|
|
4678
|
+
message: {
|
|
4679
|
+
description: "Detailed description of the error. Provides insights into the issue and potentially how to rectify it.",
|
|
4680
|
+
type: "string"
|
|
4681
|
+
}
|
|
4481
4682
|
},
|
|
4482
4683
|
required: ["message", "is_access_code_error", "error_code"],
|
|
4483
4684
|
type: "object"
|
|
@@ -4485,29 +4686,51 @@ var openapi_default = {
|
|
|
4485
4686
|
{
|
|
4486
4687
|
description: "August lock is missing a keypad.",
|
|
4487
4688
|
properties: {
|
|
4488
|
-
created_at: {
|
|
4689
|
+
created_at: {
|
|
4690
|
+
description: "Date and time at which Seam created the error.",
|
|
4691
|
+
format: "date-time",
|
|
4692
|
+
type: "string"
|
|
4693
|
+
},
|
|
4489
4694
|
error_code: {
|
|
4490
4695
|
description: "Unique identifier of the type of error. Enables quick recognition and categorization of the issue.",
|
|
4491
4696
|
enum: ["august_lock_missing_keypad"],
|
|
4492
4697
|
type: "string"
|
|
4493
4698
|
},
|
|
4494
|
-
is_access_code_error: {
|
|
4495
|
-
|
|
4496
|
-
|
|
4699
|
+
is_access_code_error: {
|
|
4700
|
+
description: "Indicates that this is an access code error.",
|
|
4701
|
+
enum: [true],
|
|
4702
|
+
type: "boolean"
|
|
4703
|
+
},
|
|
4704
|
+
message: {
|
|
4705
|
+
description: "Detailed description of the error. Provides insights into the issue and potentially how to rectify it.",
|
|
4706
|
+
type: "string"
|
|
4707
|
+
}
|
|
4708
|
+
},
|
|
4497
4709
|
required: ["message", "is_access_code_error", "error_code"],
|
|
4498
4710
|
type: "object"
|
|
4499
4711
|
},
|
|
4500
4712
|
{
|
|
4501
4713
|
description: "August lock is temporarily offline.",
|
|
4502
4714
|
properties: {
|
|
4503
|
-
created_at: {
|
|
4715
|
+
created_at: {
|
|
4716
|
+
description: "Date and time at which Seam created the error.",
|
|
4717
|
+
format: "date-time",
|
|
4718
|
+
type: "string"
|
|
4719
|
+
},
|
|
4504
4720
|
error_code: {
|
|
4505
4721
|
description: "Unique identifier of the type of error. Enables quick recognition and categorization of the issue.",
|
|
4506
4722
|
enum: ["august_lock_temporarily_offline"],
|
|
4507
4723
|
type: "string"
|
|
4508
4724
|
},
|
|
4509
|
-
is_access_code_error: {
|
|
4510
|
-
|
|
4725
|
+
is_access_code_error: {
|
|
4726
|
+
description: "Indicates that this is an access code error.",
|
|
4727
|
+
enum: [true],
|
|
4728
|
+
type: "boolean"
|
|
4729
|
+
},
|
|
4730
|
+
message: {
|
|
4731
|
+
description: "Detailed description of the error. Provides insights into the issue and potentially how to rectify it.",
|
|
4732
|
+
type: "string"
|
|
4733
|
+
}
|
|
4511
4734
|
},
|
|
4512
4735
|
required: ["message", "is_access_code_error", "error_code"],
|
|
4513
4736
|
type: "object"
|
|
@@ -4515,14 +4738,25 @@ var openapi_default = {
|
|
|
4515
4738
|
{
|
|
4516
4739
|
description: "Salto site user is not subscribed.",
|
|
4517
4740
|
properties: {
|
|
4518
|
-
created_at: {
|
|
4741
|
+
created_at: {
|
|
4742
|
+
description: "Date and time at which Seam created the error.",
|
|
4743
|
+
format: "date-time",
|
|
4744
|
+
type: "string"
|
|
4745
|
+
},
|
|
4519
4746
|
error_code: {
|
|
4520
4747
|
description: "Unique identifier of the type of error. Enables quick recognition and categorization of the issue.",
|
|
4521
4748
|
enum: ["salto_ks_user_not_subscribed"],
|
|
4522
4749
|
type: "string"
|
|
4523
4750
|
},
|
|
4524
|
-
is_access_code_error: {
|
|
4525
|
-
|
|
4751
|
+
is_access_code_error: {
|
|
4752
|
+
description: "Indicates that this is an access code error.",
|
|
4753
|
+
enum: [true],
|
|
4754
|
+
type: "boolean"
|
|
4755
|
+
},
|
|
4756
|
+
message: {
|
|
4757
|
+
description: "Detailed description of the error. Provides insights into the issue and potentially how to rectify it.",
|
|
4758
|
+
type: "string"
|
|
4759
|
+
}
|
|
4526
4760
|
},
|
|
4527
4761
|
required: ["message", "is_access_code_error", "error_code"],
|
|
4528
4762
|
type: "object"
|
|
@@ -4530,14 +4764,25 @@ var openapi_default = {
|
|
|
4530
4764
|
{
|
|
4531
4765
|
description: "Access code has not yet been fully moved to the device.",
|
|
4532
4766
|
properties: {
|
|
4533
|
-
created_at: {
|
|
4767
|
+
created_at: {
|
|
4768
|
+
description: "Date and time at which Seam created the error.",
|
|
4769
|
+
format: "date-time",
|
|
4770
|
+
type: "string"
|
|
4771
|
+
},
|
|
4534
4772
|
error_code: {
|
|
4535
4773
|
description: "Unique identifier of the type of error. Enables quick recognition and categorization of the issue.",
|
|
4536
4774
|
enum: ["hubitat_device_programming_delay"],
|
|
4537
4775
|
type: "string"
|
|
4538
4776
|
},
|
|
4539
|
-
is_access_code_error: {
|
|
4540
|
-
|
|
4777
|
+
is_access_code_error: {
|
|
4778
|
+
description: "Indicates that this is an access code error.",
|
|
4779
|
+
enum: [true],
|
|
4780
|
+
type: "boolean"
|
|
4781
|
+
},
|
|
4782
|
+
message: {
|
|
4783
|
+
description: "Detailed description of the error. Provides insights into the issue and potentially how to rectify it.",
|
|
4784
|
+
type: "string"
|
|
4785
|
+
}
|
|
4541
4786
|
},
|
|
4542
4787
|
required: ["message", "is_access_code_error", "error_code"],
|
|
4543
4788
|
type: "object"
|
|
@@ -4545,14 +4790,25 @@ var openapi_default = {
|
|
|
4545
4790
|
{
|
|
4546
4791
|
description: "No free positions available on the device.",
|
|
4547
4792
|
properties: {
|
|
4548
|
-
created_at: {
|
|
4793
|
+
created_at: {
|
|
4794
|
+
description: "Date and time at which Seam created the error.",
|
|
4795
|
+
format: "date-time",
|
|
4796
|
+
type: "string"
|
|
4797
|
+
},
|
|
4549
4798
|
error_code: {
|
|
4550
4799
|
description: "Unique identifier of the type of error. Enables quick recognition and categorization of the issue.",
|
|
4551
4800
|
enum: ["hubitat_no_free_positions_available"],
|
|
4552
4801
|
type: "string"
|
|
4553
4802
|
},
|
|
4554
|
-
is_access_code_error: {
|
|
4555
|
-
|
|
4803
|
+
is_access_code_error: {
|
|
4804
|
+
description: "Indicates that this is an access code error.",
|
|
4805
|
+
enum: [true],
|
|
4806
|
+
type: "boolean"
|
|
4807
|
+
},
|
|
4808
|
+
message: {
|
|
4809
|
+
description: "Detailed description of the error. Provides insights into the issue and potentially how to rectify it.",
|
|
4810
|
+
type: "string"
|
|
4811
|
+
}
|
|
4556
4812
|
},
|
|
4557
4813
|
required: ["message", "is_access_code_error", "error_code"],
|
|
4558
4814
|
type: "object"
|
|
@@ -4560,14 +4816,25 @@ var openapi_default = {
|
|
|
4560
4816
|
{
|
|
4561
4817
|
description: "Duplicate access code name detected.",
|
|
4562
4818
|
properties: {
|
|
4563
|
-
created_at: {
|
|
4819
|
+
created_at: {
|
|
4820
|
+
description: "Date and time at which Seam created the error.",
|
|
4821
|
+
format: "date-time",
|
|
4822
|
+
type: "string"
|
|
4823
|
+
},
|
|
4564
4824
|
error_code: {
|
|
4565
4825
|
description: "Unique identifier of the type of error. Enables quick recognition and categorization of the issue.",
|
|
4566
4826
|
enum: ["wyze_duplicate_code_name"],
|
|
4567
4827
|
type: "string"
|
|
4568
4828
|
},
|
|
4569
|
-
is_access_code_error: {
|
|
4570
|
-
|
|
4829
|
+
is_access_code_error: {
|
|
4830
|
+
description: "Indicates that this is an access code error.",
|
|
4831
|
+
enum: [true],
|
|
4832
|
+
type: "boolean"
|
|
4833
|
+
},
|
|
4834
|
+
message: {
|
|
4835
|
+
description: "Detailed description of the error. Provides insights into the issue and potentially how to rectify it.",
|
|
4836
|
+
type: "string"
|
|
4837
|
+
}
|
|
4571
4838
|
},
|
|
4572
4839
|
required: ["message", "is_access_code_error", "error_code"],
|
|
4573
4840
|
type: "object"
|
|
@@ -4575,14 +4842,25 @@ var openapi_default = {
|
|
|
4575
4842
|
{
|
|
4576
4843
|
description: "Potential duplicate access code detected.",
|
|
4577
4844
|
properties: {
|
|
4578
|
-
created_at: {
|
|
4845
|
+
created_at: {
|
|
4846
|
+
description: "Date and time at which Seam created the error.",
|
|
4847
|
+
format: "date-time",
|
|
4848
|
+
type: "string"
|
|
4849
|
+
},
|
|
4579
4850
|
error_code: {
|
|
4580
4851
|
description: "Unique identifier of the type of error. Enables quick recognition and categorization of the issue.",
|
|
4581
4852
|
enum: ["wyze_potential_duplicate_code"],
|
|
4582
4853
|
type: "string"
|
|
4583
4854
|
},
|
|
4584
|
-
is_access_code_error: {
|
|
4585
|
-
|
|
4855
|
+
is_access_code_error: {
|
|
4856
|
+
description: "Indicates that this is an access code error.",
|
|
4857
|
+
enum: [true],
|
|
4858
|
+
type: "boolean"
|
|
4859
|
+
},
|
|
4860
|
+
message: {
|
|
4861
|
+
description: "Detailed description of the error. Provides insights into the issue and potentially how to rectify it.",
|
|
4862
|
+
type: "string"
|
|
4863
|
+
}
|
|
4586
4864
|
},
|
|
4587
4865
|
required: ["message", "is_access_code_error", "error_code"],
|
|
4588
4866
|
type: "object"
|
|
@@ -4590,14 +4868,25 @@ var openapi_default = {
|
|
|
4590
4868
|
{
|
|
4591
4869
|
description: "No valid user level for Oracode.",
|
|
4592
4870
|
properties: {
|
|
4593
|
-
created_at: {
|
|
4871
|
+
created_at: {
|
|
4872
|
+
description: "Date and time at which Seam created the error.",
|
|
4873
|
+
format: "date-time",
|
|
4874
|
+
type: "string"
|
|
4875
|
+
},
|
|
4594
4876
|
error_code: {
|
|
4595
4877
|
description: "Unique identifier of the type of error. Enables quick recognition and categorization of the issue.",
|
|
4596
4878
|
enum: ["dormakaba_oracode_no_valid_user_level"],
|
|
4597
4879
|
type: "string"
|
|
4598
4880
|
},
|
|
4599
|
-
is_access_code_error: {
|
|
4600
|
-
|
|
4881
|
+
is_access_code_error: {
|
|
4882
|
+
description: "Indicates that this is an access code error.",
|
|
4883
|
+
enum: [true],
|
|
4884
|
+
type: "boolean"
|
|
4885
|
+
},
|
|
4886
|
+
message: {
|
|
4887
|
+
description: "Detailed description of the error. Provides insights into the issue and potentially how to rectify it.",
|
|
4888
|
+
type: "string"
|
|
4889
|
+
}
|
|
4601
4890
|
},
|
|
4602
4891
|
required: ["message", "is_access_code_error", "error_code"],
|
|
4603
4892
|
type: "object"
|
|
@@ -4934,11 +5223,11 @@ var openapi_default = {
|
|
|
4934
5223
|
type: "boolean"
|
|
4935
5224
|
},
|
|
4936
5225
|
is_offline_access_code: {
|
|
4937
|
-
description:
|
|
5226
|
+
description: "Indicates whether the access code is intended for use in offline scenarios. If `true`, this code can be created on a device without a network connection.",
|
|
4938
5227
|
type: "boolean"
|
|
4939
5228
|
},
|
|
4940
5229
|
is_one_time_use: {
|
|
4941
|
-
description:
|
|
5230
|
+
description: "Indicates whether the access code can only be used once. If `true`, the code becomes invalid after the first use.",
|
|
4942
5231
|
type: "boolean"
|
|
4943
5232
|
},
|
|
4944
5233
|
is_scheduled_on_device: {
|
|
@@ -4967,25 +5256,33 @@ var openapi_default = {
|
|
|
4967
5256
|
type: "string"
|
|
4968
5257
|
},
|
|
4969
5258
|
status: {
|
|
4970
|
-
description:
|
|
5259
|
+
description: "Current status of the access code within the operational lifecycle. Values are `setting`, a transitional phase that indicates that the code is being configured or activated; `set`, which indicates that the code is active and operational; `unset`, which indicates a deactivated or unused state, either before activation or after deliberate deactivation; `removing`, which indicates a transitional period in which the code is being deleted or made inactive; and `unknown`, which indicates an indeterminate state, due to reasons such as system errors or incomplete data, that highlights a potential need for system review or troubleshooting.",
|
|
4971
5260
|
enum: ["setting", "set", "unset", "removing", "unknown"],
|
|
4972
5261
|
type: "string"
|
|
4973
5262
|
},
|
|
4974
5263
|
type: {
|
|
4975
|
-
description:
|
|
5264
|
+
description: "Nature of the access code. Values are `ongoing` for access codes that are active continuously until deactivated manually or `time_bound` for access codes that have a specific duration.",
|
|
4976
5265
|
enum: ["time_bound", "ongoing"],
|
|
4977
5266
|
type: "string"
|
|
4978
5267
|
},
|
|
4979
5268
|
warnings: {
|
|
4980
|
-
description:
|
|
5269
|
+
description: "Warnings associated with the [access code](https://docs.seam.co/latest/capability-guides/smart-locks/access-codes).",
|
|
4981
5270
|
items: {
|
|
5271
|
+
description: "Warnings associated with the [access code](https://docs.seam.co/latest/capability-guides/smart-locks/access-codes).",
|
|
4982
5272
|
discriminator: { propertyName: "warning_code" },
|
|
4983
5273
|
oneOf: [
|
|
4984
5274
|
{
|
|
4985
|
-
description: "Failed to set code on
|
|
5275
|
+
description: "Failed to set code on SmartThings device.",
|
|
4986
5276
|
properties: {
|
|
4987
|
-
created_at: {
|
|
4988
|
-
|
|
5277
|
+
created_at: {
|
|
5278
|
+
description: "Date and time at which Seam created the warning.",
|
|
5279
|
+
format: "date-time",
|
|
5280
|
+
type: "string"
|
|
5281
|
+
},
|
|
5282
|
+
message: {
|
|
5283
|
+
description: "Detailed description of the warning. Provides insights into the issue and potentially how to rectify it.",
|
|
5284
|
+
type: "string"
|
|
5285
|
+
},
|
|
4989
5286
|
warning_code: {
|
|
4990
5287
|
description: "Unique identifier of the type of warning. Enables quick recognition and categorization of the issue.",
|
|
4991
5288
|
enum: ["smartthings_failed_to_set_access_code"],
|
|
@@ -4998,8 +5295,15 @@ var openapi_default = {
|
|
|
4998
5295
|
{
|
|
4999
5296
|
description: "Duplicate access code detected.",
|
|
5000
5297
|
properties: {
|
|
5001
|
-
created_at: {
|
|
5002
|
-
|
|
5298
|
+
created_at: {
|
|
5299
|
+
description: "Date and time at which Seam created the warning.",
|
|
5300
|
+
format: "date-time",
|
|
5301
|
+
type: "string"
|
|
5302
|
+
},
|
|
5303
|
+
message: {
|
|
5304
|
+
description: "Detailed description of the warning. Provides insights into the issue and potentially how to rectify it.",
|
|
5305
|
+
type: "string"
|
|
5306
|
+
},
|
|
5003
5307
|
warning_code: {
|
|
5004
5308
|
description: "Unique identifier of the type of warning. Enables quick recognition and categorization of the issue.",
|
|
5005
5309
|
enum: ["schlage_detected_duplicate"],
|
|
@@ -5012,8 +5316,15 @@ var openapi_default = {
|
|
|
5012
5316
|
{
|
|
5013
5317
|
description: "Received an error when attempting to create this code.",
|
|
5014
5318
|
properties: {
|
|
5015
|
-
created_at: {
|
|
5016
|
-
|
|
5319
|
+
created_at: {
|
|
5320
|
+
description: "Date and time at which Seam created the warning.",
|
|
5321
|
+
format: "date-time",
|
|
5322
|
+
type: "string"
|
|
5323
|
+
},
|
|
5324
|
+
message: {
|
|
5325
|
+
description: "Detailed description of the warning. Provides insights into the issue and potentially how to rectify it.",
|
|
5326
|
+
type: "string"
|
|
5327
|
+
},
|
|
5017
5328
|
warning_code: {
|
|
5018
5329
|
description: "Unique identifier of the type of warning. Enables quick recognition and categorization of the issue.",
|
|
5019
5330
|
enum: ["schlage_creation_outage"],
|
|
@@ -5026,8 +5337,15 @@ var openapi_default = {
|
|
|
5026
5337
|
{
|
|
5027
5338
|
description: "Code was modified or removed externally after Seam successfully set it on the device.",
|
|
5028
5339
|
properties: {
|
|
5029
|
-
created_at: {
|
|
5030
|
-
|
|
5340
|
+
created_at: {
|
|
5341
|
+
description: "Date and time at which Seam created the warning.",
|
|
5342
|
+
format: "date-time",
|
|
5343
|
+
type: "string"
|
|
5344
|
+
},
|
|
5345
|
+
message: {
|
|
5346
|
+
description: "Detailed description of the warning. Provides insights into the issue and potentially how to rectify it.",
|
|
5347
|
+
type: "string"
|
|
5348
|
+
},
|
|
5031
5349
|
warning_code: {
|
|
5032
5350
|
description: "Unique identifier of the type of warning. Enables quick recognition and categorization of the issue.",
|
|
5033
5351
|
enum: ["code_modified_external_to_seam"],
|
|
@@ -5040,8 +5358,15 @@ var openapi_default = {
|
|
|
5040
5358
|
{
|
|
5041
5359
|
description: "Delay in setting code on device.",
|
|
5042
5360
|
properties: {
|
|
5043
|
-
created_at: {
|
|
5044
|
-
|
|
5361
|
+
created_at: {
|
|
5362
|
+
description: "Date and time at which Seam created the warning.",
|
|
5363
|
+
format: "date-time",
|
|
5364
|
+
type: "string"
|
|
5365
|
+
},
|
|
5366
|
+
message: {
|
|
5367
|
+
description: "Detailed description of the warning. Provides insights into the issue and potentially how to rectify it.",
|
|
5368
|
+
type: "string"
|
|
5369
|
+
},
|
|
5045
5370
|
warning_code: {
|
|
5046
5371
|
description: "Unique identifier of the type of warning. Enables quick recognition and categorization of the issue.",
|
|
5047
5372
|
enum: ["delay_in_setting_on_device"],
|
|
@@ -5054,8 +5379,15 @@ var openapi_default = {
|
|
|
5054
5379
|
{
|
|
5055
5380
|
description: "Delay in removing code from device.",
|
|
5056
5381
|
properties: {
|
|
5057
|
-
created_at: {
|
|
5058
|
-
|
|
5382
|
+
created_at: {
|
|
5383
|
+
description: "Date and time at which Seam created the warning.",
|
|
5384
|
+
format: "date-time",
|
|
5385
|
+
type: "string"
|
|
5386
|
+
},
|
|
5387
|
+
message: {
|
|
5388
|
+
description: "Detailed description of the warning. Provides insights into the issue and potentially how to rectify it.",
|
|
5389
|
+
type: "string"
|
|
5390
|
+
},
|
|
5059
5391
|
warning_code: {
|
|
5060
5392
|
description: "Unique identifier of the type of warning. Enables quick recognition and categorization of the issue.",
|
|
5061
5393
|
enum: ["delay_in_removing_from_device"],
|
|
@@ -5066,10 +5398,17 @@ var openapi_default = {
|
|
|
5066
5398
|
type: "object"
|
|
5067
5399
|
},
|
|
5068
5400
|
{
|
|
5069
|
-
description: "Third
|
|
5401
|
+
description: "Third-party integration detected that may cause access codes to fail.",
|
|
5070
5402
|
properties: {
|
|
5071
|
-
created_at: {
|
|
5072
|
-
|
|
5403
|
+
created_at: {
|
|
5404
|
+
description: "Date and time at which Seam created the warning.",
|
|
5405
|
+
format: "date-time",
|
|
5406
|
+
type: "string"
|
|
5407
|
+
},
|
|
5408
|
+
message: {
|
|
5409
|
+
description: "Detailed description of the warning. Provides insights into the issue and potentially how to rectify it.",
|
|
5410
|
+
type: "string"
|
|
5411
|
+
},
|
|
5073
5412
|
warning_code: {
|
|
5074
5413
|
description: "Unique identifier of the type of warning. Enables quick recognition and categorization of the issue.",
|
|
5075
5414
|
enum: ["third_party_integration_detected"],
|
|
@@ -5082,8 +5421,15 @@ var openapi_default = {
|
|
|
5082
5421
|
{
|
|
5083
5422
|
description: "Access code has not yet been fully moved to the device.",
|
|
5084
5423
|
properties: {
|
|
5085
|
-
created_at: {
|
|
5086
|
-
|
|
5424
|
+
created_at: {
|
|
5425
|
+
description: "Date and time at which Seam created the warning.",
|
|
5426
|
+
format: "date-time",
|
|
5427
|
+
type: "string"
|
|
5428
|
+
},
|
|
5429
|
+
message: {
|
|
5430
|
+
description: "Detailed description of the warning. Provides insights into the issue and potentially how to rectify it.",
|
|
5431
|
+
type: "string"
|
|
5432
|
+
},
|
|
5087
5433
|
warning_code: {
|
|
5088
5434
|
description: "Unique identifier of the type of warning. Enables quick recognition and categorization of the issue.",
|
|
5089
5435
|
enum: ["august_device_programming_delay"],
|
|
@@ -5096,8 +5442,15 @@ var openapi_default = {
|
|
|
5096
5442
|
{
|
|
5097
5443
|
description: "August lock is temporarily offline.",
|
|
5098
5444
|
properties: {
|
|
5099
|
-
created_at: {
|
|
5100
|
-
|
|
5445
|
+
created_at: {
|
|
5446
|
+
description: "Date and time at which Seam created the warning.",
|
|
5447
|
+
format: "date-time",
|
|
5448
|
+
type: "string"
|
|
5449
|
+
},
|
|
5450
|
+
message: {
|
|
5451
|
+
description: "Detailed description of the warning. Provides insights into the issue and potentially how to rectify it.",
|
|
5452
|
+
type: "string"
|
|
5453
|
+
},
|
|
5101
5454
|
warning_code: {
|
|
5102
5455
|
description: "Unique identifier of the type of error. Enables quick recognition and categorization of the issue.",
|
|
5103
5456
|
enum: ["august_lock_temporarily_offline"],
|
|
@@ -5110,8 +5463,15 @@ var openapi_default = {
|
|
|
5110
5463
|
{
|
|
5111
5464
|
description: "Algopins must be used within 24 hours.",
|
|
5112
5465
|
properties: {
|
|
5113
|
-
created_at: {
|
|
5114
|
-
|
|
5466
|
+
created_at: {
|
|
5467
|
+
description: "Date and time at which Seam created the warning.",
|
|
5468
|
+
format: "date-time",
|
|
5469
|
+
type: "string"
|
|
5470
|
+
},
|
|
5471
|
+
message: {
|
|
5472
|
+
description: "Detailed description of the warning. Provides insights into the issue and potentially how to rectify it.",
|
|
5473
|
+
type: "string"
|
|
5474
|
+
},
|
|
5115
5475
|
warning_code: {
|
|
5116
5476
|
description: "Unique identifier of the type of warning. Enables quick recognition and categorization of the issue.",
|
|
5117
5477
|
enum: ["igloo_algopin_must_be_used_within_24_hours"],
|
|
@@ -5124,8 +5484,15 @@ var openapi_default = {
|
|
|
5124
5484
|
{
|
|
5125
5485
|
description: "Management was transferred to another workspace.",
|
|
5126
5486
|
properties: {
|
|
5127
|
-
created_at: {
|
|
5128
|
-
|
|
5487
|
+
created_at: {
|
|
5488
|
+
description: "Date and time at which Seam created the warning.",
|
|
5489
|
+
format: "date-time",
|
|
5490
|
+
type: "string"
|
|
5491
|
+
},
|
|
5492
|
+
message: {
|
|
5493
|
+
description: "Detailed description of the warning. Provides insights into the issue and potentially how to rectify it.",
|
|
5494
|
+
type: "string"
|
|
5495
|
+
},
|
|
5129
5496
|
warning_code: {
|
|
5130
5497
|
description: "Unique identifier of the type of warning. Enables quick recognition and categorization of the issue.",
|
|
5131
5498
|
enum: ["management_transferred"],
|
|
@@ -5136,10 +5503,17 @@ var openapi_default = {
|
|
|
5136
5503
|
type: "object"
|
|
5137
5504
|
},
|
|
5138
5505
|
{
|
|
5139
|
-
description: "Unable to confirm the access code is set on Kwikset device.",
|
|
5506
|
+
description: "Unable to confirm that the access code is set on Kwikset device.",
|
|
5140
5507
|
properties: {
|
|
5141
|
-
created_at: {
|
|
5142
|
-
|
|
5508
|
+
created_at: {
|
|
5509
|
+
description: "Date and time at which Seam created the warning.",
|
|
5510
|
+
format: "date-time",
|
|
5511
|
+
type: "string"
|
|
5512
|
+
},
|
|
5513
|
+
message: {
|
|
5514
|
+
description: "Detailed description of the warning. Provides insights into the issue and potentially how to rectify it.",
|
|
5515
|
+
type: "string"
|
|
5516
|
+
},
|
|
5143
5517
|
warning_code: {
|
|
5144
5518
|
description: "Unique identifier of the type of warning. Enables quick recognition and categorization of the issue.",
|
|
5145
5519
|
enum: ["kwikset_unable_to_confirm_code"],
|
|
@@ -16540,6 +16914,7 @@ var openapi_default = {
|
|
|
16540
16914
|
"x-route-path": "/thermostats/schedules"
|
|
16541
16915
|
},
|
|
16542
16916
|
unmanaged_access_code: {
|
|
16917
|
+
description: "Represents an [unmanaged smart lock access code](https://docs.seam.co/latest/capability-guides/smart-locks/access-codes/migrating-existing-access-codes).\n\nAn access code is a code used for a keypad or pinpad device. Unlike physical keys, which can easily be lost or duplicated, PIN codes can be customized, tracked, and altered on the fly.\n\nWhen you create an access code on a device in Seam, it is created as a managed access code. Access codes that exist on a device that were not created through Seam are considered unmanaged codes. We strictly limit the operations that can be performed on unmanaged codes.\n\nPrior to using Seam to manage your devices, you may have used another lock management system to manage the access codes on your devices. Where possible, we help you keep any existing access codes on devices and transition those codes to ones managed by your Seam workspace.",
|
|
16543
16918
|
properties: {
|
|
16544
16919
|
access_code_id: {
|
|
16545
16920
|
description: "Unique identifier for the access code.",
|
|
@@ -16568,21 +16943,32 @@ var openapi_default = {
|
|
|
16568
16943
|
type: "string"
|
|
16569
16944
|
},
|
|
16570
16945
|
errors: {
|
|
16571
|
-
description:
|
|
16946
|
+
description: "Errors associated with the [access code](https://docs.seam.co/latest/capability-guides/smart-locks/access-codes).",
|
|
16572
16947
|
items: {
|
|
16573
16948
|
discriminator: { propertyName: "error_code" },
|
|
16574
16949
|
oneOf: [
|
|
16575
16950
|
{
|
|
16576
|
-
description: "Failed to set code on
|
|
16951
|
+
description: "Failed to set code on SmartThings device.",
|
|
16577
16952
|
properties: {
|
|
16578
|
-
created_at: {
|
|
16953
|
+
created_at: {
|
|
16954
|
+
description: "Date and time at which Seam created the error.",
|
|
16955
|
+
format: "date-time",
|
|
16956
|
+
type: "string"
|
|
16957
|
+
},
|
|
16579
16958
|
error_code: {
|
|
16580
16959
|
description: "Unique identifier of the type of error. Enables quick recognition and categorization of the issue.",
|
|
16581
16960
|
enum: ["smartthings_failed_to_set_access_code"],
|
|
16582
16961
|
type: "string"
|
|
16583
16962
|
},
|
|
16584
|
-
is_access_code_error: {
|
|
16585
|
-
|
|
16963
|
+
is_access_code_error: {
|
|
16964
|
+
description: "Indicates that this is an access code error.",
|
|
16965
|
+
enum: [true],
|
|
16966
|
+
type: "boolean"
|
|
16967
|
+
},
|
|
16968
|
+
message: {
|
|
16969
|
+
description: "Detailed description of the error. Provides insights into the issue and potentially how to rectify it.",
|
|
16970
|
+
type: "string"
|
|
16971
|
+
}
|
|
16586
16972
|
},
|
|
16587
16973
|
required: ["message", "is_access_code_error", "error_code"],
|
|
16588
16974
|
type: "object"
|
|
@@ -16590,16 +16976,27 @@ var openapi_default = {
|
|
|
16590
16976
|
{
|
|
16591
16977
|
description: "Failed to set code after multiple retries.",
|
|
16592
16978
|
properties: {
|
|
16593
|
-
created_at: {
|
|
16594
|
-
|
|
16595
|
-
|
|
16596
|
-
|
|
16979
|
+
created_at: {
|
|
16980
|
+
description: "Date and time at which Seam created the error.",
|
|
16981
|
+
format: "date-time",
|
|
16982
|
+
type: "string"
|
|
16983
|
+
},
|
|
16984
|
+
error_code: {
|
|
16985
|
+
description: "Unique identifier of the type of error. Enables quick recognition and categorization of the issue.",
|
|
16986
|
+
enum: [
|
|
16597
16987
|
"smartthings_failed_to_set_after_multiple_retries"
|
|
16598
16988
|
],
|
|
16599
16989
|
type: "string"
|
|
16600
16990
|
},
|
|
16601
|
-
is_access_code_error: {
|
|
16602
|
-
|
|
16991
|
+
is_access_code_error: {
|
|
16992
|
+
description: "Indicates that this is an access code error.",
|
|
16993
|
+
enum: [true],
|
|
16994
|
+
type: "boolean"
|
|
16995
|
+
},
|
|
16996
|
+
message: {
|
|
16997
|
+
description: "Detailed description of the error. Provides insights into the issue and potentially how to rectify it.",
|
|
16998
|
+
type: "string"
|
|
16999
|
+
}
|
|
16603
17000
|
},
|
|
16604
17001
|
required: ["message", "is_access_code_error", "error_code"],
|
|
16605
17002
|
type: "object"
|
|
@@ -16607,14 +17004,25 @@ var openapi_default = {
|
|
|
16607
17004
|
{
|
|
16608
17005
|
description: "No free slots available on the device.",
|
|
16609
17006
|
properties: {
|
|
16610
|
-
created_at: {
|
|
17007
|
+
created_at: {
|
|
17008
|
+
description: "Date and time at which Seam created the error.",
|
|
17009
|
+
format: "date-time",
|
|
17010
|
+
type: "string"
|
|
17011
|
+
},
|
|
16611
17012
|
error_code: {
|
|
16612
17013
|
description: "Unique identifier of the type of error. Enables quick recognition and categorization of the issue.",
|
|
16613
17014
|
enum: ["smartthings_no_free_slots_available"],
|
|
16614
17015
|
type: "string"
|
|
16615
17016
|
},
|
|
16616
|
-
is_access_code_error: {
|
|
16617
|
-
|
|
17017
|
+
is_access_code_error: {
|
|
17018
|
+
description: "Indicates that this is an access code error.",
|
|
17019
|
+
enum: [true],
|
|
17020
|
+
type: "boolean"
|
|
17021
|
+
},
|
|
17022
|
+
message: {
|
|
17023
|
+
description: "Detailed description of the error. Provides insights into the issue and potentially how to rectify it.",
|
|
17024
|
+
type: "string"
|
|
17025
|
+
}
|
|
16618
17026
|
},
|
|
16619
17027
|
required: ["message", "is_access_code_error", "error_code"],
|
|
16620
17028
|
type: "object"
|
|
@@ -16622,14 +17030,25 @@ var openapi_default = {
|
|
|
16622
17030
|
{
|
|
16623
17031
|
description: "Failed to set code on device.",
|
|
16624
17032
|
properties: {
|
|
16625
|
-
created_at: {
|
|
17033
|
+
created_at: {
|
|
17034
|
+
description: "Date and time at which Seam created the error.",
|
|
17035
|
+
format: "date-time",
|
|
17036
|
+
type: "string"
|
|
17037
|
+
},
|
|
16626
17038
|
error_code: {
|
|
16627
17039
|
description: "Unique identifier of the type of error. Enables quick recognition and categorization of the issue.",
|
|
16628
17040
|
enum: ["failed_to_set_on_device"],
|
|
16629
17041
|
type: "string"
|
|
16630
17042
|
},
|
|
16631
|
-
is_access_code_error: {
|
|
16632
|
-
|
|
17043
|
+
is_access_code_error: {
|
|
17044
|
+
description: "Indicates that this is an access code error.",
|
|
17045
|
+
enum: [true],
|
|
17046
|
+
type: "boolean"
|
|
17047
|
+
},
|
|
17048
|
+
message: {
|
|
17049
|
+
description: "Detailed description of the error. Provides insights into the issue and potentially how to rectify it.",
|
|
17050
|
+
type: "string"
|
|
17051
|
+
}
|
|
16633
17052
|
},
|
|
16634
17053
|
required: ["message", "is_access_code_error", "error_code"],
|
|
16635
17054
|
type: "object"
|
|
@@ -16637,14 +17056,25 @@ var openapi_default = {
|
|
|
16637
17056
|
{
|
|
16638
17057
|
description: "Failed to remove code from device.",
|
|
16639
17058
|
properties: {
|
|
16640
|
-
created_at: {
|
|
17059
|
+
created_at: {
|
|
17060
|
+
description: "Date and time at which Seam created the error.",
|
|
17061
|
+
format: "date-time",
|
|
17062
|
+
type: "string"
|
|
17063
|
+
},
|
|
16641
17064
|
error_code: {
|
|
16642
17065
|
description: "Unique identifier of the type of error. Enables quick recognition and categorization of the issue.",
|
|
16643
17066
|
enum: ["failed_to_remove_from_device"],
|
|
16644
17067
|
type: "string"
|
|
16645
17068
|
},
|
|
16646
|
-
is_access_code_error: {
|
|
16647
|
-
|
|
17069
|
+
is_access_code_error: {
|
|
17070
|
+
description: "Indicates that this is an access code error.",
|
|
17071
|
+
enum: [true],
|
|
17072
|
+
type: "boolean"
|
|
17073
|
+
},
|
|
17074
|
+
message: {
|
|
17075
|
+
description: "Detailed description of the error. Provides insights into the issue and potentially how to rectify it.",
|
|
17076
|
+
type: "string"
|
|
17077
|
+
}
|
|
16648
17078
|
},
|
|
16649
17079
|
required: ["message", "is_access_code_error", "error_code"],
|
|
16650
17080
|
type: "object"
|
|
@@ -16652,14 +17082,25 @@ var openapi_default = {
|
|
|
16652
17082
|
{
|
|
16653
17083
|
description: "Duplicate access code detected on device.",
|
|
16654
17084
|
properties: {
|
|
16655
|
-
created_at: {
|
|
17085
|
+
created_at: {
|
|
17086
|
+
description: "Date and time at which Seam created the error.",
|
|
17087
|
+
format: "date-time",
|
|
17088
|
+
type: "string"
|
|
17089
|
+
},
|
|
16656
17090
|
error_code: {
|
|
16657
17091
|
description: "Unique identifier of the type of error. Enables quick recognition and categorization of the issue.",
|
|
16658
17092
|
enum: ["duplicate_code_on_device"],
|
|
16659
17093
|
type: "string"
|
|
16660
17094
|
},
|
|
16661
|
-
is_access_code_error: {
|
|
16662
|
-
|
|
17095
|
+
is_access_code_error: {
|
|
17096
|
+
description: "Indicates that this is an access code error.",
|
|
17097
|
+
enum: [true],
|
|
17098
|
+
type: "boolean"
|
|
17099
|
+
},
|
|
17100
|
+
message: {
|
|
17101
|
+
description: "Detailed description of the error. Provides insights into the issue and potentially how to rectify it.",
|
|
17102
|
+
type: "string"
|
|
17103
|
+
}
|
|
16663
17104
|
},
|
|
16664
17105
|
required: ["message", "is_access_code_error", "error_code"],
|
|
16665
17106
|
type: "object"
|
|
@@ -16667,14 +17108,25 @@ var openapi_default = {
|
|
|
16667
17108
|
{
|
|
16668
17109
|
description: "An attempt to modify this access code was prevented.",
|
|
16669
17110
|
properties: {
|
|
16670
|
-
created_at: {
|
|
17111
|
+
created_at: {
|
|
17112
|
+
description: "Date and time at which Seam created the error.",
|
|
17113
|
+
format: "date-time",
|
|
17114
|
+
type: "string"
|
|
17115
|
+
},
|
|
16671
17116
|
error_code: {
|
|
16672
17117
|
description: "Unique identifier of the type of error. Enables quick recognition and categorization of the issue.",
|
|
16673
17118
|
enum: ["duplicate_code_attempt_prevented"],
|
|
16674
17119
|
type: "string"
|
|
16675
17120
|
},
|
|
16676
|
-
is_access_code_error: {
|
|
16677
|
-
|
|
17121
|
+
is_access_code_error: {
|
|
17122
|
+
description: "Indicates that this is an access code error.",
|
|
17123
|
+
enum: [true],
|
|
17124
|
+
type: "boolean"
|
|
17125
|
+
},
|
|
17126
|
+
message: {
|
|
17127
|
+
description: "Detailed description of the error. Provides insights into the issue and potentially how to rectify it.",
|
|
17128
|
+
type: "string"
|
|
17129
|
+
}
|
|
16678
17130
|
},
|
|
16679
17131
|
required: ["message", "is_access_code_error", "error_code"],
|
|
16680
17132
|
type: "object"
|
|
@@ -16682,14 +17134,25 @@ var openapi_default = {
|
|
|
16682
17134
|
{
|
|
16683
17135
|
description: "Igloohome bridge has too many pending jobs in the queue.",
|
|
16684
17136
|
properties: {
|
|
16685
|
-
created_at: {
|
|
17137
|
+
created_at: {
|
|
17138
|
+
description: "Date and time at which Seam created the error.",
|
|
17139
|
+
format: "date-time",
|
|
17140
|
+
type: "string"
|
|
17141
|
+
},
|
|
16686
17142
|
error_code: {
|
|
16687
17143
|
description: "Unique identifier of the type of error. Enables quick recognition and categorization of the issue.",
|
|
16688
17144
|
enum: ["igloohome_bridge_too_many_pending_jobs"],
|
|
16689
17145
|
type: "string"
|
|
16690
17146
|
},
|
|
16691
|
-
is_access_code_error: {
|
|
16692
|
-
|
|
17147
|
+
is_access_code_error: {
|
|
17148
|
+
description: "Indicates that this is an access code error.",
|
|
17149
|
+
enum: [true],
|
|
17150
|
+
type: "boolean"
|
|
17151
|
+
},
|
|
17152
|
+
message: {
|
|
17153
|
+
description: "Detailed description of the error. Provides insights into the issue and potentially how to rectify it.",
|
|
17154
|
+
type: "string"
|
|
17155
|
+
}
|
|
16693
17156
|
},
|
|
16694
17157
|
required: ["message", "is_access_code_error", "error_code"],
|
|
16695
17158
|
type: "object"
|
|
@@ -16697,22 +17160,37 @@ var openapi_default = {
|
|
|
16697
17160
|
{
|
|
16698
17161
|
description: "Igloohome bridge is offline.",
|
|
16699
17162
|
properties: {
|
|
16700
|
-
created_at: {
|
|
17163
|
+
created_at: {
|
|
17164
|
+
description: "Date and time at which Seam created the error.",
|
|
17165
|
+
format: "date-time",
|
|
17166
|
+
type: "string"
|
|
17167
|
+
},
|
|
16701
17168
|
error_code: {
|
|
16702
17169
|
description: "Unique identifier of the type of error. Enables quick recognition and categorization of the issue.",
|
|
16703
17170
|
enum: ["igloohome_bridge_offline"],
|
|
16704
17171
|
type: "string"
|
|
16705
17172
|
},
|
|
16706
|
-
is_access_code_error: {
|
|
16707
|
-
|
|
17173
|
+
is_access_code_error: {
|
|
17174
|
+
description: "Indicates that this is an access code error.",
|
|
17175
|
+
enum: [true],
|
|
17176
|
+
type: "boolean"
|
|
17177
|
+
},
|
|
17178
|
+
message: {
|
|
17179
|
+
description: "Detailed description of the error. Provides insights into the issue and potentially how to rectify it.",
|
|
17180
|
+
type: "string"
|
|
17181
|
+
}
|
|
16708
17182
|
},
|
|
16709
17183
|
required: ["message", "is_access_code_error", "error_code"],
|
|
16710
17184
|
type: "object"
|
|
16711
17185
|
},
|
|
16712
17186
|
{
|
|
16713
|
-
description: "Lock
|
|
17187
|
+
description: "Lock has reached maximum amount of codes.",
|
|
16714
17188
|
properties: {
|
|
16715
|
-
created_at: {
|
|
17189
|
+
created_at: {
|
|
17190
|
+
description: "Date and time at which Seam created the error.",
|
|
17191
|
+
format: "date-time",
|
|
17192
|
+
type: "string"
|
|
17193
|
+
},
|
|
16716
17194
|
error_code: {
|
|
16717
17195
|
description: "Unique identifier of the type of error. Enables quick recognition and categorization of the issue.",
|
|
16718
17196
|
enum: [
|
|
@@ -16720,23 +17198,41 @@ var openapi_default = {
|
|
|
16720
17198
|
],
|
|
16721
17199
|
type: "string"
|
|
16722
17200
|
},
|
|
16723
|
-
is_access_code_error: {
|
|
16724
|
-
|
|
17201
|
+
is_access_code_error: {
|
|
17202
|
+
description: "Indicates that this is an access code error.",
|
|
17203
|
+
enum: [true],
|
|
17204
|
+
type: "boolean"
|
|
17205
|
+
},
|
|
17206
|
+
message: {
|
|
17207
|
+
description: "Detailed description of the error. Provides insights into the issue and potentially how to rectify it.",
|
|
17208
|
+
type: "string"
|
|
17209
|
+
}
|
|
16725
17210
|
},
|
|
16726
17211
|
required: ["message", "is_access_code_error", "error_code"],
|
|
16727
17212
|
type: "object"
|
|
16728
17213
|
},
|
|
16729
17214
|
{
|
|
16730
|
-
description: "Unable to confirm the access code is set on Kwikset device.",
|
|
17215
|
+
description: "Unable to confirm that the access code is set on Kwikset device.",
|
|
16731
17216
|
properties: {
|
|
16732
|
-
created_at: {
|
|
17217
|
+
created_at: {
|
|
17218
|
+
description: "Date and time at which Seam created the error.",
|
|
17219
|
+
format: "date-time",
|
|
17220
|
+
type: "string"
|
|
17221
|
+
},
|
|
16733
17222
|
error_code: {
|
|
16734
17223
|
description: "Unique identifier of the type of error. Enables quick recognition and categorization of the issue.",
|
|
16735
17224
|
enum: ["kwikset_unable_to_confirm_code"],
|
|
16736
17225
|
type: "string"
|
|
16737
17226
|
},
|
|
16738
|
-
is_access_code_error: {
|
|
16739
|
-
|
|
17227
|
+
is_access_code_error: {
|
|
17228
|
+
description: "Indicates that this is an access code error.",
|
|
17229
|
+
enum: [true],
|
|
17230
|
+
type: "boolean"
|
|
17231
|
+
},
|
|
17232
|
+
message: {
|
|
17233
|
+
description: "Detailed description of the error. Provides insights into the issue and potentially how to rectify it.",
|
|
17234
|
+
type: "string"
|
|
17235
|
+
}
|
|
16740
17236
|
},
|
|
16741
17237
|
required: ["message", "is_access_code_error", "error_code"],
|
|
16742
17238
|
type: "object"
|
|
@@ -16744,14 +17240,25 @@ var openapi_default = {
|
|
|
16744
17240
|
{
|
|
16745
17241
|
description: "Unable to confirm the deletion of the access code on Kwikset device.",
|
|
16746
17242
|
properties: {
|
|
16747
|
-
created_at: {
|
|
17243
|
+
created_at: {
|
|
17244
|
+
description: "Date and time at which Seam created the error.",
|
|
17245
|
+
format: "date-time",
|
|
17246
|
+
type: "string"
|
|
17247
|
+
},
|
|
16748
17248
|
error_code: {
|
|
16749
17249
|
description: "Unique identifier of the type of error. Enables quick recognition and categorization of the issue.",
|
|
16750
17250
|
enum: ["kwikset_unable_to_confirm_deletion"],
|
|
16751
17251
|
type: "string"
|
|
16752
17252
|
},
|
|
16753
|
-
is_access_code_error: {
|
|
16754
|
-
|
|
17253
|
+
is_access_code_error: {
|
|
17254
|
+
description: "Indicates that this is an access code error.",
|
|
17255
|
+
enum: [true],
|
|
17256
|
+
type: "boolean"
|
|
17257
|
+
},
|
|
17258
|
+
message: {
|
|
17259
|
+
description: "Detailed description of the error. Provides insights into the issue and potentially how to rectify it.",
|
|
17260
|
+
type: "string"
|
|
17261
|
+
}
|
|
16755
17262
|
},
|
|
16756
17263
|
required: ["message", "is_access_code_error", "error_code"],
|
|
16757
17264
|
type: "object"
|
|
@@ -16759,14 +17266,25 @@ var openapi_default = {
|
|
|
16759
17266
|
{
|
|
16760
17267
|
description: "Code was modified or removed externally after Seam successfully set it on the device.",
|
|
16761
17268
|
properties: {
|
|
16762
|
-
created_at: {
|
|
17269
|
+
created_at: {
|
|
17270
|
+
description: "Date and time at which Seam created the error.",
|
|
17271
|
+
format: "date-time",
|
|
17272
|
+
type: "string"
|
|
17273
|
+
},
|
|
16763
17274
|
error_code: {
|
|
16764
17275
|
description: "Unique identifier of the type of error. Enables quick recognition and categorization of the issue.",
|
|
16765
17276
|
enum: ["code_modified_external_to_seam"],
|
|
16766
17277
|
type: "string"
|
|
16767
17278
|
},
|
|
16768
|
-
is_access_code_error: {
|
|
16769
|
-
|
|
17279
|
+
is_access_code_error: {
|
|
17280
|
+
description: "Indicates that this is an access code error.",
|
|
17281
|
+
enum: [true],
|
|
17282
|
+
type: "boolean"
|
|
17283
|
+
},
|
|
17284
|
+
message: {
|
|
17285
|
+
description: "Detailed description of the error. Provides insights into the issue and potentially how to rectify it.",
|
|
17286
|
+
type: "string"
|
|
17287
|
+
}
|
|
16770
17288
|
},
|
|
16771
17289
|
required: ["message", "is_access_code_error", "error_code"],
|
|
16772
17290
|
type: "object"
|
|
@@ -16774,14 +17292,25 @@ var openapi_default = {
|
|
|
16774
17292
|
{
|
|
16775
17293
|
description: "Invalid code length for August lock.",
|
|
16776
17294
|
properties: {
|
|
16777
|
-
created_at: {
|
|
17295
|
+
created_at: {
|
|
17296
|
+
description: "Date and time at which Seam created the error.",
|
|
17297
|
+
format: "date-time",
|
|
17298
|
+
type: "string"
|
|
17299
|
+
},
|
|
16778
17300
|
error_code: {
|
|
16779
17301
|
description: "Unique identifier of the type of error. Enables quick recognition and categorization of the issue.",
|
|
16780
17302
|
enum: ["august_lock_invalid_code_length"],
|
|
16781
17303
|
type: "string"
|
|
16782
17304
|
},
|
|
16783
|
-
is_access_code_error: {
|
|
16784
|
-
|
|
17305
|
+
is_access_code_error: {
|
|
17306
|
+
description: "Indicates that this is an access code error.",
|
|
17307
|
+
enum: [true],
|
|
17308
|
+
type: "boolean"
|
|
17309
|
+
},
|
|
17310
|
+
message: {
|
|
17311
|
+
description: "Detailed description of the error. Provides insights into the issue and potentially how to rectify it.",
|
|
17312
|
+
type: "string"
|
|
17313
|
+
}
|
|
16785
17314
|
},
|
|
16786
17315
|
required: ["message", "is_access_code_error", "error_code"],
|
|
16787
17316
|
type: "object"
|
|
@@ -16789,14 +17318,25 @@ var openapi_default = {
|
|
|
16789
17318
|
{
|
|
16790
17319
|
description: "Access code has not yet been fully moved to the device.",
|
|
16791
17320
|
properties: {
|
|
16792
|
-
created_at: {
|
|
17321
|
+
created_at: {
|
|
17322
|
+
description: "Date and time at which Seam created the error.",
|
|
17323
|
+
format: "date-time",
|
|
17324
|
+
type: "string"
|
|
17325
|
+
},
|
|
16793
17326
|
error_code: {
|
|
16794
17327
|
description: "Unique identifier of the type of error. Enables quick recognition and categorization of the issue.",
|
|
16795
17328
|
enum: ["august_device_programming_delay"],
|
|
16796
17329
|
type: "string"
|
|
16797
17330
|
},
|
|
16798
|
-
is_access_code_error: {
|
|
16799
|
-
|
|
17331
|
+
is_access_code_error: {
|
|
17332
|
+
description: "Indicates that this is an access code error.",
|
|
17333
|
+
enum: [true],
|
|
17334
|
+
type: "boolean"
|
|
17335
|
+
},
|
|
17336
|
+
message: {
|
|
17337
|
+
description: "Detailed description of the error. Provides insights into the issue and potentially how to rectify it.",
|
|
17338
|
+
type: "string"
|
|
17339
|
+
}
|
|
16800
17340
|
},
|
|
16801
17341
|
required: ["message", "is_access_code_error", "error_code"],
|
|
16802
17342
|
type: "object"
|
|
@@ -16804,14 +17344,25 @@ var openapi_default = {
|
|
|
16804
17344
|
{
|
|
16805
17345
|
description: "All access code slots on the device are full.",
|
|
16806
17346
|
properties: {
|
|
16807
|
-
created_at: {
|
|
17347
|
+
created_at: {
|
|
17348
|
+
description: "Date and time at which Seam created the error.",
|
|
17349
|
+
format: "date-time",
|
|
17350
|
+
type: "string"
|
|
17351
|
+
},
|
|
16808
17352
|
error_code: {
|
|
16809
17353
|
description: "Unique identifier of the type of error. Enables quick recognition and categorization of the issue.",
|
|
16810
17354
|
enum: ["august_device_slots_full"],
|
|
16811
17355
|
type: "string"
|
|
16812
17356
|
},
|
|
16813
|
-
is_access_code_error: {
|
|
16814
|
-
|
|
17357
|
+
is_access_code_error: {
|
|
17358
|
+
description: "Indicates that this is an access code error.",
|
|
17359
|
+
enum: [true],
|
|
17360
|
+
type: "boolean"
|
|
17361
|
+
},
|
|
17362
|
+
message: {
|
|
17363
|
+
description: "Detailed description of the error. Provides insights into the issue and potentially how to rectify it.",
|
|
17364
|
+
type: "string"
|
|
17365
|
+
}
|
|
16815
17366
|
},
|
|
16816
17367
|
required: ["message", "is_access_code_error", "error_code"],
|
|
16817
17368
|
type: "object"
|
|
@@ -16819,14 +17370,25 @@ var openapi_default = {
|
|
|
16819
17370
|
{
|
|
16820
17371
|
description: "August lock is missing a keypad.",
|
|
16821
17372
|
properties: {
|
|
16822
|
-
created_at: {
|
|
17373
|
+
created_at: {
|
|
17374
|
+
description: "Date and time at which Seam created the error.",
|
|
17375
|
+
format: "date-time",
|
|
17376
|
+
type: "string"
|
|
17377
|
+
},
|
|
16823
17378
|
error_code: {
|
|
16824
17379
|
description: "Unique identifier of the type of error. Enables quick recognition and categorization of the issue.",
|
|
16825
17380
|
enum: ["august_lock_missing_keypad"],
|
|
16826
17381
|
type: "string"
|
|
16827
17382
|
},
|
|
16828
|
-
is_access_code_error: {
|
|
16829
|
-
|
|
17383
|
+
is_access_code_error: {
|
|
17384
|
+
description: "Indicates that this is an access code error.",
|
|
17385
|
+
enum: [true],
|
|
17386
|
+
type: "boolean"
|
|
17387
|
+
},
|
|
17388
|
+
message: {
|
|
17389
|
+
description: "Detailed description of the error. Provides insights into the issue and potentially how to rectify it.",
|
|
17390
|
+
type: "string"
|
|
17391
|
+
}
|
|
16830
17392
|
},
|
|
16831
17393
|
required: ["message", "is_access_code_error", "error_code"],
|
|
16832
17394
|
type: "object"
|
|
@@ -16834,14 +17396,25 @@ var openapi_default = {
|
|
|
16834
17396
|
{
|
|
16835
17397
|
description: "August lock is temporarily offline.",
|
|
16836
17398
|
properties: {
|
|
16837
|
-
created_at: {
|
|
17399
|
+
created_at: {
|
|
17400
|
+
description: "Date and time at which Seam created the error.",
|
|
17401
|
+
format: "date-time",
|
|
17402
|
+
type: "string"
|
|
17403
|
+
},
|
|
16838
17404
|
error_code: {
|
|
16839
17405
|
description: "Unique identifier of the type of error. Enables quick recognition and categorization of the issue.",
|
|
16840
17406
|
enum: ["august_lock_temporarily_offline"],
|
|
16841
17407
|
type: "string"
|
|
16842
17408
|
},
|
|
16843
|
-
is_access_code_error: {
|
|
16844
|
-
|
|
17409
|
+
is_access_code_error: {
|
|
17410
|
+
description: "Indicates that this is an access code error.",
|
|
17411
|
+
enum: [true],
|
|
17412
|
+
type: "boolean"
|
|
17413
|
+
},
|
|
17414
|
+
message: {
|
|
17415
|
+
description: "Detailed description of the error. Provides insights into the issue and potentially how to rectify it.",
|
|
17416
|
+
type: "string"
|
|
17417
|
+
}
|
|
16845
17418
|
},
|
|
16846
17419
|
required: ["message", "is_access_code_error", "error_code"],
|
|
16847
17420
|
type: "object"
|
|
@@ -16849,14 +17422,25 @@ var openapi_default = {
|
|
|
16849
17422
|
{
|
|
16850
17423
|
description: "Salto site user is not subscribed.",
|
|
16851
17424
|
properties: {
|
|
16852
|
-
created_at: {
|
|
17425
|
+
created_at: {
|
|
17426
|
+
description: "Date and time at which Seam created the error.",
|
|
17427
|
+
format: "date-time",
|
|
17428
|
+
type: "string"
|
|
17429
|
+
},
|
|
16853
17430
|
error_code: {
|
|
16854
17431
|
description: "Unique identifier of the type of error. Enables quick recognition and categorization of the issue.",
|
|
16855
17432
|
enum: ["salto_ks_user_not_subscribed"],
|
|
16856
17433
|
type: "string"
|
|
16857
17434
|
},
|
|
16858
|
-
is_access_code_error: {
|
|
16859
|
-
|
|
17435
|
+
is_access_code_error: {
|
|
17436
|
+
description: "Indicates that this is an access code error.",
|
|
17437
|
+
enum: [true],
|
|
17438
|
+
type: "boolean"
|
|
17439
|
+
},
|
|
17440
|
+
message: {
|
|
17441
|
+
description: "Detailed description of the error. Provides insights into the issue and potentially how to rectify it.",
|
|
17442
|
+
type: "string"
|
|
17443
|
+
}
|
|
16860
17444
|
},
|
|
16861
17445
|
required: ["message", "is_access_code_error", "error_code"],
|
|
16862
17446
|
type: "object"
|
|
@@ -16864,14 +17448,25 @@ var openapi_default = {
|
|
|
16864
17448
|
{
|
|
16865
17449
|
description: "Access code has not yet been fully moved to the device.",
|
|
16866
17450
|
properties: {
|
|
16867
|
-
created_at: {
|
|
17451
|
+
created_at: {
|
|
17452
|
+
description: "Date and time at which Seam created the error.",
|
|
17453
|
+
format: "date-time",
|
|
17454
|
+
type: "string"
|
|
17455
|
+
},
|
|
16868
17456
|
error_code: {
|
|
16869
17457
|
description: "Unique identifier of the type of error. Enables quick recognition and categorization of the issue.",
|
|
16870
17458
|
enum: ["hubitat_device_programming_delay"],
|
|
16871
17459
|
type: "string"
|
|
16872
17460
|
},
|
|
16873
|
-
is_access_code_error: {
|
|
16874
|
-
|
|
17461
|
+
is_access_code_error: {
|
|
17462
|
+
description: "Indicates that this is an access code error.",
|
|
17463
|
+
enum: [true],
|
|
17464
|
+
type: "boolean"
|
|
17465
|
+
},
|
|
17466
|
+
message: {
|
|
17467
|
+
description: "Detailed description of the error. Provides insights into the issue and potentially how to rectify it.",
|
|
17468
|
+
type: "string"
|
|
17469
|
+
}
|
|
16875
17470
|
},
|
|
16876
17471
|
required: ["message", "is_access_code_error", "error_code"],
|
|
16877
17472
|
type: "object"
|
|
@@ -16879,14 +17474,25 @@ var openapi_default = {
|
|
|
16879
17474
|
{
|
|
16880
17475
|
description: "No free positions available on the device.",
|
|
16881
17476
|
properties: {
|
|
16882
|
-
created_at: {
|
|
17477
|
+
created_at: {
|
|
17478
|
+
description: "Date and time at which Seam created the error.",
|
|
17479
|
+
format: "date-time",
|
|
17480
|
+
type: "string"
|
|
17481
|
+
},
|
|
16883
17482
|
error_code: {
|
|
16884
17483
|
description: "Unique identifier of the type of error. Enables quick recognition and categorization of the issue.",
|
|
16885
17484
|
enum: ["hubitat_no_free_positions_available"],
|
|
16886
17485
|
type: "string"
|
|
16887
17486
|
},
|
|
16888
|
-
is_access_code_error: {
|
|
16889
|
-
|
|
17487
|
+
is_access_code_error: {
|
|
17488
|
+
description: "Indicates that this is an access code error.",
|
|
17489
|
+
enum: [true],
|
|
17490
|
+
type: "boolean"
|
|
17491
|
+
},
|
|
17492
|
+
message: {
|
|
17493
|
+
description: "Detailed description of the error. Provides insights into the issue and potentially how to rectify it.",
|
|
17494
|
+
type: "string"
|
|
17495
|
+
}
|
|
16890
17496
|
},
|
|
16891
17497
|
required: ["message", "is_access_code_error", "error_code"],
|
|
16892
17498
|
type: "object"
|
|
@@ -16894,14 +17500,25 @@ var openapi_default = {
|
|
|
16894
17500
|
{
|
|
16895
17501
|
description: "Duplicate access code name detected.",
|
|
16896
17502
|
properties: {
|
|
16897
|
-
created_at: {
|
|
17503
|
+
created_at: {
|
|
17504
|
+
description: "Date and time at which Seam created the error.",
|
|
17505
|
+
format: "date-time",
|
|
17506
|
+
type: "string"
|
|
17507
|
+
},
|
|
16898
17508
|
error_code: {
|
|
16899
17509
|
description: "Unique identifier of the type of error. Enables quick recognition and categorization of the issue.",
|
|
16900
17510
|
enum: ["wyze_duplicate_code_name"],
|
|
16901
17511
|
type: "string"
|
|
16902
17512
|
},
|
|
16903
|
-
is_access_code_error: {
|
|
16904
|
-
|
|
17513
|
+
is_access_code_error: {
|
|
17514
|
+
description: "Indicates that this is an access code error.",
|
|
17515
|
+
enum: [true],
|
|
17516
|
+
type: "boolean"
|
|
17517
|
+
},
|
|
17518
|
+
message: {
|
|
17519
|
+
description: "Detailed description of the error. Provides insights into the issue and potentially how to rectify it.",
|
|
17520
|
+
type: "string"
|
|
17521
|
+
}
|
|
16905
17522
|
},
|
|
16906
17523
|
required: ["message", "is_access_code_error", "error_code"],
|
|
16907
17524
|
type: "object"
|
|
@@ -16909,14 +17526,25 @@ var openapi_default = {
|
|
|
16909
17526
|
{
|
|
16910
17527
|
description: "Potential duplicate access code detected.",
|
|
16911
17528
|
properties: {
|
|
16912
|
-
created_at: {
|
|
17529
|
+
created_at: {
|
|
17530
|
+
description: "Date and time at which Seam created the error.",
|
|
17531
|
+
format: "date-time",
|
|
17532
|
+
type: "string"
|
|
17533
|
+
},
|
|
16913
17534
|
error_code: {
|
|
16914
17535
|
description: "Unique identifier of the type of error. Enables quick recognition and categorization of the issue.",
|
|
16915
17536
|
enum: ["wyze_potential_duplicate_code"],
|
|
16916
17537
|
type: "string"
|
|
16917
17538
|
},
|
|
16918
|
-
is_access_code_error: {
|
|
16919
|
-
|
|
17539
|
+
is_access_code_error: {
|
|
17540
|
+
description: "Indicates that this is an access code error.",
|
|
17541
|
+
enum: [true],
|
|
17542
|
+
type: "boolean"
|
|
17543
|
+
},
|
|
17544
|
+
message: {
|
|
17545
|
+
description: "Detailed description of the error. Provides insights into the issue and potentially how to rectify it.",
|
|
17546
|
+
type: "string"
|
|
17547
|
+
}
|
|
16920
17548
|
},
|
|
16921
17549
|
required: ["message", "is_access_code_error", "error_code"],
|
|
16922
17550
|
type: "object"
|
|
@@ -16924,14 +17552,25 @@ var openapi_default = {
|
|
|
16924
17552
|
{
|
|
16925
17553
|
description: "No valid user level for Oracode.",
|
|
16926
17554
|
properties: {
|
|
16927
|
-
created_at: {
|
|
17555
|
+
created_at: {
|
|
17556
|
+
description: "Date and time at which Seam created the error.",
|
|
17557
|
+
format: "date-time",
|
|
17558
|
+
type: "string"
|
|
17559
|
+
},
|
|
16928
17560
|
error_code: {
|
|
16929
17561
|
description: "Unique identifier of the type of error. Enables quick recognition and categorization of the issue.",
|
|
16930
17562
|
enum: ["dormakaba_oracode_no_valid_user_level"],
|
|
16931
17563
|
type: "string"
|
|
16932
17564
|
},
|
|
16933
|
-
is_access_code_error: {
|
|
16934
|
-
|
|
17565
|
+
is_access_code_error: {
|
|
17566
|
+
description: "Indicates that this is an access code error.",
|
|
17567
|
+
enum: [true],
|
|
17568
|
+
type: "boolean"
|
|
17569
|
+
},
|
|
17570
|
+
message: {
|
|
17571
|
+
description: "Detailed description of the error. Provides insights into the issue and potentially how to rectify it.",
|
|
17572
|
+
type: "string"
|
|
17573
|
+
}
|
|
16935
17574
|
},
|
|
16936
17575
|
required: ["message", "is_access_code_error", "error_code"],
|
|
16937
17576
|
type: "object"
|
|
@@ -17250,7 +17889,11 @@ var openapi_default = {
|
|
|
17250
17889
|
},
|
|
17251
17890
|
type: "array"
|
|
17252
17891
|
},
|
|
17253
|
-
is_managed: {
|
|
17892
|
+
is_managed: {
|
|
17893
|
+
description: "Indicates that Seam does not manage the access code.",
|
|
17894
|
+
enum: [false],
|
|
17895
|
+
type: "boolean"
|
|
17896
|
+
},
|
|
17254
17897
|
name: {
|
|
17255
17898
|
description: "Name of the access code. Enables administrators and users to identify the access code easily, especially when there are numerous access codes.",
|
|
17256
17899
|
nullable: true,
|
|
@@ -17262,22 +17905,34 @@ var openapi_default = {
|
|
|
17262
17905
|
nullable: true,
|
|
17263
17906
|
type: "string"
|
|
17264
17907
|
},
|
|
17265
|
-
status: {
|
|
17908
|
+
status: {
|
|
17909
|
+
description: "Current status of the access code within the operational lifecycle. `set` indicates that the code is active and operational.",
|
|
17910
|
+
enum: ["set"],
|
|
17911
|
+
type: "string"
|
|
17912
|
+
},
|
|
17266
17913
|
type: {
|
|
17267
|
-
description:
|
|
17914
|
+
description: "Nature of the access code. Values are `ongoing` for access codes that are active continuously until deactivated manually or `time_bound` for access codes that have a specific duration.",
|
|
17268
17915
|
enum: ["time_bound", "ongoing"],
|
|
17269
17916
|
type: "string"
|
|
17270
17917
|
},
|
|
17271
17918
|
warnings: {
|
|
17272
|
-
description:
|
|
17919
|
+
description: "Warnings associated with the [access code](https://docs.seam.co/latest/capability-guides/smart-locks/access-codes).",
|
|
17273
17920
|
items: {
|
|
17921
|
+
description: "Warnings associated with the [access code](https://docs.seam.co/latest/capability-guides/smart-locks/access-codes).",
|
|
17274
17922
|
discriminator: { propertyName: "warning_code" },
|
|
17275
17923
|
oneOf: [
|
|
17276
17924
|
{
|
|
17277
|
-
description: "Failed to set code on
|
|
17925
|
+
description: "Failed to set code on SmartThings device.",
|
|
17278
17926
|
properties: {
|
|
17279
|
-
created_at: {
|
|
17280
|
-
|
|
17927
|
+
created_at: {
|
|
17928
|
+
description: "Date and time at which Seam created the warning.",
|
|
17929
|
+
format: "date-time",
|
|
17930
|
+
type: "string"
|
|
17931
|
+
},
|
|
17932
|
+
message: {
|
|
17933
|
+
description: "Detailed description of the warning. Provides insights into the issue and potentially how to rectify it.",
|
|
17934
|
+
type: "string"
|
|
17935
|
+
},
|
|
17281
17936
|
warning_code: {
|
|
17282
17937
|
description: "Unique identifier of the type of warning. Enables quick recognition and categorization of the issue.",
|
|
17283
17938
|
enum: ["smartthings_failed_to_set_access_code"],
|
|
@@ -17290,8 +17945,15 @@ var openapi_default = {
|
|
|
17290
17945
|
{
|
|
17291
17946
|
description: "Duplicate access code detected.",
|
|
17292
17947
|
properties: {
|
|
17293
|
-
created_at: {
|
|
17294
|
-
|
|
17948
|
+
created_at: {
|
|
17949
|
+
description: "Date and time at which Seam created the warning.",
|
|
17950
|
+
format: "date-time",
|
|
17951
|
+
type: "string"
|
|
17952
|
+
},
|
|
17953
|
+
message: {
|
|
17954
|
+
description: "Detailed description of the warning. Provides insights into the issue and potentially how to rectify it.",
|
|
17955
|
+
type: "string"
|
|
17956
|
+
},
|
|
17295
17957
|
warning_code: {
|
|
17296
17958
|
description: "Unique identifier of the type of warning. Enables quick recognition and categorization of the issue.",
|
|
17297
17959
|
enum: ["schlage_detected_duplicate"],
|
|
@@ -17304,8 +17966,15 @@ var openapi_default = {
|
|
|
17304
17966
|
{
|
|
17305
17967
|
description: "Received an error when attempting to create this code.",
|
|
17306
17968
|
properties: {
|
|
17307
|
-
created_at: {
|
|
17308
|
-
|
|
17969
|
+
created_at: {
|
|
17970
|
+
description: "Date and time at which Seam created the warning.",
|
|
17971
|
+
format: "date-time",
|
|
17972
|
+
type: "string"
|
|
17973
|
+
},
|
|
17974
|
+
message: {
|
|
17975
|
+
description: "Detailed description of the warning. Provides insights into the issue and potentially how to rectify it.",
|
|
17976
|
+
type: "string"
|
|
17977
|
+
},
|
|
17309
17978
|
warning_code: {
|
|
17310
17979
|
description: "Unique identifier of the type of warning. Enables quick recognition and categorization of the issue.",
|
|
17311
17980
|
enum: ["schlage_creation_outage"],
|
|
@@ -17318,8 +17987,15 @@ var openapi_default = {
|
|
|
17318
17987
|
{
|
|
17319
17988
|
description: "Code was modified or removed externally after Seam successfully set it on the device.",
|
|
17320
17989
|
properties: {
|
|
17321
|
-
created_at: {
|
|
17322
|
-
|
|
17990
|
+
created_at: {
|
|
17991
|
+
description: "Date and time at which Seam created the warning.",
|
|
17992
|
+
format: "date-time",
|
|
17993
|
+
type: "string"
|
|
17994
|
+
},
|
|
17995
|
+
message: {
|
|
17996
|
+
description: "Detailed description of the warning. Provides insights into the issue and potentially how to rectify it.",
|
|
17997
|
+
type: "string"
|
|
17998
|
+
},
|
|
17323
17999
|
warning_code: {
|
|
17324
18000
|
description: "Unique identifier of the type of warning. Enables quick recognition and categorization of the issue.",
|
|
17325
18001
|
enum: ["code_modified_external_to_seam"],
|
|
@@ -17332,8 +18008,15 @@ var openapi_default = {
|
|
|
17332
18008
|
{
|
|
17333
18009
|
description: "Delay in setting code on device.",
|
|
17334
18010
|
properties: {
|
|
17335
|
-
created_at: {
|
|
17336
|
-
|
|
18011
|
+
created_at: {
|
|
18012
|
+
description: "Date and time at which Seam created the warning.",
|
|
18013
|
+
format: "date-time",
|
|
18014
|
+
type: "string"
|
|
18015
|
+
},
|
|
18016
|
+
message: {
|
|
18017
|
+
description: "Detailed description of the warning. Provides insights into the issue and potentially how to rectify it.",
|
|
18018
|
+
type: "string"
|
|
18019
|
+
},
|
|
17337
18020
|
warning_code: {
|
|
17338
18021
|
description: "Unique identifier of the type of warning. Enables quick recognition and categorization of the issue.",
|
|
17339
18022
|
enum: ["delay_in_setting_on_device"],
|
|
@@ -17346,8 +18029,15 @@ var openapi_default = {
|
|
|
17346
18029
|
{
|
|
17347
18030
|
description: "Delay in removing code from device.",
|
|
17348
18031
|
properties: {
|
|
17349
|
-
created_at: {
|
|
17350
|
-
|
|
18032
|
+
created_at: {
|
|
18033
|
+
description: "Date and time at which Seam created the warning.",
|
|
18034
|
+
format: "date-time",
|
|
18035
|
+
type: "string"
|
|
18036
|
+
},
|
|
18037
|
+
message: {
|
|
18038
|
+
description: "Detailed description of the warning. Provides insights into the issue and potentially how to rectify it.",
|
|
18039
|
+
type: "string"
|
|
18040
|
+
},
|
|
17351
18041
|
warning_code: {
|
|
17352
18042
|
description: "Unique identifier of the type of warning. Enables quick recognition and categorization of the issue.",
|
|
17353
18043
|
enum: ["delay_in_removing_from_device"],
|
|
@@ -17358,10 +18048,17 @@ var openapi_default = {
|
|
|
17358
18048
|
type: "object"
|
|
17359
18049
|
},
|
|
17360
18050
|
{
|
|
17361
|
-
description: "Third
|
|
18051
|
+
description: "Third-party integration detected that may cause access codes to fail.",
|
|
17362
18052
|
properties: {
|
|
17363
|
-
created_at: {
|
|
17364
|
-
|
|
18053
|
+
created_at: {
|
|
18054
|
+
description: "Date and time at which Seam created the warning.",
|
|
18055
|
+
format: "date-time",
|
|
18056
|
+
type: "string"
|
|
18057
|
+
},
|
|
18058
|
+
message: {
|
|
18059
|
+
description: "Detailed description of the warning. Provides insights into the issue and potentially how to rectify it.",
|
|
18060
|
+
type: "string"
|
|
18061
|
+
},
|
|
17365
18062
|
warning_code: {
|
|
17366
18063
|
description: "Unique identifier of the type of warning. Enables quick recognition and categorization of the issue.",
|
|
17367
18064
|
enum: ["third_party_integration_detected"],
|
|
@@ -17374,8 +18071,15 @@ var openapi_default = {
|
|
|
17374
18071
|
{
|
|
17375
18072
|
description: "Access code has not yet been fully moved to the device.",
|
|
17376
18073
|
properties: {
|
|
17377
|
-
created_at: {
|
|
17378
|
-
|
|
18074
|
+
created_at: {
|
|
18075
|
+
description: "Date and time at which Seam created the warning.",
|
|
18076
|
+
format: "date-time",
|
|
18077
|
+
type: "string"
|
|
18078
|
+
},
|
|
18079
|
+
message: {
|
|
18080
|
+
description: "Detailed description of the warning. Provides insights into the issue and potentially how to rectify it.",
|
|
18081
|
+
type: "string"
|
|
18082
|
+
},
|
|
17379
18083
|
warning_code: {
|
|
17380
18084
|
description: "Unique identifier of the type of warning. Enables quick recognition and categorization of the issue.",
|
|
17381
18085
|
enum: ["august_device_programming_delay"],
|
|
@@ -17388,8 +18092,15 @@ var openapi_default = {
|
|
|
17388
18092
|
{
|
|
17389
18093
|
description: "August lock is temporarily offline.",
|
|
17390
18094
|
properties: {
|
|
17391
|
-
created_at: {
|
|
17392
|
-
|
|
18095
|
+
created_at: {
|
|
18096
|
+
description: "Date and time at which Seam created the warning.",
|
|
18097
|
+
format: "date-time",
|
|
18098
|
+
type: "string"
|
|
18099
|
+
},
|
|
18100
|
+
message: {
|
|
18101
|
+
description: "Detailed description of the warning. Provides insights into the issue and potentially how to rectify it.",
|
|
18102
|
+
type: "string"
|
|
18103
|
+
},
|
|
17393
18104
|
warning_code: {
|
|
17394
18105
|
description: "Unique identifier of the type of error. Enables quick recognition and categorization of the issue.",
|
|
17395
18106
|
enum: ["august_lock_temporarily_offline"],
|
|
@@ -17402,8 +18113,15 @@ var openapi_default = {
|
|
|
17402
18113
|
{
|
|
17403
18114
|
description: "Algopins must be used within 24 hours.",
|
|
17404
18115
|
properties: {
|
|
17405
|
-
created_at: {
|
|
17406
|
-
|
|
18116
|
+
created_at: {
|
|
18117
|
+
description: "Date and time at which Seam created the warning.",
|
|
18118
|
+
format: "date-time",
|
|
18119
|
+
type: "string"
|
|
18120
|
+
},
|
|
18121
|
+
message: {
|
|
18122
|
+
description: "Detailed description of the warning. Provides insights into the issue and potentially how to rectify it.",
|
|
18123
|
+
type: "string"
|
|
18124
|
+
},
|
|
17407
18125
|
warning_code: {
|
|
17408
18126
|
description: "Unique identifier of the type of warning. Enables quick recognition and categorization of the issue.",
|
|
17409
18127
|
enum: ["igloo_algopin_must_be_used_within_24_hours"],
|
|
@@ -17416,8 +18134,15 @@ var openapi_default = {
|
|
|
17416
18134
|
{
|
|
17417
18135
|
description: "Management was transferred to another workspace.",
|
|
17418
18136
|
properties: {
|
|
17419
|
-
created_at: {
|
|
17420
|
-
|
|
18137
|
+
created_at: {
|
|
18138
|
+
description: "Date and time at which Seam created the warning.",
|
|
18139
|
+
format: "date-time",
|
|
18140
|
+
type: "string"
|
|
18141
|
+
},
|
|
18142
|
+
message: {
|
|
18143
|
+
description: "Detailed description of the warning. Provides insights into the issue and potentially how to rectify it.",
|
|
18144
|
+
type: "string"
|
|
18145
|
+
},
|
|
17421
18146
|
warning_code: {
|
|
17422
18147
|
description: "Unique identifier of the type of warning. Enables quick recognition and categorization of the issue.",
|
|
17423
18148
|
enum: ["management_transferred"],
|
|
@@ -17428,10 +18153,17 @@ var openapi_default = {
|
|
|
17428
18153
|
type: "object"
|
|
17429
18154
|
},
|
|
17430
18155
|
{
|
|
17431
|
-
description: "Unable to confirm the access code is set on Kwikset device.",
|
|
18156
|
+
description: "Unable to confirm that the access code is set on Kwikset device.",
|
|
17432
18157
|
properties: {
|
|
17433
|
-
created_at: {
|
|
17434
|
-
|
|
18158
|
+
created_at: {
|
|
18159
|
+
description: "Date and time at which Seam created the warning.",
|
|
18160
|
+
format: "date-time",
|
|
18161
|
+
type: "string"
|
|
18162
|
+
},
|
|
18163
|
+
message: {
|
|
18164
|
+
description: "Detailed description of the warning. Provides insights into the issue and potentially how to rectify it.",
|
|
18165
|
+
type: "string"
|
|
18166
|
+
},
|
|
17435
18167
|
warning_code: {
|
|
17436
18168
|
description: "Unique identifier of the type of warning. Enables quick recognition and categorization of the issue.",
|
|
17437
18169
|
enum: ["kwikset_unable_to_confirm_code"],
|
|
@@ -19306,40 +20038,85 @@ var openapi_default = {
|
|
|
19306
20038
|
paths: {
|
|
19307
20039
|
"/access_codes/create": {
|
|
19308
20040
|
post: {
|
|
20041
|
+
description: "Creates a new [access code](https://docs.seam.co/latest/capability-guides/smart-locks/access-codes).",
|
|
19309
20042
|
operationId: "accessCodesCreatePost",
|
|
19310
20043
|
requestBody: {
|
|
19311
20044
|
content: {
|
|
19312
20045
|
"application/json": {
|
|
19313
20046
|
schema: {
|
|
19314
20047
|
properties: {
|
|
19315
|
-
allow_external_modification: {
|
|
20048
|
+
allow_external_modification: {
|
|
20049
|
+
description: "Indicates whether [external modification](https://docs.seam.co/latest/api/access_codes#external-modification) of the code is allowed. Default: `false`.",
|
|
20050
|
+
type: "boolean"
|
|
20051
|
+
},
|
|
19316
20052
|
attempt_for_offline_device: {
|
|
19317
20053
|
default: true,
|
|
19318
20054
|
type: "boolean"
|
|
19319
20055
|
},
|
|
19320
20056
|
code: {
|
|
20057
|
+
description: "Code to be used for access.",
|
|
19321
20058
|
maxLength: 9,
|
|
19322
20059
|
minLength: 4,
|
|
19323
20060
|
pattern: "^\\d+$",
|
|
19324
20061
|
type: "string"
|
|
19325
20062
|
},
|
|
19326
|
-
common_code_key: {
|
|
19327
|
-
|
|
19328
|
-
|
|
19329
|
-
|
|
19330
|
-
|
|
19331
|
-
|
|
20063
|
+
common_code_key: {
|
|
20064
|
+
description: "Key to identify access codes that should have the same code. Any two access codes with the same `common_code_key` are guaranteed to have the same `code`. See also [Creating and Updating Multiple Linked Access Codes](https://docs.seam.co/latest/capability-guides/smart-locks/access-codes/creating-and-updating-multiple-linked-access-codes).",
|
|
20065
|
+
type: "string"
|
|
20066
|
+
},
|
|
20067
|
+
device_id: {
|
|
20068
|
+
description: "ID of the device for which to create the new access code.",
|
|
20069
|
+
format: "uuid",
|
|
20070
|
+
type: "string"
|
|
20071
|
+
},
|
|
20072
|
+
ends_at: {
|
|
20073
|
+
description: "Date and time at which the validity of the new access code ends, in [ISO 8601](https://www.iso.org/iso-8601-date-and-time-format.html) format. Must be a time in the future and after `starts_at`.",
|
|
20074
|
+
type: "string"
|
|
20075
|
+
},
|
|
20076
|
+
is_external_modification_allowed: {
|
|
20077
|
+
description: "Indicates whether [external modification](https://docs.seam.co/latest/api/access_codes#external-modification) of the code is allowed. Default: `false`.",
|
|
20078
|
+
type: "boolean"
|
|
20079
|
+
},
|
|
20080
|
+
is_offline_access_code: {
|
|
20081
|
+
description: "Indicates whether the access code is an [offline access code](https://docs.seam.co/latest/capability-guides/smart-locks/access-codes/offline-access-codes).",
|
|
20082
|
+
type: "boolean"
|
|
20083
|
+
},
|
|
20084
|
+
is_one_time_use: {
|
|
20085
|
+
description: "Indicates whether the [offline access code](https://docs.seam.co/latest/capability-guides/smart-locks/access-codes/offline-access-codes) is a single-use access code.",
|
|
20086
|
+
type: "boolean"
|
|
20087
|
+
},
|
|
19332
20088
|
max_time_rounding: {
|
|
19333
20089
|
default: "1hour",
|
|
20090
|
+
description: "Maximum rounding adjustment. To create a daily-bound [offline access code](https://docs.seam.co/latest/capability-guides/smart-locks/access-codes/offline-access-codes) for devices that support this feature, set this parameter to `1d`.",
|
|
19334
20091
|
enum: ["1hour", "1day", "1h", "1d"],
|
|
19335
20092
|
type: "string"
|
|
19336
20093
|
},
|
|
19337
|
-
name: {
|
|
19338
|
-
|
|
19339
|
-
|
|
19340
|
-
|
|
19341
|
-
|
|
19342
|
-
|
|
20094
|
+
name: {
|
|
20095
|
+
description: "Name of the new access code.",
|
|
20096
|
+
type: "string"
|
|
20097
|
+
},
|
|
20098
|
+
prefer_native_scheduling: {
|
|
20099
|
+
description: "Indicates whether [native scheduling](https://docs.seam.co/latest/capability-guides/smart-locks/access-codes#native-scheduling) should be used for time-bound codes when supported by the provider. Default: `true`.",
|
|
20100
|
+
type: "boolean"
|
|
20101
|
+
},
|
|
20102
|
+
preferred_code_length: {
|
|
20103
|
+
description: "Preferred code length. Only applicable if you do not specify a `code`. If the affected device does not support the preferred code length, Seam reverts to using the shortest supported code length.",
|
|
20104
|
+
format: "float",
|
|
20105
|
+
type: "number"
|
|
20106
|
+
},
|
|
20107
|
+
starts_at: {
|
|
20108
|
+
description: "Date and time at which the validity of the new access code starts, in [ISO 8601](https://www.iso.org/iso-8601-date-and-time-format.html) format.",
|
|
20109
|
+
type: "string"
|
|
20110
|
+
},
|
|
20111
|
+
sync: {
|
|
20112
|
+
default: false,
|
|
20113
|
+
type: "boolean",
|
|
20114
|
+
"x-undocumented": "Only used internally."
|
|
20115
|
+
},
|
|
20116
|
+
use_backup_access_code_pool: {
|
|
20117
|
+
description: "Indicates whether to use a [backup access code pool](https://docs.seam.co/latest/core-concepts/access-codes#backup-access-codes) provided by Seam. If `true`, you can use [`/access_codes/pull_backup_access_code`](https://docs.seam.co/latest/api-clients/access_codes/pull_backup_access_code).",
|
|
20118
|
+
type: "boolean"
|
|
20119
|
+
},
|
|
19343
20120
|
use_offline_access_code: { type: "boolean" }
|
|
19344
20121
|
},
|
|
19345
20122
|
required: ["device_id"],
|
|
@@ -19382,51 +20159,88 @@ var openapi_default = {
|
|
|
19382
20159
|
"x-fern-sdk-group-name": ["access_codes"],
|
|
19383
20160
|
"x-fern-sdk-method-name": "create",
|
|
19384
20161
|
"x-fern-sdk-return-value": "access_code",
|
|
19385
|
-
"x-response-key": "access_code"
|
|
20162
|
+
"x-response-key": "access_code",
|
|
20163
|
+
"x-title": "Create an Access Code"
|
|
19386
20164
|
}
|
|
19387
20165
|
},
|
|
19388
20166
|
"/access_codes/create_multiple": {
|
|
19389
20167
|
post: {
|
|
20168
|
+
description: "Creates new [access codes](https://docs.seam.co/latest/capability-guides/smart-locks/access-codes) that share a common code across multiple devices.\n\nUsers with more than one door lock in a property may want to create groups of linked access codes, all of which have the same code (PIN). For example, a short-term rental host may want to provide guests the same PIN for both a front door lock and a back door lock.\n\nIf you specify a custom code, Seam assigns this custom code to each of the resulting access codes. However, in this case, Seam does not link these access codes together with a `common_code_key`. That is, `common_code_key` remains null for these access codes.\n\nIf you want to change these access codes that are not linked by a `common_code_key`, you cannot use `/access_codes/update_multiple`. However, you can update each of these access codes individually, using `/access_codes/update`.\n\nSee also [Creating and Updating Multiple Linked Access Codes](https://docs.seam.co/latest/capability-guides/smart-locks/access-codes/creating-and-updating-multiple-linked-access-codes).",
|
|
19390
20169
|
operationId: "accessCodesCreateMultiplePost",
|
|
19391
20170
|
requestBody: {
|
|
19392
20171
|
content: {
|
|
19393
20172
|
"application/json": {
|
|
19394
20173
|
schema: {
|
|
19395
20174
|
properties: {
|
|
19396
|
-
allow_external_modification: {
|
|
20175
|
+
allow_external_modification: {
|
|
20176
|
+
description: "Indicates whether [external modification](https://docs.seam.co/latest/api/access_codes#external-modification) of the code is allowed. Default: `false`.",
|
|
20177
|
+
type: "boolean"
|
|
20178
|
+
},
|
|
19397
20179
|
attempt_for_offline_device: {
|
|
19398
20180
|
default: true,
|
|
19399
20181
|
type: "boolean"
|
|
19400
20182
|
},
|
|
19401
20183
|
behavior_when_code_cannot_be_shared: {
|
|
19402
20184
|
default: "throw",
|
|
20185
|
+
description: "Desired behavior if any device cannot share a code. If `throw` (default), no access codes will be created if any device cannot share a code. If `create_random_code`, a random code will be created on devices that cannot share a code.",
|
|
19403
20186
|
enum: ["throw", "create_random_code"],
|
|
19404
20187
|
type: "string"
|
|
19405
20188
|
},
|
|
19406
20189
|
code: {
|
|
20190
|
+
description: "Code to be used for access.",
|
|
19407
20191
|
maxLength: 9,
|
|
19408
20192
|
minLength: 4,
|
|
19409
20193
|
pattern: "^\\d+$",
|
|
19410
20194
|
type: "string"
|
|
19411
20195
|
},
|
|
19412
20196
|
device_ids: {
|
|
20197
|
+
description: "IDs of the devices for which to create the new access codes.",
|
|
19413
20198
|
items: { format: "uuid", type: "string" },
|
|
19414
20199
|
type: "array"
|
|
19415
20200
|
},
|
|
19416
|
-
ends_at: {
|
|
19417
|
-
|
|
19418
|
-
|
|
19419
|
-
|
|
20201
|
+
ends_at: {
|
|
20202
|
+
description: "Date and time at which the validity of the new access code ends, in [ISO 8601](https://www.iso.org/iso-8601-date-and-time-format.html) format. Must be a time in the future and after `starts_at`.",
|
|
20203
|
+
type: "string"
|
|
20204
|
+
},
|
|
20205
|
+
is_external_modification_allowed: {
|
|
20206
|
+
description: "Indicates whether [external modification](https://docs.seam.co/latest/api/access_codes#external-modification) of the code is allowed. Default: `false`.",
|
|
20207
|
+
type: "boolean"
|
|
20208
|
+
},
|
|
20209
|
+
is_offline_access_code: {
|
|
20210
|
+
description: "Indicates whether the access code is an [offline access code](https://docs.seam.co/latest/capability-guides/smart-locks/access-codes/offline-access-codes).",
|
|
20211
|
+
type: "boolean"
|
|
20212
|
+
},
|
|
20213
|
+
is_one_time_use: {
|
|
20214
|
+
description: "Indicates whether the [offline access code](https://docs.seam.co/latest/capability-guides/smart-locks/access-codes/offline-access-codes) is a single-use access code.",
|
|
20215
|
+
type: "boolean"
|
|
20216
|
+
},
|
|
19420
20217
|
max_time_rounding: {
|
|
19421
20218
|
default: "1hour",
|
|
20219
|
+
description: "Maximum rounding adjustment. To create a daily-bound [offline access code](https://docs.seam.co/latest/capability-guides/smart-locks/access-codes/offline-access-codes) for devices that support this feature, set this parameter to `1d`.",
|
|
19422
20220
|
enum: ["1hour", "1day", "1h", "1d"],
|
|
19423
20221
|
type: "string"
|
|
19424
20222
|
},
|
|
19425
|
-
name: {
|
|
19426
|
-
|
|
19427
|
-
|
|
19428
|
-
|
|
19429
|
-
|
|
20223
|
+
name: {
|
|
20224
|
+
description: "Name of the new access code.",
|
|
20225
|
+
type: "string"
|
|
20226
|
+
},
|
|
20227
|
+
prefer_native_scheduling: {
|
|
20228
|
+
description: "Indicates whether [native scheduling](https://docs.seam.co/latest/capability-guides/smart-locks/access-codes#native-scheduling) should be used for time-bound codes when supported by the provider. Default: `true`.",
|
|
20229
|
+
type: "boolean"
|
|
20230
|
+
},
|
|
20231
|
+
preferred_code_length: {
|
|
20232
|
+
description: "Preferred code length. Only applicable if you do not specify a `code`. If the affected device does not support the preferred code length, Seam reverts to using the shortest supported code length.",
|
|
20233
|
+
format: "float",
|
|
20234
|
+
type: "number"
|
|
20235
|
+
},
|
|
20236
|
+
starts_at: {
|
|
20237
|
+
description: "Date and time at which the validity of the new access code starts, in [ISO 8601](https://www.iso.org/iso-8601-date-and-time-format.html) format.",
|
|
20238
|
+
type: "string"
|
|
20239
|
+
},
|
|
20240
|
+
use_backup_access_code_pool: {
|
|
20241
|
+
description: "Indicates whether to use a [backup access code pool](https://docs.seam.co/latest/core-concepts/access-codes#backup-access-codes) provided by Seam. If `true`, you can use [`/access_codes/pull_backup_access_code`](https://docs.seam.co/latest/api-clients/access_codes/pull_backup_access_code).",
|
|
20242
|
+
type: "boolean"
|
|
20243
|
+
},
|
|
19430
20244
|
use_offline_access_code: { type: "boolean" }
|
|
19431
20245
|
},
|
|
19432
20246
|
required: ["device_ids"],
|
|
@@ -19468,49 +20282,86 @@ var openapi_default = {
|
|
|
19468
20282
|
"x-fern-sdk-group-name": ["access_codes"],
|
|
19469
20283
|
"x-fern-sdk-method-name": "create_multiple",
|
|
19470
20284
|
"x-fern-sdk-return-value": "access_codes",
|
|
19471
|
-
"x-response-key": "access_codes"
|
|
20285
|
+
"x-response-key": "access_codes",
|
|
20286
|
+
"x-title": "Create Multiple Linked Access Codes"
|
|
19472
20287
|
},
|
|
19473
20288
|
put: {
|
|
20289
|
+
description: "Creates new [access codes](https://docs.seam.co/latest/capability-guides/smart-locks/access-codes) that share a common code across multiple devices.\n\nUsers with more than one door lock in a property may want to create groups of linked access codes, all of which have the same code (PIN). For example, a short-term rental host may want to provide guests the same PIN for both a front door lock and a back door lock.\n\nIf you specify a custom code, Seam assigns this custom code to each of the resulting access codes. However, in this case, Seam does not link these access codes together with a `common_code_key`. That is, `common_code_key` remains null for these access codes.\n\nIf you want to change these access codes that are not linked by a `common_code_key`, you cannot use `/access_codes/update_multiple`. However, you can update each of these access codes individually, using `/access_codes/update`.\n\nSee also [Creating and Updating Multiple Linked Access Codes](https://docs.seam.co/latest/capability-guides/smart-locks/access-codes/creating-and-updating-multiple-linked-access-codes).",
|
|
19474
20290
|
operationId: "accessCodesCreateMultiplePut",
|
|
19475
20291
|
requestBody: {
|
|
19476
20292
|
content: {
|
|
19477
20293
|
"application/json": {
|
|
19478
20294
|
schema: {
|
|
19479
20295
|
properties: {
|
|
19480
|
-
allow_external_modification: {
|
|
20296
|
+
allow_external_modification: {
|
|
20297
|
+
description: "Indicates whether [external modification](https://docs.seam.co/latest/api/access_codes#external-modification) of the code is allowed. Default: `false`.",
|
|
20298
|
+
type: "boolean"
|
|
20299
|
+
},
|
|
19481
20300
|
attempt_for_offline_device: {
|
|
19482
20301
|
default: true,
|
|
19483
20302
|
type: "boolean"
|
|
19484
20303
|
},
|
|
19485
20304
|
behavior_when_code_cannot_be_shared: {
|
|
19486
20305
|
default: "throw",
|
|
20306
|
+
description: "Desired behavior if any device cannot share a code. If `throw` (default), no access codes will be created if any device cannot share a code. If `create_random_code`, a random code will be created on devices that cannot share a code.",
|
|
19487
20307
|
enum: ["throw", "create_random_code"],
|
|
19488
20308
|
type: "string"
|
|
19489
20309
|
},
|
|
19490
20310
|
code: {
|
|
20311
|
+
description: "Code to be used for access.",
|
|
19491
20312
|
maxLength: 9,
|
|
19492
20313
|
minLength: 4,
|
|
19493
20314
|
pattern: "^\\d+$",
|
|
19494
20315
|
type: "string"
|
|
19495
20316
|
},
|
|
19496
20317
|
device_ids: {
|
|
20318
|
+
description: "IDs of the devices for which to create the new access codes.",
|
|
19497
20319
|
items: { format: "uuid", type: "string" },
|
|
19498
20320
|
type: "array"
|
|
19499
20321
|
},
|
|
19500
|
-
ends_at: {
|
|
19501
|
-
|
|
19502
|
-
|
|
19503
|
-
|
|
20322
|
+
ends_at: {
|
|
20323
|
+
description: "Date and time at which the validity of the new access code ends, in [ISO 8601](https://www.iso.org/iso-8601-date-and-time-format.html) format. Must be a time in the future and after `starts_at`.",
|
|
20324
|
+
type: "string"
|
|
20325
|
+
},
|
|
20326
|
+
is_external_modification_allowed: {
|
|
20327
|
+
description: "Indicates whether [external modification](https://docs.seam.co/latest/api/access_codes#external-modification) of the code is allowed. Default: `false`.",
|
|
20328
|
+
type: "boolean"
|
|
20329
|
+
},
|
|
20330
|
+
is_offline_access_code: {
|
|
20331
|
+
description: "Indicates whether the access code is an [offline access code](https://docs.seam.co/latest/capability-guides/smart-locks/access-codes/offline-access-codes).",
|
|
20332
|
+
type: "boolean"
|
|
20333
|
+
},
|
|
20334
|
+
is_one_time_use: {
|
|
20335
|
+
description: "Indicates whether the [offline access code](https://docs.seam.co/latest/capability-guides/smart-locks/access-codes/offline-access-codes) is a single-use access code.",
|
|
20336
|
+
type: "boolean"
|
|
20337
|
+
},
|
|
19504
20338
|
max_time_rounding: {
|
|
19505
20339
|
default: "1hour",
|
|
20340
|
+
description: "Maximum rounding adjustment. To create a daily-bound [offline access code](https://docs.seam.co/latest/capability-guides/smart-locks/access-codes/offline-access-codes) for devices that support this feature, set this parameter to `1d`.",
|
|
19506
20341
|
enum: ["1hour", "1day", "1h", "1d"],
|
|
19507
20342
|
type: "string"
|
|
19508
20343
|
},
|
|
19509
|
-
name: {
|
|
19510
|
-
|
|
19511
|
-
|
|
19512
|
-
|
|
19513
|
-
|
|
20344
|
+
name: {
|
|
20345
|
+
description: "Name of the new access code.",
|
|
20346
|
+
type: "string"
|
|
20347
|
+
},
|
|
20348
|
+
prefer_native_scheduling: {
|
|
20349
|
+
description: "Indicates whether [native scheduling](https://docs.seam.co/latest/capability-guides/smart-locks/access-codes#native-scheduling) should be used for time-bound codes when supported by the provider. Default: `true`.",
|
|
20350
|
+
type: "boolean"
|
|
20351
|
+
},
|
|
20352
|
+
preferred_code_length: {
|
|
20353
|
+
description: "Preferred code length. Only applicable if you do not specify a `code`. If the affected device does not support the preferred code length, Seam reverts to using the shortest supported code length.",
|
|
20354
|
+
format: "float",
|
|
20355
|
+
type: "number"
|
|
20356
|
+
},
|
|
20357
|
+
starts_at: {
|
|
20358
|
+
description: "Date and time at which the validity of the new access code starts, in [ISO 8601](https://www.iso.org/iso-8601-date-and-time-format.html) format.",
|
|
20359
|
+
type: "string"
|
|
20360
|
+
},
|
|
20361
|
+
use_backup_access_code_pool: {
|
|
20362
|
+
description: "Indicates whether to use a [backup access code pool](https://docs.seam.co/latest/core-concepts/access-codes#backup-access-codes) provided by Seam. If `true`, you can use [`/access_codes/pull_backup_access_code`](https://docs.seam.co/latest/api-clients/access_codes/pull_backup_access_code).",
|
|
20363
|
+
type: "boolean"
|
|
20364
|
+
},
|
|
19514
20365
|
use_offline_access_code: { type: "boolean" }
|
|
19515
20366
|
},
|
|
19516
20367
|
required: ["device_ids"],
|
|
@@ -19550,20 +20401,34 @@ var openapi_default = {
|
|
|
19550
20401
|
summary: "/access_codes/create_multiple",
|
|
19551
20402
|
tags: ["/access_codes"],
|
|
19552
20403
|
"x-fern-ignore": true,
|
|
19553
|
-
"x-response-key": "access_codes"
|
|
20404
|
+
"x-response-key": "access_codes",
|
|
20405
|
+
"x-title": "Create Multiple Linked Access Codes"
|
|
19554
20406
|
}
|
|
19555
20407
|
},
|
|
19556
20408
|
"/access_codes/delete": {
|
|
19557
20409
|
post: {
|
|
20410
|
+
description: "Deletes an [access code](https://docs.seam.co/latest/capability-guides/smart-locks/access-codes).",
|
|
19558
20411
|
operationId: "accessCodesDeletePost",
|
|
19559
20412
|
requestBody: {
|
|
19560
20413
|
content: {
|
|
19561
20414
|
"application/json": {
|
|
19562
20415
|
schema: {
|
|
19563
20416
|
properties: {
|
|
19564
|
-
access_code_id: {
|
|
19565
|
-
|
|
19566
|
-
|
|
20417
|
+
access_code_id: {
|
|
20418
|
+
description: "ID of the access code to delete.",
|
|
20419
|
+
format: "uuid",
|
|
20420
|
+
type: "string"
|
|
20421
|
+
},
|
|
20422
|
+
device_id: {
|
|
20423
|
+
description: "ID of the device for which to delete the access code.",
|
|
20424
|
+
format: "uuid",
|
|
20425
|
+
type: "string"
|
|
20426
|
+
},
|
|
20427
|
+
sync: {
|
|
20428
|
+
default: false,
|
|
20429
|
+
type: "boolean",
|
|
20430
|
+
"x-undocumented": "Only used internally."
|
|
20431
|
+
}
|
|
19567
20432
|
},
|
|
19568
20433
|
required: ["access_code_id"],
|
|
19569
20434
|
type: "object"
|
|
@@ -19603,7 +20468,8 @@ var openapi_default = {
|
|
|
19603
20468
|
"x-action-attempt-type": "DELETE_ACCESS_CODE",
|
|
19604
20469
|
"x-fern-sdk-group-name": ["access_codes"],
|
|
19605
20470
|
"x-fern-sdk-method-name": "delete",
|
|
19606
|
-
"x-response-key": null
|
|
20471
|
+
"x-response-key": null,
|
|
20472
|
+
"x-title": "Delete an Access Code"
|
|
19607
20473
|
}
|
|
19608
20474
|
},
|
|
19609
20475
|
"/access_codes/generate_code": {
|
|
@@ -19657,15 +20523,27 @@ var openapi_default = {
|
|
|
19657
20523
|
},
|
|
19658
20524
|
"/access_codes/get": {
|
|
19659
20525
|
post: {
|
|
20526
|
+
description: "Returns a specified [access code](https://docs.seam.co/latest/capability-guides/smart-locks/access-codes).\n\nYou must specify either `access_code_id` or both `device_id` and `code`.",
|
|
19660
20527
|
operationId: "accessCodesGetPost",
|
|
19661
20528
|
requestBody: {
|
|
19662
20529
|
content: {
|
|
19663
20530
|
"application/json": {
|
|
19664
20531
|
schema: {
|
|
19665
20532
|
properties: {
|
|
19666
|
-
access_code_id: {
|
|
19667
|
-
|
|
19668
|
-
|
|
20533
|
+
access_code_id: {
|
|
20534
|
+
description: "ID of the access code that you want to get. You must specify either `access_code_id` or both `device_id` and `code`.",
|
|
20535
|
+
format: "uuid",
|
|
20536
|
+
type: "string"
|
|
20537
|
+
},
|
|
20538
|
+
code: {
|
|
20539
|
+
description: "Code of the access code that you want to get. You must specify either `access_code_id` or both `device_id` and `code`.",
|
|
20540
|
+
type: "string"
|
|
20541
|
+
},
|
|
20542
|
+
device_id: {
|
|
20543
|
+
description: "ID of the device containing the access code that you want to get. You must specify either `access_code_id` or both `device_id` and `code`.",
|
|
20544
|
+
format: "uuid",
|
|
20545
|
+
type: "string"
|
|
20546
|
+
}
|
|
19669
20547
|
},
|
|
19670
20548
|
type: "object"
|
|
19671
20549
|
}
|
|
@@ -19702,11 +20580,13 @@ var openapi_default = {
|
|
|
19702
20580
|
"x-fern-sdk-group-name": ["access_codes"],
|
|
19703
20581
|
"x-fern-sdk-method-name": "get",
|
|
19704
20582
|
"x-fern-sdk-return-value": "access_code",
|
|
19705
|
-
"x-response-key": "access_code"
|
|
20583
|
+
"x-response-key": "access_code",
|
|
20584
|
+
"x-title": "Get an Access Code"
|
|
19706
20585
|
}
|
|
19707
20586
|
},
|
|
19708
20587
|
"/access_codes/list": {
|
|
19709
20588
|
post: {
|
|
20589
|
+
description: "Returns a list of all [access codes](https://docs.seam.co/latest/capability-guides/smart-locks/access-codes).\n\nSpecify either `device_id` or `access_code_ids`.",
|
|
19710
20590
|
operationId: "accessCodesListPost",
|
|
19711
20591
|
requestBody: {
|
|
19712
20592
|
content: {
|
|
@@ -19714,11 +20594,19 @@ var openapi_default = {
|
|
|
19714
20594
|
schema: {
|
|
19715
20595
|
properties: {
|
|
19716
20596
|
access_code_ids: {
|
|
20597
|
+
description: "IDs of the access codes that you want to retrieve. Specify either `device_id` or `access_code_ids`.",
|
|
19717
20598
|
items: { format: "uuid", type: "string" },
|
|
19718
20599
|
type: "array"
|
|
19719
20600
|
},
|
|
19720
|
-
device_id: {
|
|
19721
|
-
|
|
20601
|
+
device_id: {
|
|
20602
|
+
description: "ID of the device for which you want to list access codes. Specify either `device_id` or `access_code_ids`.",
|
|
20603
|
+
format: "uuid",
|
|
20604
|
+
type: "string"
|
|
20605
|
+
},
|
|
20606
|
+
user_identifier_key: {
|
|
20607
|
+
description: "Your user ID for the user by which to filter access codes.",
|
|
20608
|
+
type: "string"
|
|
20609
|
+
}
|
|
19722
20610
|
},
|
|
19723
20611
|
type: "object"
|
|
19724
20612
|
}
|
|
@@ -19758,19 +20646,24 @@ var openapi_default = {
|
|
|
19758
20646
|
"x-fern-sdk-group-name": ["access_codes"],
|
|
19759
20647
|
"x-fern-sdk-method-name": "list",
|
|
19760
20648
|
"x-fern-sdk-return-value": "access_codes",
|
|
19761
|
-
"x-response-key": "access_codes"
|
|
20649
|
+
"x-response-key": "access_codes",
|
|
20650
|
+
"x-title": "List Access Codes"
|
|
19762
20651
|
}
|
|
19763
20652
|
},
|
|
19764
20653
|
"/access_codes/pull_backup_access_code": {
|
|
19765
20654
|
post: {
|
|
19766
|
-
description: "Retrieves a backup access code for an access code. See also [Managing Backup Access Codes](https://docs.seam.co/latest/capability-guides/smart-locks/access-codes/backup-access-codes).",
|
|
20655
|
+
description: "Retrieves a backup access code for an [access code](https://docs.seam.co/latest/capability-guides/smart-locks/access-codes). See also [Managing Backup Access Codes](https://docs.seam.co/latest/capability-guides/smart-locks/access-codes/backup-access-codes).\n\nA backup access code pool is a collection of pre-programmed access codes stored on a device, ready for use. These codes are programmed in addition to the regular access codes on Seam, serving as a safety net for any issues with the primary codes.\n\nIf there's ever a complication with a primary access code\u2014be it due to intermittent connectivity, manual removal from a device, or provider outages\u2014a backup code can be retrieved. Its end time can then be adjusted to align with the original code, facilitating seamless and uninterrupted access.\n\nYou can only pull backup access codes for time-bound access codes.\n\nBefore pulling a backup access code, make sure that the device's `properties.supports_backup_access_code_pool` is `true`. Then, to activate the backup pool, set `use_backup_access_code_pool` to `true` when creating an access code.",
|
|
19767
20656
|
operationId: "accessCodesPullBackupAccessCodePost",
|
|
19768
20657
|
requestBody: {
|
|
19769
20658
|
content: {
|
|
19770
20659
|
"application/json": {
|
|
19771
20660
|
schema: {
|
|
19772
20661
|
properties: {
|
|
19773
|
-
access_code_id: {
|
|
20662
|
+
access_code_id: {
|
|
20663
|
+
description: "ID of the access code for which you want to pull a backup access code.",
|
|
20664
|
+
format: "uuid",
|
|
20665
|
+
type: "string"
|
|
20666
|
+
}
|
|
19774
20667
|
},
|
|
19775
20668
|
required: ["access_code_id"],
|
|
19776
20669
|
type: "object"
|
|
@@ -19811,11 +20704,13 @@ var openapi_default = {
|
|
|
19811
20704
|
"x-fern-sdk-group-name": ["access_codes"],
|
|
19812
20705
|
"x-fern-sdk-method-name": "pull_backup_access_code",
|
|
19813
20706
|
"x-fern-sdk-return-value": "access_code",
|
|
19814
|
-
"x-response-key": "access_code"
|
|
20707
|
+
"x-response-key": "access_code",
|
|
20708
|
+
"x-title": "Pull a Backup Access Code"
|
|
19815
20709
|
}
|
|
19816
20710
|
},
|
|
19817
20711
|
"/access_codes/simulate/create_unmanaged_access_code": {
|
|
19818
20712
|
post: {
|
|
20713
|
+
description: "Simulates the creation of an [unmanaged access code](https://docs.seam.co/latest/capability-guides/smart-locks/access-codes/migrating-existing-access-codes) in a [sandbox workspace](https://docs.seam.co/latest/core-concepts/workspaces#sandbox-workspaces).",
|
|
19819
20714
|
operationId: "accessCodesSimulateCreateUnmanagedAccessCodePost",
|
|
19820
20715
|
requestBody: {
|
|
19821
20716
|
content: {
|
|
@@ -19823,13 +20718,21 @@ var openapi_default = {
|
|
|
19823
20718
|
schema: {
|
|
19824
20719
|
properties: {
|
|
19825
20720
|
code: {
|
|
20721
|
+
description: "Code of the simulated unmanaged access code.",
|
|
19826
20722
|
maxLength: 8,
|
|
19827
20723
|
minLength: 4,
|
|
19828
20724
|
pattern: "^\\d+$",
|
|
19829
20725
|
type: "string"
|
|
19830
20726
|
},
|
|
19831
|
-
device_id: {
|
|
19832
|
-
|
|
20727
|
+
device_id: {
|
|
20728
|
+
description: "ID of the device for which you want to simulate the creation of an unmanaged access code.",
|
|
20729
|
+
format: "uuid",
|
|
20730
|
+
type: "string"
|
|
20731
|
+
},
|
|
20732
|
+
name: {
|
|
20733
|
+
description: "Name of the simulated unmanaged access code.",
|
|
20734
|
+
type: "string"
|
|
20735
|
+
}
|
|
19833
20736
|
},
|
|
19834
20737
|
required: ["device_id", "name", "code"],
|
|
19835
20738
|
type: "object"
|
|
@@ -19869,22 +20772,41 @@ var openapi_default = {
|
|
|
19869
20772
|
"x-fern-sdk-group-name": ["access_codes", "simulate"],
|
|
19870
20773
|
"x-fern-sdk-method-name": "create_unmanaged_access_code",
|
|
19871
20774
|
"x-fern-sdk-return-value": "access_code",
|
|
19872
|
-
"x-response-key": "access_code"
|
|
20775
|
+
"x-response-key": "access_code",
|
|
20776
|
+
"x-title": "Simulate Creating an Unmanaged Access Code"
|
|
19873
20777
|
}
|
|
19874
20778
|
},
|
|
19875
20779
|
"/access_codes/unmanaged/convert_to_managed": {
|
|
19876
20780
|
patch: {
|
|
20781
|
+
description: "Converts an [unmanaged access code](https://docs.seam.co/latest/capability-guides/smart-locks/access-codes/migrating-existing-access-codes) to an [access code managed through Seam](https://docs.seam.co/latest/capability-guides/smart-locks/access-codes).\n\nAn unmanaged access code has a limited set of operations that you can perform on it. Once you convert an unmanaged access code to a managed access code, the full set of access code operations and lifecycle events becomes available for it.\n\nNote that not all device providers support converting an unmanaged access code to a managed access code.",
|
|
19877
20782
|
operationId: "accessCodesUnmanagedConvertToManagedPatch",
|
|
19878
20783
|
requestBody: {
|
|
19879
20784
|
content: {
|
|
19880
20785
|
"application/json": {
|
|
19881
20786
|
schema: {
|
|
19882
20787
|
properties: {
|
|
19883
|
-
access_code_id: {
|
|
19884
|
-
|
|
19885
|
-
|
|
19886
|
-
|
|
19887
|
-
|
|
20788
|
+
access_code_id: {
|
|
20789
|
+
description: "ID of the unmanaged access code that you want to convert to a managed access code.",
|
|
20790
|
+
format: "uuid",
|
|
20791
|
+
type: "string"
|
|
20792
|
+
},
|
|
20793
|
+
allow_external_modification: {
|
|
20794
|
+
description: "Indicates whether external modification of the access code is allowed.",
|
|
20795
|
+
type: "boolean"
|
|
20796
|
+
},
|
|
20797
|
+
force: {
|
|
20798
|
+
description: "Indicates whether to force the access code conversion. To switch management of an access code from one Seam workspace to another, set `force` to `true`.",
|
|
20799
|
+
type: "boolean"
|
|
20800
|
+
},
|
|
20801
|
+
is_external_modification_allowed: {
|
|
20802
|
+
description: "Indicates whether external modification of the access code is allowed.",
|
|
20803
|
+
type: "boolean"
|
|
20804
|
+
},
|
|
20805
|
+
sync: {
|
|
20806
|
+
default: false,
|
|
20807
|
+
type: "boolean",
|
|
20808
|
+
"x-undocumented": "Only used internally."
|
|
20809
|
+
}
|
|
19888
20810
|
},
|
|
19889
20811
|
required: ["access_code_id"],
|
|
19890
20812
|
type: "object"
|
|
@@ -19918,20 +20840,39 @@ var openapi_default = {
|
|
|
19918
20840
|
tags: ["/access_codes"],
|
|
19919
20841
|
"x-action-attempt-type": "CONVERT_ACCESS_CODE_TO_MANAGED",
|
|
19920
20842
|
"x-fern-ignore": true,
|
|
19921
|
-
"x-response-key": null
|
|
20843
|
+
"x-response-key": null,
|
|
20844
|
+
"x-title": "Convert an Unmanaged Access Code"
|
|
19922
20845
|
},
|
|
19923
20846
|
post: {
|
|
20847
|
+
description: "Converts an [unmanaged access code](https://docs.seam.co/latest/capability-guides/smart-locks/access-codes/migrating-existing-access-codes) to an [access code managed through Seam](https://docs.seam.co/latest/capability-guides/smart-locks/access-codes).\n\nAn unmanaged access code has a limited set of operations that you can perform on it. Once you convert an unmanaged access code to a managed access code, the full set of access code operations and lifecycle events becomes available for it.\n\nNote that not all device providers support converting an unmanaged access code to a managed access code.",
|
|
19924
20848
|
operationId: "accessCodesUnmanagedConvertToManagedPost",
|
|
19925
20849
|
requestBody: {
|
|
19926
20850
|
content: {
|
|
19927
20851
|
"application/json": {
|
|
19928
20852
|
schema: {
|
|
19929
20853
|
properties: {
|
|
19930
|
-
access_code_id: {
|
|
19931
|
-
|
|
19932
|
-
|
|
19933
|
-
|
|
19934
|
-
|
|
20854
|
+
access_code_id: {
|
|
20855
|
+
description: "ID of the unmanaged access code that you want to convert to a managed access code.",
|
|
20856
|
+
format: "uuid",
|
|
20857
|
+
type: "string"
|
|
20858
|
+
},
|
|
20859
|
+
allow_external_modification: {
|
|
20860
|
+
description: "Indicates whether external modification of the access code is allowed.",
|
|
20861
|
+
type: "boolean"
|
|
20862
|
+
},
|
|
20863
|
+
force: {
|
|
20864
|
+
description: "Indicates whether to force the access code conversion. To switch management of an access code from one Seam workspace to another, set `force` to `true`.",
|
|
20865
|
+
type: "boolean"
|
|
20866
|
+
},
|
|
20867
|
+
is_external_modification_allowed: {
|
|
20868
|
+
description: "Indicates whether external modification of the access code is allowed.",
|
|
20869
|
+
type: "boolean"
|
|
20870
|
+
},
|
|
20871
|
+
sync: {
|
|
20872
|
+
default: false,
|
|
20873
|
+
type: "boolean",
|
|
20874
|
+
"x-undocumented": "Only used internally."
|
|
20875
|
+
}
|
|
19935
20876
|
},
|
|
19936
20877
|
required: ["access_code_id"],
|
|
19937
20878
|
type: "object"
|
|
@@ -19966,19 +20907,29 @@ var openapi_default = {
|
|
|
19966
20907
|
"x-action-attempt-type": "CONVERT_ACCESS_CODE_TO_MANAGED",
|
|
19967
20908
|
"x-fern-sdk-group-name": ["access_codes", "unmanaged"],
|
|
19968
20909
|
"x-fern-sdk-method-name": "convert_to_managed",
|
|
19969
|
-
"x-response-key": null
|
|
20910
|
+
"x-response-key": null,
|
|
20911
|
+
"x-title": "Convert an Unmanaged Access Code"
|
|
19970
20912
|
}
|
|
19971
20913
|
},
|
|
19972
20914
|
"/access_codes/unmanaged/delete": {
|
|
19973
20915
|
post: {
|
|
20916
|
+
description: "Deletes an [unmanaged access code](https://docs.seam.co/latest/capability-guides/smart-locks/access-codes/migrating-existing-access-codes).",
|
|
19974
20917
|
operationId: "accessCodesUnmanagedDeletePost",
|
|
19975
20918
|
requestBody: {
|
|
19976
20919
|
content: {
|
|
19977
20920
|
"application/json": {
|
|
19978
20921
|
schema: {
|
|
19979
20922
|
properties: {
|
|
19980
|
-
access_code_id: {
|
|
19981
|
-
|
|
20923
|
+
access_code_id: {
|
|
20924
|
+
description: "ID of the unmanaged access code to delete.",
|
|
20925
|
+
format: "uuid",
|
|
20926
|
+
type: "string"
|
|
20927
|
+
},
|
|
20928
|
+
sync: {
|
|
20929
|
+
default: false,
|
|
20930
|
+
type: "boolean",
|
|
20931
|
+
"x-undocumented": "Only used internally."
|
|
20932
|
+
}
|
|
19982
20933
|
},
|
|
19983
20934
|
required: ["access_code_id"],
|
|
19984
20935
|
type: "object"
|
|
@@ -20018,20 +20969,33 @@ var openapi_default = {
|
|
|
20018
20969
|
"x-action-attempt-type": "DELETE_ACCESS_CODE",
|
|
20019
20970
|
"x-fern-sdk-group-name": ["access_codes", "unmanaged"],
|
|
20020
20971
|
"x-fern-sdk-method-name": "delete",
|
|
20021
|
-
"x-response-key": null
|
|
20972
|
+
"x-response-key": null,
|
|
20973
|
+
"x-title": "Delete an Unmanaged Access Code"
|
|
20022
20974
|
}
|
|
20023
20975
|
},
|
|
20024
20976
|
"/access_codes/unmanaged/get": {
|
|
20025
20977
|
post: {
|
|
20978
|
+
description: "Returns a specified [unmanaged access code](https://docs.seam.co/latest/capability-guides/smart-locks/access-codes/migrating-existing-access-codes).\n\nYou must specify either `access_code_id` or both `device_id` and `code`.",
|
|
20026
20979
|
operationId: "accessCodesUnmanagedGetPost",
|
|
20027
20980
|
requestBody: {
|
|
20028
20981
|
content: {
|
|
20029
20982
|
"application/json": {
|
|
20030
20983
|
schema: {
|
|
20031
20984
|
properties: {
|
|
20032
|
-
access_code_id: {
|
|
20033
|
-
|
|
20034
|
-
|
|
20985
|
+
access_code_id: {
|
|
20986
|
+
description: "ID of the unmanaged access code that you want to get. You must specify either `access_code_id` or both `device_id` and `code`.",
|
|
20987
|
+
format: "uuid",
|
|
20988
|
+
type: "string"
|
|
20989
|
+
},
|
|
20990
|
+
code: {
|
|
20991
|
+
description: "Code of the unmanaged access code that you want to get. You must specify either `access_code_id` or both `device_id` and `code`.",
|
|
20992
|
+
type: "string"
|
|
20993
|
+
},
|
|
20994
|
+
device_id: {
|
|
20995
|
+
description: "ID of the device containing the unmanaged access code that you want to get. You must specify either `access_code_id` or both `device_id` and `code`.",
|
|
20996
|
+
format: "uuid",
|
|
20997
|
+
type: "string"
|
|
20998
|
+
}
|
|
20035
20999
|
},
|
|
20036
21000
|
type: "object"
|
|
20037
21001
|
}
|
|
@@ -20070,19 +21034,28 @@ var openapi_default = {
|
|
|
20070
21034
|
"x-fern-sdk-group-name": ["access_codes", "unmanaged"],
|
|
20071
21035
|
"x-fern-sdk-method-name": "get",
|
|
20072
21036
|
"x-fern-sdk-return-value": "access_code",
|
|
20073
|
-
"x-response-key": "access_code"
|
|
21037
|
+
"x-response-key": "access_code",
|
|
21038
|
+
"x-title": "Get an Unmanaged Access Code"
|
|
20074
21039
|
}
|
|
20075
21040
|
},
|
|
20076
21041
|
"/access_codes/unmanaged/list": {
|
|
20077
21042
|
post: {
|
|
21043
|
+
description: "Returns a list of all [unmanaged access codes](https://docs.seam.co/latest/capability-guides/smart-locks/access-codes/migrating-existing-access-codes).",
|
|
20078
21044
|
operationId: "accessCodesUnmanagedListPost",
|
|
20079
21045
|
requestBody: {
|
|
20080
21046
|
content: {
|
|
20081
21047
|
"application/json": {
|
|
20082
21048
|
schema: {
|
|
20083
21049
|
properties: {
|
|
20084
|
-
device_id: {
|
|
20085
|
-
|
|
21050
|
+
device_id: {
|
|
21051
|
+
description: "ID of the device for which you want to list unmanaged access codes.",
|
|
21052
|
+
format: "uuid",
|
|
21053
|
+
type: "string"
|
|
21054
|
+
},
|
|
21055
|
+
user_identifier_key: {
|
|
21056
|
+
description: "Your user ID for the user by which to filter unmanaged access codes.",
|
|
21057
|
+
type: "string"
|
|
21058
|
+
}
|
|
20086
21059
|
},
|
|
20087
21060
|
required: ["device_id"],
|
|
20088
21061
|
type: "object"
|
|
@@ -20125,21 +21098,36 @@ var openapi_default = {
|
|
|
20125
21098
|
"x-fern-sdk-group-name": ["access_codes", "unmanaged"],
|
|
20126
21099
|
"x-fern-sdk-method-name": "list",
|
|
20127
21100
|
"x-fern-sdk-return-value": "access_codes",
|
|
20128
|
-
"x-response-key": "access_codes"
|
|
21101
|
+
"x-response-key": "access_codes",
|
|
21102
|
+
"x-title": "List Unmanaged Access Codes"
|
|
20129
21103
|
}
|
|
20130
21104
|
},
|
|
20131
21105
|
"/access_codes/unmanaged/update": {
|
|
20132
21106
|
patch: {
|
|
21107
|
+
description: "Updates a specified [unmanaged access code](https://docs.seam.co/latest/capability-guides/smart-locks/access-codes/migrating-existing-access-codes).",
|
|
20133
21108
|
operationId: "accessCodesUnmanagedUpdatePatch",
|
|
20134
21109
|
requestBody: {
|
|
20135
21110
|
content: {
|
|
20136
21111
|
"application/json": {
|
|
20137
21112
|
schema: {
|
|
20138
21113
|
properties: {
|
|
20139
|
-
access_code_id: {
|
|
20140
|
-
|
|
20141
|
-
|
|
20142
|
-
|
|
21114
|
+
access_code_id: {
|
|
21115
|
+
description: "ID of the unmanaged access code that you want to update.",
|
|
21116
|
+
format: "uuid",
|
|
21117
|
+
type: "string"
|
|
21118
|
+
},
|
|
21119
|
+
allow_external_modification: {
|
|
21120
|
+
description: "Indicates whether [external modification](https://docs.seam.co/latest/capability-guides/smart-locks/access-codes#external-modification) of the code is allowed.",
|
|
21121
|
+
type: "boolean"
|
|
21122
|
+
},
|
|
21123
|
+
force: {
|
|
21124
|
+
description: "Indicates whether to force the unmanaged access code update.",
|
|
21125
|
+
type: "boolean"
|
|
21126
|
+
},
|
|
21127
|
+
is_external_modification_allowed: {
|
|
21128
|
+
description: "Indicates whether [external modification](https://docs.seam.co/latest/capability-guides/smart-locks/access-codes#external-modification) of the code is allowed.",
|
|
21129
|
+
type: "boolean"
|
|
21130
|
+
},
|
|
20143
21131
|
is_managed: { type: "boolean" }
|
|
20144
21132
|
},
|
|
20145
21133
|
required: ["access_code_id", "is_managed"],
|
|
@@ -20173,19 +21161,34 @@ var openapi_default = {
|
|
|
20173
21161
|
summary: "/access_codes/unmanaged/update",
|
|
20174
21162
|
tags: ["/access_codes"],
|
|
20175
21163
|
"x-fern-ignore": true,
|
|
20176
|
-
"x-response-key": null
|
|
21164
|
+
"x-response-key": null,
|
|
21165
|
+
"x-title": "Update an Unmanaged Access Code"
|
|
20177
21166
|
},
|
|
20178
21167
|
post: {
|
|
21168
|
+
description: "Updates a specified [unmanaged access code](https://docs.seam.co/latest/capability-guides/smart-locks/access-codes/migrating-existing-access-codes).",
|
|
20179
21169
|
operationId: "accessCodesUnmanagedUpdatePost",
|
|
20180
21170
|
requestBody: {
|
|
20181
21171
|
content: {
|
|
20182
21172
|
"application/json": {
|
|
20183
21173
|
schema: {
|
|
20184
21174
|
properties: {
|
|
20185
|
-
access_code_id: {
|
|
20186
|
-
|
|
20187
|
-
|
|
20188
|
-
|
|
21175
|
+
access_code_id: {
|
|
21176
|
+
description: "ID of the unmanaged access code that you want to update.",
|
|
21177
|
+
format: "uuid",
|
|
21178
|
+
type: "string"
|
|
21179
|
+
},
|
|
21180
|
+
allow_external_modification: {
|
|
21181
|
+
description: "Indicates whether [external modification](https://docs.seam.co/latest/capability-guides/smart-locks/access-codes#external-modification) of the code is allowed.",
|
|
21182
|
+
type: "boolean"
|
|
21183
|
+
},
|
|
21184
|
+
force: {
|
|
21185
|
+
description: "Indicates whether to force the unmanaged access code update.",
|
|
21186
|
+
type: "boolean"
|
|
21187
|
+
},
|
|
21188
|
+
is_external_modification_allowed: {
|
|
21189
|
+
description: "Indicates whether [external modification](https://docs.seam.co/latest/capability-guides/smart-locks/access-codes#external-modification) of the code is allowed.",
|
|
21190
|
+
type: "boolean"
|
|
21191
|
+
},
|
|
20189
21192
|
is_managed: { type: "boolean" }
|
|
20190
21193
|
},
|
|
20191
21194
|
required: ["access_code_id", "is_managed"],
|
|
@@ -20220,47 +21223,101 @@ var openapi_default = {
|
|
|
20220
21223
|
tags: ["/access_codes"],
|
|
20221
21224
|
"x-fern-sdk-group-name": ["access_codes", "unmanaged"],
|
|
20222
21225
|
"x-fern-sdk-method-name": "update",
|
|
20223
|
-
"x-response-key": null
|
|
21226
|
+
"x-response-key": null,
|
|
21227
|
+
"x-title": "Update an Unmanaged Access Code"
|
|
20224
21228
|
}
|
|
20225
21229
|
},
|
|
20226
21230
|
"/access_codes/update": {
|
|
20227
21231
|
patch: {
|
|
21232
|
+
description: "Updates a specified active or upcoming [access code](https://docs.seam.co/latest/capability-guides/smart-locks/access-codes).\n\nSee also [Modifying Access Codes](https://docs.seam.co/latest/capability-guides/smart-locks/access-codes/modifying-access-codes).",
|
|
20228
21233
|
operationId: "accessCodesUpdatePatch",
|
|
20229
21234
|
requestBody: {
|
|
20230
21235
|
content: {
|
|
20231
21236
|
"application/json": {
|
|
20232
21237
|
schema: {
|
|
20233
21238
|
properties: {
|
|
20234
|
-
access_code_id: {
|
|
20235
|
-
|
|
21239
|
+
access_code_id: {
|
|
21240
|
+
description: "ID of the access code that you want to update.",
|
|
21241
|
+
format: "uuid",
|
|
21242
|
+
type: "string"
|
|
21243
|
+
},
|
|
21244
|
+
allow_external_modification: {
|
|
21245
|
+
description: "Indicates whether [external modification](https://docs.seam.co/latest/api/access_codes#external-modification) of the code is allowed. Default: `false`.",
|
|
21246
|
+
type: "boolean"
|
|
21247
|
+
},
|
|
20236
21248
|
attempt_for_offline_device: {
|
|
20237
21249
|
default: true,
|
|
20238
21250
|
type: "boolean"
|
|
20239
21251
|
},
|
|
20240
21252
|
code: {
|
|
21253
|
+
description: "Code to be used for access.",
|
|
20241
21254
|
maxLength: 9,
|
|
20242
21255
|
minLength: 4,
|
|
20243
21256
|
pattern: "^\\d+$",
|
|
20244
21257
|
type: "string"
|
|
20245
21258
|
},
|
|
20246
|
-
device_id: {
|
|
20247
|
-
|
|
20248
|
-
|
|
20249
|
-
|
|
20250
|
-
|
|
20251
|
-
|
|
21259
|
+
device_id: {
|
|
21260
|
+
description: "ID of the device containing the access code that you want to update.",
|
|
21261
|
+
format: "uuid",
|
|
21262
|
+
type: "string"
|
|
21263
|
+
},
|
|
21264
|
+
ends_at: {
|
|
21265
|
+
description: "Date and time at which the validity of the new access code ends, in [ISO 8601](https://www.iso.org/iso-8601-date-and-time-format.html) format. Must be a time in the future and after `starts_at`.",
|
|
21266
|
+
type: "string"
|
|
21267
|
+
},
|
|
21268
|
+
is_external_modification_allowed: {
|
|
21269
|
+
description: "Indicates whether [external modification](https://docs.seam.co/latest/api/access_codes#external-modification) of the code is allowed. Default: `false`.",
|
|
21270
|
+
type: "boolean"
|
|
21271
|
+
},
|
|
21272
|
+
is_managed: {
|
|
21273
|
+
description: "Indicates whether the access code is managed through Seam. Note that to convert an unmanaged access code into a managed access code, use `/access_codes/unmanaged/convert_to_managed`.",
|
|
21274
|
+
type: "boolean"
|
|
21275
|
+
},
|
|
21276
|
+
is_offline_access_code: {
|
|
21277
|
+
description: "Indicates whether the access code is an [offline access code](https://docs.seam.co/latest/capability-guides/smart-locks/access-codes/offline-access-codes).",
|
|
21278
|
+
type: "boolean"
|
|
21279
|
+
},
|
|
21280
|
+
is_one_time_use: {
|
|
21281
|
+
description: "Indicates whether the [offline access code](https://docs.seam.co/latest/capability-guides/smart-locks/access-codes/offline-access-codes) is a single-use access code.",
|
|
21282
|
+
type: "boolean"
|
|
21283
|
+
},
|
|
20252
21284
|
max_time_rounding: {
|
|
20253
21285
|
default: "1hour",
|
|
21286
|
+
description: "Maximum rounding adjustment. To create a daily-bound [offline access code](https://docs.seam.co/latest/capability-guides/smart-locks/access-codes/offline-access-codes) for devices that support this feature, set this parameter to `1d`.",
|
|
20254
21287
|
enum: ["1hour", "1day", "1h", "1d"],
|
|
20255
21288
|
type: "string"
|
|
20256
21289
|
},
|
|
20257
|
-
name: {
|
|
20258
|
-
|
|
20259
|
-
|
|
20260
|
-
|
|
20261
|
-
|
|
20262
|
-
|
|
20263
|
-
|
|
21290
|
+
name: {
|
|
21291
|
+
description: "Name of the new access code.",
|
|
21292
|
+
type: "string"
|
|
21293
|
+
},
|
|
21294
|
+
prefer_native_scheduling: {
|
|
21295
|
+
description: "Indicates whether [native scheduling](https://docs.seam.co/latest/capability-guides/smart-locks/access-codes#native-scheduling) should be used for time-bound codes when supported by the provider. Default: `true`.",
|
|
21296
|
+
type: "boolean"
|
|
21297
|
+
},
|
|
21298
|
+
preferred_code_length: {
|
|
21299
|
+
description: "Preferred code length. Only applicable if you do not specify a `code`. If the affected device does not support the preferred code length, Seam reverts to using the shortest supported code length.",
|
|
21300
|
+
format: "float",
|
|
21301
|
+
type: "number"
|
|
21302
|
+
},
|
|
21303
|
+
starts_at: {
|
|
21304
|
+
description: "Date and time at which the validity of the new access code starts, in [ISO 8601](https://www.iso.org/iso-8601-date-and-time-format.html) format.",
|
|
21305
|
+
type: "string"
|
|
21306
|
+
},
|
|
21307
|
+
sync: {
|
|
21308
|
+
default: false,
|
|
21309
|
+
type: "boolean",
|
|
21310
|
+
"x-undocumented": "Only used internally."
|
|
21311
|
+
},
|
|
21312
|
+
type: {
|
|
21313
|
+
description: "Type to which you want to convert the access code. To convert a time-bound access code to an ongoing access code, set `type` to `ongoing`. See also [Changing a time-bound access code to permanent access](https://docs.seam.co/latest/capability-guides/smart-locks/access-codes/modifying-access-codes#special-case-2-changing-a-time-bound-access-code-to-permanent-access).",
|
|
21314
|
+
enum: ["ongoing", "time_bound"],
|
|
21315
|
+
type: "string"
|
|
21316
|
+
},
|
|
21317
|
+
use_backup_access_code_pool: {
|
|
21318
|
+
description: "Indicates whether to use a [backup access code pool](https://docs.seam.co/latest/core-concepts/access-codes#backup-access-codes) provided by Seam. If `true`, you can use [`/access_codes/pull_backup_access_code`](https://docs.seam.co/latest/api-clients/access_codes/pull_backup_access_code).",
|
|
21319
|
+
type: "boolean"
|
|
21320
|
+
},
|
|
20264
21321
|
use_offline_access_code: { type: "boolean" }
|
|
20265
21322
|
},
|
|
20266
21323
|
required: ["access_code_id"],
|
|
@@ -20300,45 +21357,99 @@ var openapi_default = {
|
|
|
20300
21357
|
tags: ["/access_codes"],
|
|
20301
21358
|
"x-action-attempt-type": "UPDATE_ACCESS_CODE",
|
|
20302
21359
|
"x-fern-ignore": true,
|
|
20303
|
-
"x-response-key": null
|
|
21360
|
+
"x-response-key": null,
|
|
21361
|
+
"x-title": "Update an Access Code"
|
|
20304
21362
|
},
|
|
20305
21363
|
post: {
|
|
21364
|
+
description: "Updates a specified active or upcoming [access code](https://docs.seam.co/latest/capability-guides/smart-locks/access-codes).\n\nSee also [Modifying Access Codes](https://docs.seam.co/latest/capability-guides/smart-locks/access-codes/modifying-access-codes).",
|
|
20306
21365
|
operationId: "accessCodesUpdatePost",
|
|
20307
21366
|
requestBody: {
|
|
20308
21367
|
content: {
|
|
20309
21368
|
"application/json": {
|
|
20310
21369
|
schema: {
|
|
20311
21370
|
properties: {
|
|
20312
|
-
access_code_id: {
|
|
20313
|
-
|
|
21371
|
+
access_code_id: {
|
|
21372
|
+
description: "ID of the access code that you want to update.",
|
|
21373
|
+
format: "uuid",
|
|
21374
|
+
type: "string"
|
|
21375
|
+
},
|
|
21376
|
+
allow_external_modification: {
|
|
21377
|
+
description: "Indicates whether [external modification](https://docs.seam.co/latest/api/access_codes#external-modification) of the code is allowed. Default: `false`.",
|
|
21378
|
+
type: "boolean"
|
|
21379
|
+
},
|
|
20314
21380
|
attempt_for_offline_device: {
|
|
20315
21381
|
default: true,
|
|
20316
21382
|
type: "boolean"
|
|
20317
21383
|
},
|
|
20318
21384
|
code: {
|
|
21385
|
+
description: "Code to be used for access.",
|
|
20319
21386
|
maxLength: 9,
|
|
20320
21387
|
minLength: 4,
|
|
20321
21388
|
pattern: "^\\d+$",
|
|
20322
21389
|
type: "string"
|
|
20323
21390
|
},
|
|
20324
|
-
device_id: {
|
|
20325
|
-
|
|
20326
|
-
|
|
20327
|
-
|
|
20328
|
-
|
|
20329
|
-
|
|
21391
|
+
device_id: {
|
|
21392
|
+
description: "ID of the device containing the access code that you want to update.",
|
|
21393
|
+
format: "uuid",
|
|
21394
|
+
type: "string"
|
|
21395
|
+
},
|
|
21396
|
+
ends_at: {
|
|
21397
|
+
description: "Date and time at which the validity of the new access code ends, in [ISO 8601](https://www.iso.org/iso-8601-date-and-time-format.html) format. Must be a time in the future and after `starts_at`.",
|
|
21398
|
+
type: "string"
|
|
21399
|
+
},
|
|
21400
|
+
is_external_modification_allowed: {
|
|
21401
|
+
description: "Indicates whether [external modification](https://docs.seam.co/latest/api/access_codes#external-modification) of the code is allowed. Default: `false`.",
|
|
21402
|
+
type: "boolean"
|
|
21403
|
+
},
|
|
21404
|
+
is_managed: {
|
|
21405
|
+
description: "Indicates whether the access code is managed through Seam. Note that to convert an unmanaged access code into a managed access code, use `/access_codes/unmanaged/convert_to_managed`.",
|
|
21406
|
+
type: "boolean"
|
|
21407
|
+
},
|
|
21408
|
+
is_offline_access_code: {
|
|
21409
|
+
description: "Indicates whether the access code is an [offline access code](https://docs.seam.co/latest/capability-guides/smart-locks/access-codes/offline-access-codes).",
|
|
21410
|
+
type: "boolean"
|
|
21411
|
+
},
|
|
21412
|
+
is_one_time_use: {
|
|
21413
|
+
description: "Indicates whether the [offline access code](https://docs.seam.co/latest/capability-guides/smart-locks/access-codes/offline-access-codes) is a single-use access code.",
|
|
21414
|
+
type: "boolean"
|
|
21415
|
+
},
|
|
20330
21416
|
max_time_rounding: {
|
|
20331
21417
|
default: "1hour",
|
|
21418
|
+
description: "Maximum rounding adjustment. To create a daily-bound [offline access code](https://docs.seam.co/latest/capability-guides/smart-locks/access-codes/offline-access-codes) for devices that support this feature, set this parameter to `1d`.",
|
|
20332
21419
|
enum: ["1hour", "1day", "1h", "1d"],
|
|
20333
21420
|
type: "string"
|
|
20334
21421
|
},
|
|
20335
|
-
name: {
|
|
20336
|
-
|
|
20337
|
-
|
|
20338
|
-
|
|
20339
|
-
|
|
20340
|
-
|
|
20341
|
-
|
|
21422
|
+
name: {
|
|
21423
|
+
description: "Name of the new access code.",
|
|
21424
|
+
type: "string"
|
|
21425
|
+
},
|
|
21426
|
+
prefer_native_scheduling: {
|
|
21427
|
+
description: "Indicates whether [native scheduling](https://docs.seam.co/latest/capability-guides/smart-locks/access-codes#native-scheduling) should be used for time-bound codes when supported by the provider. Default: `true`.",
|
|
21428
|
+
type: "boolean"
|
|
21429
|
+
},
|
|
21430
|
+
preferred_code_length: {
|
|
21431
|
+
description: "Preferred code length. Only applicable if you do not specify a `code`. If the affected device does not support the preferred code length, Seam reverts to using the shortest supported code length.",
|
|
21432
|
+
format: "float",
|
|
21433
|
+
type: "number"
|
|
21434
|
+
},
|
|
21435
|
+
starts_at: {
|
|
21436
|
+
description: "Date and time at which the validity of the new access code starts, in [ISO 8601](https://www.iso.org/iso-8601-date-and-time-format.html) format.",
|
|
21437
|
+
type: "string"
|
|
21438
|
+
},
|
|
21439
|
+
sync: {
|
|
21440
|
+
default: false,
|
|
21441
|
+
type: "boolean",
|
|
21442
|
+
"x-undocumented": "Only used internally."
|
|
21443
|
+
},
|
|
21444
|
+
type: {
|
|
21445
|
+
description: "Type to which you want to convert the access code. To convert a time-bound access code to an ongoing access code, set `type` to `ongoing`. See also [Changing a time-bound access code to permanent access](https://docs.seam.co/latest/capability-guides/smart-locks/access-codes/modifying-access-codes#special-case-2-changing-a-time-bound-access-code-to-permanent-access).",
|
|
21446
|
+
enum: ["ongoing", "time_bound"],
|
|
21447
|
+
type: "string"
|
|
21448
|
+
},
|
|
21449
|
+
use_backup_access_code_pool: {
|
|
21450
|
+
description: "Indicates whether to use a [backup access code pool](https://docs.seam.co/latest/core-concepts/access-codes#backup-access-codes) provided by Seam. If `true`, you can use [`/access_codes/pull_backup_access_code`](https://docs.seam.co/latest/api-clients/access_codes/pull_backup_access_code).",
|
|
21451
|
+
type: "boolean"
|
|
21452
|
+
},
|
|
20342
21453
|
use_offline_access_code: { type: "boolean" }
|
|
20343
21454
|
},
|
|
20344
21455
|
required: ["access_code_id"],
|
|
@@ -20379,45 +21490,99 @@ var openapi_default = {
|
|
|
20379
21490
|
"x-action-attempt-type": "UPDATE_ACCESS_CODE",
|
|
20380
21491
|
"x-fern-sdk-group-name": ["access_codes"],
|
|
20381
21492
|
"x-fern-sdk-method-name": "update",
|
|
20382
|
-
"x-response-key": null
|
|
21493
|
+
"x-response-key": null,
|
|
21494
|
+
"x-title": "Update an Access Code"
|
|
20383
21495
|
},
|
|
20384
21496
|
put: {
|
|
21497
|
+
description: "Updates a specified active or upcoming [access code](https://docs.seam.co/latest/capability-guides/smart-locks/access-codes).\n\nSee also [Modifying Access Codes](https://docs.seam.co/latest/capability-guides/smart-locks/access-codes/modifying-access-codes).",
|
|
20385
21498
|
operationId: "accessCodesUpdatePut",
|
|
20386
21499
|
requestBody: {
|
|
20387
21500
|
content: {
|
|
20388
21501
|
"application/json": {
|
|
20389
21502
|
schema: {
|
|
20390
21503
|
properties: {
|
|
20391
|
-
access_code_id: {
|
|
20392
|
-
|
|
21504
|
+
access_code_id: {
|
|
21505
|
+
description: "ID of the access code that you want to update.",
|
|
21506
|
+
format: "uuid",
|
|
21507
|
+
type: "string"
|
|
21508
|
+
},
|
|
21509
|
+
allow_external_modification: {
|
|
21510
|
+
description: "Indicates whether [external modification](https://docs.seam.co/latest/api/access_codes#external-modification) of the code is allowed. Default: `false`.",
|
|
21511
|
+
type: "boolean"
|
|
21512
|
+
},
|
|
20393
21513
|
attempt_for_offline_device: {
|
|
20394
21514
|
default: true,
|
|
20395
21515
|
type: "boolean"
|
|
20396
21516
|
},
|
|
20397
21517
|
code: {
|
|
21518
|
+
description: "Code to be used for access.",
|
|
20398
21519
|
maxLength: 9,
|
|
20399
21520
|
minLength: 4,
|
|
20400
21521
|
pattern: "^\\d+$",
|
|
20401
21522
|
type: "string"
|
|
20402
21523
|
},
|
|
20403
|
-
device_id: {
|
|
20404
|
-
|
|
20405
|
-
|
|
20406
|
-
|
|
20407
|
-
|
|
20408
|
-
|
|
21524
|
+
device_id: {
|
|
21525
|
+
description: "ID of the device containing the access code that you want to update.",
|
|
21526
|
+
format: "uuid",
|
|
21527
|
+
type: "string"
|
|
21528
|
+
},
|
|
21529
|
+
ends_at: {
|
|
21530
|
+
description: "Date and time at which the validity of the new access code ends, in [ISO 8601](https://www.iso.org/iso-8601-date-and-time-format.html) format. Must be a time in the future and after `starts_at`.",
|
|
21531
|
+
type: "string"
|
|
21532
|
+
},
|
|
21533
|
+
is_external_modification_allowed: {
|
|
21534
|
+
description: "Indicates whether [external modification](https://docs.seam.co/latest/api/access_codes#external-modification) of the code is allowed. Default: `false`.",
|
|
21535
|
+
type: "boolean"
|
|
21536
|
+
},
|
|
21537
|
+
is_managed: {
|
|
21538
|
+
description: "Indicates whether the access code is managed through Seam. Note that to convert an unmanaged access code into a managed access code, use `/access_codes/unmanaged/convert_to_managed`.",
|
|
21539
|
+
type: "boolean"
|
|
21540
|
+
},
|
|
21541
|
+
is_offline_access_code: {
|
|
21542
|
+
description: "Indicates whether the access code is an [offline access code](https://docs.seam.co/latest/capability-guides/smart-locks/access-codes/offline-access-codes).",
|
|
21543
|
+
type: "boolean"
|
|
21544
|
+
},
|
|
21545
|
+
is_one_time_use: {
|
|
21546
|
+
description: "Indicates whether the [offline access code](https://docs.seam.co/latest/capability-guides/smart-locks/access-codes/offline-access-codes) is a single-use access code.",
|
|
21547
|
+
type: "boolean"
|
|
21548
|
+
},
|
|
20409
21549
|
max_time_rounding: {
|
|
20410
21550
|
default: "1hour",
|
|
21551
|
+
description: "Maximum rounding adjustment. To create a daily-bound [offline access code](https://docs.seam.co/latest/capability-guides/smart-locks/access-codes/offline-access-codes) for devices that support this feature, set this parameter to `1d`.",
|
|
20411
21552
|
enum: ["1hour", "1day", "1h", "1d"],
|
|
20412
21553
|
type: "string"
|
|
20413
21554
|
},
|
|
20414
|
-
name: {
|
|
20415
|
-
|
|
20416
|
-
|
|
20417
|
-
|
|
20418
|
-
|
|
20419
|
-
|
|
20420
|
-
|
|
21555
|
+
name: {
|
|
21556
|
+
description: "Name of the new access code.",
|
|
21557
|
+
type: "string"
|
|
21558
|
+
},
|
|
21559
|
+
prefer_native_scheduling: {
|
|
21560
|
+
description: "Indicates whether [native scheduling](https://docs.seam.co/latest/capability-guides/smart-locks/access-codes#native-scheduling) should be used for time-bound codes when supported by the provider. Default: `true`.",
|
|
21561
|
+
type: "boolean"
|
|
21562
|
+
},
|
|
21563
|
+
preferred_code_length: {
|
|
21564
|
+
description: "Preferred code length. Only applicable if you do not specify a `code`. If the affected device does not support the preferred code length, Seam reverts to using the shortest supported code length.",
|
|
21565
|
+
format: "float",
|
|
21566
|
+
type: "number"
|
|
21567
|
+
},
|
|
21568
|
+
starts_at: {
|
|
21569
|
+
description: "Date and time at which the validity of the new access code starts, in [ISO 8601](https://www.iso.org/iso-8601-date-and-time-format.html) format.",
|
|
21570
|
+
type: "string"
|
|
21571
|
+
},
|
|
21572
|
+
sync: {
|
|
21573
|
+
default: false,
|
|
21574
|
+
type: "boolean",
|
|
21575
|
+
"x-undocumented": "Only used internally."
|
|
21576
|
+
},
|
|
21577
|
+
type: {
|
|
21578
|
+
description: "Type to which you want to convert the access code. To convert a time-bound access code to an ongoing access code, set `type` to `ongoing`. See also [Changing a time-bound access code to permanent access](https://docs.seam.co/latest/capability-guides/smart-locks/access-codes/modifying-access-codes#special-case-2-changing-a-time-bound-access-code-to-permanent-access).",
|
|
21579
|
+
enum: ["ongoing", "time_bound"],
|
|
21580
|
+
type: "string"
|
|
21581
|
+
},
|
|
21582
|
+
use_backup_access_code_pool: {
|
|
21583
|
+
description: "Indicates whether to use a [backup access code pool](https://docs.seam.co/latest/core-concepts/access-codes#backup-access-codes) provided by Seam. If `true`, you can use [`/access_codes/pull_backup_access_code`](https://docs.seam.co/latest/api-clients/access_codes/pull_backup_access_code).",
|
|
21584
|
+
type: "boolean"
|
|
21585
|
+
},
|
|
20421
21586
|
use_offline_access_code: { type: "boolean" }
|
|
20422
21587
|
},
|
|
20423
21588
|
required: ["access_code_id"],
|
|
@@ -20457,21 +21622,35 @@ var openapi_default = {
|
|
|
20457
21622
|
tags: ["/access_codes"],
|
|
20458
21623
|
"x-action-attempt-type": "UPDATE_ACCESS_CODE",
|
|
20459
21624
|
"x-fern-ignore": true,
|
|
20460
|
-
"x-response-key": null
|
|
21625
|
+
"x-response-key": null,
|
|
21626
|
+
"x-title": "Update an Access Code"
|
|
20461
21627
|
}
|
|
20462
21628
|
},
|
|
20463
21629
|
"/access_codes/update_multiple": {
|
|
20464
21630
|
patch: {
|
|
21631
|
+
description: "Updates [access codes](https://docs.seam.co/latest/capability-guides/smart-locks/access-codes) that share a common code across multiple devices.\n\nSpecify the `common_code_key` to identify the set of access codes that you want to update.\n\nSee also [Update Linked Access Codes](https://docs.seam.co/latest/capability-guides/smart-locks/access-codes/creating-and-updating-multiple-linked-access-codes#update-linked-access-codes).",
|
|
20465
21632
|
operationId: "accessCodesUpdateMultiplePatch",
|
|
20466
21633
|
requestBody: {
|
|
20467
21634
|
content: {
|
|
20468
21635
|
"application/json": {
|
|
20469
21636
|
schema: {
|
|
20470
21637
|
properties: {
|
|
20471
|
-
common_code_key: {
|
|
20472
|
-
|
|
20473
|
-
|
|
20474
|
-
|
|
21638
|
+
common_code_key: {
|
|
21639
|
+
description: "Key that links the group of access codes, assigned on creation by `/access_codes/create_multiple`.",
|
|
21640
|
+
type: "string"
|
|
21641
|
+
},
|
|
21642
|
+
ends_at: {
|
|
21643
|
+
description: "Date and time at which the validity of the new access code ends, in [ISO 8601](https://www.iso.org/iso-8601-date-and-time-format.html) format. Must be a time in the future and after `starts_at`.",
|
|
21644
|
+
type: "string"
|
|
21645
|
+
},
|
|
21646
|
+
name: {
|
|
21647
|
+
description: "Name of the new access code.",
|
|
21648
|
+
type: "string"
|
|
21649
|
+
},
|
|
21650
|
+
starts_at: {
|
|
21651
|
+
description: "Date and time at which the validity of the new access code starts, in [ISO 8601](https://www.iso.org/iso-8601-date-and-time-format.html) format.",
|
|
21652
|
+
type: "string"
|
|
21653
|
+
}
|
|
20475
21654
|
},
|
|
20476
21655
|
required: ["common_code_key"],
|
|
20477
21656
|
type: "object"
|
|
@@ -20504,19 +21683,33 @@ var openapi_default = {
|
|
|
20504
21683
|
summary: "/access_codes/update_multiple",
|
|
20505
21684
|
tags: ["/access_codes"],
|
|
20506
21685
|
"x-fern-ignore": true,
|
|
20507
|
-
"x-response-key": null
|
|
21686
|
+
"x-response-key": null,
|
|
21687
|
+
"x-title": "Update Multiple Linked Access Codes"
|
|
20508
21688
|
},
|
|
20509
21689
|
post: {
|
|
21690
|
+
description: "Updates [access codes](https://docs.seam.co/latest/capability-guides/smart-locks/access-codes) that share a common code across multiple devices.\n\nSpecify the `common_code_key` to identify the set of access codes that you want to update.\n\nSee also [Update Linked Access Codes](https://docs.seam.co/latest/capability-guides/smart-locks/access-codes/creating-and-updating-multiple-linked-access-codes#update-linked-access-codes).",
|
|
20510
21691
|
operationId: "accessCodesUpdateMultiplePost",
|
|
20511
21692
|
requestBody: {
|
|
20512
21693
|
content: {
|
|
20513
21694
|
"application/json": {
|
|
20514
21695
|
schema: {
|
|
20515
21696
|
properties: {
|
|
20516
|
-
common_code_key: {
|
|
20517
|
-
|
|
20518
|
-
|
|
20519
|
-
|
|
21697
|
+
common_code_key: {
|
|
21698
|
+
description: "Key that links the group of access codes, assigned on creation by `/access_codes/create_multiple`.",
|
|
21699
|
+
type: "string"
|
|
21700
|
+
},
|
|
21701
|
+
ends_at: {
|
|
21702
|
+
description: "Date and time at which the validity of the new access code ends, in [ISO 8601](https://www.iso.org/iso-8601-date-and-time-format.html) format. Must be a time in the future and after `starts_at`.",
|
|
21703
|
+
type: "string"
|
|
21704
|
+
},
|
|
21705
|
+
name: {
|
|
21706
|
+
description: "Name of the new access code.",
|
|
21707
|
+
type: "string"
|
|
21708
|
+
},
|
|
21709
|
+
starts_at: {
|
|
21710
|
+
description: "Date and time at which the validity of the new access code starts, in [ISO 8601](https://www.iso.org/iso-8601-date-and-time-format.html) format.",
|
|
21711
|
+
type: "string"
|
|
21712
|
+
}
|
|
20520
21713
|
},
|
|
20521
21714
|
required: ["common_code_key"],
|
|
20522
21715
|
type: "object"
|
|
@@ -20550,7 +21743,8 @@ var openapi_default = {
|
|
|
20550
21743
|
tags: ["/access_codes"],
|
|
20551
21744
|
"x-fern-sdk-group-name": ["access_codes"],
|
|
20552
21745
|
"x-fern-sdk-method-name": "update_multiple",
|
|
20553
|
-
"x-response-key": null
|
|
21746
|
+
"x-response-key": null,
|
|
21747
|
+
"x-title": "Update Multiple Linked Access Codes"
|
|
20554
21748
|
}
|
|
20555
21749
|
},
|
|
20556
21750
|
"/acs/access_groups/add_user": {
|