@samsarahq/samsara 13.7.0 → 13.8.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/dist/cjs/BaseClient.js +2 -2
- package/dist/cjs/api/resources/betaApIs/client/Client.d.ts +27 -1
- package/dist/cjs/api/resources/betaApIs/client/Client.js +27 -1
- package/dist/cjs/api/resources/betaApIs/client/requests/PlacesPatchPlaceRequestBody.d.ts +2 -0
- package/dist/cjs/api/resources/betaApIs/client/requests/PlacesPostPlaceRequestBody.d.ts +2 -0
- package/dist/cjs/api/types/PatchPlaceHubLocationUpsertBodyRequestBody.d.ts +4 -0
- package/dist/cjs/api/types/PlaceHubLocationCapacityServiceTimeInputRequestBody.d.ts +11 -0
- package/dist/cjs/api/types/PlaceHubLocationCapacityServiceTimeInputRequestBody.js +3 -0
- package/dist/cjs/api/types/PlaceHubLocationOrderServiceTimeInputRequestBody.d.ts +22 -0
- package/dist/cjs/api/types/PlaceHubLocationOrderServiceTimeInputRequestBody.js +14 -0
- package/dist/cjs/api/types/PlaceHubLocationServiceTimeInputRequestBody.d.ts +9 -0
- package/dist/cjs/api/types/PlaceHubLocationServiceTimeInputRequestBody.js +3 -0
- package/dist/cjs/api/types/index.d.ts +3 -0
- package/dist/cjs/api/types/index.js +3 -0
- package/dist/cjs/version.d.ts +1 -1
- package/dist/cjs/version.js +1 -1
- package/dist/esm/BaseClient.mjs +2 -2
- package/dist/esm/api/resources/betaApIs/client/Client.d.mts +27 -1
- package/dist/esm/api/resources/betaApIs/client/Client.mjs +27 -1
- package/dist/esm/api/resources/betaApIs/client/requests/PlacesPatchPlaceRequestBody.d.mts +2 -0
- package/dist/esm/api/resources/betaApIs/client/requests/PlacesPostPlaceRequestBody.d.mts +2 -0
- package/dist/esm/api/types/PatchPlaceHubLocationUpsertBodyRequestBody.d.mts +4 -0
- package/dist/esm/api/types/PlaceHubLocationCapacityServiceTimeInputRequestBody.d.mts +11 -0
- package/dist/esm/api/types/PlaceHubLocationCapacityServiceTimeInputRequestBody.mjs +2 -0
- package/dist/esm/api/types/PlaceHubLocationOrderServiceTimeInputRequestBody.d.mts +22 -0
- package/dist/esm/api/types/PlaceHubLocationOrderServiceTimeInputRequestBody.mjs +11 -0
- package/dist/esm/api/types/PlaceHubLocationServiceTimeInputRequestBody.d.mts +9 -0
- package/dist/esm/api/types/PlaceHubLocationServiceTimeInputRequestBody.mjs +2 -0
- package/dist/esm/api/types/index.d.mts +3 -0
- package/dist/esm/api/types/index.mjs +3 -0
- package/dist/esm/version.d.mts +1 -1
- package/dist/esm/version.mjs +1 -1
- package/package.json +1 -1
- package/reference.md +27 -1
package/dist/cjs/BaseClient.js
CHANGED
|
@@ -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.
|
|
48
|
-
"User-Agent": "@samsarahq/samsara/13.
|
|
47
|
+
"X-Fern-SDK-Version": "13.8.0",
|
|
48
|
+
"User-Agent": "@samsarahq/samsara/13.8.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",
|
|
@@ -1772,7 +1772,33 @@ export declare class BetaApIsClient {
|
|
|
1772
1772
|
/**
|
|
1773
1773
|
* Ingest new readings. This endpoint allows the ingestion of batches of readings.
|
|
1774
1774
|
*
|
|
1775
|
-
* Ingesting readings is only supported for assets created using the POST /assets API endpoint with readingsIngestionEnabled set to true. To see a full list of readings available for ingestion use the GET readings definitions API.
|
|
1775
|
+
* Ingesting readings is only supported for assets created using the POST /assets API endpoint with readingsIngestionEnabled set to true. To see a full list of readings available for ingestion use the GET readings definitions API.
|
|
1776
|
+
*
|
|
1777
|
+
*
|
|
1778
|
+
* Readings that currently support ingestion (by category):
|
|
1779
|
+
*
|
|
1780
|
+
*
|
|
1781
|
+
* <details>
|
|
1782
|
+
* <summary><strong>ingestible</strong></summary>
|
|
1783
|
+
*
|
|
1784
|
+
* * `batteryVoltage`
|
|
1785
|
+
* * `coolantTemp`
|
|
1786
|
+
* * `ecuFuelLevelMillipercent`
|
|
1787
|
+
* * `engineHours`
|
|
1788
|
+
* * `engineRpm`
|
|
1789
|
+
* * `engineState` (values: off | running | idling)
|
|
1790
|
+
* * `faultCodesJ1939`
|
|
1791
|
+
* * `faultCodesOBDII`
|
|
1792
|
+
* * `fuelLevelPerc`
|
|
1793
|
+
* * `location`
|
|
1794
|
+
* * `odometerEcu`
|
|
1795
|
+
* * `oilPressure`
|
|
1796
|
+
*
|
|
1797
|
+
* </details>
|
|
1798
|
+
*
|
|
1799
|
+
* **Note:** Use the `GET /readings/definitions` endpoint and check the `ingestionEnabled` field for the authoritative, up-to-date set of ingestible readings for your organization.
|
|
1800
|
+
*
|
|
1801
|
+
* When ingesting location data, the readingID 'location' must be used and the value object must contain at least the following fields: 'speed', 'latitude', 'longitude'.
|
|
1776
1802
|
*
|
|
1777
1803
|
* Related guide: [Readings](https://developers.samsara.com/docs/readings).
|
|
1778
1804
|
*
|
|
@@ -5200,7 +5200,33 @@ class BetaApIsClient {
|
|
|
5200
5200
|
/**
|
|
5201
5201
|
* Ingest new readings. This endpoint allows the ingestion of batches of readings.
|
|
5202
5202
|
*
|
|
5203
|
-
* Ingesting readings is only supported for assets created using the POST /assets API endpoint with readingsIngestionEnabled set to true. To see a full list of readings available for ingestion use the GET readings definitions API.
|
|
5203
|
+
* Ingesting readings is only supported for assets created using the POST /assets API endpoint with readingsIngestionEnabled set to true. To see a full list of readings available for ingestion use the GET readings definitions API.
|
|
5204
|
+
*
|
|
5205
|
+
*
|
|
5206
|
+
* Readings that currently support ingestion (by category):
|
|
5207
|
+
*
|
|
5208
|
+
*
|
|
5209
|
+
* <details>
|
|
5210
|
+
* <summary><strong>ingestible</strong></summary>
|
|
5211
|
+
*
|
|
5212
|
+
* * `batteryVoltage`
|
|
5213
|
+
* * `coolantTemp`
|
|
5214
|
+
* * `ecuFuelLevelMillipercent`
|
|
5215
|
+
* * `engineHours`
|
|
5216
|
+
* * `engineRpm`
|
|
5217
|
+
* * `engineState` (values: off | running | idling)
|
|
5218
|
+
* * `faultCodesJ1939`
|
|
5219
|
+
* * `faultCodesOBDII`
|
|
5220
|
+
* * `fuelLevelPerc`
|
|
5221
|
+
* * `location`
|
|
5222
|
+
* * `odometerEcu`
|
|
5223
|
+
* * `oilPressure`
|
|
5224
|
+
*
|
|
5225
|
+
* </details>
|
|
5226
|
+
*
|
|
5227
|
+
* **Note:** Use the `GET /readings/definitions` endpoint and check the `ingestionEnabled` field for the authoritative, up-to-date set of ingestible readings for your organization.
|
|
5228
|
+
*
|
|
5229
|
+
* When ingesting location data, the readingID 'location' must be used and the value object must contain at least the following fields: 'speed', 'latitude', 'longitude'.
|
|
5204
5230
|
*
|
|
5205
5231
|
* Related guide: [Readings](https://developers.samsara.com/docs/readings).
|
|
5206
5232
|
*
|
|
@@ -19,6 +19,8 @@ export interface PlacesPatchPlaceRequestBody {
|
|
|
19
19
|
hubLocations?: Samsara.PatchPlaceHubLocationsBodyRequestBody;
|
|
20
20
|
/** When present, replaces IFTA exemption types for the place. */
|
|
21
21
|
iftaExemptionTypes?: string[];
|
|
22
|
+
/** When true, show addresses inside the geofence on the map. */
|
|
23
|
+
isShowAddressesEnabled?: boolean;
|
|
22
24
|
/** Center latitude when switching to or editing a circle geofence. */
|
|
23
25
|
latitude?: number;
|
|
24
26
|
/** Center longitude when switching to or editing a circle geofence. */
|
|
@@ -19,6 +19,8 @@ export interface PlacesPostPlaceRequestBody {
|
|
|
19
19
|
hubLocations?: Samsara.PatchPlaceHubLocationUpsertBodyRequestBody[];
|
|
20
20
|
/** IFTA exemption types for this place. */
|
|
21
21
|
iftaExemptionTypes?: string[];
|
|
22
|
+
/** When true, show addresses inside the geofence on the map. */
|
|
23
|
+
isShowAddressesEnabled?: boolean;
|
|
22
24
|
/** Center latitude when using a circle geofence with radiusMeters. */
|
|
23
25
|
latitude?: number;
|
|
24
26
|
/** Center longitude when using a circle geofence with radiusMeters. */
|
|
@@ -17,8 +17,12 @@ export interface PatchPlaceHubLocationUpsertBodyRequestBody {
|
|
|
17
17
|
isIgnoreOrderServiceTimeEnabled?: boolean | undefined;
|
|
18
18
|
/** Stop position preference: unspecified, any, first, or last. */
|
|
19
19
|
locationPositionType?: string | undefined;
|
|
20
|
+
/** Route priority from 1 (lowest) to 5 (highest). */
|
|
21
|
+
locationPriority?: number | undefined;
|
|
22
|
+
orderServiceTime?: Samsara.PlaceHubLocationOrderServiceTimeInputRequestBody | undefined;
|
|
20
23
|
/** Required planner skills for this hub location. */
|
|
21
24
|
requiredSkills?: Samsara.PlaceHubLocationRequiredSkillInputRequestBody[] | undefined;
|
|
25
|
+
serviceTime?: Samsara.PlaceHubLocationServiceTimeInputRequestBody | undefined;
|
|
22
26
|
/** Recurring local-time service windows for this hub location. */
|
|
23
27
|
serviceWindows?: Samsara.PlaceHubLocationServiceWindowInputRequestBody[] | undefined;
|
|
24
28
|
/** Default instructions for drivers at this hub location. */
|
|
@@ -0,0 +1,11 @@
|
|
|
1
|
+
/**
|
|
2
|
+
* Per-capacity order service time entry for a hub location row.
|
|
3
|
+
*/
|
|
4
|
+
export interface PlaceHubLocationCapacityServiceTimeInputRequestBody {
|
|
5
|
+
/** Capacity UUID. */
|
|
6
|
+
capacityId: string;
|
|
7
|
+
/** Service time in seconds. */
|
|
8
|
+
serviceTimeSeconds: number;
|
|
9
|
+
/** Additional service time per quantity unit. */
|
|
10
|
+
serviceTimeSecondsPerQuantityUnit: number;
|
|
11
|
+
}
|
|
@@ -0,0 +1,22 @@
|
|
|
1
|
+
import type * as Samsara from "../index.js";
|
|
2
|
+
/**
|
|
3
|
+
* Order service time configuration for a hub location row.
|
|
4
|
+
*/
|
|
5
|
+
export interface PlaceHubLocationOrderServiceTimeInputRequestBody {
|
|
6
|
+
/** Capacity-based service times for variable mode. */
|
|
7
|
+
capacityServiceTimes?: Samsara.PlaceHubLocationCapacityServiceTimeInputRequestBody[] | undefined;
|
|
8
|
+
/** Fixed order service time in seconds when applicable. */
|
|
9
|
+
fixedTimeSeconds?: number | undefined;
|
|
10
|
+
/** Mode: fixed or variable. Valid values: `fixed`, `variable`, `unknown`, `unspecified` */
|
|
11
|
+
modeType: PlaceHubLocationOrderServiceTimeInputRequestBody.ModeType;
|
|
12
|
+
}
|
|
13
|
+
export declare namespace PlaceHubLocationOrderServiceTimeInputRequestBody {
|
|
14
|
+
/** Mode: fixed or variable. Valid values: `fixed`, `variable`, `unknown`, `unspecified` */
|
|
15
|
+
const ModeType: {
|
|
16
|
+
readonly Fixed: "fixed";
|
|
17
|
+
readonly Variable: "variable";
|
|
18
|
+
readonly Unknown: "unknown";
|
|
19
|
+
readonly Unspecified: "unspecified";
|
|
20
|
+
};
|
|
21
|
+
type ModeType = (typeof ModeType)[keyof typeof ModeType];
|
|
22
|
+
}
|
|
@@ -0,0 +1,14 @@
|
|
|
1
|
+
"use strict";
|
|
2
|
+
// This file was auto-generated by Fern from our API Definition.
|
|
3
|
+
Object.defineProperty(exports, "__esModule", { value: true });
|
|
4
|
+
exports.PlaceHubLocationOrderServiceTimeInputRequestBody = void 0;
|
|
5
|
+
var PlaceHubLocationOrderServiceTimeInputRequestBody;
|
|
6
|
+
(function (PlaceHubLocationOrderServiceTimeInputRequestBody) {
|
|
7
|
+
/** Mode: fixed or variable. Valid values: `fixed`, `variable`, `unknown`, `unspecified` */
|
|
8
|
+
PlaceHubLocationOrderServiceTimeInputRequestBody.ModeType = {
|
|
9
|
+
Fixed: "fixed",
|
|
10
|
+
Variable: "variable",
|
|
11
|
+
Unknown: "unknown",
|
|
12
|
+
Unspecified: "unspecified",
|
|
13
|
+
};
|
|
14
|
+
})(PlaceHubLocationOrderServiceTimeInputRequestBody || (exports.PlaceHubLocationOrderServiceTimeInputRequestBody = PlaceHubLocationOrderServiceTimeInputRequestBody = {}));
|
|
@@ -0,0 +1,9 @@
|
|
|
1
|
+
/**
|
|
2
|
+
* Additional service time configuration for a hub location row.
|
|
3
|
+
*/
|
|
4
|
+
export interface PlaceHubLocationServiceTimeInputRequestBody {
|
|
5
|
+
/** Whole minutes of additional service time. */
|
|
6
|
+
additionalTimeMinutes: number;
|
|
7
|
+
/** Whether additional service time is enabled. */
|
|
8
|
+
isEnabled: boolean;
|
|
9
|
+
}
|
|
@@ -1878,7 +1878,10 @@ export * from "./PersonDetectedResponseBody.js";
|
|
|
1878
1878
|
export * from "./PhotoValueObjectRequestBody.js";
|
|
1879
1879
|
export * from "./PhotoValueObjectResponseBody.js";
|
|
1880
1880
|
export * from "./PlaceGeofenceVertexResponseResponseBody.js";
|
|
1881
|
+
export * from "./PlaceHubLocationCapacityServiceTimeInputRequestBody.js";
|
|
1882
|
+
export * from "./PlaceHubLocationOrderServiceTimeInputRequestBody.js";
|
|
1881
1883
|
export * from "./PlaceHubLocationRequiredSkillInputRequestBody.js";
|
|
1884
|
+
export * from "./PlaceHubLocationServiceTimeInputRequestBody.js";
|
|
1882
1885
|
export * from "./PlaceHubLocationServiceWindowInputRequestBody.js";
|
|
1883
1886
|
export * from "./PlaceNavigationLocationResponseResponseBody.js";
|
|
1884
1887
|
export * from "./PlaceNavigationResponseResponseBody.js";
|
|
@@ -1894,7 +1894,10 @@ __exportStar(require("./PersonDetectedResponseBody.js"), exports);
|
|
|
1894
1894
|
__exportStar(require("./PhotoValueObjectRequestBody.js"), exports);
|
|
1895
1895
|
__exportStar(require("./PhotoValueObjectResponseBody.js"), exports);
|
|
1896
1896
|
__exportStar(require("./PlaceGeofenceVertexResponseResponseBody.js"), exports);
|
|
1897
|
+
__exportStar(require("./PlaceHubLocationCapacityServiceTimeInputRequestBody.js"), exports);
|
|
1898
|
+
__exportStar(require("./PlaceHubLocationOrderServiceTimeInputRequestBody.js"), exports);
|
|
1897
1899
|
__exportStar(require("./PlaceHubLocationRequiredSkillInputRequestBody.js"), exports);
|
|
1900
|
+
__exportStar(require("./PlaceHubLocationServiceTimeInputRequestBody.js"), exports);
|
|
1898
1901
|
__exportStar(require("./PlaceHubLocationServiceWindowInputRequestBody.js"), exports);
|
|
1899
1902
|
__exportStar(require("./PlaceNavigationLocationResponseResponseBody.js"), exports);
|
|
1900
1903
|
__exportStar(require("./PlaceNavigationResponseResponseBody.js"), exports);
|
package/dist/cjs/version.d.ts
CHANGED
|
@@ -1 +1 @@
|
|
|
1
|
-
export declare const SDK_VERSION = "13.
|
|
1
|
+
export declare const SDK_VERSION = "13.8.0";
|
package/dist/cjs/version.js
CHANGED
package/dist/esm/BaseClient.mjs
CHANGED
|
@@ -7,8 +7,8 @@ export function normalizeClientOptions(options) {
|
|
|
7
7
|
const headers = mergeHeaders({
|
|
8
8
|
"X-Fern-Language": "JavaScript",
|
|
9
9
|
"X-Fern-SDK-Name": "@samsarahq/samsara",
|
|
10
|
-
"X-Fern-SDK-Version": "13.
|
|
11
|
-
"User-Agent": "@samsarahq/samsara/13.
|
|
10
|
+
"X-Fern-SDK-Version": "13.8.0",
|
|
11
|
+
"User-Agent": "@samsarahq/samsara/13.8.0",
|
|
12
12
|
"X-Fern-Runtime": core.RUNTIME.type,
|
|
13
13
|
"X-Fern-Runtime-Version": core.RUNTIME.version,
|
|
14
14
|
"X-Samsara-Version": (_a = options === null || options === void 0 ? void 0 : options.version) !== null && _a !== void 0 ? _a : "2025-06-11",
|
|
@@ -1772,7 +1772,33 @@ export declare class BetaApIsClient {
|
|
|
1772
1772
|
/**
|
|
1773
1773
|
* Ingest new readings. This endpoint allows the ingestion of batches of readings.
|
|
1774
1774
|
*
|
|
1775
|
-
* Ingesting readings is only supported for assets created using the POST /assets API endpoint with readingsIngestionEnabled set to true. To see a full list of readings available for ingestion use the GET readings definitions API.
|
|
1775
|
+
* Ingesting readings is only supported for assets created using the POST /assets API endpoint with readingsIngestionEnabled set to true. To see a full list of readings available for ingestion use the GET readings definitions API.
|
|
1776
|
+
*
|
|
1777
|
+
*
|
|
1778
|
+
* Readings that currently support ingestion (by category):
|
|
1779
|
+
*
|
|
1780
|
+
*
|
|
1781
|
+
* <details>
|
|
1782
|
+
* <summary><strong>ingestible</strong></summary>
|
|
1783
|
+
*
|
|
1784
|
+
* * `batteryVoltage`
|
|
1785
|
+
* * `coolantTemp`
|
|
1786
|
+
* * `ecuFuelLevelMillipercent`
|
|
1787
|
+
* * `engineHours`
|
|
1788
|
+
* * `engineRpm`
|
|
1789
|
+
* * `engineState` (values: off | running | idling)
|
|
1790
|
+
* * `faultCodesJ1939`
|
|
1791
|
+
* * `faultCodesOBDII`
|
|
1792
|
+
* * `fuelLevelPerc`
|
|
1793
|
+
* * `location`
|
|
1794
|
+
* * `odometerEcu`
|
|
1795
|
+
* * `oilPressure`
|
|
1796
|
+
*
|
|
1797
|
+
* </details>
|
|
1798
|
+
*
|
|
1799
|
+
* **Note:** Use the `GET /readings/definitions` endpoint and check the `ingestionEnabled` field for the authoritative, up-to-date set of ingestible readings for your organization.
|
|
1800
|
+
*
|
|
1801
|
+
* When ingesting location data, the readingID 'location' must be used and the value object must contain at least the following fields: 'speed', 'latitude', 'longitude'.
|
|
1776
1802
|
*
|
|
1777
1803
|
* Related guide: [Readings](https://developers.samsara.com/docs/readings).
|
|
1778
1804
|
*
|
|
@@ -5164,7 +5164,33 @@ export class BetaApIsClient {
|
|
|
5164
5164
|
/**
|
|
5165
5165
|
* Ingest new readings. This endpoint allows the ingestion of batches of readings.
|
|
5166
5166
|
*
|
|
5167
|
-
* Ingesting readings is only supported for assets created using the POST /assets API endpoint with readingsIngestionEnabled set to true. To see a full list of readings available for ingestion use the GET readings definitions API.
|
|
5167
|
+
* Ingesting readings is only supported for assets created using the POST /assets API endpoint with readingsIngestionEnabled set to true. To see a full list of readings available for ingestion use the GET readings definitions API.
|
|
5168
|
+
*
|
|
5169
|
+
*
|
|
5170
|
+
* Readings that currently support ingestion (by category):
|
|
5171
|
+
*
|
|
5172
|
+
*
|
|
5173
|
+
* <details>
|
|
5174
|
+
* <summary><strong>ingestible</strong></summary>
|
|
5175
|
+
*
|
|
5176
|
+
* * `batteryVoltage`
|
|
5177
|
+
* * `coolantTemp`
|
|
5178
|
+
* * `ecuFuelLevelMillipercent`
|
|
5179
|
+
* * `engineHours`
|
|
5180
|
+
* * `engineRpm`
|
|
5181
|
+
* * `engineState` (values: off | running | idling)
|
|
5182
|
+
* * `faultCodesJ1939`
|
|
5183
|
+
* * `faultCodesOBDII`
|
|
5184
|
+
* * `fuelLevelPerc`
|
|
5185
|
+
* * `location`
|
|
5186
|
+
* * `odometerEcu`
|
|
5187
|
+
* * `oilPressure`
|
|
5188
|
+
*
|
|
5189
|
+
* </details>
|
|
5190
|
+
*
|
|
5191
|
+
* **Note:** Use the `GET /readings/definitions` endpoint and check the `ingestionEnabled` field for the authoritative, up-to-date set of ingestible readings for your organization.
|
|
5192
|
+
*
|
|
5193
|
+
* When ingesting location data, the readingID 'location' must be used and the value object must contain at least the following fields: 'speed', 'latitude', 'longitude'.
|
|
5168
5194
|
*
|
|
5169
5195
|
* Related guide: [Readings](https://developers.samsara.com/docs/readings).
|
|
5170
5196
|
*
|
|
@@ -19,6 +19,8 @@ export interface PlacesPatchPlaceRequestBody {
|
|
|
19
19
|
hubLocations?: Samsara.PatchPlaceHubLocationsBodyRequestBody;
|
|
20
20
|
/** When present, replaces IFTA exemption types for the place. */
|
|
21
21
|
iftaExemptionTypes?: string[];
|
|
22
|
+
/** When true, show addresses inside the geofence on the map. */
|
|
23
|
+
isShowAddressesEnabled?: boolean;
|
|
22
24
|
/** Center latitude when switching to or editing a circle geofence. */
|
|
23
25
|
latitude?: number;
|
|
24
26
|
/** Center longitude when switching to or editing a circle geofence. */
|
|
@@ -19,6 +19,8 @@ export interface PlacesPostPlaceRequestBody {
|
|
|
19
19
|
hubLocations?: Samsara.PatchPlaceHubLocationUpsertBodyRequestBody[];
|
|
20
20
|
/** IFTA exemption types for this place. */
|
|
21
21
|
iftaExemptionTypes?: string[];
|
|
22
|
+
/** When true, show addresses inside the geofence on the map. */
|
|
23
|
+
isShowAddressesEnabled?: boolean;
|
|
22
24
|
/** Center latitude when using a circle geofence with radiusMeters. */
|
|
23
25
|
latitude?: number;
|
|
24
26
|
/** Center longitude when using a circle geofence with radiusMeters. */
|
|
@@ -17,8 +17,12 @@ export interface PatchPlaceHubLocationUpsertBodyRequestBody {
|
|
|
17
17
|
isIgnoreOrderServiceTimeEnabled?: boolean | undefined;
|
|
18
18
|
/** Stop position preference: unspecified, any, first, or last. */
|
|
19
19
|
locationPositionType?: string | undefined;
|
|
20
|
+
/** Route priority from 1 (lowest) to 5 (highest). */
|
|
21
|
+
locationPriority?: number | undefined;
|
|
22
|
+
orderServiceTime?: Samsara.PlaceHubLocationOrderServiceTimeInputRequestBody | undefined;
|
|
20
23
|
/** Required planner skills for this hub location. */
|
|
21
24
|
requiredSkills?: Samsara.PlaceHubLocationRequiredSkillInputRequestBody[] | undefined;
|
|
25
|
+
serviceTime?: Samsara.PlaceHubLocationServiceTimeInputRequestBody | undefined;
|
|
22
26
|
/** Recurring local-time service windows for this hub location. */
|
|
23
27
|
serviceWindows?: Samsara.PlaceHubLocationServiceWindowInputRequestBody[] | undefined;
|
|
24
28
|
/** Default instructions for drivers at this hub location. */
|
|
@@ -0,0 +1,11 @@
|
|
|
1
|
+
/**
|
|
2
|
+
* Per-capacity order service time entry for a hub location row.
|
|
3
|
+
*/
|
|
4
|
+
export interface PlaceHubLocationCapacityServiceTimeInputRequestBody {
|
|
5
|
+
/** Capacity UUID. */
|
|
6
|
+
capacityId: string;
|
|
7
|
+
/** Service time in seconds. */
|
|
8
|
+
serviceTimeSeconds: number;
|
|
9
|
+
/** Additional service time per quantity unit. */
|
|
10
|
+
serviceTimeSecondsPerQuantityUnit: number;
|
|
11
|
+
}
|
|
@@ -0,0 +1,22 @@
|
|
|
1
|
+
import type * as Samsara from "../index.mjs";
|
|
2
|
+
/**
|
|
3
|
+
* Order service time configuration for a hub location row.
|
|
4
|
+
*/
|
|
5
|
+
export interface PlaceHubLocationOrderServiceTimeInputRequestBody {
|
|
6
|
+
/** Capacity-based service times for variable mode. */
|
|
7
|
+
capacityServiceTimes?: Samsara.PlaceHubLocationCapacityServiceTimeInputRequestBody[] | undefined;
|
|
8
|
+
/** Fixed order service time in seconds when applicable. */
|
|
9
|
+
fixedTimeSeconds?: number | undefined;
|
|
10
|
+
/** Mode: fixed or variable. Valid values: `fixed`, `variable`, `unknown`, `unspecified` */
|
|
11
|
+
modeType: PlaceHubLocationOrderServiceTimeInputRequestBody.ModeType;
|
|
12
|
+
}
|
|
13
|
+
export declare namespace PlaceHubLocationOrderServiceTimeInputRequestBody {
|
|
14
|
+
/** Mode: fixed or variable. Valid values: `fixed`, `variable`, `unknown`, `unspecified` */
|
|
15
|
+
const ModeType: {
|
|
16
|
+
readonly Fixed: "fixed";
|
|
17
|
+
readonly Variable: "variable";
|
|
18
|
+
readonly Unknown: "unknown";
|
|
19
|
+
readonly Unspecified: "unspecified";
|
|
20
|
+
};
|
|
21
|
+
type ModeType = (typeof ModeType)[keyof typeof ModeType];
|
|
22
|
+
}
|
|
@@ -0,0 +1,11 @@
|
|
|
1
|
+
// This file was auto-generated by Fern from our API Definition.
|
|
2
|
+
export var PlaceHubLocationOrderServiceTimeInputRequestBody;
|
|
3
|
+
(function (PlaceHubLocationOrderServiceTimeInputRequestBody) {
|
|
4
|
+
/** Mode: fixed or variable. Valid values: `fixed`, `variable`, `unknown`, `unspecified` */
|
|
5
|
+
PlaceHubLocationOrderServiceTimeInputRequestBody.ModeType = {
|
|
6
|
+
Fixed: "fixed",
|
|
7
|
+
Variable: "variable",
|
|
8
|
+
Unknown: "unknown",
|
|
9
|
+
Unspecified: "unspecified",
|
|
10
|
+
};
|
|
11
|
+
})(PlaceHubLocationOrderServiceTimeInputRequestBody || (PlaceHubLocationOrderServiceTimeInputRequestBody = {}));
|
|
@@ -0,0 +1,9 @@
|
|
|
1
|
+
/**
|
|
2
|
+
* Additional service time configuration for a hub location row.
|
|
3
|
+
*/
|
|
4
|
+
export interface PlaceHubLocationServiceTimeInputRequestBody {
|
|
5
|
+
/** Whole minutes of additional service time. */
|
|
6
|
+
additionalTimeMinutes: number;
|
|
7
|
+
/** Whether additional service time is enabled. */
|
|
8
|
+
isEnabled: boolean;
|
|
9
|
+
}
|
|
@@ -1878,7 +1878,10 @@ export * from "./PersonDetectedResponseBody.mjs";
|
|
|
1878
1878
|
export * from "./PhotoValueObjectRequestBody.mjs";
|
|
1879
1879
|
export * from "./PhotoValueObjectResponseBody.mjs";
|
|
1880
1880
|
export * from "./PlaceGeofenceVertexResponseResponseBody.mjs";
|
|
1881
|
+
export * from "./PlaceHubLocationCapacityServiceTimeInputRequestBody.mjs";
|
|
1882
|
+
export * from "./PlaceHubLocationOrderServiceTimeInputRequestBody.mjs";
|
|
1881
1883
|
export * from "./PlaceHubLocationRequiredSkillInputRequestBody.mjs";
|
|
1884
|
+
export * from "./PlaceHubLocationServiceTimeInputRequestBody.mjs";
|
|
1882
1885
|
export * from "./PlaceHubLocationServiceWindowInputRequestBody.mjs";
|
|
1883
1886
|
export * from "./PlaceNavigationLocationResponseResponseBody.mjs";
|
|
1884
1887
|
export * from "./PlaceNavigationResponseResponseBody.mjs";
|
|
@@ -1878,7 +1878,10 @@ export * from "./PersonDetectedResponseBody.mjs";
|
|
|
1878
1878
|
export * from "./PhotoValueObjectRequestBody.mjs";
|
|
1879
1879
|
export * from "./PhotoValueObjectResponseBody.mjs";
|
|
1880
1880
|
export * from "./PlaceGeofenceVertexResponseResponseBody.mjs";
|
|
1881
|
+
export * from "./PlaceHubLocationCapacityServiceTimeInputRequestBody.mjs";
|
|
1882
|
+
export * from "./PlaceHubLocationOrderServiceTimeInputRequestBody.mjs";
|
|
1881
1883
|
export * from "./PlaceHubLocationRequiredSkillInputRequestBody.mjs";
|
|
1884
|
+
export * from "./PlaceHubLocationServiceTimeInputRequestBody.mjs";
|
|
1882
1885
|
export * from "./PlaceHubLocationServiceWindowInputRequestBody.mjs";
|
|
1883
1886
|
export * from "./PlaceNavigationLocationResponseResponseBody.mjs";
|
|
1884
1887
|
export * from "./PlaceNavigationResponseResponseBody.mjs";
|
package/dist/esm/version.d.mts
CHANGED
|
@@ -1 +1 @@
|
|
|
1
|
-
export declare const SDK_VERSION = "13.
|
|
1
|
+
export declare const SDK_VERSION = "13.8.0";
|
package/dist/esm/version.mjs
CHANGED
|
@@ -1 +1 @@
|
|
|
1
|
-
export const SDK_VERSION = "13.
|
|
1
|
+
export const SDK_VERSION = "13.8.0";
|
package/package.json
CHANGED
package/reference.md
CHANGED
|
@@ -5699,7 +5699,33 @@ await client.betaApIs.getQualificationTypes({
|
|
|
5699
5699
|
|
|
5700
5700
|
Ingest new readings. This endpoint allows the ingestion of batches of readings.
|
|
5701
5701
|
|
|
5702
|
-
Ingesting readings is only supported for assets created using the POST /assets API endpoint with readingsIngestionEnabled set to true. To see a full list of readings available for ingestion use the GET readings definitions API.
|
|
5702
|
+
Ingesting readings is only supported for assets created using the POST /assets API endpoint with readingsIngestionEnabled set to true. To see a full list of readings available for ingestion use the GET readings definitions API.
|
|
5703
|
+
|
|
5704
|
+
|
|
5705
|
+
Readings that currently support ingestion (by category):
|
|
5706
|
+
|
|
5707
|
+
|
|
5708
|
+
<details>
|
|
5709
|
+
<summary><strong>ingestible</strong></summary>
|
|
5710
|
+
|
|
5711
|
+
* `batteryVoltage`
|
|
5712
|
+
* `coolantTemp`
|
|
5713
|
+
* `ecuFuelLevelMillipercent`
|
|
5714
|
+
* `engineHours`
|
|
5715
|
+
* `engineRpm`
|
|
5716
|
+
* `engineState` (values: off | running | idling)
|
|
5717
|
+
* `faultCodesJ1939`
|
|
5718
|
+
* `faultCodesOBDII`
|
|
5719
|
+
* `fuelLevelPerc`
|
|
5720
|
+
* `location`
|
|
5721
|
+
* `odometerEcu`
|
|
5722
|
+
* `oilPressure`
|
|
5723
|
+
|
|
5724
|
+
</details>
|
|
5725
|
+
|
|
5726
|
+
**Note:** Use the `GET /readings/definitions` endpoint and check the `ingestionEnabled` field for the authoritative, up-to-date set of ingestible readings for your organization.
|
|
5727
|
+
|
|
5728
|
+
When ingesting location data, the readingID 'location' must be used and the value object must contain at least the following fields: 'speed', 'latitude', 'longitude'.
|
|
5703
5729
|
|
|
5704
5730
|
Related guide: [Readings](https://developers.samsara.com/docs/readings).
|
|
5705
5731
|
|