@markupai/api 1.0.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": "1.0.0",
-                "User-Agent": "@markupai/api/1.0.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/resources/styleChecks/client/Client.d.ts

@@ -36,7 +36,7 @@ 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}
@@ -54,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,7 +61,7 @@ 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}
@@ -86,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);
@@ -95,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)({

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,7 +36,7 @@ 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}
@@ -54,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,7 +61,7 @@ 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}
@@ -86,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);
@@ -95,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)({

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,7 +36,7 @@ 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}
@@ -54,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,7 +61,7 @@ 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}
@@ -86,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);
@@ -95,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)({

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

@@ -18,4 +18,6 @@ export interface StyleGuideResponse {
     updated_by?: string;
     /** 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/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/version.d.ts

@@ -1 +1 @@
-export declare const SDK_VERSION = "1.0.0";
+export declare const SDK_VERSION = "1.1.0";

package/dist/cjs/version.js

@@ -1,4 +1,4 @@
 "use strict";
 Object.defineProperty(exports, "__esModule", { value: true });
 exports.SDK_VERSION = void 0;
-exports.SDK_VERSION = "1.0.0";
+exports.SDK_VERSION = "1.1.0";

package/dist/esm/Client.mjs

@@ -12,8 +12,8 @@ export class MarkupAIClient {
         this._options = Object.assign(Object.assign({}, _options), { headers: mergeHeaders({
                 "X-Fern-Language": "JavaScript",
                 "X-Fern-SDK-Name": "@markupai/api",
-                "X-Fern-SDK-Version": "1.0.0",
-                "User-Agent": "@markupai/api/1.0.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/esm/api/resources/styleChecks/client/Client.d.mts

@@ -36,7 +36,7 @@ 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}
@@ -54,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/esm/api/resources/styleChecks/client/Client.mjs

@@ -25,7 +25,7 @@ export 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}
@@ -50,7 +50,6 @@ export 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);
@@ -59,6 +58,7 @@ export 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 = mergeHeaders((_a = this._options) === null || _a === void 0 ? void 0 : _a.headers, 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/esm/api/resources/{styleSuggestions/client/requests/CreateStyleSuggestionV1StyleSuggestionsPostRequest.d.mts → styleChecks/client/requests/StyleCheckRequestBody.d.mts}

@@ -1,8 +1,8 @@
 /**
  * This file was auto-generated by Fern from our API Definition.
  */
-import * as core from "../../../../../core/index.mjs";
 import * as MarkupAI from "../../../../index.mjs";
+import * as core from "../../../../../core/index.mjs";
 /**
  * @example
  *     {
@@ -11,9 +11,7 @@ import * as MarkupAI from "../../../../index.mjs";
  *         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/esm/api/resources/styleChecks/client/requests/index.d.mts

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

package/dist/esm/api/resources/styleGuides/client/Client.mjs

@@ -117,6 +117,9 @@ export 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 = mergeHeaders((_a = this._options) === null || _a === void 0 ? void 0 : _a.headers, 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/esm/api/resources/styleGuides/client/requests/StyleGuideRequestBody.d.mts

@@ -2,6 +2,7 @@
  * This file was auto-generated by Fern from our API Definition.
  */
 import * as core from "../../../../../core/index.mjs";
+import * as MarkupAI from "../../../../index.mjs";
 /**
  * @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/esm/api/resources/styleRewrites/client/Client.d.mts

@@ -36,7 +36,7 @@ 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}
@@ -54,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/esm/api/resources/styleRewrites/client/Client.mjs

@@ -25,7 +25,7 @@ export 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}
@@ -50,7 +50,6 @@ export 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);
@@ -59,6 +58,7 @@ export 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 = mergeHeaders((_a = this._options) === null || _a === void 0 ? void 0 : _a.headers, 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/esm/api/resources/styleRewrites/client/requests/{CreateStyleRewriteV1StyleRewritesPostRequest.d.mts → StyleRewriteRequestBody.d.mts}

@@ -1,8 +1,8 @@
 /**
  * This file was auto-generated by Fern from our API Definition.
  */
-import * as core from "../../../../../core/index.mjs";
 import * as MarkupAI from "../../../../index.mjs";
+import * as core from "../../../../../core/index.mjs";
 /**
  * @example
  *     {
@@ -11,9 +11,7 @@ import * as MarkupAI from "../../../../index.mjs";
  *         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 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 CreateStyleRewriteV1StyleRewritesPostRequest {
     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/esm/api/resources/styleRewrites/client/requests/index.d.mts

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

package/dist/esm/api/resources/styleSuggestions/client/Client.d.mts

@@ -36,7 +36,7 @@ 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}
@@ -54,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/esm/api/resources/styleSuggestions/client/Client.mjs

@@ -25,7 +25,7 @@ export 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}
@@ -50,7 +50,6 @@ export 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);
@@ -59,6 +58,7 @@ export 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 = mergeHeaders((_a = this._options) === null || _a === void 0 ? void 0 : _a.headers, 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/esm/api/resources/{styleChecks/client/requests/CreateStyleCheckV1StyleChecksPostRequest.d.mts → styleSuggestions/client/requests/StyleSuggestionRequestBody.d.mts}

@@ -1,8 +1,8 @@
 /**
  * This file was auto-generated by Fern from our API Definition.
  */
-import * as core from "../../../../../core/index.mjs";
 import * as MarkupAI from "../../../../index.mjs";
+import * as core from "../../../../../core/index.mjs";
 /**
  * @example
  *     {
@@ -11,9 +11,7 @@ import * as MarkupAI from "../../../../index.mjs";
  *         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 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 CreateStyleCheckV1StyleChecksPostRequest {
     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/esm/api/resources/styleSuggestions/client/requests/index.d.mts

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

package/dist/esm/api/types/BaseStyleGuideType.d.mts

@@ -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/esm/api/types/BaseStyleGuideType.mjs

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

package/dist/esm/api/types/StyleGuideResponse.d.mts

@@ -18,4 +18,6 @@ export interface StyleGuideResponse {
     updated_by?: string;
     /** 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/esm/api/types/WorkflowInfo.d.mts

@@ -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/esm/api/types/index.d.mts

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

package/dist/esm/api/types/index.mjs

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

package/dist/esm/version.d.mts

@@ -1 +1 @@
-export declare const SDK_VERSION = "1.0.0";
+export declare const SDK_VERSION = "1.1.0";

package/dist/esm/version.mjs

@@ -1 +1 @@
-export const SDK_VERSION = "1.0.0";
+export const SDK_VERSION = "1.1.0";

package/package.json

@@ -1,6 +1,6 @@
 {
     "name": "@markupai/api",
-    "version": "1.0.0",
+    "version": "1.1.0",
     "private": false,
     "repository": "github:markupai/markup-ai-typescript-sdk",
     "license": "Apache-2.0",

package/reference.md

@@ -372,7 +372,7 @@ await client.styleChecks.createStyleCheck({
 <dl>
 <dd>
 
-**request:** `MarkupAI.CreateStyleCheckV1StyleChecksPostRequest`
+**request:** `MarkupAI.StyleCheckRequestBody`
 
 </dd>
 </dl>
@@ -504,7 +504,7 @@ await client.styleSuggestions.createStyleSuggestion({
 <dl>
 <dd>
 
-**request:** `MarkupAI.CreateStyleSuggestionV1StyleSuggestionsPostRequest`
+**request:** `MarkupAI.StyleSuggestionRequestBody`
 
 </dd>
 </dl>
@@ -636,7 +636,7 @@ await client.styleRewrites.createStyleRewrite({
 <dl>
 <dd>
 
-**request:** `MarkupAI.CreateStyleRewriteV1StyleRewritesPostRequest`
+**request:** `MarkupAI.StyleRewriteRequestBody`
 
 </dd>
 </dl>