contentful-management 11.37.0 → 11.39.0
This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
- package/dist/contentful-management.browser.js +55 -8
- package/dist/contentful-management.browser.js.map +1 -1
- package/dist/contentful-management.browser.min.js +1 -1
- package/dist/contentful-management.node.js +55 -8
- package/dist/contentful-management.node.js.map +1 -1
- package/dist/contentful-management.node.min.js +1 -1
- package/dist/es-modules/adapters/REST/endpoints/concept-scheme.js +18 -0
- package/dist/es-modules/adapters/REST/endpoints/concept.js +21 -4
- package/dist/es-modules/contentful-management.js +1 -1
- package/dist/es-modules/export-types.js +1 -1
- package/dist/es-modules/plain/plain-client.js +7 -1
- package/dist/typings/adapters/REST/endpoints/concept-scheme.d.ts +3 -0
- package/dist/typings/adapters/REST/endpoints/concept.d.ts +3 -0
- package/dist/typings/common-types.d.ts +36 -0
- package/dist/typings/entities/space.d.ts +1 -0
- package/dist/typings/entities/upload-credential.d.ts +14 -8
- package/dist/typings/export-types.d.ts +16 -15
- package/dist/typings/plain/entities/concept-scheme.d.ts +48 -0
- package/dist/typings/plain/entities/concept.d.ts +48 -0
- package/package.json +1 -1
|
@@ -24,6 +24,17 @@ export const getTotal = (http, params) => raw.get(http, `${basePath(params.organ
|
|
|
24
24
|
export const create = (http, params, data) => {
|
|
25
25
|
return raw.post(http, basePath(params.organizationId), data);
|
|
26
26
|
};
|
|
27
|
+
export const createWithId = (http, params, data) => {
|
|
28
|
+
return raw.put(http, `${basePath(params.organizationId)}/${params.conceptSchemeId}`, data);
|
|
29
|
+
};
|
|
30
|
+
export const patch = (http, params, data, headers) => {
|
|
31
|
+
return raw.patch(http, `${basePath(params.organizationId)}/${params.conceptSchemeId}`, data, {
|
|
32
|
+
headers: _objectSpread({
|
|
33
|
+
'X-Contentful-Version': params.version,
|
|
34
|
+
'Content-Type': 'application/json-patch+json'
|
|
35
|
+
}, headers)
|
|
36
|
+
});
|
|
37
|
+
};
|
|
27
38
|
export const update = (http, params, data, headers) => {
|
|
28
39
|
return raw.patch(http, `${basePath(params.organizationId)}/${params.conceptSchemeId}`, data, {
|
|
29
40
|
headers: _objectSpread({
|
|
@@ -31,4 +42,11 @@ export const update = (http, params, data, headers) => {
|
|
|
31
42
|
'Content-Type': 'application/json-patch+json'
|
|
32
43
|
}, headers)
|
|
33
44
|
});
|
|
45
|
+
};
|
|
46
|
+
export const updatePut = (http, params, data, headers) => {
|
|
47
|
+
return raw.put(http, `${basePath(params.organizationId)}/${params.conceptSchemeId}`, data, {
|
|
48
|
+
headers: _objectSpread({
|
|
49
|
+
'X-Contentful-Version': params.version
|
|
50
|
+
}, headers)
|
|
51
|
+
});
|
|
34
52
|
};
|
|
@@ -10,21 +10,38 @@ function basePath(organizationId) {
|
|
|
10
10
|
export const create = (http, params, data) => {
|
|
11
11
|
return raw.post(http, basePath(params.organizationId), data);
|
|
12
12
|
};
|
|
13
|
+
export const createWithId = (http, params, data) => {
|
|
14
|
+
return raw.put(http, `${basePath(params.organizationId)}/${params.conceptId}`, data);
|
|
15
|
+
};
|
|
16
|
+
export const patch = (http, params, data, headers) => {
|
|
17
|
+
return raw.patch(http, `${basePath(params.organizationId)}/${params.conceptId}`, data, {
|
|
18
|
+
headers: _objectSpread({
|
|
19
|
+
'X-Contentful-Version': params.version,
|
|
20
|
+
'Content-Type': 'application/json-patch+json'
|
|
21
|
+
}, headers)
|
|
22
|
+
});
|
|
23
|
+
};
|
|
13
24
|
export const update = (http, params, data, headers) => {
|
|
14
|
-
var _params$version;
|
|
15
25
|
return raw.patch(http, `${basePath(params.organizationId)}/${params.conceptId}`, data, {
|
|
16
26
|
headers: _objectSpread({
|
|
17
|
-
'X-Contentful-Version':
|
|
27
|
+
'X-Contentful-Version': params.version,
|
|
18
28
|
'Content-Type': 'application/json-patch+json'
|
|
19
29
|
}, headers)
|
|
20
30
|
});
|
|
21
31
|
};
|
|
32
|
+
export const updatePut = (http, params, data, headers) => {
|
|
33
|
+
return raw.put(http, `${basePath(params.organizationId)}/${params.conceptId}`, data, {
|
|
34
|
+
headers: _objectSpread({
|
|
35
|
+
'X-Contentful-Version': params.version
|
|
36
|
+
}, headers)
|
|
37
|
+
});
|
|
38
|
+
};
|
|
22
39
|
export const get = (http, params) => raw.get(http, `${basePath(params.organizationId)}/${params.conceptId}`);
|
|
23
40
|
export const del = (http, params, headers) => {
|
|
24
|
-
var _params$
|
|
41
|
+
var _params$version;
|
|
25
42
|
return raw.del(http, `${basePath(params.organizationId)}/${params.conceptId}`, {
|
|
26
43
|
headers: _objectSpread({
|
|
27
|
-
'X-Contentful-Version': (_params$
|
|
44
|
+
'X-Contentful-Version': (_params$version = params.version) !== null && _params$version !== void 0 ? _params$version : 0
|
|
28
45
|
}, headers)
|
|
29
46
|
});
|
|
30
47
|
};
|
|
@@ -46,7 +46,7 @@ function createClient(params, opts = {}) {
|
|
|
46
46
|
const sdkMain = opts.type === 'plain' ? 'contentful-management-plain.js' : 'contentful-management.js';
|
|
47
47
|
const userAgent = getUserAgentHeader(
|
|
48
48
|
// @ts-expect-error
|
|
49
|
-
`${sdkMain}/${"11.
|
|
49
|
+
`${sdkMain}/${"11.39.0"}`, params.application, params.integration, params.feature);
|
|
50
50
|
const adapter = createAdapter(_objectSpread(_objectSpread({}, params), {}, {
|
|
51
51
|
userAgent
|
|
52
52
|
}));
|
|
@@ -1,3 +1,3 @@
|
|
|
1
1
|
export * from './common-types';
|
|
2
2
|
export * from './plain/common-types';
|
|
3
|
-
export {
|
|
3
|
+
export { WorkflowStepPermissionAction, WorkflowStepPermissionEffect, WorkflowStepPermissionType } from './entities/workflow-definition';
|
|
@@ -116,9 +116,12 @@ export const createPlainClient = (makeRequest, defaults) => {
|
|
|
116
116
|
},
|
|
117
117
|
concept: {
|
|
118
118
|
create: wrap(wrapParams, 'Concept', 'create'),
|
|
119
|
+
createWithId: wrap(wrapParams, 'Concept', 'createWithId'),
|
|
119
120
|
get: wrap(wrapParams, 'Concept', 'get'),
|
|
120
121
|
delete: wrap(wrapParams, 'Concept', 'delete'),
|
|
122
|
+
patch: wrap(wrapParams, 'Concept', 'patch'),
|
|
121
123
|
update: wrap(wrapParams, 'Concept', 'update'),
|
|
124
|
+
updatePut: wrap(wrapParams, 'Concept', 'updatePut'),
|
|
122
125
|
getMany: wrap(wrapParams, 'Concept', 'getMany'),
|
|
123
126
|
getDescendants: wrap(wrapParams, 'Concept', 'getDescendants'),
|
|
124
127
|
getAncestors: wrap(wrapParams, 'Concept', 'getAncestors'),
|
|
@@ -130,7 +133,10 @@ export const createPlainClient = (makeRequest, defaults) => {
|
|
|
130
133
|
getTotal: wrap(wrapParams, 'ConceptScheme', 'getTotal'),
|
|
131
134
|
delete: wrap(wrapParams, 'ConceptScheme', 'delete'),
|
|
132
135
|
create: wrap(wrapParams, 'ConceptScheme', 'create'),
|
|
133
|
-
|
|
136
|
+
createWithId: wrap(wrapParams, 'ConceptScheme', 'createWithId'),
|
|
137
|
+
patch: wrap(wrapParams, 'ConceptScheme', 'patch'),
|
|
138
|
+
update: wrap(wrapParams, 'ConceptScheme', 'update'),
|
|
139
|
+
updatePut: wrap(wrapParams, 'ConceptScheme', 'updatePut')
|
|
134
140
|
},
|
|
135
141
|
function: {
|
|
136
142
|
getMany: wrap(wrapParams, 'Function', 'getMany')
|
|
@@ -4,4 +4,7 @@ export declare const del: RestEndpoint<'ConceptScheme', 'delete'>;
|
|
|
4
4
|
export declare const getMany: RestEndpoint<'ConceptScheme', 'getMany'>;
|
|
5
5
|
export declare const getTotal: RestEndpoint<'ConceptScheme', 'getTotal'>;
|
|
6
6
|
export declare const create: RestEndpoint<'ConceptScheme', 'create'>;
|
|
7
|
+
export declare const createWithId: RestEndpoint<'ConceptScheme', 'createWithId'>;
|
|
8
|
+
export declare const patch: RestEndpoint<'ConceptScheme', 'patch'>;
|
|
7
9
|
export declare const update: RestEndpoint<'ConceptScheme', 'update'>;
|
|
10
|
+
export declare const updatePut: RestEndpoint<'ConceptScheme', 'updatePut'>;
|
|
@@ -1,6 +1,9 @@
|
|
|
1
1
|
import type { RestEndpoint } from '../types';
|
|
2
2
|
export declare const create: RestEndpoint<'Concept', 'create'>;
|
|
3
|
+
export declare const createWithId: RestEndpoint<'Concept', 'createWithId'>;
|
|
4
|
+
export declare const patch: RestEndpoint<'Concept', 'patch'>;
|
|
3
5
|
export declare const update: RestEndpoint<'Concept', 'update'>;
|
|
6
|
+
export declare const updatePut: RestEndpoint<'Concept', 'updatePut'>;
|
|
4
7
|
export declare const get: RestEndpoint<'Concept', 'get'>;
|
|
5
8
|
export declare const del: RestEndpoint<'Concept', 'delete'>;
|
|
6
9
|
export declare const getMany: RestEndpoint<'Concept', 'getMany'>;
|
|
@@ -290,13 +290,19 @@ type MRInternal<UA extends boolean> = {
|
|
|
290
290
|
(opts: MROpts<'Concept', 'getTotal', UA>): MRReturn<'Concept', 'getTotal'>;
|
|
291
291
|
(opts: MROpts<'Concept', 'getDescendants', UA>): MRReturn<'Concept', 'getDescendants'>;
|
|
292
292
|
(opts: MROpts<'Concept', 'create', UA>): MRReturn<'Concept', 'create'>;
|
|
293
|
+
(opts: MROpts<'Concept', 'createWithId', UA>): MRReturn<'Concept', 'createWithId'>;
|
|
294
|
+
(opts: MROpts<'Concept', 'patch', UA>): MRReturn<'Concept', 'patch'>;
|
|
293
295
|
(opts: MROpts<'Concept', 'update', UA>): MRReturn<'Concept', 'update'>;
|
|
296
|
+
(opts: MROpts<'Concept', 'updatePut', UA>): MRReturn<'Concept', 'updatePut'>;
|
|
294
297
|
(opts: MROpts<'Concept', 'delete', UA>): MRReturn<'Concept', 'delete'>;
|
|
295
298
|
(opts: MROpts<'ConceptScheme', 'get', UA>): MRReturn<'ConceptScheme', 'get'>;
|
|
296
299
|
(opts: MROpts<'ConceptScheme', 'getMany', UA>): MRReturn<'ConceptScheme', 'getMany'>;
|
|
297
300
|
(opts: MROpts<'ConceptScheme', 'getTotal', UA>): MRReturn<'ConceptScheme', 'getTotal'>;
|
|
298
301
|
(opts: MROpts<'ConceptScheme', 'create', UA>): MRReturn<'ConceptScheme', 'create'>;
|
|
302
|
+
(opts: MROpts<'ConceptScheme', 'createWithId', UA>): MRReturn<'ConceptScheme', 'createWithId'>;
|
|
303
|
+
(opts: MROpts<'ConceptScheme', 'patch', UA>): MRReturn<'ConceptScheme', 'patch'>;
|
|
299
304
|
(opts: MROpts<'ConceptScheme', 'update', UA>): MRReturn<'ConceptScheme', 'update'>;
|
|
305
|
+
(opts: MROpts<'ConceptScheme', 'updatePut', UA>): MRReturn<'ConceptScheme', 'updatePut'>;
|
|
300
306
|
(opts: MROpts<'ConceptScheme', 'delete', UA>): MRReturn<'ConceptScheme', 'delete'>;
|
|
301
307
|
(opts: MROpts<'ContentType', 'get', UA>): MRReturn<'ContentType', 'get'>;
|
|
302
308
|
(opts: MROpts<'ContentType', 'getMany', UA>): MRReturn<'ContentType', 'getMany'>;
|
|
@@ -1061,11 +1067,26 @@ export type MRActions = {
|
|
|
1061
1067
|
payload: CreateConceptProps;
|
|
1062
1068
|
return: ConceptProps;
|
|
1063
1069
|
};
|
|
1070
|
+
createWithId: {
|
|
1071
|
+
params: GetConceptParams;
|
|
1072
|
+
payload: CreateConceptProps;
|
|
1073
|
+
return: ConceptProps;
|
|
1074
|
+
};
|
|
1075
|
+
patch: {
|
|
1076
|
+
params: UpdateConceptParams;
|
|
1077
|
+
payload: OpPatch[];
|
|
1078
|
+
return: ConceptProps;
|
|
1079
|
+
};
|
|
1064
1080
|
update: {
|
|
1065
1081
|
params: UpdateConceptParams;
|
|
1066
1082
|
payload: OpPatch[];
|
|
1067
1083
|
return: ConceptProps;
|
|
1068
1084
|
};
|
|
1085
|
+
updatePut: {
|
|
1086
|
+
params: UpdateConceptParams;
|
|
1087
|
+
payload: CreateConceptProps;
|
|
1088
|
+
return: ConceptProps;
|
|
1089
|
+
};
|
|
1069
1090
|
delete: {
|
|
1070
1091
|
params: DeleteConceptParams;
|
|
1071
1092
|
return: void;
|
|
@@ -1099,11 +1120,26 @@ export type MRActions = {
|
|
|
1099
1120
|
payload: CreateConceptSchemeProps;
|
|
1100
1121
|
return: ConceptSchemeProps;
|
|
1101
1122
|
};
|
|
1123
|
+
createWithId: {
|
|
1124
|
+
params: GetConceptSchemeParams;
|
|
1125
|
+
payload: CreateConceptSchemeProps;
|
|
1126
|
+
return: ConceptSchemeProps;
|
|
1127
|
+
};
|
|
1128
|
+
patch: {
|
|
1129
|
+
params: UpdateConceptSchemeParams;
|
|
1130
|
+
payload: OpPatch[];
|
|
1131
|
+
return: ConceptSchemeProps;
|
|
1132
|
+
};
|
|
1102
1133
|
update: {
|
|
1103
1134
|
params: UpdateConceptSchemeParams;
|
|
1104
1135
|
payload: OpPatch[];
|
|
1105
1136
|
return: ConceptSchemeProps;
|
|
1106
1137
|
};
|
|
1138
|
+
updatePut: {
|
|
1139
|
+
params: UpdateConceptSchemeParams;
|
|
1140
|
+
payload: CreateConceptSchemeProps;
|
|
1141
|
+
return: ConceptSchemeProps;
|
|
1142
|
+
};
|
|
1107
1143
|
get: {
|
|
1108
1144
|
params: GetConceptSchemeParams;
|
|
1109
1145
|
return: ConceptSchemeProps;
|
|
@@ -10,8 +10,8 @@ export type UploadCredentialProps = {
|
|
|
10
10
|
};
|
|
11
11
|
export interface UploadCredential extends UploadCredentialProps, DefaultElements<UploadCredentialProps> {
|
|
12
12
|
/**
|
|
13
|
-
*
|
|
14
|
-
* @return
|
|
13
|
+
* creates the upload credentials.
|
|
14
|
+
* @return upload credentials for file uploads
|
|
15
15
|
* @example
|
|
16
16
|
* const contentful = require('contentful-management')
|
|
17
17
|
*
|
|
@@ -19,12 +19,18 @@ export interface UploadCredential extends UploadCredentialProps, DefaultElements
|
|
|
19
19
|
* accessToken: '<content_management_api_key>'
|
|
20
20
|
* })
|
|
21
21
|
*
|
|
22
|
-
*
|
|
23
|
-
*
|
|
24
|
-
*
|
|
25
|
-
*
|
|
26
|
-
*
|
|
27
|
-
* .
|
|
22
|
+
* try {
|
|
23
|
+
* const space = await client.getSpace('<space_id>')
|
|
24
|
+
* const environment = await space.getEnvironment('<environment_id>')
|
|
25
|
+
*
|
|
26
|
+
* const upload = await client.uploadCredential.create({
|
|
27
|
+
* spaceId: space.sys.id,
|
|
28
|
+
* environmentId: environment.sys.id
|
|
29
|
+
* })
|
|
30
|
+
* } catch (error) {
|
|
31
|
+
* console.error(error)
|
|
32
|
+
* }
|
|
33
|
+
*
|
|
28
34
|
*/
|
|
29
35
|
create(): Promise<UploadCredentialProps>;
|
|
30
36
|
}
|
|
@@ -1,26 +1,25 @@
|
|
|
1
1
|
export * from './common-types';
|
|
2
|
-
export
|
|
2
|
+
export type { AccessToken, AccessTokenProps as AccessTokenProp, CreatePersonalAccessTokenProps as CreatePATProps, } from './entities/access-token';
|
|
3
3
|
export type { ApiKey, ApiKeyProps, CreateApiKeyProps } from './entities/api-key';
|
|
4
|
+
export type { AppAccessToken, AppAccessTokenProps, CreateAppAccessTokenProps, } from './entities/app-access-token';
|
|
4
5
|
export type { AppAction, AppActionCategoryProps, AppActionCategoryType, AppActionParameterDefinition, AppActionProps, AppActionType, CreateAppActionProps, } from './entities/app-action';
|
|
5
6
|
export type { AppActionCall, AppActionCallProps, CreateAppActionCallProps, } from './entities/app-action-call';
|
|
6
7
|
export type { AppBundle, AppBundleFile, AppBundleProps, CreateAppBundleProps, } from './entities/app-bundle';
|
|
7
8
|
export type { AppDefinition, AppDefinitionProps, AppLocation, CreateAppDefinitionProps, EntryFieldLocation, NavigationItem, PageLocation, SimpleLocation, } from './entities/app-definition';
|
|
8
9
|
export type { AppDetails, AppDetailsProps, AppIcon, CreateAppDetailsProps, IconType, } from './entities/app-details';
|
|
10
|
+
export type { AppEventSubscription, AppEventSubscriptionProps, CreateAppEventSubscriptionProps, } from './entities/app-event-subscription';
|
|
9
11
|
export type { AppInstallation, AppInstallationProps, CreateAppInstallationProps, } from './entities/app-installation';
|
|
12
|
+
export type { AppKey, AppKeyProps, CreateAppKeyProps } from './entities/app-key';
|
|
10
13
|
export type { AppSignedRequest, AppSignedRequestProps, CreateAppSignedRequestProps, } from './entities/app-signed-request';
|
|
11
14
|
export type { AppSigningSecret, AppSigningSecretProps, CreateAppSigningSecretProps, } from './entities/app-signing-secret';
|
|
12
|
-
export type { AppEventSubscription, AppEventSubscriptionProps, CreateAppEventSubscriptionProps, } from './entities/app-event-subscription';
|
|
13
|
-
export type { AppKey, AppKeyProps, CreateAppKeyProps } from './entities/app-key';
|
|
14
|
-
export type { AppAccessToken, AppAccessTokenProps, CreateAppAccessTokenProps, } from './entities/app-access-token';
|
|
15
15
|
export type { AppUpload, AppUploadProps } from './entities/app-upload';
|
|
16
16
|
export type { Asset, AssetFileProp, AssetProps, CreateAssetProps } from './entities/asset';
|
|
17
17
|
export type { AssetKey, AssetKeyProps, CreateAssetKeyProps } from './entities/asset-key';
|
|
18
18
|
export type { BulkAction, BulkActionPayload, BulkActionProps, BulkActionPublishPayload, BulkActionStatus, BulkActionType, BulkActionUnpublishPayload, BulkActionValidatePayload, } from './entities/bulk-action';
|
|
19
|
-
export type {
|
|
19
|
+
export type { Comment, CommentProps, CreateCommentProps, DeleteCommentParams, GetCommentParentEntityParams, GetManyCommentsParams, RichTextCommentDocument, RichTextCommentProps, UpdateCommentProps, } from './entities/comment';
|
|
20
20
|
export type { AnnotationAssignment, ContentType, ContentTypeMetadata, ContentTypeProps, CreateContentTypeProps, } from './entities/content-type';
|
|
21
21
|
export type { ContentFields, ContentTypeFieldValidation, ContentfulEntryResource, ExternalResource, } from './entities/content-type-fields';
|
|
22
22
|
export type { Control, Editor, EditorInterface, EditorInterfaceProps, EditorLayoutItem, FieldGroupItem, FieldItem, GroupControl, SidebarItem, } from './entities/editor-interface';
|
|
23
|
-
export type { FunctionProps } from './entities/function';
|
|
24
23
|
export type { CreateEntryProps, Entry, EntryProps, WithResourceName } from './entities/entry';
|
|
25
24
|
export type { CreateEnvironmentProps, Environment, EnvironmentProps } from './entities/environment';
|
|
26
25
|
export type { CreateEnvironmentAliasProps, EnvironmentAlias, EnvironmentAliasProps, } from './entities/environment-alias';
|
|
@@ -28,14 +27,14 @@ export type { ContentTypeTemplateProps, CreateEnvironmentTemplateProps, EditorIn
|
|
|
28
27
|
export type { CreateEnvironmentTemplateInstallationProps, EnvironmentTemplateInstallation, EnvironmentTemplateInstallationProps, EnvironmentTemplateInstallationStatus, EnvironmentTemplateValidationProps, ValidateEnvironmentTemplateInstallationProps, ValidationFinding, } from './entities/environment-template-installation';
|
|
29
28
|
export type { CreateExtensionProps as CreateUIExtensionProps, Extension as UIExtension, ExtensionProps as UIExtensionProps, } from './entities/extension';
|
|
30
29
|
export type { FieldType } from './entities/field-type';
|
|
30
|
+
export type { FunctionProps } from './entities/function';
|
|
31
31
|
export type { CreateLocaleProps, Locale, LocaleProps } from './entities/locale';
|
|
32
32
|
export type { Organization, OrganizationProp, OrganizationProps } from './entities/organization';
|
|
33
33
|
export type { CreateOrganizationInvitationProps, OrganizationInvitation, OrganizationInvitationProps, } from './entities/organization-invitation';
|
|
34
34
|
export type { OrganizationMembership, OrganizationMembershipProps, } from './entities/organization-membership';
|
|
35
35
|
export type { CreatePersonalAccessTokenProps, PersonalAccessToken, PersonalAccessTokenProp, PersonalAccessTokenProps, } from './entities/personal-access-token';
|
|
36
|
-
export type { CreatePersonalAccessTokenProps as CreatePATProps, AccessToken, AccessTokenProps as AccessTokenProp, } from './entities/access-token';
|
|
37
36
|
export type { PreviewApiKey, PreviewApiKeyProps } from './entities/preview-api-key';
|
|
38
|
-
export type { Release, ReleasePayload, ReleaseProps, ReleaseQueryOptions, ReleaseSysProps, ReleaseValidateOptions,
|
|
37
|
+
export type { Release, ReleaseMetadata, ReleasePayload, ReleaseProps, ReleaseQueryOptions, ReleaseReferenceFilters, ReleaseSysProps, ReleaseValidateOptions, } from './entities/release';
|
|
39
38
|
export type { ReleaseAction, ReleaseActionProps, ReleaseActionQueryOptions, ReleaseActionSysProps, ReleaseActionTypes, } from './entities/release-action';
|
|
40
39
|
export type { CreateRoleProps, Role, RoleProps } from './entities/role';
|
|
41
40
|
export type { ScheduledAction, ScheduledActionProps, ScheduledActionSysProps, } from './entities/scheduled-action';
|
|
@@ -50,17 +49,19 @@ export type { CreateTeamMembershipProps, TeamMembership, TeamMembershipProps, }
|
|
|
50
49
|
export type { CreateTeamSpaceMembershipProps, TeamSpaceMembership, TeamSpaceMembershipProps, } from './entities/team-space-membership';
|
|
51
50
|
export type { UIConfig, UIConfigProps } from './entities/ui-config';
|
|
52
51
|
export type { Upload, UploadProps } from './entities/upload';
|
|
52
|
+
export type { UploadCredential, UploadCredentialProps } from './entities/upload-credential';
|
|
53
53
|
export type { Usage, UsageProps } from './entities/usage';
|
|
54
54
|
export type { User, UserProps } from './entities/user';
|
|
55
55
|
export type { UserUIConfig, UserUIConfigProps } from './entities/user-ui-config';
|
|
56
|
-
export type { CreateWebhooksProps, UpdateWebhookProps, WebhookCallRequest, WebhookFilter, WebhookProps,
|
|
57
|
-
export type {
|
|
58
|
-
export
|
|
59
|
-
export
|
|
60
|
-
export type { CreateWorkflowProps, UpdateWorkflowProps, DeleteWorkflowParams, Workflow, WorkflowProps, WorkflowQueryOptions, } from './entities/workflow';
|
|
61
|
-
export type { WorkflowsChangelogEntry, WorkflowsChangelogEntryProps, WorkflowsChangelogQueryOptions, } from './entities/workflows-changelog-entry';
|
|
56
|
+
export type { CreateWebhooksProps, UpdateWebhookProps, UpsertWebhookSigningSecretPayload, WebHooks, WebhookCallRequest, WebhookFilter, WebhookProps, WebhookSigningSecretProps, WebhookTransformation, } from './entities/webhook';
|
|
57
|
+
export type { CreateWorkflowDefinitionParams, CreateWorkflowDefinitionProps, CreateWorkflowStepProps, DeleteWorkflowDefinitionParams, UpdateWorkflowDefinitionParams, UpdateWorkflowDefinitionProps, UpdateWorkflowStepProps, WorkflowDefinition, WorkflowDefinitionProps, WorkflowDefinitionQueryOptions, WorkflowDefinitionSysProps, WorkflowDefinitionValidationLink, WorkflowStepAction, WorkflowStepActionType, WorkflowStepAppAction, WorkflowStepEmailAction, WorkflowStepEmailActionRecipient, WorkflowStepPermission, WorkflowStepPermissionActors, WorkflowStepProps, WorkflowStepTaskAction, } from './entities/workflow-definition';
|
|
58
|
+
export * from './plain/common-types';
|
|
59
|
+
export { WorkflowStepPermissionAction, WorkflowStepPermissionEffect, WorkflowStepPermissionType, } from './entities/workflow-definition';
|
|
62
60
|
export type { ConceptProps, CreateConceptProps } from './entities/concept';
|
|
63
61
|
export type { ConceptSchemeProps, CreateConceptSchemeProps } from './entities/concept-scheme';
|
|
62
|
+
export type { ResourceProps, ResourceQueryOptions } from './entities/resource';
|
|
64
63
|
export type { ResourceProvider, ResourceProviderProps, UpsertResourceProviderProps, } from './entities/resource-provider';
|
|
65
64
|
export type { ResourceType, ResourceTypeProps, SpaceEnvResourceTypeProps, UpsertResourceTypeProps, } from './entities/resource-type';
|
|
66
|
-
export type {
|
|
65
|
+
export type { DefinedParameters, FreeFormParameters, InstallationParameterType, ParameterDefinition, ParameterOption, ParameterType, } from './entities/widget-parameters';
|
|
66
|
+
export type { CreateWorkflowProps, DeleteWorkflowParams, UpdateWorkflowProps, Workflow, WorkflowProps, WorkflowQueryOptions, } from './entities/workflow';
|
|
67
|
+
export type { WorkflowsChangelogEntry, WorkflowsChangelogEntryProps, WorkflowsChangelogQueryOptions, } from './entities/workflows-changelog-entry';
|
|
@@ -16,19 +16,67 @@ export type ConceptSchemePlainClientAPI = {
|
|
|
16
16
|
* ```
|
|
17
17
|
*/
|
|
18
18
|
create(params: SetOptional<GetOrganizationParams, 'organizationId'>, payload: CreateConceptSchemeProps): Promise<ConceptSchemeProps>;
|
|
19
|
+
/**
|
|
20
|
+
* Create Concept Scheme With Id
|
|
21
|
+
* @returns the created Concept Scheme
|
|
22
|
+
* @throws if the request fails
|
|
23
|
+
* @see {@link https://www.contentful.com/developers/docs/references/content-management-api/#/reference/taxonomy/create-a-concept-scheme-with-user-defined-id}
|
|
24
|
+
* @example
|
|
25
|
+
* ```javascript
|
|
26
|
+
* const concept = await client.conceptScheme.createWithId({
|
|
27
|
+
* organizationId: '<organization_id>',
|
|
28
|
+
* conceptSchemeId: '<concept_scheme_id>',
|
|
29
|
+
* }, conceptSchemeProps);
|
|
30
|
+
* ```
|
|
31
|
+
*/
|
|
32
|
+
createWithId(params: SetOptional<GetConceptSchemeParams, 'organizationId'>, payload: CreateConceptSchemeProps): Promise<ConceptSchemeProps>;
|
|
19
33
|
/**
|
|
20
34
|
* Update Concept Scheme
|
|
21
35
|
* @returns the updated Concept Scheme
|
|
22
36
|
* @throws if the request fails
|
|
23
37
|
* @see {@link https://www.contentful.com/developers/docs/references/content-management-api/#/reference/taxonomy/concept-scheme}
|
|
38
|
+
* @deprecated The behavior of this method as a PATCH is being deprecated, and will be replaced with a PUT in the next major version. Use the `patch` method instead.
|
|
24
39
|
* @example
|
|
25
40
|
* ```javascript
|
|
26
41
|
* const updatedConcept = await client.conceptScheme.update({
|
|
27
42
|
* organizationId: '<organization_id>',
|
|
43
|
+
* conceptSchemeId: '<concept_scheme_id>',
|
|
44
|
+
* version: 1,
|
|
28
45
|
* }, conceptSchemePatch);
|
|
29
46
|
* ```
|
|
30
47
|
*/
|
|
31
48
|
update(params: SetOptional<UpdateConceptSchemeParams, 'organizationId'>, payload: OpPatch[]): Promise<ConceptSchemeProps>;
|
|
49
|
+
/**
|
|
50
|
+
* Update Concept Scheme with PUT
|
|
51
|
+
* @returns the updated Concept Scheme
|
|
52
|
+
* @throws if the request fails
|
|
53
|
+
* @see {@link https://www.contentful.com/developers/docs/references/content-management-api/#/reference/taxonomy/concept-scheme}
|
|
54
|
+
* @deprecated In the next major version, this method will be replaced with the standard `update` method which will be updated to use PUT instead of PATCH.
|
|
55
|
+
* @example
|
|
56
|
+
* ```javascript
|
|
57
|
+
* const updatedConcept = await client.conceptScheme.update({
|
|
58
|
+
* organizationId: '<organization_id>',
|
|
59
|
+
* conceptSchemeId: '<concept_scheme_id>',
|
|
60
|
+
* version: 1,
|
|
61
|
+
* }, CreateConceptSchemeProps);
|
|
62
|
+
* ```
|
|
63
|
+
*/
|
|
64
|
+
updatePut(params: SetOptional<UpdateConceptSchemeParams, 'organizationId'>, payload: CreateConceptSchemeProps): Promise<ConceptSchemeProps>;
|
|
65
|
+
/**
|
|
66
|
+
* Update Concept Scheme
|
|
67
|
+
* @returns the updated Concept Scheme
|
|
68
|
+
* @throws if the request fails
|
|
69
|
+
* @see {@link https://www.contentful.com/developers/docs/references/content-management-api/#/reference/taxonomy/concept-scheme}
|
|
70
|
+
* @example
|
|
71
|
+
* ```javascript
|
|
72
|
+
* const updatedConcept = await client.conceptScheme.patch({
|
|
73
|
+
* organizationId: '<organization_id>',
|
|
74
|
+
* conceptSchemeId: '<concept_scheme_id>',
|
|
75
|
+
* version: 1,
|
|
76
|
+
* }, conceptSchemePatch);
|
|
77
|
+
* ```
|
|
78
|
+
*/
|
|
79
|
+
patch(params: SetOptional<UpdateConceptSchemeParams, 'organizationId'>, payload: OpPatch[]): Promise<ConceptSchemeProps>;
|
|
32
80
|
/**
|
|
33
81
|
* Get Concept Scheme
|
|
34
82
|
* @returns the Concept Scheme
|
|
@@ -16,19 +16,67 @@ export type ConceptPlainClientAPI = {
|
|
|
16
16
|
* ```
|
|
17
17
|
*/
|
|
18
18
|
create(params: SetOptional<GetOrganizationParams, 'organizationId'>, payload: CreateConceptProps): Promise<ConceptProps>;
|
|
19
|
+
/**
|
|
20
|
+
* Create Concept With Id
|
|
21
|
+
* @returns ConceptProps
|
|
22
|
+
* @throws if the request fails
|
|
23
|
+
* @see {@link https://www.contentful.com/developers/docs/references/content-management-api/#/reference/taxonomy/create-a-concept-with-user-defined-id}
|
|
24
|
+
* @example
|
|
25
|
+
* ```javascript
|
|
26
|
+
* const concept = await client.concept.createWithId({
|
|
27
|
+
* organizationId: '<organization_id>',
|
|
28
|
+
* conceptId: '<concept_id>',
|
|
29
|
+
* }, conceptProps);
|
|
30
|
+
* ```
|
|
31
|
+
*/
|
|
32
|
+
createWithId(params: SetOptional<GetConceptParams, 'organizationId'>, payload: CreateConceptProps): Promise<ConceptProps>;
|
|
19
33
|
/**
|
|
20
34
|
* Update Concept
|
|
21
35
|
* @returns the updated Concept
|
|
22
36
|
* @throws if the request fails
|
|
23
37
|
* @see {@link https://www.contentful.com/developers/docs/references/content-management-api/#/reference/taxonomy/concept}
|
|
38
|
+
* @deprecated The behavior of this method as a PATCH is being deprecated, and will be replaced with a PUT in the next major version. Use the `patch` method instead.
|
|
24
39
|
* @example
|
|
25
40
|
* ```javascript
|
|
26
41
|
* const updatedConcept = await client.concept.update({
|
|
27
42
|
* organizationId: '<organization_id>',
|
|
43
|
+
* conceptId: '<concept_id>',
|
|
44
|
+
* version: 1,
|
|
28
45
|
* }, patch);
|
|
29
46
|
* ```
|
|
30
47
|
*/
|
|
31
48
|
update(params: SetOptional<UpdateConceptParams, 'organizationId'>, payload: OpPatch[]): Promise<ConceptProps>;
|
|
49
|
+
/**
|
|
50
|
+
* Update Concept with PUT
|
|
51
|
+
* @returns the updated Concept
|
|
52
|
+
* @throws if the request fails
|
|
53
|
+
* @see {@link https://www.contentful.com/developers/docs/references/content-management-api/#/reference/taxonomy/concept}
|
|
54
|
+
* @deprecated In the next major version, this method will be replaced with the standard `update` method which will be updated to use PUT instead of PATCH.
|
|
55
|
+
* @example
|
|
56
|
+
* ```javascript
|
|
57
|
+
* const updatedConcept = await client.concept.updatePut({
|
|
58
|
+
* organizationId: '<organization_id>',
|
|
59
|
+
* conceptId: '<concept_id>',
|
|
60
|
+
* version: 1,
|
|
61
|
+
* }, patch);
|
|
62
|
+
* ```
|
|
63
|
+
*/
|
|
64
|
+
updatePut(params: SetOptional<UpdateConceptParams, 'organizationId'>, payload: CreateConceptProps): Promise<ConceptProps>;
|
|
65
|
+
/**
|
|
66
|
+
* Update Concept
|
|
67
|
+
* @returns the updated Concept
|
|
68
|
+
* @throws if the request fails
|
|
69
|
+
* @see {@link https://www.contentful.com/developers/docs/references/content-management-api/#/reference/taxonomy/concept}
|
|
70
|
+
* @example
|
|
71
|
+
* ```javascript
|
|
72
|
+
* const updatedConcept = await client.concept.patch({
|
|
73
|
+
* organizationId: '<organization_id>',
|
|
74
|
+
* conceptId: '<concept_id>',
|
|
75
|
+
* version: 1,
|
|
76
|
+
* }, patch);
|
|
77
|
+
* ```
|
|
78
|
+
*/
|
|
79
|
+
patch(params: SetOptional<UpdateConceptParams, 'organizationId'>, payload: OpPatch[]): Promise<ConceptProps>;
|
|
32
80
|
/**
|
|
33
81
|
* Get Concept
|
|
34
82
|
* @returns the Concept
|
package/package.json
CHANGED
|
@@ -1,6 +1,6 @@
|
|
|
1
1
|
{
|
|
2
2
|
"name": "contentful-management",
|
|
3
|
-
"version": "11.
|
|
3
|
+
"version": "11.39.0",
|
|
4
4
|
"description": "Client for Contentful's Content Management API",
|
|
5
5
|
"homepage": "https://www.contentful.com/developers/documentation/content-management-api/",
|
|
6
6
|
"main": "./dist/contentful-management.node.js",
|