@markupai/api 0.0.6

package/dist/api/resources/styleSuggestions/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("./client"), exports);

package/dist/api/types/CheckOptions.d.ts

@@ -0,0 +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;
+    dialect?: MarkupAI.Dialects;
+    tone?: MarkupAI.Tones;
+}

package/dist/api/types/CheckOptions.js

@@ -0,0 +1,5 @@
+"use strict";
+/**
+ * This file was auto-generated by Fern from our API Definition.
+ */
+Object.defineProperty(exports, "__esModule", { value: true });

package/dist/api/types/ClarityScore.d.ts

@@ -0,0 +1,14 @@
+/**
+ * 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;
+    sentence_complexity?: number;
+    sentence_count?: number;
+    vocabulary_complexity?: number;
+    word_count?: number;
+}

package/dist/api/types/ClarityScore.js

@@ -0,0 +1,5 @@
+"use strict";
+/**
+ * This file was auto-generated by Fern from our API Definition.
+ */
+Object.defineProperty(exports, "__esModule", { value: true });

package/dist/api/types/Dialects.d.ts

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

package/dist/api/types/Dialects.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.Dialects = void 0;
+exports.Dialects = {
+    AmericanEnglish: "american_english",
+    BritishOxford: "british_oxford",
+    CanadianEnglish: "canadian_english",
+};

package/dist/api/types/ErrorResponse.d.ts

@@ -0,0 +1,11 @@
+/**
+ * This file was auto-generated by Fern from our API Definition.
+ */
+export interface ErrorResponse {
+    /** A description of the error that occurred. */
+    detail: string;
+    /** 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/api/types/ErrorResponse.js

@@ -0,0 +1,5 @@
+"use strict";
+/**
+ * This file was auto-generated by Fern from our API Definition.
+ */
+Object.defineProperty(exports, "__esModule", { value: true });

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

@@ -0,0 +1,13 @@
+/**
+ * This file was auto-generated by Fern from our API Definition.
+ */
+export type GrammarCategory = "sva_pronoun" | "punct_cap" | "spelling" | "syntax" | "verbs" | "word_usage" | "other";
+export declare const GrammarCategory: {
+    readonly SvaPronoun: "sva_pronoun";
+    readonly PunctCap: "punct_cap";
+    readonly Spelling: "spelling";
+    readonly Syntax: "syntax";
+    readonly Verbs: "verbs";
+    readonly WordUsage: "word_usage";
+    readonly Other: "other";
+};

package/dist/api/types/GrammarCategory.js

@@ -0,0 +1,15 @@
+"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 = {
+    SvaPronoun: "sva_pronoun",
+    PunctCap: "punct_cap",
+    Spelling: "spelling",
+    Syntax: "syntax",
+    Verbs: "verbs",
+    WordUsage: "word_usage",
+    Other: "other",
+};

package/dist/api/types/GrammarScore.d.ts

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

package/dist/api/types/GrammarScore.js

@@ -0,0 +1,5 @@
+"use strict";
+/**
+ * This file was auto-generated by Fern from our API Definition.
+ */
+Object.defineProperty(exports, "__esModule", { value: true });

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

@@ -0,0 +1,13 @@
+/**
+ * This file was auto-generated by Fern from our API Definition.
+ */
+import * as MarkupAI from "../index";
+export interface Issue {
+    /** The original text */
+    original: string;
+    /** The start index of the change */
+    char_index: number;
+    /** The sub-category of the change */
+    subcategory: MarkupAI.Subcategory;
+    category?: MarkupAI.IssueCategory;
+}

package/dist/api/types/Issue.js

@@ -0,0 +1,5 @@
+"use strict";
+/**
+ * This file was auto-generated by Fern from our API Definition.
+ */
+Object.defineProperty(exports, "__esModule", { value: true });

package/dist/api/types/IssueCategory.d.ts

