confluence.js 1.6.3 → 1.7.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/.prettierrc +8 -3
- package/CHANGELOG.md +4 -0
- package/README.md +16 -0
- package/out/api/models/addContentRestriction.d.ts +8 -3
- package/out/api/models/appDescriptor.d.ts +6 -3
- package/out/api/models/asyncContentBody.d.ts +2 -2
- package/out/api/models/attachmentUpdate.d.ts +1 -1
- package/out/api/models/auditRecordCreate.d.ts +6 -2
- package/out/api/models/contentBlueprintDraft.d.ts +2 -1
- package/out/api/models/contentRestrictionUpdate.d.ts +8 -3
- package/out/api/models/contentTemplateUpdate.d.ts +4 -1
- package/out/api/models/labeledContentType.js +1 -1
- package/out/api/models/labeledContentType.js.map +1 -1
- package/out/api/models/lifecycle.d.ts +6 -2
- package/out/api/parameters/addLabelsToContent.d.ts +2 -1
- package/out/api/parameters/createContent.d.ts +12 -3
- package/out/api/parameters/createContent.js +13 -4
- package/out/api/parameters/createContent.js.map +1 -1
- package/out/api/parameters/createRelationship.d.ts +4 -1
- package/out/api/parameters/createUserProperty.d.ts +2 -2
- package/out/api/parameters/delete.d.ts +4 -1
- package/out/api/parameters/deleteRelationship.d.ts +8 -5
- package/out/api/parameters/deleteUserProperty.d.ts +2 -2
- package/out/api/parameters/findSourcesForTarget.d.ts +2 -1
- package/out/api/parameters/findTargetFromSource.d.ts +2 -1
- package/out/api/parameters/getAttachments.d.ts +12 -3
- package/out/api/parameters/getAttachments.js +13 -4
- package/out/api/parameters/getAttachments.js.map +1 -1
- package/out/api/parameters/getAvailableContentStates.d.ts +1 -1
- package/out/api/parameters/getContent.d.ts +16 -4
- package/out/api/parameters/getContent.js +13 -4
- package/out/api/parameters/getContent.js.map +1 -1
- package/out/api/parameters/getContentById.d.ts +12 -3
- package/out/api/parameters/getContentById.js +13 -4
- package/out/api/parameters/getContentById.js.map +1 -1
- package/out/api/parameters/getContentProperties.d.ts +4 -2
- package/out/api/parameters/getContentProperty.d.ts +10 -8
- package/out/api/parameters/getContentTemplates.d.ts +4 -1
- package/out/api/parameters/getContentVersion.d.ts +2 -1
- package/out/api/parameters/getContentVersions.d.ts +2 -1
- package/out/api/parameters/getDescendantsOfType.d.ts +12 -3
- package/out/api/parameters/getDescendantsOfType.js +13 -4
- package/out/api/parameters/getDescendantsOfType.js.map +1 -1
- package/out/api/parameters/getHistoryForContent.d.ts +2 -1
- package/out/api/parameters/getLabelsForContent.d.ts +2 -1
- package/out/api/parameters/getRelationship.d.ts +6 -2
- package/out/api/parameters/getSpaces.d.ts +10 -3
- package/out/api/parameters/removeGroupById.d.ts +2 -2
- package/out/api/parameters/removeGroupByName.d.ts +2 -2
- package/out/api/parameters/removeModules.d.ts +2 -1
- package/out/api/parameters/restoreContentVersion.d.ts +2 -1
- package/out/api/parameters/search.d.ts +2 -2
- package/out/api/parameters/updateAttachmentProperties.d.ts +15 -15
- package/out/api/parameters/updateUserProperty.d.ts +2 -2
- package/out/clients/baseClient.d.ts +0 -1
- package/out/clients/baseClient.js +2 -2
- package/out/clients/baseClient.js.map +1 -1
- package/out/clients/confluenceClient.d.ts +2 -0
- package/out/clients/confluenceClient.js +3 -2
- package/out/clients/confluenceClient.js.map +1 -1
- package/out/clients/serverClient.d.ts +2 -1
- package/out/clients/serverClient.js +3 -3
- package/out/clients/serverClient.js.map +1 -1
- package/out/config.d.ts +7 -7
- package/out/server/parameters/createAuditRecord.d.ts +6 -2
- package/out/server/parameters/getAttachments.d.ts +12 -3
- package/out/server/parameters/getAttachments.js +13 -4
- package/out/server/parameters/getAttachments.js.map +1 -1
- package/out/services/authenticationService/authenticationService.js +1 -1
- package/out/services/authenticationService/authenticationService.js.map +1 -1
- package/out/services/authenticationService/authentications/createJWTAuthentication.js +1 -1
- package/out/services/authenticationService/authentications/createJWTAuthentication.js.map +1 -1
- package/out/services/authenticationService/base64Encoder.d.ts +1 -3
- package/out/services/authenticationService/base64Encoder.js +3 -5
- package/out/services/authenticationService/base64Encoder.js.map +1 -1
- package/out/utilityTypes.d.ts +5 -1
- package/package.json +18 -18
- package/src/api/audit.ts +9 -9
- package/src/api/content.ts +8 -8
- package/src/api/contentAttachments.ts +10 -10
- package/src/api/contentBody.ts +6 -6
- package/src/api/contentChildrenAndDescendants.ts +11 -11
- package/src/api/contentComments.ts +2 -2
- package/src/api/contentContentState.ts +10 -10
- package/src/api/contentLabels.ts +7 -7
- package/src/api/contentMacroBody.ts +6 -6
- package/src/api/contentPermissions.ts +4 -4
- package/src/api/contentProperties.ts +11 -11
- package/src/api/contentRestrictions.ts +26 -26
- package/src/api/contentStates.ts +12 -12
- package/src/api/contentVersions.ts +6 -6
- package/src/api/contentWatches.ts +11 -11
- package/src/api/dynamicModules.ts +1 -1
- package/src/api/experimental.ts +9 -9
- package/src/api/group.ts +18 -18
- package/src/api/inlineTasks.ts +1 -1
- package/src/api/labelInfo.ts +2 -2
- package/src/api/longRunningTask.ts +2 -2
- package/src/api/models/addContentRestriction.ts +8 -3
- package/src/api/models/appDescriptor.ts +6 -3
- package/src/api/models/asyncContentBody.ts +2 -2
- package/src/api/models/attachmentContainer.ts +1 -1
- package/src/api/models/attachmentUpdate.ts +1 -1
- package/src/api/models/auditRecordCreate.ts +6 -2
- package/src/api/models/contentBlueprintDraft.ts +2 -1
- package/src/api/models/contentRestrictionUpdate.ts +8 -3
- package/src/api/models/contentTemplateUpdate.ts +4 -1
- package/src/api/models/lifecycle.ts +6 -2
- package/src/api/parameters/addLabelsToContent.ts +2 -1
- package/src/api/parameters/createContent.ts +12 -3
- package/src/api/parameters/createRelationship.ts +4 -1
- package/src/api/parameters/createUserProperty.ts +2 -2
- package/src/api/parameters/delete.ts +4 -1
- package/src/api/parameters/deleteRelationship.ts +8 -5
- package/src/api/parameters/deleteUserProperty.ts +2 -2
- package/src/api/parameters/findSourcesForTarget.ts +2 -1
- package/src/api/parameters/findTargetFromSource.ts +2 -1
- package/src/api/parameters/getAttachments.ts +12 -3
- package/src/api/parameters/getAvailableContentStates.ts +1 -1
- package/src/api/parameters/getContent.ts +16 -4
- package/src/api/parameters/getContentById.ts +12 -3
- package/src/api/parameters/getContentProperties.ts +4 -2
- package/src/api/parameters/getContentProperty.ts +10 -8
- package/src/api/parameters/getContentTemplates.ts +4 -1
- package/src/api/parameters/getContentVersion.ts +2 -1
- package/src/api/parameters/getContentVersions.ts +2 -1
- package/src/api/parameters/getDescendantsOfType.ts +12 -3
- package/src/api/parameters/getHistoryForContent.ts +2 -1
- package/src/api/parameters/getLabelsForContent.ts +2 -1
- package/src/api/parameters/getRelationship.ts +6 -2
- package/src/api/parameters/getSpaces.ts +10 -3
- package/src/api/parameters/removeGroupById.ts +2 -2
- package/src/api/parameters/removeGroupByName.ts +2 -2
- package/src/api/parameters/removeModules.ts +2 -1
- package/src/api/parameters/restoreContentVersion.ts +2 -1
- package/src/api/parameters/search.ts +2 -2
- package/src/api/parameters/updateAttachmentProperties.ts +15 -15
- package/src/api/parameters/updateUserProperty.ts +2 -2
- package/src/api/relation.ts +8 -8
- package/src/api/search.ts +7 -7
- package/src/api/settings.ts +12 -12
- package/src/api/space.ts +7 -7
- package/src/api/spacePermissions.ts +5 -5
- package/src/api/spaceProperties.ts +10 -10
- package/src/api/spaceSettings.ts +4 -4
- package/src/api/template.ts +10 -10
- package/src/api/themes.ts +1 -1
- package/src/api/users.ts +13 -13
- package/src/clients/baseClient.ts +4 -4
- package/src/clients/confluenceClient.ts +8 -0
- package/src/clients/serverClient.ts +7 -1
- package/src/config.ts +19 -11
- package/src/server/audit.ts +9 -9
- package/src/server/content.ts +49 -49
- package/src/server/contentBody.ts +2 -2
- package/src/server/group.ts +2 -2
- package/src/server/longTask.ts +1 -1
- package/src/server/parameters/createAuditRecord.ts +6 -2
- package/src/server/parameters/getAttachments.ts +12 -3
- package/src/server/parameters/updateAttachmentData.ts +1 -1
- package/src/server/search.ts +2 -2
- package/src/server/space.ts +16 -16
- package/src/server/user.ts +7 -7
- package/src/services/authenticationService/authentications/createJWTAuthentication.ts +1 -4
- package/src/services/authenticationService/base64Encoder.ts +5 -5
- package/src/utilityTypes.ts +7 -1
|
@@ -14,7 +14,10 @@ export interface CreateRelationship {
|
|
|
14
14
|
* - If `sourceType` is 'space', then specify the space key.
|
|
15
15
|
*/
|
|
16
16
|
sourceKey: string;
|
|
17
|
-
/**
|
|
17
|
+
/**
|
|
18
|
+
* The target entity type of the relationship. This must be 'space' or 'content', if the `relationName` is
|
|
19
|
+
* 'favourite'.
|
|
20
|
+
*/
|
|
18
21
|
targetType: string;
|
|
19
22
|
/**
|
|
20
23
|
* - The identifier for the target entity:
|
|
@@ -2,8 +2,8 @@ import { UserPropertyCreate } from '../models';
|
|
|
2
2
|
|
|
3
3
|
export interface CreateUserProperty extends UserPropertyCreate {
|
|
4
4
|
/**
|
|
5
|
-
* The account ID of the user. The accountId uniquely identifies the user across all Atlassian products. For
|
|
6
|
-
*
|
|
5
|
+
* The account ID of the user. The accountId uniquely identifies the user across all Atlassian products. For example,
|
|
6
|
+
* 384093:32b4d9w0-f6a5-3535-11a3-9c8c88d10192
|
|
7
7
|
*/
|
|
8
8
|
userId: string;
|
|
9
9
|
/** The key of the user property. */
|
|
@@ -11,7 +11,10 @@ export interface Delete {
|
|
|
11
11
|
* - If `sourceType` is 'space', then specify the space key.
|
|
12
12
|
*/
|
|
13
13
|
sourceKey: string;
|
|
14
|
-
/**
|
|
14
|
+
/**
|
|
15
|
+
* The target entity type of the relationship. This must be 'space' or 'content', if the `relationName` is
|
|
16
|
+
* 'favourite'.
|
|
17
|
+
*/
|
|
15
18
|
targetType: string;
|
|
16
19
|
/**
|
|
17
20
|
* - The identifier for the target entity:
|
|
@@ -11,7 +11,10 @@ export interface DeleteRelationship {
|
|
|
11
11
|
* - If `sourceType` is 'space', then specify the space key.
|
|
12
12
|
*/
|
|
13
13
|
sourceKey: string;
|
|
14
|
-
/**
|
|
14
|
+
/**
|
|
15
|
+
* The target entity type of the relationship. This must be 'space' or 'content', if the `relationName` is
|
|
16
|
+
* 'favourite'.
|
|
17
|
+
*/
|
|
15
18
|
targetType: string;
|
|
16
19
|
/**
|
|
17
20
|
* - The identifier for the target entity:
|
|
@@ -26,13 +29,13 @@ export interface DeleteRelationship {
|
|
|
26
29
|
/** The status of the target. This parameter is only used when the `targetType` is 'content'. */
|
|
27
30
|
targetStatus?: string;
|
|
28
31
|
/**
|
|
29
|
-
* The version of the source. This parameter is only used when the `sourceType` is 'content' and the `sourceStatus`
|
|
30
|
-
*
|
|
32
|
+
* The version of the source. This parameter is only used when the `sourceType` is 'content' and the `sourceStatus` is
|
|
33
|
+
* 'historical'.
|
|
31
34
|
*/
|
|
32
35
|
sourceVersion?: number;
|
|
33
36
|
/**
|
|
34
|
-
* The version of the target. This parameter is only used when the `targetType` is 'content' and the `targetStatus`
|
|
35
|
-
*
|
|
37
|
+
* The version of the target. This parameter is only used when the `targetType` is 'content' and the `targetStatus` is
|
|
38
|
+
* 'historical'.
|
|
36
39
|
*/
|
|
37
40
|
targetVersion?: number;
|
|
38
41
|
}
|
|
@@ -1,7 +1,7 @@
|
|
|
1
1
|
export interface DeleteUserProperty {
|
|
2
2
|
/**
|
|
3
|
-
* The account ID of the user. The accountId uniquely identifies the user across all Atlassian products. For
|
|
4
|
-
*
|
|
3
|
+
* The account ID of the user. The accountId uniquely identifies the user across all Atlassian products. For example,
|
|
4
|
+
* 384093:32b4d9w0-f6a5-3535-11a3-9c8c88d10192
|
|
5
5
|
*/
|
|
6
6
|
userId: string;
|
|
7
7
|
/** The key of the user property. */
|
|
@@ -15,7 +15,8 @@ export interface FindSourcesForTarget {
|
|
|
15
15
|
* - If `targetType` is `user`, then specify either `current` (logged-in user), the user key of the user, or the account
|
|
16
16
|
* ID of the user. Note that the user key has been deprecated in favor of the account ID for this parameter. See the
|
|
17
17
|
* [migration
|
|
18
|
-
* guide](https://developer.atlassian.com/cloud/confluence/deprecation-notice-user-privacy-api-migration-guide/) for
|
|
18
|
+
* guide](https://developer.atlassian.com/cloud/confluence/deprecation-notice-user-privacy-api-migration-guide/) for
|
|
19
|
+
* details.
|
|
19
20
|
* - If `targetType` is 'content', then specify the content ID.
|
|
20
21
|
* - If `targetType` is 'space', then specify the space key.
|
|
21
22
|
*/
|
|
@@ -13,7 +13,8 @@ export interface FindTargetFromSource {
|
|
|
13
13
|
* - If `sourceType` is `user`, then specify either `current` (logged-in user), the user key of the user, or the account
|
|
14
14
|
* ID of the user. Note that the user key has been deprecated in favor of the account ID for this parameter. See the
|
|
15
15
|
* [migration
|
|
16
|
-
* guide](https://developer.atlassian.com/cloud/confluence/deprecation-notice-user-privacy-api-migration-guide/) for
|
|
16
|
+
* guide](https://developer.atlassian.com/cloud/confluence/deprecation-notice-user-privacy-api-migration-guide/) for
|
|
17
|
+
* details.
|
|
17
18
|
* - If `sourceType` is 'content', then specify the content ID.
|
|
18
19
|
* - If `sourceType` is 'space', then specify the space key.
|
|
19
20
|
*/
|
|
@@ -136,7 +136,10 @@ export namespace GetAttachments {
|
|
|
136
136
|
UpdateGroupRestriction = 'restrictions.update.restrictions.group',
|
|
137
137
|
/** Returns the history of the content, including the date it was created. */
|
|
138
138
|
History = 'history',
|
|
139
|
-
/**
|
|
139
|
+
/**
|
|
140
|
+
* Returns information about the most recent update of the content, including who updated it and when it was
|
|
141
|
+
* updated.
|
|
142
|
+
*/
|
|
140
143
|
LastUpdated = 'history.lastUpdated',
|
|
141
144
|
/** Returns information about the update prior to the current content update. */
|
|
142
145
|
PreviousVersion = 'history.previousVersion',
|
|
@@ -146,9 +149,15 @@ export namespace GetAttachments {
|
|
|
146
149
|
NextVersion = 'history.nextVersion',
|
|
147
150
|
/** Returns the parent page, if the content is a page. */
|
|
148
151
|
Ancestors = 'ancestors',
|
|
149
|
-
/**
|
|
152
|
+
/**
|
|
153
|
+
* Returns the body of the content in different formats, including the editor format, view format, and export
|
|
154
|
+
* format.
|
|
155
|
+
*/
|
|
150
156
|
Body = 'body',
|
|
151
|
-
/**
|
|
157
|
+
/**
|
|
158
|
+
* Returns information about the most recent update of the content, including who updated it and when it was
|
|
159
|
+
* updated.
|
|
160
|
+
*/
|
|
152
161
|
Version = 'version',
|
|
153
162
|
/** Returns pages that are descendants at any level below the content. */
|
|
154
163
|
PageDescendant = 'descendants.page',
|
|
@@ -10,7 +10,10 @@ export interface GetContent {
|
|
|
10
10
|
* Note, the `historical` status is currently not supported.
|
|
11
11
|
*/
|
|
12
12
|
status?: string[];
|
|
13
|
-
/**
|
|
13
|
+
/**
|
|
14
|
+
* The posting date of the blog post to be returned. Required for <code>blogpost</code> type. Format:
|
|
15
|
+
* <code>yyyy-mm-dd</code>.
|
|
16
|
+
*/
|
|
14
17
|
postingDay?: string;
|
|
15
18
|
/** A multi-value parameter indicating which properties of the content to expand. */
|
|
16
19
|
expand?: string | string[] | GetContent.Expand | GetContent.Expand[];
|
|
@@ -83,7 +86,10 @@ export namespace GetContent {
|
|
|
83
86
|
UpdateGroupRestriction = 'restrictions.update.restrictions.group',
|
|
84
87
|
/** Returns the history of the content, including the date it was created. */
|
|
85
88
|
History = 'history',
|
|
86
|
-
/**
|
|
89
|
+
/**
|
|
90
|
+
* Returns information about the most recent update of the content, including who updated it and when it was
|
|
91
|
+
* updated.
|
|
92
|
+
*/
|
|
87
93
|
LastUpdated = 'history.lastUpdated',
|
|
88
94
|
/** Returns information about the update prior to the current content update. */
|
|
89
95
|
PreviousVersion = 'history.previousVersion',
|
|
@@ -93,9 +99,15 @@ export namespace GetContent {
|
|
|
93
99
|
NextVersion = 'history.nextVersion',
|
|
94
100
|
/** Returns the parent page, if the content is a page. */
|
|
95
101
|
Ancestors = 'ancestors',
|
|
96
|
-
/**
|
|
102
|
+
/**
|
|
103
|
+
* Returns the body of the content in different formats, including the editor format, view format, and export
|
|
104
|
+
* format.
|
|
105
|
+
*/
|
|
97
106
|
Body = 'body',
|
|
98
|
-
/**
|
|
107
|
+
/**
|
|
108
|
+
* Returns information about the most recent update of the content, including who updated it and when it was
|
|
109
|
+
* updated.
|
|
110
|
+
*/
|
|
99
111
|
Version = 'version',
|
|
100
112
|
/** Returns pages that are descendants at any level below the content. */
|
|
101
113
|
PageDescendant = 'descendants.page',
|
|
@@ -80,7 +80,10 @@ export namespace GetContentById {
|
|
|
80
80
|
UpdateGroupRestriction = 'restrictions.update.restrictions.group',
|
|
81
81
|
/** Returns the history of the content, including the date it was created. */
|
|
82
82
|
History = 'history',
|
|
83
|
-
/**
|
|
83
|
+
/**
|
|
84
|
+
* Returns information about the most recent update of the content, including who updated it and when it was
|
|
85
|
+
* updated.
|
|
86
|
+
*/
|
|
84
87
|
LastUpdated = 'history.lastUpdated',
|
|
85
88
|
/** Returns information about the update prior to the current content update. */
|
|
86
89
|
PreviousVersion = 'history.previousVersion',
|
|
@@ -90,9 +93,15 @@ export namespace GetContentById {
|
|
|
90
93
|
NextVersion = 'history.nextVersion',
|
|
91
94
|
/** Returns the parent page, if the content is a page. */
|
|
92
95
|
Ancestors = 'ancestors',
|
|
93
|
-
/**
|
|
96
|
+
/**
|
|
97
|
+
* Returns the body of the content in different formats, including the editor format, view format, and export
|
|
98
|
+
* format.
|
|
99
|
+
*/
|
|
94
100
|
Body = 'body',
|
|
95
|
-
/**
|
|
101
|
+
/**
|
|
102
|
+
* Returns information about the most recent update of the content, including who updated it and when it was
|
|
103
|
+
* updated.
|
|
104
|
+
*/
|
|
96
105
|
Version = 'version',
|
|
97
106
|
/** Returns pages that are descendants at any level below the content. */
|
|
98
107
|
PageDescendant = 'descendants.page',
|
|
@@ -4,10 +4,12 @@ export interface GetContentProperties {
|
|
|
4
4
|
/** The key of the content property. */
|
|
5
5
|
key?: string[];
|
|
6
6
|
/**
|
|
7
|
-
* A multi-value parameter indicating which properties of the content to expand. By default, the `version` object is
|
|
7
|
+
* A multi-value parameter indicating which properties of the content to expand. By default, the `version` object is
|
|
8
|
+
* expanded.
|
|
8
9
|
*
|
|
9
10
|
* - `content` returns the content that the property is stored against.
|
|
10
|
-
* - `version` returns information about the version of the property, such as the version number, when it was created,
|
|
11
|
+
* - `version` returns information about the version of the property, such as the version number, when it was created,
|
|
12
|
+
* etc.
|
|
11
13
|
*/
|
|
12
14
|
expand?: string[];
|
|
13
15
|
/** The starting index of the returned properties. */
|
|
@@ -4,22 +4,24 @@ export interface GetContentProperty {
|
|
|
4
4
|
/** The key of the content property. */
|
|
5
5
|
key: string;
|
|
6
6
|
/**
|
|
7
|
-
* A multi-value parameter indicating which properties of the content to expand. By default, the `version` object is
|
|
7
|
+
* A multi-value parameter indicating which properties of the content to expand. By default, the `version` object is
|
|
8
|
+
* expanded.
|
|
8
9
|
*
|
|
9
10
|
* - `content` returns the content that the property is stored against.
|
|
10
|
-
* - `version` returns information about the version of the property, such as the version number, when it was created,
|
|
11
|
+
* - `version` returns information about the version of the property, such as the version number, when it was created,
|
|
12
|
+
* etc.
|
|
11
13
|
*/
|
|
12
14
|
expand?: string[];
|
|
13
15
|
/**
|
|
14
16
|
* Filter the results to a set of content based on their status. If set to `any`, content with any status is returned.
|
|
15
17
|
* By default it will fetch current and archived statuses `?status=current&status=archived`. All supported statuses
|
|
16
18
|
*
|
|
17
|
-
* -
|
|
18
|
-
* -
|
|
19
|
-
* -
|
|
20
|
-
* -
|
|
21
|
-
* -
|
|
22
|
-
* -
|
|
19
|
+
* - Any
|
|
20
|
+
* - Archived
|
|
21
|
+
* - Current
|
|
22
|
+
* - Deleted
|
|
23
|
+
* - Draft
|
|
24
|
+
* - Trashed
|
|
23
25
|
*/
|
|
24
26
|
status?: string[];
|
|
25
27
|
}
|
|
@@ -1,5 +1,8 @@
|
|
|
1
1
|
export interface GetContentTemplates {
|
|
2
|
-
/**
|
|
2
|
+
/**
|
|
3
|
+
* The key of the space to be queried for templates. If the `spaceKey` is not specified, global templates will be
|
|
4
|
+
* returned.
|
|
5
|
+
*/
|
|
3
6
|
spaceKey?: string;
|
|
4
7
|
/** The starting index of the returned templates. */
|
|
5
8
|
start?: number;
|
|
@@ -4,7 +4,8 @@ export interface GetContentVersion {
|
|
|
4
4
|
/** The number of the version to be retrieved. */
|
|
5
5
|
versionNumber: number;
|
|
6
6
|
/**
|
|
7
|
-
* A multi-value parameter indicating which properties of the content to expand. By default, the `content` object is
|
|
7
|
+
* A multi-value parameter indicating which properties of the content to expand. By default, the `content` object is
|
|
8
|
+
* expanded.
|
|
8
9
|
*
|
|
9
10
|
* - `collaborators` returns the users that collaborated on the version.
|
|
10
11
|
* - `content` returns the content for the version.
|
|
@@ -6,7 +6,8 @@ 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. By default, the `content` object is
|
|
9
|
+
* A multi-value parameter indicating which properties of the content to expand. By default, the `content` object is
|
|
10
|
+
* expanded.
|
|
10
11
|
*
|
|
11
12
|
* - `collaborators` returns the users that collaborated on the version.
|
|
12
13
|
* - `content` returns the content for the version.
|
|
@@ -69,7 +69,10 @@ export namespace GetDescendantsOfType {
|
|
|
69
69
|
UpdateGroupRestriction = 'restrictions.update.restrictions.group',
|
|
70
70
|
/** Returns the history of the content, including the date it was created. */
|
|
71
71
|
History = 'history',
|
|
72
|
-
/**
|
|
72
|
+
/**
|
|
73
|
+
* Returns information about the most recent update of the content, including who updated it and when it was
|
|
74
|
+
* updated.
|
|
75
|
+
*/
|
|
73
76
|
LastUpdated = 'history.lastUpdated',
|
|
74
77
|
/** Returns information about the update prior to the current content update. */
|
|
75
78
|
PreviousVersion = 'history.previousVersion',
|
|
@@ -79,9 +82,15 @@ export namespace GetDescendantsOfType {
|
|
|
79
82
|
NextVersion = 'history.nextVersion',
|
|
80
83
|
/** Returns the parent page, if the content is a page. */
|
|
81
84
|
Ancestors = 'ancestors',
|
|
82
|
-
/**
|
|
85
|
+
/**
|
|
86
|
+
* Returns the body of the content in different formats, including the editor format, view format, and export
|
|
87
|
+
* format.
|
|
88
|
+
*/
|
|
83
89
|
Body = 'body',
|
|
84
|
-
/**
|
|
90
|
+
/**
|
|
91
|
+
* Returns information about the most recent update of the content, including who updated it and when it was
|
|
92
|
+
* updated.
|
|
93
|
+
*/
|
|
85
94
|
Version = 'version',
|
|
86
95
|
/** Returns pages that are descendants at any level below the content. */
|
|
87
96
|
PageDescendant = 'descendants.page',
|
|
@@ -2,7 +2,8 @@ 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. Maximum sub-expansions
|
|
5
|
+
* A multi-value parameter indicating which properties of the content history to expand. Maximum sub-expansions
|
|
6
|
+
* allowed is `8`.
|
|
6
7
|
*
|
|
7
8
|
* - `lastUpdated` returns information about the most recent update of the content, including who updated it and when it
|
|
8
9
|
* was updated.
|
|
@@ -8,7 +8,8 @@ export interface GetLabelsForContent {
|
|
|
8
8
|
* - `global` prefix is used by default when a user adds a label via the UI.
|
|
9
9
|
* - `my` prefix can be explicitly added by a user when adding a label via the UI, e.g. 'my:example-label'. Also, when a
|
|
10
10
|
* page is selected as a favourite, the 'my:favourite' label is automatically added.
|
|
11
|
-
* - `team` can used when adding labels via [Add labels to content](#api-content-id-label-post) but is not used in the
|
|
11
|
+
* - `team` can used when adding labels via [Add labels to content](#api-content-id-label-post) but is not used in the
|
|
12
|
+
* UI.
|
|
12
13
|
*/
|
|
13
14
|
prefix?: string;
|
|
14
15
|
/** The starting index of the returned labels. */
|
|
@@ -19,7 +19,10 @@ export interface GetRelationship {
|
|
|
19
19
|
* - If `sourceType` is 'space', then specify the space key.
|
|
20
20
|
*/
|
|
21
21
|
sourceKey: string;
|
|
22
|
-
/**
|
|
22
|
+
/**
|
|
23
|
+
* The target entity type of the relationship. This must be 'space' or 'content', if the `relationName` is
|
|
24
|
+
* 'favourite'.
|
|
25
|
+
*/
|
|
23
26
|
targetType: string;
|
|
24
27
|
/**
|
|
25
28
|
* The identifier for the target entity:
|
|
@@ -27,7 +30,8 @@ export interface GetRelationship {
|
|
|
27
30
|
* - If `targetType` is `user`, then specify either `current` (logged-in user), the user key of the user, or the account
|
|
28
31
|
* ID of the user. Note that the user key has been deprecated in favor of the account ID for this parameter. See the
|
|
29
32
|
* [migration
|
|
30
|
-
* guide](https://developer.atlassian.com/cloud/confluence/deprecation-notice-user-privacy-api-migration-guide/) for
|
|
33
|
+
* guide](https://developer.atlassian.com/cloud/confluence/deprecation-notice-user-privacy-api-migration-guide/) for
|
|
34
|
+
* details.
|
|
31
35
|
* - If `targetType` is 'content', then specify the content ID.
|
|
32
36
|
* - If `targetType` is 'space', then specify the space key.
|
|
33
37
|
*/
|
|
@@ -1,7 +1,13 @@
|
|
|
1
1
|
export interface GetSpaces {
|
|
2
|
-
/**
|
|
2
|
+
/**
|
|
3
|
+
* The key of the space to be returned. To return multiple spaces, specify this parameter multiple times with
|
|
4
|
+
* different values.
|
|
5
|
+
*/
|
|
3
6
|
spaceKey?: string[];
|
|
4
|
-
/**
|
|
7
|
+
/**
|
|
8
|
+
* The id of the space to be returned. To return multiple spaces, specify this parameter multiple times with different
|
|
9
|
+
* values.
|
|
10
|
+
*/
|
|
5
11
|
spaceId?: number[];
|
|
6
12
|
/** Filter the results to spaces based on their type. */
|
|
7
13
|
type?: string;
|
|
@@ -15,7 +21,8 @@ export interface GetSpaces {
|
|
|
15
21
|
*/
|
|
16
22
|
favourite?: boolean;
|
|
17
23
|
/**
|
|
18
|
-
* The userKey of the user, whose favourite spaces are used to filter the results when using the `favourite`
|
|
24
|
+
* The userKey of the user, whose favourite spaces are used to filter the results when using the `favourite`
|
|
25
|
+
* parameter.
|
|
19
26
|
*
|
|
20
27
|
* Leave blank for the current user. Use [Get user](#api-user-get) to get the userKey for a user.
|
|
21
28
|
*/
|
|
@@ -1,7 +1,8 @@
|
|
|
1
1
|
export interface RemoveModules {
|
|
2
2
|
/**
|
|
3
3
|
* The key of the module to remove. To include multiple module keys, provide multiple copies of this parameter. For
|
|
4
|
-
* example, `moduleKey=dynamic-attachment-entity-property&moduleKey=dynamic-select-field`. Nonexistent keys are
|
|
4
|
+
* example, `moduleKey=dynamic-attachment-entity-property&moduleKey=dynamic-select-field`. Nonexistent keys are
|
|
5
|
+
* ignored.
|
|
5
6
|
*/
|
|
6
7
|
moduleKey: string[];
|
|
7
8
|
}
|
|
@@ -4,7 +4,8 @@ export interface RestoreContentVersion extends VersionRestore {
|
|
|
4
4
|
/** The ID of the content for which the history will be restored. */
|
|
5
5
|
id: string;
|
|
6
6
|
/**
|
|
7
|
-
* A multi-value parameter indicating which properties of the content to expand. By default, the `content` object is
|
|
7
|
+
* A multi-value parameter indicating which properties of the content to expand. By default, the `content` object is
|
|
8
|
+
* expanded.
|
|
8
9
|
*
|
|
9
10
|
* - `collaborators` returns the users that collaborated on the version.
|
|
10
11
|
* - `content` returns the content for the version.
|
|
@@ -34,10 +34,10 @@ export interface Search {
|
|
|
34
34
|
* - ContentStatuses Content statuses to search against. Optional. Specify these values in an object.
|
|
35
35
|
*
|
|
36
36
|
* @example
|
|
37
|
-
*
|
|
37
|
+
* 'cqlcontext={%22spaceKey%22:%22TEST%22, %22contentId%22:%22123%22}';
|
|
38
38
|
*/
|
|
39
39
|
cqlcontext?: string;
|
|
40
|
-
/** Pointer to a set of search results, returned as part of the
|
|
40
|
+
/** Pointer to a set of search results, returned as part of the _next_ or _prev_ URL from the previous search call. */
|
|
41
41
|
cursor?: string;
|
|
42
42
|
/**
|
|
43
43
|
* Include content from archived spaces in the results.
|
|
@@ -46,21 +46,21 @@ export namespace UpdateAttachmentProperties {
|
|
|
46
46
|
macroRenderedOutput?: any;
|
|
47
47
|
extensions?: any;
|
|
48
48
|
_expandable?: {
|
|
49
|
-
|
|
50
|
-
|
|
51
|
-
|
|
52
|
-
|
|
53
|
-
|
|
54
|
-
|
|
55
|
-
|
|
56
|
-
|
|
57
|
-
|
|
58
|
-
|
|
59
|
-
|
|
60
|
-
|
|
61
|
-
|
|
62
|
-
|
|
63
|
-
|
|
49
|
+
childTypes: string;
|
|
50
|
+
container: string;
|
|
51
|
+
metadata: string;
|
|
52
|
+
operations: string;
|
|
53
|
+
children: string;
|
|
54
|
+
restrictions: string;
|
|
55
|
+
history: string;
|
|
56
|
+
ancestors: string;
|
|
57
|
+
body: string;
|
|
58
|
+
version: string;
|
|
59
|
+
descendants: string;
|
|
60
|
+
space: string;
|
|
61
|
+
extensions: string;
|
|
62
|
+
schedulePublishDate: string;
|
|
63
|
+
macroRenderedOutput: string;
|
|
64
64
|
};
|
|
65
65
|
_links?: GenericLinks;
|
|
66
66
|
}
|
|
@@ -2,8 +2,8 @@ import { UserPropertyUpdate } from '../models';
|
|
|
2
2
|
|
|
3
3
|
export interface UpdateUserProperty extends UserPropertyUpdate {
|
|
4
4
|
/**
|
|
5
|
-
* The account ID of the user. The accountId uniquely identifies the user across all Atlassian products. For
|
|
6
|
-
*
|
|
5
|
+
* The account ID of the user. The accountId uniquely identifies the user across all Atlassian products. For example,
|
|
6
|
+
* 384093:32b4d9w0-f6a5-3535-11a3-9c8c88d10192
|
|
7
7
|
*/
|
|
8
8
|
userId: string;
|
|
9
9
|
/** The key of the user property. */
|
package/src/api/relation.ts
CHANGED
|
@@ -20,7 +20,7 @@ export class Relation {
|
|
|
20
20
|
*/
|
|
21
21
|
async findTargetFromSource<T = Models.RelationArray>(
|
|
22
22
|
parameters: Parameters.FindTargetFromSource,
|
|
23
|
-
callback: Callback<T
|
|
23
|
+
callback: Callback<T>,
|
|
24
24
|
): Promise<void>;
|
|
25
25
|
/**
|
|
26
26
|
* Returns all target entities that have a particular relationship to the source entity. Note, relationships are one
|
|
@@ -35,7 +35,7 @@ export class Relation {
|
|
|
35
35
|
*/
|
|
36
36
|
async findTargetFromSource<T = Models.RelationArray>(
|
|
37
37
|
parameters: Parameters.FindTargetFromSource,
|
|
38
|
-
callback?: never
|
|
38
|
+
callback?: never,
|
|
39
39
|
): Promise<T>;
|
|
40
40
|
async findTargetFromSource<T = Models.RelationArray>(
|
|
41
41
|
parameters: Parameters.FindTargetFromSource,
|
|
@@ -61,7 +61,7 @@ export class Relation {
|
|
|
61
61
|
/** @deprecated Will be removed in the next major version. Use `getRelationship` instead. */
|
|
62
62
|
async GetRelationship<T = Models.Relation>(
|
|
63
63
|
parameters: Parameters.GetRelationship,
|
|
64
|
-
callback: Callback<T
|
|
64
|
+
callback: Callback<T>,
|
|
65
65
|
): Promise<void>;
|
|
66
66
|
/** @deprecated Will be removed in the next major version. Use `getRelationship` instead. */
|
|
67
67
|
async GetRelationship<T = Models.Relation>(parameters: Parameters.GetRelationship, callback?: never): Promise<T>;
|
|
@@ -85,7 +85,7 @@ export class Relation {
|
|
|
85
85
|
*/
|
|
86
86
|
async getRelationship<T = Models.Relation>(
|
|
87
87
|
parameters: Parameters.GetRelationship,
|
|
88
|
-
callback: Callback<T
|
|
88
|
+
callback: Callback<T>,
|
|
89
89
|
): Promise<void>;
|
|
90
90
|
/**
|
|
91
91
|
* Find whether a particular type of relationship exists from a source entity to a target entity. Note, relationships
|
|
@@ -130,7 +130,7 @@ export class Relation {
|
|
|
130
130
|
*/
|
|
131
131
|
async createRelationship<T = Models.Relation>(
|
|
132
132
|
parameters: Parameters.CreateRelationship,
|
|
133
|
-
callback: Callback<T
|
|
133
|
+
callback: Callback<T>,
|
|
134
134
|
): Promise<void>;
|
|
135
135
|
/**
|
|
136
136
|
* Creates a relationship between two entities (user, space, content). The 'favourite' relationship is supported by
|
|
@@ -144,7 +144,7 @@ export class Relation {
|
|
|
144
144
|
*/
|
|
145
145
|
async createRelationship<T = Models.Relation>(
|
|
146
146
|
parameters: Parameters.CreateRelationship,
|
|
147
|
-
callback?: never
|
|
147
|
+
callback?: never,
|
|
148
148
|
): Promise<T>;
|
|
149
149
|
async createRelationship<T = Models.Relation>(
|
|
150
150
|
parameters: Parameters.CreateRelationship,
|
|
@@ -220,7 +220,7 @@ export class Relation {
|
|
|
220
220
|
*/
|
|
221
221
|
async findSourcesForTarget<T = Models.RelationArray>(
|
|
222
222
|
parameters: Parameters.FindSourcesForTarget,
|
|
223
|
-
callback: Callback<T
|
|
223
|
+
callback: Callback<T>,
|
|
224
224
|
): Promise<void>;
|
|
225
225
|
/**
|
|
226
226
|
* Returns all target entities that have a particular relationship to the source entity. Note, relationships are one
|
|
@@ -236,7 +236,7 @@ export class Relation {
|
|
|
236
236
|
*/
|
|
237
237
|
async findSourcesForTarget<T = Models.RelationArray>(
|
|
238
238
|
parameters: Parameters.FindSourcesForTarget,
|
|
239
|
-
callback?: never
|
|
239
|
+
callback?: never,
|
|
240
240
|
): Promise<T>;
|
|
241
241
|
async findSourcesForTarget<T = Models.RelationArray>(
|
|
242
242
|
parameters: Parameters.FindSourcesForTarget,
|
package/src/api/search.ts
CHANGED
|
@@ -10,7 +10,7 @@ export class Search {
|
|
|
10
10
|
/** @deprecated Will be removed in the next major version. Use `searchByCQL` instead. */
|
|
11
11
|
async search<T = Models.SearchPageResponseSearchResult>(
|
|
12
12
|
parameters: Parameters.Search,
|
|
13
|
-
callback: Callback<T
|
|
13
|
+
callback: Callback<T>,
|
|
14
14
|
): Promise<void>;
|
|
15
15
|
/** @deprecated Will be removed in the next major version. Use `searchByCQL` instead. */
|
|
16
16
|
async search<T = Models.SearchPageResponseSearchResult>(parameters: Parameters.Search, callback?: never): Promise<T>;
|
|
@@ -34,7 +34,7 @@ export class Search {
|
|
|
34
34
|
*/
|
|
35
35
|
async searchByCQL<T = Models.SearchPageResponseSearchResult>(
|
|
36
36
|
parameters: Parameters.SearchByCQL,
|
|
37
|
-
callback: Callback<T
|
|
37
|
+
callback: Callback<T>,
|
|
38
38
|
): Promise<void>;
|
|
39
39
|
/**
|
|
40
40
|
* Searches for content using the [Confluence Query Language
|
|
@@ -49,7 +49,7 @@ export class Search {
|
|
|
49
49
|
*/
|
|
50
50
|
async searchByCQL<T = Models.SearchPageResponseSearchResult>(
|
|
51
51
|
parameters: Parameters.SearchByCQL,
|
|
52
|
-
callback?: never
|
|
52
|
+
callback?: never,
|
|
53
53
|
): Promise<T>;
|
|
54
54
|
async searchByCQL<T = Models.SearchPageResponseSearchResult>(
|
|
55
55
|
parameters: Parameters.SearchByCQL,
|
|
@@ -80,12 +80,12 @@ export class Search {
|
|
|
80
80
|
/** @deprecated Will be removed in the next major version. Use `searchUser` instead. */
|
|
81
81
|
async userSearch<T = Models.SearchPageResponseSearchResult>(
|
|
82
82
|
parameters: Parameters.UserSearch,
|
|
83
|
-
callback: Callback<T
|
|
83
|
+
callback: Callback<T>,
|
|
84
84
|
): Promise<void>;
|
|
85
85
|
/** @deprecated Will be removed in the next major version. Use `searchUser` instead. */
|
|
86
86
|
async userSearch<T = Models.SearchPageResponseSearchResult>(
|
|
87
87
|
parameters: Parameters.UserSearch,
|
|
88
|
-
callback?: never
|
|
88
|
+
callback?: never,
|
|
89
89
|
): Promise<T>;
|
|
90
90
|
async userSearch<T = Models.SearchPageResponseSearchResult>(
|
|
91
91
|
parameters: Parameters.UserSearch,
|
|
@@ -103,7 +103,7 @@ export class Search {
|
|
|
103
103
|
*/
|
|
104
104
|
async searchUser<T = Models.SearchPageResponseSearchResult>(
|
|
105
105
|
parameters: Parameters.SearchUser,
|
|
106
|
-
callback: Callback<T
|
|
106
|
+
callback: Callback<T>,
|
|
107
107
|
): Promise<void>;
|
|
108
108
|
/**
|
|
109
109
|
* Searches for users using user-specific queries from the [Confluence Query Language
|
|
@@ -114,7 +114,7 @@ export class Search {
|
|
|
114
114
|
*/
|
|
115
115
|
async searchUser<T = Models.SearchPageResponseSearchResult>(
|
|
116
116
|
parameters: Parameters.SearchUser,
|
|
117
|
-
callback?: never
|
|
117
|
+
callback?: never,
|
|
118
118
|
): Promise<T>;
|
|
119
119
|
async searchUser<T = Models.SearchPageResponseSearchResult>(
|
|
120
120
|
parameters: Parameters.SearchUser,
|