@resolution/confluence-api-client 0.13.4 → 0.14.0

This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
Files changed (128) hide show
  1. package/lib/openapi/core/CommonHttpClient.d.ts +1 -1
  2. package/lib/openapi/core/CommonHttpClient.js +1 -1
  3. package/lib/openapi/core/CommonHttpClient.js.map +1 -1
  4. package/lib/openapi/v1/BaseConfluenceApiV1Client.d.ts +6 -37
  5. package/lib/openapi/v1/BaseConfluenceApiV1Client.js +3 -71
  6. package/lib/openapi/v1/BaseConfluenceApiV1Client.js.map +1 -1
  7. package/lib/openapi/v1/models/audit.js +2 -2
  8. package/lib/openapi/v1/models/audit.js.map +1 -1
  9. package/lib/openapi/v1/models/common.d.ts +1 -1
  10. package/lib/openapi/v1/models/common.js +3 -3
  11. package/lib/openapi/v1/models/common.js.map +1 -1
  12. package/lib/openapi/v1/models/content.d.ts +0 -543
  13. package/lib/openapi/v1/models/content.js +2 -309
  14. package/lib/openapi/v1/models/content.js.map +1 -1
  15. package/lib/openapi/v1/models/contentChildrenAndDescendants.d.ts +7 -3
  16. package/lib/openapi/v1/models/contentChildrenAndDescendants.js +1 -1
  17. package/lib/openapi/v1/models/contentChildrenAndDescendants.js.map +1 -1
  18. package/lib/openapi/v1/models/contentRestrictions.js +1 -1
  19. package/lib/openapi/v1/models/contentRestrictions.js.map +1 -1
  20. package/lib/openapi/v1/models/contentStates.d.ts +322 -0
  21. package/lib/openapi/v1/models/contentStates.js +219 -0
  22. package/lib/openapi/v1/models/contentStates.js.map +1 -1
  23. package/lib/openapi/v1/models/contentVersions.d.ts +0 -9
  24. package/lib/openapi/v1/models/contentVersions.js +1 -10
  25. package/lib/openapi/v1/models/contentVersions.js.map +1 -1
  26. package/lib/openapi/v1/models/dynamicModules.d.ts +3 -3
  27. package/lib/openapi/v1/models/space.d.ts +1 -9
  28. package/lib/openapi/v1/models/space.js +1 -8
  29. package/lib/openapi/v1/models/space.js.map +1 -1
  30. package/lib/openapi/v1/models/template.js +1 -1
  31. package/lib/openapi/v1/models/template.js.map +1 -1
  32. package/lib/openapi/v1/services/AnalyticsService.d.ts +4 -0
  33. package/lib/openapi/v1/services/AnalyticsService.js.map +1 -1
  34. package/lib/openapi/v1/services/ContentAttachmentsService.d.ts +0 -130
  35. package/lib/openapi/v1/services/ContentAttachmentsService.js +0 -52
  36. package/lib/openapi/v1/services/ContentAttachmentsService.js.map +1 -1
  37. package/lib/openapi/v1/services/ContentBodyService.d.ts +1 -102
  38. package/lib/openapi/v1/services/ContentBodyService.js +1 -65
  39. package/lib/openapi/v1/services/ContentBodyService.js.map +1 -1
  40. package/lib/openapi/v1/services/ContentChildrenAndDescendantsService.d.ts +5 -220
  41. package/lib/openapi/v1/services/ContentChildrenAndDescendantsService.js +4 -144
  42. package/lib/openapi/v1/services/ContentChildrenAndDescendantsService.js.map +1 -1
  43. package/lib/openapi/v1/services/ContentLabelsService.d.ts +1 -44
  44. package/lib/openapi/v1/services/ContentLabelsService.js +0 -41
  45. package/lib/openapi/v1/services/ContentLabelsService.js.map +1 -1
  46. package/lib/openapi/v1/services/ContentService.d.ts +2 -560
  47. package/lib/openapi/v1/services/ContentService.js +1 -300
  48. package/lib/openapi/v1/services/ContentService.js.map +1 -1
  49. package/lib/openapi/v1/services/ContentVersionsService.d.ts +1 -72
  50. package/lib/openapi/v1/services/ContentVersionsService.js +1 -97
  51. package/lib/openapi/v1/services/ContentVersionsService.js.map +1 -1
  52. package/lib/openapi/v1/services/GroupService.d.ts +1 -1
  53. package/lib/openapi/v1/services/GroupService.js +1 -1
  54. package/lib/openapi/v1/services/SettingsService.d.ts +0 -26
  55. package/lib/openapi/v1/services/SettingsService.js +0 -38
  56. package/lib/openapi/v1/services/SettingsService.js.map +1 -1
  57. package/lib/openapi/v1/services/SpaceService.d.ts +2 -406
  58. package/lib/openapi/v1/services/SpaceService.js +1 -215
  59. package/lib/openapi/v1/services/SpaceService.js.map +1 -1
  60. package/lib/openapi/v2/BaseConfluenceApiV2Client.d.ts +22 -3
  61. package/lib/openapi/v2/BaseConfluenceApiV2Client.js +25 -1
  62. package/lib/openapi/v2/BaseConfluenceApiV2Client.js.map +1 -1
  63. package/lib/openapi/v2/models/adminKey.d.ts +13 -0
  64. package/lib/openapi/v2/models/adminKey.js +12 -0
  65. package/lib/openapi/v2/models/adminKey.js.map +1 -0
  66. package/lib/openapi/v2/models/children.d.ts +21 -6
  67. package/lib/openapi/v2/models/children.js +10 -1
  68. package/lib/openapi/v2/models/children.js.map +1 -1
  69. package/lib/openapi/v2/models/common.d.ts +6 -0
  70. package/lib/openapi/v2/models/common.js +1 -0
  71. package/lib/openapi/v2/models/common.js.map +1 -1
  72. package/lib/openapi/v2/models/descendants.d.ts +29 -0
  73. package/lib/openapi/v2/models/descendants.js +19 -0
  74. package/lib/openapi/v2/models/descendants.js.map +1 -0
  75. package/lib/openapi/v2/services/AdminKeyService.d.ts +71 -0
  76. package/lib/openapi/v2/services/AdminKeyService.js +111 -0
  77. package/lib/openapi/v2/services/AdminKeyService.js.map +1 -0
  78. package/lib/openapi/v2/services/AttachmentService.d.ts +6 -5
  79. package/lib/openapi/v2/services/AttachmentService.js.map +1 -1
  80. package/lib/openapi/v2/services/BlogPostService.d.ts +5 -4
  81. package/lib/openapi/v2/services/BlogPostService.js.map +1 -1
  82. package/lib/openapi/v2/services/ChildrenService.d.ts +307 -1
  83. package/lib/openapi/v2/services/ChildrenService.js +321 -0
  84. package/lib/openapi/v2/services/ChildrenService.js.map +1 -1
  85. package/lib/openapi/v2/services/CommentService.d.ts +10 -8
  86. package/lib/openapi/v2/services/CommentService.js.map +1 -1
  87. package/lib/openapi/v2/services/ContentPropertiesService.d.ts +1 -1
  88. package/lib/openapi/v2/services/CustomContentService.d.ts +18 -1
  89. package/lib/openapi/v2/services/CustomContentService.js +5 -0
  90. package/lib/openapi/v2/services/CustomContentService.js.map +1 -1
  91. package/lib/openapi/v2/services/DatabaseService.d.ts +4 -6
  92. package/lib/openapi/v2/services/DatabaseService.js.map +1 -1
  93. package/lib/openapi/v2/services/DescendantsService.d.ts +346 -0
  94. package/lib/openapi/v2/services/DescendantsService.js +362 -0
  95. package/lib/openapi/v2/services/DescendantsService.js.map +1 -0
  96. package/lib/openapi/v2/services/FolderService.d.ts +4 -6
  97. package/lib/openapi/v2/services/FolderService.js.map +1 -1
  98. package/lib/openapi/v2/services/PageService.d.ts +49 -6
  99. package/lib/openapi/v2/services/PageService.js +42 -2
  100. package/lib/openapi/v2/services/PageService.js.map +1 -1
  101. package/lib/openapi/v2/services/SmartLinkService.d.ts +4 -6
  102. package/lib/openapi/v2/services/SmartLinkService.js.map +1 -1
  103. package/lib/openapi/v2/services/SpaceService.d.ts +2 -1
  104. package/lib/openapi/v2/services/SpaceService.js.map +1 -1
  105. package/lib/openapi/v2/services/WhiteboardService.d.ts +6 -8
  106. package/lib/openapi/v2/services/WhiteboardService.js.map +1 -1
  107. package/package.json +3 -3
  108. package/lib/openapi/v1/models/contentProperties.d.ts +0 -78
  109. package/lib/openapi/v1/models/contentProperties.js +0 -48
  110. package/lib/openapi/v1/models/contentProperties.js.map +0 -1
  111. package/lib/openapi/v1/models/inlineTasks.d.ts +0 -33
  112. package/lib/openapi/v1/models/inlineTasks.js +0 -36
  113. package/lib/openapi/v1/models/inlineTasks.js.map +0 -1
  114. package/lib/openapi/v1/models/spaceProperties.d.ts +0 -103
  115. package/lib/openapi/v1/models/spaceProperties.js +0 -48
  116. package/lib/openapi/v1/models/spaceProperties.js.map +0 -1
  117. package/lib/openapi/v1/services/ContentCommentsService.d.ts +0 -153
  118. package/lib/openapi/v1/services/ContentCommentsService.js +0 -81
  119. package/lib/openapi/v1/services/ContentCommentsService.js.map +0 -1
  120. package/lib/openapi/v1/services/ContentPropertiesService.d.ts +0 -203
  121. package/lib/openapi/v1/services/ContentPropertiesService.js +0 -279
  122. package/lib/openapi/v1/services/ContentPropertiesService.js.map +0 -1
  123. package/lib/openapi/v1/services/InlineTasksService.d.ts +0 -101
  124. package/lib/openapi/v1/services/InlineTasksService.js +0 -145
  125. package/lib/openapi/v1/services/InlineTasksService.js.map +0 -1
  126. package/lib/openapi/v1/services/SpacePropertiesService.d.ts +0 -177
  127. package/lib/openapi/v1/services/SpacePropertiesService.js +0 -269
  128. package/lib/openapi/v1/services/SpacePropertiesService.js.map +0 -1
