@corti/sdk 0.0.0-alpha.10 → 0.1.0-alpha

package/README.md

@@ -45,11 +45,11 @@ const client = new CortiClient({
     environment: CortiEnvironment.BetaEu,
     tenantName: "YOUR_TENANT_NAME",
     auth: {
-        access_token: "YOUR_ACCESS_TOKEN",
+        accessToken: "YOUR_ACCESS_TOKEN",
         // Optional: refresh token for automatic token refresh
-        refresh_token: "YOUR_REFRESH_TOKEN",
-        expires_in: 3600,
-        refresh_expires_in: 86400,
+        refreshToken: "YOUR_REFRESH_TOKEN",
+        expiresIn: 3600,
+        refreshExpiresIn: 86400,
     },
 });
 
@@ -80,21 +80,35 @@ const request: Corti.InteractionsListRequest = {
 
 ## Exception Handling
 
-When the API returns a non-success status code (4xx or 5xx response), a subclass of the following error
-will be thrown.
+Depending on the type of error, the SDK will throw one of the following:
+
+- **CortiError**: Thrown when the API returns a non-success status code (4xx or 5xx response). This is the base error for API-related issues.
+- **ParseError**: Thrown when parsing input data fails schema validation. This typically occurs when the data you provide does not match the expected schema.
+- **JsonError**: Thrown when serializing data to JSON fails schema validation. This typically occurs when converting parsed data to JSON for transmission or storage fails validation.
+
+Example usage:
 
 ```typescript
-import { CortiError } from "@corti/sdk";
+import { CortiError, ParseError, JsonError } from "@corti/sdk";
 
 try {
     await client.interactions.create(...);
 } catch (err) {
     if (err instanceof CortiError) {
+        // Handle API errors
         console.log(err.statusCode);
         console.log(err.message);
         console.log(err.body);
         console.log(err.rawResponse);
     }
+    if (err instanceof ParseError) {
+        // Handle schema validation errors during parsing
+        console.error("Parse validation error details:", err.errors);
+    }
+    if (err instanceof JsonError) {
+        // Handle schema validation errors during serialization
+        console.error("JSON validation error details:", err.errors);
+    }
 }
 ```
 

package/dist/cjs/Client.d.ts

@@ -0,0 +1,62 @@
+/**
+ * This file was auto-generated by Fern from our API Definition.
+ */
+import * as environments from "./environments.js";
+import * as core from "./core/index.js";
+import { Auth } from "./api/resources/auth/client/Client.js";
+import { Interactions } from "./api/resources/interactions/client/Client.js";
+import { Recordings } from "./api/resources/recordings/client/Client.js";
+import { Transcripts } from "./api/resources/transcripts/client/Client.js";
+import { Facts } from "./api/resources/facts/client/Client.js";
+import { Documents } from "./api/resources/documents/client/Client.js";
+import { Templates } from "./api/resources/templates/client/Client.js";
+import { Stream } from "./api/resources/stream/client/Client.js";
+import { Transcribe } from "./api/resources/transcribe/client/Client.js";
+export declare namespace CortiClient {
+    interface Options {
+        environment: core.Supplier<environments.CortiEnvironment | environments.CortiEnvironmentUrls>;
+        /** Specify a custom URL to connect the client to. */
+        baseUrl?: core.Supplier<string>;
+        clientId: core.Supplier<string>;
+        clientSecret: core.Supplier<string>;
+        /** Override the Tenant-Name header */
+        tenantName: core.Supplier<string>;
+        /** Additional headers to include in requests. */
+        headers?: Record<string, string | core.Supplier<string | undefined> | undefined>;
+    }
+    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;
+        /** Override the Tenant-Name header */
+        tenantName?: string;
+        /** Additional headers to include in the request. */
+        headers?: Record<string, string | core.Supplier<string | undefined> | undefined>;
+    }
+}
+export declare class CortiClient {
+    protected readonly _options: CortiClient.Options;
+    private readonly _oauthTokenProvider;
+    protected _interactions: Interactions | undefined;
+    protected _recordings: Recordings | undefined;
+    protected _transcripts: Transcripts | undefined;
+    protected _facts: Facts | undefined;
+    protected _documents: Documents | undefined;
+    protected _templates: Templates | undefined;
+    protected _auth: Auth | undefined;
+    protected _stream: Stream | undefined;
+    protected _transcribe: Transcribe | undefined;
+    constructor(_options: CortiClient.Options);
+    get interactions(): Interactions;
+    get recordings(): Recordings;
+    get transcripts(): Transcripts;
+    get facts(): Facts;
+    get documents(): Documents;
+    get templates(): Templates;
+    get auth(): Auth;
+    get stream(): Stream;
+    get transcribe(): Transcribe;
+}

