@ichos/sdk 1.0.1

package/README.md

@@ -0,0 +1,5 @@
+# Ichos Public SDK
+
+This SDK is programatically generated, and immediately published to NPM.
+
+If you encounter issues with the SDK, you are welcome to open issues, though note that changes will be made to the original source code, not here.

package/dist/BaseClient.d.ts

@@ -0,0 +1,43 @@
+import { BearerAuthProvider } from "./auth/BearerAuthProvider.js";
+import * as core from "./core/index.js";
+import type * as environments from "./environments.js";
+export type BaseClientOptions = {
+    environment?: core.Supplier<environments.IchosEnvironment | string>;
+    /** Specify a custom URL to connect the client to. */
+    baseUrl?: core.Supplier<string>;
+    /** Override the x-virtual-user header */
+    virtualUser?: core.Supplier<string | undefined>;
+    /** Additional headers to include in requests. */
+    headers?: Record<string, string | core.Supplier<string | null | undefined> | null | undefined>;
+    /** The default maximum time to wait for a response in seconds. */
+    timeoutInSeconds?: number;
+    /** The default number of times to retry the request. Defaults to 2. */
+    maxRetries?: number;
+    /** Provide a custom fetch implementation. Useful for platforms that don't have a built-in fetch or need a custom implementation. */
+    fetch?: typeof fetch;
+    /** Configure logging for the client. */
+    logging?: core.logging.LogConfig | core.logging.Logger;
+} & BearerAuthProvider.AuthOptions;
+export interface BaseRequestOptions {
+    /** 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 x-virtual-user header */
+    virtualUser?: string | undefined;
+    /** Additional query string parameters to include in the request. */
+    queryParams?: Record<string, unknown>;
+    /** Additional headers to include in the request. */
+    headers?: Record<string, string | core.Supplier<string | null | undefined> | null | undefined>;
+}
+export type NormalizedClientOptions<T extends BaseClientOptions> = T & {
+    logging: core.logging.Logger;
+    authProvider?: core.AuthProvider;
+};
+export type NormalizedClientOptionsWithAuth<T extends BaseClientOptions> = NormalizedClientOptions<T> & {
+    authProvider: core.AuthProvider;
+};
+export declare function normalizeClientOptions<T extends BaseClientOptions>(options: T): NormalizedClientOptions<T>;
+export declare function normalizeClientOptionsWithAuth<T extends BaseClientOptions>(options: T): NormalizedClientOptionsWithAuth<T>;

package/dist/BaseClient.js

@@ -0,0 +1,29 @@
+// This file was auto-generated by Fern from our API Definition.
+import { BearerAuthProvider } from "./auth/BearerAuthProvider.js";
+import { mergeHeaders } from "./core/headers.js";
+import * as core from "./core/index.js";
+export function normalizeClientOptions(options) {
+    const headers = mergeHeaders({
+        "X-Fern-Language": "JavaScript",
+        "X-Fern-Runtime": core.RUNTIME.type,
+        "X-Fern-Runtime-Version": core.RUNTIME.version,
+        "x-virtual-user": options?.virtualUser,
+    }, options?.headers);
+    return {
+        ...options,
+        logging: core.logging.createLogger(options?.logging),
+        headers,
+    };
+}
+export function normalizeClientOptionsWithAuth(options) {
+    const normalized = normalizeClientOptions(options);
+    const normalizedWithNoOpAuthProvider = withNoOpAuthProvider(normalized);
+    normalized.authProvider ??= new BearerAuthProvider(normalizedWithNoOpAuthProvider);
+    return normalized;
+}
+function withNoOpAuthProvider(options) {
+    return {
+        ...options,
+        authProvider: new core.NoOpAuthProvider(),
+    };
+}

package/dist/Client.d.ts

