confluence.js 2.0.0-dev20250512202536 → 2.1.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 (224) hide show
  1. package/CHANGELOG.md +52 -2
  2. package/README.md +145 -183
  3. package/dist/cjs/api/analytics.cjs.map +1 -1
  4. package/dist/cjs/api/audit.cjs.map +1 -1
  5. package/dist/cjs/api/content.cjs +0 -5
  6. package/dist/cjs/api/content.cjs.map +1 -1
  7. package/dist/cjs/api/contentAttachments.cjs +1 -0
  8. package/dist/cjs/api/contentAttachments.cjs.map +1 -1
  9. package/dist/cjs/api/contentBody.cjs +18 -0
  10. package/dist/cjs/api/contentBody.cjs.map +1 -1
  11. package/dist/cjs/api/contentChildrenAndDescendants.cjs +2 -0
  12. package/dist/cjs/api/contentChildrenAndDescendants.cjs.map +1 -1
  13. package/dist/cjs/api/contentComments.cjs +1 -0
  14. package/dist/cjs/api/contentComments.cjs.map +1 -1
  15. package/dist/cjs/api/contentLabels.cjs.map +1 -1
  16. package/dist/cjs/api/contentMacroBody.cjs.map +1 -1
  17. package/dist/cjs/api/contentPermissions.cjs.map +1 -1
  18. package/dist/cjs/api/contentProperties.cjs +1 -0
  19. package/dist/cjs/api/contentProperties.cjs.map +1 -1
  20. package/dist/cjs/api/contentRestrictions.cjs.map +1 -1
  21. package/dist/cjs/api/contentStates.cjs +13 -0
  22. package/dist/cjs/api/contentStates.cjs.map +1 -1
  23. package/dist/cjs/api/contentVersions.cjs.map +1 -1
  24. package/dist/cjs/api/contentWatches.cjs.map +1 -1
  25. package/dist/cjs/api/dynamicModules.cjs.map +1 -1
  26. package/dist/cjs/api/experimental.cjs.map +1 -1
  27. package/dist/cjs/api/group.cjs +18 -17
  28. package/dist/cjs/api/group.cjs.map +1 -1
  29. package/dist/cjs/api/index.cjs +2 -0
  30. package/dist/cjs/api/index.cjs.map +1 -1
  31. package/dist/cjs/api/inlineTasks.cjs +1 -0
  32. package/dist/cjs/api/inlineTasks.cjs.map +1 -1
  33. package/dist/cjs/api/labelInfo.cjs.map +1 -1
  34. package/dist/cjs/api/longRunningTask.cjs +1 -0
  35. package/dist/cjs/api/longRunningTask.cjs.map +1 -1
  36. package/dist/cjs/api/models/labeledContentType.cjs.map +1 -1
  37. package/dist/cjs/api/relation.cjs.map +1 -1
  38. package/dist/cjs/api/search.cjs +1 -0
  39. package/dist/cjs/api/search.cjs.map +1 -1
  40. package/dist/cjs/api/settings.cjs.map +1 -1
  41. package/dist/cjs/api/space.cjs +4 -2
  42. package/dist/cjs/api/space.cjs.map +1 -1
  43. package/dist/cjs/api/spacePermissions.cjs.map +1 -1
  44. package/dist/cjs/api/spaceProperties.cjs +1 -0
  45. package/dist/cjs/api/spaceProperties.cjs.map +1 -1
  46. package/dist/cjs/api/spaceSettings.cjs.map +1 -1
  47. package/dist/cjs/api/template.cjs.map +1 -1
  48. package/dist/cjs/api/themes.cjs.map +1 -1
  49. package/dist/cjs/api/userProperties.cjs +56 -0
  50. package/dist/cjs/api/userProperties.cjs.map +1 -0
  51. package/dist/cjs/api/users.cjs.map +1 -1
  52. package/dist/cjs/clients/baseClient.cjs.map +1 -1
  53. package/dist/cjs/clients/confluenceClient.cjs +6 -0
  54. package/dist/cjs/clients/confluenceClient.cjs.map +1 -1
  55. package/dist/cjs/config.cjs +3 -1
  56. package/dist/cjs/config.cjs.map +1 -1
  57. package/dist/cjs/paramSerializer.cjs.map +1 -1
  58. package/dist/cjs/services/authenticationService/authenticationService.cjs.map +1 -1
  59. package/dist/cjs/services/authenticationService/authentications/createBasicAuthenticationToken.cjs.map +1 -1
  60. package/dist/cjs/services/authenticationService/authentications/createJWTAuthentication.cjs +1 -1
  61. package/dist/cjs/services/authenticationService/authentications/createJWTAuthentication.cjs.map +1 -1
  62. package/dist/cjs/services/authenticationService/base64Encoder.cjs.map +1 -1
  63. package/dist/esm/api/analytics.mjs.map +1 -1
  64. package/dist/esm/api/audit.mjs.map +1 -1
  65. package/dist/esm/api/content.mjs +0 -5
  66. package/dist/esm/api/content.mjs.map +1 -1
  67. package/dist/esm/api/contentAttachments.mjs +1 -0
  68. package/dist/esm/api/contentAttachments.mjs.map +1 -1
  69. package/dist/esm/api/contentBody.mjs +18 -0
  70. package/dist/esm/api/contentBody.mjs.map +1 -1
  71. package/dist/esm/api/contentChildrenAndDescendants.mjs +2 -0
  72. package/dist/esm/api/contentChildrenAndDescendants.mjs.map +1 -1
  73. package/dist/esm/api/contentComments.mjs +1 -0
  74. package/dist/esm/api/contentComments.mjs.map +1 -1
  75. package/dist/esm/api/contentLabels.mjs.map +1 -1
  76. package/dist/esm/api/contentMacroBody.mjs.map +1 -1
  77. package/dist/esm/api/contentPermissions.mjs.map +1 -1
  78. package/dist/esm/api/contentProperties.mjs +1 -0
  79. package/dist/esm/api/contentProperties.mjs.map +1 -1
  80. package/dist/esm/api/contentRestrictions.mjs.map +1 -1
  81. package/dist/esm/api/contentStates.mjs +13 -0
  82. package/dist/esm/api/contentStates.mjs.map +1 -1
  83. package/dist/esm/api/contentVersions.mjs.map +1 -1
  84. package/dist/esm/api/contentWatches.mjs.map +1 -1
  85. package/dist/esm/api/dynamicModules.mjs.map +1 -1
  86. package/dist/esm/api/experimental.mjs.map +1 -1
  87. package/dist/esm/api/group.mjs +18 -17
  88. package/dist/esm/api/group.mjs.map +1 -1
  89. package/dist/esm/api/index.mjs +1 -0
  90. package/dist/esm/api/index.mjs.map +1 -1
  91. package/dist/esm/api/inlineTasks.mjs +1 -0
  92. package/dist/esm/api/inlineTasks.mjs.map +1 -1
  93. package/dist/esm/api/labelInfo.mjs.map +1 -1
  94. package/dist/esm/api/longRunningTask.mjs +1 -0
  95. package/dist/esm/api/longRunningTask.mjs.map +1 -1
  96. package/dist/esm/api/models/labeledContentType.mjs.map +1 -1
  97. package/dist/esm/api/relation.mjs.map +1 -1
  98. package/dist/esm/api/search.mjs +1 -0
  99. package/dist/esm/api/search.mjs.map +1 -1
  100. package/dist/esm/api/settings.mjs.map +1 -1
  101. package/dist/esm/api/space.mjs +4 -2
  102. package/dist/esm/api/space.mjs.map +1 -1
  103. package/dist/esm/api/spacePermissions.mjs.map +1 -1
  104. package/dist/esm/api/spaceProperties.mjs +1 -0
  105. package/dist/esm/api/spaceProperties.mjs.map +1 -1
  106. package/dist/esm/api/spaceSettings.mjs.map +1 -1
  107. package/dist/esm/api/template.mjs.map +1 -1
  108. package/dist/esm/api/themes.mjs.map +1 -1
  109. package/dist/esm/api/userProperties.mjs +54 -0
  110. package/dist/esm/api/userProperties.mjs.map +1 -0
  111. package/dist/esm/api/users.mjs.map +1 -1
  112. package/dist/esm/clients/baseClient.mjs.map +1 -1
  113. package/dist/esm/clients/confluenceClient.mjs +6 -0
  114. package/dist/esm/clients/confluenceClient.mjs.map +1 -1
  115. package/dist/esm/config.mjs +3 -1
  116. package/dist/esm/config.mjs.map +1 -1
  117. package/dist/esm/paramSerializer.mjs.map +1 -1
  118. package/dist/esm/services/authenticationService/authenticationService.mjs.map +1 -1
  119. package/dist/esm/services/authenticationService/authentications/createBasicAuthenticationToken.mjs.map +1 -1
  120. package/dist/esm/services/authenticationService/authentications/createJWTAuthentication.mjs +1 -1
  121. package/dist/esm/services/authenticationService/authentications/createJWTAuthentication.mjs.map +1 -1
  122. package/dist/esm/services/authenticationService/base64Encoder.mjs.map +1 -1
  123. package/dist/esm/types/api/analytics.d.ts +1 -1
  124. package/dist/esm/types/api/audit.d.ts +3 -3
  125. package/dist/esm/types/api/content.d.ts +33 -7
  126. package/dist/esm/types/api/contentAttachments.d.ts +5 -1
  127. package/dist/esm/types/api/contentBody.d.ts +73 -7
  128. package/dist/esm/types/api/contentChildrenAndDescendants.d.ts +37 -5
  129. package/dist/esm/types/api/contentComments.d.ts +5 -0
  130. package/dist/esm/types/api/contentLabels.d.ts +17 -9
  131. package/dist/esm/types/api/contentMacroBody.d.ts +79 -1
  132. package/dist/esm/types/api/contentPermissions.d.ts +1 -1
  133. package/dist/esm/types/api/contentProperties.d.ts +25 -0
  134. package/dist/esm/types/api/contentRestrictions.d.ts +19 -7
  135. package/dist/esm/types/api/contentStates.d.ts +23 -5
  136. package/dist/esm/types/api/contentVersions.d.ts +9 -1
  137. package/dist/esm/types/api/contentWatches.d.ts +1 -1
  138. package/dist/esm/types/api/dynamicModules.d.ts +1 -1
  139. package/dist/esm/types/api/experimental.d.ts +21 -1
  140. package/dist/esm/types/api/group.d.ts +47 -27
  141. package/dist/esm/types/api/index.d.ts +1 -0
  142. package/dist/esm/types/api/inlineTasks.d.ts +13 -0
  143. package/dist/esm/types/api/labelInfo.d.ts +1 -1
  144. package/dist/esm/types/api/longRunningTask.d.ts +1 -1
  145. package/dist/esm/types/api/models/spaceCreate.d.ts +11 -2
  146. package/dist/esm/types/api/models/spacePrivateCreate.d.ts +11 -2
  147. package/dist/esm/types/api/parameters/bulkAsyncConvertContentBodyRequest.d.ts +58 -0
  148. package/dist/esm/types/api/parameters/bulkAsyncConvertContentBodyResponse.d.ts +4 -0
  149. package/dist/esm/types/api/parameters/deleteGroupById.d.ts +4 -0
  150. package/dist/esm/types/api/parameters/downloadAttachment.d.ts +6 -0
  151. package/dist/esm/types/api/parameters/getContentChildren.d.ts +6 -1
  152. package/dist/esm/types/api/parameters/getContentsWithState.d.ts +17 -0
  153. package/dist/esm/types/api/parameters/getGroupMembersByGroupId.d.ts +7 -0
  154. package/dist/esm/types/api/parameters/getGroupMembershipsForUser.d.ts +4 -0
  155. package/dist/esm/types/api/parameters/getTasks.d.ts +2 -0
  156. package/dist/esm/types/api/parameters/getUser.d.ts +4 -0
  157. package/dist/esm/types/api/parameters/index.d.ts +4 -0
  158. package/dist/esm/types/api/parameters/searchUser.d.ts +7 -0
  159. package/dist/esm/types/api/relation.d.ts +13 -15
  160. package/dist/esm/types/api/search.d.ts +7 -1
  161. package/dist/esm/types/api/settings.d.ts +5 -1
  162. package/dist/esm/types/api/space.d.ts +23 -7
  163. package/dist/esm/types/api/spacePermissions.d.ts +1 -1
  164. package/dist/esm/types/api/spaceProperties.d.ts +25 -0
  165. package/dist/esm/types/api/spaceSettings.d.ts +1 -1
  166. package/dist/esm/types/api/template.d.ts +1 -1
  167. package/dist/esm/types/api/themes.d.ts +1 -1
  168. package/dist/esm/types/api/userProperties.d.ts +102 -0
  169. package/dist/esm/types/api/users.d.ts +21 -9
  170. package/dist/esm/types/clients/confluenceClient.d.ts +6 -1
  171. package/eslint.config.ts +11 -16
  172. package/package.json +29 -28
  173. package/src/api/analytics.ts +1 -1
  174. package/src/api/audit.ts +3 -3
  175. package/src/api/content.ts +33 -12
  176. package/src/api/contentAttachments.ts +6 -1
  177. package/src/api/contentBody.ts +113 -7
  178. package/src/api/contentChildrenAndDescendants.ts +39 -5
  179. package/src/api/contentComments.ts +5 -0
  180. package/src/api/contentLabels.ts +17 -9
  181. package/src/api/contentMacroBody.ts +79 -1
  182. package/src/api/contentPermissions.ts +1 -1
  183. package/src/api/contentProperties.ts +25 -0
  184. package/src/api/contentRestrictions.ts +19 -7
  185. package/src/api/contentStates.ts +47 -5
  186. package/src/api/contentVersions.ts +9 -1
  187. package/src/api/contentWatches.ts +1 -1
  188. package/src/api/dynamicModules.ts +1 -1
  189. package/src/api/experimental.ts +21 -1
  190. package/src/api/group.ts +96 -75
  191. package/src/api/index.ts +1 -0
  192. package/src/api/inlineTasks.ts +13 -0
  193. package/src/api/labelInfo.ts +1 -1
  194. package/src/api/longRunningTask.ts +2 -1
  195. package/src/api/models/spaceCreate.ts +11 -2
  196. package/src/api/models/spacePrivateCreate.ts +11 -2
  197. package/src/api/parameters/bulkAsyncConvertContentBodyRequest.ts +88 -0
  198. package/src/api/parameters/bulkAsyncConvertContentBodyResponse.ts +4 -0
  199. package/src/api/parameters/deleteGroupById.ts +4 -0
  200. package/src/api/parameters/downloadAttachment.ts +6 -0
  201. package/src/api/parameters/getContentChildren.ts +7 -1
  202. package/src/api/parameters/getContentsWithState.ts +17 -0
  203. package/src/api/parameters/getGroupMembersByGroupId.ts +7 -0
  204. package/src/api/parameters/getGroupMembershipsForUser.ts +4 -0
  205. package/src/api/parameters/getTasks.ts +2 -0
  206. package/src/api/parameters/getUser.ts +4 -0
  207. package/src/api/parameters/index.ts +4 -0
  208. package/src/api/parameters/searchUser.ts +7 -0
  209. package/src/api/relation.ts +13 -15
  210. package/src/api/search.ts +8 -1
  211. package/src/api/settings.ts +5 -1
  212. package/src/api/space.ts +27 -9
  213. package/src/api/spacePermissions.ts +1 -1
  214. package/src/api/spaceProperties.ts +25 -0
  215. package/src/api/spaceSettings.ts +1 -1
  216. package/src/api/template.ts +1 -1
  217. package/src/api/themes.ts +1 -1
  218. package/src/api/userProperties.ts +185 -0
  219. package/src/api/users.ts +21 -9
  220. package/src/clients/baseClient.ts +1 -5
  221. package/src/clients/confluenceClient.ts +6 -0
  222. package/src/config.ts +4 -1
  223. package/src/services/authenticationService/authentications/createJWTAuthentication.ts +1 -1
  224. package/favicon.svg +0 -7
