/** * 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 StyleGuides { 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; } } /** * Endpoints related to creating, updating, and organizing style guides for content consistency across teams. */ export declare class StyleGuides { protected readonly _options: StyleGuides.Options; constructor(_options: StyleGuides.Options); /** * Retrieve all style guides associated with your organization. * * @param {StyleGuides.RequestOptions} requestOptions - Request-specific configuration. * * @throws {@link acrolinx.UnprocessableEntityError} * @throws {@link acrolinx.InternalServerError} * * @example * await client.styleGuides.listStyleGuides() */ listStyleGuides(requestOptions?: StyleGuides.RequestOptions): core.HttpResponsePromise; private __listStyleGuides; /** * Create a new style guide that can be used in checks, suggestions, and rewrites. * * @param {File | fs.ReadStream | Blob} file_upload * @param {acrolinx.StyleGuideRequestBody} request * @param {StyleGuides.RequestOptions} requestOptions - Request-specific configuration. * * @throws {@link acrolinx.UnprocessableEntityError} * @throws {@link acrolinx.InternalServerError} * * @example * await client.styleGuides.createStyleGuide(fs.createReadStream("/path/to/your/file"), {}) */ createStyleGuide(file_upload: File | fs.ReadStream | Blob, request: acrolinx.StyleGuideRequestBody, requestOptions?: StyleGuides.RequestOptions): core.HttpResponsePromise; private __createStyleGuide; /** * Retrieve a specific style guide by ID, including its metadata such as `name` and `status`. * * @param {string} styleGuideId - The ID of the style guide. * @param {StyleGuides.RequestOptions} requestOptions - Request-specific configuration. * * @throws {@link acrolinx.UnprocessableEntityError} * @throws {@link acrolinx.InternalServerError} * * @example * await client.styleGuides.getStyleGuide("style_guide_id") */ getStyleGuide(styleGuideId: string, requestOptions?: StyleGuides.RequestOptions): core.HttpResponsePromise; private __getStyleGuide; /** * Delete a style guide by ID. * * @param {string} styleGuideId - The ID of the style guide. * @param {StyleGuides.RequestOptions} requestOptions - Request-specific configuration. * * @throws {@link acrolinx.UnprocessableEntityError} * @throws {@link acrolinx.InternalServerError} * * @example * await client.styleGuides.deleteStyleGuide("style_guide_id") */ deleteStyleGuide(styleGuideId: string, requestOptions?: StyleGuides.RequestOptions): core.HttpResponsePromise; private __deleteStyleGuide; /** * Update the name of an existing style guide. * * @param {string} styleGuideId - The ID of the style guide. * @param {acrolinx.BodyStyleGuidesUpdateStyleGuide} request * @param {StyleGuides.RequestOptions} requestOptions - Request-specific configuration. * * @throws {@link acrolinx.ForbiddenError} * @throws {@link acrolinx.UnprocessableEntityError} * @throws {@link acrolinx.InternalServerError} * * @example * await client.styleGuides.updateStyleGuide("style_guide_id", { * name: "name" * }) */ updateStyleGuide(styleGuideId: string, request: acrolinx.BodyStyleGuidesUpdateStyleGuide, requestOptions?: StyleGuides.RequestOptions): core.HttpResponsePromise; private __updateStyleGuide; protected _getAuthorizationHeader(): Promise; }