@atlassian-dc-mcp/confluence 0.1.3 → 0.2.0

package/build/confluence-client/services/AdminUsersService.js

@@ -0,0 +1,43 @@
+import { OpenAPI } from '../core/OpenAPI.js';
+import { request as __request } from '../core/request.js';
+export class AdminUsersService {
+    /**
+     * Get active users
+     * Gets a paginated collection of all active users (users which count into license usage).
+     * This will exclude users that are:
+     * - anonymous,
+     * - deactivated,
+     * - externally deleted,
+     * - shadowed
+     * - unlicensed
+     *
+     * This feature relies on search index and might not be accurate when site reindex is in progress.
+     *
+     * Example request URI(s):
+     * `http://example.com/confluence/rest/api/admin/users/list/active`
+     * `http://example.com/confluence/rest/api/admin/users/list/active?start=0`
+     * `http://example.com/confluence/rest/api/admin/users/list/active?start=0&limit=100`
+     * `http://example.com/confluence/rest/api/admin/users/list/active?start=0&limit=100&expand=status`
+     *
+     * @param expand properties to expand on the user.
+     * @param limit the limit of the number of users to return, this may be restricted by fixed system limits.
+     * @param start the start point of the collection to return. This must be non-negative. Default value is 0.
+     * @returns any returns a paginated collection of users.
+     * @throws ApiError
+     */
+    static getActiveUsers(expand, limit, start) {
+        return __request(OpenAPI, {
+            method: 'GET',
+            url: '/rest/api/admin/users/list/active',
+            query: {
+                'expand': expand,
+                'limit': limit,
+                'start': start,
+            },
+            errors: {
+                403: `Returned if the calling user does not have permission to view users. This is possible for anonymous or un-licensed users.`,
+            },
+        });
+    }
+}
+//# sourceMappingURL=AdminUsersService.js.map

package/build/confluence-client/services/AdminUsersService.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"AdminUsersService.js","sourceRoot":"","sources":["../../../src/confluence-client/services/AdminUsersService.ts"],"names":[],"mappings":"AAMA,OAAO,EAAE,OAAO,EAAE,MAAM,oBAAoB,CAAC;AAC7C,OAAO,EAAE,OAAO,IAAI,SAAS,EAAE,MAAM,oBAAoB,CAAC;AAC1D,MAAM,OAAO,iBAAiB;IAC1B;;;;;;;;;;;;;;;;;;;;;;;OAuBG;IACI,MAAM,CAAC,cAAc,CACxB,MAAe,EACf,KAAc,EACd,KAAc;QAed,OAAO,SAAS,CAAC,OAAO,EAAE;YACtB,MAAM,EAAE,KAAK;YACb,GAAG,EAAE,mCAAmC;YACxC,KAAK,EAAE;gBACH,QAAQ,EAAE,MAAM;gBAChB,OAAO,EAAE,KAAK;gBACd,OAAO,EAAE,KAAK;aACjB;YACD,MAAM,EAAE;gBACJ,GAAG,EAAE,2HAA2H;aACnI;SACJ,CAAC,CAAC;IACP,CAAC;CACJ"}

package/build/confluence-client/services/AttachmentsService.d.ts

