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 GetFoldersEnabled: {
    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 GetFoldersEnabled = ClosedEnum<typeof GetFoldersEnabled>;
/**
 * 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 GetFoldersCursor = {
    /**
     * 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?: GetFoldersEnabled | 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`, `updated` and `created` are supported. All other sort_by options
 * require offset pagination.
 */
export declare const GetFoldersSortBy: {
    readonly Name: "name";
    readonly Created: "created";
    readonly Updated: "updated";
    readonly MediaCount: "mediaCount";
    readonly Id: "id";
};
/**
 * Ordering. When using cursor pagination (see cursor param),
 *
 * @remarks
 * only `id`, `updated` and `created` are supported. All other sort_by options
 * require offset pagination.
 */
export type GetFoldersSortBy = ClosedEnum<typeof GetFoldersSortBy>;
/**
 * Ordering Sort Direction (0 = desc, 1 = asc; default is 1)
 */
export declare const GetFoldersSortDirection: {
    readonly Zero: 0;
    readonly One: 1;
};
/**
 * Ordering Sort Direction (0 = desc, 1 = asc; default is 1)
 */
export type GetFoldersSortDirection = ClosedEnum<typeof GetFoldersSortDirection>;
export type GetFoldersRequest = {
    /**
     * 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?: GetFoldersCursor | undefined;
    /**
     * Ordering. When using cursor pagination (see cursor param),
     *
     * @remarks
     * only `id`, `updated` and `created` are supported. All other sort_by options
     * require offset pagination.
     */
    sortBy?: GetFoldersSortBy | undefined;
    /**
     * Ordering Sort Direction (0 = desc, 1 = asc; default is 1)
     */
    sortDirection?: GetFoldersSortDirection | undefined;
    /**
     * A collection of hashed ids belonging to folders to fetch
     */
    hashedIds?: Array<string> | undefined;
};
/**
 * A string representing what type of media this is.
 */
export declare const GetFoldersType: {
    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 GetFoldersType = ClosedEnum<typeof GetFoldersType>;
/**
 * 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 GetFoldersStatus: {
    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 GetFoldersStatus = ClosedEnum<typeof GetFoldersStatus>;
export type GetFoldersThumbnail = {
    url?: string | undefined;
    width?: number | undefined;
    height?: number | undefined;
};
/**
 * A link to where you can fetch the medias for this folder.
 */
export type GetFoldersMedias = {
    /**
     * 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?: GetFoldersType | 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?: GetFoldersStatus | 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?: GetFoldersThumbnail | undefined;
};
/**
 * A folder (previously called a project) is a container in which to organize media into. It can be
 *
 * @remarks
 * used to set permissions that apply to all the media in the folder as well as
 * organizing media into subfolders (previously called media groups).
 */
export type GetFoldersResponse = {
    /**
     * A unique numeric identifier for the folder within the system.
     */
    id: number;
    /**
     * The folder’s display name.
     */
    name: string;
    /**
     * The folder’s description.
     */
    description?: string | null | undefined;
    /**
     * The number of different medias that have been uploaded to the folder.
     */
    mediaCount: number;
    /**
     * A link to where you can fetch the medias for this folder.
     */
    medias: GetFoldersMedias;
    /**
     * The date that the folder was originally created.
     */
    created: Date;
    /**
     * The date that the folder was last updated.
     */
    updated: Date;
    /**
     * A private hashed id, uniquely identifying the folder within the system.
     */
    hashedId: string;
    /**
     * A boolean indicating whether the folder is available for public (anonymous) viewing.
     */
    public: boolean;
    /**
     * If the folder is public, this field contains a string representing the ID used for referencing the folder in public URLs.
     */
    publicId: string | null;
    anonymousCanUpload?: boolean | undefined;
    anonymousCanDownload?: boolean | 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 GetFoldersEnabled$outboundSchema: z.ZodNativeEnum<typeof GetFoldersEnabled>;
/** @internal */
export type GetFoldersCursor$Outbound = {
    enabled?: number | undefined;
    before?: string | undefined;
    after?: string | undefined;
};
/** @internal */
export declare const GetFoldersCursor$outboundSchema: z.ZodType<GetFoldersCursor$Outbound, z.ZodTypeDef, GetFoldersCursor>;
export declare function getFoldersCursorToJSON(getFoldersCursor: GetFoldersCursor): string;
/** @internal */
export declare const GetFoldersSortBy$outboundSchema: z.ZodNativeEnum<typeof GetFoldersSortBy>;
/** @internal */
export declare const GetFoldersSortDirection$outboundSchema: z.ZodNativeEnum<typeof GetFoldersSortDirection>;
/** @internal */
export type GetFoldersRequest$Outbound = {
    page?: number | undefined;
    per_page?: number | undefined;
    cursor?: GetFoldersCursor$Outbound | undefined;
    sort_by?: string | undefined;
    sort_direction?: number | undefined;
    "hashed_ids[]"?: Array<string> | undefined;
};
/** @internal */
export declare const GetFoldersRequest$outboundSchema: z.ZodType<GetFoldersRequest$Outbound, z.ZodTypeDef, GetFoldersRequest>;
export declare function getFoldersRequestToJSON(getFoldersRequest: GetFoldersRequest): string;
/** @internal */
export declare const GetFoldersType$inboundSchema: z.ZodNativeEnum<typeof GetFoldersType>;
/** @internal */
export declare const GetFoldersStatus$inboundSchema: z.ZodNativeEnum<typeof GetFoldersStatus>;
/** @internal */
export declare const GetFoldersThumbnail$inboundSchema: z.ZodType<GetFoldersThumbnail, z.ZodTypeDef, unknown>;
export declare function getFoldersThumbnailFromJSON(jsonString: string): SafeParseResult<GetFoldersThumbnail, SDKValidationError>;
/** @internal */
export declare const GetFoldersMedias$inboundSchema: z.ZodType<GetFoldersMedias, z.ZodTypeDef, unknown>;
export declare function getFoldersMediasFromJSON(jsonString: string): SafeParseResult<GetFoldersMedias, SDKValidationError>;
/** @internal */
export declare const GetFoldersResponse$inboundSchema: z.ZodType<GetFoldersResponse, z.ZodTypeDef, unknown>;
export declare function getFoldersResponseFromJSON(jsonString: string): SafeParseResult<GetFoldersResponse, SDKValidationError>;
//# sourceMappingURL=getfolders.d.ts.map