@resolution/confluence-api-client 0.13.4 → 0.14.0

This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
Files changed (128) hide show
  1. package/lib/openapi/core/CommonHttpClient.d.ts +1 -1
  2. package/lib/openapi/core/CommonHttpClient.js +1 -1
  3. package/lib/openapi/core/CommonHttpClient.js.map +1 -1
  4. package/lib/openapi/v1/BaseConfluenceApiV1Client.d.ts +6 -37
  5. package/lib/openapi/v1/BaseConfluenceApiV1Client.js +3 -71
  6. package/lib/openapi/v1/BaseConfluenceApiV1Client.js.map +1 -1
  7. package/lib/openapi/v1/models/audit.js +2 -2
  8. package/lib/openapi/v1/models/audit.js.map +1 -1
  9. package/lib/openapi/v1/models/common.d.ts +1 -1
  10. package/lib/openapi/v1/models/common.js +3 -3
  11. package/lib/openapi/v1/models/common.js.map +1 -1
  12. package/lib/openapi/v1/models/content.d.ts +0 -543
  13. package/lib/openapi/v1/models/content.js +2 -309
  14. package/lib/openapi/v1/models/content.js.map +1 -1
  15. package/lib/openapi/v1/models/contentChildrenAndDescendants.d.ts +7 -3
  16. package/lib/openapi/v1/models/contentChildrenAndDescendants.js +1 -1
  17. package/lib/openapi/v1/models/contentChildrenAndDescendants.js.map +1 -1
  18. package/lib/openapi/v1/models/contentRestrictions.js +1 -1
  19. package/lib/openapi/v1/models/contentRestrictions.js.map +1 -1
  20. package/lib/openapi/v1/models/contentStates.d.ts +322 -0
  21. package/lib/openapi/v1/models/contentStates.js +219 -0
  22. package/lib/openapi/v1/models/contentStates.js.map +1 -1
  23. package/lib/openapi/v1/models/contentVersions.d.ts +0 -9
  24. package/lib/openapi/v1/models/contentVersions.js +1 -10
  25. package/lib/openapi/v1/models/contentVersions.js.map +1 -1
  26. package/lib/openapi/v1/models/dynamicModules.d.ts +3 -3
  27. package/lib/openapi/v1/models/space.d.ts +1 -9
  28. package/lib/openapi/v1/models/space.js +1 -8
  29. package/lib/openapi/v1/models/space.js.map +1 -1
  30. package/lib/openapi/v1/models/template.js +1 -1
  31. package/lib/openapi/v1/models/template.js.map +1 -1
  32. package/lib/openapi/v1/services/AnalyticsService.d.ts +4 -0
  33. package/lib/openapi/v1/services/AnalyticsService.js.map +1 -1
  34. package/lib/openapi/v1/services/ContentAttachmentsService.d.ts +0 -130
  35. package/lib/openapi/v1/services/ContentAttachmentsService.js +0 -52
  36. package/lib/openapi/v1/services/ContentAttachmentsService.js.map +1 -1
  37. package/lib/openapi/v1/services/ContentBodyService.d.ts +1 -102
  38. package/lib/openapi/v1/services/ContentBodyService.js +1 -65
  39. package/lib/openapi/v1/services/ContentBodyService.js.map +1 -1
  40. package/lib/openapi/v1/services/ContentChildrenAndDescendantsService.d.ts +5 -220
  41. package/lib/openapi/v1/services/ContentChildrenAndDescendantsService.js +4 -144
  42. package/lib/openapi/v1/services/ContentChildrenAndDescendantsService.js.map +1 -1
  43. package/lib/openapi/v1/services/ContentLabelsService.d.ts +1 -44
  44. package/lib/openapi/v1/services/ContentLabelsService.js +0 -41
  45. package/lib/openapi/v1/services/ContentLabelsService.js.map +1 -1
  46. package/lib/openapi/v1/services/ContentService.d.ts +2 -560
  47. package/lib/openapi/v1/services/ContentService.js +1 -300
  48. package/lib/openapi/v1/services/ContentService.js.map +1 -1
  49. package/lib/openapi/v1/services/ContentVersionsService.d.ts +1 -72
  50. package/lib/openapi/v1/services/ContentVersionsService.js +1 -97
  51. package/lib/openapi/v1/services/ContentVersionsService.js.map +1 -1
  52. package/lib/openapi/v1/services/GroupService.d.ts +1 -1
  53. package/lib/openapi/v1/services/GroupService.js +1 -1
  54. package/lib/openapi/v1/services/SettingsService.d.ts +0 -26
  55. package/lib/openapi/v1/services/SettingsService.js +0 -38
  56. package/lib/openapi/v1/services/SettingsService.js.map +1 -1
  57. package/lib/openapi/v1/services/SpaceService.d.ts +2 -406
  58. package/lib/openapi/v1/services/SpaceService.js +1 -215
  59. package/lib/openapi/v1/services/SpaceService.js.map +1 -1
  60. package/lib/openapi/v2/BaseConfluenceApiV2Client.d.ts +22 -3
  61. package/lib/openapi/v2/BaseConfluenceApiV2Client.js +25 -1
  62. package/lib/openapi/v2/BaseConfluenceApiV2Client.js.map +1 -1
  63. package/lib/openapi/v2/models/adminKey.d.ts +13 -0
  64. package/lib/openapi/v2/models/adminKey.js +12 -0
  65. package/lib/openapi/v2/models/adminKey.js.map +1 -0
  66. package/lib/openapi/v2/models/children.d.ts +21 -6
  67. package/lib/openapi/v2/models/children.js +10 -1
  68. package/lib/openapi/v2/models/children.js.map +1 -1
  69. package/lib/openapi/v2/models/common.d.ts +6 -0
  70. package/lib/openapi/v2/models/common.js +1 -0
  71. package/lib/openapi/v2/models/common.js.map +1 -1
  72. package/lib/openapi/v2/models/descendants.d.ts +29 -0
  73. package/lib/openapi/v2/models/descendants.js +19 -0
  74. package/lib/openapi/v2/models/descendants.js.map +1 -0
  75. package/lib/openapi/v2/services/AdminKeyService.d.ts +71 -0
  76. package/lib/openapi/v2/services/AdminKeyService.js +111 -0
  77. package/lib/openapi/v2/services/AdminKeyService.js.map +1 -0
  78. package/lib/openapi/v2/services/AttachmentService.d.ts +6 -5
  79. package/lib/openapi/v2/services/AttachmentService.js.map +1 -1
  80. package/lib/openapi/v2/services/BlogPostService.d.ts +5 -4
  81. package/lib/openapi/v2/services/BlogPostService.js.map +1 -1
  82. package/lib/openapi/v2/services/ChildrenService.d.ts +307 -1
  83. package/lib/openapi/v2/services/ChildrenService.js +321 -0
  84. package/lib/openapi/v2/services/ChildrenService.js.map +1 -1
  85. package/lib/openapi/v2/services/CommentService.d.ts +10 -8
  86. package/lib/openapi/v2/services/CommentService.js.map +1 -1
  87. package/lib/openapi/v2/services/ContentPropertiesService.d.ts +1 -1
  88. package/lib/openapi/v2/services/CustomContentService.d.ts +18 -1
  89. package/lib/openapi/v2/services/CustomContentService.js +5 -0
  90. package/lib/openapi/v2/services/CustomContentService.js.map +1 -1
  91. package/lib/openapi/v2/services/DatabaseService.d.ts +4 -6
  92. package/lib/openapi/v2/services/DatabaseService.js.map +1 -1
  93. package/lib/openapi/v2/services/DescendantsService.d.ts +346 -0
  94. package/lib/openapi/v2/services/DescendantsService.js +362 -0
  95. package/lib/openapi/v2/services/DescendantsService.js.map +1 -0
  96. package/lib/openapi/v2/services/FolderService.d.ts +4 -6
  97. package/lib/openapi/v2/services/FolderService.js.map +1 -1
  98. package/lib/openapi/v2/services/PageService.d.ts +49 -6
  99. package/lib/openapi/v2/services/PageService.js +42 -2
  100. package/lib/openapi/v2/services/PageService.js.map +1 -1
  101. package/lib/openapi/v2/services/SmartLinkService.d.ts +4 -6
  102. package/lib/openapi/v2/services/SmartLinkService.js.map +1 -1
  103. package/lib/openapi/v2/services/SpaceService.d.ts +2 -1
  104. package/lib/openapi/v2/services/SpaceService.js.map +1 -1
  105. package/lib/openapi/v2/services/WhiteboardService.d.ts +6 -8
  106. package/lib/openapi/v2/services/WhiteboardService.js.map +1 -1
  107. package/package.json +3 -3
  108. package/lib/openapi/v1/models/contentProperties.d.ts +0 -78
  109. package/lib/openapi/v1/models/contentProperties.js +0 -48
  110. package/lib/openapi/v1/models/contentProperties.js.map +0 -1
  111. package/lib/openapi/v1/models/inlineTasks.d.ts +0 -33
  112. package/lib/openapi/v1/models/inlineTasks.js +0 -36
  113. package/lib/openapi/v1/models/inlineTasks.js.map +0 -1
  114. package/lib/openapi/v1/models/spaceProperties.d.ts +0 -103
  115. package/lib/openapi/v1/models/spaceProperties.js +0 -48
  116. package/lib/openapi/v1/models/spaceProperties.js.map +0 -1
  117. package/lib/openapi/v1/services/ContentCommentsService.d.ts +0 -153
  118. package/lib/openapi/v1/services/ContentCommentsService.js +0 -81
  119. package/lib/openapi/v1/services/ContentCommentsService.js.map +0 -1
  120. package/lib/openapi/v1/services/ContentPropertiesService.d.ts +0 -203
  121. package/lib/openapi/v1/services/ContentPropertiesService.js +0 -279
  122. package/lib/openapi/v1/services/ContentPropertiesService.js.map +0 -1
  123. package/lib/openapi/v1/services/InlineTasksService.d.ts +0 -101
  124. package/lib/openapi/v1/services/InlineTasksService.js +0 -145
  125. package/lib/openapi/v1/services/InlineTasksService.js.map +0 -1
  126. package/lib/openapi/v1/services/SpacePropertiesService.d.ts +0 -177
  127. package/lib/openapi/v1/services/SpacePropertiesService.js +0 -269
  128. package/lib/openapi/v1/services/SpacePropertiesService.js.map +0 -1
