confluence.js 1.1.3 → 1.2.0

package/out/api/parameters/deleteRelationship.js

@@ -0,0 +1,2 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });

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

@@ -0,0 +1,11 @@
+export interface DownloadAttachment {
+    /** The ID of the content that the attachment is attached to. */
+    id: string;
+    /** The ID of the attachment to download. */
+    attachmentId: string;
+    /**
+     * The version of the attachment. If this parameter is absent, the redirect URI will download the latest version of
+     * the attachment.
+     */
+    version?: number;
+}

package/out/api/parameters/downloadAttachment.js

@@ -0,0 +1,2 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });

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

@@ -1,6 +1,8 @@
 export interface GetContentProperties {
     /** The ID of the content to be queried for its properties. */
     id: string;
+    /**The key of the content property.*/
+    key?: string[];
     /**
      * A multi-value parameter indicating which properties of the content to expand. By default, the `version` object is expanded.
      *

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

@@ -0,0 +1,101 @@
+export interface GetDescendantsOfType {
+    /** The ID of the content to be queried for its descendants. */
+    id: string;
+    /** The type of descendants to return. */
+    type: string | 'page' | 'comment' | 'attachment';
+    /**
+     * Filter the results to descendants upto a desired level of the content. Note, the maximum value supported is 100.
+     * root level of the content means immediate (level 1) descendants of the type requested. all represents returning all
+     * descendants of the type requested.
+     */
+    depth?: string;
+    /** The starting index of the returned content. */
+    start?: number;
+    /** The maximum number of content to return per page. Note, this may be restricted by fixed system limits. */
+    limit?: number;
+    expand?: string | string[] | GetDescendantsOfType.Expand | GetDescendantsOfType.Expand[];
+}
+export declare namespace GetDescendantsOfType {
+    enum Expand {
+        /**
+         * Returns whether the content has attachments, comments, or child pages. Use this if you only need to check whether
+         * the content has children of a particular type.
+         */
+        AllChildTypes = "childTypes.all",
+        /** Returns whether the content has attachments. */
+        AttachmentChildType = "childTypes.attachment",
+        /** Returns whether the content has comments. */
+        CommentChildType = "childTypes.comment",
+        /** Returns whether the content has child pages. */
+        PageChildType = "childTypes.page",
+        /**
+         * Returns the space that the content is in. This is the same as the information returned by [Get
+         * space](https://developer.atlassian.com/cloud/confluence/rest/api-group-content---attachments/).
+         */
+        Container = "container",
+        /**
+         * Returns information about the current user in relation to the content, including when they last viewed it,
+         * modified it, contributed to it, or added it as a favorite.
+         */
+        CurrentUserMetadata = "metadata.currentuser",
+        /** Returns content properties that have been set via the Confluence REST API. */
+        PropertiesMetadata = "metadata.properties",
+        /** Returns the labels that have been added to the content. */
+        LabelsMetadata = "metadata.labels",
+        /** This property is only used by Atlassian. */
+        FrontendMetadata = "metadata.frontend",
+        /** Returns the operations for the content, which are used when setting permissions. */
+        Operations = "operations",
+        /** Returns pages that are descendants at the level immediately below the content. */
+        PageChildren = "children.page",
+        /** Returns all attachments for the content. */
+        AttachmentChildren = "children.attachment",
+        /** Returns all comments on the content. */
+        CommentChildren = "children.comment",
+        /** Returns the users that have permission to read the content. */
+        ReadUserRestriction = "restrictions.read.restrictions.user",
+        /**
+         * Returns the groups that have permission to read the content. Note that this may return deleted groups, because
+         * deleting a group doesn't remove associated restrictions.
+         */
+        ReadGroupRestriction = "restrictions.read.restrictions.group",
+        /** Returns the users that have permission to update the content. */
+        UpdateUserRestriction = "restrictions.update.restrictions.user",
+        /**
+         * Returns the groups that have permission to update the content. Note that this may return deleted groups because
+         * deleting a group doesn't remove associated restrictions.
+         */
+        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. */
+        LastUpdated = "history.lastUpdated",
+        /** Returns information about the update prior to the current content update. */
+        PreviousVersion = "history.previousVersion",
+        /** Returns all of the users who have contributed to the content. */
+        Contributors = "history.contributors",
+        /** Returns information about the update after to the current content update. */
+        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. */
+        Body = "body",
+        /** 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",
+        /** Returns all attachments for the content, same as `children.attachment`. */
+        AttachmentDescendant = "descendants.attachment",
+        /** Returns all comments on the content, same as `children.comment`. */
+        CommentDescendant = "descendants.comment",
+        /**
+         * Returns the space that the content is in. This is the same as the information returned by [Get
+         * space](https://developer.atlassian.com/cloud/confluence/rest/api-group-content---attachments/).
+         */
+        Space = "space",
+        /** Returns inline comment-specific properties. */
+        InlineProperties = "extensions.inlineProperties",
+        /** Returns the resolution status of each comment. */
+        Resolution = "extensions.resolution"
+    }
+}