package/dist/cjs/Client.js

@@ -0,0 +1,114 @@
+"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());
+    });
+};
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.CortiClient = void 0;
+const core = __importStar(require("./core/index.js"));
+const Client_js_1 = require("./api/resources/auth/client/Client.js");
+const headers_js_1 = require("./core/headers.js");
+const Client_js_2 = require("./api/resources/interactions/client/Client.js");
+const Client_js_3 = require("./api/resources/recordings/client/Client.js");
+const Client_js_4 = require("./api/resources/transcripts/client/Client.js");
+const Client_js_5 = require("./api/resources/facts/client/Client.js");
+const Client_js_6 = require("./api/resources/documents/client/Client.js");
+const Client_js_7 = require("./api/resources/templates/client/Client.js");
+const Client_js_8 = require("./api/resources/stream/client/Client.js");
+const Client_js_9 = require("./api/resources/transcribe/client/Client.js");
+class CortiClient {
+    constructor(_options) {
+        this._options = Object.assign(Object.assign({}, _options), { headers: (0, headers_js_1.mergeHeaders)({
+                "Tenant-Name": _options === null || _options === void 0 ? void 0 : _options.tenantName,
+                "X-Fern-Language": "JavaScript",
+                "X-Fern-SDK-Name": "@corti/sdk",
+                "X-Fern-SDK-Version": "0.1.0-alpha",
+                "User-Agent": "@corti/sdk/0.1.0-alpha",
+                "X-Fern-Runtime": core.RUNTIME.type,
+                "X-Fern-Runtime-Version": core.RUNTIME.version,
+            }, _options === null || _options === void 0 ? void 0 : _options.headers) });
+        this._oauthTokenProvider = new core.OAuthTokenProvider({
+            clientId: this._options.clientId,
+            clientSecret: this._options.clientSecret,
+            authClient: new Client_js_1.Auth(Object.assign(Object.assign({}, this._options), { environment: this._options.environment })),
+        });
+    }
+    get interactions() {
+        var _a;
+        return ((_a = this._interactions) !== null && _a !== void 0 ? _a : (this._interactions = new Client_js_2.Interactions(Object.assign(Object.assign({}, this._options), { token: () => __awaiter(this, void 0, void 0, function* () { return yield this._oauthTokenProvider.getToken(); }) }))));
+    }
+    get recordings() {
+        var _a;
+        return ((_a = this._recordings) !== null && _a !== void 0 ? _a : (this._recordings = new Client_js_3.Recordings(Object.assign(Object.assign({}, this._options), { token: () => __awaiter(this, void 0, void 0, function* () { return yield this._oauthTokenProvider.getToken(); }) }))));
+    }
+    get transcripts() {
+        var _a;
+        return ((_a = this._transcripts) !== null && _a !== void 0 ? _a : (this._transcripts = new Client_js_4.Transcripts(Object.assign(Object.assign({}, this._options), { token: () => __awaiter(this, void 0, void 0, function* () { return yield this._oauthTokenProvider.getToken(); }) }))));
+    }
+    get facts() {
+        var _a;
+        return ((_a = this._facts) !== null && _a !== void 0 ? _a : (this._facts = new Client_js_5.Facts(Object.assign(Object.assign({}, this._options), { token: () => __awaiter(this, void 0, void 0, function* () { return yield this._oauthTokenProvider.getToken(); }) }))));
+    }
+    get documents() {
+        var _a;
+        return ((_a = this._documents) !== null && _a !== void 0 ? _a : (this._documents = new Client_js_6.Documents(Object.assign(Object.assign({}, this._options), { token: () => __awaiter(this, void 0, void 0, function* () { return yield this._oauthTokenProvider.getToken(); }) }))));
+    }
+    get templates() {
+        var _a;
+        return ((_a = this._templates) !== null && _a !== void 0 ? _a : (this._templates = new Client_js_7.Templates(Object.assign(Object.assign({}, this._options), { token: () => __awaiter(this, void 0, void 0, function* () { return yield this._oauthTokenProvider.getToken(); }) }))));
+    }
+    get auth() {
+        var _a;
+        return ((_a = this._auth) !== null && _a !== void 0 ? _a : (this._auth = new Client_js_1.Auth(Object.assign(Object.assign({}, this._options), { token: () => __awaiter(this, void 0, void 0, function* () { return yield this._oauthTokenProvider.getToken(); }) }))));
+    }
+    get stream() {
+        var _a;
+        return ((_a = this._stream) !== null && _a !== void 0 ? _a : (this._stream = new Client_js_8.Stream(Object.assign(Object.assign({}, this._options), { token: () => __awaiter(this, void 0, void 0, function* () { return yield this._oauthTokenProvider.getToken(); }) }))));
+    }
+    get transcribe() {
+        var _a;
+        return ((_a = this._transcribe) !== null && _a !== void 0 ? _a : (this._transcribe = new Client_js_9.Transcribe(Object.assign(Object.assign({}, this._options), { token: () => __awaiter(this, void 0, void 0, function* () { return yield this._oauthTokenProvider.getToken(); }) }))));
+    }
+}
+exports.CortiClient = CortiClient;

