@markupai/api 0.0.6 → 0.1.1

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

@@ -62,12 +62,14 @@ class StyleRewrites {
         this._options = _options;
     }
     /**
-     * Start a style and brand rewrite workflow. Returns a workflow ID to use for polling results.
+     * Rewrite text with style corrections applied.
      *
      * @param {File | fs.ReadStream | Blob} file_upload
-     * @param {MarkupAI.StyleRewritesCreateStyleRewriteRequest} request
+     * @param {MarkupAI.CreateStyleRewriteV1StyleRewritesPostRequest} 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.InternalServerError}
@@ -75,7 +77,6 @@ class StyleRewrites {
      * @example
      *     await client.styleRewrites.createStyleRewrite(fs.createReadStream("/path/to/your/file"), {
      *         dialect: "american_english",
-     *         tone: "academic",
      *         style_guide: "style_guide"
      *     })
      */
@@ -88,16 +89,18 @@ class StyleRewrites {
             const _request = yield core.newFormData();
             yield _request.appendFile("file_upload", file_upload);
             _request.append("dialect", request.dialect);
-            _request.append("tone", request.tone);
+            if (request.tone != null) {
+                _request.append("tone", request.tone);
+            }
             _request.append("style_guide", request.style_guide);
             if (request.webhook_url != null) {
                 _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.Production, "v1/style/rewrites"),
+                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/rewrites"),
                 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.0.6", "User-Agent": "@markupai/api/0.0.6", "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: 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),
                 requestType: "file",
                 duplex: _maybeEncodedRequest.duplex,
                 body: _maybeEncodedRequest.body,
@@ -110,6 +113,10 @@ class StyleRewrites {
             }
             if (_response.error.reason === "status-code") {
                 switch (_response.error.statusCode) {
+                    case 401:
+                        throw new MarkupAI.UnauthorizedError(_response.error.body, _response.rawResponse);
+                    case 403:
+                        throw new MarkupAI.ForbiddenError(_response.error.body, _response.rawResponse);
                     case 413:
                         throw new MarkupAI.ContentTooLargeError(_response.error.body, _response.rawResponse);
                     case 422:
@@ -142,11 +149,13 @@ class StyleRewrites {
         });
     }
     /**
-     * Retrieve the results of a rewrite workflow. Returns `running` or `complete` status.
+     * Retrieve rewrite results.
      *
      * @param {string} workflowId
      * @param {StyleRewrites.RequestOptions} requestOptions - Request-specific configuration.
      *
+     * @throws {@link MarkupAI.UnauthorizedError}
+     * @throws {@link MarkupAI.ForbiddenError}
      * @throws {@link MarkupAI.NotFoundError}
      * @throws {@link MarkupAI.UnprocessableEntityError}
      * @throws {@link MarkupAI.InternalServerError}
@@ -161,9 +170,9 @@ class StyleRewrites {
         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.Production, `v1/style/rewrites/${encodeURIComponent(workflowId)}`),
+                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/rewrites/${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.0.6", "User-Agent": "@markupai/api/0.0.6", "X-Fern-Runtime": core.RUNTIME.type, "X-Fern-Runtime-Version": core.RUNTIME.version }, requestOptions === null || requestOptions === void 0 ? void 0 : requestOptions.headers),
+                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",
                 timeoutMs: (requestOptions === null || requestOptions === void 0 ? void 0 : requestOptions.timeoutInSeconds) != null ? requestOptions.timeoutInSeconds * 1000 : 60000,
@@ -175,6 +184,10 @@ class StyleRewrites {
             }
             if (_response.error.reason === "status-code") {
                 switch (_response.error.statusCode) {
+                    case 401:
+                        throw new MarkupAI.UnauthorizedError(_response.error.body, _response.rawResponse);
+                    case 403:
+                        throw new MarkupAI.ForbiddenError(_response.error.body, _response.rawResponse);
                     case 404:
                         throw new MarkupAI.NotFoundError(_response.error.body, _response.rawResponse);
                     case 422:

package/{dist/api/resources/styleChecks/client/requests/StyleChecksCreateStyleCheckRequest.d.ts → api/resources/styleRewrites/client/requests/CreateStyleRewriteV1StyleRewritesPostRequest.d.ts}

@@ -6,15 +6,14 @@ import * as MarkupAI from "../../../../index";
  * @example
  *     {
  *         dialect: "american_english",
- *         tone: "academic",
  *         style_guide: "style_guide"
  *     }
  */
