@space-df/sdk 0.0.1-dev.4 → 0.0.1-dev.40

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.
Files changed (219) hide show
  1. package/README.md +4 -7
  2. package/api.doc.md +2056 -20
  3. package/dist/README.md +4 -7
  4. package/dist/core.d.ts +1 -4
  5. package/dist/core.d.ts.map +1 -1
  6. package/dist/core.js +1 -3
  7. package/dist/core.js.map +1 -1
  8. package/dist/core.mjs +1 -3
  9. package/dist/core.mjs.map +1 -1
  10. package/dist/index.d.mts +18 -6
  11. package/dist/index.d.ts +18 -6
  12. package/dist/index.d.ts.map +1 -1
  13. package/dist/index.js +16 -16
  14. package/dist/index.js.map +1 -1
  15. package/dist/index.mjs +16 -16
  16. package/dist/index.mjs.map +1 -1
  17. package/dist/package.json +1 -1
  18. package/dist/resources/auth/auth.d.ts +20 -1
  19. package/dist/resources/auth/auth.d.ts.map +1 -1
  20. package/dist/resources/auth/auth.js +15 -0
  21. package/dist/resources/auth/auth.js.map +1 -1
  22. package/dist/resources/auth/auth.mjs +15 -0
  23. package/dist/resources/auth/auth.mjs.map +1 -1
  24. package/dist/resources/auth/index.d.ts +1 -0
  25. package/dist/resources/auth/index.d.ts.map +1 -1
  26. package/dist/resources/auth/index.js +1 -0
  27. package/dist/resources/auth/index.js.map +1 -1
  28. package/dist/resources/auth/index.mjs +1 -0
  29. package/dist/resources/auth/presigned-url.d.ts +10 -0
  30. package/dist/resources/auth/presigned-url.d.ts.map +1 -0
  31. package/dist/resources/auth/presigned-url.js +11 -0
  32. package/dist/resources/auth/presigned-url.js.map +1 -0
  33. package/dist/resources/auth/presigned-url.mjs +7 -0
  34. package/dist/resources/auth/presigned-url.mjs.map +1 -0
  35. package/dist/resources/auth/space-policies.d.ts +6 -3
  36. package/dist/resources/auth/space-policies.d.ts.map +1 -1
  37. package/dist/resources/auth/space-policies.js +16 -5
  38. package/dist/resources/auth/space-policies.js.map +1 -1
  39. package/dist/resources/auth/space-policies.mjs +16 -5
  40. package/dist/resources/auth/space-policies.mjs.map +1 -1
  41. package/dist/resources/auth/space-role-users.d.ts +13 -3
  42. package/dist/resources/auth/space-role-users.d.ts.map +1 -1
  43. package/dist/resources/auth/space-role-users.js +31 -6
  44. package/dist/resources/auth/space-role-users.js.map +1 -1
  45. package/dist/resources/auth/space-role-users.mjs +31 -6
  46. package/dist/resources/auth/space-role-users.mjs.map +1 -1
  47. package/dist/resources/auth/space-roles.d.ts +14 -3
  48. package/dist/resources/auth/space-roles.d.ts.map +1 -1
  49. package/dist/resources/auth/space-roles.js +14 -12
  50. package/dist/resources/auth/space-roles.js.map +1 -1
  51. package/dist/resources/auth/space-roles.mjs +14 -12
  52. package/dist/resources/auth/space-roles.mjs.map +1 -1
  53. package/dist/resources/auth/spaces.d.ts +21 -8
  54. package/dist/resources/auth/spaces.d.ts.map +1 -1
  55. package/dist/resources/auth/spaces.js +18 -6
  56. package/dist/resources/auth/spaces.js.map +1 -1
  57. package/dist/resources/auth/spaces.mjs +18 -6
  58. package/dist/resources/auth/spaces.mjs.map +1 -1
  59. package/dist/resources/dashboard/index.d.ts +1 -0
  60. package/dist/resources/dashboard/index.d.ts.map +1 -1
  61. package/dist/resources/dashboard/index.js +1 -0
  62. package/dist/resources/dashboard/index.js.map +1 -1
  63. package/dist/resources/dashboard/index.mjs +1 -0
  64. package/dist/resources/dashboard/widget.d.ts +11 -0
  65. package/dist/resources/dashboard/widget.d.ts.map +1 -0
  66. package/dist/resources/dashboard/widget.js +15 -0
  67. package/dist/resources/dashboard/widget.js.map +1 -0
  68. package/dist/resources/dashboard/widget.mjs +11 -0
  69. package/dist/resources/dashboard/widget.mjs.map +1 -0
  70. package/dist/resources/device/device-connector.d.ts +25 -0
  71. package/dist/resources/device/device-connector.d.ts.map +1 -0
  72. package/dist/resources/device/device-connector.js +30 -0
  73. package/dist/resources/device/device-connector.js.map +1 -0
  74. package/dist/resources/device/device-connector.mjs +26 -0
  75. package/dist/resources/device/device-connector.mjs.map +1 -0
  76. package/dist/resources/device/device-model.d.ts +20 -0
  77. package/dist/resources/device/device-model.d.ts.map +1 -0
  78. package/dist/resources/device/device-model.js +52 -0
  79. package/dist/resources/device/device-model.js.map +1 -0
  80. package/dist/resources/device/device-model.mjs +48 -0
  81. package/dist/resources/device/device-model.mjs.map +1 -0
  82. package/dist/resources/device/device-spaces.d.ts +19 -0
  83. package/dist/resources/device/device-spaces.d.ts.map +1 -0
  84. package/dist/resources/device/device-spaces.js +30 -0
  85. package/dist/resources/device/device-spaces.js.map +1 -0
  86. package/dist/resources/device/device-spaces.mjs +26 -0
  87. package/dist/resources/device/device-spaces.mjs.map +1 -0
  88. package/dist/resources/device/devices.d.ts +19 -0
  89. package/dist/resources/device/devices.d.ts.map +1 -0
  90. package/dist/resources/device/devices.js +58 -0
  91. package/dist/resources/device/devices.js.map +1 -0
  92. package/dist/resources/device/devices.mjs +54 -0
  93. package/dist/resources/device/devices.mjs.map +1 -0
  94. package/dist/resources/device/index.d.ts +8 -0
  95. package/dist/resources/device/index.d.ts.map +1 -0
  96. package/dist/resources/device/index.js +24 -0
  97. package/dist/resources/device/index.js.map +1 -0
  98. package/dist/resources/device/index.mjs +8 -0
  99. package/dist/resources/device/index.mjs.map +1 -0
  100. package/dist/resources/device/manufacturers.d.ts +20 -0
  101. package/dist/resources/device/manufacturers.d.ts.map +1 -0
  102. package/dist/resources/device/manufacturers.js +52 -0
  103. package/dist/resources/device/manufacturers.js.map +1 -0
  104. package/dist/resources/device/manufacturers.mjs +48 -0
  105. package/dist/resources/device/manufacturers.mjs.map +1 -0
  106. package/dist/resources/device/network-server.d.ts +19 -0
  107. package/dist/resources/device/network-server.d.ts.map +1 -0
  108. package/dist/resources/device/network-server.js +52 -0
  109. package/dist/resources/device/network-server.js.map +1 -0
  110. package/dist/resources/device/network-server.mjs +48 -0
  111. package/dist/resources/device/network-server.mjs.map +1 -0
  112. package/dist/resources/device/trip.d.ts +24 -0
  113. package/dist/resources/device/trip.d.ts.map +1 -0
  114. package/dist/resources/device/trip.js +49 -0
  115. package/dist/resources/device/trip.js.map +1 -0
  116. package/dist/resources/device/trip.mjs +45 -0
  117. package/dist/resources/device/trip.mjs.map +1 -0
  118. package/dist/resources/index.d.ts +3 -0
  119. package/dist/resources/index.d.ts.map +1 -1
  120. package/dist/resources/index.js +3 -0
  121. package/dist/resources/index.js.map +1 -1
  122. package/dist/resources/index.mjs +3 -0
  123. package/dist/resources/organizations/index.d.ts +2 -0
  124. package/dist/resources/organizations/index.d.ts.map +1 -0
  125. package/dist/resources/organizations/index.js +18 -0
  126. package/dist/resources/organizations/index.js.map +1 -0
  127. package/dist/resources/organizations/index.mjs +2 -0
  128. package/dist/resources/organizations/index.mjs.map +1 -0
  129. package/dist/resources/organizations/organizations.d.ts +9 -0
  130. package/dist/resources/organizations/organizations.d.ts.map +1 -0
  131. package/dist/resources/organizations/organizations.js +11 -0
  132. package/dist/resources/organizations/organizations.js.map +1 -0
  133. package/dist/resources/organizations/organizations.mjs +7 -0
  134. package/dist/resources/organizations/organizations.mjs.map +1 -0
  135. package/dist/resources/telemetry/alerts.d.ts +17 -0
  136. package/dist/resources/telemetry/alerts.d.ts.map +1 -0
  137. package/dist/resources/telemetry/alerts.js +16 -0
  138. package/dist/resources/telemetry/alerts.js.map +1 -0
  139. package/dist/resources/telemetry/alerts.mjs +12 -0
  140. package/dist/resources/telemetry/alerts.mjs.map +1 -0
  141. package/dist/resources/telemetry/entities.d.ts +40 -0
  142. package/dist/resources/telemetry/entities.d.ts.map +1 -0
  143. package/dist/resources/telemetry/entities.js +16 -0
  144. package/dist/resources/telemetry/entities.js.map +1 -0
  145. package/dist/resources/telemetry/entities.mjs +12 -0
  146. package/dist/resources/telemetry/entities.mjs.map +1 -0
  147. package/dist/resources/telemetry/geofences.d.ts +56 -0
  148. package/dist/resources/telemetry/geofences.d.ts.map +1 -0
  149. package/dist/resources/telemetry/geofences.js +52 -0
  150. package/dist/resources/telemetry/geofences.js.map +1 -0
  151. package/dist/resources/telemetry/geofences.mjs +48 -0
  152. package/dist/resources/telemetry/geofences.mjs.map +1 -0
  153. package/dist/resources/telemetry/index.d.ts +11 -0
  154. package/dist/resources/telemetry/index.d.ts.map +1 -0
  155. package/dist/resources/telemetry/index.js +32 -0
  156. package/dist/resources/telemetry/index.js.map +1 -0
  157. package/dist/resources/telemetry/index.mjs +14 -0
  158. package/dist/resources/telemetry/index.mjs.map +1 -0
  159. package/dist/src/core.ts +0 -6
  160. package/dist/src/index.ts +22 -22
  161. package/dist/src/resources/auth/auth.ts +42 -2
  162. package/dist/src/resources/auth/index.ts +1 -0
  163. package/dist/src/resources/auth/presigned-url.ts +13 -0
  164. package/dist/src/resources/auth/space-policies.ts +22 -7
  165. package/dist/src/resources/auth/space-role-users.ts +43 -6
  166. package/dist/src/resources/auth/space-roles.ts +27 -12
  167. package/dist/src/resources/auth/spaces.ts +42 -15
  168. package/dist/src/resources/dashboard/index.ts +1 -0
  169. package/dist/src/resources/dashboard/widget.ts +17 -0
  170. package/dist/src/resources/device/device-connector.ts +49 -0
  171. package/dist/src/resources/device/device-model.ts +65 -0
  172. package/dist/src/resources/device/device-spaces.ts +42 -0
  173. package/dist/src/resources/device/devices.ts +70 -0
  174. package/dist/src/resources/device/index.ts +7 -0
  175. package/dist/src/resources/device/manufacturers.ts +65 -0
  176. package/dist/src/resources/device/network-server.ts +64 -0
  177. package/dist/src/resources/device/trip.ts +69 -0
  178. package/dist/src/resources/index.ts +3 -0
  179. package/dist/src/resources/organizations/index.ts +1 -0
  180. package/dist/src/resources/organizations/organizations.ts +12 -0
  181. package/dist/src/resources/telemetry/alerts.ts +27 -0
  182. package/dist/src/resources/telemetry/entities.ts +51 -0
  183. package/dist/src/resources/telemetry/geofences.ts +91 -0
  184. package/dist/src/resources/telemetry/index.ts +12 -0
  185. package/dist/src/version.ts +1 -1
  186. package/dist/version.d.ts +1 -1
  187. package/dist/version.d.ts.map +1 -1
  188. package/dist/version.js +1 -1
  189. package/dist/version.js.map +1 -1
  190. package/dist/version.mjs +1 -1
  191. package/dist/version.mjs.map +1 -1
  192. package/package.json +1 -1
  193. package/src/core.ts +0 -6
  194. package/src/index.ts +22 -22
  195. package/src/resources/auth/auth.ts +42 -2
  196. package/src/resources/auth/index.ts +1 -0
  197. package/src/resources/auth/presigned-url.ts +13 -0
  198. package/src/resources/auth/space-policies.ts +22 -7
  199. package/src/resources/auth/space-role-users.ts +43 -6
  200. package/src/resources/auth/space-roles.ts +27 -12
  201. package/src/resources/auth/spaces.ts +42 -15
  202. package/src/resources/dashboard/index.ts +1 -0
  203. package/src/resources/dashboard/widget.ts +17 -0
  204. package/src/resources/device/device-connector.ts +49 -0
  205. package/src/resources/device/device-model.ts +65 -0
  206. package/src/resources/device/device-spaces.ts +42 -0
  207. package/src/resources/device/devices.ts +70 -0
  208. package/src/resources/device/index.ts +7 -0
  209. package/src/resources/device/manufacturers.ts +65 -0
  210. package/src/resources/device/network-server.ts +64 -0
  211. package/src/resources/device/trip.ts +69 -0
  212. package/src/resources/index.ts +3 -0
  213. package/src/resources/organizations/index.ts +1 -0
  214. package/src/resources/organizations/organizations.ts +12 -0
  215. package/src/resources/telemetry/alerts.ts +27 -0
  216. package/src/resources/telemetry/entities.ts +51 -0
  217. package/src/resources/telemetry/geofences.ts +91 -0
  218. package/src/resources/telemetry/index.ts +12 -0
  219. 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', APIKey: 'your-API-key' });
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', APIKey: 'your-API-key' });
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', APIKey: 'your-API-key' });
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
  ```