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 FormsClient { type Options = BaseClientOptions; interface RequestOptions extends BaseRequestOptions { } } export declare class FormsClient { protected readonly _options: NormalizedClientOptionsWithAuth; constructor(options?: FormsClient.Options); /** * Returns all form submissions data for the specified list of IDs. * * Rate limit: 5 requests/sec (learn more about rate limits here). * * To use this endpoint, select **Read Form Submissions** under the Forms 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.GetFormSubmissionsRequest} request * @param {FormsClient.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.forms.getFormSubmissions() */ getFormSubmissions(request?: Samsara.GetFormSubmissionsRequest, requestOptions?: FormsClient.RequestOptions): core.HttpResponsePromise; private __getFormSubmissions; /** * Creates a form submission and assigns it to an individual worker. This endpoint can be used to create an empty or partially complete form submission and assign it to a worker. * * Rate limit: 100 requests/min (learn more about rate limits here). * * To use this endpoint, select **Write Form Submissions** under the Forms 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.FormSubmissionsPostFormSubmissionRequestBody} request * @param {FormsClient.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.forms.postFormSubmission({ * formTemplate: { * id: "9814a1fa-f0c6-408b-bf85-51dc3bc71ac7", * revisionId: "1214a1fa-f0c6-408b-bf85-51dc3bc71ac7" * }, * status: "notStarted" * }) */ postFormSubmission(request: Samsara.FormSubmissionsPostFormSubmissionRequestBody, requestOptions?: FormsClient.RequestOptions): core.HttpResponsePromise; private __postFormSubmission; /** * Updates an instance of a form submission. * * Rate limit: 100 requests/min (learn more about rate limits here). * * To use this endpoint, select **Write Form Submissions** under the Forms 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.FormSubmissionsPatchFormSubmissionRequestBody} request * @param {FormsClient.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.forms.patchFormSubmission({ * id: "9814a1fa-f0c6-408b-bf85-51dc3bc71ac8", * status: "notStarted" * }) */ patchFormSubmission(request: Samsara.FormSubmissionsPatchFormSubmissionRequestBody, requestOptions?: FormsClient.RequestOptions): core.HttpResponsePromise; private __patchFormSubmission; /** * Returns a PDF export that has already been generated for a form submission. * * Rate limit: 100 requests/min (learn more about rate limits here). * * To use this endpoint, select **Read Form Submissions** under the Forms 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.GetFormSubmissionsPdfExportsRequest} request * @param {FormsClient.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.forms.getFormSubmissionsPdfExports({ * pdfId: "pdfId" * }) */ getFormSubmissionsPdfExports(request: Samsara.GetFormSubmissionsPdfExportsRequest, requestOptions?: FormsClient.RequestOptions): core.HttpResponsePromise; private __getFormSubmissionsPdfExports; /** * Creates a PDF export for an existing form submission. * * Rate limit: 100 requests/min (learn more about rate limits here). * * To use this endpoint, select **Write Form Submissions** under the Forms 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.PostFormSubmissionsPdfExportsRequest} request * @param {FormsClient.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.forms.postFormSubmissionsPdfExports({ * id: "id" * }) */ postFormSubmissionsPdfExports(request: Samsara.PostFormSubmissionsPdfExportsRequest, requestOptions?: FormsClient.RequestOptions): core.HttpResponsePromise; private __postFormSubmissionsPdfExports; /** * Returns all form submissions data that has been created or modified for your organization based on the time parameters passed in. Results are paginated and are sorted by last modified date. If you include an endTime, the endpoint will return data up until that point (exclusive). If you don’t include an endTime, you can continue to poll the API real-time with the pagination cursor that gets returned on every call. * * Rate limit: 5 requests/sec (learn more about rate limits here). * * To use this endpoint, select **Read Form Submissions** under the Forms 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.GetFormSubmissionsStreamRequest} request * @param {FormsClient.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.forms.getFormSubmissionsStream({ * startTime: "startTime" * }) */ getFormSubmissionsStream(request: Samsara.GetFormSubmissionsStreamRequest, requestOptions?: FormsClient.RequestOptions): core.HttpResponsePromise; private __getFormSubmissionsStream; /** * Returns a list of the organization's form templates for the specified list of IDs. If no IDs are provided, all form templates for the organization will be returned. * * Rate limit: 5 requests/sec (learn more about rate limits here). * * To use this endpoint, select **Read Form Submissions** under the Forms 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.GetFormTemplatesRequest} request * @param {FormsClient.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.forms.getFormTemplates() */ getFormTemplates(request?: Samsara.GetFormTemplatesRequest, requestOptions?: FormsClient.RequestOptions): core.HttpResponsePromise; private __getFormTemplates; }