/** * This file was auto-generated by Fern from our API Definition. */ import * as environments from "../../../../environments"; import * as core from "../../../../core"; import * as Flatfile from "../../../index"; export declare namespace Analysis { interface Options { environment?: core.Supplier; /** Specify a custom URL to connect the client to. */ baseUrl?: core.Supplier; token?: core.Supplier; /** Override the X-Disable-Hooks header */ xDisableHooks?: "true"; fetcher?: core.FetchFunction; } interface RequestOptions { /** The maximum time to wait for a response in seconds. */ timeoutInSeconds?: number; /** The number of times to retry the request. Defaults to 2. */ maxRetries?: number; /** A hook to abort the request. */ abortSignal?: AbortSignal; /** Override the X-Disable-Hooks header */ xDisableHooks?: "true"; /** Additional headers to include in the request. */ headers?: Record; } } export declare class Analysis { protected readonly _options: Analysis.Options; constructor(_options?: Analysis.Options); /** * @param {Flatfile.ListAnalysisRequest} request * @param {Analysis.RequestOptions} requestOptions - Request-specific configuration. * * @example * await client.analysis.list({ * sheetId: "sheetId" * }) */ list(request: Flatfile.ListAnalysisRequest, requestOptions?: Analysis.RequestOptions): core.HttpResponsePromise; private __list; /** * @param {Flatfile.CreateAnalysisRequest} request * @param {Analysis.RequestOptions} requestOptions - Request-specific configuration. * * @example * await client.analysis.create({ * sheetId: "sheetId", * environmentId: "environmentId", * spaceId: "spaceId", * workbookId: "workbookId", * analyses: [{ * field: "field", * result: { * "key": "value" * } * }, { * field: "field", * result: { * "key": "value" * } * }] * }) */ create(request: Flatfile.CreateAnalysisRequest, requestOptions?: Analysis.RequestOptions): core.HttpResponsePromise; private __create; /** * @param {Flatfile.AnalysisId} analysisId * @param {Flatfile.GetAnalysisRequest} request * @param {Analysis.RequestOptions} requestOptions - Request-specific configuration. * * @example * await client.analysis.get("analysisId", { * sheetId: "sheetId" * }) */ get(analysisId: Flatfile.AnalysisId, request: Flatfile.GetAnalysisRequest, requestOptions?: Analysis.RequestOptions): core.HttpResponsePromise; private __get; /** * @param {Flatfile.AnalysisId} analysisId * @param {Flatfile.DeleteAnalysisRequest} request * @param {Analysis.RequestOptions} requestOptions - Request-specific configuration. * * @example * await client.analysis.delete("analysisId", { * sheetId: "sheetId" * }) */ delete(analysisId: Flatfile.AnalysisId, request: Flatfile.DeleteAnalysisRequest, requestOptions?: Analysis.RequestOptions): core.HttpResponsePromise; private __delete; /** * @param {Flatfile.DeleteAnalysesBySheetRequest} request * @param {Analysis.RequestOptions} requestOptions - Request-specific configuration. * * @example * await client.analysis.deleteBySheet({ * sheetId: "sheetId" * }) */ deleteBySheet(request: Flatfile.DeleteAnalysesBySheetRequest, requestOptions?: Analysis.RequestOptions): core.HttpResponsePromise; private __deleteBySheet; /** * @param {Flatfile.AnalysisId} analysisId * @param {string} suggestionId * @param {Flatfile.UpdateSuggestionRequest} request * @param {Analysis.RequestOptions} requestOptions - Request-specific configuration. * * @example * await client.analysis.updateSuggestion("analysisId", "suggestionId", { * sheetId: "sheetId", * suggestion: { * "key": "value" * } * }) */ updateSuggestion(analysisId: Flatfile.AnalysisId, suggestionId: string, request: Flatfile.UpdateSuggestionRequest, requestOptions?: Analysis.RequestOptions): core.HttpResponsePromise; private __updateSuggestion; /** * @param {Flatfile.AnalysisId} analysisId * @param {string} suggestionId * @param {Flatfile.DeleteSuggestionRequest} request * @param {Analysis.RequestOptions} requestOptions - Request-specific configuration. * * @example * await client.analysis.deleteSuggestion("analysisId", "suggestionId", { * sheetId: "sheetId" * }) */ deleteSuggestion(analysisId: Flatfile.AnalysisId, suggestionId: string, request: Flatfile.DeleteSuggestionRequest, requestOptions?: Analysis.RequestOptions): core.HttpResponsePromise; private __deleteSuggestion; protected _getAuthorizationHeader(): Promise; }