confluence.js 1.2.0 → 1.3.1

package/src/api/contentComments.ts

@@ -43,6 +43,6 @@ export class ContentComments {
       },
     };
 
-    return this.client.sendRequest(config, callback, { methodName: 'getContentComments' });
+    return this.client.sendRequest(config, callback);
   }
 }

package/src/api/contentLabels.ts

@@ -41,7 +41,7 @@ export class ContentLabels {
       },
     };
 
-    return this.client.sendRequest(config, callback, { methodName: 'getLabelsForContent' });
+    return this.client.sendRequest(config, callback);
   }
 
   /**
@@ -87,7 +87,7 @@ export class ContentLabels {
       data: parameters.body,
     };
 
-    return this.client.sendRequest(config, callback, { methodName: 'addLabelsToContent' });
+    return this.client.sendRequest(config, callback);
   }
 
   /**
@@ -128,7 +128,7 @@ export class ContentLabels {
       },
     };
 
-    return this.client.sendRequest(config, callback, { methodName: 'removeLabelFromContentUsingQueryParameter' });
+    return this.client.sendRequest(config, callback);
   }
 
   /**
@@ -165,6 +165,6 @@ export class ContentLabels {
       method: 'DELETE',
     };
 
-    return this.client.sendRequest(config, callback, { methodName: 'removeLabelFromContent' });
+    return this.client.sendRequest(config, callback);
   }
 }

package/src/api/contentMacroBody.ts

@@ -54,6 +54,6 @@ export class ContentMacroBody {
       method: 'GET',
     };
 
-    return this.client.sendRequest(config, callback, { methodName: 'getMacroBodyByMacroId' });
+    return this.client.sendRequest(config, callback);
   }
 }

package/src/api/contentPermissions.ts

@@ -73,6 +73,6 @@ export class ContentPermissions {
       },
     };
 
-    return this.client.sendRequest(config, callback, { methodName: 'checkContentPermission' });
+    return this.client.sendRequest(config, callback);
   }
 }

package/src/api/contentProperties.ts

@@ -44,7 +44,7 @@ export class ContentProperties {
       },
     };
 
-    return this.client.sendRequest(config, callback, { methodName: 'getContentProperties' });
+    return this.client.sendRequest(config, callback);
   }
 
   /**
@@ -92,7 +92,7 @@ export class ContentProperties {
       },
     };
 
-    return this.client.sendRequest(config, callback, { methodName: 'createContentProperty' });
+    return this.client.sendRequest(config, callback);
   }
 
   /**
@@ -126,10 +126,11 @@ export class ContentProperties {
       method: 'GET',
       params: {
         expand: parameters.expand,
+        status: parameters.status,
       },
     };
 
-    return this.client.sendRequest(config, callback, { methodName: 'getContentProperty' });
+    return this.client.sendRequest(config, callback);
   }
 
   /**
@@ -176,7 +177,7 @@ export class ContentProperties {
       },
     };
 
-    return this.client.sendRequest(config, callback, { methodName: 'createContentPropertyForKey' });
+    return this.client.sendRequest(config, callback);
   }
 
   /**
@@ -214,7 +215,7 @@ export class ContentProperties {
       },
     };
 
-    return this.client.sendRequest(config, callback, { methodName: 'updateContentProperty' });
+    return this.client.sendRequest(config, callback);
   }
 
   /**
@@ -243,6 +244,6 @@ export class ContentProperties {
       method: 'DELETE',
     };
 
-    return this.client.sendRequest(config, callback, { methodName: 'deleteContentProperty' });
+    return this.client.sendRequest(config, callback);
   }
 }

package/src/api/contentRestrictions.ts

@@ -39,7 +39,7 @@ export class ContentRestrictions {
       },
     };
 
-    return this.client.sendRequest(config, callback, { methodName: 'getRestrictions' });
+    return this.client.sendRequest(config, callback);
   }
 
   /**
@@ -73,7 +73,7 @@ export class ContentRestrictions {
       data: parameters.body,
     };
 
-    return this.client.sendRequest(config, callback, { methodName: 'addRestrictions' });
+    return this.client.sendRequest(config, callback);
   }
 
   /**
@@ -109,7 +109,7 @@ export class ContentRestrictions {
       data: parameters.body,
     };
 
-    return this.client.sendRequest(config, callback, { methodName: 'updateRestrictions' });
+    return this.client.sendRequest(config, callback);
   }
 
   /**
@@ -142,7 +142,7 @@ export class ContentRestrictions {
       },
     };
 
-    return this.client.sendRequest(config, callback, { methodName: 'deleteRestrictions' });
+    return this.client.sendRequest(config, callback);
   }
 
   /**
@@ -179,7 +179,7 @@ export class ContentRestrictions {
       },
     };
 
-    return this.client.sendRequest(config, callback, { methodName: 'getRestrictionsByOperation' });
+    return this.client.sendRequest(config, callback);
   }
 
   /**
@@ -214,7 +214,7 @@ export class ContentRestrictions {
       },
     };
 
-    return this.client.sendRequest(config, callback, { methodName: 'getRestrictionsForOperation' });
+    return this.client.sendRequest(config, callback);
   }
 
   /**
@@ -258,7 +258,7 @@ export class ContentRestrictions {
       method: 'GET',
     };
 
-    return this.client.sendRequest(config, callback, { methodName: 'getContentRestrictionStatusForGroup' });
+    return this.client.sendRequest(config, callback);
   }
 
   /**
@@ -288,7 +288,7 @@ export class ContentRestrictions {
       method: 'PUT',
     };
 
-    return this.client.sendRequest(config, callback, { methodName: 'addGroupToContentRestriction' });
+    return this.client.sendRequest(config, callback);
   }
 
   /**
@@ -312,7 +312,7 @@ export class ContentRestrictions {
       method: 'DELETE',
     };
 
-    return this.client.sendRequest(config, callback, { methodName: 'removeGroupByName' });
+    return this.client.sendRequest(config, callback);
   }
 
   /**
@@ -356,7 +356,7 @@ export class ContentRestrictions {
       method: 'GET',
     };
 
-    return this.client.sendRequest(config, callback, { methodName: 'getIndividualGroupRestrictionStatusByGroupId' });
+    return this.client.sendRequest(config, callback);
   }
 
   /**
@@ -388,7 +388,7 @@ export class ContentRestrictions {
       method: 'PUT',
     };
 
-    return this.client.sendRequest(config, callback, { methodName: 'addGroupToContentRestrictionByGroupId' });
+    return this.client.sendRequest(config, callback);
   }
 
   /**
@@ -412,7 +412,7 @@ export class ContentRestrictions {
       method: 'DELETE',
     };
 
-    return this.client.sendRequest(config, callback, { methodName: 'removeGroupById' });
+    return this.client.sendRequest(config, callback);
   }
 
   /**
@@ -463,7 +463,7 @@ export class ContentRestrictions {
       },
     };
 
-    return this.client.sendRequest(config, callback, { methodName: 'getContentRestrictionStatusForUser' });
+    return this.client.sendRequest(config, callback);
   }
 
   /**
@@ -498,7 +498,7 @@ export class ContentRestrictions {
       },
     };
 
-    return this.client.sendRequest(config, callback, { methodName: 'addUserToContentRestriction' });
+    return this.client.sendRequest(config, callback);
   }
 
   /**
@@ -533,6 +533,6 @@ export class ContentRestrictions {
       },
     };
 
-    return this.client.sendRequest(config, callback, { methodName: 'removeUserFromContentRestriction' });
+    return this.client.sendRequest(config, callback);
   }
 }

package/src/api/contentVersions.ts

@@ -41,7 +41,7 @@ export class ContentVersions {
       },
     };
 
-    return this.client.sendRequest(config, callback, { methodName: 'getContentVersions' });
+    return this.client.sendRequest(config, callback);
   }
 
   /**
@@ -80,7 +80,7 @@ export class ContentVersions {
       },
     };
 
-    return this.client.sendRequest(config, callback, { methodName: 'restoreContentVersion' });
+    return this.client.sendRequest(config, callback);
   }
 
   /**
@@ -112,7 +112,7 @@ export class ContentVersions {
       },
     };
 
-    return this.client.sendRequest(config, callback, { methodName: 'getContentVersion' });
+    return this.client.sendRequest(config, callback);
   }
 
   /**
@@ -141,6 +141,6 @@ export class ContentVersions {
       method: 'DELETE',
     };
 
-    return this.client.sendRequest(config, callback, { methodName: 'deleteContentVersion' });
+    return this.client.sendRequest(config, callback);
   }
 }

package/src/api/contentWatches.ts

@@ -52,7 +52,7 @@ export class ContentWatches {
       },
     };
 
-    return this.client.sendRequest(config, callback, { methodName: 'getWatchesForPage' });
+    return this.client.sendRequest(config, callback);
   }
 
   /**
@@ -102,7 +102,7 @@ export class ContentWatches {
       },
     };
 
-    return this.client.sendRequest(config, callback, { methodName: 'getWatchesForSpace' });
+    return this.client.sendRequest(config, callback);
   }
 
   /** Returns a list of watchers of a space */
