@resolution/confluence-api-client 0.2.0

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

@@ -0,0 +1,269 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.AuditService = 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 audit_1 = require("../models/audit");
+const validationSchemaStorage_1 = require("../validationSchemaStorage");
+class AuditService extends CommonHttpService_1.CommonHttpService {
+    /**
+     * Creates a record in the audit log.
+     *
+     * **[Permissions](https://confluence.atlassian.com/x/_AozKw) required**:
+     * 'Confluence Administrator' global permission.
+     *
+     * @returns Returned if the record is created in the audit log.
+     * @path {POST} /wiki/rest/api/audit
+     * @scopes-current read:audit-log:confluence, write:audit-log:confluence
+     */
+    createAuditRecord({ auditRecordCreate, }) {
+        return this.getClientInstance()
+            .request({
+            path: "/wiki/rest/api/audit",
+            method: "POST",
+            headers: {
+                "Content-Type": "application/json",
+            },
+            body: auditRecordCreate,
+        })
+            .then(this.getClientInstance().responseHandler({
+            200: {
+                "application/json": "json",
+            },
+        }))
+            .then(commonHttpClient.castResponse())
+            .then(validationSchemaStorage_1.validationSchemaStorage.validator("AuditService.createAuditRecord.response"))
+            .then(commonHttpClient.getBody);
+    }
+    /**
+     * Exports audit records as a CSV file or ZIP file.
+     *
+     * **[Permissions](https://confluence.atlassian.com/x/_AozKw) required**:
+     * 'Confluence Administrator' global permission.
+     *
+     * @returns * status: 200, mediaType: application/zip
+     *
+     *    Returned if the requested export of the audit records is returned.
+     *
+     *  * status: 200, mediaType: text/csv
+     *
+     *    Returned if the requested export of the audit records is returned.
+     * @path {GET} /wiki/rest/api/audit/export
+     * @scopes-current read:audit-log:confluence
+     */
+    exportAuditRecords({ startDate, endDate, searchString, format, }) {
+        return this.getClientInstance()
+            .request({
+            path: "/wiki/rest/api/audit/export",
+            method: "GET",
+            query: {
+                startDate,
+                endDate,
+                searchString,
+                format,
+            },
+        })
+            .then(this.getClientInstance().responseHandler({
+            200: {
+                "application/zip": "blob",
+                "text/csv": "blob",
+            },
+        }))
+            .then(commonHttpClient.castResponse())
+            .then(validationSchemaStorage_1.validationSchemaStorage.validator("AuditService.exportAuditRecords.response"));
+    }
+    /**
+     * Returns all records in the audit log, optionally for a certain date range.
+     * This contains information about events like space exports, group membership
+     * changes, app installations, etc. For more information, see
+     * [Audit log](https://confluence.atlassian.com/confcloud/audit-log-802164269.html)
+     * in the Confluence administrator's guide.
+     *
+     * **[Permissions](https://confluence.atlassian.com/x/_AozKw) required**:
+     * 'Confluence Administrator' global permission.
+     *
+     * @returns Returned if the requested records are returned.
+     * @path {GET} /wiki/rest/api/audit
+     * @scopes-current read:audit-log:confluence
+     */
+    getAuditRecords({ startDate, endDate, searchString, start, limit, }) {
+        return this.getClientInstance()
+            .request({
+            path: "/wiki/rest/api/audit",
+            method: "GET",
+            query: {
+                startDate,
+                endDate,
+                searchString,
+                start,
+                limit,
+            },
+        })
+            .then(this.getClientInstance().responseHandler({
+            200: {
+                "application/json": "json",
+            },
+        }))
+            .then(commonHttpClient.castResponse())
+            .then(validationSchemaStorage_1.validationSchemaStorage.validator("AuditService.getAuditRecords.response"))
+            .then(commonHttpClient.getBody);
+    }
+    /**
+     * Returns records from the audit log, for a time period back from the current
+     * date. For example, you can use this method to get the last 3 months of records.
+     *
+     * This contains information about events like space exports, group membership
+     * changes, app installations, etc. For more information, see
+     * [Audit log](https://confluence.atlassian.com/confcloud/audit-log-802164269.html)
+     * in the Confluence administrator's guide.
+     *
+     * **[Permissions](https://confluence.atlassian.com/x/_AozKw) required**:
+     * 'Confluence Administrator' global permission.
+     *
+     * @returns Returned if the requested records are returned.
+     * @path {GET} /wiki/rest/api/audit/since
+     * @scopes-current read:audit-log:confluence
+     */
+    getAuditRecordsForTimePeriod({ number, units, searchString, start, limit, }) {
+        return this.getClientInstance()
+            .request({
+            path: "/wiki/rest/api/audit/since",
+            method: "GET",
+            query: {
+                number,
+                units,
+                searchString,
+                start,
+                limit,
+            },
+        })
+            .then(this.getClientInstance().responseHandler({
+            200: {
+                "application/json": "json",
+            },
+        }))
+            .then(commonHttpClient.castResponse())
+            .then(validationSchemaStorage_1.validationSchemaStorage.validator("AuditService.getAuditRecordsForTimePeriod.response"))
+            .then(commonHttpClient.getBody);
+    }
+    /**
+     * Returns the retention period for records in the audit log. The retention
+     * period is how long an audit record is kept for, from creation date until
+     * it is deleted.
+     *
+     * **[Permissions](https://confluence.atlassian.com/x/_AozKw) required**:
+     * 'Confluence Administrator' global permission.
+     *
+     * @returns Returned if the requested retention period is returned.
+     * @path {GET} /wiki/rest/api/audit/retention
+     * @scopes-current read:audit-log:confluence
+     */
+    getRetentionPeriod() {
+        return this.getClientInstance()
+            .request({
+            path: "/wiki/rest/api/audit/retention",
+            method: "GET",
+        })
+            .then(this.getClientInstance().responseHandler({
+            200: {
+                "application/json": "json",
+            },
+        }))
+            .then(commonHttpClient.castResponse())
+            .then(validationSchemaStorage_1.validationSchemaStorage.validator("AuditService.getRetentionPeriod.response"))
+            .then(commonHttpClient.getBody);
+    }
+    /**
+     * Sets the retention period for records in the audit log. The retention period
+     * can be set to a maximum of 1 year.
+     *
+     * **[Permissions](https://confluence.atlassian.com/x/_AozKw) required**:
+     * 'Confluence Administrator' global permission.
+     *
+     * @returns Returned if the retention period is updated.
+     * @path {PUT} /wiki/rest/api/audit/retention
+     * @scopes-current write:audit-log:confluence
+     */
+    setRetentionPeriod({ retentionPeriod, }) {
+        return this.getClientInstance()
+            .request({
+            path: "/wiki/rest/api/audit/retention",
+            method: "PUT",
+            headers: {
+                "Content-Type": "application/json",
+            },
+            body: retentionPeriod,
+        })
+            .then(this.getClientInstance().responseHandler({
+            200: {
+                "application/json": "json",
+            },
+        }))
+            .then(commonHttpClient.castResponse())
+            .then(validationSchemaStorage_1.validationSchemaStorage.validator("AuditService.setRetentionPeriod.response"))
+            .then(commonHttpClient.getBody);
+    }
+    static initialize() {
+        validationSchemaStorage_1.validationSchemaStorage.registerExtensible("AuditService.getAuditRecords.response", zod_1.z
+            .object({
+            status: zod_1.z.literal(200),
+            mediaType: zod_1.z.literal("application/json"),
+            body: validationSchemaStorage_1.validationSchemaStorage.lazy("AuditRecordArray"),
+        })
+            .describe("AuditService.getAuditRecords.response"));
+        validationSchemaStorage_1.validationSchemaStorage.registerExtensible("AuditService.createAuditRecord.response", zod_1.z
+            .object({
+            status: zod_1.z.literal(200),
+            mediaType: zod_1.z.literal("application/json"),
+            body: validationSchemaStorage_1.validationSchemaStorage.lazy("AuditRecord"),
+        })
+            .describe("AuditService.createAuditRecord.response"));
+        validationSchemaStorage_1.validationSchemaStorage.registerExtensible("AuditService.exportAuditRecords.response", zod_1.z
+            .object({
+            status: zod_1.z.number(),
+            mediaType: zod_1.z.string(),
+            body: zod_1.z.unknown(),
+        })
+            .superRefine(({ mediaType: mediaType }, ctx) => {
+            if (mediaType === "application/zip" || mediaType === "text/csv") {
+                return;
+            }
+            else {
+                ctx.addIssue({
+                    code: zod_1.z.ZodIssueCode.custom,
+                    path: ["mediaType"],
+                    message: `Unexpected media type: ${mediaType}`,
+                });
+            }
+        })
+            .describe("AuditService.exportAuditRecords.response"));
+        validationSchemaStorage_1.validationSchemaStorage.registerExtensible("AuditService.getRetentionPeriod.response", zod_1.z
+            .object({
+            status: zod_1.z.literal(200),
+            mediaType: zod_1.z.literal("application/json"),
+            body: validationSchemaStorage_1.validationSchemaStorage.lazy("RetentionPeriod"),
+        })
+            .describe("AuditService.getRetentionPeriod.response"));
+        validationSchemaStorage_1.validationSchemaStorage.registerExtensible("AuditService.setRetentionPeriod.response", zod_1.z
+            .object({
+            status: zod_1.z.literal(200),
+            mediaType: zod_1.z.literal("application/json"),
+            body: validationSchemaStorage_1.validationSchemaStorage.lazy("RetentionPeriod"),
+        })
+            .describe("AuditService.setRetentionPeriod.response"));
+        validationSchemaStorage_1.validationSchemaStorage.registerExtensible("AuditService.getAuditRecordsForTimePeriod.response", zod_1.z
+            .object({
+            status: zod_1.z.literal(200),
+            mediaType: zod_1.z.literal("application/json"),
+            body: validationSchemaStorage_1.validationSchemaStorage.lazy("AuditRecordArray"),
+        })
+            .describe("AuditService.getAuditRecordsForTimePeriod.response"));
+        validationSchemaStorage_1.validationSchemaStorage.registerOnce([audit_1.registerAuditValidationSchemas]);
+    }
+}
+exports.AuditService = AuditService;
+//# sourceMappingURL=AuditService.js.map

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

