confluence.js 1.1.3 → 1.2.0

package/out/api/group.js

@@ -14,6 +14,7 @@ class Group {
                 params: {
                     start: parameters === null || parameters === void 0 ? void 0 : parameters.start,
                     limit: parameters === null || parameters === void 0 ? void 0 : parameters.limit,
+                    accessType: parameters === null || parameters === void 0 ? void 0 : parameters.accessType,
                 },
             };
             return this.client.sendRequest(config, callback, { methodName: 'getGroups' });
@@ -67,13 +68,30 @@ class Group {
             return this.client.sendRequest(config, callback, { methodName: 'getGroupByGroupId' });
         });
     }
+    removeGroupById(parameters, callback) {
+        return (0, tslib_1.__awaiter)(this, void 0, void 0, function* () {
+            const config = {
+                url: '/api/group/by-id',
+                method: 'DELETE',
+                params: {
+                    id: parameters.id,
+                },
+            };
+            return this.client.sendRequest(config, callback, { methodName: 'removeGroupById' });
+        });
+    }
     getGroup(parameters, callback) {
+        return (0, tslib_1.__awaiter)(this, void 0, void 0, function* () {
+            return this.getGroupByName(parameters, callback);
+        });
+    }
+    getGroupByName(parameters, callback) {
         return (0, tslib_1.__awaiter)(this, void 0, void 0, function* () {
             const config = {
                 url: `/api/group/${parameters.groupName}`,
                 method: 'GET',
             };
-            return this.client.sendRequest(config, callback, { methodName: 'getGroup' });
+            return this.client.sendRequest(config, callback, { methodName: 'getGroupByName' });
         });
     }
     getMembersByQueryParam(parameters, callback) {
@@ -104,6 +122,11 @@ class Group {
         });
     }
     getGroupsSearch(parameters, callback) {
+        return (0, tslib_1.__awaiter)(this, void 0, void 0, function* () {
+            return this.searchGroups(parameters, callback);
+        });
+    }
+    searchGroups(parameters, callback) {
         return (0, tslib_1.__awaiter)(this, void 0, void 0, function* () {
             const config = {
                 url: '/api/group/picker',
@@ -114,7 +137,7 @@ class Group {
                     limit: parameters.limit,
                 },
             };
-            return this.client.sendRequest(config, callback, { methodName: 'getGroupsSearch' });
+            return this.client.sendRequest(config, callback, { methodName: 'searchGroups' });
         });
     }
     addUserToGroupByGroupId(parameters, callback) {
@@ -125,6 +148,9 @@ class Group {
                 params: {
                     groupId: parameters.groupId,
                 },
+                data: {
+                    accountId: parameters.accountId,
+                },
             };
             return this.client.sendRequest(config, callback, { methodName: 'addUserToGroupByGroupId' });
         });
@@ -163,6 +189,9 @@ class Group {
                 params: {
                     name: parameters.name,
                 },
+                data: {
+                    accountId: parameters.accountId,
+                },
             };
             return this.client.sendRequest(config, callback, { methodName: 'addUserToGroup' });
         });

package/out/api/index.d.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/out/api/index.js

@@ -15,6 +15,7 @@ const tslib_1 = require("tslib");
 (0, tslib_1.__exportStar)(require("./contentVersions"), exports);
 (0, tslib_1.__exportStar)(require("./contentWatches"), exports);
 (0, tslib_1.__exportStar)(require("./dynamicModules"), exports);
+(0, tslib_1.__exportStar)(require("./experimental"), exports);
 (0, tslib_1.__exportStar)(require("./group"), exports);
 (0, tslib_1.__exportStar)(require("./inlineTasks"), exports);
 (0, tslib_1.__exportStar)(require("./labelInfo"), exports);

package/out/api/inlineTasks.d.ts

@@ -19,4 +19,32 @@ export declare class InlineTasks {
      * ('Can use' global permission). Only tasks in contents that the user has permission to view are returned.
      */
     searchTasks<T = Models.TaskPageResponse>(parameters?: Parameters.SearchTasks, callback?: never): Promise<T>;
+    /**
+     * 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.
+     */
+    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.
+     */
+    getTaskById<T = Models.Task>(parameters: Parameters.GetTaskById, callback?: never): Promise<T>;
+    /**
+     * 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.
+     */
+    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.
+     */
+    updateTaskById<T = Models.Task>(parameters: Parameters.UpdateTaskById, callback?: never): Promise<T>;
 }

package/out/api/inlineTasks.js

