@markupai/api 0.0.6

package/dist/api/resources/styleChecks/client/Client.js

@@ -0,0 +1,215 @@
+"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;
+    };
+})();
+var __awaiter = (this && this.__awaiter) || function (thisArg, _arguments, P, generator) {
+    function adopt(value) { return value instanceof P ? value : new P(function (resolve) { resolve(value); }); }
+    return new (P || (P = Promise))(function (resolve, reject) {
+        function fulfilled(value) { try { step(generator.next(value)); } catch (e) { reject(e); } }
+        function rejected(value) { try { step(generator["throw"](value)); } catch (e) { reject(e); } }
+        function step(result) { result.done ? resolve(result.value) : adopt(result.value).then(fulfilled, rejected); }
+        step((generator = generator.apply(thisArg, _arguments || [])).next());
+    });
+};
+var __importDefault = (this && this.__importDefault) || function (mod) {
+    return (mod && mod.__esModule) ? mod : { "default": mod };
+};
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.StyleChecks = void 0;
+const environments = __importStar(require("../../../../environments"));
+const core = __importStar(require("../../../../core"));
+const MarkupAI = __importStar(require("../../../index"));
+const url_join_1 = __importDefault(require("url-join"));
+const errors = __importStar(require("../../../../errors/index"));
+/**
+ * Analyze your content to spot issues that go against your style guide or brand voice. Use this to catch tone, grammar, or readability problems before publishing.
+ */
+class StyleChecks {
+    constructor(_options) {
+        this._options = _options;
+    }
+    /**
+     * Start a style and brand check workflow. Returns a workflow ID to use for polling results.
+     *
+     * @param {File | fs.ReadStream | Blob} file_upload
+     * @param {MarkupAI.StyleChecksCreateStyleCheckRequest} request
+     * @param {StyleChecks.RequestOptions} requestOptions - Request-specific configuration.
+     *
+     * @throws {@link MarkupAI.ContentTooLargeError}
+     * @throws {@link MarkupAI.UnprocessableEntityError}
+     * @throws {@link MarkupAI.InternalServerError}
+     *
+     * @example
+     *     await client.styleChecks.createStyleCheck(fs.createReadStream("/path/to/your/file"), {
+     *         dialect: "american_english",
+     *         tone: "academic",
+     *         style_guide: "style_guide"
+     *     })
+     */
+    createStyleCheck(file_upload, request, requestOptions) {
+        return core.HttpResponsePromise.fromPromise(this.__createStyleCheck(file_upload, request, requestOptions));
+    }
+    __createStyleCheck(file_upload, request, requestOptions) {
+        return __awaiter(this, void 0, void 0, function* () {
+            var _a, _b, _c;
+            const _request = yield core.newFormData();
+            yield _request.appendFile("file_upload", file_upload);
+            _request.append("dialect", request.dialect);
+            _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/checks"),
+                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),
+                requestType: "file",
+                duplex: _maybeEncodedRequest.duplex,
+                body: _maybeEncodedRequest.body,
+                timeoutMs: (requestOptions === null || requestOptions === void 0 ? void 0 : requestOptions.timeoutInSeconds) != null ? requestOptions.timeoutInSeconds * 1000 : 60000,
+                maxRetries: requestOptions === null || requestOptions === void 0 ? void 0 : requestOptions.maxRetries,
+                abortSignal: requestOptions === null || requestOptions === void 0 ? void 0 : requestOptions.abortSignal,
+            });
+            if (_response.ok) {
+                return { data: _response.body, rawResponse: _response.rawResponse };
+            }
+            if (_response.error.reason === "status-code") {
+                switch (_response.error.statusCode) {
+                    case 413:
+                        throw new MarkupAI.ContentTooLargeError(_response.error.body, _response.rawResponse);
+                    case 422:
+                        throw new MarkupAI.UnprocessableEntityError(_response.error.body, _response.rawResponse);
+                    case 500:
+                        throw new MarkupAI.InternalServerError(_response.error.body, _response.rawResponse);
+                    default:
+                        throw new errors.MarkupAIError({
+                            statusCode: _response.error.statusCode,
+                            body: _response.error.body,
+                            rawResponse: _response.rawResponse,
+                        });
+                }
+            }
+            switch (_response.error.reason) {
+                case "non-json":
+                    throw new errors.MarkupAIError({
+                        statusCode: _response.error.statusCode,
+                        body: _response.error.rawBody,
+                        rawResponse: _response.rawResponse,
+                    });
+                case "timeout":
+                    throw new errors.MarkupAITimeoutError("Timeout exceeded when calling POST /v1/style/checks.");
+                case "unknown":
+                    throw new errors.MarkupAIError({
+                        message: _response.error.errorMessage,
+                        rawResponse: _response.rawResponse,
+                    });
+            }
+        });
+    }
+    /**
+     * Retrieve the results of a style and brand check workflow. Returns `running` or `complete` status.
+     *
+     * @param {string} workflowId
+     * @param {StyleChecks.RequestOptions} requestOptions - Request-specific configuration.
+     *
+     * @throws {@link MarkupAI.NotFoundError}
+     * @throws {@link MarkupAI.UnprocessableEntityError}
+     * @throws {@link MarkupAI.InternalServerError}
+     *
+     * @example
+     *     await client.styleChecks.getStyleCheck("workflow_id")
+     */
+    getStyleCheck(workflowId, requestOptions) {
+        return core.HttpResponsePromise.fromPromise(this.__getStyleCheck(workflowId, requestOptions));
+    }
+    __getStyleCheck(workflowId, requestOptions) {
+        return __awaiter(this, void 0, void 0, function* () {
+            var _a, _b, _c;
+            const _response = yield ((_a = this._options.fetcher) !== null && _a !== void 0 ? _a : core.fetcher)({
+                url: (0, url_join_1.default)((_c = (_b = (yield core.Supplier.get(this._options.baseUrl))) !== null && _b !== void 0 ? _b : (yield core.Supplier.get(this._options.environment))) !== null && _c !== void 0 ? _c : environments.MarkupAIEnvironment.Production, `v1/style/checks/${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),
+                contentType: "application/json",
+                requestType: "json",
+                timeoutMs: (requestOptions === null || requestOptions === void 0 ? void 0 : requestOptions.timeoutInSeconds) != null ? requestOptions.timeoutInSeconds * 1000 : 60000,
+                maxRetries: requestOptions === null || requestOptions === void 0 ? void 0 : requestOptions.maxRetries,
+                abortSignal: requestOptions === null || requestOptions === void 0 ? void 0 : requestOptions.abortSignal,
+            });
+            if (_response.ok) {
+                return { data: _response.body, rawResponse: _response.rawResponse };
+            }
+            if (_response.error.reason === "status-code") {
+                switch (_response.error.statusCode) {
+                    case 404:
+                        throw new MarkupAI.NotFoundError(_response.error.body, _response.rawResponse);
+                    case 422:
+                        throw new MarkupAI.UnprocessableEntityError(_response.error.body, _response.rawResponse);
+                    case 500:
+                        throw new MarkupAI.InternalServerError(_response.error.body, _response.rawResponse);
+                    default:
+                        throw new errors.MarkupAIError({
+                            statusCode: _response.error.statusCode,
+                            body: _response.error.body,
+                            rawResponse: _response.rawResponse,
+                        });
+                }
+            }
+            switch (_response.error.reason) {
+                case "non-json":
+                    throw new errors.MarkupAIError({
+                        statusCode: _response.error.statusCode,
+                        body: _response.error.rawBody,
+                        rawResponse: _response.rawResponse,
+                    });
+                case "timeout":
+                    throw new errors.MarkupAITimeoutError("Timeout exceeded when calling GET /v1/style/checks/{workflow_id}.");
+                case "unknown":
+                    throw new errors.MarkupAIError({
+                        message: _response.error.errorMessage,
+                        rawResponse: _response.rawResponse,
+                    });
+            }
+        });
+    }
+    _getAuthorizationHeader() {
+        return __awaiter(this, void 0, void 0, function* () {
+            return `Bearer ${yield core.Supplier.get(this._options.token)}`;
+        });
+    }
+}
+exports.StyleChecks = StyleChecks;

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

@@ -0,0 +1 @@
+export * from "./requests";

package/dist/api/resources/styleChecks/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"), exports);

package/dist/api/resources/styleChecks/client/requests/StyleChecksCreateStyleCheckRequest.d.ts

@@ -0,0 +1,22 @@
+/**
+ * This file was auto-generated by Fern from our API Definition.
+ */
+import * as MarkupAI from "../../../../index";
+/**
+ * @example
+ *     {
+ *         dialect: "american_english",
+ *         tone: "academic",
+ *         style_guide: "style_guide"
+ *     }
+ */
+export interface StyleChecksCreateStyleCheckRequest {
+    /** 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;
+    /** 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. */
+    webhook_url?: string;
+}

package/dist/api/resources/styleChecks/client/requests/StyleChecksCreateStyleCheckRequest.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/resources/styleChecks/client/requests/index.d.ts

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

package/dist/api/resources/styleChecks/client/requests/index.js

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

package/dist/api/resources/styleChecks/index.d.ts

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

package/dist/api/resources/styleChecks/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/resources/styleGuides/client/Client.d.ts

@@ -0,0 +1,109 @@
+/**
+ * This file was auto-generated by Fern from our API Definition.
+ */
+import * as environments from "../../../../environments";
+import * as core from "../../../../core";
+import * as MarkupAI from "../../../index";
+import * as fs from "fs";
+import { Blob } from "buffer";
+export declare namespace StyleGuides {
+    interface Options {
+        environment?: core.Supplier<environments.MarkupAIEnvironment | string>;
+        /** Specify a custom URL to connect the client to. */
+        baseUrl?: core.Supplier<string>;
+        token: core.Supplier<core.BearerToken>;
+        fetcher?: core.FetchFunction;
+    }
+    interface RequestOptions {
+        /** The maximum time to wait for a response in seconds. */
+        timeoutInSeconds?: number;
+        /** The number of times to retry the request. Defaults to 2. */
+        maxRetries?: number;
+        /** A hook to abort the request. */
+        abortSignal?: AbortSignal;
+        /** Additional headers to include in the request. */
+        headers?: Record<string, string>;
+    }
+}
+/**
+ * Endpoints related to creating, updating, and organizing style guides for content consistency across teams.
+ */
+export declare class StyleGuides {
+    protected readonly _options: StyleGuides.Options;
+    constructor(_options: StyleGuides.Options);
+    /**
+     * Retrieve all style guides associated with your organization.
+     *
+     * @param {StyleGuides.RequestOptions} requestOptions - Request-specific configuration.
+     *
+     * @throws {@link MarkupAI.UnprocessableEntityError}
+     * @throws {@link MarkupAI.InternalServerError}
+     *
+     * @example
+     *     await client.styleGuides.listStyleGuides()
+     */
+    listStyleGuides(requestOptions?: StyleGuides.RequestOptions): core.HttpResponsePromise<MarkupAI.StyleGuideResponse[]>;
+    private __listStyleGuides;
+    /**
+     * Create a new style guide that can be used in checks, suggestions, and rewrites.
+     *
+     * @param {File | fs.ReadStream | Blob} file_upload
+     * @param {MarkupAI.StyleGuideRequestBody} request
+     * @param {StyleGuides.RequestOptions} requestOptions - Request-specific configuration.
+     *
+     * @throws {@link MarkupAI.UnprocessableEntityError}
+     * @throws {@link MarkupAI.InternalServerError}
+     *
+     * @example
+     *     await client.styleGuides.createStyleGuide(fs.createReadStream("/path/to/your/file"), {})
+     */
+    createStyleGuide(file_upload: File | fs.ReadStream | Blob, request: MarkupAI.StyleGuideRequestBody, requestOptions?: StyleGuides.RequestOptions): core.HttpResponsePromise<MarkupAI.StyleGuideResponse>;
+    private __createStyleGuide;
+    /**
+     * Retrieve a specific style guide by ID, including its metadata such as `name` and `status`.
+     *
+     * @param {string} styleGuideId - The ID of the style guide.
+     * @param {StyleGuides.RequestOptions} requestOptions - Request-specific configuration.
+     *
+     * @throws {@link MarkupAI.UnprocessableEntityError}
+     * @throws {@link MarkupAI.InternalServerError}
+     *
+     * @example
+     *     await client.styleGuides.getStyleGuide("style_guide_id")
+     */
+    getStyleGuide(styleGuideId: string, requestOptions?: StyleGuides.RequestOptions): core.HttpResponsePromise<MarkupAI.StyleGuideResponse>;
+    private __getStyleGuide;
+    /**
+     * Delete a style guide by ID.
+     *
+     * @param {string} styleGuideId - The ID of the style guide.
+     * @param {StyleGuides.RequestOptions} requestOptions - Request-specific configuration.
+     *
+     * @throws {@link MarkupAI.UnprocessableEntityError}
+     * @throws {@link MarkupAI.InternalServerError}
+     *
+     * @example
+     *     await client.styleGuides.deleteStyleGuide("style_guide_id")
+     */
+    deleteStyleGuide(styleGuideId: string, requestOptions?: StyleGuides.RequestOptions): core.HttpResponsePromise<void>;
+    private __deleteStyleGuide;
+    /**
+     * Update the name of an existing style guide.
+     *
+     * @param {string} styleGuideId - The ID of the style guide.
+     * @param {MarkupAI.BodyStyleGuidesUpdateStyleGuide} request
+     * @param {StyleGuides.RequestOptions} requestOptions - Request-specific configuration.
+     *
+     * @throws {@link MarkupAI.ForbiddenError}
+     * @throws {@link MarkupAI.UnprocessableEntityError}
+     * @throws {@link MarkupAI.InternalServerError}
+     *
+     * @example
+     *     await client.styleGuides.updateStyleGuide("style_guide_id", {
+     *         name: "name"
+     *     })
+     */
+    updateStyleGuide(styleGuideId: string, request: MarkupAI.BodyStyleGuidesUpdateStyleGuide, requestOptions?: StyleGuides.RequestOptions): core.HttpResponsePromise<MarkupAI.StyleGuideResponse>;
+    private __updateStyleGuide;
+    protected _getAuthorizationHeader(): Promise<string>;
+}