@resolution/confluence-api-client 0.2.0

package/lib/openapi/v2/services/AttachmentService.d.ts

@@ -0,0 +1,307 @@
+import { CommonHttpService } from "../core/CommonHttpService";
+import { type AttachmentBulk, type AttachmentSingle, type AttachmentSortOrder } from "../models/attachment";
+import { type MultiEntityLinks } from "../models/common";
+export declare class AttachmentService extends CommonHttpService {
+    /**
+     * Delete an attachment by id.
+     *
+     * Deleting an attachment moves the attachment to the trash, where it can be
+     * restored later. To permanently delete an attachment (or "purge" it),
+     * the endpoint must be called on a **trashed** attachment with the following
+     * param `purge=true`.
+     *
+     * **[Permissions](https://confluence.atlassian.com/x/_AozKw) required**:
+     * Permission to view the container of the attachment.
+     * Permission to delete attachments in the space.
+     * Permission to administer the space (if attempting to purge).
+     *
+     * @path {DELETE} /attachments/{id}
+     * @scopes-current delete:attachment:confluence
+     */
+    deleteAttachment({ id, purge, }: {
+        /** The ID of the attachment to be deleted. */
+        id: number;
+        /** If attempting to purge the attachment. */
+        purge?: boolean;
+    }): Promise<void>;
+    /**
+     * Returns a specific attachment.
+     *
+     * **[Permissions](https://confluence.atlassian.com/x/_AozKw) required**:
+     * Permission to view the attachment's container.
+     *
+     * @returns Returned if the requested attachment is returned.
+     * @path {GET} /attachments/{id}
+     * @scopes-current read:attachment:confluence
+     */
+    getAttachmentById({ id, version, includeLabels, includeProperties, includeOperations, includeVersions, includeVersion, }: {
+        /**
+         * The ID of the attachment to be returned. If you don't know the attachment's ID,
+         * use Get attachments for page/blogpost/custom content.
+         */
+        id: string;
+        /**
+         * Allows you to retrieve a previously published version. Specify the previous
+         * version's number to retrieve its details.
+         */
+        version?: number;
+        /**
+         * Includes labels associated with this attachment in the response.
+         * The number of results will be limited to 50 and sorted in the default sort
+         * order.
+         * A `meta` and `_links` property will be present to indicate if more results are
+         * available and a link to retrieve the rest of the results.
+         */
+        includeLabels?: boolean;
+        /**
+         * Includes content properties associated with this attachment in the response.
+         * The number of results will be limited to 50 and sorted in the default sort
+         * order.
+         * A `meta` and `_links` property will be present to indicate if more results are
+         * available and a link to retrieve the rest of the results.
+         */
+        includeProperties?: boolean;
+        /**
+         * Includes operations associated with this attachment in the response.
+         * The number of results will be limited to 50 and sorted in the default sort
+         * order.
+         * A `meta` and `_links` property will be present to indicate if more results are
+         * available and a link to retrieve the rest of the results.
+         */
+        includeOperations?: boolean;
+        /**
+         * Includes versions associated with this attachment in the response.
+         * The number of results will be limited to 50 and sorted in the default sort
+         * order.
+         * A `meta` and `_links` property will be present to indicate if more results are
+         * available and a link to retrieve the rest of the results.
+         */
+        includeVersions?: boolean;
+        /**
+         * Includes the current version associated with this attachment in the response.
+         * By default this is included and can be omitted by setting the value to `false`.
+         */
+        includeVersion?: boolean;
+    }): Promise<AttachmentSingle & ({
+        _links?: {
+            /** Base url of the Confluence site. */
+            base?: string;
+        } & {
+            [key: string]: unknown;
+        };
+    } & {
+        [key: string]: unknown;
+    })>;
+    /**
+     * Returns all attachments. The number of results is limited by the `limit`
+     * parameter and additional results (if available)
+     * will be available through the `next` URL present in the `Link` response header.
+     *
+     * **[Permissions](https://confluence.atlassian.com/x/_AozKw) required**:
+     * Permission to view the container of the attachment.
+     *
+     * @returns Returned if the requested attachments are returned.
+     * @path {GET} /attachments
+     * @scopes-current read:attachment:confluence
+     */
+    getAttachments({ sort, cursor, status, mediaType, filename, limit, }: {
+        /** Used to sort the result by a particular field. */
+        sort?: AttachmentSortOrder;
+        /**
+         * Used for pagination, this opaque cursor will be returned in the `next` URL in
+         * the `Link` response header. Use the relative URL in the `Link` header to
+         * retrieve the `next` set of results.
+         */
+        cursor?: string;
+        /**
+         * Filter the results to attachments based on their status. By default, `current`
+         * and `archived` are used.
+         */
+        status?: ("current" | "archived" | "trashed")[];
+        /** Filters on the mediaType of attachments. Only one may be specified. */
+        mediaType?: string;
+        /** Filters on the file-name of attachments. Only one may be specified. */
+        filename?: string;
+        /**
+         * Maximum number of attachments per result to return. If more results exist, use
+         * the `Link` header to retrieve a relative URL that will return the next set of
+         * results.
+         */
+        limit?: number;
+    }): Promise<{
+        results?: AttachmentBulk[];
+        _links?: MultiEntityLinks;
+    } & {
+        [key: string]: unknown;
+    }>;
+    /**
+     * Returns the attachments of specific blog post. The number of results is limited
+     * by the `limit` parameter and additional results (if available)
+     * will be available through the `next` URL present in the `Link` response header.
+     *
+     * **[Permissions](https://confluence.atlassian.com/x/_AozKw) required**:
+     * Permission to view the content of the blog post and its corresponding space.
+     *
+     * @returns Returned if the requested attachments are returned.
+     * @path {GET} /blogposts/{id}/attachments
+     * @scopes-current read:attachment:confluence
+     */
+    getBlogpostAttachments({ id, sort, cursor, status, mediaType, filename, limit, }: {
+        /** The ID of the blog post for which attachments should be returned. */
+        id: number;
+        /** Used to sort the result by a particular field. */
+        sort?: AttachmentSortOrder;
+        /**
+         * Used for pagination, this opaque cursor will be returned in the `next` URL in
+         * the `Link` response header. Use the relative URL in the `Link` header to
+         * retrieve the `next` set of results.
+         */
+        cursor?: string;
+        /**
+         * Filter the results to attachments based on their status. By default, `current`
+         * and `archived` are used.
+         */
+        status?: ("current" | "archived" | "trashed")[];
+        /** Filters on the mediaType of attachments. Only one may be specified. */
+        mediaType?: string;
+        /** Filters on the file-name of attachments. Only one may be specified. */
+        filename?: string;
+        /**
+         * Maximum number of attachments per result to return. If more results exist, use
+         * the `Link` header to retrieve a relative URL that will return the next set of
+         * results.
+         */
+        limit?: number;
+    }): Promise<{
+        results?: AttachmentBulk[];
+        _links?: MultiEntityLinks;
+    } & {
+        [key: string]: unknown;
+    }>;
+    /**
+     * Returns the attachments of specific custom content. The number of results is
+     * limited by the `limit` parameter and additional results (if available)
+     * will be available through the `next` URL present in the `Link` response header.
+     *
+     * **[Permissions](https://confluence.atlassian.com/x/_AozKw) required**:
+     * Permission to view the content of the custom content and its corresponding
+     * space.
+     *
+     * @returns Returned if the requested attachments are returned.
+     * @path {GET} /custom-content/{id}/attachments
+     * @scopes-current read:attachment:confluence
+     */
+    getCustomContentAttachments({ id, sort, cursor, status, mediaType, filename, limit, }: {
+        /** The ID of the custom content for which attachments should be returned. */
+        id: number;
+        /** Used to sort the result by a particular field. */
+        sort?: AttachmentSortOrder;
+        /**
+         * Used for pagination, this opaque cursor will be returned in the `next` URL in
+         * the `Link` response header. Use the relative URL in the `Link` header to
+         * retrieve the `next` set of results.
+         */
+        cursor?: string;
+        /**
+         * Filter the results to attachments based on their status. By default, `current`
+         * and `archived` are used.
+         */
+        status?: ("current" | "archived" | "trashed")[];
+        /** Filters on the mediaType of attachments. Only one may be specified. */
+        mediaType?: string;
+        /** Filters on the file-name of attachments. Only one may be specified. */
+        filename?: string;
+        /**
+         * Maximum number of attachments per result to return. If more results exist, use
+         * the `Link` header to retrieve a relative URL that will return the next set of
+         * results.
+         */
+        limit?: number;
+    }): Promise<{
+        results?: AttachmentBulk[];
+        _links?: MultiEntityLinks;
+    } & {
+        [key: string]: unknown;
+    }>;
+    /**
+     * Returns the attachments of specified label. The number of results is limited by
+     * the `limit` parameter and additional results (if available)
+     * will be available through the `next` URL present in the `Link` response header.
+     *
+     * **[Permissions](https://confluence.atlassian.com/x/_AozKw) required**:
+     * Permission to view the attachment and its corresponding space.
+     *
+     * @returns Returned if the requested attachments for specified label were successfully
+     * fetched.
+     * @path {GET} /labels/{id}/attachments
+     * @scopes-current read:attachment:confluence
+     */
+    getLabelAttachments({ id, sort, cursor, limit, }: {
+        /** The ID of the label for which attachments should be returned. */
+        id: number;
+        /** Used to sort the result by a particular field. */
+        sort?: AttachmentSortOrder;
+        /**
+         * Used for pagination, this opaque cursor will be returned in the `next` URL in
+         * the `Link` response header. Use the relative URL in the `Link` header to
+         * retrieve the `next` set of results.
+         */
+        cursor?: string;
+        /**
+         * Maximum number of pages per result to return. If more results exist, use the
+         * `Link` header to retrieve a relative URL that will return the next set of
+         * results.
+         */
+        limit?: number;
+    }): Promise<{
+        results?: AttachmentBulk[];
+        _links?: MultiEntityLinks;
+    } & {
+        [key: string]: unknown;
+    }>;
+    /**
+     * Returns the attachments of specific page. The number of results is limited by
+     * the `limit` parameter and additional results (if available)
+     * will be available through the `next` URL present in the `Link` response header.
+     *
+     * **[Permissions](https://confluence.atlassian.com/x/_AozKw) required**:
+     * Permission to view the content of the page and its corresponding space.
+     *
+     * @returns Returned if the requested attachments are returned.
+     * @path {GET} /pages/{id}/attachments
+     * @scopes-current read:attachment:confluence
+     */
+    getPageAttachments({ id, sort, cursor, status, mediaType, filename, limit, }: {
+        /** The ID of the page for which attachments should be returned. */
+        id: number;
+        /** Used to sort the result by a particular field. */
+        sort?: AttachmentSortOrder;
+        /**
+         * Used for pagination, this opaque cursor will be returned in the `next` URL in
+         * the `Link` response header. Use the relative URL in the `Link` header to
+         * retrieve the `next` set of results.
+         */
+        cursor?: string;
+        /**
+         * Filter the results to attachments based on their status. By default, `current`
+         * and `archived` are used.
+         */
+        status?: ("current" | "archived" | "trashed")[];
+        /** Filters on the mediaType of attachments. Only one may be specified. */
+        mediaType?: string;
+        /** Filters on the file-name of attachments. Only one may be specified. */
+        filename?: string;
+        /**
+         * Maximum number of attachments per result to return. If more results exist, use
+         * the `Link` header to retrieve a relative URL that will return the next set of
+         * results.
+         */
+        limit?: number;
+    }): Promise<{
+        results?: AttachmentBulk[];
+        _links?: MultiEntityLinks;
+    } & {
+        [key: string]: unknown;
+    }>;
+    static initialize(): void;
+}