@@ -0,0 +1,134 @@
+import type { Content } from '../models/Content.js';
+import type { MockAttachmentRequest } from '../models/MockAttachmentRequest.js';
+import type { CancelablePromise } from '../core/CancelablePromise.js';
+export declare class AttachmentsService {
+    /**
+     * Get attachment
+     * Returns a paginated list of attachment Content entities within a single container.
+     * @param id The id of the content the attachment is on.
+     * @param expand (optional) a comma separated list of properties to expand on the Attachments returned. Optional.
+     * @param filename (optional) filter parameter to return only the Attachment with the matching file name.
+     * @param limit (optional) how many items should be returned after the start index.
+     * @param start (optional) the index of the first item within the result set that should be returned.
+     * @param mediaType (optional) a comma separated list of properties to expand on the Attachments returned.
+     * @returns any Returns a JSON representation of a list of attachment Content entities.
+     * @throws ApiError
+     */
+    static getAttachments(id: string, expand?: string, filename?: string, limit?: string, start?: string, mediaType?: string): CancelablePromise<{
+        results?: Array<Content>;
+        totalCount?: number;
+        start?: number;
+        limit?: number;
+        size?: number;
+        _links?: {
+            base?: string;
+            context?: string;
+            self?: string;
+            next?: string;
+            prev?: string;
+        };
+    }>;
+    /**
+     * Create attachments
+     * Add one or more attachments to a Confluence Content entity, with optional comments.
+     *
+     * **Comments are optional**, but if included there must be as many comments as there are files, and the comments must be in the same order as the files.
+     *
+     * This resource expects a multipart post. The media-type multipart/form-data is defined in RFC 1867. Most client libraries have classes that make dealing with multipart posts simple. For instance, in Java the Apache HTTP Components library provides a `MultiPartEntity` that makes it simple to submit a multipart POST.
+     *
+     * In order to protect against XSRF attacks, because this method accepts multipart/form-data, it has XSRF protection on it. This means you must submit a header of `X-Atlassian-Token: nocheck` with the request, otherwise it will be blocked.
+     *
+     * The name of the multipart/form-data parameter that contains attachments must be 'file'.
+     * @param id The id of the content the attachment is on.
+     * @param expand (optional) a comma separated list of properties to expand on the Attachments returned. Optional.
+     * @param allowDuplicated (optional) allows to upload an attachment with an existing filename.
+     * @param status a string containing the status of the attachments content container, supports current or draft, defaults to current
+     * @param formData The attachments to be added. The name of the multipart/form-data parameter that contains attachments must be 'file'.
+     * @returns Content returns a JSON representation of the attachments added.
+     * @throws ApiError
+     */
+    static createAttachments(id: string, expand?: string, allowDuplicated?: string, status?: string, formData?: MockAttachmentRequest): CancelablePromise<Content>;
+    /**
+     * Move attachment
+     * Move an attachment to a different content entity object.
+     *
+     * **When moving the attachment**, the name of the attachment can be updated as well.
+     *
+     * In order to protect against XSRF attacks, because this method accepts multipart/form-data, it has XSRF protection on it. This means you must submit a header of `X-Atlassian-Token: nocheck` with the request, otherwise it will be blocked.
+     *
+     * A simple example to move an attachment with id "456" in a container with id "123" to a container with "789":
+     *
+     * `curl -D- -u admin:admin -X POST -H "X-Atlassian-Token: nocheck" "http://myhost/rest/api/content/123/child/attachment/456/move?newContentId=789"`
+     *
+     * An example to move the same file, while also renaming it to "my-new-name":
+     *
+     * `curl -D- -u admin:admin -X POST -H "X-Atlassian-Token: nocheck" "http://myhost/rest/api/content/123/child/attachment/456/move?newContentId=789&newName=my-new-name"`
+     *
+     * This can also be used to only rename an attachment:
+     *
+     * `curl -D- -u admin:admin -X POST -H "X-Atlassian-Token: nocheck" "http://myhost/rest/api/content/123/child/attachment/456/move?newContentId=123&newName=my-new-name"`
+     * @param attachmentId the id of the attachment to upload the new file for.
+     * @param id The id of the content the attachment is on.
+     * @param newName
+     * @param newContentId
+     * @returns void
+     * @throws ApiError
+     */
+    static move(attachmentId: string, id: string, newName?: string, newContentId?: string): CancelablePromise<void>;
+    /**
+     * Update non-binary data of an Attachment
+     * Update the non-binary data of an attachment.This resource can be used to update an attachment's filename, media-type, comment, and parent container.
+     * @param attachmentId the id of the attachment to update.
+     * @param id The id of the content the attachment is on.
+     * @param requestBody
+     * @returns Content returns a JSON representation of the attachment after being updated.
+     * @throws ApiError
+     */
+    static update(attachmentId: string, id: string, requestBody?: Content): CancelablePromise<Content>;
+    /**
+     * Remove attachment
+     * This method will delete the attachment identified by attachmentId.
+     *
+     * It returns a boolean response indicating whether the operation was successful or not. If the specified attachment or version does not exist, or if the user does not have permission to remove the attachment, appropriate exceptions are thrown and mapped to their corresponding HTTP responses.
+     * @param attachmentId the id of the attachment to be removed.
+     * @param id The id of the content the attachment is on.
+     * @returns void
+     * @throws ApiError
+     */
+    static removeAttachment(attachmentId: string, id: string): CancelablePromise<void>;
+    /**
+     * Remove attachment version
+     * This method will delete the specified version of an attachment identified by attachmentId and version.
+     *
+     * If the operation is successful, it returns a response indicating that no content is returned. If the specified attachment or version does not exist, or if the user does not have permission to remove the attachment, appropriate exceptions are thrown and mapped to their corresponding HTTP responses.
+     * @param attachmentId The id of the attachment to be removed.
+     * @param id The id of the content the attachment is on.
+     * @param version
+     * @returns void
+     * @throws ApiError
+     */
+    static removeAttachmentVersion(attachmentId: string, id: string, version: number): CancelablePromise<void>;
+    /**
+     * Update binary data of an attachment
+     * Update the binary data of an Attachment, and optionally the comment and the minor edit field.
+     *
+     * This adds a new version of the attachment, containing the new binary data, filename, and content-type.
+     *
+     * **When updating the binary data of an attachment**, the comment related to it together with the field that specifies if it's a minor edit can be updated as well, but are not required.
+     *
+     * If an update is considered to be a minor edit, notifications will not be sent to the watchers of that content.
+     *
+     * This resource expects a multipart post. The media-type multipart/form-data is defined in RFC 1867. Most client libraries have classes that make dealing with multipart posts simple. For instance, in Java the Apache HTTP Components library provides a `MultiPartEntity` that makes it simple to submit a multipart POST.
+     *
+     * In order to protect against XSRF attacks, because this method accepts multipart/form-data, it has XSRF protection on it. This means you must submit a header of `X-Atlassian-Token: nocheck` with the request, otherwise it will be blocked.
+     *
+     * The name of the multipart/form-data parameter that contains attachments must be 'file'.
+     * @param attachmentId the id of the attachment to upload the new file for.
+     * @param id The id of the content the attachment is on.
+     * @param formData The attachment to be updated.
+     * @returns Content returns JSON representation of the updated attachment.
+     * @throws ApiError
+     */
+    static updateData(attachmentId: string, id: string, formData?: MockAttachmentRequest): CancelablePromise<Content>;
+}
+//# sourceMappingURL=AttachmentsService.d.ts.map

