import * as z from "zod/v3";
import { ClosedEnum } from "../../types/enums.js";
import { Result as SafeParseResult } from "../../types/fp.js";
import { SDKValidationError } from "../errors/sdkvalidationerror.js";
/**
 * Ordering. Default is ID ASC. When using cursor pagination (see cursor param),
 *
 * @remarks
 * only `id` and `created` are supported. All other sort_by options (`position`, `title`, `updated`)
 * require offset pagination.
 */
export declare const GetChannelEpisodesSortBy: {
    readonly Position: "position";
    readonly Title: "title";
    readonly Created: "created";
    readonly Updated: "updated";
    readonly Id: "id";
};
/**
 * Ordering. Default is ID ASC. When using cursor pagination (see cursor param),
 *
 * @remarks
 * only `id` and `created` are supported. All other sort_by options (`position`, `title`, `updated`)
 * require offset pagination.
 */
export type GetChannelEpisodesSortBy = ClosedEnum<typeof GetChannelEpisodesSortBy>;
/**
 * Ordering Sort Direction (0 = desc, 1 = asc; default is 1)
 */
export declare const GetChannelEpisodesSortDirection: {
    readonly Zero: 0;
    readonly One: 1;
};
/**
 * Ordering Sort Direction (0 = desc, 1 = asc; default is 1)
 */
export type GetChannelEpisodesSortDirection = ClosedEnum<typeof GetChannelEpisodesSortDirection>;
/**
 * If `cursor[enabled]` is set to 1, the first result set will be fetched with cursor pagination enabled. This
 *
 * @remarks
 * values is ignored if `cursor[before]` or `cursor[after]` are set.
 */
export declare const GetChannelEpisodesEnabled: {
    readonly Zero: 0;
    readonly One: 1;
};
/**
 * If `cursor[enabled]` is set to 1, the first result set will be fetched with cursor pagination enabled. This
 *
 * @remarks
 * values is ignored if `cursor[before]` or `cursor[after]` are set.
 */
export type GetChannelEpisodesEnabled = ClosedEnum<typeof GetChannelEpisodesEnabled>;
/**
 * If `cursor[enabled]` is set to 1 than cursor pagination is enabled and the
 *
 * @remarks
 * first set of records are fetched up to the `per_page`. Cursor
 * pagination will also be turned on if `cursor[before]` or `cursor[after]`
 * are set. Records returned will have a `cursor` property set which can be used to fetch more records in the same `sort_by` ordering.
 * The cursor value of the last record can be used to fetch records after the current result set and
 * the cursor of the first record can be used to fetch records before the result set.
 *
 * NOTE: a cursor value is only valid if the `sort_by` value hasn't changed from the
 * last fetch. For example, you cannot fetch using `sort_by` id and than pass that
 * cursor value to a `sort_by` name.
 */
export type GetChannelEpisodesCursor = {
    /**
     * If `cursor[enabled]` is set to 1, the first result set will be fetched with cursor pagination enabled. This
     *
     * @remarks
     * values is ignored if `cursor[before]` or `cursor[after]` are set.
     */
    enabled?: GetChannelEpisodesEnabled | undefined;
    /**
     * If `cursor[before]` is set than cursor pagination is enabled and all records
     *
     * @remarks
     * before the cursor up to the `per_page` are returned. This feature is useful for
     * fetching "new records", for example, in a "pull to refersh" feature when showing records in a descending
     * order.
     */
    before?: string | undefined;
    /**
     * If `cursor[after]` is set than cursor pagination is enabled and all records
     *
     * @remarks
     * after the cursor up to the `per_page` are returned.
     */
    after?: string | undefined;
};
export type GetChannelEpisodesRequest = {
    /**
     * The hashed ID of the channel to grab channel episodes from.
     */
    channelId?: string | undefined;
    /**
     * Ordering. Default is ID ASC. When using cursor pagination (see cursor param),
     *
     * @remarks
     * only `id` and `created` are supported. All other sort_by options (`position`, `title`, `updated`)
     * require offset pagination.
     */
    sortBy?: GetChannelEpisodesSortBy | undefined;
    /**
     * Ordering Sort Direction (0 = desc, 1 = asc; default is 1)
     */
    sortDirection?: GetChannelEpisodesSortDirection | undefined;
    /**
     * The page number to retrieve. This cannot be combined with `cursor`,
     *
     * @remarks
     * pagination.
     */
    page?: number | undefined;
    /**
     * The number of medias per page. Use this for both offset pagination and cursor pagination.
     */
    perPage?: number | undefined;
    /**
     * If `cursor[enabled]` is set to 1 than cursor pagination is enabled and the
     *
     * @remarks
     * first set of records are fetched up to the `per_page`. Cursor
     * pagination will also be turned on if `cursor[before]` or `cursor[after]`
     * are set. Records returned will have a `cursor` property set which can be used to fetch more records in the same `sort_by` ordering.
     * The cursor value of the last record can be used to fetch records after the current result set and
     * the cursor of the first record can be used to fetch records before the result set.
     *
     * NOTE: a cursor value is only valid if the `sort_by` value hasn't changed from the
     * last fetch. For example, you cannot fetch using `sort_by` id and than pass that
     * cursor value to a `sort_by` name.
     */
    cursor?: GetChannelEpisodesCursor | undefined;
    /**
     * Filter by media id
     */
    mediaId?: Array<string> | undefined;
    /**
     * Filter by hashed id
     */
    hashedIds?: Array<string> | undefined;
    /**
     * Filter by published status.
     */
    published?: boolean | undefined;
    /**
     * Filter by channel episode name/title.
     */
    title?: string | undefined;
};
/**
 * A channel episode represents a media that has been added to a channel. Only published
 *
 * @remarks
 * episodes are displayed in a channel.
 */