package/dist/cjs/api/resources/auth/client/Client.d.ts

@@ -39,8 +39,8 @@ export declare class Auth {
      *
      * @example
      *     await client.auth.getToken({
-     *         client_id: "client_id",
-     *         client_secret: "client_secret"
+     *         clientId: "client_id",
+     *         clientSecret: "client_secret"
      *     })
      */
     getToken(request: Corti.AuthGetTokenRequest, requestOptions?: Auth.RequestOptions): core.HttpResponsePromise<Corti.GetTokenResponse>;

package/dist/cjs/api/resources/auth/client/Client.js

@@ -44,14 +44,11 @@ var __awaiter = (this && this.__awaiter) || function (thisArg, _arguments, P, ge
         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.Auth = void 0;
 const core = __importStar(require("../../../../core/index.js"));
 const headers_js_1 = require("../../../../core/headers.js");
-const url_join_1 = __importDefault(require("url-join"));
+const serializers = __importStar(require("../../../../serialization/index.js"));
 const errors = __importStar(require("../../../../errors/index.js"));
 class Auth {
     constructor(_options) {
@@ -65,8 +62,8 @@ class Auth {
      *
      * @example
      *     await client.auth.getToken({
-     *         client_id: "client_id",
-     *         client_secret: "client_secret"
+     *         clientId: "client_id",
+     *         clientSecret: "client_secret"
      *     })
      */
     getToken(request, requestOptions) {
@@ -76,7 +73,7 @@ class Auth {
         return __awaiter(this, void 0, void 0, function* () {
             var _a, _b;
             const _response = yield core.fetcher({
-                url: (0, url_join_1.default)((_a = (yield core.Supplier.get(this._options.baseUrl))) !== null && _a !== void 0 ? _a : (yield core.Supplier.get(this._options.environment)).login, "protocol/openid-connect/token"),
+                url: core.url.join((_a = (yield core.Supplier.get(this._options.baseUrl))) !== null && _a !== void 0 ? _a : (yield core.Supplier.get(this._options.environment)).login, "protocol/openid-connect/token"),
                 method: "POST",
                 headers: (0, headers_js_1.mergeHeaders)((_b = this._options) === null || _b === void 0 ? void 0 : _b.headers, (0, headers_js_1.mergeOnlyDefinedHeaders)({
                     Authorization: yield this._getAuthorizationHeader(),
@@ -84,13 +81,25 @@ class Auth {
                 }), requestOptions === null || requestOptions === void 0 ? void 0 : requestOptions.headers),
                 contentType: "application/x-www-form-urlencoded",
                 requestType: "json",
-                body: Object.assign(Object.assign({}, request), { scope: "openid", grant_type: "client_credentials" }),
+                body: Object.assign(Object.assign({}, serializers.AuthGetTokenRequest.jsonOrThrow(request, {
+                    unrecognizedObjectKeys: "strip",
+                    omitUndefined: true,
+                })), { scope: "openid", grant_type: "client_credentials" }),
                 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 };
+                return {
+                    data: serializers.GetTokenResponse.parseOrThrow(_response.body, {
+                        unrecognizedObjectKeys: "passthrough",
+                        allowUnrecognizedUnionMembers: true,
+                        allowUnrecognizedEnumValues: true,
+                        skipValidation: true,
+                        breadcrumbsPrefix: ["response"],
+                    }),
+                    rawResponse: _response.rawResponse,
+                };
             }
             if (_response.error.reason === "status-code") {
                 throw new errors.CortiError({

package/dist/cjs/api/resources/auth/client/requests/AuthGetTokenRequest.d.ts

@@ -4,11 +4,11 @@
 /**
  * @example
  *     {
- *         client_id: "client_id",
- *         client_secret: "client_secret"
+ *         clientId: "client_id",
+ *         clientSecret: "client_secret"
  *     }
  */
 export interface AuthGetTokenRequest {
-    client_id: string;
-    client_secret: string;
+    clientId: string;
+    clientSecret: string;
 }

package/dist/cjs/api/resources/auth/types/GetTokenResponse.d.ts

@@ -2,9 +2,9 @@
  * This file was auto-generated by Fern from our API Definition.
  */
 export interface GetTokenResponse {
-    access_token: string;
-    token_type: string;
-    expires_in: number;
-    refresh_token?: string;
-    refresh_expires_in?: number;
+    accessToken: string;
+    tokenType: string;
+    expiresIn: number;
+    refreshToken?: string;
+    refreshExpiresIn?: number;
 }

package/dist/cjs/api/resources/documents/client/Client.d.ts

@@ -34,7 +34,7 @@ export declare class Documents {
     /**
      *  List Documents
      *
-     * @param {Corti.Uuid} id - The interaction ID representing the context for the request. Must be a valid UUID.
+     * @param {Corti.Uuid} id - The unique identifier of the interaction. Must be a valid UUID.
      * @param {Documents.RequestOptions} requestOptions - Request-specific configuration.
      *
      * @throws {@link Corti.BadRequestError}
@@ -45,13 +45,13 @@ export declare class Documents {
      * @example
      *     await client.documents.list("f47ac10b-58cc-4372-a567-0e02b2c3d479")
      */
-    list(id: Corti.Uuid, requestOptions?: Documents.RequestOptions): core.HttpResponsePromise<Corti.ResponseDocumentList>;
+    list(id: Corti.Uuid, requestOptions?: Documents.RequestOptions): core.HttpResponsePromise<Corti.DocumentsListResponse>;
     private __list;
     /**
      *  Generate Document.
      *
-     * @param {Corti.Uuid} id - The interaction ID representing the context for the request. Must be a valid UUID.
-     * @param {Corti.RequestDocumentCreate} request
+     * @param {Corti.Uuid} id - The unique identifier of the interaction. Must be a valid UUID.
+     * @param {Corti.DocumentsCreateRequest} request
      * @param {Documents.RequestOptions} requestOptions - Request-specific configuration.
      *
      * @throws {@link Corti.BadRequestError}
@@ -72,14 +72,13 @@ export declare class Documents {
      *         outputLanguage: "outputLanguage"
      *     })
      */
-    create(id: Corti.Uuid, request: Corti.RequestDocumentCreate, requestOptions?: Documents.RequestOptions): core.HttpResponsePromise<Corti.ResponseDocumentRead>;
+    create(id: Corti.Uuid, request: Corti.DocumentsCreateRequest, requestOptions?: Documents.RequestOptions): core.HttpResponsePromise<Corti.DocumentsGetResponse>;
     private __create;
     /**
      *  Get Document.
      *
-     * @param {Corti.Uuid} id - The interaction ID representing the context for the request. Must be a valid UUID.
+     * @param {Corti.Uuid} id - The unique identifier of the interaction. Must be a valid UUID.
      * @param {Corti.Uuid} documentId - The document ID representing the context for the request. Must be a valid UUID.
-     * @param {Corti.DocumentsGetRequest} request
      * @param {Documents.RequestOptions} requestOptions - Request-specific configuration.
      *
      * @throws {@link Corti.BadRequestError}
@@ -90,10 +89,10 @@ export declare class Documents {
      * @example
      *     await client.documents.get("f47ac10b-58cc-4372-a567-0e02b2c3d479", "f47ac10b-58cc-4372-a567-0e02b2c3d479")
      */
-    get(id: Corti.Uuid, documentId: Corti.Uuid, request?: Corti.DocumentsGetRequest, requestOptions?: Documents.RequestOptions): core.HttpResponsePromise<Corti.ResponseDocumentRead>;
+    get(id: Corti.Uuid, documentId: Corti.Uuid, requestOptions?: Documents.RequestOptions): core.HttpResponsePromise<Corti.DocumentsGetResponse>;
     private __get;
     /**
-     * @param {Corti.Uuid} id - The interaction ID representing the context for the request. Must be a valid UUID.
+     * @param {Corti.Uuid} id - The unique identifier of the interaction. Must be a valid UUID.
      * @param {Corti.Uuid} documentId - The document ID representing the context for the request. Must be a valid UUID.
      * @param {Documents.RequestOptions} requestOptions - Request-specific configuration.
      *
@@ -108,9 +107,9 @@ export declare class Documents {
     delete(id: Corti.Uuid, documentId: Corti.Uuid, requestOptions?: Documents.RequestOptions): core.HttpResponsePromise<void>;
     private __delete;
     /**
-     * @param {Corti.Uuid} id - The interaction ID representing the context for the request. Must be a valid UUID.
+     * @param {Corti.Uuid} id - The unique identifier of the interaction. Must be a valid UUID.
      * @param {Corti.Uuid} documentId - The document ID representing the context for the request. Must be a valid UUID.
-     * @param {Corti.RequestDocumentUpdate} request
+     * @param {Corti.DocumentsUpdateRequest} request
      * @param {Documents.RequestOptions} requestOptions - Request-specific configuration.
      *
      * @throws {@link Corti.BadRequestError}
@@ -121,7 +120,7 @@ export declare class Documents {
      * @example
      *     await client.documents.update("f47ac10b-58cc-4372-a567-0e02b2c3d479", "f47ac10b-58cc-4372-a567-0e02b2c3d479")
      */
-    update(id: Corti.Uuid, documentId: Corti.Uuid, request?: Corti.RequestDocumentUpdate, requestOptions?: Documents.RequestOptions): core.HttpResponsePromise<Corti.ResponseDocumentRead>;
+    update(id: Corti.Uuid, documentId: Corti.Uuid, request?: Corti.DocumentsUpdateRequest, requestOptions?: Documents.RequestOptions): core.HttpResponsePromise<Corti.DocumentsGetResponse>;
     private __update;
     protected _getAuthorizationHeader(): Promise<string | undefined>;
 }