/** * This file was auto-generated by Fern from our API Definition. */ import * as environments from "../../../../environments"; import * as core from "../../../../core"; import * as acrolinx from "../../../index"; import * as fs from "fs"; import { Blob } from "buffer"; export declare namespace StyleChecks { interface Options { environment?: core.Supplier; /** Specify a custom URL to connect the client to. */ baseUrl?: core.Supplier; token: core.Supplier; 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; /** Additional headers to include in the request. */ headers?: Record; } } /** * Analyze your content to spot issues that go against your style guide or brand voice. Use this to catch tone, grammar, or readability problems before publishing. */ export declare class StyleChecks { protected readonly _options: StyleChecks.Options; constructor(_options: StyleChecks.Options); /** * Start a style and brand check workflow. Returns a workflow ID to use for polling results. * * @param {File | fs.ReadStream | Blob} file_upload * @param {acrolinx.StyleChecksCreateStyleCheckRequest} request * @param {StyleChecks.RequestOptions} requestOptions - Request-specific configuration. * * @throws {@link acrolinx.ContentTooLargeError} * @throws {@link acrolinx.UnprocessableEntityError} * @throws {@link acrolinx.InternalServerError} * * @example * await client.styleChecks.createStyleCheck(fs.createReadStream("/path/to/your/file"), { * dialect: "american_english", * tone: "academic", * style_guide: "style_guide" * }) */ createStyleCheck(file_upload: File | fs.ReadStream | Blob, request: acrolinx.StyleChecksCreateStyleCheckRequest, requestOptions?: StyleChecks.RequestOptions): core.HttpResponsePromise; private __createStyleCheck; /** * Retrieve the results of a style and brand check workflow. Returns `running` or `complete` status. * * @param {string} workflowId * @param {StyleChecks.RequestOptions} requestOptions - Request-specific configuration. * * @throws {@link acrolinx.NotFoundError} * @throws {@link acrolinx.UnprocessableEntityError} * @throws {@link acrolinx.InternalServerError} * * @example * await client.styleChecks.getStyleCheck("workflow_id") */ getStyleCheck(workflowId: string, requestOptions?: StyleChecks.RequestOptions): core.HttpResponsePromise; private __getStyleCheck; protected _getAuthorizationHeader(): Promise; }