@ichos/sdk 1.0.1

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

@@ -0,0 +1,246 @@
+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 PodcastsClient {
+    type Options = BaseClientOptions;
+    interface RequestOptions extends BaseRequestOptions {
+    }
+}
+export declare class PodcastsClient {
+    protected readonly _options: NormalizedClientOptionsWithAuth<PodcastsClient.Options>;
+    constructor(options: PodcastsClient.Options);
+    /**
+     * Retrieve all podcasts associated with a virtual user.
+     *
+     * @param {PodcastsClient.RequestOptions} requestOptions - Request-specific configuration.
+     *
+     * @throws {@link Ichos.UnauthorizedError}
+     * @throws {@link Ichos.ForbiddenError}
+     * @throws {@link Ichos.InternalServerError}
+     *
+     * @example
+     *     await client.podcasts.listUserPodcasts()
+     */
+    listUserPodcasts(requestOptions?: PodcastsClient.RequestOptions): core.HttpResponsePromise<Ichos.PodcastsResponse>;
+    private __listUserPodcasts;
+    /**
+     * Create a new podcast.
+     *
+     * @param {Ichos.PodcastCreate} request
+     * @param {PodcastsClient.RequestOptions} requestOptions - Request-specific configuration.
+     *
+     * @throws {@link Ichos.UnauthorizedError}
+     * @throws {@link Ichos.ForbiddenError}
+     * @throws {@link Ichos.NotFoundError}
+     * @throws {@link Ichos.InternalServerError}
+     *
+     * @example
+     *     await client.podcasts.createPodcast({
+     *         title: "The Tech Wave",
+     *         explicit: false
+     *     })
+     */
+    createPodcast(request: Ichos.PodcastCreate, requestOptions?: PodcastsClient.RequestOptions): core.HttpResponsePromise<Ichos.PodcastResponse>;
+    private __createPodcast;
+    /**
+     * Import a podcast from an RSS feed URL.
+     *
+     * @param {Ichos.ImportPodcastFromRssRequest} request
+     * @param {PodcastsClient.RequestOptions} requestOptions - Request-specific configuration.
+     *
+     * @throws {@link Ichos.UnauthorizedError}
+     * @throws {@link Ichos.ForbiddenError}
+     * @throws {@link Ichos.NotFoundError}
+     * @throws {@link Ichos.InternalServerError}
+     *
+     * @example
+     *     await client.podcasts.importPodcastFromRss({
+     *         url: "url"
+     *     })
+     */
+    importPodcastFromRss(request: Ichos.ImportPodcastFromRssRequest, requestOptions?: PodcastsClient.RequestOptions): core.HttpResponsePromise<Ichos.NullResponse>;
+    private __importPodcastFromRss;
+    /**
+     * Generate a signed URL for uploading a podcast cover image.
+     *
+     * @param {Ichos.GeneratePodcastCoverUploadUrlRequest} request
+     * @param {PodcastsClient.RequestOptions} requestOptions - Request-specific configuration.
+     *
+     * @throws {@link Ichos.UnauthorizedError}
+     * @throws {@link Ichos.ForbiddenError}
+     * @throws {@link Ichos.NotFoundError}
+     * @throws {@link Ichos.InternalServerError}
+     *
+     * @example
+     *     await client.podcasts.generatePodcastCoverUploadUrl({
+     *         podcastId: "podcastId"
+     *     })
+     */
+    generatePodcastCoverUploadUrl(request: Ichos.GeneratePodcastCoverUploadUrlRequest, requestOptions?: PodcastsClient.RequestOptions): core.HttpResponsePromise<Ichos.UserUploadCoverResultResponse>;
+    private __generatePodcastCoverUploadUrl;
+    /**
+     * Trigger the system to pull a podcast cover image from a URL.
+     *
+     * @param {Ichos.PullPodcastCoverFromUrlRequest} request
+     * @param {PodcastsClient.RequestOptions} requestOptions - Request-specific configuration.
+     *
+     * @throws {@link Ichos.UnauthorizedError}
+     * @throws {@link Ichos.ForbiddenError}
+     * @throws {@link Ichos.NotFoundError}
+     * @throws {@link Ichos.InternalServerError}
+     *
+     * @example
+     *     await client.podcasts.pullPodcastCoverFromUrl({
+     *         podcastId: "podcastId",
+     *         url: "url"
+     *     })
+     */
+    pullPodcastCoverFromUrl(request: Ichos.PullPodcastCoverFromUrlRequest, requestOptions?: PodcastsClient.RequestOptions): core.HttpResponsePromise<Ichos.NullResponse>;
+    private __pullPodcastCoverFromUrl;
+    /**
+     * Retrieve the current cover image URL for a podcast.
+     *
+     * @param {Ichos.GetPodcastCoverRequest} request
+     * @param {PodcastsClient.RequestOptions} requestOptions - Request-specific configuration.
+     *
+     * @throws {@link Ichos.UnauthorizedError}
+     * @throws {@link Ichos.ForbiddenError}
+     * @throws {@link Ichos.NotFoundError}
+     * @throws {@link Ichos.InternalServerError}
+     *
+     * @example
+     *     await client.podcasts.getPodcastCover({
+     *         podcastId: "podcastId"
+     *     })
+     */
+    getPodcastCover(request: Ichos.GetPodcastCoverRequest, requestOptions?: PodcastsClient.RequestOptions): core.HttpResponsePromise<Ichos.StringOrNullResponse>;
+    private __getPodcastCover;
+    /**
+     * Retrieve a single podcast by ID.
+     *
+     * @param {Ichos.GetPodcastRequest} request
+     * @param {PodcastsClient.RequestOptions} requestOptions - Request-specific configuration.
+     *
+     * @throws {@link Ichos.UnauthorizedError}
+     * @throws {@link Ichos.ForbiddenError}
+     * @throws {@link Ichos.NotFoundError}
+     * @throws {@link Ichos.InternalServerError}
+     *
+     * @example
+     *     await client.podcasts.getPodcast({
+     *         podcastId: "podcastId"
+     *     })
+     */
+    getPodcast(request: Ichos.GetPodcastRequest, requestOptions?: PodcastsClient.RequestOptions): core.HttpResponsePromise<Ichos.PodcastResponse>;
+    private __getPodcast;
+    /**
+     * Delete a podcast.
+     *
+     * @param {Ichos.DeletePodcastRequest} request
+     * @param {PodcastsClient.RequestOptions} requestOptions - Request-specific configuration.
+     *
+     * @throws {@link Ichos.UnauthorizedError}
+     * @throws {@link Ichos.ForbiddenError}
+     * @throws {@link Ichos.NotFoundError}
+     * @throws {@link Ichos.InternalServerError}
+     *
+     * @example
+     *     await client.podcasts.deletePodcast({
+     *         podcastId: "podcastId"
+     *     })
+     */
+    deletePodcast(request: Ichos.DeletePodcastRequest, requestOptions?: PodcastsClient.RequestOptions): core.HttpResponsePromise<Ichos.NullResponse>;
+    private __deletePodcast;
+    /**
+     * Update podcast details.
+     *
+     * @param {Ichos.PodcastUpdate} request
+     * @param {PodcastsClient.RequestOptions} requestOptions - Request-specific configuration.
+     *
+     * @throws {@link Ichos.UnauthorizedError}
+     * @throws {@link Ichos.ForbiddenError}
+     * @throws {@link Ichos.NotFoundError}
+     * @throws {@link Ichos.InternalServerError}
+     *
+     * @example
+     *     await client.podcasts.updatePodcast({
+     *         podcastId: "podcastId"
+     *     })
+     */
+    updatePodcast(request: Ichos.PodcastUpdate, requestOptions?: PodcastsClient.RequestOptions): core.HttpResponsePromise<Ichos.PodcastResponse>;
+    private __updatePodcast;
+    /**
+     * Get the RSS feed URL for a podcast.
+     * Also triggers an RSS refresh.
+     *
+     * @param {Ichos.GetPodcastRssRequest} request
+     * @param {PodcastsClient.RequestOptions} requestOptions - Request-specific configuration.
+     *
+     * @throws {@link Ichos.UnauthorizedError}
+     * @throws {@link Ichos.ForbiddenError}
+     * @throws {@link Ichos.NotFoundError}
+     * @throws {@link Ichos.InternalServerError}
+     *
+     * @example
+     *     await client.podcasts.getPodcastRss({
+     *         podcastId: "podcastId"
+     *     })
+     */
+    getPodcastRss(request: Ichos.GetPodcastRssRequest, requestOptions?: PodcastsClient.RequestOptions): core.HttpResponsePromise<string>;
+    private __getPodcastRss;
+    /**
+     * Validate a podcast and generate a report.
+     *
+     * @param {Ichos.ValidatePodcastRequest} request
+     * @param {PodcastsClient.RequestOptions} requestOptions - Request-specific configuration.
+     *
+     * @throws {@link Ichos.UnauthorizedError}
+     * @throws {@link Ichos.ForbiddenError}
+     * @throws {@link Ichos.NotFoundError}
+     * @throws {@link Ichos.InternalServerError}
+     *
+     * @example
+     *     await client.podcasts.validatePodcast({
+     *         podcastId: "podcastId"
+     *     })
+     */
+    validatePodcast(request: Ichos.ValidatePodcastRequest, requestOptions?: PodcastsClient.RequestOptions): core.HttpResponsePromise<Ichos.NullResponse>;
+    private __validatePodcast;
+    /**
+     * Publish a podcast to make it available via RSS.
+     *
+     * @param {Ichos.PublishPodcastRequest} request
+     * @param {PodcastsClient.RequestOptions} requestOptions - Request-specific configuration.
+     *
+     * @throws {@link Ichos.UnauthorizedError}
+     * @throws {@link Ichos.ForbiddenError}
+     * @throws {@link Ichos.NotFoundError}
+     * @throws {@link Ichos.InternalServerError}
+     *
+     * @example
+     *     await client.podcasts.publishPodcast({
+     *         podcastId: "podcastId"
+     *     })
+     */
+    publishPodcast(request: Ichos.PublishPodcastRequest, requestOptions?: PodcastsClient.RequestOptions): core.HttpResponsePromise<Ichos.PublishPodcastOutput>;
+    private __publishPodcast;
+    /**
+     * Retrieve listener analytics for a podcast.
+     *
+     * @param {Ichos.GetPodcastListenersReportRequest} request
+     * @param {PodcastsClient.RequestOptions} requestOptions - Request-specific configuration.
+     *
+     * @throws {@link Ichos.UnauthorizedError}
+     * @throws {@link Ichos.ForbiddenError}
+     * @throws {@link Ichos.NotFoundError}
+     * @throws {@link Ichos.InternalServerError}
+     *
+     * @example
+     *     await client.podcasts.getPodcastListenersReport({
+     *         podcastId: "podcastId"
+     *     })
+     */
+    getPodcastListenersReport(request: Ichos.GetPodcastListenersReportRequest, requestOptions?: PodcastsClient.RequestOptions): core.HttpResponsePromise<Ichos.ListenersReport>;
+    private __getPodcastListenersReport;
+}