package/out/api/parameters/getDescendantsOfType.js

@@ -0,0 +1,89 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.GetDescendantsOfType = void 0;
+var GetDescendantsOfType;
+(function (GetDescendantsOfType) {
+    let Expand;
+    (function (Expand) {
+        /**
+         * Returns whether the content has attachments, comments, or child pages. Use this if you only need to check whether
+         * the content has children of a particular type.
+         */
+        Expand["AllChildTypes"] = "childTypes.all";
+        /** Returns whether the content has attachments. */
+        Expand["AttachmentChildType"] = "childTypes.attachment";
+        /** Returns whether the content has comments. */
+        Expand["CommentChildType"] = "childTypes.comment";
+        /** Returns whether the content has child pages. */
+        Expand["PageChildType"] = "childTypes.page";
+        /**
+         * Returns the space that the content is in. This is the same as the information returned by [Get
+         * space](https://developer.atlassian.com/cloud/confluence/rest/api-group-content---attachments/).
+         */
+        Expand["Container"] = "container";
+        /**
+         * Returns information about the current user in relation to the content, including when they last viewed it,
+         * modified it, contributed to it, or added it as a favorite.
+         */
+        Expand["CurrentUserMetadata"] = "metadata.currentuser";
+        /** Returns content properties that have been set via the Confluence REST API. */
+        Expand["PropertiesMetadata"] = "metadata.properties";
+        /** Returns the labels that have been added to the content. */
+        Expand["LabelsMetadata"] = "metadata.labels";
+        /** This property is only used by Atlassian. */
+        Expand["FrontendMetadata"] = "metadata.frontend";
+        /** Returns the operations for the content, which are used when setting permissions. */
+        Expand["Operations"] = "operations";
+        /** Returns pages that are descendants at the level immediately below the content. */
+        Expand["PageChildren"] = "children.page";
+        /** Returns all attachments for the content. */
+        Expand["AttachmentChildren"] = "children.attachment";
+        /** Returns all comments on the content. */
+        Expand["CommentChildren"] = "children.comment";
+        /** Returns the users that have permission to read the content. */
+        Expand["ReadUserRestriction"] = "restrictions.read.restrictions.user";
+        /**
+         * Returns the groups that have permission to read the content. Note that this may return deleted groups, because
+         * deleting a group doesn't remove associated restrictions.
+         */
+        Expand["ReadGroupRestriction"] = "restrictions.read.restrictions.group";
+        /** Returns the users that have permission to update the content. */
+        Expand["UpdateUserRestriction"] = "restrictions.update.restrictions.user";
+        /**
+         * Returns the groups that have permission to update the content. Note that this may return deleted groups because
+         * deleting a group doesn't remove associated restrictions.
+         */
+        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. */
+        Expand["LastUpdated"] = "history.lastUpdated";
+        /** Returns information about the update prior to the current content update. */
+        Expand["PreviousVersion"] = "history.previousVersion";
+        /** Returns all of the users who have contributed to the content. */
+        Expand["Contributors"] = "history.contributors";
+        /** Returns information about the update after to the current content update. */
+        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. */
+        Expand["Body"] = "body";
+        /** 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";
+        /** Returns all attachments for the content, same as `children.attachment`. */
+        Expand["AttachmentDescendant"] = "descendants.attachment";
+        /** Returns all comments on the content, same as `children.comment`. */
+        Expand["CommentDescendant"] = "descendants.comment";
+        /**
+         * Returns the space that the content is in. This is the same as the information returned by [Get
+         * space](https://developer.atlassian.com/cloud/confluence/rest/api-group-content---attachments/).
+         */
+        Expand["Space"] = "space";
+        /** Returns inline comment-specific properties. */
+        Expand["InlineProperties"] = "extensions.inlineProperties";
+        /** Returns the resolution status of each comment. */
+        Expand["Resolution"] = "extensions.resolution";
+    })(Expand = GetDescendantsOfType.Expand || (GetDescendantsOfType.Expand = {}));
+})(GetDescendantsOfType = exports.GetDescendantsOfType || (exports.GetDescendantsOfType = {}));

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