package/build/confluence-client/services/AttachmentsService.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"AttachmentsService.d.ts","sourceRoot":"","sources":["../../../src/confluence-client/services/AttachmentsService.ts"],"names":[],"mappings":"AAIA,OAAO,KAAK,EAAE,OAAO,EAAE,MAAM,sBAAsB,CAAC;AACpD,OAAO,KAAK,EAAE,qBAAqB,EAAE,MAAM,oCAAoC,CAAC;AAChF,OAAO,KAAK,EAAE,iBAAiB,EAAE,MAAM,8BAA8B,CAAC;AAGtE,qBAAa,kBAAkB;IAC3B;;;;;;;;;;;OAWG;WACW,cAAc,CACxB,EAAE,EAAE,MAAM,EACV,MAAM,CAAC,EAAE,MAAM,EACf,QAAQ,CAAC,EAAE,MAAM,EACjB,KAAK,CAAC,EAAE,MAAM,EACd,KAAK,CAAC,EAAE,MAAM,EACd,SAAS,CAAC,EAAE,MAAM,GACnB,iBAAiB,CAAC;QACjB,OAAO,CAAC,EAAE,KAAK,CAAC,OAAO,CAAC,CAAC;QACzB,UAAU,CAAC,EAAE,MAAM,CAAC;QACpB,KAAK,CAAC,EAAE,MAAM,CAAC;QACf,KAAK,CAAC,EAAE,MAAM,CAAC;QACf,IAAI,CAAC,EAAE,MAAM,CAAC;QACd,MAAM,CAAC,EAAE;YACL,IAAI,CAAC,EAAE,MAAM,CAAC;YACd,OAAO,CAAC,EAAE,MAAM,CAAC;YACjB,IAAI,CAAC,EAAE,MAAM,CAAC;YACd,IAAI,CAAC,EAAE,MAAM,CAAC;YACd,IAAI,CAAC,EAAE,MAAM,CAAC;SACjB,CAAC;KACL,CAAC;IAmBF;;;;;;;;;;;;;;;;;;OAkBG;WACW,iBAAiB,CAC3B,EAAE,EAAE,MAAM,EACV,MAAM,CAAC,EAAE,MAAM,EACf,eAAe,CAAC,EAAE,MAAM,EACxB,MAAM,CAAC,EAAE,MAAM,EACf,QAAQ,CAAC,EAAE,qBAAqB,GACjC,iBAAiB,CAAC,OAAO,CAAC;IAoB7B;;;;;;;;;;;;;;;;;;;;;;;;;OAyBG;WACW,IAAI,CACd,YAAY,EAAE,MAAM,EACpB,EAAE,EAAE,MAAM,EACV,OAAO,CAAC,EAAE,MAAM,EAChB,YAAY,CAAC,EAAE,MAAM,GACtB,iBAAiB,CAAC,IAAI,CAAC;IAkB1B;;;;;;;;OAQG;WACW,MAAM,CAChB,YAAY,EAAE,MAAM,EACpB,EAAE,EAAE,MAAM,EACV,WAAW,CAAC,EAAE,OAAO,GACtB,iBAAiB,CAAC,OAAO,CAAC;IAkB7B;;;;;;;;;OASG;WACW,gBAAgB,CAC1B,YAAY,EAAE,MAAM,EACpB,EAAE,EAAE,MAAM,GACX,iBAAiB,CAAC,IAAI,CAAC;IAc1B;;;;;;;;;;OAUG;WACW,uBAAuB,CACjC,YAAY,EAAE,MAAM,EACpB,EAAE,EAAE,MAAM,EACV,OAAO,EAAE,MAAM,GAChB,iBAAiB,CAAC,IAAI,CAAC;IAe1B;;;;;;;;;;;;;;;;;;;;OAoBG;WACW,UAAU,CACpB,YAAY,EAAE,MAAM,EACpB,EAAE,EAAE,MAAM,EACV,QAAQ,CAAC,EAAE,qBAAqB,GACjC,iBAAiB,CAAC,OAAO,CAAC;CAgBhC"}

package/build/confluence-client/services/AttachmentsService.js

