/** @module @airtable/blocks: mutations */ /** */
import { ObjectValues, ObjectMap } from '../private_utils';
import { FieldTypeConfig, NormalizedViewMetadata } from './airtable_interface';
import { GlobalConfigUpdate, GlobalConfigValue } from './global_config';
import { TableId } from './table';
import { FieldId } from './field';
import { ViewId } from './view';
import { RecordId } from './record';
/** @hidden */
export declare const MutationTypes: Readonly<{
    SET_MULTIPLE_RECORDS_CELL_VALUES: "setMultipleRecordsCellValues";
    DELETE_MULTIPLE_RECORDS: "deleteMultipleRecords";
    CREATE_MULTIPLE_RECORDS: "createMultipleRecords";
    SET_MULTIPLE_GLOBAL_CONFIG_PATHS: "setMultipleGlobalConfigPaths";
    CREATE_SINGLE_FIELD: "createSingleField";
    UPDATE_SINGLE_FIELD_CONFIG: "updateSingleFieldConfig";
    CREATE_SINGLE_TABLE: "createSingleTable";
    UPDATE_VIEW_METADATA: "updateViewMetadata";
}>;
/** @hidden */
export declare type MutationType = ObjectValues<typeof MutationTypes>;
/**
 * The Mutation emitted when the App modifies one or more {@link Record|Records}.
 *
 * @docsPath testing/mutations/SetMultipleRecordsCellValuesMutation
 */
export interface SetMultipleRecordsCellValuesMutation {
    /** This Mutation's [discriminant property](https://www.typescriptlang.org/docs/handbook/2/narrowing.html) */
    readonly type: typeof MutationTypes.SET_MULTIPLE_RECORDS_CELL_VALUES;
    /** The identifier for the @link Table in which Records are being modified */
    readonly tableId: TableId;
    /** The Records being modified */
    readonly records: ReadonlyArray<{
        readonly id: RecordId;
        readonly cellValuesByFieldId: ObjectMap<FieldId, unknown>;
    }>;
}
/** @hidden */
export interface PartialSetMultipleRecordsCellValuesMutation {
    readonly type: typeof MutationTypes.SET_MULTIPLE_RECORDS_CELL_VALUES;
    readonly tableId: TableId | undefined;
    readonly records: ReadonlyArray<{
        readonly id: RecordId | undefined;
        readonly cellValuesByFieldId: ObjectMap<FieldId, unknown | undefined> | undefined;
    }> | undefined;
}
/**
 * The Mutation emitted when the App deletes one or more {@link Record|Records}.
 *
 * @docsPath testing/mutations/DeleteMultipleRecordsMutation
 */
export interface DeleteMultipleRecordsMutation {
    /** This Mutation's [discriminant property](https://www.typescriptlang.org/docs/handbook/2/narrowing.html) */
    readonly type: typeof MutationTypes.DELETE_MULTIPLE_RECORDS;
    /** The identifier for the Table in which Records are being deleted */
    readonly tableId: TableId;
    /** The identifiers for records being deleted */
    readonly recordIds: ReadonlyArray<RecordId>;
}
/** @hidden */
export interface PartialDeleteMultipleRecordsMutation {
    readonly type: typeof MutationTypes.DELETE_MULTIPLE_RECORDS;
    readonly tableId: TableId | undefined;
    readonly recordIds: ReadonlyArray<RecordId> | undefined;
}
/**
 * The Mutation emitted when the App creates one or more {@link Record|Records}.
 *
 * @docsPath testing/mutations/CreateMultipleRecordsMutation
 */
export interface CreateMultipleRecordsMutation {
    /** This Mutation's [discriminant property](https://www.typescriptlang.org/docs/handbook/2/narrowing.html) */
    readonly type: typeof MutationTypes.CREATE_MULTIPLE_RECORDS;
    /** The identifier for the Table in which Records are being created */
    readonly tableId: TableId;
    /** The records being created */
    readonly records: ReadonlyArray<{
        readonly id: RecordId;
        readonly cellValuesByFieldId: ObjectMap<FieldId, unknown>;
    }>;
}
/** @hidden */
export interface PartialCreateMultipleRecordsMutation {
    readonly type: typeof MutationTypes.CREATE_MULTIPLE_RECORDS;
    readonly tableId: TableId | undefined;
    readonly records: ReadonlyArray<{
        readonly id: RecordId | undefined;
        readonly cellValuesByFieldId: ObjectMap<FieldId, unknown | undefined> | undefined;
    }> | undefined;
}
/**
 * The Mutation emitted when the App modifies one or more values in the
 * {@link GlobalConfig}.
 *
 * @docsPath testing/mutations/SetMultipleGlobalConfigPathsMutation
 */
export interface SetMultipleGlobalConfigPathsMutation {
    /** This Mutation's [discriminant property](https://www.typescriptlang.org/docs/handbook/2/narrowing.html) */
    readonly type: typeof MutationTypes.SET_MULTIPLE_GLOBAL_CONFIG_PATHS;
    /** One or more pairs of path and value */
    readonly updates: ReadonlyArray<GlobalConfigUpdate>;
}
/** @hidden */
export interface PartialSetMultipleGlobalConfigPathsMutation {
    readonly type: typeof MutationTypes.SET_MULTIPLE_GLOBAL_CONFIG_PATHS;
    readonly updates: ReadonlyArray<{
        readonly path: ReadonlyArray<string | undefined> | undefined;
        readonly value: GlobalConfigValue | undefined | undefined;
    }> | undefined;
}
/**
 * The Mutation emitted when the App creates a {@link Field}.
 *
 * @docsPath testing/mutations/CreateSingleFieldMutation
 */
