@samsarahq/samsara 13.25.0 → 13.26.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 +31 -0
- package/dist/cjs/api/resources/betaApIs/client/Client.js +88 -0
- package/dist/cjs/api/resources/betaApIs/client/requests/HubRouteTemplatesCreateHubRouteTemplateRequestBody.d.ts +20 -0
- package/dist/cjs/api/resources/betaApIs/client/requests/HubRouteTemplatesCreateHubRouteTemplateRequestBody.js +3 -0
- package/dist/cjs/api/resources/betaApIs/client/requests/index.d.ts +1 -0
- package/dist/cjs/api/types/CreateHubRouteTemplateDepotEndInputRequestBody.d.ts +7 -0
- package/dist/cjs/api/types/CreateHubRouteTemplateDepotEndInputRequestBody.js +3 -0
- package/dist/cjs/api/types/CreateHubRouteTemplateDepotStartInputRequestBody.d.ts +7 -0
- package/dist/cjs/api/types/CreateHubRouteTemplateDepotStartInputRequestBody.js +3 -0
- package/dist/cjs/api/types/CreateHubRouteTemplateObjectResponseBody.d.ts +26 -0
- package/dist/cjs/api/types/CreateHubRouteTemplateObjectResponseBody.js +3 -0
- package/dist/cjs/api/types/HubRouteTemplateLocationObjectResponseBody.d.ts +0 -2
- package/dist/cjs/api/types/HubRouteTemplateObjectResponseBody.d.ts +2 -2
- package/dist/cjs/api/types/HubRouteTemplatesCreateHubRouteTemplateBadGatewayErrorResponseBody.d.ts +9 -0
- package/dist/cjs/api/types/HubRouteTemplatesCreateHubRouteTemplateBadGatewayErrorResponseBody.js +3 -0
- package/dist/cjs/api/types/HubRouteTemplatesCreateHubRouteTemplateGatewayTimeoutErrorResponseBody.d.ts +9 -0
- package/dist/cjs/api/types/HubRouteTemplatesCreateHubRouteTemplateGatewayTimeoutErrorResponseBody.js +3 -0
- package/dist/cjs/api/types/HubRouteTemplatesCreateHubRouteTemplateInternalServerErrorResponseBody.d.ts +9 -0
- package/dist/cjs/api/types/HubRouteTemplatesCreateHubRouteTemplateInternalServerErrorResponseBody.js +3 -0
- package/dist/cjs/api/types/HubRouteTemplatesCreateHubRouteTemplateMethodNotAllowedErrorResponseBody.d.ts +9 -0
- package/dist/cjs/api/types/HubRouteTemplatesCreateHubRouteTemplateMethodNotAllowedErrorResponseBody.js +3 -0
- package/dist/cjs/api/types/HubRouteTemplatesCreateHubRouteTemplateNotFoundErrorResponseBody.d.ts +9 -0
- package/dist/cjs/api/types/HubRouteTemplatesCreateHubRouteTemplateNotFoundErrorResponseBody.js +3 -0
- package/dist/cjs/api/types/HubRouteTemplatesCreateHubRouteTemplateNotImplementedErrorResponseBody.d.ts +9 -0
- package/dist/cjs/api/types/HubRouteTemplatesCreateHubRouteTemplateNotImplementedErrorResponseBody.js +3 -0
- package/dist/cjs/api/types/HubRouteTemplatesCreateHubRouteTemplateResponseBody.d.ts +4 -0
- package/dist/cjs/api/types/HubRouteTemplatesCreateHubRouteTemplateResponseBody.js +3 -0
- package/dist/cjs/api/types/HubRouteTemplatesCreateHubRouteTemplateServiceUnavailableErrorResponseBody.d.ts +9 -0
- package/dist/cjs/api/types/HubRouteTemplatesCreateHubRouteTemplateServiceUnavailableErrorResponseBody.js +3 -0
- package/dist/cjs/api/types/HubRouteTemplatesCreateHubRouteTemplateTooManyRequestsErrorResponseBody.d.ts +9 -0
- package/dist/cjs/api/types/HubRouteTemplatesCreateHubRouteTemplateTooManyRequestsErrorResponseBody.js +3 -0
- package/dist/cjs/api/types/HubRouteTemplatesCreateHubRouteTemplateUnauthorizedErrorResponseBody.d.ts +9 -0
- package/dist/cjs/api/types/HubRouteTemplatesCreateHubRouteTemplateUnauthorizedErrorResponseBody.js +3 -0
- package/dist/cjs/api/types/index.d.ts +13 -0
- package/dist/cjs/api/types/index.js +13 -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 +31 -0
- package/dist/esm/api/resources/betaApIs/client/Client.mjs +88 -0
- package/dist/esm/api/resources/betaApIs/client/requests/HubRouteTemplatesCreateHubRouteTemplateRequestBody.d.mts +20 -0
- package/dist/esm/api/resources/betaApIs/client/requests/HubRouteTemplatesCreateHubRouteTemplateRequestBody.mjs +2 -0
- package/dist/esm/api/resources/betaApIs/client/requests/index.d.mts +1 -0
- package/dist/esm/api/types/CreateHubRouteTemplateDepotEndInputRequestBody.d.mts +7 -0
- package/dist/esm/api/types/CreateHubRouteTemplateDepotEndInputRequestBody.mjs +2 -0
- package/dist/esm/api/types/CreateHubRouteTemplateDepotStartInputRequestBody.d.mts +7 -0
- package/dist/esm/api/types/CreateHubRouteTemplateDepotStartInputRequestBody.mjs +2 -0
- package/dist/esm/api/types/CreateHubRouteTemplateObjectResponseBody.d.mts +26 -0
- package/dist/esm/api/types/CreateHubRouteTemplateObjectResponseBody.mjs +2 -0
- package/dist/esm/api/types/HubRouteTemplateLocationObjectResponseBody.d.mts +0 -2
- package/dist/esm/api/types/HubRouteTemplateObjectResponseBody.d.mts +2 -2
- package/dist/esm/api/types/HubRouteTemplatesCreateHubRouteTemplateBadGatewayErrorResponseBody.d.mts +9 -0
- package/dist/esm/api/types/HubRouteTemplatesCreateHubRouteTemplateBadGatewayErrorResponseBody.mjs +2 -0
- package/dist/esm/api/types/HubRouteTemplatesCreateHubRouteTemplateGatewayTimeoutErrorResponseBody.d.mts +9 -0
- package/dist/esm/api/types/HubRouteTemplatesCreateHubRouteTemplateGatewayTimeoutErrorResponseBody.mjs +2 -0
- package/dist/esm/api/types/HubRouteTemplatesCreateHubRouteTemplateInternalServerErrorResponseBody.d.mts +9 -0
- package/dist/esm/api/types/HubRouteTemplatesCreateHubRouteTemplateInternalServerErrorResponseBody.mjs +2 -0
- package/dist/esm/api/types/HubRouteTemplatesCreateHubRouteTemplateMethodNotAllowedErrorResponseBody.d.mts +9 -0
- package/dist/esm/api/types/HubRouteTemplatesCreateHubRouteTemplateMethodNotAllowedErrorResponseBody.mjs +2 -0
- package/dist/esm/api/types/HubRouteTemplatesCreateHubRouteTemplateNotFoundErrorResponseBody.d.mts +9 -0
- package/dist/esm/api/types/HubRouteTemplatesCreateHubRouteTemplateNotFoundErrorResponseBody.mjs +2 -0
- package/dist/esm/api/types/HubRouteTemplatesCreateHubRouteTemplateNotImplementedErrorResponseBody.d.mts +9 -0
- package/dist/esm/api/types/HubRouteTemplatesCreateHubRouteTemplateNotImplementedErrorResponseBody.mjs +2 -0
- package/dist/esm/api/types/HubRouteTemplatesCreateHubRouteTemplateResponseBody.d.mts +4 -0
- package/dist/esm/api/types/HubRouteTemplatesCreateHubRouteTemplateResponseBody.mjs +2 -0
- package/dist/esm/api/types/HubRouteTemplatesCreateHubRouteTemplateServiceUnavailableErrorResponseBody.d.mts +9 -0
- package/dist/esm/api/types/HubRouteTemplatesCreateHubRouteTemplateServiceUnavailableErrorResponseBody.mjs +2 -0
- package/dist/esm/api/types/HubRouteTemplatesCreateHubRouteTemplateTooManyRequestsErrorResponseBody.d.mts +9 -0
- package/dist/esm/api/types/HubRouteTemplatesCreateHubRouteTemplateTooManyRequestsErrorResponseBody.mjs +2 -0
- package/dist/esm/api/types/HubRouteTemplatesCreateHubRouteTemplateUnauthorizedErrorResponseBody.d.mts +9 -0
- package/dist/esm/api/types/HubRouteTemplatesCreateHubRouteTemplateUnauthorizedErrorResponseBody.mjs +2 -0
- package/dist/esm/api/types/index.d.mts +13 -0
- package/dist/esm/api/types/index.mjs +13 -0
- package/dist/esm/version.d.mts +1 -1
- package/dist/esm/version.mjs +1 -1
- package/package.json +1 -1
- package/reference.md +73 -0
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.26.0",
|
|
48
|
+
"User-Agent": "@samsarahq/samsara/13.26.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",
|
|
@@ -1357,6 +1357,37 @@ export declare class BetaApIsClient {
|
|
|
1357
1357
|
*/
|
|
1358
1358
|
listHubRouteTemplates(request: Samsara.ListHubRouteTemplatesRequest, requestOptions?: BetaApIsClient.RequestOptions): core.HttpResponsePromise<Samsara.HubRouteTemplatesListHubRouteTemplatesResponseBody>;
|
|
1359
1359
|
private __listHubRouteTemplates;
|
|
1360
|
+
/**
|
|
1361
|
+
* Create a new route template for a hub.
|
|
1362
|
+
*
|
|
1363
|
+
* <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>).
|
|
1364
|
+
*
|
|
1365
|
+
* To use this endpoint, select **Write Routes** under the Driver Workflow 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>
|
|
1366
|
+
*
|
|
1367
|
+
*
|
|
1368
|
+
* **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.
|
|
1369
|
+
*
|
|
1370
|
+
* @param {Samsara.HubRouteTemplatesCreateHubRouteTemplateRequestBody} request
|
|
1371
|
+
* @param {BetaApIsClient.RequestOptions} requestOptions - Request-specific configuration.
|
|
1372
|
+
*
|
|
1373
|
+
* @throws {@link Samsara.UnauthorizedError}
|
|
1374
|
+
* @throws {@link Samsara.NotFoundError}
|
|
1375
|
+
* @throws {@link Samsara.MethodNotAllowedError}
|
|
1376
|
+
* @throws {@link Samsara.TooManyRequestsError}
|
|
1377
|
+
* @throws {@link Samsara.InternalServerError}
|
|
1378
|
+
* @throws {@link Samsara.NotImplementedError}
|
|
1379
|
+
* @throws {@link Samsara.BadGatewayError}
|
|
1380
|
+
* @throws {@link Samsara.ServiceUnavailableError}
|
|
1381
|
+
* @throws {@link Samsara.GatewayTimeoutError}
|
|
1382
|
+
*
|
|
1383
|
+
* @example
|
|
1384
|
+
* await client.betaApIs.createHubRouteTemplate({
|
|
1385
|
+
* hubId: "550e8400-e29b-41d4-a716-446655440000",
|
|
1386
|
+
* name: "Downtown Delivery Route"
|
|
1387
|
+
* })
|
|
1388
|
+
*/
|
|
1389
|
+
createHubRouteTemplate(request: Samsara.HubRouteTemplatesCreateHubRouteTemplateRequestBody, requestOptions?: BetaApIsClient.RequestOptions): core.HttpResponsePromise<Samsara.HubRouteTemplatesCreateHubRouteTemplateResponseBody>;
|
|
1390
|
+
private __createHubRouteTemplate;
|
|
1360
1391
|
/**
|
|
1361
1392
|
* Delete a route template by its unique identifier.
|
|
1362
1393
|
*
|
|
@@ -3984,6 +3984,94 @@ class BetaApIsClient {
|
|
|
3984
3984
|
return (0, handleNonStatusCodeError_js_1.handleNonStatusCodeError)(_response.error, _response.rawResponse, "GET", "/hub/route-templates");
|
|
3985
3985
|
});
|
|
3986
3986
|
}
|
|
3987
|
+
/**
|
|
3988
|
+
* Create a new route template for a hub.
|
|
3989
|
+
*
|
|
3990
|
+
* <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>).
|
|
3991
|
+
*
|
|
3992
|
+
* To use this endpoint, select **Write Routes** under the Driver Workflow 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>
|
|
3993
|
+
*
|
|
3994
|
+
*
|
|
3995
|
+
* **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.
|
|
3996
|
+
*
|
|
3997
|
+
* @param {Samsara.HubRouteTemplatesCreateHubRouteTemplateRequestBody} request
|
|
3998
|
+
* @param {BetaApIsClient.RequestOptions} requestOptions - Request-specific configuration.
|
|
3999
|
+
*
|
|
4000
|
+
* @throws {@link Samsara.UnauthorizedError}
|
|
4001
|
+
* @throws {@link Samsara.NotFoundError}
|
|
4002
|
+
* @throws {@link Samsara.MethodNotAllowedError}
|
|
4003
|
+
* @throws {@link Samsara.TooManyRequestsError}
|
|
4004
|
+
* @throws {@link Samsara.InternalServerError}
|
|
4005
|
+
* @throws {@link Samsara.NotImplementedError}
|
|
4006
|
+
* @throws {@link Samsara.BadGatewayError}
|
|
4007
|
+
* @throws {@link Samsara.ServiceUnavailableError}
|
|
4008
|
+
* @throws {@link Samsara.GatewayTimeoutError}
|
|
4009
|
+
*
|
|
4010
|
+
* @example
|
|
4011
|
+
* await client.betaApIs.createHubRouteTemplate({
|
|
4012
|
+
* hubId: "550e8400-e29b-41d4-a716-446655440000",
|
|
4013
|
+
* name: "Downtown Delivery Route"
|
|
4014
|
+
* })
|
|
4015
|
+
*/
|
|
4016
|
+
createHubRouteTemplate(request, requestOptions) {
|
|
4017
|
+
return core.HttpResponsePromise.fromPromise(this.__createHubRouteTemplate(request, requestOptions));
|
|
4018
|
+
}
|
|
4019
|
+
__createHubRouteTemplate(request, requestOptions) {
|
|
4020
|
+
return __awaiter(this, void 0, void 0, function* () {
|
|
4021
|
+
var _a, _b, _c, _d, _e, _f, _g, _h, _j;
|
|
4022
|
+
const _authRequest = yield this._options.authProvider.getAuthRequest();
|
|
4023
|
+
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);
|
|
4024
|
+
const _response = yield core.fetcher({
|
|
4025
|
+
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, "hub/route-templates"),
|
|
4026
|
+
method: "POST",
|
|
4027
|
+
headers: _headers,
|
|
4028
|
+
contentType: "application/json",
|
|
4029
|
+
queryParameters: requestOptions === null || requestOptions === void 0 ? void 0 : requestOptions.queryParams,
|
|
4030
|
+
requestType: "json",
|
|
4031
|
+
body: request,
|
|
4032
|
+
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,
|
|
4033
|
+
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,
|
|
4034
|
+
abortSignal: requestOptions === null || requestOptions === void 0 ? void 0 : requestOptions.abortSignal,
|
|
4035
|
+
fetchFn: (_j = this._options) === null || _j === void 0 ? void 0 : _j.fetch,
|
|
4036
|
+
logging: this._options.logging,
|
|
4037
|
+
});
|
|
4038
|
+
if (_response.ok) {
|
|
4039
|
+
return {
|
|
4040
|
+
data: _response.body,
|
|
4041
|
+
rawResponse: _response.rawResponse,
|
|
4042
|
+
};
|
|
4043
|
+
}
|
|
4044
|
+
if (_response.error.reason === "status-code") {
|
|
4045
|
+
switch (_response.error.statusCode) {
|
|
4046
|
+
case 401:
|
|
4047
|
+
throw new Samsara.UnauthorizedError(_response.error.body, _response.rawResponse);
|
|
4048
|
+
case 404:
|
|
4049
|
+
throw new Samsara.NotFoundError(_response.error.body, _response.rawResponse);
|
|
4050
|
+
case 405:
|
|
4051
|
+
throw new Samsara.MethodNotAllowedError(_response.error.body, _response.rawResponse);
|
|
4052
|
+
case 429:
|
|
4053
|
+
throw new Samsara.TooManyRequestsError(_response.error.body, _response.rawResponse);
|
|
4054
|
+
case 500:
|
|
4055
|
+
throw new Samsara.InternalServerError(_response.error.body, _response.rawResponse);
|
|
4056
|
+
case 501:
|
|
4057
|
+
throw new Samsara.NotImplementedError(_response.error.body, _response.rawResponse);
|
|
4058
|
+
case 502:
|
|
4059
|
+
throw new Samsara.BadGatewayError(_response.error.body, _response.rawResponse);
|
|
4060
|
+
case 503:
|
|
4061
|
+
throw new Samsara.ServiceUnavailableError(_response.error.body, _response.rawResponse);
|
|
4062
|
+
case 504:
|
|
4063
|
+
throw new Samsara.GatewayTimeoutError(_response.error.body, _response.rawResponse);
|
|
4064
|
+
default:
|
|
4065
|
+
throw new errors.SamsaraError({
|
|
4066
|
+
statusCode: _response.error.statusCode,
|
|
4067
|
+
body: _response.error.body,
|
|
4068
|
+
rawResponse: _response.rawResponse,
|
|
4069
|
+
});
|
|
4070
|
+
}
|
|
4071
|
+
}
|
|
4072
|
+
return (0, handleNonStatusCodeError_js_1.handleNonStatusCodeError)(_response.error, _response.rawResponse, "POST", "/hub/route-templates");
|
|
4073
|
+
});
|
|
4074
|
+
}
|
|
3987
4075
|
/**
|
|
3988
4076
|
* Delete a route template by its unique identifier.
|
|
3989
4077
|
*
|
|
@@ -0,0 +1,20 @@
|
|
|
1
|
+
import type * as Samsara from "../../../../index.js";
|
|
2
|
+
/**
|
|
3
|
+
* @example
|
|
4
|
+
* {
|
|
5
|
+
* hubId: "550e8400-e29b-41d4-a716-446655440000",
|
|
6
|
+
* name: "Downtown Delivery Route"
|
|
7
|
+
* }
|
|
8
|
+
*/
|
|
9
|
+
export interface HubRouteTemplatesCreateHubRouteTemplateRequestBody {
|
|
10
|
+
defaultDepotEnd?: Samsara.CreateHubRouteTemplateDepotEndInputRequestBody;
|
|
11
|
+
defaultDepotStart?: Samsara.CreateHubRouteTemplateDepotStartInputRequestBody;
|
|
12
|
+
/** Default start time in HH:MM format in the hub's local timezone (e.g. '08:00'). */
|
|
13
|
+
defaultStartTimeOfDay?: string;
|
|
14
|
+
/** The ID of the hub. */
|
|
15
|
+
hubId: string;
|
|
16
|
+
/** Stop locations referenced by external ID, in the order they should be visited. */
|
|
17
|
+
locationExternalIds?: string[];
|
|
18
|
+
/** The name of the route template. */
|
|
19
|
+
name: string;
|
|
20
|
+
}
|
|
@@ -47,6 +47,7 @@ export type { GetVoiceSessionsRequest } from "./GetVoiceSessionsRequest.js";
|
|
|
47
47
|
export type { GetVoiceSessionsStreamRequest } from "./GetVoiceSessionsStreamRequest.js";
|
|
48
48
|
export type { GetWorkOrderTemplatesRequest } from "./GetWorkOrderTemplatesRequest.js";
|
|
49
49
|
export type { HosDailyLogsUpdateShippingDocsRequestBody } from "./HosDailyLogsUpdateShippingDocsRequestBody.js";
|
|
50
|
+
export type { HubRouteTemplatesCreateHubRouteTemplateRequestBody } from "./HubRouteTemplatesCreateHubRouteTemplateRequestBody.js";
|
|
50
51
|
export type { JobsCreateJobRequestBody } from "./JobsCreateJobRequestBody.js";
|
|
51
52
|
export type { JobsPatchJobRequestBody } from "./JobsPatchJobRequestBody.js";
|
|
52
53
|
export type { ListDeviceRecoveryMissingAssetsRequest } from "./ListDeviceRecoveryMissingAssetsRequest.js";
|
|
@@ -0,0 +1,26 @@
|
|
|
1
|
+
import type * as Samsara from "../index.js";
|
|
2
|
+
/**
|
|
3
|
+
* A newly created route template.
|
|
4
|
+
*/
|
|
5
|
+
export interface CreateHubRouteTemplateObjectResponseBody {
|
|
6
|
+
/** The timestamp when the route template was created, in RFC 3339 format. */
|
|
7
|
+
createdAtTime: string;
|
|
8
|
+
defaultDepotEnd?: Samsara.HubRouteTemplateDepotObjectResponseBody | undefined;
|
|
9
|
+
defaultDepotStart?: Samsara.HubRouteTemplateDepotObjectResponseBody | undefined;
|
|
10
|
+
/** Default start time of day for the route template, in HH:MM format in the hub's local timezone (e.g. '08:00'). */
|
|
11
|
+
defaultStartTimeOfDay?: string | undefined;
|
|
12
|
+
/** Total distance of the route in meters. */
|
|
13
|
+
distanceMeters: number;
|
|
14
|
+
/** Total duration of the route in seconds. */
|
|
15
|
+
durationSeconds: number;
|
|
16
|
+
/** The hub identifier this route template belongs to. */
|
|
17
|
+
hubId: string;
|
|
18
|
+
/** The unique identifier for the route template. */
|
|
19
|
+
id: string;
|
|
20
|
+
/** Ordered list of stop locations in the route template. */
|
|
21
|
+
locations: Samsara.HubRouteTemplateLocationObjectResponseBody[];
|
|
22
|
+
/** The name of the route template. */
|
|
23
|
+
name: string;
|
|
24
|
+
/** The timestamp when the route template was last updated, in RFC 3339 format. */
|
|
25
|
+
updatedAtTime: string;
|
|
26
|
+
}
|
|
@@ -6,8 +6,6 @@ export interface HubRouteTemplateLocationObjectResponseBody {
|
|
|
6
6
|
externalId?: string | undefined;
|
|
7
7
|
/** The formatted address of the location. */
|
|
8
8
|
formattedAddress: string;
|
|
9
|
-
/** The unique identifier for the location. */
|
|
10
|
-
id: string;
|
|
11
9
|
/** Latitude coordinate of the location. */
|
|
12
10
|
latitude: number;
|
|
13
11
|
/** Longitude coordinate of the location. */
|
|
@@ -7,12 +7,12 @@ export interface HubRouteTemplateObjectResponseBody {
|
|
|
7
7
|
createdAtTime: string;
|
|
8
8
|
defaultDepotEnd?: Samsara.HubRouteTemplateDepotObjectResponseBody | undefined;
|
|
9
9
|
defaultDepotStart?: Samsara.HubRouteTemplateDepotObjectResponseBody | undefined;
|
|
10
|
+
/** Default start time of day for the route template, in HH:MM format in the hub's local timezone (e.g. '08:00'). */
|
|
11
|
+
defaultStartTimeOfDay?: string | undefined;
|
|
10
12
|
/** Total distance of the route in meters. */
|
|
11
13
|
distanceMeters: number;
|
|
12
14
|
/** Total duration of the route in seconds. */
|
|
13
15
|
durationSeconds: number;
|
|
14
|
-
/** Default start time of day for the route template, in HH:MM format in the hub's local timezone (e.g. '08:00'). */
|
|
15
|
-
earliestStartTime?: string | undefined;
|
|
16
16
|
/** The hub identifier this route template belongs to. */
|
|
17
17
|
hubId: string;
|
|
18
18
|
/** The IANA timezone of the hub (e.g. 'America/Los_Angeles'). */
|
package/dist/cjs/api/types/HubRouteTemplatesCreateHubRouteTemplateBadGatewayErrorResponseBody.d.ts
ADDED
|
@@ -0,0 +1,9 @@
|
|
|
1
|
+
/**
|
|
2
|
+
* Bad Gateway
|
|
3
|
+
*/
|
|
4
|
+
export interface HubRouteTemplatesCreateHubRouteTemplateBadGatewayErrorResponseBody {
|
|
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
|
+
* Gateway timeout
|
|
3
|
+
*/
|
|
4
|
+
export interface HubRouteTemplatesCreateHubRouteTemplateGatewayTimeoutErrorResponseBody {
|
|
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
|
+
* An internal server error occurred
|
|
3
|
+
*/
|
|
4
|
+
export interface HubRouteTemplatesCreateHubRouteTemplateInternalServerErrorResponseBody {
|
|
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
|
+
* Method not allowed
|
|
3
|
+
*/
|
|
4
|
+
export interface HubRouteTemplatesCreateHubRouteTemplateMethodNotAllowedErrorResponseBody {
|
|
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/HubRouteTemplatesCreateHubRouteTemplateNotFoundErrorResponseBody.d.ts
ADDED
|
@@ -0,0 +1,9 @@
|
|
|
1
|
+
/**
|
|
2
|
+
* Resource not found
|
|
3
|
+
*/
|
|
4
|
+
export interface HubRouteTemplatesCreateHubRouteTemplateNotFoundErrorResponseBody {
|
|
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
|
+
* Requested endpoint is not yet implemented
|
|
3
|
+
*/
|
|
4
|
+
export interface HubRouteTemplatesCreateHubRouteTemplateNotImplementedErrorResponseBody {
|
|
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
|
+
* Service unavailable
|
|
3
|
+
*/
|
|
4
|
+
export interface HubRouteTemplatesCreateHubRouteTemplateServiceUnavailableErrorResponseBody {
|
|
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
|
+
* Too many requests
|
|
3
|
+
*/
|
|
4
|
+
export interface HubRouteTemplatesCreateHubRouteTemplateTooManyRequestsErrorResponseBody {
|
|
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/HubRouteTemplatesCreateHubRouteTemplateUnauthorizedErrorResponseBody.d.ts
ADDED
|
@@ -0,0 +1,9 @@
|
|
|
1
|
+
/**
|
|
2
|
+
* Unauthorized
|
|
3
|
+
*/
|
|
4
|
+
export interface HubRouteTemplatesCreateHubRouteTemplateUnauthorizedErrorResponseBody {
|
|
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
|
+
}
|
|
@@ -315,6 +315,9 @@ export * from "./CreateDriverRequestAttributes.js";
|
|
|
315
315
|
export * from "./CreateFunctionDetailResponseBody.js";
|
|
316
316
|
export * from "./CreateFunctionRequestConfigRequestBody.js";
|
|
317
317
|
export * from "./CreateFunctionStorageFileDetailResponseBody.js";
|
|
318
|
+
export * from "./CreateHubRouteTemplateDepotEndInputRequestBody.js";
|
|
319
|
+
export * from "./CreateHubRouteTemplateDepotStartInputRequestBody.js";
|
|
320
|
+
export * from "./CreateHubRouteTemplateObjectResponseBody.js";
|
|
318
321
|
export * from "./CreateReportConfigColumnRequestBody.js";
|
|
319
322
|
export * from "./CreateReportConfigObjectRequestBody.js";
|
|
320
323
|
export * from "./CreateRoutesStopRequestObjectRequestBody.js";
|
|
@@ -1541,6 +1544,16 @@ export * from "./HubPlansListHubPlansUnauthorizedErrorResponseBody.js";
|
|
|
1541
1544
|
export * from "./HubRouteTemplateDepotObjectResponseBody.js";
|
|
1542
1545
|
export * from "./HubRouteTemplateLocationObjectResponseBody.js";
|
|
1543
1546
|
export * from "./HubRouteTemplateObjectResponseBody.js";
|
|
1547
|
+
export * from "./HubRouteTemplatesCreateHubRouteTemplateBadGatewayErrorResponseBody.js";
|
|
1548
|
+
export * from "./HubRouteTemplatesCreateHubRouteTemplateGatewayTimeoutErrorResponseBody.js";
|
|
1549
|
+
export * from "./HubRouteTemplatesCreateHubRouteTemplateInternalServerErrorResponseBody.js";
|
|
1550
|
+
export * from "./HubRouteTemplatesCreateHubRouteTemplateMethodNotAllowedErrorResponseBody.js";
|
|
1551
|
+
export * from "./HubRouteTemplatesCreateHubRouteTemplateNotFoundErrorResponseBody.js";
|
|
1552
|
+
export * from "./HubRouteTemplatesCreateHubRouteTemplateNotImplementedErrorResponseBody.js";
|
|
1553
|
+
export * from "./HubRouteTemplatesCreateHubRouteTemplateResponseBody.js";
|
|
1554
|
+
export * from "./HubRouteTemplatesCreateHubRouteTemplateServiceUnavailableErrorResponseBody.js";
|
|
1555
|
+
export * from "./HubRouteTemplatesCreateHubRouteTemplateTooManyRequestsErrorResponseBody.js";
|
|
1556
|
+
export * from "./HubRouteTemplatesCreateHubRouteTemplateUnauthorizedErrorResponseBody.js";
|
|
1544
1557
|
export * from "./HubRouteTemplatesDeleteHubRouteTemplateBadGatewayErrorResponseBody.js";
|
|
1545
1558
|
export * from "./HubRouteTemplatesDeleteHubRouteTemplateGatewayTimeoutErrorResponseBody.js";
|
|
1546
1559
|
export * from "./HubRouteTemplatesDeleteHubRouteTemplateInternalServerErrorResponseBody.js";
|
|
@@ -331,6 +331,9 @@ __exportStar(require("./CreateDriverRequestAttributes.js"), exports);
|
|
|
331
331
|
__exportStar(require("./CreateFunctionDetailResponseBody.js"), exports);
|
|
332
332
|
__exportStar(require("./CreateFunctionRequestConfigRequestBody.js"), exports);
|
|
333
333
|
__exportStar(require("./CreateFunctionStorageFileDetailResponseBody.js"), exports);
|
|
334
|
+
__exportStar(require("./CreateHubRouteTemplateDepotEndInputRequestBody.js"), exports);
|
|
335
|
+
__exportStar(require("./CreateHubRouteTemplateDepotStartInputRequestBody.js"), exports);
|
|
336
|
+
__exportStar(require("./CreateHubRouteTemplateObjectResponseBody.js"), exports);
|
|
334
337
|
__exportStar(require("./CreateReportConfigColumnRequestBody.js"), exports);
|
|
335
338
|
__exportStar(require("./CreateReportConfigObjectRequestBody.js"), exports);
|
|
336
339
|
__exportStar(require("./CreateRoutesStopRequestObjectRequestBody.js"), exports);
|
|
@@ -1557,6 +1560,16 @@ __exportStar(require("./HubPlansListHubPlansUnauthorizedErrorResponseBody.js"),
|
|
|
1557
1560
|
__exportStar(require("./HubRouteTemplateDepotObjectResponseBody.js"), exports);
|
|
1558
1561
|
__exportStar(require("./HubRouteTemplateLocationObjectResponseBody.js"), exports);
|
|
1559
1562
|
__exportStar(require("./HubRouteTemplateObjectResponseBody.js"), exports);
|
|
1563
|
+
__exportStar(require("./HubRouteTemplatesCreateHubRouteTemplateBadGatewayErrorResponseBody.js"), exports);
|
|
1564
|
+
__exportStar(require("./HubRouteTemplatesCreateHubRouteTemplateGatewayTimeoutErrorResponseBody.js"), exports);
|
|
1565
|
+
__exportStar(require("./HubRouteTemplatesCreateHubRouteTemplateInternalServerErrorResponseBody.js"), exports);
|
|
1566
|
+
__exportStar(require("./HubRouteTemplatesCreateHubRouteTemplateMethodNotAllowedErrorResponseBody.js"), exports);
|
|
1567
|
+
__exportStar(require("./HubRouteTemplatesCreateHubRouteTemplateNotFoundErrorResponseBody.js"), exports);
|
|
1568
|
+
__exportStar(require("./HubRouteTemplatesCreateHubRouteTemplateNotImplementedErrorResponseBody.js"), exports);
|
|
1569
|
+
__exportStar(require("./HubRouteTemplatesCreateHubRouteTemplateResponseBody.js"), exports);
|
|
1570
|
+
__exportStar(require("./HubRouteTemplatesCreateHubRouteTemplateServiceUnavailableErrorResponseBody.js"), exports);
|
|
1571
|
+
__exportStar(require("./HubRouteTemplatesCreateHubRouteTemplateTooManyRequestsErrorResponseBody.js"), exports);
|
|
1572
|
+
__exportStar(require("./HubRouteTemplatesCreateHubRouteTemplateUnauthorizedErrorResponseBody.js"), exports);
|
|
1560
1573
|
__exportStar(require("./HubRouteTemplatesDeleteHubRouteTemplateBadGatewayErrorResponseBody.js"), exports);
|
|
1561
1574
|
__exportStar(require("./HubRouteTemplatesDeleteHubRouteTemplateGatewayTimeoutErrorResponseBody.js"), exports);
|
|
1562
1575
|
__exportStar(require("./HubRouteTemplatesDeleteHubRouteTemplateInternalServerErrorResponseBody.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.26.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.26.0",
|
|
11
|
+
"User-Agent": "@samsarahq/samsara/13.26.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",
|
|
@@ -1357,6 +1357,37 @@ export declare class BetaApIsClient {
|
|
|
1357
1357
|
*/
|
|
1358
1358
|
listHubRouteTemplates(request: Samsara.ListHubRouteTemplatesRequest, requestOptions?: BetaApIsClient.RequestOptions): core.HttpResponsePromise<Samsara.HubRouteTemplatesListHubRouteTemplatesResponseBody>;
|
|
1359
1359
|
private __listHubRouteTemplates;
|
|
1360
|
+
/**
|
|
1361
|
+
* Create a new route template for a hub.
|
|
1362
|
+
*
|
|
1363
|
+
* <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>).
|
|
1364
|
+
*
|
|
1365
|
+
* To use this endpoint, select **Write Routes** under the Driver Workflow 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>
|
|
1366
|
+
*
|
|
1367
|
+
*
|
|
1368
|
+
* **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.
|
|
1369
|
+
*
|
|
1370
|
+
* @param {Samsara.HubRouteTemplatesCreateHubRouteTemplateRequestBody} request
|
|
1371
|
+
* @param {BetaApIsClient.RequestOptions} requestOptions - Request-specific configuration.
|
|
1372
|
+
*
|
|
1373
|
+
* @throws {@link Samsara.UnauthorizedError}
|
|
1374
|
+
* @throws {@link Samsara.NotFoundError}
|
|
1375
|
+
* @throws {@link Samsara.MethodNotAllowedError}
|
|
1376
|
+
* @throws {@link Samsara.TooManyRequestsError}
|
|
1377
|
+
* @throws {@link Samsara.InternalServerError}
|
|
1378
|
+
* @throws {@link Samsara.NotImplementedError}
|
|
1379
|
+
* @throws {@link Samsara.BadGatewayError}
|
|
1380
|
+
* @throws {@link Samsara.ServiceUnavailableError}
|
|
1381
|
+
* @throws {@link Samsara.GatewayTimeoutError}
|
|
1382
|
+
*
|
|
1383
|
+
* @example
|
|
1384
|
+
* await client.betaApIs.createHubRouteTemplate({
|
|
1385
|
+
* hubId: "550e8400-e29b-41d4-a716-446655440000",
|
|
1386
|
+
* name: "Downtown Delivery Route"
|
|
1387
|
+
* })
|
|
1388
|
+
*/
|
|
1389
|
+
createHubRouteTemplate(request: Samsara.HubRouteTemplatesCreateHubRouteTemplateRequestBody, requestOptions?: BetaApIsClient.RequestOptions): core.HttpResponsePromise<Samsara.HubRouteTemplatesCreateHubRouteTemplateResponseBody>;
|
|
1390
|
+
private __createHubRouteTemplate;
|
|
1360
1391
|
/**
|
|
1361
1392
|
* Delete a route template by its unique identifier.
|
|
1362
1393
|
*
|
|
@@ -3948,6 +3948,94 @@ export class BetaApIsClient {
|
|
|
3948
3948
|
return handleNonStatusCodeError(_response.error, _response.rawResponse, "GET", "/hub/route-templates");
|
|
3949
3949
|
});
|
|
3950
3950
|
}
|
|
3951
|
+
/**
|
|
3952
|
+
* Create a new route template for a hub.
|
|
3953
|
+
*
|
|
3954
|
+
* <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>).
|
|
3955
|
+
*
|
|
3956
|
+
* To use this endpoint, select **Write Routes** under the Driver Workflow 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>
|
|
3957
|
+
*
|
|
3958
|
+
*
|
|
3959
|
+
* **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.
|
|
3960
|
+
*
|
|
3961
|
+
* @param {Samsara.HubRouteTemplatesCreateHubRouteTemplateRequestBody} request
|
|
3962
|
+
* @param {BetaApIsClient.RequestOptions} requestOptions - Request-specific configuration.
|
|
3963
|
+
*
|
|
3964
|
+
* @throws {@link Samsara.UnauthorizedError}
|
|
3965
|
+
* @throws {@link Samsara.NotFoundError}
|
|
3966
|
+
* @throws {@link Samsara.MethodNotAllowedError}
|
|
3967
|
+
* @throws {@link Samsara.TooManyRequestsError}
|
|
3968
|
+
* @throws {@link Samsara.InternalServerError}
|
|
3969
|
+
* @throws {@link Samsara.NotImplementedError}
|
|
3970
|
+
* @throws {@link Samsara.BadGatewayError}
|
|
3971
|
+
* @throws {@link Samsara.ServiceUnavailableError}
|
|
3972
|
+
* @throws {@link Samsara.GatewayTimeoutError}
|
|
3973
|
+
*
|
|
3974
|
+
* @example
|
|
3975
|
+
* await client.betaApIs.createHubRouteTemplate({
|
|
3976
|
+
* hubId: "550e8400-e29b-41d4-a716-446655440000",
|
|
3977
|
+
* name: "Downtown Delivery Route"
|
|
3978
|
+
* })
|
|
3979
|
+
*/
|
|
3980
|
+
createHubRouteTemplate(request, requestOptions) {
|
|
3981
|
+
return core.HttpResponsePromise.fromPromise(this.__createHubRouteTemplate(request, requestOptions));
|
|
3982
|
+
}
|
|
3983
|
+
__createHubRouteTemplate(request, requestOptions) {
|
|
3984
|
+
return __awaiter(this, void 0, void 0, function* () {
|
|
3985
|
+
var _a, _b, _c, _d, _e, _f, _g, _h, _j;
|
|
3986
|
+
const _authRequest = yield this._options.authProvider.getAuthRequest();
|
|
3987
|
+
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);
|
|
3988
|
+
const _response = yield core.fetcher({
|
|
3989
|
+
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, "hub/route-templates"),
|
|
3990
|
+
method: "POST",
|
|
3991
|
+
headers: _headers,
|
|
3992
|
+
contentType: "application/json",
|
|
3993
|
+
queryParameters: requestOptions === null || requestOptions === void 0 ? void 0 : requestOptions.queryParams,
|
|
3994
|
+
requestType: "json",
|
|
3995
|
+
body: request,
|
|
3996
|
+
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,
|
|
3997
|
+
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,
|
|
3998
|
+
abortSignal: requestOptions === null || requestOptions === void 0 ? void 0 : requestOptions.abortSignal,
|
|
3999
|
+
fetchFn: (_j = this._options) === null || _j === void 0 ? void 0 : _j.fetch,
|
|
4000
|
+
logging: this._options.logging,
|
|
4001
|
+
});
|
|
4002
|
+
if (_response.ok) {
|
|
4003
|
+
return {
|
|
4004
|
+
data: _response.body,
|
|
4005
|
+
rawResponse: _response.rawResponse,
|
|
4006
|
+
};
|
|
4007
|
+
}
|
|
4008
|
+
if (_response.error.reason === "status-code") {
|
|
4009
|
+
switch (_response.error.statusCode) {
|
|
4010
|
+
case 401:
|
|
4011
|
+
throw new Samsara.UnauthorizedError(_response.error.body, _response.rawResponse);
|
|
4012
|
+
case 404:
|
|
4013
|
+
throw new Samsara.NotFoundError(_response.error.body, _response.rawResponse);
|
|
4014
|
+
case 405:
|
|
4015
|
+
throw new Samsara.MethodNotAllowedError(_response.error.body, _response.rawResponse);
|
|
4016
|
+
case 429:
|
|
4017
|
+
throw new Samsara.TooManyRequestsError(_response.error.body, _response.rawResponse);
|
|
4018
|
+
case 500:
|
|
4019
|
+
throw new Samsara.InternalServerError(_response.error.body, _response.rawResponse);
|
|
4020
|
+
case 501:
|
|
4021
|
+
throw new Samsara.NotImplementedError(_response.error.body, _response.rawResponse);
|
|
4022
|
+
case 502:
|
|
4023
|
+
throw new Samsara.BadGatewayError(_response.error.body, _response.rawResponse);
|
|
4024
|
+
case 503:
|
|
4025
|
+
throw new Samsara.ServiceUnavailableError(_response.error.body, _response.rawResponse);
|
|
4026
|
+
case 504:
|
|
4027
|
+
throw new Samsara.GatewayTimeoutError(_response.error.body, _response.rawResponse);
|
|
4028
|
+
default:
|
|
4029
|
+
throw new errors.SamsaraError({
|
|
4030
|
+
statusCode: _response.error.statusCode,
|
|
4031
|
+
body: _response.error.body,
|
|
4032
|
+
rawResponse: _response.rawResponse,
|
|
4033
|
+
});
|
|
4034
|
+
}
|
|
4035
|
+
}
|
|
4036
|
+
return handleNonStatusCodeError(_response.error, _response.rawResponse, "POST", "/hub/route-templates");
|
|
4037
|
+
});
|
|
4038
|
+
}
|
|
3951
4039
|
/**
|
|
3952
4040
|
* Delete a route template by its unique identifier.
|
|
3953
4041
|
*
|
|
@@ -0,0 +1,20 @@
|
|
|
1
|
+
import type * as Samsara from "../../../../index.mjs";
|
|
2
|
+
/**
|
|
3
|
+
* @example
|
|
4
|
+
* {
|
|
5
|
+
* hubId: "550e8400-e29b-41d4-a716-446655440000",
|
|
6
|
+
* name: "Downtown Delivery Route"
|
|
7
|
+
* }
|
|
8
|
+
*/
|
|
9
|
+
export interface HubRouteTemplatesCreateHubRouteTemplateRequestBody {
|
|
10
|
+
defaultDepotEnd?: Samsara.CreateHubRouteTemplateDepotEndInputRequestBody;
|
|
11
|
+
defaultDepotStart?: Samsara.CreateHubRouteTemplateDepotStartInputRequestBody;
|
|
12
|
+
/** Default start time in HH:MM format in the hub's local timezone (e.g. '08:00'). */
|
|
13
|
+
defaultStartTimeOfDay?: string;
|
|
14
|
+
/** The ID of the hub. */
|
|
15
|
+
hubId: string;
|
|
16
|
+
/** Stop locations referenced by external ID, in the order they should be visited. */
|
|
17
|
+
locationExternalIds?: string[];
|
|
18
|
+
/** The name of the route template. */
|
|
19
|
+
name: string;
|
|
20
|
+
}
|
|
@@ -47,6 +47,7 @@ export type { GetVoiceSessionsRequest } from "./GetVoiceSessionsRequest.mjs";
|
|
|
47
47
|
export type { GetVoiceSessionsStreamRequest } from "./GetVoiceSessionsStreamRequest.mjs";
|
|
48
48
|
export type { GetWorkOrderTemplatesRequest } from "./GetWorkOrderTemplatesRequest.mjs";
|
|
49
49
|
export type { HosDailyLogsUpdateShippingDocsRequestBody } from "./HosDailyLogsUpdateShippingDocsRequestBody.mjs";
|
|
50
|
+
export type { HubRouteTemplatesCreateHubRouteTemplateRequestBody } from "./HubRouteTemplatesCreateHubRouteTemplateRequestBody.mjs";
|
|
50
51
|
export type { JobsCreateJobRequestBody } from "./JobsCreateJobRequestBody.mjs";
|
|
51
52
|
export type { JobsPatchJobRequestBody } from "./JobsPatchJobRequestBody.mjs";
|
|
52
53
|
export type { ListDeviceRecoveryMissingAssetsRequest } from "./ListDeviceRecoveryMissingAssetsRequest.mjs";
|
|
@@ -0,0 +1,26 @@
|
|
|
1
|
+
import type * as Samsara from "../index.mjs";
|
|
2
|
+
/**
|
|
3
|
+
* A newly created route template.
|
|
4
|
+
*/
|
|
5
|
+
export interface CreateHubRouteTemplateObjectResponseBody {
|
|
6
|
+
/** The timestamp when the route template was created, in RFC 3339 format. */
|
|
7
|
+
createdAtTime: string;
|
|
8
|
+
defaultDepotEnd?: Samsara.HubRouteTemplateDepotObjectResponseBody | undefined;
|
|
9
|
+
defaultDepotStart?: Samsara.HubRouteTemplateDepotObjectResponseBody | undefined;
|
|
10
|
+
/** Default start time of day for the route template, in HH:MM format in the hub's local timezone (e.g. '08:00'). */
|
|
11
|
+
defaultStartTimeOfDay?: string | undefined;
|
|
12
|
+
/** Total distance of the route in meters. */
|
|
13
|
+
distanceMeters: number;
|
|
14
|
+
/** Total duration of the route in seconds. */
|
|
15
|
+
durationSeconds: number;
|
|
16
|
+
/** The hub identifier this route template belongs to. */
|
|
17
|
+
hubId: string;
|
|
18
|
+
/** The unique identifier for the route template. */
|
|
19
|
+
id: string;
|
|
20
|
+
/** Ordered list of stop locations in the route template. */
|
|
21
|
+
locations: Samsara.HubRouteTemplateLocationObjectResponseBody[];
|
|
22
|
+
/** The name of the route template. */
|
|
23
|
+
name: string;
|
|
24
|
+
/** The timestamp when the route template was last updated, in RFC 3339 format. */
|
|
25
|
+
updatedAtTime: string;
|
|
26
|
+
}
|
|
@@ -6,8 +6,6 @@ export interface HubRouteTemplateLocationObjectResponseBody {
|
|
|
6
6
|
externalId?: string | undefined;
|
|
7
7
|
/** The formatted address of the location. */
|
|
8
8
|
formattedAddress: string;
|
|
9
|
-
/** The unique identifier for the location. */
|
|
10
|
-
id: string;
|
|
11
9
|
/** Latitude coordinate of the location. */
|
|
12
10
|
latitude: number;
|
|
13
11
|
/** Longitude coordinate of the location. */
|
|
@@ -7,12 +7,12 @@ export interface HubRouteTemplateObjectResponseBody {
|
|
|
7
7
|
createdAtTime: string;
|
|
8
8
|
defaultDepotEnd?: Samsara.HubRouteTemplateDepotObjectResponseBody | undefined;
|
|
9
9
|
defaultDepotStart?: Samsara.HubRouteTemplateDepotObjectResponseBody | undefined;
|
|
10
|
+
/** Default start time of day for the route template, in HH:MM format in the hub's local timezone (e.g. '08:00'). */
|
|
11
|
+
defaultStartTimeOfDay?: string | undefined;
|
|
10
12
|
/** Total distance of the route in meters. */
|
|
11
13
|
distanceMeters: number;
|
|
12
14
|
/** Total duration of the route in seconds. */
|
|
13
15
|
durationSeconds: number;
|
|
14
|
-
/** Default start time of day for the route template, in HH:MM format in the hub's local timezone (e.g. '08:00'). */
|
|
15
|
-
earliestStartTime?: string | undefined;
|
|
16
16
|
/** The hub identifier this route template belongs to. */
|
|
17
17
|
hubId: string;
|
|
18
18
|
/** The IANA timezone of the hub (e.g. 'America/Los_Angeles'). */
|
package/dist/esm/api/types/HubRouteTemplatesCreateHubRouteTemplateBadGatewayErrorResponseBody.d.mts
ADDED
|
@@ -0,0 +1,9 @@
|
|
|
1
|
+
/**
|
|
2
|
+
* Bad Gateway
|
|
3
|
+
*/
|
|
4
|
+
export interface HubRouteTemplatesCreateHubRouteTemplateBadGatewayErrorResponseBody {
|
|
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
|
+
* Gateway timeout
|
|
3
|
+
*/
|
|
4
|
+
export interface HubRouteTemplatesCreateHubRouteTemplateGatewayTimeoutErrorResponseBody {
|
|
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
|
+
* An internal server error occurred
|
|
3
|
+
*/
|
|
4
|
+
export interface HubRouteTemplatesCreateHubRouteTemplateInternalServerErrorResponseBody {
|
|
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
|
+
* Method not allowed
|
|
3
|
+
*/
|
|
4
|
+
export interface HubRouteTemplatesCreateHubRouteTemplateMethodNotAllowedErrorResponseBody {
|
|
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/HubRouteTemplatesCreateHubRouteTemplateNotFoundErrorResponseBody.d.mts
ADDED
|
@@ -0,0 +1,9 @@
|
|
|
1
|
+
/**
|
|
2
|
+
* Resource not found
|
|
3
|
+
*/
|
|
4
|
+
export interface HubRouteTemplatesCreateHubRouteTemplateNotFoundErrorResponseBody {
|
|
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
|
+
* Requested endpoint is not yet implemented
|
|
3
|
+
*/
|
|
4
|
+
export interface HubRouteTemplatesCreateHubRouteTemplateNotImplementedErrorResponseBody {
|
|
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
|
+
* Service unavailable
|
|
3
|
+
*/
|
|
4
|
+
export interface HubRouteTemplatesCreateHubRouteTemplateServiceUnavailableErrorResponseBody {
|
|
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
|
+
* Too many requests
|
|
3
|
+
*/
|
|
4
|
+
export interface HubRouteTemplatesCreateHubRouteTemplateTooManyRequestsErrorResponseBody {
|
|
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
|
+
* Unauthorized
|
|
3
|
+
*/
|
|
4
|
+
export interface HubRouteTemplatesCreateHubRouteTemplateUnauthorizedErrorResponseBody {
|
|
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
|
+
}
|
|
@@ -315,6 +315,9 @@ export * from "./CreateDriverRequestAttributes.mjs";
|
|
|
315
315
|
export * from "./CreateFunctionDetailResponseBody.mjs";
|
|
316
316
|
export * from "./CreateFunctionRequestConfigRequestBody.mjs";
|
|
317
317
|
export * from "./CreateFunctionStorageFileDetailResponseBody.mjs";
|
|
318
|
+
export * from "./CreateHubRouteTemplateDepotEndInputRequestBody.mjs";
|
|
319
|
+
export * from "./CreateHubRouteTemplateDepotStartInputRequestBody.mjs";
|
|
320
|
+
export * from "./CreateHubRouteTemplateObjectResponseBody.mjs";
|
|
318
321
|
export * from "./CreateReportConfigColumnRequestBody.mjs";
|
|
319
322
|
export * from "./CreateReportConfigObjectRequestBody.mjs";
|
|
320
323
|
export * from "./CreateRoutesStopRequestObjectRequestBody.mjs";
|
|
@@ -1541,6 +1544,16 @@ export * from "./HubPlansListHubPlansUnauthorizedErrorResponseBody.mjs";
|
|
|
1541
1544
|
export * from "./HubRouteTemplateDepotObjectResponseBody.mjs";
|
|
1542
1545
|
export * from "./HubRouteTemplateLocationObjectResponseBody.mjs";
|
|
1543
1546
|
export * from "./HubRouteTemplateObjectResponseBody.mjs";
|
|
1547
|
+
export * from "./HubRouteTemplatesCreateHubRouteTemplateBadGatewayErrorResponseBody.mjs";
|
|
1548
|
+
export * from "./HubRouteTemplatesCreateHubRouteTemplateGatewayTimeoutErrorResponseBody.mjs";
|
|
1549
|
+
export * from "./HubRouteTemplatesCreateHubRouteTemplateInternalServerErrorResponseBody.mjs";
|
|
1550
|
+
export * from "./HubRouteTemplatesCreateHubRouteTemplateMethodNotAllowedErrorResponseBody.mjs";
|
|
1551
|
+
export * from "./HubRouteTemplatesCreateHubRouteTemplateNotFoundErrorResponseBody.mjs";
|
|
1552
|
+
export * from "./HubRouteTemplatesCreateHubRouteTemplateNotImplementedErrorResponseBody.mjs";
|
|
1553
|
+
export * from "./HubRouteTemplatesCreateHubRouteTemplateResponseBody.mjs";
|
|
1554
|
+
export * from "./HubRouteTemplatesCreateHubRouteTemplateServiceUnavailableErrorResponseBody.mjs";
|
|
1555
|
+
export * from "./HubRouteTemplatesCreateHubRouteTemplateTooManyRequestsErrorResponseBody.mjs";
|
|
1556
|
+
export * from "./HubRouteTemplatesCreateHubRouteTemplateUnauthorizedErrorResponseBody.mjs";
|
|
1544
1557
|
export * from "./HubRouteTemplatesDeleteHubRouteTemplateBadGatewayErrorResponseBody.mjs";
|
|
1545
1558
|
export * from "./HubRouteTemplatesDeleteHubRouteTemplateGatewayTimeoutErrorResponseBody.mjs";
|
|
1546
1559
|
export * from "./HubRouteTemplatesDeleteHubRouteTemplateInternalServerErrorResponseBody.mjs";
|
|
@@ -315,6 +315,9 @@ export * from "./CreateDriverRequestAttributes.mjs";
|
|
|
315
315
|
export * from "./CreateFunctionDetailResponseBody.mjs";
|
|
316
316
|
export * from "./CreateFunctionRequestConfigRequestBody.mjs";
|
|
317
317
|
export * from "./CreateFunctionStorageFileDetailResponseBody.mjs";
|
|
318
|
+
export * from "./CreateHubRouteTemplateDepotEndInputRequestBody.mjs";
|
|
319
|
+
export * from "./CreateHubRouteTemplateDepotStartInputRequestBody.mjs";
|
|
320
|
+
export * from "./CreateHubRouteTemplateObjectResponseBody.mjs";
|
|
318
321
|
export * from "./CreateReportConfigColumnRequestBody.mjs";
|
|
319
322
|
export * from "./CreateReportConfigObjectRequestBody.mjs";
|
|
320
323
|
export * from "./CreateRoutesStopRequestObjectRequestBody.mjs";
|
|
@@ -1541,6 +1544,16 @@ export * from "./HubPlansListHubPlansUnauthorizedErrorResponseBody.mjs";
|
|
|
1541
1544
|
export * from "./HubRouteTemplateDepotObjectResponseBody.mjs";
|
|
1542
1545
|
export * from "./HubRouteTemplateLocationObjectResponseBody.mjs";
|
|
1543
1546
|
export * from "./HubRouteTemplateObjectResponseBody.mjs";
|
|
1547
|
+
export * from "./HubRouteTemplatesCreateHubRouteTemplateBadGatewayErrorResponseBody.mjs";
|
|
1548
|
+
export * from "./HubRouteTemplatesCreateHubRouteTemplateGatewayTimeoutErrorResponseBody.mjs";
|
|
1549
|
+
export * from "./HubRouteTemplatesCreateHubRouteTemplateInternalServerErrorResponseBody.mjs";
|
|
1550
|
+
export * from "./HubRouteTemplatesCreateHubRouteTemplateMethodNotAllowedErrorResponseBody.mjs";
|
|
1551
|
+
export * from "./HubRouteTemplatesCreateHubRouteTemplateNotFoundErrorResponseBody.mjs";
|
|
1552
|
+
export * from "./HubRouteTemplatesCreateHubRouteTemplateNotImplementedErrorResponseBody.mjs";
|
|
1553
|
+
export * from "./HubRouteTemplatesCreateHubRouteTemplateResponseBody.mjs";
|
|
1554
|
+
export * from "./HubRouteTemplatesCreateHubRouteTemplateServiceUnavailableErrorResponseBody.mjs";
|
|
1555
|
+
export * from "./HubRouteTemplatesCreateHubRouteTemplateTooManyRequestsErrorResponseBody.mjs";
|
|
1556
|
+
export * from "./HubRouteTemplatesCreateHubRouteTemplateUnauthorizedErrorResponseBody.mjs";
|
|
1544
1557
|
export * from "./HubRouteTemplatesDeleteHubRouteTemplateBadGatewayErrorResponseBody.mjs";
|
|
1545
1558
|
export * from "./HubRouteTemplatesDeleteHubRouteTemplateGatewayTimeoutErrorResponseBody.mjs";
|
|
1546
1559
|
export * from "./HubRouteTemplatesDeleteHubRouteTemplateInternalServerErrorResponseBody.mjs";
|
package/dist/esm/version.d.mts
CHANGED
|
@@ -1 +1 @@
|
|
|
1
|
-
export declare const SDK_VERSION = "13.
|
|
1
|
+
export declare const SDK_VERSION = "13.26.0";
|
package/dist/esm/version.mjs
CHANGED
|
@@ -1 +1 @@
|
|
|
1
|
-
export const SDK_VERSION = "13.
|
|
1
|
+
export const SDK_VERSION = "13.26.0";
|
package/package.json
CHANGED
package/reference.md
CHANGED
|
@@ -3559,6 +3559,79 @@ await client.betaApIs.listHubRouteTemplates({
|
|
|
3559
3559
|
</dl>
|
|
3560
3560
|
|
|
3561
3561
|
|
|
3562
|
+
</dd>
|
|
3563
|
+
</dl>
|
|
3564
|
+
</details>
|
|
3565
|
+
|
|
3566
|
+
<details><summary><code>client.betaApIs.<a href="/src/api/resources/betaApIs/client/Client.ts">createHubRouteTemplate</a>({ ...params }) -> Samsara.HubRouteTemplatesCreateHubRouteTemplateResponseBody</code></summary>
|
|
3567
|
+
<dl>
|
|
3568
|
+
<dd>
|
|
3569
|
+
|
|
3570
|
+
#### 📝 Description
|
|
3571
|
+
|
|
3572
|
+
<dl>
|
|
3573
|
+
<dd>
|
|
3574
|
+
|
|
3575
|
+
<dl>
|
|
3576
|
+
<dd>
|
|
3577
|
+
|
|
3578
|
+
Create a new route template for a hub.
|
|
3579
|
+
|
|
3580
|
+
<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>).
|
|
3581
|
+
|
|
3582
|
+
To use this endpoint, select **Write Routes** under the Driver Workflow 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>
|
|
3583
|
+
|
|
3584
|
+
|
|
3585
|
+
**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.
|
|
3586
|
+
</dd>
|
|
3587
|
+
</dl>
|
|
3588
|
+
</dd>
|
|
3589
|
+
</dl>
|
|
3590
|
+
|
|
3591
|
+
#### 🔌 Usage
|
|
3592
|
+
|
|
3593
|
+
<dl>
|
|
3594
|
+
<dd>
|
|
3595
|
+
|
|
3596
|
+
<dl>
|
|
3597
|
+
<dd>
|
|
3598
|
+
|
|
3599
|
+
```typescript
|
|
3600
|
+
await client.betaApIs.createHubRouteTemplate({
|
|
3601
|
+
hubId: "550e8400-e29b-41d4-a716-446655440000",
|
|
3602
|
+
name: "Downtown Delivery Route"
|
|
3603
|
+
});
|
|
3604
|
+
|
|
3605
|
+
```
|
|
3606
|
+
</dd>
|
|
3607
|
+
</dl>
|
|
3608
|
+
</dd>
|
|
3609
|
+
</dl>
|
|
3610
|
+
|
|
3611
|
+
#### ⚙️ Parameters
|
|
3612
|
+
|
|
3613
|
+
<dl>
|
|
3614
|
+
<dd>
|
|
3615
|
+
|
|
3616
|
+
<dl>
|
|
3617
|
+
<dd>
|
|
3618
|
+
|
|
3619
|
+
**request:** `Samsara.HubRouteTemplatesCreateHubRouteTemplateRequestBody`
|
|
3620
|
+
|
|
3621
|
+
</dd>
|
|
3622
|
+
</dl>
|
|
3623
|
+
|
|
3624
|
+
<dl>
|
|
3625
|
+
<dd>
|
|
3626
|
+
|
|
3627
|
+
**requestOptions:** `BetaApIsClient.RequestOptions`
|
|
3628
|
+
|
|
3629
|
+
</dd>
|
|
3630
|
+
</dl>
|
|
3631
|
+
</dd>
|
|
3632
|
+
</dl>
|
|
3633
|
+
|
|
3634
|
+
|
|
3562
3635
|
</dd>
|
|
3563
3636
|
</dl>
|
|
3564
3637
|
</details>
|