@resolution/confluence-api-client 0.13.4 → 0.14.0

package/lib/openapi/v1/services/ContentCommentsService.d.ts

@@ -1,153 +0,0 @@
-import { CommonHttpService } from "../../core/CommonHttpService";
-import { type ContentArray } from "../models/common";
-/**
- * @deprecated
- * @see https://developer.atlassian.com/cloud/confluence/rest/v1/api-group-content-comments
- * @category Services
- */
-export declare class ContentCommentsService extends CommonHttpService {
-    /**
-     * Deprecated, use [Confluence's v2
-     * API](https://developer.atlassian.com/cloud/confluence/rest/v2/intro/).
-     *
-     * Returns the comments on a piece of content.
-     *
-     * If the expand query parameter is used with the `body.export_view` and/or
-     * `body.styled_view` properties, then the query limit parameter will be
-     * restricted to a maximum value of 25.
-     *
-     * **[Permissions](https://confluence.atlassian.com/x/_AozKw) required**: 'View'
-     * permission for the space,
-     * and permission to view the content if it is a page.
-     *
-     * @deprecated
-     * @returns Returned if the requested comments are returned.
-     * @path GET `/wiki/rest/api/content/{id}/child/comment`
-     * @scopes-current read:confluence-content.summary
-     * @scopes-beta read:content-details:confluence
-     * @see https://developer.atlassian.com/cloud/confluence/rest/v1/api-group-content-comments#api-wiki-rest-api-content-id-child-comment-get
-     * @param params
-     */
-    getContentComments: ({ id, expand, parentVersion, start, limit, location, depth }: {
-        /** The ID of the content to be queried for its comments. */
-        id: string;
-        /**
-         * A multi-value parameter indicating which properties of the content to expand.
-         *
-         * - `childTypes.all` returns whether the content has attachments, comments, or
-         * child pages/whiteboards.
-         * Use this if you only need to check whether the content has children of a
-         * particular type.
-         * - `childTypes.attachment` returns whether the content has attachments.
-         * - `childTypes.comment` returns whether the content has comments.
-         * - `childTypes.page` returns whether the content has child pages.
-         * - `childTypes.whiteboard` returns whether the content has child whiteboards.
-         * - `childTypes.database` returns whether the content has child databases.
-         * - `childTypes.embed` returns whether the content has child embeds (smartlinks).
-         * - `childTypes.folder` returns whether the content has child folders.
-         * - `container` returns the space that the content is in. This is the same as the
-         * information
-         * returned by [Get space](#api-space-spaceKey-get).
-         * - `metadata.currentuser` 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.
-         * - `metadata.properties` returns content properties that have been set via the
-         * Confluence REST API.
-         * - `metadata.labels` returns the labels that have been added to the content.
-         * - `metadata.frontend` this property is only used by Atlassian.
-         * - `operations` returns the operations for the content, which are used when
-         * setting permissions.
-         * - `children.page` returns pages that are descendants at the level immediately
-         * below the content.
-         * - `children.whiteboard` returns whiteboards that are descendants at the level
-         * immediately below the content.
-         * - `children.database` returns databases that are descendants at the level
-         * immediately below the content.
-         * - `children.embed` returns embeds (smartlinks) that are descendants at the
-         * level immediately below the content.
-         * - `children.folder` returns folders that are descendants at the level
-         * immediately below the content.
-         * - `children.attachment` returns all attachments for the content.
-         * - `children.comment` returns all comments on the content.
-         * - `restrictions.read.restrictions.user` returns the users that have permission
-         * to read the content.
-         * - `restrictions.read.restrictions.group` 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.
-         * - `restrictions.update.restrictions.user` returns the users that have
-         * permission to update the content.
-         * - `restrictions.update.restrictions.group` 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.
-         * - `history` returns the history of the content, including the date it was
-         * created.
-         * - `history.lastUpdated` returns information about the most recent update of the
-         * content, including
-         * who updated it and when it was updated.
-         * - `history.previousVersion` returns information about the update prior to the
-         * current content update.
-         * - `history.contributors` returns all of the users who have contributed to the
-         * content.
-         * - `history.nextVersion` returns information about the update after to the
-         * current content update.
-         * - `ancestors` returns the parent content, if the content is a page or
-         * whiteboard.
-         * - `body` returns the body of the content in different formats, including the
-         * editor format,
-         * view format, and export format.
-         * - `body.storage` returns the body of content in storage format.
-         * - `body.view` returns the body of content in view format.
-         * - `version` returns information about the most recent update of the content,
-         * including who updated it
-         * and when it was updated.
-         * - `descendants.page` returns pages that are descendants at any level below the
-         * content.
-         * - `descendants.whiteboard` returns whiteboards that are descendants at any
-         * level below the content.
-         * - `descendants.database` returns databases that are descendants at any level
-         * below the content.
-         * - `descendants.embed` returns embeds (smartlinks) that are descendants at any
-         * level below the content.
-         * - `descendants.folder` returns folders that are descendants at any level below
-         * the content.
-         * - `descendants.attachment` returns all attachments for the content, same as
-         * `children.attachment`.
-         * - `descendants.comment` returns all comments on the content, same as
-         * `children.comment`.
-         * - `space` returns the space that the content is in. This is the same as the
-         * information returned by
-         * [Get space](#api-space-spaceKey-get).
-         *
-         * In addition, the following comment-specific expansions can be used:
-         * - `extensions.inlineProperties` returns inline comment-specific properties.
-         * - `extensions.resolution` returns the resolution status of each comment.
-         */
-        expand?: string[] | undefined;
-        /**
-         * The version of the parent content to retrieve children for.
-         * Currently, this only works for the latest version.
-         */
-        parentVersion?: number | undefined;
-        /** The starting index of the returned comments. */
-        start?: number | undefined;
-        /**
-         * The maximum number of comments to return per page. Note,
-         * this may be restricted by fixed system limits.
-         */
-        limit?: number | undefined;
-        /**
-         * The location of the comments in the page. Multiple locations can be specified.
-         * If no location is specified, comments from all locations are returned.
-         */
-        location?: "inline" | "footer" | "resolved" | undefined;
-        /**
-         * Currently, this parameter is not used.
-         * Comments are returned at the root level only.
-         */
-        depth?: string | undefined;
-    }) => Promise<ContentArray>;
-    protected static initialize(): void;
-}