export interface CreateSingleFieldMutation {
    /** This Mutation's [discriminant property](https://www.typescriptlang.org/docs/handbook/2/narrowing.html) */
    readonly type: typeof MutationTypes.CREATE_SINGLE_FIELD;
    /** The identifier for the Table in which a Field is being created */
    readonly tableId: TableId;
    /** The identifier for the Field being created */
    readonly id: FieldId;
    /** The name of the Field being created */
    readonly name: string;
    /** The configuration for the Field being created */
    readonly config: FieldTypeConfig;
}
/** @hidden */
export interface PartialCreateSingleFieldMutation {
    readonly type: typeof MutationTypes.CREATE_SINGLE_FIELD;
    readonly tableId: TableId | undefined;
    readonly id: FieldId | undefined;
    readonly name: string | undefined;
    readonly config: FieldTypeConfig | undefined;
}
/**
 * The Mutation emitted when the App modifies a {@link Field}.
 *
 * @docsPath testing/mutations/UpdateSingleFieldConfigMutation
 */
export interface UpdateSingleFieldConfigMutation {
    /** This Mutation's [discriminant property](https://www.typescriptlang.org/docs/handbook/2/narrowing.html) */
    readonly type: typeof MutationTypes.UPDATE_SINGLE_FIELD_CONFIG;
    /** The identifier for the Table in which a Field is being modified */
    readonly tableId: TableId;
    /** The identifier for the Field being modified */
    readonly id: FieldId;
    /** The new configuration for the Field being modified */
    readonly config: FieldTypeConfig;
    /** Optional options to affect the behavior of the update */
    readonly opts?: UpdateFieldOptionsOpts;
}
/** @hidden */
export interface PartialUpdateSingleFieldConfigMutation {
    readonly type: typeof MutationTypes.UPDATE_SINGLE_FIELD_CONFIG;
    readonly tableId: TableId | undefined;
    readonly id: FieldId | undefined;
    readonly config: FieldTypeConfig | undefined;
    readonly opts?: UpdateFieldOptionsOpts | undefined;
}
/**
 * Options that affect the behavior of an `UpdateSingleFieldConfigMutation`
 */
export interface UpdateFieldOptionsOpts {
    /**
     * Allowing select field choices to be deleted  is dangerous since any
     * records which use that choice will lose their cell value. By default,
     * calling `updateOptionsAsync` on a select field only allows choices to be
     *  added or modified. Passing this option will allow choices to be deleted.
     */
    enableSelectFieldChoiceDeletion?: boolean;
}
/**
 * The Mutation emitted when the App creates a {@link Table}
 *
 * @docsPath testing/mutations/CreateSingleTableMutation
 */
export interface CreateSingleTableMutation {
    /** This Mutation's [discriminant property](https://www.typescriptlang.org/docs/handbook/2/narrowing.html) */
    readonly type: typeof MutationTypes.CREATE_SINGLE_TABLE;
    /** The identifier for the Table being created */
    readonly id: TableId;
    /** The name of the Table being created */
    readonly name: string;
    /** The Fields that are being created within the new Table */
    readonly fields: ReadonlyArray<{
        name: string;
        config: FieldTypeConfig;
    }>;
}
/** @hidden */
export interface PartialCreateSingleTableMutation {
    readonly type: typeof MutationTypes.CREATE_SINGLE_TABLE;
    readonly id: TableId | undefined;
    readonly name: string | undefined;
    readonly fields: ReadonlyArray<{
        name: string | undefined;
        config: FieldTypeConfig | undefined;
    }> | undefined;
}
/**
 * The Mutation emitted when the App modifies a {@link View}.
 *
 * @docsPath testing/mutations/UpdateViewMetadataMutation
 */
export interface UpdateViewMetadataMutation {
    /** This Mutation's [discriminant property](https://www.typescriptlang.org/docs/handbook/2/narrowing.html) */
    readonly type: typeof MutationTypes.UPDATE_VIEW_METADATA;
    /** The identifier for the Table in which a View is being modified */
    readonly tableId: TableId;
    /** The identifier for the View being modified */
    readonly viewId: ViewId;
    /** The metadata for the View being modified */
    readonly metadata: NormalizedViewMetadata;
}
/** @hidden */
export interface PartialUpdateViewMetadataMutation {
    readonly type: typeof MutationTypes.UPDATE_VIEW_METADATA;
    readonly tableId: TableId | undefined;
    readonly viewId: ViewId | undefined;
    readonly metadata: NormalizedViewMetadata | undefined;
}
/** @hidden */
export declare type Mutation = SetMultipleRecordsCellValuesMutation | DeleteMultipleRecordsMutation | CreateMultipleRecordsMutation | SetMultipleGlobalConfigPathsMutation | CreateSingleFieldMutation | UpdateSingleFieldConfigMutation | CreateSingleTableMutation | UpdateViewMetadataMutation;
/** @hidden */
export declare type PartialMutation = PartialSetMultipleRecordsCellValuesMutation | PartialDeleteMultipleRecordsMutation | PartialCreateMultipleRecordsMutation | PartialSetMultipleGlobalConfigPathsMutation | PartialCreateSingleFieldMutation | PartialUpdateSingleFieldConfigMutation | PartialCreateSingleTableMutation | PartialUpdateViewMetadataMutation;
/** */
export interface SuccessfulPermissionCheckResult {
    /** */
    hasPermission: true;
}
/** */
export interface UnsuccessfulPermissionCheckResult {
    /** */
    hasPermission: false;
    /**
     * A string explaining why the action is not permitted. These strings should only be used to
     * show to the user; you should not rely on the format of the string as it may change without
     * notice.
     */
    reasonDisplayString: string;
}
/** Indicates whether the user has permission to perform a particular action, and if not, why. */
export declare type PermissionCheckResult = SuccessfulPermissionCheckResult | UnsuccessfulPermissionCheckResult;