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.
Files changed (168) hide show
  1. package/.prettierrc +8 -3
  2. package/CHANGELOG.md +4 -0
  3. package/README.md +16 -0
  4. package/out/api/contentChildrenAndDescendants.js +3 -0
  5. package/out/api/contentChildrenAndDescendants.js.map +1 -1
  6. package/out/api/models/addContentRestriction.d.ts +8 -3
  7. package/out/api/models/appDescriptor.d.ts +6 -3
  8. package/out/api/models/asyncContentBody.d.ts +2 -2
  9. package/out/api/models/attachmentUpdate.d.ts +1 -1
  10. package/out/api/models/auditRecordCreate.d.ts +6 -2
  11. package/out/api/models/contentBlueprintDraft.d.ts +2 -1
  12. package/out/api/models/contentRestrictionUpdate.d.ts +8 -3
  13. package/out/api/models/contentTemplateUpdate.d.ts +4 -1
  14. package/out/api/models/labeledContentType.js +1 -1
  15. package/out/api/models/labeledContentType.js.map +1 -1
  16. package/out/api/models/lifecycle.d.ts +6 -2
  17. package/out/api/parameters/addLabelsToContent.d.ts +2 -1
  18. package/out/api/parameters/createContent.d.ts +12 -3
  19. package/out/api/parameters/createContent.js +13 -4
  20. package/out/api/parameters/createContent.js.map +1 -1
  21. package/out/api/parameters/createRelationship.d.ts +4 -1
  22. package/out/api/parameters/createUserProperty.d.ts +2 -2
  23. package/out/api/parameters/delete.d.ts +4 -1
  24. package/out/api/parameters/deleteRelationship.d.ts +8 -5
  25. package/out/api/parameters/deleteUserProperty.d.ts +2 -2
  26. package/out/api/parameters/findSourcesForTarget.d.ts +2 -1
  27. package/out/api/parameters/findTargetFromSource.d.ts +2 -1
  28. package/out/api/parameters/getAttachments.d.ts +12 -3
  29. package/out/api/parameters/getAttachments.js +13 -4
  30. package/out/api/parameters/getAttachments.js.map +1 -1
  31. package/out/api/parameters/getAvailableContentStates.d.ts +1 -1
  32. package/out/api/parameters/getContent.d.ts +16 -4
  33. package/out/api/parameters/getContent.js +13 -4
  34. package/out/api/parameters/getContent.js.map +1 -1
  35. package/out/api/parameters/getContentById.d.ts +12 -3
  36. package/out/api/parameters/getContentById.js +13 -4
  37. package/out/api/parameters/getContentById.js.map +1 -1
  38. package/out/api/parameters/getContentProperties.d.ts +4 -2
  39. package/out/api/parameters/getContentProperty.d.ts +10 -8
  40. package/out/api/parameters/getContentTemplates.d.ts +4 -1
  41. package/out/api/parameters/getContentVersion.d.ts +2 -1
  42. package/out/api/parameters/getContentVersions.d.ts +2 -1
  43. package/out/api/parameters/getDescendantsOfType.d.ts +12 -3
  44. package/out/api/parameters/getDescendantsOfType.js +13 -4
  45. package/out/api/parameters/getDescendantsOfType.js.map +1 -1
  46. package/out/api/parameters/getHistoryForContent.d.ts +2 -1
  47. package/out/api/parameters/getLabelsForContent.d.ts +2 -1
  48. package/out/api/parameters/getRelationship.d.ts +6 -2
  49. package/out/api/parameters/getSpaces.d.ts +10 -3
  50. package/out/api/parameters/removeGroupById.d.ts +2 -2
  51. package/out/api/parameters/removeGroupByName.d.ts +2 -2
  52. package/out/api/parameters/removeModules.d.ts +2 -1
  53. package/out/api/parameters/restoreContentVersion.d.ts +2 -1
  54. package/out/api/parameters/search.d.ts +2 -2
  55. package/out/api/parameters/updateAttachmentProperties.d.ts +15 -15
  56. package/out/api/parameters/updateUserProperty.d.ts +2 -2
  57. package/out/clients/baseClient.d.ts +0 -1
  58. package/out/clients/baseClient.js +2 -2
  59. package/out/clients/baseClient.js.map +1 -1
  60. package/out/clients/confluenceClient.d.ts +2 -0
  61. package/out/clients/confluenceClient.js +3 -2
  62. package/out/clients/confluenceClient.js.map +1 -1
  63. package/out/clients/serverClient.d.ts +2 -1
  64. package/out/clients/serverClient.js +3 -3
  65. package/out/clients/serverClient.js.map +1 -1
  66. package/out/config.d.ts +7 -7
  67. package/out/server/parameters/createAuditRecord.d.ts +6 -2
  68. package/out/server/parameters/getAttachments.d.ts +12 -3
  69. package/out/server/parameters/getAttachments.js +13 -4
  70. package/out/server/parameters/getAttachments.js.map +1 -1
  71. package/out/services/authenticationService/authenticationService.js +1 -1
  72. package/out/services/authenticationService/authenticationService.js.map +1 -1
  73. package/out/services/authenticationService/authentications/createJWTAuthentication.js +1 -1
  74. package/out/services/authenticationService/authentications/createJWTAuthentication.js.map +1 -1
  75. package/out/services/authenticationService/base64Encoder.d.ts +1 -3
  76. package/out/services/authenticationService/base64Encoder.js +3 -5
  77. package/out/services/authenticationService/base64Encoder.js.map +1 -1
  78. package/out/utilityTypes.d.ts +5 -1
  79. package/package.json +25 -25
  80. package/src/api/audit.ts +9 -9
  81. package/src/api/content.ts +8 -8
  82. package/src/api/contentAttachments.ts +10 -10
  83. package/src/api/contentBody.ts +6 -6
  84. package/src/api/contentChildrenAndDescendants.ts +14 -11
  85. package/src/api/contentComments.ts +2 -2
  86. package/src/api/contentContentState.ts +10 -10
  87. package/src/api/contentLabels.ts +7 -7
  88. package/src/api/contentMacroBody.ts +6 -6
  89. package/src/api/contentPermissions.ts +4 -4
  90. package/src/api/contentProperties.ts +11 -11
  91. package/src/api/contentRestrictions.ts +26 -26
  92. package/src/api/contentStates.ts +12 -12
  93. package/src/api/contentVersions.ts +6 -6
  94. package/src/api/contentWatches.ts +11 -11
  95. package/src/api/dynamicModules.ts +1 -1
  96. package/src/api/experimental.ts +9 -9
  97. package/src/api/group.ts +18 -18
  98. package/src/api/inlineTasks.ts +1 -1
  99. package/src/api/labelInfo.ts +2 -2
  100. package/src/api/longRunningTask.ts +2 -2
  101. package/src/api/models/addContentRestriction.ts +8 -3
  102. package/src/api/models/appDescriptor.ts +6 -3
  103. package/src/api/models/asyncContentBody.ts +2 -2
  104. package/src/api/models/attachmentContainer.ts +1 -1
  105. package/src/api/models/attachmentUpdate.ts +1 -1
  106. package/src/api/models/auditRecordCreate.ts +6 -2
  107. package/src/api/models/contentBlueprintDraft.ts +2 -1
  108. package/src/api/models/contentRestrictionUpdate.ts +8 -3
  109. package/src/api/models/contentTemplateUpdate.ts +4 -1
  110. package/src/api/models/lifecycle.ts +6 -2
  111. package/src/api/parameters/addLabelsToContent.ts +2 -1
  112. package/src/api/parameters/createContent.ts +12 -3
  113. package/src/api/parameters/createRelationship.ts +4 -1
  114. package/src/api/parameters/createUserProperty.ts +2 -2
  115. package/src/api/parameters/delete.ts +4 -1
  116. package/src/api/parameters/deleteRelationship.ts +8 -5
  117. package/src/api/parameters/deleteUserProperty.ts +2 -2
  118. package/src/api/parameters/findSourcesForTarget.ts +2 -1
  119. package/src/api/parameters/findTargetFromSource.ts +2 -1
  120. package/src/api/parameters/getAttachments.ts +12 -3
  121. package/src/api/parameters/getAvailableContentStates.ts +1 -1
  122. package/src/api/parameters/getContent.ts +16 -4
  123. package/src/api/parameters/getContentById.ts +12 -3
  124. package/src/api/parameters/getContentProperties.ts +4 -2
  125. package/src/api/parameters/getContentProperty.ts +10 -8
  126. package/src/api/parameters/getContentTemplates.ts +4 -1
  127. package/src/api/parameters/getContentVersion.ts +2 -1
  128. package/src/api/parameters/getContentVersions.ts +2 -1
  129. package/src/api/parameters/getDescendantsOfType.ts +12 -3
  130. package/src/api/parameters/getHistoryForContent.ts +2 -1
  131. package/src/api/parameters/getLabelsForContent.ts +2 -1
  132. package/src/api/parameters/getRelationship.ts +6 -2
  133. package/src/api/parameters/getSpaces.ts +10 -3
  134. package/src/api/parameters/removeGroupById.ts +2 -2
  135. package/src/api/parameters/removeGroupByName.ts +2 -2
  136. package/src/api/parameters/removeModules.ts +2 -1
  137. package/src/api/parameters/restoreContentVersion.ts +2 -1
  138. package/src/api/parameters/search.ts +2 -2
  139. package/src/api/parameters/updateAttachmentProperties.ts +15 -15
  140. package/src/api/parameters/updateUserProperty.ts +2 -2
  141. package/src/api/relation.ts +8 -8
  142. package/src/api/search.ts +7 -7
  143. package/src/api/settings.ts +12 -12
  144. package/src/api/space.ts +7 -7
  145. package/src/api/spacePermissions.ts +5 -5
  146. package/src/api/spaceProperties.ts +10 -10
  147. package/src/api/spaceSettings.ts +4 -4
  148. package/src/api/template.ts +10 -10
  149. package/src/api/themes.ts +1 -1
  150. package/src/api/users.ts +13 -13
  151. package/src/clients/baseClient.ts +4 -4
  152. package/src/clients/confluenceClient.ts +8 -0
  153. package/src/clients/serverClient.ts +7 -1
  154. package/src/config.ts +19 -11
  155. package/src/server/audit.ts +9 -9
  156. package/src/server/content.ts +49 -49
  157. package/src/server/contentBody.ts +2 -2
  158. package/src/server/group.ts +2 -2
  159. package/src/server/longTask.ts +1 -1
  160. package/src/server/parameters/createAuditRecord.ts +6 -2
  161. package/src/server/parameters/getAttachments.ts +12 -3
  162. package/src/server/parameters/updateAttachmentData.ts +1 -1
  163. package/src/server/search.ts +2 -2
  164. package/src/server/space.ts +16 -16
  165. package/src/server/user.ts +7 -7
  166. package/src/services/authenticationService/authentications/createJWTAuthentication.ts +1 -4
  167. package/src/services/authenticationService/base64Encoder.ts +5 -5
  168. package/src/utilityTypes.ts +7 -1
