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 GetMediasEnabled: {
    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 GetMediasEnabled = ClosedEnum<typeof GetMediasEnabled>;
/**
 * 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 GetMediasCursor = {
    /**
     * 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?: GetMediasEnabled | 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. When using cursor pagination (see cursor param),
 *
 * @remarks
 * only `id` and `created` are supported. All other sort_by options (`name`, `updated`, `position`)
 * require offset pagination.
 */
export declare const GetMediasSortBy: {
    readonly Name: "name";
    readonly Created: "created";
    readonly Updated: "updated";
    readonly Position: "position";
};
/**
 * Ordering. When using cursor pagination (see cursor param),
 *
 * @remarks
 * only `id` and `created` are supported. All other sort_by options (`name`, `updated`, `position`)
 * require offset pagination.
 */
export type GetMediasSortBy = ClosedEnum<typeof GetMediasSortBy>;
/**
 * Ordering Sort Direction (0 = desc, 1 = asc; default is 1)
 */
export declare const GetMediasSortDirection: {
    readonly Zero: 0;
    readonly One: 1;
};
/**
 * Ordering Sort Direction (0 = desc, 1 = asc; default is 1)
 */
export type GetMediasSortDirection = ClosedEnum<typeof GetMediasSortDirection>;
/**
 * A string specifying which type of media you would like to get.
 */
export declare const QueryParamType: {
    readonly Video: "Video";
    readonly Audio: "Audio";
    readonly Image: "Image";
    readonly PdfDocument: "PdfDocument";
    readonly MicrosoftOfficeDocument: "MicrosoftOfficeDocument";
    readonly Swf: "Swf";
    readonly UnknownType: "UnknownType";
};
/**
 * A string specifying which type of media you would like to get.
 */
export type QueryParamType = ClosedEnum<typeof QueryParamType>;
export type GetMediasRequest = {
    /**
     * 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?: GetMediasCursor | undefined;
    /**
     * Ordering. When using cursor pagination (see cursor param),
     *
     * @remarks
     * only `id` and `created` are supported. All other sort_by options (`name`, `updated`, `position`)
     * require offset pagination.
     */
    sortBy?: GetMediasSortBy | undefined;
    /**
     * Ordering Sort Direction (0 = desc, 1 = asc; default is 1)
     */
    sortDirection?: GetMediasSortDirection | undefined;
    /**
     * A hashed ID specifying the folder from which you would like to get results.
     */
    folderId?: string | undefined;
    /**
     * Find a media or medias whose name exactly matches this parameter.
     */
    name?: string | undefined;
    /**
     * Format for media descriptions
     */
    descriptionFormat?: "markdown" | undefined;
    /**
     * A string specifying which type of media you would like to get.
     */
    type?: QueryParamType | undefined;
    /**
     * Find all of the medias by these hashed_ids.
     */
    hashedIds?: Array<string> | undefined;
    /**
     * Find all of the medias that match all of these tag names.
     */
    tags?: Array<string> | undefined;
    /**
     * Filter by archived status. True will return only archived medias, while false will return only active medias.
     */
    archived?: boolean | undefined;
};
/**
 * A string representing what type of media this is.
 */
export declare const GetMediasTypeResponse: {
    readonly Video: "Video";
    readonly Audio: "Audio";
    readonly Image: "Image";
    readonly PdfDocument: "PdfDocument";
    readonly MicrosoftOfficeDocument: "MicrosoftOfficeDocument";
    readonly Swf: "Swf";
    readonly UnknownType: "UnknownType";
};
/**
 * A string representing what type of media this is.
 */
export type GetMediasTypeResponse = ClosedEnum<typeof GetMediasTypeResponse>;
/**
 * Post upload processing status. - `queued`: the file is waiting in the queue to be processed. - `processing`: the file is actively being processed. - `ready`: the file has been fully processed and is ready for embedding and viewing. - `failed`: the file was unable to be processed (usually a format or size error).
 *
 * @remarks
 */
export declare const GetMediasStatus: {
    readonly Queued: "queued";
    readonly Processing: "processing";
    readonly Ready: "ready";
    readonly Failed: "failed";
};
/**
 * Post upload processing status. - `queued`: the file is waiting in the queue to be processed. - `processing`: the file is actively being processed. - `ready`: the file has been fully processed and is ready for embedding and viewing. - `failed`: the file was unable to be processed (usually a format or size error).
 *
 * @remarks
 */
export type GetMediasStatus = ClosedEnum<typeof GetMediasStatus>;
export type GetMediasThumbnail = {
    url?: string | undefined;
    width?: number | undefined;
    height?: number | undefined;
};
export type GetMediasFolder = {
    /**
     * A unique numeric identifier for the folder within the system.
     */
    id?: number | undefined;
    /**
     * The folder’s display name.
     */
    name?: string | undefined;
    /**
     * A private hashed id, uniquely identifying the folder within the system.
     */
    hashedId?: string | undefined;
};
export type GetMediasAsset = {
    /**
     * A direct-access URL to the content of the asset.
     */
    url?: string | undefined;
    /**
     * The width of this specific asset, if applicable.
     */
    width?: number | null | undefined;
    /**
     * The height of this specific asset, if applicable.
     */
    height?: number | null | undefined;
    /**
     * The size of the asset file that’s referenced by url, measured in bytes.
     */
    fileSize?: number | null | undefined;
    /**
     * The asset’s content type.
     */
    contentType?: string | null | undefined;
    /**
     * The internal type of the asset, describing how the asset should be used. Values can include OriginalFile, FlashVideoFile, MdFlashVideoFile, HdFlashVideoFile, Mp4VideoFile, MdMp4VideoFile, HdMp4VideoFile, IPhoneVideoFile, StillImageFile, SwfFile, Mp3AudioFile, and LargeImageFile.
     *
     * @remarks
     */
    type?: string | undefined;
};
/**
 * A subfolder within a folder that contains media.
 */
export type GetMediasSubfolder = {
    /**
     * A unique alphanumeric identifier for this subfolder.
     */
    hashedId: string;
    /**
     * The display name of the subfolder.
     */
    name?: string | null | undefined;
    /**
     * A description for the subfolder.
     */
    description?: string | null | undefined;
    /**
     * The position of this subfolder within its folder, used for ordering.
     */
    position: number | null;
    /**
     * The date when the subfolder was created.
     */
    created: Date | null;
    /**
     * The date when the subfolder was last modified.
     */
    updated: Date | null;
    /**
     * 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;
};
export type GetMediasTag = {
    /**
     * The display name of the tag.
     */
    name?: string | undefined;
};
/**
 * A media generally represents a video or an audio which can be embedded into your website.
 *
 * @remarks
 *
 * CDN-backed medias are accessible using this url structure: https://fast.wistia.com/embed/medias/{hashed_id}.m3u8.
 * For more information, see https://docs.wistia.com/docs/asset-urls#getting-hls-assets.
 */
export type GetMediasResponse = {
    /**
     * A unique numeric identifier for the media within the system.
     */
    id?: number | undefined;
    /**
     * The display name of the media.
     */
    name?: string | undefined;
    /**
     * A string representing what type of media this is.
     */
    type?: GetMediasTypeResponse | undefined;
    /**
     * Whether or not the media is archived, either true or false.
     */
    archived?: boolean | undefined;
    /**
     * The date when the media was originally uploaded.
     */
    created?: Date | undefined;
    /**
     * The date when the media was last changed.
     */
    updated?: Date | undefined;
    /**
     * Specifies the length (in seconds) for audio and video files. Specifies number of pages in the document. Omitted for other types of media.
     */
    duration?: number | null | undefined;
    /**
     * DEPRECATED: If you want to programmatically embed videos, follow the construct an embed code guide.
     *
     * @remarks
     *
     * @deprecated field: This will be removed in a future release, please migrate away from it as soon as possible.
     */
    embedCode?: string | undefined;
    /**
     * A unique alphanumeric identifier for this media.
     */
    hashedId?: string | undefined;
    /**
     * A description for the media which usually appears near the top of the sidebar on the media's page.
     */
    description?: string | undefined;
    /**
     * A floating point value between 0 and 1 that indicates the progress of the processing for this file.
     */
    progress?: number | undefined;
    /**
     * Post upload processing status. - `queued`: the file is waiting in the queue to be processed. - `processing`: the file is actively being processed. - `ready`: the file has been fully processed and is ready for embedding and viewing. - `failed`: the file was unable to be processed (usually a format or size error).
     *
     * @remarks
     */
    status?: GetMediasStatus | undefined;
    /**
     * The title of the section in which the media appears. This attribute is omitted if the media is not in a section (default).
     */
    section?: string | null | undefined;
    thumbnail?: GetMediasThumbnail | undefined;
    folder: GetMediasFolder | null;
    /**
     * An array of the assets available for this media.
     */
    assets?: Array<GetMediasAsset> | undefined;
    /**
     * The subfolder (media group) in which the media appears. Null if the media is not in a subfolder.
     */
    subfolder?: GetMediasSubfolder | undefined;
    /**
     * Tags associated with this media.
     */
    tags?: Array<GetMediasTag> | undefined;
    /**
     * 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 GetMediasEnabled$outboundSchema: z.ZodNativeEnum<typeof GetMediasEnabled>;
/** @internal */
export type GetMediasCursor$Outbound = {
    enabled?: number | undefined;
    before?: string | undefined;
    after?: string | undefined;
};
/** @internal */
export declare const GetMediasCursor$outboundSchema: z.ZodType<GetMediasCursor$Outbound, z.ZodTypeDef, GetMediasCursor>;
export declare function getMediasCursorToJSON(getMediasCursor: GetMediasCursor): string;
/** @internal */
export declare const GetMediasSortBy$outboundSchema: z.ZodNativeEnum<typeof GetMediasSortBy>;
/** @internal */
export declare const GetMediasSortDirection$outboundSchema: z.ZodNativeEnum<typeof GetMediasSortDirection>;
/** @internal */
export declare const QueryParamType$outboundSchema: z.ZodNativeEnum<typeof QueryParamType>;
/** @internal */
export type GetMediasRequest$Outbound = {
    page?: number | undefined;
    per_page?: number | undefined;
    cursor?: GetMediasCursor$Outbound | undefined;
    sort_by?: string | undefined;
    sort_direction?: number | undefined;
    folder_id?: string | undefined;
    name?: string | undefined;
    description_format?: "markdown" | undefined;
    type?: string | undefined;
    "hashed_ids[]"?: Array<string> | undefined;
    "tags[]"?: Array<string> | undefined;
    archived?: boolean | undefined;
};
/** @internal */
export declare const GetMediasRequest$outboundSchema: z.ZodType<GetMediasRequest$Outbound, z.ZodTypeDef, GetMediasRequest>;
export declare function getMediasRequestToJSON(getMediasRequest: GetMediasRequest): string;
/** @internal */
export declare const GetMediasTypeResponse$inboundSchema: z.ZodNativeEnum<typeof GetMediasTypeResponse>;
/** @internal */
export declare const GetMediasStatus$inboundSchema: z.ZodNativeEnum<typeof GetMediasStatus>;
/** @internal */
export declare const GetMediasThumbnail$inboundSchema: z.ZodType<GetMediasThumbnail, z.ZodTypeDef, unknown>;
export declare function getMediasThumbnailFromJSON(jsonString: string): SafeParseResult<GetMediasThumbnail, SDKValidationError>;
/** @internal */
export declare const GetMediasFolder$inboundSchema: z.ZodType<GetMediasFolder, z.ZodTypeDef, unknown>;
export declare function getMediasFolderFromJSON(jsonString: string): SafeParseResult<GetMediasFolder, SDKValidationError>;
/** @internal */
export declare const GetMediasAsset$inboundSchema: z.ZodType<GetMediasAsset, z.ZodTypeDef, unknown>;
export declare function getMediasAssetFromJSON(jsonString: string): SafeParseResult<GetMediasAsset, SDKValidationError>;
/** @internal */
export declare const GetMediasSubfolder$inboundSchema: z.ZodType<GetMediasSubfolder, z.ZodTypeDef, unknown>;
export declare function getMediasSubfolderFromJSON(jsonString: string): SafeParseResult<GetMediasSubfolder, SDKValidationError>;
/** @internal */
export declare const GetMediasTag$inboundSchema: z.ZodType<GetMediasTag, z.ZodTypeDef, unknown>;
export declare function getMediasTagFromJSON(jsonString: string): SafeParseResult<GetMediasTag, SDKValidationError>;
/** @internal */
export declare const GetMediasResponse$inboundSchema: z.ZodType<GetMediasResponse, z.ZodTypeDef, unknown>;
export declare function getMediasResponseFromJSON(jsonString: string): SafeParseResult<GetMediasResponse, SDKValidationError>;
//# sourceMappingURL=getmedias.d.ts.map