@ichos/sdk 1.0.2 → 1.0.4

package/src/api/types/Segment.ts

@@ -0,0 +1,28 @@
+// This file was auto-generated by Fern from our API Definition.
+
+export interface Segment {
+    id: string;
+    scope: Segment.Scope;
+    active: boolean;
+    type: Segment.Type;
+    organizationId?: string | null;
+    virtualUserId?: string | null;
+    podcastId?: string | null;
+    audioId?: string | null;
+    createdAt: string;
+    updatedAt: string;
+}
+
+export namespace Segment {
+    export const Scope = {
+        Organization: "organization",
+        VirtualUser: "virtual_user",
+        Podcast: "podcast",
+    } as const;
+    export type Scope = (typeof Scope)[keyof typeof Scope];
+    export const Type = {
+        Intro: "intro",
+        Outro: "outro",
+    } as const;
+    export type Type = (typeof Type)[keyof typeof Type];
+}

package/src/api/types/SegmentId.ts

@@ -0,0 +1,12 @@
+// This file was auto-generated by Fern from our API Definition.
+
+export interface SegmentId {
+    undefined?: SegmentId.Undefined;
+}
+
+export namespace SegmentId {
+    export const Undefined = {
+        SegmentId: "SegmentId",
+    } as const;
+    export type Undefined = (typeof Undefined)[keyof typeof Undefined];
+}

package/src/api/types/SegmentListResponse.ts

@@ -0,0 +1,9 @@
+// This file was auto-generated by Fern from our API Definition.
+
+import type * as Ichos from "../index.js";
+
+export interface SegmentListResponse {
+    success: boolean;
+    data: Ichos.Segment[];
+    meta: Ichos.ApiMetaSuccess;
+}

package/src/api/types/SegmentResponse.ts

@@ -0,0 +1,9 @@
+// This file was auto-generated by Fern from our API Definition.
+
+import type * as Ichos from "../index.js";
+
+export interface SegmentResponse {
+    success: boolean;
+    data: Ichos.Segment;
+    meta: Ichos.ApiMetaSuccess;
+}

package/src/api/types/StringOrNullResponse.ts

@@ -0,0 +1,9 @@
+// This file was auto-generated by Fern from our API Definition.
+
+import type * as Ichos from "../index.js";
+
+export interface StringOrNullResponse {
+    success: boolean;
+    data: string | null;
+    meta: Ichos.ApiMetaSuccess;
+}

package/src/api/types/StringResponse.ts

@@ -0,0 +1,9 @@
+// This file was auto-generated by Fern from our API Definition.
+
+import type * as Ichos from "../index.js";
+
+export interface StringResponse {
+    success: boolean;
+    data: string;
+    meta: Ichos.ApiMetaSuccess;
+}

package/src/api/types/TranscriptCompletedPayload.ts

@@ -0,0 +1,6 @@
+// This file was auto-generated by Fern from our API Definition.
+
+export interface TranscriptCompletedPayload {
+    audioId: string;
+    transcriptId: string;
+}

package/src/api/types/UnauthenticatedError.ts

@@ -0,0 +1,10 @@
+// This file was auto-generated by Fern from our API Definition.
+
+export interface UnauthenticatedError {
+    name: string;
+    message: string;
+    stack?: string;
+    statusCode: number;
+    errorCode: string;
+    errorMessage: string;
+}

package/src/api/types/UnauthenticatedErrorResponse.ts

@@ -0,0 +1,9 @@
+// This file was auto-generated by Fern from our API Definition.
+
+import type * as Ichos from "../index.js";
+
+export interface UnauthenticatedErrorResponse {
+    success: boolean;
+    error: Ichos.UnauthenticatedError;
+    meta: Ichos.ApiMeta;
+}

package/src/api/types/UnauthorizedErrorBody.ts

@@ -0,0 +1,10 @@
+// This file was auto-generated by Fern from our API Definition.
+
+export interface UnauthorizedErrorBody {
+    name: string;
+    message: string;
+    stack?: string;
+    statusCode: number;
+    errorCode: string;
+    errorMessage: string;
+}

