@ichos/sdk 1.0.7 → 1.0.8

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

@@ -205,6 +205,116 @@ export class EpisodesClient {
         return handleNonStatusCodeError(_response.error, _response.rawResponse, "POST", "/v1/episodes");
     }
 
+    /**
+     * Search episodes in the authenticated organization.
+     *
+     * @param {Ichos.SearchEpisodesRequest} request
+     * @param {EpisodesClient.RequestOptions} requestOptions - Request-specific configuration.
+     *
+     * @throws {@link Ichos.UnauthorizedError}
+     * @throws {@link Ichos.ForbiddenError}
+     * @throws {@link Ichos.InternalServerError}
+     *
+     * @example
+     *     await client.episodes.searchEpisodes({
+     *         metadataJson: "{\"externalId\":\"123\",\"source\":\"crm\"}",
+     *         metadataKey: "externalId",
+     *         query: "launch"
+     *     })
+     */
+    public searchEpisodes(
+        request: Ichos.SearchEpisodesRequest = {},
+        requestOptions?: EpisodesClient.RequestOptions,
+    ): core.HttpResponsePromise<Ichos.EpisodesResponse> {
+        return core.HttpResponsePromise.fromPromise(this.__searchEpisodes(request, requestOptions));
+    }
+
+    private async __searchEpisodes(
+        request: Ichos.SearchEpisodesRequest = {},
+        requestOptions?: EpisodesClient.RequestOptions,
+    ): Promise<core.WithRawResponse<Ichos.EpisodesResponse>> {
+        const { metadataJson, metadataKey, metadataValue, query, limit, offset } = request;
+        const _queryParams: Record<string, string | string[] | object | object[] | null> = {};
+        if (metadataJson != null) {
+            _queryParams.metadataJson = metadataJson;
+        }
+
+        if (metadataKey != null) {
+            _queryParams.metadataKey = metadataKey;
+        }
+
+        if (metadataValue != null) {
+            _queryParams.metadataValue = metadataValue;
+        }
+
+        if (query != null) {
+            _queryParams.query = query;
+        }
+
+        if (limit != null) {
+            _queryParams.limit = limit.toString();
+        }
+
+        if (offset != null) {
+            _queryParams.offset = offset.toString();
+        }
+
+        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/episodes/search",
+            ),
+            method: "GET",
+            headers: _headers,
+            queryParameters: { ..._queryParams, ...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.EpisodesResponse, 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/episodes/search");
+    }
+
     /**
      * Retrieve a single episode by ID.
      *

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

@@ -27,6 +27,7 @@ export interface EpisodeCreate {
     persons?: Ichos.Person[] | null;
     license?: string | null;
     status?: EpisodeCreate.Status;
+    metadata?: Ichos.Metadata | null;
     autoPublish?: boolean;
     coverOptions?: Ichos.CoverUploadOptions;
     audioOptions?: Ichos.AudioUploadOptions;

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

@@ -17,6 +17,7 @@ export interface EpisodeUpdate {
     adsEnabled?: boolean;
     explicit?: boolean;
     block?: boolean;
+    metadata?: Ichos.Metadata;
     pubDate?: string;
     season?: number;
     episode?: number;

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

@@ -0,0 +1,24 @@
+// This file was auto-generated by Fern from our API Definition.
+
+/**
+ * @example
+ *     {
+ *         metadataJson: "{\"externalId\":\"123\",\"source\":\"crm\"}",
+ *         metadataKey: "externalId",
+ *         query: "launch"
+ *     }
+ */
+export interface SearchEpisodesRequest {
+    /** JSON object string to match against metadata (JSONB containment). */
+    metadataJson?: string;
+    /** Metadata key to filter by. */
+    metadataKey?: string;
+    /** Metadata value to filter by (string, number, boolean, or null). */
+    metadataValue?: string;
+    /** Search query string. Searches across episode fields and metadata. */
+    query?: string;
+    /** Max number of records to return. */
+    limit?: number;
+    /** Number of records to skip. */
+    offset?: number;
+}

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

@@ -10,3 +10,4 @@ export type { LinkEpisodeAudioRequest } from "./LinkEpisodeAudioRequest.js";
 export type { ListPodcastEpisodesRequest } from "./ListPodcastEpisodesRequest.js";
 export type { PublishEpisodeRequest } from "./PublishEpisodeRequest.js";
 export type { PullEpisodeCoverFromUrlRequest } from "./PullEpisodeCoverFromUrlRequest.js";
+export type { SearchEpisodesRequest } from "./SearchEpisodesRequest.js";

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

@@ -191,6 +191,116 @@ export class PodcastsClient {
         return handleNonStatusCodeError(_response.error, _response.rawResponse, "POST", "/v1/podcasts");
     }
 