package/lib/openapi/v1/services/ContentCommentsService.js

@@ -1,81 +0,0 @@
-"use strict";
-Object.defineProperty(exports, "__esModule", { value: true });
-exports.ContentCommentsService = void 0;
-// DO NOT EDIT!
-// This file is generated by "api-typescript-generator".
-// To update this file run "yarn build:openapi".
-const commonHttpClient = require("../../core/CommonHttpClient");
-const CommonHttpService_1 = require("../../core/CommonHttpService");
-const common_1 = require("../models/common");
-const validationSchemaStorage_1 = require("../validationSchemaStorage");
-const zod_1 = require("zod");
-/**
- * @deprecated
- * @see https://developer.atlassian.com/cloud/confluence/rest/v1/api-group-content-comments
- * @category Services
- */
-class ContentCommentsService extends CommonHttpService_1.CommonHttpService {
-    constructor() {
-        super(...arguments);
-        /**
-         * Deprecated, use [Confluence's v2
-         * API](https://developer.atlassian.com/cloud/confluence/rest/v2/intro/).
-         *
-         * Returns the comments on a piece of content.
-         *
-         * If the expand query parameter is used with the `body.export_view` and/or
-         * `body.styled_view` properties, then the query limit parameter will be
-         * restricted to a maximum value of 25.
-         *
-         * **[Permissions](https://confluence.atlassian.com/x/_AozKw) required**: 'View'
-         * permission for the space,
-         * and permission to view the content if it is a page.
-         *
-         * @deprecated
-         * @returns Returned if the requested comments are returned.
-         * @path GET `/wiki/rest/api/content/{id}/child/comment`
-         * @scopes-current read:confluence-content.summary
-         * @scopes-beta read:content-details:confluence
-         * @see https://developer.atlassian.com/cloud/confluence/rest/v1/api-group-content-comments#api-wiki-rest-api-content-id-child-comment-get
-         * @param params
-         */
-        this.getContentComments = ({ id, expand, parentVersion, start, limit, location, depth }) => {
-            return this.getClientInstance().request({
-                path: "/wiki/rest/api/content/{id}/child/comment",
-                method: "GET",
-                pathParams: {
-                    id
-                },
-                query: {
-                    expand,
-                    parentVersion,
-                    start,
-                    limit,
-                    location,
-                    depth
-                },
-                parameters: {
-                    query: {
-                        expand: {
-                            explode: false
-                        }
-                    }
-                }
-            }).then(this.getClientInstance().responseHandler({
-                200: {
-                    "application/json": "json"
-                }
-            })).then(commonHttpClient.castResponse()).then(this.getClientInstance().validation(validationSchemaStorage_1.validationSchemaStorage.validator("ContentCommentsService.getContentComments.response"))).then(commonHttpClient.getBody);
-        };
-    }
-    static initialize() {
-        validationSchemaStorage_1.validationSchemaStorage.registerExtensible("ContentCommentsService.getContentComments.response", zod_1.z.object({
-            status: zod_1.z.literal(200),
-            mediaType: zod_1.z.literal("application/json"),
-            body: validationSchemaStorage_1.validationSchemaStorage.lazy("ContentArray")
-        }).describe("ContentCommentsService.getContentComments.response"));
-        validationSchemaStorage_1.validationSchemaStorage.registerOnce([common_1.registerCommonValidationSchemas]);
-    }
-}
-exports.ContentCommentsService = ContentCommentsService;
-//# sourceMappingURL=ContentCommentsService.js.map