@@ -0,0 +1,38 @@
+import { AdsClient } from "./api/resources/ads/client/Client.js";
+import { AnalyticsClient } from "./api/resources/analytics/client/Client.js";
+import { AudioClient } from "./api/resources/audio/client/Client.js";
+import { EpisodesClient } from "./api/resources/episodes/client/Client.js";
+import { OrganizationsClient } from "./api/resources/organizations/client/Client.js";
+import { PodcastsClient } from "./api/resources/podcasts/client/Client.js";
+import { SegmentsClient } from "./api/resources/segments/client/Client.js";
+import { UsersClient } from "./api/resources/users/client/Client.js";
+import { WebhooksClient } from "./api/resources/webhooks/client/Client.js";
+import type { BaseClientOptions, BaseRequestOptions } from "./BaseClient.js";
+import { type NormalizedClientOptionsWithAuth } from "./BaseClient.js";
+export declare namespace IchosClient {
+    type Options = BaseClientOptions;
+    interface RequestOptions extends BaseRequestOptions {
+    }
+}
+export declare class IchosClient {
+    protected readonly _options: NormalizedClientOptionsWithAuth<IchosClient.Options>;
+    protected _webhooks: WebhooksClient | undefined;
+    protected _segments: SegmentsClient | undefined;
+    protected _podcasts: PodcastsClient | undefined;
+    protected _episodes: EpisodesClient | undefined;
+    protected _users: UsersClient | undefined;
+    protected _organizations: OrganizationsClient | undefined;
+    protected _audio: AudioClient | undefined;
+    protected _analytics: AnalyticsClient | undefined;
+    protected _ads: AdsClient | undefined;
+    constructor(options: IchosClient.Options);
+    get webhooks(): WebhooksClient;
+    get segments(): SegmentsClient;
+    get podcasts(): PodcastsClient;
+    get episodes(): EpisodesClient;
+    get users(): UsersClient;
+    get organizations(): OrganizationsClient;
+    get audio(): AudioClient;
+    get analytics(): AnalyticsClient;
+    get ads(): AdsClient;
+}

package/dist/Client.js

@@ -0,0 +1,53 @@
+// This file was auto-generated by Fern from our API Definition.
+import { AdsClient } from "./api/resources/ads/client/Client.js";
+import { AnalyticsClient } from "./api/resources/analytics/client/Client.js";
+import { AudioClient } from "./api/resources/audio/client/Client.js";
+import { EpisodesClient } from "./api/resources/episodes/client/Client.js";
+import { OrganizationsClient } from "./api/resources/organizations/client/Client.js";
+import { PodcastsClient } from "./api/resources/podcasts/client/Client.js";
+import { SegmentsClient } from "./api/resources/segments/client/Client.js";
+import { UsersClient } from "./api/resources/users/client/Client.js";
+import { WebhooksClient } from "./api/resources/webhooks/client/Client.js";
+import { normalizeClientOptionsWithAuth } from "./BaseClient.js";
+export class IchosClient {
+    _options;
+    _webhooks;
+    _segments;
+    _podcasts;
+    _episodes;
+    _users;
+    _organizations;
+    _audio;
+    _analytics;
+    _ads;
+    constructor(options) {
+        this._options = normalizeClientOptionsWithAuth(options);
+    }
+    get webhooks() {
+        return (this._webhooks ??= new WebhooksClient(this._options));
+    }
+    get segments() {
+        return (this._segments ??= new SegmentsClient(this._options));
+    }
+    get podcasts() {
+        return (this._podcasts ??= new PodcastsClient(this._options));
+    }
+    get episodes() {
+        return (this._episodes ??= new EpisodesClient(this._options));
+    }
+    get users() {
+        return (this._users ??= new UsersClient(this._options));
+    }
+    get organizations() {
+        return (this._organizations ??= new OrganizationsClient(this._options));
+    }
+    get audio() {
+        return (this._audio ??= new AudioClient(this._options));
+    }
+    get analytics() {
+        return (this._analytics ??= new AnalyticsClient(this._options));
+    }
+    get ads() {
+        return (this._ads ??= new AdsClient(this._options));
+    }
+}

