@resolution/confluence-api-client 0.2.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.
- package/CHANGELOG.md +11 -0
- package/LICENSE.md +19 -0
- package/README.md +12 -0
- package/lib/index.d.ts +36 -0
- package/lib/index.js +64 -0
- package/lib/index.js.map +1 -0
- package/lib/openapi/v1/BaseConfluenceApiV1Client.d.ts +133 -0
- package/lib/openapi/v1/BaseConfluenceApiV1Client.js +122 -0
- package/lib/openapi/v1/BaseConfluenceApiV1Client.js.map +1 -0
- package/lib/openapi/v1/core/CommonHttpClient.d.ts +196 -0
- package/lib/openapi/v1/core/CommonHttpClient.js +390 -0
- package/lib/openapi/v1/core/CommonHttpClient.js.map +1 -0
- package/lib/openapi/v1/core/CommonHttpService.d.ts +7 -0
- package/lib/openapi/v1/core/CommonHttpService.js +20 -0
- package/lib/openapi/v1/core/CommonHttpService.js.map +1 -0
- package/lib/openapi/v1/core/CommonValidationSchemaStorage.d.ts +35 -0
- package/lib/openapi/v1/core/CommonValidationSchemaStorage.js +65 -0
- package/lib/openapi/v1/core/CommonValidationSchemaStorage.js.map +1 -0
- package/lib/openapi/v1/models/audit.d.ts +151 -0
- package/lib/openapi/v1/models/audit.js +133 -0
- package/lib/openapi/v1/models/audit.js.map +1 -0
- package/lib/openapi/v1/models/common.d.ts +645 -0
- package/lib/openapi/v1/models/common.js +654 -0
- package/lib/openapi/v1/models/common.js.map +1 -0
- package/lib/openapi/v1/models/content.d.ts +554 -0
- package/lib/openapi/v1/models/content.js +613 -0
- package/lib/openapi/v1/models/content.js.map +1 -0
- package/lib/openapi/v1/models/contentAttachments.d.ts +26 -0
- package/lib/openapi/v1/models/contentAttachments.js +33 -0
- package/lib/openapi/v1/models/contentAttachments.js.map +1 -0
- package/lib/openapi/v1/models/contentBody.d.ts +36 -0
- package/lib/openapi/v1/models/contentBody.js +63 -0
- package/lib/openapi/v1/models/contentBody.js.map +1 -0
- package/lib/openapi/v1/models/contentChildrenAndDescendants.d.ts +75 -0
- package/lib/openapi/v1/models/contentChildrenAndDescendants.js +66 -0
- package/lib/openapi/v1/models/contentChildrenAndDescendants.js.map +1 -0
- package/lib/openapi/v1/models/contentLabels.d.ts +5 -0
- package/lib/openapi/v1/models/contentLabels.js +16 -0
- package/lib/openapi/v1/models/contentLabels.js.map +1 -0
- package/lib/openapi/v1/models/contentMacroBody.d.ts +12 -0
- package/lib/openapi/v1/models/contentMacroBody.js +22 -0
- package/lib/openapi/v1/models/contentMacroBody.js.map +1 -0
- package/lib/openapi/v1/models/contentPermissions.d.ts +41 -0
- package/lib/openapi/v1/models/contentPermissions.js +35 -0
- package/lib/openapi/v1/models/contentPermissions.js.map +1 -0
- package/lib/openapi/v1/models/contentProperties.d.ts +73 -0
- package/lib/openapi/v1/models/contentProperties.js +94 -0
- package/lib/openapi/v1/models/contentProperties.js.map +1 -0
- package/lib/openapi/v1/models/contentRestrictions.d.ts +65 -0
- package/lib/openapi/v1/models/contentRestrictions.js +78 -0
- package/lib/openapi/v1/models/contentRestrictions.js.map +1 -0
- package/lib/openapi/v1/models/contentStates.d.ts +75 -0
- package/lib/openapi/v1/models/contentStates.js +72 -0
- package/lib/openapi/v1/models/contentStates.js.map +1 -0
- package/lib/openapi/v1/models/contentVersions.d.ts +28 -0
- package/lib/openapi/v1/models/contentVersions.js +36 -0
- package/lib/openapi/v1/models/contentVersions.js.map +1 -0
- package/lib/openapi/v1/models/contentWatches.d.ts +89 -0
- package/lib/openapi/v1/models/contentWatches.js +81 -0
- package/lib/openapi/v1/models/contentWatches.js.map +1 -0
- package/lib/openapi/v1/models/dynamicModules.d.ts +62 -0
- package/lib/openapi/v1/models/dynamicModules.js +24 -0
- package/lib/openapi/v1/models/dynamicModules.js.map +1 -0
- package/lib/openapi/v1/models/group.d.ts +9 -0
- package/lib/openapi/v1/models/group.js +23 -0
- package/lib/openapi/v1/models/group.js.map +1 -0
- package/lib/openapi/v1/models/inlineTasks.d.ts +30 -0
- package/lib/openapi/v1/models/inlineTasks.js +48 -0
- package/lib/openapi/v1/models/inlineTasks.js.map +1 -0
- package/lib/openapi/v1/models/labelInfo.d.ts +21 -0
- package/lib/openapi/v1/models/labelInfo.js +42 -0
- package/lib/openapi/v1/models/labelInfo.js.map +1 -0
- package/lib/openapi/v1/models/longRunningTask.d.ts +116 -0
- package/lib/openapi/v1/models/longRunningTask.js +82 -0
- package/lib/openapi/v1/models/longRunningTask.js.map +1 -0
- package/lib/openapi/v1/models/relation.d.ts +30 -0
- package/lib/openapi/v1/models/relation.js +61 -0
- package/lib/openapi/v1/models/relation.js.map +1 -0
- package/lib/openapi/v1/models/search.d.ts +41 -0
- package/lib/openapi/v1/models/search.js +65 -0
- package/lib/openapi/v1/models/search.js.map +1 -0
- package/lib/openapi/v1/models/settings.d.ts +36 -0
- package/lib/openapi/v1/models/settings.js +50 -0
- package/lib/openapi/v1/models/settings.js.map +1 -0
- package/lib/openapi/v1/models/space.d.ts +118 -0
- package/lib/openapi/v1/models/space.js +94 -0
- package/lib/openapi/v1/models/space.js.map +1 -0
- package/lib/openapi/v1/models/spacePermissions.d.ts +128 -0
- package/lib/openapi/v1/models/spacePermissions.js +102 -0
- package/lib/openapi/v1/models/spacePermissions.js.map +1 -0
- package/lib/openapi/v1/models/spaceProperties.d.ts +96 -0
- package/lib/openapi/v1/models/spaceProperties.js +93 -0
- package/lib/openapi/v1/models/spaceProperties.js.map +1 -0
- package/lib/openapi/v1/models/spaceSettings.d.ts +14 -0
- package/lib/openapi/v1/models/spaceSettings.js +17 -0
- package/lib/openapi/v1/models/spaceSettings.js.map +1 -0
- package/lib/openapi/v1/models/template.d.ts +201 -0
- package/lib/openapi/v1/models/template.js +163 -0
- package/lib/openapi/v1/models/template.js.map +1 -0
- package/lib/openapi/v1/models/themes.d.ts +26 -0
- package/lib/openapi/v1/models/themes.js +38 -0
- package/lib/openapi/v1/models/themes.js.map +1 -0
- package/lib/openapi/v1/models/userProperties.d.ts +41 -0
- package/lib/openapi/v1/models/userProperties.js +50 -0
- package/lib/openapi/v1/models/userProperties.js.map +1 -0
- package/lib/openapi/v1/models/users.d.ts +98 -0
- package/lib/openapi/v1/models/users.js +87 -0
- package/lib/openapi/v1/models/users.js.map +1 -0
- package/lib/openapi/v1/services/AnalyticsService.d.ts +54 -0
- package/lib/openapi/v1/services/AnalyticsService.js +98 -0
- package/lib/openapi/v1/services/AnalyticsService.js.map +1 -0
- package/lib/openapi/v1/services/AuditService.d.ts +163 -0
- package/lib/openapi/v1/services/AuditService.js +269 -0
- package/lib/openapi/v1/services/AuditService.js.map +1 -0
- package/lib/openapi/v1/services/ContentAttachmentsService.d.ts +332 -0
- package/lib/openapi/v1/services/ContentAttachmentsService.js +362 -0
- package/lib/openapi/v1/services/ContentAttachmentsService.js.map +1 -0
- package/lib/openapi/v1/services/ContentBodyService.d.ts +227 -0
- package/lib/openapi/v1/services/ContentBodyService.js +178 -0
- package/lib/openapi/v1/services/ContentBodyService.js.map +1 -0
- package/lib/openapi/v1/services/ContentChildrenAndDescendantsService.d.ts +621 -0
- package/lib/openapi/v1/services/ContentChildrenAndDescendantsService.js +453 -0
- package/lib/openapi/v1/services/ContentChildrenAndDescendantsService.js.map +1 -0
- package/lib/openapi/v1/services/ContentCommentsService.d.ts +147 -0
- package/lib/openapi/v1/services/ContentCommentsService.js +72 -0
- package/lib/openapi/v1/services/ContentCommentsService.js.map +1 -0
- package/lib/openapi/v1/services/ContentLabelsService.d.ts +122 -0
- package/lib/openapi/v1/services/ContentLabelsService.js +176 -0
- package/lib/openapi/v1/services/ContentLabelsService.js.map +1 -0
- package/lib/openapi/v1/services/ContentMacroBodyService.d.ts +268 -0
- package/lib/openapi/v1/services/ContentMacroBodyService.js +193 -0
- package/lib/openapi/v1/services/ContentMacroBodyService.js.map +1 -0
- package/lib/openapi/v1/services/ContentPermissionsService.d.ts +34 -0
- package/lib/openapi/v1/services/ContentPermissionsService.js +72 -0
- package/lib/openapi/v1/services/ContentPermissionsService.js.map +1 -0
- package/lib/openapi/v1/services/ContentPropertiesService.d.ts +187 -0
- package/lib/openapi/v1/services/ContentPropertiesService.js +285 -0
- package/lib/openapi/v1/services/ContentPropertiesService.js.map +1 -0
- package/lib/openapi/v1/services/ContentRestrictionsService.d.ts +503 -0
- package/lib/openapi/v1/services/ContentRestrictionsService.js +552 -0
- package/lib/openapi/v1/services/ContentRestrictionsService.js.map +1 -0
- package/lib/openapi/v1/services/ContentService.d.ts +1012 -0
- package/lib/openapi/v1/services/ContentService.js +548 -0
- package/lib/openapi/v1/services/ContentService.js.map +1 -0
- package/lib/openapi/v1/services/ContentStatesService.d.ts +220 -0
- package/lib/openapi/v1/services/ContentStatesService.js +439 -0
- package/lib/openapi/v1/services/ContentStatesService.js.map +1 -0
- package/lib/openapi/v1/services/ContentVersionsService.d.ts +121 -0
- package/lib/openapi/v1/services/ContentVersionsService.js +181 -0
- package/lib/openapi/v1/services/ContentVersionsService.js.map +1 -0
- package/lib/openapi/v1/services/ContentWatchesService.d.ts +550 -0
- package/lib/openapi/v1/services/ContentWatchesService.js +502 -0
- package/lib/openapi/v1/services/ContentWatchesService.js.map +1 -0
- package/lib/openapi/v1/services/DynamicModulesService.d.ts +47 -0
- package/lib/openapi/v1/services/DynamicModulesService.js +92 -0
- package/lib/openapi/v1/services/DynamicModulesService.js.map +1 -0
- package/lib/openapi/v1/services/ExperimentalService.d.ts +113 -0
- package/lib/openapi/v1/services/ExperimentalService.js +185 -0
- package/lib/openapi/v1/services/ExperimentalService.js.map +1 -0
- package/lib/openapi/v1/services/GroupService.d.ts +379 -0
- package/lib/openapi/v1/services/GroupService.js +515 -0
- package/lib/openapi/v1/services/GroupService.js.map +1 -0
- package/lib/openapi/v1/services/InlineTasksService.d.ts +91 -0
- package/lib/openapi/v1/services/InlineTasksService.js +155 -0
- package/lib/openapi/v1/services/InlineTasksService.js.map +1 -0
- package/lib/openapi/v1/services/LabelInfoService.d.ts +28 -0
- package/lib/openapi/v1/services/LabelInfoService.js +59 -0
- package/lib/openapi/v1/services/LabelInfoService.js.map +1 -0
- package/lib/openapi/v1/services/LongRunningTaskService.d.ts +43 -0
- package/lib/openapi/v1/services/LongRunningTaskService.js +96 -0
- package/lib/openapi/v1/services/LongRunningTaskService.js.map +1 -0
- package/lib/openapi/v1/services/RelationService.d.ts +404 -0
- package/lib/openapi/v1/services/RelationService.js +270 -0
- package/lib/openapi/v1/services/RelationService.js.map +1 -0
- package/lib/openapi/v1/services/SearchService.d.ts +175 -0
- package/lib/openapi/v1/services/SearchService.js +164 -0
- package/lib/openapi/v1/services/SearchService.js.map +1 -0
- package/lib/openapi/v1/services/SettingsService.d.ts +143 -0
- package/lib/openapi/v1/services/SettingsService.js +249 -0
- package/lib/openapi/v1/services/SettingsService.js.map +1 -0
- package/lib/openapi/v1/services/SpacePermissionsService.d.ts +68 -0
- package/lib/openapi/v1/services/SpacePermissionsService.js +121 -0
- package/lib/openapi/v1/services/SpacePermissionsService.js.map +1 -0
- package/lib/openapi/v1/services/SpacePropertiesService.d.ts +161 -0
- package/lib/openapi/v1/services/SpacePropertiesService.js +275 -0
- package/lib/openapi/v1/services/SpacePropertiesService.js.map +1 -0
- package/lib/openapi/v1/services/SpaceService.d.ts +479 -0
- package/lib/openapi/v1/services/SpaceService.js +394 -0
- package/lib/openapi/v1/services/SpaceService.js.map +1 -0
- package/lib/openapi/v1/services/SpaceSettingsService.d.ts +40 -0
- package/lib/openapi/v1/services/SpaceSettingsService.js +96 -0
- package/lib/openapi/v1/services/SpaceSettingsService.js.map +1 -0
- package/lib/openapi/v1/services/TemplateService.d.ts +163 -0
- package/lib/openapi/v1/services/TemplateService.js +259 -0
- package/lib/openapi/v1/services/TemplateService.js.map +1 -0
- package/lib/openapi/v1/services/ThemesService.d.ts +101 -0
- package/lib/openapi/v1/services/ThemesService.js +228 -0
- package/lib/openapi/v1/services/ThemesService.js.map +1 -0
- package/lib/openapi/v1/services/UserPropertiesService.d.ts +129 -0
- package/lib/openapi/v1/services/UserPropertiesService.js +192 -0
- package/lib/openapi/v1/services/UserPropertiesService.js.map +1 -0
- package/lib/openapi/v1/services/UsersService.d.ts +181 -0
- package/lib/openapi/v1/services/UsersService.js +291 -0
- package/lib/openapi/v1/services/UsersService.js.map +1 -0
- package/lib/openapi/v1/validationSchemaStorage.d.ts +3 -0
- package/lib/openapi/v1/validationSchemaStorage.js +144 -0
- package/lib/openapi/v1/validationSchemaStorage.js.map +1 -0
- package/lib/openapi/v2/BaseConfluenceApiV2Client.d.ts +88 -0
- package/lib/openapi/v2/BaseConfluenceApiV2Client.js +87 -0
- package/lib/openapi/v2/BaseConfluenceApiV2Client.js.map +1 -0
- package/lib/openapi/v2/core/CommonHttpClient.d.ts +196 -0
- package/lib/openapi/v2/core/CommonHttpClient.js +390 -0
- package/lib/openapi/v2/core/CommonHttpClient.js.map +1 -0
- package/lib/openapi/v2/core/CommonHttpService.d.ts +7 -0
- package/lib/openapi/v2/core/CommonHttpService.js +20 -0
- package/lib/openapi/v2/core/CommonHttpService.js.map +1 -0
- package/lib/openapi/v2/core/CommonValidationSchemaStorage.d.ts +35 -0
- package/lib/openapi/v2/core/CommonValidationSchemaStorage.js +65 -0
- package/lib/openapi/v2/core/CommonValidationSchemaStorage.js.map +1 -0
- package/lib/openapi/v2/models/ancestors.d.ts +11 -0
- package/lib/openapi/v2/models/ancestors.js +21 -0
- package/lib/openapi/v2/models/ancestors.js.map +1 -0
- package/lib/openapi/v2/models/attachment.d.ts +148 -0
- package/lib/openapi/v2/models/attachment.js +116 -0
- package/lib/openapi/v2/models/attachment.js.map +1 -0
- package/lib/openapi/v2/models/blogPost.d.ts +106 -0
- package/lib/openapi/v2/models/blogPost.js +134 -0
- package/lib/openapi/v2/models/blogPost.js.map +1 -0
- package/lib/openapi/v2/models/children.d.ts +29 -0
- package/lib/openapi/v2/models/children.js +38 -0
- package/lib/openapi/v2/models/children.js.map +1 -0
- package/lib/openapi/v2/models/classificationLevel.d.ts +28 -0
- package/lib/openapi/v2/models/classificationLevel.js +45 -0
- package/lib/openapi/v2/models/classificationLevel.js.map +1 -0
- package/lib/openapi/v2/models/comment.d.ts +396 -0
- package/lib/openapi/v2/models/comment.js +378 -0
- package/lib/openapi/v2/models/comment.js.map +1 -0
- package/lib/openapi/v2/models/common.d.ts +200 -0
- package/lib/openapi/v2/models/common.js +225 -0
- package/lib/openapi/v2/models/common.js.map +1 -0
- package/lib/openapi/v2/models/content.d.ts +16 -0
- package/lib/openapi/v2/models/content.js +29 -0
- package/lib/openapi/v2/models/content.js.map +1 -0
- package/lib/openapi/v2/models/contentProperties.d.ts +33 -0
- package/lib/openapi/v2/models/contentProperties.js +33 -0
- package/lib/openapi/v2/models/contentProperties.js.map +1 -0
- package/lib/openapi/v2/models/customContent.d.ts +174 -0
- package/lib/openapi/v2/models/customContent.js +163 -0
- package/lib/openapi/v2/models/customContent.js.map +1 -0
- package/lib/openapi/v2/models/dataPolicies.d.ts +34 -0
- package/lib/openapi/v2/models/dataPolicies.js +38 -0
- package/lib/openapi/v2/models/dataPolicies.js.map +1 -0
- package/lib/openapi/v2/models/database.d.ts +35 -0
- package/lib/openapi/v2/models/database.js +38 -0
- package/lib/openapi/v2/models/database.js.map +1 -0
- package/lib/openapi/v2/models/operation.d.ts +8 -0
- package/lib/openapi/v2/models/operation.js +21 -0
- package/lib/openapi/v2/models/operation.js.map +1 -0
- package/lib/openapi/v2/models/page.d.ts +124 -0
- package/lib/openapi/v2/models/page.js +143 -0
- package/lib/openapi/v2/models/page.js.map +1 -0
- package/lib/openapi/v2/models/smartLink.d.ts +38 -0
- package/lib/openapi/v2/models/smartLink.js +38 -0
- package/lib/openapi/v2/models/smartLink.js.map +1 -0
- package/lib/openapi/v2/models/space.d.ts +87 -0
- package/lib/openapi/v2/models/space.js +100 -0
- package/lib/openapi/v2/models/space.js.map +1 -0
- package/lib/openapi/v2/models/spaceProperties.d.ts +27 -0
- package/lib/openapi/v2/models/spaceProperties.js +32 -0
- package/lib/openapi/v2/models/spaceProperties.js.map +1 -0
- package/lib/openapi/v2/models/task.d.ts +39 -0
- package/lib/openapi/v2/models/task.js +39 -0
- package/lib/openapi/v2/models/task.js.map +1 -0
- package/lib/openapi/v2/models/version.d.ts +139 -0
- package/lib/openapi/v2/models/version.js +91 -0
- package/lib/openapi/v2/models/version.js.map +1 -0
- package/lib/openapi/v2/models/whiteboard.d.ts +37 -0
- package/lib/openapi/v2/models/whiteboard.js +39 -0
- package/lib/openapi/v2/models/whiteboard.js.map +1 -0
- package/lib/openapi/v2/services/AncestorsService.d.ts +143 -0
- package/lib/openapi/v2/services/AncestorsService.js +245 -0
- package/lib/openapi/v2/services/AncestorsService.js.map +1 -0
- package/lib/openapi/v2/services/AttachmentService.d.ts +307 -0
- package/lib/openapi/v2/services/AttachmentService.js +370 -0
- package/lib/openapi/v2/services/AttachmentService.js.map +1 -0
- package/lib/openapi/v2/services/BlogPostService.d.ts +386 -0
- package/lib/openapi/v2/services/BlogPostService.js +379 -0
- package/lib/openapi/v2/services/BlogPostService.js.map +1 -0
- package/lib/openapi/v2/services/ChildrenService.d.ts +85 -0
- package/lib/openapi/v2/services/ChildrenService.js +127 -0
- package/lib/openapi/v2/services/ChildrenService.js.map +1 -0
- package/lib/openapi/v2/services/ClassificationLevelService.d.ts +213 -0
- package/lib/openapi/v2/services/ClassificationLevelService.js +340 -0
- package/lib/openapi/v2/services/ClassificationLevelService.js.map +1 -0
- package/lib/openapi/v2/services/CommentService.d.ts +713 -0
- package/lib/openapi/v2/services/CommentService.js +884 -0
- package/lib/openapi/v2/services/CommentService.js.map +1 -0
- package/lib/openapi/v2/services/ContentPropertiesService.d.ts +844 -0
- package/lib/openapi/v2/services/ContentPropertiesService.js +1514 -0
- package/lib/openapi/v2/services/ContentPropertiesService.js.map +1 -0
- package/lib/openapi/v2/services/ContentService.d.ts +31 -0
- package/lib/openapi/v2/services/ContentService.js +62 -0
- package/lib/openapi/v2/services/ContentService.js.map +1 -0
- package/lib/openapi/v2/services/CustomContentService.d.ts +427 -0
- package/lib/openapi/v2/services/CustomContentService.js +423 -0
- package/lib/openapi/v2/services/CustomContentService.js.map +1 -0
- package/lib/openapi/v2/services/DataPoliciesService.d.ts +64 -0
- package/lib/openapi/v2/services/DataPoliciesService.js +108 -0
- package/lib/openapi/v2/services/DataPoliciesService.js.map +1 -0
- package/lib/openapi/v2/services/DatabaseService.d.ts +82 -0
- package/lib/openapi/v2/services/DatabaseService.js +135 -0
- package/lib/openapi/v2/services/DatabaseService.js.map +1 -0
- package/lib/openapi/v2/services/LabelService.d.ts +271 -0
- package/lib/openapi/v2/services/LabelService.js +384 -0
- package/lib/openapi/v2/services/LabelService.js.map +1 -0
- package/lib/openapi/v2/services/LikeService.d.ts +205 -0
- package/lib/openapi/v2/services/LikeService.js +358 -0
- package/lib/openapi/v2/services/LikeService.js.map +1 -0
- package/lib/openapi/v2/services/OperationService.d.ts +154 -0
- package/lib/openapi/v2/services/OperationService.js +374 -0
- package/lib/openapi/v2/services/OperationService.js.map +1 -0
- package/lib/openapi/v2/services/PageService.d.ts +408 -0
- package/lib/openapi/v2/services/PageService.js +381 -0
- package/lib/openapi/v2/services/PageService.js.map +1 -0
- package/lib/openapi/v2/services/SmartLinkService.d.ts +84 -0
- package/lib/openapi/v2/services/SmartLinkService.js +137 -0
- package/lib/openapi/v2/services/SmartLinkService.js.map +1 -0
- package/lib/openapi/v2/services/SpacePermissionsService.d.ts +36 -0
- package/lib/openapi/v2/services/SpacePermissionsService.js +66 -0
- package/lib/openapi/v2/services/SpacePermissionsService.js.map +1 -0
- package/lib/openapi/v2/services/SpacePropertiesService.d.ts +118 -0
- package/lib/openapi/v2/services/SpacePropertiesService.js +213 -0
- package/lib/openapi/v2/services/SpacePropertiesService.js.map +1 -0
- package/lib/openapi/v2/services/SpaceService.d.ts +141 -0
- package/lib/openapi/v2/services/SpaceService.js +133 -0
- package/lib/openapi/v2/services/SpaceService.js.map +1 -0
- package/lib/openapi/v2/services/TaskService.d.ts +184 -0
- package/lib/openapi/v2/services/TaskService.js +165 -0
- package/lib/openapi/v2/services/TaskService.js.map +1 -0
- package/lib/openapi/v2/services/UserService.d.ts +51 -0
- package/lib/openapi/v2/services/UserService.js +83 -0
- package/lib/openapi/v2/services/UserService.js.map +1 -0
- package/lib/openapi/v2/services/VersionService.d.ts +350 -0
- package/lib/openapi/v2/services/VersionService.js +541 -0
- package/lib/openapi/v2/services/VersionService.js.map +1 -0
- package/lib/openapi/v2/services/WhiteboardService.d.ts +82 -0
- package/lib/openapi/v2/services/WhiteboardService.js +135 -0
- package/lib/openapi/v2/services/WhiteboardService.js.map +1 -0
- package/lib/openapi/v2/validationSchemaStorage.d.ts +3 -0
- package/lib/openapi/v2/validationSchemaStorage.js +144 -0
- package/lib/openapi/v2/validationSchemaStorage.js.map +1 -0
- package/package.json +44 -0
|
@@ -0,0 +1,155 @@
|
|
|
1
|
+
"use strict";
|
|
2
|
+
Object.defineProperty(exports, "__esModule", { value: true });
|
|
3
|
+
exports.InlineTasksService = void 0;
|
|
4
|
+
// DO NOT EDIT!
|
|
5
|
+
// This file is generated by "api-typescript-generator".
|
|
6
|
+
// To update this file run "yarn build:openapi".
|
|
7
|
+
const zod_1 = require("zod");
|
|
8
|
+
const commonHttpClient = require("../core/CommonHttpClient");
|
|
9
|
+
const CommonHttpService_1 = require("../core/CommonHttpService");
|
|
10
|
+
const inlineTasks_1 = require("../models/inlineTasks");
|
|
11
|
+
const validationSchemaStorage_1 = require("../validationSchemaStorage");
|
|
12
|
+
/** @deprecated */
|
|
13
|
+
class InlineTasksService extends CommonHttpService_1.CommonHttpService {
|
|
14
|
+
/**
|
|
15
|
+
* Deprecated, use [Confluence's v2
|
|
16
|
+
* API](https://developer.atlassian.com/cloud/confluence/rest/v2/intro/).
|
|
17
|
+
*
|
|
18
|
+
* Returns inline task based on the global ID.
|
|
19
|
+
*
|
|
20
|
+
* **[Permissions](https://confluence.atlassian.com/x/_AozKw) required**:
|
|
21
|
+
* Permission to view the content associated with the task.
|
|
22
|
+
*
|
|
23
|
+
* @deprecated
|
|
24
|
+
* @returns Returned if the inline task was found given the global ID
|
|
25
|
+
* @path {GET} /wiki/rest/api/inlinetasks/{inlineTaskId}
|
|
26
|
+
* @scopes-current read:inlinetask:confluence
|
|
27
|
+
*/
|
|
28
|
+
getTaskById({ inlineTaskId, }) {
|
|
29
|
+
return this.getClientInstance()
|
|
30
|
+
.request({
|
|
31
|
+
path: "/wiki/rest/api/inlinetasks/{inlineTaskId}",
|
|
32
|
+
method: "GET",
|
|
33
|
+
pathParams: {
|
|
34
|
+
inlineTaskId,
|
|
35
|
+
},
|
|
36
|
+
})
|
|
37
|
+
.then(this.getClientInstance().responseHandler({
|
|
38
|
+
200: {
|
|
39
|
+
"application/json": "json",
|
|
40
|
+
},
|
|
41
|
+
}))
|
|
42
|
+
.then(commonHttpClient.castResponse())
|
|
43
|
+
.then(validationSchemaStorage_1.validationSchemaStorage.validator("InlineTasksService.getTaskById.response"))
|
|
44
|
+
.then(commonHttpClient.getBody);
|
|
45
|
+
}
|
|
46
|
+
/**
|
|
47
|
+
* Deprecated, use [Confluence's v2
|
|
48
|
+
* API](https://developer.atlassian.com/cloud/confluence/rest/v2/intro/).
|
|
49
|
+
*
|
|
50
|
+
* Returns inline tasks based on the search query.
|
|
51
|
+
*
|
|
52
|
+
* **[Permissions](https://confluence.atlassian.com/x/_AozKw) required**:
|
|
53
|
+
* Permission to access the Confluence site ('Can use' global permission). Only
|
|
54
|
+
* tasks
|
|
55
|
+
* in contents that the user has permission to view are returned.
|
|
56
|
+
*
|
|
57
|
+
* @deprecated
|
|
58
|
+
* @returns Returned if the query fetches zero or more results.
|
|
59
|
+
* @path {GET} /wiki/rest/api/inlinetasks/search
|
|
60
|
+
* @scopes-current read:confluence-content.all
|
|
61
|
+
* @scopes-beta read:inlinetask:confluence
|
|
62
|
+
*/
|
|
63
|
+
searchTasks({ start, limit, spaceKey, pageId, assignee, creator, completedUser, duedateFrom, duedateTo, createdateFrom, createdateTo, completedateFrom, completedateTo, status, }) {
|
|
64
|
+
return this.getClientInstance()
|
|
65
|
+
.request({
|
|
66
|
+
path: "/wiki/rest/api/inlinetasks/search",
|
|
67
|
+
method: "GET",
|
|
68
|
+
query: {
|
|
69
|
+
start,
|
|
70
|
+
limit,
|
|
71
|
+
spaceKey,
|
|
72
|
+
pageId,
|
|
73
|
+
assignee,
|
|
74
|
+
creator,
|
|
75
|
+
completedUser,
|
|
76
|
+
duedateFrom,
|
|
77
|
+
duedateTo,
|
|
78
|
+
createdateFrom,
|
|
79
|
+
createdateTo,
|
|
80
|
+
completedateFrom,
|
|
81
|
+
completedateTo,
|
|
82
|
+
status,
|
|
83
|
+
},
|
|
84
|
+
})
|
|
85
|
+
.then(this.getClientInstance().responseHandler({
|
|
86
|
+
200: {
|
|
87
|
+
"application/json": "json",
|
|
88
|
+
},
|
|
89
|
+
}))
|
|
90
|
+
.then(commonHttpClient.castResponse())
|
|
91
|
+
.then(validationSchemaStorage_1.validationSchemaStorage.validator("InlineTasksService.searchTasks.response"))
|
|
92
|
+
.then(commonHttpClient.getBody);
|
|
93
|
+
}
|
|
94
|
+
/**
|
|
95
|
+
* Updates an inline tasks status given its global ID
|
|
96
|
+
*
|
|
97
|
+
* **[Permissions](https://confluence.atlassian.com/x/_AozKw) required**:
|
|
98
|
+
* Permission to update the content associated with the task.
|
|
99
|
+
*
|
|
100
|
+
* @deprecated
|
|
101
|
+
* @returns Returned if the inline task was successfully updated.
|
|
102
|
+
* @path {PUT} /wiki/rest/api/inlinetasks/{inlineTaskId}
|
|
103
|
+
* @scopes-current read:inlinetask:confluence, write:inlinetask:confluence
|
|
104
|
+
*/
|
|
105
|
+
updateTaskById({ inlineTaskId, taskStatusUpdate, }) {
|
|
106
|
+
return this.getClientInstance()
|
|
107
|
+
.request({
|
|
108
|
+
path: "/wiki/rest/api/inlinetasks/{inlineTaskId}",
|
|
109
|
+
method: "PUT",
|
|
110
|
+
pathParams: {
|
|
111
|
+
inlineTaskId,
|
|
112
|
+
},
|
|
113
|
+
headers: {
|
|
114
|
+
"Content-Type": "application/json",
|
|
115
|
+
},
|
|
116
|
+
body: taskStatusUpdate,
|
|
117
|
+
})
|
|
118
|
+
.then(this.getClientInstance().responseHandler({
|
|
119
|
+
200: {
|
|
120
|
+
"application/json": "json",
|
|
121
|
+
},
|
|
122
|
+
}))
|
|
123
|
+
.then(commonHttpClient.castResponse())
|
|
124
|
+
.then(validationSchemaStorage_1.validationSchemaStorage.validator("InlineTasksService.updateTaskById.response"))
|
|
125
|
+
.then(commonHttpClient.getBody);
|
|
126
|
+
}
|
|
127
|
+
static initialize() {
|
|
128
|
+
validationSchemaStorage_1.validationSchemaStorage.registerExtensible("InlineTasksService.getTaskById.response", zod_1.z
|
|
129
|
+
.object({
|
|
130
|
+
status: zod_1.z.literal(200),
|
|
131
|
+
mediaType: zod_1.z.literal("application/json"),
|
|
132
|
+
body: validationSchemaStorage_1.validationSchemaStorage.lazy("TaskV1"),
|
|
133
|
+
})
|
|
134
|
+
.describe("InlineTasksService.getTaskById.response"));
|
|
135
|
+
validationSchemaStorage_1.validationSchemaStorage.registerExtensible("InlineTasksService.updateTaskById.response", zod_1.z
|
|
136
|
+
.object({
|
|
137
|
+
status: zod_1.z.literal(200),
|
|
138
|
+
mediaType: zod_1.z.literal("application/json"),
|
|
139
|
+
body: validationSchemaStorage_1.validationSchemaStorage.lazy("TaskV1"),
|
|
140
|
+
})
|
|
141
|
+
.describe("InlineTasksService.updateTaskById.response"));
|
|
142
|
+
validationSchemaStorage_1.validationSchemaStorage.registerExtensible("InlineTasksService.searchTasks.response", zod_1.z
|
|
143
|
+
.object({
|
|
144
|
+
status: zod_1.z.literal(200),
|
|
145
|
+
mediaType: zod_1.z.literal("application/json"),
|
|
146
|
+
body: validationSchemaStorage_1.validationSchemaStorage.lazy("TaskPageResponse"),
|
|
147
|
+
})
|
|
148
|
+
.describe("InlineTasksService.searchTasks.response"));
|
|
149
|
+
validationSchemaStorage_1.validationSchemaStorage.registerOnce([
|
|
150
|
+
inlineTasks_1.registerInlineTasksValidationSchemas,
|
|
151
|
+
]);
|
|
152
|
+
}
|
|
153
|
+
}
|
|
154
|
+
exports.InlineTasksService = InlineTasksService;
|
|
155
|
+
//# sourceMappingURL=InlineTasksService.js.map
|
|
@@ -0,0 +1 @@
|
|
|
1
|
+
{"version":3,"file":"InlineTasksService.js","sourceRoot":"","sources":["../../../../src/openapi/v1/services/InlineTasksService.ts"],"names":[],"mappings":";;;AAAA,eAAe;AACf,wDAAwD;AACxD,gDAAgD;AAChD,6BAAwB;AAExB,6DAA6D;AAC7D,iEAA8D;AAC9D,uDAK+B;AAC/B,wEAAqE;AACrE,kBAAkB;AAClB,MAAa,kBAAmB,SAAQ,qCAAiB;IACvD;;;;;;;;;;;;;OAaG;IACH,WAAW,CAAC,EACV,YAAY,GAIb;QACC,OAAO,IAAI,CAAC,iBAAiB,EAAE;aAC5B,OAAO,CAAC;YACP,IAAI,EAAE,2CAA2C;YACjD,MAAM,EAAE,KAAK;YACb,UAAU,EAAE;gBACV,YAAY;aACb;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,yCAAyC,CAC1C,CACF;aACA,IAAI,CAAC,gBAAgB,CAAC,OAAO,CAAC,CAAC;IACpC,CAAC;IACD;;;;;;;;;;;;;;;;OAgBG;IACH,WAAW,CAAC,EACV,KAAK,EACL,KAAK,EACL,QAAQ,EACR,MAAM,EACN,QAAQ,EACR,OAAO,EACP,aAAa,EACb,WAAW,EACX,SAAS,EACT,cAAc,EACd,YAAY,EACZ,gBAAgB,EAChB,cAAc,EACd,MAAM,GAiCP;QACC,OAAO,IAAI,CAAC,iBAAiB,EAAE;aAC5B,OAAO,CAAC;YACP,IAAI,EAAE,mCAAmC;YACzC,MAAM,EAAE,KAAK;YACb,KAAK,EAAE;gBACL,KAAK;gBACL,KAAK;gBACL,QAAQ;gBACR,MAAM;gBACN,QAAQ;gBACR,OAAO;gBACP,aAAa;gBACb,WAAW;gBACX,SAAS;gBACT,cAAc;gBACd,YAAY;gBACZ,gBAAgB;gBAChB,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,CAC/B,yCAAyC,CAC1C,CACF;aACA,IAAI,CAAC,gBAAgB,CAAC,OAAO,CAAC,CAAC;IACpC,CAAC;IACD;;;;;;;;;;OAUG;IACH,cAAc,CAAC,EACb,YAAY,EACZ,gBAAgB,GAMjB;QACC,OAAO,IAAI,CAAC,iBAAiB,EAAE;aAC5B,OAAO,CAAC;YACP,IAAI,EAAE,2CAA2C;YACjD,MAAM,EAAE,KAAK;YACb,UAAU,EAAE;gBACV,YAAY;aACb;YACD,OAAO,EAAE;gBACP,cAAc,EAAE,kBAAkB;aACnC;YACD,IAAI,EAAE,gBAAgB;SACvB,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,4CAA4C,CAC7C,CACF;aACA,IAAI,CAAC,gBAAgB,CAAC,OAAO,CAAC,CAAC;IACpC,CAAC;IACD,MAAM,CAAC,UAAU;QACf,iDAAuB,CAAC,kBAAkB,CACxC,yCAAyC,EACzC,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,QAAQ,CAAC;SAC7C,CAAC;aACD,QAAQ,CAAC,yCAAyC,CAAC,CACvD,CAAC;QACF,iDAAuB,CAAC,kBAAkB,CACxC,4CAA4C,EAC5C,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,QAAQ,CAAC;SAC7C,CAAC;aACD,QAAQ,CAAC,4CAA4C,CAAC,CAC1D,CAAC;QACF,iDAAuB,CAAC,kBAAkB,CACxC,yCAAyC,EACzC,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,kBAAkB,CAAC;SACvD,CAAC;aACD,QAAQ,CAAC,yCAAyC,CAAC,CACvD,CAAC;QACF,iDAAuB,CAAC,YAAY,CAAC;YACnC,kDAAoC;SACrC,CAAC,CAAC;IACL,CAAC;CACF;AArPD,gDAqPC"}
|
|
@@ -0,0 +1,28 @@
|
|
|
1
|
+
import { CommonHttpService } from "../core/CommonHttpService";
|
|
2
|
+
import { type LabelDetails } from "../models/labelInfo";
|
|
3
|
+
export declare class LabelInfoService extends CommonHttpService {
|
|
4
|
+
/**
|
|
5
|
+
* Returns label information and a list of contents associated with the label.
|
|
6
|
+
*
|
|
7
|
+
* **[Permissions](https://confluence.atlassian.com/x/_AozKw) required**:
|
|
8
|
+
* Permission to access the Confluence site ('Can use' global permission). Only
|
|
9
|
+
* contents
|
|
10
|
+
* that the user is permitted to view is returned.
|
|
11
|
+
*
|
|
12
|
+
* @returns Returned if the query fetches zero or more results.
|
|
13
|
+
* @path {GET} /wiki/rest/api/label
|
|
14
|
+
* @scopes-current read:confluence-content.summary
|
|
15
|
+
* @scopes-beta read:label:confluence, read:content:confluence
|
|
16
|
+
*/
|
|
17
|
+
getAllLabelContent({ name, type, start, limit, }: {
|
|
18
|
+
/** Name of the label to query. */
|
|
19
|
+
name: string;
|
|
20
|
+
/** The type of contents that are to be returned. */
|
|
21
|
+
type?: "page" | "blogpost" | "attachment" | "page_template";
|
|
22
|
+
/** The starting offset for the results. */
|
|
23
|
+
start?: number;
|
|
24
|
+
/** The number of results to be returned. */
|
|
25
|
+
limit?: number;
|
|
26
|
+
}): Promise<LabelDetails>;
|
|
27
|
+
static initialize(): void;
|
|
28
|
+
}
|
|
@@ -0,0 +1,59 @@
|
|
|
1
|
+
"use strict";
|
|
2
|
+
Object.defineProperty(exports, "__esModule", { value: true });
|
|
3
|
+
exports.LabelInfoService = void 0;
|
|
4
|
+
// DO NOT EDIT!
|
|
5
|
+
// This file is generated by "api-typescript-generator".
|
|
6
|
+
// To update this file run "yarn build:openapi".
|
|
7
|
+
const zod_1 = require("zod");
|
|
8
|
+
const commonHttpClient = require("../core/CommonHttpClient");
|
|
9
|
+
const CommonHttpService_1 = require("../core/CommonHttpService");
|
|
10
|
+
const labelInfo_1 = require("../models/labelInfo");
|
|
11
|
+
const validationSchemaStorage_1 = require("../validationSchemaStorage");
|
|
12
|
+
class LabelInfoService extends CommonHttpService_1.CommonHttpService {
|
|
13
|
+
/**
|
|
14
|
+
* Returns label information and a list of contents associated with the label.
|
|
15
|
+
*
|
|
16
|
+
* **[Permissions](https://confluence.atlassian.com/x/_AozKw) required**:
|
|
17
|
+
* Permission to access the Confluence site ('Can use' global permission). Only
|
|
18
|
+
* contents
|
|
19
|
+
* that the user is permitted to view is returned.
|
|
20
|
+
*
|
|
21
|
+
* @returns Returned if the query fetches zero or more results.
|
|
22
|
+
* @path {GET} /wiki/rest/api/label
|
|
23
|
+
* @scopes-current read:confluence-content.summary
|
|
24
|
+
* @scopes-beta read:label:confluence, read:content:confluence
|
|
25
|
+
*/
|
|
26
|
+
getAllLabelContent({ name, type, start, limit, }) {
|
|
27
|
+
return this.getClientInstance()
|
|
28
|
+
.request({
|
|
29
|
+
path: "/wiki/rest/api/label",
|
|
30
|
+
method: "GET",
|
|
31
|
+
query: {
|
|
32
|
+
name,
|
|
33
|
+
type,
|
|
34
|
+
start,
|
|
35
|
+
limit,
|
|
36
|
+
},
|
|
37
|
+
})
|
|
38
|
+
.then(this.getClientInstance().responseHandler({
|
|
39
|
+
200: {
|
|
40
|
+
"application/json": "json",
|
|
41
|
+
},
|
|
42
|
+
}))
|
|
43
|
+
.then(commonHttpClient.castResponse())
|
|
44
|
+
.then(validationSchemaStorage_1.validationSchemaStorage.validator("LabelInfoService.getAllLabelContent.response"))
|
|
45
|
+
.then(commonHttpClient.getBody);
|
|
46
|
+
}
|
|
47
|
+
static initialize() {
|
|
48
|
+
validationSchemaStorage_1.validationSchemaStorage.registerExtensible("LabelInfoService.getAllLabelContent.response", zod_1.z
|
|
49
|
+
.object({
|
|
50
|
+
status: zod_1.z.literal(200),
|
|
51
|
+
mediaType: zod_1.z.literal("application/json"),
|
|
52
|
+
body: validationSchemaStorage_1.validationSchemaStorage.lazy("LabelDetails"),
|
|
53
|
+
})
|
|
54
|
+
.describe("LabelInfoService.getAllLabelContent.response"));
|
|
55
|
+
validationSchemaStorage_1.validationSchemaStorage.registerOnce([labelInfo_1.registerLabelInfoValidationSchemas]);
|
|
56
|
+
}
|
|
57
|
+
}
|
|
58
|
+
exports.LabelInfoService = LabelInfoService;
|
|
59
|
+
//# sourceMappingURL=LabelInfoService.js.map
|
|
@@ -0,0 +1 @@
|
|
|
1
|
+
{"version":3,"file":"LabelInfoService.js","sourceRoot":"","sources":["../../../../src/openapi/v1/services/LabelInfoService.ts"],"names":[],"mappings":";;;AAAA,eAAe;AACf,wDAAwD;AACxD,gDAAgD;AAChD,6BAAwB;AAExB,6DAA6D;AAC7D,iEAA8D;AAC9D,mDAG6B;AAC7B,wEAAqE;AACrE,MAAa,gBAAiB,SAAQ,qCAAiB;IACrD;;;;;;;;;;;;OAYG;IACH,kBAAkB,CAAC,EACjB,IAAI,EACJ,IAAI,EACJ,KAAK,EACL,KAAK,GAUN;QACC,OAAO,IAAI,CAAC,iBAAiB,EAAE;aAC5B,OAAO,CAAC;YACP,IAAI,EAAE,sBAAsB;YAC5B,MAAM,EAAE,KAAK;YACb,KAAK,EAAE;gBACL,IAAI;gBACJ,IAAI;gBACJ,KAAK;gBACL,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,EAIzB,CACL;aACA,IAAI,CACH,iDAAuB,CAAC,SAAS,CAC/B,8CAA8C,CAC/C,CACF;aACA,IAAI,CAAC,gBAAgB,CAAC,OAAO,CAAC,CAAC;IACpC,CAAC;IACD,MAAM,CAAC,UAAU;QACf,iDAAuB,CAAC,kBAAkB,CACxC,8CAA8C,EAC9C,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,cAAc,CAAC;SACnD,CAAC;aACD,QAAQ,CAAC,8CAA8C,CAAC,CAC5D,CAAC;QACF,iDAAuB,CAAC,YAAY,CAAC,CAAC,8CAAkC,CAAC,CAAC,CAAC;IAC7E,CAAC;CACF;AA1ED,4CA0EC"}
|
|
@@ -0,0 +1,43 @@
|
|
|
1
|
+
import { CommonHttpService } from "../core/CommonHttpService";
|
|
2
|
+
import { type LongTaskStatusArray, type LongTaskStatusWithLinks } from "../models/longRunningTask";
|
|
3
|
+
export declare class LongRunningTaskService extends CommonHttpService {
|
|
4
|
+
/**
|
|
5
|
+
* Returns information about an active long-running task (e.g. space export),
|
|
6
|
+
* such as how long it has been running and the percentage of the task that
|
|
7
|
+
* has completed.
|
|
8
|
+
*
|
|
9
|
+
* **[Permissions](https://confluence.atlassian.com/x/_AozKw) required**:
|
|
10
|
+
* Permission to access the Confluence site ('Can use' global permission).
|
|
11
|
+
*
|
|
12
|
+
* @returns Returned if the requested task is returned.
|
|
13
|
+
* @path {GET} /wiki/rest/api/longtask/{id}
|
|
14
|
+
* @scopes-current read:confluence-space.summary
|
|
15
|
+
* @scopes-beta read:content.metadata:confluence
|
|
16
|
+
*/
|
|
17
|
+
getTask({ id, }: {
|
|
18
|
+
/** The ID of the task. */
|
|
19
|
+
id: string;
|
|
20
|
+
}): Promise<LongTaskStatusWithLinks>;
|
|
21
|
+
/**
|
|
22
|
+
* Returns information about all active long-running tasks (e.g. space export),
|
|
23
|
+
* such as how long each task has been running and the percentage of each task
|
|
24
|
+
* that has completed.
|
|
25
|
+
*
|
|
26
|
+
* **[Permissions](https://confluence.atlassian.com/x/_AozKw) required**:
|
|
27
|
+
* Permission to access the Confluence site ('Can use' global permission).
|
|
28
|
+
*
|
|
29
|
+
* @returns Returned if the requested tasks are returned.
|
|
30
|
+
* @path {GET} /wiki/rest/api/longtask
|
|
31
|
+
* @scopes-current read:content.metadata:confluence
|
|
32
|
+
*/
|
|
33
|
+
getTasks({ start, limit, }: {
|
|
34
|
+
/** The starting index of the returned tasks. */
|
|
35
|
+
start?: number;
|
|
36
|
+
/**
|
|
37
|
+
* The maximum number of tasks to return per page. Note, this may be
|
|
38
|
+
* restricted by fixed system limits.
|
|
39
|
+
*/
|
|
40
|
+
limit?: number;
|
|
41
|
+
}): Promise<LongTaskStatusArray>;
|
|
42
|
+
static initialize(): void;
|
|
43
|
+
}
|
|
@@ -0,0 +1,96 @@
|
|
|
1
|
+
"use strict";
|
|
2
|
+
Object.defineProperty(exports, "__esModule", { value: true });
|
|
3
|
+
exports.LongRunningTaskService = void 0;
|
|
4
|
+
// DO NOT EDIT!
|
|
5
|
+
// This file is generated by "api-typescript-generator".
|
|
6
|
+
// To update this file run "yarn build:openapi".
|
|
7
|
+
const zod_1 = require("zod");
|
|
8
|
+
const commonHttpClient = require("../core/CommonHttpClient");
|
|
9
|
+
const CommonHttpService_1 = require("../core/CommonHttpService");
|
|
10
|
+
const longRunningTask_1 = require("../models/longRunningTask");
|
|
11
|
+
const validationSchemaStorage_1 = require("../validationSchemaStorage");
|
|
12
|
+
class LongRunningTaskService extends CommonHttpService_1.CommonHttpService {
|
|
13
|
+
/**
|
|
14
|
+
* Returns information about an active long-running task (e.g. space export),
|
|
15
|
+
* such as how long it has been running and the percentage of the task that
|
|
16
|
+
* has completed.
|
|
17
|
+
*
|
|
18
|
+
* **[Permissions](https://confluence.atlassian.com/x/_AozKw) required**:
|
|
19
|
+
* Permission to access the Confluence site ('Can use' global permission).
|
|
20
|
+
*
|
|
21
|
+
* @returns Returned if the requested task is returned.
|
|
22
|
+
* @path {GET} /wiki/rest/api/longtask/{id}
|
|
23
|
+
* @scopes-current read:confluence-space.summary
|
|
24
|
+
* @scopes-beta read:content.metadata:confluence
|
|
25
|
+
*/
|
|
26
|
+
getTask({ id, }) {
|
|
27
|
+
return this.getClientInstance()
|
|
28
|
+
.request({
|
|
29
|
+
path: "/wiki/rest/api/longtask/{id}",
|
|
30
|
+
method: "GET",
|
|
31
|
+
pathParams: {
|
|
32
|
+
id,
|
|
33
|
+
},
|
|
34
|
+
})
|
|
35
|
+
.then(this.getClientInstance().responseHandler({
|
|
36
|
+
200: {
|
|
37
|
+
"application/json": "json",
|
|
38
|
+
},
|
|
39
|
+
}))
|
|
40
|
+
.then(commonHttpClient.castResponse())
|
|
41
|
+
.then(validationSchemaStorage_1.validationSchemaStorage.validator("LongRunningTaskService.getTask.response"))
|
|
42
|
+
.then(commonHttpClient.getBody);
|
|
43
|
+
}
|
|
44
|
+
/**
|
|
45
|
+
* Returns information about all active long-running tasks (e.g. space export),
|
|
46
|
+
* such as how long each task has been running and the percentage of each task
|
|
47
|
+
* that has completed.
|
|
48
|
+
*
|
|
49
|
+
* **[Permissions](https://confluence.atlassian.com/x/_AozKw) required**:
|
|
50
|
+
* Permission to access the Confluence site ('Can use' global permission).
|
|
51
|
+
*
|
|
52
|
+
* @returns Returned if the requested tasks are returned.
|
|
53
|
+
* @path {GET} /wiki/rest/api/longtask
|
|
54
|
+
* @scopes-current read:content.metadata:confluence
|
|
55
|
+
*/
|
|
56
|
+
getTasks({ start, limit, }) {
|
|
57
|
+
return this.getClientInstance()
|
|
58
|
+
.request({
|
|
59
|
+
path: "/wiki/rest/api/longtask",
|
|
60
|
+
method: "GET",
|
|
61
|
+
query: {
|
|
62
|
+
start,
|
|
63
|
+
limit,
|
|
64
|
+
},
|
|
65
|
+
})
|
|
66
|
+
.then(this.getClientInstance().responseHandler({
|
|
67
|
+
200: {
|
|
68
|
+
"application/json": "json",
|
|
69
|
+
},
|
|
70
|
+
}))
|
|
71
|
+
.then(commonHttpClient.castResponse())
|
|
72
|
+
.then(validationSchemaStorage_1.validationSchemaStorage.validator("LongRunningTaskService.getTasks.response"))
|
|
73
|
+
.then(commonHttpClient.getBody);
|
|
74
|
+
}
|
|
75
|
+
static initialize() {
|
|
76
|
+
validationSchemaStorage_1.validationSchemaStorage.registerExtensible("LongRunningTaskService.getTasks.response", zod_1.z
|
|
77
|
+
.object({
|
|
78
|
+
status: zod_1.z.literal(200),
|
|
79
|
+
mediaType: zod_1.z.literal("application/json"),
|
|
80
|
+
body: validationSchemaStorage_1.validationSchemaStorage.lazy("LongTaskStatusArray"),
|
|
81
|
+
})
|
|
82
|
+
.describe("LongRunningTaskService.getTasks.response"));
|
|
83
|
+
validationSchemaStorage_1.validationSchemaStorage.registerExtensible("LongRunningTaskService.getTask.response", zod_1.z
|
|
84
|
+
.object({
|
|
85
|
+
status: zod_1.z.literal(200),
|
|
86
|
+
mediaType: zod_1.z.literal("application/json"),
|
|
87
|
+
body: validationSchemaStorage_1.validationSchemaStorage.lazy("LongTaskStatusWithLinks"),
|
|
88
|
+
})
|
|
89
|
+
.describe("LongRunningTaskService.getTask.response"));
|
|
90
|
+
validationSchemaStorage_1.validationSchemaStorage.registerOnce([
|
|
91
|
+
longRunningTask_1.registerLongRunningTaskValidationSchemas,
|
|
92
|
+
]);
|
|
93
|
+
}
|
|
94
|
+
}
|
|
95
|
+
exports.LongRunningTaskService = LongRunningTaskService;
|
|
96
|
+
//# sourceMappingURL=LongRunningTaskService.js.map
|
|
@@ -0,0 +1 @@
|
|
|
1
|
+
{"version":3,"file":"LongRunningTaskService.js","sourceRoot":"","sources":["../../../../src/openapi/v1/services/LongRunningTaskService.ts"],"names":[],"mappings":";;;AAAA,eAAe;AACf,wDAAwD;AACxD,gDAAgD;AAChD,6BAAwB;AAExB,6DAA6D;AAC7D,iEAA8D;AAC9D,+DAImC;AACnC,wEAAqE;AACrE,MAAa,sBAAuB,SAAQ,qCAAiB;IAC3D;;;;;;;;;;;;OAYG;IACH,OAAO,CAAC,EACN,EAAE,GAIH;QACC,OAAO,IAAI,CAAC,iBAAiB,EAAE;aAC5B,OAAO,CAAC;YACP,IAAI,EAAE,8BAA8B;YACpC,MAAM,EAAE,KAAK;YACb,UAAU,EAAE;gBACV,EAAE;aACH;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,yCAAyC,CAC1C,CACF;aACA,IAAI,CAAC,gBAAgB,CAAC,OAAO,CAAC,CAAC;IACpC,CAAC;IACD;;;;;;;;;;;OAWG;IACH,QAAQ,CAAC,EACP,KAAK,EACL,KAAK,GASN;QACC,OAAO,IAAI,CAAC,iBAAiB,EAAE;aAC5B,OAAO,CAAC;YACP,IAAI,EAAE,yBAAyB;YAC/B,MAAM,EAAE,KAAK;YACb,KAAK,EAAE;gBACL,KAAK;gBACL,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,EAIzB,CACL;aACA,IAAI,CACH,iDAAuB,CAAC,SAAS,CAC/B,0CAA0C,CAC3C,CACF;aACA,IAAI,CAAC,gBAAgB,CAAC,OAAO,CAAC,CAAC;IACpC,CAAC;IACD,MAAM,CAAC,UAAU;QACf,iDAAuB,CAAC,kBAAkB,CACxC,0CAA0C,EAC1C,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,qBAAqB,CAAC;SAC1D,CAAC;aACD,QAAQ,CAAC,0CAA0C,CAAC,CACxD,CAAC;QACF,iDAAuB,CAAC,kBAAkB,CACxC,yCAAyC,EACzC,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,yBAAyB,CAAC;SAC9D,CAAC;aACD,QAAQ,CAAC,yCAAyC,CAAC,CACvD,CAAC;QACF,iDAAuB,CAAC,YAAY,CAAC;YACnC,0DAAwC;SACzC,CAAC,CAAC;IACL,CAAC;CACF;AAhID,wDAgIC"}
|