package/lib/openapi/v2/services/AttachmentService.js

@@ -0,0 +1,370 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.AttachmentService = void 0;
+// DO NOT EDIT!
+// This file is generated by "api-typescript-generator".
+// To update this file run "yarn build:openapi".
+const zod_1 = require("zod");
+const commonHttpClient = require("../core/CommonHttpClient");
+const CommonHttpService_1 = require("../core/CommonHttpService");
+const attachment_1 = require("../models/attachment");
+const common_1 = require("../models/common");
+const validationSchemaStorage_1 = require("../validationSchemaStorage");
+class AttachmentService extends CommonHttpService_1.CommonHttpService {
+    /**
+     * Delete an attachment by id.
+     *
+     * Deleting an attachment moves the attachment to the trash, where it can be
+     * restored later. To permanently delete an attachment (or "purge" it),
+     * the endpoint must be called on a **trashed** attachment with the following
+     * param `purge=true`.
+     *
+     * **[Permissions](https://confluence.atlassian.com/x/_AozKw) required**:
+     * Permission to view the container of the attachment.
+     * Permission to delete attachments in the space.
+     * Permission to administer the space (if attempting to purge).
+     *
+     * @path {DELETE} /attachments/{id}
+     * @scopes-current delete:attachment:confluence
+     */
+    deleteAttachment({ id, purge, }) {
+        return this.getClientInstance()
+            .request({
+            path: "/attachments/{id}",
+            method: "DELETE",
+            pathParams: {
+                id,
+            },
+            query: {
+                purge,
+            },
+        })
+            .then(commonHttpClient.discardResult);
+    }
+    /**
+     * Returns a specific attachment.
+     *
+     * **[Permissions](https://confluence.atlassian.com/x/_AozKw) required**:
+     * Permission to view the attachment's container.
+     *
+     * @returns Returned if the requested attachment is returned.
+     * @path {GET} /attachments/{id}
+     * @scopes-current read:attachment:confluence
+     */
+    getAttachmentById({ id, version, includeLabels, includeProperties, includeOperations, includeVersions, includeVersion, }) {
+        return this.getClientInstance()
+            .request({
+            path: "/attachments/{id}",
+            method: "GET",
+            pathParams: {
+                id,
+            },
+            query: {
+                version,
+                "include-labels": includeLabels,
+                "include-properties": includeProperties,
+                "include-operations": includeOperations,
+                "include-versions": includeVersions,
+                "include-version": includeVersion,
+            },
+        })
+            .then(this.getClientInstance().responseHandler({
+            200: {
+                "application/json": "json",
+            },
+        }))
+            .then(commonHttpClient.castResponse())
+            .then(validationSchemaStorage_1.validationSchemaStorage.validator("AttachmentService.getAttachmentById.response"))
+            .then(commonHttpClient.getBody);
+    }
+    /**
+     * Returns all attachments. The number of results is limited by the `limit`
+     * parameter and additional results (if available)
+     * will be available through the `next` URL present in the `Link` response header.
+     *
+     * **[Permissions](https://confluence.atlassian.com/x/_AozKw) required**:
+     * Permission to view the container of the attachment.
+     *
+     * @returns Returned if the requested attachments are returned.
+     * @path {GET} /attachments
+     * @scopes-current read:attachment:confluence
+     */
+    getAttachments({ sort, cursor, status, mediaType, filename, limit, }) {
+        return this.getClientInstance()
+            .request({
+            path: "/attachments",
+            method: "GET",
+            query: {
+                sort,
+                cursor,
+                status,
+                mediaType,
+                filename,
+                limit,
+            },
+        })
+            .then(this.getClientInstance().responseHandler({
+            200: {
+                "application/json": "json",
+            },
+        }))
+            .then(commonHttpClient.castResponse())
+            .then(validationSchemaStorage_1.validationSchemaStorage.validator("AttachmentService.getAttachments.response"))
+            .then(commonHttpClient.getBody);
+    }
+    /**
+     * Returns the attachments of specific blog post. The number of results is limited
+     * by the `limit` parameter and additional results (if available)
+     * will be available through the `next` URL present in the `Link` response header.
+     *
+     * **[Permissions](https://confluence.atlassian.com/x/_AozKw) required**:
+     * Permission to view the content of the blog post and its corresponding space.
+     *
+     * @returns Returned if the requested attachments are returned.
+     * @path {GET} /blogposts/{id}/attachments
+     * @scopes-current read:attachment:confluence
+     */
+    getBlogpostAttachments({ id, sort, cursor, status, mediaType, filename, limit, }) {
+        return this.getClientInstance()
+            .request({
+            path: "/blogposts/{id}/attachments",
+            method: "GET",
+            pathParams: {
+                id,
+            },
+            query: {
+                sort,
+                cursor,
+                status,
+                mediaType,
+                filename,
+                limit,
+            },
+        })
+            .then(this.getClientInstance().responseHandler({
+            200: {
+                "application/json": "json",
+            },
+        }))
+            .then(commonHttpClient.castResponse())
+            .then(validationSchemaStorage_1.validationSchemaStorage.validator("AttachmentService.getBlogpostAttachments.response"))
+            .then(commonHttpClient.getBody);
+    }
+    /**
+     * Returns the attachments of specific custom content. The number of results is
+     * limited by the `limit` parameter and additional results (if available)
+     * will be available through the `next` URL present in the `Link` response header.
+     *
+     * **[Permissions](https://confluence.atlassian.com/x/_AozKw) required**:
+     * Permission to view the content of the custom content and its corresponding
+     * space.
+     *
+     * @returns Returned if the requested attachments are returned.
+     * @path {GET} /custom-content/{id}/attachments
+     * @scopes-current read:attachment:confluence
+     */
+    getCustomContentAttachments({ id, sort, cursor, status, mediaType, filename, limit, }) {
+        return this.getClientInstance()
+            .request({
+            path: "/custom-content/{id}/attachments",
+            method: "GET",
+            pathParams: {
+                id,
+            },
+            query: {
+                sort,
+                cursor,
+                status,
+                mediaType,
+                filename,
+                limit,
+            },
+        })
+            .then(this.getClientInstance().responseHandler({
+            200: {
+                "application/json": "json",
+            },
+        }))
+            .then(commonHttpClient.castResponse())
+            .then(validationSchemaStorage_1.validationSchemaStorage.validator("AttachmentService.getCustomContentAttachments.response"))
+            .then(commonHttpClient.getBody);
+    }
+    /**
+     * Returns the attachments of specified label. The number of results is limited by
+     * the `limit` parameter and additional results (if available)
+     * will be available through the `next` URL present in the `Link` response header.
+     *
+     * **[Permissions](https://confluence.atlassian.com/x/_AozKw) required**:
+     * Permission to view the attachment and its corresponding space.
+     *
+     * @returns Returned if the requested attachments for specified label were successfully
+     * fetched.
+     * @path {GET} /labels/{id}/attachments
+     * @scopes-current read:attachment:confluence
+     */
+    getLabelAttachments({ id, sort, cursor, limit, }) {
+        return this.getClientInstance()
+            .request({
+            path: "/labels/{id}/attachments",
+            method: "GET",
+            pathParams: {
+                id,
+            },
+            query: {
+                sort,
+                cursor,
+                limit,
+            },
+        })
+            .then(this.getClientInstance().responseHandler({
+            200: {
+                "application/json": "json",
+            },
+        }))
+            .then(commonHttpClient.castResponse())
+            .then(validationSchemaStorage_1.validationSchemaStorage.validator("AttachmentService.getLabelAttachments.response"))
+            .then(commonHttpClient.getBody);
+    }
+    /**
+     * Returns the attachments of specific page. The number of results is limited by
+     * the `limit` parameter and additional results (if available)
+     * will be available through the `next` URL present in the `Link` response header.
+     *
+     * **[Permissions](https://confluence.atlassian.com/x/_AozKw) required**:
+     * Permission to view the content of the page and its corresponding space.
+     *
+     * @returns Returned if the requested attachments are returned.
+     * @path {GET} /pages/{id}/attachments
+     * @scopes-current read:attachment:confluence
+     */
+    getPageAttachments({ id, sort, cursor, status, mediaType, filename, limit, }) {
+        return this.getClientInstance()
+            .request({
+            path: "/pages/{id}/attachments",
+            method: "GET",
+            pathParams: {
+                id,
+            },
+            query: {
+                sort,
+                cursor,
+                status,
+                mediaType,
+                filename,
+                limit,
+            },
+        })
+            .then(this.getClientInstance().responseHandler({
+            200: {
+                "application/json": "json",
+            },
+        }))
+            .then(commonHttpClient.castResponse())
+            .then(validationSchemaStorage_1.validationSchemaStorage.validator("AttachmentService.getPageAttachments.response"))
+            .then(commonHttpClient.getBody);
+    }
+    static initialize() {
+        validationSchemaStorage_1.validationSchemaStorage.registerExtensible("AttachmentService.getAttachments.response", zod_1.z
+            .object({
+            status: zod_1.z.literal(200),
+            mediaType: zod_1.z.literal("application/json"),
+            body: zod_1.z
+                .object({
+                results: zod_1.z
+                    .array(validationSchemaStorage_1.validationSchemaStorage.lazy("AttachmentBulk"))
+                    .optional(),
+                _links: validationSchemaStorage_1.validationSchemaStorage
+                    .lazy("MultiEntityLinks")
+                    .optional(),
+            })
+                .catchall(zod_1.z.unknown()),
+        })
+            .describe("AttachmentService.getAttachments.response"));
+        validationSchemaStorage_1.validationSchemaStorage.registerExtensible("AttachmentService.getAttachmentById.response", zod_1.z
+            .object({
+            status: zod_1.z.literal(200),
+            mediaType: zod_1.z.literal("application/json"),
+            body: zod_1.z.intersection(validationSchemaStorage_1.validationSchemaStorage.lazy("AttachmentSingle"), zod_1.z
+                .object({
+                _links: zod_1.z
+                    .object({
+                    base: zod_1.z.string().optional(),
+                })
+                    .catchall(zod_1.z.unknown())
+                    .optional(),
+            })
+                .catchall(zod_1.z.unknown())),
+        })
+            .describe("AttachmentService.getAttachmentById.response"));
+        validationSchemaStorage_1.validationSchemaStorage.registerExtensible("AttachmentService.getBlogpostAttachments.response", zod_1.z
+            .object({
+            status: zod_1.z.literal(200),
+            mediaType: zod_1.z.literal("application/json"),
+            body: zod_1.z
+                .object({
+                results: zod_1.z
+                    .array(validationSchemaStorage_1.validationSchemaStorage.lazy("AttachmentBulk"))
+                    .optional(),
+                _links: validationSchemaStorage_1.validationSchemaStorage
+                    .lazy("MultiEntityLinks")
+                    .optional(),
+            })
+                .catchall(zod_1.z.unknown()),
+        })
+            .describe("AttachmentService.getBlogpostAttachments.response"));
+        validationSchemaStorage_1.validationSchemaStorage.registerExtensible("AttachmentService.getCustomContentAttachments.response", zod_1.z
+            .object({
+            status: zod_1.z.literal(200),
+            mediaType: zod_1.z.literal("application/json"),
+            body: zod_1.z
+                .object({
+                results: zod_1.z
+                    .array(validationSchemaStorage_1.validationSchemaStorage.lazy("AttachmentBulk"))
+                    .optional(),
+                _links: validationSchemaStorage_1.validationSchemaStorage
+                    .lazy("MultiEntityLinks")
+                    .optional(),
+            })
+                .catchall(zod_1.z.unknown()),
+        })
+            .describe("AttachmentService.getCustomContentAttachments.response"));
+        validationSchemaStorage_1.validationSchemaStorage.registerExtensible("AttachmentService.getLabelAttachments.response", zod_1.z
+            .object({
+            status: zod_1.z.literal(200),
+            mediaType: zod_1.z.literal("application/json"),
+            body: zod_1.z
+                .object({
+                results: zod_1.z
+                    .array(validationSchemaStorage_1.validationSchemaStorage.lazy("AttachmentBulk"))
+                    .optional(),
+                _links: validationSchemaStorage_1.validationSchemaStorage
+                    .lazy("MultiEntityLinks")
+                    .optional(),
+            })
+                .catchall(zod_1.z.unknown()),
+        })
+            .describe("AttachmentService.getLabelAttachments.response"));
+        validationSchemaStorage_1.validationSchemaStorage.registerExtensible("AttachmentService.getPageAttachments.response", zod_1.z
+            .object({
+            status: zod_1.z.literal(200),
+            mediaType: zod_1.z.literal("application/json"),
+            body: zod_1.z
+                .object({
+                results: zod_1.z
+                    .array(validationSchemaStorage_1.validationSchemaStorage.lazy("AttachmentBulk"))
+                    .optional(),
+                _links: validationSchemaStorage_1.validationSchemaStorage
+                    .lazy("MultiEntityLinks")
+                    .optional(),
+            })
+                .catchall(zod_1.z.unknown()),
+        })
+            .describe("AttachmentService.getPageAttachments.response"));
+        validationSchemaStorage_1.validationSchemaStorage.registerOnce([
+            attachment_1.registerAttachmentValidationSchemas,
+            common_1.registerCommonValidationSchemas,
+        ]);
+    }
+}
+exports.AttachmentService = AttachmentService;
+//# sourceMappingURL=AttachmentService.js.map