package/dist/api/errors/ForbiddenError.d.ts

@@ -0,0 +1,6 @@
+import type * as core from "../../core/index.js";
+import * as errors from "../../errors/index.js";
+import type * as Ichos from "../index.js";
+export declare class ForbiddenError extends errors.IchosError {
+    constructor(body: Ichos.UnauthenticatedErrorResponse, rawResponse?: core.RawResponse);
+}

package/dist/api/errors/ForbiddenError.js

@@ -0,0 +1,17 @@
+// This file was auto-generated by Fern from our API Definition.
+import * as errors from "../../errors/index.js";
+export class ForbiddenError extends errors.IchosError {
+    constructor(body, rawResponse) {
+        super({
+            message: "ForbiddenError",
+            statusCode: 403,
+            body: body,
+            rawResponse: rawResponse,
+        });
+        Object.setPrototypeOf(this, new.target.prototype);
+        if (Error.captureStackTrace) {
+            Error.captureStackTrace(this, this.constructor);
+        }
+        this.name = this.constructor.name;
+    }
+}

package/dist/api/errors/InternalServerError.d.ts

@@ -0,0 +1,6 @@
+import type * as core from "../../core/index.js";
+import * as errors from "../../errors/index.js";
+import type * as Ichos from "../index.js";
+export declare class InternalServerError extends errors.IchosError {
+    constructor(body: Ichos.InternalServerErrorResponse, rawResponse?: core.RawResponse);
+}

package/dist/api/errors/InternalServerError.js

@@ -0,0 +1,17 @@
+// This file was auto-generated by Fern from our API Definition.
+import * as errors from "../../errors/index.js";
+export class InternalServerError extends errors.IchosError {
+    constructor(body, rawResponse) {
+        super({
+            message: "InternalServerError",
+            statusCode: 500,
+            body: body,
+            rawResponse: rawResponse,
+        });
+        Object.setPrototypeOf(this, new.target.prototype);
+        if (Error.captureStackTrace) {
+            Error.captureStackTrace(this, this.constructor);
+        }
+        this.name = this.constructor.name;
+    }
+}

package/dist/api/errors/NotFoundError.d.ts

@@ -0,0 +1,6 @@
+import type * as core from "../../core/index.js";
+import * as errors from "../../errors/index.js";
+import type * as Ichos from "../index.js";
+export declare class NotFoundError extends errors.IchosError {
+    constructor(body: Ichos.NotFoundErrorResponse, rawResponse?: core.RawResponse);
+}

package/dist/api/errors/NotFoundError.js

@@ -0,0 +1,17 @@
+// This file was auto-generated by Fern from our API Definition.
+import * as errors from "../../errors/index.js";
+export class NotFoundError extends errors.IchosError {
+    constructor(body, rawResponse) {
+        super({
+            message: "NotFoundError",
+            statusCode: 404,
+            body: body,
+            rawResponse: rawResponse,
+        });
+        Object.setPrototypeOf(this, new.target.prototype);
+        if (Error.captureStackTrace) {
+            Error.captureStackTrace(this, this.constructor);
+        }
+        this.name = this.constructor.name;
+    }
+}

package/dist/api/errors/UnauthorizedError.d.ts

@@ -0,0 +1,6 @@
+import type * as core from "../../core/index.js";
+import * as errors from "../../errors/index.js";
+import type * as Ichos from "../index.js";
+export declare class UnauthorizedError extends errors.IchosError {
+    constructor(body: Ichos.UnauthorizedErrorResponse, rawResponse?: core.RawResponse);
+}

package/dist/api/errors/UnauthorizedError.js

@@ -0,0 +1,17 @@
+// This file was auto-generated by Fern from our API Definition.
+import * as errors from "../../errors/index.js";
+export class UnauthorizedError extends errors.IchosError {
+    constructor(body, rawResponse) {
+        super({
+            message: "UnauthorizedError",
+            statusCode: 401,
+            body: body,
+            rawResponse: rawResponse,
+        });
+        Object.setPrototypeOf(this, new.target.prototype);
+        if (Error.captureStackTrace) {
+            Error.captureStackTrace(this, this.constructor);
+        }
+        this.name = this.constructor.name;
+    }
+}