@@ -0,0 +1,233 @@
+import { OpenAPI } from '../core/OpenAPI.js';
+import { request as __request } from '../core/request.js';
+export class AttachmentsService {
+    /**
+     * Get attachment
+     * Returns a paginated list of attachment Content entities within a single container.
+     * @param id The id of the content the attachment is on.
+     * @param expand (optional) a comma separated list of properties to expand on the Attachments returned. Optional.
+     * @param filename (optional) filter parameter to return only the Attachment with the matching file name.
+     * @param limit (optional) how many items should be returned after the start index.
+     * @param start (optional) the index of the first item within the result set that should be returned.
+     * @param mediaType (optional) a comma separated list of properties to expand on the Attachments returned.
+     * @returns any Returns a JSON representation of a list of attachment Content entities.
+     * @throws ApiError
+     */
+    static getAttachments(id, expand, filename, limit, start, mediaType) {
+        return __request(OpenAPI, {
+            method: 'GET',
+            url: '/rest/api/content/{id}/child/attachment',
+            path: {
+                'id': id,
+            },
+            query: {
+                'expand': expand,
+                'filename': filename,
+                'limit': limit,
+                'start': start,
+                'mediaType': mediaType,
+            },
+            errors: {
+                404: ` Returned if there is no content with the given id, or if the calling user does not have permission to view the content.`,
+            },
+        });
+    }
+    /**
+     * Create attachments
+     * Add one or more attachments to a Confluence Content entity, with optional comments.
+     *
+     * **Comments are optional**, but if included there must be as many comments as there are files, and the comments must be in the same order as the files.
+     *
+     * This resource expects a multipart post. The media-type multipart/form-data is defined in RFC 1867. Most client libraries have classes that make dealing with multipart posts simple. For instance, in Java the Apache HTTP Components library provides a `MultiPartEntity` that makes it simple to submit a multipart POST.
+     *
+     * In order to protect against XSRF attacks, because this method accepts multipart/form-data, it has XSRF protection on it. This means you must submit a header of `X-Atlassian-Token: nocheck` with the request, otherwise it will be blocked.
+     *
+     * The name of the multipart/form-data parameter that contains attachments must be 'file'.
+     * @param id The id of the content the attachment is on.
+     * @param expand (optional) a comma separated list of properties to expand on the Attachments returned. Optional.
+     * @param allowDuplicated (optional) allows to upload an attachment with an existing filename.
+     * @param status a string containing the status of the attachments content container, supports current or draft, defaults to current
+     * @param formData The attachments to be added. The name of the multipart/form-data parameter that contains attachments must be 'file'.
+     * @returns Content returns a JSON representation of the attachments added.
+     * @throws ApiError
+     */
+    static createAttachments(id, expand, allowDuplicated, status, formData) {
+        return __request(OpenAPI, {
+            method: 'POST',
+            url: '/rest/api/content/{id}/child/attachment',
+            path: {
+                'id': id,
+            },
+            query: {
+                'expand': expand,
+                'allowDuplicated': allowDuplicated,
+                'status': status,
+            },
+            formData: formData,
+            mediaType: 'multipart/form-data',
+            errors: {
+                403: `Returned if attachments is disabled or if you don't have permission to add attachments to this content.`,
+                404: ` Returned if the requested content is not found, the user does not have permission to view it, or if the attachments exceeds the maximum configured attachment size.`,
+            },
+        });
+    }
+    /**
+     * Move attachment
+     * Move an attachment to a different content entity object.
+     *
+     * **When moving the attachment**, the name of the attachment can be updated as well.
+     *
+     * In order to protect against XSRF attacks, because this method accepts multipart/form-data, it has XSRF protection on it. This means you must submit a header of `X-Atlassian-Token: nocheck` with the request, otherwise it will be blocked.
+     *
+     * A simple example to move an attachment with id "456" in a container with id "123" to a container with "789":
+     *
+     * `curl -D- -u admin:admin -X POST -H "X-Atlassian-Token: nocheck" "http://myhost/rest/api/content/123/child/attachment/456/move?newContentId=789"`
+     *
+     * An example to move the same file, while also renaming it to "my-new-name":
+     *
+     * `curl -D- -u admin:admin -X POST -H "X-Atlassian-Token: nocheck" "http://myhost/rest/api/content/123/child/attachment/456/move?newContentId=789&newName=my-new-name"`
+     *
+     * This can also be used to only rename an attachment:
+     *
+     * `curl -D- -u admin:admin -X POST -H "X-Atlassian-Token: nocheck" "http://myhost/rest/api/content/123/child/attachment/456/move?newContentId=123&newName=my-new-name"`
+     * @param attachmentId the id of the attachment to upload the new file for.
+     * @param id The id of the content the attachment is on.
+     * @param newName
+     * @param newContentId
+     * @returns void
+     * @throws ApiError
+     */
+    static move(attachmentId, id, newName, newContentId) {
+        return __request(OpenAPI, {
+            method: 'POST',
+            url: '/rest/api/content/{id}/child/attachment/{attachmentId}/move',
+            path: {
+                'attachmentId': attachmentId,
+                'id': id,
+            },
+            query: {
+                'newName': newName,
+                'newContentId': newContentId,
+            },
+            errors: {
+                400: ` Returned if the attachment id is invalid.`,
+                404: ` Returned if no attachment is found for the attachmentId.`,
+            },
+        });
+    }
+    /**
+     * Update non-binary data of an Attachment
+     * Update the non-binary data of an attachment.This resource can be used to update an attachment's filename, media-type, comment, and parent container.
+     * @param attachmentId the id of the attachment to update.
+     * @param id The id of the content the attachment is on.
+     * @param requestBody
+     * @returns Content returns a JSON representation of the attachment after being updated.
+     * @throws ApiError
+     */
+    static update(attachmentId, id, requestBody) {
+        return __request(OpenAPI, {
+            method: 'PUT',
+            url: '/rest/api/content/{id}/child/attachment/{attachmentId}',
+            path: {
+                'attachmentId': attachmentId,
+                'id': id,
+            },
+            body: requestBody,
+            mediaType: 'application/json',
+            errors: {
+                400: ` Returned if the attachment id or the attachment version number are invalid.`,
+                403: `Returned if you are not permitted to update or move the attachment to a different container.`,
+                404: ` Returned if no attachment is found for the attachmentId.`,
+                409: `Returned if the version of the supplied Attachment does not match the exact version of the Attachment stored in the database.`,
+            },
+        });
+    }
+    /**
+     * Remove attachment
+     * This method will delete the attachment identified by attachmentId.
+     *
+     * It returns a boolean response indicating whether the operation was successful or not. If the specified attachment or version does not exist, or if the user does not have permission to remove the attachment, appropriate exceptions are thrown and mapped to their corresponding HTTP responses.
+     * @param attachmentId the id of the attachment to be removed.
+     * @param id The id of the content the attachment is on.
+     * @returns void
+     * @throws ApiError
+     */
+    static removeAttachment(attachmentId, id) {
+        return __request(OpenAPI, {
+            method: 'DELETE',
+            url: '/rest/api/content/{id}/child/attachment/{attachmentId}',
+            path: {
+                'attachmentId': attachmentId,
+                'id': id,
+            },
+            errors: {
+                400: `Returned if the user does not have permission to remove the attachment.`,
+                404: ` Returned if the specified attachment does not exist.`,
+            },
+        });
+    }
+    /**
+     * Remove attachment version
+     * This method will delete the specified version of an attachment identified by attachmentId and version.
+     *
+     * If the operation is successful, it returns a response indicating that no content is returned. If the specified attachment or version does not exist, or if the user does not have permission to remove the attachment, appropriate exceptions are thrown and mapped to their corresponding HTTP responses.
+     * @param attachmentId The id of the attachment to be removed.
+     * @param id The id of the content the attachment is on.
+     * @param version
+     * @returns void
+     * @throws ApiError
+     */
+    static removeAttachmentVersion(attachmentId, id, version) {
+        return __request(OpenAPI, {
+            method: 'DELETE',
+            url: '/rest/api/content/{id}/child/attachment/{attachmentId}/version/{version}',
+            path: {
+                'attachmentId': attachmentId,
+                'id': id,
+                'version': version,
+            },
+            errors: {
+                400: `Returned if the user does not have permission to remove the attachment.`,
+                404: `Returned if the specified attachment or version does not exist.`,
+            },
+        });
+    }
+    /**
+     * Update binary data of an attachment
+     * Update the binary data of an Attachment, and optionally the comment and the minor edit field.
+     *
+     * This adds a new version of the attachment, containing the new binary data, filename, and content-type.
+     *
+     * **When updating the binary data of an attachment**, the comment related to it together with the field that specifies if it's a minor edit can be updated as well, but are not required.
+     *
+     * If an update is considered to be a minor edit, notifications will not be sent to the watchers of that content.
+     *
+     * This resource expects a multipart post. The media-type multipart/form-data is defined in RFC 1867. Most client libraries have classes that make dealing with multipart posts simple. For instance, in Java the Apache HTTP Components library provides a `MultiPartEntity` that makes it simple to submit a multipart POST.
+     *
+     * In order to protect against XSRF attacks, because this method accepts multipart/form-data, it has XSRF protection on it. This means you must submit a header of `X-Atlassian-Token: nocheck` with the request, otherwise it will be blocked.
+     *
+     * The name of the multipart/form-data parameter that contains attachments must be 'file'.
+     * @param attachmentId the id of the attachment to upload the new file for.
+     * @param id The id of the content the attachment is on.
+     * @param formData The attachment to be updated.
+     * @returns Content returns JSON representation of the updated attachment.
+     * @throws ApiError
+     */
+    static updateData(attachmentId, id, formData) {
+        return __request(OpenAPI, {
+            method: 'POST',
+            url: '/rest/api/content/{id}/child/attachment/{attachmentId}/data',
+            path: {
+                'attachmentId': attachmentId,
+                'id': id,
+            },
+            formData: formData,
+            mediaType: 'multipart/form-data',
+            errors: {
+                400: ` Returned if the attachment id is invalid.`,
+                404: ` Returned if no attachment is found for the attachmentId.`,
+            },
+        });
+    }
+}
+//# sourceMappingURL=AttachmentsService.js.map

