confluence.js 1.2.2 → 1.4.0

package/src/api/content.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 Content {
@@ -49,7 +49,7 @@ export class Content {
       },
     };
 
-    return this.client.sendRequest(config, callback, { methodName: 'getContent' });
+    return this.client.sendRequest(config, callback);
   }
 
   /**
@@ -99,7 +99,7 @@ export class Content {
       },
     };
 
-    return this.client.sendRequest(config, callback, { methodName: 'createContent' });
+    return this.client.sendRequest(config, callback);
   }
 
   /**
@@ -138,7 +138,7 @@ export class Content {
       },
     };
 
-    return this.client.sendRequest(config, callback, { methodName: 'archivePages' });
+    return this.client.sendRequest(config, callback);
   }
 
   /**
@@ -185,7 +185,7 @@ export class Content {
       },
     };
 
-    return this.client.sendRequest(config, callback, { methodName: 'publishLegacyDraft' });
+    return this.client.sendRequest(config, callback);
   }
 
   /**
@@ -230,7 +230,7 @@ export class Content {
       },
     };
 
-    return this.client.sendRequest(config, callback, { methodName: 'publishSharedDraft' });
+    return this.client.sendRequest(config, callback);
   }
 
   /**
@@ -286,7 +286,7 @@ export class Content {
       },
     };
 
-    return this.client.sendRequest(config, callback, { methodName: 'searchContentByCQL' });
+    return this.client.sendRequest(config, callback);
   }
 
   /**
@@ -323,7 +323,7 @@ export class Content {
       },
     };
 
-    return this.client.sendRequest(config, callback, { methodName: 'getContentById' });
+    return this.client.sendRequest(config, callback);
   }
 
   /**
@@ -365,7 +365,7 @@ export class Content {
       },
     };
 
-    return this.client.sendRequest(config, callback, { methodName: 'updateContent' });
+    return this.client.sendRequest(config, callback);
   }
 
   /**
@@ -401,7 +401,7 @@ export class Content {
       },
     };
 
-    return this.client.sendRequest(config, callback, { methodName: 'deleteContent' });
+    return this.client.sendRequest(config, callback);
   }
 
   /**
@@ -434,6 +434,6 @@ export class Content {
       },
     };
 
-    return this.client.sendRequest(config, callback, { methodName: 'getHistoryForContent' });
+    return this.client.sendRequest(config, callback);
   }
 }

package/src/api/contentAttachments.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 ContentAttachments {
@@ -44,7 +44,7 @@ export class ContentAttachments {
       },
     };
 
-    return this.client.sendRequest(config, callback, { methodName: 'getAttachments' });
+    return this.client.sendRequest(config, callback);
   }
 
   /**
@@ -136,7 +136,7 @@ export class ContentAttachments {
       },
     };
 
-    return this.client.sendRequest(config, callback, { methodName: 'createAttachments' });
+    return this.client.sendRequest(config, callback);
   }
 
   /**
@@ -230,7 +230,7 @@ export class ContentAttachments {
       },
     };
 
-    return this.client.sendRequest(config, callback, { methodName: 'createOrUpdateAttachments' });
+    return this.client.sendRequest(config, callback);
   }
 
   /**
@@ -263,7 +263,7 @@ export class ContentAttachments {
       data: parameters.body,
     };
 
-    return this.client.sendRequest(config, callback, { methodName: 'updateAttachmentProperties' });
+    return this.client.sendRequest(config, callback);
   }
 
   /**
@@ -358,28 +358,29 @@ export class ContentAttachments {
       },
     };
 
-    return this.client.sendRequest(config, callback, { methodName: 'updateAttachmentData' });
+    return this.client.sendRequest(config, callback);
   }
 
   /** Redirects the client to a URL that serves an attachment's binary data. */
-  async downloadAttachment<T = unknown>(
+  async downloadAttachment<T = ArrayBuffer>(
     parameters: Parameters.DownloadAttachment,
     callback: Callback<T>
   ): Promise<void>;
   /** Redirects the client to a URL that serves an attachment's binary data. */
-  async downloadAttachment<T = unknown>(parameters: Parameters.DownloadAttachment, callback?: never): Promise<T>;
-  async downloadAttachment<T = unknown>(
+  async downloadAttachment<T = ArrayBuffer>(parameters: Parameters.DownloadAttachment, callback?: never): Promise<T>;
+  async downloadAttachment<T = ArrayBuffer>(
     parameters: Parameters.DownloadAttachment,
     callback?: Callback<T>,
   ): Promise<void | T> {
     const config: RequestConfig = {
       url: `/api/content/${parameters.id}/child/attachment/${parameters.attachmentId}/download`,
       method: 'GET',
+      responseType: 'arraybuffer',
       params: {
         version: parameters.version,
       },
     };
 
-    return this.client.sendRequest(config, callback, { methodName: 'downloadAttachment' });
+    return this.client.sendRequest(config, callback);
   }
 }

package/src/api/contentBody.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 ContentBody {
@@ -61,6 +61,6 @@ export class ContentBody {
       },
     };
 
-    return this.client.sendRequest(config, callback, { methodName: 'convertContentBody' });
+    return this.client.sendRequest(config, callback);
   }
 }

