@ichos/sdk 1.0.10 → 1.0.12

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

@@ -15,6 +15,9 @@ export declare namespace AudioClient {
     export interface RequestOptions extends BaseRequestOptions {}
 }
 
+/**
+ * Endpoints for managing audio.
+ */
 export class AudioClient {
     protected readonly _options: NormalizedClientOptionsWithAuth<AudioClient.Options>;
 
@@ -112,6 +115,7 @@ export class AudioClient {
      * Generate a signed URL for uploading an audio file.
      * Use the returned URL to PUT the audio file content.
      *
+     * @param {Ichos.GenerateAudioUploadUrlRequest} request
      * @param {AudioClient.RequestOptions} requestOptions - Request-specific configuration.
      *
      * @throws {@link Ichos.UnauthorizedError}
@@ -122,14 +126,26 @@ export class AudioClient {
      *     await client.audio.generateAudioUploadUrl()
      */
     public generateAudioUploadUrl(
+        request: Ichos.GenerateAudioUploadUrlRequest = {},
         requestOptions?: AudioClient.RequestOptions,
     ): core.HttpResponsePromise<Ichos.UserUploadAudioResponse> {
-        return core.HttpResponsePromise.fromPromise(this.__generateAudioUploadUrl(requestOptions));
+        return core.HttpResponsePromise.fromPromise(this.__generateAudioUploadUrl(request, requestOptions));
     }
 
     private async __generateAudioUploadUrl(
+        request: Ichos.GenerateAudioUploadUrlRequest = {},
         requestOptions?: AudioClient.RequestOptions,
     ): Promise<core.WithRawResponse<Ichos.UserUploadAudioResponse>> {
+        const { linkTo, linkToId } = request;
+        const _queryParams: Record<string, string | string[] | object | object[] | null> = {};
+        if (linkTo != null) {
+            _queryParams.linkTo = linkTo;
+        }
+
+        if (linkToId != null) {
+            _queryParams.linkToId = linkToId;
+        }
+
         const _authRequest: core.AuthRequest = await this._options.authProvider.getAuthRequest();
         const _headers: core.Fetcher.Args["headers"] = mergeHeaders(
             _authRequest.headers,
@@ -146,7 +162,7 @@ export class AudioClient {
             ),
             method: "GET",
             headers: _headers,
-            queryParameters: requestOptions?.queryParams,
+            queryParameters: { ..._queryParams, ...requestOptions?.queryParams },
             timeoutMs: (requestOptions?.timeoutInSeconds ?? this._options?.timeoutInSeconds ?? 60) * 1000,
             maxRetries: requestOptions?.maxRetries ?? this._options?.maxRetries,
             abortSignal: requestOptions?.abortSignal,
@@ -275,97 +291,6 @@ export class AudioClient {
         return handleNonStatusCodeError(_response.error, _response.rawResponse, "GET", "/v1/audio/{audioId}");
     }
 
-    /**
-     * Finalize the creation of an audio resource after the file has been uploaded.
-     * Upload completion is detected via storage events.
-     *
-     * @param {Ichos.FinalizeAudioUploadRequest} request
-     * @param {AudioClient.RequestOptions} requestOptions - Request-specific configuration.
-     *
-     * @throws {@link Ichos.UnauthorizedError}
-     * @throws {@link Ichos.TooManyRequestsError}
-     * @throws {@link Ichos.InternalServerError}
-     *
-     * @example
-     *     await client.audio.finalizeAudioUpload({
-     *         audioId: "audioId",
-     *         body: {
-     *             type: "episode",
-     *             id: "id"
-     *         }
-     *     })
-     */
-    public finalizeAudioUpload(
-        request: Ichos.FinalizeAudioUploadRequest,
-        requestOptions?: AudioClient.RequestOptions,
-    ): core.HttpResponsePromise<Ichos.AudioResponse> {
-        return core.HttpResponsePromise.fromPromise(this.__finalizeAudioUpload(request, requestOptions));
-    }
-
-    private async __finalizeAudioUpload(
-        request: Ichos.FinalizeAudioUploadRequest,
-        requestOptions?: AudioClient.RequestOptions,
-    ): Promise<core.WithRawResponse<Ichos.AudioResponse>> {
-        const { audioId, body: _body } = request;
-        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/audio/${core.url.encodePathParam(audioId)}`,
-            ),
-            method: "POST",
-            headers: _headers,
-            contentType: "application/json",
-            queryParameters: requestOptions?.queryParams,
-            requestType: "json",
-            body: _body != null ? _body : undefined,
-            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.AudioResponse, 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 429:
-                    throw new Ichos.TooManyRequestsError(
-                        _response.error.body as Ichos.TooManyRequestsErrorResponse,
-                        _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, "POST", "/v1/audio/{audioId}");
-    }
-
     /**
      * Delete an audio resource.
      *
@@ -455,95 +380,6 @@ export class AudioClient {
         return handleNonStatusCodeError(_response.error, _response.rawResponse, "DELETE", "/v1/audio/{audioId}");
     }
 
-    /**
-     * Get the status of an ongoing audio pull operation.
-     *
-     * @param {Ichos.GetAudioPullStatusRequest} request
-     * @param {AudioClient.RequestOptions} requestOptions - Request-specific configuration.
-     *
-     * @throws {@link Ichos.UnauthorizedError}
-     * @throws {@link Ichos.NotFoundError}
-     * @throws {@link Ichos.TooManyRequestsError}
-     * @throws {@link Ichos.InternalServerError}
-     *
-     * @example
-     *     await client.audio.getAudioPullStatus({
-     *         audioId: "audioId"
-     *     })
-     */
-    public getAudioPullStatus(
-        request: Ichos.GetAudioPullStatusRequest,
-        requestOptions?: AudioClient.RequestOptions,
-    ): core.HttpResponsePromise<Ichos.AudioPullStatusResponse> {
-        return core.HttpResponsePromise.fromPromise(this.__getAudioPullStatus(request, requestOptions));
-    }
-
-    private async __getAudioPullStatus(
-        request: Ichos.GetAudioPullStatusRequest,
-        requestOptions?: AudioClient.RequestOptions,
-    ): Promise<core.WithRawResponse<Ichos.AudioPullStatusResponse>> {
-        const { audioId } = request;
-        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/audio/${core.url.encodePathParam(audioId)}/pull`,
-            ),
-            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.AudioPullStatusResponse, 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 404:
-                    throw new Ichos.NotFoundError(
-                        _response.error.body as Ichos.NotFoundErrorResponse,
-                        _response.rawResponse,
-                    );
-                case 429:
-                    throw new Ichos.TooManyRequestsError(
-                        _response.error.body as Ichos.TooManyRequestsErrorResponse,
-                        _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/audio/{audioId}/pull");
-    }
-
     /**
      * @param {Ichos.TextToSpeechRequest} request
      * @param {AudioClient.RequestOptions} requestOptions - Request-specific configuration.

package/src/api/resources/audio/client/requests/GenerateAudioUploadUrlRequest.ts

@@ -0,0 +1,12 @@
+// This file was auto-generated by Fern from our API Definition.
+
+import type * as Ichos from "../../../../index.js";
+
+/**
+ * @example
+ *     {}
+ */
+export interface GenerateAudioUploadUrlRequest {
+    linkTo?: Ichos.GenerateAudioUploadUrlRequestLinkTo;
+    linkToId?: string;
+}

package/src/api/resources/audio/client/requests/PullAudioDto.ts

@@ -1,5 +1,7 @@
 // This file was auto-generated by Fern from our API Definition.
 
+import type * as Ichos from "../../../../index.js";
+
 /**
  * @example
  *     {
@@ -8,4 +10,5 @@
  */
 export interface PullAudioDto {
     url: string;
+    linkTo?: Ichos.LinkTo;
 }

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

@@ -1,6 +1,5 @@
 export type { DeleteAudioRequest } from "./DeleteAudioRequest.js";
-export type { FinalizeAudioUploadRequest } from "./FinalizeAudioUploadRequest.js";
-export type { GetAudioPullStatusRequest } from "./GetAudioPullStatusRequest.js";
+export type { GenerateAudioUploadUrlRequest } from "./GenerateAudioUploadUrlRequest.js";
 export type { GetAudioRequest } from "./GetAudioRequest.js";
 export type { PullAudioDto } from "./PullAudioDto.js";
 export type { TextToSpeechRequest } from "./TextToSpeechRequest.js";

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

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

package/src/api/resources/audio/types/GenerateAudioUploadUrlRequestLinkTo.ts

@@ -0,0 +1,9 @@
+// This file was auto-generated by Fern from our API Definition.
+
+export const GenerateAudioUploadUrlRequestLinkTo = {
+    Episode: "episode",
+    Ad: "ad",
+    Segment: "segment",
+} as const;
+export type GenerateAudioUploadUrlRequestLinkTo =
+    (typeof GenerateAudioUploadUrlRequestLinkTo)[keyof typeof GenerateAudioUploadUrlRequestLinkTo];

package/src/api/resources/audio/types/index.ts

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

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

@@ -15,6 +15,9 @@ export declare namespace EpisodesClient {
     export interface RequestOptions extends BaseRequestOptions {}
 }
 
+/**
+ * Endpoints for managing podcast episodes.
+ */
 export class EpisodesClient {
     protected readonly _options: NormalizedClientOptionsWithAuth<EpisodesClient.Options>;
 
@@ -1039,7 +1042,7 @@ export class EpisodesClient {
     }
 
     /**
-     * List audio records for a specific episode.
+     * Get audio record for a specific episode.
      *
      * @param {Ichos.GetEpisodeAudioRequest} request
      * @param {EpisodesClient.RequestOptions} requestOptions - Request-specific configuration.

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

@@ -11,13 +11,13 @@ import type * as Ichos from "../../../../index.js";
 export interface EpisodeUpdate {
     /** - The ID of the episode to update */
     episodeId: string;
+    metadata?: Ichos.Metadata;
     title?: string;
     link?: string;
     description?: string;
     adsEnabled?: boolean;
     explicit?: boolean;
     block?: boolean;
-    metadata?: Ichos.Metadata;
     coverOptions?: Ichos.CoverUploadOptions;
     season?: number;
     episode?: number;

package/src/api/resources/index.ts

@@ -2,6 +2,7 @@ export * from "./ads/client/requests/index.js";
 export * as ads from "./ads/index.js";
 export * from "./audio/client/requests/index.js";
 export * as audio from "./audio/index.js";
+export * from "./audio/types/index.js";
 export * from "./episodes/client/requests/index.js";
 export * as episodes from "./episodes/index.js";
 export * as organizations from "./organizations/index.js";
@@ -9,6 +10,7 @@ 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 "./segments/types/index.js";
 export * from "./users/client/requests/index.js";
 export * as users from "./users/index.js";
 export * from "./webhooks/client/requests/index.js";

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

@@ -201,93 +201,4 @@ export class OrganizationsClient {
             "/v1/organizations/analytics/listens",
         );
     }
-
-    /**
-     * @param {OrganizationsClient.RequestOptions} requestOptions - Request-specific configuration.
-     *
-     * @throws {@link Ichos.UnauthorizedError}
-     * @throws {@link Ichos.ForbiddenError}
-     * @throws {@link Ichos.TooManyRequestsError}
-     * @throws {@link Ichos.InternalServerError}
-     *
-     * @example
-     *     await client.organizations.getOrganizationWhitelabelConfiguration()
-     */
-    public getOrganizationWhitelabelConfiguration(
-        requestOptions?: OrganizationsClient.RequestOptions,
-    ): core.HttpResponsePromise<Ichos.OrganizationWhitelabelConfigurationResponse> {
-        return core.HttpResponsePromise.fromPromise(this.__getOrganizationWhitelabelConfiguration(requestOptions));
-    }
-
-    private async __getOrganizationWhitelabelConfiguration(
-        requestOptions?: OrganizationsClient.RequestOptions,
-    ): Promise<core.WithRawResponse<Ichos.OrganizationWhitelabelConfigurationResponse>> {
-        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/whitelabel-configuration",
-            ),
-            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.OrganizationWhitelabelConfigurationResponse,
-                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.ForbiddenErrorResponse,
-                        _response.rawResponse,
-                    );
-                case 429:
-                    throw new Ichos.TooManyRequestsError(
-                        _response.error.body as Ichos.TooManyRequestsErrorResponse,
-                        _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/whitelabel-configuration",
-        );
-    }
 }

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

@@ -15,6 +15,9 @@ export declare namespace PodcastsClient {
     export interface RequestOptions extends BaseRequestOptions {}
 }
 
+/**
+ * Endpoints related to podcast management.
+ */
 export class PodcastsClient {
     protected readonly _options: NormalizedClientOptionsWithAuth<PodcastsClient.Options>;
 
@@ -119,8 +122,7 @@ export class PodcastsClient {
      *
      * @example
      *     await client.podcasts.createPodcast({
-     *         title: "The Tech Wave",
-     *         explicit: false
+     *         title: "The Tech Wave"
      *     })
      */
     public createPodcast(
@@ -1124,14 +1126,14 @@ export class PodcastsClient {
     public publishPodcast(
         request: Ichos.PublishPodcastRequest,
         requestOptions?: PodcastsClient.RequestOptions,
-    ): core.HttpResponsePromise<Ichos.PublishPodcastOutput> {
+    ): core.HttpResponsePromise<Ichos.PublishPodcastResponse> {
         return core.HttpResponsePromise.fromPromise(this.__publishPodcast(request, requestOptions));
     }
 
     private async __publishPodcast(
         request: Ichos.PublishPodcastRequest,
         requestOptions?: PodcastsClient.RequestOptions,
-    ): Promise<core.WithRawResponse<Ichos.PublishPodcastOutput>> {
+    ): Promise<core.WithRawResponse<Ichos.PublishPodcastResponse>> {
         const { podcastId } = request;
         const _authRequest: core.AuthRequest = await this._options.authProvider.getAuthRequest();
         const _headers: core.Fetcher.Args["headers"] = mergeHeaders(
@@ -1157,7 +1159,7 @@ export class PodcastsClient {
             logging: this._options.logging,
         });
         if (_response.ok) {
-            return { data: _response.body as Ichos.PublishPodcastOutput, rawResponse: _response.rawResponse };
+            return { data: _response.body as Ichos.PublishPodcastResponse, rawResponse: _response.rawResponse };
         }
 
         if (_response.error.reason === "status-code") {

package/src/api/resources/podcasts/client/requests/PodcastCreate.ts

@@ -5,8 +5,7 @@ import type * as Ichos from "../../../../index.js";
 /**
  * @example
  *     {
- *         title: "The Tech Wave",
- *         explicit: false
+ *         title: "The Tech Wave"
  *     }
  */
 export interface PodcastCreate {
@@ -21,14 +20,17 @@ export interface PodcastCreate {
     link?: string | null;
     /** A detailed description of the podcast. */
     description?: string | null;
-    /** The language of the podcast (ISO 639-1 code). */
+    /**
+     * The language of the podcast (ISO 639-1 code). Will default to
+     * the organization's default language if not provided.
+     */
     language?: string | null;
     /** Whether ads are enabled for the podcast. */
     adsEnabled?: boolean;
     /** Categories associated with the podcast. */
     categories?: Ichos.ApplePodcastCategory[] | null;
     /** Whether the podcast contains explicit content. */
-    explicit: boolean;
+    explicit?: boolean;
     /** The author of the podcast. */
     author?: string | null;
     /** The name of the podcast owner. */

package/src/api/resources/podcasts/client/requests/PodcastUpdate.ts

@@ -22,7 +22,10 @@ export interface PodcastUpdate {
     link?: string;
     /** A detailed description of the podcast. */
     description?: string;
-    /** The language of the podcast (ISO 639-1 code). */
+    /**
+     * The language of the podcast (ISO 639-1 code). Will default to
+     * the organization's default language if not provided.
+     */
     language?: string;
     /** Whether ads are enabled for the podcast. */
     adsEnabled?: boolean;