confluence.js 1.5.1 → 1.6.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 (163) hide show
  1. package/CHANGELOG.md +22 -3
  2. package/README.md +1 -0
  3. package/out/api/audit.d.ts +24 -12
  4. package/out/api/audit.js.map +1 -1
  5. package/out/api/content.d.ts +18 -12
  6. package/out/api/content.js.map +1 -1
  7. package/out/api/contentAttachments.d.ts +14 -8
  8. package/out/api/contentAttachments.js.map +1 -1
  9. package/out/api/contentBody.d.ts +52 -0
  10. package/out/api/contentBody.js +27 -3
  11. package/out/api/contentBody.js.map +1 -1
  12. package/out/api/contentChildrenAndDescendants.js +2 -1
  13. package/out/api/contentChildrenAndDescendants.js.map +1 -1
  14. package/out/api/contentContentState.d.ts +30 -28
  15. package/out/api/contentContentState.js +2 -0
  16. package/out/api/contentContentState.js.map +1 -1
  17. package/out/api/contentMacroBody.d.ts +72 -2
  18. package/out/api/contentMacroBody.js +29 -0
  19. package/out/api/contentMacroBody.js.map +1 -1
  20. package/out/api/contentRestrictions.d.ts +16 -8
  21. package/out/api/contentRestrictions.js.map +1 -1
  22. package/out/api/contentStates.d.ts +120 -0
  23. package/out/api/contentStates.js +88 -0
  24. package/out/api/contentStates.js.map +1 -0
  25. package/out/api/contentWatches.d.ts +16 -8
  26. package/out/api/contentWatches.js.map +1 -1
  27. package/out/api/dynamicModules.js +1 -0
  28. package/out/api/dynamicModules.js.map +1 -1
  29. package/out/api/experimental.d.ts +2 -2
  30. package/out/api/index.d.ts +1 -0
  31. package/out/api/index.js +1 -0
  32. package/out/api/index.js.map +1 -1
  33. package/out/api/models/asyncContentBody.d.ts +30 -0
  34. package/out/api/models/asyncContentBody.js +3 -0
  35. package/out/api/models/asyncContentBody.js.map +1 -0
  36. package/out/api/models/asyncId.d.ts +3 -0
  37. package/out/api/models/asyncId.js +3 -0
  38. package/out/api/models/asyncId.js.map +1 -0
  39. package/out/api/models/contentBodyCreate.d.ts +1 -0
  40. package/out/api/models/contentStateResponse.d.ts +7 -0
  41. package/out/api/models/contentStateResponse.js +3 -0
  42. package/out/api/models/contentStateResponse.js.map +1 -0
  43. package/out/api/models/contentStateRestInput.d.ts +11 -0
  44. package/out/api/models/contentStateRestInput.js +3 -0
  45. package/out/api/models/contentStateRestInput.js.map +1 -0
  46. package/out/api/models/index.d.ts +16 -12
  47. package/out/api/models/index.js +16 -12
  48. package/out/api/models/index.js.map +1 -1
  49. package/out/api/parameters/asyncConvertContentBodyRequest.d.ts +38 -0
  50. package/out/api/parameters/asyncConvertContentBodyRequest.js +3 -0
  51. package/out/api/parameters/asyncConvertContentBodyRequest.js.map +1 -0
  52. package/out/api/parameters/asyncConvertContentBodyResponse.d.ts +4 -0
  53. package/out/api/parameters/asyncConvertContentBodyResponse.js +3 -0
  54. package/out/api/parameters/asyncConvertContentBodyResponse.js.map +1 -0
  55. package/out/api/parameters/convertContentBody.d.ts +16 -2
  56. package/out/api/parameters/getAndAsyncConvertMacroBodyByMacroId.d.ts +46 -0
  57. package/out/api/parameters/getAndAsyncConvertMacroBodyByMacroId.js +3 -0
  58. package/out/api/parameters/getAndAsyncConvertMacroBodyByMacroId.js.map +1 -0
  59. package/out/api/parameters/getAndConvertMacroBodyByMacroId.d.ts +34 -0
  60. package/out/api/parameters/getAndConvertMacroBodyByMacroId.js +3 -0
  61. package/out/api/parameters/getAndConvertMacroBodyByMacroId.js.map +1 -0
  62. package/out/api/parameters/getAvailableContentStates.d.ts +4 -2
  63. package/out/api/parameters/getContentState.d.ts +8 -4
  64. package/out/api/parameters/getSpaceContentStates.d.ts +4 -0
  65. package/out/api/parameters/getSpaceContentStates.js +3 -0
  66. package/out/api/parameters/getSpaceContentStates.js.map +1 -0
  67. package/out/api/parameters/getUser.d.ts +6 -4
  68. package/out/api/parameters/index.d.ts +5 -0
  69. package/out/api/parameters/index.js +5 -0
  70. package/out/api/parameters/index.js.map +1 -1
  71. package/out/api/parameters/movePage.d.ts +9 -5
  72. package/out/api/parameters/removeContentState.d.ts +5 -1
  73. package/out/api/parameters/setContentState.d.ts +11 -5
  74. package/out/api/relation.d.ts +8 -4
  75. package/out/api/relation.js.map +1 -1
  76. package/out/api/settings.d.ts +6 -4
  77. package/out/api/settings.js.map +1 -1
  78. package/out/api/space.d.ts +6 -4
  79. package/out/api/space.js.map +1 -1
  80. package/out/api/spaceProperties.d.ts +4 -4
  81. package/out/api/template.d.ts +16 -8
  82. package/out/api/template.js.map +1 -1
  83. package/out/clients/baseClient.js +3 -1
  84. package/out/clients/baseClient.js.map +1 -1
  85. package/out/clients/confluenceClient.d.ts +2 -1
  86. package/out/clients/confluenceClient.js +1 -0
  87. package/out/clients/confluenceClient.js.map +1 -1
  88. package/out/clients/serverClient.js.map +1 -1
  89. package/out/server/audit.js +6 -6
  90. package/out/server/audit.js.map +1 -1
  91. package/out/server/content.d.ts +34 -262
  92. package/out/server/content.js +40 -32
  93. package/out/server/content.js.map +1 -1
  94. package/out/server/contentBody.d.ts +2 -12
  95. package/out/server/contentBody.js +2 -1
  96. package/out/server/contentBody.js.map +1 -1
  97. package/out/server/group.js +3 -3
  98. package/out/server/group.js.map +1 -1
  99. package/out/server/longTask.js +2 -2
  100. package/out/server/longTask.js.map +1 -1
  101. package/out/server/parameters/convertContentBody.d.ts +16 -0
  102. package/out/server/parameters/updateAttachmentData.d.ts +8 -2
  103. package/out/server/search.d.ts +2 -22
  104. package/out/server/search.js +1 -1
  105. package/out/server/search.js.map +1 -1
  106. package/out/server/space.d.ts +12 -94
  107. package/out/server/space.js +14 -14
  108. package/out/server/space.js.map +1 -1
  109. package/out/server/user.d.ts +8 -152
  110. package/out/server/user.js +10 -10
  111. package/out/server/user.js.map +1 -1
  112. package/package.json +10 -10
  113. package/src/api/audit.ts +24 -12
  114. package/src/api/content.ts +23 -17
  115. package/src/api/contentAttachments.ts +19 -13
  116. package/src/api/contentBody.ts +102 -0
  117. package/src/api/contentChildrenAndDescendants.ts +3 -1
  118. package/src/api/contentContentState.ts +30 -28
  119. package/src/api/contentMacroBody.ts +119 -2
  120. package/src/api/contentRestrictions.ts +16 -8
  121. package/src/api/contentStates.ts +252 -0
  122. package/src/api/contentWatches.ts +16 -8
  123. package/src/api/dynamicModules.ts +1 -0
  124. package/src/api/experimental.ts +2 -2
  125. package/src/api/index.ts +1 -0
  126. package/src/api/models/asyncContentBody.ts +31 -0
  127. package/src/api/models/asyncId.ts +3 -0
  128. package/src/api/models/contentBodyCreate.ts +1 -0
  129. package/src/api/models/contentStateResponse.ts +8 -0
  130. package/src/api/models/contentStateRestInput.ts +11 -0
  131. package/src/api/models/index.ts +16 -12
  132. package/src/api/parameters/asyncConvertContentBodyRequest.ts +81 -0
  133. package/src/api/parameters/asyncConvertContentBodyResponse.ts +4 -0
  134. package/src/api/parameters/convertContentBody.ts +39 -2
  135. package/src/api/parameters/getAndAsyncConvertMacroBodyByMacroId.ts +88 -0
  136. package/src/api/parameters/getAndConvertMacroBodyByMacroId.ts +104 -0
  137. package/src/api/parameters/getAvailableContentStates.ts +5 -2
  138. package/src/api/parameters/getContentState.ts +9 -4
  139. package/src/api/parameters/getSpaceContentStates.ts +4 -0
  140. package/src/api/parameters/getUser.ts +14 -4
  141. package/src/api/parameters/index.ts +5 -0
  142. package/src/api/parameters/movePage.ts +9 -5
  143. package/src/api/parameters/removeContentState.ts +6 -1
  144. package/src/api/parameters/setContentState.ts +13 -5
  145. package/src/api/relation.ts +8 -4
  146. package/src/api/settings.ts +6 -4
  147. package/src/api/space.ts +7 -5
  148. package/src/api/spaceProperties.ts +4 -4
  149. package/src/api/template.ts +16 -8
  150. package/src/clients/baseClient.ts +5 -10
  151. package/src/clients/client.ts +1 -5
  152. package/src/clients/confluenceClient.ts +2 -0
  153. package/src/clients/serverClient.ts +1 -10
  154. package/src/server/audit.ts +6 -6
  155. package/src/server/content.ts +78 -295
  156. package/src/server/contentBody.ts +4 -13
  157. package/src/server/group.ts +3 -3
  158. package/src/server/longTask.ts +2 -2
  159. package/src/server/parameters/convertContentBody.ts +37 -0
  160. package/src/server/parameters/updateAttachmentData.ts +7 -3
  161. package/src/server/search.ts +3 -23
  162. package/src/server/space.ts +26 -108
  163. package/src/server/user.ts +18 -162
