confluence.js 1.2.0 → 1.3.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/CHANGELOG.md +19 -0
- package/README.md +0 -57
- package/out/api/audit.js +6 -6
- package/out/api/content.js +11 -10
- package/out/api/contentAttachments.d.ts +2 -2
- package/out/api/contentAttachments.js +7 -6
- package/out/api/contentBody.js +1 -1
- package/out/api/contentChildrenAndDescendants.js +7 -7
- package/out/api/contentComments.js +1 -1
- package/out/api/contentLabels.js +4 -4
- package/out/api/contentMacroBody.js +1 -1
- package/out/api/contentPermissions.js +1 -1
- package/out/api/contentProperties.js +7 -6
- package/out/api/contentRestrictions.js +15 -15
- package/out/api/contentVersions.js +4 -4
- package/out/api/contentWatches.js +12 -12
- package/out/api/dynamicModules.js +3 -3
- package/out/api/experimental.d.ts +36 -0
- package/out/api/experimental.js +38 -2
- package/out/api/group.js +15 -15
- package/out/api/inlineTasks.js +3 -3
- package/out/api/labelInfo.js +1 -1
- package/out/api/longRunningTask.js +2 -2
- package/out/api/parameters/addLabelsToSpace.d.ts +4 -0
- package/out/api/parameters/addLabelsToSpace.js +2 -0
- package/out/api/parameters/deleteLabelFromSpace.d.ts +8 -0
- package/out/api/parameters/deleteLabelFromSpace.js +2 -0
- package/out/api/parameters/getBulkUserLookup.d.ts +0 -6
- package/out/api/parameters/getContentById.d.ts +85 -1
- package/out/api/parameters/getContentById.js +87 -0
- package/out/api/parameters/getContentChildren.d.ts +1 -0
- package/out/api/parameters/getContentProperties.d.ts +1 -1
- package/out/api/parameters/getContentProperty.d.ts +12 -0
- package/out/api/parameters/getContentVersions.d.ts +1 -1
- package/out/api/parameters/getCurrentUser.d.ts +1 -6
- package/out/api/parameters/getHistoryForContent.d.ts +1 -1
- package/out/api/parameters/getLabelsForSpace.d.ts +18 -0
- package/out/api/parameters/getLabelsForSpace.js +2 -0
- package/out/api/parameters/index.d.ts +3 -0
- package/out/api/parameters/index.js +3 -0
- package/out/api/parameters/restoreContentVersion.d.ts +1 -1
- package/out/api/parameters/searchUser.d.ts +7 -0
- package/out/api/relation.js +5 -5
- package/out/api/search.d.ts +2 -2
- package/out/api/search.js +3 -2
- package/out/api/settings.js +6 -6
- package/out/api/space.js +9 -9
- package/out/api/spacePermissions.js +3 -3
- package/out/api/spaceProperties.js +6 -6
- package/out/api/spaceSettings.js +2 -2
- package/out/api/template.d.ts +24 -16
- package/out/api/template.js +6 -6
- package/out/api/themes.js +6 -6
- package/out/api/users.js +8 -8
- package/out/clients/baseClient.d.ts +2 -5
- package/out/clients/baseClient.js +10 -32
- package/out/clients/client.d.ts +2 -3
- package/out/config.d.ts +3 -2
- package/out/index.d.ts +1 -0
- package/out/index.js +2 -1
- package/package.json +24 -24
- package/src/api/audit.ts +6 -6
- package/src/api/content.ts +11 -10
- package/src/api/contentAttachments.ts +10 -9
- package/src/api/contentBody.ts +1 -1
- package/src/api/contentChildrenAndDescendants.ts +7 -7
- package/src/api/contentComments.ts +1 -1
- package/src/api/contentLabels.ts +4 -4
- package/src/api/contentMacroBody.ts +1 -1
- package/src/api/contentPermissions.ts +1 -1
- package/src/api/contentProperties.ts +7 -6
- package/src/api/contentRestrictions.ts +15 -15
- package/src/api/contentVersions.ts +4 -4
- package/src/api/contentWatches.ts +12 -12
- package/src/api/dynamicModules.ts +3 -3
- package/src/api/experimental.ts +95 -2
- package/src/api/group.ts +16 -15
- package/src/api/inlineTasks.ts +3 -3
- package/src/api/labelInfo.ts +1 -1
- package/src/api/longRunningTask.ts +2 -2
- package/src/api/parameters/addLabelsToSpace.ts +4 -0
- package/src/api/parameters/deleteLabelFromSpace.ts +8 -0
- package/src/api/parameters/getBulkUserLookup.ts +0 -6
- package/src/api/parameters/getContentById.ts +86 -1
- package/src/api/parameters/getContentChildren.ts +1 -0
- package/src/api/parameters/getContentProperties.ts +1 -1
- package/src/api/parameters/getContentProperty.ts +12 -0
- package/src/api/parameters/getContentVersions.ts +1 -1
- package/src/api/parameters/getCurrentUser.ts +1 -6
- package/src/api/parameters/getHistoryForContent.ts +1 -1
- package/src/api/parameters/getLabelsForSpace.ts +18 -0
- package/src/api/parameters/index.ts +3 -0
- package/src/api/parameters/restoreContentVersion.ts +1 -1
- package/src/api/parameters/searchUser.ts +7 -0
- package/src/api/relation.ts +5 -5
- package/src/api/search.ts +6 -4
- package/src/api/settings.ts +6 -6
- package/src/api/space.ts +9 -9
- package/src/api/spacePermissions.ts +3 -3
- package/src/api/spaceProperties.ts +6 -6
- package/src/api/spaceSettings.ts +2 -2
- package/src/api/template.ts +30 -22
- package/src/api/themes.ts +6 -6
- package/src/api/users.ts +8 -8
- package/src/clients/baseClient.ts +10 -62
- package/src/clients/client.ts +2 -3
- package/src/config.ts +3 -2
- package/src/index.ts +1 -0
- package/tsconfig.json +2 -1
|
@@ -1,7 +1,7 @@
|
|
|
1
1
|
export interface GetContentProperties {
|
|
2
2
|
/** The ID of the content to be queried for its properties. */
|
|
3
3
|
id: string;
|
|
4
|
-
/**The key of the content property
|
|
4
|
+
/** The key of the content property. */
|
|
5
5
|
key?: string[];
|
|
6
6
|
/**
|
|
7
7
|
* A multi-value parameter indicating which properties of the content to expand. By default, the `version` object is expanded.
|
|
@@ -10,4 +10,16 @@ export interface GetContentProperty {
|
|
|
10
10
|
* - `version` returns information about the version of the property, such as the version number, when it was created, etc.
|
|
11
11
|
*/
|
|
12
12
|
expand?: string[];
|
|
13
|
+
/**
|
|
14
|
+
* Filter the results to a set of content based on their status. If set to `any`, content with any status is returned.
|
|
15
|
+
* By default it will fetch current and archived statuses `?status=current&status=archived`. All supported statuses
|
|
16
|
+
*
|
|
17
|
+
* - any
|
|
18
|
+
* - archived
|
|
19
|
+
* - current
|
|
20
|
+
* - deleted
|
|
21
|
+
* - draft
|
|
22
|
+
* - trashed
|
|
23
|
+
*/
|
|
24
|
+
status?: string[];
|
|
13
25
|
}
|
|
@@ -6,7 +6,7 @@ export interface GetContentVersions {
|
|
|
6
6
|
/** The maximum number of versions to return per page. Note, this may be restricted by fixed system limits. */
|
|
7
7
|
limit?: number;
|
|
8
8
|
/**
|
|
9
|
-
* A multi-value parameter indicating which properties of the content to expand.
|
|
9
|
+
* A multi-value parameter indicating which properties of the content to expand. By default, the `content` object is expanded.
|
|
10
10
|
*
|
|
11
11
|
* - `collaborators` returns the users that collaborated on the version.
|
|
12
12
|
* - `content` returns the content for the version.
|
|
@@ -3,13 +3,8 @@ export interface GetCurrentUser {
|
|
|
3
3
|
* A multi-value parameter indicating which properties of the user to expand.
|
|
4
4
|
*
|
|
5
5
|
* - `operations` returns the operations that the user is allowed to do.
|
|
6
|
-
* - `details.personal` returns the 'Personal' details in the user's profile, like the 'Email' and 'Phone'. Note that
|
|
7
|
-
* these fields have been deprecated due to privacy changes. See the [migration
|
|
8
|
-
* guide](https://developer.atlassian.com/cloud/confluence/deprecation-notice-user-privacy-api-migration-guide/) for details.
|
|
9
|
-
* - `details.business` returns the 'Company' details in the user's profile, like the 'Position' and 'Department'. Note
|
|
10
|
-
* that these fields have been deprecated due to privacy changes. See the [migration
|
|
11
|
-
* guide](https://developer.atlassian.com/cloud/confluence/deprecation-notice-user-privacy-api-migration-guide/) for details.
|
|
12
6
|
* - PersonalSpace returns the user's personal space, if it exists.
|
|
7
|
+
* - `isExternalCollaborator` returns whether the user is an external collaborator user
|
|
13
8
|
*/
|
|
14
9
|
expand?: string[];
|
|
15
10
|
}
|
|
@@ -2,7 +2,7 @@ export interface GetHistoryForContent {
|
|
|
2
2
|
/** The ID of the content to be queried for its history. */
|
|
3
3
|
id: string;
|
|
4
4
|
/**
|
|
5
|
-
* A multi-value parameter indicating which properties of the content history to expand.
|
|
5
|
+
* A multi-value parameter indicating which properties of the content history to expand. Maximum sub-expansions allowed is `8`.
|
|
6
6
|
*
|
|
7
7
|
* - `lastUpdated` returns information about the most recent update of the content, including who updated it and when it
|
|
8
8
|
* was updated.
|
|
@@ -0,0 +1,18 @@
|
|
|
1
|
+
export interface GetLabelsForSpace {
|
|
2
|
+
/** The key of the space to get labels for. */
|
|
3
|
+
spaceKey: string;
|
|
4
|
+
/**
|
|
5
|
+
* Filters the results to labels with the specified prefix. If this parameter is not specified, then labels with any
|
|
6
|
+
* prefix will be returned.
|
|
7
|
+
*
|
|
8
|
+
* - `global` prefix is used by labels that are on content within the provided space.
|
|
9
|
+
* - `my` prefix can be explicitly added by a user when adding a label
|
|
10
|
+
* via the UI, e.g. 'my:example-label'.
|
|
11
|
+
* - `team` prefix is used for labels applied to the space.
|
|
12
|
+
*/
|
|
13
|
+
prefix?: string;
|
|
14
|
+
/** The starting index of the returned labels. */
|
|
15
|
+
start?: number;
|
|
16
|
+
/** The maximum number of labels to return per page. Note, this may be restricted by fixed system limits. */
|
|
17
|
+
limit?: number;
|
|
18
|
+
}
|
|
@@ -3,6 +3,7 @@ export * from './addCustomContentPermissions';
|
|
|
3
3
|
export * from './addGroupToContentRestriction';
|
|
4
4
|
export * from './addGroupToContentRestrictionByGroupId';
|
|
5
5
|
export * from './addLabelsToContent';
|
|
6
|
+
export * from './addLabelsToSpace';
|
|
6
7
|
export * from './addLabelWatcher';
|
|
7
8
|
export * from './addPermission';
|
|
8
9
|
export * from './addPermissionToSpace';
|
|
@@ -33,6 +34,7 @@ export * from './delete';
|
|
|
33
34
|
export * from './deleteContent';
|
|
34
35
|
export * from './deleteContentProperty';
|
|
35
36
|
export * from './deleteContentVersion';
|
|
37
|
+
export * from './deleteLabelFromSpace';
|
|
36
38
|
export * from './deleteRelationship';
|
|
37
39
|
export * from './deleteRestrictions';
|
|
38
40
|
export * from './deleteSpace';
|
|
@@ -81,6 +83,7 @@ export * from './getGroupsSearch';
|
|
|
81
83
|
export * from './getHistoryForContent';
|
|
82
84
|
export * from './getIndividualGroupRestrictionStatusByGroupId';
|
|
83
85
|
export * from './getLabelsForContent';
|
|
86
|
+
export * from './getLabelsForSpace';
|
|
84
87
|
export * from './getLookAndFeelSettings';
|
|
85
88
|
export * from './getMacroBodyByMacroId';
|
|
86
89
|
export * from './getMembersByQueryParam';
|
|
@@ -6,6 +6,7 @@ const tslib_1 = require("tslib");
|
|
|
6
6
|
(0, tslib_1.__exportStar)(require("./addGroupToContentRestriction"), exports);
|
|
7
7
|
(0, tslib_1.__exportStar)(require("./addGroupToContentRestrictionByGroupId"), exports);
|
|
8
8
|
(0, tslib_1.__exportStar)(require("./addLabelsToContent"), exports);
|
|
9
|
+
(0, tslib_1.__exportStar)(require("./addLabelsToSpace"), exports);
|
|
9
10
|
(0, tslib_1.__exportStar)(require("./addLabelWatcher"), exports);
|
|
10
11
|
(0, tslib_1.__exportStar)(require("./addPermission"), exports);
|
|
11
12
|
(0, tslib_1.__exportStar)(require("./addPermissionToSpace"), exports);
|
|
@@ -36,6 +37,7 @@ const tslib_1 = require("tslib");
|
|
|
36
37
|
(0, tslib_1.__exportStar)(require("./deleteContent"), exports);
|
|
37
38
|
(0, tslib_1.__exportStar)(require("./deleteContentProperty"), exports);
|
|
38
39
|
(0, tslib_1.__exportStar)(require("./deleteContentVersion"), exports);
|
|
40
|
+
(0, tslib_1.__exportStar)(require("./deleteLabelFromSpace"), exports);
|
|
39
41
|
(0, tslib_1.__exportStar)(require("./deleteRelationship"), exports);
|
|
40
42
|
(0, tslib_1.__exportStar)(require("./deleteRestrictions"), exports);
|
|
41
43
|
(0, tslib_1.__exportStar)(require("./deleteSpace"), exports);
|
|
@@ -84,6 +86,7 @@ const tslib_1 = require("tslib");
|
|
|
84
86
|
(0, tslib_1.__exportStar)(require("./getHistoryForContent"), exports);
|
|
85
87
|
(0, tslib_1.__exportStar)(require("./getIndividualGroupRestrictionStatusByGroupId"), exports);
|
|
86
88
|
(0, tslib_1.__exportStar)(require("./getLabelsForContent"), exports);
|
|
89
|
+
(0, tslib_1.__exportStar)(require("./getLabelsForSpace"), exports);
|
|
87
90
|
(0, tslib_1.__exportStar)(require("./getLookAndFeelSettings"), exports);
|
|
88
91
|
(0, tslib_1.__exportStar)(require("./getMacroBodyByMacroId"), exports);
|
|
89
92
|
(0, tslib_1.__exportStar)(require("./getMembersByQueryParam"), exports);
|
|
@@ -3,7 +3,7 @@ export interface RestoreContentVersion extends VersionRestore {
|
|
|
3
3
|
/** The ID of the content for which the history will be restored. */
|
|
4
4
|
id: string;
|
|
5
5
|
/**
|
|
6
|
-
* A multi-value parameter indicating which properties of the
|
|
6
|
+
* A multi-value parameter indicating which properties of the content to expand. By default, the `content` object is expanded.
|
|
7
7
|
*
|
|
8
8
|
* - `collaborators` returns the users that collaborated on the version.
|
|
9
9
|
* - `content` returns the content for the version.
|
|
@@ -17,4 +17,11 @@ export interface SearchUser {
|
|
|
17
17
|
start?: number;
|
|
18
18
|
/** The maximum number of user objects to return per page. Note, this may be restricted by fixed system limits. */
|
|
19
19
|
limit?: number;
|
|
20
|
+
/**
|
|
21
|
+
* A multi-value parameter indicating which properties of the user to expand.
|
|
22
|
+
*
|
|
23
|
+
* - `operations` returns the operations for the user, which are used when setting permissions.
|
|
24
|
+
* - `personalSpace` returns the personal space of the user.
|
|
25
|
+
*/
|
|
26
|
+
expand?: string[];
|
|
20
27
|
}
|
package/out/api/relation.js
CHANGED
|
@@ -21,7 +21,7 @@ class Relation {
|
|
|
21
21
|
limit: parameters.limit,
|
|
22
22
|
},
|
|
23
23
|
};
|
|
24
|
-
return this.client.sendRequest(config, callback
|
|
24
|
+
return this.client.sendRequest(config, callback);
|
|
25
25
|
});
|
|
26
26
|
}
|
|
27
27
|
GetRelationship(parameters, callback) {
|
|
@@ -42,7 +42,7 @@ class Relation {
|
|
|
42
42
|
expand: parameters.expand,
|
|
43
43
|
},
|
|
44
44
|
};
|
|
45
|
-
return this.client.sendRequest(config, callback
|
|
45
|
+
return this.client.sendRequest(config, callback);
|
|
46
46
|
});
|
|
47
47
|
}
|
|
48
48
|
createRelationship(parameters, callback) {
|
|
@@ -57,7 +57,7 @@ class Relation {
|
|
|
57
57
|
targetVersion: parameters.targetVersion,
|
|
58
58
|
},
|
|
59
59
|
};
|
|
60
|
-
return this.client.sendRequest(config, callback
|
|
60
|
+
return this.client.sendRequest(config, callback);
|
|
61
61
|
});
|
|
62
62
|
}
|
|
63
63
|
delete(parameters, callback) {
|
|
@@ -77,7 +77,7 @@ class Relation {
|
|
|
77
77
|
targetVersion: parameters.targetVersion,
|
|
78
78
|
},
|
|
79
79
|
};
|
|
80
|
-
return this.client.sendRequest(config, callback
|
|
80
|
+
return this.client.sendRequest(config, callback);
|
|
81
81
|
});
|
|
82
82
|
}
|
|
83
83
|
findSourcesForTarget(parameters, callback) {
|
|
@@ -95,7 +95,7 @@ class Relation {
|
|
|
95
95
|
limit: parameters.limit,
|
|
96
96
|
},
|
|
97
97
|
};
|
|
98
|
-
return this.client.sendRequest(config, callback
|
|
98
|
+
return this.client.sendRequest(config, callback);
|
|
99
99
|
});
|
|
100
100
|
}
|
|
101
101
|
}
|
package/out/api/search.d.ts
CHANGED
|
@@ -42,7 +42,7 @@ export declare class Search {
|
|
|
42
42
|
* (CQL)](https://developer.atlassian.com/cloud/confluence/advanced-searching-using-cql/).
|
|
43
43
|
*
|
|
44
44
|
* Note that some user fields may be set to null depending on the user's privacy settings. These are: email,
|
|
45
|
-
* profilePicture, and
|
|
45
|
+
* profilePicture, displayName, and timeZone.
|
|
46
46
|
*/
|
|
47
47
|
searchUser<T = Models.SearchPageResponseSearchResult>(parameters: Parameters.SearchUser, callback: Callback<T>): Promise<void>;
|
|
48
48
|
/**
|
|
@@ -50,7 +50,7 @@ export declare class Search {
|
|
|
50
50
|
* (CQL)](https://developer.atlassian.com/cloud/confluence/advanced-searching-using-cql/).
|
|
51
51
|
*
|
|
52
52
|
* Note that some user fields may be set to null depending on the user's privacy settings. These are: email,
|
|
53
|
-
* profilePicture, and
|
|
53
|
+
* profilePicture, displayName, and timeZone.
|
|
54
54
|
*/
|
|
55
55
|
searchUser<T = Models.SearchPageResponseSearchResult>(parameters: Parameters.SearchUser, callback?: never): Promise<T>;
|
|
56
56
|
}
|
package/out/api/search.js
CHANGED
|
@@ -31,7 +31,7 @@ class Search {
|
|
|
31
31
|
expand: parameters.expand,
|
|
32
32
|
},
|
|
33
33
|
};
|
|
34
|
-
return this.client.sendRequest(config, callback
|
|
34
|
+
return this.client.sendRequest(config, callback);
|
|
35
35
|
});
|
|
36
36
|
}
|
|
37
37
|
userSearch(parameters, callback) {
|
|
@@ -48,9 +48,10 @@ class Search {
|
|
|
48
48
|
cql: parameters.cql,
|
|
49
49
|
start: parameters.start,
|
|
50
50
|
limit: parameters.limit,
|
|
51
|
+
expand: parameters.expand,
|
|
51
52
|
},
|
|
52
53
|
};
|
|
53
|
-
return this.client.sendRequest(config, callback
|
|
54
|
+
return this.client.sendRequest(config, callback);
|
|
54
55
|
});
|
|
55
56
|
}
|
|
56
57
|
}
|
package/out/api/settings.js
CHANGED
|
@@ -15,7 +15,7 @@ class Settings {
|
|
|
15
15
|
spaceKey: parameters === null || parameters === void 0 ? void 0 : parameters.spaceKey,
|
|
16
16
|
},
|
|
17
17
|
};
|
|
18
|
-
return this.client.sendRequest(config, callback
|
|
18
|
+
return this.client.sendRequest(config, callback);
|
|
19
19
|
});
|
|
20
20
|
}
|
|
21
21
|
updateLookAndFeel(parameters, callback) {
|
|
@@ -28,7 +28,7 @@ class Settings {
|
|
|
28
28
|
lookAndFeelType: parameters === null || parameters === void 0 ? void 0 : parameters.lookAndFeelType,
|
|
29
29
|
},
|
|
30
30
|
};
|
|
31
|
-
return this.client.sendRequest(config, callback
|
|
31
|
+
return this.client.sendRequest(config, callback);
|
|
32
32
|
});
|
|
33
33
|
}
|
|
34
34
|
updateLookAndFeelSettings(parameters, callback) {
|
|
@@ -51,7 +51,7 @@ class Settings {
|
|
|
51
51
|
_links: parameters === null || parameters === void 0 ? void 0 : parameters.links,
|
|
52
52
|
},
|
|
53
53
|
};
|
|
54
|
-
return this.client.sendRequest(config, callback
|
|
54
|
+
return this.client.sendRequest(config, callback);
|
|
55
55
|
});
|
|
56
56
|
}
|
|
57
57
|
resetLookAndFeelSettings(parameters, callback) {
|
|
@@ -63,7 +63,7 @@ class Settings {
|
|
|
63
63
|
spaceKey: parameters === null || parameters === void 0 ? void 0 : parameters.spaceKey,
|
|
64
64
|
},
|
|
65
65
|
};
|
|
66
|
-
return this.client.sendRequest(config, callback
|
|
66
|
+
return this.client.sendRequest(config, callback);
|
|
67
67
|
});
|
|
68
68
|
}
|
|
69
69
|
setLookAndFeelSettings(parameters, callback) {
|
|
@@ -75,7 +75,7 @@ class Settings {
|
|
|
75
75
|
spaceKey: parameters === null || parameters === void 0 ? void 0 : parameters.spaceKey,
|
|
76
76
|
},
|
|
77
77
|
};
|
|
78
|
-
return this.client.sendRequest(config, callback
|
|
78
|
+
return this.client.sendRequest(config, callback);
|
|
79
79
|
});
|
|
80
80
|
}
|
|
81
81
|
getSystemInfo(callback) {
|
|
@@ -84,7 +84,7 @@ class Settings {
|
|
|
84
84
|
url: '/api/settings/systemInfo',
|
|
85
85
|
method: 'GET',
|
|
86
86
|
};
|
|
87
|
-
return this.client.sendRequest(config, callback
|
|
87
|
+
return this.client.sendRequest(config, callback);
|
|
88
88
|
});
|
|
89
89
|
}
|
|
90
90
|
}
|
package/out/api/space.js
CHANGED
|
@@ -12,7 +12,7 @@ class Space {
|
|
|
12
12
|
url: '/api/space',
|
|
13
13
|
method: 'GET',
|
|
14
14
|
params: {
|
|
15
|
-
spaceKey: parameters === null || parameters === void 0 ? void 0 : parameters.spaceKey,
|
|
15
|
+
spaceKey: () => { var _a; return (_a = parameters === null || parameters === void 0 ? void 0 : parameters.spaceKey) === null || _a === void 0 ? void 0 : _a.map((key) => `spaceKey=${key}`).join('&'); },
|
|
16
16
|
spaceId: parameters === null || parameters === void 0 ? void 0 : parameters.spaceId,
|
|
17
17
|
type: parameters === null || parameters === void 0 ? void 0 : parameters.type,
|
|
18
18
|
status: parameters === null || parameters === void 0 ? void 0 : parameters.status,
|
|
@@ -23,7 +23,7 @@ class Space {
|
|
|
23
23
|
limit: parameters === null || parameters === void 0 ? void 0 : parameters.limit,
|
|
24
24
|
},
|
|
25
25
|
};
|
|
26
|
-
return this.client.sendRequest(config, callback
|
|
26
|
+
return this.client.sendRequest(config, callback);
|
|
27
27
|
});
|
|
28
28
|
}
|
|
29
29
|
createSpace(parameters, callback) {
|
|
@@ -38,7 +38,7 @@ class Space {
|
|
|
38
38
|
permissions: parameters === null || parameters === void 0 ? void 0 : parameters.permissions,
|
|
39
39
|
},
|
|
40
40
|
};
|
|
41
|
-
return this.client.sendRequest(config, callback
|
|
41
|
+
return this.client.sendRequest(config, callback);
|
|
42
42
|
});
|
|
43
43
|
}
|
|
44
44
|
createPrivateSpace(parameters, callback) {
|
|
@@ -53,7 +53,7 @@ class Space {
|
|
|
53
53
|
permissions: parameters === null || parameters === void 0 ? void 0 : parameters.permissions,
|
|
54
54
|
},
|
|
55
55
|
};
|
|
56
|
-
return this.client.sendRequest(config, callback
|
|
56
|
+
return this.client.sendRequest(config, callback);
|
|
57
57
|
});
|
|
58
58
|
}
|
|
59
59
|
getSpace(parameters, callback) {
|
|
@@ -62,7 +62,7 @@ class Space {
|
|
|
62
62
|
url: `/api/space/${parameters.spaceKey}`,
|
|
63
63
|
method: 'GET',
|
|
64
64
|
};
|
|
65
|
-
return this.client.sendRequest(config, callback
|
|
65
|
+
return this.client.sendRequest(config, callback);
|
|
66
66
|
});
|
|
67
67
|
}
|
|
68
68
|
updateSpace(parameters, callback) {
|
|
@@ -78,7 +78,7 @@ class Space {
|
|
|
78
78
|
status: parameters.status,
|
|
79
79
|
},
|
|
80
80
|
};
|
|
81
|
-
return this.client.sendRequest(config, callback
|
|
81
|
+
return this.client.sendRequest(config, callback);
|
|
82
82
|
});
|
|
83
83
|
}
|
|
84
84
|
deleteSpace(parameters, callback) {
|
|
@@ -87,7 +87,7 @@ class Space {
|
|
|
87
87
|
url: `/api/space/${parameters.spaceKey}`,
|
|
88
88
|
method: 'DELETE',
|
|
89
89
|
};
|
|
90
|
-
return this.client.sendRequest(config, callback
|
|
90
|
+
return this.client.sendRequest(config, callback);
|
|
91
91
|
});
|
|
92
92
|
}
|
|
93
93
|
getContentForSpace(parameters, callback) {
|
|
@@ -101,7 +101,7 @@ class Space {
|
|
|
101
101
|
limit: parameters.limit,
|
|
102
102
|
},
|
|
103
103
|
};
|
|
104
|
-
return this.client.sendRequest(config, callback
|
|
104
|
+
return this.client.sendRequest(config, callback);
|
|
105
105
|
});
|
|
106
106
|
}
|
|
107
107
|
getContentByTypeForSpace(parameters, callback) {
|
|
@@ -115,7 +115,7 @@ class Space {
|
|
|
115
115
|
limit: parameters.limit,
|
|
116
116
|
},
|
|
117
117
|
};
|
|
118
|
-
return this.client.sendRequest(config, callback
|
|
118
|
+
return this.client.sendRequest(config, callback);
|
|
119
119
|
});
|
|
120
120
|
}
|
|
121
121
|
}
|
|
@@ -22,7 +22,7 @@ class SpacePermissions {
|
|
|
22
22
|
_links: parameters.links,
|
|
23
23
|
},
|
|
24
24
|
};
|
|
25
|
-
return this.client.sendRequest(config, callback
|
|
25
|
+
return this.client.sendRequest(config, callback);
|
|
26
26
|
});
|
|
27
27
|
}
|
|
28
28
|
addCustomContentPermissions(parameters, callback) {
|
|
@@ -35,7 +35,7 @@ class SpacePermissions {
|
|
|
35
35
|
operations: parameters.operations,
|
|
36
36
|
},
|
|
37
37
|
};
|
|
38
|
-
return this.client.sendRequest(config, callback
|
|
38
|
+
return this.client.sendRequest(config, callback);
|
|
39
39
|
});
|
|
40
40
|
}
|
|
41
41
|
removePermission(parameters, callback) {
|
|
@@ -44,7 +44,7 @@ class SpacePermissions {
|
|
|
44
44
|
url: `/api/space/${parameters.spaceKey}/permission/${parameters.id}`,
|
|
45
45
|
method: 'DELETE',
|
|
46
46
|
};
|
|
47
|
-
return this.client.sendRequest(config, callback
|
|
47
|
+
return this.client.sendRequest(config, callback);
|
|
48
48
|
});
|
|
49
49
|
}
|
|
50
50
|
}
|
|
@@ -17,7 +17,7 @@ class SpaceProperties {
|
|
|
17
17
|
limit: parameters.limit,
|
|
18
18
|
},
|
|
19
19
|
};
|
|
20
|
-
return this.client.sendRequest(config, callback
|
|
20
|
+
return this.client.sendRequest(config, callback);
|
|
21
21
|
});
|
|
22
22
|
}
|
|
23
23
|
createSpaceProperty(parameters, callback) {
|
|
@@ -31,7 +31,7 @@ class SpaceProperties {
|
|
|
31
31
|
space: parameters.space,
|
|
32
32
|
},
|
|
33
33
|
};
|
|
34
|
-
return this.client.sendRequest(config, callback
|
|
34
|
+
return this.client.sendRequest(config, callback);
|
|
35
35
|
});
|
|
36
36
|
}
|
|
37
37
|
getSpaceProperty(parameters, callback) {
|
|
@@ -43,7 +43,7 @@ class SpaceProperties {
|
|
|
43
43
|
expand: parameters.expand,
|
|
44
44
|
},
|
|
45
45
|
};
|
|
46
|
-
return this.client.sendRequest(config, callback
|
|
46
|
+
return this.client.sendRequest(config, callback);
|
|
47
47
|
});
|
|
48
48
|
}
|
|
49
49
|
createSpacePropertyForKey(parameters, callback) {
|
|
@@ -55,7 +55,7 @@ class SpaceProperties {
|
|
|
55
55
|
value: parameters.value,
|
|
56
56
|
},
|
|
57
57
|
};
|
|
58
|
-
return this.client.sendRequest(config, callback
|
|
58
|
+
return this.client.sendRequest(config, callback);
|
|
59
59
|
});
|
|
60
60
|
}
|
|
61
61
|
updateSpaceProperty(parameters, callback) {
|
|
@@ -68,7 +68,7 @@ class SpaceProperties {
|
|
|
68
68
|
version: parameters.version,
|
|
69
69
|
},
|
|
70
70
|
};
|
|
71
|
-
return this.client.sendRequest(config, callback
|
|
71
|
+
return this.client.sendRequest(config, callback);
|
|
72
72
|
});
|
|
73
73
|
}
|
|
74
74
|
deleteSpaceProperty(parameters, callback) {
|
|
@@ -77,7 +77,7 @@ class SpaceProperties {
|
|
|
77
77
|
url: `/api/space/${parameters.spaceKey}/property/${parameters.key}`,
|
|
78
78
|
method: 'DELETE',
|
|
79
79
|
};
|
|
80
|
-
return this.client.sendRequest(config, callback
|
|
80
|
+
return this.client.sendRequest(config, callback);
|
|
81
81
|
});
|
|
82
82
|
}
|
|
83
83
|
}
|
package/out/api/spaceSettings.js
CHANGED
|
@@ -12,7 +12,7 @@ class SpaceSettings {
|
|
|
12
12
|
url: `/api/space/${parameters.spaceKey}/settings`,
|
|
13
13
|
method: 'GET',
|
|
14
14
|
};
|
|
15
|
-
return this.client.sendRequest(config, callback
|
|
15
|
+
return this.client.sendRequest(config, callback);
|
|
16
16
|
});
|
|
17
17
|
}
|
|
18
18
|
updateSpaceSettings(parameters, callback) {
|
|
@@ -24,7 +24,7 @@ class SpaceSettings {
|
|
|
24
24
|
routeOverrideEnabled: parameters.routeOverrideEnabled,
|
|
25
25
|
},
|
|
26
26
|
};
|
|
27
|
-
return this.client.sendRequest(config, callback
|
|
27
|
+
return this.client.sendRequest(config, callback);
|
|
28
28
|
});
|
|
29
29
|
}
|
|
30
30
|
}
|
package/out/api/template.d.ts
CHANGED
|
@@ -22,15 +22,15 @@ export declare class Template {
|
|
|
22
22
|
/**
|
|
23
23
|
* Updates a content template. Note, blueprint templates cannot be updated via the REST API.
|
|
24
24
|
*
|
|
25
|
-
* **[Permissions](https://confluence.atlassian.com/x/_AozKw) required**: 'Admin' permission for the space to
|
|
26
|
-
* space template or 'Confluence Administrator' global permission to
|
|
25
|
+
* **[Permissions](https://confluence.atlassian.com/x/_AozKw) required**: 'Admin' permission for the space to update a
|
|
26
|
+
* space template or 'Confluence Administrator' global permission to update a global template.
|
|
27
27
|
*/
|
|
28
28
|
updateContentTemplate<T = Models.ContentTemplate>(parameters: Parameters.UpdateContentTemplate | undefined, callback: Callback<T>): Promise<void>;
|
|
29
29
|
/**
|
|
30
30
|
* Updates a content template. Note, blueprint templates cannot be updated via the REST API.
|
|
31
31
|
*
|
|
32
|
-
* **[Permissions](https://confluence.atlassian.com/x/_AozKw) required**: 'Admin' permission for the space to
|
|
33
|
-
* space template or 'Confluence Administrator' global permission to
|
|
32
|
+
* **[Permissions](https://confluence.atlassian.com/x/_AozKw) required**: 'Admin' permission for the space to update a
|
|
33
|
+
* space template or 'Confluence Administrator' global permission to update a global template.
|
|
34
34
|
*/
|
|
35
35
|
updateContentTemplate<T = Models.ContentTemplate>(parameters?: Parameters.UpdateContentTemplate, callback?: never): Promise<T>;
|
|
36
36
|
/**
|
|
@@ -40,8 +40,9 @@ export declare class Template {
|
|
|
40
40
|
* Note, all global blueprints are inherited by each space. Space blueprints can be customised without affecting the
|
|
41
41
|
* global blueprints.
|
|
42
42
|
*
|
|
43
|
-
* **[Permissions](https://confluence.atlassian.com/x/_AozKw) required**:
|
|
44
|
-
* ('Can use' global permission)
|
|
43
|
+
* **[Permissions](https://confluence.atlassian.com/x/_AozKw) required**: 'View' permission for the space to view
|
|
44
|
+
* blueprints for the space and permission to access the Confluence site ('Can use' global permission) to view global
|
|
45
|
+
* blueprints.
|
|
45
46
|
*/
|
|
46
47
|
getBlueprintTemplates<T = Models.BlueprintTemplateArray>(parameters: Parameters.GetBlueprintTemplates | undefined, callback: Callback<T>): Promise<void>;
|
|
47
48
|
/**
|
|
@@ -51,38 +52,39 @@ export declare class Template {
|
|
|
51
52
|
* Note, all global blueprints are inherited by each space. Space blueprints can be customised without affecting the
|
|
52
53
|
* global blueprints.
|
|
53
54
|
*
|
|
54
|
-
* **[Permissions](https://confluence.atlassian.com/x/_AozKw) required**:
|
|
55
|
-
* ('Can use' global permission)
|
|
55
|
+
* **[Permissions](https://confluence.atlassian.com/x/_AozKw) required**: 'View' permission for the space to view
|
|
56
|
+
* blueprints for the space and permission to access the Confluence site ('Can use' global permission) to view global
|
|
57
|
+
* blueprints.
|
|
56
58
|
*/
|
|
57
59
|
getBlueprintTemplates<T = Models.BlueprintTemplateArray>(parameters?: Parameters.GetBlueprintTemplates, callback?: never): Promise<T>;
|
|
58
60
|
/**
|
|
59
61
|
* Returns all content templates. Use this method to retrieve all global content templates or all content templates in a space.
|
|
60
62
|
*
|
|
61
|
-
* **[Permissions](https://confluence.atlassian.com/x/_AozKw) required**: '
|
|
62
|
-
* space templates and
|
|
63
|
+
* **[Permissions](https://confluence.atlassian.com/x/_AozKw) required**: 'View' permission for the space to view
|
|
64
|
+
* space templates and permission to access the Confluence site ('Can use' global permission) to view global templates.
|
|
63
65
|
*/
|
|
64
66
|
getContentTemplates<T = Models.ContentTemplateArray>(parameters: Parameters.GetContentTemplates | undefined, callback: Callback<T>): Promise<void>;
|
|
65
67
|
/**
|
|
66
68
|
* Returns all content templates. Use this method to retrieve all global content templates or all content templates in a space.
|
|
67
69
|
*
|
|
68
|
-
* **[Permissions](https://confluence.atlassian.com/x/_AozKw) required**: '
|
|
69
|
-
* space templates and
|
|
70
|
+
* **[Permissions](https://confluence.atlassian.com/x/_AozKw) required**: 'View' permission for the space to view
|
|
71
|
+
* space templates and permission to access the Confluence site ('Can use' global permission) to view global templates.
|
|
70
72
|
*/
|
|
71
73
|
getContentTemplates<T = Models.ContentTemplateArray>(parameters?: Parameters.GetContentTemplates, callback?: never): Promise<T>;
|
|
72
74
|
/**
|
|
73
75
|
* Returns a content template. This includes information about template, like the name, the space or blueprint that
|
|
74
76
|
* the template is in, the body of the template, and more.
|
|
75
77
|
*
|
|
76
|
-
* **[Permissions](https://confluence.atlassian.com/x/_AozKw) required**: '
|
|
77
|
-
* space templates and
|
|
78
|
+
* **[Permissions](https://confluence.atlassian.com/x/_AozKw) required**: 'View' permission for the space to view
|
|
79
|
+
* space templates and permission to access the Confluence site ('Can use' global permission) to view global templates.
|
|
78
80
|
*/
|
|
79
81
|
getContentTemplate<T = Models.ContentTemplate>(parameters: Parameters.GetContentTemplate, callback: Callback<T>): Promise<void>;
|
|
80
82
|
/**
|
|
81
83
|
* Returns a content template. This includes information about template, like the name, the space or blueprint that
|
|
82
84
|
* the template is in, the body of the template, and more.
|
|
83
85
|
*
|
|
84
|
-
* **[Permissions](https://confluence.atlassian.com/x/_AozKw) required**: '
|
|
85
|
-
* space templates and
|
|
86
|
+
* **[Permissions](https://confluence.atlassian.com/x/_AozKw) required**: 'View' permission for the space to view
|
|
87
|
+
* space templates and permission to access the Confluence site ('Can use' global permission) to view global templates.
|
|
86
88
|
*/
|
|
87
89
|
getContentTemplate<T = Models.ContentTemplate>(parameters: Parameters.GetContentTemplate, callback?: never): Promise<T>;
|
|
88
90
|
/**
|
|
@@ -94,6 +96,9 @@ export declare class Template {
|
|
|
94
96
|
* - If the template is a modified global-level blueprint template, it reverts to the default global-level blueprint template.
|
|
95
97
|
*
|
|
96
98
|
* Note, unmodified blueprint templates cannot be deleted.
|
|
99
|
+
*
|
|
100
|
+
* **[Permissions](https://confluence.atlassian.com/x/_AozKw) required**: 'Admin' permission for the space to delete a
|
|
101
|
+
* space template or 'Confluence Administrator' global permission to delete a global template.
|
|
97
102
|
*/
|
|
98
103
|
removeTemplate<T = void>(parameters: Parameters.RemoveTemplate, callback: Callback<T>): Promise<void>;
|
|
99
104
|
/**
|
|
@@ -105,6 +110,9 @@ export declare class Template {
|
|
|
105
110
|
* - If the template is a modified global-level blueprint template, it reverts to the default global-level blueprint template.
|
|
106
111
|
*
|
|
107
112
|
* Note, unmodified blueprint templates cannot be deleted.
|
|
113
|
+
*
|
|
114
|
+
* **[Permissions](https://confluence.atlassian.com/x/_AozKw) required**: 'Admin' permission for the space to delete a
|
|
115
|
+
* space template or 'Confluence Administrator' global permission to delete a global template.
|
|
108
116
|
*/
|
|
109
117
|
removeTemplate<T = void>(parameters: Parameters.RemoveTemplate, callback?: never): Promise<T>;
|
|
110
118
|
}
|
package/out/api/template.js
CHANGED
|
@@ -20,7 +20,7 @@ class Template {
|
|
|
20
20
|
space: parameters === null || parameters === void 0 ? void 0 : parameters.space,
|
|
21
21
|
},
|
|
22
22
|
};
|
|
23
|
-
return this.client.sendRequest(config, callback
|
|
23
|
+
return this.client.sendRequest(config, callback);
|
|
24
24
|
});
|
|
25
25
|
}
|
|
26
26
|
updateContentTemplate(parameters, callback) {
|
|
@@ -38,7 +38,7 @@ class Template {
|
|
|
38
38
|
space: parameters === null || parameters === void 0 ? void 0 : parameters.space,
|
|
39
39
|
},
|
|
40
40
|
};
|
|
41
|
-
return this.client.sendRequest(config, callback
|
|
41
|
+
return this.client.sendRequest(config, callback);
|
|
42
42
|
});
|
|
43
43
|
}
|
|
44
44
|
getBlueprintTemplates(parameters, callback) {
|
|
@@ -53,7 +53,7 @@ class Template {
|
|
|
53
53
|
expand: parameters === null || parameters === void 0 ? void 0 : parameters.expand,
|
|
54
54
|
},
|
|
55
55
|
};
|
|
56
|
-
return this.client.sendRequest(config, callback
|
|
56
|
+
return this.client.sendRequest(config, callback);
|
|
57
57
|
});
|
|
58
58
|
}
|
|
59
59
|
getContentTemplates(parameters, callback) {
|
|
@@ -68,7 +68,7 @@ class Template {
|
|
|
68
68
|
expand: parameters === null || parameters === void 0 ? void 0 : parameters.expand,
|
|
69
69
|
},
|
|
70
70
|
};
|
|
71
|
-
return this.client.sendRequest(config, callback
|
|
71
|
+
return this.client.sendRequest(config, callback);
|
|
72
72
|
});
|
|
73
73
|
}
|
|
74
74
|
getContentTemplate(parameters, callback) {
|
|
@@ -77,7 +77,7 @@ class Template {
|
|
|
77
77
|
url: `/api/template/${parameters.contentTemplateId}`,
|
|
78
78
|
method: 'GET',
|
|
79
79
|
};
|
|
80
|
-
return this.client.sendRequest(config, callback
|
|
80
|
+
return this.client.sendRequest(config, callback);
|
|
81
81
|
});
|
|
82
82
|
}
|
|
83
83
|
removeTemplate(parameters, callback) {
|
|
@@ -86,7 +86,7 @@ class Template {
|
|
|
86
86
|
url: `/api/template/${parameters.contentTemplateId}`,
|
|
87
87
|
method: 'DELETE',
|
|
88
88
|
};
|
|
89
|
-
return this.client.sendRequest(config, callback
|
|
89
|
+
return this.client.sendRequest(config, callback);
|
|
90
90
|
});
|
|
91
91
|
}
|
|
92
92
|
}
|