Function createClient
- create
Client(params): ContentfulClientApi<undefined> Parameters
- params: CreateClientParams
Client initialization parameters
+
Returns ContentfulClientApi<undefined>
- params: CreateClientParams
Function createGlobalOptions
- create
Global Options(globalSettings): GetGlobalOptions Parameters
- globalSettings: Required<GlobalOptionsParams>
Global library settings
+
Returns GetGlobalOptions
getGlobalSettings - Method returning client settings
+- globalSettings: Required<GlobalOptionsParams>
contentful.js
+
+ 
+
+
contentful.js
+Contentful JavaScript Content Delivery Library
+Introduction
+
+
+
+ 
+
+
+ 
+
+
+ 
+
+
+ 
+
+Contentful.js is a JavaScript and TypeScript library for the Contentful Content Delivery API and Content Preview API.
+The code is documented using TypeDoc and these pages are auto-generated and published with each new version.
+-
+
- For API and client documentation, please refer to the list below. +
- For all type definitions and descriptions, please refer to the list in the sidebar. +
API Overview
-
+
- Contentful Namespace
+
-
+
- createClient +
- EntryFields +
- EntryFieldTypes +
+ - ContentfulClientApi
+
-
+
- ContentfulClientApi.createAssetKey +
- ContentfulClientApi.getAsset +
- ContentfulClientApi.getAssets +
- ContentfulClientApi.getContentType +
- ContentfulClientApi.getContentTypes +
- ContentfulClientApi.getEntries +
- ContentfulClientApi.getEntry +
- ContentfulClientApi.getLocales +
- ContentfulClientApi.getSpace +
- ContentfulClientApi.getTag +
- ContentfulClientApi.getTags +
- ContentfulClientApi.parseEntries +
- ContentfulClientApi.sync +
+
Interface Asset<Modifiers, Locales>
Assets are binary files in a Contentful space
+interface Asset<Modifiers, Locales> {
fields: ChainModifiers extends Modifiers
? AssetFields | {
description?: {
[LocaleName in string]?: string
};
file?: {
[LocaleName in string]?: AssetFile
};
title?: {
[LocaleName in string]?: string
};
}
: "WITH_ALL_LOCALES" extends Modifiers
? {
description?: {
[LocaleName in string]?: string
};
file?: {
[LocaleName in string]?: AssetFile
};
title?: {
[LocaleName in string]?: string
};
}
: AssetFields;
metadata: Metadata;
sys: AssetSys;
}
fields: ChainModifiers extends Modifiers
? AssetFields | {
description?: {
[LocaleName in string]?: string
};
file?: {
[LocaleName in string]?: AssetFile
};
title?: {
[LocaleName in string]?: string
};
}
: "WITH_ALL_LOCALES" extends Modifiers
? {
description?: {
[LocaleName in string]?: string
};
file?: {
[LocaleName in string]?: AssetFile
};
title?: {
[LocaleName in string]?: string
};
}
: AssetFields;
metadata: Metadata;
sys: AssetSys;
}
Type Parameters
- Modifiers extends ChainModifiers = ChainModifiers
The chain modifiers used to configure the client. They’re set automatically when using the client chain modifiers.
+ - Locales extends LocaleCode = LocaleCode
If provided for a client using
+allLocalesmodifier, response type defines locale keys for asset field values.
Properties
fields
fields: ChainModifiers extends Modifiers
? AssetFields | {
description?: {
[LocaleName in string]?: string
};
file?: {
[LocaleName in string]?: AssetFile
};
title?: {
[LocaleName in string]?: string
};
}
: "WITH_ALL_LOCALES" extends Modifiers
? {
description?: {
[LocaleName in string]?: string
};
file?: {
[LocaleName in string]?: AssetFile
};
title?: {
[LocaleName in string]?: string
};
}
: AssetFields
? AssetFields | {
description?: {
[LocaleName in string]?: string
};
file?: {
[LocaleName in string]?: AssetFile
};
title?: {
[LocaleName in string]?: string
};
}
: "WITH_ALL_LOCALES" extends Modifiers
? {
description?: {
[LocaleName in string]?: string
};
file?: {
[LocaleName in string]?: AssetFile
};
title?: {
[LocaleName in string]?: string
};
}
: AssetFields
metadata
sys
diff --git a/contentful/11.3.1/interfaces/AssetFields.html b/contentful/11.3.1/interfaces/AssetFields.html
new file mode 100644
index 000000000..24720c36b
--- /dev/null
+++ b/contentful/11.3.1/interfaces/AssetFields.html
@@ -0,0 +1,4 @@
+
diff --git a/contentful/11.3.1/interfaces/AssetFile.html b/contentful/11.3.1/interfaces/AssetFile.html
new file mode 100644
index 000000000..04e559516
--- /dev/null
+++ b/contentful/11.3.1/interfaces/AssetFile.html
@@ -0,0 +1,5 @@
+
diff --git a/contentful/11.3.1/interfaces/BaseSys.html b/contentful/11.3.1/interfaces/BaseSys.html
new file mode 100644
index 000000000..80391fc75
--- /dev/null
+++ b/contentful/11.3.1/interfaces/BaseSys.html
@@ -0,0 +1,4 @@
+
diff --git a/contentful/11.3.1/interfaces/Concept.html b/contentful/11.3.1/interfaces/Concept.html
new file mode 100644
index 000000000..6b561822c
--- /dev/null
+++ b/contentful/11.3.1/interfaces/Concept.html
@@ -0,0 +1,16 @@
+
Interface Concept<Locales>
interface Concept<Locales> {
altLabels?: {
[locale in string]: string[]
};
broader?: Link<"TaxonomyConcept">[];
changeNote?: null | {
[locale in string]: string
};
definition?: null | {
[locale in string]: string
};
editorialNote?: null | {
[locale in string]: string
};
example?: null | {
[locale in string]: string
};
hiddenLabels?: {
[locale in string]: string[]
};
historyNote?: null | {
[locale in string]: string
};
notations?: string[];
note?: null | {
[locale in string]: string
};
prefLabel: {
[locale in string]: string
};
related?: Link<"TaxonomyConcept">[];
scopeNote?: null | {
[locale in string]: string
};
sys: ConceptSys;
uri?: string;
}
altLabels?: {
[locale in string]: string[]
};
broader?: Link<"TaxonomyConcept">[];
changeNote?: null | {
[locale in string]: string
};
definition?: null | {
[locale in string]: string
};
editorialNote?: null | {
[locale in string]: string
};
example?: null | {
[locale in string]: string
};
hiddenLabels?: {
[locale in string]: string[]
};
historyNote?: null | {
[locale in string]: string
};
notations?: string[];
note?: null | {
[locale in string]: string
};
prefLabel: {
[locale in string]: string
};
related?: Link<"TaxonomyConcept">[];
scopeNote?: null | {
[locale in string]: string
};
sys: ConceptSys;
uri?: string;
}
Type Parameters
- Locales extends LocaleCode
Index
Properties
Properties
Optionalalt
alt
[locale in string]: string[]
}
[locale in string]: string[]
}
Optionalbroader
Optionalchange
change
[locale in string]: string
}
[locale in string]: string
}
Optionaldefinition
definition?: null | {
[locale in string]: string
}
[locale in string]: string
}
Optionaleditorial
editorial
[locale in string]: string
}
[locale in string]: string
}
Optionalexample
example?: null | {
[locale in string]: string
}
[locale in string]: string
}
Optionalhidden
hidden
[locale in string]: string[]
}
[locale in string]: string[]
}
Optionalhistory
history
[locale in string]: string
}
[locale in string]: string
}
Optionalnotations
notations?: string[]
Optionalnote
note?: null | {
[locale in string]: string
}
[locale in string]: string
}
pref
pref
[locale in string]: string
}
[locale in string]: string
}
Optionalrelated
Optionalscope
scope
[locale in string]: string
}
[locale in string]: string
}
sys
Optionaluri
uri?: string
Interface ConceptScheme<Locales>
interface ConceptScheme<Locales> {
concepts: Link<"TaxonomyConcept">[];
definition?: null | {
[locale in string]: string
};
prefLabel: {
[locale in string]: string
};
sys: ConceptSchemeSys;
topConcepts: Link<"TaxonomyConcept">[];
totalConcepts: number;
uri?: string;
}
concepts: Link<"TaxonomyConcept">[];
definition?: null | {
[locale in string]: string
};
prefLabel: {
[locale in string]: string
};
sys: ConceptSchemeSys;
topConcepts: Link<"TaxonomyConcept">[];
totalConcepts: number;
uri?: string;
}
Type Parameters
- Locales extends LocaleCode
Index
Properties
Interface ContentType
Definition of a content type
+interface ContentType {
description: string;
displayField: string;
fields: ContentTypeField[];
name: string;
sys: ContentTypeSys;
}
description: string;
displayField: string;
fields: ContentTypeField[];
name: string;
sys: ContentTypeSys;
}
Index
Properties
Interface ContentTypeAllowedResources
Index
Properties
Interface ContentTypeField
Definition of a content type field
+interface ContentTypeField {
allowedResources?: ContentTypeAllowedResources[];
disabled: boolean;
id: string;
items?: FieldItem;
linkType?: string;
localized: boolean;
name: string;
omitted: boolean;
required: boolean;
type: ContentTypeFieldType;
validations: ContentTypeFieldValidation[];
}
allowedResources?: ContentTypeAllowedResources[];
disabled: boolean;
id: string;
items?: FieldItem;
linkType?: string;
localized: boolean;
name: string;
omitted: boolean;
required: boolean;
type: ContentTypeFieldType;
validations: ContentTypeFieldValidation[];
}
Interface ContentTypeFieldValidation
Definition of a single validation rule applied +to the related content type field
+interface ContentTypeFieldValidation {
enabledNodeTypes?: (
| "document"
| "paragraph"
| "heading-1"
| "heading-2"
| "heading-3"
| "heading-4"
| "heading-5"
| "heading-6"
| "ordered-list"
| "unordered-list"
| "list-item"
| "hr"
| "blockquote"
| "embedded-entry-block"
| "embedded-asset-block"
| "embedded-resource-block"
| "table"
| "table-row"
| "table-cell"
| "table-header-cell"
| "asset-hyperlink"
| "embedded-entry-inline"
| "embedded-resource-inline"
| "entry-hyperlink"
| "hyperlink"
| "resource-hyperlink")[];
in?: string[];
linkContentType?: string[];
linkMimetypeGroup?: string[];
message?: null | string;
nodes?: {
asset-hyperlink?: Pick<ContentTypeFieldValidation, "size" | "message">[];
embedded-asset-block?: Pick<ContentTypeFieldValidation, "size" | "message">[];
embedded-entry-block?: Pick<ContentTypeFieldValidation, "size" | "linkContentType" | "message">[];
embedded-entry-inline?: Pick<ContentTypeFieldValidation, "size" | "linkContentType" | "message">[];
embedded-resource-block?: {
allowedResources: ContentTypeAllowedResources[];
validations: Pick<ContentTypeFieldValidation, "size" | "message">[];
};
entry-hyperlink?: Pick<ContentTypeFieldValidation, "size" | "linkContentType" | "message">[];
};
regexp?: {
pattern: string;
};
size?: {
max?: number;
min?: number;
};
unique?: boolean;
}
enabledNodeTypes?: (
| "document"
| "paragraph"
| "heading-1"
| "heading-2"
| "heading-3"
| "heading-4"
| "heading-5"
| "heading-6"
| "ordered-list"
| "unordered-list"
| "list-item"
| "hr"
| "blockquote"
| "embedded-entry-block"
| "embedded-asset-block"
| "embedded-resource-block"
| "table"
| "table-row"
| "table-cell"
| "table-header-cell"
| "asset-hyperlink"
| "embedded-entry-inline"
| "embedded-resource-inline"
| "entry-hyperlink"
| "hyperlink"
| "resource-hyperlink")[];
in?: string[];
linkContentType?: string[];
linkMimetypeGroup?: string[];
message?: null | string;
nodes?: {
asset-hyperlink?: Pick<ContentTypeFieldValidation, "size" | "message">[];
embedded-asset-block?: Pick<ContentTypeFieldValidation, "size" | "message">[];
embedded-entry-block?: Pick<ContentTypeFieldValidation, "size" | "linkContentType" | "message">[];
embedded-entry-inline?: Pick<ContentTypeFieldValidation, "size" | "linkContentType" | "message">[];
embedded-resource-block?: {
allowedResources: ContentTypeAllowedResources[];
validations: Pick<ContentTypeFieldValidation, "size" | "message">[];
};
entry-hyperlink?: Pick<ContentTypeFieldValidation, "size" | "linkContentType" | "message">[];
};
regexp?: {
pattern: string;
};
size?: {
max?: number;
min?: number;
};
unique?: boolean;
}
Index
Properties
Properties
Optionalenabled
enabled
| "document"
| "paragraph"
| "heading-1"
| "heading-2"
| "heading-3"
| "heading-4"
| "heading-5"
| "heading-6"
| "ordered-list"
| "unordered-list"
| "list-item"
| "hr"
| "blockquote"
| "embedded-entry-block"
| "embedded-asset-block"
| "embedded-resource-block"
| "table"
| "table-row"
| "table-cell"
| "table-header-cell"
| "asset-hyperlink"
| "embedded-entry-inline"
| "embedded-resource-inline"
| "entry-hyperlink"
| "hyperlink"
| "resource-hyperlink")[]
| "document"
| "paragraph"
| "heading-1"
| "heading-2"
| "heading-3"
| "heading-4"
| "heading-5"
| "heading-6"
| "ordered-list"
| "unordered-list"
| "list-item"
| "hr"
| "blockquote"
| "embedded-entry-block"
| "embedded-asset-block"
| "embedded-resource-block"
| "table"
| "table-row"
| "table-cell"
| "table-header-cell"
| "asset-hyperlink"
| "embedded-entry-inline"
| "embedded-resource-inline"
| "entry-hyperlink"
| "hyperlink"
| "resource-hyperlink")[]
Optionalin
in?: string[]
Optionallink
link
Optionallink
link
Optionalmessage
message?: null | string
Optionalnodes
nodes?: {
asset-hyperlink?: Pick<ContentTypeFieldValidation, "size" | "message">[];
embedded-asset-block?: Pick<ContentTypeFieldValidation, "size" | "message">[];
embedded-entry-block?: Pick<ContentTypeFieldValidation, "size" | "linkContentType" | "message">[];
embedded-entry-inline?: Pick<ContentTypeFieldValidation, "size" | "linkContentType" | "message">[];
embedded-resource-block?: {
allowedResources: ContentTypeAllowedResources[];
validations: Pick<ContentTypeFieldValidation, "size" | "message">[];
};
entry-hyperlink?: Pick<ContentTypeFieldValidation, "size" | "linkContentType" | "message">[];
}
asset-hyperlink?: Pick<ContentTypeFieldValidation, "size" | "message">[];
embedded-asset-block?: Pick<ContentTypeFieldValidation, "size" | "message">[];
embedded-entry-block?: Pick<ContentTypeFieldValidation, "size" | "linkContentType" | "message">[];
embedded-entry-inline?: Pick<ContentTypeFieldValidation, "size" | "linkContentType" | "message">[];
embedded-resource-block?: {
allowedResources: ContentTypeAllowedResources[];
validations: Pick<ContentTypeFieldValidation, "size" | "message">[];
};
entry-hyperlink?: Pick<ContentTypeFieldValidation, "size" | "linkContentType" | "message">[];
}
Optionalregexp
regexp?: {
pattern: string;
}
pattern: string;
}
Optionalsize
size?: {
max?: number;
min?: number;
}
max?: number;
min?: number;
}
Optionalunique
unique?: boolean
Interface ContentTypeSys
System managed metadata for content type
+interface ContentTypeSys {
createdAt: `${number}-${number}-${number}T${number}:${number}:${number}Z`;
environment: {
sys: EnvironmentLink;
};
id: string;
revision: number;
space: {
sys: SpaceLink;
};
type: string;
updatedAt: `${number}-${number}-${number}T${number}:${number}:${number}Z`;
}
createdAt: `${number}-${number}-${number}T${number}:${number}:${number}Z`;
environment: {
sys: EnvironmentLink;
};
id: string;
revision: number;
space: {
sys: SpaceLink;
};
type: string;
updatedAt: `${number}-${number}-${number}T${number}:${number}:${number}Z`;
}
Hierarchy (view full)
- BaseSys
- ContentTypeSys
Interface ContentfulClientApi<Modifiers>
Contentful Delivery API Client. Contains methods which allow access to the different kinds of entities present in Contentful (Entries, Assets, etc).
+interface ContentfulClientApi<Modifiers> {
version: string;
withAllLocales: "WITH_ALL_LOCALES" extends Modifiers
? never
: ContentfulClientApi<AddChainModifier<Modifiers, "WITH_ALL_LOCALES">>;
withoutLinkResolution: "WITHOUT_LINK_RESOLUTION" extends Modifiers
? never
: "WITHOUT_UNRESOLVABLE_LINKS" extends Modifiers
? never
: ContentfulClientApi<AddChainModifier<Modifiers, "WITHOUT_LINK_RESOLUTION">>;
withoutUnresolvableLinks: "WITHOUT_LINK_RESOLUTION" extends Modifiers
? never
: "WITHOUT_UNRESOLVABLE_LINKS" extends Modifiers
? never
: ContentfulClientApi<AddChainModifier<Modifiers, "WITHOUT_UNRESOLVABLE_LINKS">>;
createAssetKey(expiresAt: number): Promise<AssetKey>;
getAsset<Locales>(id: string, query?: AssetQueries<Modifiers>): Promise<Asset<Modifiers, Locales>>;
getAssets<Locales>(query?: AssetsQueries<AssetFields, Modifiers>): Promise<AssetCollection<Modifiers, Locales>>;
getConcept(id: string): Promise<Concept<"en-US">>;
getConcepts(query?: ConceptsQueries): Promise<ConceptCollection<"en-US">>;
getConceptScheme(id: string): Promise<ConceptScheme<"en-US">>;
getConceptSchemes(query?: ConceptSchemesQueries): Promise<ConceptSchemeCollection<"en-US">>;
getContentType(id: string): Promise<ContentType>;
getContentTypes(query?: {
query?: string;
}): Promise<ContentTypeCollection>;
getEntries<EntrySkeleton, Locales>(query?: EntriesQueries<EntrySkeleton, Modifiers>): Promise<EntryCollection<EntrySkeleton, Modifiers, Locales>>;
getEntry<EntrySkeleton, Locales>(id: string, query?: EntryQueries<Modifiers>): Promise<Entry<EntrySkeleton, Modifiers, Locales>>;
getLocales(): Promise<LocaleCollection>;
getSpace(): Promise<Space>;
getTag(id: string): Promise<Tag>;
getTags(query?: TagQueries): Promise<TagCollection>;
parseEntries<EntrySkeleton, Locales>(data: EntryCollection<EntrySkeleton, AddChainModifier<Modifiers, "WITHOUT_LINK_RESOLUTION">, Locales>): EntryCollection<EntrySkeleton, Modifiers, Locales>;
sync<EntrySkeleton, Modifiers, Locales>(query: SyncQuery, syncOptions?: SyncOptions): Promise<SyncCollection<EntrySkeleton, Modifiers, Locales>>;
}
version: string;
withAllLocales: "WITH_ALL_LOCALES" extends Modifiers
? never
: ContentfulClientApi<AddChainModifier<Modifiers, "WITH_ALL_LOCALES">>;
withoutLinkResolution: "WITHOUT_LINK_RESOLUTION" extends Modifiers
? never
: "WITHOUT_UNRESOLVABLE_LINKS" extends Modifiers
? never
: ContentfulClientApi<AddChainModifier<Modifiers, "WITHOUT_LINK_RESOLUTION">>;
withoutUnresolvableLinks: "WITHOUT_LINK_RESOLUTION" extends Modifiers
? never
: "WITHOUT_UNRESOLVABLE_LINKS" extends Modifiers
? never
: ContentfulClientApi<AddChainModifier<Modifiers, "WITHOUT_UNRESOLVABLE_LINKS">>;
createAssetKey(expiresAt: number): Promise<AssetKey>;
getAsset<Locales>(id: string, query?: AssetQueries<Modifiers>): Promise<Asset<Modifiers, Locales>>;
getAssets<Locales>(query?: AssetsQueries<AssetFields, Modifiers>): Promise<AssetCollection<Modifiers, Locales>>;
getConcept(id: string): Promise<Concept<"en-US">>;
getConcepts(query?: ConceptsQueries): Promise<ConceptCollection<"en-US">>;
getConceptScheme(id: string): Promise<ConceptScheme<"en-US">>;
getConceptSchemes(query?: ConceptSchemesQueries): Promise<ConceptSchemeCollection<"en-US">>;
getContentType(id: string): Promise<ContentType>;
getContentTypes(query?: {
query?: string;
}): Promise<ContentTypeCollection>;
getEntries<EntrySkeleton, Locales>(query?: EntriesQueries<EntrySkeleton, Modifiers>): Promise<EntryCollection<EntrySkeleton, Modifiers, Locales>>;
getEntry<EntrySkeleton, Locales>(id: string, query?: EntryQueries<Modifiers>): Promise<Entry<EntrySkeleton, Modifiers, Locales>>;
getLocales(): Promise<LocaleCollection>;
getSpace(): Promise<Space>;
getTag(id: string): Promise<Tag>;
getTags(query?: TagQueries): Promise<TagCollection>;
parseEntries<EntrySkeleton, Locales>(data: EntryCollection<EntrySkeleton, AddChainModifier<Modifiers, "WITHOUT_LINK_RESOLUTION">, Locales>): EntryCollection<EntrySkeleton, Modifiers, Locales>;
sync<EntrySkeleton, Modifiers, Locales>(query: SyncQuery, syncOptions?: SyncOptions): Promise<SyncCollection<EntrySkeleton, Modifiers, Locales>>;
}
Type Parameters
- Modifiers extends ChainModifiers
The chain modifiers used to configure the client. They’re set automatically when using the client chain modifiers.
+
Index
Properties
Methods
Properties
version
version: string
The current Contentful.js version
+with
with
? never
: ContentfulClientApi<AddChainModifier<Modifiers, "WITH_ALL_LOCALES">>
? never
: ContentfulClientApi<AddChainModifier<Modifiers, "WITH_ALL_LOCALES">>
A client that will fetch assets and entries with all locales. Only available if not already enabled.
+without
without
? never
: "WITHOUT_UNRESOLVABLE_LINKS" extends Modifiers
? never
: ContentfulClientApi<AddChainModifier<Modifiers, "WITHOUT_LINK_RESOLUTION">>
? never
: "WITHOUT_UNRESOLVABLE_LINKS" extends Modifiers
? never
: ContentfulClientApi<AddChainModifier<Modifiers, "WITHOUT_LINK_RESOLUTION">>
A client that will not resolve links in entries. Only available if not already disabled.
+without
without
? never
: "WITHOUT_UNRESOLVABLE_LINKS" extends Modifiers
? never
: ContentfulClientApi<AddChainModifier<Modifiers, "WITHOUT_UNRESOLVABLE_LINKS">>
? never
: "WITHOUT_UNRESOLVABLE_LINKS" extends Modifiers
? never
: ContentfulClientApi<AddChainModifier<Modifiers, "WITHOUT_UNRESOLVABLE_LINKS">>
A client that will remove unresolvable links from entries. Only available if not already disabled.
+ Methods
create
get
get
- get
Assets<Locales>(query?): Promise<AssetCollection<Modifiers, Locales>> Fetches a collection of assets
+Type Parameters
Parameters
Optionalquery: AssetsQueries<AssetFields, Modifiers>Object with search parameters
+
Returns Promise<AssetCollection<Modifiers, Locales>>
Promise for a collection of Assets
+
get
get
- get
Concepts(query?): Promise<ConceptCollection<"en-US">> Fetches a collection of Concepts
+Parameters
Optionalquery: ConceptsQueriesObject with search parameters
+
Returns Promise<ConceptCollection<"en-US">>
Promise for a collection of Concepts
+
get
- get
Concept Scheme(id): Promise<ConceptScheme<"en-US">> Fetches a Concept Scheme
+Parameters
- id: string
The concept scheme's ID
+
Returns Promise<ConceptScheme<"en-US">>
Promise for a concept scheme
+- id: string
get
- get
Concept Schemes(query?): Promise<ConceptSchemeCollection<"en-US">> Fetches a collection of Concept Schemes
+Parameters
Optionalquery: ConceptSchemesQueriesObject with search parameters
+
Returns Promise<ConceptSchemeCollection<"en-US">>
Promise for a collection of Concept Schemes
+
get
- get
Content Type(id): Promise<ContentType> Fetches a content type
+Parameters
- id: string
The content type’s ID
+
Returns Promise<ContentType>
Promise for a content type
+- id: string
get
- get
Content Types(query?): Promise<ContentTypeCollection> Fetches a collection of content types
+Parameters
Optionalquery: {
query?: string;
}Optionalquery?: string
Returns Promise<ContentTypeCollection>
Promise for a collection of content types
+
get
- get
Entries<EntrySkeleton, Locales>(query?): Promise<EntryCollection<EntrySkeleton, Modifiers, Locales>> Fetches a collection of Entries
+Type Parameters
- EntrySkeleton extends EntrySkeletonType = EntrySkeletonType
Shape of entry fields used to calculate dynamic keys
+ - Locales extends string = string
If provided for a client using
+allLocalesmodifier, response type defines locale keys for entry field values.
Parameters
Optionalquery: EntriesQueries<EntrySkeleton, Modifiers>Object with search parameters
+
Returns Promise<EntryCollection<EntrySkeleton, Modifiers, Locales>>
Promise for a collection of Entries
+- EntrySkeleton extends EntrySkeletonType = EntrySkeletonType
get
- get
Entry<EntrySkeleton, Locales>(id, query?): Promise<Entry<EntrySkeleton, Modifiers, Locales>> Fetches an entry
+Type Parameters
- EntrySkeleton extends EntrySkeletonType = EntrySkeletonType
Shape of entry fields used to calculate dynamic keys
+ - Locales extends string = string
If provided for a client using
+allLocalesmodifier, response type defines locale keys for entry field values.
Parameters
- id: string
The entry’s ID
+ Optionalquery: EntryQueries<Modifiers>Object with search parameters. In this method it's only used for
+localewhen querying.
Returns Promise<Entry<EntrySkeleton, Modifiers, Locales>>
Promise for an entry
+- EntrySkeleton extends EntrySkeletonType = EntrySkeletonType
get
- get
Locales(): Promise<LocaleCollection> Fetches a collection of locales
+Returns Promise<LocaleCollection>
Promise for a collection of locales
+
get
get
get
- get
Tags(query?): Promise<TagCollection> Gets a collection of Tags
+Parameters
Optionalquery: TagQueries
Returns Promise<TagCollection>
Promise for a collection of tags
+
parse
- parse
Entries<EntrySkeleton, Locales>(data): EntryCollection<EntrySkeleton, Modifiers, Locales> Parse raw json data into a collection of entries. objects.Links will be resolved also
+Type Parameters
- EntrySkeleton extends EntrySkeletonType = EntrySkeletonType
Shape of entry fields used to calculate dynamic keys
+ - Locales extends string = string
If provided for a client using
+allLocalesmodifier, response type defines locale keys for entry field values.
Parameters
- data: EntryCollection<EntrySkeleton, AddChainModifier<Modifiers, "WITHOUT_LINK_RESOLUTION">, Locales>
json data
+
Returns EntryCollection<EntrySkeleton, Modifiers, Locales>
Example
+ +const data = {items: [
{
sys: {type: 'Entry', locale: 'en-US'},
fields: {
animal: {sys: {type: 'Link', linkType: 'Animal', id: 'oink'}},
anotheranimal: {sys: {type: 'Link', linkType: 'Animal', id: 'middle-parrot'}}
}
}
],
includes: {
Animal: [
{
sys: {type: 'Animal', id: 'oink', locale: 'en-US'},
fields: {
name: 'Pig',
friend: {sys: {type: 'Link', linkType: 'Animal', id: 'groundhog'}}
}
}
]
}
}
console.log( data.items[0].fields.foo ); // undefined
const parsedData = client.parseEntries(data);
console.log( parsedData.items[0].fields.foo ); // foo +- EntrySkeleton extends EntrySkeletonType = EntrySkeletonType
sync
- sync<EntrySkeleton, Modifiers, Locales>(query, syncOptions?): Promise<SyncCollection<EntrySkeleton, Modifiers, Locales>>
Synchronizes either all the content or only new content since last sync. + Important note: The Sync API endpoint does not support include or link resolution. +However, contentful.js can do link resolution on the client side for the initial sync. +For the delta sync (using nextSyncToken) link resolution is not possible since the sdk won’t have access to all linked entities.
+Type Parameters
- EntrySkeleton extends EntrySkeletonType = EntrySkeletonType
Shape of entity fields used to calculate dynamic keys
+ - Modifiers extends ChainModifiers = ChainModifiers
The chain modifiers used to configure the client. They’re set automatically when using the client chain modifiers.
+ - Locales extends string = string
If provided for a client using
+allLocalesmodifier, response type defines locale keys for entity field values.
Parameters
- query: SyncQuery
Query object
+ OptionalsyncOptions: SyncOptions
Returns Promise<SyncCollection<EntrySkeleton, Modifiers, Locales>>
Example
+ +import * as contentful from 'contentful'
const client = contentful.createClient({
space: '<space_id>',
accessToken: '<content_delivery_api_key>'
})
const response = await client.sync({
initial: true
})
console.log({
entries: response.entries,
assets: response.assets,
nextSyncToken: response.nextSyncToken
}) +- EntrySkeleton extends EntrySkeletonType = EntrySkeletonType
diff --git a/contentful/11.3.1/interfaces/CreateClientParams.html b/contentful/11.3.1/interfaces/CreateClientParams.html
new file mode 100644
index 000000000..ccfcea21c
--- /dev/null
+++ b/contentful/11.3.1/interfaces/CreateClientParams.html
@@ -0,0 +1,68 @@
+
Interface CreateClientParams
Client initialization parameters
+interface CreateClientParams {
accessToken: string;
adapter?: AxiosAdapter;
alphaFeatures?: {
includeContentSourceMaps?: boolean;
};
application?: string;
basePath?: string;
environment?: string;
headers?: Record<string, string>;
host?: string;
httpAgent?: any;
httpsAgent?: any;
includeContentSourceMaps?: boolean;
insecure?: boolean;
integration?: string;
logHandler?: ((level: string, data?: string | Record<string, any>) => void);
proxy?: false | AxiosProxyConfig;
requestLogger?: ((request: Error | AxiosRequestConfig<any>) => unknown);
responseLogger?: ((response: Error | AxiosResponse<any, any>) => unknown);
retryLimit?: number;
retryOnError?: boolean;
space: string;
timeout?: number;
}
accessToken: string;
adapter?: AxiosAdapter;
alphaFeatures?: {
includeContentSourceMaps?: boolean;
};
application?: string;
basePath?: string;
environment?: string;
headers?: Record<string, string>;
host?: string;
httpAgent?: any;
httpsAgent?: any;
includeContentSourceMaps?: boolean;
insecure?: boolean;
integration?: string;
logHandler?: ((level: string, data?: string | Record<string, any>) => void);
proxy?: false | AxiosProxyConfig;
requestLogger?: ((request: Error | AxiosRequestConfig<any>) => unknown);
responseLogger?: ((response: Error | AxiosResponse<any, any>) => unknown);
retryLimit?: number;
retryOnError?: boolean;
space: string;
timeout?: number;
}
Properties
access
access
Contentful CDA Access Token
+Optionaladapter
adapter?: AxiosAdapter
Optional axios request adapter (see axios docs )
+Optionalalpha
alpha
includeContentSourceMaps?: boolean;
}
includeContentSourceMaps?: boolean;
}
Enable alpha features.
+Optionalapplication
application?: string
Application name and version e.g myApp/version
+Optionalbase
base
Path appended to the host to support gateways/proxies with custom urls
+Optionalenvironment
environment?: string
Contentful Environment ID
+Optionalheaders
headers?: Record<string, string>
Optional additional headers
+Optionalhost
host?: string
API host. Also usable with preview.contentful.com.
+Optionalhttp
http
Optional Node.js HTTP agent for proxying +(see Node.js docs +and https-proxy-agent)
+Optionalhttps
https
Optional Node.js HTTP agent for proxying +(see Node.js docs +and https-proxy-agent)
+Optionalinclude
include
Enable Content Source Maps.
+Optionalinsecure
insecure?: boolean
Requests will be made over http instead of the default https
+Optionalintegration
integration?: string
Integration name and version e.g react/version
+Optionallog
log
A log handler function to process given log messages and errors. +(The default can be found at: https://github.com/contentful/contentful-sdk-core/blob/master/src/create-http-client.ts)
+Type declaration
- (level, data?): void
Parameters
- level: string
Log level, e.g. error, warning, or info
+ Optionaldata: string | Record<string, any>Log data
+
Returns void
- level: string
Optionalproxy
proxy?: false | AxiosProxyConfig
Optional Axios proxy (see axios docs )
+Optionalrequest
request
Interceptor called on every request. Takes Axios request config as an arg.
+Optionalresponse
response
Interceptor called on every response. Takes Axios response object as an arg.
+Optionalretry
retry
Optional number of retries before failure.
+Optionalretry
retry
If we should retry on errors and 429 rate limit exceptions
+space
space: string
Space ID
+Optionaltimeout
timeout?: number
connection timeout in milliseconds (default:30000)
+Interface EntitySys
System managed metadata for entities
+interface EntitySys {
contentSourceMaps?: CPAContentSourceMaps;
contentSourceMapsLookup?: ContentSourceMapsLookup;
createdAt: `${number}-${number}-${number}T${number}:${number}:${number}Z`;
environment: {
sys: EnvironmentLink;
};
id: string;
locale?: string;
revision: number;
space: {
sys: SpaceLink;
};
type: string;
updatedAt: `${number}-${number}-${number}T${number}:${number}:${number}Z`;
}
contentSourceMaps?: CPAContentSourceMaps;
contentSourceMapsLookup?: ContentSourceMapsLookup;
createdAt: `${number}-${number}-${number}T${number}:${number}:${number}Z`;
environment: {
sys: EnvironmentLink;
};
id: string;
locale?: string;
revision: number;
space: {
sys: SpaceLink;
};
type: string;
updatedAt: `${number}-${number}-${number}T${number}:${number}:${number}Z`;
}
Hierarchy (view full)
Index
Properties
Properties
Optionalcontent
content
Optionalcontent
content
created
created
environment
id
id: string
Optionallocale
locale?: string
revision
revision: number
space
type
type: string
updated
updated
Interface EntrySys
System managed metadata for entries
+interface EntrySys {
contentSourceMaps?: CPAContentSourceMaps;
contentSourceMapsLookup?: ContentSourceMapsLookup;
contentType: {
sys: ContentTypeLink;
};
createdAt: `${number}-${number}-${number}T${number}:${number}:${number}Z`;
environment: {
sys: EnvironmentLink;
};
id: string;
locale?: string;
revision: number;
space: {
sys: SpaceLink;
};
type: "Entry";
updatedAt: `${number}-${number}-${number}T${number}:${number}:${number}Z`;
}
contentSourceMaps?: CPAContentSourceMaps;
contentSourceMapsLookup?: ContentSourceMapsLookup;
contentType: {
sys: ContentTypeLink;
};
createdAt: `${number}-${number}-${number}T${number}:${number}:${number}Z`;
environment: {
sys: EnvironmentLink;
};
id: string;
locale?: string;
revision: number;
space: {
sys: SpaceLink;
};
type: "Entry";
updatedAt: `${number}-${number}-${number}T${number}:${number}:${number}Z`;
}
Hierarchy (view full)
- EntitySys
- EntrySys
Index
Properties
Properties
Optionalcontent
content
Optionalcontent
content
content
created
created
environment
id
id: string
Optionallocale
locale?: string
revision
revision: number
space
type
type
updated
updated
Interface FieldItem
Definition of an item belonging to the content type field
+interface FieldItem {
linkType?: "Entry" | "Asset";
type: "Link" | "ResourceLink" | "Symbol";
validations: ContentTypeFieldValidation[];
}
linkType?: "Entry" | "Asset";
type: "Link" | "ResourceLink" | "Symbol";
validations: ContentTypeFieldValidation[];
}
Index
Properties
Interface GlobalOptionsParams
interface GlobalOptionsParams {
environment?: string;
environmentBaseUrl?: string;
space?: string;
spaceBaseUrl?: string;
}
environment?: string;
environmentBaseUrl?: string;
space?: string;
spaceBaseUrl?: string;
}
Index
Properties
diff --git a/contentful/11.3.1/interfaces/Locale.html b/contentful/11.3.1/interfaces/Locale.html
new file mode 100644
index 000000000..a9d6ebf8e
--- /dev/null
+++ b/contentful/11.3.1/interfaces/Locale.html
@@ -0,0 +1,7 @@
+
diff --git a/contentful/11.3.1/interfaces/LocaleSys.html b/contentful/11.3.1/interfaces/LocaleSys.html
new file mode 100644
index 000000000..411ed22a2
--- /dev/null
+++ b/contentful/11.3.1/interfaces/LocaleSys.html
@@ -0,0 +1,5 @@
+
diff --git a/contentful/11.3.1/interfaces/ResourceLink.html b/contentful/11.3.1/interfaces/ResourceLink.html
new file mode 100644
index 000000000..35f87ba97
--- /dev/null
+++ b/contentful/11.3.1/interfaces/ResourceLink.html
@@ -0,0 +1,5 @@
+
diff --git a/contentful/11.3.1/interfaces/Space.html b/contentful/11.3.1/interfaces/Space.html
new file mode 100644
index 000000000..d013c31f1
--- /dev/null
+++ b/contentful/11.3.1/interfaces/Space.html
@@ -0,0 +1,6 @@
+
diff --git a/contentful/11.3.1/interfaces/SpaceSys.html b/contentful/11.3.1/interfaces/SpaceSys.html
new file mode 100644
index 000000000..321cd4617
--- /dev/null
+++ b/contentful/11.3.1/interfaces/SpaceSys.html
@@ -0,0 +1,5 @@
+
diff --git a/contentful/11.3.1/interfaces/SyncCollection.html b/contentful/11.3.1/interfaces/SyncCollection.html
new file mode 100644
index 000000000..62722977a
--- /dev/null
+++ b/contentful/11.3.1/interfaces/SyncCollection.html
@@ -0,0 +1,7 @@
+
Interface SyncCollection<EntrySkeleton, Modifiers, Locales>
interface SyncCollection<EntrySkeleton, Modifiers, Locales> {
assets: Asset<ChainModifiers extends Modifiers
? ChainModifiers<ChainModifiers>
: "WITH_ALL_LOCALES" | Exclude<Modifiers, undefined>, Locales>[];
deletedAssets: DeletedAsset[];
deletedEntries: DeletedEntry[];
entries: Entry<EntrySkeleton, ChainModifiers extends Modifiers
? ChainModifiers<ChainModifiers>
: "WITH_ALL_LOCALES" | Exclude<Modifiers, undefined>, Locales>[];
nextPageToken?: string;
nextSyncToken?: string;
}
assets: Asset<ChainModifiers extends Modifiers
? ChainModifiers<ChainModifiers>
: "WITH_ALL_LOCALES" | Exclude<Modifiers, undefined>, Locales>[];
deletedAssets: DeletedAsset[];
deletedEntries: DeletedEntry[];
entries: Entry<EntrySkeleton, ChainModifiers extends Modifiers
? ChainModifiers<ChainModifiers>
: "WITH_ALL_LOCALES" | Exclude<Modifiers, undefined>, Locales>[];
nextPageToken?: string;
nextSyncToken?: string;
}
Type Parameters
- EntrySkeleton extends EntrySkeletonType
- Modifiers extends ChainModifiers = ChainModifiers
- Locales extends LocaleCode = LocaleCode
Index
Properties
Properties
assets
assets: Asset<ChainModifiers extends Modifiers
? ChainModifiers<ChainModifiers>
: "WITH_ALL_LOCALES" | Exclude<Modifiers, undefined>, Locales>[]
? ChainModifiers<ChainModifiers>
: "WITH_ALL_LOCALES" | Exclude<Modifiers, undefined>, Locales>[]
deleted
deleted
entries
entries: Entry<EntrySkeleton, ChainModifiers extends Modifiers
? ChainModifiers<ChainModifiers>
: "WITH_ALL_LOCALES" | Exclude<Modifiers, undefined>, Locales>[]
? ChainModifiers<ChainModifiers>
: "WITH_ALL_LOCALES" | Exclude<Modifiers, undefined>, Locales>[]
Optionalnext
next
Optionalnext
next
Interface TagSys
System managed metadata for tags
+interface TagSys {
contentSourceMaps?: CPAContentSourceMaps;
contentSourceMapsLookup?: ContentSourceMapsLookup;
createdAt: `${number}-${number}-${number}T${number}:${number}:${number}Z`;
createdBy: {
sys: UserLink;
};
environment: {
sys: EnvironmentLink;
};
id: string;
space: {
sys: SpaceLink;
};
type: string;
updatedAt: `${number}-${number}-${number}T${number}:${number}:${number}Z`;
updatedBy: {
sys: UserLink;
};
version: number;
visibility: string;
}
contentSourceMaps?: CPAContentSourceMaps;
contentSourceMapsLookup?: ContentSourceMapsLookup;
createdAt: `${number}-${number}-${number}T${number}:${number}:${number}Z`;
createdBy: {
sys: UserLink;
};
environment: {
sys: EnvironmentLink;
};
id: string;
space: {
sys: SpaceLink;
};
type: string;
updatedAt: `${number}-${number}-${number}T${number}:${number}:${number}Z`;
updatedBy: {
sys: UserLink;
};
version: number;
visibility: string;
}
Hierarchy
- Omit<EntitySys, "locale" | "revision">
- TagSys
Index
Properties
Properties
Optionalcontent
content
Optionalcontent
content
created
created
created
environment
id
id: string
space
type
type: string
updated
updated
updated
version
version: number
visibility
visibility: string
contentful.js
Index
Asset
Client
ContentType
Entity
Entry
Link
Other
Base
Query
Sync
Tag
Namespace EntryFieldTypes
Definition of abstract entry field types with additional type properties +Introduced to properly distinguish all fields to create consistent query types
+Index
Type Aliases
diff --git a/contentful/11.3.1/types/AddChainModifier.html b/contentful/11.3.1/types/AddChainModifier.html
new file mode 100644
index 000000000..77c103aa9
--- /dev/null
+++ b/contentful/11.3.1/types/AddChainModifier.html
@@ -0,0 +1,2 @@
+
Type Alias AddChainModifier<Modifiers, AddedModifier>Internal
Add
? AddedModifier
: Modifiers | AddedModifier
? AddedModifier
: Modifiers | AddedModifier
Adds a modifier to a list of client chain modifiers.
+Type Parameters
- Modifiers extends ChainModifiers
- AddedModifier extends Exclude<ChainModifiers, undefined>
Type Alias AssetCollection<Modifiers, Locales>
A collection of assets
+Type Parameters
- Modifiers extends ChainModifiers = ChainModifiers
The chain modifiers used to configure the client. They’re set automatically when using the client chain modifiers.
+ - Locales extends LocaleCode = LocaleCode
If provided for a client using
+allLocalesmodifier, response type defines locale keys for asset field values.
Type Alias AssetFieldsFileDetailsQueries
Asset
All queries appliable to asset file details fields
+Type Alias AssetFieldsFileQueries
Asset
All queries appliable to asset file fields
+Type Alias AssetFieldsQueries<Fields>
Asset
All queries appliable to asset fields
+Type Parameters
- Fields extends FieldsType
Shape of asset fields used to calculate dynamic keys
+
Type Alias AssetKey
Asset
policy: string;
secret: string;
}
policy: string;
secret: string;
}
diff --git a/contentful/11.3.1/types/AssetMimeType.html b/contentful/11.3.1/types/AssetMimeType.html
new file mode 100644
index 000000000..d136021e2
--- /dev/null
+++ b/contentful/11.3.1/types/AssetMimeType.html
@@ -0,0 +1 @@
+
Type Alias AssetMimeType
Asset
| "attachment"
| "plaintext"
| "image"
| "audio"
| "video"
| "richtext"
| "presentation"
| "spreadsheet"
| "pdfdocument"
| "archive"
| "code"
| "markup"
| "attachment"
| "plaintext"
| "image"
| "audio"
| "video"
| "richtext"
| "presentation"
| "spreadsheet"
| "pdfdocument"
| "archive"
| "code"
| "markup"
Type Alias AssetOrderFilterInternal
Asset
order?: (
| OrderFilterPaths<AssetSys, "sys">
| "fields.file.contentType"
| "-fields.file.contentType"
| "fields.file.fileName"
| "-fields.file.fileName"
| "fields.file.url"
| "-fields.file.url"
| "fields.file.details.size"
| "-fields.file.details.size")[];
}
order?: (
| OrderFilterPaths<AssetSys, "sys">
| "fields.file.contentType"
| "-fields.file.contentType"
| "fields.file.fileName"
| "-fields.file.fileName"
| "fields.file.url"
| "-fields.file.url"
| "fields.file.details.size"
| "-fields.file.details.size")[];
}
Order in an asset
+Type Alias AssetQueries<Modifiers>
Search parameters for a single asset methods
+Type Parameters
- Modifiers extends ChainModifiers
The chain modifiers used to configure the client. They’re set automatically when using the client chain modifiers.
+
Type Alias AssetSelectFilter<Fields>Internal
Asset
select?: (
| "sys"
| SelectFilterPaths<AssetSys, "sys">
| "fields"
| SelectFilterPaths<Fields, "fields">
| "metadata"
| SelectFilterPaths<Metadata, "metadata">)[];
}
select?: (
| "sys"
| SelectFilterPaths<AssetSys, "sys">
| "fields"
| SelectFilterPaths<Fields, "fields">
| "metadata"
| SelectFilterPaths<Metadata, "metadata">)[];
}
Select fields in an asset
+Type Parameters
- Fields extends FieldsType
diff --git a/contentful/11.3.1/types/AssetsQueries.html b/contentful/11.3.1/types/AssetsQueries.html
new file mode 100644
index 000000000..c9c220173
--- /dev/null
+++ b/contentful/11.3.1/types/AssetsQueries.html
@@ -0,0 +1,4 @@
+
Type Alias AssetsQueries<Fields, Modifiers>
Assets
| "createdAt"
| "updatedAt"
| "revision"
| "id"
| "type">> & MetadataTagsQueries & FixedQueryOptions & FixedPagedOptions & {
mimetype_group?: AssetMimeType;
} & ("WITH_ALL_LOCALES" extends Modifiers
? {}
: LocaleOption)
| "createdAt"
| "updatedAt"
| "revision"
| "id"
| "type">> & MetadataTagsQueries & FixedQueryOptions & FixedPagedOptions & {
mimetype_group?: AssetMimeType;
} & ("WITH_ALL_LOCALES" extends Modifiers
? {}
: LocaleOption)
Search parameters for asset collection methods
+Type Parameters
- Fields extends FieldsType
- Modifiers extends ChainModifiers
The chain modifiers used to configure the client. They’re set automatically when using the client chain modifiers.
+
Type Alias BaseFieldMap<Field>
Base
? EntryFields.Symbol<Values>
: Field extends EntryFieldTypes.Text<infer Values>
? EntryFields.Text<Values>
: Field extends EntryFieldTypes.Integer<infer Values>
? EntryFields.Integer<Values>
: Field extends EntryFieldTypes.Number<infer Values>
? EntryFields.Number<Values>
: Field extends EntryFieldTypes.Date
? EntryFields.Date
: Field extends EntryFieldTypes.Boolean
? EntryFields.Boolean
: Field extends EntryFieldTypes.Location
? EntryFields.Location
: Field extends EntryFieldTypes.RichText
? EntryFields.RichText
: Field extends EntryFieldTypes.Object<infer Data>
? EntryFields.Object<Data>
: never
? EntryFields.Symbol<Values>
: Field extends EntryFieldTypes.Text<infer Values>
? EntryFields.Text<Values>
: Field extends EntryFieldTypes.Integer<infer Values>
? EntryFields.Integer<Values>
: Field extends EntryFieldTypes.Number<infer Values>
? EntryFields.Number<Values>
: Field extends EntryFieldTypes.Date
? EntryFields.Date
: Field extends EntryFieldTypes.Boolean
? EntryFields.Boolean
: Field extends EntryFieldTypes.Location
? EntryFields.Location
: Field extends EntryFieldTypes.RichText
? EntryFields.RichText
: Field extends EntryFieldTypes.Object<infer Data>
? EntryFields.Object<Data>
: never
Mapping between abstract entry field types with additional type information +and entry field types
+Type Parameters
- Field extends EntryFieldType<EntrySkeletonType>
Type Alias BoundingBoxSearchFilterInput
Bounding
Type Alias BoundingCircleSearchFilterInput
Bounding
Type Alias BoundingObjectSearchFilter<Fields, Prefix>Internal
Bounding
within - location in a bounding object in provided fields
+Type Parameters
Type Alias ChainModifiersInternal
Chain
| "WITH_ALL_LOCALES"
| "WITHOUT_LINK_RESOLUTION"
| "WITHOUT_UNRESOLVABLE_LINKS"
| undefined
| "WITH_ALL_LOCALES"
| "WITHOUT_LINK_RESOLUTION"
| "WITHOUT_UNRESOLVABLE_LINKS"
| undefined
Client chain modifiers used in all types that depend on the client configuration.
+Type Alias ClientLogLevel
Client
| "error"
| "warning"
| "info"
| string
| "error"
| "warning"
| "info"
| string
Type Alias ConceptCollection<Locale>
Concept
items: Concept<Locale>[];
limit: number;
pages?: {
next?: string;
prev?: string;
};
sys: {
type: "Array";
};
}
items: Concept<Locale>[];
limit: number;
pages?: {
next?: string;
prev?: string;
};
sys: {
type: "Array";
};
}
Type Parameters
- Locale extends LocaleCode
Type Alias ConceptSchemeCollection<Locale>
Concept
items: ConceptScheme<Locale>[];
limit: number;
pages?: {
next?: string;
prev?: string;
};
sys: {
type: "Array";
};
}
items: ConceptScheme<Locale>[];
limit: number;
pages?: {
next?: string;
prev?: string;
};
sys: {
type: "Array";
};
}
Type Parameters
- Locale extends LocaleCode
Type Alias ConceptSchemeSys
Concept
createdAt: ISODateString;
id: string;
type: "TaxonomyConceptScheme";
updatedAt: ISODateString;
version: number;
}
createdAt: ISODateString;
id: string;
type: "TaxonomyConceptScheme";
updatedAt: ISODateString;
version: number;
}
Type Alias ConceptSchemesQueries
Type Alias ConceptSys
Concept
createdAt: ISODateString;
id: string;
type: "TaxonomyConcept";
updatedAt: ISODateString;
version: number;
}
createdAt: ISODateString;
id: string;
type: "TaxonomyConcept";
updatedAt: ISODateString;
version: number;
}
Type Alias ConceptsQueries
Type Alias ConditionalFixedQueries<Fields, SupportedTypes, ValueType, Prefix, QueryFilter>
Conditional
[FieldName in keyof ConditionalPick<Fields, SupportedTypes> as `${Prefix}.${string & FieldName}${QueryFilter}`]?: ValueType
}
[FieldName in keyof ConditionalPick<Fields, SupportedTypes> as `${Prefix}.${string & FieldName}${QueryFilter}`]?: ValueType
}
Type Parameters
- Fields extends FieldsType
- SupportedTypes
- ValueType
- Prefix extends string
- QueryFilter extends string = ""
Type Alias ConditionalListQueries<Fields, SupportedTypes, Prefix, QueryFilter>
Conditional
[FieldName in keyof ConditionalPick<Fields, SupportedTypes> as `${Prefix}.${string & FieldName}${QueryFilter}`]?: NonNullable<BaseOrArrayType<Fields[FieldName]>>[]
}
[FieldName in keyof ConditionalPick<Fields, SupportedTypes> as `${Prefix}.${string & FieldName}${QueryFilter}`]?: NonNullable<BaseOrArrayType<Fields[FieldName]>>[]
}
Type Parameters
Type Alias ContentTypeCollection
Collection of content types
+Type Alias ContentTypeFieldType
Content
| "Symbol"
| "Text"
| "Integer"
| "Number"
| "Date"
| "Boolean"
| "Location"
| "Link"
| "Array"
| "Object"
| "RichText"
| "ResourceLink"
| "Symbol"
| "Text"
| "Integer"
| "Number"
| "Date"
| "Boolean"
| "Location"
| "Link"
| "Array"
| "Object"
| "RichText"
| "ResourceLink"
diff --git a/contentful/11.3.1/types/DeletedAsset.html b/contentful/11.3.1/types/DeletedAsset.html
new file mode 100644
index 000000000..e7267921a
--- /dev/null
+++ b/contentful/11.3.1/types/DeletedAsset.html
@@ -0,0 +1,2 @@
+
Type Alias DeletedAsset
System managed metadata for deleted assets
+Type Alias DeletedEntry
System managed metadata for deleted entries
+Type Alias EntriesQueries<EntrySkeleton, Modifiers>
Entries
| "createdAt"
| "updatedAt"
| "revision"
| "id"
| "type">> & MetadataTagsQueries & MetadataConceptsQueries & EntrySelectFilter & EntryOrderFilter & FixedQueryOptions & FixedPagedOptions & FixedLinkOptions & ("WITH_ALL_LOCALES" extends Modifiers
? {}
: LocaleOption)
| "createdAt"
| "updatedAt"
| "revision"
| "id"
| "type">> & MetadataTagsQueries & MetadataConceptsQueries & EntrySelectFilter & EntryOrderFilter & FixedQueryOptions & FixedPagedOptions & FixedLinkOptions & ("WITH_ALL_LOCALES" extends Modifiers
? {}
: LocaleOption)
Search parameters for entry collection methods
+Type Parameters
- EntrySkeleton extends EntrySkeletonType
Shape of an entry used to calculate dynamic keys
+ - Modifiers extends ChainModifiers
The chain modifiers used to configure the client. They’re set automatically when using the client chain modifiers.
+
Type Alias Entry<EntrySkeleton, Modifiers, Locales>
Entry<EntrySkeleton, Modifiers, Locales>: BaseEntry & {
fields: ChainModifiers extends Modifiers
? {
[FieldName in keyof EntrySkeleton["fields"]]: {
[LocaleName in Locales]?: ResolvedField<EntrySkeleton["fields"][FieldName], Modifiers, Locales>
}
} | {
[FieldName in keyof EntrySkeleton["fields"]]: ResolvedField<EntrySkeleton["fields"][FieldName], Modifiers, Locales>
}
: "WITH_ALL_LOCALES" extends Modifiers
? {
[FieldName in keyof EntrySkeleton["fields"]]: {
[LocaleName in Locales]?: ResolvedField<EntrySkeleton["fields"][FieldName], Modifiers, Locales>
}
}
: {
[FieldName in keyof EntrySkeleton["fields"]]: ResolvedField<EntrySkeleton["fields"][FieldName], Modifiers, Locales>
};
sys: {
contentType: {
sys: {
id: EntrySkeleton["contentTypeId"];
};
};
};
}
fields: ChainModifiers extends Modifiers
? {
[FieldName in keyof EntrySkeleton["fields"]]: {
[LocaleName in Locales]?: ResolvedField<EntrySkeleton["fields"][FieldName], Modifiers, Locales>
}
} | {
[FieldName in keyof EntrySkeleton["fields"]]: ResolvedField<EntrySkeleton["fields"][FieldName], Modifiers, Locales>
}
: "WITH_ALL_LOCALES" extends Modifiers
? {
[FieldName in keyof EntrySkeleton["fields"]]: {
[LocaleName in Locales]?: ResolvedField<EntrySkeleton["fields"][FieldName], Modifiers, Locales>
}
}
: {
[FieldName in keyof EntrySkeleton["fields"]]: ResolvedField<EntrySkeleton["fields"][FieldName], Modifiers, Locales>
};
sys: {
contentType: {
sys: {
id: EntrySkeleton["contentTypeId"];
};
};
};
}
Entry represents anything defined as a Content Type in a space
+Type Parameters
- EntrySkeleton extends EntrySkeletonType = EntrySkeletonType
Shape of entry fields used to calculate dynamic keys
+ - Modifiers extends ChainModifiers = ChainModifiers
The chain modifiers used to configure the client. They’re set automatically when using the client chain modifiers.
+ - Locales extends LocaleCode = LocaleCode
If provided for a client using
+allLocalesmodifier, response type defines locale keys for entry field values.
Type Alias EntryCollection<EntrySkeleton, Modifiers, Locales>
Entry
errors?: any[];
includes?: {
Asset?: Asset<Modifiers, Locales>[];
Entry?: Entry<EntrySkeletonType, Modifiers, Locales>[];
};
}
errors?: any[];
includes?: {
Asset?: Asset<Modifiers, Locales>[];
Entry?: Entry<EntrySkeletonType, Modifiers, Locales>[];
};
}
A collection of entries
+Type Parameters
- EntrySkeleton extends EntrySkeletonType
Shape of entry fields used to calculate dynamic keys
+ - Modifiers extends ChainModifiers = ChainModifiers
The chain modifiers used to configure the client. They’re set automatically when using the client chain modifiers.
+ - Locales extends LocaleCode = LocaleCode
If provided for a client using
+allLocalesmodifier, response type defines locale keys for entry field values.
diff --git a/contentful/11.3.1/types/EntryField.html b/contentful/11.3.1/types/EntryField.html
new file mode 100644
index 000000000..0b2f37c92
--- /dev/null
+++ b/contentful/11.3.1/types/EntryField.html
@@ -0,0 +1,2 @@
+
Type Alias EntryField<EntrySkeleton>
Entry
| EntryFields.Symbol
| EntryFields.Text
| EntryFields.Integer
| EntryFields.Number
| EntryFields.Date
| EntryFields.Boolean
| EntryFields.Location
| EntryFields.RichText
| EntryFields.Object
| EntryFields.EntryLink<EntrySkeleton>
| EntryFields.AssetLink
| EntryFields.Array<EntryFields.Symbol>
| EntryFields.Array<EntryFields.AssetLink>
| EntryFields.Array<EntryFields.EntryLink<EntrySkeleton>>
| EntryFields.Symbol
| EntryFields.Text
| EntryFields.Integer
| EntryFields.Number
| EntryFields.Date
| EntryFields.Boolean
| EntryFields.Location
| EntryFields.RichText
| EntryFields.Object
| EntryFields.EntryLink<EntrySkeleton>
| EntryFields.AssetLink
| EntryFields.Array<EntryFields.Symbol>
| EntryFields.Array<EntryFields.AssetLink>
| EntryFields.Array<EntryFields.EntryLink<EntrySkeleton>>
All possible values for entry field types
+Type Parameters
- EntrySkeleton extends EntrySkeletonType
Type Alias EntryFieldType<EntrySkeleton>
Entry
| EntryFieldTypes.Symbol
| EntryFieldTypes.Text
| EntryFieldTypes.Integer
| EntryFieldTypes.Number
| EntryFieldTypes.Date
| EntryFieldTypes.Boolean
| EntryFieldTypes.Location
| EntryFieldTypes.RichText
| EntryFieldTypes.Object
| EntryFieldTypes.EntryLink<EntrySkeleton>
| EntryResourceLink<EntrySkeleton>
| ExternalResourceLink
| EntryFieldTypes.AssetLink
| EntryFieldTypes.Array<EntryFieldTypes.Symbol>
| EntryFieldTypes.Array<EntryFieldTypes.AssetLink>
| EntryFieldTypes.Array<EntryFieldTypes.EntryLink<EntrySkeleton>>
| EntryFieldTypes.Array<EntryResourceLink<EntrySkeleton> | ExternalResourceLink>
| EntryFieldTypes.Symbol
| EntryFieldTypes.Text
| EntryFieldTypes.Integer
| EntryFieldTypes.Number
| EntryFieldTypes.Date
| EntryFieldTypes.Boolean
| EntryFieldTypes.Location
| EntryFieldTypes.RichText
| EntryFieldTypes.Object
| EntryFieldTypes.EntryLink<EntrySkeleton>
| EntryResourceLink<EntrySkeleton>
| ExternalResourceLink
| EntryFieldTypes.AssetLink
| EntryFieldTypes.Array<EntryFieldTypes.Symbol>
| EntryFieldTypes.Array<EntryFieldTypes.AssetLink>
| EntryFieldTypes.Array<EntryFieldTypes.EntryLink<EntrySkeleton>>
| EntryFieldTypes.Array<EntryResourceLink<EntrySkeleton> | ExternalResourceLink>
All possible values for entry field types with additional type properties
+Type Parameters
- EntrySkeleton extends EntrySkeletonType
Type Alias Array<Item>
Type Parameters
Type Alias AssetLink
Asset
type: "AssetLink";
}
type: "AssetLink";
}
Type Alias Boolean
Boolean: {
type: "Boolean";
}
type: "Boolean";
}
Type Alias Date
Date: {
type: "Date";
}
type: "Date";
}
Type Alias EntryLink<EntrySkeleton>
Type Parameters
- EntrySkeleton extends EntrySkeletonType
Type Alias EntryResourceLink<EntrySkeleton>
Type Parameters
- EntrySkeleton extends EntrySkeletonType
Type Alias ExternalResourceLink
External
type: "ExternalResourceLink";
}
type: "ExternalResourceLink";
}
diff --git a/contentful/11.3.1/types/EntryFieldTypes.Location.html b/contentful/11.3.1/types/EntryFieldTypes.Location.html
new file mode 100644
index 000000000..b2ca1fc71
--- /dev/null
+++ b/contentful/11.3.1/types/EntryFieldTypes.Location.html
@@ -0,0 +1 @@
+
Type Alias Location
Location: {
type: "Location";
}
type: "Location";
}
diff --git a/contentful/11.3.1/types/EntryFieldTypes.Object.html b/contentful/11.3.1/types/EntryFieldTypes.Object.html
new file mode 100644
index 000000000..1d90e9783
--- /dev/null
+++ b/contentful/11.3.1/types/EntryFieldTypes.Object.html
@@ -0,0 +1 @@
+
diff --git a/contentful/11.3.1/types/EntryFieldTypes.RichText.html b/contentful/11.3.1/types/EntryFieldTypes.RichText.html
new file mode 100644
index 000000000..cf6bf1259
--- /dev/null
+++ b/contentful/11.3.1/types/EntryFieldTypes.RichText.html
@@ -0,0 +1 @@
+
Type Alias RichText
Rich
type: "RichText";
}
type: "RichText";
}
diff --git a/contentful/11.3.1/types/EntryFieldTypes.Text.html b/contentful/11.3.1/types/EntryFieldTypes.Text.html
new file mode 100644
index 000000000..daaf9da6d
--- /dev/null
+++ b/contentful/11.3.1/types/EntryFieldTypes.Text.html
@@ -0,0 +1 @@
+
diff --git a/contentful/11.3.1/types/EntryFields.Array.html b/contentful/11.3.1/types/EntryFields.Array.html
new file mode 100644
index 000000000..54fbfb65b
--- /dev/null
+++ b/contentful/11.3.1/types/EntryFields.Array.html
@@ -0,0 +1 @@
+
Type Alias Array<Item>
Type Parameters
- Item extends EntryFields.Symbol | EntryFields.AssetLink | EntryFields.EntryLink<EntrySkeletonType>
Type Alias AssetLink
Type Alias Boolean
Boolean: boolean
Type Alias Date
Date: `${number}-${number}-${number}T${number}:${number}:${number}Z`
Type Alias EntryLink<EntrySkeleton>
Type Parameters
- EntrySkeleton extends EntrySkeletonType
Type Alias Link<EntrySkeleton>
Type Parameters
- EntrySkeleton extends EntrySkeletonType
Type Alias Location
Location: {
lat: number;
lon: number;
}
lat: number;
lon: number;
}
diff --git a/contentful/11.3.1/types/EntryFields.RichText.html b/contentful/11.3.1/types/EntryFields.RichText.html
new file mode 100644
index 000000000..0dc0c5eb1
--- /dev/null
+++ b/contentful/11.3.1/types/EntryFields.RichText.html
@@ -0,0 +1 @@
+
Type Alias RichText
Rich
Type Alias EntryFieldsEqualityFilter<Fields, Prefix>Internal
Entry
Equality filters in provided fields of an entry - search for exact matches
+Type Parameters
- Fields extends Record<string, EntryFieldType<EntrySkeletonType>>
- Prefix extends string
Type Alias EntryFieldsExistenceFilter<Fields, Prefix>Internal
Entry
Check for existence of provided fields in an entry
+Type Parameters
- Fields extends FieldsType
- Prefix extends string
Type Alias EntryFieldsFullTextSearchFilters<Fields, Prefix>Internal
Entry
match - full text search in provided fields of an entry
+Type Parameters
- Fields extends FieldsType
- Prefix extends string
Type Alias EntryFieldsInequalityFilter<Fields, Prefix>Internal
Entry
Inequality filters in provided fields of an entry - exclude matching items
+Type Parameters
- Fields extends Record<string, EntryFieldType<EntrySkeletonType>>
- Prefix extends string
Type Alias EntryFieldsQueries<Fields>
Entry
| EntrySelectFilterWithFields<Fields>
| EntryOrderFilterWithFields<Fields>
| EntryFieldsExistenceFilter<Fields, "fields">
| EntryFieldsEqualityFilter<Fields, "fields">
| EntryFieldsInequalityFilter<Fields, "fields">
| EntryFieldsFullTextSearchFilters<Fields, "fields">
| EntryFieldsSubsetFilters<Fields, "fields">
| EntryFieldsSetFilter<Fields, "fields">
| LocationSearchFilters<Fields, "fields">
| EntryFieldsRangeFilters<Fields, "fields">
| ReferenceSearchFilters<Fields, "fields">
| EntrySelectFilterWithFields<Fields>
| EntryOrderFilterWithFields<Fields>
| EntryFieldsExistenceFilter<Fields, "fields">
| EntryFieldsEqualityFilter<Fields, "fields">
| EntryFieldsInequalityFilter<Fields, "fields">
| EntryFieldsFullTextSearchFilters<Fields, "fields">
| EntryFieldsSubsetFilters<Fields, "fields">
| EntryFieldsSetFilter<Fields, "fields">
| LocationSearchFilters<Fields, "fields">
| EntryFieldsRangeFilters<Fields, "fields">
| ReferenceSearchFilters<Fields, "fields">
All queries applicable to entry fields
+Type Parameters
- Fields extends FieldsType
Shape of entry fields used to calculate dynamic keys
+
Type Alias EntryFieldsRangeFilters<Fields, Prefix>Internal
Entry
Range operators appliable to date and number fields in an entry
+Type Parameters
- Fields extends Record<string, EntryFieldType<EntrySkeletonType>>
- Prefix extends string
Type Alias EntryFieldsSetFilter<Fields, Prefix>Internal
Entry
Match multiple values in provided fields of an entry
+Type Parameters
- Fields extends Record<string, EntryFieldType<any>>
- Prefix extends string
Type Alias EntryFieldsSubsetFilters<Fields, Prefix>Internal
Entry
Subset filters for inclusion & exclusion in provided fields of an entry
+Type Parameters
- Fields extends Record<string, EntryFieldType<any>>
- Prefix extends string
diff --git a/contentful/11.3.1/types/EntryOrderFilter.html b/contentful/11.3.1/types/EntryOrderFilter.html
new file mode 100644
index 000000000..cf0cf1e38
--- /dev/null
+++ b/contentful/11.3.1/types/EntryOrderFilter.html
@@ -0,0 +1,3 @@
+
Type Alias EntryOrderFilterInternal
Entry
order?: (OrderFilterPaths<EntrySys, "sys"> | "sys.contentType.sys.id" | "-sys.contentType.sys.id")[];
}
order?: (OrderFilterPaths<EntrySys, "sys"> | "sys.contentType.sys.id" | "-sys.contentType.sys.id")[];
}
Order in an entry
+Type Alias EntryOrderFilterWithFields<Fields>Internal
Entry
order?: (
| `fields.${keyof ConditionalPick<Fields, SupportedEntryFieldTypes> & string}`
| `-fields.${keyof ConditionalPick<Fields, SupportedEntryFieldTypes> & string}`
| `fields.${keyof ConditionalPick<Fields, SupportedLinkTypes> & string}.sys.id`
| `-fields.${keyof ConditionalPick<Fields, SupportedLinkTypes> & string}.sys.id`
| OrderFilterPaths<EntrySys, "sys">
| "sys.contentType.sys.id"
| "-sys.contentType.sys.id")[];
}
order?: (
| `fields.${keyof ConditionalPick<Fields, SupportedEntryFieldTypes> & string}`
| `-fields.${keyof ConditionalPick<Fields, SupportedEntryFieldTypes> & string}`
| `fields.${keyof ConditionalPick<Fields, SupportedLinkTypes> & string}.sys.id`
| `-fields.${keyof ConditionalPick<Fields, SupportedLinkTypes> & string}.sys.id`
| OrderFilterPaths<EntrySys, "sys">
| "sys.contentType.sys.id"
| "-sys.contentType.sys.id")[];
}
Order for provided fields in an entry
+Type Parameters
- Fields extends Record<string, EntryFieldType<EntrySkeletonType>>
Type Alias EntryQueries<Modifiers>
Entry
? {}
: LocaleOption)
? {}
: LocaleOption)
Search parameters for a single entry methods
+Type Parameters
- Modifiers extends ChainModifiers
The chain modifiers used to configure the client. They’re set automatically when using the client chain modifiers.
+
Type Alias EntrySelectFilterInternal
Entry
select?: (
| "sys"
| "fields"
| "metadata"
| SelectFilterPaths<EntrySys, "sys">
| SelectFilterPaths<Metadata, "metadata">)[];
}
select?: (
| "sys"
| "fields"
| "metadata"
| SelectFilterPaths<EntrySys, "sys">
| SelectFilterPaths<Metadata, "metadata">)[];
}
Select fields in an entry
+Type Alias EntrySelectFilterWithFields<Fields>Internal
Entry
select?: (
| "sys"
| "fields"
| "metadata"
| SelectFilterPaths<EntrySys, "sys">
| SelectFilterPaths<Fields, "fields">
| SelectFilterPaths<Metadata, "metadata">)[];
}
select?: (
| "sys"
| "fields"
| "metadata"
| SelectFilterPaths<EntrySys, "sys">
| SelectFilterPaths<Fields, "fields">
| SelectFilterPaths<Metadata, "metadata">)[];
}
Select fields from provided fields in an entry
+Type Parameters
- Fields extends FieldsType
Type Alias EntrySkeletonType<Fields, Id>
Type Parameters
- Fields extends FieldsType = FieldsType
- Id = string
diff --git a/contentful/11.3.1/types/EqualityFilter.html b/contentful/11.3.1/types/EqualityFilter.html
new file mode 100644
index 000000000..b5349a21e
--- /dev/null
+++ b/contentful/11.3.1/types/EqualityFilter.html
@@ -0,0 +1,3 @@
+
diff --git a/contentful/11.3.1/types/ExistenceFilter.html b/contentful/11.3.1/types/ExistenceFilter.html
new file mode 100644
index 000000000..a4057fa77
--- /dev/null
+++ b/contentful/11.3.1/types/ExistenceFilter.html
@@ -0,0 +1,3 @@
+
Type Alias ExistenceFilter<Fields, Prefix>Internal
Existence
| EntryField<EntrySkeletonType<Fields>>
| AssetFile
| AssetDetails
| undefined, boolean, Prefix, "[exists]">
| EntryField<EntrySkeletonType<Fields>>
| AssetFile
| AssetDetails
| undefined, boolean, Prefix, "[exists]">
Check for existence of provided fields
+Type Parameters
- Fields extends FieldsType
- Prefix extends string
Type Alias FieldsType
Fields
Type Alias FixedLinkOptions
Fixed
links_to_asset?: string;
links_to_entry?: string;
}
links_to_asset?: string;
links_to_entry?: string;
}
Type Alias FixedPagedOptions
Fixed
limit?: number;
skip?: number;
}
limit?: number;
skip?: number;
}
Type Alias FixedQueryOptions
Fixed
include?:
| 0
| 1
| 2
| 3
| 4
| 5
| 6
| 7
| 8
| 9
| 10;
query?: string;
}
include?:
| 0
| 1
| 2
| 3
| 4
| 5
| 6
| 7
| 8
| 9
| 10;
query?: string;
}
Type Alias FullTextSearchFilters<Fields, Prefix>Internal
Full
match - full text search in provided fields
+Type Parameters
- Fields extends FieldsType
- Prefix extends string
Type Alias GetGlobalOptions
diff --git a/contentful/11.3.1/types/LinkType.html b/contentful/11.3.1/types/LinkType.html
new file mode 100644
index 000000000..d4463ed51
--- /dev/null
+++ b/contentful/11.3.1/types/LinkType.html
@@ -0,0 +1 @@
+
Type Alias LinkType
Link
| "Space"
| "ContentType"
| "Environment"
| "Entry"
| "Tag"
| "User"
| "Asset"
| "TaxonomyConcept"
| "Space"
| "ContentType"
| "Environment"
| "Entry"
| "Tag"
| "User"
| "Asset"
| "TaxonomyConcept"
Type Alias LocaleCode
Locale
diff --git a/contentful/11.3.1/types/LocaleOption.html b/contentful/11.3.1/types/LocaleOption.html
new file mode 100644
index 000000000..ea55f10a9
--- /dev/null
+++ b/contentful/11.3.1/types/LocaleOption.html
@@ -0,0 +1 @@
+
Type Alias LocaleOption
Locale
locale?: string;
}
locale?: string;
}
Type Alias LocationSearchFilters<Fields, Prefix>Internal
Location
Location search
+Type Parameters
Type Alias Metadata
User-controlled metadata
+Type Alias MetadataConceptsQueries
Metadata
| ConditionalFixedQueries<Pick<Metadata, "concepts">, any, boolean, "metadata", "[exists]">
| ConditionalListQueries<Pick<TaxonomyConceptLink, "id">, any, "metadata.concepts.sys", "[all]">
| ConditionalListQueries<Pick<TaxonomyConceptLink, "id">, any, "metadata.concepts.sys", "[in]">
| ConditionalListQueries<Pick<TaxonomyConceptLink, "id">, any, "metadata.concepts.sys", "[nin]">
| ConditionalListQueries<{
descendants: string;
}, any, "metadata.concepts", "[in]">
| ConditionalFixedQueries<Pick<Metadata, "concepts">, any, boolean, "metadata", "[exists]">
| ConditionalListQueries<Pick<TaxonomyConceptLink, "id">, any, "metadata.concepts.sys", "[all]">
| ConditionalListQueries<Pick<TaxonomyConceptLink, "id">, any, "metadata.concepts.sys", "[in]">
| ConditionalListQueries<Pick<TaxonomyConceptLink, "id">, any, "metadata.concepts.sys", "[nin]">
| ConditionalListQueries<{
descendants: string;
}, any, "metadata.concepts", "[in]">
All queries applicable to metadata concepts fields
+Type Alias MetadataTagsQueries
Metadata
| ConditionalFixedQueries<Pick<Metadata, "tags">, any, boolean, "metadata", "[exists]">
| ConditionalListQueries<Pick<TagLink, "id">, any, "metadata.tags.sys", "[all]">
| ConditionalListQueries<Pick<TagLink, "id">, any, "metadata.tags.sys", "[in]">
| ConditionalListQueries<Pick<TagLink, "id">, any, "metadata.tags.sys", "[nin]">
| ConditionalFixedQueries<Pick<Metadata, "tags">, any, boolean, "metadata", "[exists]">
| ConditionalListQueries<Pick<TagLink, "id">, any, "metadata.tags.sys", "[all]">
| ConditionalListQueries<Pick<TagLink, "id">, any, "metadata.tags.sys", "[in]">
| ConditionalListQueries<Pick<TagLink, "id">, any, "metadata.tags.sys", "[nin]">
All queries applicable to metadata tags fields
+Type Alias OrderFilterPaths<Fields, Prefix>
Order
Type Parameters
- Fields extends FieldsType
- Prefix extends string
Type Alias ProximitySearchFilter<Fields, Prefix>Internal
Proximity
near - location proximity search in provided fields
+Type Parameters
Type Alias ProximitySearchFilterInput
Proximity
diff --git a/contentful/11.3.1/types/ReferenceSearchFilters.html b/contentful/11.3.1/types/ReferenceSearchFilters.html
new file mode 100644
index 000000000..120612deb
--- /dev/null
+++ b/contentful/11.3.1/types/ReferenceSearchFilters.html
@@ -0,0 +1,3 @@
+
diff --git a/contentful/11.3.1/types/ResolvedAssetLink.html b/contentful/11.3.1/types/ResolvedAssetLink.html
new file mode 100644
index 000000000..2464e95de
--- /dev/null
+++ b/contentful/11.3.1/types/ResolvedAssetLink.html
@@ -0,0 +1,7 @@
+
Type Alias ResolvedAssetLink<Modifiers, Locales>Internal
Resolved
? Asset<Modifiers, Locales> | UnresolvedLink<"Asset"> | undefined
: "WITHOUT_LINK_RESOLUTION" extends Modifiers
? UnresolvedLink<"Asset">
: "WITHOUT_UNRESOLVABLE_LINKS" extends Modifiers
? Asset<Modifiers, Locales> | undefined
: Asset<Modifiers, Locales> | UnresolvedLink<"Asset">
? Asset<Modifiers, Locales> | UnresolvedLink<"Asset"> | undefined
: "WITHOUT_LINK_RESOLUTION" extends Modifiers
? UnresolvedLink<"Asset">
: "WITHOUT_UNRESOLVABLE_LINKS" extends Modifiers
? Asset<Modifiers, Locales> | undefined
: Asset<Modifiers, Locales> | UnresolvedLink<"Asset">
A single resolved link to another asset
+If the current client configuration includes withoutLinkResolution chain option,
+the returned type will not resolve linked entities, but keep them as objects
+If the current client configuration includes withoutUnresolvableLinks chain option,
+the returned type will not include non-resolvable linked entities
Type Parameters
- Modifiers extends ChainModifiers
The chain modifiers used to configure the client. They’re set automatically when using the client chain modifiers.
+ - Locales extends LocaleCode
Type Alias ResolvedEntryLink<Modifiers, Locales, LinkedEntry>Internal
Resolved
? Entry<LinkedEntry, Modifiers, Locales> | UnresolvedLink<"Entry"> | undefined
: "WITHOUT_LINK_RESOLUTION" extends Modifiers
? UnresolvedLink<"Entry">
: "WITHOUT_UNRESOLVABLE_LINKS" extends Modifiers
? Entry<LinkedEntry, Modifiers, Locales> | undefined
: Entry<LinkedEntry, Modifiers, Locales> | UnresolvedLink<"Entry">
? Entry<LinkedEntry, Modifiers, Locales> | UnresolvedLink<"Entry"> | undefined
: "WITHOUT_LINK_RESOLUTION" extends Modifiers
? UnresolvedLink<"Entry">
: "WITHOUT_UNRESOLVABLE_LINKS" extends Modifiers
? Entry<LinkedEntry, Modifiers, Locales> | undefined
: Entry<LinkedEntry, Modifiers, Locales> | UnresolvedLink<"Entry">
A single resolved link to another entry in the same space
+If the current client configuration includes withoutLinkResolution chain option,
+the returned type will not resolve linked entities, but keep them as objects
+If the current client configuration includes withoutUnresolvableLinks chain option,
+the returned type will not include non-resolvable linked entities
Type Parameters
- Modifiers extends ChainModifiers
The chain modifiers used to configure the client. They’re set automatically when using the client chain modifiers.
+ - Locales extends LocaleCode
If provided for a client using
+allLocalesmodifier, response type defines locale keys for entry field values. - LinkedEntry extends EntrySkeletonType
Shape of the linked entry used to calculate dynamic keys
+
Type Alias ResolvedEntryResourceLink<Modifiers, Locales, LinkedEntry>Internal
Resolved
? Entry<LinkedEntry, Modifiers, Locales> | {
sys: ResourceLink;
} | undefined
: "WITHOUT_LINK_RESOLUTION" extends Modifiers
? {
sys: ResourceLink;
}
: "WITHOUT_UNRESOLVABLE_LINKS" extends Modifiers
? Entry<LinkedEntry, Modifiers, Locales> | undefined
: Entry<LinkedEntry, Modifiers, Locales> | {
sys: ResourceLink;
}
? Entry<LinkedEntry, Modifiers, Locales> | {
sys: ResourceLink;
} | undefined
: "WITHOUT_LINK_RESOLUTION" extends Modifiers
? {
sys: ResourceLink;
}
: "WITHOUT_UNRESOLVABLE_LINKS" extends Modifiers
? Entry<LinkedEntry, Modifiers, Locales> | undefined
: Entry<LinkedEntry, Modifiers, Locales> | {
sys: ResourceLink;
}
A single resolved reference link to another entry in a different space
+If the current client configuration includes withoutLinkResolution chain option,
+the returned type will not resolve linked entities, but keep them as objects
+If the current client configuration includes withoutUnresolvableLinks chain option,
+the returned type will not include non-resolvable linked entities
Type Parameters
- Modifiers extends ChainModifiers
The chain modifiers used to configure the client. They’re set automatically when using the client chain modifiers.
+ - Locales extends LocaleCode
If provided for a client using
+allLocalesmodifier, response type defines locale keys for entry field values. - LinkedEntry extends EntrySkeletonType
Shape of the linked entry used to calculate dynamic keys
+
Type Alias ResolvedField<Field, Modifiers, Locales>
Resolved
? ResolvedLink<Item, Modifiers, Locales>[]
: ResolvedLink<Field, Modifiers, Locales>
? ResolvedLink<Item, Modifiers, Locales>[]
: ResolvedLink<Field, Modifiers, Locales>
A collection or single resolved link to another resource
+Type Parameters
- Field extends EntryFieldType<EntrySkeletonType>
Shape of an entry used to calculate dynamic keys
+ - Modifiers extends ChainModifiers
The chain modifiers used to configure the client. They’re set automatically when using the client chain modifiers.
+ - Locales extends LocaleCode = LocaleCode
If provided for a client using
+allLocalesmodifier, response type defines locale keys for entry field values.
Type Alias ResolvedLink<Field, Modifiers, Locales>Internal
Resolved
? ResolvedEntryLink<Modifiers, Locales, LinkedEntry>
: Field extends EntryResourceLink<infer LinkedEntry>
? ResolvedEntryResourceLink<Modifiers, Locales, LinkedEntry>
: Field extends ExternalResourceLink
? {
sys: ResourceLink<string>;
}
: Field extends EntryFieldTypes.AssetLink
? ResolvedAssetLink<Modifiers, Locales>
: BaseFieldMap<Field>
? ResolvedEntryLink<Modifiers, Locales, LinkedEntry>
: Field extends EntryResourceLink<infer LinkedEntry>
? ResolvedEntryResourceLink<Modifiers, Locales, LinkedEntry>
: Field extends ExternalResourceLink
? {
sys: ResourceLink<string>;
}
: Field extends EntryFieldTypes.AssetLink
? ResolvedAssetLink<Modifiers, Locales>
: BaseFieldMap<Field>
A single resolved link to another resource
+Type Parameters
- Field extends EntryFieldType<EntrySkeletonType>
Shape of an entry used to calculate dynamic keys
+ - Modifiers extends ChainModifiers = ChainModifiers
The chain modifiers used to configure the client. They’re set automatically when using the client chain modifiers.
+ - Locales extends LocaleCode = LocaleCode
If provided for a client using
+allLocalesmodifier, response type defines locale keys for entry field values.
Type Alias SelectFilterPaths<Fields, Prefix>
Type Parameters
- Fields extends FieldsType
- Prefix extends string
diff --git a/contentful/11.3.1/types/SubsetFilters.html b/contentful/11.3.1/types/SubsetFilters.html
new file mode 100644
index 000000000..e31524c0b
--- /dev/null
+++ b/contentful/11.3.1/types/SubsetFilters.html
@@ -0,0 +1,6 @@
+
Type Alias SubsetFilters<Fields, Prefix>Internal
Subset
Subset filters for inclusion & exclusion in provided fields
+Type Parameters
Type Alias SupportedEntryFieldTypes
Supported
| EntryFieldTypes.Symbol
| EntryFieldTypes.Integer
| EntryFieldTypes.Number
| EntryFieldTypes.Date
| EntryFieldTypes.Boolean
| EntryFieldTypes.Location
| undefined
| EntryFieldTypes.Symbol
| EntryFieldTypes.Integer
| EntryFieldTypes.Number
| EntryFieldTypes.Date
| EntryFieldTypes.Boolean
| EntryFieldTypes.Location
| undefined
Type Alias SupportedLinkTypes
Type Alias SupportedTypes
Supported
| EntryFields.Symbol
| EntryFields.Integer
| EntryFields.Number
| EntryFields.Date
| EntryFields.Boolean
| EntryFields.Location
| undefined
| EntryFields.Symbol
| EntryFields.Integer
| EntryFields.Number
| EntryFields.Date
| EntryFields.Boolean
| EntryFields.Location
| undefined
Type Alias SyncEntities
diff --git a/contentful/11.3.1/types/SyncPageQuery.html b/contentful/11.3.1/types/SyncPageQuery.html
new file mode 100644
index 000000000..acfd297e3
--- /dev/null
+++ b/contentful/11.3.1/types/SyncPageQuery.html
@@ -0,0 +1 @@
+
Type Alias SyncPageQuery
Type Alias SyncPageResponse
Type Alias SyncQuery
Sync
initial?: true;
limit?: number;
nextPageToken?: string;
nextSyncToken?: string;
} & ({
content_type: string;
type: "Entry";
} | {
type?:
| "Asset"
| "Entry"
| "Deletion"
| "DeletedAsset"
| "DeletedEntry";
})
initial?: true;
limit?: number;
nextPageToken?: string;
nextSyncToken?: string;
} & ({
content_type: string;
type: "Entry";
} | {
type?:
| "Asset"
| "Entry"
| "Deletion"
| "DeletedAsset"
| "DeletedEntry";
})
Type Alias SyncResponse
Type Alias SysQueries<Sys>
Sys
All queries applicable to sys fields
+Type Parameters
- Sys extends FieldsType
Type Alias Tag
Properties for a single content tag definition
+
diff --git a/contentful/11.3.1/types/TagLink.html b/contentful/11.3.1/types/TagLink.html
new file mode 100644
index 000000000..feea929a8
--- /dev/null
+++ b/contentful/11.3.1/types/TagLink.html
@@ -0,0 +1,2 @@
+
diff --git a/contentful/11.3.1/types/TagNameFilters.html b/contentful/11.3.1/types/TagNameFilters.html
new file mode 100644
index 000000000..273d4be95
--- /dev/null
+++ b/contentful/11.3.1/types/TagNameFilters.html
@@ -0,0 +1 @@
+
Type Alias TagNameFilters
Tag
name?: string;
name[exists]?: boolean;
name[in]?: string[];
name[match]?: string;
name[ne]?: string;
name[nin]?: string[];
}
name?: string;
name[exists]?: boolean;
name[in]?: string[];
name[match]?: string;
name[ne]?: string;
name[nin]?: string[];
}
Type Alias TagQueries
Tag
| "createdAt"
| "updatedAt"
| "visibility"
| "id"
| "type">> & TagOrderFilter & FixedPagedOptions
| "createdAt"
| "updatedAt"
| "visibility"
| "id"
| "type">> & TagOrderFilter & FixedPagedOptions
Search parameters for a tag methods
+Type Alias TaxonomyConceptLink
Taxonomy Concept link type
+Type Alias TaxonomyOrderFilter
Taxonomy
order?: ("sys.createdAt" | "sys.updatedAt" | "prefLabel")[];
}
order?: ("sys.createdAt" | "sys.updatedAt" | "prefLabel")[];
}
diff --git a/contentful/11.3.1/types/UserLink.html b/contentful/11.3.1/types/UserLink.html
new file mode 100644
index 000000000..f926f1e80
--- /dev/null
+++ b/contentful/11.3.1/types/UserLink.html
@@ -0,0 +1,2 @@
+
diff --git a/contentful/latest/functions/createClient.html b/contentful/latest/functions/createClient.html
index bf4b4c4c4..ae33b1ec3 100644
--- a/contentful/latest/functions/createClient.html
+++ b/contentful/latest/functions/createClient.html
@@ -3,4 +3,4 @@
Create a client instance
+