@@ -0,0 +1,4 @@
+export interface GetGroupByName {
+    /** The name of the group. This is the same as the group name shown in the Confluence administration console. */
+    groupName: string;
+}

package/out/api/parameters/getGroupByName.js

@@ -0,0 +1,2 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });

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

@@ -3,4 +3,6 @@ export interface GetGroups {
     start?: number;
     /** The maximum number of groups to return per page. Note, this may be restricted by fixed system limits. */
     limit?: number;
+    /** The group permission level for which to filter results. */
+    accessType?: string;
 }

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

@@ -0,0 +1,4 @@
+export interface GetTaskById {
+    /** Global ID of the inline task */
+    inlineTaskId: string;
+}

package/out/api/parameters/getTaskById.js

@@ -0,0 +1,2 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });

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

@@ -0,0 +1,6 @@
+export interface GetViewers {
+    /** The ID of the content to get the viewers for. */
+    contentId: string;
+    /** The number of views for the content since the date. */
+    fromDate?: string;
+}

package/out/api/parameters/getViewers.js

@@ -0,0 +1,2 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });

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

@@ -0,0 +1,6 @@
+export interface GetViews {
+    /** The ID of the content to get the views for. */
+    contentId: string;
+    /** The number of views for the content since the date. */
+    fromDate?: string;
+}

package/out/api/parameters/getViews.js

@@ -0,0 +1,2 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });

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

@@ -1,140 +1,155 @@
-export * from './getAuditRecords';
+export * from './addContentWatcher';
+export * from './addCustomContentPermissions';
+export * from './addGroupToContentRestriction';
+export * from './addGroupToContentRestrictionByGroupId';
+export * from './addLabelsToContent';
+export * from './addLabelWatcher';
+export * from './addPermission';
+export * from './addPermissionToSpace';
+export * from './addRestrictions';
+export * from './addSpaceWatcher';
+export * from './addUserToContentRestriction';
+export * from './addUserToGroup';
+export * from './addUserToGroupByGroupId';
+export * from './archivePages';
+export * from './checkContentPermission';
+export * from './convertContentBody';
+export * from './copyPage';
+export * from './copyPageHierarchy';
+export * from './createAttachments';
 export * from './createAuditRecord';
+export * from './createContent';
+export * from './createContentProperty';
+export * from './createContentPropertyForKey';
+export * from './createContentTemplate';
+export * from './createGroup';
+export * from './createOrUpdateAttachments';
+export * from './createPrivateSpace';
+export * from './createRelationship';
+export * from './createSpace';
+export * from './createSpaceProperty';
+export * from './createSpacePropertyForKey';
+export * from './delete';
+export * from './deleteContent';
+export * from './deleteContentProperty';
+export * from './deleteContentVersion';
+export * from './deleteRelationship';
+export * from './deleteRestrictions';
+export * from './deleteSpace';
+export * from './deleteSpaceProperty';
+export * from './descendantsOfType';
+export * from './downloadAttachment';
 export * from './exportAuditRecords';
-export * from './setRetentionPeriod';
+export * from './findSourcesForTarget';
+export * from './findTargetFromSource';
+export * from './getAllLabelContent';
+export * from './getAnonymousUser';
+export * from './getAttachments';
+export * from './getAuditRecords';
 export * from './getAuditRecordsForTimePeriod';