@@ -0,0 +1,13 @@
+/**
+ * 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 declare const IssueCategory: {
+    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/dist/api/types/IssueCategory.js

@@ -0,0 +1,15 @@
+"use strict";
+/**
+ * This file was auto-generated by Fern from our API Definition.
+ */
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.IssueCategory = void 0;
+exports.IssueCategory = {
+    Grammar: "grammar",
+    SentenceLength: "sentence_length",
+    SentenceStructure: "sentence_structure",
+    SimpleVocab: "simple_vocab",
+    StyleGuide: "style_guide",
+    Terminology: "terminology",
+    Tone: "tone",
+};

package/dist/api/types/QualityScore.d.ts

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

package/dist/api/types/QualityScore.js

@@ -0,0 +1,5 @@
+"use strict";
+/**
+ * This file was auto-generated by Fern from our API Definition.
+ */
+Object.defineProperty(exports, "__esModule", { value: true });

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

@@ -0,0 +1,15 @@
+/**
+ * This file was auto-generated by Fern from our API Definition.
+ */
+import * as MarkupAI from "../index";
+export interface RewriteResponse {
+    workflow_id?: string;
+    status?: MarkupAI.WorkflowStatus;
+    scores?: MarkupAI.ScoreOutput;
+    issues?: MarkupAI.Suggestion[];
+    check_options?: MarkupAI.CheckOptions;
+    /** 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;
+    rewrite?: string;
+    rewrite_scores?: MarkupAI.ScoreOutput;
+}

package/dist/api/types/RewriteResponse.js

@@ -0,0 +1,5 @@
+"use strict";
+/**
+ * This file was auto-generated by Fern from our API Definition.
+ */
+Object.defineProperty(exports, "__esModule", { value: true });

package/dist/api/types/ScoreOutput.d.ts

@@ -0,0 +1,12 @@
+/**
+ * This file was auto-generated by Fern from our API Definition.
+ */
+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;
+}

package/dist/api/types/ScoreOutput.js

@@ -0,0 +1,5 @@
+"use strict";
+/**
+ * This file was auto-generated by Fern from our API Definition.
+ */
+Object.defineProperty(exports, "__esModule", { value: true });

package/dist/api/types/SentenceLengthCategory.d.ts

@@ -0,0 +1,13 @@
+/**
+ * This file was auto-generated by Fern from our API Definition.
+ */
+export type SentenceLengthCategory = "capitalization" | "remove" | "extract" | "shorten" | "deletion" | "replace" | "other";
+export declare const SentenceLengthCategory: {
+    readonly Capitalization: "capitalization";
+    readonly Remove: "remove";
+    readonly Extract: "extract";
+    readonly Shorten: "shorten";
+    readonly Deletion: "deletion";
+    readonly Replace: "replace";
+    readonly Other: "other";
+};

package/dist/api/types/SentenceLengthCategory.js

@@ -0,0 +1,15 @@
+"use strict";
+/**
+ * This file was auto-generated by Fern from our API Definition.
+ */
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.SentenceLengthCategory = void 0;
+exports.SentenceLengthCategory = {
+    Capitalization: "capitalization",
+    Remove: "remove",
+    Extract: "extract",
+    Shorten: "shorten",
+    Deletion: "deletion",
+    Replace: "replace",
+    Other: "other",
+};

package/dist/api/types/SentenceStructureCategory.d.ts

@@ -0,0 +1,14 @@
+/**
+ * This file was auto-generated by Fern from our API Definition.
+ */
+export type SentenceStructureCategory = "complex_verbs" | "hidden_verbs" | "insertion" | "modal_verbs" | "passive" | "phrasal_verbs" | "subjunctive" | "other";
+export declare const SentenceStructureCategory: {
+    readonly ComplexVerbs: "complex_verbs";
+    readonly HiddenVerbs: "hidden_verbs";
+    readonly Insertion: "insertion";
+    readonly ModalVerbs: "modal_verbs";
+    readonly Passive: "passive";
+    readonly PhrasalVerbs: "phrasal_verbs";
+    readonly Subjunctive: "subjunctive";
+    readonly Other: "other";
+};

package/dist/api/types/SentenceStructureCategory.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.SentenceStructureCategory = void 0;
+exports.SentenceStructureCategory = {
+    ComplexVerbs: "complex_verbs",
+    HiddenVerbs: "hidden_verbs",
+    Insertion: "insertion",
+    ModalVerbs: "modal_verbs",
+    Passive: "passive",
+    PhrasalVerbs: "phrasal_verbs",
+    Subjunctive: "subjunctive",
+    Other: "other",
+};

