confluence.js 1.1.3 → 1.2.0

package/src/api/relation.ts

@@ -56,6 +56,20 @@ export class Relation {
     return this.client.sendRequest(config, callback, { methodName: 'findTargetFromSource' });
   }
 
+  /** @deprecated Will be removed in the next major version. Use `getRelationship` instead. */
+  async GetRelationship<T = Models.Relation>(
+    parameters: Parameters.GetRelationship,
+    callback: Callback<T>
+  ): Promise<void>;
+  /** @deprecated Will be removed in the next major version. Use `getRelationship` instead. */
+  async GetRelationship<T = Models.Relation>(parameters: Parameters.GetRelationship, callback?: never): Promise<T>;
+  async GetRelationship<T = Models.Relation>(
+    parameters: Parameters.GetRelationship,
+    callback?: Callback<T>,
+  ): Promise<void | T> {
+    return this.getRelationship(parameters, callback!);
+  }
+
   /**
    * Find whether a particular type of relationship exists from a source entity to a target entity. Note, relationships
    * are one way.
@@ -67,7 +81,7 @@ export class Relation {
    * **[Permissions](https://confluence.atlassian.com/x/_AozKw) required**: Permission to view both the target entity
    * and source entity.
    */
-  async GetRelationship<T = Models.Relation>(
+  async getRelationship<T = Models.Relation>(
     parameters: Parameters.GetRelationship,
     callback: Callback<T>
   ): Promise<void>;
@@ -82,8 +96,8 @@ export class Relation {
    * **[Permissions](https://confluence.atlassian.com/x/_AozKw) required**: Permission to view both the target entity
    * and source entity.
    */
-  async GetRelationship<T = Models.Relation>(parameters: Parameters.GetRelationship, callback?: never): Promise<T>;
-  async GetRelationship<T = Models.Relation>(
+  async getRelationship<T = Models.Relation>(parameters: Parameters.GetRelationship, callback?: never): Promise<T>;
+  async getRelationship<T = Models.Relation>(
     parameters: Parameters.GetRelationship,
     callback?: Callback<T>,
   ): Promise<void | T> {
@@ -99,7 +113,7 @@ export class Relation {
       },
     };
 
-    return this.client.sendRequest(config, callback, { methodName: 'GetRelationship' });
+    return this.client.sendRequest(config, callback, { methodName: 'getRelationship' });
   }
 
   /**
@@ -148,6 +162,14 @@ export class Relation {
     return this.client.sendRequest(config, callback, { methodName: 'createRelationship' });
   }
 
+  /** @deprecated Will be removed in the next major version. Use `deleteRelationship` instead. */
+  async delete<T = void>(parameters: Parameters.Delete, callback: Callback<T>): Promise<void>;
+  /** @deprecated Will be removed in the next major version. Use `deleteRelationship` instead. */
+  async delete<T = void>(parameters: Parameters.Delete, callback?: never): Promise<T>;
+  async delete<T = void>(parameters: Parameters.Delete, callback?: Callback<T>): Promise<void | T> {
+    return this.deleteRelationship(parameters, callback!);
+  }
+
   /**
    * Deletes a relationship between two entities (user, space, content).
    *
@@ -155,7 +177,7 @@ export class Relation {
    * ('Can use' global permission). For favourite relationships, the current user can only delete their own favourite
    * relationships. A space administrator can delete favourite relationships for any user.
    */
-  async delete<T = void>(parameters: Parameters.Delete, callback: Callback<T>): Promise<void>;
+  async deleteRelationship<T = void>(parameters: Parameters.DeleteRelationship, callback: Callback<T>): Promise<void>;
   /**
    * Deletes a relationship between two entities (user, space, content).
    *
@@ -163,8 +185,11 @@ export class Relation {
    * ('Can use' global permission). For favourite relationships, the current user can only delete their own favourite
    * relationships. A space administrator can delete favourite relationships for any user.
    */
-  async delete<T = void>(parameters: Parameters.Delete, callback?: never): Promise<T>;
-  async delete<T = void>(parameters: Parameters.Delete, callback?: Callback<T>): Promise<void | T> {
+  async deleteRelationship<T = void>(parameters: Parameters.DeleteRelationship, callback?: never): Promise<T>;
+  async deleteRelationship<T = void>(
+    parameters: Parameters.DeleteRelationship,
+    callback?: Callback<T>,
+  ): Promise<void | T> {
     const config: RequestConfig = {
       url: `/api/relation/${parameters.relationName}/from/${parameters.sourceType}/${parameters.sourceKey}/to/${parameters.targetType}/${parameters.targetKey}`,
       method: 'DELETE',
@@ -176,7 +201,7 @@ export class Relation {
       },
     };
 
-    return this.client.sendRequest(config, callback, { methodName: 'delete' });
+    return this.client.sendRequest(config, callback, { methodName: 'deleteRelationship' });
   }
 
   /**

package/src/api/search.ts

@@ -7,95 +7,52 @@ import { RequestConfig } from '../requestConfig';
 export class Search {
   constructor(private client: Client) {}
 
+  /** @deprecated Will be removed in the next major version. Use `searchByCQL` instead. */
+  async search<T = Models.SearchPageResponseSearchResult>(
+    parameters: Parameters.Search,
+    callback: Callback<T>
+  ): Promise<void>;
+  /** @deprecated Will be removed in the next major version. Use `searchByCQL` instead. */
+  async search<T = Models.SearchPageResponseSearchResult>(parameters: Parameters.Search, callback?: never): Promise<T>;
+  async search<T = Models.SearchPageResponseSearchResult>(
+    parameters: Parameters.Search,
+    callback?: Callback<T>,
+  ): Promise<void | T> {
+    return this.searchByCQL(parameters, callback!);
+  }
+
   /**
    * Searches for content using the [Confluence Query Language
    * (CQL)](https://developer.atlassian.com/cloud/confluence/advanced-searching-using-cql/)
    *
-   * Example initial call:
-   *
-   *     https://your-domain.atlassian.net/wiki/rest/api/search?cql=type=page&limit=25
-   *
-   * Example response:
-   *
-   *     {
-   *       "results": [
-   *         { ... },
-   *         { ... },
-   *         ...
-   *         { ... }
-   *       ],
-   *       "limit": 25,
-   *       "size": 25,
-   *       ...
-   *       "_links": {
-   *         "base": "<url>",
-   *         "context": "<url>",
-   *         "next": "/rest/api/search?cql=type=page&limit=25&cursor=raNDoMsTRiNg",
-   *         "self": "<url>"
-   *       }
-   *     }
-   *
    * When additional results are available, returns `next` and `prev` URLs to retrieve them in subsequent calls. The
    * URLs each contain a cursor that points to the appropriate set of results. Use `limit` to specify the number of
    * results returned in each call.
    *
-   * Example subsequent call (taken from example response):
-   *
-   *     https://your-domain.atlassian.net/wiki/rest/api/search?cql=type=page&limit=25&cursor=raNDoMsTRiNg
-   *
-   * The response to this will have a `prev` URL similar to the `next` in the example response.
-   *
    * **[Permissions](https://confluence.atlassian.com/x/_AozKw) required**: Permission to view the entities. Note, only
    * entities that the user has permission to view will be returned.
    */
-  async search<T = Models.SearchPageResponseSearchResult>(
-    parameters: Parameters.Search,
+  async searchByCQL<T = Models.SearchPageResponseSearchResult>(
+    parameters: Parameters.SearchByCQL,
     callback: Callback<T>
   ): Promise<void>;
   /**
    * Searches for content using the [Confluence Query Language
    * (CQL)](https://developer.atlassian.com/cloud/confluence/advanced-searching-using-cql/)
    *
-   * Example initial call:
-   *
-   *     https://your-domain.atlassian.net/wiki/rest/api/search?cql=type=page&limit=25
-   *
-   * Example response:
-   *
-   *     {
-   *       "results": [
-   *         { ... },
-   *         { ... },
-   *         ...
-   *         { ... }
-   *       ],
-   *       "limit": 25,
-   *       "size": 25,
-   *       ...
-   *       "_links": {
-   *         "base": "<url>",
-   *         "context": "<url>",
-   *         "next": "/rest/api/search?cql=type=page&limit=25&cursor=raNDoMsTRiNg",
-   *         "self": "<url>"
-   *       }
-   *     }
-   *
    * When additional results are available, returns `next` and `prev` URLs to retrieve them in subsequent calls. The
    * URLs each contain a cursor that points to the appropriate set of results. Use `limit` to specify the number of
    * results returned in each call.
    *
-   * Example subsequent call (taken from example response):
-   *
-   *     https://your-domain.atlassian.net/wiki/rest/api/search?cql=type=page&limit=25&cursor=raNDoMsTRiNg
-   *
-   * The response to this will have a `prev` URL similar to the `next` in the example response.
-   *
    * **[Permissions](https://confluence.atlassian.com/x/_AozKw) required**: Permission to view the entities. Note, only
    * entities that the user has permission to view will be returned.
    */
-  async search<T = Models.SearchPageResponseSearchResult>(parameters: Parameters.Search, callback?: never): Promise<T>;
-  async search<T = Models.SearchPageResponseSearchResult>(
-    parameters: Parameters.Search,
+  async searchByCQL<T = Models.SearchPageResponseSearchResult>(
+    parameters: Parameters.SearchByCQL,
+    callback?: never
+  ): Promise<T>;
+  async searchByCQL<T = Models.SearchPageResponseSearchResult>(
+    parameters: Parameters.SearchByCQL,
     callback?: Callback<T>,
   ): Promise<void | T> {
     const config: RequestConfig = {
@@ -105,14 +62,37 @@ export class Search {
         cql: parameters.cql,
         cqlcontext: parameters.cqlcontext,
         cursor: parameters.cursor,
+        next: parameters.next,
+        prev: parameters.prev,
         limit: parameters.limit,
+        start: parameters.start,
         includeArchivedSpaces: parameters.includeArchivedSpaces,
+        excludeCurrentSpaces: parameters.excludeCurrentSpaces,
+        excerpt: parameters.excerpt,
+        sitePermissionTypeFilter: parameters.sitePermissionTypeFilter,
+        expand: parameters.expand,
       },
     };
 
-    return this.client.sendRequest(config, callback, { methodName: 'search' });
+    return this.client.sendRequest(config, callback, { methodName: 'searchByCQL' });
   }
 
+  /** @deprecated Will be removed in the next major version. Use `searchUser` instead. */
+  async userSearch<T = Models.SearchPageResponseSearchResult>(
+    parameters: Parameters.UserSearch,
+    callback: Callback<T>
+  ): Promise<void>;
+  /** @deprecated Will be removed in the next major version. Use `searchUser` instead. */
+  async userSearch<T = Models.SearchPageResponseSearchResult>(
+    parameters: Parameters.UserSearch,
+    callback?: never
+  ): Promise<T>;
+  async userSearch<T = Models.SearchPageResponseSearchResult>(
+    parameters: Parameters.UserSearch,
+    callback?: Callback<T>,
+  ): 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/).
@@ -120,8 +100,8 @@ export class Search {
    * Note that some user fields may be set to null depending on the user's privacy settings. These are: email,
    * profilePicture, and displayName.
    */
-  async userSearch<T = Models.SearchPageResponseSearchResult>(
-    parameters: Parameters.UserSearch,
+  async searchUser<T = Models.SearchPageResponseSearchResult>(
+    parameters: Parameters.SearchUser,
     callback: Callback<T>
   ): Promise<void>;
   /**
@@ -131,12 +111,12 @@ export class Search {
    * Note that some user fields may be set to null depending on the user's privacy settings. These are: email,
    * profilePicture, and displayName.
    */
-  async userSearch<T = Models.SearchPageResponseSearchResult>(
-    parameters: Parameters.UserSearch,
+  async searchUser<T = Models.SearchPageResponseSearchResult>(
+    parameters: Parameters.SearchUser,
     callback?: never
   ): Promise<T>;
-  async userSearch<T = Models.SearchPageResponseSearchResult>(
-    parameters: Parameters.UserSearch,
+  async searchUser<T = Models.SearchPageResponseSearchResult>(
+    parameters: Parameters.SearchUser,
     callback?: Callback<T>,
   ): Promise<void | T> {
     const config: RequestConfig = {
@@ -149,6 +129,6 @@ export class Search {
       },
     };
 
-    return this.client.sendRequest(config, callback, { methodName: 'search' });
+    return this.client.sendRequest(config, callback, { methodName: 'searchUser' });
   }
 }

package/src/api/settings.ts

@@ -93,7 +93,7 @@ export class Settings {
    *
    * **[Permissions](https://confluence.atlassian.com/x/_AozKw) required**: 'Admin' permission for the space.
    */
-  async updateLookAndFeelSettings<T = Models.LookAndFeelUpdated>(
+  async updateLookAndFeelSettings<T = Models.LookAndFeel>(
     parameters: Parameters.UpdateLookAndFeelSettings | undefined,
     callback: Callback<T>
   ): Promise<void>;
@@ -106,11 +106,11 @@ export class Settings {
    *
    * **[Permissions](https://confluence.atlassian.com/x/_AozKw) required**: 'Admin' permission for the space.
    */
-  async updateLookAndFeelSettings<T = Models.LookAndFeelUpdated>(
+  async updateLookAndFeelSettings<T = Models.LookAndFeel>(
     parameters?: Parameters.UpdateLookAndFeelSettings,
     callback?: never
   ): Promise<T>;
-  async updateLookAndFeelSettings<T = Models.LookAndFeelUpdated>(
+  async updateLookAndFeelSettings<T = Models.LookAndFeel>(
     parameters?: Parameters.UpdateLookAndFeelSettings,
     callback?: Callback<T>,
   ): Promise<void | T> {
@@ -125,8 +125,11 @@ export class Settings {
         links: parameters?.links,
         menus: parameters?.menus,
         header: parameters?.header,
+        horizontalHeader: parameters?.horizontalHeader,
         content: parameters?.content,
         bordersAndDividers: parameters?.bordersAndDividers,
+        spaceReference: parameters?.spaceReference,
+        _links: parameters?.links,
       },
     };
 

package/src/api/space.ts

@@ -106,6 +106,7 @@ export class Space {
         key: parameters?.key,
         name: parameters?.name,
         description: parameters?.description,
+        permissions: parameters?.permissions,
       },
     };
 
@@ -159,6 +160,8 @@ export class Space {
         name: parameters.name,
         description: parameters.description,
         homepage: parameters.homepage,
+        type: parameters.type,
+        status: parameters.status,
       },
     };
 

package/src/api/spacePermissions.ts

@@ -7,6 +7,20 @@ import { RequestConfig } from '../requestConfig';
 export class SpacePermissions {
   constructor(private client: Client) {}
 
+  /** @deprecated Will be removed in the next major version. Use `addPermissionToSpace` instead. */
+  async addPermission<T = Models.SpacePermissionV2>(
+    parameters: Parameters.AddPermission,
+    callback: Callback<T>
+  ): Promise<void>;
+  /** @deprecated Will be removed in the next major version. Use `addPermissionToSpace` instead. */
+  async addPermission<T = Models.SpacePermissionV2>(parameters: Parameters.AddPermission, callback?: never): Promise<T>;
+  async addPermission<T = Models.SpacePermissionV2>(
+    parameters: Parameters.AddPermission,
+    callback?: Callback<T>,
+  ): Promise<void | T> {
+    return this.addPermissionToSpace(parameters, callback!);
+  }
+
   /**
    * Adds new permission to space.
    *
@@ -16,8 +30,8 @@ export class SpacePermissions {
    *
    * **[Permissions](https://confluence.atlassian.com/x/_AozKw) required**: 'Admin' permission for the space.
    */
-  async addPermission<T = Models.SpacePermissionV2>(
-    parameters: Parameters.AddPermission,
+  async addPermissionToSpace<T = Models.SpacePermissionV2>(
+    parameters: Parameters.AddPermissionToSpace,
     callback: Callback<T>
   ): Promise<void>;
   /**
@@ -29,23 +43,67 @@ export class SpacePermissions {
    *
    * **[Permissions](https://confluence.atlassian.com/x/_AozKw) required**: 'Admin' permission for the space.
    */
-  async addPermission<T = Models.SpacePermissionV2>(parameters: Parameters.AddPermission, callback?: never): Promise<T>;
-  async addPermission<T = Models.SpacePermissionV2>(
-    parameters: Parameters.AddPermission,
+  async addPermissionToSpace<T = Models.SpacePermissionV2>(
+    parameters: Parameters.AddPermissionToSpace,
+    callback?: never
+  ): Promise<T>;
+  async addPermissionToSpace<T = Models.SpacePermissionV2>(
+    parameters: Parameters.AddPermissionToSpace,
     callback?: Callback<T>,
   ): Promise<void | T> {
     const config: RequestConfig = {
       url: `/api/space/${parameters.spaceKey}/permission`,
       method: 'POST',
       data: {
-        id: parameters.id,
         subject: parameters.subject,
         operation: parameters.operation,
-        _links: parameters._links,
+        _links: parameters.links,
+      },
+    };
+
+    return this.client.sendRequest(config, callback, { methodName: 'addPermissionToSpace' });
+  }
+
+  /**
+   * Adds new custom content permission to space.
+   *
+   * If the permission to be added is a group permission, the group can be identified by its group name or group id.
+   *
+   * Note: Only apps can access this REST resource and only make changes to the respective app permissions.
+   *
+   * **[Permissions](https://confluence.atlassian.com/x/_AozKw) required**: 'Admin' permission for the space.
+   */
+  async addCustomContentPermissions<T = unknown>(
+    parameters: Parameters.AddCustomContentPermissions,
+    callback: Callback<T>
+  ): Promise<void>;
+  /**
+   * Adds new custom content permission to space.
+   *
+   * If the permission to be added is a group permission, the group can be identified by its group name or group id.
+   *
+   * Note: Only apps can access this REST resource and only make changes to the respective app permissions.
+   *
+   * **[Permissions](https://confluence.atlassian.com/x/_AozKw) required**: 'Admin' permission for the space.
+   */
+  async addCustomContentPermissions<T = unknown>(
+    parameters: Parameters.AddCustomContentPermissions,
+    callback?: never
+  ): Promise<T>;
+  async addCustomContentPermissions<T = unknown>(
+    parameters: Parameters.AddCustomContentPermissions,
+    callback?: Callback<T>,
+  ): Promise<void | T> {
+    const config: RequestConfig = {
+      url: `/api/space/${parameters.spaceKey}/permission/custom-content`,
+      method: 'POST',
+      data: {
+        subject: parameters.subject,
+        operations: parameters.operations,
       },
     };
 
-    return this.client.sendRequest(config, callback, { methodName: 'addPermission' });
+    return this.client.sendRequest(config, callback, { methodName: 'addCustomContentPermissions' });
   }
 
   /**

package/src/api/spaceProperties.ts

@@ -70,6 +70,7 @@ export class SpaceProperties {
       data: {
         key: parameters.key,
         value: parameters.value,
+        space: parameters.space,
       },
     };
 
@@ -110,8 +111,8 @@ export class SpaceProperties {
   }
 
   /**
-   * Creates a new space property. This is the same as `POST /api/space/{spaceKey}/property` but the key for the
-   * property is passed as a path parameter, rather than in the request body.
+   * Creates a new space property. This is the same as `POST /wiki/rest/api/space/{spaceKey}/property` but the key for
+   * the property is passed as a path parameter, rather than in the request body.
    *
    * **[Permissions required](https://confluence.atlassian.com/x/_AozKw)**: ‘Admin’ permission for the space.
    */
@@ -120,8 +121,8 @@ export class SpaceProperties {
     callback: Callback<T>
   ): Promise<void>;
   /**
-   * Creates a new space property. This is the same as `POST /api/space/{spaceKey}/property` but the key for the
-   * property is passed as a path parameter, rather than in the request body.
+   * Creates a new space property. This is the same as `POST /wiki/rest/api/space/{spaceKey}/property` but the key for
+   * the property is passed as a path parameter, rather than in the request body.
    *
    * **[Permissions required](https://confluence.atlassian.com/x/_AozKw)**: ‘Admin’ permission for the space.
    */

package/src/clients/baseClient.ts

@@ -101,8 +101,8 @@ export class BaseClient implements Client {
       bodyExists: !!requestConfig.data,
       callbackUsed: !!callback,
       headersExists: !!requestConfig.headers,
-      libVersion: '1.1.3',
-      libVersionHash: '6d8c23a768aec9eefc52917e68aa3926',
+      libVersion: '1.2.0',
+      libVersionHash: '0ba4439ee9a46d9d9f14c60f88f45f87',
       methodName: telemetryData?.methodName || 'sendRequest',
       onErrorMiddlewareUsed: !!this.config.middlewares?.onError,
       onResponseMiddlewareUsed: !!this.config.middlewares?.onResponse,

package/src/clients/confluenceClient.ts

@@ -14,6 +14,7 @@ import {
   ContentVersions,
   ContentWatches,
   DynamicModules,
+  Experimental,
   Group,
   InlineTasks,
   LabelInfo,
@@ -45,6 +46,7 @@ export class ConfluenceClient extends BaseClient {
   contentVersions = new ContentVersions(this);
   contentWatches = new ContentWatches(this);
   dynamicModules = new DynamicModules(this);
+  experimental = new Experimental(this);
   group = new Group(this);
   inlineTasks = new InlineTasks(this);
   labelInfo = new LabelInfo(this);