confluence.js 1.6.3 → 1.7.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/.prettierrc +8 -3
- package/CHANGELOG.md +4 -0
- package/README.md +16 -0
- package/out/api/contentChildrenAndDescendants.js +3 -0
- package/out/api/contentChildrenAndDescendants.js.map +1 -1
- 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 +25 -25
- 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 +14 -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
|
@@ -11,9 +11,9 @@ const ATLASSIAN_TOKEN_CHECK_NOCHECK_VALUE = 'no-check';
|
|
|
11
11
|
export class BaseClient implements Client {
|
|
12
12
|
#instance: AxiosInstance | undefined;
|
|
13
13
|
|
|
14
|
-
protected
|
|
15
|
-
|
|
16
|
-
|
|
14
|
+
constructor(protected readonly config: Config) {
|
|
15
|
+
this.config.apiPrefix = this.config.apiPrefix || '/wiki/rest/';
|
|
16
|
+
}
|
|
17
17
|
|
|
18
18
|
protected paramSerializer(parameters: Record<string, any>): string {
|
|
19
19
|
const parts: string[] = [];
|
|
@@ -72,7 +72,7 @@ export class BaseClient implements Client {
|
|
|
72
72
|
this.#instance = axios.create({
|
|
73
73
|
paramsSerializer: this.paramSerializer.bind(this),
|
|
74
74
|
...this.config.baseRequestConfig,
|
|
75
|
-
baseURL: `${this.config.host}${this.
|
|
75
|
+
baseURL: `${this.config.host}${this.config.apiPrefix}`,
|
|
76
76
|
headers: this.removeUndefinedProperties({
|
|
77
77
|
[ATLASSIAN_TOKEN_CHECK_FLAG]: this.config.noCheckAtlassianToken
|
|
78
78
|
? ATLASSIAN_TOKEN_CHECK_NOCHECK_VALUE
|
|
@@ -1,4 +1,5 @@
|
|
|
1
1
|
import { BaseClient } from './baseClient';
|
|
2
|
+
import { Config } from '../config';
|
|
2
3
|
import {
|
|
3
4
|
Analytics,
|
|
4
5
|
Audit,
|
|
@@ -35,6 +36,13 @@ import {
|
|
|
35
36
|
} from '../api';
|
|
36
37
|
|
|
37
38
|
export class ConfluenceClient extends BaseClient {
|
|
39
|
+
constructor(config: Config) {
|
|
40
|
+
super({
|
|
41
|
+
...config,
|
|
42
|
+
apiPrefix: config.apiPrefix ?? '/wiki/rest',
|
|
43
|
+
});
|
|
44
|
+
}
|
|
45
|
+
|
|
38
46
|
analytics = new Analytics(this);
|
|
39
47
|
audit = new Audit(this);
|
|
40
48
|
content = new Content(this);
|
|
@@ -1,8 +1,14 @@
|
|
|
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
|
|
|
4
5
|
export class ServerClient extends BaseClient {
|
|
5
|
-
|
|
6
|
+
constructor(config: Config) {
|
|
7
|
+
super({
|
|
8
|
+
...config,
|
|
9
|
+
apiPrefix: config.apiPrefix ?? '/',
|
|
10
|
+
});
|
|
11
|
+
}
|
|
6
12
|
|
|
7
13
|
audit = new Audit(this);
|
|
8
14
|
content = new Content(this);
|
package/src/config.ts
CHANGED
|
@@ -9,12 +9,12 @@ export interface Config {
|
|
|
9
9
|
middlewares?: Config.Middlewares;
|
|
10
10
|
/** @deprecated Disabled. Will be removed in the next major version. */
|
|
11
11
|
telemetry?: Config.Telemetry;
|
|
12
|
-
/**
|
|
13
|
-
* Adds `'X-Atlassian-Token': 'no-check'` to each request header
|
|
14
|
-
*/
|
|
12
|
+
/** Adds `'X-Atlassian-Token': 'no-check'` to each request header */
|
|
15
13
|
noCheckAtlassianToken?: boolean;
|
|
16
14
|
/** Enable new API error handling. `false` by default. */
|
|
17
15
|
newErrorHandling?: boolean;
|
|
16
|
+
/** Prefix for all API routes. */
|
|
17
|
+
apiPrefix?: string;
|
|
18
18
|
}
|
|
19
19
|
|
|
20
20
|
export namespace Config {
|
|
@@ -23,15 +23,20 @@ export namespace Config {
|
|
|
23
23
|
/** @deprecated Disabled. Will be removed in the next major version. */
|
|
24
24
|
export type Telemetry = boolean | any;
|
|
25
25
|
|
|
26
|
-
export type Authentication = UtilityTypes.
|
|
26
|
+
export type Authentication = UtilityTypes.XOR4<
|
|
27
|
+
{
|
|
27
28
|
jwt: Authentication.JWT;
|
|
28
|
-
},
|
|
29
|
+
},
|
|
30
|
+
{
|
|
29
31
|
personalAccessToken: Authentication.PersonalAccessToken;
|
|
30
|
-
},
|
|
32
|
+
},
|
|
33
|
+
{
|
|
31
34
|
basic: Authentication.Basic;
|
|
32
|
-
},
|
|
35
|
+
},
|
|
36
|
+
{
|
|
33
37
|
oauth2: Authentication.OAuth2;
|
|
34
|
-
}
|
|
38
|
+
}
|
|
39
|
+
>;
|
|
35
40
|
|
|
36
41
|
export interface Middlewares {
|
|
37
42
|
onError?: Config.Middlewares.OnErrorHandler;
|
|
@@ -55,13 +60,16 @@ export namespace Config {
|
|
|
55
60
|
expiryTimeSeconds?: number;
|
|
56
61
|
};
|
|
57
62
|
|
|
58
|
-
export type Basic = UtilityTypes.XOR<
|
|
63
|
+
export type Basic = UtilityTypes.XOR<
|
|
64
|
+
{
|
|
59
65
|
email: string;
|
|
60
66
|
apiToken: string;
|
|
61
|
-
},
|
|
67
|
+
},
|
|
68
|
+
{
|
|
62
69
|
username: string;
|
|
63
70
|
password: string;
|
|
64
|
-
}
|
|
71
|
+
}
|
|
72
|
+
>;
|
|
65
73
|
|
|
66
74
|
export type OAuth2 = {
|
|
67
75
|
accessToken: string;
|
package/src/server/audit.ts
CHANGED
|
@@ -11,12 +11,12 @@ export class Audit {
|
|
|
11
11
|
/** Fetch a paginated list of AuditRecord instances dating back to a certain time */
|
|
12
12
|
async getAuditRecords<T = Pagination<Models.AuditRecord>>(
|
|
13
13
|
parameters: Parameters.GetAuditRecords | undefined,
|
|
14
|
-
callback: Callback<T
|
|
14
|
+
callback: Callback<T>,
|
|
15
15
|
): Promise<void>;
|
|
16
16
|
/** Fetch a paginated list of AuditRecord instances dating back to a certain time */
|
|
17
17
|
async getAuditRecords<T = Pagination<Models.AuditRecord>>(
|
|
18
18
|
parameters?: Parameters.GetAuditRecords,
|
|
19
|
-
callback?: never
|
|
19
|
+
callback?: never,
|
|
20
20
|
): Promise<T>;
|
|
21
21
|
async getAuditRecords<T = Pagination<Models.AuditRecord>>(
|
|
22
22
|
parameters?: Parameters.GetAuditRecords,
|
|
@@ -40,12 +40,12 @@ export class Audit {
|
|
|
40
40
|
/** Creates a record in the audit log. */
|
|
41
41
|
async createAuditRecord<T = Models.AuditRecord>(
|
|
42
42
|
parameters: Parameters.CreateAuditRecord,
|
|
43
|
-
callback: Callback<T
|
|
43
|
+
callback: Callback<T>,
|
|
44
44
|
): Promise<void>;
|
|
45
45
|
/** Creates a record in the audit log. */
|
|
46
46
|
async createAuditRecord<T = Models.AuditRecord>(
|
|
47
47
|
parameters: Parameters.CreateAuditRecord,
|
|
48
|
-
callback?: never
|
|
48
|
+
callback?: never,
|
|
49
49
|
): Promise<T>;
|
|
50
50
|
async createAuditRecord<T = Models.AuditRecord>(
|
|
51
51
|
parameters: Parameters.CreateAuditRecord,
|
|
@@ -74,7 +74,7 @@ export class Audit {
|
|
|
74
74
|
/** Exports audit records as a CSV file or ZIP file. */
|
|
75
75
|
async exportAuditRecords<T = ArrayBuffer>(
|
|
76
76
|
parameters: Parameters.ExportAuditRecords | undefined,
|
|
77
|
-
callback: Callback<T
|
|
77
|
+
callback: Callback<T>,
|
|
78
78
|
): Promise<void>;
|
|
79
79
|
/** Exports audit records as a CSV file or ZIP file. */
|
|
80
80
|
async exportAuditRecords<T = ArrayBuffer>(parameters?: Parameters.ExportAuditRecords, callback?: never): Promise<T>;
|
|
@@ -112,12 +112,12 @@ export class Audit {
|
|
|
112
112
|
/** Set the retention period to a new value. Can throw ServiceException if the retention period is too long */
|
|
113
113
|
async setRetentionPeriod<T = Models.RetentionPeriod>(
|
|
114
114
|
parameters: Models.RetentionPeriod,
|
|
115
|
-
callback: Callback<T
|
|
115
|
+
callback: Callback<T>,
|
|
116
116
|
): Promise<void>;
|
|
117
117
|
/** Set the retention period to a new value. Can throw ServiceException if the retention period is too long */
|
|
118
118
|
async setRetentionPeriod<T = Models.RetentionPeriod>(
|
|
119
119
|
parameters: Models.RetentionPeriod,
|
|
120
|
-
callback?: never
|
|
120
|
+
callback?: never,
|
|
121
121
|
): Promise<T>;
|
|
122
122
|
async setRetentionPeriod<T = Models.RetentionPeriod>(
|
|
123
123
|
parameters: Models.RetentionPeriod,
|
|
@@ -138,12 +138,12 @@ export class Audit {
|
|
|
138
138
|
/** Fetch a paginated list of AuditRecord instances dating back to a certain time */
|
|
139
139
|
async getAuditRecordsForTimePeriod<T = Pagination<Models.AuditRecord>>(
|
|
140
140
|
parameters: Parameters.GetAuditRecordsSince | undefined,
|
|
141
|
-
callback: Callback<T
|
|
141
|
+
callback: Callback<T>,
|
|
142
142
|
): Promise<void>;
|
|
143
143
|
/** Fetch a paginated list of AuditRecord instances dating back to a certain time */
|
|
144
144
|
async getAuditRecordsForTimePeriod<T = Pagination<Models.AuditRecord>>(
|
|
145
145
|
parameters?: Parameters.GetAuditRecordsSince,
|
|
146
|
-
callback?: never
|
|
146
|
+
callback?: never,
|
|
147
147
|
): Promise<T>;
|
|
148
148
|
async getAuditRecordsForTimePeriod<T = Pagination<Models.AuditRecord>>(
|
|
149
149
|
parameters?: Parameters.GetAuditRecordsSince,
|
package/src/server/content.ts
CHANGED
|
@@ -11,7 +11,7 @@ export class Content {
|
|
|
11
11
|
/** Returns a paginated list of Content. */
|
|
12
12
|
async getContent<T = Pagination<Models.Content>>(
|
|
13
13
|
parameters: Parameters.GetContent | undefined,
|
|
14
|
-
callback: Callback<T
|
|
14
|
+
callback: Callback<T>,
|
|
15
15
|
): Promise<void>;
|
|
16
16
|
/** Returns a paginated list of Content. */
|
|
17
17
|
async getContent<T = Pagination<Models.Content>>(parameters?: Parameters.GetContent, callback?: never): Promise<T>;
|
|
@@ -44,7 +44,7 @@ export class Content {
|
|
|
44
44
|
*/
|
|
45
45
|
async createContent<T = Models.Content>(
|
|
46
46
|
parameters: Parameters.CreateContent | undefined,
|
|
47
|
-
callback: Callback<T
|
|
47
|
+
callback: Callback<T>,
|
|
48
48
|
): Promise<void>;
|
|
49
49
|
/**
|
|
50
50
|
* Creates a new piece of Content or publishes the draft if the content id is present.For the case publishing draft, a
|
|
@@ -193,7 +193,7 @@ export class Content {
|
|
|
193
193
|
*/
|
|
194
194
|
async getMacroBodyByHash<T = Models.MacroInstance>(
|
|
195
195
|
parameters: Parameters.GetMacroBodyByHash,
|
|
196
|
-
callback: Callback<T
|
|
196
|
+
callback: Callback<T>,
|
|
197
197
|
): Promise<void>;
|
|
198
198
|
/**
|
|
199
199
|
* Returns the body of a macro (in storage format) with the given hash. This resource is primarily used by connect
|
|
@@ -212,7 +212,7 @@ export class Content {
|
|
|
212
212
|
*/
|
|
213
213
|
async getMacroBodyByHash<T = Models.MacroInstance>(
|
|
214
214
|
parameters: Parameters.GetMacroBodyByHash,
|
|
215
|
-
callback?: never
|
|
215
|
+
callback?: never,
|
|
216
216
|
): Promise<T>;
|
|
217
217
|
async getMacroBodyByHash<T = Models.MacroInstance>(
|
|
218
218
|
parameters: Parameters.GetMacroBodyByHash,
|
|
@@ -239,7 +239,7 @@ export class Content {
|
|
|
239
239
|
*/
|
|
240
240
|
async getMacroBodyByMacroId<T = Models.MacroInstance>(
|
|
241
241
|
parameters: Parameters.GetMacroBodyByMacroId,
|
|
242
|
-
callback: Callback<T
|
|
242
|
+
callback: Callback<T>,
|
|
243
243
|
): Promise<void>;
|
|
244
244
|
/**
|
|
245
245
|
* Returns the body of a macro (in storage format) with the given id. This resource is primarily used by connect
|
|
@@ -254,7 +254,7 @@ export class Content {
|
|
|
254
254
|
*/
|
|
255
255
|
async getMacroBodyByMacroId<T = Models.MacroInstance>(
|
|
256
256
|
parameters: Parameters.GetMacroBodyByMacroId,
|
|
257
|
-
callback?: never
|
|
257
|
+
callback?: never,
|
|
258
258
|
): Promise<T>;
|
|
259
259
|
async getMacroBodyByMacroId<T = Models.MacroInstance>(
|
|
260
260
|
parameters: Parameters.GetMacroBodyByMacroId,
|
|
@@ -271,12 +271,12 @@ export class Content {
|
|
|
271
271
|
/** Fetch a list of content using the Confluence Query Language (CQL). See: Advanced searching using CQL */
|
|
272
272
|
async searchContent<T = Pagination<Models.Content>>(
|
|
273
273
|
parameters: Parameters.SearchContent | undefined,
|
|
274
|
-
callback: Callback<T
|
|
274
|
+
callback: Callback<T>,
|
|
275
275
|
): Promise<void>;
|
|
276
276
|
/** Fetch a list of content using the Confluence Query Language (CQL). See: Advanced searching using CQL */
|
|
277
277
|
async searchContent<T = Pagination<Models.Content>>(
|
|
278
278
|
parameters?: Parameters.SearchContent,
|
|
279
|
-
callback?: never
|
|
279
|
+
callback?: never,
|
|
280
280
|
): Promise<T>;
|
|
281
281
|
async searchContent<T = Pagination<Models.Content>>(
|
|
282
282
|
parameters?: Parameters.SearchContent,
|
|
@@ -309,7 +309,7 @@ export class Content {
|
|
|
309
309
|
*/
|
|
310
310
|
async getContentChildren<T = Models.ContentChildren>(
|
|
311
311
|
parameters: Parameters.GetContentChildren,
|
|
312
|
-
callback: Callback<T
|
|
312
|
+
callback: Callback<T>,
|
|
313
313
|
): Promise<void>;
|
|
314
314
|
/**
|
|
315
315
|
* Returns a map of the direct children of a piece of Content. Content can have multiple types of children - for
|
|
@@ -323,7 +323,7 @@ export class Content {
|
|
|
323
323
|
*/
|
|
324
324
|
async getContentChildren<T = Models.ContentChildren>(
|
|
325
325
|
parameters: Parameters.GetContentChildren,
|
|
326
|
-
callback?: never
|
|
326
|
+
callback?: never,
|
|
327
327
|
): Promise<T>;
|
|
328
328
|
async getContentChildren<T = Models.ContentChildren>(
|
|
329
329
|
parameters: Parameters.GetContentChildren,
|
|
@@ -350,7 +350,7 @@ export class Content {
|
|
|
350
350
|
*/
|
|
351
351
|
async getContentChildrenByType<T = Pagination<Models.Content>>(
|
|
352
352
|
parameters: Parameters.GetContentChildrenByType,
|
|
353
|
-
callback: Callback<T
|
|
353
|
+
callback: Callback<T>,
|
|
354
354
|
): Promise<void>;
|
|
355
355
|
/**
|
|
356
356
|
* Returns the direct children of a piece of Content, limited to a single child type.
|
|
@@ -359,7 +359,7 @@ export class Content {
|
|
|
359
359
|
*/
|
|
360
360
|
async getContentChildrenByType<T = Pagination<Models.Content>>(
|
|
361
361
|
parameters: Parameters.GetContentChildrenByType,
|
|
362
|
-
callback?: never
|
|
362
|
+
callback?: never,
|
|
363
363
|
): Promise<T>;
|
|
364
364
|
async getContentChildrenByType<T = Pagination<Models.Content>>(
|
|
365
365
|
parameters: Parameters.GetContentChildrenByType,
|
|
@@ -382,12 +382,12 @@ export class Content {
|
|
|
382
382
|
/** Returns the comments of a content */
|
|
383
383
|
async getContentComments<T = Pagination<Models.Content>>(
|
|
384
384
|
parameters: Parameters.GetContentComments,
|
|
385
|
-
callback: Callback<T
|
|
385
|
+
callback: Callback<T>,
|
|
386
386
|
): Promise<void>;
|
|
387
387
|
/** Returns the comments of a content */
|
|
388
388
|
async getContentComments<T = Pagination<Models.Content>>(
|
|
389
389
|
parameters: Parameters.GetContentComments,
|
|
390
|
-
callback?: never
|
|
390
|
+
callback?: never,
|
|
391
391
|
): Promise<T>;
|
|
392
392
|
async getContentComments<T = Pagination<Models.Content>>(
|
|
393
393
|
parameters: Parameters.GetContentComments,
|
|
@@ -412,12 +412,12 @@ export class Content {
|
|
|
412
412
|
/** Returns a paginated list of attachment Content entities within a single container. */
|
|
413
413
|
async getAttachments<T = Pagination<Models.Content>>(
|
|
414
414
|
parameters: Parameters.GetAttachments,
|
|
415
|
-
callback: Callback<T
|
|
415
|
+
callback: Callback<T>,
|
|
416
416
|
): Promise<void>;
|
|
417
417
|
/** Returns a paginated list of attachment Content entities within a single container. */
|
|
418
418
|
async getAttachments<T = Pagination<Models.Content>>(
|
|
419
419
|
parameters: Parameters.GetAttachments,
|
|
420
|
-
callback?: never
|
|
420
|
+
callback?: never,
|
|
421
421
|
): Promise<T>;
|
|
422
422
|
async getAttachments<T = Pagination<Models.Content>>(
|
|
423
423
|
parameters: Parameters.GetAttachments,
|
|
@@ -465,7 +465,7 @@ export class Content {
|
|
|
465
465
|
*/
|
|
466
466
|
async createAttachments<T = Pagination<Models.Content>>(
|
|
467
467
|
parameters: Parameters.CreateAttachments,
|
|
468
|
-
callback: Callback<T
|
|
468
|
+
callback: Callback<T>,
|
|
469
469
|
): Promise<void>;
|
|
470
470
|
/**
|
|
471
471
|
* Add one or more attachments to a Confluence Content entity, with optional comments.
|
|
@@ -494,7 +494,7 @@ export class Content {
|
|
|
494
494
|
*/
|
|
495
495
|
async createAttachments<T = Pagination<Models.Content>>(
|
|
496
496
|
parameters: Parameters.CreateAttachments,
|
|
497
|
-
callback?: never
|
|
497
|
+
callback?: never,
|
|
498
498
|
): Promise<T>;
|
|
499
499
|
async createAttachments<T = Pagination<Models.Content>>(
|
|
500
500
|
parameters: Parameters.CreateAttachments,
|
|
@@ -527,7 +527,7 @@ export class Content {
|
|
|
527
527
|
*/
|
|
528
528
|
async updateAttachmentProperties<T = Models.Content>(
|
|
529
529
|
parameters: Parameters.UpdateAttachmentProperties,
|
|
530
|
-
callback: Callback<T
|
|
530
|
+
callback: Callback<T>,
|
|
531
531
|
): Promise<void>;
|
|
532
532
|
/**
|
|
533
533
|
* Update the non-binary data of an Attachment.
|
|
@@ -536,7 +536,7 @@ export class Content {
|
|
|
536
536
|
*/
|
|
537
537
|
async updateAttachmentProperties<T = Models.Content>(
|
|
538
538
|
parameters: Parameters.UpdateAttachmentProperties,
|
|
539
|
-
callback?: never
|
|
539
|
+
callback?: never,
|
|
540
540
|
): Promise<T>;
|
|
541
541
|
async updateAttachmentProperties<T = Models.Content>(
|
|
542
542
|
parameters: Parameters.UpdateAttachmentProperties,
|
|
@@ -583,7 +583,7 @@ export class Content {
|
|
|
583
583
|
*/
|
|
584
584
|
async updateAttachmentData<T = Models.Content>(
|
|
585
585
|
parameters: Parameters.UpdateAttachmentData,
|
|
586
|
-
callback: Callback<T
|
|
586
|
+
callback: Callback<T>,
|
|
587
587
|
): Promise<void>;
|
|
588
588
|
/**
|
|
589
589
|
* Update the binary data of an Attachment, and optionally the comment and the minor edit field. This adds a new
|
|
@@ -613,7 +613,7 @@ export class Content {
|
|
|
613
613
|
*/
|
|
614
614
|
async updateAttachmentData<T = Models.Content>(
|
|
615
615
|
parameters: Parameters.UpdateAttachmentData,
|
|
616
|
-
callback?: never
|
|
616
|
+
callback?: never,
|
|
617
617
|
): Promise<T>;
|
|
618
618
|
async updateAttachmentData<T = Models.Content>(
|
|
619
619
|
parameters: Parameters.UpdateAttachmentData,
|
|
@@ -650,7 +650,7 @@ export class Content {
|
|
|
650
650
|
*/
|
|
651
651
|
async getContentDescendants<T = Models.ContentChildren>(
|
|
652
652
|
parameters: Parameters.GetContentDescendants,
|
|
653
|
-
callback: Callback<T
|
|
653
|
+
callback: Callback<T>,
|
|
654
654
|
): Promise<void>;
|
|
655
655
|
/**
|
|
656
656
|
* Returns a map of the descendants of a piece of Content. Content can have multiple types of descendants - for
|
|
@@ -666,7 +666,7 @@ export class Content {
|
|
|
666
666
|
*/
|
|
667
667
|
async getContentDescendants<T = Models.ContentChildren>(
|
|
668
668
|
parameters: Parameters.GetContentDescendants,
|
|
669
|
-
callback?: never
|
|
669
|
+
callback?: never,
|
|
670
670
|
): Promise<T>;
|
|
671
671
|
async getContentDescendants<T = Models.ContentChildren>(
|
|
672
672
|
parameters: Parameters.GetContentDescendants,
|
|
@@ -692,7 +692,7 @@ export class Content {
|
|
|
692
692
|
*/
|
|
693
693
|
async getContentDescendantsOfType<T = Pagination<Models.Content>>(
|
|
694
694
|
parameters: Parameters.GetContentDescendantsOfType,
|
|
695
|
-
callback: Callback<T
|
|
695
|
+
callback: Callback<T>,
|
|
696
696
|
): Promise<void>;
|
|
697
697
|
/**
|
|
698
698
|
* Returns the direct descendants of a piece of Content, limited to a single descendant type.
|
|
@@ -703,7 +703,7 @@ export class Content {
|
|
|
703
703
|
*/
|
|
704
704
|
async getContentDescendantsOfType<T = Pagination<Models.Content>>(
|
|
705
705
|
parameters: Parameters.GetContentDescendantsOfType,
|
|
706
|
-
callback?: never
|
|
706
|
+
callback?: never,
|
|
707
707
|
): Promise<T>;
|
|
708
708
|
async getContentDescendantsOfType<T = Pagination<Models.Content>>(
|
|
709
709
|
parameters: Parameters.GetContentDescendantsOfType,
|
|
@@ -725,12 +725,12 @@ export class Content {
|
|
|
725
725
|
/** Returns the list of labels on a piece of Content. */
|
|
726
726
|
async getContentLabels<T = Pagination<Models.Label>>(
|
|
727
727
|
parameters: Parameters.GetContentLabels,
|
|
728
|
-
callback: Callback<T
|
|
728
|
+
callback: Callback<T>,
|
|
729
729
|
): Promise<void>;
|
|
730
730
|
/** Returns the list of labels on a piece of Content. */
|
|
731
731
|
async getContentLabels<T = Pagination<Models.Label>>(
|
|
732
732
|
parameters: Parameters.GetContentLabels,
|
|
733
|
-
callback?: never
|
|
733
|
+
callback?: never,
|
|
734
734
|
): Promise<T>;
|
|
735
735
|
async getContentLabels<T = Pagination<Models.Label>>(
|
|
736
736
|
parameters: Parameters.GetContentLabels,
|
|
@@ -752,12 +752,12 @@ export class Content {
|
|
|
752
752
|
/** Adds a list of labels to the specified content. The body is the json representation of the list. */
|
|
753
753
|
async addLabelsToContent<T = Pagination<Models.Label>>(
|
|
754
754
|
parameters: Parameters.AddLabelsToContent,
|
|
755
|
-
callback: Callback<T
|
|
755
|
+
callback: Callback<T>,
|
|
756
756
|
): Promise<void>;
|
|
757
757
|
/** Adds a list of labels to the specified content. The body is the json representation of the list. */
|
|
758
758
|
async addLabelsToContent<T = Pagination<Models.Label>>(
|
|
759
759
|
parameters: Parameters.AddLabelsToContent,
|
|
760
|
-
callback?: never
|
|
760
|
+
callback?: never,
|
|
761
761
|
): Promise<T>;
|
|
762
762
|
async addLabelsToContent<T = Pagination<Models.Label>>(
|
|
763
763
|
parameters: Parameters.AddLabelsToContent,
|
|
@@ -775,12 +775,12 @@ export class Content {
|
|
|
775
775
|
/** Deletes a labels to the specified content. */
|
|
776
776
|
async deleteLabelWithQueryParam<T = void>(
|
|
777
777
|
parameters: Parameters.DeleteLabelWithQueryParam,
|
|
778
|
-
callback: Callback<T
|
|
778
|
+
callback: Callback<T>,
|
|
779
779
|
): Promise<void>;
|
|
780
780
|
/** Deletes a labels to the specified content. */
|
|
781
781
|
async deleteLabelWithQueryParam<T = void>(
|
|
782
782
|
parameters: Parameters.DeleteLabelWithQueryParam,
|
|
783
|
-
callback?: never
|
|
783
|
+
callback?: never,
|
|
784
784
|
): Promise<T>;
|
|
785
785
|
async deleteLabelWithQueryParam<T = void>(
|
|
786
786
|
parameters: Parameters.DeleteLabelWithQueryParam,
|
|
@@ -821,12 +821,12 @@ export class Content {
|
|
|
821
821
|
/** Returns a paginated list of content properties. */
|
|
822
822
|
async getContentProperties<T = Pagination<Models.ContentProperty>>(
|
|
823
823
|
parameters: Parameters.GetContentProperties,
|
|
824
|
-
callback: Callback<T
|
|
824
|
+
callback: Callback<T>,
|
|
825
825
|
): Promise<void>;
|
|
826
826
|
/** Returns a paginated list of content properties. */
|
|
827
827
|
async getContentProperties<T = Pagination<Models.ContentProperty>>(
|
|
828
828
|
parameters: Parameters.GetContentProperties,
|
|
829
|
-
callback?: never
|
|
829
|
+
callback?: never,
|
|
830
830
|
): Promise<T>;
|
|
831
831
|
async getContentProperties<T = Pagination<Models.ContentProperty>>(
|
|
832
832
|
parameters: Parameters.GetContentProperties,
|
|
@@ -848,12 +848,12 @@ export class Content {
|
|
|
848
848
|
/** Creates a new content property. */
|
|
849
849
|
async createContentProperty<T = Models.ContentProperty>(
|
|
850
850
|
parameters: Parameters.CreateContentProperty,
|
|
851
|
-
callback: Callback<T
|
|
851
|
+
callback: Callback<T>,
|
|
852
852
|
): Promise<void>;
|
|
853
853
|
/** Creates a new content property. */
|
|
854
854
|
async createContentProperty<T = Models.ContentProperty>(
|
|
855
855
|
parameters: Parameters.CreateContentProperty,
|
|
856
|
-
callback?: never
|
|
856
|
+
callback?: never,
|
|
857
857
|
): Promise<T>;
|
|
858
858
|
async createContentProperty<T = Models.ContentProperty>(
|
|
859
859
|
parameters: Parameters.CreateContentProperty,
|
|
@@ -874,12 +874,12 @@ export class Content {
|
|
|
874
874
|
/** Returns a content property. */
|
|
875
875
|
async getContentProperty<T = Models.ContentProperty>(
|
|
876
876
|
parameters: Parameters.GetContentProperty,
|
|
877
|
-
callback: Callback<T
|
|
877
|
+
callback: Callback<T>,
|
|
878
878
|
): Promise<void>;
|
|
879
879
|
/** Returns a content property. */
|
|
880
880
|
async getContentProperty<T = Models.ContentProperty>(
|
|
881
881
|
parameters: Parameters.GetContentProperty,
|
|
882
|
-
callback?: never
|
|
882
|
+
callback?: never,
|
|
883
883
|
): Promise<T>;
|
|
884
884
|
async getContentProperty<T = Models.ContentProperty>(
|
|
885
885
|
parameters: Parameters.GetContentProperty,
|
|
@@ -899,12 +899,12 @@ export class Content {
|
|
|
899
899
|
/** Creates a new content property. */
|
|
900
900
|
async createContentPropertyForKey<T = Models.ContentProperty>(
|
|
901
901
|
parameters: Parameters.CreateContentPropertyForKey,
|
|
902
|
-
callback: Callback<T
|
|
902
|
+
callback: Callback<T>,
|
|
903
903
|
): Promise<void>;
|
|
904
904
|
/** Creates a new content property. */
|
|
905
905
|
async createContentPropertyForKey<T = Models.ContentProperty>(
|
|
906
906
|
parameters: Parameters.CreateContentPropertyForKey,
|
|
907
|
-
callback?: never
|
|
907
|
+
callback?: never,
|
|
908
908
|
): Promise<T>;
|
|
909
909
|
async createContentPropertyForKey<T = Models.ContentProperty>(
|
|
910
910
|
parameters: Parameters.CreateContentPropertyForKey,
|
|
@@ -930,7 +930,7 @@ export class Content {
|
|
|
930
930
|
*/
|
|
931
931
|
async updateContentProperty<T = Models.ContentProperty>(
|
|
932
932
|
parameters: Parameters.UpdateContentProperty,
|
|
933
|
-
callback: Callback<T
|
|
933
|
+
callback: Callback<T>,
|
|
934
934
|
): Promise<void>;
|
|
935
935
|
/**
|
|
936
936
|
* Updates a content property. The body contains the representation of the content property. Must include the property
|
|
@@ -941,7 +941,7 @@ export class Content {
|
|
|
941
941
|
*/
|
|
942
942
|
async updateContentProperty<T = Models.ContentProperty>(
|
|
943
943
|
parameters: Parameters.UpdateContentProperty,
|
|
944
|
-
callback?: never
|
|
944
|
+
callback?: never,
|
|
945
945
|
): Promise<T>;
|
|
946
946
|
async updateContentProperty<T = Models.ContentProperty>(
|
|
947
947
|
parameters: Parameters.UpdateContentProperty,
|
|
@@ -962,7 +962,7 @@ export class Content {
|
|
|
962
962
|
/** Deletes a content property. */
|
|
963
963
|
async deleteContentProperty<T = void>(
|
|
964
964
|
parameters: Parameters.DeleteContentProperty,
|
|
965
|
-
callback: Callback<T
|
|
965
|
+
callback: Callback<T>,
|
|
966
966
|
): Promise<void>;
|
|
967
967
|
/** Deletes a content property. */
|
|
968
968
|
async deleteContentProperty<T = void>(parameters: Parameters.DeleteContentProperty, callback?: never): Promise<T>;
|
|
@@ -981,12 +981,12 @@ export class Content {
|
|
|
981
981
|
/** Returns info about all restrictions by operation */
|
|
982
982
|
async getRestrictionsByOperation<T = Models.RestrictionsByOperation>(
|
|
983
983
|
parameters: Parameters.GetRestrictionsByOperation,
|
|
984
|
-
callback: Callback<T
|
|
984
|
+
callback: Callback<T>,
|
|
985
985
|
): Promise<void>;
|
|
986
986
|
/** Returns info about all restrictions by operation */
|
|
987
987
|
async getRestrictionsByOperation<T = Models.RestrictionsByOperation>(
|
|
988
988
|
parameters: Parameters.GetRestrictionsByOperation,
|
|
989
|
-
callback?: never
|
|
989
|
+
callback?: never,
|
|
990
990
|
): Promise<T>;
|
|
991
991
|
async getRestrictionsByOperation<T = Models.RestrictionsByOperation>(
|
|
992
992
|
parameters: Parameters.GetRestrictionsByOperation,
|
|
@@ -1006,12 +1006,12 @@ export class Content {
|
|
|
1006
1006
|
/** Returns info about all restrictions of given operation */
|
|
1007
1007
|
async getRestrictionsForOperation<T = Models.ContentRestriction>(
|
|
1008
1008
|
parameters: Parameters.GetRestrictionsForOperation,
|
|
1009
|
-
callback: Callback<T
|
|
1009
|
+
callback: Callback<T>,
|
|
1010
1010
|
): Promise<void>;
|
|
1011
1011
|
/** Returns info about all restrictions of given operation */
|
|
1012
1012
|
async getRestrictionsForOperation<T = Models.ContentRestriction>(
|
|
1013
1013
|
parameters: Parameters.GetRestrictionsForOperation,
|
|
1014
|
-
callback?: never
|
|
1014
|
+
callback?: never,
|
|
1015
1015
|
): Promise<T>;
|
|
1016
1016
|
async getRestrictionsForOperation<T = Models.ContentRestriction>(
|
|
1017
1017
|
parameters: Parameters.GetRestrictionsForOperation,
|
|
@@ -1033,7 +1033,7 @@ export class Content {
|
|
|
1033
1033
|
/** Publishes a legacy draft of a Content created from a ContentBlueprint */
|
|
1034
1034
|
async publishLegacyDraft<T = Models.Content>(
|
|
1035
1035
|
parameters: Parameters.PublishLegacyDraft,
|
|
1036
|
-
callback: Callback<T
|
|
1036
|
+
callback: Callback<T>,
|
|
1037
1037
|
): Promise<void>;
|
|
1038
1038
|
/** Publishes a legacy draft of a Content created from a ContentBlueprint */
|
|
1039
1039
|
async publishLegacyDraft<T = Models.Content>(parameters: Parameters.PublishLegacyDraft, callback?: never): Promise<T>;
|
|
@@ -1056,7 +1056,7 @@ export class Content {
|
|
|
1056
1056
|
/** Publishes a shared draft of a Content created from a ContentBlueprint */
|
|
1057
1057
|
async publishSharedDraft<T = Models.Content>(
|
|
1058
1058
|
parameters: Parameters.PublishSharedDraft,
|
|
1059
|
-
callback: Callback<T
|
|
1059
|
+
callback: Callback<T>,
|
|
1060
1060
|
): Promise<void>;
|
|
1061
1061
|
/** Publishes a shared draft of a Content created from a ContentBlueprint */
|
|
1062
1062
|
async publishSharedDraft<T = Models.Content>(parameters: Parameters.PublishSharedDraft, callback?: never): Promise<T>;
|
|
@@ -19,7 +19,7 @@ export class ContentBody {
|
|
|
19
19
|
*/
|
|
20
20
|
async convertContentBody<T = Models.ContentBody>(
|
|
21
21
|
parameters: Parameters.ConvertContentBody,
|
|
22
|
-
callback: Callback<T
|
|
22
|
+
callback: Callback<T>,
|
|
23
23
|
): Promise<void>;
|
|
24
24
|
/**
|
|
25
25
|
* Converts between content body representations. Not all representations can be converted to/from other formats.
|
|
@@ -33,7 +33,7 @@ export class ContentBody {
|
|
|
33
33
|
*/
|
|
34
34
|
async convertContentBody<T = Models.ContentBody>(
|
|
35
35
|
parameters: Parameters.ConvertContentBody,
|
|
36
|
-
callback?: never
|
|
36
|
+
callback?: never,
|
|
37
37
|
): Promise<T>;
|
|
38
38
|
async convertContentBody<T = Models.ContentBody>(
|
|
39
39
|
parameters: Parameters.ConvertContentBody,
|
package/src/server/group.ts
CHANGED
|
@@ -11,7 +11,7 @@ export class Group {
|
|
|
11
11
|
/** Get a paginated collection of user groups */
|
|
12
12
|
async getGroups<T = Pagination<Models.Group>>(
|
|
13
13
|
parameters: Parameters.GetGroups | undefined,
|
|
14
|
-
callback: Callback<T
|
|
14
|
+
callback: Callback<T>,
|
|
15
15
|
): Promise<void>;
|
|
16
16
|
/** Get a paginated collection of user groups */
|
|
17
17
|
async getGroups<T = Pagination<Models.Group>>(parameters?: Parameters.GetGroups, callback?: never): Promise<T>;
|
|
@@ -51,7 +51,7 @@ export class Group {
|
|
|
51
51
|
/** Get a paginated collection of users in the given group */
|
|
52
52
|
async getMembers<T = Pagination<Models.User>>(
|
|
53
53
|
parameters: Parameters.GetMembers,
|
|
54
|
-
callback: Callback<T
|
|
54
|
+
callback: Callback<T>,
|
|
55
55
|
): Promise<void>;
|
|
56
56
|
/** Get a paginated collection of users in the given group */
|
|
57
57
|
async getMembers<T = Pagination<Models.User>>(parameters: Parameters.GetMembers, callback?: never): Promise<T>;
|
package/src/server/longTask.ts
CHANGED
|
@@ -11,7 +11,7 @@ export class LongTask {
|
|
|
11
11
|
/** Returns information about all tracked long-running tasks. */
|
|
12
12
|
async getTasks<T = Pagination<Models.LongTaskStatus>>(
|
|
13
13
|
parameters: Parameters.GetTasks | undefined,
|
|
14
|
-
callback: Callback<T
|
|
14
|
+
callback: Callback<T>,
|
|
15
15
|
): Promise<void>;
|
|
16
16
|
/** Returns information about all tracked long-running tasks. */
|
|
17
17
|
async getTasks<T = Pagination<Models.LongTaskStatus>>(parameters?: Parameters.GetTasks, callback?: never): Promise<T>;
|
|
@@ -21,12 +21,16 @@ export interface CreateAuditRecord {
|
|
|
21
21
|
remoteAddress: string;
|
|
22
22
|
/**
|
|
23
23
|
* The creation date-time of the audit record, as a timestamp. This is converted to a date-time display in the
|
|
24
|
-
* Confluence UI. If the `creationDate` is not specified, then it will be set to the timestamp for the current
|
|
24
|
+
* Confluence UI. If the `creationDate` is not specified, then it will be set to the timestamp for the current
|
|
25
|
+
* date-time.
|
|
25
26
|
*/
|
|
26
27
|
creationDate?: number;
|
|
27
28
|
/** The summary of the event, which is displayed in the 'Change' column on the audit log in the Confluence UI. */
|
|
28
29
|
summary?: string;
|
|
29
|
-
/**
|
|
30
|
+
/**
|
|
31
|
+
* A long description of the event, which is displayed in the 'Description' field on the audit log in the Confluence
|
|
32
|
+
* UI.
|
|
33
|
+
*/
|
|
30
34
|
description?: string;
|
|
31
35
|
/** The category of the event, which is displayed in the 'Event type' column on the audit log in the Confluence UI. */
|
|
32
36
|
category?: string;
|