@resolution/confluence-api-client 0.4.4 → 0.4.6

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 (183) hide show
  1. package/CHANGELOG.md +22 -0
  2. package/README.md +60 -1
  3. package/lib/openapi/v1/BaseConfluenceApiV1Client.d.ts +32 -33
  4. package/lib/openapi/v1/BaseConfluenceApiV1Client.js +151 -88
  5. package/lib/openapi/v1/BaseConfluenceApiV1Client.js.map +1 -1
  6. package/lib/openapi/v1/core/CommonHttpService.d.ts +2 -0
  7. package/lib/openapi/v1/core/CommonHttpService.js +9 -0
  8. package/lib/openapi/v1/core/CommonHttpService.js.map +1 -1
  9. package/lib/openapi/v1/services/AnalyticsService.d.ts +10 -10
  10. package/lib/openapi/v1/services/AnalyticsService.js +62 -59
  11. package/lib/openapi/v1/services/AnalyticsService.js.map +1 -1
  12. package/lib/openapi/v1/services/AuditService.d.ts +25 -25
  13. package/lib/openapi/v1/services/AuditService.js +205 -202
  14. package/lib/openapi/v1/services/AuditService.js.map +1 -1
  15. package/lib/openapi/v1/services/ContentAttachmentsService.d.ts +20 -20
  16. package/lib/openapi/v1/services/ContentAttachmentsService.js +317 -314
  17. package/lib/openapi/v1/services/ContentAttachmentsService.js.map +1 -1
  18. package/lib/openapi/v1/services/ContentBodyService.d.ts +15 -15
  19. package/lib/openapi/v1/services/ContentBodyService.js +140 -137
  20. package/lib/openapi/v1/services/ContentBodyService.js.map +1 -1
  21. package/lib/openapi/v1/services/ContentChildrenAndDescendantsService.d.ts +27 -27
  22. package/lib/openapi/v1/services/ContentChildrenAndDescendantsService.js +391 -388
  23. package/lib/openapi/v1/services/ContentChildrenAndDescendantsService.js.map +1 -1
  24. package/lib/openapi/v1/services/ContentCommentsService.d.ts +8 -8
  25. package/lib/openapi/v1/services/ContentCommentsService.js +49 -46
  26. package/lib/openapi/v1/services/ContentCommentsService.js.map +1 -1
  27. package/lib/openapi/v1/services/ContentLabelsService.d.ts +11 -11
  28. package/lib/openapi/v1/services/ContentLabelsService.js +150 -147
  29. package/lib/openapi/v1/services/ContentLabelsService.js.map +1 -1
  30. package/lib/openapi/v1/services/ContentMacroBodyService.d.ts +13 -13
  31. package/lib/openapi/v1/services/ContentMacroBodyService.js +155 -152
  32. package/lib/openapi/v1/services/ContentMacroBodyService.js.map +1 -1
  33. package/lib/openapi/v1/services/ContentPermissionsService.d.ts +2 -2
  34. package/lib/openapi/v1/services/ContentPermissionsService.js +48 -45
  35. package/lib/openapi/v1/services/ContentPermissionsService.js.map +1 -1
  36. package/lib/openapi/v1/services/ContentPropertiesService.d.ts +18 -18
  37. package/lib/openapi/v1/services/ContentPropertiesService.js +237 -234
  38. package/lib/openapi/v1/services/ContentPropertiesService.js.map +1 -1
  39. package/lib/openapi/v1/services/ContentRestrictionsService.d.ts +49 -49
  40. package/lib/openapi/v1/services/ContentRestrictionsService.js +505 -502
  41. package/lib/openapi/v1/services/ContentRestrictionsService.js.map +1 -1
  42. package/lib/openapi/v1/services/ContentService.d.ts +50 -50
  43. package/lib/openapi/v1/services/ContentService.js +475 -472
  44. package/lib/openapi/v1/services/ContentService.js.map +1 -1
  45. package/lib/openapi/v1/services/ContentStatesService.d.ts +25 -25
  46. package/lib/openapi/v1/services/ContentStatesService.js +359 -356
  47. package/lib/openapi/v1/services/ContentStatesService.js.map +1 -1
  48. package/lib/openapi/v1/services/ContentVersionsService.d.ts +13 -13
  49. package/lib/openapi/v1/services/ContentVersionsService.js +144 -141
  50. package/lib/openapi/v1/services/ContentVersionsService.js.map +1 -1
  51. package/lib/openapi/v1/services/ContentWatchesService.d.ts +57 -57
  52. package/lib/openapi/v1/services/ContentWatchesService.js +454 -451
  53. package/lib/openapi/v1/services/ContentWatchesService.js.map +1 -1
  54. package/lib/openapi/v1/services/DynamicModulesService.d.ts +5 -5
  55. package/lib/openapi/v1/services/DynamicModulesService.js +70 -67
  56. package/lib/openapi/v1/services/DynamicModulesService.js.map +1 -1
  57. package/lib/openapi/v1/services/ExperimentalService.d.ts +12 -12
  58. package/lib/openapi/v1/services/ExperimentalService.js +151 -148
  59. package/lib/openapi/v1/services/ExperimentalService.js.map +1 -1
  60. package/lib/openapi/v1/services/GroupService.d.ts +52 -52
  61. package/lib/openapi/v1/services/GroupService.js +445 -442
  62. package/lib/openapi/v1/services/GroupService.js.map +1 -1
  63. package/lib/openapi/v1/services/InlineTasksService.d.ts +20 -20
  64. package/lib/openapi/v1/services/InlineTasksService.js +118 -115
  65. package/lib/openapi/v1/services/InlineTasksService.js.map +1 -1
  66. package/lib/openapi/v1/services/LabelInfoService.d.ts +5 -5
  67. package/lib/openapi/v1/services/LabelInfoService.js +37 -34
  68. package/lib/openapi/v1/services/LabelInfoService.js.map +1 -1
  69. package/lib/openapi/v1/services/LongRunningTaskService.d.ts +8 -6
  70. package/lib/openapi/v1/services/LongRunningTaskService.js +67 -63
  71. package/lib/openapi/v1/services/LongRunningTaskService.js.map +1 -1
  72. package/lib/openapi/v1/services/RelationService.d.ts +37 -37
  73. package/lib/openapi/v1/services/RelationService.js +231 -228
  74. package/lib/openapi/v1/services/RelationService.js.map +1 -1
  75. package/lib/openapi/v1/services/SearchService.d.ts +20 -20
  76. package/lib/openapi/v1/services/SearchService.js +136 -133
  77. package/lib/openapi/v1/services/SearchService.js.map +1 -1
  78. package/lib/openapi/v1/services/SettingsService.d.ts +15 -15
  79. package/lib/openapi/v1/services/SettingsService.js +204 -201
  80. package/lib/openapi/v1/services/SettingsService.js.map +1 -1
  81. package/lib/openapi/v1/services/SpacePermissionsService.d.ts +6 -6
  82. package/lib/openapi/v1/services/SpacePermissionsService.js +99 -96
  83. package/lib/openapi/v1/services/SpacePermissionsService.js.map +1 -1
  84. package/lib/openapi/v1/services/SpacePropertiesService.d.ts +16 -16
  85. package/lib/openapi/v1/services/SpacePropertiesService.js +227 -224
  86. package/lib/openapi/v1/services/SpacePropertiesService.js.map +1 -1
  87. package/lib/openapi/v1/services/SpaceService.d.ts +38 -38
  88. package/lib/openapi/v1/services/SpaceService.js +320 -317
  89. package/lib/openapi/v1/services/SpaceService.js.map +1 -1
  90. package/lib/openapi/v1/services/SpaceSettingsService.d.ts +4 -4
  91. package/lib/openapi/v1/services/SpaceSettingsService.js +68 -65
  92. package/lib/openapi/v1/services/SpaceSettingsService.js.map +1 -1
  93. package/lib/openapi/v1/services/TemplateService.d.ts +20 -20
  94. package/lib/openapi/v1/services/TemplateService.js +214 -211
  95. package/lib/openapi/v1/services/TemplateService.js.map +1 -1
  96. package/lib/openapi/v1/services/ThemesService.d.ts +13 -13
  97. package/lib/openapi/v1/services/ThemesService.js +179 -176
  98. package/lib/openapi/v1/services/ThemesService.js.map +1 -1
  99. package/lib/openapi/v1/services/UserPropertiesService.d.ts +12 -12
  100. package/lib/openapi/v1/services/UserPropertiesService.js +165 -162
  101. package/lib/openapi/v1/services/UserPropertiesService.js.map +1 -1
  102. package/lib/openapi/v1/services/UsersService.d.ts +21 -21
  103. package/lib/openapi/v1/services/UsersService.js +229 -226
  104. package/lib/openapi/v1/services/UsersService.js.map +1 -1
  105. package/lib/openapi/v2/BaseConfluenceApiV2Client.d.ts +23 -24
  106. package/lib/openapi/v2/BaseConfluenceApiV2Client.js +92 -47
  107. package/lib/openapi/v2/BaseConfluenceApiV2Client.js.map +1 -1
  108. package/lib/openapi/v2/core/CommonHttpService.d.ts +2 -0
  109. package/lib/openapi/v2/core/CommonHttpService.js +9 -0
  110. package/lib/openapi/v2/core/CommonHttpService.js.map +1 -1
  111. package/lib/openapi/v2/models/user.d.ts +0 -2
  112. package/lib/openapi/v2/models/user.js +0 -2
  113. package/lib/openapi/v2/models/user.js.map +1 -1
  114. package/lib/openapi/v2/services/AncestorsService.d.ts +17 -17
  115. package/lib/openapi/v2/services/AncestorsService.js +174 -171
  116. package/lib/openapi/v2/services/AncestorsService.js.map +1 -1
  117. package/lib/openapi/v2/services/AttachmentService.d.ts +62 -62
  118. package/lib/openapi/v2/services/AttachmentService.js +261 -258
  119. package/lib/openapi/v2/services/AttachmentService.js.map +1 -1
  120. package/lib/openapi/v2/services/BlogPostService.d.ts +70 -70
  121. package/lib/openapi/v2/services/BlogPostService.js +270 -267
  122. package/lib/openapi/v2/services/BlogPostService.js.map +1 -1
  123. package/lib/openapi/v2/services/ChildrenService.d.ts +14 -14
  124. package/lib/openapi/v2/services/ChildrenService.js +77 -74
  125. package/lib/openapi/v2/services/ChildrenService.js.map +1 -1
  126. package/lib/openapi/v2/services/ClassificationLevelService.d.ts +21 -21
  127. package/lib/openapi/v2/services/ClassificationLevelService.js +304 -301
  128. package/lib/openapi/v2/services/ClassificationLevelService.js.map +1 -1
  129. package/lib/openapi/v2/services/CommentService.d.ts +136 -136
  130. package/lib/openapi/v2/services/CommentService.js +635 -632
  131. package/lib/openapi/v2/services/CommentService.js.map +1 -1
  132. package/lib/openapi/v2/services/ContentPropertiesService.d.ts +128 -128
  133. package/lib/openapi/v2/services/ContentPropertiesService.js +1242 -1239
  134. package/lib/openapi/v2/services/ContentPropertiesService.js.map +1 -1
  135. package/lib/openapi/v2/services/ContentService.d.ts +2 -2
  136. package/lib/openapi/v2/services/ContentService.js +40 -37
  137. package/lib/openapi/v2/services/ContentService.js.map +1 -1
  138. package/lib/openapi/v2/services/CustomContentService.d.ts +72 -72
  139. package/lib/openapi/v2/services/CustomContentService.js +299 -296
  140. package/lib/openapi/v2/services/CustomContentService.js.map +1 -1
  141. package/lib/openapi/v2/services/DataPoliciesService.d.ts +10 -10
  142. package/lib/openapi/v2/services/DataPoliciesService.js +67 -64
  143. package/lib/openapi/v2/services/DataPoliciesService.js.map +1 -1
  144. package/lib/openapi/v2/services/DatabaseService.d.ts +17 -17
  145. package/lib/openapi/v2/services/DatabaseService.js +90 -87
  146. package/lib/openapi/v2/services/DatabaseService.js.map +1 -1
  147. package/lib/openapi/v2/services/LabelService.d.ts +57 -57
  148. package/lib/openapi/v2/services/LabelService.js +263 -260
  149. package/lib/openapi/v2/services/LabelService.js.map +1 -1
  150. package/lib/openapi/v2/services/LikeService.d.ts +36 -36
  151. package/lib/openapi/v2/services/LikeService.js +250 -247
  152. package/lib/openapi/v2/services/LikeService.js.map +1 -1
  153. package/lib/openapi/v2/services/OperationService.d.ts +20 -20
  154. package/lib/openapi/v2/services/OperationService.js +298 -295
  155. package/lib/openapi/v2/services/OperationService.js.map +1 -1
  156. package/lib/openapi/v2/services/PageService.d.ts +73 -73
  157. package/lib/openapi/v2/services/PageService.js +272 -269
  158. package/lib/openapi/v2/services/PageService.js.map +1 -1
  159. package/lib/openapi/v2/services/SmartLinkService.d.ts +19 -17
  160. package/lib/openapi/v2/services/SmartLinkService.js +92 -89
  161. package/lib/openapi/v2/services/SmartLinkService.js.map +1 -1
  162. package/lib/openapi/v2/services/SpacePermissionsService.d.ts +6 -6
  163. package/lib/openapi/v2/services/SpacePermissionsService.js +35 -32
  164. package/lib/openapi/v2/services/SpacePermissionsService.js.map +1 -1
  165. package/lib/openapi/v2/services/SpacePropertiesService.d.ts +15 -15
  166. package/lib/openapi/v2/services/SpacePropertiesService.js +165 -162
  167. package/lib/openapi/v2/services/SpacePropertiesService.js.map +1 -1
  168. package/lib/openapi/v2/services/SpaceService.d.ts +28 -28
  169. package/lib/openapi/v2/services/SpaceService.js +83 -80
  170. package/lib/openapi/v2/services/SpaceService.js.map +1 -1
  171. package/lib/openapi/v2/services/TaskService.d.ts +40 -40
  172. package/lib/openapi/v2/services/TaskService.js +120 -117
  173. package/lib/openapi/v2/services/TaskService.js.map +1 -1
  174. package/lib/openapi/v2/services/UserService.d.ts +11 -11
  175. package/lib/openapi/v2/services/UserService.js +91 -88
  176. package/lib/openapi/v2/services/UserService.js.map +1 -1
  177. package/lib/openapi/v2/services/VersionService.d.ts +59 -59
  178. package/lib/openapi/v2/services/VersionService.js +395 -392
  179. package/lib/openapi/v2/services/VersionService.js.map +1 -1
  180. package/lib/openapi/v2/services/WhiteboardService.d.ts +17 -17
  181. package/lib/openapi/v2/services/WhiteboardService.js +90 -87
  182. package/lib/openapi/v2/services/WhiteboardService.js.map +1 -1
  183. package/package.json +4 -3