package/src/api/contentChildrenAndDescendants.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 ContentChildrenAndDescendants {
@@ -64,7 +64,7 @@ export class ContentChildrenAndDescendants {
       },
     };
 
-    return this.client.sendRequest(config, callback, { methodName: 'getContentChildren' });
+    return this.client.sendRequest(config, callback);
   }
 
   /**
@@ -97,7 +97,7 @@ export class ContentChildrenAndDescendants {
       method: 'PUT',
     };
 
-    return this.client.sendRequest(config, callback, { methodName: 'movePage' });
+    return this.client.sendRequest(config, callback);
   }
 
   /**
@@ -156,7 +156,7 @@ export class ContentChildrenAndDescendants {
       },
     };
 
-    return this.client.sendRequest(config, callback, { methodName: 'getContentChildrenByType' });
+    return this.client.sendRequest(config, callback);
   }
 
   /**
@@ -215,7 +215,7 @@ export class ContentChildrenAndDescendants {
       },
     };
 
-    return this.client.sendRequest(config, callback, { methodName: 'getContentDescendants' });
+    return this.client.sendRequest(config, callback);
   }
 
   /** @deprecated This API will be removed in the next major version. Use `getDescendantsOfType` method instead. */
@@ -292,7 +292,7 @@ export class ContentChildrenAndDescendants {
       },
     };
 
-    return this.client.sendRequest(config, callback, { methodName: 'descendantsOfType' });
+    return this.client.sendRequest(config, callback);
   }
 
   /**
@@ -302,7 +302,10 @@ export class ContentChildrenAndDescendants {
    * of renaming page titles during the copy; for example, search and replace can be used in conjunction to rewrite the
    * copied page titles.
    */
-  async copyPageHierarchy<T = unknown>(parameters: Parameters.CopyPageHierarchy, callback: Callback<T>): Promise<void>;
+  async copyPageHierarchy<T = Models.LongTask>(
+    parameters: Parameters.CopyPageHierarchy,
+    callback: Callback<T>
+  ): Promise<void>;
   /**
    * Copy page hierarchy allows the copying of an entire hierarchy of pages and their associated properties, permissions
    * and attachments. The id path parameter refers to the content id of the page to copy, and the new parent of this
@@ -310,8 +313,8 @@ export class ContentChildrenAndDescendants {
    * of renaming page titles during the copy; for example, search and replace can be used in conjunction to rewrite the
    * copied page titles.
    */
-  async copyPageHierarchy<T = unknown>(parameters: Parameters.CopyPageHierarchy, callback?: never): Promise<T>;
-  async copyPageHierarchy<T = unknown>(
+  async copyPageHierarchy<T = Models.LongTask>(parameters: Parameters.CopyPageHierarchy, callback?: never): Promise<T>;
+  async copyPageHierarchy<T = Models.LongTask>(
     parameters: Parameters.CopyPageHierarchy,
     callback?: Callback<T>,
   ): Promise<void | T> {
@@ -324,12 +327,13 @@ export class ContentChildrenAndDescendants {
         copyProperties: parameters.copyProperties,
         copyLabels: parameters.copyLabels,
         copyCustomContents: parameters.copyCustomContents,
+        copyDescendants: parameters.copyDescendants,
         destinationPageId: parameters.destinationPageId,
         titleOptions: parameters.titleOptions,
       },
     };
 
-    return this.client.sendRequest(config, callback, { methodName: 'copyPageHierarchy' });
+    return this.client.sendRequest(config, callback);
   }
 
   /**
@@ -372,6 +376,6 @@ export class ContentChildrenAndDescendants {
       data: parameters.bodyParameters,
     };
 
-    return this.client.sendRequest(config, callback, { methodName: 'copyPage' });
+    return this.client.sendRequest(config, callback);
   }
 }

package/src/api/contentComments.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 ContentComments {
@@ -43,6 +43,6 @@ export class ContentComments {
       },
     };
 
-    return this.client.sendRequest(config, callback, { methodName: 'getContentComments' });
+    return this.client.sendRequest(config, callback);
   }
 }

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