@@ -95,39 +95,6 @@ class SettingsService extends CommonHttpService_1.CommonHttpService {
95
95
  }
96
96
  }).then(commonHttpClient.discardResult);
97
97
  };
98
- /**
99
- * Sets the look and feel settings to either the default settings or the
100
- * custom settings, for the site or a single space. Note, the default
101
- * space settings are inherited from the current global settings.
102
- *
103
- * **[Permissions](https://confluence.atlassian.com/x/_AozKw) required**:
104
- * 'Admin' permission for the space.
105
- *
106
- * @deprecated
107
- * @returns Returned if the look and feel settings were set.
108
- * @path PUT `/wiki/rest/api/settings/lookandfeel/selected`
109
- * @scopes-current manage:confluence-configuration
110
- * @scopes-beta read:configuration:confluence, read:space.setting:confluence, write:configuration:confluence, write:space.setting:confluence
111
- * @see https://developer.atlassian.com/cloud/confluence/rest/v1/api-group-settings#api-wiki-rest-api-settings-lookandfeel-selected-put
112
- * @param params
113
- */
114
- this.setLookAndFeelSettings = ({ spaceKey, requestBody }) => {
115
- return this.getClientInstance().request({
116
- path: "/wiki/rest/api/settings/lookandfeel/selected",
117
- method: "PUT",
118
- query: {
119
- spaceKey
120
- },
121
- headers: {
122
- "Content-Type": "application/json"
123
- },
124
- body: requestBody
125
- }).then(this.getClientInstance().responseHandler({
126
- 200: {
127
- "application/json": "json"
128
- }
129
- })).then(commonHttpClient.castResponse()).then(this.getClientInstance().validation(validationSchemaStorage_1.validationSchemaStorage.validator("SettingsService.setLookAndFeelSettings.response"))).then(commonHttpClient.getBody);
130
- };
131
98
  /**
132
99
  * Sets the look and feel settings to the default (global) settings, the
133
100
  * custom settings, or the current theme's settings for a space.
@@ -211,11 +178,6 @@ class SettingsService extends CommonHttpService_1.CommonHttpService {
211
178
  mediaType: zod_1.z.literal("application/json"),
212
179
  body: validationSchemaStorage_1.validationSchemaStorage.lazy("LookAndFeelWithLinks")
213
180
  }).describe("SettingsService.updateLookAndFeelSettings.response"));
214
- validationSchemaStorage_1.validationSchemaStorage.registerExtensible("SettingsService.setLookAndFeelSettings.response", zod_1.z.object({
215
- status: zod_1.z.literal(200),
216
- mediaType: zod_1.z.literal("application/json"),
217
- body: zod_1.z.string()
218
- }).describe("SettingsService.setLookAndFeelSettings.response"));
219
181
  validationSchemaStorage_1.validationSchemaStorage.registerExtensible("SettingsService.getSystemInfo.response", zod_1.z.object({
220
182
  status: zod_1.z.literal(200),
221
183
  mediaType: zod_1.z.literal("application/json"),
@@ -1 +1 @@
1
- {"version":3,"file":"SettingsService.js","sourceRoot":"","sources":["../../../../src/openapi/v1/services/SettingsService.ts"],"names":[],"mappings":";;;AAAA,eAAe;AACf,wDAAwD;AACxD,gDAAgD;AAChD,gEAAgE;AAChE,oEAAiE;AAEjE,iDAA8K;AAC9K,wEAAqE;AACrE,6BAAwB;AACxB;;;GAGG;AACH,MAAa,eAAgB,SAAQ,qCAAiB;IAAtD;;QACE;;;;;;;;;;;;;;;;WAgBG;QACH,2BAAsB,GAAG,CAAC,EACxB,QAAQ,KAQN,EAAE,EAAgC,EAAE;YACtC,OAAO,IAAI,CAAC,iBAAiB,EAAE,CAAC,OAAO,CAAC;gBACtC,IAAI,EAAE,qCAAqC;gBAC3C,MAAM,EAAE,KAAK;gBACb,KAAK,EAAE;oBACL,QAAQ;iBACT;aACF,CAAC,CAAC,IAAI,CAAC,IAAI,CAAC,iBAAiB,EAAE,CAAC,eAAe,CAAC;gBAC/C,GAAG,EAAE;oBACH,kBAAkB,EAAE,MAAM;iBAC3B;aACF,CAAC,CAAC,CAAC,IAAI,CAAC,gBAAgB,CAAC,YAAY,EAIlC,CAAC,CAAC,IAAI,CAAC,IAAI,CAAC,iBAAiB,EAAE,CAAC,UAAU,CAAC,iDAAuB,CAAC,SAAS,CAAC,iDAAiD,CAAC,CAAC,CAAC,CAAC,IAAI,CAAC,gBAAgB,CAAC,OAAO,CAAC,CAAC;QACvK,CAAC,CAAC;QACF;;;;;;;;;;;;;WAaG;QACH,kBAAa,GAAG,GAAqC,EAAE;YACrD,OAAO,IAAI,CAAC,iBAAiB,EAAE,CAAC,OAAO,CAAC;gBACtC,IAAI,EAAE,oCAAoC;gBAC1C,MAAM,EAAE,KAAK;aACd,CAAC,CAAC,IAAI,CAAC,IAAI,CAAC,iBAAiB,EAAE,CAAC,eAAe,CAAC;gBAC/C,GAAG,EAAE;oBACH,kBAAkB,EAAE,MAAM;iBAC3B;aACF,CAAC,CAAC,CAAC,IAAI,CAAC,gBAAgB,CAAC,YAAY,EAIlC,CAAC,CAAC,IAAI,CAAC,IAAI,CAAC,iBAAiB,EAAE,CAAC,UAAU,CAAC,iDAAuB,CAAC,SAAS,CAAC,wCAAwC,CAAC,CAAC,CAAC,CAAC,IAAI,CAAC,gBAAgB,CAAC,OAAO,CAAC,CAAC;QAC9J,CAAC,CAAC;QACF;;;;;;;;;;;;;;;WAeG;QACH,6BAAwB,GAAG,CAAC,EAC1B,QAAQ,KAQN,EAAE,EAAiB,EAAE;YACvB,OAAO,IAAI,CAAC,iBAAiB,EAAE,CAAC,OAAO,CAAC;gBACtC,IAAI,EAAE,4CAA4C;gBAClD,MAAM,EAAE,QAAQ;gBAChB,KAAK,EAAE;oBACL,QAAQ;iBACT;aACF,CAAC,CAAC,IAAI,CAAC,gBAAgB,CAAC,aAAa,CAAC,CAAC;QAC1C,CAAC,CAAC;QACF;;;;;;;;;;;;;;;WAeG;QACH,2BAAsB,GAAG,CAAC,EACxB,QAAQ,EACR,WAAW,EAUZ,EAAmB,EAAE;YACpB,OAAO,IAAI,CAAC,iBAAiB,EAAE,CAAC,OAAO,CAAC;gBACtC,IAAI,EAAE,8CAA8C;gBACpD,MAAM,EAAE,KAAK;gBACb,KAAK,EAAE;oBACL,QAAQ;iBACT;gBACD,OAAO,EAAE;oBACP,cAAc,EAAE,kBAAkB;iBACnC;gBACD,IAAI,EAAE,WAAW;aAClB,CAAC,CAAC,IAAI,CAAC,IAAI,CAAC,iBAAiB,EAAE,CAAC,eAAe,CAAC;gBAC/C,GAAG,EAAE;oBACH,kBAAkB,EAAE,MAAM;iBAC3B;aACF,CAAC,CAAC,CAAC,IAAI,CAAC,gBAAgB,CAAC,YAAY,EAIlC,CAAC,CAAC,IAAI,CAAC,IAAI,CAAC,iBAAiB,EAAE,CAAC,UAAU,CAAC,iDAAuB,CAAC,SAAS,CAAC,iDAAiD,CAAC,CAAC,CAAC,CAAC,IAAI,CAAC,gBAAgB,CAAC,OAAO,CAAC,CAAC;QACvK,CAAC,CAAC;QACF;;;;;;;;;;;;;;;;WAgBG;QACH,sBAAiB,GAAG,CAAC,EACnB,oBAAoB,EAIrB,EAAiC,EAAE;YAClC,OAAO,IAAI,CAAC,iBAAiB,EAAE,CAAC,OAAO,CAAC;gBACtC,IAAI,EAAE,qCAAqC;gBAC3C,MAAM,EAAE,KAAK;gBACb,OAAO,EAAE;oBACP,cAAc,EAAE,kBAAkB;iBACnC;gBACD,IAAI,EAAE,oBAAoB;aAC3B,CAAC,CAAC,IAAI,CAAC,IAAI,CAAC,iBAAiB,EAAE,CAAC,eAAe,CAAC;gBAC/C,GAAG,EAAE;oBACH,kBAAkB,EAAE,MAAM;iBAC3B;aACF,CAAC,CAAC,CAAC,IAAI,CAAC,gBAAgB,CAAC,YAAY,EAIlC,CAAC,CAAC,IAAI,CAAC,IAAI,CAAC,iBAAiB,EAAE,CAAC,UAAU,CAAC,iDAAuB,CAAC,SAAS,CAAC,4CAA4C,CAAC,CAAC,CAAC,CAAC,IAAI,CAAC,gBAAgB,CAAC,OAAO,CAAC,CAAC;QAClK,CAAC,CAAC;QACF;;;;;;;;;;;;;;;;;WAiBG;QACH,8BAAyB,GAAG,CAAC,EAC3B,QAAQ,EACR,WAAW,EAiBZ,EAAiC,EAAE;YAClC,OAAO,IAAI,CAAC,iBAAiB,EAAE,CAAC,OAAO,CAAC;gBACtC,IAAI,EAAE,4CAA4C;gBAClD,MAAM,EAAE,MAAM;gBACd,KAAK,EAAE;oBACL,QAAQ;iBACT;gBACD,OAAO,EAAE;oBACP,cAAc,EAAE,kBAAkB;iBACnC;gBACD,IAAI,EAAE,WAAW;aAClB,CAAC,CAAC,IAAI,CAAC,IAAI,CAAC,iBAAiB,EAAE,CAAC,eAAe,CAAC;gBAC/C,GAAG,EAAE;oBACH,kBAAkB,EAAE,MAAM;iBAC3B;aACF,CAAC,CAAC,CAAC,IAAI,CAAC,gBAAgB,CAAC,YAAY,EAIlC,CAAC,CAAC,IAAI,CAAC,IAAI,CAAC,iBAAiB,EAAE,CAAC,UAAU,CAAC,iDAAuB,CAAC,SAAS,CAAC,oDAAoD,CAAC,CAAC,CAAC,CAAC,IAAI,CAAC,gBAAgB,CAAC,OAAO,CAAC,CAAC;QAC1K,CAAC,CAAC;IA6BJ,CAAC;IA5BW,MAAM,CAAC,UAAU;QACzB,iDAAuB,CAAC,kBAAkB,CAAC,iDAAiD,EAAE,OAAC,CAAC,MAAM,CAAC;YACrG,MAAM,EAAE,OAAC,CAAC,OAAO,CAAC,GAAG,CAAC;YACtB,SAAS,EAAE,OAAC,CAAC,OAAO,CAAC,kBAAkB,CAAC;YACxC,IAAI,EAAE,iDAAuB,CAAC,IAAI,CAAC,qBAAqB,CAAC;SAC1D,CAAC,CAAC,QAAQ,CAAC,iDAAiD,CAAC,CAAC,CAAC;QAChE,iDAAuB,CAAC,kBAAkB,CAAC,4CAA4C,EAAE,OAAC,CAAC,MAAM,CAAC;YAChG,MAAM,EAAE,OAAC,CAAC,OAAO,CAAC,GAAG,CAAC;YACtB,SAAS,EAAE,OAAC,CAAC,OAAO,CAAC,kBAAkB,CAAC;YACxC,IAAI,EAAE,iDAAuB,CAAC,IAAI,CAAC,sBAAsB,CAAC;SAC3D,CAAC,CAAC,QAAQ,CAAC,4CAA4C,CAAC,CAAC,CAAC;QAC3D,iDAAuB,CAAC,kBAAkB,CAAC,oDAAoD,EAAE,OAAC,CAAC,MAAM,CAAC;YACxG,MAAM,EAAE,OAAC,CAAC,OAAO,CAAC,GAAG,CAAC;YACtB,SAAS,EAAE,OAAC,CAAC,OAAO,CAAC,kBAAkB,CAAC;YACxC,IAAI,EAAE,iDAAuB,CAAC,IAAI,CAAC,sBAAsB,CAAC;SAC3D,CAAC,CAAC,QAAQ,CAAC,oDAAoD,CAAC,CAAC,CAAC;QACnE,iDAAuB,CAAC,kBAAkB,CAAC,iDAAiD,EAAE,OAAC,CAAC,MAAM,CAAC;YACrG,MAAM,EAAE,OAAC,CAAC,OAAO,CAAC,GAAG,CAAC;YACtB,SAAS,EAAE,OAAC,CAAC,OAAO,CAAC,kBAAkB,CAAC;YACxC,IAAI,EAAE,OAAC,CAAC,MAAM,EAAE;SACjB,CAAC,CAAC,QAAQ,CAAC,iDAAiD,CAAC,CAAC,CAAC;QAChE,iDAAuB,CAAC,kBAAkB,CAAC,wCAAwC,EAAE,OAAC,CAAC,MAAM,CAAC;YAC5F,MAAM,EAAE,OAAC,CAAC,OAAO,CAAC,GAAG,CAAC;YACtB,SAAS,EAAE,OAAC,CAAC,OAAO,CAAC,kBAAkB,CAAC;YACxC,IAAI,EAAE,OAAC,CAAC,QAAQ,CAAC,iDAAuB,CAAC,IAAI,CAAC,kBAAkB,CAAC,CAAC;SACnE,CAAC,CAAC,QAAQ,CAAC,wCAAwC,CAAC,CAAC,CAAC;QACvD,iDAAuB,CAAC,YAAY,CAAC,CAAC,4CAAiC,CAAC,CAAC,CAAC;IAC5E,CAAC;CACF;AAzRD,0CAyRC"}
1
+ {"version":3,"file":"SettingsService.js","sourceRoot":"","sources":["../../../../src/openapi/v1/services/SettingsService.ts"],"names":[],"mappings":";;;AAAA,eAAe;AACf,wDAAwD;AACxD,gDAAgD;AAChD,gEAAgE;AAChE,oEAAiE;AAEjE,iDAA8K;AAC9K,wEAAqE;AACrE,6BAAwB;AACxB;;;GAGG;AACH,MAAa,eAAgB,SAAQ,qCAAiB;IAAtD;;QACE;;;;;;;;;;;;;;;;WAgBG;QACH,2BAAsB,GAAG,CAAC,EACxB,QAAQ,KAQN,EAAE,EAAgC,EAAE;YACtC,OAAO,IAAI,CAAC,iBAAiB,EAAE,CAAC,OAAO,CAAC;gBACtC,IAAI,EAAE,qCAAqC;gBAC3C,MAAM,EAAE,KAAK;gBACb,KAAK,EAAE;oBACL,QAAQ;iBACT;aACF,CAAC,CAAC,IAAI,CAAC,IAAI,CAAC,iBAAiB,EAAE,CAAC,eAAe,CAAC;gBAC/C,GAAG,EAAE;oBACH,kBAAkB,EAAE,MAAM;iBAC3B;aACF,CAAC,CAAC,CAAC,IAAI,CAAC,gBAAgB,CAAC,YAAY,EAIlC,CAAC,CAAC,IAAI,CAAC,IAAI,CAAC,iBAAiB,EAAE,CAAC,UAAU,CAAC,iDAAuB,CAAC,SAAS,CAAC,iDAAiD,CAAC,CAAC,CAAC,CAAC,IAAI,CAAC,gBAAgB,CAAC,OAAO,CAAC,CAAC;QACvK,CAAC,CAAC;QACF;;;;;;;;;;;;;WAaG;QACH,kBAAa,GAAG,GAAqC,EAAE;YACrD,OAAO,IAAI,CAAC,iBAAiB,EAAE,CAAC,OAAO,CAAC;gBACtC,IAAI,EAAE,oCAAoC;gBAC1C,MAAM,EAAE,KAAK;aACd,CAAC,CAAC,IAAI,CAAC,IAAI,CAAC,iBAAiB,EAAE,CAAC,eAAe,CAAC;gBAC/C,GAAG,EAAE;oBACH,kBAAkB,EAAE,MAAM;iBAC3B;aACF,CAAC,CAAC,CAAC,IAAI,CAAC,gBAAgB,CAAC,YAAY,EAIlC,CAAC,CAAC,IAAI,CAAC,IAAI,CAAC,iBAAiB,EAAE,CAAC,UAAU,CAAC,iDAAuB,CAAC,SAAS,CAAC,wCAAwC,CAAC,CAAC,CAAC,CAAC,IAAI,CAAC,gBAAgB,CAAC,OAAO,CAAC,CAAC;QAC9J,CAAC,CAAC;QACF;;;;;;;;;;;;;;;WAeG;QACH,6BAAwB,GAAG,CAAC,EAC1B,QAAQ,KAQN,EAAE,EAAiB,EAAE;YACvB,OAAO,IAAI,CAAC,iBAAiB,EAAE,CAAC,OAAO,CAAC;gBACtC,IAAI,EAAE,4CAA4C;gBAClD,MAAM,EAAE,QAAQ;gBAChB,KAAK,EAAE;oBACL,QAAQ;iBACT;aACF,CAAC,CAAC,IAAI,CAAC,gBAAgB,CAAC,aAAa,CAAC,CAAC;QAC1C,CAAC,CAAC;QACF;;;;;;;;;;;;;;;;WAgBG;QACH,sBAAiB,GAAG,CAAC,EACnB,oBAAoB,EAIrB,EAAiC,EAAE;YAClC,OAAO,IAAI,CAAC,iBAAiB,EAAE,CAAC,OAAO,CAAC;gBACtC,IAAI,EAAE,qCAAqC;gBAC3C,MAAM,EAAE,KAAK;gBACb,OAAO,EAAE;oBACP,cAAc,EAAE,kBAAkB;iBACnC;gBACD,IAAI,EAAE,oBAAoB;aAC3B,CAAC,CAAC,IAAI,CAAC,IAAI,CAAC,iBAAiB,EAAE,CAAC,eAAe,CAAC;gBAC/C,GAAG,EAAE;oBACH,kBAAkB,EAAE,MAAM;iBAC3B;aACF,CAAC,CAAC,CAAC,IAAI,CAAC,gBAAgB,CAAC,YAAY,EAIlC,CAAC,CAAC,IAAI,CAAC,IAAI,CAAC,iBAAiB,EAAE,CAAC,UAAU,CAAC,iDAAuB,CAAC,SAAS,CAAC,4CAA4C,CAAC,CAAC,CAAC,CAAC,IAAI,CAAC,gBAAgB,CAAC,OAAO,CAAC,CAAC;QAClK,CAAC,CAAC;QACF;;;;;;;;;;;;;;;;;WAiBG;QACH,8BAAyB,GAAG,CAAC,EAC3B,QAAQ,EACR,WAAW,EAiBZ,EAAiC,EAAE;YAClC,OAAO,IAAI,CAAC,iBAAiB,EAAE,CAAC,OAAO,CAAC;gBACtC,IAAI,EAAE,4CAA4C;gBAClD,MAAM,EAAE,MAAM;gBACd,KAAK,EAAE;oBACL,QAAQ;iBACT;gBACD,OAAO,EAAE;oBACP,cAAc,EAAE,kBAAkB;iBACnC;gBACD,IAAI,EAAE,WAAW;aAClB,CAAC,CAAC,IAAI,CAAC,IAAI,CAAC,iBAAiB,EAAE,CAAC,eAAe,CAAC;gBAC/C,GAAG,EAAE;oBACH,kBAAkB,EAAE,MAAM;iBAC3B;aACF,CAAC,CAAC,CAAC,IAAI,CAAC,gBAAgB,CAAC,YAAY,EAIlC,CAAC,CAAC,IAAI,CAAC,IAAI,CAAC,iBAAiB,EAAE,CAAC,UAAU,CAAC,iDAAuB,CAAC,SAAS,CAAC,oDAAoD,CAAC,CAAC,CAAC,CAAC,IAAI,CAAC,gBAAgB,CAAC,OAAO,CAAC,CAAC;QAC1K,CAAC,CAAC;IAwBJ,CAAC;IAvBW,MAAM,CAAC,UAAU;QACzB,iDAAuB,CAAC,kBAAkB,CAAC,iDAAiD,EAAE,OAAC,CAAC,MAAM,CAAC;YACrG,MAAM,EAAE,OAAC,CAAC,OAAO,CAAC,GAAG,CAAC;YACtB,SAAS,EAAE,OAAC,CAAC,OAAO,CAAC,kBAAkB,CAAC;YACxC,IAAI,EAAE,iDAAuB,CAAC,IAAI,CAAC,qBAAqB,CAAC;SAC1D,CAAC,CAAC,QAAQ,CAAC,iDAAiD,CAAC,CAAC,CAAC;QAChE,iDAAuB,CAAC,kBAAkB,CAAC,4CAA4C,EAAE,OAAC,CAAC,MAAM,CAAC;YAChG,MAAM,EAAE,OAAC,CAAC,OAAO,CAAC,GAAG,CAAC;YACtB,SAAS,EAAE,OAAC,CAAC,OAAO,CAAC,kBAAkB,CAAC;YACxC,IAAI,EAAE,iDAAuB,CAAC,IAAI,CAAC,sBAAsB,CAAC;SAC3D,CAAC,CAAC,QAAQ,CAAC,4CAA4C,CAAC,CAAC,CAAC;QAC3D,iDAAuB,CAAC,kBAAkB,CAAC,oDAAoD,EAAE,OAAC,CAAC,MAAM,CAAC;YACxG,MAAM,EAAE,OAAC,CAAC,OAAO,CAAC,GAAG,CAAC;YACtB,SAAS,EAAE,OAAC,CAAC,OAAO,CAAC,kBAAkB,CAAC;YACxC,IAAI,EAAE,iDAAuB,CAAC,IAAI,CAAC,sBAAsB,CAAC;SAC3D,CAAC,CAAC,QAAQ,CAAC,oDAAoD,CAAC,CAAC,CAAC;QACnE,iDAAuB,CAAC,kBAAkB,CAAC,wCAAwC,EAAE,OAAC,CAAC,MAAM,CAAC;YAC5F,MAAM,EAAE,OAAC,CAAC,OAAO,CAAC,GAAG,CAAC;YACtB,SAAS,EAAE,OAAC,CAAC,OAAO,CAAC,kBAAkB,CAAC;YACxC,IAAI,EAAE,OAAC,CAAC,QAAQ,CAAC,iDAAuB,CAAC,IAAI,CAAC,kBAAkB,CAAC,CAAC;SACnE,CAAC,CAAC,QAAQ,CAAC,wCAAwC,CAAC,CAAC,CAAC;QACvD,iDAAuB,CAAC,YAAY,CAAC,CAAC,4CAAiC,CAAC,CAAC,CAAC;IAC5E,CAAC;CACF;AAnOD,0CAmOC"}
@@ -1,6 +1,6 @@
1
1
  import { CommonHttpService } from "../../core/CommonHttpService";
2
- import { type Space, type LongTask, type ContentArray, type GenericLinks } from "../models/common";
3
- import { type SpaceArray, type SpaceCreate, type SpaceUpdate } from "../models/space";
2
+ import { type Space, type LongTask } from "../models/common";
3
+ import type { SpaceCreate, SpaceUpdate } from "../models/space";
4
4
  /**
5
5
  * @see https://developer.atlassian.com/cloud/confluence/rest/v1/api-group-space
6
6
  * @category Services
@@ -65,410 +65,6 @@ export declare class SpaceService extends CommonHttpService {
65
65
  /** The key of the space to delete. */
