@ichos/sdk 1.0.1

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

@@ -0,0 +1,234 @@
+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 EpisodesClient {
+    type Options = BaseClientOptions;
+    interface RequestOptions extends BaseRequestOptions {
+    }
+}
+export declare class EpisodesClient {
+    protected readonly _options: NormalizedClientOptionsWithAuth<EpisodesClient.Options>;
+    constructor(options: EpisodesClient.Options);
+    /**
+     * Retrieve all episodes for a specific podcast.
+     *
+     * @param {Ichos.ListPodcastEpisodesRequest} request
+     * @param {EpisodesClient.RequestOptions} requestOptions - Request-specific configuration.
+     *
+     * @throws {@link Ichos.UnauthorizedError}
+     * @throws {@link Ichos.ForbiddenError}
+     * @throws {@link Ichos.NotFoundError}
+     * @throws {@link Ichos.InternalServerError}
+     *
+     * @example
+     *     await client.episodes.listPodcastEpisodes({
+     *         podcast: "podcast"
+     *     })
+     */
+    listPodcastEpisodes(request: Ichos.ListPodcastEpisodesRequest, requestOptions?: EpisodesClient.RequestOptions): core.HttpResponsePromise<Ichos.EpisodesResponse>;
+    private __listPodcastEpisodes;
+    /**
+     * Create a new episode.
+     *
+     * @param {Ichos.EpisodeCreate} request
+     * @param {EpisodesClient.RequestOptions} requestOptions - Request-specific configuration.
+     *
+     * @throws {@link Ichos.UnauthorizedError}
+     * @throws {@link Ichos.ForbiddenError}
+     * @throws {@link Ichos.NotFoundError}
+     * @throws {@link Ichos.InternalServerError}
+     *
+     * @example
+     *     await client.episodes.createEpisode({
+     *         podcastId: "podcastId",
+     *         title: "title"
+     *     })
+     */
+    createEpisode(request: Ichos.EpisodeCreate, requestOptions?: EpisodesClient.RequestOptions): core.HttpResponsePromise<Ichos.EpisodeCreateResponse>;
+    private __createEpisode;
+    /**
+     * Retrieve a single episode by ID.
+     *
+     * @param {Ichos.GetEpisodeRequest} request
+     * @param {EpisodesClient.RequestOptions} requestOptions - Request-specific configuration.
+     *
+     * @throws {@link Ichos.UnauthorizedError}
+     * @throws {@link Ichos.ForbiddenError}
+     * @throws {@link Ichos.NotFoundError}
+     * @throws {@link Ichos.InternalServerError}
+     *
+     * @example
+     *     await client.episodes.getEpisode({
+     *         episodeId: "episodeId"
+     *     })
+     */
+    getEpisode(request: Ichos.GetEpisodeRequest, requestOptions?: EpisodesClient.RequestOptions): core.HttpResponsePromise<Ichos.EpisodeResponse>;
+    private __getEpisode;
+    /**
+     * Delete an episode.
+     * Optionally delete the associated audio file.
+     *
+     * @param {Ichos.DeleteEpisodeRequest} request
+     * @param {EpisodesClient.RequestOptions} requestOptions - Request-specific configuration.
+     *
+     * @throws {@link Ichos.UnauthorizedError}
+     * @throws {@link Ichos.ForbiddenError}
+     * @throws {@link Ichos.NotFoundError}
+     * @throws {@link Ichos.InternalServerError}
+     *
+     * @example
+     *     await client.episodes.deleteEpisode({
+     *         episodeId: "episodeId"
+     *     })
+     */
+    deleteEpisode(request: Ichos.DeleteEpisodeRequest, requestOptions?: EpisodesClient.RequestOptions): core.HttpResponsePromise<Ichos.NullResponse>;
+    private __deleteEpisode;
+    /**
+     * Update an existing episode.
+     *
+     * @param {Ichos.EpisodeUpdate} request
+     * @param {EpisodesClient.RequestOptions} requestOptions - Request-specific configuration.
+     *
+     * @throws {@link Ichos.UnauthorizedError}
+     * @throws {@link Ichos.ForbiddenError}
+     * @throws {@link Ichos.NotFoundError}
+     * @throws {@link Ichos.InternalServerError}
+     *
+     * @example
+     *     await client.episodes.updateEpisode({
+     *         episodeId: "episodeId"
+     *     })
+     */
+    updateEpisode(request: Ichos.EpisodeUpdate, requestOptions?: EpisodesClient.RequestOptions): core.HttpResponsePromise<Ichos.EpisodeResponse>;
+    private __updateEpisode;
+    /**
+     * Generate a signed URL for uploading an episode cover image.
+     *
+     * @param {Ichos.GenerateEpisodeCoverUploadUrlRequest} request
+     * @param {EpisodesClient.RequestOptions} requestOptions - Request-specific configuration.
+     *
+     * @throws {@link Ichos.UnauthorizedError}
+     * @throws {@link Ichos.ForbiddenError}
+     * @throws {@link Ichos.NotFoundError}
+     * @throws {@link Ichos.InternalServerError}
+     *
+     * @example
+     *     await client.episodes.generateEpisodeCoverUploadUrl({
+     *         episodeId: "episodeId"
+     *     })
+     */
+    generateEpisodeCoverUploadUrl(request: Ichos.GenerateEpisodeCoverUploadUrlRequest, requestOptions?: EpisodesClient.RequestOptions): core.HttpResponsePromise<Ichos.UserUploadCoverResponse>;
+    private __generateEpisodeCoverUploadUrl;
+    /**
+     * Trigger the system to pull an episode cover image from a URL.
+     *
+     * @param {Ichos.PullEpisodeCoverFromUrlRequest} request
+     * @param {EpisodesClient.RequestOptions} requestOptions - Request-specific configuration.
+     *
+     * @throws {@link Ichos.UnauthorizedError}
+     * @throws {@link Ichos.ForbiddenError}
+     * @throws {@link Ichos.NotFoundError}
+     * @throws {@link Ichos.InternalServerError}
+     *
+     * @example
+     *     await client.episodes.pullEpisodeCoverFromUrl({
+     *         episodeId: "episodeId",
+     *         url: "url"
+     *     })
+     */
+    pullEpisodeCoverFromUrl(request: Ichos.PullEpisodeCoverFromUrlRequest, requestOptions?: EpisodesClient.RequestOptions): core.HttpResponsePromise<Ichos.NullResponse>;
+    private __pullEpisodeCoverFromUrl;
+    /**
+     * Retrieve the current cover image for an episode.
+     *
+     * @param {Ichos.GetEpisodeCoverRequest} request
+     * @param {EpisodesClient.RequestOptions} requestOptions - Request-specific configuration.
+     *
+     * @throws {@link Ichos.UnauthorizedError}
+     * @throws {@link Ichos.ForbiddenError}
+     * @throws {@link Ichos.NotFoundError}
+     * @throws {@link Ichos.InternalServerError}
+     *
+     * @example
+     *     await client.episodes.getEpisodeCover({
+     *         episodeId: "episodeId"
+     *     })
+     */
+    getEpisodeCover(request: Ichos.GetEpisodeCoverRequest, requestOptions?: EpisodesClient.RequestOptions): core.HttpResponsePromise<Ichos.RetrieveCoverResponse>;
+    private __getEpisodeCover;
+    /**
+     * Publish an episode to make it available in the RSS feed.
+     *
+     * @param {Ichos.PublishEpisodeRequest} request
+     * @param {EpisodesClient.RequestOptions} requestOptions - Request-specific configuration.
+     *
+     * @throws {@link Ichos.UnauthorizedError}
+     * @throws {@link Ichos.ForbiddenError}
+     * @throws {@link Ichos.NotFoundError}
+     * @throws {@link Ichos.UnprocessableEntityError}
+     * @throws {@link Ichos.InternalServerError}
+     *
+     * @example
+     *     await client.episodes.publishEpisode({
+     *         episodeId: "episodeId"
+     *     })
+     */
+    publishEpisode(request: Ichos.PublishEpisodeRequest, requestOptions?: EpisodesClient.RequestOptions): core.HttpResponsePromise<Ichos.NullResponse>;
+    private __publishEpisode;
+    /**
+     * Retrieve listener analytics for an episode.
+     *
+     * @param {Ichos.GetEpisodeListenersReportRequest} request
+     * @param {EpisodesClient.RequestOptions} requestOptions - Request-specific configuration.
+     *
+     * @throws {@link Ichos.UnauthorizedError}
+     * @throws {@link Ichos.ForbiddenError}
+     * @throws {@link Ichos.NotFoundError}
+     * @throws {@link Ichos.InternalServerError}
+     *
+     * @example
+     *     await client.episodes.getEpisodeListenersReport({
+     *         episodeId: "episodeId"
+     *     })
+     */
+    getEpisodeListenersReport(request: Ichos.GetEpisodeListenersReportRequest, requestOptions?: EpisodesClient.RequestOptions): core.HttpResponsePromise<Ichos.ListenersReportResponse>;
+    private __getEpisodeListenersReport;
+    /**
+     * List audio records for a specific episode.
+     *
+     * @param {Ichos.GetEpisodeAudioRequest} request
+     * @param {EpisodesClient.RequestOptions} requestOptions - Request-specific configuration.
+     *
+     * @throws {@link Ichos.UnauthorizedError}
+     * @throws {@link Ichos.ForbiddenError}
+     * @throws {@link Ichos.NotFoundError}
+     * @throws {@link Ichos.InternalServerError}
+     *
+     * @example
+     *     await client.episodes.getEpisodeAudio({
+     *         episodeId: "episodeId"
+     *     })
+     */
+    getEpisodeAudio(request: Ichos.GetEpisodeAudioRequest, requestOptions?: EpisodesClient.RequestOptions): core.HttpResponsePromise<Ichos.AudioResponse>;
+    private __getEpisodeAudio;
+    /**
+     * Link an audio file to an episode.
+     *
+     * @param {Ichos.LinkEpisodeAudioRequest} request
+     * @param {EpisodesClient.RequestOptions} requestOptions - Request-specific configuration.
+     *
+     * @throws {@link Ichos.UnauthorizedError}
+     * @throws {@link Ichos.ForbiddenError}
+     * @throws {@link Ichos.NotFoundError}
+     * @throws {@link Ichos.InternalServerError}
+     *
+     * @example
+     *     await client.episodes.linkEpisodeAudio({
+     *         episodeId: "episodeId",
+     *         audioId: "audioId"
+     *     })
+     */
+    linkEpisodeAudio(request: Ichos.LinkEpisodeAudioRequest, requestOptions?: EpisodesClient.RequestOptions): core.HttpResponsePromise<Ichos.NullResponse>;
+    private __linkEpisodeAudio;
+}