confluence.js 1.3.1 → 1.5.0

package/src/api/models/genericLinks.ts

@@ -1 +1,12 @@
-export type GenericLinks = Record<string, any>;
+export type GenericLinks = {
+  [key: string]: any;
+
+  self: string;
+  next?: string;
+  tinyui?: string;
+  editui?: string;
+  webui?: string;
+  base?: string;
+  context?: string;
+  download?: string;
+};

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

@@ -4,10 +4,14 @@ export * from './accountIdEmailRecordArray';
 export * from './addContentRestriction';
 export * from './addContentRestrictionUpdateArray';
 export * from './affectedObject';
+export * from './attachmentContainer';
 export * from './attachmentUpdate';
 export * from './auditRecord';
 export * from './auditRecordArray';
 export * from './auditRecordCreate';
+export * from './appDescriptor';
+export * from './attachment';
+export * from './attachmentMetadata';
 export * from './blueprintTemplate';
 export * from './blueprintTemplateArray';
 export * from './breadcrumb';
@@ -59,6 +63,7 @@ export * from './copyPageRequest';
 export * from './copyPageRequestDestination';
 export * from './cQLPersonalDataConvertedQueries';
 export * from './cQLPersonalDataMigrationRequest';
+export * from './createdAttachment';
 export * from './deletedSpace';
 export * from './dynamicModulesErrorMessage';
 export * from './embeddable';
@@ -82,7 +87,16 @@ export * from './labelCreateArray';
 export * from './labelDetails';
 export * from './labeledContent';
 export * from './labeledContentPageResponse';
+export * from './contentStateSettings';
 export * from './labeledContentType';
+export * from './longTask';
+export * from './contentState';
+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';
@@ -92,6 +106,7 @@ export * from './lookAndFeelSettings';
 export * from './lookAndFeelUpdated';
 export * from './macroInstance';
 export * from './menusLookAndFeel';
+export * from './lifecycle';
 export * from './message';
 export * from './migratedUser';
 export * from './migratedUserArray';

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: {};
+}

package/src/api/models/usersUserKeys.ts

@@ -1,5 +1,5 @@
-import { User } from './user';
 import { GenericLinks } from './genericLinks';
