import type { BaseClientOptions, BaseRequestOptions } from "../../../../BaseClient.mjs"; import { type NormalizedClientOptionsWithAuth } from "../../../../BaseClient.mjs"; import * as core from "../../../../core/index.mjs"; import * as Samsara from "../../../index.mjs"; export declare namespace PlansClient { type Options = BaseClientOptions; interface RequestOptions extends BaseRequestOptions { } } export declare class PlansClient { protected readonly _options: NormalizedClientOptionsWithAuth; constructor(options?: PlansClient.Options); /** * Create a new plan. * * Rate limit: 5 requests/sec (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.HubPlansCreateHubPlanRequestBody} request * @param {PlansClient.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.plans.createHubPlan({ * hubId: "550e8400-e29b-41d4-a716-446655440000", * name: "Weekly Plan - Week 15" * }) */ createHubPlan(request: Samsara.HubPlansCreateHubPlanRequestBody, requestOptions?: PlansClient.RequestOptions): core.HttpResponsePromise; private __createHubPlan; /** * Create one or more orders (bulk upsert). Pass an array of order objects; any object whose customerOrderId already exists will be updated, otherwise a new order is created. Functions can return JSON arrays in this Order POST format. Orders are initially created at the plan level but will migrate to hub-level entities, with planId becoming optional in future versions. * * Rate limit: 5 requests/sec (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.PlanOrdersCreatePlanOrdersRequestBody} request * @param {PlansClient.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.plans.createPlanOrders({ * data: [{ * customerOrderId: "ORDER-2024-001", * hubId: "550e8400-e29b-41d4-a716-446655440000", * planId: "650e8400-e29b-41d4-a716-446655440023" * }] * }) */ createPlanOrders(request: Samsara.PlanOrdersCreatePlanOrdersRequestBody, requestOptions?: PlansClient.RequestOptions): core.HttpResponsePromise; private __createPlanOrders; /** * Retrieve all plans 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.ListHubPlansRequest} request * @param {PlansClient.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.plans.listHubPlans({ * hubId: "hubId" * }) */ listHubPlans(request: Samsara.ListHubPlansRequest, requestOptions?: PlansClient.RequestOptions): core.HttpResponsePromise; private __listHubPlans; }