/** * An object that represents a CloudKit database zone. * * A zone is a logical separation of records within a single database. Features are often associated with an entire zone. For example, a zone may be optionally shared from one user to another. * * API schema: CKDBZone * API version: 1.3.2 */ export interface CKDBZone { /** * The name that identifies the record zone. * * The default value is `_defaultZone`, which indicates the default zone of the current database. */ zoneName: string; /** * The unique identifier for a zone within a database. */ canonicalName: string; /** * The type for the zone. * * Possible values are `DEFAULT_ZONE` and `REGULAR_CUSTOM_ZONE`. */ zoneType: string; /** * A Boolean value that indicates whether the zone is a default zone. */ isDefaultZone: boolean; /** * A Boolean value that indicates whether records in this zone can be shared. */ isSharable?: boolean; /** * A Boolean value that indicates whether zone is eligible for Zone Share. */ isEligibleForZoneShare?: boolean; /** * A Boolean value that indicates whether zone is eligible for Hierarchical Share. */ isEligibleForHierarchicalShare?: boolean; /** * The owner of the zone. */ ownerRecordName?: string; /** * The client change token for the zone. */ changeToken?: string; /** * A Boolean value that indicates whether a zone allows atomic changes of multiple records. */ atomic: boolean; } /** * An object the provides the functions that * transform {@link CKDBZone } to and from JSON. */ export declare const jsonCodecCKDBZoneOwnProperties: { /** * Get an encoder that transforms {@link CKDBZone }'s * own properties to JSON. */ readonly getEncoder: () => { readonly zoneName: (value: string) => import("@apple/cktool.core").ValidatedNEA; readonly canonicalName: (value: string) => import("@apple/cktool.core").ValidatedNEA; readonly zoneType: (value: string) => import("@apple/cktool.core").ValidatedNEA; readonly isDefaultZone: (value: boolean) => import("@apple/cktool.core").ValidatedNEA; readonly isSharable: (value: boolean | import("fp-ts/lib/Option").Option | null | undefined) => import("@apple/cktool.core").ValidatedNEA>; readonly isEligibleForZoneShare: (value: boolean | import("fp-ts/lib/Option").Option | null | undefined) => import("@apple/cktool.core").ValidatedNEA>; readonly isEligibleForHierarchicalShare: (value: boolean | import("fp-ts/lib/Option").Option | null | undefined) => import("@apple/cktool.core").ValidatedNEA>; readonly ownerRecordName: (value: string | import("fp-ts/lib/Option").Option | null | undefined) => import("@apple/cktool.core").ValidatedNEA>; readonly changeToken: (value: string | import("fp-ts/lib/Option").Option | null | undefined) => import("@apple/cktool.core").ValidatedNEA>; readonly atomic: (value: boolean) => import("@apple/cktool.core").ValidatedNEA; }; /** * Get a decoder that transforms {@link CKDBZone }'s * own properties from JSON. */ readonly getDecoder: () => { readonly zoneName: (value: string) => import("@apple/cktool.core").ValidatedNEA; readonly canonicalName: (value: string) => import("@apple/cktool.core").ValidatedNEA; readonly zoneType: (value: string) => import("@apple/cktool.core").ValidatedNEA; readonly isDefaultZone: (value: boolean) => import("@apple/cktool.core").ValidatedNEA; readonly isSharable: (value: boolean | import("fp-ts/lib/Option").Option | null | undefined) => import("@apple/cktool.core").ValidatedNEA>; readonly isEligibleForZoneShare: (value: boolean | import("fp-ts/lib/Option").Option | null | undefined) => import("@apple/cktool.core").ValidatedNEA>; readonly isEligibleForHierarchicalShare: (value: boolean | import("fp-ts/lib/Option").Option | null | undefined) => import("@apple/cktool.core").ValidatedNEA>; readonly ownerRecordName: (value: string | import("fp-ts/lib/Option").Option | null | undefined) => import("@apple/cktool.core").ValidatedNEA>; readonly changeToken: (value: string | import("fp-ts/lib/Option").Option | null | undefined) => import("@apple/cktool.core").ValidatedNEA>; readonly atomic: (value: boolean) => import("@apple/cktool.core").ValidatedNEA; }; };