import type { BaseClientOptions, BaseRequestOptions } from "../../../../BaseClient.js"; import { type NormalizedClientOptionsWithAuth } from "../../../../BaseClient.js"; import * as core from "../../../../core/index.js"; import * as Samsara from "../../../index.js"; export declare namespace HubsClient { type Options = BaseClientOptions; interface RequestOptions extends BaseRequestOptions { } } export declare class HubsClient { protected readonly _options: NormalizedClientOptionsWithAuth; constructor(options?: HubsClient.Options); /** * Retrieve capacity types for a specific hub. * * Rate limit: 10 requests/sec (learn more about rate limits here). * * To use this endpoint, select **Read Routes** under the Driver Workflow category when creating or editing an API token. Learn More. * * * **Submit Feedback**: Likes, dislikes, and API feature requests should be filed as feedback in our API feedback form. If you encountered an issue or noticed inaccuracies in the API documentation, please submit a case to our support team. * * @param {Samsara.ListHubCapacitiesRequest} request * @param {HubsClient.RequestOptions} requestOptions - Request-specific configuration. * * @throws {@link Samsara.UnauthorizedError} * @throws {@link Samsara.NotFoundError} * @throws {@link Samsara.MethodNotAllowedError} * @throws {@link Samsara.ContentTooLargeError} * @throws {@link Samsara.TooManyRequestsError} * @throws {@link Samsara.InternalServerError} * @throws {@link Samsara.NotImplementedError} * @throws {@link Samsara.BadGatewayError} * @throws {@link Samsara.ServiceUnavailableError} * @throws {@link Samsara.GatewayTimeoutError} * * @example * await client.hubs.listHubCapacities({ * hubId: "hubId" * }) */ listHubCapacities(request: Samsara.ListHubCapacitiesRequest, requestOptions?: HubsClient.RequestOptions): core.HttpResponsePromise; private __listHubCapacities; /** * Retrieve custom properties for a specific hub. * * Rate limit: 10 requests/sec (learn more about rate limits here). * * To use this endpoint, select **Read Routes** under the Driver Workflow category when creating or editing an API token. Learn More. * * * **Submit Feedback**: Likes, dislikes, and API feature requests should be filed as feedback in our API feedback form. If you encountered an issue or noticed inaccuracies in the API documentation, please submit a case to our support team. * * @param {Samsara.ListHubCustomPropertiesRequest} request * @param {HubsClient.RequestOptions} requestOptions - Request-specific configuration. * * @throws {@link Samsara.UnauthorizedError} * @throws {@link Samsara.NotFoundError} * @throws {@link Samsara.MethodNotAllowedError} * @throws {@link Samsara.ContentTooLargeError} * @throws {@link Samsara.TooManyRequestsError} * @throws {@link Samsara.InternalServerError} * @throws {@link Samsara.NotImplementedError} * @throws {@link Samsara.BadGatewayError} * @throws {@link Samsara.ServiceUnavailableError} * @throws {@link Samsara.GatewayTimeoutError} * * @example * await client.hubs.listHubCustomProperties({ * hubId: "hubId" * }) */ listHubCustomProperties(request: Samsara.ListHubCustomPropertiesRequest, requestOptions?: HubsClient.RequestOptions): core.HttpResponsePromise; private __listHubCustomProperties; /** * Update existing location by ID. * * Rate limit: 100 requests/min (learn more about rate limits here). * * To use this endpoint, select **Write Routes** under the Driver Workflow category when creating or editing an API token. Learn More. * * * **Submit Feedback**: Likes, dislikes, and API feature requests should be filed as feedback in our API feedback form. If you encountered an issue or noticed inaccuracies in the API documentation, please submit a case to our support team. * * @param {Samsara.HubLocationsUpdateHubLocationRequestBody} request * @param {HubsClient.RequestOptions} requestOptions - Request-specific configuration. * * @throws {@link Samsara.UnauthorizedError} * @throws {@link Samsara.NotFoundError} * @throws {@link Samsara.MethodNotAllowedError} * @throws {@link Samsara.ContentTooLargeError} * @throws {@link Samsara.TooManyRequestsError} * @throws {@link Samsara.InternalServerError} * @throws {@link Samsara.NotImplementedError} * @throws {@link Samsara.BadGatewayError} * @throws {@link Samsara.ServiceUnavailableError} * @throws {@link Samsara.GatewayTimeoutError} * * @example * await client.hubs.updateHubLocation({ * id: "id", * data: { * address: "123 Industrial Blvd, Los Angeles, CA 90210, US", * customerLocationId: "LOC-123", * driverInstructions: "sample instructions", * isDepot: false, * latitude: 34.0522, * longitude: -118.2437, * name: "Customer ABC Warehouse", * plannerNotes: "sample note", * serviceTimeSeconds: 1800, * serviceWindows: [{ * daysOfWeek: ["monday", "tuesday", "wednesday", "thursday", "friday"], * endTime: "17:00:00", * startTime: "08:00:00" * }], * skillsRequired: ["650e8400-e29b-41d4-a716-446655440001"] * } * }) */ updateHubLocation(request: Samsara.HubLocationsUpdateHubLocationRequestBody, requestOptions?: HubsClient.RequestOptions): core.HttpResponsePromise; private __updateHubLocation; /** * Retrieve locations for a specific hub. * * Rate limit: 10 requests/sec (learn more about rate limits here). * * To use this endpoint, select **Read Routes** under the Driver Workflow category when creating or editing an API token. Learn More. * * * **Submit Feedback**: Likes, dislikes, and API feature requests should be filed as feedback in our API feedback form. If you encountered an issue or noticed inaccuracies in the API documentation, please submit a case to our support team. * * @param {Samsara.ListHubLocationsRequest} request * @param {HubsClient.RequestOptions} requestOptions - Request-specific configuration. * * @throws {@link Samsara.UnauthorizedError} * @throws {@link Samsara.NotFoundError} * @throws {@link Samsara.MethodNotAllowedError} * @throws {@link Samsara.ContentTooLargeError} * @throws {@link Samsara.TooManyRequestsError} * @throws {@link Samsara.InternalServerError} * @throws {@link Samsara.NotImplementedError} * @throws {@link Samsara.BadGatewayError} * @throws {@link Samsara.ServiceUnavailableError} * @throws {@link Samsara.GatewayTimeoutError} * * @example * await client.hubs.listHubLocations({ * hubId: "hubId" * }) */ listHubLocations(request: Samsara.ListHubLocationsRequest, requestOptions?: HubsClient.RequestOptions): core.HttpResponsePromise; private __listHubLocations; /** * Create new locations. * * Rate limit: 100 requests/min (learn more about rate limits here). * * To use this endpoint, select **Write Routes** under the Driver Workflow category when creating or editing an API token. Learn More. * * * **Submit Feedback**: Likes, dislikes, and API feature requests should be filed as feedback in our API feedback form. If you encountered an issue or noticed inaccuracies in the API documentation, please submit a case to our support team. * * @param {Samsara.HubLocationsCreateHubLocationsRequestBody} request * @param {HubsClient.RequestOptions} requestOptions - Request-specific configuration. * * @throws {@link Samsara.UnauthorizedError} * @throws {@link Samsara.NotFoundError} * @throws {@link Samsara.MethodNotAllowedError} * @throws {@link Samsara.ContentTooLargeError} * @throws {@link Samsara.TooManyRequestsError} * @throws {@link Samsara.InternalServerError} * @throws {@link Samsara.NotImplementedError} * @throws {@link Samsara.BadGatewayError} * @throws {@link Samsara.ServiceUnavailableError} * @throws {@link Samsara.GatewayTimeoutError} * * @example * await client.hubs.createHubLocations({ * data: [{ * address: "123 Industrial Blvd, Los Angeles, CA 90210, US", * customerLocationId: "LOC-123", * driverInstructions: "sample instructions", * hubId: "550e8400-e29b-41d4-a716-446655440000", * isDepot: false, * latitude: 34.0522, * longitude: -118.2437, * name: "Customer ABC Warehouse", * plannerNotes: "sample note", * serviceTimeSeconds: 1800, * serviceWindows: [{ * daysOfWeek: ["monday", "tuesday", "wednesday", "thursday", "friday"], * endTime: "17:00:00", * startTime: "08:00:00" * }], * skillsRequired: ["650e8400-e29b-41d4-a716-446655440001"] * }] * }) */ createHubLocations(request: Samsara.HubLocationsCreateHubLocationsRequestBody, requestOptions?: HubsClient.RequestOptions): core.HttpResponsePromise; private __createHubLocations; /** * Retrieve skills for a specific hub. * * Rate limit: 10 requests/sec (learn more about rate limits here). * * To use this endpoint, select **Read Routes** under the Driver Workflow category when creating or editing an API token. Learn More. * * * **Submit Feedback**: Likes, dislikes, and API feature requests should be filed as feedback in our API feedback form. If you encountered an issue or noticed inaccuracies in the API documentation, please submit a case to our support team. * * @param {Samsara.ListHubSkillsRequest} request * @param {HubsClient.RequestOptions} requestOptions - Request-specific configuration. * * @throws {@link Samsara.UnauthorizedError} * @throws {@link Samsara.NotFoundError} * @throws {@link Samsara.MethodNotAllowedError} * @throws {@link Samsara.ContentTooLargeError} * @throws {@link Samsara.TooManyRequestsError} * @throws {@link Samsara.InternalServerError} * @throws {@link Samsara.NotImplementedError} * @throws {@link Samsara.BadGatewayError} * @throws {@link Samsara.ServiceUnavailableError} * @throws {@link Samsara.GatewayTimeoutError} * * @example * await client.hubs.listHubSkills({ * hubId: "hubId" * }) */ listHubSkills(request: Samsara.ListHubSkillsRequest, requestOptions?: HubsClient.RequestOptions): core.HttpResponsePromise; private __listHubSkills; /** * Retrieve all hubs (planners) in the organization. This endpoint supports pagination and filtering based on hub IDs and update times. * * Rate limit: 10 requests/sec (learn more about rate limits here). * * To use this endpoint, select **Read Routes** under the Driver Workflow category when creating or editing an API token. Learn More. * * * **Submit Feedback**: Likes, dislikes, and API feature requests should be filed as feedback in our API feedback form. If you encountered an issue or noticed inaccuracies in the API documentation, please submit a case to our support team. * * @param {Samsara.ListHubsRequest} request * @param {HubsClient.RequestOptions} requestOptions - Request-specific configuration. * * @throws {@link Samsara.UnauthorizedError} * @throws {@link Samsara.NotFoundError} * @throws {@link Samsara.MethodNotAllowedError} * @throws {@link Samsara.ContentTooLargeError} * @throws {@link Samsara.TooManyRequestsError} * @throws {@link Samsara.InternalServerError} * @throws {@link Samsara.NotImplementedError} * @throws {@link Samsara.BadGatewayError} * @throws {@link Samsara.ServiceUnavailableError} * @throws {@link Samsara.GatewayTimeoutError} * * @example * await client.hubs.listHubs() */ listHubs(request?: Samsara.ListHubsRequest, requestOptions?: HubsClient.RequestOptions): core.HttpResponsePromise; private __listHubs; }