@@ -1,5 +1,5 @@
1
1
  import { CommonHttpService } from "../../core/CommonHttpService";
2
- import { type ChildCustomContent, type ChildPage } from "../models/children";
2
+ import { type ChildCustomContent, type ChildrenResponse, type ChildPage } from "../models/children";
3
3
  import { type MultiEntityLinks } from "../models/common";
4
4
  /**
5
5
  * @see https://developer.atlassian.com/cloud/confluence/rest/v2/api-group-children
@@ -57,6 +57,7 @@ export declare class ChildrenService extends CommonHttpService {
57
57
  * Permission to access the Confluence site ('Can use' global permission).
58
58
  * Only pages that the user has permission to view will be returned.
59
59
  *
60
+ * @deprecated
60
61
  * @returns Returned if the requested child pages are returned.
61
62
  * @path GET `/pages/{id}/children`
62
63
  * @scopes-current read:page:confluence
@@ -89,5 +90,310 @@ export declare class ChildrenService extends CommonHttpService {
89
90
  } & {
90
91
  [key: string]: unknown;
91
92
  }>;
93
+ /**
94
+ * Returns all children for given database id in the content tree. The number of
95
+ * results is limited by the `limit` parameter and additional results (if
96
+ * available)
97
+ * will be available through the `next` URL present in the `Link` response header.
98
+ *
99
+ * The following types of content will be returned:
100
+ * - Database
101
+ * - Embed
102
+ * - Folder
103
+ * - Page
104
+ * - Whiteboard
105
+ *
106
+ * This endpoint returns minimal information about each child. To fetch more
107
+ * details, use a related endpoint based on the content type, such
108
+ * as:
109
+ *
110
+ * - [Get database by
111
+ * id](https://developer.atlassian.com/cloud/confluence/rest/v2/api-group-database/#api-databases-id-get)
112
+ * - [Get embed by
113
+ * id](https://developer.atlassian.com/cloud/confluence/rest/v2/api-group-smart-link/#api-embeds-id-get)
114
+ * - [Get folder by
115
+ * id](https://developer.atlassian.com/cloud/confluence/rest/v2/api-group-folder/#api-folders-id-get)
116
+ * - [Get page by
117
+ * id](https://developer.atlassian.com/cloud/confluence/rest/v2/api-group-page/#api-pages-id-get)
118
+ * - [Get whiteboard by
119
+ * id](https://developer.atlassian.com/cloud/confluence/rest/v2/api-group-whiteboard/#api-whiteboards-id-get).
120
+ *
121
+ * **[Permissions](https://confluence.atlassian.com/x/_AozKw) required**:
122
+ * Permission to access the Confluence site ('Can use' global permission).
123
+ * Only content that the user has permission to view will be returned.
124
+ *
125
+ * @returns Returned if the requested children are returned.
126
+ * @path GET `/databases/{id}/direct-children`
127
+ * @scopes-current read:hierarchical-content:confluence
128
+ * @see https://developer.atlassian.com/cloud/confluence/rest/v2/api-group-children#api-databases-id-direct-children-get
129
+ * @param params
130
+ */
131
+ getDatabaseDirectChildren: ({ id, cursor, limit, sort }: {
132
+ /** The ID of the parent database. */
133
+ id: number;
134
+ /**
135
+ * Used for pagination, this opaque cursor will be returned in the `next` URL in
136
+ * the `Link` response header. Use the relative URL in the `Link` header to
137
+ * retrieve the `next` set of results.
138
+ */
139
+ cursor?: string | undefined;
140
+ /**
141
+ * Maximum number of items per result to return. If more results exist, use the
142
+ * `Link` header to retrieve a relative URL that will return the next set of
143
+ * results.
144
+ */
145
+ limit?: number | undefined;
146
+ /** Used to sort the result by a particular field. */
147
+ sort?: string | undefined;
148
+ }) => Promise<{
149
+ results?: ChildrenResponse[] | undefined;
150
+ _links?: MultiEntityLinks | undefined;
151
+ } & {
152
+ [key: string]: unknown;
153
+ }>;
154
+ /**
155
+ * Returns all children for given folder id in the content tree. The number of
156
+ * results is limited by the `limit` parameter and additional results (if
157
+ * available)
158
+ * will be available through the `next` URL present in the `Link` response header.
159
+ *
160
+ * The following types of content will be returned:
161
+ * - Database
162
+ * - Embed
163
+ * - Folder
164
+ * - Page
165
+ * - Whiteboard
166
+ *
167
+ * This endpoint returns minimal information about each child. To fetch more
168
+ * details, use a related endpoint based on the content type, such
169
+ * as:
170
+ *
171
+ * - [Get database by
172
+ * id](https://developer.atlassian.com/cloud/confluence/rest/v2/api-group-database/#api-databases-id-get)
173
+ * - [Get embed by
174
+ * id](https://developer.atlassian.com/cloud/confluence/rest/v2/api-group-smart-link/#api-embeds-id-get)
175
+ * - [Get folder by
176
+ * id](https://developer.atlassian.com/cloud/confluence/rest/v2/api-group-folder/#api-folders-id-get)
177
+ * - [Get page by
178
+ * id](https://developer.atlassian.com/cloud/confluence/rest/v2/api-group-page/#api-pages-id-get)
179
+ * - [Get whiteboard by
180
+ * id](https://developer.atlassian.com/cloud/confluence/rest/v2/api-group-whiteboard/#api-whiteboards-id-get).
181
+ *
182
+ * **[Permissions](https://confluence.atlassian.com/x/_AozKw) required**:
183
+ * Permission to access the Confluence site ('Can use' global permission).
184
+ * Only content that the user has permission to view will be returned.
185
+ *
186
+ * @returns Returned if the requested children are returned.
187
+ * @path GET `/folders/{id}/direct-children`
188
+ * @scopes-current read:hierarchical-content:confluence
189
+ * @see https://developer.atlassian.com/cloud/confluence/rest/v2/api-group-children#api-folders-id-direct-children-get
190
+ * @param params
191
+ */
192
+ getFolderDirectChildren: ({ id, cursor, limit, sort }: {
193
+ /** The ID of the parent folder. */
194
+ id: number;
195
+ /**
196
+ * Used for pagination, this opaque cursor will be returned in the `next` URL in
197
+ * the `Link` response header. Use the relative URL in the `Link` header to
198
+ * retrieve the `next` set of results.
199
+ */
200
+ cursor?: string | undefined;
201
+ /**
202
+ * Maximum number of items per result to return. If more results exist, use the
203
+ * `Link` header to retrieve a relative URL that will return the next set of
204
+ * results.
205
+ */
206
+ limit?: number | undefined;
207
+ /** Used to sort the result by a particular field. */
208
+ sort?: string | undefined;
209
+ }) => Promise<{
210
+ results?: ChildrenResponse[] | undefined;
211
+ _links?: MultiEntityLinks | undefined;
212
+ } & {
213
+ [key: string]: unknown;
214
+ }>;
215
+ /**
216
+ * Returns all children for given page id in the content tree. The number of
217
+ * results is limited by the `limit` parameter and additional results (if
218
+ * available)
219
+ * will be available through the `next` URL present in the `Link` response header.
220
+ *
221
+ * The following types of content will be returned:
222
+ * - Database
223
+ * - Embed
224
+ * - Folder
225
+ * - Page
226
+ * - Whiteboard
227
+ *
228
+ * This endpoint returns minimal information about each child. To fetch more
229
+ * details, use a related endpoint based on the content type, such
230
+ * as:
231
+ *
232
+ * - [Get database by
233
+ * id](https://developer.atlassian.com/cloud/confluence/rest/v2/api-group-database/#api-databases-id-get)
234
+ * - [Get embed by
235
+ * id](https://developer.atlassian.com/cloud/confluence/rest/v2/api-group-smart-link/#api-embeds-id-get)
236
+ * - [Get folder by
237
+ * id](https://developer.atlassian.com/cloud/confluence/rest/v2/api-group-folder/#api-folders-id-get)
238
+ * - [Get page by
239
+ * id](https://developer.atlassian.com/cloud/confluence/rest/v2/api-group-page/#api-pages-id-get)
240
+ * - [Get whiteboard by
241
+ * id](https://developer.atlassian.com/cloud/confluence/rest/v2/api-group-whiteboard/#api-whiteboards-id-get).
242
+ *
243
+ * **[Permissions](https://confluence.atlassian.com/x/_AozKw) required**:
244
+ * Permission to access the Confluence site ('Can use' global permission).
245
+ * Only content that the user has permission to view will be returned.
246
+ *
247
+ * @returns Returned if the requested children are returned.
248
+ * @path GET `/pages/{id}/direct-children`
249
+ * @scopes-current read:hierarchical-content:confluence
250
+ * @see https://developer.atlassian.com/cloud/confluence/rest/v2/api-group-children#api-pages-id-direct-children-get
251
+ * @param params
252
+ */
253
+ getPageDirectChildren: ({ id, cursor, limit, sort }: {
254
+ /** The ID of the parent page. */
255
+ id: number;
256
+ /**
257
+ * Used for pagination, this opaque cursor will be returned in the `next` URL in
258
+ * the `Link` response header. Use the relative URL in the `Link` header to
259
+ * retrieve the `next` set of results.
260
+ */
261
+ cursor?: string | undefined;
262
+ /**
263
+ * Maximum number of items per result to return. If more results exist, use the
264
+ * `Link` header to retrieve a relative URL that will return the next set of
265
+ * results.
266
+ */
267
+ limit?: number | undefined;
268
+ /** Used to sort the result by a particular field. */
269
+ sort?: string | undefined;
270
+ }) => Promise<{
271
+ results?: ChildrenResponse[] | undefined;
272
+ _links?: MultiEntityLinks | undefined;
273
+ } & {
274
+ [key: string]: unknown;
275
+ }>;
276
+ /**
277
+ * Returns all children for given smart link id in the content tree. The number of
278
+ * results is limited by the `limit` parameter and additional results (if
279
+ * available)
280
+ * will be available through the `next` URL present in the `Link` response header.
281
+ *
282
+ * The following types of content will be returned:
283
+ * - Database
284
+ * - Embed
285
+ * - Folder
286
+ * - Page
287
+ * - Whiteboard
288
+ *
289
+ * This endpoint returns minimal information about each child. To fetch more
290
+ * details, use a related endpoint based on the content type, such
291
+ * as:
292
+ *
293
+ * - [Get database by
294
+ * id](https://developer.atlassian.com/cloud/confluence/rest/v2/api-group-database/#api-databases-id-get)
295
+ * - [Get embed by
296
+ * id](https://developer.atlassian.com/cloud/confluence/rest/v2/api-group-smart-link/#api-embeds-id-get)
297
+ * - [Get folder by
298
+ * id](https://developer.atlassian.com/cloud/confluence/rest/v2/api-group-folder/#api-folders-id-get)
299
+ * - [Get page by
300
+ * id](https://developer.atlassian.com/cloud/confluence/rest/v2/api-group-page/#api-pages-id-get)
301
+ * - [Get whiteboard by
302
+ * id](https://developer.atlassian.com/cloud/confluence/rest/v2/api-group-whiteboard/#api-whiteboards-id-get).
303
+ *
304
+ * **[Permissions](https://confluence.atlassian.com/x/_AozKw) required**:
305
+ * Permission to access the Confluence site ('Can use' global permission).
306
+ * Only content that the user has permission to view will be returned.
307
+ *
308
+ * @returns Returned if the requested children are returned.
309
+ * @path GET `/embeds/{id}/direct-children`
310
+ * @scopes-current read:hierarchical-content:confluence
311
+ * @see https://developer.atlassian.com/cloud/confluence/rest/v2/api-group-children#api-embeds-id-direct-children-get
312
+ * @param params
313
+ */
314
+ getSmartLinkDirectChildren: ({ id, cursor, limit, sort }: {
315
+ /** The ID of the parent smart link. */
316
+ id: number;
317
+ /**
318
+ * Used for pagination, this opaque cursor will be returned in the `next` URL in
319
+ * the `Link` response header. Use the relative URL in the `Link` header to
320
+ * retrieve the `next` set of results.
321
+ */
322
+ cursor?: string | undefined;
323
+ /**
324
+ * Maximum number of items per result to return. If more results exist, use the
325
+ * `Link` header to retrieve a relative URL that will return the next set of
326
+ * results.
327
+ */
328
+ limit?: number | undefined;
329
+ /** Used to sort the result by a particular field. */
330
+ sort?: string | undefined;
331
+ }) => Promise<{
332
+ results?: ChildrenResponse[] | undefined;
333
+ _links?: MultiEntityLinks | undefined;
334
+ } & {
335
+ [key: string]: unknown;
336
+ }>;
337
+ /**
338
+ * Returns all children for given whiteboard id in the content tree. The number of
339
+ * results is limited by the `limit` parameter and additional results (if
340
+ * available)
341
+ * will be available through the `next` URL present in the `Link` response header.
342
+ *
343
+ * The following types of content will be returned:
344
+ * - Database
345
+ * - Embed
346
+ * - Folder
347
+ * - Page
348
+ * - Whiteboard
349
+ *
350
+ * This endpoint returns minimal information about each child. To fetch more
351
+ * details, use a related endpoint based on the content type, such
352
+ * as:
353
+ *
354
+ * - [Get database by
355
+ * id](https://developer.atlassian.com/cloud/confluence/rest/v2/api-group-database/#api-databases-id-get)
356
+ * - [Get embed by
357
+ * id](https://developer.atlassian.com/cloud/confluence/rest/v2/api-group-smart-link/#api-embeds-id-get)
358
+ * - [Get folder by
359
+ * id](https://developer.atlassian.com/cloud/confluence/rest/v2/api-group-folder/#api-folders-id-get)
360
+ * - [Get page by
361
+ * id](https://developer.atlassian.com/cloud/confluence/rest/v2/api-group-page/#api-pages-id-get)
362
+ * - [Get whiteboard by
363
+ * id](https://developer.atlassian.com/cloud/confluence/rest/v2/api-group-whiteboard/#api-whiteboards-id-get).
364
+ *
365
+ * **[Permissions](https://confluence.atlassian.com/x/_AozKw) required**:
366
+ * Permission to access the Confluence site ('Can use' global permission).
367
+ * Only content that the user has permission to view will be returned.
368
+ *
369
+ * @returns Returned if the requested children are returned.
370
+ * @path GET `/whiteboards/{id}/direct-children`
371
+ * @scopes-current read:hierarchical-content:confluence
372
+ * @see https://developer.atlassian.com/cloud/confluence/rest/v2/api-group-children#api-whiteboards-id-direct-children-get
373
+ * @param params
374
+ */
375
+ getWhiteboardDirectChildren: ({ id, cursor, limit, sort }: {
376
+ /** The ID of the parent whiteboard. */
377
+ id: number;
378
+ /**
379
+ * Used for pagination, this opaque cursor will be returned in the `next` URL in
380
+ * the `Link` response header. Use the relative URL in the `Link` header to
381
+ * retrieve the `next` set of results.
382
+ */
383
+ cursor?: string | undefined;
384
+ /**
385
+ * Maximum number of items per result to return. If more results exist, use the
386
+ * `Link` header to retrieve a relative URL that will return the next set of
387
+ * results.
388
+ */
389
+ limit?: number | undefined;
390
+ /** Used to sort the result by a particular field. */
391
+ sort?: string | undefined;
392
+ }) => Promise<{
393
+ results?: ChildrenResponse[] | undefined;
394
+ _links?: MultiEntityLinks | undefined;
395
+ } & {
396
+ [key: string]: unknown;
397
+ }>;
92
398
  protected static initialize(): void;
