///
import { DocumentedResponseError } from "@apple/cktool.core";
import type { ApiOperationOptionsBase, FetchError, Source, ValidationError, ValueFromValidator } from "@apple/cktool.core";
import { AuthenticationRequiredError, CKEnvironment, RequestError } from "@apple/cktool.api.base";
import { CKDBAssetUploadUrlResponse, CKDBCreateAssetUploadUrlRequestBody, CKDBCreateRecordRequestBody, CKDBCreateZoneRequestBody, CKDBDeleteRecordsByQueryRequestBody, CKDBLookupRecordsRequestBody, CKDBLookupRecordsResponse, CKDBModifyRecordRequestBody, CKDBPagedBatchDeleteResponse, CKDBQueryRecordsRequestBody, CKDBRecordChangesRequestBody, CKDBRecordChangesResponse, CKDBRecordResponse, CKDBRecordsResponse, CKDBResolveRecordRequestBody, CKDBResolveRecordResponse, CKDBSessionUserResponse, CKDBValidateSchemaResponse, CKDBZoneResponse, CKDBZonesResponse } from "../models/index";
import * as Security from "./security";
/****************************************************************************************
*/
declare const getParamsValidatorForAcceptRecord: () => (obj: T) => import("@apple/cktool.core").ValidatedNEA & {
environment: CKEnvironment;
shortGuid: string;
containerId: string;
} & {
body?: {
readonly requestedFields: string[] | undefined;
readonly shouldFetchRootRecord: boolean | undefined;
} | undefined;
}>;
declare type AcceptRecordParamsValidator = ReturnType;
/**
* @hidden
* @internal
* @privateRemarks
* Constants for the operation that must be declared
* before use in the public operation object.
*/
declare const acceptRecordOpConsts: {
/**
* @hidden
* @internal
* @privateRemarks
* The validator used to validate the
* parameters passed to the stream function
* of this operation.
*/
readonly getParamsValidator: () => (obj: T) => import("@apple/cktool.core").ValidatedNEA & {
environment: CKEnvironment;
shortGuid: string;
containerId: string;
} & {
body?: {
readonly requestedFields: string[] | undefined;
readonly shouldFetchRootRecord: boolean | undefined;
} | undefined;
}>;
/**
* @hidden
* @internal
* @privateRemarks
* A map of HTTP response codes
* to expected success responses.
*/
readonly successResponses: {
readonly 200: {
readonly description: string;
readonly contentType: "application/json";
readonly getDecoderFn: () => (val: unknown) => import("@apple/cktool.core").ValidatedNEA;
};
};
/**
* @hidden
* @internal
* @privateRemarks
* A map of HTTP response codes
* to expected failure responses.
*/
readonly failureResponses: {
readonly 421: {
readonly description: string;
readonly contentType: "application/json";
readonly getDecoderFn: () => (val: unknown) => import("@apple/cktool.core").ValidatedNEA;
};
readonly 0: {
readonly description: string;
readonly contentType: "application/json";
readonly getDecoderFn: () => (val: unknown) => import("@apple/cktool.core").ValidatedNEA;
};
};
/**
* @internal
*/
readonly security: readonly [readonly ["CookieAuth"], readonly ["UserTokenAuth"], readonly ["CloudKitAPITokenAuth"], readonly ["CloudKitAPITokenAuth", "CloudKitWebAuthTokenAuth"]];
};
export declare type AcceptRecordSecurity = {
[Security.SCHEME_KEY_CookieAuth]: string;
} | {
[Security.SCHEME_KEY_UserTokenAuth]: string;
} | {
[Security.SCHEME_KEY_CloudKitAPITokenAuth]: string;
} | {
[Security.SCHEME_KEY_CloudKitAPITokenAuth]: string;
[Security.SCHEME_KEY_CloudKitWebAuthTokenAuth]: string;
};
/**
* @internal
*/
export declare type AcceptRecordOpConsts = typeof acceptRecordOpConsts & {
successTypes: never | {
statusCode: 200;
description: string;
result: CKDBResolveRecordResponse;
};
responseErrorTypes: never | DocumentedResponseError | DocumentedResponseError;
securityTypes: AcceptRecordSecurity;
};
/**
* Parameters type for acceptRecord.
*/
export interface AcceptRecordParams {
/**
* The container identifier. See `Container`.
*/
containerId: string;
/**
* The container environment. For valid values, see `CKEnvironment`.
*/
environment: CKEnvironment;
/**
* A global unique identifier for this record used for sharing. See `createRecord` for information on retrieving this identifier.
*/
shortGuid: string;
/**
* Configuration options for how the resolved record is returned.
*/
body?: CKDBResolveRecordRequestBody;
}
export interface AcceptRecordOpOptions extends ApiOperationOptionsBase {
security?: AcceptRecordSecurity;
}
/**
* @internal
*
* 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.
* API operation: acceptRecord
* API version: 1.3.2
*/
export declare const acceptRecordOp: {
/**
* @hidden
* @internal
* @privateRemarks
* The unique name of this operation, which corresponds
* to the OpenAPI specification from which this object
* was generated.
*/
readonly name: "acceptRecord";
/**
* @hidden
* @internal
* @privateRemarks
* The HTTP method this operation uses when making a
* request to the server.
* @internal
*/
readonly httpMethod: "POST";
/**
* @hidden
* @internal
* @privateRemarks
* The RESTful server path this operation uses when
* making a request to the server.
* @internal
*/
readonly path: "/v1/database/containers/{containerId}/environments/{environment}/sharedRecords/{shortGuid}/accept";
/**
* @hidden
* @internal
*/
readonly requestBodyContentTypes: readonly ["application/json"];
/**
* @hidden
* @internal
*/
readonly multipartParams: readonly [];
/**
* @hidden
* @internal
*
* 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.
*
* This function validates the parameters passed in
* before communicating with the server.
* If the parameters fail the check, the callbag
* source will end with an error.
*
* API operation: acceptRecord
* API version: 1.3.2
*
* @param options.configuration - The configuration object.
* @param options.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.
* @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.
*
* @returns A pullable callbag source
* that yields expected success responses.
* For more information on callbags, see the
* (standard)[https://github.com/callbag/callbag].
* See {@link acceptRecordOp.responseDictionary} for
* expected responses. Responses in the 2xx range will
* be considered success responses and will be sent
* in the stream. Other responses will cause the
* stream to end with an error condition.
*/
readonly $: (options: AcceptRecordOpOptions, params: AcceptRecordParams) => Source;
/**
* @hidden
* @internal
*
* 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.
*
* This function does not validate the parameters passed in.
*
* @param options.configuration - The configuration object.
* @param options.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.
* @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.
*
* @returns A pullable callbag source
* that yields expected success responses.
* For more information on callbags, see the
* (standard)[https://github.com/callbag/callbag].
* See {@link acceptRecordOp.responseDictionary} for
* expected responses. Responses in the 2xx range will
* be considered success responses and will be sent
* in the stream. Other responses will cause the
* stream to end with an error condition.
*/
readonly unchecked$: (options: AcceptRecordOpOptions, params: ValueFromValidator) => Source;
/**
* @hidden
* @internal
* @privateRemarks
* Indicates whether or not this operation is
* expected to change server state.
*/
readonly isMutating: true;
/**
* @hidden
* @internal
* @privateRemarks
* A map of HTTP response codes to expected responses.
*/
readonly responseDictionary: {
readonly 421: {
readonly description: string;
readonly contentType: "application/json";
readonly getDecoderFn: () => (val: unknown) => import("@apple/cktool.core").ValidatedNEA;
};
readonly 0: {
readonly description: string;
readonly contentType: "application/json";
readonly getDecoderFn: () => (val: unknown) => import("@apple/cktool.core").ValidatedNEA;
};
readonly 200: {
readonly description: string;
readonly contentType: "application/json";
readonly getDecoderFn: () => (val: unknown) => import("@apple/cktool.core").ValidatedNEA;
};
};
/**
* @hidden
* @internal
* @privateRemarks
* The validator used to validate the
* parameters passed to the stream function
* of this operation.
*/
readonly getParamsValidator: () => (obj: T) => import("@apple/cktool.core").ValidatedNEA & {
environment: CKEnvironment;
shortGuid: string;
containerId: string;
} & {
body?: {
readonly requestedFields: string[] | undefined;
readonly shouldFetchRootRecord: boolean | undefined;
} | undefined;
}>;
/**
* @hidden
* @internal
* @privateRemarks
* A map of HTTP response codes
* to expected success responses.
*/
readonly successResponses: {
readonly 200: {
readonly description: string;
readonly contentType: "application/json";
readonly getDecoderFn: () => (val: unknown) => import("@apple/cktool.core").ValidatedNEA;
};
};
/**
* @hidden
* @internal
* @privateRemarks
* A map of HTTP response codes
* to expected failure responses.
*/
readonly failureResponses: {
readonly 421: {
readonly description: string;
readonly contentType: "application/json";
readonly getDecoderFn: () => (val: unknown) => import("@apple/cktool.core").ValidatedNEA;
};
readonly 0: {
readonly description: string;
readonly contentType: "application/json";
readonly getDecoderFn: () => (val: unknown) => import("@apple/cktool.core").ValidatedNEA;
};
};
/**
* @internal
*/
readonly security: readonly [readonly ["CookieAuth"], readonly ["UserTokenAuth"], readonly ["CloudKitAPITokenAuth"], readonly ["CloudKitAPITokenAuth", "CloudKitWebAuthTokenAuth"]];
};
/****************************************************************************************
*/
declare const getParamsValidatorForCreateAssetUploadUrl: () => (obj: T) => import("@apple/cktool.core").ValidatedNEA & {
body: {
readonly recordType: string;
readonly fieldName: string;
readonly size: import("@apple/cktool.core").Int64 | undefined;
};
environment: CKEnvironment;
zoneName: string;
containerId: string;
databaseType: string;
} & {}>;
declare type CreateAssetUploadUrlParamsValidator = ReturnType;
/**
* @hidden
* @internal
* @privateRemarks
* Constants for the operation that must be declared
* before use in the public operation object.
*/
declare const createAssetUploadUrlOpConsts: {
/**
* @hidden
* @internal
* @privateRemarks
* The validator used to validate the
* parameters passed to the stream function
* of this operation.
*/
readonly getParamsValidator: () => (obj: T) => import("@apple/cktool.core").ValidatedNEA & {
body: {
readonly recordType: string;
readonly fieldName: string;
readonly size: import("@apple/cktool.core").Int64 | undefined;
};
environment: CKEnvironment;
zoneName: string;
containerId: string;
databaseType: string;
} & {}>;
/**
* @hidden
* @internal
* @privateRemarks
* A map of HTTP response codes
* to expected success responses.
*/
readonly successResponses: {
readonly 201: {
readonly description: string;
readonly contentType: "application/json";
readonly getDecoderFn: () => (val: unknown) => import("@apple/cktool.core").ValidatedNEA;
};
};
/**
* @hidden
* @internal
* @privateRemarks
* A map of HTTP response codes
* to expected failure responses.
*/
readonly failureResponses: {
readonly 421: {
readonly description: string;
readonly contentType: "application/json";
readonly getDecoderFn: () => (val: unknown) => import("@apple/cktool.core").ValidatedNEA;
};
readonly 0: {
readonly description: string;
readonly contentType: "application/json";
readonly getDecoderFn: () => (val: unknown) => import("@apple/cktool.core").ValidatedNEA;
};
};
/**
* @internal
*/
readonly security: readonly [readonly ["CookieAuth"], readonly ["UserTokenAuth"], readonly ["CloudKitAPITokenAuth"], readonly ["CloudKitAPITokenAuth", "CloudKitWebAuthTokenAuth"]];
};
export declare type CreateAssetUploadUrlSecurity = {
[Security.SCHEME_KEY_CookieAuth]: string;
} | {
[Security.SCHEME_KEY_UserTokenAuth]: string;
} | {
[Security.SCHEME_KEY_CloudKitAPITokenAuth]: string;
} | {
[Security.SCHEME_KEY_CloudKitAPITokenAuth]: string;
[Security.SCHEME_KEY_CloudKitWebAuthTokenAuth]: string;
};
/**
* @internal
*/
export declare type CreateAssetUploadUrlOpConsts = typeof createAssetUploadUrlOpConsts & {
successTypes: never | {
statusCode: 201;
description: string;
result: CKDBAssetUploadUrlResponse;
};
responseErrorTypes: never | DocumentedResponseError | DocumentedResponseError;
securityTypes: CreateAssetUploadUrlSecurity;
};
/**
* Parameters type for createAssetUploadUrl.
*/
export interface CreateAssetUploadUrlParams {
/**
* Details of the request to create an asset upload URL.
*/
body: CKDBCreateAssetUploadUrlRequestBody;
/**
* The container identifier. See `Container`.
*/
containerId: string;
/**
* The container environment. For valid values, see `CKEnvironment`.
*/
environment: CKEnvironment;
/**
* The database type. For valid values, see `CKDatabaseType`.
*/
databaseType: string;
/**
* The zone name. See `CKDBZone`.
*/
zoneName: string;
}
export interface CreateAssetUploadUrlOpOptions extends ApiOperationOptionsBase {
security?: CreateAssetUploadUrlSecurity;
}
/**
* @internal
*
* 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.
* API operation: createAssetUploadUrl
* API version: 1.3.2
*/
export declare const createAssetUploadUrlOp: {
/**
* @hidden
* @internal
* @privateRemarks
* The unique name of this operation, which corresponds
* to the OpenAPI specification from which this object
* was generated.
*/
readonly name: "createAssetUploadUrl";
/**
* @hidden
* @internal
* @privateRemarks
* The HTTP method this operation uses when making a
* request to the server.
* @internal
*/
readonly httpMethod: "POST";
/**
* @hidden
* @internal
* @privateRemarks
* The RESTful server path this operation uses when
* making a request to the server.
* @internal
*/
readonly path: "/v1/database/containers/{containerId}/environments/{environment}/databases/{databaseType}/zones/{zoneName}/assetUploadUrls";
/**
* @hidden
* @internal
*/
readonly requestBodyContentTypes: readonly ["application/json"];
/**
* @hidden
* @internal
*/
readonly multipartParams: readonly [];
/**
* @hidden
* @internal
*
* 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.
*
* This function validates the parameters passed in
* before communicating with the server.
* If the parameters fail the check, the callbag
* source will end with an error.
*
* API operation: createAssetUploadUrl
* API version: 1.3.2
*
* @param options.configuration - The configuration object.
* @param options.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.
* @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`.
*
* @returns A pullable callbag source
* that yields expected success responses.
* For more information on callbags, see the
* (standard)[https://github.com/callbag/callbag].
* See {@link createAssetUploadUrlOp.responseDictionary} for
* expected responses. Responses in the 2xx range will
* be considered success responses and will be sent
* in the stream. Other responses will cause the
* stream to end with an error condition.
*/
readonly $: (options: CreateAssetUploadUrlOpOptions, params: CreateAssetUploadUrlParams) => Source;
/**
* @hidden
* @internal
*
* 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.
*
* This function does not validate the parameters passed in.
*
* @param options.configuration - The configuration object.
* @param options.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.
* @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`.
*
* @returns A pullable callbag source
* that yields expected success responses.
* For more information on callbags, see the
* (standard)[https://github.com/callbag/callbag].
* See {@link createAssetUploadUrlOp.responseDictionary} for
* expected responses. Responses in the 2xx range will
* be considered success responses and will be sent
* in the stream. Other responses will cause the
* stream to end with an error condition.
*/
readonly unchecked$: (options: CreateAssetUploadUrlOpOptions, params: ValueFromValidator) => Source;
/**
* @hidden
* @internal
* @privateRemarks
* Indicates whether or not this operation is
* expected to change server state.
*/
readonly isMutating: true;
/**
* @hidden
* @internal
* @privateRemarks
* A map of HTTP response codes to expected responses.
*/
readonly responseDictionary: {
readonly 421: {
readonly description: string;
readonly contentType: "application/json";
readonly getDecoderFn: () => (val: unknown) => import("@apple/cktool.core").ValidatedNEA;
};
readonly 0: {
readonly description: string;
readonly contentType: "application/json";
readonly getDecoderFn: () => (val: unknown) => import("@apple/cktool.core").ValidatedNEA;
};
readonly 201: {
readonly description: string;
readonly contentType: "application/json";
readonly getDecoderFn: () => (val: unknown) => import("@apple/cktool.core").ValidatedNEA;
};
};
/**
* @hidden
* @internal
* @privateRemarks
* The validator used to validate the
* parameters passed to the stream function
* of this operation.
*/
readonly getParamsValidator: () => (obj: T) => import("@apple/cktool.core").ValidatedNEA & {
body: {
readonly recordType: string;
readonly fieldName: string;
readonly size: import("@apple/cktool.core").Int64 | undefined;
};
environment: CKEnvironment;
zoneName: string;
containerId: string;
databaseType: string;
} & {}>;
/**
* @hidden
* @internal
* @privateRemarks
* A map of HTTP response codes
* to expected success responses.
*/
readonly successResponses: {
readonly 201: {
readonly description: string;
readonly contentType: "application/json";
readonly getDecoderFn: () => (val: unknown) => import("@apple/cktool.core").ValidatedNEA;
};
};
/**
* @hidden
* @internal
* @privateRemarks
* A map of HTTP response codes
* to expected failure responses.
*/
readonly failureResponses: {
readonly 421: {
readonly description: string;
readonly contentType: "application/json";
readonly getDecoderFn: () => (val: unknown) => import("@apple/cktool.core").ValidatedNEA;
};
readonly 0: {
readonly description: string;
readonly contentType: "application/json";
readonly getDecoderFn: () => (val: unknown) => import("@apple/cktool.core").ValidatedNEA;
};
};
/**
* @internal
*/
readonly security: readonly [readonly ["CookieAuth"], readonly ["UserTokenAuth"], readonly ["CloudKitAPITokenAuth"], readonly ["CloudKitAPITokenAuth", "CloudKitWebAuthTokenAuth"]];
};
/****************************************************************************************
*/
declare const getParamsValidatorForCreateRecord: () => (obj: T) => import("@apple/cktool.core").ValidatedNEA & {
body: {
readonly fields: Record;
readonly share: {
readonly zone: {
readonly zoneName: string;
readonly canonicalName: string;
readonly zoneType: string | undefined;
readonly ownerRecordName: string | undefined;
} | undefined;
readonly action: import("../models/CKDBRecordReferenceAction").CKDBRecordReferenceAction | undefined;
readonly recordName: string | undefined;
} | undefined;
readonly parent: {
readonly zone: {
readonly zoneName: string;
readonly canonicalName: string;
readonly zoneType: string | undefined;
readonly ownerRecordName: string | undefined;
} | undefined;
readonly action: import("../models/CKDBRecordReferenceAction").CKDBRecordReferenceAction | undefined;
readonly recordName: string | undefined;
} | undefined;
readonly forRecord: {
readonly recordName: string;
readonly recordChangeTag: string;
} | undefined;
readonly publicPermission: import("../models/CKDBPermissionType").CKDBPermissionType | undefined;
readonly participants: {
readonly userIdentity: {
readonly nameComponents: {
readonly givenName: string | undefined;
readonly middleName: string | undefined;
readonly familyName: string | undefined;
readonly namePrefix: string | undefined;
readonly nameSuffix: string | undefined;
readonly nickname: string | undefined;
readonly phoneticRepresentation: string | undefined;
} | undefined;
readonly lookupInfo: {
readonly userRecordName: string | undefined;
readonly emailAddress: string | undefined;
readonly phoneNumber: string | undefined;
} | undefined;
readonly userRecordName: string | undefined;
};
readonly type: import("../models/CKDBShareParticipantType").CKDBShareParticipantType | undefined;
readonly acceptanceStatus: import("../models/CKDBShareAcceptanceStatus").CKDBShareAcceptanceStatus | undefined;
readonly permission: import("../models/CKDBPermissionType").CKDBPermissionType | undefined;
readonly participantId: string | undefined;
}[] | undefined;
readonly recordName: string | undefined;
readonly recordType: string;
readonly createShortGuid: boolean | undefined;
};
environment: CKEnvironment;
zoneName: string;
containerId: string;
databaseType: string;
} & {}>;
declare type CreateRecordParamsValidator = ReturnType;
/**
* @hidden
* @internal
* @privateRemarks
* Constants for the operation that must be declared
* before use in the public operation object.
*/
declare const createRecordOpConsts: {
/**
* @hidden
* @internal
* @privateRemarks
* The validator used to validate the
* parameters passed to the stream function
* of this operation.
*/
readonly getParamsValidator: () => (obj: T) => import("@apple/cktool.core").ValidatedNEA & {
body: {
readonly fields: Record;
readonly share: {
readonly zone: {
readonly zoneName: string;
readonly canonicalName: string;
readonly zoneType: string | undefined;
readonly ownerRecordName: string | undefined;
} | undefined;
readonly action: import("../models/CKDBRecordReferenceAction").CKDBRecordReferenceAction | undefined;
readonly recordName: string | undefined;
} | undefined;
readonly parent: {
readonly zone: {
readonly zoneName: string;
readonly canonicalName: string;
readonly zoneType: string | undefined;
readonly ownerRecordName: string | undefined;
} | undefined;
readonly action: import("../models/CKDBRecordReferenceAction").CKDBRecordReferenceAction | undefined;
readonly recordName: string | undefined;
} | undefined;
readonly forRecord: {
readonly recordName: string;
readonly recordChangeTag: string;
} | undefined;
readonly publicPermission: import("../models/CKDBPermissionType").CKDBPermissionType | undefined;
readonly participants: {
readonly userIdentity: {
readonly nameComponents: {
readonly givenName: string | undefined;
readonly middleName: string | undefined;
readonly familyName: string | undefined;
readonly namePrefix: string | undefined;
readonly nameSuffix: string | undefined;
readonly nickname: string | undefined;
readonly phoneticRepresentation: string | undefined;
} | undefined;
readonly lookupInfo: {
readonly userRecordName: string | undefined;
readonly emailAddress: string | undefined;
readonly phoneNumber: string | undefined;
} | undefined;
readonly userRecordName: string | undefined;
};
readonly type: import("../models/CKDBShareParticipantType").CKDBShareParticipantType | undefined;
readonly acceptanceStatus: import("../models/CKDBShareAcceptanceStatus").CKDBShareAcceptanceStatus | undefined;
readonly permission: import("../models/CKDBPermissionType").CKDBPermissionType | undefined;
readonly participantId: string | undefined;
}[] | undefined;
readonly recordName: string | undefined;
readonly recordType: string;
readonly createShortGuid: boolean | undefined;
};
environment: CKEnvironment;
zoneName: string;
containerId: string;
databaseType: string;
} & {}>;
/**
* @hidden
* @internal
* @privateRemarks
* A map of HTTP response codes
* to expected success responses.
*/
readonly successResponses: {
readonly 201: {
readonly description: string;
readonly contentType: "application/json";
readonly getDecoderFn: () => (val: unknown) => import("@apple/cktool.core").ValidatedNEA;
};
};
/**
* @hidden
* @internal
* @privateRemarks
* A map of HTTP response codes
* to expected failure responses.
*/
readonly failureResponses: {
readonly 421: {
readonly description: string;
readonly contentType: "application/json";
readonly getDecoderFn: () => (val: unknown) => import("@apple/cktool.core").ValidatedNEA;
};
readonly 0: {
readonly description: string;
readonly contentType: "application/json";
readonly getDecoderFn: () => (val: unknown) => import("@apple/cktool.core").ValidatedNEA;
};
};
/**
* @internal
*/
readonly security: readonly [readonly ["CookieAuth"], readonly ["UserTokenAuth"], readonly ["CloudKitAPITokenAuth"], readonly ["CloudKitAPITokenAuth", "CloudKitWebAuthTokenAuth"]];
};
export declare type CreateRecordSecurity = {
[Security.SCHEME_KEY_CookieAuth]: string;
} | {
[Security.SCHEME_KEY_UserTokenAuth]: string;
} | {
[Security.SCHEME_KEY_CloudKitAPITokenAuth]: string;
} | {
[Security.SCHEME_KEY_CloudKitAPITokenAuth]: string;
[Security.SCHEME_KEY_CloudKitWebAuthTokenAuth]: string;
};
/**
* @internal
*/
export declare type CreateRecordOpConsts = typeof createRecordOpConsts & {
successTypes: never | {
statusCode: 201;
description: string;
result: CKDBRecordResponse;
};
responseErrorTypes: never | DocumentedResponseError | DocumentedResponseError;
securityTypes: CreateRecordSecurity;
};
/**
* Parameters type for createRecord.
*/
export interface CreateRecordParams {
/**
* New record details.
*/
body: CKDBCreateRecordRequestBody;
/**
* The container identifier. See `Container`.
*/
containerId: string;
/**
* The container environment. For valid values, see `CKEnvironment`.
*/
environment: CKEnvironment;
/**
* The database type. For valid values, see `CKDatabaseType`.
*/
databaseType: string;
/**
* The zone name. See `CKDBZone`.
*/
zoneName: string;
}
export interface CreateRecordOpOptions extends ApiOperationOptionsBase {
security?: CreateRecordSecurity;
}
/**
* @internal
*
* 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.
* API operation: createRecord
* API version: 1.3.2
*/
export declare const createRecordOp: {
/**
* @hidden
* @internal
* @privateRemarks
* The unique name of this operation, which corresponds
* to the OpenAPI specification from which this object
* was generated.
*/
readonly name: "createRecord";
/**
* @hidden
* @internal
* @privateRemarks
* The HTTP method this operation uses when making a
* request to the server.
* @internal
*/
readonly httpMethod: "POST";
/**
* @hidden
* @internal
* @privateRemarks
* The RESTful server path this operation uses when
* making a request to the server.
* @internal
*/
readonly path: "/v1/database/containers/{containerId}/environments/{environment}/databases/{databaseType}/zones/{zoneName}/records";
/**
* @hidden
* @internal
*/
readonly requestBodyContentTypes: readonly ["application/json"];
/**
* @hidden
* @internal
*/
readonly multipartParams: readonly [];
/**
* @hidden
* @internal
*
* 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.
*
* This function validates the parameters passed in
* before communicating with the server.
* If the parameters fail the check, the callbag
* source will end with an error.
*
* API operation: createRecord
* API version: 1.3.2
*
* @param options.configuration - The configuration object.
* @param options.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.
* @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`.
*
* @returns A pullable callbag source
* that yields expected success responses.
* For more information on callbags, see the
* (standard)[https://github.com/callbag/callbag].
* See {@link createRecordOp.responseDictionary} for
* expected responses. Responses in the 2xx range will
* be considered success responses and will be sent
* in the stream. Other responses will cause the
* stream to end with an error condition.
*/
readonly $: (options: CreateRecordOpOptions, params: CreateRecordParams) => Source;
/**
* @hidden
* @internal
*
* 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.
*
* This function does not validate the parameters passed in.
*
* @param options.configuration - The configuration object.
* @param options.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.
* @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`.
*
* @returns A pullable callbag source
* that yields expected success responses.
* For more information on callbags, see the
* (standard)[https://github.com/callbag/callbag].
* See {@link createRecordOp.responseDictionary} for
* expected responses. Responses in the 2xx range will
* be considered success responses and will be sent
* in the stream. Other responses will cause the
* stream to end with an error condition.
*/
readonly unchecked$: (options: CreateRecordOpOptions, params: ValueFromValidator) => Source;
/**
* @hidden
* @internal
* @privateRemarks
* Indicates whether or not this operation is
* expected to change server state.
*/
readonly isMutating: true;
/**
* @hidden
* @internal
* @privateRemarks
* A map of HTTP response codes to expected responses.
*/
readonly responseDictionary: {
readonly 421: {
readonly description: string;
readonly contentType: "application/json";
readonly getDecoderFn: () => (val: unknown) => import("@apple/cktool.core").ValidatedNEA;
};
readonly 0: {
readonly description: string;
readonly contentType: "application/json";
readonly getDecoderFn: () => (val: unknown) => import("@apple/cktool.core").ValidatedNEA;
};
readonly 201: {
readonly description: string;
readonly contentType: "application/json";
readonly getDecoderFn: () => (val: unknown) => import("@apple/cktool.core").ValidatedNEA;
};
};
/**
* @hidden
* @internal
* @privateRemarks
* The validator used to validate the
* parameters passed to the stream function
* of this operation.
*/
readonly getParamsValidator: () => (obj: T) => import("@apple/cktool.core").ValidatedNEA & {
body: {
readonly fields: Record;
readonly share: {
readonly zone: {
readonly zoneName: string;
readonly canonicalName: string;
readonly zoneType: string | undefined;
readonly ownerRecordName: string | undefined;
} | undefined;
readonly action: import("../models/CKDBRecordReferenceAction").CKDBRecordReferenceAction | undefined;
readonly recordName: string | undefined;
} | undefined;
readonly parent: {
readonly zone: {
readonly zoneName: string;
readonly canonicalName: string;
readonly zoneType: string | undefined;
readonly ownerRecordName: string | undefined;
} | undefined;
readonly action: import("../models/CKDBRecordReferenceAction").CKDBRecordReferenceAction | undefined;
readonly recordName: string | undefined;
} | undefined;
readonly forRecord: {
readonly recordName: string;
readonly recordChangeTag: string;
} | undefined;
readonly publicPermission: import("../models/CKDBPermissionType").CKDBPermissionType | undefined;
readonly participants: {
readonly userIdentity: {
readonly nameComponents: {
readonly givenName: string | undefined;
readonly middleName: string | undefined;
readonly familyName: string | undefined;
readonly namePrefix: string | undefined;
readonly nameSuffix: string | undefined;
readonly nickname: string | undefined;
readonly phoneticRepresentation: string | undefined;
} | undefined;
readonly lookupInfo: {
readonly userRecordName: string | undefined;
readonly emailAddress: string | undefined;
readonly phoneNumber: string | undefined;
} | undefined;
readonly userRecordName: string | undefined;
};
readonly type: import("../models/CKDBShareParticipantType").CKDBShareParticipantType | undefined;
readonly acceptanceStatus: import("../models/CKDBShareAcceptanceStatus").CKDBShareAcceptanceStatus | undefined;
readonly permission: import("../models/CKDBPermissionType").CKDBPermissionType | undefined;
readonly participantId: string | undefined;
}[] | undefined;
readonly recordName: string | undefined;
readonly recordType: string;
readonly createShortGuid: boolean | undefined;
};
environment: CKEnvironment;
zoneName: string;
containerId: string;
databaseType: string;
} & {}>;
/**
* @hidden
* @internal
* @privateRemarks
* A map of HTTP response codes
* to expected success responses.
*/
readonly successResponses: {
readonly 201: {
readonly description: string;
readonly contentType: "application/json";
readonly getDecoderFn: () => (val: unknown) => import("@apple/cktool.core").ValidatedNEA;
};
};
/**
* @hidden
* @internal
* @privateRemarks
* A map of HTTP response codes
* to expected failure responses.
*/
readonly failureResponses: {
readonly 421: {
readonly description: string;
readonly contentType: "application/json";
readonly getDecoderFn: () => (val: unknown) => import("@apple/cktool.core").ValidatedNEA;
};
readonly 0: {
readonly description: string;
readonly contentType: "application/json";
readonly getDecoderFn: () => (val: unknown) => import("@apple/cktool.core").ValidatedNEA;
};
};
/**
* @internal
*/
readonly security: readonly [readonly ["CookieAuth"], readonly ["UserTokenAuth"], readonly ["CloudKitAPITokenAuth"], readonly ["CloudKitAPITokenAuth", "CloudKitWebAuthTokenAuth"]];
};
/****************************************************************************************
*/
declare const getParamsValidatorForCreateZone: () => (obj: T) => import("@apple/cktool.core").ValidatedNEA & {
body: {
readonly zoneName: string;
readonly zoneType: string | undefined;
};
environment: CKEnvironment;
containerId: string;
databaseType: string;
} & {}>;
declare type CreateZoneParamsValidator = ReturnType;
/**
* @hidden
* @internal
* @privateRemarks
* Constants for the operation that must be declared
* before use in the public operation object.
*/
declare const createZoneOpConsts: {
/**
* @hidden
* @internal
* @privateRemarks
* The validator used to validate the
* parameters passed to the stream function
* of this operation.
*/
readonly getParamsValidator: () => (obj: T) => import("@apple/cktool.core").ValidatedNEA & {
body: {
readonly zoneName: string;
readonly zoneType: string | undefined;
};
environment: CKEnvironment;
containerId: string;
databaseType: string;
} & {}>;
/**
* @hidden
* @internal
* @privateRemarks
* A map of HTTP response codes
* to expected success responses.
*/
readonly successResponses: {
readonly 201: {
readonly description: string;
readonly contentType: "application/json";
readonly getDecoderFn: () => (val: unknown) => import("@apple/cktool.core").ValidatedNEA;
};
};
/**
* @hidden
* @internal
* @privateRemarks
* A map of HTTP response codes
* to expected failure responses.
*/
readonly failureResponses: {
readonly 421: {
readonly description: string;
readonly contentType: "application/json";
readonly getDecoderFn: () => (val: unknown) => import("@apple/cktool.core").ValidatedNEA;
};
readonly 0: {
readonly description: string;
readonly contentType: "application/json";
readonly getDecoderFn: () => (val: unknown) => import("@apple/cktool.core").ValidatedNEA;
};
};
/**
* @internal
*/
readonly security: readonly [readonly ["CookieAuth"], readonly ["UserTokenAuth"], readonly ["CloudKitAPITokenAuth"], readonly ["CloudKitAPITokenAuth", "CloudKitWebAuthTokenAuth"]];
};
export declare type CreateZoneSecurity = {
[Security.SCHEME_KEY_CookieAuth]: string;
} | {
[Security.SCHEME_KEY_UserTokenAuth]: string;
} | {
[Security.SCHEME_KEY_CloudKitAPITokenAuth]: string;
} | {
[Security.SCHEME_KEY_CloudKitAPITokenAuth]: string;
[Security.SCHEME_KEY_CloudKitWebAuthTokenAuth]: string;
};
/**
* @internal
*/
export declare type CreateZoneOpConsts = typeof createZoneOpConsts & {
successTypes: never | {
statusCode: 201;
description: string;
result: CKDBZoneResponse;
};
responseErrorTypes: never | DocumentedResponseError | DocumentedResponseError;
securityTypes: CreateZoneSecurity;
};
/**
* Parameters type for createZone.
*/
export interface CreateZoneParams {
/**
* New zone details.
*/
body: CKDBCreateZoneRequestBody;
/**
* The container identifier. See `Container`.
*/
containerId: string;
/**
* The container environment. For valid values, see `CKEnvironment`.
*/
environment: CKEnvironment;
/**
* The database type. For valid values, see `CKDatabaseType`.
*/
databaseType: string;
}
export interface CreateZoneOpOptions extends ApiOperationOptionsBase {
security?: CreateZoneSecurity;
}
/**
* @internal
*
* Creates a new zone.
*
* If successful, the result contains a `CKDBZoneResponse` object with the created zone.
* API operation: createZone
* API version: 1.3.2
*/
export declare const createZoneOp: {
/**
* @hidden
* @internal
* @privateRemarks
* The unique name of this operation, which corresponds
* to the OpenAPI specification from which this object
* was generated.
*/
readonly name: "createZone";
/**
* @hidden
* @internal
* @privateRemarks
* The HTTP method this operation uses when making a
* request to the server.
* @internal
*/
readonly httpMethod: "POST";
/**
* @hidden
* @internal
* @privateRemarks
* The RESTful server path this operation uses when
* making a request to the server.
* @internal
*/
readonly path: "/v1/database/containers/{containerId}/environments/{environment}/databases/{databaseType}/zones";
/**
* @hidden
* @internal
*/
readonly requestBodyContentTypes: readonly ["application/json"];
/**
* @hidden
* @internal
*/
readonly multipartParams: readonly [];
/**
* @hidden
* @internal
*
* Creates a new zone.
*
* If successful, the result contains a `CKDBZoneResponse` object with the created zone.
*
* This function validates the parameters passed in
* before communicating with the server.
* If the parameters fail the check, the callbag
* source will end with an error.
*
* API operation: createZone
* API version: 1.3.2
*
* @param options.configuration - The configuration object.
* @param options.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.
* @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`.
*
* @returns A pullable callbag source
* that yields expected success responses.
* For more information on callbags, see the
* (standard)[https://github.com/callbag/callbag].
* See {@link createZoneOp.responseDictionary} for
* expected responses. Responses in the 2xx range will
* be considered success responses and will be sent
* in the stream. Other responses will cause the
* stream to end with an error condition.
*/
readonly $: (options: CreateZoneOpOptions, params: CreateZoneParams) => Source;
/**
* @hidden
* @internal
*
* Creates a new zone.
*
* If successful, the result contains a `CKDBZoneResponse` object with the created zone.
*
* This function does not validate the parameters passed in.
*
* @param options.configuration - The configuration object.
* @param options.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.
* @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`.
*
* @returns A pullable callbag source
* that yields expected success responses.
* For more information on callbags, see the
* (standard)[https://github.com/callbag/callbag].
* See {@link createZoneOp.responseDictionary} for
* expected responses. Responses in the 2xx range will
* be considered success responses and will be sent
* in the stream. Other responses will cause the
* stream to end with an error condition.
*/
readonly unchecked$: (options: CreateZoneOpOptions, params: ValueFromValidator) => Source;
/**
* @hidden
* @internal
* @privateRemarks
* Indicates whether or not this operation is
* expected to change server state.
*/
readonly isMutating: true;
/**
* @hidden
* @internal
* @privateRemarks
* A map of HTTP response codes to expected responses.
*/
readonly responseDictionary: {
readonly 421: {
readonly description: string;
readonly contentType: "application/json";
readonly getDecoderFn: () => (val: unknown) => import("@apple/cktool.core").ValidatedNEA;
};
readonly 0: {
readonly description: string;
readonly contentType: "application/json";
readonly getDecoderFn: () => (val: unknown) => import("@apple/cktool.core").ValidatedNEA;
};
readonly 201: {
readonly description: string;
readonly contentType: "application/json";
readonly getDecoderFn: () => (val: unknown) => import("@apple/cktool.core").ValidatedNEA;
};
};
/**
* @hidden
* @internal
* @privateRemarks
* The validator used to validate the
* parameters passed to the stream function
* of this operation.
*/
readonly getParamsValidator: () => (obj: T) => import("@apple/cktool.core").ValidatedNEA & {
body: {
readonly zoneName: string;
readonly zoneType: string | undefined;
};
environment: CKEnvironment;
containerId: string;
databaseType: string;
} & {}>;
/**
* @hidden
* @internal
* @privateRemarks
* A map of HTTP response codes
* to expected success responses.
*/
readonly successResponses: {
readonly 201: {
readonly description: string;
readonly contentType: "application/json";
readonly getDecoderFn: () => (val: unknown) => import("@apple/cktool.core").ValidatedNEA;
};
};
/**
* @hidden
* @internal
* @privateRemarks
* A map of HTTP response codes
* to expected failure responses.
*/
readonly failureResponses: {
readonly 421: {
readonly description: string;
readonly contentType: "application/json";
readonly getDecoderFn: () => (val: unknown) => import("@apple/cktool.core").ValidatedNEA;
};
readonly 0: {
readonly description: string;
readonly contentType: "application/json";
readonly getDecoderFn: () => (val: unknown) => import("@apple/cktool.core").ValidatedNEA;
};
};
/**
* @internal
*/
readonly security: readonly [readonly ["CookieAuth"], readonly ["UserTokenAuth"], readonly ["CloudKitAPITokenAuth"], readonly ["CloudKitAPITokenAuth", "CloudKitWebAuthTokenAuth"]];
};
/****************************************************************************************
*/
declare const getParamsValidatorForDeleteRecord: () => (obj: T) => import("@apple/cktool.core").ValidatedNEA & {
environment: CKEnvironment;
zoneName: string;
recordName: string;
containerId: string;
databaseType: string;
} & {}>;
declare type DeleteRecordParamsValidator = ReturnType;
/**
* @hidden
* @internal
* @privateRemarks
* Constants for the operation that must be declared
* before use in the public operation object.
*/
declare const deleteRecordOpConsts: {
/**
* @hidden
* @internal
* @privateRemarks
* The validator used to validate the
* parameters passed to the stream function
* of this operation.
*/
readonly getParamsValidator: () => (obj: T) => import("@apple/cktool.core").ValidatedNEA & {
environment: CKEnvironment;
zoneName: string;
recordName: string;
containerId: string;
databaseType: string;
} & {}>;
/**
* @hidden
* @internal
* @privateRemarks
* A map of HTTP response codes
* to expected success responses.
*/
readonly successResponses: {
readonly 204: {
readonly description: string;
};
};
/**
* @hidden
* @internal
* @privateRemarks
* A map of HTTP response codes
* to expected failure responses.
*/
readonly failureResponses: {
readonly 421: {
readonly description: string;
readonly contentType: "application/json";
readonly getDecoderFn: () => (val: unknown) => import("@apple/cktool.core").ValidatedNEA;
};
readonly 0: {
readonly description: string;
readonly contentType: "application/json";
readonly getDecoderFn: () => (val: unknown) => import("@apple/cktool.core").ValidatedNEA;
};
};
/**
* @internal
*/
readonly security: readonly [readonly ["CookieAuth"], readonly ["UserTokenAuth"], readonly ["CloudKitAPITokenAuth"], readonly ["CloudKitAPITokenAuth", "CloudKitWebAuthTokenAuth"]];
};
export declare type DeleteRecordSecurity = {
[Security.SCHEME_KEY_CookieAuth]: string;
} | {
[Security.SCHEME_KEY_UserTokenAuth]: string;
} | {
[Security.SCHEME_KEY_CloudKitAPITokenAuth]: string;
} | {
[Security.SCHEME_KEY_CloudKitAPITokenAuth]: string;
[Security.SCHEME_KEY_CloudKitWebAuthTokenAuth]: string;
};
/**
* @internal
*/
export declare type DeleteRecordOpConsts = typeof deleteRecordOpConsts & {
successTypes: never | {
statusCode: 204;
description: string;
};
responseErrorTypes: never | DocumentedResponseError | DocumentedResponseError;
securityTypes: DeleteRecordSecurity;
};
/**
* Parameters type for deleteRecord.
*/
export interface DeleteRecordParams {
/**
* The container identifier. See `Container`.
*/
containerId: string;
/**
* The container environment. For valid values, see `CKEnvironment`.
*/
environment: CKEnvironment;
/**
* The database type. For valid values, see `CKDatabaseType`.
*/
databaseType: string;
/**
* The zone name. See `CKDBZone`.
*/
zoneName: string;
/**
* The record name. See `CKDBRecord`.
*/
recordName: string;
}
export interface DeleteRecordOpOptions extends ApiOperationOptionsBase {
security?: DeleteRecordSecurity;
}
/**
* @internal
*
* Deletes a single record.
*
* If the operation completes successfully, the server returns a success response.
* API operation: deleteRecord
* API version: 1.3.2
*/
export declare const deleteRecordOp: {
/**
* @hidden
* @internal
* @privateRemarks
* The unique name of this operation, which corresponds
* to the OpenAPI specification from which this object
* was generated.
*/
readonly name: "deleteRecord";
/**
* @hidden
* @internal
* @privateRemarks
* The HTTP method this operation uses when making a
* request to the server.
* @internal
*/
readonly httpMethod: "DELETE";
/**
* @hidden
* @internal
* @privateRemarks
* The RESTful server path this operation uses when
* making a request to the server.
* @internal
*/
readonly path: "/v1/database/containers/{containerId}/environments/{environment}/databases/{databaseType}/zones/{zoneName}/records/{recordName}";
/**
* @hidden
* @internal
*/
readonly requestBodyContentTypes: readonly [];
/**
* @hidden
* @internal
*/
readonly multipartParams: readonly [];
/**
* @hidden
* @internal
*
* Deletes a single record.
*
* If the operation completes successfully, the server returns a success response.
*
* This function validates the parameters passed in
* before communicating with the server.
* If the parameters fail the check, the callbag
* source will end with an error.
*
* API operation: deleteRecord
* API version: 1.3.2
*
* @param options.configuration - The configuration object.
* @param options.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.
* @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`.
*
* @returns A pullable callbag source
* that yields expected success responses.
* For more information on callbags, see the
* (standard)[https://github.com/callbag/callbag].
* See {@link deleteRecordOp.responseDictionary} for
* expected responses. Responses in the 2xx range will
* be considered success responses and will be sent
* in the stream. Other responses will cause the
* stream to end with an error condition.
*/
readonly $: (options: DeleteRecordOpOptions, params: DeleteRecordParams) => Source;
/**
* @hidden
* @internal
*
* Deletes a single record.
*
* If the operation completes successfully, the server returns a success response.
*
* This function does not validate the parameters passed in.
*
* @param options.configuration - The configuration object.
* @param options.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.
* @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`.
*
* @returns A pullable callbag source
* that yields expected success responses.
* For more information on callbags, see the
* (standard)[https://github.com/callbag/callbag].
* See {@link deleteRecordOp.responseDictionary} for
* expected responses. Responses in the 2xx range will
* be considered success responses and will be sent
* in the stream. Other responses will cause the
* stream to end with an error condition.
*/
readonly unchecked$: (options: DeleteRecordOpOptions, params: ValueFromValidator) => Source;
/**
* @hidden
* @internal
* @privateRemarks
* Indicates whether or not this operation is
* expected to change server state.
*/
readonly isMutating: true;
/**
* @hidden
* @internal
* @privateRemarks
* A map of HTTP response codes to expected responses.
*/
readonly responseDictionary: {
readonly 421: {
readonly description: string;
readonly contentType: "application/json";
readonly getDecoderFn: () => (val: unknown) => import("@apple/cktool.core").ValidatedNEA;
};
readonly 0: {
readonly description: string;
readonly contentType: "application/json";
readonly getDecoderFn: () => (val: unknown) => import("@apple/cktool.core").ValidatedNEA;
};
readonly 204: {
readonly description: string;
};
};
/**
* @hidden
* @internal
* @privateRemarks
* The validator used to validate the
* parameters passed to the stream function
* of this operation.
*/
readonly getParamsValidator: () => (obj: T) => import("@apple/cktool.core").ValidatedNEA & {
environment: CKEnvironment;
zoneName: string;
recordName: string;
containerId: string;
databaseType: string;
} & {}>;
/**
* @hidden
* @internal
* @privateRemarks
* A map of HTTP response codes
* to expected success responses.
*/
readonly successResponses: {
readonly 204: {
readonly description: string;
};
};
/**
* @hidden
* @internal
* @privateRemarks
* A map of HTTP response codes
* to expected failure responses.
*/
readonly failureResponses: {
readonly 421: {
readonly description: string;
readonly contentType: "application/json";
readonly getDecoderFn: () => (val: unknown) => import("@apple/cktool.core").ValidatedNEA;
};
readonly 0: {
readonly description: string;
readonly contentType: "application/json";
readonly getDecoderFn: () => (val: unknown) => import("@apple/cktool.core").ValidatedNEA;
};
};
/**
* @internal
*/
readonly security: readonly [readonly ["CookieAuth"], readonly ["UserTokenAuth"], readonly ["CloudKitAPITokenAuth"], readonly ["CloudKitAPITokenAuth", "CloudKitWebAuthTokenAuth"]];
};
/****************************************************************************************
*/
declare const getParamsValidatorForDeleteRecordsByQuery: () => (obj: T) => import("@apple/cktool.core").ValidatedNEA & {
body: {
readonly filters: {
readonly fieldValue: unknown;
readonly type: import("../models/CKDBQueryFilterType").CKDBQueryFilterType;
readonly fieldName: string | undefined;
readonly radiusInKilometers: import("@apple/cktool.core").Double | undefined;
}[] | undefined;
readonly dryRun: boolean | undefined;
readonly recordType: string;
readonly resultsLimit: import("@apple/cktool.core").Int32 | undefined;
readonly continuationToken: string | undefined;
};
environment: CKEnvironment;
zoneName: string;
containerId: string;
databaseType: string;
} & {}>;
declare type DeleteRecordsByQueryParamsValidator = ReturnType;
/**
* @hidden
* @internal
* @privateRemarks
* Constants for the operation that must be declared
* before use in the public operation object.
*/
declare const deleteRecordsByQueryOpConsts: {
/**
* @hidden
* @internal
* @privateRemarks
* The validator used to validate the
* parameters passed to the stream function
* of this operation.
*/
readonly getParamsValidator: () => (obj: T) => import("@apple/cktool.core").ValidatedNEA & {
body: {
readonly filters: {
readonly fieldValue: unknown;
readonly type: import("../models/CKDBQueryFilterType").CKDBQueryFilterType;
readonly fieldName: string | undefined;
readonly radiusInKilometers: import("@apple/cktool.core").Double | undefined;
}[] | undefined;
readonly dryRun: boolean | undefined;
readonly recordType: string;
readonly resultsLimit: import("@apple/cktool.core").Int32 | undefined;
readonly continuationToken: string | undefined;
};
environment: CKEnvironment;
zoneName: string;
containerId: string;
databaseType: string;
} & {}>;
/**
* @hidden
* @internal
* @privateRemarks
* A map of HTTP response codes
* to expected success responses.
*/
readonly successResponses: {
readonly 200: {
readonly description: string;
readonly contentType: "application/json";
readonly getDecoderFn: () => (val: unknown) => import("@apple/cktool.core").ValidatedNEA;
};
};
/**
* @hidden
* @internal
* @privateRemarks
* A map of HTTP response codes
* to expected failure responses.
*/
readonly failureResponses: {
readonly 421: {
readonly description: string;
readonly contentType: "application/json";
readonly getDecoderFn: () => (val: unknown) => import("@apple/cktool.core").ValidatedNEA;
};
readonly 0: {
readonly description: string;
readonly contentType: "application/json";
readonly getDecoderFn: () => (val: unknown) => import("@apple/cktool.core").ValidatedNEA;
};
};
/**
* @internal
*/
readonly security: readonly [readonly ["CookieAuth"], readonly ["UserTokenAuth"], readonly ["CloudKitAPITokenAuth"], readonly ["CloudKitAPITokenAuth", "CloudKitWebAuthTokenAuth"]];
};
export declare type DeleteRecordsByQuerySecurity = {
[Security.SCHEME_KEY_CookieAuth]: string;
} | {
[Security.SCHEME_KEY_UserTokenAuth]: string;
} | {
[Security.SCHEME_KEY_CloudKitAPITokenAuth]: string;
} | {
[Security.SCHEME_KEY_CloudKitAPITokenAuth]: string;
[Security.SCHEME_KEY_CloudKitWebAuthTokenAuth]: string;
};
/**
* @internal
*/
export declare type DeleteRecordsByQueryOpConsts = typeof deleteRecordsByQueryOpConsts & {
successTypes: never | {
statusCode: 200;
description: string;
result: CKDBPagedBatchDeleteResponse;
};
responseErrorTypes: never | DocumentedResponseError | DocumentedResponseError;
securityTypes: DeleteRecordsByQuerySecurity;
};
/**
* Parameters type for deleteRecordsByQuery.
*/
export interface DeleteRecordsByQueryParams {
/**
* Query and other options for the delete records operation.
*/
body: CKDBDeleteRecordsByQueryRequestBody;
/**
* The container identifier. See `Container`.
*/
containerId: string;
/**
* The container environment. For valid values, see `CKEnvironment`.
*/
environment: CKEnvironment;
/**
* The database type. For valid values, see `CKDatabaseType`.
*/
databaseType: string;
/**
* The zone name. See `CKDBZone`.
*/
zoneName: string;
}
export interface DeleteRecordsByQueryOpOptions extends ApiOperationOptionsBase {
security?: DeleteRecordsByQuerySecurity;
}
/**
* @internal
*
* 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.
* API operation: deleteRecordsByQuery
* API version: 1.3.2
*/
export declare const deleteRecordsByQueryOp: {
/**
* @hidden
* @internal
* @privateRemarks
* The unique name of this operation, which corresponds
* to the OpenAPI specification from which this object
* was generated.
*/
readonly name: "deleteRecordsByQuery";
/**
* @hidden
* @internal
* @privateRemarks
* The HTTP method this operation uses when making a
* request to the server.
* @internal
*/
readonly httpMethod: "POST";
/**
* @hidden
* @internal
* @privateRemarks
* The RESTful server path this operation uses when
* making a request to the server.
* @internal
*/
readonly path: "/v1/database/containers/{containerId}/environments/{environment}/databases/{databaseType}/zones/{zoneName}/deletionQuery";
/**
* @hidden
* @internal
*/
readonly requestBodyContentTypes: readonly ["application/json"];
/**
* @hidden
* @internal
*/
readonly multipartParams: readonly [];
/**
* @hidden
* @internal
*
* 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.
*
* This function validates the parameters passed in
* before communicating with the server.
* If the parameters fail the check, the callbag
* source will end with an error.
*
* API operation: deleteRecordsByQuery
* API version: 1.3.2
*
* @param options.configuration - The configuration object.
* @param options.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.
* @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`.
*
* @returns A pullable callbag source
* that yields expected success responses.
* For more information on callbags, see the
* (standard)[https://github.com/callbag/callbag].
* See {@link deleteRecordsByQueryOp.responseDictionary} for
* expected responses. Responses in the 2xx range will
* be considered success responses and will be sent
* in the stream. Other responses will cause the
* stream to end with an error condition.
*/
readonly $: (options: DeleteRecordsByQueryOpOptions, params: DeleteRecordsByQueryParams) => Source;
/**
* @hidden
* @internal
*
* 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.
*
* This function does not validate the parameters passed in.
*
* @param options.configuration - The configuration object.
* @param options.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.
* @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`.
*
* @returns A pullable callbag source
* that yields expected success responses.
* For more information on callbags, see the
* (standard)[https://github.com/callbag/callbag].
* See {@link deleteRecordsByQueryOp.responseDictionary} for
* expected responses. Responses in the 2xx range will
* be considered success responses and will be sent
* in the stream. Other responses will cause the
* stream to end with an error condition.
*/
readonly unchecked$: (options: DeleteRecordsByQueryOpOptions, params: ValueFromValidator) => Source;
/**
* @hidden
* @internal
* @privateRemarks
* Indicates whether or not this operation is
* expected to change server state.
*/
readonly isMutating: true;
/**
* @hidden
* @internal
* @privateRemarks
* A map of HTTP response codes to expected responses.
*/
readonly responseDictionary: {
readonly 421: {
readonly description: string;
readonly contentType: "application/json";
readonly getDecoderFn: () => (val: unknown) => import("@apple/cktool.core").ValidatedNEA;
};
readonly 0: {
readonly description: string;
readonly contentType: "application/json";
readonly getDecoderFn: () => (val: unknown) => import("@apple/cktool.core").ValidatedNEA;
};
readonly 200: {
readonly description: string;
readonly contentType: "application/json";
readonly getDecoderFn: () => (val: unknown) => import("@apple/cktool.core").ValidatedNEA;
};
};
/**
* @hidden
* @internal
* @privateRemarks
* The validator used to validate the
* parameters passed to the stream function
* of this operation.
*/
readonly getParamsValidator: () => (obj: T) => import("@apple/cktool.core").ValidatedNEA & {
body: {
readonly filters: {
readonly fieldValue: unknown;
readonly type: import("../models/CKDBQueryFilterType").CKDBQueryFilterType;
readonly fieldName: string | undefined;
readonly radiusInKilometers: import("@apple/cktool.core").Double | undefined;
}[] | undefined;
readonly dryRun: boolean | undefined;
readonly recordType: string;
readonly resultsLimit: import("@apple/cktool.core").Int32 | undefined;
readonly continuationToken: string | undefined;
};
environment: CKEnvironment;
zoneName: string;
containerId: string;
databaseType: string;
} & {}>;
/**
* @hidden
* @internal
* @privateRemarks
* A map of HTTP response codes
* to expected success responses.
*/
readonly successResponses: {
readonly 200: {
readonly description: string;
readonly contentType: "application/json";
readonly getDecoderFn: () => (val: unknown) => import("@apple/cktool.core").ValidatedNEA;
};
};
/**
* @hidden
* @internal
* @privateRemarks
* A map of HTTP response codes
* to expected failure responses.
*/
readonly failureResponses: {
readonly 421: {
readonly description: string;
readonly contentType: "application/json";
readonly getDecoderFn: () => (val: unknown) => import("@apple/cktool.core").ValidatedNEA;
};
readonly 0: {
readonly description: string;
readonly contentType: "application/json";
readonly getDecoderFn: () => (val: unknown) => import("@apple/cktool.core").ValidatedNEA;
};
};
/**
* @internal
*/
readonly security: readonly [readonly ["CookieAuth"], readonly ["UserTokenAuth"], readonly ["CloudKitAPITokenAuth"], readonly ["CloudKitAPITokenAuth", "CloudKitWebAuthTokenAuth"]];
};
/****************************************************************************************
*/
declare const getParamsValidatorForDeleteZone: () => (obj: T) => import("@apple/cktool.core").ValidatedNEA & {
environment: CKEnvironment;
zoneName: string;
containerId: string;
databaseType: string;
} & {}>;
declare type DeleteZoneParamsValidator = ReturnType;
/**
* @hidden
* @internal
* @privateRemarks
* Constants for the operation that must be declared
* before use in the public operation object.
*/
declare const deleteZoneOpConsts: {
/**
* @hidden
* @internal
* @privateRemarks
* The validator used to validate the
* parameters passed to the stream function
* of this operation.
*/
readonly getParamsValidator: () => (obj: T) => import("@apple/cktool.core").ValidatedNEA & {
environment: CKEnvironment;
zoneName: string;
containerId: string;
databaseType: string;
} & {}>;
/**
* @hidden
* @internal
* @privateRemarks
* A map of HTTP response codes
* to expected success responses.
*/
readonly successResponses: {
readonly 204: {
readonly description: string;
};
};
/**
* @hidden
* @internal
* @privateRemarks
* A map of HTTP response codes
* to expected failure responses.
*/
readonly failureResponses: {
readonly 421: {
readonly description: string;
readonly contentType: "application/json";
readonly getDecoderFn: () => (val: unknown) => import("@apple/cktool.core").ValidatedNEA;
};
readonly 0: {
readonly description: string;
readonly contentType: "application/json";
readonly getDecoderFn: () => (val: unknown) => import("@apple/cktool.core").ValidatedNEA;
};
};
/**
* @internal
*/
readonly security: readonly [readonly ["CookieAuth"], readonly ["UserTokenAuth"], readonly ["CloudKitAPITokenAuth"], readonly ["CloudKitAPITokenAuth", "CloudKitWebAuthTokenAuth"]];
};
export declare type DeleteZoneSecurity = {
[Security.SCHEME_KEY_CookieAuth]: string;
} | {
[Security.SCHEME_KEY_UserTokenAuth]: string;
} | {
[Security.SCHEME_KEY_CloudKitAPITokenAuth]: string;
} | {
[Security.SCHEME_KEY_CloudKitAPITokenAuth]: string;
[Security.SCHEME_KEY_CloudKitWebAuthTokenAuth]: string;
};
/**
* @internal
*/
export declare type DeleteZoneOpConsts = typeof deleteZoneOpConsts & {
successTypes: never | {
statusCode: 204;
description: string;
};
responseErrorTypes: never | DocumentedResponseError | DocumentedResponseError;
securityTypes: DeleteZoneSecurity;
};
/**
* Parameters type for deleteZone.
*/
export interface DeleteZoneParams {
/**
* The container identifier. See `Container`.
*/
containerId: string;
/**
* The container environment. For valid values, see `CKEnvironment`.
*/
environment: CKEnvironment;
/**
* The database type. For valid values, see `CKDatabaseType`.
*/
databaseType: string;
/**
* The zone name. See `CKDBZone`.
*/
zoneName: string;
}
export interface DeleteZoneOpOptions extends ApiOperationOptionsBase {
security?: DeleteZoneSecurity;
}
/**
* @internal
*
* Deletes a zone.
*
* If the operation completes successfully, the server returns a success response.
* API operation: deleteZone
* API version: 1.3.2
*/
export declare const deleteZoneOp: {
/**
* @hidden
* @internal
* @privateRemarks
* The unique name of this operation, which corresponds
* to the OpenAPI specification from which this object
* was generated.
*/
readonly name: "deleteZone";
/**
* @hidden
* @internal
* @privateRemarks
* The HTTP method this operation uses when making a
* request to the server.
* @internal
*/
readonly httpMethod: "DELETE";
/**
* @hidden
* @internal
* @privateRemarks
* The RESTful server path this operation uses when
* making a request to the server.
* @internal
*/
readonly path: "/v1/database/containers/{containerId}/environments/{environment}/databases/{databaseType}/zones/{zoneName}";
/**
* @hidden
* @internal
*/
readonly requestBodyContentTypes: readonly [];
/**
* @hidden
* @internal
*/
readonly multipartParams: readonly [];
/**
* @hidden
* @internal
*
* Deletes a zone.
*
* If the operation completes successfully, the server returns a success response.
*
* This function validates the parameters passed in
* before communicating with the server.
* If the parameters fail the check, the callbag
* source will end with an error.
*
* API operation: deleteZone
* API version: 1.3.2
*
* @param options.configuration - The configuration object.
* @param options.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.
* @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`.
*
* @returns A pullable callbag source
* that yields expected success responses.
* For more information on callbags, see the
* (standard)[https://github.com/callbag/callbag].
* See {@link deleteZoneOp.responseDictionary} for
* expected responses. Responses in the 2xx range will
* be considered success responses and will be sent
* in the stream. Other responses will cause the
* stream to end with an error condition.
*/
readonly $: (options: DeleteZoneOpOptions, params: DeleteZoneParams) => Source;
/**
* @hidden
* @internal
*
* Deletes a zone.
*
* If the operation completes successfully, the server returns a success response.
*
* This function does not validate the parameters passed in.
*
* @param options.configuration - The configuration object.
* @param options.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.
* @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`.
*
* @returns A pullable callbag source
* that yields expected success responses.
* For more information on callbags, see the
* (standard)[https://github.com/callbag/callbag].
* See {@link deleteZoneOp.responseDictionary} for
* expected responses. Responses in the 2xx range will
* be considered success responses and will be sent
* in the stream. Other responses will cause the
* stream to end with an error condition.
*/
readonly unchecked$: (options: DeleteZoneOpOptions, params: ValueFromValidator) => Source;
/**
* @hidden
* @internal
* @privateRemarks
* Indicates whether or not this operation is
* expected to change server state.
*/
readonly isMutating: true;
/**
* @hidden
* @internal
* @privateRemarks
* A map of HTTP response codes to expected responses.
*/
readonly responseDictionary: {
readonly 421: {
readonly description: string;
readonly contentType: "application/json";
readonly getDecoderFn: () => (val: unknown) => import("@apple/cktool.core").ValidatedNEA;
};
readonly 0: {
readonly description: string;
readonly contentType: "application/json";
readonly getDecoderFn: () => (val: unknown) => import("@apple/cktool.core").ValidatedNEA;
};
readonly 204: {
readonly description: string;
};
};
/**
* @hidden
* @internal
* @privateRemarks
* The validator used to validate the
* parameters passed to the stream function
* of this operation.
*/
readonly getParamsValidator: () => (obj: T) => import("@apple/cktool.core").ValidatedNEA & {
environment: CKEnvironment;
zoneName: string;
containerId: string;
databaseType: string;
} & {}>;
/**
* @hidden
* @internal
* @privateRemarks
* A map of HTTP response codes
* to expected success responses.
*/
readonly successResponses: {
readonly 204: {
readonly description: string;
};
};
/**
* @hidden
* @internal
* @privateRemarks
* A map of HTTP response codes
* to expected failure responses.
*/
readonly failureResponses: {
readonly 421: {
readonly description: string;
readonly contentType: "application/json";
readonly getDecoderFn: () => (val: unknown) => import("@apple/cktool.core").ValidatedNEA;
};
readonly 0: {
readonly description: string;
readonly contentType: "application/json";
readonly getDecoderFn: () => (val: unknown) => import("@apple/cktool.core").ValidatedNEA;
};
};
/**
* @internal
*/
readonly security: readonly [readonly ["CookieAuth"], readonly ["UserTokenAuth"], readonly ["CloudKitAPITokenAuth"], readonly ["CloudKitAPITokenAuth", "CloudKitWebAuthTokenAuth"]];
};
/****************************************************************************************
*/
declare const getParamsValidatorForExportSchema: () => (obj: T) => import("@apple/cktool.core").ValidatedNEA & {
environment: CKEnvironment;
teamId: string;
containerId: string;
} & {}>;
declare type ExportSchemaParamsValidator = ReturnType;
/**
* @hidden
* @internal
* @privateRemarks
* Constants for the operation that must be declared
* before use in the public operation object.
*/
declare const exportSchemaOpConsts: {
/**
* @hidden
* @internal
* @privateRemarks
* The validator used to validate the
* parameters passed to the stream function
* of this operation.
*/
readonly getParamsValidator: () => (obj: T) => import("@apple/cktool.core").ValidatedNEA & {
environment: CKEnvironment;
teamId: string;
containerId: string;
} & {}>;
/**
* @hidden
* @internal
* @privateRemarks
* A map of HTTP response codes
* to expected success responses.
*/
readonly successResponses: {
readonly 200: {
readonly description: string;
readonly contentType: "text/plain";
};
};
/**
* @hidden
* @internal
* @privateRemarks
* A map of HTTP response codes
* to expected failure responses.
*/
readonly failureResponses: {
readonly 0: {
readonly description: string;
readonly contentType: "application/json";
readonly getDecoderFn: () => (val: unknown) => import("@apple/cktool.core").ValidatedNEA;
};
};
/**
* @internal
*/
readonly security: readonly [readonly ["CookieAuth"], readonly ["ManagementTokenAuth"]];
};
export declare type ExportSchemaSecurity = {
[Security.SCHEME_KEY_CookieAuth]: string;
} | {
[Security.SCHEME_KEY_ManagementTokenAuth]: string;
};
/**
* @internal
*/
export declare type ExportSchemaOpConsts = typeof exportSchemaOpConsts & {
successTypes: never | {
statusCode: 200;
description: string;
result: Blob;
};
responseErrorTypes: never | DocumentedResponseError;
securityTypes: ExportSchemaSecurity;
};
/**
* Parameters type for exportSchema.
*/
export interface ExportSchemaParams {
/**
* The team identifier. You can find your team identifier in the Membership tab of the Apple Developer portal at `https://developer.apple.com`.
*/
teamId: string;
/**
* The container identifier. See `Container`.
*/
containerId: string;
/**
* The container environment. For valid values, see `CKEnvironment`.
*/
environment: CKEnvironment;
}
export interface ExportSchemaOpOptions extends ApiOperationOptionsBase {
security?: ExportSchemaSecurity;
}
/**
* @internal
*
* 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`.
* API operation: exportSchema
* API version: 1.3.2
*/
export declare const exportSchemaOp: {
/**
* @hidden
* @internal
* @privateRemarks
* The unique name of this operation, which corresponds
* to the OpenAPI specification from which this object
* was generated.
*/
readonly name: "exportSchema";
/**
* @hidden
* @internal
* @privateRemarks
* The HTTP method this operation uses when making a
* request to the server.
* @internal
*/
readonly httpMethod: "GET";
/**
* @hidden
* @internal
* @privateRemarks
* The RESTful server path this operation uses when
* making a request to the server.
* @internal
*/
readonly path: "/v1/database/teams/{teamId}/containers/{containerId}/environments/{environment}/schema/export";
/**
* @hidden
* @internal
*/
readonly requestBodyContentTypes: readonly [];
/**
* @hidden
* @internal
*/
readonly multipartParams: readonly [];
/**
* @hidden
* @internal
*
* 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`.
*
* This function validates the parameters passed in
* before communicating with the server.
* If the parameters fail the check, the callbag
* source will end with an error.
*
* API operation: exportSchema
* API version: 1.3.2
*
* @param options.configuration - The configuration object.
* @param options.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.
* @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`.
*
* @returns A pullable callbag source
* that yields expected success responses.
* For more information on callbags, see the
* (standard)[https://github.com/callbag/callbag].
* See {@link exportSchemaOp.responseDictionary} for
* expected responses. Responses in the 2xx range will
* be considered success responses and will be sent
* in the stream. Other responses will cause the
* stream to end with an error condition.
*/
readonly $: (options: ExportSchemaOpOptions, params: ExportSchemaParams) => Source;
/**
* @hidden
* @internal
*
* 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`.
*
* This function does not validate the parameters passed in.
*
* @param options.configuration - The configuration object.
* @param options.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.
* @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`.
*
* @returns A pullable callbag source
* that yields expected success responses.
* For more information on callbags, see the
* (standard)[https://github.com/callbag/callbag].
* See {@link exportSchemaOp.responseDictionary} for
* expected responses. Responses in the 2xx range will
* be considered success responses and will be sent
* in the stream. Other responses will cause the
* stream to end with an error condition.
*/
readonly unchecked$: (options: ExportSchemaOpOptions, params: ValueFromValidator) => Source;
/**
* @hidden
* @internal
* @privateRemarks
* Indicates whether or not this operation is
* expected to change server state.
*/
readonly isMutating: false;
/**
* @hidden
* @internal
* @privateRemarks
* Calculate a unique key suitable for use in caching
* based on the parameters passed in.
*/
readonly cacheKeyFn: ({ teamId, containerId, environment, }: ValueFromValidator) => string;
/**
* @hidden
* @internal
* @privateRemarks
* A map of HTTP response codes to expected responses.
*/
readonly responseDictionary: {
readonly 0: {
readonly description: string;
readonly contentType: "application/json";
readonly getDecoderFn: () => (val: unknown) => import("@apple/cktool.core").ValidatedNEA;
};
readonly 200: {
readonly description: string;
readonly contentType: "text/plain";
};
};
/**
* @hidden
* @internal
* @privateRemarks
* The validator used to validate the
* parameters passed to the stream function
* of this operation.
*/
readonly getParamsValidator: () => (obj: T) => import("@apple/cktool.core").ValidatedNEA & {
environment: CKEnvironment;
teamId: string;
containerId: string;
} & {}>;
/**
* @hidden
* @internal
* @privateRemarks
* A map of HTTP response codes
* to expected success responses.
*/
readonly successResponses: {
readonly 200: {
readonly description: string;
readonly contentType: "text/plain";
};
};
/**
* @hidden
* @internal
* @privateRemarks
* A map of HTTP response codes
* to expected failure responses.
*/
readonly failureResponses: {
readonly 0: {
readonly description: string;
readonly contentType: "application/json";
readonly getDecoderFn: () => (val: unknown) => import("@apple/cktool.core").ValidatedNEA;
};
};
/**
* @internal
*/
readonly security: readonly [readonly ["CookieAuth"], readonly ["ManagementTokenAuth"]];
};
/****************************************************************************************
*/
declare const getParamsValidatorForGetRecord: () => (obj: T) => import("@apple/cktool.core").ValidatedNEA & {
environment: CKEnvironment;
zoneName: string;
recordName: string;
containerId: string;
databaseType: string;
} & {
requestedFields?: string[] | undefined;
}>;
declare type GetRecordParamsValidator = ReturnType;
/**
* @hidden
* @internal
* @privateRemarks
* Constants for the operation that must be declared
* before use in the public operation object.
*/
declare const getRecordOpConsts: {
/**
* @hidden
* @internal
* @privateRemarks
* The validator used to validate the
* parameters passed to the stream function
* of this operation.
*/
readonly getParamsValidator: () => (obj: T) => import("@apple/cktool.core").ValidatedNEA & {
environment: CKEnvironment;
zoneName: string;
recordName: string;
containerId: string;
databaseType: string;
} & {
requestedFields?: string[] | undefined;
}>;
/**
* @hidden
* @internal
* @privateRemarks
* A map of HTTP response codes
* to expected success responses.
*/
readonly successResponses: {
readonly 200: {
readonly description: string;
readonly contentType: "application/json";
readonly getDecoderFn: () => (val: unknown) => import("@apple/cktool.core").ValidatedNEA;
};
};
/**
* @hidden
* @internal
* @privateRemarks
* A map of HTTP response codes
* to expected failure responses.
*/
readonly failureResponses: {
readonly 421: {
readonly description: string;
readonly contentType: "application/json";
readonly getDecoderFn: () => (val: unknown) => import("@apple/cktool.core").ValidatedNEA;
};
readonly 0: {
readonly description: string;
readonly contentType: "application/json";
readonly getDecoderFn: () => (val: unknown) => import("@apple/cktool.core").ValidatedNEA;
};
};
/**
* @internal
*/
readonly security: readonly [readonly ["CookieAuth"], readonly ["UserTokenAuth"], readonly ["CloudKitAPITokenAuth"], readonly ["CloudKitAPITokenAuth", "CloudKitWebAuthTokenAuth"]];
};
export declare type GetRecordSecurity = {
[Security.SCHEME_KEY_CookieAuth]: string;
} | {
[Security.SCHEME_KEY_UserTokenAuth]: string;
} | {
[Security.SCHEME_KEY_CloudKitAPITokenAuth]: string;
} | {
[Security.SCHEME_KEY_CloudKitAPITokenAuth]: string;
[Security.SCHEME_KEY_CloudKitWebAuthTokenAuth]: string;
};
/**
* @internal
*/
export declare type GetRecordOpConsts = typeof getRecordOpConsts & {
successTypes: never | {
statusCode: 200;
description: string;
result: CKDBRecordResponse;
};
responseErrorTypes: never | DocumentedResponseError | DocumentedResponseError;
securityTypes: GetRecordSecurity;
};
/**
* Parameters type for getRecord.
*/
export interface GetRecordParams {
/**
* The container identifier. See `Container`.
*/
containerId: string;
/**
* The container environment. For valid values, see `CKEnvironment`.
*/
environment: CKEnvironment;
/**
* The database type. For valid values, see `CKDatabaseType`.
*/
databaseType: string;
/**
* The zone name. See `CKDBZone`.
*/
zoneName: string;
/**
* The record name. See `CKDBRecord`.
*/
recordName: string;
/**
* 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.
*/
requestedFields?: string[];
}
export interface GetRecordOpOptions extends ApiOperationOptionsBase {
security?: GetRecordSecurity;
}
/**
* @internal
*
* 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.
* API operation: getRecord
* API version: 1.3.2
*/
export declare const getRecordOp: {
/**
* @hidden
* @internal
* @privateRemarks
* The unique name of this operation, which corresponds
* to the OpenAPI specification from which this object
* was generated.
*/
readonly name: "getRecord";
/**
* @hidden
* @internal
* @privateRemarks
* The HTTP method this operation uses when making a
* request to the server.
* @internal
*/
readonly httpMethod: "GET";
/**
* @hidden
* @internal
* @privateRemarks
* The RESTful server path this operation uses when
* making a request to the server.
* @internal
*/
readonly path: "/v1/database/containers/{containerId}/environments/{environment}/databases/{databaseType}/zones/{zoneName}/records/{recordName}";
/**
* @hidden
* @internal
*/
readonly requestBodyContentTypes: readonly [];
/**
* @hidden
* @internal
*/
readonly multipartParams: readonly [];
/**
* @hidden
* @internal
*
* 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.
*
* This function validates the parameters passed in
* before communicating with the server.
* If the parameters fail the check, the callbag
* source will end with an error.
*
* API operation: getRecord
* API version: 1.3.2
*
* @param options.configuration - The configuration object.
* @param options.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.
* @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.
*
* @returns A pullable callbag source
* that yields expected success responses.
* For more information on callbags, see the
* (standard)[https://github.com/callbag/callbag].
* See {@link getRecordOp.responseDictionary} for
* expected responses. Responses in the 2xx range will
* be considered success responses and will be sent
* in the stream. Other responses will cause the
* stream to end with an error condition.
*/
readonly $: (options: GetRecordOpOptions, params: GetRecordParams) => Source;
/**
* @hidden
* @internal
*
* 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.
*
* This function does not validate the parameters passed in.
*
* @param options.configuration - The configuration object.
* @param options.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.
* @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.
*
* @returns A pullable callbag source
* that yields expected success responses.
* For more information on callbags, see the
* (standard)[https://github.com/callbag/callbag].
* See {@link getRecordOp.responseDictionary} for
* expected responses. Responses in the 2xx range will
* be considered success responses and will be sent
* in the stream. Other responses will cause the
* stream to end with an error condition.
*/
readonly unchecked$: (options: GetRecordOpOptions, params: ValueFromValidator) => Source;
/**
* @hidden
* @internal
* @privateRemarks
* Indicates whether or not this operation is
* expected to change server state.
*/
readonly isMutating: false;
/**
* @hidden
* @internal
* @privateRemarks
* Calculate a unique key suitable for use in caching
* based on the parameters passed in.
*/
readonly cacheKeyFn: ({ containerId, environment, databaseType, zoneName, recordName, requestedFields, }: ValueFromValidator) => string;
/**
* @hidden
* @internal
* @privateRemarks
* A map of HTTP response codes to expected responses.
*/
readonly responseDictionary: {
readonly 421: {
readonly description: string;
readonly contentType: "application/json";
readonly getDecoderFn: () => (val: unknown) => import("@apple/cktool.core").ValidatedNEA;
};
readonly 0: {
readonly description: string;
readonly contentType: "application/json";
readonly getDecoderFn: () => (val: unknown) => import("@apple/cktool.core").ValidatedNEA;
};
readonly 200: {
readonly description: string;
readonly contentType: "application/json";
readonly getDecoderFn: () => (val: unknown) => import("@apple/cktool.core").ValidatedNEA;
};
};
/**
* @hidden
* @internal
* @privateRemarks
* The validator used to validate the
* parameters passed to the stream function
* of this operation.
*/
readonly getParamsValidator: () => (obj: T) => import("@apple/cktool.core").ValidatedNEA & {
environment: CKEnvironment;
zoneName: string;
recordName: string;
containerId: string;
databaseType: string;
} & {
requestedFields?: string[] | undefined;
}>;
/**
* @hidden
* @internal
* @privateRemarks
* A map of HTTP response codes
* to expected success responses.
*/
readonly successResponses: {
readonly 200: {
readonly description: string;
readonly contentType: "application/json";
readonly getDecoderFn: () => (val: unknown) => import("@apple/cktool.core").ValidatedNEA;
};
};
/**
* @hidden
* @internal
* @privateRemarks
* A map of HTTP response codes
* to expected failure responses.
*/
readonly failureResponses: {
readonly 421: {
readonly description: string;
readonly contentType: "application/json";
readonly getDecoderFn: () => (val: unknown) => import("@apple/cktool.core").ValidatedNEA;
};
readonly 0: {
readonly description: string;
readonly contentType: "application/json";
readonly getDecoderFn: () => (val: unknown) => import("@apple/cktool.core").ValidatedNEA;
};
};
/**
* @internal
*/
readonly security: readonly [readonly ["CookieAuth"], readonly ["UserTokenAuth"], readonly ["CloudKitAPITokenAuth"], readonly ["CloudKitAPITokenAuth", "CloudKitWebAuthTokenAuth"]];
};
/****************************************************************************************
*/
declare const getParamsValidatorForGetSessionUser: () => (obj: T) => import("@apple/cktool.core").ValidatedNEA & {
environment: CKEnvironment;
containerId: string;
} & {}>;
declare type GetSessionUserParamsValidator = ReturnType;
/**
* @hidden
* @internal
* @privateRemarks
* Constants for the operation that must be declared
* before use in the public operation object.
*/
declare const getSessionUserOpConsts: {
/**
* @hidden
* @internal
* @privateRemarks
* The validator used to validate the
* parameters passed to the stream function
* of this operation.
*/
readonly getParamsValidator: () => (obj: T) => import("@apple/cktool.core").ValidatedNEA & {
environment: CKEnvironment;
containerId: string;
} & {}>;
/**
* @hidden
* @internal
* @privateRemarks
* A map of HTTP response codes
* to expected success responses.
*/
readonly successResponses: {
readonly 200: {
readonly description: string;
readonly contentType: "application/json";
readonly getDecoderFn: () => (val: unknown) => import("@apple/cktool.core").ValidatedNEA;
};
};
/**
* @hidden
* @internal
* @privateRemarks
* A map of HTTP response codes
* to expected failure responses.
*/
readonly failureResponses: {
readonly 421: {
readonly description: string;
readonly contentType: "application/json";
readonly getDecoderFn: () => (val: unknown) => import("@apple/cktool.core").ValidatedNEA;
};
readonly 0: {
readonly description: string;
readonly contentType: "application/json";
readonly getDecoderFn: () => (val: unknown) => import("@apple/cktool.core").ValidatedNEA;
};
};
/**
* @internal
*/
readonly security: readonly [readonly ["CloudKitAPITokenAuth"], readonly ["CloudKitAPITokenAuth", "CloudKitWebAuthTokenAuth"]];
};
export declare type GetSessionUserSecurity = {
[Security.SCHEME_KEY_CloudKitAPITokenAuth]: string;
} | {
[Security.SCHEME_KEY_CloudKitAPITokenAuth]: string;
[Security.SCHEME_KEY_CloudKitWebAuthTokenAuth]: string;
};
/**
* @internal
*/
export declare type GetSessionUserOpConsts = typeof getSessionUserOpConsts & {
successTypes: never | {
statusCode: 200;
description: string;
result: CKDBSessionUserResponse;
};
responseErrorTypes: never | DocumentedResponseError | DocumentedResponseError;
securityTypes: GetSessionUserSecurity;
};
/**
* Parameters type for getSessionUser.
*/
export interface GetSessionUserParams {
/**
* The container identifier. See `Container`.
*/
containerId: string;
/**
* The container environment. For valid values, see `CKEnvironment`.
*/
environment: CKEnvironment;
}
export interface GetSessionUserOpOptions extends ApiOperationOptionsBase {
security?: GetSessionUserSecurity;
}
/**
* @internal
*
* 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.
* API operation: getSessionUser
* API version: 1.3.2
*/
export declare const getSessionUserOp: {
/**
* @hidden
* @internal
* @privateRemarks
* The unique name of this operation, which corresponds
* to the OpenAPI specification from which this object
* was generated.
*/
readonly name: "getSessionUser";
/**
* @hidden
* @internal
* @privateRemarks
* The HTTP method this operation uses when making a
* request to the server.
* @internal
*/
readonly httpMethod: "GET";
/**
* @hidden
* @internal
* @privateRemarks
* The RESTful server path this operation uses when
* making a request to the server.
* @internal
*/
readonly path: "/v1/database/containers/{containerId}/environments/{environment}/session/user";
/**
* @hidden
* @internal
*/
readonly requestBodyContentTypes: readonly [];
/**
* @hidden
* @internal
*/
readonly multipartParams: readonly [];
/**
* @hidden
* @internal
*
* 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.
*
* This function validates the parameters passed in
* before communicating with the server.
* If the parameters fail the check, the callbag
* source will end with an error.
*
* API operation: getSessionUser
* API version: 1.3.2
*
* @param options.configuration - The configuration object.
* @param options.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.
* @param params.containerId - The container identifier. See `Container`.
* @param params.environment - The container environment. For valid values, see `CKEnvironment`.
*
* @returns A pullable callbag source
* that yields expected success responses.
* For more information on callbags, see the
* (standard)[https://github.com/callbag/callbag].
* See {@link getSessionUserOp.responseDictionary} for
* expected responses. Responses in the 2xx range will
* be considered success responses and will be sent
* in the stream. Other responses will cause the
* stream to end with an error condition.
*/
readonly $: (options: GetSessionUserOpOptions, params: GetSessionUserParams) => Source;
/**
* @hidden
* @internal
*
* 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.
*
* This function does not validate the parameters passed in.
*
* @param options.configuration - The configuration object.
* @param options.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.
* @param params.containerId - The container identifier. See `Container`.
* @param params.environment - The container environment. For valid values, see `CKEnvironment`.
*
* @returns A pullable callbag source
* that yields expected success responses.
* For more information on callbags, see the
* (standard)[https://github.com/callbag/callbag].
* See {@link getSessionUserOp.responseDictionary} for
* expected responses. Responses in the 2xx range will
* be considered success responses and will be sent
* in the stream. Other responses will cause the
* stream to end with an error condition.
*/
readonly unchecked$: (options: GetSessionUserOpOptions, params: ValueFromValidator) => Source;
/**
* @hidden
* @internal
* @privateRemarks
* Indicates whether or not this operation is
* expected to change server state.
*/
readonly isMutating: false;
/**
* @hidden
* @internal
* @privateRemarks
* Calculate a unique key suitable for use in caching
* based on the parameters passed in.
*/
readonly cacheKeyFn: ({ containerId, environment, }: ValueFromValidator) => string;
/**
* @hidden
* @internal
* @privateRemarks
* A map of HTTP response codes to expected responses.
*/
readonly responseDictionary: {
readonly 421: {
readonly description: string;
readonly contentType: "application/json";
readonly getDecoderFn: () => (val: unknown) => import("@apple/cktool.core").ValidatedNEA;
};
readonly 0: {
readonly description: string;
readonly contentType: "application/json";
readonly getDecoderFn: () => (val: unknown) => import("@apple/cktool.core").ValidatedNEA;
};
readonly 200: {
readonly description: string;
readonly contentType: "application/json";
readonly getDecoderFn: () => (val: unknown) => import("@apple/cktool.core").ValidatedNEA;
};
};
/**
* @hidden
* @internal
* @privateRemarks
* The validator used to validate the
* parameters passed to the stream function
* of this operation.
*/
readonly getParamsValidator: () => (obj: T) => import("@apple/cktool.core").ValidatedNEA & {
environment: CKEnvironment;
containerId: string;
} & {}>;
/**
* @hidden
* @internal
* @privateRemarks
* A map of HTTP response codes
* to expected success responses.
*/
readonly successResponses: {
readonly 200: {
readonly description: string;
readonly contentType: "application/json";
readonly getDecoderFn: () => (val: unknown) => import("@apple/cktool.core").ValidatedNEA;
};
};
/**
* @hidden
* @internal
* @privateRemarks
* A map of HTTP response codes
* to expected failure responses.
*/
readonly failureResponses: {
readonly 421: {
readonly description: string;
readonly contentType: "application/json";
readonly getDecoderFn: () => (val: unknown) => import("@apple/cktool.core").ValidatedNEA;
};
readonly 0: {
readonly description: string;
readonly contentType: "application/json";
readonly getDecoderFn: () => (val: unknown) => import("@apple/cktool.core").ValidatedNEA;
};
};
/**
* @internal
*/
readonly security: readonly [readonly ["CloudKitAPITokenAuth"], readonly ["CloudKitAPITokenAuth", "CloudKitWebAuthTokenAuth"]];
};
/****************************************************************************************
*/
declare const getParamsValidatorForGetZone: () => (obj: T) => import("@apple/cktool.core").ValidatedNEA & {
environment: CKEnvironment;
zoneName: string;
containerId: string;
databaseType: string;
} & {}>;
declare type GetZoneParamsValidator = ReturnType;
/**
* @hidden
* @internal
* @privateRemarks
* Constants for the operation that must be declared
* before use in the public operation object.
*/
declare const getZoneOpConsts: {
/**
* @hidden
* @internal
* @privateRemarks
* The validator used to validate the
* parameters passed to the stream function
* of this operation.
*/
readonly getParamsValidator: () => (obj: T) => import("@apple/cktool.core").ValidatedNEA & {
environment: CKEnvironment;
zoneName: string;
containerId: string;
databaseType: string;
} & {}>;
/**
* @hidden
* @internal
* @privateRemarks
* A map of HTTP response codes
* to expected success responses.
*/
readonly successResponses: {
readonly 200: {
readonly description: string;
readonly contentType: "application/json";
readonly getDecoderFn: () => (val: unknown) => import("@apple/cktool.core").ValidatedNEA;
};
};
/**
* @hidden
* @internal
* @privateRemarks
* A map of HTTP response codes
* to expected failure responses.
*/
readonly failureResponses: {
readonly 421: {
readonly description: string;
readonly contentType: "application/json";
readonly getDecoderFn: () => (val: unknown) => import("@apple/cktool.core").ValidatedNEA;
};
readonly 0: {
readonly description: string;
readonly contentType: "application/json";
readonly getDecoderFn: () => (val: unknown) => import("@apple/cktool.core").ValidatedNEA;
};
};
/**
* @internal
*/
readonly security: readonly [readonly ["CookieAuth"], readonly ["UserTokenAuth"], readonly ["CloudKitAPITokenAuth"], readonly ["CloudKitAPITokenAuth", "CloudKitWebAuthTokenAuth"]];
};
export declare type GetZoneSecurity = {
[Security.SCHEME_KEY_CookieAuth]: string;
} | {
[Security.SCHEME_KEY_UserTokenAuth]: string;
} | {
[Security.SCHEME_KEY_CloudKitAPITokenAuth]: string;
} | {
[Security.SCHEME_KEY_CloudKitAPITokenAuth]: string;
[Security.SCHEME_KEY_CloudKitWebAuthTokenAuth]: string;
};
/**
* @internal
*/
export declare type GetZoneOpConsts = typeof getZoneOpConsts & {
successTypes: never | {
statusCode: 200;
description: string;
result: CKDBZoneResponse;
};
responseErrorTypes: never | DocumentedResponseError | DocumentedResponseError;
securityTypes: GetZoneSecurity;
};
/**
* Parameters type for getZone.
*/
export interface GetZoneParams {
/**
* The container identifier. See `Container`.
*/
containerId: string;
/**
* The container environment. For valid values, see `CKEnvironment`.
*/
environment: CKEnvironment;
/**
* The database type. For valid values, see `CKDatabaseType`.
*/
databaseType: string;
/**
* The zone name. See `CKDBZone`.
*/
zoneName: string;
}
export interface GetZoneOpOptions extends ApiOperationOptionsBase {
security?: GetZoneSecurity;
}
/**
* @internal
*
* Returns details for a zone.
*
* If successful, the result contains a `CKDBZoneResponse` object with the requested zone details.
* API operation: getZone
* API version: 1.3.2
*/
export declare const getZoneOp: {
/**
* @hidden
* @internal
* @privateRemarks
* The unique name of this operation, which corresponds
* to the OpenAPI specification from which this object
* was generated.
*/
readonly name: "getZone";
/**
* @hidden
* @internal
* @privateRemarks
* The HTTP method this operation uses when making a
* request to the server.
* @internal
*/
readonly httpMethod: "GET";
/**
* @hidden
* @internal
* @privateRemarks
* The RESTful server path this operation uses when
* making a request to the server.
* @internal
*/
readonly path: "/v1/database/containers/{containerId}/environments/{environment}/databases/{databaseType}/zones/{zoneName}";
/**
* @hidden
* @internal
*/
readonly requestBodyContentTypes: readonly [];
/**
* @hidden
* @internal
*/
readonly multipartParams: readonly [];
/**
* @hidden
* @internal
*
* Returns details for a zone.
*
* If successful, the result contains a `CKDBZoneResponse` object with the requested zone details.
*
* This function validates the parameters passed in
* before communicating with the server.
* If the parameters fail the check, the callbag
* source will end with an error.
*
* API operation: getZone
* API version: 1.3.2
*
* @param options.configuration - The configuration object.
* @param options.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.
* @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`.
*
* @returns A pullable callbag source
* that yields expected success responses.
* For more information on callbags, see the
* (standard)[https://github.com/callbag/callbag].
* See {@link getZoneOp.responseDictionary} for
* expected responses. Responses in the 2xx range will
* be considered success responses and will be sent
* in the stream. Other responses will cause the
* stream to end with an error condition.
*/
readonly $: (options: GetZoneOpOptions, params: GetZoneParams) => Source;
/**
* @hidden
* @internal
*
* Returns details for a zone.
*
* If successful, the result contains a `CKDBZoneResponse` object with the requested zone details.
*
* This function does not validate the parameters passed in.
*
* @param options.configuration - The configuration object.
* @param options.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.
* @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`.
*
* @returns A pullable callbag source
* that yields expected success responses.
* For more information on callbags, see the
* (standard)[https://github.com/callbag/callbag].
* See {@link getZoneOp.responseDictionary} for
* expected responses. Responses in the 2xx range will
* be considered success responses and will be sent
* in the stream. Other responses will cause the
* stream to end with an error condition.
*/
readonly unchecked$: (options: GetZoneOpOptions, params: ValueFromValidator) => Source;
/**
* @hidden
* @internal
* @privateRemarks
* Indicates whether or not this operation is
* expected to change server state.
*/
readonly isMutating: false;
/**
* @hidden
* @internal
* @privateRemarks
* Calculate a unique key suitable for use in caching
* based on the parameters passed in.
*/
readonly cacheKeyFn: ({ containerId, environment, databaseType, zoneName, }: ValueFromValidator) => string;
/**
* @hidden
* @internal
* @privateRemarks
* A map of HTTP response codes to expected responses.
*/
readonly responseDictionary: {
readonly 421: {
readonly description: string;
readonly contentType: "application/json";
readonly getDecoderFn: () => (val: unknown) => import("@apple/cktool.core").ValidatedNEA;
};
readonly 0: {
readonly description: string;
readonly contentType: "application/json";
readonly getDecoderFn: () => (val: unknown) => import("@apple/cktool.core").ValidatedNEA;
};
readonly 200: {
readonly description: string;
readonly contentType: "application/json";
readonly getDecoderFn: () => (val: unknown) => import("@apple/cktool.core").ValidatedNEA;
};
};
/**
* @hidden
* @internal
* @privateRemarks
* The validator used to validate the
* parameters passed to the stream function
* of this operation.
*/
readonly getParamsValidator: () => (obj: T) => import("@apple/cktool.core").ValidatedNEA & {
environment: CKEnvironment;
zoneName: string;
containerId: string;
databaseType: string;
} & {}>;
/**
* @hidden
* @internal
* @privateRemarks
* A map of HTTP response codes
* to expected success responses.
*/
readonly successResponses: {
readonly 200: {
readonly description: string;
readonly contentType: "application/json";
readonly getDecoderFn: () => (val: unknown) => import("@apple/cktool.core").ValidatedNEA;
};
};
/**
* @hidden
* @internal
* @privateRemarks
* A map of HTTP response codes
* to expected failure responses.
*/
readonly failureResponses: {
readonly 421: {
readonly description: string;
readonly contentType: "application/json";
readonly getDecoderFn: () => (val: unknown) => import("@apple/cktool.core").ValidatedNEA;
};
readonly 0: {
readonly description: string;
readonly contentType: "application/json";
readonly getDecoderFn: () => (val: unknown) => import("@apple/cktool.core").ValidatedNEA;
};
};
/**
* @internal
*/
readonly security: readonly [readonly ["CookieAuth"], readonly ["UserTokenAuth"], readonly ["CloudKitAPITokenAuth"], readonly ["CloudKitAPITokenAuth", "CloudKitWebAuthTokenAuth"]];
};
/****************************************************************************************
*/
declare const getParamsValidatorForGetZones: () => (obj: T) => import("@apple/cktool.core").ValidatedNEA & {
environment: CKEnvironment;
containerId: string;
databaseType: string;
} & {
continuationToken?: string | undefined;
}>;
declare type GetZonesParamsValidator = ReturnType;
/**
* @hidden
* @internal
* @privateRemarks
* Constants for the operation that must be declared
* before use in the public operation object.
*/
declare const getZonesOpConsts: {
/**
* @hidden
* @internal
* @privateRemarks
* The validator used to validate the
* parameters passed to the stream function
* of this operation.
*/
readonly getParamsValidator: () => (obj: T) => import("@apple/cktool.core").ValidatedNEA & {
environment: CKEnvironment;
containerId: string;
databaseType: string;
} & {
continuationToken?: string | undefined;
}>;
/**
* @hidden
* @internal
* @privateRemarks
* A map of HTTP response codes
* to expected success responses.
*/
readonly successResponses: {
readonly 200: {
readonly description: string;
readonly contentType: "application/json";
readonly getDecoderFn: () => (val: unknown) => import("@apple/cktool.core").ValidatedNEA;
};
};
/**
* @hidden
* @internal
* @privateRemarks
* A map of HTTP response codes
* to expected failure responses.
*/
readonly failureResponses: {
readonly 421: {
readonly description: string;
readonly contentType: "application/json";
readonly getDecoderFn: () => (val: unknown) => import("@apple/cktool.core").ValidatedNEA;
};
readonly 0: {
readonly description: string;
readonly contentType: "application/json";
readonly getDecoderFn: () => (val: unknown) => import("@apple/cktool.core").ValidatedNEA;
};
};
/**
* @internal
*/
readonly security: readonly [readonly ["CookieAuth"], readonly ["UserTokenAuth"], readonly ["CloudKitAPITokenAuth"], readonly ["CloudKitAPITokenAuth", "CloudKitWebAuthTokenAuth"]];
};
export declare type GetZonesSecurity = {
[Security.SCHEME_KEY_CookieAuth]: string;
} | {
[Security.SCHEME_KEY_UserTokenAuth]: string;
} | {
[Security.SCHEME_KEY_CloudKitAPITokenAuth]: string;
} | {
[Security.SCHEME_KEY_CloudKitAPITokenAuth]: string;
[Security.SCHEME_KEY_CloudKitWebAuthTokenAuth]: string;
};
/**
* @internal
*/
export declare type GetZonesOpConsts = typeof getZonesOpConsts & {
successTypes: never | {
statusCode: 200;
description: string;
result: CKDBZonesResponse;
};
responseErrorTypes: never | DocumentedResponseError | DocumentedResponseError;
securityTypes: GetZonesSecurity;
};
/**
* Parameters type for getZones.
*/
export interface GetZonesParams {
/**
* The container identifier. See `Container`.
*/
containerId: string;
/**
* The container environment. For valid values, see `CKEnvironment`.
*/
environment: CKEnvironment;
/**
* The database type. For valid values, see `CKDatabaseType`.
*/
databaseType: string;
/**
* 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.
*/
continuationToken?: string;
}
export interface GetZonesOpOptions extends ApiOperationOptionsBase {
security?: GetZonesSecurity;
}
/**
* @internal
*
* 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.
* API operation: getZones
* API version: 1.3.2
*/
export declare const getZonesOp: {
/**
* @hidden
* @internal
* @privateRemarks
* The unique name of this operation, which corresponds
* to the OpenAPI specification from which this object
* was generated.
*/
readonly name: "getZones";
/**
* @hidden
* @internal
* @privateRemarks
* The HTTP method this operation uses when making a
* request to the server.
* @internal
*/
readonly httpMethod: "GET";
/**
* @hidden
* @internal
* @privateRemarks
* The RESTful server path this operation uses when
* making a request to the server.
* @internal
*/
readonly path: "/v1/database/containers/{containerId}/environments/{environment}/databases/{databaseType}/zones";
/**
* @hidden
* @internal
*/
readonly requestBodyContentTypes: readonly [];
/**
* @hidden
* @internal
*/
readonly multipartParams: readonly [];
/**
* @hidden
* @internal
*
* 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.
*
* This function validates the parameters passed in
* before communicating with the server.
* If the parameters fail the check, the callbag
* source will end with an error.
*
* API operation: getZones
* API version: 1.3.2
*
* @param options.configuration - The configuration object.
* @param options.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.
* @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.
*
* @returns A pullable callbag source
* that yields expected success responses.
* For more information on callbags, see the
* (standard)[https://github.com/callbag/callbag].
* See {@link getZonesOp.responseDictionary} for
* expected responses. Responses in the 2xx range will
* be considered success responses and will be sent
* in the stream. Other responses will cause the
* stream to end with an error condition.
*/
readonly $: (options: GetZonesOpOptions, params: GetZonesParams) => Source;
/**
* @hidden
* @internal
*
* 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.
*
* This function does not validate the parameters passed in.
*
* @param options.configuration - The configuration object.
* @param options.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.
* @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.
*
* @returns A pullable callbag source
* that yields expected success responses.
* For more information on callbags, see the
* (standard)[https://github.com/callbag/callbag].
* See {@link getZonesOp.responseDictionary} for
* expected responses. Responses in the 2xx range will
* be considered success responses and will be sent
* in the stream. Other responses will cause the
* stream to end with an error condition.
*/
readonly unchecked$: (options: GetZonesOpOptions, params: ValueFromValidator) => Source;
/**
* @hidden
* @internal
* @privateRemarks
* Indicates whether or not this operation is
* expected to change server state.
*/
readonly isMutating: false;
/**
* @hidden
* @internal
* @privateRemarks
* Calculate a unique key suitable for use in caching
* based on the parameters passed in.
*/
readonly cacheKeyFn: ({ containerId, environment, databaseType, continuationToken, }: ValueFromValidator) => string;
/**
* @hidden
* @internal
* @privateRemarks
* A map of HTTP response codes to expected responses.
*/
readonly responseDictionary: {
readonly 421: {
readonly description: string;
readonly contentType: "application/json";
readonly getDecoderFn: () => (val: unknown) => import("@apple/cktool.core").ValidatedNEA;
};
readonly 0: {
readonly description: string;
readonly contentType: "application/json";
readonly getDecoderFn: () => (val: unknown) => import("@apple/cktool.core").ValidatedNEA;
};
readonly 200: {
readonly description: string;
readonly contentType: "application/json";
readonly getDecoderFn: () => (val: unknown) => import("@apple/cktool.core").ValidatedNEA;
};
};
/**
* @hidden
* @internal
* @privateRemarks
* The validator used to validate the
* parameters passed to the stream function
* of this operation.
*/
readonly getParamsValidator: () => (obj: T) => import("@apple/cktool.core").ValidatedNEA & {
environment: CKEnvironment;
containerId: string;
databaseType: string;
} & {
continuationToken?: string | undefined;
}>;
/**
* @hidden
* @internal
* @privateRemarks
* A map of HTTP response codes
* to expected success responses.
*/
readonly successResponses: {
readonly 200: {
readonly description: string;
readonly contentType: "application/json";
readonly getDecoderFn: () => (val: unknown) => import("@apple/cktool.core").ValidatedNEA;
};
};
/**
* @hidden
* @internal
* @privateRemarks
* A map of HTTP response codes
* to expected failure responses.
*/
readonly failureResponses: {
readonly 421: {
readonly description: string;
readonly contentType: "application/json";
readonly getDecoderFn: () => (val: unknown) => import("@apple/cktool.core").ValidatedNEA;
};
readonly 0: {
readonly description: string;
readonly contentType: "application/json";
readonly getDecoderFn: () => (val: unknown) => import("@apple/cktool.core").ValidatedNEA;
};
};
/**
* @internal
*/
readonly security: readonly [readonly ["CookieAuth"], readonly ["UserTokenAuth"], readonly ["CloudKitAPITokenAuth"], readonly ["CloudKitAPITokenAuth", "CloudKitWebAuthTokenAuth"]];
};
/****************************************************************************************
*/
declare const getParamsValidatorForImportSchema: () => (obj: T) => import("@apple/cktool.core").ValidatedNEA & {
file: Blob;
environment: CKEnvironment;
teamId: string;
containerId: string;
} & {}>;
declare type ImportSchemaParamsValidator = ReturnType;
/**
* @hidden
* @internal
* @privateRemarks
* Constants for the operation that must be declared
* before use in the public operation object.
*/
declare const importSchemaOpConsts: {
/**
* @hidden
* @internal
* @privateRemarks
* The validator used to validate the
* parameters passed to the stream function
* of this operation.
*/
readonly getParamsValidator: () => (obj: T) => import("@apple/cktool.core").ValidatedNEA & {
file: Blob;
environment: CKEnvironment;
teamId: string;
containerId: string;
} & {}>;
/**
* @hidden
* @internal
* @privateRemarks
* A map of HTTP response codes
* to expected success responses.
*/
readonly successResponses: {
readonly 202: {
readonly description: string;
};
};
/**
* @hidden
* @internal
* @privateRemarks
* A map of HTTP response codes
* to expected failure responses.
*/
readonly failureResponses: {
readonly 0: {
readonly description: string;
readonly contentType: "application/json";
readonly getDecoderFn: () => (val: unknown) => import("@apple/cktool.core").ValidatedNEA;
};
};
/**
* @internal
*/
readonly security: readonly [readonly ["CookieAuth"], readonly ["ManagementTokenAuth"]];
};
export declare type ImportSchemaSecurity = {
[Security.SCHEME_KEY_CookieAuth]: string;
} | {
[Security.SCHEME_KEY_ManagementTokenAuth]: string;
};
/**
* @internal
*/
export declare type ImportSchemaOpConsts = typeof importSchemaOpConsts & {
successTypes: never | {
statusCode: 202;
description: string;
};
responseErrorTypes: never | DocumentedResponseError;
securityTypes: ImportSchemaSecurity;
};
/**
* Parameters type for importSchema.
*/
export interface ImportSchemaParams {
file: File;
/**
* The team identifier. You can find your team identifier in the Membership tab of the Apple Developer portal at `https://developer.apple.com`.
*/
teamId: string;
/**
* The container identifier. See `Container`.
*/
containerId: string;
/**
* The container environment. For valid values, see `CKEnvironment`.
*/
environment: CKEnvironment;
}
export interface ImportSchemaOpOptions extends ApiOperationOptionsBase {
security?: ImportSchemaSecurity;
}
/**
* @internal
*
* 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`.
* API operation: importSchema
* API version: 1.3.2
*/
export declare const importSchemaOp: {
/**
* @hidden
* @internal
* @privateRemarks
* The unique name of this operation, which corresponds
* to the OpenAPI specification from which this object
* was generated.
*/
readonly name: "importSchema";
/**
* @hidden
* @internal
* @privateRemarks
* The HTTP method this operation uses when making a
* request to the server.
* @internal
*/
readonly httpMethod: "PUT";
/**
* @hidden
* @internal
* @privateRemarks
* The RESTful server path this operation uses when
* making a request to the server.
* @internal
*/
readonly path: "/v1/database/teams/{teamId}/containers/{containerId}/environments/{environment}/schema";
/**
* @hidden
* @internal
*/
readonly requestBodyContentTypes: readonly ["multipart/form-data"];
/**
* @hidden
* @internal
*/
readonly multipartParams: readonly ["file"];
/**
* @hidden
* @internal
*
* 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`.
*
* This function validates the parameters passed in
* before communicating with the server.
* If the parameters fail the check, the callbag
* source will end with an error.
*
* API operation: importSchema
* API version: 1.3.2
*
* @param options.configuration - The configuration object.
* @param options.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.
* @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`.
*
* @returns A pullable callbag source
* that yields expected success responses.
* For more information on callbags, see the
* (standard)[https://github.com/callbag/callbag].
* See {@link importSchemaOp.responseDictionary} for
* expected responses. Responses in the 2xx range will
* be considered success responses and will be sent
* in the stream. Other responses will cause the
* stream to end with an error condition.
*/
readonly $: (options: ImportSchemaOpOptions, params: ImportSchemaParams) => Source