confluence.js 1.6.2 → 1.7.0

package/src/api/parameters/updateUserProperty.ts

@@ -2,8 +2,8 @@ import { UserPropertyUpdate } from '../models';
 
 export interface UpdateUserProperty extends UserPropertyUpdate {
   /**
-   * The account ID of the user. The accountId uniquely identifies the user across all Atlassian products. For
-   * example, 384093:32b4d9w0-f6a5-3535-11a3-9c8c88d10192
+   * The account ID of the user. The accountId uniquely identifies the user across all Atlassian products. For example,
+   * 384093:32b4d9w0-f6a5-3535-11a3-9c8c88d10192
    */
   userId: string;
   /** The key of the user property. */

package/src/api/relation.ts

@@ -20,7 +20,7 @@ export class Relation {
    */
   async findTargetFromSource<T = Models.RelationArray>(
     parameters: Parameters.FindTargetFromSource,
-    callback: Callback<T>
+    callback: Callback<T>,
   ): Promise<void>;
   /**
    * Returns all target entities that have a particular relationship to the source entity. Note, relationships are one
@@ -35,7 +35,7 @@ export class Relation {
    */
   async findTargetFromSource<T = Models.RelationArray>(
     parameters: Parameters.FindTargetFromSource,
-    callback?: never
+    callback?: never,
   ): Promise<T>;
   async findTargetFromSource<T = Models.RelationArray>(
     parameters: Parameters.FindTargetFromSource,
@@ -61,7 +61,7 @@ export class Relation {
   /** @deprecated Will be removed in the next major version. Use `getRelationship` instead. */
   async GetRelationship<T = Models.Relation>(
     parameters: Parameters.GetRelationship,
-    callback: Callback<T>
+    callback: Callback<T>,
   ): Promise<void>;
   /** @deprecated Will be removed in the next major version. Use `getRelationship` instead. */
   async GetRelationship<T = Models.Relation>(parameters: Parameters.GetRelationship, callback?: never): Promise<T>;
@@ -85,7 +85,7 @@ export class Relation {
    */
   async getRelationship<T = Models.Relation>(
     parameters: Parameters.GetRelationship,
-    callback: Callback<T>
+    callback: Callback<T>,
   ): Promise<void>;
   /**
    * Find whether a particular type of relationship exists from a source entity to a target entity. Note, relationships
@@ -130,7 +130,7 @@ export class Relation {
    */
   async createRelationship<T = Models.Relation>(
     parameters: Parameters.CreateRelationship,
-    callback: Callback<T>
+    callback: Callback<T>,
   ): Promise<void>;
   /**
    * Creates a relationship between two entities (user, space, content). The 'favourite' relationship is supported by
@@ -144,7 +144,7 @@ export class Relation {
    */
   async createRelationship<T = Models.Relation>(
     parameters: Parameters.CreateRelationship,
-    callback?: never
+    callback?: never,
   ): Promise<T>;
   async createRelationship<T = Models.Relation>(
     parameters: Parameters.CreateRelationship,
@@ -220,7 +220,7 @@ export class Relation {
    */
   async findSourcesForTarget<T = Models.RelationArray>(
     parameters: Parameters.FindSourcesForTarget,
-    callback: Callback<T>
+    callback: Callback<T>,
   ): Promise<void>;
   /**
    * Returns all target entities that have a particular relationship to the source entity. Note, relationships are one
@@ -236,7 +236,7 @@ export class Relation {
    */
   async findSourcesForTarget<T = Models.RelationArray>(
     parameters: Parameters.FindSourcesForTarget,
-    callback?: never
+    callback?: never,
   ): Promise<T>;
   async findSourcesForTarget<T = Models.RelationArray>(
     parameters: Parameters.FindSourcesForTarget,

package/src/api/search.ts

@@ -10,7 +10,7 @@ export class Search {
   /** @deprecated Will be removed in the next major version. Use `searchByCQL` instead. */
   async search<T = Models.SearchPageResponseSearchResult>(
     parameters: Parameters.Search,
-    callback: Callback<T>
+    callback: Callback<T>,
   ): Promise<void>;
   /** @deprecated Will be removed in the next major version. Use `searchByCQL` instead. */
   async search<T = Models.SearchPageResponseSearchResult>(parameters: Parameters.Search, callback?: never): Promise<T>;
@@ -34,7 +34,7 @@ export class Search {
    */
   async searchByCQL<T = Models.SearchPageResponseSearchResult>(
     parameters: Parameters.SearchByCQL,
-    callback: Callback<T>
+    callback: Callback<T>,
   ): Promise<void>;
   /**
    * Searches for content using the [Confluence Query Language
@@ -49,7 +49,7 @@ export class Search {
    */
   async searchByCQL<T = Models.SearchPageResponseSearchResult>(
     parameters: Parameters.SearchByCQL,
-    callback?: never
+    callback?: never,
   ): Promise<T>;
   async searchByCQL<T = Models.SearchPageResponseSearchResult>(
     parameters: Parameters.SearchByCQL,
@@ -80,12 +80,12 @@ export class Search {
   /** @deprecated Will be removed in the next major version. Use `searchUser` instead. */
   async userSearch<T = Models.SearchPageResponseSearchResult>(
     parameters: Parameters.UserSearch,
-    callback: Callback<T>
+    callback: Callback<T>,
   ): Promise<void>;
   /** @deprecated Will be removed in the next major version. Use `searchUser` instead. */
   async userSearch<T = Models.SearchPageResponseSearchResult>(
     parameters: Parameters.UserSearch,
-    callback?: never
+    callback?: never,
   ): Promise<T>;
   async userSearch<T = Models.SearchPageResponseSearchResult>(
     parameters: Parameters.UserSearch,
@@ -103,7 +103,7 @@ export class Search {
    */
   async searchUser<T = Models.SearchPageResponseSearchResult>(
     parameters: Parameters.SearchUser,
-    callback: Callback<T>
+    callback: Callback<T>,
   ): Promise<void>;
   /**
    * Searches for users using user-specific queries from the [Confluence Query Language
@@ -114,7 +114,7 @@ export class Search {
    */
   async searchUser<T = Models.SearchPageResponseSearchResult>(
     parameters: Parameters.SearchUser,
-    callback?: never
+    callback?: never,
   ): Promise<T>;
   async searchUser<T = Models.SearchPageResponseSearchResult>(
     parameters: Parameters.SearchUser,

package/src/api/settings.ts

@@ -18,7 +18,7 @@ export class Settings {
    */
   async getLookAndFeelSettings<T = Models.LookAndFeelSettings>(
     parameters: Parameters.GetLookAndFeelSettings | undefined,
-    callback: Callback<T>
+    callback: Callback<T>,
   ): Promise<void>;
   /**
    * Returns the look and feel settings for the site or a single space. This includes attributes such as the color
@@ -31,7 +31,7 @@ export class Settings {
    */
   async getLookAndFeelSettings<T = Models.LookAndFeelSettings>(
     parameters?: Parameters.GetLookAndFeelSettings,
-    callback?: never
+    callback?: never,
   ): Promise<T>;
   async getLookAndFeelSettings<T = Models.LookAndFeelSettings>(
     parameters?: Parameters.GetLookAndFeelSettings,
@@ -57,7 +57,7 @@ export class Settings {
    */
   async updateLookAndFeel<T = Models.LookAndFeelSelection>(
     parameters: Parameters.UpdateLookAndFeel | undefined,
-    callback: Callback<T>
+    callback: Callback<T>,
   ): Promise<void>;
   /**
    * Sets the look and feel settings to the default (global) settings, the custom settings, or the current theme's
@@ -68,7 +68,7 @@ export class Settings {
    */
   async updateLookAndFeel<T = Models.LookAndFeelSelection>(
     parameters?: Parameters.UpdateLookAndFeel,
-    callback?: never
+    callback?: never,
   ): Promise<T>;
   async updateLookAndFeel<T = Models.LookAndFeelSelection>(
     parameters?: Parameters.UpdateLookAndFeel,
@@ -97,7 +97,7 @@ export class Settings {
    */
   async updateLookAndFeelSettings<T = Models.LookAndFeel>(
     parameters: Parameters.UpdateLookAndFeelSettings | undefined,
-    callback: Callback<T>
+    callback: Callback<T>,
   ): Promise<void>;
   /**
    * Updates the look and feel settings for the site or for a single space. If custom settings exist, they are updated.
@@ -110,7 +110,7 @@ export class Settings {
    */
   async updateLookAndFeelSettings<T = Models.LookAndFeel>(
     parameters?: Parameters.UpdateLookAndFeelSettings,
-    callback?: never
+    callback?: never,
   ): Promise<T>;
   async updateLookAndFeelSettings<T = Models.LookAndFeel>(
     parameters?: Parameters.UpdateLookAndFeelSettings,
@@ -147,7 +147,7 @@ export class Settings {
    */
   async resetLookAndFeelSettings<T = void>(
     parameters: Parameters.ResetLookAndFeelSettings | undefined,
-    callback: Callback<T>
+    callback: Callback<T>,
   ): Promise<void>;
   /**
    * Resets the custom look and feel settings for the site or a single space. This changes the values of the custom
@@ -158,7 +158,7 @@ export class Settings {
    */
   async resetLookAndFeelSettings<T = void>(
     parameters?: Parameters.ResetLookAndFeelSettings,
-    callback?: never
+    callback?: never,
   ): Promise<T>;
   async resetLookAndFeelSettings<T = void>(
     parameters?: Parameters.ResetLookAndFeelSettings,
@@ -183,7 +183,7 @@ export class Settings {
    */
   async setLookAndFeelSettings<T = unknown>(
     parameters: Parameters.SetLookAndFeelSettings | undefined,
-    callback: Callback<T>
+    callback: Callback<T>,
   ): Promise<void>;
   /**
    * Sets the look and feel settings to either the default settings or the custom settings, for the site or a single
@@ -193,7 +193,7 @@ export class Settings {
    */
   async setLookAndFeelSettings<T = unknown>(
     parameters?: Parameters.SetLookAndFeelSettings,
-    callback?: never
+    callback?: never,
   ): Promise<T>;
   async setLookAndFeelSettings<T = unknown>(
     parameters?: Parameters.SetLookAndFeelSettings,
@@ -236,12 +236,12 @@ export class Settings {
   /** @deprecated Gets Content State settings for a space */
   async getContentStateSettings<T = Models.ContentStateSettings>(
     parameters: Parameters.GetContentStateSettings,
-    callback: Callback<T>
+    callback: Callback<T>,
   ): Promise<void>;
   /** @deprecated Gets Content State settings for a space */
   async getContentStateSettings<T = Models.ContentStateSettings>(
     parameters: Parameters.GetContentStateSettings,
-    callback?: never
+    callback?: never,
   ): Promise<T>;
   async getContentStateSettings<T = Models.ContentStateSettings>(
     parameters: Parameters.GetContentStateSettings,

package/src/api/space.ts

@@ -17,7 +17,7 @@ export class Space {
    */
   async getSpaces<T = Models.SpaceArray>(
     parameters: Parameters.GetSpaces | undefined,
-    callback: Callback<T>
+    callback: Callback<T>,
   ): Promise<void>;
   /**
    * Returns all spaces. The returned spaces are ordered alphabetically in ascending order by space key.
@@ -41,6 +41,7 @@ export class Space {
         favouriteUserKey: parameters?.favouriteUserKey,
         start: parameters?.start,
         limit: parameters?.limit,
+        expand: parameters?.expand,
       },
     };
 
@@ -54,7 +55,7 @@ export class Space {
    */
   async createSpace<T = Models.Space>(
     parameters: Parameters.CreateSpace | undefined,
-    callback: Callback<T>
+    callback: Callback<T>,
   ): Promise<void>;
   /**
    * Creates a new space. Note, currently you cannot set space labels when creating a space.
@@ -86,7 +87,7 @@ export class Space {
    */
   async createPrivateSpace<T = Models.Space>(
     parameters: Parameters.CreatePrivateSpace | undefined,
-    callback: Callback<T>
+    callback: Callback<T>,
   ): Promise<void>;
   /**
    * Creates a new space that is only visible to the creator. This method is the same as the [Create
@@ -211,7 +212,7 @@ export class Space {
    */
   async getContentForSpace<T = Models.ContentArray>(
     parameters: Parameters.GetContentForSpace,
-    callback: Callback<T>
+    callback: Callback<T>,
   ): Promise<void>;
   /**
    * Returns all content in a space. The returned content is grouped by type (pages then blogposts), then ordered by
@@ -222,7 +223,7 @@ export class Space {
    */
   async getContentForSpace<T = Models.ContentArray>(
     parameters: Parameters.GetContentForSpace,
-    callback?: never
+    callback?: never,
   ): Promise<T>;
   async getContentForSpace<T = Models.ContentArray>(
     parameters: Parameters.GetContentForSpace,
@@ -249,7 +250,7 @@ export class Space {
    */
   async getContentByTypeForSpace<T = Models.ContentArray>(
     parameters: Parameters.GetContentByTypeForSpace,
-    callback: Callback<T>
+    callback: Callback<T>,
   ): Promise<void>;
   /**
    * Returns all content of a given type, in a space. The returned content is ordered by content ID in ascending order.
@@ -259,7 +260,7 @@ export class Space {
    */
   async getContentByTypeForSpace<T = Models.ContentArray>(
     parameters: Parameters.GetContentByTypeForSpace,
-    callback?: never
+    callback?: never,
   ): Promise<T>;
   async getContentByTypeForSpace<T = Models.ContentArray>(
     parameters: Parameters.GetContentByTypeForSpace,

package/src/api/spacePermissions.ts

@@ -10,7 +10,7 @@ export class SpacePermissions {
   /** @deprecated Will be removed in the next major version. Use `addPermissionToSpace` instead. */
   async addPermission<T = Models.SpacePermissionV2>(
     parameters: Parameters.AddPermission,
-    callback: Callback<T>
+    callback: Callback<T>,
   ): Promise<void>;
   /** @deprecated Will be removed in the next major version. Use `addPermissionToSpace` instead. */
   async addPermission<T = Models.SpacePermissionV2>(parameters: Parameters.AddPermission, callback?: never): Promise<T>;
@@ -32,7 +32,7 @@ export class SpacePermissions {
    */
   async addPermissionToSpace<T = Models.SpacePermissionV2>(
     parameters: Parameters.AddPermissionToSpace,
-    callback: Callback<T>
+    callback: Callback<T>,
   ): Promise<void>;
   /**
    * Adds new permission to space.
@@ -45,7 +45,7 @@ export class SpacePermissions {
    */
   async addPermissionToSpace<T = Models.SpacePermissionV2>(
     parameters: Parameters.AddPermissionToSpace,
-    callback?: never
+    callback?: never,
   ): Promise<T>;
   async addPermissionToSpace<T = Models.SpacePermissionV2>(
     parameters: Parameters.AddPermissionToSpace,
@@ -75,7 +75,7 @@ export class SpacePermissions {
    */
   async addCustomContentPermissions<T = unknown>(
     parameters: Parameters.AddCustomContentPermissions,
-    callback: Callback<T>
+    callback: Callback<T>,
   ): Promise<void>;
   /**
    * Adds new custom content permission to space.
@@ -88,7 +88,7 @@ export class SpacePermissions {
    */
   async addCustomContentPermissions<T = unknown>(
     parameters: Parameters.AddCustomContentPermissions,
-    callback?: never
+    callback?: never,
   ): Promise<T>;
   async addCustomContentPermissions<T = unknown>(
     parameters: Parameters.AddCustomContentPermissions,

package/src/api/spaceProperties.ts

@@ -14,7 +14,7 @@ export class SpaceProperties {
    */
   async getSpaceProperties<T = Models.SpacePropertyArray>(
     parameters: Parameters.GetSpaceProperties,
-    callback: Callback<T>
+    callback: Callback<T>,
   ): Promise<void>;
   /**
    * Returns all properties for the given space. Space properties are a key-value storage associated with a space.
@@ -23,7 +23,7 @@ export class SpaceProperties {
    */
   async getSpaceProperties<T = Models.SpacePropertyArray>(
     parameters: Parameters.GetSpaceProperties,
-    callback?: never
+    callback?: never,
   ): Promise<T>;
   async getSpaceProperties<T = Models.SpacePropertyArray>(
     parameters: Parameters.GetSpaceProperties,
@@ -49,7 +49,7 @@ export class SpaceProperties {
    */
   async createSpaceProperty<T = Models.SpaceProperty>(
     parameters: Parameters.CreateSpaceProperty,
-    callback: Callback<T>
+    callback: Callback<T>,
   ): Promise<void>;
   /**
    * Creates a new space property.
@@ -58,7 +58,7 @@ export class SpaceProperties {
    */
   async createSpaceProperty<T = Models.SpaceProperty>(
     parameters: Parameters.CreateSpaceProperty,
-    callback?: never
+    callback?: never,
   ): Promise<T>;
   async createSpaceProperty<T = Models.SpaceProperty>(
     parameters: Parameters.CreateSpaceProperty,
@@ -84,7 +84,7 @@ export class SpaceProperties {
    */
   async getSpaceProperty<T = Models.SpaceProperty>(
     parameters: Parameters.GetSpaceProperty,
-    callback: Callback<T>
+    callback: Callback<T>,
   ): Promise<void>;
   /**
    * Returns a space property.
@@ -93,7 +93,7 @@ export class SpaceProperties {
    */
   async getSpaceProperty<T = Models.SpaceProperty>(
     parameters: Parameters.GetSpaceProperty,
-    callback?: never
+    callback?: never,
   ): Promise<T>;
   async getSpaceProperty<T = Models.SpaceProperty>(
     parameters: Parameters.GetSpaceProperty,
@@ -118,7 +118,7 @@ export class SpaceProperties {
    */
   async createSpacePropertyForKey<T = Models.SpaceProperty>(
     parameters: Parameters.CreateSpacePropertyForKey,
-    callback: Callback<T>
+    callback: Callback<T>,
   ): Promise<void>;
   /**
    * Creates a new space property. This is the same as `POST /api/space/{spaceKey}/property` but the key for the
@@ -128,7 +128,7 @@ export class SpaceProperties {
    */
   async createSpacePropertyForKey<T = Models.SpaceProperty>(
     parameters: Parameters.CreateSpacePropertyForKey,
-    callback?: never
+    callback?: never,
   ): Promise<T>;
   async createSpacePropertyForKey<T = Models.SpaceProperty>(
     parameters: Parameters.CreateSpacePropertyForKey,
@@ -152,7 +152,7 @@ export class SpaceProperties {
    */
   async updateSpaceProperty<T = Models.SpaceProperty>(
     parameters: Parameters.UpdateSpaceProperty,
-    callback: Callback<T>
+    callback: Callback<T>,
   ): Promise<void>;
   /**
    * Updates a space property. Note, you cannot update the key of a space property, only the value.
@@ -161,7 +161,7 @@ export class SpaceProperties {
    */
   async updateSpaceProperty<T = Models.SpaceProperty>(
     parameters: Parameters.UpdateSpaceProperty,
-    callback?: never
+    callback?: never,
   ): Promise<T>;
   async updateSpaceProperty<T = Models.SpaceProperty>(
     parameters: Parameters.UpdateSpaceProperty,

package/src/api/spaceSettings.ts

@@ -14,7 +14,7 @@ export class SpaceSettings {
    */
   async getSpaceSettings<T = Models.SpaceSettings>(
     parameters: Parameters.GetSpaceSettings,
-    callback: Callback<T>
+    callback: Callback<T>,
   ): Promise<void>;
   /**
    * Returns the settings of a space. Currently only the `routeOverrideEnabled` setting can be returned.
@@ -23,7 +23,7 @@ export class SpaceSettings {
    */
   async getSpaceSettings<T = Models.SpaceSettings>(
     parameters: Parameters.GetSpaceSettings,
-    callback?: never
+    callback?: never,
   ): Promise<T>;
   async getSpaceSettings<T = Models.SpaceSettings>(
     parameters: Parameters.GetSpaceSettings,
@@ -44,7 +44,7 @@ export class SpaceSettings {
    */
   async updateSpaceSettings<T = Models.SpaceSettings>(
     parameters: Parameters.UpdateSpaceSettings,
-    callback: Callback<T>
+    callback: Callback<T>,
   ): Promise<void>;
   /**
    * Updates the settings for a space. Currently only the `routeOverrideEnabled` setting can be updated.
@@ -53,7 +53,7 @@ export class SpaceSettings {
    */
   async updateSpaceSettings<T = Models.SpaceSettings>(
     parameters: Parameters.UpdateSpaceSettings,
-    callback?: never
+    callback?: never,
   ): Promise<T>;
   async updateSpaceSettings<T = Models.SpaceSettings>(
     parameters: Parameters.UpdateSpaceSettings,

package/src/api/template.ts

@@ -15,7 +15,7 @@ export class Template {
    */
   async createContentTemplate<T = Models.ContentTemplate>(
     parameters: Parameters.CreateContentTemplate | undefined,
-    callback: Callback<T>
+    callback: Callback<T>,
   ): Promise<void>;
   /**
    * Creates a new content template. Note, blueprint templates cannot be created via the REST API.
@@ -25,7 +25,7 @@ export class Template {
    */
   async createContentTemplate<T = Models.ContentTemplate>(
     parameters?: Parameters.CreateContentTemplate,
-    callback?: never
+    callback?: never,
   ): Promise<T>;
   async createContentTemplate<T = Models.ContentTemplate>(
     parameters?: Parameters.CreateContentTemplate,
@@ -55,7 +55,7 @@ export class Template {
    */
   async updateContentTemplate<T = Models.ContentTemplate>(
     parameters: Parameters.UpdateContentTemplate | undefined,
-    callback: Callback<T>
+    callback: Callback<T>,
   ): Promise<void>;
   /**
    * Updates a content template. Note, blueprint templates cannot be updated via the REST API.
@@ -65,7 +65,7 @@ export class Template {
    */
   async updateContentTemplate<T = Models.ContentTemplate>(
     parameters?: Parameters.UpdateContentTemplate,
-    callback?: never
+    callback?: never,
   ): Promise<T>;
   async updateContentTemplate<T = Models.ContentTemplate>(
     parameters?: Parameters.UpdateContentTemplate,
@@ -101,7 +101,7 @@ export class Template {
    */
   async getBlueprintTemplates<T = Models.BlueprintTemplateArray>(
     parameters: Parameters.GetBlueprintTemplates | undefined,
-    callback: Callback<T>
+    callback: Callback<T>,
   ): Promise<void>;
   /**
    * Returns all templates provided by blueprints. Use this method to retrieve all global blueprint templates or all
@@ -116,7 +116,7 @@ export class Template {
    */
   async getBlueprintTemplates<T = Models.BlueprintTemplateArray>(
     parameters?: Parameters.GetBlueprintTemplates,
-    callback?: never
+    callback?: never,
   ): Promise<T>;
   async getBlueprintTemplates<T = Models.BlueprintTemplateArray>(
     parameters?: Parameters.GetBlueprintTemplates,
@@ -146,7 +146,7 @@ export class Template {
    */
   async getContentTemplates<T = Models.ContentTemplateArray>(
     parameters: Parameters.GetContentTemplates | undefined,
-    callback: Callback<T>
+    callback: Callback<T>,
   ): Promise<void>;
   /**
    * Returns all content templates. Use this method to retrieve all global content templates or all content templates in
@@ -158,7 +158,7 @@ export class Template {
    */
   async getContentTemplates<T = Models.ContentTemplateArray>(
     parameters?: Parameters.GetContentTemplates,
-    callback?: never
+    callback?: never,
   ): Promise<T>;
   async getContentTemplates<T = Models.ContentTemplateArray>(
     parameters?: Parameters.GetContentTemplates,
@@ -188,7 +188,7 @@ export class Template {
    */
   async getContentTemplate<T = Models.ContentTemplate>(
     parameters: Parameters.GetContentTemplate,
-    callback: Callback<T>
+    callback: Callback<T>,
   ): Promise<void>;
   /**
    * Returns a content template. This includes information about template, like the name, the space or blueprint that
@@ -200,7 +200,7 @@ export class Template {
    */
   async getContentTemplate<T = Models.ContentTemplate>(
     parameters: Parameters.GetContentTemplate,
-    callback?: never
+    callback?: never,
   ): Promise<T>;
   async getContentTemplate<T = Models.ContentTemplate>(
     parameters: Parameters.GetContentTemplate,

package/src/api/themes.ts

@@ -14,7 +14,7 @@ export class Themes {
    */
   async getThemes<T = Models.ThemeArray>(
     parameters: Parameters.GetThemes | undefined,
-    callback: Callback<T>
+    callback: Callback<T>,
   ): Promise<void>;
   /**
    * Returns all themes, not including the default theme.