+export * from './getBlueprintTemplates';
+export * from './getBulkUserLookup';
+export * from './getBulkUserMigration';
 export * from './getContent';
-export * from './createContent';
-export * from './publishLegacyDraft';
-export * from './publishSharedDraft';
-export * from './searchContentByCQL';
 export * from './getContentById';
-export * from './updateContent';
-export * from './deleteContent';
-export * from './getHistoryForContent';
+export * from './getContentByTypeForSpace';
 export * from './getContentChildren';
-export * from './movePage';
 export * from './getContentChildrenByType';
-export * from './getContentDescendants';
-export * from './descendantsOfType';
-export * from './copyPageHierarchy';
-export * from './copyPage';
-export * from './getAttachments';
-export * from './createAttachments';
-export * from './createOrUpdateAttachments';
-export * from './updateAttachmentProperties';
-export * from './updateAttachmentData';
 export * from './getContentComments';
-export * from './getMacroBodyByMacroId';
-export * from './getLabelsForContent';
-export * from './addLabelsToContent';
-export * from './removeLabelFromContentUsingQueryParameter';
-export * from './removeLabelFromContent';
-export * from './getWatchesForPage';
-export * from './getWatchesForSpace';
-export * from './getWatchersForSpace';
-export * from './getContentWatchStatus';
-export * from './addContentWatcher';
-export * from './removeContentWatcher';
-export * from './isWatchingLabel';
-export * from './addLabelWatcher';
-export * from './removeLabelWatcher';
-export * from './isWatchingSpace';
-export * from './addSpaceWatcher';
-export * from './removeSpaceWatch';
-export * from './permissionCheck';
+export * from './getContentDescendants';
+export * from './getContentForSpace';
 export * from './getContentProperties';
-export * from './createContentProperty';
 export * from './getContentProperty';
-export * from './createContentPropertyForKey';
-export * from './updateContentProperty';
-export * from './deleteContentProperty';
-export * from './getRestrictions';
-export * from './addRestrictions';
-export * from './updateRestrictions';
-export * from './deleteRestrictions';
-export * from './getRestrictionsByOperation';
-export * from './getRestrictionsForOperation';
 export * from './getContentRestrictionStatusForGroup';
-export * from './addGroupToContentRestriction';
-export * from './getIndividualGroupRestrictionStatusByGroupId';
-export * from './addGroupToContentRestrictionByGroupId';
-export * from './removeGroupByName';
-export * from './removeGroupById';
 export * from './getContentRestrictionStatusForUser';
-export * from './addUserToContentRestriction';
-export * from './removeUserFromContentRestriction';
-export * from './getContentVersions';
-export * from './restoreContentVersion';
+export * from './getContentTemplate';
+export * from './getContentTemplates';
 export * from './getContentVersion';
-export * from './deleteContentVersion';
-export * from './convertContentBody';
-export * from './searchTasks';
-export * from './getAllLabelContent';
-export * from './getGroups';
-export * from './createGroup';
-export * from './removeGroup';
-export * from './getGroupByQueryParam';
-export * from './getGroupByGroupId';
+export * from './getContentVersions';
+export * from './getContentWatchStatus';
+export * from './getCurrentUser';
+export * from './getDescendantsOfType';
 export * from './getGroup';
-export * from './getMembersByQueryParam';
+export * from './getGroupByGroupId';
+export * from './getGroupByName';
+export * from './getGroupByQueryParam';
 export * from './getGroupMembers';
-export * from './getGroupsSearch';
-export * from './addUserToGroupByGroupId';
-export * from './removeMemberFromGroupByGroupId';
 export * from './getGroupMembersByGroupId';
-export * from './addUserToGroup';
-export * from './removeMemberFromGroup';
-export * from './getTasks';
-export * from './getTask';
-export * from './findTargetFromSource';
-export * from './getRelationship';
-export * from './createRelationship';
-export * from './delete';
-export * from './findSourcesForTarget';
-export * from './search';
-export * from './userSearch';
+export * from './getGroupMembershipsForUser';
+export * from './getGroups';
+export * from './getGroupsSearch';
+export * from './getHistoryForContent';
+export * from './getIndividualGroupRestrictionStatusByGroupId';
+export * from './getLabelsForContent';
 export * from './getLookAndFeelSettings';
