@samsarahq/samsara 6.3.1 → 7.0.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 (56) hide show
  1. package/dist/cjs/BaseClient.js +2 -2
  2. package/dist/cjs/api/resources/betaApIs/client/Client.d.ts +91 -0
  3. package/dist/cjs/api/resources/betaApIs/client/Client.js +265 -0
  4. package/dist/cjs/api/resources/betaApIs/client/requests/ListMaintenanceVendorsRequest.d.ts +1 -1
  5. package/dist/cjs/api/resources/betaApIs/client/requests/index.d.ts +3 -0
  6. package/dist/cjs/api/resources/betaApIs/client/requests/index.js +3 -1
  7. package/dist/cjs/api/resources/previewApIs/client/Client.d.ts +0 -109
  8. package/dist/cjs/api/resources/previewApIs/client/Client.js +0 -294
  9. package/dist/cjs/api/resources/previewApIs/client/requests/index.d.ts +0 -3
  10. package/dist/cjs/api/resources/previewApIs/client/requests/index.js +0 -3
  11. package/dist/cjs/api/types/MissingStateResponseBody.d.ts +1 -1
  12. package/dist/cjs/api/types/NotificationRecipientResponseResponseBody.d.ts +23 -0
  13. package/dist/cjs/api/types/NotificationRecipientResponseResponseBody.js +14 -0
  14. package/dist/cjs/api/types/RecoveryStateResponseBody.d.ts +1 -1
  15. package/dist/cjs/api/types/VendorObjectResponseBody.d.ts +2 -0
  16. package/dist/cjs/api/types/index.d.ts +1 -1
  17. package/dist/cjs/api/types/index.js +1 -1
  18. package/dist/cjs/version.d.ts +1 -1
  19. package/dist/cjs/version.js +1 -1
  20. package/dist/esm/BaseClient.mjs +2 -2
  21. package/dist/esm/api/resources/betaApIs/client/Client.d.mts +91 -0
  22. package/dist/esm/api/resources/betaApIs/client/Client.mjs +265 -0
  23. package/dist/esm/api/resources/betaApIs/client/requests/ListMaintenanceVendorsRequest.d.mts +1 -1
  24. package/dist/esm/api/resources/betaApIs/client/requests/index.d.mts +3 -0
  25. package/dist/esm/api/resources/betaApIs/client/requests/index.mjs +1 -0
  26. package/dist/esm/api/resources/previewApIs/client/Client.d.mts +0 -109
  27. package/dist/esm/api/resources/previewApIs/client/Client.mjs +0 -294
  28. package/dist/esm/api/resources/previewApIs/client/requests/index.d.mts +0 -3
  29. package/dist/esm/api/resources/previewApIs/client/requests/index.mjs +1 -1
  30. package/dist/esm/api/types/MissingStateResponseBody.d.mts +1 -1
  31. package/dist/esm/api/types/NotificationRecipientResponseResponseBody.d.mts +23 -0
  32. package/dist/esm/api/types/NotificationRecipientResponseResponseBody.mjs +11 -0
  33. package/dist/esm/api/types/RecoveryStateResponseBody.d.mts +1 -1
  34. package/dist/esm/api/types/VendorObjectResponseBody.d.mts +2 -0
  35. package/dist/esm/api/types/index.d.mts +1 -1
  36. package/dist/esm/api/types/index.mjs +1 -1
  37. package/dist/esm/version.d.mts +1 -1
  38. package/dist/esm/version.mjs +1 -1
  39. package/package.json +1 -1
  40. package/reference.md +217 -235
  41. package/dist/cjs/api/types/NotificationRecipientResponseBody.d.ts +0 -19
  42. package/dist/cjs/api/types/NotificationRecipientResponseBody.js +0 -14
  43. package/dist/esm/api/types/NotificationRecipientResponseBody.d.mts +0 -19
  44. package/dist/esm/api/types/NotificationRecipientResponseBody.mjs +0 -11
  45. /package/dist/cjs/api/resources/{previewApIs → betaApIs}/client/requests/DeviceRecoveryMarkAssetMissingRequestBody.d.ts +0 -0
  46. /package/dist/cjs/api/resources/{previewApIs → betaApIs}/client/requests/DeviceRecoveryMarkAssetMissingRequestBody.js +0 -0
  47. /package/dist/cjs/api/resources/{previewApIs → betaApIs}/client/requests/DeviceRecoveryRecoverAssetRequestBody.d.ts +0 -0
  48. /package/dist/cjs/api/resources/{previewApIs → betaApIs}/client/requests/DeviceRecoveryRecoverAssetRequestBody.js +0 -0
  49. /package/dist/cjs/api/resources/{previewApIs → betaApIs}/client/requests/ListDeviceRecoveryMissingAssetsRequest.d.ts +0 -0
  50. /package/dist/cjs/api/resources/{previewApIs → betaApIs}/client/requests/ListDeviceRecoveryMissingAssetsRequest.js +0 -0
  51. /package/dist/esm/api/resources/{previewApIs → betaApIs}/client/requests/DeviceRecoveryMarkAssetMissingRequestBody.d.mts +0 -0
  52. /package/dist/esm/api/resources/{previewApIs → betaApIs}/client/requests/DeviceRecoveryMarkAssetMissingRequestBody.mjs +0 -0
  53. /package/dist/esm/api/resources/{previewApIs → betaApIs}/client/requests/DeviceRecoveryRecoverAssetRequestBody.d.mts +0 -0
  54. /package/dist/esm/api/resources/{previewApIs → betaApIs}/client/requests/DeviceRecoveryRecoverAssetRequestBody.mjs +0 -0
  55. /package/dist/esm/api/resources/{previewApIs → betaApIs}/client/requests/ListDeviceRecoveryMissingAssetsRequest.d.mts +0 -0
  56. /package/dist/esm/api/resources/{previewApIs → betaApIs}/client/requests/ListDeviceRecoveryMissingAssetsRequest.mjs +0 -0
