@ichos/sdk 1.0.2 → 1.0.4

package/src/api/resources/episodes/client/index.ts

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

package/src/api/resources/episodes/client/requests/DeleteEpisodeRequest.ts

@@ -0,0 +1,14 @@
+// This file was auto-generated by Fern from our API Definition.
+
+/**
+ * @example
+ *     {
+ *         episodeId: "episodeId"
+ *     }
+ */
+export interface DeleteEpisodeRequest {
+    /** - The ID of the episode to delete */
+    episodeId: string;
+    /** - Whether to also delete the linked audio file (default: false) */
+    deleteAudio?: boolean;
+}

package/src/api/resources/episodes/client/requests/EpisodeCreate.ts

@@ -0,0 +1,49 @@
+// This file was auto-generated by Fern from our API Definition.
+
+import type * as Ichos from "../../../../index.js";
+
+/**
+ * @example
+ *     {
+ *         podcastId: "podcastId",
+ *         title: "title"
+ *     }
+ */
+export interface EpisodeCreate {
+    podcastId: string;
+    title: string;
+    adsEnabled?: boolean;
+    link?: string | null;
+    description?: string | null;
+    explicit?: boolean | null;
+    block?: boolean | null;
+    pubDate?: string | null;
+    season?: number | null;
+    episode?: number | null;
+    episodeType?: EpisodeCreate.EpisodeType | null;
+    coverKey?: string | null;
+    transcripts?: Ichos.EpisodeTranscript[] | null;
+    chaptersUrl?: string | null;
+    persons?: Ichos.Person[] | null;
+    license?: string | null;
+    status?: EpisodeCreate.Status;
+    autoPublish?: boolean;
+    coverOptions?: Ichos.CoverUploadOptions;
+    audioOptions?: Ichos.AudioUploadOptions;
+}
+
+export namespace EpisodeCreate {
+    export const EpisodeType = {
+        Full: "full",
+        Trailer: "trailer",
+        Bonus: "bonus",
+    } as const;
+    export type EpisodeType = (typeof EpisodeType)[keyof typeof EpisodeType];
+    export const Status = {
+        Draft: "draft",
+        Scheduled: "scheduled",
+        Published: "published",
+        Deleted: "deleted",
+    } as const;
+    export type Status = (typeof Status)[keyof typeof Status];
+}

package/src/api/resources/episodes/client/requests/EpisodeUpdate.ts

@@ -0,0 +1,49 @@
+// This file was auto-generated by Fern from our API Definition.
+
+import type * as Ichos from "../../../../index.js";
+
+/**
+ * @example
+ *     {
+ *         episodeId: "episodeId"
+ *     }
+ */
+export interface EpisodeUpdate {
+    /** - The ID of the episode to update */
+    episodeId: string;
+    title?: string;
+    link?: string;
+    description?: string;
+    adsEnabled?: boolean;
+    explicit?: boolean;
+    block?: boolean;
+    pubDate?: string;
+    season?: number;
+    episode?: number;
+    episodeType?: EpisodeUpdate.EpisodeType;
+    coverKey?: string;
+    transcripts?: Ichos.EpisodeTranscript[];
+    chaptersUrl?: string;
+    persons?: Ichos.Person[];
+    license?: string;
+    status?: EpisodeUpdate.Status;
+    autoPublish?: boolean;
+    coverOptions?: Ichos.CoverUploadOptions;
+    audioOptions?: Ichos.AudioUploadOptions;
+}
+
+export namespace EpisodeUpdate {
+    export const EpisodeType = {
+        Full: "full",
+        Trailer: "trailer",
+        Bonus: "bonus",
+    } as const;
+    export type EpisodeType = (typeof EpisodeType)[keyof typeof EpisodeType];
+    export const Status = {
+        Draft: "draft",
+        Scheduled: "scheduled",
+        Published: "published",
+        Deleted: "deleted",
+    } as const;
+    export type Status = (typeof Status)[keyof typeof Status];
+}

package/src/api/resources/episodes/client/requests/GenerateEpisodeCoverUploadUrlRequest.ts

@@ -0,0 +1,12 @@
+// This file was auto-generated by Fern from our API Definition.
+
+/**
+ * @example
+ *     {
+ *         episodeId: "episodeId"
+ *     }
+ */
+export interface GenerateEpisodeCoverUploadUrlRequest {
+    /** - The ID of the episode */
+    episodeId: string;
+}

package/src/api/resources/episodes/client/requests/GetEpisodeAudioRequest.ts

