@resolution/confluence-api-client 0.4.1 → 0.4.3

package/CHANGELOG.md

@@ -3,6 +3,27 @@
 All notable changes to this project will be documented in this file.
 See [Conventional Commits](https://conventionalcommits.org) for commit guidelines.
 
+## [0.4.3](https://bitbucket.org/resolutiongmbh/atlassian-api-clients/branches/compare/v0.4.3%0Dv0.4.2) (2024-06-11)
+
+
+### Bug Fixes
+
+* update generated files according to new OpenAPI schemas ([381a1ea](https://bitbucket.org/resolutiongmbh/atlassian-api-clients/commits/381a1ea9b21cfaf6325d7f564ecba2453c8410fa))
+
+
+
+## [0.4.2](https://bitbucket.org/resolutiongmbh/atlassian-api-clients/compare/v0.4.1...v0.4.2) (2024-06-11)
+
+
+### Bug Fixes
+
+* add base path to confluence v2 API ([8b1965c](https://bitbucket.org/resolutiongmbh/atlassian-api-clients/commits/8b1965ca84d55dd4bf9600c36006d7d61e8e2fcd))
+* add links to JIRA/Confluence documentation ([64c19b2](https://bitbucket.org/resolutiongmbh/atlassian-api-clients/commits/64c19b2b0d1685c0d64639c6a44314a253ad5529))
+
+
+
+
+
 ## [0.4.1](https://bitbucket.org/resolutiongmbh/atlassian-api-clients/compare/v0.4.0...v0.4.1) (2024-06-10)
 
 

package/README.md

@@ -9,4 +9,128 @@ Compatible with the following request/fetch Atlassian libraries:
  * [@forge/api](https://developer.atlassian.com/cloud/jira/platform/forge/)
  * [@forge/bridge](https://developer.atlassian.com/cloud/jira/platform/forge/)
 
-More details will follow.
+## Installation
+
+Install using npm
+
+```bash
+npm add @resolution/confluence-api-client
+```
+
+Or using yarn
+
+```bash
+yarn add @resolution/confluence-api-client
+```
+
+## Usage
+
+### Connect
+
+Inside Connect iframe:
+
+```typescript
+import { ConfluenceApiV1, ConfluenceApiV2 } from '@resolution/confluence-api-client';
+
+async function test() {
+  const confluenceApiV1 = new ConfluenceApiV1({ AP: window.AP });
+  const currentUser = await confluenceApiV1.users.getCurrentUser();
+  console.log("Current User:", currentUser);
+
+  const confluenceApiV2 = new ConfluenceApiV2({ AP: window.AP });
+  const spaces = await confluenceApiV2.space.getSpaces({ keys: ["SPACE"] });
+  console.log("Space:", spaces.results[0]);
+}
+
+test().catch(console.error);
+```
+
+On the server side using `atlassian-connect-express`:
+
+```typescript
+import atlassianConnectExpress from 'atlassian-connect-express';
+import { ConfluenceApiV1, ConfluenceApiV2 } from '@resolution/confluence-api-client';
+
+const app = express();
+const ace = atlassianConnectExpress(app);
+
+app.use(ace.authenticate());
+
+app.get('/current-user', async () => {
+  const confluenceApiV1 = new ConfluenceApiV1({ ace, clientKey: req.context.clientKey });
+  const currentUser = await confluenceApiV1.users.getCurrentUser();
+  res.status(200).send(currentUser);
+});
+
+app.get('/spaces/:spaceKey', async () => {
+  const confluenceApiV2 = new ConfluenceApiV2({ ace, clientKey: req.context.clientKey });
+  const spaces = await confluenceApiV2.space.getSpaces({ keys: [req.params.spaceKey] });
+  res.status(200).send(spaces.results[0]);
+});
+
+app.listen(3000);
+```
+
+### Forge
+
+Inside Forge iframe:
+
+```typescript
+import { ConfluenceApiV1, ConfluenceApiV2 } from '@resolution/confluence-api-client';
+import { requestConfluence } from '@forge/bridge';
+
+async function test() {
+  const confluenceApiV1 = new ConfluenceApiV1({ requestConfluence });
+  const currentUser = await confluenceApiV1.users.getCurrentUser();
+  console.log("Current User:", currentUser);
+
+  const confluenceApiV2 = new ConfluenceApiV2({ requestConfluence });
+  const spaces = await confluenceApiV2.space.getSpaces({ keys: ["SPACE"] });
+  console.log("Space:", spaces.results[0]);
+}
+
+test().catch(console.error);
+```
+
+On the server side using `@forge/api`:
+
+```typescript
+import { ConfluenceApiV1, ConfluenceApiV2 } from '@resolution/confluence-api-client';
+import * as forgeApi from '@forge/api';
+
+export const handler = async ({ payload }) => {
+    const confluenceApiV1 = new ConfluenceApiV1({ forgeApi });
+    const currentUser = await confluenceApiV1.users.getCurrentUser();
+
+    const confluenceApiV2 = new ConfluenceApiV2({ forgeApi });
+    const spaces = await confluenceApiV2.space.getSpaces({ keys: [payload.spaceKey] });
+
+    return { currentUser, space: spaces.results[0] };
+}
+```
+
+External fetch on the server side:
+
+```typescript
+import { ConfluenceApiV1, ConfluenceApiV2 } from '@resolution/confluence-api-client';
+import { fetch } from "@forge/api";
+
+const baseUrl = "https://your-jira-instance.atlassian.net";
+
+export const handler = async ({ payload }) => {
+    const confluenceApiV1 = new ConfluenceApiV1({ fetch, baseUrl });
+    const currentUser = await confluenceApiV1.users.getCurrentUser();
+
+    const confluenceApiV2 = new ConfluenceApiV2({ fetch, baseUrl });
+    const spaces = await confluenceApiV2.space.getSpaces({ keys: [payload.spaceKey] });
+
+    return { currentUser, space: spaces.results[0] };
+}
+```
+
+## References
+
+* [Confluence API V1](https://developer.atlassian.com/cloud/confluence/rest/v1/intro/)
+* [Confluence API V2](https://developer.atlassian.com/cloud/confluence/rest/v2/intro/)
+* [Atlassian Connect for Confluence](https://developer.atlassian.com/cloud/confluence/getting-started-with-connect/)
+* [Atlassian Forge for Confluence](https://developer.atlassian.com/cloud/confluence/getting-started-with-forge/)

package/lib/index.js

@@ -30,7 +30,7 @@ validationSchemaStorage_1.validationSchemaStorage.setErrorClass(atlassian_api_co
  */
 class ConfluenceApiV2 extends BaseConfluenceApiV2Client_1.BaseConfluenceApiV2Client {
     constructor(options) {
-        super((0, atlassian_api_common_1.getApiClientOptions)(options));
+        super((0, atlassian_api_common_1.getApiClientOptions)(Object.assign(Object.assign({}, options), { basePath: "/wiki/api/v2" })));
         this.options = options;
         /**
          * Switches the API client to the app context.

package/lib/index.js.map

@@ -1 +1 @@
-{"version":3,"file":"index.js","sourceRoot":"","sources":["../src/index.ts"],"names":[],"mappings":";;;;;;;;;;;;;;;;;AAAA,2EAW0C;AAQjC,yFAdP,+BAAQ,OAcO;AANjB,sFAAmF;AACnF,sFAAmF;AAEnF,yEAAuD;AACvD,yEAAuD;AAIvD,kFAAkH;AAClH,kFAAkH;AAElH,iDAA+B,CAAC,aAAa,CAAC,+BAAQ,CAAC,CAAC;AACxD,iDAA+B,CAAC,aAAa,CAAC,+BAAQ,CAAC,CAAC;AAExD;;GAEG;AACH,MAAa,eAAgB,SAAQ,qDAAyB;IAC5D,YACY,OAKY;QAEtB,KAAK,CAAC,IAAA,0CAAmB,EAAC,OAAO,CAAC,CAAC,CAAC;QAP1B,YAAO,GAAP,OAAO,CAKK;QAKxB;;WAEG;QACH,UAAK,GAAG,IAAA,wCAAiB,GAA0B,CAAC;QACpD;;WAEG;QACH,WAAM,GAAG,IAAA,yCAAkB,GAA0B,CAAC;IATtD,CAAC;CAUF;AApBD,0CAoBC;AAED;;GAEG;AACH,MAAa,eAAgB,SAAQ,qDAAyB;IAC5D,YACY,OAKY;QAEtB,KAAK,CAAC,IAAA,0CAAmB,EAAC,OAAO,CAAC,CAAC,CAAC;QAP1B,YAAO,GAAP,OAAO,CAKK;QAIxB;;WAEG;QACH,UAAK,GAAG,IAAA,wCAAiB,GAA0B,CAAC;QACpD;;WAEG;QACH,WAAM,GAAG,IAAA,yCAAkB,GAA0B,CAAC;IARtD,CAAC;CASF;AAnBD,0CAmBC"}
+{"version":3,"file":"index.js","sourceRoot":"","sources":["../src/index.ts"],"names":[],"mappings":";;;;;;;;;;;;;;;;;AAAA,2EAW0C;AAQjC,yFAdP,+BAAQ,OAcO;AANjB,sFAAmF;AACnF,sFAAmF;AAEnF,yEAAuD;AACvD,yEAAuD;AAIvD,kFAAkH;AAClH,kFAAkH;AAElH,iDAA+B,CAAC,aAAa,CAAC,+BAAQ,CAAC,CAAC;AACxD,iDAA+B,CAAC,aAAa,CAAC,+BAAQ,CAAC,CAAC;AAExD;;GAEG;AACH,MAAa,eAAgB,SAAQ,qDAAyB;IAC5D,YACY,OAKY;QAEtB,KAAK,CAAC,IAAA,0CAAmB,kCAAM,OAAO,KAAE,QAAQ,EAAE,cAAc,IAAG,CAAC,CAAC;QAP3D,YAAO,GAAP,OAAO,CAKK;QAKxB;;WAEG;QACH,UAAK,GAAG,IAAA,wCAAiB,GAA0B,CAAC;QACpD;;WAEG;QACH,WAAM,GAAG,IAAA,yCAAkB,GAA0B,CAAC;IATtD,CAAC;CAUF;AApBD,0CAoBC;AAED;;GAEG;AACH,MAAa,eAAgB,SAAQ,qDAAyB;IAC5D,YACY,OAKY;QAEtB,KAAK,CAAC,IAAA,0CAAmB,EAAC,OAAO,CAAC,CAAC,CAAC;QAP1B,YAAO,GAAP,OAAO,CAKK;QAIxB;;WAEG;QACH,UAAK,GAAG,IAAA,wCAAiB,GAA0B,CAAC;QACpD;;WAEG;QACH,WAAM,GAAG,IAAA,yCAAkB,GAA0B,CAAC;IARtD,CAAC;CASF;AAnBD,0CAmBC"}

package/lib/openapi/v1/BaseConfluenceApiV1Client.d.ts

@@ -1,7 +1,7 @@
 import * as commonHttpClient from "./core/CommonHttpClient";
 import { CommonHttpService } from "./core/CommonHttpService";
 import type { AffectedObject, AuditRecord, AuditRecordArray, AuditRecordCreate, ChangedValue, RetentionPeriod } from "./models/audit";
-import type { AsyncId, Container, Content, ContentArray, ContentBody, ContentBodyCreate, ContentChildren, ContentId, ContentRestriction, EmbeddedContent, GenericAccountId, GenericLinks, GenericUserKey, GenericUserName, Group, GroupArrayWithLinks, Icon, LabelArray, LabelCreate, LabelV1, LongTask, LookAndFeel, Message, OperationCheckResult, Space, SpaceSettings, Theme, User, UserArray, UserDetails, VersionV1, WebResourceDependencies } from "./models/common";
+import type { AsyncId, Container, Content, ContentArray, ContentBody, ContentBodyCreate, ContentChildren, ContentId, ContentRestriction, EmbeddedContent, GenericAccountId, GenericLinks, GenericUserKey, GenericUserName, Group, GroupArrayWithLinks, IconV1, LabelArray, LabelCreate, LabelV1, LongTask, LookAndFeel, Message, OperationCheckResult, Space, SpaceSettings, Theme, UserArray, UserDetails, UserV1, VersionV1, WebResourceDependencies } from "./models/common";
 import type { ButtonLookAndFeel, ContainerLookAndFeel, ContentBlueprintDraft, ContentBodyCreateStorage, ContentChildType, ContentCreate, ContentHistory, ContentLookAndFeel, ContentMetadata, ContentUpdate, Embeddable, GlobalSpaceIdentifier, GroupArray, HeaderLookAndFeel, HorizontalHeaderLookAndFeel, MenusLookAndFeel, NavigationLookAndFeel, ScreenLookAndFeel, SearchFieldLookAndFeel, SpaceDescriptionV1, SpacePermissionV1, SuperBatchWebResources, TopNavigationLookAndFeel, UsersUserKeys } from "./models/content";
 import type { AttachmentPropertiesUpdateBody } from "./models/contentAttachments";
 import type { AsyncContentBody } from "./models/contentBody";
@@ -84,50 +84,94 @@ export declare class BaseConfluenceApiV1ClientError extends commonHttpClient.Com
 export declare class BaseConfluenceApiV1Client extends CommonHttpService {
     client: commonHttpClient.CommonHttpClient;
     getClient: () => commonHttpClient.CommonHttpClient;
+    /** @see https://developer.atlassian.com/cloud/confluence/rest/v1/api-group-analytics */
     analytics: AnalyticsService;
+    /** @see https://developer.atlassian.com/cloud/confluence/rest/v1/api-group-audit */
     audit: AuditService;
+    /** @see https://developer.atlassian.com/cloud/confluence/rest/v1/api-group-content-attachments */
     contentAttachments: ContentAttachmentsService;
+    /** @see https://developer.atlassian.com/cloud/confluence/rest/v1/api-group-content-body */
     contentBody: ContentBodyService;
+    /** @see https://developer.atlassian.com/cloud/confluence/rest/v1/api-group-content-children-and-descendants */
     contentChildrenAndDescendants: ContentChildrenAndDescendantsService;
-    /** @deprecated */
+    /**
+     * @deprecated
+     * @see https://developer.atlassian.com/cloud/confluence/rest/v1/api-group-content-comments
+     */
     contentComments: ContentCommentsService;
+    /** @see https://developer.atlassian.com/cloud/confluence/rest/v1/api-group-content-labels */
     contentLabels: ContentLabelsService;
+    /** @see https://developer.atlassian.com/cloud/confluence/rest/v1/api-group-content-macro-body */
     contentMacroBody: ContentMacroBodyService;
+    /** @see https://developer.atlassian.com/cloud/confluence/rest/v1/api-group-content-permissions */
     contentPermissions: ContentPermissionsService;
-    /** @deprecated */
+    /**
+     * @deprecated
+     * @see https://developer.atlassian.com/cloud/confluence/rest/v1/api-group-content-properties
+     */
     contentProperties: ContentPropertiesService;
+    /** @see https://developer.atlassian.com/cloud/confluence/rest/v1/api-group-content-restrictions */
     contentRestrictions: ContentRestrictionsService;
+    /** @see https://developer.atlassian.com/cloud/confluence/rest/v1/api-group-content */
     content: ContentService;
+    /** @see https://developer.atlassian.com/cloud/confluence/rest/v1/api-group-content-states */
     contentStates: ContentStatesService;
+    /** @see https://developer.atlassian.com/cloud/confluence/rest/v1/api-group-content-versions */
     contentVersions: ContentVersionsService;
+    /** @see https://developer.atlassian.com/cloud/confluence/rest/v1/api-group-content-watches */
     contentWatches: ContentWatchesService;
+    /** @see https://developer.atlassian.com/cloud/confluence/rest/v1/api-group-dynamic-modules */
     dynamicModules: DynamicModulesService;
-    /** APIs in this section can change without any prior deprecation notice. */
+    /**
+     * APIs in this section can change without any prior deprecation notice.
+     *
+     * @see https://developer.atlassian.com/cloud/confluence/rest/v1/api-group-experimental
+     */
     experimental: ExperimentalService;
     /**
      * **[WARNING](https://support.atlassian.com/user-management/docs/create-and-update-groups/)
      * The standard Atlassian group names are default names only and can be edited or
      * deleted.**  For example, an admin or Atlassian support could delete the default
      * group jira-software-users or rename it to jsw-users at any point.
+     *
+     * @see https://developer.atlassian.com/cloud/confluence/rest/v1/api-group-group
      */
     group: GroupService;
-    /** @deprecated */
+    /**
+     * @deprecated
+     * @see https://developer.atlassian.com/cloud/confluence/rest/v1/api-group-inline-tasks
+     */
     inlineTasks: InlineTasksService;
+    /** @see https://developer.atlassian.com/cloud/confluence/rest/v1/api-group-label-info */
     labelInfo: LabelInfoService;
+    /** @see https://developer.atlassian.com/cloud/confluence/rest/v1/api-group-long-running-task */
     longRunningTask: LongRunningTaskService;
+    /** @see https://developer.atlassian.com/cloud/confluence/rest/v1/api-group-relation */
     relation: RelationService;
+    /** @see https://developer.atlassian.com/cloud/confluence/rest/v1/api-group-search */
     search: SearchService;
+    /** @see https://developer.atlassian.com/cloud/confluence/rest/v1/api-group-settings */
     settings: SettingsService;
+    /** @see https://developer.atlassian.com/cloud/confluence/rest/v1/api-group-space-permissions */
     spacePermissions: SpacePermissionsService;
-    /** @deprecated */
+    /**
+     * @deprecated
+     * @see https://developer.atlassian.com/cloud/confluence/rest/v1/api-group-space-properties
+     */
     spaceProperties: SpacePropertiesService;
+    /** @see https://developer.atlassian.com/cloud/confluence/rest/v1/api-group-space */
     space: SpaceService;
+    /** @see https://developer.atlassian.com/cloud/confluence/rest/v1/api-group-space-settings */
     spaceSettings: SpaceSettingsService;
+    /** @see https://developer.atlassian.com/cloud/confluence/rest/v1/api-group-template */
     template: TemplateService;
+    /** @see https://developer.atlassian.com/cloud/confluence/rest/v1/api-group-themes */
     themes: ThemesService;
+    /** @see https://developer.atlassian.com/cloud/confluence/rest/v1/api-group-user-properties */
     userProperties: UserPropertiesService;
+    /** @see https://developer.atlassian.com/cloud/confluence/rest/v1/api-group-users */
     users: UsersService;
     constructor(options?: BaseConfluenceApiV1ClientOptions);
     static createClientWithServices: typeof commonHttpClient.createClientWithServices;
 }
-export type { AccountId, GroupName, AccountIdEmailRecord, AccountIdEmailRecordArray, BulkUserLookup, BulkUserLookupArray, UserAnonymous, AffectedObject, AuditRecord, AuditRecordArray, AuditRecordCreate, ChangedValue, RetentionPeriod, AsyncContentBody, AsyncId, Container, Content, ContentArray, ContentBody, ContentBodyCreate, ContentChildren, ContentId, ContentRestriction, EmbeddedContent, GenericAccountId, GenericLinks, GenericUserKey, GenericUserName, Group, GroupArrayWithLinks, Icon, LabelArray, LabelCreate, LabelV1, LongTask, LookAndFeel, Message, OperationCheckResult, Space, SpaceSettings, Theme, User, UserArray, UserDetails, VersionV1, WebResourceDependencies, AttachmentPropertiesUpdateBody, AvailableContentStates, ContentState, ContentStateBulkSetTaskUpdate, ContentStateFailure, ContentStateResponse, ContentStateRestInput, ContentStateSettings, BlueprintTemplate, BlueprintTemplateArray, ContentTemplate, ContentTemplateArray, ContentTemplateBody, ContentTemplateBodyCreate, ContentTemplateCreate, ContentTemplateUpdate, Breadcrumb, ContainerSummary, SearchPageResponseSearchResult, SearchResult, ButtonLookAndFeel, ContainerLookAndFeel, ContentBlueprintDraft, ContentBodyCreateStorage, ContentChildType, ContentCreate, ContentHistory, ContentLookAndFeel, ContentMetadata, ContentUpdate, Embeddable, GlobalSpaceIdentifier, GroupArray, HeaderLookAndFeel, HorizontalHeaderLookAndFeel, MenusLookAndFeel, NavigationLookAndFeel, ScreenLookAndFeel, SearchFieldLookAndFeel, SpaceDescriptionV1, SpacePermissionV1, SuperBatchWebResources, TopNavigationLookAndFeel, UsersUserKeys, ConnectModule, ConnectModules, DynamicModulesErrorMessage, ContentPermissionRequest, PermissionCheckResponse, PermissionSubjectWithGroupId, ContentPropertyArray, ContentPropertyCreate, ContentPropertyCreateNoKey, ContentPropertyUpdate, ContentPropertyV1, ContentRestrictionAddOrUpdateArray, ContentRestrictionArray, ContentRestrictionUpdate, CopyPageHierarchyRequest, CopyPageHierarchyTitleOptions, CopyPageRequest, CopyPageRequestDestination, GroupCreate, SpaceArray, SpaceCreate, SpaceDescriptionCreate, SpacePermissionCreate, SpaceUpdate, LabelCreateArray, LabelDetails, LabeledContent, LabeledContentPageResponse, LabeledContentType, LongTaskStatus, LongTaskStatusArray, LongTaskStatusWithLinks, LookAndFeelSelection, LookAndFeelSettings, LookAndFeelWithLinks, SystemInfoEntity, MacroInstance, PermissionSubject, SpacePermissionCustomContent, SpacePermissionRequest, SpacePermissionV2, PropertyValue, SpacePropertyArray, SpacePropertyCreate, SpacePropertyCreateNoKey, SpacePropertyUpdate, SpacePropertyV1, Relation, RelationArray, RelationData, SpaceSettingsUpdate, SpaceWatch, SpaceWatchArray, UserWatch, Watch, WatchArray, WatchUser, TaskPageResponse, TaskStatusUpdate, TaskV1, ThemeArray, ThemeNoLinks, ThemeUpdate, UserProperty, UserPropertyCreate, UserPropertyKeyArray, UserPropertyUpdate, VersionArray, VersionRestore, };
+export type { AccountId, GroupName, AccountIdEmailRecord, AccountIdEmailRecordArray, BulkUserLookup, BulkUserLookupArray, UserAnonymous, AffectedObject, AuditRecord, AuditRecordArray, AuditRecordCreate, ChangedValue, RetentionPeriod, AsyncContentBody, AsyncId, Container, Content, ContentArray, ContentBody, ContentBodyCreate, ContentChildren, ContentId, ContentRestriction, EmbeddedContent, GenericAccountId, GenericLinks, GenericUserKey, GenericUserName, Group, GroupArrayWithLinks, IconV1, LabelArray, LabelCreate, LabelV1, LongTask, LookAndFeel, Message, OperationCheckResult, Space, SpaceSettings, Theme, UserArray, UserDetails, UserV1, VersionV1, WebResourceDependencies, AttachmentPropertiesUpdateBody, AvailableContentStates, ContentState, ContentStateBulkSetTaskUpdate, ContentStateFailure, ContentStateResponse, ContentStateRestInput, ContentStateSettings, BlueprintTemplate, BlueprintTemplateArray, ContentTemplate, ContentTemplateArray, ContentTemplateBody, ContentTemplateBodyCreate, ContentTemplateCreate, ContentTemplateUpdate, Breadcrumb, ContainerSummary, SearchPageResponseSearchResult, SearchResult, ButtonLookAndFeel, ContainerLookAndFeel, ContentBlueprintDraft, ContentBodyCreateStorage, ContentChildType, ContentCreate, ContentHistory, ContentLookAndFeel, ContentMetadata, ContentUpdate, Embeddable, GlobalSpaceIdentifier, GroupArray, HeaderLookAndFeel, HorizontalHeaderLookAndFeel, MenusLookAndFeel, NavigationLookAndFeel, ScreenLookAndFeel, SearchFieldLookAndFeel, SpaceDescriptionV1, SpacePermissionV1, SuperBatchWebResources, TopNavigationLookAndFeel, UsersUserKeys, ConnectModule, ConnectModules, DynamicModulesErrorMessage, ContentPermissionRequest, PermissionCheckResponse, PermissionSubjectWithGroupId, ContentPropertyArray, ContentPropertyCreate, ContentPropertyCreateNoKey, ContentPropertyUpdate, ContentPropertyV1, ContentRestrictionAddOrUpdateArray, ContentRestrictionArray, ContentRestrictionUpdate, CopyPageHierarchyRequest, CopyPageHierarchyTitleOptions, CopyPageRequest, CopyPageRequestDestination, GroupCreate, SpaceArray, SpaceCreate, SpaceDescriptionCreate, SpacePermissionCreate, SpaceUpdate, LabelCreateArray, LabelDetails, LabeledContent, LabeledContentPageResponse, LabeledContentType, LongTaskStatus, LongTaskStatusArray, LongTaskStatusWithLinks, LookAndFeelSelection, LookAndFeelSettings, LookAndFeelWithLinks, SystemInfoEntity, MacroInstance, PermissionSubject, SpacePermissionCustomContent, SpacePermissionRequest, SpacePermissionV2, PropertyValue, SpacePropertyArray, SpacePropertyCreate, SpacePropertyCreateNoKey, SpacePropertyUpdate, SpacePropertyV1, Relation, RelationArray, RelationData, SpaceSettingsUpdate, SpaceWatch, SpaceWatchArray, UserWatch, Watch, WatchArray, WatchUser, TaskPageResponse, TaskStatusUpdate, TaskV1, ThemeArray, ThemeNoLinks, ThemeUpdate, UserProperty, UserPropertyCreate, UserPropertyKeyArray, UserPropertyUpdate, VersionArray, VersionRestore, };

package/lib/openapi/v1/BaseConfluenceApiV1Client.js

@@ -70,48 +70,92 @@ class BaseConfluenceApiV1Client extends CommonHttpService_1.CommonHttpService {
             errorClass: BaseConfluenceApiV1ClientError,
         });
         this.getClient = () => this.client;
+        /** @see https://developer.atlassian.com/cloud/confluence/rest/v1/api-group-analytics */
         this.analytics = new AnalyticsService_1.AnalyticsService(this.getClient);
+        /** @see https://developer.atlassian.com/cloud/confluence/rest/v1/api-group-audit */
         this.audit = new AuditService_1.AuditService(this.getClient);
+        /** @see https://developer.atlassian.com/cloud/confluence/rest/v1/api-group-content-attachments */
         this.contentAttachments = new ContentAttachmentsService_1.ContentAttachmentsService(this.getClient);
+        /** @see https://developer.atlassian.com/cloud/confluence/rest/v1/api-group-content-body */
         this.contentBody = new ContentBodyService_1.ContentBodyService(this.getClient);
+        /** @see https://developer.atlassian.com/cloud/confluence/rest/v1/api-group-content-children-and-descendants */
         this.contentChildrenAndDescendants = new ContentChildrenAndDescendantsService_1.ContentChildrenAndDescendantsService(this.getClient);
-        /** @deprecated */
+        /**
+         * @deprecated
+         * @see https://developer.atlassian.com/cloud/confluence/rest/v1/api-group-content-comments
+         */
         this.contentComments = new ContentCommentsService_1.ContentCommentsService(this.getClient);
+        /** @see https://developer.atlassian.com/cloud/confluence/rest/v1/api-group-content-labels */
         this.contentLabels = new ContentLabelsService_1.ContentLabelsService(this.getClient);
+        /** @see https://developer.atlassian.com/cloud/confluence/rest/v1/api-group-content-macro-body */
         this.contentMacroBody = new ContentMacroBodyService_1.ContentMacroBodyService(this.getClient);
+        /** @see https://developer.atlassian.com/cloud/confluence/rest/v1/api-group-content-permissions */
         this.contentPermissions = new ContentPermissionsService_1.ContentPermissionsService(this.getClient);
-        /** @deprecated */
+        /**
+         * @deprecated
+         * @see https://developer.atlassian.com/cloud/confluence/rest/v1/api-group-content-properties
+         */
         this.contentProperties = new ContentPropertiesService_1.ContentPropertiesService(this.getClient);
+        /** @see https://developer.atlassian.com/cloud/confluence/rest/v1/api-group-content-restrictions */
         this.contentRestrictions = new ContentRestrictionsService_1.ContentRestrictionsService(this.getClient);
+        /** @see https://developer.atlassian.com/cloud/confluence/rest/v1/api-group-content */
         this.content = new ContentService_1.ContentService(this.getClient);
+        /** @see https://developer.atlassian.com/cloud/confluence/rest/v1/api-group-content-states */
         this.contentStates = new ContentStatesService_1.ContentStatesService(this.getClient);
+        /** @see https://developer.atlassian.com/cloud/confluence/rest/v1/api-group-content-versions */
         this.contentVersions = new ContentVersionsService_1.ContentVersionsService(this.getClient);
+        /** @see https://developer.atlassian.com/cloud/confluence/rest/v1/api-group-content-watches */
         this.contentWatches = new ContentWatchesService_1.ContentWatchesService(this.getClient);
+        /** @see https://developer.atlassian.com/cloud/confluence/rest/v1/api-group-dynamic-modules */
         this.dynamicModules = new DynamicModulesService_1.DynamicModulesService(this.getClient);
-        /** APIs in this section can change without any prior deprecation notice. */
+        /**
+         * APIs in this section can change without any prior deprecation notice.
+         *
+         * @see https://developer.atlassian.com/cloud/confluence/rest/v1/api-group-experimental
+         */
         this.experimental = new ExperimentalService_1.ExperimentalService(this.getClient);
         /**
          * **[WARNING](https://support.atlassian.com/user-management/docs/create-and-update-groups/)
          * The standard Atlassian group names are default names only and can be edited or
          * deleted.**  For example, an admin or Atlassian support could delete the default
          * group jira-software-users or rename it to jsw-users at any point.
+         *
+         * @see https://developer.atlassian.com/cloud/confluence/rest/v1/api-group-group
          */
         this.group = new GroupService_1.GroupService(this.getClient);
-        /** @deprecated */
+        /**
+         * @deprecated
+         * @see https://developer.atlassian.com/cloud/confluence/rest/v1/api-group-inline-tasks
+         */
         this.inlineTasks = new InlineTasksService_1.InlineTasksService(this.getClient);
+        /** @see https://developer.atlassian.com/cloud/confluence/rest/v1/api-group-label-info */
         this.labelInfo = new LabelInfoService_1.LabelInfoService(this.getClient);
+        /** @see https://developer.atlassian.com/cloud/confluence/rest/v1/api-group-long-running-task */
         this.longRunningTask = new LongRunningTaskService_1.LongRunningTaskService(this.getClient);
+        /** @see https://developer.atlassian.com/cloud/confluence/rest/v1/api-group-relation */
         this.relation = new RelationService_1.RelationService(this.getClient);
+        /** @see https://developer.atlassian.com/cloud/confluence/rest/v1/api-group-search */
         this.search = new SearchService_1.SearchService(this.getClient);
+        /** @see https://developer.atlassian.com/cloud/confluence/rest/v1/api-group-settings */
         this.settings = new SettingsService_1.SettingsService(this.getClient);
+        /** @see https://developer.atlassian.com/cloud/confluence/rest/v1/api-group-space-permissions */
         this.spacePermissions = new SpacePermissionsService_1.SpacePermissionsService(this.getClient);
-        /** @deprecated */
+        /**
+         * @deprecated
+         * @see https://developer.atlassian.com/cloud/confluence/rest/v1/api-group-space-properties
+         */
         this.spaceProperties = new SpacePropertiesService_1.SpacePropertiesService(this.getClient);
+        /** @see https://developer.atlassian.com/cloud/confluence/rest/v1/api-group-space */
         this.space = new SpaceService_1.SpaceService(this.getClient);
+        /** @see https://developer.atlassian.com/cloud/confluence/rest/v1/api-group-space-settings */
         this.spaceSettings = new SpaceSettingsService_1.SpaceSettingsService(this.getClient);
+        /** @see https://developer.atlassian.com/cloud/confluence/rest/v1/api-group-template */
         this.template = new TemplateService_1.TemplateService(this.getClient);
+        /** @see https://developer.atlassian.com/cloud/confluence/rest/v1/api-group-themes */
         this.themes = new ThemesService_1.ThemesService(this.getClient);
+        /** @see https://developer.atlassian.com/cloud/confluence/rest/v1/api-group-user-properties */
         this.userProperties = new UserPropertiesService_1.UserPropertiesService(this.getClient);
+        /** @see https://developer.atlassian.com/cloud/confluence/rest/v1/api-group-users */
         this.users = new UsersService_1.UsersService(this.getClient);
         this.client.setOptions(Object.assign(Object.assign({}, this.client.getOptions()), options));
     }

package/lib/openapi/v1/BaseConfluenceApiV1Client.js.map

@@ -1 +1 @@
-{"version":3,"file":"BaseConfluenceApiV1Client.js","sourceRoot":"","sources":["../../../src/openapi/v1/BaseConfluenceApiV1Client.ts"],"names":[],"mappings":";;;AAAA,eAAe;AACf,wDAAwD;AACxD,gDAAgD;AAChD,4DAA4D;AAC5D,gEAA6D;AAoM7D,kEAA+D;AAC/D,0DAAuD;AACvD,oFAAiF;AACjF,sEAAmE;AACnE,0GAAuG;AACvG,8EAA2E;AAC3E,0EAAuE;AACvE,gFAA6E;AAC7E,oFAAiF;AACjF,kFAA+E;AAC/E,sFAAmF;AACnF,8DAA2D;AAC3D,0EAAuE;AACvE,8EAA2E;AAC3E,4EAAyE;AACzE,4EAAyE;AACzE,wEAAqE;AACrE,0DAAuD;AACvD,sEAAmE;AACnE,kEAA+D;AAC/D,8EAA2E;AAC3E,gEAA6D;AAC7D,4DAAyD;AACzD,gEAA6D;AAC7D,gFAA6E;AAC7E,8EAA2E;AAC3E,0DAAuD;AACvD,0EAAuE;AACvE,gEAA6D;AAC7D,4DAAyD;AACzD,4EAAyE;AACzE,0DAAuD;AACvD,uEAAoE;AAGpE,MAAa,8BAA+B,SAAQ,gBAAgB,CAAC,qBAAqB;IAA1F;;QACE,SAAI,GAAG,gCAAgC,CAAC;IAC1C,CAAC;CAAA;AAFD,wEAEC;AACD;;;;;;;;;;;;;;GAcG;AACH,MAAa,yBAA0B,SAAQ,qCAAiB;IAoD9D,YAAY,OAA0C;QACpD,KAAK,CAAC,GAAG,EAAE,CAAC,IAAI,CAAC,MAAM,CAAC,CAAC;QApD3B,WAAM,GAAG,IAAI,gBAAgB,CAAC,gBAAgB,CAAC;YAC7C,OAAO,EAAE,6BAA6B;YACtC,kBAAkB,EAAE,MAAM;YAC1B,UAAU,EAAE,8BAA8B;SAC3C,CAAC,CAAC;QACH,cAAS,GAAG,GAAG,EAAE,CAAC,IAAI,CAAC,MAAM,CAAC;QAC9B,cAAS,GAAG,IAAI,mCAAgB,CAAC,IAAI,CAAC,SAAS,CAAC,CAAC;QACjD,UAAK,GAAG,IAAI,2BAAY,CAAC,IAAI,CAAC,SAAS,CAAC,CAAC;QACzC,uBAAkB,GAAG,IAAI,qDAAyB,CAAC,IAAI,CAAC,SAAS,CAAC,CAAC;QACnE,gBAAW,GAAG,IAAI,uCAAkB,CAAC,IAAI,CAAC,SAAS,CAAC,CAAC;QACrD,kCAA6B,GAAG,IAAI,2EAAoC,CACtE,IAAI,CAAC,SAAS,CACf,CAAC;QACF,kBAAkB;QAClB,oBAAe,GAAG,IAAI,+CAAsB,CAAC,IAAI,CAAC,SAAS,CAAC,CAAC;QAC7D,kBAAa,GAAG,IAAI,2CAAoB,CAAC,IAAI,CAAC,SAAS,CAAC,CAAC;QACzD,qBAAgB,GAAG,IAAI,iDAAuB,CAAC,IAAI,CAAC,SAAS,CAAC,CAAC;QAC/D,uBAAkB,GAAG,IAAI,qDAAyB,CAAC,IAAI,CAAC,SAAS,CAAC,CAAC;QACnE,kBAAkB;QAClB,sBAAiB,GAAG,IAAI,mDAAwB,CAAC,IAAI,CAAC,SAAS,CAAC,CAAC;QACjE,wBAAmB,GAAG,IAAI,uDAA0B,CAAC,IAAI,CAAC,SAAS,CAAC,CAAC;QACrE,YAAO,GAAG,IAAI,+BAAc,CAAC,IAAI,CAAC,SAAS,CAAC,CAAC;QAC7C,kBAAa,GAAG,IAAI,2CAAoB,CAAC,IAAI,CAAC,SAAS,CAAC,CAAC;QACzD,oBAAe,GAAG,IAAI,+CAAsB,CAAC,IAAI,CAAC,SAAS,CAAC,CAAC;QAC7D,mBAAc,GAAG,IAAI,6CAAqB,CAAC,IAAI,CAAC,SAAS,CAAC,CAAC;QAC3D,mBAAc,GAAG,IAAI,6CAAqB,CAAC,IAAI,CAAC,SAAS,CAAC,CAAC;QAC3D,4EAA4E;QAC5E,iBAAY,GAAG,IAAI,yCAAmB,CAAC,IAAI,CAAC,SAAS,CAAC,CAAC;QACvD;;;;;WAKG;QACH,UAAK,GAAG,IAAI,2BAAY,CAAC,IAAI,CAAC,SAAS,CAAC,CAAC;QACzC,kBAAkB;QAClB,gBAAW,GAAG,IAAI,uCAAkB,CAAC,IAAI,CAAC,SAAS,CAAC,CAAC;QACrD,cAAS,GAAG,IAAI,mCAAgB,CAAC,IAAI,CAAC,SAAS,CAAC,CAAC;QACjD,oBAAe,GAAG,IAAI,+CAAsB,CAAC,IAAI,CAAC,SAAS,CAAC,CAAC;QAC7D,aAAQ,GAAG,IAAI,iCAAe,CAAC,IAAI,CAAC,SAAS,CAAC,CAAC;QAC/C,WAAM,GAAG,IAAI,6BAAa,CAAC,IAAI,CAAC,SAAS,CAAC,CAAC;QAC3C,aAAQ,GAAG,IAAI,iCAAe,CAAC,IAAI,CAAC,SAAS,CAAC,CAAC;QAC/C,qBAAgB,GAAG,IAAI,iDAAuB,CAAC,IAAI,CAAC,SAAS,CAAC,CAAC;QAC/D,kBAAkB;QAClB,oBAAe,GAAG,IAAI,+CAAsB,CAAC,IAAI,CAAC,SAAS,CAAC,CAAC;QAC7D,UAAK,GAAG,IAAI,2BAAY,CAAC,IAAI,CAAC,SAAS,CAAC,CAAC;QACzC,kBAAa,GAAG,IAAI,2CAAoB,CAAC,IAAI,CAAC,SAAS,CAAC,CAAC;QACzD,aAAQ,GAAG,IAAI,iCAAe,CAAC,IAAI,CAAC,SAAS,CAAC,CAAC;QAC/C,WAAM,GAAG,IAAI,6BAAa,CAAC,IAAI,CAAC,SAAS,CAAC,CAAC;QAC3C,mBAAc,GAAG,IAAI,6CAAqB,CAAC,IAAI,CAAC,SAAS,CAAC,CAAC;QAC3D,UAAK,GAAG,IAAI,2BAAY,CAAC,IAAI,CAAC,SAAS,CAAC,CAAC;QAGvC,IAAI,CAAC,MAAM,CAAC,UAAU,iCACjB,IAAI,CAAC,MAAM,CAAC,UAAU,EAAE,GACxB,OAAO,EACV,CAAC;IACL,CAAC;;AA1DH,8DA4DC;AADQ,kDAAwB,GAAG,gBAAgB,CAAC,wBAAwB,AAA5C,CAA6C;AAE9E,iDAAuB,CAAC,aAAa,CAAC,8BAA8B,CAAC,CAAC"}
+{"version":3,"file":"BaseConfluenceApiV1Client.js","sourceRoot":"","sources":["../../../src/openapi/v1/BaseConfluenceApiV1Client.ts"],"names":[],"mappings":";;;AAAA,eAAe;AACf,wDAAwD;AACxD,gDAAgD;AAChD,4DAA4D;AAC5D,gEAA6D;AAoM7D,kEAA+D;AAC/D,0DAAuD;AACvD,oFAAiF;AACjF,sEAAmE;AACnE,0GAAuG;AACvG,8EAA2E;AAC3E,0EAAuE;AACvE,gFAA6E;AAC7E,oFAAiF;AACjF,kFAA+E;AAC/E,sFAAmF;AACnF,8DAA2D;AAC3D,0EAAuE;AACvE,8EAA2E;AAC3E,4EAAyE;AACzE,4EAAyE;AACzE,wEAAqE;AACrE,0DAAuD;AACvD,sEAAmE;AACnE,kEAA+D;AAC/D,8EAA2E;AAC3E,gEAA6D;AAC7D,4DAAyD;AACzD,gEAA6D;AAC7D,gFAA6E;AAC7E,8EAA2E;AAC3E,0DAAuD;AACvD,0EAAuE;AACvE,gEAA6D;AAC7D,4DAAyD;AACzD,4EAAyE;AACzE,0DAAuD;AACvD,uEAAoE;AAGpE,MAAa,8BAA+B,SAAQ,gBAAgB,CAAC,qBAAqB;IAA1F;;QACE,SAAI,GAAG,gCAAgC,CAAC;IAC1C,CAAC;CAAA;AAFD,wEAEC;AACD;;;;;;;;;;;;;;GAcG;AACH,MAAa,yBAA0B,SAAQ,qCAAiB;IAgG9D,YAAY,OAA0C;QACpD,KAAK,CAAC,GAAG,EAAE,CAAC,IAAI,CAAC,MAAM,CAAC,CAAC;QAhG3B,WAAM,GAAG,IAAI,gBAAgB,CAAC,gBAAgB,CAAC;YAC7C,OAAO,EAAE,6BAA6B;YACtC,kBAAkB,EAAE,MAAM;YAC1B,UAAU,EAAE,8BAA8B;SAC3C,CAAC,CAAC;QACH,cAAS,GAAG,GAAG,EAAE,CAAC,IAAI,CAAC,MAAM,CAAC;QAC9B,wFAAwF;QACxF,cAAS,GAAG,IAAI,mCAAgB,CAAC,IAAI,CAAC,SAAS,CAAC,CAAC;QACjD,oFAAoF;QACpF,UAAK,GAAG,IAAI,2BAAY,CAAC,IAAI,CAAC,SAAS,CAAC,CAAC;QACzC,kGAAkG;QAClG,uBAAkB,GAAG,IAAI,qDAAyB,CAAC,IAAI,CAAC,SAAS,CAAC,CAAC;QACnE,2FAA2F;QAC3F,gBAAW,GAAG,IAAI,uCAAkB,CAAC,IAAI,CAAC,SAAS,CAAC,CAAC;QACrD,+GAA+G;QAC/G,kCAA6B,GAAG,IAAI,2EAAoC,CACtE,IAAI,CAAC,SAAS,CACf,CAAC;QACF;;;WAGG;QACH,oBAAe,GAAG,IAAI,+CAAsB,CAAC,IAAI,CAAC,SAAS,CAAC,CAAC;QAC7D,6FAA6F;QAC7F,kBAAa,GAAG,IAAI,2CAAoB,CAAC,IAAI,CAAC,SAAS,CAAC,CAAC;QACzD,iGAAiG;QACjG,qBAAgB,GAAG,IAAI,iDAAuB,CAAC,IAAI,CAAC,SAAS,CAAC,CAAC;QAC/D,kGAAkG;QAClG,uBAAkB,GAAG,IAAI,qDAAyB,CAAC,IAAI,CAAC,SAAS,CAAC,CAAC;QACnE;;;WAGG;QACH,sBAAiB,GAAG,IAAI,mDAAwB,CAAC,IAAI,CAAC,SAAS,CAAC,CAAC;QACjE,mGAAmG;QACnG,wBAAmB,GAAG,IAAI,uDAA0B,CAAC,IAAI,CAAC,SAAS,CAAC,CAAC;QACrE,sFAAsF;QACtF,YAAO,GAAG,IAAI,+BAAc,CAAC,IAAI,CAAC,SAAS,CAAC,CAAC;QAC7C,6FAA6F;QAC7F,kBAAa,GAAG,IAAI,2CAAoB,CAAC,IAAI,CAAC,SAAS,CAAC,CAAC;QACzD,+FAA+F;QAC/F,oBAAe,GAAG,IAAI,+CAAsB,CAAC,IAAI,CAAC,SAAS,CAAC,CAAC;QAC7D,8FAA8F;QAC9F,mBAAc,GAAG,IAAI,6CAAqB,CAAC,IAAI,CAAC,SAAS,CAAC,CAAC;QAC3D,8FAA8F;QAC9F,mBAAc,GAAG,IAAI,6CAAqB,CAAC,IAAI,CAAC,SAAS,CAAC,CAAC;QAC3D;;;;WAIG;QACH,iBAAY,GAAG,IAAI,yCAAmB,CAAC,IAAI,CAAC,SAAS,CAAC,CAAC;QACvD;;;;;;;WAOG;QACH,UAAK,GAAG,IAAI,2BAAY,CAAC,IAAI,CAAC,SAAS,CAAC,CAAC;QACzC;;;WAGG;QACH,gBAAW,GAAG,IAAI,uCAAkB,CAAC,IAAI,CAAC,SAAS,CAAC,CAAC;QACrD,yFAAyF;QACzF,cAAS,GAAG,IAAI,mCAAgB,CAAC,IAAI,CAAC,SAAS,CAAC,CAAC;QACjD,gGAAgG;QAChG,oBAAe,GAAG,IAAI,+CAAsB,CAAC,IAAI,CAAC,SAAS,CAAC,CAAC;QAC7D,uFAAuF;QACvF,aAAQ,GAAG,IAAI,iCAAe,CAAC,IAAI,CAAC,SAAS,CAAC,CAAC;QAC/C,qFAAqF;QACrF,WAAM,GAAG,IAAI,6BAAa,CAAC,IAAI,CAAC,SAAS,CAAC,CAAC;QAC3C,uFAAuF;QACvF,aAAQ,GAAG,IAAI,iCAAe,CAAC,IAAI,CAAC,SAAS,CAAC,CAAC;QAC/C,gGAAgG;QAChG,qBAAgB,GAAG,IAAI,iDAAuB,CAAC,IAAI,CAAC,SAAS,CAAC,CAAC;QAC/D;;;WAGG;QACH,oBAAe,GAAG,IAAI,+CAAsB,CAAC,IAAI,CAAC,SAAS,CAAC,CAAC;QAC7D,oFAAoF;QACpF,UAAK,GAAG,IAAI,2BAAY,CAAC,IAAI,CAAC,SAAS,CAAC,CAAC;QACzC,6FAA6F;QAC7F,kBAAa,GAAG,IAAI,2CAAoB,CAAC,IAAI,CAAC,SAAS,CAAC,CAAC;QACzD,uFAAuF;QACvF,aAAQ,GAAG,IAAI,iCAAe,CAAC,IAAI,CAAC,SAAS,CAAC,CAAC;QAC/C,qFAAqF;QACrF,WAAM,GAAG,IAAI,6BAAa,CAAC,IAAI,CAAC,SAAS,CAAC,CAAC;QAC3C,8FAA8F;QAC9F,mBAAc,GAAG,IAAI,6CAAqB,CAAC,IAAI,CAAC,SAAS,CAAC,CAAC;QAC3D,oFAAoF;QACpF,UAAK,GAAG,IAAI,2BAAY,CAAC,IAAI,CAAC,SAAS,CAAC,CAAC;QAGvC,IAAI,CAAC,MAAM,CAAC,UAAU,iCACjB,IAAI,CAAC,MAAM,CAAC,UAAU,EAAE,GACxB,OAAO,EACV,CAAC;IACL,CAAC;;AAtGH,8DAwGC;AADQ,kDAAwB,GAAG,gBAAgB,CAAC,wBAAwB,AAA5C,CAA6C;AAE9E,iDAAuB,CAAC,aAAa,CAAC,8BAA8B,CAAC,CAAC"}

package/lib/openapi/v1/models/common.d.ts

@@ -258,7 +258,7 @@ export interface GroupArrayWithLinks extends Record<string, unknown> {
  * This object represents an icon. If used as a profilePicture, this may be
  * returned as null, depending on the user's privacy setting.
  */
-export interface Icon extends Record<string, unknown> {
+export interface IconV1 extends Record<string, unknown> {
     path: string;
     width: number;
     height: number;
@@ -343,7 +343,7 @@ export interface Space extends Record<string, unknown> {
      * This object represents an icon. If used as a profilePicture, this may be
      * returned as null, depending on the user's privacy setting.
      */
-    icon?: Icon | null;
+    icon?: IconV1 | null;
     description?: {
         plain?: SpaceDescriptionV1;
         view?: SpaceDescriptionV1;
@@ -375,7 +375,7 @@ export interface Space extends Record<string, unknown> {
     lookAndFeel?: LookAndFeel;
     history?: {
         createdDate: string;
-        createdBy?: User | null;
+        createdBy?: UserV1 | null;
     } & {
         [key: string]: unknown;
     };
@@ -424,80 +424,11 @@ export interface Theme extends Record<string, unknown> {
      * This object represents an icon. If used as a profilePicture, this may be
      * returned as null, depending on the user's privacy setting.
      */
-    icon?: Icon | null;
-    _links?: GenericLinks;
-}
-export interface User extends Record<string, unknown> {
-    type: "known" | "unknown" | "anonymous" | "user";
-    /**
-     * This property is no longer available and will be removed from the documentation
-     * soon.
-     * Use `accountId` instead.
-     * See the [deprecation
-     * notice](/cloud/confluence/deprecation-notice-user-privacy-api-migration-guide/)
-     * for details.
-     */
-    username?: GenericUserName | null;
-    /**
-     * This property is no longer available and will be removed from the documentation
-     * soon.
-     * Use `accountId` instead.
-     * See the [deprecation
-     * notice](/cloud/confluence/deprecation-notice-user-privacy-api-migration-guide/)
-     * for details.
-     */
-    userKey?: GenericUserKey | null;
-    /**
-     * The account ID of the user, which uniquely identifies the user across all
-     * Atlassian products.
-     * For example, `384093:32b4d9w0-f6a5-3535-11a3-9c8c88d10192`.
-     */
-    accountId?: GenericAccountId | null;
-    /**
-     * The account type of the user, may return empty string if unavailable. App is if
-     * the user is a bot user created on behalf of an Atlassian app.
-     */
-    accountType?: "atlassian" | "app" | "";
-    /**
-     * The email address of the user. Depending on the user's privacy setting, this
-     * may return an empty string.
-     */
-    email?: string | null;
-    /** The public name or nickname of the user. Will always contain a value. */
-    publicName?: string;
-    /**
-     * This object represents an icon. If used as a profilePicture, this may be
-     * returned as null, depending on the user's privacy setting.
-     */
-    profilePicture?: Icon | null;
-    /**
-     * The displays name of the user. Depending on the user's privacy setting, this
-     * may be the same as publicName.
-     */
-    displayName?: string | null;
-    /**
-     * This displays user time zone. Depending on the user's privacy setting, this may
-     * return null.
-     */
-    timeZone?: string | null;
-    /** Whether the user is an external collaborator user */
-    isExternalCollaborator?: boolean;
-    /** Whether the user is an external collaborator user */
-    externalCollaborator?: boolean;
-    operations?: OperationCheckResult[] | null;
-    details?: UserDetails;
-    personalSpace?: Space | null;
-    _expandable?: {
-        operations?: string;
-        details?: string;
-        personalSpace?: string;
-    } & {
-        [key: string]: unknown;
-    };
+    icon?: IconV1 | null;
     _links?: GenericLinks;
 }
 export interface UserArray extends Record<string, unknown> {
-    results: (User | null)[];
+    results: (UserV1 | null)[];
     start?: number;
     limit?: number;
     size?: number;
@@ -575,8 +506,77 @@ export interface UserDetails extends Record<string, unknown> {
         [key: string]: unknown;
     };
 }
+export interface UserV1 extends Record<string, unknown> {
+    type: "known" | "unknown" | "anonymous" | "user";
+    /**
+     * This property is no longer available and will be removed from the documentation
+     * soon.
+     * Use `accountId` instead.
+     * See the [deprecation
+     * notice](/cloud/confluence/deprecation-notice-user-privacy-api-migration-guide/)
+     * for details.
+     */
+    username?: GenericUserName | null;
+    /**
+     * This property is no longer available and will be removed from the documentation
+     * soon.
+     * Use `accountId` instead.
+     * See the [deprecation
+     * notice](/cloud/confluence/deprecation-notice-user-privacy-api-migration-guide/)
+     * for details.
+     */
+    userKey?: GenericUserKey | null;
+    /**
+     * The account ID of the user, which uniquely identifies the user across all
+     * Atlassian products.
+     * For example, `384093:32b4d9w0-f6a5-3535-11a3-9c8c88d10192`.
+     */
+    accountId?: GenericAccountId | null;
+    /**
+     * The account type of the user, may return empty string if unavailable. App is if
+     * the user is a bot user created on behalf of an Atlassian app.
+     */
+    accountType?: "atlassian" | "app" | "";
+    /**
+     * The email address of the user. Depending on the user's privacy setting, this
+     * may return an empty string.
+     */
+    email?: string | null;
+    /** The public name or nickname of the user. Will always contain a value. */
+    publicName?: string;
+    /**
+     * This object represents an icon. If used as a profilePicture, this may be
+     * returned as null, depending on the user's privacy setting.
+     */
+    profilePicture?: IconV1 | null;
+    /**
+     * The displays name of the user. Depending on the user's privacy setting, this
+     * may be the same as publicName.
+     */
+    displayName?: string | null;
+    /**
+     * This displays user time zone. Depending on the user's privacy setting, this may
+     * return null.
+     */
+    timeZone?: string | null;
+    /** Whether the user is an external collaborator user */
+    isExternalCollaborator?: boolean;
+    /** Whether the user is an external collaborator user */
+    externalCollaborator?: boolean;
+    operations?: OperationCheckResult[] | null;
+    details?: UserDetails;
+    personalSpace?: Space | null;
+    _expandable?: {
+        operations?: string;
+        details?: string;
+        personalSpace?: string;
+    } & {
+        [key: string]: unknown;
+    };
+    _links?: GenericLinks;
+}
 export interface VersionV1 extends Record<string, unknown> {
-    by?: User | null;
+    by?: UserV1 | null;
     when: string | null;
     friendlyWhen?: string | null;
     message?: string | null;