confluence.js 1.1.3 → 1.2.0

package/src/api/contentPermissions.ts

@@ -7,6 +7,23 @@ import { RequestConfig } from '../requestConfig';
 export class ContentPermissions {
   constructor(private client: Client) {}
 
+  /** @deprecated Will be removed in the next major version. Use `checkContentPermission` method instead. */
+  async permissionCheck<T = Models.PermissionCheckResponse>(
+    parameters: Parameters.PermissionCheck,
+    callback: Callback<T>
+  ): Promise<void>;
+  /** @deprecated Will be removed in the next major version. Use `checkContentPermission` method instead. */
+  async permissionCheck<T = Models.PermissionCheckResponse>(
+    parameters: Parameters.PermissionCheck,
+    callback?: never
+  ): Promise<T>;
+  async permissionCheck<T = Models.PermissionCheckResponse>(
+    parameters: Parameters.PermissionCheck,
+    callback?: Callback<T>,
+  ): Promise<void | T> {
+    return this.checkContentPermission(parameters, callback!);
+  }
+
   /**
    * Check if a user or a group can perform an operation to the specified content. The `operation` to check must be
    * provided. The user’s account ID or the ID of the group can be provided in the `subject` to check permissions
@@ -21,8 +38,8 @@ export class ContentPermissions {
    * ('Can use' global permission) if checking permission for self, otherwise 'Confluence Administrator' global
    * permission is required.
    */
-  async permissionCheck<T = Models.PermissionCheckResponse>(
-    parameters: Parameters.PermissionCheck,
+  async checkContentPermission<T = Models.PermissionCheckResponse>(
+    parameters: Parameters.CheckContentPermission,
     callback: Callback<T>
   ): Promise<void>;
   /**
@@ -39,12 +56,12 @@ export class ContentPermissions {
    * ('Can use' global permission) if checking permission for self, otherwise 'Confluence Administrator' global
    * permission is required.
    */
-  async permissionCheck<T = Models.PermissionCheckResponse>(
-    parameters: Parameters.PermissionCheck,
+  async checkContentPermission<T = Models.PermissionCheckResponse>(
+    parameters: Parameters.CheckContentPermission,
     callback?: never
   ): Promise<T>;
-  async permissionCheck<T = Models.PermissionCheckResponse>(
-    parameters: Parameters.PermissionCheck,
+  async checkContentPermission<T = Models.PermissionCheckResponse>(
+    parameters: Parameters.CheckContentPermission,
     callback?: Callback<T>,
   ): Promise<void | T> {
     const config: RequestConfig = {
@@ -56,6 +73,6 @@ export class ContentPermissions {
       },
     };
 
-    return this.client.sendRequest(config, callback, { methodName: 'permissionCheck' });
+    return this.client.sendRequest(config, callback, { methodName: 'checkContentPermission' });
   }
 }

package/src/api/contentProperties.ts

@@ -37,6 +37,7 @@ export class ContentProperties {
       url: `/api/content/${parameters.id}/property`,
       method: 'GET',
       params: {
+        key: parameters.key,
         expand: parameters.expand,
         start: parameters.start,
         limit: parameters.limit,

package/src/api/contentWatches.ts

@@ -68,7 +68,7 @@ export class ContentWatches {
    * **[Permissions](https://confluence.atlassian.com/x/_AozKw) required**: Permission to access the Confluence site
    * ('Can use' global permission).
    */
-  async getWatchesForSpace<T = Models.WatchArray>(
+  async getWatchesForSpace<T = Models.SpaceWatchArray>(
     parameters: Parameters.GetWatchesForSpace,
     callback: Callback<T>
   ): Promise<void>;
@@ -85,11 +85,11 @@ export class ContentWatches {
    * **[Permissions](https://confluence.atlassian.com/x/_AozKw) required**: Permission to access the Confluence site
    * ('Can use' global permission).
    */
-  async getWatchesForSpace<T = Models.WatchArray>(
+  async getWatchesForSpace<T = Models.SpaceWatchArray>(
     parameters: Parameters.GetWatchesForSpace,
     callback?: never
   ): Promise<T>;
-  async getWatchesForSpace<T = Models.WatchArray>(
+  async getWatchesForSpace<T = Models.SpaceWatchArray>(
     parameters: Parameters.GetWatchesForSpace,
     callback?: Callback<T>,
   ): Promise<void | T> {

package/src/api/experimental.ts

@@ -0,0 +1,44 @@
+import * as Models from './models';
+import * as Parameters from './parameters';
+import { Client } from '../clients';
+import { Callback } from '../callback';
+import { RequestConfig } from '../requestConfig';
+
+export class Experimental {
+  constructor(private client: Client) {}
+
+  /** Get the total number of views a piece of content has. */
+  async getViews<T = Models.GetViews>(parameters: Parameters.GetViews, callback: Callback<T>): Promise<void>;
+  /** Get the total number of views a piece of content has. */
+  async getViews<T = Models.GetViews>(parameters: Parameters.GetViews, callback?: never): Promise<T>;
+  async getViews<T = Models.GetViews>(parameters: Parameters.GetViews, callback?: Callback<T>): Promise<void | T> {
+    const config: RequestConfig = {
+      url: `/api/analytics/content/${parameters.contentId}/views`,
+      method: 'GET',
+      params: {
+        fromDate: parameters.fromDate,
+      },
+    };
+
+    return this.client.sendRequest(config, callback, { methodName: 'getViews' });
+  }
+
+  /** Get the total number of distinct viewers a piece of content has. */
+  async getViewers<T = Models.GetViewers>(parameters: Parameters.GetViewers, callback: Callback<T>): Promise<void>;
+  /** Get the total number of distinct viewers a piece of content has. */
+  async getViewers<T = Models.GetViewers>(parameters: Parameters.GetViewers, callback?: never): Promise<T>;
+  async getViewers<T = Models.GetViewers>(
+    parameters: Parameters.GetViewers,
+    callback?: Callback<T>,
+  ): Promise<void | T> {
+    const config: RequestConfig = {
+      url: `/api/analytics/content/${parameters.contentId}/viewers`,
+      method: 'GET',
+      params: {
+        fromDate: parameters.fromDate,
+      },
+    };
+
+    return this.client.sendRequest(config, callback, { methodName: 'getViewers' });
+  }
+}

package/src/api/group.ts

@@ -34,6 +34,7 @@ export class Group {
       params: {
         start: parameters?.start,
         limit: parameters?.limit,
+        accessType: parameters?.accessType,
       },
     };
 
@@ -158,6 +159,37 @@ export class Group {
     return this.client.sendRequest(config, callback, { methodName: 'getGroupByGroupId' });
   }
 
+  /**
+   * Delete user group.
+   *
+   * **[Permissions](https://confluence.atlassian.com/x/_AozKw) required**: User must be a site admin.
+   */
+  async removeGroupById<T = void>(parameters: Parameters.RemoveGroupById, callback: Callback<T>): Promise<void>;
+  /**
+   * Delete user group.
+   *
+   * **[Permissions](https://confluence.atlassian.com/x/_AozKw) required**: User must be a site admin.
+   */
+  async removeGroupById<T = void>(parameters: Parameters.RemoveGroupById, callback?: never): Promise<T>;
+  async removeGroupById<T = void>(parameters: Parameters.RemoveGroupById, callback?: Callback<T>): Promise<void | T> {
+    const config: RequestConfig = {
+      url: '/api/group/by-id',
+      method: 'DELETE',
+      params: {
+        id: parameters.id,
+      },
+    };
+
+    return this.client.sendRequest(config, callback, { methodName: 'removeGroupById' });
+  }
+
+  /** @deprecated Will be removed in the next major version. Use `getGroupByName` instead. */
+  async getGroup<T = Models.Group>(parameters: Parameters.GetGroup, callback: Callback<T>): Promise<void>;
+  /** @deprecated Will be removed in the next major version. Use `getGroupByName` instead. */
+  async getGroup<T = Models.Group>(parameters: Parameters.GetGroup, callback?: never): Promise<T>;
+  async getGroup<T = Models.Group>(parameters: Parameters.GetGroup, callback?: Callback<T>): Promise<void | T> {
+    return this.getGroupByName(parameters, callback!);
+  }
   /**
    * Returns a user group for a given group name.
    *
@@ -166,7 +198,7 @@ export class Group {
    * **[Permissions](https://confluence.atlassian.com/x/_AozKw) required**: Permission to access the Confluence site
    * ('Can use' global permission).
    */
-  async getGroup<T = Models.Group>(parameters: Parameters.GetGroup, callback: Callback<T>): Promise<void>;
+  async getGroupByName<T = Models.Group>(parameters: Parameters.GetGroupByName, callback: Callback<T>): Promise<void>;
   /**
    * Returns a user group for a given group name.
    *
@@ -175,14 +207,17 @@ export class Group {
    * **[Permissions](https://confluence.atlassian.com/x/_AozKw) required**: Permission to access the Confluence site
    * ('Can use' global permission).
    */
-  async getGroup<T = Models.Group>(parameters: Parameters.GetGroup, callback?: never): Promise<T>;
-  async getGroup<T = Models.Group>(parameters: Parameters.GetGroup, callback?: Callback<T>): Promise<void | T> {
+  async getGroupByName<T = Models.Group>(parameters: Parameters.GetGroupByName, callback?: never): Promise<T>;
+  async getGroupByName<T = Models.Group>(
+    parameters: Parameters.GetGroupByName,
+    callback?: Callback<T>,
+  ): Promise<void | T> {
     const config: RequestConfig = {
       url: `/api/group/${parameters.groupName}`,
       method: 'GET',
     };
 
-    return this.client.sendRequest(config, callback, { methodName: 'getGroup' });
+    return this.client.sendRequest(config, callback, { methodName: 'getGroupByName' });
   }
 
   /**
@@ -191,7 +226,7 @@ export class Group {
    * **[Permissions](https://confluence.atlassian.com/x/_AozKw) required**: Permission to access the Confluence site
    * ('Can use' global permission).
    */
-  async getMembersByQueryParam<T = Models.UserArrayWithLinks>(
+  async getMembersByQueryParam<T = Models.UserArray>(
     parameters: Parameters.GetMembersByQueryParam,
     callback: Callback<T>
   ): Promise<void>;
@@ -201,11 +236,11 @@ export class Group {
    * **[Permissions](https://confluence.atlassian.com/x/_AozKw) required**: Permission to access the Confluence site
    * ('Can use' global permission).
    */
-  async getMembersByQueryParam<T = Models.UserArrayWithLinks>(
+  async getMembersByQueryParam<T = Models.UserArray>(
     parameters: Parameters.GetMembersByQueryParam,
     callback?: never
   ): Promise<T>;
-  async getMembersByQueryParam<T = Models.UserArrayWithLinks>(
+  async getMembersByQueryParam<T = Models.UserArray>(
     parameters: Parameters.GetMembersByQueryParam,
     callback?: Callback<T>,
   ): Promise<void | T> {
@@ -230,7 +265,7 @@ export class Group {
    * **[Permissions](https://confluence.atlassian.com/x/_AozKw) required**: Permission to access the Confluence site
    * ('Can use' global permission).
    */
-  async getGroupMembers<T = Models.UserArrayWithLinks>(
+  async getGroupMembers<T = Models.UserArray>(
     parameters: Parameters.GetGroupMembers,
     callback: Callback<T>
   ): Promise<void>;
@@ -242,11 +277,8 @@ export class Group {
    * **[Permissions](https://confluence.atlassian.com/x/_AozKw) required**: Permission to access the Confluence site
    * ('Can use' global permission).
    */
-  async getGroupMembers<T = Models.UserArrayWithLinks>(
-    parameters: Parameters.GetGroupMembers,
-    callback?: never
-  ): Promise<T>;
-  async getGroupMembers<T = Models.UserArrayWithLinks>(
+  async getGroupMembers<T = Models.UserArray>(parameters: Parameters.GetGroupMembers, callback?: never): Promise<T>;
+  async getGroupMembers<T = Models.UserArray>(
     parameters: Parameters.GetGroupMembers,
     callback?: Callback<T>,
   ): Promise<void | T> {
@@ -262,12 +294,12 @@ export class Group {
     return this.client.sendRequest(config, callback, { methodName: 'getGroupMembers' });
   }
 
-  /** Get search results of groups by partial query provided. */
+  /** @deprecated Will be removed in the next major version. Use `searchGroups` instead. */
   async getGroupsSearch<T = Models.GroupArrayWithLinks>(
     parameters: Parameters.GetGroupsSearch,
     callback: Callback<T>
   ): Promise<void>;
-  /** Get search results of groups by partial query provided. */
+  /** @deprecated Will be removed in the next major version. Use `searchGroups` instead. */
   async getGroupsSearch<T = Models.GroupArrayWithLinks>(
     parameters: Parameters.GetGroupsSearch,
     callback?: never
@@ -275,6 +307,20 @@ export class Group {
   async getGroupsSearch<T = Models.GroupArrayWithLinks>(
     parameters: Parameters.GetGroupsSearch,
     callback?: Callback<T>,
+  ): Promise<void | T> {
+    return this.searchGroups(parameters, callback!);
+  }
+
+  /** Get search results of groups by partial query provided. */
+  async searchGroups<T = Models.GroupArrayWithLinks>(
+    parameters: Parameters.SearchGroups,
+    callback: Callback<T>
+  ): Promise<void>;
+  /** Get search results of groups by partial query provided. */
+  async searchGroups<T = Models.GroupArrayWithLinks>(parameters: Parameters.SearchGroups, callback?: never): Promise<T>;
+  async searchGroups<T = Models.GroupArrayWithLinks>(
+    parameters: Parameters.SearchGroups,
+    callback?: Callback<T>,
   ): Promise<void | T> {
     const config: RequestConfig = {
       url: '/api/group/picker',
@@ -286,7 +332,7 @@ export class Group {
       },
     };
 
-    return this.client.sendRequest(config, callback, { methodName: 'getGroupsSearch' });
+    return this.client.sendRequest(config, callback, { methodName: 'searchGroups' });
   }
 
   /**
@@ -317,6 +363,9 @@ export class Group {
       params: {
         groupId: parameters.groupId,
       },
+      data: {
+        accountId: parameters.accountId,
+      },
     };
 
     return this.client.sendRequest(config, callback, { methodName: 'addUserToGroupByGroupId' });
@@ -364,7 +413,7 @@ export class Group {
    * **[Permissions](https://confluence.atlassian.com/x/_AozKw) required**: Permission to access the Confluence site
    * ('Can use' global permission).
    */
-  async getGroupMembersByGroupId<T = Models.UserArrayWithLinks>(
+  async getGroupMembersByGroupId<T = Models.UserArray>(
     parameters: Parameters.GetGroupMembersByGroupId,
     callback: Callback<T>
   ): Promise<void>;
@@ -376,11 +425,11 @@ export class Group {
    * **[Permissions](https://confluence.atlassian.com/x/_AozKw) required**: Permission to access the Confluence site
    * ('Can use' global permission).
    */
-  async getGroupMembersByGroupId<T = Models.UserArrayWithLinks>(
+  async getGroupMembersByGroupId<T = Models.UserArray>(
     parameters: Parameters.GetGroupMembersByGroupId,
     callback?: never
   ): Promise<T>;
-  async getGroupMembersByGroupId<T = Models.UserArrayWithLinks>(
+  async getGroupMembersByGroupId<T = Models.UserArray>(
     parameters: Parameters.GetGroupMembersByGroupId,
     callback?: Callback<T>,
   ): Promise<void | T> {
@@ -415,6 +464,9 @@ export class Group {
       params: {
         name: parameters.name,
       },
+      data: {
+        accountId: parameters.accountId,
+      },
     };
 
     return this.client.sendRequest(config, callback, { methodName: 'addUserToGroup' });

package/src/api/index.ts

@@ -12,6 +12,7 @@ export * from './contentRestrictions';
 export * from './contentVersions';
 export * from './contentWatches';
 export * from './dynamicModules';
+export * from './experimental';
 export * from './group';
 export * from './inlineTasks';
 export * from './labelInfo';

package/src/api/inlineTasks.ts

@@ -51,4 +51,56 @@ export class InlineTasks {
 
     return this.client.sendRequest(config, callback, { methodName: 'searchTasks' });
   }
+
+  /**
+   * Returns inline task based on the global ID.
+   *
+   * **[Permissions](https://confluence.atlassian.com/x/_AozKw) required**: Permission to view the content associated
+   * with the task.
+   */
+  async getTaskById<T = Models.Task>(parameters: Parameters.GetTaskById, callback: Callback<T>): Promise<void>;
+  /**
+   * Returns inline task based on the global ID.
+   *
+   * **[Permissions](https://confluence.atlassian.com/x/_AozKw) required**: Permission to view the content associated
+   * with the task.
+   */
+  async getTaskById<T = Models.Task>(parameters: Parameters.GetTaskById, callback?: never): Promise<T>;
+  async getTaskById<T = Models.Task>(parameters: Parameters.GetTaskById, callback?: Callback<T>): Promise<void | T> {
+    const config: RequestConfig = {
+      url: `/api/inlinetasks/${parameters.inlineTaskId}`,
+      method: 'GET',
+    };
+
+    return this.client.sendRequest(config, callback, { methodName: 'getTaskById' });
+  }
+
+  /**
+   * Updates an inline tasks status given its global ID
+   *
+   * **[Permissions](https://confluence.atlassian.com/x/_AozKw) required**: Permission to update the content associated
+   * with the task.
+   */
+  async updateTaskById<T = Models.Task>(parameters: Parameters.UpdateTaskById, callback: Callback<T>): Promise<void>;
+  /**
+   * Updates an inline tasks status given its global ID
+   *
+   * **[Permissions](https://confluence.atlassian.com/x/_AozKw) required**: Permission to update the content associated
+   * with the task.
+   */
+  async updateTaskById<T = Models.Task>(parameters: Parameters.UpdateTaskById, callback?: never): Promise<T>;
+  async updateTaskById<T = Models.Task>(
+    parameters: Parameters.UpdateTaskById,
+    callback?: Callback<T>,
+  ): Promise<void | T> {
+    const config: RequestConfig = {
+      url: `/api/inlinetasks/${parameters.inlineTaskId}`,
+      method: 'PUT',
+      data: {
+        status: parameters.status,
+      },
+    };
+
+    return this.client.sendRequest(config, callback, { methodName: 'updateTaskById' });
+  }
 }

package/src/api/models/getViewers.ts

@@ -0,0 +1,6 @@
+export interface GetViewers {
+  /** The content ID. */
+  id?: number;
+  /** The total number of distinct viewers for the content. */
+  count?: number;
+}

package/src/api/models/getViews.ts

@@ -0,0 +1,6 @@
+export interface GetViews {
+  /** The content ID. */
+  id?: number;
+  /** The total number of views for the content. */
+  count?: number;
+}

package/src/api/models/groupCreate.ts

@@ -0,0 +1,4 @@
+export interface GroupCreate {
+  type: string;
+  name: string;
+}

package/src/api/models/horizontalHeaderLookAndFeel.ts

@@ -0,0 +1,12 @@
+import { ButtonLookAndFeel } from './buttonLookAndFeel';
+import { TopNavigationLookAndFeel } from './topNavigationLookAndFeel';
+import { NavigationLookAndFeel } from './navigationLookAndFeel';
+import { SearchFieldLookAndFeel } from './searchFieldLookAndFeel';
+
+export interface HorizontalHeaderLookAndFeel {
+  backgroundColor: string;
+  button?: ButtonLookAndFeel;
+  primaryNavigation: TopNavigationLookAndFeel;
+  secondaryNavigation?: NavigationLookAndFeel;
+  search?: SearchFieldLookAndFeel;
+}

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;
+  };
 }