-export interface StyleChecksCreateStyleCheckRequest {
+export interface CreateStyleRewriteV1StyleRewritesPostRequest {
     /** 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. */
-    tone: MarkupAI.Tones;
+    tone?: MarkupAI.Tones;
     /** The style guide to follow for your content. You can use a style guide ID or choose from built-in options: `ap`, `chicago`, or `microsoft`. */
     style_guide: string;
     /** A URL that results will be POSTed to once the process completes. */

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

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

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

@@ -32,12 +32,14 @@ export declare class StyleSuggestions {
     protected readonly _options: StyleSuggestions.Options;
     constructor(_options: StyleSuggestions.Options);
     /**
-     * Start a style and brand suggestion workflow. Returns a workflow ID to use for polling results.
+     * Get suggested corrections for text.
      *
      * @param {File | fs.ReadStream | Blob} file_upload
-     * @param {MarkupAI.StyleSuggestionsCreateStyleSuggestionRequest} request
+     * @param {MarkupAI.CreateStyleSuggestionV1StyleSuggestionsPostRequest} 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.InternalServerError}
@@ -45,18 +47,19 @@ export declare class StyleSuggestions {
      * @example
      *     await client.styleSuggestions.createStyleSuggestion(fs.createReadStream("/path/to/your/file"), {
      *         dialect: "american_english",
-     *         tone: "academic",
      *         style_guide: "style_guide"
      *     })
      */
-    createStyleSuggestion(file_upload: File | fs.ReadStream | Blob, request: MarkupAI.StyleSuggestionsCreateStyleSuggestionRequest, requestOptions?: StyleSuggestions.RequestOptions): core.HttpResponsePromise<MarkupAI.WorkflowResponse>;
+    createStyleSuggestion(file_upload: File | fs.ReadStream | Blob, request: MarkupAI.CreateStyleSuggestionV1StyleSuggestionsPostRequest, requestOptions?: StyleSuggestions.RequestOptions): core.HttpResponsePromise<MarkupAI.WorkflowResponse>;
     private __createStyleSuggestion;
     /**
-     * Retrieve the results of a style and brand suggestion workflow. Returns `running` or `complete` status.
+     * Retrieve suggestion results.
      *
      * @param {string} workflowId
      * @param {StyleSuggestions.RequestOptions} requestOptions - Request-specific configuration.
      *
+     * @throws {@link MarkupAI.UnauthorizedError}
+     * @throws {@link MarkupAI.ForbiddenError}
      * @throws {@link MarkupAI.NotFoundError}
      * @throws {@link MarkupAI.UnprocessableEntityError}
      * @throws {@link MarkupAI.InternalServerError}

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

@@ -62,12 +62,14 @@ class StyleSuggestions {
         this._options = _options;
     }
     /**
-     * Start a style and brand suggestion workflow. Returns a workflow ID to use for polling results.
+     * Get suggested corrections for text.
      *
      * @param {File | fs.ReadStream | Blob} file_upload
-     * @param {MarkupAI.StyleSuggestionsCreateStyleSuggestionRequest} request
+     * @param {MarkupAI.CreateStyleSuggestionV1StyleSuggestionsPostRequest} 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.InternalServerError}
@@ -75,7 +77,6 @@ class StyleSuggestions {
      * @example
      *     await client.styleSuggestions.createStyleSuggestion(fs.createReadStream("/path/to/your/file"), {
      *         dialect: "american_english",
-     *         tone: "academic",
      *         style_guide: "style_guide"
      *     })
      */
@@ -88,16 +89,18 @@ class StyleSuggestions {
             const _request = yield core.newFormData();
             yield _request.appendFile("file_upload", file_upload);
             _request.append("dialect", request.dialect);
-            _request.append("tone", request.tone);
+            if (request.tone != null) {
+                _request.append("tone", request.tone);
+            }
             _request.append("style_guide", request.style_guide);
             if (request.webhook_url != null) {
                 _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.Production, "v1/style/suggestions"),
+                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"),
                 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.0.6", "User-Agent": "@markupai/api/0.0.6", "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: 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),
                 requestType: "file",
                 duplex: _maybeEncodedRequest.duplex,
                 body: _maybeEncodedRequest.body,
@@ -110,6 +113,10 @@ class StyleSuggestions {
             }
             if (_response.error.reason === "status-code") {
                 switch (_response.error.statusCode) {
+                    case 401:
+                        throw new MarkupAI.UnauthorizedError(_response.error.body, _response.rawResponse);
+                    case 403:
+                        throw new MarkupAI.ForbiddenError(_response.error.body, _response.rawResponse);
                     case 413:
                         throw new MarkupAI.ContentTooLargeError(_response.error.body, _response.rawResponse);
                     case 422:
@@ -142,11 +149,13 @@ class StyleSuggestions {
         });
     }
     /**
-     * Retrieve the results of a style and brand suggestion workflow. Returns `running` or `complete` status.
+     * Retrieve suggestion results.
      *
      * @param {string} workflowId
      * @param {StyleSuggestions.RequestOptions} requestOptions - Request-specific configuration.
      *
+     * @throws {@link MarkupAI.UnauthorizedError}
+     * @throws {@link MarkupAI.ForbiddenError}
      * @throws {@link MarkupAI.NotFoundError}
      * @throws {@link MarkupAI.UnprocessableEntityError}
      * @throws {@link MarkupAI.InternalServerError}
@@ -161,9 +170,9 @@ class StyleSuggestions {
         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.Production, `v1/style/suggestions/${encodeURIComponent(workflowId)}`),
+                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)}`),
                 method: "GET",
-                headers: Object.assign({ Authorization: yield this._getAuthorizationHeader(), "X-Fern-Language": "JavaScript", "X-Fern-SDK-Name": "@markupai/api", "X-Fern-SDK-Version": "0.0.6", "User-Agent": "@markupai/api/0.0.6", "X-Fern-Runtime": core.RUNTIME.type, "X-Fern-Runtime-Version": core.RUNTIME.version }, requestOptions === null || requestOptions === void 0 ? void 0 : requestOptions.headers),
+                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",
                 timeoutMs: (requestOptions === null || requestOptions === void 0 ? void 0 : requestOptions.timeoutInSeconds) != null ? requestOptions.timeoutInSeconds * 1000 : 60000,
@@ -175,6 +184,10 @@ class StyleSuggestions {
             }
             if (_response.error.reason === "status-code") {
                 switch (_response.error.statusCode) {
+                    case 401:
+                        throw new MarkupAI.UnauthorizedError(_response.error.body, _response.rawResponse);
+                    case 403:
+                        throw new MarkupAI.ForbiddenError(_response.error.body, _response.rawResponse);
                     case 404:
                         throw new MarkupAI.NotFoundError(_response.error.body, _response.rawResponse);
                     case 422:

package/api/resources/{styleRewrites/client/requests/StyleRewritesCreateStyleRewriteRequest.d.ts → styleSuggestions/client/requests/CreateStyleSuggestionV1StyleSuggestionsPostRequest.d.ts}

@@ -6,15 +6,14 @@ import * as MarkupAI from "../../../../index";
  * @example
  *     {
  *         dialect: "american_english",
- *         tone: "academic",
  *         style_guide: "style_guide"
  *     }
  */
-export interface StyleRewritesCreateStyleRewriteRequest {
+export interface CreateStyleSuggestionV1StyleSuggestionsPostRequest {
     /** 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. */
-    tone: MarkupAI.Tones;
+    tone?: MarkupAI.Tones;
     /** The style guide to follow for your content. You can use a style guide ID or choose from built-in options: `ap`, `chicago`, or `microsoft`. */
     style_guide: string;
     /** A URL that results will be POSTed to once the process completes. */

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

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

package/api/types/AnalysisScore.d.ts

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

package/api/types/ClarityCategory.d.ts

@@ -0,0 +1,4 @@
+/**
+ * This file was auto-generated by Fern from our API Definition.
+ */
+export type ClarityCategory = "clarity";

package/api/types/ClarityScore.d.ts

@@ -2,13 +2,11 @@
  * This file was auto-generated by Fern from our API Definition.
  */
 export interface ClarityScore {
-    average_sentence_length?: number;
-    flesch_kincaid_grade?: number;
-    flesch_reading_ease?: number;
-    lexical_diversity?: number;
     score?: number;
+    flesch_reading_ease?: number;
     sentence_complexity?: number;
-    sentence_count?: number;
     vocabulary_complexity?: number;
+    sentence_count?: number;
     word_count?: number;
+    average_sentence_length?: number;
 }

package/api/types/ErrorResponse.d.ts

@@ -4,7 +4,7 @@
 export interface ErrorResponse {
     /** A description of the error that occurred. */
     detail: string;
-    /** the HTTP status code generated by the server for this issue */
+    /** The HTTP status code generated by the server for this issue */
     status: number;
     /** A unique ID associated with the HTTP request. */
     request_id: string;

package/api/types/IssueCategory.d.ts

@@ -1,12 +1,10 @@
 /**
  * This file was auto-generated by Fern from our API Definition.
  */
-export type IssueCategory = "grammar" | "sentence_length" | "sentence_structure" | "simple_vocab" | "style_guide" | "terminology" | "tone";
+export type IssueCategory = "clarity" | "grammar" | "style_guide" | "terminology" | "tone";
 export declare const IssueCategory: {
+    readonly Clarity: "clarity";
     readonly Grammar: "grammar";
-    readonly SentenceLength: "sentence_length";
-    readonly SentenceStructure: "sentence_structure";
-    readonly SimpleVocab: "simple_vocab";
     readonly StyleGuide: "style_guide";
     readonly Terminology: "terminology";
     readonly Tone: "tone";

package/api/types/IssueCategory.js

@@ -5,10 +5,8 @@
 Object.defineProperty(exports, "__esModule", { value: true });
 exports.IssueCategory = void 0;
 exports.IssueCategory = {
+    Clarity: "clarity",
     Grammar: "grammar",
-    SentenceLength: "sentence_length",
-    SentenceStructure: "sentence_structure",
-    SimpleVocab: "simple_vocab",
     StyleGuide: "style_guide",
     Terminology: "terminology",
     Tone: "tone",

package/api/types/QualityScore.d.ts

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

package/api/types/RewriteResponse.d.ts

@@ -3,7 +3,7 @@
  */
 import * as MarkupAI from "../index";
 export interface RewriteResponse {
-    workflow_id?: string;
+    workflow_id: string;
     status?: MarkupAI.WorkflowStatus;
     scores?: MarkupAI.ScoreOutput;
     issues?: MarkupAI.Suggestion[];

package/api/types/ScoreOutput.d.ts

@@ -4,9 +4,5 @@
 import * as MarkupAI from "../index";
 export interface ScoreOutput {
     quality?: MarkupAI.QualityScore;
-    clarity?: MarkupAI.ClarityScore;
-    grammar?: MarkupAI.GrammarScore;
-    style_guide?: MarkupAI.StyleGuideScore;
-    tone?: MarkupAI.ToneScore;
-    terminology?: MarkupAI.TerminologyScore;
+    analysis?: MarkupAI.AnalysisScore;
 }

package/api/types/StyleCheckResponse.d.ts

@@ -3,7 +3,7 @@
  */
 import * as MarkupAI from "../index";
 export interface StyleCheckResponse {
-    workflow_id?: string;
+    workflow_id: string;
     status?: MarkupAI.WorkflowStatus;
     scores?: MarkupAI.ScoreOutput;
     issues?: MarkupAI.Issue[];

package/api/types/Subcategory.d.ts

@@ -5,4 +5,4 @@ import * as MarkupAI from "../index";
 /**
  * The sub-category of the change
  */
-export type Subcategory = MarkupAI.GrammarCategory | MarkupAI.SimpleVocabCategory | MarkupAI.SentenceStructureCategory | MarkupAI.SentenceLengthCategory | MarkupAI.ToneCategory | MarkupAI.StyleGuideCategory | MarkupAI.TermReplaceCategory;
+export type Subcategory = MarkupAI.GrammarCategory | MarkupAI.SimpleVocabCategory | MarkupAI.SentenceStructureCategory | MarkupAI.SentenceLengthCategory | MarkupAI.ToneCategory | MarkupAI.StyleGuideCategory | MarkupAI.TermReplaceCategory | MarkupAI.ClarityCategory;

package/api/types/SuggestionResponse.d.ts

@@ -3,7 +3,7 @@
  */
 import * as MarkupAI from "../index";
 export interface SuggestionResponse {
-    workflow_id?: string;
+    workflow_id: string;
     status?: MarkupAI.WorkflowStatus;
     scores?: MarkupAI.ScoreOutput;
     issues?: MarkupAI.Suggestion[];

package/api/types/ToneScore.d.ts

@@ -5,8 +5,6 @@ export interface ToneScore {
     score?: number;
     informality?: number;
     liveliness?: number;
-    target_informality?: number;
-    target_liveliness?: number;
-    informality_tolerance?: number;
-    liveliness_tolerance?: number;
+    informality_alignment?: number;
+    liveliness_alignment?: number;
 }

package/api/types/index.d.ts

@@ -1,4 +1,6 @@
+export * from "./AnalysisScore";
 export * from "./CheckOptions";
+export * from "./ClarityCategory";
 export * from "./ClarityScore";
 export * from "./Dialects";
 export * from "./ErrorResponse";

package/api/types/index.js

@@ -14,7 +14,9 @@ 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("./AnalysisScore"), exports);
 __exportStar(require("./CheckOptions"), exports);
+__exportStar(require("./ClarityCategory"), exports);
 __exportStar(require("./ClarityScore"), exports);
 __exportStar(require("./Dialects"), exports);
 __exportStar(require("./ErrorResponse"), exports);

package/dist/api/errors/ContentTooLargeError.d.ts

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

package/dist/api/errors/UnauthorizedError.d.ts

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

package/dist/api/errors/UnauthorizedError.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.UnauthorizedError = void 0;
+const errors = __importStar(require("../../errors/index"));
+class UnauthorizedError extends errors.MarkupAIError {
+    constructor(body, rawResponse) {
+        super({
+            message: "UnauthorizedError",
+            statusCode: 401,
+            body: body,
+            rawResponse: rawResponse,
+        });
+        Object.setPrototypeOf(this, UnauthorizedError.prototype);
+    }
+}
+exports.UnauthorizedError = UnauthorizedError;

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

@@ -1,5 +1,6 @@
+export * from "./UnauthorizedError";
+export * from "./ForbiddenError";
 export * from "./UnprocessableEntityError";
 export * from "./InternalServerError";
-export * from "./ForbiddenError";
 export * from "./ContentTooLargeError";
 export * from "./NotFoundError";

package/dist/api/errors/index.js

@@ -14,8 +14,9 @@ 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("./UnauthorizedError"), exports);
+__exportStar(require("./ForbiddenError"), exports);
 __exportStar(require("./UnprocessableEntityError"), exports);
 __exportStar(require("./InternalServerError"), exports);
-__exportStar(require("./ForbiddenError"), exports);
 __exportStar(require("./ContentTooLargeError"), exports);
 __exportStar(require("./NotFoundError"), exports);

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

@@ -32,12 +32,14 @@ export declare class StyleChecks {
     protected readonly _options: StyleChecks.Options;
     constructor(_options: StyleChecks.Options);
     /**
-     * Start a style and brand check workflow. Returns a workflow ID to use for polling results.
+     * Analyze text for grammar, style, and clarity issues.
      *
      * @param {File | fs.ReadStream | Blob} file_upload
-     * @param {MarkupAI.StyleChecksCreateStyleCheckRequest} request
+     * @param {MarkupAI.CreateStyleCheckV1StyleChecksPostRequest} 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.InternalServerError}
@@ -45,18 +47,19 @@ export declare class StyleChecks {
      * @example
      *     await client.styleChecks.createStyleCheck(fs.createReadStream("/path/to/your/file"), {
      *         dialect: "american_english",
-     *         tone: "academic",
      *         style_guide: "style_guide"
      *     })
      */
-    createStyleCheck(file_upload: File | fs.ReadStream | Blob, request: MarkupAI.StyleChecksCreateStyleCheckRequest, requestOptions?: StyleChecks.RequestOptions): core.HttpResponsePromise<MarkupAI.WorkflowResponse>;
+    createStyleCheck(file_upload: File | fs.ReadStream | Blob, request: MarkupAI.CreateStyleCheckV1StyleChecksPostRequest, requestOptions?: StyleChecks.RequestOptions): core.HttpResponsePromise<MarkupAI.WorkflowResponse>;
     private __createStyleCheck;
     /**
-     * Retrieve the results of a style and brand check workflow. Returns `running` or `complete` status.
+     * Retrieve style check results.
      *
      * @param {string} workflowId
      * @param {StyleChecks.RequestOptions} requestOptions - Request-specific configuration.
      *
+     * @throws {@link MarkupAI.UnauthorizedError}
+     * @throws {@link MarkupAI.ForbiddenError}
      * @throws {@link MarkupAI.NotFoundError}
      * @throws {@link MarkupAI.UnprocessableEntityError}
      * @throws {@link MarkupAI.InternalServerError}