+import { User } from './user';
 
 export interface UsersUserKeys {
   users: User[];

package/src/api/models/version.ts

@@ -1,7 +1,7 @@
-import { User } from './user';
 import { Content } from './content';
-import { UsersUserKeys } from './usersUserKeys';
 import { GenericLinks } from './genericLinks';
+import { User } from './user';
+import { UsersUserKeys } from './usersUserKeys';
 
 export interface Version {
   by: User;

package/src/api/models/versionArray.ts

@@ -1,5 +1,5 @@
-import { Version } from './version';
 import { GenericLinks } from './genericLinks';
+import { Version } from './version';
 
 export interface VersionArray {
   results: Version[];

package/src/api/models/watchArray.ts

@@ -1,5 +1,5 @@
-import { Watch } from './watch';
 import { GenericLinks } from './genericLinks';
+import { Watch } from './watch';
 
 export interface WatchArray {
   results: Watch[];

package/src/api/parameters/createAttachments.ts

@@ -2,7 +2,17 @@ export interface CreateAttachments {
   /** The ID of the content to add the attachment to. */
   id: string;
   /** The status of the content that the attachment is being added to. */
-  status?: string;
+  status?: 'current' | 'draft' | string;
+  /** The attachments to be created. */
+  attachments: CreateAttachments.Attachment | CreateAttachments.Attachment[];
+}
 
-  [key: string]: any;
+export namespace CreateAttachments {
+  export interface Attachment {
+    file: Buffer | ReadableStream | string | Blob | File | any;
+    filename: string;
+    minorEdit: boolean;
+    contentType?: string;
+    comment?: string;
+  }
 }

package/src/api/parameters/createOrUpdateAttachments.ts

@@ -1,8 +1,11 @@
+import { CreateAttachments } from './createAttachments';
+
 export interface CreateOrUpdateAttachments {
   /** The ID of the content to add the attachment to. */
   id: string;
   /** The status of the content that the attachment is being added to. This should always be set to 'current'. */
-  status?: string;
+  status?: 'current' | 'draft' | string;
 
-  [key: string]: any;
+  /** The attachments to be created or updated. */
+  attachments: CreateAttachments.Attachment | CreateAttachments.Attachment[];
 }

package/src/api/parameters/createUserProperty.ts

@@ -0,0 +1,11 @@
+import { UserPropertyCreate } from '../models';
+
+export interface CreateUserProperty extends UserPropertyCreate {
+  /**
+   * The account ID of the user. The accountId uniquely identifies the user across all Atlassian products. For
+   * example, 384093:32b4d9w0-f6a5-3535-11a3-9c8c88d10192
+   */
+  userId: string;
+  /** The key of the user property. */
+  key: string;
+}

package/src/api/parameters/deletePageTree.ts

@@ -0,0 +1,4 @@
+export interface DeletePageTree {
+  /** The ID of the content which forms root of the page tree, to be deleted. */
+  id: string;
+}

package/src/api/parameters/deleteUserProperty.ts

@@ -0,0 +1,9 @@
+export interface DeleteUserProperty {
+  /**
+   * The account ID of the user. The accountId uniquely identifies the user across all Atlassian products. For
+   * example, 384093:32b4d9w0-f6a5-3535-11a3-9c8c88d10192
+   */
+  userId: string;
+  /** The key of the user property. */
+  key: string;
+}

package/src/api/parameters/getAttachments.ts

@@ -2,7 +2,77 @@ export interface GetAttachments {
   /** The ID of the content to be queried for its attachments. */
   id: string;
   /** A multi-value parameter indicating which properties of the content to expand. */
-  expand?: string | string[] | GetAttachments.Expand | GetAttachments.Expand[];
+  expand?:
+  | 'childTypes.all'
+  | 'childTypes.attachment'
+  | 'childTypes.comment'
+  | 'childTypes.page'
+  | 'container'
+  | 'metadata'
+  | 'metadata.currentuser'
+  | 'metadata.properties'
+  | 'metadata.labels'
+  | 'metadata.frontend'
+  | 'operations'
+  | 'children.page'
+  | 'children.attachment'
+  | 'children.comment'
+  | 'restrictions.read.restrictions.user'
+  | 'restrictions.read.restrictions.group'
+  | 'restrictions.update.restrictions.user'
+  | 'restrictions.update.restrictions.group'
+  | 'history'
+  | 'history.lastUpdated'
+  | 'history.previousVersion'
+  | 'history.contributors'
+  | 'history.nextVersion'
+  | 'ancestors'
+  | 'body'
+  | 'version'
+  | 'descendants.page'
+  | 'descendants.attachment'
+  | 'descendants.comment'
+  | 'space'
+  | 'extensions.inlineProperties'
+  | 'extensions.resolution'
+  | (
+    | 'childTypes.all'
+    | 'childTypes.attachment'
+    | 'childTypes.comment'
+    | 'childTypes.page'
+    | 'container'
+    | 'metadata'
+    | 'metadata.currentuser'
+    | 'metadata.properties'
+    | 'metadata.labels'
+    | 'metadata.frontend'
+    | 'operations'
+    | 'children.page'
+    | 'children.attachment'
+    | 'children.comment'
+    | 'restrictions.read.restrictions.user'
+    | 'restrictions.read.restrictions.group'
+    | 'restrictions.update.restrictions.user'
+    | 'restrictions.update.restrictions.group'
+    | 'history'
+    | 'history.lastUpdated'
+    | 'history.previousVersion'
+    | 'history.contributors'
+    | 'history.nextVersion'
+    | 'ancestors'
+    | 'body'
+    | 'version'
+    | 'descendants.page'
+    | 'descendants.attachment'
+    | 'descendants.comment'
+    | 'space'
+    | 'extensions.inlineProperties'
+    | 'extensions.resolution'
+  )[]
+  | string
+  | string[]
+  | GetAttachments.Expand
+  | GetAttachments.Expand[];
   /** The starting index of the returned attachments. */
   start?: number;
   /** The maximum number of attachments to return per page. Note, this may be restricted by fixed system limits. */

package/src/api/parameters/getAvailableContentStates.ts

@@ -0,0 +1,4 @@
+export interface GetAvailableContentStates {
+  /** Id of content to get available states for */
+  contentId: string;
+}

package/src/api/parameters/getContentState.ts

@@ -0,0 +1,6 @@
+export interface GetContentState {
+  /** The Id of the page whose content state is of interest. */
+  contentId: string;
+  /** Set designation=DRAFT or designation=PUBLISHED. */
+  designation?: string;
+}

package/src/api/parameters/getContentStateLastUpdated.ts

@@ -0,0 +1,4 @@
+export interface GetContentStateLastUpdated {
+  /** Id of Content to get information for */
+  contentId: string;
+}

package/src/api/parameters/getContentStateSettings.ts

@@ -0,0 +1,4 @@
+export interface GetContentStateSettings {
+  /** SpaceKey */
+  spaceKey: string;
+}

package/src/api/parameters/getGroupMembersByGroupId.ts

@@ -5,4 +5,9 @@ export interface GetGroupMembersByGroupId {
   start?: number;
   /** The maximum number of users to return per page. Note, this may be restricted by fixed system limits. */
   limit?: number;
+  /**
+   * Whether to include total size parameter in the results. Note, fetching total size property is an expensive
+   * operation; use it if your use case needs this value.
+   */
+  shouldReturnTotalSize?: boolean;
 }

package/src/api/parameters/getMembersByQueryParam.ts

@@ -8,4 +8,9 @@ export interface GetMembersByQueryParam {
    * say if the limit parameter exceeds 200, this API will return a maximum of 200 users per page.
    */
   limit?: number;
+  /**
+   * Whether to include total size parameter in the results. Note, fetching total size property is an expensive
+   * operation; use it if your use case needs this value.
+   */
+  shouldReturnTotalSize?: boolean;
 }

package/src/api/parameters/getSpaces.ts

@@ -21,7 +21,37 @@ export interface GetSpaces {
    */
   favouriteUserKey?: string;
   /** A multi-value parameter indicating which properties of the content to expand. */
-  expand?: string[];
+  expand?:
+  | 'settings'
+  | 'metadata'
+  | 'metadata.labels'
+  | 'operations'
+  | 'lookAndFeel'
+  | 'permissions'
+  | 'icon'
+  | 'description'
+  | 'description.plain'
+  | 'description.view'
+  | 'theme'
+  | 'homepage'
+  | 'history'
+  | (
+    | 'settings'
+    | 'metadata'
+    | 'metadata.labels'
+    | 'operations'
+    | 'lookAndFeel'
+    | 'permissions'
+    | 'icon'
+    | 'description'
+    | 'description.plain'
+    | 'description.view'
+    | 'theme'
+    | 'homepage'
+    | 'history'
+  )[]
+  | string
+  | string[];
   /** The starting index of the returned spaces. */
   start?: number;
   /** The maximum number of spaces to return per page. Note, this may be restricted by fixed system limits. */

package/src/api/parameters/getUserProperties.ts

@@ -0,0 +1,8 @@
+export interface GetUserProperties {
+  /** The account ID of the user to be queried for its properties. */
+  userId: string;
+  /** The starting index of the returned properties. */
+  start?: number;
+  /** The maximum number of properties to return per page. Note, this may be restricted by fixed system limits. */
+  limit?: number;
+}

package/src/api/parameters/getUserProperty.ts

@@ -0,0 +1,6 @@
+export interface GetUserProperty {
+  /** The account ID of the user to be queried for its properties. */
+  userId: string;
+  /** The key of the user property. */
+  key: string;
+}

package/src/api/parameters/index.ts

@@ -30,15 +30,18 @@ export * from './createRelationship';
 export * from './createSpace';
 export * from './createSpaceProperty';
 export * from './createSpacePropertyForKey';
+export * from './createUserProperty';
 export * from './delete';
 export * from './deleteContent';
 export * from './deleteContentProperty';
 export * from './deleteContentVersion';
 export * from './deleteLabelFromSpace';
+export * from './deletePageTree';
 export * from './deleteRelationship';
 export * from './deleteRestrictions';
 export * from './deleteSpace';
 export * from './deleteSpaceProperty';
+export * from './deleteUserProperty';
 export * from './descendantsOfType';
 export * from './downloadAttachment';
 export * from './exportAuditRecords';
@@ -49,6 +52,7 @@ export * from './getAnonymousUser';
 export * from './getAttachments';
 export * from './getAuditRecords';
 export * from './getAuditRecordsForTimePeriod';
+export * from './getAvailableContentStates';
 export * from './getBlueprintTemplates';
 export * from './getBulkUserLookup';
 export * from './getBulkUserMigration';
@@ -64,6 +68,9 @@ export * from './getContentProperties';
 export * from './getContentProperty';
 export * from './getContentRestrictionStatusForGroup';
 export * from './getContentRestrictionStatusForUser';
+export * from './getContentState';
+export * from './getContentStateLastUpdated';
+export * from './getContentStateSettings';
 export * from './getContentTemplate';
 export * from './getContentTemplates';
 export * from './getContentVersion';
@@ -105,6 +112,8 @@ export * from './getTasks';
 export * from './getTheme';
 export * from './getThemes';
 export * from './getUser';
+export * from './getUserProperties';
+export * from './getUserProperty';
 export * from './getViewers';
 export * from './getViews';
 export * from './getWatchersForSpace';
@@ -117,6 +126,7 @@ export * from './permissionCheck';
 export * from './publishLegacyDraft';
 export * from './publishSharedDraft';
 export * from './registerModules';
+export * from './removeContentState';
 export * from './removeContentWatcher';
 export * from './removeGroup';
 export * from './removeGroupById';
@@ -140,6 +150,7 @@ export * from './searchContentByCQL';
 export * from './searchGroups';
 export * from './searchTasks';
 export * from './searchUser';
+export * from './setContentState';
 export * from './setLookAndFeelSettings';
 export * from './setRetentionPeriod';
 export * from './setSpaceTheme';
@@ -155,4 +166,5 @@ export * from './updateSpace';
 export * from './updateSpaceProperty';
 export * from './updateSpaceSettings';
 export * from './updateTaskById';
+export * from './updateUserProperty';
 export * from './userSearch';