@markupai/api 0.0.6 → 0.2.0

package/README.md

@@ -21,10 +21,9 @@ Instantiate and use the client with the following:
 
 ```typescript
 import { MarkupAIClient } from "@markupai/api";
-import * as fs from "fs";
 
 const client = new MarkupAIClient({ token: "YOUR_TOKEN" });
-await client.styleGuides.createStyleGuide(fs.createReadStream("/path/to/your/file"), {});
+await client.styleGuides.listStyleGuides();
 ```
 
 ## Request And Response Types
@@ -49,7 +48,7 @@ will be thrown.
 import { MarkupAIError } from "@markupai/api";
 
 try {
-    await client.styleGuides.createStyleGuide(...);
+    await client.styleGuides.listStyleGuides(...);
 } catch (err) {
     if (err instanceof MarkupAIError) {
         console.log(err.statusCode);
@@ -67,13 +66,25 @@ try {
 If you would like to send additional headers as part of the request, use the `headers` request option.
 
 ```typescript
-const response = await client.styleGuides.createStyleGuide(..., {
+const response = await client.styleGuides.listStyleGuides(..., {
     headers: {
         'X-Custom-Header': 'custom value'
     }
 });
 ```
 
+### Additional Query String Parameters
+
+If you would like to send additional query string parameters as part of the request, use the `queryParams` request option.
+
+```typescript
+const response = await client.styleGuides.listStyleGuides(..., {
+    queryParams: {
+        'customQueryParamKey': 'custom query param value'
+    }
+});
+```
+
 ### Retries
 
 The SDK is instrumented with automatic retries with exponential backoff. A request will be retried as long
@@ -89,7 +100,7 @@ A request is deemed retryable when any of the following HTTP status codes is ret
 Use the `maxRetries` request option to configure this behavior.
 
 ```typescript
-const response = await client.styleGuides.createStyleGuide(..., {
+const response = await client.styleGuides.listStyleGuides(..., {
     maxRetries: 0 // override maxRetries at the request level
 });
 ```
@@ -99,7 +110,7 @@ const response = await client.styleGuides.createStyleGuide(..., {
 The SDK defaults to a 60 second timeout. Use the `timeoutInSeconds` option to configure this behavior.
 
 ```typescript
-const response = await client.styleGuides.createStyleGuide(..., {
+const response = await client.styleGuides.listStyleGuides(..., {
     timeoutInSeconds: 30 // override timeout to 30s
 });
 ```
@@ -110,7 +121,7 @@ The SDK allows users to abort requests at any point by passing in an abort signa
 
 ```typescript
 const controller = new AbortController();
-const response = await client.styleGuides.createStyleGuide(..., {
+const response = await client.styleGuides.listStyleGuides(..., {
     abortSignal: controller.signal
 });
 controller.abort(); // aborts the request
@@ -122,7 +133,7 @@ The SDK provides access to raw response data, including headers, through the `.w
 The `.withRawResponse()` method returns a promise that results to an object with a `data` and a `rawResponse` property.
 
 ```typescript
-const { data, rawResponse } = await client.styleGuides.createStyleGuide(...).withRawResponse();
+const { data, rawResponse } = await client.styleGuides.listStyleGuides(...).withRawResponse();
 
 console.log(data);
 console.log(rawResponse.headers['X-My-Header']);
@@ -130,8 +141,7 @@ console.log(rawResponse.headers['X-My-Header']);
 
 ### Runtime Compatibility
 
-The SDK defaults to `node-fetch` but will use the global fetch client if present. The SDK works in the following
-runtimes:
+The SDK works in the following runtimes:
 
 - Node.js 18+
 - Vercel

package/{Client.d.ts → dist/cjs/Client.d.ts}

@@ -1,18 +1,20 @@
 /**
  * This file was auto-generated by Fern from our API Definition.
  */
-import * as environments from "./environments";
-import * as core from "./core";
-import { StyleGuides } from "./api/resources/styleGuides/client/Client";
-import { StyleChecks } from "./api/resources/styleChecks/client/Client";
-import { StyleSuggestions } from "./api/resources/styleSuggestions/client/Client";
-import { StyleRewrites } from "./api/resources/styleRewrites/client/Client";
+import * as environments from "./environments.js";
+import * as core from "./core/index.js";
+import { StyleGuides } from "./api/resources/styleGuides/client/Client.js";
+import { StyleChecks } from "./api/resources/styleChecks/client/Client.js";
+import { StyleSuggestions } from "./api/resources/styleSuggestions/client/Client.js";
+import { StyleRewrites } from "./api/resources/styleRewrites/client/Client.js";
 export declare namespace MarkupAIClient {
     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>;
+        /** Additional headers to include in requests. */
+        headers?: Record<string, string | core.Supplier<string | null | undefined> | null | undefined>;
         fetcher?: core.FetchFunction;
     }
     interface RequestOptions {
@@ -22,8 +24,10 @@ export declare namespace MarkupAIClient {
         maxRetries?: number;
         /** A hook to abort the request. */
         abortSignal?: AbortSignal;
+        /** Additional query string parameters to include in the request. */
+        queryParams?: Record<string, unknown>;
         /** Additional headers to include in the request. */
-        headers?: Record<string, string>;
+        headers?: Record<string, string | core.Supplier<string | null | undefined> | null | undefined>;
     }
 }
 export declare class MarkupAIClient {

package/dist/cjs/Client.js

@@ -0,0 +1,74 @@
+"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.MarkupAIClient = void 0;
+const core = __importStar(require("./core/index.js"));
+const headers_js_1 = require("./core/headers.js");
+const Client_js_1 = require("./api/resources/styleGuides/client/Client.js");
+const Client_js_2 = require("./api/resources/styleChecks/client/Client.js");
+const Client_js_3 = require("./api/resources/styleSuggestions/client/Client.js");
+const Client_js_4 = require("./api/resources/styleRewrites/client/Client.js");
+class MarkupAIClient {
+    constructor(_options) {
+        this._options = Object.assign(Object.assign({}, _options), { headers: (0, headers_js_1.mergeHeaders)({
+                "X-Fern-Language": "JavaScript",
+                "X-Fern-SDK-Name": "@markupai/api",
+                "X-Fern-SDK-Version": "0.2.0",
+                "User-Agent": "@markupai/api/0.2.0",
+                "X-Fern-Runtime": core.RUNTIME.type,
+                "X-Fern-Runtime-Version": core.RUNTIME.version,
+            }, _options === null || _options === void 0 ? void 0 : _options.headers) });
+    }
+    get styleGuides() {
+        var _a;
+        return ((_a = this._styleGuides) !== null && _a !== void 0 ? _a : (this._styleGuides = new Client_js_1.StyleGuides(this._options)));
+    }
+    get styleChecks() {
+        var _a;
+        return ((_a = this._styleChecks) !== null && _a !== void 0 ? _a : (this._styleChecks = new Client_js_2.StyleChecks(this._options)));
+    }
+    get styleSuggestions() {
+        var _a;
+        return ((_a = this._styleSuggestions) !== null && _a !== void 0 ? _a : (this._styleSuggestions = new Client_js_3.StyleSuggestions(this._options)));
+    }
+    get styleRewrites() {
+        var _a;
+        return ((_a = this._styleRewrites) !== null && _a !== void 0 ? _a : (this._styleRewrites = new Client_js_4.StyleRewrites(this._options)));
+    }
+}
+exports.MarkupAIClient = MarkupAIClient;

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

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

package/dist/{api → cjs/api}/errors/ContentTooLargeError.js

@@ -37,7 +37,7 @@ var __importStar = (this && this.__importStar) || (function () {
 })();
 Object.defineProperty(exports, "__esModule", { value: true });
 exports.ContentTooLargeError = void 0;
-const errors = __importStar(require("../../errors/index"));
+const errors = __importStar(require("../../errors/index.js"));
 class ContentTooLargeError extends errors.MarkupAIError {
     constructor(body, rawResponse) {
         super({

package/{api → dist/cjs/api}/errors/ForbiddenError.d.ts

@@ -1,9 +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";
+import * as errors from "../../errors/index.js";
+import * as MarkupAI from "../index.js";
+import * as core from "../../core/index.js";
 export declare class ForbiddenError extends errors.MarkupAIError {
     constructor(body: MarkupAI.ErrorResponse, rawResponse?: core.RawResponse);
 }

package/{api → dist/cjs/api}/errors/ForbiddenError.js

@@ -37,7 +37,7 @@ var __importStar = (this && this.__importStar) || (function () {
 })();
 Object.defineProperty(exports, "__esModule", { value: true });
 exports.ForbiddenError = void 0;
-const errors = __importStar(require("../../errors/index"));
+const errors = __importStar(require("../../errors/index.js"));
 class ForbiddenError extends errors.MarkupAIError {
     constructor(body, rawResponse) {
         super({

package/dist/{api → cjs/api}/errors/InternalServerError.d.ts

@@ -1,9 +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";
+import * as errors from "../../errors/index.js";
+import * as MarkupAI from "../index.js";
+import * as core from "../../core/index.js";
 export declare class InternalServerError extends errors.MarkupAIError {
     constructor(body: MarkupAI.ErrorResponse, rawResponse?: core.RawResponse);
 }

package/{api → dist/cjs/api}/errors/InternalServerError.js

@@ -37,7 +37,7 @@ var __importStar = (this && this.__importStar) || (function () {
 })();
 Object.defineProperty(exports, "__esModule", { value: true });
 exports.InternalServerError = void 0;
-const errors = __importStar(require("../../errors/index"));
+const errors = __importStar(require("../../errors/index.js"));
 class InternalServerError extends errors.MarkupAIError {
     constructor(body, rawResponse) {
         super({

package/dist/{api → cjs/api}/errors/NotFoundError.d.ts

@@ -1,9 +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";
+import * as errors from "../../errors/index.js";
+import * as MarkupAI from "../index.js";
+import * as core from "../../core/index.js";
 export declare class NotFoundError extends errors.MarkupAIError {
     constructor(body: MarkupAI.ErrorResponse, rawResponse?: core.RawResponse);
 }

package/dist/{api → cjs/api}/errors/NotFoundError.js

@@ -37,7 +37,7 @@ var __importStar = (this && this.__importStar) || (function () {
 })();
 Object.defineProperty(exports, "__esModule", { value: true });
 exports.NotFoundError = void 0;
-const errors = __importStar(require("../../errors/index"));
+const errors = __importStar(require("../../errors/index.js"));
 class NotFoundError extends errors.MarkupAIError {
     constructor(body, rawResponse) {
         super({

package/dist/cjs/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.js";
+import * as MarkupAI from "../index.js";
+import * as core from "../../core/index.js";
+export declare class UnauthorizedError extends errors.MarkupAIError {
+    constructor(body: MarkupAI.ErrorResponse, rawResponse?: core.RawResponse);
+}

package/{api/errors/NotFoundError.js → dist/cjs/api/errors/UnauthorizedError.js}

@@ -36,17 +36,17 @@ var __importStar = (this && this.__importStar) || (function () {
     };
 })();
 Object.defineProperty(exports, "__esModule", { value: true });
-exports.NotFoundError = void 0;
-const errors = __importStar(require("../../errors/index"));
-class NotFoundError extends errors.MarkupAIError {
+exports.UnauthorizedError = void 0;
+const errors = __importStar(require("../../errors/index.js"));
+class UnauthorizedError extends errors.MarkupAIError {
     constructor(body, rawResponse) {
         super({
-            message: "NotFoundError",
-            statusCode: 404,
+            message: "UnauthorizedError",
+            statusCode: 401,
             body: body,
             rawResponse: rawResponse,
         });
-        Object.setPrototypeOf(this, NotFoundError.prototype);
+        Object.setPrototypeOf(this, UnauthorizedError.prototype);
     }
 }
-exports.NotFoundError = NotFoundError;
+exports.UnauthorizedError = UnauthorizedError;

package/{api → dist/cjs/api}/errors/UnprocessableEntityError.d.ts

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

package/{api → dist/cjs/api}/errors/UnprocessableEntityError.js

@@ -37,7 +37,7 @@ var __importStar = (this && this.__importStar) || (function () {
 })();
 Object.defineProperty(exports, "__esModule", { value: true });
 exports.UnprocessableEntityError = void 0;
-const errors = __importStar(require("../../errors/index"));
+const errors = __importStar(require("../../errors/index.js"));
 class UnprocessableEntityError extends errors.MarkupAIError {
     constructor(body, rawResponse) {
         super({

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

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

package/{api → dist/cjs/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("./UnprocessableEntityError"), exports);
-__exportStar(require("./InternalServerError"), exports);
-__exportStar(require("./ForbiddenError"), exports);
-__exportStar(require("./ContentTooLargeError"), exports);
-__exportStar(require("./NotFoundError"), exports);
+__exportStar(require("./UnauthorizedError.js"), exports);
+__exportStar(require("./ForbiddenError.js"), exports);
+__exportStar(require("./UnprocessableEntityError.js"), exports);
+__exportStar(require("./InternalServerError.js"), exports);
+__exportStar(require("./ContentTooLargeError.js"), exports);
+__exportStar(require("./NotFoundError.js"), exports);

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

@@ -0,0 +1,3 @@
+export * from "./types/index.js";
+export * from "./errors/index.js";
+export * from "./resources/index.js";

package/{api → dist/cjs/api}/index.js

@@ -14,6 +14,6 @@ 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("./types"), exports);
-__exportStar(require("./errors"), exports);
-__exportStar(require("./resources"), exports);
+__exportStar(require("./types/index.js"), exports);
+__exportStar(require("./errors/index.js"), exports);
+__exportStar(require("./resources/index.js"), exports);

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

@@ -0,0 +1,8 @@
+export * as styleGuides from "./styleGuides/index.js";
+export * as styleChecks from "./styleChecks/index.js";
+export * as styleSuggestions from "./styleSuggestions/index.js";
+export * as styleRewrites from "./styleRewrites/index.js";
+export * from "./styleGuides/client/requests/index.js";
+export * from "./styleChecks/client/requests/index.js";
+export * from "./styleSuggestions/client/requests/index.js";
+export * from "./styleRewrites/client/requests/index.js";

package/{api → dist/cjs/api}/resources/index.js

@@ -37,11 +37,11 @@ var __exportStar = (this && this.__exportStar) || function(m, exports) {
 };
 Object.defineProperty(exports, "__esModule", { value: true });
 exports.styleRewrites = exports.styleSuggestions = exports.styleChecks = exports.styleGuides = void 0;
-exports.styleGuides = __importStar(require("./styleGuides"));
-exports.styleChecks = __importStar(require("./styleChecks"));
-exports.styleSuggestions = __importStar(require("./styleSuggestions"));
-exports.styleRewrites = __importStar(require("./styleRewrites"));
-__exportStar(require("./styleGuides/client/requests"), exports);
-__exportStar(require("./styleChecks/client/requests"), exports);
-__exportStar(require("./styleSuggestions/client/requests"), exports);
-__exportStar(require("./styleRewrites/client/requests"), exports);
+exports.styleGuides = __importStar(require("./styleGuides/index.js"));
+exports.styleChecks = __importStar(require("./styleChecks/index.js"));
+exports.styleSuggestions = __importStar(require("./styleSuggestions/index.js"));
+exports.styleRewrites = __importStar(require("./styleRewrites/index.js"));
+__exportStar(require("./styleGuides/client/requests/index.js"), exports);
+__exportStar(require("./styleChecks/client/requests/index.js"), exports);
+__exportStar(require("./styleSuggestions/client/requests/index.js"), exports);
+__exportStar(require("./styleRewrites/client/requests/index.js"), exports);

package/{api → dist/cjs/api}/resources/styleChecks/client/Client.d.ts

@@ -1,17 +1,17 @@
 /**
  * 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";
+import * as environments from "../../../../environments.js";
+import * as core from "../../../../core/index.js";
+import * as MarkupAI from "../../../index.js";
 export declare namespace StyleChecks {
     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>;
+        /** Additional headers to include in requests. */
+        headers?: Record<string, string | core.Supplier<string | null | undefined> | null | undefined>;
         fetcher?: core.FetchFunction;
     }
     interface RequestOptions {
@@ -21,8 +21,10 @@ export declare namespace StyleChecks {
         maxRetries?: number;
         /** A hook to abort the request. */
         abortSignal?: AbortSignal;
+        /** Additional query string parameters to include in the request. */
+        queryParams?: Record<string, unknown>;
         /** Additional headers to include in the request. */
-        headers?: Record<string, string>;
+        headers?: Record<string, string | core.Supplier<string | null | undefined> | null | undefined>;
     }
 }
 /**
@@ -32,31 +34,35 @@ 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}
      *
      * @example
-     *     await client.styleChecks.createStyleCheck(fs.createReadStream("/path/to/your/file"), {
+     *     import { createReadStream } from "fs";
+     *     await client.styleChecks.createStyleCheck({
+     *         file_upload: 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(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}