@samsarahq/samsara 13.31.0 → 13.33.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.
Files changed (186) hide show
  1. package/dist/cjs/BaseClient.js +2 -2
  2. package/dist/cjs/api/resources/assets/client/Client.d.ts +32 -0
  3. package/dist/cjs/api/resources/assets/client/Client.js +91 -0
  4. package/dist/cjs/api/resources/assets/client/requests/GetAssetReeferRequest.d.ts +16 -0
  5. package/dist/cjs/api/resources/assets/client/requests/GetAssetReeferRequest.js +3 -0
  6. package/dist/cjs/api/resources/assets/client/requests/index.d.ts +1 -0
  7. package/dist/cjs/api/resources/betaApIs/client/Client.d.ts +31 -0
  8. package/dist/cjs/api/resources/betaApIs/client/Client.js +101 -0
  9. package/dist/cjs/api/resources/betaApIs/client/requests/GetPlaceGeofenceRequest.d.ts +36 -0
  10. package/dist/cjs/api/resources/betaApIs/client/requests/GetPlaceGeofenceRequest.js +3 -0
  11. package/dist/cjs/api/resources/betaApIs/client/requests/PlacesPatchPlaceRequestBody.d.ts +1 -0
  12. package/dist/cjs/api/resources/betaApIs/client/requests/PlacesPostPlaceRequestBody.d.ts +1 -0
  13. package/dist/cjs/api/resources/betaApIs/client/requests/index.d.ts +1 -0
  14. package/dist/cjs/api/resources/betaApIs/types/GetPlaceGeofenceRequestSizeOrder.d.ts +5 -0
  15. package/dist/cjs/api/resources/betaApIs/types/GetPlaceGeofenceRequestSizeOrder.js +8 -0
  16. package/dist/cjs/api/resources/betaApIs/types/index.d.ts +1 -0
  17. package/dist/cjs/api/resources/betaApIs/types/index.js +1 -0
  18. package/dist/cjs/api/resources/media/client/Client.d.ts +0 -1
  19. package/dist/cjs/api/resources/media/client/Client.js +0 -1
  20. package/dist/cjs/api/resources/media/client/requests/MediaRetrievalPostMediaRetrievalRequestBody.d.ts +30 -3
  21. package/dist/cjs/api/resources/media/client/requests/MediaRetrievalPostMediaRetrievalRequestBody.js +25 -0
  22. package/dist/cjs/api/resources/readings/client/requests/GetReadingsHistoryRequest.d.ts +4 -0
  23. package/dist/cjs/api/resources/readings/client/requests/GetReadingsSnapshotRequest.d.ts +4 -0
  24. package/dist/cjs/api/types/AssetReeferAlarmObjectResponseBody.d.ts +10 -0
  25. package/dist/cjs/api/types/AssetReeferAlarmObjectResponseBody.js +3 -0
  26. package/dist/cjs/api/types/AssetReeferAlarmsStatObjectResponseBody.d.ts +7 -0
  27. package/dist/cjs/api/types/AssetReeferAlarmsStatObjectResponseBody.js +3 -0
  28. package/dist/cjs/api/types/AssetReeferEngineHoursStatObjectResponseBody.d.ts +6 -0
  29. package/dist/cjs/api/types/AssetReeferEngineHoursStatObjectResponseBody.js +3 -0
  30. package/dist/cjs/api/types/AssetReeferFuelPercentageStatObjectResponseBody.d.ts +6 -0
  31. package/dist/cjs/api/types/AssetReeferFuelPercentageStatObjectResponseBody.js +3 -0
  32. package/dist/cjs/api/types/AssetReeferPowerStatusObjectResponseBody.d.ts +6 -0
  33. package/dist/cjs/api/types/AssetReeferPowerStatusObjectResponseBody.js +3 -0
  34. package/dist/cjs/api/types/AssetReeferStatsObjectResponseBody.d.ts +15 -0
  35. package/dist/cjs/api/types/AssetReeferStatsObjectResponseBody.js +3 -0
  36. package/dist/cjs/api/types/AssetReeferTemperatureStatObjectResponseBody.d.ts +6 -0
  37. package/dist/cjs/api/types/AssetReeferTemperatureStatObjectResponseBody.js +3 -0
  38. package/dist/cjs/api/types/AssetsGetAssetReeferBadGatewayErrorResponseBody.d.ts +9 -0
  39. package/dist/cjs/api/types/AssetsGetAssetReeferBadGatewayErrorResponseBody.js +3 -0
  40. package/dist/cjs/api/types/AssetsGetAssetReeferGatewayTimeoutErrorResponseBody.d.ts +9 -0
  41. package/dist/cjs/api/types/AssetsGetAssetReeferGatewayTimeoutErrorResponseBody.js +3 -0
  42. package/dist/cjs/api/types/AssetsGetAssetReeferInternalServerErrorResponseBody.d.ts +9 -0
  43. package/dist/cjs/api/types/AssetsGetAssetReeferInternalServerErrorResponseBody.js +3 -0
  44. package/dist/cjs/api/types/AssetsGetAssetReeferMethodNotAllowedErrorResponseBody.d.ts +9 -0
  45. package/dist/cjs/api/types/AssetsGetAssetReeferMethodNotAllowedErrorResponseBody.js +3 -0
  46. package/dist/cjs/api/types/AssetsGetAssetReeferNotFoundErrorResponseBody.d.ts +9 -0
  47. package/dist/cjs/api/types/AssetsGetAssetReeferNotFoundErrorResponseBody.js +3 -0
  48. package/dist/cjs/api/types/AssetsGetAssetReeferNotImplementedErrorResponseBody.d.ts +9 -0
  49. package/dist/cjs/api/types/AssetsGetAssetReeferNotImplementedErrorResponseBody.js +3 -0
  50. package/dist/cjs/api/types/AssetsGetAssetReeferResponseBody.d.ts +10 -0
  51. package/dist/cjs/api/types/AssetsGetAssetReeferResponseBody.js +3 -0
  52. package/dist/cjs/api/types/AssetsGetAssetReeferServiceUnavailableErrorResponseBody.d.ts +9 -0
  53. package/dist/cjs/api/types/AssetsGetAssetReeferServiceUnavailableErrorResponseBody.js +3 -0
  54. package/dist/cjs/api/types/AssetsGetAssetReeferTooManyRequestsErrorResponseBody.d.ts +9 -0
  55. package/dist/cjs/api/types/AssetsGetAssetReeferTooManyRequestsErrorResponseBody.js +3 -0
  56. package/dist/cjs/api/types/AssetsGetAssetReeferUnauthorizedErrorResponseBody.d.ts +9 -0
  57. package/dist/cjs/api/types/AssetsGetAssetReeferUnauthorizedErrorResponseBody.js +3 -0
  58. package/dist/cjs/api/types/PlaceBusinessContactResponseResponseBody.d.ts +11 -0
  59. package/dist/cjs/api/types/PlaceBusinessContactResponseResponseBody.js +3 -0
  60. package/dist/cjs/api/types/PlaceBusinessContactsResponseResponseBody.d.ts +12 -0
  61. package/dist/cjs/api/types/PlaceBusinessContactsResponseResponseBody.js +3 -0
  62. package/dist/cjs/api/types/PlaceGeofenceSuggestionCandidateResponseResponseBody.d.ts +26 -0
  63. package/dist/cjs/api/types/PlaceGeofenceSuggestionCandidateResponseResponseBody.js +17 -0
  64. package/dist/cjs/api/types/PlaceResponseObjectResponseBody.d.ts +1 -0
  65. package/dist/cjs/api/types/PlacesGetPlaceGeofenceBadGatewayErrorResponseBody.d.ts +9 -0
  66. package/dist/cjs/api/types/PlacesGetPlaceGeofenceBadGatewayErrorResponseBody.js +3 -0
  67. package/dist/cjs/api/types/PlacesGetPlaceGeofenceGatewayTimeoutErrorResponseBody.d.ts +9 -0
  68. package/dist/cjs/api/types/PlacesGetPlaceGeofenceGatewayTimeoutErrorResponseBody.js +3 -0
  69. package/dist/cjs/api/types/PlacesGetPlaceGeofenceInternalServerErrorResponseBody.d.ts +9 -0
  70. package/dist/cjs/api/types/PlacesGetPlaceGeofenceInternalServerErrorResponseBody.js +3 -0
  71. package/dist/cjs/api/types/PlacesGetPlaceGeofenceMethodNotAllowedErrorResponseBody.d.ts +9 -0
  72. package/dist/cjs/api/types/PlacesGetPlaceGeofenceMethodNotAllowedErrorResponseBody.js +3 -0
  73. package/dist/cjs/api/types/PlacesGetPlaceGeofenceNotFoundErrorResponseBody.d.ts +9 -0
  74. package/dist/cjs/api/types/PlacesGetPlaceGeofenceNotFoundErrorResponseBody.js +3 -0
  75. package/dist/cjs/api/types/PlacesGetPlaceGeofenceNotImplementedErrorResponseBody.d.ts +9 -0
  76. package/dist/cjs/api/types/PlacesGetPlaceGeofenceNotImplementedErrorResponseBody.js +3 -0
  77. package/dist/cjs/api/types/PlacesGetPlaceGeofenceResponseBody.d.ts +7 -0
  78. package/dist/cjs/api/types/PlacesGetPlaceGeofenceResponseBody.js +3 -0
  79. package/dist/cjs/api/types/PlacesGetPlaceGeofenceServiceUnavailableErrorResponseBody.d.ts +9 -0
  80. package/dist/cjs/api/types/PlacesGetPlaceGeofenceServiceUnavailableErrorResponseBody.js +3 -0
  81. package/dist/cjs/api/types/PlacesGetPlaceGeofenceTooManyRequestsErrorResponseBody.d.ts +9 -0
  82. package/dist/cjs/api/types/PlacesGetPlaceGeofenceTooManyRequestsErrorResponseBody.js +3 -0
  83. package/dist/cjs/api/types/PlacesGetPlaceGeofenceUnauthorizedErrorResponseBody.d.ts +9 -0
  84. package/dist/cjs/api/types/PlacesGetPlaceGeofenceUnauthorizedErrorResponseBody.js +3 -0
  85. package/dist/cjs/api/types/PostPlaceBusinessContactInputRequestBody.d.ts +11 -0
  86. package/dist/cjs/api/types/PostPlaceBusinessContactInputRequestBody.js +3 -0
  87. package/dist/cjs/api/types/PostPlaceBusinessContactsInputRequestBody.d.ts +12 -0
  88. package/dist/cjs/api/types/PostPlaceBusinessContactsInputRequestBody.js +3 -0
  89. package/dist/cjs/api/types/index.d.ts +32 -0
  90. package/dist/cjs/api/types/index.js +32 -0
  91. package/dist/cjs/version.d.ts +1 -1
  92. package/dist/cjs/version.js +1 -1
  93. package/dist/esm/BaseClient.mjs +2 -2
  94. package/dist/esm/api/resources/assets/client/Client.d.mts +32 -0
  95. package/dist/esm/api/resources/assets/client/Client.mjs +91 -0
  96. package/dist/esm/api/resources/assets/client/requests/GetAssetReeferRequest.d.mts +16 -0
  97. package/dist/esm/api/resources/assets/client/requests/GetAssetReeferRequest.mjs +2 -0
  98. package/dist/esm/api/resources/assets/client/requests/index.d.mts +1 -0
  99. package/dist/esm/api/resources/betaApIs/client/Client.d.mts +31 -0
  100. package/dist/esm/api/resources/betaApIs/client/Client.mjs +101 -0
  101. package/dist/esm/api/resources/betaApIs/client/requests/GetPlaceGeofenceRequest.d.mts +36 -0
  102. package/dist/esm/api/resources/betaApIs/client/requests/GetPlaceGeofenceRequest.mjs +2 -0
  103. package/dist/esm/api/resources/betaApIs/client/requests/PlacesPatchPlaceRequestBody.d.mts +1 -0
  104. package/dist/esm/api/resources/betaApIs/client/requests/PlacesPostPlaceRequestBody.d.mts +1 -0
  105. package/dist/esm/api/resources/betaApIs/client/requests/index.d.mts +1 -0
  106. package/dist/esm/api/resources/betaApIs/types/GetPlaceGeofenceRequestSizeOrder.d.mts +5 -0
  107. package/dist/esm/api/resources/betaApIs/types/GetPlaceGeofenceRequestSizeOrder.mjs +5 -0
  108. package/dist/esm/api/resources/betaApIs/types/index.d.mts +1 -0
  109. package/dist/esm/api/resources/betaApIs/types/index.mjs +1 -0
  110. package/dist/esm/api/resources/media/client/Client.d.mts +0 -1
  111. package/dist/esm/api/resources/media/client/Client.mjs +0 -1
  112. package/dist/esm/api/resources/media/client/requests/MediaRetrievalPostMediaRetrievalRequestBody.d.mts +30 -3
  113. package/dist/esm/api/resources/media/client/requests/MediaRetrievalPostMediaRetrievalRequestBody.mjs +25 -0
  114. package/dist/esm/api/resources/readings/client/requests/GetReadingsHistoryRequest.d.mts +4 -0
  115. package/dist/esm/api/resources/readings/client/requests/GetReadingsSnapshotRequest.d.mts +4 -0
  116. package/dist/esm/api/types/AssetReeferAlarmObjectResponseBody.d.mts +10 -0
  117. package/dist/esm/api/types/AssetReeferAlarmObjectResponseBody.mjs +2 -0
  118. package/dist/esm/api/types/AssetReeferAlarmsStatObjectResponseBody.d.mts +7 -0
  119. package/dist/esm/api/types/AssetReeferAlarmsStatObjectResponseBody.mjs +2 -0
  120. package/dist/esm/api/types/AssetReeferEngineHoursStatObjectResponseBody.d.mts +6 -0
  121. package/dist/esm/api/types/AssetReeferEngineHoursStatObjectResponseBody.mjs +2 -0
  122. package/dist/esm/api/types/AssetReeferFuelPercentageStatObjectResponseBody.d.mts +6 -0
  123. package/dist/esm/api/types/AssetReeferFuelPercentageStatObjectResponseBody.mjs +2 -0
  124. package/dist/esm/api/types/AssetReeferPowerStatusObjectResponseBody.d.mts +6 -0
  125. package/dist/esm/api/types/AssetReeferPowerStatusObjectResponseBody.mjs +2 -0
  126. package/dist/esm/api/types/AssetReeferStatsObjectResponseBody.d.mts +15 -0
  127. package/dist/esm/api/types/AssetReeferStatsObjectResponseBody.mjs +2 -0
  128. package/dist/esm/api/types/AssetReeferTemperatureStatObjectResponseBody.d.mts +6 -0
  129. package/dist/esm/api/types/AssetReeferTemperatureStatObjectResponseBody.mjs +2 -0
  130. package/dist/esm/api/types/AssetsGetAssetReeferBadGatewayErrorResponseBody.d.mts +9 -0
  131. package/dist/esm/api/types/AssetsGetAssetReeferBadGatewayErrorResponseBody.mjs +2 -0
  132. package/dist/esm/api/types/AssetsGetAssetReeferGatewayTimeoutErrorResponseBody.d.mts +9 -0
  133. package/dist/esm/api/types/AssetsGetAssetReeferGatewayTimeoutErrorResponseBody.mjs +2 -0
  134. package/dist/esm/api/types/AssetsGetAssetReeferInternalServerErrorResponseBody.d.mts +9 -0
  135. package/dist/esm/api/types/AssetsGetAssetReeferInternalServerErrorResponseBody.mjs +2 -0
  136. package/dist/esm/api/types/AssetsGetAssetReeferMethodNotAllowedErrorResponseBody.d.mts +9 -0
  137. package/dist/esm/api/types/AssetsGetAssetReeferMethodNotAllowedErrorResponseBody.mjs +2 -0
  138. package/dist/esm/api/types/AssetsGetAssetReeferNotFoundErrorResponseBody.d.mts +9 -0
  139. package/dist/esm/api/types/AssetsGetAssetReeferNotFoundErrorResponseBody.mjs +2 -0
  140. package/dist/esm/api/types/AssetsGetAssetReeferNotImplementedErrorResponseBody.d.mts +9 -0
  141. package/dist/esm/api/types/AssetsGetAssetReeferNotImplementedErrorResponseBody.mjs +2 -0
  142. package/dist/esm/api/types/AssetsGetAssetReeferResponseBody.d.mts +10 -0
  143. package/dist/esm/api/types/AssetsGetAssetReeferResponseBody.mjs +2 -0
  144. package/dist/esm/api/types/AssetsGetAssetReeferServiceUnavailableErrorResponseBody.d.mts +9 -0
  145. package/dist/esm/api/types/AssetsGetAssetReeferServiceUnavailableErrorResponseBody.mjs +2 -0
  146. package/dist/esm/api/types/AssetsGetAssetReeferTooManyRequestsErrorResponseBody.d.mts +9 -0
  147. package/dist/esm/api/types/AssetsGetAssetReeferTooManyRequestsErrorResponseBody.mjs +2 -0
  148. package/dist/esm/api/types/AssetsGetAssetReeferUnauthorizedErrorResponseBody.d.mts +9 -0
  149. package/dist/esm/api/types/AssetsGetAssetReeferUnauthorizedErrorResponseBody.mjs +2 -0
  150. package/dist/esm/api/types/PlaceBusinessContactResponseResponseBody.d.mts +11 -0
  151. package/dist/esm/api/types/PlaceBusinessContactResponseResponseBody.mjs +2 -0
  152. package/dist/esm/api/types/PlaceBusinessContactsResponseResponseBody.d.mts +12 -0
  153. package/dist/esm/api/types/PlaceBusinessContactsResponseResponseBody.mjs +2 -0
  154. package/dist/esm/api/types/PlaceGeofenceSuggestionCandidateResponseResponseBody.d.mts +26 -0
  155. package/dist/esm/api/types/PlaceGeofenceSuggestionCandidateResponseResponseBody.mjs +14 -0
  156. package/dist/esm/api/types/PlaceResponseObjectResponseBody.d.mts +1 -0
  157. package/dist/esm/api/types/PlacesGetPlaceGeofenceBadGatewayErrorResponseBody.d.mts +9 -0
  158. package/dist/esm/api/types/PlacesGetPlaceGeofenceBadGatewayErrorResponseBody.mjs +2 -0
  159. package/dist/esm/api/types/PlacesGetPlaceGeofenceGatewayTimeoutErrorResponseBody.d.mts +9 -0
  160. package/dist/esm/api/types/PlacesGetPlaceGeofenceGatewayTimeoutErrorResponseBody.mjs +2 -0
  161. package/dist/esm/api/types/PlacesGetPlaceGeofenceInternalServerErrorResponseBody.d.mts +9 -0
  162. package/dist/esm/api/types/PlacesGetPlaceGeofenceInternalServerErrorResponseBody.mjs +2 -0
  163. package/dist/esm/api/types/PlacesGetPlaceGeofenceMethodNotAllowedErrorResponseBody.d.mts +9 -0
  164. package/dist/esm/api/types/PlacesGetPlaceGeofenceMethodNotAllowedErrorResponseBody.mjs +2 -0
  165. package/dist/esm/api/types/PlacesGetPlaceGeofenceNotFoundErrorResponseBody.d.mts +9 -0
  166. package/dist/esm/api/types/PlacesGetPlaceGeofenceNotFoundErrorResponseBody.mjs +2 -0
  167. package/dist/esm/api/types/PlacesGetPlaceGeofenceNotImplementedErrorResponseBody.d.mts +9 -0
  168. package/dist/esm/api/types/PlacesGetPlaceGeofenceNotImplementedErrorResponseBody.mjs +2 -0
  169. package/dist/esm/api/types/PlacesGetPlaceGeofenceResponseBody.d.mts +7 -0
  170. package/dist/esm/api/types/PlacesGetPlaceGeofenceResponseBody.mjs +2 -0
  171. package/dist/esm/api/types/PlacesGetPlaceGeofenceServiceUnavailableErrorResponseBody.d.mts +9 -0
  172. package/dist/esm/api/types/PlacesGetPlaceGeofenceServiceUnavailableErrorResponseBody.mjs +2 -0
  173. package/dist/esm/api/types/PlacesGetPlaceGeofenceTooManyRequestsErrorResponseBody.d.mts +9 -0
  174. package/dist/esm/api/types/PlacesGetPlaceGeofenceTooManyRequestsErrorResponseBody.mjs +2 -0
  175. package/dist/esm/api/types/PlacesGetPlaceGeofenceUnauthorizedErrorResponseBody.d.mts +9 -0
  176. package/dist/esm/api/types/PlacesGetPlaceGeofenceUnauthorizedErrorResponseBody.mjs +2 -0
  177. package/dist/esm/api/types/PostPlaceBusinessContactInputRequestBody.d.mts +11 -0
  178. package/dist/esm/api/types/PostPlaceBusinessContactInputRequestBody.mjs +2 -0
  179. package/dist/esm/api/types/PostPlaceBusinessContactsInputRequestBody.d.mts +12 -0
  180. package/dist/esm/api/types/PostPlaceBusinessContactsInputRequestBody.mjs +2 -0
  181. package/dist/esm/api/types/index.d.mts +32 -0
  182. package/dist/esm/api/types/index.mjs +32 -0
  183. package/dist/esm/version.d.mts +1 -1
  184. package/dist/esm/version.mjs +1 -1
  185. package/package.json +1 -1
  186. package/reference.md +147 -1