@@ -23,19 +23,19 @@ export declare class CommentService extends CommonHttpService {
23
23
  * @scopes-current write:comment:confluence
24
24
  * @see https://developer.atlassian.com/cloud/confluence/rest/v2/api-group-comment#api-footer-comments-post
25
25
  */
26
- createFooterComment({ createFooterCommentModel, }: {
26
+ createFooterComment: ({ createFooterCommentModel, }: {
27
27
  /** The footer comment to be created */
28
28
  createFooterCommentModel: CreateFooterCommentModel;
29
- }): Promise<FooterCommentModel & ({
30
- _links?: {
29
+ }) => Promise<FooterCommentModel & {
30
+ _links?: ({
31
31
  /** Base url of the Confluence site. */
32
- base?: string;
32
+ base?: string | undefined;
33
33
  } & {
34
34
  [key: string]: unknown;
35
- };
35
+ }) | undefined;
36
36
  } & {
37
37
  [key: string]: unknown;
38
- })>;
38
+ }>;
39
39
  /**
40
40
  * Create an inline comment. This can be at the top level (specifying pageId or
41
41
  * blogPostId in the request body)
@@ -54,19 +54,19 @@ export declare class CommentService extends CommonHttpService {
54
54
  * @scopes-current write:comment:confluence
55
55
  * @see https://developer.atlassian.com/cloud/confluence/rest/v2/api-group-comment#api-inline-comments-post
56
56
  */
57
- createInlineComment({ createInlineCommentModel, }: {
57
+ createInlineComment: ({ createInlineCommentModel, }: {
58
58
  /** The inline comment to be created */
59
59
  createInlineCommentModel: CreateInlineCommentModel;
60
- }): Promise<InlineCommentModel & ({
61
- _links?: {
60
+ }) => Promise<InlineCommentModel & {
61
+ _links?: ({
62
62
  /** Base url of the Confluence site. */
63
- base?: string;
63
+ base?: string | undefined;
64
64
  } & {
65
65
  [key: string]: unknown;
66
- };
66
+ }) | undefined;
67
67
  } & {
68
68
  [key: string]: unknown;
69
- })>;
69
+ }>;
70
70
  /**
71
71
  * Deletes a footer comment. This is a permanent deletion and cannot be reverted.
72
72
  *
@@ -78,10 +78,10 @@ export declare class CommentService extends CommonHttpService {
78
78
  * @scopes-current delete:comment:confluence
79
79
  * @see https://developer.atlassian.com/cloud/confluence/rest/v2/api-group-comment#api-footer-comments-comment-id-delete
80
80
  */
81
- deleteFooterComment({ commentId, }: {
81
+ deleteFooterComment: ({ commentId, }: {
82
82
  /** The ID of the comment to be retrieved. */
83
83
  commentId: number;
84
- }): Promise<void>;
84
+ }) => Promise<void>;
85
85
  /**
86
86
  * Deletes an inline comment. This is a permanent deletion and cannot be reverted.
87
87
  *
@@ -93,10 +93,10 @@ export declare class CommentService extends CommonHttpService {
93
93
  * @scopes-current delete:comment:confluence
94
94
  * @see https://developer.atlassian.com/cloud/confluence/rest/v2/api-group-comment#api-inline-comments-comment-id-delete
95
95
  */
96
- deleteInlineComment({ commentId, }: {
96
+ deleteInlineComment: ({ commentId, }: {
97
97
  /** The ID of the comment to be deleted. */
98
98
  commentId: number;
99
- }): Promise<void>;
99
+ }) => Promise<void>;
100
100
  /**
101
101
  * Returns the comments of the specific attachment.
102
102
  * The number of results is limited by the `limit` parameter and additional
@@ -111,7 +111,7 @@ export declare class CommentService extends CommonHttpService {
111
111
  * @scopes-current read:comment:confluence
112
112
  * @see https://developer.atlassian.com/cloud/confluence/rest/v2/api-group-comment#api-attachments-id-footer-comments-get
113
113
  */
114
- getAttachmentComments({ id, bodyFormat, cursor, limit, sort, version, }: {
114
+ getAttachmentComments: ({ id, bodyFormat, cursor, limit, sort, version, }: {
115
115
  /** The ID of the attachment for which comments should be returned. */
116
116
  id: string;
117
117
  /**
@@ -119,29 +119,29 @@ export declare class CommentService extends CommonHttpService {
119
119
  * available, the representation will be available under a response field of the
120
120
  * same name under the `body` field.
121
121
  */
122
- bodyFormat?: PrimaryBodyRepresentation;
122
+ bodyFormat?: PrimaryBodyRepresentation | undefined;
123
123
  /**
124
124
  * Used for pagination, this opaque cursor will be returned in the `next` URL in
125
125
  * the `Link` response header. Use the relative URL in the `Link` header to
126
126
  * retrieve the `next` set of results.
127
127
  */
128
- cursor?: string;
128
+ cursor?: string | undefined;
129
129
  /**
130
130
  * Maximum number of comments per result to return. If more results exist, use the
131
131
  * `Link` header to retrieve a relative URL that will return the next set of
132
132
  * results.
133
133
  */
134
- limit?: number;
134
+ limit?: number | undefined;
135
135
  /** Used to sort the result by a particular field. */
136
- sort?: CommentSortOrder;
136
+ sort?: CommentSortOrder | undefined;
137
137
  /**
138
138
  * Version number of the attachment to retrieve comments for. If no version
139
139
  * provided, retrieves comments for the latest version.
140
140
  */
141
- version?: number;
142
- }): Promise<{
143
- results?: AttachmentCommentModel[];
144
- _links?: MultiEntityLinks;
141
+ version?: number | undefined;
142
+ }) => Promise<{
143
+ results?: AttachmentCommentModel[] | undefined;
144
+ _links?: MultiEntityLinks | undefined;
145
145
  } & {
146
146
  [key: string]: unknown;
147
147
  }>;
@@ -158,7 +158,7 @@ export declare class CommentService extends CommonHttpService {
158
158
  * @scopes-current read:comment:confluence
159
159
  * @see https://developer.atlassian.com/cloud/confluence/rest/v2/api-group-comment#api-blogposts-id-footer-comments-get
160
160
  */
161
- getBlogPostFooterComments({ id, bodyFormat, sort, cursor, limit, }: {
161
+ getBlogPostFooterComments: ({ id, bodyFormat, sort, cursor, limit, }: {
162
162
  /** The ID of the blog post for which footer comments should be returned. */
163
163
  id: number;
164
164
  /**
@@ -166,24 +166,24 @@ export declare class CommentService extends CommonHttpService {
166
166
  * available, the representation will be available under a response field of the
167
167
  * same name under the `body` field.
168
168
  */
169
- bodyFormat?: PrimaryBodyRepresentation;
169
+ bodyFormat?: PrimaryBodyRepresentation | undefined;
170
170
  /** Used to sort the result by a particular field. */
171
- sort?: CommentSortOrder;
171
+ sort?: CommentSortOrder | undefined;
172
172
  /**
173
173
  * Used for pagination, this opaque cursor will be returned in the `next` URL in
174
174
  * the `Link` response header. Use the relative URL in the `Link` header to
175
175
  * retrieve the `next` set of results.
176
176
  */
177
- cursor?: string;
177
+ cursor?: string | undefined;
178
178
  /**
179
179
  * Maximum number of footer comments per result to return. If more results exist,
180
180
  * use the `Link` header to retrieve a relative URL that will return the next set
181
181
  * of results.
182
182
  */
183
- limit?: number;
184
- }): Promise<{
185
- results?: BlogPostCommentModel[];
186
- _links?: MultiEntityLinks;
183
+ limit?: number | undefined;
184
+ }) => Promise<{
185
+ results?: BlogPostCommentModel[] | undefined;
186
+ _links?: MultiEntityLinks | undefined;
187
187
  } & {
188
188
  [key: string]: unknown;
189
189
  }>;
@@ -200,7 +200,7 @@ export declare class CommentService extends CommonHttpService {
200
200
  * @scopes-current read:comment:confluence
201
201
  * @see https://developer.atlassian.com/cloud/confluence/rest/v2/api-group-comment#api-blogposts-id-inline-comments-get
202
202
  */
203
- getBlogPostInlineComments({ id, bodyFormat, sort, cursor, limit, }: {
203
+ getBlogPostInlineComments: ({ id, bodyFormat, sort, cursor, limit, }: {
204
204
  /** The ID of the blog post for which inline comments should be returned. */
205
205
  id: number;
206
206
  /**
@@ -208,24 +208,24 @@ export declare class CommentService extends CommonHttpService {
208
208
  * available, the representation will be available under a response field of the
209
209
  * same name under the `body` field.
210
210
  */
211
- bodyFormat?: PrimaryBodyRepresentation;
211
+ bodyFormat?: PrimaryBodyRepresentation | undefined;
212
212
  /** Used to sort the result by a particular field. */
213
- sort?: CommentSortOrder;
213
+ sort?: CommentSortOrder | undefined;
214
214
  /**
215
215
  * Used for pagination, this opaque cursor will be returned in the `next` URL in
216
216
  * the `Link` response header. Use the relative URL in the `Link` header to
217
217
  * retrieve the `next` set of results.
218
218
  */
219
- cursor?: string;
219
+ cursor?: string | undefined;
220
220
  /**
221
221
  * Maximum number of inline comments per result to return. If more results exist,
222
222
  * use the `Link` header to retrieve a relative URL that will return the next set
223
223
  * of results.
224
224
  */
225
- limit?: number;
226
- }): Promise<{
227
- results?: BlogPostInlineCommentModel[];
228
- _links?: MultiEntityLinks;
225
+ limit?: number | undefined;
226
+ }) => Promise<{
227
+ results?: BlogPostInlineCommentModel[] | undefined;
228
+ _links?: MultiEntityLinks | undefined;
229
229
  } & {
230
230
  [key: string]: unknown;
231
231
  }>;
@@ -243,7 +243,7 @@ export declare class CommentService extends CommonHttpService {
243
243
  * @scopes-current read:comment:confluence
244
244
  * @see https://developer.atlassian.com/cloud/confluence/rest/v2/api-group-comment#api-custom-content-id-footer-comments-get
245
245
  */
246
- getCustomContentComments({ id, bodyFormat, cursor, limit, sort, }: {
246
+ getCustomContentComments: ({ id, bodyFormat, cursor, limit, sort, }: {
247
247
  /** The ID of the custom content for which comments should be returned. */
248
248
  id: number;
249
249
  /**
@@ -251,24 +251,24 @@ export declare class CommentService extends CommonHttpService {
251
251
  * available, the representation will be available under a response field of the
252
252
  * same name under the `body` field.
253
253
  */
254
- bodyFormat?: PrimaryBodyRepresentation;
254
+ bodyFormat?: PrimaryBodyRepresentation | undefined;
255
255
  /**
256
256
  * Used for pagination, this opaque cursor will be returned in the `next` URL in
257
257
  * the `Link` response header. Use the relative URL in the `Link` header to
258
258
  * retrieve the `next` set of results.
259
259
  */
260
- cursor?: string;
260
+ cursor?: string | undefined;
261
261
  /**
262
262
  * Maximum number of comments per result to return. If more results exist, use the
263
263
  * `Link` header to retrieve a relative URL that will return the next set of
264
264
  * results.
265
265
  */
266
- limit?: number;
266
+ limit?: number | undefined;
267
267
  /** Used to sort the result by a particular field. */
268
- sort?: CommentSortOrder;
269
- }): Promise<{
270
- results?: CustomContentCommentModel[];
271
- _links?: MultiEntityLinks;
268
+ sort?: CommentSortOrder | undefined;
269
+ }) => Promise<{
270
+ results?: CustomContentCommentModel[] | undefined;
271
+ _links?: MultiEntityLinks | undefined;
272
272
  } & {
273
273
  [key: string]: unknown;
274
274
  }>;
@@ -283,7 +283,7 @@ export declare class CommentService extends CommonHttpService {
283
283
  * @scopes-current read:comment:confluence
284
284
  * @see https://developer.atlassian.com/cloud/confluence/rest/v2/api-group-comment#api-footer-comments-comment-id-get
285
285
  */
286
- getFooterCommentById({ commentId, bodyFormat, version, includeProperties, includeOperations, includeLikes, includeVersions, includeVersion, }: {
286
+ getFooterCommentById: ({ commentId, bodyFormat, version, includeProperties, includeOperations, includeLikes, includeVersions, includeVersion, }: {
287
287
  /** The ID of the comment to be retrieved. */
288
288
  commentId: number;
289
289
  /**
@@ -291,12 +291,12 @@ export declare class CommentService extends CommonHttpService {
291
291
  * available, the representation will be available under a response field of the
292
292
  * same name under the `body` field.
293
293
  */
294
- bodyFormat?: PrimaryBodyRepresentationSingle;
294
+ bodyFormat?: PrimaryBodyRepresentationSingle | undefined;
295
295
  /**
296
296
  * Allows you to retrieve a previously published version. Specify the previous
297
297
  * version's number to retrieve its details.
298
298
  */
299
- version?: number;
299
+ version?: number | undefined;
300
300
  /**
301
301
  * Includes content properties associated with this footer comment in the response.
302
302
  * The number of results will be limited to 50 and sorted in the default sort
@@ -304,7 +304,7 @@ export declare class CommentService extends CommonHttpService {
304
304
  * A `meta` and `_links` property will be present to indicate if more results are
305
305
  * available and a link to retrieve the rest of the results.
306
306
  */
307
- includeProperties?: boolean;
307
+ includeProperties?: boolean | undefined;
308
308
  /**
309
309
  * Includes operations associated with this footer comment in the response.
310
310
  * The number of results will be limited to 50 and sorted in the default sort
@@ -312,7 +312,7 @@ export declare class CommentService extends CommonHttpService {
312
312
  * A `meta` and `_links` property will be present to indicate if more results are
313
313
  * available and a link to retrieve the rest of the results.
314
314
  */
315
- includeOperations?: boolean;
315
+ includeOperations?: boolean | undefined;
316
316
  /**
317
317
  * Includes likes associated with this footer comment in the response.
318
318
  * The number of results will be limited to 50 and sorted in the default sort
@@ -320,7 +320,7 @@ export declare class CommentService extends CommonHttpService {
320
320
  * A `meta` and `_links` property will be present to indicate if more results are
321
321
  * available and a link to retrieve the rest of the results.
322
322
  */
323
- includeLikes?: boolean;
323
+ includeLikes?: boolean | undefined;
324
324
  /**
325
325
  * Includes versions associated with this footer comment in the response.
326
326
  * The number of results will be limited to 50 and sorted in the default sort
@@ -328,23 +328,23 @@ export declare class CommentService extends CommonHttpService {
328
328
  * A `meta` and `_links` property will be present to indicate if more results are
329
329
  * available and a link to retrieve the rest of the results.
330
330
  */
331
- includeVersions?: boolean;
331
+ includeVersions?: boolean | undefined;
332
332
  /**
333
333
  * Includes the current version associated with this footer comment in the
334
334
  * response.
335
335
  * By default this is included and can be omitted by setting the value to `false`.
336
336
  */
337
- includeVersion?: boolean;
338
- }): Promise<FooterCommentModel & ({
339
- _links?: {
337
+ includeVersion?: boolean | undefined;
338
+ }) => Promise<FooterCommentModel & {
339
+ _links?: ({
340
340
  /** Base url of the Confluence site. */
341
- base?: string;
341
+ base?: string | undefined;
342
342
  } & {
343
343
  [key: string]: unknown;
344
- };
344
+ }) | undefined;
345
345
  } & {
346
346
  [key: string]: unknown;
347
- })>;
347
+ }>;
348
348
  /**
349
349
  * Returns the children footer comments of specific comment. The number of results
350
350
  * is limited by the `limit` parameter and additional results (if available)
@@ -358,7 +358,7 @@ export declare class CommentService extends CommonHttpService {
358
358
  * @scopes-current read:comment:confluence
359
359
  * @see https://developer.atlassian.com/cloud/confluence/rest/v2/api-group-comment#api-footer-comments-id-children-get
360
360
  */
361
- getFooterCommentChildren({ id, bodyFormat, sort, cursor, limit, }: {
361
+ getFooterCommentChildren: ({ id, bodyFormat, sort, cursor, limit, }: {
362
362
  /**
363
363
  * The ID of the parent comment for which footer comment children should be
364
364
  * returned.
@@ -369,24 +369,24 @@ export declare class CommentService extends CommonHttpService {
369
369
  * available, the representation will be available under a response field of the
370
370
  * same name under the `body` field.
371
371
  */
372
- bodyFormat?: PrimaryBodyRepresentation;
372
+ bodyFormat?: PrimaryBodyRepresentation | undefined;
373
373
  /** Used to sort the result by a particular field. */
374
- sort?: CommentSortOrder;
374
+ sort?: CommentSortOrder | undefined;
375
375
  /**
376
376
  * Used for pagination, this opaque cursor will be returned in the `next` URL in
377
377
  * the `Link` response header. Use the relative URL in the `Link` header to
378
378
  * retrieve the `next` set of results.
379
379
  */
380
- cursor?: string;
380
+ cursor?: string | undefined;
381
381
  /**
382
382
  * Maximum number of footer comments per result to return. If more results exist,
383
383
  * use the `Link` header to retrieve a relative URL that will return the next set
384
384
  * of results.
385
385
  */
386
- limit?: number;
387
- }): Promise<{
388
- results?: ChildrenCommentModel[];
389
- _links?: MultiEntityLinks;
386
+ limit?: number | undefined;
387
+ }) => Promise<{
388
+ results?: ChildrenCommentModel[] | undefined;
389
+ _links?: MultiEntityLinks | undefined;
390
390
  } & {
391
391
  [key: string]: unknown;
392
392
  }>;
@@ -403,30 +403,30 @@ export declare class CommentService extends CommonHttpService {
403
403
  * @scopes-current read:comment:confluence
404
404
  * @see https://developer.atlassian.com/cloud/confluence/rest/v2/api-group-comment#api-footer-comments-get
405
405
  */
406
- getFooterComments({ bodyFormat, sort, cursor, limit, }?: {
406
+ getFooterComments: ({ bodyFormat, sort, cursor, limit, }?: {
407
407
  /**
408
408
  * The content format type to be returned in the `body` field of the response. If
409
409
  * available, the representation will be available under a response field of the
410
410
  * same name under the `body` field.
411
411
  */
412
- bodyFormat?: PrimaryBodyRepresentation;
412
+ bodyFormat?: PrimaryBodyRepresentation | undefined;
413
413
  /** Used to sort the result by a particular field. */
414
- sort?: CommentSortOrder;
414
+ sort?: CommentSortOrder | undefined;
415
415
  /**
416
416
  * Used for pagination, this opaque cursor will be returned in the `next` URL in
417
417
  * the `Link` response header. Use the relative URL in the `Link` header to
418
418
  * retrieve the `next` set of results.
419
419
  */
420
- cursor?: string;
420
+ cursor?: string | undefined;
421
421
  /**
422
422
  * Maximum number of footer comments per result to return. If more results exist,
423
423
  * use the `Link` header to retrieve a relative URL that will return the next set
424
424
  * of results.
425
425
  */
426
- limit?: number;
427
- }): Promise<{
428
- results?: FooterCommentModel[];
429
- _links?: MultiEntityLinks;
426
+ limit?: number | undefined;
427
+ }) => Promise<{
428
+ results?: FooterCommentModel[] | undefined;
429
+ _links?: MultiEntityLinks | undefined;
430
430
  } & {
431
431
  [key: string]: unknown;
432
432
  }>;
@@ -442,7 +442,7 @@ export declare class CommentService extends CommonHttpService {
442
442
  * @scopes-current read:comment:confluence
443
443
  * @see https://developer.atlassian.com/cloud/confluence/rest/v2/api-group-comment#api-inline-comments-comment-id-get
444
444
  */
445
- getInlineCommentById({ commentId, bodyFormat, version, includeProperties, includeOperations, includeLikes, includeVersions, includeVersion, }: {
445
+ getInlineCommentById: ({ commentId, bodyFormat, version, includeProperties, includeOperations, includeLikes, includeVersions, includeVersion, }: {
446
446
  /** The ID of the comment to be retrieved. */
447
447
  commentId: number;
448
448
  /**
@@ -450,12 +450,12 @@ export declare class CommentService extends CommonHttpService {
450
450
  * available, the representation will be available under a response field of the
451
451
  * same name under the `body` field.
452
452
  */
453
- bodyFormat?: PrimaryBodyRepresentationSingle;
453
+ bodyFormat?: PrimaryBodyRepresentationSingle | undefined;
454
454
  /**
455
455
  * Allows you to retrieve a previously published version. Specify the previous
456
456
  * version's number to retrieve its details.
457
457
  */
458
- version?: number;
458
+ version?: number | undefined;
459
459
  /**
460
460
  * Includes content properties associated with this inline comment in the response.
461
461
  * The number of results will be limited to 50 and sorted in the default sort
@@ -463,7 +463,7 @@ export declare class CommentService extends CommonHttpService {
463
463
  * A `meta` and `_links` property will be present to indicate if more results are
464
464
  * available and a link to retrieve the rest of the results.
465
465
  */
466
- includeProperties?: boolean;
466
+ includeProperties?: boolean | undefined;
467
467
  /**
468
468
  * Includes operations associated with this inline comment in the response.
469
469
  * The number of results will be limited to 50 and sorted in the default sort
@@ -471,7 +471,7 @@ export declare class CommentService extends CommonHttpService {
471
471
  * A `meta` and `_links` property will be present to indicate if more results are
472
472
  * available and a link to retrieve the rest of the results.
473
473
  */
474
- includeOperations?: boolean;
474
+ includeOperations?: boolean | undefined;
475
475
  /**
476
476
  * Includes likes associated with this inline comment in the response.
477
477
  * The number of results will be limited to 50 and sorted in the default sort
@@ -479,7 +479,7 @@ export declare class CommentService extends CommonHttpService {
479
479
  * A `meta` and `_links` property will be present to indicate if more results are
480
480
  * available and a link to retrieve the rest of the results.
481
481
  */
482
- includeLikes?: boolean;
482
+ includeLikes?: boolean | undefined;
483
483
  /**
484
484
  * Includes versions associated with this inline comment in the response.
485
485
  * The number of results will be limited to 50 and sorted in the default sort
@@ -487,23 +487,23 @@ export declare class CommentService extends CommonHttpService {
487
487
  * A `meta` and `_links` property will be present to indicate if more results are
488
488
  * available and a link to retrieve the rest of the results.
489
489
  */
490
- includeVersions?: boolean;
490
+ includeVersions?: boolean | undefined;
491
491
  /**
492
492
  * Includes the current version associated with this inline comment in the
493
493
  * response.
494
494
  * By default this is included and can be omitted by setting the value to `false`.
495
495
  */
496
- includeVersion?: boolean;
497
- }): Promise<InlineCommentModel & ({
498
- _links?: {
496
+ includeVersion?: boolean | undefined;
497
+ }) => Promise<InlineCommentModel & {
498
+ _links?: ({
499
499
  /** Base url of the Confluence site. */
500
- base?: string;
500
+ base?: string | undefined;
501
501
  } & {
502
502
  [key: string]: unknown;
503
- };
503
+ }) | undefined;
504
504
  } & {
505
505
  [key: string]: unknown;
506
- })>;
506
+ }>;
507
507
  /**
508
508
  * Returns the children inline comments of specific comment. The number of results
509
509
  * is limited by the `limit` parameter and additional results (if available)
@@ -517,7 +517,7 @@ export declare class CommentService extends CommonHttpService {
517
517
  * @scopes-current read:comment:confluence
518
518
  * @see https://developer.atlassian.com/cloud/confluence/rest/v2/api-group-comment#api-inline-comments-id-children-get
519
519
  */
520
- getInlineCommentChildren({ id, bodyFormat, sort, cursor, limit, }: {
520
+ getInlineCommentChildren: ({ id, bodyFormat, sort, cursor, limit, }: {
521
521
  /**
522
522
  * The ID of the parent comment for which inline comment children should be
523
523
  * returned.
@@ -528,24 +528,24 @@ export declare class CommentService extends CommonHttpService {
528
528
  * available, the representation will be available under a response field of the
529
529
  * same name under the `body` field.
530
530
  */
531
- bodyFormat?: PrimaryBodyRepresentation;
531
+ bodyFormat?: PrimaryBodyRepresentation | undefined;
532
532
  /** Used to sort the result by a particular field. */
533
- sort?: CommentSortOrder;
533
+ sort?: CommentSortOrder | undefined;
534
534
  /**
535
535
  * Used for pagination, this opaque cursor will be returned in the `next` URL in
536
536
  * the `Link` response header. Use the relative URL in the `Link` header to
537
537
  * retrieve the `next` set of results.
538
538
  */
539
- cursor?: string;
539
+ cursor?: string | undefined;
540
540
  /**
541
541
  * Maximum number of footer comments per result to return. If more results exist,
542
542
  * use the `Link` header to retrieve a relative URL that will return the next set
543
543
  * of results.
544
544
  */
545
- limit?: number;
546
- }): Promise<{
547
- results?: InlineCommentChildrenModel[];
548
- _links?: MultiEntityLinks;
545
+ limit?: number | undefined;
546
+ }) => Promise<{
547
+ results?: InlineCommentChildrenModel[] | undefined;
548
+ _links?: MultiEntityLinks | undefined;
549
549
  } & {
550
550
  [key: string]: unknown;
551
551
  }>;
@@ -562,30 +562,30 @@ export declare class CommentService extends CommonHttpService {
562
562
  * @scopes-current read:comment:confluence
563
563
  * @see https://developer.atlassian.com/cloud/confluence/rest/v2/api-group-comment#api-inline-comments-get
564
564
  */
565
- getInlineComments({ bodyFormat, sort, cursor, limit, }?: {
565
+ getInlineComments: ({ bodyFormat, sort, cursor, limit, }?: {
566
566
  /**
567
567
  * The content format type to be returned in the `body` field of the response. If
568
568
  * available, the representation will be available under a response field of the
569
569
  * same name under the `body` field.
570
570
  */
571
- bodyFormat?: PrimaryBodyRepresentation;
571
+ bodyFormat?: PrimaryBodyRepresentation | undefined;
572
572
  /** Used to sort the result by a particular field. */
573
- sort?: CommentSortOrder;
573
+ sort?: CommentSortOrder | undefined;
574
574
  /**
575
575
  * Used for pagination, this opaque cursor will be returned in the `next` URL in
576
576
  * the `Link` response header. Use the relative URL in the `Link` header to
577
577
  * retrieve the `next` set of results.
578
578
  */
579
- cursor?: string;
579
+ cursor?: string | undefined;
580
580
  /**
581
581
  * Maximum number of footer comments per result to return. If more results exist,
582
582
  * use the `Link` header to retrieve a relative URL that will return the next set
583
583
  * of results.
584
584
  */
585
- limit?: number;
586
- }): Promise<{
587
- results?: InlineCommentModel[];
588
- _links?: MultiEntityLinks;
585
+ limit?: number | undefined;
586
+ }) => Promise<{
587
+ results?: InlineCommentModel[] | undefined;
588
+ _links?: MultiEntityLinks | undefined;
589
589
  } & {
590
590
  [key: string]: unknown;
591
591
  }>;
@@ -602,7 +602,7 @@ export declare class CommentService extends CommonHttpService {
602
602
  * @scopes-current read:comment:confluence
603
603
  * @see https://developer.atlassian.com/cloud/confluence/rest/v2/api-group-comment#api-pages-id-footer-comments-get
604
604
  */
605
- getPageFooterComments({ id, bodyFormat, sort, cursor, limit, }: {
605
+ getPageFooterComments: ({ id, bodyFormat, sort, cursor, limit, }: {
606
606
  /** The ID of the page for which footer comments should be returned. */
607
607
  id: number;
608
608
  /**
@@ -610,24 +610,24 @@ export declare class CommentService extends CommonHttpService {
610
610
  * available, the representation will be available under a response field of the
611
611
  * same name under the `body` field.
612
612
  */
613
- bodyFormat?: PrimaryBodyRepresentation;
613
+ bodyFormat?: PrimaryBodyRepresentation | undefined;
614
614
  /** Used to sort the result by a particular field. */
615
- sort?: CommentSortOrder;
615
+ sort?: CommentSortOrder | undefined;
616
616
  /**
617
617
  * Used for pagination, this opaque cursor will be returned in the `next` URL in
618
618
  * the `Link` response header. Use the relative URL in the `Link` header to
619
619
  * retrieve the `next` set of results.
620
620
  */
621
- cursor?: string;
621
+ cursor?: string | undefined;
622
622
  /**
623
623
  * Maximum number of footer comments per result to return. If more results exist,
624
624
  * use the `Link` header to retrieve a relative URL that will return the next set
625
625
  * of results.
626
626
  */
627
- limit?: number;
628
- }): Promise<{
629
- results?: PageCommentModel[];
630
- _links?: MultiEntityLinks;
627
+ limit?: number | undefined;
628
+ }) => Promise<{
629
+ results?: PageCommentModel[] | undefined;
630
+ _links?: MultiEntityLinks | undefined;
631
631
  } & {
632
632
  [key: string]: unknown;
633
633
  }>;
@@ -644,7 +644,7 @@ export declare class CommentService extends CommonHttpService {
644
644
  * @scopes-current read:comment:confluence
645
645
  * @see https://developer.atlassian.com/cloud/confluence/rest/v2/api-group-comment#api-pages-id-inline-comments-get
646
646
  */
647
- getPageInlineComments({ id, bodyFormat, sort, cursor, limit, }: {
647
+ getPageInlineComments: ({ id, bodyFormat, sort, cursor, limit, }: {
648
648
  /** The ID of the page for which inline comments should be returned. */
649
649
  id: number;
650
650
  /**
@@ -652,24 +652,24 @@ export declare class CommentService extends CommonHttpService {
652
652
  * available, the representation will be available under a response field of the
653
653
  * same name under the `body` field.
654
654
  */
655
- bodyFormat?: PrimaryBodyRepresentation;
655
+ bodyFormat?: PrimaryBodyRepresentation | undefined;
656
656
  /** Used to sort the result by a particular field. */
657
- sort?: CommentSortOrder;
657
+ sort?: CommentSortOrder | undefined;
658
658
  /**
659
659
  * Used for pagination, this opaque cursor will be returned in the `next` URL in
660
660
  * the `Link` response header. Use the relative URL in the `Link` header to
661
661
  * retrieve the `next` set of results.
662
662
  */
663
- cursor?: string;
663
+ cursor?: string | undefined;
664
664
  /**
665
665
  * Maximum number of inline comments per result to return. If more results exist,
666
666
  * use the `Link` header to retrieve a relative URL that will return the next set
667
667
  * of results.
668
668
  */
669
- limit?: number;
670
- }): Promise<{
671
- results?: PageInlineCommentModel[];
672
- _links?: MultiEntityLinks;
669
+ limit?: number | undefined;
670
+ }) => Promise<{
671
+ results?: PageInlineCommentModel[] | undefined;
672
+ _links?: MultiEntityLinks | undefined;
673
673
  } & {
674
674
  [key: string]: unknown;
675
675
  }>;
@@ -685,21 +685,21 @@ export declare class CommentService extends CommonHttpService {
685
685
  * @scopes-current write:comment:confluence
686
686
  * @see https://developer.atlassian.com/cloud/confluence/rest/v2/api-group-comment#api-footer-comments-comment-id-put
687
687
  */
688
- updateFooterComment({ commentId, requestBody, }: {
688
+ updateFooterComment: ({ commentId, requestBody, }: {
689
689
  /** The ID of the comment to be retrieved. */
690
690
  commentId: number;
691
691
  /** The footer comment to be created */
692
- requestBody: UpdateFooterCommentModel & ({
693
- _links?: {
692
+ requestBody: UpdateFooterCommentModel & {
693
+ _links?: ({
694
694
  /** Base url of the Confluence site. */
695
- base?: string;
695
+ base?: string | undefined;
696
696
  } & {
697
697
  [key: string]: unknown;
698
- };
698
+ }) | undefined;
699
699
  } & {
700
700
  [key: string]: unknown;
701
- });
702
- }): Promise<FooterCommentModel>;
701
+ };
702
+ }) => Promise<FooterCommentModel>;
703
703
  /**
704
704
  * Update an inline comment. This can be used to update the body text of a comment
705
705
  * and/or to resolve the comment
@@ -713,20 +713,20 @@ export declare class CommentService extends CommonHttpService {
713
713
  * @scopes-current write:comment:confluence
714
714
  * @see https://developer.atlassian.com/cloud/confluence/rest/v2/api-group-comment#api-inline-comments-comment-id-put
715
715
  */
716
- updateInlineComment({ commentId, updateInlineCommentModel, }: {
716
+ updateInlineComment: ({ commentId, updateInlineCommentModel, }: {
717
717
  /** The ID of the comment to be retrieved. */
718
718
  commentId: number;
719
719
  /** The inline comment to be updated */
720
720
  updateInlineCommentModel: UpdateInlineCommentModel;
721
- }): Promise<InlineCommentModel & ({
722
- _links?: {
721
+ }) => Promise<InlineCommentModel & {
722
+ _links?: ({
723
723
  /** Base url of the Confluence site. */
724
- base?: string;
724
+ base?: string | undefined;
725
725
  } & {
726
726
  [key: string]: unknown;
727
- };
727
+ }) | undefined;
728
728
  } & {
729
729
  [key: string]: unknown;
730
- })>;
730
+ }>;
731
731
  static initialize(): void;
732
732
  }