import { CancellablePromise } from "@apple/cktool.core"; import type { CancelledError, FetchError, PromisesApiBaseConstructor, ReactiveStreamError, ValidationError } from "@apple/cktool.core"; import { AcceptRecordParams, CreateAssetUploadUrlParams, CreateRecordParams, CreateZoneParams, DeleteRecordParams, DeleteRecordsByQueryParams, DeleteZoneParams, ExportSchemaParams, GetRecordParams, GetSessionUserParams, GetZoneParams, GetZonesParams, ImportSchemaParams, LookupRecordsParams, QueryRecordChangesParams, QueryRecordsParams, ResetConfigToProductionParams, ResetToProductionParams, ResolveRecordParams, UpdateRecordParams, ValidateSchemaParams } from "./descriptors"; import type { AcceptRecordOpConsts, AcceptRecordSecurity, CreateAssetUploadUrlOpConsts, CreateAssetUploadUrlSecurity, CreateRecordOpConsts, CreateRecordSecurity, CreateZoneOpConsts, CreateZoneSecurity, DeleteRecordOpConsts, DeleteRecordSecurity, DeleteRecordsByQueryOpConsts, DeleteRecordsByQuerySecurity, DeleteZoneOpConsts, DeleteZoneSecurity, ExportSchemaOpConsts, ExportSchemaSecurity, GetRecordOpConsts, GetRecordSecurity, GetSessionUserOpConsts, GetSessionUserSecurity, GetZoneOpConsts, GetZoneSecurity, GetZonesOpConsts, GetZonesSecurity, ImportSchemaOpConsts, ImportSchemaSecurity, LookupRecordsOpConsts, LookupRecordsSecurity, QueryRecordChangesOpConsts, QueryRecordChangesSecurity, QueryRecordsOpConsts, QueryRecordsSecurity, ResetConfigToProductionOpConsts, ResetConfigToProductionSecurity, ResetToProductionOpConsts, ResetToProductionSecurity, ResolveRecordOpConsts, ResolveRecordSecurity, UpdateRecordOpConsts, UpdateRecordSecurity, ValidateSchemaOpConsts, ValidateSchemaSecurity } from "./descriptors"; import { DatabaseOpDescriptorMap } from "./descriptorMap"; import { AcceptRecordPOptions, CreateAssetUploadUrlPOptions, CreateRecordPOptions, CreateZonePOptions, DeleteRecordPOptions, DeleteRecordsByQueryPOptions, DeleteZonePOptions, ExportSchemaPOptions, GetRecordPOptions, GetSessionUserPOptions, GetZonePOptions, GetZonesPOptions, ImportSchemaPOptions, LookupRecordsPOptions, QueryRecordChangesPOptions, QueryRecordsPOptions, ResetConfigToProductionPOptions, ResetToProductionPOptions, ResolveRecordPOptions, UpdateRecordPOptions, ValidateSchemaPOptions } from "./promises"; export declare type DatabasePromisesApiMixinSecurity = AcceptRecordSecurity | CreateAssetUploadUrlSecurity | CreateRecordSecurity | CreateZoneSecurity | DeleteRecordSecurity | DeleteRecordsByQuerySecurity | DeleteZoneSecurity | ExportSchemaSecurity | GetRecordSecurity | GetSessionUserSecurity | GetZoneSecurity | GetZonesSecurity | ImportSchemaSecurity | LookupRecordsSecurity | QueryRecordChangesSecurity | QueryRecordsSecurity | ResetConfigToProductionSecurity | ResetToProductionSecurity | ResolveRecordSecurity | UpdateRecordSecurity | ValidateSchemaSecurity; /** * API version: 1.3.2 */ export interface IDatabasePromisesApi { /** * Accepts a share on behalf of the current user. * * If successful, the result contains a `CKDBResolveRecordResponse` object that contains the resolved record. The recipient must accept the shared record before adding it to their shared database. A shared record's participants are listed in the `participants` field on `CKDBRecord`. You can update this array using the `updateRecord` operation. * * @param params.containerId - The container identifier. See `Container`. * @param params.environment - The container environment. For valid values, see `CKEnvironment`. * @param params.shortGuid - A global unique identifier for this record used for sharing. See `createRecord` for information on retrieving this identifier. * @param params.body - Configuration options for how the resolved record is returned. * @param options.configuration - The configuration object. * @param params.security - An optional dictionary of * security scheme names to the API key or cookie * used for authentication * with the ACP server. If not provided and this operation * is called in a browser, cookie authentication will be * used. * * @returns A promise that yields expected success responses * when resolved. * See {@link acceptRecordOp.responseDictionary} for * expected responses. Responses in the 2xx range will * be considered success responses. * Other responses will cause the promise to reject. */ acceptRecord(params: AcceptRecordParams, options?: Partial): CancellablePromise; /** * Creates a new URL for uploading assets. * * If successful, the result contains the URL to use when uploading an asset, which is valid for 15 minutes. Use this URL to upload your asset and provide the asset fields returned by the upload when creating or updating a record. The following fields are returned if the asset upload is successful: `size`, `receipt`, `fileChecksum`, `wrappingKey`, `referenceChecksum`. You can use these values when creating a `CKDBRecordFieldAssetValue` object for your asset field type. * * @param params.body - Details of the request to create an asset upload URL. * @param params.containerId - The container identifier. See `Container`. * @param params.environment - The container environment. For valid values, see `CKEnvironment`. * @param params.databaseType - The database type. For valid values, see `CKDatabaseType`. * @param params.zoneName - The zone name. See `CKDBZone`. * @param options.configuration - The configuration object. * @param params.security - An optional dictionary of * security scheme names to the API key or cookie * used for authentication * with the ACP server. If not provided and this operation * is called in a browser, cookie authentication will be * used. * * @returns A promise that yields expected success responses * when resolved. * See {@link createAssetUploadUrlOp.responseDictionary} for * expected responses. Responses in the 2xx range will * be considered success responses. * Other responses will cause the promise to reject. */ createAssetUploadUrl(params: CreateAssetUploadUrlParams, options?: Partial): CancellablePromise; /** * Creates a new record. * * If successful, the result contains a `CKDBRecordResponse` object with the created record. When creating a new record, if you omit the `recordName` property from `body`, the server assigns the record a UUID. When `assetType` fields exist in your record type, you must upload the assets prior to creating a record using the `createAssetUploadUrl` operation. For shared records, set the `createShortGuid` property in `body` to `true` in order to create a globally unique identifier for this record that the server uses when the share participant accepts a shared record. * * @param params.body - New record details. * @param params.containerId - The container identifier. See `Container`. * @param params.environment - The container environment. For valid values, see `CKEnvironment`. * @param params.databaseType - The database type. For valid values, see `CKDatabaseType`. * @param params.zoneName - The zone name. See `CKDBZone`. * @param options.configuration - The configuration object. * @param params.security - An optional dictionary of * security scheme names to the API key or cookie * used for authentication * with the ACP server. If not provided and this operation * is called in a browser, cookie authentication will be * used. * * @returns A promise that yields expected success responses * when resolved. * See {@link createRecordOp.responseDictionary} for * expected responses. Responses in the 2xx range will * be considered success responses. * Other responses will cause the promise to reject. */ createRecord(params: CreateRecordParams, options?: Partial): CancellablePromise; /** * Creates a new zone. * * If successful, the result contains a `CKDBZoneResponse` object with the created zone. * * @param params.body - New zone details. * @param params.containerId - The container identifier. See `Container`. * @param params.environment - The container environment. For valid values, see `CKEnvironment`. * @param params.databaseType - The database type. For valid values, see `CKDatabaseType`. * @param options.configuration - The configuration object. * @param params.security - An optional dictionary of * security scheme names to the API key or cookie * used for authentication * with the ACP server. If not provided and this operation * is called in a browser, cookie authentication will be * used. * * @returns A promise that yields expected success responses * when resolved. * See {@link createZoneOp.responseDictionary} for * expected responses. Responses in the 2xx range will * be considered success responses. * Other responses will cause the promise to reject. */ createZone(params: CreateZoneParams, options?: Partial): CancellablePromise; /** * Deletes a single record. * * If the operation completes successfully, the server returns a success response. * * @param params.containerId - The container identifier. See `Container`. * @param params.environment - The container environment. For valid values, see `CKEnvironment`. * @param params.databaseType - The database type. For valid values, see `CKDatabaseType`. * @param params.zoneName - The zone name. See `CKDBZone`. * @param params.recordName - The record name. See `CKDBRecord`. * @param options.configuration - The configuration object. * @param params.security - An optional dictionary of * security scheme names to the API key or cookie * used for authentication * with the ACP server. If not provided and this operation * is called in a browser, cookie authentication will be * used. * * @returns A promise that yields expected success responses * when resolved. * See {@link deleteRecordOp.responseDictionary} for * expected responses. Responses in the 2xx range will * be considered success responses. * Other responses will cause the promise to reject. */ deleteRecord(params: DeleteRecordParams, options?: Partial): CancellablePromise; /** * Deletes records matching the provided query. * * This operation allows you to delete multiple records of a record type that match specific filters. If the operation completes, the response contains a `CKDBPagedBatchDeleteResponse` object that details the result of the batch delete operation. You can delete up to 200 records in a single operation. If more records match your filters, the response also contains a continuation token that you can use to delete the next set of matching records. * * @param params.body - Query and other options for the delete records operation. * @param params.containerId - The container identifier. See `Container`. * @param params.environment - The container environment. For valid values, see `CKEnvironment`. * @param params.databaseType - The database type. For valid values, see `CKDatabaseType`. * @param params.zoneName - The zone name. See `CKDBZone`. * @param options.configuration - The configuration object. * @param params.security - An optional dictionary of * security scheme names to the API key or cookie * used for authentication * with the ACP server. If not provided and this operation * is called in a browser, cookie authentication will be * used. * * @returns A promise that yields expected success responses * when resolved. * See {@link deleteRecordsByQueryOp.responseDictionary} for * expected responses. Responses in the 2xx range will * be considered success responses. * Other responses will cause the promise to reject. */ deleteRecordsByQuery(params: DeleteRecordsByQueryParams, options?: Partial): CancellablePromise; /** * Deletes a zone. * * If the operation completes successfully, the server returns a success response. * * @param params.containerId - The container identifier. See `Container`. * @param params.environment - The container environment. For valid values, see `CKEnvironment`. * @param params.databaseType - The database type. For valid values, see `CKDatabaseType`. * @param params.zoneName - The zone name. See `CKDBZone`. * @param options.configuration - The configuration object. * @param params.security - An optional dictionary of * security scheme names to the API key or cookie * used for authentication * with the ACP server. If not provided and this operation * is called in a browser, cookie authentication will be * used. * * @returns A promise that yields expected success responses * when resolved. * See {@link deleteZoneOp.responseDictionary} for * expected responses. Responses in the 2xx range will * be considered success responses. * Other responses will cause the promise to reject. */ deleteZone(params: DeleteZoneParams, options?: Partial): CancellablePromise; /** * Downloads the container’s schema. * * Downloads a schema file for the environment specified. If the operation completes successfully, the returned response contains the textual representation of the container’s schema for the given environment. The text obtained this way is in CloudKit Schema Language. To learn more about CloudKit Schema Language, see `https://developer.apple.com/documentation/cloudkit/integrating_a_text-based_schema_into_your_workflow`. Related: `importSchema`, `validateSchema`. * * @param params.teamId - The team identifier. You can find your team identifier in the Membership tab of the Apple Developer portal at `https://developer.apple.com`. * @param params.containerId - The container identifier. See `Container`. * @param params.environment - The container environment. For valid values, see `CKEnvironment`. * @param options.configuration - The configuration object. * @param params.security - An optional dictionary of * security scheme names to the API key or cookie * used for authentication * with the ACP server. If not provided and this operation * is called in a browser, cookie authentication will be * used. * * @returns A promise that yields expected success responses * when resolved. * See {@link exportSchemaOp.responseDictionary} for * expected responses. Responses in the 2xx range will * be considered success responses. * Other responses will cause the promise to reject. */ exportSchema(params: ExportSchemaParams, options?: Partial): CancellablePromise; /** * Returns a record's details. * * If successful, the result contains a `CKDBRecordResponse` object with the requested record. If you provide `requestedFields`, the server only returns fields specified in that array. If it’s set to an empty array, the server returns record metadata without the field values. If you omit `requestedFields`, the server returns all record fields. * * @param params.containerId - The container identifier. See `Container`. * @param params.environment - The container environment. For valid values, see `CKEnvironment`. * @param params.databaseType - The database type. For valid values, see `CKDatabaseType`. * @param params.zoneName - The zone name. See `CKDBZone`. * @param params.recordName - The record name. See `CKDBRecord`. * @param params.requestedFields - The array of record field names that limits the amount of data returned in this operation. The server only returns fields specified in the array. * @param options.configuration - The configuration object. * @param params.security - An optional dictionary of * security scheme names to the API key or cookie * used for authentication * with the ACP server. If not provided and this operation * is called in a browser, cookie authentication will be * used. * * @returns A promise that yields expected success responses * when resolved. * See {@link getRecordOp.responseDictionary} for * expected responses. Responses in the 2xx range will * be considered success responses. * Other responses will cause the promise to reject. */ getRecord(params: GetRecordParams, options?: Partial): CancellablePromise; /** * Returns details for the user in current session. * * If successful, the returned response contains a `CKDBSessionUserResponse` object with the current user information. If the user hasn't authenticated yet or if their authentication has expired, the server returns an `AuthenticationRequiredError` error with a `redirectUrl` that your app can use to re-authenticate the user. * * @param params.containerId - The container identifier. See `Container`. * @param params.environment - The container environment. For valid values, see `CKEnvironment`. * @param options.configuration - The configuration object. * @param params.security - An optional dictionary of * security scheme names to the API key or cookie * used for authentication * with the ACP server. If not provided and this operation * is called in a browser, cookie authentication will be * used. * * @returns A promise that yields expected success responses * when resolved. * See {@link getSessionUserOp.responseDictionary} for * expected responses. Responses in the 2xx range will * be considered success responses. * Other responses will cause the promise to reject. */ getSessionUser(params: GetSessionUserParams, options?: Partial): CancellablePromise; /** * Returns details for a zone. * * If successful, the result contains a `CKDBZoneResponse` object with the requested zone details. * * @param params.containerId - The container identifier. See `Container`. * @param params.environment - The container environment. For valid values, see `CKEnvironment`. * @param params.databaseType - The database type. For valid values, see `CKDatabaseType`. * @param params.zoneName - The zone name. See `CKDBZone`. * @param options.configuration - The configuration object. * @param params.security - An optional dictionary of * security scheme names to the API key or cookie * used for authentication * with the ACP server. If not provided and this operation * is called in a browser, cookie authentication will be * used. * * @returns A promise that yields expected success responses * when resolved. * See {@link getZoneOp.responseDictionary} for * expected responses. Responses in the 2xx range will * be considered success responses. * Other responses will cause the promise to reject. */ getZone(params: GetZoneParams, options?: Partial): CancellablePromise; /** * Returns a collection of zones. * * If successful, the returned result contains a `CKDBZonesResponse` object with an array of zones. If there are more zones than the server can return in one response, the server provides a continuation token to fetch the next set of zones. * * @param params.containerId - The container identifier. See `Container`. * @param params.environment - The container environment. For valid values, see `CKEnvironment`. * @param params.databaseType - The database type. For valid values, see `CKDatabaseType`. * @param params.continuationToken - Optional continuation token that defines your place in the collection of zones. If the `getZones` response contains a continuation token, you can provide that token here to fetch the next set of zones. * @param options.configuration - The configuration object. * @param params.security - An optional dictionary of * security scheme names to the API key or cookie * used for authentication * with the ACP server. If not provided and this operation * is called in a browser, cookie authentication will be * used. * * @returns A promise that yields expected success responses * when resolved. * See {@link getZonesOp.responseDictionary} for * expected responses. Responses in the 2xx range will * be considered success responses. * Other responses will cause the promise to reject. */ getZones(params: GetZonesParams, options?: Partial): CancellablePromise; /** * Uploads a file that defines the new schema for the container. * * Changes the container’s schema using the uploaded text file for the environment specified. If the operation completes successfully, the server returns a success response. The text you provide in the file object must be in CloudKit Schema Language. To learn more about CloudKit Schema Language, see `https://developer.apple.com/documentation/cloudkit/integrating_a_text-based_schema_into_your_workflow`. Note that in most cases, you use `CKEnvironment.DEVELOPMENT` as the environment. Related: `exportSchema`, `validateSchema`. * * @param params.file * @param params.teamId - The team identifier. You can find your team identifier in the Membership tab of the Apple Developer portal at `https://developer.apple.com`. * @param params.containerId - The container identifier. See `Container`. * @param params.environment - The container environment. For valid values, see `CKEnvironment`. * @param options.configuration - The configuration object. * @param params.security - An optional dictionary of * security scheme names to the API key or cookie * used for authentication * with the ACP server. If not provided and this operation * is called in a browser, cookie authentication will be * used. * * @returns A promise that yields expected success responses * when resolved. * See {@link importSchemaOp.responseDictionary} for * expected responses. Responses in the 2xx range will * be considered success responses. * Other responses will cause the promise to reject. */ importSchema(params: ImportSchemaParams, options?: Partial): CancellablePromise; /** * Fetches multiple records by record name. * * If successful, the server returns a `CKDBLookupRecordsResponse` object, which contains an array of `CKDBRecordResult` objects. `CKDBRecordResult` can represent three types of records: existing, deleted, and error. You can verify that a returned record isn't missing or deleted by checking that the type is set to `existing`. * * @param params.body - The array of record names to look up. * @param params.containerId - The container identifier. See `Container`. * @param params.environment - The container environment. For valid values, see `CKEnvironment`. * @param params.databaseType - The database type. For valid values, see `CKDatabaseType`. * @param params.zoneName - The zone name. See `CKDBZone`. * @param options.configuration - The configuration object. * @param params.security - An optional dictionary of * security scheme names to the API key or cookie * used for authentication * with the ACP server. If not provided and this operation * is called in a browser, cookie authentication will be * used. * * @returns A promise that yields expected success responses * when resolved. * See {@link lookupRecordsOp.responseDictionary} for * expected responses. Responses in the 2xx range will * be considered success responses. * Other responses will cause the promise to reject. */ lookupRecords(params: LookupRecordsParams, options?: Partial): CancellablePromise; /** * Returns records that changed since a specified sync token or since a zone was created. * * If successful, the response contains a `CKDBRecordChangesResponse` object with an array of `CKDBRecordResult` objects. `CKDBRecordResult` can represent three types of records: existing, deleted, and error. You can verify that a returned record isn't missing or deleted by checking that the type is set to `existing`. * * @param params.containerId - The container identifier. See `Container`. * @param params.environment - The container environment. For valid values, see `CKEnvironment`. * @param params.databaseType - The database type. For valid values, see `CKDatabaseType`. * @param params.zoneName - The zone name. See `CKDBZone`. * @param params.body - Request parameters for fetching record changes. You can customize record changes that the server fetches by providing starting change token, record types, and fields in the body parameter. See `CKDBRecordChangesRequestBody`. * @param options.configuration - The configuration object. * @param params.security - An optional dictionary of * security scheme names to the API key or cookie * used for authentication * with the ACP server. If not provided and this operation * is called in a browser, cookie authentication will be * used. * * @returns A promise that yields expected success responses * when resolved. * See {@link queryRecordChangesOp.responseDictionary} for * expected responses. Responses in the 2xx range will * be considered success responses. * Other responses will cause the promise to reject. */ queryRecordChanges(params: QueryRecordChangesParams, options?: Partial): CancellablePromise; /** * Returns a collection of records matching the provided query. * * If successful, the response contains a `CKDBRecordsResponse` object with an array of records. For details on the body parameter see `CKDBQueryRecordsRequestBody`. * * @param params.body - Details of the query to use when fetching records. * @param params.containerId - The container identifier. See `Container`. * @param params.environment - The container environment. For valid values, see `CKEnvironment`. * @param params.databaseType - The database type. For valid values, see `CKDatabaseType`. * @param params.zoneName - The zone name. See `CKDBZone`. * @param options.configuration - The configuration object. * @param params.security - An optional dictionary of * security scheme names to the API key or cookie * used for authentication * with the ACP server. If not provided and this operation * is called in a browser, cookie authentication will be * used. * * @returns A promise that yields expected success responses * when resolved. * See {@link queryRecordsOp.responseDictionary} for * expected responses. Responses in the 2xx range will * be considered success responses. * Other responses will cause the promise to reject. */ queryRecords(params: QueryRecordsParams, options?: Partial): CancellablePromise; /** * Resets the container configuration to production. * * @param params.teamId - The team identifier. You can find your team identifier in the Membership tab of the Apple Developer portal at `https://developer.apple.com`. * @param params.containerId - The container identifier. See `Container`. * @param options.configuration - The configuration object. * @param params.security - An optional dictionary of * security scheme names to the API key or cookie * used for authentication * with the ACP server. If not provided and this operation * is called in a browser, cookie authentication will be * used. * * @returns A promise that yields expected success responses * when resolved. * See {@link resetConfigToProductionOp.responseDictionary} for * expected responses. Responses in the 2xx range will * be considered success responses. * Other responses will cause the promise to reject. */ resetConfigToProduction(params: ResetConfigToProductionParams, options?: Partial): CancellablePromise; /** * Resets the schema of the environment to production. * * Changes the schema of the container within the given environment to production and resets the environment. If the operation completes successfully, the server returns a success response. * * @param params.teamId - The team identifier. You can find your team identifier in the Membership tab of the Apple Developer portal at `https://developer.apple.com`. * @param params.containerId - The container identifier. See `Container`. * @param params.environment - The container environment. For valid values, see `CKEnvironment`. * @param options.configuration - The configuration object. * @param params.security - An optional dictionary of * security scheme names to the API key or cookie * used for authentication * with the ACP server. If not provided and this operation * is called in a browser, cookie authentication will be * used. * * @returns A promise that yields expected success responses * when resolved. * See {@link resetToProductionOp.responseDictionary} for * expected responses. Responses in the 2xx range will * be considered success responses. * Other responses will cause the promise to reject. */ resetToProduction(params: ResetToProductionParams, options?: Partial): CancellablePromise; /** * Fetches information about records given their shortGuid properties. * * If successful, the response contains a `CKDBResolveRecordResponse` object with the resolved record. * * @param params.containerId - The container identifier. See `Container`. * @param params.environment - The container environment. For valid values, see `CKEnvironment`. * @param params.shortGuid - A global unique identifier for this record used for sharing. See `createRecord` for information on retrieving this identifier. * @param params.body - Configuration options for how the resolved record is returned. * @param options.configuration - The configuration object. * @param params.security - An optional dictionary of * security scheme names to the API key or cookie * used for authentication * with the ACP server. If not provided and this operation * is called in a browser, cookie authentication will be * used. * * @returns A promise that yields expected success responses * when resolved. * See {@link resolveRecordOp.responseDictionary} for * expected responses. Responses in the 2xx range will * be considered success responses. * Other responses will cause the promise to reject. */ resolveRecord(params: ResolveRecordParams, options?: Partial): CancellablePromise; /** * Updates an existing record. * * If successful, the response contains a `CKDBRecordResponse` object with the updated record. If there are `assetType` fields in your record type, you must upload the assets prior to creating a record using the `createAssetUploadUrl` operation. If this record will be shared, you must set `createShortGuid` to `true` to create a globally unique identifier for this record that your app uses when a share participant accepts a shared record. * * @param params.body - Updated record details. If there are `assetType` fields in your record type, you must upload the assets prior to creating a record using the createAssetUploadUrl operation. If this record will be shared, you must set `createShortGuid` to `true` to create a globally unique identifier for this record that your app uses when a share participant accepts a shared record. * @param params.containerId - The container identifier. See `Container`. * @param params.environment - The container environment. For valid values, see `CKEnvironment`. * @param params.databaseType - The database type. For valid values, see `CKDatabaseType`. * @param params.zoneName - The zone name. See `CKDBZone`. * @param params.recordName - The record name. See `CKDBRecord`. * @param params.force - If true, forces the operation to work without `changeTag`. * @param options.configuration - The configuration object. * @param params.security - An optional dictionary of * security scheme names to the API key or cookie * used for authentication * with the ACP server. If not provided and this operation * is called in a browser, cookie authentication will be * used. * * @returns A promise that yields expected success responses * when resolved. * See {@link updateRecordOp.responseDictionary} for * expected responses. Responses in the 2xx range will * be considered success responses. * Other responses will cause the promise to reject. */ updateRecord(params: UpdateRecordParams, options?: Partial): CancellablePromise; /** * Validates the uploaded schema file for the container. * * If the operation completes successfully, the response contains a result with a `CKDBValidateSchemaResponse` object. A schema validates successfully only if it has the correct syntax and if `importSchema` is able to import it successfully to the container. The text you provide in the file object must be in CloudKit Schema Language. To learn more about CloudKit Schema Language, see `https://developer.apple.com/documentation/cloudkit/integrating_a_text-based_schema_into_your_workflow`. Related: `exportSchema`, `importSchema`. * * @param params.file * @param params.teamId - The team identifier. You can find your team identifier in the Membership tab of the Apple Developer portal at `https://developer.apple.com`. * @param params.containerId - The container identifier. See `Container`. * @param params.environment - The container environment. For valid values, see `CKEnvironment`. * @param options.configuration - The configuration object. * @param params.security - An optional dictionary of * security scheme names to the API key or cookie * used for authentication * with the ACP server. If not provided and this operation * is called in a browser, cookie authentication will be * used. * * @returns A promise that yields expected success responses * when resolved. * See {@link validateSchemaOp.responseDictionary} for * expected responses. Responses in the 2xx range will * be considered success responses. * Other responses will cause the promise to reject. */ validateSchema(params: ValidateSchemaParams, options?: Partial): CancellablePromise; } /** * @hidden * @internal */ export declare function DatabasePromisesApiMixin(Base: TBase & { __CKTOOL_DatabasePromisesApi?: unknown; }): TBase & PromisesApiBaseConstructor & { readonly __descriptorMap: TBase["__descriptorMap"] & DatabaseOpDescriptorMap; }; }> & { readonly __descriptorMap: TBase["__descriptorMap"] & DatabaseOpDescriptorMap; };