@samsarahq/samsara 13.9.0 → 13.10.0
This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
- package/dist/cjs/BaseClient.js +2 -2
- package/dist/cjs/api/resources/betaApIs/client/Client.d.ts +28 -0
- package/dist/cjs/api/resources/betaApIs/client/Client.js +87 -0
- package/dist/cjs/api/resources/betaApIs/client/requests/GetPlaceDeletionsRequest.d.ts +10 -0
- package/dist/cjs/api/resources/betaApIs/client/requests/GetPlaceDeletionsRequest.js +3 -0
- package/dist/cjs/api/resources/betaApIs/client/requests/index.d.ts +1 -0
- package/dist/cjs/api/types/PlaceDeletionMarkerObjectResponseBody.d.ts +17 -0
- package/dist/cjs/api/types/PlaceDeletionMarkerObjectResponseBody.js +3 -0
- package/dist/cjs/api/types/PlacesGetPlaceDeletionsBadGatewayErrorResponseBody.d.ts +9 -0
- package/dist/cjs/api/types/PlacesGetPlaceDeletionsBadGatewayErrorResponseBody.js +3 -0
- package/dist/cjs/api/types/PlacesGetPlaceDeletionsGatewayTimeoutErrorResponseBody.d.ts +9 -0
- package/dist/cjs/api/types/PlacesGetPlaceDeletionsGatewayTimeoutErrorResponseBody.js +3 -0
- package/dist/cjs/api/types/PlacesGetPlaceDeletionsInternalServerErrorResponseBody.d.ts +9 -0
- package/dist/cjs/api/types/PlacesGetPlaceDeletionsInternalServerErrorResponseBody.js +3 -0
- package/dist/cjs/api/types/PlacesGetPlaceDeletionsMethodNotAllowedErrorResponseBody.d.ts +9 -0
- package/dist/cjs/api/types/PlacesGetPlaceDeletionsMethodNotAllowedErrorResponseBody.js +3 -0
- package/dist/cjs/api/types/PlacesGetPlaceDeletionsNotFoundErrorResponseBody.d.ts +9 -0
- package/dist/cjs/api/types/PlacesGetPlaceDeletionsNotFoundErrorResponseBody.js +3 -0
- package/dist/cjs/api/types/PlacesGetPlaceDeletionsNotImplementedErrorResponseBody.d.ts +9 -0
- package/dist/cjs/api/types/PlacesGetPlaceDeletionsNotImplementedErrorResponseBody.js +3 -0
- package/dist/cjs/api/types/PlacesGetPlaceDeletionsResponseBody.d.ts +6 -0
- package/dist/cjs/api/types/PlacesGetPlaceDeletionsResponseBody.js +3 -0
- package/dist/cjs/api/types/PlacesGetPlaceDeletionsServiceUnavailableErrorResponseBody.d.ts +9 -0
- package/dist/cjs/api/types/PlacesGetPlaceDeletionsServiceUnavailableErrorResponseBody.js +3 -0
- package/dist/cjs/api/types/PlacesGetPlaceDeletionsTooManyRequestsErrorResponseBody.d.ts +9 -0
- package/dist/cjs/api/types/PlacesGetPlaceDeletionsTooManyRequestsErrorResponseBody.js +3 -0
- package/dist/cjs/api/types/PlacesGetPlaceDeletionsUnauthorizedErrorResponseBody.d.ts +9 -0
- package/dist/cjs/api/types/PlacesGetPlaceDeletionsUnauthorizedErrorResponseBody.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 +28 -0
- package/dist/esm/api/resources/betaApIs/client/Client.mjs +87 -0
- package/dist/esm/api/resources/betaApIs/client/requests/GetPlaceDeletionsRequest.d.mts +10 -0
- package/dist/esm/api/resources/betaApIs/client/requests/GetPlaceDeletionsRequest.mjs +2 -0
- package/dist/esm/api/resources/betaApIs/client/requests/index.d.mts +1 -0
- package/dist/esm/api/types/PlaceDeletionMarkerObjectResponseBody.d.mts +17 -0
- package/dist/esm/api/types/PlaceDeletionMarkerObjectResponseBody.mjs +2 -0
- package/dist/esm/api/types/PlacesGetPlaceDeletionsBadGatewayErrorResponseBody.d.mts +9 -0
- package/dist/esm/api/types/PlacesGetPlaceDeletionsBadGatewayErrorResponseBody.mjs +2 -0
- package/dist/esm/api/types/PlacesGetPlaceDeletionsGatewayTimeoutErrorResponseBody.d.mts +9 -0
- package/dist/esm/api/types/PlacesGetPlaceDeletionsGatewayTimeoutErrorResponseBody.mjs +2 -0
- package/dist/esm/api/types/PlacesGetPlaceDeletionsInternalServerErrorResponseBody.d.mts +9 -0
- package/dist/esm/api/types/PlacesGetPlaceDeletionsInternalServerErrorResponseBody.mjs +2 -0
- package/dist/esm/api/types/PlacesGetPlaceDeletionsMethodNotAllowedErrorResponseBody.d.mts +9 -0
- package/dist/esm/api/types/PlacesGetPlaceDeletionsMethodNotAllowedErrorResponseBody.mjs +2 -0
- package/dist/esm/api/types/PlacesGetPlaceDeletionsNotFoundErrorResponseBody.d.mts +9 -0
- package/dist/esm/api/types/PlacesGetPlaceDeletionsNotFoundErrorResponseBody.mjs +2 -0
- package/dist/esm/api/types/PlacesGetPlaceDeletionsNotImplementedErrorResponseBody.d.mts +9 -0
- package/dist/esm/api/types/PlacesGetPlaceDeletionsNotImplementedErrorResponseBody.mjs +2 -0
- package/dist/esm/api/types/PlacesGetPlaceDeletionsResponseBody.d.mts +6 -0
- package/dist/esm/api/types/PlacesGetPlaceDeletionsResponseBody.mjs +2 -0
- package/dist/esm/api/types/PlacesGetPlaceDeletionsServiceUnavailableErrorResponseBody.d.mts +9 -0
- package/dist/esm/api/types/PlacesGetPlaceDeletionsServiceUnavailableErrorResponseBody.mjs +2 -0
- package/dist/esm/api/types/PlacesGetPlaceDeletionsTooManyRequestsErrorResponseBody.d.mts +9 -0
- package/dist/esm/api/types/PlacesGetPlaceDeletionsTooManyRequestsErrorResponseBody.mjs +2 -0
- package/dist/esm/api/types/PlacesGetPlaceDeletionsUnauthorizedErrorResponseBody.d.mts +9 -0
- package/dist/esm/api/types/PlacesGetPlaceDeletionsUnauthorizedErrorResponseBody.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 +70 -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.10.0",
|
|
48
|
+
"User-Agent": "@samsarahq/samsara/13.10.0",
|
|
49
49
|
"X-Fern-Runtime": core.RUNTIME.type,
|
|
50
50
|
"X-Fern-Runtime-Version": core.RUNTIME.version,
|
|
51
51
|
"X-Samsara-Version": (_a = options === null || options === void 0 ? void 0 : options.version) !== null && _a !== void 0 ? _a : "2025-06-11",
|
|
@@ -1357,6 +1357,34 @@ export declare class BetaApIsClient {
|
|
|
1357
1357
|
*/
|
|
1358
1358
|
patchPlace(request?: Samsara.PlacesPatchPlaceRequestBody, requestOptions?: BetaApIsClient.RequestOptions): core.HttpResponsePromise<Samsara.PlacesPatchPlaceResponseBody>;
|
|
1359
1359
|
private __patchPlace;
|
|
1360
|
+
/**
|
|
1361
|
+
* Returns cursor-paginated deletion markers for soft-deleted places in the organization. Use for replication after DELETE /places.
|
|
1362
|
+
*
|
|
1363
|
+
* <b>Rate limit:</b> 5 requests/sec (learn more about rate limits <a href="https://developers.samsara.com/docs/rate-limits" target="_blank">here</a>).
|
|
1364
|
+
*
|
|
1365
|
+
* To use this endpoint, select **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>
|
|
1366
|
+
*
|
|
1367
|
+
*
|
|
1368
|
+
* **Submit Feedback**: Likes, dislikes, and API feature requests should be filed as feedback in our <a href="https://forms.gle/zkD4NCH7HjKb7mm69" target="_blank">API feedback form</a>. If you encountered an issue or noticed inaccuracies in the API documentation, please <a href="https://www.samsara.com/help" target="_blank">submit a case</a> to our support team.
|
|
1369
|
+
*
|
|
1370
|
+
* @param {Samsara.GetPlaceDeletionsRequest} request
|
|
1371
|
+
* @param {BetaApIsClient.RequestOptions} requestOptions - Request-specific configuration.
|
|
1372
|
+
*
|
|
1373
|
+
* @throws {@link Samsara.UnauthorizedError}
|
|
1374
|
+
* @throws {@link Samsara.NotFoundError}
|
|
1375
|
+
* @throws {@link Samsara.MethodNotAllowedError}
|
|
1376
|
+
* @throws {@link Samsara.TooManyRequestsError}
|
|
1377
|
+
* @throws {@link Samsara.InternalServerError}
|
|
1378
|
+
* @throws {@link Samsara.NotImplementedError}
|
|
1379
|
+
* @throws {@link Samsara.BadGatewayError}
|
|
1380
|
+
* @throws {@link Samsara.ServiceUnavailableError}
|
|
1381
|
+
* @throws {@link Samsara.GatewayTimeoutError}
|
|
1382
|
+
*
|
|
1383
|
+
* @example
|
|
1384
|
+
* await client.betaApIs.getPlaceDeletions()
|
|
1385
|
+
*/
|
|
1386
|
+
getPlaceDeletions(request?: Samsara.GetPlaceDeletionsRequest, requestOptions?: BetaApIsClient.RequestOptions): core.HttpResponsePromise<Samsara.PlacesGetPlaceDeletionsResponseBody>;
|
|
1387
|
+
private __getPlaceDeletions;
|
|
1360
1388
|
/**
|
|
1361
1389
|
* List all preferred fuel stations for your organization.
|
|
1362
1390
|
*
|
|
@@ -4034,6 +4034,93 @@ class BetaApIsClient {
|
|
|
4034
4034
|
return (0, handleNonStatusCodeError_js_1.handleNonStatusCodeError)(_response.error, _response.rawResponse, "PATCH", "/places");
|
|
4035
4035
|
});
|
|
4036
4036
|
}
|
|
4037
|
+
/**
|
|
4038
|
+
* Returns cursor-paginated deletion markers for soft-deleted places in the organization. Use for replication after DELETE /places.
|
|
4039
|
+
*
|
|
4040
|
+
* <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>).
|
|
4041
|
+
*
|
|
4042
|
+
* 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>
|
|
4043
|
+
*
|
|
4044
|
+
*
|
|
4045
|
+
* **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.
|
|
4046
|
+
*
|
|
4047
|
+
* @param {Samsara.GetPlaceDeletionsRequest} request
|
|
4048
|
+
* @param {BetaApIsClient.RequestOptions} requestOptions - Request-specific configuration.
|
|
4049
|
+
*
|
|
4050
|
+
* @throws {@link Samsara.UnauthorizedError}
|
|
4051
|
+
* @throws {@link Samsara.NotFoundError}
|
|
4052
|
+
* @throws {@link Samsara.MethodNotAllowedError}
|
|
4053
|
+
* @throws {@link Samsara.TooManyRequestsError}
|
|
4054
|
+
* @throws {@link Samsara.InternalServerError}
|
|
4055
|
+
* @throws {@link Samsara.NotImplementedError}
|
|
4056
|
+
* @throws {@link Samsara.BadGatewayError}
|
|
4057
|
+
* @throws {@link Samsara.ServiceUnavailableError}
|
|
4058
|
+
* @throws {@link Samsara.GatewayTimeoutError}
|
|
4059
|
+
*
|
|
4060
|
+
* @example
|
|
4061
|
+
* await client.betaApIs.getPlaceDeletions()
|
|
4062
|
+
*/
|
|
4063
|
+
getPlaceDeletions(request = {}, requestOptions) {
|
|
4064
|
+
return core.HttpResponsePromise.fromPromise(this.__getPlaceDeletions(request, requestOptions));
|
|
4065
|
+
}
|
|
4066
|
+
__getPlaceDeletions() {
|
|
4067
|
+
return __awaiter(this, arguments, void 0, function* (request = {}, requestOptions) {
|
|
4068
|
+
var _a, _b, _c, _d, _e, _f, _g, _h, _j;
|
|
4069
|
+
const { after, limit } = request;
|
|
4070
|
+
const _queryParams = {
|
|
4071
|
+
after,
|
|
4072
|
+
limit,
|
|
4073
|
+
};
|
|
4074
|
+
const _authRequest = yield this._options.authProvider.getAuthRequest();
|
|
4075
|
+
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);
|
|
4076
|
+
const _response = yield core.fetcher({
|
|
4077
|
+
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/deletions"),
|
|
4078
|
+
method: "GET",
|
|
4079
|
+
headers: _headers,
|
|
4080
|
+
queryParameters: Object.assign(Object.assign({}, _queryParams), requestOptions === null || requestOptions === void 0 ? void 0 : requestOptions.queryParams),
|
|
4081
|
+
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,
|
|
4082
|
+
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,
|
|
4083
|
+
abortSignal: requestOptions === null || requestOptions === void 0 ? void 0 : requestOptions.abortSignal,
|
|
4084
|
+
fetchFn: (_j = this._options) === null || _j === void 0 ? void 0 : _j.fetch,
|
|
4085
|
+
logging: this._options.logging,
|
|
4086
|
+
});
|
|
4087
|
+
if (_response.ok) {
|
|
4088
|
+
return {
|
|
4089
|
+
data: _response.body,
|
|
4090
|
+
rawResponse: _response.rawResponse,
|
|
4091
|
+
};
|
|
4092
|
+
}
|
|
4093
|
+
if (_response.error.reason === "status-code") {
|
|
4094
|
+
switch (_response.error.statusCode) {
|
|
4095
|
+
case 401:
|
|
4096
|
+
throw new Samsara.UnauthorizedError(_response.error.body, _response.rawResponse);
|
|
4097
|
+
case 404:
|
|
4098
|
+
throw new Samsara.NotFoundError(_response.error.body, _response.rawResponse);
|
|
4099
|
+
case 405:
|
|
4100
|
+
throw new Samsara.MethodNotAllowedError(_response.error.body, _response.rawResponse);
|
|
4101
|
+
case 429:
|
|
4102
|
+
throw new Samsara.TooManyRequestsError(_response.error.body, _response.rawResponse);
|
|
4103
|
+
case 500:
|
|
4104
|
+
throw new Samsara.InternalServerError(_response.error.body, _response.rawResponse);
|
|
4105
|
+
case 501:
|
|
4106
|
+
throw new Samsara.NotImplementedError(_response.error.body, _response.rawResponse);
|
|
4107
|
+
case 502:
|
|
4108
|
+
throw new Samsara.BadGatewayError(_response.error.body, _response.rawResponse);
|
|
4109
|
+
case 503:
|
|
4110
|
+
throw new Samsara.ServiceUnavailableError(_response.error.body, _response.rawResponse);
|
|
4111
|
+
case 504:
|
|
4112
|
+
throw new Samsara.GatewayTimeoutError(_response.error.body, _response.rawResponse);
|
|
4113
|
+
default:
|
|
4114
|
+
throw new errors.SamsaraError({
|
|
4115
|
+
statusCode: _response.error.statusCode,
|
|
4116
|
+
body: _response.error.body,
|
|
4117
|
+
rawResponse: _response.rawResponse,
|
|
4118
|
+
});
|
|
4119
|
+
}
|
|
4120
|
+
}
|
|
4121
|
+
return (0, handleNonStatusCodeError_js_1.handleNonStatusCodeError)(_response.error, _response.rawResponse, "GET", "/places/deletions");
|
|
4122
|
+
});
|
|
4123
|
+
}
|
|
4037
4124
|
/**
|
|
4038
4125
|
* List all preferred fuel stations for your organization.
|
|
4039
4126
|
*
|
|
@@ -0,0 +1,10 @@
|
|
|
1
|
+
/**
|
|
2
|
+
* @example
|
|
3
|
+
* {}
|
|
4
|
+
*/
|
|
5
|
+
export interface GetPlaceDeletionsRequest {
|
|
6
|
+
/** 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. */
|
|
7
|
+
after?: string;
|
|
8
|
+
/** The limit for how many objects will be in the response. Default and max for this value is 512 objects. */
|
|
9
|
+
limit?: number;
|
|
10
|
+
}
|
|
@@ -31,6 +31,7 @@ export type { GetFunctionRunRequest } from "./GetFunctionRunRequest.js";
|
|
|
31
31
|
export type { GetFunctionStorageFileRequest } from "./GetFunctionStorageFileRequest.js";
|
|
32
32
|
export type { GetHosEldEventsRequest } from "./GetHosEldEventsRequest.js";
|
|
33
33
|
export type { GetJobsRequest } from "./GetJobsRequest.js";
|
|
34
|
+
export type { GetPlaceDeletionsRequest } from "./GetPlaceDeletionsRequest.js";
|
|
34
35
|
export type { GetPlacesRequest } from "./GetPlacesRequest.js";
|
|
35
36
|
export type { GetPreferredStationRequest } from "./GetPreferredStationRequest.js";
|
|
36
37
|
export type { GetQualificationRecordsRequest } from "./GetQualificationRecordsRequest.js";
|
|
@@ -0,0 +1,17 @@
|
|
|
1
|
+
/**
|
|
2
|
+
* Deletion marker for a soft-deleted place.
|
|
3
|
+
*/
|
|
4
|
+
export interface PlaceDeletionMarkerObjectResponseBody {
|
|
5
|
+
/** When the delete became customer-visible, in RFC 3339 format. */
|
|
6
|
+
deletedAtTime: string;
|
|
7
|
+
/** External ids captured for the place when present. */
|
|
8
|
+
externalIds?: PlaceDeletionMarkerObjectResponseBody.ExternalIds | undefined;
|
|
9
|
+
/** Samsara place id. */
|
|
10
|
+
id: string;
|
|
11
|
+
}
|
|
12
|
+
export declare namespace PlaceDeletionMarkerObjectResponseBody {
|
|
13
|
+
/**
|
|
14
|
+
* External ids captured for the place when present.
|
|
15
|
+
*/
|
|
16
|
+
type ExternalIds = {};
|
|
17
|
+
}
|
|
@@ -0,0 +1,9 @@
|
|
|
1
|
+
/**
|
|
2
|
+
* An internal server error occurred
|
|
3
|
+
*/
|
|
4
|
+
export interface PlacesGetPlaceDeletionsInternalServerErrorResponseBody {
|
|
5
|
+
/** Message of error */
|
|
6
|
+
message: string;
|
|
7
|
+
/** The request ID; used when reaching out to support for issues with requests. */
|
|
8
|
+
requestId: string;
|
|
9
|
+
}
|
|
@@ -0,0 +1,9 @@
|
|
|
1
|
+
/**
|
|
2
|
+
* Method not allowed
|
|
3
|
+
*/
|
|
4
|
+
export interface PlacesGetPlaceDeletionsMethodNotAllowedErrorResponseBody {
|
|
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 PlacesGetPlaceDeletionsNotImplementedErrorResponseBody {
|
|
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 PlacesGetPlaceDeletionsResponseBody {
|
|
3
|
+
/** Deletion markers for soft-deleted places. */
|
|
4
|
+
data: Samsara.PlaceDeletionMarkerObjectResponseBody[];
|
|
5
|
+
pagination: Samsara.GoaPaginationResponseResponseBody;
|
|
6
|
+
}
|
|
@@ -0,0 +1,9 @@
|
|
|
1
|
+
/**
|
|
2
|
+
* Service unavailable
|
|
3
|
+
*/
|
|
4
|
+
export interface PlacesGetPlaceDeletionsServiceUnavailableErrorResponseBody {
|
|
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
|
+
}
|
|
@@ -1878,6 +1878,7 @@ export * from "./PendingDutyStatusDurationsObjectResponseBody.js";
|
|
|
1878
1878
|
export * from "./PersonDetectedResponseBody.js";
|
|
1879
1879
|
export * from "./PhotoValueObjectRequestBody.js";
|
|
1880
1880
|
export * from "./PhotoValueObjectResponseBody.js";
|
|
1881
|
+
export * from "./PlaceDeletionMarkerObjectResponseBody.js";
|
|
1881
1882
|
export * from "./PlaceGeofenceVertexResponseResponseBody.js";
|
|
1882
1883
|
export * from "./PlaceHubLocationCapacityServiceTimeInputRequestBody.js";
|
|
1883
1884
|
export * from "./PlaceHubLocationOrderServiceTimeInputRequestBody.js";
|
|
@@ -1898,6 +1899,16 @@ export * from "./PlacesDeletePlaceNotImplementedErrorResponseBody.js";
|
|
|
1898
1899
|
export * from "./PlacesDeletePlaceServiceUnavailableErrorResponseBody.js";
|
|
1899
1900
|
export * from "./PlacesDeletePlaceTooManyRequestsErrorResponseBody.js";
|
|
1900
1901
|
export * from "./PlacesDeletePlaceUnauthorizedErrorResponseBody.js";
|
|
1902
|
+
export * from "./PlacesGetPlaceDeletionsBadGatewayErrorResponseBody.js";
|
|
1903
|
+
export * from "./PlacesGetPlaceDeletionsGatewayTimeoutErrorResponseBody.js";
|
|
1904
|
+
export * from "./PlacesGetPlaceDeletionsInternalServerErrorResponseBody.js";
|
|
1905
|
+
export * from "./PlacesGetPlaceDeletionsMethodNotAllowedErrorResponseBody.js";
|
|
1906
|
+
export * from "./PlacesGetPlaceDeletionsNotFoundErrorResponseBody.js";
|
|
1907
|
+
export * from "./PlacesGetPlaceDeletionsNotImplementedErrorResponseBody.js";
|
|
1908
|
+
export * from "./PlacesGetPlaceDeletionsResponseBody.js";
|
|
1909
|
+
export * from "./PlacesGetPlaceDeletionsServiceUnavailableErrorResponseBody.js";
|
|
1910
|
+
export * from "./PlacesGetPlaceDeletionsTooManyRequestsErrorResponseBody.js";
|
|
1911
|
+
export * from "./PlacesGetPlaceDeletionsUnauthorizedErrorResponseBody.js";
|
|
1901
1912
|
export * from "./PlacesGetPlacesBadGatewayErrorResponseBody.js";
|
|
1902
1913
|
export * from "./PlacesGetPlacesGatewayTimeoutErrorResponseBody.js";
|
|
1903
1914
|
export * from "./PlacesGetPlacesInternalServerErrorResponseBody.js";
|
|
@@ -1894,6 +1894,7 @@ __exportStar(require("./PendingDutyStatusDurationsObjectResponseBody.js"), expor
|
|
|
1894
1894
|
__exportStar(require("./PersonDetectedResponseBody.js"), exports);
|
|
1895
1895
|
__exportStar(require("./PhotoValueObjectRequestBody.js"), exports);
|
|
1896
1896
|
__exportStar(require("./PhotoValueObjectResponseBody.js"), exports);
|
|
1897
|
+
__exportStar(require("./PlaceDeletionMarkerObjectResponseBody.js"), exports);
|
|
1897
1898
|
__exportStar(require("./PlaceGeofenceVertexResponseResponseBody.js"), exports);
|
|
1898
1899
|
__exportStar(require("./PlaceHubLocationCapacityServiceTimeInputRequestBody.js"), exports);
|
|
1899
1900
|
__exportStar(require("./PlaceHubLocationOrderServiceTimeInputRequestBody.js"), exports);
|
|
@@ -1914,6 +1915,16 @@ __exportStar(require("./PlacesDeletePlaceNotImplementedErrorResponseBody.js"), e
|
|
|
1914
1915
|
__exportStar(require("./PlacesDeletePlaceServiceUnavailableErrorResponseBody.js"), exports);
|
|
1915
1916
|
__exportStar(require("./PlacesDeletePlaceTooManyRequestsErrorResponseBody.js"), exports);
|
|
1916
1917
|
__exportStar(require("./PlacesDeletePlaceUnauthorizedErrorResponseBody.js"), exports);
|
|
1918
|
+
__exportStar(require("./PlacesGetPlaceDeletionsBadGatewayErrorResponseBody.js"), exports);
|
|
1919
|
+
__exportStar(require("./PlacesGetPlaceDeletionsGatewayTimeoutErrorResponseBody.js"), exports);
|
|
1920
|
+
__exportStar(require("./PlacesGetPlaceDeletionsInternalServerErrorResponseBody.js"), exports);
|
|
1921
|
+
__exportStar(require("./PlacesGetPlaceDeletionsMethodNotAllowedErrorResponseBody.js"), exports);
|
|
1922
|
+
__exportStar(require("./PlacesGetPlaceDeletionsNotFoundErrorResponseBody.js"), exports);
|
|
1923
|
+
__exportStar(require("./PlacesGetPlaceDeletionsNotImplementedErrorResponseBody.js"), exports);
|
|
1924
|
+
__exportStar(require("./PlacesGetPlaceDeletionsResponseBody.js"), exports);
|
|
1925
|
+
__exportStar(require("./PlacesGetPlaceDeletionsServiceUnavailableErrorResponseBody.js"), exports);
|
|
1926
|
+
__exportStar(require("./PlacesGetPlaceDeletionsTooManyRequestsErrorResponseBody.js"), exports);
|
|
1927
|
+
__exportStar(require("./PlacesGetPlaceDeletionsUnauthorizedErrorResponseBody.js"), exports);
|
|
1917
1928
|
__exportStar(require("./PlacesGetPlacesBadGatewayErrorResponseBody.js"), exports);
|
|
1918
1929
|
__exportStar(require("./PlacesGetPlacesGatewayTimeoutErrorResponseBody.js"), exports);
|
|
1919
1930
|
__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.10.0";
|
package/dist/cjs/version.js
CHANGED
package/dist/esm/BaseClient.mjs
CHANGED
|
@@ -7,8 +7,8 @@ export function normalizeClientOptions(options) {
|
|
|
7
7
|
const headers = mergeHeaders({
|
|
8
8
|
"X-Fern-Language": "JavaScript",
|
|
9
9
|
"X-Fern-SDK-Name": "@samsarahq/samsara",
|
|
10
|
-
"X-Fern-SDK-Version": "13.
|
|
11
|
-
"User-Agent": "@samsarahq/samsara/13.
|
|
10
|
+
"X-Fern-SDK-Version": "13.10.0",
|
|
11
|
+
"User-Agent": "@samsarahq/samsara/13.10.0",
|
|
12
12
|
"X-Fern-Runtime": core.RUNTIME.type,
|
|
13
13
|
"X-Fern-Runtime-Version": core.RUNTIME.version,
|
|
14
14
|
"X-Samsara-Version": (_a = options === null || options === void 0 ? void 0 : options.version) !== null && _a !== void 0 ? _a : "2025-06-11",
|
|
@@ -1357,6 +1357,34 @@ export declare class BetaApIsClient {
|
|
|
1357
1357
|
*/
|
|
1358
1358
|
patchPlace(request?: Samsara.PlacesPatchPlaceRequestBody, requestOptions?: BetaApIsClient.RequestOptions): core.HttpResponsePromise<Samsara.PlacesPatchPlaceResponseBody>;
|
|
1359
1359
|
private __patchPlace;
|
|
1360
|
+
/**
|
|
1361
|
+
* Returns cursor-paginated deletion markers for soft-deleted places in the organization. Use for replication after DELETE /places.
|
|
1362
|
+
*
|
|
1363
|
+
* <b>Rate limit:</b> 5 requests/sec (learn more about rate limits <a href="https://developers.samsara.com/docs/rate-limits" target="_blank">here</a>).
|
|
1364
|
+
*
|
|
1365
|
+
* To use this endpoint, select **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>
|
|
1366
|
+
*
|
|
1367
|
+
*
|
|
1368
|
+
* **Submit Feedback**: Likes, dislikes, and API feature requests should be filed as feedback in our <a href="https://forms.gle/zkD4NCH7HjKb7mm69" target="_blank">API feedback form</a>. If you encountered an issue or noticed inaccuracies in the API documentation, please <a href="https://www.samsara.com/help" target="_blank">submit a case</a> to our support team.
|
|
1369
|
+
*
|
|
1370
|
+
* @param {Samsara.GetPlaceDeletionsRequest} request
|
|
1371
|
+
* @param {BetaApIsClient.RequestOptions} requestOptions - Request-specific configuration.
|
|
1372
|
+
*
|
|
1373
|
+
* @throws {@link Samsara.UnauthorizedError}
|
|
1374
|
+
* @throws {@link Samsara.NotFoundError}
|
|
1375
|
+
* @throws {@link Samsara.MethodNotAllowedError}
|
|
1376
|
+
* @throws {@link Samsara.TooManyRequestsError}
|
|
1377
|
+
* @throws {@link Samsara.InternalServerError}
|
|
1378
|
+
* @throws {@link Samsara.NotImplementedError}
|
|
1379
|
+
* @throws {@link Samsara.BadGatewayError}
|
|
1380
|
+
* @throws {@link Samsara.ServiceUnavailableError}
|
|
1381
|
+
* @throws {@link Samsara.GatewayTimeoutError}
|
|
1382
|
+
*
|
|
1383
|
+
* @example
|
|
1384
|
+
* await client.betaApIs.getPlaceDeletions()
|
|
1385
|
+
*/
|
|
1386
|
+
getPlaceDeletions(request?: Samsara.GetPlaceDeletionsRequest, requestOptions?: BetaApIsClient.RequestOptions): core.HttpResponsePromise<Samsara.PlacesGetPlaceDeletionsResponseBody>;
|
|
1387
|
+
private __getPlaceDeletions;
|
|
1360
1388
|
/**
|
|
1361
1389
|
* List all preferred fuel stations for your organization.
|
|
1362
1390
|
*
|
|
@@ -3998,6 +3998,93 @@ export class BetaApIsClient {
|
|
|
3998
3998
|
return handleNonStatusCodeError(_response.error, _response.rawResponse, "PATCH", "/places");
|
|
3999
3999
|
});
|
|
4000
4000
|
}
|
|
4001
|
+
/**
|
|
4002
|
+
* Returns cursor-paginated deletion markers for soft-deleted places in the organization. Use for replication after DELETE /places.
|
|
4003
|
+
*
|
|
4004
|
+
* <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>).
|
|
4005
|
+
*
|
|
4006
|
+
* 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>
|
|
4007
|
+
*
|
|
4008
|
+
*
|
|
4009
|
+
* **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.
|
|
4010
|
+
*
|
|
4011
|
+
* @param {Samsara.GetPlaceDeletionsRequest} request
|
|
4012
|
+
* @param {BetaApIsClient.RequestOptions} requestOptions - Request-specific configuration.
|
|
4013
|
+
*
|
|
4014
|
+
* @throws {@link Samsara.UnauthorizedError}
|
|
4015
|
+
* @throws {@link Samsara.NotFoundError}
|
|
4016
|
+
* @throws {@link Samsara.MethodNotAllowedError}
|
|
4017
|
+
* @throws {@link Samsara.TooManyRequestsError}
|
|
4018
|
+
* @throws {@link Samsara.InternalServerError}
|
|
4019
|
+
* @throws {@link Samsara.NotImplementedError}
|
|
4020
|
+
* @throws {@link Samsara.BadGatewayError}
|
|
4021
|
+
* @throws {@link Samsara.ServiceUnavailableError}
|
|
4022
|
+
* @throws {@link Samsara.GatewayTimeoutError}
|
|
4023
|
+
*
|
|
4024
|
+
* @example
|
|
4025
|
+
* await client.betaApIs.getPlaceDeletions()
|
|
4026
|
+
*/
|
|
4027
|
+
getPlaceDeletions(request = {}, requestOptions) {
|
|
4028
|
+
return core.HttpResponsePromise.fromPromise(this.__getPlaceDeletions(request, requestOptions));
|
|
4029
|
+
}
|
|
4030
|
+
__getPlaceDeletions() {
|
|
4031
|
+
return __awaiter(this, arguments, void 0, function* (request = {}, requestOptions) {
|
|
4032
|
+
var _a, _b, _c, _d, _e, _f, _g, _h, _j;
|
|
4033
|
+
const { after, limit } = request;
|
|
4034
|
+
const _queryParams = {
|
|
4035
|
+
after,
|
|
4036
|
+
limit,
|
|
4037
|
+
};
|
|
4038
|
+
const _authRequest = yield this._options.authProvider.getAuthRequest();
|
|
4039
|
+
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);
|
|
4040
|
+
const _response = yield core.fetcher({
|
|
4041
|
+
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/deletions"),
|
|
4042
|
+
method: "GET",
|
|
4043
|
+
headers: _headers,
|
|
4044
|
+
queryParameters: Object.assign(Object.assign({}, _queryParams), requestOptions === null || requestOptions === void 0 ? void 0 : requestOptions.queryParams),
|
|
4045
|
+
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,
|
|
4046
|
+
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,
|
|
4047
|
+
abortSignal: requestOptions === null || requestOptions === void 0 ? void 0 : requestOptions.abortSignal,
|
|
4048
|
+
fetchFn: (_j = this._options) === null || _j === void 0 ? void 0 : _j.fetch,
|
|
4049
|
+
logging: this._options.logging,
|
|
4050
|
+
});
|
|
4051
|
+
if (_response.ok) {
|
|
4052
|
+
return {
|
|
4053
|
+
data: _response.body,
|
|
4054
|
+
rawResponse: _response.rawResponse,
|
|
4055
|
+
};
|
|
4056
|
+
}
|
|
4057
|
+
if (_response.error.reason === "status-code") {
|
|
4058
|
+
switch (_response.error.statusCode) {
|
|
4059
|
+
case 401:
|
|
4060
|
+
throw new Samsara.UnauthorizedError(_response.error.body, _response.rawResponse);
|
|
4061
|
+
case 404:
|
|
4062
|
+
throw new Samsara.NotFoundError(_response.error.body, _response.rawResponse);
|
|
4063
|
+
case 405:
|
|
4064
|
+
throw new Samsara.MethodNotAllowedError(_response.error.body, _response.rawResponse);
|
|
4065
|
+
case 429:
|
|
4066
|
+
throw new Samsara.TooManyRequestsError(_response.error.body, _response.rawResponse);
|
|
4067
|
+
case 500:
|
|
4068
|
+
throw new Samsara.InternalServerError(_response.error.body, _response.rawResponse);
|
|
4069
|
+
case 501:
|
|
4070
|
+
throw new Samsara.NotImplementedError(_response.error.body, _response.rawResponse);
|
|
4071
|
+
case 502:
|
|
4072
|
+
throw new Samsara.BadGatewayError(_response.error.body, _response.rawResponse);
|
|
4073
|
+
case 503:
|
|
4074
|
+
throw new Samsara.ServiceUnavailableError(_response.error.body, _response.rawResponse);
|
|
4075
|
+
case 504:
|
|
4076
|
+
throw new Samsara.GatewayTimeoutError(_response.error.body, _response.rawResponse);
|
|
4077
|
+
default:
|
|
4078
|
+
throw new errors.SamsaraError({
|
|
4079
|
+
statusCode: _response.error.statusCode,
|
|
4080
|
+
body: _response.error.body,
|
|
4081
|
+
rawResponse: _response.rawResponse,
|
|
4082
|
+
});
|
|
4083
|
+
}
|
|
4084
|
+
}
|
|
4085
|
+
return handleNonStatusCodeError(_response.error, _response.rawResponse, "GET", "/places/deletions");
|
|
4086
|
+
});
|
|
4087
|
+
}
|
|
4001
4088
|
/**
|
|
4002
4089
|
* List all preferred fuel stations for your organization.
|
|
4003
4090
|
*
|
|
@@ -0,0 +1,10 @@
|
|
|
1
|
+
/**
|
|
2
|
+
* @example
|
|
3
|
+
* {}
|
|
4
|
+
*/
|
|
5
|
+
export interface GetPlaceDeletionsRequest {
|
|
6
|
+
/** 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. */
|
|
7
|
+
after?: string;
|
|
8
|
+
/** The limit for how many objects will be in the response. Default and max for this value is 512 objects. */
|
|
9
|
+
limit?: number;
|
|
10
|
+
}
|
|
@@ -31,6 +31,7 @@ export type { GetFunctionRunRequest } from "./GetFunctionRunRequest.mjs";
|
|
|
31
31
|
export type { GetFunctionStorageFileRequest } from "./GetFunctionStorageFileRequest.mjs";
|
|
32
32
|
export type { GetHosEldEventsRequest } from "./GetHosEldEventsRequest.mjs";
|
|
33
33
|
export type { GetJobsRequest } from "./GetJobsRequest.mjs";
|
|
34
|
+
export type { GetPlaceDeletionsRequest } from "./GetPlaceDeletionsRequest.mjs";
|
|
34
35
|
export type { GetPlacesRequest } from "./GetPlacesRequest.mjs";
|
|
35
36
|
export type { GetPreferredStationRequest } from "./GetPreferredStationRequest.mjs";
|
|
36
37
|
export type { GetQualificationRecordsRequest } from "./GetQualificationRecordsRequest.mjs";
|
|
@@ -0,0 +1,17 @@
|
|
|
1
|
+
/**
|
|
2
|
+
* Deletion marker for a soft-deleted place.
|
|
3
|
+
*/
|
|
4
|
+
export interface PlaceDeletionMarkerObjectResponseBody {
|
|
5
|
+
/** When the delete became customer-visible, in RFC 3339 format. */
|
|
6
|
+
deletedAtTime: string;
|
|
7
|
+
/** External ids captured for the place when present. */
|
|
8
|
+
externalIds?: PlaceDeletionMarkerObjectResponseBody.ExternalIds | undefined;
|
|
9
|
+
/** Samsara place id. */
|
|
10
|
+
id: string;
|
|
11
|
+
}
|
|
12
|
+
export declare namespace PlaceDeletionMarkerObjectResponseBody {
|
|
13
|
+
/**
|
|
14
|
+
* External ids captured for the place when present.
|
|
15
|
+
*/
|
|
16
|
+
type ExternalIds = {};
|
|
17
|
+
}
|
|
@@ -0,0 +1,9 @@
|
|
|
1
|
+
/**
|
|
2
|
+
* An internal server error occurred
|
|
3
|
+
*/
|
|
4
|
+
export interface PlacesGetPlaceDeletionsInternalServerErrorResponseBody {
|
|
5
|
+
/** Message of error */
|
|
6
|
+
message: string;
|
|
7
|
+
/** The request ID; used when reaching out to support for issues with requests. */
|
|
8
|
+
requestId: string;
|
|
9
|
+
}
|
|
@@ -0,0 +1,9 @@
|
|
|
1
|
+
/**
|
|
2
|
+
* Method not allowed
|
|
3
|
+
*/
|
|
4
|
+
export interface PlacesGetPlaceDeletionsMethodNotAllowedErrorResponseBody {
|
|
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 PlacesGetPlaceDeletionsNotImplementedErrorResponseBody {
|
|
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 PlacesGetPlaceDeletionsResponseBody {
|
|
3
|
+
/** Deletion markers for soft-deleted places. */
|
|
4
|
+
data: Samsara.PlaceDeletionMarkerObjectResponseBody[];
|
|
5
|
+
pagination: Samsara.GoaPaginationResponseResponseBody;
|
|
6
|
+
}
|
|
@@ -0,0 +1,9 @@
|
|
|
1
|
+
/**
|
|
2
|
+
* Service unavailable
|
|
3
|
+
*/
|
|
4
|
+
export interface PlacesGetPlaceDeletionsServiceUnavailableErrorResponseBody {
|
|
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
|
+
}
|
|
@@ -1878,6 +1878,7 @@ export * from "./PendingDutyStatusDurationsObjectResponseBody.mjs";
|
|
|
1878
1878
|
export * from "./PersonDetectedResponseBody.mjs";
|
|
1879
1879
|
export * from "./PhotoValueObjectRequestBody.mjs";
|
|
1880
1880
|
export * from "./PhotoValueObjectResponseBody.mjs";
|
|
1881
|
+
export * from "./PlaceDeletionMarkerObjectResponseBody.mjs";
|
|
1881
1882
|
export * from "./PlaceGeofenceVertexResponseResponseBody.mjs";
|
|
1882
1883
|
export * from "./PlaceHubLocationCapacityServiceTimeInputRequestBody.mjs";
|
|
1883
1884
|
export * from "./PlaceHubLocationOrderServiceTimeInputRequestBody.mjs";
|
|
@@ -1898,6 +1899,16 @@ export * from "./PlacesDeletePlaceNotImplementedErrorResponseBody.mjs";
|
|
|
1898
1899
|
export * from "./PlacesDeletePlaceServiceUnavailableErrorResponseBody.mjs";
|
|
1899
1900
|
export * from "./PlacesDeletePlaceTooManyRequestsErrorResponseBody.mjs";
|
|
1900
1901
|
export * from "./PlacesDeletePlaceUnauthorizedErrorResponseBody.mjs";
|
|
1902
|
+
export * from "./PlacesGetPlaceDeletionsBadGatewayErrorResponseBody.mjs";
|
|
1903
|
+
export * from "./PlacesGetPlaceDeletionsGatewayTimeoutErrorResponseBody.mjs";
|
|
1904
|
+
export * from "./PlacesGetPlaceDeletionsInternalServerErrorResponseBody.mjs";
|
|
1905
|
+
export * from "./PlacesGetPlaceDeletionsMethodNotAllowedErrorResponseBody.mjs";
|
|
1906
|
+
export * from "./PlacesGetPlaceDeletionsNotFoundErrorResponseBody.mjs";
|
|
1907
|
+
export * from "./PlacesGetPlaceDeletionsNotImplementedErrorResponseBody.mjs";
|
|
1908
|
+
export * from "./PlacesGetPlaceDeletionsResponseBody.mjs";
|
|
1909
|
+
export * from "./PlacesGetPlaceDeletionsServiceUnavailableErrorResponseBody.mjs";
|
|
1910
|
+
export * from "./PlacesGetPlaceDeletionsTooManyRequestsErrorResponseBody.mjs";
|
|
1911
|
+
export * from "./PlacesGetPlaceDeletionsUnauthorizedErrorResponseBody.mjs";
|
|
1901
1912
|
export * from "./PlacesGetPlacesBadGatewayErrorResponseBody.mjs";
|
|
1902
1913
|
export * from "./PlacesGetPlacesGatewayTimeoutErrorResponseBody.mjs";
|
|
1903
1914
|
export * from "./PlacesGetPlacesInternalServerErrorResponseBody.mjs";
|
|
@@ -1878,6 +1878,7 @@ export * from "./PendingDutyStatusDurationsObjectResponseBody.mjs";
|
|
|
1878
1878
|
export * from "./PersonDetectedResponseBody.mjs";
|
|
1879
1879
|
export * from "./PhotoValueObjectRequestBody.mjs";
|
|
1880
1880
|
export * from "./PhotoValueObjectResponseBody.mjs";
|
|
1881
|
+
export * from "./PlaceDeletionMarkerObjectResponseBody.mjs";
|
|
1881
1882
|
export * from "./PlaceGeofenceVertexResponseResponseBody.mjs";
|
|
1882
1883
|
export * from "./PlaceHubLocationCapacityServiceTimeInputRequestBody.mjs";
|
|
1883
1884
|
export * from "./PlaceHubLocationOrderServiceTimeInputRequestBody.mjs";
|
|
@@ -1898,6 +1899,16 @@ export * from "./PlacesDeletePlaceNotImplementedErrorResponseBody.mjs";
|
|
|
1898
1899
|
export * from "./PlacesDeletePlaceServiceUnavailableErrorResponseBody.mjs";
|
|
1899
1900
|
export * from "./PlacesDeletePlaceTooManyRequestsErrorResponseBody.mjs";
|
|
1900
1901
|
export * from "./PlacesDeletePlaceUnauthorizedErrorResponseBody.mjs";
|
|
1902
|
+
export * from "./PlacesGetPlaceDeletionsBadGatewayErrorResponseBody.mjs";
|
|
1903
|
+
export * from "./PlacesGetPlaceDeletionsGatewayTimeoutErrorResponseBody.mjs";
|
|
1904
|
+
export * from "./PlacesGetPlaceDeletionsInternalServerErrorResponseBody.mjs";
|
|
1905
|
+
export * from "./PlacesGetPlaceDeletionsMethodNotAllowedErrorResponseBody.mjs";
|
|
1906
|
+
export * from "./PlacesGetPlaceDeletionsNotFoundErrorResponseBody.mjs";
|
|
1907
|
+
export * from "./PlacesGetPlaceDeletionsNotImplementedErrorResponseBody.mjs";
|
|
1908
|
+
export * from "./PlacesGetPlaceDeletionsResponseBody.mjs";
|
|
1909
|
+
export * from "./PlacesGetPlaceDeletionsServiceUnavailableErrorResponseBody.mjs";
|
|
1910
|
+
export * from "./PlacesGetPlaceDeletionsTooManyRequestsErrorResponseBody.mjs";
|
|
1911
|
+
export * from "./PlacesGetPlaceDeletionsUnauthorizedErrorResponseBody.mjs";
|
|
1901
1912
|
export * from "./PlacesGetPlacesBadGatewayErrorResponseBody.mjs";
|
|
1902
1913
|
export * from "./PlacesGetPlacesGatewayTimeoutErrorResponseBody.mjs";
|
|
1903
1914
|
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.10.0";
|
package/dist/esm/version.mjs
CHANGED
|
@@ -1 +1 @@
|
|
|
1
|
-
export const SDK_VERSION = "13.
|
|
1
|
+
export const SDK_VERSION = "13.10.0";
|
package/package.json
CHANGED
package/reference.md
CHANGED
|
@@ -4723,6 +4723,76 @@ await client.betaApIs.patchPlace();
|
|
|
4723
4723
|
</dl>
|
|
4724
4724
|
|
|
4725
4725
|
|
|
4726
|
+
</dd>
|
|
4727
|
+
</dl>
|
|
4728
|
+
</details>
|
|
4729
|
+
|
|
4730
|
+
<details><summary><code>client.betaApIs.<a href="/src/api/resources/betaApIs/client/Client.ts">getPlaceDeletions</a>({ ...params }) -> Samsara.PlacesGetPlaceDeletionsResponseBody</code></summary>
|
|
4731
|
+
<dl>
|
|
4732
|
+
<dd>
|
|
4733
|
+
|
|
4734
|
+
#### 📝 Description
|
|
4735
|
+
|
|
4736
|
+
<dl>
|
|
4737
|
+
<dd>
|
|
4738
|
+
|
|
4739
|
+
<dl>
|
|
4740
|
+
<dd>
|
|
4741
|
+
|
|
4742
|
+
Returns cursor-paginated deletion markers for soft-deleted places in the organization. Use for replication after DELETE /places.
|
|
4743
|
+
|
|
4744
|
+
<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>).
|
|
4745
|
+
|
|
4746
|
+
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>
|
|
4747
|
+
|
|
4748
|
+
|
|
4749
|
+
**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.
|
|
4750
|
+
</dd>
|
|
4751
|
+
</dl>
|
|
4752
|
+
</dd>
|
|
4753
|
+
</dl>
|
|
4754
|
+
|
|
4755
|
+
#### 🔌 Usage
|
|
4756
|
+
|
|
4757
|
+
<dl>
|
|
4758
|
+
<dd>
|
|
4759
|
+
|
|
4760
|
+
<dl>
|
|
4761
|
+
<dd>
|
|
4762
|
+
|
|
4763
|
+
```typescript
|
|
4764
|
+
await client.betaApIs.getPlaceDeletions();
|
|
4765
|
+
|
|
4766
|
+
```
|
|
4767
|
+
</dd>
|
|
4768
|
+
</dl>
|
|
4769
|
+
</dd>
|
|
4770
|
+
</dl>
|
|
4771
|
+
|
|
4772
|
+
#### ⚙️ Parameters
|
|
4773
|
+
|
|
4774
|
+
<dl>
|
|
4775
|
+
<dd>
|
|
4776
|
+
|
|
4777
|
+
<dl>
|
|
4778
|
+
<dd>
|
|
4779
|
+
|
|
4780
|
+
**request:** `Samsara.GetPlaceDeletionsRequest`
|
|
4781
|
+
|
|
4782
|
+
</dd>
|
|
4783
|
+
</dl>
|
|
4784
|
+
|
|
4785
|
+
<dl>
|
|
4786
|
+
<dd>
|
|
4787
|
+
|
|
4788
|
+
**requestOptions:** `BetaApIsClient.RequestOptions`
|
|
4789
|
+
|
|
4790
|
+
</dd>
|
|
4791
|
+
</dl>
|
|
4792
|
+
</dd>
|
|
4793
|
+
</dl>
|
|
4794
|
+
|
|
4795
|
+
|
|
4726
4796
|
</dd>
|
|
4727
4797
|
</dl>
|
|
4728
4798
|
</details>
|