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";
/**
 * 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 GetChannelsEnabled: {
    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 GetChannelsEnabled = ClosedEnum<typeof GetChannelsEnabled>;
/**
 * 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 GetChannelsCursor = {
    /**
     * 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?: GetChannelsEnabled | 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;
};
/**
 * Ordering. Default is ID ASC.
 *
 * @remarks
 * Note: Only 'id' and 'created' are supported when using cursor pagination.
 */
export declare const GetChannelsSortBy: {
    readonly Created: "created";
    readonly Id: "id";
    readonly Updated: "updated";
    readonly Name: "name";
};
/**
 * Ordering. Default is ID ASC.
 *
 * @remarks
 * Note: Only 'id' and 'created' are supported when using cursor pagination.
 */
export type GetChannelsSortBy = ClosedEnum<typeof GetChannelsSortBy>;
/**
 * Ordering Sort Direction (0 = desc, 1 = asc; default is 1)
 */
export declare const GetChannelsSortDirection: {
    readonly Zero: 0;
    readonly One: 1;
};
/**
 * Ordering Sort Direction (0 = desc, 1 = asc; default is 1)
 */
export type GetChannelsSortDirection = ClosedEnum<typeof GetChannelsSortDirection>;
export type GetChannelsRequest = {
    /**
     * 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?: GetChannelsCursor | undefined;
    /**
     * Page number to retrieve
     */
    page?: number | undefined;
    /**
     * Number of channels per page
     */
    perPage?: number | undefined;
    /**
     * Ordering. Default is ID ASC.
     *
     * @remarks
     * Note: Only 'id' and 'created' are supported when using cursor pagination.
     */
    sortBy?: GetChannelsSortBy | undefined;
    /**
     * Ordering Sort Direction (0 = desc, 1 = asc; default is 1)
     */
    sortDirection?: GetChannelsSortDirection | undefined;
    /**
     * Find all of the channels limited to these hashed_ids.
     */
    hashedIds?: Array<string> | undefined;
};
/**
 * A Channel lets you take a collection of video (or audio) and embed them
 *
 * @remarks
 * on your site, as well as distribute through podcasting.
 */
export type GetChannelsResponse = {
    /**
     * The numeric id of the channel.
     */
    id: number;
    /**
     * The date when the channel was originally created.
     */
    created: Date;
    /**
     * The channel's description.
     */
    description: string;
    /**
     * A unique alphanumeric identifier for this channel.
     */
    hashedId: string;
    /**
     * The number of medias in the channel.
     */
    mediaCount: number;
    /**
     * The display name for the channel
     */
    name: string;
    /**
     * The date when the channel was last updated.
     */
    updated: 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;
};
/** @internal */
export declare const GetChannelsEnabled$outboundSchema: z.ZodNativeEnum<typeof GetChannelsEnabled>;
/** @internal */
export type GetChannelsCursor$Outbound = {
    enabled?: number | undefined;
    before?: string | undefined;
    after?: string | undefined;
};
/** @internal */
export declare const GetChannelsCursor$outboundSchema: z.ZodType<GetChannelsCursor$Outbound, z.ZodTypeDef, GetChannelsCursor>;
export declare function getChannelsCursorToJSON(getChannelsCursor: GetChannelsCursor): string;
/** @internal */
export declare const GetChannelsSortBy$outboundSchema: z.ZodNativeEnum<typeof GetChannelsSortBy>;
/** @internal */
export declare const GetChannelsSortDirection$outboundSchema: z.ZodNativeEnum<typeof GetChannelsSortDirection>;
/** @internal */
export type GetChannelsRequest$Outbound = {
    cursor?: GetChannelsCursor$Outbound | undefined;
    page?: number | undefined;
    per_page?: number | undefined;
    sort_by?: string | undefined;
    sort_direction?: number | undefined;
    "hashed_ids[]"?: Array<string> | undefined;
};
/** @internal */
export declare const GetChannelsRequest$outboundSchema: z.ZodType<GetChannelsRequest$Outbound, z.ZodTypeDef, GetChannelsRequest>;
export declare function getChannelsRequestToJSON(getChannelsRequest: GetChannelsRequest): string;
/** @internal */
export declare const GetChannelsResponse$inboundSchema: z.ZodType<GetChannelsResponse, z.ZodTypeDef, unknown>;
export declare function getChannelsResponseFromJSON(jsonString: string): SafeParseResult<GetChannelsResponse, SDKValidationError>;
//# sourceMappingURL=getchannels.d.ts.map