package/build/confluence-client/services/AttachmentsService.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"AttachmentsService.js","sourceRoot":"","sources":["../../../src/confluence-client/services/AttachmentsService.ts"],"names":[],"mappings":"AAOA,OAAO,EAAE,OAAO,EAAE,MAAM,oBAAoB,CAAC;AAC7C,OAAO,EAAE,OAAO,IAAI,SAAS,EAAE,MAAM,oBAAoB,CAAC;AAC1D,MAAM,OAAO,kBAAkB;IAC3B;;;;;;;;;;;OAWG;IACI,MAAM,CAAC,cAAc,CACxB,EAAU,EACV,MAAe,EACf,QAAiB,EACjB,KAAc,EACd,KAAc,EACd,SAAkB;QAelB,OAAO,SAAS,CAAC,OAAO,EAAE;YACtB,MAAM,EAAE,KAAK;YACb,GAAG,EAAE,yCAAyC;YAC9C,IAAI,EAAE;gBACF,IAAI,EAAE,EAAE;aACX;YACD,KAAK,EAAE;gBACH,QAAQ,EAAE,MAAM;gBAChB,UAAU,EAAE,QAAQ;gBACpB,OAAO,EAAE,KAAK;gBACd,OAAO,EAAE,KAAK;gBACd,WAAW,EAAE,SAAS;aACzB;YACD,MAAM,EAAE;gBACJ,GAAG,EAAE,0HAA0H;aAClI;SACJ,CAAC,CAAC;IACP,CAAC;IACD;;;;;;;;;;;;;;;;;;OAkBG;IACI,MAAM,CAAC,iBAAiB,CAC3B,EAAU,EACV,MAAe,EACf,eAAwB,EACxB,MAAe,EACf,QAAgC;QAEhC,OAAO,SAAS,CAAC,OAAO,EAAE;YACtB,MAAM,EAAE,MAAM;YACd,GAAG,EAAE,yCAAyC;YAC9C,IAAI,EAAE;gBACF,IAAI,EAAE,EAAE;aACX;YACD,KAAK,EAAE;gBACH,QAAQ,EAAE,MAAM;gBAChB,iBAAiB,EAAE,eAAe;gBAClC,QAAQ,EAAE,MAAM;aACnB;YACD,QAAQ,EAAE,QAAQ;YAClB,SAAS,EAAE,qBAAqB;YAChC,MAAM,EAAE;gBACJ,GAAG,EAAE,yGAAyG;gBAC9G,GAAG,EAAE,sKAAsK;aAC9K;SACJ,CAAC,CAAC;IACP,CAAC;IACD;;;;;;;;;;;;;;;;;;;;;;;;;OAyBG;IACI,MAAM,CAAC,IAAI,CACd,YAAoB,EACpB,EAAU,EACV,OAAgB,EAChB,YAAqB;QAErB,OAAO,SAAS,CAAC,OAAO,EAAE;YACtB,MAAM,EAAE,MAAM;YACd,GAAG,EAAE,6DAA6D;YAClE,IAAI,EAAE;gBACF,cAAc,EAAE,YAAY;gBAC5B,IAAI,EAAE,EAAE;aACX;YACD,KAAK,EAAE;gBACH,SAAS,EAAE,OAAO;gBAClB,cAAc,EAAE,YAAY;aAC/B;YACD,MAAM,EAAE;gBACJ,GAAG,EAAE,4CAA4C;gBACjD,GAAG,EAAE,2DAA2D;aACnE;SACJ,CAAC,CAAC;IACP,CAAC;IACD;;;;;;;;OAQG;IACI,MAAM,CAAC,MAAM,CAChB,YAAoB,EACpB,EAAU,EACV,WAAqB;QAErB,OAAO,SAAS,CAAC,OAAO,EAAE;YACtB,MAAM,EAAE,KAAK;YACb,GAAG,EAAE,wDAAwD;YAC7D,IAAI,EAAE;gBACF,cAAc,EAAE,YAAY;gBAC5B,IAAI,EAAE,EAAE;aACX;YACD,IAAI,EAAE,WAAW;YACjB,SAAS,EAAE,kBAAkB;YAC7B,MAAM,EAAE;gBACJ,GAAG,EAAE,8EAA8E;gBACnF,GAAG,EAAE,8FAA8F;gBACnG,GAAG,EAAE,2DAA2D;gBAChE,GAAG,EAAE,+HAA+H;aACvI;SACJ,CAAC,CAAC;IACP,CAAC;IACD;;;;;;;;;OASG;IACI,MAAM,CAAC,gBAAgB,CAC1B,YAAoB,EACpB,EAAU;QAEV,OAAO,SAAS,CAAC,OAAO,EAAE;YACtB,MAAM,EAAE,QAAQ;YAChB,GAAG,EAAE,wDAAwD;YAC7D,IAAI,EAAE;gBACF,cAAc,EAAE,YAAY;gBAC5B,IAAI,EAAE,EAAE;aACX;YACD,MAAM,EAAE;gBACJ,GAAG,EAAE,yEAAyE;gBAC9E,GAAG,EAAE,uDAAuD;aAC/D;SACJ,CAAC,CAAC;IACP,CAAC;IACD;;;;;;;;;;OAUG;IACI,MAAM,CAAC,uBAAuB,CACjC,YAAoB,EACpB,EAAU,EACV,OAAe;QAEf,OAAO,SAAS,CAAC,OAAO,EAAE;YACtB,MAAM,EAAE,QAAQ;YAChB,GAAG,EAAE,0EAA0E;YAC/E,IAAI,EAAE;gBACF,cAAc,EAAE,YAAY;gBAC5B,IAAI,EAAE,EAAE;gBACR,SAAS,EAAE,OAAO;aACrB;YACD,MAAM,EAAE;gBACJ,GAAG,EAAE,yEAAyE;gBAC9E,GAAG,EAAE,iEAAiE;aACzE;SACJ,CAAC,CAAC;IACP,CAAC;IACD;;;;;;;;;;;;;;;;;;;;OAoBG;IACI,MAAM,CAAC,UAAU,CACpB,YAAoB,EACpB,EAAU,EACV,QAAgC;QAEhC,OAAO,SAAS,CAAC,OAAO,EAAE;YACtB,MAAM,EAAE,MAAM;YACd,GAAG,EAAE,6DAA6D;YAClE,IAAI,EAAE;gBACF,cAAc,EAAE,YAAY;gBAC5B,IAAI,EAAE,EAAE;aACX;YACD,QAAQ,EAAE,QAAQ;YAClB,SAAS,EAAE,qBAAqB;YAChC,MAAM,EAAE;gBACJ,GAAG,EAAE,4CAA4C;gBACjD,GAAG,EAAE,2DAA2D;aACnE;SACJ,CAAC,CAAC;IACP,CAAC;CACJ"}