@@ -0,0 +1 @@
+{"version":3,"file":"AuditService.js","sourceRoot":"","sources":["../../../../src/openapi/v1/services/AuditService.ts"],"names":[],"mappings":";;;AAAA,eAAe;AACf,wDAAwD;AACxD,gDAAgD;AAChD,6BAAwB;AAExB,6DAA6D;AAC7D,iEAA8D;AAC9D,2CAMyB;AACzB,wEAAqE;AACrE,MAAa,YAAa,SAAQ,qCAAiB;IACjD;;;;;;;;;OASG;IACH,iBAAiB,CAAC,EAChB,iBAAiB,GAIlB;QACC,OAAO,IAAI,CAAC,iBAAiB,EAAE;aAC5B,OAAO,CAAC;YACP,IAAI,EAAE,sBAAsB;YAC5B,MAAM,EAAE,MAAM;YACd,OAAO,EAAE;gBACP,cAAc,EAAE,kBAAkB;aACnC;YACD,IAAI,EAAE,iBAAiB;SACxB,CAAC;aACD,IAAI,CACH,IAAI,CAAC,iBAAiB,EAAE,CAAC,eAAe,CAAC;YACvC,GAAG,EAAE;gBACH,kBAAkB,EAAE,MAAM;aAC3B;SACF,CAAC,CACH;aACA,IAAI,CACH,gBAAgB,CAAC,YAAY,EAIzB,CACL;aACA,IAAI,CACH,iDAAuB,CAAC,SAAS,CAC/B,yCAAyC,CAC1C,CACF;aACA,IAAI,CAAC,gBAAgB,CAAC,OAAO,CAAC,CAAC;IACpC,CAAC;IACD;;;;;;;;;;;;;;;OAeG;IACH,kBAAkB,CAAC,EACjB,SAAS,EACT,OAAO,EACP,YAAY,EACZ,MAAM,GAqBP;QAOC,OAAO,IAAI,CAAC,iBAAiB,EAAE;aAC5B,OAAO,CAAC;YACP,IAAI,EAAE,6BAA6B;YACnC,MAAM,EAAE,KAAK;YACb,KAAK,EAAE;gBACL,SAAS;gBACT,OAAO;gBACP,YAAY;gBACZ,MAAM;aACP;SACF,CAAC;aACD,IAAI,CACH,IAAI,CAAC,iBAAiB,EAAE,CAAC,eAAe,CAAC;YACvC,GAAG,EAAE;gBACH,iBAAiB,EAAE,MAAM;gBACzB,UAAU,EAAE,MAAM;aACnB;SACF,CAAC,CACH;aACA,IAAI,CACH,gBAAgB,CAAC,YAAY,EAIzB,CACL;aACA,IAAI,CACH,iDAAuB,CAAC,SAAS,CAC/B,0CAA0C,CAC3C,CACF,CAAC;IACN,CAAC;IACD;;;;;;;;;;;;;OAaG;IACH,eAAe,CAAC,EACd,SAAS,EACT,OAAO,EACP,YAAY,EACZ,KAAK,EACL,KAAK,GA0BN;QACC,OAAO,IAAI,CAAC,iBAAiB,EAAE;aAC5B,OAAO,CAAC;YACP,IAAI,EAAE,sBAAsB;YAC5B,MAAM,EAAE,KAAK;YACb,KAAK,EAAE;gBACL,SAAS;gBACT,OAAO;gBACP,YAAY;gBACZ,KAAK;gBACL,KAAK;aACN;SACF,CAAC;aACD,IAAI,CACH,IAAI,CAAC,iBAAiB,EAAE,CAAC,eAAe,CAAC;YACvC,GAAG,EAAE;gBACH,kBAAkB,EAAE,MAAM;aAC3B;SACF,CAAC,CACH;aACA,IAAI,CACH,gBAAgB,CAAC,YAAY,EAIzB,CACL;aACA,IAAI,CACH,iDAAuB,CAAC,SAAS,CAC/B,uCAAuC,CACxC,CACF;aACA,IAAI,CAAC,gBAAgB,CAAC,OAAO,CAAC,CAAC;IACpC,CAAC;IACD;;;;;;;;;;;;;;;OAeG;IACH,4BAA4B,CAAC,EAC3B,MAAM,EACN,KAAK,EACL,YAAY,EACZ,KAAK,EACL,KAAK,GA+BN;QACC,OAAO,IAAI,CAAC,iBAAiB,EAAE;aAC5B,OAAO,CAAC;YACP,IAAI,EAAE,4BAA4B;YAClC,MAAM,EAAE,KAAK;YACb,KAAK,EAAE;gBACL,MAAM;gBACN,KAAK;gBACL,YAAY;gBACZ,KAAK;gBACL,KAAK;aACN;SACF,CAAC;aACD,IAAI,CACH,IAAI,CAAC,iBAAiB,EAAE,CAAC,eAAe,CAAC;YACvC,GAAG,EAAE;gBACH,kBAAkB,EAAE,MAAM;aAC3B;SACF,CAAC,CACH;aACA,IAAI,CACH,gBAAgB,CAAC,YAAY,EAIzB,CACL;aACA,IAAI,CACH,iDAAuB,CAAC,SAAS,CAC/B,oDAAoD,CACrD,CACF;aACA,IAAI,CAAC,gBAAgB,CAAC,OAAO,CAAC,CAAC;IACpC,CAAC;IACD;;;;;;;;;;;OAWG;IACH,kBAAkB;QAChB,OAAO,IAAI,CAAC,iBAAiB,EAAE;aAC5B,OAAO,CAAC;YACP,IAAI,EAAE,gCAAgC;YACtC,MAAM,EAAE,KAAK;SACd,CAAC;aACD,IAAI,CACH,IAAI,CAAC,iBAAiB,EAAE,CAAC,eAAe,CAAC;YACvC,GAAG,EAAE;gBACH,kBAAkB,EAAE,MAAM;aAC3B;SACF,CAAC,CACH;aACA,IAAI,CACH,gBAAgB,CAAC,YAAY,EAIzB,CACL;aACA,IAAI,CACH,iDAAuB,CAAC,SAAS,CAC/B,0CAA0C,CAC3C,CACF;aACA,IAAI,CAAC,gBAAgB,CAAC,OAAO,CAAC,CAAC;IACpC,CAAC;IACD;;;;;;;;;;OAUG;IACH,kBAAkB,CAAC,EACjB,eAAe,GAIhB;QACC,OAAO,IAAI,CAAC,iBAAiB,EAAE;aAC5B,OAAO,CAAC;YACP,IAAI,EAAE,gCAAgC;YACtC,MAAM,EAAE,KAAK;YACb,OAAO,EAAE;gBACP,cAAc,EAAE,kBAAkB;aACnC;YACD,IAAI,EAAE,eAAe;SACtB,CAAC;aACD,IAAI,CACH,IAAI,CAAC,iBAAiB,EAAE,CAAC,eAAe,CAAC;YACvC,GAAG,EAAE;gBACH,kBAAkB,EAAE,MAAM;aAC3B;SACF,CAAC,CACH;aACA,IAAI,CACH,gBAAgB,CAAC,YAAY,EAIzB,CACL;aACA,IAAI,CACH,iDAAuB,CAAC,SAAS,CAC/B,0CAA0C,CAC3C,CACF;aACA,IAAI,CAAC,gBAAgB,CAAC,OAAO,CAAC,CAAC;IACpC,CAAC;IACD,MAAM,CAAC,UAAU;QACf,iDAAuB,CAAC,kBAAkB,CACxC,uCAAuC,EACvC,OAAC;aACE,MAAM,CAAC;YACN,MAAM,EAAE,OAAC,CAAC,OAAO,CAAC,GAAG,CAAC;YACtB,SAAS,EAAE,OAAC,CAAC,OAAO,CAAC,kBAAkB,CAAC;YACxC,IAAI,EAAE,iDAAuB,CAAC,IAAI,CAAC,kBAAkB,CAAC;SACvD,CAAC;aACD,QAAQ,CAAC,uCAAuC,CAAC,CACrD,CAAC;QACF,iDAAuB,CAAC,kBAAkB,CACxC,yCAAyC,EACzC,OAAC;aACE,MAAM,CAAC;YACN,MAAM,EAAE,OAAC,CAAC,OAAO,CAAC,GAAG,CAAC;YACtB,SAAS,EAAE,OAAC,CAAC,OAAO,CAAC,kBAAkB,CAAC;YACxC,IAAI,EAAE,iDAAuB,CAAC,IAAI,CAAC,aAAa,CAAC;SAClD,CAAC;aACD,QAAQ,CAAC,yCAAyC,CAAC,CACvD,CAAC;QACF,iDAAuB,CAAC,kBAAkB,CACxC,0CAA0C,EAC1C,OAAC;aACE,MAAM,CAAC;YACN,MAAM,EAAE,OAAC,CAAC,MAAM,EAAE;YAClB,SAAS,EAAE,OAAC,CAAC,MAAM,EAAE;YACrB,IAAI,EAAE,OAAC,CAAC,OAAO,EAAE;SAClB,CAAC;aACD,WAAW,CAAC,CAAC,EAAE,SAAS,EAAE,SAAS,EAAE,EAAE,GAAG,EAAE,EAAE;YAC7C,IAAI,SAAS,KAAK,iBAAiB,IAAI,SAAS,KAAK,UAAU,EAAE,CAAC;gBAChE,OAAO;YACT,CAAC;iBAAM,CAAC;gBACN,GAAG,CAAC,QAAQ,CAAC;oBACX,IAAI,EAAE,OAAC,CAAC,YAAY,CAAC,MAAM;oBAC3B,IAAI,EAAE,CAAC,WAAW,CAAC;oBACnB,OAAO,EAAE,0BAA0B,SAAS,EAAE;iBAC/C,CAAC,CAAC;YACL,CAAC;QACH,CAAC,CAAC;aACD,QAAQ,CAAC,0CAA0C,CAAC,CACxD,CAAC;QACF,iDAAuB,CAAC,kBAAkB,CACxC,0CAA0C,EAC1C,OAAC;aACE,MAAM,CAAC;YACN,MAAM,EAAE,OAAC,CAAC,OAAO,CAAC,GAAG,CAAC;YACtB,SAAS,EAAE,OAAC,CAAC,OAAO,CAAC,kBAAkB,CAAC;YACxC,IAAI,EAAE,iDAAuB,CAAC,IAAI,CAAC,iBAAiB,CAAC;SACtD,CAAC;aACD,QAAQ,CAAC,0CAA0C,CAAC,CACxD,CAAC;QACF,iDAAuB,CAAC,kBAAkB,CACxC,0CAA0C,EAC1C,OAAC;aACE,MAAM,CAAC;YACN,MAAM,EAAE,OAAC,CAAC,OAAO,CAAC,GAAG,CAAC;YACtB,SAAS,EAAE,OAAC,CAAC,OAAO,CAAC,kBAAkB,CAAC;YACxC,IAAI,EAAE,iDAAuB,CAAC,IAAI,CAAC,iBAAiB,CAAC;SACtD,CAAC;aACD,QAAQ,CAAC,0CAA0C,CAAC,CACxD,CAAC;QACF,iDAAuB,CAAC,kBAAkB,CACxC,oDAAoD,EACpD,OAAC;aACE,MAAM,CAAC;YACN,MAAM,EAAE,OAAC,CAAC,OAAO,CAAC,GAAG,CAAC;YACtB,SAAS,EAAE,OAAC,CAAC,OAAO,CAAC,kBAAkB,CAAC;YACxC,IAAI,EAAE,iDAAuB,CAAC,IAAI,CAAC,kBAAkB,CAAC;SACvD,CAAC;aACD,QAAQ,CAAC,oDAAoD,CAAC,CAClE,CAAC;QACF,iDAAuB,CAAC,YAAY,CAAC,CAAC,sCAA8B,CAAC,CAAC,CAAC;IACzE,CAAC;CACF;AApcD,oCAocC"}

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