66
66
  spaceKey: string;
67
67
  }) => Promise<LongTask>;
68
- /**
69
- * Deprecated, use [Confluence's v2
70
- * API](https://developer.atlassian.com/cloud/confluence/rest/v2/intro/).
71
- *
72
- * Returns all content of a given type, in a space. The returned content is
73
- * ordered by content ID in ascending order.
74
- *
75
- * If the expand query parameter is used with the `body.export_view` and/or
76
- * `body.styled_view` properties, then the query limit parameter will be
77
- * restricted to a maximum value of 25.
78
- *
79
- * **[Permissions](https://confluence.atlassian.com/x/_AozKw) required**:
80
- * 'View' permission for the space. Note, the returned list will only
81
- * contain content that the current user has permission to view.
82
- *
83
- * @deprecated
84
- * @returns Returned if the requested content is returned.
85
- * @path GET `/wiki/rest/api/space/{spaceKey}/content/{type}`
86
- * @scopes-current read:confluence-content.summary
87
- * @scopes-beta read:content-details:confluence
88
- * @see https://developer.atlassian.com/cloud/confluence/rest/v1/api-group-space#api-wiki-rest-api-space-spacekey-content-type-get
89
- * @param params
90
- */
91
- getContentByTypeForSpace: ({ spaceKey, type, depth, expand, start, limit }: {
92
- /** The key of the space to be queried for its content. */
93
- spaceKey: string;
94
- /** The type of content to return. `page`, `blogpost`, `<some_customContentType>`. */
95
- type: string;
96
- /**
97
- * Filter the results to content at the root level of the space or all
98
- * content.
99
- */
100
- depth?: "all" | "root" | undefined;
101
- /**
102
- * A multi-value parameter indicating which properties of the content to expand.
103
- *
104
- * - `childTypes.all` returns whether the content has attachments, comments, or
105
- * child pages/whiteboards.
106
- * Use this if you only need to check whether the content has children of a
107
- * particular type.
108
- * - `childTypes.attachment` returns whether the content has attachments.
109
- * - `childTypes.comment` returns whether the content has comments.
110
- * - `childTypes.page` returns whether the content has child pages.
111
- * - `childTypes.whiteboard` returns whether the content has child whiteboards.
112
- * - `childTypes.database` returns whether the content has child databases.
113
- * - `childTypes.embed` returns whether the content has child embeds (smartlinks).
114
- * - `childTypes.folder` returns whether the content has child folders.
115
- * - `container` returns the space that the content is in. This is the same as the
116
- * information
117
- * returned by [Get space](#api-space-spaceKey-get).
118
- * - `metadata.currentuser` returns information about the current user in relation
119
- * to the content,
120
- * including when they last viewed it, modified it, contributed to it, or added it
121
- * as a favorite.
122
- * - `metadata.properties` returns content properties that have been set via the
123
- * Confluence REST API.
124
- * - `metadata.labels` returns the labels that have been added to the content.
125
- * - `metadata.frontend` this property is only used by Atlassian.
126
- * - `operations` returns the operations for the content, which are used when
127
- * setting permissions.
128
- * - `children.page` returns pages that are descendants at the level immediately
129
- * below the content.
130
- * - `children.whiteboard` returns whiteboards that are descendants at the level
131
- * immediately below the content.
132
- * - `children.database` returns databases that are descendants at the level
133
- * immediately below the content.
134
- * - `children.embed` returns embeds (smartlinks) that are descendants at the
135
- * level immediately below the content.
136
- * - `children.folder` returns folders that are descendants at the level
137
- * immediately below the content.
138
- * - `children.attachment` returns all attachments for the content.
139
- * - `children.comment` returns all comments on the content.
140
- * - `restrictions.read.restrictions.user` returns the users that have permission
141
- * to read the content.
142
- * - `restrictions.read.restrictions.group` returns the groups that have
143
- * permission to read the content. Note that
144
- * this may return deleted groups, because deleting a group doesn't remove
145
- * associated restrictions.
146
- * - `restrictions.update.restrictions.user` returns the users that have
147
- * permission to update the content.
148
- * - `restrictions.update.restrictions.group` returns the groups that have
149
- * permission to update the content. Note that
150
- * this may return deleted groups because deleting a group doesn't remove
151
- * associated restrictions.
152
- * - `history` returns the history of the content, including the date it was
153
- * created.
154
- * - `history.lastUpdated` returns information about the most recent update of the
155
- * content, including
156
- * who updated it and when it was updated.
157
- * - `history.previousVersion` returns information about the update prior to the
158
- * current content update.
159
- * - `history.contributors` returns all of the users who have contributed to the
160
- * content.
161
- * - `history.nextVersion` returns information about the update after to the
162
- * current content update.
163
- * - `ancestors` returns the parent content, if the content is a page or
164
- * whiteboard.
165
- * - `body` returns the body of the content in different formats, including the
166
- * editor format,
167
- * view format, and export format.
168
- * - `body.storage` returns the body of content in storage format.
169
- * - `body.view` returns the body of content in view format.
170
- * - `version` returns information about the most recent update of the content,
171
- * including who updated it
172
- * and when it was updated.
173
- * - `descendants.page` returns pages that are descendants at any level below the
174
- * content.
175
- * - `descendants.whiteboard` returns whiteboards that are descendants at any
176
- * level below the content.
177
- * - `descendants.database` returns databases that are descendants at any level
178
- * below the content.
179
- * - `descendants.embed` returns embeds (smartlinks) that are descendants at any
180
- * level below the content.
181
- * - `descendants.folder` returns folders that are descendants at any level below
182
- * the content.
183
- * - `descendants.attachment` returns all attachments for the content, same as
184
- * `children.attachment`.
185
- * - `descendants.comment` returns all comments on the content, same as
186
- * `children.comment`.
187
- * - `space` returns the space that the content is in. This is the same as the
188
- * information returned by
189
- * [Get space](#api-space-spaceKey-get).
190
- *
191
- * In addition, the following comment-specific expansions can be used:
192
- * - `extensions.inlineProperties` returns inline comment-specific properties.
193
- * - `extensions.resolution` returns the resolution status of each comment.
194
- */
195
- expand?: string[] | undefined;
196
- /** The starting index of the returned content. */
197
- start?: number | undefined;
198
- /**
199
- * The maximum number of content objects to return per page. Note, this
200
- * may be restricted by fixed system limits.
201
- */
202
- limit?: number | undefined;
203
- }) => Promise<ContentArray>;
204
- /**
205
- * Deprecated, use [Confluence's v2
206
- * API](https://developer.atlassian.com/cloud/confluence/rest/v2/intro/).
207
- *
208
- * Returns all content in a space. The returned content is grouped by type
209
- * (pages then blogposts), then ordered by content ID in ascending order.
210
- *
211
- * If the expand query parameter is used with the `body.export_view` and/or
212
- * `body.styled_view` properties, then the query limit parameter will be
213
- * restricted to a maximum value of 25.
214
- *
215
- * **[Permissions](https://confluence.atlassian.com/x/_AozKw) required**:
216
- * 'View' permission for the space. Note, the returned list will only
217
- * contain content that the current user has permission to view.
218
- *
219
- * @deprecated
220
- * @returns Returned if the requested content is returned.
221
- * @path GET `/wiki/rest/api/space/{spaceKey}/content`
222
- * @scopes-current read:confluence-content.summary
223
- * @scopes-beta read:content-details:confluence
224
- * @see https://developer.atlassian.com/cloud/confluence/rest/v1/api-group-space#api-wiki-rest-api-space-spacekey-content-get
225
- * @param params
226
- */
227
- getContentForSpace: ({ spaceKey, depth, expand, start, limit }: {
228
- /** The key of the space to be queried for its content. */
229
- spaceKey: string;
230
- /** Filter the results to content at the root level of the space or all content. */
231
- depth?: "all" | "root" | undefined;
232
- /**
233
- * A multi-value parameter indicating which properties of the content to expand.
234
- *
235
- * - `childTypes.all` returns whether the content has attachments, comments, or
236
- * child pages/whiteboards.
237
- * Use this if you only need to check whether the content has children of a
238
- * particular type.
239
- * - `childTypes.attachment` returns whether the content has attachments.
240
- * - `childTypes.comment` returns whether the content has comments.
241
- * - `childTypes.page` returns whether the content has child pages.
242
- * - `childTypes.whiteboard` returns whether the content has child whiteboards.
243
- * - `childTypes.database` returns whether the content has child databases.
244
- * - `childTypes.embed` returns whether the content has child embeds (smartlinks).
245
- * - `childTypes.folder` returns whether the content has child folders.
246
- * - `container` returns the space that the content is in. This is the same as the
247
- * information
248
- * returned by [Get space](#api-space-spaceKey-get).
249
- * - `metadata.currentuser` returns information about the current user in relation
250
- * to the content,
251
- * including when they last viewed it, modified it, contributed to it, or added it
252
- * as a favorite.
253
- * - `metadata.properties` returns content properties that have been set via the
254
- * Confluence REST API.
255
- * - `metadata.labels` returns the labels that have been added to the content.
256
- * - `metadata.frontend` this property is only used by Atlassian.
257
- * - `operations` returns the operations for the content, which are used when
258
- * setting permissions.
259
- * - `children.page` returns pages that are descendants at the level immediately
260
- * below the content.
261
- * - `children.whiteboard` returns whiteboards that are descendants at the level
262
- * immediately below the content.
263
- * - `children.database` returns databases that are descendants at the level
264
- * immediately below the content.
265
- * - `children.embed` returns embeds (smartlinks) that are descendants at the
266
- * level immediately below the content.
267
- * - `children.folder` returns folders that are descendants at the level
268
- * immediately below the content.
269
- * - `children.attachment` returns all attachments for the content.
270
- * - `children.comment` returns all comments on the content.
271
- * - `restrictions.read.restrictions.user` returns the users that have permission
272
- * to read the content.
273
- * - `restrictions.read.restrictions.group` returns the groups that have
274
- * permission to read the content. Note that
275
- * this may return deleted groups, because deleting a group doesn't remove
276
- * associated restrictions.
277
- * - `restrictions.update.restrictions.user` returns the users that have
278
- * permission to update the content.
279
- * - `restrictions.update.restrictions.group` returns the groups that have
280
- * permission to update the content. Note that
281
- * this may return deleted groups because deleting a group doesn't remove
282
- * associated restrictions.
283
- * - `history` returns the history of the content, including the date it was
284
- * created.
285
- * - `history.lastUpdated` returns information about the most recent update of the
286
- * content, including
287
- * who updated it and when it was updated.
288
- * - `history.previousVersion` returns information about the update prior to the
289
- * current content update.
290
- * - `history.contributors` returns all of the users who have contributed to the
291
- * content.
292
- * - `history.nextVersion` returns information about the update after to the
293
- * current content update.
294
- * - `ancestors` returns the parent content, if the content is a page or
295
- * whiteboard.
296
- * - `body` returns the body of the content in different formats, including the
297
- * editor format,
298
- * view format, and export format.
299
- * - `body.storage` returns the body of content in storage format.
300
- * - `body.view` returns the body of content in view format.
301
- * - `version` returns information about the most recent update of the content,
302
- * including who updated it
303
- * and when it was updated.
304
- * - `descendants.page` returns pages that are descendants at any level below the
305
- * content.
306
- * - `descendants.whiteboard` returns whiteboards that are descendants at any
307
- * level below the content.
308
- * - `descendants.database` returns databases that are descendants at any level
309
- * below the content.
310
- * - `descendants.embed` returns embeds (smartlinks) that are descendants at any
311
- * level below the content.
312
- * - `descendants.folder` returns folders that are descendants at any level below
313
- * the content.
314
- * - `descendants.attachment` returns all attachments for the content, same as
315
- * `children.attachment`.
316
- * - `descendants.comment` returns all comments on the content, same as
317
- * `children.comment`.
318
- * - `space` returns the space that the content is in. This is the same as the
319
- * information returned by
320
- * [Get space](#api-space-spaceKey-get).
321
- *
322
- * In addition, the following comment-specific expansions can be used:
323
- * - `extensions.inlineProperties` returns inline comment-specific properties.
324
- * - `extensions.resolution` returns the resolution status of each comment.
325
- */
326
- expand?: string[] | undefined;
327
- /** The starting index of the returned content. */
328
- start?: number | undefined;
329
- /**
330
- * The maximum number of content objects to return per page. Note, this
331
- * may be restricted by fixed system limits.
332
- */
333
- limit?: number | undefined;
334
- }) => Promise<{
335
- page?: ContentArray | undefined;
336
- blogpost?: ContentArray | undefined;
337
- _links?: GenericLinks | undefined;
338
- } & {
339
- [key: string]: unknown;
340
- }>;
341
- /**
342
- * Deprecated, use [Confluence's v2
343
- * API](https://developer.atlassian.com/cloud/confluence/rest/v2/intro/).
344
- *
345
- * Returns a space. This includes information like the name, description,
346
- * and permissions, but not the content in the space.
347
- *
348
- * **[Permissions](https://confluence.atlassian.com/x/_AozKw) required**:
349
- * 'View' permission for the space.
350
- *
351
- * @deprecated
352
- * @returns Returned if the requested space is returned.
353
- * @path GET `/wiki/rest/api/space/{spaceKey}`
354
- * @scopes-current read:confluence-space.summary
355
- * @scopes-beta read:content-details:confluence
356
- * @see https://developer.atlassian.com/cloud/confluence/rest/v1/api-group-space#api-wiki-rest-api-space-spacekey-get
357
- * @param params
358
- */
359
- getSpace: ({ spaceKey, expand }: {
360
- /** The key of the space to be returned. */
361
- spaceKey: string;
362
- /**
363
- * A multi-value parameter indicating which properties of the spaces to
364
- * expand, where:
365
- *
366
- * - `settings` returns the settings for the space, similar to [Get space
367
- * settings](#api-space-spaceKey-settings-get).
368
- * - `metadata` returns the space metadata.
369
- * - `metadata.labels` returns the space labels, which are used to categorize
370
- * the space.
371
- * - `operations` returns the operations for a space, which are used when
372
- * setting permissions.
373
- * - `lookAndFeel` returns information about the look and feel of the space,
374
- * including the color scheme.
375
- * - `permissions` returns the permissions for the space. Note that this may
376
- * return permissions for deleted groups,
377
- * because deleting a group doesn't remove associated space permissions.
378
- * - `icon` returns information about space icon.
379
- * - `description` returns the description of the space.
380
- * - `description.plain` returns the description of the space, the plain format.
381
- * - `description.view` returns the description of the space, the view format.
382
- * - `theme` returns information about the space theme.
383
- * - `homepage` returns information about the space homepage.
384
- * - `history` returns information about the history of the space.
385
- */
386
- expand?: ("metadata" | "description" | "history" | "settings" | "icon" | "homepage" | "operations" | "permissions" | "theme" | "lookAndFeel" | "metadata.labels" | "description.plain" | "description.view")[] | undefined;
387
- }) => Promise<Space | null>;
388
- /**
389
- * Deprecated, use [Confluence's v2
390
- * API](https://developer.atlassian.com/cloud/confluence/rest/v2/intro/).
391
- *
392
- * Returns all spaces. The returned spaces are ordered alphabetically in
393
- * ascending order by space key.
394
- *
395
- * **[Permissions](https://confluence.atlassian.com/x/_AozKw) required**:
396
- * Permission to access the Confluence site ('Can use' global permission).
397
- * Note, the returned list will only contain spaces that the current user
398
- * has permission to view.
399
- *
400
- * @deprecated
401
- * @returns Returned if the requested spaces are returned.
402
- * @path GET `/wiki/rest/api/space`
403
- * @scopes-current read:confluence-space.summary
404
- * @scopes-beta read:content-details:confluence
405
- * @see https://developer.atlassian.com/cloud/confluence/rest/v1/api-group-space#api-wiki-rest-api-space-get
406
- * @param params
407
- */
408
- getSpaces: ({ spaceKey, spaceId, type, status, label, favourite, favouriteUserKey, expand, start, limit }?: {
409
- /**
410
- * The key of the space to be returned. To return multiple spaces,
411
- * specify this parameter multiple times with different values.
412
- */
413
- spaceKey?: string[] | undefined;
414
- /**
415
- * The id of the space to be returned. To return multiple spaces,
416
- * specify this parameter multiple times with different values.
417
- */
418
- spaceId?: number[] | undefined;
419
- /** Filter the results to spaces based on their type. */
420
- type?: "global" | "personal" | "collaboration" | "knowledge_base" | undefined;
421
- /** Filter the results to spaces based on their status. */
422
- status?: "current" | "archived" | undefined;
423
- /** Filter the results to spaces based on their label. */
424
- label?: string[] | undefined;
425
- /**
426
- * Filter the results to the favourite spaces of the user specified by
427
- * `favouriteUserKey`. Note, 'favourite' spaces are also
428
- * known as 'saved for later' spaces.
429
- */
430
- favourite?: boolean | undefined;
431
- /**
432
- * The userKey of the user, whose favourite spaces are used to filter
433
- * the results when using the `favourite` parameter.
434
- *
435
- * Leave blank for the current user. Use [Get user](#api-user-get) to
436
- * get the userKey for a user.
437
- */
438
- favouriteUserKey?: string | undefined;
439
- /**
440
- * A multi-value parameter indicating which properties of the spaces to
441
- * expand, where:
442
- *
443
- * - `settings` returns the settings for the space, similar to [Get space
444
- * settings](#api-space-spaceKey-settings-get).
445
- * - `metadata` returns the space metadata.
446
- * - `metadata.labels` returns the space labels, which are used to categorize
447
- * the space.
448
- * - `operations` returns the operations for a space, which are used when
449
- * setting permissions.
450
- * - `lookAndFeel` returns information about the look and feel of the space,
451
- * including the color scheme.
452
- * - `permissions` returns the permissions for the space. Note that this may
453
- * return permissions for deleted groups,
454
- * because deleting a group doesn't remove associated space permissions.
455
- * - `icon` returns information about space icon.
456
- * - `description` returns the description of the space.
457
- * - `description.plain` returns the description of the space, the plain format.
458
- * - `description.view` returns the description of the space, the view format.
459
- * - `theme` returns information about the space theme.
460
- * - `homepage` returns information about the space homepage.
461
- * - `history` returns information about the history of the space.
462
- */
463
- expand?: ("metadata" | "description" | "history" | "settings" | "icon" | "homepage" | "operations" | "permissions" | "theme" | "lookAndFeel" | "metadata.labels" | "description.plain" | "description.view")[] | undefined;
464
- /** The starting index of the returned spaces. */
465
- start?: number | undefined;
466
- /**
467
- * The maximum number of spaces to return per page. Note, this may be
468
- * restricted by fixed system limits.
469
- */
470
- limit?: number | undefined;
471
- }) => Promise<SpaceArray>;
472
68
  /**
473
69
  * Updates the name, description, or homepage of a space.
474
70
  *