@@ -4,14 +4,17 @@ export * from './accountIdEmailRecordArray';
4
4
  export * from './addContentRestriction';
5
5
  export * from './addContentRestrictionUpdateArray';
6
6
  export * from './affectedObject';
7
+ export * from './appDescriptor';
8
+ export * from './asyncContentBody';
9
+ export * from './asyncId';
10
+ export * from './attachment';
7
11
  export * from './attachmentContainer';
12
+ export * from './attachmentMetadata';
8
13
  export * from './attachmentUpdate';
9
14
  export * from './auditRecord';
10
15
  export * from './auditRecordArray';
11
16
  export * from './auditRecordCreate';
12
- export * from './appDescriptor';
13
- export * from './attachment';
14
- export * from './attachmentMetadata';
17
+ export * from './availableContentStates';
15
18
  export * from './blueprintTemplate';
16
19
  export * from './blueprintTemplateArray';
17
20
  export * from './breadcrumb';
@@ -51,6 +54,11 @@ export * from './contentRestriction';
51
54
  export * from './contentRestrictionArray';
52
55
  export * from './contentRestrictionUpdate';
53
56
  export * from './contentRestrictionUpdateArray';
57
+ export * from './contentState';
58
+ export * from './contentStateContainer';
59
+ export * from './contentStateResponse';
60
+ export * from './contentStateRestInput';
61
+ export * from './contentStateSettings';
54
62
  export * from './contentTemplate';