@@ -128,7 +128,7 @@ export class ContentWatches {
       },
     };
 
-    return this.client.sendRequest(config, callback, { methodName: 'getWatchersForSpace' });
+    return this.client.sendRequest(config, callback);
   }
 
   /**
@@ -171,7 +171,7 @@ export class ContentWatches {
       },
     };
 
-    return this.client.sendRequest(config, callback, { methodName: 'getContentWatchStatus' });
+    return this.client.sendRequest(config, callback);
   }
 
   /**
@@ -212,7 +212,7 @@ export class ContentWatches {
       },
     };
 
-    return this.client.sendRequest(config, callback, { methodName: 'addContentWatcher' });
+    return this.client.sendRequest(config, callback);
   }
 
   /**
@@ -255,7 +255,7 @@ export class ContentWatches {
       },
     };
 
-    return this.client.sendRequest(config, callback, { methodName: 'removeContentWatcher' });
+    return this.client.sendRequest(config, callback);
   }
 
   /**
@@ -295,7 +295,7 @@ export class ContentWatches {
       },
     };
 
-    return this.client.sendRequest(config, callback, { methodName: 'isWatchingLabel' });
+    return this.client.sendRequest(config, callback);
   }
 
   /**
@@ -336,7 +336,7 @@ export class ContentWatches {
       },
     };
 
-    return this.client.sendRequest(config, callback, { methodName: 'addLabelWatcher' });
+    return this.client.sendRequest(config, callback);
   }
 
   /**
@@ -373,7 +373,7 @@ export class ContentWatches {
       },
     };
 
-    return this.client.sendRequest(config, callback, { methodName: 'removeLabelWatcher' });
+    return this.client.sendRequest(config, callback);
   }
 
   /**
@@ -413,7 +413,7 @@ export class ContentWatches {
       },
     };
 
-    return this.client.sendRequest(config, callback, { methodName: 'isWatchingSpace' });
+    return this.client.sendRequest(config, callback);
   }
 
   /**
@@ -454,7 +454,7 @@ export class ContentWatches {
       },
     };
 
-    return this.client.sendRequest(config, callback, { methodName: 'addSpaceWatcher' });
+    return this.client.sendRequest(config, callback);
   }
 
   /**
@@ -488,6 +488,6 @@ export class ContentWatches {
       },
     };
 
-    return this.client.sendRequest(config, callback, { methodName: 'removeSpaceWatch' });
+    return this.client.sendRequest(config, callback);
   }
 }

package/src/api/dynamicModules.ts

@@ -24,7 +24,7 @@ export class DynamicModules {
       method: 'GET',
     };
 
-    return this.client.sendRequest(config, callback, { methodName: 'getModules' });
+    return this.client.sendRequest(config, callback);
   }
 
   /**
@@ -53,7 +53,7 @@ export class DynamicModules {
       method: 'POST',
     };
 
-    return this.client.sendRequest(config, callback, { methodName: 'registerModules' });
+    return this.client.sendRequest(config, callback);
   }
 
   /**
@@ -77,6 +77,6 @@ export class DynamicModules {
       },
     };
 
-    return this.client.sendRequest(config, callback, { methodName: 'removeModules' });
+    return this.client.sendRequest(config, callback);
   }
 }

package/src/api/experimental.ts

@@ -7,6 +7,99 @@ import { RequestConfig } from '../requestConfig';
 export class Experimental {
   constructor(private client: Client) {}
 
+  /**
+   * Returns a list of labels associated with a space. Can provide a prefix as well as other filters to select different
+   * types of labels.
+   */
+  async getLabelsForSpace<T = Models.LabelArray>(
+    parameters: Parameters.GetLabelsForSpace,
+    callback: Callback<T>
+  ): Promise<void>;
+  /**
+   * Returns a list of labels associated with a space. Can provide a prefix as well as other filters to select different
+   * types of labels.
+   */
+  async getLabelsForSpace<T = Models.LabelArray>(
+    parameters: Parameters.GetLabelsForSpace,
+    callback?: never
+  ): Promise<T>;
+  async getLabelsForSpace<T = Models.LabelArray>(
+    parameters: Parameters.GetLabelsForSpace,
+    callback?: Callback<T>,
+  ): Promise<void | T> {
+    const config: RequestConfig = {
+      url: `/api/space/${parameters.spaceKey}/label`,
+      method: 'GET',
+      params: {
+        prefix: parameters.prefix,
+        start: parameters.start,
+        limit: parameters.limit,
+      },
+    };
+
+    return this.client.sendRequest(config, callback);
+  }
+
+  /**
+   * Adds labels to a piece of content. Does not modify the existing labels.
+   *
+   * Notes:
+   *
+   * - Labels can also be added when creating content ([Create content](#api-content-post)).
+   * - Labels can be updated when updating content ([Update content](#api-content-id-put)). This will delete the existing
+   *   labels and replace them with the labels in the request.
+   *
+   * **[Permissions](https://confluence.atlassian.com/x/_AozKw) required**: Permission to update the content.
+   */
+  async addLabelsToSpace<T = Models.LabelArray>(
+    parameters: Parameters.AddLabelsToSpace,
+    callback: Callback<T>
+  ): Promise<void>;
+  /**
+   * Adds labels to a piece of content. Does not modify the existing labels.
+   *
+   * Notes:
+   *
+   * - Labels can also be added when creating content ([Create content](#api-content-post)).
+   * - Labels can be updated when updating content ([Update content](#api-content-id-put)). This will delete the existing
+   *   labels and replace them with the labels in the request.
+   *
+   * **[Permissions](https://confluence.atlassian.com/x/_AozKw) required**: Permission to update the content.
+   */
+  async addLabelsToSpace<T = Models.LabelArray>(parameters: Parameters.AddLabelsToSpace, callback?: never): Promise<T>;
+  async addLabelsToSpace<T = Models.LabelArray>(
+    parameters: Parameters.AddLabelsToSpace,
+    callback?: Callback<T>,
+  ): Promise<void | T> {
+    const config: RequestConfig = {
+      url: `/api/space/${parameters.spaceKey}/label`,
+      method: 'POST',
+    };
+
+    return this.client.sendRequest(config, callback);
+  }
+
+  async deleteLabelFromSpace<T = void>(
+    parameters: Parameters.DeleteLabelFromSpace,
+    callback: Callback<T>
+  ): Promise<void>;
+  async deleteLabelFromSpace<T = void>(parameters: Parameters.DeleteLabelFromSpace, callback?: never): Promise<T>;
+  async deleteLabelFromSpace<T = void>(
+    parameters: Parameters.DeleteLabelFromSpace,
+    callback?: Callback<T>,
+  ): Promise<void | T> {
+    const config: RequestConfig = {
+      url: `/api/space/${parameters.spaceKey}/label`,
+      method: 'DELETE',
+      params: {
+        name: parameters.name,
+        prefix: parameters.prefix,
+      },
+    };
+
+    return this.client.sendRequest(config, callback);
+  }
+
   /** Get the total number of views a piece of content has. */
   async getViews<T = Models.GetViews>(parameters: Parameters.GetViews, callback: Callback<T>): Promise<void>;
   /** Get the total number of views a piece of content has. */
