confluence.js 1.6.2 → 1.7.0

package/.prettierrc

@@ -1,5 +1,10 @@
 {
-  "plugins": [
-    "prettier-plugin-jsdoc"
-  ]
+  "arrowParens": "avoid",
+  "endOfLine": "lf",
+  "plugins": ["prettier-plugin-jsdoc"],
+  "printWidth": 120,
+  "singleQuote": true,
+  "tabWidth": 2,
+  "trailingComma": "all",
+  "useTabs": false
 }

package/CHANGELOG.md

@@ -1,5 +1,13 @@
 # Changelog
 
+### 1.7.0
+
+- `apiPrefix` added to code for allowing to use custom API prefix for all clients. Thanks to [Petr Plenkov](https://github.com/ThePlenkov) for pull request.
+
+### 1.6.3
+
+- `atlas_doc_format` added to some models. Thanks to [Andrew McClenaghan](https://github.com/andymac4182) for pull request.
+
 ### 1.6.2
 
 - Badge fixed

package/README.md

@@ -25,6 +25,7 @@ Usability, consistency, and performance are key focuses of confluence.js, and it
     - [JWT](#jwt)
     - [Personal access token](#personal-access-token)
   - [Your first request and using algorithm](#your-first-request-and-using-algorithm)
+  - [`apiPrefix` config parameter](#apiprefix-config-parameter)
 - [Decreasing Webpack bundle size](#decreasing-webpack-bundle-size)
 - [Take a look at our other products](#take-a-look-at-our-other-products)
 - [License](#license)
@@ -271,6 +272,21 @@ The name of the methods is the name of the endpoint in the group without spaces
 
 The parameters depend on the specific endpoint. For more information, [see here](https://mrrefactoring.github.io/confluence.js/).
 
+#### `apiPrefix` config parameter
+
+The `apiPrefix` parameter is used to specify the prefix for the API. For example, if you use the custom domain `https://mydomain.atlassian.net/api` for API.
+
+Example of use:
+
+```typescript
+import { ConfluenceClient } from 'confluence.js';
+
+const client = new ConfluenceClient({
+  host: 'https://your-domain.atlassian.net',
+  apiPrefix: '/api',
+});
+```
+
 ## Decreasing Webpack bundle size
 
 If you use Webpack and need to reduce the size of the assembly, you can create your client with only the groups you use.

package/out/api/models/addContentRestriction.d.ts

@@ -6,18 +6,23 @@ export interface AddContentRestriction {
      * this object.
      */
     restrictions: {
-        /** The users that the restrictions will be applied to. This array must have at least one item, otherwise it should be omitted. */
+        /**
+         * The users that the restrictions will be applied to. This array must have at least one item, otherwise it should
+         * be omitted.
+         */
         user?: {
             /** Set to 'known'. */
             type: string;
             /**
              * This property is no longer available and will be removed from the documentation soon. Use `accountId` instead.
-             * See the [deprecation notice](/cloud/confluence/deprecation-notice-user-privacy-api-migration-guide/) for details.
+             * See the [deprecation notice](/cloud/confluence/deprecation-notice-user-privacy-api-migration-guide/) for
+             * details.
              */
             username?: string;
             /**
              * This property is no longer available and will be removed from the documentation soon. Use `accountId` instead.
-             * See the [deprecation notice](/cloud/confluence/deprecation-notice-user-privacy-api-migration-guide/) for details.
+             * See the [deprecation notice](/cloud/confluence/deprecation-notice-user-privacy-api-migration-guide/) for
+             * details.
              */
             userKey?: string;
             /**

package/out/api/models/appDescriptor.d.ts

@@ -8,7 +8,8 @@ export interface AppDescriptor {
     /**
      * The base url of the remote app, which is used for all communications back to the app instance.
      *
-     * The baseUrl must start with `https://` to ensure that all data is sent securely between our cloud instances and your app.
+     * The baseUrl must start with `https://` to ensure that all data is sent securely between our cloud instances and
+     * your app.
      *
      * Note: each app must have a unique baseUrl. If you would like to serve multiple apps from the same host, consider
      * adding a path prefix into the baseUrl.
@@ -23,7 +24,8 @@ export interface AppDescriptor {
      * app as a private version, and have a seamless transition for those beta customers (and existing customers) once the
      * major revision is launched.
      *
-     * Vendors can accomplish this by listing a new private version of their app, with a new descriptor hosted at a new URL.
+     * Vendors can accomplish this by listing a new private version of their app, with a new descriptor hosted at a new
+     * URL.
      *
      * They use the Atlassian Marketplace's access token facilities to share this version with customers (or for internal
      * use). When this version is ready to be taken live, it can be transitioned from private to public, and all customers
@@ -31,7 +33,8 @@ export interface AppDescriptor {
      *
      * It's important to note that this approach allows vendors to create new versions manually, despite the fact that in
      * the common case, the versions are automatically created. This has a few benefits-- for example, it gives vendors
-     * the ability to change their descriptor URL if they need to (the descriptor URL will be immutable for existing versions).
+     * the ability to change their descriptor URL if they need to (the descriptor URL will be immutable for existing
+     * versions).
      */
     apiVersion?: number;
     /**

package/out/api/models/asyncContentBody.d.ts

@@ -7,8 +7,8 @@ export interface AsyncContentBody {
     renderTaskId?: string;
     error?: string;
     /**
-     * Rerunning is reserved for when the job is working, but there is a previous run's value in the cache. You may
-     * choose to continue polling, or use the cached value.
+     * Rerunning is reserved for when the job is working, but there is a previous run's value in the cache. You may choose
+     * to continue polling, or use the cached value.
      */
     status?: string;
     embeddedContent?: EmbeddedContent[];

package/out/api/models/attachment.d.ts

@@ -13,6 +13,7 @@ export interface Attachment {
         comment: string;
         mediaTypeDescription: string;
         fileId: string;
+        collectionName?: string;
     };
     _expandable: {
         childTypes: string;

package/out/api/models/attachmentUpdate.d.ts

@@ -1,4 +1,4 @@
-/** @deprecated will be removed in second major version */
+/** @deprecated Will be removed in second major version */
 export interface AttachmentUpdate {
     /**
      * The attachment version. Set this to the current version number of the attachment. Note, the version number only

package/out/api/models/auditRecordCreate.d.ts

@@ -21,12 +21,16 @@ export interface AuditRecordCreate {
     remoteAddress: string;
     /**
      * The creation date-time of the audit record, as a timestamp. This is converted to a date-time display in the
-     * Confluence UI. If the `creationDate` is not specified, then it will be set to the timestamp for the current date-time.
+     * Confluence UI. If the `creationDate` is not specified, then it will be set to the timestamp for the current
+     * date-time.
      */
     creationDate?: number;
     /** The summary of the event, which is displayed in the 'Change' column on the audit log in the Confluence UI. */
     summary?: string;
-    /** A long description of the event, which is displayed in the 'Description' field on the audit log in the Confluence UI. */
+    /**
+     * A long description of the event, which is displayed in the 'Description' field on the audit log in the Confluence
+     * UI.
+     */
     description?: string;
     /** The category of the event, which is displayed in the 'Event type' column on the audit log in the Confluence UI. */
     category?: string;

package/out/api/models/content.d.ts

@@ -30,6 +30,7 @@ export interface Content {
         storage?: ContentBody;
         editor2?: ContentBody;
         anonymous_export_view?: ContentBody;
+        atlas_doc_format?: ContentBody;
         _expandable: {
             editor?: string;
             view?: string;
@@ -38,6 +39,7 @@ export interface Content {
             storage?: string;
             editor2?: string;
             anonymous_export_view?: string;
+            atlas_doc_format?: string;
         };
     };
     restrictions?: {

package/out/api/models/contentBlueprintDraft.d.ts

@@ -19,7 +19,8 @@ export interface ContentBlueprintDraft {
      * The new ancestor (i.e. parent page) for the content. If you have specified an ancestor, you must also specify a
      * `space` property in the request body for the space that the ancestor is in.
      *
-     * Note, if you specify more than one ancestor, the last ID in the array will be selected as the parent page for the content.
+     * Note, if you specify more than one ancestor, the last ID in the array will be selected as the parent page for the
+     * content.
      */
     ancestors?: {
         /** The content ID of the ancestor. */

package/out/api/models/contentCreate.d.ts

@@ -46,5 +46,6 @@ export interface ContentCreate {
         storage?: ContentBodyCreate;
         editor2?: ContentBodyCreate;
         anonymous_export_view?: ContentBodyCreate;
+        atlas_doc_format?: ContentBodyCreate;
     };
 }

package/out/api/models/contentRestrictionUpdate.d.ts

@@ -6,18 +6,23 @@ export interface ContentRestrictionUpdate {
      * this object.
      */
     restrictions: {
-        /** The users that the restrictions will be applied to. This array must have at least one item, otherwise it should be omitted. */
+        /**
+         * The users that the restrictions will be applied to. This array must have at least one item, otherwise it should
+         * be omitted.
+         */
         user?: {
             /** Set to 'known'. */
             type: string;
             /**
              * This property is no longer available and will be removed from the documentation soon. Use `accountId` instead.
-             * See the [deprecation notice](/cloud/confluence/deprecation-notice-user-privacy-api-migration-guide/) for details.
+             * See the [deprecation notice](/cloud/confluence/deprecation-notice-user-privacy-api-migration-guide/) for
+             * details.
              */
             username?: string;
             /**
              * This property is no longer available and will be removed from the documentation soon. Use `accountId` instead.
-             * See the [deprecation notice](/cloud/confluence/deprecation-notice-user-privacy-api-migration-guide/) for details.
+             * See the [deprecation notice](/cloud/confluence/deprecation-notice-user-privacy-api-migration-guide/) for
+             * details.
              */
             userKey?: string;
             /**

package/out/api/models/contentTemplateUpdate.d.ts

@@ -13,7 +13,10 @@ export interface ContentTemplateUpdate {
     description?: string;
     /** Labels for the template. */
     labels?: Label[];
-    /** The key for the space of the template. Required if the template is a space template. Set this to the current `space.key`. */
+    /**
+     * The key for the space of the template. Required if the template is a space template. Set this to the current
+     * `space.key`.
+     */
     space?: {
         key: string;
     };

package/out/api/models/contentUpdate.d.ts

@@ -37,5 +37,6 @@ export interface ContentUpdate {
         storage?: ContentBodyCreateStorage;
         editor2?: ContentBodyCreate;
         anonymous_export_view?: ContentBodyCreate;
+        atlas_doc_format?: ContentBodyCreate;
     };
 }

package/out/api/models/labeledContentType.js

@@ -7,5 +7,5 @@ var LabeledContentType;
     LabeledContentType["Blogpost"] = "blogpost";
     LabeledContentType["Attachment"] = "attachment";
     LabeledContentType["PageTemplate"] = "page_template";
-})(LabeledContentType = exports.LabeledContentType || (exports.LabeledContentType = {}));
+})(LabeledContentType || (exports.LabeledContentType = LabeledContentType = {}));
 //# sourceMappingURL=labeledContentType.js.map

package/out/api/models/labeledContentType.js.map

@@ -1 +1 @@
-{"version":3,"file":"labeledContentType.js","sourceRoot":"","sources":["../../../src/api/models/labeledContentType.ts"],"names":[],"mappings":";;;AAAA,IAAY,kBAKX;AALD,WAAY,kBAAkB;IAC5B,mCAAa,CAAA;IACb,2CAAqB,CAAA;IACrB,+CAAyB,CAAA;IACzB,oDAA8B,CAAA;AAChC,CAAC,EALW,kBAAkB,GAAlB,0BAAkB,KAAlB,0BAAkB,QAK7B"}
+{"version":3,"file":"labeledContentType.js","sourceRoot":"","sources":["../../../src/api/models/labeledContentType.ts"],"names":[],"mappings":";;;AAAA,IAAY,kBAKX;AALD,WAAY,kBAAkB;IAC5B,mCAAa,CAAA;IACb,2CAAqB,CAAA;IACrB,+CAAyB,CAAA;IACzB,oDAA8B,CAAA;AAChC,CAAC,EALW,kBAAkB,kCAAlB,kBAAkB,QAK7B"}

package/out/api/models/lifecycle.d.ts

@@ -18,7 +18,10 @@ export interface Lifecycle {
      * this situation is tracked by [AC-1528](https://ecosystem.atlassian.net/browse/AC-1528) in the Connect backlog.
      */
     clientKey?: string;
-    /** @deprecated This is the public key for this Atlassian product instance. This field is deprecated and should not be used. */
+    /**
+     * @deprecated This is the public key for this Atlassian product instance. This field is deprecated and should not be
+     *   used.
+     */
     publicKey?: string;
     /**
      * The account ID for identifying users in the `sub` claim sent in JWT during calls. This is the user associated with
@@ -27,7 +30,8 @@ export interface Lifecycle {
     accountId?: string;
     /**
      * Use this string to sign outgoing JWT tokens and validate incoming JWT tokens. Optional: and may not be present on
-     * non-JWT app installations, and is only sent on the `installed` event. All instances of your app use the same shared secret.
+     * non-JWT app installations, and is only sent on the `installed` event. All instances of your app use the same shared
+     * secret.
      */
     sharedSecret?: string;
     /** @deprecated This is a string representation of the host product's version. Generally you should not need it. */

package/out/api/parameters/addLabelsToContent.d.ts

@@ -3,7 +3,8 @@ export interface AddLabelsToContent {
     /** The ID of the content that will have labels added to it. */
     id: string;
     /**
-     * If true, return the new 400 error response on invalid requests. Otherwise return a server error response on invalid requests.
+     * If true, return the new 400 error response on invalid requests. Otherwise return a server error response on invalid
+     * requests.
      *
      * Why does this parameter exist? Previously, our API was returning a 500 status code with a difficult-to-consume
      * response body. We've fixed the response to have a 400 status code and a more useful body. This parameter enables a

package/out/api/parameters/createContent.d.ts

@@ -58,7 +58,10 @@ export declare namespace CreateContent {
         UpdateGroupRestriction = "restrictions.update.restrictions.group",
         /** Returns the history of the content, including the date it was created. */
         History = "history",
-        /** Returns information about the most recent update of the content, including who updated it and when it was updated. */
+        /**
+         * Returns information about the most recent update of the content, including who updated it and when it was
+         * updated.
+         */
         LastUpdated = "history.lastUpdated",
         /** Returns information about the update prior to the current content update. */
         PreviousVersion = "history.previousVersion",
@@ -68,9 +71,15 @@ export declare namespace CreateContent {
         NextVersion = "history.nextVersion",
         /** Returns the parent page, if the content is a page. */
         Ancestors = "ancestors",
-        /** Returns the body of the content in different formats, including the editor format, view format, and export format. */
+        /**
+         * Returns the body of the content in different formats, including the editor format, view format, and export
+         * format.
+         */
         Body = "body",
-        /** Returns information about the most recent update of the content, including who updated it and when it was updated. */
+        /**
+         * Returns information about the most recent update of the content, including who updated it and when it was
+         * updated.
+         */
         Version = "version",
         /** Returns pages that are descendants at any level below the content. */
         PageDescendant = "descendants.page",

package/out/api/parameters/createContent.js

@@ -56,7 +56,10 @@ var CreateContent;
         Expand["UpdateGroupRestriction"] = "restrictions.update.restrictions.group";
         /** Returns the history of the content, including the date it was created. */
         Expand["History"] = "history";
-        /** Returns information about the most recent update of the content, including who updated it and when it was updated. */
+        /**
+         * Returns information about the most recent update of the content, including who updated it and when it was
+         * updated.
+         */
         Expand["LastUpdated"] = "history.lastUpdated";
         /** Returns information about the update prior to the current content update. */
         Expand["PreviousVersion"] = "history.previousVersion";
@@ -66,9 +69,15 @@ var CreateContent;
         Expand["NextVersion"] = "history.nextVersion";
         /** Returns the parent page, if the content is a page. */
         Expand["Ancestors"] = "ancestors";
-        /** Returns the body of the content in different formats, including the editor format, view format, and export format. */
+        /**
+         * Returns the body of the content in different formats, including the editor format, view format, and export
+         * format.
+         */
         Expand["Body"] = "body";
-        /** Returns information about the most recent update of the content, including who updated it and when it was updated. */
+        /**
+         * Returns information about the most recent update of the content, including who updated it and when it was
+         * updated.
+         */
         Expand["Version"] = "version";
         /** Returns pages that are descendants at any level below the content. */
         Expand["PageDescendant"] = "descendants.page";
@@ -86,5 +95,5 @@ var CreateContent;
         /** Returns the resolution status of each comment. */
         Expand["Resolution"] = "extensions.resolution";
     })(Expand = CreateContent.Expand || (CreateContent.Expand = {}));
-})(CreateContent = exports.CreateContent || (exports.CreateContent = {}));
+})(CreateContent || (exports.CreateContent = CreateContent = {}));
 //# sourceMappingURL=createContent.js.map

package/out/api/parameters/createContent.js.map

@@ -1 +1 @@
-{"version":3,"file":"createContent.js","sourceRoot":"","sources":["../../../src/api/parameters/createContent.ts"],"names":[],"mappings":";;;AASA,IAAiB,aAAa,CAmF7B;AAnFD,WAAiB,aAAa;IAC5B,IAAY,MAiFX;IAjFD,WAAY,MAAM;QAChB;;;WAGG;QACH,0CAAgC,CAAA;QAChC,mDAAmD;QACnD,uDAA6C,CAAA;QAC7C,gDAAgD;QAChD,iDAAuC,CAAA;QACvC,mDAAmD;QACnD,2CAAiC,CAAA;QACjC;;;WAGG;QACH,iCAAuB,CAAA;QACvB;;;WAGG;QACH,sDAA4C,CAAA;QAC5C,iFAAiF;QACjF,oDAA0C,CAAA;QAC1C,8DAA8D;QAC9D,4CAAkC,CAAA;QAClC,+CAA+C;QAC/C,gDAAsC,CAAA;QACtC,uFAAuF;QACvF,mCAAyB,CAAA;QACzB,qFAAqF;QACrF,wCAA8B,CAAA;QAC9B,+CAA+C;QAC/C,oDAA0C,CAAA;QAC1C,2CAA2C;QAC3C,8CAAoC,CAAA;QACpC,kEAAkE;QAClE,qEAA2D,CAAA;QAC3D;;;WAGG;QACH,uEAA6D,CAAA;QAC7D,oEAAoE;QACpE,yEAA+D,CAAA;QAC/D;;;WAGG;QACH,2EAAiE,CAAA;QACjE,6EAA6E;QAC7E,6BAAmB,CAAA;QACnB,yHAAyH;QACzH,6CAAmC,CAAA;QACnC,gFAAgF;QAChF,qDAA2C,CAAA;QAC3C,oEAAoE;QACpE,+CAAqC,CAAA;QACrC,gFAAgF;QAChF,6CAAmC,CAAA;QACnC,yDAAyD;QACzD,iCAAuB,CAAA;QACvB,yHAAyH;QACzH,uBAAa,CAAA;QACb,yHAAyH;QACzH,6BAAmB,CAAA;QACnB,yEAAyE;QACzE,6CAAmC,CAAA;QACnC,8EAA8E;QAC9E,yDAA+C,CAAA;QAC/C,uEAAuE;QACvE,mDAAyC,CAAA;QACzC;;;WAGG;QACH,yBAAe,CAAA;QACf,kDAAkD;QAClD,0DAAgD,CAAA;QAChD,qDAAqD;QACrD,8CAAoC,CAAA;IACtC,CAAC,EAjFW,MAAM,GAAN,oBAAM,KAAN,oBAAM,QAiFjB;AACH,CAAC,EAnFgB,aAAa,GAAb,qBAAa,KAAb,qBAAa,QAmF7B"}
+{"version":3,"file":"createContent.js","sourceRoot":"","sources":["../../../src/api/parameters/createContent.ts"],"names":[],"mappings":";;;AASA,IAAiB,aAAa,CA4F7B;AA5FD,WAAiB,aAAa;IAC5B,IAAY,MA0FX;IA1FD,WAAY,MAAM;QAChB;;;WAGG;QACH,0CAAgC,CAAA;QAChC,mDAAmD;QACnD,uDAA6C,CAAA;QAC7C,gDAAgD;QAChD,iDAAuC,CAAA;QACvC,mDAAmD;QACnD,2CAAiC,CAAA;QACjC;;;WAGG;QACH,iCAAuB,CAAA;QACvB;;;WAGG;QACH,sDAA4C,CAAA;QAC5C,iFAAiF;QACjF,oDAA0C,CAAA;QAC1C,8DAA8D;QAC9D,4CAAkC,CAAA;QAClC,+CAA+C;QAC/C,gDAAsC,CAAA;QACtC,uFAAuF;QACvF,mCAAyB,CAAA;QACzB,qFAAqF;QACrF,wCAA8B,CAAA;QAC9B,+CAA+C;QAC/C,oDAA0C,CAAA;QAC1C,2CAA2C;QAC3C,8CAAoC,CAAA;QACpC,kEAAkE;QAClE,qEAA2D,CAAA;QAC3D;;;WAGG;QACH,uEAA6D,CAAA;QAC7D,oEAAoE;QACpE,yEAA+D,CAAA;QAC/D;;;WAGG;QACH,2EAAiE,CAAA;QACjE,6EAA6E;QAC7E,6BAAmB,CAAA;QACnB;;;WAGG;QACH,6CAAmC,CAAA;QACnC,gFAAgF;QAChF,qDAA2C,CAAA;QAC3C,oEAAoE;QACpE,+CAAqC,CAAA;QACrC,gFAAgF;QAChF,6CAAmC,CAAA;QACnC,yDAAyD;QACzD,iCAAuB,CAAA;QACvB;;;WAGG;QACH,uBAAa,CAAA;QACb;;;WAGG;QACH,6BAAmB,CAAA;QACnB,yEAAyE;QACzE,6CAAmC,CAAA;QACnC,8EAA8E;QAC9E,yDAA+C,CAAA;QAC/C,uEAAuE;QACvE,mDAAyC,CAAA;QACzC;;;WAGG;QACH,yBAAe,CAAA;QACf,kDAAkD;QAClD,0DAAgD,CAAA;QAChD,qDAAqD;QACrD,8CAAoC,CAAA;IACtC,CAAC,EA1FW,MAAM,GAAN,oBAAM,KAAN,oBAAM,QA0FjB;AACH,CAAC,EA5FgB,aAAa,6BAAb,aAAa,QA4F7B"}

package/out/api/parameters/createRelationship.d.ts

@@ -14,7 +14,10 @@ export interface CreateRelationship {
      *   - If `sourceType` is 'space', then specify the space key.
      */
     sourceKey: string;
-    /** The target entity type of the relationship. This must be 'space' or 'content', if the `relationName` is 'favourite'. */
+    /**
+     * The target entity type of the relationship. This must be 'space' or 'content', if the `relationName` is
+     * 'favourite'.
+     */
     targetType: string;
     /**
      * - The identifier for the target entity:

package/out/api/parameters/createUserProperty.d.ts

@@ -1,8 +1,8 @@
 import { UserPropertyCreate } from '../models';
 export interface CreateUserProperty extends UserPropertyCreate {
     /**
-     * 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/out/api/parameters/delete.d.ts

@@ -11,7 +11,10 @@ export interface Delete {
      *   - If `sourceType` is 'space', then specify the space key.
      */
     sourceKey: string;
-    /** The target entity type of the relationship. This must be 'space' or 'content', if the `relationName` is 'favourite'. */
+    /**
+     * The target entity type of the relationship. This must be 'space' or 'content', if the `relationName` is
+     * 'favourite'.
+     */
     targetType: string;
     /**
      * - The identifier for the target entity:

package/out/api/parameters/deleteRelationship.d.ts

@@ -11,7 +11,10 @@ export interface DeleteRelationship {
      *   - If `sourceType` is 'space', then specify the space key.
      */
     sourceKey: string;
-    /** The target entity type of the relationship. This must be 'space' or 'content', if the `relationName` is 'favourite'. */
+    /**
+     * The target entity type of the relationship. This must be 'space' or 'content', if the `relationName` is
+     * 'favourite'.
+     */
     targetType: string;
     /**
      * - The identifier for the target entity:
@@ -26,13 +29,13 @@ export interface DeleteRelationship {
     /** The status of the target. This parameter is only used when the `targetType` is 'content'. */
     targetStatus?: string;
     /**
-     * The version of the source. This parameter is only used when the `sourceType` is 'content' and the `sourceStatus`
-     * is 'historical'.
+     * The version of the source. This parameter is only used when the `sourceType` is 'content' and the `sourceStatus` is
+     * 'historical'.
      */
     sourceVersion?: number;
     /**
-     * The version of the target. This parameter is only used when the `targetType` is 'content' and the `targetStatus`
-     * is 'historical'.
+     * The version of the target. This parameter is only used when the `targetType` is 'content' and the `targetStatus` is
+     * 'historical'.
      */
     targetVersion?: number;
 }

package/out/api/parameters/deleteUserProperty.d.ts

@@ -1,7 +1,7 @@
 export interface DeleteUserProperty {
     /**
-     * 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/out/api/parameters/findSourcesForTarget.d.ts

@@ -15,7 +15,8 @@ export interface FindSourcesForTarget {
      * - If `targetType` is `user`, then specify either `current` (logged-in user), the user key of the user, or the account
      *   ID of the user. Note that the user key has been deprecated in favor of the account ID for this parameter. See the
      *   [migration
-     *   guide](https://developer.atlassian.com/cloud/confluence/deprecation-notice-user-privacy-api-migration-guide/) for details.
+     *   guide](https://developer.atlassian.com/cloud/confluence/deprecation-notice-user-privacy-api-migration-guide/) for
+     *   details.
      * - If `targetType` is 'content', then specify the content ID.
      * - If `targetType` is 'space', then specify the space key.
      */

package/out/api/parameters/findTargetFromSource.d.ts

@@ -13,7 +13,8 @@ export interface FindTargetFromSource {
      * - If `sourceType` is `user`, then specify either `current` (logged-in user), the user key of the user, or the account
      *   ID of the user. Note that the user key has been deprecated in favor of the account ID for this parameter. See the
      *   [migration
-     *   guide](https://developer.atlassian.com/cloud/confluence/deprecation-notice-user-privacy-api-migration-guide/) for details.
+     *   guide](https://developer.atlassian.com/cloud/confluence/deprecation-notice-user-privacy-api-migration-guide/) for
+     *   details.
      * - If `sourceType` is 'content', then specify the content ID.
      * - If `sourceType` is 'space', then specify the space key.
      */

package/out/api/parameters/getAttachments.d.ts

@@ -65,7 +65,10 @@ export declare namespace GetAttachments {
         UpdateGroupRestriction = "restrictions.update.restrictions.group",
         /** Returns the history of the content, including the date it was created. */
         History = "history",
-        /** Returns information about the most recent update of the content, including who updated it and when it was updated. */
+        /**
+         * Returns information about the most recent update of the content, including who updated it and when it was
+         * updated.
+         */
         LastUpdated = "history.lastUpdated",
         /** Returns information about the update prior to the current content update. */
         PreviousVersion = "history.previousVersion",
@@ -75,9 +78,15 @@ export declare namespace GetAttachments {
         NextVersion = "history.nextVersion",
         /** Returns the parent page, if the content is a page. */
         Ancestors = "ancestors",
-        /** Returns the body of the content in different formats, including the editor format, view format, and export format. */
+        /**
+         * Returns the body of the content in different formats, including the editor format, view format, and export
+         * format.
+         */
         Body = "body",
-        /** Returns information about the most recent update of the content, including who updated it and when it was updated. */
+        /**
+         * Returns information about the most recent update of the content, including who updated it and when it was
+         * updated.
+         */
         Version = "version",
         /** Returns pages that are descendants at any level below the content. */
         PageDescendant = "descendants.page",

package/out/api/parameters/getAttachments.js

@@ -56,7 +56,10 @@ var GetAttachments;
         Expand["UpdateGroupRestriction"] = "restrictions.update.restrictions.group";
         /** Returns the history of the content, including the date it was created. */
         Expand["History"] = "history";
-        /** Returns information about the most recent update of the content, including who updated it and when it was updated. */
+        /**
+         * Returns information about the most recent update of the content, including who updated it and when it was
+         * updated.
+         */
         Expand["LastUpdated"] = "history.lastUpdated";
         /** Returns information about the update prior to the current content update. */
         Expand["PreviousVersion"] = "history.previousVersion";
@@ -66,9 +69,15 @@ var GetAttachments;
         Expand["NextVersion"] = "history.nextVersion";
         /** Returns the parent page, if the content is a page. */
         Expand["Ancestors"] = "ancestors";
-        /** Returns the body of the content in different formats, including the editor format, view format, and export format. */
+        /**
+         * Returns the body of the content in different formats, including the editor format, view format, and export
+         * format.
+         */
         Expand["Body"] = "body";
-        /** Returns information about the most recent update of the content, including who updated it and when it was updated. */
+        /**
+         * Returns information about the most recent update of the content, including who updated it and when it was
+         * updated.
+         */
         Expand["Version"] = "version";
         /** Returns pages that are descendants at any level below the content. */
         Expand["PageDescendant"] = "descendants.page";
@@ -86,5 +95,5 @@ var GetAttachments;
         /** Returns the resolution status of each comment. */
         Expand["Resolution"] = "extensions.resolution";
     })(Expand = GetAttachments.Expand || (GetAttachments.Expand = {}));
-})(GetAttachments = exports.GetAttachments || (exports.GetAttachments = {}));
+})(GetAttachments || (exports.GetAttachments = GetAttachments = {}));
 //# sourceMappingURL=getAttachments.js.map

package/out/api/parameters/getAttachments.js.map

@@ -1 +1 @@
-{"version":3,"file":"getAttachments.js","sourceRoot":"","sources":["../../../src/api/parameters/getAttachments.ts"],"names":[],"mappings":";;;AAqFA,IAAiB,cAAc,CAmF9B;AAnFD,WAAiB,cAAc;IAC7B,IAAY,MAiFX;IAjFD,WAAY,MAAM;QAChB;;;WAGG;QACH,0CAAgC,CAAA;QAChC,mDAAmD;QACnD,uDAA6C,CAAA;QAC7C,gDAAgD;QAChD,iDAAuC,CAAA;QACvC,mDAAmD;QACnD,2CAAiC,CAAA;QACjC;;;WAGG;QACH,iCAAuB,CAAA;QACvB;;;WAGG;QACH,sDAA4C,CAAA;QAC5C,iFAAiF;QACjF,oDAA0C,CAAA;QAC1C,8DAA8D;QAC9D,4CAAkC,CAAA;QAClC,+CAA+C;QAC/C,gDAAsC,CAAA;QACtC,uFAAuF;QACvF,mCAAyB,CAAA;QACzB,qFAAqF;QACrF,wCAA8B,CAAA;QAC9B,+CAA+C;QAC/C,oDAA0C,CAAA;QAC1C,2CAA2C;QAC3C,8CAAoC,CAAA;QACpC,kEAAkE;QAClE,qEAA2D,CAAA;QAC3D;;;WAGG;QACH,uEAA6D,CAAA;QAC7D,oEAAoE;QACpE,yEAA+D,CAAA;QAC/D;;;WAGG;QACH,2EAAiE,CAAA;QACjE,6EAA6E;QAC7E,6BAAmB,CAAA;QACnB,yHAAyH;QACzH,6CAAmC,CAAA;QACnC,gFAAgF;QAChF,qDAA2C,CAAA;QAC3C,oEAAoE;QACpE,+CAAqC,CAAA;QACrC,gFAAgF;QAChF,6CAAmC,CAAA;QACnC,yDAAyD;QACzD,iCAAuB,CAAA;QACvB,yHAAyH;QACzH,uBAAa,CAAA;QACb,yHAAyH;QACzH,6BAAmB,CAAA;QACnB,yEAAyE;QACzE,6CAAmC,CAAA;QACnC,8EAA8E;QAC9E,yDAA+C,CAAA;QAC/C,uEAAuE;QACvE,mDAAyC,CAAA;QACzC;;;WAGG;QACH,yBAAe,CAAA;QACf,kDAAkD;QAClD,0DAAgD,CAAA;QAChD,qDAAqD;QACrD,8CAAoC,CAAA;IACtC,CAAC,EAjFW,MAAM,GAAN,qBAAM,KAAN,qBAAM,QAiFjB;AACH,CAAC,EAnFgB,cAAc,GAAd,sBAAc,KAAd,sBAAc,QAmF9B"}
+{"version":3,"file":"getAttachments.js","sourceRoot":"","sources":["../../../src/api/parameters/getAttachments.ts"],"names":[],"mappings":";;;AAqFA,IAAiB,cAAc,CA4F9B;AA5FD,WAAiB,cAAc;IAC7B,IAAY,MA0FX;IA1FD,WAAY,MAAM;QAChB;;;WAGG;QACH,0CAAgC,CAAA;QAChC,mDAAmD;QACnD,uDAA6C,CAAA;QAC7C,gDAAgD;QAChD,iDAAuC,CAAA;QACvC,mDAAmD;QACnD,2CAAiC,CAAA;QACjC;;;WAGG;QACH,iCAAuB,CAAA;QACvB;;;WAGG;QACH,sDAA4C,CAAA;QAC5C,iFAAiF;QACjF,oDAA0C,CAAA;QAC1C,8DAA8D;QAC9D,4CAAkC,CAAA;QAClC,+CAA+C;QAC/C,gDAAsC,CAAA;QACtC,uFAAuF;QACvF,mCAAyB,CAAA;QACzB,qFAAqF;QACrF,wCAA8B,CAAA;QAC9B,+CAA+C;QAC/C,oDAA0C,CAAA;QAC1C,2CAA2C;QAC3C,8CAAoC,CAAA;QACpC,kEAAkE;QAClE,qEAA2D,CAAA;QAC3D;;;WAGG;QACH,uEAA6D,CAAA;QAC7D,oEAAoE;QACpE,yEAA+D,CAAA;QAC/D;;;WAGG;QACH,2EAAiE,CAAA;QACjE,6EAA6E;QAC7E,6BAAmB,CAAA;QACnB;;;WAGG;QACH,6CAAmC,CAAA;QACnC,gFAAgF;QAChF,qDAA2C,CAAA;QAC3C,oEAAoE;QACpE,+CAAqC,CAAA;QACrC,gFAAgF;QAChF,6CAAmC,CAAA;QACnC,yDAAyD;QACzD,iCAAuB,CAAA;QACvB;;;WAGG;QACH,uBAAa,CAAA;QACb;;;WAGG;QACH,6BAAmB,CAAA;QACnB,yEAAyE;QACzE,6CAAmC,CAAA;QACnC,8EAA8E;QAC9E,yDAA+C,CAAA;QAC/C,uEAAuE;QACvE,mDAAyC,CAAA;QACzC;;;WAGG;QACH,yBAAe,CAAA;QACf,kDAAkD;QAClD,0DAAgD,CAAA;QAChD,qDAAqD;QACrD,8CAAoC,CAAA;IACtC,CAAC,EA1FW,MAAM,GAAN,qBAAM,KAAN,qBAAM,QA0FjB;AACH,CAAC,EA5FgB,cAAc,8BAAd,cAAc,QA4F9B"}

package/out/api/parameters/getAvailableContentStates.d.ts

@@ -1,5 +1,5 @@
 export interface GetAvailableContentStates {
-    /**id of content to get available states for*/
+    /** Id of content to get available states for */
     id?: string;
     /** @deprecated Id of content to get available states for */
     contentId?: string;

package/out/api/parameters/getContent.d.ts

@@ -10,7 +10,10 @@ export interface GetContent {
      * Note, the `historical` status is currently not supported.
      */
     status?: string[];
-    /** The posting date of the blog post to be returned. Required for <code>blogpost</code> type. Format: <code>yyyy-mm-dd</code>. */
+    /**
+     * The posting date of the blog post to be returned. Required for <code>blogpost</code> type. Format:
+     * <code>yyyy-mm-dd</code>.
+     */
     postingDay?: string;
     /** A multi-value parameter indicating which properties of the content to expand. */
     expand?: string | string[] | GetContent.Expand | GetContent.Expand[];
@@ -82,7 +85,10 @@ export declare namespace GetContent {
         UpdateGroupRestriction = "restrictions.update.restrictions.group",
         /** Returns the history of the content, including the date it was created. */
         History = "history",
-        /** Returns information about the most recent update of the content, including who updated it and when it was updated. */
+        /**
+         * Returns information about the most recent update of the content, including who updated it and when it was
+         * updated.
+         */
         LastUpdated = "history.lastUpdated",
         /** Returns information about the update prior to the current content update. */
         PreviousVersion = "history.previousVersion",
@@ -92,9 +98,15 @@ export declare namespace GetContent {
         NextVersion = "history.nextVersion",
         /** Returns the parent page, if the content is a page. */
         Ancestors = "ancestors",
-        /** Returns the body of the content in different formats, including the editor format, view format, and export format. */
+        /**
+         * Returns the body of the content in different formats, including the editor format, view format, and export
+         * format.
+         */
         Body = "body",
-        /** Returns information about the most recent update of the content, including who updated it and when it was updated. */
+        /**
+         * Returns information about the most recent update of the content, including who updated it and when it was
+         * updated.
+         */
         Version = "version",
         /** Returns pages that are descendants at any level below the content. */
         PageDescendant = "descendants.page",