@markupai/api 1.1.0 → 1.3.0

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

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

package/dist/cjs/api/resources/terminology/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/dist/cjs/api/resources/terminology/client/requests/BodyTerminologyImportTerminology.d.ts

@@ -0,0 +1,17 @@
+/**
+ * This file was auto-generated by Fern from our API Definition.
+ */
+import * as core from "../../../../../core/index.js";
+/**
+ * @example
+ *     {
+ *         file: fs.createReadStream("/path/to/your/file"),
+ *         delete_existing: true
+ *     }
+ */
+export interface BodyTerminologyImportTerminology {
+    /** Delete all existing terms, term sets and domains before importing */
+    delete_existing?: boolean;
+    /** CSV or ACTIF XML file containing terminology data */
+    file: core.file.Uploadable.FileLike;
+}

package/dist/cjs/api/resources/terminology/client/requests/BodyTerminologyImportTerminology.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/cjs/api/resources/{styleGuides/client/requests/BodyUpdateStyleGuideV1StyleGuidesStyleGuideIdPatch.d.ts → terminology/client/requests/DomainCreateRequest.d.ts}

@@ -7,7 +7,7 @@
  *         name: "name"
  *     }
  */
-export interface BodyUpdateStyleGuideV1StyleGuidesStyleGuideIdPatch {
-    /** The name of the style guide. */
+export interface DomainCreateRequest {
     name: string;
+    description?: string;
 }

package/dist/cjs/api/resources/terminology/client/requests/DomainCreateRequest.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/cjs/api/resources/terminology/client/requests/DomainUpdateRequest.d.ts

@@ -0,0 +1,11 @@
+/**
+ * This file was auto-generated by Fern from our API Definition.
+ */
+/**
+ * @example
+ *     {}
+ */
+export interface DomainUpdateRequest {
+    name?: string;
+    description?: string;
+}

package/dist/cjs/api/resources/terminology/client/requests/DomainUpdateRequest.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/cjs/api/resources/terminology/client/requests/TermSetCreateRequest.d.ts

@@ -0,0 +1,15 @@
+/**
+ * This file was auto-generated by Fern from our API Definition.
+ */
+import * as MarkupAI from "../../../../index.js";
+/**
+ * @example
+ *     {
+ *         instructions: "instructions"
+ *     }
+ */
+export interface TermSetCreateRequest {
+    instructions: string;
+    terms?: MarkupAI.TermCreateRequest[];
+    domain_ids?: string[];
+}

package/dist/cjs/api/resources/terminology/client/requests/TermSetCreateRequest.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/cjs/api/resources/terminology/client/requests/TermSetUpdateRequest.d.ts

@@ -0,0 +1,11 @@
+/**
+ * This file was auto-generated by Fern from our API Definition.
+ */
+/**
+ * @example
+ *     {}
+ */
+export interface TermSetUpdateRequest {
+    instructions?: string;
+    domain_ids?: string[];
+}

package/dist/cjs/api/resources/terminology/client/requests/TermSetUpdateRequest.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/cjs/api/resources/terminology/client/requests/TermUpdateRequest.d.ts

@@ -0,0 +1,15 @@
+/**
+ * This file was auto-generated by Fern from our API Definition.
+ */
+import * as MarkupAI from "../../../../index.js";
+/**
+ * @example
+ *     {
+ *         term: "term",
+ *         type: "preferred"
+ *     }
+ */
+export interface TermUpdateRequest {
+    term: string;
+    type: MarkupAI.TermType;
+}

package/dist/cjs/api/resources/terminology/client/requests/TermUpdateRequest.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/cjs/api/resources/terminology/client/requests/TerminologyListDomainsRequest.d.ts

@@ -0,0 +1,19 @@
+/**
+ * This file was auto-generated by Fern from our API Definition.
+ */
+/**
+ * @example
+ *     {
+ *         page: 1,
+ *         page_size: 1,
+ *         search: "search"
+ *     }
+ */
+export interface TerminologyListDomainsRequest {
+    /** Page number (1-based) */
+    page?: number;
+    /** Number of items per page */
+    page_size?: number;
+    /** Optional name filter */
+    search?: string;
+}

package/dist/cjs/api/resources/terminology/client/requests/TerminologyListDomainsRequest.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/cjs/api/resources/terminology/client/requests/TerminologyListTermSetsRequest.d.ts

@@ -0,0 +1,21 @@
+/**
+ * This file was auto-generated by Fern from our API Definition.
+ */
+/**
+ * @example
+ *     {
+ *         page: 1,
+ *         page_size: 1,
+ *         search_term: "search_term"
+ *     }
+ */
+export interface TerminologyListTermSetsRequest {
+    /** Page number (1-based) */
+    page?: number;
+    /** Number of items per page */
+    page_size?: number;
+    /** Optional search term to filter term sets */
+    search_term?: string;
+    /** Optional domain filter (any of these domains) */
+    domain_ids?: string | string[];
+}

package/dist/cjs/api/resources/terminology/client/requests/TerminologyListTermSetsRequest.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/cjs/api/resources/terminology/client/requests/TerminologySearchTerminologyRequest.d.ts

@@ -0,0 +1,14 @@
+/**
+ * This file was auto-generated by Fern from our API Definition.
+ */
+/**
+ * @example
+ *     {
+ *         query: "query"
+ *     }
+ */
+export interface TerminologySearchTerminologyRequest {
+    query: string;
+    /** Optional domain filter */
+    domain_ids?: string | string[];
+}

package/dist/cjs/api/resources/terminology/client/requests/TerminologySearchTerminologyRequest.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/cjs/api/resources/terminology/client/requests/index.d.ts

@@ -0,0 +1,9 @@
+export { type BodyTerminologyImportTerminology } from "./BodyTerminologyImportTerminology.js";
+export { type TerminologySearchTerminologyRequest } from "./TerminologySearchTerminologyRequest.js";
+export { type TerminologyListTermSetsRequest } from "./TerminologyListTermSetsRequest.js";
+export { type TermSetCreateRequest } from "./TermSetCreateRequest.js";
+export { type TermSetUpdateRequest } from "./TermSetUpdateRequest.js";
+export { type TermUpdateRequest } from "./TermUpdateRequest.js";
+export { type TerminologyListDomainsRequest } from "./TerminologyListDomainsRequest.js";
+export { type DomainCreateRequest } from "./DomainCreateRequest.js";
+export { type DomainUpdateRequest } from "./DomainUpdateRequest.js";

package/dist/cjs/api/resources/terminology/client/requests/index.js

@@ -0,0 +1,2 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });

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

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