@@ -20,7 +113,7 @@ export class Experimental {
       },
     };
 
-    return this.client.sendRequest(config, callback, { methodName: 'getViews' });
+    return this.client.sendRequest(config, callback);
   }
 
   /** Get the total number of distinct viewers a piece of content has. */
@@ -39,6 +132,6 @@ export class Experimental {
       },
     };
 
-    return this.client.sendRequest(config, callback, { methodName: 'getViewers' });
+    return this.client.sendRequest(config, callback);
   }
 }

package/src/api/group.ts

@@ -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);
   }
 
   /**
@@ -254,7 +255,7 @@ export class Group {
       },
     };
 
-    return this.client.sendRequest(config, callback, { methodName: 'getMembersByQueryParam' });
+    return this.client.sendRequest(config, callback);
   }
 
   /**
@@ -291,7 +292,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. */
@@ -332,7 +333,7 @@ export class Group {
       },
     };
 
-    return this.client.sendRequest(config, callback, { methodName: 'searchGroups' });
+    return this.client.sendRequest(config, callback);
   }
 
   /**
@@ -368,7 +369,7 @@ export class Group {
       },
     };
 
-    return this.client.sendRequest(config, callback, { methodName: 'addUserToGroupByGroupId' });
+    return this.client.sendRequest(config, callback);
   }
 
   /**
@@ -402,7 +403,7 @@ export class Group {
       },
     };
 
-    return this.client.sendRequest(config, callback, { methodName: 'removeMemberFromGroupByGroupId' });
+    return this.client.sendRequest(config, callback);
   }
 
   /**
@@ -442,7 +443,7 @@ export class Group {
       },
     };
 
-    return this.client.sendRequest(config, callback, { methodName: 'getGroupMembersByGroupId' });
+    return this.client.sendRequest(config, callback);
   }
 
   /**
@@ -469,7 +470,7 @@ export class Group {
       },
     };
 
-    return this.client.sendRequest(config, callback, { methodName: 'addUserToGroup' });
+    return this.client.sendRequest(config, callback);
   }
 
   /**
@@ -500,6 +501,6 @@ export class Group {
       },
     };
 
-    return this.client.sendRequest(config, callback, { methodName: 'removeMemberFromGroup' });
+    return this.client.sendRequest(config, callback);
   }
 }

package/src/api/inlineTasks.ts

@@ -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

@@ -42,6 +42,6 @@ export class LabelInfo {
       },
     };
 
-    return this.client.sendRequest(config, callback, { methodName: 'getAllLabelContent' });
+    return this.client.sendRequest(config, callback);
   }
 }