55
63
  export * from './contentTemplateArray';
56
64
  export * from './contentTemplateBodyCreate';
@@ -87,16 +95,9 @@ export * from './labelCreateArray';
87
95
  export * from './labelDetails';
88
96
  export * from './labeledContent';
89
97
  export * from './labeledContentPageResponse';
90
- export * from './contentStateSettings';
91
98
  export * from './labeledContentType';
99
+ export * from './lifecycle';
92
100
  export * from './longTask';
93
- export * from './contentState';
94
- export * from './userPropertyCreate';
95
- export * from './userPropertyUpdate';
96
- export * from './contentStateContainer';
97
- export * from './availableContentStates';
98
- export * from './userPropertyKeyArray';
99
- export * from './userProperty';
100
101
  export * from './longTaskStatus';
101
102
  export * from './longTaskStatusArray';
102
103
  export * from './longTaskStatusWithLinks';
@@ -106,7 +107,6 @@ export * from './lookAndFeelSettings';
106
107
  export * from './lookAndFeelUpdated';
107
108
  export * from './macroInstance';
108
109
  export * from './menusLookAndFeel';
109
- export * from './lifecycle';
110
110
  export * from './message';
111
111
  export * from './migratedUser';
112
112
  export * from './migratedUserArray';
@@ -162,6 +162,10 @@ export * from './userAnonymous';
162
162
  export * from './userArray';
163
163
  export * from './userArrayWithLinks';
164
164
  export * from './userDetails';
165
+ export * from './userProperty';
166
+ export * from './userPropertyCreate';
167
+ export * from './userPropertyKeyArray';
168
+ export * from './userPropertyUpdate';
165
169
  export * from './usersUserKeys';
166
170
  export * from './userWatch';
167
171
  export * from './version';