-export * from './updateLookAndFeel';
-export * from './updateLookAndFeelSettings';
-export * from './resetLookAndFeelSettings';
-export * from './setLookAndFeelSettings';
-export * from './getThemes';
-export * from './getTheme';
-export * from './getSpaceTheme';
-export * from './setSpaceTheme';
-export * from './resetSpaceTheme';
-export * from './getSpaces';
-export * from './createSpace';
-export * from './createPrivateSpace';
+export * from './getMacroBodyByMacroId';
+export * from './getMembersByQueryParam';
+export * from './getPrivacyUnsafeUserEmail';
+export * from './getPrivacyUnsafeUserEmailBulk';
+export * from './getRelationship';
+export * from './getRestrictions';
+export * from './getRestrictionsByOperation';
+export * from './getRestrictionsForOperation';
 export * from './getSpace';
-export * from './updateSpace';
-export * from './deleteSpace';
-export * from './getContentForSpace';
-export * from './getContentByTypeForSpace';
-export * from './addPermission';
-export * from './removePermission';
 export * from './getSpaceProperties';
-export * from './createSpaceProperty';
 export * from './getSpaceProperty';
-export * from './createSpacePropertyForKey';
-export * from './updateSpaceProperty';
-export * from './deleteSpaceProperty';
+export * from './getSpaces';
 export * from './getSpaceSettings';
-export * from './updateSpaceSettings';
-export * from './createContentTemplate';
-export * from './updateContentTemplate';
-export * from './getBlueprintTemplates';
-export * from './getContentTemplates';
-export * from './getContentTemplate';
-export * from './removeTemplate';
+export * from './getSpaceTheme';
+export * from './getTask';
+export * from './getTaskById';
+export * from './getTasks';
+export * from './getTheme';
+export * from './getThemes';
 export * from './getUser';
-export * from './getAnonymousUser';
-export * from './getCurrentUser';
-export * from './getGroupMembershipsForUser';
-export * from './getBulkUserLookup';
-export * from './getPrivacyUnsafeUserEmail';
-export * from './getPrivacyUnsafeUserEmailBulk';
-export * from './getBulkUserMigration';
+export * from './getViewers';
+export * from './getViews';
+export * from './getWatchersForSpace';
+export * from './getWatchesForPage';
+export * from './getWatchesForSpace';
+export * from './isWatchingLabel';
+export * from './isWatchingSpace';
+export * from './movePage';
+export * from './permissionCheck';
+export * from './publishLegacyDraft';
+export * from './publishSharedDraft';
 export * from './registerModules';
+export * from './removeContentWatcher';
+export * from './removeGroup';
+export * from './removeGroupById';
+export * from './removeGroupByName';
+export * from './removeLabelFromContent';
+export * from './removeLabelFromContentUsingQueryParameter';
+export * from './removeLabelWatcher';
+export * from './removeMemberFromGroup';
+export * from './removeMemberFromGroupByGroupId';
 export * from './removeModules';
+export * from './removePermission';
+export * from './removeSpaceWatch';
+export * from './removeTemplate';
+export * from './removeUserFromContentRestriction';
+export * from './resetLookAndFeelSettings';
+export * from './resetSpaceTheme';
+export * from './restoreContentVersion';
+export * from './search';
+export * from './searchByCQL';
+export * from './searchContentByCQL';
+export * from './searchGroups';
+export * from './searchTasks';
+export * from './searchUser';
+export * from './setLookAndFeelSettings';
+export * from './setRetentionPeriod';
+export * from './setSpaceTheme';
+export * from './updateAttachmentData';
+export * from './updateAttachmentProperties';
+export * from './updateContent';
+export * from './updateContentProperty';
+export * from './updateContentTemplate';
+export * from './updateLookAndFeel';
+export * from './updateLookAndFeelSettings';
+export * from './updateRestrictions';
+export * from './updateSpace';
+export * from './updateSpaceProperty';
+export * from './updateSpaceSettings';
+export * from './updateTaskById';
+export * from './userSearch';