package/dist/api/errors/UnprocessableEntityError.d.ts

@@ -0,0 +1,6 @@
+import type * as core from "../../core/index.js";
+import * as errors from "../../errors/index.js";
+import type * as Ichos from "../index.js";
+export declare class UnprocessableEntityError extends errors.IchosError {
+    constructor(body: Ichos.ValidationErrorResponse, rawResponse?: core.RawResponse);
+}

package/dist/api/errors/UnprocessableEntityError.js

@@ -0,0 +1,17 @@
+// This file was auto-generated by Fern from our API Definition.
+import * as errors from "../../errors/index.js";
+export class UnprocessableEntityError extends errors.IchosError {
+    constructor(body, rawResponse) {
+        super({
+            message: "UnprocessableEntityError",
+            statusCode: 422,
+            body: body,
+            rawResponse: rawResponse,
+        });
+        Object.setPrototypeOf(this, new.target.prototype);
+        if (Error.captureStackTrace) {
+            Error.captureStackTrace(this, this.constructor);
+        }
+        this.name = this.constructor.name;
+    }
+}

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

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

package/dist/api/errors/index.js

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

package/dist/api/index.d.ts

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

package/dist/api/index.js

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

package/dist/api/resources/ads/client/Client.d.ts

@@ -0,0 +1,226 @@
+import type { BaseClientOptions, BaseRequestOptions } from "../../../../BaseClient.js";
+import { type NormalizedClientOptionsWithAuth } from "../../../../BaseClient.js";
+import * as core from "../../../../core/index.js";
+import * as Ichos from "../../../index.js";
+export declare namespace AdsClient {
+    type Options = BaseClientOptions;
+    interface RequestOptions extends BaseRequestOptions {
+    }
+}
+export declare class AdsClient {
+    protected readonly _options: NormalizedClientOptionsWithAuth<AdsClient.Options>;
+    constructor(options: AdsClient.Options);
+    /**
+     * Create a new ad. Ads are associated with either an organization or a virtual user.
+     * An organization ad must have an organizationId and no virtualUserId.
+     * A virtual user ad must have both an organizationId and a virtualUserId.
+     * Audio for the ad will need to be uploaded separately and linked via the /link-audio endpoint.
+     *
+     * @param {Ichos.AdCreate} request
+     * @param {AdsClient.RequestOptions} requestOptions - Request-specific configuration.
+     *
+     * @throws {@link Ichos.UnauthorizedError}
+     * @throws {@link Ichos.ForbiddenError}
+     * @throws {@link Ichos.InternalServerError}
+     *
+     * @example
+     *     await client.ads.createAd({
+     *         active: true,
+     *         label: "label",
+     *         type: "organization",
+     *         organizationId: "organizationId"
+     *     })
+     */
+    createAd(request: Ichos.AdCreate, requestOptions?: AdsClient.RequestOptions): core.HttpResponsePromise<Ichos.AdResponse>;
+    private __createAd;
+    /**
+     * Delete an ad.
+     * Optionally delete the associated audio file.
+     *
+     * @param {Ichos.DeleteAdRequest} request
+     * @param {AdsClient.RequestOptions} requestOptions - Request-specific configuration.
+     *
+     * @throws {@link Ichos.UnauthorizedError}
+     * @throws {@link Ichos.ForbiddenError}
+     * @throws {@link Ichos.NotFoundError}
+     * @throws {@link Ichos.InternalServerError}
+     *
+     * @example
+     *     await client.ads.deleteAd({
+     *         adId: "adId"
+     *     })
+     */
+    deleteAd(request: Ichos.DeleteAdRequest, requestOptions?: AdsClient.RequestOptions): core.HttpResponsePromise<Ichos.NullResponse>;
+    private __deleteAd;
+    /**
+     * Update an existing ad
+     *
+     * @param {Ichos.AdUpdate} request
+     * @param {AdsClient.RequestOptions} requestOptions - Request-specific configuration.
+     *
+     * @throws {@link Ichos.UnauthorizedError}
+     * @throws {@link Ichos.ForbiddenError}
+     * @throws {@link Ichos.InternalServerError}
+     *
+     * @example
+     *     await client.ads.updateAd({
+     *         adId: "adId"
+     *     })
+     */
+    updateAd(request: Ichos.AdUpdate, requestOptions?: AdsClient.RequestOptions): core.HttpResponsePromise<Ichos.AdResponse>;
+    private __updateAd;
+    /**
+     * Link an audio file to an ad.
+     * This associates an uploaded audio file with the ad definition.
+     *
+     * @param {Ichos.LinkAdAudioRequest} request
+     * @param {AdsClient.RequestOptions} requestOptions - Request-specific configuration.
+     *
+     * @throws {@link Ichos.UnauthorizedError}
+     * @throws {@link Ichos.ForbiddenError}
+     * @throws {@link Ichos.InternalServerError}
+     *
+     * @example
+     *     await client.ads.linkAdAudio({
+     *         adId: "adId",
+     *         audioId: "audioId"
+     *     })
+     */
+    linkAdAudio(request: Ichos.LinkAdAudioRequest, requestOptions?: AdsClient.RequestOptions): core.HttpResponsePromise<Ichos.NullResponse>;
+    private __linkAdAudio;
+    /**
+     * Retrieve all ads for the authenticated organization
+     *
+     * @param {AdsClient.RequestOptions} requestOptions - Request-specific configuration.
+     *
+     * @throws {@link Ichos.UnauthorizedError}
+     * @throws {@link Ichos.ForbiddenError}
+     * @throws {@link Ichos.NotFoundError}
+     * @throws {@link Ichos.InternalServerError}
+     *
+     * @example
+     *     await client.ads.listOrganizationAds()
+     */
+    listOrganizationAds(requestOptions?: AdsClient.RequestOptions): core.HttpResponsePromise<Ichos.AdListResponse>;
+    private __listOrganizationAds;
+    /**
+     * Retrieve all ads for a specific virtual user
+     *
+     * @param {Ichos.ListVirtualUserAdsRequest} request
+     * @param {AdsClient.RequestOptions} requestOptions - Request-specific configuration.
+     *
+     * @throws {@link Ichos.UnauthorizedError}
+     * @throws {@link Ichos.ForbiddenError}
+     * @throws {@link Ichos.NotFoundError}
+     * @throws {@link Ichos.InternalServerError}
+     *
+     * @example
+     *     await client.ads.listVirtualUserAds()
+     */
+    listVirtualUserAds(request?: Ichos.ListVirtualUserAdsRequest, requestOptions?: AdsClient.RequestOptions): core.HttpResponsePromise<Ichos.AdListResponse>;
+    private __listVirtualUserAds;
+    /**
+     * Retrieve ad weights for the authenticated virtual user
+     *
+     * @param {AdsClient.RequestOptions} requestOptions - Request-specific configuration.
+     *
+     * @throws {@link Ichos.UnauthorizedError}
+     * @throws {@link Ichos.ForbiddenError}
+     * @throws {@link Ichos.NotFoundError}
+     * @throws {@link Ichos.InternalServerError}
+     *
+     * @example
+     *     await client.ads.listAdWeights()
+     */
+    listAdWeights(requestOptions?: AdsClient.RequestOptions): core.HttpResponsePromise<Ichos.AdWeightListResponse>;
+    private __listAdWeights;
+    /**
+     * Update the ad weight for a virtual user or organization
+     *
+     * @param {Ichos.UpdateAdWeightRequest} request
+     * @param {AdsClient.RequestOptions} requestOptions - Request-specific configuration.
+     *
+     * @throws {@link Ichos.UnauthorizedError}
+     * @throws {@link Ichos.ForbiddenError}
+     * @throws {@link Ichos.NotFoundError}
+     * @throws {@link Ichos.InternalServerError}
+     *
+     * @example
+     *     await client.ads.updateAdWeight({
+     *         weight: 1.1
+     *     })
+     */
+    updateAdWeight(request: Ichos.UpdateAdWeightRequest, requestOptions?: AdsClient.RequestOptions): core.HttpResponsePromise<Ichos.AdWeightListResponse>;
+    private __updateAdWeight;
+    /**
+     * Retrieve all ad weights for the organization
+     *
+     * @param {AdsClient.RequestOptions} requestOptions - Request-specific configuration.
+     *
+     * @throws {@link Ichos.UnauthorizedError}
+     * @throws {@link Ichos.ForbiddenError}
+     * @throws {@link Ichos.NotFoundError}
+     * @throws {@link Ichos.InternalServerError}
+     *
+     * @example
+     *     await client.ads.listAllAdWeights()
+     */
+    listAllAdWeights(requestOptions?: AdsClient.RequestOptions): core.HttpResponsePromise<Ichos.AdWeightListResponse>;
+    private __listAllAdWeights;
+    /**
+     * Update multiple ad weights in bulk
+     *
+     * @param {Ichos.AdWeight[]} request
+     * @param {AdsClient.RequestOptions} requestOptions - Request-specific configuration.
+     *
+     * @throws {@link Ichos.UnauthorizedError}
+     * @throws {@link Ichos.ForbiddenError}
+     * @throws {@link Ichos.NotFoundError}
+     * @throws {@link Ichos.InternalServerError}
+     *
+     * @example
+     *     await client.ads.updateAdWeightBulk([{
+     *             organizationId: "organizationId",
+     *             weight: 1.1
+     *         }])
+     */
+    updateAdWeightBulk(request: Ichos.AdWeight[], requestOptions?: AdsClient.RequestOptions): core.HttpResponsePromise<Ichos.AdWeightListResponse>;
+    private __updateAdWeightBulk;
+    /**
+     * Create a new ad insertion point for an episode
+     *
+     * @param {Ichos.AdInsertionPointCreate} request
+     * @param {AdsClient.RequestOptions} requestOptions - Request-specific configuration.
+     *
+     * @throws {@link Ichos.UnauthorizedError}
+     * @throws {@link Ichos.ForbiddenError}
+     * @throws {@link Ichos.NotFoundError}
+     * @throws {@link Ichos.InternalServerError}
+     *
+     * @example
+     *     await client.ads.createAdInsertionPoint({
+     *         episodeId: "episodeId",
+     *         offsetSeconds: 1.1
+     *     })
+     */
+    createAdInsertionPoint(request: Ichos.AdInsertionPointCreate, requestOptions?: AdsClient.RequestOptions): core.HttpResponsePromise<Ichos.AdInsertionPointResponse>;
+    private __createAdInsertionPoint;
+    /**
+     * Retrieve all ad insertion points for a specific episode
+     *
+     * @param {Ichos.ListAdInsertionPointsRequest} request
+     * @param {AdsClient.RequestOptions} requestOptions - Request-specific configuration.
+     *
+     * @throws {@link Ichos.UnauthorizedError}
+     * @throws {@link Ichos.ForbiddenError}
+     * @throws {@link Ichos.NotFoundError}
+     * @throws {@link Ichos.InternalServerError}
+     *
+     * @example
+     *     await client.ads.listAdInsertionPoints({
+     *         episodeId: "episodeId"
+     *     })
+     */
+    listAdInsertionPoints(request: Ichos.ListAdInsertionPointsRequest, requestOptions?: AdsClient.RequestOptions): core.HttpResponsePromise<Ichos.AdInsertionPointListResponse>;
+    private __listAdInsertionPoints;
+}