@markupai/api 0.0.6 → 0.2.0

package/dist/{api/types/ClarityScore.d.ts → esm/api/types/ClarityScore.d.mts}

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

@@ -0,0 +1,4 @@
+/**
+ * This file was auto-generated by Fern from our API Definition.
+ */
+export {};

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

@@ -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.mjs";
+export interface ConfigOptions {
     dialect?: MarkupAI.Dialects;
+    style_guide?: MarkupAI.StyleGuide;
     tone?: MarkupAI.Tones;
 }

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

@@ -0,0 +1,4 @@
+/**
+ * This file was auto-generated by Fern from our API Definition.
+ */
+export {};

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

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

@@ -0,0 +1,14 @@
+/**
+ * This file was auto-generated by Fern from our API Definition.
+ */
+export const 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/dist/esm/api/types/ConsistencyScore.d.mts

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

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

@@ -0,0 +1,4 @@
+/**
+ * This file was auto-generated by Fern from our API Definition.
+ */
+export {};

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

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

@@ -0,0 +1,8 @@
+/**
+ * This file was auto-generated by Fern from our API Definition.
+ */
+export const Dialects = {
+    AmericanEnglish: "american_english",
+    BritishEnglish: "british_english",
+    CanadianEnglish: "canadian_english",
+};

package/dist/{api/types/ErrorResponse.d.ts → esm/api/types/ErrorResponse.d.mts}

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

@@ -0,0 +1,4 @@
+/**
+ * This file was auto-generated by Fern from our API Definition.
+ */
+export {};

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

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

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

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

@@ -0,0 +1,4 @@
+/**
+ * This file was auto-generated by Fern from our API Definition.
+ */
+export {};

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

@@ -0,0 +1,19 @@
+/**
+ * This file was auto-generated by Fern from our API Definition.
+ */
+import * as MarkupAI from "../index.mjs";
+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/esm/api/types/Issue.mjs

@@ -0,0 +1,4 @@
+/**
+ * This file was auto-generated by Fern from our API Definition.
+ */
+export {};

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

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

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

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

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

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

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

@@ -0,0 +1,4 @@
+/**
+ * This file was auto-generated by Fern from our API Definition.
+ */
+export {};

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

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

@@ -0,0 +1,4 @@
+/**
+ * This file was auto-generated by Fern from our API Definition.
+ */
+export {};

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

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

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

@@ -0,0 +1,4 @@
+/**
+ * This file was auto-generated by Fern from our API Definition.
+ */
+export {};

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

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

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

@@ -0,0 +1,4 @@
+/**
+ * This file was auto-generated by Fern from our API Definition.
+ */
+export {};

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

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

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

@@ -0,0 +1,4 @@
+/**
+ * This file was auto-generated by Fern from our API Definition.
+ */
+export {};

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

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

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

@@ -0,0 +1,4 @@
+/**
+ * This file was auto-generated by Fern from our API Definition.
+ */
+export {};

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

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

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

@@ -0,0 +1,4 @@
+/**
+ * This file was auto-generated by Fern from our API Definition.
+ */
+export {};

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

@@ -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.mjs";
 export interface StyleGuide {
     /** The type of style guide to use */
     style_guide_type?: MarkupAI.StyleGuides;

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

@@ -0,0 +1,4 @@
+/**
+ * This file was auto-generated by Fern from our API Definition.
+ */
+export {};

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

@@ -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.mjs";
 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;
+    /** The prompt used to apply a style guide to a document. This should not be displayed to the user. */
+    prompt: string;
 }

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

@@ -0,0 +1,4 @@
+/**
+ * This file was auto-generated by Fern from our API Definition.
+ */
+export {};

package/dist/{api/types/WorkflowStatus.js → esm/api/types/StyleGuideStatus.mjs}

@@ -1,10 +1,7 @@
-"use strict";
 /**
  * This file was auto-generated by Fern from our API Definition.
  */
-Object.defineProperty(exports, "__esModule", { value: true });
-exports.WorkflowStatus = void 0;
-exports.WorkflowStatus = {
+export const StyleGuideStatus = {
     Running: "running",
     Completed: "completed",
     Failed: "failed",

package/dist/{api/types/StyleGuides.js → esm/api/types/StyleGuides.mjs}

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

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

@@ -0,0 +1,21 @@
+/**
+ * This file was auto-generated by Fern from our API Definition.
+ */
+import * as MarkupAI from "../index.mjs";
+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/esm/api/types/Suggestion.mjs

@@ -0,0 +1,4 @@
+/**
+ * This file was auto-generated by Fern from our API Definition.
+ */
+export {};

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

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

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

@@ -0,0 +1,4 @@
+/**
+ * This file was auto-generated by Fern from our API Definition.
+ */
+export {};

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

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

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

@@ -0,0 +1,4 @@
+/**
+ * This file was auto-generated by Fern from our API Definition.
+ */
+export {};

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

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

@@ -0,0 +1,7 @@
+/**
+ * This file was auto-generated by Fern from our API Definition.
+ */
+export const TermReplaceCategory = {
+    Terminology: "Terminology",
+    Other: "other",
+};

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

@@ -0,0 +1,4 @@
+/**
+ * This file was auto-generated by Fern from our API Definition.
+ */
+export {};

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

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

@@ -0,0 +1,11 @@
+/**
+ * This file was auto-generated by Fern from our API Definition.
+ */
+export const 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/{api/types/ToneScore.d.ts → esm/api/types/ToneScore.d.mts}

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

@@ -0,0 +1,4 @@
+/**
+ * This file was auto-generated by Fern from our API Definition.
+ */
+export {};

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

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

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

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

@@ -0,0 +1,4 @@
+/**
+ * This file was auto-generated by Fern from our API Definition.
+ */
+export {};

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

@@ -0,0 +1,17 @@
+/**
+ * This file was auto-generated by Fern from our API Definition.
+ */
+import * as MarkupAI from "../index.mjs";
+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/dist/esm/api/types/WorkflowInfo.mjs

@@ -0,0 +1,4 @@
+/**
+ * This file was auto-generated by Fern from our API Definition.
+ */
+export {};

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

@@ -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.mjs";
 export interface WorkflowResponse {
     status: MarkupAI.WorkflowStatus;
     workflow_id: string;

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

@@ -0,0 +1,4 @@
+/**
+ * This file was auto-generated by Fern from our API Definition.
+ */
+export {};

package/dist/{api/types/StyleGuideStatus.js → esm/api/types/WorkflowStatus.mjs}

@@ -1,10 +1,7 @@
-"use strict";
 /**
  * This file was auto-generated by Fern from our API Definition.
  */
-Object.defineProperty(exports, "__esModule", { value: true });
-exports.StyleGuideStatus = void 0;
-exports.StyleGuideStatus = {
+export const WorkflowStatus = {
     Running: "running",
     Completed: "completed",
     Failed: "failed",