@samsarahq/samsara 11.9.0 → 11.10.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 -0
- package/dist/cjs/api/resources/betaApIs/client/Client.js +92 -0
- package/dist/cjs/api/resources/betaApIs/client/requests/ListHubRouteTemplatesRequest.d.ts +18 -0
- package/dist/cjs/api/resources/betaApIs/client/requests/ListHubRouteTemplatesRequest.js +3 -0
- package/dist/cjs/api/resources/betaApIs/client/requests/index.d.ts +1 -0
- package/dist/cjs/api/types/HubRouteTemplateDepotObjectResponseBody.d.ts +17 -0
- package/dist/cjs/api/types/HubRouteTemplateDepotObjectResponseBody.js +3 -0
- package/dist/cjs/api/types/HubRouteTemplateLocationObjectResponseBody.d.ts +19 -0
- package/dist/cjs/api/types/HubRouteTemplateLocationObjectResponseBody.js +3 -0
- package/dist/cjs/api/types/HubRouteTemplateObjectResponseBody.d.ts +28 -0
- package/dist/cjs/api/types/HubRouteTemplateObjectResponseBody.js +3 -0
- package/dist/cjs/api/types/HubRouteTemplatesListHubRouteTemplatesBadGatewayErrorResponseBody.d.ts +9 -0
- package/dist/cjs/api/types/HubRouteTemplatesListHubRouteTemplatesBadGatewayErrorResponseBody.js +3 -0
- package/dist/cjs/api/types/HubRouteTemplatesListHubRouteTemplatesGatewayTimeoutErrorResponseBody.d.ts +9 -0
- package/dist/cjs/api/types/HubRouteTemplatesListHubRouteTemplatesGatewayTimeoutErrorResponseBody.js +3 -0
- package/dist/cjs/api/types/HubRouteTemplatesListHubRouteTemplatesInternalServerErrorResponseBody.d.ts +9 -0
- package/dist/cjs/api/types/HubRouteTemplatesListHubRouteTemplatesInternalServerErrorResponseBody.js +3 -0
- package/dist/cjs/api/types/HubRouteTemplatesListHubRouteTemplatesMethodNotAllowedErrorResponseBody.d.ts +9 -0
- package/dist/cjs/api/types/HubRouteTemplatesListHubRouteTemplatesMethodNotAllowedErrorResponseBody.js +3 -0
- package/dist/cjs/api/types/HubRouteTemplatesListHubRouteTemplatesNotFoundErrorResponseBody.d.ts +9 -0
- package/dist/cjs/api/types/HubRouteTemplatesListHubRouteTemplatesNotFoundErrorResponseBody.js +3 -0
- package/dist/cjs/api/types/HubRouteTemplatesListHubRouteTemplatesNotImplementedErrorResponseBody.d.ts +9 -0
- package/dist/cjs/api/types/HubRouteTemplatesListHubRouteTemplatesNotImplementedErrorResponseBody.js +3 -0
- package/dist/cjs/api/types/HubRouteTemplatesListHubRouteTemplatesResponseBody.d.ts +6 -0
- package/dist/cjs/api/types/HubRouteTemplatesListHubRouteTemplatesResponseBody.js +3 -0
- package/dist/cjs/api/types/HubRouteTemplatesListHubRouteTemplatesServiceUnavailableErrorResponseBody.d.ts +9 -0
- package/dist/cjs/api/types/HubRouteTemplatesListHubRouteTemplatesServiceUnavailableErrorResponseBody.js +3 -0
- package/dist/cjs/api/types/HubRouteTemplatesListHubRouteTemplatesTooManyRequestsErrorResponseBody.d.ts +9 -0
- package/dist/cjs/api/types/HubRouteTemplatesListHubRouteTemplatesTooManyRequestsErrorResponseBody.js +3 -0
- package/dist/cjs/api/types/HubRouteTemplatesListHubRouteTemplatesUnauthorizedErrorResponseBody.d.ts +9 -0
- package/dist/cjs/api/types/HubRouteTemplatesListHubRouteTemplatesUnauthorizedErrorResponseBody.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 +30 -0
- package/dist/esm/api/resources/betaApIs/client/Client.mjs +92 -0
- package/dist/esm/api/resources/betaApIs/client/requests/ListHubRouteTemplatesRequest.d.mts +18 -0
- package/dist/esm/api/resources/betaApIs/client/requests/ListHubRouteTemplatesRequest.mjs +2 -0
- package/dist/esm/api/resources/betaApIs/client/requests/index.d.mts +1 -0
- package/dist/esm/api/types/HubRouteTemplateDepotObjectResponseBody.d.mts +17 -0
- package/dist/esm/api/types/HubRouteTemplateDepotObjectResponseBody.mjs +2 -0
- package/dist/esm/api/types/HubRouteTemplateLocationObjectResponseBody.d.mts +19 -0
- package/dist/esm/api/types/HubRouteTemplateLocationObjectResponseBody.mjs +2 -0
- package/dist/esm/api/types/HubRouteTemplateObjectResponseBody.d.mts +28 -0
- package/dist/esm/api/types/HubRouteTemplateObjectResponseBody.mjs +2 -0
- package/dist/esm/api/types/HubRouteTemplatesListHubRouteTemplatesBadGatewayErrorResponseBody.d.mts +9 -0
- package/dist/esm/api/types/HubRouteTemplatesListHubRouteTemplatesBadGatewayErrorResponseBody.mjs +2 -0
- package/dist/esm/api/types/HubRouteTemplatesListHubRouteTemplatesGatewayTimeoutErrorResponseBody.d.mts +9 -0
- package/dist/esm/api/types/HubRouteTemplatesListHubRouteTemplatesGatewayTimeoutErrorResponseBody.mjs +2 -0
- package/dist/esm/api/types/HubRouteTemplatesListHubRouteTemplatesInternalServerErrorResponseBody.d.mts +9 -0
- package/dist/esm/api/types/HubRouteTemplatesListHubRouteTemplatesInternalServerErrorResponseBody.mjs +2 -0
- package/dist/esm/api/types/HubRouteTemplatesListHubRouteTemplatesMethodNotAllowedErrorResponseBody.d.mts +9 -0
- package/dist/esm/api/types/HubRouteTemplatesListHubRouteTemplatesMethodNotAllowedErrorResponseBody.mjs +2 -0
- package/dist/esm/api/types/HubRouteTemplatesListHubRouteTemplatesNotFoundErrorResponseBody.d.mts +9 -0
- package/dist/esm/api/types/HubRouteTemplatesListHubRouteTemplatesNotFoundErrorResponseBody.mjs +2 -0
- package/dist/esm/api/types/HubRouteTemplatesListHubRouteTemplatesNotImplementedErrorResponseBody.d.mts +9 -0
- package/dist/esm/api/types/HubRouteTemplatesListHubRouteTemplatesNotImplementedErrorResponseBody.mjs +2 -0
- package/dist/esm/api/types/HubRouteTemplatesListHubRouteTemplatesResponseBody.d.mts +6 -0
- package/dist/esm/api/types/HubRouteTemplatesListHubRouteTemplatesResponseBody.mjs +2 -0
- package/dist/esm/api/types/HubRouteTemplatesListHubRouteTemplatesServiceUnavailableErrorResponseBody.d.mts +9 -0
- package/dist/esm/api/types/HubRouteTemplatesListHubRouteTemplatesServiceUnavailableErrorResponseBody.mjs +2 -0
- package/dist/esm/api/types/HubRouteTemplatesListHubRouteTemplatesTooManyRequestsErrorResponseBody.d.mts +9 -0
- package/dist/esm/api/types/HubRouteTemplatesListHubRouteTemplatesTooManyRequestsErrorResponseBody.mjs +2 -0
- package/dist/esm/api/types/HubRouteTemplatesListHubRouteTemplatesUnauthorizedErrorResponseBody.d.mts +9 -0
- package/dist/esm/api/types/HubRouteTemplatesListHubRouteTemplatesUnauthorizedErrorResponseBody.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 +72 -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": "11.
|
|
48
|
-
"User-Agent": "@samsarahq/samsara/11.
|
|
47
|
+
"X-Fern-SDK-Version": "11.10.0",
|
|
48
|
+
"User-Agent": "@samsarahq/samsara/11.10.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",
|
|
@@ -1192,6 +1192,36 @@ export declare class BetaApIsClient {
|
|
|
1192
1192
|
*/
|
|
1193
1193
|
deletePlanOrders(request: Samsara.DeletePlanOrdersRequest, requestOptions?: BetaApIsClient.RequestOptions): core.HttpResponsePromise<void>;
|
|
1194
1194
|
private __deletePlanOrders;
|
|
1195
|
+
/**
|
|
1196
|
+
* Retrieve route templates for a specific hub. Optionally filter by route template ID or name.
|
|
1197
|
+
*
|
|
1198
|
+
* <b>Rate limit:</b> 10 requests/sec (learn more about rate limits <a href="https://developers.samsara.com/docs/rate-limits" target="_blank">here</a>).
|
|
1199
|
+
*
|
|
1200
|
+
* To use this endpoint, select **Read 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>
|
|
1201
|
+
*
|
|
1202
|
+
*
|
|
1203
|
+
* **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.
|
|
1204
|
+
*
|
|
1205
|
+
* @param {Samsara.ListHubRouteTemplatesRequest} request
|
|
1206
|
+
* @param {BetaApIsClient.RequestOptions} requestOptions - Request-specific configuration.
|
|
1207
|
+
*
|
|
1208
|
+
* @throws {@link Samsara.UnauthorizedError}
|
|
1209
|
+
* @throws {@link Samsara.NotFoundError}
|
|
1210
|
+
* @throws {@link Samsara.MethodNotAllowedError}
|
|
1211
|
+
* @throws {@link Samsara.TooManyRequestsError}
|
|
1212
|
+
* @throws {@link Samsara.InternalServerError}
|
|
1213
|
+
* @throws {@link Samsara.NotImplementedError}
|
|
1214
|
+
* @throws {@link Samsara.BadGatewayError}
|
|
1215
|
+
* @throws {@link Samsara.ServiceUnavailableError}
|
|
1216
|
+
* @throws {@link Samsara.GatewayTimeoutError}
|
|
1217
|
+
*
|
|
1218
|
+
* @example
|
|
1219
|
+
* await client.betaApIs.listHubRouteTemplates({
|
|
1220
|
+
* hubId: "hubId"
|
|
1221
|
+
* })
|
|
1222
|
+
*/
|
|
1223
|
+
listHubRouteTemplates(request: Samsara.ListHubRouteTemplatesRequest, requestOptions?: BetaApIsClient.RequestOptions): core.HttpResponsePromise<Samsara.HubRouteTemplatesListHubRouteTemplatesResponseBody>;
|
|
1224
|
+
private __listHubRouteTemplates;
|
|
1195
1225
|
/**
|
|
1196
1226
|
* Returns qualification records for the specified list of IDs.
|
|
1197
1227
|
*
|
|
@@ -3525,6 +3525,98 @@ class BetaApIsClient {
|
|
|
3525
3525
|
return (0, handleNonStatusCodeError_js_1.handleNonStatusCodeError)(_response.error, _response.rawResponse, "DELETE", "/hub/plan/orders");
|
|
3526
3526
|
});
|
|
3527
3527
|
}
|
|
3528
|
+
/**
|
|
3529
|
+
* Retrieve route templates for a specific hub. Optionally filter by route template ID or name.
|
|
3530
|
+
*
|
|
3531
|
+
* <b>Rate limit:</b> 10 requests/sec (learn more about rate limits <a href="https://developers.samsara.com/docs/rate-limits" target="_blank">here</a>).
|
|
3532
|
+
*
|
|
3533
|
+
* To use this endpoint, select **Read 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>
|
|
3534
|
+
*
|
|
3535
|
+
*
|
|
3536
|
+
* **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.
|
|
3537
|
+
*
|
|
3538
|
+
* @param {Samsara.ListHubRouteTemplatesRequest} request
|
|
3539
|
+
* @param {BetaApIsClient.RequestOptions} requestOptions - Request-specific configuration.
|
|
3540
|
+
*
|
|
3541
|
+
* @throws {@link Samsara.UnauthorizedError}
|
|
3542
|
+
* @throws {@link Samsara.NotFoundError}
|
|
3543
|
+
* @throws {@link Samsara.MethodNotAllowedError}
|
|
3544
|
+
* @throws {@link Samsara.TooManyRequestsError}
|
|
3545
|
+
* @throws {@link Samsara.InternalServerError}
|
|
3546
|
+
* @throws {@link Samsara.NotImplementedError}
|
|
3547
|
+
* @throws {@link Samsara.BadGatewayError}
|
|
3548
|
+
* @throws {@link Samsara.ServiceUnavailableError}
|
|
3549
|
+
* @throws {@link Samsara.GatewayTimeoutError}
|
|
3550
|
+
*
|
|
3551
|
+
* @example
|
|
3552
|
+
* await client.betaApIs.listHubRouteTemplates({
|
|
3553
|
+
* hubId: "hubId"
|
|
3554
|
+
* })
|
|
3555
|
+
*/
|
|
3556
|
+
listHubRouteTemplates(request, requestOptions) {
|
|
3557
|
+
return core.HttpResponsePromise.fromPromise(this.__listHubRouteTemplates(request, requestOptions));
|
|
3558
|
+
}
|
|
3559
|
+
__listHubRouteTemplates(request, requestOptions) {
|
|
3560
|
+
return __awaiter(this, void 0, void 0, function* () {
|
|
3561
|
+
var _a, _b, _c, _d, _e, _f, _g, _h, _j;
|
|
3562
|
+
const { hubId, id, name, after, limit } = request;
|
|
3563
|
+
const _queryParams = {
|
|
3564
|
+
hubId,
|
|
3565
|
+
id,
|
|
3566
|
+
name,
|
|
3567
|
+
after,
|
|
3568
|
+
limit,
|
|
3569
|
+
};
|
|
3570
|
+
const _authRequest = yield this._options.authProvider.getAuthRequest();
|
|
3571
|
+
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);
|
|
3572
|
+
const _response = yield core.fetcher({
|
|
3573
|
+
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"),
|
|
3574
|
+
method: "GET",
|
|
3575
|
+
headers: _headers,
|
|
3576
|
+
queryParameters: Object.assign(Object.assign({}, _queryParams), requestOptions === null || requestOptions === void 0 ? void 0 : requestOptions.queryParams),
|
|
3577
|
+
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,
|
|
3578
|
+
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,
|
|
3579
|
+
abortSignal: requestOptions === null || requestOptions === void 0 ? void 0 : requestOptions.abortSignal,
|
|
3580
|
+
fetchFn: (_j = this._options) === null || _j === void 0 ? void 0 : _j.fetch,
|
|
3581
|
+
logging: this._options.logging,
|
|
3582
|
+
});
|
|
3583
|
+
if (_response.ok) {
|
|
3584
|
+
return {
|
|
3585
|
+
data: _response.body,
|
|
3586
|
+
rawResponse: _response.rawResponse,
|
|
3587
|
+
};
|
|
3588
|
+
}
|
|
3589
|
+
if (_response.error.reason === "status-code") {
|
|
3590
|
+
switch (_response.error.statusCode) {
|
|
3591
|
+
case 401:
|
|
3592
|
+
throw new Samsara.UnauthorizedError(_response.error.body, _response.rawResponse);
|
|
3593
|
+
case 404:
|
|
3594
|
+
throw new Samsara.NotFoundError(_response.error.body, _response.rawResponse);
|
|
3595
|
+
case 405:
|
|
3596
|
+
throw new Samsara.MethodNotAllowedError(_response.error.body, _response.rawResponse);
|
|
3597
|
+
case 429:
|
|
3598
|
+
throw new Samsara.TooManyRequestsError(_response.error.body, _response.rawResponse);
|
|
3599
|
+
case 500:
|
|
3600
|
+
throw new Samsara.InternalServerError(_response.error.body, _response.rawResponse);
|
|
3601
|
+
case 501:
|
|
3602
|
+
throw new Samsara.NotImplementedError(_response.error.body, _response.rawResponse);
|
|
3603
|
+
case 502:
|
|
3604
|
+
throw new Samsara.BadGatewayError(_response.error.body, _response.rawResponse);
|
|
3605
|
+
case 503:
|
|
3606
|
+
throw new Samsara.ServiceUnavailableError(_response.error.body, _response.rawResponse);
|
|
3607
|
+
case 504:
|
|
3608
|
+
throw new Samsara.GatewayTimeoutError(_response.error.body, _response.rawResponse);
|
|
3609
|
+
default:
|
|
3610
|
+
throw new errors.SamsaraError({
|
|
3611
|
+
statusCode: _response.error.statusCode,
|
|
3612
|
+
body: _response.error.body,
|
|
3613
|
+
rawResponse: _response.rawResponse,
|
|
3614
|
+
});
|
|
3615
|
+
}
|
|
3616
|
+
}
|
|
3617
|
+
return (0, handleNonStatusCodeError_js_1.handleNonStatusCodeError)(_response.error, _response.rawResponse, "GET", "/hub/route-templates");
|
|
3618
|
+
});
|
|
3619
|
+
}
|
|
3528
3620
|
/**
|
|
3529
3621
|
* Returns qualification records for the specified list of IDs.
|
|
3530
3622
|
*
|
|
@@ -0,0 +1,18 @@
|
|
|
1
|
+
/**
|
|
2
|
+
* @example
|
|
3
|
+
* {
|
|
4
|
+
* hubId: "hubId"
|
|
5
|
+
* }
|
|
6
|
+
*/
|
|
7
|
+
export interface ListHubRouteTemplatesRequest {
|
|
8
|
+
/** The hub identifier. */
|
|
9
|
+
hubId: string;
|
|
10
|
+
/** Filter by a specific route template ID. */
|
|
11
|
+
id?: string;
|
|
12
|
+
/** Filter by route template name (exact match). */
|
|
13
|
+
name?: string;
|
|
14
|
+
/** If specified, this should be the endCursor value from the previous page of results. When present, this request will return the next page of results that occur immediately after the previous page of results. */
|
|
15
|
+
after?: string;
|
|
16
|
+
/** The limit for how many objects will be in the response. Default and max for this value is 100 objects. */
|
|
17
|
+
limit?: number;
|
|
18
|
+
}
|
|
@@ -44,6 +44,7 @@ export type { ListAssetAssignmentsRequest } from "./ListAssetAssignmentsRequest.
|
|
|
44
44
|
export type { ListAssociationsRequest } from "./ListAssociationsRequest.js";
|
|
45
45
|
export type { ListDeviceRecoveryMissingAssetsRequest } from "./ListDeviceRecoveryMissingAssetsRequest.js";
|
|
46
46
|
export type { ListHubCustomPropertiesRequest } from "./ListHubCustomPropertiesRequest.js";
|
|
47
|
+
export type { ListHubRouteTemplatesRequest } from "./ListHubRouteTemplatesRequest.js";
|
|
47
48
|
export type { ListMaintenanceVendorsRequest } from "./ListMaintenanceVendorsRequest.js";
|
|
48
49
|
export type { ListPlanOrdersRequest } from "./ListPlanOrdersRequest.js";
|
|
49
50
|
export type { ListRidershipAccountsRequest } from "./ListRidershipAccountsRequest.js";
|
|
@@ -0,0 +1,17 @@
|
|
|
1
|
+
/**
|
|
2
|
+
* A depot location for a route template.
|
|
3
|
+
*/
|
|
4
|
+
export interface HubRouteTemplateDepotObjectResponseBody {
|
|
5
|
+
/** The customer-provided external identifier for the depot location. */
|
|
6
|
+
externalId?: string | undefined;
|
|
7
|
+
/** The formatted address of the depot location. */
|
|
8
|
+
formattedAddress: string;
|
|
9
|
+
/** The unique identifier for the depot location. */
|
|
10
|
+
id: string;
|
|
11
|
+
/** Latitude coordinate of the depot location. */
|
|
12
|
+
latitude: number;
|
|
13
|
+
/** Longitude coordinate of the depot location. */
|
|
14
|
+
longitude: number;
|
|
15
|
+
/** The name of the depot location. */
|
|
16
|
+
name: string;
|
|
17
|
+
}
|
|
@@ -0,0 +1,19 @@
|
|
|
1
|
+
/**
|
|
2
|
+
* A stop location within a route template.
|
|
3
|
+
*/
|
|
4
|
+
export interface HubRouteTemplateLocationObjectResponseBody {
|
|
5
|
+
/** The customer-provided identifier for the location. */
|
|
6
|
+
externalId?: string | undefined;
|
|
7
|
+
/** The formatted address of the location. */
|
|
8
|
+
formattedAddress: string;
|
|
9
|
+
/** The unique identifier for the location. */
|
|
10
|
+
id: string;
|
|
11
|
+
/** Latitude coordinate of the location. */
|
|
12
|
+
latitude: number;
|
|
13
|
+
/** Longitude coordinate of the location. */
|
|
14
|
+
longitude: number;
|
|
15
|
+
/** The name of the location. */
|
|
16
|
+
name: string;
|
|
17
|
+
/** The 1-based position of this stop in the route template. */
|
|
18
|
+
position: number;
|
|
19
|
+
}
|
|
@@ -0,0 +1,28 @@
|
|
|
1
|
+
import type * as Samsara from "../index.js";
|
|
2
|
+
/**
|
|
3
|
+
* A route template for a hub.
|
|
4
|
+
*/
|
|
5
|
+
export interface HubRouteTemplateObjectResponseBody {
|
|
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
|
+
/** Total distance of the route in meters. */
|
|
11
|
+
distanceMeters: number;
|
|
12
|
+
/** Total duration of the route in seconds. */
|
|
13
|
+
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
|
+
/** The hub identifier this route template belongs to. */
|
|
17
|
+
hubId: string;
|
|
18
|
+
/** The IANA timezone of the hub (e.g. 'America/Los_Angeles'). */
|
|
19
|
+
hubTimezone: string;
|
|
20
|
+
/** The unique identifier for the route template. */
|
|
21
|
+
id: string;
|
|
22
|
+
/** Ordered list of stop locations in the route template. */
|
|
23
|
+
locations: Samsara.HubRouteTemplateLocationObjectResponseBody[];
|
|
24
|
+
/** The name of the route template. */
|
|
25
|
+
name: string;
|
|
26
|
+
/** The timestamp when the route template was last updated, in RFC 3339 format. */
|
|
27
|
+
updatedAtTime: string;
|
|
28
|
+
}
|
package/dist/cjs/api/types/HubRouteTemplatesListHubRouteTemplatesBadGatewayErrorResponseBody.d.ts
ADDED
|
@@ -0,0 +1,9 @@
|
|
|
1
|
+
/**
|
|
2
|
+
* Bad Gateway
|
|
3
|
+
*/
|
|
4
|
+
export interface HubRouteTemplatesListHubRouteTemplatesBadGatewayErrorResponseBody {
|
|
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 HubRouteTemplatesListHubRouteTemplatesGatewayTimeoutErrorResponseBody {
|
|
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 HubRouteTemplatesListHubRouteTemplatesInternalServerErrorResponseBody {
|
|
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 HubRouteTemplatesListHubRouteTemplatesMethodNotAllowedErrorResponseBody {
|
|
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/HubRouteTemplatesListHubRouteTemplatesNotFoundErrorResponseBody.d.ts
ADDED
|
@@ -0,0 +1,9 @@
|
|
|
1
|
+
/**
|
|
2
|
+
* Resource not found
|
|
3
|
+
*/
|
|
4
|
+
export interface HubRouteTemplatesListHubRouteTemplatesNotFoundErrorResponseBody {
|
|
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 HubRouteTemplatesListHubRouteTemplatesNotImplementedErrorResponseBody {
|
|
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 HubRouteTemplatesListHubRouteTemplatesServiceUnavailableErrorResponseBody {
|
|
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 HubRouteTemplatesListHubRouteTemplatesTooManyRequestsErrorResponseBody {
|
|
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/HubRouteTemplatesListHubRouteTemplatesUnauthorizedErrorResponseBody.d.ts
ADDED
|
@@ -0,0 +1,9 @@
|
|
|
1
|
+
/**
|
|
2
|
+
* Unauthorized
|
|
3
|
+
*/
|
|
4
|
+
export interface HubRouteTemplatesListHubRouteTemplatesUnauthorizedErrorResponseBody {
|
|
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
|
+
}
|
|
@@ -1413,6 +1413,19 @@ export * from "./HubPlansListHubPlansResponseBody.js";
|
|
|
1413
1413
|
export * from "./HubPlansListHubPlansServiceUnavailableErrorResponseBody.js";
|
|
1414
1414
|
export * from "./HubPlansListHubPlansTooManyRequestsErrorResponseBody.js";
|
|
1415
1415
|
export * from "./HubPlansListHubPlansUnauthorizedErrorResponseBody.js";
|
|
1416
|
+
export * from "./HubRouteTemplateDepotObjectResponseBody.js";
|
|
1417
|
+
export * from "./HubRouteTemplateLocationObjectResponseBody.js";
|
|
1418
|
+
export * from "./HubRouteTemplateObjectResponseBody.js";
|
|
1419
|
+
export * from "./HubRouteTemplatesListHubRouteTemplatesBadGatewayErrorResponseBody.js";
|
|
1420
|
+
export * from "./HubRouteTemplatesListHubRouteTemplatesGatewayTimeoutErrorResponseBody.js";
|
|
1421
|
+
export * from "./HubRouteTemplatesListHubRouteTemplatesInternalServerErrorResponseBody.js";
|
|
1422
|
+
export * from "./HubRouteTemplatesListHubRouteTemplatesMethodNotAllowedErrorResponseBody.js";
|
|
1423
|
+
export * from "./HubRouteTemplatesListHubRouteTemplatesNotFoundErrorResponseBody.js";
|
|
1424
|
+
export * from "./HubRouteTemplatesListHubRouteTemplatesNotImplementedErrorResponseBody.js";
|
|
1425
|
+
export * from "./HubRouteTemplatesListHubRouteTemplatesResponseBody.js";
|
|
1426
|
+
export * from "./HubRouteTemplatesListHubRouteTemplatesServiceUnavailableErrorResponseBody.js";
|
|
1427
|
+
export * from "./HubRouteTemplatesListHubRouteTemplatesTooManyRequestsErrorResponseBody.js";
|
|
1428
|
+
export * from "./HubRouteTemplatesListHubRouteTemplatesUnauthorizedErrorResponseBody.js";
|
|
1416
1429
|
export * from "./HubSkillObjectResponseBody.js";
|
|
1417
1430
|
export * from "./HubSkillsListHubSkillsBadGatewayErrorResponseBody.js";
|
|
1418
1431
|
export * from "./HubSkillsListHubSkillsGatewayTimeoutErrorResponseBody.js";
|
|
@@ -1429,6 +1429,19 @@ __exportStar(require("./HubPlansListHubPlansResponseBody.js"), exports);
|
|
|
1429
1429
|
__exportStar(require("./HubPlansListHubPlansServiceUnavailableErrorResponseBody.js"), exports);
|
|
1430
1430
|
__exportStar(require("./HubPlansListHubPlansTooManyRequestsErrorResponseBody.js"), exports);
|
|
1431
1431
|
__exportStar(require("./HubPlansListHubPlansUnauthorizedErrorResponseBody.js"), exports);
|
|
1432
|
+
__exportStar(require("./HubRouteTemplateDepotObjectResponseBody.js"), exports);
|
|
1433
|
+
__exportStar(require("./HubRouteTemplateLocationObjectResponseBody.js"), exports);
|
|
1434
|
+
__exportStar(require("./HubRouteTemplateObjectResponseBody.js"), exports);
|
|
1435
|
+
__exportStar(require("./HubRouteTemplatesListHubRouteTemplatesBadGatewayErrorResponseBody.js"), exports);
|
|
1436
|
+
__exportStar(require("./HubRouteTemplatesListHubRouteTemplatesGatewayTimeoutErrorResponseBody.js"), exports);
|
|
1437
|
+
__exportStar(require("./HubRouteTemplatesListHubRouteTemplatesInternalServerErrorResponseBody.js"), exports);
|
|
1438
|
+
__exportStar(require("./HubRouteTemplatesListHubRouteTemplatesMethodNotAllowedErrorResponseBody.js"), exports);
|
|
1439
|
+
__exportStar(require("./HubRouteTemplatesListHubRouteTemplatesNotFoundErrorResponseBody.js"), exports);
|
|
1440
|
+
__exportStar(require("./HubRouteTemplatesListHubRouteTemplatesNotImplementedErrorResponseBody.js"), exports);
|
|
1441
|
+
__exportStar(require("./HubRouteTemplatesListHubRouteTemplatesResponseBody.js"), exports);
|
|
1442
|
+
__exportStar(require("./HubRouteTemplatesListHubRouteTemplatesServiceUnavailableErrorResponseBody.js"), exports);
|
|
1443
|
+
__exportStar(require("./HubRouteTemplatesListHubRouteTemplatesTooManyRequestsErrorResponseBody.js"), exports);
|
|
1444
|
+
__exportStar(require("./HubRouteTemplatesListHubRouteTemplatesUnauthorizedErrorResponseBody.js"), exports);
|
|
1432
1445
|
__exportStar(require("./HubSkillObjectResponseBody.js"), exports);
|
|
1433
1446
|
__exportStar(require("./HubSkillsListHubSkillsBadGatewayErrorResponseBody.js"), exports);
|
|
1434
1447
|
__exportStar(require("./HubSkillsListHubSkillsGatewayTimeoutErrorResponseBody.js"), exports);
|
package/dist/cjs/version.d.ts
CHANGED
|
@@ -1 +1 @@
|
|
|
1
|
-
export declare const SDK_VERSION = "11.
|
|
1
|
+
export declare const SDK_VERSION = "11.10.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": "11.
|
|
11
|
-
"User-Agent": "@samsarahq/samsara/11.
|
|
10
|
+
"X-Fern-SDK-Version": "11.10.0",
|
|
11
|
+
"User-Agent": "@samsarahq/samsara/11.10.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",
|
|
@@ -1192,6 +1192,36 @@ export declare class BetaApIsClient {
|
|
|
1192
1192
|
*/
|
|
1193
1193
|
deletePlanOrders(request: Samsara.DeletePlanOrdersRequest, requestOptions?: BetaApIsClient.RequestOptions): core.HttpResponsePromise<void>;
|
|
1194
1194
|
private __deletePlanOrders;
|
|
1195
|
+
/**
|
|
1196
|
+
* Retrieve route templates for a specific hub. Optionally filter by route template ID or name.
|
|
1197
|
+
*
|
|
1198
|
+
* <b>Rate limit:</b> 10 requests/sec (learn more about rate limits <a href="https://developers.samsara.com/docs/rate-limits" target="_blank">here</a>).
|
|
1199
|
+
*
|
|
1200
|
+
* To use this endpoint, select **Read 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>
|
|
1201
|
+
*
|
|
1202
|
+
*
|
|
1203
|
+
* **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.
|
|
1204
|
+
*
|
|
1205
|
+
* @param {Samsara.ListHubRouteTemplatesRequest} request
|
|
1206
|
+
* @param {BetaApIsClient.RequestOptions} requestOptions - Request-specific configuration.
|
|
1207
|
+
*
|
|
1208
|
+
* @throws {@link Samsara.UnauthorizedError}
|
|
1209
|
+
* @throws {@link Samsara.NotFoundError}
|
|
1210
|
+
* @throws {@link Samsara.MethodNotAllowedError}
|
|
1211
|
+
* @throws {@link Samsara.TooManyRequestsError}
|
|
1212
|
+
* @throws {@link Samsara.InternalServerError}
|
|
1213
|
+
* @throws {@link Samsara.NotImplementedError}
|
|
1214
|
+
* @throws {@link Samsara.BadGatewayError}
|
|
1215
|
+
* @throws {@link Samsara.ServiceUnavailableError}
|
|
1216
|
+
* @throws {@link Samsara.GatewayTimeoutError}
|
|
1217
|
+
*
|
|
1218
|
+
* @example
|
|
1219
|
+
* await client.betaApIs.listHubRouteTemplates({
|
|
1220
|
+
* hubId: "hubId"
|
|
1221
|
+
* })
|
|
1222
|
+
*/
|
|
1223
|
+
listHubRouteTemplates(request: Samsara.ListHubRouteTemplatesRequest, requestOptions?: BetaApIsClient.RequestOptions): core.HttpResponsePromise<Samsara.HubRouteTemplatesListHubRouteTemplatesResponseBody>;
|
|
1224
|
+
private __listHubRouteTemplates;
|
|
1195
1225
|
/**
|
|
1196
1226
|
* Returns qualification records for the specified list of IDs.
|
|
1197
1227
|
*
|
|
@@ -3489,6 +3489,98 @@ export class BetaApIsClient {
|
|
|
3489
3489
|
return handleNonStatusCodeError(_response.error, _response.rawResponse, "DELETE", "/hub/plan/orders");
|
|
3490
3490
|
});
|
|
3491
3491
|
}
|
|
3492
|
+
/**
|
|
3493
|
+
* Retrieve route templates for a specific hub. Optionally filter by route template ID or name.
|
|
3494
|
+
*
|
|
3495
|
+
* <b>Rate limit:</b> 10 requests/sec (learn more about rate limits <a href="https://developers.samsara.com/docs/rate-limits" target="_blank">here</a>).
|
|
3496
|
+
*
|
|
3497
|
+
* To use this endpoint, select **Read 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>
|
|
3498
|
+
*
|
|
3499
|
+
*
|
|
3500
|
+
* **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.
|
|
3501
|
+
*
|
|
3502
|
+
* @param {Samsara.ListHubRouteTemplatesRequest} request
|
|
3503
|
+
* @param {BetaApIsClient.RequestOptions} requestOptions - Request-specific configuration.
|
|
3504
|
+
*
|
|
3505
|
+
* @throws {@link Samsara.UnauthorizedError}
|
|
3506
|
+
* @throws {@link Samsara.NotFoundError}
|
|
3507
|
+
* @throws {@link Samsara.MethodNotAllowedError}
|
|
3508
|
+
* @throws {@link Samsara.TooManyRequestsError}
|
|
3509
|
+
* @throws {@link Samsara.InternalServerError}
|
|
3510
|
+
* @throws {@link Samsara.NotImplementedError}
|
|
3511
|
+
* @throws {@link Samsara.BadGatewayError}
|
|
3512
|
+
* @throws {@link Samsara.ServiceUnavailableError}
|
|
3513
|
+
* @throws {@link Samsara.GatewayTimeoutError}
|
|
3514
|
+
*
|
|
3515
|
+
* @example
|
|
3516
|
+
* await client.betaApIs.listHubRouteTemplates({
|
|
3517
|
+
* hubId: "hubId"
|
|
3518
|
+
* })
|
|
3519
|
+
*/
|
|
3520
|
+
listHubRouteTemplates(request, requestOptions) {
|
|
3521
|
+
return core.HttpResponsePromise.fromPromise(this.__listHubRouteTemplates(request, requestOptions));
|
|
3522
|
+
}
|
|
3523
|
+
__listHubRouteTemplates(request, requestOptions) {
|
|
3524
|
+
return __awaiter(this, void 0, void 0, function* () {
|
|
3525
|
+
var _a, _b, _c, _d, _e, _f, _g, _h, _j;
|
|
3526
|
+
const { hubId, id, name, after, limit } = request;
|
|
3527
|
+
const _queryParams = {
|
|
3528
|
+
hubId,
|
|
3529
|
+
id,
|
|
3530
|
+
name,
|
|
3531
|
+
after,
|
|
3532
|
+
limit,
|
|
3533
|
+
};
|
|
3534
|
+
const _authRequest = yield this._options.authProvider.getAuthRequest();
|
|
3535
|
+
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);
|
|
3536
|
+
const _response = yield core.fetcher({
|
|
3537
|
+
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"),
|
|
3538
|
+
method: "GET",
|
|
3539
|
+
headers: _headers,
|
|
3540
|
+
queryParameters: Object.assign(Object.assign({}, _queryParams), requestOptions === null || requestOptions === void 0 ? void 0 : requestOptions.queryParams),
|
|
3541
|
+
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,
|
|
3542
|
+
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,
|
|
3543
|
+
abortSignal: requestOptions === null || requestOptions === void 0 ? void 0 : requestOptions.abortSignal,
|
|
3544
|
+
fetchFn: (_j = this._options) === null || _j === void 0 ? void 0 : _j.fetch,
|
|
3545
|
+
logging: this._options.logging,
|
|
3546
|
+
});
|
|
3547
|
+
if (_response.ok) {
|
|
3548
|
+
return {
|
|
3549
|
+
data: _response.body,
|
|
3550
|
+
rawResponse: _response.rawResponse,
|
|
3551
|
+
};
|
|
3552
|
+
}
|
|
3553
|
+
if (_response.error.reason === "status-code") {
|
|
3554
|
+
switch (_response.error.statusCode) {
|
|
3555
|
+
case 401:
|
|
3556
|
+
throw new Samsara.UnauthorizedError(_response.error.body, _response.rawResponse);
|
|
3557
|
+
case 404:
|
|
3558
|
+
throw new Samsara.NotFoundError(_response.error.body, _response.rawResponse);
|
|
3559
|
+
case 405:
|
|
3560
|
+
throw new Samsara.MethodNotAllowedError(_response.error.body, _response.rawResponse);
|
|
3561
|
+
case 429:
|
|
3562
|
+
throw new Samsara.TooManyRequestsError(_response.error.body, _response.rawResponse);
|
|
3563
|
+
case 500:
|
|
3564
|
+
throw new Samsara.InternalServerError(_response.error.body, _response.rawResponse);
|
|
3565
|
+
case 501:
|
|
3566
|
+
throw new Samsara.NotImplementedError(_response.error.body, _response.rawResponse);
|
|
3567
|
+
case 502:
|
|
3568
|
+
throw new Samsara.BadGatewayError(_response.error.body, _response.rawResponse);
|
|
3569
|
+
case 503:
|
|
3570
|
+
throw new Samsara.ServiceUnavailableError(_response.error.body, _response.rawResponse);
|
|
3571
|
+
case 504:
|
|
3572
|
+
throw new Samsara.GatewayTimeoutError(_response.error.body, _response.rawResponse);
|
|
3573
|
+
default:
|
|
3574
|
+
throw new errors.SamsaraError({
|
|
3575
|
+
statusCode: _response.error.statusCode,
|
|
3576
|
+
body: _response.error.body,
|
|
3577
|
+
rawResponse: _response.rawResponse,
|
|
3578
|
+
});
|
|
3579
|
+
}
|
|
3580
|
+
}
|
|
3581
|
+
return handleNonStatusCodeError(_response.error, _response.rawResponse, "GET", "/hub/route-templates");
|
|
3582
|
+
});
|
|
3583
|
+
}
|
|
3492
3584
|
/**
|
|
3493
3585
|
* Returns qualification records for the specified list of IDs.
|
|
3494
3586
|
*
|
|
@@ -0,0 +1,18 @@
|
|
|
1
|
+
/**
|
|
2
|
+
* @example
|
|
3
|
+
* {
|
|
4
|
+
* hubId: "hubId"
|
|
5
|
+
* }
|
|
6
|
+
*/
|
|
7
|
+
export interface ListHubRouteTemplatesRequest {
|
|
8
|
+
/** The hub identifier. */
|
|
9
|
+
hubId: string;
|
|
10
|
+
/** Filter by a specific route template ID. */
|
|
11
|
+
id?: string;
|
|
12
|
+
/** Filter by route template name (exact match). */
|
|
13
|
+
name?: string;
|
|
14
|
+
/** If specified, this should be the endCursor value from the previous page of results. When present, this request will return the next page of results that occur immediately after the previous page of results. */
|
|
15
|
+
after?: string;
|
|
16
|
+
/** The limit for how many objects will be in the response. Default and max for this value is 100 objects. */
|
|
17
|
+
limit?: number;
|
|
18
|
+
}
|
|
@@ -44,6 +44,7 @@ export type { ListAssetAssignmentsRequest } from "./ListAssetAssignmentsRequest.
|
|
|
44
44
|
export type { ListAssociationsRequest } from "./ListAssociationsRequest.mjs";
|
|
45
45
|
export type { ListDeviceRecoveryMissingAssetsRequest } from "./ListDeviceRecoveryMissingAssetsRequest.mjs";
|
|
46
46
|
export type { ListHubCustomPropertiesRequest } from "./ListHubCustomPropertiesRequest.mjs";
|
|
47
|
+
export type { ListHubRouteTemplatesRequest } from "./ListHubRouteTemplatesRequest.mjs";
|
|
47
48
|
export type { ListMaintenanceVendorsRequest } from "./ListMaintenanceVendorsRequest.mjs";
|
|
48
49
|
export type { ListPlanOrdersRequest } from "./ListPlanOrdersRequest.mjs";
|
|
49
50
|
export type { ListRidershipAccountsRequest } from "./ListRidershipAccountsRequest.mjs";
|
|
@@ -0,0 +1,17 @@
|
|
|
1
|
+
/**
|
|
2
|
+
* A depot location for a route template.
|
|
3
|
+
*/
|
|
4
|
+
export interface HubRouteTemplateDepotObjectResponseBody {
|
|
5
|
+
/** The customer-provided external identifier for the depot location. */
|
|
6
|
+
externalId?: string | undefined;
|
|
7
|
+
/** The formatted address of the depot location. */
|
|
8
|
+
formattedAddress: string;
|
|
9
|
+
/** The unique identifier for the depot location. */
|
|
10
|
+
id: string;
|
|
11
|
+
/** Latitude coordinate of the depot location. */
|
|
12
|
+
latitude: number;
|
|
13
|
+
/** Longitude coordinate of the depot location. */
|
|
14
|
+
longitude: number;
|
|
15
|
+
/** The name of the depot location. */
|
|
16
|
+
name: string;
|
|
17
|
+
}
|
|
@@ -0,0 +1,19 @@
|
|
|
1
|
+
/**
|
|
2
|
+
* A stop location within a route template.
|
|
3
|
+
*/
|
|
4
|
+
export interface HubRouteTemplateLocationObjectResponseBody {
|
|
5
|
+
/** The customer-provided identifier for the location. */
|
|
6
|
+
externalId?: string | undefined;
|
|
7
|
+
/** The formatted address of the location. */
|
|
8
|
+
formattedAddress: string;
|
|
9
|
+
/** The unique identifier for the location. */
|
|
10
|
+
id: string;
|
|
11
|
+
/** Latitude coordinate of the location. */
|
|
12
|
+
latitude: number;
|
|
13
|
+
/** Longitude coordinate of the location. */
|
|
14
|
+
longitude: number;
|
|
15
|
+
/** The name of the location. */
|
|
16
|
+
name: string;
|
|
17
|
+
/** The 1-based position of this stop in the route template. */
|
|
18
|
+
position: number;
|
|
19
|
+
}
|
|
@@ -0,0 +1,28 @@
|
|
|
1
|
+
import type * as Samsara from "../index.mjs";
|
|
2
|
+
/**
|
|
3
|
+
* A route template for a hub.
|
|
4
|
+
*/
|
|
5
|
+
export interface HubRouteTemplateObjectResponseBody {
|
|
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
|
+
/** Total distance of the route in meters. */
|
|
11
|
+
distanceMeters: number;
|
|
12
|
+
/** Total duration of the route in seconds. */
|
|
13
|
+
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
|
+
/** The hub identifier this route template belongs to. */
|
|
17
|
+
hubId: string;
|
|
18
|
+
/** The IANA timezone of the hub (e.g. 'America/Los_Angeles'). */
|
|
19
|
+
hubTimezone: string;
|
|
20
|
+
/** The unique identifier for the route template. */
|
|
21
|
+
id: string;
|
|
22
|
+
/** Ordered list of stop locations in the route template. */
|
|
23
|
+
locations: Samsara.HubRouteTemplateLocationObjectResponseBody[];
|
|
24
|
+
/** The name of the route template. */
|
|
25
|
+
name: string;
|
|
26
|
+
/** The timestamp when the route template was last updated, in RFC 3339 format. */
|
|
27
|
+
updatedAtTime: string;
|
|
28
|
+
}
|
package/dist/esm/api/types/HubRouteTemplatesListHubRouteTemplatesBadGatewayErrorResponseBody.d.mts
ADDED
|
@@ -0,0 +1,9 @@
|
|
|
1
|
+
/**
|
|
2
|
+
* Bad Gateway
|
|
3
|
+
*/
|
|
4
|
+
export interface HubRouteTemplatesListHubRouteTemplatesBadGatewayErrorResponseBody {
|
|
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 HubRouteTemplatesListHubRouteTemplatesGatewayTimeoutErrorResponseBody {
|
|
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 HubRouteTemplatesListHubRouteTemplatesInternalServerErrorResponseBody {
|
|
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 HubRouteTemplatesListHubRouteTemplatesMethodNotAllowedErrorResponseBody {
|
|
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/HubRouteTemplatesListHubRouteTemplatesNotFoundErrorResponseBody.d.mts
ADDED
|
@@ -0,0 +1,9 @@
|
|
|
1
|
+
/**
|
|
2
|
+
* Resource not found
|
|
3
|
+
*/
|
|
4
|
+
export interface HubRouteTemplatesListHubRouteTemplatesNotFoundErrorResponseBody {
|
|
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 HubRouteTemplatesListHubRouteTemplatesNotImplementedErrorResponseBody {
|
|
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 HubRouteTemplatesListHubRouteTemplatesServiceUnavailableErrorResponseBody {
|
|
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 HubRouteTemplatesListHubRouteTemplatesTooManyRequestsErrorResponseBody {
|
|
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/HubRouteTemplatesListHubRouteTemplatesUnauthorizedErrorResponseBody.d.mts
ADDED
|
@@ -0,0 +1,9 @@
|
|
|
1
|
+
/**
|
|
2
|
+
* Unauthorized
|
|
3
|
+
*/
|
|
4
|
+
export interface HubRouteTemplatesListHubRouteTemplatesUnauthorizedErrorResponseBody {
|
|
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
|
+
}
|
|
@@ -1413,6 +1413,19 @@ export * from "./HubPlansListHubPlansResponseBody.mjs";
|
|
|
1413
1413
|
export * from "./HubPlansListHubPlansServiceUnavailableErrorResponseBody.mjs";
|
|
1414
1414
|
export * from "./HubPlansListHubPlansTooManyRequestsErrorResponseBody.mjs";
|
|
1415
1415
|
export * from "./HubPlansListHubPlansUnauthorizedErrorResponseBody.mjs";
|
|
1416
|
+
export * from "./HubRouteTemplateDepotObjectResponseBody.mjs";
|
|
1417
|
+
export * from "./HubRouteTemplateLocationObjectResponseBody.mjs";
|
|
1418
|
+
export * from "./HubRouteTemplateObjectResponseBody.mjs";
|
|
1419
|
+
export * from "./HubRouteTemplatesListHubRouteTemplatesBadGatewayErrorResponseBody.mjs";
|
|
1420
|
+
export * from "./HubRouteTemplatesListHubRouteTemplatesGatewayTimeoutErrorResponseBody.mjs";
|
|
1421
|
+
export * from "./HubRouteTemplatesListHubRouteTemplatesInternalServerErrorResponseBody.mjs";
|
|
1422
|
+
export * from "./HubRouteTemplatesListHubRouteTemplatesMethodNotAllowedErrorResponseBody.mjs";
|
|
1423
|
+
export * from "./HubRouteTemplatesListHubRouteTemplatesNotFoundErrorResponseBody.mjs";
|
|
1424
|
+
export * from "./HubRouteTemplatesListHubRouteTemplatesNotImplementedErrorResponseBody.mjs";
|
|
1425
|
+
export * from "./HubRouteTemplatesListHubRouteTemplatesResponseBody.mjs";
|
|
1426
|
+
export * from "./HubRouteTemplatesListHubRouteTemplatesServiceUnavailableErrorResponseBody.mjs";
|
|
1427
|
+
export * from "./HubRouteTemplatesListHubRouteTemplatesTooManyRequestsErrorResponseBody.mjs";
|
|
1428
|
+
export * from "./HubRouteTemplatesListHubRouteTemplatesUnauthorizedErrorResponseBody.mjs";
|
|
1416
1429
|
export * from "./HubSkillObjectResponseBody.mjs";
|
|
1417
1430
|
export * from "./HubSkillsListHubSkillsBadGatewayErrorResponseBody.mjs";
|
|
1418
1431
|
export * from "./HubSkillsListHubSkillsGatewayTimeoutErrorResponseBody.mjs";
|
|
@@ -1413,6 +1413,19 @@ export * from "./HubPlansListHubPlansResponseBody.mjs";
|
|
|
1413
1413
|
export * from "./HubPlansListHubPlansServiceUnavailableErrorResponseBody.mjs";
|
|
1414
1414
|
export * from "./HubPlansListHubPlansTooManyRequestsErrorResponseBody.mjs";
|
|
1415
1415
|
export * from "./HubPlansListHubPlansUnauthorizedErrorResponseBody.mjs";
|
|
1416
|
+
export * from "./HubRouteTemplateDepotObjectResponseBody.mjs";
|
|
1417
|
+
export * from "./HubRouteTemplateLocationObjectResponseBody.mjs";
|
|
1418
|
+
export * from "./HubRouteTemplateObjectResponseBody.mjs";
|
|
1419
|
+
export * from "./HubRouteTemplatesListHubRouteTemplatesBadGatewayErrorResponseBody.mjs";
|
|
1420
|
+
export * from "./HubRouteTemplatesListHubRouteTemplatesGatewayTimeoutErrorResponseBody.mjs";
|
|
1421
|
+
export * from "./HubRouteTemplatesListHubRouteTemplatesInternalServerErrorResponseBody.mjs";
|
|
1422
|
+
export * from "./HubRouteTemplatesListHubRouteTemplatesMethodNotAllowedErrorResponseBody.mjs";
|
|
1423
|
+
export * from "./HubRouteTemplatesListHubRouteTemplatesNotFoundErrorResponseBody.mjs";
|
|
1424
|
+
export * from "./HubRouteTemplatesListHubRouteTemplatesNotImplementedErrorResponseBody.mjs";
|
|
1425
|
+
export * from "./HubRouteTemplatesListHubRouteTemplatesResponseBody.mjs";
|
|
1426
|
+
export * from "./HubRouteTemplatesListHubRouteTemplatesServiceUnavailableErrorResponseBody.mjs";
|
|
1427
|
+
export * from "./HubRouteTemplatesListHubRouteTemplatesTooManyRequestsErrorResponseBody.mjs";
|
|
1428
|
+
export * from "./HubRouteTemplatesListHubRouteTemplatesUnauthorizedErrorResponseBody.mjs";
|
|
1416
1429
|
export * from "./HubSkillObjectResponseBody.mjs";
|
|
1417
1430
|
export * from "./HubSkillsListHubSkillsBadGatewayErrorResponseBody.mjs";
|
|
1418
1431
|
export * from "./HubSkillsListHubSkillsGatewayTimeoutErrorResponseBody.mjs";
|
package/dist/esm/version.d.mts
CHANGED
|
@@ -1 +1 @@
|
|
|
1
|
-
export declare const SDK_VERSION = "11.
|
|
1
|
+
export declare const SDK_VERSION = "11.10.0";
|
package/dist/esm/version.mjs
CHANGED
|
@@ -1 +1 @@
|
|
|
1
|
-
export const SDK_VERSION = "11.
|
|
1
|
+
export const SDK_VERSION = "11.10.0";
|
package/package.json
CHANGED
package/reference.md
CHANGED
|
@@ -4306,6 +4306,78 @@ await client.betaApIs.deletePlanOrders({
|
|
|
4306
4306
|
</dl>
|
|
4307
4307
|
|
|
4308
4308
|
|
|
4309
|
+
</dd>
|
|
4310
|
+
</dl>
|
|
4311
|
+
</details>
|
|
4312
|
+
|
|
4313
|
+
<details><summary><code>client.betaApIs.<a href="/src/api/resources/betaApIs/client/Client.ts">listHubRouteTemplates</a>({ ...params }) -> Samsara.HubRouteTemplatesListHubRouteTemplatesResponseBody</code></summary>
|
|
4314
|
+
<dl>
|
|
4315
|
+
<dd>
|
|
4316
|
+
|
|
4317
|
+
#### 📝 Description
|
|
4318
|
+
|
|
4319
|
+
<dl>
|
|
4320
|
+
<dd>
|
|
4321
|
+
|
|
4322
|
+
<dl>
|
|
4323
|
+
<dd>
|
|
4324
|
+
|
|
4325
|
+
Retrieve route templates for a specific hub. Optionally filter by route template ID or name.
|
|
4326
|
+
|
|
4327
|
+
<b>Rate limit:</b> 10 requests/sec (learn more about rate limits <a href="https://developers.samsara.com/docs/rate-limits" target="_blank">here</a>).
|
|
4328
|
+
|
|
4329
|
+
To use this endpoint, select **Read 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>
|
|
4330
|
+
|
|
4331
|
+
|
|
4332
|
+
**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.
|
|
4333
|
+
</dd>
|
|
4334
|
+
</dl>
|
|
4335
|
+
</dd>
|
|
4336
|
+
</dl>
|
|
4337
|
+
|
|
4338
|
+
#### 🔌 Usage
|
|
4339
|
+
|
|
4340
|
+
<dl>
|
|
4341
|
+
<dd>
|
|
4342
|
+
|
|
4343
|
+
<dl>
|
|
4344
|
+
<dd>
|
|
4345
|
+
|
|
4346
|
+
```typescript
|
|
4347
|
+
await client.betaApIs.listHubRouteTemplates({
|
|
4348
|
+
hubId: "hubId"
|
|
4349
|
+
});
|
|
4350
|
+
|
|
4351
|
+
```
|
|
4352
|
+
</dd>
|
|
4353
|
+
</dl>
|
|
4354
|
+
</dd>
|
|
4355
|
+
</dl>
|
|
4356
|
+
|
|
4357
|
+
#### ⚙️ Parameters
|
|
4358
|
+
|
|
4359
|
+
<dl>
|
|
4360
|
+
<dd>
|
|
4361
|
+
|
|
4362
|
+
<dl>
|
|
4363
|
+
<dd>
|
|
4364
|
+
|
|
4365
|
+
**request:** `Samsara.ListHubRouteTemplatesRequest`
|
|
4366
|
+
|
|
4367
|
+
</dd>
|
|
4368
|
+
</dl>
|
|
4369
|
+
|
|
4370
|
+
<dl>
|
|
4371
|
+
<dd>
|
|
4372
|
+
|
|
4373
|
+
**requestOptions:** `BetaApIsClient.RequestOptions`
|
|
4374
|
+
|
|
4375
|
+
</dd>
|
|
4376
|
+
</dl>
|
|
4377
|
+
</dd>
|
|
4378
|
+
</dl>
|
|
4379
|
+
|
|
4380
|
+
|
|
4309
4381
|
</dd>
|
|
4310
4382
|
</dl>
|
|
4311
4383
|
</details>
|