@@ -1464,6 +1464,271 @@ export class BetaApIsClient {
1464
1464
  return handleNonStatusCodeError(_response.error, _response.rawResponse, "GET", "/devices");
1465
1465
  });
1466
1466
  }
1467
+ /**
1468
+ * List all assets that are currently marked as missing for the organization.
1469
+ *
1470
+ * <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>).
1471
+ *
1472
+ * To use this endpoint, select **Read Assets** under the Assets 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>
1473
+ *
1474
+ *
1475
+ * **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.
1476
+ *
1477
+ * @param {Samsara.ListDeviceRecoveryMissingAssetsRequest} request
1478
+ * @param {BetaApIsClient.RequestOptions} requestOptions - Request-specific configuration.
1479
+ *
1480
+ * @throws {@link Samsara.UnauthorizedError}
1481
+ * @throws {@link Samsara.NotFoundError}
1482
+ * @throws {@link Samsara.MethodNotAllowedError}
1483
+ * @throws {@link Samsara.TooManyRequestsError}
1484
+ * @throws {@link Samsara.InternalServerError}
1485
+ * @throws {@link Samsara.NotImplementedError}
1486
+ * @throws {@link Samsara.BadGatewayError}
1487
+ * @throws {@link Samsara.ServiceUnavailableError}
1488
+ * @throws {@link Samsara.GatewayTimeoutError}
1489
+ *
1490
+ * @example
1491
+ * await client.betaApIs.listDeviceRecoveryMissingAssets()
1492
+ */
1493
+ listDeviceRecoveryMissingAssets(request = {}, requestOptions) {
1494
+ return core.HttpResponsePromise.fromPromise(this.__listDeviceRecoveryMissingAssets(request, requestOptions));
1495
+ }
1496
+ __listDeviceRecoveryMissingAssets() {
1497
+ return __awaiter(this, arguments, void 0, function* (request = {}, requestOptions) {
1498
+ var _a, _b, _c, _d, _e, _f, _g, _h, _j;
1499
+ const { after } = request;
1500
+ const _queryParams = {
1501
+ after,
1502
+ };
1503
+ const _authRequest = yield this._options.authProvider.getAuthRequest();
1504
+ 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);
1505
+ const _response = yield core.fetcher({
1506
+ 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, "fleet/assets/device-recovery-missing"),
1507
+ method: "GET",
1508
+ headers: _headers,
1509
+ queryParameters: Object.assign(Object.assign({}, _queryParams), requestOptions === null || requestOptions === void 0 ? void 0 : requestOptions.queryParams),
1510
+ 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,
1511
+ 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,
1512
+ abortSignal: requestOptions === null || requestOptions === void 0 ? void 0 : requestOptions.abortSignal,
1513
+ fetchFn: (_j = this._options) === null || _j === void 0 ? void 0 : _j.fetch,
1514
+ logging: this._options.logging,
1515
+ });
1516
+ if (_response.ok) {
1517
+ return {
1518
+ data: _response.body,
1519
+ rawResponse: _response.rawResponse,
1520
+ };
1521
+ }
1522
+ if (_response.error.reason === "status-code") {
1523
+ switch (_response.error.statusCode) {
1524
+ case 401:
1525
+ throw new Samsara.UnauthorizedError(_response.error.body, _response.rawResponse);
1526
+ case 404:
1527
+ throw new Samsara.NotFoundError(_response.error.body, _response.rawResponse);
1528
+ case 405:
1529
+ throw new Samsara.MethodNotAllowedError(_response.error.body, _response.rawResponse);
1530
+ case 429:
1531
+ throw new Samsara.TooManyRequestsError(_response.error.body, _response.rawResponse);
1532
+ case 500:
1533
+ throw new Samsara.InternalServerError(_response.error.body, _response.rawResponse);
1534
+ case 501:
1535
+ throw new Samsara.NotImplementedError(_response.error.body, _response.rawResponse);
1536
+ case 502:
1537
+ throw new Samsara.BadGatewayError(_response.error.body, _response.rawResponse);
1538
+ case 503:
1539
+ throw new Samsara.ServiceUnavailableError(_response.error.body, _response.rawResponse);
1540
+ case 504:
1541
+ throw new Samsara.GatewayTimeoutError(_response.error.body, _response.rawResponse);
1542
+ default:
1543
+ throw new errors.SamsaraError({
1544
+ statusCode: _response.error.statusCode,
1545
+ body: _response.error.body,
1546
+ rawResponse: _response.rawResponse,
1547
+ });
1548
+ }
1549
+ }
1550
+ return handleNonStatusCodeError(_response.error, _response.rawResponse, "GET", "/fleet/assets/device-recovery-missing");
1551
+ });
1552
+ }
1553
+ /**
1554
+ * Mark an asset as missing. Optionally specify a note and notification recipients who will receive email updates.
1555
+ *
1556
+ * <b>Rate limit:</b> 100 requests/min (learn more about rate limits <a href="https://developers.samsara.com/docs/rate-limits" target="_blank">here</a>).
1557
+ *
1558
+ * To use this endpoint, select **Write Assets** under the Assets 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>
1559
+ *
1560
+ *
1561
+ * **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.
1562
+ *
1563
+ * @param {Samsara.DeviceRecoveryMarkAssetMissingRequestBody} request
1564
+ * @param {BetaApIsClient.RequestOptions} requestOptions - Request-specific configuration.
1565
+ *
1566
+ * @throws {@link Samsara.UnauthorizedError}
1567
+ * @throws {@link Samsara.NotFoundError}
1568
+ * @throws {@link Samsara.MethodNotAllowedError}
1569
+ * @throws {@link Samsara.TooManyRequestsError}
1570
+ * @throws {@link Samsara.InternalServerError}
1571
+ * @throws {@link Samsara.NotImplementedError}
1572
+ * @throws {@link Samsara.BadGatewayError}
1573
+ * @throws {@link Samsara.ServiceUnavailableError}
1574
+ * @throws {@link Samsara.GatewayTimeoutError}
1575
+ *
1576
+ * @example
1577
+ * await client.betaApIs.markAssetMissing({
1578
+ * id: "id"
1579
+ * })
1580
+ */
1581
+ markAssetMissing(request, requestOptions) {
1582
+ return core.HttpResponsePromise.fromPromise(this.__markAssetMissing(request, requestOptions));
1583
+ }
1584
+ __markAssetMissing(request, requestOptions) {
1585
+ return __awaiter(this, void 0, void 0, function* () {
1586
+ var _a, _b, _c, _d, _e, _f, _g, _h, _j;
1587
+ const { id } = request, _body = __rest(request, ["id"]);
1588
+ const _authRequest = yield this._options.authProvider.getAuthRequest();
1589
+ 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);
1590
+ const _response = yield core.fetcher({
1591
+ 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, `fleet/assets/device-recovery/${core.url.encodePathParam(id)}/missing`),
1592
+ method: "POST",
1593
+ headers: _headers,
1594
+ contentType: "application/json",
1595
+ queryParameters: requestOptions === null || requestOptions === void 0 ? void 0 : requestOptions.queryParams,
1596
+ requestType: "json",
1597
+ body: _body,
1598
+ 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,
1599
+ 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,
1600
+ abortSignal: requestOptions === null || requestOptions === void 0 ? void 0 : requestOptions.abortSignal,
1601
+ fetchFn: (_j = this._options) === null || _j === void 0 ? void 0 : _j.fetch,
1602
+ logging: this._options.logging,
1603
+ });
1604
+ if (_response.ok) {
1605
+ return {
1606
+ data: _response.body,
1607
+ rawResponse: _response.rawResponse,
1608
+ };
1609
+ }
1610
+ if (_response.error.reason === "status-code") {
1611
+ switch (_response.error.statusCode) {
1612
+ case 401:
1613
+ throw new Samsara.UnauthorizedError(_response.error.body, _response.rawResponse);
1614
+ case 404:
1615
+ throw new Samsara.NotFoundError(_response.error.body, _response.rawResponse);
1616
+ case 405:
1617
+ throw new Samsara.MethodNotAllowedError(_response.error.body, _response.rawResponse);
1618
+ case 429:
1619
+ throw new Samsara.TooManyRequestsError(_response.error.body, _response.rawResponse);
1620
+ case 500:
1621
+ throw new Samsara.InternalServerError(_response.error.body, _response.rawResponse);
1622
+ case 501:
1623
+ throw new Samsara.NotImplementedError(_response.error.body, _response.rawResponse);
1624
+ case 502:
1625
+ throw new Samsara.BadGatewayError(_response.error.body, _response.rawResponse);
1626
+ case 503:
1627
+ throw new Samsara.ServiceUnavailableError(_response.error.body, _response.rawResponse);
1628
+ case 504:
1629
+ throw new Samsara.GatewayTimeoutError(_response.error.body, _response.rawResponse);
1630
+ default:
1631
+ throw new errors.SamsaraError({
1632
+ statusCode: _response.error.statusCode,
1633
+ body: _response.error.body,
1634
+ rawResponse: _response.rawResponse,
1635
+ });
1636
+ }
1637
+ }
1638
+ return handleNonStatusCodeError(_response.error, _response.rawResponse, "POST", "/fleet/assets/device-recovery/{id}/missing");
1639
+ });
1640
+ }
1641
+ /**
1642
+ * Mark a missing asset as recovered. Provide the recovery status, reason for being missing, and optional additional details.
1643
+ *
1644
+ * <b>Rate limit:</b> 100 requests/min (learn more about rate limits <a href="https://developers.samsara.com/docs/rate-limits" target="_blank">here</a>).
1645
+ *
1646
+ * To use this endpoint, select **Write Assets** under the Assets 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>
1647
+ *
1648
+ *
1649
+ * **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.
1650
+ *
1651
+ * @param {Samsara.DeviceRecoveryRecoverAssetRequestBody} request
1652
+ * @param {BetaApIsClient.RequestOptions} requestOptions - Request-specific configuration.
1653
+ *
1654
+ * @throws {@link Samsara.UnauthorizedError}
1655
+ * @throws {@link Samsara.NotFoundError}
1656
+ * @throws {@link Samsara.MethodNotAllowedError}
1657
+ * @throws {@link Samsara.TooManyRequestsError}
1658
+ * @throws {@link Samsara.InternalServerError}
1659
+ * @throws {@link Samsara.NotImplementedError}
1660
+ * @throws {@link Samsara.BadGatewayError}
1661
+ * @throws {@link Samsara.ServiceUnavailableError}
1662
+ * @throws {@link Samsara.GatewayTimeoutError}
1663
+ *
1664
+ * @example
1665
+ * await client.betaApIs.recoverAsset({
1666
+ * id: "id",
1667
+ * missing_reason: "MISPLACED",
1668
+ * recovery_status: "YES",
1669
+ * status: "RECOVERED"
1670
+ * })
1671
+ */
1672
+ recoverAsset(request, requestOptions) {
1673
+ return core.HttpResponsePromise.fromPromise(this.__recoverAsset(request, requestOptions));
1674
+ }
1675
+ __recoverAsset(request, requestOptions) {
1676
+ return __awaiter(this, void 0, void 0, function* () {
1677
+ var _a, _b, _c, _d, _e, _f, _g, _h, _j;
1678
+ const { id } = request, _body = __rest(request, ["id"]);
1679
+ const _authRequest = yield this._options.authProvider.getAuthRequest();
1680
+ 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);
1681
+ const _response = yield core.fetcher({
1682
+ 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, `fleet/assets/device-recovery/${core.url.encodePathParam(id)}/recovered`),
1683
+ method: "POST",
1684
+ headers: _headers,
1685
+ contentType: "application/json",
1686
+ queryParameters: requestOptions === null || requestOptions === void 0 ? void 0 : requestOptions.queryParams,
1687
+ requestType: "json",
1688
+ body: _body,
1689
+ 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,
1690
+ 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,
1691
+ abortSignal: requestOptions === null || requestOptions === void 0 ? void 0 : requestOptions.abortSignal,
1692
+ fetchFn: (_j = this._options) === null || _j === void 0 ? void 0 : _j.fetch,
1693
+ logging: this._options.logging,
1694
+ });
1695
+ if (_response.ok) {
1696
+ return {
1697
+ data: _response.body,
1698
+ rawResponse: _response.rawResponse,
1699
+ };
1700
+ }
1701
+ if (_response.error.reason === "status-code") {
1702
+ switch (_response.error.statusCode) {
1703
+ case 401:
1704
+ throw new Samsara.UnauthorizedError(_response.error.body, _response.rawResponse);
1705
+ case 404:
1706
+ throw new Samsara.NotFoundError(_response.error.body, _response.rawResponse);
1707
+ case 405:
1708
+ throw new Samsara.MethodNotAllowedError(_response.error.body, _response.rawResponse);
1709
+ case 429:
1710
+ throw new Samsara.TooManyRequestsError(_response.error.body, _response.rawResponse);
1711
+ case 500:
1712
+ throw new Samsara.InternalServerError(_response.error.body, _response.rawResponse);
1713
+ case 501:
1714
+ throw new Samsara.NotImplementedError(_response.error.body, _response.rawResponse);
1715
+ case 502:
1716
+ throw new Samsara.BadGatewayError(_response.error.body, _response.rawResponse);
1717
+ case 503:
1718
+ throw new Samsara.ServiceUnavailableError(_response.error.body, _response.rawResponse);
1719
+ case 504:
1720
+ throw new Samsara.GatewayTimeoutError(_response.error.body, _response.rawResponse);
1721
+ default:
1722
+ throw new errors.SamsaraError({
1723
+ statusCode: _response.error.statusCode,
1724
+ body: _response.error.body,
1725
+ rawResponse: _response.rawResponse,
1726
+ });
1727
+ }
1728
+ }
1729
+ return handleNonStatusCodeError(_response.error, _response.rawResponse, "POST", "/fleet/assets/device-recovery/{id}/recovered");
1730
+ });
1731
+ }
1467
1732
  /**
1468
1733
  * Returns a paginated list of vehicles enrolled in the CARB CTC program with their latest compliance status. Results can be filtered by tag IDs and test status.
1469
1734
  *
@@ -3,7 +3,7 @@
3
3
  * {}
4
4
  */
