@seamapi/http 2.1.0 → 2.2.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/lib/seam/connect/resources/access-code.d.ts +743 -56
- package/lib/seam/connect/resources/access-grant.d.ts +279 -10
- package/lib/seam/connect/resources/access-method.d.ts +204 -8
- package/lib/seam/connect/resources/acs-access-group.d.ts +242 -9
- package/lib/seam/connect/resources/acs-credential.d.ts +212 -6
- package/lib/seam/connect/resources/acs-encoder.d.ts +46 -0
- package/lib/seam/connect/resources/acs-entrance.d.ts +298 -5
- package/lib/seam/connect/resources/acs-system.d.ts +227 -11
- package/lib/seam/connect/resources/acs-user.d.ts +388 -19
- package/lib/seam/connect/resources/action-attempt.d.ts +954 -0
- package/lib/seam/connect/resources/batch.d.ts +3 -0
- package/lib/seam/connect/resources/client-session.d.ts +48 -0
- package/lib/seam/connect/resources/connect-webview.d.ts +70 -0
- package/lib/seam/connect/resources/connected-account.d.ts +281 -12
- package/lib/seam/connect/resources/customer-portal.d.ts +22 -0
- package/lib/seam/connect/resources/device-provider.d.ts +72 -0
- package/lib/seam/connect/resources/device.d.ts +2063 -41
- package/lib/seam/connect/resources/event.d.ts +4014 -0
- package/lib/seam/connect/resources/instant-key.d.ts +41 -0
- package/lib/seam/connect/resources/noise-threshold.d.ts +24 -0
- package/lib/seam/connect/resources/phone.d.ts +72 -0
- package/lib/seam/connect/resources/space.d.ts +54 -0
- package/lib/seam/connect/resources/thermostat-daily-program.d.ts +27 -0
- package/lib/seam/connect/resources/thermostat-schedule.d.ts +45 -0
- package/lib/seam/connect/resources/unmanaged-access-code.d.ts +602 -50
- package/lib/seam/connect/resources/unmanaged-access-grant.d.ts +267 -10
- package/lib/seam/connect/resources/unmanaged-access-method.d.ts +195 -8
- package/lib/seam/connect/resources/unmanaged-device.d.ts +810 -120
- package/lib/seam/connect/resources/unmanaged-user-identity.d.ts +79 -3
- package/lib/seam/connect/resources/user-identity.d.ts +82 -3
- package/lib/seam/connect/resources/webhook.d.ts +15 -0
- package/lib/seam/connect/resources/workspace.d.ts +45 -0
- package/lib/seam/connect/routes/access-codes/access-codes.d.ts +288 -0
- package/lib/seam/connect/routes/access-codes/access-codes.js +60 -0
- package/lib/seam/connect/routes/access-codes/access-codes.js.map +1 -1
- package/lib/seam/connect/routes/access-codes/simulate/simulate.d.ts +12 -0
- package/lib/seam/connect/routes/access-codes/simulate/simulate.js +3 -0
- package/lib/seam/connect/routes/access-codes/simulate/simulate.js.map +1 -1
- package/lib/seam/connect/routes/access-codes/unmanaged/unmanaged.d.ts +72 -0
- package/lib/seam/connect/routes/access-codes/unmanaged/unmanaged.js +21 -0
- package/lib/seam/connect/routes/access-codes/unmanaged/unmanaged.js.map +1 -1
- package/lib/seam/connect/routes/access-grants/access-grants.d.ts +177 -0
- package/lib/seam/connect/routes/access-grants/access-grants.js +21 -0
- package/lib/seam/connect/routes/access-grants/access-grants.js.map +1 -1
- package/lib/seam/connect/routes/access-grants/unmanaged/unmanaged.d.ts +43 -0
- package/lib/seam/connect/routes/access-grants/unmanaged/unmanaged.js +13 -0
- package/lib/seam/connect/routes/access-grants/unmanaged/unmanaged.js.map +1 -1
- package/lib/seam/connect/routes/access-methods/access-methods.d.ts +78 -0
- package/lib/seam/connect/routes/access-methods/access-methods.js +21 -0
- package/lib/seam/connect/routes/access-methods/access-methods.js.map +1 -1
- package/lib/seam/connect/routes/access-methods/unmanaged/unmanaged.d.ts +21 -0
- package/lib/seam/connect/routes/access-methods/unmanaged/unmanaged.js +6 -0
- package/lib/seam/connect/routes/access-methods/unmanaged/unmanaged.js.map +1 -1
- package/lib/seam/connect/routes/acs/access-groups/access-groups.d.ts +63 -0
- package/lib/seam/connect/routes/acs/access-groups/access-groups.js +21 -0
- package/lib/seam/connect/routes/acs/access-groups/access-groups.js.map +1 -1
- package/lib/seam/connect/routes/acs/credentials/credentials.d.ts +126 -0
- package/lib/seam/connect/routes/acs/credentials/credentials.js +24 -0
- package/lib/seam/connect/routes/acs/credentials/credentials.js.map +1 -1
- package/lib/seam/connect/routes/acs/encoders/encoders.d.ts +66 -0
- package/lib/seam/connect/routes/acs/encoders/encoders.js +15 -0
- package/lib/seam/connect/routes/acs/encoders/encoders.js.map +1 -1
- package/lib/seam/connect/routes/acs/encoders/simulate/simulate.d.ts +39 -0
- package/lib/seam/connect/routes/acs/encoders/simulate/simulate.js +12 -0
- package/lib/seam/connect/routes/acs/encoders/simulate/simulate.js.map +1 -1
- package/lib/seam/connect/routes/acs/entrances/entrances.d.ts +72 -0
- package/lib/seam/connect/routes/acs/entrances/entrances.js +15 -0
- package/lib/seam/connect/routes/acs/entrances/entrances.js.map +1 -1
- package/lib/seam/connect/routes/acs/systems/systems.d.ts +64 -0
- package/lib/seam/connect/routes/acs/systems/systems.js +16 -0
- package/lib/seam/connect/routes/acs/systems/systems.js.map +1 -1
- package/lib/seam/connect/routes/acs/users/users.d.ts +189 -0
- package/lib/seam/connect/routes/acs/users/users.js +33 -0
- package/lib/seam/connect/routes/acs/users/users.js.map +1 -1
- package/lib/seam/connect/routes/action-attempts/action-attempts.d.ts +21 -0
- package/lib/seam/connect/routes/action-attempts/action-attempts.js +6 -0
- package/lib/seam/connect/routes/action-attempts/action-attempts.js.map +1 -1
- package/lib/seam/connect/routes/client-sessions/client-sessions.d.ts +113 -0
- package/lib/seam/connect/routes/client-sessions/client-sessions.js +23 -0
- package/lib/seam/connect/routes/client-sessions/client-sessions.js.map +1 -1
- package/lib/seam/connect/routes/connect-webviews/connect-webviews.d.ts +76 -0
- package/lib/seam/connect/routes/connect-webviews/connect-webviews.js +22 -0
- package/lib/seam/connect/routes/connect-webviews/connect-webviews.js.map +1 -1
- package/lib/seam/connect/routes/connected-accounts/connected-accounts.d.ts +70 -0
- package/lib/seam/connect/routes/connected-accounts/connected-accounts.js +19 -0
- package/lib/seam/connect/routes/connected-accounts/connected-accounts.js.map +1 -1
- package/lib/seam/connect/routes/connected-accounts/simulate/simulate.d.ts +6 -0
- package/lib/seam/connect/routes/connected-accounts/simulate/simulate.js +3 -0
- package/lib/seam/connect/routes/connected-accounts/simulate/simulate.js.map +1 -1
- package/lib/seam/connect/routes/customers/customers.d.ts +1042 -0
- package/lib/seam/connect/routes/customers/customers.js +10 -0
- package/lib/seam/connect/routes/customers/customers.js.map +1 -1
- package/lib/seam/connect/routes/devices/devices.d.ts +122 -0
- package/lib/seam/connect/routes/devices/devices.js +23 -0
- package/lib/seam/connect/routes/devices/devices.js.map +1 -1
- package/lib/seam/connect/routes/devices/simulate/simulate.d.ts +42 -0
- package/lib/seam/connect/routes/devices/simulate/simulate.js +27 -0
- package/lib/seam/connect/routes/devices/simulate/simulate.js.map +1 -1
- package/lib/seam/connect/routes/devices/unmanaged/unmanaged.d.ts +80 -0
- package/lib/seam/connect/routes/devices/unmanaged/unmanaged.js +17 -0
- package/lib/seam/connect/routes/devices/unmanaged/unmanaged.js.map +1 -1
- package/lib/seam/connect/routes/events/events.d.ts +99 -0
- package/lib/seam/connect/routes/events/events.js +6 -0
- package/lib/seam/connect/routes/events/events.js.map +1 -1
- package/lib/seam/connect/routes/instant-keys/instant-keys.d.ts +21 -0
- package/lib/seam/connect/routes/instant-keys/instant-keys.js +9 -0
- package/lib/seam/connect/routes/instant-keys/instant-keys.js.map +1 -1
- package/lib/seam/connect/routes/locks/locks.d.ts +85 -0
- package/lib/seam/connect/routes/locks/locks.js +16 -0
- package/lib/seam/connect/routes/locks/locks.js.map +1 -1
- package/lib/seam/connect/routes/locks/simulate/simulate.d.ts +15 -0
- package/lib/seam/connect/routes/locks/simulate/simulate.js +6 -0
- package/lib/seam/connect/routes/locks/simulate/simulate.js.map +1 -1
- package/lib/seam/connect/routes/noise-sensors/noise-sensors.d.ts +51 -0
- package/lib/seam/connect/routes/noise-sensors/noise-sensors.js +3 -0
- package/lib/seam/connect/routes/noise-sensors/noise-sensors.js.map +1 -1
- package/lib/seam/connect/routes/noise-sensors/noise-thresholds/noise-thresholds.d.ts +66 -0
- package/lib/seam/connect/routes/noise-sensors/noise-thresholds/noise-thresholds.js +15 -0
- package/lib/seam/connect/routes/noise-sensors/noise-thresholds/noise-thresholds.js.map +1 -1
- package/lib/seam/connect/routes/noise-sensors/simulate/simulate.d.ts +6 -0
- package/lib/seam/connect/routes/noise-sensors/simulate/simulate.js +3 -0
- package/lib/seam/connect/routes/noise-sensors/simulate/simulate.js.map +1 -1
- package/lib/seam/connect/routes/phones/phones.d.ts +21 -0
- package/lib/seam/connect/routes/phones/phones.js +9 -0
- package/lib/seam/connect/routes/phones/phones.js.map +1 -1
- package/lib/seam/connect/routes/phones/simulate/simulate.d.ts +45 -0
- package/lib/seam/connect/routes/phones/simulate/simulate.js +3 -0
- package/lib/seam/connect/routes/phones/simulate/simulate.js.map +1 -1
- package/lib/seam/connect/routes/seam-http-endpoints-without-workspace.d.ts +6 -0
- package/lib/seam/connect/routes/seam-http-endpoints-without-workspace.js +6 -0
- package/lib/seam/connect/routes/seam-http-endpoints-without-workspace.js.map +1 -1
- package/lib/seam/connect/routes/seam-http-endpoints.d.ts +696 -0
- package/lib/seam/connect/routes/seam-http-endpoints.js +696 -0
- package/lib/seam/connect/routes/seam-http-endpoints.js.map +1 -1
- package/lib/seam/connect/routes/spaces/spaces.d.ts +165 -0
- package/lib/seam/connect/routes/spaces/spaces.js +36 -0
- package/lib/seam/connect/routes/spaces/spaces.js.map +1 -1
- package/lib/seam/connect/routes/thermostats/daily-programs/daily-programs.d.ts +42 -0
- package/lib/seam/connect/routes/thermostats/daily-programs/daily-programs.js +9 -0
- package/lib/seam/connect/routes/thermostats/daily-programs/daily-programs.js.map +1 -1
- package/lib/seam/connect/routes/thermostats/schedules/schedules.d.ts +69 -0
- package/lib/seam/connect/routes/thermostats/schedules/schedules.js +15 -0
- package/lib/seam/connect/routes/thermostats/schedules/schedules.js.map +1 -1
- package/lib/seam/connect/routes/thermostats/simulate/simulate.d.ts +33 -0
- package/lib/seam/connect/routes/thermostats/simulate/simulate.js +6 -0
- package/lib/seam/connect/routes/thermostats/simulate/simulate.js.map +1 -1
- package/lib/seam/connect/routes/thermostats/thermostats.d.ts +300 -0
- package/lib/seam/connect/routes/thermostats/thermostats.js +42 -0
- package/lib/seam/connect/routes/thermostats/thermostats.js.map +1 -1
- package/lib/seam/connect/routes/user-identities/unmanaged/unmanaged.d.ts +35 -0
- package/lib/seam/connect/routes/user-identities/unmanaged/unmanaged.js +11 -0
- package/lib/seam/connect/routes/user-identities/unmanaged/unmanaged.js.map +1 -1
- package/lib/seam/connect/routes/user-identities/user-identities.d.ts +145 -0
- package/lib/seam/connect/routes/user-identities/user-identities.js +46 -0
- package/lib/seam/connect/routes/user-identities/user-identities.js.map +1 -1
- package/lib/seam/connect/routes/webhooks/webhooks.d.ts +33 -0
- package/lib/seam/connect/routes/webhooks/webhooks.js +15 -0
- package/lib/seam/connect/routes/webhooks/webhooks.js.map +1 -1
- package/lib/seam/connect/routes/workspaces/workspaces.d.ts +88 -0
- package/lib/seam/connect/routes/workspaces/workspaces.js +15 -0
- package/lib/seam/connect/routes/workspaces/workspaces.js.map +1 -1
- package/lib/version.d.ts +1 -1
- package/lib/version.js +1 -1
- package/package.json +1 -1
- package/src/lib/seam/connect/resources/access-code.ts +719 -35
- package/src/lib/seam/connect/resources/access-grant.ts +284 -16
- package/src/lib/seam/connect/resources/access-method.ts +205 -10
- package/src/lib/seam/connect/resources/acs-access-group.ts +247 -14
- package/src/lib/seam/connect/resources/acs-credential.ts +210 -5
- package/src/lib/seam/connect/resources/acs-encoder.ts +46 -0
- package/src/lib/seam/connect/resources/acs-entrance.ts +296 -4
- package/src/lib/seam/connect/resources/acs-system.ts +223 -9
- package/src/lib/seam/connect/resources/acs-user.ts +382 -16
- package/src/lib/seam/connect/resources/action-attempt.ts +956 -0
- package/src/lib/seam/connect/resources/batch.ts +3 -0
- package/src/lib/seam/connect/resources/client-session.ts +48 -0
- package/src/lib/seam/connect/resources/connect-webview.ts +70 -0
- package/src/lib/seam/connect/resources/connected-account.ts +277 -10
- package/src/lib/seam/connect/resources/customer-portal.ts +22 -0
- package/src/lib/seam/connect/resources/device-provider.ts +72 -0
- package/src/lib/seam/connect/resources/device.ts +2059 -39
- package/src/lib/seam/connect/resources/event.ts +4015 -0
- package/src/lib/seam/connect/resources/instant-key.ts +41 -0
- package/src/lib/seam/connect/resources/noise-threshold.ts +24 -0
- package/src/lib/seam/connect/resources/phone.ts +72 -0
- package/src/lib/seam/connect/resources/space.ts +54 -0
- package/src/lib/seam/connect/resources/thermostat-daily-program.ts +27 -0
- package/src/lib/seam/connect/resources/thermostat-schedule.ts +45 -0
- package/src/lib/seam/connect/resources/unmanaged-access-code.ts +580 -30
- package/src/lib/seam/connect/resources/unmanaged-access-grant.ts +272 -16
- package/src/lib/seam/connect/resources/unmanaged-access-method.ts +196 -10
- package/src/lib/seam/connect/resources/unmanaged-device.ts +727 -39
- package/src/lib/seam/connect/resources/unmanaged-user-identity.ts +84 -8
- package/src/lib/seam/connect/resources/user-identity.ts +87 -8
- package/src/lib/seam/connect/resources/webhook.ts +15 -0
- package/src/lib/seam/connect/resources/workspace.ts +46 -0
- package/src/lib/seam/connect/routes/access-codes/access-codes.ts +291 -0
- package/src/lib/seam/connect/routes/access-codes/simulate/simulate.ts +12 -0
- package/src/lib/seam/connect/routes/access-codes/unmanaged/unmanaged.ts +73 -0
- package/src/lib/seam/connect/routes/access-grants/access-grants.ts +180 -0
- package/src/lib/seam/connect/routes/access-grants/unmanaged/unmanaged.ts +43 -0
- package/src/lib/seam/connect/routes/access-methods/access-methods.ts +79 -0
- package/src/lib/seam/connect/routes/access-methods/unmanaged/unmanaged.ts +21 -0
- package/src/lib/seam/connect/routes/acs/access-groups/access-groups.ts +63 -0
- package/src/lib/seam/connect/routes/acs/credentials/credentials.ts +133 -0
- package/src/lib/seam/connect/routes/acs/encoders/encoders.ts +66 -0
- package/src/lib/seam/connect/routes/acs/encoders/simulate/simulate.ts +40 -0
- package/src/lib/seam/connect/routes/acs/entrances/entrances.ts +72 -0
- package/src/lib/seam/connect/routes/acs/systems/systems.ts +64 -0
- package/src/lib/seam/connect/routes/acs/users/users.ts +189 -0
- package/src/lib/seam/connect/routes/action-attempts/action-attempts.ts +21 -0
- package/src/lib/seam/connect/routes/client-sessions/client-sessions.ts +113 -0
- package/src/lib/seam/connect/routes/connect-webviews/connect-webviews.ts +76 -0
- package/src/lib/seam/connect/routes/connected-accounts/connected-accounts.ts +70 -0
- package/src/lib/seam/connect/routes/connected-accounts/simulate/simulate.ts +6 -0
- package/src/lib/seam/connect/routes/customers/customers.ts +1058 -0
- package/src/lib/seam/connect/routes/devices/devices.ts +123 -0
- package/src/lib/seam/connect/routes/devices/simulate/simulate.ts +42 -0
- package/src/lib/seam/connect/routes/devices/unmanaged/unmanaged.ts +80 -0
- package/src/lib/seam/connect/routes/events/events.ts +99 -0
- package/src/lib/seam/connect/routes/instant-keys/instant-keys.ts +21 -0
- package/src/lib/seam/connect/routes/locks/locks.ts +85 -0
- package/src/lib/seam/connect/routes/locks/simulate/simulate.ts +15 -0
- package/src/lib/seam/connect/routes/noise-sensors/noise-sensors.ts +51 -0
- package/src/lib/seam/connect/routes/noise-sensors/noise-thresholds/noise-thresholds.ts +66 -0
- package/src/lib/seam/connect/routes/noise-sensors/simulate/simulate.ts +6 -0
- package/src/lib/seam/connect/routes/phones/phones.ts +21 -0
- package/src/lib/seam/connect/routes/phones/simulate/simulate.ts +45 -0
- package/src/lib/seam/connect/routes/seam-http-endpoints-without-workspace.ts +6 -0
- package/src/lib/seam/connect/routes/seam-http-endpoints.ts +696 -0
- package/src/lib/seam/connect/routes/spaces/spaces.ts +166 -0
- package/src/lib/seam/connect/routes/thermostats/daily-programs/daily-programs.ts +42 -0
- package/src/lib/seam/connect/routes/thermostats/schedules/schedules.ts +69 -0
- package/src/lib/seam/connect/routes/thermostats/simulate/simulate.ts +33 -0
- package/src/lib/seam/connect/routes/thermostats/thermostats.ts +300 -0
- package/src/lib/seam/connect/routes/user-identities/unmanaged/unmanaged.ts +35 -0
- package/src/lib/seam/connect/routes/user-identities/user-identities.ts +146 -0
- package/src/lib/seam/connect/routes/webhooks/webhooks.ts +33 -0
- package/src/lib/seam/connect/routes/workspaces/workspaces.ts +88 -0
- package/src/lib/version.ts +1 -1
|
@@ -3,318 +3,868 @@
|
|
|
3
3
|
* Do not edit this file.
|
|
4
4
|
*/
|
|
5
5
|
|
|
6
|
+
/**
|
|
7
|
+
* Represents an [unmanaged smart lock access code](https://docs.seam.co/low-level-apis/smart-locks/access-codes/migrating-existing-access-codes).
|
|
8
|
+
*
|
|
9
|
+
* 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.
|
|
10
|
+
*
|
|
11
|
+
* 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.
|
|
12
|
+
*
|
|
13
|
+
* 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.
|
|
14
|
+
*
|
|
15
|
+
* Not all providers support unmanaged access codes. The following providers do not support unmanaged access codes:
|
|
16
|
+
*
|
|
17
|
+
* - [Kwikset](https://docs.seam.co/device-and-system-integration-guides/kwikset-locks)
|
|
18
|
+
*/
|
|
6
19
|
export type UnmanagedAccessCode = {
|
|
20
|
+
/**
|
|
21
|
+
* Unique identifier for the access code.
|
|
22
|
+
*/
|
|
7
23
|
access_code_id: string
|
|
8
24
|
|
|
25
|
+
/**
|
|
26
|
+
* Indicates that Seam cannot convert this unmanaged access code to a managed access code. Some providers do not support management of unmanaged access codes through API integrations.
|
|
27
|
+
*/
|
|
9
28
|
cannot_be_managed?: boolean | undefined
|
|
29
|
+
/**
|
|
30
|
+
* Indicates that Seam cannot delete this unmanaged access code through the provider. If this access code needs to be deleted, it will only be possible from the manufacturer app.
|
|
31
|
+
*/
|
|
10
32
|
cannot_delete_unmanaged_access_code?: boolean | undefined
|
|
33
|
+
/**
|
|
34
|
+
* Code used for access. Typically, a numeric or alphanumeric string.
|
|
35
|
+
*/
|
|
11
36
|
code: string | null
|
|
37
|
+
/**
|
|
38
|
+
* Date and time at which the access code was created.
|
|
39
|
+
*/
|
|
12
40
|
created_at: string
|
|
13
41
|
|
|
42
|
+
/**
|
|
43
|
+
* Unique identifier for the device associated with the access code.
|
|
44
|
+
*/
|
|
14
45
|
device_id: string
|
|
15
46
|
|
|
47
|
+
/**
|
|
48
|
+
* Metadata for a dormakaba Oracode unmanaged access code. Only present for unmanaged access codes from dormakaba Oracode devices.
|
|
49
|
+
*/
|
|
16
50
|
dormakaba_oracode_metadata?:
|
|
17
51
|
| {
|
|
52
|
+
/**
|
|
53
|
+
* Indicates whether the stay can be cancelled via the Dormakaba Oracode API.
|
|
54
|
+
*/
|
|
18
55
|
is_cancellable?: boolean | undefined
|
|
56
|
+
/**
|
|
57
|
+
* Indicates whether early check-in is available for this stay.
|
|
58
|
+
*/
|
|
19
59
|
is_early_checkin_able?: boolean | undefined
|
|
60
|
+
/**
|
|
61
|
+
* Indicates whether the stay can be extended via the Dormakaba Oracode API.
|
|
62
|
+
*/
|
|
20
63
|
is_extendable?: boolean | undefined
|
|
64
|
+
/**
|
|
65
|
+
* Indicates whether the access code can be overridden. When false, the maximum number of overrides has been reached.
|
|
66
|
+
*/
|
|
21
67
|
is_overridable?: boolean | undefined
|
|
68
|
+
/**
|
|
69
|
+
* Dormakaba Oracode site name associated with this access code.
|
|
70
|
+
*/
|
|
22
71
|
site_name?: string | undefined
|
|
72
|
+
/**
|
|
73
|
+
* Dormakaba Oracode stay ID associated with this access code.
|
|
74
|
+
*/
|
|
23
75
|
stay_id?: number | undefined
|
|
76
|
+
/**
|
|
77
|
+
* Dormakaba Oracode user level ID associated with this access code.
|
|
78
|
+
*/
|
|
24
79
|
user_level_id?: string | undefined
|
|
80
|
+
/**
|
|
81
|
+
* Dormakaba Oracode user level name associated with this access code.
|
|
82
|
+
*/
|
|
25
83
|
user_level_name?: string | null | undefined
|
|
26
84
|
}
|
|
27
85
|
| null
|
|
28
86
|
| undefined
|
|
87
|
+
/**
|
|
88
|
+
* Date and time after which the time-bound access code becomes inactive.
|
|
89
|
+
*/
|
|
29
90
|
ends_at?: string | null | undefined
|
|
91
|
+
/**
|
|
92
|
+
* Errors associated with the [access code](https://docs.seam.co/low-level-apis/smart-locks/access-codes).
|
|
93
|
+
*/
|
|
30
94
|
errors: Array<
|
|
95
|
+
/**
|
|
96
|
+
* Indicates a provider-specific issue that prevents the access code from being set or managed. Check the error message for details.
|
|
97
|
+
*/
|
|
31
98
|
| {
|
|
99
|
+
/**
|
|
100
|
+
* Date and time at which Seam created the error.
|
|
101
|
+
*/
|
|
32
102
|
created_at?: string | undefined
|
|
103
|
+
/**
|
|
104
|
+
* Unique identifier of the type of error. Enables quick recognition and categorization of the issue.
|
|
105
|
+
*/
|
|
33
106
|
error_code: 'provider_issue'
|
|
34
107
|
|
|
108
|
+
/**
|
|
109
|
+
* Indicates that this is an access code error.
|
|
110
|
+
*/
|
|
35
111
|
is_access_code_error: boolean
|
|
36
112
|
|
|
113
|
+
/**
|
|
114
|
+
* Detailed description of the error. Provides insights into the issue and potentially how to rectify it.
|
|
115
|
+
*/
|
|
37
116
|
message: string
|
|
38
|
-
}
|
|
117
|
+
} /**
|
|
118
|
+
* Failed to set code on device.
|
|
119
|
+
*/
|
|
39
120
|
| {
|
|
121
|
+
/**
|
|
122
|
+
* Date and time at which Seam created the error.
|
|
123
|
+
*/
|
|
40
124
|
created_at?: string | undefined
|
|
125
|
+
/**
|
|
126
|
+
* Unique identifier of the type of error. Enables quick recognition and categorization of the issue.
|
|
127
|
+
*/
|
|
41
128
|
error_code: 'failed_to_set_on_device'
|
|
42
129
|
|
|
130
|
+
/**
|
|
131
|
+
* Indicates that this is an access code error.
|
|
132
|
+
*/
|
|
43
133
|
is_access_code_error: boolean
|
|
44
134
|
|
|
135
|
+
/**
|
|
136
|
+
* Detailed description of the error. Provides insights into the issue and potentially how to rectify it.
|
|
137
|
+
*/
|
|
45
138
|
message: string
|
|
46
|
-
}
|
|
139
|
+
} /**
|
|
140
|
+
* Failed to remove code from device.
|
|
141
|
+
*/
|
|
47
142
|
| {
|
|
143
|
+
/**
|
|
144
|
+
* Date and time at which Seam created the error.
|
|
145
|
+
*/
|
|
48
146
|
created_at?: string | undefined
|
|
147
|
+
/**
|
|
148
|
+
* Unique identifier of the type of error. Enables quick recognition and categorization of the issue.
|
|
149
|
+
*/
|
|
49
150
|
error_code: 'failed_to_remove_from_device'
|
|
50
151
|
|
|
152
|
+
/**
|
|
153
|
+
* Indicates that this is an access code error.
|
|
154
|
+
*/
|
|
51
155
|
is_access_code_error: boolean
|
|
52
156
|
|
|
157
|
+
/**
|
|
158
|
+
* Detailed description of the error. Provides insights into the issue and potentially how to rectify it.
|
|
159
|
+
*/
|
|
53
160
|
message: string
|
|
54
|
-
}
|
|
161
|
+
} /**
|
|
162
|
+
* Duplicate access code detected on device.
|
|
163
|
+
*/
|
|
55
164
|
| {
|
|
165
|
+
/**
|
|
166
|
+
* Date and time at which Seam created the error.
|
|
167
|
+
*/
|
|
56
168
|
created_at?: string | undefined
|
|
169
|
+
/**
|
|
170
|
+
* Unique identifier of the type of error. Enables quick recognition and categorization of the issue.
|
|
171
|
+
*/
|
|
57
172
|
error_code: 'duplicate_code_on_device'
|
|
58
173
|
|
|
174
|
+
/**
|
|
175
|
+
* Indicates that this is an access code error.
|
|
176
|
+
*/
|
|
59
177
|
is_access_code_error: boolean
|
|
60
178
|
|
|
179
|
+
/**
|
|
180
|
+
* ID of the managed access code that conflicts with this managed access code, when Seam can identify it.
|
|
181
|
+
*/
|
|
61
182
|
managed_access_code_id?: string | undefined
|
|
183
|
+
/**
|
|
184
|
+
* Detailed description of the error. Provides insights into the issue and potentially how to rectify it.
|
|
185
|
+
*/
|
|
62
186
|
message: string
|
|
63
187
|
|
|
188
|
+
/**
|
|
189
|
+
* ID of the unmanaged access code that conflicts with this managed access code, when Seam can identify it.
|
|
190
|
+
*/
|
|
64
191
|
unmanaged_access_code_id?: string | undefined
|
|
65
|
-
}
|
|
192
|
+
} /**
|
|
193
|
+
* No space for access code on device.
|
|
194
|
+
*/
|
|
66
195
|
| {
|
|
196
|
+
/**
|
|
197
|
+
* Date and time at which Seam created the error.
|
|
198
|
+
*/
|
|
67
199
|
created_at?: string | undefined
|
|
200
|
+
/**
|
|
201
|
+
* Unique identifier of the type of error. Enables quick recognition and categorization of the issue.
|
|
202
|
+
*/
|
|
68
203
|
error_code: 'no_space_for_access_code_on_device'
|
|
69
204
|
|
|
205
|
+
/**
|
|
206
|
+
* Indicates that this is an access code error.
|
|
207
|
+
*/
|
|
70
208
|
is_access_code_error: boolean
|
|
71
209
|
|
|
210
|
+
/**
|
|
211
|
+
* Detailed description of the error. Provides insights into the issue and potentially how to rectify it.
|
|
212
|
+
*/
|
|
72
213
|
message: string
|
|
73
|
-
}
|
|
214
|
+
} /**
|
|
215
|
+
* Code was modified or removed externally after Seam successfully set it on the device. The external change conflicts with the state that Seam is trying to apply, so Seam will attempt to set the code on the device again.
|
|
216
|
+
*/
|
|
74
217
|
| {
|
|
218
|
+
/**
|
|
219
|
+
* Indicates the type of external modification. `modified` means the code's PIN or schedule was changed. `removed` means the code was deleted from the device.
|
|
220
|
+
*/
|
|
75
221
|
change_type?: 'modified' | 'removed' | undefined
|
|
222
|
+
/**
|
|
223
|
+
* Date and time at which Seam created the error.
|
|
224
|
+
*/
|
|
76
225
|
created_at?: string | undefined
|
|
226
|
+
/**
|
|
227
|
+
* Unique identifier of the type of error. Enables quick recognition and categorization of the issue.
|
|
228
|
+
*/
|
|
77
229
|
error_code: 'conflicting_external_modification'
|
|
78
230
|
|
|
231
|
+
/**
|
|
232
|
+
* Indicates that this is an access code error.
|
|
233
|
+
*/
|
|
79
234
|
is_access_code_error: boolean
|
|
80
235
|
|
|
236
|
+
/**
|
|
237
|
+
* Detailed description of the error. Provides insights into the issue and potentially how to rectify it.
|
|
238
|
+
*/
|
|
81
239
|
message: string
|
|
82
240
|
|
|
241
|
+
/**
|
|
242
|
+
* List of fields that were changed externally, with their previous and new values.
|
|
243
|
+
*/
|
|
83
244
|
modified_fields?:
|
|
84
245
|
| Array<{
|
|
246
|
+
/**
|
|
247
|
+
* The name of the field that was changed (e.g. `code`, `starts_at`, `ends_at`).
|
|
248
|
+
*/
|
|
85
249
|
field: string
|
|
86
250
|
|
|
251
|
+
/**
|
|
252
|
+
* The previous value of the field.
|
|
253
|
+
*/
|
|
87
254
|
from: string | null
|
|
255
|
+
/**
|
|
256
|
+
* The new value of the field.
|
|
257
|
+
*/
|
|
88
258
|
to: string | null
|
|
89
259
|
}>
|
|
90
260
|
| undefined
|
|
91
|
-
}
|
|
261
|
+
} /**
|
|
262
|
+
* Indicates that the access code is disabled or inactive on the device. The code exists but will not grant access until re-enabled.
|
|
263
|
+
*/
|
|
92
264
|
| {
|
|
265
|
+
/**
|
|
266
|
+
* Date and time at which Seam created the error.
|
|
267
|
+
*/
|
|
93
268
|
created_at?: string | undefined
|
|
269
|
+
/**
|
|
270
|
+
* Unique identifier of the type of error. Enables quick recognition and categorization of the issue.
|
|
271
|
+
*/
|
|
94
272
|
error_code: 'access_code_inactive'
|
|
95
273
|
|
|
274
|
+
/**
|
|
275
|
+
* Indicates that this is an access code error.
|
|
276
|
+
*/
|
|
96
277
|
is_access_code_error: boolean
|
|
97
278
|
|
|
279
|
+
/**
|
|
280
|
+
* Detailed description of the error. Provides insights into the issue and potentially how to rectify it.
|
|
281
|
+
*/
|
|
98
282
|
message: string
|
|
99
|
-
}
|
|
283
|
+
} /**
|
|
284
|
+
* Admin role required—insufficient permissions to manage PINs on this device. Please have an admin update your role, or ask them to set the PIN.
|
|
285
|
+
*/
|
|
100
286
|
| {
|
|
287
|
+
/**
|
|
288
|
+
* Date and time at which Seam created the error.
|
|
289
|
+
*/
|
|
101
290
|
created_at?: string | undefined
|
|
291
|
+
/**
|
|
292
|
+
* Unique identifier of the type of error. Enables quick recognition and categorization of the issue.
|
|
293
|
+
*/
|
|
102
294
|
error_code: 'insufficient_permissions'
|
|
103
295
|
|
|
296
|
+
/**
|
|
297
|
+
* Indicates that this is an access code error.
|
|
298
|
+
*/
|
|
104
299
|
is_access_code_error: boolean
|
|
105
300
|
|
|
301
|
+
/**
|
|
302
|
+
* Detailed description of the error. Provides insights into the issue and potentially how to rectify it.
|
|
303
|
+
*/
|
|
106
304
|
message: string
|
|
107
|
-
}
|
|
305
|
+
} /**
|
|
306
|
+
* Indicates that the account is disconnected.
|
|
307
|
+
*/
|
|
108
308
|
| {
|
|
309
|
+
/**
|
|
310
|
+
* Date and time at which Seam created the error.
|
|
311
|
+
*/
|
|
109
312
|
created_at: string
|
|
110
313
|
|
|
314
|
+
/**
|
|
315
|
+
* Unique identifier of the type of error. Enables quick recognition and categorization of the issue.
|
|
316
|
+
*/
|
|
111
317
|
error_code: 'account_disconnected'
|
|
112
318
|
|
|
319
|
+
/**
|
|
320
|
+
* Indicates that the error is a [connected account](https://docs.seam.co/api/connected_accounts) error.
|
|
321
|
+
*/
|
|
113
322
|
is_connected_account_error: boolean
|
|
114
323
|
|
|
324
|
+
/**
|
|
325
|
+
* Indicates that the error is not a device error.
|
|
326
|
+
*/
|
|
115
327
|
is_device_error: boolean
|
|
116
328
|
|
|
329
|
+
/**
|
|
330
|
+
* Detailed description of the error. Provides insights into the issue and potentially how to rectify it.
|
|
331
|
+
*/
|
|
117
332
|
message: string
|
|
118
|
-
}
|
|
333
|
+
} /**
|
|
334
|
+
* Indicates that the Salto site user limit has been reached.
|
|
335
|
+
*/
|
|
119
336
|
| {
|
|
337
|
+
/**
|
|
338
|
+
* Date and time at which Seam created the error.
|
|
339
|
+
*/
|
|
120
340
|
created_at: string
|
|
121
341
|
|
|
342
|
+
/**
|
|
343
|
+
* Unique identifier of the type of error. Enables quick recognition and categorization of the issue.
|
|
344
|
+
*/
|
|
122
345
|
error_code: 'salto_ks_subscription_limit_exceeded'
|
|
123
346
|
|
|
347
|
+
/**
|
|
348
|
+
* Indicates that the error is a [connected account](https://docs.seam.co/api/connected_accounts) error.
|
|
349
|
+
*/
|
|
124
350
|
is_connected_account_error: boolean
|
|
125
351
|
|
|
352
|
+
/**
|
|
353
|
+
* Indicates that the error is not a device error.
|
|
354
|
+
*/
|
|
126
355
|
is_device_error: boolean
|
|
127
356
|
|
|
357
|
+
/**
|
|
358
|
+
* Detailed description of the error. Provides insights into the issue and potentially how to rectify it.
|
|
359
|
+
*/
|
|
128
360
|
message: string
|
|
129
|
-
}
|
|
361
|
+
} /**
|
|
362
|
+
* Indicates that one or more dormakaba sites associated with the connected account could not be connected. Contact dormakaba support.
|
|
363
|
+
*/
|
|
130
364
|
| {
|
|
365
|
+
/**
|
|
366
|
+
* Date and time at which Seam created the error.
|
|
367
|
+
*/
|
|
131
368
|
created_at: string
|
|
132
369
|
|
|
370
|
+
/**
|
|
371
|
+
* Unique identifier of the type of error. Enables quick recognition and categorization of the issue.
|
|
372
|
+
*/
|
|
133
373
|
error_code: 'dormakaba_sites_disconnected'
|
|
134
374
|
|
|
375
|
+
/**
|
|
376
|
+
* Indicates that the error is a [connected account](https://docs.seam.co/api/connected_accounts) error.
|
|
377
|
+
*/
|
|
135
378
|
is_connected_account_error: boolean
|
|
136
379
|
|
|
380
|
+
/**
|
|
381
|
+
* Indicates that the error is not a device error.
|
|
382
|
+
*/
|
|
137
383
|
is_device_error: boolean
|
|
138
384
|
|
|
385
|
+
/**
|
|
386
|
+
* Detailed description of the error. Provides insights into the issue and potentially how to rectify it.
|
|
387
|
+
*/
|
|
139
388
|
message: string
|
|
140
|
-
}
|
|
389
|
+
} /**
|
|
390
|
+
* Indicates that the device is offline.
|
|
391
|
+
*/
|
|
141
392
|
| {
|
|
393
|
+
/**
|
|
394
|
+
* Date and time at which Seam created the error.
|
|
395
|
+
*/
|
|
142
396
|
created_at: string
|
|
143
397
|
|
|
398
|
+
/**
|
|
399
|
+
* Unique identifier of the type of error. Enables quick recognition and categorization of the issue.
|
|
400
|
+
*/
|
|
144
401
|
error_code: 'device_offline'
|
|
145
402
|
|
|
403
|
+
/**
|
|
404
|
+
* Indicates that the error is a device error.
|
|
405
|
+
*/
|
|
146
406
|
is_device_error: boolean
|
|
147
407
|
|
|
408
|
+
/**
|
|
409
|
+
* Detailed description of the error. Provides insights into the issue and potentially how to rectify it.
|
|
410
|
+
*/
|
|
148
411
|
message: string
|
|
149
|
-
}
|
|
412
|
+
} /**
|
|
413
|
+
* Indicates that the device has been removed.
|
|
414
|
+
*/
|
|
150
415
|
| {
|
|
416
|
+
/**
|
|
417
|
+
* Date and time at which Seam created the error.
|
|
418
|
+
*/
|
|
151
419
|
created_at: string
|
|
152
420
|
|
|
421
|
+
/**
|
|
422
|
+
* Unique identifier of the type of error. Enables quick recognition and categorization of the issue.
|
|
423
|
+
*/
|
|
153
424
|
error_code: 'device_removed'
|
|
154
425
|
|
|
426
|
+
/**
|
|
427
|
+
* Indicates that the error is a device error.
|
|
428
|
+
*/
|
|
155
429
|
is_device_error: boolean
|
|
156
430
|
|
|
431
|
+
/**
|
|
432
|
+
* Detailed description of the error. Provides insights into the issue and potentially how to rectify it.
|
|
433
|
+
*/
|
|
157
434
|
message: string
|
|
158
|
-
}
|
|
435
|
+
} /**
|
|
436
|
+
* Indicates that the hub is disconnected.
|
|
437
|
+
*/
|
|
159
438
|
| {
|
|
439
|
+
/**
|
|
440
|
+
* Date and time at which Seam created the error.
|
|
441
|
+
*/
|
|
160
442
|
created_at: string
|
|
161
443
|
|
|
444
|
+
/**
|
|
445
|
+
* Unique identifier of the type of error. Enables quick recognition and categorization of the issue.
|
|
446
|
+
*/
|
|
162
447
|
error_code: 'hub_disconnected'
|
|
163
448
|
|
|
449
|
+
/**
|
|
450
|
+
* Indicates that the error is a device error.
|
|
451
|
+
*/
|
|
164
452
|
is_device_error: boolean
|
|
165
453
|
|
|
454
|
+
/**
|
|
455
|
+
* Detailed description of the error. Provides insights into the issue and potentially how to rectify it.
|
|
456
|
+
*/
|
|
166
457
|
message: string
|
|
167
|
-
}
|
|
458
|
+
} /**
|
|
459
|
+
* Indicates that the device is disconnected.
|
|
460
|
+
*/
|
|
168
461
|
| {
|
|
462
|
+
/**
|
|
463
|
+
* Date and time at which Seam created the error.
|
|
464
|
+
*/
|
|
169
465
|
created_at: string
|
|
170
466
|
|
|
467
|
+
/**
|
|
468
|
+
* Unique identifier of the type of error. Enables quick recognition and categorization of the issue.
|
|
469
|
+
*/
|
|
171
470
|
error_code: 'device_disconnected'
|
|
172
471
|
|
|
472
|
+
/**
|
|
473
|
+
* Indicates that the error is a device error.
|
|
474
|
+
*/
|
|
173
475
|
is_device_error: boolean
|
|
174
476
|
|
|
477
|
+
/**
|
|
478
|
+
* Detailed description of the error. Provides insights into the issue and potentially how to rectify it.
|
|
479
|
+
*/
|
|
175
480
|
message: string
|
|
176
|
-
}
|
|
481
|
+
} /**
|
|
482
|
+
* Indicates that the [backup access code pool](https://docs.seam.co/low-level-apis/smart-locks/access-codes/backup-access-codes) is empty.
|
|
483
|
+
*/
|
|
177
484
|
| {
|
|
485
|
+
/**
|
|
486
|
+
* Date and time at which Seam created the error.
|
|
487
|
+
*/
|
|
178
488
|
created_at: string
|
|
179
489
|
|
|
490
|
+
/**
|
|
491
|
+
* Unique identifier of the type of error. Enables quick recognition and categorization of the issue.
|
|
492
|
+
*/
|
|
180
493
|
error_code: 'empty_backup_access_code_pool'
|
|
181
494
|
|
|
495
|
+
/**
|
|
496
|
+
* Indicates that the error is a device error.
|
|
497
|
+
*/
|
|
182
498
|
is_device_error: boolean
|
|
183
499
|
|
|
500
|
+
/**
|
|
501
|
+
* Detailed description of the error. Provides insights into the issue and potentially how to rectify it.
|
|
502
|
+
*/
|
|
184
503
|
message: string
|
|
185
|
-
}
|
|
504
|
+
} /**
|
|
505
|
+
* Indicates that the user is not authorized to use the August lock.
|
|
506
|
+
*/
|
|
186
507
|
| {
|
|
508
|
+
/**
|
|
509
|
+
* Date and time at which Seam created the error.
|
|
510
|
+
*/
|
|
187
511
|
created_at: string
|
|
188
512
|
|
|
513
|
+
/**
|
|
514
|
+
* Unique identifier of the type of error. Enables quick recognition and categorization of the issue.
|
|
515
|
+
*/
|
|
189
516
|
error_code: 'august_lock_not_authorized'
|
|
190
517
|
|
|
518
|
+
/**
|
|
519
|
+
* Indicates that the error is a device error.
|
|
520
|
+
*/
|
|
191
521
|
is_device_error: boolean
|
|
192
522
|
|
|
523
|
+
/**
|
|
524
|
+
* Detailed description of the error. Provides insights into the issue and potentially how to rectify it.
|
|
525
|
+
*/
|
|
193
526
|
message: string
|
|
194
|
-
}
|
|
527
|
+
} /**
|
|
528
|
+
* Indicates that device credentials are missing.
|
|
529
|
+
*/
|
|
195
530
|
| {
|
|
531
|
+
/**
|
|
532
|
+
* Date and time at which Seam created the error.
|
|
533
|
+
*/
|
|
196
534
|
created_at: string
|
|
197
535
|
|
|
536
|
+
/**
|
|
537
|
+
* Unique identifier of the type of error. Enables quick recognition and categorization of the issue.
|
|
538
|
+
*/
|
|
198
539
|
error_code: 'missing_device_credentials'
|
|
199
540
|
|
|
541
|
+
/**
|
|
542
|
+
* Indicates that the error is a device error.
|
|
543
|
+
*/
|
|
200
544
|
is_device_error: boolean
|
|
201
545
|
|
|
546
|
+
/**
|
|
547
|
+
* Detailed description of the error. Provides insights into the issue and potentially how to rectify it.
|
|
548
|
+
*/
|
|
202
549
|
message: string
|
|
203
|
-
}
|
|
550
|
+
} /**
|
|
551
|
+
* Indicates that the auxiliary heat is running.
|
|
552
|
+
*/
|
|
204
553
|
| {
|
|
554
|
+
/**
|
|
555
|
+
* Date and time at which Seam created the error.
|
|
556
|
+
*/
|
|
205
557
|
created_at: string
|
|
206
558
|
|
|
559
|
+
/**
|
|
560
|
+
* Unique identifier of the type of error. Enables quick recognition and categorization of the issue.
|
|
561
|
+
*/
|
|
207
562
|
error_code: 'auxiliary_heat_running'
|
|
208
563
|
|
|
564
|
+
/**
|
|
565
|
+
* Indicates that the error is a device error.
|
|
566
|
+
*/
|
|
209
567
|
is_device_error: boolean
|
|
210
568
|
|
|
569
|
+
/**
|
|
570
|
+
* Detailed description of the error. Provides insights into the issue and potentially how to rectify it.
|
|
571
|
+
*/
|
|
211
572
|
message: string
|
|
212
|
-
}
|
|
573
|
+
} /**
|
|
574
|
+
* Indicates that a subscription is required to connect.
|
|
575
|
+
*/
|
|
213
576
|
| {
|
|
577
|
+
/**
|
|
578
|
+
* Date and time at which Seam created the error.
|
|
579
|
+
*/
|
|
214
580
|
created_at: string
|
|
215
581
|
|
|
582
|
+
/**
|
|
583
|
+
* Unique identifier of the type of error. Enables quick recognition and categorization of the issue.
|
|
584
|
+
*/
|
|
216
585
|
error_code: 'subscription_required'
|
|
217
586
|
|
|
587
|
+
/**
|
|
588
|
+
* Indicates that the error is a device error.
|
|
589
|
+
*/
|
|
218
590
|
is_device_error: boolean
|
|
219
591
|
|
|
592
|
+
/**
|
|
593
|
+
* Detailed description of the error. Provides insights into the issue and potentially how to rectify it.
|
|
594
|
+
*/
|
|
220
595
|
message: string
|
|
221
|
-
}
|
|
596
|
+
} /**
|
|
597
|
+
* Indicates that the Seam API cannot communicate with [Seam Bridge](https://docs.seam.co/capability-guides/seam-bridge), for example, if the Seam Bridge executable has stopped or if the computer running the Seam Bridge executable is offline. See also [Troubleshooting Your Access Control System](https://docs.seam.co/low-level-apis/access-systems/troubleshooting-your-access-control-system#acs_system-errors-seam_bridge_disconnected).
|
|
598
|
+
*/
|
|
222
599
|
| {
|
|
600
|
+
/**
|
|
601
|
+
* Date and time at which Seam created the error.
|
|
602
|
+
*/
|
|
223
603
|
created_at: string
|
|
224
604
|
|
|
605
|
+
/**
|
|
606
|
+
* Unique identifier of the type of error. Enables quick recognition and categorization of the issue.
|
|
607
|
+
*/
|
|
225
608
|
error_code: 'bridge_disconnected'
|
|
226
609
|
|
|
610
|
+
/**
|
|
611
|
+
* Indicates whether the error is related to [Seam Bridge](https://docs.seam.co/capability-guides/seam-bridge).
|
|
612
|
+
*/
|
|
227
613
|
is_bridge_error?: boolean | undefined
|
|
614
|
+
/**
|
|
615
|
+
* Indicates whether the error is related specifically to the connected account.
|
|
616
|
+
*/
|
|
228
617
|
is_connected_account_error?: boolean | undefined
|
|
618
|
+
/**
|
|
619
|
+
* Detailed description of the error. Provides insights into the issue and potentially how to rectify it.
|
|
620
|
+
*/
|
|
229
621
|
message: string
|
|
230
622
|
}
|
|
231
623
|
>
|
|
232
624
|
|
|
625
|
+
/**
|
|
626
|
+
* Indicates that Seam does not manage the access code.
|
|
627
|
+
*/
|
|
233
628
|
is_managed: boolean
|
|
234
629
|
|
|
630
|
+
/**
|
|
631
|
+
* Name of the access code. Enables administrators and users to identify the access code easily, especially when there are numerous access codes. Note that the name provided on Seam is used to identify the code on Seam and is not necessarily the name that will appear in the lock provider's app or on the device. This is because lock providers may have constraints on names, such as length, uniqueness, or characters that can be used. In addition, some lock providers may break down names into components such as `first_name` and `last_name`. To provide a consistent experience, Seam identifies the code on Seam by its name but may modify the name that appears on the lock provider's app or on the device. For example, Seam may add additional characters or truncate the name to meet provider constraints. To help your users identify codes set by Seam, Seam provides the name exactly as it appears on the lock provider's app or on the device as a separate property called `appearance`. This is an object with a `name` property and, optionally, `first_name` and `last_name` properties (for providers that break down a name into components).
|
|
632
|
+
*/
|
|
235
633
|
name: string | null
|
|
634
|
+
/**
|
|
635
|
+
* Date and time at which the time-bound access code becomes active.
|
|
636
|
+
*/
|
|
236
637
|
starts_at?: string | null | undefined
|
|
638
|
+
/**
|
|
639
|
+
* Current status of the access code within the operational lifecycle. `set` indicates that the code is active and operational. `unset` indicates that the code exists on the provider but is not usable on the device.
|
|
640
|
+
*/
|
|
237
641
|
status: 'set' | 'unset'
|
|
238
642
|
|
|
643
|
+
/**
|
|
644
|
+
* Type of the access code. `ongoing` access codes are active continuously until deactivated manually. `time_bound` access codes have a specific duration.
|
|
645
|
+
*/
|
|
239
646
|
type: 'time_bound' | 'ongoing'
|
|
240
647
|
|
|
648
|
+
/**
|
|
649
|
+
* Warnings associated with the [access code](https://docs.seam.co/low-level-apis/smart-locks/access-codes).
|
|
650
|
+
*/
|
|
241
651
|
warnings: Array<
|
|
652
|
+
/**
|
|
653
|
+
* The access code's PIN rotates periodically when the code is renewed. Retrieve the latest code before each use.
|
|
654
|
+
*/
|
|
242
655
|
| {
|
|
656
|
+
/**
|
|
657
|
+
* Date and time at which Seam created the warning.
|
|
658
|
+
*/
|
|
243
659
|
created_at?: string | undefined
|
|
660
|
+
/**
|
|
661
|
+
* Detailed description of the warning. Provides insights into the issue and potentially how to rectify it.
|
|
662
|
+
*/
|
|
244
663
|
message: string
|
|
245
664
|
|
|
665
|
+
/**
|
|
666
|
+
* Unique identifier of the type of warning. Enables quick recognition and categorization of the issue.
|
|
667
|
+
*/
|
|
246
668
|
warning_code: 'code_rotates_periodically'
|
|
247
|
-
}
|
|
669
|
+
} /**
|
|
670
|
+
* The device's time zone is unknown and this code's time frame crosses a daylight-saving transition in at least one plausible time zone. A 1-hour safety buffer has been applied to the side of the time frame affected by the transition (`ends_at` for spring-forward, `starts_at` for fall-back) so the code stays active through the shift — the code may be usable up to 1 hour beyond your requested window. Set the device's time zone via `/devices/report_provider_metadata` to clear the buffer and guarantee exact handling.
|
|
671
|
+
*/
|
|
248
672
|
| {
|
|
673
|
+
/**
|
|
674
|
+
* Date and time at which Seam created the warning.
|
|
675
|
+
*/
|
|
249
676
|
created_at?: string | undefined
|
|
677
|
+
/**
|
|
678
|
+
* Detailed description of the warning. Provides insights into the issue and potentially how to rectify it.
|
|
679
|
+
*/
|
|
250
680
|
message: string
|
|
251
681
|
|
|
682
|
+
/**
|
|
683
|
+
* Unique identifier of the type of warning. Enables quick recognition and categorization of the issue.
|
|
684
|
+
*/
|
|
252
685
|
warning_code: 'time_frame_adjusted_for_unknown_time_zone'
|
|
253
|
-
}
|
|
686
|
+
} /**
|
|
687
|
+
* Code was modified or removed externally after Seam successfully set it on the device. External modification is allowed for this code, so the externally modified state is being honored.
|
|
688
|
+
*/
|
|
254
689
|
| {
|
|
690
|
+
/**
|
|
691
|
+
* Indicates the type of external modification. `modified` means the code's PIN or schedule was changed. `removed` means the code was deleted from the device.
|
|
692
|
+
*/
|
|
255
693
|
change_type?: 'modified' | 'removed' | undefined
|
|
694
|
+
/**
|
|
695
|
+
* Date and time at which Seam created the warning.
|
|
696
|
+
*/
|
|
256
697
|
created_at?: string | undefined
|
|
698
|
+
/**
|
|
699
|
+
* Detailed description of the warning. Provides insights into the issue and potentially how to rectify it.
|
|
700
|
+
*/
|
|
257
701
|
message: string
|
|
258
702
|
|
|
703
|
+
/**
|
|
704
|
+
* List of fields that were changed externally, with their previous and new values.
|
|
705
|
+
*/
|
|
259
706
|
modified_fields?:
|
|
260
707
|
| Array<{
|
|
708
|
+
/**
|
|
709
|
+
* The name of the field that was changed (e.g. `code`, `starts_at`, `ends_at`).
|
|
710
|
+
*/
|
|
261
711
|
field: string
|
|
262
712
|
|
|
713
|
+
/**
|
|
714
|
+
* The previous value of the field.
|
|
715
|
+
*/
|
|
263
716
|
from: string | null
|
|
717
|
+
/**
|
|
718
|
+
* The new value of the field.
|
|
719
|
+
*/
|
|
264
720
|
to: string | null
|
|
265
721
|
}>
|
|
266
722
|
| undefined
|
|
723
|
+
/**
|
|
724
|
+
* Unique identifier of the type of warning. Enables quick recognition and categorization of the issue.
|
|
725
|
+
*/
|
|
267
726
|
warning_code: 'external_modification_in_effect'
|
|
268
|
-
}
|
|
727
|
+
} /**
|
|
728
|
+
* Delay in setting code on device.
|
|
729
|
+
*/
|
|
269
730
|
| {
|
|
731
|
+
/**
|
|
732
|
+
* Date and time at which Seam created the warning.
|
|
733
|
+
*/
|
|
270
734
|
created_at?: string | undefined
|
|
735
|
+
/**
|
|
736
|
+
* Detailed description of the warning. Provides insights into the issue and potentially how to rectify it.
|
|
737
|
+
*/
|
|
271
738
|
message: string
|
|
272
739
|
|
|
740
|
+
/**
|
|
741
|
+
* Unique identifier of the type of warning. Enables quick recognition and categorization of the issue.
|
|
742
|
+
*/
|
|
273
743
|
warning_code: 'delay_in_setting_on_device'
|
|
274
|
-
}
|
|
744
|
+
} /**
|
|
745
|
+
* Delay in removing code from device.
|
|
746
|
+
*/
|
|
275
747
|
| {
|
|
748
|
+
/**
|
|
749
|
+
* Date and time at which Seam created the warning.
|
|
750
|
+
*/
|
|
276
751
|
created_at?: string | undefined
|
|
752
|
+
/**
|
|
753
|
+
* Detailed description of the warning. Provides insights into the issue and potentially how to rectify it.
|
|
754
|
+
*/
|
|
277
755
|
message: string
|
|
278
756
|
|
|
757
|
+
/**
|
|
758
|
+
* Unique identifier of the type of warning. Enables quick recognition and categorization of the issue.
|
|
759
|
+
*/
|
|
279
760
|
warning_code: 'delay_in_removing_from_device'
|
|
280
|
-
}
|
|
761
|
+
} /**
|
|
762
|
+
* Third-party integration detected that may cause access codes to fail.
|
|
763
|
+
*/
|
|
281
764
|
| {
|
|
765
|
+
/**
|
|
766
|
+
* Date and time at which Seam created the warning.
|
|
767
|
+
*/
|
|
282
768
|
created_at?: string | undefined
|
|
769
|
+
/**
|
|
770
|
+
* Detailed description of the warning. Provides insights into the issue and potentially how to rectify it.
|
|
771
|
+
*/
|
|
283
772
|
message: string
|
|
284
773
|
|
|
774
|
+
/**
|
|
775
|
+
* Unique identifier of the type of warning. Enables quick recognition and categorization of the issue.
|
|
776
|
+
*/
|
|
285
777
|
warning_code: 'third_party_integration_detected'
|
|
286
|
-
}
|
|
778
|
+
} /**
|
|
779
|
+
* Algopins must be used within 24 hours.
|
|
780
|
+
*/
|
|
287
781
|
| {
|
|
782
|
+
/**
|
|
783
|
+
* Date and time at which Seam created the warning.
|
|
784
|
+
*/
|
|
288
785
|
created_at?: string | undefined
|
|
786
|
+
/**
|
|
787
|
+
* Detailed description of the warning. Provides insights into the issue and potentially how to rectify it.
|
|
788
|
+
*/
|
|
289
789
|
message: string
|
|
290
790
|
|
|
791
|
+
/**
|
|
792
|
+
* Unique identifier of the type of warning. Enables quick recognition and categorization of the issue.
|
|
793
|
+
*/
|
|
291
794
|
warning_code: 'igloo_algopin_must_be_used_within_24_hours'
|
|
292
|
-
}
|
|
795
|
+
} /**
|
|
796
|
+
* Management was transferred to another workspace.
|
|
797
|
+
*/
|
|
293
798
|
| {
|
|
799
|
+
/**
|
|
800
|
+
* Date and time at which Seam created the warning.
|
|
801
|
+
*/
|
|
294
802
|
created_at?: string | undefined
|
|
803
|
+
/**
|
|
804
|
+
* Detailed description of the warning. Provides insights into the issue and potentially how to rectify it.
|
|
805
|
+
*/
|
|
295
806
|
message: string
|
|
296
807
|
|
|
808
|
+
/**
|
|
809
|
+
* Unique identifier of the type of warning. Enables quick recognition and categorization of the issue.
|
|
810
|
+
*/
|
|
297
811
|
warning_code: 'management_transferred'
|
|
298
|
-
}
|
|
812
|
+
} /**
|
|
813
|
+
* A backup access code has been pulled and is being used in place of this access code.
|
|
814
|
+
*/
|
|
299
815
|
| {
|
|
816
|
+
/**
|
|
817
|
+
* Date and time at which Seam created the warning.
|
|
818
|
+
*/
|
|
300
819
|
created_at?: string | undefined
|
|
820
|
+
/**
|
|
821
|
+
* Detailed description of the warning. Provides insights into the issue and potentially how to rectify it.
|
|
822
|
+
*/
|
|
301
823
|
message: string
|
|
302
824
|
|
|
825
|
+
/**
|
|
826
|
+
* Unique identifier of the type of warning. Enables quick recognition and categorization of the issue.
|
|
827
|
+
*/
|
|
303
828
|
warning_code: 'using_backup_access_code'
|
|
304
|
-
}
|
|
829
|
+
} /**
|
|
830
|
+
* Access code is being deleted.
|
|
831
|
+
*/
|
|
305
832
|
| {
|
|
833
|
+
/**
|
|
834
|
+
* Date and time at which Seam created the warning.
|
|
835
|
+
*/
|
|
306
836
|
created_at?: string | undefined
|
|
837
|
+
/**
|
|
838
|
+
* Detailed description of the warning. Provides insights into the issue and potentially how to rectify it.
|
|
839
|
+
*/
|
|
307
840
|
message: string
|
|
308
841
|
|
|
842
|
+
/**
|
|
843
|
+
* Unique identifier of the type of warning. Enables quick recognition and categorization of the issue.
|
|
844
|
+
*/
|
|
309
845
|
warning_code: 'being_deleted'
|
|
310
|
-
}
|
|
846
|
+
} /**
|
|
847
|
+
* An unknown issue occurred with the access code.
|
|
848
|
+
*/
|
|
311
849
|
| {
|
|
850
|
+
/**
|
|
851
|
+
* Date and time at which Seam created the warning.
|
|
852
|
+
*/
|
|
312
853
|
created_at?: string | undefined
|
|
854
|
+
/**
|
|
855
|
+
* Detailed description of the warning. Provides insights into the issue and potentially how to rectify it.
|
|
856
|
+
*/
|
|
313
857
|
message: string
|
|
314
858
|
|
|
859
|
+
/**
|
|
860
|
+
* Unique identifier of the type of warning. Enables quick recognition and categorization of the issue.
|
|
861
|
+
*/
|
|
315
862
|
warning_code: 'unknown_issue_with_access_code'
|
|
316
863
|
}
|
|
317
864
|
>
|
|
318
865
|
|
|
866
|
+
/**
|
|
867
|
+
* Unique identifier for the Seam workspace associated with the access code.
|
|
868
|
+
*/
|
|
319
869
|
workspace_id: string
|
|
320
870
|
}
|