@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,168 +11,171 @@ const common_1 = require("../models/common");
11
11
  const validationSchemaStorage_1 = require("../validationSchemaStorage");
12
12
  /** @see https://developer.atlassian.com/cloud/confluence/rest/v2/api-group-space-properties */
13
13
  class SpacePropertiesService extends CommonHttpService_1.CommonHttpService {
14
- /**
15
- * Creates a new space property.
16
- *
17
- * **[Permissions](https://confluence.atlassian.com/x/_AozKw) required**:
18
- * Permission to access the Confluence site ('Can use' global permission) and
19
- * 'Admin' permission for the space.
20
- *
21
- * @returns Returned if the space property was created successfully.
22
- * @path {POST} /spaces/{space-id}/properties
23
- * @scopes-current read:space:confluence, write:space:confluence
24
- * @see https://developer.atlassian.com/cloud/confluence/rest/v2/api-group-space-properties#api-spaces-space-id-properties-post
25
- */
26
- createSpaceProperty({ spaceId, spacePropertyCreateRequest, }) {
27
- return this.getClientInstance()
28
- .request({
29
- path: "/spaces/{space-id}/properties",
30
- method: "POST",
31
- pathParams: {
32
- "space-id": spaceId,
33
- },
34
- headers: {
35
- "Content-Type": "application/json",
36
- },
37
- body: spacePropertyCreateRequest,
38
- })
39
- .then(this.getClientInstance().responseHandler({
40
- 201: {
41
- "application/json": "json",
42
- },
43
- }))
44
- .then(commonHttpClient.castResponse())
45
- .then(validationSchemaStorage_1.validationSchemaStorage.validator("SpacePropertiesService.createSpaceProperty.response"))
46
- .then(commonHttpClient.getBody);
47
- }
48
- /**
49
- * Deletes a space property by its id.
50
- *
51
- * **[Permissions](https://confluence.atlassian.com/x/_AozKw) required**:
52
- * Permission to access the Confluence site ('Can use' global permission) and
53
- * 'Admin' permission for the space.
54
- *
55
- * @path {DELETE} /spaces/{space-id}/properties/{property-id}
56
- * @scopes-current read:space:confluence, write:space:confluence
57
- * @see https://developer.atlassian.com/cloud/confluence/rest/v2/api-group-space-properties#api-spaces-space-id-properties-property-id-delete
58
- */
59
- deleteSpacePropertyById({ spaceId, propertyId, }) {
60
- return this.getClientInstance()
61
- .request({
62
- path: "/spaces/{space-id}/properties/{property-id}",
63
- method: "DELETE",
64
- pathParams: {
65
- "space-id": spaceId,
66
- "property-id": propertyId,
67
- },
68
- })
69
- .then(commonHttpClient.discardResult);
70
- }
71
- /**
72
- * Returns all properties for the given space. Space properties are a key-value
73
- * storage associated with a space.
74
- * The limit parameter specifies the maximum number of results returned in a
75
- * single response. Use the `link` response header
76
- * to paginate through additional results.
77
- *
78
- * **[Permissions](https://confluence.atlassian.com/x/_AozKw) required**:
79
- * Permission to access the Confluence site ('Can use' global permission) and
80
- * 'View' permission for the space.
81
- *
82
- * @returns Returned if the requested space properties are returned. `results` may be empty
83
- * if no results were found.
84
- * @path {GET} /spaces/{space-id}/properties
85
- * @scopes-current read:space:confluence
86
- * @see https://developer.atlassian.com/cloud/confluence/rest/v2/api-group-space-properties#api-spaces-space-id-properties-get
87
- */
88
- getSpaceProperties({ spaceId, key, cursor, limit, }) {
89
- return this.getClientInstance()
90
- .request({
91
- path: "/spaces/{space-id}/properties",
92
- method: "GET",
93
- pathParams: {
94
- "space-id": spaceId,
95
- },
96
- query: {
97
- key,
98
- cursor,
99
- limit,
100
- },
101
- })
102
- .then(this.getClientInstance().responseHandler({
103
- 200: {
104
- "application/json": "json",
105
- },
106
- }))
107
- .then(commonHttpClient.castResponse())
108
- .then(validationSchemaStorage_1.validationSchemaStorage.validator("SpacePropertiesService.getSpaceProperties.response"))
109
- .then(commonHttpClient.getBody);
110
- }
111
- /**
112
- * Retrieve a space property by its id.
113
- *
114
- * **[Permissions](https://confluence.atlassian.com/x/_AozKw) required**:
115
- * Permission to access the Confluence site ('Can use' global permission) and
116
- * 'View' permission for the space.
117
- *
118
- * @returns Returned if the space property was retrieved.
119
- * @path {GET} /spaces/{space-id}/properties/{property-id}
120
- * @scopes-current read:space:confluence
121
- * @see https://developer.atlassian.com/cloud/confluence/rest/v2/api-group-space-properties#api-spaces-space-id-properties-property-id-get
122
- */
123
- getSpacePropertyById({ spaceId, propertyId, }) {
124
- return this.getClientInstance()
125
- .request({
126
- path: "/spaces/{space-id}/properties/{property-id}",
127
- method: "GET",
128
- pathParams: {
129
- "space-id": spaceId,
130
- "property-id": propertyId,
131
- },
132
- })
133
- .then(this.getClientInstance().responseHandler({
134
- 200: {
135
- "application/json": "json",
136
- },
137
- }))
138
- .then(commonHttpClient.castResponse())
139
- .then(validationSchemaStorage_1.validationSchemaStorage.validator("SpacePropertiesService.getSpacePropertyById.response"))
140
- .then(commonHttpClient.getBody);
141
- }
142
- /**
143
- * Update a space property by its id.
144
- *
145
- * **[Permissions](https://confluence.atlassian.com/x/_AozKw) required**:
146
- * Permission to access the Confluence site ('Can use' global permission) and
147
- * 'Admin' permission for the space.
148
- *
149
- * @returns Returned if the space property was updated successfully.
150
- * @path {PUT} /spaces/{space-id}/properties/{property-id}
151
- * @scopes-current read:space:confluence, write:space:confluence
152
- * @see https://developer.atlassian.com/cloud/confluence/rest/v2/api-group-space-properties#api-spaces-space-id-properties-property-id-put
153
- */
154
- updateSpacePropertyById({ spaceId, propertyId, spacePropertyUpdateRequest, }) {
155
- return this.getClientInstance()
156
- .request({
157
- path: "/spaces/{space-id}/properties/{property-id}",
158
- method: "PUT",
159
- pathParams: {
160
- "space-id": spaceId,
161
- "property-id": propertyId,
162
- },
163
- headers: {
164
- "Content-Type": "application/json",
165
- },
166
- body: spacePropertyUpdateRequest,
167
- })
168
- .then(this.getClientInstance().responseHandler({
169
- 200: {
170
- "application/json": "json",
171
- },
172
- }))
173
- .then(commonHttpClient.castResponse())
174
- .then(validationSchemaStorage_1.validationSchemaStorage.validator("SpacePropertiesService.updateSpacePropertyById.response"))
175
- .then(commonHttpClient.getBody);
14
+ constructor() {
15
+ super(...arguments);
16
+ /**
17
+ * Creates a new space property.
18
+ *
19
+ * **[Permissions](https://confluence.atlassian.com/x/_AozKw) required**:
20
+ * Permission to access the Confluence site ('Can use' global permission) and
21
+ * 'Admin' permission for the space.
22
+ *
23
+ * @returns Returned if the space property was created successfully.
24
+ * @path {POST} /spaces/{space-id}/properties
25
+ * @scopes-current read:space:confluence, write:space:confluence
26
+ * @see https://developer.atlassian.com/cloud/confluence/rest/v2/api-group-space-properties#api-spaces-space-id-properties-post
27
+ */
28
+ this.createSpaceProperty = ({ spaceId, spacePropertyCreateRequest, }) => {
29
+ return this.getClientInstance()
30
+ .request({
31
+ path: "/spaces/{space-id}/properties",
32
+ method: "POST",
33
+ pathParams: {
34
+ "space-id": spaceId,
35
+ },
36
+ headers: {
37
+ "Content-Type": "application/json",
38
+ },
39
+ body: spacePropertyCreateRequest,
40
+ })
41
+ .then(this.getClientInstance().responseHandler({
42
+ 201: {
43
+ "application/json": "json",
44
+ },
45
+ }))
46
+ .then(commonHttpClient.castResponse())
47
+ .then(validationSchemaStorage_1.validationSchemaStorage.validator("SpacePropertiesService.createSpaceProperty.response"))
48
+ .then(commonHttpClient.getBody);
49
+ };
50
+ /**
51
+ * Deletes a space property by its id.
52
+ *
53
+ * **[Permissions](https://confluence.atlassian.com/x/_AozKw) required**:
54
+ * Permission to access the Confluence site ('Can use' global permission) and
55
+ * 'Admin' permission for the space.
56
+ *
57
+ * @path {DELETE} /spaces/{space-id}/properties/{property-id}
58
+ * @scopes-current read:space:confluence, write:space:confluence
59
+ * @see https://developer.atlassian.com/cloud/confluence/rest/v2/api-group-space-properties#api-spaces-space-id-properties-property-id-delete
60
+ */
61
+ this.deleteSpacePropertyById = ({ spaceId, propertyId, }) => {
62
+ return this.getClientInstance()
63
+ .request({
64
+ path: "/spaces/{space-id}/properties/{property-id}",
65
+ method: "DELETE",
66
+ pathParams: {
67
+ "space-id": spaceId,
68
+ "property-id": propertyId,
69
+ },
70
+ })
71
+ .then(commonHttpClient.discardResult);
72
+ };
73
+ /**
74
+ * Returns all properties for the given space. Space properties are a key-value
75
+ * storage associated with a space.
76
+ * The limit parameter specifies the maximum number of results returned in a
77
+ * single response. Use the `link` response header
78
+ * to paginate through additional results.
79
+ *
80
+ * **[Permissions](https://confluence.atlassian.com/x/_AozKw) required**:
81
+ * Permission to access the Confluence site ('Can use' global permission) and
82
+ * 'View' permission for the space.
83
+ *
84
+ * @returns Returned if the requested space properties are returned. `results` may be empty
85
+ * if no results were found.
86
+ * @path {GET} /spaces/{space-id}/properties
87
+ * @scopes-current read:space:confluence
88
+ * @see https://developer.atlassian.com/cloud/confluence/rest/v2/api-group-space-properties#api-spaces-space-id-properties-get
89
+ */
90
+ this.getSpaceProperties = ({ spaceId, key, cursor, limit, }) => {
91
+ return this.getClientInstance()
92
+ .request({
93
+ path: "/spaces/{space-id}/properties",
94
+ method: "GET",
95
+ pathParams: {
96
+ "space-id": spaceId,
97
+ },
98
+ query: {
99
+ key,
100
+ cursor,
101
+ limit,
102
+ },
103
+ })
104
+ .then(this.getClientInstance().responseHandler({
105
+ 200: {
106
+ "application/json": "json",
107
+ },
108
+ }))
109
+ .then(commonHttpClient.castResponse())
110
+ .then(validationSchemaStorage_1.validationSchemaStorage.validator("SpacePropertiesService.getSpaceProperties.response"))
111
+ .then(commonHttpClient.getBody);
112
+ };
113
+ /**
114
+ * Retrieve a space property by its id.
115
+ *
116
+ * **[Permissions](https://confluence.atlassian.com/x/_AozKw) required**:
117
+ * Permission to access the Confluence site ('Can use' global permission) and
118
+ * 'View' permission for the space.
119
+ *
120
+ * @returns Returned if the space property was retrieved.
121
+ * @path {GET} /spaces/{space-id}/properties/{property-id}
122
+ * @scopes-current read:space:confluence
123
+ * @see https://developer.atlassian.com/cloud/confluence/rest/v2/api-group-space-properties#api-spaces-space-id-properties-property-id-get
124
+ */
125
+ this.getSpacePropertyById = ({ spaceId, propertyId, }) => {
126
+ return this.getClientInstance()
127
+ .request({
128
+ path: "/spaces/{space-id}/properties/{property-id}",
129
+ method: "GET",
130
+ pathParams: {
131
+ "space-id": spaceId,
132
+ "property-id": propertyId,
133
+ },
134
+ })
135
+ .then(this.getClientInstance().responseHandler({
136
+ 200: {
137
+ "application/json": "json",
138
+ },
139
+ }))
140
+ .then(commonHttpClient.castResponse())
141
+ .then(validationSchemaStorage_1.validationSchemaStorage.validator("SpacePropertiesService.getSpacePropertyById.response"))
142
+ .then(commonHttpClient.getBody);
143
+ };
144
+ /**
145
+ * Update a space property by its id.
146
+ *
147
+ * **[Permissions](https://confluence.atlassian.com/x/_AozKw) required**:
148
+ * Permission to access the Confluence site ('Can use' global permission) and
149
+ * 'Admin' permission for the space.
150
+ *
151
+ * @returns Returned if the space property was updated successfully.
152
+ * @path {PUT} /spaces/{space-id}/properties/{property-id}
153
+ * @scopes-current read:space:confluence, write:space:confluence
154
+ * @see https://developer.atlassian.com/cloud/confluence/rest/v2/api-group-space-properties#api-spaces-space-id-properties-property-id-put
155
+ */
156
+ this.updateSpacePropertyById = ({ spaceId, propertyId, spacePropertyUpdateRequest, }) => {
157
+ return this.getClientInstance()
158
+ .request({
159
+ path: "/spaces/{space-id}/properties/{property-id}",
160
+ method: "PUT",
161
+ pathParams: {
162
+ "space-id": spaceId,
163
+ "property-id": propertyId,
164
+ },
165
+ headers: {
166
+ "Content-Type": "application/json",
167
+ },
168
+ body: spacePropertyUpdateRequest,
169
+ })
170
+ .then(this.getClientInstance().responseHandler({
171
+ 200: {
172
+ "application/json": "json",
173
+ },
174
+ }))
175
+ .then(commonHttpClient.castResponse())
176
+ .then(validationSchemaStorage_1.validationSchemaStorage.validator("SpacePropertiesService.updateSpacePropertyById.response"))
177
+ .then(commonHttpClient.getBody);
178
+ };
176
179
  }
177
180
  static initialize() {
178
181
  validationSchemaStorage_1.validationSchemaStorage.registerExtensible("SpacePropertiesService.getSpaceProperties.response", zod_1.z
@@ -1 +1 @@
1
- {"version":3,"file":"SpacePropertiesService.js","sourceRoot":"","sources":["../../../../src/openapi/v2/services/SpacePropertiesService.ts"],"names":[],"mappings":";;;AAAA,eAAe;AACf,wDAAwD;AACxD,gDAAgD;AAChD,6BAAwB;AAExB,6DAA6D;AAC7D,iEAA8D;AAC9D,6CAI0B;AAK1B,wEAAqE;AACrE,+FAA+F;AAC/F,MAAa,sBAAuB,SAAQ,qCAAiB;IAC3D;;;;;;;;;;;OAWG;IACH,mBAAmB,CAAC,EAClB,OAAO,EACP,0BAA0B,GAM3B;QACC,OAAO,IAAI,CAAC,iBAAiB,EAAE;aAC5B,OAAO,CAAC;YACP,IAAI,EAAE,+BAA+B;YACrC,MAAM,EAAE,MAAM;YACd,UAAU,EAAE;gBACV,UAAU,EAAE,OAAO;aACpB;YACD,OAAO,EAAE;gBACP,cAAc,EAAE,kBAAkB;aACnC;YACD,IAAI,EAAE,0BAA0B;SACjC,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,CAC/B,qDAAqD,CACtD,CACF;aACA,IAAI,CAAC,gBAAgB,CAAC,OAAO,CAAC,CAAC;IACpC,CAAC;IACD;;;;;;;;;;OAUG;IACH,uBAAuB,CAAC,EACtB,OAAO,EACP,UAAU,GAMX;QACC,OAAO,IAAI,CAAC,iBAAiB,EAAE;aAC5B,OAAO,CAAC;YACP,IAAI,EAAE,6CAA6C;YACnD,MAAM,EAAE,QAAQ;YAChB,UAAU,EAAE;gBACV,UAAU,EAAE,OAAO;gBACnB,aAAa,EAAE,UAAU;aAC1B;SACF,CAAC;aACD,IAAI,CAAC,gBAAgB,CAAC,aAAa,CAAC,CAAC;IAC1C,CAAC;IACD;;;;;;;;;;;;;;;;OAgBG;IACH,kBAAkB,CAAC,EACjB,OAAO,EACP,GAAG,EACH,MAAM,EACN,KAAK,GAsBN;QAQC,OAAO,IAAI,CAAC,iBAAiB,EAAE;aAC5B,OAAO,CAAC;YACP,IAAI,EAAE,+BAA+B;YACrC,MAAM,EAAE,KAAK;YACb,UAAU,EAAE;gBACV,UAAU,EAAE,OAAO;aACpB;YACD,KAAK,EAAE;gBACL,GAAG;gBACH,MAAM;gBACN,KAAK;aACN;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,EASzB,CACL;aACA,IAAI,CACH,iDAAuB,CAAC,SAAS,CAC/B,oDAAoD,CACrD,CACF;aACA,IAAI,CAAC,gBAAgB,CAAC,OAAO,CAAC,CAAC;IACpC,CAAC;IACD;;;;;;;;;;;OAWG;IACH,oBAAoB,CAAC,EACnB,OAAO,EACP,UAAU,GAMX;QACC,OAAO,IAAI,CAAC,iBAAiB,EAAE;aAC5B,OAAO,CAAC;YACP,IAAI,EAAE,6CAA6C;YACnD,MAAM,EAAE,KAAK;YACb,UAAU,EAAE;gBACV,UAAU,EAAE,OAAO;gBACnB,aAAa,EAAE,UAAU;aAC1B;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,CAC/B,sDAAsD,CACvD,CACF;aACA,IAAI,CAAC,gBAAgB,CAAC,OAAO,CAAC,CAAC;IACpC,CAAC;IACD;;;;;;;;;;;OAWG;IACH,uBAAuB,CAAC,EACtB,OAAO,EACP,UAAU,EACV,0BAA0B,GAQ3B;QACC,OAAO,IAAI,CAAC,iBAAiB,EAAE;aAC5B,OAAO,CAAC;YACP,IAAI,EAAE,6CAA6C;YACnD,MAAM,EAAE,KAAK;YACb,UAAU,EAAE;gBACV,UAAU,EAAE,OAAO;gBACnB,aAAa,EAAE,UAAU;aAC1B;YACD,OAAO,EAAE;gBACP,cAAc,EAAE,kBAAkB;aACnC;YACD,IAAI,EAAE,0BAA0B;SACjC,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,CAC/B,yDAAyD,CAC1D,CACF;aACA,IAAI,CAAC,gBAAgB,CAAC,OAAO,CAAC,CAAC;IACpC,CAAC;IACD,MAAM,CAAC,UAAU;QACf,iDAAuB,CAAC,kBAAkB,CACxC,oDAAoD,EACpD,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,OAAC;iBACJ,MAAM,CAAC;gBACN,OAAO,EAAE,OAAC;qBACP,KAAK,CAAC,iDAAuB,CAAC,IAAI,CAAC,eAAe,CAAC,CAAC;qBACpD,QAAQ,EAAE;gBACb,MAAM,EAAE,iDAAuB;qBAC5B,IAAI,CAAC,kBAAkB,CAAC;qBACxB,QAAQ,EAAE;aACd,CAAC;iBACD,QAAQ,CAAC,OAAC,CAAC,OAAO,EAAE,CAAC;SACzB,CAAC;aACD,QAAQ,CAAC,oDAAoD,CAAC,CAClE,CAAC;QACF,iDAAuB,CAAC,kBAAkB,CACxC,qDAAqD,EACrD,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,eAAe,CAAC;SACpD,CAAC;aACD,QAAQ,CAAC,qDAAqD,CAAC,CACnE,CAAC;QACF,iDAAuB,CAAC,kBAAkB,CACxC,sDAAsD,EACtD,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,eAAe,CAAC;SACpD,CAAC;aACD,QAAQ,CAAC,sDAAsD,CAAC,CACpE,CAAC;QACF,iDAAuB,CAAC,kBAAkB,CACxC,yDAAyD,EACzD,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,eAAe,CAAC;SACpD,CAAC;aACD,QAAQ,CAAC,yDAAyD,CAAC,CACvE,CAAC;QACF,iDAAuB,CAAC,YAAY,CAAC,CAAC,wCAA+B,CAAC,CAAC,CAAC;IAC1E,CAAC;CACF;AAjVD,wDAiVC"}
1
+ {"version":3,"file":"SpacePropertiesService.js","sourceRoot":"","sources":["../../../../src/openapi/v2/services/SpacePropertiesService.ts"],"names":[],"mappings":";;;AAAA,eAAe;AACf,wDAAwD;AACxD,gDAAgD;AAChD,6BAAwB;AAExB,6DAA6D;AAC7D,iEAA8D;AAC9D,6CAI0B;AAK1B,wEAAqE;AACrE,+FAA+F;AAC/F,MAAa,sBAAuB,SAAQ,qCAAiB;IAA7D;;QACE;;;;;;;;;;;WAWG;QACH,wBAAmB,GAAG,CAAC,EACrB,OAAO,EACP,0BAA0B,GAM3B,EAA0B,EAAE;YAC3B,OAAO,IAAI,CAAC,iBAAiB,EAAE;iBAC5B,OAAO,CAAC;gBACP,IAAI,EAAE,+BAA+B;gBACrC,MAAM,EAAE,MAAM;gBACd,UAAU,EAAE;oBACV,UAAU,EAAE,OAAO;iBACpB;gBACD,OAAO,EAAE;oBACP,cAAc,EAAE,kBAAkB;iBACnC;gBACD,IAAI,EAAE,0BAA0B;aACjC,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,CAC/B,qDAAqD,CACtD,CACF;iBACA,IAAI,CAAC,gBAAgB,CAAC,OAAO,CAAC,CAAC;QACpC,CAAC,CAAC;QACF;;;;;;;;;;WAUG;QACH,4BAAuB,GAAG,CAAC,EACzB,OAAO,EACP,UAAU,GAMX,EAAiB,EAAE;YAClB,OAAO,IAAI,CAAC,iBAAiB,EAAE;iBAC5B,OAAO,CAAC;gBACP,IAAI,EAAE,6CAA6C;gBACnD,MAAM,EAAE,QAAQ;gBAChB,UAAU,EAAE;oBACV,UAAU,EAAE,OAAO;oBACnB,aAAa,EAAE,UAAU;iBAC1B;aACF,CAAC;iBACD,IAAI,CAAC,gBAAgB,CAAC,aAAa,CAAC,CAAC;QAC1C,CAAC,CAAC;QACF;;;;;;;;;;;;;;;;WAgBG;QACH,uBAAkB,GAAG,CAAC,EACpB,OAAO,EACP,GAAG,EACH,MAAM,EACN,KAAK,GAsBN,EAOC,EAAE;YACF,OAAO,IAAI,CAAC,iBAAiB,EAAE;iBAC5B,OAAO,CAAC;gBACP,IAAI,EAAE,+BAA+B;gBACrC,MAAM,EAAE,KAAK;gBACb,UAAU,EAAE;oBACV,UAAU,EAAE,OAAO;iBACpB;gBACD,KAAK,EAAE;oBACL,GAAG;oBACH,MAAM;oBACN,KAAK;iBACN;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,EASzB,CACL;iBACA,IAAI,CACH,iDAAuB,CAAC,SAAS,CAC/B,oDAAoD,CACrD,CACF;iBACA,IAAI,CAAC,gBAAgB,CAAC,OAAO,CAAC,CAAC;QACpC,CAAC,CAAC;QACF;;;;;;;;;;;WAWG;QACH,yBAAoB,GAAG,CAAC,EACtB,OAAO,EACP,UAAU,GAMX,EAA0B,EAAE;YAC3B,OAAO,IAAI,CAAC,iBAAiB,EAAE;iBAC5B,OAAO,CAAC;gBACP,IAAI,EAAE,6CAA6C;gBACnD,MAAM,EAAE,KAAK;gBACb,UAAU,EAAE;oBACV,UAAU,EAAE,OAAO;oBACnB,aAAa,EAAE,UAAU;iBAC1B;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,CAC/B,sDAAsD,CACvD,CACF;iBACA,IAAI,CAAC,gBAAgB,CAAC,OAAO,CAAC,CAAC;QACpC,CAAC,CAAC;QACF;;;;;;;;;;;WAWG;QACH,4BAAuB,GAAG,CAAC,EACzB,OAAO,EACP,UAAU,EACV,0BAA0B,GAQ3B,EAA0B,EAAE;YAC3B,OAAO,IAAI,CAAC,iBAAiB,EAAE;iBAC5B,OAAO,CAAC;gBACP,IAAI,EAAE,6CAA6C;gBACnD,MAAM,EAAE,KAAK;gBACb,UAAU,EAAE;oBACV,UAAU,EAAE,OAAO;oBACnB,aAAa,EAAE,UAAU;iBAC1B;gBACD,OAAO,EAAE;oBACP,cAAc,EAAE,kBAAkB;iBACnC;gBACD,IAAI,EAAE,0BAA0B;aACjC,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,CAC/B,yDAAyD,CAC1D,CACF;iBACA,IAAI,CAAC,gBAAgB,CAAC,OAAO,CAAC,CAAC;QACpC,CAAC,CAAC;IAqDJ,CAAC;IApDC,MAAM,CAAC,UAAU;QACf,iDAAuB,CAAC,kBAAkB,CACxC,oDAAoD,EACpD,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,OAAC;iBACJ,MAAM,CAAC;gBACN,OAAO,EAAE,OAAC;qBACP,KAAK,CAAC,iDAAuB,CAAC,IAAI,CAAC,eAAe,CAAC,CAAC;qBACpD,QAAQ,EAAE;gBACb,MAAM,EAAE,iDAAuB;qBAC5B,IAAI,CAAC,kBAAkB,CAAC;qBACxB,QAAQ,EAAE;aACd,CAAC;iBACD,QAAQ,CAAC,OAAC,CAAC,OAAO,EAAE,CAAC;SACzB,CAAC;aACD,QAAQ,CAAC,oDAAoD,CAAC,CAClE,CAAC;QACF,iDAAuB,CAAC,kBAAkB,CACxC,qDAAqD,EACrD,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,eAAe,CAAC;SACpD,CAAC;aACD,QAAQ,CAAC,qDAAqD,CAAC,CACnE,CAAC;QACF,iDAAuB,CAAC,kBAAkB,CACxC,sDAAsD,EACtD,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,eAAe,CAAC;SACpD,CAAC;aACD,QAAQ,CAAC,sDAAsD,CAAC,CACpE,CAAC;QACF,iDAAuB,CAAC,kBAAkB,CACxC,yDAAyD,EACzD,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,eAAe,CAAC;SACpD,CAAC;aACD,QAAQ,CAAC,yDAAyD,CAAC,CACvE,CAAC;QACF,iDAAuB,CAAC,YAAY,CAAC,CAAC,wCAA+B,CAAC,CAAC,CAAC;IAC1E,CAAC;CACF;AAjVD,wDAiVC"}
@@ -14,7 +14,7 @@ export declare class SpaceService extends CommonHttpService {
14
14
  * @scopes-current read:space:confluence
15
15
  * @see https://developer.atlassian.com/cloud/confluence/rest/v2/api-group-space#api-spaces-id-get
16
16
  */
17
- getSpaceById({ id, descriptionFormat, includeIcon, includeOperations, includeProperties, includePermissions, includeLabels, }: {
17
+ getSpaceById: ({ id, descriptionFormat, includeIcon, includeOperations, includeProperties, includePermissions, includeLabels, }: {
18
18
  /** The ID of the space to be returned. */
19
19
  id: number;
20
20
  /**
@@ -22,9 +22,9 @@ export declare class SpaceService extends CommonHttpService {
22
22
  * response. If available, the representation will be available under a response
23
23
  * field of the same name under the `description` field.
24
24
  */
25
- descriptionFormat?: SpaceDescriptionBodyRepresentation;
25
+ descriptionFormat?: SpaceDescriptionBodyRepresentation | undefined;
26
26
  /** If the icon for the space should be fetched or not. */
27
- includeIcon?: boolean;
27
+ includeIcon?: boolean | undefined;
28
28
  /**
29
29
  * Includes operations associated with this space in the response.
30
30
  * The number of results will be limited to 50 and sorted in the default sort
@@ -32,7 +32,7 @@ export declare class SpaceService extends CommonHttpService {
32
32
  * A `meta` and `_links` property will be present to indicate if more results are
33
33
  * available and a link to retrieve the rest of the results.
34
34
  */
35
- includeOperations?: boolean;
35
+ includeOperations?: boolean | undefined;
36
36
  /**
37
37
  * Includes space properties associated with this space in the response.
38
38
  * The number of results will be limited to 50 and sorted in the default sort
@@ -40,7 +40,7 @@ export declare class SpaceService extends CommonHttpService {
40
40
  * A `meta` and `_links` property will be present to indicate if more results are
41
41
  * available and a link to retrieve the rest of the results.
42
42
  */
43
- includeProperties?: boolean;
43
+ includeProperties?: boolean | undefined;
44
44
  /**
45
45
  * Includes space permissions associated with this space in the response.
46
46
  * The number of results will be limited to 50 and sorted in the default sort
@@ -48,7 +48,7 @@ export declare class SpaceService extends CommonHttpService {
48
48
  * A `meta` and `_links` property will be present to indicate if more results are
49
49
  * available and a link to retrieve the rest of the results.
50
50
  */
51
- includePermissions?: boolean;
51
+ includePermissions?: boolean | undefined;
52
52
  /**
53
53
  * Includes labels associated with this space in the response.
54
54
  * The number of results will be limited to 50 and sorted in the default sort
@@ -56,17 +56,17 @@ export declare class SpaceService extends CommonHttpService {
56
56
  * A `meta` and `_links` property will be present to indicate if more results are
57
57
  * available and a link to retrieve the rest of the results.
58
58
  */
59
- includeLabels?: boolean;
60
- }): Promise<SpaceSingle & ({
61
- _links?: {
59
+ includeLabels?: boolean | undefined;
60
+ }) => Promise<SpaceSingle & {
61
+ _links?: ({
62
62
  /** Base url of the Confluence site. */
63
- base?: string;
63
+ base?: string | undefined;
64
64
  } & {
65
65
  [key: string]: unknown;
66
- };
66
+ }) | undefined;
67
67
  } & {
68
68
  [key: string]: unknown;
69
- })>;
69
+ }>;
70
70
  /**
71
71
  * Returns all spaces. The results will be sorted by id ascending. The number of
72
72
  * results is limited by the `limit` parameter and
@@ -82,61 +82,61 @@ export declare class SpaceService extends CommonHttpService {
82
82
  * @scopes-current read:space:confluence
83
83
  * @see https://developer.atlassian.com/cloud/confluence/rest/v2/api-group-space#api-spaces-get
84
84
  */
85
- getSpaces({ ids, keys, type, status, labels, favoritedBy, notFavoritedBy, sort, descriptionFormat, includeIcon, cursor, limit, }?: {
85
+ getSpaces: ({ ids, keys, type, status, labels, favoritedBy, notFavoritedBy, sort, descriptionFormat, includeIcon, cursor, limit, }?: {
86
86
  /**
87
87
  * Filter the results to spaces based on their IDs. Multiple IDs can be specified
88
88
  * as a comma-separated list.
89
89
  */
90
- ids?: number[];
90
+ ids?: number[] | undefined;
91
91
  /**
92
92
  * Filter the results to spaces based on their keys. Multiple keys can be
93
93
  * specified as a comma-separated list.
94
94
  */
95
- keys?: string[];
95
+ keys?: string[] | undefined;
96
96
  /** Filter the results to spaces based on their type. */
97
- type?: "global" | "collaboration" | "knowledge_base" | "personal";
97
+ type?: "global" | "personal" | "collaboration" | "knowledge_base" | undefined;
98
98
  /** Filter the results to spaces based on their status. */
99
- status?: "current" | "archived";
99
+ status?: "current" | "archived" | undefined;
100
100
  /**
101
101
  * Filter the results to spaces based on their labels. Multiple labels can be
102
102
  * specified as a comma-separated list.
103
103
  */
104
- labels?: string[];
104
+ labels?: string[] | undefined;
105
105
  /**
106
106
  * Filter the results to spaces favorited by the user with the specified account
107
107
  * ID.
108
108
  */
109
- favoritedBy?: string;
109
+ favoritedBy?: string | undefined;
110
110
  /**
111
111
  * Filter the results to spaces NOT favorited by the user with the specified
112
112
  * account ID.
113
113
  */
114
- notFavoritedBy?: string;
114
+ notFavoritedBy?: string | undefined;
115
115
  /** Used to sort the result by a particular field. */
116
- sort?: SpaceSortOrder;
116
+ sort?: SpaceSortOrder | undefined;
117
117
  /**
118
118
  * The content format type to be returned in the `description` field of the
119
119
  * response. If available, the representation will be available under a response
120
120
  * field of the same name under the `description` field.
121
121
  */
122
- descriptionFormat?: SpaceDescriptionBodyRepresentation;
122
+ descriptionFormat?: SpaceDescriptionBodyRepresentation | undefined;
123
123
  /** If the icon for the space should be fetched or not. */
124
- includeIcon?: boolean;
124
+ includeIcon?: boolean | undefined;
125
125
  /**
126
126
  * Used for pagination, this opaque cursor will be returned in the `next` URL in
127
127
  * the `Link` response header. Use the relative URL in the `Link` header to
128
128
  * retrieve the `next` set of results.
129
129
  */
130
- cursor?: string;
130
+ cursor?: string | undefined;
131
131
  /**
132
132
  * Maximum number of spaces per result to return. If more results exist, use the
133
133
  * `Link` response header to retrieve a relative URL that will return the next set
134
134
  * of results.
135
135
  */
136
- limit?: number;
137
- }): Promise<{
138
- results?: SpaceBulk[];
139
- _links?: MultiEntityLinks;
136
+ limit?: number | undefined;
137
+ }) => Promise<{
138
+ results?: SpaceBulk[] | undefined;
139
+ _links?: MultiEntityLinks | undefined;
140
140
  } & {
141
141
  [key: string]: unknown;
142
142
  }>;