5
5
  export interface ListMaintenanceVendorsRequest {
6
- /** A comma-separated list of up to 100 vendor IDs to filter on. Accepts Samsara UUIDs or external IDs in key:value format. The default external ID key is samsara.vendorId (e.g. samsara.vendorId:V-12345). See [external IDs](https://developers.samsara.com/docs/external-ids). */
6
+ /** A comma-separated list of up to 100 vendor IDs to filter on. Accepts Samsara UUIDs or external IDs in key:value format. See [external IDs](https://developers.samsara.com/docs/external-ids). */
7
7
  ids?: string | string[];
8
8
  /** When true, include externalIds on each vendor in the response. Default false. */
9
9
  includeExternalIds?: boolean;
@@ -2,6 +2,8 @@ export type { DeleteJobRequest } from "./DeleteJobRequest.mjs";
2
2
  export type { DeleteRidershipAccountRequest } from "./DeleteRidershipAccountRequest.mjs";
3
3
  export type { DeleteRidershipPassengerRequest } from "./DeleteRidershipPassengerRequest.mjs";
4
4
  export type { DeleteRidershipRouteSetupRequest } from "./DeleteRidershipRouteSetupRequest.mjs";
5
+ export type { DeviceRecoveryMarkAssetMissingRequestBody } from "./DeviceRecoveryMarkAssetMissingRequestBody.mjs";
6
+ export { DeviceRecoveryRecoverAssetRequestBody } from "./DeviceRecoveryRecoverAssetRequestBody.mjs";
5
7
  export type { EngineImmobilizerUpdateEngineImmobilizerStateRequestBody } from "./EngineImmobilizerUpdateEngineImmobilizerStateRequestBody.mjs";
6
8
  export type { EquipmentPatchEquipmentRequestBody } from "./EquipmentPatchEquipmentRequestBody.mjs";
7
9
  export type { FunctionsStartFunctionRunRequestBody } from "./FunctionsStartFunctionRunRequestBody.mjs";
@@ -40,6 +42,7 @@ export type { JobsCreateJobRequestBody } from "./JobsCreateJobRequestBody.mjs";
40
42
  export type { JobsPatchJobRequestBody } from "./JobsPatchJobRequestBody.mjs";
41
43
  export type { ListCarbCtcVehicleHistoryRequest } from "./ListCarbCtcVehicleHistoryRequest.mjs";
42
44
  export type { ListCarbCtcVehiclesRequest } from "./ListCarbCtcVehiclesRequest.mjs";
45
+ export type { ListDeviceRecoveryMissingAssetsRequest } from "./ListDeviceRecoveryMissingAssetsRequest.mjs";
43
46
  export type { ListHubCustomPropertiesRequest } from "./ListHubCustomPropertiesRequest.mjs";
44
47
  export type { ListMaintenanceVendorsRequest } from "./ListMaintenanceVendorsRequest.mjs";
45
48
  export type { ListReadingsDefinitionsRequest } from "./ListReadingsDefinitionsRequest.mjs";
@@ -1,2 +1,3 @@
1
+ export { DeviceRecoveryRecoverAssetRequestBody } from "./DeviceRecoveryRecoverAssetRequestBody.mjs";
1
2
  export { RidershipPassengersCreateRidershipPassengerRequestBody } from "./RidershipPassengersCreateRidershipPassengerRequestBody.mjs";
2
3
  export { RidershipPassengersUpdateRidershipPassengerRequestBody } from "./RidershipPassengersUpdateRidershipPassengerRequestBody.mjs";
@@ -10,115 +10,6 @@ export declare namespace PreviewApIsClient {
10
10
  export declare class PreviewApIsClient {
11
11
  protected readonly _options: NormalizedClientOptionsWithAuth<PreviewApIsClient.Options>;
12
12
  constructor(options?: PreviewApIsClient.Options);
13
- /**
14
- * List all assets that are currently marked as missing for the organization.
15
- *
16
- * <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>).
17
- *
18
- * To use this endpoint, select **Read Assets** under the Assets 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>
19
- *
20
- * Endpoints in this section are in Preview. These APIs are not functional and are instead for soliciting feedback from our API users on the intended design of this API. Additionally, it is not guaranteed that we will be releasing an endpoint included in this section to production. This means that developers should **NOT** rely on these APIs to build business critical applications
21
- *
22
- * - Samsara may change the structure of a preview API's interface without versioning or any notice to API users.
23
- *
24
- * - When an endpoint becomes generally available, it will be announced in the API [changelog](https://developers.samsara.com/changelog).
25
- *
26
- *
27
- * **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.
28
- *
29
- * @param {Samsara.ListDeviceRecoveryMissingAssetsRequest} request
30
- * @param {PreviewApIsClient.RequestOptions} requestOptions - Request-specific configuration.
31
- *
32
- * @throws {@link Samsara.UnauthorizedError}
33
- * @throws {@link Samsara.NotFoundError}
34
- * @throws {@link Samsara.MethodNotAllowedError}
35
- * @throws {@link Samsara.TooManyRequestsError}
36
- * @throws {@link Samsara.InternalServerError}
37
- * @throws {@link Samsara.NotImplementedError}
38
- * @throws {@link Samsara.BadGatewayError}
39
- * @throws {@link Samsara.ServiceUnavailableError}
40
- * @throws {@link Samsara.GatewayTimeoutError}
41
- *
42
- * @example
43
- * await client.previewApIs.listDeviceRecoveryMissingAssets()
44
- */
45
- listDeviceRecoveryMissingAssets(request?: Samsara.ListDeviceRecoveryMissingAssetsRequest, requestOptions?: PreviewApIsClient.RequestOptions): core.HttpResponsePromise<Samsara.DeviceRecoveryListDeviceRecoveryMissingAssetsResponseBody>;
46
- private __listDeviceRecoveryMissingAssets;
47
- /**
48
- * Mark an asset as missing. Optionally specify a note and notification recipients who will receive email updates.
49
- *
50
- * <b>Rate limit:</b> 100 requests/min (learn more about rate limits <a href="https://developers.samsara.com/docs/rate-limits" target="_blank">here</a>).
51
- *
52
- * To use this endpoint, select **Write Assets** under the Assets 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>
53
- *
54
- * Endpoints in this section are in Preview. These APIs are not functional and are instead for soliciting feedback from our API users on the intended design of this API. Additionally, it is not guaranteed that we will be releasing an endpoint included in this section to production. This means that developers should **NOT** rely on these APIs to build business critical applications
55
- *
56
- * - Samsara may change the structure of a preview API's interface without versioning or any notice to API users.
57
- *
58
- * - When an endpoint becomes generally available, it will be announced in the API [changelog](https://developers.samsara.com/changelog).
59
- *
60
- *
61
- * **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.
62
- *
63
- * @param {Samsara.DeviceRecoveryMarkAssetMissingRequestBody} request
64
- * @param {PreviewApIsClient.RequestOptions} requestOptions - Request-specific configuration.
65
- *
66
- * @throws {@link Samsara.UnauthorizedError}
67
- * @throws {@link Samsara.NotFoundError}
68
- * @throws {@link Samsara.MethodNotAllowedError}
69
- * @throws {@link Samsara.TooManyRequestsError}
70
- * @throws {@link Samsara.InternalServerError}
71
- * @throws {@link Samsara.NotImplementedError}
72
- * @throws {@link Samsara.BadGatewayError}
73
- * @throws {@link Samsara.ServiceUnavailableError}
74
- * @throws {@link Samsara.GatewayTimeoutError}
75
- *
76
- * @example
77
- * await client.previewApIs.markAssetMissing({
78
- * id: "id"
79
- * })
80
- */
81
- markAssetMissing(request: Samsara.DeviceRecoveryMarkAssetMissingRequestBody, requestOptions?: PreviewApIsClient.RequestOptions): core.HttpResponsePromise<Samsara.DeviceRecoveryMarkAssetMissingResponseBody>;
82
- private __markAssetMissing;
83
- /**
84
- * Mark a missing asset as recovered. Provide the recovery status, reason for being missing, and optional additional details.
85
- *
86
- * <b>Rate limit:</b> 100 requests/min (learn more about rate limits <a href="https://developers.samsara.com/docs/rate-limits" target="_blank">here</a>).
87
- *
88
- * To use this endpoint, select **Write Assets** under the Assets 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>
89
- *
90
- * Endpoints in this section are in Preview. These APIs are not functional and are instead for soliciting feedback from our API users on the intended design of this API. Additionally, it is not guaranteed that we will be releasing an endpoint included in this section to production. This means that developers should **NOT** rely on these APIs to build business critical applications
91
- *
92
- * - Samsara may change the structure of a preview API's interface without versioning or any notice to API users.
93
- *
94
- * - When an endpoint becomes generally available, it will be announced in the API [changelog](https://developers.samsara.com/changelog).
95
- *
96
- *
97
- * **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.
98
- *
99
- * @param {Samsara.DeviceRecoveryRecoverAssetRequestBody} request
100
- * @param {PreviewApIsClient.RequestOptions} requestOptions - Request-specific configuration.
101
- *
102
- * @throws {@link Samsara.UnauthorizedError}
103
- * @throws {@link Samsara.NotFoundError}
104
- * @throws {@link Samsara.MethodNotAllowedError}
105
- * @throws {@link Samsara.TooManyRequestsError}
106
- * @throws {@link Samsara.InternalServerError}
107
- * @throws {@link Samsara.NotImplementedError}
108
- * @throws {@link Samsara.BadGatewayError}
109
- * @throws {@link Samsara.ServiceUnavailableError}
110
- * @throws {@link Samsara.GatewayTimeoutError}
111
- *
112
- * @example
113
- * await client.previewApIs.recoverAsset({
114
- * id: "id",
115
- * missing_reason: "MISPLACED",
116
- * recovery_status: "YES",
117
- * status: "RECOVERED"
118
- * })
119
- */
120
- recoverAsset(request: Samsara.DeviceRecoveryRecoverAssetRequestBody, requestOptions?: PreviewApIsClient.RequestOptions): core.HttpResponsePromise<Samsara.DeviceRecoveryRecoverAssetResponseBody>;
121
- private __recoverAsset;
122
13
  /**
123
14
  * Creates a short-lived auth token for a driver.
124
15
  *