@@ -0,0 +1,12 @@
+// This file was auto-generated by Fern from our API Definition.
+
+/**
+ * @example
+ *     {
+ *         episodeId: "episodeId"
+ *     }
+ */
+export interface GetEpisodeAudioRequest {
+    /** - The ID of the episode to retrieve audio for */
+    episodeId: string;
+}

package/src/api/resources/episodes/client/requests/GetEpisodeCoverRequest.ts

@@ -0,0 +1,12 @@
+// This file was auto-generated by Fern from our API Definition.
+
+/**
+ * @example
+ *     {
+ *         episodeId: "episodeId"
+ *     }
+ */
+export interface GetEpisodeCoverRequest {
+    /** - The ID of the episode */
+    episodeId: string;
+}

package/src/api/resources/episodes/client/requests/GetEpisodeListenersReportRequest.ts

@@ -0,0 +1,12 @@
+// This file was auto-generated by Fern from our API Definition.
+
+/**
+ * @example
+ *     {
+ *         episodeId: "episodeId"
+ *     }
+ */
+export interface GetEpisodeListenersReportRequest {
+    /** - The ID of the episode */
+    episodeId: string;
+}

package/src/api/resources/episodes/client/requests/GetEpisodeRequest.ts

@@ -0,0 +1,12 @@
+// This file was auto-generated by Fern from our API Definition.
+
+/**
+ * @example
+ *     {
+ *         episodeId: "episodeId"
+ *     }
+ */
+export interface GetEpisodeRequest {
+    /** - The ID of the episode to retrieve */
+    episodeId: string;
+}

package/src/api/resources/episodes/client/requests/LinkEpisodeAudioRequest.ts

@@ -0,0 +1,15 @@
+// This file was auto-generated by Fern from our API Definition.
+
+/**
+ * @example
+ *     {
+ *         episodeId: "episodeId",
+ *         audioId: "audioId"
+ *     }
+ */
+export interface LinkEpisodeAudioRequest {
+    /** - The ID of the episode */
+    episodeId: string;
+    /** - The ID of the audio file to link */
+    audioId: string;
+}

package/src/api/resources/episodes/client/requests/ListPodcastEpisodesRequest.ts

@@ -0,0 +1,12 @@
+// This file was auto-generated by Fern from our API Definition.
+
+/**
+ * @example
+ *     {
+ *         podcast: "podcast"
+ *     }
+ */
+export interface ListPodcastEpisodesRequest {
+    /** - The ID of the podcast to retrieve episodes for */
+    podcast: string;
+}

package/src/api/resources/episodes/client/requests/PublishEpisodeRequest.ts

@@ -0,0 +1,12 @@
+// This file was auto-generated by Fern from our API Definition.
+
+/**
+ * @example
+ *     {
+ *         episodeId: "episodeId"
+ *     }
+ */
+export interface PublishEpisodeRequest {
+    /** - The ID of the episode to publish */
+    episodeId: string;
+}

package/src/api/resources/episodes/client/requests/PullEpisodeCoverFromUrlRequest.ts

@@ -0,0 +1,14 @@
+// This file was auto-generated by Fern from our API Definition.
+
+/**
+ * @example
+ *     {
+ *         episodeId: "episodeId",
+ *         url: "url"
+ *     }
+ */
+export interface PullEpisodeCoverFromUrlRequest {
+    /** - The ID of the episode */
+    episodeId: string;
+    url: string;
+}

package/src/api/resources/episodes/client/requests/index.ts

@@ -0,0 +1,12 @@
+export type { DeleteEpisodeRequest } from "./DeleteEpisodeRequest.js";
+export type { EpisodeCreate } from "./EpisodeCreate.js";
+export type { EpisodeUpdate } from "./EpisodeUpdate.js";
+export type { GenerateEpisodeCoverUploadUrlRequest } from "./GenerateEpisodeCoverUploadUrlRequest.js";
+export type { GetEpisodeAudioRequest } from "./GetEpisodeAudioRequest.js";
+export type { GetEpisodeCoverRequest } from "./GetEpisodeCoverRequest.js";
+export type { GetEpisodeListenersReportRequest } from "./GetEpisodeListenersReportRequest.js";
+export type { GetEpisodeRequest } from "./GetEpisodeRequest.js";
+export type { LinkEpisodeAudioRequest } from "./LinkEpisodeAudioRequest.js";
+export type { ListPodcastEpisodesRequest } from "./ListPodcastEpisodesRequest.js";
+export type { PublishEpisodeRequest } from "./PublishEpisodeRequest.js";
+export type { PullEpisodeCoverFromUrlRequest } from "./PullEpisodeCoverFromUrlRequest.js";

package/src/api/resources/episodes/index.ts

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

