@samsarahq/samsara 13.17.1 → 13.19.0

This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
Files changed (80) hide show
  1. package/dist/cjs/BaseClient.js +2 -2
  2. package/dist/cjs/api/resources/betaApIs/client/Client.d.ts +28 -0
  3. package/dist/cjs/api/resources/betaApIs/client/Client.js +86 -0
  4. package/dist/cjs/api/resources/betaApIs/client/requests/GetWorkOrderTemplatesRequest.d.ts +8 -0
  5. package/dist/cjs/api/resources/betaApIs/client/requests/GetWorkOrderTemplatesRequest.js +3 -0
  6. package/dist/cjs/api/resources/betaApIs/client/requests/index.d.ts +1 -0
  7. package/dist/cjs/api/types/CreateRoutesStopRequestObjectRequestBody.d.ts +2 -0
  8. package/dist/cjs/api/types/HosViolationDayObjectRequestBody.d.ts +6 -0
  9. package/dist/cjs/api/types/HosViolationDayObjectRequestBody.js +3 -0
  10. package/dist/cjs/api/types/RoutesStopResponseObjectResponseBody.d.ts +2 -0
  11. package/dist/cjs/api/types/UpdateRoutesStopRequestObjectRequestBody.d.ts +2 -0
  12. package/dist/cjs/api/types/WorkOrderObjectResponseBody.d.ts +2 -0
  13. package/dist/cjs/api/types/WorkOrderTemplateObjectResponseBody.d.ts +9 -0
  14. package/dist/cjs/api/types/WorkOrderTemplateObjectResponseBody.js +3 -0
  15. package/dist/cjs/api/types/WorkOrderWithTimeEntriesObjectResponseBody.d.ts +2 -0
  16. package/dist/cjs/api/types/WorkOrdersGetWorkOrderTemplatesBadGatewayErrorResponseBody.d.ts +9 -0
  17. package/dist/cjs/api/types/WorkOrdersGetWorkOrderTemplatesBadGatewayErrorResponseBody.js +3 -0
  18. package/dist/cjs/api/types/WorkOrdersGetWorkOrderTemplatesGatewayTimeoutErrorResponseBody.d.ts +9 -0
  19. package/dist/cjs/api/types/WorkOrdersGetWorkOrderTemplatesGatewayTimeoutErrorResponseBody.js +3 -0
  20. package/dist/cjs/api/types/WorkOrdersGetWorkOrderTemplatesInternalServerErrorResponseBody.d.ts +9 -0
  21. package/dist/cjs/api/types/WorkOrdersGetWorkOrderTemplatesInternalServerErrorResponseBody.js +3 -0
  22. package/dist/cjs/api/types/WorkOrdersGetWorkOrderTemplatesMethodNotAllowedErrorResponseBody.d.ts +9 -0
  23. package/dist/cjs/api/types/WorkOrdersGetWorkOrderTemplatesMethodNotAllowedErrorResponseBody.js +3 -0
  24. package/dist/cjs/api/types/WorkOrdersGetWorkOrderTemplatesNotFoundErrorResponseBody.d.ts +9 -0
  25. package/dist/cjs/api/types/WorkOrdersGetWorkOrderTemplatesNotFoundErrorResponseBody.js +3 -0
  26. package/dist/cjs/api/types/WorkOrdersGetWorkOrderTemplatesNotImplementedErrorResponseBody.d.ts +9 -0
  27. package/dist/cjs/api/types/WorkOrdersGetWorkOrderTemplatesNotImplementedErrorResponseBody.js +3 -0
  28. package/dist/cjs/api/types/WorkOrdersGetWorkOrderTemplatesResponseBody.d.ts +5 -0
  29. package/dist/cjs/api/types/WorkOrdersGetWorkOrderTemplatesResponseBody.js +3 -0
  30. package/dist/cjs/api/types/WorkOrdersGetWorkOrderTemplatesServiceUnavailableErrorResponseBody.d.ts +9 -0
  31. package/dist/cjs/api/types/WorkOrdersGetWorkOrderTemplatesServiceUnavailableErrorResponseBody.js +3 -0
  32. package/dist/cjs/api/types/WorkOrdersGetWorkOrderTemplatesTooManyRequestsErrorResponseBody.d.ts +9 -0
  33. package/dist/cjs/api/types/WorkOrdersGetWorkOrderTemplatesTooManyRequestsErrorResponseBody.js +3 -0
  34. package/dist/cjs/api/types/WorkOrdersGetWorkOrderTemplatesUnauthorizedErrorResponseBody.d.ts +9 -0
  35. package/dist/cjs/api/types/WorkOrdersGetWorkOrderTemplatesUnauthorizedErrorResponseBody.js +3 -0
  36. package/dist/cjs/api/types/index.d.ts +12 -0
  37. package/dist/cjs/api/types/index.js +12 -0
  38. package/dist/cjs/version.d.ts +1 -1
  39. package/dist/cjs/version.js +1 -1
  40. package/dist/esm/BaseClient.mjs +2 -2
  41. package/dist/esm/api/resources/betaApIs/client/Client.d.mts +28 -0
  42. package/dist/esm/api/resources/betaApIs/client/Client.mjs +86 -0
  43. package/dist/esm/api/resources/betaApIs/client/requests/GetWorkOrderTemplatesRequest.d.mts +8 -0
  44. package/dist/esm/api/resources/betaApIs/client/requests/GetWorkOrderTemplatesRequest.mjs +2 -0
  45. package/dist/esm/api/resources/betaApIs/client/requests/index.d.mts +1 -0
  46. package/dist/esm/api/types/CreateRoutesStopRequestObjectRequestBody.d.mts +2 -0
  47. package/dist/esm/api/types/HosViolationDayObjectRequestBody.d.mts +6 -0
  48. package/dist/esm/api/types/HosViolationDayObjectRequestBody.mjs +2 -0
  49. package/dist/esm/api/types/RoutesStopResponseObjectResponseBody.d.mts +2 -0
  50. package/dist/esm/api/types/UpdateRoutesStopRequestObjectRequestBody.d.mts +2 -0
  51. package/dist/esm/api/types/WorkOrderObjectResponseBody.d.mts +2 -0
  52. package/dist/esm/api/types/WorkOrderTemplateObjectResponseBody.d.mts +9 -0
  53. package/dist/esm/api/types/WorkOrderTemplateObjectResponseBody.mjs +2 -0
  54. package/dist/esm/api/types/WorkOrderWithTimeEntriesObjectResponseBody.d.mts +2 -0
  55. package/dist/esm/api/types/WorkOrdersGetWorkOrderTemplatesBadGatewayErrorResponseBody.d.mts +9 -0
  56. package/dist/esm/api/types/WorkOrdersGetWorkOrderTemplatesBadGatewayErrorResponseBody.mjs +2 -0
  57. package/dist/esm/api/types/WorkOrdersGetWorkOrderTemplatesGatewayTimeoutErrorResponseBody.d.mts +9 -0
  58. package/dist/esm/api/types/WorkOrdersGetWorkOrderTemplatesGatewayTimeoutErrorResponseBody.mjs +2 -0
  59. package/dist/esm/api/types/WorkOrdersGetWorkOrderTemplatesInternalServerErrorResponseBody.d.mts +9 -0
  60. package/dist/esm/api/types/WorkOrdersGetWorkOrderTemplatesInternalServerErrorResponseBody.mjs +2 -0
  61. package/dist/esm/api/types/WorkOrdersGetWorkOrderTemplatesMethodNotAllowedErrorResponseBody.d.mts +9 -0
  62. package/dist/esm/api/types/WorkOrdersGetWorkOrderTemplatesMethodNotAllowedErrorResponseBody.mjs +2 -0
  63. package/dist/esm/api/types/WorkOrdersGetWorkOrderTemplatesNotFoundErrorResponseBody.d.mts +9 -0
  64. package/dist/esm/api/types/WorkOrdersGetWorkOrderTemplatesNotFoundErrorResponseBody.mjs +2 -0
  65. package/dist/esm/api/types/WorkOrdersGetWorkOrderTemplatesNotImplementedErrorResponseBody.d.mts +9 -0
  66. package/dist/esm/api/types/WorkOrdersGetWorkOrderTemplatesNotImplementedErrorResponseBody.mjs +2 -0
  67. package/dist/esm/api/types/WorkOrdersGetWorkOrderTemplatesResponseBody.d.mts +5 -0
  68. package/dist/esm/api/types/WorkOrdersGetWorkOrderTemplatesResponseBody.mjs +2 -0
  69. package/dist/esm/api/types/WorkOrdersGetWorkOrderTemplatesServiceUnavailableErrorResponseBody.d.mts +9 -0
  70. package/dist/esm/api/types/WorkOrdersGetWorkOrderTemplatesServiceUnavailableErrorResponseBody.mjs +2 -0
  71. package/dist/esm/api/types/WorkOrdersGetWorkOrderTemplatesTooManyRequestsErrorResponseBody.d.mts +9 -0
  72. package/dist/esm/api/types/WorkOrdersGetWorkOrderTemplatesTooManyRequestsErrorResponseBody.mjs +2 -0
  73. package/dist/esm/api/types/WorkOrdersGetWorkOrderTemplatesUnauthorizedErrorResponseBody.d.mts +9 -0
  74. package/dist/esm/api/types/WorkOrdersGetWorkOrderTemplatesUnauthorizedErrorResponseBody.mjs +2 -0
  75. package/dist/esm/api/types/index.d.mts +12 -0
  76. package/dist/esm/api/types/index.mjs +12 -0
  77. package/dist/esm/version.d.mts +1 -1
  78. package/dist/esm/version.mjs +1 -1
  79. package/package.json +1 -1
  80. package/reference.md +70 -0