@@ -0,0 +1,58 @@
1
+ import type { OneOrMany } from "../../interfaces/index.js";
2
+ export interface BulkAsyncConvertContentBodyRequest {
3
+ /** The name of the target format for the content body conversion. */
4
+ to: string;
5
+ /** This object is used when creating or updating content. */
6
+ body: Record<string, any> & {
7
+ /** The body of the content in the relevant format. */
8
+ value: string;
9
+ /** The content format type. Set the value of this property to the name of the format being used, e.g. 'storage'. */
10
+ representation: "view" | "export_view" | "styled_view" | "storage" | "editor" | "editor2" | "anonymous_export_view" | "wiki" | "atlas_doc_format" | "plain" | "raw" | string;
11
+ };
12
+ /**
13
+ * A multi-value, comma-separated parameter indicating which properties of the content to expand and populate. Expands
14
+ * are dependent on the `to` conversion format and may be irrelevant for certain conversions (e.g.
15
+ * `macroRenderedOutput` is redundant when converting to `view` format).
16
+ *
17
+ * If rendering to `view` format, and the body content being converted includes arbitrary nested content (such as
18
+ * macros); then it is necessary to include webresource expands in the request. Webresources for content body are the
19
+ * batched JS and CSS dependencies for any nested dynamic content (i.e. macros).
20
+ */
21
+ expand?: OneOrMany<"embeddedContent" | "mediaToken" | "macroRenderedOutput" | "webresource.superbatch.uris.js" | "webresource.superbatch.uris.css" | "webresource.superbatch.uris.all" | "webresource.superbatch.tags.all" | "webresource.superbatch.tags.css" | "webresource.superbatch.tags.js" | "webresource.uris.js" | "webresource.uris.css" | "webresource.uris.all" | "webresource.tags.all" | "webresource.tags.css" | "webresource.tags.js">;
22
+ /**
23
+ * Mode used for rendering embedded content, such as attachments.
24
+ *
25
+ * - `current` renders the embedded content using the latest version.
26
+ * - `version-at-save renders` the embedded content using the version at the time of save.
27
+ *
28
+ * @default current
29
+ */
30
+ embeddedContentRender?: "current" | "version-at-save" | string;
31
+ /**
32
+ * The content ID used to find the space for resolving embedded content (page includes, files, and links) in the
33
+ * content body. For example, if the source content contains the link
34
+ *
35
+ * `<ac:link><ri:page ri:content-title="Example page" /><ac:link>` and the `contentIdContext=123` parameter is
36
+ * provided, then the link will be converted into a link to the "Example page" page in the same space that has the
37
+ * content with ID=123. Note that `spaceKeyContext` will be ignored if this parameter is provided.
38
+ */
39
+ contentIdContext?: string;
40
+ /**
41
+ * The space key used for resolving embedded content (page includes, files, and links) in the content body. For
42
+ * example, if the source content contains the link `<ac:link><ri:page ri:content-title="Example page" /><ac:link>`
43
+ * and the `spaceKeyContext=TEST` parameter is provided, then the link will be converted into a link to the "Example
44
+ * page" page in the "TEST" space.
45
+ */
46
+ spaceKeyContext?: string;
47
+ /**
48
+ * If `false`, the cache will erase its current value and begin a new conversion. If `true`, the cache will not erase
49
+ * its current value, and will set the status of the async conversion to “RERUNNING”. Once the data is updated, the
50
+ * status will change to “COMPLETED”. Large macros that take a long time to convert and that need not be immediately
51
+ * up to date (e.g. a macro in which the new conversion result is the same as a previous conversion result that was
52
+ * completed within the last 5 minutes) should set this field to `true`. Cache values are stored per user per content
53
+ * body and expansions.
54
+ *
55
+ * @default false
56
+ */
57
+ allowCache?: boolean;
58
+ }
@@ -0,0 +1,4 @@
1
+ export interface BulkAsyncConvertContentBodyResponse {
2
+ /** The asyncIds of the conversion tasks. */
3
+ ids: string[];
4
+ }
@@ -0,0 +1,4 @@
1
+ export interface DeleteGroupById {
2
+ /** Id of the group to delete. */
3
+ id: string;
4
+ }
@@ -8,4 +8,10 @@ export interface DownloadAttachment {
8
8
  * the attachment.
9
9
  */
10
10
  version?: number;
11
+ /**
12
+ * The statuses allowed on the retrieved attachment. If this parameter is absent, it will default to `current`.
13
+ *
14
+ * @default current
15
+ */
16
+ status?: string | string[];
11
17
  }
