@seamapi/http 0.26.0 → 0.27.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/README.md +8 -5
- package/dist/connect.cjs.map +1 -1
- package/dist/connect.d.cts +4 -1
- package/lib/seam/connect/routes/access-codes-unmanaged.d.ts +1 -1
- package/lib/seam/connect/routes/access-codes-unmanaged.js.map +1 -1
- package/lib/seam/connect/routes/access-codes.d.ts +1 -1
- package/lib/seam/connect/routes/access-codes.js.map +1 -1
- package/lib/seam/connect/routes/acs-access-groups.d.ts +1 -1
- package/lib/seam/connect/routes/acs-access-groups.js.map +1 -1
- package/lib/seam/connect/routes/acs-credential-pools.d.ts +1 -1
- package/lib/seam/connect/routes/acs-credential-pools.js.map +1 -1
- package/lib/seam/connect/routes/acs-credential-provisioning-automations.d.ts +1 -1
- package/lib/seam/connect/routes/acs-credential-provisioning-automations.js.map +1 -1
- package/lib/seam/connect/routes/acs-credentials.d.ts +1 -1
- package/lib/seam/connect/routes/acs-credentials.js.map +1 -1
- package/lib/seam/connect/routes/acs-entrances.d.ts +1 -1
- package/lib/seam/connect/routes/acs-entrances.js.map +1 -1
- package/lib/seam/connect/routes/acs-systems.d.ts +1 -1
- package/lib/seam/connect/routes/acs-systems.js.map +1 -1
- package/lib/seam/connect/routes/acs-users.d.ts +1 -1
- package/lib/seam/connect/routes/acs-users.js.map +1 -1
- package/lib/seam/connect/routes/action-attempts.d.ts +1 -1
- package/lib/seam/connect/routes/action-attempts.js.map +1 -1
- package/lib/seam/connect/routes/client-sessions.d.ts +1 -1
- package/lib/seam/connect/routes/client-sessions.js.map +1 -1
- package/lib/seam/connect/routes/connect-webviews.d.ts +1 -1
- package/lib/seam/connect/routes/connect-webviews.js.map +1 -1
- package/lib/seam/connect/routes/connected-accounts.d.ts +1 -1
- package/lib/seam/connect/routes/connected-accounts.js.map +1 -1
- package/lib/seam/connect/routes/devices-simulate.d.ts +1 -1
- package/lib/seam/connect/routes/devices-simulate.js.map +1 -1
- package/lib/seam/connect/routes/devices-unmanaged.d.ts +1 -1
- package/lib/seam/connect/routes/devices-unmanaged.js.map +1 -1
- package/lib/seam/connect/routes/devices.d.ts +1 -1
- package/lib/seam/connect/routes/devices.js.map +1 -1
- package/lib/seam/connect/routes/events.d.ts +1 -1
- package/lib/seam/connect/routes/events.js.map +1 -1
- package/lib/seam/connect/routes/locks.d.ts +1 -1
- package/lib/seam/connect/routes/locks.js.map +1 -1
- package/lib/seam/connect/routes/networks.d.ts +1 -1
- package/lib/seam/connect/routes/networks.js.map +1 -1
- package/lib/seam/connect/routes/noise-sensors-noise-thresholds.d.ts +1 -1
- package/lib/seam/connect/routes/noise-sensors-noise-thresholds.js.map +1 -1
- package/lib/seam/connect/routes/phones-simulate.d.ts +1 -1
- package/lib/seam/connect/routes/phones-simulate.js.map +1 -1
- package/lib/seam/connect/routes/phones.d.ts +1 -1
- package/lib/seam/connect/routes/phones.js.map +1 -1
- package/lib/seam/connect/routes/thermostats-climate-setting-schedules.d.ts +1 -1
- package/lib/seam/connect/routes/thermostats-climate-setting-schedules.js.map +1 -1
- package/lib/seam/connect/routes/thermostats.d.ts +1 -1
- package/lib/seam/connect/routes/thermostats.js.map +1 -1
- package/lib/seam/connect/routes/user-identities-enrollment-automations.d.ts +1 -1
- package/lib/seam/connect/routes/user-identities-enrollment-automations.js.map +1 -1
- package/lib/seam/connect/routes/user-identities.d.ts +1 -1
- package/lib/seam/connect/routes/user-identities.js.map +1 -1
- package/lib/seam/connect/routes/webhooks.d.ts +1 -1
- package/lib/seam/connect/routes/webhooks.js.map +1 -1
- package/lib/seam/connect/routes/workspaces.d.ts +1 -1
- package/lib/seam/connect/routes/workspaces.js.map +1 -1
- package/lib/types.d.ts +3 -0
- package/lib/types.js +2 -0
- package/lib/types.js.map +1 -0
- package/lib/version.d.ts +1 -1
- package/lib/version.js +1 -1
- package/package.json +4 -8
- package/src/lib/seam/connect/routes/access-codes-unmanaged.ts +1 -1
- package/src/lib/seam/connect/routes/access-codes.ts +1 -1
- package/src/lib/seam/connect/routes/acs-access-groups.ts +1 -1
- package/src/lib/seam/connect/routes/acs-credential-pools.ts +1 -1
- package/src/lib/seam/connect/routes/acs-credential-provisioning-automations.ts +1 -1
- package/src/lib/seam/connect/routes/acs-credentials.ts +1 -1
- package/src/lib/seam/connect/routes/acs-entrances.ts +1 -1
- package/src/lib/seam/connect/routes/acs-systems.ts +1 -1
- package/src/lib/seam/connect/routes/acs-users.ts +1 -1
- package/src/lib/seam/connect/routes/action-attempts.ts +1 -1
- package/src/lib/seam/connect/routes/client-sessions.ts +1 -1
- package/src/lib/seam/connect/routes/connect-webviews.ts +1 -1
- package/src/lib/seam/connect/routes/connected-accounts.ts +1 -1
- package/src/lib/seam/connect/routes/devices-simulate.ts +1 -1
- package/src/lib/seam/connect/routes/devices-unmanaged.ts +1 -1
- package/src/lib/seam/connect/routes/devices.ts +1 -1
- package/src/lib/seam/connect/routes/events.ts +1 -1
- package/src/lib/seam/connect/routes/locks.ts +1 -1
- package/src/lib/seam/connect/routes/networks.ts +1 -1
- package/src/lib/seam/connect/routes/noise-sensors-noise-thresholds.ts +1 -1
- package/src/lib/seam/connect/routes/phones-simulate.ts +1 -1
- package/src/lib/seam/connect/routes/phones.ts +1 -1
- package/src/lib/seam/connect/routes/thermostats-climate-setting-schedules.ts +1 -1
- package/src/lib/seam/connect/routes/thermostats.ts +1 -1
- package/src/lib/seam/connect/routes/user-identities-enrollment-automations.ts +1 -1
- package/src/lib/seam/connect/routes/user-identities.ts +1 -1
- package/src/lib/seam/connect/routes/webhooks.ts +1 -1
- package/src/lib/seam/connect/routes/workspaces.ts +1 -1
- package/src/lib/types.ts +8 -0
- package/src/lib/version.ts +1 -1
package/README.md
CHANGED
|
@@ -28,10 +28,11 @@ The underlying HTTP client is [Axios].
|
|
|
28
28
|
|
|
29
29
|
## Installation
|
|
30
30
|
|
|
31
|
-
|
|
32
|
-
|
|
33
|
-
|
|
34
|
-
|
|
31
|
+
> [!IMPORTANT]
|
|
32
|
+
> This is a low-level package meant for applications and libraries with particular dependency requirements.
|
|
33
|
+
> Before using this package, ensure you understand the installation and updating instructions.
|
|
34
|
+
> This SDK is entirely contained in the [seam package].
|
|
35
|
+
> Seam recommends using that package instead for simpler dependency management.
|
|
35
36
|
|
|
36
37
|
Add this as a dependency to your project using [npm] with
|
|
37
38
|
|
|
@@ -76,7 +77,8 @@ $ npm install -D @seamapi/types@latest
|
|
|
76
77
|
|
|
77
78
|
### Examples
|
|
78
79
|
|
|
79
|
-
|
|
80
|
+
> [!NOTE]
|
|
81
|
+
> These examples assume `SEAM_API_KEY` is set in your environment.
|
|
80
82
|
|
|
81
83
|
#### List devices
|
|
82
84
|
|
|
@@ -104,6 +106,7 @@ Authentication may be configured by passing the corresponding
|
|
|
104
106
|
options directly to the `SeamHttp` constructor,
|
|
105
107
|
or with the more ergonomic static factory methods.
|
|
106
108
|
|
|
109
|
+
> [!NOTE]
|
|
107
110
|
> Publishable Key authentication is not supported by the constructor
|
|
108
111
|
> and must be configured using `SeamHttp.fromPublishableKey`.
|
|
109
112
|
|