@@ -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.17.1",
48
- "User-Agent": "@samsarahq/samsara/13.17.1",
47
+ "X-Fern-SDK-Version": "13.19.0",
48
+ "User-Agent": "@samsarahq/samsara/13.19.0",
49
49
  "X-Fern-Runtime": core.RUNTIME.type,
50
50
  "X-Fern-Runtime-Version": core.RUNTIME.version,
51
51
  "X-Samsara-Version": (_a = options === null || options === void 0 ? void 0 : options.version) !== null && _a !== void 0 ? _a : "2025-06-11",
@@ -1298,6 +1298,34 @@ export declare class BetaApIsClient {
1298
1298
  */
1299
1299
  deleteHubRouteTemplate(request: Samsara.DeleteHubRouteTemplateRequest, requestOptions?: BetaApIsClient.RequestOptions): core.HttpResponsePromise<void>;
1300
1300
  private __deleteHubRouteTemplate;
1301
+ /**
1302
+ * Gets work order templates by id. Ids that do not resolve to a template (e.g. deleted) are omitted from the response.
1303
+ *
1304
+ * <b>Rate limit:</b> 5 requests/sec (learn more about rate limits <a href="https://developers.samsara.com/docs/rate-limits" target="_blank">here</a>).
1305
+ *
1306
+ * To use this endpoint, select **Read Work Orders** under the Work Orders category when creating or editing an API token. <a href="https://developers.samsara.com/docs/authentication#scopes-for-api-tokens" target="_blank">Learn More.</a>
1307
+ *
1308
+ *
1309
+ * **Submit Feedback**: Likes, dislikes, and API feature requests should be filed as feedback in our <a href="https://forms.gle/zkD4NCH7HjKb7mm69" target="_blank">API feedback form</a>. If you encountered an issue or noticed inaccuracies in the API documentation, please <a href="https://www.samsara.com/help" target="_blank">submit a case</a> to our support team.
1310
+ *
1311
+ * @param {Samsara.GetWorkOrderTemplatesRequest} request
1312
+ * @param {BetaApIsClient.RequestOptions} requestOptions - Request-specific configuration.
1313
+ *
1314
+ * @throws {@link Samsara.UnauthorizedError}
1315
+ * @throws {@link Samsara.NotFoundError}
1316
+ * @throws {@link Samsara.MethodNotAllowedError}
1317
+ * @throws {@link Samsara.TooManyRequestsError}
1318
+ * @throws {@link Samsara.InternalServerError}
1319
+ * @throws {@link Samsara.NotImplementedError}
1320
+ * @throws {@link Samsara.BadGatewayError}
1321
+ * @throws {@link Samsara.ServiceUnavailableError}
1322
+ * @throws {@link Samsara.GatewayTimeoutError}
1323
+ *
1324
+ * @example
1325
+ * await client.betaApIs.getWorkOrderTemplates()
1326
+ */
1327
+ getWorkOrderTemplates(request?: Samsara.GetWorkOrderTemplatesRequest, requestOptions?: BetaApIsClient.RequestOptions): core.HttpResponsePromise<Samsara.WorkOrdersGetWorkOrderTemplatesResponseBody>;
1328
+ private __getWorkOrderTemplates;
1301
1329
  /**
1302
1330
  * Returns places for the authorized organization. Supports cursor pagination or batch fetch by Samsara place ids via `placeIds` or by external ids via `externalIds` (mutually exclusive).
1303
1331
  *
@@ -3866,6 +3866,92 @@ class BetaApIsClient {
3866
3866
  return (0, handleNonStatusCodeError_js_1.handleNonStatusCodeError)(_response.error, _response.rawResponse, "DELETE", "/hub/route-templates");
3867
3867
  });
3868
3868
  }
3869
+ /**
3870
+ * Gets work order templates by id. Ids that do not resolve to a template (e.g. deleted) are omitted from the response.
3871
+ *
3872
+ * <b>Rate limit:</b> 5 requests/sec (learn more about rate limits <a href="https://developers.samsara.com/docs/rate-limits" target="_blank">here</a>).
3873
+ *
3874
+ * To use this endpoint, select **Read Work Orders** under the Work Orders category when creating or editing an API token. <a href="https://developers.samsara.com/docs/authentication#scopes-for-api-tokens" target="_blank">Learn More.</a>
3875
+ *
3876
+ *
3877
+ * **Submit Feedback**: Likes, dislikes, and API feature requests should be filed as feedback in our <a href="https://forms.gle/zkD4NCH7HjKb7mm69" target="_blank">API feedback form</a>. If you encountered an issue or noticed inaccuracies in the API documentation, please <a href="https://www.samsara.com/help" target="_blank">submit a case</a> to our support team.
3878
+ *
3879
+ * @param {Samsara.GetWorkOrderTemplatesRequest} request
3880
+ * @param {BetaApIsClient.RequestOptions} requestOptions - Request-specific configuration.
3881
+ *
3882
+ * @throws {@link Samsara.UnauthorizedError}
3883
+ * @throws {@link Samsara.NotFoundError}
3884
+ * @throws {@link Samsara.MethodNotAllowedError}
3885
+ * @throws {@link Samsara.TooManyRequestsError}
3886
+ * @throws {@link Samsara.InternalServerError}
3887
+ * @throws {@link Samsara.NotImplementedError}
3888
+ * @throws {@link Samsara.BadGatewayError}
3889
+ * @throws {@link Samsara.ServiceUnavailableError}
3890
+ * @throws {@link Samsara.GatewayTimeoutError}
3891
+ *
3892
+ * @example
3893
+ * await client.betaApIs.getWorkOrderTemplates()
3894
+ */
3895
+ getWorkOrderTemplates(request = {}, requestOptions) {
3896
+ return core.HttpResponsePromise.fromPromise(this.__getWorkOrderTemplates(request, requestOptions));
3897
+ }
3898
+ __getWorkOrderTemplates() {
3899
+ return __awaiter(this, arguments, void 0, function* (request = {}, requestOptions) {
3900
+ var _a, _b, _c, _d, _e, _f, _g, _h, _j;
3901
+ const { ids } = request;
3902
+ const _queryParams = {
3903
+ ids,
3904
+ };
3905
+ const _authRequest = yield this._options.authProvider.getAuthRequest();
3906
+ const _headers = (0, headers_js_1.mergeHeaders)(_authRequest.headers, (_a = this._options) === null || _a === void 0 ? void 0 : _a.headers, (0, headers_js_1.mergeOnlyDefinedHeaders)({ "X-Samsara-Version": requestOptions === null || requestOptions === void 0 ? void 0 : requestOptions.version }), requestOptions === null || requestOptions === void 0 ? void 0 : requestOptions.headers);
3907
+ const _response = yield core.fetcher({
3908
+ url: core.url.join((_c = (_b = (yield core.Supplier.get(this._options.baseUrl))) !== null && _b !== void 0 ? _b : (yield core.Supplier.get(this._options.environment))) !== null && _c !== void 0 ? _c : environments.SamsaraEnvironment.ProductionApi, "maintenance/work-order-templates"),
3909
+ method: "GET",
3910
+ headers: _headers,
3911
+ queryParameters: Object.assign(Object.assign({}, _queryParams), requestOptions === null || requestOptions === void 0 ? void 0 : requestOptions.queryParams),
3912
+ timeoutMs: ((_f = (_d = requestOptions === null || requestOptions === void 0 ? void 0 : requestOptions.timeoutInSeconds) !== null && _d !== void 0 ? _d : (_e = this._options) === null || _e === void 0 ? void 0 : _e.timeoutInSeconds) !== null && _f !== void 0 ? _f : 60) * 1000,
3913
+ maxRetries: (_g = requestOptions === null || requestOptions === void 0 ? void 0 : requestOptions.maxRetries) !== null && _g !== void 0 ? _g : (_h = this._options) === null || _h === void 0 ? void 0 : _h.maxRetries,
3914
+ abortSignal: requestOptions === null || requestOptions === void 0 ? void 0 : requestOptions.abortSignal,
3915
+ fetchFn: (_j = this._options) === null || _j === void 0 ? void 0 : _j.fetch,
3916
+ logging: this._options.logging,
3917
+ });
3918
+ if (_response.ok) {
3919
+ return {
3920
+ data: _response.body,
3921
+ rawResponse: _response.rawResponse,
3922
+ };
3923
+ }
3924
+ if (_response.error.reason === "status-code") {
3925
+ switch (_response.error.statusCode) {
3926
+ case 401:
3927
+ throw new Samsara.UnauthorizedError(_response.error.body, _response.rawResponse);
3928
+ case 404:
3929
+ throw new Samsara.NotFoundError(_response.error.body, _response.rawResponse);
3930
+ case 405:
3931
+ throw new Samsara.MethodNotAllowedError(_response.error.body, _response.rawResponse);
3932
+ case 429:
3933
+ throw new Samsara.TooManyRequestsError(_response.error.body, _response.rawResponse);
3934
+ case 500:
3935
+ throw new Samsara.InternalServerError(_response.error.body, _response.rawResponse);
3936
+ case 501:
3937
+ throw new Samsara.NotImplementedError(_response.error.body, _response.rawResponse);
3938
+ case 502:
3939
+ throw new Samsara.BadGatewayError(_response.error.body, _response.rawResponse);
3940
+ case 503:
3941
+ throw new Samsara.ServiceUnavailableError(_response.error.body, _response.rawResponse);
3942
+ case 504:
3943
+ throw new Samsara.GatewayTimeoutError(_response.error.body, _response.rawResponse);
3944
+ default:
3945
+ throw new errors.SamsaraError({
3946
+ statusCode: _response.error.statusCode,
3947
+ body: _response.error.body,
3948
+ rawResponse: _response.rawResponse,
3949
+ });
3950
+ }
3951
+ }
3952
+ return (0, handleNonStatusCodeError_js_1.handleNonStatusCodeError)(_response.error, _response.rawResponse, "GET", "/maintenance/work-order-templates");
3953
+ });
3954
+ }
3869
3955
  /**
3870
3956
  * Returns places for the authorized organization. Supports cursor pagination or batch fetch by Samsara place ids via `placeIds` or by external ids via `externalIds` (mutually exclusive).
3871
3957
  *
@@ -0,0 +1,8 @@
1
+ /**
2
+ * @example
3
+ * {}
4
+ */
5
+ export interface GetWorkOrderTemplatesRequest {
6
+ /** The work order template IDs to look up. Up to 100 ids. Ids that do not resolve to a template (e.g. deleted) are omitted from the response. */
7
+ ids?: string | string[];
8
+ }
@@ -0,0 +1,3 @@
1
+ "use strict";
2
+ // This file was auto-generated by Fern from our API Definition.
3
+ Object.defineProperty(exports, "__esModule", { value: true });
@@ -44,6 +44,7 @@ export type { GetRidershipPassengerRequest } from "./GetRidershipPassengerReques
44
44
  export type { GetRidershipRouteSetupRequest } from "./GetRidershipRouteSetupRequest.js";
45
45
  export type { GetVoiceSessionsRequest } from "./GetVoiceSessionsRequest.js";
46
46
  export type { GetVoiceSessionsStreamRequest } from "./GetVoiceSessionsStreamRequest.js";
47
+ export type { GetWorkOrderTemplatesRequest } from "./GetWorkOrderTemplatesRequest.js";
47
48
  export type { HosDailyLogsUpdateShippingDocsRequestBody } from "./HosDailyLogsUpdateShippingDocsRequestBody.js";
48
49
  export type { JobsCreateJobRequestBody } from "./JobsCreateJobRequestBody.js";
49
50
  export type { JobsPatchJobRequestBody } from "./JobsPatchJobRequestBody.js";
@@ -2,6 +2,8 @@ import type * as Samsara from "../index.js";
2
2
  export interface CreateRoutesStopRequestObjectRequestBody {
3
3
  /** ID of the address. An address [externalId](https://developers.samsara.com/docs/external-ids#using-external-ids) can also be used interchangeably here. */
4
4
  addressId?: string | undefined;
5
+ /** Appointment windows for the stop. */
6
+ appointmentWindows?: Samsara.HosViolationDayObjectRequestBody[] | undefined;
5
7
  /** A map of external ids */
6
8
  externalIds?: Record<string, string> | undefined;
7
9
  /** Name of the stop */
@@ -0,0 +1,6 @@
1
+ export interface HosViolationDayObjectRequestBody {
2
+ /** The end time of the day on which the violation occurred in RFC 3339 format. This is determined by the driver's ELD start hour (00:00 or 12:00) */
3
+ endTime: string;
4
+ /** The start time of the day on which the violation occurred in RFC 3339 format. This is determined by the driver's ELD start hour (00:00 or 12:00) */
5
+ startTime: string;
6
+ }
@@ -0,0 +1,3 @@
1
+ "use strict";
2
+ // This file was auto-generated by Fern from our API Definition.
3
+ Object.defineProperty(exports, "__esModule", { value: true });
@@ -7,6 +7,8 @@ export interface RoutesStopResponseObjectResponseBody {
7
7
  /** Actual GPS-measured distance traveled from the previous stop's departure to this stop's arrival, in meters. Null for the first stop, skipped stops, or if GPS data is unavailable. */
8
8
  actualDistanceMeters?: number | undefined;
9
9
  address?: Samsara.GoaAddressTinyResponseResponseBody | undefined;
10
+ /** Appointment windows for the stop. */
11
+ appointmentWindows?: Samsara.HosViolationDayObjectResponseBody[] | undefined;
10
12
  /** List of documents associated with the stop. */
11
13
  documents?: Samsara.GoaDocumentTinyResponseResponseBody[] | undefined;
12
14
  /** The time the stop became en-route, in RFC 3339 format. */
@@ -2,6 +2,8 @@ import type * as Samsara from "../index.js";
2
2
  export interface UpdateRoutesStopRequestObjectRequestBody {
3
3
  /** ID of the address. An address [externalId](https://developers.samsara.com/docs/external-ids#using-external-ids) can also be used interchangeably here. */
4
4
  addressId?: string | undefined;
5
+ /** Appointment windows for the stop. */
6
+ appointmentWindows?: Samsara.HosViolationDayObjectRequestBody[] | undefined;
5
7
  /** A map of external ids */
6
8
  externalIds?: Record<string, string> | undefined;
7
9
  /** ID of the stop */
@@ -51,6 +51,8 @@ export interface WorkOrderObjectResponseBody {
51
51
  updatedAtTime: string;
52
52
  /** The vendor UUID for the work order. */
53
53
  vendorUuid?: string | undefined;
54
+ /** IDs of the work order template(s) this work order was created from. May include templates that have since been deleted. */
55
+ workOrderTemplateIds?: string[] | undefined;
54
56
  }
55
57
  export declare namespace WorkOrderObjectResponseBody {
56
58
  /** The priority of the work order Valid values: `High`, `Low`, `Medium`, `Urgent` */
@@ -0,0 +1,9 @@
1
+ /**
2
+ * A work order template.
3
+ */
4
+ export interface WorkOrderTemplateObjectResponseBody {
5
+ /** The unique id of the work order template. */
6
+ id: string;
7
+ /** The name of the work order template. */
8
+ name: string;
9
+ }
@@ -0,0 +1,3 @@
1
+ "use strict";
2
+ // This file was auto-generated by Fern from our API Definition.
3
+ Object.defineProperty(exports, "__esModule", { value: true });
@@ -51,6 +51,8 @@ export interface WorkOrderWithTimeEntriesObjectResponseBody {
51
51
  updatedAtTime: string;
52
52
  /** The vendor UUID for the work order. */
53
53
  vendorUuid?: string | undefined;
54
+ /** IDs of the work order template(s) this work order was created from. May include templates that have since been deleted. */
55
+ workOrderTemplateIds?: string[] | undefined;
54
56
  }
55
57
  export declare namespace WorkOrderWithTimeEntriesObjectResponseBody {
56
58
  /** The priority of the work order Valid values: `High`, `Low`, `Medium`, `Urgent` */
@@ -0,0 +1,9 @@
1
+ /**
2
+ * Bad Gateway
3
+ */
4
+ export interface WorkOrdersGetWorkOrderTemplatesBadGatewayErrorResponseBody {
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,3 @@
1
+ "use strict";
2
+ // This file was auto-generated by Fern from our API Definition.
3
+ Object.defineProperty(exports, "__esModule", { value: true });
@@ -0,0 +1,9 @@
1
+ /**
2
+ * Gateway timeout
3
+ */
4
+ export interface WorkOrdersGetWorkOrderTemplatesGatewayTimeoutErrorResponseBody {
5
+ /** Message of error */
6
+ message: string;
7
+ /** The request ID; used when reaching out to support for issues with requests. */
8
+ requestId: string;
9
+ }
@@ -0,0 +1,3 @@
1
+ "use strict";
2
+ // This file was auto-generated by Fern from our API Definition.
3
+ Object.defineProperty(exports, "__esModule", { value: true });
@@ -0,0 +1,9 @@
1
+ /**
2
+ * An internal server error occurred
3
+ */
4
+ export interface WorkOrdersGetWorkOrderTemplatesInternalServerErrorResponseBody {
5
+ /** Message of error */
6
+ message: string;
7
+ /** The request ID; used when reaching out to support for issues with requests. */
8
+ requestId: string;
9
+ }
@@ -0,0 +1,3 @@
1
+ "use strict";
2
+ // This file was auto-generated by Fern from our API Definition.
3
+ Object.defineProperty(exports, "__esModule", { value: true });
@@ -0,0 +1,9 @@
1
+ /**
2
+ * Method not allowed
3
+ */
4
+ export interface WorkOrdersGetWorkOrderTemplatesMethodNotAllowedErrorResponseBody {
5
+ /** Message of error */
6
+ message: string;
7
+ /** The request ID; used when reaching out to support for issues with requests. */
8
+ requestId: string;
9
+ }
@@ -0,0 +1,3 @@
1
+ "use strict";
2
+ // This file was auto-generated by Fern from our API Definition.
3
+ Object.defineProperty(exports, "__esModule", { value: true });
@@ -0,0 +1,9 @@
1
+ /**
2
+ * Resource not found
3
+ */
4
+ export interface WorkOrdersGetWorkOrderTemplatesNotFoundErrorResponseBody {
5
+ /** Message of error */
6
+ message: string;
7
+ /** The request ID; used when reaching out to support for issues with requests. */
8
+ requestId: string;
9
+ }
@@ -0,0 +1,3 @@
1
+ "use strict";
2
+ // This file was auto-generated by Fern from our API Definition.
3
+ Object.defineProperty(exports, "__esModule", { value: true });
@@ -0,0 +1,9 @@
1
+ /**
2
+ * Requested endpoint is not yet implemented
3
+ */
4
+ export interface WorkOrdersGetWorkOrderTemplatesNotImplementedErrorResponseBody {
5
+ /** Message of error */
6
+ message: string;
7
+ /** The request ID; used when reaching out to support for issues with requests. */
8
+ requestId: string;
9
+ }
@@ -0,0 +1,3 @@
1
+ "use strict";
2
+ // This file was auto-generated by Fern from our API Definition.
3
+ Object.defineProperty(exports, "__esModule", { value: true });
@@ -0,0 +1,5 @@
1
+ import type * as Samsara from "../index.js";
2
+ export interface WorkOrdersGetWorkOrderTemplatesResponseBody {
3
+ /** Work order templates. */
4
+ data: Samsara.WorkOrderTemplateObjectResponseBody[];
5
+ }
@@ -0,0 +1,3 @@
1
+ "use strict";
2
+ // This file was auto-generated by Fern from our API Definition.
3
+ Object.defineProperty(exports, "__esModule", { value: true });
@@ -0,0 +1,9 @@
1
+ /**
2
+ * Service unavailable
3
+ */
4
+ export interface WorkOrdersGetWorkOrderTemplatesServiceUnavailableErrorResponseBody {
5
+ /** Message of error */
6
+ message: string;
7
+ /** The request ID; used when reaching out to support for issues with requests. */
8
+ requestId: string;
9
+ }
@@ -0,0 +1,3 @@
1
+ "use strict";
2
+ // This file was auto-generated by Fern from our API Definition.
3
+ Object.defineProperty(exports, "__esModule", { value: true });
@@ -0,0 +1,9 @@
1
+ /**
2
+ * Too many requests
3
+ */
4
+ export interface WorkOrdersGetWorkOrderTemplatesTooManyRequestsErrorResponseBody {
5
+ /** Message of error */
6
+ message: string;
7
+ /** The request ID; used when reaching out to support for issues with requests. */
8
+ requestId: string;
9
+ }
@@ -0,0 +1,3 @@
1
+ "use strict";
2
+ // This file was auto-generated by Fern from our API Definition.
3
+ Object.defineProperty(exports, "__esModule", { value: true });
@@ -0,0 +1,9 @@
1
+ /**
2
+ * Unauthorized
3
+ */
4
+ export interface WorkOrdersGetWorkOrderTemplatesUnauthorizedErrorResponseBody {
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,3 @@
1
+ "use strict";
2
+ // This file was auto-generated by Fern from our API Definition.
3
+ Object.defineProperty(exports, "__esModule", { value: true });
@@ -1374,6 +1374,7 @@ export * from "./HosLogsList.js";
1374
1374
  export * from "./HosLogsResponse.js";
1375
1375
  export * from "./HosShift.js";
1376
1376
  export * from "./HosViolationDataResponseBody.js";
1377
+ export * from "./HosViolationDayObjectRequestBody.js";
1377
1378
  export * from "./HosViolationDayObjectResponseBody.js";
1378
1379
  export * from "./HosViolationObjectResponseBody.js";
1379
1380
  export * from "./HosViolations.js";
@@ -3487,6 +3488,16 @@ export * from "./WorkOrdersGetWorkOrdersResponseBody.js";
3487
3488
  export * from "./WorkOrdersGetWorkOrdersServiceUnavailableErrorResponseBody.js";
3488
3489
  export * from "./WorkOrdersGetWorkOrdersTooManyRequestsErrorResponseBody.js";
3489
3490
  export * from "./WorkOrdersGetWorkOrdersUnauthorizedErrorResponseBody.js";
3491
+ export * from "./WorkOrdersGetWorkOrderTemplatesBadGatewayErrorResponseBody.js";
3492
+ export * from "./WorkOrdersGetWorkOrderTemplatesGatewayTimeoutErrorResponseBody.js";
3493
+ export * from "./WorkOrdersGetWorkOrderTemplatesInternalServerErrorResponseBody.js";
3494
+ export * from "./WorkOrdersGetWorkOrderTemplatesMethodNotAllowedErrorResponseBody.js";
3495
+ export * from "./WorkOrdersGetWorkOrderTemplatesNotFoundErrorResponseBody.js";
3496
+ export * from "./WorkOrdersGetWorkOrderTemplatesNotImplementedErrorResponseBody.js";
3497
+ export * from "./WorkOrdersGetWorkOrderTemplatesResponseBody.js";
3498
+ export * from "./WorkOrdersGetWorkOrderTemplatesServiceUnavailableErrorResponseBody.js";
3499
+ export * from "./WorkOrdersGetWorkOrderTemplatesTooManyRequestsErrorResponseBody.js";
3500
+ export * from "./WorkOrdersGetWorkOrderTemplatesUnauthorizedErrorResponseBody.js";
3490
3501
  export * from "./WorkOrdersPatchWorkOrdersBadGatewayErrorResponseBody.js";
3491
3502
  export * from "./WorkOrdersPatchWorkOrdersGatewayTimeoutErrorResponseBody.js";
3492
3503
  export * from "./WorkOrdersPatchWorkOrdersInternalServerErrorResponseBody.js";
@@ -3530,6 +3541,7 @@ export * from "./WorkOrdersStreamWorkOrdersUnauthorizedErrorResponseBody.js";
3530
3541
  export * from "./WorkOrderTaxCreateObjectRequestBody.js";
3531
3542
  export * from "./WorkOrderTaxObjectRequestBody.js";
3532
3543
  export * from "./WorkOrderTaxObjectResponseBody.js";
3544
+ export * from "./WorkOrderTemplateObjectResponseBody.js";
3533
3545
  export * from "./WorkOrderTimeEntryObjectResponseBody.js";
3534
3546
  export * from "./WorkOrderUnallocatedLaborObjectResponseBody.js";
3535
3547
  export * from "./WorkOrderWithTimeEntriesObjectResponseBody.js";
@@ -1390,6 +1390,7 @@ __exportStar(require("./HosLogsList.js"), exports);
1390
1390
  __exportStar(require("./HosLogsResponse.js"), exports);
1391
1391
  __exportStar(require("./HosShift.js"), exports);
1392
1392
  __exportStar(require("./HosViolationDataResponseBody.js"), exports);
1393
+ __exportStar(require("./HosViolationDayObjectRequestBody.js"), exports);
1393
1394
  __exportStar(require("./HosViolationDayObjectResponseBody.js"), exports);
1394
1395
  __exportStar(require("./HosViolationObjectResponseBody.js"), exports);
1395
1396
  __exportStar(require("./HosViolations.js"), exports);
@@ -3503,6 +3504,16 @@ __exportStar(require("./WorkOrdersGetWorkOrdersResponseBody.js"), exports);
3503
3504
  __exportStar(require("./WorkOrdersGetWorkOrdersServiceUnavailableErrorResponseBody.js"), exports);
3504
3505
  __exportStar(require("./WorkOrdersGetWorkOrdersTooManyRequestsErrorResponseBody.js"), exports);
3505
3506
  __exportStar(require("./WorkOrdersGetWorkOrdersUnauthorizedErrorResponseBody.js"), exports);
3507
+ __exportStar(require("./WorkOrdersGetWorkOrderTemplatesBadGatewayErrorResponseBody.js"), exports);
3508
+ __exportStar(require("./WorkOrdersGetWorkOrderTemplatesGatewayTimeoutErrorResponseBody.js"), exports);
3509
+ __exportStar(require("./WorkOrdersGetWorkOrderTemplatesInternalServerErrorResponseBody.js"), exports);
3510
+ __exportStar(require("./WorkOrdersGetWorkOrderTemplatesMethodNotAllowedErrorResponseBody.js"), exports);
3511
+ __exportStar(require("./WorkOrdersGetWorkOrderTemplatesNotFoundErrorResponseBody.js"), exports);
3512
+ __exportStar(require("./WorkOrdersGetWorkOrderTemplatesNotImplementedErrorResponseBody.js"), exports);
3513
+ __exportStar(require("./WorkOrdersGetWorkOrderTemplatesResponseBody.js"), exports);
3514
+ __exportStar(require("./WorkOrdersGetWorkOrderTemplatesServiceUnavailableErrorResponseBody.js"), exports);
3515
+ __exportStar(require("./WorkOrdersGetWorkOrderTemplatesTooManyRequestsErrorResponseBody.js"), exports);
3516
+ __exportStar(require("./WorkOrdersGetWorkOrderTemplatesUnauthorizedErrorResponseBody.js"), exports);
3506
3517
  __exportStar(require("./WorkOrdersPatchWorkOrdersBadGatewayErrorResponseBody.js"), exports);
3507
3518
  __exportStar(require("./WorkOrdersPatchWorkOrdersGatewayTimeoutErrorResponseBody.js"), exports);
3508
3519
  __exportStar(require("./WorkOrdersPatchWorkOrdersInternalServerErrorResponseBody.js"), exports);
@@ -3546,6 +3557,7 @@ __exportStar(require("./WorkOrdersStreamWorkOrdersUnauthorizedErrorResponseBody.
3546
3557
  __exportStar(require("./WorkOrderTaxCreateObjectRequestBody.js"), exports);
3547
3558
  __exportStar(require("./WorkOrderTaxObjectRequestBody.js"), exports);
3548
3559
  __exportStar(require("./WorkOrderTaxObjectResponseBody.js"), exports);
3560
+ __exportStar(require("./WorkOrderTemplateObjectResponseBody.js"), exports);
3549
3561
  __exportStar(require("./WorkOrderTimeEntryObjectResponseBody.js"), exports);
3550
3562
  __exportStar(require("./WorkOrderUnallocatedLaborObjectResponseBody.js"), exports);
3551
3563
  __exportStar(require("./WorkOrderWithTimeEntriesObjectResponseBody.js"), exports);
@@ -1 +1 @@
1
- export declare const SDK_VERSION = "13.17.1";
1
+ export declare const SDK_VERSION = "13.19.0";
@@ -1,4 +1,4 @@
1
1
  "use strict";
2
2
  Object.defineProperty(exports, "__esModule", { value: true });
3
3
  exports.SDK_VERSION = void 0;
4
- exports.SDK_VERSION = "13.17.1";
4
+ exports.SDK_VERSION = "13.19.0";
@@ -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.17.1",
11
- "User-Agent": "@samsarahq/samsara/13.17.1",
10
+ "X-Fern-SDK-Version": "13.19.0",
11
+ "User-Agent": "@samsarahq/samsara/13.19.0",
12
12
  "X-Fern-Runtime": core.RUNTIME.type,
13
13
  "X-Fern-Runtime-Version": core.RUNTIME.version,
14
14
  "X-Samsara-Version": (_a = options === null || options === void 0 ? void 0 : options.version) !== null && _a !== void 0 ? _a : "2025-06-11",
@@ -1298,6 +1298,34 @@ export declare class BetaApIsClient {
1298
1298
  */
1299
1299
  deleteHubRouteTemplate(request: Samsara.DeleteHubRouteTemplateRequest, requestOptions?: BetaApIsClient.RequestOptions): core.HttpResponsePromise<void>;
1300
1300
  private __deleteHubRouteTemplate;
1301
+ /**
1302
+ * Gets work order templates by id. Ids that do not resolve to a template (e.g. deleted) are omitted from the response.
1303
+ *
1304
+ * <b>Rate limit:</b> 5 requests/sec (learn more about rate limits <a href="https://developers.samsara.com/docs/rate-limits" target="_blank">here</a>).
1305
+ *
1306
+ * To use this endpoint, select **Read Work Orders** under the Work Orders category when creating or editing an API token. <a href="https://developers.samsara.com/docs/authentication#scopes-for-api-tokens" target="_blank">Learn More.</a>
1307
+ *
1308
+ *
1309
+ * **Submit Feedback**: Likes, dislikes, and API feature requests should be filed as feedback in our <a href="https://forms.gle/zkD4NCH7HjKb7mm69" target="_blank">API feedback form</a>. If you encountered an issue or noticed inaccuracies in the API documentation, please <a href="https://www.samsara.com/help" target="_blank">submit a case</a> to our support team.
1310
+ *
1311
+ * @param {Samsara.GetWorkOrderTemplatesRequest} request
1312
+ * @param {BetaApIsClient.RequestOptions} requestOptions - Request-specific configuration.
1313
+ *
1314
+ * @throws {@link Samsara.UnauthorizedError}
1315
+ * @throws {@link Samsara.NotFoundError}
1316
+ * @throws {@link Samsara.MethodNotAllowedError}
1317
+ * @throws {@link Samsara.TooManyRequestsError}
1318
+ * @throws {@link Samsara.InternalServerError}
1319
+ * @throws {@link Samsara.NotImplementedError}
1320
+ * @throws {@link Samsara.BadGatewayError}
1321
+ * @throws {@link Samsara.ServiceUnavailableError}
1322
+ * @throws {@link Samsara.GatewayTimeoutError}
1323
+ *
1324
+ * @example
1325
+ * await client.betaApIs.getWorkOrderTemplates()
1326
+ */
1327
+ getWorkOrderTemplates(request?: Samsara.GetWorkOrderTemplatesRequest, requestOptions?: BetaApIsClient.RequestOptions): core.HttpResponsePromise<Samsara.WorkOrdersGetWorkOrderTemplatesResponseBody>;
1328
+ private __getWorkOrderTemplates;
1301
1329
  /**
1302
1330
  * Returns places for the authorized organization. Supports cursor pagination or batch fetch by Samsara place ids via `placeIds` or by external ids via `externalIds` (mutually exclusive).
1303
1331
  *
@@ -3830,6 +3830,92 @@ export class BetaApIsClient {
3830
3830
  return handleNonStatusCodeError(_response.error, _response.rawResponse, "DELETE", "/hub/route-templates");
3831
3831
  });
3832
3832
  }
3833
+ /**
3834
+ * Gets work order templates by id. Ids that do not resolve to a template (e.g. deleted) are omitted from the response.
3835
+ *
3836
+ * <b>Rate limit:</b> 5 requests/sec (learn more about rate limits <a href="https://developers.samsara.com/docs/rate-limits" target="_blank">here</a>).
3837
+ *
3838
+ * To use this endpoint, select **Read Work Orders** under the Work Orders category when creating or editing an API token. <a href="https://developers.samsara.com/docs/authentication#scopes-for-api-tokens" target="_blank">Learn More.</a>
3839
+ *
3840
+ *
3841
+ * **Submit Feedback**: Likes, dislikes, and API feature requests should be filed as feedback in our <a href="https://forms.gle/zkD4NCH7HjKb7mm69" target="_blank">API feedback form</a>. If you encountered an issue or noticed inaccuracies in the API documentation, please <a href="https://www.samsara.com/help" target="_blank">submit a case</a> to our support team.
3842
+ *
3843
+ * @param {Samsara.GetWorkOrderTemplatesRequest} request
3844
+ * @param {BetaApIsClient.RequestOptions} requestOptions - Request-specific configuration.
3845
+ *
3846
+ * @throws {@link Samsara.UnauthorizedError}
3847
+ * @throws {@link Samsara.NotFoundError}
3848
+ * @throws {@link Samsara.MethodNotAllowedError}
3849
+ * @throws {@link Samsara.TooManyRequestsError}
3850
+ * @throws {@link Samsara.InternalServerError}
3851
+ * @throws {@link Samsara.NotImplementedError}
3852
+ * @throws {@link Samsara.BadGatewayError}
3853
+ * @throws {@link Samsara.ServiceUnavailableError}
3854
+ * @throws {@link Samsara.GatewayTimeoutError}
3855
+ *
3856
+ * @example
3857
+ * await client.betaApIs.getWorkOrderTemplates()
3858
+ */
3859
+ getWorkOrderTemplates(request = {}, requestOptions) {
3860
+ return core.HttpResponsePromise.fromPromise(this.__getWorkOrderTemplates(request, requestOptions));
3861
+ }
3862
+ __getWorkOrderTemplates() {
3863
+ return __awaiter(this, arguments, void 0, function* (request = {}, requestOptions) {
3864
+ var _a, _b, _c, _d, _e, _f, _g, _h, _j;
3865
+ const { ids } = request;
3866
+ const _queryParams = {
3867
+ ids,
3868
+ };
3869
+ const _authRequest = yield this._options.authProvider.getAuthRequest();
3870
+ const _headers = mergeHeaders(_authRequest.headers, (_a = this._options) === null || _a === void 0 ? void 0 : _a.headers, mergeOnlyDefinedHeaders({ "X-Samsara-Version": requestOptions === null || requestOptions === void 0 ? void 0 : requestOptions.version }), requestOptions === null || requestOptions === void 0 ? void 0 : requestOptions.headers);
3871
+ const _response = yield core.fetcher({
3872
+ url: core.url.join((_c = (_b = (yield core.Supplier.get(this._options.baseUrl))) !== null && _b !== void 0 ? _b : (yield core.Supplier.get(this._options.environment))) !== null && _c !== void 0 ? _c : environments.SamsaraEnvironment.ProductionApi, "maintenance/work-order-templates"),
3873
+ method: "GET",
3874
+ headers: _headers,
3875
+ queryParameters: Object.assign(Object.assign({}, _queryParams), requestOptions === null || requestOptions === void 0 ? void 0 : requestOptions.queryParams),
3876
+ timeoutMs: ((_f = (_d = requestOptions === null || requestOptions === void 0 ? void 0 : requestOptions.timeoutInSeconds) !== null && _d !== void 0 ? _d : (_e = this._options) === null || _e === void 0 ? void 0 : _e.timeoutInSeconds) !== null && _f !== void 0 ? _f : 60) * 1000,
3877
+ maxRetries: (_g = requestOptions === null || requestOptions === void 0 ? void 0 : requestOptions.maxRetries) !== null && _g !== void 0 ? _g : (_h = this._options) === null || _h === void 0 ? void 0 : _h.maxRetries,
3878
+ abortSignal: requestOptions === null || requestOptions === void 0 ? void 0 : requestOptions.abortSignal,
3879
+ fetchFn: (_j = this._options) === null || _j === void 0 ? void 0 : _j.fetch,
3880
+ logging: this._options.logging,
3881
+ });
3882
+ if (_response.ok) {
3883
+ return {
3884
+ data: _response.body,
3885
+ rawResponse: _response.rawResponse,
3886
+ };
3887
+ }
3888
+ if (_response.error.reason === "status-code") {
3889
+ switch (_response.error.statusCode) {
3890
+ case 401:
3891
+ throw new Samsara.UnauthorizedError(_response.error.body, _response.rawResponse);
3892
+ case 404:
3893
+ throw new Samsara.NotFoundError(_response.error.body, _response.rawResponse);
3894
+ case 405:
3895
+ throw new Samsara.MethodNotAllowedError(_response.error.body, _response.rawResponse);
3896
+ case 429:
3897
+ throw new Samsara.TooManyRequestsError(_response.error.body, _response.rawResponse);
3898
+ case 500:
3899
+ throw new Samsara.InternalServerError(_response.error.body, _response.rawResponse);
3900
+ case 501:
3901
+ throw new Samsara.NotImplementedError(_response.error.body, _response.rawResponse);
3902
+ case 502:
3903
+ throw new Samsara.BadGatewayError(_response.error.body, _response.rawResponse);
3904
+ case 503:
3905
+ throw new Samsara.ServiceUnavailableError(_response.error.body, _response.rawResponse);
3906
+ case 504:
3907
+ throw new Samsara.GatewayTimeoutError(_response.error.body, _response.rawResponse);
3908
+ default:
3909
+ throw new errors.SamsaraError({
3910
+ statusCode: _response.error.statusCode,
3911
+ body: _response.error.body,
3912
+ rawResponse: _response.rawResponse,
3913
+ });
3914
+ }
3915
+ }
3916
+ return handleNonStatusCodeError(_response.error, _response.rawResponse, "GET", "/maintenance/work-order-templates");
3917
+ });
3918
+ }
3833
3919
  /**
3834
3920
  * Returns places for the authorized organization. Supports cursor pagination or batch fetch by Samsara place ids via `placeIds` or by external ids via `externalIds` (mutually exclusive).
3835
3921
  *
@@ -0,0 +1,8 @@
1
+ /**
2
+ * @example
3
+ * {}
4
+ */
5
+ export interface GetWorkOrderTemplatesRequest {
6
+ /** The work order template IDs to look up. Up to 100 ids. Ids that do not resolve to a template (e.g. deleted) are omitted from the response. */
7
+ ids?: string | string[];
8
+ }
@@ -0,0 +1,2 @@
1
+ // This file was auto-generated by Fern from our API Definition.
2
+ export {};
@@ -44,6 +44,7 @@ export type { GetRidershipPassengerRequest } from "./GetRidershipPassengerReques
44
44
  export type { GetRidershipRouteSetupRequest } from "./GetRidershipRouteSetupRequest.mjs";
45
45
  export type { GetVoiceSessionsRequest } from "./GetVoiceSessionsRequest.mjs";
46
46
  export type { GetVoiceSessionsStreamRequest } from "./GetVoiceSessionsStreamRequest.mjs";
47
+ export type { GetWorkOrderTemplatesRequest } from "./GetWorkOrderTemplatesRequest.mjs";
47
48
  export type { HosDailyLogsUpdateShippingDocsRequestBody } from "./HosDailyLogsUpdateShippingDocsRequestBody.mjs";
48
49
  export type { JobsCreateJobRequestBody } from "./JobsCreateJobRequestBody.mjs";
49
50
  export type { JobsPatchJobRequestBody } from "./JobsPatchJobRequestBody.mjs";
@@ -2,6 +2,8 @@ import type * as Samsara from "../index.mjs";
2
2
  export interface CreateRoutesStopRequestObjectRequestBody {
3
3
  /** ID of the address. An address [externalId](https://developers.samsara.com/docs/external-ids#using-external-ids) can also be used interchangeably here. */
4
4
  addressId?: string | undefined;
5
+ /** Appointment windows for the stop. */
6
+ appointmentWindows?: Samsara.HosViolationDayObjectRequestBody[] | undefined;
5
7
  /** A map of external ids */
6
8
  externalIds?: Record<string, string> | undefined;
7
9
  /** Name of the stop */
@@ -0,0 +1,6 @@
1
+ export interface HosViolationDayObjectRequestBody {
2
+ /** The end time of the day on which the violation occurred in RFC 3339 format. This is determined by the driver's ELD start hour (00:00 or 12:00) */
3
+ endTime: string;
4
+ /** The start time of the day on which the violation occurred in RFC 3339 format. This is determined by the driver's ELD start hour (00:00 or 12:00) */
5
+ startTime: string;
6
+ }
@@ -0,0 +1,2 @@
1
+ // This file was auto-generated by Fern from our API Definition.
2
+ export {};
@@ -7,6 +7,8 @@ export interface RoutesStopResponseObjectResponseBody {
7
7
  /** Actual GPS-measured distance traveled from the previous stop's departure to this stop's arrival, in meters. Null for the first stop, skipped stops, or if GPS data is unavailable. */
8
8
  actualDistanceMeters?: number | undefined;
9
9
  address?: Samsara.GoaAddressTinyResponseResponseBody | undefined;
10
+ /** Appointment windows for the stop. */
11
+ appointmentWindows?: Samsara.HosViolationDayObjectResponseBody[] | undefined;
10
12
  /** List of documents associated with the stop. */
11
13
  documents?: Samsara.GoaDocumentTinyResponseResponseBody[] | undefined;
12
14
  /** The time the stop became en-route, in RFC 3339 format. */
@@ -2,6 +2,8 @@ import type * as Samsara from "../index.mjs";
2
2
  export interface UpdateRoutesStopRequestObjectRequestBody {
3
3
  /** ID of the address. An address [externalId](https://developers.samsara.com/docs/external-ids#using-external-ids) can also be used interchangeably here. */
4
4
  addressId?: string | undefined;
5
+ /** Appointment windows for the stop. */
6
+ appointmentWindows?: Samsara.HosViolationDayObjectRequestBody[] | undefined;
5
7
  /** A map of external ids */
6
8
  externalIds?: Record<string, string> | undefined;
7
9
  /** ID of the stop */
@@ -51,6 +51,8 @@ export interface WorkOrderObjectResponseBody {
51
51
  updatedAtTime: string;
52
52
  /** The vendor UUID for the work order. */
53
53
  vendorUuid?: string | undefined;
54
+ /** IDs of the work order template(s) this work order was created from. May include templates that have since been deleted. */
55
+ workOrderTemplateIds?: string[] | undefined;
54
56
  }
55
57
  export declare namespace WorkOrderObjectResponseBody {
56
58
  /** The priority of the work order Valid values: `High`, `Low`, `Medium`, `Urgent` */
@@ -0,0 +1,9 @@
1
+ /**
2
+ * A work order template.
3
+ */
4
+ export interface WorkOrderTemplateObjectResponseBody {
5
+ /** The unique id of the work order template. */
6
+ id: string;
7
+ /** The name of the work order template. */
8
+ name: string;
9
+ }
@@ -0,0 +1,2 @@
1
+ // This file was auto-generated by Fern from our API Definition.
2
+ export {};
@@ -51,6 +51,8 @@ export interface WorkOrderWithTimeEntriesObjectResponseBody {
51
51
  updatedAtTime: string;
52
52
  /** The vendor UUID for the work order. */
53
53
  vendorUuid?: string | undefined;
54
+ /** IDs of the work order template(s) this work order was created from. May include templates that have since been deleted. */
55
+ workOrderTemplateIds?: string[] | undefined;
54
56
  }
55
57
  export declare namespace WorkOrderWithTimeEntriesObjectResponseBody {
56
58
  /** The priority of the work order Valid values: `High`, `Low`, `Medium`, `Urgent` */
@@ -0,0 +1,9 @@
1
+ /**
2
+ * Bad Gateway
3
+ */
4
+ export interface WorkOrdersGetWorkOrderTemplatesBadGatewayErrorResponseBody {
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,2 @@
1
+ // This file was auto-generated by Fern from our API Definition.
2
+ export {};
@@ -0,0 +1,9 @@
1
+ /**
2
+ * Gateway timeout
3
+ */
4
+ export interface WorkOrdersGetWorkOrderTemplatesGatewayTimeoutErrorResponseBody {
5
+ /** Message of error */
6
+ message: string;
7
+ /** The request ID; used when reaching out to support for issues with requests. */
8
+ requestId: string;
9
+ }
@@ -0,0 +1,2 @@
1
+ // This file was auto-generated by Fern from our API Definition.
2
+ export {};
@@ -0,0 +1,9 @@
1
+ /**
2
+ * An internal server error occurred
3
+ */
4
+ export interface WorkOrdersGetWorkOrderTemplatesInternalServerErrorResponseBody {
5
+ /** Message of error */
6
+ message: string;
7
+ /** The request ID; used when reaching out to support for issues with requests. */
8
+ requestId: string;
9
+ }
@@ -0,0 +1,2 @@
1
+ // This file was auto-generated by Fern from our API Definition.
2
+ export {};
@@ -0,0 +1,9 @@
1
+ /**
2
+ * Method not allowed
3
+ */
4
+ export interface WorkOrdersGetWorkOrderTemplatesMethodNotAllowedErrorResponseBody {
5
+ /** Message of error */
6
+ message: string;
7
+ /** The request ID; used when reaching out to support for issues with requests. */
8
+ requestId: string;
9
+ }
@@ -0,0 +1,2 @@
1
+ // This file was auto-generated by Fern from our API Definition.
2
+ export {};
@@ -0,0 +1,9 @@
1
+ /**
2
+ * Resource not found
3
+ */
4
+ export interface WorkOrdersGetWorkOrderTemplatesNotFoundErrorResponseBody {
5
+ /** Message of error */
6
+ message: string;
7
+ /** The request ID; used when reaching out to support for issues with requests. */
8
+ requestId: string;
9
+ }
@@ -0,0 +1,2 @@
1
+ // This file was auto-generated by Fern from our API Definition.
2
+ export {};
@@ -0,0 +1,9 @@
1
+ /**
2
+ * Requested endpoint is not yet implemented
3
+ */
4
+ export interface WorkOrdersGetWorkOrderTemplatesNotImplementedErrorResponseBody {
5
+ /** Message of error */
6
+ message: string;
7
+ /** The request ID; used when reaching out to support for issues with requests. */
8
+ requestId: string;
9
+ }
@@ -0,0 +1,2 @@
1
+ // This file was auto-generated by Fern from our API Definition.
2
+ export {};
@@ -0,0 +1,5 @@
1
+ import type * as Samsara from "../index.mjs";
2
+ export interface WorkOrdersGetWorkOrderTemplatesResponseBody {
3
+ /** Work order templates. */
4
+ data: Samsara.WorkOrderTemplateObjectResponseBody[];
5
+ }
@@ -0,0 +1,2 @@
1
+ // This file was auto-generated by Fern from our API Definition.
2
+ export {};
@@ -0,0 +1,9 @@
1
+ /**
2
+ * Service unavailable
3
+ */
4
+ export interface WorkOrdersGetWorkOrderTemplatesServiceUnavailableErrorResponseBody {
5
+ /** Message of error */
6
+ message: string;
7
+ /** The request ID; used when reaching out to support for issues with requests. */
8
+ requestId: string;
9
+ }
@@ -0,0 +1,2 @@
1
+ // This file was auto-generated by Fern from our API Definition.
2
+ export {};
@@ -0,0 +1,9 @@
1
+ /**
2
+ * Too many requests
3
+ */
4
+ export interface WorkOrdersGetWorkOrderTemplatesTooManyRequestsErrorResponseBody {
5
+ /** Message of error */
6
+ message: string;
7
+ /** The request ID; used when reaching out to support for issues with requests. */
8
+ requestId: string;
9
+ }
@@ -0,0 +1,2 @@
1
+ // This file was auto-generated by Fern from our API Definition.
2
+ export {};
@@ -0,0 +1,9 @@
1
+ /**
2
+ * Unauthorized
3
+ */
4
+ export interface WorkOrdersGetWorkOrderTemplatesUnauthorizedErrorResponseBody {
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,2 @@
1
+ // This file was auto-generated by Fern from our API Definition.
2
+ export {};
@@ -1374,6 +1374,7 @@ export * from "./HosLogsList.mjs";
1374
1374
  export * from "./HosLogsResponse.mjs";
1375
1375
  export * from "./HosShift.mjs";
1376
1376
  export * from "./HosViolationDataResponseBody.mjs";
1377
+ export * from "./HosViolationDayObjectRequestBody.mjs";
1377
1378
  export * from "./HosViolationDayObjectResponseBody.mjs";
1378
1379
  export * from "./HosViolationObjectResponseBody.mjs";
1379
1380
  export * from "./HosViolations.mjs";
@@ -3487,6 +3488,16 @@ export * from "./WorkOrdersGetWorkOrdersResponseBody.mjs";
3487
3488
  export * from "./WorkOrdersGetWorkOrdersServiceUnavailableErrorResponseBody.mjs";
3488
3489
  export * from "./WorkOrdersGetWorkOrdersTooManyRequestsErrorResponseBody.mjs";
3489
3490
  export * from "./WorkOrdersGetWorkOrdersUnauthorizedErrorResponseBody.mjs";
3491
+ export * from "./WorkOrdersGetWorkOrderTemplatesBadGatewayErrorResponseBody.mjs";
3492
+ export * from "./WorkOrdersGetWorkOrderTemplatesGatewayTimeoutErrorResponseBody.mjs";
3493
+ export * from "./WorkOrdersGetWorkOrderTemplatesInternalServerErrorResponseBody.mjs";
3494
+ export * from "./WorkOrdersGetWorkOrderTemplatesMethodNotAllowedErrorResponseBody.mjs";
3495
+ export * from "./WorkOrdersGetWorkOrderTemplatesNotFoundErrorResponseBody.mjs";
3496
+ export * from "./WorkOrdersGetWorkOrderTemplatesNotImplementedErrorResponseBody.mjs";
3497
+ export * from "./WorkOrdersGetWorkOrderTemplatesResponseBody.mjs";
3498
+ export * from "./WorkOrdersGetWorkOrderTemplatesServiceUnavailableErrorResponseBody.mjs";
3499
+ export * from "./WorkOrdersGetWorkOrderTemplatesTooManyRequestsErrorResponseBody.mjs";
3500
+ export * from "./WorkOrdersGetWorkOrderTemplatesUnauthorizedErrorResponseBody.mjs";
3490
3501
  export * from "./WorkOrdersPatchWorkOrdersBadGatewayErrorResponseBody.mjs";
3491
3502
  export * from "./WorkOrdersPatchWorkOrdersGatewayTimeoutErrorResponseBody.mjs";
3492
3503
  export * from "./WorkOrdersPatchWorkOrdersInternalServerErrorResponseBody.mjs";
@@ -3530,6 +3541,7 @@ export * from "./WorkOrdersStreamWorkOrdersUnauthorizedErrorResponseBody.mjs";
3530
3541
  export * from "./WorkOrderTaxCreateObjectRequestBody.mjs";
3531
3542
  export * from "./WorkOrderTaxObjectRequestBody.mjs";
3532
3543
  export * from "./WorkOrderTaxObjectResponseBody.mjs";
3544
+ export * from "./WorkOrderTemplateObjectResponseBody.mjs";
3533
3545
  export * from "./WorkOrderTimeEntryObjectResponseBody.mjs";
3534
3546
  export * from "./WorkOrderUnallocatedLaborObjectResponseBody.mjs";
3535
3547
  export * from "./WorkOrderWithTimeEntriesObjectResponseBody.mjs";
@@ -1374,6 +1374,7 @@ export * from "./HosLogsList.mjs";
1374
1374
  export * from "./HosLogsResponse.mjs";
1375
1375
  export * from "./HosShift.mjs";
1376
1376
  export * from "./HosViolationDataResponseBody.mjs";
1377
+ export * from "./HosViolationDayObjectRequestBody.mjs";
1377
1378
  export * from "./HosViolationDayObjectResponseBody.mjs";
1378
1379
  export * from "./HosViolationObjectResponseBody.mjs";
1379
1380
  export * from "./HosViolations.mjs";
@@ -3487,6 +3488,16 @@ export * from "./WorkOrdersGetWorkOrdersResponseBody.mjs";
3487
3488
  export * from "./WorkOrdersGetWorkOrdersServiceUnavailableErrorResponseBody.mjs";
3488
3489
  export * from "./WorkOrdersGetWorkOrdersTooManyRequestsErrorResponseBody.mjs";
3489
3490
  export * from "./WorkOrdersGetWorkOrdersUnauthorizedErrorResponseBody.mjs";
3491
+ export * from "./WorkOrdersGetWorkOrderTemplatesBadGatewayErrorResponseBody.mjs";
3492
+ export * from "./WorkOrdersGetWorkOrderTemplatesGatewayTimeoutErrorResponseBody.mjs";
3493
+ export * from "./WorkOrdersGetWorkOrderTemplatesInternalServerErrorResponseBody.mjs";
3494
+ export * from "./WorkOrdersGetWorkOrderTemplatesMethodNotAllowedErrorResponseBody.mjs";
3495
+ export * from "./WorkOrdersGetWorkOrderTemplatesNotFoundErrorResponseBody.mjs";
3496
+ export * from "./WorkOrdersGetWorkOrderTemplatesNotImplementedErrorResponseBody.mjs";
3497
+ export * from "./WorkOrdersGetWorkOrderTemplatesResponseBody.mjs";
3498
+ export * from "./WorkOrdersGetWorkOrderTemplatesServiceUnavailableErrorResponseBody.mjs";
3499
+ export * from "./WorkOrdersGetWorkOrderTemplatesTooManyRequestsErrorResponseBody.mjs";
3500
+ export * from "./WorkOrdersGetWorkOrderTemplatesUnauthorizedErrorResponseBody.mjs";
3490
3501
  export * from "./WorkOrdersPatchWorkOrdersBadGatewayErrorResponseBody.mjs";
3491
3502
  export * from "./WorkOrdersPatchWorkOrdersGatewayTimeoutErrorResponseBody.mjs";
3492
3503
  export * from "./WorkOrdersPatchWorkOrdersInternalServerErrorResponseBody.mjs";
@@ -3530,6 +3541,7 @@ export * from "./WorkOrdersStreamWorkOrdersUnauthorizedErrorResponseBody.mjs";
3530
3541
  export * from "./WorkOrderTaxCreateObjectRequestBody.mjs";
3531
3542
  export * from "./WorkOrderTaxObjectRequestBody.mjs";
3532
3543
  export * from "./WorkOrderTaxObjectResponseBody.mjs";
3544
+ export * from "./WorkOrderTemplateObjectResponseBody.mjs";
3533
3545
  export * from "./WorkOrderTimeEntryObjectResponseBody.mjs";
3534
3546
  export * from "./WorkOrderUnallocatedLaborObjectResponseBody.mjs";
3535
3547
  export * from "./WorkOrderWithTimeEntriesObjectResponseBody.mjs";
@@ -1 +1 @@
1
- export declare const SDK_VERSION = "13.17.1";
1
+ export declare const SDK_VERSION = "13.19.0";
@@ -1 +1 @@
1
- export const SDK_VERSION = "13.17.1";
1
+ export const SDK_VERSION = "13.19.0";
package/package.json CHANGED
@@ -1,6 +1,6 @@
1
1
  {
2
2
  "name": "@samsarahq/samsara",
3
- "version": "13.17.1",
3
+ "version": "13.19.0",
4
4
  "private": false,
5
5
  "repository": {
6
6
  "type": "git",
package/reference.md CHANGED
@@ -3458,6 +3458,76 @@ await client.betaApIs.deleteHubRouteTemplate({
3458
3458
  </dl>
3459
3459
 
3460
3460
 
3461
+ </dd>
3462
+ </dl>
3463
+ </details>
3464
+
3465
+ <details><summary><code>client.betaApIs.<a href="/src/api/resources/betaApIs/client/Client.ts">getWorkOrderTemplates</a>({ ...params }) -> Samsara.WorkOrdersGetWorkOrderTemplatesResponseBody</code></summary>
3466
+ <dl>
3467
+ <dd>
3468
+
3469
+ #### 📝 Description
3470
+
3471
+ <dl>
3472
+ <dd>
3473
+
3474
+ <dl>
3475
+ <dd>
3476
+
3477
+ Gets work order templates by id. Ids that do not resolve to a template (e.g. deleted) are omitted from the response.
3478
+
3479
+ <b>Rate limit:</b> 5 requests/sec (learn more about rate limits <a href="https://developers.samsara.com/docs/rate-limits" target="_blank">here</a>).
3480
+
3481
+ To use this endpoint, select **Read Work Orders** under the Work Orders category when creating or editing an API token. <a href="https://developers.samsara.com/docs/authentication#scopes-for-api-tokens" target="_blank">Learn More.</a>
3482
+
3483
+
3484
+ **Submit Feedback**: Likes, dislikes, and API feature requests should be filed as feedback in our <a href="https://forms.gle/zkD4NCH7HjKb7mm69" target="_blank">API feedback form</a>. If you encountered an issue or noticed inaccuracies in the API documentation, please <a href="https://www.samsara.com/help" target="_blank">submit a case</a> to our support team.
3485
+ </dd>
3486
+ </dl>
3487
+ </dd>
3488
+ </dl>
3489
+
3490
+ #### 🔌 Usage
3491
+
3492
+ <dl>
3493
+ <dd>
3494
+
3495
+ <dl>
3496
+ <dd>
3497
+
3498
+ ```typescript
3499
+ await client.betaApIs.getWorkOrderTemplates();
3500
+
3501
+ ```
3502
+ </dd>
3503
+ </dl>
3504
+ </dd>
3505
+ </dl>
3506
+
3507
+ #### ⚙️ Parameters
3508
+
3509
+ <dl>
3510
+ <dd>
3511
+
3512
+ <dl>
3513
+ <dd>
3514
+
3515
+ **request:** `Samsara.GetWorkOrderTemplatesRequest`
3516
+
3517
+ </dd>
3518
+ </dl>
3519
+
3520
+ <dl>
3521
+ <dd>
3522
+
3523
+ **requestOptions:** `BetaApIsClient.RequestOptions`
3524
+
3525
+ </dd>
3526
+ </dl>
3527
+ </dd>
3528
+ </dl>
3529
+
3530
+
3461
3531
  </dd>
3462
3532
  </dl>
3463
3533
  </details>