package/src/api/types/UnauthorizedErrorResponse.ts

@@ -0,0 +1,9 @@
+// This file was auto-generated by Fern from our API Definition.
+
+import type * as Ichos from "../index.js";
+
+export interface UnauthorizedErrorResponse {
+    success: boolean;
+    error: Ichos.UnauthorizedErrorBody;
+    meta: Ichos.ApiMeta;
+}

package/src/api/types/UserUploadAudioResponse.ts

@@ -0,0 +1,9 @@
+// This file was auto-generated by Fern from our API Definition.
+
+import type * as Ichos from "../index.js";
+
+export interface UserUploadAudioResponse {
+    success: boolean;
+    data: Ichos.UserUploadAudioResult;
+    meta: Ichos.ApiMetaSuccess;
+}

package/src/api/types/UserUploadAudioResult.ts

@@ -0,0 +1,7 @@
+// This file was auto-generated by Fern from our API Definition.
+
+export interface UserUploadAudioResult {
+    putUrl: string;
+    key: string;
+    audioId: string;
+}

package/src/api/types/UserUploadCoverResponse.ts

@@ -0,0 +1,9 @@
+// This file was auto-generated by Fern from our API Definition.
+
+import type * as Ichos from "../index.js";
+
+export interface UserUploadCoverResponse {
+    success: boolean;
+    data: Ichos.UserUploadCoverResult;
+    meta: Ichos.ApiMetaSuccess;
+}

package/src/api/types/UserUploadCoverResult.ts

@@ -0,0 +1,7 @@
+// This file was auto-generated by Fern from our API Definition.
+
+export interface UserUploadCoverResult {
+    putUrl: string;
+    key: string;
+    publicUrl: string;
+}

package/src/api/types/UserUploadCoverResultResponse.ts

@@ -0,0 +1,9 @@
+// This file was auto-generated by Fern from our API Definition.
+
+import type * as Ichos from "../index.js";
+
+export interface UserUploadCoverResultResponse {
+    success: boolean;
+    data: Ichos.UserUploadCoverResult;
+    meta: Ichos.ApiMetaSuccess;
+}

package/src/api/types/ValidationErrorResponse.ts

@@ -0,0 +1,9 @@
+// This file was auto-generated by Fern from our API Definition.
+
+import type * as Ichos from "../index.js";
+
+export interface ValidationErrorResponse {
+    success: boolean;
+    error: Ichos.UnauthorizedErrorBody;
+    meta: Ichos.ApiMeta;
+}

package/src/api/types/ValidationIssue.ts

@@ -0,0 +1,20 @@
+// This file was auto-generated by Fern from our API Definition.
+
+export interface ValidationIssue {
+    entity: ValidationIssue.Entity;
+    entityId?: string;
+    code: string;
+    message: string;
+    field?: string;
+}
+
+export namespace ValidationIssue {
+    export const Entity = {
+        Episode: "episode",
+        Podcast: "podcast",
+        RssFeed: "rss_feed",
+        EpisodeCover: "episode-cover",
+        Audio: "audio",
+    } as const;
+    export type Entity = (typeof Entity)[keyof typeof Entity];
+}

package/src/api/types/VirtualUser.ts

@@ -0,0 +1,12 @@
+// This file was auto-generated by Fern from our API Definition.
+
+export interface VirtualUser {
+    /** The user' external ID. Provided by the API consumer */
+    externalId: string;
+    /** The organization ID this user belongs to. */
+    organizationId: string;
+    /** Whether this is the default user for the organization. */
+    isDefault: boolean;
+    /** Whether ads are enabled for this virtual user. */
+    adsEnabled: boolean;
+}

package/src/api/types/VirtualUserListResponse.ts