@@ -31,5 +31,26 @@ class InlineTasks {
             return this.client.sendRequest(config, callback, { methodName: 'searchTasks' });
         });
     }
+    getTaskById(parameters, callback) {
+        return (0, tslib_1.__awaiter)(this, void 0, void 0, function* () {
+            const config = {
+                url: `/api/inlinetasks/${parameters.inlineTaskId}`,
+                method: 'GET',
+            };
+            return this.client.sendRequest(config, callback, { methodName: 'getTaskById' });
+        });
+    }
+    updateTaskById(parameters, callback) {
+        return (0, tslib_1.__awaiter)(this, void 0, void 0, function* () {
+            const config = {
+                url: `/api/inlinetasks/${parameters.inlineTaskId}`,
+                method: 'PUT',
+                data: {
+                    status: parameters.status,
+                },
+            };
+            return this.client.sendRequest(config, callback, { methodName: 'updateTaskById' });
+        });
+    }
 }
 exports.InlineTasks = InlineTasks;

package/out/api/models/getViewers.d.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/out/api/models/getViewers.js

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

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

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

package/out/api/models/getViews.js

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

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

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

package/out/api/models/groupCreate.js

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

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

@@ -0,0 +1,11 @@
+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/out/api/models/horizontalHeaderLookAndFeel.js

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

package/out/api/models/index.d.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/out/api/models/index.js

@@ -17,8 +17,6 @@ const tslib_1 = require("tslib");
 (0, tslib_1.__exportStar)(require("./bulkUserLookup"), exports);
 (0, tslib_1.__exportStar)(require("./bulkUserLookupArray"), exports);
 (0, tslib_1.__exportStar)(require("./buttonLookAndFeel"), exports);
-(0, tslib_1.__exportStar)(require("./cQLPersonalDataConvertedQueries"), exports);
-(0, tslib_1.__exportStar)(require("./cQLPersonalDataMigrationRequest"), exports);
 (0, tslib_1.__exportStar)(require("./changedValue"), exports);
 (0, tslib_1.__exportStar)(require("./connectModule"), exports);
 (0, tslib_1.__exportStar)(require("./connectModules"), exports);
@@ -33,8 +31,8 @@ const tslib_1 = require("tslib");
 (0, tslib_1.__exportStar)(require("./contentBody"), exports);
 (0, tslib_1.__exportStar)(require("./contentBodyCreate"), exports);
 (0, tslib_1.__exportStar)(require("./contentBodyCreateStorage"), exports);
-(0, tslib_1.__exportStar)(require("./contentChildType"), exports);
 (0, tslib_1.__exportStar)(require("./contentChildren"), exports);
+(0, tslib_1.__exportStar)(require("./contentChildType"), exports);
 (0, tslib_1.__exportStar)(require("./contentComment"), exports);
 (0, tslib_1.__exportStar)(require("./contentCreate"), exports);
 (0, tslib_1.__exportStar)(require("./contentHistory"), exports);
@@ -62,17 +60,23 @@ const tslib_1 = require("tslib");
 (0, tslib_1.__exportStar)(require("./copyPageHierarchyTitleOptions"), exports);
 (0, tslib_1.__exportStar)(require("./copyPageRequest"), exports);
 (0, tslib_1.__exportStar)(require("./copyPageRequestDestination"), exports);
+(0, tslib_1.__exportStar)(require("./cQLPersonalDataConvertedQueries"), exports);
+(0, tslib_1.__exportStar)(require("./cQLPersonalDataMigrationRequest"), exports);
 (0, tslib_1.__exportStar)(require("./deletedSpace"), exports);
 (0, tslib_1.__exportStar)(require("./dynamicModulesErrorMessage"), exports);
 (0, tslib_1.__exportStar)(require("./embeddable"), exports);
 (0, tslib_1.__exportStar)(require("./embeddedContent"), exports);
 (0, tslib_1.__exportStar)(require("./genericLinks"), exports);
 (0, tslib_1.__exportStar)(require("./getRestrictionsByOperation"), exports);
+(0, tslib_1.__exportStar)(require("./getViewers"), exports);
+(0, tslib_1.__exportStar)(require("./getViews"), exports);
 (0, tslib_1.__exportStar)(require("./group"), exports);
 (0, tslib_1.__exportStar)(require("./groupArray"), exports);
 (0, tslib_1.__exportStar)(require("./groupArrayWithLinks"), exports);