package/dist/api/types/SimpleVocabCategory.d.ts

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

package/dist/api/types/SimpleVocabCategory.js

@@ -0,0 +1,10 @@
+"use strict";
+/**
+ * This file was auto-generated by Fern from our API Definition.
+ */
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.SimpleVocabCategory = void 0;
+exports.SimpleVocabCategory = {
+    Vocabulary: "vocabulary",
+    Other: "other",
+};

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

@@ -0,0 +1,13 @@
+/**
+ * This file was auto-generated by Fern from our API Definition.
+ */
+import * as MarkupAI from "../index";
+export interface StyleCheckResponse {
+    workflow_id?: string;
+    status?: MarkupAI.WorkflowStatus;
+    scores?: MarkupAI.ScoreOutput;
+    issues?: MarkupAI.Issue[];
+    check_options?: MarkupAI.CheckOptions;
+    /** 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/api/types/StyleCheckResponse.js

@@ -0,0 +1,5 @@
+"use strict";
+/**
+ * This file was auto-generated by Fern from our API Definition.
+ */
+Object.defineProperty(exports, "__esModule", { value: true });

package/dist/api/types/StyleGuide.d.ts

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

package/dist/api/types/StyleGuide.js

@@ -0,0 +1,5 @@
+"use strict";
+/**
+ * This file was auto-generated by Fern from our API Definition.
+ */
+Object.defineProperty(exports, "__esModule", { value: true });

package/dist/api/types/StyleGuideCategory.d.ts

@@ -0,0 +1,15 @@
+/**
+ * This file was auto-generated by Fern from our API Definition.
+ */
+export type StyleGuideCategory = "punctuation" | "capitalization" | "spelling_and_grammar" | "numbers_dates_times" | "inclusive_language" | "tone" | "specific_conventions" | "clarity_and_readability" | "other";
+export declare const StyleGuideCategory: {
+    readonly Punctuation: "punctuation";
+    readonly Capitalization: "capitalization";
+    readonly SpellingAndGrammar: "spelling_and_grammar";
+    readonly NumbersDatesTimes: "numbers_dates_times";
+    readonly InclusiveLanguage: "inclusive_language";
+    readonly Tone: "tone";
+    readonly SpecificConventions: "specific_conventions";
+    readonly ClarityAndReadability: "clarity_and_readability";
+    readonly Other: "other";
+};

package/dist/api/types/StyleGuideCategory.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.StyleGuideCategory = void 0;
+exports.StyleGuideCategory = {
+    Punctuation: "punctuation",
+    Capitalization: "capitalization",
+    SpellingAndGrammar: "spelling_and_grammar",
+    NumbersDatesTimes: "numbers_dates_times",
+    InclusiveLanguage: "inclusive_language",
+    Tone: "tone",
+    SpecificConventions: "specific_conventions",
+    ClarityAndReadability: "clarity_and_readability",
+    Other: "other",
+};

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

@@ -0,0 +1,19 @@
+/**
+ * This file was auto-generated by Fern from our API Definition.
+ */
+import * as MarkupAI from "../index";
+export interface StyleGuideResponse {
+    id: string;
+    /** The name of the style guide. */
+    name: string;
+    /** The UTC date and time the style guide was created. */
+    created_at: string;
+    /** The ID of the user who created the style guide. */
+    created_by: string;
+    /** The status of the submitted style guide. */
+    status: MarkupAI.StyleGuideStatus;
+    /** The UTC datetime that the style guide was last updated. If null, the style guide has never been updated. */
+    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;
+}

package/dist/api/types/StyleGuideResponse.js

@@ -0,0 +1,5 @@
+"use strict";
+/**
+ * This file was auto-generated by Fern from our API Definition.
+ */
+Object.defineProperty(exports, "__esModule", { value: true });

package/dist/api/types/StyleGuideScore.d.ts

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

package/dist/api/types/StyleGuideScore.js

@@ -0,0 +1,5 @@
+"use strict";
+/**
+ * This file was auto-generated by Fern from our API Definition.
+ */
+Object.defineProperty(exports, "__esModule", { value: true });

package/dist/api/types/StyleGuideStatus.d.ts

@@ -0,0 +1,10 @@
+/**
+ * This file was auto-generated by Fern from our API Definition.
+ */
+export type StyleGuideStatus = "running" | "completed" | "failed" | "not_found";
+export declare const StyleGuideStatus: {
+    readonly Running: "running";
+    readonly Completed: "completed";
+    readonly Failed: "failed";
+    readonly NotFound: "not_found";
+};

package/dist/api/types/StyleGuideStatus.js

@@ -0,0 +1,12 @@
+"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 = {
+    Running: "running",
+    Completed: "completed",
+    Failed: "failed",
+    NotFound: "not_found",
+};

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

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