@@ -0,0 +1,9 @@
+// This file was auto-generated by Fern from our API Definition.
+
+import type * as Ichos from "../index.js";
+
+export interface VirtualUserListResponse {
+    success: boolean;
+    data: Ichos.VirtualUser[];
+    meta: Ichos.ApiMetaSuccess;
+}

package/src/api/types/VirtualUserResponse.ts

@@ -0,0 +1,9 @@
+// This file was auto-generated by Fern from our API Definition.
+
+import type * as Ichos from "../index.js";
+
+export interface VirtualUserResponse {
+    success: boolean;
+    data: Ichos.VirtualUser;
+    meta: Ichos.ApiMetaSuccess;
+}

package/src/api/types/WebhookDestination.ts

@@ -0,0 +1,9 @@
+// This file was auto-generated by Fern from our API Definition.
+
+export interface WebhookDestination {
+    destinationUrl: string;
+    id: string;
+    organizationId: string;
+    secret: string;
+    active: boolean;
+}

package/src/api/types/WebhookDestinationResponse.ts

@@ -0,0 +1,9 @@
+// This file was auto-generated by Fern from our API Definition.
+
+import type * as Ichos from "../index.js";
+
+export interface WebhookDestinationResponse {
+    success: boolean;
+    data: Ichos.WebhookDestination;
+    meta: Ichos.ApiMetaSuccess;
+}

package/src/api/types/WebhookEvent.ts

@@ -0,0 +1,37 @@
+// This file was auto-generated by Fern from our API Definition.
+
+import type * as Ichos from "../index.js";
+
+export interface WebhookEvent {
+    id: string;
+    destinationId: string;
+    organizationId: string;
+    destinationUrl: string;
+    eventType: WebhookEvent.EventType;
+    data: WebhookEvent.Data;
+    status: WebhookEvent.Status;
+    attempts: number;
+}
+
+export namespace WebhookEvent {
+    export const EventType = {
+        TranscriptCompleted: "transcript.completed",
+        AudioPulled: "audio.pulled",
+        AudioProcessed: "audio.processed",
+        PodcastImportCompleted: "podcast.import.completed",
+        PodcastImportFailed: "podcast.import.failed",
+    } as const;
+    export type EventType = (typeof EventType)[keyof typeof EventType];
+    export type Data =
+        | Ichos.TranscriptCompletedPayload
+        | Ichos.AudioPulledPayload
+        | Ichos.AudioProcessedPayload
+        | Ichos.PodcastImportCompletedPayload
+        | Ichos.PodcastImportFailedPayload;
+    export const Status = {
+        Pending: "pending",
+        Delivered: "delivered",
+        Failed: "failed",
+    } as const;
+    export type Status = (typeof Status)[keyof typeof Status];
+}

package/src/api/types/index.ts