package/build/confluence-client/services/BackupAndRestoreService.d.ts

@@ -0,0 +1,146 @@
+import type { ExampleMultipartFormData } from '../models/ExampleMultipartFormData.js';
+import type { FileInfo } from '../models/FileInfo.js';
+import type { JobDetails } from '../models/JobDetails.js';
+import type { SiteBackupJobDetails } from '../models/SiteBackupJobDetails.js';
+import type { SiteBackupSettings } from '../models/SiteBackupSettings.js';
+import type { SiteRestoreJobDetails } from '../models/SiteRestoreJobDetails.js';
+import type { SiteRestoreSettings } from '../models/SiteRestoreSettings.js';
+import type { SpaceBackupJobDetails } from '../models/SpaceBackupJobDetails.js';
+import type { SpaceBackupSettings } from '../models/SpaceBackupSettings.js';
+import type { SpaceRestoreJobDetails } from '../models/SpaceRestoreJobDetails.js';
+import type { SpaceRestoreSettings } from '../models/SpaceRestoreSettings.js';
+import type { CancelablePromise } from '../core/CancelablePromise.js';
+export declare class BackupAndRestoreService {
+    /**
+     * Cancel all queued jobs
+     * Cancels all queued jobs. Does not affect jobs that are being processed at the moment.
+     * @returns any Returns the number of cancelled jobs. If no jobs were cancelled, 0 is returned.
+     * Example response: `1`
+     * @throws ApiError
+     */
+    static cancelAllQueuedJobs(): CancelablePromise<any>;
+    /**
+     * Cancel job
+     * Cancels the job. If the job is already cancelled or failed, the method will do nothing.
+     * @param jobId id of the backup/restore job
+     * @returns JobDetails Returns a JSON representation of the cancelled job.
+     * @throws ApiError
+     */
+    static cancelJob(jobId: string): CancelablePromise<JobDetails>;
+    /**
+     * Create site backup job
+     * Starts the new site backup job.
+     * @param requestBody Site backup settings
+     * @returns SiteBackupJobDetails Returns a JSON representation of the site backup job details.
+     * @throws ApiError
+     */
+    static createSiteBackupJob(requestBody?: SiteBackupSettings): CancelablePromise<SiteBackupJobDetails>;
+    /**
+     * Create site restore job
+     * Starts the new site restore job.
+     * @param requestBody space restore settings
+     * @returns SiteRestoreJobDetails Returns a JSON representation of the site restore job.
+     * @throws ApiError
+     */
+    static createSiteRestoreJob(requestBody?: SiteRestoreSettings): CancelablePromise<SiteRestoreJobDetails>;
+    /**
+     * Create site restore job for upload backup file
+     * This resource expects a multipart post. The media-type multipart/form-data is defined in RFC 1867.
+     *
+     * Most client libraries have classes that make dealing with multipart posts simple.
+     *
+     * For instance, in Java the Apache HTTP Components library provides a MultiPartEntity that makes it simple to submit a multipart POST.
+     *
+     * In order to protect against XSRF attacks, because this method accepts multipart/form-data, it has XSRF protection on it.  This means you must submit a header of X-Atlassian-Token: nocheck with the request, otherwise it will be blocked.
+     *
+     * The name of the multipart/form-data parameter that contains attachments must be "file".
+     *
+     * An example to attach the file:
+     *
+     * curl -D- -u admin:admin -X POST -H "X-Atlassian-Token: nocheck" -F  file=@myfile.zip http://myhost/rest/api/backup-restore/restore/space/upload
+     *
+     * .
+     * @param formData Backup file to be uploaded. Has to be a zip file.
+     * @returns SiteRestoreJobDetails Returns a JSON representation of the site restore job details.
+     * @throws ApiError
+     */
+    static createSiteRestoreJobForUploadedBackupFile(formData?: ExampleMultipartFormData): CancelablePromise<SiteRestoreJobDetails>;
+    /**
+     * Create space backup job
+     * Creates new space backup job and adds it to the queue.
+     * @param requestBody Space backup settings
+     * @returns SpaceBackupJobDetails Returns a JSON representation of the space backup job
+     * @throws ApiError
+     */
+    static createSpaceBackupJob(requestBody?: SpaceBackupSettings): CancelablePromise<SpaceBackupJobDetails>;
+    /**
+     * Create space restore job
+     * Creates new space restore job and adds it to the queue.
+     * @param requestBody space restore settings
+     * @returns SpaceRestoreJobDetails Returns a JSON representation of the space restore job.
+     * @throws ApiError
+     */
+    static createSpaceRestoreJob(requestBody?: SpaceRestoreSettings): CancelablePromise<SpaceRestoreJobDetails>;
+    /**
+     * Create space restore job for upload backup file
+     * This resource expects a multipart post. The media-type multipart/form-data is defined in RFC 1867.
+     *
+     * Most client libraries have classes that make dealing with multipart posts simple.
+     *
+     * For instance, in Java the Apache HTTP Components library provides a MultiPartEntity that makes it simple to submit a multipart POST.
+     *
+     * In order to protect against XSRF attacks, because this method accepts multipart/form-data, it has XSRF protection on it.  This means you must submit a header of X-Atlassian-Token: nocheck with the request, otherwise it will be blocked.
+     *
+     * The name of the multipart/form-data parameter that contains attachments must be "file".
+     *
+     * An example to attach the file:
+     *
+     * curl -D- -u admin:admin -X POST -H "X-Atlassian-Token: nocheck" -F  file=@myfile.zip http://myhost/rest/api/backup-restore/restore/space/upload
+     *
+     * .
+     * @param formData backup file uploaded. Has to be a zip file.
+     * @returns SpaceRestoreJobDetails Returns a JSON representation of the space restore job details.
+     * @throws ApiError
+     */
+    static createSpaceRestoreJobForUploadedBackupFile(formData?: ExampleMultipartFormData): CancelablePromise<SpaceRestoreJobDetails>;
+    /**
+     * Download backup file
+     * Downloads the backup file for the given job. Requires site admin or space export permissions for all spaces included in the backup job.
+     * @param jobId id of the backup/restore job
+     * @returns JobDetails Returns a data stream of the backup file content.
+     * @throws ApiError
+     */
+    static downloadBackupFile(jobId: string): CancelablePromise<JobDetails>;
+    /**
+     * Find jobs by filters
+     * Returns jobs based on the filters provided. The user must have permission to see the jobs.
+     * @param owner userName of user who had created a job.
+     * @param spaceKey the key of the Space the User is attempting to view.
+     * @param fromDate minimum job creation date. Supported date format is `yyyy-MM-ddTHH:mm:ss.SSSZ`
+     * @param jobStates list of job states. Acceptable values: "QUEUED", "PROCESSING", "FINISHED", "CANCELLING", "CANCELLED", "FAILED"
+     * @param toDate maximum job create date. Supported date format is `yyyy-MM-ddTHH:mm:ss.SSSZ`
+     * @param jobOperation job operation. Acceptable values: "BACKUP" and "RESTORE"
+     * @param limit amount of jobs that should be returned
+     * @param jobScope scope of the job. Acceptable values: "SPACE" and "SITE"
+     * @returns JobDetails Returns the List of backup/restore jobs visible to user based on the filter provided and the user's permissions.
+     * @throws ApiError
+     */
+    static findJobs(owner?: string, spaceKey?: string, fromDate?: string, jobStates?: string, toDate?: string, jobOperation?: string, limit?: string, jobScope?: string): CancelablePromise<Array<JobDetails>>;
+    /**
+     * Get files in restore directory
+     * returns list of information on files in conf-home/restore/(jobScope).
+     * @param jobScope name of type of restore job (SITE or SPACE or null), if null, all backup files are listed
+     * @returns FileInfo Returns a list of FileInfo objects, containing fileName, fileCreationTime, fileSize, and jobScope.
+     * @throws ApiError
+     */
+    static getFiles(jobScope?: string): CancelablePromise<Array<FileInfo>>;
+    /**
+     * Get job by ID
+     * Get job by id. The user must be a sysadmin or the owner of the job.
+     * @param jobId id of the backup/restore job
+     * @returns JobDetails Returns a JSON representation of the backup/restore job
+     * @throws ApiError
+     */
+    static getJob(jobId: string): CancelablePromise<JobDetails>;
+}
+//# sourceMappingURL=BackupAndRestoreService.d.ts.map

