confluence.js 1.2.2 → 1.4.0

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

@@ -1,5 +1,5 @@
-import { ThemeNoLinks } from './themeNoLinks';
 import { GenericLinks } from './genericLinks';
+import { ThemeNoLinks } from './themeNoLinks';
 export interface ThemeArray {
     results: ThemeNoLinks[];
     start: number;

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

@@ -1,8 +1,8 @@
+import { GenericLinks } from './genericLinks';
 import { Icon } from './icon';
 import { OperationCheckResult } from './operationCheckResult';
-import { UserDetails } from './userDetails';
 import { Space } from './space';
-import { GenericLinks } from './genericLinks';
+import { UserDetails } from './userDetails';
 export interface User {
     type: string;
     /**

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

@@ -1,6 +1,6 @@
+import { GenericLinks } from './genericLinks';
 import { Icon } from './icon';
 import { OperationCheckResult } from './operationCheckResult';
-import { GenericLinks } from './genericLinks';
 export interface UserAnonymous {
     type: string;
     profilePicture: Icon;

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

@@ -0,0 +1,13 @@
+import { GenericLinks } from './genericLinks';
+export interface UserProperty {
+    key: string;
+    /** The value of the content property. */
+    value: {};
+    /** A unique identifier for the user property */
+    id: string;
+    /** Datetime when the property was last modified such as `2022-02-01T12:00:00.111Z` */
+    lastModifiedDate: string;
+    /** Datetime when the property was created such as `2022-01-01T12:00:00.111Z` */
+    createdDate: string;
+    Links?: GenericLinks;
+}

package/out/api/models/userProperty.js

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

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

@@ -0,0 +1,4 @@
+export interface UserPropertyCreate {
+    /** The value of the user property. */
+    value: {};
+}

package/out/api/models/userPropertyCreate.js

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

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

@@ -0,0 +1,10 @@
+import { GenericLinks } from './genericLinks';
+export interface UserPropertyKeyArray {
+    results: {
+        key?: string;
+    }[];
+    start?: number;
+    limit?: number;
+    size?: number;
+    Links?: GenericLinks;
+}

package/out/api/models/userPropertyKeyArray.js

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

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

@@ -0,0 +1,4 @@
+export interface UserPropertyUpdate {
+    /** The value of the user property. */
+    value: {};
+}

package/out/api/models/userPropertyUpdate.js

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

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

@@ -1,5 +1,5 @@
-import { User } from './user';
 import { GenericLinks } from './genericLinks';
+import { User } from './user';
 export interface UsersUserKeys {
     users: User[];
     userKeys: string[];

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

@@ -1,7 +1,7 @@
-import { User } from './user';
 import { Content } from './content';
-import { UsersUserKeys } from './usersUserKeys';
 import { GenericLinks } from './genericLinks';
+import { User } from './user';
+import { UsersUserKeys } from './usersUserKeys';
 export interface Version {
     by: User;
     when: string;

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

@@ -1,5 +1,5 @@
-import { Version } from './version';
 import { GenericLinks } from './genericLinks';
+import { Version } from './version';
 export interface VersionArray {
     results: Version[];
     start: number;

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

@@ -1,5 +1,5 @@
-import { Watch } from './watch';
 import { GenericLinks } from './genericLinks';
+import { Watch } from './watch';
 export interface WatchArray {
     results: Watch[];
     start: number;

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

@@ -0,0 +1,10 @@
+import { UserPropertyCreate } from '../models';
+export interface CreateUserProperty extends UserPropertyCreate {
+    /**
+     * The account ID of the user. The accountId uniquely identifies the user across all Atlassian products. For
+     * example, 384093:32b4d9w0-f6a5-3535-11a3-9c8c88d10192
+     */
+    userId: string;
+    /** The key of the user property. */
+    key: string;
+}

package/out/api/parameters/createUserProperty.js

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

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

@@ -0,0 +1,4 @@
+export interface DeletePageTree {
+    /** The ID of the content which forms root of the page tree, to be deleted. */
+    id: string;
+}

package/out/api/parameters/deletePageTree.js

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

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

@@ -0,0 +1,9 @@
+export interface DeleteUserProperty {
+    /**
+     * The account ID of the user. The accountId uniquely identifies the user across all Atlassian products. For
+     * example, 384093:32b4d9w0-f6a5-3535-11a3-9c8c88d10192
+     */
+    userId: string;
+    /** The key of the user property. */
+    key: string;
+}

package/out/api/parameters/deleteUserProperty.js

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

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

@@ -0,0 +1,4 @@
+export interface GetAvailableContentStates {
+    /** Id of content to get available states for */
+    contentId: string;
+}

package/out/api/parameters/getAvailableContentStates.js

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

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

@@ -0,0 +1,6 @@
+export interface GetContentState {
+    /** The Id of the page whose content state is of interest. */
+    contentId: string;
+    /** Set designation=DRAFT or designation=PUBLISHED. */
+    designation?: string;
+}

package/out/api/parameters/getContentState.js

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

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

@@ -0,0 +1,4 @@
+export interface GetContentStateLastUpdated {
+    /** Id of Content to get information for */
+    contentId: string;
+}

package/out/api/parameters/getContentStateLastUpdated.js

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

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

@@ -0,0 +1,4 @@
+export interface GetContentStateSettings {
+    /** SpaceKey */
+    spaceKey: string;
+}

package/out/api/parameters/getContentStateSettings.js

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

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

@@ -5,4 +5,9 @@ export interface GetGroupMembersByGroupId {
     start?: number;
     /** The maximum number of users to return per page. Note, this may be restricted by fixed system limits. */
     limit?: number;
+    /**
+     * Whether to include total size parameter in the results. Note, fetching total size property is an expensive
+     * operation; use it if your use case needs this value.
+     */
+    shouldReturnTotalSize?: boolean;
 }

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

@@ -8,4 +8,9 @@ export interface GetMembersByQueryParam {
      * say if the limit parameter exceeds 200, this API will return a maximum of 200 users per page.
      */
     limit?: number;
+    /**
+     * Whether to include total size parameter in the results. Note, fetching total size property is an expensive
+     * operation; use it if your use case needs this value.
+     */
+    shouldReturnTotalSize?: boolean;
 }

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

@@ -21,7 +21,7 @@ export interface GetSpaces {
      */
     favouriteUserKey?: string;
     /** A multi-value parameter indicating which properties of the content to expand. */
-    expand?: string[];
+    expand?: 'settings' | 'metadata' | 'metadata.labels' | 'operations' | 'lookAndFeel' | 'permissions' | 'icon' | 'description' | 'description.plain' | 'description.view' | 'theme' | 'homepage' | 'history' | ('settings' | 'metadata' | 'metadata.labels' | 'operations' | 'lookAndFeel' | 'permissions' | 'icon' | 'description' | 'description.plain' | 'description.view' | 'theme' | 'homepage' | 'history')[] | string | string[];
     /** The starting index of the returned spaces. */
     start?: number;
     /** The maximum number of spaces to return per page. Note, this may be restricted by fixed system limits. */

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

@@ -0,0 +1,8 @@
+export interface GetUserProperties {
+    /** The account ID of the user to be queried for its properties. */
+    userId: string;
+    /** The starting index of the returned properties. */
+    start?: number;
+    /** The maximum number of properties to return per page. Note, this may be restricted by fixed system limits. */
+    limit?: number;
+}

package/out/api/parameters/getUserProperties.js

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

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

@@ -0,0 +1,6 @@
+export interface GetUserProperty {
+    /** The account ID of the user to be queried for its properties. */
+    userId: string;
+    /** The key of the user property. */
+    key: string;
+}

package/out/api/parameters/getUserProperty.js

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

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

@@ -30,15 +30,18 @@ export * from './createRelationship';
 export * from './createSpace';
 export * from './createSpaceProperty';
 export * from './createSpacePropertyForKey';
+export * from './createUserProperty';
 export * from './delete';
 export * from './deleteContent';
 export * from './deleteContentProperty';
 export * from './deleteContentVersion';
 export * from './deleteLabelFromSpace';
+export * from './deletePageTree';
 export * from './deleteRelationship';
 export * from './deleteRestrictions';
 export * from './deleteSpace';
 export * from './deleteSpaceProperty';
+export * from './deleteUserProperty';
 export * from './descendantsOfType';
 export * from './downloadAttachment';
 export * from './exportAuditRecords';
@@ -49,6 +52,7 @@ export * from './getAnonymousUser';
 export * from './getAttachments';
 export * from './getAuditRecords';
 export * from './getAuditRecordsForTimePeriod';
+export * from './getAvailableContentStates';
 export * from './getBlueprintTemplates';
 export * from './getBulkUserLookup';
 export * from './getBulkUserMigration';
@@ -64,6 +68,9 @@ export * from './getContentProperties';
 export * from './getContentProperty';
 export * from './getContentRestrictionStatusForGroup';
 export * from './getContentRestrictionStatusForUser';
+export * from './getContentState';
+export * from './getContentStateLastUpdated';
+export * from './getContentStateSettings';
 export * from './getContentTemplate';
 export * from './getContentTemplates';
 export * from './getContentVersion';
@@ -105,6 +112,8 @@ export * from './getTasks';
 export * from './getTheme';
 export * from './getThemes';
 export * from './getUser';
+export * from './getUserProperties';
+export * from './getUserProperty';
 export * from './getViewers';
 export * from './getViews';
 export * from './getWatchersForSpace';
@@ -117,6 +126,7 @@ export * from './permissionCheck';
 export * from './publishLegacyDraft';
 export * from './publishSharedDraft';
 export * from './registerModules';
+export * from './removeContentState';
 export * from './removeContentWatcher';
 export * from './removeGroup';
 export * from './removeGroupById';
@@ -140,6 +150,7 @@ export * from './searchContentByCQL';
 export * from './searchGroups';
 export * from './searchTasks';
 export * from './searchUser';
+export * from './setContentState';
 export * from './setLookAndFeelSettings';
 export * from './setRetentionPeriod';
 export * from './setSpaceTheme';
@@ -155,4 +166,5 @@ export * from './updateSpace';
 export * from './updateSpaceProperty';
 export * from './updateSpaceSettings';
 export * from './updateTaskById';
+export * from './updateUserProperty';
 export * from './userSearch';