@@ -0,0 +1,76 @@
+export * from "./Ad.js";
+export * from "./AdId.js";
+export * from "./AdInsertionPoint.js";
+export * from "./AdInsertionPointListResponse.js";
+export * from "./AdInsertionPointResponse.js";
+export * from "./AdListResponse.js";
+export * from "./AdResponse.js";
+export * from "./AdWeight.js";
+export * from "./AdWeightListResponse.js";
+export * from "./ApiMeta.js";
+export * from "./ApiMetaSuccess.js";
+export * from "./ApplePodcastCategory.js";
+export * from "./Audio.js";
+export * from "./AudioEntityLink.js";
+export * from "./AudioProcessedPayload.js";
+export * from "./AudioPulledPayload.js";
+export * from "./AudioPullResponse.js";
+export * from "./AudioPullStatusResponse.js";
+export * from "./AudioResponse.js";
+export * from "./AudioUploadOptions.js";
+export * from "./AudioUploadResponse.js";
+export * from "./AuthenticatedOrganizationResponse.js";
+export * from "./Chapter.js";
+export * from "./CoverUploadOptions.js";
+export * from "./CoverUploadResponse.js";
+export * from "./Episode.js";
+export * from "./EpisodeCreatedResponseData.js";
+export * from "./EpisodeCreateResponse.js";
+export * from "./EpisodeId.js";
+export * from "./EpisodeResponse.js";
+export * from "./EpisodesResponse.js";
+export * from "./EpisodeTranscript.js";
+export * from "./InternalServerErrorBody.js";
+export * from "./InternalServerErrorResponse.js";
+export * from "./Listeners.js";
+export * from "./ListenersReport.js";
+export * from "./ListenersReportResponse.js";
+export * from "./ListWebhookDestinationsResponse.js";
+export * from "./ListWebhookEventsResponse.js";
+export * from "./MonthlyListenersResponse.js";
+export * from "./NotFoundErrorBody.js";
+export * from "./NotFoundErrorResponse.js";
+export * from "./NullResponse.js";
+export * from "./Organization.js";
+export * from "./Person.js";
+export * from "./Podcast.js";
+export * from "./PodcastImportCompletedPayload.js";
+export * from "./PodcastImportFailedPayload.js";
+export * from "./PodcastResponse.js";
+export * from "./PodcastsResponse.js";
+export * from "./PublishPodcastOutput.js";
+export * from "./RetrieveCoverResponse.js";
+export * from "./Segment.js";
+export * from "./SegmentId.js";
+export * from "./SegmentListResponse.js";
+export * from "./SegmentResponse.js";
+export * from "./StringOrNullResponse.js";
+export * from "./StringResponse.js";
+export * from "./TranscriptCompletedPayload.js";
+export * from "./UnauthenticatedError.js";
+export * from "./UnauthenticatedErrorResponse.js";
+export * from "./UnauthorizedErrorBody.js";
+export * from "./UnauthorizedErrorResponse.js";
+export * from "./UserUploadAudioResponse.js";
+export * from "./UserUploadAudioResult.js";
+export * from "./UserUploadCoverResponse.js";
+export * from "./UserUploadCoverResult.js";
+export * from "./UserUploadCoverResultResponse.js";
+export * from "./ValidationErrorResponse.js";
+export * from "./ValidationIssue.js";
+export * from "./VirtualUser.js";
+export * from "./VirtualUserListResponse.js";
+export * from "./VirtualUserResponse.js";
+export * from "./WebhookDestination.js";
+export * from "./WebhookDestinationResponse.js";
+export * from "./WebhookEvent.js";

package/src/auth/BearerAuthProvider.ts

@@ -0,0 +1,37 @@
+// This file was auto-generated by Fern from our API Definition.
+
+import * as core from "../core/index.js";
+import * as errors from "../errors/index.js";
+
+export namespace BearerAuthProvider {
+    export interface AuthOptions {
+        token: core.Supplier<core.BearerToken>;
+    }
+
+    export interface Options extends AuthOptions {}
+}
+
+export class BearerAuthProvider implements core.AuthProvider {
+    private readonly token: core.Supplier<core.BearerToken>;
+
+    constructor(options: BearerAuthProvider.Options) {
+        this.token = options.token;
+    }
+
+    public static canCreate(options: BearerAuthProvider.Options): boolean {
+        return options.token != null;
+    }
+
+    public async getAuthRequest(_arg?: { endpointMetadata?: core.EndpointMetadata }): Promise<core.AuthRequest> {
+        const token = await core.Supplier.get(this.token);
+        if (token == null) {
+            throw new errors.IchosError({
+                message: "Please specify a token by passing it in to the constructor",
+            });
+        }
+
+        return {
+            headers: { Authorization: `Bearer ${token}` },
+        };
+    }
+}

package/src/auth/index.ts

@@ -0,0 +1 @@
+export { BearerAuthProvider } from "./BearerAuthProvider.js";

package/src/core/auth/AuthProvider.ts

@@ -0,0 +1,6 @@
+import type { EndpointMetadata } from "../fetcher/EndpointMetadata.js";
+import type { AuthRequest } from "./AuthRequest.js";
+
+export interface AuthProvider {
+    getAuthRequest(arg?: { endpointMetadata?: EndpointMetadata }): Promise<AuthRequest>;
+}