export type GetChannelEpisodesResponse = {
    /**
     * A unique alphanumeric identifier for the channel episode's channel.
     */
    channelHashedId: string;
    /**
     * The date when the channel episode was originally created.
     */
    created: Date;
    /**
     * A cursor for stable pagination based on current `sort_by` order. You can pass this to `cursor[before]` or `cursor[after]` as a parameter to fetch the records before or after this record in the same sort order. This is only populated if records were fetched with `cursor[enabled]`, or `cursor[before]` or `cursor[after]`.
     */
    cursor?: string | null | undefined;
    /**
     * The channel episode's description or episode notes.
     */
    description: string;
    /**
     * A short summary of the episode that is displayed when space is limited.
     */
    summary: string;
    /**
     * A unique alphanumeric identifier for the channel episode.
     */
    hashedId: string;
    /**
     * A unique alphanumeric identifier for the channel episode's media.
     */
    mediaHashedId: string;
    /**
     * Whether the channel episode has been published or is still in draft form.
     */
    published: boolean;
    /**
     * The date and time when the episode is scheduled to be published in UTC timezone (only present when publish_status is 'scheduled').
     */
    publishAt?: Date | undefined;
    /**
     * The title of the channel episode
     */
    title: string | null;
    /**
     * The date when the channel was last updated.
     */
    updated: Date;
};
/** @internal */
export declare const GetChannelEpisodesSortBy$outboundSchema: z.ZodNativeEnum<typeof GetChannelEpisodesSortBy>;
/** @internal */
export declare const GetChannelEpisodesSortDirection$outboundSchema: z.ZodNativeEnum<typeof GetChannelEpisodesSortDirection>;
/** @internal */
export declare const GetChannelEpisodesEnabled$outboundSchema: z.ZodNativeEnum<typeof GetChannelEpisodesEnabled>;
/** @internal */
export type GetChannelEpisodesCursor$Outbound = {
    enabled?: number | undefined;
    before?: string | undefined;
    after?: string | undefined;
};
/** @internal */
export declare const GetChannelEpisodesCursor$outboundSchema: z.ZodType<GetChannelEpisodesCursor$Outbound, z.ZodTypeDef, GetChannelEpisodesCursor>;
export declare function getChannelEpisodesCursorToJSON(getChannelEpisodesCursor: GetChannelEpisodesCursor): string;
/** @internal */
export type GetChannelEpisodesRequest$Outbound = {
    channel_id?: string | undefined;
    sort_by?: string | undefined;
    sort_direction?: number | undefined;
    page?: number | undefined;
    per_page?: number | undefined;
    cursor?: GetChannelEpisodesCursor$Outbound | undefined;
    "media_id[]"?: Array<string> | undefined;
    "hashed_ids[]"?: Array<string> | undefined;
    published?: boolean | undefined;
    title?: string | undefined;
};
/** @internal */
export declare const GetChannelEpisodesRequest$outboundSchema: z.ZodType<GetChannelEpisodesRequest$Outbound, z.ZodTypeDef, GetChannelEpisodesRequest>;
export declare function getChannelEpisodesRequestToJSON(getChannelEpisodesRequest: GetChannelEpisodesRequest): string;
/** @internal */
export declare const GetChannelEpisodesResponse$inboundSchema: z.ZodType<GetChannelEpisodesResponse, z.ZodTypeDef, unknown>;
export declare function getChannelEpisodesResponseFromJSON(jsonString: string): SafeParseResult<GetChannelEpisodesResponse, SDKValidationError>;
//# sourceMappingURL=getchannelepisodes.d.ts.map