confluence.js 1.2.2 → 1.4.0

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/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/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';

package/src/api/parameters/removeContentState.ts

@@ -0,0 +1,4 @@
+export interface RemoveContentState {
+  /** The Id of the content whose content state is to be set. */
+  contentId: string;
+}

package/src/api/parameters/searchGroups.ts

@@ -5,4 +5,9 @@ export interface SearchGroups {
   start?: number;
   /** The maximum number of groups to return per page. Note, this is restricted to a maximum limit of 200 groups. */
   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/setContentState.ts

@@ -0,0 +1,8 @@
+export interface SetContentState {
+  /** The Id of the content whose content state is to be set. */
+  contentId: string;
+  /** The Id of the content */
+  contentStateId?: number;
+  name?: string;
+  color?: string;
+}

package/src/api/parameters/updateUserProperty.ts

@@ -0,0 +1,11 @@
+import { UserPropertyUpdate } from '../models';
+
+export interface UpdateUserProperty extends UserPropertyUpdate {
+  /**
+   * 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/relation.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 Relation {
@@ -53,7 +53,7 @@ export class Relation {
       },
     };
 
-    return this.client.sendRequest(config, callback, { methodName: 'findTargetFromSource' });
+    return this.client.sendRequest(config, callback);
   }
 
   /** @deprecated Will be removed in the next major version. Use `getRelationship` instead. */
@@ -113,7 +113,7 @@ export class Relation {
       },
     };
 
-    return this.client.sendRequest(config, callback, { methodName: 'getRelationship' });
+    return this.client.sendRequest(config, callback);
   }
 
   /**
@@ -159,7 +159,7 @@ export class Relation {
       },
     };
 
-    return this.client.sendRequest(config, callback, { methodName: 'createRelationship' });
+    return this.client.sendRequest(config, callback);
   }
 
   /** @deprecated Will be removed in the next major version. Use `deleteRelationship` instead. */
@@ -201,7 +201,7 @@ export class Relation {
       },
     };
 
-    return this.client.sendRequest(config, callback, { methodName: 'deleteRelationship' });
+    return this.client.sendRequest(config, callback);
   }
 
   /**
@@ -252,6 +252,6 @@ export class Relation {
       },
     };
 
-    return this.client.sendRequest(config, callback, { methodName: 'findSourcesForTarget' });
+    return this.client.sendRequest(config, callback);
   }
 }

package/src/api/search.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 Search {
@@ -74,7 +74,7 @@ export class Search {
       },
     };
 
-    return this.client.sendRequest(config, callback, { methodName: 'searchByCQL' });
+    return this.client.sendRequest(config, callback);
   }
 
   /** @deprecated Will be removed in the next major version. Use `searchUser` instead. */
@@ -93,12 +93,13 @@ export class Search {
   ): Promise<void | T> {
     return this.searchUser(parameters, callback!);
   }
+
   /**
    * Searches for users using user-specific queries from the [Confluence Query Language
    * (CQL)](https://developer.atlassian.com/cloud/confluence/advanced-searching-using-cql/).
    *
    * Note that some user fields may be set to null depending on the user's privacy settings. These are: email,
-   * profilePicture, and displayName.
+   * profilePicture, displayName, and timeZone.
    */
   async searchUser<T = Models.SearchPageResponseSearchResult>(
     parameters: Parameters.SearchUser,
@@ -109,7 +110,7 @@ export class Search {
    * (CQL)](https://developer.atlassian.com/cloud/confluence/advanced-searching-using-cql/).
    *
    * Note that some user fields may be set to null depending on the user's privacy settings. These are: email,
-   * profilePicture, and displayName.
+   * profilePicture, displayName, and timeZone.
    */
   async searchUser<T = Models.SearchPageResponseSearchResult>(
     parameters: Parameters.SearchUser,
@@ -126,9 +127,10 @@ export class Search {
         cql: parameters.cql,
         start: parameters.start,
         limit: parameters.limit,
+        expand: parameters.expand,
       },
     };
 
-    return this.client.sendRequest(config, callback, { methodName: 'searchUser' });
+    return this.client.sendRequest(config, callback);
   }
 }