@@ -0,0 +1,81 @@
1
+ import { ContentBodyCreate } from '../models';
2
+
3
+ export interface AsyncConvertContentBodyRequest extends ContentBodyCreate {
4
+ /** The name of the target format for the content body. */
5
+ to: string;
6
+ /**
7
+ * The space key used for resolving embedded content (page includes, files, and links) in the content body. For
8
+ * example, if the source content contains the link `<ac:link><ri:page ri:content-title="Example page" /><ac:link>`
9
+ * and the `spaceKeyContext=TEST` parameter is provided, then the link will be converted to a link to the "Example
10
+ * page" page in the "TEST" space.
11
+ */
12
+ spaceKeyContext?: string;
13
+ /**
14
+ * The content ID used to find the space for resolving embedded content (page includes, files, and links) in the
15
+ * content body. For example, if the source content contains the link `<ac:link><ri:page ri:content-title="Example
16
+ * page" /><ac:link>` and the `contentIdContext=123` parameter is provided, then the link will be converted to a link
17
+ * to the "Example page" page in the same space that has the content with ID=123. Note, `spaceKeyContext` will be
18
+ * ignored if this parameter is provided.
19
+ */
20
+ contentIdContext?: string;
21
+ /**
22
+ * If this field is false, the cache will erase its current value and begin a new conversion. If this field is true,
23
+ * the cache will not erase its current value, and will set the status of the async conversion to RERUNNING. Once the
24
+ * data is updated, the status will change to COMPLETED. Large macros that take long to convert, and whose data need
25
+ * not immediately up to date (same as previous conversion's result within last 5 minutes) should set this fields to
26
+ * true. Cache values are stored per user per content body and expansions.
27
+ */
28
+ allowCache?: boolean;
29
+ /**
30
+ * Mode used for rendering embedded content, like attachments.
31
+ *
32
+ * - `current` renders the embedded content using the latest version.
33
+ * - `version-at-save` renders the embedded content using the version at
34
+ * the time of save.
35
+ */
36
+ embeddedContentRender?: string;
37
+ /** A multi-value parameter indicating which properties of the content to expand and populate. */
38
+ expand?:
39
+ | 'embeddedContent'
40
+ | 'mediaToken'
41
+ | 'webresource.superbatch.metatags'
42
+ | 'webresource.superbatch.tags.all'
43
+ | 'webresource.superbatch.tags.css'
44
+ | 'webresource.superbatch.tags.data'
45
+ | 'webresource.superbatch.tags.js'
46
+ | 'webresource.superbatch.uris.all'
47
+ | 'webresource.superbatch.uris.css'
48
+ | 'webresource.superbatch.uris.data'
49
+ | 'webresource.superbatch.uris.js'
50
+ | 'webresource.tags.all'
51
+ | 'webresource.tags.css'
52
+ | 'webresource.tags.data'
53
+ | 'webresource.tags.js'
54
+ | 'webresource.uris.all'
55
+ | 'webresource.uris.css'
56
+ | 'webresource.uris.data'
57
+ | 'webresource.uris.js'
58
+ | (
59
+ | 'embeddedContent'
60
+ | 'mediaToken'
61
+ | 'webresource.superbatch.metatags'
62
+ | 'webresource.superbatch.tags.all'
63
+ | 'webresource.superbatch.tags.css'
64
+ | 'webresource.superbatch.tags.data'
65
+ | 'webresource.superbatch.tags.js'
66
+ | 'webresource.superbatch.uris.all'
67
+ | 'webresource.superbatch.uris.css'
68
+ | 'webresource.superbatch.uris.data'
69
+ | 'webresource.superbatch.uris.js'
70
+ | 'webresource.tags.all'
71
+ | 'webresource.tags.css'
72
+ | 'webresource.tags.data'
73
+ | 'webresource.tags.js'
74
+ | 'webresource.uris.all'
75
+ | 'webresource.uris.css'
76
+ | 'webresource.uris.data'
77
+ | 'webresource.uris.js'
78
+ )[]
79
+ | string
80
+ | string[];
81
+ }
@@ -0,0 +1,4 @@
1
+ export interface AsyncConvertContentBodyResponse {
2
+ /** The asyncId of the macro task to get the converted body. */
3
+ id: string;
4
+ }
@@ -3,8 +3,43 @@ import { ContentBodyCreate } from '../models';
3
3
  export interface ConvertContentBody extends ContentBodyCreate {
4
4
  /** The name of the target format for the content body. */
5
5
  to: string;
6
- /** A multi-value parameter indicating which properties of the content to expand. */
7
- expand?: string[];
6
+
7
+ /**
8
+ * A multi-value parameter indicating which properties of the content to expand. Expands are dependent on the to
9
+ * conversion format and may be irrelevant for certain conversions (e.g. macroRenderedOutput is redundant when
10
+ * converting to view format).
11
+ *
12
+ * - `webresource` returns JS and CSS resources necessary for displaying nested content in `view` format
13
+ * - `webresource.superbatch.uris.js` returns all common JS dependencies
14
+ * - `webresource.superbatch.uris.css` returns all common CSS dependencies
15
+ * - `webresource.uris.js` returns JS dependencies specific to conversion
16
+ * - `webresource.uris.css` returns CSS dependencies specific to conversion
17
+ * - `embeddedContent` returns metadata for nested content (e.g. page included using page include macro)
18
+ * - `mediaToken` returns JWT token for retrieving attachment data from Media API
19
+ * - `macroRenderedOutput` additionally converts body to view format
20
+ */
21
+ expand?:
22
+ | 'webresource'
23
+ | 'webresource.superbatch.uris.js'
24
+ | 'webresource.superbatch.uris.css'
25
+ | 'webresource.uris.js'
26
+ | 'webresource.uris.css'
27
+ | 'embeddedContent'
28
+ | 'mediaToken'
29
+ | 'macroRenderedOutput'
30
+ | (
31
+ | 'webresource'
32
+ | 'webresource.superbatch.uris.js'
33
+ | 'webresource.superbatch.uris.css'
34
+ | 'webresource.uris.js'
35
+ | 'webresource.uris.css'
36
+ | 'embeddedContent'
37
+ | 'mediaToken'
38
+ | 'macroRenderedOutput'
39
+ )[]
40
+ | string
41
+ | string[];
42
+
8
43
  /**
9
44
  * The space key used for resolving embedded content (page includes, files, and links) in the content body. For
10
45
  * example, if the source content contains the link `<ac:link><ri:page ri:content-title="Example page" /><ac:link>`
@@ -27,4 +62,6 @@ export interface ConvertContentBody extends ContentBodyCreate {
27
62
  * - `version-at-save` renders the embedded content using the version at the time of save.
28
63
  */
29
64
  embeddedContentRender?: string;
65
+
66
+ additionalProperties?: any[];
30
67
  }
