@datocms/cma-client
Version:
JS client for DatoCMS REST Content Management API
1,215 lines • 169 kB
TypeScript
import BaseResource from '../../BaseResource.js';
import type * as ApiTypes from '../ApiTypes.js';
import type * as RawApiTypes from '../RawApiTypes.js';
export default class Field extends BaseResource {
static readonly TYPE: "field";
/**
* Create a new field
*
* Read more: https://www.datocms.com/docs/content-management-api/resources/field/create
*
* @throws {ApiError}
* @throws {TimeoutError}
*/
create(itemTypeId: string | ApiTypes.ItemTypeData, body: ApiTypes.FieldCreateSchema): Promise<(Omit<ApiTypes.FieldStableShell, "field_type" | "default_value" | "validators" | "appearance" | "localized"> & {
field_type: "boolean";
localized: false;
default_value: import("../../index.js").BooleanFieldValue;
validators: import("../../index.js").BooleanFieldValidators;
appearance: import("../../index.js").BooleanFieldAppearance & Omit<{
editor: string;
field_extension?: string | undefined;
parameters: {
[k: string]: unknown;
};
addons: {
[k: string]: unknown;
id: string;
field_extension?: string | undefined;
parameters: {
[k: string]: unknown;
};
}[];
}, "editor" | "parameters">;
}) | (Omit<ApiTypes.FieldStableShell, "field_type" | "default_value" | "validators" | "appearance" | "localized"> & {
field_type: "boolean";
localized: true;
default_value: Record<string, import("../../index.js").BooleanFieldValue>;
validators: import("../../index.js").BooleanFieldValidators;
appearance: import("../../index.js").BooleanFieldAppearance & Omit<{
editor: string;
field_extension?: string | undefined;
parameters: {
[k: string]: unknown;
};
addons: {
[k: string]: unknown;
id: string;
field_extension?: string | undefined;
parameters: {
[k: string]: unknown;
};
}[];
}, "editor" | "parameters">;
}) | (Omit<ApiTypes.FieldStableShell, "field_type" | "default_value" | "validators" | "appearance" | "localized"> & {
field_type: "color";
localized: false;
default_value: import("../../index.js").ColorFieldValue;
validators: import("../../index.js").ColorFieldValidators;
appearance: import("../../index.js").ColorFieldAppearance & Omit<{
editor: string;
field_extension?: string | undefined;
parameters: {
[k: string]: unknown;
};
addons: {
[k: string]: unknown;
id: string;
field_extension?: string | undefined;
parameters: {
[k: string]: unknown;
};
}[];
}, "editor" | "parameters">;
}) | (Omit<ApiTypes.FieldStableShell, "field_type" | "default_value" | "validators" | "appearance" | "localized"> & {
field_type: "color";
localized: true;
default_value: Record<string, import("../../index.js").ColorFieldValue>;
validators: import("../../index.js").ColorFieldValidators;
appearance: import("../../index.js").ColorFieldAppearance & Omit<{
editor: string;
field_extension?: string | undefined;
parameters: {
[k: string]: unknown;
};
addons: {
[k: string]: unknown;
id: string;
field_extension?: string | undefined;
parameters: {
[k: string]: unknown;
};
}[];
}, "editor" | "parameters">;
}) | (Omit<ApiTypes.FieldStableShell, "field_type" | "default_value" | "validators" | "appearance" | "localized"> & {
field_type: "date";
localized: false;
default_value: import("../../index.js").DateFieldValue;
validators: import("../../index.js").DateFieldValidators;
appearance: import("../../index.js").DateFieldAppearance & Omit<{
editor: string;
field_extension?: string | undefined;
parameters: {
[k: string]: unknown;
};
addons: {
[k: string]: unknown;
id: string;
field_extension?: string | undefined;
parameters: {
[k: string]: unknown;
};
}[];
}, "editor" | "parameters">;
}) | (Omit<ApiTypes.FieldStableShell, "field_type" | "default_value" | "validators" | "appearance" | "localized"> & {
field_type: "date";
localized: true;
default_value: Record<string, import("../../index.js").DateFieldValue>;
validators: import("../../index.js").DateFieldValidators;
appearance: import("../../index.js").DateFieldAppearance & Omit<{
editor: string;
field_extension?: string | undefined;
parameters: {
[k: string]: unknown;
};
addons: {
[k: string]: unknown;
id: string;
field_extension?: string | undefined;
parameters: {
[k: string]: unknown;
};
}[];
}, "editor" | "parameters">;
}) | (Omit<ApiTypes.FieldStableShell, "field_type" | "default_value" | "validators" | "appearance" | "localized"> & {
field_type: "date_time";
localized: false;
default_value: import("../../index.js").DateTimeFieldValue;
validators: import("../../index.js").DateTimeFieldValidators;
appearance: import("../../index.js").DateTimeFieldAppearance & Omit<{
editor: string;
field_extension?: string | undefined;
parameters: {
[k: string]: unknown;
};
addons: {
[k: string]: unknown;
id: string;
field_extension?: string | undefined;
parameters: {
[k: string]: unknown;
};
}[];
}, "editor" | "parameters">;
}) | (Omit<ApiTypes.FieldStableShell, "field_type" | "default_value" | "validators" | "appearance" | "localized"> & {
field_type: "date_time";
localized: true;
default_value: Record<string, import("../../index.js").DateTimeFieldValue>;
validators: import("../../index.js").DateTimeFieldValidators;
appearance: import("../../index.js").DateTimeFieldAppearance & Omit<{
editor: string;
field_extension?: string | undefined;
parameters: {
[k: string]: unknown;
};
addons: {
[k: string]: unknown;
id: string;
field_extension?: string | undefined;
parameters: {
[k: string]: unknown;
};
}[];
}, "editor" | "parameters">;
}) | (Omit<ApiTypes.FieldStableShell, "field_type" | "default_value" | "validators" | "appearance" | "localized"> & {
field_type: "file";
localized: false;
default_value: null;
validators: import("../../index.js").FileFieldValidators;
appearance: import("../../index.js").FileFieldAppearance & Omit<{
editor: string;
field_extension?: string | undefined;
parameters: {
[k: string]: unknown;
};
addons: {
[k: string]: unknown;
id: string;
field_extension?: string | undefined;
parameters: {
[k: string]: unknown;
};
}[];
}, "editor" | "parameters">;
}) | (Omit<ApiTypes.FieldStableShell, "field_type" | "default_value" | "validators" | "appearance" | "localized"> & {
field_type: "file";
localized: true;
default_value: Record<string, null>;
validators: import("../../index.js").FileFieldValidators;
appearance: import("../../index.js").FileFieldAppearance & Omit<{
editor: string;
field_extension?: string | undefined;
parameters: {
[k: string]: unknown;
};
addons: {
[k: string]: unknown;
id: string;
field_extension?: string | undefined;
parameters: {
[k: string]: unknown;
};
}[];
}, "editor" | "parameters">;
}) | (Omit<ApiTypes.FieldStableShell, "field_type" | "default_value" | "validators" | "appearance" | "localized"> & {
field_type: "float";
localized: false;
default_value: import("../../index.js").FloatFieldValue;
validators: import("../../index.js").FloatFieldValidators;
appearance: import("../../index.js").FloatFieldAppearance & Omit<{
editor: string;
field_extension?: string | undefined;
parameters: {
[k: string]: unknown;
};
addons: {
[k: string]: unknown;
id: string;
field_extension?: string | undefined;
parameters: {
[k: string]: unknown;
};
}[];
}, "editor" | "parameters">;
}) | (Omit<ApiTypes.FieldStableShell, "field_type" | "default_value" | "validators" | "appearance" | "localized"> & {
field_type: "float";
localized: true;
default_value: Record<string, import("../../index.js").FloatFieldValue>;
validators: import("../../index.js").FloatFieldValidators;
appearance: import("../../index.js").FloatFieldAppearance & Omit<{
editor: string;
field_extension?: string | undefined;
parameters: {
[k: string]: unknown;
};
addons: {
[k: string]: unknown;
id: string;
field_extension?: string | undefined;
parameters: {
[k: string]: unknown;
};
}[];
}, "editor" | "parameters">;
}) | (Omit<ApiTypes.FieldStableShell, "field_type" | "default_value" | "validators" | "appearance" | "localized"> & {
field_type: "gallery";
localized: false;
default_value: null;
validators: import("../../index.js").GalleryFieldValidators;
appearance: import("../../index.js").GalleryFieldAppearance & Omit<{
editor: string;
field_extension?: string | undefined;
parameters: {
[k: string]: unknown;
};
addons: {
[k: string]: unknown;
id: string;
field_extension?: string | undefined;
parameters: {
[k: string]: unknown;
};
}[];
}, "editor" | "parameters">;
}) | (Omit<ApiTypes.FieldStableShell, "field_type" | "default_value" | "validators" | "appearance" | "localized"> & {
field_type: "gallery";
localized: true;
default_value: Record<string, null>;
validators: import("../../index.js").GalleryFieldValidators;
appearance: import("../../index.js").GalleryFieldAppearance & Omit<{
editor: string;
field_extension?: string | undefined;
parameters: {
[k: string]: unknown;
};
addons: {
[k: string]: unknown;
id: string;
field_extension?: string | undefined;
parameters: {
[k: string]: unknown;
};
}[];
}, "editor" | "parameters">;
}) | (Omit<ApiTypes.FieldStableShell, "field_type" | "default_value" | "validators" | "appearance" | "localized"> & {
field_type: "integer";
localized: false;
default_value: import("../../index.js").IntegerFieldValue;
validators: import("../../index.js").IntegerFieldValidators;
appearance: import("../../index.js").IntegerFieldAppearance & Omit<{
editor: string;
field_extension?: string | undefined;
parameters: {
[k: string]: unknown;
};
addons: {
[k: string]: unknown;
id: string;
field_extension?: string | undefined;
parameters: {
[k: string]: unknown;
};
}[];
}, "editor" | "parameters">;
}) | (Omit<ApiTypes.FieldStableShell, "field_type" | "default_value" | "validators" | "appearance" | "localized"> & {
field_type: "integer";
localized: true;
default_value: Record<string, import("../../index.js").IntegerFieldValue>;
validators: import("../../index.js").IntegerFieldValidators;
appearance: import("../../index.js").IntegerFieldAppearance & Omit<{
editor: string;
field_extension?: string | undefined;
parameters: {
[k: string]: unknown;
};
addons: {
[k: string]: unknown;
id: string;
field_extension?: string | undefined;
parameters: {
[k: string]: unknown;
};
}[];
}, "editor" | "parameters">;
}) | (Omit<ApiTypes.FieldStableShell, "field_type" | "default_value" | "validators" | "appearance" | "localized"> & {
field_type: "json";
localized: false;
default_value: import("../../index.js").JsonFieldValue;
validators: import("../../index.js").JsonFieldValidators;
appearance: import("../../index.js").JsonFieldAppearance & Omit<{
editor: string;
field_extension?: string | undefined;
parameters: {
[k: string]: unknown;
};
addons: {
[k: string]: unknown;
id: string;
field_extension?: string | undefined;
parameters: {
[k: string]: unknown;
};
}[];
}, "editor" | "parameters">;
}) | (Omit<ApiTypes.FieldStableShell, "field_type" | "default_value" | "validators" | "appearance" | "localized"> & {
field_type: "json";
localized: true;
default_value: Record<string, import("../../index.js").JsonFieldValue>;
validators: import("../../index.js").JsonFieldValidators;
appearance: import("../../index.js").JsonFieldAppearance & Omit<{
editor: string;
field_extension?: string | undefined;
parameters: {
[k: string]: unknown;
};
addons: {
[k: string]: unknown;
id: string;
field_extension?: string | undefined;
parameters: {
[k: string]: unknown;
};
}[];
}, "editor" | "parameters">;
}) | (Omit<ApiTypes.FieldStableShell, "field_type" | "default_value" | "validators" | "appearance" | "localized"> & {
field_type: "lat_lon";
localized: false;
default_value: import("../../index.js").LatLonFieldValue;
validators: import("../../index.js").LatLonFieldValidators;
appearance: import("../../index.js").LatLonFieldAppearance & Omit<{
editor: string;
field_extension?: string | undefined;
parameters: {
[k: string]: unknown;
};
addons: {
[k: string]: unknown;
id: string;
field_extension?: string | undefined;
parameters: {
[k: string]: unknown;
};
}[];
}, "editor" | "parameters">;
}) | (Omit<ApiTypes.FieldStableShell, "field_type" | "default_value" | "validators" | "appearance" | "localized"> & {
field_type: "lat_lon";
localized: true;
default_value: Record<string, import("../../index.js").LatLonFieldValue>;
validators: import("../../index.js").LatLonFieldValidators;
appearance: import("../../index.js").LatLonFieldAppearance & Omit<{
editor: string;
field_extension?: string | undefined;
parameters: {
[k: string]: unknown;
};
addons: {
[k: string]: unknown;
id: string;
field_extension?: string | undefined;
parameters: {
[k: string]: unknown;
};
}[];
}, "editor" | "parameters">;
}) | (Omit<ApiTypes.FieldStableShell, "field_type" | "default_value" | "validators" | "appearance" | "localized"> & {
field_type: "link";
localized: false;
default_value: null;
validators: import("../../index.js").LinkFieldValidators;
appearance: import("../../index.js").LinkFieldAppearance & Omit<{
editor: string;
field_extension?: string | undefined;
parameters: {
[k: string]: unknown;
};
addons: {
[k: string]: unknown;
id: string;
field_extension?: string | undefined;
parameters: {
[k: string]: unknown;
};
}[];
}, "editor" | "parameters">;
}) | (Omit<ApiTypes.FieldStableShell, "field_type" | "default_value" | "validators" | "appearance" | "localized"> & {
field_type: "link";
localized: true;
default_value: Record<string, null>;
validators: import("../../index.js").LinkFieldValidators;
appearance: import("../../index.js").LinkFieldAppearance & Omit<{
editor: string;
field_extension?: string | undefined;
parameters: {
[k: string]: unknown;
};
addons: {
[k: string]: unknown;
id: string;
field_extension?: string | undefined;
parameters: {
[k: string]: unknown;
};
}[];
}, "editor" | "parameters">;
}) | (Omit<ApiTypes.FieldStableShell, "field_type" | "default_value" | "validators" | "appearance" | "localized"> & {
field_type: "links";
localized: false;
default_value: null;
validators: import("../../index.js").LinksFieldValidators;
appearance: import("../../index.js").LinksFieldAppearance & Omit<{
editor: string;
field_extension?: string | undefined;
parameters: {
[k: string]: unknown;
};
addons: {
[k: string]: unknown;
id: string;
field_extension?: string | undefined;
parameters: {
[k: string]: unknown;
};
}[];
}, "editor" | "parameters">;
}) | (Omit<ApiTypes.FieldStableShell, "field_type" | "default_value" | "validators" | "appearance" | "localized"> & {
field_type: "links";
localized: true;
default_value: Record<string, null>;
validators: import("../../index.js").LinksFieldValidators;
appearance: import("../../index.js").LinksFieldAppearance & Omit<{
editor: string;
field_extension?: string | undefined;
parameters: {
[k: string]: unknown;
};
addons: {
[k: string]: unknown;
id: string;
field_extension?: string | undefined;
parameters: {
[k: string]: unknown;
};
}[];
}, "editor" | "parameters">;
}) | (Omit<ApiTypes.FieldStableShell, "field_type" | "default_value" | "validators" | "appearance" | "localized"> & {
field_type: "rich_text";
localized: false;
default_value: null;
validators: import("../../index.js").RichTextFieldValidators;
appearance: import("../../index.js").RichTextFieldAppearance & Omit<{
editor: string;
field_extension?: string | undefined;
parameters: {
[k: string]: unknown;
};
addons: {
[k: string]: unknown;
id: string;
field_extension?: string | undefined;
parameters: {
[k: string]: unknown;
};
}[];
}, "editor" | "parameters">;
}) | (Omit<ApiTypes.FieldStableShell, "field_type" | "default_value" | "validators" | "appearance" | "localized"> & {
field_type: "rich_text";
localized: true;
default_value: Record<string, null>;
validators: import("../../index.js").RichTextFieldValidators;
appearance: import("../../index.js").RichTextFieldAppearance & Omit<{
editor: string;
field_extension?: string | undefined;
parameters: {
[k: string]: unknown;
};
addons: {
[k: string]: unknown;
id: string;
field_extension?: string | undefined;
parameters: {
[k: string]: unknown;
};
}[];
}, "editor" | "parameters">;
}) | (Omit<ApiTypes.FieldStableShell, "field_type" | "default_value" | "validators" | "appearance" | "localized"> & {
field_type: "seo";
localized: false;
default_value: null;
validators: import("../../index.js").SeoFieldValidators;
appearance: import("../../index.js").SeoFieldAppearance & Omit<{
editor: string;
field_extension?: string | undefined;
parameters: {
[k: string]: unknown;
};
addons: {
[k: string]: unknown;
id: string;
field_extension?: string | undefined;
parameters: {
[k: string]: unknown;
};
}[];
}, "editor" | "parameters">;
}) | (Omit<ApiTypes.FieldStableShell, "field_type" | "default_value" | "validators" | "appearance" | "localized"> & {
field_type: "seo";
localized: true;
default_value: Record<string, null>;
validators: import("../../index.js").SeoFieldValidators;
appearance: import("../../index.js").SeoFieldAppearance & Omit<{
editor: string;
field_extension?: string | undefined;
parameters: {
[k: string]: unknown;
};
addons: {
[k: string]: unknown;
id: string;
field_extension?: string | undefined;
parameters: {
[k: string]: unknown;
};
}[];
}, "editor" | "parameters">;
}) | (Omit<ApiTypes.FieldStableShell, "field_type" | "default_value" | "validators" | "appearance" | "localized"> & {
field_type: "single_block";
localized: false;
default_value: null;
validators: import("../../index.js").SingleBlockFieldValidators;
appearance: import("../../index.js").SingleBlockFieldAppearance & Omit<{
editor: string;
field_extension?: string | undefined;
parameters: {
[k: string]: unknown;
};
addons: {
[k: string]: unknown;
id: string;
field_extension?: string | undefined;
parameters: {
[k: string]: unknown;
};
}[];
}, "editor" | "parameters">;
}) | (Omit<ApiTypes.FieldStableShell, "field_type" | "default_value" | "validators" | "appearance" | "localized"> & {
field_type: "single_block";
localized: true;
default_value: Record<string, null>;
validators: import("../../index.js").SingleBlockFieldValidators;
appearance: import("../../index.js").SingleBlockFieldAppearance & Omit<{
editor: string;
field_extension?: string | undefined;
parameters: {
[k: string]: unknown;
};
addons: {
[k: string]: unknown;
id: string;
field_extension?: string | undefined;
parameters: {
[k: string]: unknown;
};
}[];
}, "editor" | "parameters">;
}) | (Omit<ApiTypes.FieldStableShell, "field_type" | "default_value" | "validators" | "appearance" | "localized"> & {
field_type: "slug";
localized: false;
default_value: null;
validators: import("../../index.js").SlugFieldValidators;
appearance: import("../../index.js").SlugFieldAppearance & Omit<{
editor: string;
field_extension?: string | undefined;
parameters: {
[k: string]: unknown;
};
addons: {
[k: string]: unknown;
id: string;
field_extension?: string | undefined;
parameters: {
[k: string]: unknown;
};
}[];
}, "editor" | "parameters">;
}) | (Omit<ApiTypes.FieldStableShell, "field_type" | "default_value" | "validators" | "appearance" | "localized"> & {
field_type: "slug";
localized: true;
default_value: Record<string, null>;
validators: import("../../index.js").SlugFieldValidators;
appearance: import("../../index.js").SlugFieldAppearance & Omit<{
editor: string;
field_extension?: string | undefined;
parameters: {
[k: string]: unknown;
};
addons: {
[k: string]: unknown;
id: string;
field_extension?: string | undefined;
parameters: {
[k: string]: unknown;
};
}[];
}, "editor" | "parameters">;
}) | (Omit<ApiTypes.FieldStableShell, "field_type" | "default_value" | "validators" | "appearance" | "localized"> & {
field_type: "string";
localized: false;
default_value: import("../../index.js").StringFieldValue;
validators: import("../../index.js").StringFieldValidators;
appearance: import("../../index.js").StringFieldAppearance & Omit<{
editor: string;
field_extension?: string | undefined;
parameters: {
[k: string]: unknown;
};
addons: {
[k: string]: unknown;
id: string;
field_extension?: string | undefined;
parameters: {
[k: string]: unknown;
};
}[];
}, "editor" | "parameters">;
}) | (Omit<ApiTypes.FieldStableShell, "field_type" | "default_value" | "validators" | "appearance" | "localized"> & {
field_type: "string";
localized: true;
default_value: Record<string, import("../../index.js").StringFieldValue>;
validators: import("../../index.js").StringFieldValidators;
appearance: import("../../index.js").StringFieldAppearance & Omit<{
editor: string;
field_extension?: string | undefined;
parameters: {
[k: string]: unknown;
};
addons: {
[k: string]: unknown;
id: string;
field_extension?: string | undefined;
parameters: {
[k: string]: unknown;
};
}[];
}, "editor" | "parameters">;
}) | (Omit<ApiTypes.FieldStableShell, "field_type" | "default_value" | "validators" | "appearance" | "localized"> & {
field_type: "structured_text";
localized: false;
default_value: null;
validators: import("../../index.js").StructuredTextFieldValidators;
appearance: import("../../index.js").StructuredTextFieldAppearance & Omit<{
editor: string;
field_extension?: string | undefined;
parameters: {
[k: string]: unknown;
};
addons: {
[k: string]: unknown;
id: string;
field_extension?: string | undefined;
parameters: {
[k: string]: unknown;
};
}[];
}, "editor" | "parameters">;
}) | (Omit<ApiTypes.FieldStableShell, "field_type" | "default_value" | "validators" | "appearance" | "localized"> & {
field_type: "structured_text";
localized: true;
default_value: Record<string, null>;
validators: import("../../index.js").StructuredTextFieldValidators;
appearance: import("../../index.js").StructuredTextFieldAppearance & Omit<{
editor: string;
field_extension?: string | undefined;
parameters: {
[k: string]: unknown;
};
addons: {
[k: string]: unknown;
id: string;
field_extension?: string | undefined;
parameters: {
[k: string]: unknown;
};
}[];
}, "editor" | "parameters">;
}) | (Omit<ApiTypes.FieldStableShell, "field_type" | "default_value" | "validators" | "appearance" | "localized"> & {
field_type: "text";
localized: false;
default_value: import("../../index.js").TextFieldValue;
validators: import("../../index.js").TextFieldValidators;
appearance: import("../../index.js").TextFieldAppearance & Omit<{
editor: string;
field_extension?: string | undefined;
parameters: {
[k: string]: unknown;
};
addons: {
[k: string]: unknown;
id: string;
field_extension?: string | undefined;
parameters: {
[k: string]: unknown;
};
}[];
}, "editor" | "parameters">;
}) | (Omit<ApiTypes.FieldStableShell, "field_type" | "default_value" | "validators" | "appearance" | "localized"> & {
field_type: "text";
localized: true;
default_value: Record<string, import("../../index.js").TextFieldValue>;
validators: import("../../index.js").TextFieldValidators;
appearance: import("../../index.js").TextFieldAppearance & Omit<{
editor: string;
field_extension?: string | undefined;
parameters: {
[k: string]: unknown;
};
addons: {
[k: string]: unknown;
id: string;
field_extension?: string | undefined;
parameters: {
[k: string]: unknown;
};
}[];
}, "editor" | "parameters">;
}) | (Omit<ApiTypes.FieldStableShell, "field_type" | "default_value" | "validators" | "appearance" | "localized"> & {
field_type: "video";
localized: false;
default_value: null;
validators: import("../../index.js").VideoFieldValidators;
appearance: import("../../index.js").VideoFieldAppearance & Omit<{
editor: string;
field_extension?: string | undefined;
parameters: {
[k: string]: unknown;
};
addons: {
[k: string]: unknown;
id: string;
field_extension?: string | undefined;
parameters: {
[k: string]: unknown;
};
}[];
}, "editor" | "parameters">;
}) | (Omit<ApiTypes.FieldStableShell, "field_type" | "default_value" | "validators" | "appearance" | "localized"> & {
field_type: "video";
localized: true;
default_value: Record<string, null>;
validators: import("../../index.js").VideoFieldValidators;
appearance: import("../../index.js").VideoFieldAppearance & Omit<{
editor: string;
field_extension?: string | undefined;
parameters: {
[k: string]: unknown;
};
addons: {
[k: string]: unknown;
id: string;
field_extension?: string | undefined;
parameters: {
[k: string]: unknown;
};
}[];
}, "editor" | "parameters">;
})>;
/**
* Create a new field
*
* Read more: https://www.datocms.com/docs/content-management-api/resources/field/create
*
* @throws {ApiError}
* @throws {TimeoutError}
*/
rawCreate(itemTypeId: string, body: RawApiTypes.FieldCreateSchema): Promise<RawApiTypes.FieldCreateJobSchema>;
/**
* Update a field
*
* Read more: https://www.datocms.com/docs/content-management-api/resources/field/update
*
* @throws {ApiError}
* @throws {TimeoutError}
*/
update(fieldId: string | ApiTypes.FieldData, body: ApiTypes.FieldUpdateSchema): Promise<(Omit<ApiTypes.FieldStableShell, "field_type" | "default_value" | "validators" | "appearance" | "localized"> & {
field_type: "boolean";
localized: false;
default_value: import("../../index.js").BooleanFieldValue;
validators: import("../../index.js").BooleanFieldValidators;
appearance: import("../../index.js").BooleanFieldAppearance & Omit<{
editor: string;
field_extension?: string | undefined;
parameters: {
[k: string]: unknown;
};
addons: {
[k: string]: unknown;
id: string;
field_extension?: string | undefined;
parameters: {
[k: string]: unknown;
};
}[];
}, "editor" | "parameters">;
}) | (Omit<ApiTypes.FieldStableShell, "field_type" | "default_value" | "validators" | "appearance" | "localized"> & {
field_type: "boolean";
localized: true;
default_value: Record<string, import("../../index.js").BooleanFieldValue>;
validators: import("../../index.js").BooleanFieldValidators;
appearance: import("../../index.js").BooleanFieldAppearance & Omit<{
editor: string;
field_extension?: string | undefined;
parameters: {
[k: string]: unknown;
};
addons: {
[k: string]: unknown;
id: string;
field_extension?: string | undefined;
parameters: {
[k: string]: unknown;
};
}[];
}, "editor" | "parameters">;
}) | (Omit<ApiTypes.FieldStableShell, "field_type" | "default_value" | "validators" | "appearance" | "localized"> & {
field_type: "color";
localized: false;
default_value: import("../../index.js").ColorFieldValue;
validators: import("../../index.js").ColorFieldValidators;
appearance: import("../../index.js").ColorFieldAppearance & Omit<{
editor: string;
field_extension?: string | undefined;
parameters: {
[k: string]: unknown;
};
addons: {
[k: string]: unknown;
id: string;
field_extension?: string | undefined;
parameters: {
[k: string]: unknown;
};
}[];
}, "editor" | "parameters">;
}) | (Omit<ApiTypes.FieldStableShell, "field_type" | "default_value" | "validators" | "appearance" | "localized"> & {
field_type: "color";
localized: true;
default_value: Record<string, import("../../index.js").ColorFieldValue>;
validators: import("../../index.js").ColorFieldValidators;
appearance: import("../../index.js").ColorFieldAppearance & Omit<{
editor: string;
field_extension?: string | undefined;
parameters: {
[k: string]: unknown;
};
addons: {
[k: string]: unknown;
id: string;
field_extension?: string | undefined;
parameters: {
[k: string]: unknown;
};
}[];
}, "editor" | "parameters">;
}) | (Omit<ApiTypes.FieldStableShell, "field_type" | "default_value" | "validators" | "appearance" | "localized"> & {
field_type: "date";
localized: false;
default_value: import("../../index.js").DateFieldValue;
validators: import("../../index.js").DateFieldValidators;
appearance: import("../../index.js").DateFieldAppearance & Omit<{
editor: string;
field_extension?: string | undefined;
parameters: {
[k: string]: unknown;
};
addons: {
[k: string]: unknown;
id: string;
field_extension?: string | undefined;
parameters: {
[k: string]: unknown;
};
}[];
}, "editor" | "parameters">;
}) | (Omit<ApiTypes.FieldStableShell, "field_type" | "default_value" | "validators" | "appearance" | "localized"> & {
field_type: "date";
localized: true;
default_value: Record<string, import("../../index.js").DateFieldValue>;
validators: import("../../index.js").DateFieldValidators;
appearance: import("../../index.js").DateFieldAppearance & Omit<{
editor: string;
field_extension?: string | undefined;
parameters: {
[k: string]: unknown;
};
addons: {
[k: string]: unknown;
id: string;
field_extension?: string | undefined;
parameters: {
[k: string]: unknown;
};
}[];
}, "editor" | "parameters">;
}) | (Omit<ApiTypes.FieldStableShell, "field_type" | "default_value" | "validators" | "appearance" | "localized"> & {
field_type: "date_time";
localized: false;
default_value: import("../../index.js").DateTimeFieldValue;
validators: import("../../index.js").DateTimeFieldValidators;
appearance: import("../../index.js").DateTimeFieldAppearance & Omit<{
editor: string;
field_extension?: string | undefined;
parameters: {
[k: string]: unknown;
};
addons: {
[k: string]: unknown;
id: string;
field_extension?: string | undefined;
parameters: {
[k: string]: unknown;
};
}[];
}, "editor" | "parameters">;
}) | (Omit<ApiTypes.FieldStableShell, "field_type" | "default_value" | "validators" | "appearance" | "localized"> & {
field_type: "date_time";
localized: true;
default_value: Record<string, import("../../index.js").DateTimeFieldValue>;
validators: import("../../index.js").DateTimeFieldValidators;
appearance: import("../../index.js").DateTimeFieldAppearance & Omit<{
editor: string;
field_extension?: string | undefined;
parameters: {
[k: string]: unknown;
};
addons: {
[k: string]: unknown;
id: string;
field_extension?: string | undefined;
parameters: {
[k: string]: unknown;
};
}[];
}, "editor" | "parameters">;
}) | (Omit<ApiTypes.FieldStableShell, "field_type" | "default_value" | "validators" | "appearance" | "localized"> & {
field_type: "file";
localized: false;
default_value: null;
validators: import("../../index.js").FileFieldValidators;
appearance: import("../../index.js").FileFieldAppearance & Omit<{
editor: string;
field_extension?: string | undefined;
parameters: {
[k: string]: unknown;
};
addons: {
[k: string]: unknown;
id: string;
field_extension?: string | undefined;
parameters: {
[k: string]: unknown;
};
}[];
}, "editor" | "parameters">;
}) | (Omit<ApiTypes.FieldStableShell, "field_type" | "default_value" | "validators" | "appearance" | "localized"> & {
field_type: "file";
localized: true;
default_value: Record<string, null>;
validators: import("../../index.js").FileFieldValidators;
appearance: import("../../index.js").FileFieldAppearance & Omit<{
editor: string;
field_extension?: string | undefined;
parameters: {
[k: string]: unknown;
};
addons: {
[k: string]: unknown;
id: string;
field_extension?: string | undefined;
parameters: {
[k: string]: unknown;
};
}[];
}, "editor" | "parameters">;
}) | (Omit<ApiTypes.FieldStableShell, "field_type" | "default_value" | "validators" | "appearance" | "localized"> & {
field_type: "float";
localized: false;
default_value: import("../../index.js").FloatFieldValue;
validators: import("../../index.js").FloatFieldValidators;
appearance: import("../../index.js").FloatFieldAppearance & Omit<{
editor: string;
field_extension?: string | undefined;
parameters: {
[k: string]: unknown;
};
addons: {
[k: string]: unknown;
id: string;
field_extension?: string | undefined;
parameters: {
[k: string]: unknown;
};
}[];
}, "editor" | "parameters">;
}) | (Omit<ApiTypes.FieldStableShell, "field_type" | "default_value" | "validators" | "appearance" | "localized"> & {
field_type: "float";
localized: true;
default_value: Record<string, import("../../index.js").FloatFieldValue>;
validators: import("../../index.js").FloatFieldValidators;
appearance: import("../../index.js").FloatFieldAppearance & Omit<{
editor: string;
field_extension?: string | undefined;
parameters: {
[k: string]: unknown;
};
addons: {
[k: string]: unknown;
id: string;
field_extension?: string | undefined;
parameters: {
[k: string]: unknown;
};
}[];
}, "editor" | "parameters">;
}) | (Omit<ApiTypes.FieldStableShell, "field_type" | "default_value" | "validators" | "appearance" | "localized"> & {
field_type: "gallery";
localized: false;
default_value: null;
validators: import("../../index.js").GalleryFieldValidators;
appearance: import("../../index.js").GalleryFieldAppearance & Omit<{
editor: string;
field_extension?: string | undefined;
parameters: {
[k: string]: unknown;
};
addons: {
[k: string]: unknown;
id: string;
field_extension?: string | undefined;
parameters: {
[k: string]: unknown;
};
}[];
}, "editor" | "parameters">;
}) | (Omit<ApiTypes.FieldStableShell, "field_type" | "default_value" | "validators" | "appearance" | "localized"> & {
field_type: "gallery";
localized: true;
default_value: Record<string, null>;
validators: import("../../index.js").GalleryFieldValidators;
appearance: import("../../index.js").GalleryFieldAppearance & Omit<{
editor: string;
field_extension?: string | undefined;
parameters: {
[k: string]: unknown;
};
addons: {
[k: string]: unknown;
id: string;
field_extension?: string | undefined;
parameters: {
[k: string]: unknown;
};
}[];
}, "editor" | "parameters">;
}) | (Omit<ApiTypes.FieldStableShell, "field_type" | "default_value" | "validators" | "appearance" | "localized"> & {
field_type: "integer";
localized: false;
default_value: import("../../index.js").IntegerFieldValue;
validators: import("../../index.js").IntegerFieldValidators;
appearance: import("../../index.js").IntegerFieldAppearance & Omit<{
editor: string;
field_extension?: string | undefined;
parameters: {
[k: string]: unknown;
};
addons: {
[k: string]: unknown;
id: string;
field_extension?: string | undefined;
parameters: {
[k: string]: unknown;
};
}[];
}, "editor" | "parameters">;
}) | (Omit<ApiTypes.FieldStableShell, "field_type" | "default_value" | "validators" | "appearance" | "localized"> & {
field_type: "integer";
localized: true;
default_value: Record<string, import("../../index.js").IntegerFieldValue>;
validators: import("../../index.js").IntegerFieldValidators;
appearance: import("../../index.js").IntegerFieldAppearance & Omit<{
editor: string;
field_extension?: string | undefined;
parameters: {
[k: string]: unknown;
};
addons: {
[k: string]: unknown;
id: string;
field_extension?: string | undefined;
parameters: {
[k: string]: unknown;
};
}[];
}, "editor" | "parameters">;
}) | (Omit<ApiTypes.FieldStableShell, "field_type" | "default_value" | "validators" | "appearance" | "localized"> & {
field_type: "json";
localized: false;
default_value: import("../../index.js").JsonFieldValue;
validators: import("../../index.js").JsonFieldValidators;
appearance: import("../../index.js").JsonFieldAppearance & Omit<{
editor: string;
field_extension?: string | undefined;
parameters: {
[k: string]: unknown;
};
addons: {
[k: string]: unknown;
id: string;
field_extension?: string | undefined;
parameters: {
[k: string]: unknown;
};
}[];
}, "editor" | "parameters">;
}) | (Omit<ApiTypes.FieldStableShell, "field_type" | "default_value" | "validators" | "appearance" | "localized"> & {
field_type: "json";
localized: true;
default_value: Record<string, import("../../index.js").JsonFieldValue>;
validators: import("../../index.js").JsonFieldValidators;
appearance: import("../../index.js").JsonFieldAppearance & Omit<{
editor: string;
field_extension?: string | undefined;
parameters: {
[k: string]: unknown;
};
addons: {
[k: string]: unknown;
id: string;
field_extension?: string | undefined;
parameters: {
[k: string]: unknown;
};
}[];
}, "editor" | "parameters">;
}) | (Omit<ApiTypes.FieldStableShell, "field_type" | "default_value" | "validators" | "appearance" | "localized"> & {
field_type: "lat_lon";
localized: false;
default_value: import("../../index.js").LatLonFieldValue;
validators: import("../../index.js").LatLonFieldValidators;
appearance: import("../../index.js").LatLonFieldAppearance & Omit<{
editor: string;
field_extension?: string | undefined;
parameters: {
[k: string]: unknown;
};
addons: {
[k: string]: unknown;
id: string;
field_extension?: string | undefined;
parameters: {
[k: string]: unknown;
};
}[];
}, "editor" | "parameters">;
}) | (Omit<ApiTypes.FieldStableShell, "field_type" | "default_value" | "validators" | "appearance" | "localized"> & {
field_type: "lat_lon";
localized: true;
default_value: Record<string, import("../../