package/src/api/settings.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 Settings {
@@ -43,7 +43,7 @@ export class Settings {
       },
     };
 
-    return this.client.sendRequest(config, callback, { methodName: 'getLookAndFeelSettings' });
+    return this.client.sendRequest(config, callback);
   }
 
   /**
@@ -81,7 +81,7 @@ export class Settings {
       },
     };
 
-    return this.client.sendRequest(config, callback, { methodName: 'updateLookAndFeel' });
+    return this.client.sendRequest(config, callback);
   }
 
   /**
@@ -133,7 +133,7 @@ export class Settings {
       },
     };
 
-    return this.client.sendRequest(config, callback, { methodName: 'updateLookAndFeelSettings' });
+    return this.client.sendRequest(config, callback);
   }
 
   /**
@@ -170,7 +170,7 @@ export class Settings {
       },
     };
 
-    return this.client.sendRequest(config, callback, { methodName: 'resetLookAndFeelSettings' });
+    return this.client.sendRequest(config, callback);
   }
 
   /**
@@ -205,7 +205,7 @@ export class Settings {
       },
     };
 
-    return this.client.sendRequest(config, callback, { methodName: 'setLookAndFeelSettings' });
+    return this.client.sendRequest(config, callback);
   }
 
   /**
@@ -228,6 +228,28 @@ export class Settings {
       method: 'GET',
     };
 
-    return this.client.sendRequest(config, callback, { methodName: 'getSystemInfo' });
+    return this.client.sendRequest(config, callback);
+  }
+
+  /** Gets Content State settings for a space */
+  async getContentStateSettings<T = Models.ContentStateSettings>(
+    parameters: Parameters.GetContentStateSettings,
+    callback: Callback<T>
+  ): Promise<void>;
+  /** Gets Content State settings for a space */
+  async getContentStateSettings<T = Models.ContentStateSettings>(
+    parameters: Parameters.GetContentStateSettings,
+    callback?: never
+  ): Promise<T>;
+  async getContentStateSettings<T = Models.ContentStateSettings>(
+    parameters: Parameters.GetContentStateSettings,
+    callback?: Callback<T>,
+  ): Promise<void | T> {
+    const config: RequestConfig = {
+      url: `/api/space/${parameters.spaceKey}/state/settings`,
+      method: 'GET',
+    };
+
+    return this.client.sendRequest(config, callback);
   }
 }

package/src/api/space.ts

@@ -1,7 +1,8 @@
 import * as Models from './models';
 import * as Parameters from './parameters';
-import { Client } from '../clients';
 import { Callback } from '../callback';