@@ -15,7 +15,7 @@ export class ContentStates {
15
15
  */
16
16
  async getContentState<T = Models.ContentStateResponse>(
17
17
  parameters: Parameters.GetContentState,
18
- callback: Callback<T>
18
+ callback: Callback<T>,
19
19
  ): Promise<void>;
20
20
  /**
21
21
  * Gets the current content state of the draft or current version of content. To specify the draft version, set the
@@ -25,7 +25,7 @@ export class ContentStates {
25
25
  */
26
26
  async getContentState<T = Models.ContentStateResponse>(
27
27
  parameters: Parameters.GetContentState,
28
- callback?: never
28
+ callback?: never,
29
29
  ): Promise<T>;
30
30
  async getContentState<T = Models.ContentStateResponse>(
31
31
  parameters: Parameters.GetContentState,
@@ -58,7 +58,7 @@ export class ContentStates {
58
58
  */
59
59
  async setContentState<T = Models.ContentStateResponse>(
60
60
  parameters: Parameters.SetContentState,
61
- callback: Callback<T>
61
+ callback: Callback<T>,
62
62
  ): Promise<void>;
63
63
  /**
64
64
  * Sets the content state of the content specified and creates a new version (publishes the content without changing
@@ -76,7 +76,7 @@ export class ContentStates {
76
76
  */
77
77
  async setContentState<T = Models.ContentStateResponse>(
78
78
  parameters: Parameters.SetContentState,
79
- callback?: never
79
+ callback?: never,
80
80
  ): Promise<T>;
81
81
  async setContentState<T = Models.ContentStateResponse>(
82
82
  parameters: Parameters.SetContentState,
@@ -106,7 +106,7 @@ export class ContentStates {
106
106
  */
107
107
  async removeContentState<T = Models.ContentStateResponse>(
108
108
  parameters: Parameters.RemoveContentState,
109
- callback: Callback<T>
109
+ callback: Callback<T>,
110
110
  ): Promise<void>;
111
111
  /**
112
112
  * Removes the content state of the content specified and creates a new version (publishes the content without
@@ -116,7 +116,7 @@ export class ContentStates {
116
116
  */
117
117
  async removeContentState<T = Models.ContentStateResponse>(
118
118
  parameters: Parameters.RemoveContentState,
119
- callback?: never
119
+ callback?: never,
120
120
  ): Promise<T>;
121
121
  async removeContentState<T = Models.ContentStateResponse>(
122
122
  parameters: Parameters.RemoveContentState,
@@ -142,7 +142,7 @@ export class ContentStates {
142
142
  */
143
143
  async getAvailableContentStates<T = Models.AvailableContentStates>(
144
144
  parameters: Parameters.GetAvailableContentStates,
145
- callback: Callback<T>
145
+ callback: Callback<T>,
146
146
  ): Promise<void>;
147
147
  /**
148
148
  * Gets content states that are available for the content to be set as. Will return all enabled Space Content States.
@@ -153,7 +153,7 @@ export class ContentStates {
153
153
  */
154
154
  async getAvailableContentStates<T = Models.AvailableContentStates>(
155
155
  parameters: Parameters.GetAvailableContentStates,
156
- callback?: never
156
+ callback?: never,
157
157
  ): Promise<T>;
158
158
  async getAvailableContentStates<T = Models.AvailableContentStates>(
159
159
  parameters: Parameters.GetAvailableContentStates,
@@ -195,7 +195,7 @@ export class ContentStates {
195
195
  */
196
196
  async getSpaceContentStates<T = Models.ContentState[]>(
197
197
  parameters: Parameters.GetSpaceContentStates,
198
- callback: Callback<T>
198
+ callback: Callback<T>,
199
199
  ): Promise<void>;
200
200
  /**
201
201
  * Get content states that are suggested in the space.
@@ -204,7 +204,7 @@ export class ContentStates {
204
204
  */
205
205
  async getSpaceContentStates<T = Models.ContentState[]>(
206
206
  parameters: Parameters.GetSpaceContentStates,
207
- callback?: never
207
+ callback?: never,
208
208
  ): Promise<T>;
209
209
  async getSpaceContentStates<T = Models.ContentState[]>(
210
210
  parameters: Parameters.GetSpaceContentStates,
@@ -226,7 +226,7 @@ export class ContentStates {
226
226
  */
227
227
  async getContentStateSettings<T = Models.ContentStateSettings>(
228
228
  parameters: Parameters.GetContentStateSettings,
229
- callback: Callback<T>
229
+ callback: Callback<T>,
230
230
  ): Promise<void>;
231
231
  /**
232
232
  * Get object describing whether content states are allowed at all, if custom content states or space content states
@@ -236,7 +236,7 @@ export class ContentStates {
236
236
  */
237
237
  async getContentStateSettings<T = Models.ContentStateSettings>(
238
238
  parameters: Parameters.GetContentStateSettings,
239
- callback?: never
239
+ callback?: never,
240
240
  ): Promise<T>;
241
241
  async getContentStateSettings<T = Models.ContentStateSettings>(
242
242
  parameters: Parameters.GetContentStateSettings,
@@ -15,7 +15,7 @@ export class ContentVersions {
15
15
  */
16
16
  async getContentVersions<T = Models.VersionArray>(
17
17
  parameters: Parameters.GetContentVersions,
18
- callback: Callback<T>
18
+ callback: Callback<T>,
19
19
  ): Promise<void>;
20
20
  /**
21
21
  * Returns the versions for a piece of content in descending order.
@@ -25,7 +25,7 @@ export class ContentVersions {
25
25
  */
26
26
  async getContentVersions<T = Models.VersionArray>(
27
27
  parameters: Parameters.GetContentVersions,
28
- callback?: never
28
+ callback?: never,
29
29
  ): Promise<T>;
30
30
  async getContentVersions<T = Models.VersionArray>(
31
31
  parameters: Parameters.GetContentVersions,
@@ -52,7 +52,7 @@ export class ContentVersions {
52
52
  */
53
53
  async restoreContentVersion<T = Models.Version>(
54
54
  parameters: Parameters.RestoreContentVersion,
55
- callback: Callback<T>
55
+ callback: Callback<T>,
56
56
  ): Promise<void>;
57
57
  /**
58
58
  * Restores a historical version to be the latest version. That is, a new version is created with the content of the
@@ -62,7 +62,7 @@ export class ContentVersions {
62
62
  */
63
63
  async restoreContentVersion<T = Models.Version>(
64
64
  parameters: Parameters.RestoreContentVersion,
65
- callback?: never
65
+ callback?: never,
66
66
  ): Promise<T>;
67
67
  async restoreContentVersion<T = Models.Version>(
68
68
  parameters: Parameters.RestoreContentVersion,
@@ -91,7 +91,7 @@ export class ContentVersions {
91
91
  */
92
92
  async getContentVersion<T = Models.Version>(
93
93
  parameters: Parameters.GetContentVersion,
94
- callback: Callback<T>
94
+ callback: Callback<T>,
95
95
  ): Promise<void>;
96
96
  /**
97
97
  * Returns a version for a piece of content.
@@ -123,7 +123,7 @@ export class ContentVersions {
123
123
  */
124
124
  async deleteContentVersion<T = void>(
125
125
  parameters: Parameters.DeleteContentVersion,
126
- callback: Callback<T>
126
+ callback: Callback<T>,
127
127
  ): Promise<void>;
128
128
  /**
129
129
  * Delete a historical version. This does not delete the changes made to the content in that version, rather the
@@ -22,7 +22,7 @@ export class ContentWatches {
22
22
  */
23
23
  async getWatchesForPage<T = Models.WatchArray>(
24
24
  parameters: Parameters.GetWatchesForPage,
25
- callback: Callback<T>
25
+ callback: Callback<T>,
26
26
  ): Promise<void>;
27
27
  /**
28
28
  * Returns the watches for a page. A user that watches a page will receive receive notifications when the page is
@@ -39,7 +39,7 @@ export class ContentWatches {
39
39
  */
40
40
  async getWatchesForPage<T = Models.WatchArray>(
41
41
  parameters: Parameters.GetWatchesForPage,
42
- callback?: never
42
+ callback?: never,
43
43
  ): Promise<T>;
44
44
  async getWatchesForPage<T = Models.WatchArray>(
45
45
  parameters: Parameters.GetWatchesForPage,
@@ -72,7 +72,7 @@ export class ContentWatches {
72
72
  */
73
73
  async getWatchesForSpace<T = Models.SpaceWatchArray>(
74
74
  parameters: Parameters.GetWatchesForSpace,
75
- callback: Callback<T>
75
+ callback: Callback<T>,
76
76
  ): Promise<void>;
77
77
  /**
78
78
  * Returns all space watches for the space that the content is in. A user that watches a space will receive receive
@@ -89,7 +89,7 @@ export class ContentWatches {
89
89
  */
90
90
  async getWatchesForSpace<T = Models.SpaceWatchArray>(
91
91
  parameters: Parameters.GetWatchesForSpace,
92
- callback?: never
92
+ callback?: never,
93
93
  ): Promise<T>;
94
94
  async getWatchesForSpace<T = Models.SpaceWatchArray>(
95
95
  parameters: Parameters.GetWatchesForSpace,
@@ -110,12 +110,12 @@ export class ContentWatches {
110
110
  /** Returns a list of watchers of a space */
111
111
  async getWatchersForSpace<T = Models.SpaceWatchArray>(
112
112
  parameters: Parameters.GetWatchersForSpace,
113
- callback: Callback<T>
113
+ callback: Callback<T>,
114
114
  ): Promise<void>;
115
115
  /** Returns a list of watchers of a space */
116
116
  async getWatchersForSpace<T = Models.SpaceWatchArray>(
117
117
  parameters: Parameters.GetWatchersForSpace,
118
- callback?: never
118
+ callback?: never,
119
119
  ): Promise<T>;
120
120
  async getWatchersForSpace<T = Models.SpaceWatchArray>(
121
121
  parameters: Parameters.GetWatchersForSpace,
@@ -144,7 +144,7 @@ export class ContentWatches {
144
144
  */
145
145
  async getContentWatchStatus<T = Models.UserWatch>(
146
146
  parameters: Parameters.GetContentWatchStatus,
147
- callback: Callback<T>
147
+ callback: Callback<T>,
148
148
  ): Promise<void>;
149
149
  /**
150
150
  * Returns whether a user is watching a piece of content. Choose the user by doing one of the following:
@@ -157,7 +157,7 @@ export class ContentWatches {
157
157
  */
158
158
  async getContentWatchStatus<T = Models.UserWatch>(
159
159
  parameters: Parameters.GetContentWatchStatus,
160
- callback?: never
160
+ callback?: never,
161
161
  ): Promise<T>;
162
162
  async getContentWatchStatus<T = Models.UserWatch>(
163
163
  parameters: Parameters.GetContentWatchStatus,
@@ -230,7 +230,7 @@ export class ContentWatches {
230
230
  */
231
231
  async removeContentWatcher<T = void>(
232
232
  parameters: Parameters.RemoveContentWatcher,
233
- callback: Callback<T>
233
+ callback: Callback<T>,
234
234
  ): Promise<void>;
235
235
  /**
236
236
  * Removes a user as a watcher from a piece of content. Choose the user by doing one of the following:
@@ -273,7 +273,7 @@ export class ContentWatches {
273
273
  */
274
274
  async isWatchingLabel<T = Models.UserWatch>(
275
275
  parameters: Parameters.IsWatchingLabel,
276
- callback: Callback<T>
276
+ callback: Callback<T>,
277
277
  ): Promise<void>;
278
278
  /**
279
279
  * Returns whether a user is watching a label. Choose the user by doing one of the following:
@@ -393,7 +393,7 @@ export class ContentWatches {
393
393
  */
394
394
  async isWatchingSpace<T = Models.UserWatch>(
395
395
  parameters: Parameters.IsWatchingSpace,
396
- callback: Callback<T>
396
+ callback: Callback<T>,
397
397
  ): Promise<void>;
398
398
  /**
399
399
  * Returns whether a user is watching a space. Choose the user by doing one of the following:
@@ -35,7 +35,7 @@ export class DynamicModules {
35
35
  */
36
36
  async registerModules<T = unknown>(
37
37
  parameters: Parameters.RegisterModules | undefined,
38
- callback: Callback<T>
38
+ callback: Callback<T>,
39
39
  ): Promise<void>;
40
40
  /**
41
41
  * Registers a list of modules. For the list of modules that support dynamic registration, see [Dynamic
@@ -22,7 +22,7 @@ export class Experimental {
22
22
  */
23
23
  async deletePageTree<T = Models.LongTask>(
24
24
  parameters: Parameters.DeletePageTree,
25
- callback: Callback<T>
25
+ callback: Callback<T>,
26
26
  ): Promise<void>;
27
27
  /**
28
28
  * Moves a pagetree rooted at a page to the space's trash:
@@ -56,7 +56,7 @@ export class Experimental {
56
56
  */
57
57
  async getLabelsForSpace<T = Models.LabelArray>(
58
58
  parameters: Parameters.GetLabelsForSpace,
59
- callback: Callback<T>
59
+ callback: Callback<T>,
60
60
  ): Promise<void>;
61
61
  /**
62
62
  * Returns a list of labels associated with a space. Can provide a prefix as well as other filters to select different
@@ -64,7 +64,7 @@ export class Experimental {
64
64
  */
65
65
  async getLabelsForSpace<T = Models.LabelArray>(
66
66
  parameters: Parameters.GetLabelsForSpace,
67
- callback?: never
67
+ callback?: never,
68
68
  ): Promise<T>;
69
69
  async getLabelsForSpace<T = Models.LabelArray>(
70
70
  parameters: Parameters.GetLabelsForSpace,
@@ -96,7 +96,7 @@ export class Experimental {
96
96
  */
97
97
  async addLabelsToSpace<T = Models.LabelArray>(
98
98
  parameters: Parameters.AddLabelsToSpace,
99
- callback: Callback<T>
99
+ callback: Callback<T>,
100
100
  ): Promise<void>;
101
101
  /**
102
102
  * Adds labels to a piece of content. Does not modify the existing labels.
@@ -124,7 +124,7 @@ export class Experimental {
124
124
 
125
125
  async deleteLabelFromSpace<T = void>(
126
126
  parameters: Parameters.DeleteLabelFromSpace,
127
- callback: Callback<T>
127
+ callback: Callback<T>,
128
128
  ): Promise<void>;
129
129
  async deleteLabelFromSpace<T = void>(parameters: Parameters.DeleteLabelFromSpace, callback?: never): Promise<T>;
130
130
  async deleteLabelFromSpace<T = void>(
@@ -153,7 +153,7 @@ export class Experimental {
153
153
  */
154
154
  async getUserProperties<T = Models.UserPropertyKeyArray>(
155
155
  parameters: Parameters.GetUserProperties,
156
- callback: Callback<T>
156
+ callback: Callback<T>,
157
157
  ): Promise<void>;
158
158
  /**
159
159
  * Returns the properties for a user as list of property keys. For more information about user properties, see
@@ -165,7 +165,7 @@ export class Experimental {
165
165
  */
166
166
  async getUserProperties<T = Models.UserPropertyKeyArray>(
167
167
  parameters: Parameters.GetUserProperties,
168
- callback?: never
168
+ callback?: never,
169
169
  ): Promise<T>;
170
170
  async getUserProperties<T = Models.UserPropertyKeyArray>(
171
171
  parameters: Parameters.GetUserProperties,
@@ -193,7 +193,7 @@ export class Experimental {
193
193
  */
194
194
  async getUserProperty<T = Models.UserProperty>(
195
195
  parameters: Parameters.GetUserProperty,
196
- callback: Callback<T>
196
+ callback: Callback<T>,
197
197
  ): Promise<void>;
198
198
  /**
199
199
  * Returns the property corresponding to `key` for a user. For more information about user properties, see [Confluence
@@ -227,7 +227,7 @@ export class Experimental {
227
227
  */
228
228
  async createUserProperty<T = unknown>(
229
229
  parameters: Parameters.CreateUserProperty,
230
- callback: Callback<T>
230
+ callback: Callback<T>,
231
231
  ): Promise<void>;
232
232
  /**
233
233
  * Creates a property for a user. For more information about user properties, see [Confluence entity properties]
package/src/api/group.ts CHANGED
@@ -15,7 +15,7 @@ export class Group {
15
15
  */
16
16
  async getGroups<T = Models.GroupArrayWithLinks>(
17
17
  parameters: Parameters.GetGroups | undefined,
18
- callback: Callback<T>
18
+ callback: Callback<T>,
19
19
  ): Promise<void>;
20
20
  /**
21
21
  * Returns all user groups. The returned groups are ordered alphabetically in ascending order by group name.
@@ -48,7 +48,7 @@ export class Group {
48
48
  */
49
49
  async createGroup<T = Models.Group>(
50
50
  parameters: Parameters.CreateGroup | undefined,
51
- callback: Callback<T>
51
+ callback: Callback<T>,
52
52
  ): Promise<void>;
53
53
  /**
54
54
  * Creates a new user group.
@@ -100,7 +100,7 @@ export class Group {
100
100
  */
101
101
  async getGroupByQueryParam<T = Models.Group>(
102
102
  parameters: Parameters.GetGroupByQueryParam,
103
- callback: Callback<T>
103
+ callback: Callback<T>,
104
104
  ): Promise<void>;
105
105
  /**
106
106
  * Returns a user group for a given group name.
@@ -110,7 +110,7 @@ export class Group {
110
110
  */
111
111
  async getGroupByQueryParam<T = Models.Group>(
112
112
  parameters: Parameters.GetGroupByQueryParam,
113
- callback?: never
113
+ callback?: never,
114
114
  ): Promise<T>;
115
115
  async getGroupByQueryParam<T = Models.Group>(
116
116
  parameters: Parameters.GetGroupByQueryParam,
@@ -135,7 +135,7 @@ export class Group {
135
135
  */
136
136
  async getGroupByGroupId<T = Models.Group>(
137
137
  parameters: Parameters.GetGroupByGroupId,
138
- callback: Callback<T>
138
+ callback: Callback<T>,
139
139
  ): Promise<void>;
140
140
  /**
141
141
  * Returns a user group for a given group id.
@@ -229,7 +229,7 @@ export class Group {
229
229
  */
230
230
  async getMembersByQueryParam<T = Models.UserArray>(
231
231
  parameters: Parameters.GetMembersByQueryParam,
232
- callback: Callback<T>
232
+ callback: Callback<T>,
233
233
  ): Promise<void>;
234
234
  /**
235
235
  * Returns the users that are members of a group.
@@ -239,7 +239,7 @@ export class Group {
239
239
  */
240
240
  async getMembersByQueryParam<T = Models.UserArray>(
241
241
  parameters: Parameters.GetMembersByQueryParam,
242
- callback?: never
242
+ callback?: never,
243
243
  ): Promise<T>;
244
244
  async getMembersByQueryParam<T = Models.UserArray>(
245
245
  parameters: Parameters.GetMembersByQueryParam,
@@ -269,7 +269,7 @@ export class Group {
269
269
  */
270
270
  async getGroupMembers<T = Models.UserArray>(
271
271
  parameters: Parameters.GetGroupMembers,
272
- callback: Callback<T>
272
+ callback: Callback<T>,
273
273
  ): Promise<void>;
274
274
  /**
275
275
  * Returns the users that are members of a group.
@@ -299,12 +299,12 @@ export class Group {
299
299
  /** @deprecated Will be removed in the next major version. Use `searchGroups` instead. */
300
300
  async getGroupsSearch<T = Models.GroupArrayWithLinks>(
301
301
  parameters: Parameters.GetGroupsSearch,
302
- callback: Callback<T>
302
+ callback: Callback<T>,
303
303
  ): Promise<void>;
304
304
  /** @deprecated Will be removed in the next major version. Use `searchGroups` instead. */
305
305
  async getGroupsSearch<T = Models.GroupArrayWithLinks>(
306
306
  parameters: Parameters.GetGroupsSearch,
307
- callback?: never
307
+ callback?: never,
308
308
  ): Promise<T>;
309
309
  async getGroupsSearch<T = Models.GroupArrayWithLinks>(
310
310
  parameters: Parameters.GetGroupsSearch,
@@ -316,7 +316,7 @@ export class Group {
316
316
  /** Get search results of groups by partial query provided. */
317
317
  async searchGroups<T = Models.GroupArrayWithLinks>(
318
318
  parameters: Parameters.SearchGroups,
319
- callback: Callback<T>
319
+ callback: Callback<T>,
320
320
  ): Promise<void>;
321
321
  /** Get search results of groups by partial query provided. */
322
322
  async searchGroups<T = Models.GroupArrayWithLinks>(parameters: Parameters.SearchGroups, callback?: never): Promise<T>;
@@ -345,7 +345,7 @@ export class Group {
345
345
  */
346
346
  async addUserToGroupByGroupId<T = unknown>(
347
347
  parameters: Parameters.AddUserToGroupByGroupId,
348
- callback: Callback<T>
348
+ callback: Callback<T>,
349
349
  ): Promise<void>;
350
350
  /**
351
351
  * Adds a user as a member in a group represented by its groupId
@@ -354,7 +354,7 @@ export class Group {
354
354
  */
355
355
  async addUserToGroupByGroupId<T = unknown>(
356
356
  parameters: Parameters.AddUserToGroupByGroupId,
357
- callback?: never
357
+ callback?: never,
358
358
  ): Promise<T>;
359
359
  async addUserToGroupByGroupId<T = unknown>(
360
360
  parameters: Parameters.AddUserToGroupByGroupId,
@@ -381,7 +381,7 @@ export class Group {
381
381
  */
382
382
  async removeMemberFromGroupByGroupId<T = void>(
383
383
  parameters: Parameters.RemoveMemberFromGroupByGroupId,
384
- callback: Callback<T>
384
+ callback: Callback<T>,
385
385
  ): Promise<void>;
386
386
  /**
387
387
  * Remove user as a member from a group.
@@ -390,7 +390,7 @@ export class Group {
390
390
  */
391
391
  async removeMemberFromGroupByGroupId<T = void>(
392
392
  parameters: Parameters.RemoveMemberFromGroupByGroupId,
393
- callback?: never
393
+ callback?: never,
394
394
  ): Promise<T>;
395
395
  async removeMemberFromGroupByGroupId<T = void>(
396
396
  parameters: Parameters.RemoveMemberFromGroupByGroupId,
@@ -418,7 +418,7 @@ export class Group {
418
418
  */
419
419
  async getGroupMembersByGroupId<T = Models.UserArray>(
420
420
  parameters: Parameters.GetGroupMembersByGroupId,
421
- callback: Callback<T>
421
+ callback: Callback<T>,
422
422
  ): Promise<void>;
423
423
  /**
424
424
  * Returns the users that are members of a group.
@@ -430,7 +430,7 @@ export class Group {
430
430
  */
431
431
  async getGroupMembersByGroupId<T = Models.UserArray>(
432
432
  parameters: Parameters.GetGroupMembersByGroupId,
433
- callback?: never
433
+ callback?: never,
434
434
  ): Promise<T>;
435
435
  async getGroupMembersByGroupId<T = Models.UserArray>(
436
436
  parameters: Parameters.GetGroupMembersByGroupId,
@@ -483,7 +483,7 @@ export class Group {
483
483
  */
484
484
  async removeMemberFromGroup<T = void>(
485
485
  parameters: Parameters.RemoveMemberFromGroup,
486
- callback: Callback<T>
486
+ callback: Callback<T>,
487
487
  ): Promise<void>;
488
488
  /**
489
489
  * Remove user as a member from a group.
@@ -15,7 +15,7 @@ export class InlineTasks {
15
15
  */
16
16
  async searchTasks<T = Models.TaskPageResponse>(
17
17
  parameters: Parameters.SearchTasks | undefined,
18
- callback: Callback<T>
18
+ callback: Callback<T>,
19
19
  ): Promise<void>;
20
20
  /**
21
21
  * Returns inline tasks based on the search query.
@@ -15,7 +15,7 @@ export class LabelInfo {
15
15
  */
16
16
  async getAllLabelContent<T = Models.LabelDetails>(
17
17
  parameters: Parameters.GetAllLabelContent,
18
- callback: Callback<T>
18
+ callback: Callback<T>,
19
19
  ): Promise<void>;
20
20
  /**
21
21
  * Returns label information and a list of contents associated with the label.
@@ -25,7 +25,7 @@ export class LabelInfo {
25
25
  */
26
26
  async getAllLabelContent<T = Models.LabelDetails>(
27
27
  parameters: Parameters.GetAllLabelContent,
28
- callback?: never
28
+ callback?: never,
29
29
  ): Promise<T>;
30
30
  async getAllLabelContent<T = Models.LabelDetails>(
31
31
  parameters: Parameters.GetAllLabelContent,
@@ -16,7 +16,7 @@ export class LongRunningTask {
16
16
  */
17
17
  async getTasks<T = Models.LongTaskStatusArray>(
18
18
  parameters: Parameters.GetTasks | undefined,
19
- callback: Callback<T>
19
+ callback: Callback<T>,
20
20
  ): Promise<void>;
21
21
  /**
22
22
  * Returns information about all active long-running tasks (e.g. space export), such as how long each task has been
@@ -51,7 +51,7 @@ export class LongRunningTask {
51
51
  */
52
52
  async getTask<T = Models.LongTaskStatusWithLinks>(
53
53
  parameters: Parameters.GetTask,
54
- callback: Callback<T>
54
+ callback: Callback<T>,
55
55
  ): Promise<void>;
56
56
  /**
57
57
  * Returns information about an active long-running task (e.g. space export), such as how long it has been running and
@@ -6,18 +6,23 @@ export interface AddContentRestriction {
6
6
  * this object.
7
7
  */
8
8
  restrictions: {
9
- /** The users that the restrictions will be applied to. This array must have at least one item, otherwise it should be omitted. */
9
+ /**
10
+ * The users that the restrictions will be applied to. This array must have at least one item, otherwise it should
11
+ * be omitted.
12
+ */
10
13
  user?: {
11
14
  /** Set to 'known'. */
12
15
  type: string;
13
16
  /**
14
17
  * This property is no longer available and will be removed from the documentation soon. Use `accountId` instead.
15
- * See the [deprecation notice](/cloud/confluence/deprecation-notice-user-privacy-api-migration-guide/) for details.
18
+ * See the [deprecation notice](/cloud/confluence/deprecation-notice-user-privacy-api-migration-guide/) for
19
+ * details.
16
20
  */
17
21
  username?: string;
18
22
  /**
19
23
  * This property is no longer available and will be removed from the documentation soon. Use `accountId` instead.
20
- * See the [deprecation notice](/cloud/confluence/deprecation-notice-user-privacy-api-migration-guide/) for details.
24
+ * See the [deprecation notice](/cloud/confluence/deprecation-notice-user-privacy-api-migration-guide/) for
25
+ * details.
21
26
  */
22
27
  userKey?: string;
23
28
  /**
@@ -10,7 +10,8 @@ export interface AppDescriptor {
10
10
  /**
11
11
  * The base url of the remote app, which is used for all communications back to the app instance.
12
12
  *
13
- * The baseUrl must start with `https://` to ensure that all data is sent securely between our cloud instances and your app.
13
+ * The baseUrl must start with `https://` to ensure that all data is sent securely between our cloud instances and
14
+ * your app.
14
15
  *
15
16
  * Note: each app must have a unique baseUrl. If you would like to serve multiple apps from the same host, consider
16
17
  * adding a path prefix into the baseUrl.
@@ -27,7 +28,8 @@ export interface AppDescriptor {
27
28
  * app as a private version, and have a seamless transition for those beta customers (and existing customers) once the
28
29
  * major revision is launched.
29
30
  *
30
- * Vendors can accomplish this by listing a new private version of their app, with a new descriptor hosted at a new URL.
31
+ * Vendors can accomplish this by listing a new private version of their app, with a new descriptor hosted at a new
32
+ * URL.
31
33
  *
32
34
  * They use the Atlassian Marketplace's access token facilities to share this version with customers (or for internal
33
35
  * use). When this version is ready to be taken live, it can be transitioned from private to public, and all customers
@@ -35,7 +37,8 @@ export interface AppDescriptor {
35
37
  *
36
38
  * It's important to note that this approach allows vendors to create new versions manually, despite the fact that in
37
39
  * the common case, the versions are automatically created. This has a few benefits-- for example, it gives vendors
38
- * the ability to change their descriptor URL if they need to (the descriptor URL will be immutable for existing versions).
40
+ * the ability to change their descriptor URL if they need to (the descriptor URL will be immutable for existing
41
+ * versions).
39
42
  */
40
43
  apiVersion?: number;
41
44
 
@@ -8,8 +8,8 @@ export interface AsyncContentBody {
8
8
  renderTaskId?: string;
9
9
  error?: string;
10
10
  /**
11
- * Rerunning is reserved for when the job is working, but there is a previous run's value in the cache. You may
12
- * choose to continue polling, or use the cached value.
11
+ * Rerunning is reserved for when the job is working, but there is a previous run's value in the cache. You may choose
12
+ * to continue polling, or use the cached value.
13
13
  */
14
14
  status?: string;
15
15
  embeddedContent?: EmbeddedContent[];
@@ -13,7 +13,7 @@ export interface AttachmentContainer {
13
13
  container: string;
14
14
  metadata: string;
15
15
  restrictions: string;
16
- history:string;
16
+ history: string;
17
17
  body: string;
18
18
  version: string;
19
19
  descendants: string;
@@ -1,4 +1,4 @@
1
- /** @deprecated will be removed in second major version */
1
+ /** @deprecated Will be removed in second major version */
2
2
  export interface AttachmentUpdate {
3
3
  /**
4
4
  * The attachment version. Set this to the current version number of the attachment. Note, the version number only
@@ -22,12 +22,16 @@ export interface AuditRecordCreate {
22
22
  remoteAddress: string;
23
23
  /**
24
24
  * The creation date-time of the audit record, as a timestamp. This is converted to a date-time display in the
25
- * Confluence UI. If the `creationDate` is not specified, then it will be set to the timestamp for the current date-time.
25
+ * Confluence UI. If the `creationDate` is not specified, then it will be set to the timestamp for the current
26
+ * date-time.
26
27
  */
27
28
  creationDate?: number;
28
29
  /** The summary of the event, which is displayed in the 'Change' column on the audit log in the Confluence UI. */
29
30
  summary?: string;
30
- /** A long description of the event, which is displayed in the 'Description' field on the audit log in the Confluence UI. */
31
+ /**
32
+ * A long description of the event, which is displayed in the 'Description' field on the audit log in the Confluence
33
+ * UI.
34
+ */
31
35
  description?: string;
32
36
  /** The category of the event, which is displayed in the 'Event type' column on the audit log in the Confluence UI. */
33
37
  category?: string;
@@ -19,7 +19,8 @@ export interface ContentBlueprintDraft {
19
19
  * The new ancestor (i.e. parent page) for the content. If you have specified an ancestor, you must also specify a
20
20
  * `space` property in the request body for the space that the ancestor is in.
21
21
  *
22
- * Note, if you specify more than one ancestor, the last ID in the array will be selected as the parent page for the content.
22
+ * Note, if you specify more than one ancestor, the last ID in the array will be selected as the parent page for the
23
+ * content.
23
24
  */
24
25
  ancestors?: {
25
26
  /** The content ID of the ancestor. */