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
|
@@ -79,7 +79,10 @@ export declare namespace GetContentById {
|
|
|
79
79
|
UpdateGroupRestriction = "restrictions.update.restrictions.group",
|
|
80
80
|
/** Returns the history of the content, including the date it was created. */
|
|
81
81
|
History = "history",
|
|
82
|
-
/**
|
|
82
|
+
/**
|
|
83
|
+
* Returns information about the most recent update of the content, including who updated it and when it was
|
|
84
|
+
* updated.
|
|
85
|
+
*/
|
|
83
86
|
LastUpdated = "history.lastUpdated",
|
|
84
87
|
/** Returns information about the update prior to the current content update. */
|
|
85
88
|
PreviousVersion = "history.previousVersion",
|
|
@@ -89,9 +92,15 @@ export declare namespace GetContentById {
|
|
|
89
92
|
NextVersion = "history.nextVersion",
|
|
90
93
|
/** Returns the parent page, if the content is a page. */
|
|
91
94
|
Ancestors = "ancestors",
|
|
92
|
-
/**
|
|
95
|
+
/**
|
|
96
|
+
* Returns the body of the content in different formats, including the editor format, view format, and export
|
|
97
|
+
* format.
|
|
98
|
+
*/
|
|
93
99
|
Body = "body",
|
|
94
|
-
/**
|
|
100
|
+
/**
|
|
101
|
+
* Returns information about the most recent update of the content, including who updated it and when it was
|
|
102
|
+
* updated.
|
|
103
|
+
*/
|
|
95
104
|
Version = "version",
|
|
96
105
|
/** Returns pages that are descendants at any level below the content. */
|
|
97
106
|
PageDescendant = "descendants.page",
|
|
@@ -56,7 +56,10 @@ var GetContentById;
|
|
|
56
56
|
Expand["UpdateGroupRestriction"] = "restrictions.update.restrictions.group";
|
|
57
57
|
/** Returns the history of the content, including the date it was created. */
|
|
58
58
|
Expand["History"] = "history";
|
|
59
|
-
/**
|
|
59
|
+
/**
|
|
60
|
+
* Returns information about the most recent update of the content, including who updated it and when it was
|
|
61
|
+
* updated.
|
|
62
|
+
*/
|
|
60
63
|
Expand["LastUpdated"] = "history.lastUpdated";
|
|
61
64
|
/** Returns information about the update prior to the current content update. */
|
|
62
65
|
Expand["PreviousVersion"] = "history.previousVersion";
|
|
@@ -66,9 +69,15 @@ var GetContentById;
|
|
|
66
69
|
Expand["NextVersion"] = "history.nextVersion";
|
|
67
70
|
/** Returns the parent page, if the content is a page. */
|
|
68
71
|
Expand["Ancestors"] = "ancestors";
|
|
69
|
-
/**
|
|
72
|
+
/**
|
|
73
|
+
* Returns the body of the content in different formats, including the editor format, view format, and export
|
|
74
|
+
* format.
|
|
75
|
+
*/
|
|
70
76
|
Expand["Body"] = "body";
|
|
71
|
-
/**
|
|
77
|
+
/**
|
|
78
|
+
* Returns information about the most recent update of the content, including who updated it and when it was
|
|
79
|
+
* updated.
|
|
80
|
+
*/
|
|
72
81
|
Expand["Version"] = "version";
|
|
73
82
|
/** Returns pages that are descendants at any level below the content. */
|
|
74
83
|
Expand["PageDescendant"] = "descendants.page";
|
|
@@ -86,5 +95,5 @@ var GetContentById;
|
|
|
86
95
|
/** Returns the resolution status of each comment. */
|
|
87
96
|
Expand["Resolution"] = "extensions.resolution";
|
|
88
97
|
})(Expand = GetContentById.Expand || (GetContentById.Expand = {}));
|
|
89
|
-
})(GetContentById
|
|
98
|
+
})(GetContentById || (exports.GetContentById = GetContentById = {}));
|
|
90
99
|
//# sourceMappingURL=getContentById.js.map
|
|
@@ -1 +1 @@
|
|
|
1
|
-
{"version":3,"file":"getContentById.js","sourceRoot":"","sources":["../../../src/api/parameters/getContentById.ts"],"names":[],"mappings":";;;AA6BA,IAAiB,cAAc,
|
|
1
|
+
{"version":3,"file":"getContentById.js","sourceRoot":"","sources":["../../../src/api/parameters/getContentById.ts"],"names":[],"mappings":";;;AA6BA,IAAiB,cAAc,CA4F9B;AA5FD,WAAiB,cAAc;IAC7B,IAAY,MA0FX;IA1FD,WAAY,MAAM;QAChB;;;WAGG;QACH,0CAAgC,CAAA;QAChC,mDAAmD;QACnD,uDAA6C,CAAA;QAC7C,gDAAgD;QAChD,iDAAuC,CAAA;QACvC,mDAAmD;QACnD,2CAAiC,CAAA;QACjC;;;WAGG;QACH,iCAAuB,CAAA;QACvB;;;WAGG;QACH,sDAA4C,CAAA;QAC5C,iFAAiF;QACjF,oDAA0C,CAAA;QAC1C,8DAA8D;QAC9D,4CAAkC,CAAA;QAClC,+CAA+C;QAC/C,gDAAsC,CAAA;QACtC,uFAAuF;QACvF,mCAAyB,CAAA;QACzB,qFAAqF;QACrF,wCAA8B,CAAA;QAC9B,+CAA+C;QAC/C,oDAA0C,CAAA;QAC1C,2CAA2C;QAC3C,8CAAoC,CAAA;QACpC,kEAAkE;QAClE,qEAA2D,CAAA;QAC3D;;;WAGG;QACH,uEAA6D,CAAA;QAC7D,oEAAoE;QACpE,yEAA+D,CAAA;QAC/D;;;WAGG;QACH,2EAAiE,CAAA;QACjE,6EAA6E;QAC7E,6BAAmB,CAAA;QACnB;;;WAGG;QACH,6CAAmC,CAAA;QACnC,gFAAgF;QAChF,qDAA2C,CAAA;QAC3C,oEAAoE;QACpE,+CAAqC,CAAA;QACrC,gFAAgF;QAChF,6CAAmC,CAAA;QACnC,yDAAyD;QACzD,iCAAuB,CAAA;QACvB;;;WAGG;QACH,uBAAa,CAAA;QACb;;;WAGG;QACH,6BAAmB,CAAA;QACnB,yEAAyE;QACzE,6CAAmC,CAAA;QACnC,8EAA8E;QAC9E,yDAA+C,CAAA;QAC/C,uEAAuE;QACvE,mDAAyC,CAAA;QACzC;;;WAGG;QACH,yBAAe,CAAA;QACf,kDAAkD;QAClD,0DAAgD,CAAA;QAChD,qDAAqD;QACrD,8CAAoC,CAAA;IACtC,CAAC,EA1FW,MAAM,GAAN,qBAAM,KAAN,qBAAM,QA0FjB;AACH,CAAC,EA5FgB,cAAc,8BAAd,cAAc,QA4F9B"}
|
|
@@ -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.
|
|
@@ -68,7 +68,10 @@ export declare namespace GetDescendantsOfType {
|
|
|
68
68
|
UpdateGroupRestriction = "restrictions.update.restrictions.group",
|
|
69
69
|
/** Returns the history of the content, including the date it was created. */
|
|
70
70
|
History = "history",
|
|
71
|
-
/**
|
|
71
|
+
/**
|
|
72
|
+
* Returns information about the most recent update of the content, including who updated it and when it was
|
|
73
|
+
* updated.
|
|
74
|
+
*/
|
|
72
75
|
LastUpdated = "history.lastUpdated",
|
|
73
76
|
/** Returns information about the update prior to the current content update. */
|
|
74
77
|
PreviousVersion = "history.previousVersion",
|
|
@@ -78,9 +81,15 @@ export declare namespace GetDescendantsOfType {
|
|
|
78
81
|
NextVersion = "history.nextVersion",
|
|
79
82
|
/** Returns the parent page, if the content is a page. */
|
|
80
83
|
Ancestors = "ancestors",
|
|
81
|
-
/**
|
|
84
|
+
/**
|
|
85
|
+
* Returns the body of the content in different formats, including the editor format, view format, and export
|
|
86
|
+
* format.
|
|
87
|
+
*/
|
|
82
88
|
Body = "body",
|
|
83
|
-
/**
|
|
89
|
+
/**
|
|
90
|
+
* Returns information about the most recent update of the content, including who updated it and when it was
|
|
91
|
+
* updated.
|
|
92
|
+
*/
|
|
84
93
|
Version = "version",
|
|
85
94
|
/** Returns pages that are descendants at any level below the content. */
|
|
86
95
|
PageDescendant = "descendants.page",
|
|
@@ -56,7 +56,10 @@ var GetDescendantsOfType;
|
|
|
56
56
|
Expand["UpdateGroupRestriction"] = "restrictions.update.restrictions.group";
|
|
57
57
|
/** Returns the history of the content, including the date it was created. */
|
|
58
58
|
Expand["History"] = "history";
|
|
59
|
-
/**
|
|
59
|
+
/**
|
|
60
|
+
* Returns information about the most recent update of the content, including who updated it and when it was
|
|
61
|
+
* updated.
|
|
62
|
+
*/
|
|
60
63
|
Expand["LastUpdated"] = "history.lastUpdated";
|
|
61
64
|
/** Returns information about the update prior to the current content update. */
|
|
62
65
|
Expand["PreviousVersion"] = "history.previousVersion";
|
|
@@ -66,9 +69,15 @@ var GetDescendantsOfType;
|
|
|
66
69
|
Expand["NextVersion"] = "history.nextVersion";
|
|
67
70
|
/** Returns the parent page, if the content is a page. */
|
|
68
71
|
Expand["Ancestors"] = "ancestors";
|
|
69
|
-
/**
|
|
72
|
+
/**
|
|
73
|
+
* Returns the body of the content in different formats, including the editor format, view format, and export
|
|
74
|
+
* format.
|
|
75
|
+
*/
|
|
70
76
|
Expand["Body"] = "body";
|
|
71
|
-
/**
|
|
77
|
+
/**
|
|
78
|
+
* Returns information about the most recent update of the content, including who updated it and when it was
|
|
79
|
+
* updated.
|
|
80
|
+
*/
|
|
72
81
|
Expand["Version"] = "version";
|
|
73
82
|
/** Returns pages that are descendants at any level below the content. */
|
|
74
83
|
Expand["PageDescendant"] = "descendants.page";
|
|
@@ -86,5 +95,5 @@ var GetDescendantsOfType;
|
|
|
86
95
|
/** Returns the resolution status of each comment. */
|
|
87
96
|
Expand["Resolution"] = "extensions.resolution";
|
|
88
97
|
})(Expand = GetDescendantsOfType.Expand || (GetDescendantsOfType.Expand = {}));
|
|
89
|
-
})(GetDescendantsOfType
|
|
98
|
+
})(GetDescendantsOfType || (exports.GetDescendantsOfType = GetDescendantsOfType = {}));
|
|
90
99
|
//# sourceMappingURL=getDescendantsOfType.js.map
|
|
@@ -1 +1 @@
|
|
|
1
|
-
{"version":3,"file":"getDescendantsOfType.js","sourceRoot":"","sources":["../../../src/api/parameters/getDescendantsOfType.ts"],"names":[],"mappings":";;;AAkBA,IAAiB,oBAAoB,
|
|
1
|
+
{"version":3,"file":"getDescendantsOfType.js","sourceRoot":"","sources":["../../../src/api/parameters/getDescendantsOfType.ts"],"names":[],"mappings":";;;AAkBA,IAAiB,oBAAoB,CA4FpC;AA5FD,WAAiB,oBAAoB;IACnC,IAAY,MA0FX;IA1FD,WAAY,MAAM;QAChB;;;WAGG;QACH,0CAAgC,CAAA;QAChC,mDAAmD;QACnD,uDAA6C,CAAA;QAC7C,gDAAgD;QAChD,iDAAuC,CAAA;QACvC,mDAAmD;QACnD,2CAAiC,CAAA;QACjC;;;WAGG;QACH,iCAAuB,CAAA;QACvB;;;WAGG;QACH,sDAA4C,CAAA;QAC5C,iFAAiF;QACjF,oDAA0C,CAAA;QAC1C,8DAA8D;QAC9D,4CAAkC,CAAA;QAClC,+CAA+C;QAC/C,gDAAsC,CAAA;QACtC,uFAAuF;QACvF,mCAAyB,CAAA;QACzB,qFAAqF;QACrF,wCAA8B,CAAA;QAC9B,+CAA+C;QAC/C,oDAA0C,CAAA;QAC1C,2CAA2C;QAC3C,8CAAoC,CAAA;QACpC,kEAAkE;QAClE,qEAA2D,CAAA;QAC3D;;;WAGG;QACH,uEAA6D,CAAA;QAC7D,oEAAoE;QACpE,yEAA+D,CAAA;QAC/D;;;WAGG;QACH,2EAAiE,CAAA;QACjE,6EAA6E;QAC7E,6BAAmB,CAAA;QACnB;;;WAGG;QACH,6CAAmC,CAAA;QACnC,gFAAgF;QAChF,qDAA2C,CAAA;QAC3C,oEAAoE;QACpE,+CAAqC,CAAA;QACrC,gFAAgF;QAChF,6CAAmC,CAAA;QACnC,yDAAyD;QACzD,iCAAuB,CAAA;QACvB;;;WAGG;QACH,uBAAa,CAAA;QACb;;;WAGG;QACH,6BAAmB,CAAA;QACnB,yEAAyE;QACzE,6CAAmC,CAAA;QACnC,8EAA8E;QAC9E,yDAA+C,CAAA;QAC/C,uEAAuE;QACvE,mDAAyC,CAAA;QACzC;;;WAGG;QACH,yBAAe,CAAA;QACf,kDAAkD;QAClD,0DAAgD,CAAA;QAChD,qDAAqD;QACrD,8CAAoC,CAAA;IACtC,CAAC,EA1FW,MAAM,GAAN,2BAAM,KAAN,2BAAM,QA0FjB;AACH,CAAC,EA5FgB,oBAAoB,oCAApB,oBAAoB,QA4FpC"}
|
|
@@ -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
|
}
|
|
@@ -3,7 +3,8 @@ 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 content to expand. By default, the `content` object is
|
|
6
|
+
* A multi-value parameter indicating which properties of the content to expand. By default, the `content` object is
|
|
7
|
+
* expanded.
|
|
7
8
|
*
|
|
8
9
|
* - `collaborators` returns the users that collaborated on the version.
|
|
9
10
|
* - `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.
|
|
@@ -30,21 +30,21 @@ export declare namespace UpdateAttachmentProperties {
|
|
|
30
30
|
macroRenderedOutput?: any;
|
|
31
31
|
extensions?: any;
|
|
32
32
|
_expandable?: {
|
|
33
|
-
|
|
34
|
-
|
|
35
|
-
|
|
36
|
-
|
|
37
|
-
|
|
38
|
-
|
|
39
|
-
|
|
40
|
-
|
|
41
|
-
|
|
42
|
-
|
|
43
|
-
|
|
44
|
-
|
|
45
|
-
|
|
46
|
-
|
|
47
|
-
|
|
33
|
+
childTypes: string;
|
|
34
|
+
container: string;
|
|
35
|
+
metadata: string;
|
|
36
|
+
operations: string;
|
|
37
|
+
children: string;
|
|
38
|
+
restrictions: string;
|
|
39
|
+
history: string;
|
|
40
|
+
ancestors: string;
|
|
41
|
+
body: string;
|
|
42
|
+
version: string;
|
|
43
|
+
descendants: string;
|
|
44
|
+
space: string;
|
|
45
|
+
extensions: string;
|
|
46
|
+
schedulePublishDate: string;
|
|
47
|
+
macroRenderedOutput: string;
|
|
48
48
|
};
|
|
49
49
|
_links?: GenericLinks;
|
|
50
50
|
}
|
|
@@ -1,8 +1,8 @@
|
|
|
1
1
|
import { UserPropertyUpdate } from '../models';
|
|
2
2
|
export interface UpdateUserProperty extends UserPropertyUpdate {
|
|
3
3
|
/**
|
|
4
|
-
* The account ID of the user. The accountId uniquely identifies the user across all Atlassian products. For
|
|
5
|
-
*
|
|
4
|
+
* The account ID of the user. The accountId uniquely identifies the user across all Atlassian products. For example,
|
|
5
|
+
* 384093:32b4d9w0-f6a5-3535-11a3-9c8c88d10192
|
|
6
6
|
*/
|
|
7
7
|
userId: string;
|
|
8
8
|
/** The key of the user property. */
|
|
@@ -5,7 +5,6 @@ import type { RequestConfig } from '../requestConfig';
|
|
|
5
5
|
export declare class BaseClient implements Client {
|
|
6
6
|
#private;
|
|
7
7
|
protected readonly config: Config;
|
|
8
|
-
protected urlSuffix: string;
|
|
9
8
|
constructor(config: Config);
|
|
10
9
|
protected paramSerializer(parameters: Record<string, any>): string;
|
|
11
10
|
protected encode(value: string): string;
|
|
@@ -11,7 +11,7 @@ class BaseClient {
|
|
|
11
11
|
constructor(config) {
|
|
12
12
|
this.config = config;
|
|
13
13
|
_BaseClient_instance.set(this, void 0);
|
|
14
|
-
this.
|
|
14
|
+
this.config.apiPrefix = this.config.apiPrefix || '/wiki/rest/';
|
|
15
15
|
}
|
|
16
16
|
paramSerializer(parameters) {
|
|
17
17
|
const parts = [];
|
|
@@ -59,7 +59,7 @@ class BaseClient {
|
|
|
59
59
|
if (tslib_1.__classPrivateFieldGet(this, _BaseClient_instance, "f")) {
|
|
60
60
|
return tslib_1.__classPrivateFieldGet(this, _BaseClient_instance, "f");
|
|
61
61
|
}
|
|
62
|
-
tslib_1.__classPrivateFieldSet(this, _BaseClient_instance, axios_1.default.create(Object.assign(Object.assign({ paramsSerializer: this.paramSerializer.bind(this) }, this.config.baseRequestConfig), { baseURL: `${this.config.host}${this.
|
|
62
|
+
tslib_1.__classPrivateFieldSet(this, _BaseClient_instance, axios_1.default.create(Object.assign(Object.assign({ paramsSerializer: this.paramSerializer.bind(this) }, this.config.baseRequestConfig), { baseURL: `${this.config.host}${this.config.apiPrefix}`, headers: this.removeUndefinedProperties(Object.assign({ [ATLASSIAN_TOKEN_CHECK_FLAG]: this.config.noCheckAtlassianToken
|
|
63
63
|
? ATLASSIAN_TOKEN_CHECK_NOCHECK_VALUE
|
|
64
64
|
: undefined }, (_a = this.config.baseRequestConfig) === null || _a === void 0 ? void 0 : _a.headers)) })), "f");
|
|
65
65
|
return tslib_1.__classPrivateFieldGet(this, _BaseClient_instance, "f");
|
|
@@ -1 +1 @@
|
|
|
1
|
-
{"version":3,"file":"baseClient.js","sourceRoot":"","sources":["../../src/clients/baseClient.ts"],"names":[],"mappings":";;;;;AAAA,6EAA0E;AAK1E,iCAA6C;AAE7C,MAAM,0BAA0B,GAAG,mBAAmB,CAAC;AACvD,MAAM,mCAAmC,GAAG,UAAU,CAAC;AAEvD,MAAa,UAAU;
|
|
1
|
+
{"version":3,"file":"baseClient.js","sourceRoot":"","sources":["../../src/clients/baseClient.ts"],"names":[],"mappings":";;;;;AAAA,6EAA0E;AAK1E,iCAA6C;AAE7C,MAAM,0BAA0B,GAAG,mBAAmB,CAAC;AACvD,MAAM,mCAAmC,GAAG,UAAU,CAAC;AAEvD,MAAa,UAAU;IAGrB,YAA+B,MAAc;QAAd,WAAM,GAAN,MAAM,CAAQ;QAF7C,uCAAqC;QAGnC,IAAI,CAAC,MAAM,CAAC,SAAS,GAAG,IAAI,CAAC,MAAM,CAAC,SAAS,IAAI,aAAa,CAAC;IACjE,CAAC;IAES,eAAe,CAAC,UAA+B;QACvD,MAAM,KAAK,GAAa,EAAE,CAAC;QAE3B,MAAM,CAAC,OAAO,CAAC,UAAU,CAAC,CAAC,OAAO,CAAC,CAAC,CAAC,GAAG,EAAE,KAAK,CAAC,EAAE,EAAE;YAClD,IAAI,KAAK,KAAK,IAAI,IAAI,OAAO,KAAK,KAAK,WAAW,EAAE;gBAClD,OAAO;aACR;YAED,IAAI,KAAK,CAAC,OAAO,CAAC,KAAK,CAAC,EAAE;gBACxB,6CAA6C;gBAC7C,KAAK,GAAG,KAAK,CAAC,IAAI,CAAC,GAAG,CAAC,CAAC;aACzB;YAED,IAAI,KAAK,YAAY,IAAI,EAAE;gBACzB,6CAA6C;gBAC7C,KAAK,GAAG,KAAK,CAAC,WAAW,EAAE,CAAC;aAC7B;iBAAM,IAAI,KAAK,KAAK,IAAI,IAAI,OAAO,KAAK,KAAK,QAAQ,EAAE;gBACtD,6CAA6C;gBAC7C,KAAK,GAAG,IAAI,CAAC,SAAS,CAAC,KAAK,CAAC,CAAC;aAC/B;iBAAM,IAAI,KAAK,YAAY,QAAQ,EAAE;gBACpC,MAAM,IAAI,GAAG,KAAK,EAAE,CAAC;gBAErB,OAAO,IAAI,IAAI,KAAK,CAAC,IAAI,CAAC,IAAI,CAAC,CAAC;aACjC;YAED,KAAK,CAAC,IAAI,CAAC,GAAG,IAAI,CAAC,MAAM,CAAC,GAAG,CAAC,IAAI,IAAI,CAAC,MAAM,CAAC,KAAK,CAAC,EAAE,CAAC,CAAC;YAExD,OAAO;QACT,CAAC,CAAC,CAAC;QAEH,OAAO,KAAK,CAAC,IAAI,CAAC,GAAG,CAAC,CAAC;IACzB,CAAC;IAES,MAAM,CAAC,KAAa;QAC5B,OAAO,kBAAkB,CAAC,KAAK,CAAC;aAC7B,OAAO,CAAC,OAAO,EAAE,GAAG,CAAC;aACrB,OAAO,CAAC,MAAM,EAAE,GAAG,CAAC;aACpB,OAAO,CAAC,OAAO,EAAE,GAAG,CAAC;aACrB,OAAO,CAAC,MAAM,EAAE,GAAG,CAAC;aACpB,OAAO,CAAC,OAAO,EAAE,GAAG,CAAC;aACrB,OAAO,CAAC,OAAO,EAAE,GAAG,CAAC,CAAC;IAC3B,CAAC;IAES,yBAAyB,CAAC,GAAwB;QAC1D,OAAO,MAAM,CAAC,OAAO,CAAC,GAAG,CAAC;aACvB,MAAM,CAAC,CAAC,CAAC,EAAE,KAAK,CAAC,EAAE,EAAE,CAAC,OAAO,KAAK,KAAK,WAAW,CAAC;aACnD,MAAM,CAAC,CAAC,WAAW,EAAE,CAAC,GAAG,EAAE,KAAK,CAAC,EAAE,EAAE,CAAC,iCAAM,WAAW,KAAE,CAAC,GAAG,CAAC,EAAE,KAAK,IAAG,EAAE,EAAE,CAAC,CAAC;IACnF,CAAC;IAED,IAAY,QAAQ;;QAClB,IAAI,+BAAA,IAAI,4BAAU,EAAE;YAClB,OAAO,+BAAA,IAAI,4BAAU,CAAC;SACvB;QAED,+BAAA,IAAI,wBAAa,eAAK,CAAC,MAAM,+BAC3B,gBAAgB,EAAE,IAAI,CAAC,eAAe,CAAC,IAAI,CAAC,IAAI,CAAC,IAC9C,IAAI,CAAC,MAAM,CAAC,iBAAiB,KAChC,OAAO,EAAE,GAAG,IAAI,CAAC,MAAM,CAAC,IAAI,GAAG,IAAI,CAAC,MAAM,CAAC,SAAS,EAAE,EACtD,OAAO,EAAE,IAAI,CAAC,yBAAyB,iBACrC,CAAC,0BAA0B,CAAC,EAAE,IAAI,CAAC,MAAM,CAAC,qBAAqB;oBAC7D,CAAC,CAAC,mCAAmC;oBACrC,CAAC,CAAC,SAAS,IACV,MAAA,IAAI,CAAC,MAAM,CAAC,iBAAiB,0CAAE,OAAO,EACzC,IACF,MAAA,CAAC;QAEH,OAAO,+BAAA,IAAI,4BAAU,CAAC;IACxB,CAAC;IAIK,WAAW,CAAI,aAA4B,EAAE,QAA6B;;;YAC9E,IAAI;gBACF,MAAM,qBAAqB,mCACtB,aAAa,KAChB,OAAO,EAAE,IAAI,CAAC,yBAAyB,iBACrC,aAAa,EAAE,MAAM,6CAAqB,CAAC,sBAAsB,CAAC,IAAI,CAAC,MAAM,CAAC,cAAc,EAAE;4BAC5F,OAAO,EAAE,IAAI,CAAC,MAAM,CAAC,IAAI;4BACzB,GAAG,EAAE,IAAI,CAAC,QAAQ,CAAC,MAAM,CAAC,aAAa,CAAC;4BACxC,MAAM,EAAE,aAAa,CAAC,MAAO;yBAC9B,CAAC,IACC,aAAa,CAAC,OAAO,EACxB,GACH,CAAC;gBAEF,MAAM,QAAQ,GAAG,MAAM,IAAI,CAAC,QAAQ,CAAC,OAAO,CAAI,qBAAqB,CAAC,CAAC;gBAEvE,MAAM,uBAAuB,GAAG,QAAQ,IAAI,CAAC,CAAC,IAAO,EAAQ,EAAE,CAAC,QAAQ,CAAC,IAAI,EAAE,IAAI,CAAC,CAAC,CAAC;gBACtF,MAAM,sBAAsB,GAAG,CAAC,IAAO,EAAK,EAAE,CAAC,IAAI,CAAC;gBAEpD,MAAM,eAAe,GAAG,uBAAuB,aAAvB,uBAAuB,cAAvB,uBAAuB,GAAI,sBAAsB,CAAC;gBAE1E,MAAA,MAAA,IAAI,CAAC,MAAM,CAAC,WAAW,0CAAE,UAAU,mDAAG,QAAQ,CAAC,IAAI,CAAC,CAAC;gBAErD,OAAO,eAAe,CAAC,QAAQ,CAAC,IAAI,CAAC,CAAC;aACvC;YAAC,OAAO,CAAM,EAAE;gBACf,MAAM,GAAG,GAAG,IAAI,CAAC,MAAM,CAAC,gBAAgB,IAAI,CAAC,CAAC,YAAY,CAAC,CAAC,CAAC,CAAC,CAAC,QAAQ,CAAC,IAAI,CAAC,CAAC,CAAC,CAAC,CAAC;gBAEjF,MAAM,oBAAoB,GAAG,QAAQ,IAAI,CAAC,CAAC,KAAmB,EAAE,EAAE,CAAC,QAAQ,CAAC,KAAK,CAAC,CAAC,CAAC;gBACpF,MAAM,mBAAmB,GAAG,CAAC,KAAY,EAAE,EAAE;oBAC3C,MAAM,KAAK,CAAC;gBACd,CAAC,CAAC;gBAEF,MAAM,YAAY,GAAG,oBAAoB,aAApB,oBAAoB,cAApB,oBAAoB,GAAI,mBAAmB,CAAC;gBAEjE,MAAA,MAAA,IAAI,CAAC,MAAM,CAAC,WAAW,0CAAE,OAAO,mDAAG,GAAG,CAAC,CAAC;gBAExC,OAAO,YAAY,CAAC,GAAG,CAAC,CAAC;aAC1B;;KACF;CACF;AArHD,gCAqHC"}
|
|
@@ -1,6 +1,8 @@
|
|
|
1
1
|
import { BaseClient } from './baseClient';
|
|
2
|
+
import { Config } from '../config';
|
|
2
3
|
import { Analytics, Audit, Content, ContentAttachments, ContentBody, ContentChildrenAndDescendants, ContentComments, ContentContentState, ContentLabels, ContentMacroBody, ContentPermissions, ContentProperties, ContentRestrictions, ContentStates, ContentVersions, ContentWatches, DynamicModules, Experimental, Group, InlineTasks, LabelInfo, LongRunningTask, Relation, Search, Settings, Space, SpacePermissions, SpaceProperties, SpaceSettings, Template, Themes, Users } from '../api';
|
|
3
4
|
export declare class ConfluenceClient extends BaseClient {
|
|
5
|
+
constructor(config: Config);
|
|
4
6
|
analytics: Analytics;
|
|
5
7
|
audit: Audit;
|
|
6
8
|
content: Content;
|
|
@@ -4,8 +4,9 @@ exports.ConfluenceClient = void 0;
|
|
|
4
4
|
const baseClient_1 = require("./baseClient");
|
|
5
5
|
const api_1 = require("../api");
|
|
6
6
|
class ConfluenceClient extends baseClient_1.BaseClient {
|
|
7
|
-
constructor() {
|
|
8
|
-
|
|
7
|
+
constructor(config) {
|
|
8
|
+
var _a;
|
|
9
|
+
super(Object.assign(Object.assign({}, config), { apiPrefix: (_a = config.apiPrefix) !== null && _a !== void 0 ? _a : '/wiki/rest' }));
|
|
9
10
|
this.analytics = new api_1.Analytics(this);
|
|
10
11
|
this.audit = new api_1.Audit(this);
|
|
11
12
|
this.content = new api_1.Content(this);
|
|
@@ -1 +1 @@
|
|
|
1
|
-
{"version":3,"file":"confluenceClient.js","sourceRoot":"","sources":["../../src/clients/confluenceClient.ts"],"names":[],"mappings":";;;AAAA,6CAA0C;
|
|
1
|
+
{"version":3,"file":"confluenceClient.js","sourceRoot":"","sources":["../../src/clients/confluenceClient.ts"],"names":[],"mappings":";;;AAAA,6CAA0C;AAE1C,gCAiCgB;AAEhB,MAAa,gBAAiB,SAAQ,uBAAU;IAC9C,YAAY,MAAc;;QACxB,KAAK,iCACA,MAAM,KACT,SAAS,EAAE,MAAA,MAAM,CAAC,SAAS,mCAAI,YAAY,IAC3C,CAAC;QAGL,cAAS,GAAG,IAAI,eAAS,CAAC,IAAI,CAAC,CAAC;QAChC,UAAK,GAAG,IAAI,WAAK,CAAC,IAAI,CAAC,CAAC;QACxB,YAAO,GAAG,IAAI,aAAO,CAAC,IAAI,CAAC,CAAC;QAC5B,uBAAkB,GAAG,IAAI,wBAAkB,CAAC,IAAI,CAAC,CAAC;QAClD,gBAAW,GAAG,IAAI,iBAAW,CAAC,IAAI,CAAC,CAAC;QACpC,kCAA6B,GAAG,IAAI,mCAA6B,CAAC,IAAI,CAAC,CAAC;QACxE,oBAAe,GAAG,IAAI,qBAAe,CAAC,IAAI,CAAC,CAAC;QAC5C,wBAAmB,GAAG,IAAI,yBAAmB,CAAC,IAAI,CAAC,CAAC;QACpD,kBAAa,GAAG,IAAI,mBAAa,CAAC,IAAI,CAAC,CAAC;QACxC,qBAAgB,GAAG,IAAI,sBAAgB,CAAC,IAAI,CAAC,CAAC;QAC9C,uBAAkB,GAAG,IAAI,wBAAkB,CAAC,IAAI,CAAC,CAAC;QAClD,sBAAiB,GAAG,IAAI,uBAAiB,CAAC,IAAI,CAAC,CAAC;QAChD,wBAAmB,GAAG,IAAI,yBAAmB,CAAC,IAAI,CAAC,CAAC;QACpD,kBAAa,GAAG,IAAI,mBAAa,CAAC,IAAI,CAAC,CAAC;QACxC,oBAAe,GAAG,IAAI,qBAAe,CAAC,IAAI,CAAC,CAAC;QAC5C,mBAAc,GAAG,IAAI,oBAAc,CAAC,IAAI,CAAC,CAAC;QAC1C,mBAAc,GAAG,IAAI,oBAAc,CAAC,IAAI,CAAC,CAAC;QAC1C,iBAAY,GAAG,IAAI,kBAAY,CAAC,IAAI,CAAC,CAAC;QACtC,UAAK,GAAG,IAAI,WAAK,CAAC,IAAI,CAAC,CAAC;QACxB,gBAAW,GAAG,IAAI,iBAAW,CAAC,IAAI,CAAC,CAAC;QACpC,cAAS,GAAG,IAAI,eAAS,CAAC,IAAI,CAAC,CAAC;QAChC,oBAAe,GAAG,IAAI,qBAAe,CAAC,IAAI,CAAC,CAAC;QAC5C,aAAQ,GAAG,IAAI,cAAQ,CAAC,IAAI,CAAC,CAAC;QAC9B,WAAM,GAAG,IAAI,YAAM,CAAC,IAAI,CAAC,CAAC;QAC1B,aAAQ,GAAG,IAAI,cAAQ,CAAC,IAAI,CAAC,CAAC;QAC9B,UAAK,GAAG,IAAI,WAAK,CAAC,IAAI,CAAC,CAAC;QACxB,qBAAgB,GAAG,IAAI,sBAAgB,CAAC,IAAI,CAAC,CAAC;QAC9C,oBAAe,GAAG,IAAI,qBAAe,CAAC,IAAI,CAAC,CAAC;QAC5C,kBAAa,GAAG,IAAI,mBAAa,CAAC,IAAI,CAAC,CAAC;QACxC,aAAQ,GAAG,IAAI,cAAQ,CAAC,IAAI,CAAC,CAAC;QAC9B,WAAM,GAAG,IAAI,YAAM,CAAC,IAAI,CAAC,CAAC;QAC1B,UAAK,GAAG,IAAI,WAAK,CAAC,IAAI,CAAC,CAAC;IAjCxB,CAAC;CAkCF;AAxCD,4CAwCC"}
|
|
@@ -1,7 +1,8 @@
|
|
|
1
1
|
import { BaseClient } from './baseClient';
|
|
2
|
+
import { Config } from '../config';
|
|
2
3
|
import { Audit, Content, ContentBody, Group, LongTask, Search, Space, User } from '../server';
|
|
3
4
|
export declare class ServerClient extends BaseClient {
|
|
4
|
-
|
|
5
|
+
constructor(config: Config);
|
|
5
6
|
audit: Audit;
|
|
6
7
|
content: Content;
|
|
7
8
|
contentBody: ContentBody;
|
|
@@ -4,9 +4,9 @@ exports.ServerClient = void 0;
|
|
|
4
4
|
const baseClient_1 = require("./baseClient");
|
|
5
5
|
const server_1 = require("../server");
|
|
6
6
|
class ServerClient extends baseClient_1.BaseClient {
|
|
7
|
-
constructor() {
|
|
8
|
-
|
|
9
|
-
|
|
7
|
+
constructor(config) {
|
|
8
|
+
var _a;
|
|
9
|
+
super(Object.assign(Object.assign({}, config), { apiPrefix: (_a = config.apiPrefix) !== null && _a !== void 0 ? _a : '/' }));
|
|
10
10
|
this.audit = new server_1.Audit(this);
|
|
11
11
|
this.content = new server_1.Content(this);
|
|
12
12
|
this.contentBody = new server_1.ContentBody(this);
|
|
@@ -1 +1 @@
|
|
|
1
|
-
{"version":3,"file":"serverClient.js","sourceRoot":"","sources":["../../src/clients/serverClient.ts"],"names":[],"mappings":";;;AAAA,6CAA0C;
|
|
1
|
+
{"version":3,"file":"serverClient.js","sourceRoot":"","sources":["../../src/clients/serverClient.ts"],"names":[],"mappings":";;;AAAA,6CAA0C;AAE1C,sCAA8F;AAE9F,MAAa,YAAa,SAAQ,uBAAU;IAC1C,YAAY,MAAc;;QACxB,KAAK,iCACA,MAAM,KACT,SAAS,EAAE,MAAA,MAAM,CAAC,SAAS,mCAAI,GAAG,IAClC,CAAC;QAGL,UAAK,GAAG,IAAI,cAAK,CAAC,IAAI,CAAC,CAAC;QACxB,YAAO,GAAG,IAAI,gBAAO,CAAC,IAAI,CAAC,CAAC;QAC5B,gBAAW,GAAG,IAAI,oBAAW,CAAC,IAAI,CAAC,CAAC;QACpC,UAAK,GAAG,IAAI,cAAK,CAAC,IAAI,CAAC,CAAC;QACxB,aAAQ,GAAG,IAAI,iBAAQ,CAAC,IAAI,CAAC,CAAC;QAC9B,WAAM,GAAG,IAAI,eAAM,CAAC,IAAI,CAAC,CAAC;QAC1B,UAAK,GAAG,IAAI,cAAK,CAAC,IAAI,CAAC,CAAC;QACxB,SAAI,GAAG,IAAI,aAAI,CAAC,IAAI,CAAC,CAAC;IATtB,CAAC;CAUF;AAhBD,oCAgBC"}
|
package/out/config.d.ts
CHANGED
|
@@ -8,27 +8,27 @@ export interface Config {
|
|
|
8
8
|
middlewares?: Config.Middlewares;
|
|
9
9
|
/** @deprecated Disabled. Will be removed in the next major version. */
|
|
10
10
|
telemetry?: Config.Telemetry;
|
|
11
|
-
/**
|
|
12
|
-
* Adds `'X-Atlassian-Token': 'no-check'` to each request header
|
|
13
|
-
*/
|
|
11
|
+
/** Adds `'X-Atlassian-Token': 'no-check'` to each request header */
|
|
14
12
|
noCheckAtlassianToken?: boolean;
|
|
15
13
|
/** Enable new API error handling. `false` by default. */
|
|
16
14
|
newErrorHandling?: boolean;
|
|
15
|
+
/** Prefix for all API routes. */
|
|
16
|
+
apiPrefix?: string;
|
|
17
17
|
}
|
|
18
18
|
export declare namespace Config {
|
|
19
19
|
type BaseRequestConfig = RequestConfig;
|
|
20
20
|
type Error = AxiosError;
|
|
21
21
|
/** @deprecated Disabled. Will be removed in the next major version. */
|
|
22
22
|
type Telemetry = boolean | any;
|
|
23
|
-
type Authentication = UtilityTypes.
|
|
23
|
+
type Authentication = UtilityTypes.XOR4<{
|
|
24
24
|
jwt: Authentication.JWT;
|
|
25
|
-
},
|
|
25
|
+
}, {
|
|
26
26
|
personalAccessToken: Authentication.PersonalAccessToken;
|
|
27
|
-
},
|
|
27
|
+
}, {
|
|
28
28
|
basic: Authentication.Basic;
|
|
29
29
|
}, {
|
|
30
30
|
oauth2: Authentication.OAuth2;
|
|
31
|
-
}
|
|
31
|
+
}>;
|
|
32
32
|
interface Middlewares {
|
|
33
33
|
onError?: Config.Middlewares.OnErrorHandler;
|
|
34
34
|
onResponse?: Config.Middlewares.OnResponseHandler;
|
|
@@ -20,12 +20,16 @@ export interface CreateAuditRecord {
|
|
|
20
20
|
remoteAddress: string;
|
|
21
21
|
/**
|
|
22
22
|
* The creation date-time of the audit record, as a timestamp. This is converted to a date-time display in the
|
|
23
|
-
* Confluence UI. If the `creationDate` is not specified, then it will be set to the timestamp for the current
|
|
23
|
+
* Confluence UI. If the `creationDate` is not specified, then it will be set to the timestamp for the current
|
|
24
|
+
* date-time.
|
|
24
25
|
*/
|
|
25
26
|
creationDate?: number;
|
|
26
27
|
/** The summary of the event, which is displayed in the 'Change' column on the audit log in the Confluence UI. */
|
|
27
28
|
summary?: string;
|
|
28
|
-
/**
|
|
29
|
+
/**
|
|
30
|
+
* A long description of the event, which is displayed in the 'Description' field on the audit log in the Confluence
|
|
31
|
+
* UI.
|
|
32
|
+
*/
|
|
29
33
|
description?: string;
|
|
30
34
|
/** The category of the event, which is displayed in the 'Event type' column on the audit log in the Confluence UI. */
|
|
31
35
|
category?: string;
|