Class RestAdapter
Implements
Index
Constructors
Methods
Constructors
constructor
- new
Rest Adapter(params): RestAdapter Parameters
- params: RestAdapterParams
Returns RestAdapter
Methods
make
- make
Request<R>(__namedParameters): Promise<R> Type Parameters
Parameters
- __namedParameters: MakeRequestOptions
Returns Promise<R>
Enumeration BulkActionStatus
Index
Enumeration Members
Enumeration ScheduledActionReferenceFilters
Index
Enumeration Members
diff --git a/contentful-management/11.40.3/enums/WorkflowStepPermissionAction.html b/contentful-management/11.40.3/enums/WorkflowStepPermissionAction.html
new file mode 100644
index 0000000000..ed6382e8a2
--- /dev/null
+++ b/contentful-management/11.40.3/enums/WorkflowStepPermissionAction.html
@@ -0,0 +1,4 @@
+
diff --git a/contentful-management/11.40.3/enums/WorkflowStepPermissionEffect.html b/contentful-management/11.40.3/enums/WorkflowStepPermissionEffect.html
new file mode 100644
index 0000000000..8439ad1c7a
--- /dev/null
+++ b/contentful-management/11.40.3/enums/WorkflowStepPermissionEffect.html
@@ -0,0 +1,3 @@
+
diff --git a/contentful-management/11.40.3/enums/WorkflowStepPermissionType.html b/contentful-management/11.40.3/enums/WorkflowStepPermissionType.html
new file mode 100644
index 0000000000..78fcc64072
--- /dev/null
+++ b/contentful-management/11.40.3/enums/WorkflowStepPermissionType.html
@@ -0,0 +1,3 @@
+
Enumeration WorkflowStepPermissionType
Index
Enumeration Members
diff --git a/contentful-management/11.40.3/functions/createClient.html b/contentful-management/11.40.3/functions/createClient.html
new file mode 100644
index 0000000000..abe6cfc39a
--- /dev/null
+++ b/contentful-management/11.40.3/functions/createClient.html
@@ -0,0 +1,7 @@
+
Function createClient
- create
Client(params): ClientAPI Create a client instance
+Parameters
- params: ClientOptions
Client initialization parameters
+
+ +const client = contentfulManagement.createClient({
accessToken: 'myAccessToken'
}) +
Returns ClientAPI
- params: ClientOptions
- create
Client(params, opts): PlainClientAPI Parameters
- params: ClientOptions
- opts: {
defaults?: DefaultParams;
type: "plain";
}Optionaldefaults?: DefaultParamstype: "plain"
Returns PlainClientAPI
- create
Client(params, opts): ClientAPI | PlainClientAPI Parameters
- params: ClientOptions
- opts: {
alphaFeatures: string[];
defaults?: DefaultParams;
type?: "plain";
}alpha
Features: string[] Optionaldefaults?: DefaultParamsOptionaltype?: "plain"
Returns ClientAPI | PlainClientAPI
Function fetchAll
- fetch
All<Params, Entity, F>(fetchFn, params): Promise<Entity[]> Parameters for endpoint methods that can be paginated are inconsistent,
+fetchAllwill only +work with the more common version of supplying the limit, skip, and pageNext parameters via a distinctqueryproperty in the +parameters.Type Parameters
Returns Promise<Entity[]>
Function isDraft
- is
Draft(data): boolean Parameters
- data: {
sys: MetaSysProps;
}sys: MetaSysProps
Returns boolean
- data: {
Function isPublished
- is
Published(data): boolean Parameters
- data: {
sys: MetaSysProps;
}sys: MetaSysProps
Returns boolean
- data: {
Function isUpdated
- is
Updated(data): boolean Parameters
- data: {
sys: MetaSysProps;
}sys: MetaSysProps
Returns boolean
- data: {
contentful-management.js - v11.40.3
Class Hierarchy
- DefaultElements
- AccessToken
- ApiKey
- AppAccessToken
- AppActionCall
- AppBundle
- AppDetails
- AppEventSubscription
- AppInstallation
- AppKey
- AppSignedRequest
- AppSigningSecret
- AppUpload
- Asset
- AssetKey
- BulkAction
- Comment
- ContentType
- EditorInterface
- Entry
- EnvironmentAlias
- UIExtension
- Locale
- OrganizationInvitation
- OrganizationMembership
- PersonalAccessToken
- PreviewApiKey
- Release
- ReleaseAction
- Role
- ScheduledAction
- Snapshot
- SpaceMember
- SpaceMembership
- Tag
- Task
- Team
- TeamMembership
- TeamSpaceMembership
- UIConfig
- Upload
- UploadCredential
- Usage
- User
- UserUIConfig
- WebHooks
- WorkflowDefinition
- ResourceProvider
- ResourceType
- Workflow
- WorkflowsChangelogEntry
- Collection
- CursorPaginatedCollection
- AccessToken
contentful-management.js - v11.40.3
+accessToken (required, when
host (default:
hostUpload (default:
httpAgent (default:
httpsAgent (default:
headers (default:
proxy (default:
retryOnError (default:
logHandler (default:
requestLogger (default:
responseLogger (default:
apiAdapter (default:
throttle (default:
+
+ 
+
+
Content Management API
+JavaScript
++ Readme · + Setup · + Migration · + Changelog · + Contributing +
+
+
+ 
+
+
Introduction
+
+
+
+
What is Contentful?
+Contentful provides a content infrastructure for digital teams to power content in websites, apps, and devices. Unlike a CMS, Contentful was built to integrate with the modern software stack. It offers a central hub for structured content, powerful management and delivery APIs, and a customizable web app that enable developers and content creators to ship digital products faster.
+
+
+Table of contents
+ + + +Features
-
+
- Content management and retrieval through Contentful's Content Management API. +
- Built in rate limiting with recovery procedures +
- Asset processing helpers +
Supported environments
Browsers and Node.js:
+-
+
- Chrome +
- Firefox +
- Edge +
- Safari +
- node.js (LTS) +
Other browsers should also work, but at the moment we're only running automated tests on the browsers and Node.js versions specified above.
+Getting started
To get started with the Contentful Management JS library you'll need to install it, and then get credentials which will allow you to access your content in Contentful.
+-
+
- Installation +
- Authentication +
- Using ES6 import +
- Your first request +
- Troubleshooting +
- Documentation/References +
Installation
Node:
Using npm:
+npm install contentful-management
+Using yarn:
+yarn add contentful-management
+Browser:
For browsers, we recommend to download the library via npm or yarn to ensure 100% availability.
+If you'd like to use a standalone built file you can use the following script tag or download it from jsDelivr, under the dist directory:
<script src="https://cdn.jsdelivr.net/npm/contentful-management@latest/dist/contentful-management.browser.min.js"></script>
+It's not recommended to use the above URL for production.
+Using contentful@latest will always get you the latest version, but you can also specify a specific version number:
<!-- Avoid using the following url for production. You can not rely on its availability. -->
<script src="https://cdn.jsdelivr.net/npm/contentful-management@7.3.0/dist/contentful-management.browser.min.js"></script>
+The Contentful Management library will be accessible via the contentfulManagement global variable.
Check the releases page to know which versions are available.
+Typings
This library also comes with typings to use with typescript.
+Authentication
To get content from Contentful, an app should authenticate with an OAuth bearer token.
+If you want to use this library for a simple tool or a local app that you won't redistribute or make available to other users, you can get an API key for the Management API at our Authentication page.
+If you'd like to create an app which would make use of this library but that would be available for other users, where they could authenticate with their own Contentful credentials, make sure to also check out the section about Creating an OAuth Application
+Using ES6 import
You can use the es6 import with the library as follows
+// import createClient directly
import contentful from 'contentful-management'
const client = contentful.createClient(
{
// This is the access token for this space. Normally you get the token in the Contentful web app
accessToken: 'YOUR_ACCESS_TOKEN',
},
{ type: 'plain' }
)
//....
+Your first request
Beginning with contentful-management@7 this library provides a client which exposes all CMA endpoints in a simple flat API surface, as opposed to the waterfall structure exposed by legacy versions of the SDK.
const contentful = require('contentful-management')
const plainClient = contentful.createClient(
{
accessToken: 'YOUR_ACCESS_TOKEN',
},
{ type: 'plain' }
)
const environment = await plainClient.environment.get({
spaceId: '<space_id>',
environmentId: '<environment_id>',
})
const entries = await plainClient.entry.getMany({
spaceId: '123',
environmentId: '',
query: {
skip: 10,
limit: 100,
},
})
// With scoped space and environment
const scopedPlainClient = contentful.createClient(
{
accessToken: 'YOUR_ACCESS_TOKEN',
},
{
type: 'plain',
defaults: {
spaceId: '<space_id>',
environmentId: '<environment_id>',
},
}
)
// entries from '<space_id>' & '<environment_id>'
const entries = await scopedPlainClient.entry.getMany({
query: {
skip: 10,
limit: 100,
},
})
+You can try and change the above example on Runkit.
+The benefits of using the "plain" version of the client, over the legacy version, are:
+-
+
- The ability to reach any possible CMA endpoint without the necessity to call any async functions beforehand.
+
-
+
- It's especially important if you're using this CMA client for non-linear scripts (for example, a complex Front-end application) +
+ - All returned objects are simple Javascript objects without any wrappers. They can be easily serialized without an additional
toPlainObjectfunction call.
+ - The ability to scope CMA client instance to a specific
spaceId,environmentId, andorganizationIdwhen initializing the client. +-
+
- You can pass a concrete values to
defaultsand omit specifying these params in actual CMA methods calls.
+
+ - You can pass a concrete values to
Legacy Client Interface
The following code snippet is an example of the legacy client interface, which reads and writes data as a sequence of nested requests:
+const contentful = require('contentful-management')
const client = contentful.createClient({
accessToken: 'YOUR_ACCESS_TOKEN',
})
// Get a space with the specified ID
client.getSpace('spaceId').then((space) => {
// Get an environment within the space
space.getEnvironment('master').then((environment) => {
// Get entries from this environment
environment.getEntries().then((entries) => {
console.log(entries.items)
})
// Get a content type
environment.getContentType('product').then((contentType) => {
// Update its name
contentType.name = 'New Product'
contentType.update().then((updatedContentType) => {
console.log('Update was successful')
})
})
})
})
+App Framework
Starting @contentful/app-sdk@4 you can use this client to make requests
+from your apps built for Contentful.
A dedicated Adapter +grants your apps access to the supported space-environment scoped entities without compromising on security as you won't +need to expose a management token, and without coding any additional backend middleware.
+const contentfulApp = require('@contentful/app-sdk')
const contentful = require('contentful-management')
contentfulApp.init((sdk) => {
const cma = contentful.createClient(
{ apiAdapter: sdk.cmaAdapter },
{
type: 'plain',
defaults: {
environmentId: sdk.ids.environmentAlias ?? sdk.ids.environment,
spaceId: sdk.ids.space,
},
}
)
// ...rest of initialization code
})
+++Please Note
+Requests issued by the App SDK adapter will count towards the same rate limiting quota as the ones made by other APIs +exposed by App SDK (e.g., Space API). Ultimately, they will all fall into the same bucket as the calls performed by +the host app (i.e., Contentful web app, Compose, or Launch).
+
Troubleshooting
-
+
- I can't Install the package via npm - Check your internet connection - It is called
contentful-managementand notcontenful-management¯\_(ツ)_/¯
+ - Can I use the library in react native projects - Yes it is possible +
- I get the error: Unable to resolve module
http- Our library is supplied as node and browser version. Most non-node environments, like React Native, act like a browser. To force using of the browser version, you can require it via:const { createClient } = require('contentful-management/dist/contentful-management.browser.min.js')
+ - I am not sure what payload to send when creating and entity (Asset/Entity/ContentType etc...) - Check the Content Management API docs or the examples in the reference docs - Feel free to open an issue if you didn't find what you need in the above links +
- 😱 something is wrong what should I do - If it is a bug related to the code create a GitHub issue and make sure to remove any credential for your code before sharing it. - If you need to share your credentials, for example you have an issue with your space, please create a support ticket. - Please do not share your management token in a GitHub issue +
Documentation/References
To help you get the most out of this library, we've prepared reference documentation, tutorials and other examples that will help you learn and understand how to use this library.
+Configuration
The createClient method supports several options you may set to achieve the expected behavior:
contentful.createClient({
... your config here ...
})
+accessToken (required, when apiAdapter is not set)
Your CMA access token.
+host (default: 'api.contentful.com')
Set the host used to build the request URI's.
+hostUpload (default: 'upload.contentful.com')
Set the host used to build the upload related request uri's.
+basePath (default: ``)
This path gets appended to the host to allow request urls like https://gateway.example.com/contentful/ for custom gateways/proxies.
httpAgent (default: undefined)
Custom agent to perform HTTP requests. Find further information in the axios request config documentation.
+httpsAgent (default: undefined)
Custom agent to perform HTTPS requests. Find further information in the axios request config documentation.
+headers (default: {})
Additional headers to attach to the requests. We add/overwrite the following headers:
+-
+
- Content-Type:
application/vnd.contentful.management.v1+json
+ - X-Contentful-User-Agent:
sdk contentful-management.js/1.2.3; platform node.js/1.2.3; os macOS/1.2.3+(Automatically generated)
+
proxy (default: undefined)
Axios proxy configuration. See the axios request config documentation for further information about the supported values.
+retryOnError (default: true)
By default, this library is retrying requests which resulted in a 500 server error and 429 rate limit response. Set this to false to disable this behavior.
logHandler (default: function (level, data) {})
Errors and warnings will be logged by default to the node or browser console. Pass your own log handler to intercept here and handle errors, warnings and info on your own.
+requestLogger (default: function (config) {})
Interceptor called on every request. Takes Axios request config as an arg. Default does nothing. Pass your own function to log any desired data.
+responseLogger (default: function (response) {})
Interceptor called on every response. Takes Axios response object as an arg. Default does nothing. Pass your own function to log any desired data.
+apiAdapter (default: new RestAdapter(configuration))
An Adapter
+that can be utilized to issue requests. It defaults to a RestAdapter
+initialized with provided configuration.
++Please Note
+The Adapter will take precedence over the other options. Therefore, ensure you're providing the Adapter all the +information it needs to issue the request (e.g., host or auth headers)
+
throttle (default: 0)
Maximum number of requests per second.
+-
+
1-30(fixed number of limit),
+'auto'(calculated limit based on your plan),
+'0%'-'100%'(calculated % limit based on your plan)
+
Reference documentation
The Contentful's JS library reference documents what objects and methods are exposed by this library, what arguments they expect and what kind of data is returned.
+Most methods also have examples which show you how to use them.
+You can start by looking at the top level contentfulManagement namespace.
The ContentfulClientAPI namespace defines the methods at the Client level which allow you to create and get spaces.
The ContentfulSpaceAPI namespace defines the methods at the Space level which allow you to create and get entries, assets, content types and other possible entities.
The Entry, Asset and ContentType namespaces show you the instance methods you can use on each of these entities, once you retrieve them from the server.
++From version 1.0.0 onwards, you can access documentation for a specific version by visiting
+https://contentful.github.io/contentful-management.js/contentful-management/<VERSION>
Contentful JavaScript resources
Read the Contentful for JavaScript page for Tutorials, Demo Apps, and more information on other ways of using JavaScript with Contentful
+REST API reference
This library is a wrapper around our Contentful Management REST API. Some more specific details such as search parameters and pagination are better explained on the REST API reference, and you can also get a better understanding of how the requests look under the hood.
+Versioning
This project strictly follows Semantic Versioning by use of semantic-release.
+This means that new versions are released automatically as fixes, features or breaking changes are released.
+You can check the changelog on the releases page.
+Reach out to us
You have questions about how to use this library?
-
+
- Reach out to our community
+forum:
+ - Jump into our community slack
+channel:
+
You found a bug or want to propose a feature?
-
+
- File an issue here on GitHub:
.
+Make sure to remove any credential from your code before sharing it.
+
You need to share confidential information or have other questions?
-
+
- File a support ticket at our Contentful Customer
+Support:
+
Get involved
We appreciate any help on our repositories. For more details about how to contribute see our CONTRIBUTING.md document.
+License
This repository is published under the MIT license.
+Code of Conduct
We want to provide a safe, inclusive, welcoming, and harassment-free space and experience for all participants, regardless of gender identity and expression, sexual orientation, disability, physical appearance, socioeconomic status, body size, ethnicity, nationality, level of experience, age, religion (or lack thereof), or other identity markers.
+ +Interface AccessToken
interface AccessToken {
name: string;
revokedAt: null | string;
scopes: "content_management_manage"[];
sys: AccessTokenSysProps;
token?: string;
revoke(): Promise<AccessToken>;
toPlainObject(): AccessTokenProp;
}
name: string;
revokedAt: null | string;
scopes: "content_management_manage"[];
sys: AccessTokenSysProps;
token?: string;
revoke(): Promise<AccessToken>;
toPlainObject(): AccessTokenProp;
}
Hierarchy (view full)
- AccessTokenProp
- DefaultElements<AccessTokenProp>
- AccessToken
Properties
name
name: string
revoked
revoked
scopes
scopes: "content_management_manage"[]
sys
sys: AccessTokenSysProps
Optionaltoken
token?: string
Methods
revoke
- revoke(): Promise<AccessToken>
Revokes access token
+Returns Promise<AccessToken>
Object the revoked access token
+
to
- to
Plain Object(): AccessTokenProp Returns AccessTokenProp
Interface Adapter
Implemented by
Index
Properties
Interface ApiKey
interface ApiKey {
accessToken: string;
description?: string;
environments: {
sys: MetaLinkProps;
}[];
name: string;
policies?: {
action: string;
effect: string;
}[];
preview_api_key: {
sys: MetaLinkProps;
};
sys: MetaSysProps;
delete(): Promise<void>;
toPlainObject(): ApiKeyProps;
update(): Promise<ApiKey>;
}
accessToken: string;
description?: string;
environments: {
sys: MetaLinkProps;
}[];
name: string;
policies?: {
action: string;
effect: string;
}[];
preview_api_key: {
sys: MetaLinkProps;
};
sys: MetaSysProps;
delete(): Promise<void>;
toPlainObject(): ApiKeyProps;
update(): Promise<ApiKey>;
}
Hierarchy (view full)
Index
Properties
Methods
Properties
access
access
Optionaldescription
description?: string
environments
name
name: string
Optionalpolicies
policies?: {
action: string;
effect: string;
}[]
action: string;
effect: string;
}[]
preview_
sys
Methods
delete
- delete(): Promise<void>
Deletes this object on the server.
+Returns Promise<void>
Promise for the deletion. It contains no data, but the Promise error case should be handled.
+Example: ```javascript +const contentful = require('contentful-management') + +const client = contentful.createClient({ + accessToken: '<content_management_api_key>' +}) +client.getSpace('<space_id>') +.then((space) => space.getApiKey(<api-key-id>)) +.then((apiKey) => apiKey.delete()) +.then(() => console.log('apikey deleted')) +.catch(console.error) +```
to
- to
Plain Object(): ApiKeyProps Returns ApiKeyProps
update
- update(): Promise<ApiKey>
Sends an update to the server with any changes made to the object's properties
+Returns Promise<ApiKey>
Object returned from the server with updated changes.
+Example: ```javascript +const contentful = require('contentful-management') + +const client = contentful.createClient({ + accessToken: '<content_management_api_key>' +}) +client.getSpace('<space_id>') +.then((space) => space.getApiKey(<api-key-id>)) +.then((apiKey) => { + apiKey.name = 'New name' + return apiKey.update() +}) +.then(apiKey => console.log(apiKey.name)) +.catch(console.error) +```
Interface AppAccessToken
interface AppAccessToken {
sys: AppAccessTokenSys;
token: string;
toPlainObject(): AppAccessTokenProps;
}
sys: AppAccessTokenSys;
token: string;
toPlainObject(): AppAccessTokenProps;
}
Hierarchy (view full)
- AppAccessTokenProps
- DefaultElements<AppAccessTokenProps>
- AppAccessToken
Index
Properties
Methods
Properties
sys
sys: AppAccessTokenSys
System metadata
+token
token: string
Token for an app installation in a space environment
+ Methods
to
- to
Plain Object(): AppAccessTokenProps Returns AppAccessTokenProps
Interface AppActionCall
Hierarchy (view full)
- AppActionCallProps
- DefaultElements<AppActionCallProps>
- AppActionCall
Index
Properties
sys
+
Methods
Methods
to
- to
Plain Object(): AppActionCallProps Returns AppActionCallProps
Interface AppBundle
interface AppBundle {
comment?: string;
files: AppBundleFile[];
sys: AppBundleSys;
delete(): Promise<void>;
toPlainObject(): AppBundleProps;
}
comment?: string;
files: AppBundleFile[];
sys: AppBundleSys;
delete(): Promise<void>;
toPlainObject(): AppBundleProps;
}
Hierarchy (view full)
- AppBundleProps
- DefaultElements<AppBundleProps>
- AppBundle
Index
Properties
Methods
Properties
Optionalcomment
comment?: string
A comment that describes this bundle
+files
List of all the files that are in this bundle
+sys
sys: AppBundleSys
System metadata
+ Methods
delete
- delete(): Promise<void>
Deletes this object on the server.
+Returns Promise<void>
Promise for the deletion. It contains no data, but the Promise error case should be handled.
+Example: ```javascript +const contentful = require('contentful-management') + +const client = contentful.createClient({ + accessToken: '<content_management_api_key>' +}) + +client.getOrganization('<org_id>') +.then((org) => org.getAppDefinition('<app_def_id>')) +.then((appDefinition) => appDefinition.getAppBundle('<app-bundle-id>')) +.then((appBundle) => appBundle.delete()) +.catch(console.error) +```
to
- to
Plain Object(): AppBundleProps Returns AppBundleProps
Interface AppDetails
interface AppDetails {
icon?: AppIcon;
sys: AppDetailsSys;
delete(): Promise<void>;
toPlainObject(): AppDetailsProps;
}
icon?: AppIcon;
sys: AppDetailsSys;
delete(): Promise<void>;
toPlainObject(): AppDetailsProps;
}
Hierarchy (view full)
- AppDetailsProps
- DefaultElements<AppDetailsProps>
- AppDetails
Index
Properties
Methods
Methods
delete
- delete(): Promise<void>
Deletes this object on the server.
+Returns Promise<void>
Promise for the deletion. It contains no data, but the Promise error case should be handled.
+Example: ```javascript +const contentful = require('contentful-management') + +const client = contentful.createClient({ + accessToken: '<content_management_api_key>' +}) +client.getOrganization('<organization_id>') +.then((organization) => organization.getAppDetails(<app-id>)) +.then((appDetails) => appDetails.delete()) +.then(() => console.log('appDetails deleted')) +.catch(console.error) +```
to
- to
Plain Object(): AppDetailsProps Returns AppDetailsProps
Interface AppEventSubscription
interface AppEventSubscription {
sys: AppEventSubscriptionSys;
targetUrl: string;
topics: string[];
delete(): Promise<void>;
toPlainObject(): AppEventSubscriptionProps;
}
sys: AppEventSubscriptionSys;
targetUrl: string;
topics: string[];
delete(): Promise<void>;
toPlainObject(): AppEventSubscriptionProps;
}
Hierarchy (view full)
- AppEventSubscriptionProps
- DefaultElements<AppEventSubscriptionProps>
- AppEventSubscription
Index
Properties
Methods
Properties
sys
sys: AppEventSubscriptionSys
System metadata
+target
target
Subscription url that will receive events
+topics
topics: string[]
List of topics to subscribe to
+ Methods
delete
- delete(): Promise<void>
Deletes this object on the server.
+Returns Promise<void>
Promise for the deletion. It contains no data, but the Promise error case should be handled.
+Example: ```javascript +const contentful = require('contentful-management') + +const client = contentful.createClient({ + accessToken: '<content_management_api_key>' +}) +client.getOrganization('<organization_id>') +.then((organization) => organization.getAppEventSubscription(<app-definition-id>)) +.then((eventSubscription) => eventSubscription.delete()) +.then(() => console.log('eventSubscription deleted')) +.catch(console.error) +```
to
- to
Plain Object(): AppEventSubscriptionProps Returns AppEventSubscriptionProps
diff --git a/contentful-management/11.40.3/interfaces/AppInstallation.html b/contentful-management/11.40.3/interfaces/AppInstallation.html
new file mode 100644
index 0000000000..bd0c6af8d8
--- /dev/null
+++ b/contentful-management/11.40.3/interfaces/AppInstallation.html
@@ -0,0 +1,127 @@
+
Interface AppInstallation
interface AppInstallation {
parameters?: FreeFormParameters;
sys: Omit<BasicMetaSysProps, "id"> & {
appDefinition: SysLink;
environment: SysLink;
space: SysLink;
};
delete(): Promise<void>;
toPlainObject(): AppInstallationProps;
update(): Promise<AppInstallation>;
}
parameters?: FreeFormParameters;
sys: Omit<BasicMetaSysProps, "id"> & {
appDefinition: SysLink;
environment: SysLink;
space: SysLink;
};
delete(): Promise<void>;
toPlainObject(): AppInstallationProps;
update(): Promise<AppInstallation>;
}
Hierarchy (view full)
- AppInstallationProps
- DefaultElements<AppInstallationProps>
- AppInstallation
Index
Properties
parameters?
+sys
+
Methods
Properties
Optionalparameters
Free-form installation parameters (API limits stringified length to 32KB)
+sys
sys: Omit<BasicMetaSysProps, "id"> & {
appDefinition: SysLink;
environment: SysLink;
space: SysLink;
}
appDefinition: SysLink;
environment: SysLink;
space: SysLink;
}
Methods
delete
- delete(): Promise<void>
Deletes this object on the server.
+Returns Promise<void>
Promise for the deletion. It contains no data, but the Promise error case should be handled.
+Example: ```javascript +const contentful = require('contentful-management') + +const client = contentful.createClient({ + accessToken: '<content_management_api_key>' +}) + +client.getSpace('<space_id>') +.then((space) => space.getEnvironment('<environment_id>')) +.then((environment) => environment.getAppInstallation('<app_definition_id>')) +.then((appInstallation) => appInstallation.delete()) +.then(() => console.log(`App installation deleted.`)) +.catch(console.error) +```
to
- to
Plain Object(): AppInstallationProps Returns AppInstallationProps
update
- update(): Promise<AppInstallation>
Sends an update to the server with any changes made to the object's properties
+Returns Promise<AppInstallation>
Object returned from the server with updated changes.
+Example: ```javascript +const contentful = require('contentful-management') + +const client = contentful.createClient({ + accessToken: '<content_management_api_key>' +}) + +client.getSpace('<space_id>') +.then((space) => space.getEnvironment('<environment_id>')) +.then((environment) => environment.getAppInstallation('<app_definition_id>')) +.then((appInstallation) => { + appInstallation.parameters.someParameter = 'New Value' + return appInstallation.update() +}) +.then((appInstallation) => console.log(`App installation ${appInstallation.sys.id} was updated`)) +.catch(console.error) +```
Interface AppKey
interface AppKey {
generated?: {
privateKey: string;
};
jwk: JWK;
sys: AppKeySys;
delete(): Promise<void>;
toPlainObject(): AppKeyProps;
}
generated?: {
privateKey: string;
};
jwk: JWK;
sys: AppKeySys;
delete(): Promise<void>;
toPlainObject(): AppKeyProps;
}
Hierarchy (view full)
Index
Properties
Methods
Properties
Optionalgenerated
generated?: {
privateKey: string;
}
privateKey: string;
}
If generated, private key is returned
+Type declaration
private
Key: string Base64 PEM
+
jwk
jwk: JWK
JSON Web Key
+sys
sys: AppKeySys
System metadata
+ Methods
delete
- delete(): Promise<void>
Deletes this object on the server.
+Returns Promise<void>
Promise for the deletion. It contains no data, but the Promise error case should be handled.
+Example: ```javascript +const contentful = require('contentful-management') + +const client = contentful.createClient({ + accessToken: '<content_management_api_key>' +}) +client.getOrganization('<organization_id>') +.then((organization) => organization.getAppKey(<api-key-id>)) +.then((signingSecret) => signingSecret.delete()) +.then(() => console.log('signingSecret deleted')) +.catch(console.error) +```
to
- to
Plain Object(): AppKeyProps Returns AppKeyProps
Interface AppSignedRequest
interface AppSignedRequest {
additionalHeaders: {
x-contentful-environment-id: string;
x-contentful-signature: string;
x-contentful-signed-headers: string;
x-contentful-space-id: string;
x-contentful-timestamp: string;
x-contentful-user-id: string;
};
sys: AppSignedRequestSys;
toPlainObject(): AppSignedRequestProps;
}
additionalHeaders: {
x-contentful-environment-id: string;
x-contentful-signature: string;
x-contentful-signed-headers: string;
x-contentful-space-id: string;
x-contentful-timestamp: string;
x-contentful-user-id: string;
};
sys: AppSignedRequestSys;
toPlainObject(): AppSignedRequestProps;
}
Hierarchy (view full)
- AppSignedRequestProps
- DefaultElements<AppSignedRequestProps>
- AppSignedRequest
Index
Properties
Methods
Properties
additional
additional
x-contentful-environment-id: string;
x-contentful-signature: string;
x-contentful-signed-headers: string;
x-contentful-space-id: string;
x-contentful-timestamp: string;
x-contentful-user-id: string;
}
x-contentful-environment-id: string;
x-contentful-signature: string;
x-contentful-signed-headers: string;
x-contentful-space-id: string;
x-contentful-timestamp: string;
x-contentful-user-id: string;
}
new headers to be included in the request
+sys
sys: AppSignedRequestSys
System metadata
+ Methods
to
- to
Plain Object(): AppSignedRequestProps Returns AppSignedRequestProps
Interface AppSigningSecret
interface AppSigningSecret {
redactedValue: string;
sys: AppSigningSecretSys;
delete(): Promise<void>;
toPlainObject(): AppSigningSecretProps;
}
redactedValue: string;
sys: AppSigningSecretSys;
delete(): Promise<void>;
toPlainObject(): AppSigningSecretProps;
}
Hierarchy (view full)
- AppSigningSecretProps
- DefaultElements<AppSigningSecretProps>
- AppSigningSecret
Index
Properties
redacted
Methods
Properties
redacted
redacted
The last four characters of the signing secret
+sys
sys: AppSigningSecretSys
System metadata
+ Methods
delete
- delete(): Promise<void>
Deletes this object on the server.
+Returns Promise<void>
Promise for the deletion. It contains no data, but the Promise error case should be handled.
+Example: ```javascript +const contentful = require('contentful-management') + +const client = contentful.createClient({ + accessToken: '<content_management_api_key>' +}) +client.getOrganization('<organization_id>') +.then((organization) => organization.getAppSigningSecret(<api-key-id>)) +.then((signingSecret) => signingSecret.delete()) +.then(() => console.log('signingSecret deleted')) +.catch(console.error) +```
to
- to
Plain Object(): AppSigningSecretProps Returns AppSigningSecretProps
Interface AppUpload
interface AppUpload {
sys: {
createdAt: string;
createdBy?: SysLink;
id: string;
type: string;
updatedAt: string;
updatedBy?: SysLink;
} & {
expiresAt: string;
organization: SysLink;
};
delete(): Promise<void>;
toPlainObject(): AppUploadProps;
}
sys: {
createdAt: string;
createdBy?: SysLink;
id: string;
type: string;
updatedAt: string;
updatedBy?: SysLink;
} & {
expiresAt: string;
organization: SysLink;
};
delete(): Promise<void>;
toPlainObject(): AppUploadProps;
}
Hierarchy (view full)
- AppUploadProps
- DefaultElements<AppUploadProps>
- AppUpload
Index
Properties
sys
+
Methods
Methods
delete
- delete(): Promise<void>
Deletes this object on the server.
+Returns Promise<void>
Promise for the deletion. It contains no data, but the Promise error case should be handled.
+Example: ```javascript +const contentful = require('contentful-management') + +const client = contentful.createClient({ + accessToken: '<content_management_api_key>' +}) + +client.getOrganization('<org_id>') +.then((org) => org.getAppUpload('<app_upload_id>')) +.then((appUpload) => appUpload.delete()) +.then(() => console.log(`App Upload deleted.`)) +.catch(console.error) +```
to
- to
Plain Object(): AppUploadProps Returns AppUploadProps
Interface Asset
interface Asset {
fields: {
description?: {
[key: string]: string;
};
file: {
[key: string]: {
contentType: string;
details?: Record<string, any>;
fileName: string;
upload?: string;
uploadFrom?: Record<string, any>;
url?: string;
};
};
title: {
[key: string]: string;
};
};
metadata?: MetadataProps;
sys: EntityMetaSysProps;
archive(): Promise<Asset>;
delete(): Promise<void>;
isArchived(): boolean;
isDraft(): boolean;
isPublished(): boolean;
isUpdated(): boolean;
processForAllLocales(options?: AssetProcessingForLocale): Promise<Asset>;
processForLocale(locale: string, Options?: AssetProcessingForLocale): Promise<Asset>;
publish(): Promise<Asset>;
toPlainObject(): AssetProps;
unarchive(): Promise<Asset>;
unpublish(): Promise<Asset>;
update(): Promise<Asset>;
}
fields: {
description?: {
[key: string]: string;
};
file: {
[key: string]: {
contentType: string;
details?: Record<string, any>;
fileName: string;
upload?: string;
uploadFrom?: Record<string, any>;
url?: string;
};
};
title: {
[key: string]: string;
};
};
metadata?: MetadataProps;
sys: EntityMetaSysProps;
archive(): Promise<Asset>;
delete(): Promise<void>;
isArchived(): boolean;
isDraft(): boolean;
isPublished(): boolean;
isUpdated(): boolean;
processForAllLocales(options?: AssetProcessingForLocale): Promise<Asset>;
processForLocale(locale: string, Options?: AssetProcessingForLocale): Promise<Asset>;
publish(): Promise<Asset>;
toPlainObject(): AssetProps;
unarchive(): Promise<Asset>;
unpublish(): Promise<Asset>;
update(): Promise<Asset>;
}
Hierarchy (view full)
- AssetProps
- DefaultElements<AssetProps>
- AssetApi
- Asset
Index
Properties
Methods
Properties
fields
fields: {
description?: {
[key: string]: string;
};
file: {
[key: string]: {
contentType: string;
details?: Record<string, any>;
fileName: string;
upload?: string;
uploadFrom?: Record<string, any>;
url?: string;
};
};
title: {
[key: string]: string;
};
}
description?: {
[key: string]: string;
};
file: {
[key: string]: {
contentType: string;
details?: Record<string, any>;
fileName: string;
upload?: string;
uploadFrom?: Record<string, any>;
url?: string;
};
};
title: {
[key: string]: string;
};
}
Type declaration
Optionaldescription?: {
[key: string]: string;
}Description for this asset
+[key: string]: string
file: {
[key: string]: {
contentType: string;
details?: Record<string, any>;
fileName: string;
upload?: string;
uploadFrom?: Record<string, any>;
url?: string;
};
}File object for this asset
+[key: string]: {
contentType: string;
details?: Record<string, any>;
fileName: string;
upload?: string;
uploadFrom?: Record<string, any>;
url?: string;
}content
Type: string Optionaldetails?: Record<string, any>Details for the file, depending on file type (example: image size in bytes, etc)
+file
Name: string Optionalupload?: stringUrl where the file is available to be downloaded from, into the Contentful asset system. After the asset is processed this field is gone.
+OptionaluploadFrom?: Record<string, any> Optionalurl?: stringUrl where the file is available at the Contentful media asset system. This field won't be available until the asset is processed.
+
title: {
[key: string]: string;
}Title for this asset
+[key: string]: string
Optionalmetadata
sys
Methods
archive
- archive(): Promise<Asset>
Archives the object
+Returns Promise<Asset>
Object returned from the server with updated metadata.
+Example: ```javascript +const contentful = require('contentful-management') + +const client = contentful.createClient({ + accessToken: '<content_management_api_key>' +}) + +client.getSpace('<space_id>') +.then((space) => space.getEnvironment('<environment_id>')) +.then((environment) => environment.getAsset('<asset_id>')) +.then((asset) => asset.archive()) +.then((asset) => console.log(`Asset ${asset.sys.id} archived.`) +.catch(console.error) +```
delete
- delete(): Promise<void>
Deletes this object on the server.
+Returns Promise<void>
Promise for the deletion. It contains no data, but the Promise error case should be handled.
+Example: ```javascript +const contentful = require('contentful-management') + +const client = contentful.createClient({ + accessToken: '<content_management_api_key>' +}) + +client.getSpace('<space_id>') +.then((space) => space.getEnvironment('<environment_id>')) +.then((environment) => environment.getAsset('<asset_id>')) +.then((asset) => asset.delete()) +.then((asset) => console.log(`Asset deleted.`) +.catch(console.error) +```
is
is
is
is
process
- process
For All Locales(options?): Promise<Asset> Triggers asset processing after an upload, for the files uploaded to all locales of an asset.
+Parameters
Optionaloptions: AssetProcessingForLocaleAdditional options for processing
+
Returns Promise<Asset>
Object returned from the server with updated metadata.
+Throws
If the asset takes too long to process. If this happens, retrieve the asset again, and if the url property is available, then processing has succeeded. If not, your file might be damaged.
+Example: ```javascript +const contentful = require('contentful-management') + +const client = contentful.createClient({ + accessToken: '<content_management_api_key>' +}) +client.getSpace('<space_id>') +.then((space) => space.getEnvironment('<environment_id>')) +.then((environment) => environment.createAssetWithId('<asset_id>', { + title: { + 'en-US': 'Playsam Streamliner', + 'de-DE': 'Playsam Streamliner' + }, + file: { + 'en-US': { + contentType: 'image/jpeg', + fileName: 'example.jpeg', + upload: 'https://example.com/example.jpg' + }, + 'de-DE': { + contentType: 'image/jpeg', + fileName: 'example.jpeg', + upload: 'https://example.com/example-de.jpg' + } + } +})) +.then((asset) => asset.processForAllLocales()) +.then((asset) => console.log(asset)) +.catch(console.error) +```
+
+const client = contentful.createClient({
+ accessToken: '<content_management_api_key>'
+})
+client.getSpace('<space_id>')
+.then((space) => space.getEnvironment('<environment_id>'))
+.then((environment) => environment.createAssetWithId('<asset_id>', {
+ title: {
+ 'en-US': 'Playsam Streamliner',
+ 'de-DE': 'Playsam Streamliner'
+ },
+ file: {
+ 'en-US': {
+ contentType: 'image/jpeg',
+ fileName: 'example.jpeg',
+ upload: 'https://example.com/example.jpg'
+ },
+ 'de-DE': {
+ contentType: 'image/jpeg',
+ fileName: 'example.jpeg',
+ upload: 'https://example.com/example-de.jpg'
+ }
+ }
+}))
+.then((asset) => asset.processForAllLocales())
+.then((asset) => console.log(asset))
+.catch(console.error)
+```){kind=link}
process
- process
For Locale(locale, Options?): Promise<Asset> Triggers asset processing after an upload, for the file uploaded to a specific locale.
+Parameters
- locale: string
Locale which processing should be triggered for
+ OptionalOptions: AssetProcessingForLocale
Returns Promise<Asset>
Object returned from the server with updated metadata.
+Throws
If the asset takes too long to process. If this happens, retrieve the asset again, and if the url property is available, then processing has succeeded. If not, your file might be damaged.
+Example: ```javascript +const contentful = require('contentful-management') + +const client = contentful.createClient({ + accessToken: '<content_management_api_key>' +}) +client.getSpace('<space_id>') +.then((space) => space.getEnvironment('<environment_id>')) +.then((environment) => environment.createAssetWithId('<asset_id>', { + title: { + 'en-US': 'Playsam Streamliner', + }, + file: { + 'en-US': { + contentType: 'image/jpeg', + fileName: 'example.jpeg', + upload: 'https://example.com/example.jpg' + } + } +})) +.then((asset) => asset.processForLocale('en-US')) +.then((asset) => console.log(asset)) +.catch(console.error) +```
- locale: string
+
+const client = contentful.createClient({
+ accessToken: '<content_management_api_key>'
+})
+client.getSpace('<space_id>')
+.then((space) => space.getEnvironment('<environment_id>'))
+.then((environment) => environment.createAssetWithId('<asset_id>', {
+ title: {
+ 'en-US': 'Playsam Streamliner',
+ },
+ file: {
+ 'en-US': {
+ contentType: 'image/jpeg',
+ fileName: 'example.jpeg',
+ upload: 'https://example.com/example.jpg'
+ }
+ }
+}))
+.then((asset) => asset.processForLocale('en-US'))
+.then((asset) => console.log(asset))
+.catch(console.error)
+```){kind=link}
publish
- publish(): Promise<Asset>
Publishes the object
+Returns Promise<Asset>
Object returned from the server with updated metadata.
+Example: ```javascript +const contentful = require('contentful-management') + +const client = contentful.createClient({ + accessToken: '<content_management_api_key>' +}) + +client.getSpace('<space_id>') +.then((space) => space.getEnvironment('<environment_id>')) +.then((environment) => environment.getAsset('<asset_id>')) +.then((asset) => asset.publish()) +.then((asset) => console.log(`Asset ${asset.sys.id} published.`) +.catch(console.error) +```
to
- to
Plain Object(): AssetProps Returns AssetProps
unarchive
- unarchive(): Promise<Asset>
Unarchives the object
+Returns Promise<Asset>
Object returned from the server with updated metadata.
+Example: ```javascript +const contentful = require('contentful-management') + +const client = contentful.createClient({ + accessToken: '<content_management_api_key>' +}) + +client.getSpace('<space_id>') +.then((space) => space.getEnvironment('<environment_id>')) +.then((environment) => environment.getAsset('<asset_id>')) +.then((asset) => asset.unarchive()) +.then((asset) => console.log(`Asset ${asset.sys.id} unarchived.`) +.catch(console.error) +```
unpublish
- unpublish(): Promise<Asset>
Unpublishes the object
+Returns Promise<Asset>
Object returned from the server with updated metadata.
+Example: ```javascript +const contentful = require('contentful-management') + +const client = contentful.createClient({ + accessToken: '<content_management_api_key>' +}) + +client.getSpace('<space_id>') +.then((space) => space.getEnvironment('<environment_id>')) +.then((environment) => environment.getAsset('<asset_id>')) +.then((asset) => asset.unpublish()) +.then((asset) => console.log(`Asset ${asset.sys.id} unpublished.`) +.catch(console.error) +```
update
- update(): Promise<Asset>
Sends an update to the server with any changes made to the object's properties
+Returns Promise<Asset>
Object returned from the server with updated changes.
+Example: ```javascript +const contentful = require('contentful-management') + +const client = contentful.createClient({ + accessToken: '<content_management_api_key>' +}) + +client.getSpace('<space_id>') +.then((space) => space.getEnvironment('<environment_id>')) +.then((environment) => environment.getAsset('<asset_id>')) +.then((asset) => { + asset.fields.title['en-US'] = 'New asset title' + return asset.update() +}) +.then((asset) => console.log(`Asset ${asset.sys.id} updated.`) +.catch(console.error) +```
Interface AssetFileProp
interface AssetFileProp {
fields: {
description: {
[key: string]: string;
};
file: {
[key: string]: {
contentType: string;
file: string | ArrayBuffer | Stream;
fileName: string;
};
};
title: {
[key: string]: string;
};
};
sys: MetaSysProps;
}
fields: {
description: {
[key: string]: string;
};
file: {
[key: string]: {
contentType: string;
file: string | ArrayBuffer | Stream;
fileName: string;
};
};
title: {
[key: string]: string;
};
};
sys: MetaSysProps;
}
Interface AssetKey
Hierarchy (view full)
Index
Properties
Methods
Properties
policy
policy: string
A JWT describing a policy; needs to be attached to signed URLs
+secret
secret: string
A secret key to be used for signing URLs
+ Methods
to
- to
Plain Object(): AssetKeyProps Returns AssetKeyProps
diff --git a/contentful-management/11.40.3/interfaces/BasicCursorPaginationOptions.html b/contentful-management/11.40.3/interfaces/BasicCursorPaginationOptions.html
new file mode 100644
index 0000000000..dd9257c085
--- /dev/null
+++ b/contentful-management/11.40.3/interfaces/BasicCursorPaginationOptions.html
@@ -0,0 +1,3 @@
+
Interface BasicCursorPaginationOptions
Hierarchy
- Omit<BasicQueryOptions, "skip">
- BasicCursorPaginationOptions
diff --git a/contentful-management/11.40.3/interfaces/BasicQueryOptions.html b/contentful-management/11.40.3/interfaces/BasicQueryOptions.html
new file mode 100644
index 0000000000..abcb4ad2ed
--- /dev/null
+++ b/contentful-management/11.40.3/interfaces/BasicQueryOptions.html
@@ -0,0 +1,3 @@
+
diff --git a/contentful-management/11.40.3/interfaces/BulkAction.html b/contentful-management/11.40.3/interfaces/BulkAction.html
new file mode 100644
index 0000000000..2d8833cb02
--- /dev/null
+++ b/contentful-management/11.40.3/interfaces/BulkAction.html
@@ -0,0 +1,13 @@
+
Interface BulkAction<T>
The object returned by the BulkActions API
+interface BulkAction<T> {
action: BulkActionType;
error?: BulkActionFailedError;
payload: T;
sys: BulkActionSysProps;
get(): BulkAction<any>;
toPlainObject(): BulkActionProps<T>;
waitProcessing(options?: AsyncActionProcessingOptions): Promise<BulkAction<any>>;
}
action: BulkActionType;
error?: BulkActionFailedError;
payload: T;
sys: BulkActionSysProps;
get(): BulkAction<any>;
toPlainObject(): BulkActionProps<T>;
waitProcessing(options?: AsyncActionProcessingOptions): Promise<BulkAction<any>>;
}
Type Parameters
- T extends BulkActionPayload = any
Hierarchy (view full)
- BulkActionProps<T>
- BulkActionApiMethods
- DefaultElements<BulkActionProps<T>>
- BulkAction
Index
Properties
Methods
Properties
action
Optionalerror
error?: BulkActionFailedError
error information, if present
+payload
original payload when BulkAction was created
+sys
sys: BulkActionSysProps
Methods
get
- get(): BulkAction<any>
Performs a new GET request and returns the wrapper BulkAction
+Returns BulkAction<any>
to
- to
Plain Object(): BulkActionProps<T> Returns BulkActionProps<T>
wait
- wait
Processing(options?): Promise<BulkAction<any>> Waits until the BulkAction is in one of the final states (
+succeededorfailed) and returns it.Parameters
Optionaloptions: AsyncActionProcessingOptions
Returns Promise<BulkAction<any>>
Interface BulkActionProps<TPayload>
The object returned by the BulkActions API
+interface BulkActionProps<TPayload> {
action: BulkActionType;
error?: BulkActionFailedError;
payload: TPayload;
sys: BulkActionSysProps;
}
action: BulkActionType;
error?: BulkActionFailedError;
payload: TPayload;
sys: BulkActionSysProps;
}
Type Parameters
- TPayload extends BulkActionPayload = any
Hierarchy (view full)
- BulkActionProps
Interface BulkActionPublishPayload
Base interface for all Payload interfaces. Used as part of the MakeRequestOptions to simplify payload definitions.
+interface BulkActionPublishPayload {
entities: {
items: Collection<VersionedLink<Entity>>;
sys?: {
type: "Array";
};
};
}
entities: {
items: Collection<VersionedLink<Entity>>;
sys?: {
type: "Array";
};
};
}
Hierarchy (view full)
- MakeRequestPayload
- BulkActionPublishPayload
Index
Properties
entities
+
Interface BulkActionUnpublishPayload
Base interface for all Payload interfaces. Used as part of the MakeRequestOptions to simplify payload definitions.
+interface BulkActionUnpublishPayload {
entities: {
items: Collection<Link<Entity>>;
sys?: {
type: "Array";
};
};
}
entities: {
items: Collection<Link<Entity>>;
sys?: {
type: "Array";
};
};
}
Hierarchy (view full)
- MakeRequestPayload
- BulkActionUnpublishPayload
Index
Properties
entities
+
Interface BulkActionValidatePayload
Base interface for all Payload interfaces. Used as part of the MakeRequestOptions to simplify payload definitions.
+interface BulkActionValidatePayload {
action?: "publish";
entities: {
items: Collection<Link<Entity>>;
sys?: {
type: "Array";
};
};
}
action?: "publish";
entities: {
items: Collection<Link<Entity>>;
sys?: {
type: "Array";
};
};
}
Hierarchy (view full)
- MakeRequestPayload
- BulkActionValidatePayload
Interface Collection<T, TPlain>
interface Collection<T, TPlain> {
items: T[];
limit: number;
skip: number;
sys: {
type: "Array";
};
total: number;
toPlainObject(): CollectionProp<TPlain>;
}
items: T[];
limit: number;
skip: number;
sys: {
type: "Array";
};
total: number;
toPlainObject(): CollectionProp<TPlain>;
}
Type Parameters
Hierarchy (view full)
- CollectionProp<T>
- DefaultElements<CollectionProp<TPlain>>
- Collection
Methods
to
- to
Plain Object(): CollectionProp<TPlain> Returns CollectionProp<TPlain>
diff --git a/contentful-management/11.40.3/interfaces/Comment.html b/contentful-management/11.40.3/interfaces/Comment.html
new file mode 100644
index 0000000000..b240e3ab66
--- /dev/null
+++ b/contentful-management/11.40.3/interfaces/Comment.html
@@ -0,0 +1,7 @@
+
Interface Comment
interface Comment {
body: string;
status: CommentStatus;
sys: CommentSysProps;
delete(): Promise<void>;
toPlainObject(): CommentProps;
update(): Promise<Comment | RichTextComment>;
}
body: string;
status: CommentStatus;
sys: CommentSysProps;
delete(): Promise<void>;
toPlainObject(): CommentProps;
update(): Promise<Comment | RichTextComment>;
}
Hierarchy (view full)
- CommentProps
- DefaultElements<CommentProps>
- CommentApi
- Comment
Methods
delete
to
- to
Plain Object(): CommentProps Returns CommentProps
update
Interface ContentFields<T>
interface ContentFields<T> {
allowedResources?: ContentTypeAllowedResources[];
apiName?: string;
defaultValue?: T;
deleted?: boolean;
disabled?: boolean;
id: string;
items?: Item;
linkType?: string;
localized: boolean;
name: string;
omitted?: boolean;
required: boolean;
type: string;
validations?: ContentTypeFieldValidation[];
}
allowedResources?: ContentTypeAllowedResources[];
apiName?: string;
defaultValue?: T;
deleted?: boolean;
disabled?: boolean;
id: string;
items?: Item;
linkType?: string;
localized: boolean;
name: string;
omitted?: boolean;
required: boolean;
type: string;
validations?: ContentTypeFieldValidation[];
}
Type Parameters
- T = KeyValueMap
Hierarchy
- Item
- ContentFields
Index
Properties
Properties
Optionalallowed
allowed
Optionalapi
api
Optionaldefault
Optionaldeleted
deleted?: boolean
Optionaldisabled
disabled?: boolean
id
id: string
Optionalitems
items?: Item
Optionallink
link
localized
localized: boolean
name
name: string
Optionalomitted
omitted?: boolean
required
required: boolean
type
type: string
Optionalvalidations
Interface ContentType
interface ContentType {
description: string;
displayField: string;
fields: ContentFields<KeyValueMap>[];
metadata?: ContentTypeMetadata;
name: string;
sys: BasicMetaSysProps & {
environment: SysLink;
firstPublishedAt?: string;
publishedCounter?: number;
publishedVersion?: number;
space: SysLink;
};
delete(): Promise<void>;
getEditorInterface(): Promise<EditorInterface>;
getSnapshot(snapshotId: string): Promise<SnapshotProps<ContentTypeProps>>;
getSnapshots(): Promise<Collection<Snapshot<ContentTypeProps>, SnapshotProps<ContentTypeProps>>>;
isDraft(): boolean;
isPublished(): boolean;
isUpdated(): boolean;
omitAndDeleteField(id: string): Promise<ContentType>;
publish(): Promise<ContentType>;
toPlainObject(): ContentTypeProps;
unpublish(): Promise<ContentType>;
update(): Promise<ContentType>;
}
description: string;
displayField: string;
fields: ContentFields<KeyValueMap>[];
metadata?: ContentTypeMetadata;
name: string;
sys: BasicMetaSysProps & {
environment: SysLink;
firstPublishedAt?: string;
publishedCounter?: number;
publishedVersion?: number;
space: SysLink;
};
delete(): Promise<void>;
getEditorInterface(): Promise<EditorInterface>;
getSnapshot(snapshotId: string): Promise<SnapshotProps<ContentTypeProps>>;
getSnapshots(): Promise<Collection<Snapshot<ContentTypeProps>, SnapshotProps<ContentTypeProps>>>;
isDraft(): boolean;
isPublished(): boolean;
isUpdated(): boolean;
omitAndDeleteField(id: string): Promise<ContentType>;
publish(): Promise<ContentType>;
toPlainObject(): ContentTypeProps;
unpublish(): Promise<ContentType>;
update(): Promise<ContentType>;
}
Hierarchy (view full)
- ContentTypeProps
- DefaultElements<ContentTypeProps>
- ContentTypeApi
- ContentType
Index
Properties
Methods
Properties
description
description: string
display
display
Field used as the main display field for Entries
+fields
All the fields contained in this Content Type
+Optionalmetadata
name
name: string
sys
sys: BasicMetaSysProps & {
environment: SysLink;
firstPublishedAt?: string;
publishedCounter?: number;
publishedVersion?: number;
space: SysLink;
}
environment: SysLink;
firstPublishedAt?: string;
publishedCounter?: number;
publishedVersion?: number;
space: SysLink;
}
Methods
delete
- delete(): Promise<void>
Deletes this object on the server.
+Returns Promise<void>
Promise for the deletion. It contains no data, but the Promise error case should be handled.
+Example: ```javascript +const contentful = require('contentful-management') + +const client = contentful.createClient({ + accessToken: '<content_management_api_key>' +}) + +client.getSpace('<space_id>') +.then((space) => space.getEnvironment('<environment_id>')) +.then((environment) => environment.getContentType('<contentType_id>')) +.then((contentType) => contentType.delete()) +.then(() => console.log('contentType deleted')) +.catch(console.error) +```
get
- get
Editor Interface(): Promise<EditorInterface> Gets the editor interface for the object
+
+Important note: The editor interface only represent a published contentType.
+To get the most recent representation of the contentType make sure to publish it firstReturns Promise<EditorInterface>
Object returned from the server with the current editor interface.
+Example: ```javascript +const contentful = require('contentful-management') + +const client = contentful.createClient({ + accessToken: '<content_management_api_key>' +}) + +client.getSpace('<space_id>') +.then((space) => space.getEnvironment('<environment_id>')) +.then((environment) => environment.getContentType('<contentType_id>')) +.then((contentType) => contentType.getEditorInterface()) +.then((editorInterface) => console.log(editorInterface.contorls)) +.catch(console.error) +```
get
- get
Snapshot(snapshotId): Promise<SnapshotProps<ContentTypeProps>> Gets a snapshot of a contentType
+Parameters
- snapshotId: string
Id of the snapshot
+
Returns Promise<SnapshotProps<ContentTypeProps>>
Example: ```javascript +const contentful = require('contentful-management') + +const client = contentful.createClient({ + accessToken: '<content_management_api_key>' +}) + +client.getSpace('<space_id>') +.then((space) => space.getEnvironment('<environment_id>')) +.then((environment) => environment.getContentType('<contentType_id>')) +.then((entry) => entry.getSnapshot('<snapshot-id>')) +.then((snapshot) => console.log(snapshot)) +.catch(console.error) +```
- snapshotId: string
get
- get
Snapshots(): Promise<Collection<Snapshot<ContentTypeProps>, SnapshotProps<ContentTypeProps>>> Gets all snapshots of a contentType
+Returns Promise<Collection<Snapshot<ContentTypeProps>, SnapshotProps<ContentTypeProps>>>
Example: ```javascript +const contentful = require('contentful-management') + +const client = contentful.createClient({ + accessToken: '<content_management_api_key>' +}) + +client.getSpace('<space_id>') +.then((space) => space.getEnvironment('<environment_id>')) +.then((environment) => environment.getContentType('<contentType_id>')) +.then((entry) => entry.getSnapshots()) +.then((snapshots) => console.log(snapshots.items)) +.catch(console.error) +```
is
is
is
omit
- omit
And Delete Field(id): Promise<ContentType> Omits and deletes a field if it exists on the contentType. This is a convenience method which does both operations at once and potentially less +safe than the standard way. See note about deleting fields on the Update method.
+Parameters
- id: string
Returns Promise<ContentType>
Object returned from the server with updated metadata.
+
publish
- publish(): Promise<ContentType>
Publishes the object
+Returns Promise<ContentType>
Object returned from the server with updated metadata.
+Example: ```javascript +const contentful = require('contentful-management') + +const client = contentful.createClient({ + accessToken: '<content_management_api_key>' +}) + +client.getSpace('<space_id>') +.then((space) => space.getEnvironment('<environment_id>')) +.then((environment) => environment.getContentType('<contentType_id>')) +.then((contentType) => contentType.publish()) +.then((contentType) => console.log(`${contentType.sys.id} is published`)) +.catch(console.error) +```
to
- to
Plain Object(): ContentTypeProps Returns ContentTypeProps
unpublish
- unpublish(): Promise<ContentType>
Unpublishes the object
+Returns Promise<ContentType>
Object returned from the server with updated metadata.
+Example: ```javascript +const contentful = require('contentful-management') + +const client = contentful.createClient({ + accessToken: '<content_management_api_key>' +}) + +client.getSpace('<space_id>') +.then((space) => space.getEnvironment('<environment_id>')) +.then((environment) => environment.getContentType('<contentType_id>')) +.then((contentType) => contentType.unpublish()) +.then((contentType) => console.log(`${contentType.sys.id} is unpublished`)) +.catch(console.error) +```
update
- update(): Promise<ContentType>
Sends an update to the server with any changes made to the object's properties.
+
+Important note about deleting fields: The standard way to delete a field is with two updates: first omit the property from your responses (set the field attribute "omitted" to true), and then +delete it by setting the attribute "deleted" to true. See the "Deleting fields" section in the +API reference for more reasoning. Alternatively, +you may use the convenience method omitAndDeleteField to do both steps at once.Returns Promise<ContentType>
Object returned from the server with updated changes.
+Example: ```javascript +const contentful = require('contentful-management') + +const client = contentful.createClient({ + accessToken: '<content_management_api_key>' +}) + +client.getSpace('<space_id>') +.then((space) => space.getEnvironment('<environment_id>')) +.then((environment) => environment.getContentType('<contentType_id>')) +.then((contentType) => { + contentType.name = 'New name' + return contentType.update() +}) +.then(contentType => console.log(contentType)) +.catch(console.error) +```
Interface ContentTypeFieldValidation
interface ContentTypeFieldValidation {
assetFileSize?: NumRange;
assetImageDimensions?: {
height?: NumRange;
width?: NumRange;
};
dateRange?: DateRange;
enabledMarks?: string[];
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 | number)[];
linkContentType?: string[];
linkMimetypeGroup?: string[];
message?: null | string;
nodes?: NodesValidation;
prohibitRegexp?: RegExp;
range?: NumRange;
regexp?: RegExp;
size?: NumRange;
unique?: boolean;
}
assetFileSize?: NumRange;
assetImageDimensions?: {
height?: NumRange;
width?: NumRange;
};
dateRange?: DateRange;
enabledMarks?: string[];
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 | number)[];
linkContentType?: string[];
linkMimetypeGroup?: string[];
message?: null | string;
nodes?: NodesValidation;
prohibitRegexp?: RegExp;
range?: NumRange;
regexp?: RegExp;
size?: NumRange;
unique?: boolean;
}
Index
Properties
Optionalasset
asset
Optionalasset
asset
height?: NumRange;
width?: NumRange;
}
height?: NumRange;
width?: NumRange;
}
Optionaldate
date
Optionalenabled
enabled
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 | number)[]
Optionallink
link
Optionallink
link
Optionalmessage
message?: null | string
Optionalnodes
nodes?: NodesValidation
Optionalprohibit
prohibit
Optionalrange
range?: NumRange
Optionalregexp
regexp?: RegExp
Optionalsize
size?: NumRange
Optionalunique
unique?: boolean
Interface ContentTypeTemplateProps
interface ContentTypeTemplateProps {
basedOn?: {
contentType: Link<"ContentType">;
environment: Link<"Environment">;
space: Link<"Space">;
};
description: string;
displayField: string;
fields: ContentFields<KeyValueMap>[];
hints?: Hint[];
id: string;
metadata?: ContentTypeMetadata;
name: string;
}
basedOn?: {
contentType: Link<"ContentType">;
environment: Link<"Environment">;
space: Link<"Space">;
};
description: string;
displayField: string;
fields: ContentFields<KeyValueMap>[];
hints?: Hint[];
id: string;
metadata?: ContentTypeMetadata;
name: string;
}
Hierarchy
- Omit<ContentTypeProps, "sys">
- ContentTypeTemplateProps
Index
Properties
Interface ContentfulEntryResource
interface ContentfulEntryResource {
contentTypes: string[];
source: string;
type: "Contentful:Entry";
}
contentTypes: string[];
source: string;
type: "Contentful:Entry";
}
Index
Properties
Interface Control
interface Control {
fieldId: string;
settings?: DefinedParameters;
widgetId?: string;
widgetNamespace?: string;
}
fieldId: string;
settings?: DefinedParameters;
widgetId?: string;
widgetNamespace?: string;
}
Hierarchy
- WidgetConfig
- Control
Index
Properties
Interface CursorPaginatedCollection<T, TPlain>
interface CursorPaginatedCollection<T, TPlain> {
items: T[];
limit: number;
pages?: {
next?: string;
prev?: string;
};
sys: {
type: "Array";
};
toPlainObject(): CursorPaginatedCollectionProp<TPlain>;
}
items: T[];
limit: number;
pages?: {
next?: string;
prev?: string;
};
sys: {
type: "Array";
};
toPlainObject(): CursorPaginatedCollectionProp<TPlain>;
}
Type Parameters
Hierarchy (view full)
- CursorPaginatedCollectionProp<T>
- DefaultElements<CursorPaginatedCollectionProp<TPlain>>
- CursorPaginatedCollection
Index
Properties
Methods
Properties
items
limit
limit: number
Optionalpages
pages?: {
next?: string;
prev?: string;
}
next?: string;
prev?: string;
}
sys
sys: {
type: "Array";
}
type: "Array";
}
Methods
to
- to
Plain Object(): CursorPaginatedCollectionProp<TPlain> Returns CursorPaginatedCollectionProp<TPlain>
Interface CursorPaginatedCollectionProp<TObj>
interface CursorPaginatedCollectionProp<TObj> {
items: TObj[];
limit: number;
pages?: {
next?: string;
prev?: string;
};
sys: {
type: "Array";
};
}
items: TObj[];
limit: number;
pages?: {
next?: string;
prev?: string;
};
sys: {
type: "Array";
};
}
Type Parameters
Hierarchy (view full)
- Omit<CollectionProp<TObj>, "total" | "skip">
- CursorPaginatedCollectionProp
Interface DefaultElements<TPlainObject>
Type Parameters
Hierarchy (view full)
- DefaultElements
- AccessToken
- ApiKey
- AppAccessToken
- AppActionCall
- AppBundle
- AppDetails
- AppEventSubscription
- AppInstallation
- AppKey
- AppSignedRequest
- AppSigningSecret
- AppUpload
- Asset
- AssetKey
- BulkAction
- Comment
- ContentType
- EditorInterface
- Entry
- EnvironmentAlias
- UIExtension
- Locale
- OrganizationInvitation
- OrganizationMembership
- PersonalAccessToken
- PreviewApiKey
- Release
- ReleaseAction
- Role
- ScheduledAction
- Snapshot
- SpaceMember
- SpaceMembership
- Tag
- Task
- Team
- TeamMembership
- TeamSpaceMembership
- UIConfig
- Upload
- UploadCredential
- Usage
- User
- UserUIConfig
- WebHooks
- WorkflowDefinition
- ResourceProvider
- ResourceType
- Workflow
- WorkflowsChangelogEntry
- Collection
- CursorPaginatedCollection
Index
Methods
Methods
to
- to
Plain Object(): TPlainObject Returns TPlainObject
Interface Editor
interface Editor {
disabled?: boolean;
settings?: DefinedParameters;
widgetId: string;
widgetNamespace: string;
}
disabled?: boolean;
settings?: DefinedParameters;
widgetId: string;
widgetNamespace: string;
}
Index
Properties
Interface EditorInterface
interface EditorInterface {
controls?: Control[];
editor?: Editor;
editorLayout?: FieldGroupItem[];
editors?: Editor[];
groupControls?: GroupControl[];
sidebar?: SidebarItem[];
sys: MetaSysProps & {
contentType: {
sys: MetaLinkProps;
};
environment: {
sys: MetaLinkProps;
};
space: {
sys: MetaLinkProps;
};
};
getControlForField(id: string): null | Control;
toPlainObject(): EditorInterfaceProps;
update(): Promise<EditorInterface>;
}
controls?: Control[];
editor?: Editor;
editorLayout?: FieldGroupItem[];
editors?: Editor[];
groupControls?: GroupControl[];
sidebar?: SidebarItem[];
sys: MetaSysProps & {
contentType: {
sys: MetaLinkProps;
};
environment: {
sys: MetaLinkProps;
};
space: {
sys: MetaLinkProps;
};
};
getControlForField(id: string): null | Control;
toPlainObject(): EditorInterfaceProps;
update(): Promise<EditorInterface>;
}
Hierarchy (view full)
- EditorInterfaceProps
- DefaultElements<EditorInterfaceProps>
- EditorInterface
Index
Properties
Methods
Properties
Optionalcontrols
Array of fields and their associated widgetId
+Optionaleditor
Legacy singular editor override
+Optionaleditor
Array of editor layout field groups
+Optionaleditors
Array of editors. Defaults will be used if property is missing.
+Optionalgroup
Array of field groups and their associated widgetId
+Optionalsidebar
Array of sidebar widgets. Defaults will be used if property is missing.
+sys
sys: MetaSysProps & {
contentType: {
sys: MetaLinkProps;
};
environment: {
sys: MetaLinkProps;
};
space: {
sys: MetaLinkProps;
};
}
contentType: {
sys: MetaLinkProps;
};
environment: {
sys: MetaLinkProps;
};
space: {
sys: MetaLinkProps;
};
}
Methods
get
- get
Control For Field(id): null | Control Gets a control for a specific field
+Parameters
- id: string
Returns null | Control
control object for specific field
+
+ +const contentful = require('contentful-management')
const client = contentful.createClient({
accessToken: '<content_management_api_key>'
})
client.getSpace('<space_id>')
.then((space) => space.getEnvironment('<environment_id>'))
.then((environment) => environment.getContentType('<contentType_id>'))
.then((contentType) => contentType.getEditorInterface())
.then((editorInterface) => {
control = editorInterface.getControlForField('<field-id>')
console.log(control)
})
.catch(console.error) +
to
- to
Plain Object(): EditorInterfaceProps Returns EditorInterfaceProps
update
- update(): Promise<EditorInterface>
Sends an update to the server with any changes made to the object's properties
+Returns Promise<EditorInterface>
Object returned from the server with updated changes.
+
+ +const contentful = require('contentful-management')
const client = contentful.createClient({
accessToken: '<content_management_api_key>'
})
client.getSpace('<space_id>')
.then((space) => space.getEnvironment('<environment_id>'))
.then((environment) => environment.getContentType('<contentType_id>'))
.then((contentType) => contentType.getEditorInterface())
.then((editorInterface) => {
editorInterface.controls[0] = { "fieldId": "title", "widgetId": "singleLine"}
editorInterface.editors = [
{ "widgetId": "custom-widget", "widgetNamespace": "app" }
]
return editorInterface.update()
})
.catch(console.error) +
Interface EditorInterfaceTemplateProps
interface EditorInterfaceTemplateProps {
contentTypeTemplate: Link<"ContentTypeTemplate">;
controls?: Control[];
editor?: Editor;
editorLayout?: FieldGroupItem[];
editors?: Editor[];
groupControls?: GroupControl[];
sidebar?: SidebarItem[];
}
contentTypeTemplate: Link<"ContentTypeTemplate">;
controls?: Control[];
editor?: Editor;
editorLayout?: FieldGroupItem[];
editors?: Editor[];
groupControls?: GroupControl[];
sidebar?: SidebarItem[];
}
Hierarchy
- Omit<EditorInterfaceProps, "sys">
- EditorInterfaceTemplateProps
Index
Properties
Properties
content
Optionalcontrols
Array of fields and their associated widgetId
+Optionaleditor
Legacy singular editor override
+Optionaleditor
Array of editor layout field groups
+Optionaleditors
Array of editors. Defaults will be used if property is missing.
+Optionalgroup
Array of field groups and their associated widgetId
+Optionalsidebar
Array of sidebar widgets. Defaults will be used if property is missing.
+Interface EntityMetaSysProps
interface EntityMetaSysProps {
archivedAt?: string;
archivedBy?: SysLink;
archivedVersion?: number;
contentType: SysLink;
createdAt: string;
createdBy?: SysLink;
deletedAt?: string;
deletedBy?: SysLink;
deletedVersion?: number;
environment: SysLink;
firstPublishedAt?: string;
id: string;
locale?: string;
publishedAt?: string;
publishedBy?: Link<"User"> | Link<"AppDefinition">;
publishedCounter?: number;
publishedVersion?: number;
space: SysLink;
status?: SysLink;
type: string;
updatedAt: string;
updatedBy?: SysLink;
version: number;
}
archivedAt?: string;
archivedBy?: SysLink;
archivedVersion?: number;
contentType: SysLink;
createdAt: string;
createdBy?: SysLink;
deletedAt?: string;
deletedBy?: SysLink;
deletedVersion?: number;
environment: SysLink;
firstPublishedAt?: string;
id: string;
locale?: string;
publishedAt?: string;
publishedBy?: Link<"User"> | Link<"AppDefinition">;
publishedCounter?: number;
publishedVersion?: number;
space: SysLink;
status?: SysLink;
type: string;
updatedAt: string;
updatedBy?: SysLink;
version: number;
}
Hierarchy (view full)
- MetaSysProps
- EntityMetaSysProps
Index
Properties
Optionalarchived
archived
Optionalarchived
Optionalarchived
archived
content
created
created
Optionalcreated
Optionaldeleted
deleted
Optionaldeleted
Optionaldeleted
deleted
environment
Optionalfirst
first
id
id: string
Optionallocale
locale?: string
Optionalpublished
published
Optionalpublished
Optionalpublished
published
Optionalpublished
published
space
Optionalstatus
type
type: string
updated
updated
Optionalupdated
version
version: number
Interface Entry
interface Entry {
archive: (() => Promise<Entry>);
createComment: ((data: CreateCommentProps) => Promise<Comment | RichTextComment>);
createTask: ((data: CreateTaskProps) => Promise<Task>);
delete: (() => Promise<any>);
fields: KeyValueMap;
getComment: ((id: string) => Promise<Comment | RichTextComment>);
getComments: (() => Promise<Collection<Comment | RichTextComment, CommentProps | RichTextCommentProps>>);
getSnapshot: ((snapshotId: string) => Promise<Snapshot<EntryProps>>);
getSnapshots: ((query?: {}) => Promise<Collection<Snapshot<EntryProps>, SnapshotProps<EntryProps>>>);
getTask: ((id: string) => Promise<Task>);
getTasks: ((query?: {}) => Promise<Collection<Task, TaskProps>>);
isArchived: (() => boolean);
isDraft: (() => boolean);
isPublished: (() => boolean);
isUpdated: (() => boolean);
metadata?: MetadataProps;
patch: ((ops: OpPatch[]) => Promise<Entry>);
publish: (() => Promise<Entry>);
references: ((options?: EntryReferenceOptionsProps) => Promise<Collection<Entry, EntryProps<KeyValueMap>>>);
sys: EntryMetaSysProps;
unarchive: (() => Promise<Entry>);
unpublish: (() => Promise<Entry>);
update: (() => Promise<Entry>);
toPlainObject(): EntryProps<KeyValueMap>;
}
archive: (() => Promise<Entry>);
createComment: ((data: CreateCommentProps) => Promise<Comment | RichTextComment>);
createTask: ((data: CreateTaskProps) => Promise<Task>);
delete: (() => Promise<any>);
fields: KeyValueMap;
getComment: ((id: string) => Promise<Comment | RichTextComment>);
getComments: (() => Promise<Collection<Comment | RichTextComment, CommentProps | RichTextCommentProps>>);
getSnapshot: ((snapshotId: string) => Promise<Snapshot<EntryProps>>);
getSnapshots: ((query?: {}) => Promise<Collection<Snapshot<EntryProps>, SnapshotProps<EntryProps>>>);
getTask: ((id: string) => Promise<Task>);
getTasks: ((query?: {}) => Promise<Collection<Task, TaskProps>>);
isArchived: (() => boolean);
isDraft: (() => boolean);
isPublished: (() => boolean);
isUpdated: (() => boolean);
metadata?: MetadataProps;
patch: ((ops: OpPatch[]) => Promise<Entry>);
publish: (() => Promise<Entry>);
references: ((options?: EntryReferenceOptionsProps) => Promise<Collection<Entry, EntryProps<KeyValueMap>>>);
sys: EntryMetaSysProps;
unarchive: (() => Promise<Entry>);
unpublish: (() => Promise<Entry>);
update: (() => Promise<Entry>);
toPlainObject(): EntryProps<KeyValueMap>;
}
Hierarchy (view full)
- EntryProps
- DefaultElements<EntryProps>
- ContentfulEntryApi
- Entry
Index
Properties
Methods
Properties
archive
Archives the object
+Type declaration
Example: ```javascript +const contentful = require('contentful-management') + +const client = contentful.createClient({ + accessToken: '<content_management_api_key>' +}) + +client.getSpace('<space_id>') +.then((space) => space.getEnvironment('<environment_id>')) +.then((environment) => environment.getEntry('<entry_id>')) +.then((entry) => entry.archive()) +.then((entry) => console.log(`Entry ${entry.sys.id} archived.`)) +.catch(console.error) +```
create
Creates a new comment for an entry
+Type declaration
- (data): Promise<Comment | RichTextComment>
Parameters
- data: CreateCommentProps
Object representation of the Comment to be created
+
Returns Promise<Comment | RichTextComment>
Promise for the newly created Comment
+- data: CreateCommentProps
Example: ```javascript +const contentful = require('contentful-management') + +const client = contentful.createClient({ + accessToken: '<content_management_api_key>' +}) + +client.getSpace('<space_id>') +.then((space) => space.getEnvironment('<environment-id>')) +.then((environment) => environment.getEntry('<entry-id>')) +.then((entry) => entry.createComment({ + body: 'Something left to do' +})) +.then((comment) => console.log(comment)) +.catch(console.error) +```
create
Creates a new task for an entry
+Type declaration
- (data): Promise<Task>
Parameters
- data: CreateTaskProps
Object representation of the Task to be created
+
Returns Promise<Task>
Promise for the newly created Task
+- data: CreateTaskProps
Example: ```javascript +const contentful = require('contentful-management') + +const client = contentful.createClient({ + accessToken: '<content_management_api_key>' +}) + +client.getSpace('<space_id>') +.then((space) => space.getEnvironment('<environment-id>')) +.then((environment) => environment.getEntry('<entry-id>')) +.then((entry) => entry.createTask({ + body: 'Something left to do', + assignedTo: '<user-id>', + status: 'active' +})) +.then((task) => console.log(task)) +.catch(console.error) +```
delete
delete: (() => Promise<any>) = ...
Deletes this object on the server.
+Type declaration
- (): Promise<any>
Returns Promise<any>
Promise for the deletion. It contains no data, but the Promise error case should be handled.
+
Example: ```javascript +const contentful = require('contentful-management') + +const client = contentful.createClient({ + accessToken: '<content_management_api_key>' +}) + +client.getSpace('<space_id>') +.then((space) => space.getEnvironment('<environment_id>')) +.then((environment) => environment.getEntry('<entry_id>')) +.then((entry) => entry.delete()) +.then(() => console.log(`Entry deleted.`)) +.catch(console.error) +```
fields
get
Gets a comment of an entry
+Type declaration
- (id): Promise<Comment | RichTextComment>
Parameters
- id: string
Returns Promise<Comment | RichTextComment>
const contentful = require('contentful-management')
+const client = contentful.createClient({ +accessToken: '<content_management_api_key>' +})
+client.getSpace('<space_id>') +.then((space) => space.getEnvironment('
+')) +.then((environment) => environment.getEntry(' ')) +.then((entry) => entry.getComment( <comment-id>)) +.then((comment) => console.log(comment)) +.catch(console.error)
+ ++
get
get
Gets all comments of an entry
+Type declaration
- (): Promise<Collection<Comment | RichTextComment, CommentProps | RichTextCommentProps>>
Returns Promise<Collection<Comment | RichTextComment, CommentProps | RichTextCommentProps>>
const contentful = require('contentful-management')
+const client = contentful.createClient({ +accessToken: '<content_management_api_key>' +})
+client.getSpace('<space_id>') +.then((space) => space.getEnvironment('
+')) +.then((environment) => environment.getEntry(' ')) +.then((entry) => entry.getComments()) +.then((comments) => console.log(comments)) +.catch(console.error)
+ ++
get
Gets a snapshot of an entry
+Type declaration
- (snapshotId): Promise<Snapshot<EntryProps>>
Parameters
- snapshotId: string
Id of the snapshot
+
Returns Promise<Snapshot<EntryProps>>
- snapshotId: string
Example: ```javascript +const contentful = require('contentful-management') + +const client = contentful.createClient({ + accessToken: '<content_management_api_key>' +}) + +client.getSpace('<space_id>') +.then((space) => space.getEnvironment('<environment_id>')) +.then((environment) => environment.getEntry('<entry_id>')) +.then((entry) => entry.getSnapshot('<snapshot_id>')) +.then((snapshot) => console.log(snapshot)) +.catch(console.error) +```
get
get
Gets all snapshots of an entry
+Example: ```javascript +const contentful = require('contentful-management') + +const client = contentful.createClient({ + accessToken: '<content_management_api_key>' +}) + +client.getSpace('<space_id>') +.then((space) => space.getEnvironment('<environment_id>')) +.then((environment) => environment.getEntry('<entry_id>')) +.then((entry) => entry.getSnapshots()) +.then((snapshots) => console.log(snapshots.items)) +.catch(console.error) +```
get
Gets a task of an entry
+Type declaration
- (id): Promise<Task>
Parameters
- id: string
Returns Promise<Task>
const contentful = require('contentful-management')
+const client = contentful.createClient({ +accessToken: '<content_management_api_key>' +})
+client.getSpace('<space_id>') +.then((space) => space.getEnvironment('
+')) +.then((environment) => environment.getEntry(' ')) +.then((entry) => entry.getTask( <task-id>)) +.then((task) => console.log(task)) +.catch(console.error)
+ ++
get
Gets all tasks of an entry
+Type declaration
- (query?): Promise<Collection<Task, TaskProps>>
Parameters
- query: {} = {}
Returns Promise<Collection<Task, TaskProps>>
const contentful = require('contentful-management')
+const client = contentful.createClient({ +accessToken: '<content_management_api_key>' +})
+client.getSpace('<space_id>') +.then((space) => space.getEnvironment('
+')) +.then((environment) => environment.getEntry(' ')) +.then((entry) => entry.getTasks()) +.then((tasks) => console.log(tasks)) +.catch(console.error)
+ ++- query: {} = {}
is
is
Checks if entry is archived. This means it's not exposed to the Delivery/Preview APIs.
+is
is
Checks if the entry is in draft mode. This means it is not published.
+is
is
Checks if the entry is published. A published entry might have unpublished changes
+is
is
Checks if the entry is updated. This means the entry was previously published but has unpublished changes.
+Optionalmetadata
patch
Sends an JSON patch to the server with any changes made to the object's properties
+Type declaration
Example: ```javascript +const contentful = require('contentful-management') + +const client = contentful.createClient({ + accessToken: '<content_management_api_key>' +}) + +client.getSpace('<space_id>') +.then((space) => space.getEnvironment('<environment_id>')) +.then((environment) => environment.getEntry('<entry_id>')) +.then((entry) => entry.patch([ + { + op: 'replace', + path: '/fields/title/en-US', + value: 'New entry title' + } +])) +.then((entry) => console.log(`Entry ${entry.sys.id} updated.`)) +.catch(console.error) +```
publish
Publishes the object
+Type declaration
Example: ```javascript +const contentful = require('contentful-management') + +const client = contentful.createClient({ + accessToken: '<content_management_api_key>' +}) + +client.getSpace('<space_id>') +.then((space) => space.getEnvironment('<environment_id>')) +.then((environment) => environment.getEntry('<entry_id>')) +.then((entry) => entry.publish()) +.then((entry) => console.log(`Entry ${entry.sys.id} published.`)) +.catch(console.error) +```
references
references: ((options?: EntryReferenceOptionsProps) => Promise<Collection<Entry, EntryProps<KeyValueMap>>>) = ...
Recursively collects references of an entry and their descendants
+sys
unarchive
Unarchives the object
+Type declaration
Example: ```javascript +const contentful = require('contentful-management') + +const client = contentful.createClient({ + accessToken: '<content_management_api_key>' +}) + +client.getSpace('<space_id>') +.then((space) => space.getEnvironment('<environment_id>')) +.then((environment) => environment.getEntry('<entry_id>')) +.then((entry) => entry.unarchive()) +.then((entry) => console.log(`Entry ${entry.sys.id} unarchived.`)) +.catch(console.error) +```
unpublish
Unpublishes the object
+Type declaration
Example: ```javascript +const contentful = require('contentful-management') + +const client = contentful.createClient({ + accessToken: '<content_management_api_key>' +}) + +client.getSpace('<space_id>') +.then((space) => space.getEnvironment('<environment_id>')) +.then((environment) => environment.getEntry('<entry_id>')) +.then((entry) => entry.unpublish()) +.then((entry) => console.log(`Entry ${entry.sys.id} unpublished.`)) +.catch(console.error) +```
update
Sends an update to the server with any changes made to the object's properties
+Type declaration
Example: ```javascript +const contentful = require('contentful-management') + +const client = contentful.createClient({ + accessToken: '<content_management_api_key>' +}) + +client.getSpace('<space_id>') +.then((space) => space.getEnvironment('<environment_id>')) +.then((environment) => environment.getEntry('<entry_id>')) +.then((entry) => { + entry.fields.title['en-US'] = 'New entry title' + return entry.update() +}) +.then((entry) => console.log(`Entry ${entry.sys.id} updated.`)) +.catch(console.error) +```
Methods
to
- to
Plain Object(): EntryProps<KeyValueMap> Returns EntryProps<KeyValueMap>
Interface EntryMetaSysProps
interface EntryMetaSysProps {
archivedAt?: string;
archivedBy?: SysLink;
archivedVersion?: number;
automationTags: Link<"Tag">[];
contentType: SysLink;
createdAt: string;
createdBy?: SysLink;
deletedAt?: string;
deletedBy?: SysLink;
deletedVersion?: number;
environment: SysLink;
firstPublishedAt?: string;
id: string;
locale?: string;
publishedAt?: string;
publishedBy?: Link<"User"> | Link<"AppDefinition">;
publishedCounter?: number;
publishedVersion?: number;
space: SysLink;
status?: SysLink;
type: string;
updatedAt: string;
updatedBy?: SysLink;
version: number;
}
archivedAt?: string;
archivedBy?: SysLink;
archivedVersion?: number;
automationTags: Link<"Tag">[];
contentType: SysLink;
createdAt: string;
createdBy?: SysLink;
deletedAt?: string;
deletedBy?: SysLink;
deletedVersion?: number;
environment: SysLink;
firstPublishedAt?: string;
id: string;
locale?: string;
publishedAt?: string;
publishedBy?: Link<"User"> | Link<"AppDefinition">;
publishedCounter?: number;
publishedVersion?: number;
space: SysLink;
status?: SysLink;
type: string;
updatedAt: string;
updatedBy?: SysLink;
version: number;
}
Hierarchy (view full)
- EntityMetaSysProps
- EntryMetaSysProps
Index
Properties
archived
Properties
Optionalarchived
archived
Optionalarchived
Optionalarchived
archived
automation
content
created
created
Optionalcreated
Optionaldeleted
deleted
Optionaldeleted
Optionaldeleted
deleted
environment
Optionalfirst
first
id
id: string
Optionallocale
locale?: string
Optionalpublished
published
Optionalpublished
Optionalpublished
published
Optionalpublished
published
space
Optionalstatus
type
type: string
updated
updated
Optionalupdated
version
version: number
Interface EnvironmentAlias
interface EnvironmentAlias {
environment: {
sys: MetaLinkProps;
};
sys: BasicMetaSysProps & {
space: SysLink;
};
delete(): Promise<void>;
toPlainObject(): EnvironmentAliasProps;
update(): Promise<EnvironmentAlias>;
}
environment: {
sys: MetaLinkProps;
};
sys: BasicMetaSysProps & {
space: SysLink;
};
delete(): Promise<void>;
toPlainObject(): EnvironmentAliasProps;
update(): Promise<EnvironmentAlias>;
}
Hierarchy (view full)
- EnvironmentAliasProps
- DefaultElements<EnvironmentAliasProps>
- EnvironmentAlias
Index
Properties
environment
+sys
+
Methods
Methods
delete
- delete(): Promise<void>
Deletes this object on the server.
+Returns Promise<void>
Promise for the deletion. It contains no data, but the Promise error case should be handled.
+
+ +const contentful = require('contentful-management')
const client = contentful.createClient({
accessToken: '<content_management_api_key>'
})
client.getSpace('<space_id>')
.then((space) => space.getEnvironmentAlias('<environment_alias_id>'))
.then((alias) => {
return alias.delete()
})
.then(() => console.log(`Alias deleted.`))
.catch(console.error) +
to
- to
Plain Object(): EnvironmentAliasProps Returns EnvironmentAliasProps
update
- update(): Promise<EnvironmentAlias>
Sends an update to the server with any changes made to the object's properties. Currently, you can only change the id of the alias's underlying environment. See the example below.
+Returns Promise<EnvironmentAlias>
Object returned from the server with updated changes.
+
+ +const contentful = require('contentful-management')
const client = contentful.createClient({
accessToken: '<content_management_api_key>'
})
client.getSpace('<space_id>')
.then((space) => space.getEnvironmentAlias('<environment_alias_id>'))
.then((alias) => {
alias.environment.sys.id = '<environment_id>'
return alias.update()
})
.then((alias) => console.log(`alias ${alias.sys.id} updated.`))
.catch(console.error) +
diff --git a/contentful-management/11.40.3/interfaces/FieldGroupItem.html b/contentful-management/11.40.3/interfaces/FieldGroupItem.html
new file mode 100644
index 0000000000..c2da289fd1
--- /dev/null
+++ b/contentful-management/11.40.3/interfaces/FieldGroupItem.html
@@ -0,0 +1,4 @@
+
diff --git a/contentful-management/11.40.3/interfaces/GroupControl.html b/contentful-management/11.40.3/interfaces/GroupControl.html
new file mode 100644
index 0000000000..691a6227b3
--- /dev/null
+++ b/contentful-management/11.40.3/interfaces/GroupControl.html
@@ -0,0 +1,9 @@
+
Interface GroupControl
interface GroupControl {
groupId: string;
settings?: DefinedParameters;
widgetId?: string;
widgetNamespace?: string;
}
groupId: string;
settings?: DefinedParameters;
widgetId?: string;
widgetNamespace?: string;
}
Hierarchy
- WidgetConfig
- GroupControl
Index
Properties
Interface Link<T>
Link is a reference object to another entity that can be resolved using tools such as contentful-resolve
+Type Parameters
Index
Properties
sys
+
Interface Locale
interface Locale {
code: string;
contentDeliveryApi: boolean;
contentManagementApi: boolean;
default: boolean;
fallbackCode: null | string;
internal_code: string;
name: string;
optional: boolean;
sys: BasicMetaSysProps & {
environment: SysLink;
space: SysLink;
};
delete(): Promise<void>;
toPlainObject(): LocaleProps;
update(): Promise<Locale>;
}
code: string;
contentDeliveryApi: boolean;
contentManagementApi: boolean;
default: boolean;
fallbackCode: null | string;
internal_code: string;
name: string;
optional: boolean;
sys: BasicMetaSysProps & {
environment: SysLink;
space: SysLink;
};
delete(): Promise<void>;
toPlainObject(): LocaleProps;
update(): Promise<Locale>;
}
Hierarchy (view full)
Index
Properties
Methods
Properties
code
code: string
Locale code (example: en-us)
+content
content
If the content under this locale should be available on the CDA (for public reading)
+content
content
If the content under this locale should be available on the CMA (for editing)
+default
default: boolean
If this is the default locale
+fallback
fallback
Locale code to fallback to when there is not content for the current locale
+internal_
internal_
Internal locale code
+name
name: string
Locale name
+optional
optional: boolean
If the locale needs to be filled in on entries or not
+sys
Methods
delete
- delete(): Promise<void>
Deletes this object on the server.
+Returns Promise<void>
Promise for the deletion. It contains no data, but the Promise error case should be handled.
+Example: ```javascript +const contentful = require('contentful-management') + +const client = contentful.createClient({ + accessToken: '<content_management_api_key>' +}) + +client.getSpace('<space_id>') +.then((space) => space.getEnvironment('<environment_id>')) +.then((environment) => environment.getLocale('<locale_id>')) +.then((locale) => locale.delete()) +.then(() => console.log(`locale deleted.`)) +.catch(console.error) +```
to
- to
Plain Object(): LocaleProps Returns LocaleProps
update
- update(): Promise<Locale>
Sends an update to the server with any changes made to the object's properties
+Returns Promise<Locale>
Object returned from the server with updated changes.
+Example: ```javascript +const contentful = require('contentful-management') + +const client = contentful.createClient({ + accessToken: '<content_management_api_key>' +}) + +client.getSpace('<space_id>') +.then((space) => space.getEnvironment('<environment_id>')) +.then((environment) => environment.getLocale('<locale_id>')) +.then((locale) => { + locale.name = 'New locale name' + return locale.update() +}) +.then((locale) => console.log(`locale ${locale.sys.id} updated.`)) +.catch(console.error) +```
Interface MakeRequestOptions
interface MakeRequestOptions {
action: string;
entityType: keyof MRActions;
headers?: Partial<RawAxiosHeaders & {
Accept: AxiosHeaderValue;
Authorization: AxiosHeaderValue;
Content-Encoding: AxiosHeaderValue;
Content-Length: AxiosHeaderValue;
User-Agent: AxiosHeaderValue;
} & {
Content-Type: ContentType;
}>;
params?: Record<string, unknown>;
payload?: Record<string, unknown> | MakeRequestPayload | OpPatch[];
userAgent: string;
}
action: string;
entityType: keyof MRActions;
headers?: Partial<RawAxiosHeaders & {
Accept: AxiosHeaderValue;
Authorization: AxiosHeaderValue;
Content-Encoding: AxiosHeaderValue;
Content-Length: AxiosHeaderValue;
User-Agent: AxiosHeaderValue;
} & {
Content-Type: ContentType;
}>;
params?: Record<string, unknown>;
payload?: Record<string, unknown> | MakeRequestPayload | OpPatch[];
userAgent: string;
}
Properties
action
action: string
entity
entity
Optionalheaders
headers?: Partial<RawAxiosHeaders & {
Accept: AxiosHeaderValue;
Authorization: AxiosHeaderValue;
Content-Encoding: AxiosHeaderValue;
Content-Length: AxiosHeaderValue;
User-Agent: AxiosHeaderValue;
} & {
Content-Type: ContentType;
}>
Accept: AxiosHeaderValue;
Authorization: AxiosHeaderValue;
Content-Encoding: AxiosHeaderValue;
Content-Length: AxiosHeaderValue;
User-Agent: AxiosHeaderValue;
} & {
Content-Type: ContentType;
}>
Optionalparams
params?: Record<string, unknown>
Optionalpayload
user
user
Interface MakeRequestPayload
Base interface for all Payload interfaces. Used as part of the MakeRequestOptions to simplify payload definitions.
+Hierarchy (view full)
diff --git a/contentful-management/11.40.3/interfaces/MetaSysProps.html b/contentful-management/11.40.3/interfaces/MetaSysProps.html
new file mode 100644
index 0000000000..6ec27b2f86
--- /dev/null
+++ b/contentful-management/11.40.3/interfaces/MetaSysProps.html
@@ -0,0 +1,19 @@
+
Interface MetaSysProps
interface MetaSysProps {
archivedAt?: string;
archivedBy?: SysLink;
archivedVersion?: number;
createdAt: string;
createdBy?: SysLink;
deletedAt?: string;
deletedBy?: SysLink;
deletedVersion?: number;
id: string;
publishedVersion?: number;
space?: SysLink;
status?: SysLink;
type: string;
updatedAt: string;
updatedBy?: SysLink;
version: number;
}
archivedAt?: string;
archivedBy?: SysLink;
archivedVersion?: number;
createdAt: string;
createdBy?: SysLink;
deletedAt?: string;
deletedBy?: SysLink;
deletedVersion?: number;
id: string;
publishedVersion?: number;
space?: SysLink;
status?: SysLink;
type: string;
updatedAt: string;
updatedBy?: SysLink;
version: number;
}
Hierarchy (view full)
- BasicMetaSysProps
- MetaSysProps
Index
Properties
Properties
Optionalarchived
archived
Optionalarchived
Optionalarchived
archived
created
created
Optionalcreated
Optionaldeleted
deleted
Optionaldeleted
Optionaldeleted
deleted
id
id: string
Optionalpublished
published
Optionalspace
Optionalstatus
type
type: string
updated
updated
Optionalupdated
version
version: number
diff --git a/contentful-management/11.40.3/interfaces/NavigationItem.html b/contentful-management/11.40.3/interfaces/NavigationItem.html
new file mode 100644
index 0000000000..5605fe4907
--- /dev/null
+++ b/contentful-management/11.40.3/interfaces/NavigationItem.html
@@ -0,0 +1,3 @@
+
diff --git a/contentful-management/11.40.3/interfaces/OrganizationInvitation.html b/contentful-management/11.40.3/interfaces/OrganizationInvitation.html
new file mode 100644
index 0000000000..f9875e97da
--- /dev/null
+++ b/contentful-management/11.40.3/interfaces/OrganizationInvitation.html
@@ -0,0 +1,7 @@
+
Interface OrganizationInvitation
interface OrganizationInvitation {
email: string;
firstName: string;
lastName: string;
role: string;
sys: MetaSysProps & {
invitationUrl: string;
organizationMembership: {
sys: MetaLinkProps;
};
status: string;
user: null | Record<string, any>;
};
toPlainObject(): OrganizationInvitationProps;
}
email: string;
firstName: string;
lastName: string;
role: string;
sys: MetaSysProps & {
invitationUrl: string;
organizationMembership: {
sys: MetaLinkProps;
};
status: string;
user: null | Record<string, any>;
};
toPlainObject(): OrganizationInvitationProps;
}
Hierarchy (view full)
- OrganizationInvitationProps
- DefaultElements<OrganizationInvitationProps>
- OrganizationInvitation
Properties
email: string
first
first
last
last
role
role: string
sys
sys: MetaSysProps & {
invitationUrl: string;
organizationMembership: {
sys: MetaLinkProps;
};
status: string;
user: null | Record<string, any>;
}
invitationUrl: string;
organizationMembership: {
sys: MetaLinkProps;
};
status: string;
user: null | Record<string, any>;
}
Methods
to
- to
Plain Object(): OrganizationInvitationProps Returns OrganizationInvitationProps
Interface OrganizationMembership
interface OrganizationMembership {
role: string;
status: boolean;
sys: MetaSysProps & {
user: {
sys: MetaLinkProps;
};
};
delete(): Promise<void>;
toPlainObject(): OrganizationMembershipProps;
update(): Promise<OrganizationMembership>;
}
role: string;
status: boolean;
sys: MetaSysProps & {
user: {
sys: MetaLinkProps;
};
};
delete(): Promise<void>;
toPlainObject(): OrganizationMembershipProps;
update(): Promise<OrganizationMembership>;
}
Hierarchy (view full)
- OrganizationMembershipProps
- DefaultElements<OrganizationMembershipProps>
- OrganizationMembership
Methods
delete
- delete(): Promise<void>
Deletes this object on the server. +@example```javascript +const contentful = require('contentful-management')
+const client = contentful.createClient({ +accessToken: '<content_management_api_key>' +})
+client.getOrganization('organization_id') +.then(org => org.getOrganizationMembership('organizationMembership_id')) +.then((organizationMembership) => { +organizationMembership.delete(); +}) +.catch(console.error)
+
+ ++Returns Promise<void>
to
- to
Plain Object(): OrganizationMembershipProps Returns OrganizationMembershipProps
update
- update(): Promise<OrganizationMembership>
Sends an update to the server with any changes made to the object's properties
+Returns Promise<OrganizationMembership>
Object returned from the server with updated changes.
+Example: ```javascript +const contentful = require('contentful-management') + +const client = contentful.createClient({ + accessToken: '<content_management_api_key>' +}) + +client.getOrganization('organization_id') +.then(org => org.getOrganizationMembership('organizationMembership_id')) +.then((organizationMembership) => { + organizationMembership.role = 'member'; + organizationMembership.update(); +}) +.catch(console.error)
diff --git a/contentful-management/11.40.3/interfaces/ParameterDefinition.html b/contentful-management/11.40.3/interfaces/ParameterDefinition.html
new file mode 100644
index 0000000000..e17dc7b449
--- /dev/null
+++ b/contentful-management/11.40.3/interfaces/ParameterDefinition.html
@@ -0,0 +1,9 @@
+
Interface ParameterDefinition<T>
interface ParameterDefinition<T> {
default?: string | number | boolean;
description?: string;
id: string;
labels?: {
empty?: string;
false?: string;
true?: string;
};
name: string;
options?: ParameterOption[];
required?: boolean;
type: T;
}
default?: string | number | boolean;
description?: string;
id: string;
labels?: {
empty?: string;
false?: string;
true?: string;
};
name: string;
options?: ParameterOption[];
required?: boolean;
type: T;
}
Type Parameters
- T = ParameterType
Interface PersonalAccessToken
interface PersonalAccessToken {
name: string;
revokedAt: null | string;
scopes: "content_management_manage"[];
sys: MetaSysProps & {
expiresAt?: string;
};
token?: string;
revoke(): Promise<PersonalAccessToken>;
toPlainObject(): PersonalAccessTokenProps;
}
name: string;
revokedAt: null | string;
scopes: "content_management_manage"[];
sys: MetaSysProps & {
expiresAt?: string;
};
token?: string;
revoke(): Promise<PersonalAccessToken>;
toPlainObject(): PersonalAccessTokenProps;
}
Hierarchy (view full)
- PersonalAccessTokenProps
- DefaultElements<PersonalAccessTokenProps>
- PersonalAccessToken
Properties
name
name: string
revoked
revoked
scopes
scopes: "content_management_manage"[]
sys
Optionaltoken
token?: string
Methods
revoke
- revoke(): Promise<PersonalAccessToken>
Revokes a personal access token
+Returns Promise<PersonalAccessToken>
Object the revoked personal access token
+Example: ```javascript +const contentful = require('contentful-management') + +const client = contentful.createClient({ + accessToken: <content_management_api_key> +}) + +client.getPersonalAccessToken('<token-id>') + .then((personalAccessToken) => { + return personalAccessToken.revoke() + }) + .catch(console.error) +```
to
- to
Plain Object(): PersonalAccessTokenProps Returns PersonalAccessTokenProps
Interface PreviewApiKey
interface PreviewApiKey {
accessToken: string;
description: string;
name: string;
sys: MetaSysProps;
toPlainObject(): PreviewApiKeyProps;
}
accessToken: string;
description: string;
name: string;
sys: MetaSysProps;
toPlainObject(): PreviewApiKeyProps;
}
Hierarchy (view full)
- PreviewApiKeyProps
- DefaultElements<PreviewApiKeyProps>
- PreviewApiKey
Index
Properties
Methods
Methods
to
- to
Plain Object(): PreviewApiKeyProps Returns PreviewApiKeyProps
Interface QueryOptions
interface QueryOptions {
content_type?: string;
include?: number;
limit?: number;
links_to_entry?: string;
order?: string;
select?: string;
skip?: number;
[key: string]: any;
}
content_type?: string;
include?: number;
limit?: number;
links_to_entry?: string;
order?: string;
select?: string;
skip?: number;
[key: string]: any;
}
Hierarchy (view full)
- PaginationQueryOptions
- BasicQueryOptions
- QueryOptions
Indexable
- [key: string]: any
Index
Properties
Interface Release
The object returned by the Releases API
+interface Release {
entities: BaseCollection<Link<Entity>>;
metadata?: ReleaseMetadata;
sys: ReleaseSysProps;
title: string;
archive(): Promise<Release>;
delete(): Promise<void>;
publish(options?: AsyncActionProcessingOptions): Promise<ReleaseAction<"publish">>;
toPlainObject(): ReleaseProps;
unarchive(): Promise<Release>;
unpublish(options?: AsyncActionProcessingOptions): Promise<ReleaseAction<"unpublish">>;
update(payload: ReleasePayload): Promise<Release>;
validate(__namedParameters?: {
options?: AsyncActionProcessingOptions;
payload?: ReleaseValidatePayload;
}): Promise<ReleaseAction<"validate">>;
}
entities: BaseCollection<Link<Entity>>;
metadata?: ReleaseMetadata;
sys: ReleaseSysProps;
title: string;
archive(): Promise<Release>;
delete(): Promise<void>;
publish(options?: AsyncActionProcessingOptions): Promise<ReleaseAction<"publish">>;
toPlainObject(): ReleaseProps;
unarchive(): Promise<Release>;
unpublish(options?: AsyncActionProcessingOptions): Promise<ReleaseAction<"unpublish">>;
update(payload: ReleasePayload): Promise<Release>;
validate(__namedParameters?: {
options?: AsyncActionProcessingOptions;
payload?: ReleaseValidatePayload;
}): Promise<ReleaseAction<"validate">>;
}
Hierarchy (view full)
- ReleaseProps
- ReleaseApiMethods
- DefaultElements<ReleaseProps>
- Release
Methods
archive
delete
publish
- publish(options?): Promise<ReleaseAction<"publish">>
Publishes a Release and waits until the asynchronous action is completed
+Parameters
Optionaloptions: AsyncActionProcessingOptions
Returns Promise<ReleaseAction<"publish">>
to
- to
Plain Object(): ReleaseProps Returns ReleaseProps
unarchive
unpublish
- unpublish(options?): Promise<ReleaseAction<"unpublish">>
Unpublishes a Release and waits until the asynchronous action is completed
+Parameters
Optionaloptions: AsyncActionProcessingOptions
Returns Promise<ReleaseAction<"unpublish">>
update
- update(payload): Promise<Release>
Updates a Release and returns the updated Release object
+Parameters
- payload: ReleasePayload
Returns Promise<Release>
validate
- validate(__namedParameters?): Promise<ReleaseAction<"validate">>
Validates a Release and waits until the asynchronous action is completed
+Parameters
Optional__namedParameters: {
options?: AsyncActionProcessingOptions;
payload?: ReleaseValidatePayload;
}Optionaloptions?: AsyncActionProcessingOptionsOptionalpayload?: ReleaseValidatePayload
Returns Promise<ReleaseAction<"validate">>
Interface ReleaseAction<T>
The object returned by the Releases API
+interface ReleaseAction<T> {
action: T;
sys: ReleaseActionSysProps;
get(): ReleaseAction<any>;
toPlainObject(): ReleaseActionProps<T>;
waitProcessing(options?: AsyncActionProcessingOptions): ReleaseAction<any>;
}
action: T;
sys: ReleaseActionSysProps;
get(): ReleaseAction<any>;
toPlainObject(): ReleaseActionProps<T>;
waitProcessing(options?: AsyncActionProcessingOptions): ReleaseAction<any>;
}
Type Parameters
- T extends ReleaseActionTypes = any
Hierarchy (view full)
- ReleaseActionProps<T>
- ReleaseActionApiMethods
- DefaultElements<ReleaseActionProps<T>>
- ReleaseAction
Index
Properties
Methods
Methods
get
- get(): ReleaseAction<any>
Performs a new GET request and returns the wrapper Release
+Returns ReleaseAction<any>
to
- to
Plain Object(): ReleaseActionProps<T> Returns ReleaseActionProps<T>
wait
- wait
Processing(options?): ReleaseAction<any> Waits until the Release Action has either succeeded or failed
+Parameters
Optionaloptions: AsyncActionProcessingOptions
Returns ReleaseAction<any>
Interface ReleaseActionProps<T>
The object returned by the Releases API
+Type Parameters
- T extends ReleaseActionTypes = any
Hierarchy (view full)
- ReleaseActionProps
Interface ReleaseActionQueryOptions
interface ReleaseActionQueryOptions {
action?: ReleaseActionTypes;
limit?: number;
order?: string;
sys.id[in]?: string;
sys.release.sys.id[in]?: string;
sys.status[in]?: string;
sys.status[nin]?: string;
uniqueBy?: string;
}
action?: ReleaseActionTypes;
limit?: number;
order?: string;
sys.id[in]?: string;
sys.release.sys.id[in]?: string;
sys.status[in]?: string;
sys.status[nin]?: string;
uniqueBy?: string;
}
Index
Properties
Properties
Optionalaction
Optionallimit
limit?: number
Limit of how many records are returned in the query result
+Optionalorder
order?: string
Optionalsys.id[in]
sys.id[in]?: string
Find Release Actions by using a comma-separated list of Ids
+Optionalsys.release.sys.id[in]
sys.release.sys.id[in]?: string
Optionalsys.status[in]
sys.status[in]?: string
Optionalsys.status[nin]
sys.status[nin]?: string
Optionalunique
unique
Get unique results by this field. Currently supports sys.release.sys.id
Interface ReleasePayload
Base interface for all Payload interfaces. Used as part of the MakeRequestOptions to simplify payload definitions.
+Hierarchy (view full)
- MakeRequestPayload
- ReleasePayload
Interface ReleaseProps
The object returned by the Releases API
+interface ReleaseProps {
entities: BaseCollection<Link<Entity>>;
metadata?: ReleaseMetadata;
sys: ReleaseSysProps;
title: string;
}
entities: BaseCollection<Link<Entity>>;
metadata?: ReleaseMetadata;
sys: ReleaseSysProps;
title: string;
}
Hierarchy (view full)
- ReleaseProps
Interface ReleaseQueryOptions
interface ReleaseQueryOptions {
entities.sys.id[in]?: string;
entities.sys.linkType?: string;
entities[exists]?: boolean;
limit?: number;
order?: string;
pageNext?: string;
sys.createdBy.sys.id[in]?: string;
sys.id[in]?: string;
sys.id[nin]?: string;
sys.status[in]?: ReleaseStatus;
sys.status[nin]?: ReleaseStatus;
title[match]?: string;
}
entities.sys.id[in]?: string;
entities.sys.linkType?: string;
entities[exists]?: boolean;
limit?: number;
order?: string;
pageNext?: string;
sys.createdBy.sys.id[in]?: string;
sys.id[in]?: string;
sys.id[nin]?: string;
sys.status[in]?: ReleaseStatus;
sys.status[nin]?: ReleaseStatus;
title[match]?: string;
}
Properties
Optionalentities.sys.id[in]
entities.sys.id[in]?: string
Find releases containing the specified, comma-separated entities. Requires entities.sys.linkType
Optionalentities.sys.link
entities.sys.link
Find releases filtered by the Entity type (Asset, Entry)
+Optionalentities[exists]
entities[exists]?: boolean
Filter by empty Releases (exists=false) or Releases with items (exists=true)
+Optionallimit
limit?: number
Limit how many records are returned in the result
+Optionalorder
order?: string
Order releases +Supported values include
+-
+
title,-title
+sys.updatedAt,-sys.updatedAt
+sys.createdAt,-sys.createdAt
+
Optionalpage
page
If present, will return results based on a pagination cursor
+Optionalsys.created
sys.created
Comma-separated list of user Ids to find releases by creator
+Optionalsys.id[in]
sys.id[in]?: string
Comma-separated list of Ids to find (inclusion)
+Optionalsys.id[nin]
sys.id[nin]?: string
Comma-separated list of ids to exclude from the query
+Optionalsys.status[in]
sys.status[in]?: ReleaseStatus
Comma-separated filter (inclusion) by Release status (active, archived)
+Optionalsys.status[nin]
sys.status[nin]?: ReleaseStatus
Comma-separated filter (exclusion) by Release status (active, archived)
+Optionaltitle[match]
title[match]?: string
Find releases using full text phrase and term matching
+Interface ReleaseValidateOptions
interface ReleaseValidateOptions {
payload?: ReleaseValidatePayload;
processingOptions?: AsyncActionProcessingOptions;
}
payload?: ReleaseValidatePayload;
processingOptions?: AsyncActionProcessingOptions;
}
Index
Properties
Interface ResourceLink<T>
ResourceLink is a reference object to another entity outside of the current space/environment
+Type Parameters
Index
Properties
sys
+
Interface ResourceProvider
interface ResourceProvider {
function: SysLink;
sys: Omit<BasicMetaSysProps, "version"> & {
appDefinition: SysLink;
organization: SysLink;
};
type: "function";
delete(): Promise<void>;
getResourceType(id: string): Promise<ResourceType>;
getResourceTypes(): Promise<CollectionProp<ResourceType>>;
toPlainObject(): ResourceProviderProps;
upsert(): Promise<ResourceProvider>;
upsertResourceType(id: string, data: UpsertResourceTypeProps): Promise<ResourceType>;
}
function: SysLink;
sys: Omit<BasicMetaSysProps, "version"> & {
appDefinition: SysLink;
organization: SysLink;
};
type: "function";
delete(): Promise<void>;
getResourceType(id: string): Promise<ResourceType>;
getResourceTypes(): Promise<CollectionProp<ResourceType>>;
toPlainObject(): ResourceProviderProps;
upsert(): Promise<ResourceProvider>;
upsertResourceType(id: string, data: UpsertResourceTypeProps): Promise<ResourceType>;
}
Hierarchy (view full)
- ResourceProviderProps
- DefaultElements<ResourceProviderProps>
- ResourceProvider
Index
Properties
Methods
Properties
function
Link to a Contentful function
+sys
System metadata
+type
type
Resource Provider type, value is 'function'
+ Methods
delete
get
- get
Resource Type(id): Promise<ResourceType> Parameters
- id: string
Returns Promise<ResourceType>
get
- get
Resource Types(): Promise<CollectionProp<ResourceType>> Returns Promise<CollectionProp<ResourceType>>
to
- to
Plain Object(): ResourceProviderProps Returns ResourceProviderProps
upsert
- upsert(): Promise<ResourceProvider>
Returns Promise<ResourceProvider>
upsert
- upsert
Resource Type(id, data): Promise<ResourceType> Parameters
- id: string
- data: UpsertResourceTypeProps
Returns Promise<ResourceType>
Interface ResourceType
interface ResourceType {
defaultFieldMapping: {
badge?: {
label: string;
variant: string;
};
description?: string;
externalUrl?: string;
image?: {
altText?: string;
url: string;
};
subtitle?: string;
title: string;
};
name: string;
sys: Omit<BasicMetaSysProps, "version"> & {
appDefinition: SysLink;
organization: SysLink;
resourceProvider: SysLink;
};
delete(): Promise<void>;
toPlainObject(): ResourceTypeProps;
upsert(): Promise<ResourceType>;
}
defaultFieldMapping: {
badge?: {
label: string;
variant: string;
};
description?: string;
externalUrl?: string;
image?: {
altText?: string;
url: string;
};
subtitle?: string;
title: string;
};
name: string;
sys: Omit<BasicMetaSysProps, "version"> & {
appDefinition: SysLink;
organization: SysLink;
resourceProvider: SysLink;
};
delete(): Promise<void>;
toPlainObject(): ResourceTypeProps;
upsert(): Promise<ResourceType>;
}
Hierarchy (view full)
- ResourceTypeProps
- DefaultElements<ResourceTypeProps>
- ResourceType
Index
Properties
Methods
Properties
default
default
badge?: {
label: string;
variant: string;
};
description?: string;
externalUrl?: string;
image?: {
altText?: string;
url: string;
};
subtitle?: string;
title: string;
}
badge?: {
label: string;
variant: string;
};
description?: string;
externalUrl?: string;
image?: {
altText?: string;
url: string;
};
subtitle?: string;
title: string;
}
Resource Type defaultFieldMapping
+name
name: string
Resource Type name
+sys
sys: Omit<BasicMetaSysProps, "version"> & {
appDefinition: SysLink;
organization: SysLink;
resourceProvider: SysLink;
}
appDefinition: SysLink;
organization: SysLink;
resourceProvider: SysLink;
}
System metadata
+ Methods
delete
to
- to
Plain Object(): ResourceTypeProps Returns ResourceTypeProps
upsert
- upsert(): Promise<ResourceType>
Returns Promise<ResourceType>
diff --git a/contentful-management/11.40.3/interfaces/Role.html b/contentful-management/11.40.3/interfaces/Role.html
new file mode 100644
index 0000000000..b35fe7b64a
--- /dev/null
+++ b/contentful-management/11.40.3/interfaces/Role.html
@@ -0,0 +1,124 @@
+
Interface Role
interface Role {
description?: string;
name: string;
permissions: {
ContentDelivery: string | string[];
ContentModel: string[];
EnvironmentAliases: string | string[];
Environments: string | string[];
Settings: string | string[];
Tags: string | string[];
};
policies: {
actions: ActionType[] | "all";
constraint: ConstraintType;
effect: string;
}[];
sys: BasicMetaSysProps & {
space: SysLink;
};
delete(): Promise<void>;
toPlainObject(): RoleProps;
update(): Promise<Role>;
}
description?: string;
name: string;
permissions: {
ContentDelivery: string | string[];
ContentModel: string[];
EnvironmentAliases: string | string[];
Environments: string | string[];
Settings: string | string[];
Tags: string | string[];
};
policies: {
actions: ActionType[] | "all";
constraint: ConstraintType;
effect: string;
}[];
sys: BasicMetaSysProps & {
space: SysLink;
};
delete(): Promise<void>;
toPlainObject(): RoleProps;
update(): Promise<Role>;
}
Hierarchy (view full)
Index
Properties
Methods
Properties
Optionaldescription
description?: string
name
name: string
permissions
permissions: {
ContentDelivery: string | string[];
ContentModel: string[];
EnvironmentAliases: string | string[];
Environments: string | string[];
Settings: string | string[];
Tags: string | string[];
}
ContentDelivery: string | string[];
ContentModel: string[];
EnvironmentAliases: string | string[];
Environments: string | string[];
Settings: string | string[];
Tags: string | string[];
}
Permissions for application sections
+policies
policies: {
actions: ActionType[] | "all";
constraint: ConstraintType;
effect: string;
}[]
actions: ActionType[] | "all";
constraint: ConstraintType;
effect: string;
}[]
sys
Methods
delete
- delete(): Promise<void>
Deletes this object on the server.
+Returns Promise<void>
Promise for the deletion. It contains no data, but the Promise error case should be handled.
+Example: ```javascript +const contentful = require('contentful-management') + +const client = contentful.createClient({ + accessToken: '<content_management_api_key>' +}) + +client.getSpace('<space_id>') +.then((space) => space.getRole('<role_id>')) +.then((role) => role.delete()) +.then((role) => console.log(`role deleted.`)) +.catch(console.error) +```
to
update
- update(): Promise<Role>
Sends an update to the server with any changes made to the object's properties
+Returns Promise<Role>
Object returned from the server with updated changes.
+Example: ```javascript +const contentful = require('contentful-management') + +const client = contentful.createClient({ + accessToken: '<content_management_api_key>' +}) + +client.getSpace('<space_id>') +.then((space) => space.getRole('<roles_id>')) +.then((roles) => { + roles.name = 'New role name' + return roles.update() +}) +.then((roles) => console.log(`roles ${roles.sys.id} updated.`)) +.catch(console.error) +```
Interface ScheduledAction
interface ScheduledAction {
action: SchedulableActionType;
entity: Link<SchedulableEntityType>;
environment?: {
sys: MetaLinkProps;
};
error?: ScheduledActionFailedError;
payload?: ScheduledActionPayloadProps;
scheduledFor: {
datetime: string;
timezone?: string;
};
sys: ScheduledActionSysProps;
delete(): Promise<ScheduledAction>;
toPlainObject(): ScheduledActionProps;
update(): Promise<ScheduledAction>;
}
action: SchedulableActionType;
entity: Link<SchedulableEntityType>;
environment?: {
sys: MetaLinkProps;
};
error?: ScheduledActionFailedError;
payload?: ScheduledActionPayloadProps;
scheduledFor: {
datetime: string;
timezone?: string;
};
sys: ScheduledActionSysProps;
delete(): Promise<ScheduledAction>;
toPlainObject(): ScheduledActionProps;
update(): Promise<ScheduledAction>;
}
Hierarchy (view full)
- ScheduledActionProps
- DefaultElements<ScheduledActionProps>
- ScheduledActionApi
- ScheduledAction
Index
Properties
Methods
Properties
action
action: SchedulableActionType
entity
Optionalenvironment
Optionalerror
error?: ScheduledActionFailedError
The Contentful-style error that occurred during execution if sys.status is failed
+Optionalpayload
payload?: ScheduledActionPayloadProps
scheduled
scheduled
datetime: string;
timezone?: string;
}
datetime: string;
timezone?: string;
}
Type declaration
datetime: string
Optionaltimezone?: stringA valid IANA timezone Olson identifier
+
sys
Methods
delete
- delete(): Promise<ScheduledAction>
Returns Promise<ScheduledAction>
to
- to
Plain Object(): ScheduledActionProps Returns ScheduledActionProps
update
- update(): Promise<ScheduledAction>
Returns Promise<ScheduledAction>
Interface SidebarItem
interface SidebarItem {
disabled?: boolean;
settings?: DefinedParameters;
widgetId: string;
widgetNamespace: string;
}
disabled?: boolean;
settings?: DefinedParameters;
widgetId: string;
widgetNamespace: string;
}
Index
Properties
diff --git a/contentful-management/11.40.3/interfaces/Snapshot.html b/contentful-management/11.40.3/interfaces/Snapshot.html
new file mode 100644
index 0000000000..3c88ec91f9
--- /dev/null
+++ b/contentful-management/11.40.3/interfaces/Snapshot.html
@@ -0,0 +1,4 @@
+
Interface Snapshot<T>
interface Snapshot<T> {
snapshot: T;
sys: MetaSysProps & {
snapshotEntityType: string;
snapshotType: string;
};
toPlainObject(): SnapshotProps<T>;
}
snapshot: T;
sys: MetaSysProps & {
snapshotEntityType: string;
snapshotType: string;
};
toPlainObject(): SnapshotProps<T>;
}
Type Parameters
Hierarchy (view full)
- SnapshotProps<T>
- DefaultElements<SnapshotProps<T>>
- Snapshot
Index
Properties
Methods
Methods
to
- to
Plain Object(): SnapshotProps<T> Returns SnapshotProps<T>
Interface SpaceMember
interface SpaceMember {
admin: boolean;
roles: {
sys: MetaLinkProps;
}[];
sys: MetaSysProps;
toPlainObject(): SpaceMemberProps;
}
admin: boolean;
roles: {
sys: MetaLinkProps;
}[];
sys: MetaSysProps;
toPlainObject(): SpaceMemberProps;
}
Hierarchy (view full)
- SpaceMemberProps
- DefaultElements<SpaceMemberProps>
- SpaceMember
Index
Properties
Methods
Methods
to
- to
Plain Object(): SpaceMemberProps Returns SpaceMemberProps
Interface SpaceMembership
interface SpaceMembership {
admin: boolean;
roles: SysLink[];
sys: MetaSysProps & {
space: SysLink;
user: SysLink;
};
user: SysLink;
delete(): Promise<void>;
toPlainObject(): SpaceMembershipProps;
update(): Promise<SpaceMembership>;
}
admin: boolean;
roles: SysLink[];
sys: MetaSysProps & {
space: SysLink;
user: SysLink;
};
user: SysLink;
delete(): Promise<void>;
toPlainObject(): SpaceMembershipProps;
update(): Promise<SpaceMembership>;
}
Hierarchy (view full)
- SpaceMembershipProps
- DefaultElements<SpaceMembershipProps>
- SpaceMembership
Methods
delete
- delete(): Promise<void>
Deletes this object on the server.
+Returns Promise<void>
Promise for the deletion. It contains no data, but the Promise error case should be handled.
+Example: ```javascript +const contentful = require('contentful-management') + +const client = contentful.createClient({ + accessToken: '<content_management_api_key>' +}) + +client.getSpace('<space_id>') +.then((space) => space.getSpaceMembership('<spaceMembership_id>')) +.then((spaceMembership) => spaceMembership.delete()) +.then(() => console.log(`spaceMembership deleted.`)) +.catch(console.error) +```
to
- to
Plain Object(): SpaceMembershipProps Returns SpaceMembershipProps
update
- update(): Promise<SpaceMembership>
Sends an update to the server with any changes made to the object's properties
+Returns Promise<SpaceMembership>
Object returned from the server with updated changes.
+Example: ```javascript +const contentful = require('contentful-management') + +const client = contentful.createClient({ + accessToken: '<content_management_api_key>' +}) + +client.getSpace('<space_id>') +.then((space) => space.getSpaceMembership('<spaceMembership_id>')) +.then((spaceMembership) => { + spaceMembership.name = 'new space membership name' +}) +.then((spaceMembership) => console.log(`spaceMembership ${spaceMembership.sys.id} updated.`)) +.catch(console.error) +```
diff --git a/contentful-management/11.40.3/interfaces/SysLink.html b/contentful-management/11.40.3/interfaces/SysLink.html
new file mode 100644
index 0000000000..2d0d61fecb
--- /dev/null
+++ b/contentful-management/11.40.3/interfaces/SysLink.html
@@ -0,0 +1,2 @@
+
diff --git a/contentful-management/11.40.3/interfaces/Tag.html b/contentful-management/11.40.3/interfaces/Tag.html
new file mode 100644
index 0000000000..73f1b2c94c
--- /dev/null
+++ b/contentful-management/11.40.3/interfaces/Tag.html
@@ -0,0 +1,6 @@
+
diff --git a/contentful-management/11.40.3/interfaces/Task.html b/contentful-management/11.40.3/interfaces/Task.html
new file mode 100644
index 0000000000..d4c58a18d4
--- /dev/null
+++ b/contentful-management/11.40.3/interfaces/Task.html
@@ -0,0 +1,9 @@
+
Interface Task
interface Task {
assignedTo: Link<"Team" | "User">;
body: string;
dueDate?: string;
status: TaskStatus;
sys: TaskSysProps;
delete(): Promise<void>;
toPlainObject(): TaskProps;
update(): Promise<Task>;
}
assignedTo: Link<"Team" | "User">;
body: string;
dueDate?: string;
status: TaskStatus;
sys: TaskSysProps;
delete(): Promise<void>;
toPlainObject(): TaskProps;
update(): Promise<Task>;
}
Hierarchy (view full)
- TaskProps
- DefaultElements<TaskProps>
- TaskApi
- Task
Index
Properties
Methods
Interface Team
interface Team {
description: string;
name: string;
sys: MetaSysProps & {
memberCount: number;
organization: {
sys: MetaLinkProps;
};
};
delete(): Promise<void>;
toPlainObject(): TeamProps;
update(): Promise<Team>;
}
description: string;
name: string;
sys: MetaSysProps & {
memberCount: number;
organization: {
sys: MetaLinkProps;
};
};
delete(): Promise<void>;
toPlainObject(): TeamProps;
update(): Promise<Team>;
}
Hierarchy (view full)
Index
Properties
Methods
Properties
description
description: string
Description of the team
+name
name: string
Name of the team
+sys
System metadata
+ Methods
delete
- delete(): Promise<void>
Deletes this object on the server.
+Returns Promise<void>
Promise for the deletion. It contains no data, but the Promise error case should be handled.
+Example: ```javascript +const contentful = require('contentful-management') + +const client = contentful.createClient({ + accessToken: '<content_management_api_key>' +}) + +client.getOrganization('organization_id') +.then(org => org.getOrganizationMembership('organizationMembership_id')) +.then((team) => { + team.delete(); +}) +.catch(console.error) +```
to
update
- update(): Promise<Team>
Sends an update to the server with any changes made to the object's properties
+Returns Promise<Team>
Object returned from the server with updated changes.
+Example: ```javascript +const contentful = require('contentful-management') + +const client = contentful.createClient({ + accessToken: '<content_management_api_key>' +}) + +client.getOrganization('organization_id') +.then(org => org.getTeam('team_id')) +.then((team) => { + team.description = 'new description'; + team.update(); +}) +.catch(console.error) +```
Interface TeamMembership
interface TeamMembership {
admin: boolean;
organizationMembershipId: string;
sys: MetaSysProps & {
organization: {
sys: MetaLinkProps;
};
organizationMembership: {
sys: MetaLinkProps;
};
team: {
sys: MetaLinkProps;
};
};
delete(): Promise<void>;
toPlainObject(): TeamMembershipProps;
update(): Promise<TeamMembership>;
}
admin: boolean;
organizationMembershipId: string;
sys: MetaSysProps & {
organization: {
sys: MetaLinkProps;
};
organizationMembership: {
sys: MetaLinkProps;
};
team: {
sys: MetaLinkProps;
};
};
delete(): Promise<void>;
toPlainObject(): TeamMembershipProps;
update(): Promise<TeamMembership>;
}
Hierarchy (view full)
- TeamMembershipProps
- DefaultElements<TeamMembershipProps>
- TeamMembership
Index
Properties
Methods
Properties
admin
admin: boolean
Is admin
+organization
organization
Organization membership id
+sys
sys: MetaSysProps & {
organization: {
sys: MetaLinkProps;
};
organizationMembership: {
sys: MetaLinkProps;
};
team: {
sys: MetaLinkProps;
};
}
organization: {
sys: MetaLinkProps;
};
organizationMembership: {
sys: MetaLinkProps;
};
team: {
sys: MetaLinkProps;
};
}
System metadata
+ Methods
delete
- delete(): Promise<void>
Deletes this object on the server.
+Returns Promise<void>
Promise for the deletion. It contains no data, but the Promise error case should be handled.
+Example: ```javascript +const contentful = require('contentful-management') + +const client = contentful.createClient({ + accessToken: '<content_management_api_key>' +}) + +client.getOrganization('organizationId') +.then(org => org.getTeamMembership('teamId', 'teamMembershipId')) +.then((teamMembership) => { + teamMembership.delete(); +}) +.catch(console.error) +```
to
- to
Plain Object(): TeamMembershipProps Returns TeamMembershipProps
update
- update(): Promise<TeamMembership>
Sends an update to the server with any changes made to the object's properties
+Returns Promise<TeamMembership>
Object returned from the server with updated changes.
+Example: ```javascript +const contentful = require('contentful-management') + +const client = contentful.createClient({ + accessToken: '<content_management_api_key>' +}) + +client.getOrganization('organizationId') +.then(org => org.getTeamMembership('teamId', 'teamMembershipId')) +.then((teamMembership) => { + teamMembership.admin = true; + teamMembership.update(); +}) +.catch(console.error) +```
Interface TeamSpaceMembership
interface TeamSpaceMembership {
admin: boolean;
roles: {
sys: MetaLinkProps;
}[];
sys: MetaSysProps & {
space: {
sys: MetaLinkProps;
};
team: {
sys: MetaLinkProps;
};
};
delete(): Promise<void>;
toPlainObject(): TeamSpaceMembershipProps;
update(): Promise<TeamSpaceMembership>;
}
admin: boolean;
roles: {
sys: MetaLinkProps;
}[];
sys: MetaSysProps & {
space: {
sys: MetaLinkProps;
};
team: {
sys: MetaLinkProps;
};
};
delete(): Promise<void>;
toPlainObject(): TeamSpaceMembershipProps;
update(): Promise<TeamSpaceMembership>;
}
Hierarchy (view full)
- TeamSpaceMembershipProps
- DefaultElements<TeamSpaceMembershipProps>
- TeamSpaceMembership
Methods
delete
- delete(): Promise<void>
Deletes this object on the server.
+Returns Promise<void>
Promise for the deletion. It contains no data, but the Promise error case should be handled.
+Example: ```javascript +const contentful = require('contentful-management') + +const client = contentful.createClient({ + accessToken: '<content_management_api_key>' +}) + +client.getSpace('<space_id>') +.then((space) => space.getTeamSpaceMembership('<team_space_membership_id>')) +.then((teamSpaceMembership) => teamSpaceMembership.delete()) +.then(() => console.log(`spaceMembership deleted.`)) +.catch(console.error) +```
to
- to
Plain Object(): TeamSpaceMembershipProps Returns TeamSpaceMembershipProps
update
- update(): Promise<TeamSpaceMembership>
Sends an update to the server with any changes made to the object's properties
+Returns Promise<TeamSpaceMembership>
Object returned from the server with updated changes.
+Example: ```javascript +const contentful = require('contentful-management') + +const client = contentful.createClient({ + accessToken: '<content_management_api_key>' +}) + +client.getSpace('<space_id>') + .then((space) => space.getTeamSpaceMembership('team_space_membership_id')) + .then((teamSpaceMembership) => { + item.roles = [ + { + sys: { + type: 'Link', + linkType: 'Role', + id: 'role_id' + } + } + ] + }) + .then((spaceMembership) => console.log(`spaceMembership ${spaceMembership.sys.id} updated.`)) + .catch(console.error) + ```
Interface UIConfig
interface UIConfig {
assetListViews: ViewFolder[];
entryListViews: ViewFolder[];
homeViews: HomeView[];
sys: UIConfigSysProps;
toPlainObject(): UIConfigProps;
}
assetListViews: ViewFolder[];
entryListViews: ViewFolder[];
homeViews: HomeView[];
sys: UIConfigSysProps;
toPlainObject(): UIConfigProps;
}
Hierarchy (view full)
Index
Properties
Methods
Properties
asset
asset
entry
entry
home
home
sys
sys: UIConfigSysProps
System metadata
+ Methods
to
- to
Plain Object(): UIConfigProps Returns UIConfigProps
Interface UIExtension
interface UIExtension {
extension: {
fieldTypes: FieldType[];
name: string;
parameters?: {
installation?: ParameterDefinition<InstallationParameterType>[];
instance?: ParameterDefinition<ParameterType>[];
};
sidebar?: boolean;
src?: string;
srcdoc?: string;
};
parameters?: DefinedParameters;
sys: ExtensionSysProps;
delete(): Promise<void>;
toPlainObject(): UIExtensionProps;
update(): Promise<UIExtension>;
}
extension: {
fieldTypes: FieldType[];
name: string;
parameters?: {
installation?: ParameterDefinition<InstallationParameterType>[];
instance?: ParameterDefinition<ParameterType>[];
};
sidebar?: boolean;
src?: string;
srcdoc?: string;
};
parameters?: DefinedParameters;
sys: ExtensionSysProps;
delete(): Promise<void>;
toPlainObject(): UIExtensionProps;
update(): Promise<UIExtension>;
}
Hierarchy (view full)
- UIExtensionProps
- DefaultElements<UIExtensionProps>
- UIExtension
Index
Properties
Methods
Properties
extension
extension: {
fieldTypes: FieldType[];
name: string;
parameters?: {
installation?: ParameterDefinition<InstallationParameterType>[];
instance?: ParameterDefinition<ParameterType>[];
};
sidebar?: boolean;
src?: string;
srcdoc?: string;
}
fieldTypes: FieldType[];
name: string;
parameters?: {
installation?: ParameterDefinition<InstallationParameterType>[];
instance?: ParameterDefinition<ParameterType>[];
};
sidebar?: boolean;
src?: string;
srcdoc?: string;
}
Type declaration
field
Types: FieldType[] Field types where an extension can be used
+name: string
Extension name
+Optionalparameters?: {
installation?: ParameterDefinition<InstallationParameterType>[];
instance?: ParameterDefinition<ParameterType>[];
}Parameter definitions
+Optionalinstallation?: ParameterDefinition<InstallationParameterType>[]Optionalinstance?: ParameterDefinition<ParameterType>[]
Optionalsidebar?: booleanControls the location of the extension. If true it will be rendered on the sidebar instead of replacing the field's editing control
+Optionalsrc?: stringURL where the root HTML document of the extension can be found
+Optionalsrcdoc?: stringString representation of the extension (e.g. inline HTML code)
+
Optionalparameters
Values for installation parameters
+sys
sys: ExtensionSysProps
Methods
delete
- delete(): Promise<void>
Deletes this object on the server.
+Returns Promise<void>
Promise for the deletion. It contains no data, but the Promise error case should be handled.
+Example: ```javascript +const contentful = require('contentful-management') + +const client = contentful.createClient({ + accessToken: '<content_management_api_key>' +}) + +client.getSpace('<space_id>') +.then((space) => space.getEnvironment('<environment_id>')) +.then((environment) => environment.getUiExtension('<ui_extension_id>')) +.then((extension) => extension.delete()) +.then(() => console.log(`UI Extension deleted.`)) +.catch(console.error) +```
to
- to
Plain Object(): UIExtensionProps Returns UIExtensionProps
update
- update(): Promise<UIExtension>
Sends an update to the server with any changes made to the object's properties
+Returns Promise<UIExtension>
Object returned from the server with updated changes.
+Example: ```javascript +const contentful = require('contentful-management') + +const client = contentful.createClient({ + accessToken: '<content_management_api_key>' +}) + +client.getSpace('<space_id>') +.then((space) => space.getEnvironment('<environment_id>')) +.then((environment) => environment.getUiExtension('<ui_extension_id>')) +.then((extension) => { + extension.extension.name = 'New UI Extension name' + return extension.update() +}) +.then((extension) => console.log(`UI Extension ${extension.sys.id} updated.`)) +.catch(console.error) +```
Interface Upload
interface Upload {
sys: MetaSysProps & {
environment?: SysLink;
space: SysLink;
};
delete(): Promise<void>;
toPlainObject(): UploadProps;
}
sys: MetaSysProps & {
environment?: SysLink;
space: SysLink;
};
delete(): Promise<void>;
toPlainObject(): UploadProps;
}
Hierarchy (view full)
Index
Properties
sys
+
Methods
Methods
delete
- delete(): Promise<void>
Deletes this object on the server.
+Returns Promise<void>
Promise for the deletion. It contains no data, but the Promise error case should be handled.
+Example
+ +const contentful = require('contentful-management')
const client = contentful.createClient({
accessToken: '<content_management_api_key>'
})
client.getSpace('<space_id>')
.then((space) => space.getEnvironment('<environment_id>'))
.then((environment) => environment.getUpload('<upload_id>'))
.then((upload) => upload.delete())
.then((upload) => console.log(`upload ${upload.sys.id} updated.`))
.catch(console.error) +
to
- to
Plain Object(): UploadProps Returns UploadProps
Interface UploadCredential
interface UploadCredential {
sys: MetaSysProps & {
environment?: SysLink;
space: SysLink;
};
create(): Promise<UploadCredentialProps>;
toPlainObject(): UploadCredentialProps;
}
sys: MetaSysProps & {
environment?: SysLink;
space: SysLink;
};
create(): Promise<UploadCredentialProps>;
toPlainObject(): UploadCredentialProps;
}
Hierarchy (view full)
- UploadCredentialProps
- DefaultElements<UploadCredentialProps>
- UploadCredential
Index
Properties
sys
+
Methods
Methods
create
- create(): Promise<UploadCredentialProps>
creates the upload credentials.
+Returns Promise<UploadCredentialProps>
upload credentials for file uploads
+Example
+ +const contentful = require('contentful-management')
const client = contentful.createClient({
accessToken: '<content_management_api_key>'
})
try {
const space = await client.getSpace('<space_id>')
const environment = await space.getEnvironment('<environment_id>')
const upload = await client.uploadCredential.create({
spaceId: space.sys.id,
environmentId: environment.sys.id
})
} catch (error) {
console.error(error)
} +
to
- to
Plain Object(): UploadCredentialProps Returns UploadCredentialProps
Interface Usage
interface Usage {
dateRange: {
endAt: string;
startAt: string;
};
metric: UsageMetricEnum;
sys: MetaSysProps & {
organization?: {
sys: MetaLinkProps;
};
};
unitOfMeasure: string;
usage: number;
usagePerDay: {
[key: string]: number;
};
toPlainObject(): UsageProps;
}
dateRange: {
endAt: string;
startAt: string;
};
metric: UsageMetricEnum;
sys: MetaSysProps & {
organization?: {
sys: MetaLinkProps;
};
};
unitOfMeasure: string;
usage: number;
usagePerDay: {
[key: string]: number;
};
toPlainObject(): UsageProps;
}
Hierarchy (view full)
Index
Properties
Methods
Properties
date
date
endAt: string;
startAt: string;
}
endAt: string;
startAt: string;
}
Range of usage
+metric
metric: UsageMetricEnum
Type of usage
+sys
System metadata
+unit
unit
Unit of usage metric
+usage
usage: number
Value of the usage
+usage
usage
[key: string]: number;
}
[key: string]: number;
}
Usage per day
+ Methods
to
- to
Plain Object(): UsageProps Returns UsageProps
Interface User
interface User {
2faEnabled: boolean;
activated: boolean;
avatarUrl: string;
confirmed: boolean;
cookieConsentData: string;
email: string;
firstName: string;
lastName: string;
signInCount: number;
sys: BasicMetaSysProps;
toPlainObject(): UserProps;
}
2faEnabled: boolean;
activated: boolean;
avatarUrl: string;
confirmed: boolean;
cookieConsentData: string;
email: string;
firstName: string;
lastName: string;
signInCount: number;
sys: BasicMetaSysProps;
toPlainObject(): UserProps;
}
Hierarchy (view full)
Index
Properties
Methods
Properties
2fa
2fa
activated
activated: boolean
Activation flag
+avatar
avatar
Url to the users avatar
+confirmed
confirmed: boolean
User confirmation flag
+cookie
cookie
email: string
Email address of the user
+first
first
First name of the user
+last
last
Last name of the user
+sign
sign
Number of sign ins
+sys
System metadata
+Interface UserUIConfig
interface UserUIConfig {
assetListViews: ViewFolder[];
entryListViews: ViewFolder[];
sys: UserUIConfigSysProps;
toPlainObject(): UserUIConfigProps;
}
assetListViews: ViewFolder[];
entryListViews: ViewFolder[];
sys: UserUIConfigSysProps;
toPlainObject(): UserUIConfigProps;
}
Hierarchy (view full)
- UserUIConfigProps
- DefaultElements<UserUIConfigProps>
- UserUIConfig
Index
Properties
Methods
Properties
asset
asset
entry
entry
sys
sys: UserUIConfigSysProps
System metadata
+ Methods
to
- to
Plain Object(): UserUIConfigProps Returns UserUIConfigProps
diff --git a/contentful-management/11.40.3/interfaces/WebHooks.html b/contentful-management/11.40.3/interfaces/WebHooks.html
new file mode 100644
index 0000000000..a5e6c746f0
--- /dev/null
+++ b/contentful-management/11.40.3/interfaces/WebHooks.html
@@ -0,0 +1,52 @@
+
Interface WebHooks
interface WebHooks {
active: boolean;
filters?: WebhookFilter[];
headers: WebhookHeader[];
httpBasicPassword?: string;
httpBasicUsername?: string;
name: string;
sys: BasicMetaSysProps & {
space: SysLink;
};
topics: string[];
transformation?: WebhookTransformation;
url: string;
delete(): Promise<void>;
getCall(id: string): Promise<WebhookCallDetailsProps>;
getCalls(): Promise<CollectionProp<{
errors: any[];
eventType: string;
requestAt: string;
responseAt: string;
statusCode: number;
sys: {
createdAt: string;
createdBy?: SysLink;
id: string;
type: string;
};
url: string;
}>>;
getHealth(): Promise<WebhookHealthProps>;
toPlainObject(): WebhookProps;
update(): Promise<WebHooks>;
}
active: boolean;
filters?: WebhookFilter[];
headers: WebhookHeader[];
httpBasicPassword?: string;
httpBasicUsername?: string;
name: string;
sys: BasicMetaSysProps & {
space: SysLink;
};
topics: string[];
transformation?: WebhookTransformation;
url: string;
delete(): Promise<void>;
getCall(id: string): Promise<WebhookCallDetailsProps>;
getCalls(): Promise<CollectionProp<{
errors: any[];
eventType: string;
requestAt: string;
responseAt: string;
statusCode: number;
sys: {
createdAt: string;
createdBy?: SysLink;
id: string;
type: string;
};
url: string;
}>>;
getHealth(): Promise<WebhookHealthProps>;
toPlainObject(): WebhookProps;
update(): Promise<WebHooks>;
}
Hierarchy (view full)
- WebhookProps
- DefaultElements<WebhookProps>
- WebHooks
Index
Properties
Methods
Properties
active
active: boolean
Whether the Webhook is active. If set to false, no calls will be made
+Optionalfilters
Webhook filters
+headers
headers: WebhookHeader[]
Headers that should be appended to the webhook request
+Optionalhttp
http
Password for basic http auth
+Optionalhttp
http
Username for basic http auth
+name
name: string
Webhook name
+sys
System metadata
+topics
topics: string[]
Topics the webhook wants to subscribe to
+Optionaltransformation
Transformation to apply
+url
url: string
Webhook url
+ Methods
delete
- delete(): Promise<void>
Deletes this object on the server.
+Returns Promise<void>
Promise for the deletion. It contains no data, but the Promise error case should be handled.
+
+ +const contentful = require('contentful-management')
const client = contentful.createClient({
accessToken: '<content_management_api_key>'
})
client.getSpace('<space_id>')
.then((space) => space.getWebhook('<webhook_id>'))
.then((webhook) => webhook.delete())
.then((webhook) => console.log(`webhook ${webhook.sys.id} updated.`))
.catch(console.error) +
get
- get
Call(id): Promise<WebhookCallDetailsProps> Webhook call with specific id. See https://www.contentful.com/developers/docs/references/content-management-api/#/reference/webhook-calls/webhook-call-overviews for more details
+Parameters
- id: string
Returns Promise<WebhookCallDetailsProps>
Promise for call details
+
+ +const contentful = require('contentful-management')
const client = contentful.createClient({
accessToken: '<content_management_api_key>'
})
client.getSpace('<space_id>')
.then((space) => space.getWebhook('<webhook_id>'))
.then((webhook) => webhook.getCall('<call-id>'))
.then((webhookCall) => console.log(webhookCall))
.catch(console.error) +
get
- get
Calls(): Promise<CollectionProp<{
errors: any[];
eventType: string;
requestAt: string;
responseAt: string;
statusCode: number;
sys: {
createdAt: string;
createdBy?: SysLink;
id: string;
type: string;
};
url: string;
}>> List of the most recent webhook calls. See https://www.contentful.com/developers/docs/references/content-management-api/#/reference/webhook-calls/webhook-call-overviews for more details.
+Returns Promise<CollectionProp<{
errors: any[];
eventType: string;
requestAt: string;
responseAt: string;
statusCode: number;
sys: {
createdAt: string;
createdBy?: SysLink;
id: string;
type: string;
};
url: string;
}>>Promise for list of calls
+
+ +const contentful = require('contentful-management')
const client = contentful.createClient({
accessToken: '<content_management_api_key>'
})
client.getSpace('<space_id>')
.then((space) => space.getWebhook('<webhook_id>'))
.then((webhook) => webhook.getCalls())
.then((response) => console.log(response.items)) // webhook calls
.catch(console.error) +
get
- get
Health(): Promise<WebhookHealthProps> Overview of the health of webhook calls. See https://www.contentful.com/developers/docs/references/content-management-api/#/reference/webhook-calls/webhook-call-overviews for more details.
+Returns Promise<WebhookHealthProps>
Promise for health info
+
+ +const contentful = require('contentful-management')
const client = contentful.createClient({
accessToken: '<content_management_api_key>'
})
client.getSpace('<space_id>')
.then((space) => space.getWebhook('<webhook_id>'))
.then((webhook) => webhook.getHealth())
.then((webhookHealth) => console.log(webhookHealth))
.catch(console.error) +
to
- to
Plain Object(): WebhookProps Returns WebhookProps
update
- update(): Promise<WebHooks>
Sends an update to the server with any changes made to the object's properties
+Returns Promise<WebHooks>
Object returned from the server with updated changes.
+
+ +const contentful = require('contentful-management')
const client = contentful.createClient({
accessToken: '<content_management_api_key>'
})
client.getSpace('<space_id>')
.then((space) => space.getWebhook('<webhook_id>'))
.then((webhook) => {
webhook.name = 'new webhook name'
return webhook.update()
})
.then((webhook) => console.log(`webhook ${webhook.sys.id} updated.`))
.catch(console.error) +
Interface Workflow
interface Workflow {
stepId?: string;
sys: WorkflowSysProps;
complete(): Promise<void>;
delete(): Promise<void>;
get(): Promise<Workflow>;
toPlainObject(): WorkflowProps;
update(): Promise<Workflow>;
}
stepId?: string;
sys: WorkflowSysProps;
complete(): Promise<void>;
delete(): Promise<void>;
get(): Promise<Workflow>;
toPlainObject(): WorkflowProps;
update(): Promise<Workflow>;
}
Hierarchy (view full)
- WorkflowProps
- DefaultElements<WorkflowProps>
- WorkflowApi
- Workflow
Methods
complete
delete
get
to
- to
Plain Object(): WorkflowProps Returns WorkflowProps
update
Interface WorkflowDefinition
interface WorkflowDefinition {
appliesTo?: WorkflowDefinitionValidationLink[];
description?: string;
flowType?: "no_restriction" | "strict_neighbor";
name: string;
startOnEntityCreation?: boolean;
steps: WorkflowStepProps[];
sys: WorkflowDefinitionSysProps;
delete(): Promise<void>;
toPlainObject(): WorkflowDefinitionProps;
update(): Promise<WorkflowDefinition>;
}
appliesTo?: WorkflowDefinitionValidationLink[];
description?: string;
flowType?: "no_restriction" | "strict_neighbor";
name: string;
startOnEntityCreation?: boolean;
steps: WorkflowStepProps[];
sys: WorkflowDefinitionSysProps;
delete(): Promise<void>;
toPlainObject(): WorkflowDefinitionProps;
update(): Promise<WorkflowDefinition>;
}
Hierarchy (view full)
- WorkflowDefinitionProps
- DefaultElements<WorkflowDefinitionProps>
- WorkflowDefinitionApi
- WorkflowDefinition
Index
Properties
Methods
Properties
Optionalapplies
Optionaldescription
description?: string
Optionalflow
flow
name
name: string
Optionalstart
start
steps
sys
Methods
delete
to
- to
Plain Object(): WorkflowDefinitionProps Returns WorkflowDefinitionProps
update
- update(): Promise<WorkflowDefinition>
Returns Promise<WorkflowDefinition>
Interface WorkflowStepPermission
interface WorkflowStepPermission {
configuration: {
action: WorkflowStepPermissionAction;
actors: WorkflowStepPermissionActors;
effect: WorkflowStepPermissionEffect;
};
type: WorkflowStepPermissionType;
}
configuration: {
action: WorkflowStepPermissionAction;
actors: WorkflowStepPermissionActors;
effect: WorkflowStepPermissionEffect;
};
type: WorkflowStepPermissionType;
}
Index
Properties
Properties
configuration
configuration: {
action: WorkflowStepPermissionAction;
actors: WorkflowStepPermissionActors;
effect: WorkflowStepPermissionEffect;
}
action: WorkflowStepPermissionAction;
actors: WorkflowStepPermissionActors;
effect: WorkflowStepPermissionEffect;
}
type
Interface WorkflowsChangelogEntry
interface WorkflowsChangelogEntry {
entity: Link<"Entry">;
event: string;
eventAt: string;
eventBy: SysLink;
stepAnnotations: string[];
stepId: string;
stepName: string;
workflow: VersionedLink<"Workflow">;
workflowDefinition: Link<"WorkflowDefinition">;
toPlainObject(): WorkflowsChangelogEntryProps;
}
entity: Link<"Entry">;
event: string;
eventAt: string;
eventBy: SysLink;
stepAnnotations: string[];
stepId: string;
stepName: string;
workflow: VersionedLink<"Workflow">;
workflowDefinition: Link<"WorkflowDefinition">;
toPlainObject(): WorkflowsChangelogEntryProps;
}
Hierarchy (view full)
- WorkflowsChangelogEntryProps
- DefaultElements<WorkflowsChangelogEntryProps>
- WorkflowsChangelogEntry
Index
Properties
Methods
Properties
entity
event
event: string
event
event
event
step
step
step
step
step
step
workflow
workflow
Methods
to
- to
Plain Object(): WorkflowsChangelogEntryProps Returns WorkflowsChangelogEntryProps
+
+ 
+
+
Content Management API
+ +JavaScript
+ ++ Readme · + Setup · + Migration · + Changelog · + Contributing +
+ +
+
+
+
+
+
+
+
+
Content Management API
+ +JavaScript
+ ++ Readme · + Setup · + Migration · + Changelog · + Contributing +
+ +
+
+
+
+
+
+
+
+
Content Management API
+ +JavaScript
+ ++ Readme · + Setup · + Migration · + Changelog · + Contributing +
+ +
+
+
+
+
+
+
+
+
Content Management API
+ +JavaScript
+ ++ Readme · + Setup · + Migration · + Changelog · + Contributing +
+ +
+
+
+
+
+
+
+## Features
+
+- Content management and retrieval through Contentful's [Content Management API](https://www.contentful.com/developers/docs/references/content-management-api/).
+- Built in rate limiting with recovery procedures
+- Asset processing helpers
+
+## Supported environments
+
+Browsers and Node.js:
+
+- Chrome
+- Firefox
+- Edge
+- Safari
+- node.js (LTS)
+
+Other browsers should also work, but at the moment we're only running automated tests on the browsers and Node.js versions specified above.
+
+# Getting started
+
+To get started with the Contentful Management JS library you'll need to install it, and then get credentials which will allow you to access your content in Contentful.
+
+- [Installation](#installation)
+- [Authentication](#authentication)
+- [Using ES6 import](#using-es6-import)
+- [Your first request](#your-first-request)
+- [Troubleshooting](#troubleshooting)
+- [Documentation/References](#documentationreferences)
+
+## Installation
+
+### Node:
+
+Using [npm](http://npmjs.org):
+
+```sh
+npm install contentful-management
+```
+
+Using [yarn](https://yarnpkg.com/lang/en/):
+
+```sh
+yarn add contentful-management
+```
+
+### Browser:
+
+For browsers, we recommend to download the library via npm or yarn to ensure 100% availability.
+
+If you'd like to use a standalone built file you can use the following script tag or download it from [jsDelivr](https://www.jsdelivr.com/package/npm/contentful-management), under the `dist` directory:
+
+```html
+
+```
+
+**It's not recommended to use the above URL for production.**
+
+Using `contentful@latest` will always get you the latest version, but you can also specify a specific version number:
+
+```html
+
+
+```
+
+The Contentful Management library will be accessible via the `contentfulManagement` global variable.
+
+Check the [releases](https://github.com/contentful/contentful-management.js/releases) page to know which versions are available.
+
+## Typings
+
+This library also comes with typings to use with typescript.
+
+## Authentication
+
+To get content from Contentful, an app should authenticate with an OAuth bearer token.
+
+If you want to use this library for a simple tool or a local app that you won't redistribute or make available to other users, you can get an API key for the Management API at our [Authentication page](https://www.contentful.com/developers/docs/references/authentication/).
+
+If you'd like to create an app which would make use of this library but that would be available for other users, where they could authenticate with their own Contentful credentials, make sure to also check out the section about [Creating an OAuth Application](https://www.contentful.com/developers/docs/references/authentication/#creating-an-oauth-20-application)
+
+## Using ES6 import
+
+You can use the es6 import with the library as follows
+
+```js
+// import createClient directly
+import contentful from 'contentful-management'
+const client = contentful.createClient(
+ {
+ // This is the access token for this space. Normally you get the token in the Contentful web app
+ accessToken: 'YOUR_ACCESS_TOKEN',
+ },
+ { type: 'plain' }
+)
+//....
+```
+
+## Your first request
+
+Beginning with `contentful-management@7` this library provides a client which exposes all CMA endpoints in a simple flat API surface, as opposed to the waterfall structure exposed by legacy versions of the SDK.
+
+```javascript
+const contentful = require('contentful-management')
+const plainClient = contentful.createClient(
+ {
+ accessToken: 'YOUR_ACCESS_TOKEN',
+ },
+ { type: 'plain' }
+)
+
+const environment = await plainClient.environment.get({
+ spaceId: 'Table of contents
+ + + +- [Features](#features) +- [Supported Environments](#supported-environments) +- [Getting Started](#getting-started) + - [Installation](#installation) + - [Node](#node-) + - [Browser](#browser-) + - [Typings](#typings) + - [Authentication](#authentication) + - [Using ES6 import](#using-es6-import) + - [Your first Request](#your-first-request) + - [Alternative plain API](#alternative-plain-api) +- [App Framework](#app-framework) +- [Troubleshooting](#troubleshooting) +- [Documentation/References](#documentationreferences) + - [Configuration](#configuration) + - [Reference Documentation](#reference-documentation) + - [Contentful Javascript resources](#contentful-javascript-resources) + - [REST API reference](#rest-api-reference) +- [Versioning](#versioning) +- [Reach out to us](#reach-out-to-us) +- [Get involved](#get-involved) +- [License](#license) +- [Code of Conduct](#code-of-conduct) + + +
+
+
+
+
Content Management API
+ +JavaScript
+ ++ Readme · + Setup · + Migration · + Changelog · + Contributing +
+ +
+
+
+
+
contentful-management.js - v11.40.3
Contentful Management API SDK. Allows you to create instances of a client +with access to the Contentful Content Management API.
+Index
Namespaces
Enumerations
Classes
Interfaces
Access
Type Aliases
Access
Variables
Functions
Namespace editorInterfaceDefaults
Type Alias AccessTokenProp
Access
name: string;
revokedAt: null | string;
scopes: "content_management_manage"[];
sys: AccessTokenSysProps;
token?: string;
}
name: string;
revokedAt: null | string;
scopes: "content_management_manage"[];
sys: AccessTokenSysProps;
token?: string;
}
Type Alias AnnotationAssignment
Annotation
parameters?: Record<string, string | number | boolean>;
}
parameters?: Record<string, string | number | boolean>;
}
Type Alias ApiKeyProps
Api
accessToken: string;
description?: string;
environments: {
sys: MetaLinkProps;
}[];
name: string;
policies?: {
action: string;
effect: string;
}[];
preview_api_key: {
sys: MetaLinkProps;
};
sys: MetaSysProps;
}
accessToken: string;
description?: string;
environments: {
sys: MetaLinkProps;
}[];
name: string;
policies?: {
action: string;
effect: string;
}[];
preview_api_key: {
sys: MetaLinkProps;
};
sys: MetaSysProps;
}
Type Alias AppAccessTokenProps
App
sys: AppAccessTokenSys;
token: string;
}
sys: AppAccessTokenSys;
token: string;
}
Type declaration
sys: AppAccessTokenSys
System metadata
+token: string
Token for an app installation in a space environment
+
Type Alias AppAction
Type declaration
delete:function
- delete(): Promise<void>
Deletes this object on the server.
+Returns Promise<void>
Promise for the deletion. It contains no data, but the Promise error case should be handled.
+Example: ```javascript +const contentful = require('contentful-management') + +const client = contentful.createClient({ + accessToken: '<content_management_api_key>' +}) + +client.getOrganization('<org_id>') +.then((org) => org.getAppDefinition('<app_def_id>')) +.then((appDefinition) => appDefinition.getAppAction('<app-action-id>')) +.then((appAction) => appAction.delete()) +.catch(console.error) +```
Type Alias AppActionCallProps
App
sys: AppActionCallSys;
}
sys: AppActionCallSys;
}
Type declaration
sys: AppActionCallSys
System metadata
+
Type Alias AppActionCategoryProps
App
description: string;
name: string;
parameters?: AppActionParameterDefinition[];
sys: {
id: AppActionCategoryType;
type: "AppActionCategory";
version: string;
};
}
description: string;
name: string;
parameters?: AppActionParameterDefinition[];
sys: {
id: AppActionCategoryType;
type: "AppActionCategory";
version: string;
};
}
Type Alias AppActionCategoryType
App
Type Alias AppActionParameterDefinition
Type Alias AppActionProps
App
description?: string;
name: string;
sys: AppActionSys;
type?: AppActionType;
url: string;
}
description?: string;
name: string;
sys: AppActionSys;
type?: AppActionType;
url: string;
}
Type declaration
Optionaldescription?: stringHuman readable description of the action
+name: string
Human readable name for the action
+sys: AppActionSys
System metadata
+Optionaltype?: AppActionTypeType of the action, defaults to endpoint if not provided +endpoint: action is sent to specified URL +function: deprecated, use function-invocation instead +function-invocation: action invokes a contentful function
+url: string
Url that will be called when the action is invoked
+
Type Alias AppActionType
App
Type Alias AppBundleFile
App
md5: string;
name: string;
size: number;
}
md5: string;
name: string;
size: number;
}
Type Alias AppBundleProps
Type declaration
Optionalcomment?: stringA comment that describes this bundle
+files: AppBundleFile[]
List of all the files that are in this bundle
+sys: AppBundleSys
System metadata
+
Type Alias AppDefinition
App
Type Alias AppDefinitionProps
App
bundle?: Link<"AppBundle">;
locations?: AppLocation[];
name: string;
parameters?: {
installation?: ParameterDefinition<InstallationParameterType>[];
instance?: ParameterDefinition[];
};
src?: string;
sys: BasicMetaSysProps & {
organization: SysLink;
shared: boolean;
};
}
bundle?: Link<"AppBundle">;
locations?: AppLocation[];
name: string;
parameters?: {
installation?: ParameterDefinition<InstallationParameterType>[];
instance?: ParameterDefinition[];
};
src?: string;
sys: BasicMetaSysProps & {
organization: SysLink;
shared: boolean;
};
}
Type declaration
Optionalbundle?: Link<"AppBundle">Link to an AppBundle
+Optionallocations?: AppLocation[]Locations where the app can be installed
+name: string
App name
+Optionalparameters?: {
installation?: ParameterDefinition<InstallationParameterType>[];
instance?: ParameterDefinition[];
}Instance parameter definitions
+Optionalinstallation?: ParameterDefinition<InstallationParameterType>[]Optionalinstance?: ParameterDefinition[]
Optionalsrc?: stringURL where the root HTML document of the app can be found
+sys: BasicMetaSysProps & {
organization: SysLink;
shared: boolean;
}System metadata
+
diff --git a/contentful-management/11.40.3/types/AppEventSubscriptionProps.html b/contentful-management/11.40.3/types/AppEventSubscriptionProps.html
new file mode 100644
index 0000000000..6b9791066b
--- /dev/null
+++ b/contentful-management/11.40.3/types/AppEventSubscriptionProps.html
@@ -0,0 +1,4 @@
+
Type Alias AppEventSubscriptionProps
App
sys: AppEventSubscriptionSys;
targetUrl: string;
topics: string[];
}
sys: AppEventSubscriptionSys;
targetUrl: string;
topics: string[];
}
Type declaration
sys: AppEventSubscriptionSys
System metadata
+target
Url: string Subscription url that will receive events
+topics: string[]
List of topics to subscribe to
+
Type Alias AppInstallationProps
App
parameters?: FreeFormParameters;
sys: Omit<BasicMetaSysProps, "id"> & {
appDefinition: SysLink;
environment: SysLink;
space: SysLink;
};
}
parameters?: FreeFormParameters;
sys: Omit<BasicMetaSysProps, "id"> & {
appDefinition: SysLink;
environment: SysLink;
space: SysLink;
};
}
Type declaration
Optionalparameters?: FreeFormParametersFree-form installation parameters (API limits stringified length to 32KB)
+sys: Omit<BasicMetaSysProps, "id"> & {
appDefinition: SysLink;
environment: SysLink;
space: SysLink;
}
Type Alias AppKeyProps
App
generated?: {
privateKey: string;
};
jwk: JWK;
sys: AppKeySys;
}
generated?: {
privateKey: string;
};
jwk: JWK;
sys: AppKeySys;
}
Type declaration
Optionalgenerated?: {
privateKey: string;
}If generated, private key is returned
+private
Key: string Base64 PEM
+
jwk: JWK
JSON Web Key
+sys: AppKeySys
System metadata
+
Type Alias AppLocation
Type Alias AppSignedRequestProps
App
additionalHeaders: {
x-contentful-environment-id: string;
x-contentful-signature: string;
x-contentful-signed-headers: string;
x-contentful-space-id: string;
x-contentful-timestamp: string;
x-contentful-user-id: string;
};
sys: AppSignedRequestSys;
}
additionalHeaders: {
x-contentful-environment-id: string;
x-contentful-signature: string;
x-contentful-signed-headers: string;
x-contentful-space-id: string;
x-contentful-timestamp: string;
x-contentful-user-id: string;
};
sys: AppSignedRequestSys;
}
Type declaration
additional
Headers: {
x-contentful-environment-id: string;
x-contentful-signature: string;
x-contentful-signed-headers: string;
x-contentful-space-id: string;
x-contentful-timestamp: string;
x-contentful-user-id: string;
}new headers to be included in the request
+x-
contentful- environment- id: string x-
contentful- signature: string x-
contentful- signed- headers: string x-
contentful- space- id: string x-
contentful- timestamp: string x-
contentful- user- id: string
sys: AppSignedRequestSys
System metadata
+
Type Alias AppSigningSecretProps
App
redactedValue: string;
sys: AppSigningSecretSys;
}
redactedValue: string;
sys: AppSigningSecretSys;
}
Type declaration
redacted
Value: string The last four characters of the signing secret
+sys: AppSigningSecretSys
System metadata
+
Type Alias AppUploadProps
Type Alias AssetKeyProps
Asset
policy: string;
secret: string;
}
policy: string;
secret: string;
}
Type declaration
policy: string
A JWT describing a policy; needs to be attached to signed URLs
+secret: string
A secret key to be used for signing URLs
+
Type Alias AssetProps
Asset
fields: {
description?: {
[key: string]: string;
};
file: {
[key: string]: {
contentType: string;
details?: Record<string, any>;
fileName: string;
upload?: string;
uploadFrom?: Record<string, any>;
url?: string;
};
};
title: {
[key: string]: string;
};
};
metadata?: MetadataProps;
sys: EntityMetaSysProps;
}
fields: {
description?: {
[key: string]: string;
};
file: {
[key: string]: {
contentType: string;
details?: Record<string, any>;
fileName: string;
upload?: string;
uploadFrom?: Record<string, any>;
url?: string;
};
};
title: {
[key: string]: string;
};
};
metadata?: MetadataProps;
sys: EntityMetaSysProps;
}
Type declaration
fields: {
description?: {
[key: string]: string;
};
file: {
[key: string]: {
contentType: string;
details?: Record<string, any>;
fileName: string;
upload?: string;
uploadFrom?: Record<string, any>;
url?: string;
};
};
title: {
[key: string]: string;
};
}Optionaldescription?: {
[key: string]: string;
}Description for this asset
+[key: string]: string
file: {
[key: string]: {
contentType: string;
details?: Record<string, any>;
fileName: string;
upload?: string;
uploadFrom?: Record<string, any>;
url?: string;
};
}File object for this asset
+[key: string]: {
contentType: string;
details?: Record<string, any>;
fileName: string;
upload?: string;
uploadFrom?: Record<string, any>;
url?: string;
}content
Type: string Optionaldetails?: Record<string, any>Details for the file, depending on file type (example: image size in bytes, etc)
+file
Name: string Optionalupload?: stringUrl where the file is available to be downloaded from, into the Contentful asset system. After the asset is processed this field is gone.
+OptionaluploadFrom?: Record<string, any> Optionalurl?: stringUrl where the file is available at the Contentful media asset system. This field won't be available until the asset is processed.
+
title: {
[key: string]: string;
}Title for this asset
+[key: string]: string
Optionalmetadata?: MetadataPropssys: EntityMetaSysProps
Type Alias BulkActionPayload
Bulk
Type Alias BulkActionType
Bulk
Type Alias ClientAPI
ClientAPI: ReturnType<typeof createClientApi>
Type Alias CommentProps
Comment
body: string;
status: CommentStatus;
sys: CommentSysProps;
}
body: string;
status: CommentStatus;
sys: CommentSysProps;
}
diff --git a/contentful-management/11.40.3/types/ConceptSchemeProps.html b/contentful-management/11.40.3/types/ConceptSchemeProps.html
new file mode 100644
index 0000000000..72b49d8459
--- /dev/null
+++ b/contentful-management/11.40.3/types/ConceptSchemeProps.html
@@ -0,0 +1 @@
+
diff --git a/contentful-management/11.40.3/types/ContentTypeMetadata.html b/contentful-management/11.40.3/types/ContentTypeMetadata.html
new file mode 100644
index 0000000000..b271016856
--- /dev/null
+++ b/contentful-management/11.40.3/types/ContentTypeMetadata.html
@@ -0,0 +1 @@
+
Type Alias ContentTypeMetadata
Content
annotations?: RequireAtLeastOne<{
ContentType?: AnnotationAssignment[];
ContentTypeField?: Record<string, AnnotationAssignment[]>;
}, "ContentType" | "ContentTypeField">;
taxonomy?: (Link<"TaxonomyConcept"> | Link<"TaxonomyConceptScheme">)[];
}
annotations?: RequireAtLeastOne<{
ContentType?: AnnotationAssignment[];
ContentTypeField?: Record<string, AnnotationAssignment[]>;
}, "ContentType" | "ContentTypeField">;
taxonomy?: (Link<"TaxonomyConcept"> | Link<"TaxonomyConceptScheme">)[];
}
Type Alias ContentTypeProps
Content
description: string;
displayField: string;
fields: ContentFields[];
metadata?: ContentTypeMetadata;
name: string;
sys: BasicMetaSysProps & {
environment: SysLink;
firstPublishedAt?: string;
publishedCounter?: number;
publishedVersion?: number;
space: SysLink;
};
}
description: string;
displayField: string;
fields: ContentFields[];
metadata?: ContentTypeMetadata;
name: string;
sys: BasicMetaSysProps & {
environment: SysLink;
firstPublishedAt?: string;
publishedCounter?: number;
publishedVersion?: number;
space: SysLink;
};
}
Type declaration
description: string
display
Field: string Field used as the main display field for Entries
+fields: ContentFields[]
All the fields contained in this Content Type
+Optionalmetadata?: ContentTypeMetadataname: string
sys: BasicMetaSysProps & {
environment: SysLink;
firstPublishedAt?: string;
publishedCounter?: number;
publishedVersion?: number;
space: SysLink;
}
Type Alias CreateApiKeyProps
Type Alias CreateAppAccessTokenProps
Create
jwt: string;
}
jwt: string;
}
Type declaration
jwt: string
JSON Web Token
+
Type Alias CreateAppActionCallProps
Create
parameters: {
[key: string]: any;
};
}
parameters: {
[key: string]: any;
};
}
Type declaration
parameters: {
[key: string]: any;
}The body for the call
+[key: string]: any
Type Alias CreateAppActionProps
Create
description?: string;
name: string;
type?: AppActionType;
url: string;
}
description?: string;
name: string;
type?: AppActionType;
url: string;
}
Type Alias CreateAppBundleProps
Create
actions?: ActionManifestProps[];
appUploadId: string;
comment?: string;
functions?: FunctionManifestProps[];
}
actions?: ActionManifestProps[];
appUploadId: string;
comment?: string;
functions?: FunctionManifestProps[];
}
Type Alias CreateAppDefinitionProps
Create
diff --git a/contentful-management/11.40.3/types/CreateAppEventSubscriptionProps.html b/contentful-management/11.40.3/types/CreateAppEventSubscriptionProps.html
new file mode 100644
index 0000000000..082e527a71
--- /dev/null
+++ b/contentful-management/11.40.3/types/CreateAppEventSubscriptionProps.html
@@ -0,0 +1 @@
+
Type Alias CreateAppEventSubscriptionProps
Type Alias CreateAppInstallationProps
Type Alias CreateAppKeyProps
Create
generate?: boolean;
jwk?: JWK;
}
generate?: boolean;
jwk?: JWK;
}
Type declaration
Optionalgenerate?: booleanToggle for automatic private key generation
+Optionaljwk?: JWKJSON Web Key, required if generate is falsy
+
Type Alias CreateAppSignedRequestProps
Create
body?: string;
headers?: Record<string, string>;
method:
| "GET"
| "PUT"
| "POST"
| "DELETE"
| "PATCH"
| "HEAD";
path: string;
}
body?: string;
headers?: Record<string, string>;
method:
| "GET"
| "PUT"
| "POST"
| "DELETE"
| "PATCH"
| "HEAD";
path: string;
}
Type declaration
Optionalbody?: stringoptional stringified body of the request
+Optionalheaders?: Record<string, string>optional headers of the request
+method:
| "GET"
| "PUT"
| "POST"
| "DELETE"
| "PATCH"
| "HEAD"the request method
+path: string
the path of the request method
+
Type Alias CreateAppSigningSecretProps
Create
value: string;
}
value: string;
}
Type declaration
value: string
A 64 character matching the regular expression /^[0-9a-zA-Z+/=_-]+$/
+
Type Alias CreateAssetKeyProps
Create
expiresAt: number;
}
expiresAt: number;
}
Type declaration
expires
At: number (required) UNIX timestamp in the future (but not more than 48 hours from now)
+
Type Alias CreateAssetProps
Type Alias CreateCommentProps
Type Alias CreateConceptProps
Type Alias CreateConceptSchemeProps
Create
Type Alias CreateContentTypeProps
Create
Type Alias CreateEntryProps<TFields>
Type Parameters
- TFields = KeyValueMap
Type Alias CreateEnvironmentAliasProps
Type Alias CreateEnvironmentProps
diff --git a/contentful-management/11.40.3/types/CreateEnvironmentTemplateProps.html b/contentful-management/11.40.3/types/CreateEnvironmentTemplateProps.html
new file mode 100644
index 0000000000..aea673c63c
--- /dev/null
+++ b/contentful-management/11.40.3/types/CreateEnvironmentTemplateProps.html
@@ -0,0 +1 @@
+
Type Alias CreateEnvironmentTemplateProps
Type Alias CreateLocaleProps
Create
| "optional"
| "contentManagementApi"
| "default"
| "contentDeliveryApi">, "internal_code">
| "optional"
| "contentManagementApi"
| "default"
| "contentDeliveryApi">, "internal_code">
Type Alias CreateOrganizationInvitationProps
Type Alias CreatePATProps
Type Alias CreatePersonalAccessTokenProps
Create
expiresIn?: number;
}
expiresIn?: number;
}
Type Alias CreateRoleProps
Type Alias CreateSpaceMembershipProps
Type Alias CreateTagProps
Type Alias CreateTaskProps
Type Alias CreateTeamMembershipProps
Type Alias CreateTeamProps
Type Alias CreateTeamSpaceMembershipProps
Type Alias CreateUIExtensionProps
CreateUIExtension
extension: RequireExactlyOne<SetRequired<UIExtensionProps["extension"], "name" | "fieldTypes" | "sidebar">, "src" | "srcdoc">;
}
extension: RequireExactlyOne<SetRequired<UIExtensionProps["extension"], "name" | "fieldTypes" | "sidebar">, "src" | "srcdoc">;
}
Type Alias CreateWebhooksProps
Type Alias CreateWithResponseParams
Type Alias CreateWorkflowDefinitionParams
Type Alias CreateWorkflowDefinitionProps
Create
steps: CreateWorkflowStepProps[];
}
steps: CreateWorkflowStepProps[];
}
Type Alias CreateWorkflowProps
Create
entity: Link<"Entry">;
workflowDefinition: Link<"WorkflowDefinition">;
}
entity: Link<"Entry">;
workflowDefinition: Link<"WorkflowDefinition">;
}
Type Alias CreateWorkflowStepProps
Type Alias DefinedParameters
Defined
Type Alias DeleteCommentParams
Type Alias DeleteConceptParams
Type Alias DeleteConceptSchemeParams
Type Alias DeleteWorkflowDefinitionParams
Type Alias DeleteWorkflowParams
Type Alias EditorInterfaceProps
Editor
controls?: Control[];
editor?: Editor;
editorLayout?: FieldGroupItem[];
editors?: Editor[];
groupControls?: GroupControl[];
sidebar?: SidebarItem[];
sys: MetaSysProps & {
contentType: {
sys: MetaLinkProps;
};
environment: {
sys: MetaLinkProps;
};
space: {
sys: MetaLinkProps;
};
};
}
controls?: Control[];
editor?: Editor;
editorLayout?: FieldGroupItem[];
editors?: Editor[];
groupControls?: GroupControl[];
sidebar?: SidebarItem[];
sys: MetaSysProps & {
contentType: {
sys: MetaLinkProps;
};
environment: {
sys: MetaLinkProps;
};
space: {
sys: MetaLinkProps;
};
};
}
Type declaration
Optionalcontrols?: Control[]Array of fields and their associated widgetId
+Optionaleditor?: EditorLegacy singular editor override
+OptionaleditorLayout?: FieldGroupItem[] Array of editor layout field groups
+Optionaleditors?: Editor[]Array of editors. Defaults will be used if property is missing.
+OptionalgroupControls?: GroupControl[] Array of field groups and their associated widgetId
+Optionalsidebar?: SidebarItem[]Array of sidebar widgets. Defaults will be used if property is missing.
+sys: MetaSysProps & {
contentType: {
sys: MetaLinkProps;
};
environment: {
sys: MetaLinkProps;
};
space: {
sys: MetaLinkProps;
};
}
Type Alias EditorLayoutItem
Type Alias EntryProps<T>
Type Parameters
- T = KeyValueMap
Type Alias Environment
Type Alias EnvironmentAliasProps
Environment
environment: {
sys: MetaLinkProps;
};
sys: BasicMetaSysProps & {
space: SysLink;
};
}
environment: {
sys: MetaLinkProps;
};
sys: BasicMetaSysProps & {
space: SysLink;
};
}
Type declaration
environment: {
sys: MetaLinkProps;
}sys: MetaLinkProps
sys: BasicMetaSysProps & {
space: SysLink;
}System meta data
+
Type Alias EnvironmentProps
Environment
name: string;
sys: EnvironmentMetaSys;
}
name: string;
sys: EnvironmentMetaSys;
}
Type declaration
name: string
Name of the environment
+sys: EnvironmentMetaSys
System metadata
+
Type Alias EnvironmentTemplate
Environment
Type Alias EnvironmentTemplateInstallation
Environment
Type Alias EnvironmentTemplateInstallationProps
Environment
sys: BasicMetaSysProps & {
completedAt?: ISO8601Timestamp;
createdAt: ISO8601Timestamp;
createdBy: Link<"User" | "AppDefinition">;
environment: Link<"Environment">;
errors?: JsonArray;
space: Link<"Space">;
status: EnvironmentTemplateInstallationStatus;
template: VersionedLink<"Template">;
type: "EnvironmentTemplateInstallation";
updatedAt: ISO8601Timestamp;
updatedBy: Link<"User" | "AppDefinition">;
version: number;
};
}
sys: BasicMetaSysProps & {
completedAt?: ISO8601Timestamp;
createdAt: ISO8601Timestamp;
createdBy: Link<"User" | "AppDefinition">;
environment: Link<"Environment">;
errors?: JsonArray;
space: Link<"Space">;
status: EnvironmentTemplateInstallationStatus;
template: VersionedLink<"Template">;
type: "EnvironmentTemplateInstallation";
updatedAt: ISO8601Timestamp;
updatedBy: Link<"User" | "AppDefinition">;
version: number;
};
}
Type Alias EnvironmentTemplateInstallationStatus
Environment
Type Alias EnvironmentTemplateParams
Environment
environmentId: string;
environmentTemplateId: string;
spaceId: string;
}
environmentId: string;
environmentTemplateId: string;
spaceId: string;
}
Type Alias EnvironmentTemplateProps
Environment
description?: string;
entities: {
contentTypeTemplates: ContentTypeTemplateProps[];
editorInterfaceTemplates: EditorInterfaceTemplateProps[];
};
name: string;
sys: BasicMetaSysProps & {
organization: Link<"Organization">;
version: number;
};
versionDescription?: string;
versionName: string;
}
description?: string;
entities: {
contentTypeTemplates: ContentTypeTemplateProps[];
editorInterfaceTemplates: EditorInterfaceTemplateProps[];
};
name: string;
sys: BasicMetaSysProps & {
organization: Link<"Organization">;
version: number;
};
versionDescription?: string;
versionName: string;
}
diff --git a/contentful-management/11.40.3/types/FieldType.html b/contentful-management/11.40.3/types/FieldType.html
new file mode 100644
index 0000000000..9f4e538699
--- /dev/null
+++ b/contentful-management/11.40.3/types/FieldType.html
@@ -0,0 +1 @@
+
Type Alias FieldType
Field
| {
type: "Symbol";
}
| {
type: "Text";
}
| {
type: "RichText";
}
| {
type: "Integer";
}
| {
type: "Number";
}
| {
type: "Date";
}
| {
type: "Boolean";
}
| {
type: "Object";
}
| {
type: "Location";
}
| {
linkType: "Asset";
type: "Link";
}
| {
linkType: "Entry";
type: "Link";
}
| {
linkType: string;
type: "ResourceLink";
}
| {
items: {
type: "Symbol";
};
type: "Array";
}
| {
items: {
linkType: "Entry";
type: "Link";
};
type: "Array";
}
| {
items: {
linkType: string;
type: "ResourceLink";
};
type: "Array";
}
| {
items: {
linkType: "Asset";
type: "Link";
};
type: "Array";
}
| {
type: "Symbol";
}
| {
type: "Text";
}
| {
type: "RichText";
}
| {
type: "Integer";
}
| {
type: "Number";
}
| {
type: "Date";
}
| {
type: "Boolean";
}
| {
type: "Object";
}
| {
type: "Location";
}
| {
linkType: "Asset";
type: "Link";
}
| {
linkType: "Entry";
type: "Link";
}
| {
linkType: string;
type: "ResourceLink";
}
| {
items: {
type: "Symbol";
};
type: "Array";
}
| {
items: {
linkType: "Entry";
type: "Link";
};
type: "Array";
}
| {
items: {
linkType: string;
type: "ResourceLink";
};
type: "Array";
}
| {
items: {
linkType: "Asset";
type: "Link";
};
type: "Array";
}
Type Alias FreeFormParameters
Free
| Record<string, any>
| any[]
| number
| string
| boolean
| Record<string, any>
| any[]
| number
| string
| boolean
Type Alias FunctionProps
Function
accepts: string[];
allowNetworks?: string[];
description: string;
name: string;
path: string;
sys: {
appDefinition: Link<"AppDefinition">;
createdAt: string;
createdBy: Link<"User">;
id: string;
organization: Link<"Organization">;
type: "Function";
updatedAt: string;
updatedBy: Link<"User">;
};
}
accepts: string[];
allowNetworks?: string[];
description: string;
name: string;
path: string;
sys: {
appDefinition: Link<"AppDefinition">;
createdAt: string;
createdBy: Link<"User">;
id: string;
organization: Link<"Organization">;
type: "Function";
updatedAt: string;
updatedBy: Link<"User">;
};
}
Type Alias GetAppActionCallDetailsParams
Type Alias GetAppActionCallParams
Type Alias GetAppActionParams
Type Alias GetAppActionsForEnvParams
Type Alias GetAppBundleParams
Type Alias GetAppDefinitionParams
Type Alias GetAppInstallationParams
Type Alias GetAppInstallationsForOrgParams
Type Alias GetAppKeyParams
Type Alias GetAppUploadParams
Type Alias GetBulkActionParams
Type Alias GetCommentParams
Type Alias GetCommentParentEntityParams
Get
parentEntityId: string;
parentEntityReference?: string;
parentEntityType: "ContentType";
} | {
parentEntityId: string;
parentEntityReference?: string;
parentEntityType: "Entry";
} | {
parentEntityId: string;
parentEntityType: "Workflow";
parentEntityVersion?: number;
})
parentEntityId: string;
parentEntityReference?: string;
parentEntityType: "ContentType";
} | {
parentEntityId: string;
parentEntityReference?: string;
parentEntityType: "Entry";
} | {
parentEntityId: string;
parentEntityType: "Workflow";
parentEntityVersion?: number;
})
Type Alias GetConceptDescendantsParams
Get
conceptId: string;
} & {
query?: {
depth?: number;
pageUrl?: string;
};
}
conceptId: string;
} & {
query?: {
depth?: number;
pageUrl?: string;
};
}
Type Alias GetConceptParams
Type Alias GetConceptSchemeParams
Type Alias GetContentTypeParams
Type Alias GetEditorInterfaceParams
Type Alias GetEntryParams
Type Alias GetEnvironmentTemplateParams
Type Alias GetExtensionParams
Type Alias GetManyCommentsParams
Get
status?: CommentStatus;
}
status?: CommentStatus;
}
Type Alias GetManyConceptParams
Get
query?: {
pageUrl?: string;
} | {
conceptScheme?: string;
query?: string;
} & BasicCursorPaginationOptions & Omit<PaginationQueryOptions, "skip">;
}
query?: {
pageUrl?: string;
} | {
conceptScheme?: string;
query?: string;
} & BasicCursorPaginationOptions & Omit<PaginationQueryOptions, "skip">;
}
Type Alias GetManyConceptSchemeParams
Get
query?: {
pageUrl?: string;
} | {
query?: string;
} & BasicCursorPaginationOptions & Omit<PaginationQueryOptions, "skip">;
}
query?: {
pageUrl?: string;
} | {
query?: string;
} & BasicCursorPaginationOptions & Omit<PaginationQueryOptions, "skip">;
}
Type Alias GetOrganizationMembershipParams
Type Alias GetOrganizationParams
Get
organizationId: string;
}
organizationId: string;
}
Type Alias GetReleaseParams
Type Alias GetResourceParams
Type Alias GetResourceProviderParams
Type Alias GetResourceTypeParams
Type Alias GetSnapshotForContentTypeParams
Type Alias GetSnapshotForEntryParams
Type Alias GetSpaceEnvAliasParams
Type Alias GetSpaceEnvironmentParams
Get
environmentId: string;
spaceId: string;
}
environmentId: string;
spaceId: string;
}
Type Alias GetSpaceEnvironmentUploadParams
Type Alias GetSpaceMembershipProps
Type Alias GetSpaceParams
Get
spaceId: string;
}
spaceId: string;
}
Type Alias GetTagParams
Type Alias GetTaskParams
Type Alias GetTeamMembershipParams
Type Alias GetTeamParams
Get
organizationId: string;
teamId: string;
}
organizationId: string;
teamId: string;
}
Type Alias GetTeamSpaceMembershipParams
Type Alias GetUIConfigParams
Type Alias GetUserUIConfigParams
Type Alias GetWebhookCallDetailsUrl
Type Alias GetWebhookParams
Type Alias GetWorkflowDefinitionParams
Type Alias GetWorkflowParams
Type Alias Hint
Hint: {
fieldId: string;
operation: "renameFieldId";
previousFieldId: string;
}
fieldId: string;
operation: "renameFieldId";
previousFieldId: string;
}
Type Alias ISO8601Timestamp
ISO8601
String will be in ISO8601 datetime format e.g. 2013-06-26T13:57:24Z
+Type Alias IconType
Icon
Type Alias InstallationParameterType
Type Alias KeyValueMap
Key
Type Alias LocaleProps
Locale
code: string;
contentDeliveryApi: boolean;
contentManagementApi: boolean;
default: boolean;
fallbackCode: string | null;
internal_code: string;
name: string;
optional: boolean;
sys: BasicMetaSysProps & {
environment: SysLink;
space: SysLink;
};
}
code: string;
contentDeliveryApi: boolean;
contentManagementApi: boolean;
default: boolean;
fallbackCode: string | null;
internal_code: string;
name: string;
optional: boolean;
sys: BasicMetaSysProps & {
environment: SysLink;
space: SysLink;
};
}
Type declaration
code: string
Locale code (example: en-us)
+content
Delivery Api: boolean If the content under this locale should be available on the CDA (for public reading)
+content
Management Api: boolean If the content under this locale should be available on the CMA (for editing)
+default: boolean
If this is the default locale
+fallback
Code: string | null Locale code to fallback to when there is not content for the current locale
+internal_
code: string Internal locale code
+name: string
Locale name
+optional: boolean
If the locale needs to be filled in on entries or not
+sys: BasicMetaSysProps & {
environment: SysLink;
space: SysLink;
}
Type Alias Organization
Type Alias OrganizationInvitationProps
Organization
email: string;
firstName: string;
lastName: string;
role: string;
sys: MetaSysProps & {
invitationUrl: string;
organizationMembership: {
sys: MetaLinkProps;
};
status: string;
user: Record<string, any> | null;
};
}
email: string;
firstName: string;
lastName: string;
role: string;
sys: MetaSysProps & {
invitationUrl: string;
organizationMembership: {
sys: MetaLinkProps;
};
status: string;
user: Record<string, any> | null;
};
}
Type Alias OrganizationMembershipProps
Organization
role: string;
status: boolean;
sys: MetaSysProps & {
user: {
sys: MetaLinkProps;
};
};
}
role: string;
status: boolean;
sys: MetaSysProps & {
user: {
sys: MetaLinkProps;
};
};
}
Type declaration
role: string
Role
+status: boolean
status
+sys: MetaSysProps & {
user: {
sys: MetaLinkProps;
};
}System metadata
+
Type Alias OrganizationProp
Type Alias OrganizationProps
Type declaration
name: string
Name
+sys: MetaSysProps
System metadata
+
Type Alias PaginationQueryParams
Type Alias ParameterOption
Parameter
[key: string]: string;
}
[key: string]: string;
}
Type Alias ParameterType
Parameter
| "Boolean"
| "Symbol"
| "Number"
| "Enum"
| "Boolean"
| "Symbol"
| "Number"
| "Enum"
Type Alias PersonalAccessTokenProp
Type Alias PersonalAccessTokenProps
Personal
name: string;
revokedAt: null | string;
scopes: "content_management_manage"[];
sys: MetaSysProps & {
expiresAt?: string;
};
token?: string;
}
name: string;
revokedAt: null | string;
scopes: "content_management_manage"[];
sys: MetaSysProps & {
expiresAt?: string;
};
token?: string;
}
Type Alias PlainClientAPI
Plain
accessToken: {
createPersonalAccessToken(rawData: CreatePATProps, headers?: Partial<RawAxiosHeaders & {
Accept: AxiosHeaderValue;
Authorization: AxiosHeaderValue;
Content-Encoding: AxiosHeaderValue;
Content-Length: AxiosHeaderValue;
User-Agent: AxiosHeaderValue;
} & {
Content-Type: ContentType;
}>): Promise<AccessTokenProp>;
get(params: OptionalDefaults<{
tokenId: string;
}>): Promise<AccessTokenProp>;
getMany(params: OptionalDefaults<QueryParams>): Promise<CollectionProp<AccessTokenProp>>;
getManyForOrganization(params: OptionalDefaults<GetOrganizationParams & QueryParams>): Promise<CollectionProp<AccessTokenProp>>;
revoke(params: OptionalDefaults<{
tokenId: string;
}>): Promise<AccessTokenProp>;
};
apiKey: {
create(params: OptionalDefaults<GetSpaceParams>, data: CreateApiKeyProps, headers?: Partial<RawAxiosHeaders & {
Accept: AxiosHeaderValue;
Authorization: AxiosHeaderValue;
Content-Encoding: AxiosHeaderValue;
Content-Length: AxiosHeaderValue;
User-Agent: AxiosHeaderValue;
} & {
Content-Type: ContentType;
}>): Promise<ApiKeyProps>;
createWithId(params: OptionalDefaults<GetSpaceParams & {
apiKeyId: string;
}>, data: CreateApiKeyProps, headers?: Partial<RawAxiosHeaders & {
Accept: AxiosHeaderValue;
Authorization: AxiosHeaderValue;
Content-Encoding: AxiosHeaderValue;
Content-Length: AxiosHeaderValue;
User-Agent: AxiosHeaderValue;
} & {
Content-Type: ContentType;
}>): Promise<ApiKeyProps>;
delete(params: OptionalDefaults<GetSpaceParams & {
apiKeyId: string;
}>): Promise<any>;
get(params: OptionalDefaults<GetSpaceParams & {
apiKeyId: string;
}>): Promise<ApiKeyProps>;
getMany(params: OptionalDefaults<GetSpaceParams & QueryParams>): Promise<CollectionProp<ApiKeyProps>>;
update(params: OptionalDefaults<GetSpaceParams & {
apiKeyId: string;
}>, rawData: ApiKeyProps, headers?: Partial<RawAxiosHeaders & {
Accept: AxiosHeaderValue;
Authorization: AxiosHeaderValue;
Content-Encoding: AxiosHeaderValue;
Content-Length: AxiosHeaderValue;
User-Agent: AxiosHeaderValue;
} & {
Content-Type: ContentType;
}>): Promise<ApiKeyProps>;
};
appAccessToken: AppAccessTokenPlainClientAPI;
appAction: AppActionPlainClientAPI;
appActionCall: AppActionCallPlainClientAPI;
appBundle: AppBundlePlainClientAPI;
appDefinition: AppDefinitionPlainClientAPI;
appDetails: AppDetailsPlainClientAPI;
appEventSubscription: AppEventSubscriptionPlainClientAPI;
appInstallation: AppInstallationPlainClientAPI;
appKey: AppKeyPlainClientAPI;
appSignedRequest: AppSignedRequestPlainClientAPI;
appSigningSecret: AppSigningSecretPlainClientAPI;
appUpload: AppUploadPlainClientAPI;
asset: {
archive(params: OptionalDefaults<GetSpaceEnvironmentParams & {
assetId: string;
}>): Promise<AssetProps>;
create(params: OptionalDefaults<GetSpaceEnvironmentParams>, rawData: CreateAssetProps): Promise<AssetProps>;
createFromFiles(params: OptionalDefaults<GetSpaceEnvironmentParams>, data: Omit<AssetFileProp, "sys">): Promise<AssetProps>;
createWithId(params: OptionalDefaults<GetSpaceEnvironmentParams & {
assetId: string;
}>, rawData: CreateAssetProps): Promise<AssetProps>;
delete(params: OptionalDefaults<GetSpaceEnvironmentParams & {
assetId: string;
}>): Promise<any>;
get(params: OptionalDefaults<GetSpaceEnvironmentParams & {
assetId: string;
} & QueryParams>, rawData?: unknown, headers?: Partial<RawAxiosHeaders & {
Accept: AxiosHeaderValue;
Authorization: AxiosHeaderValue;
Content-Encoding: AxiosHeaderValue;
Content-Length: AxiosHeaderValue;
User-Agent: AxiosHeaderValue;
} & {
Content-Type: ContentType;
}>): Promise<AssetProps>;
getMany(params: OptionalDefaults<GetSpaceEnvironmentParams & QueryParams>, rawData?: unknown, headers?: Partial<RawAxiosHeaders & {
Accept: AxiosHeaderValue;
Authorization: AxiosHeaderValue;
Content-Encoding: AxiosHeaderValue;
Content-Length: AxiosHeaderValue;
User-Agent: AxiosHeaderValue;
} & {
Content-Type: ContentType;
}>): Promise<CollectionProp<AssetProps>>;
getPublished(params: OptionalDefaults<GetSpaceEnvironmentParams & QueryParams>, rawData?: unknown, headers?: Partial<RawAxiosHeaders & {
Accept: AxiosHeaderValue;
Authorization: AxiosHeaderValue;
Content-Encoding: AxiosHeaderValue;
Content-Length: AxiosHeaderValue;
User-Agent: AxiosHeaderValue;
} & {
Content-Type: ContentType;
}>): Promise<CollectionProp<AssetProps>>;
processForAllLocales(params: OptionalDefaults<GetSpaceEnvironmentParams>, asset: AssetProps, processingOptions?: AssetProcessingForLocale): Promise<AssetProps>;
processForLocale(params: OptionalDefaults<GetSpaceEnvironmentParams>, asset: AssetProps, locale: string, processingOptions?: AssetProcessingForLocale): Promise<AssetProps>;
publish(params: OptionalDefaults<GetSpaceEnvironmentParams & {
assetId: string;
}>, rawData: AssetProps): Promise<AssetProps>;
unarchive(params: OptionalDefaults<GetSpaceEnvironmentParams & {
assetId: string;
}>): Promise<AssetProps>;
unpublish(params: OptionalDefaults<GetSpaceEnvironmentParams & {
assetId: string;
}>): Promise<AssetProps>;
update(params: OptionalDefaults<GetSpaceEnvironmentParams & {
assetId: string;
}>, rawData: AssetProps, headers?: Partial<RawAxiosHeaders & {
Accept: AxiosHeaderValue;
Authorization: AxiosHeaderValue;
Content-Encoding: AxiosHeaderValue;
Content-Length: AxiosHeaderValue;
User-Agent: AxiosHeaderValue;
} & {
Content-Type: ContentType;
}>): Promise<AssetProps>;
};
assetKey: {
create(params: OptionalDefaults<GetSpaceEnvironmentParams>, data: CreateAssetKeyProps): Promise<AssetKeyProps>;
};
bulkAction: {
get<T>(params: GetBulkActionParams): Promise<BulkActionProps<T>>;
publish(params: GetSpaceEnvironmentParams, payload: BulkActionPublishPayload): Promise<BulkActionProps<BulkActionPublishPayload>>;
unpublish(params: GetSpaceEnvironmentParams, payload: BulkActionUnpublishPayload): Promise<BulkActionProps<BulkActionUnpublishPayload>>;
validate(params: GetSpaceEnvironmentParams, payload: BulkActionValidatePayload): Promise<BulkActionProps<BulkActionValidatePayload>>;
};
comment: CommentPlainClientAPI;
concept: ConceptPlainClientAPI;
conceptScheme: ConceptSchemePlainClientAPI;
contentType: {
create(params: OptionalDefaults<GetSpaceEnvironmentParams>, rawData: {
description?: string;
displayField?: string;
fields: ContentFields[];
metadata?: ContentTypeMetadata;
name: string;
}): Promise<ContentTypeProps>;
createWithId(params: OptionalDefaults<GetSpaceEnvironmentParams & {
contentTypeId: string;
}>, rawData: {
description?: string;
displayField?: string;
fields: ContentFields[];
metadata?: ContentTypeMetadata;
name: string;
}): Promise<ContentTypeProps>;
delete(params: OptionalDefaults<GetContentTypeParams>): Promise<any>;
get(params: OptionalDefaults<GetSpaceEnvironmentParams & {
contentTypeId: string;
} & QueryParams>): Promise<ContentTypeProps>;
getMany(params: OptionalDefaults<GetSpaceEnvironmentParams & QueryParams>): Promise<CollectionProp<ContentTypeProps>>;
omitAndDeleteField(params: OptionalDefaults<GetContentTypeParams>, contentType: ContentTypeProps, fieldId: string): Promise<ContentTypeProps>;
publish(params: OptionalDefaults<GetContentTypeParams>, rawData: ContentTypeProps): Promise<ContentTypeProps>;
unpublish(params: OptionalDefaults<GetContentTypeParams>): Promise<ContentTypeProps>;
update(params: OptionalDefaults<GetContentTypeParams>, rawData: ContentTypeProps, headers?: Partial<RawAxiosHeaders & {
Accept: AxiosHeaderValue;
Authorization: AxiosHeaderValue;
Content-Encoding: AxiosHeaderValue;
Content-Length: AxiosHeaderValue;
User-Agent: AxiosHeaderValue;
} & {
Content-Type: ContentType;
}>): Promise<ContentTypeProps>;
};
editorInterface: EditorInterfacePlainClientAPI;
entry: {
archive<T>(params: OptionalDefaults<GetSpaceEnvironmentParams & {
entryId: string;
}>): Promise<EntryProps<T>>;
create<T>(params: OptionalDefaults<GetSpaceEnvironmentParams & {
contentTypeId: string;
}>, rawData: CreateEntryProps<T>): Promise<EntryProps<T>>;
createWithId<T>(params: OptionalDefaults<GetSpaceEnvironmentParams & {
contentTypeId: string;
entryId: string;
}>, rawData: CreateEntryProps<T>): Promise<EntryProps<T>>;
delete(params: OptionalDefaults<GetSpaceEnvironmentParams & {
entryId: string;
}>): Promise<any>;
get<T>(params: OptionalDefaults<GetSpaceEnvironmentParams & {
entryId: string;
}>, rawData?: unknown, headers?: Partial<RawAxiosHeaders & {
Accept: AxiosHeaderValue;
Authorization: AxiosHeaderValue;
Content-Encoding: AxiosHeaderValue;
Content-Length: AxiosHeaderValue;
User-Agent: AxiosHeaderValue;
} & {
Content-Type: ContentType;
}>): Promise<EntryProps<T>>;
getMany<T>(params: OptionalDefaults<GetSpaceEnvironmentParams & QueryParams>, rawData?: unknown, headers?: Partial<RawAxiosHeaders & {
Accept: AxiosHeaderValue;
Authorization: AxiosHeaderValue;
Content-Encoding: AxiosHeaderValue;
Content-Length: AxiosHeaderValue;
User-Agent: AxiosHeaderValue;
} & {
Content-Type: ContentType;
}>): Promise<CollectionProp<EntryProps<T>>>;
getPublished<T>(params: OptionalDefaults<GetSpaceEnvironmentParams & QueryParams>, rawData?: unknown, headers?: Partial<RawAxiosHeaders & {
Accept: AxiosHeaderValue;
Authorization: AxiosHeaderValue;
Content-Encoding: AxiosHeaderValue;
Content-Length: AxiosHeaderValue;
User-Agent: AxiosHeaderValue;
} & {
Content-Type: ContentType;
}>): Promise<CollectionProp<EntryProps<T>>>;
patch<T>(params: OptionalDefaults<GetSpaceEnvironmentParams & {
entryId: string;
}>, rawData: OpPatch[], headers?: Partial<RawAxiosHeaders & {
Accept: AxiosHeaderValue;
Authorization: AxiosHeaderValue;
Content-Encoding: AxiosHeaderValue;
Content-Length: AxiosHeaderValue;
User-Agent: AxiosHeaderValue;
} & {
Content-Type: ContentType;
}>): Promise<EntryProps<T>>;
publish<T>(params: OptionalDefaults<GetSpaceEnvironmentParams & {
entryId: string;
}>, rawData: EntryProps<T>): Promise<EntryProps<T>>;
references(params: OptionalDefaults<GetSpaceEnvironmentParams & {
entryId: string;
include?: number;
}>): Promise<EntryReferenceProps>;
unarchive<T>(params: OptionalDefaults<GetSpaceEnvironmentParams & {
entryId: string;
}>): Promise<EntryProps<T>>;
unpublish<T>(params: OptionalDefaults<GetSpaceEnvironmentParams & {
entryId: string;
}>): Promise<EntryProps<T>>;
update<T>(params: OptionalDefaults<GetSpaceEnvironmentParams & {
entryId: string;
}>, rawData: EntryProps<T>, headers?: Partial<RawAxiosHeaders & {
Accept: AxiosHeaderValue;
Authorization: AxiosHeaderValue;
Content-Encoding: AxiosHeaderValue;
Content-Length: AxiosHeaderValue;
User-Agent: AxiosHeaderValue;
} & {
Content-Type: ContentType;
}>): Promise<EntryProps<T>>;
};
environment: EnvironmentPlainClientAPI;
environmentAlias: EnvironmentAliasPlainClientAPI;
environmentTemplate: {
create(params: GetOrganizationParams, rawData: CreateEnvironmentTemplateProps, headers?: Partial<RawAxiosHeaders & {
Accept: AxiosHeaderValue;
Authorization: AxiosHeaderValue;
Content-Encoding: AxiosHeaderValue;
Content-Length: AxiosHeaderValue;
User-Agent: AxiosHeaderValue;
} & {
Content-Type: ContentType;
}>): Promise<EnvironmentTemplateProps>;
delete(params: GetEnvironmentTemplateParams, headers?: Partial<RawAxiosHeaders & {
Accept: AxiosHeaderValue;
Authorization: AxiosHeaderValue;
Content-Encoding: AxiosHeaderValue;
Content-Length: AxiosHeaderValue;
User-Agent: AxiosHeaderValue;
} & {
Content-Type: ContentType;
}>): Promise<void>;
disconnect(params: EnvironmentTemplateParams, headers?: Partial<RawAxiosHeaders & {
Accept: AxiosHeaderValue;
Authorization: AxiosHeaderValue;
Content-Encoding: AxiosHeaderValue;
Content-Length: AxiosHeaderValue;
User-Agent: AxiosHeaderValue;
} & {
Content-Type: ContentType;
}>): Promise<void>;
get(params: GetOrganizationParams & {
environmentTemplateId: string;
} & {
query?: {
select?: string;
};
version?: number;
}, headers?: Partial<RawAxiosHeaders & {
Accept: AxiosHeaderValue;
Authorization: AxiosHeaderValue;
Content-Encoding: AxiosHeaderValue;
Content-Length: AxiosHeaderValue;
User-Agent: AxiosHeaderValue;
} & {
Content-Type: ContentType;
}>): Promise<EnvironmentTemplateProps>;
getMany(params: GetOrganizationParams & {
query?: BasicCursorPaginationOptions & {
select?: string;
};
}, headers?: Partial<RawAxiosHeaders & {
Accept: AxiosHeaderValue;
Authorization: AxiosHeaderValue;
Content-Encoding: AxiosHeaderValue;
Content-Length: AxiosHeaderValue;
User-Agent: AxiosHeaderValue;
} & {
Content-Type: ContentType;
}>): Promise<CursorPaginatedCollectionProp<EnvironmentTemplateProps>>;
install(params: EnvironmentTemplateParams, rawData: CreateEnvironmentTemplateInstallationProps, headers?: Partial<RawAxiosHeaders & {
Accept: AxiosHeaderValue;
Authorization: AxiosHeaderValue;
Content-Encoding: AxiosHeaderValue;
Content-Length: AxiosHeaderValue;
User-Agent: AxiosHeaderValue;
} & {
Content-Type: ContentType;
}>): Promise<EnvironmentTemplateInstallationProps>;
update(params: GetEnvironmentTemplateParams, rawData: EnvironmentTemplateProps, headers?: Partial<RawAxiosHeaders & {
Accept: AxiosHeaderValue;
Authorization: AxiosHeaderValue;
Content-Encoding: AxiosHeaderValue;
Content-Length: AxiosHeaderValue;
User-Agent: AxiosHeaderValue;
} & {
Content-Type: ContentType;
}>): Promise<EnvironmentTemplateProps>;
validate(params: EnvironmentTemplateParams & {
version?: number;
}, rawData: ValidateEnvironmentTemplateInstallationProps, headers?: Partial<RawAxiosHeaders & {
Accept: AxiosHeaderValue;
Authorization: AxiosHeaderValue;
Content-Encoding: AxiosHeaderValue;
Content-Length: AxiosHeaderValue;
User-Agent: AxiosHeaderValue;
} & {
Content-Type: ContentType;
}>): Promise<EnvironmentTemplateValidationProps>;
versions(params: GetOrganizationParams & {
environmentTemplateId: string;
} & {
query?: BasicCursorPaginationOptions & {
select?: string;
};
}, headers?: Partial<RawAxiosHeaders & {
Accept: AxiosHeaderValue;
Authorization: AxiosHeaderValue;
Content-Encoding: AxiosHeaderValue;
Content-Length: AxiosHeaderValue;
User-Agent: AxiosHeaderValue;
} & {
Content-Type: ContentType;
}>): Promise<CursorPaginatedCollectionProp<EnvironmentTemplateProps>>;
versionUpdate(params: GetOrganizationParams & {
environmentTemplateId: string;
} & {
version: number;
}, rawData: {
versionDescription?: string;
versionName?: string;
}, headers?: Partial<RawAxiosHeaders & {
Accept: AxiosHeaderValue;
Authorization: AxiosHeaderValue;
Content-Encoding: AxiosHeaderValue;
Content-Length: AxiosHeaderValue;
User-Agent: AxiosHeaderValue;
} & {
Content-Type: ContentType;
}>): Promise<EnvironmentTemplateProps>;
};
environmentTemplateInstallation: {
getForEnvironment(params: BasicCursorPaginationOptions & EnvironmentTemplateParams & {
installationId?: string;
}, headers?: Partial<RawAxiosHeaders & {
Accept: AxiosHeaderValue;
Authorization: AxiosHeaderValue;
Content-Encoding: AxiosHeaderValue;
Content-Length: AxiosHeaderValue;
User-Agent: AxiosHeaderValue;
} & {
Content-Type: ContentType;
}>): Promise<CursorPaginatedCollectionProp<EnvironmentTemplateInstallationProps>>;
getMany(params: BasicCursorPaginationOptions & {
environmentId?: string;
environmentTemplateId: string;
organizationId: string;
spaceId?: string;
}, headers?: Partial<RawAxiosHeaders & {
Accept: AxiosHeaderValue;
Authorization: AxiosHeaderValue;
Content-Encoding: AxiosHeaderValue;
Content-Length: AxiosHeaderValue;
User-Agent: AxiosHeaderValue;
} & {
Content-Type: ContentType;
}>): Promise<CursorPaginatedCollectionProp<EnvironmentTemplateInstallationProps>>;
};
extension: ExtensionPlainClientAPI;
function: {
getMany(params: OptionalDefaults<GetOrganizationParams & {
appDefinitionId: string;
} & QueryParams>): Promise<CollectionProp<FunctionProps>>;
};
locale: LocalePlainClientAPI;
organization: OrganizationPlainClientAPI;
organizationInvitation: {
create(params: OptionalDefaults<{
organizationId: string;
}>, data: CreateOrganizationInvitationProps, headers?: Partial<RawAxiosHeaders & {
Accept: AxiosHeaderValue;
Authorization: AxiosHeaderValue;
Content-Encoding: AxiosHeaderValue;
Content-Length: AxiosHeaderValue;
User-Agent: AxiosHeaderValue;
} & {
Content-Type: ContentType;
}>): Promise<OrganizationInvitationProps>;
get(params: OptionalDefaults<{
invitationId: string;
organizationId: string;
}>, headers?: Partial<RawAxiosHeaders & {
Accept: AxiosHeaderValue;
Authorization: AxiosHeaderValue;
Content-Encoding: AxiosHeaderValue;
Content-Length: AxiosHeaderValue;
User-Agent: AxiosHeaderValue;
} & {
Content-Type: ContentType;
}>): Promise<OrganizationInvitationProps>;
};
organizationMembership: {
delete(params: OptionalDefaults<GetOrganizationMembershipParams>): Promise<any>;
get(params: OptionalDefaults<GetOrganizationMembershipParams>): Promise<OrganizationMembershipProps>;
getMany(params: OptionalDefaults<GetOrganizationParams & QueryParams>): Promise<CollectionProp<OrganizationMembershipProps>>;
update(params: OptionalDefaults<GetOrganizationMembershipParams>, rawData: OrganizationMembershipProps, headers?: Partial<RawAxiosHeaders & {
Accept: AxiosHeaderValue;
Authorization: AxiosHeaderValue;
Content-Encoding: AxiosHeaderValue;
Content-Length: AxiosHeaderValue;
User-Agent: AxiosHeaderValue;
} & {
Content-Type: ContentType;
}>): Promise<OrganizationMembershipProps>;
};
personalAccessToken: {
create(rawData: CreatePersonalAccessTokenProps, headers?: Partial<RawAxiosHeaders & {
Accept: AxiosHeaderValue;
Authorization: AxiosHeaderValue;
Content-Encoding: AxiosHeaderValue;
Content-Length: AxiosHeaderValue;
User-Agent: AxiosHeaderValue;
} & {
Content-Type: ContentType;
}>): Promise<PersonalAccessTokenProps>;
get(params: OptionalDefaults<{
tokenId: string;
}>): Promise<PersonalAccessTokenProps>;
getMany(params: OptionalDefaults<QueryParams>): Promise<CollectionProp<PersonalAccessTokenProps>>;
revoke(params: OptionalDefaults<{
tokenId: string;
}>): Promise<PersonalAccessTokenProps>;
};
previewApiKey: {
get(params: OptionalDefaults<GetSpaceParams & {
previewApiKeyId: string;
}>): Promise<PreviewApiKeyProps>;
getMany(params: OptionalDefaults<GetSpaceParams & QueryParams>): Promise<CollectionProp<PreviewApiKeyProps>>;
};
raw: {
delete<T>(url: string, config?: RawAxiosRequestConfig): Promise<T>;
get<T>(url: string, config?: RawAxiosRequestConfig): Promise<T>;
getDefaultParams(): undefined | DefaultParams;
http<T>(url: string, config?: RawAxiosRequestConfig): Promise<T>;
patch<T>(url: string, payload?: any, config?: RawAxiosRequestConfig): Promise<T>;
post<T>(url: string, payload?: any, config?: RawAxiosRequestConfig): Promise<T>;
put<T>(url: string, payload?: any, config?: RawAxiosRequestConfig): Promise<T>;
};
release: {
archive(params: OptionalDefaults<GetSpaceEnvironmentParams & {
releaseId: string;
} & {
version: number;
}>): Promise<ReleaseProps>;
create(params: OptionalDefaults<GetSpaceEnvironmentParams>, data: ReleasePayload): Promise<ReleaseProps>;
delete(params: OptionalDefaults<GetReleaseParams>): Promise<void>;
get(params: OptionalDefaults<GetReleaseParams>): Promise<ReleaseProps>;
publish(params: OptionalDefaults<GetSpaceEnvironmentParams & {
releaseId: string;
} & {
version: number;
}>): Promise<ReleaseActionProps<"publish">>;
query(params: Omit<GetSpaceEnvironmentParams, keyof DefaultParams> & Partial<Pick<GetSpaceEnvironmentParams, keyof GetSpaceEnvironmentParams>> & {
query?: ReleaseQueryOptions;
}): Promise<CursorPaginatedCollectionProp<ReleaseProps>>;
unarchive(params: OptionalDefaults<GetSpaceEnvironmentParams & {
releaseId: string;
} & {
version: number;
}>): Promise<ReleaseProps>;
unpublish(params: OptionalDefaults<GetSpaceEnvironmentParams & {
releaseId: string;
} & {
version: number;
}>): Promise<ReleaseActionProps<"unpublish">>;
update(params: OptionalDefaults<GetSpaceEnvironmentParams & {
releaseId: string;
} & {
version: number;
}>, data: ReleasePayload): Promise<ReleaseProps>;
validate(params: OptionalDefaults<GetReleaseParams>, data?: ReleaseValidatePayload): Promise<ReleaseActionProps<"validate">>;
};
releaseAction: {
get(params: Omit<GetReleaseParams, keyof DefaultParams> & Partial<Pick<GetReleaseParams, keyof GetSpaceEnvironmentParams>> & {
actionId: string;
}): Promise<ReleaseActionProps<any>>;
getMany(params: Omit<GetSpaceEnvironmentParams, keyof DefaultParams> & Partial<Pick<GetSpaceEnvironmentParams, keyof GetSpaceEnvironmentParams>> & {
query?: ReleaseActionQueryOptions;
}): Promise<CollectionProp<ReleaseActionProps<any>>>;
queryForRelease(params: Omit<GetReleaseParams, keyof DefaultParams> & Partial<Pick<GetReleaseParams, keyof GetSpaceEnvironmentParams>> & {
query?: ReleaseActionQueryOptions;
}): Promise<CollectionProp<ReleaseActionProps<any>>>;
};
resource: ResourcePlainAPI;
resourceProvider: ResourceProviderPlainClientAPI;
resourceType: ResourceTypePlainClientAPI;
role: RolePlainClientAPI;
scheduledActions: {
create(params: OptionalDefaults<GetSpaceParams>, data: CreateUpdateScheduledActionProps): Promise<ScheduledActionProps>;
delete(params: OptionalDefaults<GetSpaceEnvironmentParams & {
scheduledActionId: string;
}>): Promise<ScheduledActionProps>;
get(params: Omit<GetSpaceParams, keyof DefaultParams> & Partial<Pick<GetSpaceParams, "spaceId">> & {
environmentId: string;
scheduledActionId: string;
}): Promise<ScheduledActionProps>;
getMany(params: OptionalDefaults<GetSpaceParams & QueryParams>): Promise<CursorPaginatedCollectionProp<ScheduledActionProps>>;
update(params: OptionalDefaults<GetSpaceParams & {
scheduledActionId: string;
version: number;
}>, data: CreateUpdateScheduledActionProps): Promise<ScheduledActionProps>;
};
snapshot: {
getForContentType(params: OptionalDefaults<GetSpaceEnvironmentParams & {
contentTypeId: string;
} & {
snapshotId: string;
}>): Promise<SnapshotProps<ContentTypeProps>>;
getForEntry<T>(params: OptionalDefaults<GetSpaceEnvironmentParams & {
entryId: string;
} & {
snapshotId: string;
}>): Promise<SnapshotProps<Omit<EntryProps<T>, "metadata">>>;
getManyForContentType(params: OptionalDefaults<GetSpaceEnvironmentParams & {
contentTypeId: string;
} & QueryParams>): Promise<CollectionProp<SnapshotProps<ContentTypeProps>>>;
getManyForEntry<T>(params: OptionalDefaults<GetSpaceEnvironmentParams & {
entryId: string;
} & QueryParams>): Promise<CollectionProp<SnapshotProps<Omit<EntryProps<T>, "metadata">>>>;
};
space: SpacePlainClientAPI;
spaceMember: SpaceMemberPlainClientAPI;
spaceMembership: SpaceMembershipPlainClientAPI;
tag: TagPlainClientAPI;
task: TaskPlainClientAPI;
team: TeamPlainClientAPI;
teamMembership: TeamMembershipPlainClientAPI;
teamSpaceMembership: TeamSpaceMembershipPlainClientAPI;
uiConfig: UIConfigPlainClientAPI;
upload: UploadPlainClientAPI;
uploadCredential: UploadCredentialAPI;
usage: UsagePlainClientAPI;
user: UserPlainClientAPI;
userUIConfig: UserUIConfigPlainClientAPI;
webhook: WebhookPlainClientAPI;
workflow: WorkflowPlainClientAPI;
workflowDefinition: WorkflowDefinitionPlainClientAPI;
workflowsChangelog: WorkflowsChangelogPlainClientAPI;
}
accessToken: {
createPersonalAccessToken(rawData: CreatePATProps, headers?: Partial<RawAxiosHeaders & {
Accept: AxiosHeaderValue;
Authorization: AxiosHeaderValue;
Content-Encoding: AxiosHeaderValue;
Content-Length: AxiosHeaderValue;
User-Agent: AxiosHeaderValue;
} & {
Content-Type: ContentType;
}>): Promise<AccessTokenProp>;
get(params: OptionalDefaults<{
tokenId: string;
}>): Promise<AccessTokenProp>;
getMany(params: OptionalDefaults<QueryParams>): Promise<CollectionProp<AccessTokenProp>>;
getManyForOrganization(params: OptionalDefaults<GetOrganizationParams & QueryParams>): Promise<CollectionProp<AccessTokenProp>>;
revoke(params: OptionalDefaults<{
tokenId: string;
}>): Promise<AccessTokenProp>;
};
apiKey: {
create(params: OptionalDefaults<GetSpaceParams>, data: CreateApiKeyProps, headers?: Partial<RawAxiosHeaders & {
Accept: AxiosHeaderValue;
Authorization: AxiosHeaderValue;
Content-Encoding: AxiosHeaderValue;
Content-Length: AxiosHeaderValue;
User-Agent: AxiosHeaderValue;
} & {
Content-Type: ContentType;
}>): Promise<ApiKeyProps>;
createWithId(params: OptionalDefaults<GetSpaceParams & {
apiKeyId: string;
}>, data: CreateApiKeyProps, headers?: Partial<RawAxiosHeaders & {
Accept: AxiosHeaderValue;
Authorization: AxiosHeaderValue;
Content-Encoding: AxiosHeaderValue;
Content-Length: AxiosHeaderValue;
User-Agent: AxiosHeaderValue;
} & {
Content-Type: ContentType;
}>): Promise<ApiKeyProps>;
delete(params: OptionalDefaults<GetSpaceParams & {
apiKeyId: string;
}>): Promise<any>;
get(params: OptionalDefaults<GetSpaceParams & {
apiKeyId: string;
}>): Promise<ApiKeyProps>;
getMany(params: OptionalDefaults<GetSpaceParams & QueryParams>): Promise<CollectionProp<ApiKeyProps>>;
update(params: OptionalDefaults<GetSpaceParams & {
apiKeyId: string;
}>, rawData: ApiKeyProps, headers?: Partial<RawAxiosHeaders & {
Accept: AxiosHeaderValue;
Authorization: AxiosHeaderValue;
Content-Encoding: AxiosHeaderValue;
Content-Length: AxiosHeaderValue;
User-Agent: AxiosHeaderValue;
} & {
Content-Type: ContentType;
}>): Promise<ApiKeyProps>;
};
appAccessToken: AppAccessTokenPlainClientAPI;
appAction: AppActionPlainClientAPI;
appActionCall: AppActionCallPlainClientAPI;
appBundle: AppBundlePlainClientAPI;
appDefinition: AppDefinitionPlainClientAPI;
appDetails: AppDetailsPlainClientAPI;
appEventSubscription: AppEventSubscriptionPlainClientAPI;
appInstallation: AppInstallationPlainClientAPI;
appKey: AppKeyPlainClientAPI;
appSignedRequest: AppSignedRequestPlainClientAPI;
appSigningSecret: AppSigningSecretPlainClientAPI;
appUpload: AppUploadPlainClientAPI;
asset: {
archive(params: OptionalDefaults<GetSpaceEnvironmentParams & {
assetId: string;
}>): Promise<AssetProps>;
create(params: OptionalDefaults<GetSpaceEnvironmentParams>, rawData: CreateAssetProps): Promise<AssetProps>;
createFromFiles(params: OptionalDefaults<GetSpaceEnvironmentParams>, data: Omit<AssetFileProp, "sys">): Promise<AssetProps>;
createWithId(params: OptionalDefaults<GetSpaceEnvironmentParams & {
assetId: string;
}>, rawData: CreateAssetProps): Promise<AssetProps>;
delete(params: OptionalDefaults<GetSpaceEnvironmentParams & {
assetId: string;
}>): Promise<any>;
get(params: OptionalDefaults<GetSpaceEnvironmentParams & {
assetId: string;
} & QueryParams>, rawData?: unknown, headers?: Partial<RawAxiosHeaders & {
Accept: AxiosHeaderValue;
Authorization: AxiosHeaderValue;
Content-Encoding: AxiosHeaderValue;
Content-Length: AxiosHeaderValue;
User-Agent: AxiosHeaderValue;
} & {
Content-Type: ContentType;
}>): Promise<AssetProps>;
getMany(params: OptionalDefaults<GetSpaceEnvironmentParams & QueryParams>, rawData?: unknown, headers?: Partial<RawAxiosHeaders & {
Accept: AxiosHeaderValue;
Authorization: AxiosHeaderValue;
Content-Encoding: AxiosHeaderValue;
Content-Length: AxiosHeaderValue;
User-Agent: AxiosHeaderValue;
} & {
Content-Type: ContentType;
}>): Promise<CollectionProp<AssetProps>>;
getPublished(params: OptionalDefaults<GetSpaceEnvironmentParams & QueryParams>, rawData?: unknown, headers?: Partial<RawAxiosHeaders & {
Accept: AxiosHeaderValue;
Authorization: AxiosHeaderValue;
Content-Encoding: AxiosHeaderValue;
Content-Length: AxiosHeaderValue;
User-Agent: AxiosHeaderValue;
} & {
Content-Type: ContentType;
}>): Promise<CollectionProp<AssetProps>>;
processForAllLocales(params: OptionalDefaults<GetSpaceEnvironmentParams>, asset: AssetProps, processingOptions?: AssetProcessingForLocale): Promise<AssetProps>;
processForLocale(params: OptionalDefaults<GetSpaceEnvironmentParams>, asset: AssetProps, locale: string, processingOptions?: AssetProcessingForLocale): Promise<AssetProps>;
publish(params: OptionalDefaults<GetSpaceEnvironmentParams & {
assetId: string;
}>, rawData: AssetProps): Promise<AssetProps>;
unarchive(params: OptionalDefaults<GetSpaceEnvironmentParams & {
assetId: string;
}>): Promise<AssetProps>;
unpublish(params: OptionalDefaults<GetSpaceEnvironmentParams & {
assetId: string;
}>): Promise<AssetProps>;
update(params: OptionalDefaults<GetSpaceEnvironmentParams & {
assetId: string;
}>, rawData: AssetProps, headers?: Partial<RawAxiosHeaders & {
Accept: AxiosHeaderValue;
Authorization: AxiosHeaderValue;
Content-Encoding: AxiosHeaderValue;
Content-Length: AxiosHeaderValue;
User-Agent: AxiosHeaderValue;
} & {
Content-Type: ContentType;
}>): Promise<AssetProps>;
};
assetKey: {
create(params: OptionalDefaults<GetSpaceEnvironmentParams>, data: CreateAssetKeyProps): Promise<AssetKeyProps>;
};
bulkAction: {
get<T>(params: GetBulkActionParams): Promise<BulkActionProps<T>>;
publish(params: GetSpaceEnvironmentParams, payload: BulkActionPublishPayload): Promise<BulkActionProps<BulkActionPublishPayload>>;
unpublish(params: GetSpaceEnvironmentParams, payload: BulkActionUnpublishPayload): Promise<BulkActionProps<BulkActionUnpublishPayload>>;
validate(params: GetSpaceEnvironmentParams, payload: BulkActionValidatePayload): Promise<BulkActionProps<BulkActionValidatePayload>>;
};
comment: CommentPlainClientAPI;
concept: ConceptPlainClientAPI;
conceptScheme: ConceptSchemePlainClientAPI;
contentType: {
create(params: OptionalDefaults<GetSpaceEnvironmentParams>, rawData: {
description?: string;
displayField?: string;
fields: ContentFields[];
metadata?: ContentTypeMetadata;
name: string;
}): Promise<ContentTypeProps>;
createWithId(params: OptionalDefaults<GetSpaceEnvironmentParams & {
contentTypeId: string;
}>, rawData: {
description?: string;
displayField?: string;
fields: ContentFields[];
metadata?: ContentTypeMetadata;
name: string;
}): Promise<ContentTypeProps>;
delete(params: OptionalDefaults<GetContentTypeParams>): Promise<any>;
get(params: OptionalDefaults<GetSpaceEnvironmentParams & {
contentTypeId: string;
} & QueryParams>): Promise<ContentTypeProps>;
getMany(params: OptionalDefaults<GetSpaceEnvironmentParams & QueryParams>): Promise<CollectionProp<ContentTypeProps>>;
omitAndDeleteField(params: OptionalDefaults<GetContentTypeParams>, contentType: ContentTypeProps, fieldId: string): Promise<ContentTypeProps>;
publish(params: OptionalDefaults<GetContentTypeParams>, rawData: ContentTypeProps): Promise<ContentTypeProps>;
unpublish(params: OptionalDefaults<GetContentTypeParams>): Promise<ContentTypeProps>;
update(params: OptionalDefaults<GetContentTypeParams>, rawData: ContentTypeProps, headers?: Partial<RawAxiosHeaders & {
Accept: AxiosHeaderValue;
Authorization: AxiosHeaderValue;
Content-Encoding: AxiosHeaderValue;
Content-Length: AxiosHeaderValue;
User-Agent: AxiosHeaderValue;
} & {
Content-Type: ContentType;
}>): Promise<ContentTypeProps>;
};
editorInterface: EditorInterfacePlainClientAPI;
entry: {
archive<T>(params: OptionalDefaults<GetSpaceEnvironmentParams & {
entryId: string;
}>): Promise<EntryProps<T>>;
create<T>(params: OptionalDefaults<GetSpaceEnvironmentParams & {
contentTypeId: string;
}>, rawData: CreateEntryProps<T>): Promise<EntryProps<T>>;
createWithId<T>(params: OptionalDefaults<GetSpaceEnvironmentParams & {
contentTypeId: string;
entryId: string;
}>, rawData: CreateEntryProps<T>): Promise<EntryProps<T>>;
delete(params: OptionalDefaults<GetSpaceEnvironmentParams & {
entryId: string;
}>): Promise<any>;
get<T>(params: OptionalDefaults<GetSpaceEnvironmentParams & {
entryId: string;
}>, rawData?: unknown, headers?: Partial<RawAxiosHeaders & {
Accept: AxiosHeaderValue;
Authorization: AxiosHeaderValue;
Content-Encoding: AxiosHeaderValue;
Content-Length: AxiosHeaderValue;
User-Agent: AxiosHeaderValue;
} & {
Content-Type: ContentType;
}>): Promise<EntryProps<T>>;
getMany<T>(params: OptionalDefaults<GetSpaceEnvironmentParams & QueryParams>, rawData?: unknown, headers?: Partial<RawAxiosHeaders & {
Accept: AxiosHeaderValue;
Authorization: AxiosHeaderValue;
Content-Encoding: AxiosHeaderValue;
Content-Length: AxiosHeaderValue;
User-Agent: AxiosHeaderValue;
} & {
Content-Type: ContentType;
}>): Promise<CollectionProp<EntryProps<T>>>;
getPublished<T>(params: OptionalDefaults<GetSpaceEnvironmentParams & QueryParams>, rawData?: unknown, headers?: Partial<RawAxiosHeaders & {
Accept: AxiosHeaderValue;
Authorization: AxiosHeaderValue;
Content-Encoding: AxiosHeaderValue;
Content-Length: AxiosHeaderValue;
User-Agent: AxiosHeaderValue;
} & {
Content-Type: ContentType;
}>): Promise<CollectionProp<EntryProps<T>>>;
patch<T>(params: OptionalDefaults<GetSpaceEnvironmentParams & {
entryId: string;
}>, rawData: OpPatch[], headers?: Partial<RawAxiosHeaders & {
Accept: AxiosHeaderValue;
Authorization: AxiosHeaderValue;
Content-Encoding: AxiosHeaderValue;
Content-Length: AxiosHeaderValue;
User-Agent: AxiosHeaderValue;
} & {
Content-Type: ContentType;
}>): Promise<EntryProps<T>>;
publish<T>(params: OptionalDefaults<GetSpaceEnvironmentParams & {
entryId: string;
}>, rawData: EntryProps<T>): Promise<EntryProps<T>>;
references(params: OptionalDefaults<GetSpaceEnvironmentParams & {
entryId: string;
include?: number;
}>): Promise<EntryReferenceProps>;
unarchive<T>(params: OptionalDefaults<GetSpaceEnvironmentParams & {
entryId: string;
}>): Promise<EntryProps<T>>;
unpublish<T>(params: OptionalDefaults<GetSpaceEnvironmentParams & {
entryId: string;
}>): Promise<EntryProps<T>>;
update<T>(params: OptionalDefaults<GetSpaceEnvironmentParams & {
entryId: string;
}>, rawData: EntryProps<T>, headers?: Partial<RawAxiosHeaders & {
Accept: AxiosHeaderValue;
Authorization: AxiosHeaderValue;
Content-Encoding: AxiosHeaderValue;
Content-Length: AxiosHeaderValue;
User-Agent: AxiosHeaderValue;
} & {
Content-Type: ContentType;
}>): Promise<EntryProps<T>>;
};
environment: EnvironmentPlainClientAPI;
environmentAlias: EnvironmentAliasPlainClientAPI;
environmentTemplate: {
create(params: GetOrganizationParams, rawData: CreateEnvironmentTemplateProps, headers?: Partial<RawAxiosHeaders & {
Accept: AxiosHeaderValue;
Authorization: AxiosHeaderValue;
Content-Encoding: AxiosHeaderValue;
Content-Length: AxiosHeaderValue;
User-Agent: AxiosHeaderValue;
} & {
Content-Type: ContentType;
}>): Promise<EnvironmentTemplateProps>;
delete(params: GetEnvironmentTemplateParams, headers?: Partial<RawAxiosHeaders & {
Accept: AxiosHeaderValue;
Authorization: AxiosHeaderValue;
Content-Encoding: AxiosHeaderValue;
Content-Length: AxiosHeaderValue;
User-Agent: AxiosHeaderValue;
} & {
Content-Type: ContentType;
}>): Promise<void>;
disconnect(params: EnvironmentTemplateParams, headers?: Partial<RawAxiosHeaders & {
Accept: AxiosHeaderValue;
Authorization: AxiosHeaderValue;
Content-Encoding: AxiosHeaderValue;
Content-Length: AxiosHeaderValue;
User-Agent: AxiosHeaderValue;
} & {
Content-Type: ContentType;
}>): Promise<void>;
get(params: GetOrganizationParams & {
environmentTemplateId: string;
} & {
query?: {
select?: string;
};
version?: number;
}, headers?: Partial<RawAxiosHeaders & {
Accept: AxiosHeaderValue;
Authorization: AxiosHeaderValue;
Content-Encoding: AxiosHeaderValue;
Content-Length: AxiosHeaderValue;
User-Agent: AxiosHeaderValue;
} & {
Content-Type: ContentType;
}>): Promise<EnvironmentTemplateProps>;
getMany(params: GetOrganizationParams & {
query?: BasicCursorPaginationOptions & {
select?: string;
};
}, headers?: Partial<RawAxiosHeaders & {
Accept: AxiosHeaderValue;
Authorization: AxiosHeaderValue;
Content-Encoding: AxiosHeaderValue;
Content-Length: AxiosHeaderValue;
User-Agent: AxiosHeaderValue;
} & {
Content-Type: ContentType;
}>): Promise<CursorPaginatedCollectionProp<EnvironmentTemplateProps>>;
install(params: EnvironmentTemplateParams, rawData: CreateEnvironmentTemplateInstallationProps, headers?: Partial<RawAxiosHeaders & {
Accept: AxiosHeaderValue;
Authorization: AxiosHeaderValue;
Content-Encoding: AxiosHeaderValue;
Content-Length: AxiosHeaderValue;
User-Agent: AxiosHeaderValue;
} & {
Content-Type: ContentType;
}>): Promise<EnvironmentTemplateInstallationProps>;
update(params: GetEnvironmentTemplateParams, rawData: EnvironmentTemplateProps, headers?: Partial<RawAxiosHeaders & {
Accept: AxiosHeaderValue;
Authorization: AxiosHeaderValue;
Content-Encoding: AxiosHeaderValue;
Content-Length: AxiosHeaderValue;
User-Agent: AxiosHeaderValue;
} & {
Content-Type: ContentType;
}>): Promise<EnvironmentTemplateProps>;
validate(params: EnvironmentTemplateParams & {
version?: number;
}, rawData: ValidateEnvironmentTemplateInstallationProps, headers?: Partial<RawAxiosHeaders & {
Accept: AxiosHeaderValue;
Authorization: AxiosHeaderValue;
Content-Encoding: AxiosHeaderValue;
Content-Length: AxiosHeaderValue;
User-Agent: AxiosHeaderValue;
} & {
Content-Type: ContentType;
}>): Promise<EnvironmentTemplateValidationProps>;
versions(params: GetOrganizationParams & {
environmentTemplateId: string;
} & {
query?: BasicCursorPaginationOptions & {
select?: string;
};
}, headers?: Partial<RawAxiosHeaders & {
Accept: AxiosHeaderValue;
Authorization: AxiosHeaderValue;
Content-Encoding: AxiosHeaderValue;
Content-Length: AxiosHeaderValue;
User-Agent: AxiosHeaderValue;
} & {
Content-Type: ContentType;
}>): Promise<CursorPaginatedCollectionProp<EnvironmentTemplateProps>>;
versionUpdate(params: GetOrganizationParams & {
environmentTemplateId: string;
} & {
version: number;
}, rawData: {
versionDescription?: string;
versionName?: string;
}, headers?: Partial<RawAxiosHeaders & {
Accept: AxiosHeaderValue;
Authorization: AxiosHeaderValue;
Content-Encoding: AxiosHeaderValue;
Content-Length: AxiosHeaderValue;
User-Agent: AxiosHeaderValue;
} & {
Content-Type: ContentType;
}>): Promise<EnvironmentTemplateProps>;
};
environmentTemplateInstallation: {
getForEnvironment(params: BasicCursorPaginationOptions & EnvironmentTemplateParams & {
installationId?: string;
}, headers?: Partial<RawAxiosHeaders & {
Accept: AxiosHeaderValue;
Authorization: AxiosHeaderValue;
Content-Encoding: AxiosHeaderValue;
Content-Length: AxiosHeaderValue;
User-Agent: AxiosHeaderValue;
} & {
Content-Type: ContentType;
}>): Promise<CursorPaginatedCollectionProp<EnvironmentTemplateInstallationProps>>;
getMany(params: BasicCursorPaginationOptions & {
environmentId?: string;
environmentTemplateId: string;
organizationId: string;
spaceId?: string;
}, headers?: Partial<RawAxiosHeaders & {
Accept: AxiosHeaderValue;
Authorization: AxiosHeaderValue;
Content-Encoding: AxiosHeaderValue;
Content-Length: AxiosHeaderValue;
User-Agent: AxiosHeaderValue;
} & {
Content-Type: ContentType;
}>): Promise<CursorPaginatedCollectionProp<EnvironmentTemplateInstallationProps>>;
};
extension: ExtensionPlainClientAPI;
function: {
getMany(params: OptionalDefaults<GetOrganizationParams & {
appDefinitionId: string;
} & QueryParams>): Promise<CollectionProp<FunctionProps>>;
};
locale: LocalePlainClientAPI;
organization: OrganizationPlainClientAPI;
organizationInvitation: {
create(params: OptionalDefaults<{
organizationId: string;
}>, data: CreateOrganizationInvitationProps, headers?: Partial<RawAxiosHeaders & {
Accept: AxiosHeaderValue;
Authorization: AxiosHeaderValue;
Content-Encoding: AxiosHeaderValue;
Content-Length: AxiosHeaderValue;
User-Agent: AxiosHeaderValue;
} & {
Content-Type: ContentType;
}>): Promise<OrganizationInvitationProps>;
get(params: OptionalDefaults<{
invitationId: string;
organizationId: string;
}>, headers?: Partial<RawAxiosHeaders & {
Accept: AxiosHeaderValue;
Authorization: AxiosHeaderValue;
Content-Encoding: AxiosHeaderValue;
Content-Length: AxiosHeaderValue;
User-Agent: AxiosHeaderValue;
} & {
Content-Type: ContentType;
}>): Promise<OrganizationInvitationProps>;
};
organizationMembership: {
delete(params: OptionalDefaults<GetOrganizationMembershipParams>): Promise<any>;
get(params: OptionalDefaults<GetOrganizationMembershipParams>): Promise<OrganizationMembershipProps>;
getMany(params: OptionalDefaults<GetOrganizationParams & QueryParams>): Promise<CollectionProp<OrganizationMembershipProps>>;
update(params: OptionalDefaults<GetOrganizationMembershipParams>, rawData: OrganizationMembershipProps, headers?: Partial<RawAxiosHeaders & {
Accept: AxiosHeaderValue;
Authorization: AxiosHeaderValue;
Content-Encoding: AxiosHeaderValue;
Content-Length: AxiosHeaderValue;
User-Agent: AxiosHeaderValue;
} & {
Content-Type: ContentType;
}>): Promise<OrganizationMembershipProps>;
};
personalAccessToken: {
create(rawData: CreatePersonalAccessTokenProps, headers?: Partial<RawAxiosHeaders & {
Accept: AxiosHeaderValue;
Authorization: AxiosHeaderValue;
Content-Encoding: AxiosHeaderValue;
Content-Length: AxiosHeaderValue;
User-Agent: AxiosHeaderValue;
} & {
Content-Type: ContentType;
}>): Promise<PersonalAccessTokenProps>;
get(params: OptionalDefaults<{
tokenId: string;
}>): Promise<PersonalAccessTokenProps>;
getMany(params: OptionalDefaults<QueryParams>): Promise<CollectionProp<PersonalAccessTokenProps>>;
revoke(params: OptionalDefaults<{
tokenId: string;
}>): Promise<PersonalAccessTokenProps>;
};
previewApiKey: {
get(params: OptionalDefaults<GetSpaceParams & {
previewApiKeyId: string;
}>): Promise<PreviewApiKeyProps>;
getMany(params: OptionalDefaults<GetSpaceParams & QueryParams>): Promise<CollectionProp<PreviewApiKeyProps>>;
};
raw: {
delete<T>(url: string, config?: RawAxiosRequestConfig): Promise<T>;
get<T>(url: string, config?: RawAxiosRequestConfig): Promise<T>;
getDefaultParams(): undefined | DefaultParams;
http<T>(url: string, config?: RawAxiosRequestConfig): Promise<T>;
patch<T>(url: string, payload?: any, config?: RawAxiosRequestConfig): Promise<T>;
post<T>(url: string, payload?: any, config?: RawAxiosRequestConfig): Promise<T>;
put<T>(url: string, payload?: any, config?: RawAxiosRequestConfig): Promise<T>;
};
release: {
archive(params: OptionalDefaults<GetSpaceEnvironmentParams & {
releaseId: string;
} & {
version: number;
}>): Promise<ReleaseProps>;
create(params: OptionalDefaults<GetSpaceEnvironmentParams>, data: ReleasePayload): Promise<ReleaseProps>;
delete(params: OptionalDefaults<GetReleaseParams>): Promise<void>;
get(params: OptionalDefaults<GetReleaseParams>): Promise<ReleaseProps>;
publish(params: OptionalDefaults<GetSpaceEnvironmentParams & {
releaseId: string;
} & {
version: number;
}>): Promise<ReleaseActionProps<"publish">>;
query(params: Omit<GetSpaceEnvironmentParams, keyof DefaultParams> & Partial<Pick<GetSpaceEnvironmentParams, keyof GetSpaceEnvironmentParams>> & {
query?: ReleaseQueryOptions;
}): Promise<CursorPaginatedCollectionProp<ReleaseProps>>;
unarchive(params: OptionalDefaults<GetSpaceEnvironmentParams & {
releaseId: string;
} & {
version: number;
}>): Promise<ReleaseProps>;
unpublish(params: OptionalDefaults<GetSpaceEnvironmentParams & {
releaseId: string;
} & {
version: number;
}>): Promise<ReleaseActionProps<"unpublish">>;
update(params: OptionalDefaults<GetSpaceEnvironmentParams & {
releaseId: string;
} & {
version: number;
}>, data: ReleasePayload): Promise<ReleaseProps>;
validate(params: OptionalDefaults<GetReleaseParams>, data?: ReleaseValidatePayload): Promise<ReleaseActionProps<"validate">>;
};
releaseAction: {
get(params: Omit<GetReleaseParams, keyof DefaultParams> & Partial<Pick<GetReleaseParams, keyof GetSpaceEnvironmentParams>> & {
actionId: string;
}): Promise<ReleaseActionProps<any>>;
getMany(params: Omit<GetSpaceEnvironmentParams, keyof DefaultParams> & Partial<Pick<GetSpaceEnvironmentParams, keyof GetSpaceEnvironmentParams>> & {
query?: ReleaseActionQueryOptions;
}): Promise<CollectionProp<ReleaseActionProps<any>>>;
queryForRelease(params: Omit<GetReleaseParams, keyof DefaultParams> & Partial<Pick<GetReleaseParams, keyof GetSpaceEnvironmentParams>> & {
query?: ReleaseActionQueryOptions;
}): Promise<CollectionProp<ReleaseActionProps<any>>>;
};
resource: ResourcePlainAPI;
resourceProvider: ResourceProviderPlainClientAPI;
resourceType: ResourceTypePlainClientAPI;
role: RolePlainClientAPI;
scheduledActions: {
create(params: OptionalDefaults<GetSpaceParams>, data: CreateUpdateScheduledActionProps): Promise<ScheduledActionProps>;
delete(params: OptionalDefaults<GetSpaceEnvironmentParams & {
scheduledActionId: string;
}>): Promise<ScheduledActionProps>;
get(params: Omit<GetSpaceParams, keyof DefaultParams> & Partial<Pick<GetSpaceParams, "spaceId">> & {
environmentId: string;
scheduledActionId: string;
}): Promise<ScheduledActionProps>;
getMany(params: OptionalDefaults<GetSpaceParams & QueryParams>): Promise<CursorPaginatedCollectionProp<ScheduledActionProps>>;
update(params: OptionalDefaults<GetSpaceParams & {
scheduledActionId: string;
version: number;
}>, data: CreateUpdateScheduledActionProps): Promise<ScheduledActionProps>;
};
snapshot: {
getForContentType(params: OptionalDefaults<GetSpaceEnvironmentParams & {
contentTypeId: string;
} & {
snapshotId: string;
}>): Promise<SnapshotProps<ContentTypeProps>>;
getForEntry<T>(params: OptionalDefaults<GetSpaceEnvironmentParams & {
entryId: string;
} & {
snapshotId: string;
}>): Promise<SnapshotProps<Omit<EntryProps<T>, "metadata">>>;
getManyForContentType(params: OptionalDefaults<GetSpaceEnvironmentParams & {
contentTypeId: string;
} & QueryParams>): Promise<CollectionProp<SnapshotProps<ContentTypeProps>>>;
getManyForEntry<T>(params: OptionalDefaults<GetSpaceEnvironmentParams & {
entryId: string;
} & QueryParams>): Promise<CollectionProp<SnapshotProps<Omit<EntryProps<T>, "metadata">>>>;
};
space: SpacePlainClientAPI;
spaceMember: SpaceMemberPlainClientAPI;
spaceMembership: SpaceMembershipPlainClientAPI;
tag: TagPlainClientAPI;
task: TaskPlainClientAPI;
team: TeamPlainClientAPI;
teamMembership: TeamMembershipPlainClientAPI;
teamSpaceMembership: TeamSpaceMembershipPlainClientAPI;
uiConfig: UIConfigPlainClientAPI;
upload: UploadPlainClientAPI;
uploadCredential: UploadCredentialAPI;
usage: UsagePlainClientAPI;
user: UserPlainClientAPI;
userUIConfig: UserUIConfigPlainClientAPI;
webhook: WebhookPlainClientAPI;
workflow: WorkflowPlainClientAPI;
workflowDefinition: WorkflowDefinitionPlainClientAPI;
workflowsChangelog: WorkflowsChangelogPlainClientAPI;
}
Type Alias PlainClientDefaultParams
Plain
Type Alias PreviewApiKeyProps
Type Alias QueryParams
Type Alias ReleaseActionSysProps
Release
createdAt: ISO8601Timestamp;
createdBy: Link<"User">;
environment: Link<"Environment">;
id: string;
release: Link<"Release">;
space: Link<"Space">;
status: ReleaseActionStatuses;
type: "ReleaseAction";
updatedAt: ISO8601Timestamp;
updatedBy: Link<"User">;
}
createdAt: ISO8601Timestamp;
createdBy: Link<"User">;
environment: Link<"Environment">;
id: string;
release: Link<"Release">;
space: Link<"Space">;
status: ReleaseActionStatuses;
type: "ReleaseAction";
updatedAt: ISO8601Timestamp;
updatedBy: Link<"User">;
}
Type Alias ReleaseActionTypes
Release
Type Alias ReleaseMetadata
Release
withReferences: {
entity: Link<"Entry">;
filter: Record<ReleaseReferenceFilters, string[]>;
}[];
}
withReferences: {
entity: Link<"Entry">;
filter: Record<ReleaseReferenceFilters, string[]>;
}[];
}
Type Alias ReleaseReferenceFilters
Type Alias ReleaseSysProps
Release
archivedAt?: ISO8601Timestamp;
archivedBy?: Link<"User">;
createdAt: ISO8601Timestamp;
createdBy: Link<"User"> | Link<"AppDefinition">;
environment: Link<"Environment">;
id: string;
lastAction?: Link<"ReleaseAction">;
space: Link<"Space">;
status: ReleaseStatus;
type: "Release";
updatedAt: ISO8601Timestamp;
updatedBy: Link<"User"> | Link<"AppDefinition">;
version: number;
}
archivedAt?: ISO8601Timestamp;
archivedBy?: Link<"User">;
createdAt: ISO8601Timestamp;
createdBy: Link<"User"> | Link<"AppDefinition">;
environment: Link<"Environment">;
id: string;
lastAction?: Link<"ReleaseAction">;
space: Link<"Space">;
status: ReleaseStatus;
type: "Release";
updatedAt: ISO8601Timestamp;
updatedBy: Link<"User"> | Link<"AppDefinition">;
version: number;
}
Type Alias ResourceProps
Resource
fields: {
badge?: {
label: string;
variant:
| "primary"
| "negative"
| "positive"
| "warning"
| "secondary";
};
description?: string;
externalUrl?: string;
image?: {
altText?: string;
url: string;
};
subtitle?: string;
title: string;
};
sys: {
appDefinition: SysLink;
resourceProvider: SysLink;
resourceType: SysLink;
type: "Resource";
urn: string;
};
}
fields: {
badge?: {
label: string;
variant:
| "primary"
| "negative"
| "positive"
| "warning"
| "secondary";
};
description?: string;
externalUrl?: string;
image?: {
altText?: string;
url: string;
};
subtitle?: string;
title: string;
};
sys: {
appDefinition: SysLink;
resourceProvider: SysLink;
resourceType: SysLink;
type: "Resource";
urn: string;
};
}
Type Alias ResourceProviderProps
Resource
function: SysLink;
sys: Omit<BasicMetaSysProps, "version"> & {
appDefinition: SysLink;
organization: SysLink;
};
type: "function";
}
function: SysLink;
sys: Omit<BasicMetaSysProps, "version"> & {
appDefinition: SysLink;
organization: SysLink;
};
type: "function";
}
Type declaration
function: SysLink
Link to a Contentful function
+sys: Omit<BasicMetaSysProps, "version"> & {
appDefinition: SysLink;
organization: SysLink;
}System metadata
+type: "function"
Resource Provider type, value is 'function'
+
Type Alias ResourceQueryOptions
Resource
Type Alias ResourceTypeProps
Resource
defaultFieldMapping: {
badge?: {
label: string;
variant: string;
};
description?: string;
externalUrl?: string;
image?: {
altText?: string;
url: string;
};
subtitle?: string;
title: string;
};
name: string;
sys: Omit<BasicMetaSysProps, "version"> & {
appDefinition: SysLink;
organization: SysLink;
resourceProvider: SysLink;
};
}
defaultFieldMapping: {
badge?: {
label: string;
variant: string;
};
description?: string;
externalUrl?: string;
image?: {
altText?: string;
url: string;
};
subtitle?: string;
title: string;
};
name: string;
sys: Omit<BasicMetaSysProps, "version"> & {
appDefinition: SysLink;
organization: SysLink;
resourceProvider: SysLink;
};
}
Type declaration
default
Field Mapping: {
badge?: {
label: string;
variant: string;
};
description?: string;
externalUrl?: string;
image?: {
altText?: string;
url: string;
};
subtitle?: string;
title: string;
}Resource Type defaultFieldMapping
+Optionalbadge?: {
label: string;
variant: string;
}label: string
variant: string
Optionaldescription?: stringOptionalexternalUrl?: string Optionalimage?: {
altText?: string;
url: string;
}OptionalaltText?: string url: string
Optionalsubtitle?: stringtitle: string
name: string
Resource Type name
+sys: Omit<BasicMetaSysProps, "version"> & {
appDefinition: SysLink;
organization: SysLink;
resourceProvider: SysLink;
}System metadata
+
Type Alias RichTextCommentProps
Type Alias RoleProps
Role
description?: string;
name: string;
permissions: {
ContentDelivery: string[] | string;
ContentModel: string[];
EnvironmentAliases: string[] | string;
Environments: string[] | string;
Settings: string[] | string;
Tags: string[] | string;
};
policies: {
actions: ActionType[] | "all";
constraint: ConstraintType;
effect: string;
}[];
sys: BasicMetaSysProps & {
space: SysLink;
};
}
description?: string;
name: string;
permissions: {
ContentDelivery: string[] | string;
ContentModel: string[];
EnvironmentAliases: string[] | string;
Environments: string[] | string;
Settings: string[] | string;
Tags: string[] | string;
};
policies: {
actions: ActionType[] | "all";
constraint: ConstraintType;
effect: string;
}[];
sys: BasicMetaSysProps & {
space: SysLink;
};
}
Type declaration
Optionaldescription?: stringname: string
permissions: {
ContentDelivery: string[] | string;
ContentModel: string[];
EnvironmentAliases: string[] | string;
Environments: string[] | string;
Settings: string[] | string;
Tags: string[] | string;
}Permissions for application sections
+Content
Delivery: string[] | string Content
Model: string[] Environment
Aliases: string[] | string Environments: string[] | string
Settings: string[] | string
Tags: string[] | string
policies: {
actions: ActionType[] | "all";
constraint: ConstraintType;
effect: string;
}[]sys: BasicMetaSysProps & {
space: SysLink;
}
Type Alias ScheduledActionProps
Scheduled
action: SchedulableActionType;
entity: Link<SchedulableEntityType>;
environment?: {
sys: MetaLinkProps;
};
error?: ScheduledActionFailedError;
payload?: ScheduledActionPayloadProps;
scheduledFor: {
datetime: ISO8601Timestamp;
timezone?: string;
};
sys: ScheduledActionSysProps;
}
action: SchedulableActionType;
entity: Link<SchedulableEntityType>;
environment?: {
sys: MetaLinkProps;
};
error?: ScheduledActionFailedError;
payload?: ScheduledActionPayloadProps;
scheduledFor: {
datetime: ISO8601Timestamp;
timezone?: string;
};
sys: ScheduledActionSysProps;
}
Type declaration
action: SchedulableActionType
entity: Link<SchedulableEntityType>
Optionalenvironment?: {
sys: MetaLinkProps;
}sys: MetaLinkProps
Optionalerror?: ScheduledActionFailedErrorThe Contentful-style error that occurred during execution if sys.status is failed
+Optionalpayload?: ScheduledActionPayloadPropsscheduled
For: {
datetime: ISO8601Timestamp;
timezone?: string;
}datetime: ISO8601Timestamp
Optionaltimezone?: stringA valid IANA timezone Olson identifier
+
sys: ScheduledActionSysProps
Type Alias ScheduledActionSysProps
Scheduled
canceledAt?: ISO8601Timestamp;
canceledBy?: Link<"User"> | Link<"AppDefinition">;
createdAt: ISO8601Timestamp;
createdBy: Link<"User"> | Link<"AppDefinition">;
id: string;
space: SysLink;
status: ScheduledActionStatus;
type: "ScheduledAction";
updatedAt: ISO8601Timestamp;
updatedBy: Link<"User"> | Link<"AppDefinition">;
version: number;
}
canceledAt?: ISO8601Timestamp;
canceledBy?: Link<"User"> | Link<"AppDefinition">;
createdAt: ISO8601Timestamp;
createdBy: Link<"User"> | Link<"AppDefinition">;
id: string;
space: SysLink;
status: ScheduledActionStatus;
type: "ScheduledAction";
updatedAt: ISO8601Timestamp;
updatedBy: Link<"User"> | Link<"AppDefinition">;
version: number;
}
Type declaration
OptionalcanceledAt?: ISO8601Timestamp an ISO8601 date string representing when an action was moved to canceled
+OptionalcanceledBy?: Link<"User"> | Link<"AppDefinition"> created
At: ISO8601Timestamp created
By: Link<"User"> | Link<"AppDefinition"> id: string
space: SysLink
status: ScheduledActionStatus
type: "ScheduledAction"
updated
At: ISO8601Timestamp an ISO8601 date string representing when an action was updated
+updated
By: Link<"User"> | Link<"AppDefinition"> version: number
Type Alias SnapshotProps<T>
Snapshot
snapshot: T;
sys: MetaSysProps & {
snapshotEntityType: string;
snapshotType: string;
};
}
snapshot: T;
sys: MetaSysProps & {
snapshotEntityType: string;
snapshotType: string;
};
}
Type Parameters
Type Alias Space
Type Alias SpaceEnvResourceTypeProps
Space
sys: Partial<Pick<ResourceTypeProps["sys"], OptionalSysFields>> & Omit<ResourceTypeProps["sys"], OptionalSysFields>;
}
sys: Partial<Pick<ResourceTypeProps["sys"], OptionalSysFields>> & Omit<ResourceTypeProps["sys"], OptionalSysFields>;
}
Type Alias SpaceMemberProps
Type declaration
admin: boolean
User is an admin
+roles: {
sys: MetaLinkProps;
}[]Array of Role Links
+sys: MetaSysProps
Type Alias SpaceMembershipProps
Space
admin: boolean;
roles: SysLink[];
sys: MetaSysProps & {
space: SysLink;
user: SysLink;
};
user: SysLink;
}
admin: boolean;
roles: SysLink[];
sys: MetaSysProps & {
space: SysLink;
user: SysLink;
};
user: SysLink;
}
Type Alias SpaceProps
Space
name: string;
sys: BasicMetaSysProps & {
archivedAt?: string;
organization: {
sys: {
id: string;
};
};
};
}
name: string;
sys: BasicMetaSysProps & {
archivedAt?: string;
organization: {
sys: {
id: string;
};
};
};
}
Type Alias SpaceQueryParams
Type Alias TagProps
Tag
name: string;
sys: TagSysProps;
}
name: string;
sys: TagSysProps;
}
Type Alias TagVisibility
Tag
Type Alias TaskProps
Task
assignedTo: Link<"User" | "Team">;
body: string;
dueDate?: string;
status: TaskStatus;
sys: TaskSysProps;
}
assignedTo: Link<"User" | "Team">;
body: string;
dueDate?: string;
status: TaskStatus;
sys: TaskSysProps;
}
Type Alias TeamMembershipProps
Team
admin: boolean;
organizationMembershipId: string;
sys: MetaSysProps & {
organization: {
sys: MetaLinkProps;
};
organizationMembership: {
sys: MetaLinkProps;
};
team: {
sys: MetaLinkProps;
};
};
}
admin: boolean;
organizationMembershipId: string;
sys: MetaSysProps & {
organization: {
sys: MetaLinkProps;
};
organizationMembership: {
sys: MetaLinkProps;
};
team: {
sys: MetaLinkProps;
};
};
}
Type declaration
admin: boolean
Is admin
+organization
Membership Id: string Organization membership id
+sys: MetaSysProps & {
organization: {
sys: MetaLinkProps;
};
organizationMembership: {
sys: MetaLinkProps;
};
team: {
sys: MetaLinkProps;
};
}System metadata
+
Type Alias TeamProps
Team
description: string;
name: string;
sys: MetaSysProps & {
memberCount: number;
organization: {
sys: MetaLinkProps;
};
};
}
description: string;
name: string;
sys: MetaSysProps & {
memberCount: number;
organization: {
sys: MetaLinkProps;
};
};
}
Type declaration
description: string
Description of the team
+name: string
Name of the team
+sys: MetaSysProps & {
memberCount: number;
organization: {
sys: MetaLinkProps;
};
}System metadata
+
Type Alias TeamSpaceMembershipProps
Team
admin: boolean;
roles: {
sys: MetaLinkProps;
}[];
sys: MetaSysProps & {
space: {
sys: MetaLinkProps;
};
team: {
sys: MetaLinkProps;
};
};
}
admin: boolean;
roles: {
sys: MetaLinkProps;
}[];
sys: MetaSysProps & {
space: {
sys: MetaLinkProps;
};
team: {
sys: MetaLinkProps;
};
};
}
Type declaration
admin: boolean
Is admin
+roles: {
sys: MetaLinkProps;
}[]Roles
+sys: MetaSysProps & {
space: {
sys: MetaLinkProps;
};
team: {
sys: MetaLinkProps;
};
}System metadata
+
Type Alias UIConfigProps
UIConfig
assetListViews: ViewFolder[];
entryListViews: ViewFolder[];
homeViews: HomeView[];
sys: UIConfigSysProps;
}
assetListViews: ViewFolder[];
entryListViews: ViewFolder[];
homeViews: HomeView[];
sys: UIConfigSysProps;
}
Type declaration
asset
List Views: ViewFolder[] entry
List Views: ViewFolder[] home
Views: HomeView[] sys: UIConfigSysProps
System metadata
+
Type Alias UIExtensionProps
UIExtension
extension: {
fieldTypes: FieldType[];
name: string;
parameters?: {
installation?: ParameterDefinition<InstallationParameterType>[];
instance?: ParameterDefinition[];
};
sidebar?: boolean;
src?: string;
srcdoc?: string;
};
parameters?: DefinedParameters;
sys: ExtensionSysProps;
}
extension: {
fieldTypes: FieldType[];
name: string;
parameters?: {
installation?: ParameterDefinition<InstallationParameterType>[];
instance?: ParameterDefinition[];
};
sidebar?: boolean;
src?: string;
srcdoc?: string;
};
parameters?: DefinedParameters;
sys: ExtensionSysProps;
}
Type declaration
extension: {
fieldTypes: FieldType[];
name: string;
parameters?: {
installation?: ParameterDefinition<InstallationParameterType>[];
instance?: ParameterDefinition[];
};
sidebar?: boolean;
src?: string;
srcdoc?: string;
}field
Types: FieldType[] Field types where an extension can be used
+name: string
Extension name
+Optionalparameters?: {
installation?: ParameterDefinition<InstallationParameterType>[];
instance?: ParameterDefinition[];
}Parameter definitions
+Optionalinstallation?: ParameterDefinition<InstallationParameterType>[]Optionalinstance?: ParameterDefinition[]
Optionalsidebar?: booleanControls the location of the extension. If true it will be rendered on the sidebar instead of replacing the field's editing control
+Optionalsrc?: stringURL where the root HTML document of the extension can be found
+Optionalsrcdoc?: stringString representation of the extension (e.g. inline HTML code)
+
Optionalparameters?: DefinedParametersValues for installation parameters
+sys: ExtensionSysProps
Type Alias UpdateCommentProps
Type Alias UpdateConceptParams
Type Alias UpdateConceptSchemeParams
Type Alias UpdateTaskProps
Type Alias UpdateWebhookProps
Update
| "headers"
| "name"
| "topics"
| "url"
| "active">
| "headers"
| "name"
| "topics"
| "url"
| "active">
Type Alias UpdateWorkflowDefinitionParams
Type Alias UpdateWorkflowDefinitionProps
Update
steps: (CreateWorkflowStepProps | UpdateWorkflowStepProps)[];
sys: Pick<WorkflowDefinitionSysProps, "version">;
}
steps: (CreateWorkflowStepProps | UpdateWorkflowStepProps)[];
sys: Pick<WorkflowDefinitionSysProps, "version">;
}
Type Alias UpdateWorkflowProps
Type Alias UpdateWorkflowStepProps
Type Alias UploadCredentialProps
Type declaration
sys: MetaSysProps & {
environment?: SysLink;
space: SysLink;
}System metadata
+
Type Alias UploadProps
Type declaration
sys: MetaSysProps & {
environment?: SysLink;
space: SysLink;
}System metadata
+
Type Alias UpsertResourceProviderProps
Type Alias UpsertResourceTypeProps
Type Alias UpsertWebhookSigningSecretPayload
Upsert
value: string;
}
value: string;
}
Type Alias UsageProps
Usage
dateRange: {
endAt: string;
startAt: string;
};
metric: UsageMetricEnum;
sys: MetaSysProps & {
organization?: {
sys: MetaLinkProps;
};
};
unitOfMeasure: string;
usage: number;
usagePerDay: {
[key: string]: number;
};
}
dateRange: {
endAt: string;
startAt: string;
};
metric: UsageMetricEnum;
sys: MetaSysProps & {
organization?: {
sys: MetaLinkProps;
};
};
unitOfMeasure: string;
usage: number;
usagePerDay: {
[key: string]: number;
};
}
Type declaration
date
Range: {
endAt: string;
startAt: string;
}Range of usage
+end
At: string start
At: string
metric: UsageMetricEnum
Type of usage
+sys: MetaSysProps & {
organization?: {
sys: MetaLinkProps;
};
}System metadata
+unit
Of Measure: string Unit of usage metric
+usage: number
Value of the usage
+usage
Per Day: {
[key: string]: number;
}Usage per day
+[key: string]: number
Type Alias UserProps
User
2faEnabled: boolean;
activated: boolean;
avatarUrl: string;
confirmed: boolean;
cookieConsentData: string;
email: string;
firstName: string;
lastName: string;
signInCount: number;
sys: BasicMetaSysProps;
}
2faEnabled: boolean;
activated: boolean;
avatarUrl: string;
confirmed: boolean;
cookieConsentData: string;
email: string;
firstName: string;
lastName: string;
signInCount: number;
sys: BasicMetaSysProps;
}
Type declaration
2fa
Enabled: boolean activated: boolean
Activation flag
+avatar
Url: string Url to the users avatar
+confirmed: boolean
User confirmation flag
+cookie
Consent Data: string email: string
Email address of the user
+first
Name: string First name of the user
+last
Name: string Last name of the user
+sign
In Count: number Number of sign ins
+sys: BasicMetaSysProps
System metadata
+
Type Alias UserUIConfigProps
UserUIConfig
assetListViews: ViewFolder[];
entryListViews: ViewFolder[];
sys: UserUIConfigSysProps;
}
assetListViews: ViewFolder[];
entryListViews: ViewFolder[];
sys: UserUIConfigSysProps;
}
Type declaration
asset
List Views: ViewFolder[] entry
List Views: ViewFolder[] sys: UserUIConfigSysProps
System metadata
+
Type Alias ValidateEnvironmentTemplateInstallationProps
Validate
Type Alias ValidationFinding
Validation
details: Record<string, unknown>;
message: string;
}
details: Record<string, unknown>;
message: string;
}
Type Alias WebhookCallRequest
Webhook
body: string;
headers: {
[key: string]: string;
};
method: string;
url: string;
}
body: string;
headers: {
[key: string]: string;
};
method: string;
url: string;
}
Type Alias WebhookFilter
Webhook
| EqualityConstraint
| InConstraint
| RegexpConstraint
| NotConstraint
| EqualityConstraint
| InConstraint
| RegexpConstraint
| NotConstraint
Type Alias WebhookProps
Webhook
active: boolean;
filters?: WebhookFilter[];
headers: WebhookHeader[];
httpBasicPassword?: string;
httpBasicUsername?: string;
name: string;
sys: BasicMetaSysProps & {
space: SysLink;
};
topics: string[];
transformation?: WebhookTransformation;
url: string;
}
active: boolean;
filters?: WebhookFilter[];
headers: WebhookHeader[];
httpBasicPassword?: string;
httpBasicUsername?: string;
name: string;
sys: BasicMetaSysProps & {
space: SysLink;
};
topics: string[];
transformation?: WebhookTransformation;
url: string;
}
Type declaration
active: boolean
Whether the Webhook is active. If set to false, no calls will be made
+Optionalfilters?: WebhookFilter[]Webhook filters
+headers: WebhookHeader[]
Headers that should be appended to the webhook request
+OptionalhttpBasic Password?: string Password for basic http auth
+OptionalhttpBasic Username?: string Username for basic http auth
+name: string
Webhook name
+sys: BasicMetaSysProps & {
space: SysLink;
}System metadata
+topics: string[]
Topics the webhook wants to subscribe to
+Optionaltransformation?: WebhookTransformationTransformation to apply
+url: string
Webhook url
+
Type Alias WebhookSigningSecretProps
Webhook
redactedValue: string;
sys: WebhookSigningSecretSys & {
space: {
sys: MetaLinkProps;
};
};
}
redactedValue: string;
sys: WebhookSigningSecretSys & {
space: {
sys: MetaLinkProps;
};
};
}
Type Alias WebhookTransformation
Webhook
body?: JsonValue;
contentType?:
| null
| "application/vnd.contentful.management.v1+json"
| "application/vnd.contentful.management.v1+json; charset=utf-8"
| "application/json"
| "application/json; charset=utf-8"
| "application/x-www-form-urlencoded"
| "application/x-www-form-urlencoded; charset=utf-8";
includeContentLength?: boolean | null;
method?:
| null
| "POST"
| "GET"
| "PUT"
| "PATCH"
| "DELETE";
}
body?: JsonValue;
contentType?:
| null
| "application/vnd.contentful.management.v1+json"
| "application/vnd.contentful.management.v1+json; charset=utf-8"
| "application/json"
| "application/json; charset=utf-8"
| "application/x-www-form-urlencoded"
| "application/x-www-form-urlencoded; charset=utf-8";
includeContentLength?: boolean | null;
method?:
| null
| "POST"
| "GET"
| "PUT"
| "PATCH"
| "DELETE";
}
diff --git a/contentful-management/11.40.3/types/WorkflowDefinitionProps.html b/contentful-management/11.40.3/types/WorkflowDefinitionProps.html
new file mode 100644
index 0000000000..f416ee8163
--- /dev/null
+++ b/contentful-management/11.40.3/types/WorkflowDefinitionProps.html
@@ -0,0 +1 @@
+
Type Alias WorkflowDefinitionProps
Workflow
appliesTo?: WorkflowDefinitionValidationLink[];
description?: string;
flowType?: "no_restriction" | "strict_neighbor";
name: string;
startOnEntityCreation?: boolean;
steps: WorkflowStepProps[];
sys: WorkflowDefinitionSysProps;
}
appliesTo?: WorkflowDefinitionValidationLink[];
description?: string;
flowType?: "no_restriction" | "strict_neighbor";
name: string;
startOnEntityCreation?: boolean;
steps: WorkflowStepProps[];
sys: WorkflowDefinitionSysProps;
}
Type Alias WorkflowDefinitionQueryOptions
Type Alias WorkflowDefinitionSysProps
Workflow
| "id"
| "version"
| "createdAt"
| "createdBy"
| "updatedAt"
| "updatedBy"> & {
environment: SysLink;
isLocked: boolean;
space: SysLink;
type: "WorkflowDefinition";
}
| "id"
| "version"
| "createdAt"
| "createdBy"
| "updatedAt"
| "updatedBy"> & {
environment: SysLink;
isLocked: boolean;
space: SysLink;
type: "WorkflowDefinition";
}
Type Alias WorkflowDefinitionValidationLink
Workflow
linkType: "Entry";
type: "Link";
validations: {
linkContentType: string[];
}[];
}
linkType: "Entry";
type: "Link";
validations: {
linkContentType: string[];
}[];
}
Type Alias WorkflowProps
Workflow
stepId?: string;
sys: WorkflowSysProps;
}
stepId?: string;
sys: WorkflowSysProps;
}
Type Alias WorkflowQueryOptions
Workflow
order?: OrderQueryParam;
stepId[in]?: string;
sys.entity.sys.id[in]?: string;
sys.entity.sys.linkType?: string;
sys.workflowDefinition.sys.id?: string;
}
order?: OrderQueryParam;
stepId[in]?: string;
sys.entity.sys.id[in]?: string;
sys.entity.sys.linkType?: string;
sys.workflowDefinition.sys.id?: string;
}
Type declaration
Optionalorder?: OrderQueryParamOrder workflows by
+OptionalstepId[in]?: string Optionalsys.entity.sys.id[in]?: stringFind workflows containing the specified, comma-separated entities. Requires
+sys.entity.sys.linkTypeOptionalsys.entity.sys.linkType?: string Find workflows filtered by the Entity type (Entry)
+Optionalsys.workflowDefinition.sys.id?: string
Type Alias WorkflowStepAction
Type Alias WorkflowStepAppAction
Workflow
appActionId: string;
appId: string;
configuration?: {
body?: Record<string, any>;
headers?: Record<string, string>;
};
type: "app";
}
appActionId: string;
appId: string;
configuration?: {
body?: Record<string, any>;
headers?: Record<string, string>;
};
type: "app";
}
Type Alias WorkflowStepEmailAction
Workflow
configuration: {
recipients: WorkflowStepEmailActionRecipient[];
};
type: "email";
}
configuration: {
recipients: WorkflowStepEmailActionRecipient[];
};
type: "email";
}
diff --git a/contentful-management/11.40.3/types/WorkflowStepPermissionActors.html b/contentful-management/11.40.3/types/WorkflowStepPermissionActors.html
new file mode 100644
index 0000000000..878a05bea6
--- /dev/null
+++ b/contentful-management/11.40.3/types/WorkflowStepPermissionActors.html
@@ -0,0 +1 @@
+
diff --git a/contentful-management/11.40.3/types/WorkflowStepProps.html b/contentful-management/11.40.3/types/WorkflowStepProps.html
new file mode 100644
index 0000000000..afd6dff0e3
--- /dev/null
+++ b/contentful-management/11.40.3/types/WorkflowStepProps.html
@@ -0,0 +1 @@
+
Type Alias WorkflowStepProps
Workflow
actions?: WorkflowStepAction[];
annotations?: string[];
description?: string;
id: string;
name: string;
permissions?: WorkflowStepPermission[];
}
actions?: WorkflowStepAction[];
annotations?: string[];
description?: string;
id: string;
name: string;
permissions?: WorkflowStepPermission[];
}
diff --git a/contentful-management/11.40.3/types/WorkflowsChangelogEntryProps.html b/contentful-management/11.40.3/types/WorkflowsChangelogEntryProps.html
new file mode 100644
index 0000000000..c669aa0769
--- /dev/null
+++ b/contentful-management/11.40.3/types/WorkflowsChangelogEntryProps.html
@@ -0,0 +1 @@
+
Type Alias WorkflowsChangelogEntryProps
Workflows
entity: Link<"Entry">;
event: string;
eventAt: string;
eventBy: SysLink;
stepAnnotations: string[];
stepId: string;
stepName: string;
workflow: VersionedLink<"Workflow">;
workflowDefinition: Link<"WorkflowDefinition">;
}
entity: Link<"Entry">;
event: string;
eventAt: string;
eventBy: SysLink;
stepAnnotations: string[];
stepId: string;
stepName: string;
workflow: VersionedLink<"Workflow">;
workflowDefinition: Link<"WorkflowDefinition">;
}
Type Alias WorkflowsChangelogQueryOptions
Workflows
entity.sys.id: string;
entity.sys.linkType: string;
eventAt[gte]?: string;
eventAt[lte]?: string;
workflow.sys.id?: string;
workflowDefinition.sys.id[in]?: string;
}
entity.sys.id: string;
entity.sys.linkType: string;
eventAt[gte]?: string;
eventAt[lte]?: string;
workflow.sys.id?: string;
workflowDefinition.sys.id[in]?: string;
}
Type declaration
entity.sys.id: string
Find workflows changelog entries containing the specified, comma-separated entities. Requires
+sys.entity.sys.linkTypeentity.sys.link
Type: string Find workflows changelog entries filtered by the Entity type (Entry)
+OptionaleventAt[gte]?: string OptionaleventAt[lte]?: string Optionalworkflow.sys.id?: stringworkflow.sys.id is optional so all past workflows can be found
+OptionalworkflowDefinition.sys.id[in]?: string
Variable ReleaseReferenceFilters
Class RestAdapter
Implements
Index
Constructors
constructor
+RestAdapter | contentful-management.js - v11.40.3
make
Class RestAdapter
Implements
Index
Constructors
Methods
Constructors
constructor
- new
Rest Adapter(params): RestAdapter Parameters
- params: RestAdapterParams
Returns RestAdapter
Methods
make
- make
Request<R>(__namedParameters): Promise<R> Type Parameters
Parameters
- __namedParameters: MakeRequestOptions
Returns Promise<R>
Constructors
constructor
- new
Rest Adapter(params): RestAdapter Parameters
- params: RestAdapterParams
Returns RestAdapter
Methods
make
- make
Request<R>(__namedParameters): Promise<R> Type Parameters
Parameters
- __namedParameters: MakeRequestOptions
Returns Promise<R>
Enumeration BulkActionStatus
Represents the state of the BulkAction
- Index
Enumeration Members
created
+BulkActionStatus | contentful-management.js - v11.40.3
Enumeration BulkActionStatus
Represents the state of the BulkAction
+ Index
Enumeration Members
failed
failed
BulkAction failed to complete (terminal state)
+in
in
BulkAction has been started and pending completion
+succeeded
succeeded
BulkAction was completed successfully (terminal state)
+Enumeration ScheduledActionReferenceFilters
Index
Enumeration Members
Enumeration ScheduledActionReferenceFilters
Index
Enumeration Members
diff --git a/contentful-management/latest/enums/WorkflowStepPermissionAction.html b/contentful-management/latest/enums/WorkflowStepPermissionAction.html
index 2edfbb4ec8..ed6382e8a2 100644
--- a/contentful-management/latest/enums/WorkflowStepPermissionAction.html
+++ b/contentful-management/latest/enums/WorkflowStepPermissionAction.html
@@ -1,4 +1,4 @@
-
Enumeration WorkflowStepPermissionAction
diff --git a/contentful-management/latest/enums/WorkflowStepPermissionType.html b/contentful-management/latest/enums/WorkflowStepPermissionType.html
index 19fcee56c4..78fcc64072 100644
--- a/contentful-management/latest/enums/WorkflowStepPermissionType.html
+++ b/contentful-management/latest/enums/WorkflowStepPermissionType.html
@@ -1,3 +1,3 @@
-
Enumeration WorkflowStepPermissionType
Index
Enumeration Members
EntityWorkflowStepPermissionType | contentful-management.js - v11.40.3
Enumeration WorkflowStepPermissionType
Index
Enumeration Members
+
diff --git a/contentful-management/latest/functions/createClient.html b/contentful-management/latest/functions/createClient.html
index a89da7c5c5..abe6cfc39a 100644
--- a/contentful-management/latest/functions/createClient.html
+++ b/contentful-management/latest/functions/createClient.html
@@ -1,7 +1,7 @@
-
Function createClient
- create
Client(params): ClientAPI Create a client instance
+createClient | contentful-management.js - v11.40.3 +Function createClient
- create
Client(params): ClientAPI Create a client instance
Parameters
- params: ClientOptions
Client initialization parameters
-const client = contentfulManagement.createClient({
accessToken: 'myAccessToken'
})
Returns ClientAPI
- params: ClientOptions
- create
Client(params, opts): PlainClientAPI Parameters
- params: ClientOptions
- opts: {
defaults?: DefaultParams;
type: "plain";
}Optionaldefaults?: DefaultParamstype: "plain"
Returns PlainClientAPI
- create
Client(params, opts): ClientAPI | PlainClientAPI Parameters
- params: ClientOptions
- opts: {
alphaFeatures: string[];
defaults?: DefaultParams;
type?: "plain";
}alpha
Features: string[] Optionaldefaults?: DefaultParamsOptionaltype?: "plain"
Returns ClientAPI | PlainClientAPI
- create
Returns ClientAPI
Parameters
- params: ClientOptions
- opts: {
defaults?: DefaultParams;
type: "plain";
}Optionaldefaults?: DefaultParamstype: "plain"
Returns PlainClientAPI
Parameters
- params: ClientOptions
- opts: {
alphaFeatures: string[];
defaults?: DefaultParams;
type?: "plain";
}alpha
Features: string[] Optionaldefaults?: DefaultParamsOptionaltype?: "plain"
Returns ClientAPI | PlainClientAPI
Function fetchAll
- fetch
All<Params, Entity, F>(fetchFn, params): Promise<Entity[]> Parameters for endpoint methods that can be paginated are inconsistent,
fetchAllwill only +fetchAll | contentful-management.js - v11.40.3 +Function fetchAll
- fetch
All<Params, Entity, F>(fetchFn, params): Promise<Entity[]> Parameters for endpoint methods that can be paginated are inconsistent,
-fetchAllwill only work with the more common version of supplying the limit, skip, and pageNext parameters via a distinctqueryproperty in the parameters.Type Parameters
Returns Promise<Entity[]>
Type Parameters
Returns Promise<Entity[]>
- fetch
Function isDraft
- is
Draft(data): boolean Parameters
- data: {
sys: MetaSysProps;
}sys: MetaSysProps
Returns boolean
- data: {
Function isDraft
- is
Draft(data): boolean Parameters
- data: {
sys: MetaSysProps;
}sys: MetaSysProps
Returns boolean
- data: {
Function isPublished
- is
Published(data): boolean Parameters
- data: {
sys: MetaSysProps;
}sys: MetaSysProps
Returns boolean
- data: {
Function isPublished
- is
Published(data): boolean Parameters
- data: {
sys: MetaSysProps;
}sys: MetaSysProps
Returns boolean
- data: {
Function isUpdated
- is
Updated(data): boolean Parameters
- data: {
sys: MetaSysProps;
}sys: MetaSysProps
Returns boolean
- data: {
Function isUpdated
- is
Updated(data): boolean Parameters
- data: {
sys: MetaSysProps;
}sys: MetaSysProps
Returns boolean
- data: {
contentful-management.js - v11.40.2
Class Hierarchy
- DefaultElements
- AccessToken
- ApiKey
- AppAccessToken
- AppActionCall
- AppBundle
- AppDetails
- AppEventSubscription
- AppInstallation
- AppKey
- AppSignedRequest
- AppSigningSecret
- AppUpload
- Asset
- AssetKey
- BulkAction
- Comment
- ContentType
- EditorInterface
- Entry
- EnvironmentAlias
- UIExtension
- Locale
- OrganizationInvitation
- OrganizationMembership
- PersonalAccessToken
- PreviewApiKey
- Release
- ReleaseAction
- Role
- ScheduledAction
- Snapshot
- SpaceMember
- SpaceMembership
- Tag
- Task
- Team
- TeamMembership
- TeamSpaceMembership
- UIConfig
- Upload
- UploadCredential
- Usage
- User
- UserUIConfig
- WebHooks
- WorkflowDefinition
- ResourceProvider
- ResourceType
- Workflow
- WorkflowsChangelogEntry
- Collection
- CursorPaginatedCollection
- AccessToken
contentful-management.js - v11.40.3
Class Hierarchy
- DefaultElements
- AccessToken
- ApiKey
- AppAccessToken
- AppActionCall
- AppBundle
- AppDetails
- AppEventSubscription
- AppInstallation
- AppKey
- AppSignedRequest
- AppSigningSecret
- AppUpload
- Asset
- AssetKey
- BulkAction
- Comment
- ContentType
- EditorInterface
- Entry
- EnvironmentAlias
- UIExtension
- Locale
- OrganizationInvitation
- OrganizationMembership
- PersonalAccessToken
- PreviewApiKey
- Release
- ReleaseAction
- Role
- ScheduledAction
- Snapshot
- SpaceMember
- SpaceMembership
- Tag
- Task
- Team
- TeamMembership
- TeamSpaceMembership
- UIConfig
- Upload
- UploadCredential
- Usage
- User
- UserUIConfig
- WebHooks
- WorkflowDefinition
- ResourceProvider
- ResourceType
- Workflow
- WorkflowsChangelogEntry
- Collection
- CursorPaginatedCollection
- AccessToken
contentful-management.js - v11.40.2
+contentful-management.js - v11.40.3
contentful-management.js - v11.40.3
@@ -228,4 +228,4 @@ JavaScript
License
This repository is published under the MIT license.
Code of Conduct
We want to provide a safe, inclusive, welcoming, and harassment-free space and experience for all participants, regardless of gender identity and expression, sexual orientation, disability, physical appearance, socioeconomic status, body size, ethnicity, nationality, level of experience, age, religion (or lack thereof), or other identity markers.
-Interface AccessToken
interface AccessToken {
name: string;
revokedAt: null | string;
scopes: "content_management_manage"[];
sys: AccessTokenSysProps;
token?: string;
revoke(): Promise<AccessToken>;
toPlainObject(): AccessTokenProp;
}
name: string;
revokedAt: null | string;
scopes: "content_management_manage"[];
sys: AccessTokenSysProps;
token?: string;
revoke(): Promise<AccessToken>;
toPlainObject(): AccessTokenProp;
}
Hierarchy (view full)
- AccessTokenProp
- DefaultElements<AccessTokenProp>
- AccessToken
Index
Properties
name
+AccessToken | contentful-management.js - v11.40.3
revoked
revoked
to
+```" aria-label="Permalink" class="tsd-anchor-icon">Interface AccessToken
interface AccessToken {
name: string;
revokedAt: null | string;
scopes: "content_management_manage"[];
sys: AccessTokenSysProps;
token?: string;
revoke(): Promise<AccessToken>;
toPlainObject(): AccessTokenProp;
}
name: string;
revokedAt: null | string;
scopes: "content_management_manage"[];
sys: AccessTokenSysProps;
token?: string;
revoke(): Promise<AccessToken>;
toPlainObject(): AccessTokenProp;
}
Hierarchy (view full)
- AccessTokenProp
- DefaultElements<AccessTokenProp>
- AccessToken
Properties
name
name: string
revoked
revoked
scopes
scopes: "content_management_manage"[]
sys
sys: AccessTokenSysProps
Optionaltoken
token?: string
Methods
revoke
- revoke(): Promise<AccessToken>
Revokes access token
+
Properties
name
name: string
revoked
revoked
scopes
scopes: "content_management_manage"[]
sys
sys: AccessTokenSysProps
Optionaltoken
token?: string
Methods
revoke
- revoke(): Promise<AccessToken>
Revokes access token
Returns Promise<AccessToken>
Object the revoked access token
to
- to
Plain Object(): AccessTokenProp Returns AccessTokenProp
to
- to
Plain Object(): AccessTokenProp Returns AccessTokenProp
Interface Adapter
Implemented by
Index
Properties
Interface Adapter
Implemented by
Index
Properties
Interface ApiKey
interface ApiKey {
accessToken: string;
description?: string;
environments: {
sys: MetaLinkProps;
}[];
name: string;
policies?: {
action: string;
effect: string;
}[];
preview_api_key: {
sys: MetaLinkProps;
};
sys: MetaSysProps;
delete(): Promise<void>;
toPlainObject(): ApiKeyProps;
update(): Promise<ApiKey>;
}
accessToken: string;
description?: string;
environments: {
sys: MetaLinkProps;
}[];
name: string;
policies?: {
action: string;
effect: string;
}[];
preview_api_key: {
sys: MetaLinkProps;
};
sys: MetaSysProps;
delete(): Promise<void>;
toPlainObject(): ApiKeyProps;
update(): Promise<ApiKey>;
}
Hierarchy (view full)
Index
Properties
accessApiKey | contentful-management.js - v11.40.3
access
preview_
to
to
Interface ApiKey
interface ApiKey {
accessToken: string;
description?: string;
environments: {
sys: MetaLinkProps;
}[];
name: string;
policies?: {
action: string;
effect: string;
}[];
preview_api_key: {
sys: MetaLinkProps;
};
sys: MetaSysProps;
delete(): Promise<void>;
toPlainObject(): ApiKeyProps;
update(): Promise<ApiKey>;
}
accessToken: string;
description?: string;
environments: {
sys: MetaLinkProps;
}[];
name: string;
policies?: {
action: string;
effect: string;
}[];
preview_api_key: {
sys: MetaLinkProps;
};
sys: MetaSysProps;
delete(): Promise<void>;
toPlainObject(): ApiKeyProps;
update(): Promise<ApiKey>;
}
Hierarchy (view full)
Index
Properties
Methods
Properties
access
access
Optionaldescription
description?: string
environments
name
name: string
Optionalpolicies
policies?: {
action: string;
effect: string;
}[]
action: string;
effect: string;
}[]
preview_
sys
Methods
delete
to
- to
Plain Object(): ApiKeyProps Returns ApiKeyProps
update
- update(): Promise<ApiKey>
Sends an update to the server with any changes made to the object's properties
+```" aria-label="Permalink" class="tsd-anchor-icon">
to
- to
Plain Object(): ApiKeyProps Returns ApiKeyProps
update
Interface AppAccessToken
interface AppAccessToken {
sys: AppAccessTokenSys;
token: string;
toPlainObject(): AppAccessTokenProps;
}
sys: AppAccessTokenSys;
token: string;
toPlainObject(): AppAccessTokenProps;
}
Hierarchy (view full)
- AppAccessTokenProps
- DefaultElements<AppAccessTokenProps>
- AppAccessToken
Index
Properties
sys
+AppAccessToken | contentful-management.js - v11.40.3
to
Interface AppAccessToken
interface AppAccessToken {
sys: AppAccessTokenSys;
token: string;
toPlainObject(): AppAccessTokenProps;
}
sys: AppAccessTokenSys;
token: string;
toPlainObject(): AppAccessTokenProps;
}
Hierarchy (view full)
- AppAccessTokenProps
- DefaultElements<AppAccessTokenProps>
- AppAccessToken
Index
Properties
Methods
Properties
sys
sys: AppAccessTokenSys
System metadata
-token
token: string
Token for an app installation in a space environment
- Methods
to
- to
Plain Object(): AppAccessTokenProps Returns AppAccessTokenProps
token
token: string
Token for an app installation in a space environment
+ Methods
to
- to
Plain Object(): AppAccessTokenProps Returns AppAccessTokenProps
Interface AppActionCall
Hierarchy (view full)
- AppActionCallProps
- DefaultElements<AppActionCallProps>
- AppActionCall
Index
Properties
sys
+AppActionCall | contentful-management.js - v11.40.3
to
Interface AppActionCall
Hierarchy (view full)
- AppActionCallProps
- DefaultElements<AppActionCallProps>
- AppActionCall
Index
Properties
Methods
Methods
to
- to
Plain Object(): AppActionCallProps Returns AppActionCallProps
Methods
to
- to
Plain Object(): AppActionCallProps Returns AppActionCallProps
Interface AppBundle
interface AppBundle {
comment?: string;
files: AppBundleFile[];
sys: AppBundleSys;
delete(): Promise<void>;
toPlainObject(): AppBundleProps;
}
comment?: string;
files: AppBundleFile[];
sys: AppBundleSys;
delete(): Promise<void>;
toPlainObject(): AppBundleProps;
}
Hierarchy (view full)
- AppBundleProps
- DefaultElements<AppBundleProps>
- AppBundle
Index
Properties
comment?
+AppBundle | contentful-management.js - v11.40.3
to
Interface AppBundle
interface AppBundle {
comment?: string;
files: AppBundleFile[];
sys: AppBundleSys;
delete(): Promise<void>;
toPlainObject(): AppBundleProps;
}
comment?: string;
files: AppBundleFile[];
sys: AppBundleSys;
delete(): Promise<void>;
toPlainObject(): AppBundleProps;
}
Hierarchy (view full)
- AppBundleProps
- DefaultElements<AppBundleProps>
- AppBundle
Index
Properties
Methods
Properties
Optionalcomment
comment?: string
A comment that describes this bundle
-files
List of all the files that are in this bundle
-sys
sys: AppBundleSys
System metadata
- Methods
delete
files
List of all the files that are in this bundle
+sys
sys: AppBundleSys
System metadata
+ Methods
delete
to
- to
Plain Object(): AppBundleProps Returns AppBundleProps
to
- to
Plain Object(): AppBundleProps Returns AppBundleProps
Interface AppDetails
interface AppDetails {
icon?: AppIcon;
sys: AppDetailsSys;
delete(): Promise<void>;
toPlainObject(): AppDetailsProps;
}
icon?: AppIcon;
sys: AppDetailsSys;
delete(): Promise<void>;
toPlainObject(): AppDetailsProps;
}
Hierarchy (view full)
- AppDetailsProps
- DefaultElements<AppDetailsProps>
- AppDetails
Index
Properties
icon?
+AppDetails | contentful-management.js - v11.40.3
to
Interface AppDetails
interface AppDetails {
icon?: AppIcon;
sys: AppDetailsSys;
delete(): Promise<void>;
toPlainObject(): AppDetailsProps;
}
icon?: AppIcon;
sys: AppDetailsSys;
delete(): Promise<void>;
toPlainObject(): AppDetailsProps;
}
Hierarchy (view full)
- AppDetailsProps
- DefaultElements<AppDetailsProps>
- AppDetails
Index
Properties
Methods
Methods
delete
to
- to
Plain Object(): AppDetailsProps Returns AppDetailsProps
to
- to
Plain Object(): AppDetailsProps Returns AppDetailsProps
Interface AppEventSubscription
interface AppEventSubscription {
sys: AppEventSubscriptionSys;
targetUrl: string;
topics: string[];
delete(): Promise<void>;
toPlainObject(): AppEventSubscriptionProps;
}
sys: AppEventSubscriptionSys;
targetUrl: string;
topics: string[];
delete(): Promise<void>;
toPlainObject(): AppEventSubscriptionProps;
}
Hierarchy (view full)
- AppEventSubscriptionProps
- DefaultElements<AppEventSubscriptionProps>
- AppEventSubscription
Index
Properties
sys
+AppEventSubscription | contentful-management.js - v11.40.3
target
target
to
Interface AppEventSubscription
interface AppEventSubscription {
sys: AppEventSubscriptionSys;
targetUrl: string;
topics: string[];
delete(): Promise<void>;
toPlainObject(): AppEventSubscriptionProps;
}
sys: AppEventSubscriptionSys;
targetUrl: string;
topics: string[];
delete(): Promise<void>;
toPlainObject(): AppEventSubscriptionProps;
}
Hierarchy (view full)
- AppEventSubscriptionProps
- DefaultElements<AppEventSubscriptionProps>
- AppEventSubscription
Index
Properties
Methods
Properties
sys
sys: AppEventSubscriptionSys
System metadata
-target
target
Subscription url that will receive events
-topics
topics: string[]
List of topics to subscribe to
- Methods
delete
target
target
Subscription url that will receive events
+topics
topics: string[]
List of topics to subscribe to
+ Methods
delete
to
- to
Plain Object(): AppEventSubscriptionProps Returns AppEventSubscriptionProps
to
- to
Plain Object(): AppEventSubscriptionProps Returns AppEventSubscriptionProps
Interface AppIcon
Interface AppInstallation
interface AppInstallation {
parameters?: FreeFormParameters;
sys: Omit<BasicMetaSysProps, "id"> & {
appDefinition: SysLink;
environment: SysLink;
space: SysLink;
};
delete(): Promise<void>;
toPlainObject(): AppInstallationProps;
update(): Promise<AppInstallation>;
}
parameters?: FreeFormParameters;
sys: Omit<BasicMetaSysProps, "id"> & {
appDefinition: SysLink;
environment: SysLink;
space: SysLink;
};
delete(): Promise<void>;
toPlainObject(): AppInstallationProps;
update(): Promise<AppInstallation>;
}
Hierarchy (view full)
- AppInstallationProps
- DefaultElements<AppInstallationProps>
- AppInstallation
Index
Properties
parameters?
+AppInstallation | contentful-management.js - v11.40.3
to
to
+```" aria-label="Permalink" class="tsd-anchor-icon">Interface AppInstallation
interface AppInstallation {
parameters?: FreeFormParameters;
sys: Omit<BasicMetaSysProps, "id"> & {
appDefinition: SysLink;
environment: SysLink;
space: SysLink;
};
delete(): Promise<void>;
toPlainObject(): AppInstallationProps;
update(): Promise<AppInstallation>;
}
parameters?: FreeFormParameters;
sys: Omit<BasicMetaSysProps, "id"> & {
appDefinition: SysLink;
environment: SysLink;
space: SysLink;
};
delete(): Promise<void>;
toPlainObject(): AppInstallationProps;
update(): Promise<AppInstallation>;
}
Hierarchy (view full)
- AppInstallationProps
- DefaultElements<AppInstallationProps>
- AppInstallation
Index
Properties
Methods
Properties
Optionalparameters
Free-form installation parameters (API limits stringified length to 32KB)
-sys
sys: Omit<BasicMetaSysProps, "id"> & {
appDefinition: SysLink;
environment: SysLink;
space: SysLink;
}
appDefinition: SysLink;
environment: SysLink;
space: SysLink;
}
Methods
delete
sys
sys: Omit<BasicMetaSysProps, "id"> & {
appDefinition: SysLink;
environment: SysLink;
space: SysLink;
}
appDefinition: SysLink;
environment: SysLink;
space: SysLink;
}
Methods
delete
to
- to
Plain Object(): AppInstallationProps Returns AppInstallationProps
update
- update(): Promise<AppInstallation>
Sends an update to the server with any changes made to the object's properties
+```" aria-label="Permalink" class="tsd-anchor-icon">
to
- to
Plain Object(): AppInstallationProps Returns AppInstallationProps
update
- update(): Promise<AppInstallation>
Sends an update to the server with any changes made to the object's properties
Returns Promise<AppInstallation>
Object returned from the server with updated changes.
Interface AppKey
interface AppKey {
generated?: {
privateKey: string;
};
jwk: JWK;
sys: AppKeySys;
delete(): Promise<void>;
toPlainObject(): AppKeyProps;
}
generated?: {
privateKey: string;
};
jwk: JWK;
sys: AppKeySys;
delete(): Promise<void>;
toPlainObject(): AppKeyProps;
}
Hierarchy (view full)
Index
Properties
generated?
+AppKey | contentful-management.js - v11.40.3
to
+```" aria-label="Permalink" class="tsd-anchor-icon">Interface AppKey
interface AppKey {
generated?: {
privateKey: string;
};
jwk: JWK;
sys: AppKeySys;
delete(): Promise<void>;
toPlainObject(): AppKeyProps;
}
generated?: {
privateKey: string;
};
jwk: JWK;
sys: AppKeySys;
delete(): Promise<void>;
toPlainObject(): AppKeyProps;
}
Hierarchy (view full)
Index
Properties
Methods
jwk
jwk: JWK
JSON Web Key
+sys
sys: AppKeySys
System metadata
+ Methods
delete
to
- to
Plain Object(): AppKeyProps Returns AppKeyProps
to
- to
Plain Object(): AppKeyProps Returns AppKeyProps
Interface AppSignedRequest
interface AppSignedRequest {
additionalHeaders: {
x-contentful-environment-id: string;
x-contentful-signature: string;
x-contentful-signed-headers: string;
x-contentful-space-id: string;
x-contentful-timestamp: string;
x-contentful-user-id: string;
};
sys: AppSignedRequestSys;
toPlainObject(): AppSignedRequestProps;
}
additionalHeaders: {
x-contentful-environment-id: string;
x-contentful-signature: string;
x-contentful-signed-headers: string;
x-contentful-space-id: string;
x-contentful-timestamp: string;
x-contentful-user-id: string;
};
sys: AppSignedRequestSys;
toPlainObject(): AppSignedRequestProps;
}
Hierarchy (view full)
- AppSignedRequestProps
- DefaultElements<AppSignedRequestProps>
- AppSignedRequest
Index
Properties
additionalAppSignedRequest | contentful-management.js - v11.40.3
additional
to
Interface AppSignedRequest
interface AppSignedRequest {
additionalHeaders: {
x-contentful-environment-id: string;
x-contentful-signature: string;
x-contentful-signed-headers: string;
x-contentful-space-id: string;
x-contentful-timestamp: string;
x-contentful-user-id: string;
};
sys: AppSignedRequestSys;
toPlainObject(): AppSignedRequestProps;
}
additionalHeaders: {
x-contentful-environment-id: string;
x-contentful-signature: string;
x-contentful-signed-headers: string;
x-contentful-space-id: string;
x-contentful-timestamp: string;
x-contentful-user-id: string;
};
sys: AppSignedRequestSys;
toPlainObject(): AppSignedRequestProps;
}
Hierarchy (view full)
- AppSignedRequestProps
- DefaultElements<AppSignedRequestProps>
- AppSignedRequest
Index
Properties
Methods
Properties
additional
additional
x-contentful-environment-id: string;
x-contentful-signature: string;
x-contentful-signed-headers: string;
x-contentful-space-id: string;
x-contentful-timestamp: string;
x-contentful-user-id: string;
}
x-contentful-environment-id: string;
x-contentful-signature: string;
x-contentful-signed-headers: string;
x-contentful-space-id: string;
x-contentful-timestamp: string;
x-contentful-user-id: string;
}
new headers to be included in the request
-sys
sys: AppSignedRequestSys
System metadata
- Methods
to
- to
Plain Object(): AppSignedRequestProps Returns AppSignedRequestProps
sys
sys: AppSignedRequestSys
System metadata
+ Methods
to
- to
Plain Object(): AppSignedRequestProps Returns AppSignedRequestProps
Interface AppSigningSecret
interface AppSigningSecret {
redactedValue: string;
sys: AppSigningSecretSys;
delete(): Promise<void>;
toPlainObject(): AppSigningSecretProps;
}
redactedValue: string;
sys: AppSigningSecretSys;
delete(): Promise<void>;
toPlainObject(): AppSigningSecretProps;
}
Hierarchy (view full)
- AppSigningSecretProps
- DefaultElements<AppSigningSecretProps>
- AppSigningSecret
Index
Properties
redactedAppSigningSecret | contentful-management.js - v11.40.3
redacted
to
Interface AppSigningSecret
interface AppSigningSecret {
redactedValue: string;
sys: AppSigningSecretSys;
delete(): Promise<void>;
toPlainObject(): AppSigningSecretProps;
}
redactedValue: string;
sys: AppSigningSecretSys;
delete(): Promise<void>;
toPlainObject(): AppSigningSecretProps;
}
Hierarchy (view full)
- AppSigningSecretProps
- DefaultElements<AppSigningSecretProps>
- AppSigningSecret
Index
Properties
Methods
Properties
redacted
redacted
The last four characters of the signing secret
-sys
sys: AppSigningSecretSys
System metadata
- Methods
delete
to
- to
Plain Object(): AppSigningSecretProps Returns AppSigningSecretProps
to
- to
Plain Object(): AppSigningSecretProps Returns AppSigningSecretProps
Interface AppUpload
interface AppUpload {
sys: {
createdAt: string;
createdBy?: SysLink;
id: string;
type: string;
updatedAt: string;
updatedBy?: SysLink;
} & {
expiresAt: string;
organization: SysLink;
};
delete(): Promise<void>;
toPlainObject(): AppUploadProps;
}
sys: {
createdAt: string;
createdBy?: SysLink;
id: string;
type: string;
updatedAt: string;
updatedBy?: SysLink;
} & {
expiresAt: string;
organization: SysLink;
};
delete(): Promise<void>;
toPlainObject(): AppUploadProps;
}
Hierarchy (view full)
- AppUploadProps
- DefaultElements<AppUploadProps>
- AppUpload
Index
Properties
sys
+AppUpload | contentful-management.js - v11.40.3
to
+```" aria-label="Permalink" class="tsd-anchor-icon">Interface AppUpload
interface AppUpload {
sys: {
createdAt: string;
createdBy?: SysLink;
id: string;
type: string;
updatedAt: string;
updatedBy?: SysLink;
} & {
expiresAt: string;
organization: SysLink;
};
delete(): Promise<void>;
toPlainObject(): AppUploadProps;
}
sys: {
createdAt: string;
createdBy?: SysLink;
id: string;
type: string;
updatedAt: string;
updatedBy?: SysLink;
} & {
expiresAt: string;
organization: SysLink;
};
delete(): Promise<void>;
toPlainObject(): AppUploadProps;
}
Hierarchy (view full)
- AppUploadProps
- DefaultElements<AppUploadProps>
- AppUpload
Index
Properties
Methods
Methods
delete
to
- to
Plain Object(): AppUploadProps Returns AppUploadProps
to
- to
Plain Object(): AppUploadProps Returns AppUploadProps
Interface Asset
interface Asset {
fields: {
description?: {
[key: string]: string;
};
file: {
[key: string]: {
contentType: string;
details?: Record<string, any>;
fileName: string;
upload?: string;
uploadFrom?: Record<string, any>;
url?: string;
};
};
title: {
[key: string]: string;
};
};
metadata?: MetadataProps;
sys: EntityMetaSysProps;
archive(): Promise<Asset>;
delete(): Promise<void>;
isArchived(): boolean;
isDraft(): boolean;
isPublished(): boolean;
isUpdated(): boolean;
processForAllLocales(options?: AssetProcessingForLocale): Promise<Asset>;
processForLocale(locale: string, Options?: AssetProcessingForLocale): Promise<Asset>;
publish(): Promise<Asset>;
toPlainObject(): AssetProps;
unarchive(): Promise<Asset>;
unpublish(): Promise<Asset>;
update(): Promise<Asset>;
}
fields: {
description?: {
[key: string]: string;
};
file: {
[key: string]: {
contentType: string;
details?: Record<string, any>;
fileName: string;
upload?: string;
uploadFrom?: Record<string, any>;
url?: string;
};
};
title: {
[key: string]: string;
};
};
metadata?: MetadataProps;
sys: EntityMetaSysProps;
archive(): Promise<Asset>;
delete(): Promise<void>;
isArchived(): boolean;
isDraft(): boolean;
isPublished(): boolean;
isUpdated(): boolean;
processForAllLocales(options?: AssetProcessingForLocale): Promise<Asset>;
processForLocale(locale: string, Options?: AssetProcessingForLocale): Promise<Asset>;
publish(): Promise<Asset>;
toPlainObject(): AssetProps;
unarchive(): Promise<Asset>;
unpublish(): Promise<Asset>;
update(): Promise<Asset>;
}
Hierarchy (view full)
- AssetProps
- DefaultElements<AssetProps>
- AssetApi
- Asset
Index
Properties
fields
+Asset | contentful-management.js - v11.40.3
file
title: {
is
is
is
is
process
Interface Asset
interface Asset {
fields: {
description?: {
[key: string]: string;
};
file: {
[key: string]: {
contentType: string;
details?: Record<string, any>;
fileName: string;
upload?: string;
uploadFrom?: Record<string, any>;
url?: string;
};
};
title: {
[key: string]: string;
};
};
metadata?: MetadataProps;
sys: EntityMetaSysProps;
archive(): Promise<Asset>;
delete(): Promise<void>;
isArchived(): boolean;
isDraft(): boolean;
isPublished(): boolean;
isUpdated(): boolean;
processForAllLocales(options?: AssetProcessingForLocale): Promise<Asset>;
processForLocale(locale: string, Options?: AssetProcessingForLocale): Promise<Asset>;
publish(): Promise<Asset>;
toPlainObject(): AssetProps;
unarchive(): Promise<Asset>;
unpublish(): Promise<Asset>;
update(): Promise<Asset>;
}
fields: {
description?: {
[key: string]: string;
};
file: {
[key: string]: {
contentType: string;
details?: Record<string, any>;
fileName: string;
upload?: string;
uploadFrom?: Record<string, any>;
url?: string;
};
};
title: {
[key: string]: string;
};
};
metadata?: MetadataProps;
sys: EntityMetaSysProps;
archive(): Promise<Asset>;
delete(): Promise<void>;
isArchived(): boolean;
isDraft(): boolean;
isPublished(): boolean;
isUpdated(): boolean;
processForAllLocales(options?: AssetProcessingForLocale): Promise<Asset>;
processForLocale(locale: string, Options?: AssetProcessingForLocale): Promise<Asset>;
publish(): Promise<Asset>;
toPlainObject(): AssetProps;
unarchive(): Promise<Asset>;
unpublish(): Promise<Asset>;
update(): Promise<Asset>;
}
Hierarchy (view full)
- AssetProps
- DefaultElements<AssetProps>
- AssetApi
- Asset
Index
Properties
Methods
archive
@@ -20,7 +20,7 @@
file
Optionalupload?: string
Url where the file is available to be downloaded from, into the Contentful asset system. After the asset is processed this field is gone.
Optionalupload
Optionalurl?: string
Url where the file is available at the Contentful media asset system. This field won't be available until the asset is processed.
title: {
[key: string]: string;
}
Title for this asset
-[key: string]: string
Optionalmetadata
sys
Methods
archive
- archive(): Promise<Asset>
Archives the object
+[key: string]: string
Optionalmetadata
sys
delete
is
is
is
is
process
- process
For All Locales(options?): Promise<Asset> Triggers asset processing after an upload, for the files uploaded to all locales of an asset.
+```" aria-label="Permalink" class="tsd-anchor-icon">
is
is
is
is
process
- process
For All Locales(options?): Promise<Asset> Triggers asset processing after an upload, for the files uploaded to all locales of an asset.
Parameters
Optionaloptions: AssetProcessingForLocaleAdditional options for processing
Returns Promise<Asset>
Object returned from the server with updated metadata.
Throws
If the asset takes too long to process. If this happens, retrieve the asset again, and if the url property is available, then processing has succeeded. If not, your file might be damaged.
@@ -252,7 +252,7 @@ .then((asset) => asset.processForAllLocales()) .then((asset) => console.log(asset)) .catch(console.error) -```" aria-label="Permalink" class="tsd-anchor-icon">
process
- process
For Locale(locale, Options?): Promise<Asset> Triggers asset processing after an upload, for the file uploaded to a specific locale.
+```" aria-label="Permalink" class="tsd-anchor-icon">
process
- process
For Locale(locale, Options?): Promise<Asset> Triggers asset processing after an upload, for the file uploaded to a specific locale.
Parameters
- locale: string
Locale which processing should be triggered for
OptionalOptions: AssetProcessingForLocale
Returns Promise<Asset>
Object returned from the server with updated metadata.
Throws
If the asset takes too long to process. If this happens, retrieve the asset again, and if the url property is available, then processing has succeeded. If not, your file might be damaged.
@@ -348,7 +348,7 @@ .then((asset) => asset.processForLocale('en-US')) .then((asset) => console.log(asset)) .catch(console.error) -```" aria-label="Permalink" class="tsd-anchor-icon">- locale: string
publish
- publish(): Promise<Asset>
Publishes the object
+```" aria-label="Permalink" class="tsd-anchor-icon">
publish
to
- to
Plain Object(): AssetProps Returns AssetProps
unarchive
- unarchive(): Promise<Asset>
Unarchives the object
+```" aria-label="Permalink" class="tsd-anchor-icon">
to
- to
Plain Object(): AssetProps Returns AssetProps
unarchive
unpublish
- unpublish(): Promise<Asset>
Unpublishes the object
+```" aria-label="Permalink" class="tsd-anchor-icon">
unpublish
update
- update(): Promise<Asset>
Sends an update to the server with any changes made to the object's properties
+```" aria-label="Permalink" class="tsd-anchor-icon">
update
Interface AssetFileProp
interface AssetFileProp {
fields: {
description: {
[key: string]: string;
};
file: {
[key: string]: {
contentType: string;
file: string | ArrayBuffer | Stream;
fileName: string;
};
};
title: {
[key: string]: string;
};
};
sys: MetaSysProps;
}
fields: {
description: {
[key: string]: string;
};
file: {
[key: string]: {
contentType: string;
file: string | ArrayBuffer | Stream;
fileName: string;
};
};
title: {
[key: string]: string;
};
};
sys: MetaSysProps;
}
Index
Properties
fields
+AssetFileProp | contentful-management.js - v11.40.3
Interface AssetFileProp
interface AssetFileProp {
fields: {
description: {
[key: string]: string;
};
file: {
[key: string]: {
contentType: string;
file: string | ArrayBuffer | Stream;
fileName: string;
};
};
title: {
[key: string]: string;
};
};
sys: MetaSysProps;
}
fields: {
description: {
[key: string]: string;
};
file: {
[key: string]: {
contentType: string;
file: string | ArrayBuffer | Stream;
fileName: string;
};
};
title: {
[key: string]: string;
};
};
sys: MetaSysProps;
}
Interface AssetKey
Hierarchy (view full)
Index
Properties
policy
+AssetKey | contentful-management.js - v11.40.3
to
Interface AssetKey
Hierarchy (view full)
Index
Properties
Methods
Properties
policy
policy: string
A JWT describing a policy; needs to be attached to signed URLs
-secret
secret: string
A secret key to be used for signing URLs
- Methods
to
- to
Plain Object(): AssetKeyProps Returns AssetKeyProps
secret
secret: string
A secret key to be used for signing URLs
+ Methods
to
- to
Plain Object(): AssetKeyProps Returns AssetKeyProps
Interface BasicCursorPaginationOptions
Hierarchy
- Omit<BasicQueryOptions, "skip">
- BasicCursorPaginationOptions
Index
Properties
pageBasicCursorPaginationOptions | contentful-management.js - v11.40.3
Interface BasicCursorPaginationOptions
Hierarchy
- Omit<BasicQueryOptions, "skip">
- BasicCursorPaginationOptions
Interface BasicMetaSysProps
interface BasicMetaSysProps {
createdAt: string;
createdBy?: SysLink;
id: string;
type: string;
updatedAt: string;
updatedBy?: SysLink;
version: number;
}
createdAt: string;
createdBy?: SysLink;
id: string;
type: string;
updatedAt: string;
updatedBy?: SysLink;
version: number;
}
Hierarchy (view full)
- BasicMetaSysProps
Index
Properties
createdBasicMetaSysProps | contentful-management.js - v11.40.3
diff --git a/contentful-management/latest/interfaces/BulkAction.html b/contentful-management/latest/interfaces/BulkAction.html
index c5a25f95fe..2d8833cb02 100644
--- a/contentful-management/latest/interfaces/BulkAction.html
+++ b/contentful-management/latest/interfaces/BulkAction.html
@@ -1,13 +1,13 @@
-
Interface BulkAction<T>
The object returned by the BulkActions API
-interface BulkAction<T> {
action: BulkActionType;
error?: BulkActionFailedError;
payload: T;
sys: BulkActionSysProps;
get(): BulkAction<any>;
toPlainObject(): BulkActionProps<T>;
waitProcessing(options?: AsyncActionProcessingOptions): Promise<BulkAction<any>>;
}
action: BulkActionType;
error?: BulkActionFailedError;
payload: T;
sys: BulkActionSysProps;
get(): BulkAction<any>;
toPlainObject(): BulkActionProps<T>;
waitProcessing(options?: AsyncActionProcessingOptions): Promise<BulkAction<any>>;
}
Type Parameters
- T extends BulkActionPayload = any
Hierarchy (view full)
- BulkActionProps<T>
- BulkActionApiMethods
- DefaultElements<BulkActionProps<T>>
- BulkAction
Index
Properties
action
+BulkAction | contentful-management.js - v11.40.3
to
wait
Interface BulkAction<T>
The object returned by the BulkActions API
+interface BulkAction<T> {
action: BulkActionType;
error?: BulkActionFailedError;
payload: T;
sys: BulkActionSysProps;
get(): BulkAction<any>;
toPlainObject(): BulkActionProps<T>;
waitProcessing(options?: AsyncActionProcessingOptions): Promise<BulkAction<any>>;
}
action: BulkActionType;
error?: BulkActionFailedError;
payload: T;
sys: BulkActionSysProps;
get(): BulkAction<any>;
toPlainObject(): BulkActionProps<T>;
waitProcessing(options?: AsyncActionProcessingOptions): Promise<BulkAction<any>>;
}
Type Parameters
- T extends BulkActionPayload = any
Hierarchy (view full)
- BulkActionProps<T>
- BulkActionApiMethods
- DefaultElements<BulkActionProps<T>>
- BulkAction
Index
Properties
Methods
Properties
action
Optionalerror
error?: BulkActionFailedError
error information, if present
-payload
original payload when BulkAction was created
-sys
sys: BulkActionSysProps
Methods
get
- get(): BulkAction<any>
Performs a new GET request and returns the wrapper BulkAction
-Returns BulkAction<any>
to
- to
Plain Object(): BulkActionProps<T> Returns BulkActionProps<T>
wait
- wait
Processing(options?): Promise<BulkAction<any>> Waits until the BulkAction is in one of the final states (
-succeededorfailed) and returns it.Parameters
Optionaloptions: AsyncActionProcessingOptions
Returns Promise<BulkAction<any>>
Properties
action
Optionalerror
error?: BulkActionFailedError
error information, if present
+payload
original payload when BulkAction was created
+sys
sys: BulkActionSysProps
Methods
get
- get(): BulkAction<any>
Performs a new GET request and returns the wrapper BulkAction
+Returns BulkAction<any>
to
- to
Plain Object(): BulkActionProps<T> Returns BulkActionProps<T>
wait
- wait
Processing(options?): Promise<BulkAction<any>> Waits until the BulkAction is in one of the final states (
+succeededorfailed) and returns it.Parameters
Optionaloptions: AsyncActionProcessingOptions
Returns Promise<BulkAction<any>>
Interface BulkActionProps<TPayload>
The object returned by the BulkActions API
-interface BulkActionProps<TPayload> {
action: BulkActionType;
error?: BulkActionFailedError;
payload: TPayload;
sys: BulkActionSysProps;
}
action: BulkActionType;
error?: BulkActionFailedError;
payload: TPayload;
sys: BulkActionSysProps;
}
Type Parameters
- TPayload extends BulkActionPayload = any
Hierarchy (view full)
- BulkActionProps
Index
Properties
action
+BulkActionProps | contentful-management.js - v11.40.3
Interface BulkActionProps<TPayload>
The object returned by the BulkActions API
+interface BulkActionProps<TPayload> {
action: BulkActionType;
error?: BulkActionFailedError;
payload: TPayload;
sys: BulkActionSysProps;
}
action: BulkActionType;
error?: BulkActionFailedError;
payload: TPayload;
sys: BulkActionSysProps;
}
Type Parameters
- TPayload extends BulkActionPayload = any
Hierarchy (view full)
- BulkActionProps
Interface BulkActionPublishPayload
Base interface for all Payload interfaces. Used as part of the MakeRequestOptions to simplify payload definitions.
-interface BulkActionPublishPayload {
entities: {
items: Collection<VersionedLink<Entity>>;
sys?: {
type: "Array";
};
};
}
entities: {
items: Collection<VersionedLink<Entity>>;
sys?: {
type: "Array";
};
};
}
Hierarchy (view full)
- MakeRequestPayload
- BulkActionPublishPayload
Index
Properties
entities
-
Interface BulkActionPublishPayload
Base interface for all Payload interfaces. Used as part of the MakeRequestOptions to simplify payload definitions.
+interface BulkActionPublishPayload {
entities: {
items: Collection<VersionedLink<Entity>>;
sys?: {
type: "Array";
};
};
}
entities: {
items: Collection<VersionedLink<Entity>>;
sys?: {
type: "Array";
};
};
}
Hierarchy (view full)
- MakeRequestPayload
- BulkActionPublishPayload
Index
Properties
entities
+
Interface BulkActionUnpublishPayload
Base interface for all Payload interfaces. Used as part of the MakeRequestOptions to simplify payload definitions.
-interface BulkActionUnpublishPayload {
entities: {
items: Collection<Link<Entity>>;
sys?: {
type: "Array";
};
};
}
entities: {
items: Collection<Link<Entity>>;
sys?: {
type: "Array";
};
};
}
Hierarchy (view full)
- MakeRequestPayload
- BulkActionUnpublishPayload
Index
Properties
entities
-
Interface BulkActionUnpublishPayload
Base interface for all Payload interfaces. Used as part of the MakeRequestOptions to simplify payload definitions.
+interface BulkActionUnpublishPayload {
entities: {
items: Collection<Link<Entity>>;
sys?: {
type: "Array";
};
};
}
entities: {
items: Collection<Link<Entity>>;
sys?: {
type: "Array";
};
};
}
Hierarchy (view full)
- MakeRequestPayload
- BulkActionUnpublishPayload
Index
Properties
entities
+
Interface BulkActionValidatePayload
Base interface for all Payload interfaces. Used as part of the MakeRequestOptions to simplify payload definitions.
-interface BulkActionValidatePayload {
action?: "publish";
entities: {
items: Collection<Link<Entity>>;
sys?: {
type: "Array";
};
};
}
action?: "publish";
entities: {
items: Collection<Link<Entity>>;
sys?: {
type: "Array";
};
};
}
Hierarchy (view full)
- MakeRequestPayload
- BulkActionValidatePayload
Index
Properties
action?
+BulkActionValidatePayload | contentful-management.js - v11.40.3
Interface BulkActionValidatePayload
Base interface for all Payload interfaces. Used as part of the MakeRequestOptions to simplify payload definitions.
+interface BulkActionValidatePayload {
action?: "publish";
entities: {
items: Collection<Link<Entity>>;
sys?: {
type: "Array";
};
};
}
action?: "publish";
entities: {
items: Collection<Link<Entity>>;
sys?: {
type: "Array";
};
};
}
Hierarchy (view full)
- MakeRequestPayload
- BulkActionValidatePayload
Interface Collection<T, TPlain>
interface Collection<T, TPlain> {
items: T[];
limit: number;
skip: number;
sys: {
type: "Array";
};
total: number;
toPlainObject(): CollectionProp<TPlain>;
}
items: T[];
limit: number;
skip: number;
sys: {
type: "Array";
};
total: number;
toPlainObject(): CollectionProp<TPlain>;
}
Type Parameters
Hierarchy (view full)
- CollectionProp<T>
- DefaultElements<CollectionProp<TPlain>>
- Collection
Index
Properties
items
+Collection | contentful-management.js - v11.40.3
to
Interface Collection<T, TPlain>
interface Collection<T, TPlain> {
items: T[];
limit: number;
skip: number;
sys: {
type: "Array";
};
total: number;
toPlainObject(): CollectionProp<TPlain>;
}
items: T[];
limit: number;
skip: number;
sys: {
type: "Array";
};
total: number;
toPlainObject(): CollectionProp<TPlain>;
}
Type Parameters
Hierarchy (view full)
- CollectionProp<T>
- DefaultElements<CollectionProp<TPlain>>
- Collection
Methods
to
- to
Plain Object(): CollectionProp<TPlain> Returns CollectionProp<TPlain>
Methods
to
- to
Plain Object(): CollectionProp<TPlain> Returns CollectionProp<TPlain>
Interface CollectionProp<TObj>
interface CollectionProp<TObj> {
items: TObj[];
limit: number;
skip: number;
sys: {
type: "Array";
};
total: number;
}
items: TObj[];
limit: number;
skip: number;
sys: {
type: "Array";
};
total: number;
}
Type Parameters
Hierarchy (view full)
- CollectionProp
Index
Properties
items
+CollectionProp | contentful-management.js - v11.40.3
Interface Comment
interface Comment {
body: string;
status: CommentStatus;
sys: CommentSysProps;
delete(): Promise<void>;
toPlainObject(): CommentProps;
update(): Promise<Comment | RichTextComment>;
}
body: string;
status: CommentStatus;
sys: CommentSysProps;
delete(): Promise<void>;
toPlainObject(): CommentProps;
update(): Promise<Comment | RichTextComment>;
}
Hierarchy (view full)
- CommentProps
- DefaultElements<CommentProps>
- CommentApi
- Comment
Index
Properties
body
+Comment | contentful-management.js - v11.40.3
to
Interface Comment
interface Comment {
body: string;
status: CommentStatus;
sys: CommentSysProps;
delete(): Promise<void>;
toPlainObject(): CommentProps;
update(): Promise<Comment | RichTextComment>;
}
body: string;
status: CommentStatus;
sys: CommentSysProps;
delete(): Promise<void>;
toPlainObject(): CommentProps;
update(): Promise<Comment | RichTextComment>;
}
Hierarchy (view full)
- CommentProps
- DefaultElements<CommentProps>
- CommentApi
- Comment
Methods
delete
to
- to
Plain Object(): CommentProps Returns CommentProps
update
Methods
delete
to
- to
Plain Object(): CommentProps Returns CommentProps
update
Interface ContentFields<T>
interface ContentFields<T> {
allowedResources?: ContentTypeAllowedResources[];
apiName?: string;
defaultValue?: T;
deleted?: boolean;
disabled?: boolean;
id: string;
items?: Item;
linkType?: string;
localized: boolean;
name: string;
omitted?: boolean;
required: boolean;
type: string;
validations?: ContentTypeFieldValidation[];
}
allowedResources?: ContentTypeAllowedResources[];
apiName?: string;
defaultValue?: T;
deleted?: boolean;
disabled?: boolean;
id: string;
items?: Item;
linkType?: string;
localized: boolean;
name: string;
omitted?: boolean;
required: boolean;
type: string;
validations?: ContentTypeFieldValidation[];
}
Type Parameters
- T = KeyValueMap
Hierarchy
- Item
- ContentFields
Index
Properties
allowedContentFields | contentful-management.js - v11.40.3
Interface ContentFields<T>
interface ContentFields<T> {
allowedResources?: ContentTypeAllowedResources[];
apiName?: string;
defaultValue?: T;
deleted?: boolean;
disabled?: boolean;
id: string;
items?: Item;
linkType?: string;
localized: boolean;
name: string;
omitted?: boolean;
required: boolean;
type: string;
validations?: ContentTypeFieldValidation[];
}
allowedResources?: ContentTypeAllowedResources[];
apiName?: string;
defaultValue?: T;
deleted?: boolean;
disabled?: boolean;
id: string;
items?: Item;
linkType?: string;
localized: boolean;
name: string;
omitted?: boolean;
required: boolean;
type: string;
validations?: ContentTypeFieldValidation[];
}
Type Parameters
- T = KeyValueMap
Hierarchy
- Item
- ContentFields
Index
Properties
Properties
Optionalallowed
allowed
Optionalapi
api
Optionaldefault
Optionaldeleted
deleted?: boolean
Optionaldisabled
disabled?: boolean
id
id: string
Optionalitems
items?: Item
Optionallink
link
localized
localized: boolean
name
name: string
Optionalomitted
omitted?: boolean
required
required: boolean
type
type: string
Optionalvalidations
Properties
Optionalallowed
allowed
Optionalapi
api
Optionaldefault
Optionaldeleted
deleted?: boolean
Optionaldisabled
disabled?: boolean
id
id: string
Optionalitems
items?: Item
Optionallink
link
localized
localized: boolean
name
name: string
Optionalomitted
omitted?: boolean
required
required: boolean
type
type: string
Optionalvalidations
Interface ContentType
interface ContentType {
description: string;
displayField: string;
fields: ContentFields<KeyValueMap>[];
metadata?: ContentTypeMetadata;
name: string;
sys: BasicMetaSysProps & {
environment: SysLink;
firstPublishedAt?: string;
publishedCounter?: number;
publishedVersion?: number;
space: SysLink;
};
delete(): Promise<void>;
getEditorInterface(): Promise<EditorInterface>;
getSnapshot(snapshotId: string): Promise<SnapshotProps<ContentTypeProps>>;
getSnapshots(): Promise<Collection<Snapshot<ContentTypeProps>, SnapshotProps<ContentTypeProps>>>;
isDraft(): boolean;
isPublished(): boolean;
isUpdated(): boolean;
omitAndDeleteField(id: string): Promise<ContentType>;
publish(): Promise<ContentType>;
toPlainObject(): ContentTypeProps;
unpublish(): Promise<ContentType>;
update(): Promise<ContentType>;
}
description: string;
displayField: string;
fields: ContentFields<KeyValueMap>[];
metadata?: ContentTypeMetadata;
name: string;
sys: BasicMetaSysProps & {
environment: SysLink;
firstPublishedAt?: string;
publishedCounter?: number;
publishedVersion?: number;
space: SysLink;
};
delete(): Promise<void>;
getEditorInterface(): Promise<EditorInterface>;
getSnapshot(snapshotId: string): Promise<SnapshotProps<ContentTypeProps>>;
getSnapshots(): Promise<Collection<Snapshot<ContentTypeProps>, SnapshotProps<ContentTypeProps>>>;
isDraft(): boolean;
isPublished(): boolean;
isUpdated(): boolean;
omitAndDeleteField(id: string): Promise<ContentType>;
publish(): Promise<ContentType>;
toPlainObject(): ContentTypeProps;
unpublish(): Promise<ContentType>;
update(): Promise<ContentType>;
}
Hierarchy (view full)
- ContentTypeProps
- DefaultElements<ContentTypeProps>
- ContentTypeApi
- ContentType
Index
Properties
description
+ContentType | contentful-management.js - v11.40.3
display
display
get
get
Interface ContentType
interface ContentType {
description: string;
displayField: string;
fields: ContentFields<KeyValueMap>[];
metadata?: ContentTypeMetadata;
name: string;
sys: BasicMetaSysProps & {
environment: SysLink;
firstPublishedAt?: string;
publishedCounter?: number;
publishedVersion?: number;
space: SysLink;
};
delete(): Promise<void>;
getEditorInterface(): Promise<EditorInterface>;
getSnapshot(snapshotId: string): Promise<SnapshotProps<ContentTypeProps>>;
getSnapshots(): Promise<Collection<Snapshot<ContentTypeProps>, SnapshotProps<ContentTypeProps>>>;
isDraft(): boolean;
isPublished(): boolean;
isUpdated(): boolean;
omitAndDeleteField(id: string): Promise<ContentType>;
publish(): Promise<ContentType>;
toPlainObject(): ContentTypeProps;
unpublish(): Promise<ContentType>;
update(): Promise<ContentType>;
}
description: string;
displayField: string;
fields: ContentFields<KeyValueMap>[];
metadata?: ContentTypeMetadata;
name: string;
sys: BasicMetaSysProps & {
environment: SysLink;
firstPublishedAt?: string;
publishedCounter?: number;
publishedVersion?: number;
space: SysLink;
};
delete(): Promise<void>;
getEditorInterface(): Promise<EditorInterface>;
getSnapshot(snapshotId: string): Promise<SnapshotProps<ContentTypeProps>>;
getSnapshots(): Promise<Collection<Snapshot<ContentTypeProps>, SnapshotProps<ContentTypeProps>>>;
isDraft(): boolean;
isPublished(): boolean;
isUpdated(): boolean;
omitAndDeleteField(id: string): Promise<ContentType>;
publish(): Promise<ContentType>;
toPlainObject(): ContentTypeProps;
unpublish(): Promise<ContentType>;
update(): Promise<ContentType>;
}
Hierarchy (view full)
- ContentTypeProps
- DefaultElements<ContentTypeProps>
- ContentTypeApi
- ContentType
Index
Properties
Properties
description
description: string
display
display
Field used as the main display field for Entries
-fields
All the fields contained in this Content Type
-Optionalmetadata
name
name: string
sys
sys: BasicMetaSysProps & {
environment: SysLink;
firstPublishedAt?: string;
publishedCounter?: number;
publishedVersion?: number;
space: SysLink;
}
environment: SysLink;
firstPublishedAt?: string;
publishedCounter?: number;
publishedVersion?: number;
space: SysLink;
}
Properties
description
description: string
display
display
Field used as the main display field for Entries
+fields
All the fields contained in this Content Type
+Optionalmetadata
name
name: string
sys
sys: BasicMetaSysProps & {
environment: SysLink;
firstPublishedAt?: string;
publishedCounter?: number;
publishedVersion?: number;
space: SysLink;
}
environment: SysLink;
firstPublishedAt?: string;
publishedCounter?: number;
publishedVersion?: number;
space: SysLink;
}
Methods
delete
get
- get
Editor Interface(): Promise<EditorInterface> Gets the editor interface for the object
+```" aria-label="Permalink" class="tsd-anchor-icon">
get
- get
Editor Interface(): Promise<EditorInterface> Gets the editor interface for the object
Important note: The editor interface only represent a published contentType.
To get the most recent representation of the contentType make sure to publish it firstReturns Promise<EditorInterface>
Object returned from the server with the current editor interface.
@@ -128,7 +128,7 @@ .then((contentType) => contentType.getEditorInterface()) .then((editorInterface) => console.log(editorInterface.contorls)) .catch(console.error) -```" aria-label="Permalink" class="tsd-anchor-icon">
get
- get
Snapshot(snapshotId): Promise<SnapshotProps<ContentTypeProps>> Gets a snapshot of a contentType
+```" aria-label="Permalink" class="tsd-anchor-icon">
get
- get
Snapshot(snapshotId): Promise<SnapshotProps<ContentTypeProps>> Gets a snapshot of a contentType
Parameters
- snapshotId: string
Id of the snapshot
Returns Promise<SnapshotProps<ContentTypeProps>>
- snapshotId: string
get
- get
Snapshots(): Promise<Collection<Snapshot<ContentTypeProps>, SnapshotProps<ContentTypeProps>>> Gets all snapshots of a contentType
+```" aria-label="Permalink" class="tsd-anchor-icon">
get
- get
Snapshots(): Promise<Collection<Snapshot<ContentTypeProps>, SnapshotProps<ContentTypeProps>>> Gets all snapshots of a contentType
Returns Promise<Collection<Snapshot<ContentTypeProps>, SnapshotProps<ContentTypeProps>>>
is
is
is
omit
- omit
And Delete Field(id): Promise<ContentType> Omits and deletes a field if it exists on the contentType. This is a convenience method which does both operations at once and potentially less +```" aria-label="Permalink" class="tsd-anchor-icon">
is
is
is
omit
- omit
And Delete Field(id): Promise<ContentType> Omits and deletes a field if it exists on the contentType. This is a convenience method which does both operations at once and potentially less safe than the standard way. See note about deleting fields on the Update method.
Parameters
- id: string
Returns Promise<ContentType>
Object returned from the server with updated metadata.
-
publish
- publish(): Promise<ContentType>
Publishes the object
+publish
- publish(): Promise<ContentType>
Publishes the object
Returns Promise<ContentType>
Object returned from the server with updated metadata.
to
Plain Object - to
Plain Object(): ContentTypeProps Returns ContentTypeProps
unpublish
- unpublish(): Promise<ContentType>
Unpublishes the object
+```" aria-label="Permalink" class="tsd-anchor-icon">
to
- to
Plain Object(): ContentTypeProps Returns ContentTypeProps
unpublish
- unpublish(): Promise<ContentType>
Unpublishes the object
Returns Promise<ContentType>
Object returned from the server with updated metadata.
update
- update(): Promise<ContentType>
Sends an update to the server with any changes made to the object's properties.
+```" aria-label="Permalink" class="tsd-anchor-icon">
update
- update(): Promise<ContentType>
Sends an update to the server with any changes made to the object's properties.
Important note about deleting fields: The standard way to delete a field is with two updates: first omit the property from your responses (set the field attribute "omitted" to true), and then delete it by setting the attribute "deleted" to true. See the "Deleting fields" section in the API reference for more reasoning. Alternatively, @@ -419,4 +419,4 @@ }) .then(contentType => console.log(contentType)) .catch(console.error) -```" aria-label="Permalink" class="tsd-anchor-icon">
Interface ContentTypeFieldValidation
interface ContentTypeFieldValidation {
assetFileSize?: NumRange;
assetImageDimensions?: {
height?: NumRange;
width?: NumRange;
};
dateRange?: DateRange;
enabledMarks?: string[];
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 | number)[];
linkContentType?: string[];
linkMimetypeGroup?: string[];
message?: null | string;
nodes?: NodesValidation;
prohibitRegexp?: RegExp;
range?: NumRange;
regexp?: RegExp;
size?: NumRange;
unique?: boolean;
}
assetFileSize?: NumRange;
assetImageDimensions?: {
height?: NumRange;
width?: NumRange;
};
dateRange?: DateRange;
enabledMarks?: string[];
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 | number)[];
linkContentType?: string[];
linkMimetypeGroup?: string[];
message?: null | string;
nodes?: NodesValidation;
prohibitRegexp?: RegExp;
range?: NumRange;
regexp?: RegExp;
size?: NumRange;
unique?: boolean;
}
Index
Properties
assetContentTypeFieldValidation | contentful-management.js - v11.40.3
Interface ContentTypeFieldValidation
interface ContentTypeFieldValidation {
assetFileSize?: NumRange;
assetImageDimensions?: {
height?: NumRange;
width?: NumRange;
};
dateRange?: DateRange;
enabledMarks?: string[];
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 | number)[];
linkContentType?: string[];
linkMimetypeGroup?: string[];
message?: null | string;
nodes?: NodesValidation;
prohibitRegexp?: RegExp;
range?: NumRange;
regexp?: RegExp;
size?: NumRange;
unique?: boolean;
}
assetFileSize?: NumRange;
assetImageDimensions?: {
height?: NumRange;
width?: NumRange;
};
dateRange?: DateRange;
enabledMarks?: string[];
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 | number)[];
linkContentType?: string[];
linkMimetypeGroup?: string[];
message?: null | string;
nodes?: NodesValidation;
prohibitRegexp?: RegExp;
range?: NumRange;
regexp?: RegExp;
size?: NumRange;
unique?: boolean;
}
Index
Properties
asset
Properties
Optionalasset
asset
Optionalasset
asset
height?: NumRange;
width?: NumRange;
}
height?: NumRange;
width?: NumRange;
}
Optionaldate
date
Optionalenabled
enabled
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 | number)[]
Optionallink
link
Optionallink
link
Optionalmessage
message?: null | string
Optionalnodes
nodes?: NodesValidation
Optionalprohibit
prohibit
Optionalrange
range?: NumRange
Optionalregexp
regexp?: RegExp
Optionalsize
size?: NumRange
Optionalunique
unique?: boolean
Properties
Optionalasset
asset
Optionalasset
asset
height?: NumRange;
width?: NumRange;
}
height?: NumRange;
width?: NumRange;
}
Optionaldate
date
Optionalenabled
enabled
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 | number)[]
Optionallink
link
Optionallink
link
Optionalmessage
message?: null | string
Optionalnodes
nodes?: NodesValidation
Optionalprohibit
prohibit
Optionalrange
range?: NumRange
Optionalregexp
regexp?: RegExp
Optionalsize
size?: NumRange
Optionalunique
unique?: boolean
Interface ContentTypeTemplateProps
interface ContentTypeTemplateProps {
basedOn?: {
contentType: Link<"ContentType">;
environment: Link<"Environment">;
space: Link<"Space">;
};
description: string;
displayField: string;
fields: ContentFields<KeyValueMap>[];
hints?: Hint[];
id: string;
metadata?: ContentTypeMetadata;
name: string;
}
basedOn?: {
contentType: Link<"ContentType">;
environment: Link<"Environment">;
space: Link<"Space">;
};
description: string;
displayField: string;
fields: ContentFields<KeyValueMap>[];
hints?: Hint[];
id: string;
metadata?: ContentTypeMetadata;
name: string;
}
Hierarchy
- Omit<ContentTypeProps, "sys">
- ContentTypeTemplateProps
Index
Properties
basedContentTypeTemplateProps | contentful-management.js - v11.40.3
Interface ContentTypeTemplateProps
interface ContentTypeTemplateProps {
basedOn?: {
contentType: Link<"ContentType">;
environment: Link<"Environment">;
space: Link<"Space">;
};
description: string;
displayField: string;
fields: ContentFields<KeyValueMap>[];
hints?: Hint[];
id: string;
metadata?: ContentTypeMetadata;
name: string;
}
basedOn?: {
contentType: Link<"ContentType">;
environment: Link<"Environment">;
space: Link<"Space">;
};
description: string;
displayField: string;
fields: ContentFields<KeyValueMap>[];
hints?: Hint[];
id: string;
metadata?: ContentTypeMetadata;
name: string;
}
Hierarchy
- Omit<ContentTypeProps, "sys">
- ContentTypeTemplateProps
Index
Properties
Interface ContentfulEntryResource
interface ContentfulEntryResource {
contentTypes: string[];
source: string;
type: "Contentful:Entry";
}
contentTypes: string[];
source: string;
type: "Contentful:Entry";
}
Index
Properties
contentContentfulEntryResource | contentful-management.js - v11.40.3
Interface ContentfulEntryResource
interface ContentfulEntryResource {
contentTypes: string[];
source: string;
type: "Contentful:Entry";
}
contentTypes: string[];
source: string;
type: "Contentful:Entry";
}
Index
Properties
Interface Control
interface Control {
fieldId: string;
settings?: DefinedParameters;
widgetId?: string;
widgetNamespace?: string;
}
fieldId: string;
settings?: DefinedParameters;
widgetId?: string;
widgetNamespace?: string;
}
Hierarchy
- WidgetConfig
- Control
Index
Properties
fieldControl | contentful-management.js - v11.40.3
Interface Control
interface Control {
fieldId: string;
settings?: DefinedParameters;
widgetId?: string;
widgetNamespace?: string;
}
fieldId: string;
settings?: DefinedParameters;
widgetId?: string;
widgetNamespace?: string;
}
Hierarchy
- WidgetConfig
- Control
Index
Properties
Optionalsettings
Instance parameter values
+Optionalwidget
widget
ID of the widget used
+Optionalwidget
widget
Type of the widget used
+Interface CursorPaginatedCollection<T, TPlain>
interface CursorPaginatedCollection<T, TPlain> {
items: T[];
limit: number;
pages?: {
next?: string;
prev?: string;
};
sys: {
type: "Array";
};
toPlainObject(): CursorPaginatedCollectionProp<TPlain>;
}
items: T[];
limit: number;
pages?: {
next?: string;
prev?: string;
};
sys: {
type: "Array";
};
toPlainObject(): CursorPaginatedCollectionProp<TPlain>;
}
Type Parameters
Hierarchy (view full)
- CursorPaginatedCollectionProp<T>
- DefaultElements<CursorPaginatedCollectionProp<TPlain>>
- CursorPaginatedCollection
Index
Properties
items
+CursorPaginatedCollection | contentful-management.js - v11.40.3
to
Interface CursorPaginatedCollection<T, TPlain>
interface CursorPaginatedCollection<T, TPlain> {
items: T[];
limit: number;
pages?: {
next?: string;
prev?: string;
};
sys: {
type: "Array";
};
toPlainObject(): CursorPaginatedCollectionProp<TPlain>;
}
items: T[];
limit: number;
pages?: {
next?: string;
prev?: string;
};
sys: {
type: "Array";
};
toPlainObject(): CursorPaginatedCollectionProp<TPlain>;
}
Type Parameters
Hierarchy (view full)
- CursorPaginatedCollectionProp<T>
- DefaultElements<CursorPaginatedCollectionProp<TPlain>>
- CursorPaginatedCollection
Index
Properties
Methods
Properties
items
limit
limit: number
Optionalpages
pages?: {
next?: string;
prev?: string;
}
next?: string;
prev?: string;
}
sys
sys: {
type: "Array";
}
type: "Array";
}
Methods
to
- to
Plain Object(): CursorPaginatedCollectionProp<TPlain> Returns CursorPaginatedCollectionProp<TPlain>
Properties
items
limit
limit: number
Optionalpages
pages?: {
next?: string;
prev?: string;
}
next?: string;
prev?: string;
}
sys
sys: {
type: "Array";
}
type: "Array";
}
Methods
to
- to
Plain Object(): CursorPaginatedCollectionProp<TPlain> Returns CursorPaginatedCollectionProp<TPlain>
Interface CursorPaginatedCollectionProp<TObj>
interface CursorPaginatedCollectionProp<TObj> {
items: TObj[];
limit: number;
pages?: {
next?: string;
prev?: string;
};
sys: {
type: "Array";
};
}
items: TObj[];
limit: number;
pages?: {
next?: string;
prev?: string;
};
sys: {
type: "Array";
};
}
Type Parameters
Hierarchy (view full)
- Omit<CollectionProp<TObj>, "total" | "skip">
- CursorPaginatedCollectionProp
Index
Properties
items
+CursorPaginatedCollectionProp | contentful-management.js - v11.40.3
Interface CursorPaginatedCollectionProp<TObj>
interface CursorPaginatedCollectionProp<TObj> {
items: TObj[];
limit: number;
pages?: {
next?: string;
prev?: string;
};
sys: {
type: "Array";
};
}
items: TObj[];
limit: number;
pages?: {
next?: string;
prev?: string;
};
sys: {
type: "Array";
};
}
Type Parameters
Hierarchy (view full)
- Omit<CollectionProp<TObj>, "total" | "skip">
- CursorPaginatedCollectionProp
Interface DefaultElements<TPlainObject>
Type Parameters
Hierarchy (view full)
- DefaultElements
- AccessToken
- ApiKey
- AppAccessToken
- AppActionCall
- AppBundle
- AppDetails
- AppEventSubscription
- AppInstallation
- AppKey
- AppSignedRequest
- AppSigningSecret
- AppUpload
- Asset
- AssetKey
- BulkAction
- Comment
- ContentType
- EditorInterface
- Entry
- EnvironmentAlias
- UIExtension
- Locale
- OrganizationInvitation
- OrganizationMembership
- PersonalAccessToken
- PreviewApiKey
- Release
- ReleaseAction
- Role
- ScheduledAction
- Snapshot
- SpaceMember
- SpaceMembership
- Tag
- Task
- Team
- TeamMembership
- TeamSpaceMembership
- UIConfig
- Upload
- UploadCredential
- Usage
- User
- UserUIConfig
- WebHooks
- WorkflowDefinition
- ResourceProvider
- ResourceType
- Workflow
- WorkflowsChangelogEntry
- Collection
- CursorPaginatedCollection
Index
Methods
Methods
to
- to
Plain Object(): TPlainObject Returns TPlainObject
Interface DefaultElements<TPlainObject>
Type Parameters
Hierarchy (view full)
- DefaultElements
- AccessToken
- ApiKey
- AppAccessToken
- AppActionCall
- AppBundle
- AppDetails
- AppEventSubscription
- AppInstallation
- AppKey
- AppSignedRequest
- AppSigningSecret
- AppUpload
- Asset
- AssetKey
- BulkAction
- Comment
- ContentType
- EditorInterface
- Entry
- EnvironmentAlias
- UIExtension
- Locale
- OrganizationInvitation
- OrganizationMembership
- PersonalAccessToken
- PreviewApiKey
- Release
- ReleaseAction
- Role
- ScheduledAction
- Snapshot
- SpaceMember
- SpaceMembership
- Tag
- Task
- Team
- TeamMembership
- TeamSpaceMembership
- UIConfig
- Upload
- UploadCredential
- Usage
- User
- UserUIConfig
- WebHooks
- WorkflowDefinition
- ResourceProvider
- ResourceType
- Workflow
- WorkflowsChangelogEntry
- Collection
- CursorPaginatedCollection
Index
Methods
Methods
to
- to
Plain Object(): TPlainObject Returns TPlainObject
Interface Editor
interface Editor {
disabled?: boolean;
settings?: DefinedParameters;
widgetId: string;
widgetNamespace: string;
}
disabled?: boolean;
settings?: DefinedParameters;
widgetId: string;
widgetNamespace: string;
}
Index
Properties
disabled?
+Editor | contentful-management.js - v11.40.3
Interface Editor
interface Editor {
disabled?: boolean;
settings?: DefinedParameters;
widgetId: string;
widgetNamespace: string;
}
disabled?: boolean;
settings?: DefinedParameters;
widgetId: string;
widgetNamespace: string;
}
Index
Properties
Optionalsettings
Instance parameter values
+widget
widget
ID of the widget used
+widget
widget
Type of the widget used
+Interface EditorInterface
interface EditorInterface {
controls?: Control[];
editor?: Editor;
editorLayout?: FieldGroupItem[];
editors?: Editor[];
groupControls?: GroupControl[];
sidebar?: SidebarItem[];
sys: MetaSysProps & {
contentType: {
sys: MetaLinkProps;
};
environment: {
sys: MetaLinkProps;
};
space: {
sys: MetaLinkProps;
};
};
getControlForField(id: string): null | Control;
toPlainObject(): EditorInterfaceProps;
update(): Promise<EditorInterface>;
}
controls?: Control[];
editor?: Editor;
editorLayout?: FieldGroupItem[];
editors?: Editor[];
groupControls?: GroupControl[];
sidebar?: SidebarItem[];
sys: MetaSysProps & {
contentType: {
sys: MetaLinkProps;
};
environment: {
sys: MetaLinkProps;
};
space: {
sys: MetaLinkProps;
};
};
getControlForField(id: string): null | Control;
toPlainObject(): EditorInterfaceProps;
update(): Promise<EditorInterface>;
}
Hierarchy (view full)
- EditorInterfaceProps
- DefaultElements<EditorInterfaceProps>
- EditorInterface
Index
Properties
controls?
+EditorInterface | contentful-management.js - v11.40.3
get
get
to
diff --git a/contentful-management/latest/interfaces/EditorInterfaceTemplateProps.html b/contentful-management/latest/interfaces/EditorInterfaceTemplateProps.html
index d043d2af4f..b7b6e3f15d 100644
--- a/contentful-management/latest/interfaces/EditorInterfaceTemplateProps.html
+++ b/contentful-management/latest/interfaces/EditorInterfaceTemplateProps.html
@@ -1,14 +1,14 @@
-Interface EditorInterface
interface EditorInterface {
controls?: Control[];
editor?: Editor;
editorLayout?: FieldGroupItem[];
editors?: Editor[];
groupControls?: GroupControl[];
sidebar?: SidebarItem[];
sys: MetaSysProps & {
contentType: {
sys: MetaLinkProps;
};
environment: {
sys: MetaLinkProps;
};
space: {
sys: MetaLinkProps;
};
};
getControlForField(id: string): null | Control;
toPlainObject(): EditorInterfaceProps;
update(): Promise<EditorInterface>;
}
controls?: Control[];
editor?: Editor;
editorLayout?: FieldGroupItem[];
editors?: Editor[];
groupControls?: GroupControl[];
sidebar?: SidebarItem[];
sys: MetaSysProps & {
contentType: {
sys: MetaLinkProps;
};
environment: {
sys: MetaLinkProps;
};
space: {
sys: MetaLinkProps;
};
};
getControlForField(id: string): null | Control;
toPlainObject(): EditorInterfaceProps;
update(): Promise<EditorInterface>;
}
Hierarchy (view full)
- EditorInterfaceProps
- DefaultElements<EditorInterfaceProps>
- EditorInterface
Index
Properties
Properties
Optionalcontrols
Array of fields and their associated widgetId
-Optionaleditor
Legacy singular editor override
-Optionaleditor
Array of editor layout field groups
-Optionaleditors
Array of editors. Defaults will be used if property is missing.
-Optionalgroup
Array of field groups and their associated widgetId
-Optionalsidebar
Array of sidebar widgets. Defaults will be used if property is missing.
-sys
sys: MetaSysProps & {
contentType: {
sys: MetaLinkProps;
};
environment: {
sys: MetaLinkProps;
};
space: {
sys: MetaLinkProps;
};
}
contentType: {
sys: MetaLinkProps;
};
environment: {
sys: MetaLinkProps;
};
space: {
sys: MetaLinkProps;
};
}
Methods
get
- get
Control For Field(id): null | Control Gets a control for a specific field
+
Optionaleditor
Legacy singular editor override
+Optionaleditor
Array of editor layout field groups
+Optionaleditors
Array of editors. Defaults will be used if property is missing.
+Optionalgroup
Array of field groups and their associated widgetId
+Optionalsidebar
Array of sidebar widgets. Defaults will be used if property is missing.
+sys
sys: MetaSysProps & {
contentType: {
sys: MetaLinkProps;
};
environment: {
sys: MetaLinkProps;
};
space: {
sys: MetaLinkProps;
};
}
contentType: {
sys: MetaLinkProps;
};
environment: {
sys: MetaLinkProps;
};
space: {
sys: MetaLinkProps;
};
}
Methods
get
- get
Control For Field(id): null | Control Gets a control for a specific field
Parameters
- id: string
Returns null | Control
control object for specific field
-const contentful = require('contentful-management')
const client = contentful.createClient({
accessToken: '<content_management_api_key>'
})
client.getSpace('<space_id>')
.then((space) => space.getEnvironment('<environment_id>'))
.then((environment) => environment.getContentType('<contentType_id>'))
.then((contentType) => contentType.getEditorInterface())
.then((editorInterface) => {
control = editorInterface.getControlForField('<field-id>')
console.log(control)
})
.catch(console.error)
to
- to
Plain Object(): EditorInterfaceProps Returns EditorInterfaceProps
update
- update(): Promise<EditorInterface>
Sends an update to the server with any changes made to the object's properties
+to
Plain Object - to
Plain Object(): EditorInterfaceProps Returns EditorInterfaceProps
update
- update(): Promise<EditorInterface>
Sends an update to the server with any changes made to the object's properties
Returns Promise<EditorInterface>
Object returned from the server with updated changes.
-const contentful = require('contentful-management')
const client = contentful.createClient({
accessToken: '<content_management_api_key>'
})
client.getSpace('<space_id>')
.then((space) => space.getEnvironment('<environment_id>'))
.then((environment) => environment.getContentType('<contentType_id>'))
.then((contentType) => contentType.getEditorInterface())
.then((editorInterface) => {
editorInterface.controls[0] = { "fieldId": "title", "widgetId": "singleLine"}
editorInterface.editors = [
{ "widgetId": "custom-widget", "widgetNamespace": "app" }
]
return editorInterface.update()
})
.catch(console.error)
- to
Interface EditorInterfaceTemplateProps
interface EditorInterfaceTemplateProps {
contentTypeTemplate: Link<"ContentTypeTemplate">;
controls?: Control[];
editor?: Editor;
editorLayout?: FieldGroupItem[];
editors?: Editor[];
groupControls?: GroupControl[];
sidebar?: SidebarItem[];
}
contentTypeTemplate: Link<"ContentTypeTemplate">;
controls?: Control[];
editor?: Editor;
editorLayout?: FieldGroupItem[];
editors?: Editor[];
groupControls?: GroupControl[];
sidebar?: SidebarItem[];
}
Hierarchy
- Omit<EditorInterfaceProps, "sys">
- EditorInterfaceTemplateProps
Index
Properties
contentEditorInterfaceTemplateProps | contentful-management.js - v11.40.3
content
Interface EditorInterfaceTemplateProps
interface EditorInterfaceTemplateProps {
contentTypeTemplate: Link<"ContentTypeTemplate">;
controls?: Control[];
editor?: Editor;
editorLayout?: FieldGroupItem[];
editors?: Editor[];
groupControls?: GroupControl[];
sidebar?: SidebarItem[];
}
contentTypeTemplate: Link<"ContentTypeTemplate">;
controls?: Control[];
editor?: Editor;
editorLayout?: FieldGroupItem[];
editors?: Editor[];
groupControls?: GroupControl[];
sidebar?: SidebarItem[];
}
Hierarchy
- Omit<EditorInterfaceProps, "sys">
- EditorInterfaceTemplateProps
Index
Properties
content
Optionalcontrols
Array of fields and their associated widgetId
-Optionaleditor
Legacy singular editor override
-Optionaleditor
Array of editor layout field groups
-Optionaleditors
Array of editors. Defaults will be used if property is missing.
-Optionalgroup
Array of field groups and their associated widgetId
-Optionalsidebar
Array of sidebar widgets. Defaults will be used if property is missing.
- Properties
content
Optionalcontrols
Array of fields and their associated widgetId
+Optionaleditor
Legacy singular editor override
+Optionaleditor
Array of editor layout field groups
+Optionaleditors
Array of editors. Defaults will be used if property is missing.
+Optionalgroup
Array of field groups and their associated widgetId
+Optionalsidebar
Array of sidebar widgets. Defaults will be used if property is missing.
+Interface EntityMetaSysProps
interface EntityMetaSysProps {
archivedAt?: string;
archivedBy?: SysLink;
archivedVersion?: number;
contentType: SysLink;
createdAt: string;
createdBy?: SysLink;
deletedAt?: string;
deletedBy?: SysLink;
deletedVersion?: number;
environment: SysLink;
firstPublishedAt?: string;
id: string;
locale?: string;
publishedAt?: string;
publishedBy?: Link<"User"> | Link<"AppDefinition">;
publishedCounter?: number;
publishedVersion?: number;
space: SysLink;
status?: SysLink;
type: string;
updatedAt: string;
updatedBy?: SysLink;
version: number;
}
archivedAt?: string;
archivedBy?: SysLink;
archivedVersion?: number;
contentType: SysLink;
createdAt: string;
createdBy?: SysLink;
deletedAt?: string;
deletedBy?: SysLink;
deletedVersion?: number;
environment: SysLink;
firstPublishedAt?: string;
id: string;
locale?: string;
publishedAt?: string;
publishedBy?: Link<"User"> | Link<"AppDefinition">;
publishedCounter?: number;
publishedVersion?: number;
space: SysLink;
status?: SysLink;
type: string;
updatedAt: string;
updatedBy?: SysLink;
version: number;
}
Hierarchy (view full)
- MetaSysProps
- EntityMetaSysProps
Index
Properties
archivedEntityMetaSysProps | contentful-management.js - v11.40.3
content
content
created
created
updated
Interface EntityMetaSysProps
interface EntityMetaSysProps {
archivedAt?: string;
archivedBy?: SysLink;
archivedVersion?: number;
contentType: SysLink;
createdAt: string;
createdBy?: SysLink;
deletedAt?: string;
deletedBy?: SysLink;
deletedVersion?: number;
environment: SysLink;
firstPublishedAt?: string;
id: string;
locale?: string;
publishedAt?: string;
publishedBy?: Link<"User"> | Link<"AppDefinition">;
publishedCounter?: number;
publishedVersion?: number;
space: SysLink;
status?: SysLink;
type: string;
updatedAt: string;
updatedBy?: SysLink;
version: number;
}
archivedAt?: string;
archivedBy?: SysLink;
archivedVersion?: number;
contentType: SysLink;
createdAt: string;
createdBy?: SysLink;
deletedAt?: string;
deletedBy?: SysLink;
deletedVersion?: number;
environment: SysLink;
firstPublishedAt?: string;
id: string;
locale?: string;
publishedAt?: string;
publishedBy?: Link<"User"> | Link<"AppDefinition">;
publishedCounter?: number;
publishedVersion?: number;
space: SysLink;
status?: SysLink;
type: string;
updatedAt: string;
updatedBy?: SysLink;
version: number;
}
Hierarchy (view full)
- MetaSysProps
- EntityMetaSysProps
Index
Properties
archived
Properties
Optionalarchived
archived
Optionalarchived
Optionalarchived
archived
content
Properties
Optionalarchived
archived
Optionalarchived
Optionalarchived
archived
content
created
created
Optionalcreated
Optionaldeleted
deleted
Optionaldeleted
Optionaldeleted
deleted
environment
Optionalfirst
first
id
id: string
Optionallocale
locale?: string
Optionalpublished
published
Optionalpublished
Optionalpublished
published
Optionalpublished
published
space
Optionalstatus
created
created
Optionalcreated
Optionaldeleted
deleted
Optionaldeleted
Optionaldeleted
deleted
environment
Optionalfirst
first
id
id: string
Optionallocale
locale?: string
Optionalpublished
published
Optionalpublished
Optionalpublished
published
Optionalpublished
published
space
Optionalstatus
type
type: string
updated
updated
Optionalupdated
version
version: number
type
type: string
updated
updated
Optionalupdated
version
version: number
Interface Entry
interface Entry {
archive: (() => Promise<Entry>);
createComment: ((data: CreateCommentProps) => Promise<Comment | RichTextComment>);
createTask: ((data: CreateTaskProps) => Promise<Task>);
delete: (() => Promise<any>);
fields: KeyValueMap;
getComment: ((id: string) => Promise<Comment | RichTextComment>);
getComments: (() => Promise<Collection<Comment | RichTextComment, CommentProps | RichTextCommentProps>>);
getSnapshot: ((snapshotId: string) => Promise<Snapshot<EntryProps>>);
getSnapshots: ((query?: {}) => Promise<Collection<Snapshot<EntryProps>, SnapshotProps<EntryProps>>>);
getTask: ((id: string) => Promise<Task>);
getTasks: ((query?: {}) => Promise<Collection<Task, TaskProps>>);
isArchived: (() => boolean);
isDraft: (() => boolean);
isPublished: (() => boolean);
isUpdated: (() => boolean);
metadata?: MetadataProps;
patch: ((ops: OpPatch[]) => Promise<Entry>);
publish: (() => Promise<Entry>);
references: ((options?: EntryReferenceOptionsProps) => Promise<Collection<Entry, EntryProps<KeyValueMap>>>);
sys: EntryMetaSysProps;
unarchive: (() => Promise<Entry>);
unpublish: (() => Promise<Entry>);
update: (() => Promise<Entry>);
toPlainObject(): EntryProps<KeyValueMap>;
}
archive: (() => Promise<Entry>);
createComment: ((data: CreateCommentProps) => Promise<Comment | RichTextComment>);
createTask: ((data: CreateTaskProps) => Promise<Task>);
delete: (() => Promise<any>);
fields: KeyValueMap;
getComment: ((id: string) => Promise<Comment | RichTextComment>);
getComments: (() => Promise<Collection<Comment | RichTextComment, CommentProps | RichTextCommentProps>>);
getSnapshot: ((snapshotId: string) => Promise<Snapshot<EntryProps>>);
getSnapshots: ((query?: {}) => Promise<Collection<Snapshot<EntryProps>, SnapshotProps<EntryProps>>>);
getTask: ((id: string) => Promise<Task>);
getTasks: ((query?: {}) => Promise<Collection<Task, TaskProps>>);
isArchived: (() => boolean);
isDraft: (() => boolean);
isPublished: (() => boolean);
isUpdated: (() => boolean);
metadata?: MetadataProps;
patch: ((ops: OpPatch[]) => Promise<Entry>);
publish: (() => Promise<Entry>);
references: ((options?: EntryReferenceOptionsProps) => Promise<Collection<Entry, EntryProps<KeyValueMap>>>);
sys: EntryMetaSysProps;
unarchive: (() => Promise<Entry>);
unpublish: (() => Promise<Entry>);
update: (() => Promise<Entry>);
toPlainObject(): EntryProps<KeyValueMap>;
}
Hierarchy (view full)
- EntryProps
- DefaultElements<EntryProps>
- ContentfulEntryApi
- Entry
Index
Properties
archive
+Entry | contentful-management.js - v11.40.3
create
create
create
create
Interface Entry
interface Entry {
archive: (() => Promise<Entry>);
createComment: ((data: CreateCommentProps) => Promise<Comment | RichTextComment>);
createTask: ((data: CreateTaskProps) => Promise<Task>);
delete: (() => Promise<any>);
fields: KeyValueMap;
getComment: ((id: string) => Promise<Comment | RichTextComment>);
getComments: (() => Promise<Collection<Comment | RichTextComment, CommentProps | RichTextCommentProps>>);
getSnapshot: ((snapshotId: string) => Promise<Snapshot<EntryProps>>);
getSnapshots: ((query?: {}) => Promise<Collection<Snapshot<EntryProps>, SnapshotProps<EntryProps>>>);
getTask: ((id: string) => Promise<Task>);
getTasks: ((query?: {}) => Promise<Collection<Task, TaskProps>>);
isArchived: (() => boolean);
isDraft: (() => boolean);
isPublished: (() => boolean);
isUpdated: (() => boolean);
metadata?: MetadataProps;
patch: ((ops: OpPatch[]) => Promise<Entry>);
publish: (() => Promise<Entry>);
references: ((options?: EntryReferenceOptionsProps) => Promise<Collection<Entry, EntryProps<KeyValueMap>>>);
sys: EntryMetaSysProps;
unarchive: (() => Promise<Entry>);
unpublish: (() => Promise<Entry>);
update: (() => Promise<Entry>);
toPlainObject(): EntryProps<KeyValueMap>;
}
archive: (() => Promise<Entry>);
createComment: ((data: CreateCommentProps) => Promise<Comment | RichTextComment>);
createTask: ((data: CreateTaskProps) => Promise<Task>);
delete: (() => Promise<any>);
fields: KeyValueMap;
getComment: ((id: string) => Promise<Comment | RichTextComment>);
getComments: (() => Promise<Collection<Comment | RichTextComment, CommentProps | RichTextCommentProps>>);
getSnapshot: ((snapshotId: string) => Promise<Snapshot<EntryProps>>);
getSnapshots: ((query?: {}) => Promise<Collection<Snapshot<EntryProps>, SnapshotProps<EntryProps>>>);
getTask: ((id: string) => Promise<Task>);
getTasks: ((query?: {}) => Promise<Collection<Task, TaskProps>>);
isArchived: (() => boolean);
isDraft: (() => boolean);
isPublished: (() => boolean);
isUpdated: (() => boolean);
metadata?: MetadataProps;
patch: ((ops: OpPatch[]) => Promise<Entry>);
publish: (() => Promise<Entry>);
references: ((options?: EntryReferenceOptionsProps) => Promise<Collection<Entry, EntryProps<KeyValueMap>>>);
sys: EntryMetaSysProps;
unarchive: (() => Promise<Entry>);
unpublish: (() => Promise<Entry>);
update: (() => Promise<Entry>);
toPlainObject(): EntryProps<KeyValueMap>;
}
Hierarchy (view full)
- EntryProps
- DefaultElements<EntryProps>
- ContentfulEntryApi
- Entry
Index
Properties
archive
create
create
Creates a new comment for an entry
+```" aria-label="Permalink" class="tsd-anchor-icon">create
Creates a new comment for an entry
Type declaration
- (data): Promise<Comment | RichTextComment>
Parameters
- data: CreateCommentProps
Object representation of the Comment to be created
Returns Promise<Comment | RichTextComment>
Promise for the newly created Comment
- data: CreateCommentProps
create
Creates a new task for an entry
+```" aria-label="Permalink" class="tsd-anchor-icon">create
Creates a new task for an entry
Type declaration
- (data): Promise<Task>
Parameters
- data: CreateTaskProps
Object representation of the Task to be created
Returns Promise<Task>
Promise for the newly created Task
- data: CreateTaskProps
delete
delete: (() => Promise<any>) = ...
Deletes this object on the server.
+```" aria-label="Permalink" class="tsd-anchor-icon">delete
delete: (() => Promise<any>) = ...
Deletes this object on the server.
Type declaration
- (): Promise<any>
Returns Promise<any>
Promise for the deletion. It contains no data, but the Promise error case should be handled.
fields
get
Gets a comment of an entry
+```" aria-label="Permalink" class="tsd-anchor-icon">fields
get
Gets a comment of an entry
get
get
Gets all comments of an entry
+get
get
Gets all comments of an entry
Type declaration
- (): Promise<Collection<Comment | RichTextComment, CommentProps | RichTextCommentProps>>
Returns Promise<Collection<Comment | RichTextComment, CommentProps | RichTextCommentProps>>
const contentful = require('contentful-management')
const client = contentful.createClient({ accessToken: '<content_management_api_key>' @@ -292,7 +292,7 @@
-
get
Gets a snapshot of an entry
+get
Gets a snapshot of an entry
Type declaration
- (snapshotId): Promise<Snapshot<EntryProps>>
Parameters
- snapshotId: string
Id of the snapshot
Returns Promise<Snapshot<EntryProps>>
- snapshotId: string
get
get
Gets all snapshots of an entry
+```" aria-label="Permalink" class="tsd-anchor-icon">get
get
Gets all snapshots of an entry
get
Gets a task of an entry
+```" aria-label="Permalink" class="tsd-anchor-icon">get
Gets a task of an entry
get
Gets all tasks of an entry
+get
Gets all tasks of an entry
Type declaration
- (query?): Promise<Collection<Task, TaskProps>>
Parameters
- query: {} = {}
Returns Promise<Collection<Task, TaskProps>>
const contentful = require('contentful-management')
const client = contentful.createClient({ accessToken: '<content_management_api_key>' @@ -427,11 +427,11 @@
-- query: {} = {}
is
is
Checks if entry is archived. This means it's not exposed to the Delivery/Preview APIs.
-is
is
Checks if the entry is in draft mode. This means it is not published.
-is
is
Checks if the entry is published. A published entry might have unpublished changes
-is
is
Checks if the entry is updated. This means the entry was previously published but has unpublished changes.
-Optionalmetadata
patch
Sends an JSON patch to the server with any changes made to the object's properties
+is
is
Checks if entry is archived. This means it's not exposed to the Delivery/Preview APIs.
+is
is
Checks if the entry is in draft mode. This means it is not published.
+is
is
Checks if the entry is published. A published entry might have unpublished changes
+is
is
Checks if the entry is updated. This means the entry was previously published but has unpublished changes.
+Optionalmetadata
patch
Sends an JSON patch to the server with any changes made to the object's properties
Type declaration
publish
Publishes the object
+```" aria-label="Permalink" class="tsd-anchor-icon">publish
Publishes the object
Type declaration
references
references: ((options?: EntryReferenceOptionsProps) => Promise<Collection<Entry, EntryProps<KeyValueMap>>>) = ...
Recursively collects references of an entry and their descendants
-sys
unarchive
Unarchives the object
+```" aria-label="Permalink" class="tsd-anchor-icon">references
references: ((options?: EntryReferenceOptionsProps) => Promise<Collection<Entry, EntryProps<KeyValueMap>>>) = ...
Recursively collects references of an entry and their descendants
+sys
unarchive
Unarchives the object
Type declaration
unpublish
Unpublishes the object
+```" aria-label="Permalink" class="tsd-anchor-icon">unpublish
Unpublishes the object
Type declaration
update
Sends an update to the server with any changes made to the object's properties
+```" aria-label="Permalink" class="tsd-anchor-icon">update
Sends an update to the server with any changes made to the object's properties
Type declaration
Methods
to
- to
Plain Object(): EntryProps<KeyValueMap> Returns EntryProps<KeyValueMap>
Methods
to
- to
Plain Object(): EntryProps<KeyValueMap> Returns EntryProps<KeyValueMap>
Interface EntryFieldLocation
Index
Properties
fieldEntryFieldLocation | contentful-management.js - v11.40.3
Interface EntryMetaSysProps
interface EntryMetaSysProps {
archivedAt?: string;
archivedBy?: SysLink;
archivedVersion?: number;
automationTags: Link<"Tag">[];
contentType: SysLink;
createdAt: string;
createdBy?: SysLink;
deletedAt?: string;
deletedBy?: SysLink;
deletedVersion?: number;
environment: SysLink;
firstPublishedAt?: string;
id: string;
locale?: string;
publishedAt?: string;
publishedBy?: Link<"User"> | Link<"AppDefinition">;
publishedCounter?: number;
publishedVersion?: number;
space: SysLink;
status?: SysLink;
type: string;
updatedAt: string;
updatedBy?: SysLink;
version: number;
}
archivedAt?: string;
archivedBy?: SysLink;
archivedVersion?: number;
automationTags: Link<"Tag">[];
contentType: SysLink;
createdAt: string;
createdBy?: SysLink;
deletedAt?: string;
deletedBy?: SysLink;
deletedVersion?: number;
environment: SysLink;
firstPublishedAt?: string;
id: string;
locale?: string;
publishedAt?: string;
publishedBy?: Link<"User"> | Link<"AppDefinition">;
publishedCounter?: number;
publishedVersion?: number;
space: SysLink;
status?: SysLink;
type: string;
updatedAt: string;
updatedBy?: SysLink;
version: number;
}
Hierarchy (view full)
- EntityMetaSysProps
- EntryMetaSysProps
Index
Properties
archivedEntryMetaSysProps | contentful-management.js - v11.40.3
automation
content
automation
content
created
created
updated
Interface EntryMetaSysProps
interface EntryMetaSysProps {
archivedAt?: string;
archivedBy?: SysLink;
archivedVersion?: number;
automationTags: Link<"Tag">[];
contentType: SysLink;
createdAt: string;
createdBy?: SysLink;
deletedAt?: string;
deletedBy?: SysLink;
deletedVersion?: number;
environment: SysLink;
firstPublishedAt?: string;
id: string;
locale?: string;
publishedAt?: string;
publishedBy?: Link<"User"> | Link<"AppDefinition">;
publishedCounter?: number;
publishedVersion?: number;
space: SysLink;
status?: SysLink;
type: string;
updatedAt: string;
updatedBy?: SysLink;
version: number;
}
archivedAt?: string;
archivedBy?: SysLink;
archivedVersion?: number;
automationTags: Link<"Tag">[];
contentType: SysLink;
createdAt: string;
createdBy?: SysLink;
deletedAt?: string;
deletedBy?: SysLink;
deletedVersion?: number;
environment: SysLink;
firstPublishedAt?: string;
id: string;
locale?: string;
publishedAt?: string;
publishedBy?: Link<"User"> | Link<"AppDefinition">;
publishedCounter?: number;
publishedVersion?: number;
space: SysLink;
status?: SysLink;
type: string;
updatedAt: string;
updatedBy?: SysLink;
version: number;
}
Hierarchy (view full)
- EntityMetaSysProps
- EntryMetaSysProps
Index
Properties
archived
Properties
Optionalarchived
archived
Optionalarchived
Optionalarchived
archived
automation
content
Properties
Optionalarchived
archived
Optionalarchived
Optionalarchived
archived
automation
content
created
created
Optionalcreated
Optionaldeleted
deleted
Optionaldeleted
Optionaldeleted
deleted
environment
Optionalfirst
first
id
id: string
Optionallocale
locale?: string
Optionalpublished
published
Optionalpublished
Optionalpublished
published
Optionalpublished
published
space
Optionalstatus
created
created
Optionalcreated
Optionaldeleted
deleted
Optionaldeleted
Optionaldeleted
deleted
environment
Optionalfirst
first
id
id: string
Optionallocale
locale?: string
Optionalpublished
published
Optionalpublished
Optionalpublished
published
Optionalpublished
published
space
Optionalstatus
type
type: string
updated
updated
Optionalupdated
version
version: number
type
type: string
updated
updated
Optionalupdated
version
version: number
Interface EnvironmentAlias
interface EnvironmentAlias {
environment: {
sys: MetaLinkProps;
};
sys: BasicMetaSysProps & {
space: SysLink;
};
delete(): Promise<void>;
toPlainObject(): EnvironmentAliasProps;
update(): Promise<EnvironmentAlias>;
}
environment: {
sys: MetaLinkProps;
};
sys: BasicMetaSysProps & {
space: SysLink;
};
delete(): Promise<void>;
toPlainObject(): EnvironmentAliasProps;
update(): Promise<EnvironmentAlias>;
}
Hierarchy (view full)
- EnvironmentAliasProps
- DefaultElements<EnvironmentAliasProps>
- EnvironmentAlias
Index
Properties
environment
+EnvironmentAlias | contentful-management.js - v11.40.3
to
to
Interface EnvironmentAlias
interface EnvironmentAlias {
environment: {
sys: MetaLinkProps;
};
sys: BasicMetaSysProps & {
space: SysLink;
};
delete(): Promise<void>;
toPlainObject(): EnvironmentAliasProps;
update(): Promise<EnvironmentAlias>;
}
environment: {
sys: MetaLinkProps;
};
sys: BasicMetaSysProps & {
space: SysLink;
};
delete(): Promise<void>;
toPlainObject(): EnvironmentAliasProps;
update(): Promise<EnvironmentAlias>;
}
Hierarchy (view full)
- EnvironmentAliasProps
- DefaultElements<EnvironmentAliasProps>
- EnvironmentAlias
Index
Properties
Methods
Methods
delete
- delete(): Promise<void>
Deletes this object on the server.
Returns Promise<void>
Promise for the deletion. It contains no data, but the Promise error case should be handled.
const contentful = require('contentful-management')
const client = contentful.createClient({
accessToken: '<content_management_api_key>'
})
client.getSpace('<space_id>')
.then((space) => space.getEnvironmentAlias('<environment_alias_id>'))
.then((alias) => {
return alias.delete()
})
.then(() => console.log(`Alias deleted.`))
.catch(console.error)
to
- to
Plain Object(): EnvironmentAliasProps Returns EnvironmentAliasProps
update
- update(): Promise<EnvironmentAlias>
Sends an update to the server with any changes made to the object's properties. Currently, you can only change the id of the alias's underlying environment. See the example below.
+
to
- to
Plain Object(): EnvironmentAliasProps Returns EnvironmentAliasProps
update
- update(): Promise<EnvironmentAlias>
Sends an update to the server with any changes made to the object's properties. Currently, you can only change the id of the alias's underlying environment. See the example below.
Returns Promise<EnvironmentAlias>
Object returned from the server with updated changes.
const contentful = require('contentful-management')
const client = contentful.createClient({
accessToken: '<content_management_api_key>'
})
client.getSpace('<space_id>')
.then((space) => space.getEnvironmentAlias('<environment_alias_id>'))
.then((alias) => {
alias.environment.sys.id = '<environment_id>'
return alias.update()
})
.then((alias) => console.log(`alias ${alias.sys.id} updated.`))
.catch(console.error)
+
diff --git a/contentful-management/latest/interfaces/FieldGroupItem.html b/contentful-management/latest/interfaces/FieldGroupItem.html
index fcac65cfd2..c2da289fd1 100644
--- a/contentful-management/latest/interfaces/FieldGroupItem.html
+++ b/contentful-management/latest/interfaces/FieldGroupItem.html
@@ -1,4 +1,4 @@
-
Interface FieldGroupItem
Index
Properties
groupFieldGroupItem | contentful-management.js - v11.40.3
+
diff --git a/contentful-management/latest/interfaces/GroupControl.html b/contentful-management/latest/interfaces/GroupControl.html
index c541c28a4d..691a6227b3 100644
--- a/contentful-management/latest/interfaces/GroupControl.html
+++ b/contentful-management/latest/interfaces/GroupControl.html
@@ -1,9 +1,9 @@
-
Interface GroupControl
interface GroupControl {
groupId: string;
settings?: DefinedParameters;
widgetId?: string;
widgetNamespace?: string;
}
groupId: string;
settings?: DefinedParameters;
widgetId?: string;
widgetNamespace?: string;
}
Hierarchy
- WidgetConfig
- GroupControl
Index
Properties
groupGroupControl | contentful-management.js - v11.40.3
Interface GroupControl
interface GroupControl {
groupId: string;
settings?: DefinedParameters;
widgetId?: string;
widgetNamespace?: string;
}
groupId: string;
settings?: DefinedParameters;
widgetId?: string;
widgetNamespace?: string;
}
Hierarchy
- WidgetConfig
- GroupControl
Index
Properties
Optionalsettings
Instance parameter values
+Optionalwidget
widget
ID of the widget used
+Optionalwidget
widget
Type of the widget used
+Interface Link<T>
Link is a reference object to another entity that can be resolved using tools such as contentful-resolve
-Type Parameters
Index
Properties
sys
-
Interface Link<T>
Link is a reference object to another entity that can be resolved using tools such as contentful-resolve
+Type Parameters
Index
Properties
sys
+
Interface Locale
interface Locale {
code: string;
contentDeliveryApi: boolean;
contentManagementApi: boolean;
default: boolean;
fallbackCode: null | string;
internal_code: string;
name: string;
optional: boolean;
sys: BasicMetaSysProps & {
environment: SysLink;
space: SysLink;
};
delete(): Promise<void>;
toPlainObject(): LocaleProps;
update(): Promise<Locale>;
}
code: string;
contentDeliveryApi: boolean;
contentManagementApi: boolean;
default: boolean;
fallbackCode: null | string;
internal_code: string;
name: string;
optional: boolean;
sys: BasicMetaSysProps & {
environment: SysLink;
space: SysLink;
};
delete(): Promise<void>;
toPlainObject(): LocaleProps;
update(): Promise<Locale>;
}
Hierarchy (view full)
Index
Properties
code
+Locale | contentful-management.js - v11.40.3
content
content
fallback
internal_
content
content
fallback
internal_
to
to
+```" aria-label="Permalink" class="tsd-anchor-icon">Interface Locale
interface Locale {
code: string;
contentDeliveryApi: boolean;
contentManagementApi: boolean;
default: boolean;
fallbackCode: null | string;
internal_code: string;
name: string;
optional: boolean;
sys: BasicMetaSysProps & {
environment: SysLink;
space: SysLink;
};
delete(): Promise<void>;
toPlainObject(): LocaleProps;
update(): Promise<Locale>;
}
code: string;
contentDeliveryApi: boolean;
contentManagementApi: boolean;
default: boolean;
fallbackCode: null | string;
internal_code: string;
name: string;
optional: boolean;
sys: BasicMetaSysProps & {
environment: SysLink;
space: SysLink;
};
delete(): Promise<void>;
toPlainObject(): LocaleProps;
update(): Promise<Locale>;
}
Hierarchy (view full)
Index
Properties
Properties
code
code: string
Locale code (example: en-us)
-content
content
If the content under this locale should be available on the CDA (for public reading)
-content
content
If the content under this locale should be available on the CMA (for editing)
-default
default: boolean
If this is the default locale
-fallback
fallback
Locale code to fallback to when there is not content for the current locale
-internal_
internal_
Internal locale code
-name
name: string
Locale name
-optional
optional: boolean
If the locale needs to be filled in on entries or not
-sys
Methods
delete
content
content
If the content under this locale should be available on the CDA (for public reading)
+content
content
If the content under this locale should be available on the CMA (for editing)
+default
default: boolean
If this is the default locale
+fallback
fallback
Locale code to fallback to when there is not content for the current locale
+internal_
internal_
Internal locale code
+name
name: string
Locale name
+optional
optional: boolean
If the locale needs to be filled in on entries or not
+sys
Methods
delete
to
- to
Plain Object(): LocaleProps Returns LocaleProps
update
- update(): Promise<Locale>
Sends an update to the server with any changes made to the object's properties
+```" aria-label="Permalink" class="tsd-anchor-icon">
to
- to
Plain Object(): LocaleProps Returns LocaleProps
update
Interface MakeRequestOptions
interface MakeRequestOptions {
action: string;
entityType: keyof MRActions;
headers?: Partial<RawAxiosHeaders & {
Accept: AxiosHeaderValue;
Authorization: AxiosHeaderValue;
Content-Encoding: AxiosHeaderValue;
Content-Length: AxiosHeaderValue;
User-Agent: AxiosHeaderValue;
} & {
Content-Type: ContentType;
}>;
params?: Record<string, unknown>;
payload?: Record<string, unknown> | MakeRequestPayload | OpPatch[];
userAgent: string;
}
action: string;
entityType: keyof MRActions;
headers?: Partial<RawAxiosHeaders & {
Accept: AxiosHeaderValue;
Authorization: AxiosHeaderValue;
Content-Encoding: AxiosHeaderValue;
Content-Length: AxiosHeaderValue;
User-Agent: AxiosHeaderValue;
} & {
Content-Type: ContentType;
}>;
params?: Record<string, unknown>;
payload?: Record<string, unknown> | MakeRequestPayload | OpPatch[];
userAgent: string;
}
Index
Properties
action
+MakeRequestOptions | contentful-management.js - v11.40.3
entity
user
Interface MakeRequestOptions
interface MakeRequestOptions {
action: string;
entityType: keyof MRActions;
headers?: Partial<RawAxiosHeaders & {
Accept: AxiosHeaderValue;
Authorization: AxiosHeaderValue;
Content-Encoding: AxiosHeaderValue;
Content-Length: AxiosHeaderValue;
User-Agent: AxiosHeaderValue;
} & {
Content-Type: ContentType;
}>;
params?: Record<string, unknown>;
payload?: Record<string, unknown> | MakeRequestPayload | OpPatch[];
userAgent: string;
}
action: string;
entityType: keyof MRActions;
headers?: Partial<RawAxiosHeaders & {
Accept: AxiosHeaderValue;
Authorization: AxiosHeaderValue;
Content-Encoding: AxiosHeaderValue;
Content-Length: AxiosHeaderValue;
User-Agent: AxiosHeaderValue;
} & {
Content-Type: ContentType;
}>;
params?: Record<string, unknown>;
payload?: Record<string, unknown> | MakeRequestPayload | OpPatch[];
userAgent: string;
}
Properties
action
action: string
entity
entity
Optionalheaders
headers?: Partial<RawAxiosHeaders & {
Accept: AxiosHeaderValue;
Authorization: AxiosHeaderValue;
Content-Encoding: AxiosHeaderValue;
Content-Length: AxiosHeaderValue;
User-Agent: AxiosHeaderValue;
} & {
Content-Type: ContentType;
}>
Accept: AxiosHeaderValue;
Authorization: AxiosHeaderValue;
Content-Encoding: AxiosHeaderValue;
Content-Length: AxiosHeaderValue;
User-Agent: AxiosHeaderValue;
} & {
Content-Type: ContentType;
}>
Optionalparams
params?: Record<string, unknown>
Optionalpayload
user
user
Properties
action
action: string
entity
entity
Optionalheaders
headers?: Partial<RawAxiosHeaders & {
Accept: AxiosHeaderValue;
Authorization: AxiosHeaderValue;
Content-Encoding: AxiosHeaderValue;
Content-Length: AxiosHeaderValue;
User-Agent: AxiosHeaderValue;
} & {
Content-Type: ContentType;
}>
Accept: AxiosHeaderValue;
Authorization: AxiosHeaderValue;
Content-Encoding: AxiosHeaderValue;
Content-Length: AxiosHeaderValue;
User-Agent: AxiosHeaderValue;
} & {
Content-Type: ContentType;
}>
Optionalparams
params?: Record<string, unknown>
Optionalpayload
user
user
Interface MakeRequestPayload
Base interface for all Payload interfaces. Used as part of the MakeRequestOptions to simplify payload definitions.
-Hierarchy (view full)
Interface MakeRequestPayload
Base interface for all Payload interfaces. Used as part of the MakeRequestOptions to simplify payload definitions.
+Hierarchy (view full)
Interface MetaLinkProps
Interface MetaSysProps
interface MetaSysProps {
archivedAt?: string;
archivedBy?: SysLink;
archivedVersion?: number;
createdAt: string;
createdBy?: SysLink;
deletedAt?: string;
deletedBy?: SysLink;
deletedVersion?: number;
id: string;
publishedVersion?: number;
space?: SysLink;
status?: SysLink;
type: string;
updatedAt: string;
updatedBy?: SysLink;
version: number;
}
archivedAt?: string;
archivedBy?: SysLink;
archivedVersion?: number;
createdAt: string;
createdBy?: SysLink;
deletedAt?: string;
deletedBy?: SysLink;
deletedVersion?: number;
id: string;
publishedVersion?: number;
space?: SysLink;
status?: SysLink;
type: string;
updatedAt: string;
updatedBy?: SysLink;
version: number;
}
Hierarchy (view full)
- BasicMetaSysProps
- MetaSysProps
Index
Properties
archivedMetaSysProps | contentful-management.js - v11.40.3
created
created
updated
Interface MetaSysProps
interface MetaSysProps {
archivedAt?: string;
archivedBy?: SysLink;
archivedVersion?: number;
createdAt: string;
createdBy?: SysLink;
deletedAt?: string;
deletedBy?: SysLink;
deletedVersion?: number;
id: string;
publishedVersion?: number;
space?: SysLink;
status?: SysLink;
type: string;
updatedAt: string;
updatedBy?: SysLink;
version: number;
}
archivedAt?: string;
archivedBy?: SysLink;
archivedVersion?: number;
createdAt: string;
createdBy?: SysLink;
deletedAt?: string;
deletedBy?: SysLink;
deletedVersion?: number;
id: string;
publishedVersion?: number;
space?: SysLink;
status?: SysLink;
type: string;
updatedAt: string;
updatedBy?: SysLink;
version: number;
}
Hierarchy (view full)
- BasicMetaSysProps
- MetaSysProps
Index
Properties
Properties
Optionalarchived
archived
Optionalarchived
Optionalarchived
archived
created
created
Optionalcreated
Optionaldeleted
deleted
Optionaldeleted
Optionaldeleted
deleted
id
id: string
Optionalpublished
published
Optionalspace
Optionalstatus
Properties
Optionalarchived
archived
Optionalarchived
Optionalarchived
archived
created
created
Optionalcreated
Optionaldeleted
deleted
Optionaldeleted
Optionaldeleted
deleted
id
id: string
Optionalpublished
published
Optionalspace
Optionalstatus
type
type: string
updated
updated
Optionalupdated
version
version: number
type
type: string
updated
updated
Optionalupdated
version
version: number
Interface MetadataProps
Index
Properties
Interface NavigationItem
Interface OrganizationInvitation
interface OrganizationInvitation {
email: string;
firstName: string;
lastName: string;
role: string;
sys: MetaSysProps & {
invitationUrl: string;
organizationMembership: {
sys: MetaLinkProps;
};
status: string;
user: null | Record<string, any>;
};
toPlainObject(): OrganizationInvitationProps;
}
email: string;
firstName: string;
lastName: string;
role: string;
sys: MetaSysProps & {
invitationUrl: string;
organizationMembership: {
sys: MetaLinkProps;
};
status: string;
user: null | Record<string, any>;
};
toPlainObject(): OrganizationInvitationProps;
}
Hierarchy (view full)
- OrganizationInvitationProps
- DefaultElements<OrganizationInvitationProps>
- OrganizationInvitation
Index
Properties
email
+OrganizationInvitation | contentful-management.js - v11.40.3
email
first
last
to
Interface OrganizationInvitation
interface OrganizationInvitation {
email: string;
firstName: string;
lastName: string;
role: string;
sys: MetaSysProps & {
invitationUrl: string;
organizationMembership: {
sys: MetaLinkProps;
};
status: string;
user: null | Record<string, any>;
};
toPlainObject(): OrganizationInvitationProps;
}
email: string;
firstName: string;
lastName: string;
role: string;
sys: MetaSysProps & {
invitationUrl: string;
organizationMembership: {
sys: MetaLinkProps;
};
status: string;
user: null | Record<string, any>;
};
toPlainObject(): OrganizationInvitationProps;
}
Hierarchy (view full)
- OrganizationInvitationProps
- DefaultElements<OrganizationInvitationProps>
- OrganizationInvitation
Properties
email: string
first
first
last
last
role
role: string
sys
sys: MetaSysProps & {
invitationUrl: string;
organizationMembership: {
sys: MetaLinkProps;
};
status: string;
user: null | Record<string, any>;
}
invitationUrl: string;
organizationMembership: {
sys: MetaLinkProps;
};
status: string;
user: null | Record<string, any>;
}
Methods
to
- to
Plain Object(): OrganizationInvitationProps Returns OrganizationInvitationProps
Properties
email: string
first
first
last
last
role
role: string
sys
sys: MetaSysProps & {
invitationUrl: string;
organizationMembership: {
sys: MetaLinkProps;
};
status: string;
user: null | Record<string, any>;
}
invitationUrl: string;
organizationMembership: {
sys: MetaLinkProps;
};
status: string;
user: null | Record<string, any>;
}
Methods
to
- to
Plain Object(): OrganizationInvitationProps Returns OrganizationInvitationProps
Interface OrganizationMembership
interface OrganizationMembership {
role: string;
status: boolean;
sys: MetaSysProps & {
user: {
sys: MetaLinkProps;
};
};
delete(): Promise<void>;
toPlainObject(): OrganizationMembershipProps;
update(): Promise<OrganizationMembership>;
}
role: string;
status: boolean;
sys: MetaSysProps & {
user: {
sys: MetaLinkProps;
};
};
delete(): Promise<void>;
toPlainObject(): OrganizationMembershipProps;
update(): Promise<OrganizationMembership>;
}
Hierarchy (view full)
- OrganizationMembershipProps
- DefaultElements<OrganizationMembershipProps>
- OrganizationMembership
Index
Properties
role
+OrganizationMembership | contentful-management.js - v11.40.3
to
to
Interface OrganizationMembership
interface OrganizationMembership {
role: string;
status: boolean;
sys: MetaSysProps & {
user: {
sys: MetaLinkProps;
};
};
delete(): Promise<void>;
toPlainObject(): OrganizationMembershipProps;
update(): Promise<OrganizationMembership>;
}
role: string;
status: boolean;
sys: MetaSysProps & {
user: {
sys: MetaLinkProps;
};
};
delete(): Promise<void>;
toPlainObject(): OrganizationMembershipProps;
update(): Promise<OrganizationMembership>;
}
Hierarchy (view full)
- OrganizationMembershipProps
- DefaultElements<OrganizationMembershipProps>
- OrganizationMembership
Methods
delete
to
- to
Plain Object(): OrganizationMembershipProps Returns OrganizationMembershipProps
update
- update(): Promise<OrganizationMembership>
Sends an update to the server with any changes made to the object's properties
+Returns Promise<void>
to
- to
Plain Object(): OrganizationMembershipProps Returns OrganizationMembershipProps
update
- update(): Promise<OrganizationMembership>
Sends an update to the server with any changes made to the object's properties
Returns Promise<OrganizationMembership>
Object returned from the server with updated changes.
Interface PageLocation
Index
Properties
location
+PageLocation | contentful-management.js - v11.40.3
diff --git a/contentful-management/latest/interfaces/ParameterDefinition.html b/contentful-management/latest/interfaces/ParameterDefinition.html
index e65b8229da..e17dc7b449 100644
--- a/contentful-management/latest/interfaces/ParameterDefinition.html
+++ b/contentful-management/latest/interfaces/ParameterDefinition.html
@@ -1,4 +1,4 @@
-
Interface ParameterDefinition<T>
interface ParameterDefinition<T> {
default?: string | number | boolean;
description?: string;
id: string;
labels?: {
empty?: string;
false?: string;
true?: string;
};
name: string;
options?: ParameterOption[];
required?: boolean;
type: T;
}
default?: string | number | boolean;
description?: string;
id: string;
labels?: {
empty?: string;
false?: string;
true?: string;
};
name: string;
options?: ParameterOption[];
required?: boolean;
type: T;
}
Type Parameters
- T = ParameterType
Index
Properties
default?
+ParameterDefinition | contentful-management.js - v11.40.3
Interface ParameterDefinition<T>
interface ParameterDefinition<T> {
default?: string | number | boolean;
description?: string;
id: string;
labels?: {
empty?: string;
false?: string;
true?: string;
};
name: string;
options?: ParameterOption[];
required?: boolean;
type: T;
}
default?: string | number | boolean;
description?: string;
id: string;
labels?: {
empty?: string;
false?: string;
true?: string;
};
name: string;
options?: ParameterOption[];
required?: boolean;
type: T;
}
Type Parameters
- T = ParameterType
Interface PersonalAccessToken
interface PersonalAccessToken {
name: string;
revokedAt: null | string;
scopes: "content_management_manage"[];
sys: MetaSysProps & {
expiresAt?: string;
};
token?: string;
revoke(): Promise<PersonalAccessToken>;
toPlainObject(): PersonalAccessTokenProps;
}
name: string;
revokedAt: null | string;
scopes: "content_management_manage"[];
sys: MetaSysProps & {
expiresAt?: string;
};
token?: string;
revoke(): Promise<PersonalAccessToken>;
toPlainObject(): PersonalAccessTokenProps;
}
Hierarchy (view full)
- PersonalAccessTokenProps
- DefaultElements<PersonalAccessTokenProps>
- PersonalAccessToken
Index
Properties
name
+PersonalAccessToken | contentful-management.js - v11.40.3
revoked
revoked
to
+```" aria-label="Permalink" class="tsd-anchor-icon">Interface PersonalAccessToken
interface PersonalAccessToken {
name: string;
revokedAt: null | string;
scopes: "content_management_manage"[];
sys: MetaSysProps & {
expiresAt?: string;
};
token?: string;
revoke(): Promise<PersonalAccessToken>;
toPlainObject(): PersonalAccessTokenProps;
}
name: string;
revokedAt: null | string;
scopes: "content_management_manage"[];
sys: MetaSysProps & {
expiresAt?: string;
};
token?: string;
revoke(): Promise<PersonalAccessToken>;
toPlainObject(): PersonalAccessTokenProps;
}
Hierarchy (view full)
- PersonalAccessTokenProps
- DefaultElements<PersonalAccessTokenProps>
- PersonalAccessToken
Properties
name
name: string
revoked
revoked
scopes
scopes: "content_management_manage"[]
sys
Optionaltoken
token?: string
Methods
revoke
- revoke(): Promise<PersonalAccessToken>
Revokes a personal access token
+
Properties
name
name: string
revoked
revoked
scopes
scopes: "content_management_manage"[]
sys
Optionaltoken
token?: string
Methods
revoke
- revoke(): Promise<PersonalAccessToken>
Revokes a personal access token
Returns Promise<PersonalAccessToken>
Object the revoked personal access token
to
- to
Plain Object(): PersonalAccessTokenProps Returns PersonalAccessTokenProps
to
- to
Plain Object(): PersonalAccessTokenProps Returns PersonalAccessTokenProps
Interface PreviewApiKey
interface PreviewApiKey {
accessToken: string;
description: string;
name: string;
sys: MetaSysProps;
toPlainObject(): PreviewApiKeyProps;
}
accessToken: string;
description: string;
name: string;
sys: MetaSysProps;
toPlainObject(): PreviewApiKeyProps;
}
Hierarchy (view full)
- PreviewApiKeyProps
- DefaultElements<PreviewApiKeyProps>
- PreviewApiKey
Index
Properties
accessPreviewApiKey | contentful-management.js - v11.40.3
to
Interface PreviewApiKey
interface PreviewApiKey {
accessToken: string;
description: string;
name: string;
sys: MetaSysProps;
toPlainObject(): PreviewApiKeyProps;
}
accessToken: string;
description: string;
name: string;
sys: MetaSysProps;
toPlainObject(): PreviewApiKeyProps;
}
Hierarchy (view full)
- PreviewApiKeyProps
- DefaultElements<PreviewApiKeyProps>
- PreviewApiKey
Index
Properties
Methods
Methods
to
- to
Plain Object(): PreviewApiKeyProps Returns PreviewApiKeyProps
Methods
to
- to
Plain Object(): PreviewApiKeyProps Returns PreviewApiKeyProps
Interface QueryOptions
interface QueryOptions {
content_type?: string;
include?: number;
limit?: number;
links_to_entry?: string;
order?: string;
select?: string;
skip?: number;
[key: string]: any;
}
content_type?: string;
include?: number;
limit?: number;
links_to_entry?: string;
order?: string;
select?: string;
skip?: number;
[key: string]: any;
}
Hierarchy (view full)
- PaginationQueryOptions
- BasicQueryOptions
- QueryOptions
Indexable
- [key: string]: any
Index
Properties
content_QueryOptions | contentful-management.js - v11.40.3
Interface QueryOptions
interface QueryOptions {
content_type?: string;
include?: number;
limit?: number;
links_to_entry?: string;
order?: string;
select?: string;
skip?: number;
[key: string]: any;
}
content_type?: string;
include?: number;
limit?: number;
links_to_entry?: string;
order?: string;
select?: string;
skip?: number;
[key: string]: any;
}
Hierarchy (view full)
- PaginationQueryOptions
- BasicQueryOptions
- QueryOptions
Indexable
- [key: string]: any
Index
Properties
Interface Release
The object returned by the Releases API
-interface Release {
entities: BaseCollection<Link<Entity>>;
metadata?: ReleaseMetadata;
sys: ReleaseSysProps;
title: string;
archive(): Promise<Release>;
delete(): Promise<void>;
publish(options?: AsyncActionProcessingOptions): Promise<ReleaseAction<"publish">>;
toPlainObject(): ReleaseProps;
unarchive(): Promise<Release>;
unpublish(options?: AsyncActionProcessingOptions): Promise<ReleaseAction<"unpublish">>;
update(payload: ReleasePayload): Promise<Release>;
validate(__namedParameters?: {
options?: AsyncActionProcessingOptions;
payload?: ReleaseValidatePayload;
}): Promise<ReleaseAction<"validate">>;
}
entities: BaseCollection<Link<Entity>>;
metadata?: ReleaseMetadata;
sys: ReleaseSysProps;
title: string;
archive(): Promise<Release>;
delete(): Promise<void>;
publish(options?: AsyncActionProcessingOptions): Promise<ReleaseAction<"publish">>;
toPlainObject(): ReleaseProps;
unarchive(): Promise<Release>;
unpublish(options?: AsyncActionProcessingOptions): Promise<ReleaseAction<"unpublish">>;
update(payload: ReleasePayload): Promise<Release>;
validate(__namedParameters?: {
options?: AsyncActionProcessingOptions;
payload?: ReleaseValidatePayload;
}): Promise<ReleaseAction<"validate">>;
}
Hierarchy (view full)
- ReleaseProps
- ReleaseApiMethods
- DefaultElements<ReleaseProps>
- Release
Index
Properties
entities
+Release | contentful-management.js - v11.40.3
to
to
Interface Release
The object returned by the Releases API
+interface Release {
entities: BaseCollection<Link<Entity>>;
metadata?: ReleaseMetadata;
sys: ReleaseSysProps;
title: string;
archive(): Promise<Release>;
delete(): Promise<void>;
publish(options?: AsyncActionProcessingOptions): Promise<ReleaseAction<"publish">>;
toPlainObject(): ReleaseProps;
unarchive(): Promise<Release>;
unpublish(options?: AsyncActionProcessingOptions): Promise<ReleaseAction<"unpublish">>;
update(payload: ReleasePayload): Promise<Release>;
validate(__namedParameters?: {
options?: AsyncActionProcessingOptions;
payload?: ReleaseValidatePayload;
}): Promise<ReleaseAction<"validate">>;
}
entities: BaseCollection<Link<Entity>>;
metadata?: ReleaseMetadata;
sys: ReleaseSysProps;
title: string;
archive(): Promise<Release>;
delete(): Promise<void>;
publish(options?: AsyncActionProcessingOptions): Promise<ReleaseAction<"publish">>;
toPlainObject(): ReleaseProps;
unarchive(): Promise<Release>;
unpublish(options?: AsyncActionProcessingOptions): Promise<ReleaseAction<"unpublish">>;
update(payload: ReleasePayload): Promise<Release>;
validate(__namedParameters?: {
options?: AsyncActionProcessingOptions;
payload?: ReleaseValidatePayload;
}): Promise<ReleaseAction<"validate">>;
}
Hierarchy (view full)
- ReleaseProps
- ReleaseApiMethods
- DefaultElements<ReleaseProps>
- Release
Methods
archive
- archive(): Promise<Release>
Archives a release and locks any actions such as adding new entities or publishing/unpublishing. +
Methods
archive
delete
publish
- publish(options?): Promise<ReleaseAction<"publish">>
Publishes a Release and waits until the asynchronous action is completed
-Parameters
Optionaloptions: AsyncActionProcessingOptions
Returns Promise<ReleaseAction<"publish">>
to
- to
Plain Object(): ReleaseProps Returns ReleaseProps
unarchive
- unarchive(): Promise<Release>
Unarchives an
+archivedrelease and unlocks operations on the Release. This operation increases the sys.version property
delete
publish
- publish(options?): Promise<ReleaseAction<"publish">>
Publishes a Release and waits until the asynchronous action is completed
+Parameters
Optionaloptions: AsyncActionProcessingOptions
Returns Promise<ReleaseAction<"publish">>
to
- to
Plain Object(): ReleaseProps Returns ReleaseProps
unarchive
unpublish
- unpublish(options?): Promise<ReleaseAction<"unpublish">>
Unpublishes a Release and waits until the asynchronous action is completed
-Parameters
Optionaloptions: AsyncActionProcessingOptions
Returns Promise<ReleaseAction<"unpublish">>
update
- update(payload): Promise<Release>
Updates a Release and returns the updated Release object
-Parameters
- payload: ReleasePayload
Returns Promise<Release>
validate
- validate(__namedParameters?): Promise<ReleaseAction<"validate">>
Validates a Release and waits until the asynchronous action is completed
-Parameters
Optional__namedParameters: {
options?: AsyncActionProcessingOptions;
payload?: ReleaseValidatePayload;
}Optionaloptions?: AsyncActionProcessingOptionsOptionalpayload?: ReleaseValidatePayload
Returns Promise<ReleaseAction<"validate">>
unpublish
- unpublish(options?): Promise<ReleaseAction<"unpublish">>
Unpublishes a Release and waits until the asynchronous action is completed
+Parameters
Optionaloptions: AsyncActionProcessingOptions
Returns Promise<ReleaseAction<"unpublish">>
update
- update(payload): Promise<Release>
Updates a Release and returns the updated Release object
+Parameters
- payload: ReleasePayload
Returns Promise<Release>
validate
- validate(__namedParameters?): Promise<ReleaseAction<"validate">>
Validates a Release and waits until the asynchronous action is completed
+Parameters
Optional__namedParameters: {
options?: AsyncActionProcessingOptions;
payload?: ReleaseValidatePayload;
}Optionaloptions?: AsyncActionProcessingOptionsOptionalpayload?: ReleaseValidatePayload
Returns Promise<ReleaseAction<"validate">>
Interface ReleaseAction<T>
The object returned by the Releases API
-interface ReleaseAction<T> {
action: T;
sys: ReleaseActionSysProps;
get(): ReleaseAction<any>;
toPlainObject(): ReleaseActionProps<T>;
waitProcessing(options?: AsyncActionProcessingOptions): ReleaseAction<any>;
}
action: T;
sys: ReleaseActionSysProps;
get(): ReleaseAction<any>;
toPlainObject(): ReleaseActionProps<T>;
waitProcessing(options?: AsyncActionProcessingOptions): ReleaseAction<any>;
}
Type Parameters
- T extends ReleaseActionTypes = any
Hierarchy (view full)
- ReleaseActionProps<T>
- ReleaseActionApiMethods
- DefaultElements<ReleaseActionProps<T>>
- ReleaseAction
Index
Properties
action
+ReleaseAction | contentful-management.js - v11.40.3
to
wait
Interface ReleaseAction<T>
The object returned by the Releases API
+interface ReleaseAction<T> {
action: T;
sys: ReleaseActionSysProps;
get(): ReleaseAction<any>;
toPlainObject(): ReleaseActionProps<T>;
waitProcessing(options?: AsyncActionProcessingOptions): ReleaseAction<any>;
}
action: T;
sys: ReleaseActionSysProps;
get(): ReleaseAction<any>;
toPlainObject(): ReleaseActionProps<T>;
waitProcessing(options?: AsyncActionProcessingOptions): ReleaseAction<any>;
}
Type Parameters
- T extends ReleaseActionTypes = any
Hierarchy (view full)
- ReleaseActionProps<T>
- ReleaseActionApiMethods
- DefaultElements<ReleaseActionProps<T>>
- ReleaseAction
Index
Properties
Methods
Methods
get
- get(): ReleaseAction<any>
Performs a new GET request and returns the wrapper Release
-Returns ReleaseAction<any>
to
- to
Plain Object(): ReleaseActionProps<T> Returns ReleaseActionProps<T>
wait
- wait
Processing(options?): ReleaseAction<any> Waits until the Release Action has either succeeded or failed
-Parameters
Optionaloptions: AsyncActionProcessingOptions
Returns ReleaseAction<any>
Methods
get
- get(): ReleaseAction<any>
Performs a new GET request and returns the wrapper Release
+Returns ReleaseAction<any>
to
- to
Plain Object(): ReleaseActionProps<T> Returns ReleaseActionProps<T>
wait
- wait
Processing(options?): ReleaseAction<any> Waits until the Release Action has either succeeded or failed
+Parameters
Optionaloptions: AsyncActionProcessingOptions
Returns ReleaseAction<any>
Interface ReleaseActionProps<T>
The object returned by the Releases API
-Type Parameters
- T extends ReleaseActionTypes = any
Hierarchy (view full)
- ReleaseActionProps
Index
Properties
action
+ReleaseActionProps | contentful-management.js - v11.40.3
Interface ReleaseActionProps<T>
The object returned by the Releases API
+Type Parameters
- T extends ReleaseActionTypes = any
Hierarchy (view full)
- ReleaseActionProps
Interface ReleaseActionQueryOptions
interface ReleaseActionQueryOptions {
action?: ReleaseActionTypes;
limit?: number;
order?: string;
sys.id[in]?: string;
sys.release.sys.id[in]?: string;
sys.status[in]?: string;
sys.status[nin]?: string;
uniqueBy?: string;
}
action?: ReleaseActionTypes;
limit?: number;
order?: string;
sys.id[in]?: string;
sys.release.sys.id[in]?: string;
sys.status[in]?: string;
sys.status[nin]?: string;
uniqueBy?: string;
}
Index
Properties
action?
+ReleaseActionQueryOptions | contentful-management.js - v11.40.3
+Interface ReleaseActionQueryOptions
interface ReleaseActionQueryOptions {
action?: ReleaseActionTypes;
limit?: number;
order?: string;
sys.id[in]?: string;
sys.release.sys.id[in]?: string;
sys.status[in]?: string;
sys.status[nin]?: string;
uniqueBy?: string;
}
action?: ReleaseActionTypes;
limit?: number;
order?: string;
sys.id[in]?: string;
sys.release.sys.id[in]?: string;
sys.status[in]?: string;
sys.status[nin]?: string;
uniqueBy?: string;
}
Index
Properties
Properties
Optionalaction
Optionallimit
limit?: number
Limit of how many records are returned in the query result
Optionalorder
order?: string
Optionalorder
order?: string
Optionalsys.id[in]
sys.id[in]?: string
Find Release Actions by using a comma-separated list of Ids
-Optionalsys.release.sys.id[in]
sys.release.sys.id[in]?: string
Optionalsys.status[in]
sys.status[in]?: string
Optionalsys.status[nin]
sys.status[nin]?: string
Optionalunique
unique
Get unique results by this field. Currently supports sys.release.sys.id
Optionalsys.id[in]
sys.id[in]?: string
Find Release Actions by using a comma-separated list of Ids
+Optionalsys.release.sys.id[in]
sys.release.sys.id[in]?: string
Optionalsys.status[in]
sys.status[in]?: string
Optionalsys.status[nin]
sys.status[nin]?: string
Optionalunique
unique
Get unique results by this field. Currently supports sys.release.sys.id
Interface ReleasePayload
Base interface for all Payload interfaces. Used as part of the MakeRequestOptions to simplify payload definitions.
-Hierarchy (view full)
- MakeRequestPayload
- ReleasePayload
Index
Properties
entities
+ReleasePayload | contentful-management.js - v11.40.3
Interface ReleasePayload
Base interface for all Payload interfaces. Used as part of the MakeRequestOptions to simplify payload definitions.
+Hierarchy (view full)
- MakeRequestPayload
- ReleasePayload
Interface ReleaseProps
The object returned by the Releases API
-interface ReleaseProps {
entities: BaseCollection<Link<Entity>>;
metadata?: ReleaseMetadata;
sys: ReleaseSysProps;
title: string;
}
entities: BaseCollection<Link<Entity>>;
metadata?: ReleaseMetadata;
sys: ReleaseSysProps;
title: string;
}
Hierarchy (view full)
- ReleaseProps
Index
Properties
entities
+ReleaseProps | contentful-management.js - v11.40.3
Interface ReleaseProps
The object returned by the Releases API
+interface ReleaseProps {
entities: BaseCollection<Link<Entity>>;
metadata?: ReleaseMetadata;
sys: ReleaseSysProps;
title: string;
}
entities: BaseCollection<Link<Entity>>;
metadata?: ReleaseMetadata;
sys: ReleaseSysProps;
title: string;
}
Hierarchy (view full)
- ReleaseProps
Interface ReleaseQueryOptions
interface ReleaseQueryOptions {
entities.sys.id[in]?: string;
entities.sys.linkType?: string;
entities[exists]?: boolean;
limit?: number;
order?: string;
pageNext?: string;
sys.createdBy.sys.id[in]?: string;
sys.id[in]?: string;
sys.id[nin]?: string;
sys.status[in]?: ReleaseStatus;
sys.status[nin]?: ReleaseStatus;
title[match]?: string;
}
entities.sys.id[in]?: string;
entities.sys.linkType?: string;
entities[exists]?: boolean;
limit?: number;
order?: string;
pageNext?: string;
sys.createdBy.sys.id[in]?: string;
sys.id[in]?: string;
sys.id[nin]?: string;
sys.status[in]?: ReleaseStatus;
sys.status[nin]?: ReleaseStatus;
title[match]?: string;
}
Index
Properties
entities.sys.id[in]?
+ReleaseQueryOptions | contentful-management.js - v11.40.3
+Interface ReleaseQueryOptions
interface ReleaseQueryOptions {
entities.sys.id[in]?: string;
entities.sys.linkType?: string;
entities[exists]?: boolean;
limit?: number;
order?: string;
pageNext?: string;
sys.createdBy.sys.id[in]?: string;
sys.id[in]?: string;
sys.id[nin]?: string;
sys.status[in]?: ReleaseStatus;
sys.status[nin]?: ReleaseStatus;
title[match]?: string;
}
entities.sys.id[in]?: string;
entities.sys.linkType?: string;
entities[exists]?: boolean;
limit?: number;
order?: string;
pageNext?: string;
sys.createdBy.sys.id[in]?: string;
sys.id[in]?: string;
sys.id[nin]?: string;
sys.status[in]?: ReleaseStatus;
sys.status[nin]?: ReleaseStatus;
title[match]?: string;
}
Index
Properties
entities.sys.id[in]?
entities.sys.link
Properties
Optionalentities.sys.id[in]
entities.sys.id[in]?: string
Find releases containing the specified, comma-separated entities. Requires entities.sys.linkType
Optionalentities.sys.link
entities.sys.link
Find releases filtered by the Entity type (Asset, Entry)
-Optionalentities[exists]
entities[exists]?: boolean
Filter by empty Releases (exists=false) or Releases with items (exists=true)
-Optionallimit
limit?: number
Limit how many records are returned in the result
+Optionalentities.sys.link
entities.sys.link
Find releases filtered by the Entity type (Asset, Entry)
+Optionalentities[exists]
entities[exists]?: boolean
Filter by empty Releases (exists=false) or Releases with items (exists=true)
+Optionallimit
limit?: number
Limit how many records are returned in the result
Optionalorder
order?: string
Order releases +
Optionalorder
order?: string
Order releases Supported values include
title,-title
@@ -27,11 +27,11 @@
Optionalpage
page
If present, will return results based on a pagination cursor
-Optionalsys.created
sys.created
Comma-separated list of user Ids to find releases by creator
-Optionalsys.id[in]
sys.id[in]?: string
Comma-separated list of Ids to find (inclusion)
-Optionalsys.id[nin]
sys.id[nin]?: string
Comma-separated list of ids to exclude from the query
-Optionalsys.status[in]
sys.status[in]?: ReleaseStatus
Comma-separated filter (inclusion) by Release status (active, archived)
-Optionalsys.status[nin]
sys.status[nin]?: ReleaseStatus
Comma-separated filter (exclusion) by Release status (active, archived)
-Optionaltitle[match]
title[match]?: string
Find releases using full text phrase and term matching
-Optionalpage
page
If present, will return results based on a pagination cursor
+Optionalsys.created
sys.created
Comma-separated list of user Ids to find releases by creator
+Optionalsys.id[in]
sys.id[in]?: string
Comma-separated list of Ids to find (inclusion)
+Optionalsys.id[nin]
sys.id[nin]?: string
Comma-separated list of ids to exclude from the query
+Optionalsys.status[in]
sys.status[in]?: ReleaseStatus
Comma-separated filter (inclusion) by Release status (active, archived)
+Optionalsys.status[nin]
sys.status[nin]?: ReleaseStatus
Comma-separated filter (exclusion) by Release status (active, archived)
+Optionaltitle[match]
title[match]?: string
Find releases using full text phrase and term matching
+Interface ReleaseValidateOptions
interface ReleaseValidateOptions {
payload?: ReleaseValidatePayload;
processingOptions?: AsyncActionProcessingOptions;
}
payload?: ReleaseValidatePayload;
processingOptions?: AsyncActionProcessingOptions;
}
Index
Properties
payload?
+ReleaseValidateOptions | contentful-management.js - v11.40.3
Interface ReleaseValidateOptions
interface ReleaseValidateOptions {
payload?: ReleaseValidatePayload;
processingOptions?: AsyncActionProcessingOptions;
}
payload?: ReleaseValidatePayload;
processingOptions?: AsyncActionProcessingOptions;
}
Index
Properties
Interface ResourceLink<T>
ResourceLink is a reference object to another entity outside of the current space/environment
-Type Parameters
Index
Properties
sys
-
Interface ResourceLink<T>
ResourceLink is a reference object to another entity outside of the current space/environment
+Type Parameters
Index
Properties
sys
+
Interface ResourceProvider
interface ResourceProvider {
function: SysLink;
sys: Omit<BasicMetaSysProps, "version"> & {
appDefinition: SysLink;
organization: SysLink;
};
type: "function";
delete(): Promise<void>;
getResourceType(id: string): Promise<ResourceType>;
getResourceTypes(): Promise<CollectionProp<ResourceType>>;
toPlainObject(): ResourceProviderProps;
upsert(): Promise<ResourceProvider>;
upsertResourceType(id: string, data: UpsertResourceTypeProps): Promise<ResourceType>;
}
function: SysLink;
sys: Omit<BasicMetaSysProps, "version"> & {
appDefinition: SysLink;
organization: SysLink;
};
type: "function";
delete(): Promise<void>;
getResourceType(id: string): Promise<ResourceType>;
getResourceTypes(): Promise<CollectionProp<ResourceType>>;
toPlainObject(): ResourceProviderProps;
upsert(): Promise<ResourceProvider>;
upsertResourceType(id: string, data: UpsertResourceTypeProps): Promise<ResourceType>;
}
Hierarchy (view full)
- ResourceProviderProps
- DefaultElements<ResourceProviderProps>
- ResourceProvider
Index
Properties
function
+ResourceProvider | contentful-management.js - v11.40.3
get
get
to
upsert
Interface ResourceProvider
interface ResourceProvider {
function: SysLink;
sys: Omit<BasicMetaSysProps, "version"> & {
appDefinition: SysLink;
organization: SysLink;
};
type: "function";
delete(): Promise<void>;
getResourceType(id: string): Promise<ResourceType>;
getResourceTypes(): Promise<CollectionProp<ResourceType>>;
toPlainObject(): ResourceProviderProps;
upsert(): Promise<ResourceProvider>;
upsertResourceType(id: string, data: UpsertResourceTypeProps): Promise<ResourceType>;
}
function: SysLink;
sys: Omit<BasicMetaSysProps, "version"> & {
appDefinition: SysLink;
organization: SysLink;
};
type: "function";
delete(): Promise<void>;
getResourceType(id: string): Promise<ResourceType>;
getResourceTypes(): Promise<CollectionProp<ResourceType>>;
toPlainObject(): ResourceProviderProps;
upsert(): Promise<ResourceProvider>;
upsertResourceType(id: string, data: UpsertResourceTypeProps): Promise<ResourceType>;
}
Hierarchy (view full)
- ResourceProviderProps
- DefaultElements<ResourceProviderProps>
- ResourceProvider
Properties
function
Link to a Contentful function
-sys
System metadata
-type
type
Resource Provider type, value is 'function'
- Methods
delete
get
- get
Resource Type(id): Promise<ResourceType> Parameters
- id: string
Returns Promise<ResourceType>
get
- get
Resource Types(): Promise<CollectionProp<ResourceType>> Returns Promise<CollectionProp<ResourceType>>
to
- to
Plain Object(): ResourceProviderProps Returns ResourceProviderProps
upsert
- upsert(): Promise<ResourceProvider>
Returns Promise<ResourceProvider>
upsert
- upsert
Resource Type(id, data): Promise<ResourceType> Parameters
- id: string
- data: UpsertResourceTypeProps
Returns Promise<ResourceType>
sys
System metadata
+type
type
Resource Provider type, value is 'function'
+ Methods
delete
get
- get
Resource Type(id): Promise<ResourceType> Parameters
- id: string
Returns Promise<ResourceType>
get
- get
Resource Types(): Promise<CollectionProp<ResourceType>> Returns Promise<CollectionProp<ResourceType>>
to
- to
Plain Object(): ResourceProviderProps Returns ResourceProviderProps
upsert
- upsert(): Promise<ResourceProvider>
Returns Promise<ResourceProvider>
upsert
- upsert
Resource Type(id, data): Promise<ResourceType> Parameters
- id: string
- data: UpsertResourceTypeProps
Returns Promise<ResourceType>
Interface ResourceType
interface ResourceType {
defaultFieldMapping: {
badge?: {
label: string;
variant: string;
};
description?: string;
externalUrl?: string;
image?: {
altText?: string;
url: string;
};
subtitle?: string;
title: string;
};
name: string;
sys: Omit<BasicMetaSysProps, "version"> & {
appDefinition: SysLink;
organization: SysLink;
resourceProvider: SysLink;
};
delete(): Promise<void>;
toPlainObject(): ResourceTypeProps;
upsert(): Promise<ResourceType>;
}
defaultFieldMapping: {
badge?: {
label: string;
variant: string;
};
description?: string;
externalUrl?: string;
image?: {
altText?: string;
url: string;
};
subtitle?: string;
title: string;
};
name: string;
sys: Omit<BasicMetaSysProps, "version"> & {
appDefinition: SysLink;
organization: SysLink;
resourceProvider: SysLink;
};
delete(): Promise<void>;
toPlainObject(): ResourceTypeProps;
upsert(): Promise<ResourceType>;
}
Hierarchy (view full)
- ResourceTypeProps
- DefaultElements<ResourceTypeProps>
- ResourceType
Index
Properties
defaultResourceType | contentful-management.js - v11.40.3
default
to
Interface ResourceType
interface ResourceType {
defaultFieldMapping: {
badge?: {
label: string;
variant: string;
};
description?: string;
externalUrl?: string;
image?: {
altText?: string;
url: string;
};
subtitle?: string;
title: string;
};
name: string;
sys: Omit<BasicMetaSysProps, "version"> & {
appDefinition: SysLink;
organization: SysLink;
resourceProvider: SysLink;
};
delete(): Promise<void>;
toPlainObject(): ResourceTypeProps;
upsert(): Promise<ResourceType>;
}
defaultFieldMapping: {
badge?: {
label: string;
variant: string;
};
description?: string;
externalUrl?: string;
image?: {
altText?: string;
url: string;
};
subtitle?: string;
title: string;
};
name: string;
sys: Omit<BasicMetaSysProps, "version"> & {
appDefinition: SysLink;
organization: SysLink;
resourceProvider: SysLink;
};
delete(): Promise<void>;
toPlainObject(): ResourceTypeProps;
upsert(): Promise<ResourceType>;
}
Hierarchy (view full)
- ResourceTypeProps
- DefaultElements<ResourceTypeProps>
- ResourceType
Index
Properties
Methods
Properties
default
default
badge?: {
label: string;
variant: string;
};
description?: string;
externalUrl?: string;
image?: {
altText?: string;
url: string;
};
subtitle?: string;
title: string;
}
badge?: {
label: string;
variant: string;
};
description?: string;
externalUrl?: string;
image?: {
altText?: string;
url: string;
};
subtitle?: string;
title: string;
}
Resource Type defaultFieldMapping
-name
name: string
Resource Type name
-sys
sys: Omit<BasicMetaSysProps, "version"> & {
appDefinition: SysLink;
organization: SysLink;
resourceProvider: SysLink;
}
appDefinition: SysLink;
organization: SysLink;
resourceProvider: SysLink;
}
System metadata
- Methods
delete
to
- to
Plain Object(): ResourceTypeProps Returns ResourceTypeProps
upsert
- upsert(): Promise<ResourceType>
Returns Promise<ResourceType>
name
name: string
Resource Type name
+sys
sys: Omit<BasicMetaSysProps, "version"> & {
appDefinition: SysLink;
organization: SysLink;
resourceProvider: SysLink;
}
appDefinition: SysLink;
organization: SysLink;
resourceProvider: SysLink;
}
System metadata
+ Methods
delete
to
- to
Plain Object(): ResourceTypeProps Returns ResourceTypeProps
upsert
- upsert(): Promise<ResourceType>
Returns Promise<ResourceType>
Interface RichTextCommentDocument
Hierarchy
- Node
- RichTextCommentDocument
Index
Properties
Interface Role
interface Role {
description?: string;
name: string;
permissions: {
ContentDelivery: string | string[];
ContentModel: string[];
EnvironmentAliases: string | string[];
Environments: string | string[];
Settings: string | string[];
Tags: string | string[];
};
policies: {
actions: ActionType[] | "all";
constraint: ConstraintType;
effect: string;
}[];
sys: BasicMetaSysProps & {
space: SysLink;
};
delete(): Promise<void>;
toPlainObject(): RoleProps;
update(): Promise<Role>;
}
description?: string;
name: string;
permissions: {
ContentDelivery: string | string[];
ContentModel: string[];
EnvironmentAliases: string | string[];
Environments: string | string[];
Settings: string | string[];
Tags: string | string[];
};
policies: {
actions: ActionType[] | "all";
constraint: ConstraintType;
effect: string;
}[];
sys: BasicMetaSysProps & {
space: SysLink;
};
delete(): Promise<void>;
toPlainObject(): RoleProps;
update(): Promise<Role>;
}
Hierarchy (view full)
Index
Properties
description?
+Role | contentful-management.js - v11.40.3
to
to
Interface Role
interface Role {
description?: string;
name: string;
permissions: {
ContentDelivery: string | string[];
ContentModel: string[];
EnvironmentAliases: string | string[];
Environments: string | string[];
Settings: string | string[];
Tags: string | string[];
};
policies: {
actions: ActionType[] | "all";
constraint: ConstraintType;
effect: string;
}[];
sys: BasicMetaSysProps & {
space: SysLink;
};
delete(): Promise<void>;
toPlainObject(): RoleProps;
update(): Promise<Role>;
}
description?: string;
name: string;
permissions: {
ContentDelivery: string | string[];
ContentModel: string[];
EnvironmentAliases: string | string[];
Environments: string | string[];
Settings: string | string[];
Tags: string | string[];
};
policies: {
actions: ActionType[] | "all";
constraint: ConstraintType;
effect: string;
}[];
sys: BasicMetaSysProps & {
space: SysLink;
};
delete(): Promise<void>;
toPlainObject(): RoleProps;
update(): Promise<Role>;
}
Hierarchy (view full)
Index
Properties
Methods
Properties
Optionaldescription
description?: string
name
name: string
permissions
permissions: {
ContentDelivery: string | string[];
ContentModel: string[];
EnvironmentAliases: string | string[];
Environments: string | string[];
Settings: string | string[];
Tags: string | string[];
}
ContentDelivery: string | string[];
ContentModel: string[];
EnvironmentAliases: string | string[];
Environments: string | string[];
Settings: string | string[];
Tags: string | string[];
}
Permissions for application sections
-policies
policies: {
actions: ActionType[] | "all";
constraint: ConstraintType;
effect: string;
}[]
actions: ActionType[] | "all";
constraint: ConstraintType;
effect: string;
}[]
sys
Properties
Optionaldescription
description?: string
name
name: string
permissions
permissions: {
ContentDelivery: string | string[];
ContentModel: string[];
EnvironmentAliases: string | string[];
Environments: string | string[];
Settings: string | string[];
Tags: string | string[];
}
ContentDelivery: string | string[];
ContentModel: string[];
EnvironmentAliases: string | string[];
Environments: string | string[];
Settings: string | string[];
Tags: string | string[];
}
Permissions for application sections
+policies
policies: {
actions: ActionType[] | "all";
constraint: ConstraintType;
effect: string;
}[]
actions: ActionType[] | "all";
constraint: ConstraintType;
effect: string;
}[]
sys
Methods
delete
to
update
- update(): Promise<Role>
Sends an update to the server with any changes made to the object's properties
+```" aria-label="Permalink" class="tsd-anchor-icon">
to
update
Interface ScheduledAction
interface ScheduledAction {
action: SchedulableActionType;
entity: Link<SchedulableEntityType>;
environment?: {
sys: MetaLinkProps;
};
error?: ScheduledActionFailedError;
payload?: ScheduledActionPayloadProps;
scheduledFor: {
datetime: string;
timezone?: string;
};
sys: ScheduledActionSysProps;
delete(): Promise<ScheduledAction>;
toPlainObject(): ScheduledActionProps;
update(): Promise<ScheduledAction>;
}
action: SchedulableActionType;
entity: Link<SchedulableEntityType>;
environment?: {
sys: MetaLinkProps;
};
error?: ScheduledActionFailedError;
payload?: ScheduledActionPayloadProps;
scheduledFor: {
datetime: string;
timezone?: string;
};
sys: ScheduledActionSysProps;
delete(): Promise<ScheduledAction>;
toPlainObject(): ScheduledActionProps;
update(): Promise<ScheduledAction>;
}
Hierarchy (view full)
- ScheduledActionProps
- DefaultElements<ScheduledActionProps>
- ScheduledActionApi
- ScheduledAction
Index
Properties
action
+ScheduledAction | contentful-management.js - v11.40.3
scheduled
scheduled
to
+Interface ScheduledAction
interface ScheduledAction {
action: SchedulableActionType;
entity: Link<SchedulableEntityType>;
environment?: {
sys: MetaLinkProps;
};
error?: ScheduledActionFailedError;
payload?: ScheduledActionPayloadProps;
scheduledFor: {
datetime: string;
timezone?: string;
};
sys: ScheduledActionSysProps;
delete(): Promise<ScheduledAction>;
toPlainObject(): ScheduledActionProps;
update(): Promise<ScheduledAction>;
}
action: SchedulableActionType;
entity: Link<SchedulableEntityType>;
environment?: {
sys: MetaLinkProps;
};
error?: ScheduledActionFailedError;
payload?: ScheduledActionPayloadProps;
scheduledFor: {
datetime: string;
timezone?: string;
};
sys: ScheduledActionSysProps;
delete(): Promise<ScheduledAction>;
toPlainObject(): ScheduledActionProps;
update(): Promise<ScheduledAction>;
}
Hierarchy (view full)
- ScheduledActionProps
- DefaultElements<ScheduledActionProps>
- ScheduledActionApi
- ScheduledAction
Index
Properties
Methods
Properties
action
action: SchedulableActionType
entity
Optionalenvironment
Optionalerror
error?: ScheduledActionFailedError
The Contentful-style error that occurred during execution if sys.status is failed
Optionalpayload
payload?: ScheduledActionPayloadProps
scheduled
scheduled
datetime: string;
timezone?: string;
}
datetime: string;
timezone?: string;
}
Type declaration
datetime: string
Optionaltimezone?: stringA valid IANA timezone Olson identifier
+
Optionalpayload
payload?: ScheduledActionPayloadProps
scheduled
scheduled
datetime: string;
timezone?: string;
}
datetime: string;
timezone?: string;
}
Type declaration
datetime: string
Optionaltimezone?: stringA valid IANA timezone Olson identifier
sys
Methods
delete
- delete(): Promise<ScheduledAction>
Returns Promise<ScheduledAction>
to
- to
Plain Object(): ScheduledActionProps Returns ScheduledActionProps
update
- update(): Promise<ScheduledAction>
Returns Promise<ScheduledAction>
sys
Methods
delete
- delete(): Promise<ScheduledAction>
Returns Promise<ScheduledAction>
to
- to
Plain Object(): ScheduledActionProps Returns ScheduledActionProps
update
- update(): Promise<ScheduledAction>
Returns Promise<ScheduledAction>
Interface SidebarItem
interface SidebarItem {
disabled?: boolean;
settings?: DefinedParameters;
widgetId: string;
widgetNamespace: string;
}
disabled?: boolean;
settings?: DefinedParameters;
widgetId: string;
widgetNamespace: string;
}
Index
Properties
disabled?
+SidebarItem | contentful-management.js - v11.40.3
Interface SidebarItem
interface SidebarItem {
disabled?: boolean;
settings?: DefinedParameters;
widgetId: string;
widgetNamespace: string;
}
disabled?: boolean;
settings?: DefinedParameters;
widgetId: string;
widgetNamespace: string;
}
Index
Properties
Optionalsettings
Instance parameter values
+widget
widget
ID of the widget used
+widget
widget
Type of the widget used
+
+
diff --git a/contentful-management/latest/interfaces/Snapshot.html b/contentful-management/latest/interfaces/Snapshot.html
index a49f242c5a..3c88ec91f9 100644
--- a/contentful-management/latest/interfaces/Snapshot.html
+++ b/contentful-management/latest/interfaces/Snapshot.html
@@ -1,4 +1,4 @@
-
Interface Snapshot<T>
interface Snapshot<T> {
snapshot: T;
sys: MetaSysProps & {
snapshotEntityType: string;
snapshotType: string;
};
toPlainObject(): SnapshotProps<T>;
}
snapshot: T;
sys: MetaSysProps & {
snapshotEntityType: string;
snapshotType: string;
};
toPlainObject(): SnapshotProps<T>;
}
Type Parameters
Hierarchy (view full)
- SnapshotProps<T>
- DefaultElements<SnapshotProps<T>>
- Snapshot
Index
Properties
snapshot
+Snapshot | contentful-management.js - v11.40.3
to
Interface Snapshot<T>
interface Snapshot<T> {
snapshot: T;
sys: MetaSysProps & {
snapshotEntityType: string;
snapshotType: string;
};
toPlainObject(): SnapshotProps<T>;
}
snapshot: T;
sys: MetaSysProps & {
snapshotEntityType: string;
snapshotType: string;
};
toPlainObject(): SnapshotProps<T>;
}
Type Parameters
Hierarchy (view full)
- SnapshotProps<T>
- DefaultElements<SnapshotProps<T>>
- Snapshot
Index
Properties
Methods
Methods
to
- to
Plain Object(): SnapshotProps<T> Returns SnapshotProps<T>
Methods
to
- to
Plain Object(): SnapshotProps<T> Returns SnapshotProps<T>
Interface SpaceMember
interface SpaceMember {
admin: boolean;
roles: {
sys: MetaLinkProps;
}[];
sys: MetaSysProps;
toPlainObject(): SpaceMemberProps;
}
admin: boolean;
roles: {
sys: MetaLinkProps;
}[];
sys: MetaSysProps;
toPlainObject(): SpaceMemberProps;
}
Hierarchy (view full)
- SpaceMemberProps
- DefaultElements<SpaceMemberProps>
- SpaceMember
Index
Properties
admin
+SpaceMember | contentful-management.js - v11.40.3
to
Interface SpaceMember
interface SpaceMember {
admin: boolean;
roles: {
sys: MetaLinkProps;
}[];
sys: MetaSysProps;
toPlainObject(): SpaceMemberProps;
}
admin: boolean;
roles: {
sys: MetaLinkProps;
}[];
sys: MetaSysProps;
toPlainObject(): SpaceMemberProps;
}
Hierarchy (view full)
- SpaceMemberProps
- DefaultElements<SpaceMemberProps>
- SpaceMember
Index
Properties
Methods
Methods
to
- to
Plain Object(): SpaceMemberProps Returns SpaceMemberProps
roles
Array of Role Links
+sys
Methods
to
- to
Plain Object(): SpaceMemberProps Returns SpaceMemberProps
Interface SpaceMembership
interface SpaceMembership {
admin: boolean;
roles: SysLink[];
sys: MetaSysProps & {
space: SysLink;
user: SysLink;
};
user: SysLink;
delete(): Promise<void>;
toPlainObject(): SpaceMembershipProps;
update(): Promise<SpaceMembership>;
}
admin: boolean;
roles: SysLink[];
sys: MetaSysProps & {
space: SysLink;
user: SysLink;
};
user: SysLink;
delete(): Promise<void>;
toPlainObject(): SpaceMembershipProps;
update(): Promise<SpaceMembership>;
}
Hierarchy (view full)
- SpaceMembershipProps
- DefaultElements<SpaceMembershipProps>
- SpaceMembership
Index
Properties
admin
+SpaceMembership | contentful-management.js - v11.40.3
to
to
Interface SpaceMembership
interface SpaceMembership {
admin: boolean;
roles: SysLink[];
sys: MetaSysProps & {
space: SysLink;
user: SysLink;
};
user: SysLink;
delete(): Promise<void>;
toPlainObject(): SpaceMembershipProps;
update(): Promise<SpaceMembership>;
}
admin: boolean;
roles: SysLink[];
sys: MetaSysProps & {
space: SysLink;
user: SysLink;
};
user: SysLink;
delete(): Promise<void>;
toPlainObject(): SpaceMembershipProps;
update(): Promise<SpaceMembership>;
}
Hierarchy (view full)
- SpaceMembershipProps
- DefaultElements<SpaceMembershipProps>
- SpaceMembership
Methods
delete
to
- to
Plain Object(): SpaceMembershipProps Returns SpaceMembershipProps
update
- update(): Promise<SpaceMembership>
Sends an update to the server with any changes made to the object's properties
+```" aria-label="Permalink" class="tsd-anchor-icon">
to
- to
Plain Object(): SpaceMembershipProps Returns SpaceMembershipProps
update
- update(): Promise<SpaceMembership>
Sends an update to the server with any changes made to the object's properties
Returns Promise<SpaceMembership>
Object returned from the server with updated changes.
Interface SpaceQueryOptions
Hierarchy (view full)
- PaginationQueryOptions
- SpaceQueryOptions
Index
Properties
limit?
+SpaceQueryOptions | contentful-management.js - v11.40.3
+
+
diff --git a/contentful-management/latest/interfaces/Tag.html b/contentful-management/latest/interfaces/Tag.html
index c6cde3ff96..73f1b2c94c 100644
--- a/contentful-management/latest/interfaces/Tag.html
+++ b/contentful-management/latest/interfaces/Tag.html
@@ -1,6 +1,6 @@
-
Interface Tag
interface Tag {
name: string;
sys: TagSysProps;
delete(): Promise<void>;
toPlainObject(): TagProps;
update(): Promise<Tag>;
}
name: string;
sys: TagSysProps;
delete(): Promise<void>;
toPlainObject(): TagProps;
update(): Promise<Tag>;
}
Hierarchy (view full)
- TagProps
- DefaultElements<TagProps>
- TagApi
- Tag
Interface Task
interface Task {
assignedTo: Link<"Team" | "User">;
body: string;
dueDate?: string;
status: TaskStatus;
sys: TaskSysProps;
delete(): Promise<void>;
toPlainObject(): TaskProps;
update(): Promise<Task>;
}
assignedTo: Link<"Team" | "User">;
body: string;
dueDate?: string;
status: TaskStatus;
sys: TaskSysProps;
delete(): Promise<void>;
toPlainObject(): TaskProps;
update(): Promise<Task>;
}
Hierarchy (view full)
- TaskProps
- DefaultElements<TaskProps>
- TaskApi
- Task
Index
Properties
assignedTask | contentful-management.js - v11.40.3
Interface Task
interface Task {
assignedTo: Link<"Team" | "User">;
body: string;
dueDate?: string;
status: TaskStatus;
sys: TaskSysProps;
delete(): Promise<void>;
toPlainObject(): TaskProps;
update(): Promise<Task>;
}
assignedTo: Link<"Team" | "User">;
body: string;
dueDate?: string;
status: TaskStatus;
sys: TaskSysProps;
delete(): Promise<void>;
toPlainObject(): TaskProps;
update(): Promise<Task>;
}
Hierarchy (view full)
- TaskProps
- DefaultElements<TaskProps>
- TaskApi
- Task
Index
Properties
Methods
Interface Team
interface Team {
description: string;
name: string;
sys: MetaSysProps & {
memberCount: number;
organization: {
sys: MetaLinkProps;
};
};
delete(): Promise<void>;
toPlainObject(): TeamProps;
update(): Promise<Team>;
}
description: string;
name: string;
sys: MetaSysProps & {
memberCount: number;
organization: {
sys: MetaLinkProps;
};
};
delete(): Promise<void>;
toPlainObject(): TeamProps;
update(): Promise<Team>;
}
Hierarchy (view full)
Index
Properties
description
+Team | contentful-management.js - v11.40.3
to
to
+```" aria-label="Permalink" class="tsd-anchor-icon">Interface Team
interface Team {
description: string;
name: string;
sys: MetaSysProps & {
memberCount: number;
organization: {
sys: MetaLinkProps;
};
};
delete(): Promise<void>;
toPlainObject(): TeamProps;
update(): Promise<Team>;
}
description: string;
name: string;
sys: MetaSysProps & {
memberCount: number;
organization: {
sys: MetaLinkProps;
};
};
delete(): Promise<void>;
toPlainObject(): TeamProps;
update(): Promise<Team>;
}
Hierarchy (view full)
Index
Properties
Methods
Properties
description
description: string
Description of the team
-name
name: string
Name of the team
-sys
System metadata
- Methods
delete
to
update
- update(): Promise<Team>
Sends an update to the server with any changes made to the object's properties
+```" aria-label="Permalink" class="tsd-anchor-icon">
to
update
Interface TeamMembership
interface TeamMembership {
admin: boolean;
organizationMembershipId: string;
sys: MetaSysProps & {
organization: {
sys: MetaLinkProps;
};
organizationMembership: {
sys: MetaLinkProps;
};
team: {
sys: MetaLinkProps;
};
};
delete(): Promise<void>;
toPlainObject(): TeamMembershipProps;
update(): Promise<TeamMembership>;
}
admin: boolean;
organizationMembershipId: string;
sys: MetaSysProps & {
organization: {
sys: MetaLinkProps;
};
organizationMembership: {
sys: MetaLinkProps;
};
team: {
sys: MetaLinkProps;
};
};
delete(): Promise<void>;
toPlainObject(): TeamMembershipProps;
update(): Promise<TeamMembership>;
}
Hierarchy (view full)
- TeamMembershipProps
- DefaultElements<TeamMembershipProps>
- TeamMembership
Index
Properties
admin
+TeamMembership | contentful-management.js - v11.40.3
organization
organization
to
to
+```" aria-label="Permalink" class="tsd-anchor-icon">Interface TeamMembership
interface TeamMembership {
admin: boolean;
organizationMembershipId: string;
sys: MetaSysProps & {
organization: {
sys: MetaLinkProps;
};
organizationMembership: {
sys: MetaLinkProps;
};
team: {
sys: MetaLinkProps;
};
};
delete(): Promise<void>;
toPlainObject(): TeamMembershipProps;
update(): Promise<TeamMembership>;
}
admin: boolean;
organizationMembershipId: string;
sys: MetaSysProps & {
organization: {
sys: MetaLinkProps;
};
organizationMembership: {
sys: MetaLinkProps;
};
team: {
sys: MetaLinkProps;
};
};
delete(): Promise<void>;
toPlainObject(): TeamMembershipProps;
update(): Promise<TeamMembership>;
}
Hierarchy (view full)
- TeamMembershipProps
- DefaultElements<TeamMembershipProps>
- TeamMembership
Index
Properties
Methods
Properties
admin
admin: boolean
Is admin
-organization
organization
Organization membership id
-sys
sys: MetaSysProps & {
organization: {
sys: MetaLinkProps;
};
organizationMembership: {
sys: MetaLinkProps;
};
team: {
sys: MetaLinkProps;
};
}
organization: {
sys: MetaLinkProps;
};
organizationMembership: {
sys: MetaLinkProps;
};
team: {
sys: MetaLinkProps;
};
}
System metadata
- Methods
delete
organization
organization
Organization membership id
+sys
sys: MetaSysProps & {
organization: {
sys: MetaLinkProps;
};
organizationMembership: {
sys: MetaLinkProps;
};
team: {
sys: MetaLinkProps;
};
}
organization: {
sys: MetaLinkProps;
};
organizationMembership: {
sys: MetaLinkProps;
};
team: {
sys: MetaLinkProps;
};
}
System metadata
+ Methods
delete
to
- to
Plain Object(): TeamMembershipProps Returns TeamMembershipProps
update
- update(): Promise<TeamMembership>
Sends an update to the server with any changes made to the object's properties
+```" aria-label="Permalink" class="tsd-anchor-icon">
to
- to
Plain Object(): TeamMembershipProps Returns TeamMembershipProps
update
- update(): Promise<TeamMembership>
Sends an update to the server with any changes made to the object's properties
Returns Promise<TeamMembership>
Object returned from the server with updated changes.
Interface TeamSpaceMembership
interface TeamSpaceMembership {
admin: boolean;
roles: {
sys: MetaLinkProps;
}[];
sys: MetaSysProps & {
space: {
sys: MetaLinkProps;
};
team: {
sys: MetaLinkProps;
};
};
delete(): Promise<void>;
toPlainObject(): TeamSpaceMembershipProps;
update(): Promise<TeamSpaceMembership>;
}
admin: boolean;
roles: {
sys: MetaLinkProps;
}[];
sys: MetaSysProps & {
space: {
sys: MetaLinkProps;
};
team: {
sys: MetaLinkProps;
};
};
delete(): Promise<void>;
toPlainObject(): TeamSpaceMembershipProps;
update(): Promise<TeamSpaceMembership>;
}
Hierarchy (view full)
- TeamSpaceMembershipProps
- DefaultElements<TeamSpaceMembershipProps>
- TeamSpaceMembership
Index
Properties
admin
+TeamSpaceMembership | contentful-management.js - v11.40.3
to
to
+ ```" aria-label="Permalink" class="tsd-anchor-icon">Interface TeamSpaceMembership
interface TeamSpaceMembership {
admin: boolean;
roles: {
sys: MetaLinkProps;
}[];
sys: MetaSysProps & {
space: {
sys: MetaLinkProps;
};
team: {
sys: MetaLinkProps;
};
};
delete(): Promise<void>;
toPlainObject(): TeamSpaceMembershipProps;
update(): Promise<TeamSpaceMembership>;
}
admin: boolean;
roles: {
sys: MetaLinkProps;
}[];
sys: MetaSysProps & {
space: {
sys: MetaLinkProps;
};
team: {
sys: MetaLinkProps;
};
};
delete(): Promise<void>;
toPlainObject(): TeamSpaceMembershipProps;
update(): Promise<TeamSpaceMembership>;
}
Hierarchy (view full)
- TeamSpaceMembershipProps
- DefaultElements<TeamSpaceMembershipProps>
- TeamSpaceMembership
Methods
delete
to
- to
Plain Object(): TeamSpaceMembershipProps Returns TeamSpaceMembershipProps
update
- update(): Promise<TeamSpaceMembership>
Sends an update to the server with any changes made to the object's properties
+```" aria-label="Permalink" class="tsd-anchor-icon">
to
- to
Plain Object(): TeamSpaceMembershipProps Returns TeamSpaceMembershipProps
update
- update(): Promise<TeamSpaceMembership>
Sends an update to the server with any changes made to the object's properties
Returns Promise<TeamSpaceMembership>
Object returned from the server with updated changes.
Interface UIConfig
interface UIConfig {
assetListViews: ViewFolder[];
entryListViews: ViewFolder[];
homeViews: HomeView[];
sys: UIConfigSysProps;
toPlainObject(): UIConfigProps;
}
assetListViews: ViewFolder[];
entryListViews: ViewFolder[];
homeViews: HomeView[];
sys: UIConfigSysProps;
toPlainObject(): UIConfigProps;
}
Hierarchy (view full)
Index
Properties
assetUIConfig | contentful-management.js - v11.40.3
asset
entry
home
to
Interface UIConfig
interface UIConfig {
assetListViews: ViewFolder[];
entryListViews: ViewFolder[];
homeViews: HomeView[];
sys: UIConfigSysProps;
toPlainObject(): UIConfigProps;
}
assetListViews: ViewFolder[];
entryListViews: ViewFolder[];
homeViews: HomeView[];
sys: UIConfigSysProps;
toPlainObject(): UIConfigProps;
}
Hierarchy (view full)
Index
Properties
Methods
Properties
asset
asset
entry
entry
home
home
sys
sys: UIConfigSysProps
System metadata
- Methods
to
- to
Plain Object(): UIConfigProps Returns UIConfigProps
Properties
asset
asset
entry
entry
home
home
sys
sys: UIConfigSysProps
System metadata
+ Methods
to
- to
Plain Object(): UIConfigProps Returns UIConfigProps
Interface UIExtension
interface UIExtension {
extension: {
fieldTypes: FieldType[];
name: string;
parameters?: {
installation?: ParameterDefinition<InstallationParameterType>[];
instance?: ParameterDefinition<ParameterType>[];
};
sidebar?: boolean;
src?: string;
srcdoc?: string;
};
parameters?: DefinedParameters;
sys: ExtensionSysProps;
delete(): Promise<void>;
toPlainObject(): UIExtensionProps;
update(): Promise<UIExtension>;
}
extension: {
fieldTypes: FieldType[];
name: string;
parameters?: {
installation?: ParameterDefinition<InstallationParameterType>[];
instance?: ParameterDefinition<ParameterType>[];
};
sidebar?: boolean;
src?: string;
srcdoc?: string;
};
parameters?: DefinedParameters;
sys: ExtensionSysProps;
delete(): Promise<void>;
toPlainObject(): UIExtensionProps;
update(): Promise<UIExtension>;
}
Hierarchy (view full)
- UIExtensionProps
- DefaultElements<UIExtensionProps>
- UIExtension
Index
Properties
extension
+UIExtension | contentful-management.js - v11.40.3
to
to
Interface UIExtension
interface UIExtension {
extension: {
fieldTypes: FieldType[];
name: string;
parameters?: {
installation?: ParameterDefinition<InstallationParameterType>[];
instance?: ParameterDefinition<ParameterType>[];
};
sidebar?: boolean;
src?: string;
srcdoc?: string;
};
parameters?: DefinedParameters;
sys: ExtensionSysProps;
delete(): Promise<void>;
toPlainObject(): UIExtensionProps;
update(): Promise<UIExtension>;
}
extension: {
fieldTypes: FieldType[];
name: string;
parameters?: {
installation?: ParameterDefinition<InstallationParameterType>[];
instance?: ParameterDefinition<ParameterType>[];
};
sidebar?: boolean;
src?: string;
srcdoc?: string;
};
parameters?: DefinedParameters;
sys: ExtensionSysProps;
delete(): Promise<void>;
toPlainObject(): UIExtensionProps;
update(): Promise<UIExtension>;
}
Hierarchy (view full)
- UIExtensionProps
- DefaultElements<UIExtensionProps>
- UIExtension
Index
Properties
Methods
delete
@@ -10,8 +10,8 @@
Optionalinstallation?: ParameterDefinition<InstallationParameterType>[]Optionalinstance?: ParameterDefinition<ParameterType>[]
Optionalsidebar?: boolean
Controls the location of the extension. If true it will be rendered on the sidebar instead of replacing the field's editing control
Optionalsrc?: string
URL where the root HTML document of the extension can be found
Optionalsrcdoc?: string
String representation of the extension (e.g. inline HTML code)
-Optionalparameters
Values for installation parameters
-sys
sys: ExtensionSysProps
Optionalparameters
Values for installation parameters
+sys
sys: ExtensionSysProps
Methods
delete
to
- to
Plain Object(): UIExtensionProps Returns UIExtensionProps
update
- update(): Promise<UIExtension>
Sends an update to the server with any changes made to the object's properties
+```" aria-label="Permalink" class="tsd-anchor-icon">
to
- to
Plain Object(): UIExtensionProps Returns UIExtensionProps
update
- update(): Promise<UIExtension>
Sends an update to the server with any changes made to the object's properties
Returns Promise<UIExtension>
Object returned from the server with updated changes.
Interface Upload
interface Upload {
sys: MetaSysProps & {
environment?: SysLink;
space: SysLink;
};
delete(): Promise<void>;
toPlainObject(): UploadProps;
}
sys: MetaSysProps & {
environment?: SysLink;
space: SysLink;
};
delete(): Promise<void>;
toPlainObject(): UploadProps;
}
Hierarchy (view full)
Index
Properties
sys
+Upload | contentful-management.js - v11.40.3
to
Interface Upload
interface Upload {
sys: MetaSysProps & {
environment?: SysLink;
space: SysLink;
};
delete(): Promise<void>;
toPlainObject(): UploadProps;
}
sys: MetaSysProps & {
environment?: SysLink;
space: SysLink;
};
delete(): Promise<void>;
toPlainObject(): UploadProps;
}
Hierarchy (view full)
Index
Properties
Methods
Methods
delete
- delete(): Promise<void>
Deletes this object on the server.
Returns Promise<void>
Promise for the deletion. It contains no data, but the Promise error case should be handled.
Example
-const contentful = require('contentful-management')
const client = contentful.createClient({
accessToken: '<content_management_api_key>'
})
client.getSpace('<space_id>')
.then((space) => space.getEnvironment('<environment_id>'))
.then((environment) => environment.getUpload('<upload_id>'))
.then((upload) => upload.delete())
.then((upload) => console.log(`upload ${upload.sys.id} updated.`))
.catch(console.error)
to
- to
Plain Object(): UploadProps Returns UploadProps
to
- to
Plain Object(): UploadProps Returns UploadProps
Interface UploadCredential
interface UploadCredential {
sys: MetaSysProps & {
environment?: SysLink;
space: SysLink;
};
create(): Promise<UploadCredentialProps>;
toPlainObject(): UploadCredentialProps;
}
sys: MetaSysProps & {
environment?: SysLink;
space: SysLink;
};
create(): Promise<UploadCredentialProps>;
toPlainObject(): UploadCredentialProps;
}
Hierarchy (view full)
- UploadCredentialProps
- DefaultElements<UploadCredentialProps>
- UploadCredential
Index
Properties
sys
+UploadCredential | contentful-management.js - v11.40.3
to
Interface UploadCredential
interface UploadCredential {
sys: MetaSysProps & {
environment?: SysLink;
space: SysLink;
};
create(): Promise<UploadCredentialProps>;
toPlainObject(): UploadCredentialProps;
}
sys: MetaSysProps & {
environment?: SysLink;
space: SysLink;
};
create(): Promise<UploadCredentialProps>;
toPlainObject(): UploadCredentialProps;
}
Hierarchy (view full)
- UploadCredentialProps
- DefaultElements<UploadCredentialProps>
- UploadCredential
Index
Properties
Methods
Methods
create
- create(): Promise<UploadCredentialProps>
creates the upload credentials.
+
Methods
create
- create(): Promise<UploadCredentialProps>
creates the upload credentials.
Returns Promise<UploadCredentialProps>
upload credentials for file uploads
Example
-const contentful = require('contentful-management')
const client = contentful.createClient({
accessToken: '<content_management_api_key>'
})
try {
const space = await client.getSpace('<space_id>')
const environment = await space.getEnvironment('<environment_id>')
const upload = await client.uploadCredential.create({
spaceId: space.sys.id,
environmentId: environment.sys.id
})
} catch (error) {
console.error(error)
}
to
- to
Plain Object(): UploadCredentialProps Returns UploadCredentialProps
to
- to
Plain Object(): UploadCredentialProps Returns UploadCredentialProps
Interface Usage
interface Usage {
dateRange: {
endAt: string;
startAt: string;
};
metric: UsageMetricEnum;
sys: MetaSysProps & {
organization?: {
sys: MetaLinkProps;
};
};
unitOfMeasure: string;
usage: number;
usagePerDay: {
[key: string]: number;
};
toPlainObject(): UsageProps;
}
dateRange: {
endAt: string;
startAt: string;
};
metric: UsageMetricEnum;
sys: MetaSysProps & {
organization?: {
sys: MetaLinkProps;
};
};
unitOfMeasure: string;
usage: number;
usagePerDay: {
[key: string]: number;
};
toPlainObject(): UsageProps;
}
Hierarchy (view full)
Index
Properties
dateUsage | contentful-management.js - v11.40.3
date
unit
usage
to
Interface Usage
interface Usage {
dateRange: {
endAt: string;
startAt: string;
};
metric: UsageMetricEnum;
sys: MetaSysProps & {
organization?: {
sys: MetaLinkProps;
};
};
unitOfMeasure: string;
usage: number;
usagePerDay: {
[key: string]: number;
};
toPlainObject(): UsageProps;
}
dateRange: {
endAt: string;
startAt: string;
};
metric: UsageMetricEnum;
sys: MetaSysProps & {
organization?: {
sys: MetaLinkProps;
};
};
unitOfMeasure: string;
usage: number;
usagePerDay: {
[key: string]: number;
};
toPlainObject(): UsageProps;
}
Hierarchy (view full)
Index
Properties
Methods
Properties
date
date
endAt: string;
startAt: string;
}
endAt: string;
startAt: string;
}
Range of usage
-metric
metric: UsageMetricEnum
Type of usage
-sys
System metadata
-unit
unit
Unit of usage metric
-usage
usage: number
Value of the usage
-usage
usage
[key: string]: number;
}
[key: string]: number;
}
Usage per day
- Methods
to
- to
Plain Object(): UsageProps Returns UsageProps
metric
metric: UsageMetricEnum
Type of usage
+sys
System metadata
+unit
unit
Unit of usage metric
+usage
usage: number
Value of the usage
+usage
usage
[key: string]: number;
}
[key: string]: number;
}
Usage per day
+ Methods
to
- to
Plain Object(): UsageProps Returns UsageProps
Interface User
interface User {
2faEnabled: boolean;
activated: boolean;
avatarUrl: string;
confirmed: boolean;
cookieConsentData: string;
email: string;
firstName: string;
lastName: string;
signInCount: number;
sys: BasicMetaSysProps;
toPlainObject(): UserProps;
}
2faEnabled: boolean;
activated: boolean;
avatarUrl: string;
confirmed: boolean;
cookieConsentData: string;
email: string;
firstName: string;
lastName: string;
signInCount: number;
sys: BasicMetaSysProps;
toPlainObject(): UserProps;
}
Hierarchy (view full)
Index
Properties
2faUser | contentful-management.js - v11.40.3
2fa
avatar
cookie
email
first
last
sign
Interface User
interface User {
2faEnabled: boolean;
activated: boolean;
avatarUrl: string;
confirmed: boolean;
cookieConsentData: string;
email: string;
firstName: string;
lastName: string;
signInCount: number;
sys: BasicMetaSysProps;
toPlainObject(): UserProps;
}
2faEnabled: boolean;
activated: boolean;
avatarUrl: string;
confirmed: boolean;
cookieConsentData: string;
email: string;
firstName: string;
lastName: string;
signInCount: number;
sys: BasicMetaSysProps;
toPlainObject(): UserProps;
}
Hierarchy (view full)
Index
Properties
Methods
Properties
2fa
2fa
activated
activated: boolean
Activation flag
-avatar
avatar
Url to the users avatar
-confirmed
confirmed: boolean
User confirmation flag
-cookie
cookie
email: string
Email address of the user
-first
first
First name of the user
-last
last
Last name of the user
-sign
sign
Number of sign ins
-sys
System metadata
- Properties
2fa
2fa
activated
activated: boolean
Activation flag
+avatar
avatar
Url to the users avatar
+confirmed
confirmed: boolean
User confirmation flag
+cookie
cookie
email: string
Email address of the user
+first
first
First name of the user
+last
last
Last name of the user
+sign
sign
Number of sign ins
+sys
System metadata
+Interface UserUIConfig
interface UserUIConfig {
assetListViews: ViewFolder[];
entryListViews: ViewFolder[];
sys: UserUIConfigSysProps;
toPlainObject(): UserUIConfigProps;
}
assetListViews: ViewFolder[];
entryListViews: ViewFolder[];
sys: UserUIConfigSysProps;
toPlainObject(): UserUIConfigProps;
}
Hierarchy (view full)
- UserUIConfigProps
- DefaultElements<UserUIConfigProps>
- UserUIConfig
Index
Properties
assetUserUIConfig | contentful-management.js - v11.40.3
asset
entry
to
Interface UserUIConfig
interface UserUIConfig {
assetListViews: ViewFolder[];
entryListViews: ViewFolder[];
sys: UserUIConfigSysProps;
toPlainObject(): UserUIConfigProps;
}
assetListViews: ViewFolder[];
entryListViews: ViewFolder[];
sys: UserUIConfigSysProps;
toPlainObject(): UserUIConfigProps;
}
Hierarchy (view full)
- UserUIConfigProps
- DefaultElements<UserUIConfigProps>
- UserUIConfig
Index
Properties
Methods
Properties
asset
asset
entry
entry
sys
sys: UserUIConfigSysProps
System metadata
- Methods
to
- to
Plain Object(): UserUIConfigProps Returns UserUIConfigProps
Properties
asset
asset
entry
entry
sys
sys: UserUIConfigSysProps
System metadata
+ Methods
to
- to
Plain Object(): UserUIConfigProps Returns UserUIConfigProps
+
diff --git a/contentful-management/latest/interfaces/WebHooks.html b/contentful-management/latest/interfaces/WebHooks.html
index c59bb006f1..a5e6c746f0 100644
--- a/contentful-management/latest/interfaces/WebHooks.html
+++ b/contentful-management/latest/interfaces/WebHooks.html
@@ -1,4 +1,4 @@
-
Interface WebHooks
interface WebHooks {
active: boolean;
filters?: WebhookFilter[];
headers: WebhookHeader[];
httpBasicPassword?: string;
httpBasicUsername?: string;
name: string;
sys: BasicMetaSysProps & {
space: SysLink;
};
topics: string[];
transformation?: WebhookTransformation;
url: string;
delete(): Promise<void>;
getCall(id: string): Promise<WebhookCallDetailsProps>;
getCalls(): Promise<CollectionProp<{
errors: any[];
eventType: string;
requestAt: string;
responseAt: string;
statusCode: number;
sys: {
createdAt: string;
createdBy?: SysLink;
id: string;
type: string;
};
url: string;
}>>;
getHealth(): Promise<WebhookHealthProps>;
toPlainObject(): WebhookProps;
update(): Promise<WebHooks>;
}
active: boolean;
filters?: WebhookFilter[];
headers: WebhookHeader[];
httpBasicPassword?: string;
httpBasicUsername?: string;
name: string;
sys: BasicMetaSysProps & {
space: SysLink;
};
topics: string[];
transformation?: WebhookTransformation;
url: string;
delete(): Promise<void>;
getCall(id: string): Promise<WebhookCallDetailsProps>;
getCalls(): Promise<CollectionProp<{
errors: any[];
eventType: string;
requestAt: string;
responseAt: string;
statusCode: number;
sys: {
createdAt: string;
createdBy?: SysLink;
id: string;
type: string;
};
url: string;
}>>;
getHealth(): Promise<WebhookHealthProps>;
toPlainObject(): WebhookProps;
update(): Promise<WebHooks>;
}
Hierarchy (view full)
- WebhookProps
- DefaultElements<WebhookProps>
- WebHooks
Index
Properties
active
+WebHooks | contentful-management.js - v11.40.3
get
AppActionCallProps | contentful-management.js - v11.40.2 AppActionCallProps | contentful-management.js - v11.40.3 AppActionCategoryProps | contentful-management.js - v11.40.2 AppActionCategoryProps | contentful-management.js - v11.40.3 AppActionCategoryType | contentful-management.js - v11.40.2 AppActionCategoryType | contentful-management.js - v11.40.3 AppActionParameterDefinition | contentful-management.js - v11.40.2 AppActionParameterDefinition | contentful-management.js - v11.40.3 AppActionProps | contentful-management.js - v11.40.2 AppActionType | contentful-management.js - v11.40.2 AppActionType | contentful-management.js - v11.40.3 AppBundleFile | contentful-management.js - v11.40.2 AppBundleFile | contentful-management.js - v11.40.3 AppBundleProps | contentful-management.js - v11.40.2 AppDefinition | contentful-management.js - v11.40.2 AppDefinition | contentful-management.js - v11.40.3 AppDefinitionProps | contentful-management.js - v11.40.2 AppDetailsProps | contentful-management.js - v11.40.2 AppEventSubscriptionProps | contentful-management.js - v11.40.2 AppInstallationProps | contentful-management.js - v11.40.2 AppInstallationProps | contentful-management.js - v11.40.3 AppKeyProps | contentful-management.js - v11.40.2 AppLocation | contentful-management.js - v11.40.2 AppLocation | contentful-management.js - v11.40.3 AppSignedRequestProps | contentful-management.js - v11.40.2 AppSigningSecretProps | contentful-management.js - v11.40.2 AppUploadProps | contentful-management.js - v11.40.2 AppUploadProps | contentful-management.js - v11.40.3 AssetKeyProps | contentful-management.js - v11.40.2 AssetProps | contentful-management.js - v11.40.2 BulkActionPayload | contentful-management.js - v11.40.2 BulkActionPayload | contentful-management.js - v11.40.3 BulkActionType | contentful-management.js - v11.40.2 BulkActionType | contentful-management.js - v11.40.3 ClientAPI | contentful-management.js - v11.40.2 ClientAPI | contentful-management.js - v11.40.3 ClientParams | contentful-management.js - v11.40.2 ClientParams | contentful-management.js - v11.40.3 CommentProps | contentful-management.js - v11.40.2 CommentProps | contentful-management.js - v11.40.3 ConceptProps | contentful-management.js - v11.40.2 ConceptProps | contentful-management.js - v11.40.3 ConceptSchemeProps | contentful-management.js - v11.40.2 ConceptSchemeProps | contentful-management.js - v11.40.3 ContentTypeMetadata | contentful-management.js - v11.40.2 ContentTypeMetadata | contentful-management.js - v11.40.3 ContentTypeProps | contentful-management.js - v11.40.2 CreateApiKeyProps | contentful-management.js - v11.40.2 CreateApiKeyProps | contentful-management.js - v11.40.3 CreateAppAccessTokenProps | contentful-management.js - v11.40.2 CreateAppAccessTokenProps | contentful-management.js - v11.40.3 CreateAppActionCallProps | contentful-management.js - v11.40.2 CreateAppActionCallProps | contentful-management.js - v11.40.3 CreateAppActionProps | contentful-management.js - v11.40.2 CreateAppActionProps | contentful-management.js - v11.40.3 CreateAppBundleProps | contentful-management.js - v11.40.2 CreateAppBundleProps | contentful-management.js - v11.40.3 CreateAppDefinitionProps | contentful-management.js - v11.40.2 CreateAppDefinitionProps | contentful-management.js - v11.40.3 CreateAppDetailsProps | contentful-management.js - v11.40.2 CreateAppDetailsProps | contentful-management.js - v11.40.3 CreateAppEventSubscriptionProps | contentful-management.js - v11.40.2 CreateAppEventSubscriptionProps | contentful-management.js - v11.40.3 CreateAppInstallationProps | contentful-management.js - v11.40.2 CreateAppInstallationProps | contentful-management.js - v11.40.3 CreateAppKeyProps | contentful-management.js - v11.40.2 CreateAppSignedRequestProps | contentful-management.js - v11.40.2 CreateAppSigningSecretProps | contentful-management.js - v11.40.2 CreateAppSigningSecretProps | contentful-management.js - v11.40.3 CreateAssetKeyProps | contentful-management.js - v11.40.2 CreateAssetKeyProps | contentful-management.js - v11.40.3 CreateAssetProps | contentful-management.js - v11.40.2 CreateAssetProps | contentful-management.js - v11.40.3 CreateCommentProps | contentful-management.js - v11.40.2 CreateCommentProps | contentful-management.js - v11.40.3 CreateConceptProps | contentful-management.js - v11.40.2 CreateConceptProps | contentful-management.js - v11.40.3 CreateConceptSchemeProps | contentful-management.js - v11.40.2 CreateConceptSchemeProps | contentful-management.js - v11.40.3 CreateContentTypeProps | contentful-management.js - v11.40.2 CreateContentTypeProps | contentful-management.js - v11.40.3 CreateEntryProps | contentful-management.js - v11.40.2 CreateEntryProps | contentful-management.js - v11.40.3 CreateEnvironmentAliasProps | contentful-management.js - v11.40.2 CreateEnvironmentAliasProps | contentful-management.js - v11.40.3 CreateEnvironmentProps | contentful-management.js - v11.40.2 CreateEnvironmentProps | contentful-management.js - v11.40.3 CreateEnvironmentTemplateInstallationProps | contentful-management.js - v11.40.2 CreateEnvironmentTemplateInstallationProps | contentful-management.js - v11.40.3 CreateEnvironmentTemplateProps | contentful-management.js - v11.40.2 CreateEnvironmentTemplateProps | contentful-management.js - v11.40.3 CreateLocaleProps | contentful-management.js - v11.40.2 CreateLocaleProps | contentful-management.js - v11.40.3 CreateOrganizationInvitationProps | contentful-management.js - v11.40.2 CreateOrganizationInvitationProps | contentful-management.js - v11.40.3 CreatePATProps | contentful-management.js - v11.40.2 CreatePATProps | contentful-management.js - v11.40.3 CreatePersonalAccessTokenProps | contentful-management.js - v11.40.2 CreatePersonalAccessTokenProps | contentful-management.js - v11.40.3 CreateRoleProps | contentful-management.js - v11.40.2 CreateRoleProps | contentful-management.js - v11.40.3 CreateSpaceMembershipProps | contentful-management.js - v11.40.2 CreateSpaceMembershipProps | contentful-management.js - v11.40.3 CreateTagProps | contentful-management.js - v11.40.2 CreateTagProps | contentful-management.js - v11.40.3 CreateTaskProps | contentful-management.js - v11.40.2 CreateTaskProps | contentful-management.js - v11.40.3 CreateTeamMembershipProps | contentful-management.js - v11.40.2 CreateTeamMembershipProps | contentful-management.js - v11.40.3 CreateTeamProps | contentful-management.js - v11.40.2 CreateTeamProps | contentful-management.js - v11.40.3 CreateTeamSpaceMembershipProps | contentful-management.js - v11.40.2 CreateTeamSpaceMembershipProps | contentful-management.js - v11.40.3 CreateUIExtensionProps | contentful-management.js - v11.40.2 CreateUIExtensionProps | contentful-management.js - v11.40.3 CreateWebhooksProps | contentful-management.js - v11.40.2 CreateWebhooksProps | contentful-management.js - v11.40.3 CreateWithResponseParams | contentful-management.js - v11.40.2 CreateWithResponseParams | contentful-management.js - v11.40.3 CreateWorkflowDefinitionParams | contentful-management.js - v11.40.2 CreateWorkflowDefinitionParams | contentful-management.js - v11.40.3 CreateWorkflowDefinitionProps | contentful-management.js - v11.40.2 CreateWorkflowDefinitionProps | contentful-management.js - v11.40.3 CreateWorkflowProps | contentful-management.js - v11.40.2 CreateWorkflowProps | contentful-management.js - v11.40.3 CreateWorkflowStepProps | contentful-management.js - v11.40.2 CreateWorkflowStepProps | contentful-management.js - v11.40.3 DefinedParameters | contentful-management.js - v11.40.2 DefinedParameters | contentful-management.js - v11.40.3 DeleteCommentParams | contentful-management.js - v11.40.2 DeleteCommentParams | contentful-management.js - v11.40.3 DeleteConceptParams | contentful-management.js - v11.40.2 DeleteConceptParams | contentful-management.js - v11.40.3 DeleteConceptSchemeParams | contentful-management.js - v11.40.2 DeleteConceptSchemeParams | contentful-management.js - v11.40.3 DeleteWorkflowDefinitionParams | contentful-management.js - v11.40.2 DeleteWorkflowDefinitionParams | contentful-management.js - v11.40.3 DeleteWorkflowParams | contentful-management.js - v11.40.2 DeleteWorkflowParams | contentful-management.js - v11.40.3 EditorInterfaceProps | contentful-management.js - v11.40.2 EditorLayoutItem | contentful-management.js - v11.40.2 EditorLayoutItem | contentful-management.js - v11.40.3 EntryProps | contentful-management.js - v11.40.2 EntryProps | contentful-management.js - v11.40.3 Environment | contentful-management.js - v11.40.2 Environment | contentful-management.js - v11.40.3 EnvironmentAliasProps | contentful-management.js - v11.40.2 EnvironmentAliasProps | contentful-management.js - v11.40.3 EnvironmentProps | contentful-management.js - v11.40.2 EnvironmentTemplate | contentful-management.js - v11.40.2 EnvironmentTemplate | contentful-management.js - v11.40.3 EnvironmentTemplateInstallation | contentful-management.js - v11.40.2 EnvironmentTemplateInstallation | contentful-management.js - v11.40.3 EnvironmentTemplateInstallationProps | contentful-management.js - v11.40.2 EnvironmentTemplateInstallationProps | contentful-management.js - v11.40.3 EnvironmentTemplateInstallationStatus | contentful-management.js - v11.40.2 EnvironmentTemplateInstallationStatus | contentful-management.js - v11.40.3 EnvironmentTemplateParams | contentful-management.js - v11.40.2 EnvironmentTemplateParams | contentful-management.js - v11.40.3 EnvironmentTemplateProps | contentful-management.js - v11.40.2 EnvironmentTemplateProps | contentful-management.js - v11.40.3 EnvironmentTemplateValidationProps | contentful-management.js - v11.40.2 EnvironmentTemplateValidationProps | contentful-management.js - v11.40.3 FieldType | contentful-management.js - v11.40.2 FieldType | contentful-management.js - v11.40.3 FreeFormParameters | contentful-management.js - v11.40.2 FreeFormParameters | contentful-management.js - v11.40.3 FunctionProps | contentful-management.js - v11.40.2 FunctionProps | contentful-management.js - v11.40.3 GetAppActionCallDetailsParams | contentful-management.js - v11.40.2 GetAppActionCallDetailsParams | contentful-management.js - v11.40.3 GetAppActionCallParams | contentful-management.js - v11.40.2 GetAppActionCallParams | contentful-management.js - v11.40.3 GetAppActionParams | contentful-management.js - v11.40.2 GetAppActionParams | contentful-management.js - v11.40.3 GetAppActionsForEnvParams | contentful-management.js - v11.40.2 GetAppActionsForEnvParams | contentful-management.js - v11.40.3 GetAppBundleParams | contentful-management.js - v11.40.2 GetAppBundleParams | contentful-management.js - v11.40.3 GetAppDefinitionParams | contentful-management.js - v11.40.2 GetAppDefinitionParams | contentful-management.js - v11.40.3 GetAppInstallationParams | contentful-management.js - v11.40.2 GetAppInstallationParams | contentful-management.js - v11.40.3 GetAppInstallationsForOrgParams | contentful-management.js - v11.40.2 GetAppInstallationsForOrgParams | contentful-management.js - v11.40.3 GetAppKeyParams | contentful-management.js - v11.40.2 GetAppKeyParams | contentful-management.js - v11.40.3 GetAppUploadParams | contentful-management.js - v11.40.2 GetAppUploadParams | contentful-management.js - v11.40.3 GetBulkActionParams | contentful-management.js - v11.40.2 GetBulkActionParams | contentful-management.js - v11.40.3 GetCommentParams | contentful-management.js - v11.40.2 GetCommentParams | contentful-management.js - v11.40.3 GetCommentParentEntityParams | contentful-management.js - v11.40.2 GetCommentParentEntityParams | contentful-management.js - v11.40.3 GetConceptDescendantsParams | contentful-management.js - v11.40.2 GetConceptDescendantsParams | contentful-management.js - v11.40.3 GetConceptParams | contentful-management.js - v11.40.2 GetConceptParams | contentful-management.js - v11.40.3 GetConceptSchemeParams | contentful-management.js - v11.40.2 GetConceptSchemeParams | contentful-management.js - v11.40.3 GetContentTypeParams | contentful-management.js - v11.40.2 GetContentTypeParams | contentful-management.js - v11.40.3 GetEditorInterfaceParams | contentful-management.js - v11.40.2 GetEditorInterfaceParams | contentful-management.js - v11.40.3 GetEntryParams | contentful-management.js - v11.40.2 GetEntryParams | contentful-management.js - v11.40.3 GetEnvironmentTemplateParams | contentful-management.js - v11.40.2 GetEnvironmentTemplateParams | contentful-management.js - v11.40.3 GetExtensionParams | contentful-management.js - v11.40.2 GetExtensionParams | contentful-management.js - v11.40.3 GetManyCommentsParams | contentful-management.js - v11.40.2 GetManyCommentsParams | contentful-management.js - v11.40.3 GetManyConceptParams | contentful-management.js - v11.40.2 GetManyConceptParams | contentful-management.js - v11.40.3 GetManyConceptSchemeParams | contentful-management.js - v11.40.2 GetManyConceptSchemeParams | contentful-management.js - v11.40.3 GetOrganizationMembershipParams | contentful-management.js - v11.40.2 GetOrganizationMembershipParams | contentful-management.js - v11.40.3 GetOrganizationParams | contentful-management.js - v11.40.2 GetOrganizationParams | contentful-management.js - v11.40.3 GetReleaseParams | contentful-management.js - v11.40.2 GetReleaseParams | contentful-management.js - v11.40.3 GetResourceParams | contentful-management.js - v11.40.2 GetResourceParams | contentful-management.js - v11.40.3 GetResourceProviderParams | contentful-management.js - v11.40.2 GetResourceProviderParams | contentful-management.js - v11.40.3 GetResourceTypeParams | contentful-management.js - v11.40.2 GetResourceTypeParams | contentful-management.js - v11.40.3 GetSnapshotForContentTypeParams | contentful-management.js - v11.40.2 GetSnapshotForContentTypeParams | contentful-management.js - v11.40.3 GetSnapshotForEntryParams | contentful-management.js - v11.40.2 GetSnapshotForEntryParams | contentful-management.js - v11.40.3 GetSpaceEnvAliasParams | contentful-management.js - v11.40.2 GetSpaceEnvAliasParams | contentful-management.js - v11.40.3 GetSpaceEnvironmentParams | contentful-management.js - v11.40.2 GetSpaceEnvironmentParams | contentful-management.js - v11.40.3 GetSpaceEnvironmentUploadParams | contentful-management.js - v11.40.2 GetSpaceEnvironmentUploadParams | contentful-management.js - v11.40.3 GetSpaceMembershipProps | contentful-management.js - v11.40.2 GetSpaceMembershipProps | contentful-management.js - v11.40.3 GetSpaceParams | contentful-management.js - v11.40.2 GetSpaceParams | contentful-management.js - v11.40.3 GetTagParams | contentful-management.js - v11.40.2 GetTagParams | contentful-management.js - v11.40.3 GetTaskParams | contentful-management.js - v11.40.2 GetTaskParams | contentful-management.js - v11.40.3 GetTeamMembershipParams | contentful-management.js - v11.40.2 GetTeamMembershipParams | contentful-management.js - v11.40.3 GetTeamParams | contentful-management.js - v11.40.2 GetTeamParams | contentful-management.js - v11.40.3 GetTeamSpaceMembershipParams | contentful-management.js - v11.40.2 GetTeamSpaceMembershipParams | contentful-management.js - v11.40.3 GetUIConfigParams | contentful-management.js - v11.40.2 GetUIConfigParams | contentful-management.js - v11.40.3 GetUserUIConfigParams | contentful-management.js - v11.40.2 GetUserUIConfigParams | contentful-management.js - v11.40.3 GetWebhookCallDetailsUrl | contentful-management.js - v11.40.2 GetWebhookCallDetailsUrl | contentful-management.js - v11.40.3 GetWebhookParams | contentful-management.js - v11.40.2 GetWebhookParams | contentful-management.js - v11.40.3 GetWorkflowDefinitionParams | contentful-management.js - v11.40.2 GetWorkflowDefinitionParams | contentful-management.js - v11.40.3 GetWorkflowParams | contentful-management.js - v11.40.2 GetWorkflowParams | contentful-management.js - v11.40.3 Hint | contentful-management.js - v11.40.2 Hint | contentful-management.js - v11.40.3 ISO8601Timestamp | contentful-management.js - v11.40.2 ISO8601Timestamp | contentful-management.js - v11.40.3 IconType | contentful-management.js - v11.40.2 IconType | contentful-management.js - v11.40.3 InstallationParameterType | contentful-management.js - v11.40.2 InstallationParameterType | contentful-management.js - v11.40.3 KeyValueMap | contentful-management.js - v11.40.2 KeyValueMap | contentful-management.js - v11.40.3 LocaleProps | contentful-management.js - v11.40.2 Organization | contentful-management.js - v11.40.2 Organization | contentful-management.js - v11.40.3 OrganizationInvitationProps | contentful-management.js - v11.40.2 OrganizationInvitationProps | contentful-management.js - v11.40.3 OrganizationMembershipProps | contentful-management.js - v11.40.2 OrganizationProp | contentful-management.js - v11.40.2 OrganizationProp | contentful-management.js - v11.40.3 OrganizationProps | contentful-management.js - v11.40.2 PaginationQueryParams | contentful-management.js - v11.40.2 PaginationQueryParams | contentful-management.js - v11.40.3 ParameterOption | contentful-management.js - v11.40.2 ParameterOption | contentful-management.js - v11.40.3 ParameterType | contentful-management.js - v11.40.2 ParameterType | contentful-management.js - v11.40.3 PersonalAccessTokenProp | contentful-management.js - v11.40.2 PersonalAccessTokenProp | contentful-management.js - v11.40.3 PersonalAccessTokenProps | contentful-management.js - v11.40.2 PersonalAccessTokenProps | contentful-management.js - v11.40.3 PlainClientAPI | contentful-management.js - v11.40.2 PlainClientAPI | contentful-management.js - v11.40.3 PlainClientDefaultParams | contentful-management.js - v11.40.2 PlainClientDefaultParams | contentful-management.js - v11.40.3 PreviewApiKeyProps | contentful-management.js - v11.40.2 PreviewApiKeyProps | contentful-management.js - v11.40.3 QueryParams | contentful-management.js - v11.40.2 QueryParams | contentful-management.js - v11.40.3 ReleaseActionSysProps | contentful-management.js - v11.40.2 ReleaseActionSysProps | contentful-management.js - v11.40.3 ReleaseActionTypes | contentful-management.js - v11.40.2 ReleaseActionTypes | contentful-management.js - v11.40.3 ReleaseMetadata | contentful-management.js - v11.40.2 ReleaseMetadata | contentful-management.js - v11.40.3 ReleaseReferenceFilters | contentful-management.js - v11.40.2 ReleaseReferenceFilters | contentful-management.js - v11.40.3 ReleaseSysProps | contentful-management.js - v11.40.2 ReleaseSysProps | contentful-management.js - v11.40.3 ResourceProps | contentful-management.js - v11.40.2 ResourceProps | contentful-management.js - v11.40.3 ResourceProviderProps | contentful-management.js - v11.40.2 ResourceQueryOptions | contentful-management.js - v11.40.2 ResourceQueryOptions | contentful-management.js - v11.40.3 ResourceTypeProps | contentful-management.js - v11.40.2 RichTextCommentProps | contentful-management.js - v11.40.2 RichTextCommentProps | contentful-management.js - v11.40.3 RoleProps | contentful-management.js - v11.40.2 RoleProps | contentful-management.js - v11.40.3 ScheduledActionProps | contentful-management.js - v11.40.2 ScheduledActionSysProps | contentful-management.js - v11.40.2 SnapshotProps | contentful-management.js - v11.40.2 SnapshotProps | contentful-management.js - v11.40.3 Space | contentful-management.js - v11.40.2 Space | contentful-management.js - v11.40.3 SpaceEnvResourceTypeProps | contentful-management.js - v11.40.2 SpaceEnvResourceTypeProps | contentful-management.js - v11.40.3 SpaceMemberProps | contentful-management.js - v11.40.2 SpaceMembershipProps | contentful-management.js - v11.40.2 SpaceMembershipProps | contentful-management.js - v11.40.3 SpaceProps | contentful-management.js - v11.40.2 SpaceProps | contentful-management.js - v11.40.3 SpaceQueryParams | contentful-management.js - v11.40.2 SpaceQueryParams | contentful-management.js - v11.40.3 TagProps | contentful-management.js - v11.40.2 TagProps | contentful-management.js - v11.40.3 TagVisibility | contentful-management.js - v11.40.2 TagVisibility | contentful-management.js - v11.40.3 TaskProps | contentful-management.js - v11.40.2 TaskProps | contentful-management.js - v11.40.3 TeamMembershipProps | contentful-management.js - v11.40.2 TeamProps | contentful-management.js - v11.40.2 TeamSpaceMembershipProps | contentful-management.js - v11.40.2 UIConfigProps | contentful-management.js - v11.40.2 UIConfigProps | contentful-management.js - v11.40.3 UIExtensionProps | contentful-management.js - v11.40.2 UpdateCommentProps | contentful-management.js - v11.40.2 UpdateCommentProps | contentful-management.js - v11.40.3 UpdateConceptParams | contentful-management.js - v11.40.2 UpdateConceptParams | contentful-management.js - v11.40.3 UpdateConceptSchemeParams | contentful-management.js - v11.40.2 UpdateConceptSchemeParams | contentful-management.js - v11.40.3 UpdateTaskProps | contentful-management.js - v11.40.2 UpdateTaskProps | contentful-management.js - v11.40.3 UpdateWebhookProps | contentful-management.js - v11.40.2 UpdateWebhookProps | contentful-management.js - v11.40.3 UpdateWorkflowDefinitionParams | contentful-management.js - v11.40.2 UpdateWorkflowDefinitionParams | contentful-management.js - v11.40.3 UpdateWorkflowDefinitionProps | contentful-management.js - v11.40.2 UpdateWorkflowDefinitionProps | contentful-management.js - v11.40.3 UpdateWorkflowProps | contentful-management.js - v11.40.2 UpdateWorkflowProps | contentful-management.js - v11.40.3 UpdateWorkflowStepProps | contentful-management.js - v11.40.2 UpdateWorkflowStepProps | contentful-management.js - v11.40.3 UploadCredentialProps | contentful-management.js - v11.40.2 UploadCredentialProps | contentful-management.js - v11.40.3 UploadProps | contentful-management.js - v11.40.2 UploadProps | contentful-management.js - v11.40.3 UpsertResourceProviderProps | contentful-management.js - v11.40.2 UpsertResourceProviderProps | contentful-management.js - v11.40.3 UpsertResourceTypeProps | contentful-management.js - v11.40.2 UpsertResourceTypeProps | contentful-management.js - v11.40.3 UpsertWebhookSigningSecretPayload | contentful-management.js - v11.40.2 UpsertWebhookSigningSecretPayload | contentful-management.js - v11.40.3 UsageProps | contentful-management.js - v11.40.2 UserProps | contentful-management.js - v11.40.2 UserUIConfigProps | contentful-management.js - v11.40.2 UserUIConfigProps | contentful-management.js - v11.40.3 ValidateEnvironmentTemplateInstallationProps | contentful-management.js - v11.40.2 ValidateEnvironmentTemplateInstallationProps | contentful-management.js - v11.40.3 ValidationFinding | contentful-management.js - v11.40.2 ValidationFinding | contentful-management.js - v11.40.3 WebhookCallRequest | contentful-management.js - v11.40.2 WebhookCallRequest | contentful-management.js - v11.40.3 WebhookFilter | contentful-management.js - v11.40.2 WebhookFilter | contentful-management.js - v11.40.3 WebhookProps | contentful-management.js - v11.40.2 WebhookSigningSecretProps | contentful-management.js - v11.40.2 WebhookSigningSecretProps | contentful-management.js - v11.40.3 WebhookTransformation | contentful-management.js - v11.40.2 WebhookTransformation | contentful-management.js - v11.40.3 WithResourceName | contentful-management.js - v11.40.2 WithResourceName | contentful-management.js - v11.40.3 WorkflowDefinitionProps | contentful-management.js - v11.40.2 WorkflowDefinitionProps | contentful-management.js - v11.40.3 WorkflowDefinitionQueryOptions | contentful-management.js - v11.40.2 WorkflowDefinitionQueryOptions | contentful-management.js - v11.40.3 WorkflowDefinitionSysProps | contentful-management.js - v11.40.2 WorkflowDefinitionSysProps | contentful-management.js - v11.40.3 WorkflowDefinitionValidationLink | contentful-management.js - v11.40.2 WorkflowDefinitionValidationLink | contentful-management.js - v11.40.3 WorkflowProps | contentful-management.js - v11.40.2 WorkflowProps | contentful-management.js - v11.40.3 WorkflowQueryOptions | contentful-management.js - v11.40.2 WorkflowStepAction | contentful-management.js - v11.40.2 WorkflowStepAction | contentful-management.js - v11.40.3 WorkflowStepAppAction | contentful-management.js - v11.40.2 WorkflowStepAppAction | contentful-management.js - v11.40.3 WorkflowStepEmailAction | contentful-management.js - v11.40.2 WorkflowStepEmailAction | contentful-management.js - v11.40.3 WorkflowStepEmailActionRecipient | contentful-management.js - v11.40.2 WorkflowStepEmailActionRecipient | contentful-management.js - v11.40.3 WorkflowStepPermissionActors | contentful-management.js - v11.40.2 WorkflowStepPermissionActors | contentful-management.js - v11.40.3 WorkflowStepProps | contentful-management.js - v11.40.2 WorkflowStepProps | contentful-management.js - v11.40.3 WorkflowStepTaskAction | contentful-management.js - v11.40.2 WorkflowStepTaskAction | contentful-management.js - v11.40.3 WorkflowsChangelogEntryProps | contentful-management.js - v11.40.2 WorkflowsChangelogEntryProps | contentful-management.js - v11.40.3 WorkflowsChangelogQueryOptions | contentful-management.js - v11.40.2 ReleaseReferenceFilters | contentful-management.js - v11.40.2 ReleaseReferenceFilters | contentful-management.js - v11.40.3
Interface WebHooks
interface WebHooks {
active: boolean;
filters?: WebhookFilter[];
headers: WebhookHeader[];
httpBasicPassword?: string;
httpBasicUsername?: string;
name: string;
sys: BasicMetaSysProps & {
space: SysLink;
};
topics: string[];
transformation?: WebhookTransformation;
url: string;
delete(): Promise<void>;
getCall(id: string): Promise<WebhookCallDetailsProps>;
getCalls(): Promise<CollectionProp<{
errors: any[];
eventType: string;
requestAt: string;
responseAt: string;
statusCode: number;
sys: {
createdAt: string;
createdBy?: SysLink;
id: string;
type: string;
};
url: string;
}>>;
getHealth(): Promise<WebhookHealthProps>;
toPlainObject(): WebhookProps;
update(): Promise<WebHooks>;
}
active: boolean;
filters?: WebhookFilter[];
headers: WebhookHeader[];
httpBasicPassword?: string;
httpBasicUsername?: string;
name: string;
sys: BasicMetaSysProps & {
space: SysLink;
};
topics: string[];
transformation?: WebhookTransformation;
url: string;
delete(): Promise<void>;
getCall(id: string): Promise<WebhookCallDetailsProps>;
getCalls(): Promise<CollectionProp<{
errors: any[];
eventType: string;
requestAt: string;
responseAt: string;
statusCode: number;
sys: {
createdAt: string;
createdBy?: SysLink;
id: string;
type: string;
};
url: string;
}>>;
getHealth(): Promise<WebhookHealthProps>;
toPlainObject(): WebhookProps;
update(): Promise<WebHooks>;
}
Hierarchy (view full)
- WebhookProps
- DefaultElements<WebhookProps>
- WebHooks
Index
Properties
Properties
active
active: boolean
Whether the Webhook is active. If set to false, no calls will be made
-Optionalfilters
Webhook filters
-headers
headers: WebhookHeader[]
Headers that should be appended to the webhook request
-Optionalhttp
http
Password for basic http auth
-Optionalhttp
http
Username for basic http auth
-name
name: string
Webhook name
-sys
System metadata
-topics
topics: string[]
Topics the webhook wants to subscribe to
-Optionaltransformation
Transformation to apply
-url
url: string
Webhook url
- Methods
delete
Optionalfilters
Webhook filters
+headers
headers: WebhookHeader[]
Headers that should be appended to the webhook request
+Optionalhttp
http
Password for basic http auth
+Optionalhttp
http
Username for basic http auth
+name
name: string
Webhook name
+sys
System metadata
+topics
topics: string[]
Topics the webhook wants to subscribe to
+Optionaltransformation
Transformation to apply
+url
url: string
Webhook url
+ Methods
delete
- delete(): Promise<void>
Deletes this object on the server.
Returns Promise<void>
Promise for the deletion. It contains no data, but the Promise error case should be handled.
-const contentful = require('contentful-management')
const client = contentful.createClient({
accessToken: '<content_management_api_key>'
})
client.getSpace('<space_id>')
.then((space) => space.getWebhook('<webhook_id>'))
.then((webhook) => webhook.delete())
.then((webhook) => console.log(`webhook ${webhook.sys.id} updated.`))
.catch(console.error)
get
- get
Call(id): Promise<WebhookCallDetailsProps> - diff --git a/contentful-management/latest/interfaces/Workflow.html b/contentful-management/latest/interfaces/Workflow.html index f43a8a9d1e..e55eaee1cb 100644 --- a/contentful-management/latest/interfaces/Workflow.html +++ b/contentful-management/latest/interfaces/Workflow.html @@ -1,8 +1,8 @@ -
Webhook call with specific id. See https://www.contentful.com/developers/docs/references/content-management-api/#/reference/webhook-calls/webhook-call-overviews for more details
+get
Call - get
Call(id): Promise<WebhookCallDetailsProps> Webhook call with specific id. See https://www.contentful.com/developers/docs/references/content-management-api/#/reference/webhook-calls/webhook-call-overviews for more details
Parameters
- id: string
Returns Promise<WebhookCallDetailsProps>
Promise for call details
-const contentful = require('contentful-management')
const client = contentful.createClient({
accessToken: '<content_management_api_key>'
})
client.getSpace('<space_id>')
.then((space) => space.getWebhook('<webhook_id>'))
.then((webhook) => webhook.getCall('<call-id>'))
.then((webhookCall) => console.log(webhookCall))
.catch(console.error)
get
Calls - get
Calls(): Promise<CollectionProp<{
errors: any[];
eventType: string;
requestAt: string;
responseAt: string;
statusCode: number;
sys: {
createdAt: string;
createdBy?: SysLink;
id: string;
type: string;
};
url: string;
}>> List of the most recent webhook calls. See https://www.contentful.com/developers/docs/references/content-management-api/#/reference/webhook-calls/webhook-call-overviews for more details.
+get
Calls - get
Calls(): Promise<CollectionProp<{
errors: any[];
eventType: string;
requestAt: string;
responseAt: string;
statusCode: number;
sys: {
createdAt: string;
createdBy?: SysLink;
id: string;
type: string;
};
url: string;
}>> List of the most recent webhook calls. See https://www.contentful.com/developers/docs/references/content-management-api/#/reference/webhook-calls/webhook-call-overviews for more details.
Returns Promise<CollectionProp<{
errors: any[];
eventType: string;
requestAt: string;
responseAt: string;
statusCode: number;
sys: {
createdAt: string;
createdBy?: SysLink;
id: string;
type: string;
};
url: string;
}>>Promise for list of calls
-const contentful = require('contentful-management')
const client = contentful.createClient({
accessToken: '<content_management_api_key>'
})
client.getSpace('<space_id>')
.then((space) => space.getWebhook('<webhook_id>'))
.then((webhook) => webhook.getCalls())
.then((response) => console.log(response.items)) // webhook calls
.catch(console.error)
get
Health - get
Health(): Promise<WebhookHealthProps> - +
Overview of the health of webhook calls. See https://www.contentful.com/developers/docs/references/content-management-api/#/reference/webhook-calls/webhook-call-overviews for more details.
+get
Health - get
Health(): Promise<WebhookHealthProps> Overview of the health of webhook calls. See https://www.contentful.com/developers/docs/references/content-management-api/#/reference/webhook-calls/webhook-call-overviews for more details.
Returns Promise<WebhookHealthProps>
Promise for health info
-const contentful = require('contentful-management')
const client = contentful.createClient({
accessToken: '<content_management_api_key>'
})
client.getSpace('<space_id>')
.then((space) => space.getWebhook('<webhook_id>'))
.then((webhook) => webhook.getHealth())
.then((webhookHealth) => console.log(webhookHealth))
.catch(console.error)
to
Plain Object - to
Plain Object(): WebhookProps Returns WebhookProps
update
- update(): Promise<WebHooks>
Sends an update to the server with any changes made to the object's properties
+to
Plain Object - to
Plain Object(): WebhookProps Returns WebhookProps
update
- update(): Promise<WebHooks>
Sends an update to the server with any changes made to the object's properties
Returns Promise<WebHooks>
Object returned from the server with updated changes.
-const contentful = require('contentful-management')
const client = contentful.createClient({
accessToken: '<content_management_api_key>'
})
client.getSpace('<space_id>')
.then((space) => space.getWebhook('<webhook_id>'))
.then((webhook) => {
webhook.name = 'new webhook name'
return webhook.update()
})
.then((webhook) => console.log(`webhook ${webhook.sys.id} updated.`))
.catch(console.error)
- to
- get
- get
Workflow | contentful-management.js - v11.40.2 diff --git a/contentful-management/latest/interfaces/WorkflowDefinition.html b/contentful-management/latest/interfaces/WorkflowDefinition.html index ec0f25288a..67b9fd3abc 100644 --- a/contentful-management/latest/interfaces/WorkflowDefinition.html +++ b/contentful-management/latest/interfaces/WorkflowDefinition.html @@ -1,4 +1,4 @@ -Interface Workflow
interface Workflow {
stepId?: string;
sys: WorkflowSysProps;
complete(): Promise<void>;
delete(): Promise<void>;
get(): Promise<Workflow>;
toPlainObject(): WorkflowProps;
update(): Promise<Workflow>;
}Hierarchy (view full)
- WorkflowProps
- DefaultElements<WorkflowProps>
- WorkflowApi
- Workflow
Index
Properties
stepId? + Workflow | contentful-management.js - v11.40.3 +Interface Workflow
interface Workflow {
stepId?: string;
sys: WorkflowSysProps;
complete(): Promise<void>;
delete(): Promise<void>;
get(): Promise<Workflow>;
toPlainObject(): WorkflowProps;
update(): Promise<Workflow>;
}Hierarchy (view full)
- WorkflowProps
- DefaultElements<WorkflowProps>
- WorkflowApi
- Workflow
Methods
complete
delete
get
to
Plain Object - to
Plain Object(): WorkflowProps Returns WorkflowProps
update
Methods
complete
delete
get
to
Plain Object - to
Plain Object(): WorkflowProps Returns WorkflowProps
update
WorkflowDefinition | contentful-management.js - v11.40.2 diff --git a/contentful-management/latest/interfaces/WorkflowStepPermission.html b/contentful-management/latest/interfaces/WorkflowStepPermission.html index 2f911dfc21..57e3d5cca7 100644 --- a/contentful-management/latest/interfaces/WorkflowStepPermission.html +++ b/contentful-management/latest/interfaces/WorkflowStepPermission.html @@ -1,3 +1,3 @@ -Interface WorkflowDefinition
interface WorkflowDefinition {
appliesTo?: WorkflowDefinitionValidationLink[];
description?: string;
flowType?: "no_restriction" | "strict_neighbor";
name: string;
startOnEntityCreation?: boolean;
steps: WorkflowStepProps[];
sys: WorkflowDefinitionSysProps;
delete(): Promise<void>;
toPlainObject(): WorkflowDefinitionProps;
update(): Promise<WorkflowDefinition>;
}Hierarchy (view full)
- WorkflowDefinitionProps
- DefaultElements<WorkflowDefinitionProps>
- WorkflowDefinitionApi
- WorkflowDefinition
Index
Properties
appliesTo? + WorkflowDefinition | contentful-management.js - v11.40.3 +Interface WorkflowDefinition
interface WorkflowDefinition {
appliesTo?: WorkflowDefinitionValidationLink[];
description?: string;
flowType?: "no_restriction" | "strict_neighbor";
name: string;
startOnEntityCreation?: boolean;
steps: WorkflowStepProps[];
sys: WorkflowDefinitionSysProps;
delete(): Promise<void>;
toPlainObject(): WorkflowDefinitionProps;
update(): Promise<WorkflowDefinition>;
}Hierarchy (view full)
- WorkflowDefinitionProps
- DefaultElements<WorkflowDefinitionProps>
- WorkflowDefinitionApi
- WorkflowDefinition
Index
Properties
Methods
Properties
OptionalappliesTo Optionaldescriptiondescription?: stringOptionalflowType flowType?: "no_restriction" | "strict_neighbor" name
name: stringOptionalstartOn Entity Creation startOn Entity Creation?: boolean steps
sys
Methods
delete
to
Plain Object - to
Plain Object(): WorkflowDefinitionProps Returns WorkflowDefinitionProps
update
- update(): Promise<WorkflowDefinition>
Returns Promise<WorkflowDefinition>
Properties
OptionalappliesTo Optionaldescriptiondescription?: stringOptionalflowType flowType?: "no_restriction" | "strict_neighbor" name
name: stringOptionalstartOn Entity Creation startOn Entity Creation?: boolean steps
sys
Methods
delete
to
Plain Object - to
Plain Object(): WorkflowDefinitionProps Returns WorkflowDefinitionProps
update
- update(): Promise<WorkflowDefinition>
Returns Promise<WorkflowDefinition>
WorkflowStepPermission | contentful-management.js - v11.40.2 diff --git a/contentful-management/latest/interfaces/WorkflowsChangelogEntry.html b/contentful-management/latest/interfaces/WorkflowsChangelogEntry.html index 052999ed30..edc13bd93f 100644 --- a/contentful-management/latest/interfaces/WorkflowsChangelogEntry.html +++ b/contentful-management/latest/interfaces/WorkflowsChangelogEntry.html @@ -1,4 +1,4 @@ -Interface WorkflowStepPermission
interface WorkflowStepPermission {
configuration: {
action: WorkflowStepPermissionAction;
actors: WorkflowStepPermissionActors;
effect: WorkflowStepPermissionEffect;
};
type: WorkflowStepPermissionType;
}Index
Properties
configuration +WorkflowStepPermission | contentful-management.js - v11.40.3 +Interface WorkflowStepPermission
interface WorkflowStepPermission {
configuration: {
action: WorkflowStepPermissionAction;
actors: WorkflowStepPermissionActors;
effect: WorkflowStepPermissionEffect;
};
type: WorkflowStepPermissionType;
}Index
Properties
Properties
configuration
configuration: {
action: WorkflowStepPermissionAction;
actors: WorkflowStepPermissionActors;
effect: WorkflowStepPermissionEffect;
}type
Properties
configuration
configuration: {
action: WorkflowStepPermissionAction;
actors: WorkflowStepPermissionActors;
effect: WorkflowStepPermissionEffect;
}type
WorkflowsChangelogEntry | contentful-management.js - v11.40.2 diff --git a/contentful-management/latest/media/CHANGELOG.md b/contentful-management/latest/media/CHANGELOG.md index ece9759e25..4c4a41f521 100644 --- a/contentful-management/latest/media/CHANGELOG.md +++ b/contentful-management/latest/media/CHANGELOG.md @@ -1,4 +1,9 @@ -## [11.40.2](https://github.com/contentful/contentful-management.js/compare/v11.40.1...v11.40.2) (2024-12-05) +## [11.40.3](https://github.com/contentful/contentful-management.js/compare/v11.40.2...v11.40.3) (2024-12-30) + + +### Bug Fixes + +* upgrade axios to 1.7.9 [ZEND-5779] ([#2501](https://github.com/contentful/contentful-management.js/issues/2501)) ([d4c6232](https://github.com/contentful/contentful-management.js/commit/d4c6232d4ad8098dd7d56ab1fda1c02d789bb498)) diff --git a/contentful-management/latest/modules.html b/contentful-management/latest/modules.html index fa5c123610..b6187865cf 100644 --- a/contentful-management/latest/modules.html +++ b/contentful-management/latest/modules.html @@ -1,4 +1,4 @@ -Interface WorkflowsChangelogEntry
interface WorkflowsChangelogEntry {
entity: Link<"Entry">;
event: string;
eventAt: string;
eventBy: SysLink;
stepAnnotations: string[];
stepId: string;
stepName: string;
workflow: VersionedLink<"Workflow">;
workflowDefinition: Link<"WorkflowDefinition">;
toPlainObject(): WorkflowsChangelogEntryProps;
}Hierarchy (view full)
- WorkflowsChangelogEntryProps
- DefaultElements<WorkflowsChangelogEntryProps>
- WorkflowsChangelogEntry
Index
Properties
entity +WorkflowsChangelogEntry | contentful-management.js - v11.40.3 +Interface WorkflowsChangelogEntry
interface WorkflowsChangelogEntry {
entity: Link<"Entry">;
event: string;
eventAt: string;
eventBy: SysLink;
stepAnnotations: string[];
stepId: string;
stepName: string;
workflow: VersionedLink<"Workflow">;
workflowDefinition: Link<"WorkflowDefinition">;
toPlainObject(): WorkflowsChangelogEntryProps;
}Hierarchy (view full)
- WorkflowsChangelogEntryProps
- DefaultElements<WorkflowsChangelogEntryProps>
- WorkflowsChangelogEntry
Index
Properties
Methods
Properties
entity
event
event: stringevent
At eventAt: string event
By step
Annotations stepAnnotations: string[] step
Id stepId: string step
Name stepName: string workflow
workflow
Definition Methods
to
Plain Object - to
Plain Object(): WorkflowsChangelogEntryProps Returns WorkflowsChangelogEntryProps
Properties
entity
event
event: stringevent
At eventAt: string event
By step
Annotations stepAnnotations: string[] step
Id stepId: string step
Name stepName: string workflow
workflow
Definition Methods
to
Plain Object - to
Plain Object(): WorkflowsChangelogEntryProps Returns WorkflowsChangelogEntryProps
contentful-management.js - v11.40.2 diff --git a/contentful-management/latest/modules/editorInterfaceDefaults.html b/contentful-management/latest/modules/editorInterfaceDefaults.html index 03892aad46..63e8ebba6e 100644 --- a/contentful-management/latest/modules/editorInterfaceDefaults.html +++ b/contentful-management/latest/modules/editorInterfaceDefaults.html @@ -1 +1 @@ -contentful-management.js - v11.40.2
Contentful Management API SDK. Allows you to create instances of a client +
contentful-management.js - v11.40.3 +contentful-management.js - v11.40.3
Contentful Management API SDK. Allows you to create instances of a client with access to the Contentful Content Management API.
Index
Namespaces
Enumerations
editorInterfaceDefaults | contentful-management.js - v11.40.2 +Namespace editorInterfaceDefaults
editorInterfaceDefaults | contentful-management.js - v11.40.3 diff --git a/contentful-management/latest/types/AccessTokenProp.html b/contentful-management/latest/types/AccessTokenProp.html index 91c18c79bc..a182bc1947 100644 --- a/contentful-management/latest/types/AccessTokenProp.html +++ b/contentful-management/latest/types/AccessTokenProp.html @@ -1 +1 @@ -Namespace editorInterfaceDefaults
AccessTokenProp | contentful-management.js - v11.40.2 +Type Alias AccessTokenProp
AccessToken Prop: {
name: string;
revokedAt: null | string;
scopes: "content_management_manage"[];
sys: AccessTokenSysProps;
token?: string;
}AccessTokenProp | contentful-management.js - v11.40.3 diff --git a/contentful-management/latest/types/AnnotationAssignment.html b/contentful-management/latest/types/AnnotationAssignment.html index ece51c23c1..64710bdf44 100644 --- a/contentful-management/latest/types/AnnotationAssignment.html +++ b/contentful-management/latest/types/AnnotationAssignment.html @@ -1 +1 @@ -Type Alias AccessTokenProp
AccessToken Prop: {
name: string;
revokedAt: null | string;
scopes: "content_management_manage"[];
sys: AccessTokenSysProps;
token?: string;
}AnnotationAssignment | contentful-management.js - v11.40.2 +Type Alias AnnotationAssignment
AnnotationAssignment: Link<"Annotation"> & {
parameters?: Record<string, string | number | boolean>;
}AnnotationAssignment | contentful-management.js - v11.40.3 diff --git a/contentful-management/latest/types/ApiKeyProps.html b/contentful-management/latest/types/ApiKeyProps.html index 4fe66195bf..ccf31aa369 100644 --- a/contentful-management/latest/types/ApiKeyProps.html +++ b/contentful-management/latest/types/ApiKeyProps.html @@ -1 +1 @@ -Type Alias AnnotationAssignment
AnnotationAssignment: Link<"Annotation"> & {
parameters?: Record<string, string | number | boolean>;
}ApiKeyProps | contentful-management.js - v11.40.2 +Type Alias ApiKeyProps
ApiKey Props: {
accessToken: string;
description?: string;
environments: {
sys: MetaLinkProps;
}[];
name: string;
policies?: {
action: string;
effect: string;
}[];
preview_api_key: {
sys: MetaLinkProps;
};
sys: MetaSysProps;
}ApiKeyProps | contentful-management.js - v11.40.3 diff --git a/contentful-management/latest/types/AppAccessTokenProps.html b/contentful-management/latest/types/AppAccessTokenProps.html index bea2ae609c..806de09455 100644 --- a/contentful-management/latest/types/AppAccessTokenProps.html +++ b/contentful-management/latest/types/AppAccessTokenProps.html @@ -1,3 +1,3 @@ -Type Alias ApiKeyProps
ApiKey Props: {
accessToken: string;
description?: string;
environments: {
sys: MetaLinkProps;
}[];
name: string;
policies?: {
action: string;
effect: string;
}[];
preview_api_key: {
sys: MetaLinkProps;
};
sys: MetaSysProps;
}AppAccessTokenProps | contentful-management.js - v11.40.2 diff --git a/contentful-management/latest/types/AppAction.html b/contentful-management/latest/types/AppAction.html index a824211093..42d96647e8 100644 --- a/contentful-management/latest/types/AppAction.html +++ b/contentful-management/latest/types/AppAction.html @@ -1,4 +1,4 @@ -Type Alias AppAccessTokenProps
AppAccess Token Props: {
sys: AppAccessTokenSys;
token: string;
}Type declaration
sys: AppAccessTokenSys
System metadata
+AppAccessTokenProps | contentful-management.js - v11.40.3 +Type Alias AppAccessTokenProps
AppAccess Token Props: {
sys: AppAccessTokenSys;
token: string;
}Type declaration
sys: AppAccessTokenSys
System metadata
token: string
Token for an app installation in a space environment
-
AppAction | contentful-management.js - v11.40.2 Type Alias AppAction
Type declaration
- get
Type Alias AppActionCallProps
App
sys: AppActionCallSys;
}
sys: AppActionCallSys;
}
Type declaration
sys: AppActionCallSys
System metadata
-
Type Alias AppActionCallProps
App
sys: AppActionCallSys;
}
sys: AppActionCallSys;
}
Type declaration
sys: AppActionCallSys
System metadata
+
Type Alias AppActionCategoryProps
App
description: string;
name: string;
parameters?: AppActionParameterDefinition[];
sys: {
id: AppActionCategoryType;
type: "AppActionCategory";
version: string;
};
}
description: string;
name: string;
parameters?: AppActionParameterDefinition[];
sys: {
id: AppActionCategoryType;
type: "AppActionCategory";
version: string;
};
}
Type Alias AppActionCategoryProps
App
description: string;
name: string;
parameters?: AppActionParameterDefinition[];
sys: {
id: AppActionCategoryType;
type: "AppActionCategory";
version: string;
};
}
description: string;
name: string;
parameters?: AppActionParameterDefinition[];
sys: {
id: AppActionCategoryType;
type: "AppActionCategory";
version: string;
};
}
Type Alias AppActionCategoryType
App
Type Alias AppActionCategoryType
App
Type Alias AppActionParameterDefinition
Type Alias AppActionParameterDefinition
Type Alias AppActionProps
App
description?: string;
name: string;
sys: AppActionSys;
type?: AppActionType;
url: string;
}
description?: string;
name: string;
sys: AppActionSys;
type?: AppActionType;
url: string;
}
Type declaration
Optionaldescription?: stringHuman readable description of the action
+AppActionProps | contentful-management.js - v11.40.3 +Type Alias AppActionProps
AppAction Props: AppActionCategory & {
description?: string;
name: string;
sys: AppActionSys;
type?: AppActionType;
url: string;
}Type declaration
Optionaldescription?: stringHuman readable description of the action
name: string
Human readable name for the action
sys: AppActionSys
System metadata
Optionaltype?: AppActionTypeType of the action, defaults to endpoint if not provided @@ -6,4 +6,4 @@ function: deprecated, use function-invocation instead function-invocation: action invokes a contentful function
url: string
Url that will be called when the action is invoked
-
Type Alias AppActionType
App
Type Alias AppActionType
App
Type Alias AppBundleFile
App
md5: string;
name: string;
size: number;
}
md5: string;
name: string;
size: number;
}
Type Alias AppBundleFile
App
md5: string;
name: string;
size: number;
}
md5: string;
name: string;
size: number;
}
Type Alias AppBundleProps
Type declaration
Optionalcomment?: stringA comment that describes this bundle
+AppBundleProps | contentful-management.js - v11.40.3 +Type Alias AppBundleProps
Type declaration
Optionalcomment?: stringA comment that describes this bundle
files: AppBundleFile[]
List of all the files that are in this bundle
sys: AppBundleSys
System metadata
-
Type Alias AppDefinition
App
Type Alias AppDefinition
App
Type Alias AppDefinitionProps
App
bundle?: Link<"AppBundle">;
locations?: AppLocation[];
name: string;
parameters?: {
installation?: ParameterDefinition<InstallationParameterType>[];
instance?: ParameterDefinition[];
};
src?: string;
sys: BasicMetaSysProps & {
organization: SysLink;
shared: boolean;
};
}
bundle?: Link<"AppBundle">;
locations?: AppLocation[];
name: string;
parameters?: {
installation?: ParameterDefinition<InstallationParameterType>[];
instance?: ParameterDefinition[];
};
src?: string;
sys: BasicMetaSysProps & {
organization: SysLink;
shared: boolean;
};
}
Type declaration
Optionalbundle?: Link<"AppBundle">Link to an AppBundle
+AppDefinitionProps | contentful-management.js - v11.40.3 +Type Alias AppDefinitionProps
AppDefinition Props: {
bundle?: Link<"AppBundle">;
locations?: AppLocation[];
name: string;
parameters?: {
installation?: ParameterDefinition<InstallationParameterType>[];
instance?: ParameterDefinition[];
};
src?: string;
sys: BasicMetaSysProps & {
organization: SysLink;
shared: boolean;
};
}Type declaration
Optionalbundle?: Link<"AppBundle">Link to an AppBundle
Optionallocations?: AppLocation[]Locations where the app can be installed
name: string
App name
Optionalparameters?: {
installation?: ParameterDefinition<InstallationParameterType>[];
instance?: ParameterDefinition[];
}Instance parameter definitions
Optionalinstallation?: ParameterDefinition<InstallationParameterType>[]Optionalinstance?: ParameterDefinition[]
Optionalsrc?: stringURL where the root HTML document of the app can be found
sys: BasicMetaSysProps & {
organization: SysLink;
shared: boolean;
}System metadata
-
Type Alias AppDetailsProps
Type declaration
Optionalicon?: AppIcon
Type Alias AppEventSubscriptionProps
App
sys: AppEventSubscriptionSys;
targetUrl: string;
topics: string[];
}
sys: AppEventSubscriptionSys;
targetUrl: string;
topics: string[];
}
Type declaration
sys: AppEventSubscriptionSys
System metadata
+AppEventSubscriptionProps | contentful-management.js - v11.40.3 +Type Alias AppEventSubscriptionProps
AppEvent Subscription Props: {
sys: AppEventSubscriptionSys;
targetUrl: string;
topics: string[];
}Type declaration
sys: AppEventSubscriptionSys
System metadata
target
Url: string Subscription url that will receive events
topics: string[]
List of topics to subscribe to
-
Type Alias AppInstallationProps
App
parameters?: FreeFormParameters;
sys: Omit<BasicMetaSysProps, "id"> & {
appDefinition: SysLink;
environment: SysLink;
space: SysLink;
};
}
parameters?: FreeFormParameters;
sys: Omit<BasicMetaSysProps, "id"> & {
appDefinition: SysLink;
environment: SysLink;
space: SysLink;
};
}
Type declaration
Optionalparameters?: FreeFormParametersFree-form installation parameters (API limits stringified length to 32KB)
-sys: Omit<BasicMetaSysProps, "id"> & {
appDefinition: SysLink;
environment: SysLink;
space: SysLink;
}
Type Alias AppInstallationProps
App
parameters?: FreeFormParameters;
sys: Omit<BasicMetaSysProps, "id"> & {
appDefinition: SysLink;
environment: SysLink;
space: SysLink;
};
}
parameters?: FreeFormParameters;
sys: Omit<BasicMetaSysProps, "id"> & {
appDefinition: SysLink;
environment: SysLink;
space: SysLink;
};
}
Type declaration
Optionalparameters?: FreeFormParametersFree-form installation parameters (API limits stringified length to 32KB)
+sys: Omit<BasicMetaSysProps, "id"> & {
appDefinition: SysLink;
environment: SysLink;
space: SysLink;
}
Type Alias AppKeyProps
App
generated?: {
privateKey: string;
};
jwk: JWK;
sys: AppKeySys;
}
generated?: {
privateKey: string;
};
jwk: JWK;
sys: AppKeySys;
}
Type declaration
Optionalgenerated?: {
privateKey: string;
}If generated, private key is returned
+AppKeyProps | contentful-management.js - v11.40.3 +Type Alias AppKeyProps
AppKey Props: {
generated?: {
privateKey: string;
};
jwk: JWK;
sys: AppKeySys;
}Type declaration
Optionalgenerated?: {
privateKey: string;
}If generated, private key is returned
private
Key: string Base64 PEM
jwk: JWK
JSON Web Key
sys: AppKeySys
System metadata
-
Type Alias AppLocation
Type Alias AppLocation
Type Alias AppSignedRequestProps
App
additionalHeaders: {
x-contentful-environment-id: string;
x-contentful-signature: string;
x-contentful-signed-headers: string;
x-contentful-space-id: string;
x-contentful-timestamp: string;
x-contentful-user-id: string;
};
sys: AppSignedRequestSys;
}
additionalHeaders: {
x-contentful-environment-id: string;
x-contentful-signature: string;
x-contentful-signed-headers: string;
x-contentful-space-id: string;
x-contentful-timestamp: string;
x-contentful-user-id: string;
};
sys: AppSignedRequestSys;
}
Type declaration
additional
Headers: {
x-contentful-environment-id: string;
x-contentful-signature: string;
x-contentful-signed-headers: string;
x-contentful-space-id: string;
x-contentful-timestamp: string;
x-contentful-user-id: string;
}new headers to be included in the request
+AppSignedRequestProps | contentful-management.js - v11.40.3 +Type Alias AppSignedRequestProps
AppSigned Request Props: {
additionalHeaders: {
x-contentful-environment-id: string;
x-contentful-signature: string;
x-contentful-signed-headers: string;
x-contentful-space-id: string;
x-contentful-timestamp: string;
x-contentful-user-id: string;
};
sys: AppSignedRequestSys;
}Type declaration
additional
Headers: {
x-contentful-environment-id: string;
x-contentful-signature: string;
x-contentful-signed-headers: string;
x-contentful-space-id: string;
x-contentful-timestamp: string;
x-contentful-user-id: string;
}new headers to be included in the request
x-
contentful- environment- id: string x-
contentful- signature: string x-
contentful- signed- headers: string x-
contentful- space- id: string x-
contentful- timestamp: string x-
contentful- user- id: string
sys: AppSignedRequestSys
System metadata
-
Type Alias AppSigningSecretProps
App
redactedValue: string;
sys: AppSigningSecretSys;
}
redactedValue: string;
sys: AppSigningSecretSys;
}
Type declaration
redacted
Value: string The last four characters of the signing secret
+AppSigningSecretProps | contentful-management.js - v11.40.3 +Type Alias AppSigningSecretProps
AppSigning Secret Props: {
redactedValue: string;
sys: AppSigningSecretSys;
}Type declaration
redacted
Value: string The last four characters of the signing secret
sys: AppSigningSecretSys
System metadata
-
Type Alias AppUploadProps
Type Alias AppUploadProps
Type Alias AssetKeyProps
Asset
policy: string;
secret: string;
}
policy: string;
secret: string;
}
Type declaration
policy: string
A JWT describing a policy; needs to be attached to signed URLs
+AssetKeyProps | contentful-management.js - v11.40.3 +Type Alias AssetKeyProps
AssetKey Props: {
policy: string;
secret: string;
}Type declaration
policy: string
A JWT describing a policy; needs to be attached to signed URLs
secret: string
A secret key to be used for signing URLs
-
Type Alias AssetProps
Asset
fields: {
description?: {
[key: string]: string;
};
file: {
[key: string]: {
contentType: string;
details?: Record<string, any>;
fileName: string;
upload?: string;
uploadFrom?: Record<string, any>;
url?: string;
};
};
title: {
[key: string]: string;
};
};
metadata?: MetadataProps;
sys: EntityMetaSysProps;
}
fields: {
description?: {
[key: string]: string;
};
file: {
[key: string]: {
contentType: string;
details?: Record<string, any>;
fileName: string;
upload?: string;
uploadFrom?: Record<string, any>;
url?: string;
};
};
title: {
[key: string]: string;
};
};
metadata?: MetadataProps;
sys: EntityMetaSysProps;
}
Type declaration
fields: {
description?: {
[key: string]: string;
};
file: {
[key: string]: {
contentType: string;
details?: Record<string, any>;
fileName: string;
upload?: string;
uploadFrom?: Record<string, any>;
url?: string;
};
};
title: {
[key: string]: string;
};
}Optionaldescription?: {
[key: string]: string;
}Description for this asset
+AssetProps | contentful-management.js - v11.40.3 +Type Alias AssetProps
AssetProps: {
fields: {
description?: {
[key: string]: string;
};
file: {
[key: string]: {
contentType: string;
details?: Record<string, any>;
fileName: string;
upload?: string;
uploadFrom?: Record<string, any>;
url?: string;
};
};
title: {
[key: string]: string;
};
};
metadata?: MetadataProps;
sys: EntityMetaSysProps;
}Type declaration
fields: {
description?: {
[key: string]: string;
};
file: {
[key: string]: {
contentType: string;
details?: Record<string, any>;
fileName: string;
upload?: string;
uploadFrom?: Record<string, any>;
url?: string;
};
};
title: {
[key: string]: string;
};
}Optionaldescription?: {
[key: string]: string;
}Description for this asset
[key: string]: string
file: {
[key: string]: {
contentType: string;
details?: Record<string, any>;
fileName: string;
upload?: string;
uploadFrom?: Record<string, any>;
url?: string;
};
}File object for this asset
[key: string]: {
contentType: string;
details?: Record<string, any>;
fileName: string;
upload?: string;
uploadFrom?: Record<string, any>;
url?: string;
}content
Type: string Optionaldetails?: Record<string, any>Details for the file, depending on file type (example: image size in bytes, etc)
file
Name: string Optionalupload?: stringUrl where the file is available to be downloaded from, into the Contentful asset system. After the asset is processed this field is gone.
OptionaluploadFrom?: Record<string, any> Optionalurl?: stringUrl where the file is available at the Contentful media asset system. This field won't be available until the asset is processed.
title: {
[key: string]: string;
}Title for this asset
-[key: string]: string
Optionalmetadata?: MetadataPropssys: EntityMetaSysProps
[key: string]: string
Optionalmetadata?: MetadataPropssys: EntityMetaSysProps
Type Alias BulkActionPayload
Bulk
Type Alias BulkActionPayload
Bulk
Type Alias BulkActionType
Bulk
Type Alias BulkActionType
Bulk
Type Alias ClientAPI
ClientAPI: ReturnType<typeof createClientApi>
Type Alias ClientAPI
ClientAPI: ReturnType<typeof createClientApi>
Type Alias CommentProps
Comment
body: string;
status: CommentStatus;
sys: CommentSysProps;
}
body: string;
status: CommentStatus;
sys: CommentSysProps;
}
Type Alias CommentProps
Comment
body: string;
status: CommentStatus;
sys: CommentSysProps;
}
body: string;
status: CommentStatus;
sys: CommentSysProps;
}
+
diff --git a/contentful-management/latest/types/ConceptSchemeProps.html b/contentful-management/latest/types/ConceptSchemeProps.html
index 05e7c7eedb..72b49d8459 100644
--- a/contentful-management/latest/types/ConceptSchemeProps.html
+++ b/contentful-management/latest/types/ConceptSchemeProps.html
@@ -1 +1 @@
-
+
diff --git a/contentful-management/latest/types/ContentTypeMetadata.html b/contentful-management/latest/types/ContentTypeMetadata.html
index 43fb41f264..b271016856 100644
--- a/contentful-management/latest/types/ContentTypeMetadata.html
+++ b/contentful-management/latest/types/ContentTypeMetadata.html
@@ -1 +1 @@
-
Type Alias ContentTypeMetadata
Content
annotations?: RequireAtLeastOne<{
ContentType?: AnnotationAssignment[];
ContentTypeField?: Record<string, AnnotationAssignment[]>;
}, "ContentType" | "ContentTypeField">;
taxonomy?: (Link<"TaxonomyConcept"> | Link<"TaxonomyConceptScheme">)[];
}
annotations?: RequireAtLeastOne<{
ContentType?: AnnotationAssignment[];
ContentTypeField?: Record<string, AnnotationAssignment[]>;
}, "ContentType" | "ContentTypeField">;
taxonomy?: (Link<"TaxonomyConcept"> | Link<"TaxonomyConceptScheme">)[];
}
Type Alias ContentTypeMetadata
Content
annotations?: RequireAtLeastOne<{
ContentType?: AnnotationAssignment[];
ContentTypeField?: Record<string, AnnotationAssignment[]>;
}, "ContentType" | "ContentTypeField">;
taxonomy?: (Link<"TaxonomyConcept"> | Link<"TaxonomyConceptScheme">)[];
}
annotations?: RequireAtLeastOne<{
ContentType?: AnnotationAssignment[];
ContentTypeField?: Record<string, AnnotationAssignment[]>;
}, "ContentType" | "ContentTypeField">;
taxonomy?: (Link<"TaxonomyConcept"> | Link<"TaxonomyConceptScheme">)[];
}
Type Alias ContentTypeProps
Content
description: string;
displayField: string;
fields: ContentFields[];
metadata?: ContentTypeMetadata;
name: string;
sys: BasicMetaSysProps & {
environment: SysLink;
firstPublishedAt?: string;
publishedCounter?: number;
publishedVersion?: number;
space: SysLink;
};
}
description: string;
displayField: string;
fields: ContentFields[];
metadata?: ContentTypeMetadata;
name: string;
sys: BasicMetaSysProps & {
environment: SysLink;
firstPublishedAt?: string;
publishedCounter?: number;
publishedVersion?: number;
space: SysLink;
};
}
Type declaration
description: string
display
Field: string Field used as the main display field for Entries
+ContentTypeProps | contentful-management.js - v11.40.3 +Type Alias ContentTypeProps
ContentType Props: {
description: string;
displayField: string;
fields: ContentFields[];
metadata?: ContentTypeMetadata;
name: string;
sys: BasicMetaSysProps & {
environment: SysLink;
firstPublishedAt?: string;
publishedCounter?: number;
publishedVersion?: number;
space: SysLink;
};
}Type declaration
description: string
display
Field: string Field used as the main display field for Entries
fields: ContentFields[]
All the fields contained in this Content Type
-Optionalmetadata?: ContentTypeMetadataname: string
sys: BasicMetaSysProps & {
environment: SysLink;
firstPublishedAt?: string;
publishedCounter?: number;
publishedVersion?: number;
space: SysLink;
}
Optionalmetadata?: ContentTypeMetadataname: string
sys: BasicMetaSysProps & {
environment: SysLink;
firstPublishedAt?: string;
publishedCounter?: number;
publishedVersion?: number;
space: SysLink;
}
Type Alias CreateApiKeyProps
Type Alias CreateApiKeyProps
Type Alias CreateAppAccessTokenProps
Create
jwt: string;
}
jwt: string;
}
Type declaration
jwt: string
JSON Web Token
-
Type Alias CreateAppAccessTokenProps
Create
jwt: string;
}
jwt: string;
}
Type declaration
jwt: string
JSON Web Token
+
Type Alias CreateAppActionCallProps
Create
parameters: {
[key: string]: any;
};
}
parameters: {
[key: string]: any;
};
}
Type declaration
parameters: {
[key: string]: any;
}The body for the call
-[key: string]: any
Type Alias CreateAppActionCallProps
Create
parameters: {
[key: string]: any;
};
}
parameters: {
[key: string]: any;
};
}
Type declaration
parameters: {
[key: string]: any;
}The body for the call
+[key: string]: any
Type Alias CreateAppActionProps
Create
description?: string;
name: string;
type?: AppActionType;
url: string;
}
description?: string;
name: string;
type?: AppActionType;
url: string;
}
Type Alias CreateAppActionProps
Create
description?: string;
name: string;
type?: AppActionType;
url: string;
}
description?: string;
name: string;
type?: AppActionType;
url: string;
}
Type Alias CreateAppBundleProps
Create
actions?: ActionManifestProps[];
appUploadId: string;
comment?: string;
functions?: FunctionManifestProps[];
}
actions?: ActionManifestProps[];
appUploadId: string;
comment?: string;
functions?: FunctionManifestProps[];
}
Type Alias CreateAppBundleProps
Create
actions?: ActionManifestProps[];
appUploadId: string;
comment?: string;
functions?: FunctionManifestProps[];
}
actions?: ActionManifestProps[];
appUploadId: string;
comment?: string;
functions?: FunctionManifestProps[];
}
Type Alias CreateAppDefinitionProps
Create
Type Alias CreateAppDefinitionProps
Create
+
diff --git a/contentful-management/latest/types/CreateAppEventSubscriptionProps.html b/contentful-management/latest/types/CreateAppEventSubscriptionProps.html
index 7bcb2fdd9d..082e527a71 100644
--- a/contentful-management/latest/types/CreateAppEventSubscriptionProps.html
+++ b/contentful-management/latest/types/CreateAppEventSubscriptionProps.html
@@ -1 +1 @@
-
Type Alias CreateAppEventSubscriptionProps
Type Alias CreateAppEventSubscriptionProps
Type Alias CreateAppInstallationProps
Type Alias CreateAppInstallationProps
Type Alias CreateAppKeyProps
Create
generate?: boolean;
jwk?: JWK;
}
generate?: boolean;
jwk?: JWK;
}
Type declaration
Optionalgenerate?: booleanToggle for automatic private key generation
+CreateAppKeyProps | contentful-management.js - v11.40.3 +Type Alias CreateAppKeyProps
CreateApp Key Props: {
generate?: boolean;
jwk?: JWK;
}Type declaration
Optionalgenerate?: booleanToggle for automatic private key generation
Optionaljwk?: JWKJSON Web Key, required if generate is falsy
-
Type Alias CreateAppSignedRequestProps
Create
body?: string;
headers?: Record<string, string>;
method:
| "GET"
| "PUT"
| "POST"
| "DELETE"
| "PATCH"
| "HEAD";
path: string;
}
body?: string;
headers?: Record<string, string>;
method:
| "GET"
| "PUT"
| "POST"
| "DELETE"
| "PATCH"
| "HEAD";
path: string;
}
Type declaration
Optionalbody?: stringoptional stringified body of the request
+CreateAppSignedRequestProps | contentful-management.js - v11.40.3 +Type Alias CreateAppSignedRequestProps
CreateApp Signed Request Props: {
body?: string;
headers?: Record<string, string>;
method:
| "GET"
| "PUT"
| "POST"
| "DELETE"
| "PATCH"
| "HEAD";
path: string;
}Type declaration
Optionalbody?: stringoptional stringified body of the request
Optionalheaders?: Record<string, string>optional headers of the request
method:
| "GET"
| "PUT"
| "POST"
| "DELETE"
| "PATCH"
| "HEAD"the request method
path: string
the path of the request method
-
Type Alias CreateAppSigningSecretProps
Create
value: string;
}
value: string;
}
Type declaration
value: string
A 64 character matching the regular expression /^[0-9a-zA-Z+/=_-]+$/
-
Type Alias CreateAppSigningSecretProps
Create
value: string;
}
value: string;
}
Type declaration
value: string
A 64 character matching the regular expression /^[0-9a-zA-Z+/=_-]+$/
+
Type Alias CreateAssetKeyProps
Create
expiresAt: number;
}
expiresAt: number;
}
Type declaration
expires
At: number (required) UNIX timestamp in the future (but not more than 48 hours from now)
-
Type Alias CreateAssetKeyProps
Create
expiresAt: number;
}
expiresAt: number;
}
Type declaration
expires
At: number (required) UNIX timestamp in the future (but not more than 48 hours from now)
+
Type Alias CreateAssetProps
Type Alias CreateAssetProps
Type Alias CreateCommentProps
Type Alias CreateCommentProps
Type Alias CreateConceptProps
Type Alias CreateConceptProps
Type Alias CreateConceptSchemeProps
Create
Type Alias CreateConceptSchemeProps
Create
Type Alias CreateContentTypeProps
Create
Type Alias CreateContentTypeProps
Create
Type Alias CreateEntryProps<TFields>
Type Parameters
- TFields = KeyValueMap
Type Alias CreateEntryProps<TFields>
Type Parameters
- TFields = KeyValueMap
Type Alias CreateEnvironmentAliasProps
Type Alias CreateEnvironmentAliasProps
Type Alias CreateEnvironmentProps
Type Alias CreateEnvironmentProps
+
diff --git a/contentful-management/latest/types/CreateEnvironmentTemplateProps.html b/contentful-management/latest/types/CreateEnvironmentTemplateProps.html
index ee00c222b5..aea673c63c 100644
--- a/contentful-management/latest/types/CreateEnvironmentTemplateProps.html
+++ b/contentful-management/latest/types/CreateEnvironmentTemplateProps.html
@@ -1 +1 @@
-
Type Alias CreateEnvironmentTemplateProps
Type Alias CreateEnvironmentTemplateProps
Type Alias CreateLocaleProps
Create
| "optional"
| "contentManagementApi"
| "default"
| "contentDeliveryApi">, "internal_code">
| "optional"
| "contentManagementApi"
| "default"
| "contentDeliveryApi">, "internal_code">
Type Alias CreateLocaleProps
Create
| "optional"
| "contentManagementApi"
| "default"
| "contentDeliveryApi">, "internal_code">
| "optional"
| "contentManagementApi"
| "default"
| "contentDeliveryApi">, "internal_code">
Type Alias CreateOrganizationInvitationProps
Type Alias CreateOrganizationInvitationProps
Type Alias CreatePATProps
Type Alias CreatePATProps
Type Alias CreatePersonalAccessTokenProps
Create
expiresIn?: number;
}
expiresIn?: number;
}
Type Alias CreatePersonalAccessTokenProps
Create
expiresIn?: number;
}
expiresIn?: number;
}
Type Alias CreateRoleProps
Type Alias CreateRoleProps
Type Alias CreateSpaceMembershipProps
Type Alias CreateSpaceMembershipProps
Type Alias CreateTagProps
Type Alias CreateTagProps
Type Alias CreateTaskProps
Type Alias CreateTaskProps
Type Alias CreateTeamMembershipProps
Type Alias CreateTeamMembershipProps
Type Alias CreateTeamProps
Type Alias CreateTeamProps
Type Alias CreateTeamSpaceMembershipProps
Type Alias CreateTeamSpaceMembershipProps
Type Alias CreateUIExtensionProps
CreateUIExtension
extension: RequireExactlyOne<SetRequired<UIExtensionProps["extension"], "name" | "fieldTypes" | "sidebar">, "src" | "srcdoc">;
}
extension: RequireExactlyOne<SetRequired<UIExtensionProps["extension"], "name" | "fieldTypes" | "sidebar">, "src" | "srcdoc">;
}
Type Alias CreateUIExtensionProps
CreateUIExtension
extension: RequireExactlyOne<SetRequired<UIExtensionProps["extension"], "name" | "fieldTypes" | "sidebar">, "src" | "srcdoc">;
}
extension: RequireExactlyOne<SetRequired<UIExtensionProps["extension"], "name" | "fieldTypes" | "sidebar">, "src" | "srcdoc">;
}
Type Alias CreateWebhooksProps
Type Alias CreateWebhooksProps
Type Alias CreateWithResponseParams
Type Alias CreateWithResponseParams
Type Alias CreateWorkflowDefinitionParams
Type Alias CreateWorkflowDefinitionParams
Type Alias CreateWorkflowDefinitionProps
Create
steps: CreateWorkflowStepProps[];
}
steps: CreateWorkflowStepProps[];
}
Type Alias CreateWorkflowDefinitionProps
Create
steps: CreateWorkflowStepProps[];
}
steps: CreateWorkflowStepProps[];
}
Type Alias CreateWorkflowProps
Create
entity: Link<"Entry">;
workflowDefinition: Link<"WorkflowDefinition">;
}
entity: Link<"Entry">;
workflowDefinition: Link<"WorkflowDefinition">;
}
Type Alias CreateWorkflowProps
Create
entity: Link<"Entry">;
workflowDefinition: Link<"WorkflowDefinition">;
}
entity: Link<"Entry">;
workflowDefinition: Link<"WorkflowDefinition">;
}
Type Alias CreateWorkflowStepProps
Type Alias CreateWorkflowStepProps
Type Alias DefinedParameters
Defined
Type Alias DefinedParameters
Defined
Type Alias DeleteCommentParams
Type Alias DeleteCommentParams
Type Alias DeleteConceptParams
Type Alias DeleteConceptParams
Type Alias DeleteConceptSchemeParams
Type Alias DeleteConceptSchemeParams
Type Alias DeleteWorkflowDefinitionParams
Type Alias DeleteWorkflowDefinitionParams
Type Alias DeleteWorkflowParams
Type Alias DeleteWorkflowParams
Type Alias EditorInterfaceProps
Editor
controls?: Control[];
editor?: Editor;
editorLayout?: FieldGroupItem[];
editors?: Editor[];
groupControls?: GroupControl[];
sidebar?: SidebarItem[];
sys: MetaSysProps & {
contentType: {
sys: MetaLinkProps;
};
environment: {
sys: MetaLinkProps;
};
space: {
sys: MetaLinkProps;
};
};
}
controls?: Control[];
editor?: Editor;
editorLayout?: FieldGroupItem[];
editors?: Editor[];
groupControls?: GroupControl[];
sidebar?: SidebarItem[];
sys: MetaSysProps & {
contentType: {
sys: MetaLinkProps;
};
environment: {
sys: MetaLinkProps;
};
space: {
sys: MetaLinkProps;
};
};
}
Type declaration
Optionalcontrols?: Control[]Array of fields and their associated widgetId
+EditorInterfaceProps | contentful-management.js - v11.40.3 +Type Alias EditorInterfaceProps
EditorInterface Props: {
controls?: Control[];
editor?: Editor;
editorLayout?: FieldGroupItem[];
editors?: Editor[];
groupControls?: GroupControl[];
sidebar?: SidebarItem[];
sys: MetaSysProps & {
contentType: {
sys: MetaLinkProps;
};
environment: {
sys: MetaLinkProps;
};
space: {
sys: MetaLinkProps;
};
};
}Type declaration
Optionalcontrols?: Control[]Array of fields and their associated widgetId
Optionaleditor?: EditorLegacy singular editor override
OptionaleditorLayout?: FieldGroupItem[] Array of editor layout field groups
Optionaleditors?: Editor[]Array of editors. Defaults will be used if property is missing.
OptionalgroupControls?: GroupControl[] Array of field groups and their associated widgetId
Optionalsidebar?: SidebarItem[]Array of sidebar widgets. Defaults will be used if property is missing.
-sys: MetaSysProps & {
contentType: {
sys: MetaLinkProps;
};
environment: {
sys: MetaLinkProps;
};
space: {
sys: MetaLinkProps;
};
}
sys: MetaSysProps & {
contentType: {
sys: MetaLinkProps;
};
environment: {
sys: MetaLinkProps;
};
space: {
sys: MetaLinkProps;
};
}
Type Alias EditorLayoutItem
Type Alias EditorLayoutItem
Type Alias EntryProps<T>
Type Parameters
- T = KeyValueMap
Type Alias EntryProps<T>
Type Parameters
- T = KeyValueMap
Type Alias Environment
Type Alias Environment
Type Alias EnvironmentAliasProps
Environment
environment: {
sys: MetaLinkProps;
};
sys: BasicMetaSysProps & {
space: SysLink;
};
}
environment: {
sys: MetaLinkProps;
};
sys: BasicMetaSysProps & {
space: SysLink;
};
}
Type declaration
environment: {
sys: MetaLinkProps;
}sys: MetaLinkProps
sys: BasicMetaSysProps & {
space: SysLink;
}System meta data
-
Type Alias EnvironmentAliasProps
Environment
environment: {
sys: MetaLinkProps;
};
sys: BasicMetaSysProps & {
space: SysLink;
};
}
environment: {
sys: MetaLinkProps;
};
sys: BasicMetaSysProps & {
space: SysLink;
};
}
Type declaration
environment: {
sys: MetaLinkProps;
}sys: MetaLinkProps
sys: BasicMetaSysProps & {
space: SysLink;
}System meta data
+
Type Alias EnvironmentProps
Environment
name: string;
sys: EnvironmentMetaSys;
}
name: string;
sys: EnvironmentMetaSys;
}
Type declaration
name: string
Name of the environment
+EnvironmentProps | contentful-management.js - v11.40.3 +Type Alias EnvironmentProps
EnvironmentProps: {
name: string;
sys: EnvironmentMetaSys;
}Type declaration
name: string
Name of the environment
sys: EnvironmentMetaSys
System metadata
-
Type Alias EnvironmentTemplate
Environment
Type Alias EnvironmentTemplate
Environment
Type Alias EnvironmentTemplateInstallation
Environment
Type Alias EnvironmentTemplateInstallation
Environment
Type Alias EnvironmentTemplateInstallationProps
Environment
sys: BasicMetaSysProps & {
completedAt?: ISO8601Timestamp;
createdAt: ISO8601Timestamp;
createdBy: Link<"User" | "AppDefinition">;
environment: Link<"Environment">;
errors?: JsonArray;
space: Link<"Space">;
status: EnvironmentTemplateInstallationStatus;
template: VersionedLink<"Template">;
type: "EnvironmentTemplateInstallation";
updatedAt: ISO8601Timestamp;
updatedBy: Link<"User" | "AppDefinition">;
version: number;
};
}
sys: BasicMetaSysProps & {
completedAt?: ISO8601Timestamp;
createdAt: ISO8601Timestamp;
createdBy: Link<"User" | "AppDefinition">;
environment: Link<"Environment">;
errors?: JsonArray;
space: Link<"Space">;
status: EnvironmentTemplateInstallationStatus;
template: VersionedLink<"Template">;
type: "EnvironmentTemplateInstallation";
updatedAt: ISO8601Timestamp;
updatedBy: Link<"User" | "AppDefinition">;
version: number;
};
}
Type Alias EnvironmentTemplateInstallationProps
Environment
sys: BasicMetaSysProps & {
completedAt?: ISO8601Timestamp;
createdAt: ISO8601Timestamp;
createdBy: Link<"User" | "AppDefinition">;
environment: Link<"Environment">;
errors?: JsonArray;
space: Link<"Space">;
status: EnvironmentTemplateInstallationStatus;
template: VersionedLink<"Template">;
type: "EnvironmentTemplateInstallation";
updatedAt: ISO8601Timestamp;
updatedBy: Link<"User" | "AppDefinition">;
version: number;
};
}
sys: BasicMetaSysProps & {
completedAt?: ISO8601Timestamp;
createdAt: ISO8601Timestamp;
createdBy: Link<"User" | "AppDefinition">;
environment: Link<"Environment">;
errors?: JsonArray;
space: Link<"Space">;
status: EnvironmentTemplateInstallationStatus;
template: VersionedLink<"Template">;
type: "EnvironmentTemplateInstallation";
updatedAt: ISO8601Timestamp;
updatedBy: Link<"User" | "AppDefinition">;
version: number;
};
}
Type Alias EnvironmentTemplateInstallationStatus
Environment
Type Alias EnvironmentTemplateInstallationStatus
Environment
Type Alias EnvironmentTemplateParams
Environment
environmentId: string;
environmentTemplateId: string;
spaceId: string;
}
environmentId: string;
environmentTemplateId: string;
spaceId: string;
}
Type Alias EnvironmentTemplateParams
Environment
environmentId: string;
environmentTemplateId: string;
spaceId: string;
}
environmentId: string;
environmentTemplateId: string;
spaceId: string;
}
Type Alias EnvironmentTemplateProps
Environment
description?: string;
entities: {
contentTypeTemplates: ContentTypeTemplateProps[];
editorInterfaceTemplates: EditorInterfaceTemplateProps[];
};
name: string;
sys: BasicMetaSysProps & {
organization: Link<"Organization">;
version: number;
};
versionDescription?: string;
versionName: string;
}
description?: string;
entities: {
contentTypeTemplates: ContentTypeTemplateProps[];
editorInterfaceTemplates: EditorInterfaceTemplateProps[];
};
name: string;
sys: BasicMetaSysProps & {
organization: Link<"Organization">;
version: number;
};
versionDescription?: string;
versionName: string;
}
Type Alias EnvironmentTemplateProps
Environment
description?: string;
entities: {
contentTypeTemplates: ContentTypeTemplateProps[];
editorInterfaceTemplates: EditorInterfaceTemplateProps[];
};
name: string;
sys: BasicMetaSysProps & {
organization: Link<"Organization">;
version: number;
};
versionDescription?: string;
versionName: string;
}
description?: string;
entities: {
contentTypeTemplates: ContentTypeTemplateProps[];
editorInterfaceTemplates: EditorInterfaceTemplateProps[];
};
name: string;
sys: BasicMetaSysProps & {
organization: Link<"Organization">;
version: number;
};
versionDescription?: string;
versionName: string;
}
+
diff --git a/contentful-management/latest/types/FieldType.html b/contentful-management/latest/types/FieldType.html
index 98a218b799..9f4e538699 100644
--- a/contentful-management/latest/types/FieldType.html
+++ b/contentful-management/latest/types/FieldType.html
@@ -1 +1 @@
-
Type Alias FieldType
Field
| {
type: "Symbol";
}
| {
type: "Text";
}
| {
type: "RichText";
}
| {
type: "Integer";
}
| {
type: "Number";
}
| {
type: "Date";
}
| {
type: "Boolean";
}
| {
type: "Object";
}
| {
type: "Location";
}
| {
linkType: "Asset";
type: "Link";
}
| {
linkType: "Entry";
type: "Link";
}
| {
linkType: string;
type: "ResourceLink";
}
| {
items: {
type: "Symbol";
};
type: "Array";
}
| {
items: {
linkType: "Entry";
type: "Link";
};
type: "Array";
}
| {
items: {
linkType: string;
type: "ResourceLink";
};
type: "Array";
}
| {
items: {
linkType: "Asset";
type: "Link";
};
type: "Array";
}
| {
type: "Symbol";
}
| {
type: "Text";
}
| {
type: "RichText";
}
| {
type: "Integer";
}
| {
type: "Number";
}
| {
type: "Date";
}
| {
type: "Boolean";
}
| {
type: "Object";
}
| {
type: "Location";
}
| {
linkType: "Asset";
type: "Link";
}
| {
linkType: "Entry";
type: "Link";
}
| {
linkType: string;
type: "ResourceLink";
}
| {
items: {
type: "Symbol";
};
type: "Array";
}
| {
items: {
linkType: "Entry";
type: "Link";
};
type: "Array";
}
| {
items: {
linkType: string;
type: "ResourceLink";
};
type: "Array";
}
| {
items: {
linkType: "Asset";
type: "Link";
};
type: "Array";
}
Type Alias FieldType
Field
| {
type: "Symbol";
}
| {
type: "Text";
}
| {
type: "RichText";
}
| {
type: "Integer";
}
| {
type: "Number";
}
| {
type: "Date";
}
| {
type: "Boolean";
}
| {
type: "Object";
}
| {
type: "Location";
}
| {
linkType: "Asset";
type: "Link";
}
| {
linkType: "Entry";
type: "Link";
}
| {
linkType: string;
type: "ResourceLink";
}
| {
items: {
type: "Symbol";
};
type: "Array";
}
| {
items: {
linkType: "Entry";
type: "Link";
};
type: "Array";
}
| {
items: {
linkType: string;
type: "ResourceLink";
};
type: "Array";
}
| {
items: {
linkType: "Asset";
type: "Link";
};
type: "Array";
}
| {
type: "Symbol";
}
| {
type: "Text";
}
| {
type: "RichText";
}
| {
type: "Integer";
}
| {
type: "Number";
}
| {
type: "Date";
}
| {
type: "Boolean";
}
| {
type: "Object";
}
| {
type: "Location";
}
| {
linkType: "Asset";
type: "Link";
}
| {
linkType: "Entry";
type: "Link";
}
| {
linkType: string;
type: "ResourceLink";
}
| {
items: {
type: "Symbol";
};
type: "Array";
}
| {
items: {
linkType: "Entry";
type: "Link";
};
type: "Array";
}
| {
items: {
linkType: string;
type: "ResourceLink";
};
type: "Array";
}
| {
items: {
linkType: "Asset";
type: "Link";
};
type: "Array";
}
Type Alias FreeFormParameters
Free
| Record<string, any>
| any[]
| number
| string
| boolean
| Record<string, any>
| any[]
| number
| string
| boolean
Type Alias FreeFormParameters
Free
| Record<string, any>
| any[]
| number
| string
| boolean
| Record<string, any>
| any[]
| number
| string
| boolean
Type Alias FunctionProps
Function
accepts: string[];
allowNetworks?: string[];
description: string;
name: string;
path: string;
sys: {
appDefinition: Link<"AppDefinition">;
createdAt: string;
createdBy: Link<"User">;
id: string;
organization: Link<"Organization">;
type: "Function";
updatedAt: string;
updatedBy: Link<"User">;
};
}
accepts: string[];
allowNetworks?: string[];
description: string;
name: string;
path: string;
sys: {
appDefinition: Link<"AppDefinition">;
createdAt: string;
createdBy: Link<"User">;
id: string;
organization: Link<"Organization">;
type: "Function";
updatedAt: string;
updatedBy: Link<"User">;
};
}
Type Alias FunctionProps
Function
accepts: string[];
allowNetworks?: string[];
description: string;
name: string;
path: string;
sys: {
appDefinition: Link<"AppDefinition">;
createdAt: string;
createdBy: Link<"User">;
id: string;
organization: Link<"Organization">;
type: "Function";
updatedAt: string;
updatedBy: Link<"User">;
};
}
accepts: string[];
allowNetworks?: string[];
description: string;
name: string;
path: string;
sys: {
appDefinition: Link<"AppDefinition">;
createdAt: string;
createdBy: Link<"User">;
id: string;
organization: Link<"Organization">;
type: "Function";
updatedAt: string;
updatedBy: Link<"User">;
};
}
Type Alias GetAppActionCallDetailsParams
Type Alias GetAppActionCallDetailsParams
Type Alias GetAppActionCallParams
Type Alias GetAppActionCallParams
Type Alias GetAppActionParams
Type Alias GetAppActionParams
Type Alias GetAppActionsForEnvParams
Type Alias GetAppActionsForEnvParams
Type Alias GetAppBundleParams
Type Alias GetAppBundleParams
Type Alias GetAppDefinitionParams
Type Alias GetAppDefinitionParams
Type Alias GetAppInstallationParams
Type Alias GetAppInstallationParams
Type Alias GetAppInstallationsForOrgParams
Type Alias GetAppInstallationsForOrgParams
Type Alias GetAppKeyParams
Type Alias GetAppKeyParams
Type Alias GetAppUploadParams
Type Alias GetAppUploadParams
Type Alias GetBulkActionParams
Type Alias GetBulkActionParams
Type Alias GetCommentParams
Type Alias GetCommentParams
Type Alias GetCommentParentEntityParams
Get
parentEntityId: string;
parentEntityReference?: string;
parentEntityType: "ContentType";
} | {
parentEntityId: string;
parentEntityReference?: string;
parentEntityType: "Entry";
} | {
parentEntityId: string;
parentEntityType: "Workflow";
parentEntityVersion?: number;
})
parentEntityId: string;
parentEntityReference?: string;
parentEntityType: "ContentType";
} | {
parentEntityId: string;
parentEntityReference?: string;
parentEntityType: "Entry";
} | {
parentEntityId: string;
parentEntityType: "Workflow";
parentEntityVersion?: number;
})
Type Alias GetCommentParentEntityParams
Get
parentEntityId: string;
parentEntityReference?: string;
parentEntityType: "ContentType";
} | {
parentEntityId: string;
parentEntityReference?: string;
parentEntityType: "Entry";
} | {
parentEntityId: string;
parentEntityType: "Workflow";
parentEntityVersion?: number;
})
parentEntityId: string;
parentEntityReference?: string;
parentEntityType: "ContentType";
} | {
parentEntityId: string;
parentEntityReference?: string;
parentEntityType: "Entry";
} | {
parentEntityId: string;
parentEntityType: "Workflow";
parentEntityVersion?: number;
})
Type Alias GetConceptDescendantsParams
Get
conceptId: string;
} & {
query?: {
depth?: number;
pageUrl?: string;
};
}
conceptId: string;
} & {
query?: {
depth?: number;
pageUrl?: string;
};
}
Type Alias GetConceptDescendantsParams
Get
conceptId: string;
} & {
query?: {
depth?: number;
pageUrl?: string;
};
}
conceptId: string;
} & {
query?: {
depth?: number;
pageUrl?: string;
};
}
Type Alias GetConceptParams
Type Alias GetConceptParams
Type Alias GetConceptSchemeParams
Type Alias GetConceptSchemeParams
Type Alias GetContentTypeParams
Type Alias GetContentTypeParams
Type Alias GetEditorInterfaceParams
Type Alias GetEditorInterfaceParams
Type Alias GetEntryParams
Type Alias GetEntryParams
Type Alias GetEnvironmentTemplateParams
Type Alias GetEnvironmentTemplateParams
Type Alias GetExtensionParams
Type Alias GetExtensionParams
Type Alias GetManyCommentsParams
Get
status?: CommentStatus;
}
status?: CommentStatus;
}
Type Alias GetManyCommentsParams
Get
status?: CommentStatus;
}
status?: CommentStatus;
}
Type Alias GetManyConceptParams
Get
query?: {
pageUrl?: string;
} | {
conceptScheme?: string;
query?: string;
} & BasicCursorPaginationOptions & Omit<PaginationQueryOptions, "skip">;
}
query?: {
pageUrl?: string;
} | {
conceptScheme?: string;
query?: string;
} & BasicCursorPaginationOptions & Omit<PaginationQueryOptions, "skip">;
}
Type Alias GetManyConceptParams
Get
query?: {
pageUrl?: string;
} | {
conceptScheme?: string;
query?: string;
} & BasicCursorPaginationOptions & Omit<PaginationQueryOptions, "skip">;
}
query?: {
pageUrl?: string;
} | {
conceptScheme?: string;
query?: string;
} & BasicCursorPaginationOptions & Omit<PaginationQueryOptions, "skip">;
}
Type Alias GetManyConceptSchemeParams
Get
query?: {
pageUrl?: string;
} | {
query?: string;
} & BasicCursorPaginationOptions & Omit<PaginationQueryOptions, "skip">;
}
query?: {
pageUrl?: string;
} | {
query?: string;
} & BasicCursorPaginationOptions & Omit<PaginationQueryOptions, "skip">;
}
Type Alias GetManyConceptSchemeParams
Get
query?: {
pageUrl?: string;
} | {
query?: string;
} & BasicCursorPaginationOptions & Omit<PaginationQueryOptions, "skip">;
}
query?: {
pageUrl?: string;
} | {
query?: string;
} & BasicCursorPaginationOptions & Omit<PaginationQueryOptions, "skip">;
}
Type Alias GetOrganizationMembershipParams
Type Alias GetOrganizationMembershipParams
Type Alias GetOrganizationParams
Get
organizationId: string;
}
organizationId: string;
}
Type Alias GetOrganizationParams
Get
organizationId: string;
}
organizationId: string;
}
Type Alias GetReleaseParams
Type Alias GetReleaseParams
Type Alias GetResourceParams
Type Alias GetResourceParams
Type Alias GetResourceProviderParams
Type Alias GetResourceProviderParams
Type Alias GetResourceTypeParams
Type Alias GetResourceTypeParams
Type Alias GetSnapshotForContentTypeParams
Type Alias GetSnapshotForContentTypeParams
Type Alias GetSnapshotForEntryParams
Type Alias GetSnapshotForEntryParams
Type Alias GetSpaceEnvAliasParams
Type Alias GetSpaceEnvAliasParams
Type Alias GetSpaceEnvironmentParams
Get
environmentId: string;
spaceId: string;
}
environmentId: string;
spaceId: string;
}
Type Alias GetSpaceEnvironmentParams
Get
environmentId: string;
spaceId: string;
}
environmentId: string;
spaceId: string;
}
Type Alias GetSpaceEnvironmentUploadParams
Type Alias GetSpaceEnvironmentUploadParams
Type Alias GetSpaceMembershipProps
Type Alias GetSpaceMembershipProps
Type Alias GetSpaceParams
Get
spaceId: string;
}
spaceId: string;
}
Type Alias GetSpaceParams
Get
spaceId: string;
}
spaceId: string;
}
Type Alias GetTagParams
Type Alias GetTagParams
Type Alias GetTaskParams
Type Alias GetTaskParams
Type Alias GetTeamMembershipParams
Type Alias GetTeamMembershipParams
Type Alias GetTeamParams
Get
organizationId: string;
teamId: string;
}
organizationId: string;
teamId: string;
}
Type Alias GetTeamParams
Get
organizationId: string;
teamId: string;
}
organizationId: string;
teamId: string;
}
Type Alias GetTeamSpaceMembershipParams
Type Alias GetTeamSpaceMembershipParams
Type Alias GetUIConfigParams
Type Alias GetUIConfigParams
Type Alias GetUserUIConfigParams
Type Alias GetUserUIConfigParams
Type Alias GetWebhookCallDetailsUrl
Type Alias GetWebhookCallDetailsUrl
Type Alias GetWebhookParams
Type Alias GetWebhookParams
Type Alias GetWorkflowDefinitionParams
Type Alias GetWorkflowDefinitionParams
Type Alias GetWorkflowParams
Type Alias GetWorkflowParams
Type Alias Hint
Hint: {
fieldId: string;
operation: "renameFieldId";
previousFieldId: string;
}
fieldId: string;
operation: "renameFieldId";
previousFieldId: string;
}
Type Alias Hint
Hint: {
fieldId: string;
operation: "renameFieldId";
previousFieldId: string;
}
fieldId: string;
operation: "renameFieldId";
previousFieldId: string;
}
Type Alias ISO8601Timestamp
ISO8601
String will be in ISO8601 datetime format e.g. 2013-06-26T13:57:24Z
-Type Alias ISO8601Timestamp
ISO8601
String will be in ISO8601 datetime format e.g. 2013-06-26T13:57:24Z
+Type Alias IconType
Icon
Type Alias IconType
Icon
Type Alias InstallationParameterType
Type Alias InstallationParameterType
Type Alias KeyValueMap
Key
Type Alias KeyValueMap
Key
Type Alias LocaleProps
Locale
code: string;
contentDeliveryApi: boolean;
contentManagementApi: boolean;
default: boolean;
fallbackCode: string | null;
internal_code: string;
name: string;
optional: boolean;
sys: BasicMetaSysProps & {
environment: SysLink;
space: SysLink;
};
}
code: string;
contentDeliveryApi: boolean;
contentManagementApi: boolean;
default: boolean;
fallbackCode: string | null;
internal_code: string;
name: string;
optional: boolean;
sys: BasicMetaSysProps & {
environment: SysLink;
space: SysLink;
};
}
Type declaration
code: string
Locale code (example: en-us)
+LocaleProps | contentful-management.js - v11.40.3 +Type Alias LocaleProps
LocaleProps: {
code: string;
contentDeliveryApi: boolean;
contentManagementApi: boolean;
default: boolean;
fallbackCode: string | null;
internal_code: string;
name: string;
optional: boolean;
sys: BasicMetaSysProps & {
environment: SysLink;
space: SysLink;
};
}Type declaration
code: string
Locale code (example: en-us)
content
Delivery Api: boolean If the content under this locale should be available on the CDA (for public reading)
content
Management Api: boolean If the content under this locale should be available on the CMA (for editing)
default: boolean
If this is the default locale
@@ -6,4 +6,4 @@internal_
code: string Internal locale code
name: string
Locale name
optional: boolean
If the locale needs to be filled in on entries or not
-sys: BasicMetaSysProps & {
environment: SysLink;
space: SysLink;
}
sys: BasicMetaSysProps & {
environment: SysLink;
space: SysLink;
}
Type Alias Organization
Type Alias Organization
Type Alias OrganizationInvitationProps
Organization
email: string;
firstName: string;
lastName: string;
role: string;
sys: MetaSysProps & {
invitationUrl: string;
organizationMembership: {
sys: MetaLinkProps;
};
status: string;
user: Record<string, any> | null;
};
}
email: string;
firstName: string;
lastName: string;
role: string;
sys: MetaSysProps & {
invitationUrl: string;
organizationMembership: {
sys: MetaLinkProps;
};
status: string;
user: Record<string, any> | null;
};
}
Type Alias OrganizationInvitationProps
Organization
email: string;
firstName: string;
lastName: string;
role: string;
sys: MetaSysProps & {
invitationUrl: string;
organizationMembership: {
sys: MetaLinkProps;
};
status: string;
user: Record<string, any> | null;
};
}
email: string;
firstName: string;
lastName: string;
role: string;
sys: MetaSysProps & {
invitationUrl: string;
organizationMembership: {
sys: MetaLinkProps;
};
status: string;
user: Record<string, any> | null;
};
}
Type Alias OrganizationMembershipProps
Organization
role: string;
status: boolean;
sys: MetaSysProps & {
user: {
sys: MetaLinkProps;
};
};
}
role: string;
status: boolean;
sys: MetaSysProps & {
user: {
sys: MetaLinkProps;
};
};
}
Type declaration
role: string
Role
+OrganizationMembershipProps | contentful-management.js - v11.40.3 +Type Alias OrganizationMembershipProps
OrganizationMembership Props: {
role: string;
status: boolean;
sys: MetaSysProps & {
user: {
sys: MetaLinkProps;
};
};
}Type declaration
role: string
Role
status: boolean
status
sys: MetaSysProps & {
user: {
sys: MetaLinkProps;
};
}System metadata
-
Type Alias OrganizationProp
Type Alias OrganizationProp
Type Alias OrganizationProps
Type declaration
name: string
Name
+OrganizationProps | contentful-management.js - v11.40.3 +Type Alias OrganizationProps
Type declaration
name: string
Name
sys: MetaSysProps
System metadata
-
Type Alias PaginationQueryParams
Type Alias PaginationQueryParams
Type Alias ParameterOption
Parameter
[key: string]: string;
}
[key: string]: string;
}
Type Alias ParameterOption
Parameter
[key: string]: string;
}
[key: string]: string;
}
Type Alias ParameterType
Parameter
| "Boolean"
| "Symbol"
| "Number"
| "Enum"
| "Boolean"
| "Symbol"
| "Number"
| "Enum"
Type Alias ParameterType
Parameter
| "Boolean"
| "Symbol"
| "Number"
| "Enum"
| "Boolean"
| "Symbol"
| "Number"
| "Enum"
Type Alias PersonalAccessTokenProp
Type Alias PersonalAccessTokenProp
Type Alias PersonalAccessTokenProps
Personal
name: string;
revokedAt: null | string;
scopes: "content_management_manage"[];
sys: MetaSysProps & {
expiresAt?: string;
};
token?: string;
}
name: string;
revokedAt: null | string;
scopes: "content_management_manage"[];
sys: MetaSysProps & {
expiresAt?: string;
};
token?: string;
}
Type Alias PersonalAccessTokenProps
Personal
name: string;
revokedAt: null | string;
scopes: "content_management_manage"[];
sys: MetaSysProps & {
expiresAt?: string;
};
token?: string;
}
name: string;
revokedAt: null | string;
scopes: "content_management_manage"[];
sys: MetaSysProps & {
expiresAt?: string;
};
token?: string;
}
Type Alias PlainClientAPI
Plain
accessToken: {
createPersonalAccessToken(rawData: CreatePATProps, headers?: Partial<RawAxiosHeaders & {
Accept: AxiosHeaderValue;
Authorization: AxiosHeaderValue;
Content-Encoding: AxiosHeaderValue;
Content-Length: AxiosHeaderValue;
User-Agent: AxiosHeaderValue;
} & {
Content-Type: ContentType;
}>): Promise<AccessTokenProp>;
get(params: OptionalDefaults<{
tokenId: string;
}>): Promise<AccessTokenProp>;
getMany(params: OptionalDefaults<QueryParams>): Promise<CollectionProp<AccessTokenProp>>;
getManyForOrganization(params: OptionalDefaults<GetOrganizationParams & QueryParams>): Promise<CollectionProp<AccessTokenProp>>;
revoke(params: OptionalDefaults<{
tokenId: string;
}>): Promise<AccessTokenProp>;
};
apiKey: {
create(params: OptionalDefaults<GetSpaceParams>, data: CreateApiKeyProps, headers?: Partial<RawAxiosHeaders & {
Accept: AxiosHeaderValue;
Authorization: AxiosHeaderValue;
Content-Encoding: AxiosHeaderValue;
Content-Length: AxiosHeaderValue;
User-Agent: AxiosHeaderValue;
} & {
Content-Type: ContentType;
}>): Promise<ApiKeyProps>;
createWithId(params: OptionalDefaults<GetSpaceParams & {
apiKeyId: string;
}>, data: CreateApiKeyProps, headers?: Partial<RawAxiosHeaders & {
Accept: AxiosHeaderValue;
Authorization: AxiosHeaderValue;
Content-Encoding: AxiosHeaderValue;
Content-Length: AxiosHeaderValue;
User-Agent: AxiosHeaderValue;
} & {
Content-Type: ContentType;
}>): Promise<ApiKeyProps>;
delete(params: OptionalDefaults<GetSpaceParams & {
apiKeyId: string;
}>): Promise<any>;
get(params: OptionalDefaults<GetSpaceParams & {
apiKeyId: string;
}>): Promise<ApiKeyProps>;
getMany(params: OptionalDefaults<GetSpaceParams & QueryParams>): Promise<CollectionProp<ApiKeyProps>>;
update(params: OptionalDefaults<GetSpaceParams & {
apiKeyId: string;
}>, rawData: ApiKeyProps, headers?: Partial<RawAxiosHeaders & {
Accept: AxiosHeaderValue;
Authorization: AxiosHeaderValue;
Content-Encoding: AxiosHeaderValue;
Content-Length: AxiosHeaderValue;
User-Agent: AxiosHeaderValue;
} & {
Content-Type: ContentType;
}>): Promise<ApiKeyProps>;
};
appAccessToken: AppAccessTokenPlainClientAPI;
appAction: AppActionPlainClientAPI;
appActionCall: AppActionCallPlainClientAPI;
appBundle: AppBundlePlainClientAPI;
appDefinition: AppDefinitionPlainClientAPI;
appDetails: AppDetailsPlainClientAPI;
appEventSubscription: AppEventSubscriptionPlainClientAPI;
appInstallation: AppInstallationPlainClientAPI;
appKey: AppKeyPlainClientAPI;
appSignedRequest: AppSignedRequestPlainClientAPI;
appSigningSecret: AppSigningSecretPlainClientAPI;
appUpload: AppUploadPlainClientAPI;
asset: {
archive(params: OptionalDefaults<GetSpaceEnvironmentParams & {
assetId: string;
}>): Promise<AssetProps>;
create(params: OptionalDefaults<GetSpaceEnvironmentParams>, rawData: CreateAssetProps): Promise<AssetProps>;
createFromFiles(params: OptionalDefaults<GetSpaceEnvironmentParams>, data: Omit<AssetFileProp, "sys">): Promise<AssetProps>;
createWithId(params: OptionalDefaults<GetSpaceEnvironmentParams & {
assetId: string;
}>, rawData: CreateAssetProps): Promise<AssetProps>;
delete(params: OptionalDefaults<GetSpaceEnvironmentParams & {
assetId: string;
}>): Promise<any>;
get(params: OptionalDefaults<GetSpaceEnvironmentParams & {
assetId: string;
} & QueryParams>, rawData?: unknown, headers?: Partial<RawAxiosHeaders & {
Accept: AxiosHeaderValue;
Authorization: AxiosHeaderValue;
Content-Encoding: AxiosHeaderValue;
Content-Length: AxiosHeaderValue;
User-Agent: AxiosHeaderValue;
} & {
Content-Type: ContentType;
}>): Promise<AssetProps>;
getMany(params: OptionalDefaults<GetSpaceEnvironmentParams & QueryParams>, rawData?: unknown, headers?: Partial<RawAxiosHeaders & {
Accept: AxiosHeaderValue;
Authorization: AxiosHeaderValue;
Content-Encoding: AxiosHeaderValue;
Content-Length: AxiosHeaderValue;
User-Agent: AxiosHeaderValue;
} & {
Content-Type: ContentType;
}>): Promise<CollectionProp<AssetProps>>;
getPublished(params: OptionalDefaults<GetSpaceEnvironmentParams & QueryParams>, rawData?: unknown, headers?: Partial<RawAxiosHeaders & {
Accept: AxiosHeaderValue;
Authorization: AxiosHeaderValue;
Content-Encoding: AxiosHeaderValue;
Content-Length: AxiosHeaderValue;
User-Agent: AxiosHeaderValue;
} & {
Content-Type: ContentType;
}>): Promise<CollectionProp<AssetProps>>;
processForAllLocales(params: OptionalDefaults<GetSpaceEnvironmentParams>, asset: AssetProps, processingOptions?: AssetProcessingForLocale): Promise<AssetProps>;
processForLocale(params: OptionalDefaults<GetSpaceEnvironmentParams>, asset: AssetProps, locale: string, processingOptions?: AssetProcessingForLocale): Promise<AssetProps>;
publish(params: OptionalDefaults<GetSpaceEnvironmentParams & {
assetId: string;
}>, rawData: AssetProps): Promise<AssetProps>;
unarchive(params: OptionalDefaults<GetSpaceEnvironmentParams & {
assetId: string;
}>): Promise<AssetProps>;
unpublish(params: OptionalDefaults<GetSpaceEnvironmentParams & {
assetId: string;
}>): Promise<AssetProps>;
update(params: OptionalDefaults<GetSpaceEnvironmentParams & {
assetId: string;
}>, rawData: AssetProps, headers?: Partial<RawAxiosHeaders & {
Accept: AxiosHeaderValue;
Authorization: AxiosHeaderValue;
Content-Encoding: AxiosHeaderValue;
Content-Length: AxiosHeaderValue;
User-Agent: AxiosHeaderValue;
} & {
Content-Type: ContentType;
}>): Promise<AssetProps>;
};
assetKey: {
create(params: OptionalDefaults<GetSpaceEnvironmentParams>, data: CreateAssetKeyProps): Promise<AssetKeyProps>;
};
bulkAction: {
get<T>(params: GetBulkActionParams): Promise<BulkActionProps<T>>;
publish(params: GetSpaceEnvironmentParams, payload: BulkActionPublishPayload): Promise<BulkActionProps<BulkActionPublishPayload>>;
unpublish(params: GetSpaceEnvironmentParams, payload: BulkActionUnpublishPayload): Promise<BulkActionProps<BulkActionUnpublishPayload>>;
validate(params: GetSpaceEnvironmentParams, payload: BulkActionValidatePayload): Promise<BulkActionProps<BulkActionValidatePayload>>;
};
comment: CommentPlainClientAPI;
concept: ConceptPlainClientAPI;
conceptScheme: ConceptSchemePlainClientAPI;
contentType: {
create(params: OptionalDefaults<GetSpaceEnvironmentParams>, rawData: {
description?: string;
displayField?: string;
fields: ContentFields[];
metadata?: ContentTypeMetadata;
name: string;
}): Promise<ContentTypeProps>;
createWithId(params: OptionalDefaults<GetSpaceEnvironmentParams & {
contentTypeId: string;
}>, rawData: {
description?: string;
displayField?: string;
fields: ContentFields[];
metadata?: ContentTypeMetadata;
name: string;
}): Promise<ContentTypeProps>;
delete(params: OptionalDefaults<GetContentTypeParams>): Promise<any>;
get(params: OptionalDefaults<GetSpaceEnvironmentParams & {
contentTypeId: string;
} & QueryParams>): Promise<ContentTypeProps>;
getMany(params: OptionalDefaults<GetSpaceEnvironmentParams & QueryParams>): Promise<CollectionProp<ContentTypeProps>>;
omitAndDeleteField(params: OptionalDefaults<GetContentTypeParams>, contentType: ContentTypeProps, fieldId: string): Promise<ContentTypeProps>;
publish(params: OptionalDefaults<GetContentTypeParams>, rawData: ContentTypeProps): Promise<ContentTypeProps>;
unpublish(params: OptionalDefaults<GetContentTypeParams>): Promise<ContentTypeProps>;
update(params: OptionalDefaults<GetContentTypeParams>, rawData: ContentTypeProps, headers?: Partial<RawAxiosHeaders & {
Accept: AxiosHeaderValue;
Authorization: AxiosHeaderValue;
Content-Encoding: AxiosHeaderValue;
Content-Length: AxiosHeaderValue;
User-Agent: AxiosHeaderValue;
} & {
Content-Type: ContentType;
}>): Promise<ContentTypeProps>;
};
editorInterface: EditorInterfacePlainClientAPI;
entry: {
archive<T>(params: OptionalDefaults<GetSpaceEnvironmentParams & {
entryId: string;
}>): Promise<EntryProps<T>>;
create<T>(params: OptionalDefaults<GetSpaceEnvironmentParams & {
contentTypeId: string;
}>, rawData: CreateEntryProps<T>): Promise<EntryProps<T>>;
createWithId<T>(params: OptionalDefaults<GetSpaceEnvironmentParams & {
contentTypeId: string;
entryId: string;
}>, rawData: CreateEntryProps<T>): Promise<EntryProps<T>>;
delete(params: OptionalDefaults<GetSpaceEnvironmentParams & {
entryId: string;
}>): Promise<any>;
get<T>(params: OptionalDefaults<GetSpaceEnvironmentParams & {
entryId: string;
}>, rawData?: unknown, headers?: Partial<RawAxiosHeaders & {
Accept: AxiosHeaderValue;
Authorization: AxiosHeaderValue;
Content-Encoding: AxiosHeaderValue;
Content-Length: AxiosHeaderValue;
User-Agent: AxiosHeaderValue;
} & {
Content-Type: ContentType;
}>): Promise<EntryProps<T>>;
getMany<T>(params: OptionalDefaults<GetSpaceEnvironmentParams & QueryParams>, rawData?: unknown, headers?: Partial<RawAxiosHeaders & {
Accept: AxiosHeaderValue;
Authorization: AxiosHeaderValue;
Content-Encoding: AxiosHeaderValue;
Content-Length: AxiosHeaderValue;
User-Agent: AxiosHeaderValue;
} & {
Content-Type: ContentType;
}>): Promise<CollectionProp<EntryProps<T>>>;
getPublished<T>(params: OptionalDefaults<GetSpaceEnvironmentParams & QueryParams>, rawData?: unknown, headers?: Partial<RawAxiosHeaders & {
Accept: AxiosHeaderValue;
Authorization: AxiosHeaderValue;
Content-Encoding: AxiosHeaderValue;
Content-Length: AxiosHeaderValue;
User-Agent: AxiosHeaderValue;
} & {
Content-Type: ContentType;
}>): Promise<CollectionProp<EntryProps<T>>>;
patch<T>(params: OptionalDefaults<GetSpaceEnvironmentParams & {
entryId: string;
}>, rawData: OpPatch[], headers?: Partial<RawAxiosHeaders & {
Accept: AxiosHeaderValue;
Authorization: AxiosHeaderValue;
Content-Encoding: AxiosHeaderValue;
Content-Length: AxiosHeaderValue;
User-Agent: AxiosHeaderValue;
} & {
Content-Type: ContentType;
}>): Promise<EntryProps<T>>;
publish<T>(params: OptionalDefaults<GetSpaceEnvironmentParams & {
entryId: string;
}>, rawData: EntryProps<T>): Promise<EntryProps<T>>;
references(params: OptionalDefaults<GetSpaceEnvironmentParams & {
entryId: string;
include?: number;
}>): Promise<EntryReferenceProps>;
unarchive<T>(params: OptionalDefaults<GetSpaceEnvironmentParams & {
entryId: string;
}>): Promise<EntryProps<T>>;
unpublish<T>(params: OptionalDefaults<GetSpaceEnvironmentParams & {
entryId: string;
}>): Promise<EntryProps<T>>;
update<T>(params: OptionalDefaults<GetSpaceEnvironmentParams & {
entryId: string;
}>, rawData: EntryProps<T>, headers?: Partial<RawAxiosHeaders & {
Accept: AxiosHeaderValue;
Authorization: AxiosHeaderValue;
Content-Encoding: AxiosHeaderValue;
Content-Length: AxiosHeaderValue;
User-Agent: AxiosHeaderValue;
} & {
Content-Type: ContentType;
}>): Promise<EntryProps<T>>;
};
environment: EnvironmentPlainClientAPI;
environmentAlias: EnvironmentAliasPlainClientAPI;
environmentTemplate: {
create(params: GetOrganizationParams, rawData: CreateEnvironmentTemplateProps, headers?: Partial<RawAxiosHeaders & {
Accept: AxiosHeaderValue;
Authorization: AxiosHeaderValue;
Content-Encoding: AxiosHeaderValue;
Content-Length: AxiosHeaderValue;
User-Agent: AxiosHeaderValue;
} & {
Content-Type: ContentType;
}>): Promise<EnvironmentTemplateProps>;
delete(params: GetEnvironmentTemplateParams, headers?: Partial<RawAxiosHeaders & {
Accept: AxiosHeaderValue;
Authorization: AxiosHeaderValue;
Content-Encoding: AxiosHeaderValue;
Content-Length: AxiosHeaderValue;
User-Agent: AxiosHeaderValue;
} & {
Content-Type: ContentType;
}>): Promise<void>;
disconnect(params: EnvironmentTemplateParams, headers?: Partial<RawAxiosHeaders & {
Accept: AxiosHeaderValue;
Authorization: AxiosHeaderValue;
Content-Encoding: AxiosHeaderValue;
Content-Length: AxiosHeaderValue;
User-Agent: AxiosHeaderValue;
} & {
Content-Type: ContentType;
}>): Promise<void>;
get(params: GetOrganizationParams & {
environmentTemplateId: string;
} & {
query?: {
select?: string;
};
version?: number;
}, headers?: Partial<RawAxiosHeaders & {
Accept: AxiosHeaderValue;
Authorization: AxiosHeaderValue;
Content-Encoding: AxiosHeaderValue;
Content-Length: AxiosHeaderValue;
User-Agent: AxiosHeaderValue;
} & {
Content-Type: ContentType;
}>): Promise<EnvironmentTemplateProps>;
getMany(params: GetOrganizationParams & {
query?: BasicCursorPaginationOptions & {
select?: string;
};
}, headers?: Partial<RawAxiosHeaders & {
Accept: AxiosHeaderValue;
Authorization: AxiosHeaderValue;
Content-Encoding: AxiosHeaderValue;
Content-Length: AxiosHeaderValue;
User-Agent: AxiosHeaderValue;
} & {
Content-Type: ContentType;
}>): Promise<CursorPaginatedCollectionProp<EnvironmentTemplateProps>>;
install(params: EnvironmentTemplateParams, rawData: CreateEnvironmentTemplateInstallationProps, headers?: Partial<RawAxiosHeaders & {
Accept: AxiosHeaderValue;
Authorization: AxiosHeaderValue;
Content-Encoding: AxiosHeaderValue;
Content-Length: AxiosHeaderValue;
User-Agent: AxiosHeaderValue;
} & {
Content-Type: ContentType;
}>): Promise<EnvironmentTemplateInstallationProps>;
update(params: GetEnvironmentTemplateParams, rawData: EnvironmentTemplateProps, headers?: Partial<RawAxiosHeaders & {
Accept: AxiosHeaderValue;
Authorization: AxiosHeaderValue;
Content-Encoding: AxiosHeaderValue;
Content-Length: AxiosHeaderValue;
User-Agent: AxiosHeaderValue;
} & {
Content-Type: ContentType;
}>): Promise<EnvironmentTemplateProps>;
validate(params: EnvironmentTemplateParams & {
version?: number;
}, rawData: ValidateEnvironmentTemplateInstallationProps, headers?: Partial<RawAxiosHeaders & {
Accept: AxiosHeaderValue;
Authorization: AxiosHeaderValue;
Content-Encoding: AxiosHeaderValue;
Content-Length: AxiosHeaderValue;
User-Agent: AxiosHeaderValue;
} & {
Content-Type: ContentType;
}>): Promise<EnvironmentTemplateValidationProps>;
versions(params: GetOrganizationParams & {
environmentTemplateId: string;
} & {
query?: BasicCursorPaginationOptions & {
select?: string;
};
}, headers?: Partial<RawAxiosHeaders & {
Accept: AxiosHeaderValue;
Authorization: AxiosHeaderValue;
Content-Encoding: AxiosHeaderValue;
Content-Length: AxiosHeaderValue;
User-Agent: AxiosHeaderValue;
} & {
Content-Type: ContentType;
}>): Promise<CursorPaginatedCollectionProp<EnvironmentTemplateProps>>;
versionUpdate(params: GetOrganizationParams & {
environmentTemplateId: string;
} & {
version: number;
}, rawData: {
versionDescription?: string;
versionName?: string;
}, headers?: Partial<RawAxiosHeaders & {
Accept: AxiosHeaderValue;
Authorization: AxiosHeaderValue;
Content-Encoding: AxiosHeaderValue;
Content-Length: AxiosHeaderValue;
User-Agent: AxiosHeaderValue;
} & {
Content-Type: ContentType;
}>): Promise<EnvironmentTemplateProps>;
};
environmentTemplateInstallation: {
getForEnvironment(params: BasicCursorPaginationOptions & EnvironmentTemplateParams & {
installationId?: string;
}, headers?: Partial<RawAxiosHeaders & {
Accept: AxiosHeaderValue;
Authorization: AxiosHeaderValue;
Content-Encoding: AxiosHeaderValue;
Content-Length: AxiosHeaderValue;
User-Agent: AxiosHeaderValue;
} & {
Content-Type: ContentType;
}>): Promise<CursorPaginatedCollectionProp<EnvironmentTemplateInstallationProps>>;
getMany(params: BasicCursorPaginationOptions & {
environmentId?: string;
environmentTemplateId: string;
organizationId: string;
spaceId?: string;
}, headers?: Partial<RawAxiosHeaders & {
Accept: AxiosHeaderValue;
Authorization: AxiosHeaderValue;
Content-Encoding: AxiosHeaderValue;
Content-Length: AxiosHeaderValue;
User-Agent: AxiosHeaderValue;
} & {
Content-Type: ContentType;
}>): Promise<CursorPaginatedCollectionProp<EnvironmentTemplateInstallationProps>>;
};
extension: ExtensionPlainClientAPI;
function: {
getMany(params: OptionalDefaults<GetOrganizationParams & {
appDefinitionId: string;
} & QueryParams>): Promise<CollectionProp<FunctionProps>>;
};
locale: LocalePlainClientAPI;
organization: OrganizationPlainClientAPI;
organizationInvitation: {
create(params: OptionalDefaults<{
organizationId: string;
}>, data: CreateOrganizationInvitationProps, headers?: Partial<RawAxiosHeaders & {
Accept: AxiosHeaderValue;
Authorization: AxiosHeaderValue;
Content-Encoding: AxiosHeaderValue;
Content-Length: AxiosHeaderValue;
User-Agent: AxiosHeaderValue;
} & {
Content-Type: ContentType;
}>): Promise<OrganizationInvitationProps>;
get(params: OptionalDefaults<{
invitationId: string;
organizationId: string;
}>, headers?: Partial<RawAxiosHeaders & {
Accept: AxiosHeaderValue;
Authorization: AxiosHeaderValue;
Content-Encoding: AxiosHeaderValue;
Content-Length: AxiosHeaderValue;
User-Agent: AxiosHeaderValue;
} & {
Content-Type: ContentType;
}>): Promise<OrganizationInvitationProps>;
};
organizationMembership: {
delete(params: OptionalDefaults<GetOrganizationMembershipParams>): Promise<any>;
get(params: OptionalDefaults<GetOrganizationMembershipParams>): Promise<OrganizationMembershipProps>;
getMany(params: OptionalDefaults<GetOrganizationParams & QueryParams>): Promise<CollectionProp<OrganizationMembershipProps>>;
update(params: OptionalDefaults<GetOrganizationMembershipParams>, rawData: OrganizationMembershipProps, headers?: Partial<RawAxiosHeaders & {
Accept: AxiosHeaderValue;
Authorization: AxiosHeaderValue;
Content-Encoding: AxiosHeaderValue;
Content-Length: AxiosHeaderValue;
User-Agent: AxiosHeaderValue;
} & {
Content-Type: ContentType;
}>): Promise<OrganizationMembershipProps>;
};
personalAccessToken: {
create(rawData: CreatePersonalAccessTokenProps, headers?: Partial<RawAxiosHeaders & {
Accept: AxiosHeaderValue;
Authorization: AxiosHeaderValue;
Content-Encoding: AxiosHeaderValue;
Content-Length: AxiosHeaderValue;
User-Agent: AxiosHeaderValue;
} & {
Content-Type: ContentType;
}>): Promise<PersonalAccessTokenProps>;
get(params: OptionalDefaults<{
tokenId: string;
}>): Promise<PersonalAccessTokenProps>;
getMany(params: OptionalDefaults<QueryParams>): Promise<CollectionProp<PersonalAccessTokenProps>>;
revoke(params: OptionalDefaults<{
tokenId: string;
}>): Promise<PersonalAccessTokenProps>;
};
previewApiKey: {
get(params: OptionalDefaults<GetSpaceParams & {
previewApiKeyId: string;
}>): Promise<PreviewApiKeyProps>;
getMany(params: OptionalDefaults<GetSpaceParams & QueryParams>): Promise<CollectionProp<PreviewApiKeyProps>>;
};
raw: {
delete<T>(url: string, config?: RawAxiosRequestConfig): Promise<T>;
get<T>(url: string, config?: RawAxiosRequestConfig): Promise<T>;
getDefaultParams(): undefined | DefaultParams;
http<T>(url: string, config?: RawAxiosRequestConfig): Promise<T>;
patch<T>(url: string, payload?: any, config?: RawAxiosRequestConfig): Promise<T>;
post<T>(url: string, payload?: any, config?: RawAxiosRequestConfig): Promise<T>;
put<T>(url: string, payload?: any, config?: RawAxiosRequestConfig): Promise<T>;
};
release: {
archive(params: OptionalDefaults<GetSpaceEnvironmentParams & {
releaseId: string;
} & {
version: number;
}>): Promise<ReleaseProps>;
create(params: OptionalDefaults<GetSpaceEnvironmentParams>, data: ReleasePayload): Promise<ReleaseProps>;
delete(params: OptionalDefaults<GetReleaseParams>): Promise<void>;
get(params: OptionalDefaults<GetReleaseParams>): Promise<ReleaseProps>;
publish(params: OptionalDefaults<GetSpaceEnvironmentParams & {
releaseId: string;
} & {
version: number;
}>): Promise<ReleaseActionProps<"publish">>;
query(params: Omit<GetSpaceEnvironmentParams, keyof DefaultParams> & Partial<Pick<GetSpaceEnvironmentParams, keyof GetSpaceEnvironmentParams>> & {
query?: ReleaseQueryOptions;
}): Promise<CursorPaginatedCollectionProp<ReleaseProps>>;
unarchive(params: OptionalDefaults<GetSpaceEnvironmentParams & {
releaseId: string;
} & {
version: number;
}>): Promise<ReleaseProps>;
unpublish(params: OptionalDefaults<GetSpaceEnvironmentParams & {
releaseId: string;
} & {
version: number;
}>): Promise<ReleaseActionProps<"unpublish">>;
update(params: OptionalDefaults<GetSpaceEnvironmentParams & {
releaseId: string;
} & {
version: number;
}>, data: ReleasePayload): Promise<ReleaseProps>;
validate(params: OptionalDefaults<GetReleaseParams>, data?: ReleaseValidatePayload): Promise<ReleaseActionProps<"validate">>;
};
releaseAction: {
get(params: Omit<GetReleaseParams, keyof DefaultParams> & Partial<Pick<GetReleaseParams, keyof GetSpaceEnvironmentParams>> & {
actionId: string;
}): Promise<ReleaseActionProps<any>>;
getMany(params: Omit<GetSpaceEnvironmentParams, keyof DefaultParams> & Partial<Pick<GetSpaceEnvironmentParams, keyof GetSpaceEnvironmentParams>> & {
query?: ReleaseActionQueryOptions;
}): Promise<CollectionProp<ReleaseActionProps<any>>>;
queryForRelease(params: Omit<GetReleaseParams, keyof DefaultParams> & Partial<Pick<GetReleaseParams, keyof GetSpaceEnvironmentParams>> & {
query?: ReleaseActionQueryOptions;
}): Promise<CollectionProp<ReleaseActionProps<any>>>;
};
resource: ResourcePlainAPI;
resourceProvider: ResourceProviderPlainClientAPI;
resourceType: ResourceTypePlainClientAPI;
role: RolePlainClientAPI;
scheduledActions: {
create(params: OptionalDefaults<GetSpaceParams>, data: CreateUpdateScheduledActionProps): Promise<ScheduledActionProps>;
delete(params: OptionalDefaults<GetSpaceEnvironmentParams & {
scheduledActionId: string;
}>): Promise<ScheduledActionProps>;
get(params: Omit<GetSpaceParams, keyof DefaultParams> & Partial<Pick<GetSpaceParams, "spaceId">> & {
environmentId: string;
scheduledActionId: string;
}): Promise<ScheduledActionProps>;
getMany(params: OptionalDefaults<GetSpaceParams & QueryParams>): Promise<CursorPaginatedCollectionProp<ScheduledActionProps>>;
update(params: OptionalDefaults<GetSpaceParams & {
scheduledActionId: string;
version: number;
}>, data: CreateUpdateScheduledActionProps): Promise<ScheduledActionProps>;
};
snapshot: {
getForContentType(params: OptionalDefaults<GetSpaceEnvironmentParams & {
contentTypeId: string;
} & {
snapshotId: string;
}>): Promise<SnapshotProps<ContentTypeProps>>;
getForEntry<T>(params: OptionalDefaults<GetSpaceEnvironmentParams & {
entryId: string;
} & {
snapshotId: string;
}>): Promise<SnapshotProps<Omit<EntryProps<T>, "metadata">>>;
getManyForContentType(params: OptionalDefaults<GetSpaceEnvironmentParams & {
contentTypeId: string;
} & QueryParams>): Promise<CollectionProp<SnapshotProps<ContentTypeProps>>>;
getManyForEntry<T>(params: OptionalDefaults<GetSpaceEnvironmentParams & {
entryId: string;
} & QueryParams>): Promise<CollectionProp<SnapshotProps<Omit<EntryProps<T>, "metadata">>>>;
};
space: SpacePlainClientAPI;
spaceMember: SpaceMemberPlainClientAPI;
spaceMembership: SpaceMembershipPlainClientAPI;
tag: TagPlainClientAPI;
task: TaskPlainClientAPI;
team: TeamPlainClientAPI;
teamMembership: TeamMembershipPlainClientAPI;
teamSpaceMembership: TeamSpaceMembershipPlainClientAPI;
uiConfig: UIConfigPlainClientAPI;
upload: UploadPlainClientAPI;
uploadCredential: UploadCredentialAPI;
usage: UsagePlainClientAPI;
user: UserPlainClientAPI;
userUIConfig: UserUIConfigPlainClientAPI;
webhook: WebhookPlainClientAPI;
workflow: WorkflowPlainClientAPI;
workflowDefinition: WorkflowDefinitionPlainClientAPI;
workflowsChangelog: WorkflowsChangelogPlainClientAPI;
}
accessToken: {
createPersonalAccessToken(rawData: CreatePATProps, headers?: Partial<RawAxiosHeaders & {
Accept: AxiosHeaderValue;
Authorization: AxiosHeaderValue;
Content-Encoding: AxiosHeaderValue;
Content-Length: AxiosHeaderValue;
User-Agent: AxiosHeaderValue;
} & {
Content-Type: ContentType;
}>): Promise<AccessTokenProp>;
get(params: OptionalDefaults<{
tokenId: string;
}>): Promise<AccessTokenProp>;
getMany(params: OptionalDefaults<QueryParams>): Promise<CollectionProp<AccessTokenProp>>;
getManyForOrganization(params: OptionalDefaults<GetOrganizationParams & QueryParams>): Promise<CollectionProp<AccessTokenProp>>;
revoke(params: OptionalDefaults<{
tokenId: string;
}>): Promise<AccessTokenProp>;
};
apiKey: {
create(params: OptionalDefaults<GetSpaceParams>, data: CreateApiKeyProps, headers?: Partial<RawAxiosHeaders & {
Accept: AxiosHeaderValue;
Authorization: AxiosHeaderValue;
Content-Encoding: AxiosHeaderValue;
Content-Length: AxiosHeaderValue;
User-Agent: AxiosHeaderValue;
} & {
Content-Type: ContentType;
}>): Promise<ApiKeyProps>;
createWithId(params: OptionalDefaults<GetSpaceParams & {
apiKeyId: string;
}>, data: CreateApiKeyProps, headers?: Partial<RawAxiosHeaders & {
Accept: AxiosHeaderValue;
Authorization: AxiosHeaderValue;
Content-Encoding: AxiosHeaderValue;
Content-Length: AxiosHeaderValue;
User-Agent: AxiosHeaderValue;
} & {
Content-Type: ContentType;
}>): Promise<ApiKeyProps>;
delete(params: OptionalDefaults<GetSpaceParams & {
apiKeyId: string;
}>): Promise<any>;
get(params: OptionalDefaults<GetSpaceParams & {
apiKeyId: string;
}>): Promise<ApiKeyProps>;
getMany(params: OptionalDefaults<GetSpaceParams & QueryParams>): Promise<CollectionProp<ApiKeyProps>>;
update(params: OptionalDefaults<GetSpaceParams & {
apiKeyId: string;
}>, rawData: ApiKeyProps, headers?: Partial<RawAxiosHeaders & {
Accept: AxiosHeaderValue;
Authorization: AxiosHeaderValue;
Content-Encoding: AxiosHeaderValue;
Content-Length: AxiosHeaderValue;
User-Agent: AxiosHeaderValue;
} & {
Content-Type: ContentType;
}>): Promise<ApiKeyProps>;
};
appAccessToken: AppAccessTokenPlainClientAPI;
appAction: AppActionPlainClientAPI;
appActionCall: AppActionCallPlainClientAPI;
appBundle: AppBundlePlainClientAPI;
appDefinition: AppDefinitionPlainClientAPI;
appDetails: AppDetailsPlainClientAPI;
appEventSubscription: AppEventSubscriptionPlainClientAPI;
appInstallation: AppInstallationPlainClientAPI;
appKey: AppKeyPlainClientAPI;
appSignedRequest: AppSignedRequestPlainClientAPI;
appSigningSecret: AppSigningSecretPlainClientAPI;
appUpload: AppUploadPlainClientAPI;
asset: {
archive(params: OptionalDefaults<GetSpaceEnvironmentParams & {
assetId: string;
}>): Promise<AssetProps>;
create(params: OptionalDefaults<GetSpaceEnvironmentParams>, rawData: CreateAssetProps): Promise<AssetProps>;
createFromFiles(params: OptionalDefaults<GetSpaceEnvironmentParams>, data: Omit<AssetFileProp, "sys">): Promise<AssetProps>;
createWithId(params: OptionalDefaults<GetSpaceEnvironmentParams & {
assetId: string;
}>, rawData: CreateAssetProps): Promise<AssetProps>;
delete(params: OptionalDefaults<GetSpaceEnvironmentParams & {
assetId: string;
}>): Promise<any>;
get(params: OptionalDefaults<GetSpaceEnvironmentParams & {
assetId: string;
} & QueryParams>, rawData?: unknown, headers?: Partial<RawAxiosHeaders & {
Accept: AxiosHeaderValue;
Authorization: AxiosHeaderValue;
Content-Encoding: AxiosHeaderValue;
Content-Length: AxiosHeaderValue;
User-Agent: AxiosHeaderValue;
} & {
Content-Type: ContentType;
}>): Promise<AssetProps>;
getMany(params: OptionalDefaults<GetSpaceEnvironmentParams & QueryParams>, rawData?: unknown, headers?: Partial<RawAxiosHeaders & {
Accept: AxiosHeaderValue;
Authorization: AxiosHeaderValue;
Content-Encoding: AxiosHeaderValue;
Content-Length: AxiosHeaderValue;
User-Agent: AxiosHeaderValue;
} & {
Content-Type: ContentType;
}>): Promise<CollectionProp<AssetProps>>;
getPublished(params: OptionalDefaults<GetSpaceEnvironmentParams & QueryParams>, rawData?: unknown, headers?: Partial<RawAxiosHeaders & {
Accept: AxiosHeaderValue;
Authorization: AxiosHeaderValue;
Content-Encoding: AxiosHeaderValue;
Content-Length: AxiosHeaderValue;
User-Agent: AxiosHeaderValue;
} & {
Content-Type: ContentType;
}>): Promise<CollectionProp<AssetProps>>;
processForAllLocales(params: OptionalDefaults<GetSpaceEnvironmentParams>, asset: AssetProps, processingOptions?: AssetProcessingForLocale): Promise<AssetProps>;
processForLocale(params: OptionalDefaults<GetSpaceEnvironmentParams>, asset: AssetProps, locale: string, processingOptions?: AssetProcessingForLocale): Promise<AssetProps>;
publish(params: OptionalDefaults<GetSpaceEnvironmentParams & {
assetId: string;
}>, rawData: AssetProps): Promise<AssetProps>;
unarchive(params: OptionalDefaults<GetSpaceEnvironmentParams & {
assetId: string;
}>): Promise<AssetProps>;
unpublish(params: OptionalDefaults<GetSpaceEnvironmentParams & {
assetId: string;
}>): Promise<AssetProps>;
update(params: OptionalDefaults<GetSpaceEnvironmentParams & {
assetId: string;
}>, rawData: AssetProps, headers?: Partial<RawAxiosHeaders & {
Accept: AxiosHeaderValue;
Authorization: AxiosHeaderValue;
Content-Encoding: AxiosHeaderValue;
Content-Length: AxiosHeaderValue;
User-Agent: AxiosHeaderValue;
} & {
Content-Type: ContentType;
}>): Promise<AssetProps>;
};
assetKey: {
create(params: OptionalDefaults<GetSpaceEnvironmentParams>, data: CreateAssetKeyProps): Promise<AssetKeyProps>;
};
bulkAction: {
get<T>(params: GetBulkActionParams): Promise<BulkActionProps<T>>;
publish(params: GetSpaceEnvironmentParams, payload: BulkActionPublishPayload): Promise<BulkActionProps<BulkActionPublishPayload>>;
unpublish(params: GetSpaceEnvironmentParams, payload: BulkActionUnpublishPayload): Promise<BulkActionProps<BulkActionUnpublishPayload>>;
validate(params: GetSpaceEnvironmentParams, payload: BulkActionValidatePayload): Promise<BulkActionProps<BulkActionValidatePayload>>;
};
comment: CommentPlainClientAPI;
concept: ConceptPlainClientAPI;
conceptScheme: ConceptSchemePlainClientAPI;
contentType: {
create(params: OptionalDefaults<GetSpaceEnvironmentParams>, rawData: {
description?: string;
displayField?: string;
fields: ContentFields[];
metadata?: ContentTypeMetadata;
name: string;
}): Promise<ContentTypeProps>;
createWithId(params: OptionalDefaults<GetSpaceEnvironmentParams & {
contentTypeId: string;
}>, rawData: {
description?: string;
displayField?: string;
fields: ContentFields[];
metadata?: ContentTypeMetadata;
name: string;
}): Promise<ContentTypeProps>;
delete(params: OptionalDefaults<GetContentTypeParams>): Promise<any>;
get(params: OptionalDefaults<GetSpaceEnvironmentParams & {
contentTypeId: string;
} & QueryParams>): Promise<ContentTypeProps>;
getMany(params: OptionalDefaults<GetSpaceEnvironmentParams & QueryParams>): Promise<CollectionProp<ContentTypeProps>>;
omitAndDeleteField(params: OptionalDefaults<GetContentTypeParams>, contentType: ContentTypeProps, fieldId: string): Promise<ContentTypeProps>;
publish(params: OptionalDefaults<GetContentTypeParams>, rawData: ContentTypeProps): Promise<ContentTypeProps>;
unpublish(params: OptionalDefaults<GetContentTypeParams>): Promise<ContentTypeProps>;
update(params: OptionalDefaults<GetContentTypeParams>, rawData: ContentTypeProps, headers?: Partial<RawAxiosHeaders & {
Accept: AxiosHeaderValue;
Authorization: AxiosHeaderValue;
Content-Encoding: AxiosHeaderValue;
Content-Length: AxiosHeaderValue;
User-Agent: AxiosHeaderValue;
} & {
Content-Type: ContentType;
}>): Promise<ContentTypeProps>;
};
editorInterface: EditorInterfacePlainClientAPI;
entry: {
archive<T>(params: OptionalDefaults<GetSpaceEnvironmentParams & {
entryId: string;
}>): Promise<EntryProps<T>>;
create<T>(params: OptionalDefaults<GetSpaceEnvironmentParams & {
contentTypeId: string;
}>, rawData: CreateEntryProps<T>): Promise<EntryProps<T>>;
createWithId<T>(params: OptionalDefaults<GetSpaceEnvironmentParams & {
contentTypeId: string;
entryId: string;
}>, rawData: CreateEntryProps<T>): Promise<EntryProps<T>>;
delete(params: OptionalDefaults<GetSpaceEnvironmentParams & {
entryId: string;
}>): Promise<any>;
get<T>(params: OptionalDefaults<GetSpaceEnvironmentParams & {
entryId: string;
}>, rawData?: unknown, headers?: Partial<RawAxiosHeaders & {
Accept: AxiosHeaderValue;
Authorization: AxiosHeaderValue;
Content-Encoding: AxiosHeaderValue;
Content-Length: AxiosHeaderValue;
User-Agent: AxiosHeaderValue;
} & {
Content-Type: ContentType;
}>): Promise<EntryProps<T>>;
getMany<T>(params: OptionalDefaults<GetSpaceEnvironmentParams & QueryParams>, rawData?: unknown, headers?: Partial<RawAxiosHeaders & {
Accept: AxiosHeaderValue;
Authorization: AxiosHeaderValue;
Content-Encoding: AxiosHeaderValue;
Content-Length: AxiosHeaderValue;
User-Agent: AxiosHeaderValue;
} & {
Content-Type: ContentType;
}>): Promise<CollectionProp<EntryProps<T>>>;
getPublished<T>(params: OptionalDefaults<GetSpaceEnvironmentParams & QueryParams>, rawData?: unknown, headers?: Partial<RawAxiosHeaders & {
Accept: AxiosHeaderValue;
Authorization: AxiosHeaderValue;
Content-Encoding: AxiosHeaderValue;
Content-Length: AxiosHeaderValue;
User-Agent: AxiosHeaderValue;
} & {
Content-Type: ContentType;
}>): Promise<CollectionProp<EntryProps<T>>>;
patch<T>(params: OptionalDefaults<GetSpaceEnvironmentParams & {
entryId: string;
}>, rawData: OpPatch[], headers?: Partial<RawAxiosHeaders & {
Accept: AxiosHeaderValue;
Authorization: AxiosHeaderValue;
Content-Encoding: AxiosHeaderValue;
Content-Length: AxiosHeaderValue;
User-Agent: AxiosHeaderValue;
} & {
Content-Type: ContentType;
}>): Promise<EntryProps<T>>;
publish<T>(params: OptionalDefaults<GetSpaceEnvironmentParams & {
entryId: string;
}>, rawData: EntryProps<T>): Promise<EntryProps<T>>;
references(params: OptionalDefaults<GetSpaceEnvironmentParams & {
entryId: string;
include?: number;
}>): Promise<EntryReferenceProps>;
unarchive<T>(params: OptionalDefaults<GetSpaceEnvironmentParams & {
entryId: string;
}>): Promise<EntryProps<T>>;
unpublish<T>(params: OptionalDefaults<GetSpaceEnvironmentParams & {
entryId: string;
}>): Promise<EntryProps<T>>;
update<T>(params: OptionalDefaults<GetSpaceEnvironmentParams & {
entryId: string;
}>, rawData: EntryProps<T>, headers?: Partial<RawAxiosHeaders & {
Accept: AxiosHeaderValue;
Authorization: AxiosHeaderValue;
Content-Encoding: AxiosHeaderValue;
Content-Length: AxiosHeaderValue;
User-Agent: AxiosHeaderValue;
} & {
Content-Type: ContentType;
}>): Promise<EntryProps<T>>;
};
environment: EnvironmentPlainClientAPI;
environmentAlias: EnvironmentAliasPlainClientAPI;
environmentTemplate: {
create(params: GetOrganizationParams, rawData: CreateEnvironmentTemplateProps, headers?: Partial<RawAxiosHeaders & {
Accept: AxiosHeaderValue;
Authorization: AxiosHeaderValue;
Content-Encoding: AxiosHeaderValue;
Content-Length: AxiosHeaderValue;
User-Agent: AxiosHeaderValue;
} & {
Content-Type: ContentType;
}>): Promise<EnvironmentTemplateProps>;
delete(params: GetEnvironmentTemplateParams, headers?: Partial<RawAxiosHeaders & {
Accept: AxiosHeaderValue;
Authorization: AxiosHeaderValue;
Content-Encoding: AxiosHeaderValue;
Content-Length: AxiosHeaderValue;
User-Agent: AxiosHeaderValue;
} & {
Content-Type: ContentType;
}>): Promise<void>;
disconnect(params: EnvironmentTemplateParams, headers?: Partial<RawAxiosHeaders & {
Accept: AxiosHeaderValue;
Authorization: AxiosHeaderValue;
Content-Encoding: AxiosHeaderValue;
Content-Length: AxiosHeaderValue;
User-Agent: AxiosHeaderValue;
} & {
Content-Type: ContentType;
}>): Promise<void>;
get(params: GetOrganizationParams & {
environmentTemplateId: string;
} & {
query?: {
select?: string;
};
version?: number;
}, headers?: Partial<RawAxiosHeaders & {
Accept: AxiosHeaderValue;
Authorization: AxiosHeaderValue;
Content-Encoding: AxiosHeaderValue;
Content-Length: AxiosHeaderValue;
User-Agent: AxiosHeaderValue;
} & {
Content-Type: ContentType;
}>): Promise<EnvironmentTemplateProps>;
getMany(params: GetOrganizationParams & {
query?: BasicCursorPaginationOptions & {
select?: string;
};
}, headers?: Partial<RawAxiosHeaders & {
Accept: AxiosHeaderValue;
Authorization: AxiosHeaderValue;
Content-Encoding: AxiosHeaderValue;
Content-Length: AxiosHeaderValue;
User-Agent: AxiosHeaderValue;
} & {
Content-Type: ContentType;
}>): Promise<CursorPaginatedCollectionProp<EnvironmentTemplateProps>>;
install(params: EnvironmentTemplateParams, rawData: CreateEnvironmentTemplateInstallationProps, headers?: Partial<RawAxiosHeaders & {
Accept: AxiosHeaderValue;
Authorization: AxiosHeaderValue;
Content-Encoding: AxiosHeaderValue;
Content-Length: AxiosHeaderValue;
User-Agent: AxiosHeaderValue;
} & {
Content-Type: ContentType;
}>): Promise<EnvironmentTemplateInstallationProps>;
update(params: GetEnvironmentTemplateParams, rawData: EnvironmentTemplateProps, headers?: Partial<RawAxiosHeaders & {
Accept: AxiosHeaderValue;
Authorization: AxiosHeaderValue;
Content-Encoding: AxiosHeaderValue;
Content-Length: AxiosHeaderValue;
User-Agent: AxiosHeaderValue;
} & {
Content-Type: ContentType;
}>): Promise<EnvironmentTemplateProps>;
validate(params: EnvironmentTemplateParams & {
version?: number;
}, rawData: ValidateEnvironmentTemplateInstallationProps, headers?: Partial<RawAxiosHeaders & {
Accept: AxiosHeaderValue;
Authorization: AxiosHeaderValue;
Content-Encoding: AxiosHeaderValue;
Content-Length: AxiosHeaderValue;
User-Agent: AxiosHeaderValue;
} & {
Content-Type: ContentType;
}>): Promise<EnvironmentTemplateValidationProps>;
versions(params: GetOrganizationParams & {
environmentTemplateId: string;
} & {
query?: BasicCursorPaginationOptions & {
select?: string;
};
}, headers?: Partial<RawAxiosHeaders & {
Accept: AxiosHeaderValue;
Authorization: AxiosHeaderValue;
Content-Encoding: AxiosHeaderValue;
Content-Length: AxiosHeaderValue;
User-Agent: AxiosHeaderValue;
} & {
Content-Type: ContentType;
}>): Promise<CursorPaginatedCollectionProp<EnvironmentTemplateProps>>;
versionUpdate(params: GetOrganizationParams & {
environmentTemplateId: string;
} & {
version: number;
}, rawData: {
versionDescription?: string;
versionName?: string;
}, headers?: Partial<RawAxiosHeaders & {
Accept: AxiosHeaderValue;
Authorization: AxiosHeaderValue;
Content-Encoding: AxiosHeaderValue;
Content-Length: AxiosHeaderValue;
User-Agent: AxiosHeaderValue;
} & {
Content-Type: ContentType;
}>): Promise<EnvironmentTemplateProps>;
};
environmentTemplateInstallation: {
getForEnvironment(params: BasicCursorPaginationOptions & EnvironmentTemplateParams & {
installationId?: string;
}, headers?: Partial<RawAxiosHeaders & {
Accept: AxiosHeaderValue;
Authorization: AxiosHeaderValue;
Content-Encoding: AxiosHeaderValue;
Content-Length: AxiosHeaderValue;
User-Agent: AxiosHeaderValue;
} & {
Content-Type: ContentType;
}>): Promise<CursorPaginatedCollectionProp<EnvironmentTemplateInstallationProps>>;
getMany(params: BasicCursorPaginationOptions & {
environmentId?: string;
environmentTemplateId: string;
organizationId: string;
spaceId?: string;
}, headers?: Partial<RawAxiosHeaders & {
Accept: AxiosHeaderValue;
Authorization: AxiosHeaderValue;
Content-Encoding: AxiosHeaderValue;
Content-Length: AxiosHeaderValue;
User-Agent: AxiosHeaderValue;
} & {
Content-Type: ContentType;
}>): Promise<CursorPaginatedCollectionProp<EnvironmentTemplateInstallationProps>>;
};
extension: ExtensionPlainClientAPI;
function: {
getMany(params: OptionalDefaults<GetOrganizationParams & {
appDefinitionId: string;
} & QueryParams>): Promise<CollectionProp<FunctionProps>>;
};
locale: LocalePlainClientAPI;
organization: OrganizationPlainClientAPI;
organizationInvitation: {
create(params: OptionalDefaults<{
organizationId: string;
}>, data: CreateOrganizationInvitationProps, headers?: Partial<RawAxiosHeaders & {
Accept: AxiosHeaderValue;
Authorization: AxiosHeaderValue;
Content-Encoding: AxiosHeaderValue;
Content-Length: AxiosHeaderValue;
User-Agent: AxiosHeaderValue;
} & {
Content-Type: ContentType;
}>): Promise<OrganizationInvitationProps>;
get(params: OptionalDefaults<{
invitationId: string;
organizationId: string;
}>, headers?: Partial<RawAxiosHeaders & {
Accept: AxiosHeaderValue;
Authorization: AxiosHeaderValue;
Content-Encoding: AxiosHeaderValue;
Content-Length: AxiosHeaderValue;
User-Agent: AxiosHeaderValue;
} & {
Content-Type: ContentType;
}>): Promise<OrganizationInvitationProps>;
};
organizationMembership: {
delete(params: OptionalDefaults<GetOrganizationMembershipParams>): Promise<any>;
get(params: OptionalDefaults<GetOrganizationMembershipParams>): Promise<OrganizationMembershipProps>;
getMany(params: OptionalDefaults<GetOrganizationParams & QueryParams>): Promise<CollectionProp<OrganizationMembershipProps>>;
update(params: OptionalDefaults<GetOrganizationMembershipParams>, rawData: OrganizationMembershipProps, headers?: Partial<RawAxiosHeaders & {
Accept: AxiosHeaderValue;
Authorization: AxiosHeaderValue;
Content-Encoding: AxiosHeaderValue;
Content-Length: AxiosHeaderValue;
User-Agent: AxiosHeaderValue;
} & {
Content-Type: ContentType;
}>): Promise<OrganizationMembershipProps>;
};
personalAccessToken: {
create(rawData: CreatePersonalAccessTokenProps, headers?: Partial<RawAxiosHeaders & {
Accept: AxiosHeaderValue;
Authorization: AxiosHeaderValue;
Content-Encoding: AxiosHeaderValue;
Content-Length: AxiosHeaderValue;
User-Agent: AxiosHeaderValue;
} & {
Content-Type: ContentType;
}>): Promise<PersonalAccessTokenProps>;
get(params: OptionalDefaults<{
tokenId: string;
}>): Promise<PersonalAccessTokenProps>;
getMany(params: OptionalDefaults<QueryParams>): Promise<CollectionProp<PersonalAccessTokenProps>>;
revoke(params: OptionalDefaults<{
tokenId: string;
}>): Promise<PersonalAccessTokenProps>;
};
previewApiKey: {
get(params: OptionalDefaults<GetSpaceParams & {
previewApiKeyId: string;
}>): Promise<PreviewApiKeyProps>;
getMany(params: OptionalDefaults<GetSpaceParams & QueryParams>): Promise<CollectionProp<PreviewApiKeyProps>>;
};
raw: {
delete<T>(url: string, config?: RawAxiosRequestConfig): Promise<T>;
get<T>(url: string, config?: RawAxiosRequestConfig): Promise<T>;
getDefaultParams(): undefined | DefaultParams;
http<T>(url: string, config?: RawAxiosRequestConfig): Promise<T>;
patch<T>(url: string, payload?: any, config?: RawAxiosRequestConfig): Promise<T>;
post<T>(url: string, payload?: any, config?: RawAxiosRequestConfig): Promise<T>;
put<T>(url: string, payload?: any, config?: RawAxiosRequestConfig): Promise<T>;
};
release: {
archive(params: OptionalDefaults<GetSpaceEnvironmentParams & {
releaseId: string;
} & {
version: number;
}>): Promise<ReleaseProps>;
create(params: OptionalDefaults<GetSpaceEnvironmentParams>, data: ReleasePayload): Promise<ReleaseProps>;
delete(params: OptionalDefaults<GetReleaseParams>): Promise<void>;
get(params: OptionalDefaults<GetReleaseParams>): Promise<ReleaseProps>;
publish(params: OptionalDefaults<GetSpaceEnvironmentParams & {
releaseId: string;
} & {
version: number;
}>): Promise<ReleaseActionProps<"publish">>;
query(params: Omit<GetSpaceEnvironmentParams, keyof DefaultParams> & Partial<Pick<GetSpaceEnvironmentParams, keyof GetSpaceEnvironmentParams>> & {
query?: ReleaseQueryOptions;
}): Promise<CursorPaginatedCollectionProp<ReleaseProps>>;
unarchive(params: OptionalDefaults<GetSpaceEnvironmentParams & {
releaseId: string;
} & {
version: number;
}>): Promise<ReleaseProps>;
unpublish(params: OptionalDefaults<GetSpaceEnvironmentParams & {
releaseId: string;
} & {
version: number;
}>): Promise<ReleaseActionProps<"unpublish">>;
update(params: OptionalDefaults<GetSpaceEnvironmentParams & {
releaseId: string;
} & {
version: number;
}>, data: ReleasePayload): Promise<ReleaseProps>;
validate(params: OptionalDefaults<GetReleaseParams>, data?: ReleaseValidatePayload): Promise<ReleaseActionProps<"validate">>;
};
releaseAction: {
get(params: Omit<GetReleaseParams, keyof DefaultParams> & Partial<Pick<GetReleaseParams, keyof GetSpaceEnvironmentParams>> & {
actionId: string;
}): Promise<ReleaseActionProps<any>>;
getMany(params: Omit<GetSpaceEnvironmentParams, keyof DefaultParams> & Partial<Pick<GetSpaceEnvironmentParams, keyof GetSpaceEnvironmentParams>> & {
query?: ReleaseActionQueryOptions;
}): Promise<CollectionProp<ReleaseActionProps<any>>>;
queryForRelease(params: Omit<GetReleaseParams, keyof DefaultParams> & Partial<Pick<GetReleaseParams, keyof GetSpaceEnvironmentParams>> & {
query?: ReleaseActionQueryOptions;
}): Promise<CollectionProp<ReleaseActionProps<any>>>;
};
resource: ResourcePlainAPI;
resourceProvider: ResourceProviderPlainClientAPI;
resourceType: ResourceTypePlainClientAPI;
role: RolePlainClientAPI;
scheduledActions: {
create(params: OptionalDefaults<GetSpaceParams>, data: CreateUpdateScheduledActionProps): Promise<ScheduledActionProps>;
delete(params: OptionalDefaults<GetSpaceEnvironmentParams & {
scheduledActionId: string;
}>): Promise<ScheduledActionProps>;
get(params: Omit<GetSpaceParams, keyof DefaultParams> & Partial<Pick<GetSpaceParams, "spaceId">> & {
environmentId: string;
scheduledActionId: string;
}): Promise<ScheduledActionProps>;
getMany(params: OptionalDefaults<GetSpaceParams & QueryParams>): Promise<CursorPaginatedCollectionProp<ScheduledActionProps>>;
update(params: OptionalDefaults<GetSpaceParams & {
scheduledActionId: string;
version: number;
}>, data: CreateUpdateScheduledActionProps): Promise<ScheduledActionProps>;
};
snapshot: {
getForContentType(params: OptionalDefaults<GetSpaceEnvironmentParams & {
contentTypeId: string;
} & {
snapshotId: string;
}>): Promise<SnapshotProps<ContentTypeProps>>;
getForEntry<T>(params: OptionalDefaults<GetSpaceEnvironmentParams & {
entryId: string;
} & {
snapshotId: string;
}>): Promise<SnapshotProps<Omit<EntryProps<T>, "metadata">>>;
getManyForContentType(params: OptionalDefaults<GetSpaceEnvironmentParams & {
contentTypeId: string;
} & QueryParams>): Promise<CollectionProp<SnapshotProps<ContentTypeProps>>>;
getManyForEntry<T>(params: OptionalDefaults<GetSpaceEnvironmentParams & {
entryId: string;
} & QueryParams>): Promise<CollectionProp<SnapshotProps<Omit<EntryProps<T>, "metadata">>>>;
};
space: SpacePlainClientAPI;
spaceMember: SpaceMemberPlainClientAPI;
spaceMembership: SpaceMembershipPlainClientAPI;
tag: TagPlainClientAPI;
task: TaskPlainClientAPI;
team: TeamPlainClientAPI;
teamMembership: TeamMembershipPlainClientAPI;
teamSpaceMembership: TeamSpaceMembershipPlainClientAPI;
uiConfig: UIConfigPlainClientAPI;
upload: UploadPlainClientAPI;
uploadCredential: UploadCredentialAPI;
usage: UsagePlainClientAPI;
user: UserPlainClientAPI;
userUIConfig: UserUIConfigPlainClientAPI;
webhook: WebhookPlainClientAPI;
workflow: WorkflowPlainClientAPI;
workflowDefinition: WorkflowDefinitionPlainClientAPI;
workflowsChangelog: WorkflowsChangelogPlainClientAPI;
}
Type Alias PlainClientAPI
Plain
accessToken: {
createPersonalAccessToken(rawData: CreatePATProps, headers?: Partial<RawAxiosHeaders & {
Accept: AxiosHeaderValue;
Authorization: AxiosHeaderValue;
Content-Encoding: AxiosHeaderValue;
Content-Length: AxiosHeaderValue;
User-Agent: AxiosHeaderValue;
} & {
Content-Type: ContentType;
}>): Promise<AccessTokenProp>;
get(params: OptionalDefaults<{
tokenId: string;
}>): Promise<AccessTokenProp>;
getMany(params: OptionalDefaults<QueryParams>): Promise<CollectionProp<AccessTokenProp>>;
getManyForOrganization(params: OptionalDefaults<GetOrganizationParams & QueryParams>): Promise<CollectionProp<AccessTokenProp>>;
revoke(params: OptionalDefaults<{
tokenId: string;
}>): Promise<AccessTokenProp>;
};
apiKey: {
create(params: OptionalDefaults<GetSpaceParams>, data: CreateApiKeyProps, headers?: Partial<RawAxiosHeaders & {
Accept: AxiosHeaderValue;
Authorization: AxiosHeaderValue;
Content-Encoding: AxiosHeaderValue;
Content-Length: AxiosHeaderValue;
User-Agent: AxiosHeaderValue;
} & {
Content-Type: ContentType;
}>): Promise<ApiKeyProps>;
createWithId(params: OptionalDefaults<GetSpaceParams & {
apiKeyId: string;
}>, data: CreateApiKeyProps, headers?: Partial<RawAxiosHeaders & {
Accept: AxiosHeaderValue;
Authorization: AxiosHeaderValue;
Content-Encoding: AxiosHeaderValue;
Content-Length: AxiosHeaderValue;
User-Agent: AxiosHeaderValue;
} & {
Content-Type: ContentType;
}>): Promise<ApiKeyProps>;
delete(params: OptionalDefaults<GetSpaceParams & {
apiKeyId: string;
}>): Promise<any>;
get(params: OptionalDefaults<GetSpaceParams & {
apiKeyId: string;
}>): Promise<ApiKeyProps>;
getMany(params: OptionalDefaults<GetSpaceParams & QueryParams>): Promise<CollectionProp<ApiKeyProps>>;
update(params: OptionalDefaults<GetSpaceParams & {
apiKeyId: string;
}>, rawData: ApiKeyProps, headers?: Partial<RawAxiosHeaders & {
Accept: AxiosHeaderValue;
Authorization: AxiosHeaderValue;
Content-Encoding: AxiosHeaderValue;
Content-Length: AxiosHeaderValue;
User-Agent: AxiosHeaderValue;
} & {
Content-Type: ContentType;
}>): Promise<ApiKeyProps>;
};
appAccessToken: AppAccessTokenPlainClientAPI;
appAction: AppActionPlainClientAPI;
appActionCall: AppActionCallPlainClientAPI;
appBundle: AppBundlePlainClientAPI;
appDefinition: AppDefinitionPlainClientAPI;
appDetails: AppDetailsPlainClientAPI;
appEventSubscription: AppEventSubscriptionPlainClientAPI;
appInstallation: AppInstallationPlainClientAPI;
appKey: AppKeyPlainClientAPI;
appSignedRequest: AppSignedRequestPlainClientAPI;
appSigningSecret: AppSigningSecretPlainClientAPI;
appUpload: AppUploadPlainClientAPI;
asset: {
archive(params: OptionalDefaults<GetSpaceEnvironmentParams & {
assetId: string;
}>): Promise<AssetProps>;
create(params: OptionalDefaults<GetSpaceEnvironmentParams>, rawData: CreateAssetProps): Promise<AssetProps>;
createFromFiles(params: OptionalDefaults<GetSpaceEnvironmentParams>, data: Omit<AssetFileProp, "sys">): Promise<AssetProps>;
createWithId(params: OptionalDefaults<GetSpaceEnvironmentParams & {
assetId: string;
}>, rawData: CreateAssetProps): Promise<AssetProps>;
delete(params: OptionalDefaults<GetSpaceEnvironmentParams & {
assetId: string;
}>): Promise<any>;
get(params: OptionalDefaults<GetSpaceEnvironmentParams & {
assetId: string;
} & QueryParams>, rawData?: unknown, headers?: Partial<RawAxiosHeaders & {
Accept: AxiosHeaderValue;
Authorization: AxiosHeaderValue;
Content-Encoding: AxiosHeaderValue;
Content-Length: AxiosHeaderValue;
User-Agent: AxiosHeaderValue;
} & {
Content-Type: ContentType;
}>): Promise<AssetProps>;
getMany(params: OptionalDefaults<GetSpaceEnvironmentParams & QueryParams>, rawData?: unknown, headers?: Partial<RawAxiosHeaders & {
Accept: AxiosHeaderValue;
Authorization: AxiosHeaderValue;
Content-Encoding: AxiosHeaderValue;
Content-Length: AxiosHeaderValue;
User-Agent: AxiosHeaderValue;
} & {
Content-Type: ContentType;
}>): Promise<CollectionProp<AssetProps>>;
getPublished(params: OptionalDefaults<GetSpaceEnvironmentParams & QueryParams>, rawData?: unknown, headers?: Partial<RawAxiosHeaders & {
Accept: AxiosHeaderValue;
Authorization: AxiosHeaderValue;
Content-Encoding: AxiosHeaderValue;
Content-Length: AxiosHeaderValue;
User-Agent: AxiosHeaderValue;
} & {
Content-Type: ContentType;
}>): Promise<CollectionProp<AssetProps>>;
processForAllLocales(params: OptionalDefaults<GetSpaceEnvironmentParams>, asset: AssetProps, processingOptions?: AssetProcessingForLocale): Promise<AssetProps>;
processForLocale(params: OptionalDefaults<GetSpaceEnvironmentParams>, asset: AssetProps, locale: string, processingOptions?: AssetProcessingForLocale): Promise<AssetProps>;
publish(params: OptionalDefaults<GetSpaceEnvironmentParams & {
assetId: string;
}>, rawData: AssetProps): Promise<AssetProps>;
unarchive(params: OptionalDefaults<GetSpaceEnvironmentParams & {
assetId: string;
}>): Promise<AssetProps>;
unpublish(params: OptionalDefaults<GetSpaceEnvironmentParams & {
assetId: string;
}>): Promise<AssetProps>;
update(params: OptionalDefaults<GetSpaceEnvironmentParams & {
assetId: string;
}>, rawData: AssetProps, headers?: Partial<RawAxiosHeaders & {
Accept: AxiosHeaderValue;
Authorization: AxiosHeaderValue;
Content-Encoding: AxiosHeaderValue;
Content-Length: AxiosHeaderValue;
User-Agent: AxiosHeaderValue;
} & {
Content-Type: ContentType;
}>): Promise<AssetProps>;
};
assetKey: {
create(params: OptionalDefaults<GetSpaceEnvironmentParams>, data: CreateAssetKeyProps): Promise<AssetKeyProps>;
};
bulkAction: {
get<T>(params: GetBulkActionParams): Promise<BulkActionProps<T>>;
publish(params: GetSpaceEnvironmentParams, payload: BulkActionPublishPayload): Promise<BulkActionProps<BulkActionPublishPayload>>;
unpublish(params: GetSpaceEnvironmentParams, payload: BulkActionUnpublishPayload): Promise<BulkActionProps<BulkActionUnpublishPayload>>;
validate(params: GetSpaceEnvironmentParams, payload: BulkActionValidatePayload): Promise<BulkActionProps<BulkActionValidatePayload>>;
};
comment: CommentPlainClientAPI;
concept: ConceptPlainClientAPI;
conceptScheme: ConceptSchemePlainClientAPI;
contentType: {
create(params: OptionalDefaults<GetSpaceEnvironmentParams>, rawData: {
description?: string;
displayField?: string;
fields: ContentFields[];
metadata?: ContentTypeMetadata;
name: string;
}): Promise<ContentTypeProps>;
createWithId(params: OptionalDefaults<GetSpaceEnvironmentParams & {
contentTypeId: string;
}>, rawData: {
description?: string;
displayField?: string;
fields: ContentFields[];
metadata?: ContentTypeMetadata;
name: string;
}): Promise<ContentTypeProps>;
delete(params: OptionalDefaults<GetContentTypeParams>): Promise<any>;
get(params: OptionalDefaults<GetSpaceEnvironmentParams & {
contentTypeId: string;
} & QueryParams>): Promise<ContentTypeProps>;
getMany(params: OptionalDefaults<GetSpaceEnvironmentParams & QueryParams>): Promise<CollectionProp<ContentTypeProps>>;
omitAndDeleteField(params: OptionalDefaults<GetContentTypeParams>, contentType: ContentTypeProps, fieldId: string): Promise<ContentTypeProps>;
publish(params: OptionalDefaults<GetContentTypeParams>, rawData: ContentTypeProps): Promise<ContentTypeProps>;
unpublish(params: OptionalDefaults<GetContentTypeParams>): Promise<ContentTypeProps>;
update(params: OptionalDefaults<GetContentTypeParams>, rawData: ContentTypeProps, headers?: Partial<RawAxiosHeaders & {
Accept: AxiosHeaderValue;
Authorization: AxiosHeaderValue;
Content-Encoding: AxiosHeaderValue;
Content-Length: AxiosHeaderValue;
User-Agent: AxiosHeaderValue;
} & {
Content-Type: ContentType;
}>): Promise<ContentTypeProps>;
};
editorInterface: EditorInterfacePlainClientAPI;
entry: {
archive<T>(params: OptionalDefaults<GetSpaceEnvironmentParams & {
entryId: string;
}>): Promise<EntryProps<T>>;
create<T>(params: OptionalDefaults<GetSpaceEnvironmentParams & {
contentTypeId: string;
}>, rawData: CreateEntryProps<T>): Promise<EntryProps<T>>;
createWithId<T>(params: OptionalDefaults<GetSpaceEnvironmentParams & {
contentTypeId: string;
entryId: string;
}>, rawData: CreateEntryProps<T>): Promise<EntryProps<T>>;
delete(params: OptionalDefaults<GetSpaceEnvironmentParams & {
entryId: string;
}>): Promise<any>;
get<T>(params: OptionalDefaults<GetSpaceEnvironmentParams & {
entryId: string;
}>, rawData?: unknown, headers?: Partial<RawAxiosHeaders & {
Accept: AxiosHeaderValue;
Authorization: AxiosHeaderValue;
Content-Encoding: AxiosHeaderValue;
Content-Length: AxiosHeaderValue;
User-Agent: AxiosHeaderValue;
} & {
Content-Type: ContentType;
}>): Promise<EntryProps<T>>;
getMany<T>(params: OptionalDefaults<GetSpaceEnvironmentParams & QueryParams>, rawData?: unknown, headers?: Partial<RawAxiosHeaders & {
Accept: AxiosHeaderValue;
Authorization: AxiosHeaderValue;
Content-Encoding: AxiosHeaderValue;
Content-Length: AxiosHeaderValue;
User-Agent: AxiosHeaderValue;
} & {
Content-Type: ContentType;
}>): Promise<CollectionProp<EntryProps<T>>>;
getPublished<T>(params: OptionalDefaults<GetSpaceEnvironmentParams & QueryParams>, rawData?: unknown, headers?: Partial<RawAxiosHeaders & {
Accept: AxiosHeaderValue;
Authorization: AxiosHeaderValue;
Content-Encoding: AxiosHeaderValue;
Content-Length: AxiosHeaderValue;
User-Agent: AxiosHeaderValue;
} & {
Content-Type: ContentType;
}>): Promise<CollectionProp<EntryProps<T>>>;
patch<T>(params: OptionalDefaults<GetSpaceEnvironmentParams & {
entryId: string;
}>, rawData: OpPatch[], headers?: Partial<RawAxiosHeaders & {
Accept: AxiosHeaderValue;
Authorization: AxiosHeaderValue;
Content-Encoding: AxiosHeaderValue;
Content-Length: AxiosHeaderValue;
User-Agent: AxiosHeaderValue;
} & {
Content-Type: ContentType;
}>): Promise<EntryProps<T>>;
publish<T>(params: OptionalDefaults<GetSpaceEnvironmentParams & {
entryId: string;
}>, rawData: EntryProps<T>): Promise<EntryProps<T>>;
references(params: OptionalDefaults<GetSpaceEnvironmentParams & {
entryId: string;
include?: number;
}>): Promise<EntryReferenceProps>;
unarchive<T>(params: OptionalDefaults<GetSpaceEnvironmentParams & {
entryId: string;
}>): Promise<EntryProps<T>>;
unpublish<T>(params: OptionalDefaults<GetSpaceEnvironmentParams & {
entryId: string;
}>): Promise<EntryProps<T>>;
update<T>(params: OptionalDefaults<GetSpaceEnvironmentParams & {
entryId: string;
}>, rawData: EntryProps<T>, headers?: Partial<RawAxiosHeaders & {
Accept: AxiosHeaderValue;
Authorization: AxiosHeaderValue;
Content-Encoding: AxiosHeaderValue;
Content-Length: AxiosHeaderValue;
User-Agent: AxiosHeaderValue;
} & {
Content-Type: ContentType;
}>): Promise<EntryProps<T>>;
};
environment: EnvironmentPlainClientAPI;
environmentAlias: EnvironmentAliasPlainClientAPI;
environmentTemplate: {
create(params: GetOrganizationParams, rawData: CreateEnvironmentTemplateProps, headers?: Partial<RawAxiosHeaders & {
Accept: AxiosHeaderValue;
Authorization: AxiosHeaderValue;
Content-Encoding: AxiosHeaderValue;
Content-Length: AxiosHeaderValue;
User-Agent: AxiosHeaderValue;
} & {
Content-Type: ContentType;
}>): Promise<EnvironmentTemplateProps>;
delete(params: GetEnvironmentTemplateParams, headers?: Partial<RawAxiosHeaders & {
Accept: AxiosHeaderValue;
Authorization: AxiosHeaderValue;
Content-Encoding: AxiosHeaderValue;
Content-Length: AxiosHeaderValue;
User-Agent: AxiosHeaderValue;
} & {
Content-Type: ContentType;
}>): Promise<void>;
disconnect(params: EnvironmentTemplateParams, headers?: Partial<RawAxiosHeaders & {
Accept: AxiosHeaderValue;
Authorization: AxiosHeaderValue;
Content-Encoding: AxiosHeaderValue;
Content-Length: AxiosHeaderValue;
User-Agent: AxiosHeaderValue;
} & {
Content-Type: ContentType;
}>): Promise<void>;
get(params: GetOrganizationParams & {
environmentTemplateId: string;
} & {
query?: {
select?: string;
};
version?: number;
}, headers?: Partial<RawAxiosHeaders & {
Accept: AxiosHeaderValue;
Authorization: AxiosHeaderValue;
Content-Encoding: AxiosHeaderValue;
Content-Length: AxiosHeaderValue;
User-Agent: AxiosHeaderValue;
} & {
Content-Type: ContentType;
}>): Promise<EnvironmentTemplateProps>;
getMany(params: GetOrganizationParams & {
query?: BasicCursorPaginationOptions & {
select?: string;
};
}, headers?: Partial<RawAxiosHeaders & {
Accept: AxiosHeaderValue;
Authorization: AxiosHeaderValue;
Content-Encoding: AxiosHeaderValue;
Content-Length: AxiosHeaderValue;
User-Agent: AxiosHeaderValue;
} & {
Content-Type: ContentType;
}>): Promise<CursorPaginatedCollectionProp<EnvironmentTemplateProps>>;
install(params: EnvironmentTemplateParams, rawData: CreateEnvironmentTemplateInstallationProps, headers?: Partial<RawAxiosHeaders & {
Accept: AxiosHeaderValue;
Authorization: AxiosHeaderValue;
Content-Encoding: AxiosHeaderValue;
Content-Length: AxiosHeaderValue;
User-Agent: AxiosHeaderValue;
} & {
Content-Type: ContentType;
}>): Promise<EnvironmentTemplateInstallationProps>;
update(params: GetEnvironmentTemplateParams, rawData: EnvironmentTemplateProps, headers?: Partial<RawAxiosHeaders & {
Accept: AxiosHeaderValue;
Authorization: AxiosHeaderValue;
Content-Encoding: AxiosHeaderValue;
Content-Length: AxiosHeaderValue;
User-Agent: AxiosHeaderValue;
} & {
Content-Type: ContentType;
}>): Promise<EnvironmentTemplateProps>;
validate(params: EnvironmentTemplateParams & {
version?: number;
}, rawData: ValidateEnvironmentTemplateInstallationProps, headers?: Partial<RawAxiosHeaders & {
Accept: AxiosHeaderValue;
Authorization: AxiosHeaderValue;
Content-Encoding: AxiosHeaderValue;
Content-Length: AxiosHeaderValue;
User-Agent: AxiosHeaderValue;
} & {
Content-Type: ContentType;
}>): Promise<EnvironmentTemplateValidationProps>;
versions(params: GetOrganizationParams & {
environmentTemplateId: string;
} & {
query?: BasicCursorPaginationOptions & {
select?: string;
};
}, headers?: Partial<RawAxiosHeaders & {
Accept: AxiosHeaderValue;
Authorization: AxiosHeaderValue;
Content-Encoding: AxiosHeaderValue;
Content-Length: AxiosHeaderValue;
User-Agent: AxiosHeaderValue;
} & {
Content-Type: ContentType;
}>): Promise<CursorPaginatedCollectionProp<EnvironmentTemplateProps>>;
versionUpdate(params: GetOrganizationParams & {
environmentTemplateId: string;
} & {
version: number;
}, rawData: {
versionDescription?: string;
versionName?: string;
}, headers?: Partial<RawAxiosHeaders & {
Accept: AxiosHeaderValue;
Authorization: AxiosHeaderValue;
Content-Encoding: AxiosHeaderValue;
Content-Length: AxiosHeaderValue;
User-Agent: AxiosHeaderValue;
} & {
Content-Type: ContentType;
}>): Promise<EnvironmentTemplateProps>;
};
environmentTemplateInstallation: {
getForEnvironment(params: BasicCursorPaginationOptions & EnvironmentTemplateParams & {
installationId?: string;
}, headers?: Partial<RawAxiosHeaders & {
Accept: AxiosHeaderValue;
Authorization: AxiosHeaderValue;
Content-Encoding: AxiosHeaderValue;
Content-Length: AxiosHeaderValue;
User-Agent: AxiosHeaderValue;
} & {
Content-Type: ContentType;
}>): Promise<CursorPaginatedCollectionProp<EnvironmentTemplateInstallationProps>>;
getMany(params: BasicCursorPaginationOptions & {
environmentId?: string;
environmentTemplateId: string;
organizationId: string;
spaceId?: string;
}, headers?: Partial<RawAxiosHeaders & {
Accept: AxiosHeaderValue;
Authorization: AxiosHeaderValue;
Content-Encoding: AxiosHeaderValue;
Content-Length: AxiosHeaderValue;
User-Agent: AxiosHeaderValue;
} & {
Content-Type: ContentType;
}>): Promise<CursorPaginatedCollectionProp<EnvironmentTemplateInstallationProps>>;
};
extension: ExtensionPlainClientAPI;
function: {
getMany(params: OptionalDefaults<GetOrganizationParams & {
appDefinitionId: string;
} & QueryParams>): Promise<CollectionProp<FunctionProps>>;
};
locale: LocalePlainClientAPI;
organization: OrganizationPlainClientAPI;
organizationInvitation: {
create(params: OptionalDefaults<{
organizationId: string;
}>, data: CreateOrganizationInvitationProps, headers?: Partial<RawAxiosHeaders & {
Accept: AxiosHeaderValue;
Authorization: AxiosHeaderValue;
Content-Encoding: AxiosHeaderValue;
Content-Length: AxiosHeaderValue;
User-Agent: AxiosHeaderValue;
} & {
Content-Type: ContentType;
}>): Promise<OrganizationInvitationProps>;
get(params: OptionalDefaults<{
invitationId: string;
organizationId: string;
}>, headers?: Partial<RawAxiosHeaders & {
Accept: AxiosHeaderValue;
Authorization: AxiosHeaderValue;
Content-Encoding: AxiosHeaderValue;
Content-Length: AxiosHeaderValue;
User-Agent: AxiosHeaderValue;
} & {
Content-Type: ContentType;
}>): Promise<OrganizationInvitationProps>;
};
organizationMembership: {
delete(params: OptionalDefaults<GetOrganizationMembershipParams>): Promise<any>;
get(params: OptionalDefaults<GetOrganizationMembershipParams>): Promise<OrganizationMembershipProps>;
getMany(params: OptionalDefaults<GetOrganizationParams & QueryParams>): Promise<CollectionProp<OrganizationMembershipProps>>;
update(params: OptionalDefaults<GetOrganizationMembershipParams>, rawData: OrganizationMembershipProps, headers?: Partial<RawAxiosHeaders & {
Accept: AxiosHeaderValue;
Authorization: AxiosHeaderValue;
Content-Encoding: AxiosHeaderValue;
Content-Length: AxiosHeaderValue;
User-Agent: AxiosHeaderValue;
} & {
Content-Type: ContentType;
}>): Promise<OrganizationMembershipProps>;
};
personalAccessToken: {
create(rawData: CreatePersonalAccessTokenProps, headers?: Partial<RawAxiosHeaders & {
Accept: AxiosHeaderValue;
Authorization: AxiosHeaderValue;
Content-Encoding: AxiosHeaderValue;
Content-Length: AxiosHeaderValue;
User-Agent: AxiosHeaderValue;
} & {
Content-Type: ContentType;
}>): Promise<PersonalAccessTokenProps>;
get(params: OptionalDefaults<{
tokenId: string;
}>): Promise<PersonalAccessTokenProps>;
getMany(params: OptionalDefaults<QueryParams>): Promise<CollectionProp<PersonalAccessTokenProps>>;
revoke(params: OptionalDefaults<{
tokenId: string;
}>): Promise<PersonalAccessTokenProps>;
};
previewApiKey: {
get(params: OptionalDefaults<GetSpaceParams & {
previewApiKeyId: string;
}>): Promise<PreviewApiKeyProps>;
getMany(params: OptionalDefaults<GetSpaceParams & QueryParams>): Promise<CollectionProp<PreviewApiKeyProps>>;
};
raw: {
delete<T>(url: string, config?: RawAxiosRequestConfig): Promise<T>;
get<T>(url: string, config?: RawAxiosRequestConfig): Promise<T>;
getDefaultParams(): undefined | DefaultParams;
http<T>(url: string, config?: RawAxiosRequestConfig): Promise<T>;
patch<T>(url: string, payload?: any, config?: RawAxiosRequestConfig): Promise<T>;
post<T>(url: string, payload?: any, config?: RawAxiosRequestConfig): Promise<T>;
put<T>(url: string, payload?: any, config?: RawAxiosRequestConfig): Promise<T>;
};
release: {
archive(params: OptionalDefaults<GetSpaceEnvironmentParams & {
releaseId: string;
} & {
version: number;
}>): Promise<ReleaseProps>;
create(params: OptionalDefaults<GetSpaceEnvironmentParams>, data: ReleasePayload): Promise<ReleaseProps>;
delete(params: OptionalDefaults<GetReleaseParams>): Promise<void>;
get(params: OptionalDefaults<GetReleaseParams>): Promise<ReleaseProps>;
publish(params: OptionalDefaults<GetSpaceEnvironmentParams & {
releaseId: string;
} & {
version: number;
}>): Promise<ReleaseActionProps<"publish">>;
query(params: Omit<GetSpaceEnvironmentParams, keyof DefaultParams> & Partial<Pick<GetSpaceEnvironmentParams, keyof GetSpaceEnvironmentParams>> & {
query?: ReleaseQueryOptions;
}): Promise<CursorPaginatedCollectionProp<ReleaseProps>>;
unarchive(params: OptionalDefaults<GetSpaceEnvironmentParams & {
releaseId: string;
} & {
version: number;
}>): Promise<ReleaseProps>;
unpublish(params: OptionalDefaults<GetSpaceEnvironmentParams & {
releaseId: string;
} & {
version: number;
}>): Promise<ReleaseActionProps<"unpublish">>;
update(params: OptionalDefaults<GetSpaceEnvironmentParams & {
releaseId: string;
} & {
version: number;
}>, data: ReleasePayload): Promise<ReleaseProps>;
validate(params: OptionalDefaults<GetReleaseParams>, data?: ReleaseValidatePayload): Promise<ReleaseActionProps<"validate">>;
};
releaseAction: {
get(params: Omit<GetReleaseParams, keyof DefaultParams> & Partial<Pick<GetReleaseParams, keyof GetSpaceEnvironmentParams>> & {
actionId: string;
}): Promise<ReleaseActionProps<any>>;
getMany(params: Omit<GetSpaceEnvironmentParams, keyof DefaultParams> & Partial<Pick<GetSpaceEnvironmentParams, keyof GetSpaceEnvironmentParams>> & {
query?: ReleaseActionQueryOptions;
}): Promise<CollectionProp<ReleaseActionProps<any>>>;
queryForRelease(params: Omit<GetReleaseParams, keyof DefaultParams> & Partial<Pick<GetReleaseParams, keyof GetSpaceEnvironmentParams>> & {
query?: ReleaseActionQueryOptions;
}): Promise<CollectionProp<ReleaseActionProps<any>>>;
};
resource: ResourcePlainAPI;
resourceProvider: ResourceProviderPlainClientAPI;
resourceType: ResourceTypePlainClientAPI;
role: RolePlainClientAPI;
scheduledActions: {
create(params: OptionalDefaults<GetSpaceParams>, data: CreateUpdateScheduledActionProps): Promise<ScheduledActionProps>;
delete(params: OptionalDefaults<GetSpaceEnvironmentParams & {
scheduledActionId: string;
}>): Promise<ScheduledActionProps>;
get(params: Omit<GetSpaceParams, keyof DefaultParams> & Partial<Pick<GetSpaceParams, "spaceId">> & {
environmentId: string;
scheduledActionId: string;
}): Promise<ScheduledActionProps>;
getMany(params: OptionalDefaults<GetSpaceParams & QueryParams>): Promise<CursorPaginatedCollectionProp<ScheduledActionProps>>;
update(params: OptionalDefaults<GetSpaceParams & {
scheduledActionId: string;
version: number;
}>, data: CreateUpdateScheduledActionProps): Promise<ScheduledActionProps>;
};
snapshot: {
getForContentType(params: OptionalDefaults<GetSpaceEnvironmentParams & {
contentTypeId: string;
} & {
snapshotId: string;
}>): Promise<SnapshotProps<ContentTypeProps>>;
getForEntry<T>(params: OptionalDefaults<GetSpaceEnvironmentParams & {
entryId: string;
} & {
snapshotId: string;
}>): Promise<SnapshotProps<Omit<EntryProps<T>, "metadata">>>;
getManyForContentType(params: OptionalDefaults<GetSpaceEnvironmentParams & {
contentTypeId: string;
} & QueryParams>): Promise<CollectionProp<SnapshotProps<ContentTypeProps>>>;
getManyForEntry<T>(params: OptionalDefaults<GetSpaceEnvironmentParams & {
entryId: string;
} & QueryParams>): Promise<CollectionProp<SnapshotProps<Omit<EntryProps<T>, "metadata">>>>;
};
space: SpacePlainClientAPI;
spaceMember: SpaceMemberPlainClientAPI;
spaceMembership: SpaceMembershipPlainClientAPI;
tag: TagPlainClientAPI;
task: TaskPlainClientAPI;
team: TeamPlainClientAPI;
teamMembership: TeamMembershipPlainClientAPI;
teamSpaceMembership: TeamSpaceMembershipPlainClientAPI;
uiConfig: UIConfigPlainClientAPI;
upload: UploadPlainClientAPI;
uploadCredential: UploadCredentialAPI;
usage: UsagePlainClientAPI;
user: UserPlainClientAPI;
userUIConfig: UserUIConfigPlainClientAPI;
webhook: WebhookPlainClientAPI;
workflow: WorkflowPlainClientAPI;
workflowDefinition: WorkflowDefinitionPlainClientAPI;
workflowsChangelog: WorkflowsChangelogPlainClientAPI;
}
accessToken: {
createPersonalAccessToken(rawData: CreatePATProps, headers?: Partial<RawAxiosHeaders & {
Accept: AxiosHeaderValue;
Authorization: AxiosHeaderValue;
Content-Encoding: AxiosHeaderValue;
Content-Length: AxiosHeaderValue;
User-Agent: AxiosHeaderValue;
} & {
Content-Type: ContentType;
}>): Promise<AccessTokenProp>;
get(params: OptionalDefaults<{
tokenId: string;
}>): Promise<AccessTokenProp>;
getMany(params: OptionalDefaults<QueryParams>): Promise<CollectionProp<AccessTokenProp>>;
getManyForOrganization(params: OptionalDefaults<GetOrganizationParams & QueryParams>): Promise<CollectionProp<AccessTokenProp>>;
revoke(params: OptionalDefaults<{
tokenId: string;
}>): Promise<AccessTokenProp>;
};
apiKey: {
create(params: OptionalDefaults<GetSpaceParams>, data: CreateApiKeyProps, headers?: Partial<RawAxiosHeaders & {
Accept: AxiosHeaderValue;
Authorization: AxiosHeaderValue;
Content-Encoding: AxiosHeaderValue;
Content-Length: AxiosHeaderValue;
User-Agent: AxiosHeaderValue;
} & {
Content-Type: ContentType;
}>): Promise<ApiKeyProps>;
createWithId(params: OptionalDefaults<GetSpaceParams & {
apiKeyId: string;
}>, data: CreateApiKeyProps, headers?: Partial<RawAxiosHeaders & {
Accept: AxiosHeaderValue;
Authorization: AxiosHeaderValue;
Content-Encoding: AxiosHeaderValue;
Content-Length: AxiosHeaderValue;
User-Agent: AxiosHeaderValue;
} & {
Content-Type: ContentType;
}>): Promise<ApiKeyProps>;
delete(params: OptionalDefaults<GetSpaceParams & {
apiKeyId: string;
}>): Promise<any>;
get(params: OptionalDefaults<GetSpaceParams & {
apiKeyId: string;
}>): Promise<ApiKeyProps>;
getMany(params: OptionalDefaults<GetSpaceParams & QueryParams>): Promise<CollectionProp<ApiKeyProps>>;
update(params: OptionalDefaults<GetSpaceParams & {
apiKeyId: string;
}>, rawData: ApiKeyProps, headers?: Partial<RawAxiosHeaders & {
Accept: AxiosHeaderValue;
Authorization: AxiosHeaderValue;
Content-Encoding: AxiosHeaderValue;
Content-Length: AxiosHeaderValue;
User-Agent: AxiosHeaderValue;
} & {
Content-Type: ContentType;
}>): Promise<ApiKeyProps>;
};
appAccessToken: AppAccessTokenPlainClientAPI;
appAction: AppActionPlainClientAPI;
appActionCall: AppActionCallPlainClientAPI;
appBundle: AppBundlePlainClientAPI;
appDefinition: AppDefinitionPlainClientAPI;
appDetails: AppDetailsPlainClientAPI;
appEventSubscription: AppEventSubscriptionPlainClientAPI;
appInstallation: AppInstallationPlainClientAPI;
appKey: AppKeyPlainClientAPI;
appSignedRequest: AppSignedRequestPlainClientAPI;
appSigningSecret: AppSigningSecretPlainClientAPI;
appUpload: AppUploadPlainClientAPI;
asset: {
archive(params: OptionalDefaults<GetSpaceEnvironmentParams & {
assetId: string;
}>): Promise<AssetProps>;
create(params: OptionalDefaults<GetSpaceEnvironmentParams>, rawData: CreateAssetProps): Promise<AssetProps>;
createFromFiles(params: OptionalDefaults<GetSpaceEnvironmentParams>, data: Omit<AssetFileProp, "sys">): Promise<AssetProps>;
createWithId(params: OptionalDefaults<GetSpaceEnvironmentParams & {
assetId: string;
}>, rawData: CreateAssetProps): Promise<AssetProps>;
delete(params: OptionalDefaults<GetSpaceEnvironmentParams & {
assetId: string;
}>): Promise<any>;
get(params: OptionalDefaults<GetSpaceEnvironmentParams & {
assetId: string;
} & QueryParams>, rawData?: unknown, headers?: Partial<RawAxiosHeaders & {
Accept: AxiosHeaderValue;
Authorization: AxiosHeaderValue;
Content-Encoding: AxiosHeaderValue;
Content-Length: AxiosHeaderValue;
User-Agent: AxiosHeaderValue;
} & {
Content-Type: ContentType;
}>): Promise<AssetProps>;
getMany(params: OptionalDefaults<GetSpaceEnvironmentParams & QueryParams>, rawData?: unknown, headers?: Partial<RawAxiosHeaders & {
Accept: AxiosHeaderValue;
Authorization: AxiosHeaderValue;
Content-Encoding: AxiosHeaderValue;
Content-Length: AxiosHeaderValue;
User-Agent: AxiosHeaderValue;
} & {
Content-Type: ContentType;
}>): Promise<CollectionProp<AssetProps>>;
getPublished(params: OptionalDefaults<GetSpaceEnvironmentParams & QueryParams>, rawData?: unknown, headers?: Partial<RawAxiosHeaders & {
Accept: AxiosHeaderValue;
Authorization: AxiosHeaderValue;
Content-Encoding: AxiosHeaderValue;
Content-Length: AxiosHeaderValue;
User-Agent: AxiosHeaderValue;
} & {
Content-Type: ContentType;
}>): Promise<CollectionProp<AssetProps>>;
processForAllLocales(params: OptionalDefaults<GetSpaceEnvironmentParams>, asset: AssetProps, processingOptions?: AssetProcessingForLocale): Promise<AssetProps>;
processForLocale(params: OptionalDefaults<GetSpaceEnvironmentParams>, asset: AssetProps, locale: string, processingOptions?: AssetProcessingForLocale): Promise<AssetProps>;
publish(params: OptionalDefaults<GetSpaceEnvironmentParams & {
assetId: string;
}>, rawData: AssetProps): Promise<AssetProps>;
unarchive(params: OptionalDefaults<GetSpaceEnvironmentParams & {
assetId: string;
}>): Promise<AssetProps>;
unpublish(params: OptionalDefaults<GetSpaceEnvironmentParams & {
assetId: string;
}>): Promise<AssetProps>;
update(params: OptionalDefaults<GetSpaceEnvironmentParams & {
assetId: string;
}>, rawData: AssetProps, headers?: Partial<RawAxiosHeaders & {
Accept: AxiosHeaderValue;
Authorization: AxiosHeaderValue;
Content-Encoding: AxiosHeaderValue;
Content-Length: AxiosHeaderValue;
User-Agent: AxiosHeaderValue;
} & {
Content-Type: ContentType;
}>): Promise<AssetProps>;
};
assetKey: {
create(params: OptionalDefaults<GetSpaceEnvironmentParams>, data: CreateAssetKeyProps): Promise<AssetKeyProps>;
};
bulkAction: {
get<T>(params: GetBulkActionParams): Promise<BulkActionProps<T>>;
publish(params: GetSpaceEnvironmentParams, payload: BulkActionPublishPayload): Promise<BulkActionProps<BulkActionPublishPayload>>;
unpublish(params: GetSpaceEnvironmentParams, payload: BulkActionUnpublishPayload): Promise<BulkActionProps<BulkActionUnpublishPayload>>;
validate(params: GetSpaceEnvironmentParams, payload: BulkActionValidatePayload): Promise<BulkActionProps<BulkActionValidatePayload>>;
};
comment: CommentPlainClientAPI;
concept: ConceptPlainClientAPI;
conceptScheme: ConceptSchemePlainClientAPI;
contentType: {
create(params: OptionalDefaults<GetSpaceEnvironmentParams>, rawData: {
description?: string;
displayField?: string;
fields: ContentFields[];
metadata?: ContentTypeMetadata;
name: string;
}): Promise<ContentTypeProps>;
createWithId(params: OptionalDefaults<GetSpaceEnvironmentParams & {
contentTypeId: string;
}>, rawData: {
description?: string;
displayField?: string;
fields: ContentFields[];
metadata?: ContentTypeMetadata;
name: string;
}): Promise<ContentTypeProps>;
delete(params: OptionalDefaults<GetContentTypeParams>): Promise<any>;
get(params: OptionalDefaults<GetSpaceEnvironmentParams & {
contentTypeId: string;
} & QueryParams>): Promise<ContentTypeProps>;
getMany(params: OptionalDefaults<GetSpaceEnvironmentParams & QueryParams>): Promise<CollectionProp<ContentTypeProps>>;
omitAndDeleteField(params: OptionalDefaults<GetContentTypeParams>, contentType: ContentTypeProps, fieldId: string): Promise<ContentTypeProps>;
publish(params: OptionalDefaults<GetContentTypeParams>, rawData: ContentTypeProps): Promise<ContentTypeProps>;
unpublish(params: OptionalDefaults<GetContentTypeParams>): Promise<ContentTypeProps>;
update(params: OptionalDefaults<GetContentTypeParams>, rawData: ContentTypeProps, headers?: Partial<RawAxiosHeaders & {
Accept: AxiosHeaderValue;
Authorization: AxiosHeaderValue;
Content-Encoding: AxiosHeaderValue;
Content-Length: AxiosHeaderValue;
User-Agent: AxiosHeaderValue;
} & {
Content-Type: ContentType;
}>): Promise<ContentTypeProps>;
};
editorInterface: EditorInterfacePlainClientAPI;
entry: {
archive<T>(params: OptionalDefaults<GetSpaceEnvironmentParams & {
entryId: string;
}>): Promise<EntryProps<T>>;
create<T>(params: OptionalDefaults<GetSpaceEnvironmentParams & {
contentTypeId: string;
}>, rawData: CreateEntryProps<T>): Promise<EntryProps<T>>;
createWithId<T>(params: OptionalDefaults<GetSpaceEnvironmentParams & {
contentTypeId: string;
entryId: string;
}>, rawData: CreateEntryProps<T>): Promise<EntryProps<T>>;
delete(params: OptionalDefaults<GetSpaceEnvironmentParams & {
entryId: string;
}>): Promise<any>;
get<T>(params: OptionalDefaults<GetSpaceEnvironmentParams & {
entryId: string;
}>, rawData?: unknown, headers?: Partial<RawAxiosHeaders & {
Accept: AxiosHeaderValue;
Authorization: AxiosHeaderValue;
Content-Encoding: AxiosHeaderValue;
Content-Length: AxiosHeaderValue;
User-Agent: AxiosHeaderValue;
} & {
Content-Type: ContentType;
}>): Promise<EntryProps<T>>;
getMany<T>(params: OptionalDefaults<GetSpaceEnvironmentParams & QueryParams>, rawData?: unknown, headers?: Partial<RawAxiosHeaders & {
Accept: AxiosHeaderValue;
Authorization: AxiosHeaderValue;
Content-Encoding: AxiosHeaderValue;
Content-Length: AxiosHeaderValue;
User-Agent: AxiosHeaderValue;
} & {
Content-Type: ContentType;
}>): Promise<CollectionProp<EntryProps<T>>>;
getPublished<T>(params: OptionalDefaults<GetSpaceEnvironmentParams & QueryParams>, rawData?: unknown, headers?: Partial<RawAxiosHeaders & {
Accept: AxiosHeaderValue;
Authorization: AxiosHeaderValue;
Content-Encoding: AxiosHeaderValue;
Content-Length: AxiosHeaderValue;
User-Agent: AxiosHeaderValue;
} & {
Content-Type: ContentType;
}>): Promise<CollectionProp<EntryProps<T>>>;
patch<T>(params: OptionalDefaults<GetSpaceEnvironmentParams & {
entryId: string;
}>, rawData: OpPatch[], headers?: Partial<RawAxiosHeaders & {
Accept: AxiosHeaderValue;
Authorization: AxiosHeaderValue;
Content-Encoding: AxiosHeaderValue;
Content-Length: AxiosHeaderValue;
User-Agent: AxiosHeaderValue;
} & {
Content-Type: ContentType;
}>): Promise<EntryProps<T>>;
publish<T>(params: OptionalDefaults<GetSpaceEnvironmentParams & {
entryId: string;
}>, rawData: EntryProps<T>): Promise<EntryProps<T>>;
references(params: OptionalDefaults<GetSpaceEnvironmentParams & {
entryId: string;
include?: number;
}>): Promise<EntryReferenceProps>;
unarchive<T>(params: OptionalDefaults<GetSpaceEnvironmentParams & {
entryId: string;
}>): Promise<EntryProps<T>>;
unpublish<T>(params: OptionalDefaults<GetSpaceEnvironmentParams & {
entryId: string;
}>): Promise<EntryProps<T>>;
update<T>(params: OptionalDefaults<GetSpaceEnvironmentParams & {
entryId: string;
}>, rawData: EntryProps<T>, headers?: Partial<RawAxiosHeaders & {
Accept: AxiosHeaderValue;
Authorization: AxiosHeaderValue;
Content-Encoding: AxiosHeaderValue;
Content-Length: AxiosHeaderValue;
User-Agent: AxiosHeaderValue;
} & {
Content-Type: ContentType;
}>): Promise<EntryProps<T>>;
};
environment: EnvironmentPlainClientAPI;
environmentAlias: EnvironmentAliasPlainClientAPI;
environmentTemplate: {
create(params: GetOrganizationParams, rawData: CreateEnvironmentTemplateProps, headers?: Partial<RawAxiosHeaders & {
Accept: AxiosHeaderValue;
Authorization: AxiosHeaderValue;
Content-Encoding: AxiosHeaderValue;
Content-Length: AxiosHeaderValue;
User-Agent: AxiosHeaderValue;
} & {
Content-Type: ContentType;
}>): Promise<EnvironmentTemplateProps>;
delete(params: GetEnvironmentTemplateParams, headers?: Partial<RawAxiosHeaders & {
Accept: AxiosHeaderValue;
Authorization: AxiosHeaderValue;
Content-Encoding: AxiosHeaderValue;
Content-Length: AxiosHeaderValue;
User-Agent: AxiosHeaderValue;
} & {
Content-Type: ContentType;
}>): Promise<void>;
disconnect(params: EnvironmentTemplateParams, headers?: Partial<RawAxiosHeaders & {
Accept: AxiosHeaderValue;
Authorization: AxiosHeaderValue;
Content-Encoding: AxiosHeaderValue;
Content-Length: AxiosHeaderValue;
User-Agent: AxiosHeaderValue;
} & {
Content-Type: ContentType;
}>): Promise<void>;
get(params: GetOrganizationParams & {
environmentTemplateId: string;
} & {
query?: {
select?: string;
};
version?: number;
}, headers?: Partial<RawAxiosHeaders & {
Accept: AxiosHeaderValue;
Authorization: AxiosHeaderValue;
Content-Encoding: AxiosHeaderValue;
Content-Length: AxiosHeaderValue;
User-Agent: AxiosHeaderValue;
} & {
Content-Type: ContentType;
}>): Promise<EnvironmentTemplateProps>;
getMany(params: GetOrganizationParams & {
query?: BasicCursorPaginationOptions & {
select?: string;
};
}, headers?: Partial<RawAxiosHeaders & {
Accept: AxiosHeaderValue;
Authorization: AxiosHeaderValue;
Content-Encoding: AxiosHeaderValue;
Content-Length: AxiosHeaderValue;
User-Agent: AxiosHeaderValue;
} & {
Content-Type: ContentType;
}>): Promise<CursorPaginatedCollectionProp<EnvironmentTemplateProps>>;
install(params: EnvironmentTemplateParams, rawData: CreateEnvironmentTemplateInstallationProps, headers?: Partial<RawAxiosHeaders & {
Accept: AxiosHeaderValue;
Authorization: AxiosHeaderValue;
Content-Encoding: AxiosHeaderValue;
Content-Length: AxiosHeaderValue;
User-Agent: AxiosHeaderValue;
} & {
Content-Type: ContentType;
}>): Promise<EnvironmentTemplateInstallationProps>;
update(params: GetEnvironmentTemplateParams, rawData: EnvironmentTemplateProps, headers?: Partial<RawAxiosHeaders & {
Accept: AxiosHeaderValue;
Authorization: AxiosHeaderValue;
Content-Encoding: AxiosHeaderValue;
Content-Length: AxiosHeaderValue;
User-Agent: AxiosHeaderValue;
} & {
Content-Type: ContentType;
}>): Promise<EnvironmentTemplateProps>;
validate(params: EnvironmentTemplateParams & {
version?: number;
}, rawData: ValidateEnvironmentTemplateInstallationProps, headers?: Partial<RawAxiosHeaders & {
Accept: AxiosHeaderValue;
Authorization: AxiosHeaderValue;
Content-Encoding: AxiosHeaderValue;
Content-Length: AxiosHeaderValue;
User-Agent: AxiosHeaderValue;
} & {
Content-Type: ContentType;
}>): Promise<EnvironmentTemplateValidationProps>;
versions(params: GetOrganizationParams & {
environmentTemplateId: string;
} & {
query?: BasicCursorPaginationOptions & {
select?: string;
};
}, headers?: Partial<RawAxiosHeaders & {
Accept: AxiosHeaderValue;
Authorization: AxiosHeaderValue;
Content-Encoding: AxiosHeaderValue;
Content-Length: AxiosHeaderValue;
User-Agent: AxiosHeaderValue;
} & {
Content-Type: ContentType;
}>): Promise<CursorPaginatedCollectionProp<EnvironmentTemplateProps>>;
versionUpdate(params: GetOrganizationParams & {
environmentTemplateId: string;
} & {
version: number;
}, rawData: {
versionDescription?: string;
versionName?: string;
}, headers?: Partial<RawAxiosHeaders & {
Accept: AxiosHeaderValue;
Authorization: AxiosHeaderValue;
Content-Encoding: AxiosHeaderValue;
Content-Length: AxiosHeaderValue;
User-Agent: AxiosHeaderValue;
} & {
Content-Type: ContentType;
}>): Promise<EnvironmentTemplateProps>;
};
environmentTemplateInstallation: {
getForEnvironment(params: BasicCursorPaginationOptions & EnvironmentTemplateParams & {
installationId?: string;
}, headers?: Partial<RawAxiosHeaders & {
Accept: AxiosHeaderValue;
Authorization: AxiosHeaderValue;
Content-Encoding: AxiosHeaderValue;
Content-Length: AxiosHeaderValue;
User-Agent: AxiosHeaderValue;
} & {
Content-Type: ContentType;
}>): Promise<CursorPaginatedCollectionProp<EnvironmentTemplateInstallationProps>>;
getMany(params: BasicCursorPaginationOptions & {
environmentId?: string;
environmentTemplateId: string;
organizationId: string;
spaceId?: string;
}, headers?: Partial<RawAxiosHeaders & {
Accept: AxiosHeaderValue;
Authorization: AxiosHeaderValue;
Content-Encoding: AxiosHeaderValue;
Content-Length: AxiosHeaderValue;
User-Agent: AxiosHeaderValue;
} & {
Content-Type: ContentType;
}>): Promise<CursorPaginatedCollectionProp<EnvironmentTemplateInstallationProps>>;
};
extension: ExtensionPlainClientAPI;
function: {
getMany(params: OptionalDefaults<GetOrganizationParams & {
appDefinitionId: string;
} & QueryParams>): Promise<CollectionProp<FunctionProps>>;
};
locale: LocalePlainClientAPI;
organization: OrganizationPlainClientAPI;
organizationInvitation: {
create(params: OptionalDefaults<{
organizationId: string;
}>, data: CreateOrganizationInvitationProps, headers?: Partial<RawAxiosHeaders & {
Accept: AxiosHeaderValue;
Authorization: AxiosHeaderValue;
Content-Encoding: AxiosHeaderValue;
Content-Length: AxiosHeaderValue;
User-Agent: AxiosHeaderValue;
} & {
Content-Type: ContentType;
}>): Promise<OrganizationInvitationProps>;
get(params: OptionalDefaults<{
invitationId: string;
organizationId: string;
}>, headers?: Partial<RawAxiosHeaders & {
Accept: AxiosHeaderValue;
Authorization: AxiosHeaderValue;
Content-Encoding: AxiosHeaderValue;
Content-Length: AxiosHeaderValue;
User-Agent: AxiosHeaderValue;
} & {
Content-Type: ContentType;
}>): Promise<OrganizationInvitationProps>;
};
organizationMembership: {
delete(params: OptionalDefaults<GetOrganizationMembershipParams>): Promise<any>;
get(params: OptionalDefaults<GetOrganizationMembershipParams>): Promise<OrganizationMembershipProps>;
getMany(params: OptionalDefaults<GetOrganizationParams & QueryParams>): Promise<CollectionProp<OrganizationMembershipProps>>;
update(params: OptionalDefaults<GetOrganizationMembershipParams>, rawData: OrganizationMembershipProps, headers?: Partial<RawAxiosHeaders & {
Accept: AxiosHeaderValue;
Authorization: AxiosHeaderValue;
Content-Encoding: AxiosHeaderValue;
Content-Length: AxiosHeaderValue;
User-Agent: AxiosHeaderValue;
} & {
Content-Type: ContentType;
}>): Promise<OrganizationMembershipProps>;
};
personalAccessToken: {
create(rawData: CreatePersonalAccessTokenProps, headers?: Partial<RawAxiosHeaders & {
Accept: AxiosHeaderValue;
Authorization: AxiosHeaderValue;
Content-Encoding: AxiosHeaderValue;
Content-Length: AxiosHeaderValue;
User-Agent: AxiosHeaderValue;
} & {
Content-Type: ContentType;
}>): Promise<PersonalAccessTokenProps>;
get(params: OptionalDefaults<{
tokenId: string;
}>): Promise<PersonalAccessTokenProps>;
getMany(params: OptionalDefaults<QueryParams>): Promise<CollectionProp<PersonalAccessTokenProps>>;
revoke(params: OptionalDefaults<{
tokenId: string;
}>): Promise<PersonalAccessTokenProps>;
};
previewApiKey: {
get(params: OptionalDefaults<GetSpaceParams & {
previewApiKeyId: string;
}>): Promise<PreviewApiKeyProps>;
getMany(params: OptionalDefaults<GetSpaceParams & QueryParams>): Promise<CollectionProp<PreviewApiKeyProps>>;
};
raw: {
delete<T>(url: string, config?: RawAxiosRequestConfig): Promise<T>;
get<T>(url: string, config?: RawAxiosRequestConfig): Promise<T>;
getDefaultParams(): undefined | DefaultParams;
http<T>(url: string, config?: RawAxiosRequestConfig): Promise<T>;
patch<T>(url: string, payload?: any, config?: RawAxiosRequestConfig): Promise<T>;
post<T>(url: string, payload?: any, config?: RawAxiosRequestConfig): Promise<T>;
put<T>(url: string, payload?: any, config?: RawAxiosRequestConfig): Promise<T>;
};
release: {
archive(params: OptionalDefaults<GetSpaceEnvironmentParams & {
releaseId: string;
} & {
version: number;
}>): Promise<ReleaseProps>;
create(params: OptionalDefaults<GetSpaceEnvironmentParams>, data: ReleasePayload): Promise<ReleaseProps>;
delete(params: OptionalDefaults<GetReleaseParams>): Promise<void>;
get(params: OptionalDefaults<GetReleaseParams>): Promise<ReleaseProps>;
publish(params: OptionalDefaults<GetSpaceEnvironmentParams & {
releaseId: string;
} & {
version: number;
}>): Promise<ReleaseActionProps<"publish">>;
query(params: Omit<GetSpaceEnvironmentParams, keyof DefaultParams> & Partial<Pick<GetSpaceEnvironmentParams, keyof GetSpaceEnvironmentParams>> & {
query?: ReleaseQueryOptions;
}): Promise<CursorPaginatedCollectionProp<ReleaseProps>>;
unarchive(params: OptionalDefaults<GetSpaceEnvironmentParams & {
releaseId: string;
} & {
version: number;
}>): Promise<ReleaseProps>;
unpublish(params: OptionalDefaults<GetSpaceEnvironmentParams & {
releaseId: string;
} & {
version: number;
}>): Promise<ReleaseActionProps<"unpublish">>;
update(params: OptionalDefaults<GetSpaceEnvironmentParams & {
releaseId: string;
} & {
version: number;
}>, data: ReleasePayload): Promise<ReleaseProps>;
validate(params: OptionalDefaults<GetReleaseParams>, data?: ReleaseValidatePayload): Promise<ReleaseActionProps<"validate">>;
};
releaseAction: {
get(params: Omit<GetReleaseParams, keyof DefaultParams> & Partial<Pick<GetReleaseParams, keyof GetSpaceEnvironmentParams>> & {
actionId: string;
}): Promise<ReleaseActionProps<any>>;
getMany(params: Omit<GetSpaceEnvironmentParams, keyof DefaultParams> & Partial<Pick<GetSpaceEnvironmentParams, keyof GetSpaceEnvironmentParams>> & {
query?: ReleaseActionQueryOptions;
}): Promise<CollectionProp<ReleaseActionProps<any>>>;
queryForRelease(params: Omit<GetReleaseParams, keyof DefaultParams> & Partial<Pick<GetReleaseParams, keyof GetSpaceEnvironmentParams>> & {
query?: ReleaseActionQueryOptions;
}): Promise<CollectionProp<ReleaseActionProps<any>>>;
};
resource: ResourcePlainAPI;
resourceProvider: ResourceProviderPlainClientAPI;
resourceType: ResourceTypePlainClientAPI;
role: RolePlainClientAPI;
scheduledActions: {
create(params: OptionalDefaults<GetSpaceParams>, data: CreateUpdateScheduledActionProps): Promise<ScheduledActionProps>;
delete(params: OptionalDefaults<GetSpaceEnvironmentParams & {
scheduledActionId: string;
}>): Promise<ScheduledActionProps>;
get(params: Omit<GetSpaceParams, keyof DefaultParams> & Partial<Pick<GetSpaceParams, "spaceId">> & {
environmentId: string;
scheduledActionId: string;
}): Promise<ScheduledActionProps>;
getMany(params: OptionalDefaults<GetSpaceParams & QueryParams>): Promise<CursorPaginatedCollectionProp<ScheduledActionProps>>;
update(params: OptionalDefaults<GetSpaceParams & {
scheduledActionId: string;
version: number;
}>, data: CreateUpdateScheduledActionProps): Promise<ScheduledActionProps>;
};
snapshot: {
getForContentType(params: OptionalDefaults<GetSpaceEnvironmentParams & {
contentTypeId: string;
} & {
snapshotId: string;
}>): Promise<SnapshotProps<ContentTypeProps>>;
getForEntry<T>(params: OptionalDefaults<GetSpaceEnvironmentParams & {
entryId: string;
} & {
snapshotId: string;
}>): Promise<SnapshotProps<Omit<EntryProps<T>, "metadata">>>;
getManyForContentType(params: OptionalDefaults<GetSpaceEnvironmentParams & {
contentTypeId: string;
} & QueryParams>): Promise<CollectionProp<SnapshotProps<ContentTypeProps>>>;
getManyForEntry<T>(params: OptionalDefaults<GetSpaceEnvironmentParams & {
entryId: string;
} & QueryParams>): Promise<CollectionProp<SnapshotProps<Omit<EntryProps<T>, "metadata">>>>;
};
space: SpacePlainClientAPI;
spaceMember: SpaceMemberPlainClientAPI;
spaceMembership: SpaceMembershipPlainClientAPI;
tag: TagPlainClientAPI;
task: TaskPlainClientAPI;
team: TeamPlainClientAPI;
teamMembership: TeamMembershipPlainClientAPI;
teamSpaceMembership: TeamSpaceMembershipPlainClientAPI;
uiConfig: UIConfigPlainClientAPI;
upload: UploadPlainClientAPI;
uploadCredential: UploadCredentialAPI;
usage: UsagePlainClientAPI;
user: UserPlainClientAPI;
userUIConfig: UserUIConfigPlainClientAPI;
webhook: WebhookPlainClientAPI;
workflow: WorkflowPlainClientAPI;
workflowDefinition: WorkflowDefinitionPlainClientAPI;
workflowsChangelog: WorkflowsChangelogPlainClientAPI;
}
Type Alias PlainClientDefaultParams
Plain
Type Alias PlainClientDefaultParams
Plain
Type Alias PreviewApiKeyProps
Type Alias PreviewApiKeyProps
Type Alias QueryParams
Type Alias QueryParams
Type Alias ReleaseActionSysProps
Release
createdAt: ISO8601Timestamp;
createdBy: Link<"User">;
environment: Link<"Environment">;
id: string;
release: Link<"Release">;
space: Link<"Space">;
status: ReleaseActionStatuses;
type: "ReleaseAction";
updatedAt: ISO8601Timestamp;
updatedBy: Link<"User">;
}
createdAt: ISO8601Timestamp;
createdBy: Link<"User">;
environment: Link<"Environment">;
id: string;
release: Link<"Release">;
space: Link<"Space">;
status: ReleaseActionStatuses;
type: "ReleaseAction";
updatedAt: ISO8601Timestamp;
updatedBy: Link<"User">;
}
Type Alias ReleaseActionSysProps
Release
createdAt: ISO8601Timestamp;
createdBy: Link<"User">;
environment: Link<"Environment">;
id: string;
release: Link<"Release">;
space: Link<"Space">;
status: ReleaseActionStatuses;
type: "ReleaseAction";
updatedAt: ISO8601Timestamp;
updatedBy: Link<"User">;
}
createdAt: ISO8601Timestamp;
createdBy: Link<"User">;
environment: Link<"Environment">;
id: string;
release: Link<"Release">;
space: Link<"Space">;
status: ReleaseActionStatuses;
type: "ReleaseAction";
updatedAt: ISO8601Timestamp;
updatedBy: Link<"User">;
}
Type Alias ReleaseActionTypes
Release
Type Alias ReleaseActionTypes
Release
Type Alias ReleaseMetadata
Release
withReferences: {
entity: Link<"Entry">;
filter: Record<ReleaseReferenceFilters, string[]>;
}[];
}
withReferences: {
entity: Link<"Entry">;
filter: Record<ReleaseReferenceFilters, string[]>;
}[];
}
Type Alias ReleaseMetadata
Release
withReferences: {
entity: Link<"Entry">;
filter: Record<ReleaseReferenceFilters, string[]>;
}[];
}
withReferences: {
entity: Link<"Entry">;
filter: Record<ReleaseReferenceFilters, string[]>;
}[];
}
Type Alias ReleaseReferenceFilters
Type Alias ReleaseReferenceFilters
Type Alias ReleaseSysProps
Release
archivedAt?: ISO8601Timestamp;
archivedBy?: Link<"User">;
createdAt: ISO8601Timestamp;
createdBy: Link<"User"> | Link<"AppDefinition">;
environment: Link<"Environment">;
id: string;
lastAction?: Link<"ReleaseAction">;
space: Link<"Space">;
status: ReleaseStatus;
type: "Release";
updatedAt: ISO8601Timestamp;
updatedBy: Link<"User"> | Link<"AppDefinition">;
version: number;
}
archivedAt?: ISO8601Timestamp;
archivedBy?: Link<"User">;
createdAt: ISO8601Timestamp;
createdBy: Link<"User"> | Link<"AppDefinition">;
environment: Link<"Environment">;
id: string;
lastAction?: Link<"ReleaseAction">;
space: Link<"Space">;
status: ReleaseStatus;
type: "Release";
updatedAt: ISO8601Timestamp;
updatedBy: Link<"User"> | Link<"AppDefinition">;
version: number;
}
Type Alias ReleaseSysProps
Release
archivedAt?: ISO8601Timestamp;
archivedBy?: Link<"User">;
createdAt: ISO8601Timestamp;
createdBy: Link<"User"> | Link<"AppDefinition">;
environment: Link<"Environment">;
id: string;
lastAction?: Link<"ReleaseAction">;
space: Link<"Space">;
status: ReleaseStatus;
type: "Release";
updatedAt: ISO8601Timestamp;
updatedBy: Link<"User"> | Link<"AppDefinition">;
version: number;
}
archivedAt?: ISO8601Timestamp;
archivedBy?: Link<"User">;
createdAt: ISO8601Timestamp;
createdBy: Link<"User"> | Link<"AppDefinition">;
environment: Link<"Environment">;
id: string;
lastAction?: Link<"ReleaseAction">;
space: Link<"Space">;
status: ReleaseStatus;
type: "Release";
updatedAt: ISO8601Timestamp;
updatedBy: Link<"User"> | Link<"AppDefinition">;
version: number;
}
Type Alias ResourceProps
Resource
fields: {
badge?: {
label: string;
variant:
| "primary"
| "negative"
| "positive"
| "warning"
| "secondary";
};
description?: string;
externalUrl?: string;
image?: {
altText?: string;
url: string;
};
subtitle?: string;
title: string;
};
sys: {
appDefinition: SysLink;
resourceProvider: SysLink;
resourceType: SysLink;
type: "Resource";
urn: string;
};
}
fields: {
badge?: {
label: string;
variant:
| "primary"
| "negative"
| "positive"
| "warning"
| "secondary";
};
description?: string;
externalUrl?: string;
image?: {
altText?: string;
url: string;
};
subtitle?: string;
title: string;
};
sys: {
appDefinition: SysLink;
resourceProvider: SysLink;
resourceType: SysLink;
type: "Resource";
urn: string;
};
}
Type Alias ResourceProps
Resource
fields: {
badge?: {
label: string;
variant:
| "primary"
| "negative"
| "positive"
| "warning"
| "secondary";
};
description?: string;
externalUrl?: string;
image?: {
altText?: string;
url: string;
};
subtitle?: string;
title: string;
};
sys: {
appDefinition: SysLink;
resourceProvider: SysLink;
resourceType: SysLink;
type: "Resource";
urn: string;
};
}
fields: {
badge?: {
label: string;
variant:
| "primary"
| "negative"
| "positive"
| "warning"
| "secondary";
};
description?: string;
externalUrl?: string;
image?: {
altText?: string;
url: string;
};
subtitle?: string;
title: string;
};
sys: {
appDefinition: SysLink;
resourceProvider: SysLink;
resourceType: SysLink;
type: "Resource";
urn: string;
};
}
Type Alias ResourceProviderProps
Resource
function: SysLink;
sys: Omit<BasicMetaSysProps, "version"> & {
appDefinition: SysLink;
organization: SysLink;
};
type: "function";
}
function: SysLink;
sys: Omit<BasicMetaSysProps, "version"> & {
appDefinition: SysLink;
organization: SysLink;
};
type: "function";
}
Type declaration
function: SysLink
Link to a Contentful function
+ResourceProviderProps | contentful-management.js - v11.40.3 +Type Alias ResourceProviderProps
ResourceProvider Props: {
function: SysLink;
sys: Omit<BasicMetaSysProps, "version"> & {
appDefinition: SysLink;
organization: SysLink;
};
type: "function";
}Type declaration
function: SysLink
Link to a Contentful function
sys: Omit<BasicMetaSysProps, "version"> & {
appDefinition: SysLink;
organization: SysLink;
}System metadata
type: "function"
Resource Provider type, value is 'function'
-
Type Alias ResourceQueryOptions
Resource
Type Alias ResourceQueryOptions
Resource
Type Alias ResourceTypeProps
Resource
defaultFieldMapping: {
badge?: {
label: string;
variant: string;
};
description?: string;
externalUrl?: string;
image?: {
altText?: string;
url: string;
};
subtitle?: string;
title: string;
};
name: string;
sys: Omit<BasicMetaSysProps, "version"> & {
appDefinition: SysLink;
organization: SysLink;
resourceProvider: SysLink;
};
}
defaultFieldMapping: {
badge?: {
label: string;
variant: string;
};
description?: string;
externalUrl?: string;
image?: {
altText?: string;
url: string;
};
subtitle?: string;
title: string;
};
name: string;
sys: Omit<BasicMetaSysProps, "version"> & {
appDefinition: SysLink;
organization: SysLink;
resourceProvider: SysLink;
};
}
Type declaration
default
Field Mapping: {
badge?: {
label: string;
variant: string;
};
description?: string;
externalUrl?: string;
image?: {
altText?: string;
url: string;
};
subtitle?: string;
title: string;
}Resource Type defaultFieldMapping
+ResourceTypeProps | contentful-management.js - v11.40.3 +Type Alias ResourceTypeProps
ResourceType Props: {
defaultFieldMapping: {
badge?: {
label: string;
variant: string;
};
description?: string;
externalUrl?: string;
image?: {
altText?: string;
url: string;
};
subtitle?: string;
title: string;
};
name: string;
sys: Omit<BasicMetaSysProps, "version"> & {
appDefinition: SysLink;
organization: SysLink;
resourceProvider: SysLink;
};
}Type declaration
default
Field Mapping: {
badge?: {
label: string;
variant: string;
};
description?: string;
externalUrl?: string;
image?: {
altText?: string;
url: string;
};
subtitle?: string;
title: string;
}Resource Type defaultFieldMapping
Optionalbadge?: {
label: string;
variant: string;
}label: string
variant: string
Optionaldescription?: stringOptionalexternalUrl?: string Optionalimage?: {
altText?: string;
url: string;
}OptionalaltText?: string url: string
Optionalsubtitle?: stringtitle: string
name: string
Resource Type name
sys: Omit<BasicMetaSysProps, "version"> & {
appDefinition: SysLink;
organization: SysLink;
resourceProvider: SysLink;
}System metadata
-
Type Alias RichTextCommentProps
Type Alias RichTextCommentProps
Type Alias RoleProps
Role
description?: string;
name: string;
permissions: {
ContentDelivery: string[] | string;
ContentModel: string[];
EnvironmentAliases: string[] | string;
Environments: string[] | string;
Settings: string[] | string;
Tags: string[] | string;
};
policies: {
actions: ActionType[] | "all";
constraint: ConstraintType;
effect: string;
}[];
sys: BasicMetaSysProps & {
space: SysLink;
};
}
description?: string;
name: string;
permissions: {
ContentDelivery: string[] | string;
ContentModel: string[];
EnvironmentAliases: string[] | string;
Environments: string[] | string;
Settings: string[] | string;
Tags: string[] | string;
};
policies: {
actions: ActionType[] | "all";
constraint: ConstraintType;
effect: string;
}[];
sys: BasicMetaSysProps & {
space: SysLink;
};
}
Type declaration
Optionaldescription?: stringname: string
permissions: {
ContentDelivery: string[] | string;
ContentModel: string[];
EnvironmentAliases: string[] | string;
Environments: string[] | string;
Settings: string[] | string;
Tags: string[] | string;
}Permissions for application sections
-Content
Delivery: string[] | string Content
Model: string[] Environment
Aliases: string[] | string Environments: string[] | string
Settings: string[] | string
Tags: string[] | string
policies: {
actions: ActionType[] | "all";
constraint: ConstraintType;
effect: string;
}[]sys: BasicMetaSysProps & {
space: SysLink;
}
Type Alias RoleProps
Role
description?: string;
name: string;
permissions: {
ContentDelivery: string[] | string;
ContentModel: string[];
EnvironmentAliases: string[] | string;
Environments: string[] | string;
Settings: string[] | string;
Tags: string[] | string;
};
policies: {
actions: ActionType[] | "all";
constraint: ConstraintType;
effect: string;
}[];
sys: BasicMetaSysProps & {
space: SysLink;
};
}
description?: string;
name: string;
permissions: {
ContentDelivery: string[] | string;
ContentModel: string[];
EnvironmentAliases: string[] | string;
Environments: string[] | string;
Settings: string[] | string;
Tags: string[] | string;
};
policies: {
actions: ActionType[] | "all";
constraint: ConstraintType;
effect: string;
}[];
sys: BasicMetaSysProps & {
space: SysLink;
};
}
Type declaration
Optionaldescription?: stringname: string
permissions: {
ContentDelivery: string[] | string;
ContentModel: string[];
EnvironmentAliases: string[] | string;
Environments: string[] | string;
Settings: string[] | string;
Tags: string[] | string;
}Permissions for application sections
+Content
Delivery: string[] | string Content
Model: string[] Environment
Aliases: string[] | string Environments: string[] | string
Settings: string[] | string
Tags: string[] | string
policies: {
actions: ActionType[] | "all";
constraint: ConstraintType;
effect: string;
}[]sys: BasicMetaSysProps & {
space: SysLink;
}
Type Alias ScheduledActionProps
Scheduled
action: SchedulableActionType;
entity: Link<SchedulableEntityType>;
environment?: {
sys: MetaLinkProps;
};
error?: ScheduledActionFailedError;
payload?: ScheduledActionPayloadProps;
scheduledFor: {
datetime: ISO8601Timestamp;
timezone?: string;
};
sys: ScheduledActionSysProps;
}
action: SchedulableActionType;
entity: Link<SchedulableEntityType>;
environment?: {
sys: MetaLinkProps;
};
error?: ScheduledActionFailedError;
payload?: ScheduledActionPayloadProps;
scheduledFor: {
datetime: ISO8601Timestamp;
timezone?: string;
};
sys: ScheduledActionSysProps;
}
Type declaration
action: SchedulableActionType
entity: Link<SchedulableEntityType>
Optionalenvironment?: {
sys: MetaLinkProps;
}sys: MetaLinkProps
Optionalerror?: ScheduledActionFailedErrorThe Contentful-style error that occurred during execution if sys.status is failed
+ScheduledActionProps | contentful-management.js - v11.40.3 +Type Alias ScheduledActionProps
ScheduledAction Props: {
action: SchedulableActionType;
entity: Link<SchedulableEntityType>;
environment?: {
sys: MetaLinkProps;
};
error?: ScheduledActionFailedError;
payload?: ScheduledActionPayloadProps;
scheduledFor: {
datetime: ISO8601Timestamp;
timezone?: string;
};
sys: ScheduledActionSysProps;
}Type declaration
action: SchedulableActionType
entity: Link<SchedulableEntityType>
Optionalenvironment?: {
sys: MetaLinkProps;
}sys: MetaLinkProps
Optionalerror?: ScheduledActionFailedErrorThe Contentful-style error that occurred during execution if sys.status is failed
sys: ScheduledActionSysProps
sys: ScheduledActionSysProps
Type Alias ScheduledActionSysProps
Scheduled
canceledAt?: ISO8601Timestamp;
canceledBy?: Link<"User"> | Link<"AppDefinition">;
createdAt: ISO8601Timestamp;
createdBy: Link<"User"> | Link<"AppDefinition">;
id: string;
space: SysLink;
status: ScheduledActionStatus;
type: "ScheduledAction";
updatedAt: ISO8601Timestamp;
updatedBy: Link<"User"> | Link<"AppDefinition">;
version: number;
}
canceledAt?: ISO8601Timestamp;
canceledBy?: Link<"User"> | Link<"AppDefinition">;
createdAt: ISO8601Timestamp;
createdBy: Link<"User"> | Link<"AppDefinition">;
id: string;
space: SysLink;
status: ScheduledActionStatus;
type: "ScheduledAction";
updatedAt: ISO8601Timestamp;
updatedBy: Link<"User"> | Link<"AppDefinition">;
version: number;
}
Type declaration
OptionalcanceledAt?: ISO8601Timestamp an ISO8601 date string representing when an action was moved to canceled
+ScheduledActionSysProps | contentful-management.js - v11.40.3 +Type Alias ScheduledActionSysProps
ScheduledAction Sys Props: {
canceledAt?: ISO8601Timestamp;
canceledBy?: Link<"User"> | Link<"AppDefinition">;
createdAt: ISO8601Timestamp;
createdBy: Link<"User"> | Link<"AppDefinition">;
id: string;
space: SysLink;
status: ScheduledActionStatus;
type: "ScheduledAction";
updatedAt: ISO8601Timestamp;
updatedBy: Link<"User"> | Link<"AppDefinition">;
version: number;
}Type declaration
OptionalcanceledAt?: ISO8601Timestamp an ISO8601 date string representing when an action was moved to canceled
OptionalcanceledBy?: Link<"User"> | Link<"AppDefinition"> created
At: ISO8601Timestamp created
By: Link<"User"> | Link<"AppDefinition"> id: string
space: SysLink
status: ScheduledActionStatus
type: "ScheduledAction"
updated
At: ISO8601Timestamp an ISO8601 date string representing when an action was updated
-updated
By: Link<"User"> | Link<"AppDefinition"> version: number
updated
By: Link<"User"> | Link<"AppDefinition"> version: number
Type Alias SnapshotProps<T>
Snapshot
snapshot: T;
sys: MetaSysProps & {
snapshotEntityType: string;
snapshotType: string;
};
}
snapshot: T;
sys: MetaSysProps & {
snapshotEntityType: string;
snapshotType: string;
};
}
Type Parameters
Type Alias SnapshotProps<T>
Snapshot
snapshot: T;
sys: MetaSysProps & {
snapshotEntityType: string;
snapshotType: string;
};
}
snapshot: T;
sys: MetaSysProps & {
snapshotEntityType: string;
snapshotType: string;
};
}
Type Parameters
Type Alias Space
Type Alias Space
Type Alias SpaceEnvResourceTypeProps
Space
sys: Partial<Pick<ResourceTypeProps["sys"], OptionalSysFields>> & Omit<ResourceTypeProps["sys"], OptionalSysFields>;
}
sys: Partial<Pick<ResourceTypeProps["sys"], OptionalSysFields>> & Omit<ResourceTypeProps["sys"], OptionalSysFields>;
}
Type Alias SpaceEnvResourceTypeProps
Space
sys: Partial<Pick<ResourceTypeProps["sys"], OptionalSysFields>> & Omit<ResourceTypeProps["sys"], OptionalSysFields>;
}
sys: Partial<Pick<ResourceTypeProps["sys"], OptionalSysFields>> & Omit<ResourceTypeProps["sys"], OptionalSysFields>;
}
Type Alias SpaceMemberProps
Type declaration
admin: boolean
User is an admin
+SpaceMemberProps | contentful-management.js - v11.40.3 +Type Alias SpaceMemberProps
Type declaration
admin: boolean
User is an admin
roles: {
sys: MetaLinkProps;
}[]Array of Role Links
-sys: MetaSysProps
sys: MetaSysProps
Type Alias SpaceMembershipProps
Space
admin: boolean;
roles: SysLink[];
sys: MetaSysProps & {
space: SysLink;
user: SysLink;
};
user: SysLink;
}
admin: boolean;
roles: SysLink[];
sys: MetaSysProps & {
space: SysLink;
user: SysLink;
};
user: SysLink;
}
Type Alias SpaceMembershipProps
Space
admin: boolean;
roles: SysLink[];
sys: MetaSysProps & {
space: SysLink;
user: SysLink;
};
user: SysLink;
}
admin: boolean;
roles: SysLink[];
sys: MetaSysProps & {
space: SysLink;
user: SysLink;
};
user: SysLink;
}
Type Alias SpaceProps
Space
name: string;
sys: BasicMetaSysProps & {
archivedAt?: string;
organization: {
sys: {
id: string;
};
};
};
}
name: string;
sys: BasicMetaSysProps & {
archivedAt?: string;
organization: {
sys: {
id: string;
};
};
};
}
Type Alias SpaceProps
Space
name: string;
sys: BasicMetaSysProps & {
archivedAt?: string;
organization: {
sys: {
id: string;
};
};
};
}
name: string;
sys: BasicMetaSysProps & {
archivedAt?: string;
organization: {
sys: {
id: string;
};
};
};
}
Type Alias SpaceQueryParams
Type Alias SpaceQueryParams
Type Alias TagProps
Tag
name: string;
sys: TagSysProps;
}
name: string;
sys: TagSysProps;
}
Type Alias TagProps
Tag
name: string;
sys: TagSysProps;
}
name: string;
sys: TagSysProps;
}
Type Alias TagVisibility
Tag
Type Alias TagVisibility
Tag
Type Alias TaskProps
Task
assignedTo: Link<"User" | "Team">;
body: string;
dueDate?: string;
status: TaskStatus;
sys: TaskSysProps;
}
assignedTo: Link<"User" | "Team">;
body: string;
dueDate?: string;
status: TaskStatus;
sys: TaskSysProps;
}
Type Alias TaskProps
Task
assignedTo: Link<"User" | "Team">;
body: string;
dueDate?: string;
status: TaskStatus;
sys: TaskSysProps;
}
assignedTo: Link<"User" | "Team">;
body: string;
dueDate?: string;
status: TaskStatus;
sys: TaskSysProps;
}
Type Alias TeamMembershipProps
Team
admin: boolean;
organizationMembershipId: string;
sys: MetaSysProps & {
organization: {
sys: MetaLinkProps;
};
organizationMembership: {
sys: MetaLinkProps;
};
team: {
sys: MetaLinkProps;
};
};
}
admin: boolean;
organizationMembershipId: string;
sys: MetaSysProps & {
organization: {
sys: MetaLinkProps;
};
organizationMembership: {
sys: MetaLinkProps;
};
team: {
sys: MetaLinkProps;
};
};
}
Type declaration
admin: boolean
Is admin
+TeamMembershipProps | contentful-management.js - v11.40.3 +Type Alias TeamMembershipProps
TeamMembership Props: {
admin: boolean;
organizationMembershipId: string;
sys: MetaSysProps & {
organization: {
sys: MetaLinkProps;
};
organizationMembership: {
sys: MetaLinkProps;
};
team: {
sys: MetaLinkProps;
};
};
}Type declaration
admin: boolean
Is admin
organization
Membership Id: string Organization membership id
sys: MetaSysProps & {
organization: {
sys: MetaLinkProps;
};
organizationMembership: {
sys: MetaLinkProps;
};
team: {
sys: MetaLinkProps;
};
}System metadata
-
Type Alias TeamProps
Team
description: string;
name: string;
sys: MetaSysProps & {
memberCount: number;
organization: {
sys: MetaLinkProps;
};
};
}
description: string;
name: string;
sys: MetaSysProps & {
memberCount: number;
organization: {
sys: MetaLinkProps;
};
};
}
Type declaration
description: string
Description of the team
+TeamProps | contentful-management.js - v11.40.3 +Type Alias TeamProps
TeamProps: {
description: string;
name: string;
sys: MetaSysProps & {
memberCount: number;
organization: {
sys: MetaLinkProps;
};
};
}Type declaration
description: string
Description of the team
name: string
Name of the team
sys: MetaSysProps & {
memberCount: number;
organization: {
sys: MetaLinkProps;
};
}System metadata
-
Type Alias TeamSpaceMembershipProps
Team
admin: boolean;
roles: {
sys: MetaLinkProps;
}[];
sys: MetaSysProps & {
space: {
sys: MetaLinkProps;
};
team: {
sys: MetaLinkProps;
};
};
}
admin: boolean;
roles: {
sys: MetaLinkProps;
}[];
sys: MetaSysProps & {
space: {
sys: MetaLinkProps;
};
team: {
sys: MetaLinkProps;
};
};
}
Type declaration
admin: boolean
Is admin
+TeamSpaceMembershipProps | contentful-management.js - v11.40.3 +Type Alias TeamSpaceMembershipProps
TeamSpace Membership Props: {
admin: boolean;
roles: {
sys: MetaLinkProps;
}[];
sys: MetaSysProps & {
space: {
sys: MetaLinkProps;
};
team: {
sys: MetaLinkProps;
};
};
}Type declaration
admin: boolean
Is admin
roles: {
sys: MetaLinkProps;
}[]Roles
sys: MetaSysProps & {
space: {
sys: MetaLinkProps;
};
team: {
sys: MetaLinkProps;
};
}System metadata
-
Type Alias UIConfigProps
UIConfig
assetListViews: ViewFolder[];
entryListViews: ViewFolder[];
homeViews: HomeView[];
sys: UIConfigSysProps;
}
assetListViews: ViewFolder[];
entryListViews: ViewFolder[];
homeViews: HomeView[];
sys: UIConfigSysProps;
}
Type declaration
asset
List Views: ViewFolder[] entry
List Views: ViewFolder[] home
Views: HomeView[] sys: UIConfigSysProps
System metadata
-
Type Alias UIConfigProps
UIConfig
assetListViews: ViewFolder[];
entryListViews: ViewFolder[];
homeViews: HomeView[];
sys: UIConfigSysProps;
}
assetListViews: ViewFolder[];
entryListViews: ViewFolder[];
homeViews: HomeView[];
sys: UIConfigSysProps;
}
Type declaration
asset
List Views: ViewFolder[] entry
List Views: ViewFolder[] home
Views: HomeView[] sys: UIConfigSysProps
System metadata
+
Type Alias UIExtensionProps
UIExtension
extension: {
fieldTypes: FieldType[];
name: string;
parameters?: {
installation?: ParameterDefinition<InstallationParameterType>[];
instance?: ParameterDefinition[];
};
sidebar?: boolean;
src?: string;
srcdoc?: string;
};
parameters?: DefinedParameters;
sys: ExtensionSysProps;
}
extension: {
fieldTypes: FieldType[];
name: string;
parameters?: {
installation?: ParameterDefinition<InstallationParameterType>[];
instance?: ParameterDefinition[];
};
sidebar?: boolean;
src?: string;
srcdoc?: string;
};
parameters?: DefinedParameters;
sys: ExtensionSysProps;
}
Type declaration
extension: {
fieldTypes: FieldType[];
name: string;
parameters?: {
installation?: ParameterDefinition<InstallationParameterType>[];
instance?: ParameterDefinition[];
};
sidebar?: boolean;
src?: string;
srcdoc?: string;
}field
Types: FieldType[] Field types where an extension can be used
+UIExtensionProps | contentful-management.js - v11.40.3 +Type Alias UIExtensionProps
UIExtensionProps: {
extension: {
fieldTypes: FieldType[];
name: string;
parameters?: {
installation?: ParameterDefinition<InstallationParameterType>[];
instance?: ParameterDefinition[];
};
sidebar?: boolean;
src?: string;
srcdoc?: string;
};
parameters?: DefinedParameters;
sys: ExtensionSysProps;
}Type declaration
extension: {
fieldTypes: FieldType[];
name: string;
parameters?: {
installation?: ParameterDefinition<InstallationParameterType>[];
instance?: ParameterDefinition[];
};
sidebar?: boolean;
src?: string;
srcdoc?: string;
}field
Types: FieldType[] Field types where an extension can be used
name: string
Extension name
Optionalparameters?: {
installation?: ParameterDefinition<InstallationParameterType>[];
instance?: ParameterDefinition[];
}Parameter definitions
Optionalinstallation?: ParameterDefinition<InstallationParameterType>[]Optionalinstance?: ParameterDefinition[]
Optionalsidebar?: booleanControls the location of the extension. If true it will be rendered on the sidebar instead of replacing the field's editing control
Optionalsrc?: stringURL where the root HTML document of the extension can be found
Optionalsrcdoc?: stringString representation of the extension (e.g. inline HTML code)
Optionalparameters?: DefinedParametersValues for installation parameters
-sys: ExtensionSysProps
sys: ExtensionSysProps
Type Alias UpdateCommentProps
Type Alias UpdateCommentProps
Type Alias UpdateConceptParams
Type Alias UpdateConceptParams
Type Alias UpdateConceptSchemeParams
Type Alias UpdateConceptSchemeParams
Type Alias UpdateTaskProps
Type Alias UpdateTaskProps
Type Alias UpdateWebhookProps
Update
| "headers"
| "name"
| "topics"
| "url"
| "active">
| "headers"
| "name"
| "topics"
| "url"
| "active">
Type Alias UpdateWebhookProps
Update
| "headers"
| "name"
| "topics"
| "url"
| "active">
| "headers"
| "name"
| "topics"
| "url"
| "active">
Type Alias UpdateWorkflowDefinitionParams
Type Alias UpdateWorkflowDefinitionParams
Type Alias UpdateWorkflowDefinitionProps
Update
steps: (CreateWorkflowStepProps | UpdateWorkflowStepProps)[];
sys: Pick<WorkflowDefinitionSysProps, "version">;
}
steps: (CreateWorkflowStepProps | UpdateWorkflowStepProps)[];
sys: Pick<WorkflowDefinitionSysProps, "version">;
}
Type Alias UpdateWorkflowDefinitionProps
Update
steps: (CreateWorkflowStepProps | UpdateWorkflowStepProps)[];
sys: Pick<WorkflowDefinitionSysProps, "version">;
}
steps: (CreateWorkflowStepProps | UpdateWorkflowStepProps)[];
sys: Pick<WorkflowDefinitionSysProps, "version">;
}
Type Alias UpdateWorkflowProps
Type Alias UpdateWorkflowProps
Type Alias UpdateWorkflowStepProps
Type Alias UpdateWorkflowStepProps
Type Alias UploadCredentialProps
Type declaration
sys: MetaSysProps & {
environment?: SysLink;
space: SysLink;
}System metadata
-
Type Alias UploadCredentialProps
Type declaration
sys: MetaSysProps & {
environment?: SysLink;
space: SysLink;
}System metadata
+
Type Alias UploadProps
Type declaration
sys: MetaSysProps & {
environment?: SysLink;
space: SysLink;
}System metadata
-
Type Alias UploadProps
Type declaration
sys: MetaSysProps & {
environment?: SysLink;
space: SysLink;
}System metadata
+
Type Alias UpsertResourceProviderProps
Type Alias UpsertResourceProviderProps
Type Alias UpsertResourceTypeProps
Type Alias UpsertResourceTypeProps
Type Alias UpsertWebhookSigningSecretPayload
Upsert
value: string;
}
value: string;
}
Type Alias UpsertWebhookSigningSecretPayload
Upsert
value: string;
}
value: string;
}
Type Alias UsageProps
Usage
dateRange: {
endAt: string;
startAt: string;
};
metric: UsageMetricEnum;
sys: MetaSysProps & {
organization?: {
sys: MetaLinkProps;
};
};
unitOfMeasure: string;
usage: number;
usagePerDay: {
[key: string]: number;
};
}
dateRange: {
endAt: string;
startAt: string;
};
metric: UsageMetricEnum;
sys: MetaSysProps & {
organization?: {
sys: MetaLinkProps;
};
};
unitOfMeasure: string;
usage: number;
usagePerDay: {
[key: string]: number;
};
}
Type declaration
date
Range: {
endAt: string;
startAt: string;
}Range of usage
+UsageProps | contentful-management.js - v11.40.3 +Type Alias UsageProps
UsageProps: {
dateRange: {
endAt: string;
startAt: string;
};
metric: UsageMetricEnum;
sys: MetaSysProps & {
organization?: {
sys: MetaLinkProps;
};
};
unitOfMeasure: string;
usage: number;
usagePerDay: {
[key: string]: number;
};
}Type declaration
date
Range: {
endAt: string;
startAt: string;
}Range of usage
end
At: string start
At: string
metric: UsageMetricEnum
Type of usage
sys: MetaSysProps & {
organization?: {
sys: MetaLinkProps;
};
}System metadata
unit
Of Measure: string Unit of usage metric
usage: number
Value of the usage
usage
Per Day: {
[key: string]: number;
}Usage per day
-[key: string]: number
[key: string]: number
Type Alias UserProps
User
2faEnabled: boolean;
activated: boolean;
avatarUrl: string;
confirmed: boolean;
cookieConsentData: string;
email: string;
firstName: string;
lastName: string;
signInCount: number;
sys: BasicMetaSysProps;
}
2faEnabled: boolean;
activated: boolean;
avatarUrl: string;
confirmed: boolean;
cookieConsentData: string;
email: string;
firstName: string;
lastName: string;
signInCount: number;
sys: BasicMetaSysProps;
}
Type declaration
2fa
Enabled: boolean activated: boolean
Activation flag
+UserProps | contentful-management.js - v11.40.3 +Type Alias UserProps
UserProps: {
2faEnabled: boolean;
activated: boolean;
avatarUrl: string;
confirmed: boolean;
cookieConsentData: string;
email: string;
firstName: string;
lastName: string;
signInCount: number;
sys: BasicMetaSysProps;
}Type declaration
2fa
Enabled: boolean activated: boolean
Activation flag
avatar
Url: string Url to the users avatar
confirmed: boolean
User confirmation flag
cookie
Consent Data: string email: string
Email address of the user
@@ -6,4 +6,4 @@last
Name: string Last name of the user
sign
In Count: number Number of sign ins
sys: BasicMetaSysProps
System metadata
-
Type Alias UserUIConfigProps
UserUIConfig
assetListViews: ViewFolder[];
entryListViews: ViewFolder[];
sys: UserUIConfigSysProps;
}
assetListViews: ViewFolder[];
entryListViews: ViewFolder[];
sys: UserUIConfigSysProps;
}
Type declaration
asset
List Views: ViewFolder[] entry
List Views: ViewFolder[] sys: UserUIConfigSysProps
System metadata
-
Type Alias UserUIConfigProps
UserUIConfig
assetListViews: ViewFolder[];
entryListViews: ViewFolder[];
sys: UserUIConfigSysProps;
}
assetListViews: ViewFolder[];
entryListViews: ViewFolder[];
sys: UserUIConfigSysProps;
}
Type declaration
asset
List Views: ViewFolder[] entry
List Views: ViewFolder[] sys: UserUIConfigSysProps
System metadata
+
Type Alias ValidateEnvironmentTemplateInstallationProps
Validate
Type Alias ValidateEnvironmentTemplateInstallationProps
Validate
Type Alias ValidationFinding
Validation
details: Record<string, unknown>;
message: string;
}
details: Record<string, unknown>;
message: string;
}
Type Alias ValidationFinding
Validation
details: Record<string, unknown>;
message: string;
}
details: Record<string, unknown>;
message: string;
}
Type Alias WebhookCallRequest
Webhook
body: string;
headers: {
[key: string]: string;
};
method: string;
url: string;
}
body: string;
headers: {
[key: string]: string;
};
method: string;
url: string;
}
Type Alias WebhookCallRequest
Webhook
body: string;
headers: {
[key: string]: string;
};
method: string;
url: string;
}
body: string;
headers: {
[key: string]: string;
};
method: string;
url: string;
}
Type Alias WebhookFilter
Webhook
| EqualityConstraint
| InConstraint
| RegexpConstraint
| NotConstraint
| EqualityConstraint
| InConstraint
| RegexpConstraint
| NotConstraint
Type Alias WebhookFilter
Webhook
| EqualityConstraint
| InConstraint
| RegexpConstraint
| NotConstraint
| EqualityConstraint
| InConstraint
| RegexpConstraint
| NotConstraint
Type Alias WebhookProps
Webhook
active: boolean;
filters?: WebhookFilter[];
headers: WebhookHeader[];
httpBasicPassword?: string;
httpBasicUsername?: string;
name: string;
sys: BasicMetaSysProps & {
space: SysLink;
};
topics: string[];
transformation?: WebhookTransformation;
url: string;
}
active: boolean;
filters?: WebhookFilter[];
headers: WebhookHeader[];
httpBasicPassword?: string;
httpBasicUsername?: string;
name: string;
sys: BasicMetaSysProps & {
space: SysLink;
};
topics: string[];
transformation?: WebhookTransformation;
url: string;
}
Type declaration
active: boolean
Whether the Webhook is active. If set to false, no calls will be made
+WebhookProps | contentful-management.js - v11.40.3 +Type Alias WebhookProps
WebhookProps: {
active: boolean;
filters?: WebhookFilter[];
headers: WebhookHeader[];
httpBasicPassword?: string;
httpBasicUsername?: string;
name: string;
sys: BasicMetaSysProps & {
space: SysLink;
};
topics: string[];
transformation?: WebhookTransformation;
url: string;
}Type declaration
active: boolean
Whether the Webhook is active. If set to false, no calls will be made
Optionalfilters?: WebhookFilter[]Webhook filters
headers: WebhookHeader[]
Headers that should be appended to the webhook request
OptionalhttpBasic Password?: string Password for basic http auth
@@ -8,4 +8,4 @@topics: string[]
Topics the webhook wants to subscribe to
Optionaltransformation?: WebhookTransformationTransformation to apply
url: string
Webhook url
-
Type Alias WebhookSigningSecretProps
Webhook
redactedValue: string;
sys: WebhookSigningSecretSys & {
space: {
sys: MetaLinkProps;
};
};
}
redactedValue: string;
sys: WebhookSigningSecretSys & {
space: {
sys: MetaLinkProps;
};
};
}
Type Alias WebhookSigningSecretProps
Webhook
redactedValue: string;
sys: WebhookSigningSecretSys & {
space: {
sys: MetaLinkProps;
};
};
}
redactedValue: string;
sys: WebhookSigningSecretSys & {
space: {
sys: MetaLinkProps;
};
};
}
Type Alias WebhookTransformation
Webhook
body?: JsonValue;
contentType?:
| null
| "application/vnd.contentful.management.v1+json"
| "application/vnd.contentful.management.v1+json; charset=utf-8"
| "application/json"
| "application/json; charset=utf-8"
| "application/x-www-form-urlencoded"
| "application/x-www-form-urlencoded; charset=utf-8";
includeContentLength?: boolean | null;
method?:
| null
| "POST"
| "GET"
| "PUT"
| "PATCH"
| "DELETE";
}
body?: JsonValue;
contentType?:
| null
| "application/vnd.contentful.management.v1+json"
| "application/vnd.contentful.management.v1+json; charset=utf-8"
| "application/json"
| "application/json; charset=utf-8"
| "application/x-www-form-urlencoded"
| "application/x-www-form-urlencoded; charset=utf-8";
includeContentLength?: boolean | null;
method?:
| null
| "POST"
| "GET"
| "PUT"
| "PATCH"
| "DELETE";
}
Type Alias WebhookTransformation
Webhook
body?: JsonValue;
contentType?:
| null
| "application/vnd.contentful.management.v1+json"
| "application/vnd.contentful.management.v1+json; charset=utf-8"
| "application/json"
| "application/json; charset=utf-8"
| "application/x-www-form-urlencoded"
| "application/x-www-form-urlencoded; charset=utf-8";
includeContentLength?: boolean | null;
method?:
| null
| "POST"
| "GET"
| "PUT"
| "PATCH"
| "DELETE";
}
body?: JsonValue;
contentType?:
| null
| "application/vnd.contentful.management.v1+json"
| "application/vnd.contentful.management.v1+json; charset=utf-8"
| "application/json"
| "application/json; charset=utf-8"
| "application/x-www-form-urlencoded"
| "application/x-www-form-urlencoded; charset=utf-8";
includeContentLength?: boolean | null;
method?:
| null
| "POST"
| "GET"
| "PUT"
| "PATCH"
| "DELETE";
}
+
diff --git a/contentful-management/latest/types/WorkflowDefinitionProps.html b/contentful-management/latest/types/WorkflowDefinitionProps.html
index 2786b2e1ce..f416ee8163 100644
--- a/contentful-management/latest/types/WorkflowDefinitionProps.html
+++ b/contentful-management/latest/types/WorkflowDefinitionProps.html
@@ -1 +1 @@
-
Type Alias WorkflowDefinitionProps
Workflow
appliesTo?: WorkflowDefinitionValidationLink[];
description?: string;
flowType?: "no_restriction" | "strict_neighbor";
name: string;
startOnEntityCreation?: boolean;
steps: WorkflowStepProps[];
sys: WorkflowDefinitionSysProps;
}
appliesTo?: WorkflowDefinitionValidationLink[];
description?: string;
flowType?: "no_restriction" | "strict_neighbor";
name: string;
startOnEntityCreation?: boolean;
steps: WorkflowStepProps[];
sys: WorkflowDefinitionSysProps;
}
Type Alias WorkflowDefinitionProps
Workflow
appliesTo?: WorkflowDefinitionValidationLink[];
description?: string;
flowType?: "no_restriction" | "strict_neighbor";
name: string;
startOnEntityCreation?: boolean;
steps: WorkflowStepProps[];
sys: WorkflowDefinitionSysProps;
}
appliesTo?: WorkflowDefinitionValidationLink[];
description?: string;
flowType?: "no_restriction" | "strict_neighbor";
name: string;
startOnEntityCreation?: boolean;
steps: WorkflowStepProps[];
sys: WorkflowDefinitionSysProps;
}
Type Alias WorkflowDefinitionQueryOptions
Type Alias WorkflowDefinitionQueryOptions
Type Alias WorkflowDefinitionSysProps
Workflow
| "id"
| "version"
| "createdAt"
| "createdBy"
| "updatedAt"
| "updatedBy"> & {
environment: SysLink;
isLocked: boolean;
space: SysLink;
type: "WorkflowDefinition";
}
| "id"
| "version"
| "createdAt"
| "createdBy"
| "updatedAt"
| "updatedBy"> & {
environment: SysLink;
isLocked: boolean;
space: SysLink;
type: "WorkflowDefinition";
}
Type Alias WorkflowDefinitionSysProps
Workflow
| "id"
| "version"
| "createdAt"
| "createdBy"
| "updatedAt"
| "updatedBy"> & {
environment: SysLink;
isLocked: boolean;
space: SysLink;
type: "WorkflowDefinition";
}
| "id"
| "version"
| "createdAt"
| "createdBy"
| "updatedAt"
| "updatedBy"> & {
environment: SysLink;
isLocked: boolean;
space: SysLink;
type: "WorkflowDefinition";
}
Type Alias WorkflowDefinitionValidationLink
Workflow
linkType: "Entry";
type: "Link";
validations: {
linkContentType: string[];
}[];
}
linkType: "Entry";
type: "Link";
validations: {
linkContentType: string[];
}[];
}
Type Alias WorkflowDefinitionValidationLink
Workflow
linkType: "Entry";
type: "Link";
validations: {
linkContentType: string[];
}[];
}
linkType: "Entry";
type: "Link";
validations: {
linkContentType: string[];
}[];
}
Type Alias WorkflowProps
Workflow
stepId?: string;
sys: WorkflowSysProps;
}
stepId?: string;
sys: WorkflowSysProps;
}
Type Alias WorkflowProps
Workflow
stepId?: string;
sys: WorkflowSysProps;
}
stepId?: string;
sys: WorkflowSysProps;
}
Type Alias WorkflowQueryOptions
Workflow
order?: OrderQueryParam;
stepId[in]?: string;
sys.entity.sys.id[in]?: string;
sys.entity.sys.linkType?: string;
sys.workflowDefinition.sys.id?: string;
}
order?: OrderQueryParam;
stepId[in]?: string;
sys.entity.sys.id[in]?: string;
sys.entity.sys.linkType?: string;
sys.workflowDefinition.sys.id?: string;
}
Type declaration
Optionalorder?: OrderQueryParamOrder workflows by
+WorkflowQueryOptions | contentful-management.js - v11.40.3 +Type Alias WorkflowQueryOptions
WorkflowQuery Options: Omit<PaginationQueryOptions, "order"> & {
order?: OrderQueryParam;
stepId[in]?: string;
sys.entity.sys.id[in]?: string;
sys.entity.sys.linkType?: string;
sys.workflowDefinition.sys.id?: string;
}Type declaration
Optionalorder?: OrderQueryParamOrder workflows by
OptionalstepId[in]?: string Optionalsys.entity.sys.id[in]?: stringFind workflows containing the specified, comma-separated entities. Requires
sys.entity.sys.linkTypeOptionalsys.entity.sys.linkType?: string Find workflows filtered by the Entity type (Entry)
-Optionalsys.workflowDefinition.sys.id?: string
Optionalsys.workflowDefinition.sys.id?: string
Type Alias WorkflowStepAction
Type Alias WorkflowStepAction
Type Alias WorkflowStepAppAction
Workflow
appActionId: string;
appId: string;
configuration?: {
body?: Record<string, any>;
headers?: Record<string, string>;
};
type: "app";
}
appActionId: string;
appId: string;
configuration?: {
body?: Record<string, any>;
headers?: Record<string, string>;
};
type: "app";
}
Type Alias WorkflowStepAppAction
Workflow
appActionId: string;
appId: string;
configuration?: {
body?: Record<string, any>;
headers?: Record<string, string>;
};
type: "app";
}
appActionId: string;
appId: string;
configuration?: {
body?: Record<string, any>;
headers?: Record<string, string>;
};
type: "app";
}
Type Alias WorkflowStepEmailAction
Workflow
configuration: {
recipients: WorkflowStepEmailActionRecipient[];
};
type: "email";
}
configuration: {
recipients: WorkflowStepEmailActionRecipient[];
};
type: "email";
}
Type Alias WorkflowStepEmailAction
Workflow
configuration: {
recipients: WorkflowStepEmailActionRecipient[];
};
type: "email";
}
configuration: {
recipients: WorkflowStepEmailActionRecipient[];
};
type: "email";
}
+
diff --git a/contentful-management/latest/types/WorkflowStepPermissionActors.html b/contentful-management/latest/types/WorkflowStepPermissionActors.html
index 4e35aa441a..878a05bea6 100644
--- a/contentful-management/latest/types/WorkflowStepPermissionActors.html
+++ b/contentful-management/latest/types/WorkflowStepPermissionActors.html
@@ -1 +1 @@
-
+
diff --git a/contentful-management/latest/types/WorkflowStepProps.html b/contentful-management/latest/types/WorkflowStepProps.html
index 64e310460b..afd6dff0e3 100644
--- a/contentful-management/latest/types/WorkflowStepProps.html
+++ b/contentful-management/latest/types/WorkflowStepProps.html
@@ -1 +1 @@
-
Type Alias WorkflowStepProps
Workflow
actions?: WorkflowStepAction[];
annotations?: string[];
description?: string;
id: string;
name: string;
permissions?: WorkflowStepPermission[];
}
actions?: WorkflowStepAction[];
annotations?: string[];
description?: string;
id: string;
name: string;
permissions?: WorkflowStepPermission[];
}
Type Alias WorkflowStepProps
Workflow
actions?: WorkflowStepAction[];
annotations?: string[];
description?: string;
id: string;
name: string;
permissions?: WorkflowStepPermission[];
}
actions?: WorkflowStepAction[];
annotations?: string[];
description?: string;
id: string;
name: string;
permissions?: WorkflowStepPermission[];
}
+
diff --git a/contentful-management/latest/types/WorkflowsChangelogEntryProps.html b/contentful-management/latest/types/WorkflowsChangelogEntryProps.html
index d24926878d..c669aa0769 100644
--- a/contentful-management/latest/types/WorkflowsChangelogEntryProps.html
+++ b/contentful-management/latest/types/WorkflowsChangelogEntryProps.html
@@ -1 +1 @@
-
Type Alias WorkflowsChangelogEntryProps
Workflows
entity: Link<"Entry">;
event: string;
eventAt: string;
eventBy: SysLink;
stepAnnotations: string[];
stepId: string;
stepName: string;
workflow: VersionedLink<"Workflow">;
workflowDefinition: Link<"WorkflowDefinition">;
}
entity: Link<"Entry">;
event: string;
eventAt: string;
eventBy: SysLink;
stepAnnotations: string[];
stepId: string;
stepName: string;
workflow: VersionedLink<"Workflow">;
workflowDefinition: Link<"WorkflowDefinition">;
}
Type Alias WorkflowsChangelogEntryProps
Workflows
entity: Link<"Entry">;
event: string;
eventAt: string;
eventBy: SysLink;
stepAnnotations: string[];
stepId: string;
stepName: string;
workflow: VersionedLink<"Workflow">;
workflowDefinition: Link<"WorkflowDefinition">;
}
entity: Link<"Entry">;
event: string;
eventAt: string;
eventBy: SysLink;
stepAnnotations: string[];
stepId: string;
stepName: string;
workflow: VersionedLink<"Workflow">;
workflowDefinition: Link<"WorkflowDefinition">;
}
Type Alias WorkflowsChangelogQueryOptions
Workflows
entity.sys.id: string;
entity.sys.linkType: string;
eventAt[gte]?: string;
eventAt[lte]?: string;
workflow.sys.id?: string;
workflowDefinition.sys.id[in]?: string;
}
entity.sys.id: string;
entity.sys.linkType: string;
eventAt[gte]?: string;
eventAt[lte]?: string;
workflow.sys.id?: string;
workflowDefinition.sys.id[in]?: string;
}
Type declaration
entity.sys.id: string
Find workflows changelog entries containing the specified, comma-separated entities. Requires
+sys.entity.sys.linkTypeWorkflowsChangelogQueryOptions | contentful-management.js - v11.40.3 +Type Alias WorkflowsChangelogQueryOptions
WorkflowsChangelog Query Options: Omit<PaginationQueryOptions, "order"> & {
entity.sys.id: string;
entity.sys.linkType: string;
eventAt[gte]?: string;
eventAt[lte]?: string;
workflow.sys.id?: string;
workflowDefinition.sys.id[in]?: string;
}Type declaration
entity.sys.id: string
Find workflows changelog entries containing the specified, comma-separated entities. Requires
sys.entity.sys.linkTypeentity.sys.link
Type: string Find workflows changelog entries filtered by the Entity type (Entry)
OptionaleventAt[gte]?: string OptionaleventAt[lte]?: string Optionalworkflow.sys.id?: stringworkflow.sys.id is optional so all past workflows can be found
-OptionalworkflowDefinition.sys.id[in]?: string
OptionalworkflowDefinition.sys.id[in]?: string
Represents the state of the BulkAction
+