package/src/core/auth/AuthRequest.ts

@@ -0,0 +1,9 @@
+/**
+ * Request parameters for authentication requests.
+ */
+export interface AuthRequest {
+    /**
+     * The headers to be included in the request.
+     */
+    headers: Record<string, string>;
+}

package/src/core/auth/BasicAuth.ts

@@ -0,0 +1,32 @@
+import { base64Decode, base64Encode } from "../base64.js";
+
+export interface BasicAuth {
+    username: string;
+    password: string;
+}
+
+const BASIC_AUTH_HEADER_PREFIX = /^Basic /i;
+
+export const BasicAuth = {
+    toAuthorizationHeader: (basicAuth: BasicAuth | undefined): string | undefined => {
+        if (basicAuth == null) {
+            return undefined;
+        }
+        const token = base64Encode(`${basicAuth.username}:${basicAuth.password}`);
+        return `Basic ${token}`;
+    },
+    fromAuthorizationHeader: (header: string): BasicAuth => {
+        const credentials = header.replace(BASIC_AUTH_HEADER_PREFIX, "");
+        const decoded = base64Decode(credentials);
+        const [username, ...passwordParts] = decoded.split(":");
+        const password = passwordParts.length > 0 ? passwordParts.join(":") : undefined;
+
+        if (username == null || password == null) {
+            throw new Error("Invalid basic auth");
+        }
+        return {
+            username,
+            password,
+        };
+    },
+};

package/src/core/auth/BearerToken.ts

@@ -0,0 +1,20 @@
+export type BearerToken = string;
+
+const BEARER_AUTH_HEADER_PREFIX = /^Bearer /i;
+
+function toAuthorizationHeader(token: string | undefined): string | undefined {
+    if (token == null) {
+        return undefined;
+    }
+    return `Bearer ${token}`;
+}
+
+export const BearerToken: {
+    toAuthorizationHeader: typeof toAuthorizationHeader;
+    fromAuthorizationHeader: (header: string) => BearerToken;
+} = {
+    toAuthorizationHeader: toAuthorizationHeader,
+    fromAuthorizationHeader: (header: string): BearerToken => {
+        return header.replace(BEARER_AUTH_HEADER_PREFIX, "").trim() as BearerToken;
+    },
+};

package/src/core/auth/NoOpAuthProvider.ts

@@ -0,0 +1,8 @@
+import type { AuthProvider } from "./AuthProvider.js";
+import type { AuthRequest } from "./AuthRequest.js";
+
+export class NoOpAuthProvider implements AuthProvider {
+    public getAuthRequest(): Promise<AuthRequest> {
+        return Promise.resolve({ headers: {} });
+    }
+}

package/src/core/auth/index.ts

@@ -0,0 +1,5 @@
+export type { AuthProvider } from "./AuthProvider.js";
+export type { AuthRequest } from "./AuthRequest.js";
+export { BasicAuth } from "./BasicAuth.js";
+export { BearerToken } from "./BearerToken.js";
+export { NoOpAuthProvider } from "./NoOpAuthProvider.js";

package/src/core/base64.ts

@@ -0,0 +1,27 @@
+function base64ToBytes(base64: string): Uint8Array {
+    const binString = atob(base64);
+    return Uint8Array.from(binString, (m) => m.codePointAt(0)!);
+}
+
+function bytesToBase64(bytes: Uint8Array): string {
+    const binString = String.fromCodePoint(...bytes);
+    return btoa(binString);
+}
+
+export function base64Encode(input: string): string {
+    if (typeof Buffer !== "undefined") {
+        return Buffer.from(input, "utf8").toString("base64");
+    }
+
+    const bytes = new TextEncoder().encode(input);
+    return bytesToBase64(bytes);
+}
+
+export function base64Decode(input: string): string {
+    if (typeof Buffer !== "undefined") {
+        return Buffer.from(input, "base64").toString("utf8");
+    }
+
+    const bytes = base64ToBytes(input);
+    return new TextDecoder().decode(bytes);
+}

