confluence.js 1.2.2 → 1.4.0

package/src/api/contentRestrictions.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 ContentRestrictions {
@@ -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

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

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

@@ -1,6 +1,6 @@
 import * as Parameters from './parameters';
-import { Client } from '../clients';
 import { Callback } from '../callback';
+import { Client } from '../clients';
 import { RequestConfig } from '../requestConfig';
 
 export class DynamicModules {
@@ -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

@@ -1,12 +1,55 @@
 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 Experimental {
   constructor(private client: Client) {}
 
+  /**
+   * Moves a pagetree rooted at a page to the space's trash:
+   *
+   * - If the content's type is `page` and its status is `current`, it will be trashed including all its descendants.
+   * - For every other combination of content type and status, this API is not supported.
+   *
+   * This API accepts the pageTree delete request and returns a task ID. The delete process happens asynchronously.
+   *
+   * Use the `/longtask/<taskId>` REST API to get the copy task status.
+   *
+   * **[Permissions](https://confluence.atlassian.com/x/_AozKw) required**: 'Delete' permission for the space that the
+   * content is in.
+   */
+  async deletePageTree<T = Models.LongTask>(
+    parameters: Parameters.DeletePageTree,
+    callback: Callback<T>
+  ): Promise<void>;
+  /**
+   * Moves a pagetree rooted at a page to the space's trash:
+   *
+   * - If the content's type is `page` and its status is `current`, it will be trashed including all its descendants.
+   * - For every other combination of content type and status, this API is not supported.
+   *
+   * This API accepts the pageTree delete request and returns a task ID. The delete process happens asynchronously.
+   *
+   * Use the `/longtask/<taskId>` REST API to get the copy task status.
+   *
+   * **[Permissions](https://confluence.atlassian.com/x/_AozKw) required**: 'Delete' permission for the space that the
+   * content is in.
+   */
+  async deletePageTree<T = Models.LongTask>(parameters: Parameters.DeletePageTree, callback?: never): Promise<T>;
+  async deletePageTree<T = Models.LongTask>(
+    parameters: Parameters.DeletePageTree,
+    callback?: Callback<T>,
+  ): Promise<void | T> {
+    const config: RequestConfig = {
+      url: `/api/content/${parameters.id}/pageTree`,
+      method: 'DELETE',
+    };
+
+    return this.client.sendRequest(config, callback);
+  }
+
   /**
    * Returns a list of labels associated with a space. Can provide a prefix as well as other filters to select different
    * types of labels.
@@ -37,7 +80,7 @@ export class Experimental {
       },
     };
 
-    return this.client.sendRequest(config, callback, { methodName: 'getLabelsForSpace' });
+    return this.client.sendRequest(config, callback);
   }
 
   /**
@@ -76,7 +119,7 @@ export class Experimental {
       method: 'POST',
     };
 
-    return this.client.sendRequest(config, callback, { methodName: 'addLabelsToSpace' });
+    return this.client.sendRequest(config, callback);
   }
 
   async deleteLabelFromSpace<T = void>(
@@ -97,23 +140,183 @@ export class Experimental {
       },
     };
 
-    return this.client.sendRequest(config, callback, { methodName: 'deleteLabelFromSpace' });
+    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. */
-  async getViews<T = Models.GetViews>(parameters: Parameters.GetViews, callback?: never): Promise<T>;
-  async getViews<T = Models.GetViews>(parameters: Parameters.GetViews, callback?: Callback<T>): Promise<void | T> {
+  /**
+   * Returns the properties for a user as list of property keys. For more information about user properties, see
+   * [Confluence entity properties](https://developer.atlassian.com/cloud/confluence/confluence-entity-properties/).
+   * `Note`, these properties stored against a user are on a Confluence site level and not space/content level.
+   *
+   * **[Permissions](https://confluence.atlassian.com/x/_AozKw) required**: Permission to access the Confluence site
+   * ('Can use' global permission).
+   */
+  async getUserProperties<T = Models.UserPropertyKeyArray>(
+    parameters: Parameters.GetUserProperties,
+    callback: Callback<T>
+  ): Promise<void>;
+  /**
+   * Returns the properties for a user as list of property keys. For more information about user properties, see
+   * [Confluence entity properties](https://developer.atlassian.com/cloud/confluence/confluence-entity-properties/).
+   * `Note`, these properties stored against a user are on a Confluence site level and not space/content level.
+   *
+   * **[Permissions](https://confluence.atlassian.com/x/_AozKw) required**: Permission to access the Confluence site
+   * ('Can use' global permission).
+   */
+  async getUserProperties<T = Models.UserPropertyKeyArray>(
+    parameters: Parameters.GetUserProperties,
+    callback?: never
+  ): Promise<T>;
+  async getUserProperties<T = Models.UserPropertyKeyArray>(
+    parameters: Parameters.GetUserProperties,
+    callback?: Callback<T>,
+  ): Promise<void | T> {
     const config: RequestConfig = {
-      url: `/api/analytics/content/${parameters.contentId}/views`,
+      url: `/api/user/${parameters.userId}/property`,
       method: 'GET',
       params: {
-        fromDate: parameters.fromDate,
+        start: parameters.start,
+        limit: parameters.limit,
+      },
+    };
+
+    return this.client.sendRequest(config, callback);
+  }
+
+  /**
+   * Returns the property corresponding to `key` for a user. For more information about user properties, see [Confluence
+   * entity properties](https://developer.atlassian.com/cloud/confluence/confluence-entity-properties/). `Note`, these
+   * properties stored against a user are on a Confluence site level and not space/content level.
+   *
+   * **[Permissions](https://confluence.atlassian.com/x/_AozKw) required**: Permission to access the Confluence site
+   * ('Can use' global permission).
+   */
+  async getUserProperty<T = Models.UserProperty>(
+    parameters: Parameters.GetUserProperty,
+    callback: Callback<T>
+  ): Promise<void>;
+  /**
+   * Returns the property corresponding to `key` for a user. For more information about user properties, see [Confluence
+   * entity properties](https://developer.atlassian.com/cloud/confluence/confluence-entity-properties/). `Note`, these
+   * properties stored against a user are on a Confluence site level and not space/content level.
+   *
+   * **[Permissions](https://confluence.atlassian.com/x/_AozKw) required**: Permission to access the Confluence site
+   * ('Can use' global permission).
+   */
+  async getUserProperty<T = Models.UserProperty>(parameters: Parameters.GetUserProperty, callback?: never): Promise<T>;
+  async getUserProperty<T = Models.UserProperty>(
+    parameters: Parameters.GetUserProperty,
+    callback?: Callback<T>,
+  ): Promise<void | T> {
+    const config: RequestConfig = {
+      url: `/api/user/${parameters.userId}/property/${parameters.key}`,
+      method: 'GET',
+    };
+
+    return this.client.sendRequest(config, callback);
+  }
+
+  /**
+   * Creates a property for a user. For more information about user properties, see [Confluence entity properties]
+   * (https://developer.atlassian.com/cloud/confluence/confluence-entity-properties/). `Note`, these properties stored
+   * against a user are on a Confluence site level and not space/content level.
+   *
+   * `Note:` the number of properties which could be created per app in a tenant for each user might be restricted by
+   * fixed system limits. **[Permissions](https://confluence.atlassian.com/x/_AozKw) required**: Permission to access
+   * the Confluence site ('Can use' global permission).
+   */
+  async createUserProperty<T = unknown>(
+    parameters: Parameters.CreateUserProperty,
+    callback: Callback<T>
+  ): Promise<void>;
+  /**
+   * Creates a property for a user. For more information about user properties, see [Confluence entity properties]
+   * (https://developer.atlassian.com/cloud/confluence/confluence-entity-properties/). `Note`, these properties stored
+   * against a user are on a Confluence site level and not space/content level.
+   *
+   * `Note:` the number of properties which could be created per app in a tenant for each user might be restricted by
+   * fixed system limits. **[Permissions](https://confluence.atlassian.com/x/_AozKw) required**: Permission to access
+   * the Confluence site ('Can use' global permission).
+   */
+  async createUserProperty<T = unknown>(parameters: Parameters.CreateUserProperty, callback?: never): Promise<T>;
+  async createUserProperty<T = unknown>(
+    parameters: Parameters.CreateUserProperty,
+    callback?: Callback<T>,
+  ): Promise<void | T> {
+    const config: RequestConfig = {
+      url: `/api/user/${parameters.userId}/property/${parameters.key}`,
+      method: 'POST',
+      data: {
+        value: parameters.value,
+      },
+    };
+
+    return this.client.sendRequest(config, callback);
+  }
+
+  /**
+   * Updates a property for the given user. Note, you cannot update the key of a user property, only the value. For more
+   * information about user properties, see [Confluence entity
+   * properties](https://developer.atlassian.com/cloud/confluence/confluence-entity-properties/). `Note`, these
+   * properties stored against a user are on a Confluence site level and not space/content level.
+   *
+   * **[Permissions](https://confluence.atlassian.com/x/_AozKw) required**: Permission to access the Confluence site
+   * ('Can use' global permission).
+   */
+  async updateUserProperty<T = void>(parameters: Parameters.UpdateUserProperty, callback: Callback<T>): Promise<void>;
+  /**
+   * Updates a property for the given user. Note, you cannot update the key of a user property, only the value. For more
+   * information about user properties, see [Confluence entity
+   * properties](https://developer.atlassian.com/cloud/confluence/confluence-entity-properties/). `Note`, these
+   * properties stored against a user are on a Confluence site level and not space/content level.
+   *
+   * **[Permissions](https://confluence.atlassian.com/x/_AozKw) required**: Permission to access the Confluence site
+   * ('Can use' global permission).
+   */
+  async updateUserProperty<T = void>(parameters: Parameters.UpdateUserProperty, callback?: never): Promise<T>;
+  async updateUserProperty<T = void>(
+    parameters: Parameters.UpdateUserProperty,
+    callback?: Callback<T>,
+  ): Promise<void | T> {
+    const config: RequestConfig = {
+      url: `/api/user/${parameters.userId}/property/${parameters.key}`,
+      method: 'PUT',
+      data: {
+        value: parameters.value,
       },
     };
 
-    return this.client.sendRequest(config, callback, { methodName: 'getViews' });
+    return this.client.sendRequest(config, callback);
+  }
+
+  /**
+   * Deletes a property for the given user. For more information about user properties, see [Confluence entity
+   * properties](https://developer.atlassian.com/cloud/confluence/confluence-entity-properties/). `Note`, these
+   * properties stored against a user are on a Confluence site level and not space/content level.
+   *
+   * **[Permissions](https://confluence.atlassian.com/x/_AozKw) required**: Permission to access the Confluence site
+   * ('Can use' global permission).
+   */
+  async deleteUserProperty<T = void>(parameters: Parameters.DeleteUserProperty, callback: Callback<T>): Promise<void>;
+  /**
+   * Deletes a property for the given user. For more information about user properties, see [Confluence entity
+   * properties](https://developer.atlassian.com/cloud/confluence/confluence-entity-properties/). `Note`, these
+   * properties stored against a user are on a Confluence site level and not space/content level.
+   *
+   * **[Permissions](https://confluence.atlassian.com/x/_AozKw) required**: Permission to access the Confluence site
+   * ('Can use' global permission).
+   */
+  async deleteUserProperty<T = void>(parameters: Parameters.DeleteUserProperty, callback?: never): Promise<T>;
+  async deleteUserProperty<T = void>(
+    parameters: Parameters.DeleteUserProperty,
+    callback?: Callback<T>,
+  ): Promise<void | T> {
+    const config: RequestConfig = {
+      url: `/api/user/${parameters.userId}/property/${parameters.key}`,
+      method: 'DELETE',
+    };
+
+    return this.client.sendRequest(config, callback);
   }
 
   /** Get the total number of distinct viewers a piece of content has. */
@@ -132,6 +335,6 @@ export class Experimental {
       },
     };
 
-    return this.client.sendRequest(config, callback, { methodName: 'getViewers' });
+    return this.client.sendRequest(config, callback);
   }
 }