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"; /** * A flag indicating whether or not the folder is enabled for public access. Set to “1” to enable and “0” to disable. */ export declare const PostFoldersPublicEnum: { readonly Zero: "0"; readonly One: "1"; }; /** * A flag indicating whether or not the folder is enabled for public access. Set to “1” to enable and “0” to disable. */ export type PostFoldersPublicEnum = ClosedEnum; export type PostFoldersPublicUnion = PostFoldersPublicEnum | boolean; export type PostFoldersRequest = { /** * The name of the folder you want to create. */ name?: string | undefined; /** * The email address of the person you want to set as the owner of this folder. Defaults to the Wistia Account Owner. */ adminEmail?: string | undefined; public?: PostFoldersPublicEnum | boolean | undefined; }; /** * A string representing what type of media this is. */ export declare const PostFoldersType: { 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 PostFoldersType = ClosedEnum; /** * 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 PostFoldersStatus: { 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 PostFoldersStatus = ClosedEnum; export type PostFoldersThumbnail = { url?: string | undefined; width?: number | undefined; height?: number | undefined; }; /** * A link to where you can fetch the medias for this folder. */ export type PostFoldersMedias = { /** * 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?: PostFoldersType | 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?: PostFoldersStatus | 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?: PostFoldersThumbnail | 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 PostFoldersResponse = { /** * 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: PostFoldersMedias; /** * 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 PostFoldersPublicEnum$outboundSchema: z.ZodNativeEnum; /** @internal */ export type PostFoldersPublicUnion$Outbound = string | boolean; /** @internal */ export declare const PostFoldersPublicUnion$outboundSchema: z.ZodType; export declare function postFoldersPublicUnionToJSON(postFoldersPublicUnion: PostFoldersPublicUnion): string; /** @internal */ export type PostFoldersRequest$Outbound = { name?: string | undefined; adminEmail?: string | undefined; public?: string | boolean | undefined; }; /** @internal */ export declare const PostFoldersRequest$outboundSchema: z.ZodType; export declare function postFoldersRequestToJSON(postFoldersRequest: PostFoldersRequest): string; /** @internal */ export declare const PostFoldersType$inboundSchema: z.ZodNativeEnum; /** @internal */ export declare const PostFoldersStatus$inboundSchema: z.ZodNativeEnum; /** @internal */ export declare const PostFoldersThumbnail$inboundSchema: z.ZodType; export declare function postFoldersThumbnailFromJSON(jsonString: string): SafeParseResult; /** @internal */ export declare const PostFoldersMedias$inboundSchema: z.ZodType; export declare function postFoldersMediasFromJSON(jsonString: string): SafeParseResult; /** @internal */ export declare const PostFoldersResponse$inboundSchema: z.ZodType; export declare function postFoldersResponseFromJSON(jsonString: string): SafeParseResult; //# sourceMappingURL=postfolders.d.ts.map