package/src/core/exports.ts

@@ -0,0 +1 @@
+export * from "./logging/exports.js";

package/src/core/fetcher/APIResponse.ts

@@ -0,0 +1,23 @@
+import type { RawResponse } from "./RawResponse.js";
+
+/**
+ * The response of an API call.
+ * It is a successful response or a failed response.
+ */
+export type APIResponse<Success, Failure> = SuccessfulResponse<Success> | FailedResponse<Failure>;
+
+export interface SuccessfulResponse<T> {
+    ok: true;
+    body: T;
+    /**
+     * @deprecated Use `rawResponse` instead
+     */
+    headers?: Record<string, any>;
+    rawResponse: RawResponse;
+}
+
+export interface FailedResponse<T> {
+    ok: false;
+    error: T;
+    rawResponse: RawResponse;
+}

package/src/core/fetcher/BinaryResponse.ts

@@ -0,0 +1,34 @@
+export type BinaryResponse = {
+    /** [MDN Reference](https://developer.mozilla.org/docs/Web/API/Request/bodyUsed) */
+    bodyUsed: Response["bodyUsed"];
+    /**
+     * Returns a ReadableStream of the response body.
+     * [MDN Reference](https://developer.mozilla.org/docs/Web/API/Request/body)
+     */
+    stream: () => Response["body"];
+    /** [MDN Reference](https://developer.mozilla.org/docs/Web/API/Request/arrayBuffer) */
+    arrayBuffer: () => ReturnType<Response["arrayBuffer"]>;
+    /** [MDN Reference](https://developer.mozilla.org/docs/Web/API/Request/blob) */
+    blob: () => ReturnType<Response["blob"]>;
+    /**
+     * [MDN Reference](https://developer.mozilla.org/docs/Web/API/Request/bytes)
+     * Some versions of the Fetch API may not support this method.
+     */
+    bytes?(): ReturnType<Response["bytes"]>;
+};
+
+export function getBinaryResponse(response: Response): BinaryResponse {
+    const binaryResponse: BinaryResponse = {
+        get bodyUsed() {
+            return response.bodyUsed;
+        },
+        stream: () => response.body,
+        arrayBuffer: response.arrayBuffer.bind(response),
+        blob: response.blob.bind(response),
+    };
+    if ("bytes" in response && typeof response.bytes === "function") {
+        binaryResponse.bytes = response.bytes.bind(response);
+    }
+
+    return binaryResponse;
+}

package/src/core/fetcher/EndpointMetadata.ts

@@ -0,0 +1,13 @@
+export type SecuritySchemeKey = string;
+/**
+ * A collection of security schemes, where the key is the name of the security scheme and the value is the list of scopes required for that scheme.
+ * All schemes in the collection must be satisfied for authentication to be successful.
+ */
+export type SecuritySchemeCollection = Record<SecuritySchemeKey, AuthScope[]>;
+export type AuthScope = string;
+export type EndpointMetadata = {
+    /**
+     * An array of security scheme collections. Each collection represents an alternative way to authenticate.
+     */
+    security?: SecuritySchemeCollection[];
+};

package/src/core/fetcher/EndpointSupplier.ts

@@ -0,0 +1,14 @@
+import type { EndpointMetadata } from "./EndpointMetadata.js";
+import type { Supplier } from "./Supplier.js";
+
+type EndpointSupplierFn<T> = (arg: { endpointMetadata: EndpointMetadata }) => T | Promise<T>;
+export type EndpointSupplier<T> = Supplier<T> | EndpointSupplierFn<T>;
+export const EndpointSupplier = {
+    get: async <T>(supplier: EndpointSupplier<T>, arg: { endpointMetadata: EndpointMetadata }): Promise<T> => {
+        if (typeof supplier === "function") {
+            return (supplier as EndpointSupplierFn<T>)(arg);
+        } else {
+            return supplier;
+        }
+    },
+};