+(0, tslib_1.__exportStar)(require("./groupCreate"), exports);
 (0, tslib_1.__exportStar)(require("./groupName"), exports);
 (0, tslib_1.__exportStar)(require("./headerLookAndFeel"), exports);
+(0, tslib_1.__exportStar)(require("./horizontalHeaderLookAndFeel"), exports);
 (0, tslib_1.__exportStar)(require("./icon"), exports);
 (0, tslib_1.__exportStar)(require("./label"), exports);
 (0, tslib_1.__exportStar)(require("./labelArray"), exports);
@@ -115,6 +119,9 @@ const tslib_1 = require("tslib");
 (0, tslib_1.__exportStar)(require("./spaceDescription"), exports);
 (0, tslib_1.__exportStar)(require("./spaceDescriptionCreate"), exports);
 (0, tslib_1.__exportStar)(require("./spacePermission"), exports);
+(0, tslib_1.__exportStar)(require("./spacePermissionCreate"), exports);
+(0, tslib_1.__exportStar)(require("./spacePermissionCustomContent"), exports);
+(0, tslib_1.__exportStar)(require("./spacePermissionRequest"), exports);
 (0, tslib_1.__exportStar)(require("./spacePermissionV2"), exports);
 (0, tslib_1.__exportStar)(require("./spacePrivateCreate"), exports);
 (0, tslib_1.__exportStar)(require("./spaceProperty"), exports);
@@ -132,17 +139,19 @@ const tslib_1 = require("tslib");
 (0, tslib_1.__exportStar)(require("./systemInfoEntity"), exports);
 (0, tslib_1.__exportStar)(require("./task"), exports);
 (0, tslib_1.__exportStar)(require("./taskPageResponse"), exports);
+(0, tslib_1.__exportStar)(require("./taskStatusUpdate"), exports);
 (0, tslib_1.__exportStar)(require("./theme"), exports);
 (0, tslib_1.__exportStar)(require("./themeArray"), exports);
 (0, tslib_1.__exportStar)(require("./themeNoLinks"), exports);
 (0, tslib_1.__exportStar)(require("./themeUpdate"), exports);
+(0, tslib_1.__exportStar)(require("./topNavigationLookAndFeel"), exports);
 (0, tslib_1.__exportStar)(require("./user"), exports);
 (0, tslib_1.__exportStar)(require("./userAnonymous"), exports);
 (0, tslib_1.__exportStar)(require("./userArray"), exports);
 (0, tslib_1.__exportStar)(require("./userArrayWithLinks"), exports);
 (0, tslib_1.__exportStar)(require("./userDetails"), exports);
-(0, tslib_1.__exportStar)(require("./userWatch"), exports);
 (0, tslib_1.__exportStar)(require("./usersUserKeys"), exports);
+(0, tslib_1.__exportStar)(require("./userWatch"), exports);
 (0, tslib_1.__exportStar)(require("./version"), exports);
 (0, tslib_1.__exportStar)(require("./versionArray"), exports);
 (0, tslib_1.__exportStar)(require("./versionRestore"), exports);

package/out/api/models/lookAndFeel.d.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: {
         color: string;
@@ -14,4 +15,6 @@ export interface LookAndFeel {
     bordersAndDividers: {
         color: string;
     };
+    horizontalHeader?: HorizontalHeaderLookAndFeel;
+    spaceReference?: unknown;
 }

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

@@ -0,0 +1,33 @@
+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/out/api/models/spacePermissionCreate.js

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

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

@@ -0,0 +1,16 @@
+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/out/api/models/spacePermissionCustomContent.js

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

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

@@ -0,0 +1,41 @@
+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/out/api/models/spacePermissionRequest.js

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

package/out/api/models/spacePrivateCreate.d.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 {
     /** The key for the new space. Format: See [Space keys](https://confluence.atlassian.com/x/lqNMMQ). */
@@ -6,4 +7,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/out/api/models/spacePropertyCreate.d.ts

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

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

@@ -8,4 +8,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/out/api/models/taskStatusUpdate.d.ts

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

package/out/api/models/taskStatusUpdate.js

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

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

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

package/out/api/models/topNavigationLookAndFeel.js

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

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

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

package/out/api/parameters/addCustomContentPermissions.js

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

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

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

package/out/api/parameters/addPermissionToSpace.js

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

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

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

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

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

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

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

package/out/api/parameters/archivePages.js

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

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

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

package/out/api/parameters/checkContentPermission.js

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

package/out/api/parameters/deleteRelationship.d.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;
+}