@@ -1,3 +1,4 @@
1
+ import type { OneOrMany } from "../../interfaces/index.js";
1
2
  export interface GetContentChildren {
2
3
  /** The ID of the content to be queried for its children. */
3
4
  id: string;
@@ -9,7 +10,11 @@ export interface GetContentChildren {
9
10
  * - `page` returns all child pages of the content.
10
11
  * - Custom content types that are provided by apps are also supported.
11
12
  */
12
- expand?: string[];
13
+ expand?: OneOrMany<"attachment" | "comments" | "page" | string>;
13
14
  /** The version of the parent content to retrieve children for. Currently, this only works for the latest version. */
14
15
  parentVersion?: number;
16
+ /** The starting index of the returned content children. */
17
+ start?: number;
18
+ /** The maximum number of content children to return per page. */
19
+ limit?: number;
15
20
  }
@@ -0,0 +1,17 @@
1
+ export interface GetContentsWithState {
2
+ /** The key of the space to be queried for its content state settings. */
3
+ spaceKey: string;
4
+ /** The id of the content state to filter content by */
5
+ stateId: number;
6
+ /**
7
+ * A multi-value parameter indicating which properties of the content to expand. Options include: space, version,
8
+ * history, children, etc.
9
+ *
10
+ * Ex: (space, version);
11
+ */
12
+ expand?: string[];
13
+ /** Maximum number of results to return */
14
+ limit?: number;
15
+ /** Number of result to start returning. (0 indexed) */
16
+ start?: number;
17
+ }
@@ -10,4 +10,11 @@ export interface GetGroupMembersByGroupId {
10
10
  * operation; use it if your use case needs this value.
11
11
  */
12
12
  shouldReturnTotalSize?: boolean;
13
+ /**
14
+ * A multi-value parameter indicating which properties of the user to expand.
15
+ *
16
+ * - `operations` returns the operations that the user is allowed to do.
17
+ * - `personalSpace` returns the user's personal space, if it exists.
18
+ */
19
+ expand?: 'operations' | 'personalSpace' | string | ('operations' | 'personalSpace' | string)[];
13
20
  }
@@ -2,11 +2,15 @@ export interface GetGroupMembershipsForUser {
2
2
  /**
3
3
  * This parameter is no longer available and will be removed from the documentation soon. Use `accountId` instead. See
4
4
  * the [deprecation notice](/cloud/confluence/deprecation-notice-user-privacy-api-migration-guide/) for details.
5
+ *
6
+ * @deprecated Will be removed in next major version.
5
7
  */
6
8
  key?: string;
7
9
  /**
8
10
  * This parameter is no longer available and will be removed from the documentation soon. Use `accountId` instead. See
9
11
  * the [deprecation notice](/cloud/confluence/deprecation-notice-user-privacy-api-migration-guide/) for details.
12
+ *
13
+ * @deprecated Will be removed in next major version.
10
14
  */
11
15
  username?: string;
12
16
  /**
@@ -1,4 +1,6 @@
1
1
  export interface GetTasks {
2
+ /** The key of the tasks. */
3
+ key?: string;
2
4
  /** The starting index of the returned tasks. */
3
5
  start?: number;
4
6
  /** The maximum number of tasks to return per page. Note, this may be restricted by fixed system limits. */
@@ -2,11 +2,15 @@ export interface GetUser {
2
2
  /**
3
3
  * This parameter is no longer available and will be removed from the documentation soon. Use `accountId` instead. See
4
4
  * the [deprecation notice](/cloud/confluence/deprecation-notice-user-privacy-api-migration-guide/) for details.
5
+ *
6
+ * @deprecated Will be removed in next major version.
5
7
  */
6
8
  key?: string;
7
9
  /**
8
10
  * This parameter is no longer available and will be removed from the documentation soon. Use `accountId` instead. See
9
11
  * the [deprecation notice](/cloud/confluence/deprecation-notice-user-privacy-api-migration-guide/) for details.
12
+ *
13
+ * @deprecated Will be removed in next major version.
10
14
  */
11
15
  username?: string;
12
16
  /**
@@ -14,6 +14,8 @@ export * from "./addUserToGroupByGroupId.js";
14
14
  export * from "./archivePages.js";
15
15
  export * from "./asyncConvertContentBodyRequest.js";
16
16
  export * from "./asyncConvertContentBodyResponse.js";
17
+ export * from "./bulkAsyncConvertContentBodyRequest.js";
18
+ export * from "./bulkAsyncConvertContentBodyResponse.js";
17
19
  export * from "./checkContentPermission.js";
18
20
  export * from "./convertContentBody.js";
19
21
  export * from "./copyPage.js";
@@ -35,6 +37,7 @@ export * from "./createUserProperty.js";
35
37
  export * from "./deleteContent.js";
36
38
  export * from "./deleteContentProperty.js";
37
39
  export * from "./deleteContentVersion.js";
40
+ export * from "./deleteGroupById.js";
38
41
  export * from "./deleteLabelFromSpace.js";
39
42
  export * from "./deletePageTree.js";
40
43
  export * from "./deleteRelationship.js";
@@ -71,6 +74,7 @@ export * from "./getContentRestrictionStatusForGroup.js";
71
74
  export * from "./getContentRestrictionStatusForUser.js";
72
75
  export * from "./getContentState.js";
73
76
  export * from "./getContentStateSettings.js";
77
+ export * from "./getContentsWithState.js";
74
78
  export * from "./getContentTemplate.js";
75
79
  export * from "./getContentTemplates.js";
76
80
  export * from "./getContentVersion.js";
@@ -24,4 +24,11 @@ export interface SearchUser {
24
24
  * - `personalSpace` returns the personal space of the user.
25
25
  */
26
26
  expand?: string[];
27
+ /**
28
+ * Filters users by permission type. Use `none` to default to licensed users, `externalCollaborator` for
29
+ * external/guest users, and `all` to include all permission types.
30
+ *
31
+ * @default none
32
+ */
33
+ sitePermissionTypeFilter?: 'all' | 'externalCollaborator' | 'none' | string;
27
34
  }
@@ -1,7 +1,7 @@
1
1
  import type * as Models from "./models/index.js";
2
2
  import type * as Parameters from "./parameters/index.js";
3
- import type { Callback } from "../callback.js";
4
3
  import type { Client } from "../clients/index.js";
4
+ import type { Callback } from "../callback.js";
5
5
  export declare class Relation {
6
6
  private client;
7
7
  constructor(client: Client);
@@ -10,8 +10,8 @@ export declare class Relation {
10
10
  * way.
11
11
  *
12
12
  * For example, the following method finds all content that the current user has an 'ignore' relationship with: `GET
13
- * https://your-domain.atlassian.net/wiki/rest/api/relation/ignore/from/user/current/to/content` Note, 'ignore' is an
14
- * example custom relationship type.
13
+ * https://your-domain.atlassian.net/api/relation/ignore/from/user/current/to/content` Note, 'ignore' is an example
14
+ * custom relationship type.
15
15
  *
16
16
  * **[Permissions](https://confluence.atlassian.com/x/_AozKw) required**: Permission to view both the target entity
17
17
  * and source entity.
@@ -22,8 +22,8 @@ export declare class Relation {
22
22
  * way.
23
23
  *
24
24
  * For example, the following method finds all content that the current user has an 'ignore' relationship with: `GET
25
- * https://your-domain.atlassian.net/wiki/rest/api/relation/ignore/from/user/current/to/content` Note, 'ignore' is an
26
- * example custom relationship type.
25
+ * https://your-domain.atlassian.net/api/relation/ignore/from/user/current/to/content` Note, 'ignore' is an example
26
+ * custom relationship type.
27
27
  *
28
28
  * **[Permissions](https://confluence.atlassian.com/x/_AozKw) required**: Permission to view both the target entity
29
29
  * and source entity.
@@ -35,7 +35,7 @@ export declare class Relation {
35
35
  *
36
36
  * For example, you can use this method to find whether the current user has selected a particular page as a favorite
37
37
  * (i.e. 'save for later'): `GET
38
- * https://your-domain.atlassian.net/wiki/rest/api/relation/favourite/from/user/current/to/content/123`
38
+ * https://your-domain.atlassian.net/api/relation/favourite/from/user/current/to/content/123`
39
39
  *
40
40
  * **[Permissions](https://confluence.atlassian.com/x/_AozKw) required**: Permission to view both the target entity
41
41
  * and source entity.
@@ -47,7 +47,7 @@ export declare class Relation {
47
47
  *
48
48
  * For example, you can use this method to find whether the current user has selected a particular page as a favorite
49
49
  * (i.e. 'save for later'): `GET
50
- * https://your-domain.atlassian.net/wiki/rest/api/relation/favourite/from/user/current/to/content/123`
50
+ * https://your-domain.atlassian.net/api/relation/favourite/from/user/current/to/content/123`
51
51
  *
52
52
  * **[Permissions](https://confluence.atlassian.com/x/_AozKw) required**: Permission to view both the target entity
53
53
  * and source entity.
@@ -58,7 +58,7 @@ export declare class Relation {
58
58
  * default, but you can use this method to create any type of relationship between two entities.
59
59
  *
60
60
  * For example, the following method creates a 'sibling' relationship between two pieces of content: `GET
61
- * https://your-domain.atlassian.net/wiki/rest/api/relation/sibling/from/content/123/to/content/456`
61
+ * https://your-domain.atlassian.net/api/relation/sibling/from/content/123/to/content/456`
62
62
  *
63
63
  * **[Permissions](https://confluence.atlassian.com/x/_AozKw) required**: Permission to access the Confluence site
64
64
  * ('Can use' global permission).
@@ -69,7 +69,7 @@ export declare class Relation {
69
69
  * default, but you can use this method to create any type of relationship between two entities.
70
70
  *
71
71
  * For example, the following method creates a 'sibling' relationship between two pieces of content: `GET
72
- * https://your-domain.atlassian.net/wiki/rest/api/relation/sibling/from/content/123/to/content/456`
72
+ * https://your-domain.atlassian.net/api/relation/sibling/from/content/123/to/content/456`
73
73
  *
74
74
  * **[Permissions](https://confluence.atlassian.com/x/_AozKw) required**: Permission to access the Confluence site
75
75
  * ('Can use' global permission).
@@ -96,9 +96,8 @@ export declare class Relation {
96
96
  * way.
97
97
  *
98
98
  * For example, the following method finds all users that have a 'collaborator' relationship to a piece of content
99
- * with an ID of '1234': `GET
100
- * https://your-domain.atlassian.net/wiki/rest/api/relation/collaborator/to/content/1234/from/user` Note,
101
- * 'collaborator' is an example custom relationship type.
99
+ * with an ID of '1234': `GET https://your-domain.atlassian.net/api/relation/collaborator/to/content/1234/from/user`
100
+ * Note, 'collaborator' is an example custom relationship type.
102
101
  *
103
102
  * **[Permissions](https://confluence.atlassian.com/x/_AozKw) required**: Permission to view both the target entity
104
103
  * and source entity.
@@ -109,9 +108,8 @@ export declare class Relation {
109
108
  * way.
110
109
  *
111
110
  * For example, the following method finds all users that have a 'collaborator' relationship to a piece of content
112
- * with an ID of '1234': `GET
113
- * https://your-domain.atlassian.net/wiki/rest/api/relation/collaborator/to/content/1234/from/user` Note,
114
- * 'collaborator' is an example custom relationship type.
111
+ * with an ID of '1234': `GET https://your-domain.atlassian.net/api/relation/collaborator/to/content/1234/from/user`
112
+ * Note, 'collaborator' is an example custom relationship type.
115
113
  *
116
114
  * **[Permissions](https://confluence.atlassian.com/x/_AozKw) required**: Permission to view both the target entity
117
115
  * and source entity.
@@ -1,7 +1,7 @@
1
1
  import type * as Models from "./models/index.js";
2
2
  import type * as Parameters from "./parameters/index.js";
3
- import type { Callback } from "../callback.js";
4
3
  import type { Client } from "../clients/index.js";
4
+ import type { Callback } from "../callback.js";
5
5
  export declare class Search {
6
6
  private client;
7
7
  constructor(client: Client);
@@ -33,6 +33,9 @@ export declare class Search {
33
33
  * Searches for users using user-specific queries from the [Confluence Query Language
34
34
  * (CQL)](https://developer.atlassian.com/cloud/confluence/advanced-searching-using-cql/).
35
35
  *
36
+ * Note that CQL input queries submitted through the `/api/search/user` endpoint only support user-specific fields
37
+ * like `user`, `user.fullname`, `user.accountid`, and `user.userkey`.
38
+ *
36
39
  * Note that some user fields may be set to null depending on the user's privacy settings. These are: email,
37
40
  * profilePicture, displayName, and timeZone.
38
41
  */
@@ -41,6 +44,9 @@ export declare class Search {
41
44
  * Searches for users using user-specific queries from the [Confluence Query Language
42
45
  * (CQL)](https://developer.atlassian.com/cloud/confluence/advanced-searching-using-cql/).
43
46
  *
47
+ * Note that CQL input queries submitted through the `/api/search/user` endpoint only support user-specific fields
48
+ * like `user`, `user.fullname`, `user.accountid`, and `user.userkey`.
49
+ *
44
50
  * Note that some user fields may be set to null depending on the user's privacy settings. These are: email,
45
51
  * profilePicture, displayName, and timeZone.
46
52
  */
@@ -1,7 +1,7 @@
1
1
  import type * as Models from "./models/index.js";
2
2
  import type * as Parameters from "./parameters/index.js";
3
- import type { Callback } from "../callback.js";
4
3
  import type { Client } from "../clients/index.js";
4
+ import type { Callback } from "../callback.js";
5
5
  export declare class Settings {
6
6
  private client;
7
7
  constructor(client: Client);
@@ -82,6 +82,8 @@ export declare class Settings {
82
82
  * space. Note, the default space settings are inherited from the current global settings.
83
83
  *
84
84
  * **[Permissions](https://confluence.atlassian.com/x/_AozKw) required**: 'Admin' permission for the space.
85
+ *
86
+ * @deprecated Will be removed in next major version.
85
87
  */
86
88
  setLookAndFeelSettings<T = unknown>(parameters: Parameters.SetLookAndFeelSettings | undefined, callback: Callback<T>): Promise<void>;
87
89
  /**
@@ -89,6 +91,8 @@ export declare class Settings {
89
91
  * space. Note, the default space settings are inherited from the current global settings.
90
92
  *
91
93
  * **[Permissions](https://confluence.atlassian.com/x/_AozKw) required**: 'Admin' permission for the space.
94
+ *
95
+ * @deprecated Will be removed in next major version.
92
96
  */
93
97
  setLookAndFeelSettings<T = unknown>(parameters?: Parameters.SetLookAndFeelSettings, callback?: never): Promise<T>;
94
98
  /**
@@ -1,7 +1,7 @@
1
1
  import type * as Models from "./models/index.js";
2
2
  import type * as Parameters from "./parameters/index.js";
3
- import type { Callback } from "../callback.js";
4
3
  import type { Client } from "../clients/index.js";
4
+ import type { Callback } from "../callback.js";
5
5
  export declare class Space {
6
6
  private client;
7
7
  constructor(client: Client);
@@ -11,6 +11,8 @@ export declare class Space {
11
11
  * **[Permissions](https://confluence.atlassian.com/x/_AozKw) required**: Permission to access the Confluence site
12
12
  * ('Can use' global permission). Note, the returned list will only contain spaces that the current user has
13
13
  * permission to view.
14
+ *
15
+ * @deprecated Will be removed in next major version.
14
16
  */
15
17
  getSpaces<T = Models.SpaceArray>(parameters: Parameters.GetSpaces | undefined, callback: Callback<T>): Promise<void>;
16
18
  /**
@@ -19,6 +21,8 @@ export declare class Space {
19
21
  * **[Permissions](https://confluence.atlassian.com/x/_AozKw) required**: Permission to access the Confluence site
20
22
  * ('Can use' global permission). Note, the returned list will only contain spaces that the current user has
21
23
  * permission to view.
24
+ *
25
+ * @deprecated Will be removed in next major version.
22
26
  */
23
27
  getSpaces<T = Models.SpaceArray>(parameters?: Parameters.GetSpaces, callback?: never): Promise<T>;
24
28
  /**
@@ -54,6 +58,8 @@ export declare class Space {
54
58
  * space.
55
59
  *
56
60
  * **[Permissions](https://confluence.atlassian.com/x/_AozKw) required**: 'View' permission for the space.
61
+ *
62
+ * @deprecated Will be removed in next major version.
57
63
  */
58
64
  getSpace<T = Models.Space>(parameters: Parameters.GetSpace, callback: Callback<T>): Promise<void>;
59
65
  /**
@@ -61,6 +67,8 @@ export declare class Space {
61
67
  * space.
62
68
  *
63
69
  * **[Permissions](https://confluence.atlassian.com/x/_AozKw) required**: 'View' permission for the space.
70
+ *
71
+ * @deprecated Will be removed in next major version.
64
72
  */
65
73
  getSpace<T = Models.Space>(parameters: Parameters.GetSpace, callback?: never): Promise<T>;
66
74
  /**
@@ -82,17 +90,17 @@ export declare class Space {
82
90
  */
83
91
  updateSpace<T = Models.Space>(parameters: Parameters.UpdateSpace, callback?: never): Promise<T>;
84
92
  /**
85
- * Deletes a space. Note, the space will be deleted in a long running task. Therefore, the space may not be deleted
86
- * yet when this method has returned. Clients should poll the status link that is returned in the response until the
87
- * task completes.
93
+ * Permanently deletes a space without sending it to the trash. Note, the space will be deleted in a long running
94
+ * task. Therefore, the space may not be deleted yet when this method has returned. Clients should poll the status
95
+ * link that is returned in the response until the task completes.
88
96
  *
89
97
  * **[Permissions](https://confluence.atlassian.com/x/_AozKw) required**: 'Admin' permission for the space.
90
98
  */
91
99
  deleteSpace<T = Models.LongTask>(parameters: Parameters.DeleteSpace, callback: Callback<T>): Promise<void>;
92
100
  /**
93
- * Deletes a space. Note, the space will be deleted in a long running task. Therefore, the space may not be deleted
94
- * yet when this method has returned. Clients should poll the status link that is returned in the response until the
95
- * task completes.
101
+ * Permanently deletes a space without sending it to the trash. Note, the space will be deleted in a long running
102
+ * task. Therefore, the space may not be deleted yet when this method has returned. Clients should poll the status
103
+ * link that is returned in the response until the task completes.
96
104
  *
97
105
  * **[Permissions](https://confluence.atlassian.com/x/_AozKw) required**: 'Admin' permission for the space.
98
106
  */
@@ -103,6 +111,8 @@ export declare class Space {
103
111
  *
104
112
  * **[Permissions](https://confluence.atlassian.com/x/_AozKw) required**: 'View' permission for the space. Note, the
105
113
  * returned list will only contain content that the current user has permission to view.
114
+ *
115
+ * @deprecated Will be removed in next major version.
106
116
  */
107
117
  getContentForSpace<T = Models.ContentArray>(parameters: Parameters.GetContentForSpace, callback: Callback<T>): Promise<void>;
108
118
  /**
@@ -111,6 +121,8 @@ export declare class Space {
111
121
  *
112
122
  * **[Permissions](https://confluence.atlassian.com/x/_AozKw) required**: 'View' permission for the space. Note, the
113
123
  * returned list will only contain content that the current user has permission to view.
124
+ *
125
+ * @deprecated Will be removed in next major version.
114
126
  */
115
127
  getContentForSpace<T = Models.ContentArray>(parameters: Parameters.GetContentForSpace, callback?: never): Promise<T>;
116
128
  /**
@@ -118,6 +130,8 @@ export declare class Space {
118
130
  *
119
131
  * **[Permissions](https://confluence.atlassian.com/x/_AozKw) required**: 'View' permission for the space. Note, the
120
132
  * returned list will only contain content that the current user has permission to view.
133
+ *
134
+ * @deprecated Will be removed in next major version.
121
135
  */
122
136
  getContentByTypeForSpace<T = Models.ContentArray>(parameters: Parameters.GetContentByTypeForSpace, callback: Callback<T>): Promise<void>;
123
137
  /**
@@ -125,6 +139,8 @@ export declare class Space {
125
139
  *
126
140
  * **[Permissions](https://confluence.atlassian.com/x/_AozKw) required**: 'View' permission for the space. Note, the
127
141
  * returned list will only contain content that the current user has permission to view.
142
+ *
143
+ * @deprecated Will be removed in next major version.
128
144
  */
129
145
  getContentByTypeForSpace<T = Models.ContentArray>(parameters: Parameters.GetContentByTypeForSpace, callback?: never): Promise<T>;
130
146
  }
@@ -1,7 +1,7 @@
1
1
  import type * as Models from "./models/index.js";
2
2
  import type * as Parameters from "./parameters/index.js";
3
- import type { Callback } from "../callback.js";
4
3
  import type { Client } from "../clients/index.js";
4
+ import type { Callback } from "../callback.js";
5
5
  export declare class SpacePermissions {
6
6
  private client;
7
7
  constructor(client: Client);
@@ -2,6 +2,7 @@ import type * as Models from "./models/index.js";
2
2
  import type * as Parameters from "./parameters/index.js";
3
3
  import type { Callback } from "../callback.js";
4
4
  import type { Client } from "../clients/index.js";
5
+ /** @deprecated Will be removed in next major version. */
5
6
  export declare class SpaceProperties {
6
7
  private client;
7
8
  constructor(client: Client);
@@ -9,36 +10,48 @@ export declare class SpaceProperties {
9
10
  * Returns all properties for the given space. Space properties are a key-value storage associated with a space.
10
11
  *
11
12
  * **[Permissions required](https://confluence.atlassian.com/x/_AozKw)**: ‘View’ permission for the space.
13
+ *
14
+ * @deprecated Will be removed in next major version.
12
15
  */
13
16
  getSpaceProperties<T = Models.SpacePropertyArray>(parameters: Parameters.GetSpaceProperties, callback: Callback<T>): Promise<void>;
14
17
  /**
15
18
  * Returns all properties for the given space. Space properties are a key-value storage associated with a space.
16
19
  *
17
20
  * **[Permissions required](https://confluence.atlassian.com/x/_AozKw)**: ‘View’ permission for the space.
21
+ *
22
+ * @deprecated Will be removed in next major version.
18
23
  */
19
24
  getSpaceProperties<T = Models.SpacePropertyArray>(parameters: Parameters.GetSpaceProperties, callback?: never): Promise<T>;
20
25
  /**
21
26
  * Creates a new space property.
22
27
  *
23
28
  * **[Permissions required](https://confluence.atlassian.com/x/_AozKw)**: ‘Admin’ permission for the space.
29
+ *
30
+ * @deprecated Will be removed in next major version.
24
31
  */
25
32
  createSpaceProperty<T = Models.SpaceProperty>(parameters: Parameters.CreateSpaceProperty, callback: Callback<T>): Promise<void>;
26
33
  /**
27
34
  * Creates a new space property.
28
35
  *
29
36
  * **[Permissions required](https://confluence.atlassian.com/x/_AozKw)**: ‘Admin’ permission for the space.
37
+ *
38
+ * @deprecated Will be removed in next major version.
30
39
  */
31
40
  createSpaceProperty<T = Models.SpaceProperty>(parameters: Parameters.CreateSpaceProperty, callback?: never): Promise<T>;
32
41
  /**
33
42
  * Returns a space property.
34
43
  *
35
44
  * **[Permissions required](https://confluence.atlassian.com/x/_AozKw)**: ‘View’ permission for the space.
45
+ *
46
+ * @deprecated Will be removed in next major version.
36
47
  */
37
48
  getSpaceProperty<T = Models.SpaceProperty>(parameters: Parameters.GetSpaceProperty, callback: Callback<T>): Promise<void>;
38
49
  /**
39
50
  * Returns a space property.
40
51
  *
41
52
  * **[Permissions required](https://confluence.atlassian.com/x/_AozKw)**: ‘View’ permission for the space.
53
+ *
54
+ * @deprecated Will be removed in next major version.
42
55
  */
43
56
  getSpaceProperty<T = Models.SpaceProperty>(parameters: Parameters.GetSpaceProperty, callback?: never): Promise<T>;
44
57
  /**
@@ -46,6 +59,8 @@ export declare class SpaceProperties {
46
59
  * property is passed as a path parameter, rather than in the request body.
47
60
  *
48
61
  * **[Permissions required](https://confluence.atlassian.com/x/_AozKw)**: ‘Admin’ permission for the space.
62
+ *
63
+ * @deprecated Will be removed in next major version.
49
64
  */
50
65
  createSpacePropertyForKey<T = Models.SpaceProperty>(parameters: Parameters.CreateSpacePropertyForKey, callback: Callback<T>): Promise<void>;
51
66
  /**
@@ -53,30 +68,40 @@ export declare class SpaceProperties {
53
68
  * property is passed as a path parameter, rather than in the request body.
54
69
  *
55
70
  * **[Permissions required](https://confluence.atlassian.com/x/_AozKw)**: ‘Admin’ permission for the space.
71
+ *
72
+ * @deprecated Will be removed in next major version.
56
73
  */
57
74
  createSpacePropertyForKey<T = Models.SpaceProperty>(parameters: Parameters.CreateSpacePropertyForKey, callback?: never): Promise<T>;
58
75
  /**
59
76
  * Updates a space property. Note, you cannot update the key of a space property, only the value.
60
77
  *
61
78
  * **[Permissions required](https://confluence.atlassian.com/x/_AozKw)**: ‘Admin’ permission for the space.
79
+ *
80
+ * @deprecated Will be removed in next major version.
62
81
  */
63
82
  updateSpaceProperty<T = Models.SpaceProperty>(parameters: Parameters.UpdateSpaceProperty, callback: Callback<T>): Promise<void>;
64
83
  /**
65
84
  * Updates a space property. Note, you cannot update the key of a space property, only the value.
66
85
  *
67
86
  * **[Permissions required](https://confluence.atlassian.com/x/_AozKw)**: ‘Admin’ permission for the space.
87
+ *
88
+ * @deprecated Will be removed in next major version.
68
89
  */
69
90
  updateSpaceProperty<T = Models.SpaceProperty>(parameters: Parameters.UpdateSpaceProperty, callback?: never): Promise<T>;
70
91
  /**
71
92
  * Deletes a space property.
72
93
  *
73
94
  * **[Permissions required](https://confluence.atlassian.com/x/_AozKw)**: ‘Admin’ permission for the space.
95
+ *
96
+ * @deprecated Will be removed in next major version.
74
97
  */
75
98
  deleteSpaceProperty<T = void>(parameters: Parameters.DeleteSpaceProperty, callback: Callback<T>): Promise<void>;
76
99
  /**
77
100
  * Deletes a space property.
78
101
  *
79
102
  * **[Permissions required](https://confluence.atlassian.com/x/_AozKw)**: ‘Admin’ permission for the space.
103
+ *
104
+ * @deprecated Will be removed in next major version.
80
105
  */
81
106
  deleteSpaceProperty<T = void>(parameters: Parameters.DeleteSpaceProperty, callback?: never): Promise<T>;
82
107
  }
@@ -1,7 +1,7 @@
1
1
  import type * as Models from "./models/index.js";
2
2
  import type * as Parameters from "./parameters/index.js";
3
- import type { Callback } from "../callback.js";
4
3
  import type { Client } from "../clients/index.js";
4
+ import type { Callback } from "../callback.js";
5
5
  export declare class SpaceSettings {
6
6
  private client;
7
7
  constructor(client: Client);
@@ -1,7 +1,7 @@
1
1
  import type * as Models from "./models/index.js";
2
2
  import type * as Parameters from "./parameters/index.js";
3
- import type { Callback } from "../callback.js";
4
3
  import type { Client } from "../clients/index.js";
4
+ import type { Callback } from "../callback.js";
5
5
  export declare class Template {
6
6
  private client;
7
7
  constructor(client: Client);
@@ -1,7 +1,7 @@
1
1
  import type * as Models from "./models/index.js";
2
2
  import type * as Parameters from "./parameters/index.js";
3
- import type { Callback } from "../callback.js";
4
3
  import type { Client } from "../clients/index.js";
4
+ import type { Callback } from "../callback.js";
5
5
  export declare class Themes {
6
6
  private client;
7
7
  constructor(client: Client);