@@ -44,8 +44,8 @@ function normalizeClientOptions(options) {
44
44
  const headers = (0, headers_js_1.mergeHeaders)({
45
45
  "X-Fern-Language": "JavaScript",
46
46
  "X-Fern-SDK-Name": "@samsarahq/samsara",
47
- "X-Fern-SDK-Version": "13.31.0",
48
- "User-Agent": "@samsarahq/samsara/13.31.0",
47
+ "X-Fern-SDK-Version": "13.33.0",
48
+ "User-Agent": "@samsarahq/samsara/13.33.0",
49
49
  "X-Fern-Runtime": core.RUNTIME.type,
50
50
  "X-Fern-Runtime-Version": core.RUNTIME.version,
51
51
  "X-Samsara-Version": (_a = options === null || options === void 0 ? void 0 : options.version) !== null && _a !== void 0 ? _a : "2025-06-11",
@@ -162,6 +162,38 @@ export declare class AssetsClient {
162
162
  */
163
163
  v1GetAssetsReefers(request: Samsara.V1GetAssetsReefersRequest, requestOptions?: AssetsClient.RequestOptions): core.HttpResponsePromise<Samsara.InlineResponse2003>;
164
164
  private __v1GetAssetsReefers;
165
+ /**
166
+ * Fetch the reefer-specific stats of an asset.
167
+ *
168
+ * <b>Rate limit:</b> 25 requests/sec (learn more about rate limits <a href="https://developers.samsara.com/docs/rate-limits" target="_blank">here</a>).
169
+ *
170
+ * To use this endpoint, select **Read Trailers** under the Trailers category when creating or editing an API token. <a href="https://developers.samsara.com/docs/authentication#scopes-for-api-tokens" target="_blank">Learn More.</a>
171
+ *
172
+ *
173
+ * **Submit Feedback**: Likes, dislikes, and API feature requests should be filed as feedback in our <a href="https://forms.gle/zkD4NCH7HjKb7mm69" target="_blank">API feedback form</a>. If you encountered an issue or noticed inaccuracies in the API documentation, please <a href="https://www.samsara.com/help" target="_blank">submit a case</a> to our support team.
174
+ *
175
+ * @param {Samsara.GetAssetReeferRequest} request
176
+ * @param {AssetsClient.RequestOptions} requestOptions - Request-specific configuration.
177
+ *
178
+ * @throws {@link Samsara.UnauthorizedError}
179
+ * @throws {@link Samsara.NotFoundError}
180
+ * @throws {@link Samsara.MethodNotAllowedError}
181
+ * @throws {@link Samsara.TooManyRequestsError}
182
+ * @throws {@link Samsara.InternalServerError}
183
+ * @throws {@link Samsara.NotImplementedError}
184
+ * @throws {@link Samsara.BadGatewayError}
185
+ * @throws {@link Samsara.ServiceUnavailableError}
186
+ * @throws {@link Samsara.GatewayTimeoutError}
187
+ *
188
+ * @example
189
+ * await client.assets.getAssetReefer({
190
+ * assetId: 1000000,
191
+ * startMs: 1000000,
192
+ * endMs: 1000000
193
+ * })
194
+ */
195
+ getAssetReefer(request: Samsara.GetAssetReeferRequest, requestOptions?: AssetsClient.RequestOptions): core.HttpResponsePromise<Samsara.AssetsGetAssetReeferResponseBody>;
196
+ private __getAssetReefer;
165
197
  /**
166
198
  * > 🚧 This endpoint is still on our legacy API.
167
199
  *
@@ -545,6 +545,97 @@ class AssetsClient {
545
545
  return (0, handleNonStatusCodeError_js_1.handleNonStatusCodeError)(_response.error, _response.rawResponse, "GET", "/v1/fleet/assets/reefers");
546
546
  });
547
547
  }
548
+ /**
549
+ * Fetch the reefer-specific stats of an asset.
550
+ *
551
+ * <b>Rate limit:</b> 25 requests/sec (learn more about rate limits <a href="https://developers.samsara.com/docs/rate-limits" target="_blank">here</a>).
552
+ *
553
+ * To use this endpoint, select **Read Trailers** under the Trailers category when creating or editing an API token. <a href="https://developers.samsara.com/docs/authentication#scopes-for-api-tokens" target="_blank">Learn More.</a>
554
+ *
555
+ *
556
+ * **Submit Feedback**: Likes, dislikes, and API feature requests should be filed as feedback in our <a href="https://forms.gle/zkD4NCH7HjKb7mm69" target="_blank">API feedback form</a>. If you encountered an issue or noticed inaccuracies in the API documentation, please <a href="https://www.samsara.com/help" target="_blank">submit a case</a> to our support team.
557
+ *
558
+ * @param {Samsara.GetAssetReeferRequest} request
559
+ * @param {AssetsClient.RequestOptions} requestOptions - Request-specific configuration.
560
+ *
561
+ * @throws {@link Samsara.UnauthorizedError}
562
+ * @throws {@link Samsara.NotFoundError}
563
+ * @throws {@link Samsara.MethodNotAllowedError}
564
+ * @throws {@link Samsara.TooManyRequestsError}
565
+ * @throws {@link Samsara.InternalServerError}
566
+ * @throws {@link Samsara.NotImplementedError}
567
+ * @throws {@link Samsara.BadGatewayError}
568
+ * @throws {@link Samsara.ServiceUnavailableError}
569
+ * @throws {@link Samsara.GatewayTimeoutError}
570
+ *
571
+ * @example
572
+ * await client.assets.getAssetReefer({
573
+ * assetId: 1000000,
574
+ * startMs: 1000000,
575
+ * endMs: 1000000
576
+ * })
577
+ */
578
+ getAssetReefer(request, requestOptions) {
579
+ return core.HttpResponsePromise.fromPromise(this.__getAssetReefer(request, requestOptions));
580
+ }
581
+ __getAssetReefer(request, requestOptions) {
582
+ return __awaiter(this, void 0, void 0, function* () {
583
+ var _a, _b, _c, _d, _e, _f, _g, _h, _j;
584
+ const { assetId, startMs, endMs } = request;
585
+ const _queryParams = {
586
+ startMs,
587
+ endMs,
588
+ };
589
+ const _authRequest = yield this._options.authProvider.getAuthRequest();
590
+ const _headers = (0, headers_js_1.mergeHeaders)(_authRequest.headers, (_a = this._options) === null || _a === void 0 ? void 0 : _a.headers, (0, headers_js_1.mergeOnlyDefinedHeaders)({ "X-Samsara-Version": requestOptions === null || requestOptions === void 0 ? void 0 : requestOptions.version }), requestOptions === null || requestOptions === void 0 ? void 0 : requestOptions.headers);
591
+ const _response = yield core.fetcher({
592
+ url: core.url.join((_c = (_b = (yield core.Supplier.get(this._options.baseUrl))) !== null && _b !== void 0 ? _b : (yield core.Supplier.get(this._options.environment))) !== null && _c !== void 0 ? _c : environments.SamsaraEnvironment.ProductionApi, `v1/fleet/assets/${core.url.encodePathParam(assetId)}/reefer`),
593
+ method: "GET",
594
+ headers: _headers,
595
+ queryParameters: Object.assign(Object.assign({}, _queryParams), requestOptions === null || requestOptions === void 0 ? void 0 : requestOptions.queryParams),
596
+ timeoutMs: ((_f = (_d = requestOptions === null || requestOptions === void 0 ? void 0 : requestOptions.timeoutInSeconds) !== null && _d !== void 0 ? _d : (_e = this._options) === null || _e === void 0 ? void 0 : _e.timeoutInSeconds) !== null && _f !== void 0 ? _f : 60) * 1000,
597
+ maxRetries: (_g = requestOptions === null || requestOptions === void 0 ? void 0 : requestOptions.maxRetries) !== null && _g !== void 0 ? _g : (_h = this._options) === null || _h === void 0 ? void 0 : _h.maxRetries,
598
+ abortSignal: requestOptions === null || requestOptions === void 0 ? void 0 : requestOptions.abortSignal,
599
+ fetchFn: (_j = this._options) === null || _j === void 0 ? void 0 : _j.fetch,
600
+ logging: this._options.logging,
601
+ });
602
+ if (_response.ok) {
603
+ return {
604
+ data: _response.body,
605
+ rawResponse: _response.rawResponse,
606
+ };
607
+ }
608
+ if (_response.error.reason === "status-code") {
609
+ switch (_response.error.statusCode) {
610
+ case 401:
611
+ throw new Samsara.UnauthorizedError(_response.error.body, _response.rawResponse);
612
+ case 404:
613
+ throw new Samsara.NotFoundError(_response.error.body, _response.rawResponse);
614
+ case 405:
615
+ throw new Samsara.MethodNotAllowedError(_response.error.body, _response.rawResponse);
616
+ case 429:
617
+ throw new Samsara.TooManyRequestsError(_response.error.body, _response.rawResponse);
618
+ case 500:
619
+ throw new Samsara.InternalServerError(_response.error.body, _response.rawResponse);
620
+ case 501:
621
+ throw new Samsara.NotImplementedError(_response.error.body, _response.rawResponse);
622
+ case 502:
623
+ throw new Samsara.BadGatewayError(_response.error.body, _response.rawResponse);
624
+ case 503:
625
+ throw new Samsara.ServiceUnavailableError(_response.error.body, _response.rawResponse);
626
+ case 504:
627
+ throw new Samsara.GatewayTimeoutError(_response.error.body, _response.rawResponse);
628
+ default:
629
+ throw new errors.SamsaraError({
630
+ statusCode: _response.error.statusCode,
631
+ body: _response.error.body,
632
+ rawResponse: _response.rawResponse,
633
+ });
634
+ }
635
+ }
636
+ return (0, handleNonStatusCodeError_js_1.handleNonStatusCodeError)(_response.error, _response.rawResponse, "GET", "/v1/fleet/assets/{assetId}/reefer");
637
+ });
638
+ }
548
639
  /**
549
640
  * > 🚧 This endpoint is still on our legacy API.
550
641
  *
@@ -0,0 +1,16 @@
1
+ /**
2
+ * @example
3
+ * {
4
+ * assetId: 1000000,
5
+ * startMs: 1000000,
6
+ * endMs: 1000000
7
+ * }
8
+ */
9
+ export interface GetAssetReeferRequest {
10
+ /** ID of the asset. Must contain only digits 0-9. */
11
+ assetId: number;
12
+ /** Timestamp in milliseconds representing the start of the period to fetch, inclusive. Used in combination with endMs. */
13
+ startMs: number;
14
+ /** Timestamp in milliseconds representing the end of the period to fetch, inclusive. Used in combination with startMs. */
15
+ endMs: number;
16
+ }
@@ -0,0 +1,3 @@
1
+ "use strict";
2
+ // This file was auto-generated by Fern from our API Definition.
3
+ Object.defineProperty(exports, "__esModule", { value: true });
@@ -1,6 +1,7 @@
1
1
  export { AssetsCreateAssetRequestBody } from "./AssetsCreateAssetRequestBody.js";
2
2
  export { AssetsUpdateAssetRequestBody } from "./AssetsUpdateAssetRequestBody.js";
3
3
  export type { DeleteAssetRequest } from "./DeleteAssetRequest.js";
4
+ export type { GetAssetReeferRequest } from "./GetAssetReeferRequest.js";
4
5
  export type { GetAssetsRequest } from "./GetAssetsRequest.js";
5
6
  export type { ListAssetsRequest } from "./ListAssetsRequest.js";
6
7
  export type { UpdateAssetsRequest } from "./UpdateAssetsRequest.js";
@@ -1678,6 +1678,37 @@ export declare class BetaApIsClient {
1678
1678
  */
1679
1679
  getPlaceGeocode(request: Samsara.GetPlaceGeocodeRequest, requestOptions?: BetaApIsClient.RequestOptions): core.HttpResponsePromise<Samsara.PlacesGetPlaceGeocodeResponseBody>;
1680
1680
  private __getPlaceGeocode;
1681
+ /**
1682
+ * Returns geofence suggestion candidates for a seed point. Does not create or update a Place. Applies the same selection rules as geofence.auto on Place write.
1683
+ *
1684
+ * <b>Rate limit:</b> 5 requests/sec (learn more about rate limits <a href="https://developers.samsara.com/docs/rate-limits" target="_blank">here</a>).
1685
+ *
1686
+ * To use this endpoint, select **Read Places** under the Places category when creating or editing an API token. <a href="https://developers.samsara.com/docs/authentication#scopes-for-api-tokens" target="_blank">Learn More.</a>
1687
+ *
1688
+ *
1689
+ * **Submit Feedback**: Likes, dislikes, and API feature requests should be filed as feedback in our <a href="https://forms.gle/zkD4NCH7HjKb7mm69" target="_blank">API feedback form</a>. If you encountered an issue or noticed inaccuracies in the API documentation, please <a href="https://www.samsara.com/help" target="_blank">submit a case</a> to our support team.
1690
+ *
1691
+ * @param {Samsara.GetPlaceGeofenceRequest} request
1692
+ * @param {BetaApIsClient.RequestOptions} requestOptions - Request-specific configuration.
1693
+ *
1694
+ * @throws {@link Samsara.UnauthorizedError}
1695
+ * @throws {@link Samsara.NotFoundError}
1696
+ * @throws {@link Samsara.MethodNotAllowedError}
1697
+ * @throws {@link Samsara.TooManyRequestsError}
1698
+ * @throws {@link Samsara.InternalServerError}
1699
+ * @throws {@link Samsara.NotImplementedError}
1700
+ * @throws {@link Samsara.BadGatewayError}
1701
+ * @throws {@link Samsara.ServiceUnavailableError}
1702
+ * @throws {@link Samsara.GatewayTimeoutError}
1703
+ *
1704
+ * @example
1705
+ * await client.betaApIs.getPlaceGeofence({
1706
+ * latitude: 1.1,
1707
+ * longitude: 1.1
1708
+ * })
1709
+ */
1710
+ getPlaceGeofence(request: Samsara.GetPlaceGeofenceRequest, requestOptions?: BetaApIsClient.RequestOptions): core.HttpResponsePromise<Samsara.PlacesGetPlaceGeofenceResponseBody>;
1711
+ private __getPlaceGeofence;
1681
1712
  /**
1682
1713
  * List all preferred fuel stations for your organization.
1683
1714
  *
@@ -4948,6 +4948,107 @@ class BetaApIsClient {
4948
4948
  return (0, handleNonStatusCodeError_js_1.handleNonStatusCodeError)(_response.error, _response.rawResponse, "GET", "/places/geocode");
4949
4949
  });
4950
4950
  }
4951
+ /**
4952
+ * Returns geofence suggestion candidates for a seed point. Does not create or update a Place. Applies the same selection rules as geofence.auto on Place write.
4953
+ *
4954
+ * <b>Rate limit:</b> 5 requests/sec (learn more about rate limits <a href="https://developers.samsara.com/docs/rate-limits" target="_blank">here</a>).
4955
+ *
4956
+ * To use this endpoint, select **Read Places** under the Places category when creating or editing an API token. <a href="https://developers.samsara.com/docs/authentication#scopes-for-api-tokens" target="_blank">Learn More.</a>
4957
+ *
4958
+ *
4959
+ * **Submit Feedback**: Likes, dislikes, and API feature requests should be filed as feedback in our <a href="https://forms.gle/zkD4NCH7HjKb7mm69" target="_blank">API feedback form</a>. If you encountered an issue or noticed inaccuracies in the API documentation, please <a href="https://www.samsara.com/help" target="_blank">submit a case</a> to our support team.
4960
+ *
4961
+ * @param {Samsara.GetPlaceGeofenceRequest} request
4962
+ * @param {BetaApIsClient.RequestOptions} requestOptions - Request-specific configuration.
4963
+ *
4964
+ * @throws {@link Samsara.UnauthorizedError}
4965
+ * @throws {@link Samsara.NotFoundError}
4966
+ * @throws {@link Samsara.MethodNotAllowedError}
4967
+ * @throws {@link Samsara.TooManyRequestsError}
4968
+ * @throws {@link Samsara.InternalServerError}
4969
+ * @throws {@link Samsara.NotImplementedError}
4970
+ * @throws {@link Samsara.BadGatewayError}
4971
+ * @throws {@link Samsara.ServiceUnavailableError}
4972
+ * @throws {@link Samsara.GatewayTimeoutError}
4973
+ *
4974
+ * @example
4975
+ * await client.betaApIs.getPlaceGeofence({
4976
+ * latitude: 1.1,
4977
+ * longitude: 1.1
4978
+ * })
4979
+ */
4980
+ getPlaceGeofence(request, requestOptions) {
4981
+ return core.HttpResponsePromise.fromPromise(this.__getPlaceGeofence(request, requestOptions));
4982
+ }
4983
+ __getPlaceGeofence(request, requestOptions) {
4984
+ return __awaiter(this, void 0, void 0, function* () {
4985
+ var _a, _b, _c, _d, _e, _f, _g, _h, _j;
4986
+ const { latitude, longitude, suggestionTypes, sizeOrder, minLatitude, minLongitude, maxLatitude, maxLongitude, maxAreaSquareMeters, maxSourceVertices, maxVertices, maxResults, after, } = request;
4987
+ const _queryParams = {
4988
+ latitude,
4989
+ longitude,
4990
+ suggestionTypes,
4991
+ sizeOrder: sizeOrder != null ? sizeOrder : undefined,
4992
+ minLatitude,
4993
+ minLongitude,
4994
+ maxLatitude,
4995
+ maxLongitude,
4996
+ maxAreaSquareMeters,
4997
+ maxSourceVertices,
4998
+ maxVertices,
4999
+ maxResults,
5000
+ after,
5001
+ };
5002
+ const _authRequest = yield this._options.authProvider.getAuthRequest();
5003
+ const _headers = (0, headers_js_1.mergeHeaders)(_authRequest.headers, (_a = this._options) === null || _a === void 0 ? void 0 : _a.headers, (0, headers_js_1.mergeOnlyDefinedHeaders)({ "X-Samsara-Version": requestOptions === null || requestOptions === void 0 ? void 0 : requestOptions.version }), requestOptions === null || requestOptions === void 0 ? void 0 : requestOptions.headers);
5004
+ const _response = yield core.fetcher({
5005
+ url: core.url.join((_c = (_b = (yield core.Supplier.get(this._options.baseUrl))) !== null && _b !== void 0 ? _b : (yield core.Supplier.get(this._options.environment))) !== null && _c !== void 0 ? _c : environments.SamsaraEnvironment.ProductionApi, "places/geofence"),
5006
+ method: "GET",
5007
+ headers: _headers,
5008
+ queryParameters: Object.assign(Object.assign({}, _queryParams), requestOptions === null || requestOptions === void 0 ? void 0 : requestOptions.queryParams),
5009
+ timeoutMs: ((_f = (_d = requestOptions === null || requestOptions === void 0 ? void 0 : requestOptions.timeoutInSeconds) !== null && _d !== void 0 ? _d : (_e = this._options) === null || _e === void 0 ? void 0 : _e.timeoutInSeconds) !== null && _f !== void 0 ? _f : 60) * 1000,
5010
+ maxRetries: (_g = requestOptions === null || requestOptions === void 0 ? void 0 : requestOptions.maxRetries) !== null && _g !== void 0 ? _g : (_h = this._options) === null || _h === void 0 ? void 0 : _h.maxRetries,
5011
+ abortSignal: requestOptions === null || requestOptions === void 0 ? void 0 : requestOptions.abortSignal,
5012
+ fetchFn: (_j = this._options) === null || _j === void 0 ? void 0 : _j.fetch,
5013
+ logging: this._options.logging,
5014
+ });
5015
+ if (_response.ok) {
5016
+ return {
5017
+ data: _response.body,
5018
+ rawResponse: _response.rawResponse,
5019
+ };
5020
+ }
5021
+ if (_response.error.reason === "status-code") {
5022
+ switch (_response.error.statusCode) {
5023
+ case 401:
5024
+ throw new Samsara.UnauthorizedError(_response.error.body, _response.rawResponse);
5025
+ case 404:
5026
+ throw new Samsara.NotFoundError(_response.error.body, _response.rawResponse);
5027
+ case 405:
5028
+ throw new Samsara.MethodNotAllowedError(_response.error.body, _response.rawResponse);
5029
+ case 429:
5030
+ throw new Samsara.TooManyRequestsError(_response.error.body, _response.rawResponse);
5031
+ case 500:
5032
+ throw new Samsara.InternalServerError(_response.error.body, _response.rawResponse);
5033
+ case 501:
5034
+ throw new Samsara.NotImplementedError(_response.error.body, _response.rawResponse);
5035
+ case 502:
5036
+ throw new Samsara.BadGatewayError(_response.error.body, _response.rawResponse);
5037
+ case 503:
5038
+ throw new Samsara.ServiceUnavailableError(_response.error.body, _response.rawResponse);
5039
+ case 504:
5040
+ throw new Samsara.GatewayTimeoutError(_response.error.body, _response.rawResponse);
5041
+ default:
5042
+ throw new errors.SamsaraError({
5043
+ statusCode: _response.error.statusCode,
5044
+ body: _response.error.body,
5045
+ rawResponse: _response.rawResponse,
5046
+ });
5047
+ }
5048
+ }
5049
+ return (0, handleNonStatusCodeError_js_1.handleNonStatusCodeError)(_response.error, _response.rawResponse, "GET", "/places/geofence");
5050
+ });
5051
+ }
4951
5052
  /**
4952
5053
  * List all preferred fuel stations for your organization.
4953
5054
  *
@@ -0,0 +1,36 @@
1
+ import type * as Samsara from "../../../../index.js";
2
+ /**
3
+ * @example
4
+ * {
5
+ * latitude: 1.1,
6
+ * longitude: 1.1
7
+ * }
8
+ */
9
+ export interface GetPlaceGeofenceRequest {
10
+ /** Seed point latitude in WGS84 decimal degrees. */
11
+ latitude: number;
12
+ /** Seed point longitude in WGS84 decimal degrees. */
13
+ longitude: number;
14
+ /** Comma-separated geofence suggestion types in priority order. Values: building, parcel, landUse, boundary, facility, infrastructure. */
15
+ suggestionTypes?: string;
16
+ /** Candidate sort order: smallestFirst (default) or largestFirst. Valid values: `smallestFirst`, `largestFirst` */
17
+ sizeOrder?: Samsara.GetPlaceGeofenceRequestSizeOrder;
18
+ /** Search bound minimum latitude (WGS84 decimal degrees). Must be supplied with minLongitude, maxLatitude, and maxLongitude, or omitted entirely. */
19
+ minLatitude?: number;
20
+ /** Search bound minimum longitude (WGS84 decimal degrees). */
21
+ minLongitude?: number;
22
+ /** Search bound maximum latitude (WGS84 decimal degrees). */
23
+ maxLatitude?: number;
24
+ /** Search bound maximum longitude (WGS84 decimal degrees). */
25
+ maxLongitude?: number;
26
+ /** Drop candidates with area above this value in square meters. */
27
+ maxAreaSquareMeters?: number;
28
+ /** Drop candidates whose source polygon exceeds this vertex count before simplification. */
29
+ maxSourceVertices?: number;
30
+ /** Simplify each returned candidate polygon to at most this many vertices. */
31
+ maxVertices?: number;
32
+ /** Page size: max candidates in data[] per page. Default 5, max 20. */
33
+ maxResults?: number;
34
+ /** If specified, this should be the endCursor value from the previous page of results. When present, this request will return the next page of results that occur immediately after the previous page of results. */
35
+ after?: string;
36
+ }
@@ -0,0 +1,3 @@
1
+ "use strict";
2
+ // This file was auto-generated by Fern from our API Definition.
3
+ Object.defineProperty(exports, "__esModule", { value: true });
@@ -10,6 +10,7 @@ export interface PlacesPatchPlaceRequestBody {
10
10
  externalId?: string;
11
11
  /** Single-line address string. */
12
12
  address?: string;
13
+ businessContacts?: Samsara.PostPlaceBusinessContactsInputRequestBody;
13
14
  /** Camera recording mode: fullRecording, driverPrivacy, completePrivacy, or inherit. Valid values: `fullRecording`, `driverPrivacy`, `completePrivacy`, `inherit`, `unknown`, `unspecified` */
14
15
  cameraRecordingModeType?: PlacesPatchPlaceRequestBody.CameraRecordingModeType;
15
16
  /** When present, replaces external ids for the place. */
@@ -10,6 +10,7 @@ import type * as Samsara from "../../../../index.js";
10
10
  export interface PlacesPostPlaceRequestBody {
11
11
  /** Single-line address string. */
12
12
  address: string;
13
+ businessContacts?: Samsara.PostPlaceBusinessContactsInputRequestBody;
13
14
  /** Camera recording mode: fullRecording, driverPrivacy, completePrivacy, or inherit. Valid values: `fullRecording`, `driverPrivacy`, `completePrivacy`, `inherit`, `unknown`, `unspecified` */
14
15
  cameraRecordingModeType?: PlacesPostPlaceRequestBody.CameraRecordingModeType;
15
16
  /** External identifiers. */
@@ -34,6 +34,7 @@ export type { GetHosEldEventsRequest } from "./GetHosEldEventsRequest.js";
34
34
  export type { GetJobsRequest } from "./GetJobsRequest.js";
35
35
  export type { GetPlaceDeletionsRequest } from "./GetPlaceDeletionsRequest.js";
36
36
  export type { GetPlaceGeocodeRequest } from "./GetPlaceGeocodeRequest.js";
37
+ export type { GetPlaceGeofenceRequest } from "./GetPlaceGeofenceRequest.js";
37
38
  export type { GetPlacesRequest } from "./GetPlacesRequest.js";
38
39
  export type { GetPreferredStationRequest } from "./GetPreferredStationRequest.js";
39
40
  export type { GetQualificationRecordsRequest } from "./GetQualificationRecordsRequest.js";
@@ -0,0 +1,5 @@
1
+ export declare const GetPlaceGeofenceRequestSizeOrder: {
2
+ readonly SmallestFirst: "smallestFirst";
3
+ readonly LargestFirst: "largestFirst";
4
+ };
5
+ export type GetPlaceGeofenceRequestSizeOrder = (typeof GetPlaceGeofenceRequestSizeOrder)[keyof typeof GetPlaceGeofenceRequestSizeOrder];
@@ -0,0 +1,8 @@
1
+ "use strict";
2
+ // This file was auto-generated by Fern from our API Definition.
3
+ Object.defineProperty(exports, "__esModule", { value: true });
4
+ exports.GetPlaceGeofenceRequestSizeOrder = void 0;
5
+ exports.GetPlaceGeofenceRequestSizeOrder = {
6
+ SmallestFirst: "smallestFirst",
7
+ LargestFirst: "largestFirst",
8
+ };
@@ -2,6 +2,7 @@ export * from "./GetAssetsInputsRequestType.js";
2
2
  export * from "./GetDriverEfficiencyRequestDriverActivationStatus.js";
3
3
  export * from "./GetHosEldEventsRequestDriverActivationStatus.js";
4
4
  export * from "./GetJobsRequestStatus.js";
5
+ export * from "./GetPlaceGeofenceRequestSizeOrder.js";
5
6
  export * from "./GetQualificationRecordsStreamRequestEntityType.js";
6
7
  export * from "./GetQualificationTypesRequestEntityType.js";
7
8
  export * from "./ListDriverWorkflowsRequestWorkflowType.js";
@@ -18,6 +18,7 @@ __exportStar(require("./GetAssetsInputsRequestType.js"), exports);
18
18
  __exportStar(require("./GetDriverEfficiencyRequestDriverActivationStatus.js"), exports);
19
19
  __exportStar(require("./GetHosEldEventsRequestDriverActivationStatus.js"), exports);
20
20
  __exportStar(require("./GetJobsRequestStatus.js"), exports);
21
+ __exportStar(require("./GetPlaceGeofenceRequestSizeOrder.js"), exports);
21
22
  __exportStar(require("./GetQualificationRecordsStreamRequestEntityType.js"), exports);
22
23
  __exportStar(require("./GetQualificationTypesRequestEntityType.js"), exports);
23
24
  __exportStar(require("./ListDriverWorkflowsRequestWorkflowType.js"), exports);
@@ -98,7 +98,6 @@ export declare class MediaClient {
98
98
  * @example
99
99
  * await client.media.postMediaRetrieval({
100
100
  * endTime: "2019-06-13T19:08:55Z",
101
- * inputs: ["dashcamRoadFacing", "dashcamRoadFacing", "dashcamRoadFacing", "dashcamRoadFacing"],
102
101
  * mediaType: "image",
103
102
  * startTime: "2019-06-13T19:08:25Z",
104
103
  * vehicleId: "1234"
@@ -274,7 +274,6 @@ class MediaClient {
274
274
  * @example
275
275
  * await client.media.postMediaRetrieval({
276
276
  * endTime: "2019-06-13T19:08:55Z",
277
- * inputs: ["dashcamRoadFacing", "dashcamRoadFacing", "dashcamRoadFacing", "dashcamRoadFacing"],
278
277
  * mediaType: "image",
279
278
  * startTime: "2019-06-13T19:08:25Z",
280
279
  * vehicleId: "1234"
@@ -2,17 +2,18 @@
2
2
  * @example
3
3
  * {
4
4
  * endTime: "2019-06-13T19:08:55Z",
5
- * inputs: ["dashcamRoadFacing", "dashcamRoadFacing", "dashcamRoadFacing", "dashcamRoadFacing"],
6
5
  * mediaType: "image",
7
6
  * startTime: "2019-06-13T19:08:25Z",
8
7
  * vehicleId: "1234"
9
8
  * }
10
9
  */
11
10
  export interface MediaRetrievalPostMediaRetrievalRequestBody {
11
+ /** Optional list of camera roles to resolve to analog inputs at request time. Requires an AHD4 auxcam device. Can be used alone or combined with inputs. */
12
+ cameraRoles?: MediaRetrievalPostMediaRetrievalRequestBody.CameraRoles.Item[];
12
13
  /** An end time in RFC 3339 format. If endTime is the same as startTime, an image will be captured at startTime. Must be 1 second or more after startTime and no more than the maximum allowed duration per video retrieval type. Please refer to our KB articles for more information. (Examples: 2019-06-13T19:08:55Z, 2019-06-13T19:08:55.455Z, OR 2015-09-15T14:00:42-04:00). */
13
14
  endTime: string;
14
- /** A list of desired camera inputs for which to capture media. Only media with valid inputs (e.g. device has that input stream and device was recording at the time) will be uploaded. An empty list is invalid. */
15
- inputs: MediaRetrievalPostMediaRetrievalRequestBody.Inputs.Item[];
15
+ /** A list of desired camera inputs for which to capture media. Only media with valid inputs (e.g. device has that input stream and device was recording at the time) will be uploaded. At least one of inputs or cameraRoles must be provided. */
16
+ inputs?: MediaRetrievalPostMediaRetrievalRequestBody.Inputs.Item[];
16
17
  /** The desired media type. If a video is requested, endTime must be after startTime. If an image is requested, endTime must be the same as startTime. Must be one of: image, videoHighRes, videoLowRes. Examples: image, videoHighRes, videoLowRes, hyperlapse. Valid values: `image`, `videoHighRes`, `videoLowRes`, `hyperlapse` */
17
18
  mediaType: MediaRetrievalPostMediaRetrievalRequestBody.MediaType;
18
19
  /** A start time in RFC 3339 format. Millisecond precision and timezones are supported. (Examples: 2019-06-13T19:08:25Z, 2019-06-13T19:08:25.455Z, OR 2015-09-15T14:00:12-04:00). */
@@ -21,6 +22,32 @@ export interface MediaRetrievalPostMediaRetrievalRequestBody {
21
22
  vehicleId: string;
22
23
  }
23
24
  export declare namespace MediaRetrievalPostMediaRetrievalRequestBody {
25
+ type CameraRoles = CameraRoles.Item[];
26
+ namespace CameraRoles {
27
+ /** camera role Valid values: `leftMirrorMount`, `leftSide`, `rightMirrorMount`, `rightSide`, `rearHigh`, `rearBumper`, `inCab`, `front`, `hopper`, `other1`, `other2`, `other3`, `other4`, `leftBev`, `rightBev`, `rearBev`, `frontBev`, `otherBev`, `bevNotUsed` */
28
+ const Item: {
29
+ readonly LeftMirrorMount: "leftMirrorMount";
30
+ readonly LeftSide: "leftSide";
31
+ readonly RightMirrorMount: "rightMirrorMount";
32
+ readonly RightSide: "rightSide";
33
+ readonly RearHigh: "rearHigh";
34
+ readonly RearBumper: "rearBumper";
35
+ readonly InCab: "inCab";
36
+ readonly Front: "front";
37
+ readonly Hopper: "hopper";
38
+ readonly Other1: "other1";
39
+ readonly Other2: "other2";
40
+ readonly Other3: "other3";
41
+ readonly Other4: "other4";
42
+ readonly LeftBev: "leftBev";
43
+ readonly RightBev: "rightBev";
44
+ readonly RearBev: "rearBev";
45
+ readonly FrontBev: "frontBev";
46
+ readonly OtherBev: "otherBev";
47
+ readonly BevNotUsed: "bevNotUsed";
48
+ };
49
+ type Item = (typeof Item)[keyof typeof Item];
50
+ }
24
51
  type Inputs = Inputs.Item[];
25
52
  namespace Inputs {
26
53
  /** input Valid values: `dashcamRoadFacing`, `dashcamDriverFacing`, `analog1`, `analog2`, `analog3`, `analog4` */
@@ -4,6 +4,31 @@ Object.defineProperty(exports, "__esModule", { value: true });
4
4
  exports.MediaRetrievalPostMediaRetrievalRequestBody = void 0;
5
5
  var MediaRetrievalPostMediaRetrievalRequestBody;
6
6
  (function (MediaRetrievalPostMediaRetrievalRequestBody) {
7
+ let CameraRoles;
8
+ (function (CameraRoles) {
9
+ /** camera role Valid values: `leftMirrorMount`, `leftSide`, `rightMirrorMount`, `rightSide`, `rearHigh`, `rearBumper`, `inCab`, `front`, `hopper`, `other1`, `other2`, `other3`, `other4`, `leftBev`, `rightBev`, `rearBev`, `frontBev`, `otherBev`, `bevNotUsed` */
10
+ CameraRoles.Item = {
11
+ LeftMirrorMount: "leftMirrorMount",
12
+ LeftSide: "leftSide",
13
+ RightMirrorMount: "rightMirrorMount",
14
+ RightSide: "rightSide",
15
+ RearHigh: "rearHigh",
16
+ RearBumper: "rearBumper",
17
+ InCab: "inCab",
18
+ Front: "front",
19
+ Hopper: "hopper",
20
+ Other1: "other1",
21
+ Other2: "other2",
22
+ Other3: "other3",
23
+ Other4: "other4",
24
+ LeftBev: "leftBev",
25
+ RightBev: "rightBev",
26
+ RearBev: "rearBev",
27
+ FrontBev: "frontBev",
28
+ OtherBev: "otherBev",
29
+ BevNotUsed: "bevNotUsed",
30
+ };
31
+ })(CameraRoles = MediaRetrievalPostMediaRetrievalRequestBody.CameraRoles || (MediaRetrievalPostMediaRetrievalRequestBody.CameraRoles = {}));
7
32
  let Inputs;
8
33
  (function (Inputs) {
9
34
  /** input Valid values: `dashcamRoadFacing`, `dashcamDriverFacing`, `analog1`, `analog2`, `analog3`, `analog4` */
@@ -184,9 +184,13 @@ export interface GetReadingsHistoryRequest {
184
184
  * <summary><strong>reefer</strong></summary>
185
185
  *
186
186
  * * `reeferAlarm` (Reefer Alarms): Array of active alarm codes for the refrigeration unit with metadata
187
+ * * `reeferAlarmActive` (TouchPrint Alarm Active): TouchPrint ALM digital output (input configured as Switch). On-device gating ensures this only reports on alarm-configured inputs; see reeferAlarm for OEM alarm codes and reeferAlarmSeverity for severity. (values: inactive | active)
187
188
  * * `reeferAlarmSeverity` (Reefer Alarm Severity): Highest severity level across active reefer alarms (green, yellow, red, orange) (values: none | green | yellow | red | orange)
188
189
  * * `reeferAmbientAir` (Reefer Ambient Air Temperature): External environment temperature for the reefer (celsius)
189
190
  * * `reeferBatteryVoltage` (Reefer Battery Voltage): The voltage of the Refrigeration Unit's battery. (volt)
191
+ * * `reeferDefrostZone1` (Reefer Defrost (Zone 1)): Whether the reefer defrost cycle is active in zone 1 (sustained state). On-device gating ensures this only reports on defrost-configured inputs. (values: off | on)
192
+ * * `reeferDefrostZone2` (Reefer Defrost (Zone 2)): Whether the reefer defrost cycle is active in zone 2 (sustained state). On-device gating ensures this only reports on defrost-configured inputs. (values: off | on)
193
+ * * `reeferDefrostZone3` (Reefer Defrost (Zone 3)): Whether the reefer defrost cycle is active in zone 3 (sustained state). On-device gating ensures this only reports on defrost-configured inputs. (values: off | on)
190
194
  * * `reeferDoorOpenZone1` (Reefer Door Open (Zone 1)): Status indicating whether the reefer's door (zone 1) is closed or open (values: closed | open)
191
195
  * * `reeferDoorOpenZone2` (Reefer Door Open (Zone 2)): Status indicating whether the reefer's door (zone 2) is closed or open (values: closed | open)
192
196
  * * `reeferDoorOpenZone3` (Reefer Door Open (Zone 3)): Status indicating whether the reefer's door (zone 3) is closed or open (values: closed | open)
@@ -184,9 +184,13 @@ export interface GetReadingsSnapshotRequest {
184
184
  * <summary><strong>reefer</strong></summary>
185
185
  *
186
186
  * * `reeferAlarm` (Reefer Alarms): Array of active alarm codes for the refrigeration unit with metadata
187
+ * * `reeferAlarmActive` (TouchPrint Alarm Active): TouchPrint ALM digital output (input configured as Switch). On-device gating ensures this only reports on alarm-configured inputs; see reeferAlarm for OEM alarm codes and reeferAlarmSeverity for severity. (values: inactive | active)
187
188
  * * `reeferAlarmSeverity` (Reefer Alarm Severity): Highest severity level across active reefer alarms (green, yellow, red, orange) (values: none | green | yellow | red | orange)
188
189
  * * `reeferAmbientAir` (Reefer Ambient Air Temperature): External environment temperature for the reefer (celsius)
189
190
  * * `reeferBatteryVoltage` (Reefer Battery Voltage): The voltage of the Refrigeration Unit's battery. (volt)
191
+ * * `reeferDefrostZone1` (Reefer Defrost (Zone 1)): Whether the reefer defrost cycle is active in zone 1 (sustained state). On-device gating ensures this only reports on defrost-configured inputs. (values: off | on)
192
+ * * `reeferDefrostZone2` (Reefer Defrost (Zone 2)): Whether the reefer defrost cycle is active in zone 2 (sustained state). On-device gating ensures this only reports on defrost-configured inputs. (values: off | on)
193
+ * * `reeferDefrostZone3` (Reefer Defrost (Zone 3)): Whether the reefer defrost cycle is active in zone 3 (sustained state). On-device gating ensures this only reports on defrost-configured inputs. (values: off | on)
190
194
  * * `reeferDoorOpenZone1` (Reefer Door Open (Zone 1)): Status indicating whether the reefer's door (zone 1) is closed or open (values: closed | open)
191
195
  * * `reeferDoorOpenZone2` (Reefer Door Open (Zone 2)): Status indicating whether the reefer's door (zone 2) is closed or open (values: closed | open)
192
196
  * * `reeferDoorOpenZone3` (Reefer Door Open (Zone 3)): Status indicating whether the reefer's door (zone 3) is closed or open (values: closed | open)
@@ -0,0 +1,10 @@
1
+ export interface AssetReeferAlarmObjectResponseBody {
2
+ /** ID of the alarm */
3
+ alarmCode?: number | undefined;
4
+ /** Description of the alarm */
5
+ description?: string | undefined;
6
+ /** Recommended operator action */
7
+ operatorAction?: string | undefined;
8
+ /** Severity of the alarm: 1: OK to run, 2: Check as specified, 3: Take immediate action */
9
+ severity?: number | undefined;
10
+ }
@@ -0,0 +1,3 @@
1
+ "use strict";
2
+ // This file was auto-generated by Fern from our API Definition.
3
+ Object.defineProperty(exports, "__esModule", { value: true });
@@ -0,0 +1,7 @@
1
+ import type * as Samsara from "../index.js";
2
+ export interface AssetReeferAlarmsStatObjectResponseBody {
3
+ /** All alarms that were reported at the time. */
4
+ alarms?: Samsara.AssetReeferAlarmObjectResponseBody[] | undefined;
5
+ /** Timestamp when the alarms were reported, in Unix milliseconds since epoch */
6
+ changedAtMs?: number | undefined;
7
+ }
@@ -0,0 +1,3 @@
1
+ "use strict";
2
+ // This file was auto-generated by Fern from our API Definition.
3
+ Object.defineProperty(exports, "__esModule", { value: true });
@@ -0,0 +1,6 @@
1
+ export interface AssetReeferEngineHoursStatObjectResponseBody {
2
+ /** Timestamp in Unix milliseconds since epoch. */
3
+ changedAtMs?: number | undefined;
4
+ /** Engine hours of the reefer. */
5
+ engineHours?: number | undefined;
6
+ }
@@ -0,0 +1,3 @@
1
+ "use strict";
2
+ // This file was auto-generated by Fern from our API Definition.
3
+ Object.defineProperty(exports, "__esModule", { value: true });
@@ -0,0 +1,6 @@
1
+ export interface AssetReeferFuelPercentageStatObjectResponseBody {
2
+ /** Timestamp in Unix milliseconds since epoch. */
3
+ changedAtMs?: number | undefined;
4
+ /** Fuel percentage of the reefer. */
5
+ fuelPercentage?: number | undefined;
6
+ }