confluence.js 1.2.2 → 1.4.0

package/src/api/group.ts

@@ -1,7 +1,7 @@
 import * as Models from './models';
 import * as Parameters from './parameters';
-import { Client } from '../clients';
 import { Callback } from '../callback';
+import { Client } from '../clients';
 import { RequestConfig } from '../requestConfig';
 
 export class Group {
@@ -38,7 +38,7 @@ export class Group {
       },
     };
 
-    return this.client.sendRequest(config, callback, { methodName: 'getGroups' });
+    return this.client.sendRequest(config, callback);
   }
 
   /**
@@ -65,7 +65,7 @@ export class Group {
       },
     };
 
-    return this.client.sendRequest(config, callback, { methodName: 'createGroup' });
+    return this.client.sendRequest(config, callback);
   }
 
   /**
@@ -89,7 +89,7 @@ export class Group {
       },
     };
 
-    return this.client.sendRequest(config, callback, { methodName: 'removeGroup' });
+    return this.client.sendRequest(config, callback);
   }
 
   /**
@@ -124,7 +124,7 @@ export class Group {
       },
     };
 
-    return this.client.sendRequest(config, callback, { methodName: 'getGroupByQueryParam' });
+    return this.client.sendRequest(config, callback);
   }
 
   /**
@@ -156,7 +156,7 @@ export class Group {
       },
     };
 
-    return this.client.sendRequest(config, callback, { methodName: 'getGroupByGroupId' });
+    return this.client.sendRequest(config, callback);
   }
 
   /**
@@ -180,7 +180,7 @@ export class Group {
       },
     };
 
-    return this.client.sendRequest(config, callback, { methodName: 'removeGroupById' });
+    return this.client.sendRequest(config, callback);
   }
 
   /** @deprecated Will be removed in the next major version. Use `getGroupByName` instead. */
@@ -190,6 +190,7 @@ export class Group {
   async getGroup<T = Models.Group>(parameters: Parameters.GetGroup, callback?: Callback<T>): Promise<void | T> {
     return this.getGroupByName(parameters, callback!);
   }
+
   /**
    * Returns a user group for a given group name.
    *
@@ -217,7 +218,7 @@ export class Group {
       method: 'GET',
     };
 
-    return this.client.sendRequest(config, callback, { methodName: 'getGroupByName' });
+    return this.client.sendRequest(config, callback);
   }
 
   /**
@@ -251,10 +252,11 @@ export class Group {
         name: parameters.name,
         start: parameters.start,
         limit: parameters.limit,
+        shouldReturnTotalSize: parameters.shouldReturnTotalSize,
       },
     };
 
-    return this.client.sendRequest(config, callback, { methodName: 'getMembersByQueryParam' });
+    return this.client.sendRequest(config, callback);
   }
 
   /**
@@ -291,7 +293,7 @@ export class Group {
       },
     };
 
-    return this.client.sendRequest(config, callback, { methodName: 'getGroupMembers' });
+    return this.client.sendRequest(config, callback);
   }
 
   /** @deprecated Will be removed in the next major version. Use `searchGroups` instead. */
@@ -329,10 +331,11 @@ export class Group {
         query: parameters.query,
         start: parameters.start,
         limit: parameters.limit,
+        shouldReturnTotalSize: parameters.shouldReturnTotalSize,
       },
     };
 