+    /**
+     * Search podcasts in the authenticated organization.
+     *
+     * @param {Ichos.SearchPodcastsRequest} request
+     * @param {PodcastsClient.RequestOptions} requestOptions - Request-specific configuration.
+     *
+     * @throws {@link Ichos.UnauthorizedError}
+     * @throws {@link Ichos.ForbiddenError}
+     * @throws {@link Ichos.InternalServerError}
+     *
+     * @example
+     *     await client.podcasts.searchPodcasts({
+     *         metadataJson: "{\"externalId\":\"123\",\"source\":\"crm\"}",
+     *         metadataKey: "externalId",
+     *         query: "tech"
+     *     })
+     */
+    public searchPodcasts(
+        request: Ichos.SearchPodcastsRequest = {},
+        requestOptions?: PodcastsClient.RequestOptions,
+    ): core.HttpResponsePromise<Ichos.PodcastsResponse> {
+        return core.HttpResponsePromise.fromPromise(this.__searchPodcasts(request, requestOptions));
+    }
+
+    private async __searchPodcasts(
+        request: Ichos.SearchPodcastsRequest = {},
+        requestOptions?: PodcastsClient.RequestOptions,
+    ): Promise<core.WithRawResponse<Ichos.PodcastsResponse>> {
+        const { metadataJson, metadataKey, metadataValue, query, limit, offset } = request;
+        const _queryParams: Record<string, string | string[] | object | object[] | null> = {};
+        if (metadataJson != null) {
+            _queryParams.metadataJson = metadataJson;
+        }
+
+        if (metadataKey != null) {
+            _queryParams.metadataKey = metadataKey;
+        }
+
+        if (metadataValue != null) {
+            _queryParams.metadataValue = metadataValue;
+        }
+
+        if (query != null) {
+            _queryParams.query = query;
+        }
+
+        if (limit != null) {
+            _queryParams.limit = limit.toString();
+        }
+
+        if (offset != null) {
+            _queryParams.offset = offset.toString();
+        }
+
+        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/podcasts/search",
+            ),
+            method: "GET",
+            headers: _headers,
+            queryParameters: { ..._queryParams, ...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.PodcastsResponse, 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/podcasts/search");
+    }
+
     /**
      * Import a podcast from an RSS feed URL.
      *

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

@@ -51,6 +51,7 @@ export interface PodcastCreate {
     fundingUrl?: string | null;
     /** The text to display for the funding link. */
     fundingText?: string | null;
