@samsarahq/samsara 13.28.0 → 13.29.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 +90 -0
- package/dist/cjs/api/resources/betaApIs/client/requests/GetPlaceGeocodeRequest.d.ts +14 -0
- package/dist/cjs/api/resources/betaApIs/client/requests/GetPlaceGeocodeRequest.js +3 -0
- package/dist/cjs/api/resources/betaApIs/client/requests/index.d.ts +1 -0
- package/dist/cjs/api/types/PlaceGeocodeResultResponseResponseBody.d.ts +9 -0
- package/dist/cjs/api/types/PlaceGeocodeResultResponseResponseBody.js +3 -0
- package/dist/cjs/api/types/PlacesGetPlaceGeocodeBadGatewayErrorResponseBody.d.ts +9 -0
- package/dist/cjs/api/types/PlacesGetPlaceGeocodeBadGatewayErrorResponseBody.js +3 -0
- package/dist/cjs/api/types/PlacesGetPlaceGeocodeGatewayTimeoutErrorResponseBody.d.ts +9 -0
- package/dist/cjs/api/types/PlacesGetPlaceGeocodeGatewayTimeoutErrorResponseBody.js +3 -0
- package/dist/cjs/api/types/PlacesGetPlaceGeocodeInternalServerErrorResponseBody.d.ts +9 -0
- package/dist/cjs/api/types/PlacesGetPlaceGeocodeInternalServerErrorResponseBody.js +3 -0
- package/dist/cjs/api/types/PlacesGetPlaceGeocodeMethodNotAllowedErrorResponseBody.d.ts +9 -0
- package/dist/cjs/api/types/PlacesGetPlaceGeocodeMethodNotAllowedErrorResponseBody.js +3 -0
- package/dist/cjs/api/types/PlacesGetPlaceGeocodeNotFoundErrorResponseBody.d.ts +9 -0
- package/dist/cjs/api/types/PlacesGetPlaceGeocodeNotFoundErrorResponseBody.js +3 -0
- package/dist/cjs/api/types/PlacesGetPlaceGeocodeNotImplementedErrorResponseBody.d.ts +9 -0
- package/dist/cjs/api/types/PlacesGetPlaceGeocodeNotImplementedErrorResponseBody.js +3 -0
- package/dist/cjs/api/types/PlacesGetPlaceGeocodeResponseBody.d.ts +6 -0
- package/dist/cjs/api/types/PlacesGetPlaceGeocodeResponseBody.js +3 -0
- package/dist/cjs/api/types/PlacesGetPlaceGeocodeServiceUnavailableErrorResponseBody.d.ts +9 -0
- package/dist/cjs/api/types/PlacesGetPlaceGeocodeServiceUnavailableErrorResponseBody.js +3 -0
- package/dist/cjs/api/types/PlacesGetPlaceGeocodeTooManyRequestsErrorResponseBody.d.ts +9 -0
- package/dist/cjs/api/types/PlacesGetPlaceGeocodeTooManyRequestsErrorResponseBody.js +3 -0
- package/dist/cjs/api/types/PlacesGetPlaceGeocodeUnauthorizedErrorResponseBody.d.ts +9 -0
- package/dist/cjs/api/types/PlacesGetPlaceGeocodeUnauthorizedErrorResponseBody.js +3 -0
- package/dist/cjs/api/types/index.d.ts +11 -0
- package/dist/cjs/api/types/index.js +11 -0
- package/dist/cjs/version.d.ts +1 -1
- package/dist/cjs/version.js +1 -1
- package/dist/esm/BaseClient.mjs +2 -2
- package/dist/esm/api/resources/betaApIs/client/Client.d.mts +30 -0
- package/dist/esm/api/resources/betaApIs/client/Client.mjs +90 -0
- package/dist/esm/api/resources/betaApIs/client/requests/GetPlaceGeocodeRequest.d.mts +14 -0
- package/dist/esm/api/resources/betaApIs/client/requests/GetPlaceGeocodeRequest.mjs +2 -0
- package/dist/esm/api/resources/betaApIs/client/requests/index.d.mts +1 -0
- package/dist/esm/api/types/PlaceGeocodeResultResponseResponseBody.d.mts +9 -0
- package/dist/esm/api/types/PlaceGeocodeResultResponseResponseBody.mjs +2 -0
- package/dist/esm/api/types/PlacesGetPlaceGeocodeBadGatewayErrorResponseBody.d.mts +9 -0
- package/dist/esm/api/types/PlacesGetPlaceGeocodeBadGatewayErrorResponseBody.mjs +2 -0
- package/dist/esm/api/types/PlacesGetPlaceGeocodeGatewayTimeoutErrorResponseBody.d.mts +9 -0
- package/dist/esm/api/types/PlacesGetPlaceGeocodeGatewayTimeoutErrorResponseBody.mjs +2 -0
- package/dist/esm/api/types/PlacesGetPlaceGeocodeInternalServerErrorResponseBody.d.mts +9 -0
- package/dist/esm/api/types/PlacesGetPlaceGeocodeInternalServerErrorResponseBody.mjs +2 -0
- package/dist/esm/api/types/PlacesGetPlaceGeocodeMethodNotAllowedErrorResponseBody.d.mts +9 -0
- package/dist/esm/api/types/PlacesGetPlaceGeocodeMethodNotAllowedErrorResponseBody.mjs +2 -0
- package/dist/esm/api/types/PlacesGetPlaceGeocodeNotFoundErrorResponseBody.d.mts +9 -0
- package/dist/esm/api/types/PlacesGetPlaceGeocodeNotFoundErrorResponseBody.mjs +2 -0
- package/dist/esm/api/types/PlacesGetPlaceGeocodeNotImplementedErrorResponseBody.d.mts +9 -0
- package/dist/esm/api/types/PlacesGetPlaceGeocodeNotImplementedErrorResponseBody.mjs +2 -0
- package/dist/esm/api/types/PlacesGetPlaceGeocodeResponseBody.d.mts +6 -0
- package/dist/esm/api/types/PlacesGetPlaceGeocodeResponseBody.mjs +2 -0
- package/dist/esm/api/types/PlacesGetPlaceGeocodeServiceUnavailableErrorResponseBody.d.mts +9 -0
- package/dist/esm/api/types/PlacesGetPlaceGeocodeServiceUnavailableErrorResponseBody.mjs +2 -0
- package/dist/esm/api/types/PlacesGetPlaceGeocodeTooManyRequestsErrorResponseBody.d.mts +9 -0
- package/dist/esm/api/types/PlacesGetPlaceGeocodeTooManyRequestsErrorResponseBody.mjs +2 -0
- package/dist/esm/api/types/PlacesGetPlaceGeocodeUnauthorizedErrorResponseBody.d.mts +9 -0
- package/dist/esm/api/types/PlacesGetPlaceGeocodeUnauthorizedErrorResponseBody.mjs +2 -0
- package/dist/esm/api/types/index.d.mts +11 -0
- package/dist/esm/api/types/index.mjs +11 -0
- package/dist/esm/version.d.mts +1 -1
- package/dist/esm/version.mjs +1 -1
- package/package.json +1 -1
- package/reference.md +72 -0
package/dist/cjs/BaseClient.js
CHANGED
|
@@ -44,8 +44,8 @@ function normalizeClientOptions(options) {
|
|
|
44
44
|
const headers = (0, headers_js_1.mergeHeaders)({
|
|
45
45
|
"X-Fern-Language": "JavaScript",
|
|
46
46
|
"X-Fern-SDK-Name": "@samsarahq/samsara",
|
|
47
|
-
"X-Fern-SDK-Version": "13.
|
|
48
|
-
"User-Agent": "@samsarahq/samsara/13.
|
|
47
|
+
"X-Fern-SDK-Version": "13.29.0",
|
|
48
|
+
"User-Agent": "@samsarahq/samsara/13.29.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",
|
|
@@ -1648,6 +1648,36 @@ export declare class BetaApIsClient {
|
|
|
1648
1648
|
*/
|
|
1649
1649
|
getPlaceDeletions(request?: Samsara.GetPlaceDeletionsRequest, requestOptions?: BetaApIsClient.RequestOptions): core.HttpResponsePromise<Samsara.PlacesGetPlaceDeletionsResponseBody>;
|
|
1650
1650
|
private __getPlaceDeletions;
|
|
1651
|
+
/**
|
|
1652
|
+
* Forward-geocodes a free-form address string. Does not create or update a Place. Returns geocode candidates with cursor pagination.
|
|
1653
|
+
*
|
|
1654
|
+
* <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>).
|
|
1655
|
+
*
|
|
1656
|
+
* To use this endpoint, select **Read Places** under the Places 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>
|
|
1657
|
+
*
|
|
1658
|
+
*
|
|
1659
|
+
* **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.
|
|
1660
|
+
*
|
|
1661
|
+
* @param {Samsara.GetPlaceGeocodeRequest} request
|
|
1662
|
+
* @param {BetaApIsClient.RequestOptions} requestOptions - Request-specific configuration.
|
|
1663
|
+
*
|
|
1664
|
+
* @throws {@link Samsara.UnauthorizedError}
|
|
1665
|
+
* @throws {@link Samsara.NotFoundError}
|
|
1666
|
+
* @throws {@link Samsara.MethodNotAllowedError}
|
|
1667
|
+
* @throws {@link Samsara.TooManyRequestsError}
|
|
1668
|
+
* @throws {@link Samsara.InternalServerError}
|
|
1669
|
+
* @throws {@link Samsara.NotImplementedError}
|
|
1670
|
+
* @throws {@link Samsara.BadGatewayError}
|
|
1671
|
+
* @throws {@link Samsara.ServiceUnavailableError}
|
|
1672
|
+
* @throws {@link Samsara.GatewayTimeoutError}
|
|
1673
|
+
*
|
|
1674
|
+
* @example
|
|
1675
|
+
* await client.betaApIs.getPlaceGeocode({
|
|
1676
|
+
* address: "address"
|
|
1677
|
+
* })
|
|
1678
|
+
*/
|
|
1679
|
+
getPlaceGeocode(request: Samsara.GetPlaceGeocodeRequest, requestOptions?: BetaApIsClient.RequestOptions): core.HttpResponsePromise<Samsara.PlacesGetPlaceGeocodeResponseBody>;
|
|
1680
|
+
private __getPlaceGeocode;
|
|
1651
1681
|
/**
|
|
1652
1682
|
* List all preferred fuel stations for your organization.
|
|
1653
1683
|
*
|
|
@@ -4858,6 +4858,96 @@ class BetaApIsClient {
|
|
|
4858
4858
|
return (0, handleNonStatusCodeError_js_1.handleNonStatusCodeError)(_response.error, _response.rawResponse, "GET", "/places/deletions");
|
|
4859
4859
|
});
|
|
4860
4860
|
}
|
|
4861
|
+
/**
|
|
4862
|
+
* Forward-geocodes a free-form address string. Does not create or update a Place. Returns geocode candidates with cursor pagination.
|
|
4863
|
+
*
|
|
4864
|
+
* <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>).
|
|
4865
|
+
*
|
|
4866
|
+
* To use this endpoint, select **Read Places** under the Places 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>
|
|
4867
|
+
*
|
|
4868
|
+
*
|
|
4869
|
+
* **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.
|
|
4870
|
+
*
|
|
4871
|
+
* @param {Samsara.GetPlaceGeocodeRequest} request
|
|
4872
|
+
* @param {BetaApIsClient.RequestOptions} requestOptions - Request-specific configuration.
|
|
4873
|
+
*
|
|
4874
|
+
* @throws {@link Samsara.UnauthorizedError}
|
|
4875
|
+
* @throws {@link Samsara.NotFoundError}
|
|
4876
|
+
* @throws {@link Samsara.MethodNotAllowedError}
|
|
4877
|
+
* @throws {@link Samsara.TooManyRequestsError}
|
|
4878
|
+
* @throws {@link Samsara.InternalServerError}
|
|
4879
|
+
* @throws {@link Samsara.NotImplementedError}
|
|
4880
|
+
* @throws {@link Samsara.BadGatewayError}
|
|
4881
|
+
* @throws {@link Samsara.ServiceUnavailableError}
|
|
4882
|
+
* @throws {@link Samsara.GatewayTimeoutError}
|
|
4883
|
+
*
|
|
4884
|
+
* @example
|
|
4885
|
+
* await client.betaApIs.getPlaceGeocode({
|
|
4886
|
+
* address: "address"
|
|
4887
|
+
* })
|
|
4888
|
+
*/
|
|
4889
|
+
getPlaceGeocode(request, requestOptions) {
|
|
4890
|
+
return core.HttpResponsePromise.fromPromise(this.__getPlaceGeocode(request, requestOptions));
|
|
4891
|
+
}
|
|
4892
|
+
__getPlaceGeocode(request, requestOptions) {
|
|
4893
|
+
return __awaiter(this, void 0, void 0, function* () {
|
|
4894
|
+
var _a, _b, _c, _d, _e, _f, _g, _h, _j;
|
|
4895
|
+
const { address, after, limit } = request;
|
|
4896
|
+
const _queryParams = {
|
|
4897
|
+
address,
|
|
4898
|
+
after,
|
|
4899
|
+
limit,
|
|
4900
|
+
};
|
|
4901
|
+
const _authRequest = yield this._options.authProvider.getAuthRequest();
|
|
4902
|
+
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);
|
|
4903
|
+
const _response = yield core.fetcher({
|
|
4904
|
+
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, "places/geocode"),
|
|
4905
|
+
method: "GET",
|
|
4906
|
+
headers: _headers,
|
|
4907
|
+
queryParameters: Object.assign(Object.assign({}, _queryParams), requestOptions === null || requestOptions === void 0 ? void 0 : requestOptions.queryParams),
|
|
4908
|
+
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,
|
|
4909
|
+
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,
|
|
4910
|
+
abortSignal: requestOptions === null || requestOptions === void 0 ? void 0 : requestOptions.abortSignal,
|
|
4911
|
+
fetchFn: (_j = this._options) === null || _j === void 0 ? void 0 : _j.fetch,
|
|
4912
|
+
logging: this._options.logging,
|
|
4913
|
+
});
|
|
4914
|
+
if (_response.ok) {
|
|
4915
|
+
return {
|
|
4916
|
+
data: _response.body,
|
|
4917
|
+
rawResponse: _response.rawResponse,
|
|
4918
|
+
};
|
|
4919
|
+
}
|
|
4920
|
+
if (_response.error.reason === "status-code") {
|
|
4921
|
+
switch (_response.error.statusCode) {
|
|
4922
|
+
case 401:
|
|
4923
|
+
throw new Samsara.UnauthorizedError(_response.error.body, _response.rawResponse);
|
|
4924
|
+
case 404:
|
|
4925
|
+
throw new Samsara.NotFoundError(_response.error.body, _response.rawResponse);
|
|
4926
|
+
case 405:
|
|
4927
|
+
throw new Samsara.MethodNotAllowedError(_response.error.body, _response.rawResponse);
|
|
4928
|
+
case 429:
|
|
4929
|
+
throw new Samsara.TooManyRequestsError(_response.error.body, _response.rawResponse);
|
|
4930
|
+
case 500:
|
|
4931
|
+
throw new Samsara.InternalServerError(_response.error.body, _response.rawResponse);
|
|
4932
|
+
case 501:
|
|
4933
|
+
throw new Samsara.NotImplementedError(_response.error.body, _response.rawResponse);
|
|
4934
|
+
case 502:
|
|
4935
|
+
throw new Samsara.BadGatewayError(_response.error.body, _response.rawResponse);
|
|
4936
|
+
case 503:
|
|
4937
|
+
throw new Samsara.ServiceUnavailableError(_response.error.body, _response.rawResponse);
|
|
4938
|
+
case 504:
|
|
4939
|
+
throw new Samsara.GatewayTimeoutError(_response.error.body, _response.rawResponse);
|
|
4940
|
+
default:
|
|
4941
|
+
throw new errors.SamsaraError({
|
|
4942
|
+
statusCode: _response.error.statusCode,
|
|
4943
|
+
body: _response.error.body,
|
|
4944
|
+
rawResponse: _response.rawResponse,
|
|
4945
|
+
});
|
|
4946
|
+
}
|
|
4947
|
+
}
|
|
4948
|
+
return (0, handleNonStatusCodeError_js_1.handleNonStatusCodeError)(_response.error, _response.rawResponse, "GET", "/places/geocode");
|
|
4949
|
+
});
|
|
4950
|
+
}
|
|
4861
4951
|
/**
|
|
4862
4952
|
* List all preferred fuel stations for your organization.
|
|
4863
4953
|
*
|
|
@@ -0,0 +1,14 @@
|
|
|
1
|
+
/**
|
|
2
|
+
* @example
|
|
3
|
+
* {
|
|
4
|
+
* address: "address"
|
|
5
|
+
* }
|
|
6
|
+
*/
|
|
7
|
+
export interface GetPlaceGeocodeRequest {
|
|
8
|
+
/** Address string to forward-geocode (URL-encoded). Required; must be non-empty. */
|
|
9
|
+
address: string;
|
|
10
|
+
/** 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. */
|
|
11
|
+
after?: string;
|
|
12
|
+
/** The limit for how many objects will be in the response. Default 5, max 20. */
|
|
13
|
+
limit?: number;
|
|
14
|
+
}
|
|
@@ -33,6 +33,7 @@ export type { GetFunctionStorageFileRequest } from "./GetFunctionStorageFileRequ
|
|
|
33
33
|
export type { GetHosEldEventsRequest } from "./GetHosEldEventsRequest.js";
|
|
34
34
|
export type { GetJobsRequest } from "./GetJobsRequest.js";
|
|
35
35
|
export type { GetPlaceDeletionsRequest } from "./GetPlaceDeletionsRequest.js";
|
|
36
|
+
export type { GetPlaceGeocodeRequest } from "./GetPlaceGeocodeRequest.js";
|
|
36
37
|
export type { GetPlacesRequest } from "./GetPlacesRequest.js";
|
|
37
38
|
export type { GetPreferredStationRequest } from "./GetPreferredStationRequest.js";
|
|
38
39
|
export type { GetQualificationRecordsRequest } from "./GetQualificationRecordsRequest.js";
|
|
@@ -0,0 +1,9 @@
|
|
|
1
|
+
/**
|
|
2
|
+
* An internal server error occurred
|
|
3
|
+
*/
|
|
4
|
+
export interface PlacesGetPlaceGeocodeInternalServerErrorResponseBody {
|
|
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 PlacesGetPlaceGeocodeNotImplementedErrorResponseBody {
|
|
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,6 @@
|
|
|
1
|
+
import type * as Samsara from "../index.js";
|
|
2
|
+
export interface PlacesGetPlaceGeocodeResponseBody {
|
|
3
|
+
/** Geocode candidates for the requested address. */
|
|
4
|
+
data: Samsara.PlaceGeocodeResultResponseResponseBody[];
|
|
5
|
+
pagination: Samsara.GoaPaginationResponseResponseBody;
|
|
6
|
+
}
|
|
@@ -0,0 +1,9 @@
|
|
|
1
|
+
/**
|
|
2
|
+
* Service unavailable
|
|
3
|
+
*/
|
|
4
|
+
export interface PlacesGetPlaceGeocodeServiceUnavailableErrorResponseBody {
|
|
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
|
+
}
|
|
@@ -1970,6 +1970,7 @@ export * from "./PersonDetectedResponseBody.js";
|
|
|
1970
1970
|
export * from "./PhotoValueObjectRequestBody.js";
|
|
1971
1971
|
export * from "./PhotoValueObjectResponseBody.js";
|
|
1972
1972
|
export * from "./PlaceDeletionMarkerObjectResponseBody.js";
|
|
1973
|
+
export * from "./PlaceGeocodeResultResponseResponseBody.js";
|
|
1973
1974
|
export * from "./PlaceGeofenceCircleInputRequestBody.js";
|
|
1974
1975
|
export * from "./PlaceGeofenceCircleResponseResponseBody.js";
|
|
1975
1976
|
export * from "./PlaceGeofenceInputRequestBody.js";
|
|
@@ -2008,6 +2009,16 @@ export * from "./PlacesGetPlaceDeletionsResponseBody.js";
|
|
|
2008
2009
|
export * from "./PlacesGetPlaceDeletionsServiceUnavailableErrorResponseBody.js";
|
|
2009
2010
|
export * from "./PlacesGetPlaceDeletionsTooManyRequestsErrorResponseBody.js";
|
|
2010
2011
|
export * from "./PlacesGetPlaceDeletionsUnauthorizedErrorResponseBody.js";
|
|
2012
|
+
export * from "./PlacesGetPlaceGeocodeBadGatewayErrorResponseBody.js";
|
|
2013
|
+
export * from "./PlacesGetPlaceGeocodeGatewayTimeoutErrorResponseBody.js";
|
|
2014
|
+
export * from "./PlacesGetPlaceGeocodeInternalServerErrorResponseBody.js";
|
|
2015
|
+
export * from "./PlacesGetPlaceGeocodeMethodNotAllowedErrorResponseBody.js";
|
|
2016
|
+
export * from "./PlacesGetPlaceGeocodeNotFoundErrorResponseBody.js";
|
|
2017
|
+
export * from "./PlacesGetPlaceGeocodeNotImplementedErrorResponseBody.js";
|
|
2018
|
+
export * from "./PlacesGetPlaceGeocodeResponseBody.js";
|
|
2019
|
+
export * from "./PlacesGetPlaceGeocodeServiceUnavailableErrorResponseBody.js";
|
|
2020
|
+
export * from "./PlacesGetPlaceGeocodeTooManyRequestsErrorResponseBody.js";
|
|
2021
|
+
export * from "./PlacesGetPlaceGeocodeUnauthorizedErrorResponseBody.js";
|
|
2011
2022
|
export * from "./PlacesGetPlacesBadGatewayErrorResponseBody.js";
|
|
2012
2023
|
export * from "./PlacesGetPlacesGatewayTimeoutErrorResponseBody.js";
|
|
2013
2024
|
export * from "./PlacesGetPlacesInternalServerErrorResponseBody.js";
|
|
@@ -1986,6 +1986,7 @@ __exportStar(require("./PersonDetectedResponseBody.js"), exports);
|
|
|
1986
1986
|
__exportStar(require("./PhotoValueObjectRequestBody.js"), exports);
|
|
1987
1987
|
__exportStar(require("./PhotoValueObjectResponseBody.js"), exports);
|
|
1988
1988
|
__exportStar(require("./PlaceDeletionMarkerObjectResponseBody.js"), exports);
|
|
1989
|
+
__exportStar(require("./PlaceGeocodeResultResponseResponseBody.js"), exports);
|
|
1989
1990
|
__exportStar(require("./PlaceGeofenceCircleInputRequestBody.js"), exports);
|
|
1990
1991
|
__exportStar(require("./PlaceGeofenceCircleResponseResponseBody.js"), exports);
|
|
1991
1992
|
__exportStar(require("./PlaceGeofenceInputRequestBody.js"), exports);
|
|
@@ -2024,6 +2025,16 @@ __exportStar(require("./PlacesGetPlaceDeletionsResponseBody.js"), exports);
|
|
|
2024
2025
|
__exportStar(require("./PlacesGetPlaceDeletionsServiceUnavailableErrorResponseBody.js"), exports);
|
|
2025
2026
|
__exportStar(require("./PlacesGetPlaceDeletionsTooManyRequestsErrorResponseBody.js"), exports);
|
|
2026
2027
|
__exportStar(require("./PlacesGetPlaceDeletionsUnauthorizedErrorResponseBody.js"), exports);
|
|
2028
|
+
__exportStar(require("./PlacesGetPlaceGeocodeBadGatewayErrorResponseBody.js"), exports);
|
|
2029
|
+
__exportStar(require("./PlacesGetPlaceGeocodeGatewayTimeoutErrorResponseBody.js"), exports);
|
|
2030
|
+
__exportStar(require("./PlacesGetPlaceGeocodeInternalServerErrorResponseBody.js"), exports);
|
|
2031
|
+
__exportStar(require("./PlacesGetPlaceGeocodeMethodNotAllowedErrorResponseBody.js"), exports);
|
|
2032
|
+
__exportStar(require("./PlacesGetPlaceGeocodeNotFoundErrorResponseBody.js"), exports);
|
|
2033
|
+
__exportStar(require("./PlacesGetPlaceGeocodeNotImplementedErrorResponseBody.js"), exports);
|
|
2034
|
+
__exportStar(require("./PlacesGetPlaceGeocodeResponseBody.js"), exports);
|
|
2035
|
+
__exportStar(require("./PlacesGetPlaceGeocodeServiceUnavailableErrorResponseBody.js"), exports);
|
|
2036
|
+
__exportStar(require("./PlacesGetPlaceGeocodeTooManyRequestsErrorResponseBody.js"), exports);
|
|
2037
|
+
__exportStar(require("./PlacesGetPlaceGeocodeUnauthorizedErrorResponseBody.js"), exports);
|
|
2027
2038
|
__exportStar(require("./PlacesGetPlacesBadGatewayErrorResponseBody.js"), exports);
|
|
2028
2039
|
__exportStar(require("./PlacesGetPlacesGatewayTimeoutErrorResponseBody.js"), exports);
|
|
2029
2040
|
__exportStar(require("./PlacesGetPlacesInternalServerErrorResponseBody.js"), exports);
|
package/dist/cjs/version.d.ts
CHANGED
|
@@ -1 +1 @@
|
|
|
1
|
-
export declare const SDK_VERSION = "13.
|
|
1
|
+
export declare const SDK_VERSION = "13.29.0";
|
package/dist/cjs/version.js
CHANGED
package/dist/esm/BaseClient.mjs
CHANGED
|
@@ -7,8 +7,8 @@ export function normalizeClientOptions(options) {
|
|
|
7
7
|
const headers = mergeHeaders({
|
|
8
8
|
"X-Fern-Language": "JavaScript",
|
|
9
9
|
"X-Fern-SDK-Name": "@samsarahq/samsara",
|
|
10
|
-
"X-Fern-SDK-Version": "13.
|
|
11
|
-
"User-Agent": "@samsarahq/samsara/13.
|
|
10
|
+
"X-Fern-SDK-Version": "13.29.0",
|
|
11
|
+
"User-Agent": "@samsarahq/samsara/13.29.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",
|
|
@@ -1648,6 +1648,36 @@ export declare class BetaApIsClient {
|
|
|
1648
1648
|
*/
|
|
1649
1649
|
getPlaceDeletions(request?: Samsara.GetPlaceDeletionsRequest, requestOptions?: BetaApIsClient.RequestOptions): core.HttpResponsePromise<Samsara.PlacesGetPlaceDeletionsResponseBody>;
|
|
1650
1650
|
private __getPlaceDeletions;
|
|
1651
|
+
/**
|
|
1652
|
+
* Forward-geocodes a free-form address string. Does not create or update a Place. Returns geocode candidates with cursor pagination.
|
|
1653
|
+
*
|
|
1654
|
+
* <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>).
|
|
1655
|
+
*
|
|
1656
|
+
* To use this endpoint, select **Read Places** under the Places 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>
|
|
1657
|
+
*
|
|
1658
|
+
*
|
|
1659
|
+
* **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.
|
|
1660
|
+
*
|
|
1661
|
+
* @param {Samsara.GetPlaceGeocodeRequest} request
|
|
1662
|
+
* @param {BetaApIsClient.RequestOptions} requestOptions - Request-specific configuration.
|
|
1663
|
+
*
|
|
1664
|
+
* @throws {@link Samsara.UnauthorizedError}
|
|
1665
|
+
* @throws {@link Samsara.NotFoundError}
|
|
1666
|
+
* @throws {@link Samsara.MethodNotAllowedError}
|
|
1667
|
+
* @throws {@link Samsara.TooManyRequestsError}
|
|
1668
|
+
* @throws {@link Samsara.InternalServerError}
|
|
1669
|
+
* @throws {@link Samsara.NotImplementedError}
|
|
1670
|
+
* @throws {@link Samsara.BadGatewayError}
|
|
1671
|
+
* @throws {@link Samsara.ServiceUnavailableError}
|
|
1672
|
+
* @throws {@link Samsara.GatewayTimeoutError}
|
|
1673
|
+
*
|
|
1674
|
+
* @example
|
|
1675
|
+
* await client.betaApIs.getPlaceGeocode({
|
|
1676
|
+
* address: "address"
|
|
1677
|
+
* })
|
|
1678
|
+
*/
|
|
1679
|
+
getPlaceGeocode(request: Samsara.GetPlaceGeocodeRequest, requestOptions?: BetaApIsClient.RequestOptions): core.HttpResponsePromise<Samsara.PlacesGetPlaceGeocodeResponseBody>;
|
|
1680
|
+
private __getPlaceGeocode;
|
|
1651
1681
|
/**
|
|
1652
1682
|
* List all preferred fuel stations for your organization.
|
|
1653
1683
|
*
|
|
@@ -4822,6 +4822,96 @@ export class BetaApIsClient {
|
|
|
4822
4822
|
return handleNonStatusCodeError(_response.error, _response.rawResponse, "GET", "/places/deletions");
|
|
4823
4823
|
});
|
|
4824
4824
|
}
|
|
4825
|
+
/**
|
|
4826
|
+
* Forward-geocodes a free-form address string. Does not create or update a Place. Returns geocode candidates with cursor pagination.
|
|
4827
|
+
*
|
|
4828
|
+
* <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>).
|
|
4829
|
+
*
|
|
4830
|
+
* To use this endpoint, select **Read Places** under the Places 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>
|
|
4831
|
+
*
|
|
4832
|
+
*
|
|
4833
|
+
* **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.
|
|
4834
|
+
*
|
|
4835
|
+
* @param {Samsara.GetPlaceGeocodeRequest} request
|
|
4836
|
+
* @param {BetaApIsClient.RequestOptions} requestOptions - Request-specific configuration.
|
|
4837
|
+
*
|
|
4838
|
+
* @throws {@link Samsara.UnauthorizedError}
|
|
4839
|
+
* @throws {@link Samsara.NotFoundError}
|
|
4840
|
+
* @throws {@link Samsara.MethodNotAllowedError}
|
|
4841
|
+
* @throws {@link Samsara.TooManyRequestsError}
|
|
4842
|
+
* @throws {@link Samsara.InternalServerError}
|
|
4843
|
+
* @throws {@link Samsara.NotImplementedError}
|
|
4844
|
+
* @throws {@link Samsara.BadGatewayError}
|
|
4845
|
+
* @throws {@link Samsara.ServiceUnavailableError}
|
|
4846
|
+
* @throws {@link Samsara.GatewayTimeoutError}
|
|
4847
|
+
*
|
|
4848
|
+
* @example
|
|
4849
|
+
* await client.betaApIs.getPlaceGeocode({
|
|
4850
|
+
* address: "address"
|
|
4851
|
+
* })
|
|
4852
|
+
*/
|
|
4853
|
+
getPlaceGeocode(request, requestOptions) {
|
|
4854
|
+
return core.HttpResponsePromise.fromPromise(this.__getPlaceGeocode(request, requestOptions));
|
|
4855
|
+
}
|
|
4856
|
+
__getPlaceGeocode(request, requestOptions) {
|
|
4857
|
+
return __awaiter(this, void 0, void 0, function* () {
|
|
4858
|
+
var _a, _b, _c, _d, _e, _f, _g, _h, _j;
|
|
4859
|
+
const { address, after, limit } = request;
|
|
4860
|
+
const _queryParams = {
|
|
4861
|
+
address,
|
|
4862
|
+
after,
|
|
4863
|
+
limit,
|
|
4864
|
+
};
|
|
4865
|
+
const _authRequest = yield this._options.authProvider.getAuthRequest();
|
|
4866
|
+
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);
|
|
4867
|
+
const _response = yield core.fetcher({
|
|
4868
|
+
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, "places/geocode"),
|
|
4869
|
+
method: "GET",
|
|
4870
|
+
headers: _headers,
|
|
4871
|
+
queryParameters: Object.assign(Object.assign({}, _queryParams), requestOptions === null || requestOptions === void 0 ? void 0 : requestOptions.queryParams),
|
|
4872
|
+
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,
|
|
4873
|
+
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,
|
|
4874
|
+
abortSignal: requestOptions === null || requestOptions === void 0 ? void 0 : requestOptions.abortSignal,
|
|
4875
|
+
fetchFn: (_j = this._options) === null || _j === void 0 ? void 0 : _j.fetch,
|
|
4876
|
+
logging: this._options.logging,
|
|
4877
|
+
});
|
|
4878
|
+
if (_response.ok) {
|
|
4879
|
+
return {
|
|
4880
|
+
data: _response.body,
|
|
4881
|
+
rawResponse: _response.rawResponse,
|
|
4882
|
+
};
|
|
4883
|
+
}
|
|
4884
|
+
if (_response.error.reason === "status-code") {
|
|
4885
|
+
switch (_response.error.statusCode) {
|
|
4886
|
+
case 401:
|
|
4887
|
+
throw new Samsara.UnauthorizedError(_response.error.body, _response.rawResponse);
|
|
4888
|
+
case 404:
|
|
4889
|
+
throw new Samsara.NotFoundError(_response.error.body, _response.rawResponse);
|
|
4890
|
+
case 405:
|
|
4891
|
+
throw new Samsara.MethodNotAllowedError(_response.error.body, _response.rawResponse);
|
|
4892
|
+
case 429:
|
|
4893
|
+
throw new Samsara.TooManyRequestsError(_response.error.body, _response.rawResponse);
|
|
4894
|
+
case 500:
|
|
4895
|
+
throw new Samsara.InternalServerError(_response.error.body, _response.rawResponse);
|
|
4896
|
+
case 501:
|
|
4897
|
+
throw new Samsara.NotImplementedError(_response.error.body, _response.rawResponse);
|
|
4898
|
+
case 502:
|
|
4899
|
+
throw new Samsara.BadGatewayError(_response.error.body, _response.rawResponse);
|
|
4900
|
+
case 503:
|
|
4901
|
+
throw new Samsara.ServiceUnavailableError(_response.error.body, _response.rawResponse);
|
|
4902
|
+
case 504:
|
|
4903
|
+
throw new Samsara.GatewayTimeoutError(_response.error.body, _response.rawResponse);
|
|
4904
|
+
default:
|
|
4905
|
+
throw new errors.SamsaraError({
|
|
4906
|
+
statusCode: _response.error.statusCode,
|
|
4907
|
+
body: _response.error.body,
|
|
4908
|
+
rawResponse: _response.rawResponse,
|
|
4909
|
+
});
|
|
4910
|
+
}
|
|
4911
|
+
}
|
|
4912
|
+
return handleNonStatusCodeError(_response.error, _response.rawResponse, "GET", "/places/geocode");
|
|
4913
|
+
});
|
|
4914
|
+
}
|
|
4825
4915
|
/**
|
|
4826
4916
|
* List all preferred fuel stations for your organization.
|
|
4827
4917
|
*
|
|
@@ -0,0 +1,14 @@
|
|
|
1
|
+
/**
|
|
2
|
+
* @example
|
|
3
|
+
* {
|
|
4
|
+
* address: "address"
|
|
5
|
+
* }
|
|
6
|
+
*/
|
|
7
|
+
export interface GetPlaceGeocodeRequest {
|
|
8
|
+
/** Address string to forward-geocode (URL-encoded). Required; must be non-empty. */
|
|
9
|
+
address: string;
|
|
10
|
+
/** 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. */
|
|
11
|
+
after?: string;
|
|
12
|
+
/** The limit for how many objects will be in the response. Default 5, max 20. */
|
|
13
|
+
limit?: number;
|
|
14
|
+
}
|
|
@@ -33,6 +33,7 @@ export type { GetFunctionStorageFileRequest } from "./GetFunctionStorageFileRequ
|
|
|
33
33
|
export type { GetHosEldEventsRequest } from "./GetHosEldEventsRequest.mjs";
|
|
34
34
|
export type { GetJobsRequest } from "./GetJobsRequest.mjs";
|
|
35
35
|
export type { GetPlaceDeletionsRequest } from "./GetPlaceDeletionsRequest.mjs";
|
|
36
|
+
export type { GetPlaceGeocodeRequest } from "./GetPlaceGeocodeRequest.mjs";
|
|
36
37
|
export type { GetPlacesRequest } from "./GetPlacesRequest.mjs";
|
|
37
38
|
export type { GetPreferredStationRequest } from "./GetPreferredStationRequest.mjs";
|
|
38
39
|
export type { GetQualificationRecordsRequest } from "./GetQualificationRecordsRequest.mjs";
|
|
@@ -0,0 +1,9 @@
|
|
|
1
|
+
/**
|
|
2
|
+
* An internal server error occurred
|
|
3
|
+
*/
|
|
4
|
+
export interface PlacesGetPlaceGeocodeInternalServerErrorResponseBody {
|
|
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 PlacesGetPlaceGeocodeNotImplementedErrorResponseBody {
|
|
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,6 @@
|
|
|
1
|
+
import type * as Samsara from "../index.mjs";
|
|
2
|
+
export interface PlacesGetPlaceGeocodeResponseBody {
|
|
3
|
+
/** Geocode candidates for the requested address. */
|
|
4
|
+
data: Samsara.PlaceGeocodeResultResponseResponseBody[];
|
|
5
|
+
pagination: Samsara.GoaPaginationResponseResponseBody;
|
|
6
|
+
}
|
|
@@ -0,0 +1,9 @@
|
|
|
1
|
+
/**
|
|
2
|
+
* Service unavailable
|
|
3
|
+
*/
|
|
4
|
+
export interface PlacesGetPlaceGeocodeServiceUnavailableErrorResponseBody {
|
|
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
|
+
}
|
|
@@ -1970,6 +1970,7 @@ export * from "./PersonDetectedResponseBody.mjs";
|
|
|
1970
1970
|
export * from "./PhotoValueObjectRequestBody.mjs";
|
|
1971
1971
|
export * from "./PhotoValueObjectResponseBody.mjs";
|
|
1972
1972
|
export * from "./PlaceDeletionMarkerObjectResponseBody.mjs";
|
|
1973
|
+
export * from "./PlaceGeocodeResultResponseResponseBody.mjs";
|
|
1973
1974
|
export * from "./PlaceGeofenceCircleInputRequestBody.mjs";
|
|
1974
1975
|
export * from "./PlaceGeofenceCircleResponseResponseBody.mjs";
|
|
1975
1976
|
export * from "./PlaceGeofenceInputRequestBody.mjs";
|
|
@@ -2008,6 +2009,16 @@ export * from "./PlacesGetPlaceDeletionsResponseBody.mjs";
|
|
|
2008
2009
|
export * from "./PlacesGetPlaceDeletionsServiceUnavailableErrorResponseBody.mjs";
|
|
2009
2010
|
export * from "./PlacesGetPlaceDeletionsTooManyRequestsErrorResponseBody.mjs";
|
|
2010
2011
|
export * from "./PlacesGetPlaceDeletionsUnauthorizedErrorResponseBody.mjs";
|
|
2012
|
+
export * from "./PlacesGetPlaceGeocodeBadGatewayErrorResponseBody.mjs";
|
|
2013
|
+
export * from "./PlacesGetPlaceGeocodeGatewayTimeoutErrorResponseBody.mjs";
|
|
2014
|
+
export * from "./PlacesGetPlaceGeocodeInternalServerErrorResponseBody.mjs";
|
|
2015
|
+
export * from "./PlacesGetPlaceGeocodeMethodNotAllowedErrorResponseBody.mjs";
|
|
2016
|
+
export * from "./PlacesGetPlaceGeocodeNotFoundErrorResponseBody.mjs";
|
|
2017
|
+
export * from "./PlacesGetPlaceGeocodeNotImplementedErrorResponseBody.mjs";
|
|
2018
|
+
export * from "./PlacesGetPlaceGeocodeResponseBody.mjs";
|
|
2019
|
+
export * from "./PlacesGetPlaceGeocodeServiceUnavailableErrorResponseBody.mjs";
|
|
2020
|
+
export * from "./PlacesGetPlaceGeocodeTooManyRequestsErrorResponseBody.mjs";
|
|
2021
|
+
export * from "./PlacesGetPlaceGeocodeUnauthorizedErrorResponseBody.mjs";
|
|
2011
2022
|
export * from "./PlacesGetPlacesBadGatewayErrorResponseBody.mjs";
|
|
2012
2023
|
export * from "./PlacesGetPlacesGatewayTimeoutErrorResponseBody.mjs";
|
|
2013
2024
|
export * from "./PlacesGetPlacesInternalServerErrorResponseBody.mjs";
|
|
@@ -1970,6 +1970,7 @@ export * from "./PersonDetectedResponseBody.mjs";
|
|
|
1970
1970
|
export * from "./PhotoValueObjectRequestBody.mjs";
|
|
1971
1971
|
export * from "./PhotoValueObjectResponseBody.mjs";
|
|
1972
1972
|
export * from "./PlaceDeletionMarkerObjectResponseBody.mjs";
|
|
1973
|
+
export * from "./PlaceGeocodeResultResponseResponseBody.mjs";
|
|
1973
1974
|
export * from "./PlaceGeofenceCircleInputRequestBody.mjs";
|
|
1974
1975
|
export * from "./PlaceGeofenceCircleResponseResponseBody.mjs";
|
|
1975
1976
|
export * from "./PlaceGeofenceInputRequestBody.mjs";
|
|
@@ -2008,6 +2009,16 @@ export * from "./PlacesGetPlaceDeletionsResponseBody.mjs";
|
|
|
2008
2009
|
export * from "./PlacesGetPlaceDeletionsServiceUnavailableErrorResponseBody.mjs";
|
|
2009
2010
|
export * from "./PlacesGetPlaceDeletionsTooManyRequestsErrorResponseBody.mjs";
|
|
2010
2011
|
export * from "./PlacesGetPlaceDeletionsUnauthorizedErrorResponseBody.mjs";
|
|
2012
|
+
export * from "./PlacesGetPlaceGeocodeBadGatewayErrorResponseBody.mjs";
|
|
2013
|
+
export * from "./PlacesGetPlaceGeocodeGatewayTimeoutErrorResponseBody.mjs";
|
|
2014
|
+
export * from "./PlacesGetPlaceGeocodeInternalServerErrorResponseBody.mjs";
|
|
2015
|
+
export * from "./PlacesGetPlaceGeocodeMethodNotAllowedErrorResponseBody.mjs";
|
|
2016
|
+
export * from "./PlacesGetPlaceGeocodeNotFoundErrorResponseBody.mjs";
|
|
2017
|
+
export * from "./PlacesGetPlaceGeocodeNotImplementedErrorResponseBody.mjs";
|
|
2018
|
+
export * from "./PlacesGetPlaceGeocodeResponseBody.mjs";
|
|
2019
|
+
export * from "./PlacesGetPlaceGeocodeServiceUnavailableErrorResponseBody.mjs";
|
|
2020
|
+
export * from "./PlacesGetPlaceGeocodeTooManyRequestsErrorResponseBody.mjs";
|
|
2021
|
+
export * from "./PlacesGetPlaceGeocodeUnauthorizedErrorResponseBody.mjs";
|
|
2011
2022
|
export * from "./PlacesGetPlacesBadGatewayErrorResponseBody.mjs";
|
|
2012
2023
|
export * from "./PlacesGetPlacesGatewayTimeoutErrorResponseBody.mjs";
|
|
2013
2024
|
export * from "./PlacesGetPlacesInternalServerErrorResponseBody.mjs";
|
package/dist/esm/version.d.mts
CHANGED
|
@@ -1 +1 @@
|
|
|
1
|
-
export declare const SDK_VERSION = "13.
|
|
1
|
+
export declare const SDK_VERSION = "13.29.0";
|
package/dist/esm/version.mjs
CHANGED
|
@@ -1 +1 @@
|
|
|
1
|
-
export const SDK_VERSION = "13.
|
|
1
|
+
export const SDK_VERSION = "13.29.0";
|
package/package.json
CHANGED
package/reference.md
CHANGED
|
@@ -4270,6 +4270,78 @@ await client.betaApIs.getPlaceDeletions();
|
|
|
4270
4270
|
</dl>
|
|
4271
4271
|
|
|
4272
4272
|
|
|
4273
|
+
</dd>
|
|
4274
|
+
</dl>
|
|
4275
|
+
</details>
|
|
4276
|
+
|
|
4277
|
+
<details><summary><code>client.betaApIs.<a href="/src/api/resources/betaApIs/client/Client.ts">getPlaceGeocode</a>({ ...params }) -> Samsara.PlacesGetPlaceGeocodeResponseBody</code></summary>
|
|
4278
|
+
<dl>
|
|
4279
|
+
<dd>
|
|
4280
|
+
|
|
4281
|
+
#### 📝 Description
|
|
4282
|
+
|
|
4283
|
+
<dl>
|
|
4284
|
+
<dd>
|
|
4285
|
+
|
|
4286
|
+
<dl>
|
|
4287
|
+
<dd>
|
|
4288
|
+
|
|
4289
|
+
Forward-geocodes a free-form address string. Does not create or update a Place. Returns geocode candidates with cursor pagination.
|
|
4290
|
+
|
|
4291
|
+
<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>).
|
|
4292
|
+
|
|
4293
|
+
To use this endpoint, select **Read Places** under the Places 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>
|
|
4294
|
+
|
|
4295
|
+
|
|
4296
|
+
**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.
|
|
4297
|
+
</dd>
|
|
4298
|
+
</dl>
|
|
4299
|
+
</dd>
|
|
4300
|
+
</dl>
|
|
4301
|
+
|
|
4302
|
+
#### 🔌 Usage
|
|
4303
|
+
|
|
4304
|
+
<dl>
|
|
4305
|
+
<dd>
|
|
4306
|
+
|
|
4307
|
+
<dl>
|
|
4308
|
+
<dd>
|
|
4309
|
+
|
|
4310
|
+
```typescript
|
|
4311
|
+
await client.betaApIs.getPlaceGeocode({
|
|
4312
|
+
address: "address"
|
|
4313
|
+
});
|
|
4314
|
+
|
|
4315
|
+
```
|
|
4316
|
+
</dd>
|
|
4317
|
+
</dl>
|
|
4318
|
+
</dd>
|
|
4319
|
+
</dl>
|
|
4320
|
+
|
|
4321
|
+
#### ⚙️ Parameters
|
|
4322
|
+
|
|
4323
|
+
<dl>
|
|
4324
|
+
<dd>
|
|
4325
|
+
|
|
4326
|
+
<dl>
|
|
4327
|
+
<dd>
|
|
4328
|
+
|
|
4329
|
+
**request:** `Samsara.GetPlaceGeocodeRequest`
|
|
4330
|
+
|
|
4331
|
+
</dd>
|
|
4332
|
+
</dl>
|
|
4333
|
+
|
|
4334
|
+
<dl>
|
|
4335
|
+
<dd>
|
|
4336
|
+
|
|
4337
|
+
**requestOptions:** `BetaApIsClient.RequestOptions`
|
|
4338
|
+
|
|
4339
|
+
</dd>
|
|
4340
|
+
</dl>
|
|
4341
|
+
</dd>
|
|
4342
|
+
</dl>
|
|
4343
|
+
|
|
4344
|
+
|
|
4273
4345
|
</dd>
|
|
4274
4346
|
</dl>
|
|
4275
4347
|
</details>
|