@samsarahq/samsara 13.17.0 → 13.18.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 +30 -1
- package/dist/cjs/api/resources/betaApIs/client/Client.js +88 -1
- package/dist/cjs/api/resources/betaApIs/client/requests/GetWorkOrderTemplatesRequest.d.ts +8 -0
- package/dist/cjs/api/resources/betaApIs/client/requests/GetWorkOrderTemplatesRequest.js +3 -0
- package/dist/cjs/api/resources/betaApIs/client/requests/SafetyEventsV2PatchSafetyEventsV2BatchRequestBody.d.ts +1 -1
- package/dist/cjs/api/resources/betaApIs/client/requests/index.d.ts +1 -0
- package/dist/cjs/api/types/WorkOrderTemplateObjectResponseBody.d.ts +9 -0
- package/dist/cjs/api/types/WorkOrderTemplateObjectResponseBody.js +3 -0
- package/dist/cjs/api/types/WorkOrdersGetWorkOrderTemplatesBadGatewayErrorResponseBody.d.ts +9 -0
- package/dist/cjs/api/types/WorkOrdersGetWorkOrderTemplatesBadGatewayErrorResponseBody.js +3 -0
- package/dist/cjs/api/types/WorkOrdersGetWorkOrderTemplatesGatewayTimeoutErrorResponseBody.d.ts +9 -0
- package/dist/cjs/api/types/WorkOrdersGetWorkOrderTemplatesGatewayTimeoutErrorResponseBody.js +3 -0
- package/dist/cjs/api/types/WorkOrdersGetWorkOrderTemplatesInternalServerErrorResponseBody.d.ts +9 -0
- package/dist/cjs/api/types/WorkOrdersGetWorkOrderTemplatesInternalServerErrorResponseBody.js +3 -0
- package/dist/cjs/api/types/WorkOrdersGetWorkOrderTemplatesMethodNotAllowedErrorResponseBody.d.ts +9 -0
- package/dist/cjs/api/types/WorkOrdersGetWorkOrderTemplatesMethodNotAllowedErrorResponseBody.js +3 -0
- package/dist/cjs/api/types/WorkOrdersGetWorkOrderTemplatesNotFoundErrorResponseBody.d.ts +9 -0
- package/dist/cjs/api/types/WorkOrdersGetWorkOrderTemplatesNotFoundErrorResponseBody.js +3 -0
- package/dist/cjs/api/types/WorkOrdersGetWorkOrderTemplatesNotImplementedErrorResponseBody.d.ts +9 -0
- package/dist/cjs/api/types/WorkOrdersGetWorkOrderTemplatesNotImplementedErrorResponseBody.js +3 -0
- package/dist/cjs/api/types/WorkOrdersGetWorkOrderTemplatesResponseBody.d.ts +5 -0
- package/dist/cjs/api/types/WorkOrdersGetWorkOrderTemplatesResponseBody.js +3 -0
- package/dist/cjs/api/types/WorkOrdersGetWorkOrderTemplatesServiceUnavailableErrorResponseBody.d.ts +9 -0
- package/dist/cjs/api/types/WorkOrdersGetWorkOrderTemplatesServiceUnavailableErrorResponseBody.js +3 -0
- package/dist/cjs/api/types/WorkOrdersGetWorkOrderTemplatesTooManyRequestsErrorResponseBody.d.ts +9 -0
- package/dist/cjs/api/types/WorkOrdersGetWorkOrderTemplatesTooManyRequestsErrorResponseBody.js +3 -0
- package/dist/cjs/api/types/WorkOrdersGetWorkOrderTemplatesUnauthorizedErrorResponseBody.d.ts +9 -0
- package/dist/cjs/api/types/WorkOrdersGetWorkOrderTemplatesUnauthorizedErrorResponseBody.js +3 -0
- package/dist/cjs/api/types/index.d.ts +11 -0
- package/dist/cjs/api/types/index.js +11 -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 +30 -1
- package/dist/esm/api/resources/betaApIs/client/Client.mjs +88 -1
- package/dist/esm/api/resources/betaApIs/client/requests/GetWorkOrderTemplatesRequest.d.mts +8 -0
- package/dist/esm/api/resources/betaApIs/client/requests/GetWorkOrderTemplatesRequest.mjs +2 -0
- package/dist/esm/api/resources/betaApIs/client/requests/SafetyEventsV2PatchSafetyEventsV2BatchRequestBody.d.mts +1 -1
- package/dist/esm/api/resources/betaApIs/client/requests/index.d.mts +1 -0
- package/dist/esm/api/types/WorkOrderTemplateObjectResponseBody.d.mts +9 -0
- package/dist/esm/api/types/WorkOrderTemplateObjectResponseBody.mjs +2 -0
- package/dist/esm/api/types/WorkOrdersGetWorkOrderTemplatesBadGatewayErrorResponseBody.d.mts +9 -0
- package/dist/esm/api/types/WorkOrdersGetWorkOrderTemplatesBadGatewayErrorResponseBody.mjs +2 -0
- package/dist/esm/api/types/WorkOrdersGetWorkOrderTemplatesGatewayTimeoutErrorResponseBody.d.mts +9 -0
- package/dist/esm/api/types/WorkOrdersGetWorkOrderTemplatesGatewayTimeoutErrorResponseBody.mjs +2 -0
- package/dist/esm/api/types/WorkOrdersGetWorkOrderTemplatesInternalServerErrorResponseBody.d.mts +9 -0
- package/dist/esm/api/types/WorkOrdersGetWorkOrderTemplatesInternalServerErrorResponseBody.mjs +2 -0
- package/dist/esm/api/types/WorkOrdersGetWorkOrderTemplatesMethodNotAllowedErrorResponseBody.d.mts +9 -0
- package/dist/esm/api/types/WorkOrdersGetWorkOrderTemplatesMethodNotAllowedErrorResponseBody.mjs +2 -0
- package/dist/esm/api/types/WorkOrdersGetWorkOrderTemplatesNotFoundErrorResponseBody.d.mts +9 -0
- package/dist/esm/api/types/WorkOrdersGetWorkOrderTemplatesNotFoundErrorResponseBody.mjs +2 -0
- package/dist/esm/api/types/WorkOrdersGetWorkOrderTemplatesNotImplementedErrorResponseBody.d.mts +9 -0
- package/dist/esm/api/types/WorkOrdersGetWorkOrderTemplatesNotImplementedErrorResponseBody.mjs +2 -0
- package/dist/esm/api/types/WorkOrdersGetWorkOrderTemplatesResponseBody.d.mts +5 -0
- package/dist/esm/api/types/WorkOrdersGetWorkOrderTemplatesResponseBody.mjs +2 -0
- package/dist/esm/api/types/WorkOrdersGetWorkOrderTemplatesServiceUnavailableErrorResponseBody.d.mts +9 -0
- package/dist/esm/api/types/WorkOrdersGetWorkOrderTemplatesServiceUnavailableErrorResponseBody.mjs +2 -0
- package/dist/esm/api/types/WorkOrdersGetWorkOrderTemplatesTooManyRequestsErrorResponseBody.d.mts +9 -0
- package/dist/esm/api/types/WorkOrdersGetWorkOrderTemplatesTooManyRequestsErrorResponseBody.mjs +2 -0
- package/dist/esm/api/types/WorkOrdersGetWorkOrderTemplatesUnauthorizedErrorResponseBody.d.mts +9 -0
- package/dist/esm/api/types/WorkOrdersGetWorkOrderTemplatesUnauthorizedErrorResponseBody.mjs +2 -0
- package/dist/esm/api/types/index.d.mts +11 -0
- package/dist/esm/api/types/index.mjs +11 -0
- package/dist/esm/version.d.mts +1 -1
- package/dist/esm/version.mjs +1 -1
- package/package.json +1 -1
- package/reference.md +72 -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.18.0",
|
|
48
|
+
"User-Agent": "@samsarahq/samsara/13.18.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",
|
|
@@ -1298,6 +1298,34 @@ export declare class BetaApIsClient {
|
|
|
1298
1298
|
*/
|
|
1299
1299
|
deleteHubRouteTemplate(request: Samsara.DeleteHubRouteTemplateRequest, requestOptions?: BetaApIsClient.RequestOptions): core.HttpResponsePromise<void>;
|
|
1300
1300
|
private __deleteHubRouteTemplate;
|
|
1301
|
+
/**
|
|
1302
|
+
* Gets work order templates by id. Ids that do not resolve to a template (e.g. deleted) are omitted from the response.
|
|
1303
|
+
*
|
|
1304
|
+
* <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>).
|
|
1305
|
+
*
|
|
1306
|
+
* To use this endpoint, select **Read Work Orders** under the Work Orders 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>
|
|
1307
|
+
*
|
|
1308
|
+
*
|
|
1309
|
+
* **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.
|
|
1310
|
+
*
|
|
1311
|
+
* @param {Samsara.GetWorkOrderTemplatesRequest} request
|
|
1312
|
+
* @param {BetaApIsClient.RequestOptions} requestOptions - Request-specific configuration.
|
|
1313
|
+
*
|
|
1314
|
+
* @throws {@link Samsara.UnauthorizedError}
|
|
1315
|
+
* @throws {@link Samsara.NotFoundError}
|
|
1316
|
+
* @throws {@link Samsara.MethodNotAllowedError}
|
|
1317
|
+
* @throws {@link Samsara.TooManyRequestsError}
|
|
1318
|
+
* @throws {@link Samsara.InternalServerError}
|
|
1319
|
+
* @throws {@link Samsara.NotImplementedError}
|
|
1320
|
+
* @throws {@link Samsara.BadGatewayError}
|
|
1321
|
+
* @throws {@link Samsara.ServiceUnavailableError}
|
|
1322
|
+
* @throws {@link Samsara.GatewayTimeoutError}
|
|
1323
|
+
*
|
|
1324
|
+
* @example
|
|
1325
|
+
* await client.betaApIs.getWorkOrderTemplates()
|
|
1326
|
+
*/
|
|
1327
|
+
getWorkOrderTemplates(request?: Samsara.GetWorkOrderTemplatesRequest, requestOptions?: BetaApIsClient.RequestOptions): core.HttpResponsePromise<Samsara.WorkOrdersGetWorkOrderTemplatesResponseBody>;
|
|
1328
|
+
private __getWorkOrderTemplates;
|
|
1301
1329
|
/**
|
|
1302
1330
|
* Returns places for the authorized organization. Supports cursor pagination or batch fetch by Samsara place ids via `placeIds` or by external ids via `externalIds` (mutually exclusive).
|
|
1303
1331
|
*
|
|
@@ -1873,6 +1901,7 @@ export declare class BetaApIsClient {
|
|
|
1873
1901
|
* * `engineHours`
|
|
1874
1902
|
* * `engineRpm`
|
|
1875
1903
|
* * `engineState` (values: off | running | idling)
|
|
1904
|
+
* * `faultCodes`
|
|
1876
1905
|
* * `faultCodesJ1939`
|
|
1877
1906
|
* * `faultCodesOBDII`
|
|
1878
1907
|
* * `fuelLevelPerc`
|
|
@@ -2401,7 +2430,7 @@ export declare class BetaApIsClient {
|
|
|
2401
2430
|
*
|
|
2402
2431
|
* @example
|
|
2403
2432
|
* await client.betaApIs.patchSafetyEventsV2Batch({
|
|
2404
|
-
* safetyEventIds: ["bb2ff5ab-30ad-49ec-9d2d-55ec30bbf590", "bb2ff5ab-30ad-49ec-9d2d-55ec30bbf590", "bb2ff5ab-30ad-49ec-9d2d-55ec30bbf590"]
|
|
2433
|
+
* safetyEventIds: ["bb2ff5ab-30ad-49ec-9d2d-55ec30bbf590", "bb2ff5ab-30ad-49ec-9d2d-55ec30bbf590", "bb2ff5ab-30ad-49ec-9d2d-55ec30bbf590", "bb2ff5ab-30ad-49ec-9d2d-55ec30bbf590"]
|
|
2405
2434
|
* })
|
|
2406
2435
|
*/
|
|
2407
2436
|
patchSafetyEventsV2Batch(request: Samsara.SafetyEventsV2PatchSafetyEventsV2BatchRequestBody, requestOptions?: BetaApIsClient.RequestOptions): core.HttpResponsePromise<Samsara.SafetyEventsV2PatchSafetyEventsV2BatchResponseBody>;
|
|
@@ -3866,6 +3866,92 @@ class BetaApIsClient {
|
|
|
3866
3866
|
return (0, handleNonStatusCodeError_js_1.handleNonStatusCodeError)(_response.error, _response.rawResponse, "DELETE", "/hub/route-templates");
|
|
3867
3867
|
});
|
|
3868
3868
|
}
|
|
3869
|
+
/**
|
|
3870
|
+
* Gets work order templates by id. Ids that do not resolve to a template (e.g. deleted) are omitted from the response.
|
|
3871
|
+
*
|
|
3872
|
+
* <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>).
|
|
3873
|
+
*
|
|
3874
|
+
* To use this endpoint, select **Read Work Orders** under the Work Orders 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>
|
|
3875
|
+
*
|
|
3876
|
+
*
|
|
3877
|
+
* **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.
|
|
3878
|
+
*
|
|
3879
|
+
* @param {Samsara.GetWorkOrderTemplatesRequest} request
|
|
3880
|
+
* @param {BetaApIsClient.RequestOptions} requestOptions - Request-specific configuration.
|
|
3881
|
+
*
|
|
3882
|
+
* @throws {@link Samsara.UnauthorizedError}
|
|
3883
|
+
* @throws {@link Samsara.NotFoundError}
|
|
3884
|
+
* @throws {@link Samsara.MethodNotAllowedError}
|
|
3885
|
+
* @throws {@link Samsara.TooManyRequestsError}
|
|
3886
|
+
* @throws {@link Samsara.InternalServerError}
|
|
3887
|
+
* @throws {@link Samsara.NotImplementedError}
|
|
3888
|
+
* @throws {@link Samsara.BadGatewayError}
|
|
3889
|
+
* @throws {@link Samsara.ServiceUnavailableError}
|
|
3890
|
+
* @throws {@link Samsara.GatewayTimeoutError}
|
|
3891
|
+
*
|
|
3892
|
+
* @example
|
|
3893
|
+
* await client.betaApIs.getWorkOrderTemplates()
|
|
3894
|
+
*/
|
|
3895
|
+
getWorkOrderTemplates(request = {}, requestOptions) {
|
|
3896
|
+
return core.HttpResponsePromise.fromPromise(this.__getWorkOrderTemplates(request, requestOptions));
|
|
3897
|
+
}
|
|
3898
|
+
__getWorkOrderTemplates() {
|
|
3899
|
+
return __awaiter(this, arguments, void 0, function* (request = {}, requestOptions) {
|
|
3900
|
+
var _a, _b, _c, _d, _e, _f, _g, _h, _j;
|
|
3901
|
+
const { ids } = request;
|
|
3902
|
+
const _queryParams = {
|
|
3903
|
+
ids,
|
|
3904
|
+
};
|
|
3905
|
+
const _authRequest = yield this._options.authProvider.getAuthRequest();
|
|
3906
|
+
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);
|
|
3907
|
+
const _response = yield core.fetcher({
|
|
3908
|
+
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, "maintenance/work-order-templates"),
|
|
3909
|
+
method: "GET",
|
|
3910
|
+
headers: _headers,
|
|
3911
|
+
queryParameters: Object.assign(Object.assign({}, _queryParams), requestOptions === null || requestOptions === void 0 ? void 0 : requestOptions.queryParams),
|
|
3912
|
+
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,
|
|
3913
|
+
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,
|
|
3914
|
+
abortSignal: requestOptions === null || requestOptions === void 0 ? void 0 : requestOptions.abortSignal,
|
|
3915
|
+
fetchFn: (_j = this._options) === null || _j === void 0 ? void 0 : _j.fetch,
|
|
3916
|
+
logging: this._options.logging,
|
|
3917
|
+
});
|
|
3918
|
+
if (_response.ok) {
|
|
3919
|
+
return {
|
|
3920
|
+
data: _response.body,
|
|
3921
|
+
rawResponse: _response.rawResponse,
|
|
3922
|
+
};
|
|
3923
|
+
}
|
|
3924
|
+
if (_response.error.reason === "status-code") {
|
|
3925
|
+
switch (_response.error.statusCode) {
|
|
3926
|
+
case 401:
|
|
3927
|
+
throw new Samsara.UnauthorizedError(_response.error.body, _response.rawResponse);
|
|
3928
|
+
case 404:
|
|
3929
|
+
throw new Samsara.NotFoundError(_response.error.body, _response.rawResponse);
|
|
3930
|
+
case 405:
|
|
3931
|
+
throw new Samsara.MethodNotAllowedError(_response.error.body, _response.rawResponse);
|
|
3932
|
+
case 429:
|
|
3933
|
+
throw new Samsara.TooManyRequestsError(_response.error.body, _response.rawResponse);
|
|
3934
|
+
case 500:
|
|
3935
|
+
throw new Samsara.InternalServerError(_response.error.body, _response.rawResponse);
|
|
3936
|
+
case 501:
|
|
3937
|
+
throw new Samsara.NotImplementedError(_response.error.body, _response.rawResponse);
|
|
3938
|
+
case 502:
|
|
3939
|
+
throw new Samsara.BadGatewayError(_response.error.body, _response.rawResponse);
|
|
3940
|
+
case 503:
|
|
3941
|
+
throw new Samsara.ServiceUnavailableError(_response.error.body, _response.rawResponse);
|
|
3942
|
+
case 504:
|
|
3943
|
+
throw new Samsara.GatewayTimeoutError(_response.error.body, _response.rawResponse);
|
|
3944
|
+
default:
|
|
3945
|
+
throw new errors.SamsaraError({
|
|
3946
|
+
statusCode: _response.error.statusCode,
|
|
3947
|
+
body: _response.error.body,
|
|
3948
|
+
rawResponse: _response.rawResponse,
|
|
3949
|
+
});
|
|
3950
|
+
}
|
|
3951
|
+
}
|
|
3952
|
+
return (0, handleNonStatusCodeError_js_1.handleNonStatusCodeError)(_response.error, _response.rawResponse, "GET", "/maintenance/work-order-templates");
|
|
3953
|
+
});
|
|
3954
|
+
}
|
|
3869
3955
|
/**
|
|
3870
3956
|
* Returns places for the authorized organization. Supports cursor pagination or batch fetch by Samsara place ids via `placeIds` or by external ids via `externalIds` (mutually exclusive).
|
|
3871
3957
|
*
|
|
@@ -5483,6 +5569,7 @@ class BetaApIsClient {
|
|
|
5483
5569
|
* * `engineHours`
|
|
5484
5570
|
* * `engineRpm`
|
|
5485
5571
|
* * `engineState` (values: off | running | idling)
|
|
5572
|
+
* * `faultCodes`
|
|
5486
5573
|
* * `faultCodesJ1939`
|
|
5487
5574
|
* * `faultCodesOBDII`
|
|
5488
5575
|
* * `fuelLevelPerc`
|
|
@@ -6943,7 +7030,7 @@ class BetaApIsClient {
|
|
|
6943
7030
|
*
|
|
6944
7031
|
* @example
|
|
6945
7032
|
* await client.betaApIs.patchSafetyEventsV2Batch({
|
|
6946
|
-
* safetyEventIds: ["bb2ff5ab-30ad-49ec-9d2d-55ec30bbf590", "bb2ff5ab-30ad-49ec-9d2d-55ec30bbf590", "bb2ff5ab-30ad-49ec-9d2d-55ec30bbf590"]
|
|
7033
|
+
* safetyEventIds: ["bb2ff5ab-30ad-49ec-9d2d-55ec30bbf590", "bb2ff5ab-30ad-49ec-9d2d-55ec30bbf590", "bb2ff5ab-30ad-49ec-9d2d-55ec30bbf590", "bb2ff5ab-30ad-49ec-9d2d-55ec30bbf590"]
|
|
6947
7034
|
* })
|
|
6948
7035
|
*/
|
|
6949
7036
|
patchSafetyEventsV2Batch(request, requestOptions) {
|
|
@@ -2,7 +2,7 @@ import type * as Samsara from "../../../../index.js";
|
|
|
2
2
|
/**
|
|
3
3
|
* @example
|
|
4
4
|
* {
|
|
5
|
-
* safetyEventIds: ["bb2ff5ab-30ad-49ec-9d2d-55ec30bbf590", "bb2ff5ab-30ad-49ec-9d2d-55ec30bbf590", "bb2ff5ab-30ad-49ec-9d2d-55ec30bbf590"]
|
|
5
|
+
* safetyEventIds: ["bb2ff5ab-30ad-49ec-9d2d-55ec30bbf590", "bb2ff5ab-30ad-49ec-9d2d-55ec30bbf590", "bb2ff5ab-30ad-49ec-9d2d-55ec30bbf590", "bb2ff5ab-30ad-49ec-9d2d-55ec30bbf590"]
|
|
6
6
|
* }
|
|
7
7
|
*/
|
|
8
8
|
export interface SafetyEventsV2PatchSafetyEventsV2BatchRequestBody {
|
|
@@ -44,6 +44,7 @@ export type { GetRidershipPassengerRequest } from "./GetRidershipPassengerReques
|
|
|
44
44
|
export type { GetRidershipRouteSetupRequest } from "./GetRidershipRouteSetupRequest.js";
|
|
45
45
|
export type { GetVoiceSessionsRequest } from "./GetVoiceSessionsRequest.js";
|
|
46
46
|
export type { GetVoiceSessionsStreamRequest } from "./GetVoiceSessionsStreamRequest.js";
|
|
47
|
+
export type { GetWorkOrderTemplatesRequest } from "./GetWorkOrderTemplatesRequest.js";
|
|
47
48
|
export type { HosDailyLogsUpdateShippingDocsRequestBody } from "./HosDailyLogsUpdateShippingDocsRequestBody.js";
|
|
48
49
|
export type { JobsCreateJobRequestBody } from "./JobsCreateJobRequestBody.js";
|
|
49
50
|
export type { JobsPatchJobRequestBody } from "./JobsPatchJobRequestBody.js";
|
package/dist/cjs/api/types/WorkOrdersGetWorkOrderTemplatesGatewayTimeoutErrorResponseBody.d.ts
ADDED
|
@@ -0,0 +1,9 @@
|
|
|
1
|
+
/**
|
|
2
|
+
* Gateway timeout
|
|
3
|
+
*/
|
|
4
|
+
export interface WorkOrdersGetWorkOrderTemplatesGatewayTimeoutErrorResponseBody {
|
|
5
|
+
/** Message of error */
|
|
6
|
+
message: string;
|
|
7
|
+
/** The request ID; used when reaching out to support for issues with requests. */
|
|
8
|
+
requestId: string;
|
|
9
|
+
}
|
package/dist/cjs/api/types/WorkOrdersGetWorkOrderTemplatesInternalServerErrorResponseBody.d.ts
ADDED
|
@@ -0,0 +1,9 @@
|
|
|
1
|
+
/**
|
|
2
|
+
* An internal server error occurred
|
|
3
|
+
*/
|
|
4
|
+
export interface WorkOrdersGetWorkOrderTemplatesInternalServerErrorResponseBody {
|
|
5
|
+
/** Message of error */
|
|
6
|
+
message: string;
|
|
7
|
+
/** The request ID; used when reaching out to support for issues with requests. */
|
|
8
|
+
requestId: string;
|
|
9
|
+
}
|
package/dist/cjs/api/types/WorkOrdersGetWorkOrderTemplatesMethodNotAllowedErrorResponseBody.d.ts
ADDED
|
@@ -0,0 +1,9 @@
|
|
|
1
|
+
/**
|
|
2
|
+
* Method not allowed
|
|
3
|
+
*/
|
|
4
|
+
export interface WorkOrdersGetWorkOrderTemplatesMethodNotAllowedErrorResponseBody {
|
|
5
|
+
/** Message of error */
|
|
6
|
+
message: string;
|
|
7
|
+
/** The request ID; used when reaching out to support for issues with requests. */
|
|
8
|
+
requestId: string;
|
|
9
|
+
}
|
|
@@ -0,0 +1,9 @@
|
|
|
1
|
+
/**
|
|
2
|
+
* Resource not found
|
|
3
|
+
*/
|
|
4
|
+
export interface WorkOrdersGetWorkOrderTemplatesNotFoundErrorResponseBody {
|
|
5
|
+
/** Message of error */
|
|
6
|
+
message: string;
|
|
7
|
+
/** The request ID; used when reaching out to support for issues with requests. */
|
|
8
|
+
requestId: string;
|
|
9
|
+
}
|
package/dist/cjs/api/types/WorkOrdersGetWorkOrderTemplatesNotImplementedErrorResponseBody.d.ts
ADDED
|
@@ -0,0 +1,9 @@
|
|
|
1
|
+
/**
|
|
2
|
+
* Requested endpoint is not yet implemented
|
|
3
|
+
*/
|
|
4
|
+
export interface WorkOrdersGetWorkOrderTemplatesNotImplementedErrorResponseBody {
|
|
5
|
+
/** Message of error */
|
|
6
|
+
message: string;
|
|
7
|
+
/** The request ID; used when reaching out to support for issues with requests. */
|
|
8
|
+
requestId: string;
|
|
9
|
+
}
|
package/dist/cjs/api/types/WorkOrdersGetWorkOrderTemplatesServiceUnavailableErrorResponseBody.d.ts
ADDED
|
@@ -0,0 +1,9 @@
|
|
|
1
|
+
/**
|
|
2
|
+
* Service unavailable
|
|
3
|
+
*/
|
|
4
|
+
export interface WorkOrdersGetWorkOrderTemplatesServiceUnavailableErrorResponseBody {
|
|
5
|
+
/** Message of error */
|
|
6
|
+
message: string;
|
|
7
|
+
/** The request ID; used when reaching out to support for issues with requests. */
|
|
8
|
+
requestId: string;
|
|
9
|
+
}
|
package/dist/cjs/api/types/WorkOrdersGetWorkOrderTemplatesTooManyRequestsErrorResponseBody.d.ts
ADDED
|
@@ -0,0 +1,9 @@
|
|
|
1
|
+
/**
|
|
2
|
+
* Too many requests
|
|
3
|
+
*/
|
|
4
|
+
export interface WorkOrdersGetWorkOrderTemplatesTooManyRequestsErrorResponseBody {
|
|
5
|
+
/** Message of error */
|
|
6
|
+
message: string;
|
|
7
|
+
/** The request ID; used when reaching out to support for issues with requests. */
|
|
8
|
+
requestId: string;
|
|
9
|
+
}
|
|
@@ -3487,6 +3487,16 @@ export * from "./WorkOrdersGetWorkOrdersResponseBody.js";
|
|
|
3487
3487
|
export * from "./WorkOrdersGetWorkOrdersServiceUnavailableErrorResponseBody.js";
|
|
3488
3488
|
export * from "./WorkOrdersGetWorkOrdersTooManyRequestsErrorResponseBody.js";
|
|
3489
3489
|
export * from "./WorkOrdersGetWorkOrdersUnauthorizedErrorResponseBody.js";
|
|
3490
|
+
export * from "./WorkOrdersGetWorkOrderTemplatesBadGatewayErrorResponseBody.js";
|
|
3491
|
+
export * from "./WorkOrdersGetWorkOrderTemplatesGatewayTimeoutErrorResponseBody.js";
|
|
3492
|
+
export * from "./WorkOrdersGetWorkOrderTemplatesInternalServerErrorResponseBody.js";
|
|
3493
|
+
export * from "./WorkOrdersGetWorkOrderTemplatesMethodNotAllowedErrorResponseBody.js";
|
|
3494
|
+
export * from "./WorkOrdersGetWorkOrderTemplatesNotFoundErrorResponseBody.js";
|
|
3495
|
+
export * from "./WorkOrdersGetWorkOrderTemplatesNotImplementedErrorResponseBody.js";
|
|
3496
|
+
export * from "./WorkOrdersGetWorkOrderTemplatesResponseBody.js";
|
|
3497
|
+
export * from "./WorkOrdersGetWorkOrderTemplatesServiceUnavailableErrorResponseBody.js";
|
|
3498
|
+
export * from "./WorkOrdersGetWorkOrderTemplatesTooManyRequestsErrorResponseBody.js";
|
|
3499
|
+
export * from "./WorkOrdersGetWorkOrderTemplatesUnauthorizedErrorResponseBody.js";
|
|
3490
3500
|
export * from "./WorkOrdersPatchWorkOrdersBadGatewayErrorResponseBody.js";
|
|
3491
3501
|
export * from "./WorkOrdersPatchWorkOrdersGatewayTimeoutErrorResponseBody.js";
|
|
3492
3502
|
export * from "./WorkOrdersPatchWorkOrdersInternalServerErrorResponseBody.js";
|
|
@@ -3530,6 +3540,7 @@ export * from "./WorkOrdersStreamWorkOrdersUnauthorizedErrorResponseBody.js";
|
|
|
3530
3540
|
export * from "./WorkOrderTaxCreateObjectRequestBody.js";
|
|
3531
3541
|
export * from "./WorkOrderTaxObjectRequestBody.js";
|
|
3532
3542
|
export * from "./WorkOrderTaxObjectResponseBody.js";
|
|
3543
|
+
export * from "./WorkOrderTemplateObjectResponseBody.js";
|
|
3533
3544
|
export * from "./WorkOrderTimeEntryObjectResponseBody.js";
|
|
3534
3545
|
export * from "./WorkOrderUnallocatedLaborObjectResponseBody.js";
|
|
3535
3546
|
export * from "./WorkOrderWithTimeEntriesObjectResponseBody.js";
|
|
@@ -3503,6 +3503,16 @@ __exportStar(require("./WorkOrdersGetWorkOrdersResponseBody.js"), exports);
|
|
|
3503
3503
|
__exportStar(require("./WorkOrdersGetWorkOrdersServiceUnavailableErrorResponseBody.js"), exports);
|
|
3504
3504
|
__exportStar(require("./WorkOrdersGetWorkOrdersTooManyRequestsErrorResponseBody.js"), exports);
|
|
3505
3505
|
__exportStar(require("./WorkOrdersGetWorkOrdersUnauthorizedErrorResponseBody.js"), exports);
|
|
3506
|
+
__exportStar(require("./WorkOrdersGetWorkOrderTemplatesBadGatewayErrorResponseBody.js"), exports);
|
|
3507
|
+
__exportStar(require("./WorkOrdersGetWorkOrderTemplatesGatewayTimeoutErrorResponseBody.js"), exports);
|
|
3508
|
+
__exportStar(require("./WorkOrdersGetWorkOrderTemplatesInternalServerErrorResponseBody.js"), exports);
|
|
3509
|
+
__exportStar(require("./WorkOrdersGetWorkOrderTemplatesMethodNotAllowedErrorResponseBody.js"), exports);
|
|
3510
|
+
__exportStar(require("./WorkOrdersGetWorkOrderTemplatesNotFoundErrorResponseBody.js"), exports);
|
|
3511
|
+
__exportStar(require("./WorkOrdersGetWorkOrderTemplatesNotImplementedErrorResponseBody.js"), exports);
|
|
3512
|
+
__exportStar(require("./WorkOrdersGetWorkOrderTemplatesResponseBody.js"), exports);
|
|
3513
|
+
__exportStar(require("./WorkOrdersGetWorkOrderTemplatesServiceUnavailableErrorResponseBody.js"), exports);
|
|
3514
|
+
__exportStar(require("./WorkOrdersGetWorkOrderTemplatesTooManyRequestsErrorResponseBody.js"), exports);
|
|
3515
|
+
__exportStar(require("./WorkOrdersGetWorkOrderTemplatesUnauthorizedErrorResponseBody.js"), exports);
|
|
3506
3516
|
__exportStar(require("./WorkOrdersPatchWorkOrdersBadGatewayErrorResponseBody.js"), exports);
|
|
3507
3517
|
__exportStar(require("./WorkOrdersPatchWorkOrdersGatewayTimeoutErrorResponseBody.js"), exports);
|
|
3508
3518
|
__exportStar(require("./WorkOrdersPatchWorkOrdersInternalServerErrorResponseBody.js"), exports);
|
|
@@ -3546,6 +3556,7 @@ __exportStar(require("./WorkOrdersStreamWorkOrdersUnauthorizedErrorResponseBody.
|
|
|
3546
3556
|
__exportStar(require("./WorkOrderTaxCreateObjectRequestBody.js"), exports);
|
|
3547
3557
|
__exportStar(require("./WorkOrderTaxObjectRequestBody.js"), exports);
|
|
3548
3558
|
__exportStar(require("./WorkOrderTaxObjectResponseBody.js"), exports);
|
|
3559
|
+
__exportStar(require("./WorkOrderTemplateObjectResponseBody.js"), exports);
|
|
3549
3560
|
__exportStar(require("./WorkOrderTimeEntryObjectResponseBody.js"), exports);
|
|
3550
3561
|
__exportStar(require("./WorkOrderUnallocatedLaborObjectResponseBody.js"), exports);
|
|
3551
3562
|
__exportStar(require("./WorkOrderWithTimeEntriesObjectResponseBody.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.18.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.18.0",
|
|
11
|
+
"User-Agent": "@samsarahq/samsara/13.18.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",
|
|
@@ -1298,6 +1298,34 @@ export declare class BetaApIsClient {
|
|
|
1298
1298
|
*/
|
|
1299
1299
|
deleteHubRouteTemplate(request: Samsara.DeleteHubRouteTemplateRequest, requestOptions?: BetaApIsClient.RequestOptions): core.HttpResponsePromise<void>;
|
|
1300
1300
|
private __deleteHubRouteTemplate;
|
|
1301
|
+
/**
|
|
1302
|
+
* Gets work order templates by id. Ids that do not resolve to a template (e.g. deleted) are omitted from the response.
|
|
1303
|
+
*
|
|
1304
|
+
* <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>).
|
|
1305
|
+
*
|
|
1306
|
+
* To use this endpoint, select **Read Work Orders** under the Work Orders 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>
|
|
1307
|
+
*
|
|
1308
|
+
*
|
|
1309
|
+
* **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.
|
|
1310
|
+
*
|
|
1311
|
+
* @param {Samsara.GetWorkOrderTemplatesRequest} request
|
|
1312
|
+
* @param {BetaApIsClient.RequestOptions} requestOptions - Request-specific configuration.
|
|
1313
|
+
*
|
|
1314
|
+
* @throws {@link Samsara.UnauthorizedError}
|
|
1315
|
+
* @throws {@link Samsara.NotFoundError}
|
|
1316
|
+
* @throws {@link Samsara.MethodNotAllowedError}
|
|
1317
|
+
* @throws {@link Samsara.TooManyRequestsError}
|
|
1318
|
+
* @throws {@link Samsara.InternalServerError}
|
|
1319
|
+
* @throws {@link Samsara.NotImplementedError}
|
|
1320
|
+
* @throws {@link Samsara.BadGatewayError}
|
|
1321
|
+
* @throws {@link Samsara.ServiceUnavailableError}
|
|
1322
|
+
* @throws {@link Samsara.GatewayTimeoutError}
|
|
1323
|
+
*
|
|
1324
|
+
* @example
|
|
1325
|
+
* await client.betaApIs.getWorkOrderTemplates()
|
|
1326
|
+
*/
|
|
1327
|
+
getWorkOrderTemplates(request?: Samsara.GetWorkOrderTemplatesRequest, requestOptions?: BetaApIsClient.RequestOptions): core.HttpResponsePromise<Samsara.WorkOrdersGetWorkOrderTemplatesResponseBody>;
|
|
1328
|
+
private __getWorkOrderTemplates;
|
|
1301
1329
|
/**
|
|
1302
1330
|
* Returns places for the authorized organization. Supports cursor pagination or batch fetch by Samsara place ids via `placeIds` or by external ids via `externalIds` (mutually exclusive).
|
|
1303
1331
|
*
|
|
@@ -1873,6 +1901,7 @@ export declare class BetaApIsClient {
|
|
|
1873
1901
|
* * `engineHours`
|
|
1874
1902
|
* * `engineRpm`
|
|
1875
1903
|
* * `engineState` (values: off | running | idling)
|
|
1904
|
+
* * `faultCodes`
|
|
1876
1905
|
* * `faultCodesJ1939`
|
|
1877
1906
|
* * `faultCodesOBDII`
|
|
1878
1907
|
* * `fuelLevelPerc`
|
|
@@ -2401,7 +2430,7 @@ export declare class BetaApIsClient {
|
|
|
2401
2430
|
*
|
|
2402
2431
|
* @example
|
|
2403
2432
|
* await client.betaApIs.patchSafetyEventsV2Batch({
|
|
2404
|
-
* safetyEventIds: ["bb2ff5ab-30ad-49ec-9d2d-55ec30bbf590", "bb2ff5ab-30ad-49ec-9d2d-55ec30bbf590", "bb2ff5ab-30ad-49ec-9d2d-55ec30bbf590"]
|
|
2433
|
+
* safetyEventIds: ["bb2ff5ab-30ad-49ec-9d2d-55ec30bbf590", "bb2ff5ab-30ad-49ec-9d2d-55ec30bbf590", "bb2ff5ab-30ad-49ec-9d2d-55ec30bbf590", "bb2ff5ab-30ad-49ec-9d2d-55ec30bbf590"]
|
|
2405
2434
|
* })
|
|
2406
2435
|
*/
|
|
2407
2436
|
patchSafetyEventsV2Batch(request: Samsara.SafetyEventsV2PatchSafetyEventsV2BatchRequestBody, requestOptions?: BetaApIsClient.RequestOptions): core.HttpResponsePromise<Samsara.SafetyEventsV2PatchSafetyEventsV2BatchResponseBody>;
|
|
@@ -3830,6 +3830,92 @@ export class BetaApIsClient {
|
|
|
3830
3830
|
return handleNonStatusCodeError(_response.error, _response.rawResponse, "DELETE", "/hub/route-templates");
|
|
3831
3831
|
});
|
|
3832
3832
|
}
|
|
3833
|
+
/**
|
|
3834
|
+
* Gets work order templates by id. Ids that do not resolve to a template (e.g. deleted) are omitted from the response.
|
|
3835
|
+
*
|
|
3836
|
+
* <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>).
|
|
3837
|
+
*
|
|
3838
|
+
* To use this endpoint, select **Read Work Orders** under the Work Orders 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>
|
|
3839
|
+
*
|
|
3840
|
+
*
|
|
3841
|
+
* **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.
|
|
3842
|
+
*
|
|
3843
|
+
* @param {Samsara.GetWorkOrderTemplatesRequest} request
|
|
3844
|
+
* @param {BetaApIsClient.RequestOptions} requestOptions - Request-specific configuration.
|
|
3845
|
+
*
|
|
3846
|
+
* @throws {@link Samsara.UnauthorizedError}
|
|
3847
|
+
* @throws {@link Samsara.NotFoundError}
|
|
3848
|
+
* @throws {@link Samsara.MethodNotAllowedError}
|
|
3849
|
+
* @throws {@link Samsara.TooManyRequestsError}
|
|
3850
|
+
* @throws {@link Samsara.InternalServerError}
|
|
3851
|
+
* @throws {@link Samsara.NotImplementedError}
|
|
3852
|
+
* @throws {@link Samsara.BadGatewayError}
|
|
3853
|
+
* @throws {@link Samsara.ServiceUnavailableError}
|
|
3854
|
+
* @throws {@link Samsara.GatewayTimeoutError}
|
|
3855
|
+
*
|
|
3856
|
+
* @example
|
|
3857
|
+
* await client.betaApIs.getWorkOrderTemplates()
|
|
3858
|
+
*/
|
|
3859
|
+
getWorkOrderTemplates(request = {}, requestOptions) {
|
|
3860
|
+
return core.HttpResponsePromise.fromPromise(this.__getWorkOrderTemplates(request, requestOptions));
|
|
3861
|
+
}
|
|
3862
|
+
__getWorkOrderTemplates() {
|
|
3863
|
+
return __awaiter(this, arguments, void 0, function* (request = {}, requestOptions) {
|
|
3864
|
+
var _a, _b, _c, _d, _e, _f, _g, _h, _j;
|
|
3865
|
+
const { ids } = request;
|
|
3866
|
+
const _queryParams = {
|
|
3867
|
+
ids,
|
|
3868
|
+
};
|
|
3869
|
+
const _authRequest = yield this._options.authProvider.getAuthRequest();
|
|
3870
|
+
const _headers = mergeHeaders(_authRequest.headers, (_a = this._options) === null || _a === void 0 ? void 0 : _a.headers, mergeOnlyDefinedHeaders({ "X-Samsara-Version": requestOptions === null || requestOptions === void 0 ? void 0 : requestOptions.version }), requestOptions === null || requestOptions === void 0 ? void 0 : requestOptions.headers);
|
|
3871
|
+
const _response = yield core.fetcher({
|
|
3872
|
+
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, "maintenance/work-order-templates"),
|
|
3873
|
+
method: "GET",
|
|
3874
|
+
headers: _headers,
|
|
3875
|
+
queryParameters: Object.assign(Object.assign({}, _queryParams), requestOptions === null || requestOptions === void 0 ? void 0 : requestOptions.queryParams),
|
|
3876
|
+
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,
|
|
3877
|
+
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,
|
|
3878
|
+
abortSignal: requestOptions === null || requestOptions === void 0 ? void 0 : requestOptions.abortSignal,
|
|
3879
|
+
fetchFn: (_j = this._options) === null || _j === void 0 ? void 0 : _j.fetch,
|
|
3880
|
+
logging: this._options.logging,
|
|
3881
|
+
});
|
|
3882
|
+
if (_response.ok) {
|
|
3883
|
+
return {
|
|
3884
|
+
data: _response.body,
|
|
3885
|
+
rawResponse: _response.rawResponse,
|
|
3886
|
+
};
|
|
3887
|
+
}
|
|
3888
|
+
if (_response.error.reason === "status-code") {
|
|
3889
|
+
switch (_response.error.statusCode) {
|
|
3890
|
+
case 401:
|
|
3891
|
+
throw new Samsara.UnauthorizedError(_response.error.body, _response.rawResponse);
|
|
3892
|
+
case 404:
|
|
3893
|
+
throw new Samsara.NotFoundError(_response.error.body, _response.rawResponse);
|
|
3894
|
+
case 405:
|
|
3895
|
+
throw new Samsara.MethodNotAllowedError(_response.error.body, _response.rawResponse);
|
|
3896
|
+
case 429:
|
|
3897
|
+
throw new Samsara.TooManyRequestsError(_response.error.body, _response.rawResponse);
|
|
3898
|
+
case 500:
|
|
3899
|
+
throw new Samsara.InternalServerError(_response.error.body, _response.rawResponse);
|
|
3900
|
+
case 501:
|
|
3901
|
+
throw new Samsara.NotImplementedError(_response.error.body, _response.rawResponse);
|
|
3902
|
+
case 502:
|
|
3903
|
+
throw new Samsara.BadGatewayError(_response.error.body, _response.rawResponse);
|
|
3904
|
+
case 503:
|
|
3905
|
+
throw new Samsara.ServiceUnavailableError(_response.error.body, _response.rawResponse);
|
|
3906
|
+
case 504:
|
|
3907
|
+
throw new Samsara.GatewayTimeoutError(_response.error.body, _response.rawResponse);
|
|
3908
|
+
default:
|
|
3909
|
+
throw new errors.SamsaraError({
|
|
3910
|
+
statusCode: _response.error.statusCode,
|
|
3911
|
+
body: _response.error.body,
|
|
3912
|
+
rawResponse: _response.rawResponse,
|
|
3913
|
+
});
|
|
3914
|
+
}
|
|
3915
|
+
}
|
|
3916
|
+
return handleNonStatusCodeError(_response.error, _response.rawResponse, "GET", "/maintenance/work-order-templates");
|
|
3917
|
+
});
|
|
3918
|
+
}
|
|
3833
3919
|
/**
|
|
3834
3920
|
* Returns places for the authorized organization. Supports cursor pagination or batch fetch by Samsara place ids via `placeIds` or by external ids via `externalIds` (mutually exclusive).
|
|
3835
3921
|
*
|
|
@@ -5447,6 +5533,7 @@ export class BetaApIsClient {
|
|
|
5447
5533
|
* * `engineHours`
|
|
5448
5534
|
* * `engineRpm`
|
|
5449
5535
|
* * `engineState` (values: off | running | idling)
|
|
5536
|
+
* * `faultCodes`
|
|
5450
5537
|
* * `faultCodesJ1939`
|
|
5451
5538
|
* * `faultCodesOBDII`
|
|
5452
5539
|
* * `fuelLevelPerc`
|
|
@@ -6907,7 +6994,7 @@ export class BetaApIsClient {
|
|
|
6907
6994
|
*
|
|
6908
6995
|
* @example
|
|
6909
6996
|
* await client.betaApIs.patchSafetyEventsV2Batch({
|
|
6910
|
-
* safetyEventIds: ["bb2ff5ab-30ad-49ec-9d2d-55ec30bbf590", "bb2ff5ab-30ad-49ec-9d2d-55ec30bbf590", "bb2ff5ab-30ad-49ec-9d2d-55ec30bbf590"]
|
|
6997
|
+
* safetyEventIds: ["bb2ff5ab-30ad-49ec-9d2d-55ec30bbf590", "bb2ff5ab-30ad-49ec-9d2d-55ec30bbf590", "bb2ff5ab-30ad-49ec-9d2d-55ec30bbf590", "bb2ff5ab-30ad-49ec-9d2d-55ec30bbf590"]
|
|
6911
6998
|
* })
|
|
6912
6999
|
*/
|
|
6913
7000
|
patchSafetyEventsV2Batch(request, requestOptions) {
|
|
@@ -2,7 +2,7 @@ import type * as Samsara from "../../../../index.mjs";
|
|
|
2
2
|
/**
|
|
3
3
|
* @example
|
|
4
4
|
* {
|
|
5
|
-
* safetyEventIds: ["bb2ff5ab-30ad-49ec-9d2d-55ec30bbf590", "bb2ff5ab-30ad-49ec-9d2d-55ec30bbf590", "bb2ff5ab-30ad-49ec-9d2d-55ec30bbf590"]
|
|
5
|
+
* safetyEventIds: ["bb2ff5ab-30ad-49ec-9d2d-55ec30bbf590", "bb2ff5ab-30ad-49ec-9d2d-55ec30bbf590", "bb2ff5ab-30ad-49ec-9d2d-55ec30bbf590", "bb2ff5ab-30ad-49ec-9d2d-55ec30bbf590"]
|
|
6
6
|
* }
|
|
7
7
|
*/
|
|
8
8
|
export interface SafetyEventsV2PatchSafetyEventsV2BatchRequestBody {
|
|
@@ -44,6 +44,7 @@ export type { GetRidershipPassengerRequest } from "./GetRidershipPassengerReques
|
|
|
44
44
|
export type { GetRidershipRouteSetupRequest } from "./GetRidershipRouteSetupRequest.mjs";
|
|
45
45
|
export type { GetVoiceSessionsRequest } from "./GetVoiceSessionsRequest.mjs";
|
|
46
46
|
export type { GetVoiceSessionsStreamRequest } from "./GetVoiceSessionsStreamRequest.mjs";
|
|
47
|
+
export type { GetWorkOrderTemplatesRequest } from "./GetWorkOrderTemplatesRequest.mjs";
|
|
47
48
|
export type { HosDailyLogsUpdateShippingDocsRequestBody } from "./HosDailyLogsUpdateShippingDocsRequestBody.mjs";
|
|
48
49
|
export type { JobsCreateJobRequestBody } from "./JobsCreateJobRequestBody.mjs";
|
|
49
50
|
export type { JobsPatchJobRequestBody } from "./JobsPatchJobRequestBody.mjs";
|
package/dist/esm/api/types/WorkOrdersGetWorkOrderTemplatesGatewayTimeoutErrorResponseBody.d.mts
ADDED
|
@@ -0,0 +1,9 @@
|
|
|
1
|
+
/**
|
|
2
|
+
* Gateway timeout
|
|
3
|
+
*/
|
|
4
|
+
export interface WorkOrdersGetWorkOrderTemplatesGatewayTimeoutErrorResponseBody {
|
|
5
|
+
/** Message of error */
|
|
6
|
+
message: string;
|
|
7
|
+
/** The request ID; used when reaching out to support for issues with requests. */
|
|
8
|
+
requestId: string;
|
|
9
|
+
}
|
package/dist/esm/api/types/WorkOrdersGetWorkOrderTemplatesInternalServerErrorResponseBody.d.mts
ADDED
|
@@ -0,0 +1,9 @@
|
|
|
1
|
+
/**
|
|
2
|
+
* An internal server error occurred
|
|
3
|
+
*/
|
|
4
|
+
export interface WorkOrdersGetWorkOrderTemplatesInternalServerErrorResponseBody {
|
|
5
|
+
/** Message of error */
|
|
6
|
+
message: string;
|
|
7
|
+
/** The request ID; used when reaching out to support for issues with requests. */
|
|
8
|
+
requestId: string;
|
|
9
|
+
}
|
package/dist/esm/api/types/WorkOrdersGetWorkOrderTemplatesMethodNotAllowedErrorResponseBody.d.mts
ADDED
|
@@ -0,0 +1,9 @@
|
|
|
1
|
+
/**
|
|
2
|
+
* Method not allowed
|
|
3
|
+
*/
|
|
4
|
+
export interface WorkOrdersGetWorkOrderTemplatesMethodNotAllowedErrorResponseBody {
|
|
5
|
+
/** Message of error */
|
|
6
|
+
message: string;
|
|
7
|
+
/** The request ID; used when reaching out to support for issues with requests. */
|
|
8
|
+
requestId: string;
|
|
9
|
+
}
|
|
@@ -0,0 +1,9 @@
|
|
|
1
|
+
/**
|
|
2
|
+
* Resource not found
|
|
3
|
+
*/
|
|
4
|
+
export interface WorkOrdersGetWorkOrderTemplatesNotFoundErrorResponseBody {
|
|
5
|
+
/** Message of error */
|
|
6
|
+
message: string;
|
|
7
|
+
/** The request ID; used when reaching out to support for issues with requests. */
|
|
8
|
+
requestId: string;
|
|
9
|
+
}
|
package/dist/esm/api/types/WorkOrdersGetWorkOrderTemplatesNotImplementedErrorResponseBody.d.mts
ADDED
|
@@ -0,0 +1,9 @@
|
|
|
1
|
+
/**
|
|
2
|
+
* Requested endpoint is not yet implemented
|
|
3
|
+
*/
|
|
4
|
+
export interface WorkOrdersGetWorkOrderTemplatesNotImplementedErrorResponseBody {
|
|
5
|
+
/** Message of error */
|
|
6
|
+
message: string;
|
|
7
|
+
/** The request ID; used when reaching out to support for issues with requests. */
|
|
8
|
+
requestId: string;
|
|
9
|
+
}
|
package/dist/esm/api/types/WorkOrdersGetWorkOrderTemplatesServiceUnavailableErrorResponseBody.d.mts
ADDED
|
@@ -0,0 +1,9 @@
|
|
|
1
|
+
/**
|
|
2
|
+
* Service unavailable
|
|
3
|
+
*/
|
|
4
|
+
export interface WorkOrdersGetWorkOrderTemplatesServiceUnavailableErrorResponseBody {
|
|
5
|
+
/** Message of error */
|
|
6
|
+
message: string;
|
|
7
|
+
/** The request ID; used when reaching out to support for issues with requests. */
|
|
8
|
+
requestId: string;
|
|
9
|
+
}
|
package/dist/esm/api/types/WorkOrdersGetWorkOrderTemplatesTooManyRequestsErrorResponseBody.d.mts
ADDED
|
@@ -0,0 +1,9 @@
|
|
|
1
|
+
/**
|
|
2
|
+
* Too many requests
|
|
3
|
+
*/
|
|
4
|
+
export interface WorkOrdersGetWorkOrderTemplatesTooManyRequestsErrorResponseBody {
|
|
5
|
+
/** Message of error */
|
|
6
|
+
message: string;
|
|
7
|
+
/** The request ID; used when reaching out to support for issues with requests. */
|
|
8
|
+
requestId: string;
|
|
9
|
+
}
|
|
@@ -3487,6 +3487,16 @@ export * from "./WorkOrdersGetWorkOrdersResponseBody.mjs";
|
|
|
3487
3487
|
export * from "./WorkOrdersGetWorkOrdersServiceUnavailableErrorResponseBody.mjs";
|
|
3488
3488
|
export * from "./WorkOrdersGetWorkOrdersTooManyRequestsErrorResponseBody.mjs";
|
|
3489
3489
|
export * from "./WorkOrdersGetWorkOrdersUnauthorizedErrorResponseBody.mjs";
|
|
3490
|
+
export * from "./WorkOrdersGetWorkOrderTemplatesBadGatewayErrorResponseBody.mjs";
|
|
3491
|
+
export * from "./WorkOrdersGetWorkOrderTemplatesGatewayTimeoutErrorResponseBody.mjs";
|
|
3492
|
+
export * from "./WorkOrdersGetWorkOrderTemplatesInternalServerErrorResponseBody.mjs";
|
|
3493
|
+
export * from "./WorkOrdersGetWorkOrderTemplatesMethodNotAllowedErrorResponseBody.mjs";
|
|
3494
|
+
export * from "./WorkOrdersGetWorkOrderTemplatesNotFoundErrorResponseBody.mjs";
|
|
3495
|
+
export * from "./WorkOrdersGetWorkOrderTemplatesNotImplementedErrorResponseBody.mjs";
|
|
3496
|
+
export * from "./WorkOrdersGetWorkOrderTemplatesResponseBody.mjs";
|
|
3497
|
+
export * from "./WorkOrdersGetWorkOrderTemplatesServiceUnavailableErrorResponseBody.mjs";
|
|
3498
|
+
export * from "./WorkOrdersGetWorkOrderTemplatesTooManyRequestsErrorResponseBody.mjs";
|
|
3499
|
+
export * from "./WorkOrdersGetWorkOrderTemplatesUnauthorizedErrorResponseBody.mjs";
|
|
3490
3500
|
export * from "./WorkOrdersPatchWorkOrdersBadGatewayErrorResponseBody.mjs";
|
|
3491
3501
|
export * from "./WorkOrdersPatchWorkOrdersGatewayTimeoutErrorResponseBody.mjs";
|
|
3492
3502
|
export * from "./WorkOrdersPatchWorkOrdersInternalServerErrorResponseBody.mjs";
|
|
@@ -3530,6 +3540,7 @@ export * from "./WorkOrdersStreamWorkOrdersUnauthorizedErrorResponseBody.mjs";
|
|
|
3530
3540
|
export * from "./WorkOrderTaxCreateObjectRequestBody.mjs";
|
|
3531
3541
|
export * from "./WorkOrderTaxObjectRequestBody.mjs";
|
|
3532
3542
|
export * from "./WorkOrderTaxObjectResponseBody.mjs";
|
|
3543
|
+
export * from "./WorkOrderTemplateObjectResponseBody.mjs";
|
|
3533
3544
|
export * from "./WorkOrderTimeEntryObjectResponseBody.mjs";
|
|
3534
3545
|
export * from "./WorkOrderUnallocatedLaborObjectResponseBody.mjs";
|
|
3535
3546
|
export * from "./WorkOrderWithTimeEntriesObjectResponseBody.mjs";
|
|
@@ -3487,6 +3487,16 @@ export * from "./WorkOrdersGetWorkOrdersResponseBody.mjs";
|
|
|
3487
3487
|
export * from "./WorkOrdersGetWorkOrdersServiceUnavailableErrorResponseBody.mjs";
|
|
3488
3488
|
export * from "./WorkOrdersGetWorkOrdersTooManyRequestsErrorResponseBody.mjs";
|
|
3489
3489
|
export * from "./WorkOrdersGetWorkOrdersUnauthorizedErrorResponseBody.mjs";
|
|
3490
|
+
export * from "./WorkOrdersGetWorkOrderTemplatesBadGatewayErrorResponseBody.mjs";
|
|
3491
|
+
export * from "./WorkOrdersGetWorkOrderTemplatesGatewayTimeoutErrorResponseBody.mjs";
|
|
3492
|
+
export * from "./WorkOrdersGetWorkOrderTemplatesInternalServerErrorResponseBody.mjs";
|
|
3493
|
+
export * from "./WorkOrdersGetWorkOrderTemplatesMethodNotAllowedErrorResponseBody.mjs";
|
|
3494
|
+
export * from "./WorkOrdersGetWorkOrderTemplatesNotFoundErrorResponseBody.mjs";
|
|
3495
|
+
export * from "./WorkOrdersGetWorkOrderTemplatesNotImplementedErrorResponseBody.mjs";
|
|
3496
|
+
export * from "./WorkOrdersGetWorkOrderTemplatesResponseBody.mjs";
|
|
3497
|
+
export * from "./WorkOrdersGetWorkOrderTemplatesServiceUnavailableErrorResponseBody.mjs";
|
|
3498
|
+
export * from "./WorkOrdersGetWorkOrderTemplatesTooManyRequestsErrorResponseBody.mjs";
|
|
3499
|
+
export * from "./WorkOrdersGetWorkOrderTemplatesUnauthorizedErrorResponseBody.mjs";
|
|
3490
3500
|
export * from "./WorkOrdersPatchWorkOrdersBadGatewayErrorResponseBody.mjs";
|
|
3491
3501
|
export * from "./WorkOrdersPatchWorkOrdersGatewayTimeoutErrorResponseBody.mjs";
|
|
3492
3502
|
export * from "./WorkOrdersPatchWorkOrdersInternalServerErrorResponseBody.mjs";
|
|
@@ -3530,6 +3540,7 @@ export * from "./WorkOrdersStreamWorkOrdersUnauthorizedErrorResponseBody.mjs";
|
|
|
3530
3540
|
export * from "./WorkOrderTaxCreateObjectRequestBody.mjs";
|
|
3531
3541
|
export * from "./WorkOrderTaxObjectRequestBody.mjs";
|
|
3532
3542
|
export * from "./WorkOrderTaxObjectResponseBody.mjs";
|
|
3543
|
+
export * from "./WorkOrderTemplateObjectResponseBody.mjs";
|
|
3533
3544
|
export * from "./WorkOrderTimeEntryObjectResponseBody.mjs";
|
|
3534
3545
|
export * from "./WorkOrderUnallocatedLaborObjectResponseBody.mjs";
|
|
3535
3546
|
export * from "./WorkOrderWithTimeEntriesObjectResponseBody.mjs";
|
package/dist/esm/version.d.mts
CHANGED
|
@@ -1 +1 @@
|
|
|
1
|
-
export declare const SDK_VERSION = "13.
|
|
1
|
+
export declare const SDK_VERSION = "13.18.0";
|
package/dist/esm/version.mjs
CHANGED
|
@@ -1 +1 @@
|
|
|
1
|
-
export const SDK_VERSION = "13.
|
|
1
|
+
export const SDK_VERSION = "13.18.0";
|
package/package.json
CHANGED
package/reference.md
CHANGED
|
@@ -3458,6 +3458,76 @@ await client.betaApIs.deleteHubRouteTemplate({
|
|
|
3458
3458
|
</dl>
|
|
3459
3459
|
|
|
3460
3460
|
|
|
3461
|
+
</dd>
|
|
3462
|
+
</dl>
|
|
3463
|
+
</details>
|
|
3464
|
+
|
|
3465
|
+
<details><summary><code>client.betaApIs.<a href="/src/api/resources/betaApIs/client/Client.ts">getWorkOrderTemplates</a>({ ...params }) -> Samsara.WorkOrdersGetWorkOrderTemplatesResponseBody</code></summary>
|
|
3466
|
+
<dl>
|
|
3467
|
+
<dd>
|
|
3468
|
+
|
|
3469
|
+
#### 📝 Description
|
|
3470
|
+
|
|
3471
|
+
<dl>
|
|
3472
|
+
<dd>
|
|
3473
|
+
|
|
3474
|
+
<dl>
|
|
3475
|
+
<dd>
|
|
3476
|
+
|
|
3477
|
+
Gets work order templates by id. Ids that do not resolve to a template (e.g. deleted) are omitted from the response.
|
|
3478
|
+
|
|
3479
|
+
<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>).
|
|
3480
|
+
|
|
3481
|
+
To use this endpoint, select **Read Work Orders** under the Work Orders 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>
|
|
3482
|
+
|
|
3483
|
+
|
|
3484
|
+
**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.
|
|
3485
|
+
</dd>
|
|
3486
|
+
</dl>
|
|
3487
|
+
</dd>
|
|
3488
|
+
</dl>
|
|
3489
|
+
|
|
3490
|
+
#### 🔌 Usage
|
|
3491
|
+
|
|
3492
|
+
<dl>
|
|
3493
|
+
<dd>
|
|
3494
|
+
|
|
3495
|
+
<dl>
|
|
3496
|
+
<dd>
|
|
3497
|
+
|
|
3498
|
+
```typescript
|
|
3499
|
+
await client.betaApIs.getWorkOrderTemplates();
|
|
3500
|
+
|
|
3501
|
+
```
|
|
3502
|
+
</dd>
|
|
3503
|
+
</dl>
|
|
3504
|
+
</dd>
|
|
3505
|
+
</dl>
|
|
3506
|
+
|
|
3507
|
+
#### ⚙️ Parameters
|
|
3508
|
+
|
|
3509
|
+
<dl>
|
|
3510
|
+
<dd>
|
|
3511
|
+
|
|
3512
|
+
<dl>
|
|
3513
|
+
<dd>
|
|
3514
|
+
|
|
3515
|
+
**request:** `Samsara.GetWorkOrderTemplatesRequest`
|
|
3516
|
+
|
|
3517
|
+
</dd>
|
|
3518
|
+
</dl>
|
|
3519
|
+
|
|
3520
|
+
<dl>
|
|
3521
|
+
<dd>
|
|
3522
|
+
|
|
3523
|
+
**requestOptions:** `BetaApIsClient.RequestOptions`
|
|
3524
|
+
|
|
3525
|
+
</dd>
|
|
3526
|
+
</dl>
|
|
3527
|
+
</dd>
|
|
3528
|
+
</dl>
|
|
3529
|
+
|
|
3530
|
+
|
|
3461
3531
|
</dd>
|
|
3462
3532
|
</dl>
|
|
3463
3533
|
</details>
|
|
@@ -4804,6 +4874,7 @@ Readings that currently support ingestion (by category):
|
|
|
4804
4874
|
* `engineHours`
|
|
4805
4875
|
* `engineRpm`
|
|
4806
4876
|
* `engineState` (values: off | running | idling)
|
|
4877
|
+
* `faultCodes`
|
|
4807
4878
|
* `faultCodesJ1939`
|
|
4808
4879
|
* `faultCodesOBDII`
|
|
4809
4880
|
* `fuelLevelPerc`
|
|
@@ -6003,7 +6074,7 @@ To use this endpoint, select **Write Safety Events & Scores** under the Safety &
|
|
|
6003
6074
|
|
|
6004
6075
|
```typescript
|
|
6005
6076
|
await client.betaApIs.patchSafetyEventsV2Batch({
|
|
6006
|
-
safetyEventIds: ["bb2ff5ab-30ad-49ec-9d2d-55ec30bbf590", "bb2ff5ab-30ad-49ec-9d2d-55ec30bbf590", "bb2ff5ab-30ad-49ec-9d2d-55ec30bbf590"]
|
|
6077
|
+
safetyEventIds: ["bb2ff5ab-30ad-49ec-9d2d-55ec30bbf590", "bb2ff5ab-30ad-49ec-9d2d-55ec30bbf590", "bb2ff5ab-30ad-49ec-9d2d-55ec30bbf590", "bb2ff5ab-30ad-49ec-9d2d-55ec30bbf590"]
|
|
6007
6078
|
});
|
|
6008
6079
|
|
|
6009
6080
|
```
|