package/dist/api/types/StyleGuides.js

@@ -0,0 +1,13 @@
+"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 = {
+    Ap: "ap",
+    Chicago: "chicago",
+    Microsoft: "microsoft",
+    Demo: "demo",
+    StyleBrandImporter: "style_brand_importer",
+};

package/dist/api/types/Subcategory.d.ts

@@ -0,0 +1,8 @@
+/**
+ * This file was auto-generated by Fern from our API Definition.
+ */
+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;

package/dist/api/types/Subcategory.js

@@ -0,0 +1,5 @@
+"use strict";
+/**
+ * This file was auto-generated by Fern from our API Definition.
+ */
+Object.defineProperty(exports, "__esModule", { value: true });

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

@@ -0,0 +1,14 @@
+/**
+ * This file was auto-generated by Fern from our API Definition.
+ */
+import * as MarkupAI from "../index";
+export interface Suggestion {
+    /** The original text */
+    original: string;
+    /** The start index of the change */
+    char_index: number;
+    /** The sub-category of the change */
+    subcategory: MarkupAI.Subcategory;
+    suggestion: string;
+    category?: MarkupAI.IssueCategory;
+}

package/dist/api/types/Suggestion.js

@@ -0,0 +1,5 @@
+"use strict";
+/**
+ * This file was auto-generated by Fern from our API Definition.
+ */
+Object.defineProperty(exports, "__esModule", { value: true });

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

@@ -0,0 +1,13 @@
+/**
+ * This file was auto-generated by Fern from our API Definition.
+ */
+import * as MarkupAI from "../index";
+export interface SuggestionResponse {
+    workflow_id?: string;
+    status?: MarkupAI.WorkflowStatus;
+    scores?: MarkupAI.ScoreOutput;
+    issues?: MarkupAI.Suggestion[];
+    check_options?: MarkupAI.CheckOptions;
+    /** 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/api/types/SuggestionResponse.js

@@ -0,0 +1,5 @@
+"use strict";
+/**
+ * This file was auto-generated by Fern from our API Definition.
+ */
+Object.defineProperty(exports, "__esModule", { value: true });

package/dist/api/types/TermReplaceCategory.d.ts

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

package/dist/api/types/TermReplaceCategory.js

@@ -0,0 +1,10 @@
+"use strict";
+/**
+ * This file was auto-generated by Fern from our API Definition.
+ */
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.TermReplaceCategory = void 0;
+exports.TermReplaceCategory = {
+    Term: "term",
+    Other: "other",
+};

package/dist/api/types/TerminologyScore.d.ts

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

package/dist/api/types/TerminologyScore.js

@@ -0,0 +1,5 @@
+"use strict";
+/**
+ * This file was auto-generated by Fern from our API Definition.
+ */
+Object.defineProperty(exports, "__esModule", { value: true });

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

@@ -0,0 +1,12 @@
+/**
+ * This file was auto-generated by Fern from our API Definition.
+ */
+export type ToneCategory = "word_choice" | "syntax" | "punctuation" | "discourse_features" | "implicit_style" | "other";
+export declare const ToneCategory: {
+    readonly WordChoice: "word_choice";
+    readonly Syntax: "syntax";
+    readonly Punctuation: "punctuation";
+    readonly DiscourseFeatures: "discourse_features";
+    readonly ImplicitStyle: "implicit_style";
+    readonly Other: "other";
+};