@@ -0,0 +1,88 @@
1
+ export interface GetAndAsyncConvertMacroBodyByMacroId {
2
+ /** The ID for the content that contains the macro. */
3
+ id: string;
4
+ /**
5
+ * The version of the content that contains the macro. Specifying `0` as the `version` will return the macro body for
6
+ * the latest content version.
7
+ */
8
+ version: number;
9
+ /**
10
+ * The ID of the macro. For apps, this is passed to the macro by the Connect/Forge framework. Otherwise, find the
11
+ * macro ID by querying the desired content and version, then expanding the body in storage format. For example,
12
+ * '/content/196611/version/7?expand=content.body.storage'.
13
+ */
14
+ macroId: string;
15
+ /**
16
+ * The content representation to return the macro in. Currently, the following conversions are allowed:
17
+ *
18
+ * -`export_view` - `styled_view` - `view`;
19
+ */
20
+ to: string;
21
+ /**
22
+ * If this field is false, the cache will erase its current value and begin a conversion. If this field is true, the
23
+ * cache will not erase its current value, and will set the status of the result in cache to RERUNNING. Once the data
24
+ * is updated, the status will change to COMPLETED. Large macros that take long to convert, and who want to show
25
+ * intermediate, but potentially stale data, immediately should set this field to true. Cache values are stored per
26
+ * macro per user per content and expansions.
27
+ */
28
+ allowCache?: boolean;
29
+ /**
30
+ * The space key used for resolving embedded content (page includes, files, and links) in the content body. For
31
+ * example, if the source content contains the link `<ac:link><ri:page ri:content-title="Example page" /><ac:link>`
32
+ * and the `spaceKeyContext=TEST` parameter is provided, then the link will be converted to a link to the "Example
33
+ * page" page in the "TEST" space.
34
+ */
35
+ spaceKeyContext?: string;
36
+ /**
37
+ * Mode used for rendering embedded content, like attachments.
38
+ *
39
+ * - `current` renders the embedded content using the latest version.
40
+ * - `version-at-save` renders the embedded content using the version at
41
+ * the time of save.
42
+ */
43
+ embeddedContentRender?: string;
44
+ /** A multi-value parameter indicating which properties of the content to expand and populate. */
45
+ expand?:
46
+ | 'embeddedContent'
47
+ | 'mediaToken'
48
+ | 'webresource.superbatch.metatags'
49
+ | 'webresource.superbatch.tags.all'
50
+ | 'webresource.superbatch.tags.css'
51
+ | 'webresource.superbatch.tags.data'
52
+ | 'webresource.superbatch.tags.js'
53
+ | 'webresource.superbatch.uris.all'
54
+ | 'webresource.superbatch.uris.css'
55
+ | 'webresource.superbatch.uris.data'
56
+ | 'webresource.superbatch.uris.js'
57
+ | 'webresource.tags.all'
58
+ | 'webresource.tags.css'
59
+ | 'webresource.tags.data'
60
+ | 'webresource.tags.js'
61
+ | 'webresource.uris.all'
62
+ | 'webresource.uris.css'
63
+ | 'webresource.uris.data'
64
+ | 'webresource.uris.js'
65
+ | (
66
+ | 'embeddedContent'
67
+ | 'mediaToken'
68
+ | 'webresource.superbatch.metatags'
69
+ | 'webresource.superbatch.tags.all'
70
+ | 'webresource.superbatch.tags.css'
71
+ | 'webresource.superbatch.tags.data'
72
+ | 'webresource.superbatch.tags.js'
73
+ | 'webresource.superbatch.uris.all'
74
+ | 'webresource.superbatch.uris.css'
75
+ | 'webresource.superbatch.uris.data'
76
+ | 'webresource.superbatch.uris.js'
77
+ | 'webresource.tags.all'
78
+ | 'webresource.tags.css'
79
+ | 'webresource.tags.data'
80
+ | 'webresource.tags.js'
81
+ | 'webresource.uris.all'
82
+ | 'webresource.uris.css'
83
+ | 'webresource.uris.data'
84
+ | 'webresource.uris.js'
85
+ )[]
86
+ | string
87
+ | string[];
88
+ }
@@ -0,0 +1,104 @@
1
+ export interface GetAndConvertMacroBodyByMacroId {
2
+ /** The ID for the content that contains the macro. */
3
+ id: string;
4
+ /**
5
+ * The version of the content that contains the macro. Specifying `0` as the `version` will return the macro body for
6
+ * the latest content version.
7
+ */
8
+ version: number;
9
+ /**
10
+ * The ID of the macro. This is usually passed by the app that the macro is in. Otherwise, find the macro ID by
11
+ * querying the desired content and version, then expanding the body in storage format. For example,
12
+ * '/content/196611/version/7?expand=content.body.storage'.
13
+ */
14
+ macroId: string;
15
+ /** The content representation to return the macro in. */
16
+ to: string;
17
+ /**
18
+ * The space key used for resolving embedded content (page includes, files, and links) in the content body. For
19
+ * example, if the source content contains the link `<ac:link><ri:page ri:content-title="Example page" /><ac:link>`
20
+ * and the `spaceKeyContext=TEST` parameter is provided, then the link will be converted to a link to the "Example
21
+ * page" page in the "TEST" space.
22
+ */
23
+ spaceKeyContext?: string;
24
+ /**
25
+ * Mode used for rendering embedded content, like attachments.
26
+ *
27
+ * - `current` renders the embedded content using the latest version.
28
+ * - `version-at-save` renders the embedded content using the version at
29
+ * the time of save.
30
+ */
31
+ embeddedContentRender?: 'current' | 'version-at-save' | string;
32
+ /** A multi-value parameter indicating which properties of the content to expand. */
33
+ expand?:
34
+ | 'childTypes.all'
35
+ | 'childTypes.attachment'
36
+ | 'childTypes.comment'
37
+ | 'childTypes.page'
38
+ | 'container'
39
+ | 'metadata.currentuser'
40
+ | 'metadata.properties'
41
+ | 'metadata.labels'
42
+ | 'metadata.frontend'
43
+ | 'operations'
44
+ | 'children.page'
45
+ | 'children.attachment'
46
+ | 'children.comment'
47
+ | 'restrictions.read.restrictions.user'
48
+ | 'restrictions.read.restrictions.group'
49
+ | 'restrictions.update.restrictions.user'
50
+ | 'restrictions.update.restrictions.group'
51
+ | 'history'
52
+ | 'history.lastUpdated'
53
+ | 'history.previousVersion'
54
+ | 'history.contributors'
55
+ | 'history.nextVersion'
56
+ | 'ancestors'
57
+ | 'body'
58
+ | 'body.storage'
59
+ | 'body.view'
60
+ | 'version'
61
+ | 'descendants.page'
62
+ | 'descendants.attachment'
63
+ | 'descendants.comment'
64
+ | 'space'
65
+ | 'extensions.inlineProperties'
66
+ | 'extensions.resolution'
67
+ | (
68
+ | 'childTypes.all'
69
+ | 'childTypes.attachment'
70
+ | 'childTypes.comment'
71
+ | 'childTypes.page'
72
+ | 'container'
73
+ | 'metadata.currentuser'
74
+ | 'metadata.properties'
75
+ | 'metadata.labels'
76
+ | 'metadata.frontend'
77
+ | 'operations'
78
+ | 'children.page'
79
+ | 'children.attachment'
80
+ | 'children.comment'
81
+ | 'restrictions.read.restrictions.user'
82
+ | 'restrictions.read.restrictions.group'
83
+ | 'restrictions.update.restrictions.user'
84
+ | 'restrictions.update.restrictions.group'
85
+ | 'history'
86
+ | 'history.lastUpdated'
87
+ | 'history.previousVersion'
88
+ | 'history.contributors'
89
+ | 'history.nextVersion'
90
+ | 'ancestors'
91
+ | 'body'
92
+ | 'body.storage'
93
+ | 'body.view'
94
+ | 'version'
95
+ | 'descendants.page'
96
+ | 'descendants.attachment'
97
+ | 'descendants.comment'
98
+ | 'space'
99
+ | 'extensions.inlineProperties'
100
+ | 'extensions.resolution'
101
+ )[]
102
+ | string
103
+ | string[];
104
+ }
@@ -1,4 +1,7 @@
1
1
  export interface GetAvailableContentStates {
2
- /** Id of content to get available states for */
3
- contentId: string;
2
+ /**id of content to get available states for*/
3
+ id?: string;
4
+
5
+ /** @deprecated Id of content to get available states for */
6
+ contentId?: string;
4
7
  }
