contentful-management 11.35.0 → 11.36.0-beta.1
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 +13 -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 +14 -10
- 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/access-token.js +5 -5
- package/dist/es-modules/contentful-management.js +1 -1
- package/dist/es-modules/create-environment-api.js +5 -2
- package/dist/es-modules/entities/scheduled-action.js +2 -2
- package/dist/typings/adapters/REST/endpoints/access-token.d.ts +5 -5
- package/dist/typings/common-types.d.ts +16 -16
- package/dist/typings/create-contentful-api.d.ts +3 -3
- package/dist/typings/create-environment-api.d.ts +1 -1
- package/dist/typings/entities/access-token.d.ts +4 -4
- package/dist/typings/entities/organization.d.ts +4 -4
- package/dist/typings/entities/personal-access-token.d.ts +4 -4
- package/dist/typings/entities/release-action.d.ts +1 -0
- package/dist/typings/entities/scheduled-action.d.ts +1 -1
- package/dist/typings/export-types.d.ts +3 -3
- package/dist/typings/plain/common-types.d.ts +11 -11
- package/dist/typings/plain/entities/organization.d.ts +3 -3
- package/dist/typings/plain/entities/resource-provider.d.ts +14 -11
- package/dist/typings/plain/entities/resource.d.ts +9 -7
- package/package.json +1 -1
|
@@ -6,7 +6,7 @@ import * as raw from './raw';
|
|
|
6
6
|
* @param {AxiosInstance} http - An Axios HTTP client instance.
|
|
7
7
|
* @param {Object} params - Parameters for the request.
|
|
8
8
|
* @param {string} params.tokenId - The unique token ID of the access token to retrieve.
|
|
9
|
-
* @returns {Promise<
|
|
9
|
+
* @returns {Promise<AccessTokenProps>} A Promise that resolves with the retrieved access token information.
|
|
10
10
|
* @example ```javascript
|
|
11
11
|
* const contentful = require('contentful-management')
|
|
12
12
|
*
|
|
@@ -30,7 +30,7 @@ export const get = (http, params) => {
|
|
|
30
30
|
*
|
|
31
31
|
* @param {AxiosInstance} http - An Axios HTTP client instance.
|
|
32
32
|
* @param {QueryParams} params - Query parameters to filter and customize the request.
|
|
33
|
-
* @returns {Promise<CollectionProp<
|
|
33
|
+
* @returns {Promise<CollectionProp<AccessTokenProps>>} A Promise that resolves with a collection of access token properties.
|
|
34
34
|
* @example ```javascript
|
|
35
35
|
* const contentful = require('contentful-management')
|
|
36
36
|
*
|
|
@@ -58,7 +58,7 @@ export const getMany = (http, params) => {
|
|
|
58
58
|
* @param {Object} _params - Unused parameters (can be an empty object).
|
|
59
59
|
* @param {CreatePersonalAccessTokenProps} rawData - Data for creating the personal access token.
|
|
60
60
|
* @param {RawAxiosRequestHeaders} [headers] - Optional HTTP headers for the request.
|
|
61
|
-
* @returns {Promise<
|
|
61
|
+
* @returns {Promise<AccessTokenProps>} A Promise that resolves with the created personal access token.
|
|
62
62
|
* @example ```javascript
|
|
63
63
|
* const contentful = require('contentful-management')
|
|
64
64
|
*
|
|
@@ -85,7 +85,7 @@ export const createPersonalAccessToken = (http, _params, rawData, headers) => {
|
|
|
85
85
|
* @param {AxiosInstance} http - The Axios HTTP client instance.
|
|
86
86
|
* @param {Object} params - The parameters for revoking the access token.
|
|
87
87
|
* @param {string} params.tokenId - The unique identifier of the access token to revoke.
|
|
88
|
-
* @returns {Promise<
|
|
88
|
+
* @returns {Promise<AccessTokenProps>} A Promise that resolves with the updated access token information after revocation.
|
|
89
89
|
* @example ```javascript
|
|
90
90
|
* const contentful = require('contentful-management')
|
|
91
91
|
*
|
|
@@ -110,7 +110,7 @@ export const revoke = (http, params) => {
|
|
|
110
110
|
* @param {AxiosInstance} http - The Axios HTTP client instance.
|
|
111
111
|
* @param {GetOrganizationParams & QueryParams} params - Parameters for the request, including organization ID and query parameters.
|
|
112
112
|
* @param {string} params.organizationId - The unique identifier of the organization.
|
|
113
|
-
* @returns {Promise<CollectionProp<
|
|
113
|
+
* @returns {Promise<CollectionProp<AccessTokenProps>>} A promise that resolves to a collection of access tokens.
|
|
114
114
|
* @example ```javascript
|
|
115
115
|
* const contentful = require('contentful-management')
|
|
116
116
|
*
|
|
@@ -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.36.0-beta.1"}`, params.application, params.integration, params.feature);
|
|
50
50
|
const adapter = createAdapter(_objectSpread(_objectSpread({}, params), {}, {
|
|
51
51
|
userAgent
|
|
52
52
|
}));
|
|
@@ -1239,14 +1239,17 @@ export default function createEnvironmentApi(makeRequest) {
|
|
|
1239
1239
|
* .catch(console.error)
|
|
1240
1240
|
* ```
|
|
1241
1241
|
*/
|
|
1242
|
-
getLocales() {
|
|
1242
|
+
getLocales(query = {}) {
|
|
1243
1243
|
const raw = this.toPlainObject();
|
|
1244
1244
|
return makeRequest({
|
|
1245
1245
|
entityType: 'Locale',
|
|
1246
1246
|
action: 'getMany',
|
|
1247
1247
|
params: {
|
|
1248
1248
|
spaceId: raw.sys.space.sys.id,
|
|
1249
|
-
environmentId: raw.sys.id
|
|
1249
|
+
environmentId: raw.sys.id,
|
|
1250
|
+
query: createRequestConfig({
|
|
1251
|
+
query
|
|
1252
|
+
}).params
|
|
1250
1253
|
}
|
|
1251
1254
|
}).then(data => wrapLocaleCollection(makeRequest, data));
|
|
1252
1255
|
},
|
|
@@ -9,14 +9,14 @@ import enhanceWithMethods from '../enhance-with-methods';
|
|
|
9
9
|
/**
|
|
10
10
|
* Represents that state of the scheduled action
|
|
11
11
|
*/
|
|
12
|
-
|
|
12
|
+
export let ScheduledActionStatus = /*#__PURE__*/function (ScheduledActionStatus) {
|
|
13
13
|
ScheduledActionStatus["scheduled"] = "scheduled";
|
|
14
14
|
ScheduledActionStatus["inProgress"] = "inProgress";
|
|
15
15
|
ScheduledActionStatus["succeeded"] = "succeeded";
|
|
16
16
|
ScheduledActionStatus["failed"] = "failed";
|
|
17
17
|
ScheduledActionStatus["canceled"] = "canceled";
|
|
18
18
|
return ScheduledActionStatus;
|
|
19
|
-
}(
|
|
19
|
+
}({});
|
|
20
20
|
export default function getInstanceMethods(makeRequest) {
|
|
21
21
|
const getParams = self => {
|
|
22
22
|
var _scheduledAction$envi;
|
|
@@ -5,7 +5,7 @@ import type { RestEndpoint } from '../types';
|
|
|
5
5
|
* @param {AxiosInstance} http - An Axios HTTP client instance.
|
|
6
6
|
* @param {Object} params - Parameters for the request.
|
|
7
7
|
* @param {string} params.tokenId - The unique token ID of the access token to retrieve.
|
|
8
|
-
* @returns {Promise<
|
|
8
|
+
* @returns {Promise<AccessTokenProps>} A Promise that resolves with the retrieved access token information.
|
|
9
9
|
* @example ```javascript
|
|
10
10
|
* const contentful = require('contentful-management')
|
|
11
11
|
*
|
|
@@ -26,7 +26,7 @@ export declare const get: RestEndpoint<'AccessToken', 'get'>;
|
|
|
26
26
|
*
|
|
27
27
|
* @param {AxiosInstance} http - An Axios HTTP client instance.
|
|
28
28
|
* @param {QueryParams} params - Query parameters to filter and customize the request.
|
|
29
|
-
* @returns {Promise<CollectionProp<
|
|
29
|
+
* @returns {Promise<CollectionProp<AccessTokenProps>>} A Promise that resolves with a collection of access token properties.
|
|
30
30
|
* @example ```javascript
|
|
31
31
|
* const contentful = require('contentful-management')
|
|
32
32
|
*
|
|
@@ -49,7 +49,7 @@ export declare const getMany: RestEndpoint<'AccessToken', 'getMany'>;
|
|
|
49
49
|
* @param {Object} _params - Unused parameters (can be an empty object).
|
|
50
50
|
* @param {CreatePersonalAccessTokenProps} rawData - Data for creating the personal access token.
|
|
51
51
|
* @param {RawAxiosRequestHeaders} [headers] - Optional HTTP headers for the request.
|
|
52
|
-
* @returns {Promise<
|
|
52
|
+
* @returns {Promise<AccessTokenProps>} A Promise that resolves with the created personal access token.
|
|
53
53
|
* @example ```javascript
|
|
54
54
|
* const contentful = require('contentful-management')
|
|
55
55
|
*
|
|
@@ -71,7 +71,7 @@ export declare const createPersonalAccessToken: RestEndpoint<'AccessToken', 'cre
|
|
|
71
71
|
* @param {AxiosInstance} http - The Axios HTTP client instance.
|
|
72
72
|
* @param {Object} params - The parameters for revoking the access token.
|
|
73
73
|
* @param {string} params.tokenId - The unique identifier of the access token to revoke.
|
|
74
|
-
* @returns {Promise<
|
|
74
|
+
* @returns {Promise<AccessTokenProps>} A Promise that resolves with the updated access token information after revocation.
|
|
75
75
|
* @example ```javascript
|
|
76
76
|
* const contentful = require('contentful-management')
|
|
77
77
|
*
|
|
@@ -93,7 +93,7 @@ export declare const revoke: RestEndpoint<'AccessToken', 'revoke'>;
|
|
|
93
93
|
* @param {AxiosInstance} http - The Axios HTTP client instance.
|
|
94
94
|
* @param {GetOrganizationParams & QueryParams} params - Parameters for the request, including organization ID and query parameters.
|
|
95
95
|
* @param {string} params.organizationId - The unique identifier of the organization.
|
|
96
|
-
* @returns {Promise<CollectionProp<
|
|
96
|
+
* @returns {Promise<CollectionProp<AccessTokenProps>>} A promise that resolves to a collection of access tokens.
|
|
97
97
|
* @example ```javascript
|
|
98
98
|
* const contentful = require('contentful-management')
|
|
99
99
|
*
|
|
@@ -16,11 +16,11 @@ import type { CreateEnvironmentProps, EnvironmentProps } from './entities/enviro
|
|
|
16
16
|
import type { CreateEnvironmentAliasProps, EnvironmentAliasProps } from './entities/environment-alias';
|
|
17
17
|
import type { CreateLocaleProps, LocaleProps } from './entities/locale';
|
|
18
18
|
import type { AppInstallationsForOrganizationProps } from './entities/app-definition';
|
|
19
|
-
import type {
|
|
19
|
+
import type { OrganizationProps } from './entities/organization';
|
|
20
20
|
import type { CreateOrganizationInvitationProps, OrganizationInvitationProps } from './entities/organization-invitation';
|
|
21
21
|
import type { OrganizationMembershipProps } from './entities/organization-membership';
|
|
22
|
-
import type { CreatePersonalAccessTokenProps,
|
|
23
|
-
import type {
|
|
22
|
+
import type { CreatePersonalAccessTokenProps, PersonalAccessTokenProps } from './entities/personal-access-token';
|
|
23
|
+
import type { AccessTokenProps, CreatePersonalAccessTokenProps as CreatePATProps } from './entities/access-token';
|
|
24
24
|
import type { PreviewApiKeyProps } from './entities/preview-api-key';
|
|
25
25
|
import type { CreateRoleProps, RoleProps } from './entities/role';
|
|
26
26
|
import type { ScheduledActionProps } from './entities/scheduled-action';
|
|
@@ -126,7 +126,6 @@ export interface BasicMetaSysProps {
|
|
|
126
126
|
}
|
|
127
127
|
export interface MetaSysProps extends BasicMetaSysProps {
|
|
128
128
|
space?: SysLink;
|
|
129
|
-
status?: SysLink;
|
|
130
129
|
publishedVersion?: number;
|
|
131
130
|
archivedVersion?: number;
|
|
132
131
|
archivedBy?: SysLink;
|
|
@@ -137,7 +136,7 @@ export interface MetaSysProps extends BasicMetaSysProps {
|
|
|
137
136
|
}
|
|
138
137
|
export interface EntityMetaSysProps extends MetaSysProps {
|
|
139
138
|
space: SysLink;
|
|
140
|
-
|
|
139
|
+
status?: SysLink;
|
|
141
140
|
environment: SysLink;
|
|
142
141
|
publishedBy?: Link<'User'> | Link<'AppDefinition'>;
|
|
143
142
|
publishedAt?: string;
|
|
@@ -146,6 +145,7 @@ export interface EntityMetaSysProps extends MetaSysProps {
|
|
|
146
145
|
locale?: string;
|
|
147
146
|
}
|
|
148
147
|
export interface EntryMetaSysProps extends EntityMetaSysProps {
|
|
148
|
+
contentType: SysLink;
|
|
149
149
|
automationTags: Link<'Tag'>[];
|
|
150
150
|
}
|
|
151
151
|
export interface MetaLinkProps {
|
|
@@ -1471,11 +1471,11 @@ export type MRActions = {
|
|
|
1471
1471
|
Organization: {
|
|
1472
1472
|
getMany: {
|
|
1473
1473
|
params: PaginationQueryParams;
|
|
1474
|
-
return: CollectionProp<
|
|
1474
|
+
return: CollectionProp<OrganizationProps>;
|
|
1475
1475
|
};
|
|
1476
1476
|
get: {
|
|
1477
1477
|
params: GetOrganizationParams;
|
|
1478
|
-
return:
|
|
1478
|
+
return: OrganizationProps;
|
|
1479
1479
|
};
|
|
1480
1480
|
};
|
|
1481
1481
|
OrganizationInvitation: {
|
|
@@ -1521,23 +1521,23 @@ export type MRActions = {
|
|
|
1521
1521
|
params: {
|
|
1522
1522
|
tokenId: string;
|
|
1523
1523
|
};
|
|
1524
|
-
return:
|
|
1524
|
+
return: PersonalAccessTokenProps;
|
|
1525
1525
|
};
|
|
1526
1526
|
getMany: {
|
|
1527
1527
|
params: QueryParams;
|
|
1528
|
-
return: CollectionProp<
|
|
1528
|
+
return: CollectionProp<PersonalAccessTokenProps>;
|
|
1529
1529
|
};
|
|
1530
1530
|
create: {
|
|
1531
1531
|
params: {};
|
|
1532
1532
|
payload: CreatePersonalAccessTokenProps;
|
|
1533
1533
|
headers?: RawAxiosRequestHeaders;
|
|
1534
|
-
return:
|
|
1534
|
+
return: PersonalAccessTokenProps;
|
|
1535
1535
|
};
|
|
1536
1536
|
revoke: {
|
|
1537
1537
|
params: {
|
|
1538
1538
|
tokenId: string;
|
|
1539
1539
|
};
|
|
1540
|
-
return:
|
|
1540
|
+
return: PersonalAccessTokenProps;
|
|
1541
1541
|
};
|
|
1542
1542
|
};
|
|
1543
1543
|
AccessToken: {
|
|
@@ -1545,27 +1545,27 @@ export type MRActions = {
|
|
|
1545
1545
|
params: {
|
|
1546
1546
|
tokenId: string;
|
|
1547
1547
|
};
|
|
1548
|
-
return:
|
|
1548
|
+
return: AccessTokenProps;
|
|
1549
1549
|
};
|
|
1550
1550
|
getMany: {
|
|
1551
1551
|
params: QueryParams;
|
|
1552
|
-
return: CollectionProp<
|
|
1552
|
+
return: CollectionProp<AccessTokenProps>;
|
|
1553
1553
|
};
|
|
1554
1554
|
createPersonalAccessToken: {
|
|
1555
1555
|
params: {};
|
|
1556
1556
|
payload: CreatePATProps;
|
|
1557
1557
|
headers?: RawAxiosRequestHeaders;
|
|
1558
|
-
return:
|
|
1558
|
+
return: AccessTokenProps;
|
|
1559
1559
|
};
|
|
1560
1560
|
revoke: {
|
|
1561
1561
|
params: {
|
|
1562
1562
|
tokenId: string;
|
|
1563
1563
|
};
|
|
1564
|
-
return:
|
|
1564
|
+
return: AccessTokenProps;
|
|
1565
1565
|
};
|
|
1566
1566
|
getManyForOrganization: {
|
|
1567
1567
|
params: GetOrganizationParams & QueryParams;
|
|
1568
|
-
return: CollectionProp<
|
|
1568
|
+
return: CollectionProp<AccessTokenProps>;
|
|
1569
1569
|
};
|
|
1570
1570
|
};
|
|
1571
1571
|
PreviewApiKey: {
|
|
@@ -1,5 +1,5 @@
|
|
|
1
1
|
import type { Collection, MakeRequest, PaginationQueryParams, QueryOptions, QueryParams, GetAppDefinitionParams, CursorPaginatedCollection, GetEnvironmentTemplateParams, BasicCursorPaginationOptions } from './common-types';
|
|
2
|
-
import type { Organization,
|
|
2
|
+
import type { Organization, OrganizationProps } from './entities/organization';
|
|
3
3
|
import type { CreatePersonalAccessTokenProps } from './entities/personal-access-token';
|
|
4
4
|
import type { Space, SpaceProps } from './entities/space';
|
|
5
5
|
import type { AppDefinition } from './entities/app-definition';
|
|
@@ -165,7 +165,7 @@ export default function createClientApi(makeRequest: MakeRequest): {
|
|
|
165
165
|
* .catch(console.error)
|
|
166
166
|
* ```
|
|
167
167
|
*/
|
|
168
|
-
getOrganizations: (query?: PaginationQueryParams["query"]) => Promise<Collection<Organization,
|
|
168
|
+
getOrganizations: (query?: PaginationQueryParams["query"]) => Promise<Collection<Organization, OrganizationProps>>;
|
|
169
169
|
/**
|
|
170
170
|
* Gets the authenticated user
|
|
171
171
|
* @return Promise for a User
|
|
@@ -260,7 +260,7 @@ export default function createClientApi(makeRequest: MakeRequest): {
|
|
|
260
260
|
* .catch(console.error)
|
|
261
261
|
* ```
|
|
262
262
|
*/
|
|
263
|
-
getPersonalAccessTokens: () => Promise<Collection<import("./entities/personal-access-token").PersonalAccessToken, import("./entities/personal-access-token").
|
|
263
|
+
getPersonalAccessTokens: () => Promise<Collection<import("./entities/personal-access-token").PersonalAccessToken, import("./entities/personal-access-token").PersonalAccessTokenProps>>;
|
|
264
264
|
/**
|
|
265
265
|
* Gets a users access token
|
|
266
266
|
* @param data - users access token config
|
|
@@ -843,7 +843,7 @@ export default function createEnvironmentApi(makeRequest: MakeRequest): {
|
|
|
843
843
|
* .catch(console.error)
|
|
844
844
|
* ```
|
|
845
845
|
*/
|
|
846
|
-
getLocales(): Promise<import("./common-types").Collection<import("./entities/locale").Locale, import("./entities/locale").LocaleProps>>;
|
|
846
|
+
getLocales(query?: BasicQueryOptions): Promise<import("./common-types").Collection<import("./entities/locale").Locale, import("./entities/locale").LocaleProps>>;
|
|
847
847
|
/**
|
|
848
848
|
* Creates a Locale
|
|
849
849
|
* @param data - Object representation of the Locale to be created
|
|
@@ -10,7 +10,7 @@ type AccessTokenSysProps = BasicMetaSysProps & {
|
|
|
10
10
|
lastUsedAt: string | null;
|
|
11
11
|
redactedValue: string;
|
|
12
12
|
};
|
|
13
|
-
export type
|
|
13
|
+
export type AccessTokenProps = {
|
|
14
14
|
sys: AccessTokenSysProps;
|
|
15
15
|
name: string;
|
|
16
16
|
scopes: 'content_management_manage'[];
|
|
@@ -20,7 +20,7 @@ export type AccessTokenProp = {
|
|
|
20
20
|
export type CreatePersonalAccessTokenProps = Pick<AccessToken, 'name' | 'scopes'> & {
|
|
21
21
|
expiresIn: number;
|
|
22
22
|
};
|
|
23
|
-
export interface AccessToken extends
|
|
23
|
+
export interface AccessToken extends AccessTokenProps, DefaultElements<AccessTokenProps> {
|
|
24
24
|
/**
|
|
25
25
|
* Revokes access token
|
|
26
26
|
* @return Object the revoked access token
|
|
@@ -46,12 +46,12 @@ export interface AccessToken extends AccessTokenProp, DefaultElements<AccessToke
|
|
|
46
46
|
* @param data - Raw access token data
|
|
47
47
|
* @return Wrapped access token
|
|
48
48
|
*/
|
|
49
|
-
export declare function wrapAccessToken(makeRequest: MakeRequest, data:
|
|
49
|
+
export declare function wrapAccessToken(makeRequest: MakeRequest, data: AccessTokenProps): AccessToken;
|
|
50
50
|
/**
|
|
51
51
|
* @private
|
|
52
52
|
* @param makeRequest - function to make requests via an adapter
|
|
53
53
|
* @param data - Raw access collection data
|
|
54
54
|
* @return Wrapped access token collection data
|
|
55
55
|
*/
|
|
56
|
-
export declare const wrapAccessTokenCollection: (makeRequest: MakeRequest, data: import("../common-types").CollectionProp<
|
|
56
|
+
export declare const wrapAccessTokenCollection: (makeRequest: MakeRequest, data: import("../common-types").CollectionProp<AccessTokenProps>) => import("../common-types").Collection<AccessToken, AccessTokenProps>;
|
|
57
57
|
export {};
|
|
@@ -1,7 +1,7 @@
|
|
|
1
1
|
import type { ContentfulOrganizationAPI } from '../create-organization-api';
|
|
2
2
|
import type { MetaSysProps, DefaultElements, MakeRequest } from '../common-types';
|
|
3
|
-
export type Organization = DefaultElements<
|
|
4
|
-
export type
|
|
3
|
+
export type Organization = DefaultElements<OrganizationProps> & OrganizationProps & ContentfulOrganizationAPI;
|
|
4
|
+
export type OrganizationProps = {
|
|
5
5
|
/**
|
|
6
6
|
* System metadata
|
|
7
7
|
*/
|
|
@@ -21,9 +21,9 @@ export type OrganizationProp = {
|
|
|
21
21
|
* @param data - API response for an Organization
|
|
22
22
|
* @return {Organization}
|
|
23
23
|
*/
|
|
24
|
-
export declare function wrapOrganization(makeRequest: MakeRequest, data:
|
|
24
|
+
export declare function wrapOrganization(makeRequest: MakeRequest, data: OrganizationProps): Organization;
|
|
25
25
|
/**
|
|
26
26
|
* This method normalizes each organization in a collection.
|
|
27
27
|
* @private
|
|
28
28
|
*/
|
|
29
|
-
export declare const wrapOrganizationCollection: (makeRequest: MakeRequest, data: import("../common-types").CollectionProp<
|
|
29
|
+
export declare const wrapOrganizationCollection: (makeRequest: MakeRequest, data: import("../common-types").CollectionProp<OrganizationProps>) => import("../common-types").Collection<Organization, OrganizationProps>;
|
|
@@ -1,5 +1,5 @@
|
|
|
1
1
|
import type { MetaSysProps, DefaultElements, MakeRequest } from '../common-types';
|
|
2
|
-
export type
|
|
2
|
+
export type PersonalAccessTokenProps = {
|
|
3
3
|
sys: MetaSysProps & {
|
|
4
4
|
expiresAt?: string;
|
|
5
5
|
};
|
|
@@ -11,7 +11,7 @@ export type PersonalAccessTokenProp = {
|
|
|
11
11
|
export type CreatePersonalAccessTokenProps = Pick<PersonalAccessToken, 'name' | 'scopes'> & {
|
|
12
12
|
expiresIn?: number;
|
|
13
13
|
};
|
|
14
|
-
export interface PersonalAccessToken extends
|
|
14
|
+
export interface PersonalAccessToken extends PersonalAccessTokenProps, DefaultElements<PersonalAccessTokenProps> {
|
|
15
15
|
/**
|
|
16
16
|
* Revokes a personal access token
|
|
17
17
|
* @return Object the revoked personal access token
|
|
@@ -37,11 +37,11 @@ export interface PersonalAccessToken extends PersonalAccessTokenProp, DefaultEle
|
|
|
37
37
|
* @param data - Raw personal access token data
|
|
38
38
|
* @return Wrapped personal access token
|
|
39
39
|
*/
|
|
40
|
-
export declare function wrapPersonalAccessToken(makeRequest: MakeRequest, data:
|
|
40
|
+
export declare function wrapPersonalAccessToken(makeRequest: MakeRequest, data: PersonalAccessTokenProps): PersonalAccessToken;
|
|
41
41
|
/**
|
|
42
42
|
* @private
|
|
43
43
|
* @param makeRequest - function to make requests via an adapter
|
|
44
44
|
* @param data - Raw personal access collection data
|
|
45
45
|
* @return Wrapped personal access token collection data
|
|
46
46
|
*/
|
|
47
|
-
export declare const wrapPersonalAccessTokenCollection: (makeRequest: MakeRequest, data: import("../common-types").CollectionProp<
|
|
47
|
+
export declare const wrapPersonalAccessTokenCollection: (makeRequest: MakeRequest, data: import("../common-types").CollectionProp<PersonalAccessTokenProps>) => import("../common-types").Collection<PersonalAccessToken, PersonalAccessTokenProps>;
|
|
@@ -2,7 +2,7 @@ import type { DefaultElements, ISO8601Timestamp, MetaLinkProps, Link, MakeReques
|
|
|
2
2
|
/**
|
|
3
3
|
* Represents that state of the scheduled action
|
|
4
4
|
*/
|
|
5
|
-
declare enum ScheduledActionStatus {
|
|
5
|
+
export declare enum ScheduledActionStatus {
|
|
6
6
|
/** action is pending execution */
|
|
7
7
|
scheduled = "scheduled",
|
|
8
8
|
/** action has been started and pending completion */
|
|
@@ -29,11 +29,11 @@ export type { CreateEnvironmentTemplateInstallationProps, EnvironmentTemplateIns
|
|
|
29
29
|
export type { CreateExtensionProps as CreateUIExtensionProps, Extension as UIExtension, ExtensionProps as UIExtensionProps, } from './entities/extension';
|
|
30
30
|
export type { FieldType } from './entities/field-type';
|
|
31
31
|
export type { CreateLocaleProps, Locale, LocaleProps } from './entities/locale';
|
|
32
|
-
export type { Organization,
|
|
32
|
+
export type { Organization, 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
|
-
export type { CreatePersonalAccessTokenProps, PersonalAccessToken, PersonalAccessTokenProp, } from './entities/personal-access-token';
|
|
36
|
-
export type { CreatePersonalAccessTokenProps as CreatePATProps, AccessToken, AccessTokenProp, } from './entities/access-token';
|
|
35
|
+
export type { CreatePersonalAccessTokenProps, PersonalAccessToken, PersonalAccessTokenProps as PersonalAccessTokenProp, } from './entities/personal-access-token';
|
|
36
|
+
export type { CreatePersonalAccessTokenProps as CreatePATProps, AccessToken, AccessTokenProps as AccessTokenProp, } from './entities/access-token';
|
|
37
37
|
export type { PreviewApiKey, PreviewApiKeyProps } from './entities/preview-api-key';
|
|
38
38
|
export type { Release, ReleasePayload, ReleaseProps, ReleaseQueryOptions, ReleaseSysProps, ReleaseValidateOptions, ReleaseMetadata, ReleaseReferenceFilters, } from './entities/release';
|
|
39
39
|
export type { ReleaseAction, ReleaseActionProps, ReleaseActionQueryOptions, ReleaseActionSysProps, ReleaseActionTypes, } from './entities/release-action';
|
|
@@ -7,8 +7,8 @@ import type { ContentTypeProps, CreateContentTypeProps } from '../entities/conte
|
|
|
7
7
|
import type { CreateEntryProps, EntryProps, EntryReferenceProps } from '../entities/entry';
|
|
8
8
|
import type { CreateOrganizationInvitationProps, OrganizationInvitationProps } from '../entities/organization-invitation';
|
|
9
9
|
import type { OrganizationMembershipProps } from '../entities/organization-membership';
|
|
10
|
-
import type { CreatePersonalAccessTokenProps,
|
|
11
|
-
import type {
|
|
10
|
+
import type { CreatePersonalAccessTokenProps, PersonalAccessTokenProps } from '../entities/personal-access-token';
|
|
11
|
+
import type { AccessTokenProps, CreatePersonalAccessTokenProps as CreatePATProps } from '../entities/access-token';
|
|
12
12
|
import type { PreviewApiKeyProps } from '../entities/preview-api-key';
|
|
13
13
|
import type { CreateUpdateScheduledActionProps, ScheduledActionProps } from '../entities/scheduled-action';
|
|
14
14
|
import type { SnapshotProps } from '../entities/snapshot';
|
|
@@ -234,23 +234,23 @@ export type PlainClientAPI = {
|
|
|
234
234
|
personalAccessToken: {
|
|
235
235
|
get(params: OptionalDefaults<{
|
|
236
236
|
tokenId: string;
|
|
237
|
-
}>): Promise<
|
|
238
|
-
getMany(params: OptionalDefaults<QueryParams>): Promise<CollectionProp<
|
|
239
|
-
create(rawData: CreatePersonalAccessTokenProps, headers?: RawAxiosRequestHeaders): Promise<
|
|
237
|
+
}>): Promise<PersonalAccessTokenProps>;
|
|
238
|
+
getMany(params: OptionalDefaults<QueryParams>): Promise<CollectionProp<PersonalAccessTokenProps>>;
|
|
239
|
+
create(rawData: CreatePersonalAccessTokenProps, headers?: RawAxiosRequestHeaders): Promise<PersonalAccessTokenProps>;
|
|
240
240
|
revoke(params: OptionalDefaults<{
|
|
241
241
|
tokenId: string;
|
|
242
|
-
}>): Promise<
|
|
242
|
+
}>): Promise<PersonalAccessTokenProps>;
|
|
243
243
|
};
|
|
244
244
|
accessToken: {
|
|
245
245
|
get(params: OptionalDefaults<{
|
|
246
246
|
tokenId: string;
|
|
247
|
-
}>): Promise<
|
|
248
|
-
getMany(params: OptionalDefaults<QueryParams>): Promise<CollectionProp<
|
|
249
|
-
createPersonalAccessToken(rawData: CreatePATProps, headers?: RawAxiosRequestHeaders): Promise<
|
|
247
|
+
}>): Promise<AccessTokenProps>;
|
|
248
|
+
getMany(params: OptionalDefaults<QueryParams>): Promise<CollectionProp<AccessTokenProps>>;
|
|
249
|
+
createPersonalAccessToken(rawData: CreatePATProps, headers?: RawAxiosRequestHeaders): Promise<AccessTokenProps>;
|
|
250
250
|
revoke(params: OptionalDefaults<{
|
|
251
251
|
tokenId: string;
|
|
252
|
-
}>): Promise<
|
|
253
|
-
getManyForOrganization(params: OptionalDefaults<GetOrganizationParams & QueryParams>): Promise<CollectionProp<
|
|
252
|
+
}>): Promise<AccessTokenProps>;
|
|
253
|
+
getManyForOrganization(params: OptionalDefaults<GetOrganizationParams & QueryParams>): Promise<CollectionProp<AccessTokenProps>>;
|
|
254
254
|
};
|
|
255
255
|
usage: UsagePlainClientAPI;
|
|
256
256
|
release: {
|
|
@@ -1,5 +1,5 @@
|
|
|
1
1
|
import type { PaginationQueryParams, CollectionProp, GetOrganizationParams } from '../../common-types';
|
|
2
|
-
import type {
|
|
2
|
+
import type { OrganizationProps } from '../../entities/organization';
|
|
3
3
|
import type { OptionalDefaults } from '../wrappers/wrap';
|
|
4
4
|
export type OrganizationPlainClientAPI = {
|
|
5
5
|
/**
|
|
@@ -16,7 +16,7 @@ export type OrganizationPlainClientAPI = {
|
|
|
16
16
|
* })
|
|
17
17
|
* ```
|
|
18
18
|
*/
|
|
19
|
-
getAll(params?: OptionalDefaults<PaginationQueryParams>): Promise<CollectionProp<
|
|
19
|
+
getAll(params?: OptionalDefaults<PaginationQueryParams>): Promise<CollectionProp<OrganizationProps>>;
|
|
20
20
|
/**
|
|
21
21
|
* Fetch a single organization by its ID
|
|
22
22
|
* @param params the organization ID
|
|
@@ -29,5 +29,5 @@ export type OrganizationPlainClientAPI = {
|
|
|
29
29
|
* })
|
|
30
30
|
* ```
|
|
31
31
|
*/
|
|
32
|
-
get(params: OptionalDefaults<GetOrganizationParams>): Promise<
|
|
32
|
+
get(params: OptionalDefaults<GetOrganizationParams>): Promise<OrganizationProps>;
|
|
33
33
|
};
|
|
@@ -4,10 +4,10 @@ import type { UpsertResourceProviderProps, ResourceProviderProps } from '../../e
|
|
|
4
4
|
import type { OptionalDefaults } from '../wrappers/wrap';
|
|
5
5
|
export type ResourceProviderPlainClientAPI = {
|
|
6
6
|
/**
|
|
7
|
-
*
|
|
7
|
+
* Fetches a Resource Provider
|
|
8
8
|
* @param params entity IDs to identify the Resource Provider
|
|
9
|
-
* @returns the
|
|
10
|
-
* @throws if the request fails
|
|
9
|
+
* @returns the Resource Provider
|
|
10
|
+
* @throws if the request fails or the Resource Provider is not found
|
|
11
11
|
* @example
|
|
12
12
|
* ```javascript
|
|
13
13
|
* const resourceProvider = await client.resourceProvider.get({
|
|
@@ -18,15 +18,17 @@ export type ResourceProviderPlainClientAPI = {
|
|
|
18
18
|
*/
|
|
19
19
|
get(params: OptionalDefaults<GetResourceProviderParams>): Promise<ResourceProviderProps>;
|
|
20
20
|
/**
|
|
21
|
-
* Creates
|
|
21
|
+
* Creates a Resource Provider
|
|
22
22
|
* @param params entity IDs to identify the Resource Provider
|
|
23
|
-
* @param rawData the
|
|
24
|
-
* @returns the created
|
|
25
|
-
* @throws if the request fails, the App Definition
|
|
23
|
+
* @param rawData the Resource Provider data
|
|
24
|
+
* @returns the created Resource Provider
|
|
25
|
+
* @throws if the request fails, the App Definition is not found,
|
|
26
|
+
* a Resource Provider associated with the organization and app definition already exists,
|
|
27
|
+
* or the payload is malformed
|
|
26
28
|
* @example
|
|
27
29
|
* ```javascript
|
|
28
|
-
* // You need a valid AppDefinition with an activated AppBundle that has a
|
|
29
|
-
* const
|
|
30
|
+
* // You need a valid AppDefinition with an activated AppBundle that has a configured Contentful function
|
|
31
|
+
* const resourceProvider = await client.resourceProvider.upsert(
|
|
30
32
|
* {
|
|
31
33
|
* organizationId: '<organization_id>',
|
|
32
34
|
* appDefinitionId: '<app_definition_id>',
|
|
@@ -41,9 +43,10 @@ export type ResourceProviderPlainClientAPI = {
|
|
|
41
43
|
*/
|
|
42
44
|
upsert(params: OptionalDefaults<GetResourceProviderParams>, rawData: UpsertResourceProviderProps, headers?: RawAxiosRequestHeaders): Promise<ResourceProviderProps>;
|
|
43
45
|
/**
|
|
44
|
-
*
|
|
46
|
+
* Deletes a ResourceProvider
|
|
45
47
|
* @param params entity IDs to identify the Resource Provider
|
|
46
|
-
* @throws if the request fails,
|
|
48
|
+
* @throws if the request fails, the Resource Provider is not found
|
|
49
|
+
* or the Resource Provider is associated with an existing Resource Type
|
|
47
50
|
* @example
|
|
48
51
|
* ```javascript
|
|
49
52
|
* await client.resourceProvider.delete({
|
|
@@ -3,17 +3,19 @@ import type { CursorPaginatedCollectionProp, GetResourceParams } from '../../com
|
|
|
3
3
|
import type { ResourceProps, ResourceQueryOptions } from '../../entities/resource';
|
|
4
4
|
export type ResourcePlainAPI = {
|
|
5
5
|
/**
|
|
6
|
-
*
|
|
6
|
+
* Fetches all Resources.
|
|
7
|
+
* Supports fetching specific Resources by URNs or searching by a text query.
|
|
7
8
|
* @param params entity IDs to identify the Resources
|
|
8
|
-
* @
|
|
9
|
-
* @
|
|
9
|
+
* @params optional query params for search or lookup events
|
|
10
|
+
* @returns the Resources collection
|
|
11
|
+
* @throws if the request fails or the Resource Type is not found
|
|
10
12
|
* @example
|
|
11
13
|
* ```javascript
|
|
12
14
|
* // Lookup example
|
|
13
|
-
* const
|
|
15
|
+
* const resources = await client.resource.getMany({
|
|
14
16
|
* spaceId: '<space_id>',
|
|
15
17
|
* environmentId: '<environment_id>',
|
|
16
|
-
* resourceTypeId: '<
|
|
18
|
+
* resourceTypeId: '<resource_provider_id>:<resource_type_name>',
|
|
17
19
|
* query: {
|
|
18
20
|
* 'sys.urn[in]': '<resource_urn1>,<resource_urn2>',
|
|
19
21
|
* limit': <number>,
|
|
@@ -21,10 +23,10 @@ export type ResourcePlainAPI = {
|
|
|
21
23
|
* });
|
|
22
24
|
*
|
|
23
25
|
* // Search example
|
|
24
|
-
* const
|
|
26
|
+
* const resources = await client.resource.getMany({
|
|
25
27
|
* spaceId: '<space_id>',
|
|
26
28
|
* environmentId: '<environment_id>',
|
|
27
|
-
* resourceTypeId: '<
|
|
29
|
+
* resourceTypeId: '<resource_provider_id>:<resource_type_name>',
|
|
28
30
|
* query: {
|
|
29
31
|
* 'query': 'text',
|
|
30
32
|
* 'limit': <number>,
|
package/package.json
CHANGED
|
@@ -1,6 +1,6 @@
|
|
|
1
1
|
{
|
|
2
2
|
"name": "contentful-management",
|
|
3
|
-
"version": "11.
|
|
3
|
+
"version": "11.36.0-beta.1",
|
|
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",
|