+import { Client } from '../clients';
+import { paramSerializer } from '../paramSerializer';
 import { RequestConfig } from '../requestConfig';
 
 export class Space {
@@ -31,7 +32,7 @@ export class Space {
       url: '/api/space',
       method: 'GET',
       params: {
-        spaceKey: parameters?.spaceKey,
+        spaceKey: paramSerializer('spaceKey', parameters?.spaceKey),
         spaceId: parameters?.spaceId,
         type: parameters?.type,
         status: parameters?.status,
@@ -43,7 +44,7 @@ export class Space {
       },
     };
 
-    return this.client.sendRequest(config, callback, { methodName: 'getSpaces' });
+    return this.client.sendRequest(config, callback);
   }
 
   /**
@@ -73,7 +74,7 @@ export class Space {
       },
     };
 
-    return this.client.sendRequest(config, callback, { methodName: 'createSpace' });
+    return this.client.sendRequest(config, callback);
   }
 
   /**
@@ -110,7 +111,7 @@ export class Space {
       },
     };
 
-    return this.client.sendRequest(config, callback, { methodName: 'createPrivateSpace' });
+    return this.client.sendRequest(config, callback);
   }
 
   /**
@@ -129,9 +130,12 @@ export class Space {
     const config: RequestConfig = {
       url: `/api/space/${parameters.spaceKey}`,
       method: 'GET',
+      params: {
+        expand: parameters.expand,
+      },
     };
 
-    return this.client.sendRequest(config, callback, { methodName: 'getSpace' });
+    return this.client.sendRequest(config, callback);
   }
 
   /**
@@ -165,7 +169,7 @@ export class Space {
       },
     };
 
-    return this.client.sendRequest(config, callback, { methodName: 'updateSpace' });
+    return this.client.sendRequest(config, callback);
   }
 
   /**
@@ -193,7 +197,7 @@ export class Space {
       method: 'DELETE',
     };
 
-    return this.client.sendRequest(config, callback, { methodName: 'deleteSpace' });
+    return this.client.sendRequest(config, callback);
   }
 
   /**
@@ -232,7 +236,7 @@ export class Space {
       },
     };
 
-    return this.client.sendRequest(config, callback, { methodName: 'getContentForSpace' });
+    return this.client.sendRequest(config, callback);
   }
 
   /**
@@ -269,6 +273,6 @@ export class Space {
       },
     };
 
-    return this.client.sendRequest(config, callback, { methodName: 'getContentByTypeForSpace' });
+    return this.client.sendRequest(config, callback);
   }
 }

package/src/api/spacePermissions.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 SpacePermissions {
@@ -61,7 +61,7 @@ export class SpacePermissions {
       },
     };
 
-    return this.client.sendRequest(config, callback, { methodName: 'addPermissionToSpace' });
+    return this.client.sendRequest(config, callback);
   }
 
   /**
@@ -103,7 +103,7 @@ export class SpacePermissions {
       },
     };
 
-    return this.client.sendRequest(config, callback, { methodName: 'addCustomContentPermissions' });
+    return this.client.sendRequest(config, callback);
   }
 
   /**
@@ -130,6 +130,6 @@ export class SpacePermissions {
       method: 'DELETE',
     };
 
-    return this.client.sendRequest(config, callback, { methodName: 'removePermission' });
+    return this.client.sendRequest(config, callback);
   }
 }

package/src/api/spaceProperties.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 SpaceProperties {
@@ -39,7 +39,7 @@ export class SpaceProperties {
       },
     };
 
-    return this.client.sendRequest(config, callback, { methodName: 'getSpaceProperties' });
+    return this.client.sendRequest(config, callback);
   }
 
   /**
@@ -74,7 +74,7 @@ export class SpaceProperties {
       },
     };
 
-    return this.client.sendRequest(config, callback, { methodName: 'createSpaceProperty' });
+    return this.client.sendRequest(config, callback);
   }
 
   /**
@@ -107,7 +107,7 @@ export class SpaceProperties {
       },
     };
 
-    return this.client.sendRequest(config, callback, { methodName: 'getSpaceProperty' });
+    return this.client.sendRequest(config, callback);
   }
 
   /**
@@ -142,7 +142,7 @@ export class SpaceProperties {
       },
     };
 
-    return this.client.sendRequest(config, callback, { methodName: 'createSpacePropertyForKey' });
+    return this.client.sendRequest(config, callback);
   }
 
   /**
@@ -176,7 +176,7 @@ export class SpaceProperties {
       },
     };
 
-    return this.client.sendRequest(config, callback, { methodName: 'updateSpaceProperty' });
+    return this.client.sendRequest(config, callback);
   }
 
   /**
@@ -200,6 +200,6 @@ export class SpaceProperties {
       method: 'DELETE',
     };
 
-    return this.client.sendRequest(config, callback, { methodName: 'deleteSpaceProperty' });
+    return this.client.sendRequest(config, callback);
   }
 }

package/src/api/spaceSettings.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 SpaceSettings {
@@ -34,7 +34,7 @@ export class SpaceSettings {
       method: 'GET',
     };
 
-    return this.client.sendRequest(config, callback, { methodName: 'getSpaceSettings' });
+    return this.client.sendRequest(config, callback);
   }
 
   /**
@@ -67,6 +67,6 @@ export class SpaceSettings {
       },
     };
 
-    return this.client.sendRequest(config, callback, { methodName: 'updateSpaceSettings' });
+    return this.client.sendRequest(config, callback);
   }
 }