@@ -1,6 +1,11 @@
1
1
  export interface GetContentState {
2
- /** The Id of the page whose content state is of interest. */
3
- contentId: string;
4
- /** Set designation=DRAFT or designation=PUBLISHED. */
5
- designation?: string;
2
+ /** The id of the content whose content state is of interest. */
3
+ id?: string;
4
+ /** Set status to one of [current,draft,archived]. */
5
+ status?: 'current' | 'draft' | 'archived' | string;
6
+
7
+ /** @deprecated The Id of the page whose content state is of interest. */
8
+ contentId?: string;
9
+ /** @deprecated Set designation=DRAFT or designation=PUBLISHED. */
10
+ designation?: 'DRAFT' | 'PUBLISHED' | string;
6
11
  }
@@ -0,0 +1,4 @@
1
+ export interface GetSpaceContentStates {
2
+ /** The key of the space to be queried for its content state settings. */
3
+ spaceKey: string;
4
+ }
@@ -20,12 +20,22 @@ export interface GetUser {
20
20
  * - `operations` returns the operations that the user is allowed to do.
21
21
  * - `details.personal` returns the 'Personal' details in the user's profile, like the 'Email' and 'Phone'. Note that
22
22
  * these fields have been deprecated due to privacy changes. See the [migration
23
- * guide](https://developer.atlassian.com/cloud/confluence/deprecation-notice-user-privacy-api-migration-guide/) for details.
23
+ * guide](https://developer.atlassian.com/cloud/confluence/deprecation-notice-user-privacy-api-migration-guide/) for
24
+ * details.
24
25
  * - `details.business` returns the 'Company' details in the user's profile, like the 'Position' and 'Department'. Note
25
26
  * that these fields have been deprecated due to privacy changes. See the [migration
26
- * guide](https://developer.atlassian.com/cloud/confluence/deprecation-notice-user-privacy-api-migration-guide/) for details.
27
- * - PersonalSpace returns the user's personal space, if it exists.
27
+ * guide](https://developer.atlassian.com/cloud/confluence/deprecation-notice-user-privacy-api-migration-guide/) for
28
+ * details.
29
+ * - `personalSpace` returns the user's personal space, if it exists.
28
30
  * - `isExternalCollaborator` returns whether the user is an external collaborator user
29
31
  */
30
- expand?: string[];
32
+ expand?:
33
+ | 'operations'
34
+ | 'details.personal'
35
+ | 'details.business'
36
+ | 'personalSpace'
37
+ | 'isExternalCollaborator'
38
+ | ('operations' | 'details.personal' | 'details.business' | 'personalSpace' | 'isExternalCollaborator')[]
39
+ | string
40
+ | string[];
31
41
  }
@@ -13,6 +13,8 @@ export * from './addUserToContentRestriction';
13
13
  export * from './addUserToGroup';
14
14
  export * from './addUserToGroupByGroupId';
15
15
  export * from './archivePages';
16
+ export * from './asyncConvertContentBodyRequest';
17
+ export * from './asyncConvertContentBodyResponse';
16
18
  export * from './checkContentPermission';
17
19
  export * from './convertContentBody';
18
20
  export * from './copyPage';
@@ -48,6 +50,8 @@ export * from './exportAuditRecords';
48
50
  export * from './findSourcesForTarget';
49
51
  export * from './findTargetFromSource';
50
52
  export * from './getAllLabelContent';
53
+ export * from './getAndAsyncConvertMacroBodyByMacroId';
54
+ export * from './getAndConvertMacroBodyByMacroId';
51
55
  export * from './getAnonymousUser';
52
56
  export * from './getAttachments';
53
57
  export * from './getAuditRecords';
@@ -101,6 +105,7 @@ export * from './getRestrictions';
101
105
  export * from './getRestrictionsByOperation';
102
106
  export * from './getRestrictionsForOperation';
103
107
  export * from './getSpace';
108
+ export * from './getSpaceContentStates';
104
109
  export * from './getSpaceProperties';
105
110
  export * from './getSpaceProperty';
106
111
  export * from './getSpaces';
@@ -1,12 +1,16 @@
1
1
  export interface MovePage {
2
2
  /** The ID of the page to be moved */
3
- id: string;
3
+ pageId?: string;
4
+ /** @deprecated The ID of the page to be moved */
5
+ id?: string;
4
6
  /**
5
- * The position to move the page to relative to the target page: `before` - move the page under the same parent as the
6
- * target, before the target in the list of children `after` - move the page under the same parent as the target,
7
- * after the target in the list of children `append` - move the page to be a child of the target
7
+ * The position to move the page to relative to the target page:
8
+ *
9
+ * - `before` - move the page under the same parent as the target, before the target in the list of children
10
+ * - `after` - move the page under the same parent as the target, after the target in the list of children
11
+ * - `append` - move the page to be a child of the target
8
12
  */
9
- position: string;
13
+ position: 'before' | 'after' | 'append' | string;
10
14
  /** The ID of the target page for this operation */
11
15
  targetId: string;
12
16
  }
@@ -1,4 +1,9 @@
1
1
  export interface RemoveContentState {
2
2
  /** The Id of the content whose content state is to be set. */
3
- contentId: string;
3
+ id?: string;
4
+ /** Status of content state from which to delete state. Can be draft or archived */
5
+ status?: string;
6
+
7
+ /** @deprecated The Id of the content whose content state is to be set. */
8
+ contentId?: string;
4
9
  }
@@ -1,8 +1,16 @@
1
- export interface SetContentState {
1
+ import { ContentStateRestInput } from '../models';
2
+
3
+ export interface SetContentState extends ContentStateRestInput {
2
4
  /** The Id of the content whose content state is to be set. */
3
- contentId: string;
4
- /** The Id of the content */
5
+ id?: string;
6
+ /**
7
+ * Status of content onto which state will be placed. If draft, then draft state will change. If current, state will
8
+ * be placed onto a new version of the content with same body as previous version.
9
+ */
10
+ status?: 'current' | 'draft' | string;
11
+
12
+ /** @deprecated The Id of the content whose content state is to be set. */
13
+ contentId?: string;
14
+ /** @deprecated The Id of the content */
5
15
  contentStateId?: number;
6
- name?: string;
7
- color?: string;
8
16
  }
@@ -8,7 +8,8 @@ export class Relation {
8
8
  constructor(private client: Client) {}
9
9
 
10
10
  /**
11
- * Returns all target entities that have a particular relationship to the source entity. Note, relationships are one way.
11
+ * Returns all target entities that have a particular relationship to the source entity. Note, relationships are one
12
+ * way.
12
13
  *
13
14
  * For example, the following method finds all content that the current user has an 'ignore' relationship with: `GET
14
15
  * https://your-domain.atlassian.net/wiki/rest/api/relation/ignore/from/user/current/to/content` Note, 'ignore' is an
@@ -22,7 +23,8 @@ export class Relation {
22
23
  callback: Callback<T>
23
24
  ): Promise<void>;
24
25
  /**
25
- * Returns all target entities that have a particular relationship to the source entity. Note, relationships are one way.
26
+ * Returns all target entities that have a particular relationship to the source entity. Note, relationships are one
27
+ * way.
26
28
  *
27
29
  * For example, the following method finds all content that the current user has an 'ignore' relationship with: `GET
28
30
  * https://your-domain.atlassian.net/wiki/rest/api/relation/ignore/from/user/current/to/content` Note, 'ignore' is an
@@ -205,7 +207,8 @@ export class Relation {
205
207
  }
206
208
 
207
209
  /**
208
- * Returns all target entities that have a particular relationship to the source entity. Note, relationships are one way.
210
+ * Returns all target entities that have a particular relationship to the source entity. Note, relationships are one
211
+ * way.
209
212
  *
210
213
  * For example, the following method finds all users that have a 'collaborator' relationship to a piece of content
211
214
  * with an ID of '1234': `GET
@@ -220,7 +223,8 @@ export class Relation {
220
223
  callback: Callback<T>
221
224
  ): Promise<void>;
222
225
  /**
223
- * Returns all target entities that have a particular relationship to the source entity. Note, relationships are one way.
226
+ * Returns all target entities that have a particular relationship to the source entity. Note, relationships are one
227
+ * way.
224
228
  *
225
229
  * For example, the following method finds all users that have a 'collaborator' relationship to a piece of content
226
230
  * with an ID of '1234': `GET
@@ -11,7 +11,8 @@ export class Settings {
11
11
  * Returns the look and feel settings for the site or a single space. This includes attributes such as the color
12
12
  * scheme, padding, and border radius.
13
13
  *
14
- * The look and feel settings for a space can be inherited from the global look and feel settings or provided by a theme.
14
+ * The look and feel settings for a space can be inherited from the global look and feel settings or provided by a
15
+ * theme.
15
16
  *
16
17
  * **[Permissions](https://confluence.atlassian.com/x/_AozKw) required**: None
17
18
  */
@@ -23,7 +24,8 @@ export class Settings {
23
24
  * Returns the look and feel settings for the site or a single space. This includes attributes such as the color
24
25
  * scheme, padding, and border radius.
25
26
  *
26
- * The look and feel settings for a space can be inherited from the global look and feel settings or provided by a theme.
27
+ * The look and feel settings for a space can be inherited from the global look and feel settings or provided by a
28
+ * theme.
27
29
  *
28
30
  * **[Permissions](https://confluence.atlassian.com/x/_AozKw) required**: None
29
31
  */
@@ -231,12 +233,12 @@ export class Settings {
231
233
  return this.client.sendRequest(config, callback);
232
234
  }
233
235
 
234
- /** Gets Content State settings for a space */
236
+ /** @deprecated Gets Content State settings for a space */
235
237
  async getContentStateSettings<T = Models.ContentStateSettings>(
236
238
  parameters: Parameters.GetContentStateSettings,
237
239
  callback: Callback<T>
238
240
  ): Promise<void>;
239
- /** Gets Content State settings for a space */
241
+ /** @deprecated Gets Content State settings for a space */
240
242
  async getContentStateSettings<T = Models.ContentStateSettings>(
241
243
  parameters: Parameters.GetContentStateSettings,
242
244
  callback?: never
package/src/api/space.ts CHANGED
@@ -115,13 +115,15 @@ export class Space {
115
115
  }
116
116
 
117
117
  /**
118
- * Returns a space. This includes information like the name, description, and permissions, but not the content in the space.
118
+ * Returns a space. This includes information like the name, description, and permissions, but not the content in the
119
+ * space.
119
120
  *
120
121
  * **[Permissions](https://confluence.atlassian.com/x/_AozKw) required**: 'View' permission for the space.
121
122
  */
122
123
  async getSpace<T = Models.Space>(parameters: Parameters.GetSpace, callback: Callback<T>): Promise<void>;
123
124
  /**
124
- * Returns a space. This includes information like the name, description, and permissions, but not the content in the space.
125
+ * Returns a space. This includes information like the name, description, and permissions, but not the content in the
126
+ * space.
125
127
  *
126
128
  * **[Permissions](https://confluence.atlassian.com/x/_AozKw) required**: 'View' permission for the space.
127
129
  */
@@ -179,7 +181,7 @@ export class Space {
179
181
  *
180
182
  * **[Permissions](https://confluence.atlassian.com/x/_AozKw) required**: 'Admin' permission for the space.
181
183
  */
182
- async deleteSpace<T = Models.DeletedSpace>(parameters: Parameters.DeleteSpace, callback: Callback<T>): Promise<void>;
184
+ async deleteSpace<T = Models.LongTask>(parameters: Parameters.DeleteSpace, callback: Callback<T>): Promise<void>;
183
185
  /**
184
186
  * Deletes a space. Note, the space will be deleted in a long running task. Therefore, the space may not be deleted
185
187
  * yet when this method has returned. Clients should poll the status link that is returned in the response until the
@@ -187,8 +189,8 @@ export class Space {
187
189
  *
188
190
  * **[Permissions](https://confluence.atlassian.com/x/_AozKw) required**: 'Admin' permission for the space.
189
191
  */
190
- async deleteSpace<T = Models.DeletedSpace>(parameters: Parameters.DeleteSpace, callback?: never): Promise<T>;
191
- async deleteSpace<T = Models.DeletedSpace>(
192
+ async deleteSpace<T = Models.LongTask>(parameters: Parameters.DeleteSpace, callback?: never): Promise<T>;
193
+ async deleteSpace<T = Models.LongTask>(
192
194
  parameters: Parameters.DeleteSpace,
193
195
  callback?: Callback<T>,
194
196
  ): Promise<void | T> {