package/lib/openapi/v1/services/ContentCommentsService.js.map

@@ -1 +0,0 @@
-{"version":3,"file":"ContentCommentsService.js","sourceRoot":"","sources":["../../../../src/openapi/v1/services/ContentCommentsService.ts"],"names":[],"mappings":";;;AAAA,eAAe;AACf,wDAAwD;AACxD,gDAAgD;AAChD,gEAAgE;AAChE,oEAAiE;AACjE,6CAAsF;AACtF,wEAAqE;AACrE,6BAAwB;AACxB;;;;GAIG;AACH,MAAa,sBAAuB,SAAQ,qCAAiB;IAA7D;;QACE;;;;;;;;;;;;;;;;;;;;;WAqBG;QACH,uBAAkB,GAAG,CAAC,EACpB,EAAE,EACF,MAAM,EACN,aAAa,EACb,KAAK,EACL,KAAK,EACL,QAAQ,EACR,KAAK,EAyHN,EAAyB,EAAE;YAC1B,OAAO,IAAI,CAAC,iBAAiB,EAAE,CAAC,OAAO,CAAC;gBACtC,IAAI,EAAE,2CAA2C;gBACjD,MAAM,EAAE,KAAK;gBACb,UAAU,EAAE;oBACV,EAAE;iBACH;gBACD,KAAK,EAAE;oBACL,MAAM;oBACN,aAAa;oBACb,KAAK;oBACL,KAAK;oBACL,QAAQ;oBACR,KAAK;iBACN;gBACD,UAAU,EAAE;oBACV,KAAK,EAAE;wBACL,MAAM,EAAE;4BACN,OAAO,EAAE,KAAK;yBACf;qBACF;iBACF;aACF,CAAC,CAAC,IAAI,CAAC,IAAI,CAAC,iBAAiB,EAAE,CAAC,eAAe,CAAC;gBAC/C,GAAG,EAAE;oBACH,kBAAkB,EAAE,MAAM;iBAC3B;aACF,CAAC,CAAC,CAAC,IAAI,CAAC,gBAAgB,CAAC,YAAY,EAIlC,CAAC,CAAC,IAAI,CAAC,IAAI,CAAC,iBAAiB,EAAE,CAAC,UAAU,CAAC,iDAAuB,CAAC,SAAS,CAAC,oDAAoD,CAAC,CAAC,CAAC,CAAC,IAAI,CAAC,gBAAgB,CAAC,OAAO,CAAC,CAAC;QAC1K,CAAC,CAAC;IASJ,CAAC;IARW,MAAM,CAAC,UAAU;QACzB,iDAAuB,CAAC,kBAAkB,CAAC,oDAAoD,EAAE,OAAC,CAAC,MAAM,CAAC;YACxG,MAAM,EAAE,OAAC,CAAC,OAAO,CAAC,GAAG,CAAC;YACtB,SAAS,EAAE,OAAC,CAAC,OAAO,CAAC,kBAAkB,CAAC;YACxC,IAAI,EAAE,iDAAuB,CAAC,IAAI,CAAC,cAAc,CAAC;SACnD,CAAC,CAAC,QAAQ,CAAC,oDAAoD,CAAC,CAAC,CAAC;QACnE,iDAAuB,CAAC,YAAY,CAAC,CAAC,wCAA+B,CAAC,CAAC,CAAC;IAC1E,CAAC;CACF;AA/LD,wDA+LC"}

