confluence.js 1.1.3 → 1.3.0

package/src/api/models/index.ts

@@ -14,8 +14,6 @@ export * from './breadcrumb';
 export * from './bulkUserLookup';
 export * from './bulkUserLookupArray';
 export * from './buttonLookAndFeel';
-export * from './cQLPersonalDataConvertedQueries';
-export * from './cQLPersonalDataMigrationRequest';
 export * from './changedValue';
 export * from './connectModule';
 export * from './connectModules';
@@ -30,8 +28,8 @@ export * from './contentBlueprintDraft';
 export * from './contentBody';
 export * from './contentBodyCreate';
 export * from './contentBodyCreateStorage';
-export * from './contentChildType';
 export * from './contentChildren';
+export * from './contentChildType';
 export * from './contentComment';
 export * from './contentCreate';
 export * from './contentHistory';
@@ -59,17 +57,23 @@ export * from './copyPageHierarchyRequest';
 export * from './copyPageHierarchyTitleOptions';
 export * from './copyPageRequest';
 export * from './copyPageRequestDestination';
+export * from './cQLPersonalDataConvertedQueries';
+export * from './cQLPersonalDataMigrationRequest';
 export * from './deletedSpace';
 export * from './dynamicModulesErrorMessage';
 export * from './embeddable';
 export * from './embeddedContent';
 export * from './genericLinks';
 export * from './getRestrictionsByOperation';
+export * from './getViewers';
+export * from './getViews';
 export * from './group';
 export * from './groupArray';
 export * from './groupArrayWithLinks';
+export * from './groupCreate';
 export * from './groupName';
 export * from './headerLookAndFeel';
+export * from './horizontalHeaderLookAndFeel';
 export * from './icon';
 export * from './label';
 export * from './labelArray';
@@ -112,6 +116,9 @@ export * from './spaceCreate';
 export * from './spaceDescription';
 export * from './spaceDescriptionCreate';
 export * from './spacePermission';
+export * from './spacePermissionCreate';
+export * from './spacePermissionCustomContent';
+export * from './spacePermissionRequest';
 export * from './spacePermissionV2';
 export * from './spacePrivateCreate';
 export * from './spaceProperty';
@@ -129,17 +136,19 @@ export * from './superBatchWebResources';
 export * from './systemInfoEntity';
 export * from './task';
 export * from './taskPageResponse';
+export * from './taskStatusUpdate';
 export * from './theme';
 export * from './themeArray';
 export * from './themeNoLinks';
 export * from './themeUpdate';
+export * from './topNavigationLookAndFeel';
 export * from './user';
 export * from './userAnonymous';
 export * from './userArray';
 export * from './userArrayWithLinks';
 export * from './userDetails';
-export * from './userWatch';
 export * from './usersUserKeys';
+export * from './userWatch';
 export * from './version';
 export * from './versionArray';
 export * from './versionRestore';

package/src/api/models/lookAndFeel.ts

@@ -1,6 +1,7 @@
 import { MenusLookAndFeel } from './menusLookAndFeel';
 import { HeaderLookAndFeel } from './headerLookAndFeel';
 import { ContentLookAndFeel } from './contentLookAndFeel';
