@resolution/confluence-api-client 0.4.4 → 0.4.6

This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
Files changed (183) hide show
  1. package/CHANGELOG.md +22 -0
  2. package/README.md +60 -1
  3. package/lib/openapi/v1/BaseConfluenceApiV1Client.d.ts +32 -33
  4. package/lib/openapi/v1/BaseConfluenceApiV1Client.js +151 -88
  5. package/lib/openapi/v1/BaseConfluenceApiV1Client.js.map +1 -1
  6. package/lib/openapi/v1/core/CommonHttpService.d.ts +2 -0
  7. package/lib/openapi/v1/core/CommonHttpService.js +9 -0
  8. package/lib/openapi/v1/core/CommonHttpService.js.map +1 -1
  9. package/lib/openapi/v1/services/AnalyticsService.d.ts +10 -10
  10. package/lib/openapi/v1/services/AnalyticsService.js +62 -59
  11. package/lib/openapi/v1/services/AnalyticsService.js.map +1 -1
  12. package/lib/openapi/v1/services/AuditService.d.ts +25 -25
  13. package/lib/openapi/v1/services/AuditService.js +205 -202
  14. package/lib/openapi/v1/services/AuditService.js.map +1 -1
  15. package/lib/openapi/v1/services/ContentAttachmentsService.d.ts +20 -20
  16. package/lib/openapi/v1/services/ContentAttachmentsService.js +317 -314
  17. package/lib/openapi/v1/services/ContentAttachmentsService.js.map +1 -1
  18. package/lib/openapi/v1/services/ContentBodyService.d.ts +15 -15
  19. package/lib/openapi/v1/services/ContentBodyService.js +140 -137
  20. package/lib/openapi/v1/services/ContentBodyService.js.map +1 -1
  21. package/lib/openapi/v1/services/ContentChildrenAndDescendantsService.d.ts +27 -27
  22. package/lib/openapi/v1/services/ContentChildrenAndDescendantsService.js +391 -388
  23. package/lib/openapi/v1/services/ContentChildrenAndDescendantsService.js.map +1 -1
  24. package/lib/openapi/v1/services/ContentCommentsService.d.ts +8 -8
  25. package/lib/openapi/v1/services/ContentCommentsService.js +49 -46
  26. package/lib/openapi/v1/services/ContentCommentsService.js.map +1 -1
  27. package/lib/openapi/v1/services/ContentLabelsService.d.ts +11 -11
  28. package/lib/openapi/v1/services/ContentLabelsService.js +150 -147
  29. package/lib/openapi/v1/services/ContentLabelsService.js.map +1 -1
  30. package/lib/openapi/v1/services/ContentMacroBodyService.d.ts +13 -13
  31. package/lib/openapi/v1/services/ContentMacroBodyService.js +155 -152
  32. package/lib/openapi/v1/services/ContentMacroBodyService.js.map +1 -1
  33. package/lib/openapi/v1/services/ContentPermissionsService.d.ts +2 -2
  34. package/lib/openapi/v1/services/ContentPermissionsService.js +48 -45
  35. package/lib/openapi/v1/services/ContentPermissionsService.js.map +1 -1
  36. package/lib/openapi/v1/services/ContentPropertiesService.d.ts +18 -18
  37. package/lib/openapi/v1/services/ContentPropertiesService.js +237 -234
  38. package/lib/openapi/v1/services/ContentPropertiesService.js.map +1 -1
  39. package/lib/openapi/v1/services/ContentRestrictionsService.d.ts +49 -49
  40. package/lib/openapi/v1/services/ContentRestrictionsService.js +505 -502
  41. package/lib/openapi/v1/services/ContentRestrictionsService.js.map +1 -1
  42. package/lib/openapi/v1/services/ContentService.d.ts +50 -50
  43. package/lib/openapi/v1/services/ContentService.js +475 -472
  44. package/lib/openapi/v1/services/ContentService.js.map +1 -1
  45. package/lib/openapi/v1/services/ContentStatesService.d.ts +25 -25
  46. package/lib/openapi/v1/services/ContentStatesService.js +359 -356
  47. package/lib/openapi/v1/services/ContentStatesService.js.map +1 -1
  48. package/lib/openapi/v1/services/ContentVersionsService.d.ts +13 -13
  49. package/lib/openapi/v1/services/ContentVersionsService.js +144 -141
  50. package/lib/openapi/v1/services/ContentVersionsService.js.map +1 -1
  51. package/lib/openapi/v1/services/ContentWatchesService.d.ts +57 -57
  52. package/lib/openapi/v1/services/ContentWatchesService.js +454 -451
  53. package/lib/openapi/v1/services/ContentWatchesService.js.map +1 -1
  54. package/lib/openapi/v1/services/DynamicModulesService.d.ts +5 -5
  55. package/lib/openapi/v1/services/DynamicModulesService.js +70 -67
  56. package/lib/openapi/v1/services/DynamicModulesService.js.map +1 -1
  57. package/lib/openapi/v1/services/ExperimentalService.d.ts +12 -12
  58. package/lib/openapi/v1/services/ExperimentalService.js +151 -148
  59. package/lib/openapi/v1/services/ExperimentalService.js.map +1 -1
  60. package/lib/openapi/v1/services/GroupService.d.ts +52 -52
  61. package/lib/openapi/v1/services/GroupService.js +445 -442
  62. package/lib/openapi/v1/services/GroupService.js.map +1 -1
  63. package/lib/openapi/v1/services/InlineTasksService.d.ts +20 -20
  64. package/lib/openapi/v1/services/InlineTasksService.js +118 -115
  65. package/lib/openapi/v1/services/InlineTasksService.js.map +1 -1
  66. package/lib/openapi/v1/services/LabelInfoService.d.ts +5 -5
  67. package/lib/openapi/v1/services/LabelInfoService.js +37 -34
  68. package/lib/openapi/v1/services/LabelInfoService.js.map +1 -1
  69. package/lib/openapi/v1/services/LongRunningTaskService.d.ts +8 -6
  70. package/lib/openapi/v1/services/LongRunningTaskService.js +67 -63
  71. package/lib/openapi/v1/services/LongRunningTaskService.js.map +1 -1
  72. package/lib/openapi/v1/services/RelationService.d.ts +37 -37
  73. package/lib/openapi/v1/services/RelationService.js +231 -228
  74. package/lib/openapi/v1/services/RelationService.js.map +1 -1
  75. package/lib/openapi/v1/services/SearchService.d.ts +20 -20
  76. package/lib/openapi/v1/services/SearchService.js +136 -133
  77. package/lib/openapi/v1/services/SearchService.js.map +1 -1
  78. package/lib/openapi/v1/services/SettingsService.d.ts +15 -15
  79. package/lib/openapi/v1/services/SettingsService.js +204 -201
  80. package/lib/openapi/v1/services/SettingsService.js.map +1 -1
  81. package/lib/openapi/v1/services/SpacePermissionsService.d.ts +6 -6
  82. package/lib/openapi/v1/services/SpacePermissionsService.js +99 -96
  83. package/lib/openapi/v1/services/SpacePermissionsService.js.map +1 -1
  84. package/lib/openapi/v1/services/SpacePropertiesService.d.ts +16 -16
  85. package/lib/openapi/v1/services/SpacePropertiesService.js +227 -224
  86. package/lib/openapi/v1/services/SpacePropertiesService.js.map +1 -1
  87. package/lib/openapi/v1/services/SpaceService.d.ts +38 -38
  88. package/lib/openapi/v1/services/SpaceService.js +320 -317
  89. package/lib/openapi/v1/services/SpaceService.js.map +1 -1
  90. package/lib/openapi/v1/services/SpaceSettingsService.d.ts +4 -4
  91. package/lib/openapi/v1/services/SpaceSettingsService.js +68 -65
  92. package/lib/openapi/v1/services/SpaceSettingsService.js.map +1 -1
  93. package/lib/openapi/v1/services/TemplateService.d.ts +20 -20
  94. package/lib/openapi/v1/services/TemplateService.js +214 -211
  95. package/lib/openapi/v1/services/TemplateService.js.map +1 -1
  96. package/lib/openapi/v1/services/ThemesService.d.ts +13 -13
  97. package/lib/openapi/v1/services/ThemesService.js +179 -176
  98. package/lib/openapi/v1/services/ThemesService.js.map +1 -1
  99. package/lib/openapi/v1/services/UserPropertiesService.d.ts +12 -12
  100. package/lib/openapi/v1/services/UserPropertiesService.js +165 -162
  101. package/lib/openapi/v1/services/UserPropertiesService.js.map +1 -1
  102. package/lib/openapi/v1/services/UsersService.d.ts +21 -21
  103. package/lib/openapi/v1/services/UsersService.js +229 -226
  104. package/lib/openapi/v1/services/UsersService.js.map +1 -1
  105. package/lib/openapi/v2/BaseConfluenceApiV2Client.d.ts +23 -24
  106. package/lib/openapi/v2/BaseConfluenceApiV2Client.js +92 -47
  107. package/lib/openapi/v2/BaseConfluenceApiV2Client.js.map +1 -1
  108. package/lib/openapi/v2/core/CommonHttpService.d.ts +2 -0
  109. package/lib/openapi/v2/core/CommonHttpService.js +9 -0
  110. package/lib/openapi/v2/core/CommonHttpService.js.map +1 -1
  111. package/lib/openapi/v2/models/user.d.ts +0 -2
  112. package/lib/openapi/v2/models/user.js +0 -2
  113. package/lib/openapi/v2/models/user.js.map +1 -1
  114. package/lib/openapi/v2/services/AncestorsService.d.ts +17 -17
  115. package/lib/openapi/v2/services/AncestorsService.js +174 -171
  116. package/lib/openapi/v2/services/AncestorsService.js.map +1 -1
  117. package/lib/openapi/v2/services/AttachmentService.d.ts +62 -62
  118. package/lib/openapi/v2/services/AttachmentService.js +261 -258
  119. package/lib/openapi/v2/services/AttachmentService.js.map +1 -1
  120. package/lib/openapi/v2/services/BlogPostService.d.ts +70 -70
  121. package/lib/openapi/v2/services/BlogPostService.js +270 -267
  122. package/lib/openapi/v2/services/BlogPostService.js.map +1 -1
  123. package/lib/openapi/v2/services/ChildrenService.d.ts +14 -14
  124. package/lib/openapi/v2/services/ChildrenService.js +77 -74
  125. package/lib/openapi/v2/services/ChildrenService.js.map +1 -1
  126. package/lib/openapi/v2/services/ClassificationLevelService.d.ts +21 -21
  127. package/lib/openapi/v2/services/ClassificationLevelService.js +304 -301
  128. package/lib/openapi/v2/services/ClassificationLevelService.js.map +1 -1
  129. package/lib/openapi/v2/services/CommentService.d.ts +136 -136
  130. package/lib/openapi/v2/services/CommentService.js +635 -632
  131. package/lib/openapi/v2/services/CommentService.js.map +1 -1
  132. package/lib/openapi/v2/services/ContentPropertiesService.d.ts +128 -128
  133. package/lib/openapi/v2/services/ContentPropertiesService.js +1242 -1239
  134. package/lib/openapi/v2/services/ContentPropertiesService.js.map +1 -1
  135. package/lib/openapi/v2/services/ContentService.d.ts +2 -2
  136. package/lib/openapi/v2/services/ContentService.js +40 -37
  137. package/lib/openapi/v2/services/ContentService.js.map +1 -1
  138. package/lib/openapi/v2/services/CustomContentService.d.ts +72 -72
  139. package/lib/openapi/v2/services/CustomContentService.js +299 -296
  140. package/lib/openapi/v2/services/CustomContentService.js.map +1 -1
  141. package/lib/openapi/v2/services/DataPoliciesService.d.ts +10 -10
  142. package/lib/openapi/v2/services/DataPoliciesService.js +67 -64
  143. package/lib/openapi/v2/services/DataPoliciesService.js.map +1 -1
  144. package/lib/openapi/v2/services/DatabaseService.d.ts +17 -17
  145. package/lib/openapi/v2/services/DatabaseService.js +90 -87
  146. package/lib/openapi/v2/services/DatabaseService.js.map +1 -1
  147. package/lib/openapi/v2/services/LabelService.d.ts +57 -57
  148. package/lib/openapi/v2/services/LabelService.js +263 -260
  149. package/lib/openapi/v2/services/LabelService.js.map +1 -1
  150. package/lib/openapi/v2/services/LikeService.d.ts +36 -36
  151. package/lib/openapi/v2/services/LikeService.js +250 -247
  152. package/lib/openapi/v2/services/LikeService.js.map +1 -1
  153. package/lib/openapi/v2/services/OperationService.d.ts +20 -20
  154. package/lib/openapi/v2/services/OperationService.js +298 -295
  155. package/lib/openapi/v2/services/OperationService.js.map +1 -1
  156. package/lib/openapi/v2/services/PageService.d.ts +73 -73
  157. package/lib/openapi/v2/services/PageService.js +272 -269
  158. package/lib/openapi/v2/services/PageService.js.map +1 -1
  159. package/lib/openapi/v2/services/SmartLinkService.d.ts +19 -17
  160. package/lib/openapi/v2/services/SmartLinkService.js +92 -89
  161. package/lib/openapi/v2/services/SmartLinkService.js.map +1 -1
  162. package/lib/openapi/v2/services/SpacePermissionsService.d.ts +6 -6
  163. package/lib/openapi/v2/services/SpacePermissionsService.js +35 -32
  164. package/lib/openapi/v2/services/SpacePermissionsService.js.map +1 -1
  165. package/lib/openapi/v2/services/SpacePropertiesService.d.ts +15 -15
  166. package/lib/openapi/v2/services/SpacePropertiesService.js +165 -162
  167. package/lib/openapi/v2/services/SpacePropertiesService.js.map +1 -1
  168. package/lib/openapi/v2/services/SpaceService.d.ts +28 -28
  169. package/lib/openapi/v2/services/SpaceService.js +83 -80
  170. package/lib/openapi/v2/services/SpaceService.js.map +1 -1
  171. package/lib/openapi/v2/services/TaskService.d.ts +40 -40
  172. package/lib/openapi/v2/services/TaskService.js +120 -117
  173. package/lib/openapi/v2/services/TaskService.js.map +1 -1
  174. package/lib/openapi/v2/services/UserService.d.ts +11 -11
  175. package/lib/openapi/v2/services/UserService.js +91 -88
  176. package/lib/openapi/v2/services/UserService.js.map +1 -1
  177. package/lib/openapi/v2/services/VersionService.d.ts +59 -59
  178. package/lib/openapi/v2/services/VersionService.js +395 -392
  179. package/lib/openapi/v2/services/VersionService.js.map +1 -1
  180. package/lib/openapi/v2/services/WhiteboardService.d.ts +17 -17
  181. package/lib/openapi/v2/services/WhiteboardService.js +90 -87
  182. package/lib/openapi/v2/services/WhiteboardService.js.map +1 -1
  183. package/package.json +4 -3