package/build/confluence-client/services/BackupAndRestoreService.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"BackupAndRestoreService.d.ts","sourceRoot":"","sources":["../../../src/confluence-client/services/BackupAndRestoreService.ts"],"names":[],"mappings":"AAIA,OAAO,KAAK,EAAE,wBAAwB,EAAE,MAAM,uCAAuC,CAAC;AACtF,OAAO,KAAK,EAAE,QAAQ,EAAE,MAAM,uBAAuB,CAAC;AACtD,OAAO,KAAK,EAAE,UAAU,EAAE,MAAM,yBAAyB,CAAC;AAC1D,OAAO,KAAK,EAAE,oBAAoB,EAAE,MAAM,mCAAmC,CAAC;AAC9E,OAAO,KAAK,EAAE,kBAAkB,EAAE,MAAM,iCAAiC,CAAC;AAC1E,OAAO,KAAK,EAAE,qBAAqB,EAAE,MAAM,oCAAoC,CAAC;AAChF,OAAO,KAAK,EAAE,mBAAmB,EAAE,MAAM,kCAAkC,CAAC;AAC5E,OAAO,KAAK,EAAE,qBAAqB,EAAE,MAAM,oCAAoC,CAAC;AAChF,OAAO,KAAK,EAAE,mBAAmB,EAAE,MAAM,kCAAkC,CAAC;AAC5E,OAAO,KAAK,EAAE,sBAAsB,EAAE,MAAM,qCAAqC,CAAC;AAClF,OAAO,KAAK,EAAE,oBAAoB,EAAE,MAAM,mCAAmC,CAAC;AAC9E,OAAO,KAAK,EAAE,iBAAiB,EAAE,MAAM,8BAA8B,CAAC;AAGtE,qBAAa,uBAAuB;IAChC;;;;;;OAMG;WACW,mBAAmB,IAAI,iBAAiB,CAAC,GAAG,CAAC;IAS3D;;;;;;OAMG;WACW,SAAS,CACnB,KAAK,EAAE,MAAM,GACd,iBAAiB,CAAC,UAAU,CAAC;IAYhC;;;;;;OAMG;WACW,mBAAmB,CAC7B,WAAW,CAAC,EAAE,kBAAkB,GACjC,iBAAiB,CAAC,oBAAoB,CAAC;IAY1C;;;;;;OAMG;WACW,oBAAoB,CAC9B,WAAW,CAAC,EAAE,mBAAmB,GAClC,iBAAiB,CAAC,qBAAqB,CAAC;IAY3C;;;;;;;;;;;;;;;;;;;;OAoBG;WACW,yCAAyC,CACnD,QAAQ,CAAC,EAAE,wBAAwB,GACpC,iBAAiB,CAAC,qBAAqB,CAAC;IAY3C;;;;;;OAMG;WACW,oBAAoB,CAC9B,WAAW,CAAC,EAAE,mBAAmB,GAClC,iBAAiB,CAAC,qBAAqB,CAAC;IAa3C;;;;;;OAMG;WACW,qBAAqB,CAC/B,WAAW,CAAC,EAAE,oBAAoB,GACnC,iBAAiB,CAAC,sBAAsB,CAAC;IAY5C;;;;;;;;;;;;;;;;;;;;OAoBG;WACW,0CAA0C,CACpD,QAAQ,CAAC,EAAE,wBAAwB,GACpC,iBAAiB,CAAC,sBAAsB,CAAC;IAY5C;;;;;;OAMG;WACW,kBAAkB,CAC5B,KAAK,EAAE,MAAM,GACd,iBAAiB,CAAC,UAAU,CAAC;IAYhC;;;;;;;;;;;;;OAaG;WACW,QAAQ,CAClB,KAAK,CAAC,EAAE,MAAM,EACd,QAAQ,CAAC,EAAE,MAAM,EACjB,QAAQ,CAAC,EAAE,MAAM,EACjB,SAAS,CAAC,EAAE,MAAM,EAClB,MAAM,CAAC,EAAE,MAAM,EACf,YAAY,CAAC,EAAE,MAAM,EACrB,KAAK,CAAC,EAAE,MAAM,EACd,QAAQ,CAAC,EAAE,MAAM,GAClB,iBAAiB,CAAC,KAAK,CAAC,UAAU,CAAC,CAAC;IAmBvC;;;;;;OAMG;WACW,QAAQ,CAClB,QAAQ,CAAC,EAAE,MAAM,GAClB,iBAAiB,CAAC,KAAK,CAAC,QAAQ,CAAC,CAAC;IAYrC;;;;;;OAMG;WACW,MAAM,CAChB,KAAK,EAAE,MAAM,GACd,iBAAiB,CAAC,UAAU,CAAC;CAanC"}