@@ -0,0 +1,332 @@
+import { CommonHttpService } from "../core/CommonHttpService";
+import { type Content, type ContentArray } from "../models/common";
+import type { AttachmentPropertiesUpdateBody } from "../models/contentAttachments";
+export declare class ContentAttachmentsService extends CommonHttpService {
+    /**
+     * Adds an attachment to a piece of content. This method only adds a new
+     * attachment. If you want to update an existing attachment, use
+     * [Create or update attachments](#api-content-id-child-attachment-put).
+     *
+     * Note, you must set a `X-Atlassian-Token: nocheck` header on the request
+     * for this method, otherwise it will be blocked. This protects against XSRF
+     * attacks, which is necessary as this method accepts multipart/form-data.
+     *
+     * The media type 'multipart/form-data' is defined in [RFC
+     * 7578](https://www.ietf.org/rfc/rfc7578.txt).
+     * Most client libraries have classes that make it easier to implement
+     * multipart posts, like the
+     * [MultipartEntityBuilder](https://hc.apache.org/httpcomponents-client-5.1.x/current/httpclient5/apidocs/)
+     * Java class provided by Apache HTTP Components.
+     *
+     * Note, according to [RFC 7578](https://tools.ietf.org/html/rfc7578#section-4.5),
+     * in the case where the form data is text,
+     * the charset parameter for the "text/plain" Content-Type may be used to
+     * indicate the character encoding used in that part. In the case of this
+     * API endpoint, the `comment` body parameter should be sent with `type=text/plain`
+     * and `charset=utf-8` values. This will force the charset to be UTF-8.
+     *
+     * Example: This curl command attaches a file ('example.txt') to a container
+     * (id='123') with a comment and `minorEdits`=true.
+     *
+     * ``` bash
+     * curl -D- \
+     *   -u admin:admin \
+     *   -X POST \
+     *   -H 'X-Atlassian-Token: nocheck' \
+     *   -F 'file=@"example.txt"' \
+     *   -F 'minorEdit="true"' \
+     *   -F 'comment="Example attachment comment"; type=text/plain; charset=utf-8' \
+     *   http://myhost/rest/api/content/123/child/attachment
+     * ```
+     * **[Permissions](https://confluence.atlassian.com/x/_AozKw) required**:
+     * Permission to update the content.
+     *
+     * @returns Returned if the attachments were added to the content.
+     * @path {POST} /wiki/rest/api/content/{id}/child/attachment
+     * @scopes-current write:confluence-file
+     * @scopes-beta read:content-details:confluence, write:attachment:confluence
+     */
+    createAttachment({ id, status, requestBody, }: {
+        /** The ID of the content to add the attachment to. */
+        id: string;
+        /** The status of the content that the attachment is being added to. */
+        status?: "current" | "draft";
+        requestBody: unknown;
+    }): Promise<ContentArray>;
+    /**
+     * Adds an attachment to a piece of content. If the attachment already exists
+     * for the content, then the attachment is updated (i.e. a new version of the
+     * attachment is created).
+     *
+     * Note, you must set a `X-Atlassian-Token: nocheck` header on the request
+     * for this method, otherwise it will be blocked. This protects against XSRF
+     * attacks, which is necessary as this method accepts multipart/form-data.
+     *
+     * The media type 'multipart/form-data' is defined in [RFC
+     * 7578](https://www.ietf.org/rfc/rfc7578.txt).
+     * Most client libraries have classes that make it easier to implement
+     * multipart posts, like the
+     * [MultipartEntityBuilder](https://hc.apache.org/httpcomponents-client-5.1.x/current/httpclient5/apidocs/)
+     * Java class provided by Apache HTTP Components.
+     *
+     * Note, according to [RFC 7578](https://tools.ietf.org/html/rfc7578#section-4.5),
+     * in the case where the form data is text,
+     * the charset parameter for the "text/plain" Content-Type may be used to
+     * indicate the character encoding used in that part. In the case of this
+     * API endpoint, the `comment` body parameter should be sent with `type=text/plain`
+     * and `charset=utf-8` values. This will force the charset to be UTF-8.
+     *
+     * Example: This curl command attaches a file ('example.txt') to a piece of
+     * content (id='123') with a comment and `minorEdits`=true. If the 'example.txt'
+     * file already exists, it will update it with a new version of the attachment.
+     *
+     * ``` bash
+     * curl -D- \
+     *   -u admin:admin \
+     *   -X PUT \
+     *   -H 'X-Atlassian-Token: nocheck' \
+     *   -F 'file=@"example.txt"' \
+     *   -F 'minorEdit="true"' \
+     *   -F 'comment="Example attachment comment"; type=text/plain; charset=utf-8' \
+     *   http://myhost/rest/api/content/123/child/attachment
+     * ```
+     * **[Permissions](https://confluence.atlassian.com/x/_AozKw) required**:
+     * Permission to update the content.
+     *
+     * @returns Returned if the attachments were added to the content.
+     * @path {PUT} /wiki/rest/api/content/{id}/child/attachment
+     * @scopes-current write:confluence-file
+     * @scopes-beta read:content-details:confluence, write:attachment:confluence
+     */
+    createOrUpdateAttachments({ id, status, requestBody, }: {
+        /** The ID of the content to add the attachment to. */
+        id: string;
+        /**
+         * The status of the content that the attachment is being added to.
+         * This should always be set to 'current'.
+         */
+        status?: "current" | "draft";
+        requestBody: unknown;
+    }): Promise<ContentArray>;
+    /**
+     * Redirects the client to a URL that serves an attachment's binary data.
+     *
+     * @path {GET} /wiki/rest/api/content/{id}/child/attachment/{attachmentId}/download
+     * @scopes-current readonly:content.attachment:confluence
+     * @scopes-beta read:attachment:confluence
+     */
+    downloadAttatchment({ id, attachmentId, version, }: {
+        /** The ID of the content that the attachment is attached to. */
+        id: string;
+        /** The ID of the attachment to download. */
+        attachmentId: string;
+        /**
+         * The version of the attachment. If this parameter is absent, the redirect URI
+         * will download the latest version of the attachment.
+         */
+        version?: number;
+    }): Promise<void>;
+    /**
+     * Deprecated, use [Confluence's v2
+     * API](https://developer.atlassian.com/cloud/confluence/rest/v2/intro/).
+     *
+     * Returns the attachments for a piece of content.
+     *
+     * By default, the following objects are expanded: `metadata`.
+     *
+     * **[Permissions](https://confluence.atlassian.com/x/_AozKw) required**:
+     * Permission to view the content. If the content is a blog post, 'View' permission
+     * for the space is required.
+     *
+     * @deprecated
+     * @returns Returned if the requested attachments are returned.
+     * @path {GET} /wiki/rest/api/content/{id}/child/attachment
+     * @scopes-current read:confluence-content.summary
+     * @scopes-beta read:content-details:confluence
+     */
+    getAttachments({ id, expand, start, limit, filename, mediaType, }: {
+        /** The ID of the content to be queried for its attachments. */
+        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[];
+        /** The starting index of the returned attachments. */
+        start?: number;
+        /**
+         * The maximum number of attachments to return per page.
+         * Note, this may be restricted by fixed system limits.
+         */
+        limit?: number;
+        /** Filter the results to attachments that match the filename. */
+        filename?: string;
+        /** Filter the results to attachments that match the media type. */
+        mediaType?: string;
+    }): Promise<ContentArray>;
+    /**
+     * Updates the binary data of an attachment, given the attachment ID, and
+     * optionally the comment and the minor edit field.
+     *
+     * This method is essentially the same as [Create or update
+     * attachments](#api-content-id-child-attachment-put),
+     * except that it matches the attachment ID rather than the name.
+     *
+     * Note, you must set a `X-Atlassian-Token: nocheck` header on the request
+     * for this method, otherwise it will be blocked. This protects against XSRF
+     * attacks, which is necessary as this method accepts multipart/form-data.
+     *
+     * The media type 'multipart/form-data' is defined in [RFC
+     * 7578](https://www.ietf.org/rfc/rfc7578.txt).
+     * Most client libraries have classes that make it easier to implement
+     * multipart posts, like the
+     * [MultipartEntityBuilder](https://hc.apache.org/httpcomponents-client-5.1.x/current/httpclient5/apidocs/)
+     * Java class provided by Apache HTTP Components.
+     *
+     * Note, according to [RFC 7578](https://tools.ietf.org/html/rfc7578#section-4.5),
+     * in the case where the form data is text,
+     * the charset parameter for the "text/plain" Content-Type may be used to
+     * indicate the character encoding used in that part. In the case of this
+     * API endpoint, the `comment` body parameter should be sent with `type=text/plain`
+     * and `charset=utf-8` values. This will force the charset to be UTF-8.
+     *
+     * Example: This curl command updates an attachment (id='att456') that is attached
+     * to a piece of content (id='123') with a comment and `minorEdits`=true.
+     *
+     * ``` bash
+     * curl -D- \
+     *   -u admin:admin \
+     *   -X POST \
+     *   -H 'X-Atlassian-Token: nocheck' \
+     *   -F 'file=@"example.txt"' \
+     *   -F 'minorEdit="true"' \
+     *   -F 'comment="Example attachment comment"; type=text/plain; charset=utf-8' \
+     *   http://myhost/rest/api/content/123/child/attachment/att456/data
+     * ```
+     * **[Permissions](https://confluence.atlassian.com/x/_AozKw) required**:
+     * Permission to update the content.
+     *
+     * @returns Returned if the attachment is updated.
+     * @path {POST} /wiki/rest/api/content/{id}/child/attachment/{attachmentId}/data
+     * @scopes-current write:confluence-file
+     * @scopes-beta read:content-details:confluence, write:attachment:confluence
+     */
+    updateAttachmentData({ id, attachmentId, requestBody, }: {
+        /** The ID of the content that the attachment is attached to. */
+        id: string;
+        /** The ID of the attachment to update. */
+        attachmentId: string;
+        requestBody: unknown;
+    }): Promise<Content | null>;
+    /**
+     * Updates the attachment properties, i.e. the non-binary data of an attachment
+     * like the filename, media-type, comment, and parent container.
+     *
+     * **[Permissions](https://confluence.atlassian.com/x/_AozKw) required**:
+     * Permission to update the content.
+     *
+     * @returns Returned if the attachment is updated.
+     * @path {PUT} /wiki/rest/api/content/{id}/child/attachment/{attachmentId}
+     * @scopes-current write:confluence-file, write:confluence-props
+     * @scopes-beta read:content-details:confluence, write:attachment:confluence
+     */
+    updateAttachmentProperties({ id, attachmentId, attachmentPropertiesUpdateBody, }: {
+        /** The ID of the content that the attachment is attached to. */
+        id: string;
+        /** The ID of the attachment to update. */
+        attachmentId: string;
+        /** The details of the attachment to be updated. */
+        attachmentPropertiesUpdateBody: AttachmentPropertiesUpdateBody;
+    }): Promise<Content | null>;
+    static initialize(): void;
+}