93
399
  }
@@ -60,6 +60,7 @@ class ChildrenService extends CommonHttpService_1.CommonHttpService {
60
60
  * Permission to access the Confluence site ('Can use' global permission).
61
61
  * Only pages that the user has permission to view will be returned.
62
62
  *
63
+ * @deprecated
63
64
  * @returns Returned if the requested child pages are returned.
64
65
  * @path GET `/pages/{id}/children`
65
66
  * @scopes-current read:page:confluence
@@ -84,6 +85,286 @@ class ChildrenService extends CommonHttpService_1.CommonHttpService {
84
85
  }
85
86
  })).then(commonHttpClient.castResponse()).then(this.getClientInstance().validation(validationSchemaStorage_1.validationSchemaStorage.validator("ChildrenService.getChildPages.response"))).then(commonHttpClient.getBody);
86
87
  };
88
+ /**
89
+ * Returns all children for given database id in the content tree. The number of
90
+ * results is limited by the `limit` parameter and additional results (if
91
+ * available)
92
+ * will be available through the `next` URL present in the `Link` response header.
93
+ *
94
+ * The following types of content will be returned:
95
+ * - Database
96
+ * - Embed
97
+ * - Folder
98
+ * - Page
99
+ * - Whiteboard
100
+ *
101
+ * This endpoint returns minimal information about each child. To fetch more
102
+ * details, use a related endpoint based on the content type, such
103
+ * as:
104
+ *
105
+ * - [Get database by
106
+ * id](https://developer.atlassian.com/cloud/confluence/rest/v2/api-group-database/#api-databases-id-get)
107
+ * - [Get embed by
108
+ * id](https://developer.atlassian.com/cloud/confluence/rest/v2/api-group-smart-link/#api-embeds-id-get)
109
+ * - [Get folder by
110
+ * id](https://developer.atlassian.com/cloud/confluence/rest/v2/api-group-folder/#api-folders-id-get)
111
+ * - [Get page by
112
+ * id](https://developer.atlassian.com/cloud/confluence/rest/v2/api-group-page/#api-pages-id-get)
113
+ * - [Get whiteboard by
114
+ * id](https://developer.atlassian.com/cloud/confluence/rest/v2/api-group-whiteboard/#api-whiteboards-id-get).
115
+ *
116
+ * **[Permissions](https://confluence.atlassian.com/x/_AozKw) required**:
117
+ * Permission to access the Confluence site ('Can use' global permission).
118
+ * Only content that the user has permission to view will be returned.
119
+ *
120
+ * @returns Returned if the requested children are returned.
121
+ * @path GET `/databases/{id}/direct-children`
122
+ * @scopes-current read:hierarchical-content:confluence
123
+ * @see https://developer.atlassian.com/cloud/confluence/rest/v2/api-group-children#api-databases-id-direct-children-get
124
+ * @param params
125
+ */
126
+ this.getDatabaseDirectChildren = ({ id, cursor, limit, sort }) => {
127
+ return this.getClientInstance().request({
128
+ path: "/databases/{id}/direct-children",
129
+ method: "GET",
130
+ pathParams: {
131
+ id
132
+ },
133
+ query: {
134
+ cursor,
135
+ limit,
136
+ sort
137
+ }
138
+ }).then(this.getClientInstance().responseHandler({
139
+ 200: {
140
+ "application/json": "json"
141
+ }
142
+ })).then(commonHttpClient.castResponse()).then(this.getClientInstance().validation(validationSchemaStorage_1.validationSchemaStorage.validator("ChildrenService.getDatabaseDirectChildren.response"))).then(commonHttpClient.getBody);
143
+ };
144
+ /**
145
+ * Returns all children for given folder id in the content tree. The number of
146
+ * results is limited by the `limit` parameter and additional results (if
147
+ * available)
148
+ * will be available through the `next` URL present in the `Link` response header.
149
+ *
150
+ * The following types of content will be returned:
151
+ * - Database
152
+ * - Embed
153
+ * - Folder
154
+ * - Page
155
+ * - Whiteboard
156
+ *
157
+ * This endpoint returns minimal information about each child. To fetch more
158
+ * details, use a related endpoint based on the content type, such
159
+ * as:
160
+ *
161
+ * - [Get database by
162
+ * id](https://developer.atlassian.com/cloud/confluence/rest/v2/api-group-database/#api-databases-id-get)
163
+ * - [Get embed by
164
+ * id](https://developer.atlassian.com/cloud/confluence/rest/v2/api-group-smart-link/#api-embeds-id-get)
165
+ * - [Get folder by
166
+ * id](https://developer.atlassian.com/cloud/confluence/rest/v2/api-group-folder/#api-folders-id-get)
167
+ * - [Get page by
168
+ * id](https://developer.atlassian.com/cloud/confluence/rest/v2/api-group-page/#api-pages-id-get)
169
+ * - [Get whiteboard by
170
+ * id](https://developer.atlassian.com/cloud/confluence/rest/v2/api-group-whiteboard/#api-whiteboards-id-get).
171
+ *
172
+ * **[Permissions](https://confluence.atlassian.com/x/_AozKw) required**:
173
+ * Permission to access the Confluence site ('Can use' global permission).
174
+ * Only content that the user has permission to view will be returned.
175
+ *
176
+ * @returns Returned if the requested children are returned.
177
+ * @path GET `/folders/{id}/direct-children`
178
+ * @scopes-current read:hierarchical-content:confluence
179
+ * @see https://developer.atlassian.com/cloud/confluence/rest/v2/api-group-children#api-folders-id-direct-children-get
180
+ * @param params
181
+ */
182
+ this.getFolderDirectChildren = ({ id, cursor, limit, sort }) => {
183
+ return this.getClientInstance().request({
184
+ path: "/folders/{id}/direct-children",
185
+ method: "GET",
186
+ pathParams: {
187
+ id
188
+ },
189
+ query: {
190
+ cursor,
191
+ limit,
192
+ sort
193
+ }
194
+ }).then(this.getClientInstance().responseHandler({
195
+ 200: {
196
+ "application/json": "json"
197
+ }
198
+ })).then(commonHttpClient.castResponse()).then(this.getClientInstance().validation(validationSchemaStorage_1.validationSchemaStorage.validator("ChildrenService.getFolderDirectChildren.response"))).then(commonHttpClient.getBody);
199
+ };
200
+ /**
201
+ * Returns all children for given page id in the content tree. The number of
202
+ * results is limited by the `limit` parameter and additional results (if
203
+ * available)
204
+ * will be available through the `next` URL present in the `Link` response header.
205
+ *
206
+ * The following types of content will be returned:
207
+ * - Database
208
+ * - Embed
209
+ * - Folder
210
+ * - Page
211
+ * - Whiteboard
212
+ *
213
+ * This endpoint returns minimal information about each child. To fetch more
214
+ * details, use a related endpoint based on the content type, such
215
+ * as:
216
+ *
217
+ * - [Get database by
218
+ * id](https://developer.atlassian.com/cloud/confluence/rest/v2/api-group-database/#api-databases-id-get)
219
+ * - [Get embed by
220
+ * id](https://developer.atlassian.com/cloud/confluence/rest/v2/api-group-smart-link/#api-embeds-id-get)
221
+ * - [Get folder by
222
+ * id](https://developer.atlassian.com/cloud/confluence/rest/v2/api-group-folder/#api-folders-id-get)
223
+ * - [Get page by
224
+ * id](https://developer.atlassian.com/cloud/confluence/rest/v2/api-group-page/#api-pages-id-get)
225
+ * - [Get whiteboard by
226
+ * id](https://developer.atlassian.com/cloud/confluence/rest/v2/api-group-whiteboard/#api-whiteboards-id-get).
227
+ *
228
+ * **[Permissions](https://confluence.atlassian.com/x/_AozKw) required**:
229
+ * Permission to access the Confluence site ('Can use' global permission).
230
+ * Only content that the user has permission to view will be returned.
231
+ *
232
+ * @returns Returned if the requested children are returned.
233
+ * @path GET `/pages/{id}/direct-children`
234
+ * @scopes-current read:hierarchical-content:confluence
235
+ * @see https://developer.atlassian.com/cloud/confluence/rest/v2/api-group-children#api-pages-id-direct-children-get
236
+ * @param params
237
+ */
238
+ this.getPageDirectChildren = ({ id, cursor, limit, sort }) => {
239
+ return this.getClientInstance().request({
240
+ path: "/pages/{id}/direct-children",
241
+ method: "GET",
242
+ pathParams: {
243
+ id
244
+ },
245
+ query: {
246
+ cursor,
247
+ limit,
248
+ sort
249
+ }
250
+ }).then(this.getClientInstance().responseHandler({
251
+ 200: {
252
+ "application/json": "json"
253
+ }
254
+ })).then(commonHttpClient.castResponse()).then(this.getClientInstance().validation(validationSchemaStorage_1.validationSchemaStorage.validator("ChildrenService.getPageDirectChildren.response"))).then(commonHttpClient.getBody);
255
+ };
256
+ /**
257
+ * Returns all children for given smart link id in the content tree. The number of
258
+ * results is limited by the `limit` parameter and additional results (if
259
+ * available)
260
+ * will be available through the `next` URL present in the `Link` response header.
261
+ *
262
+ * The following types of content will be returned:
263
+ * - Database
264
+ * - Embed
265
+ * - Folder
266
+ * - Page
267
+ * - Whiteboard
268
+ *
269
+ * This endpoint returns minimal information about each child. To fetch more
270
+ * details, use a related endpoint based on the content type, such
271
+ * as:
272
+ *
273
+ * - [Get database by
274
+ * id](https://developer.atlassian.com/cloud/confluence/rest/v2/api-group-database/#api-databases-id-get)
275
+ * - [Get embed by
276
+ * id](https://developer.atlassian.com/cloud/confluence/rest/v2/api-group-smart-link/#api-embeds-id-get)
277
+ * - [Get folder by
278
+ * id](https://developer.atlassian.com/cloud/confluence/rest/v2/api-group-folder/#api-folders-id-get)
279
+ * - [Get page by
280
+ * id](https://developer.atlassian.com/cloud/confluence/rest/v2/api-group-page/#api-pages-id-get)
281
+ * - [Get whiteboard by
282
+ * id](https://developer.atlassian.com/cloud/confluence/rest/v2/api-group-whiteboard/#api-whiteboards-id-get).
283
+ *
284
+ * **[Permissions](https://confluence.atlassian.com/x/_AozKw) required**:
285
+ * Permission to access the Confluence site ('Can use' global permission).
286
+ * Only content that the user has permission to view will be returned.
287
+ *
288
+ * @returns Returned if the requested children are returned.
289
+ * @path GET `/embeds/{id}/direct-children`
290
+ * @scopes-current read:hierarchical-content:confluence
291
+ * @see https://developer.atlassian.com/cloud/confluence/rest/v2/api-group-children#api-embeds-id-direct-children-get
292
+ * @param params
293
+ */
294
+ this.getSmartLinkDirectChildren = ({ id, cursor, limit, sort }) => {
295
+ return this.getClientInstance().request({
296
+ path: "/embeds/{id}/direct-children",
297
+ method: "GET",
298
+ pathParams: {
299
+ id
300
+ },
301
+ query: {
302
+ cursor,
303
+ limit,
304
+ sort
305
+ }
306
+ }).then(this.getClientInstance().responseHandler({
307
+ 200: {
308
+ "application/json": "json"
309
+ }
310
+ })).then(commonHttpClient.castResponse()).then(this.getClientInstance().validation(validationSchemaStorage_1.validationSchemaStorage.validator("ChildrenService.getSmartLinkDirectChildren.response"))).then(commonHttpClient.getBody);
311
+ };
312
+ /**
313
+ * Returns all children for given whiteboard id in the content tree. The number of
314
+ * results is limited by the `limit` parameter and additional results (if
315
+ * available)
316
+ * will be available through the `next` URL present in the `Link` response header.
317
+ *
318
+ * The following types of content will be returned:
319
+ * - Database
320
+ * - Embed
321
+ * - Folder
322
+ * - Page
323
+ * - Whiteboard
324
+ *
325
+ * This endpoint returns minimal information about each child. To fetch more
326
+ * details, use a related endpoint based on the content type, such
327
+ * as:
328
+ *
329
+ * - [Get database by
330
+ * id](https://developer.atlassian.com/cloud/confluence/rest/v2/api-group-database/#api-databases-id-get)
331
+ * - [Get embed by
332
+ * id](https://developer.atlassian.com/cloud/confluence/rest/v2/api-group-smart-link/#api-embeds-id-get)
333
+ * - [Get folder by
334
+ * id](https://developer.atlassian.com/cloud/confluence/rest/v2/api-group-folder/#api-folders-id-get)
335
+ * - [Get page by
336
+ * id](https://developer.atlassian.com/cloud/confluence/rest/v2/api-group-page/#api-pages-id-get)
337
+ * - [Get whiteboard by
338
+ * id](https://developer.atlassian.com/cloud/confluence/rest/v2/api-group-whiteboard/#api-whiteboards-id-get).
339
+ *
340
+ * **[Permissions](https://confluence.atlassian.com/x/_AozKw) required**:
341
+ * Permission to access the Confluence site ('Can use' global permission).
342
+ * Only content that the user has permission to view will be returned.
343
+ *
344
+ * @returns Returned if the requested children are returned.
345
+ * @path GET `/whiteboards/{id}/direct-children`
346
+ * @scopes-current read:hierarchical-content:confluence
347
+ * @see https://developer.atlassian.com/cloud/confluence/rest/v2/api-group-children#api-whiteboards-id-direct-children-get
348
+ * @param params
349
+ */
350
+ this.getWhiteboardDirectChildren = ({ id, cursor, limit, sort }) => {
351
+ return this.getClientInstance().request({
352
+ path: "/whiteboards/{id}/direct-children",
353
+ method: "GET",
354
+ pathParams: {
355
+ id
356
+ },
357
+ query: {
358
+ cursor,
359
+ limit,
360
+ sort
361
+ }
362
+ }).then(this.getClientInstance().responseHandler({
363
+ 200: {
364
+ "application/json": "json"
365
+ }
366
+ })).then(commonHttpClient.castResponse()).then(this.getClientInstance().validation(validationSchemaStorage_1.validationSchemaStorage.validator("ChildrenService.getWhiteboardDirectChildren.response"))).then(commonHttpClient.getBody);
367
+ };
87
368
  }
