@space-df/sdk 0.0.1-dev.4 → 0.0.1-dev.41
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 +4 -7
- package/api.doc.md +2057 -20
- package/dist/README.md +4 -7
- package/dist/core.d.ts +1 -4
- package/dist/core.d.ts.map +1 -1
- package/dist/core.js +1 -3
- package/dist/core.js.map +1 -1
- package/dist/core.mjs +1 -3
- package/dist/core.mjs.map +1 -1
- package/dist/index.d.mts +18 -6
- package/dist/index.d.ts +18 -6
- package/dist/index.d.ts.map +1 -1
- package/dist/index.js +16 -16
- package/dist/index.js.map +1 -1
- package/dist/index.mjs +16 -16
- package/dist/index.mjs.map +1 -1
- package/dist/package.json +1 -1
- package/dist/resources/auth/auth.d.ts +20 -1
- package/dist/resources/auth/auth.d.ts.map +1 -1
- package/dist/resources/auth/auth.js +15 -0
- package/dist/resources/auth/auth.js.map +1 -1
- package/dist/resources/auth/auth.mjs +15 -0
- package/dist/resources/auth/auth.mjs.map +1 -1
- package/dist/resources/auth/index.d.ts +1 -0
- package/dist/resources/auth/index.d.ts.map +1 -1
- package/dist/resources/auth/index.js +1 -0
- package/dist/resources/auth/index.js.map +1 -1
- package/dist/resources/auth/index.mjs +1 -0
- package/dist/resources/auth/presigned-url.d.ts +10 -0
- package/dist/resources/auth/presigned-url.d.ts.map +1 -0
- package/dist/resources/auth/presigned-url.js +11 -0
- package/dist/resources/auth/presigned-url.js.map +1 -0
- package/dist/resources/auth/presigned-url.mjs +7 -0
- package/dist/resources/auth/presigned-url.mjs.map +1 -0
- package/dist/resources/auth/space-policies.d.ts +6 -3
- package/dist/resources/auth/space-policies.d.ts.map +1 -1
- package/dist/resources/auth/space-policies.js +16 -5
- package/dist/resources/auth/space-policies.js.map +1 -1
- package/dist/resources/auth/space-policies.mjs +16 -5
- package/dist/resources/auth/space-policies.mjs.map +1 -1
- package/dist/resources/auth/space-role-users.d.ts +13 -3
- package/dist/resources/auth/space-role-users.d.ts.map +1 -1
- package/dist/resources/auth/space-role-users.js +31 -6
- package/dist/resources/auth/space-role-users.js.map +1 -1
- package/dist/resources/auth/space-role-users.mjs +31 -6
- package/dist/resources/auth/space-role-users.mjs.map +1 -1
- package/dist/resources/auth/space-roles.d.ts +14 -3
- package/dist/resources/auth/space-roles.d.ts.map +1 -1
- package/dist/resources/auth/space-roles.js +14 -12
- package/dist/resources/auth/space-roles.js.map +1 -1
- package/dist/resources/auth/space-roles.mjs +14 -12
- package/dist/resources/auth/space-roles.mjs.map +1 -1
- package/dist/resources/auth/spaces.d.ts +21 -8
- package/dist/resources/auth/spaces.d.ts.map +1 -1
- package/dist/resources/auth/spaces.js +18 -6
- package/dist/resources/auth/spaces.js.map +1 -1
- package/dist/resources/auth/spaces.mjs +18 -6
- package/dist/resources/auth/spaces.mjs.map +1 -1
- package/dist/resources/dashboard/index.d.ts +1 -0
- package/dist/resources/dashboard/index.d.ts.map +1 -1
- package/dist/resources/dashboard/index.js +1 -0
- package/dist/resources/dashboard/index.js.map +1 -1
- package/dist/resources/dashboard/index.mjs +1 -0
- package/dist/resources/dashboard/widget.d.ts +11 -0
- package/dist/resources/dashboard/widget.d.ts.map +1 -0
- package/dist/resources/dashboard/widget.js +15 -0
- package/dist/resources/dashboard/widget.js.map +1 -0
- package/dist/resources/dashboard/widget.mjs +11 -0
- package/dist/resources/dashboard/widget.mjs.map +1 -0
- package/dist/resources/device/device-connector.d.ts +25 -0
- package/dist/resources/device/device-connector.d.ts.map +1 -0
- package/dist/resources/device/device-connector.js +30 -0
- package/dist/resources/device/device-connector.js.map +1 -0
- package/dist/resources/device/device-connector.mjs +26 -0
- package/dist/resources/device/device-connector.mjs.map +1 -0
- package/dist/resources/device/device-model.d.ts +20 -0
- package/dist/resources/device/device-model.d.ts.map +1 -0
- package/dist/resources/device/device-model.js +52 -0
- package/dist/resources/device/device-model.js.map +1 -0
- package/dist/resources/device/device-model.mjs +48 -0
- package/dist/resources/device/device-model.mjs.map +1 -0
- package/dist/resources/device/device-spaces.d.ts +19 -0
- package/dist/resources/device/device-spaces.d.ts.map +1 -0
- package/dist/resources/device/device-spaces.js +30 -0
- package/dist/resources/device/device-spaces.js.map +1 -0
- package/dist/resources/device/device-spaces.mjs +26 -0
- package/dist/resources/device/device-spaces.mjs.map +1 -0
- package/dist/resources/device/devices.d.ts +19 -0
- package/dist/resources/device/devices.d.ts.map +1 -0
- package/dist/resources/device/devices.js +58 -0
- package/dist/resources/device/devices.js.map +1 -0
- package/dist/resources/device/devices.mjs +54 -0
- package/dist/resources/device/devices.mjs.map +1 -0
- package/dist/resources/device/index.d.ts +8 -0
- package/dist/resources/device/index.d.ts.map +1 -0
- package/dist/resources/device/index.js +24 -0
- package/dist/resources/device/index.js.map +1 -0
- package/dist/resources/device/index.mjs +8 -0
- package/dist/resources/device/index.mjs.map +1 -0
- package/dist/resources/device/manufacturers.d.ts +20 -0
- package/dist/resources/device/manufacturers.d.ts.map +1 -0
- package/dist/resources/device/manufacturers.js +52 -0
- package/dist/resources/device/manufacturers.js.map +1 -0
- package/dist/resources/device/manufacturers.mjs +48 -0
- package/dist/resources/device/manufacturers.mjs.map +1 -0
- package/dist/resources/device/network-server.d.ts +19 -0
- package/dist/resources/device/network-server.d.ts.map +1 -0
- package/dist/resources/device/network-server.js +52 -0
- package/dist/resources/device/network-server.js.map +1 -0
- package/dist/resources/device/network-server.mjs +48 -0
- package/dist/resources/device/network-server.mjs.map +1 -0
- package/dist/resources/device/trip.d.ts +24 -0
- package/dist/resources/device/trip.d.ts.map +1 -0
- package/dist/resources/device/trip.js +49 -0
- package/dist/resources/device/trip.js.map +1 -0
- package/dist/resources/device/trip.mjs +45 -0
- package/dist/resources/device/trip.mjs.map +1 -0
- package/dist/resources/index.d.ts +3 -0
- package/dist/resources/index.d.ts.map +1 -1
- package/dist/resources/index.js +3 -0
- package/dist/resources/index.js.map +1 -1
- package/dist/resources/index.mjs +3 -0
- package/dist/resources/organizations/index.d.ts +2 -0
- package/dist/resources/organizations/index.d.ts.map +1 -0
- package/dist/resources/organizations/index.js +18 -0
- package/dist/resources/organizations/index.js.map +1 -0
- package/dist/resources/organizations/index.mjs +2 -0
- package/dist/resources/organizations/index.mjs.map +1 -0
- package/dist/resources/organizations/organizations.d.ts +9 -0
- package/dist/resources/organizations/organizations.d.ts.map +1 -0
- package/dist/resources/organizations/organizations.js +11 -0
- package/dist/resources/organizations/organizations.js.map +1 -0
- package/dist/resources/organizations/organizations.mjs +7 -0
- package/dist/resources/organizations/organizations.mjs.map +1 -0
- package/dist/resources/telemetry/alerts.d.ts +17 -0
- package/dist/resources/telemetry/alerts.d.ts.map +1 -0
- package/dist/resources/telemetry/alerts.js +16 -0
- package/dist/resources/telemetry/alerts.js.map +1 -0
- package/dist/resources/telemetry/alerts.mjs +12 -0
- package/dist/resources/telemetry/alerts.mjs.map +1 -0
- package/dist/resources/telemetry/entities.d.ts +40 -0
- package/dist/resources/telemetry/entities.d.ts.map +1 -0
- package/dist/resources/telemetry/entities.js +16 -0
- package/dist/resources/telemetry/entities.js.map +1 -0
- package/dist/resources/telemetry/entities.mjs +12 -0
- package/dist/resources/telemetry/entities.mjs.map +1 -0
- package/dist/resources/telemetry/geofences.d.ts +56 -0
- package/dist/resources/telemetry/geofences.d.ts.map +1 -0
- package/dist/resources/telemetry/geofences.js +52 -0
- package/dist/resources/telemetry/geofences.js.map +1 -0
- package/dist/resources/telemetry/geofences.mjs +48 -0
- package/dist/resources/telemetry/geofences.mjs.map +1 -0
- package/dist/resources/telemetry/index.d.ts +11 -0
- package/dist/resources/telemetry/index.d.ts.map +1 -0
- package/dist/resources/telemetry/index.js +32 -0
- package/dist/resources/telemetry/index.js.map +1 -0
- package/dist/resources/telemetry/index.mjs +14 -0
- package/dist/resources/telemetry/index.mjs.map +1 -0
- package/dist/src/core.ts +0 -6
- package/dist/src/index.ts +22 -22
- package/dist/src/resources/auth/auth.ts +42 -2
- package/dist/src/resources/auth/index.ts +1 -0
- package/dist/src/resources/auth/presigned-url.ts +13 -0
- package/dist/src/resources/auth/space-policies.ts +22 -7
- package/dist/src/resources/auth/space-role-users.ts +43 -6
- package/dist/src/resources/auth/space-roles.ts +27 -12
- package/dist/src/resources/auth/spaces.ts +42 -15
- package/dist/src/resources/dashboard/index.ts +1 -0
- package/dist/src/resources/dashboard/widget.ts +17 -0
- package/dist/src/resources/device/device-connector.ts +49 -0
- package/dist/src/resources/device/device-model.ts +65 -0
- package/dist/src/resources/device/device-spaces.ts +42 -0
- package/dist/src/resources/device/devices.ts +70 -0
- package/dist/src/resources/device/index.ts +7 -0
- package/dist/src/resources/device/manufacturers.ts +65 -0
- package/dist/src/resources/device/network-server.ts +64 -0
- package/dist/src/resources/device/trip.ts +69 -0
- package/dist/src/resources/index.ts +3 -0
- package/dist/src/resources/organizations/index.ts +1 -0
- package/dist/src/resources/organizations/organizations.ts +12 -0
- package/dist/src/resources/telemetry/alerts.ts +27 -0
- package/dist/src/resources/telemetry/entities.ts +51 -0
- package/dist/src/resources/telemetry/geofences.ts +92 -0
- package/dist/src/resources/telemetry/index.ts +12 -0
- package/dist/src/types/api.ts +5 -0
- package/dist/src/version.ts +1 -1
- package/dist/types/api.d.ts +4 -0
- package/dist/types/api.d.ts.map +1 -1
- package/dist/version.d.ts +1 -1
- package/dist/version.d.ts.map +1 -1
- package/dist/version.js +1 -1
- package/dist/version.js.map +1 -1
- package/dist/version.mjs +1 -1
- package/dist/version.mjs.map +1 -1
- package/package.json +1 -1
- package/src/core.ts +0 -6
- package/src/index.ts +22 -22
- package/src/resources/auth/auth.ts +42 -2
- package/src/resources/auth/index.ts +1 -0
- package/src/resources/auth/presigned-url.ts +13 -0
- package/src/resources/auth/space-policies.ts +22 -7
- package/src/resources/auth/space-role-users.ts +43 -6
- package/src/resources/auth/space-roles.ts +27 -12
- package/src/resources/auth/spaces.ts +42 -15
- package/src/resources/dashboard/index.ts +1 -0
- package/src/resources/dashboard/widget.ts +17 -0
- package/src/resources/device/device-connector.ts +49 -0
- package/src/resources/device/device-model.ts +65 -0
- package/src/resources/device/device-spaces.ts +42 -0
- package/src/resources/device/devices.ts +70 -0
- package/src/resources/device/index.ts +7 -0
- package/src/resources/device/manufacturers.ts +65 -0
- package/src/resources/device/network-server.ts +64 -0
- package/src/resources/device/trip.ts +69 -0
- package/src/resources/index.ts +3 -0
- package/src/resources/organizations/index.ts +1 -0
- package/src/resources/organizations/organizations.ts +12 -0
- package/src/resources/telemetry/alerts.ts +27 -0
- package/src/resources/telemetry/entities.ts +51 -0
- package/src/resources/telemetry/geofences.ts +92 -0
- package/src/resources/telemetry/index.ts +12 -0
- package/src/types/api.ts +5 -0
- package/src/version.ts +1 -1
package/README.md
CHANGED
|
@@ -38,7 +38,6 @@ Customize the SDK with a configuration file. Below are common options:
|
|
|
38
38
|
| ---------------- | ------------------------------------------------------------------ | ------------- |
|
|
39
39
|
| `organization` | Your organization | None |
|
|
40
40
|
| `baseURL` | baseURL | None |
|
|
41
|
-
| `APIKey` | APIKey | None |
|
|
42
41
|
| `timeout` | The maximum amount of time | 1 minute |
|
|
43
42
|
| `httpAgent` | An HTTP agent used to manage HTTP(S) connections | None |
|
|
44
43
|
| `fetch` | Specify a custom `fetch` function implementation | Node fetch |
|
|
@@ -50,7 +49,7 @@ Customize the SDK with a configuration file. Below are common options:
|
|
|
50
49
|
Example:
|
|
51
50
|
|
|
52
51
|
```typescript
|
|
53
|
-
const sdk = new SDK({ organization: 'your-organization'
|
|
52
|
+
const sdk = new SDK({ organization: 'your-organization' });
|
|
54
53
|
```
|
|
55
54
|
|
|
56
55
|
## Usage
|
|
@@ -60,10 +59,10 @@ Import and initialize a client.
|
|
|
60
59
|
```typescript
|
|
61
60
|
import SpaceDFSDK from 'spacedf-sdk';
|
|
62
61
|
|
|
63
|
-
const client = new SpaceDFSDK({ organization: 'your-organization'
|
|
62
|
+
const client = new SpaceDFSDK({ organization: 'your-organization' });
|
|
64
63
|
|
|
65
64
|
/* or use with your base url */
|
|
66
|
-
// const client = new SpaceDFSDK({ baseURL: 'your-url'
|
|
65
|
+
// const client = new SpaceDFSDK({ baseURL: 'your-url' });
|
|
67
66
|
```
|
|
68
67
|
|
|
69
68
|
Register new SpaceDF account.
|
|
@@ -104,8 +103,7 @@ const registerResponse = await client.auth.register(
|
|
|
104
103
|
password: 'example',
|
|
105
104
|
},
|
|
106
105
|
{
|
|
107
|
-
organization: 'your-organization'
|
|
108
|
-
APIKey: 'your-API-key',
|
|
106
|
+
organization: 'your-organization'
|
|
109
107
|
},
|
|
110
108
|
);
|
|
111
109
|
|
|
@@ -113,7 +111,6 @@ const registerResponse = await client.auth.register(
|
|
|
113
111
|
|
|
114
112
|
const spacePoliciesResponse = await client.spacePolicies.retrieve(1, {
|
|
115
113
|
organization: 'your-organization',
|
|
116
|
-
APIKey: 'your-API-key',
|
|
117
114
|
accessToken: 'your-access-token',
|
|
118
115
|
});
|
|
119
116
|
```
|