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 PutFoldersIdPublicEnum: { 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 PutFoldersIdPublicEnum = ClosedEnum; export type PutFoldersIdPublicUnion = PutFoldersIdPublicEnum | boolean; export type PutFoldersIdRequestBody = { /** * The folder’s new name. */ name?: string | undefined; /** * The folder’s new description. */ description?: string | undefined; /** * Whether anonymous users can upload media to the folder. */ anonymousCanUpload?: boolean | undefined; /** * Whether anonymous users can download media from the folder. */ anonymousCanDownload?: boolean | undefined; public?: PutFoldersIdPublicEnum | boolean | undefined; }; export type PutFoldersIdRequest = { /** * Folder Hashed ID */ id: string; requestBody?: PutFoldersIdRequestBody | undefined; }; /** * A string representing what type of media this is. */ export declare const PutFoldersIdType: { 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 PutFoldersIdType = 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 PutFoldersIdStatus: { 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 PutFoldersIdStatus = ClosedEnum; export type PutFoldersIdThumbnail = { url?: string | undefined; width?: number | undefined; height?: number | undefined; }; /** * A link to where you can fetch the medias for this folder. */ export type PutFoldersIdMedias = { /** * 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?: PutFoldersIdType | 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?: PutFoldersIdStatus | 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?: PutFoldersIdThumbnail | 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 PutFoldersIdResponse = { /** * 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: PutFoldersIdMedias; /** * 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 PutFoldersIdPublicEnum$outboundSchema: z.ZodNativeEnum; /** @internal */ export type PutFoldersIdPublicUnion$Outbound = string | boolean; /** @internal */ export declare const PutFoldersIdPublicUnion$outboundSchema: z.ZodType; export declare function putFoldersIdPublicUnionToJSON(putFoldersIdPublicUnion: PutFoldersIdPublicUnion): string; /** @internal */ export type PutFoldersIdRequestBody$Outbound = { name?: string | undefined; description?: string | undefined; anonymousCanUpload?: boolean | undefined; anonymousCanDownload?: boolean | undefined; public?: string | boolean | undefined; }; /** @internal */ export declare const PutFoldersIdRequestBody$outboundSchema: z.ZodType; export declare function putFoldersIdRequestBodyToJSON(putFoldersIdRequestBody: PutFoldersIdRequestBody): string; /** @internal */ export type PutFoldersIdRequest$Outbound = { id: string; RequestBody?: PutFoldersIdRequestBody$Outbound | undefined; }; /** @internal */ export declare const PutFoldersIdRequest$outboundSchema: z.ZodType; export declare function putFoldersIdRequestToJSON(putFoldersIdRequest: PutFoldersIdRequest): string; /** @internal */ export declare const PutFoldersIdType$inboundSchema: z.ZodNativeEnum; /** @internal */ export declare const PutFoldersIdStatus$inboundSchema: z.ZodNativeEnum; /** @internal */ export declare const PutFoldersIdThumbnail$inboundSchema: z.ZodType; export declare function putFoldersIdThumbnailFromJSON(jsonString: string): SafeParseResult; /** @internal */ export declare const PutFoldersIdMedias$inboundSchema: z.ZodType; export declare function putFoldersIdMediasFromJSON(jsonString: string): SafeParseResult; /** @internal */ export declare const PutFoldersIdResponse$inboundSchema: z.ZodType; export declare function putFoldersIdResponseFromJSON(jsonString: string): SafeParseResult; //# sourceMappingURL=putfoldersid.d.ts.map