@markupai/api 0.1.1 → 0.3.0

package/dist/{api → cjs/api}/resources/styleSuggestions/client/Client.js

@@ -44,16 +44,13 @@ var __awaiter = (this && this.__awaiter) || function (thisArg, _arguments, P, ge
         step((generator = generator.apply(thisArg, _arguments || [])).next());
     });
 };
-var __importDefault = (this && this.__importDefault) || function (mod) {
-    return (mod && mod.__esModule) ? mod : { "default": mod };
-};
 Object.defineProperty(exports, "__esModule", { value: true });
 exports.StyleSuggestions = void 0;
-const environments = __importStar(require("../../../../environments"));
-const core = __importStar(require("../../../../core"));
-const MarkupAI = __importStar(require("../../../index"));
-const url_join_1 = __importDefault(require("url-join"));
-const errors = __importStar(require("../../../../errors/index"));
+const environments = __importStar(require("../../../../environments.js"));
+const core = __importStar(require("../../../../core/index.js"));
+const MarkupAI = __importStar(require("../../../index.js"));
+const headers_js_1 = require("../../../../core/headers.js");
+const errors = __importStar(require("../../../../errors/index.js"));
 /**
  * Get detailed results from style checks, including flagged issues and suggestions for how to fix them. Perfect for polishing content and staying on-brand.
  */