@@ -11,139 +11,142 @@ const search_1 = require("../models/search");
11
11
  const validationSchemaStorage_1 = require("../validationSchemaStorage");
12
12
  /** @see https://developer.atlassian.com/cloud/confluence/rest/v1/api-group-search */
13
13
  class SearchService extends CommonHttpService_1.CommonHttpService {
14
- /**
15
- * Searches for content using the
16
- * [Confluence Query Language
17
- * (CQL)](https://developer.atlassian.com/cloud/confluence/advanced-searching-using-cql/).
18
- *
19
- * **Note that CQL input queries submitted through the `/wiki/rest/api/search`
20
- * endpoint no longer support user-specific fields like `user`, `user.fullname`,
21
- * `user.accountid`, and `user.userkey`.**
22
- * See this [deprecation
23
- * notice](https://developer.atlassian.com/cloud/confluence/deprecation-notice-search-api/)
24
- * for more details.
25
- *
26
- * Example initial call:
27
- * ```
28
- * /wiki/rest/api/search?cql=type=page&limit=25
29
- * ```
30
- *
31
- * Example response:
32
- * ```
33
- * {
34
- * "results": [
35
- * { ... },
36
- * { ... },
37
- * ...
38
- * { ... }
39
- * ],
40
- * "limit": 25,
41
- * "size": 25,
42
- * ...
43
- * "_links": {
44
- * "base": "<url>",
45
- * "context": "<url>",
46
- * "next": "/rest/api/search?cql=type=page&limit=25&cursor=raNDoMsTRiNg",
47
- * "self": "<url>"
48
- * }
49
- * }
50
- * ```
51
- *
52
- * When additional results are available, returns `next` and `prev` URLs to
53
- * retrieve them in subsequent calls. The URLs each contain a cursor that points
54
- * to the appropriate set of results. Use `limit` to specify the number of results
55
- * returned in each call.
56
- *
57
- * Example subsequent call (taken from example response):
58
- * ```
59
- * /wiki/rest/api/search?cql=type=page&limit=25&cursor=raNDoMsTRiNg
60
- * ```
61
- * The response to this will have a `prev` URL similar to the `next` in the
62
- * example response.
63
- *
64
- * Starting on Dec 10, 2024, if the expand query parameter is used with the
65
- * `body.export_view` and/or `body.styled_view` properties, then the query limit
66
- * parameter will be restricted to a maximum value of 25.
67
- *
68
- * **[Permissions](https://confluence.atlassian.com/x/_AozKw) required**:
69
- * Permission to view the entities. Note, only entities that the user has
70
- * permission to view will be returned.
71
- *
72
- * @returns Returned if the requested results are returned.
73
- * @path {GET} /wiki/rest/api/search
74
- * @scopes-current search:confluence
75
- * @scopes-beta read:content-details:confluence
76
- * @see https://developer.atlassian.com/cloud/confluence/rest/v1/api-group-search#api-wiki-rest-api-search-get
77
- */
78
- searchByCql({ cql, cqlcontext, cursor, next, prev, limit, start, includeArchivedSpaces, excludeCurrentSpaces, excerpt, sitePermissionTypeFilter, _, expand, }) {
79
- return this.getClientInstance()
80
- .request({
81
- path: "/wiki/rest/api/search",
82
- method: "GET",
83
- query: {
84
- cql,
85
- cqlcontext,
86
- cursor,
87
- next,
88
- prev,
89
- limit,
90
- start,
91
- includeArchivedSpaces,
92
- excludeCurrentSpaces,
93
- excerpt,
94
- sitePermissionTypeFilter,
95
- _,
96
- expand,
97
- },
98
- })
99
- .then(this.getClientInstance().responseHandler({
100
- 200: {
101
- "application/json": "json",
102
- },
103
- }))
104
- .then(commonHttpClient.castResponse())
105
- .then(validationSchemaStorage_1.validationSchemaStorage.validator("SearchService.searchByCQL.response"))
106
- .then(commonHttpClient.getBody);
107
- }
108
- /**
109
- * Searches for users using user-specific queries from the
110
- * [Confluence Query Language
111
- * (CQL)](https://developer.atlassian.com/cloud/confluence/advanced-searching-using-cql/).
112
- *
113
- * Note that CQL input queries submitted through the `/wiki/rest/api/search/user`
114
- * endpoint only support user-specific fields like `user`, `user.fullname`,
115
- * `user.accountid`, and `user.userkey`.
116
- *
117
- * Note that some user fields may be set to null depending on the user's privacy
118
- * settings.
119
- * These are: email, profilePicture, displayName, and timeZone.
120
- *
121
- * @returns Returned if the requested results are returned.
122
- * @path {GET} /wiki/rest/api/search/user
123
- * @scopes-current read:content-details:confluence
124
- * @see https://developer.atlassian.com/cloud/confluence/rest/v1/api-group-search#api-wiki-rest-api-search-user-get
125
- */
126
- searchUser({ cql, start, limit, expand, sitePermissionTypeFilter, }) {
127
- return this.getClientInstance()
128
- .request({
129
- path: "/wiki/rest/api/search/user",
130
- method: "GET",
131
- query: {
132
- cql,
133
- start,
134
- limit,
135
- expand,
136
- sitePermissionTypeFilter,
137
- },
138
- })
139
- .then(this.getClientInstance().responseHandler({
140
- 200: {
141
- "application/json": "json",
142
- },
143
- }))
144
- .then(commonHttpClient.castResponse())
145
- .then(validationSchemaStorage_1.validationSchemaStorage.validator("SearchService.searchUser.response"))
146
- .then(commonHttpClient.getBody);
14
+ constructor() {
15
+ super(...arguments);
16
+ /**
17
+ * Searches for content using the
18
+ * [Confluence Query Language
19
+ * (CQL)](https://developer.atlassian.com/cloud/confluence/advanced-searching-using-cql/).
20
+ *
21
+ * **Note that CQL input queries submitted through the `/wiki/rest/api/search`
22
+ * endpoint no longer support user-specific fields like `user`, `user.fullname`,
23
+ * `user.accountid`, and `user.userkey`.**
24
+ * See this [deprecation
25
+ * notice](https://developer.atlassian.com/cloud/confluence/deprecation-notice-search-api/)
26
+ * for more details.
27
+ *
28
+ * Example initial call:
29
+ * ```
30
+ * /wiki/rest/api/search?cql=type=page&limit=25
31
+ * ```
32
+ *
33
+ * Example response:
34
+ * ```
35
+ * {
36
+ * "results": [
37
+ * { ... },
38
+ * { ... },
39
+ * ...
40
+ * { ... }
41
+ * ],
42
+ * "limit": 25,
43
+ * "size": 25,
44
+ * ...
45
+ * "_links": {
46
+ * "base": "<url>",
47
+ * "context": "<url>",
48
+ * "next": "/rest/api/search?cql=type=page&limit=25&cursor=raNDoMsTRiNg",
49
+ * "self": "<url>"
50
+ * }
51
+ * }
52
+ * ```
53
+ *
54
+ * When additional results are available, returns `next` and `prev` URLs to
55
+ * retrieve them in subsequent calls. The URLs each contain a cursor that points
56
+ * to the appropriate set of results. Use `limit` to specify the number of results
57
+ * returned in each call.
58
+ *
59
+ * Example subsequent call (taken from example response):
60
+ * ```
61
+ * /wiki/rest/api/search?cql=type=page&limit=25&cursor=raNDoMsTRiNg
62
+ * ```
63
+ * The response to this will have a `prev` URL similar to the `next` in the
64
+ * example response.
65
+ *
66
+ * Starting on Dec 10, 2024, if the expand query parameter is used with the
67
+ * `body.export_view` and/or `body.styled_view` properties, then the query limit
68
+ * parameter will be restricted to a maximum value of 25.
69
+ *
70
+ * **[Permissions](https://confluence.atlassian.com/x/_AozKw) required**:
71
+ * Permission to view the entities. Note, only entities that the user has
72
+ * permission to view will be returned.
73
+ *
74
+ * @returns Returned if the requested results are returned.
75
+ * @path {GET} /wiki/rest/api/search
76
+ * @scopes-current search:confluence
77
+ * @scopes-beta read:content-details:confluence
78
+ * @see https://developer.atlassian.com/cloud/confluence/rest/v1/api-group-search#api-wiki-rest-api-search-get
79
+ */
80
+ this.searchByCql = ({ cql, cqlcontext, cursor, next, prev, limit, start, includeArchivedSpaces, excludeCurrentSpaces, excerpt, sitePermissionTypeFilter, _, expand, }) => {
81
+ return this.getClientInstance()
82
+ .request({
83
+ path: "/wiki/rest/api/search",
84
+ method: "GET",
85
+ query: {
86
+ cql,
87
+ cqlcontext,
88
+ cursor,
89
+ next,
90
+ prev,
91
+ limit,
92
+ start,
93
+ includeArchivedSpaces,
94
+ excludeCurrentSpaces,
95
+ excerpt,
96
+ sitePermissionTypeFilter,
97
+ _,
98
+ expand,
99
+ },
100
+ })
101
+ .then(this.getClientInstance().responseHandler({
102
+ 200: {
103
+ "application/json": "json",
104
+ },
105
+ }))
106
+ .then(commonHttpClient.castResponse())
107
+ .then(validationSchemaStorage_1.validationSchemaStorage.validator("SearchService.searchByCQL.response"))
108
+ .then(commonHttpClient.getBody);
109
+ };
110
+ /**
111
+ * Searches for users using user-specific queries from the
112
+ * [Confluence Query Language
113
+ * (CQL)](https://developer.atlassian.com/cloud/confluence/advanced-searching-using-cql/).
114
+ *
115
+ * Note that CQL input queries submitted through the `/wiki/rest/api/search/user`
116
+ * endpoint only support user-specific fields like `user`, `user.fullname`,
117
+ * `user.accountid`, and `user.userkey`.
118
+ *
119
+ * Note that some user fields may be set to null depending on the user's privacy
120
+ * settings.
121
+ * These are: email, profilePicture, displayName, and timeZone.
122
+ *
123
+ * @returns Returned if the requested results are returned.
124
+ * @path {GET} /wiki/rest/api/search/user
125
+ * @scopes-current read:content-details:confluence
126
+ * @see https://developer.atlassian.com/cloud/confluence/rest/v1/api-group-search#api-wiki-rest-api-search-user-get
127
+ */
128
+ this.searchUser = ({ cql, start, limit, expand, sitePermissionTypeFilter, }) => {
129
+ return this.getClientInstance()
130
+ .request({
131
+ path: "/wiki/rest/api/search/user",
132
+ method: "GET",
133
+ query: {
134
+ cql,
135
+ start,
136
+ limit,
137
+ expand,
138
+ sitePermissionTypeFilter,
139
+ },
140
+ })
141
+ .then(this.getClientInstance().responseHandler({
142
+ 200: {
143
+ "application/json": "json",
144
+ },
145
+ }))
146
+ .then(commonHttpClient.castResponse())
147
+ .then(validationSchemaStorage_1.validationSchemaStorage.validator("SearchService.searchUser.response"))
148
+ .then(commonHttpClient.getBody);
149
+ };
147
150
  }
148
151
  static initialize() {
149
152
  validationSchemaStorage_1.validationSchemaStorage.registerExtensible("SearchService.searchByCQL.response", zod_1.z
@@ -1 +1 @@
1
- {"version":3,"file":"SearchService.js","sourceRoot":"","sources":["../../../../src/openapi/v1/services/SearchService.ts"],"names":[],"mappings":";;;AAAA,eAAe;AACf,wDAAwD;AACxD,gDAAgD;AAChD,6BAAwB;AAExB,6DAA6D;AAC7D,iEAA8D;AAC9D,6CAG0B;AAC1B,wEAAqE;AACrE,qFAAqF;AACrF,MAAa,aAAc,SAAQ,qCAAiB;IAClD;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;OA+DG;IACH,WAAW,CAAC,EACV,GAAG,EACH,UAAU,EACV,MAAM,EACN,IAAI,EACJ,IAAI,EACJ,KAAK,EACL,KAAK,EACL,qBAAqB,EACrB,oBAAoB,EACpB,OAAO,EACP,wBAAwB,EACxB,CAAC,EACD,MAAM,GAuDP;QACC,OAAO,IAAI,CAAC,iBAAiB,EAAE;aAC5B,OAAO,CAAC;YACP,IAAI,EAAE,uBAAuB;YAC7B,MAAM,EAAE,KAAK;YACb,KAAK,EAAE;gBACL,GAAG;gBACH,UAAU;gBACV,MAAM;gBACN,IAAI;gBACJ,IAAI;gBACJ,KAAK;gBACL,KAAK;gBACL,qBAAqB;gBACrB,oBAAoB;gBACpB,OAAO;gBACP,wBAAwB;gBACxB,CAAC;gBACD,MAAM;aACP;SACF,CAAC;aACD,IAAI,CACH,IAAI,CAAC,iBAAiB,EAAE,CAAC,eAAe,CAAC;YACvC,GAAG,EAAE;gBACH,kBAAkB,EAAE,MAAM;aAC3B;SACF,CAAC,CACH;aACA,IAAI,CACH,gBAAgB,CAAC,YAAY,EAIzB,CACL;aACA,IAAI,CACH,iDAAuB,CAAC,SAAS,CAAC,oCAAoC,CAAC,CACxE;aACA,IAAI,CAAC,gBAAgB,CAAC,OAAO,CAAC,CAAC;IACpC,CAAC;IACD;;;;;;;;;;;;;;;;;OAiBG;IACH,UAAU,CAAC,EACT,GAAG,EACH,KAAK,EACL,KAAK,EACL,MAAM,EACN,wBAAwB,GAwCzB;QACC,OAAO,IAAI,CAAC,iBAAiB,EAAE;aAC5B,OAAO,CAAC;YACP,IAAI,EAAE,4BAA4B;YAClC,MAAM,EAAE,KAAK;YACb,KAAK,EAAE;gBACL,GAAG;gBACH,KAAK;gBACL,KAAK;gBACL,MAAM;gBACN,wBAAwB;aACzB;SACF,CAAC;aACD,IAAI,CACH,IAAI,CAAC,iBAAiB,EAAE,CAAC,eAAe,CAAC;YACvC,GAAG,EAAE;gBACH,kBAAkB,EAAE,MAAM;aAC3B;SACF,CAAC,CACH;aACA,IAAI,CACH,gBAAgB,CAAC,YAAY,EAIzB,CACL;aACA,IAAI,CACH,iDAAuB,CAAC,SAAS,CAAC,mCAAmC,CAAC,CACvE;aACA,IAAI,CAAC,gBAAgB,CAAC,OAAO,CAAC,CAAC;IACpC,CAAC;IACD,MAAM,CAAC,UAAU;QACf,iDAAuB,CAAC,kBAAkB,CACxC,oCAAoC,EACpC,OAAC;aACE,MAAM,CAAC;YACN,MAAM,EAAE,OAAC,CAAC,OAAO,CAAC,GAAG,CAAC;YACtB,SAAS,EAAE,OAAC,CAAC,OAAO,CAAC,kBAAkB,CAAC;YACxC,IAAI,EAAE,iDAAuB,CAAC,IAAI,CAAC,gCAAgC,CAAC;SACrE,CAAC;aACD,QAAQ,CAAC,oCAAoC,CAAC,CAClD,CAAC;QACF,iDAAuB,CAAC,kBAAkB,CACxC,mCAAmC,EACnC,OAAC;aACE,MAAM,CAAC;YACN,MAAM,EAAE,OAAC,CAAC,OAAO,CAAC,GAAG,CAAC;YACtB,SAAS,EAAE,OAAC,CAAC,OAAO,CAAC,kBAAkB,CAAC;YACxC,IAAI,EAAE,iDAAuB,CAAC,IAAI,CAAC,gCAAgC,CAAC;SACrE,CAAC;aACD,QAAQ,CAAC,mCAAmC,CAAC,CACjD,CAAC;QACF,iDAAuB,CAAC,YAAY,CAAC,CAAC,wCAA+B,CAAC,CAAC,CAAC;IAC1E,CAAC;CACF;AAnSD,sCAmSC"}
1
+ {"version":3,"file":"SearchService.js","sourceRoot":"","sources":["../../../../src/openapi/v1/services/SearchService.ts"],"names":[],"mappings":";;;AAAA,eAAe;AACf,wDAAwD;AACxD,gDAAgD;AAChD,6BAAwB;AAExB,6DAA6D;AAC7D,iEAA8D;AAC9D,6CAG0B;AAC1B,wEAAqE;AACrE,qFAAqF;AACrF,MAAa,aAAc,SAAQ,qCAAiB;IAApD;;QACE;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;WA+DG;QACH,gBAAW,GAAG,CAAC,EACb,GAAG,EACH,UAAU,EACV,MAAM,EACN,IAAI,EACJ,IAAI,EACJ,KAAK,EACL,KAAK,EACL,qBAAqB,EACrB,oBAAoB,EACpB,OAAO,EACP,wBAAwB,EACxB,CAAC,EACD,MAAM,GAuDP,EAA2C,EAAE;YAC5C,OAAO,IAAI,CAAC,iBAAiB,EAAE;iBAC5B,OAAO,CAAC;gBACP,IAAI,EAAE,uBAAuB;gBAC7B,MAAM,EAAE,KAAK;gBACb,KAAK,EAAE;oBACL,GAAG;oBACH,UAAU;oBACV,MAAM;oBACN,IAAI;oBACJ,IAAI;oBACJ,KAAK;oBACL,KAAK;oBACL,qBAAqB;oBACrB,oBAAoB;oBACpB,OAAO;oBACP,wBAAwB;oBACxB,CAAC;oBACD,MAAM;iBACP;aACF,CAAC;iBACD,IAAI,CACH,IAAI,CAAC,iBAAiB,EAAE,CAAC,eAAe,CAAC;gBACvC,GAAG,EAAE;oBACH,kBAAkB,EAAE,MAAM;iBAC3B;aACF,CAAC,CACH;iBACA,IAAI,CACH,gBAAgB,CAAC,YAAY,EAIzB,CACL;iBACA,IAAI,CACH,iDAAuB,CAAC,SAAS,CAAC,oCAAoC,CAAC,CACxE;iBACA,IAAI,CAAC,gBAAgB,CAAC,OAAO,CAAC,CAAC;QACpC,CAAC,CAAC;QACF;;;;;;;;;;;;;;;;;WAiBG;QACH,eAAU,GAAG,CAAC,EACZ,GAAG,EACH,KAAK,EACL,KAAK,EACL,MAAM,EACN,wBAAwB,GAwCzB,EAA2C,EAAE;YAC5C,OAAO,IAAI,CAAC,iBAAiB,EAAE;iBAC5B,OAAO,CAAC;gBACP,IAAI,EAAE,4BAA4B;gBAClC,MAAM,EAAE,KAAK;gBACb,KAAK,EAAE;oBACL,GAAG;oBACH,KAAK;oBACL,KAAK;oBACL,MAAM;oBACN,wBAAwB;iBACzB;aACF,CAAC;iBACD,IAAI,CACH,IAAI,CAAC,iBAAiB,EAAE,CAAC,eAAe,CAAC;gBACvC,GAAG,EAAE;oBACH,kBAAkB,EAAE,MAAM;iBAC3B;aACF,CAAC,CACH;iBACA,IAAI,CACH,gBAAgB,CAAC,YAAY,EAIzB,CACL;iBACA,IAAI,CACH,iDAAuB,CAAC,SAAS,CAAC,mCAAmC,CAAC,CACvE;iBACA,IAAI,CAAC,gBAAgB,CAAC,OAAO,CAAC,CAAC;QACpC,CAAC,CAAC;IAwBJ,CAAC;IAvBC,MAAM,CAAC,UAAU;QACf,iDAAuB,CAAC,kBAAkB,CACxC,oCAAoC,EACpC,OAAC;aACE,MAAM,CAAC;YACN,MAAM,EAAE,OAAC,CAAC,OAAO,CAAC,GAAG,CAAC;YACtB,SAAS,EAAE,OAAC,CAAC,OAAO,CAAC,kBAAkB,CAAC;YACxC,IAAI,EAAE,iDAAuB,CAAC,IAAI,CAAC,gCAAgC,CAAC;SACrE,CAAC;aACD,QAAQ,CAAC,oCAAoC,CAAC,CAClD,CAAC;QACF,iDAAuB,CAAC,kBAAkB,CACxC,mCAAmC,EACnC,OAAC;aACE,MAAM,CAAC;YACN,MAAM,EAAE,OAAC,CAAC,OAAO,CAAC,GAAG,CAAC;YACtB,SAAS,EAAE,OAAC,CAAC,OAAO,CAAC,kBAAkB,CAAC;YACxC,IAAI,EAAE,iDAAuB,CAAC,IAAI,CAAC,gCAAgC,CAAC;SACrE,CAAC;aACD,QAAQ,CAAC,mCAAmC,CAAC,CACjD,CAAC;QACF,iDAAuB,CAAC,YAAY,CAAC,CAAC,wCAA+B,CAAC,CAAC,CAAC;IAC1E,CAAC;CACF;AAnSD,sCAmSC"}
@@ -19,14 +19,14 @@ export declare class SettingsService extends CommonHttpService {
19
19
  * @scopes-beta read:configuration:confluence, read:space.setting:confluence
20
20
  * @see https://developer.atlassian.com/cloud/confluence/rest/v1/api-group-settings#api-wiki-rest-api-settings-lookandfeel-get
21
21
  */
22
- getLookAndFeelSettings({ spaceKey, }?: {
22
+ getLookAndFeelSettings: ({ spaceKey, }?: {
23
23
  /**
24
24
  * The key of the space for which the look and feel settings will be
25
25
  * returned. If this is not set, only the global look and feel settings
26
26
  * are returned.
27
27
  */
28
- spaceKey?: string;
29
- }): Promise<LookAndFeelSettings>;
28
+ spaceKey?: string | undefined;
29
+ }) => Promise<LookAndFeelSettings>;
30
30
  /**
31
31
  * Returns the system information for the Confluence Cloud tenant. This
32
32
  * information is used by Atlassian.
@@ -41,7 +41,7 @@ export declare class SettingsService extends CommonHttpService {
41
41
  * @scopes-beta read:configuration:confluence
42
42
  * @see https://developer.atlassian.com/cloud/confluence/rest/v1/api-group-settings#api-wiki-rest-api-settings-systeminfo-get
43
43
  */
44
- getSystemInfo(): Promise<SystemInfoEntity | null>;
44
+ getSystemInfo: () => Promise<SystemInfoEntity | null>;
45
45
  /**
46
46
  * Resets the custom look and feel settings for the site or a single space.
47
47
  * This changes the values of the custom settings to be the same as the
@@ -57,14 +57,14 @@ export declare class SettingsService extends CommonHttpService {
57
57
  * @scopes-beta write:configuration:confluence, write:space.setting:confluence
58
58
  * @see https://developer.atlassian.com/cloud/confluence/rest/v1/api-group-settings#api-wiki-rest-api-settings-lookandfeel-custom-delete
59
59
  */
60
- resetLookAndFeelSettings({ spaceKey, }?: {
60
+ resetLookAndFeelSettings: ({ spaceKey, }?: {
61
61
  /**
62
62
  * The key of the space for which the look and feel settings will be
63
63
  * reset. If this is not set, the global look and feel settings will
64
64
  * be reset.
65
65
  */
66
- spaceKey?: string;
67
- }): Promise<void>;
66
+ spaceKey?: string | undefined;
67
+ }) => Promise<void>;
68
68
  /**
69
69
  * Sets the look and feel settings to either the default settings or the
70
70
  * custom settings, for the site or a single space. Note, the default
@@ -81,16 +81,16 @@ export declare class SettingsService extends CommonHttpService {
81
81
  * write:configuration:confluence, write:space.setting:confluence
82
82
  * @see https://developer.atlassian.com/cloud/confluence/rest/v1/api-group-settings#api-wiki-rest-api-settings-lookandfeel-selected-put
83
83
  */
84
- setLookAndFeelSettings({ spaceKey, requestBody, }: {
84
+ setLookAndFeelSettings: ({ spaceKey, requestBody, }: {
85
85
  /**
86
86
  * The key of the space for which the look and feel settings will be
87
87
  * set. If this is not set, the global look and feel settings will be
88
88
  * set.
89
89
  */
90
- spaceKey?: string;
90
+ spaceKey?: string | undefined;
91
91
  /** The look and feel type to be set. */
92
92
  requestBody: "global" | "custom" | "theme";
93
- }): Promise<string>;
93
+ }) => Promise<string>;
94
94
  /**
95
95
  * Sets the look and feel settings to the default (global) settings, the
96
96
  * custom settings, or the current theme's settings for a space.
@@ -107,10 +107,10 @@ export declare class SettingsService extends CommonHttpService {
107
107
  * @scopes-beta read:space.setting:confluence, write:space.setting:confluence
108
108
  * @see https://developer.atlassian.com/cloud/confluence/rest/v1/api-group-settings#api-wiki-rest-api-settings-lookandfeel-put
109
109
  */
110
- updateLookAndFeel({ lookAndFeelSelection, }: {
110
+ updateLookAndFeel: ({ lookAndFeelSelection, }: {
111
111
  /** The look and feel type to be set. */
112
112
  lookAndFeelSelection: LookAndFeelSelection;
113
- }): Promise<LookAndFeelSelection>;
113
+ }) => Promise<LookAndFeelSelection>;
114
114
  /**
115
115
  * Updates the look and feel settings for the site or for a single space.
116
116
  * If custom settings exist, they are updated. If no custom settings exist,
@@ -129,13 +129,13 @@ export declare class SettingsService extends CommonHttpService {
129
129
  * write:configuration:confluence, write:space.setting:confluence
130
130
  * @see https://developer.atlassian.com/cloud/confluence/rest/v1/api-group-settings#api-wiki-rest-api-settings-lookandfeel-custom-post
131
131
  */
132
- updateLookAndFeelSettings({ spaceKey, lookAndFeel, }: {
132
+ updateLookAndFeelSettings: ({ spaceKey, lookAndFeel, }: {
133
133
  /**
134
134
  * The key of the space for which the look and feel settings will be
135
135
  * updated. If this is not set, the global look and feel settings will
136
136
  * be updated.
137
137
  */
138
- spaceKey?: string;
138
+ spaceKey?: string | undefined;
139
139
  /**
140
140
  * The updated settings. All values for the settings must be included,
141
141
  * regardless of whether they are being changed.
@@ -145,6 +145,6 @@ export declare class SettingsService extends CommonHttpService {
145
145
  * and modify it as needed.
146
146
  */
147
147
  lookAndFeel: LookAndFeel;
148
- }): Promise<LookAndFeelWithLinks>;
148
+ }) => Promise<LookAndFeelWithLinks>;
149
149
  static initialize(): void;
150
150
  }