@seamapi/types 1.376.0 → 1.378.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 +1669 -398
- package/dist/connect.cjs.map +1 -1
- package/dist/connect.d.cts +1461 -183
- 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/models/acs/acs-users/acs-user.d.ts +28 -28
- package/lib/seam/connect/models/acs/acs-users/pending-mutations.d.ts +195 -10
- package/lib/seam/connect/models/acs/acs-users/pending-mutations.js +16 -3
- package/lib/seam/connect/models/acs/acs-users/pending-mutations.js.map +1 -1
- package/lib/seam/connect/models/bridges/bridge-client-session.d.ts +80 -80
- package/lib/seam/connect/models/bridges/bridge-client-session.js +5 -0
- package/lib/seam/connect/models/bridges/bridge-client-session.js.map +1 -1
- package/lib/seam/connect/openapi.d.ts +295 -10
- package/lib/seam/connect/openapi.js +1587 -347
- package/lib/seam/connect/openapi.js.map +1 -1
- package/lib/seam/connect/route-types.d.ts +1113 -120
- 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/models/acs/acs-users/pending-mutations.ts +17 -3
- package/src/lib/seam/connect/models/bridges/bridge-client-session.ts +5 -0
- package/src/lib/seam/connect/openapi.ts +1923 -360
- package/src/lib/seam/connect/route-types.ts +1113 -120
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",
|
|
@@ -2397,10 +2421,14 @@ var updating_user_information_mutation = common_pending_mutation.extend({
|
|
|
2397
2421
|
from: acs_user_info.partial(),
|
|
2398
2422
|
to: acs_user_info.partial()
|
|
2399
2423
|
});
|
|
2424
|
+
var access_schedule = zod.z.object({
|
|
2425
|
+
starts_at: zod.z.string().datetime().nullable(),
|
|
2426
|
+
ends_at: zod.z.string().datetime().nullable()
|
|
2427
|
+
});
|
|
2400
2428
|
var updating_access_schedule_mutation = common_pending_mutation.extend({
|
|
2401
2429
|
mutation_code: zod.z.literal("updating_access_schedule"),
|
|
2402
|
-
from:
|
|
2403
|
-
to:
|
|
2430
|
+
from: access_schedule,
|
|
2431
|
+
to: access_schedule
|
|
2404
2432
|
});
|
|
2405
2433
|
var updating_suspension_state_mutation = common_pending_mutation.extend({
|
|
2406
2434
|
mutation_code: zod.z.literal("updating_suspension_state"),
|
|
@@ -2430,6 +2458,9 @@ var acs_user_pending_mutations = zod.z.discriminatedUnion(
|
|
|
2430
2458
|
zod.z.object({
|
|
2431
2459
|
creating: creating.optional().nullable(),
|
|
2432
2460
|
deleting: deleting.optional().nullable(),
|
|
2461
|
+
updating_access_schedule: updating_access_schedule_mutation.optional().nullable(),
|
|
2462
|
+
updating_group_membership: zod.z.map(zod.z.string().uuid(), updating_group_membership_mutation).optional().nullable(),
|
|
2463
|
+
updating_suspension_state: updating_suspension_state_mutation.optional().nullable(),
|
|
2433
2464
|
"updating_user_information.full_name": common_pending_mutation.extend({
|
|
2434
2465
|
mutation_code: zod.z.literal("updating_user_information"),
|
|
2435
2466
|
from: zod.z.object({
|
|
@@ -3027,11 +3058,11 @@ var common_bridge_client_session_error = zod.z.object({
|
|
|
3027
3058
|
var error_code_description6 = "Unique identifier of the type of error. Enables quick recognition and categorization of the issue.";
|
|
3028
3059
|
var bridge_lan_unreachable = common_bridge_client_session_error.extend({
|
|
3029
3060
|
error_code: zod.z.literal("bridge_lan_unreachable").describe(error_code_description6),
|
|
3030
|
-
is_tailscale_proxy_reachable: zod.z.boolean().describe("Seam cannot reach the tailscale proxy"),
|
|
3031
|
-
is_tailscale_proxy_socks_server_healthy: zod.z.boolean().describe("Tailscale proxy's SOCKS server is unhealthy"),
|
|
3032
|
-
can_tailscale_proxy_reach_tailscale_network: zod.z.boolean().describe("Tailscale proxy cannot reach the Tailscale network"),
|
|
3033
|
-
can_tailscale_proxy_reach_bridge: zod.z.boolean().describe("Tailscale proxy cannot reach the bridge"),
|
|
3034
|
-
is_bridge_socks_server_healthy: zod.z.boolean().describe("Bridge's SOCKS server is unhealthy")
|
|
3061
|
+
is_tailscale_proxy_reachable: zod.z.boolean().nullable().describe("Seam cannot reach the tailscale proxy"),
|
|
3062
|
+
is_tailscale_proxy_socks_server_healthy: zod.z.boolean().nullable().describe("Tailscale proxy's SOCKS server is unhealthy"),
|
|
3063
|
+
can_tailscale_proxy_reach_tailscale_network: zod.z.boolean().nullable().describe("Tailscale proxy cannot reach the Tailscale network"),
|
|
3064
|
+
can_tailscale_proxy_reach_bridge: zod.z.boolean().nullable().describe("Tailscale proxy cannot reach the bridge"),
|
|
3065
|
+
is_bridge_socks_server_healthy: zod.z.boolean().nullable().describe("Bridge's SOCKS server is unhealthy")
|
|
3035
3066
|
}).describe("Seam cannot reach the bridge's LAN");
|
|
3036
3067
|
var no_communication_from_bridge = common_bridge_client_session_error.extend({
|
|
3037
3068
|
error_code: zod.z.literal("no_communication_from_bridge").describe(error_code_description6)
|
|
@@ -4201,6 +4232,7 @@ var openapi_default = {
|
|
|
4201
4232
|
components: {
|
|
4202
4233
|
schemas: {
|
|
4203
4234
|
access_code: {
|
|
4235
|
+
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
4236
|
properties: {
|
|
4205
4237
|
access_code_id: {
|
|
4206
4238
|
description: "Unique identifier for the access code.",
|
|
@@ -4234,21 +4266,32 @@ var openapi_default = {
|
|
|
4234
4266
|
type: "string"
|
|
4235
4267
|
},
|
|
4236
4268
|
errors: {
|
|
4237
|
-
description:
|
|
4269
|
+
description: "Errors associated with the [access code](https://docs.seam.co/latest/capability-guides/smart-locks/access-codes).",
|
|
4238
4270
|
items: {
|
|
4239
4271
|
discriminator: { propertyName: "error_code" },
|
|
4240
4272
|
oneOf: [
|
|
4241
4273
|
{
|
|
4242
|
-
description: "Failed to set code on
|
|
4274
|
+
description: "Failed to set code on SmartThings device.",
|
|
4243
4275
|
properties: {
|
|
4244
|
-
created_at: {
|
|
4276
|
+
created_at: {
|
|
4277
|
+
description: "Date and time at which Seam created the error.",
|
|
4278
|
+
format: "date-time",
|
|
4279
|
+
type: "string"
|
|
4280
|
+
},
|
|
4245
4281
|
error_code: {
|
|
4246
4282
|
description: "Unique identifier of the type of error. Enables quick recognition and categorization of the issue.",
|
|
4247
4283
|
enum: ["smartthings_failed_to_set_access_code"],
|
|
4248
4284
|
type: "string"
|
|
4249
4285
|
},
|
|
4250
|
-
is_access_code_error: {
|
|
4251
|
-
|
|
4286
|
+
is_access_code_error: {
|
|
4287
|
+
description: "Indicates that this is an access code error.",
|
|
4288
|
+
enum: [true],
|
|
4289
|
+
type: "boolean"
|
|
4290
|
+
},
|
|
4291
|
+
message: {
|
|
4292
|
+
description: "Detailed description of the error. Provides insights into the issue and potentially how to rectify it.",
|
|
4293
|
+
type: "string"
|
|
4294
|
+
}
|
|
4252
4295
|
},
|
|
4253
4296
|
required: ["message", "is_access_code_error", "error_code"],
|
|
4254
4297
|
type: "object"
|
|
@@ -4256,7 +4299,11 @@ var openapi_default = {
|
|
|
4256
4299
|
{
|
|
4257
4300
|
description: "Failed to set code after multiple retries.",
|
|
4258
4301
|
properties: {
|
|
4259
|
-
created_at: {
|
|
4302
|
+
created_at: {
|
|
4303
|
+
description: "Date and time at which Seam created the error.",
|
|
4304
|
+
format: "date-time",
|
|
4305
|
+
type: "string"
|
|
4306
|
+
},
|
|
4260
4307
|
error_code: {
|
|
4261
4308
|
description: "Unique identifier of the type of error. Enables quick recognition and categorization of the issue.",
|
|
4262
4309
|
enum: [
|
|
@@ -4264,8 +4311,15 @@ var openapi_default = {
|
|
|
4264
4311
|
],
|
|
4265
4312
|
type: "string"
|
|
4266
4313
|
},
|
|
4267
|
-
is_access_code_error: {
|
|
4268
|
-
|
|
4314
|
+
is_access_code_error: {
|
|
4315
|
+
description: "Indicates that this is an access code error.",
|
|
4316
|
+
enum: [true],
|
|
4317
|
+
type: "boolean"
|
|
4318
|
+
},
|
|
4319
|
+
message: {
|
|
4320
|
+
description: "Detailed description of the error. Provides insights into the issue and potentially how to rectify it.",
|
|
4321
|
+
type: "string"
|
|
4322
|
+
}
|
|
4269
4323
|
},
|
|
4270
4324
|
required: ["message", "is_access_code_error", "error_code"],
|
|
4271
4325
|
type: "object"
|
|
@@ -4273,14 +4327,25 @@ var openapi_default = {
|
|
|
4273
4327
|
{
|
|
4274
4328
|
description: "No free slots available on the device.",
|
|
4275
4329
|
properties: {
|
|
4276
|
-
created_at: {
|
|
4330
|
+
created_at: {
|
|
4331
|
+
description: "Date and time at which Seam created the error.",
|
|
4332
|
+
format: "date-time",
|
|
4333
|
+
type: "string"
|
|
4334
|
+
},
|
|
4277
4335
|
error_code: {
|
|
4278
4336
|
description: "Unique identifier of the type of error. Enables quick recognition and categorization of the issue.",
|
|
4279
4337
|
enum: ["smartthings_no_free_slots_available"],
|
|
4280
4338
|
type: "string"
|
|
4281
4339
|
},
|
|
4282
|
-
is_access_code_error: {
|
|
4283
|
-
|
|
4340
|
+
is_access_code_error: {
|
|
4341
|
+
description: "Indicates that this is an access code error.",
|
|
4342
|
+
enum: [true],
|
|
4343
|
+
type: "boolean"
|
|
4344
|
+
},
|
|
4345
|
+
message: {
|
|
4346
|
+
description: "Detailed description of the error. Provides insights into the issue and potentially how to rectify it.",
|
|
4347
|
+
type: "string"
|
|
4348
|
+
}
|
|
4284
4349
|
},
|
|
4285
4350
|
required: ["message", "is_access_code_error", "error_code"],
|
|
4286
4351
|
type: "object"
|
|
@@ -4288,14 +4353,25 @@ var openapi_default = {
|
|
|
4288
4353
|
{
|
|
4289
4354
|
description: "Failed to set code on device.",
|
|
4290
4355
|
properties: {
|
|
4291
|
-
created_at: {
|
|
4356
|
+
created_at: {
|
|
4357
|
+
description: "Date and time at which Seam created the error.",
|
|
4358
|
+
format: "date-time",
|
|
4359
|
+
type: "string"
|
|
4360
|
+
},
|
|
4292
4361
|
error_code: {
|
|
4293
4362
|
description: "Unique identifier of the type of error. Enables quick recognition and categorization of the issue.",
|
|
4294
4363
|
enum: ["failed_to_set_on_device"],
|
|
4295
4364
|
type: "string"
|
|
4296
4365
|
},
|
|
4297
|
-
is_access_code_error: {
|
|
4298
|
-
|
|
4366
|
+
is_access_code_error: {
|
|
4367
|
+
description: "Indicates that this is an access code error.",
|
|
4368
|
+
enum: [true],
|
|
4369
|
+
type: "boolean"
|
|
4370
|
+
},
|
|
4371
|
+
message: {
|
|
4372
|
+
description: "Detailed description of the error. Provides insights into the issue and potentially how to rectify it.",
|
|
4373
|
+
type: "string"
|
|
4374
|
+
}
|
|
4299
4375
|
},
|
|
4300
4376
|
required: ["message", "is_access_code_error", "error_code"],
|
|
4301
4377
|
type: "object"
|
|
@@ -4303,14 +4379,25 @@ var openapi_default = {
|
|
|
4303
4379
|
{
|
|
4304
4380
|
description: "Failed to remove code from device.",
|
|
4305
4381
|
properties: {
|
|
4306
|
-
created_at: {
|
|
4382
|
+
created_at: {
|
|
4383
|
+
description: "Date and time at which Seam created the error.",
|
|
4384
|
+
format: "date-time",
|
|
4385
|
+
type: "string"
|
|
4386
|
+
},
|
|
4307
4387
|
error_code: {
|
|
4308
4388
|
description: "Unique identifier of the type of error. Enables quick recognition and categorization of the issue.",
|
|
4309
4389
|
enum: ["failed_to_remove_from_device"],
|
|
4310
4390
|
type: "string"
|
|
4311
4391
|
},
|
|
4312
|
-
is_access_code_error: {
|
|
4313
|
-
|
|
4392
|
+
is_access_code_error: {
|
|
4393
|
+
description: "Indicates that this is an access code error.",
|
|
4394
|
+
enum: [true],
|
|
4395
|
+
type: "boolean"
|
|
4396
|
+
},
|
|
4397
|
+
message: {
|
|
4398
|
+
description: "Detailed description of the error. Provides insights into the issue and potentially how to rectify it.",
|
|
4399
|
+
type: "string"
|
|
4400
|
+
}
|
|
4314
4401
|
},
|
|
4315
4402
|
required: ["message", "is_access_code_error", "error_code"],
|
|
4316
4403
|
type: "object"
|
|
@@ -4318,14 +4405,25 @@ var openapi_default = {
|
|
|
4318
4405
|
{
|
|
4319
4406
|
description: "Duplicate access code detected on device.",
|
|
4320
4407
|
properties: {
|
|
4321
|
-
created_at: {
|
|
4408
|
+
created_at: {
|
|
4409
|
+
description: "Date and time at which Seam created the error.",
|
|
4410
|
+
format: "date-time",
|
|
4411
|
+
type: "string"
|
|
4412
|
+
},
|
|
4322
4413
|
error_code: {
|
|
4323
4414
|
description: "Unique identifier of the type of error. Enables quick recognition and categorization of the issue.",
|
|
4324
4415
|
enum: ["duplicate_code_on_device"],
|
|
4325
4416
|
type: "string"
|
|
4326
4417
|
},
|
|
4327
|
-
is_access_code_error: {
|
|
4328
|
-
|
|
4418
|
+
is_access_code_error: {
|
|
4419
|
+
description: "Indicates that this is an access code error.",
|
|
4420
|
+
enum: [true],
|
|
4421
|
+
type: "boolean"
|
|
4422
|
+
},
|
|
4423
|
+
message: {
|
|
4424
|
+
description: "Detailed description of the error. Provides insights into the issue and potentially how to rectify it.",
|
|
4425
|
+
type: "string"
|
|
4426
|
+
}
|
|
4329
4427
|
},
|
|
4330
4428
|
required: ["message", "is_access_code_error", "error_code"],
|
|
4331
4429
|
type: "object"
|
|
@@ -4333,14 +4431,25 @@ var openapi_default = {
|
|
|
4333
4431
|
{
|
|
4334
4432
|
description: "An attempt to modify this access code was prevented.",
|
|
4335
4433
|
properties: {
|
|
4336
|
-
created_at: {
|
|
4434
|
+
created_at: {
|
|
4435
|
+
description: "Date and time at which Seam created the error.",
|
|
4436
|
+
format: "date-time",
|
|
4437
|
+
type: "string"
|
|
4438
|
+
},
|
|
4337
4439
|
error_code: {
|
|
4338
4440
|
description: "Unique identifier of the type of error. Enables quick recognition and categorization of the issue.",
|
|
4339
4441
|
enum: ["duplicate_code_attempt_prevented"],
|
|
4340
4442
|
type: "string"
|
|
4341
4443
|
},
|
|
4342
|
-
is_access_code_error: {
|
|
4343
|
-
|
|
4444
|
+
is_access_code_error: {
|
|
4445
|
+
description: "Indicates that this is an access code error.",
|
|
4446
|
+
enum: [true],
|
|
4447
|
+
type: "boolean"
|
|
4448
|
+
},
|
|
4449
|
+
message: {
|
|
4450
|
+
description: "Detailed description of the error. Provides insights into the issue and potentially how to rectify it.",
|
|
4451
|
+
type: "string"
|
|
4452
|
+
}
|
|
4344
4453
|
},
|
|
4345
4454
|
required: ["message", "is_access_code_error", "error_code"],
|
|
4346
4455
|
type: "object"
|
|
@@ -4348,14 +4457,25 @@ var openapi_default = {
|
|
|
4348
4457
|
{
|
|
4349
4458
|
description: "Igloohome bridge has too many pending jobs in the queue.",
|
|
4350
4459
|
properties: {
|
|
4351
|
-
created_at: {
|
|
4460
|
+
created_at: {
|
|
4461
|
+
description: "Date and time at which Seam created the error.",
|
|
4462
|
+
format: "date-time",
|
|
4463
|
+
type: "string"
|
|
4464
|
+
},
|
|
4352
4465
|
error_code: {
|
|
4353
4466
|
description: "Unique identifier of the type of error. Enables quick recognition and categorization of the issue.",
|
|
4354
4467
|
enum: ["igloohome_bridge_too_many_pending_jobs"],
|
|
4355
4468
|
type: "string"
|
|
4356
4469
|
},
|
|
4357
|
-
is_access_code_error: {
|
|
4358
|
-
|
|
4470
|
+
is_access_code_error: {
|
|
4471
|
+
description: "Indicates that this is an access code error.",
|
|
4472
|
+
enum: [true],
|
|
4473
|
+
type: "boolean"
|
|
4474
|
+
},
|
|
4475
|
+
message: {
|
|
4476
|
+
description: "Detailed description of the error. Provides insights into the issue and potentially how to rectify it.",
|
|
4477
|
+
type: "string"
|
|
4478
|
+
}
|
|
4359
4479
|
},
|
|
4360
4480
|
required: ["message", "is_access_code_error", "error_code"],
|
|
4361
4481
|
type: "object"
|
|
@@ -4363,22 +4483,37 @@ var openapi_default = {
|
|
|
4363
4483
|
{
|
|
4364
4484
|
description: "Igloohome bridge is offline.",
|
|
4365
4485
|
properties: {
|
|
4366
|
-
created_at: {
|
|
4486
|
+
created_at: {
|
|
4487
|
+
description: "Date and time at which Seam created the error.",
|
|
4488
|
+
format: "date-time",
|
|
4489
|
+
type: "string"
|
|
4490
|
+
},
|
|
4367
4491
|
error_code: {
|
|
4368
4492
|
description: "Unique identifier of the type of error. Enables quick recognition and categorization of the issue.",
|
|
4369
4493
|
enum: ["igloohome_bridge_offline"],
|
|
4370
4494
|
type: "string"
|
|
4371
4495
|
},
|
|
4372
|
-
is_access_code_error: {
|
|
4373
|
-
|
|
4496
|
+
is_access_code_error: {
|
|
4497
|
+
description: "Indicates that this is an access code error.",
|
|
4498
|
+
enum: [true],
|
|
4499
|
+
type: "boolean"
|
|
4500
|
+
},
|
|
4501
|
+
message: {
|
|
4502
|
+
description: "Detailed description of the error. Provides insights into the issue and potentially how to rectify it.",
|
|
4503
|
+
type: "string"
|
|
4504
|
+
}
|
|
4374
4505
|
},
|
|
4375
4506
|
required: ["message", "is_access_code_error", "error_code"],
|
|
4376
4507
|
type: "object"
|
|
4377
4508
|
},
|
|
4378
4509
|
{
|
|
4379
|
-
description: "Lock
|
|
4510
|
+
description: "Lock has reached maximum amount of codes.",
|
|
4380
4511
|
properties: {
|
|
4381
|
-
created_at: {
|
|
4512
|
+
created_at: {
|
|
4513
|
+
description: "Date and time at which Seam created the error.",
|
|
4514
|
+
format: "date-time",
|
|
4515
|
+
type: "string"
|
|
4516
|
+
},
|
|
4382
4517
|
error_code: {
|
|
4383
4518
|
description: "Unique identifier of the type of error. Enables quick recognition and categorization of the issue.",
|
|
4384
4519
|
enum: [
|
|
@@ -4386,23 +4521,41 @@ var openapi_default = {
|
|
|
4386
4521
|
],
|
|
4387
4522
|
type: "string"
|
|
4388
4523
|
},
|
|
4389
|
-
is_access_code_error: {
|
|
4390
|
-
|
|
4524
|
+
is_access_code_error: {
|
|
4525
|
+
description: "Indicates that this is an access code error.",
|
|
4526
|
+
enum: [true],
|
|
4527
|
+
type: "boolean"
|
|
4528
|
+
},
|
|
4529
|
+
message: {
|
|
4530
|
+
description: "Detailed description of the error. Provides insights into the issue and potentially how to rectify it.",
|
|
4531
|
+
type: "string"
|
|
4532
|
+
}
|
|
4391
4533
|
},
|
|
4392
4534
|
required: ["message", "is_access_code_error", "error_code"],
|
|
4393
4535
|
type: "object"
|
|
4394
4536
|
},
|
|
4395
4537
|
{
|
|
4396
|
-
description: "Unable to confirm the access code is set on Kwikset device.",
|
|
4538
|
+
description: "Unable to confirm that the access code is set on Kwikset device.",
|
|
4397
4539
|
properties: {
|
|
4398
|
-
created_at: {
|
|
4540
|
+
created_at: {
|
|
4541
|
+
description: "Date and time at which Seam created the error.",
|
|
4542
|
+
format: "date-time",
|
|
4543
|
+
type: "string"
|
|
4544
|
+
},
|
|
4399
4545
|
error_code: {
|
|
4400
4546
|
description: "Unique identifier of the type of error. Enables quick recognition and categorization of the issue.",
|
|
4401
4547
|
enum: ["kwikset_unable_to_confirm_code"],
|
|
4402
4548
|
type: "string"
|
|
4403
4549
|
},
|
|
4404
|
-
is_access_code_error: {
|
|
4405
|
-
|
|
4550
|
+
is_access_code_error: {
|
|
4551
|
+
description: "Indicates that this is an access code error.",
|
|
4552
|
+
enum: [true],
|
|
4553
|
+
type: "boolean"
|
|
4554
|
+
},
|
|
4555
|
+
message: {
|
|
4556
|
+
description: "Detailed description of the error. Provides insights into the issue and potentially how to rectify it.",
|
|
4557
|
+
type: "string"
|
|
4558
|
+
}
|
|
4406
4559
|
},
|
|
4407
4560
|
required: ["message", "is_access_code_error", "error_code"],
|
|
4408
4561
|
type: "object"
|
|
@@ -4410,14 +4563,25 @@ var openapi_default = {
|
|
|
4410
4563
|
{
|
|
4411
4564
|
description: "Unable to confirm the deletion of the access code on Kwikset device.",
|
|
4412
4565
|
properties: {
|
|
4413
|
-
created_at: {
|
|
4566
|
+
created_at: {
|
|
4567
|
+
description: "Date and time at which Seam created the error.",
|
|
4568
|
+
format: "date-time",
|
|
4569
|
+
type: "string"
|
|
4570
|
+
},
|
|
4414
4571
|
error_code: {
|
|
4415
4572
|
description: "Unique identifier of the type of error. Enables quick recognition and categorization of the issue.",
|
|
4416
4573
|
enum: ["kwikset_unable_to_confirm_deletion"],
|
|
4417
4574
|
type: "string"
|
|
4418
4575
|
},
|
|
4419
|
-
is_access_code_error: {
|
|
4420
|
-
|
|
4576
|
+
is_access_code_error: {
|
|
4577
|
+
description: "Indicates that this is an access code error.",
|
|
4578
|
+
enum: [true],
|
|
4579
|
+
type: "boolean"
|
|
4580
|
+
},
|
|
4581
|
+
message: {
|
|
4582
|
+
description: "Detailed description of the error. Provides insights into the issue and potentially how to rectify it.",
|
|
4583
|
+
type: "string"
|
|
4584
|
+
}
|
|
4421
4585
|
},
|
|
4422
4586
|
required: ["message", "is_access_code_error", "error_code"],
|
|
4423
4587
|
type: "object"
|
|
@@ -4425,14 +4589,25 @@ var openapi_default = {
|
|
|
4425
4589
|
{
|
|
4426
4590
|
description: "Code was modified or removed externally after Seam successfully set it on the device.",
|
|
4427
4591
|
properties: {
|
|
4428
|
-
created_at: {
|
|
4592
|
+
created_at: {
|
|
4593
|
+
description: "Date and time at which Seam created the error.",
|
|
4594
|
+
format: "date-time",
|
|
4595
|
+
type: "string"
|
|
4596
|
+
},
|
|
4429
4597
|
error_code: {
|
|
4430
4598
|
description: "Unique identifier of the type of error. Enables quick recognition and categorization of the issue.",
|
|
4431
4599
|
enum: ["code_modified_external_to_seam"],
|
|
4432
4600
|
type: "string"
|
|
4433
4601
|
},
|
|
4434
|
-
is_access_code_error: {
|
|
4435
|
-
|
|
4602
|
+
is_access_code_error: {
|
|
4603
|
+
description: "Indicates that this is an access code error.",
|
|
4604
|
+
enum: [true],
|
|
4605
|
+
type: "boolean"
|
|
4606
|
+
},
|
|
4607
|
+
message: {
|
|
4608
|
+
description: "Detailed description of the error. Provides insights into the issue and potentially how to rectify it.",
|
|
4609
|
+
type: "string"
|
|
4610
|
+
}
|
|
4436
4611
|
},
|
|
4437
4612
|
required: ["message", "is_access_code_error", "error_code"],
|
|
4438
4613
|
type: "object"
|
|
@@ -4440,14 +4615,25 @@ var openapi_default = {
|
|
|
4440
4615
|
{
|
|
4441
4616
|
description: "Invalid code length for August lock.",
|
|
4442
4617
|
properties: {
|
|
4443
|
-
created_at: {
|
|
4618
|
+
created_at: {
|
|
4619
|
+
description: "Date and time at which Seam created the error.",
|
|
4620
|
+
format: "date-time",
|
|
4621
|
+
type: "string"
|
|
4622
|
+
},
|
|
4444
4623
|
error_code: {
|
|
4445
4624
|
description: "Unique identifier of the type of error. Enables quick recognition and categorization of the issue.",
|
|
4446
4625
|
enum: ["august_lock_invalid_code_length"],
|
|
4447
4626
|
type: "string"
|
|
4448
4627
|
},
|
|
4449
|
-
is_access_code_error: {
|
|
4450
|
-
|
|
4628
|
+
is_access_code_error: {
|
|
4629
|
+
description: "Indicates that this is an access code error.",
|
|
4630
|
+
enum: [true],
|
|
4631
|
+
type: "boolean"
|
|
4632
|
+
},
|
|
4633
|
+
message: {
|
|
4634
|
+
description: "Detailed description of the error. Provides insights into the issue and potentially how to rectify it.",
|
|
4635
|
+
type: "string"
|
|
4636
|
+
}
|
|
4451
4637
|
},
|
|
4452
4638
|
required: ["message", "is_access_code_error", "error_code"],
|
|
4453
4639
|
type: "object"
|
|
@@ -4455,14 +4641,25 @@ var openapi_default = {
|
|
|
4455
4641
|
{
|
|
4456
4642
|
description: "Access code has not yet been fully moved to the device.",
|
|
4457
4643
|
properties: {
|
|
4458
|
-
created_at: {
|
|
4644
|
+
created_at: {
|
|
4645
|
+
description: "Date and time at which Seam created the error.",
|
|
4646
|
+
format: "date-time",
|
|
4647
|
+
type: "string"
|
|
4648
|
+
},
|
|
4459
4649
|
error_code: {
|
|
4460
4650
|
description: "Unique identifier of the type of error. Enables quick recognition and categorization of the issue.",
|
|
4461
4651
|
enum: ["august_device_programming_delay"],
|
|
4462
4652
|
type: "string"
|
|
4463
4653
|
},
|
|
4464
|
-
is_access_code_error: {
|
|
4465
|
-
|
|
4654
|
+
is_access_code_error: {
|
|
4655
|
+
description: "Indicates that this is an access code error.",
|
|
4656
|
+
enum: [true],
|
|
4657
|
+
type: "boolean"
|
|
4658
|
+
},
|
|
4659
|
+
message: {
|
|
4660
|
+
description: "Detailed description of the error. Provides insights into the issue and potentially how to rectify it.",
|
|
4661
|
+
type: "string"
|
|
4662
|
+
}
|
|
4466
4663
|
},
|
|
4467
4664
|
required: ["message", "is_access_code_error", "error_code"],
|
|
4468
4665
|
type: "object"
|
|
@@ -4470,14 +4667,25 @@ var openapi_default = {
|
|
|
4470
4667
|
{
|
|
4471
4668
|
description: "All access code slots on the device are full.",
|
|
4472
4669
|
properties: {
|
|
4473
|
-
created_at: {
|
|
4670
|
+
created_at: {
|
|
4671
|
+
description: "Date and time at which Seam created the error.",
|
|
4672
|
+
format: "date-time",
|
|
4673
|
+
type: "string"
|
|
4674
|
+
},
|
|
4474
4675
|
error_code: {
|
|
4475
4676
|
description: "Unique identifier of the type of error. Enables quick recognition and categorization of the issue.",
|
|
4476
4677
|
enum: ["august_device_slots_full"],
|
|
4477
4678
|
type: "string"
|
|
4478
4679
|
},
|
|
4479
|
-
is_access_code_error: {
|
|
4480
|
-
|
|
4680
|
+
is_access_code_error: {
|
|
4681
|
+
description: "Indicates that this is an access code error.",
|
|
4682
|
+
enum: [true],
|
|
4683
|
+
type: "boolean"
|
|
4684
|
+
},
|
|
4685
|
+
message: {
|
|
4686
|
+
description: "Detailed description of the error. Provides insights into the issue and potentially how to rectify it.",
|
|
4687
|
+
type: "string"
|
|
4688
|
+
}
|
|
4481
4689
|
},
|
|
4482
4690
|
required: ["message", "is_access_code_error", "error_code"],
|
|
4483
4691
|
type: "object"
|
|
@@ -4485,14 +4693,25 @@ var openapi_default = {
|
|
|
4485
4693
|
{
|
|
4486
4694
|
description: "August lock is missing a keypad.",
|
|
4487
4695
|
properties: {
|
|
4488
|
-
created_at: {
|
|
4696
|
+
created_at: {
|
|
4697
|
+
description: "Date and time at which Seam created the error.",
|
|
4698
|
+
format: "date-time",
|
|
4699
|
+
type: "string"
|
|
4700
|
+
},
|
|
4489
4701
|
error_code: {
|
|
4490
4702
|
description: "Unique identifier of the type of error. Enables quick recognition and categorization of the issue.",
|
|
4491
4703
|
enum: ["august_lock_missing_keypad"],
|
|
4492
4704
|
type: "string"
|
|
4493
4705
|
},
|
|
4494
|
-
is_access_code_error: {
|
|
4495
|
-
|
|
4706
|
+
is_access_code_error: {
|
|
4707
|
+
description: "Indicates that this is an access code error.",
|
|
4708
|
+
enum: [true],
|
|
4709
|
+
type: "boolean"
|
|
4710
|
+
},
|
|
4711
|
+
message: {
|
|
4712
|
+
description: "Detailed description of the error. Provides insights into the issue and potentially how to rectify it.",
|
|
4713
|
+
type: "string"
|
|
4714
|
+
}
|
|
4496
4715
|
},
|
|
4497
4716
|
required: ["message", "is_access_code_error", "error_code"],
|
|
4498
4717
|
type: "object"
|
|
@@ -4500,14 +4719,25 @@ var openapi_default = {
|
|
|
4500
4719
|
{
|
|
4501
4720
|
description: "August lock is temporarily offline.",
|
|
4502
4721
|
properties: {
|
|
4503
|
-
created_at: {
|
|
4722
|
+
created_at: {
|
|
4723
|
+
description: "Date and time at which Seam created the error.",
|
|
4724
|
+
format: "date-time",
|
|
4725
|
+
type: "string"
|
|
4726
|
+
},
|
|
4504
4727
|
error_code: {
|
|
4505
4728
|
description: "Unique identifier of the type of error. Enables quick recognition and categorization of the issue.",
|
|
4506
4729
|
enum: ["august_lock_temporarily_offline"],
|
|
4507
4730
|
type: "string"
|
|
4508
4731
|
},
|
|
4509
|
-
is_access_code_error: {
|
|
4510
|
-
|
|
4732
|
+
is_access_code_error: {
|
|
4733
|
+
description: "Indicates that this is an access code error.",
|
|
4734
|
+
enum: [true],
|
|
4735
|
+
type: "boolean"
|
|
4736
|
+
},
|
|
4737
|
+
message: {
|
|
4738
|
+
description: "Detailed description of the error. Provides insights into the issue and potentially how to rectify it.",
|
|
4739
|
+
type: "string"
|
|
4740
|
+
}
|
|
4511
4741
|
},
|
|
4512
4742
|
required: ["message", "is_access_code_error", "error_code"],
|
|
4513
4743
|
type: "object"
|
|
@@ -4515,14 +4745,25 @@ var openapi_default = {
|
|
|
4515
4745
|
{
|
|
4516
4746
|
description: "Salto site user is not subscribed.",
|
|
4517
4747
|
properties: {
|
|
4518
|
-
created_at: {
|
|
4748
|
+
created_at: {
|
|
4749
|
+
description: "Date and time at which Seam created the error.",
|
|
4750
|
+
format: "date-time",
|
|
4751
|
+
type: "string"
|
|
4752
|
+
},
|
|
4519
4753
|
error_code: {
|
|
4520
4754
|
description: "Unique identifier of the type of error. Enables quick recognition and categorization of the issue.",
|
|
4521
4755
|
enum: ["salto_ks_user_not_subscribed"],
|
|
4522
4756
|
type: "string"
|
|
4523
4757
|
},
|
|
4524
|
-
is_access_code_error: {
|
|
4525
|
-
|
|
4758
|
+
is_access_code_error: {
|
|
4759
|
+
description: "Indicates that this is an access code error.",
|
|
4760
|
+
enum: [true],
|
|
4761
|
+
type: "boolean"
|
|
4762
|
+
},
|
|
4763
|
+
message: {
|
|
4764
|
+
description: "Detailed description of the error. Provides insights into the issue and potentially how to rectify it.",
|
|
4765
|
+
type: "string"
|
|
4766
|
+
}
|
|
4526
4767
|
},
|
|
4527
4768
|
required: ["message", "is_access_code_error", "error_code"],
|
|
4528
4769
|
type: "object"
|
|
@@ -4530,14 +4771,25 @@ var openapi_default = {
|
|
|
4530
4771
|
{
|
|
4531
4772
|
description: "Access code has not yet been fully moved to the device.",
|
|
4532
4773
|
properties: {
|
|
4533
|
-
created_at: {
|
|
4774
|
+
created_at: {
|
|
4775
|
+
description: "Date and time at which Seam created the error.",
|
|
4776
|
+
format: "date-time",
|
|
4777
|
+
type: "string"
|
|
4778
|
+
},
|
|
4534
4779
|
error_code: {
|
|
4535
4780
|
description: "Unique identifier of the type of error. Enables quick recognition and categorization of the issue.",
|
|
4536
4781
|
enum: ["hubitat_device_programming_delay"],
|
|
4537
4782
|
type: "string"
|
|
4538
4783
|
},
|
|
4539
|
-
is_access_code_error: {
|
|
4540
|
-
|
|
4784
|
+
is_access_code_error: {
|
|
4785
|
+
description: "Indicates that this is an access code error.",
|
|
4786
|
+
enum: [true],
|
|
4787
|
+
type: "boolean"
|
|
4788
|
+
},
|
|
4789
|
+
message: {
|
|
4790
|
+
description: "Detailed description of the error. Provides insights into the issue and potentially how to rectify it.",
|
|
4791
|
+
type: "string"
|
|
4792
|
+
}
|
|
4541
4793
|
},
|
|
4542
4794
|
required: ["message", "is_access_code_error", "error_code"],
|
|
4543
4795
|
type: "object"
|
|
@@ -4545,14 +4797,25 @@ var openapi_default = {
|
|
|
4545
4797
|
{
|
|
4546
4798
|
description: "No free positions available on the device.",
|
|
4547
4799
|
properties: {
|
|
4548
|
-
created_at: {
|
|
4800
|
+
created_at: {
|
|
4801
|
+
description: "Date and time at which Seam created the error.",
|
|
4802
|
+
format: "date-time",
|
|
4803
|
+
type: "string"
|
|
4804
|
+
},
|
|
4549
4805
|
error_code: {
|
|
4550
4806
|
description: "Unique identifier of the type of error. Enables quick recognition and categorization of the issue.",
|
|
4551
4807
|
enum: ["hubitat_no_free_positions_available"],
|
|
4552
4808
|
type: "string"
|
|
4553
4809
|
},
|
|
4554
|
-
is_access_code_error: {
|
|
4555
|
-
|
|
4810
|
+
is_access_code_error: {
|
|
4811
|
+
description: "Indicates that this is an access code error.",
|
|
4812
|
+
enum: [true],
|
|
4813
|
+
type: "boolean"
|
|
4814
|
+
},
|
|
4815
|
+
message: {
|
|
4816
|
+
description: "Detailed description of the error. Provides insights into the issue and potentially how to rectify it.",
|
|
4817
|
+
type: "string"
|
|
4818
|
+
}
|
|
4556
4819
|
},
|
|
4557
4820
|
required: ["message", "is_access_code_error", "error_code"],
|
|
4558
4821
|
type: "object"
|
|
@@ -4560,14 +4823,25 @@ var openapi_default = {
|
|
|
4560
4823
|
{
|
|
4561
4824
|
description: "Duplicate access code name detected.",
|
|
4562
4825
|
properties: {
|
|
4563
|
-
created_at: {
|
|
4826
|
+
created_at: {
|
|
4827
|
+
description: "Date and time at which Seam created the error.",
|
|
4828
|
+
format: "date-time",
|
|
4829
|
+
type: "string"
|
|
4830
|
+
},
|
|
4564
4831
|
error_code: {
|
|
4565
4832
|
description: "Unique identifier of the type of error. Enables quick recognition and categorization of the issue.",
|
|
4566
4833
|
enum: ["wyze_duplicate_code_name"],
|
|
4567
4834
|
type: "string"
|
|
4568
4835
|
},
|
|
4569
|
-
is_access_code_error: {
|
|
4570
|
-
|
|
4836
|
+
is_access_code_error: {
|
|
4837
|
+
description: "Indicates that this is an access code error.",
|
|
4838
|
+
enum: [true],
|
|
4839
|
+
type: "boolean"
|
|
4840
|
+
},
|
|
4841
|
+
message: {
|
|
4842
|
+
description: "Detailed description of the error. Provides insights into the issue and potentially how to rectify it.",
|
|
4843
|
+
type: "string"
|
|
4844
|
+
}
|
|
4571
4845
|
},
|
|
4572
4846
|
required: ["message", "is_access_code_error", "error_code"],
|
|
4573
4847
|
type: "object"
|
|
@@ -4575,14 +4849,25 @@ var openapi_default = {
|
|
|
4575
4849
|
{
|
|
4576
4850
|
description: "Potential duplicate access code detected.",
|
|
4577
4851
|
properties: {
|
|
4578
|
-
created_at: {
|
|
4852
|
+
created_at: {
|
|
4853
|
+
description: "Date and time at which Seam created the error.",
|
|
4854
|
+
format: "date-time",
|
|
4855
|
+
type: "string"
|
|
4856
|
+
},
|
|
4579
4857
|
error_code: {
|
|
4580
4858
|
description: "Unique identifier of the type of error. Enables quick recognition and categorization of the issue.",
|
|
4581
4859
|
enum: ["wyze_potential_duplicate_code"],
|
|
4582
4860
|
type: "string"
|
|
4583
4861
|
},
|
|
4584
|
-
is_access_code_error: {
|
|
4585
|
-
|
|
4862
|
+
is_access_code_error: {
|
|
4863
|
+
description: "Indicates that this is an access code error.",
|
|
4864
|
+
enum: [true],
|
|
4865
|
+
type: "boolean"
|
|
4866
|
+
},
|
|
4867
|
+
message: {
|
|
4868
|
+
description: "Detailed description of the error. Provides insights into the issue and potentially how to rectify it.",
|
|
4869
|
+
type: "string"
|
|
4870
|
+
}
|
|
4586
4871
|
},
|
|
4587
4872
|
required: ["message", "is_access_code_error", "error_code"],
|
|
4588
4873
|
type: "object"
|
|
@@ -4590,14 +4875,25 @@ var openapi_default = {
|
|
|
4590
4875
|
{
|
|
4591
4876
|
description: "No valid user level for Oracode.",
|
|
4592
4877
|
properties: {
|
|
4593
|
-
created_at: {
|
|
4878
|
+
created_at: {
|
|
4879
|
+
description: "Date and time at which Seam created the error.",
|
|
4880
|
+
format: "date-time",
|
|
4881
|
+
type: "string"
|
|
4882
|
+
},
|
|
4594
4883
|
error_code: {
|
|
4595
4884
|
description: "Unique identifier of the type of error. Enables quick recognition and categorization of the issue.",
|
|
4596
4885
|
enum: ["dormakaba_oracode_no_valid_user_level"],
|
|
4597
4886
|
type: "string"
|
|
4598
4887
|
},
|
|
4599
|
-
is_access_code_error: {
|
|
4600
|
-
|
|
4888
|
+
is_access_code_error: {
|
|
4889
|
+
description: "Indicates that this is an access code error.",
|
|
4890
|
+
enum: [true],
|
|
4891
|
+
type: "boolean"
|
|
4892
|
+
},
|
|
4893
|
+
message: {
|
|
4894
|
+
description: "Detailed description of the error. Provides insights into the issue and potentially how to rectify it.",
|
|
4895
|
+
type: "string"
|
|
4896
|
+
}
|
|
4601
4897
|
},
|
|
4602
4898
|
required: ["message", "is_access_code_error", "error_code"],
|
|
4603
4899
|
type: "object"
|
|
@@ -4934,11 +5230,11 @@ var openapi_default = {
|
|
|
4934
5230
|
type: "boolean"
|
|
4935
5231
|
},
|
|
4936
5232
|
is_offline_access_code: {
|
|
4937
|
-
description:
|
|
5233
|
+
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
5234
|
type: "boolean"
|
|
4939
5235
|
},
|
|
4940
5236
|
is_one_time_use: {
|
|
4941
|
-
description:
|
|
5237
|
+
description: "Indicates whether the access code can only be used once. If `true`, the code becomes invalid after the first use.",
|
|
4942
5238
|
type: "boolean"
|
|
4943
5239
|
},
|
|
4944
5240
|
is_scheduled_on_device: {
|
|
@@ -4967,25 +5263,33 @@ var openapi_default = {
|
|
|
4967
5263
|
type: "string"
|
|
4968
5264
|
},
|
|
4969
5265
|
status: {
|
|
4970
|
-
description:
|
|
5266
|
+
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
5267
|
enum: ["setting", "set", "unset", "removing", "unknown"],
|
|
4972
5268
|
type: "string"
|
|
4973
5269
|
},
|
|
4974
5270
|
type: {
|
|
4975
|
-
description:
|
|
5271
|
+
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
5272
|
enum: ["time_bound", "ongoing"],
|
|
4977
5273
|
type: "string"
|
|
4978
5274
|
},
|
|
4979
5275
|
warnings: {
|
|
4980
|
-
description:
|
|
5276
|
+
description: "Warnings associated with the [access code](https://docs.seam.co/latest/capability-guides/smart-locks/access-codes).",
|
|
4981
5277
|
items: {
|
|
5278
|
+
description: "Warnings associated with the [access code](https://docs.seam.co/latest/capability-guides/smart-locks/access-codes).",
|
|
4982
5279
|
discriminator: { propertyName: "warning_code" },
|
|
4983
5280
|
oneOf: [
|
|
4984
5281
|
{
|
|
4985
|
-
description: "Failed to set code on
|
|
5282
|
+
description: "Failed to set code on SmartThings device.",
|
|
4986
5283
|
properties: {
|
|
4987
|
-
created_at: {
|
|
4988
|
-
|
|
5284
|
+
created_at: {
|
|
5285
|
+
description: "Date and time at which Seam created the warning.",
|
|
5286
|
+
format: "date-time",
|
|
5287
|
+
type: "string"
|
|
5288
|
+
},
|
|
5289
|
+
message: {
|
|
5290
|
+
description: "Detailed description of the warning. Provides insights into the issue and potentially how to rectify it.",
|
|
5291
|
+
type: "string"
|
|
5292
|
+
},
|
|
4989
5293
|
warning_code: {
|
|
4990
5294
|
description: "Unique identifier of the type of warning. Enables quick recognition and categorization of the issue.",
|
|
4991
5295
|
enum: ["smartthings_failed_to_set_access_code"],
|
|
@@ -4998,8 +5302,15 @@ var openapi_default = {
|
|
|
4998
5302
|
{
|
|
4999
5303
|
description: "Duplicate access code detected.",
|
|
5000
5304
|
properties: {
|
|
5001
|
-
created_at: {
|
|
5002
|
-
|
|
5305
|
+
created_at: {
|
|
5306
|
+
description: "Date and time at which Seam created the warning.",
|
|
5307
|
+
format: "date-time",
|
|
5308
|
+
type: "string"
|
|
5309
|
+
},
|
|
5310
|
+
message: {
|
|
5311
|
+
description: "Detailed description of the warning. Provides insights into the issue and potentially how to rectify it.",
|
|
5312
|
+
type: "string"
|
|
5313
|
+
},
|
|
5003
5314
|
warning_code: {
|
|
5004
5315
|
description: "Unique identifier of the type of warning. Enables quick recognition and categorization of the issue.",
|
|
5005
5316
|
enum: ["schlage_detected_duplicate"],
|
|
@@ -5012,8 +5323,15 @@ var openapi_default = {
|
|
|
5012
5323
|
{
|
|
5013
5324
|
description: "Received an error when attempting to create this code.",
|
|
5014
5325
|
properties: {
|
|
5015
|
-
created_at: {
|
|
5016
|
-
|
|
5326
|
+
created_at: {
|
|
5327
|
+
description: "Date and time at which Seam created the warning.",
|
|
5328
|
+
format: "date-time",
|
|
5329
|
+
type: "string"
|
|
5330
|
+
},
|
|
5331
|
+
message: {
|
|
5332
|
+
description: "Detailed description of the warning. Provides insights into the issue and potentially how to rectify it.",
|
|
5333
|
+
type: "string"
|
|
5334
|
+
},
|
|
5017
5335
|
warning_code: {
|
|
5018
5336
|
description: "Unique identifier of the type of warning. Enables quick recognition and categorization of the issue.",
|
|
5019
5337
|
enum: ["schlage_creation_outage"],
|
|
@@ -5026,8 +5344,15 @@ var openapi_default = {
|
|
|
5026
5344
|
{
|
|
5027
5345
|
description: "Code was modified or removed externally after Seam successfully set it on the device.",
|
|
5028
5346
|
properties: {
|
|
5029
|
-
created_at: {
|
|
5030
|
-
|
|
5347
|
+
created_at: {
|
|
5348
|
+
description: "Date and time at which Seam created the warning.",
|
|
5349
|
+
format: "date-time",
|
|
5350
|
+
type: "string"
|
|
5351
|
+
},
|
|
5352
|
+
message: {
|
|
5353
|
+
description: "Detailed description of the warning. Provides insights into the issue and potentially how to rectify it.",
|
|
5354
|
+
type: "string"
|
|
5355
|
+
},
|
|
5031
5356
|
warning_code: {
|
|
5032
5357
|
description: "Unique identifier of the type of warning. Enables quick recognition and categorization of the issue.",
|
|
5033
5358
|
enum: ["code_modified_external_to_seam"],
|
|
@@ -5040,8 +5365,15 @@ var openapi_default = {
|
|
|
5040
5365
|
{
|
|
5041
5366
|
description: "Delay in setting code on device.",
|
|
5042
5367
|
properties: {
|
|
5043
|
-
created_at: {
|
|
5044
|
-
|
|
5368
|
+
created_at: {
|
|
5369
|
+
description: "Date and time at which Seam created the warning.",
|
|
5370
|
+
format: "date-time",
|
|
5371
|
+
type: "string"
|
|
5372
|
+
},
|
|
5373
|
+
message: {
|
|
5374
|
+
description: "Detailed description of the warning. Provides insights into the issue and potentially how to rectify it.",
|
|
5375
|
+
type: "string"
|
|
5376
|
+
},
|
|
5045
5377
|
warning_code: {
|
|
5046
5378
|
description: "Unique identifier of the type of warning. Enables quick recognition and categorization of the issue.",
|
|
5047
5379
|
enum: ["delay_in_setting_on_device"],
|
|
@@ -5054,8 +5386,15 @@ var openapi_default = {
|
|
|
5054
5386
|
{
|
|
5055
5387
|
description: "Delay in removing code from device.",
|
|
5056
5388
|
properties: {
|
|
5057
|
-
created_at: {
|
|
5058
|
-
|
|
5389
|
+
created_at: {
|
|
5390
|
+
description: "Date and time at which Seam created the warning.",
|
|
5391
|
+
format: "date-time",
|
|
5392
|
+
type: "string"
|
|
5393
|
+
},
|
|
5394
|
+
message: {
|
|
5395
|
+
description: "Detailed description of the warning. Provides insights into the issue and potentially how to rectify it.",
|
|
5396
|
+
type: "string"
|
|
5397
|
+
},
|
|
5059
5398
|
warning_code: {
|
|
5060
5399
|
description: "Unique identifier of the type of warning. Enables quick recognition and categorization of the issue.",
|
|
5061
5400
|
enum: ["delay_in_removing_from_device"],
|
|
@@ -5066,10 +5405,17 @@ var openapi_default = {
|
|
|
5066
5405
|
type: "object"
|
|
5067
5406
|
},
|
|
5068
5407
|
{
|
|
5069
|
-
description: "Third
|
|
5408
|
+
description: "Third-party integration detected that may cause access codes to fail.",
|
|
5070
5409
|
properties: {
|
|
5071
|
-
created_at: {
|
|
5072
|
-
|
|
5410
|
+
created_at: {
|
|
5411
|
+
description: "Date and time at which Seam created the warning.",
|
|
5412
|
+
format: "date-time",
|
|
5413
|
+
type: "string"
|
|
5414
|
+
},
|
|
5415
|
+
message: {
|
|
5416
|
+
description: "Detailed description of the warning. Provides insights into the issue and potentially how to rectify it.",
|
|
5417
|
+
type: "string"
|
|
5418
|
+
},
|
|
5073
5419
|
warning_code: {
|
|
5074
5420
|
description: "Unique identifier of the type of warning. Enables quick recognition and categorization of the issue.",
|
|
5075
5421
|
enum: ["third_party_integration_detected"],
|
|
@@ -5082,8 +5428,15 @@ var openapi_default = {
|
|
|
5082
5428
|
{
|
|
5083
5429
|
description: "Access code has not yet been fully moved to the device.",
|
|
5084
5430
|
properties: {
|
|
5085
|
-
created_at: {
|
|
5086
|
-
|
|
5431
|
+
created_at: {
|
|
5432
|
+
description: "Date and time at which Seam created the warning.",
|
|
5433
|
+
format: "date-time",
|
|
5434
|
+
type: "string"
|
|
5435
|
+
},
|
|
5436
|
+
message: {
|
|
5437
|
+
description: "Detailed description of the warning. Provides insights into the issue and potentially how to rectify it.",
|
|
5438
|
+
type: "string"
|
|
5439
|
+
},
|
|
5087
5440
|
warning_code: {
|
|
5088
5441
|
description: "Unique identifier of the type of warning. Enables quick recognition and categorization of the issue.",
|
|
5089
5442
|
enum: ["august_device_programming_delay"],
|
|
@@ -5096,8 +5449,15 @@ var openapi_default = {
|
|
|
5096
5449
|
{
|
|
5097
5450
|
description: "August lock is temporarily offline.",
|
|
5098
5451
|
properties: {
|
|
5099
|
-
created_at: {
|
|
5100
|
-
|
|
5452
|
+
created_at: {
|
|
5453
|
+
description: "Date and time at which Seam created the warning.",
|
|
5454
|
+
format: "date-time",
|
|
5455
|
+
type: "string"
|
|
5456
|
+
},
|
|
5457
|
+
message: {
|
|
5458
|
+
description: "Detailed description of the warning. Provides insights into the issue and potentially how to rectify it.",
|
|
5459
|
+
type: "string"
|
|
5460
|
+
},
|
|
5101
5461
|
warning_code: {
|
|
5102
5462
|
description: "Unique identifier of the type of error. Enables quick recognition and categorization of the issue.",
|
|
5103
5463
|
enum: ["august_lock_temporarily_offline"],
|
|
@@ -5110,8 +5470,15 @@ var openapi_default = {
|
|
|
5110
5470
|
{
|
|
5111
5471
|
description: "Algopins must be used within 24 hours.",
|
|
5112
5472
|
properties: {
|
|
5113
|
-
created_at: {
|
|
5114
|
-
|
|
5473
|
+
created_at: {
|
|
5474
|
+
description: "Date and time at which Seam created the warning.",
|
|
5475
|
+
format: "date-time",
|
|
5476
|
+
type: "string"
|
|
5477
|
+
},
|
|
5478
|
+
message: {
|
|
5479
|
+
description: "Detailed description of the warning. Provides insights into the issue and potentially how to rectify it.",
|
|
5480
|
+
type: "string"
|
|
5481
|
+
},
|
|
5115
5482
|
warning_code: {
|
|
5116
5483
|
description: "Unique identifier of the type of warning. Enables quick recognition and categorization of the issue.",
|
|
5117
5484
|
enum: ["igloo_algopin_must_be_used_within_24_hours"],
|
|
@@ -5124,8 +5491,15 @@ var openapi_default = {
|
|
|
5124
5491
|
{
|
|
5125
5492
|
description: "Management was transferred to another workspace.",
|
|
5126
5493
|
properties: {
|
|
5127
|
-
created_at: {
|
|
5128
|
-
|
|
5494
|
+
created_at: {
|
|
5495
|
+
description: "Date and time at which Seam created the warning.",
|
|
5496
|
+
format: "date-time",
|
|
5497
|
+
type: "string"
|
|
5498
|
+
},
|
|
5499
|
+
message: {
|
|
5500
|
+
description: "Detailed description of the warning. Provides insights into the issue and potentially how to rectify it.",
|
|
5501
|
+
type: "string"
|
|
5502
|
+
},
|
|
5129
5503
|
warning_code: {
|
|
5130
5504
|
description: "Unique identifier of the type of warning. Enables quick recognition and categorization of the issue.",
|
|
5131
5505
|
enum: ["management_transferred"],
|
|
@@ -5136,10 +5510,17 @@ var openapi_default = {
|
|
|
5136
5510
|
type: "object"
|
|
5137
5511
|
},
|
|
5138
5512
|
{
|
|
5139
|
-
description: "Unable to confirm the access code is set on Kwikset device.",
|
|
5513
|
+
description: "Unable to confirm that the access code is set on Kwikset device.",
|
|
5140
5514
|
properties: {
|
|
5141
|
-
created_at: {
|
|
5142
|
-
|
|
5515
|
+
created_at: {
|
|
5516
|
+
description: "Date and time at which Seam created the warning.",
|
|
5517
|
+
format: "date-time",
|
|
5518
|
+
type: "string"
|
|
5519
|
+
},
|
|
5520
|
+
message: {
|
|
5521
|
+
description: "Detailed description of the warning. Provides insights into the issue and potentially how to rectify it.",
|
|
5522
|
+
type: "string"
|
|
5523
|
+
},
|
|
5143
5524
|
warning_code: {
|
|
5144
5525
|
description: "Unique identifier of the type of warning. Enables quick recognition and categorization of the issue.",
|
|
5145
5526
|
enum: ["kwikset_unable_to_confirm_code"],
|
|
@@ -6489,14 +6870,13 @@ var openapi_default = {
|
|
|
6489
6870
|
from: {
|
|
6490
6871
|
properties: {
|
|
6491
6872
|
ends_at: {
|
|
6492
|
-
description: "Date and time at which the user's access ends, in [ISO 8601](https://www.iso.org/iso-8601-date-and-time-format.html) format.",
|
|
6493
6873
|
format: "date-time",
|
|
6494
6874
|
nullable: true,
|
|
6495
6875
|
type: "string"
|
|
6496
6876
|
},
|
|
6497
6877
|
starts_at: {
|
|
6498
|
-
description: "Date and time at which the user's access starts, in [ISO 8601](https://www.iso.org/iso-8601-date-and-time-format.html) format.",
|
|
6499
6878
|
format: "date-time",
|
|
6879
|
+
nullable: true,
|
|
6500
6880
|
type: "string"
|
|
6501
6881
|
}
|
|
6502
6882
|
},
|
|
@@ -6510,14 +6890,13 @@ var openapi_default = {
|
|
|
6510
6890
|
to: {
|
|
6511
6891
|
properties: {
|
|
6512
6892
|
ends_at: {
|
|
6513
|
-
description: "Date and time at which the user's access ends, in [ISO 8601](https://www.iso.org/iso-8601-date-and-time-format.html) format.",
|
|
6514
6893
|
format: "date-time",
|
|
6515
6894
|
nullable: true,
|
|
6516
6895
|
type: "string"
|
|
6517
6896
|
},
|
|
6518
6897
|
starts_at: {
|
|
6519
|
-
description: "Date and time at which the user's access starts, in [ISO 8601](https://www.iso.org/iso-8601-date-and-time-format.html) format.",
|
|
6520
6898
|
format: "date-time",
|
|
6899
|
+
nullable: true,
|
|
6521
6900
|
type: "string"
|
|
6522
6901
|
}
|
|
6523
6902
|
},
|
|
@@ -16540,6 +16919,7 @@ var openapi_default = {
|
|
|
16540
16919
|
"x-route-path": "/thermostats/schedules"
|
|
16541
16920
|
},
|
|
16542
16921
|
unmanaged_access_code: {
|
|
16922
|
+
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
16923
|
properties: {
|
|
16544
16924
|
access_code_id: {
|
|
16545
16925
|
description: "Unique identifier for the access code.",
|
|
@@ -16568,21 +16948,32 @@ var openapi_default = {
|
|
|
16568
16948
|
type: "string"
|
|
16569
16949
|
},
|
|
16570
16950
|
errors: {
|
|
16571
|
-
description:
|
|
16951
|
+
description: "Errors associated with the [access code](https://docs.seam.co/latest/capability-guides/smart-locks/access-codes).",
|
|
16572
16952
|
items: {
|
|
16573
16953
|
discriminator: { propertyName: "error_code" },
|
|
16574
16954
|
oneOf: [
|
|
16575
16955
|
{
|
|
16576
|
-
description: "Failed to set code on
|
|
16956
|
+
description: "Failed to set code on SmartThings device.",
|
|
16577
16957
|
properties: {
|
|
16578
|
-
created_at: {
|
|
16958
|
+
created_at: {
|
|
16959
|
+
description: "Date and time at which Seam created the error.",
|
|
16960
|
+
format: "date-time",
|
|
16961
|
+
type: "string"
|
|
16962
|
+
},
|
|
16579
16963
|
error_code: {
|
|
16580
16964
|
description: "Unique identifier of the type of error. Enables quick recognition and categorization of the issue.",
|
|
16581
16965
|
enum: ["smartthings_failed_to_set_access_code"],
|
|
16582
16966
|
type: "string"
|
|
16583
16967
|
},
|
|
16584
|
-
is_access_code_error: {
|
|
16585
|
-
|
|
16968
|
+
is_access_code_error: {
|
|
16969
|
+
description: "Indicates that this is an access code error.",
|
|
16970
|
+
enum: [true],
|
|
16971
|
+
type: "boolean"
|
|
16972
|
+
},
|
|
16973
|
+
message: {
|
|
16974
|
+
description: "Detailed description of the error. Provides insights into the issue and potentially how to rectify it.",
|
|
16975
|
+
type: "string"
|
|
16976
|
+
}
|
|
16586
16977
|
},
|
|
16587
16978
|
required: ["message", "is_access_code_error", "error_code"],
|
|
16588
16979
|
type: "object"
|
|
@@ -16590,16 +16981,27 @@ var openapi_default = {
|
|
|
16590
16981
|
{
|
|
16591
16982
|
description: "Failed to set code after multiple retries.",
|
|
16592
16983
|
properties: {
|
|
16593
|
-
created_at: {
|
|
16594
|
-
|
|
16595
|
-
|
|
16984
|
+
created_at: {
|
|
16985
|
+
description: "Date and time at which Seam created the error.",
|
|
16986
|
+
format: "date-time",
|
|
16987
|
+
type: "string"
|
|
16988
|
+
},
|
|
16989
|
+
error_code: {
|
|
16990
|
+
description: "Unique identifier of the type of error. Enables quick recognition and categorization of the issue.",
|
|
16596
16991
|
enum: [
|
|
16597
16992
|
"smartthings_failed_to_set_after_multiple_retries"
|
|
16598
16993
|
],
|
|
16599
16994
|
type: "string"
|
|
16600
16995
|
},
|
|
16601
|
-
is_access_code_error: {
|
|
16602
|
-
|
|
16996
|
+
is_access_code_error: {
|
|
16997
|
+
description: "Indicates that this is an access code error.",
|
|
16998
|
+
enum: [true],
|
|
16999
|
+
type: "boolean"
|
|
17000
|
+
},
|
|
17001
|
+
message: {
|
|
17002
|
+
description: "Detailed description of the error. Provides insights into the issue and potentially how to rectify it.",
|
|
17003
|
+
type: "string"
|
|
17004
|
+
}
|
|
16603
17005
|
},
|
|
16604
17006
|
required: ["message", "is_access_code_error", "error_code"],
|
|
16605
17007
|
type: "object"
|
|
@@ -16607,14 +17009,25 @@ var openapi_default = {
|
|
|
16607
17009
|
{
|
|
16608
17010
|
description: "No free slots available on the device.",
|
|
16609
17011
|
properties: {
|
|
16610
|
-
created_at: {
|
|
17012
|
+
created_at: {
|
|
17013
|
+
description: "Date and time at which Seam created the error.",
|
|
17014
|
+
format: "date-time",
|
|
17015
|
+
type: "string"
|
|
17016
|
+
},
|
|
16611
17017
|
error_code: {
|
|
16612
17018
|
description: "Unique identifier of the type of error. Enables quick recognition and categorization of the issue.",
|
|
16613
17019
|
enum: ["smartthings_no_free_slots_available"],
|
|
16614
17020
|
type: "string"
|
|
16615
17021
|
},
|
|
16616
|
-
is_access_code_error: {
|
|
16617
|
-
|
|
17022
|
+
is_access_code_error: {
|
|
17023
|
+
description: "Indicates that this is an access code error.",
|
|
17024
|
+
enum: [true],
|
|
17025
|
+
type: "boolean"
|
|
17026
|
+
},
|
|
17027
|
+
message: {
|
|
17028
|
+
description: "Detailed description of the error. Provides insights into the issue and potentially how to rectify it.",
|
|
17029
|
+
type: "string"
|
|
17030
|
+
}
|
|
16618
17031
|
},
|
|
16619
17032
|
required: ["message", "is_access_code_error", "error_code"],
|
|
16620
17033
|
type: "object"
|
|
@@ -16622,14 +17035,25 @@ var openapi_default = {
|
|
|
16622
17035
|
{
|
|
16623
17036
|
description: "Failed to set code on device.",
|
|
16624
17037
|
properties: {
|
|
16625
|
-
created_at: {
|
|
17038
|
+
created_at: {
|
|
17039
|
+
description: "Date and time at which Seam created the error.",
|
|
17040
|
+
format: "date-time",
|
|
17041
|
+
type: "string"
|
|
17042
|
+
},
|
|
16626
17043
|
error_code: {
|
|
16627
17044
|
description: "Unique identifier of the type of error. Enables quick recognition and categorization of the issue.",
|
|
16628
17045
|
enum: ["failed_to_set_on_device"],
|
|
16629
17046
|
type: "string"
|
|
16630
17047
|
},
|
|
16631
|
-
is_access_code_error: {
|
|
16632
|
-
|
|
17048
|
+
is_access_code_error: {
|
|
17049
|
+
description: "Indicates that this is an access code error.",
|
|
17050
|
+
enum: [true],
|
|
17051
|
+
type: "boolean"
|
|
17052
|
+
},
|
|
17053
|
+
message: {
|
|
17054
|
+
description: "Detailed description of the error. Provides insights into the issue and potentially how to rectify it.",
|
|
17055
|
+
type: "string"
|
|
17056
|
+
}
|
|
16633
17057
|
},
|
|
16634
17058
|
required: ["message", "is_access_code_error", "error_code"],
|
|
16635
17059
|
type: "object"
|
|
@@ -16637,14 +17061,25 @@ var openapi_default = {
|
|
|
16637
17061
|
{
|
|
16638
17062
|
description: "Failed to remove code from device.",
|
|
16639
17063
|
properties: {
|
|
16640
|
-
created_at: {
|
|
17064
|
+
created_at: {
|
|
17065
|
+
description: "Date and time at which Seam created the error.",
|
|
17066
|
+
format: "date-time",
|
|
17067
|
+
type: "string"
|
|
17068
|
+
},
|
|
16641
17069
|
error_code: {
|
|
16642
17070
|
description: "Unique identifier of the type of error. Enables quick recognition and categorization of the issue.",
|
|
16643
17071
|
enum: ["failed_to_remove_from_device"],
|
|
16644
17072
|
type: "string"
|
|
16645
17073
|
},
|
|
16646
|
-
is_access_code_error: {
|
|
16647
|
-
|
|
17074
|
+
is_access_code_error: {
|
|
17075
|
+
description: "Indicates that this is an access code error.",
|
|
17076
|
+
enum: [true],
|
|
17077
|
+
type: "boolean"
|
|
17078
|
+
},
|
|
17079
|
+
message: {
|
|
17080
|
+
description: "Detailed description of the error. Provides insights into the issue and potentially how to rectify it.",
|
|
17081
|
+
type: "string"
|
|
17082
|
+
}
|
|
16648
17083
|
},
|
|
16649
17084
|
required: ["message", "is_access_code_error", "error_code"],
|
|
16650
17085
|
type: "object"
|
|
@@ -16652,14 +17087,25 @@ var openapi_default = {
|
|
|
16652
17087
|
{
|
|
16653
17088
|
description: "Duplicate access code detected on device.",
|
|
16654
17089
|
properties: {
|
|
16655
|
-
created_at: {
|
|
17090
|
+
created_at: {
|
|
17091
|
+
description: "Date and time at which Seam created the error.",
|
|
17092
|
+
format: "date-time",
|
|
17093
|
+
type: "string"
|
|
17094
|
+
},
|
|
16656
17095
|
error_code: {
|
|
16657
17096
|
description: "Unique identifier of the type of error. Enables quick recognition and categorization of the issue.",
|
|
16658
17097
|
enum: ["duplicate_code_on_device"],
|
|
16659
17098
|
type: "string"
|
|
16660
17099
|
},
|
|
16661
|
-
is_access_code_error: {
|
|
16662
|
-
|
|
17100
|
+
is_access_code_error: {
|
|
17101
|
+
description: "Indicates that this is an access code error.",
|
|
17102
|
+
enum: [true],
|
|
17103
|
+
type: "boolean"
|
|
17104
|
+
},
|
|
17105
|
+
message: {
|
|
17106
|
+
description: "Detailed description of the error. Provides insights into the issue and potentially how to rectify it.",
|
|
17107
|
+
type: "string"
|
|
17108
|
+
}
|
|
16663
17109
|
},
|
|
16664
17110
|
required: ["message", "is_access_code_error", "error_code"],
|
|
16665
17111
|
type: "object"
|
|
@@ -16667,14 +17113,25 @@ var openapi_default = {
|
|
|
16667
17113
|
{
|
|
16668
17114
|
description: "An attempt to modify this access code was prevented.",
|
|
16669
17115
|
properties: {
|
|
16670
|
-
created_at: {
|
|
17116
|
+
created_at: {
|
|
17117
|
+
description: "Date and time at which Seam created the error.",
|
|
17118
|
+
format: "date-time",
|
|
17119
|
+
type: "string"
|
|
17120
|
+
},
|
|
16671
17121
|
error_code: {
|
|
16672
17122
|
description: "Unique identifier of the type of error. Enables quick recognition and categorization of the issue.",
|
|
16673
17123
|
enum: ["duplicate_code_attempt_prevented"],
|
|
16674
17124
|
type: "string"
|
|
16675
17125
|
},
|
|
16676
|
-
is_access_code_error: {
|
|
16677
|
-
|
|
17126
|
+
is_access_code_error: {
|
|
17127
|
+
description: "Indicates that this is an access code error.",
|
|
17128
|
+
enum: [true],
|
|
17129
|
+
type: "boolean"
|
|
17130
|
+
},
|
|
17131
|
+
message: {
|
|
17132
|
+
description: "Detailed description of the error. Provides insights into the issue and potentially how to rectify it.",
|
|
17133
|
+
type: "string"
|
|
17134
|
+
}
|
|
16678
17135
|
},
|
|
16679
17136
|
required: ["message", "is_access_code_error", "error_code"],
|
|
16680
17137
|
type: "object"
|
|
@@ -16682,14 +17139,25 @@ var openapi_default = {
|
|
|
16682
17139
|
{
|
|
16683
17140
|
description: "Igloohome bridge has too many pending jobs in the queue.",
|
|
16684
17141
|
properties: {
|
|
16685
|
-
created_at: {
|
|
17142
|
+
created_at: {
|
|
17143
|
+
description: "Date and time at which Seam created the error.",
|
|
17144
|
+
format: "date-time",
|
|
17145
|
+
type: "string"
|
|
17146
|
+
},
|
|
16686
17147
|
error_code: {
|
|
16687
17148
|
description: "Unique identifier of the type of error. Enables quick recognition and categorization of the issue.",
|
|
16688
17149
|
enum: ["igloohome_bridge_too_many_pending_jobs"],
|
|
16689
17150
|
type: "string"
|
|
16690
17151
|
},
|
|
16691
|
-
is_access_code_error: {
|
|
16692
|
-
|
|
17152
|
+
is_access_code_error: {
|
|
17153
|
+
description: "Indicates that this is an access code error.",
|
|
17154
|
+
enum: [true],
|
|
17155
|
+
type: "boolean"
|
|
17156
|
+
},
|
|
17157
|
+
message: {
|
|
17158
|
+
description: "Detailed description of the error. Provides insights into the issue and potentially how to rectify it.",
|
|
17159
|
+
type: "string"
|
|
17160
|
+
}
|
|
16693
17161
|
},
|
|
16694
17162
|
required: ["message", "is_access_code_error", "error_code"],
|
|
16695
17163
|
type: "object"
|
|
@@ -16697,22 +17165,37 @@ var openapi_default = {
|
|
|
16697
17165
|
{
|
|
16698
17166
|
description: "Igloohome bridge is offline.",
|
|
16699
17167
|
properties: {
|
|
16700
|
-
created_at: {
|
|
17168
|
+
created_at: {
|
|
17169
|
+
description: "Date and time at which Seam created the error.",
|
|
17170
|
+
format: "date-time",
|
|
17171
|
+
type: "string"
|
|
17172
|
+
},
|
|
16701
17173
|
error_code: {
|
|
16702
17174
|
description: "Unique identifier of the type of error. Enables quick recognition and categorization of the issue.",
|
|
16703
17175
|
enum: ["igloohome_bridge_offline"],
|
|
16704
17176
|
type: "string"
|
|
16705
17177
|
},
|
|
16706
|
-
is_access_code_error: {
|
|
16707
|
-
|
|
17178
|
+
is_access_code_error: {
|
|
17179
|
+
description: "Indicates that this is an access code error.",
|
|
17180
|
+
enum: [true],
|
|
17181
|
+
type: "boolean"
|
|
17182
|
+
},
|
|
17183
|
+
message: {
|
|
17184
|
+
description: "Detailed description of the error. Provides insights into the issue and potentially how to rectify it.",
|
|
17185
|
+
type: "string"
|
|
17186
|
+
}
|
|
16708
17187
|
},
|
|
16709
17188
|
required: ["message", "is_access_code_error", "error_code"],
|
|
16710
17189
|
type: "object"
|
|
16711
17190
|
},
|
|
16712
17191
|
{
|
|
16713
|
-
description: "Lock
|
|
17192
|
+
description: "Lock has reached maximum amount of codes.",
|
|
16714
17193
|
properties: {
|
|
16715
|
-
created_at: {
|
|
17194
|
+
created_at: {
|
|
17195
|
+
description: "Date and time at which Seam created the error.",
|
|
17196
|
+
format: "date-time",
|
|
17197
|
+
type: "string"
|
|
17198
|
+
},
|
|
16716
17199
|
error_code: {
|
|
16717
17200
|
description: "Unique identifier of the type of error. Enables quick recognition and categorization of the issue.",
|
|
16718
17201
|
enum: [
|
|
@@ -16720,23 +17203,41 @@ var openapi_default = {
|
|
|
16720
17203
|
],
|
|
16721
17204
|
type: "string"
|
|
16722
17205
|
},
|
|
16723
|
-
is_access_code_error: {
|
|
16724
|
-
|
|
17206
|
+
is_access_code_error: {
|
|
17207
|
+
description: "Indicates that this is an access code error.",
|
|
17208
|
+
enum: [true],
|
|
17209
|
+
type: "boolean"
|
|
17210
|
+
},
|
|
17211
|
+
message: {
|
|
17212
|
+
description: "Detailed description of the error. Provides insights into the issue and potentially how to rectify it.",
|
|
17213
|
+
type: "string"
|
|
17214
|
+
}
|
|
16725
17215
|
},
|
|
16726
17216
|
required: ["message", "is_access_code_error", "error_code"],
|
|
16727
17217
|
type: "object"
|
|
16728
17218
|
},
|
|
16729
17219
|
{
|
|
16730
|
-
description: "Unable to confirm the access code is set on Kwikset device.",
|
|
17220
|
+
description: "Unable to confirm that the access code is set on Kwikset device.",
|
|
16731
17221
|
properties: {
|
|
16732
|
-
created_at: {
|
|
17222
|
+
created_at: {
|
|
17223
|
+
description: "Date and time at which Seam created the error.",
|
|
17224
|
+
format: "date-time",
|
|
17225
|
+
type: "string"
|
|
17226
|
+
},
|
|
16733
17227
|
error_code: {
|
|
16734
17228
|
description: "Unique identifier of the type of error. Enables quick recognition and categorization of the issue.",
|
|
16735
17229
|
enum: ["kwikset_unable_to_confirm_code"],
|
|
16736
17230
|
type: "string"
|
|
16737
17231
|
},
|
|
16738
|
-
is_access_code_error: {
|
|
16739
|
-
|
|
17232
|
+
is_access_code_error: {
|
|
17233
|
+
description: "Indicates that this is an access code error.",
|
|
17234
|
+
enum: [true],
|
|
17235
|
+
type: "boolean"
|
|
17236
|
+
},
|
|
17237
|
+
message: {
|
|
17238
|
+
description: "Detailed description of the error. Provides insights into the issue and potentially how to rectify it.",
|
|
17239
|
+
type: "string"
|
|
17240
|
+
}
|
|
16740
17241
|
},
|
|
16741
17242
|
required: ["message", "is_access_code_error", "error_code"],
|
|
16742
17243
|
type: "object"
|
|
@@ -16744,14 +17245,25 @@ var openapi_default = {
|
|
|
16744
17245
|
{
|
|
16745
17246
|
description: "Unable to confirm the deletion of the access code on Kwikset device.",
|
|
16746
17247
|
properties: {
|
|
16747
|
-
created_at: {
|
|
17248
|
+
created_at: {
|
|
17249
|
+
description: "Date and time at which Seam created the error.",
|
|
17250
|
+
format: "date-time",
|
|
17251
|
+
type: "string"
|
|
17252
|
+
},
|
|
16748
17253
|
error_code: {
|
|
16749
17254
|
description: "Unique identifier of the type of error. Enables quick recognition and categorization of the issue.",
|
|
16750
17255
|
enum: ["kwikset_unable_to_confirm_deletion"],
|
|
16751
17256
|
type: "string"
|
|
16752
17257
|
},
|
|
16753
|
-
is_access_code_error: {
|
|
16754
|
-
|
|
17258
|
+
is_access_code_error: {
|
|
17259
|
+
description: "Indicates that this is an access code error.",
|
|
17260
|
+
enum: [true],
|
|
17261
|
+
type: "boolean"
|
|
17262
|
+
},
|
|
17263
|
+
message: {
|
|
17264
|
+
description: "Detailed description of the error. Provides insights into the issue and potentially how to rectify it.",
|
|
17265
|
+
type: "string"
|
|
17266
|
+
}
|
|
16755
17267
|
},
|
|
16756
17268
|
required: ["message", "is_access_code_error", "error_code"],
|
|
16757
17269
|
type: "object"
|
|
@@ -16759,14 +17271,25 @@ var openapi_default = {
|
|
|
16759
17271
|
{
|
|
16760
17272
|
description: "Code was modified or removed externally after Seam successfully set it on the device.",
|
|
16761
17273
|
properties: {
|
|
16762
|
-
created_at: {
|
|
17274
|
+
created_at: {
|
|
17275
|
+
description: "Date and time at which Seam created the error.",
|
|
17276
|
+
format: "date-time",
|
|
17277
|
+
type: "string"
|
|
17278
|
+
},
|
|
16763
17279
|
error_code: {
|
|
16764
17280
|
description: "Unique identifier of the type of error. Enables quick recognition and categorization of the issue.",
|
|
16765
17281
|
enum: ["code_modified_external_to_seam"],
|
|
16766
17282
|
type: "string"
|
|
16767
17283
|
},
|
|
16768
|
-
is_access_code_error: {
|
|
16769
|
-
|
|
17284
|
+
is_access_code_error: {
|
|
17285
|
+
description: "Indicates that this is an access code error.",
|
|
17286
|
+
enum: [true],
|
|
17287
|
+
type: "boolean"
|
|
17288
|
+
},
|
|
17289
|
+
message: {
|
|
17290
|
+
description: "Detailed description of the error. Provides insights into the issue and potentially how to rectify it.",
|
|
17291
|
+
type: "string"
|
|
17292
|
+
}
|
|
16770
17293
|
},
|
|
16771
17294
|
required: ["message", "is_access_code_error", "error_code"],
|
|
16772
17295
|
type: "object"
|
|
@@ -16774,14 +17297,25 @@ var openapi_default = {
|
|
|
16774
17297
|
{
|
|
16775
17298
|
description: "Invalid code length for August lock.",
|
|
16776
17299
|
properties: {
|
|
16777
|
-
created_at: {
|
|
17300
|
+
created_at: {
|
|
17301
|
+
description: "Date and time at which Seam created the error.",
|
|
17302
|
+
format: "date-time",
|
|
17303
|
+
type: "string"
|
|
17304
|
+
},
|
|
16778
17305
|
error_code: {
|
|
16779
17306
|
description: "Unique identifier of the type of error. Enables quick recognition and categorization of the issue.",
|
|
16780
17307
|
enum: ["august_lock_invalid_code_length"],
|
|
16781
17308
|
type: "string"
|
|
16782
17309
|
},
|
|
16783
|
-
is_access_code_error: {
|
|
16784
|
-
|
|
17310
|
+
is_access_code_error: {
|
|
17311
|
+
description: "Indicates that this is an access code error.",
|
|
17312
|
+
enum: [true],
|
|
17313
|
+
type: "boolean"
|
|
17314
|
+
},
|
|
17315
|
+
message: {
|
|
17316
|
+
description: "Detailed description of the error. Provides insights into the issue and potentially how to rectify it.",
|
|
17317
|
+
type: "string"
|
|
17318
|
+
}
|
|
16785
17319
|
},
|
|
16786
17320
|
required: ["message", "is_access_code_error", "error_code"],
|
|
16787
17321
|
type: "object"
|
|
@@ -16789,14 +17323,25 @@ var openapi_default = {
|
|
|
16789
17323
|
{
|
|
16790
17324
|
description: "Access code has not yet been fully moved to the device.",
|
|
16791
17325
|
properties: {
|
|
16792
|
-
created_at: {
|
|
17326
|
+
created_at: {
|
|
17327
|
+
description: "Date and time at which Seam created the error.",
|
|
17328
|
+
format: "date-time",
|
|
17329
|
+
type: "string"
|
|
17330
|
+
},
|
|
16793
17331
|
error_code: {
|
|
16794
17332
|
description: "Unique identifier of the type of error. Enables quick recognition and categorization of the issue.",
|
|
16795
17333
|
enum: ["august_device_programming_delay"],
|
|
16796
17334
|
type: "string"
|
|
16797
17335
|
},
|
|
16798
|
-
is_access_code_error: {
|
|
16799
|
-
|
|
17336
|
+
is_access_code_error: {
|
|
17337
|
+
description: "Indicates that this is an access code error.",
|
|
17338
|
+
enum: [true],
|
|
17339
|
+
type: "boolean"
|
|
17340
|
+
},
|
|
17341
|
+
message: {
|
|
17342
|
+
description: "Detailed description of the error. Provides insights into the issue and potentially how to rectify it.",
|
|
17343
|
+
type: "string"
|
|
17344
|
+
}
|
|
16800
17345
|
},
|
|
16801
17346
|
required: ["message", "is_access_code_error", "error_code"],
|
|
16802
17347
|
type: "object"
|
|
@@ -16804,14 +17349,25 @@ var openapi_default = {
|
|
|
16804
17349
|
{
|
|
16805
17350
|
description: "All access code slots on the device are full.",
|
|
16806
17351
|
properties: {
|
|
16807
|
-
created_at: {
|
|
17352
|
+
created_at: {
|
|
17353
|
+
description: "Date and time at which Seam created the error.",
|
|
17354
|
+
format: "date-time",
|
|
17355
|
+
type: "string"
|
|
17356
|
+
},
|
|
16808
17357
|
error_code: {
|
|
16809
17358
|
description: "Unique identifier of the type of error. Enables quick recognition and categorization of the issue.",
|
|
16810
17359
|
enum: ["august_device_slots_full"],
|
|
16811
17360
|
type: "string"
|
|
16812
17361
|
},
|
|
16813
|
-
is_access_code_error: {
|
|
16814
|
-
|
|
17362
|
+
is_access_code_error: {
|
|
17363
|
+
description: "Indicates that this is an access code error.",
|
|
17364
|
+
enum: [true],
|
|
17365
|
+
type: "boolean"
|
|
17366
|
+
},
|
|
17367
|
+
message: {
|
|
17368
|
+
description: "Detailed description of the error. Provides insights into the issue and potentially how to rectify it.",
|
|
17369
|
+
type: "string"
|
|
17370
|
+
}
|
|
16815
17371
|
},
|
|
16816
17372
|
required: ["message", "is_access_code_error", "error_code"],
|
|
16817
17373
|
type: "object"
|
|
@@ -16819,14 +17375,25 @@ var openapi_default = {
|
|
|
16819
17375
|
{
|
|
16820
17376
|
description: "August lock is missing a keypad.",
|
|
16821
17377
|
properties: {
|
|
16822
|
-
created_at: {
|
|
17378
|
+
created_at: {
|
|
17379
|
+
description: "Date and time at which Seam created the error.",
|
|
17380
|
+
format: "date-time",
|
|
17381
|
+
type: "string"
|
|
17382
|
+
},
|
|
16823
17383
|
error_code: {
|
|
16824
17384
|
description: "Unique identifier of the type of error. Enables quick recognition and categorization of the issue.",
|
|
16825
17385
|
enum: ["august_lock_missing_keypad"],
|
|
16826
17386
|
type: "string"
|
|
16827
17387
|
},
|
|
16828
|
-
is_access_code_error: {
|
|
16829
|
-
|
|
17388
|
+
is_access_code_error: {
|
|
17389
|
+
description: "Indicates that this is an access code error.",
|
|
17390
|
+
enum: [true],
|
|
17391
|
+
type: "boolean"
|
|
17392
|
+
},
|
|
17393
|
+
message: {
|
|
17394
|
+
description: "Detailed description of the error. Provides insights into the issue and potentially how to rectify it.",
|
|
17395
|
+
type: "string"
|
|
17396
|
+
}
|
|
16830
17397
|
},
|
|
16831
17398
|
required: ["message", "is_access_code_error", "error_code"],
|
|
16832
17399
|
type: "object"
|
|
@@ -16834,14 +17401,25 @@ var openapi_default = {
|
|
|
16834
17401
|
{
|
|
16835
17402
|
description: "August lock is temporarily offline.",
|
|
16836
17403
|
properties: {
|
|
16837
|
-
created_at: {
|
|
17404
|
+
created_at: {
|
|
17405
|
+
description: "Date and time at which Seam created the error.",
|
|
17406
|
+
format: "date-time",
|
|
17407
|
+
type: "string"
|
|
17408
|
+
},
|
|
16838
17409
|
error_code: {
|
|
16839
17410
|
description: "Unique identifier of the type of error. Enables quick recognition and categorization of the issue.",
|
|
16840
17411
|
enum: ["august_lock_temporarily_offline"],
|
|
16841
17412
|
type: "string"
|
|
16842
17413
|
},
|
|
16843
|
-
is_access_code_error: {
|
|
16844
|
-
|
|
17414
|
+
is_access_code_error: {
|
|
17415
|
+
description: "Indicates that this is an access code error.",
|
|
17416
|
+
enum: [true],
|
|
17417
|
+
type: "boolean"
|
|
17418
|
+
},
|
|
17419
|
+
message: {
|
|
17420
|
+
description: "Detailed description of the error. Provides insights into the issue and potentially how to rectify it.",
|
|
17421
|
+
type: "string"
|
|
17422
|
+
}
|
|
16845
17423
|
},
|
|
16846
17424
|
required: ["message", "is_access_code_error", "error_code"],
|
|
16847
17425
|
type: "object"
|
|
@@ -16849,14 +17427,25 @@ var openapi_default = {
|
|
|
16849
17427
|
{
|
|
16850
17428
|
description: "Salto site user is not subscribed.",
|
|
16851
17429
|
properties: {
|
|
16852
|
-
created_at: {
|
|
17430
|
+
created_at: {
|
|
17431
|
+
description: "Date and time at which Seam created the error.",
|
|
17432
|
+
format: "date-time",
|
|
17433
|
+
type: "string"
|
|
17434
|
+
},
|
|
16853
17435
|
error_code: {
|
|
16854
17436
|
description: "Unique identifier of the type of error. Enables quick recognition and categorization of the issue.",
|
|
16855
17437
|
enum: ["salto_ks_user_not_subscribed"],
|
|
16856
17438
|
type: "string"
|
|
16857
17439
|
},
|
|
16858
|
-
is_access_code_error: {
|
|
16859
|
-
|
|
17440
|
+
is_access_code_error: {
|
|
17441
|
+
description: "Indicates that this is an access code error.",
|
|
17442
|
+
enum: [true],
|
|
17443
|
+
type: "boolean"
|
|
17444
|
+
},
|
|
17445
|
+
message: {
|
|
17446
|
+
description: "Detailed description of the error. Provides insights into the issue and potentially how to rectify it.",
|
|
17447
|
+
type: "string"
|
|
17448
|
+
}
|
|
16860
17449
|
},
|
|
16861
17450
|
required: ["message", "is_access_code_error", "error_code"],
|
|
16862
17451
|
type: "object"
|
|
@@ -16864,14 +17453,25 @@ var openapi_default = {
|
|
|
16864
17453
|
{
|
|
16865
17454
|
description: "Access code has not yet been fully moved to the device.",
|
|
16866
17455
|
properties: {
|
|
16867
|
-
created_at: {
|
|
17456
|
+
created_at: {
|
|
17457
|
+
description: "Date and time at which Seam created the error.",
|
|
17458
|
+
format: "date-time",
|
|
17459
|
+
type: "string"
|
|
17460
|
+
},
|
|
16868
17461
|
error_code: {
|
|
16869
17462
|
description: "Unique identifier of the type of error. Enables quick recognition and categorization of the issue.",
|
|
16870
17463
|
enum: ["hubitat_device_programming_delay"],
|
|
16871
17464
|
type: "string"
|
|
16872
17465
|
},
|
|
16873
|
-
is_access_code_error: {
|
|
16874
|
-
|
|
17466
|
+
is_access_code_error: {
|
|
17467
|
+
description: "Indicates that this is an access code error.",
|
|
17468
|
+
enum: [true],
|
|
17469
|
+
type: "boolean"
|
|
17470
|
+
},
|
|
17471
|
+
message: {
|
|
17472
|
+
description: "Detailed description of the error. Provides insights into the issue and potentially how to rectify it.",
|
|
17473
|
+
type: "string"
|
|
17474
|
+
}
|
|
16875
17475
|
},
|
|
16876
17476
|
required: ["message", "is_access_code_error", "error_code"],
|
|
16877
17477
|
type: "object"
|
|
@@ -16879,14 +17479,25 @@ var openapi_default = {
|
|
|
16879
17479
|
{
|
|
16880
17480
|
description: "No free positions available on the device.",
|
|
16881
17481
|
properties: {
|
|
16882
|
-
created_at: {
|
|
17482
|
+
created_at: {
|
|
17483
|
+
description: "Date and time at which Seam created the error.",
|
|
17484
|
+
format: "date-time",
|
|
17485
|
+
type: "string"
|
|
17486
|
+
},
|
|
16883
17487
|
error_code: {
|
|
16884
17488
|
description: "Unique identifier of the type of error. Enables quick recognition and categorization of the issue.",
|
|
16885
17489
|
enum: ["hubitat_no_free_positions_available"],
|
|
16886
17490
|
type: "string"
|
|
16887
17491
|
},
|
|
16888
|
-
is_access_code_error: {
|
|
16889
|
-
|
|
17492
|
+
is_access_code_error: {
|
|
17493
|
+
description: "Indicates that this is an access code error.",
|
|
17494
|
+
enum: [true],
|
|
17495
|
+
type: "boolean"
|
|
17496
|
+
},
|
|
17497
|
+
message: {
|
|
17498
|
+
description: "Detailed description of the error. Provides insights into the issue and potentially how to rectify it.",
|
|
17499
|
+
type: "string"
|
|
17500
|
+
}
|
|
16890
17501
|
},
|
|
16891
17502
|
required: ["message", "is_access_code_error", "error_code"],
|
|
16892
17503
|
type: "object"
|
|
@@ -16894,14 +17505,25 @@ var openapi_default = {
|
|
|
16894
17505
|
{
|
|
16895
17506
|
description: "Duplicate access code name detected.",
|
|
16896
17507
|
properties: {
|
|
16897
|
-
created_at: {
|
|
17508
|
+
created_at: {
|
|
17509
|
+
description: "Date and time at which Seam created the error.",
|
|
17510
|
+
format: "date-time",
|
|
17511
|
+
type: "string"
|
|
17512
|
+
},
|
|
16898
17513
|
error_code: {
|
|
16899
17514
|
description: "Unique identifier of the type of error. Enables quick recognition and categorization of the issue.",
|
|
16900
17515
|
enum: ["wyze_duplicate_code_name"],
|
|
16901
17516
|
type: "string"
|
|
16902
17517
|
},
|
|
16903
|
-
is_access_code_error: {
|
|
16904
|
-
|
|
17518
|
+
is_access_code_error: {
|
|
17519
|
+
description: "Indicates that this is an access code error.",
|
|
17520
|
+
enum: [true],
|
|
17521
|
+
type: "boolean"
|
|
17522
|
+
},
|
|
17523
|
+
message: {
|
|
17524
|
+
description: "Detailed description of the error. Provides insights into the issue and potentially how to rectify it.",
|
|
17525
|
+
type: "string"
|
|
17526
|
+
}
|
|
16905
17527
|
},
|
|
16906
17528
|
required: ["message", "is_access_code_error", "error_code"],
|
|
16907
17529
|
type: "object"
|
|
@@ -16909,14 +17531,25 @@ var openapi_default = {
|
|
|
16909
17531
|
{
|
|
16910
17532
|
description: "Potential duplicate access code detected.",
|
|
16911
17533
|
properties: {
|
|
16912
|
-
created_at: {
|
|
17534
|
+
created_at: {
|
|
17535
|
+
description: "Date and time at which Seam created the error.",
|
|
17536
|
+
format: "date-time",
|
|
17537
|
+
type: "string"
|
|
17538
|
+
},
|
|
16913
17539
|
error_code: {
|
|
16914
17540
|
description: "Unique identifier of the type of error. Enables quick recognition and categorization of the issue.",
|
|
16915
17541
|
enum: ["wyze_potential_duplicate_code"],
|
|
16916
17542
|
type: "string"
|
|
16917
17543
|
},
|
|
16918
|
-
is_access_code_error: {
|
|
16919
|
-
|
|
17544
|
+
is_access_code_error: {
|
|
17545
|
+
description: "Indicates that this is an access code error.",
|
|
17546
|
+
enum: [true],
|
|
17547
|
+
type: "boolean"
|
|
17548
|
+
},
|
|
17549
|
+
message: {
|
|
17550
|
+
description: "Detailed description of the error. Provides insights into the issue and potentially how to rectify it.",
|
|
17551
|
+
type: "string"
|
|
17552
|
+
}
|
|
16920
17553
|
},
|
|
16921
17554
|
required: ["message", "is_access_code_error", "error_code"],
|
|
16922
17555
|
type: "object"
|
|
@@ -16924,14 +17557,25 @@ var openapi_default = {
|
|
|
16924
17557
|
{
|
|
16925
17558
|
description: "No valid user level for Oracode.",
|
|
16926
17559
|
properties: {
|
|
16927
|
-
created_at: {
|
|
17560
|
+
created_at: {
|
|
17561
|
+
description: "Date and time at which Seam created the error.",
|
|
17562
|
+
format: "date-time",
|
|
17563
|
+
type: "string"
|
|
17564
|
+
},
|
|
16928
17565
|
error_code: {
|
|
16929
17566
|
description: "Unique identifier of the type of error. Enables quick recognition and categorization of the issue.",
|
|
16930
17567
|
enum: ["dormakaba_oracode_no_valid_user_level"],
|
|
16931
17568
|
type: "string"
|
|
16932
17569
|
},
|
|
16933
|
-
is_access_code_error: {
|
|
16934
|
-
|
|
17570
|
+
is_access_code_error: {
|
|
17571
|
+
description: "Indicates that this is an access code error.",
|
|
17572
|
+
enum: [true],
|
|
17573
|
+
type: "boolean"
|
|
17574
|
+
},
|
|
17575
|
+
message: {
|
|
17576
|
+
description: "Detailed description of the error. Provides insights into the issue and potentially how to rectify it.",
|
|
17577
|
+
type: "string"
|
|
17578
|
+
}
|
|
16935
17579
|
},
|
|
16936
17580
|
required: ["message", "is_access_code_error", "error_code"],
|
|
16937
17581
|
type: "object"
|
|
@@ -17250,7 +17894,11 @@ var openapi_default = {
|
|
|
17250
17894
|
},
|
|
17251
17895
|
type: "array"
|
|
17252
17896
|
},
|
|
17253
|
-
is_managed: {
|
|
17897
|
+
is_managed: {
|
|
17898
|
+
description: "Indicates that Seam does not manage the access code.",
|
|
17899
|
+
enum: [false],
|
|
17900
|
+
type: "boolean"
|
|
17901
|
+
},
|
|
17254
17902
|
name: {
|
|
17255
17903
|
description: "Name of the access code. Enables administrators and users to identify the access code easily, especially when there are numerous access codes.",
|
|
17256
17904
|
nullable: true,
|
|
@@ -17262,22 +17910,34 @@ var openapi_default = {
|
|
|
17262
17910
|
nullable: true,
|
|
17263
17911
|
type: "string"
|
|
17264
17912
|
},
|
|
17265
|
-
status: {
|
|
17913
|
+
status: {
|
|
17914
|
+
description: "Current status of the access code within the operational lifecycle. `set` indicates that the code is active and operational.",
|
|
17915
|
+
enum: ["set"],
|
|
17916
|
+
type: "string"
|
|
17917
|
+
},
|
|
17266
17918
|
type: {
|
|
17267
|
-
description:
|
|
17919
|
+
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
17920
|
enum: ["time_bound", "ongoing"],
|
|
17269
17921
|
type: "string"
|
|
17270
17922
|
},
|
|
17271
17923
|
warnings: {
|
|
17272
|
-
description:
|
|
17924
|
+
description: "Warnings associated with the [access code](https://docs.seam.co/latest/capability-guides/smart-locks/access-codes).",
|
|
17273
17925
|
items: {
|
|
17926
|
+
description: "Warnings associated with the [access code](https://docs.seam.co/latest/capability-guides/smart-locks/access-codes).",
|
|
17274
17927
|
discriminator: { propertyName: "warning_code" },
|
|
17275
17928
|
oneOf: [
|
|
17276
17929
|
{
|
|
17277
|
-
description: "Failed to set code on
|
|
17930
|
+
description: "Failed to set code on SmartThings device.",
|
|
17278
17931
|
properties: {
|
|
17279
|
-
created_at: {
|
|
17280
|
-
|
|
17932
|
+
created_at: {
|
|
17933
|
+
description: "Date and time at which Seam created the warning.",
|
|
17934
|
+
format: "date-time",
|
|
17935
|
+
type: "string"
|
|
17936
|
+
},
|
|
17937
|
+
message: {
|
|
17938
|
+
description: "Detailed description of the warning. Provides insights into the issue and potentially how to rectify it.",
|
|
17939
|
+
type: "string"
|
|
17940
|
+
},
|
|
17281
17941
|
warning_code: {
|
|
17282
17942
|
description: "Unique identifier of the type of warning. Enables quick recognition and categorization of the issue.",
|
|
17283
17943
|
enum: ["smartthings_failed_to_set_access_code"],
|
|
@@ -17290,8 +17950,15 @@ var openapi_default = {
|
|
|
17290
17950
|
{
|
|
17291
17951
|
description: "Duplicate access code detected.",
|
|
17292
17952
|
properties: {
|
|
17293
|
-
created_at: {
|
|
17294
|
-
|
|
17953
|
+
created_at: {
|
|
17954
|
+
description: "Date and time at which Seam created the warning.",
|
|
17955
|
+
format: "date-time",
|
|
17956
|
+
type: "string"
|
|
17957
|
+
},
|
|
17958
|
+
message: {
|
|
17959
|
+
description: "Detailed description of the warning. Provides insights into the issue and potentially how to rectify it.",
|
|
17960
|
+
type: "string"
|
|
17961
|
+
},
|
|
17295
17962
|
warning_code: {
|
|
17296
17963
|
description: "Unique identifier of the type of warning. Enables quick recognition and categorization of the issue.",
|
|
17297
17964
|
enum: ["schlage_detected_duplicate"],
|
|
@@ -17304,8 +17971,15 @@ var openapi_default = {
|
|
|
17304
17971
|
{
|
|
17305
17972
|
description: "Received an error when attempting to create this code.",
|
|
17306
17973
|
properties: {
|
|
17307
|
-
created_at: {
|
|
17308
|
-
|
|
17974
|
+
created_at: {
|
|
17975
|
+
description: "Date and time at which Seam created the warning.",
|
|
17976
|
+
format: "date-time",
|
|
17977
|
+
type: "string"
|
|
17978
|
+
},
|
|
17979
|
+
message: {
|
|
17980
|
+
description: "Detailed description of the warning. Provides insights into the issue and potentially how to rectify it.",
|
|
17981
|
+
type: "string"
|
|
17982
|
+
},
|
|
17309
17983
|
warning_code: {
|
|
17310
17984
|
description: "Unique identifier of the type of warning. Enables quick recognition and categorization of the issue.",
|
|
17311
17985
|
enum: ["schlage_creation_outage"],
|
|
@@ -17318,8 +17992,15 @@ var openapi_default = {
|
|
|
17318
17992
|
{
|
|
17319
17993
|
description: "Code was modified or removed externally after Seam successfully set it on the device.",
|
|
17320
17994
|
properties: {
|
|
17321
|
-
created_at: {
|
|
17322
|
-
|
|
17995
|
+
created_at: {
|
|
17996
|
+
description: "Date and time at which Seam created the warning.",
|
|
17997
|
+
format: "date-time",
|
|
17998
|
+
type: "string"
|
|
17999
|
+
},
|
|
18000
|
+
message: {
|
|
18001
|
+
description: "Detailed description of the warning. Provides insights into the issue and potentially how to rectify it.",
|
|
18002
|
+
type: "string"
|
|
18003
|
+
},
|
|
17323
18004
|
warning_code: {
|
|
17324
18005
|
description: "Unique identifier of the type of warning. Enables quick recognition and categorization of the issue.",
|
|
17325
18006
|
enum: ["code_modified_external_to_seam"],
|
|
@@ -17332,8 +18013,15 @@ var openapi_default = {
|
|
|
17332
18013
|
{
|
|
17333
18014
|
description: "Delay in setting code on device.",
|
|
17334
18015
|
properties: {
|
|
17335
|
-
created_at: {
|
|
17336
|
-
|
|
18016
|
+
created_at: {
|
|
18017
|
+
description: "Date and time at which Seam created the warning.",
|
|
18018
|
+
format: "date-time",
|
|
18019
|
+
type: "string"
|
|
18020
|
+
},
|
|
18021
|
+
message: {
|
|
18022
|
+
description: "Detailed description of the warning. Provides insights into the issue and potentially how to rectify it.",
|
|
18023
|
+
type: "string"
|
|
18024
|
+
},
|
|
17337
18025
|
warning_code: {
|
|
17338
18026
|
description: "Unique identifier of the type of warning. Enables quick recognition and categorization of the issue.",
|
|
17339
18027
|
enum: ["delay_in_setting_on_device"],
|
|
@@ -17346,8 +18034,15 @@ var openapi_default = {
|
|
|
17346
18034
|
{
|
|
17347
18035
|
description: "Delay in removing code from device.",
|
|
17348
18036
|
properties: {
|
|
17349
|
-
created_at: {
|
|
17350
|
-
|
|
18037
|
+
created_at: {
|
|
18038
|
+
description: "Date and time at which Seam created the warning.",
|
|
18039
|
+
format: "date-time",
|
|
18040
|
+
type: "string"
|
|
18041
|
+
},
|
|
18042
|
+
message: {
|
|
18043
|
+
description: "Detailed description of the warning. Provides insights into the issue and potentially how to rectify it.",
|
|
18044
|
+
type: "string"
|
|
18045
|
+
},
|
|
17351
18046
|
warning_code: {
|
|
17352
18047
|
description: "Unique identifier of the type of warning. Enables quick recognition and categorization of the issue.",
|
|
17353
18048
|
enum: ["delay_in_removing_from_device"],
|
|
@@ -17358,10 +18053,17 @@ var openapi_default = {
|
|
|
17358
18053
|
type: "object"
|
|
17359
18054
|
},
|
|
17360
18055
|
{
|
|
17361
|
-
description: "Third
|
|
18056
|
+
description: "Third-party integration detected that may cause access codes to fail.",
|
|
17362
18057
|
properties: {
|
|
17363
|
-
created_at: {
|
|
17364
|
-
|
|
18058
|
+
created_at: {
|
|
18059
|
+
description: "Date and time at which Seam created the warning.",
|
|
18060
|
+
format: "date-time",
|
|
18061
|
+
type: "string"
|
|
18062
|
+
},
|
|
18063
|
+
message: {
|
|
18064
|
+
description: "Detailed description of the warning. Provides insights into the issue and potentially how to rectify it.",
|
|
18065
|
+
type: "string"
|
|
18066
|
+
},
|
|
17365
18067
|
warning_code: {
|
|
17366
18068
|
description: "Unique identifier of the type of warning. Enables quick recognition and categorization of the issue.",
|
|
17367
18069
|
enum: ["third_party_integration_detected"],
|
|
@@ -17374,8 +18076,15 @@ var openapi_default = {
|
|
|
17374
18076
|
{
|
|
17375
18077
|
description: "Access code has not yet been fully moved to the device.",
|
|
17376
18078
|
properties: {
|
|
17377
|
-
created_at: {
|
|
17378
|
-
|
|
18079
|
+
created_at: {
|
|
18080
|
+
description: "Date and time at which Seam created the warning.",
|
|
18081
|
+
format: "date-time",
|
|
18082
|
+
type: "string"
|
|
18083
|
+
},
|
|
18084
|
+
message: {
|
|
18085
|
+
description: "Detailed description of the warning. Provides insights into the issue and potentially how to rectify it.",
|
|
18086
|
+
type: "string"
|
|
18087
|
+
},
|
|
17379
18088
|
warning_code: {
|
|
17380
18089
|
description: "Unique identifier of the type of warning. Enables quick recognition and categorization of the issue.",
|
|
17381
18090
|
enum: ["august_device_programming_delay"],
|
|
@@ -17388,8 +18097,15 @@ var openapi_default = {
|
|
|
17388
18097
|
{
|
|
17389
18098
|
description: "August lock is temporarily offline.",
|
|
17390
18099
|
properties: {
|
|
17391
|
-
created_at: {
|
|
17392
|
-
|
|
18100
|
+
created_at: {
|
|
18101
|
+
description: "Date and time at which Seam created the warning.",
|
|
18102
|
+
format: "date-time",
|
|
18103
|
+
type: "string"
|
|
18104
|
+
},
|
|
18105
|
+
message: {
|
|
18106
|
+
description: "Detailed description of the warning. Provides insights into the issue and potentially how to rectify it.",
|
|
18107
|
+
type: "string"
|
|
18108
|
+
},
|
|
17393
18109
|
warning_code: {
|
|
17394
18110
|
description: "Unique identifier of the type of error. Enables quick recognition and categorization of the issue.",
|
|
17395
18111
|
enum: ["august_lock_temporarily_offline"],
|
|
@@ -17402,8 +18118,15 @@ var openapi_default = {
|
|
|
17402
18118
|
{
|
|
17403
18119
|
description: "Algopins must be used within 24 hours.",
|
|
17404
18120
|
properties: {
|
|
17405
|
-
created_at: {
|
|
17406
|
-
|
|
18121
|
+
created_at: {
|
|
18122
|
+
description: "Date and time at which Seam created the warning.",
|
|
18123
|
+
format: "date-time",
|
|
18124
|
+
type: "string"
|
|
18125
|
+
},
|
|
18126
|
+
message: {
|
|
18127
|
+
description: "Detailed description of the warning. Provides insights into the issue and potentially how to rectify it.",
|
|
18128
|
+
type: "string"
|
|
18129
|
+
},
|
|
17407
18130
|
warning_code: {
|
|
17408
18131
|
description: "Unique identifier of the type of warning. Enables quick recognition and categorization of the issue.",
|
|
17409
18132
|
enum: ["igloo_algopin_must_be_used_within_24_hours"],
|
|
@@ -17416,8 +18139,15 @@ var openapi_default = {
|
|
|
17416
18139
|
{
|
|
17417
18140
|
description: "Management was transferred to another workspace.",
|
|
17418
18141
|
properties: {
|
|
17419
|
-
created_at: {
|
|
17420
|
-
|
|
18142
|
+
created_at: {
|
|
18143
|
+
description: "Date and time at which Seam created the warning.",
|
|
18144
|
+
format: "date-time",
|
|
18145
|
+
type: "string"
|
|
18146
|
+
},
|
|
18147
|
+
message: {
|
|
18148
|
+
description: "Detailed description of the warning. Provides insights into the issue and potentially how to rectify it.",
|
|
18149
|
+
type: "string"
|
|
18150
|
+
},
|
|
17421
18151
|
warning_code: {
|
|
17422
18152
|
description: "Unique identifier of the type of warning. Enables quick recognition and categorization of the issue.",
|
|
17423
18153
|
enum: ["management_transferred"],
|
|
@@ -17428,10 +18158,17 @@ var openapi_default = {
|
|
|
17428
18158
|
type: "object"
|
|
17429
18159
|
},
|
|
17430
18160
|
{
|
|
17431
|
-
description: "Unable to confirm the access code is set on Kwikset device.",
|
|
18161
|
+
description: "Unable to confirm that the access code is set on Kwikset device.",
|
|
17432
18162
|
properties: {
|
|
17433
|
-
created_at: {
|
|
17434
|
-
|
|
18163
|
+
created_at: {
|
|
18164
|
+
description: "Date and time at which Seam created the warning.",
|
|
18165
|
+
format: "date-time",
|
|
18166
|
+
type: "string"
|
|
18167
|
+
},
|
|
18168
|
+
message: {
|
|
18169
|
+
description: "Detailed description of the warning. Provides insights into the issue and potentially how to rectify it.",
|
|
18170
|
+
type: "string"
|
|
18171
|
+
},
|
|
17435
18172
|
warning_code: {
|
|
17436
18173
|
description: "Unique identifier of the type of warning. Enables quick recognition and categorization of the issue.",
|
|
17437
18174
|
enum: ["kwikset_unable_to_confirm_code"],
|
|
@@ -18134,14 +18871,13 @@ var openapi_default = {
|
|
|
18134
18871
|
from: {
|
|
18135
18872
|
properties: {
|
|
18136
18873
|
ends_at: {
|
|
18137
|
-
description: "Date and time at which the user's access ends, in [ISO 8601](https://www.iso.org/iso-8601-date-and-time-format.html) format.",
|
|
18138
18874
|
format: "date-time",
|
|
18139
18875
|
nullable: true,
|
|
18140
18876
|
type: "string"
|
|
18141
18877
|
},
|
|
18142
18878
|
starts_at: {
|
|
18143
|
-
description: "Date and time at which the user's access starts, in [ISO 8601](https://www.iso.org/iso-8601-date-and-time-format.html) format.",
|
|
18144
18879
|
format: "date-time",
|
|
18880
|
+
nullable: true,
|
|
18145
18881
|
type: "string"
|
|
18146
18882
|
}
|
|
18147
18883
|
},
|
|
@@ -18155,14 +18891,13 @@ var openapi_default = {
|
|
|
18155
18891
|
to: {
|
|
18156
18892
|
properties: {
|
|
18157
18893
|
ends_at: {
|
|
18158
|
-
description: "Date and time at which the user's access ends, in [ISO 8601](https://www.iso.org/iso-8601-date-and-time-format.html) format.",
|
|
18159
18894
|
format: "date-time",
|
|
18160
18895
|
nullable: true,
|
|
18161
18896
|
type: "string"
|
|
18162
18897
|
},
|
|
18163
18898
|
starts_at: {
|
|
18164
|
-
description: "Date and time at which the user's access starts, in [ISO 8601](https://www.iso.org/iso-8601-date-and-time-format.html) format.",
|
|
18165
18899
|
format: "date-time",
|
|
18900
|
+
nullable: true,
|
|
18166
18901
|
type: "string"
|
|
18167
18902
|
}
|
|
18168
18903
|
},
|
|
@@ -19306,40 +20041,85 @@ var openapi_default = {
|
|
|
19306
20041
|
paths: {
|
|
19307
20042
|
"/access_codes/create": {
|
|
19308
20043
|
post: {
|
|
20044
|
+
description: "Creates a new [access code](https://docs.seam.co/latest/capability-guides/smart-locks/access-codes).",
|
|
19309
20045
|
operationId: "accessCodesCreatePost",
|
|
19310
20046
|
requestBody: {
|
|
19311
20047
|
content: {
|
|
19312
20048
|
"application/json": {
|
|
19313
20049
|
schema: {
|
|
19314
20050
|
properties: {
|
|
19315
|
-
allow_external_modification: {
|
|
20051
|
+
allow_external_modification: {
|
|
20052
|
+
description: "Indicates whether [external modification](https://docs.seam.co/latest/api/access_codes#external-modification) of the code is allowed. Default: `false`.",
|
|
20053
|
+
type: "boolean"
|
|
20054
|
+
},
|
|
19316
20055
|
attempt_for_offline_device: {
|
|
19317
20056
|
default: true,
|
|
19318
20057
|
type: "boolean"
|
|
19319
20058
|
},
|
|
19320
20059
|
code: {
|
|
20060
|
+
description: "Code to be used for access.",
|
|
19321
20061
|
maxLength: 9,
|
|
19322
20062
|
minLength: 4,
|
|
19323
20063
|
pattern: "^\\d+$",
|
|
19324
20064
|
type: "string"
|
|
19325
20065
|
},
|
|
19326
|
-
common_code_key: {
|
|
19327
|
-
|
|
19328
|
-
|
|
19329
|
-
|
|
19330
|
-
|
|
19331
|
-
|
|
20066
|
+
common_code_key: {
|
|
20067
|
+
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).",
|
|
20068
|
+
type: "string"
|
|
20069
|
+
},
|
|
20070
|
+
device_id: {
|
|
20071
|
+
description: "ID of the device for which to create the new access code.",
|
|
20072
|
+
format: "uuid",
|
|
20073
|
+
type: "string"
|
|
20074
|
+
},
|
|
20075
|
+
ends_at: {
|
|
20076
|
+
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`.",
|
|
20077
|
+
type: "string"
|
|
20078
|
+
},
|
|
20079
|
+
is_external_modification_allowed: {
|
|
20080
|
+
description: "Indicates whether [external modification](https://docs.seam.co/latest/api/access_codes#external-modification) of the code is allowed. Default: `false`.",
|
|
20081
|
+
type: "boolean"
|
|
20082
|
+
},
|
|
20083
|
+
is_offline_access_code: {
|
|
20084
|
+
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).",
|
|
20085
|
+
type: "boolean"
|
|
20086
|
+
},
|
|
20087
|
+
is_one_time_use: {
|
|
20088
|
+
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.",
|
|
20089
|
+
type: "boolean"
|
|
20090
|
+
},
|
|
19332
20091
|
max_time_rounding: {
|
|
19333
20092
|
default: "1hour",
|
|
20093
|
+
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
20094
|
enum: ["1hour", "1day", "1h", "1d"],
|
|
19335
20095
|
type: "string"
|
|
19336
20096
|
},
|
|
19337
|
-
name: {
|
|
19338
|
-
|
|
19339
|
-
|
|
19340
|
-
|
|
19341
|
-
|
|
19342
|
-
|
|
20097
|
+
name: {
|
|
20098
|
+
description: "Name of the new access code.",
|
|
20099
|
+
type: "string"
|
|
20100
|
+
},
|
|
20101
|
+
prefer_native_scheduling: {
|
|
20102
|
+
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`.",
|
|
20103
|
+
type: "boolean"
|
|
20104
|
+
},
|
|
20105
|
+
preferred_code_length: {
|
|
20106
|
+
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.",
|
|
20107
|
+
format: "float",
|
|
20108
|
+
type: "number"
|
|
20109
|
+
},
|
|
20110
|
+
starts_at: {
|
|
20111
|
+
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.",
|
|
20112
|
+
type: "string"
|
|
20113
|
+
},
|
|
20114
|
+
sync: {
|
|
20115
|
+
default: false,
|
|
20116
|
+
type: "boolean",
|
|
20117
|
+
"x-undocumented": "Only used internally."
|
|
20118
|
+
},
|
|
20119
|
+
use_backup_access_code_pool: {
|
|
20120
|
+
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).",
|
|
20121
|
+
type: "boolean"
|
|
20122
|
+
},
|
|
19343
20123
|
use_offline_access_code: { type: "boolean" }
|
|
19344
20124
|
},
|
|
19345
20125
|
required: ["device_id"],
|
|
@@ -19382,51 +20162,88 @@ var openapi_default = {
|
|
|
19382
20162
|
"x-fern-sdk-group-name": ["access_codes"],
|
|
19383
20163
|
"x-fern-sdk-method-name": "create",
|
|
19384
20164
|
"x-fern-sdk-return-value": "access_code",
|
|
19385
|
-
"x-response-key": "access_code"
|
|
20165
|
+
"x-response-key": "access_code",
|
|
20166
|
+
"x-title": "Create an Access Code"
|
|
19386
20167
|
}
|
|
19387
20168
|
},
|
|
19388
20169
|
"/access_codes/create_multiple": {
|
|
19389
20170
|
post: {
|
|
20171
|
+
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
20172
|
operationId: "accessCodesCreateMultiplePost",
|
|
19391
20173
|
requestBody: {
|
|
19392
20174
|
content: {
|
|
19393
20175
|
"application/json": {
|
|
19394
20176
|
schema: {
|
|
19395
20177
|
properties: {
|
|
19396
|
-
allow_external_modification: {
|
|
20178
|
+
allow_external_modification: {
|
|
20179
|
+
description: "Indicates whether [external modification](https://docs.seam.co/latest/api/access_codes#external-modification) of the code is allowed. Default: `false`.",
|
|
20180
|
+
type: "boolean"
|
|
20181
|
+
},
|
|
19397
20182
|
attempt_for_offline_device: {
|
|
19398
20183
|
default: true,
|
|
19399
20184
|
type: "boolean"
|
|
19400
20185
|
},
|
|
19401
20186
|
behavior_when_code_cannot_be_shared: {
|
|
19402
20187
|
default: "throw",
|
|
20188
|
+
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
20189
|
enum: ["throw", "create_random_code"],
|
|
19404
20190
|
type: "string"
|
|
19405
20191
|
},
|
|
19406
20192
|
code: {
|
|
20193
|
+
description: "Code to be used for access.",
|
|
19407
20194
|
maxLength: 9,
|
|
19408
20195
|
minLength: 4,
|
|
19409
20196
|
pattern: "^\\d+$",
|
|
19410
20197
|
type: "string"
|
|
19411
20198
|
},
|
|
19412
20199
|
device_ids: {
|
|
20200
|
+
description: "IDs of the devices for which to create the new access codes.",
|
|
19413
20201
|
items: { format: "uuid", type: "string" },
|
|
19414
20202
|
type: "array"
|
|
19415
20203
|
},
|
|
19416
|
-
ends_at: {
|
|
19417
|
-
|
|
19418
|
-
|
|
19419
|
-
|
|
20204
|
+
ends_at: {
|
|
20205
|
+
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`.",
|
|
20206
|
+
type: "string"
|
|
20207
|
+
},
|
|
20208
|
+
is_external_modification_allowed: {
|
|
20209
|
+
description: "Indicates whether [external modification](https://docs.seam.co/latest/api/access_codes#external-modification) of the code is allowed. Default: `false`.",
|
|
20210
|
+
type: "boolean"
|
|
20211
|
+
},
|
|
20212
|
+
is_offline_access_code: {
|
|
20213
|
+
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).",
|
|
20214
|
+
type: "boolean"
|
|
20215
|
+
},
|
|
20216
|
+
is_one_time_use: {
|
|
20217
|
+
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.",
|
|
20218
|
+
type: "boolean"
|
|
20219
|
+
},
|
|
19420
20220
|
max_time_rounding: {
|
|
19421
20221
|
default: "1hour",
|
|
20222
|
+
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
20223
|
enum: ["1hour", "1day", "1h", "1d"],
|
|
19423
20224
|
type: "string"
|
|
19424
20225
|
},
|
|
19425
|
-
name: {
|
|
19426
|
-
|
|
19427
|
-
|
|
19428
|
-
|
|
19429
|
-
|
|
20226
|
+
name: {
|
|
20227
|
+
description: "Name of the new access code.",
|
|
20228
|
+
type: "string"
|
|
20229
|
+
},
|
|
20230
|
+
prefer_native_scheduling: {
|
|
20231
|
+
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`.",
|
|
20232
|
+
type: "boolean"
|
|
20233
|
+
},
|
|
20234
|
+
preferred_code_length: {
|
|
20235
|
+
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.",
|
|
20236
|
+
format: "float",
|
|
20237
|
+
type: "number"
|
|
20238
|
+
},
|
|
20239
|
+
starts_at: {
|
|
20240
|
+
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.",
|
|
20241
|
+
type: "string"
|
|
20242
|
+
},
|
|
20243
|
+
use_backup_access_code_pool: {
|
|
20244
|
+
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).",
|
|
20245
|
+
type: "boolean"
|
|
20246
|
+
},
|
|
19430
20247
|
use_offline_access_code: { type: "boolean" }
|
|
19431
20248
|
},
|
|
19432
20249
|
required: ["device_ids"],
|
|
@@ -19468,49 +20285,86 @@ var openapi_default = {
|
|
|
19468
20285
|
"x-fern-sdk-group-name": ["access_codes"],
|
|
19469
20286
|
"x-fern-sdk-method-name": "create_multiple",
|
|
19470
20287
|
"x-fern-sdk-return-value": "access_codes",
|
|
19471
|
-
"x-response-key": "access_codes"
|
|
20288
|
+
"x-response-key": "access_codes",
|
|
20289
|
+
"x-title": "Create Multiple Linked Access Codes"
|
|
19472
20290
|
},
|
|
19473
20291
|
put: {
|
|
20292
|
+
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
20293
|
operationId: "accessCodesCreateMultiplePut",
|
|
19475
20294
|
requestBody: {
|
|
19476
20295
|
content: {
|
|
19477
20296
|
"application/json": {
|
|
19478
20297
|
schema: {
|
|
19479
20298
|
properties: {
|
|
19480
|
-
allow_external_modification: {
|
|
20299
|
+
allow_external_modification: {
|
|
20300
|
+
description: "Indicates whether [external modification](https://docs.seam.co/latest/api/access_codes#external-modification) of the code is allowed. Default: `false`.",
|
|
20301
|
+
type: "boolean"
|
|
20302
|
+
},
|
|
19481
20303
|
attempt_for_offline_device: {
|
|
19482
20304
|
default: true,
|
|
19483
20305
|
type: "boolean"
|
|
19484
20306
|
},
|
|
19485
20307
|
behavior_when_code_cannot_be_shared: {
|
|
19486
20308
|
default: "throw",
|
|
20309
|
+
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
20310
|
enum: ["throw", "create_random_code"],
|
|
19488
20311
|
type: "string"
|
|
19489
20312
|
},
|
|
19490
20313
|
code: {
|
|
20314
|
+
description: "Code to be used for access.",
|
|
19491
20315
|
maxLength: 9,
|
|
19492
20316
|
minLength: 4,
|
|
19493
20317
|
pattern: "^\\d+$",
|
|
19494
20318
|
type: "string"
|
|
19495
20319
|
},
|
|
19496
20320
|
device_ids: {
|
|
20321
|
+
description: "IDs of the devices for which to create the new access codes.",
|
|
19497
20322
|
items: { format: "uuid", type: "string" },
|
|
19498
20323
|
type: "array"
|
|
19499
20324
|
},
|
|
19500
|
-
ends_at: {
|
|
19501
|
-
|
|
19502
|
-
|
|
19503
|
-
|
|
20325
|
+
ends_at: {
|
|
20326
|
+
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`.",
|
|
20327
|
+
type: "string"
|
|
20328
|
+
},
|
|
20329
|
+
is_external_modification_allowed: {
|
|
20330
|
+
description: "Indicates whether [external modification](https://docs.seam.co/latest/api/access_codes#external-modification) of the code is allowed. Default: `false`.",
|
|
20331
|
+
type: "boolean"
|
|
20332
|
+
},
|
|
20333
|
+
is_offline_access_code: {
|
|
20334
|
+
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).",
|
|
20335
|
+
type: "boolean"
|
|
20336
|
+
},
|
|
20337
|
+
is_one_time_use: {
|
|
20338
|
+
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.",
|
|
20339
|
+
type: "boolean"
|
|
20340
|
+
},
|
|
19504
20341
|
max_time_rounding: {
|
|
19505
20342
|
default: "1hour",
|
|
20343
|
+
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
20344
|
enum: ["1hour", "1day", "1h", "1d"],
|
|
19507
20345
|
type: "string"
|
|
19508
20346
|
},
|
|
19509
|
-
name: {
|
|
19510
|
-
|
|
19511
|
-
|
|
19512
|
-
|
|
19513
|
-
|
|
20347
|
+
name: {
|
|
20348
|
+
description: "Name of the new access code.",
|
|
20349
|
+
type: "string"
|
|
20350
|
+
},
|
|
20351
|
+
prefer_native_scheduling: {
|
|
20352
|
+
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`.",
|
|
20353
|
+
type: "boolean"
|
|
20354
|
+
},
|
|
20355
|
+
preferred_code_length: {
|
|
20356
|
+
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.",
|
|
20357
|
+
format: "float",
|
|
20358
|
+
type: "number"
|
|
20359
|
+
},
|
|
20360
|
+
starts_at: {
|
|
20361
|
+
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.",
|
|
20362
|
+
type: "string"
|
|
20363
|
+
},
|
|
20364
|
+
use_backup_access_code_pool: {
|
|
20365
|
+
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).",
|
|
20366
|
+
type: "boolean"
|
|
20367
|
+
},
|
|
19514
20368
|
use_offline_access_code: { type: "boolean" }
|
|
19515
20369
|
},
|
|
19516
20370
|
required: ["device_ids"],
|
|
@@ -19550,20 +20404,34 @@ var openapi_default = {
|
|
|
19550
20404
|
summary: "/access_codes/create_multiple",
|
|
19551
20405
|
tags: ["/access_codes"],
|
|
19552
20406
|
"x-fern-ignore": true,
|
|
19553
|
-
"x-response-key": "access_codes"
|
|
20407
|
+
"x-response-key": "access_codes",
|
|
20408
|
+
"x-title": "Create Multiple Linked Access Codes"
|
|
19554
20409
|
}
|
|
19555
20410
|
},
|
|
19556
20411
|
"/access_codes/delete": {
|
|
19557
20412
|
post: {
|
|
20413
|
+
description: "Deletes an [access code](https://docs.seam.co/latest/capability-guides/smart-locks/access-codes).",
|
|
19558
20414
|
operationId: "accessCodesDeletePost",
|
|
19559
20415
|
requestBody: {
|
|
19560
20416
|
content: {
|
|
19561
20417
|
"application/json": {
|
|
19562
20418
|
schema: {
|
|
19563
20419
|
properties: {
|
|
19564
|
-
access_code_id: {
|
|
19565
|
-
|
|
19566
|
-
|
|
20420
|
+
access_code_id: {
|
|
20421
|
+
description: "ID of the access code to delete.",
|
|
20422
|
+
format: "uuid",
|
|
20423
|
+
type: "string"
|
|
20424
|
+
},
|
|
20425
|
+
device_id: {
|
|
20426
|
+
description: "ID of the device for which to delete the access code.",
|
|
20427
|
+
format: "uuid",
|
|
20428
|
+
type: "string"
|
|
20429
|
+
},
|
|
20430
|
+
sync: {
|
|
20431
|
+
default: false,
|
|
20432
|
+
type: "boolean",
|
|
20433
|
+
"x-undocumented": "Only used internally."
|
|
20434
|
+
}
|
|
19567
20435
|
},
|
|
19568
20436
|
required: ["access_code_id"],
|
|
19569
20437
|
type: "object"
|
|
@@ -19603,7 +20471,8 @@ var openapi_default = {
|
|
|
19603
20471
|
"x-action-attempt-type": "DELETE_ACCESS_CODE",
|
|
19604
20472
|
"x-fern-sdk-group-name": ["access_codes"],
|
|
19605
20473
|
"x-fern-sdk-method-name": "delete",
|
|
19606
|
-
"x-response-key": null
|
|
20474
|
+
"x-response-key": null,
|
|
20475
|
+
"x-title": "Delete an Access Code"
|
|
19607
20476
|
}
|
|
19608
20477
|
},
|
|
19609
20478
|
"/access_codes/generate_code": {
|
|
@@ -19657,15 +20526,27 @@ var openapi_default = {
|
|
|
19657
20526
|
},
|
|
19658
20527
|
"/access_codes/get": {
|
|
19659
20528
|
post: {
|
|
20529
|
+
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
20530
|
operationId: "accessCodesGetPost",
|
|
19661
20531
|
requestBody: {
|
|
19662
20532
|
content: {
|
|
19663
20533
|
"application/json": {
|
|
19664
20534
|
schema: {
|
|
19665
20535
|
properties: {
|
|
19666
|
-
access_code_id: {
|
|
19667
|
-
|
|
19668
|
-
|
|
20536
|
+
access_code_id: {
|
|
20537
|
+
description: "ID of the access code that you want to get. You must specify either `access_code_id` or both `device_id` and `code`.",
|
|
20538
|
+
format: "uuid",
|
|
20539
|
+
type: "string"
|
|
20540
|
+
},
|
|
20541
|
+
code: {
|
|
20542
|
+
description: "Code of the access code that you want to get. You must specify either `access_code_id` or both `device_id` and `code`.",
|
|
20543
|
+
type: "string"
|
|
20544
|
+
},
|
|
20545
|
+
device_id: {
|
|
20546
|
+
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`.",
|
|
20547
|
+
format: "uuid",
|
|
20548
|
+
type: "string"
|
|
20549
|
+
}
|
|
19669
20550
|
},
|
|
19670
20551
|
type: "object"
|
|
19671
20552
|
}
|
|
@@ -19702,11 +20583,13 @@ var openapi_default = {
|
|
|
19702
20583
|
"x-fern-sdk-group-name": ["access_codes"],
|
|
19703
20584
|
"x-fern-sdk-method-name": "get",
|
|
19704
20585
|
"x-fern-sdk-return-value": "access_code",
|
|
19705
|
-
"x-response-key": "access_code"
|
|
20586
|
+
"x-response-key": "access_code",
|
|
20587
|
+
"x-title": "Get an Access Code"
|
|
19706
20588
|
}
|
|
19707
20589
|
},
|
|
19708
20590
|
"/access_codes/list": {
|
|
19709
20591
|
post: {
|
|
20592
|
+
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
20593
|
operationId: "accessCodesListPost",
|
|
19711
20594
|
requestBody: {
|
|
19712
20595
|
content: {
|
|
@@ -19714,11 +20597,19 @@ var openapi_default = {
|
|
|
19714
20597
|
schema: {
|
|
19715
20598
|
properties: {
|
|
19716
20599
|
access_code_ids: {
|
|
20600
|
+
description: "IDs of the access codes that you want to retrieve. Specify either `device_id` or `access_code_ids`.",
|
|
19717
20601
|
items: { format: "uuid", type: "string" },
|
|
19718
20602
|
type: "array"
|
|
19719
20603
|
},
|
|
19720
|
-
device_id: {
|
|
19721
|
-
|
|
20604
|
+
device_id: {
|
|
20605
|
+
description: "ID of the device for which you want to list access codes. Specify either `device_id` or `access_code_ids`.",
|
|
20606
|
+
format: "uuid",
|
|
20607
|
+
type: "string"
|
|
20608
|
+
},
|
|
20609
|
+
user_identifier_key: {
|
|
20610
|
+
description: "Your user ID for the user by which to filter access codes.",
|
|
20611
|
+
type: "string"
|
|
20612
|
+
}
|
|
19722
20613
|
},
|
|
19723
20614
|
type: "object"
|
|
19724
20615
|
}
|
|
@@ -19758,19 +20649,24 @@ var openapi_default = {
|
|
|
19758
20649
|
"x-fern-sdk-group-name": ["access_codes"],
|
|
19759
20650
|
"x-fern-sdk-method-name": "list",
|
|
19760
20651
|
"x-fern-sdk-return-value": "access_codes",
|
|
19761
|
-
"x-response-key": "access_codes"
|
|
20652
|
+
"x-response-key": "access_codes",
|
|
20653
|
+
"x-title": "List Access Codes"
|
|
19762
20654
|
}
|
|
19763
20655
|
},
|
|
19764
20656
|
"/access_codes/pull_backup_access_code": {
|
|
19765
20657
|
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).",
|
|
20658
|
+
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
20659
|
operationId: "accessCodesPullBackupAccessCodePost",
|
|
19768
20660
|
requestBody: {
|
|
19769
20661
|
content: {
|
|
19770
20662
|
"application/json": {
|
|
19771
20663
|
schema: {
|
|
19772
20664
|
properties: {
|
|
19773
|
-
access_code_id: {
|
|
20665
|
+
access_code_id: {
|
|
20666
|
+
description: "ID of the access code for which you want to pull a backup access code.",
|
|
20667
|
+
format: "uuid",
|
|
20668
|
+
type: "string"
|
|
20669
|
+
}
|
|
19774
20670
|
},
|
|
19775
20671
|
required: ["access_code_id"],
|
|
19776
20672
|
type: "object"
|
|
@@ -19811,11 +20707,13 @@ var openapi_default = {
|
|
|
19811
20707
|
"x-fern-sdk-group-name": ["access_codes"],
|
|
19812
20708
|
"x-fern-sdk-method-name": "pull_backup_access_code",
|
|
19813
20709
|
"x-fern-sdk-return-value": "access_code",
|
|
19814
|
-
"x-response-key": "access_code"
|
|
20710
|
+
"x-response-key": "access_code",
|
|
20711
|
+
"x-title": "Pull a Backup Access Code"
|
|
19815
20712
|
}
|
|
19816
20713
|
},
|
|
19817
20714
|
"/access_codes/simulate/create_unmanaged_access_code": {
|
|
19818
20715
|
post: {
|
|
20716
|
+
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
20717
|
operationId: "accessCodesSimulateCreateUnmanagedAccessCodePost",
|
|
19820
20718
|
requestBody: {
|
|
19821
20719
|
content: {
|
|
@@ -19823,13 +20721,21 @@ var openapi_default = {
|
|
|
19823
20721
|
schema: {
|
|
19824
20722
|
properties: {
|
|
19825
20723
|
code: {
|
|
20724
|
+
description: "Code of the simulated unmanaged access code.",
|
|
19826
20725
|
maxLength: 8,
|
|
19827
20726
|
minLength: 4,
|
|
19828
20727
|
pattern: "^\\d+$",
|
|
19829
20728
|
type: "string"
|
|
19830
20729
|
},
|
|
19831
|
-
device_id: {
|
|
19832
|
-
|
|
20730
|
+
device_id: {
|
|
20731
|
+
description: "ID of the device for which you want to simulate the creation of an unmanaged access code.",
|
|
20732
|
+
format: "uuid",
|
|
20733
|
+
type: "string"
|
|
20734
|
+
},
|
|
20735
|
+
name: {
|
|
20736
|
+
description: "Name of the simulated unmanaged access code.",
|
|
20737
|
+
type: "string"
|
|
20738
|
+
}
|
|
19833
20739
|
},
|
|
19834
20740
|
required: ["device_id", "name", "code"],
|
|
19835
20741
|
type: "object"
|
|
@@ -19869,22 +20775,41 @@ var openapi_default = {
|
|
|
19869
20775
|
"x-fern-sdk-group-name": ["access_codes", "simulate"],
|
|
19870
20776
|
"x-fern-sdk-method-name": "create_unmanaged_access_code",
|
|
19871
20777
|
"x-fern-sdk-return-value": "access_code",
|
|
19872
|
-
"x-response-key": "access_code"
|
|
20778
|
+
"x-response-key": "access_code",
|
|
20779
|
+
"x-title": "Simulate Creating an Unmanaged Access Code"
|
|
19873
20780
|
}
|
|
19874
20781
|
},
|
|
19875
20782
|
"/access_codes/unmanaged/convert_to_managed": {
|
|
19876
20783
|
patch: {
|
|
20784
|
+
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
20785
|
operationId: "accessCodesUnmanagedConvertToManagedPatch",
|
|
19878
20786
|
requestBody: {
|
|
19879
20787
|
content: {
|
|
19880
20788
|
"application/json": {
|
|
19881
20789
|
schema: {
|
|
19882
20790
|
properties: {
|
|
19883
|
-
access_code_id: {
|
|
19884
|
-
|
|
19885
|
-
|
|
19886
|
-
|
|
19887
|
-
|
|
20791
|
+
access_code_id: {
|
|
20792
|
+
description: "ID of the unmanaged access code that you want to convert to a managed access code.",
|
|
20793
|
+
format: "uuid",
|
|
20794
|
+
type: "string"
|
|
20795
|
+
},
|
|
20796
|
+
allow_external_modification: {
|
|
20797
|
+
description: "Indicates whether external modification of the access code is allowed.",
|
|
20798
|
+
type: "boolean"
|
|
20799
|
+
},
|
|
20800
|
+
force: {
|
|
20801
|
+
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`.",
|
|
20802
|
+
type: "boolean"
|
|
20803
|
+
},
|
|
20804
|
+
is_external_modification_allowed: {
|
|
20805
|
+
description: "Indicates whether external modification of the access code is allowed.",
|
|
20806
|
+
type: "boolean"
|
|
20807
|
+
},
|
|
20808
|
+
sync: {
|
|
20809
|
+
default: false,
|
|
20810
|
+
type: "boolean",
|
|
20811
|
+
"x-undocumented": "Only used internally."
|
|
20812
|
+
}
|
|
19888
20813
|
},
|
|
19889
20814
|
required: ["access_code_id"],
|
|
19890
20815
|
type: "object"
|
|
@@ -19918,20 +20843,39 @@ var openapi_default = {
|
|
|
19918
20843
|
tags: ["/access_codes"],
|
|
19919
20844
|
"x-action-attempt-type": "CONVERT_ACCESS_CODE_TO_MANAGED",
|
|
19920
20845
|
"x-fern-ignore": true,
|
|
19921
|
-
"x-response-key": null
|
|
20846
|
+
"x-response-key": null,
|
|
20847
|
+
"x-title": "Convert an Unmanaged Access Code"
|
|
19922
20848
|
},
|
|
19923
20849
|
post: {
|
|
20850
|
+
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
20851
|
operationId: "accessCodesUnmanagedConvertToManagedPost",
|
|
19925
20852
|
requestBody: {
|
|
19926
20853
|
content: {
|
|
19927
20854
|
"application/json": {
|
|
19928
20855
|
schema: {
|
|
19929
20856
|
properties: {
|
|
19930
|
-
access_code_id: {
|
|
19931
|
-
|
|
19932
|
-
|
|
19933
|
-
|
|
19934
|
-
|
|
20857
|
+
access_code_id: {
|
|
20858
|
+
description: "ID of the unmanaged access code that you want to convert to a managed access code.",
|
|
20859
|
+
format: "uuid",
|
|
20860
|
+
type: "string"
|
|
20861
|
+
},
|
|
20862
|
+
allow_external_modification: {
|
|
20863
|
+
description: "Indicates whether external modification of the access code is allowed.",
|
|
20864
|
+
type: "boolean"
|
|
20865
|
+
},
|
|
20866
|
+
force: {
|
|
20867
|
+
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`.",
|
|
20868
|
+
type: "boolean"
|
|
20869
|
+
},
|
|
20870
|
+
is_external_modification_allowed: {
|
|
20871
|
+
description: "Indicates whether external modification of the access code is allowed.",
|
|
20872
|
+
type: "boolean"
|
|
20873
|
+
},
|
|
20874
|
+
sync: {
|
|
20875
|
+
default: false,
|
|
20876
|
+
type: "boolean",
|
|
20877
|
+
"x-undocumented": "Only used internally."
|
|
20878
|
+
}
|
|
19935
20879
|
},
|
|
19936
20880
|
required: ["access_code_id"],
|
|
19937
20881
|
type: "object"
|
|
@@ -19966,19 +20910,29 @@ var openapi_default = {
|
|
|
19966
20910
|
"x-action-attempt-type": "CONVERT_ACCESS_CODE_TO_MANAGED",
|
|
19967
20911
|
"x-fern-sdk-group-name": ["access_codes", "unmanaged"],
|
|
19968
20912
|
"x-fern-sdk-method-name": "convert_to_managed",
|
|
19969
|
-
"x-response-key": null
|
|
20913
|
+
"x-response-key": null,
|
|
20914
|
+
"x-title": "Convert an Unmanaged Access Code"
|
|
19970
20915
|
}
|
|
19971
20916
|
},
|
|
19972
20917
|
"/access_codes/unmanaged/delete": {
|
|
19973
20918
|
post: {
|
|
20919
|
+
description: "Deletes an [unmanaged access code](https://docs.seam.co/latest/capability-guides/smart-locks/access-codes/migrating-existing-access-codes).",
|
|
19974
20920
|
operationId: "accessCodesUnmanagedDeletePost",
|
|
19975
20921
|
requestBody: {
|
|
19976
20922
|
content: {
|
|
19977
20923
|
"application/json": {
|
|
19978
20924
|
schema: {
|
|
19979
20925
|
properties: {
|
|
19980
|
-
access_code_id: {
|
|
19981
|
-
|
|
20926
|
+
access_code_id: {
|
|
20927
|
+
description: "ID of the unmanaged access code to delete.",
|
|
20928
|
+
format: "uuid",
|
|
20929
|
+
type: "string"
|
|
20930
|
+
},
|
|
20931
|
+
sync: {
|
|
20932
|
+
default: false,
|
|
20933
|
+
type: "boolean",
|
|
20934
|
+
"x-undocumented": "Only used internally."
|
|
20935
|
+
}
|
|
19982
20936
|
},
|
|
19983
20937
|
required: ["access_code_id"],
|
|
19984
20938
|
type: "object"
|
|
@@ -20018,20 +20972,33 @@ var openapi_default = {
|
|
|
20018
20972
|
"x-action-attempt-type": "DELETE_ACCESS_CODE",
|
|
20019
20973
|
"x-fern-sdk-group-name": ["access_codes", "unmanaged"],
|
|
20020
20974
|
"x-fern-sdk-method-name": "delete",
|
|
20021
|
-
"x-response-key": null
|
|
20975
|
+
"x-response-key": null,
|
|
20976
|
+
"x-title": "Delete an Unmanaged Access Code"
|
|
20022
20977
|
}
|
|
20023
20978
|
},
|
|
20024
20979
|
"/access_codes/unmanaged/get": {
|
|
20025
20980
|
post: {
|
|
20981
|
+
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
20982
|
operationId: "accessCodesUnmanagedGetPost",
|
|
20027
20983
|
requestBody: {
|
|
20028
20984
|
content: {
|
|
20029
20985
|
"application/json": {
|
|
20030
20986
|
schema: {
|
|
20031
20987
|
properties: {
|
|
20032
|
-
access_code_id: {
|
|
20033
|
-
|
|
20034
|
-
|
|
20988
|
+
access_code_id: {
|
|
20989
|
+
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`.",
|
|
20990
|
+
format: "uuid",
|
|
20991
|
+
type: "string"
|
|
20992
|
+
},
|
|
20993
|
+
code: {
|
|
20994
|
+
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`.",
|
|
20995
|
+
type: "string"
|
|
20996
|
+
},
|
|
20997
|
+
device_id: {
|
|
20998
|
+
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`.",
|
|
20999
|
+
format: "uuid",
|
|
21000
|
+
type: "string"
|
|
21001
|
+
}
|
|
20035
21002
|
},
|
|
20036
21003
|
type: "object"
|
|
20037
21004
|
}
|
|
@@ -20070,19 +21037,28 @@ var openapi_default = {
|
|
|
20070
21037
|
"x-fern-sdk-group-name": ["access_codes", "unmanaged"],
|
|
20071
21038
|
"x-fern-sdk-method-name": "get",
|
|
20072
21039
|
"x-fern-sdk-return-value": "access_code",
|
|
20073
|
-
"x-response-key": "access_code"
|
|
21040
|
+
"x-response-key": "access_code",
|
|
21041
|
+
"x-title": "Get an Unmanaged Access Code"
|
|
20074
21042
|
}
|
|
20075
21043
|
},
|
|
20076
21044
|
"/access_codes/unmanaged/list": {
|
|
20077
21045
|
post: {
|
|
21046
|
+
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
21047
|
operationId: "accessCodesUnmanagedListPost",
|
|
20079
21048
|
requestBody: {
|
|
20080
21049
|
content: {
|
|
20081
21050
|
"application/json": {
|
|
20082
21051
|
schema: {
|
|
20083
21052
|
properties: {
|
|
20084
|
-
device_id: {
|
|
20085
|
-
|
|
21053
|
+
device_id: {
|
|
21054
|
+
description: "ID of the device for which you want to list unmanaged access codes.",
|
|
21055
|
+
format: "uuid",
|
|
21056
|
+
type: "string"
|
|
21057
|
+
},
|
|
21058
|
+
user_identifier_key: {
|
|
21059
|
+
description: "Your user ID for the user by which to filter unmanaged access codes.",
|
|
21060
|
+
type: "string"
|
|
21061
|
+
}
|
|
20086
21062
|
},
|
|
20087
21063
|
required: ["device_id"],
|
|
20088
21064
|
type: "object"
|
|
@@ -20125,21 +21101,36 @@ var openapi_default = {
|
|
|
20125
21101
|
"x-fern-sdk-group-name": ["access_codes", "unmanaged"],
|
|
20126
21102
|
"x-fern-sdk-method-name": "list",
|
|
20127
21103
|
"x-fern-sdk-return-value": "access_codes",
|
|
20128
|
-
"x-response-key": "access_codes"
|
|
21104
|
+
"x-response-key": "access_codes",
|
|
21105
|
+
"x-title": "List Unmanaged Access Codes"
|
|
20129
21106
|
}
|
|
20130
21107
|
},
|
|
20131
21108
|
"/access_codes/unmanaged/update": {
|
|
20132
21109
|
patch: {
|
|
21110
|
+
description: "Updates a specified [unmanaged access code](https://docs.seam.co/latest/capability-guides/smart-locks/access-codes/migrating-existing-access-codes).",
|
|
20133
21111
|
operationId: "accessCodesUnmanagedUpdatePatch",
|
|
20134
21112
|
requestBody: {
|
|
20135
21113
|
content: {
|
|
20136
21114
|
"application/json": {
|
|
20137
21115
|
schema: {
|
|
20138
21116
|
properties: {
|
|
20139
|
-
access_code_id: {
|
|
20140
|
-
|
|
20141
|
-
|
|
20142
|
-
|
|
21117
|
+
access_code_id: {
|
|
21118
|
+
description: "ID of the unmanaged access code that you want to update.",
|
|
21119
|
+
format: "uuid",
|
|
21120
|
+
type: "string"
|
|
21121
|
+
},
|
|
21122
|
+
allow_external_modification: {
|
|
21123
|
+
description: "Indicates whether [external modification](https://docs.seam.co/latest/capability-guides/smart-locks/access-codes#external-modification) of the code is allowed.",
|
|
21124
|
+
type: "boolean"
|
|
21125
|
+
},
|
|
21126
|
+
force: {
|
|
21127
|
+
description: "Indicates whether to force the unmanaged access code update.",
|
|
21128
|
+
type: "boolean"
|
|
21129
|
+
},
|
|
21130
|
+
is_external_modification_allowed: {
|
|
21131
|
+
description: "Indicates whether [external modification](https://docs.seam.co/latest/capability-guides/smart-locks/access-codes#external-modification) of the code is allowed.",
|
|
21132
|
+
type: "boolean"
|
|
21133
|
+
},
|
|
20143
21134
|
is_managed: { type: "boolean" }
|
|
20144
21135
|
},
|
|
20145
21136
|
required: ["access_code_id", "is_managed"],
|
|
@@ -20173,19 +21164,34 @@ var openapi_default = {
|
|
|
20173
21164
|
summary: "/access_codes/unmanaged/update",
|
|
20174
21165
|
tags: ["/access_codes"],
|
|
20175
21166
|
"x-fern-ignore": true,
|
|
20176
|
-
"x-response-key": null
|
|
21167
|
+
"x-response-key": null,
|
|
21168
|
+
"x-title": "Update an Unmanaged Access Code"
|
|
20177
21169
|
},
|
|
20178
21170
|
post: {
|
|
21171
|
+
description: "Updates a specified [unmanaged access code](https://docs.seam.co/latest/capability-guides/smart-locks/access-codes/migrating-existing-access-codes).",
|
|
20179
21172
|
operationId: "accessCodesUnmanagedUpdatePost",
|
|
20180
21173
|
requestBody: {
|
|
20181
21174
|
content: {
|
|
20182
21175
|
"application/json": {
|
|
20183
21176
|
schema: {
|
|
20184
21177
|
properties: {
|
|
20185
|
-
access_code_id: {
|
|
20186
|
-
|
|
20187
|
-
|
|
20188
|
-
|
|
21178
|
+
access_code_id: {
|
|
21179
|
+
description: "ID of the unmanaged access code that you want to update.",
|
|
21180
|
+
format: "uuid",
|
|
21181
|
+
type: "string"
|
|
21182
|
+
},
|
|
21183
|
+
allow_external_modification: {
|
|
21184
|
+
description: "Indicates whether [external modification](https://docs.seam.co/latest/capability-guides/smart-locks/access-codes#external-modification) of the code is allowed.",
|
|
21185
|
+
type: "boolean"
|
|
21186
|
+
},
|
|
21187
|
+
force: {
|
|
21188
|
+
description: "Indicates whether to force the unmanaged access code update.",
|
|
21189
|
+
type: "boolean"
|
|
21190
|
+
},
|
|
21191
|
+
is_external_modification_allowed: {
|
|
21192
|
+
description: "Indicates whether [external modification](https://docs.seam.co/latest/capability-guides/smart-locks/access-codes#external-modification) of the code is allowed.",
|
|
21193
|
+
type: "boolean"
|
|
21194
|
+
},
|
|
20189
21195
|
is_managed: { type: "boolean" }
|
|
20190
21196
|
},
|
|
20191
21197
|
required: ["access_code_id", "is_managed"],
|
|
@@ -20220,47 +21226,101 @@ var openapi_default = {
|
|
|
20220
21226
|
tags: ["/access_codes"],
|
|
20221
21227
|
"x-fern-sdk-group-name": ["access_codes", "unmanaged"],
|
|
20222
21228
|
"x-fern-sdk-method-name": "update",
|
|
20223
|
-
"x-response-key": null
|
|
21229
|
+
"x-response-key": null,
|
|
21230
|
+
"x-title": "Update an Unmanaged Access Code"
|
|
20224
21231
|
}
|
|
20225
21232
|
},
|
|
20226
21233
|
"/access_codes/update": {
|
|
20227
21234
|
patch: {
|
|
21235
|
+
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
21236
|
operationId: "accessCodesUpdatePatch",
|
|
20229
21237
|
requestBody: {
|
|
20230
21238
|
content: {
|
|
20231
21239
|
"application/json": {
|
|
20232
21240
|
schema: {
|
|
20233
21241
|
properties: {
|
|
20234
|
-
access_code_id: {
|
|
20235
|
-
|
|
21242
|
+
access_code_id: {
|
|
21243
|
+
description: "ID of the access code that you want to update.",
|
|
21244
|
+
format: "uuid",
|
|
21245
|
+
type: "string"
|
|
21246
|
+
},
|
|
21247
|
+
allow_external_modification: {
|
|
21248
|
+
description: "Indicates whether [external modification](https://docs.seam.co/latest/api/access_codes#external-modification) of the code is allowed. Default: `false`.",
|
|
21249
|
+
type: "boolean"
|
|
21250
|
+
},
|
|
20236
21251
|
attempt_for_offline_device: {
|
|
20237
21252
|
default: true,
|
|
20238
21253
|
type: "boolean"
|
|
20239
21254
|
},
|
|
20240
21255
|
code: {
|
|
21256
|
+
description: "Code to be used for access.",
|
|
20241
21257
|
maxLength: 9,
|
|
20242
21258
|
minLength: 4,
|
|
20243
21259
|
pattern: "^\\d+$",
|
|
20244
21260
|
type: "string"
|
|
20245
21261
|
},
|
|
20246
|
-
device_id: {
|
|
20247
|
-
|
|
20248
|
-
|
|
20249
|
-
|
|
20250
|
-
|
|
20251
|
-
|
|
21262
|
+
device_id: {
|
|
21263
|
+
description: "ID of the device containing the access code that you want to update.",
|
|
21264
|
+
format: "uuid",
|
|
21265
|
+
type: "string"
|
|
21266
|
+
},
|
|
21267
|
+
ends_at: {
|
|
21268
|
+
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`.",
|
|
21269
|
+
type: "string"
|
|
21270
|
+
},
|
|
21271
|
+
is_external_modification_allowed: {
|
|
21272
|
+
description: "Indicates whether [external modification](https://docs.seam.co/latest/api/access_codes#external-modification) of the code is allowed. Default: `false`.",
|
|
21273
|
+
type: "boolean"
|
|
21274
|
+
},
|
|
21275
|
+
is_managed: {
|
|
21276
|
+
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`.",
|
|
21277
|
+
type: "boolean"
|
|
21278
|
+
},
|
|
21279
|
+
is_offline_access_code: {
|
|
21280
|
+
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).",
|
|
21281
|
+
type: "boolean"
|
|
21282
|
+
},
|
|
21283
|
+
is_one_time_use: {
|
|
21284
|
+
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.",
|
|
21285
|
+
type: "boolean"
|
|
21286
|
+
},
|
|
20252
21287
|
max_time_rounding: {
|
|
20253
21288
|
default: "1hour",
|
|
21289
|
+
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
21290
|
enum: ["1hour", "1day", "1h", "1d"],
|
|
20255
21291
|
type: "string"
|
|
20256
21292
|
},
|
|
20257
|
-
name: {
|
|
20258
|
-
|
|
20259
|
-
|
|
20260
|
-
|
|
20261
|
-
|
|
20262
|
-
|
|
20263
|
-
|
|
21293
|
+
name: {
|
|
21294
|
+
description: "Name of the new access code.",
|
|
21295
|
+
type: "string"
|
|
21296
|
+
},
|
|
21297
|
+
prefer_native_scheduling: {
|
|
21298
|
+
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`.",
|
|
21299
|
+
type: "boolean"
|
|
21300
|
+
},
|
|
21301
|
+
preferred_code_length: {
|
|
21302
|
+
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.",
|
|
21303
|
+
format: "float",
|
|
21304
|
+
type: "number"
|
|
21305
|
+
},
|
|
21306
|
+
starts_at: {
|
|
21307
|
+
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.",
|
|
21308
|
+
type: "string"
|
|
21309
|
+
},
|
|
21310
|
+
sync: {
|
|
21311
|
+
default: false,
|
|
21312
|
+
type: "boolean",
|
|
21313
|
+
"x-undocumented": "Only used internally."
|
|
21314
|
+
},
|
|
21315
|
+
type: {
|
|
21316
|
+
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).",
|
|
21317
|
+
enum: ["ongoing", "time_bound"],
|
|
21318
|
+
type: "string"
|
|
21319
|
+
},
|
|
21320
|
+
use_backup_access_code_pool: {
|
|
21321
|
+
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).",
|
|
21322
|
+
type: "boolean"
|
|
21323
|
+
},
|
|
20264
21324
|
use_offline_access_code: { type: "boolean" }
|
|
20265
21325
|
},
|
|
20266
21326
|
required: ["access_code_id"],
|
|
@@ -20300,45 +21360,99 @@ var openapi_default = {
|
|
|
20300
21360
|
tags: ["/access_codes"],
|
|
20301
21361
|
"x-action-attempt-type": "UPDATE_ACCESS_CODE",
|
|
20302
21362
|
"x-fern-ignore": true,
|
|
20303
|
-
"x-response-key": null
|
|
21363
|
+
"x-response-key": null,
|
|
21364
|
+
"x-title": "Update an Access Code"
|
|
20304
21365
|
},
|
|
20305
21366
|
post: {
|
|
21367
|
+
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
21368
|
operationId: "accessCodesUpdatePost",
|
|
20307
21369
|
requestBody: {
|
|
20308
21370
|
content: {
|
|
20309
21371
|
"application/json": {
|
|
20310
21372
|
schema: {
|
|
20311
21373
|
properties: {
|
|
20312
|
-
access_code_id: {
|
|
20313
|
-
|
|
21374
|
+
access_code_id: {
|
|
21375
|
+
description: "ID of the access code that you want to update.",
|
|
21376
|
+
format: "uuid",
|
|
21377
|
+
type: "string"
|
|
21378
|
+
},
|
|
21379
|
+
allow_external_modification: {
|
|
21380
|
+
description: "Indicates whether [external modification](https://docs.seam.co/latest/api/access_codes#external-modification) of the code is allowed. Default: `false`.",
|
|
21381
|
+
type: "boolean"
|
|
21382
|
+
},
|
|
20314
21383
|
attempt_for_offline_device: {
|
|
20315
21384
|
default: true,
|
|
20316
21385
|
type: "boolean"
|
|
20317
21386
|
},
|
|
20318
21387
|
code: {
|
|
21388
|
+
description: "Code to be used for access.",
|
|
20319
21389
|
maxLength: 9,
|
|
20320
21390
|
minLength: 4,
|
|
20321
21391
|
pattern: "^\\d+$",
|
|
20322
21392
|
type: "string"
|
|
20323
21393
|
},
|
|
20324
|
-
device_id: {
|
|
20325
|
-
|
|
20326
|
-
|
|
20327
|
-
|
|
20328
|
-
|
|
20329
|
-
|
|
21394
|
+
device_id: {
|
|
21395
|
+
description: "ID of the device containing the access code that you want to update.",
|
|
21396
|
+
format: "uuid",
|
|
21397
|
+
type: "string"
|
|
21398
|
+
},
|
|
21399
|
+
ends_at: {
|
|
21400
|
+
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`.",
|
|
21401
|
+
type: "string"
|
|
21402
|
+
},
|
|
21403
|
+
is_external_modification_allowed: {
|
|
21404
|
+
description: "Indicates whether [external modification](https://docs.seam.co/latest/api/access_codes#external-modification) of the code is allowed. Default: `false`.",
|
|
21405
|
+
type: "boolean"
|
|
21406
|
+
},
|
|
21407
|
+
is_managed: {
|
|
21408
|
+
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`.",
|
|
21409
|
+
type: "boolean"
|
|
21410
|
+
},
|
|
21411
|
+
is_offline_access_code: {
|
|
21412
|
+
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).",
|
|
21413
|
+
type: "boolean"
|
|
21414
|
+
},
|
|
21415
|
+
is_one_time_use: {
|
|
21416
|
+
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.",
|
|
21417
|
+
type: "boolean"
|
|
21418
|
+
},
|
|
20330
21419
|
max_time_rounding: {
|
|
20331
21420
|
default: "1hour",
|
|
21421
|
+
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
21422
|
enum: ["1hour", "1day", "1h", "1d"],
|
|
20333
21423
|
type: "string"
|
|
20334
21424
|
},
|
|
20335
|
-
name: {
|
|
20336
|
-
|
|
20337
|
-
|
|
20338
|
-
|
|
20339
|
-
|
|
20340
|
-
|
|
20341
|
-
|
|
21425
|
+
name: {
|
|
21426
|
+
description: "Name of the new access code.",
|
|
21427
|
+
type: "string"
|
|
21428
|
+
},
|
|
21429
|
+
prefer_native_scheduling: {
|
|
21430
|
+
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`.",
|
|
21431
|
+
type: "boolean"
|
|
21432
|
+
},
|
|
21433
|
+
preferred_code_length: {
|
|
21434
|
+
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.",
|
|
21435
|
+
format: "float",
|
|
21436
|
+
type: "number"
|
|
21437
|
+
},
|
|
21438
|
+
starts_at: {
|
|
21439
|
+
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.",
|
|
21440
|
+
type: "string"
|
|
21441
|
+
},
|
|
21442
|
+
sync: {
|
|
21443
|
+
default: false,
|
|
21444
|
+
type: "boolean",
|
|
21445
|
+
"x-undocumented": "Only used internally."
|
|
21446
|
+
},
|
|
21447
|
+
type: {
|
|
21448
|
+
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).",
|
|
21449
|
+
enum: ["ongoing", "time_bound"],
|
|
21450
|
+
type: "string"
|
|
21451
|
+
},
|
|
21452
|
+
use_backup_access_code_pool: {
|
|
21453
|
+
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).",
|
|
21454
|
+
type: "boolean"
|
|
21455
|
+
},
|
|
20342
21456
|
use_offline_access_code: { type: "boolean" }
|
|
20343
21457
|
},
|
|
20344
21458
|
required: ["access_code_id"],
|
|
@@ -20379,45 +21493,99 @@ var openapi_default = {
|
|
|
20379
21493
|
"x-action-attempt-type": "UPDATE_ACCESS_CODE",
|
|
20380
21494
|
"x-fern-sdk-group-name": ["access_codes"],
|
|
20381
21495
|
"x-fern-sdk-method-name": "update",
|
|
20382
|
-
"x-response-key": null
|
|
21496
|
+
"x-response-key": null,
|
|
21497
|
+
"x-title": "Update an Access Code"
|
|
20383
21498
|
},
|
|
20384
21499
|
put: {
|
|
21500
|
+
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
21501
|
operationId: "accessCodesUpdatePut",
|
|
20386
21502
|
requestBody: {
|
|
20387
21503
|
content: {
|
|
20388
21504
|
"application/json": {
|
|
20389
21505
|
schema: {
|
|
20390
21506
|
properties: {
|
|
20391
|
-
access_code_id: {
|
|
20392
|
-
|
|
21507
|
+
access_code_id: {
|
|
21508
|
+
description: "ID of the access code that you want to update.",
|
|
21509
|
+
format: "uuid",
|
|
21510
|
+
type: "string"
|
|
21511
|
+
},
|
|
21512
|
+
allow_external_modification: {
|
|
21513
|
+
description: "Indicates whether [external modification](https://docs.seam.co/latest/api/access_codes#external-modification) of the code is allowed. Default: `false`.",
|
|
21514
|
+
type: "boolean"
|
|
21515
|
+
},
|
|
20393
21516
|
attempt_for_offline_device: {
|
|
20394
21517
|
default: true,
|
|
20395
21518
|
type: "boolean"
|
|
20396
21519
|
},
|
|
20397
21520
|
code: {
|
|
21521
|
+
description: "Code to be used for access.",
|
|
20398
21522
|
maxLength: 9,
|
|
20399
21523
|
minLength: 4,
|
|
20400
21524
|
pattern: "^\\d+$",
|
|
20401
21525
|
type: "string"
|
|
20402
21526
|
},
|
|
20403
|
-
device_id: {
|
|
20404
|
-
|
|
20405
|
-
|
|
20406
|
-
|
|
20407
|
-
|
|
20408
|
-
|
|
21527
|
+
device_id: {
|
|
21528
|
+
description: "ID of the device containing the access code that you want to update.",
|
|
21529
|
+
format: "uuid",
|
|
21530
|
+
type: "string"
|
|
21531
|
+
},
|
|
21532
|
+
ends_at: {
|
|
21533
|
+
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`.",
|
|
21534
|
+
type: "string"
|
|
21535
|
+
},
|
|
21536
|
+
is_external_modification_allowed: {
|
|
21537
|
+
description: "Indicates whether [external modification](https://docs.seam.co/latest/api/access_codes#external-modification) of the code is allowed. Default: `false`.",
|
|
21538
|
+
type: "boolean"
|
|
21539
|
+
},
|
|
21540
|
+
is_managed: {
|
|
21541
|
+
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`.",
|
|
21542
|
+
type: "boolean"
|
|
21543
|
+
},
|
|
21544
|
+
is_offline_access_code: {
|
|
21545
|
+
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).",
|
|
21546
|
+
type: "boolean"
|
|
21547
|
+
},
|
|
21548
|
+
is_one_time_use: {
|
|
21549
|
+
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.",
|
|
21550
|
+
type: "boolean"
|
|
21551
|
+
},
|
|
20409
21552
|
max_time_rounding: {
|
|
20410
21553
|
default: "1hour",
|
|
21554
|
+
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
21555
|
enum: ["1hour", "1day", "1h", "1d"],
|
|
20412
21556
|
type: "string"
|
|
20413
21557
|
},
|
|
20414
|
-
name: {
|
|
20415
|
-
|
|
20416
|
-
|
|
20417
|
-
|
|
20418
|
-
|
|
20419
|
-
|
|
20420
|
-
|
|
21558
|
+
name: {
|
|
21559
|
+
description: "Name of the new access code.",
|
|
21560
|
+
type: "string"
|
|
21561
|
+
},
|
|
21562
|
+
prefer_native_scheduling: {
|
|
21563
|
+
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`.",
|
|
21564
|
+
type: "boolean"
|
|
21565
|
+
},
|
|
21566
|
+
preferred_code_length: {
|
|
21567
|
+
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.",
|
|
21568
|
+
format: "float",
|
|
21569
|
+
type: "number"
|
|
21570
|
+
},
|
|
21571
|
+
starts_at: {
|
|
21572
|
+
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.",
|
|
21573
|
+
type: "string"
|
|
21574
|
+
},
|
|
21575
|
+
sync: {
|
|
21576
|
+
default: false,
|
|
21577
|
+
type: "boolean",
|
|
21578
|
+
"x-undocumented": "Only used internally."
|
|
21579
|
+
},
|
|
21580
|
+
type: {
|
|
21581
|
+
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).",
|
|
21582
|
+
enum: ["ongoing", "time_bound"],
|
|
21583
|
+
type: "string"
|
|
21584
|
+
},
|
|
21585
|
+
use_backup_access_code_pool: {
|
|
21586
|
+
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).",
|
|
21587
|
+
type: "boolean"
|
|
21588
|
+
},
|
|
20421
21589
|
use_offline_access_code: { type: "boolean" }
|
|
20422
21590
|
},
|
|
20423
21591
|
required: ["access_code_id"],
|
|
@@ -20457,21 +21625,35 @@ var openapi_default = {
|
|
|
20457
21625
|
tags: ["/access_codes"],
|
|
20458
21626
|
"x-action-attempt-type": "UPDATE_ACCESS_CODE",
|
|
20459
21627
|
"x-fern-ignore": true,
|
|
20460
|
-
"x-response-key": null
|
|
21628
|
+
"x-response-key": null,
|
|
21629
|
+
"x-title": "Update an Access Code"
|
|
20461
21630
|
}
|
|
20462
21631
|
},
|
|
20463
21632
|
"/access_codes/update_multiple": {
|
|
20464
21633
|
patch: {
|
|
21634
|
+
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
21635
|
operationId: "accessCodesUpdateMultiplePatch",
|
|
20466
21636
|
requestBody: {
|
|
20467
21637
|
content: {
|
|
20468
21638
|
"application/json": {
|
|
20469
21639
|
schema: {
|
|
20470
21640
|
properties: {
|
|
20471
|
-
common_code_key: {
|
|
20472
|
-
|
|
20473
|
-
|
|
20474
|
-
|
|
21641
|
+
common_code_key: {
|
|
21642
|
+
description: "Key that links the group of access codes, assigned on creation by `/access_codes/create_multiple`.",
|
|
21643
|
+
type: "string"
|
|
21644
|
+
},
|
|
21645
|
+
ends_at: {
|
|
21646
|
+
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`.",
|
|
21647
|
+
type: "string"
|
|
21648
|
+
},
|
|
21649
|
+
name: {
|
|
21650
|
+
description: "Name of the new access code.",
|
|
21651
|
+
type: "string"
|
|
21652
|
+
},
|
|
21653
|
+
starts_at: {
|
|
21654
|
+
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.",
|
|
21655
|
+
type: "string"
|
|
21656
|
+
}
|
|
20475
21657
|
},
|
|
20476
21658
|
required: ["common_code_key"],
|
|
20477
21659
|
type: "object"
|
|
@@ -20504,19 +21686,33 @@ var openapi_default = {
|
|
|
20504
21686
|
summary: "/access_codes/update_multiple",
|
|
20505
21687
|
tags: ["/access_codes"],
|
|
20506
21688
|
"x-fern-ignore": true,
|
|
20507
|
-
"x-response-key": null
|
|
21689
|
+
"x-response-key": null,
|
|
21690
|
+
"x-title": "Update Multiple Linked Access Codes"
|
|
20508
21691
|
},
|
|
20509
21692
|
post: {
|
|
21693
|
+
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
21694
|
operationId: "accessCodesUpdateMultiplePost",
|
|
20511
21695
|
requestBody: {
|
|
20512
21696
|
content: {
|
|
20513
21697
|
"application/json": {
|
|
20514
21698
|
schema: {
|
|
20515
21699
|
properties: {
|
|
20516
|
-
common_code_key: {
|
|
20517
|
-
|
|
20518
|
-
|
|
20519
|
-
|
|
21700
|
+
common_code_key: {
|
|
21701
|
+
description: "Key that links the group of access codes, assigned on creation by `/access_codes/create_multiple`.",
|
|
21702
|
+
type: "string"
|
|
21703
|
+
},
|
|
21704
|
+
ends_at: {
|
|
21705
|
+
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`.",
|
|
21706
|
+
type: "string"
|
|
21707
|
+
},
|
|
21708
|
+
name: {
|
|
21709
|
+
description: "Name of the new access code.",
|
|
21710
|
+
type: "string"
|
|
21711
|
+
},
|
|
21712
|
+
starts_at: {
|
|
21713
|
+
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.",
|
|
21714
|
+
type: "string"
|
|
21715
|
+
}
|
|
20520
21716
|
},
|
|
20521
21717
|
required: ["common_code_key"],
|
|
20522
21718
|
type: "object"
|
|
@@ -20550,7 +21746,8 @@ var openapi_default = {
|
|
|
20550
21746
|
tags: ["/access_codes"],
|
|
20551
21747
|
"x-fern-sdk-group-name": ["access_codes"],
|
|
20552
21748
|
"x-fern-sdk-method-name": "update_multiple",
|
|
20553
|
-
"x-response-key": null
|
|
21749
|
+
"x-response-key": null,
|
|
21750
|
+
"x-title": "Update Multiple Linked Access Codes"
|
|
20554
21751
|
}
|
|
20555
21752
|
},
|
|
20556
21753
|
"/acs/access_groups/add_user": {
|
|
@@ -22275,6 +23472,60 @@ var openapi_default = {
|
|
|
22275
23472
|
"x-title": "Encode a Credential"
|
|
22276
23473
|
}
|
|
22277
23474
|
},
|
|
23475
|
+
"/acs/encoders/get": {
|
|
23476
|
+
post: {
|
|
23477
|
+
description: "Returns a specified [encoder](https://docs.seam.co/latest/capability-guides/access-systems/working-with-card-encoders-and-scanners).",
|
|
23478
|
+
operationId: "acsEncodersGetPost",
|
|
23479
|
+
requestBody: {
|
|
23480
|
+
content: {
|
|
23481
|
+
"application/json": {
|
|
23482
|
+
schema: {
|
|
23483
|
+
properties: {
|
|
23484
|
+
acs_encoder_id: {
|
|
23485
|
+
description: "ID of the desired encoder.",
|
|
23486
|
+
format: "uuid",
|
|
23487
|
+
type: "string"
|
|
23488
|
+
}
|
|
23489
|
+
},
|
|
23490
|
+
required: ["acs_encoder_id"],
|
|
23491
|
+
type: "object"
|
|
23492
|
+
}
|
|
23493
|
+
}
|
|
23494
|
+
}
|
|
23495
|
+
},
|
|
23496
|
+
responses: {
|
|
23497
|
+
200: {
|
|
23498
|
+
content: {
|
|
23499
|
+
"application/json": {
|
|
23500
|
+
schema: {
|
|
23501
|
+
properties: {
|
|
23502
|
+
acs_encoder: { $ref: "#/components/schemas/acs_encoder" },
|
|
23503
|
+
ok: { type: "boolean" }
|
|
23504
|
+
},
|
|
23505
|
+
required: ["acs_encoder", "ok"],
|
|
23506
|
+
type: "object"
|
|
23507
|
+
}
|
|
23508
|
+
}
|
|
23509
|
+
},
|
|
23510
|
+
description: "OK"
|
|
23511
|
+
},
|
|
23512
|
+
400: { description: "Bad Request" },
|
|
23513
|
+
401: { description: "Unauthorized" }
|
|
23514
|
+
},
|
|
23515
|
+
security: [
|
|
23516
|
+
{ pat_with_workspace: [] },
|
|
23517
|
+
{ console_session_with_workspace: [] },
|
|
23518
|
+
{ api_key: [] }
|
|
23519
|
+
],
|
|
23520
|
+
summary: "/acs/encoders/get",
|
|
23521
|
+
tags: ["/acs"],
|
|
23522
|
+
"x-fern-sdk-group-name": ["acs", "encoders"],
|
|
23523
|
+
"x-fern-sdk-method-name": "get",
|
|
23524
|
+
"x-fern-sdk-return-value": "acs_encoder",
|
|
23525
|
+
"x-response-key": "acs_encoder",
|
|
23526
|
+
"x-title": "Get an Encoder"
|
|
23527
|
+
}
|
|
23528
|
+
},
|
|
22278
23529
|
"/acs/encoders/list": {
|
|
22279
23530
|
post: {
|
|
22280
23531
|
description: "Returns a list of all [encoders](https://docs.seam.co/latest/capability-guides/access-systems/working-with-card-encoders-and-scanners).",
|
|
@@ -28243,10 +29494,12 @@ var openapi_default = {
|
|
|
28243
29494
|
properties: {
|
|
28244
29495
|
can_tailscale_proxy_reach_bridge: {
|
|
28245
29496
|
description: "Tailscale proxy cannot reach the bridge",
|
|
29497
|
+
nullable: true,
|
|
28246
29498
|
type: "boolean"
|
|
28247
29499
|
},
|
|
28248
29500
|
can_tailscale_proxy_reach_tailscale_network: {
|
|
28249
29501
|
description: "Tailscale proxy cannot reach the Tailscale network",
|
|
29502
|
+
nullable: true,
|
|
28250
29503
|
type: "boolean"
|
|
28251
29504
|
},
|
|
28252
29505
|
created_at: {
|
|
@@ -28260,14 +29513,17 @@ var openapi_default = {
|
|
|
28260
29513
|
},
|
|
28261
29514
|
is_bridge_socks_server_healthy: {
|
|
28262
29515
|
description: "Bridge's SOCKS server is unhealthy",
|
|
29516
|
+
nullable: true,
|
|
28263
29517
|
type: "boolean"
|
|
28264
29518
|
},
|
|
28265
29519
|
is_tailscale_proxy_reachable: {
|
|
28266
29520
|
description: "Seam cannot reach the tailscale proxy",
|
|
29521
|
+
nullable: true,
|
|
28267
29522
|
type: "boolean"
|
|
28268
29523
|
},
|
|
28269
29524
|
is_tailscale_proxy_socks_server_healthy: {
|
|
28270
29525
|
description: "Tailscale proxy's SOCKS server is unhealthy",
|
|
29526
|
+
nullable: true,
|
|
28271
29527
|
type: "boolean"
|
|
28272
29528
|
},
|
|
28273
29529
|
message: { type: "string" }
|
|
@@ -28399,10 +29655,12 @@ var openapi_default = {
|
|
|
28399
29655
|
properties: {
|
|
28400
29656
|
can_tailscale_proxy_reach_bridge: {
|
|
28401
29657
|
description: "Tailscale proxy cannot reach the bridge",
|
|
29658
|
+
nullable: true,
|
|
28402
29659
|
type: "boolean"
|
|
28403
29660
|
},
|
|
28404
29661
|
can_tailscale_proxy_reach_tailscale_network: {
|
|
28405
29662
|
description: "Tailscale proxy cannot reach the Tailscale network",
|
|
29663
|
+
nullable: true,
|
|
28406
29664
|
type: "boolean"
|
|
28407
29665
|
},
|
|
28408
29666
|
created_at: {
|
|
@@ -28416,14 +29674,17 @@ var openapi_default = {
|
|
|
28416
29674
|
},
|
|
28417
29675
|
is_bridge_socks_server_healthy: {
|
|
28418
29676
|
description: "Bridge's SOCKS server is unhealthy",
|
|
29677
|
+
nullable: true,
|
|
28419
29678
|
type: "boolean"
|
|
28420
29679
|
},
|
|
28421
29680
|
is_tailscale_proxy_reachable: {
|
|
28422
29681
|
description: "Seam cannot reach the tailscale proxy",
|
|
29682
|
+
nullable: true,
|
|
28423
29683
|
type: "boolean"
|
|
28424
29684
|
},
|
|
28425
29685
|
is_tailscale_proxy_socks_server_healthy: {
|
|
28426
29686
|
description: "Tailscale proxy's SOCKS server is unhealthy",
|
|
29687
|
+
nullable: true,
|
|
28427
29688
|
type: "boolean"
|
|
28428
29689
|
},
|
|
28429
29690
|
message: { type: "string" }
|
|
@@ -28546,10 +29807,12 @@ var openapi_default = {
|
|
|
28546
29807
|
properties: {
|
|
28547
29808
|
can_tailscale_proxy_reach_bridge: {
|
|
28548
29809
|
description: "Tailscale proxy cannot reach the bridge",
|
|
29810
|
+
nullable: true,
|
|
28549
29811
|
type: "boolean"
|
|
28550
29812
|
},
|
|
28551
29813
|
can_tailscale_proxy_reach_tailscale_network: {
|
|
28552
29814
|
description: "Tailscale proxy cannot reach the Tailscale network",
|
|
29815
|
+
nullable: true,
|
|
28553
29816
|
type: "boolean"
|
|
28554
29817
|
},
|
|
28555
29818
|
created_at: {
|
|
@@ -28563,14 +29826,17 @@ var openapi_default = {
|
|
|
28563
29826
|
},
|
|
28564
29827
|
is_bridge_socks_server_healthy: {
|
|
28565
29828
|
description: "Bridge's SOCKS server is unhealthy",
|
|
29829
|
+
nullable: true,
|
|
28566
29830
|
type: "boolean"
|
|
28567
29831
|
},
|
|
28568
29832
|
is_tailscale_proxy_reachable: {
|
|
28569
29833
|
description: "Seam cannot reach the tailscale proxy",
|
|
29834
|
+
nullable: true,
|
|
28570
29835
|
type: "boolean"
|
|
28571
29836
|
},
|
|
28572
29837
|
is_tailscale_proxy_socks_server_healthy: {
|
|
28573
29838
|
description: "Tailscale proxy's SOCKS server is unhealthy",
|
|
29839
|
+
nullable: true,
|
|
28574
29840
|
type: "boolean"
|
|
28575
29841
|
},
|
|
28576
29842
|
message: { type: "string" }
|
|
@@ -28702,10 +29968,12 @@ var openapi_default = {
|
|
|
28702
29968
|
properties: {
|
|
28703
29969
|
can_tailscale_proxy_reach_bridge: {
|
|
28704
29970
|
description: "Tailscale proxy cannot reach the bridge",
|
|
29971
|
+
nullable: true,
|
|
28705
29972
|
type: "boolean"
|
|
28706
29973
|
},
|
|
28707
29974
|
can_tailscale_proxy_reach_tailscale_network: {
|
|
28708
29975
|
description: "Tailscale proxy cannot reach the Tailscale network",
|
|
29976
|
+
nullable: true,
|
|
28709
29977
|
type: "boolean"
|
|
28710
29978
|
},
|
|
28711
29979
|
created_at: {
|
|
@@ -28719,14 +29987,17 @@ var openapi_default = {
|
|
|
28719
29987
|
},
|
|
28720
29988
|
is_bridge_socks_server_healthy: {
|
|
28721
29989
|
description: "Bridge's SOCKS server is unhealthy",
|
|
29990
|
+
nullable: true,
|
|
28722
29991
|
type: "boolean"
|
|
28723
29992
|
},
|
|
28724
29993
|
is_tailscale_proxy_reachable: {
|
|
28725
29994
|
description: "Seam cannot reach the tailscale proxy",
|
|
29995
|
+
nullable: true,
|
|
28726
29996
|
type: "boolean"
|
|
28727
29997
|
},
|
|
28728
29998
|
is_tailscale_proxy_socks_server_healthy: {
|
|
28729
29999
|
description: "Tailscale proxy's SOCKS server is unhealthy",
|
|
30000
|
+
nullable: true,
|
|
28730
30001
|
type: "boolean"
|
|
28731
30002
|
},
|
|
28732
30003
|
message: { type: "string" }
|