package/lib/openapi/v1/services/ContentPropertiesService.d.ts

@@ -1,203 +0,0 @@
-import { CommonHttpService } from "../../core/CommonHttpService";
-import { type ContentPropertyArray, type ContentPropertyCreate, type ContentPropertyV1, type ContentPropertyUpdate, type ContentPropertyCreateNoKey } from "../models/contentProperties";
-/**
- * @deprecated
- * @see https://developer.atlassian.com/cloud/confluence/rest/v1/api-group-content-properties
- * @category Services
- */
-export declare class ContentPropertiesService extends CommonHttpService {
-    /**
-     * Creates a property for an existing piece of content. For more information
-     * about content properties, see [Confluence entity
-     * properties](https://developer.atlassian.com/cloud/confluence/confluence-entity-properties/).
-     *
-     * This is the same as [Create content property for
-     * key](#api-content-id-property-key-post)
-     * except that the key is specified in the request body instead of as a
-     * path parameter.
-     *
-     * Content properties can also be added when creating a new piece of content
-     * by including them in the `metadata.properties` of the request.
-     *
-     * **[Permissions](https://confluence.atlassian.com/x/_AozKw) required**:
-     * Permission to update the content.
-     *
-     * @deprecated
-     * @returns Returned if the content property is created.
-     * @path POST `/wiki/rest/api/content/{id}/property`
-     * @scopes-current write:confluence-props
-     * @scopes-beta read:content.property:confluence, write:content.property:confluence
-     * @see https://developer.atlassian.com/cloud/confluence/rest/v1/api-group-content-properties#api-wiki-rest-api-content-id-property-post
-     * @param params
-     */
-    createContentProperty: ({ id, contentPropertyCreate }: {
-        /** The ID of the content to add the property to. */
-        id: string;
-        /** The content property to be created. */
-        contentPropertyCreate: ContentPropertyCreate;
-    }) => Promise<ContentPropertyV1>;
-    /**
-     * Creates a property for an existing piece of content. For more information
-     * about content properties, see [Confluence entity
-     * properties](https://developer.atlassian.com/cloud/confluence/confluence-entity-properties/).
-     *
-     * This is the same as [Create content property](#api-content-id-property-post)
-     * except that the key is specified as a path parameter instead of in the
-     * request body.
-     *
-     * Content properties can also be added when creating a new piece of content
-     * by including them in the `metadata.properties` of the request.
-     *
-     * **[Permissions](https://confluence.atlassian.com/x/_AozKw) required**:
-     * Permission to update the content.
-     *
-     * @deprecated
-     * @returns Returned if the content property is created.
-     * @path POST `/wiki/rest/api/content/{id}/property/{key}`
-     * @scopes-current write:confluence-props
-     * @scopes-beta read:content.property:confluence, write:content.property:confluence
-     * @see https://developer.atlassian.com/cloud/confluence/rest/v1/api-group-content-properties#api-wiki-rest-api-content-id-property-key-post
-     * @param params
-     */
-    createContentPropertyForKey: ({ id, key, contentPropertyCreateNoKey }: {
-        /** The ID of the content to add the property to. */
-        id: string;
-        /** The key of the content property. Required. */
-        key: string;
-        /** The content property to be created. */
-        contentPropertyCreateNoKey: ContentPropertyCreateNoKey;
-    }) => Promise<ContentPropertyV1>;
-    /**
-     * Deletes a content property. For more information about content properties, see
-     * [Confluence entity
-     * properties](https://developer.atlassian.com/cloud/confluence/confluence-entity-properties/).
-     *
-     * **[Permissions](https://confluence.atlassian.com/x/_AozKw) required**:
-     * Permission to update the content.
-     *
-     * @deprecated
-     * @path DELETE `/wiki/rest/api/content/{id}/property/{key}`
-     * @scopes-current write:confluence-props
-     * @scopes-beta write:content.property:confluence
-     * @see https://developer.atlassian.com/cloud/confluence/rest/v1/api-group-content-properties#api-wiki-rest-api-content-id-property-key-delete
-     * @param params
-     */
-    deleteContentProperty: ({ id, key }: {
-        /** The ID of the content that the property belongs to. */
-        id: string;
-        /** The key of the property. */
-        key: string;
-    }) => Promise<void>;
-    /**
-     * Returns the properties for a piece of content. For more information
-     * about content properties, see [Confluence entity
-     * properties](https://developer.atlassian.com/cloud/confluence/confluence-entity-properties/).
-     *
-     * **[Permissions](https://confluence.atlassian.com/x/_AozKw) required**:
-     * 'View' permission for the space, and permission to view the content if it is a
-     * page.
-     *
-     * @deprecated
-     * @returns Returned if the requested properties are returned.
-     * @path GET `/wiki/rest/api/content/{id}/property`
-     * @scopes-current read:confluence-props
-     * @scopes-beta read:content-details:confluence
-     * @see https://developer.atlassian.com/cloud/confluence/rest/v1/api-group-content-properties#api-wiki-rest-api-content-id-property-get
-     * @param params
-     */
-    getContentProperties: ({ id, key, expand, start, limit }: {
-        /** The ID of the content to be queried for its properties. */
-        id: string;
-        /** The key of the content property. */
-        key?: string[] | undefined;
-        /**
-         * A multi-value parameter indicating which properties of the content to
-         * expand. By default, the `version` object is expanded.
-         *
-         * - `content` returns the content that the property is stored against.
-         * - `version` returns information about the version of the property, such
-         * as the version number, when it was created, etc.
-         */
-        expand?: ("content" | "version")[] | undefined;
-        /** The starting index of the returned properties. */
-        start?: number | undefined;
-        /**
-         * The maximum number of properties to return per page.
-         * Note, this may be restricted by fixed system limits.
-         */
-        limit?: number | undefined;
-    }) => Promise<ContentPropertyArray>;
-    /**
-     * Returns a content property for a piece of content. For more information, see
-     * [Confluence entity
-     * properties](https://developer.atlassian.com/cloud/confluence/confluence-entity-properties/).
-     *
-     * **[Permissions](https://confluence.atlassian.com/x/_AozKw) required**:
-     * 'View' permission for the space, and permission to view the content if it is a
-     * page.
-     *
-     * @deprecated
-     * @returns Returned if the content property is returned.
-     * @path GET `/wiki/rest/api/content/{id}/property/{key}`
-     * @scopes-current read:confluence-props
-     * @scopes-beta read:content-details:confluence
-     * @see https://developer.atlassian.com/cloud/confluence/rest/v1/api-group-content-properties#api-wiki-rest-api-content-id-property-key-get
-     * @param params
-     */
-    getContentProperty: ({ id, key, expand, status }: {
-        /** The ID of the content to be queried for the property. */
-        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.
-         *
-         * - `content` returns the content that the property is stored against.
-         * - `version` returns information about the version of the property, such
-         * as the version number, when it was created, etc.
-         */
-        expand?: ("content" | "version")[] | undefined;
-        /**
-         * 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?: "current" | "any" | "deleted" | "draft" | "trashed" | "archived" | undefined;
-    }) => Promise<ContentPropertyV1>;
-    /**
-     * Updates an existing content property. This method will also create a new
-     * property for a piece of content, if the property key does not exist and
-     * the property version is 1. For more information about content properties, see
-     * [Confluence entity
-     * properties](https://developer.atlassian.com/cloud/confluence/confluence-entity-properties/).
-     *
-     * **[Permissions](https://confluence.atlassian.com/x/_AozKw) required**:
-     * Permission to update the content.
-     *
-     * @deprecated
-     * @returns Returned if the content property is created.
-     * @path PUT `/wiki/rest/api/content/{id}/property/{key}`
-     * @scopes-current write:confluence-props
-     * @scopes-beta read:content.property:confluence, write:content.property:confluence
-     * @see https://developer.atlassian.com/cloud/confluence/rest/v1/api-group-content-properties#api-wiki-rest-api-content-id-property-key-put
-     * @param params
-     */
-    updateContentProperty: ({ id, key, contentPropertyUpdate }: {
-        /** The ID of the content that the property belongs to. */
-        id: string;
-        /** The key of the property. */
-        key: string;
-        /** The content property being updated. */
-        contentPropertyUpdate: ContentPropertyUpdate;
-    }) => Promise<ContentPropertyV1>;
-    protected static initialize(): void;
-}