package/src/api/resources/index.ts

@@ -0,0 +1,17 @@
+export * from "./ads/client/requests/index.js";
+export * as ads from "./ads/index.js";
+export * from "./analytics/client/requests/index.js";
+export * as analytics from "./analytics/index.js";
+export * from "./audio/client/requests/index.js";
+export * as audio from "./audio/index.js";
+export * from "./episodes/client/requests/index.js";
+export * as episodes from "./episodes/index.js";
+export * as organizations from "./organizations/index.js";
+export * from "./podcasts/client/requests/index.js";
+export * as podcasts from "./podcasts/index.js";
+export * from "./segments/client/requests/index.js";
+export * as segments from "./segments/index.js";
+export * from "./users/client/requests/index.js";
+export * as users from "./users/index.js";
+export * from "./webhooks/client/requests/index.js";
+export * as webhooks from "./webhooks/index.js";

package/src/api/resources/organizations/client/Client.ts

@@ -0,0 +1,192 @@
+// This file was auto-generated by Fern from our API Definition.
+
+import type { BaseClientOptions, BaseRequestOptions } from "../../../../BaseClient.js";
+import { type NormalizedClientOptionsWithAuth, normalizeClientOptionsWithAuth } from "../../../../BaseClient.js";
+import { mergeHeaders, mergeOnlyDefinedHeaders } from "../../../../core/headers.js";
+import * as core from "../../../../core/index.js";
+import * as environments from "../../../../environments.js";
+import { handleNonStatusCodeError } from "../../../../errors/handleNonStatusCodeError.js";
+import * as errors from "../../../../errors/index.js";
+import * as Ichos from "../../../index.js";
+
+export declare namespace OrganizationsClient {
+    export type Options = BaseClientOptions;
+
+    export interface RequestOptions extends BaseRequestOptions {}
+}
+
+export class OrganizationsClient {
+    protected readonly _options: NormalizedClientOptionsWithAuth<OrganizationsClient.Options>;
+
+    constructor(options: OrganizationsClient.Options) {
+        this._options = normalizeClientOptionsWithAuth(options);
+    }
+
+    /**
+     * Retrieve the currently authenticated organization.
+     *
+     * @param {OrganizationsClient.RequestOptions} requestOptions - Request-specific configuration.
+     *
+     * @throws {@link Ichos.UnauthorizedError}
+     * @throws {@link Ichos.ForbiddenError}
+     * @throws {@link Ichos.InternalServerError}
+     *
+     * @example
+     *     await client.organizations.getAuthenticatedOrganization()
+     */
+    public getAuthenticatedOrganization(
+        requestOptions?: OrganizationsClient.RequestOptions,
+    ): core.HttpResponsePromise<Ichos.AuthenticatedOrganizationResponse> {
+        return core.HttpResponsePromise.fromPromise(this.__getAuthenticatedOrganization(requestOptions));
+    }
+
+    private async __getAuthenticatedOrganization(
+        requestOptions?: OrganizationsClient.RequestOptions,
+    ): Promise<core.WithRawResponse<Ichos.AuthenticatedOrganizationResponse>> {
+        const _authRequest: core.AuthRequest = await this._options.authProvider.getAuthRequest();
+        const _headers: core.Fetcher.Args["headers"] = mergeHeaders(
+            _authRequest.headers,
+            this._options?.headers,
+            mergeOnlyDefinedHeaders({ "x-virtual-user": requestOptions?.virtualUser ?? this._options?.virtualUser }),
+            requestOptions?.headers,
+        );
+        const _response = await core.fetcher({
+            url: core.url.join(
+                (await core.Supplier.get(this._options.baseUrl)) ??
+                    (await core.Supplier.get(this._options.environment)) ??
+                    environments.IchosEnvironment.Default,
+                "v1/organizations/me",
+            ),
+            method: "GET",
+            headers: _headers,
+            queryParameters: requestOptions?.queryParams,
+            timeoutMs: (requestOptions?.timeoutInSeconds ?? this._options?.timeoutInSeconds ?? 60) * 1000,
+            maxRetries: requestOptions?.maxRetries ?? this._options?.maxRetries,
+            abortSignal: requestOptions?.abortSignal,
+            fetchFn: this._options?.fetch,
+            logging: this._options.logging,
+        });
+        if (_response.ok) {
+            return {
+                data: _response.body as Ichos.AuthenticatedOrganizationResponse,
+                rawResponse: _response.rawResponse,
+            };
+        }
+
+        if (_response.error.reason === "status-code") {
+            switch (_response.error.statusCode) {
+                case 401:
+                    throw new Ichos.UnauthorizedError(
+                        _response.error.body as Ichos.UnauthorizedErrorResponse,
+                        _response.rawResponse,
+                    );
+                case 403:
+                    throw new Ichos.ForbiddenError(
+                        _response.error.body as Ichos.UnauthenticatedErrorResponse,
+                        _response.rawResponse,
+                    );
+                case 500:
+                    throw new Ichos.InternalServerError(
+                        _response.error.body as Ichos.InternalServerErrorResponse,
+                        _response.rawResponse,
+                    );
+                default:
+                    throw new errors.IchosError({
+                        statusCode: _response.error.statusCode,
+                        body: _response.error.body,
+                        rawResponse: _response.rawResponse,
+                    });
+            }
+        }
+
+        return handleNonStatusCodeError(_response.error, _response.rawResponse, "GET", "/v1/organizations/me");
+    }
+
+    /**
+     * Retrieve listener analytics for the authenticated organization.
+     *
+     * @param {OrganizationsClient.RequestOptions} requestOptions - Request-specific configuration.
+     *
+     * @throws {@link Ichos.UnauthorizedError}
+     * @throws {@link Ichos.ForbiddenError}
+     * @throws {@link Ichos.NotFoundError}
+     * @throws {@link Ichos.InternalServerError}
+     *
+     * @example
+     *     await client.organizations.getOrganizationListenersReport()
+     */
+    public getOrganizationListenersReport(
+        requestOptions?: OrganizationsClient.RequestOptions,
+    ): core.HttpResponsePromise<Ichos.ListenersReportResponse> {
+        return core.HttpResponsePromise.fromPromise(this.__getOrganizationListenersReport(requestOptions));
+    }
+
+    private async __getOrganizationListenersReport(
+        requestOptions?: OrganizationsClient.RequestOptions,
+    ): Promise<core.WithRawResponse<Ichos.ListenersReportResponse>> {
+        const _authRequest: core.AuthRequest = await this._options.authProvider.getAuthRequest();
+        const _headers: core.Fetcher.Args["headers"] = mergeHeaders(
+            _authRequest.headers,
+            this._options?.headers,
+            mergeOnlyDefinedHeaders({ "x-virtual-user": requestOptions?.virtualUser ?? this._options?.virtualUser }),
+            requestOptions?.headers,
+        );
+        const _response = await core.fetcher({
+            url: core.url.join(
+                (await core.Supplier.get(this._options.baseUrl)) ??
+                    (await core.Supplier.get(this._options.environment)) ??
+                    environments.IchosEnvironment.Default,
+                "v1/organizations/analytics/listens",
+            ),
+            method: "GET",
+            headers: _headers,
+            queryParameters: requestOptions?.queryParams,
+            timeoutMs: (requestOptions?.timeoutInSeconds ?? this._options?.timeoutInSeconds ?? 60) * 1000,
+            maxRetries: requestOptions?.maxRetries ?? this._options?.maxRetries,
+            abortSignal: requestOptions?.abortSignal,
+            fetchFn: this._options?.fetch,
+            logging: this._options.logging,
+        });
+        if (_response.ok) {
+            return { data: _response.body as Ichos.ListenersReportResponse, rawResponse: _response.rawResponse };
+        }
+
+        if (_response.error.reason === "status-code") {
+            switch (_response.error.statusCode) {
+                case 401:
+                    throw new Ichos.UnauthorizedError(
+                        _response.error.body as Ichos.UnauthorizedErrorResponse,
+                        _response.rawResponse,
+                    );
+                case 403:
+                    throw new Ichos.ForbiddenError(
+                        _response.error.body as Ichos.UnauthenticatedErrorResponse,
+                        _response.rawResponse,
+                    );
+                case 404:
+                    throw new Ichos.NotFoundError(
+                        _response.error.body as Ichos.NotFoundErrorResponse,
+                        _response.rawResponse,
+                    );
+                case 500:
+                    throw new Ichos.InternalServerError(
+                        _response.error.body as Ichos.InternalServerErrorResponse,
+                        _response.rawResponse,
+                    );
+                default:
+                    throw new errors.IchosError({
+                        statusCode: _response.error.statusCode,
+                        body: _response.error.body,
+                        rawResponse: _response.rawResponse,
+                    });
+            }
+        }
+
+        return handleNonStatusCodeError(
+            _response.error,
+            _response.rawResponse,
+            "GET",
+            "/v1/organizations/analytics/listens",
+        );
+    }
+}

package/src/api/resources/organizations/client/index.ts

@@ -0,0 +1 @@
+export {};

package/src/api/resources/organizations/index.ts

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