confluence.js 1.5.1 → 1.6.0

package/src/api/spaceProperties.ts

@@ -111,8 +111,8 @@ export class SpaceProperties {
   }
 
   /**
-   * 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.
+   * 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.
    *
    * **[Permissions required](https://confluence.atlassian.com/x/_AozKw)**: ‘Admin’ permission for the space.
    */
@@ -121,8 +121,8 @@ export class SpaceProperties {
     callback: Callback<T>
   ): Promise<void>;
   /**
-   * 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.
+   * 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.
    *
    * **[Permissions required](https://confluence.atlassian.com/x/_AozKw)**: ‘Admin’ permission for the space.
    */

package/src/api/template.ts

@@ -137,20 +137,24 @@ export class Template {
   }
 
   /**
-   * Returns all content templates. Use this method to retrieve all global content templates or all content templates in a space.
+   * Returns all content templates. Use this method to retrieve all global content templates or all content templates in
+   * a space.
    *
    * **[Permissions](https://confluence.atlassian.com/x/_AozKw) required**: 'View' permission for the space to view
-   * space templates and permission to access the Confluence site ('Can use' global permission) to view global templates.
+   * space templates and permission to access the Confluence site ('Can use' global permission) to view global
+   * templates.
    */
   async getContentTemplates<T = Models.ContentTemplateArray>(
     parameters: Parameters.GetContentTemplates | undefined,
     callback: Callback<T>
   ): Promise<void>;
   /**
-   * Returns all content templates. Use this method to retrieve all global content templates or all content templates in a space.
+   * Returns all content templates. Use this method to retrieve all global content templates or all content templates in
+   * a space.
    *
    * **[Permissions](https://confluence.atlassian.com/x/_AozKw) required**: 'View' permission for the space to view
-   * space templates and permission to access the Confluence site ('Can use' global permission) to view global templates.
+   * space templates and permission to access the Confluence site ('Can use' global permission) to view global
+   * templates.
    */
   async getContentTemplates<T = Models.ContentTemplateArray>(
     parameters?: Parameters.GetContentTemplates,
@@ -179,7 +183,8 @@ export class Template {
    * the template is in, the body of the template, and more.
    *
    * **[Permissions](https://confluence.atlassian.com/x/_AozKw) required**: 'View' permission for the space to view
-   * space templates and permission to access the Confluence site ('Can use' global permission) to view global templates.
+   * space templates and permission to access the Confluence site ('Can use' global permission) to view global
+   * templates.
    */
   async getContentTemplate<T = Models.ContentTemplate>(
     parameters: Parameters.GetContentTemplate,
@@ -190,7 +195,8 @@ export class Template {
    * the template is in, the body of the template, and more.
    *
    * **[Permissions](https://confluence.atlassian.com/x/_AozKw) required**: 'View' permission for the space to view
-   * space templates and permission to access the Confluence site ('Can use' global permission) to view global templates.
+   * space templates and permission to access the Confluence site ('Can use' global permission) to view global
+   * templates.
    */
   async getContentTemplate<T = Models.ContentTemplate>(
     parameters: Parameters.GetContentTemplate,
@@ -214,7 +220,8 @@ export class Template {
    * - If the template is a content template, it is deleted.
    * - If the template is a modified space-level blueprint template, it reverts to the template inherited from the
    *   global-level blueprint template.
-   * - If the template is a modified global-level blueprint template, it reverts to the default global-level blueprint template.
+   * - If the template is a modified global-level blueprint template, it reverts to the default global-level blueprint
+   *   template.
    *
    * Note, unmodified blueprint templates cannot be deleted.
    *
@@ -228,7 +235,8 @@ export class Template {
    * - If the template is a content template, it is deleted.
    * - If the template is a modified space-level blueprint template, it reverts to the template inherited from the
    *   global-level blueprint template.
-   * - If the template is a modified global-level blueprint template, it reverts to the default global-level blueprint template.
+   * - If the template is a modified global-level blueprint template, it reverts to the default global-level blueprint
+   *   template.
    *
    * Note, unmodified blueprint templates cannot be deleted.
    *

package/src/clients/baseClient.ts

@@ -74,7 +74,9 @@ export class BaseClient implements Client {
       ...this.config.baseRequestConfig,
       baseURL: `${this.config.host}${this.urlSuffix}`,
       headers: this.removeUndefinedProperties({
-        [ATLASSIAN_TOKEN_CHECK_FLAG]: this.config.noCheckAtlassianToken ? ATLASSIAN_TOKEN_CHECK_NOCHECK_VALUE : undefined,
+        [ATLASSIAN_TOKEN_CHECK_FLAG]: this.config.noCheckAtlassianToken
+          ? ATLASSIAN_TOKEN_CHECK_NOCHECK_VALUE
+          : undefined,
         ...this.config.baseRequestConfig?.headers,
       }),
     });
@@ -83,15 +85,8 @@ export class BaseClient implements Client {
   }
 
   async sendRequest<T>(requestConfig: RequestConfig, callback: never, telemetryData?: any): Promise<T>;
-  async sendRequest<T>(
-    requestConfig: RequestConfig,
-    callback: Callback<T>,
-    telemetryData?: any,
-  ): Promise<void>;
-  async sendRequest<T>(
-    requestConfig: RequestConfig,
-    callback: Callback<T> | never,
-  ): Promise<void | T> {
+  async sendRequest<T>(requestConfig: RequestConfig, callback: Callback<T>, telemetryData?: any): Promise<void>;
+  async sendRequest<T>(requestConfig: RequestConfig, callback: Callback<T> | never): Promise<void | T> {
     try {
       const modifiedRequestConfig = {
         ...requestConfig,

package/src/clients/client.ts

@@ -3,9 +3,5 @@ import type { RequestConfig } from '../requestConfig';
 
 export interface Client {
   sendRequest<T>(requestConfig: RequestConfig, callback?: never, telemetryData?: any): Promise<T>;
-  sendRequest<T>(
-    requestConfig: RequestConfig,
-    callback?: Callback<T>,
-    telemetryData?: any,
-  ): Promise<void>;
+  sendRequest<T>(requestConfig: RequestConfig, callback?: Callback<T>, telemetryData?: any): Promise<void>;
 }

package/src/clients/confluenceClient.ts

@@ -13,6 +13,7 @@ import {
   ContentPermissions,
   ContentProperties,
   ContentRestrictions,
+  ContentStates,
   ContentVersions,
   ContentWatches,
   DynamicModules,
@@ -47,6 +48,7 @@ export class ConfluenceClient extends BaseClient {
   contentPermissions = new ContentPermissions(this);
   contentProperties = new ContentProperties(this);
   contentRestrictions = new ContentRestrictions(this);
+  contentStates = new ContentStates(this);
   contentVersions = new ContentVersions(this);
   contentWatches = new ContentWatches(this);
   dynamicModules = new DynamicModules(this);

package/src/clients/serverClient.ts

@@ -1,14 +1,5 @@
 import { BaseClient } from './baseClient';
-import {
-  Audit,
-  Content,
-  ContentBody,
-  Group,
-  LongTask,
-  Search,
-  Space,
-  User,
-} from '../server';
+import { Audit, Content, ContentBody, Group, LongTask, Search, Space, User } from '../server';
 
 export class ServerClient extends BaseClient {
   urlSuffix = '/';

package/src/server/audit.ts

@@ -34,7 +34,7 @@ export class Audit {
       },
     };
 
-    return this.client.sendRequest(config, callback, { methodName: 'server.getAuditRecords' });
+    return this.client.sendRequest(config, callback);
   }
 
   /** Creates a record in the audit log. */
@@ -68,7 +68,7 @@ export class Audit {
       },
     };
 
-    return this.client.sendRequest(config, callback, { methodName: 'server.createAuditRecord' });
+    return this.client.sendRequest(config, callback);
   }
 
   /** Exports audit records as a CSV file or ZIP file. */
@@ -93,7 +93,7 @@ export class Audit {
       },
     };
 
-    return this.client.sendRequest(config, callback, { methodName: 'server.exportAuditRecords' });
+    return this.client.sendRequest(config, callback);
   }
 
   /** Fetches the current retention periodResponses */
@@ -106,7 +106,7 @@ export class Audit {
       method: 'GET',
     };
 
-    return this.client.sendRequest(config, callback, { methodName: 'server.getRetentionPeriod' });
+    return this.client.sendRequest(config, callback);
   }
 
   /** Set the retention period to a new value. Can throw ServiceException if the retention period is too long */
@@ -132,7 +132,7 @@ export class Audit {
       },
     };
 
-    return this.client.sendRequest(config, callback, { methodName: 'server.setRetentionPeriod' });
+    return this.client.sendRequest(config, callback);
   }
 
   /** Fetch a paginated list of AuditRecord instances dating back to a certain time */
@@ -161,6 +161,6 @@ export class Audit {
       },
     };
 
-    return this.client.sendRequest(config, callback, { methodName: 'server.getAuditRecordsForTimePeriod' });
+    return this.client.sendRequest(config, callback);
   }
 }