package/dist/cjs/api/resources/terminology/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/index.js"), exports);

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

@@ -1,15 +1,12 @@
 /**
  * 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 type ConsistencyCategory = "Consistent Punctuation" | "Consistent Capitalization" | "Numbers, Dates, and Times" | "Inclusive Language" | "Special Style Guide Requirements" | "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

@@ -7,11 +7,8 @@ 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/dist/cjs/api/types/DomainResponse.d.ts

@@ -0,0 +1,13 @@
+/**
+ * This file was auto-generated by Fern from our API Definition.
+ */
+export interface DomainResponse {
+    id: string;
+    name: string;
+    description?: string;
+    created_at: string;
+    updated_at: string;
+    created_by?: string;
+    updated_by?: string;
+    term_set_count?: number;
+}

package/dist/cjs/api/types/DomainResponse.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/cjs/api/types/DomainSummary.d.ts

@@ -0,0 +1,7 @@
+/**
+ * This file was auto-generated by Fern from our API Definition.
+ */
+export interface DomainSummary {
+    id: string;
+    name: string;
+}

package/dist/cjs/api/types/DomainSummary.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/cjs/api/types/ImportSummary.d.ts

@@ -0,0 +1,12 @@
+/**
+ * This file was auto-generated by Fern from our API Definition.
+ */
+export interface ImportSummary {
+    entries_processed?: number;
+    term_sets_created?: number;
+    term_sets_deleted?: number;
+    terms_created_or_updated?: number;
+    domains_created?: number;
+    domains_deleted?: number;
+    errors?: string[];
+}

package/dist/cjs/api/types/ImportSummary.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/cjs/api/types/MatchedTerm.d.ts

@@ -0,0 +1,7 @@
+/**
+ * This file was auto-generated by Fern from our API Definition.
+ */
+export interface MatchedTerm {
+    term: string;
+    matched_ngram: string;
+}

package/dist/cjs/api/types/MatchedTerm.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/cjs/api/types/PaginatedDomainsResponse.d.ts

@@ -0,0 +1,11 @@
+/**
+ * This file was auto-generated by Fern from our API Definition.
+ */
+import * as MarkupAI from "../index.js";
+export interface PaginatedDomainsResponse {
+    domains: MarkupAI.DomainResponse[];
+    total_count: number;
+    page: number;
+    page_size: number;
+    total_pages: number;
+}

package/dist/cjs/api/types/PaginatedDomainsResponse.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/cjs/api/types/PaginatedTermSetsResponse.d.ts

@@ -0,0 +1,15 @@
+/**
+ * This file was auto-generated by Fern from our API Definition.
+ */
+import * as MarkupAI from "../index.js";
+/**
+ * Pageable response for term sets in term management UI
+ */
+export interface PaginatedTermSetsResponse {
+    term_sets: MarkupAI.TermSetWithTerms[];
+    total_count: number;
+    total_unfiltered_term_sets: number;
+    page: number;
+    page_size: number;
+    total_pages: number;
+}