88
369
  static initialize() {
89
370
  validationSchemaStorage_1.validationSchemaStorage.registerExtensible("ChildrenService.getChildCustomContent.response", zod_1.z.object({
@@ -94,6 +375,30 @@ class ChildrenService extends CommonHttpService_1.CommonHttpService {
94
375
  _links: validationSchemaStorage_1.validationSchemaStorage.lazy("MultiEntityLinks").optional()
95
376
  }).catchall(zod_1.z.unknown())
96
377
  }).describe("ChildrenService.getChildCustomContent.response"));
378
+ validationSchemaStorage_1.validationSchemaStorage.registerExtensible("ChildrenService.getDatabaseDirectChildren.response", zod_1.z.object({
379
+ status: zod_1.z.literal(200),
380
+ mediaType: zod_1.z.literal("application/json"),
381
+ body: zod_1.z.object({
382
+ results: zod_1.z.array(validationSchemaStorage_1.validationSchemaStorage.lazy("ChildrenResponse")).optional(),
383
+ _links: validationSchemaStorage_1.validationSchemaStorage.lazy("MultiEntityLinks").optional()
384
+ }).catchall(zod_1.z.unknown())
385
+ }).describe("ChildrenService.getDatabaseDirectChildren.response"));
386
+ validationSchemaStorage_1.validationSchemaStorage.registerExtensible("ChildrenService.getSmartLinkDirectChildren.response", zod_1.z.object({
387
+ status: zod_1.z.literal(200),
388
+ mediaType: zod_1.z.literal("application/json"),
389
+ body: zod_1.z.object({
390
+ results: zod_1.z.array(validationSchemaStorage_1.validationSchemaStorage.lazy("ChildrenResponse")).optional(),
391
+ _links: validationSchemaStorage_1.validationSchemaStorage.lazy("MultiEntityLinks").optional()
392
+ }).catchall(zod_1.z.unknown())
393
+ }).describe("ChildrenService.getSmartLinkDirectChildren.response"));
394
+ validationSchemaStorage_1.validationSchemaStorage.registerExtensible("ChildrenService.getFolderDirectChildren.response", zod_1.z.object({
395
+ status: zod_1.z.literal(200),
396
+ mediaType: zod_1.z.literal("application/json"),
397
+ body: zod_1.z.object({
398
+ results: zod_1.z.array(validationSchemaStorage_1.validationSchemaStorage.lazy("ChildrenResponse")).optional(),
399
+ _links: validationSchemaStorage_1.validationSchemaStorage.lazy("MultiEntityLinks").optional()
400
+ }).catchall(zod_1.z.unknown())
401
+ }).describe("ChildrenService.getFolderDirectChildren.response"));
97
402
  validationSchemaStorage_1.validationSchemaStorage.registerExtensible("ChildrenService.getChildPages.response", zod_1.z.object({
98
403
  status: zod_1.z.literal(200),
99
404
  mediaType: zod_1.z.literal("application/json"),
@@ -102,6 +407,22 @@ class ChildrenService extends CommonHttpService_1.CommonHttpService {
102
407
  _links: validationSchemaStorage_1.validationSchemaStorage.lazy("MultiEntityLinks").optional()
103
408
  }).catchall(zod_1.z.unknown())
104
409
  }).describe("ChildrenService.getChildPages.response"));