-    return this.client.sendRequest(config, callback, { methodName: 'searchGroups' });
+    return this.client.sendRequest(config, callback);
   }
 
   /**
@@ -368,7 +371,7 @@ export class Group {
       },
     };
 
-    return this.client.sendRequest(config, callback, { methodName: 'addUserToGroupByGroupId' });
+    return this.client.sendRequest(config, callback);
   }
 
   /**
@@ -402,7 +405,7 @@ export class Group {
       },
     };
 
-    return this.client.sendRequest(config, callback, { methodName: 'removeMemberFromGroupByGroupId' });
+    return this.client.sendRequest(config, callback);
   }
 
   /**
@@ -439,10 +442,11 @@ export class Group {
       params: {
         start: parameters.start,
         limit: parameters.limit,
+        shouldReturnTotalSize: parameters.shouldReturnTotalSize,
       },
     };
 
-    return this.client.sendRequest(config, callback, { methodName: 'getGroupMembersByGroupId' });
+    return this.client.sendRequest(config, callback);
   }
 
   /**
@@ -469,7 +473,7 @@ export class Group {
       },
     };
 
-    return this.client.sendRequest(config, callback, { methodName: 'addUserToGroup' });
+    return this.client.sendRequest(config, callback);
   }
 
   /**
@@ -500,6 +504,6 @@ export class Group {
       },
     };
 
-    return this.client.sendRequest(config, callback, { methodName: 'removeMemberFromGroup' });
+    return this.client.sendRequest(config, callback);
   }
 }

package/src/api/index.ts

@@ -1,9 +1,11 @@
+export * from './analytics';
 export * from './audit';
 export * from './content';
 export * from './contentAttachments';
 export * from './contentBody';
 export * from './contentChildrenAndDescendants';
 export * from './contentComments';
+export * from './contentContentState';
 export * from './contentLabels';
 export * from './contentMacroBody';
 export * from './contentPermissions';

package/src/api/inlineTasks.ts

@@ -1,7 +1,7 @@
 import * as Models from './models';
 import * as Parameters from './parameters';
-import { Client } from '../clients';
 import { Callback } from '../callback';
+import { Client } from '../clients';
 import { RequestConfig } from '../requestConfig';
 
 export class InlineTasks {
@@ -49,7 +49,7 @@ export class InlineTasks {
       },
     };
 
-    return this.client.sendRequest(config, callback, { methodName: 'searchTasks' });
+    return this.client.sendRequest(config, callback);
   }
 
   /**
@@ -72,7 +72,7 @@ export class InlineTasks {
       method: 'GET',
     };
 
-    return this.client.sendRequest(config, callback, { methodName: 'getTaskById' });
+    return this.client.sendRequest(config, callback);
   }
 
   /**
@@ -101,6 +101,6 @@ export class InlineTasks {
       },
     };
 
-    return this.client.sendRequest(config, callback, { methodName: 'updateTaskById' });
+    return this.client.sendRequest(config, callback);
   }
 }

package/src/api/labelInfo.ts

@@ -1,7 +1,7 @@
 import * as Models from './models';
 import * as Parameters from './parameters';
-import { Client } from '../clients';
 import { Callback } from '../callback';
+import { Client } from '../clients';
 import { RequestConfig } from '../requestConfig';
 
 export class LabelInfo {
@@ -42,6 +42,6 @@ export class LabelInfo {
       },
     };
 
-    return this.client.sendRequest(config, callback, { methodName: 'getAllLabelContent' });
+    return this.client.sendRequest(config, callback);
   }
 }

package/src/api/longRunningTask.ts

@@ -1,7 +1,7 @@
 import * as Models from './models';
 import * as Parameters from './parameters';
-import { Client } from '../clients';
 import { Callback } from '../callback';
+import { Client } from '../clients';
 import { RequestConfig } from '../requestConfig';
 
 export class LongRunningTask {
@@ -39,7 +39,7 @@ export class LongRunningTask {
       },
     };
 
-    return this.client.sendRequest(config, callback, { methodName: 'getTasks' });
+    return this.client.sendRequest(config, callback);
   }
 
   /**
@@ -70,6 +70,6 @@ export class LongRunningTask {
       method: 'GET',
     };
 
-    return this.client.sendRequest(config, callback, { methodName: 'getTask' });
+    return this.client.sendRequest(config, callback);
   }
 }

package/src/api/models/availableContentStates.ts

@@ -0,0 +1,7 @@
+import { ContentState } from './contentState';
+
+export interface AvailableContentStates {
+  /** Space suggested content states that can be used in the space */
+  spaceContentStates: ContentState[];
+  customContentStates: ContentState[];
+}

package/src/api/models/blueprintTemplate.ts

@@ -1,6 +1,6 @@
-import { Label } from './label';
 import { ContentBody } from './contentBody';
 import { GenericLinks } from './genericLinks';
