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 GetFoldersFolderIdSharingsEnabled: { 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 GetFoldersFolderIdSharingsEnabled = ClosedEnum; /** * 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 GetFoldersFolderIdSharingsCursor = { /** * 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?: GetFoldersFolderIdSharingsEnabled | 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` is supported. */ export declare const GetFoldersFolderIdSharingsSortBy: { readonly Id: "id"; }; /** * Ordering. When using cursor pagination (see cursor param), * * @remarks * only `id` is supported. */ export type GetFoldersFolderIdSharingsSortBy = ClosedEnum; /** * Ordering Sort Direction (0 = desc, 1 = asc; default is 1) */ export declare const GetFoldersFolderIdSharingsSortDirection: { readonly Zero: 0; readonly One: 1; }; /** * Ordering Sort Direction (0 = desc, 1 = asc; default is 1) */ export type GetFoldersFolderIdSharingsSortDirection = ClosedEnum; export type GetFoldersFolderIdSharingsRequest = { /** * Folder Hashed ID */ folderId: string; /** * 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?: GetFoldersFolderIdSharingsCursor | undefined; /** * Ordering. When using cursor pagination (see cursor param), * * @remarks * only `id` is supported. */ sortBy?: GetFoldersFolderIdSharingsSortBy | undefined; /** * Ordering Sort Direction (0 = desc, 1 = asc; default is 1) */ sortDirection?: GetFoldersFolderIdSharingsSortDirection | undefined; /** * Filter sharings by their hashed IDs */ hashedIds?: Array | undefined; }; export type GetFoldersFolderIdSharingsShare = { id: number; name: string; type: string; email: string; }; export type GetFoldersFolderIdSharingsFolder = { id: number; name: string; }; /** * A sharing is an object that links either a contact or a contact group to a folder, including information about the contacts' permissions to that folder. * * @remarks */ export type GetFoldersFolderIdSharingsResponse = { id: number; isAdmin: boolean; canShare: boolean; canDownload: boolean; canUpload: boolean; share: GetFoldersFolderIdSharingsShare; folder: GetFoldersFolderIdSharingsFolder; /** * 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 GetFoldersFolderIdSharingsEnabled$outboundSchema: z.ZodNativeEnum; /** @internal */ export type GetFoldersFolderIdSharingsCursor$Outbound = { enabled?: number | undefined; before?: string | undefined; after?: string | undefined; }; /** @internal */ export declare const GetFoldersFolderIdSharingsCursor$outboundSchema: z.ZodType; export declare function getFoldersFolderIdSharingsCursorToJSON(getFoldersFolderIdSharingsCursor: GetFoldersFolderIdSharingsCursor): string; /** @internal */ export declare const GetFoldersFolderIdSharingsSortBy$outboundSchema: z.ZodNativeEnum; /** @internal */ export declare const GetFoldersFolderIdSharingsSortDirection$outboundSchema: z.ZodNativeEnum; /** @internal */ export type GetFoldersFolderIdSharingsRequest$Outbound = { folderId: string; page?: number | undefined; per_page?: number | undefined; cursor?: GetFoldersFolderIdSharingsCursor$Outbound | undefined; sort_by: string; sort_direction: number; "hashed_ids[]"?: Array | undefined; }; /** @internal */ export declare const GetFoldersFolderIdSharingsRequest$outboundSchema: z.ZodType; export declare function getFoldersFolderIdSharingsRequestToJSON(getFoldersFolderIdSharingsRequest: GetFoldersFolderIdSharingsRequest): string; /** @internal */ export declare const GetFoldersFolderIdSharingsShare$inboundSchema: z.ZodType; export declare function getFoldersFolderIdSharingsShareFromJSON(jsonString: string): SafeParseResult; /** @internal */ export declare const GetFoldersFolderIdSharingsFolder$inboundSchema: z.ZodType; export declare function getFoldersFolderIdSharingsFolderFromJSON(jsonString: string): SafeParseResult; /** @internal */ export declare const GetFoldersFolderIdSharingsResponse$inboundSchema: z.ZodType; export declare function getFoldersFolderIdSharingsResponseFromJSON(jsonString: string): SafeParseResult; //# sourceMappingURL=getfoldersfolderidsharings.d.ts.map