410
+ validationSchemaStorage_1.validationSchemaStorage.registerExtensible("ChildrenService.getPageDirectChildren.response", zod_1.z.object({
411
+ status: zod_1.z.literal(200),
412
+ mediaType: zod_1.z.literal("application/json"),
413
+ body: zod_1.z.object({
414
+ results: zod_1.z.array(validationSchemaStorage_1.validationSchemaStorage.lazy("ChildrenResponse")).optional(),
415
+ _links: validationSchemaStorage_1.validationSchemaStorage.lazy("MultiEntityLinks").optional()
416
+ }).catchall(zod_1.z.unknown())
417
+ }).describe("ChildrenService.getPageDirectChildren.response"));
418
+ validationSchemaStorage_1.validationSchemaStorage.registerExtensible("ChildrenService.getWhiteboardDirectChildren.response", zod_1.z.object({
419
+ status: zod_1.z.literal(200),
420
+ mediaType: zod_1.z.literal("application/json"),
421
+ body: zod_1.z.object({
422
+ results: zod_1.z.array(validationSchemaStorage_1.validationSchemaStorage.lazy("ChildrenResponse")).optional(),
423
+ _links: validationSchemaStorage_1.validationSchemaStorage.lazy("MultiEntityLinks").optional()
424
+ }).catchall(zod_1.z.unknown())
425
+ }).describe("ChildrenService.getWhiteboardDirectChildren.response"));
105
426
  validationSchemaStorage_1.validationSchemaStorage.registerOnce([children_1.registerChildrenValidationSchemas, common_1.registerCommonValidationSchemas]);
106
427
  }
107
428
  }