+import { Label } from './label';
 
 export interface BlueprintTemplate {
   templateId: string;

package/src/api/models/bulkUserLookup.ts

@@ -1,8 +1,8 @@
+import { GenericLinks } from './genericLinks';
 import { Icon } from './icon';
 import { OperationCheckResult } from './operationCheckResult';
-import { UserDetails } from './userDetails';
 import { Space } from './space';
-import { GenericLinks } from './genericLinks';
+import { UserDetails } from './userDetails';
 
 export interface BulkUserLookup {
   type: string;

package/src/api/models/content.ts

@@ -1,13 +1,13 @@
-import { Space } from './space';
-import { ContentHistory } from './contentHistory';
-import { Version } from './version';
-import { OperationCheckResult } from './operationCheckResult';
-import { ContentChildren } from './contentChildren';
-import { ContentChildType } from './contentChildType';
 import { Container } from './container';
 import { ContentBody } from './contentBody';
+import { ContentChildren } from './contentChildren';
+import { ContentChildType } from './contentChildType';
+import { ContentHistory } from './contentHistory';
 import { ContentRestriction } from './contentRestriction';
 import { GenericLinks } from './genericLinks';
+import { OperationCheckResult } from './operationCheckResult';
+import { Space } from './space';
+import { Version } from './version';
 
 /** Base object for all content types. */
 export interface Content {

package/src/api/models/contentHistory.ts

@@ -1,7 +1,7 @@
+import { GenericLinks } from './genericLinks';
 import { User } from './user';
-import { Version } from './version';
 import { UsersUserKeys } from './usersUserKeys';
-import { GenericLinks } from './genericLinks';
+import { Version } from './version';
 
 export interface ContentHistory {
   latest: boolean;

package/src/api/models/contentLookAndFeel.ts

@@ -1,5 +1,5 @@
-import { ScreenLookAndFeel } from './screenLookAndFeel';
 import { ContainerLookAndFeel } from './containerLookAndFeel';
+import { ScreenLookAndFeel } from './screenLookAndFeel';
 
 export interface ContentLookAndFeel {
   screen: ScreenLookAndFeel;

package/src/api/models/contentMetadata.ts

@@ -1,6 +1,6 @@
-import { Version } from './version';
 import { GenericLinks } from './genericLinks';
 import { LabelArray } from './labelArray';
+import { Version } from './version';
 
 /** Metadata object for page, blogpost, comment content */
 export interface ContentMetadata {

package/src/api/models/contentRestriction.ts

@@ -1,7 +1,7 @@
-import { UserArray } from './userArray';
-import { GroupArray } from './groupArray';
 import { Content } from './content';
 import { GenericLinks } from './genericLinks';
+import { GroupArray } from './groupArray';
+import { UserArray } from './userArray';
 
 export interface ContentRestriction {
   operation: string;

package/src/api/models/contentState.ts

@@ -0,0 +1,8 @@
+export interface ContentState {
+  /** Identifier of content state. If 0, 1, or 2, this is a default space state */
+  id: number;
+  /** Name of content state. */
+  name: string;
+  /** Hex string representing color of state */
+  color: string;
+}

package/src/api/models/contentStateContainer.ts

@@ -0,0 +1,6 @@
+import { ContentState } from './contentState';
+
+export interface ContentStateContainer {
+  /** Null or Content State */
+  target?: ContentState;
+}

package/src/api/models/contentStateSettings.ts

@@ -0,0 +1,12 @@
+import { ContentState } from './contentState';
+
+export interface ContentStateSettings {
+  /** Whether users can place content states on any pages and blog posts in the space */
+  contentStatesAllowed: boolean;
+  /** Whether users can create custom states on the fly on pages and blog posts */
+  customContentStatesAllowed: boolean;
+  /** Whether space content states are allowed */
+  spaceContentStatesAllowed: boolean;
+  /** Space content states that users in the space can choose from */
+  spaceContentStates?: ContentState[];
+}

package/src/api/models/contentTemplate.ts

@@ -1,6 +1,6 @@
-import { Label } from './label';
 import { ContentBody } from './contentBody';
 import { GenericLinks } from './genericLinks';
+import { Label } from './label';
 
 export interface ContentTemplate {
   templateId: string;

package/src/api/models/copyPageHierarchyRequest.ts

@@ -11,6 +11,8 @@ export interface CopyPageHierarchyRequest {
   copyLabels?: boolean;
   /** If set to `true`, custom contents are copied to the destination page. */
   copyCustomContents?: boolean;
+  /** If set to `true`, descendants are copied to the destination page. */
+  copyDescendants?: boolean;
   destinationPageId: string;
   titleOptions?: CopyPageHierarchyTitleOptions;
 }

package/src/api/models/copyPageRequest.ts

@@ -1,5 +1,5 @@
-import { CopyPageRequestDestination } from './copyPageRequestDestination';
 import { ContentBodyCreate } from './contentBodyCreate';
+import { CopyPageRequestDestination } from './copyPageRequestDestination';
 
 export interface CopyPageRequest {
   /** If set to `true`, attachments are copied to the destination page. */

package/src/api/models/horizontalHeaderLookAndFeel.ts

@@ -1,7 +1,7 @@
 import { ButtonLookAndFeel } from './buttonLookAndFeel';
-import { TopNavigationLookAndFeel } from './topNavigationLookAndFeel';
 import { NavigationLookAndFeel } from './navigationLookAndFeel';
 import { SearchFieldLookAndFeel } from './searchFieldLookAndFeel';
+import { TopNavigationLookAndFeel } from './topNavigationLookAndFeel';
 
 export interface HorizontalHeaderLookAndFeel {
   backgroundColor: string;

package/src/api/models/index.ts

@@ -82,7 +82,15 @@ export * from './labelCreateArray';
 export * from './labelDetails';
 export * from './labeledContent';
 export * from './labeledContentPageResponse';
+export * from './contentStateSettings';
 export * from './labeledContentType';
+export * from './longTask';
+export * from './userPropertyCreate';
+export * from './userPropertyUpdate';
+export * from './contentStateContainer';
+export * from './availableContentStates';
+export * from './userPropertyKeyArray';
+export * from './userProperty';
 export * from './longTaskStatus';
 export * from './longTaskStatusArray';
 export * from './longTaskStatusWithLinks';

package/src/api/models/labelArray.ts

@@ -1,5 +1,5 @@
-import { Label } from './label';
 import { GenericLinks } from './genericLinks';
+import { Label } from './label';
 
 export interface LabelArray {
   results: Label[];

package/src/api/models/longTask.ts

@@ -0,0 +1,8 @@
+export interface LongTask {
+  /** A unique identifier for the long task */
+  id: string;
+  links: {
+    /** The URL to retrieve status of long task. */
+    status?: string;
+  };
+}

package/src/api/models/longTaskStatusArray.ts

@@ -1,5 +1,5 @@
-import { LongTaskStatus } from './longTaskStatus';
 import { GenericLinks } from './genericLinks';
+import { LongTaskStatus } from './longTaskStatus';
 
 export interface LongTaskStatusArray {
   results: LongTaskStatus[];

package/src/api/models/lookAndFeel.ts

@@ -1,7 +1,7 @@
-import { MenusLookAndFeel } from './menusLookAndFeel';
-import { HeaderLookAndFeel } from './headerLookAndFeel';
 import { ContentLookAndFeel } from './contentLookAndFeel';
+import { HeaderLookAndFeel } from './headerLookAndFeel';
 import { HorizontalHeaderLookAndFeel } from './horizontalHeaderLookAndFeel';
+import { MenusLookAndFeel } from './menusLookAndFeel';
 
 export interface LookAndFeel {
   headings: {

package/src/api/models/migratedUserArray.ts

@@ -1,5 +1,5 @@
-import { MigratedUser } from './migratedUser';
 import { GenericLinks } from './genericLinks';
+import { MigratedUser } from './migratedUser';
 
 export interface MigratedUserArray {
   results: MigratedUser[];

package/src/api/models/relation.ts

@@ -1,5 +1,5 @@
-import { RelationData } from './relationData';
 import { GenericLinks } from './genericLinks';
+import { RelationData } from './relationData';
 
 export interface Relation {
   name: string;

package/src/api/models/relationArray.ts

@@ -1,5 +1,5 @@
-import { Relation } from './relation';
 import { GenericLinks } from './genericLinks';
+import { Relation } from './relation';
 
 export interface RelationArray {
   results: Relation[];

package/src/api/models/searchPageResponseSearchResult.ts

@@ -1,5 +1,5 @@
-import { SearchResult } from './searchResult';
 import { GenericLinks } from './genericLinks';
+import { SearchResult } from './searchResult';
 
 export interface SearchPageResponseSearchResult {
   results: SearchResult[];

package/src/api/models/searchResult.ts

@@ -1,6 +1,6 @@
-import { Content } from './content';
-import { ContainerSummary } from './containerSummary';
 import { Breadcrumb } from './breadcrumb';
+import { ContainerSummary } from './containerSummary';
+import { Content } from './content';
 
 export interface SearchResult {
   content: Content;

package/src/api/models/space.ts

@@ -1,13 +1,13 @@
-import { Icon } from './icon';
-import { SpaceDescription } from './spaceDescription';
 import { Content } from './content';
+import { GenericLinks } from './genericLinks';
+import { Icon } from './icon';
 import { LabelArray } from './labelArray';
+import { LookAndFeel } from './lookAndFeel';
 import { OperationCheckResult } from './operationCheckResult';
+import { SpaceDescription } from './spaceDescription';
 import { SpacePermission } from './spacePermission';
 import { SpaceSettings } from './spaceSettings';
 import { Theme } from './theme';
-import { LookAndFeel } from './lookAndFeel';
-import { GenericLinks } from './genericLinks';
 
 export interface Space {
   id: number;

package/src/api/models/spaceArray.ts

@@ -1,5 +1,5 @@
-import { Space } from './space';
 import { GenericLinks } from './genericLinks';
+import { Space } from './space';
 
 export interface SpaceArray {
   results: Space[];

package/src/api/models/spacePermission.ts

@@ -1,6 +1,6 @@
-import { User } from './user';
 import { Group } from './group';
 import { OperationCheckResult } from './operationCheckResult';
+import { User } from './user';
 
 /**
  * This object represents a permission for given space. Permissions consist of* at least one operation object with an

package/src/api/models/spacePermissionCreate.ts

@@ -1,6 +1,6 @@
-import { User } from './user';
 import { GroupCreate } from './groupCreate';
 import { OperationCheckResult } from './operationCheckResult';
+import { User } from './user';
 
 /**
  * This object represents a permission for given space. Permissions consist of* at least one operation object with an

package/src/api/models/spacePermissionRequest.ts

@@ -1,5 +1,5 @@
-import { PermissionSubject } from './permissionSubject';
 import { GenericLinks } from './genericLinks';
+import { PermissionSubject } from './permissionSubject';
 
 /**
  * This object represents the request for the single space permission. Permissions consist of* at least one operation

package/src/api/models/spacePermissionV2.ts

@@ -1,5 +1,5 @@
-import { PermissionSubject } from './permissionSubject';
 import { GenericLinks } from './genericLinks';
+import { PermissionSubject } from './permissionSubject';
 
 /**
  * This object represents a single space permission. Permissions consist of* at least one operation object with an

package/src/api/models/spacePropertyArray.ts

@@ -1,5 +1,5 @@
-import { SpaceProperty } from './spaceProperty';
 import { GenericLinks } from './genericLinks';
+import { SpaceProperty } from './spaceProperty';
 
 export interface SpacePropertyArray {
   results: SpaceProperty[];

package/src/api/models/spaceWatchArray.ts

@@ -1,5 +1,5 @@
-import { SpaceWatch } from './spaceWatch';
 import { GenericLinks } from './genericLinks';
+import { SpaceWatch } from './spaceWatch';
 
 export interface SpaceWatchArray {
   results: SpaceWatch[];

package/src/api/models/themeArray.ts

@@ -1,5 +1,5 @@
-import { ThemeNoLinks } from './themeNoLinks';
 import { GenericLinks } from './genericLinks';
+import { ThemeNoLinks } from './themeNoLinks';
 
 export interface ThemeArray {
   results: ThemeNoLinks[];

package/src/api/models/user.ts

@@ -1,8 +1,8 @@
+import { GenericLinks } from './genericLinks';
 import { Icon } from './icon';
 import { OperationCheckResult } from './operationCheckResult';
-import { UserDetails } from './userDetails';
 import { Space } from './space';
-import { GenericLinks } from './genericLinks';
+import { UserDetails } from './userDetails';
 
 export interface User {
   type: string;

package/src/api/models/userAnonymous.ts

@@ -1,6 +1,6 @@
+import { GenericLinks } from './genericLinks';
 import { Icon } from './icon';
 import { OperationCheckResult } from './operationCheckResult';
-import { GenericLinks } from './genericLinks';
 
 export interface UserAnonymous {
   type: string;

package/src/api/models/userProperty.ts

@@ -0,0 +1,14 @@
+import { GenericLinks } from './genericLinks';
+
+export interface UserProperty {
+  key: string;
+  /** The value of the content property. */
+  value: {};
+  /** A unique identifier for the user property */
+  id: string;
+  /** Datetime when the property was last modified such as `2022-02-01T12:00:00.111Z` */
+  lastModifiedDate: string;
+  /** Datetime when the property was created such as `2022-01-01T12:00:00.111Z` */
+  createdDate: string;
+  Links?: GenericLinks;
+}

package/src/api/models/userPropertyCreate.ts

@@ -0,0 +1,4 @@
+export interface UserPropertyCreate {
+  /** The value of the user property. */
+  value: {};
+}

package/src/api/models/userPropertyKeyArray.ts

@@ -0,0 +1,11 @@
+import { GenericLinks } from './genericLinks';
+
+export interface UserPropertyKeyArray {
+  results: {
+    key?: string;
+  }[];
+  start?: number;
+  limit?: number;
+  size?: number;
+  Links?: GenericLinks;
+}

package/src/api/models/userPropertyUpdate.ts

@@ -0,0 +1,4 @@
+export interface UserPropertyUpdate {
+  /** The value of the user property. */
+  value: {};
+}