+import { HorizontalHeaderLookAndFeel } from './horizontalHeaderLookAndFeel';
 
 export interface LookAndFeel {
   headings: {
@@ -15,4 +16,6 @@ export interface LookAndFeel {
   bordersAndDividers: {
     color: string;
   };
+  horizontalHeader?: HorizontalHeaderLookAndFeel;
+  spaceReference?: unknown;
 }

package/src/api/models/spacePermissionCreate.ts

@@ -0,0 +1,34 @@
+import { User } from './user';
+import { GroupCreate } from './groupCreate';
+import { OperationCheckResult } from './operationCheckResult';
+
+/**
+ * This object represents a permission for given space. Permissions consist of* at least one operation object with an
+ * accompanying subjects object.
+ *
+ * The following combinations of `operation` and `targetType` values are valid for the `operation` object:
+ *
+ * - 'create': 'page', 'blogpost', 'comment', 'attachment'
+ * - 'read': 'space'
+ * - 'delete': 'page', 'blogpost', 'comment', 'attachment'
+ * - 'export': 'space'
+ * - 'administer': 'space'
+ */
+export interface SpacePermissionCreate {
+  /** The users and/or groups that the permission applies to. */
+  subjects: {
+    user?: {
+      results: User[];
+      size: number;
+    };
+    group?: {
+      results: GroupCreate[];
+      size: number;
+    };
+  };
+  operation: OperationCheckResult;
+  /** Grant anonymous users permission to use the operation. */
+  anonymousAccess: boolean;
+  /** Grants access to unlicensed users from JIRA Service Desk when used with the 'read space' operation. */
+  unlicensedAccess: boolean;
+}

package/src/api/models/spacePermissionCustomContent.ts

@@ -0,0 +1,17 @@
+import { PermissionSubject } from './permissionSubject';
+
+/**
+ * This object represents a list of space permissions for custom content type for an individual user. Permissions
+ * consist of* a subjects object and a list with at least one operation object.
+ */
+export interface SpacePermissionCustomContent {
+  subject: PermissionSubject;
+  operations: {
+    /** The operation type */
+    key: string;
+    /** The custom content type */
+    target: string;
+    /** Grant or restrict access */
+    access: boolean;
+  }[];
+}

package/src/api/models/spacePermissionRequest.ts

@@ -0,0 +1,42 @@
+import { PermissionSubject } from './permissionSubject';
+import { GenericLinks } from './genericLinks';
+
+/**
+ * This object represents the request for the single space permission. Permissions consist of* at least one operation
+ * object with an accompanying subjects object.
+ *
+ * The following combinations of `operation.key` and `operation.target` values are valid for the `operation` object:
+ *
+ * ```bash
+ * 'create': 'page', 'blogpost', 'comment', 'attachment'
+ * 'read': 'space'
+ * 'delete': 'page', 'blogpost', 'comment', 'attachment', 'space'
+ * 'export': 'space'
+ * 'administer': 'space'
+ * 'archive': 'page'
+ * 'restrict_content': 'space'
+ * ```
+ *
+ * For example, to enable Delete Own permission, set the `operation` object to the following:
+ *
+ *     "operation": {
+ *         "key": "delete",
+ *         "target": "space"
+ *     }
+ *
+ * To enable Add/Delete Restrictions permissions, set the `operation` object to the following:
+ *
+ *     "operation": {
+ *         "key": "restrict_content",
+ *         "target": "space"
+ *     }
+ */
+export interface SpacePermissionRequest {
+  subject: PermissionSubject;
+  operation: {
+    key: string;
+    /** The space or content type that the operation applies to. */
+    target: string;
+  };
+  links?: GenericLinks;
+}

package/src/api/models/spacePrivateCreate.ts

@@ -1,4 +1,5 @@
 import { SpaceDescriptionCreate } from './spaceDescriptionCreate';
+import { SpacePermissionCreate } from './spacePermissionCreate';
 
 /** This is the request object used when creating a new private space. */
 export interface SpacePrivateCreate {
@@ -7,4 +8,12 @@ export interface SpacePrivateCreate {
   /** The name of the new space. */
   name: string;
   description?: SpaceDescriptionCreate;
+  /**
+   * The permissions for the new space. If no permissions are provided, the [Confluence default space
+   * permissions](https://confluence.atlassian.com/x/UAgzKw#CreateaSpace-Spacepermissions) are applied. Note that if
+   * permissions are provided, the space is created with only the provided set of permissions, not including the default
+   * space permissions. Space permissions can be modified after creation using the space permissions endpoints, and a
+   * private space can be created using the create private space endpoint.
+   */
+  permissions?: SpacePermissionCreate[];
 }

package/src/api/models/spacePropertyCreate.ts

@@ -4,4 +4,8 @@ export interface SpacePropertyCreate {
   /** The key of the new property. */
   key: string;
   value: PropertyValue;
+  space?: {
+    /** The key of the space */
+    key?: string;
+  };
 }

package/src/api/models/spaceUpdate.ts

@@ -9,4 +9,8 @@ export interface SpaceUpdate {
     /** The ID of the page. */
     id: string;
   };
+  /** The updated type for this space. */
+  type?: string;
+  /** The updated status for this space. */
+  status?: string;
 }

package/src/api/models/taskStatusUpdate.ts

@@ -0,0 +1,3 @@
+export interface TaskStatusUpdate {
+  status: string;
+}

package/src/api/models/topNavigationLookAndFeel.ts

@@ -0,0 +1,8 @@
+export interface TopNavigationLookAndFeel {
+  color?: string;
+  highlightColor: string;
+  hoverOrFocus?: {
+    backgroundColor?: string;
+    color?: string;
+  };
+}

package/src/api/parameters/addCustomContentPermissions.ts

@@ -0,0 +1,6 @@
+import { SpacePermissionCustomContent } from '../models';
+
+export interface AddCustomContentPermissions extends SpacePermissionCustomContent {
+  /** The key of the space to be queried for its content. */
+  spaceKey: string;
+}

package/src/api/parameters/addLabelsToSpace.ts

@@ -0,0 +1,4 @@
+export interface AddLabelsToSpace {
+  /** The key of the space to add labels to. */
+  spaceKey: string;
+}

package/src/api/parameters/addPermissionToSpace.ts

@@ -0,0 +1,6 @@
+import { SpacePermissionRequest } from '../models';
+
+export interface AddPermissionToSpace extends SpacePermissionRequest {
+  /** The key of the space to be queried for its content. */
+  spaceKey: string;
+}

package/src/api/parameters/addUserToGroup.ts

@@ -1,4 +1,6 @@
-export interface AddUserToGroup {
+import { AccountId } from '../models';
+
+export interface AddUserToGroup extends AccountId {
   /** Name of the group whose membership is updated */
   name: string;
 }

package/src/api/parameters/addUserToGroupByGroupId.ts

@@ -1,4 +1,6 @@
-export interface AddUserToGroupByGroupId {
+import { AccountId } from '../models';
+
+export interface AddUserToGroupByGroupId extends AccountId {
   /** GroupId of the group whose membership is updated */
   groupId: string;
 }

package/src/api/parameters/archivePages.ts

@@ -0,0 +1,6 @@
+export interface ArchivePages {
+  pages: Array<{
+    /** The `id` of the page to be archived. */
+    id: number;
+  }>;
+}

package/src/api/parameters/checkContentPermission.ts

@@ -0,0 +1,6 @@
+import { ContentPermissionRequest } from '../models';
+
+export interface CheckContentPermission extends ContentPermissionRequest {
+  /** The ID of the content to check permissions against. */
+  id: string;
+}

package/src/api/parameters/deleteLabelFromSpace.ts

@@ -0,0 +1,8 @@
+export interface DeleteLabelFromSpace {
+  /** The key of the space to remove a labels from. */
+  spaceKey: string;
+  /** The name of the label to remove */
+  name: string;
+  /** The prefix of the label to remove. If not provided defaults to global. */
+  prefix?: string;
+}

package/src/api/parameters/deleteRelationship.ts

@@ -0,0 +1,38 @@
+export interface DeleteRelationship {
+  /** The name of the relationship. */
+  relationName: string;
+  /** The source entity type of the relationship. This must be 'user', if the `relationName` is 'favourite'. */
+  sourceType: string;
+  /**
+   * - The identifier for the source entity:
+   *
+   *   - If `sourceType` is 'user', then specify either 'current' (logged-in user) or the user key.
+   *   - If `sourceType` is 'content', then specify the content ID.
+   *   - 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'. */
+  targetType: string;
+  /**
+   * - The identifier for the target entity:
+   *
+   *   - If `sourceType` is 'user', then specify either 'current' (logged-in user) or the user key.
+   *   - If `sourceType` is 'content', then specify the content ID.
+   *   - If `sourceType` is 'space', then specify the space key.
+   */
+  targetKey: string;
+  /** The status of the source. This parameter is only used when the `sourceType` is 'content'. */
+  sourceStatus?: string;
+  /** 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'.
+   */
+  sourceVersion?: number;
+  /**
+   * The version of the target. This parameter is only used when the `targetType` is 'content' and the `targetStatus`
+   * is 'historical'.
+   */
+  targetVersion?: number;
+}

package/src/api/parameters/downloadAttachment.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/src/api/parameters/getBulkUserLookup.ts

@@ -5,12 +5,6 @@ export interface GetBulkUserLookup {
    * A multi-value parameter indicating which properties of the user to expand.
    *
    * - `operations` returns the operations that the user is allowed to do.
-   * - `details.personal` returns the 'Personal' details in the user's profile, like the 'Email' and 'Phone'. Note that
-   *   these fields have been deprecated due to privacy changes. See the [migration
-   *   guide](https://developer.atlassian.com/cloud/confluence/deprecation-notice-user-privacy-api-migration-guide/) for details.
-   * - `details.business` returns the 'Company' details in the user's profile, like the 'Position' and 'Department'. Note
-   *   that these fields have been deprecated due to privacy changes. See the [migration
-   *   guide](https://developer.atlassian.com/cloud/confluence/deprecation-notice-user-privacy-api-migration-guide/) for details.
    * - PersonalSpace returns the user's personal space, if it exists.
    */
   expand?: string[];

package/src/api/parameters/getContentById.ts

@@ -19,10 +19,95 @@ export interface GetContentById {
    */
   embeddedContentRender?: string;
   /** A multi-value parameter indicating which properties of the content to expand. */
-  expand?: string[];
+  expand?: string | string[] | GetContentById.Expand | GetContentById.Expand[];
   /**
    * If set to `viewed`, the request will trigger a 'viewed' event for the content. When this event is triggered, the
    * page/blogpost will appear on the 'Recently visited' tab of the user's Confluence dashboard.
    */
   trigger?: string;
 }
+
+export namespace GetContentById {
+  export 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/src/api/parameters/getContentChildren.ts

@@ -7,6 +7,7 @@ export interface GetContentChildren {
    * - `attachment` returns all attachments for the content.
    * - `comments` returns all comments for the content.
    * - `page` returns all child pages of the content.
+   * - Custom content types that are provided by apps are also supported.
    */
   expand?: string[];
   /** The version of the parent content to retrieve children for. Currently, this only works for the latest version. */

package/src/api/parameters/getContentProperties.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/src/api/parameters/getContentProperty.ts

@@ -10,4 +10,16 @@ export interface GetContentProperty {
    * - `version` returns information about the version of the property, such as the version number, when it was created, etc.
    */
   expand?: string[];
+  /**
+   * Filter the results to a set of content based on their status. If set to `any`, content with any status is returned.
+   * By default it will fetch current and archived statuses `?status=current&status=archived`. All supported statuses
+   *
+   * - any
+   * - archived
+   * - current
+   * - deleted
+   * - draft
+   * - trashed
+   */
+  status?: string[];
 }

package/src/api/parameters/getContentVersions.ts

@@ -6,7 +6,7 @@ export interface GetContentVersions {
   /** The maximum number of versions to return per page. Note, this may be restricted by fixed system limits. */
   limit?: number;
   /**
-   * A multi-value parameter indicating which properties of the content to expand.
+   * A multi-value parameter indicating which properties of the content to expand. By default, the `content` object is expanded.
    *
    * - `collaborators` returns the users that collaborated on the version.
    * - `content` returns the content for the version.

package/src/api/parameters/getCurrentUser.ts

@@ -3,13 +3,8 @@ export interface GetCurrentUser {
    * A multi-value parameter indicating which properties of the user to expand.
    *
    * - `operations` returns the operations that the user is allowed to do.
-   * - `details.personal` returns the 'Personal' details in the user's profile, like the 'Email' and 'Phone'. Note that
-   *   these fields have been deprecated due to privacy changes. See the [migration
-   *   guide](https://developer.atlassian.com/cloud/confluence/deprecation-notice-user-privacy-api-migration-guide/) for details.
-   * - `details.business` returns the 'Company' details in the user's profile, like the 'Position' and 'Department'. Note
-   *   that these fields have been deprecated due to privacy changes. See the [migration
-   *   guide](https://developer.atlassian.com/cloud/confluence/deprecation-notice-user-privacy-api-migration-guide/) for details.
    * - PersonalSpace returns the user's personal space, if it exists.
+   * - `isExternalCollaborator` returns whether the user is an external collaborator user
    */
   expand?: string[];
 }

package/src/api/parameters/getDescendantsOfType.ts

@@ -0,0 +1,102 @@
+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 namespace GetDescendantsOfType {
+  export 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/src/api/parameters/getGroupByName.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/src/api/parameters/getGroups.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;
 }