@markupai/api 0.3.0 → 1.1.0

package/README.md

@@ -5,6 +5,23 @@
 
 The official Markup AI SDK for interacting with the Markup AI API.
 
+## Table of Contents
+
+- [Installation](#installation)
+- [Reference](#reference)
+- [Usage](#usage)
+- [Request and Response Types](#request-and-response-types)
+- [Exception Handling](#exception-handling)
+- [Advanced](#advanced)
+    - [Additional Headers](#additional-headers)
+    - [Additional Query String Parameters](#additional-query-string-parameters)
+    - [Retries](#retries)
+    - [Timeouts](#timeouts)
+    - [Aborting Requests](#aborting-requests)
+    - [Access Raw Response Data](#access-raw-response-data)
+    - [Runtime Compatibility](#runtime-compatibility)
+- [Contributing](#contributing)
+
 ## Installation
 
 ```sh
@@ -26,7 +43,7 @@ const client = new MarkupAIClient({ token: "YOUR_TOKEN" });
 await client.styleGuides.listStyleGuides();
 ```
 
-## Request And Response Types
+## Request and Response Types
 
 The SDK exports all request and response types as TypeScript interfaces. Simply import them with the
 following namespace:

package/dist/cjs/Client.js

@@ -48,8 +48,8 @@ class MarkupAIClient {
         this._options = Object.assign(Object.assign({}, _options), { headers: (0, headers_js_1.mergeHeaders)({
                 "X-Fern-Language": "JavaScript",
                 "X-Fern-SDK-Name": "@markupai/api",
-                "X-Fern-SDK-Version": "0.3.0",
-                "User-Agent": "@markupai/api/0.3.0",
+                "X-Fern-SDK-Version": "1.1.0",
+                "User-Agent": "@markupai/api/1.1.0",
                 "X-Fern-Runtime": core.RUNTIME.type,
                 "X-Fern-Runtime-Version": core.RUNTIME.version,
             }, _options === null || _options === void 0 ? void 0 : _options.headers) });

package/dist/cjs/api/errors/TooManyRequestsError.d.ts

@@ -0,0 +1,9 @@
+/**
+ * This file was auto-generated by Fern from our API Definition.
+ */
+import * as errors from "../../errors/index.js";
+import * as MarkupAI from "../index.js";
+import * as core from "../../core/index.js";
+export declare class TooManyRequestsError extends errors.MarkupAIError {
+    constructor(body: MarkupAI.ErrorResponse, rawResponse?: core.RawResponse);
+}

package/dist/cjs/api/errors/TooManyRequestsError.js

@@ -0,0 +1,52 @@
+"use strict";
+/**
+ * This file was auto-generated by Fern from our API Definition.
+ */
+var __createBinding = (this && this.__createBinding) || (Object.create ? (function(o, m, k, k2) {
+    if (k2 === undefined) k2 = k;
+    var desc = Object.getOwnPropertyDescriptor(m, k);
+    if (!desc || ("get" in desc ? !m.__esModule : desc.writable || desc.configurable)) {
+      desc = { enumerable: true, get: function() { return m[k]; } };
+    }
+    Object.defineProperty(o, k2, desc);
+}) : (function(o, m, k, k2) {
+    if (k2 === undefined) k2 = k;
+    o[k2] = m[k];
+}));
+var __setModuleDefault = (this && this.__setModuleDefault) || (Object.create ? (function(o, v) {
+    Object.defineProperty(o, "default", { enumerable: true, value: v });
+}) : function(o, v) {
+    o["default"] = v;
+});
+var __importStar = (this && this.__importStar) || (function () {
+    var ownKeys = function(o) {
+        ownKeys = Object.getOwnPropertyNames || function (o) {
+            var ar = [];
+            for (var k in o) if (Object.prototype.hasOwnProperty.call(o, k)) ar[ar.length] = k;
+            return ar;
+        };
+        return ownKeys(o);
+    };
+    return function (mod) {
+        if (mod && mod.__esModule) return mod;
+        var result = {};
+        if (mod != null) for (var k = ownKeys(mod), i = 0; i < k.length; i++) if (k[i] !== "default") __createBinding(result, mod, k[i]);
+        __setModuleDefault(result, mod);
+        return result;
+    };
+})();
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.TooManyRequestsError = void 0;
+const errors = __importStar(require("../../errors/index.js"));
+class TooManyRequestsError extends errors.MarkupAIError {
+    constructor(body, rawResponse) {
+        super({
+            message: "TooManyRequestsError",
+            statusCode: 429,
+            body: body,
+            rawResponse: rawResponse,
+        });
+        Object.setPrototypeOf(this, TooManyRequestsError.prototype);
+    }
+}
+exports.TooManyRequestsError = TooManyRequestsError;

package/dist/cjs/api/errors/index.d.ts

@@ -4,3 +4,4 @@ export * from "./UnprocessableEntityError.js";
 export * from "./InternalServerError.js";
 export * from "./ContentTooLargeError.js";
 export * from "./NotFoundError.js";
+export * from "./TooManyRequestsError.js";

package/dist/cjs/api/errors/index.js

@@ -20,3 +20,4 @@ __exportStar(require("./UnprocessableEntityError.js"), exports);
 __exportStar(require("./InternalServerError.js"), exports);
 __exportStar(require("./ContentTooLargeError.js"), exports);
 __exportStar(require("./NotFoundError.js"), exports);
+__exportStar(require("./TooManyRequestsError.js"), exports);

package/dist/cjs/api/resources/styleChecks/client/Client.d.ts

@@ -36,13 +36,14 @@ export declare class StyleChecks {
     /**
      * Analyze text for grammar, style, and clarity issues.
      *
-     * @param {MarkupAI.CreateStyleCheckV1StyleChecksPostRequest} request
+     * @param {MarkupAI.StyleCheckRequestBody} request
      * @param {StyleChecks.RequestOptions} requestOptions - Request-specific configuration.
      *
      * @throws {@link MarkupAI.UnauthorizedError}
      * @throws {@link MarkupAI.ForbiddenError}
      * @throws {@link MarkupAI.ContentTooLargeError}
      * @throws {@link MarkupAI.UnprocessableEntityError}
+     * @throws {@link MarkupAI.TooManyRequestsError}
      * @throws {@link MarkupAI.InternalServerError}
      *
      * @example
@@ -53,7 +54,7 @@ export declare class StyleChecks {
      *         style_guide: "style_guide"
      *     })
      */
-    createStyleCheck(request: MarkupAI.CreateStyleCheckV1StyleChecksPostRequest, requestOptions?: StyleChecks.RequestOptions): core.HttpResponsePromise<MarkupAI.WorkflowResponse>;
+    createStyleCheck(request: MarkupAI.StyleCheckRequestBody, requestOptions?: StyleChecks.RequestOptions): core.HttpResponsePromise<MarkupAI.WorkflowResponse>;
     private __createStyleCheck;
     /**
      * Retrieve style check results.

package/dist/cjs/api/resources/styleChecks/client/Client.js

@@ -61,13 +61,14 @@ class StyleChecks {
     /**
      * Analyze text for grammar, style, and clarity issues.
      *
-     * @param {MarkupAI.CreateStyleCheckV1StyleChecksPostRequest} request
+     * @param {MarkupAI.StyleCheckRequestBody} request
      * @param {StyleChecks.RequestOptions} requestOptions - Request-specific configuration.
      *
      * @throws {@link MarkupAI.UnauthorizedError}
      * @throws {@link MarkupAI.ForbiddenError}
      * @throws {@link MarkupAI.ContentTooLargeError}
      * @throws {@link MarkupAI.UnprocessableEntityError}
+     * @throws {@link MarkupAI.TooManyRequestsError}
      * @throws {@link MarkupAI.InternalServerError}
      *
      * @example
@@ -85,7 +86,6 @@ class StyleChecks {
         return __awaiter(this, void 0, void 0, function* () {
             var _a, _b, _c, _d;
             const _request = yield core.newFormData();
-            yield _request.appendFile("file_upload", request.file_upload);
             _request.append("dialect", request.dialect);
             if (request.tone != null) {
                 _request.append("tone", request.tone);
@@ -94,6 +94,7 @@ class StyleChecks {
             if (request.webhook_url != null) {
                 _request.append("webhook_url", request.webhook_url);
             }
+            yield _request.appendFile("file_upload", request.file_upload);
             const _maybeEncodedRequest = yield _request.getRequest();
             let _headers = (0, headers_js_1.mergeHeaders)((_a = this._options) === null || _a === void 0 ? void 0 : _a.headers, (0, headers_js_1.mergeOnlyDefinedHeaders)(Object.assign({ Authorization: yield this._getAuthorizationHeader() }, _maybeEncodedRequest.headers)), requestOptions === null || requestOptions === void 0 ? void 0 : requestOptions.headers);
             const _response = yield ((_b = this._options.fetcher) !== null && _b !== void 0 ? _b : core.fetcher)({
@@ -121,6 +122,8 @@ class StyleChecks {
                         throw new MarkupAI.ContentTooLargeError(_response.error.body, _response.rawResponse);
                     case 422:
                         throw new MarkupAI.UnprocessableEntityError(_response.error.body, _response.rawResponse);
+                    case 429:
+                        throw new MarkupAI.TooManyRequestsError(_response.error.body, _response.rawResponse);
                     case 500:
                         throw new MarkupAI.InternalServerError(_response.error.body, _response.rawResponse);
                     default:

package/dist/cjs/api/resources/{styleSuggestions/client/requests/CreateStyleSuggestionV1StyleSuggestionsPostRequest.d.ts → styleChecks/client/requests/StyleCheckRequestBody.d.ts}

@@ -1,8 +1,8 @@
 /**
  * This file was auto-generated by Fern from our API Definition.
  */
-import * as core from "../../../../../core/index.js";
 import * as MarkupAI from "../../../../index.js";
+import * as core from "../../../../../core/index.js";
 /**
  * @example
  *     {
@@ -11,9 +11,7 @@ import * as MarkupAI from "../../../../index.js";
  *         style_guide: "style_guide"
  *     }
  */
-export interface CreateStyleSuggestionV1StyleSuggestionsPostRequest {
-    /** The document to analyze. Text files (.txt), PDFs (.pdf), and Markdown files (.md) are accepted. The max file size is 1.5 MB */
-    file_upload: core.file.Uploadable.FileLike;
+export interface StyleCheckRequestBody {
     /** The language variant you'd like us to use for analysis. Choose from American English, British English, or other supported dialects. */
     dialect: MarkupAI.Dialects;
     /** The tone variation you're aiming for. Options include formal, academic, casual, and other tone variations to match your content goals. */
@@ -22,4 +20,6 @@ export interface CreateStyleSuggestionV1StyleSuggestionsPostRequest {
     style_guide: string;
     /** A URL that results will be POSTed to once the process completes. */
     webhook_url?: string;
+    /** The document to analyze. Text (.txt), Markdown (.md), HTML (.html .htm), DITA (.dita, .xml), and PDF (.pdf) files are accepted. The max file size is 1.5 MB. */
+    file_upload: core.file.Uploadable.FileLike;
 }

package/dist/cjs/api/resources/styleChecks/client/requests/index.d.ts

@@ -1 +1 @@
-export { type CreateStyleCheckV1StyleChecksPostRequest } from "./CreateStyleCheckV1StyleChecksPostRequest.js";
+export { type StyleCheckRequestBody } from "./StyleCheckRequestBody.js";

package/dist/cjs/api/resources/styleGuides/client/Client.js

@@ -153,6 +153,9 @@ class StyleGuides {
             const _request = yield core.newFormData();
             yield _request.appendFile("file_upload", request.file_upload);
             _request.append("name", request.name);
+            if (request.base_style_guide != null) {
+                _request.append("base_style_guide", request.base_style_guide);
+            }
             const _maybeEncodedRequest = yield _request.getRequest();
             let _headers = (0, headers_js_1.mergeHeaders)((_a = this._options) === null || _a === void 0 ? void 0 : _a.headers, (0, headers_js_1.mergeOnlyDefinedHeaders)(Object.assign({ Authorization: yield this._getAuthorizationHeader() }, _maybeEncodedRequest.headers)), requestOptions === null || requestOptions === void 0 ? void 0 : requestOptions.headers);
             const _response = yield ((_b = this._options.fetcher) !== null && _b !== void 0 ? _b : core.fetcher)({

package/dist/cjs/api/resources/styleGuides/client/requests/StyleGuideRequestBody.d.ts

@@ -2,6 +2,7 @@
  * This file was auto-generated by Fern from our API Definition.
  */
 import * as core from "../../../../../core/index.js";
+import * as MarkupAI from "../../../../index.js";
 /**
  * @example
  *     {
@@ -14,4 +15,6 @@ export interface StyleGuideRequestBody {
     file_upload: core.file.Uploadable.FileLike;
     /** A friendly name for your style guide to help you identify it later. */
     name: string;
+    /** The base style guide to extend (AP, Chicago, or Microsoft). If not provided, the style guide will be created from scratch. */
+    base_style_guide?: MarkupAI.BaseStyleGuideType;
 }

package/dist/cjs/api/resources/styleRewrites/client/Client.d.ts

@@ -36,13 +36,14 @@ export declare class StyleRewrites {
     /**
      * Rewrite text with style corrections applied.
      *
-     * @param {MarkupAI.CreateStyleRewriteV1StyleRewritesPostRequest} request
+     * @param {MarkupAI.StyleRewriteRequestBody} request
      * @param {StyleRewrites.RequestOptions} requestOptions - Request-specific configuration.
      *
      * @throws {@link MarkupAI.UnauthorizedError}
      * @throws {@link MarkupAI.ForbiddenError}
      * @throws {@link MarkupAI.ContentTooLargeError}
      * @throws {@link MarkupAI.UnprocessableEntityError}
+     * @throws {@link MarkupAI.TooManyRequestsError}
      * @throws {@link MarkupAI.InternalServerError}
      *
      * @example
@@ -53,7 +54,7 @@ export declare class StyleRewrites {
      *         style_guide: "style_guide"
      *     })
      */
-    createStyleRewrite(request: MarkupAI.CreateStyleRewriteV1StyleRewritesPostRequest, requestOptions?: StyleRewrites.RequestOptions): core.HttpResponsePromise<MarkupAI.WorkflowResponse>;
+    createStyleRewrite(request: MarkupAI.StyleRewriteRequestBody, requestOptions?: StyleRewrites.RequestOptions): core.HttpResponsePromise<MarkupAI.WorkflowResponse>;
     private __createStyleRewrite;
     /**
      * Retrieve rewrite results.

package/dist/cjs/api/resources/styleRewrites/client/Client.js

@@ -61,13 +61,14 @@ class StyleRewrites {
     /**
      * Rewrite text with style corrections applied.
      *
-     * @param {MarkupAI.CreateStyleRewriteV1StyleRewritesPostRequest} request
+     * @param {MarkupAI.StyleRewriteRequestBody} request
      * @param {StyleRewrites.RequestOptions} requestOptions - Request-specific configuration.
      *
      * @throws {@link MarkupAI.UnauthorizedError}
      * @throws {@link MarkupAI.ForbiddenError}
      * @throws {@link MarkupAI.ContentTooLargeError}
      * @throws {@link MarkupAI.UnprocessableEntityError}
+     * @throws {@link MarkupAI.TooManyRequestsError}
      * @throws {@link MarkupAI.InternalServerError}
      *
      * @example
@@ -85,7 +86,6 @@ class StyleRewrites {
         return __awaiter(this, void 0, void 0, function* () {
             var _a, _b, _c, _d;
             const _request = yield core.newFormData();
-            yield _request.appendFile("file_upload", request.file_upload);
             _request.append("dialect", request.dialect);
             if (request.tone != null) {
                 _request.append("tone", request.tone);
@@ -94,6 +94,7 @@ class StyleRewrites {
             if (request.webhook_url != null) {
                 _request.append("webhook_url", request.webhook_url);
             }
+            yield _request.appendFile("file_upload", request.file_upload);
             const _maybeEncodedRequest = yield _request.getRequest();
             let _headers = (0, headers_js_1.mergeHeaders)((_a = this._options) === null || _a === void 0 ? void 0 : _a.headers, (0, headers_js_1.mergeOnlyDefinedHeaders)(Object.assign({ Authorization: yield this._getAuthorizationHeader() }, _maybeEncodedRequest.headers)), requestOptions === null || requestOptions === void 0 ? void 0 : requestOptions.headers);
             const _response = yield ((_b = this._options.fetcher) !== null && _b !== void 0 ? _b : core.fetcher)({
@@ -121,6 +122,8 @@ class StyleRewrites {
                         throw new MarkupAI.ContentTooLargeError(_response.error.body, _response.rawResponse);
                     case 422:
                         throw new MarkupAI.UnprocessableEntityError(_response.error.body, _response.rawResponse);
+                    case 429:
+                        throw new MarkupAI.TooManyRequestsError(_response.error.body, _response.rawResponse);
                     case 500:
                         throw new MarkupAI.InternalServerError(_response.error.body, _response.rawResponse);
                     default:

package/dist/cjs/api/resources/{styleChecks/client/requests/CreateStyleCheckV1StyleChecksPostRequest.d.ts → styleRewrites/client/requests/StyleRewriteRequestBody.d.ts}

@@ -1,8 +1,8 @@
 /**
  * This file was auto-generated by Fern from our API Definition.
  */
-import * as core from "../../../../../core/index.js";
 import * as MarkupAI from "../../../../index.js";
+import * as core from "../../../../../core/index.js";
 /**
  * @example
  *     {
@@ -11,9 +11,7 @@ import * as MarkupAI from "../../../../index.js";
  *         style_guide: "style_guide"
  *     }
  */
-export interface CreateStyleCheckV1StyleChecksPostRequest {
-    /** The document to analyze. Text files (.txt), PDFs (.pdf), and Markdown files (.md) are accepted. The max file size is 1.5 MB */
-    file_upload: core.file.Uploadable.FileLike;
+export interface StyleRewriteRequestBody {
     /** The language variant you'd like us to use for analysis. Choose from American English, British English, or other supported dialects. */
     dialect: MarkupAI.Dialects;
     /** The tone variation you're aiming for. Options include formal, academic, casual, and other tone variations to match your content goals. */
@@ -22,4 +20,6 @@ export interface CreateStyleCheckV1StyleChecksPostRequest {
     style_guide: string;
     /** A URL that results will be POSTed to once the process completes. */
     webhook_url?: string;
+    /** The document to rewrite. Text (.txt), Markdown (.md), HTML (.html .htm), and DITA (.dita, .xml) files are accepted. The max file size is 1.5 MB. */
+    file_upload: core.file.Uploadable.FileLike;
 }

package/dist/cjs/api/resources/styleRewrites/client/requests/index.d.ts

@@ -1 +1 @@
-export { type CreateStyleRewriteV1StyleRewritesPostRequest } from "./CreateStyleRewriteV1StyleRewritesPostRequest.js";
+export { type StyleRewriteRequestBody } from "./StyleRewriteRequestBody.js";

package/dist/cjs/api/resources/styleSuggestions/client/Client.d.ts

@@ -36,13 +36,14 @@ export declare class StyleSuggestions {
     /**
      * Get suggested corrections for text.
      *
-     * @param {MarkupAI.CreateStyleSuggestionV1StyleSuggestionsPostRequest} request
+     * @param {MarkupAI.StyleSuggestionRequestBody} request
      * @param {StyleSuggestions.RequestOptions} requestOptions - Request-specific configuration.
      *
      * @throws {@link MarkupAI.UnauthorizedError}
      * @throws {@link MarkupAI.ForbiddenError}
      * @throws {@link MarkupAI.ContentTooLargeError}
      * @throws {@link MarkupAI.UnprocessableEntityError}
+     * @throws {@link MarkupAI.TooManyRequestsError}
      * @throws {@link MarkupAI.InternalServerError}
      *
      * @example
@@ -53,7 +54,7 @@ export declare class StyleSuggestions {
      *         style_guide: "style_guide"
      *     })
      */
-    createStyleSuggestion(request: MarkupAI.CreateStyleSuggestionV1StyleSuggestionsPostRequest, requestOptions?: StyleSuggestions.RequestOptions): core.HttpResponsePromise<MarkupAI.WorkflowResponse>;
+    createStyleSuggestion(request: MarkupAI.StyleSuggestionRequestBody, requestOptions?: StyleSuggestions.RequestOptions): core.HttpResponsePromise<MarkupAI.WorkflowResponse>;
     private __createStyleSuggestion;
     /**
      * Retrieve suggestion results.

package/dist/cjs/api/resources/styleSuggestions/client/Client.js

@@ -61,13 +61,14 @@ class StyleSuggestions {
     /**
      * Get suggested corrections for text.
      *
-     * @param {MarkupAI.CreateStyleSuggestionV1StyleSuggestionsPostRequest} request
+     * @param {MarkupAI.StyleSuggestionRequestBody} request
      * @param {StyleSuggestions.RequestOptions} requestOptions - Request-specific configuration.
      *
      * @throws {@link MarkupAI.UnauthorizedError}
      * @throws {@link MarkupAI.ForbiddenError}
      * @throws {@link MarkupAI.ContentTooLargeError}
      * @throws {@link MarkupAI.UnprocessableEntityError}
+     * @throws {@link MarkupAI.TooManyRequestsError}
      * @throws {@link MarkupAI.InternalServerError}
      *
      * @example
@@ -85,7 +86,6 @@ class StyleSuggestions {
         return __awaiter(this, void 0, void 0, function* () {
             var _a, _b, _c, _d;
             const _request = yield core.newFormData();
-            yield _request.appendFile("file_upload", request.file_upload);
             _request.append("dialect", request.dialect);
             if (request.tone != null) {
                 _request.append("tone", request.tone);
@@ -94,6 +94,7 @@ class StyleSuggestions {
             if (request.webhook_url != null) {
                 _request.append("webhook_url", request.webhook_url);
             }
+            yield _request.appendFile("file_upload", request.file_upload);
             const _maybeEncodedRequest = yield _request.getRequest();
             let _headers = (0, headers_js_1.mergeHeaders)((_a = this._options) === null || _a === void 0 ? void 0 : _a.headers, (0, headers_js_1.mergeOnlyDefinedHeaders)(Object.assign({ Authorization: yield this._getAuthorizationHeader() }, _maybeEncodedRequest.headers)), requestOptions === null || requestOptions === void 0 ? void 0 : requestOptions.headers);
             const _response = yield ((_b = this._options.fetcher) !== null && _b !== void 0 ? _b : core.fetcher)({
@@ -121,6 +122,8 @@ class StyleSuggestions {
                         throw new MarkupAI.ContentTooLargeError(_response.error.body, _response.rawResponse);
                     case 422:
                         throw new MarkupAI.UnprocessableEntityError(_response.error.body, _response.rawResponse);
+                    case 429:
+                        throw new MarkupAI.TooManyRequestsError(_response.error.body, _response.rawResponse);
                     case 500:
                         throw new MarkupAI.InternalServerError(_response.error.body, _response.rawResponse);
                     default:

package/dist/cjs/api/resources/{styleRewrites/client/requests/CreateStyleRewriteV1StyleRewritesPostRequest.d.ts → styleSuggestions/client/requests/StyleSuggestionRequestBody.d.ts}

@@ -1,8 +1,8 @@
 /**
  * This file was auto-generated by Fern from our API Definition.
  */
-import * as core from "../../../../../core/index.js";
 import * as MarkupAI from "../../../../index.js";
+import * as core from "../../../../../core/index.js";
 /**
  * @example
  *     {
@@ -11,9 +11,7 @@ import * as MarkupAI from "../../../../index.js";
  *         style_guide: "style_guide"
  *     }
  */
-export interface CreateStyleRewriteV1StyleRewritesPostRequest {
-    /** The document to analyze. Text files (.txt), PDFs (.pdf), and Markdown files (.md) are accepted. The max file size is 1.5 MB */
-    file_upload: core.file.Uploadable.FileLike;
+export interface StyleSuggestionRequestBody {
     /** The language variant you'd like us to use for analysis. Choose from American English, British English, or other supported dialects. */
     dialect: MarkupAI.Dialects;
     /** The tone variation you're aiming for. Options include formal, academic, casual, and other tone variations to match your content goals. */
@@ -22,4 +20,6 @@ export interface CreateStyleRewriteV1StyleRewritesPostRequest {
     style_guide: string;
     /** A URL that results will be POSTed to once the process completes. */
     webhook_url?: string;
+    /** The document to analyze. Text (.txt), Markdown (.md), HTML (.html .htm), DITA (.dita, .xml), and PDF (.pdf) files are accepted. The max file size is 1.5 MB. */
+    file_upload: core.file.Uploadable.FileLike;
 }

package/dist/cjs/api/resources/styleSuggestions/client/requests/index.d.ts

@@ -1 +1 @@
-export { type CreateStyleSuggestionV1StyleSuggestionsPostRequest } from "./CreateStyleSuggestionV1StyleSuggestionsPostRequest.js";
+export { type StyleSuggestionRequestBody } from "./StyleSuggestionRequestBody.js";

package/dist/cjs/api/types/BaseStyleGuideType.d.ts

@@ -0,0 +1,9 @@
+/**
+ * This file was auto-generated by Fern from our API Definition.
+ */
+export type BaseStyleGuideType = "ap" | "chicago" | "microsoft";
+export declare const BaseStyleGuideType: {
+    readonly Ap: "ap";
+    readonly Chicago: "chicago";
+    readonly Microsoft: "microsoft";
+};

package/dist/cjs/api/types/BaseStyleGuideType.js

@@ -0,0 +1,11 @@
+"use strict";
+/**
+ * This file was auto-generated by Fern from our API Definition.
+ */
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.BaseStyleGuideType = void 0;
+exports.BaseStyleGuideType = {
+    Ap: "ap",
+    Chicago: "chicago",
+    Microsoft: "microsoft",
+};

package/dist/cjs/api/types/StyleGuideResponse.d.ts

@@ -16,6 +16,8 @@ export interface StyleGuideResponse {
     updated_at?: string;
     /** The ID of the user who last updated the style guide. If null, the style guide has never been updated. */
     updated_by?: string;
-    /** Summarizes the rules and guidelines which will be applied by this style guide. */
+    /** User-friendly summary of the style guide's contents and characteristics */
     summary?: string;
+    /** The base style guide type that this style guide extends (AP, Chicago, or Microsoft). */
+    base_style_guide_type?: MarkupAI.BaseStyleGuideType;
 }

package/dist/cjs/api/types/StyleGuides.d.ts

@@ -1,11 +1,10 @@
 /**
  * This file was auto-generated by Fern from our API Definition.
  */
-export type StyleGuides = "ap" | "chicago" | "microsoft" | "demo" | "style_brand_importer";
+export type StyleGuides = "ap" | "chicago" | "microsoft" | "style_brand_importer";
 export declare const StyleGuides: {
     readonly Ap: "ap";
     readonly Chicago: "chicago";
     readonly Microsoft: "microsoft";
-    readonly Demo: "demo";
     readonly StyleBrandImporter: "style_brand_importer";
 };

package/dist/cjs/api/types/StyleGuides.js

@@ -8,6 +8,5 @@ exports.StyleGuides = {
     Ap: "ap",
     Chicago: "chicago",
     Microsoft: "microsoft",
-    Demo: "demo",
     StyleBrandImporter: "style_brand_importer",
 };

package/dist/cjs/api/types/WorkflowInfo.d.ts

@@ -7,6 +7,8 @@ export interface WorkflowInfo {
     id: string;
     /** API version */
     api_version?: string;
+    /** The original name of the file passed into the workflow */
+    filename?: string;
     /** UTC timestamp when the result was generated */
     generated_at?: string;
     status?: MarkupAI.WorkflowStatus;

package/dist/cjs/api/types/index.d.ts

@@ -1,4 +1,5 @@
 export * from "./AnalysisScore.js";
+export * from "./BaseStyleGuideType.js";
 export * from "./ClarityCategory.js";
 export * from "./ClarityScore.js";
 export * from "./ConfigOptions.js";

package/dist/cjs/api/types/index.js

@@ -15,6 +15,7 @@ var __exportStar = (this && this.__exportStar) || function(m, exports) {
 };
 Object.defineProperty(exports, "__esModule", { value: true });
 __exportStar(require("./AnalysisScore.js"), exports);
+__exportStar(require("./BaseStyleGuideType.js"), exports);
 __exportStar(require("./ClarityCategory.js"), exports);
 __exportStar(require("./ClarityScore.js"), exports);
 __exportStar(require("./ConfigOptions.js"), exports);

package/dist/cjs/core/auth/index.d.ts

@@ -1,4 +1,4 @@
-export { AuthProvider } from "./AuthProvider.js";
-export { type AuthRequest } from "./AuthRequest.js";
+export type { AuthProvider } from "./AuthProvider.js";
+export type { AuthRequest } from "./AuthRequest.js";
 export { BasicAuth } from "./BasicAuth.js";
 export { BearerToken } from "./BearerToken.js";

package/dist/cjs/core/fetcher/EndpointMetadata.d.ts

@@ -0,0 +1,13 @@
+export type SecuritySchemeKey = string;
+/**
+ * A collection of security schemes, where the key is the name of the security scheme and the value is the list of scopes required for that scheme.
+ * All schemes in the collection must be satisfied for authentication to be successful.
+ */
+export type SecuritySchemeCollection = Record<SecuritySchemeKey, AuthScope[]>;
+export type AuthScope = string;
+export type EndpointMetadata = {
+    /**
+     * An array of security scheme collections. Each collection represents an alternative way to authenticate.
+     */
+    security?: SecuritySchemeCollection[];
+};

package/dist/cjs/core/fetcher/EndpointMetadata.js

@@ -0,0 +1,2 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });

package/dist/cjs/core/fetcher/EndpointSupplier.d.ts

@@ -0,0 +1,12 @@
+import { EndpointMetadata } from "./EndpointMetadata.js";
+import { Supplier } from "./Supplier.js";
+type EndpointSupplierFn<T> = (arg: {
+    endpointMetadata: EndpointMetadata;
+}) => T | Promise<T>;
+export type EndpointSupplier<T> = Supplier<T> | EndpointSupplierFn<T>;
+export declare const EndpointSupplier: {
+    get: <T>(supplier: EndpointSupplier<T>, arg: {
+        endpointMetadata: EndpointMetadata;
+    }) => Promise<T>;
+};
+export {};

package/dist/cjs/core/fetcher/EndpointSupplier.js

@@ -0,0 +1,22 @@
+"use strict";
+var __awaiter = (this && this.__awaiter) || function (thisArg, _arguments, P, generator) {
+    function adopt(value) { return value instanceof P ? value : new P(function (resolve) { resolve(value); }); }
+    return new (P || (P = Promise))(function (resolve, reject) {
+        function fulfilled(value) { try { step(generator.next(value)); } catch (e) { reject(e); } }
+        function rejected(value) { try { step(generator["throw"](value)); } catch (e) { reject(e); } }
+        function step(result) { result.done ? resolve(result.value) : adopt(result.value).then(fulfilled, rejected); }
+        step((generator = generator.apply(thisArg, _arguments || [])).next());
+    });
+};
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.EndpointSupplier = void 0;
+exports.EndpointSupplier = {
+    get: (supplier, arg) => __awaiter(void 0, void 0, void 0, function* () {
+        if (typeof supplier === "function") {
+            return supplier(arg);
+        }
+        else {
+            return supplier;
+        }
+    }),
+};

package/dist/cjs/core/fetcher/Fetcher.d.ts

@@ -1,12 +1,13 @@
 import { APIResponse } from "./APIResponse.js";
-import { Supplier } from "./Supplier.js";
+import { EndpointMetadata } from "./EndpointMetadata.js";
+import { EndpointSupplier } from "./EndpointSupplier.js";
 export type FetchFunction = <R = unknown>(args: Fetcher.Args) => Promise<APIResponse<R, Fetcher.Error>>;
 export declare namespace Fetcher {
     interface Args {
         url: string;
         method: string;
         contentType?: string;
-        headers?: Record<string, string | Supplier<string | null | undefined> | null | undefined>;
+        headers?: Record<string, string | EndpointSupplier<string | null | undefined> | null | undefined>;
         queryParameters?: Record<string, unknown>;
         body?: unknown;
         timeoutMs?: number;
@@ -16,6 +17,7 @@ export declare namespace Fetcher {
         requestType?: "json" | "file" | "bytes";
         responseType?: "json" | "blob" | "sse" | "streaming" | "text" | "arrayBuffer" | "binary-response";
         duplex?: "half";
+        endpointMetadata?: EndpointMetadata;
     }
     type Error = FailedStatusCodeError | NonJsonError | TimeoutError | UnknownError;
     interface FailedStatusCodeError {