@@ -64,7 +61,6 @@ class StyleSuggestions {
     /**
      * Get suggested corrections for text.
      *
-     * @param {File | fs.ReadStream | Blob} file_upload
      * @param {MarkupAI.CreateStyleSuggestionV1StyleSuggestionsPostRequest} request
      * @param {StyleSuggestions.RequestOptions} requestOptions - Request-specific configuration.
      *
@@ -75,19 +71,21 @@ class StyleSuggestions {
      * @throws {@link MarkupAI.InternalServerError}
      *
      * @example
-     *     await client.styleSuggestions.createStyleSuggestion(fs.createReadStream("/path/to/your/file"), {
+     *     import { createReadStream } from "fs";
+     *     await client.styleSuggestions.createStyleSuggestion({
+     *         file_upload: fs.createReadStream("/path/to/your/file"),
      *         dialect: "american_english",
      *         style_guide: "style_guide"
      *     })
      */
-    createStyleSuggestion(file_upload, request, requestOptions) {
-        return core.HttpResponsePromise.fromPromise(this.__createStyleSuggestion(file_upload, request, requestOptions));
+    createStyleSuggestion(request, requestOptions) {
+        return core.HttpResponsePromise.fromPromise(this.__createStyleSuggestion(request, requestOptions));
     }
-    __createStyleSuggestion(file_upload, request, requestOptions) {
+    __createStyleSuggestion(request, requestOptions) {
         return __awaiter(this, void 0, void 0, function* () {
-            var _a, _b, _c;
+            var _a, _b, _c, _d;
             const _request = yield core.newFormData();
-            yield _request.appendFile("file_upload", file_upload);
+            yield _request.appendFile("file_upload", request.file_upload);
             _request.append("dialect", request.dialect);
             if (request.tone != null) {
                 _request.append("tone", request.tone);
@@ -97,10 +95,12 @@ class StyleSuggestions {
                 _request.append("webhook_url", request.webhook_url);
             }
             const _maybeEncodedRequest = yield _request.getRequest();
-            const _response = yield ((_a = this._options.fetcher) !== null && _a !== void 0 ? _a : core.fetcher)({
-                url: (0, url_join_1.default)((_c = (_b = (yield core.Supplier.get(this._options.baseUrl))) !== null && _b !== void 0 ? _b : (yield core.Supplier.get(this._options.environment))) !== null && _c !== void 0 ? _c : environments.MarkupAIEnvironment.Default, "v1/style/suggestions"),
+            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)({
+                url: core.url.join((_d = (_c = (yield core.Supplier.get(this._options.baseUrl))) !== null && _c !== void 0 ? _c : (yield core.Supplier.get(this._options.environment))) !== null && _d !== void 0 ? _d : environments.MarkupAIEnvironment.Default, "v1/style/suggestions"),
                 method: "POST",
-                headers: Object.assign(Object.assign({ Authorization: yield this._getAuthorizationHeader(), "X-Fern-Language": "JavaScript", "X-Fern-SDK-Name": "@markupai/api", "X-Fern-SDK-Version": "0.1.1", "User-Agent": "@markupai/api/0.1.1", "X-Fern-Runtime": core.RUNTIME.type, "X-Fern-Runtime-Version": core.RUNTIME.version }, _maybeEncodedRequest.headers), requestOptions === null || requestOptions === void 0 ? void 0 : requestOptions.headers),
+                headers: _headers,
+                queryParameters: requestOptions === null || requestOptions === void 0 ? void 0 : requestOptions.queryParams,
                 requestType: "file",
                 duplex: _maybeEncodedRequest.duplex,
                 body: _maybeEncodedRequest.body,
@@ -168,13 +168,13 @@ class StyleSuggestions {
     }
     __getStyleSuggestion(workflowId, requestOptions) {
         return __awaiter(this, void 0, void 0, function* () {
-            var _a, _b, _c;
-            const _response = yield ((_a = this._options.fetcher) !== null && _a !== void 0 ? _a : core.fetcher)({
-                url: (0, url_join_1.default)((_c = (_b = (yield core.Supplier.get(this._options.baseUrl))) !== null && _b !== void 0 ? _b : (yield core.Supplier.get(this._options.environment))) !== null && _c !== void 0 ? _c : environments.MarkupAIEnvironment.Default, `v1/style/suggestions/${encodeURIComponent(workflowId)}`),
+            var _a, _b, _c, _d;
+            let _headers = (0, headers_js_1.mergeHeaders)((_a = this._options) === null || _a === void 0 ? void 0 : _a.headers, (0, headers_js_1.mergeOnlyDefinedHeaders)({ Authorization: yield this._getAuthorizationHeader() }), requestOptions === null || requestOptions === void 0 ? void 0 : requestOptions.headers);
+            const _response = yield ((_b = this._options.fetcher) !== null && _b !== void 0 ? _b : core.fetcher)({
+                url: core.url.join((_d = (_c = (yield core.Supplier.get(this._options.baseUrl))) !== null && _c !== void 0 ? _c : (yield core.Supplier.get(this._options.environment))) !== null && _d !== void 0 ? _d : environments.MarkupAIEnvironment.Default, `v1/style/suggestions/${encodeURIComponent(workflowId)}`),
                 method: "GET",
-                headers: Object.assign({ Authorization: yield this._getAuthorizationHeader(), "X-Fern-Language": "JavaScript", "X-Fern-SDK-Name": "@markupai/api", "X-Fern-SDK-Version": "0.1.1", "User-Agent": "@markupai/api/0.1.1", "X-Fern-Runtime": core.RUNTIME.type, "X-Fern-Runtime-Version": core.RUNTIME.version }, requestOptions === null || requestOptions === void 0 ? void 0 : requestOptions.headers),
-                contentType: "application/json",
-                requestType: "json",
+                headers: _headers,
+                queryParameters: requestOptions === null || requestOptions === void 0 ? void 0 : requestOptions.queryParams,
                 timeoutMs: (requestOptions === null || requestOptions === void 0 ? void 0 : requestOptions.timeoutInSeconds) != null ? requestOptions.timeoutInSeconds * 1000 : 60000,
                 maxRetries: requestOptions === null || requestOptions === void 0 ? void 0 : requestOptions.maxRetries,
                 abortSignal: requestOptions === null || requestOptions === void 0 ? void 0 : requestOptions.abortSignal,

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

@@ -0,0 +1,2 @@
+export {};
+export * from "./requests/index.js";

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

@@ -0,0 +1,17 @@
+"use strict";
+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 __exportStar = (this && this.__exportStar) || function(m, exports) {
+    for (var p in m) if (p !== "default" && !Object.prototype.hasOwnProperty.call(exports, p)) __createBinding(exports, m, p);
+};
+Object.defineProperty(exports, "__esModule", { value: true });
+__exportStar(require("./requests/index.js"), exports);

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

@@ -1,15 +1,19 @@
 /**
  * This file was auto-generated by Fern from our API Definition.
  */
-import * as MarkupAI from "../../../../index";
+import * as core from "../../../../../core/index.js";
+import * as MarkupAI from "../../../../index.js";
 /**
  * @example
  *     {
+ *         file_upload: fs.createReadStream("/path/to/your/file"),
  *         dialect: "american_english",
  *         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;
     /** 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. */

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

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

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

@@ -0,0 +1 @@
+export * from "./client/index.js";

package/{api/resources/styleChecks/client → dist/cjs/api/resources/styleSuggestions}/index.js

@@ -14,4 +14,4 @@ var __exportStar = (this && this.__exportStar) || function(m, exports) {
     for (var p in m) if (p !== "default" && !Object.prototype.hasOwnProperty.call(exports, p)) __createBinding(exports, m, p);
 };
 Object.defineProperty(exports, "__esModule", { value: true });
-__exportStar(require("./requests"), exports);
+__exportStar(require("./client/index.js"), exports);

package/{api → dist/cjs/api}/types/AnalysisScore.d.ts

@@ -1,7 +1,7 @@
 /**
  * This file was auto-generated by Fern from our API Definition.
  */
-import * as MarkupAI from "../index";
+import * as MarkupAI from "../index.js";
 export interface AnalysisScore {
     clarity?: MarkupAI.ClarityScore;
     tone?: MarkupAI.ToneScore;

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

@@ -0,0 +1,16 @@
+/**
+ * This file was auto-generated by Fern from our API Definition.
+ */
+export type ClarityCategory = "Simpler Words" | "Complex Verb Tenses" | "Hidden Verbs" | "Direct Statements" | "Passive Voice" | "Phrasal Verbs" | "Formal Grammar Forms" | "Unnecessary Words" | "Sentence Splitting" | "Concise Wording";
+export declare const ClarityCategory: {
+    readonly SimplerWords: "Simpler Words";
+    readonly ComplexVerbTenses: "Complex Verb Tenses";
+    readonly HiddenVerbs: "Hidden Verbs";
+    readonly DirectStatements: "Direct Statements";
+    readonly PassiveVoice: "Passive Voice";
+    readonly PhrasalVerbs: "Phrasal Verbs";
+    readonly FormalGrammarForms: "Formal Grammar Forms";
+    readonly UnnecessaryWords: "Unnecessary Words";
+    readonly SentenceSplitting: "Sentence Splitting";
+    readonly ConciseWording: "Concise Wording";
+};

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

@@ -0,0 +1,18 @@
+"use strict";
+/**
+ * This file was auto-generated by Fern from our API Definition.
+ */
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.ClarityCategory = void 0;
+exports.ClarityCategory = {
+    SimplerWords: "Simpler Words",
+    ComplexVerbTenses: "Complex Verb Tenses",
+    HiddenVerbs: "Hidden Verbs",
+    DirectStatements: "Direct Statements",
+    PassiveVoice: "Passive Voice",
+    PhrasalVerbs: "Phrasal Verbs",
+    FormalGrammarForms: "Formal Grammar Forms",
+    UnnecessaryWords: "Unnecessary Words",
+    SentenceSplitting: "Sentence Splitting",
+    ConciseWording: "Concise Wording",
+};

package/dist/{api/types/CheckOptions.d.ts → cjs/api/types/ConfigOptions.d.ts}

@@ -1,9 +1,9 @@
 /**
  * This file was auto-generated by Fern from our API Definition.
  */
-import * as MarkupAI from "../index";
-export interface CheckOptions {
-    style_guide?: MarkupAI.StyleGuide;
+import * as MarkupAI from "../index.js";
+export interface ConfigOptions {
     dialect?: MarkupAI.Dialects;
+    style_guide?: MarkupAI.StyleGuide;
     tone?: MarkupAI.Tones;
 }

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

@@ -0,0 +1,15 @@
+/**
+ * This file was auto-generated by Fern from our API Definition.
+ */
+export type ConsistencyCategory = "Consistent Punctuation" | "Consistent Capitalization" | "Preferred Spelling and Grammar" | "Numbers, Dates, and Times" | "Inclusive Language" | "Brand Voice" | "Special Style Guide Requirements" | "Clarity and Readability" | "other";
+export declare const ConsistencyCategory: {
+    readonly ConsistentPunctuation: "Consistent Punctuation";
+    readonly ConsistentCapitalization: "Consistent Capitalization";
+    readonly PreferredSpellingAndGrammar: "Preferred Spelling and Grammar";
+    readonly NumbersDatesAndTimes: "Numbers, Dates, and Times";
+    readonly InclusiveLanguage: "Inclusive Language";
+    readonly BrandVoice: "Brand Voice";
+    readonly SpecialStyleGuideRequirements: "Special Style Guide Requirements";
+    readonly ClarityAndReadability: "Clarity and Readability";
+    readonly Other: "other";
+};

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

@@ -0,0 +1,17 @@
+"use strict";
+/**
+ * This file was auto-generated by Fern from our API Definition.
+ */
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.ConsistencyCategory = void 0;
+exports.ConsistencyCategory = {
+    ConsistentPunctuation: "Consistent Punctuation",
+    ConsistentCapitalization: "Consistent Capitalization",
+    PreferredSpellingAndGrammar: "Preferred Spelling and Grammar",
+    NumbersDatesAndTimes: "Numbers, Dates, and Times",
+    InclusiveLanguage: "Inclusive Language",
+    BrandVoice: "Brand Voice",
+    SpecialStyleGuideRequirements: "Special Style Guide Requirements",
+    ClarityAndReadability: "Clarity and Readability",
+    Other: "other",
+};

package/{api/types/StyleGuideScore.d.ts → dist/cjs/api/types/ConsistencyScore.d.ts}

@@ -1,7 +1,7 @@
 /**
  * This file was auto-generated by Fern from our API Definition.
  */
-export interface StyleGuideScore {
+export interface ConsistencyScore {
     score?: number;
     issues?: number;
 }

package/{api → dist/cjs/api}/types/Dialects.d.ts

@@ -1,9 +1,9 @@
 /**
  * This file was auto-generated by Fern from our API Definition.
  */
-export type Dialects = "american_english" | "british_oxford" | "canadian_english";
+export type Dialects = "american_english" | "british_english" | "canadian_english";
 export declare const Dialects: {
     readonly AmericanEnglish: "american_english";
-    readonly BritishOxford: "british_oxford";
+    readonly BritishEnglish: "british_english";
     readonly CanadianEnglish: "canadian_english";
 };

package/{api → dist/cjs/api}/types/Dialects.js

@@ -6,6 +6,6 @@ Object.defineProperty(exports, "__esModule", { value: true });
 exports.Dialects = void 0;
 exports.Dialects = {
     AmericanEnglish: "american_english",
-    BritishOxford: "british_oxford",
+    BritishEnglish: "british_english",
     CanadianEnglish: "canadian_english",
 };

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

@@ -0,0 +1,14 @@
+/**
+ * This file was auto-generated by Fern from our API Definition.
+ */
+export type GrammarCategory = "Grammar Agreement" | "Punctuation" | "Capitalization" | "Spelling" | "Sentence Structure" | "Verb Forms" | "Context Fit" | "other";
+export declare const GrammarCategory: {
+    readonly GrammarAgreement: "Grammar Agreement";
+    readonly Punctuation: "Punctuation";
+    readonly Capitalization: "Capitalization";
+    readonly Spelling: "Spelling";
+    readonly SentenceStructure: "Sentence Structure";
+    readonly VerbForms: "Verb Forms";
+    readonly ContextFit: "Context Fit";
+    readonly Other: "other";
+};

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

@@ -0,0 +1,16 @@
+"use strict";
+/**
+ * This file was auto-generated by Fern from our API Definition.
+ */
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.GrammarCategory = void 0;
+exports.GrammarCategory = {
+    GrammarAgreement: "Grammar Agreement",
+    Punctuation: "Punctuation",
+    Capitalization: "Capitalization",
+    Spelling: "Spelling",
+    SentenceStructure: "Sentence Structure",
+    VerbForms: "Verb Forms",
+    ContextFit: "Context Fit",
+    Other: "other",
+};

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

@@ -0,0 +1,19 @@
+/**
+ * This file was auto-generated by Fern from our API Definition.
+ */
+import * as MarkupAI from "../index.js";
+export interface Issue {
+    /** The original text */
+    original: string;
+    /** Position details of the issue */
+    position: MarkupAI.Position;
+    /** The sub-category of the change */
+    subcategory: Issue.Subcategory;
+    category?: MarkupAI.IssueCategory;
+}
+export declare namespace Issue {
+    /**
+     * The sub-category of the change
+     */
+    type Subcategory = MarkupAI.GrammarCategory | MarkupAI.ClarityCategory | MarkupAI.ToneCategory | MarkupAI.ConsistencyCategory | MarkupAI.TermReplaceCategory;
+}

package/dist/{api → cjs/api}/types/IssueCategory.d.ts

@@ -1,11 +1,11 @@
 /**
  * This file was auto-generated by Fern from our API Definition.
  */
-export type IssueCategory = "clarity" | "grammar" | "style_guide" | "terminology" | "tone";
+export type IssueCategory = "clarity" | "grammar" | "consistency" | "terminology" | "tone";
 export declare const IssueCategory: {
     readonly Clarity: "clarity";
     readonly Grammar: "grammar";
-    readonly StyleGuide: "style_guide";
+    readonly Consistency: "consistency";
     readonly Terminology: "terminology";
     readonly Tone: "tone";
 };

package/dist/{api → cjs/api}/types/IssueCategory.js

@@ -7,7 +7,7 @@ exports.IssueCategory = void 0;
 exports.IssueCategory = {
     Clarity: "clarity",
     Grammar: "grammar",
-    StyleGuide: "style_guide",
+    Consistency: "consistency",
     Terminology: "terminology",
     Tone: "tone",
 };

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

@@ -0,0 +1,8 @@
+/**
+ * This file was auto-generated by Fern from our API Definition.
+ */
+import * as MarkupAI from "../index.js";
+export interface OriginalContent {
+    issues?: MarkupAI.Issue[];
+    scores?: MarkupAI.ScoreOutput;
+}

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

@@ -0,0 +1,7 @@
+/**
+ * This file was auto-generated by Fern from our API Definition.
+ */
+export interface Position {
+    /** The start index of the issue in the text */
+    start_index: number;
+}

package/dist/{api → cjs/api}/types/QualityScore.d.ts

@@ -1,10 +1,10 @@
 /**
  * This file was auto-generated by Fern from our API Definition.
  */
-import * as MarkupAI from "../index";
+import * as MarkupAI from "../index.js";
 export interface QualityScore {
     score?: number;
     grammar?: MarkupAI.GrammarScore;
-    style_guide?: MarkupAI.StyleGuideScore;
+    consistency?: MarkupAI.ConsistencyScore;
     terminology?: MarkupAI.TerminologyScore;
 }

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

@@ -0,0 +1,8 @@
+/**
+ * This file was auto-generated by Fern from our API Definition.
+ */
+import * as MarkupAI from "../index.js";
+export interface RewriteContent {
+    text?: string;
+    scores?: MarkupAI.ScoreOutput;
+}

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

@@ -0,0 +1,10 @@
+/**
+ * This file was auto-generated by Fern from our API Definition.
+ */
+import * as MarkupAI from "../index.js";
+export interface RewriteResponse {
+    config?: MarkupAI.ConfigOptions;
+    original?: MarkupAI.SuggestionOriginalContent;
+    rewrite?: MarkupAI.RewriteContent;
+    workflow: MarkupAI.WorkflowInfo;
+}

package/dist/{api → cjs/api}/types/ScoreOutput.d.ts

@@ -1,7 +1,7 @@
 /**
  * This file was auto-generated by Fern from our API Definition.
  */
-import * as MarkupAI from "../index";
+import * as MarkupAI from "../index.js";
 export interface ScoreOutput {
     quality?: MarkupAI.QualityScore;
     analysis?: MarkupAI.AnalysisScore;

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

@@ -0,0 +1,9 @@
+/**
+ * This file was auto-generated by Fern from our API Definition.
+ */
+import * as MarkupAI from "../index.js";
+export interface StyleCheckResponse {
+    config?: MarkupAI.ConfigOptions;
+    original?: MarkupAI.OriginalContent;
+    workflow: MarkupAI.WorkflowInfo;
+}

package/{api → dist/cjs/api}/types/StyleGuide.d.ts

@@ -1,7 +1,7 @@
 /**
  * This file was auto-generated by Fern from our API Definition.
  */
-import * as MarkupAI from "../index";
+import * as MarkupAI from "../index.js";
 export interface StyleGuide {
     /** The type of style guide to use */
     style_guide_type?: MarkupAI.StyleGuides;

package/dist/{api → cjs/api}/types/StyleGuideResponse.d.ts

@@ -1,7 +1,7 @@
 /**
  * This file was auto-generated by Fern from our API Definition.
  */
-import * as MarkupAI from "../index";
+import * as MarkupAI from "../index.js";
 export interface StyleGuideResponse {
     id: string;
     /** The name of the style guide. */
@@ -16,4 +16,6 @@ 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. */
+    summary?: string;
 }

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

@@ -0,0 +1,21 @@
+/**
+ * This file was auto-generated by Fern from our API Definition.
+ */
+import * as MarkupAI from "../index.js";
+export interface Suggestion {
+    /** The original text */
+    original: string;
+    /** Position details of the issue */
+    position: MarkupAI.Position;
+    /** The sub-category of the change */
+    subcategory: Suggestion.Subcategory;
+    /** The suggested replacement text */
+    suggestion: string;
+    category?: MarkupAI.IssueCategory;
+}
+export declare namespace Suggestion {
+    /**
+     * The sub-category of the change
+     */
+    type Subcategory = MarkupAI.GrammarCategory | MarkupAI.ClarityCategory | MarkupAI.ToneCategory | MarkupAI.ConsistencyCategory | MarkupAI.TermReplaceCategory;
+}

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

@@ -0,0 +1,8 @@
+/**
+ * This file was auto-generated by Fern from our API Definition.
+ */
+import * as MarkupAI from "../index.js";
+export interface SuggestionOriginalContent {
+    issues?: MarkupAI.Suggestion[];
+    scores?: MarkupAI.ScoreOutput;
+}

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

@@ -0,0 +1,9 @@
+/**
+ * This file was auto-generated by Fern from our API Definition.
+ */
+import * as MarkupAI from "../index.js";
+export interface SuggestionResponse {
+    config?: MarkupAI.ConfigOptions;
+    original?: MarkupAI.SuggestionOriginalContent;
+    workflow: MarkupAI.WorkflowInfo;
+}

package/{api → dist/cjs/api}/types/TermReplaceCategory.d.ts

@@ -1,8 +1,8 @@
 /**
  * This file was auto-generated by Fern from our API Definition.
  */
-export type TermReplaceCategory = "term" | "other";
+export type TermReplaceCategory = "Terminology" | "other";
 export declare const TermReplaceCategory: {
-    readonly Term: "term";
+    readonly Terminology: "Terminology";
     readonly Other: "other";
 };

package/{api → dist/cjs/api}/types/TermReplaceCategory.js

@@ -5,6 +5,6 @@
 Object.defineProperty(exports, "__esModule", { value: true });
 exports.TermReplaceCategory = void 0;
 exports.TermReplaceCategory = {
-    Term: "term",
+    Terminology: "Terminology",
     Other: "other",
 };

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

@@ -0,0 +1,12 @@
+/**
+ * This file was auto-generated by Fern from our API Definition.
+ */
+export type ToneCategory = "Tone-Aligned Wording" | "Tone-Shaping Structure" | "Tone-Signal Punctuation" | "Transitions and Flow" | "Additional Tone Changes" | "other";
+export declare const ToneCategory: {
+    readonly ToneAlignedWording: "Tone-Aligned Wording";
+    readonly ToneShapingStructure: "Tone-Shaping Structure";
+    readonly ToneSignalPunctuation: "Tone-Signal Punctuation";
+    readonly TransitionsAndFlow: "Transitions and Flow";
+    readonly AdditionalToneChanges: "Additional Tone Changes";
+    readonly Other: "other";
+};

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

@@ -0,0 +1,14 @@
+"use strict";
+/**
+ * This file was auto-generated by Fern from our API Definition.
+ */
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.ToneCategory = void 0;
+exports.ToneCategory = {
+    ToneAlignedWording: "Tone-Aligned Wording",
+    ToneShapingStructure: "Tone-Shaping Structure",
+    ToneSignalPunctuation: "Tone-Signal Punctuation",
+    TransitionsAndFlow: "Transitions and Flow",
+    AdditionalToneChanges: "Additional Tone Changes",
+    Other: "other",
+};

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

@@ -0,0 +1,14 @@
+/**
+ * This file was auto-generated by Fern from our API Definition.
+ */
+export type Tones = "academic" | "confident" | "conversational" | "empathetic" | "engaging" | "friendly" | "professional" | "technical";
+export declare const Tones: {
+    readonly Academic: "academic";
+    readonly Confident: "confident";
+    readonly Conversational: "conversational";
+    readonly Empathetic: "empathetic";
+    readonly Engaging: "engaging";
+    readonly Friendly: "friendly";
+    readonly Professional: "professional";
+    readonly Technical: "technical";
+};

package/{api → dist/cjs/api}/types/Tones.js

@@ -6,9 +6,11 @@ Object.defineProperty(exports, "__esModule", { value: true });
 exports.Tones = void 0;
 exports.Tones = {
     Academic: "academic",
-    Business: "business",
+    Confident: "confident",
     Conversational: "conversational",
-    Formal: "formal",
-    Informal: "informal",
+    Empathetic: "empathetic",
+    Engaging: "engaging",
+    Friendly: "friendly",
+    Professional: "professional",
     Technical: "technical",
 };

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

@@ -0,0 +1,17 @@
+/**
+ * This file was auto-generated by Fern from our API Definition.
+ */
+import * as MarkupAI from "../index.js";
+export interface WorkflowInfo {
+    /** Workflow ID */
+    id: string;
+    /** API version */
+    api_version?: string;
+    /** UTC timestamp when the result was generated */
+    generated_at?: string;
+    status?: MarkupAI.WorkflowStatus;
+    /** Workflow type: checks, suggestions, or rewrites */
+    type: string;
+    /** The status code received and URL used when sending the webhook if a webhook URL was included when starting the process. */
+    webhook_response?: MarkupAI.WebhookResponse;
+}

package/{api → dist/cjs/api}/types/WorkflowResponse.d.ts

@@ -1,7 +1,7 @@
 /**
  * This file was auto-generated by Fern from our API Definition.
  */
-import * as MarkupAI from "../index";
+import * as MarkupAI from "../index.js";
 export interface WorkflowResponse {
     status: MarkupAI.WorkflowStatus;
     workflow_id: string;