+    metadata?: Ichos.Metadata;
 }
 
 export namespace PodcastCreate {

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

@@ -52,6 +52,7 @@ export interface PodcastUpdate {
     fundingUrl?: string;
     /** The text to display for the funding link. */
     fundingText?: string;
+    metadata?: Ichos.Metadata;
 }
 
 export namespace PodcastUpdate {

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

@@ -0,0 +1,24 @@
+// This file was auto-generated by Fern from our API Definition.
+
+/**
+ * @example
+ *     {
+ *         metadataJson: "{\"externalId\":\"123\",\"source\":\"crm\"}",
+ *         metadataKey: "externalId",
+ *         query: "tech"
+ *     }
+ */
+export interface SearchPodcastsRequest {
+    /** JSON object string to match against metadata (JSONB containment). */
+    metadataJson?: string;
+    /** Metadata key to filter by. */
+    metadataKey?: string;
+    /** Metadata value to filter by (string, number, boolean, or null). */
+    metadataValue?: string;
+    /** Search query string. Searches across podcast fields and metadata. */
+    query?: string;
+    /** Max number of records to return. */
+    limit?: number;
+    /** Number of records to skip. */
+    offset?: number;
+}

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

@@ -9,4 +9,5 @@ export type { PodcastCreate } from "./PodcastCreate.js";
 export type { PodcastUpdate } from "./PodcastUpdate.js";
 export type { PublishPodcastRequest } from "./PublishPodcastRequest.js";
 export type { PullPodcastCoverFromUrlRequest } from "./PullPodcastCoverFromUrlRequest.js";
+export type { SearchPodcastsRequest } from "./SearchPodcastsRequest.js";
 export type { ValidatePodcastRequest } from "./ValidatePodcastRequest.js";

package/src/api/types/Episode.ts

@@ -14,7 +14,7 @@ export interface Episode {
     season: number | null;
     episode: number | null;
     episodeType: Episode.EpisodeType;
-    coverKey: string | null;
+    coverUrl: string | null;
     transcripts: Ichos.EpisodeTranscript[] | null;
     chaptersUrl: string | null;
     persons: Ichos.Person[] | null;
@@ -24,6 +24,7 @@ export interface Episode {
     audioId: string | null;
     guid: string;
     slug: string;
+    metadata: Ichos.Metadata;
     url: string;
     createdAt: string;
     updatedAt: string;

package/src/api/types/EpisodeCreatedResponseData.ts

@@ -14,7 +14,7 @@ export interface EpisodeCreatedResponseData {
     season: number | null;
     episode: number | null;
     episodeType: EpisodeCreatedResponseData.EpisodeType;
-    coverKey: string | null;
+    coverUrl: string | null;
     transcripts: Ichos.EpisodeTranscript[] | null;
     chaptersUrl: string | null;
     persons: Ichos.Person[] | null;
@@ -24,6 +24,7 @@ export interface EpisodeCreatedResponseData {
     audioId: string | null;
     guid: string;
     slug: string;
+    metadata: Ichos.Metadata;
     url: string;
     createdAt: string;
     updatedAt: string;

package/src/api/types/EpisodeSearchParams.ts

@@ -0,0 +1,23 @@
+// This file was auto-generated by Fern from our API Definition.
+
+export interface EpisodeSearchParams {
+    /** JSON object string to match against metadata (JSONB containment). */
+    metadataJson?: string;
+    /** Metadata key to filter by. */
+    metadataKey?: string;
+    /** Metadata value to filter by (string, number, boolean, or null). */
+    metadataValue?: EpisodeSearchParams.MetadataValue | null;
+    /** Search query string. Searches across episode fields and metadata. */
+    query?: string;
+    /** Max number of records to return. */
+    limit?: number;
+    /** Number of records to skip. */
+    offset?: number;
+}
+
+export namespace EpisodeSearchParams {
+    /**
+     * Metadata value to filter by (string, number, boolean, or null).
+     */
+    export type MetadataValue = string | number | boolean;
+}

package/src/api/types/Organization.ts

@@ -1,5 +1,7 @@
 // This file was auto-generated by Fern from our API Definition.
 
+import type * as Ichos from "../index.js";
+
 export interface Organization {
     /** Unique identifier for the organization. */
     id: string;
@@ -7,6 +9,7 @@ export interface Organization {
     name: string;
     /** The status of the organization. */
     status: Organization.Status;
+    metadata: Ichos.Metadata;
 }
 
 export namespace Organization {

package/src/api/types/Podcast.ts

@@ -50,6 +50,9 @@ export interface Podcast {
     fundingText: string | null;
     rssUrl: string | null;
     pubDate: string;
+    metadata: Ichos.Metadata;
+    createdAt: string;
+    updatedAt: string;
 }
 
 export namespace Podcast {

package/src/api/types/PodcastSearchParams.ts

@@ -0,0 +1,23 @@
+// This file was auto-generated by Fern from our API Definition.
+
+export interface PodcastSearchParams {
+    /** JSON object string to match against metadata (JSONB containment). */
+    metadataJson?: string;
+    /** Metadata key to filter by. */
+    metadataKey?: string;
+    /** Metadata value to filter by (string, number, boolean, or null). */
+    metadataValue?: PodcastSearchParams.MetadataValue | null;
+    /** Search query string. Searches across podcast fields and metadata. */
+    query?: string;
+    /** Max number of records to return. */
+    limit?: number;
+    /** Number of records to skip. */
+    offset?: number;
+}
+
+export namespace PodcastSearchParams {
+    /**
+     * Metadata value to filter by (string, number, boolean, or null).
+     */
+    export type MetadataValue = string | number | boolean;
+}

package/src/api/types/Segment.ts

@@ -1,5 +1,7 @@
 // This file was auto-generated by Fern from our API Definition.
 
+import type * as Ichos from "../index.js";
+
 export interface Segment {
     id: string;
     scope: Segment.Scope;
@@ -9,6 +11,7 @@ export interface Segment {
     virtualUserId?: string | null;
     podcastId?: string | null;
     audioId?: string | null;
+    metadata: Ichos.Metadata;
     createdAt: string;
     updatedAt: string;
 }

package/src/api/types/index.ts

@@ -26,6 +26,7 @@ export * from "./Episode.js";
 export * from "./EpisodeCreatedResponseData.js";
 export * from "./EpisodeCreateResponse.js";
 export * from "./EpisodeResponse.js";
+export * from "./EpisodeSearchParams.js";
 export * from "./EpisodesResponse.js";
 export * from "./EpisodeTranscript.js";
 export * from "./InternalServerErrorBody.js";
@@ -48,6 +49,7 @@ export * from "./Podcast.js";
 export * from "./PodcastImportCompletedPayload.js";
 export * from "./PodcastImportFailedPayload.js";
 export * from "./PodcastResponse.js";
+export * from "./PodcastSearchParams.js";
 export * from "./PodcastsResponse.js";
 export * from "./PublishPodcastOutput.js";
 export * from "./RetrieveCoverResponse.js";