package/dist/cjs/api/types/PaginatedTermSetsResponse.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/cjs/api/types/StyleGuideResponse.d.ts

@@ -20,4 +20,6 @@ export interface StyleGuideResponse {
     summary?: string;
     /** The base style guide type that this style guide extends (AP, Chicago, or Microsoft). */
     base_style_guide_type?: MarkupAI.BaseStyleGuideType;
+    /** List of domain IDs to filter terminology searches by. NULL or empty list means no filtering. */
+    terminology_domain_ids?: string[];
 }

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

@@ -0,0 +1,11 @@
+/**
+ * This file was auto-generated by Fern from our API Definition.
+ */
+import * as MarkupAI from "../index.js";
+/**
+ * Payload to create a new term for a term set
+ */
+export interface TermCreateRequest {
+    term: string;
+    type: MarkupAI.TermType;
+}

package/dist/cjs/api/types/TermCreateRequest.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/cjs/api/types/TermDetail.d.ts

@@ -0,0 +1,16 @@
+/**
+ * This file was auto-generated by Fern from our API Definition.
+ */
+import * as MarkupAI from "../index.js";
+/**
+ * Detailed term information for term management UI
+ */
+export interface TermDetail {
+    id: string;
+    term: string;
+    type: MarkupAI.TermType;
+    created_at: string;
+    updated_at: string;
+    created_by?: string;
+    updated_by?: string;
+}

package/dist/cjs/api/types/TermDetail.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/cjs/api/types/TermItem.d.ts

@@ -0,0 +1,7 @@
+/**
+ * This file was auto-generated by Fern from our API Definition.
+ */
+export interface TermItem {
+    term: string;
+    type: string;
+}

package/dist/cjs/api/types/TermItem.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/cjs/api/types/TermResponse.d.ts

@@ -0,0 +1,16 @@
+/**
+ * This file was auto-generated by Fern from our API Definition.
+ */
+import * as MarkupAI from "../index.js";
+/**
+ * DB-mapped representation of a term.
+ */
+export interface TermResponse {
+    id: string;
+    term: string;
+    type: MarkupAI.TermType;
+    created_at: string;
+    updated_at: string;
+    created_by?: string;
+    updated_by?: string;
+}

package/dist/cjs/api/types/TermResponse.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/cjs/api/types/TermSetResponse.d.ts

@@ -0,0 +1,14 @@
+/**
+ * This file was auto-generated by Fern from our API Definition.
+ */
+/**
+ * DB-mapped representation of a term set (no terms).
+ */
+export interface TermSetResponse {
+    id: string;
+    instructions: string;
+    created_at: string;
+    updated_at: string;
+    created_by?: string;
+    updated_by?: string;
+}

package/dist/cjs/api/types/TermSetResponse.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/cjs/api/types/TermSetResult.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 TermSetResult {
+    instructions: string;
+    terms: MarkupAI.TermItem[];
+    matched_terms: MarkupAI.MatchedTerm[];
+}

package/dist/cjs/api/types/TermSetResult.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/cjs/api/types/TermSetWithTerms.d.ts

@@ -0,0 +1,17 @@
+/**
+ * This file was auto-generated by Fern from our API Definition.
+ */
+import * as MarkupAI from "../index.js";
+/**
+ * Term set with all associated terms for term management UI
+ */
+export interface TermSetWithTerms {
+    id: string;
+    instructions: string;
+    created_at: string;
+    updated_at: string;
+    created_by?: string;
+    updated_by?: string;
+    terms: MarkupAI.TermDetail[];
+    domains?: MarkupAI.DomainSummary[];
+}

package/dist/cjs/api/types/TermSetWithTerms.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/cjs/api/types/TermType.d.ts

@@ -0,0 +1,12 @@
+/**
+ * This file was auto-generated by Fern from our API Definition.
+ */
+/**
+ * Represents the three types of terms in the terminology system.
+ */
+export type TermType = "preferred" | "prohibited" | "context_dependent";
+export declare const TermType: {
+    readonly Preferred: "preferred";
+    readonly Prohibited: "prohibited";
+    readonly ContextDependent: "context_dependent";
+};

package/dist/cjs/api/types/TermType.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.TermType = void 0;
+exports.TermType = {
+    Preferred: "preferred",
+    Prohibited: "prohibited",
+    ContextDependent: "context_dependent",
+};

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

@@ -0,0 +1,7 @@
+/**
+ * This file was auto-generated by Fern from our API Definition.
+ */
+import * as MarkupAI from "../index.js";
+export interface TerminologySearchResponse {
+    results: MarkupAI.TermSetResult[];
+}

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

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