confluence.js 1.3.0 → 1.4.1

package/src/api/contentContentState.ts

@@ -0,0 +1,157 @@
+import * as Models from './models';
+import * as Parameters from './parameters';
+import { Callback } from '../callback';
+import { Client } from '../clients';
+import { RequestConfig } from '../requestConfig';
+
+export class ContentContentState {
+  constructor(private client: Client) {}
+
+  /**
+   * Gets the current page status of the draft or published version of content. To specify the draft version, set the
+   * parameter status to PUBLISHED, otherwise DRAFT.
+   */
+  async getContentState<T = Models.ContentStateContainer>(
+    parameters: Parameters.GetContentState,
+    callback: Callback<T>
+  ): Promise<void>;
+  /**
+   * Gets the current page status of the draft or published version of content. To specify the draft version, set the
+   * parameter status to PUBLISHED, otherwise DRAFT.
+   */
+  async getContentState<T = Models.ContentStateContainer>(
+    parameters: Parameters.GetContentState,
+    callback?: never
+  ): Promise<T>;
+  async getContentState<T = Models.ContentStateContainer>(
+    parameters: Parameters.GetContentState,
+    callback?: Callback<T>,
+  ): Promise<void | T> {
+    const config: RequestConfig = {
+      url: `/api/content/${parameters.contentId}/state`,
+      method: 'GET',
+      params: {
+        designation: parameters.designation,
+      },
+    };
+
+    return this.client.sendRequest(config, callback);
+  }
+
+  /**
+   * Sets the content state of the content specified and creates a new version (publishes the content without changing
+   * the body) of the content with the new status. The desired type of status must be allowed. There are space suggested
+   * statuses and custom statuses. To specify the desired new status, one can use the id of the status or the name and
+   * color of the status. If contentStateId is defined, then name and color are ignored. If contentStateId is not
+   * defined, name and color will be used if provided. Firstly, we will determine if a status of this name and color
+   * exists, and if it does, that this status is used. If it does not exist, and custom statuses are allowed, a custom
+   * status with this name and color will be created. Color can be specified in traditional english colors (teal,
+   * magenta, lavender, etc.) or as a hex string ex: #0ff0Fd.
+   */
+  async setContentState<T = Models.ContentStateContainer>(
+    parameters: Parameters.SetContentState,
+    callback: Callback<T>
+  ): Promise<void>;
+  /**
+   * Sets the content state of the content specified and creates a new version (publishes the content without changing
+   * the body) of the content with the new status. The desired type of status must be allowed. There are space suggested
+   * statuses and custom statuses. To specify the desired new status, one can use the id of the status or the name and
+   * color of the status. If contentStateId is defined, then name and color are ignored. If contentStateId is not
+   * defined, name and color will be used if provided. Firstly, we will determine if a status of this name and color
+   * exists, and if it does, that this status is used. If it does not exist, and custom statuses are allowed, a custom
+   * status with this name and color will be created. Color can be specified in traditional english colors (teal,
+   * magenta, lavender, etc.) or as a hex string ex: #0ff0Fd.
+   */
+  async setContentState<T = Models.ContentStateContainer>(
+    parameters: Parameters.SetContentState,
+    callback?: never
+  ): Promise<T>;
+  async setContentState<T = Models.ContentStateContainer>(
+    parameters: Parameters.SetContentState,
+    callback?: Callback<T>,
+  ): Promise<void | T> {
+    const config: RequestConfig = {
+      url: `/api/content/${parameters.contentId}/state`,
+      method: 'PUT',
+      params: {
+        contentStateId: parameters.contentStateId,
+        name: parameters.name,
+        color: parameters.color,
+      },
+    };
+
+    return this.client.sendRequest(config, callback);
+  }
+
+  /**
+   * Removes the content state of the content specified and creates a new version (publishes the content without
+   * changing the body) of the content with the new status.
+   */
+  async removeContentState<T = Models.ContentStateContainer>(
+    parameters: Parameters.RemoveContentState,
+    callback: Callback<T>
+  ): Promise<void>;
+  /**
+   * Removes the content state of the content specified and creates a new version (publishes the content without
+   * changing the body) of the content with the new status.
+   */
+  async removeContentState<T = Models.ContentStateContainer>(
+    parameters: Parameters.RemoveContentState,
+    callback?: never
+  ): Promise<T>;
+  async removeContentState<T = Models.ContentStateContainer>(
+    parameters: Parameters.RemoveContentState,
+    callback?: Callback<T>,
+  ): Promise<void | T> {
+    const config: RequestConfig = {
+      url: `/api/content/${parameters.contentId}/state`,
+      method: 'DELETE',
+    };
+
+    return this.client.sendRequest(config, callback);
+  }
+
+  /** Gets a Global Timestamp of the last time the content state was updated */
+  async getContentStateLastUpdated<T = unknown>(
+    parameters: Parameters.GetContentStateLastUpdated,
+    callback: Callback<T>
+  ): Promise<void>;
+  /** Gets a Global Timestamp of the last time the content state was updated */
+  async getContentStateLastUpdated<T = unknown>(
+    parameters: Parameters.GetContentStateLastUpdated,
+    callback?: never
+  ): Promise<T>;
+  async getContentStateLastUpdated<T = unknown>(
+    parameters: Parameters.GetContentStateLastUpdated,
+    callback?: Callback<T>,
+  ): Promise<void | T> {
+    const config: RequestConfig = {
+      url: `/api/content/${parameters.contentId}/state/last-updated`,
+      method: 'GET',
+    };
+
+    return this.client.sendRequest(config, callback);
+  }
+
+  /** Gets content states that are available for the content to be set as. */
+  async getAvailableContentStates<T = Models.AvailableContentStates>(
+    parameters: Parameters.GetAvailableContentStates,
+    callback: Callback<T>
+  ): Promise<void>;
+  /** Gets content states that are available for the content to be set as. */
+  async getAvailableContentStates<T = Models.AvailableContentStates>(
+    parameters: Parameters.GetAvailableContentStates,
+    callback?: never
+  ): Promise<T>;
+  async getAvailableContentStates<T = Models.AvailableContentStates>(
+    parameters: Parameters.GetAvailableContentStates,
+    callback?: Callback<T>,
+  ): Promise<void | T> {
+    const config: RequestConfig = {
+      url: `/api/content/${parameters.contentId}/state/available-states`,
+      method: 'GET',
+    };
+
+    return this.client.sendRequest(config, callback);
+  }
+}

package/src/api/contentLabels.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 ContentLabels {
@@ -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

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

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

@@ -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 ContentProperties {
@@ -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);
   }
 
   /**
@@ -130,7 +130,7 @@ export class ContentProperties {
       },
     };
 
-    return this.client.sendRequest(config, callback, { methodName: 'getContentProperty' });
+    return this.client.sendRequest(config, callback);
   }
 
   /**
@@ -177,7 +177,7 @@ export class ContentProperties {
       },
     };
 
-    return this.client.sendRequest(config, callback, { methodName: 'createContentPropertyForKey' });
+    return this.client.sendRequest(config, callback);
   }
 
   /**
@@ -215,7 +215,7 @@ export class ContentProperties {
       },
     };
 
-    return this.client.sendRequest(config, callback, { methodName: 'updateContentProperty' });
+    return this.client.sendRequest(config, callback);
   }
 
   /**
@@ -244,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

@@ -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);
   }
 }