@resolution/confluence-api-client 0.2.0

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

@@ -0,0 +1,502 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.ContentWatchesService = 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 contentWatches_1 = require("../models/contentWatches");
+const validationSchemaStorage_1 = require("../validationSchemaStorage");
+class ContentWatchesService extends CommonHttpService_1.CommonHttpService {
+    /**
+     * Adds a user as a watcher to a piece of content. Choose the user by doing
+     * one of the following:
+     *
+     * - Specify a user via a query parameter: Use the `accountId` to identify the
+     * user.
+     * - Do not specify a user: The currently logged-in user will be used.
+     *
+     * Note, you must add the `X-Atlassian-Token: no-check` header when making a
+     * request, as this operation has XSRF protection.
+     *
+     * **[Permissions](https://confluence.atlassian.com/x/_AozKw) required**:
+     * 'Confluence Administrator' global permission if specifying a user, otherwise
+     * permission to access the Confluence site ('Can use' global permission).
+     *
+     * @path {POST} /wiki/rest/api/user/watch/content/{contentId}
+     * @scopes-current write:confluence-content
+     * @scopes-beta write:watcher:confluence
+     */
+    addContentWatcher({ contentId, key, username, accountId, }) {
+        return this.getClientInstance()
+            .request({
+            path: "/wiki/rest/api/user/watch/content/{contentId}",
+            method: "POST",
+            pathParams: {
+                contentId,
+            },
+            query: {
+                key,
+                username,
+                accountId,
+            },
+        })
+            .then(commonHttpClient.discardResult);
+    }
+    /**
+     * Adds a user as a watcher to a label. Choose the user by doing one of the
+     * following:
+     *
+     * - Specify a user via a query parameter: Use the `accountId` to identify the
+     * user.
+     * - Do not specify a user: The currently logged-in user will be used.
+     *
+     * Note, you must add the `X-Atlassian-Token: no-check` header when making a
+     * request, as this operation has XSRF protection.
+     *
+     * **[Permissions](https://confluence.atlassian.com/x/_AozKw) required**:
+     * 'Confluence Administrator' global permission if specifying a user, otherwise
+     * permission to access the Confluence site ('Can use' global permission).
+     *
+     * @path {POST} /wiki/rest/api/user/watch/label/{labelName}
+     * @scopes-current write:confluence-content
+     * @scopes-beta write:watcher:confluence
+     */
+    addLabelWatcher({ labelName, key, username, accountId, xAtlassianToken, }) {
+        return this.getClientInstance()
+            .request({
+            path: "/wiki/rest/api/user/watch/label/{labelName}",
+            method: "POST",
+            pathParams: {
+                labelName,
+            },
+            query: {
+                key,
+                username,
+                accountId,
+            },
+            headers: {
+                "X-Atlassian-Token": xAtlassianToken,
+            },
+        })
+            .then(commonHttpClient.discardResult);
+    }
+    /**
+     * Adds a user as a watcher to a space. Choose the user by doing one of the
+     * following:
+     *
+     * - Specify a user via a query parameter: Use the `accountId` to identify the
+     * user.
+     * - Do not specify a user: The currently logged-in user will be used.
+     *
+     * Note, you must add the `X-Atlassian-Token: no-check` header when making a
+     * request, as this operation has XSRF protection.
+     *
+     * **[Permissions](https://confluence.atlassian.com/x/_AozKw) required**:
+     * 'Confluence Administrator' global permission if specifying a user, otherwise
+     * permission to access the Confluence site ('Can use' global permission).
+     *
+     * @path {POST} /wiki/rest/api/user/watch/space/{spaceKey}
+     * @scopes-current write:confluence-content
+     * @scopes-beta write:watcher:confluence
+     */
+    addSpaceWatcher({ spaceKey, key, username, accountId, xAtlassianToken, }) {
+        return this.getClientInstance()
+            .request({
+            path: "/wiki/rest/api/user/watch/space/{spaceKey}",
+            method: "POST",
+            pathParams: {
+                spaceKey,
+            },
+            query: {
+                key,
+                username,
+                accountId,
+            },
+            headers: {
+                "X-Atlassian-Token": xAtlassianToken,
+            },
+        })
+            .then(commonHttpClient.discardResult);
+    }
+    /**
+     * Returns whether a user is watching a piece of content. Choose the user by
+     * doing one of the following:
+     *
+     * - Specify a user via a query parameter: Use the `accountId` to identify the
+     * user.
+     * - Do not specify a user: The currently logged-in user will be used.
+     *
+     * **[Permissions](https://confluence.atlassian.com/x/_AozKw) required**:
+     * 'Confluence Administrator' global permission if specifying a user, otherwise
+     * permission to access the Confluence site ('Can use' global permission).
+     *
+     * @returns Returned if the requested watch status is returned.
+     * @path {GET} /wiki/rest/api/user/watch/content/{contentId}
+     * @scopes-current read:confluence-content.summary
+     * @scopes-beta read:watcher:confluence
+     */
+    getContentWatchStatus({ contentId, key, username, accountId, }) {
+        return this.getClientInstance()
+            .request({
+            path: "/wiki/rest/api/user/watch/content/{contentId}",
+            method: "GET",
+            pathParams: {
+                contentId,
+            },
+            query: {
+                key,
+                username,
+                accountId,
+            },
+        })
+            .then(this.getClientInstance().responseHandler({
+            200: {
+                "application/json": "json",
+            },
+        }))
+            .then(commonHttpClient.castResponse())
+            .then(validationSchemaStorage_1.validationSchemaStorage.validator("ContentWatchesService.getContentWatchStatus.response"))
+            .then(commonHttpClient.getBody);
+    }
+    /**
+     * Returns a list of watchers of a space
+     *
+     * @returns Returned if watchers list is returned.
+     * @path {GET} /wiki/rest/api/space/{spaceKey}/watch
+     * @scopes-current read:watcher:confluence, read:user:confluence
+     */
+    getWatchersForSpace({ spaceKey, start, limit, }) {
+        return this.getClientInstance()
+            .request({
+            path: "/wiki/rest/api/space/{spaceKey}/watch",
+            method: "GET",
+            pathParams: {
+                spaceKey,
+            },
+            query: {
+                start,
+                limit,
+            },
+        })
+            .then(this.getClientInstance().responseHandler({
+            200: {
+                "application/json": "json",
+            },
+        }))
+            .then(commonHttpClient.castResponse())
+            .then(validationSchemaStorage_1.validationSchemaStorage.validator("ContentWatchesService.getWatchersForSpace.response"))
+            .then(commonHttpClient.getBody);
+    }
+    /**
+     * Returns the watches for a page. A user that watches a page will receive
+     * receive notifications when the page is updated.
+     *
+     * If you want to manage watches for a page, use the following `user` methods:
+     *
+     * - [Get content watch status for user](#api-user-watch-content-contentId-get)
+     * - [Add content watch](#api-user-watch-content-contentId-post)
+     * - [Remove content watch](#api-user-watch-content-contentId-delete)
+     *
+     * **[Permissions](https://confluence.atlassian.com/x/_AozKw) required**:
+     * Permission to access the Confluence site ('Can use' global permission).
+     *
+     * @returns Returned if the requested watches are returned.
+     * @path {GET} /wiki/rest/api/content/{id}/notification/child-created
+     * @scopes-current read:confluence-content.summary
+     * @scopes-beta read:watcher:confluence, read:user:confluence
+     */
+    getWatchesForPage({ id, start, limit, }) {
+        return this.getClientInstance()
+            .request({
+            path: "/wiki/rest/api/content/{id}/notification/child-created",
+            method: "GET",
+            pathParams: {
+                id,
+            },
+            query: {
+                start,
+                limit,
+            },
+        })
+            .then(this.getClientInstance().responseHandler({
+            200: {
+                "application/json": "json",
+            },
+        }))
+            .then(commonHttpClient.castResponse())
+            .then(validationSchemaStorage_1.validationSchemaStorage.validator("ContentWatchesService.getWatchesForPage.response"))
+            .then(commonHttpClient.getBody);
+    }
+    /**
+     * Returns all space watches for the space that the content is in. A user that
+     * watches a space will receive receive notifications when any content in the
+     * space is updated.
+     *
+     * If you want to manage watches for a space, use the following `user` methods:
+     *
+     * - [Get space watch status for user](#api-user-watch-space-spaceKey-get)
+     * - [Add space watch](#api-user-watch-space-spaceKey-post)
+     * - [Remove space watch](#api-user-watch-space-spaceKey-delete)
+     *
+     * **[Permissions](https://confluence.atlassian.com/x/_AozKw) required**:
+     * Permission to access the Confluence site ('Can use' global permission).
+     *
+     * @returns Returned if the requested watches are returned.
+     * @path {GET} /wiki/rest/api/content/{id}/notification/created
+     * @scopes-current read:confluence-content.summary
+     * @scopes-beta read:watcher:confluence, read:user:confluence
+     */
+    getWatchesForSpace({ id, start, limit, }) {
+        return this.getClientInstance()
+            .request({
+            path: "/wiki/rest/api/content/{id}/notification/created",
+            method: "GET",
+            pathParams: {
+                id,
+            },
+            query: {
+                start,
+                limit,
+            },
+        })
+            .then(this.getClientInstance().responseHandler({
+            200: {
+                "application/json": "json",
+            },
+        }))
+            .then(commonHttpClient.castResponse())
+            .then(validationSchemaStorage_1.validationSchemaStorage.validator("ContentWatchesService.getWatchesForSpace.response"))
+            .then(commonHttpClient.getBody);
+    }
+    /**
+     * Returns whether a user is watching a label. Choose the user by doing one
+     * of the following:
+     *
+     * - Specify a user via a query parameter: Use the `accountId` to identify the
+     * user.
+     * - Do not specify a user: The currently logged-in user will be used.
+     *
+     * **[Permissions](https://confluence.atlassian.com/x/_AozKw) required**:
+     * 'Confluence Administrator' global permission if specifying a user, otherwise
+     * permission to access the Confluence site ('Can use' global permission).
+     *
+     * @returns Returned if the requested watch status is returned.
+     * @path {GET} /wiki/rest/api/user/watch/label/{labelName}
+     * @scopes-current read:confluence-content.summary
+     * @scopes-beta read:watcher:confluence
+     */
+    isWatchingLabel({ labelName, key, username, accountId, }) {
+        return this.getClientInstance()
+            .request({
+            path: "/wiki/rest/api/user/watch/label/{labelName}",
+            method: "GET",
+            pathParams: {
+                labelName,
+            },
+            query: {
+                key,
+                username,
+                accountId,
+            },
+        })
+            .then(this.getClientInstance().responseHandler({
+            200: {
+                "application/json": "json",
+            },
+        }))
+            .then(commonHttpClient.castResponse())
+            .then(validationSchemaStorage_1.validationSchemaStorage.validator("ContentWatchesService.isWatchingLabel.response"))
+            .then(commonHttpClient.getBody);
+    }
+    /**
+     * Returns whether a user is watching a space. Choose the user by
+     * doing one of the following:
+     *
+     * - Specify a user via a query parameter: Use the `accountId` to identify the
+     * user.
+     * - Do not specify a user: The currently logged-in user will be used.
+     *
+     * **[Permissions](https://confluence.atlassian.com/x/_AozKw) required**:
+     * 'Confluence Administrator' global permission if specifying a user, otherwise
+     * permission to access the Confluence site ('Can use' global permission).
+     *
+     * @returns Returned if the requested watch status is returned.
+     * @path {GET} /wiki/rest/api/user/watch/space/{spaceKey}
+     * @scopes-current read:confluence-content.summary
+     * @scopes-beta read:watcher:confluence
+     */
+    isWatchingSpace({ spaceKey, key, username, accountId, }) {
+        return this.getClientInstance()
+            .request({
+            path: "/wiki/rest/api/user/watch/space/{spaceKey}",
+            method: "GET",
+            pathParams: {
+                spaceKey,
+            },
+            query: {
+                key,
+                username,
+                accountId,
+            },
+        })
+            .then(this.getClientInstance().responseHandler({
+            200: {
+                "application/json": "json",
+            },
+        }))
+            .then(commonHttpClient.castResponse())
+            .then(validationSchemaStorage_1.validationSchemaStorage.validator("ContentWatchesService.isWatchingSpace.response"))
+            .then(commonHttpClient.getBody);
+    }
+    /**
+     * Removes a user as a watcher from a piece of content. Choose the user by
+     * doing one of the following:
+     *
+     * - Specify a user via a query parameter: Use the `accountId` to identify the
+     * user.
+     * - Do not specify a user: The currently logged-in user will be used.
+     *
+     * **[Permissions](https://confluence.atlassian.com/x/_AozKw) required**:
+     * 'Confluence Administrator' global permission if specifying a user, otherwise
+     * permission to access the Confluence site ('Can use' global permission).
+     *
+     * @path {DELETE} /wiki/rest/api/user/watch/content/{contentId}
+     * @scopes-current write:confluence-content
+     * @scopes-beta write:watcher:confluence
+     */
+    removeContentWatcher({ contentId, key, username, accountId, xAtlassianToken, }) {
+        return this.getClientInstance()
+            .request({
+            path: "/wiki/rest/api/user/watch/content/{contentId}",
+            method: "DELETE",
+            pathParams: {
+                contentId,
+            },
+            query: {
+                key,
+                username,
+                accountId,
+            },
+            headers: {
+                "X-Atlassian-Token": xAtlassianToken,
+            },
+        })
+            .then(commonHttpClient.discardResult);
+    }
+    /**
+     * Removes a user as a watcher from a label. Choose the user by doing one of
+     * the following:
+     *
+     * - Specify a user via a query parameter: Use the `accountId` to identify the
+     * user.
+     * - Do not specify a user: The currently logged-in user will be used.
+     *
+     * **[Permissions](https://confluence.atlassian.com/x/_AozKw) required**:
+     * 'Confluence Administrator' global permission if specifying a user, otherwise
+     * permission to access the Confluence site ('Can use' global permission).
+     *
+     * @path {DELETE} /wiki/rest/api/user/watch/label/{labelName}
+     * @scopes-current write:confluence-content
+     * @scopes-beta write:watcher:confluence
+     */
+    removeLabelWatcher({ labelName, key, username, accountId, }) {
+        return this.getClientInstance()
+            .request({
+            path: "/wiki/rest/api/user/watch/label/{labelName}",
+            method: "DELETE",
+            pathParams: {
+                labelName,
+            },
+            query: {
+                key,
+                username,
+                accountId,
+            },
+        })
+            .then(commonHttpClient.discardResult);
+    }
+    /**
+     * Removes a user as a watcher from a space. Choose the user by doing one of
+     * the following:
+     *
+     * - Specify a user via a query parameter: Use the `accountId` to identify the
+     * user.
+     * - Do not specify a user: The currently logged-in user will be used.
+     *
+     * **[Permissions](https://confluence.atlassian.com/x/_AozKw) required**:
+     * 'Confluence Administrator' global permission if specifying a user, otherwise
+     * permission to access the Confluence site ('Can use' global permission).
+     *
+     * @path {DELETE} /wiki/rest/api/user/watch/space/{spaceKey}
+     * @scopes-current write:confluence-content
+     * @scopes-beta write:watcher:confluence
+     */
+    removeSpaceWatch({ spaceKey, key, username, accountId, }) {
+        return this.getClientInstance()
+            .request({
+            path: "/wiki/rest/api/user/watch/space/{spaceKey}",
+            method: "DELETE",
+            pathParams: {
+                spaceKey,
+            },
+            query: {
+                key,
+                username,
+                accountId,
+            },
+        })
+            .then(commonHttpClient.discardResult);
+    }
+    static initialize() {
+        validationSchemaStorage_1.validationSchemaStorage.registerExtensible("ContentWatchesService.getWatchesForPage.response", zod_1.z
+            .object({
+            status: zod_1.z.literal(200),
+            mediaType: zod_1.z.literal("application/json"),
+            body: validationSchemaStorage_1.validationSchemaStorage.lazy("WatchArray"),
+        })
+            .describe("ContentWatchesService.getWatchesForPage.response"));
+        validationSchemaStorage_1.validationSchemaStorage.registerExtensible("ContentWatchesService.getWatchesForSpace.response", zod_1.z
+            .object({
+            status: zod_1.z.literal(200),
+            mediaType: zod_1.z.literal("application/json"),
+            body: validationSchemaStorage_1.validationSchemaStorage.lazy("SpaceWatchArray"),
+        })
+            .describe("ContentWatchesService.getWatchesForSpace.response"));
+        validationSchemaStorage_1.validationSchemaStorage.registerExtensible("ContentWatchesService.getWatchersForSpace.response", zod_1.z
+            .object({
+            status: zod_1.z.literal(200),
+            mediaType: zod_1.z.literal("application/json"),
+            body: validationSchemaStorage_1.validationSchemaStorage.lazy("SpaceWatchArray"),
+        })
+            .describe("ContentWatchesService.getWatchersForSpace.response"));
+        validationSchemaStorage_1.validationSchemaStorage.registerExtensible("ContentWatchesService.getContentWatchStatus.response", zod_1.z
+            .object({
+            status: zod_1.z.literal(200),
+            mediaType: zod_1.z.literal("application/json"),
+            body: validationSchemaStorage_1.validationSchemaStorage.lazy("UserWatch"),
+        })
+            .describe("ContentWatchesService.getContentWatchStatus.response"));
+        validationSchemaStorage_1.validationSchemaStorage.registerExtensible("ContentWatchesService.isWatchingLabel.response", zod_1.z
+            .object({
+            status: zod_1.z.literal(200),
+            mediaType: zod_1.z.literal("application/json"),
+            body: validationSchemaStorage_1.validationSchemaStorage.lazy("UserWatch"),
+        })
+            .describe("ContentWatchesService.isWatchingLabel.response"));
+        validationSchemaStorage_1.validationSchemaStorage.registerExtensible("ContentWatchesService.isWatchingSpace.response", zod_1.z
+            .object({
+            status: zod_1.z.literal(200),
+            mediaType: zod_1.z.literal("application/json"),
+            body: validationSchemaStorage_1.validationSchemaStorage.lazy("UserWatch"),
+        })
+            .describe("ContentWatchesService.isWatchingSpace.response"));
+        validationSchemaStorage_1.validationSchemaStorage.registerOnce([
+            contentWatches_1.registerContentWatchesValidationSchemas,
+        ]);
+    }
+}
+exports.ContentWatchesService = ContentWatchesService;
+//# sourceMappingURL=ContentWatchesService.js.map

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

@@ -0,0 +1 @@
+{"version":3,"file":"ContentWatchesService.js","sourceRoot":"","sources":["../../../../src/openapi/v1/services/ContentWatchesService.ts"],"names":[],"mappings":";;;AAAA,eAAe;AACf,wDAAwD;AACxD,gDAAgD;AAChD,6BAAwB;AAExB,6DAA6D;AAC7D,iEAA8D;AAC9D,6DAKkC;AAClC,wEAAqE;AACrE,MAAa,qBAAsB,SAAQ,qCAAiB;IAC1D;;;;;;;;;;;;;;;;;;OAkBG;IACH,iBAAiB,CAAC,EAChB,SAAS,EACT,GAAG,EACH,QAAQ,EACR,SAAS,GAgCV;QACC,OAAO,IAAI,CAAC,iBAAiB,EAAE;aAC5B,OAAO,CAAC;YACP,IAAI,EAAE,+CAA+C;YACrD,MAAM,EAAE,MAAM;YACd,UAAU,EAAE;gBACV,SAAS;aACV;YACD,KAAK,EAAE;gBACL,GAAG;gBACH,QAAQ;gBACR,SAAS;aACV;SACF,CAAC;aACD,IAAI,CAAC,gBAAgB,CAAC,aAAa,CAAC,CAAC;IAC1C,CAAC;IACD;;;;;;;;;;;;;;;;;;OAkBG;IACH,eAAe,CAAC,EACd,SAAS,EACT,GAAG,EACH,QAAQ,EACR,SAAS,EACT,eAAe,GAqChB;QACC,OAAO,IAAI,CAAC,iBAAiB,EAAE;aAC5B,OAAO,CAAC;YACP,IAAI,EAAE,6CAA6C;YACnD,MAAM,EAAE,MAAM;YACd,UAAU,EAAE;gBACV,SAAS;aACV;YACD,KAAK,EAAE;gBACL,GAAG;gBACH,QAAQ;gBACR,SAAS;aACV;YACD,OAAO,EAAE;gBACP,mBAAmB,EAAE,eAAe;aACrC;SACF,CAAC;aACD,IAAI,CAAC,gBAAgB,CAAC,aAAa,CAAC,CAAC;IAC1C,CAAC;IACD;;;;;;;;;;;;;;;;;;OAkBG;IACH,eAAe,CAAC,EACd,QAAQ,EACR,GAAG,EACH,QAAQ,EACR,SAAS,EACT,eAAe,GAqChB;QACC,OAAO,IAAI,CAAC,iBAAiB,EAAE;aAC5B,OAAO,CAAC;YACP,IAAI,EAAE,4CAA4C;YAClD,MAAM,EAAE,MAAM;YACd,UAAU,EAAE;gBACV,QAAQ;aACT;YACD,KAAK,EAAE;gBACL,GAAG;gBACH,QAAQ;gBACR,SAAS;aACV;YACD,OAAO,EAAE;gBACP,mBAAmB,EAAE,eAAe;aACrC;SACF,CAAC;aACD,IAAI,CAAC,gBAAgB,CAAC,aAAa,CAAC,CAAC;IAC1C,CAAC;IACD;;;;;;;;;;;;;;;;OAgBG;IACH,qBAAqB,CAAC,EACpB,SAAS,EACT,GAAG,EACH,QAAQ,EACR,SAAS,GAmCV;QACC,OAAO,IAAI,CAAC,iBAAiB,EAAE;aAC5B,OAAO,CAAC;YACP,IAAI,EAAE,+CAA+C;YACrD,MAAM,EAAE,KAAK;YACb,UAAU,EAAE;gBACV,SAAS;aACV;YACD,KAAK,EAAE;gBACL,GAAG;gBACH,QAAQ;gBACR,SAAS;aACV;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,sDAAsD,CACvD,CACF;aACA,IAAI,CAAC,gBAAgB,CAAC,OAAO,CAAC,CAAC;IACpC,CAAC;IACD;;;;;;OAMG;IACH,mBAAmB,CAAC,EAClB,QAAQ,EACR,KAAK,EACL,KAAK,GAWN;QACC,OAAO,IAAI,CAAC,iBAAiB,EAAE;aAC5B,OAAO,CAAC;YACP,IAAI,EAAE,uCAAuC;YAC7C,MAAM,EAAE,KAAK;YACb,UAAU,EAAE;gBACV,QAAQ;aACT;YACD,KAAK,EAAE;gBACL,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;;;;;;;;;;;;;;;;;OAiBG;IACH,iBAAiB,CAAC,EAChB,EAAE,EACF,KAAK,EACL,KAAK,GAWN;QACC,OAAO,IAAI,CAAC,iBAAiB,EAAE;aAC5B,OAAO,CAAC;YACP,IAAI,EAAE,wDAAwD;YAC9D,MAAM,EAAE,KAAK;YACb,UAAU,EAAE;gBACV,EAAE;aACH;YACD,KAAK,EAAE;gBACL,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,kDAAkD,CACnD,CACF;aACA,IAAI,CAAC,gBAAgB,CAAC,OAAO,CAAC,CAAC;IACpC,CAAC;IACD;;;;;;;;;;;;;;;;;;OAkBG;IACH,kBAAkB,CAAC,EACjB,EAAE,EACF,KAAK,EACL,KAAK,GAWN;QACC,OAAO,IAAI,CAAC,iBAAiB,EAAE;aAC5B,OAAO,CAAC;YACP,IAAI,EAAE,kDAAkD;YACxD,MAAM,EAAE,KAAK;YACb,UAAU,EAAE;gBACV,EAAE;aACH;YACD,KAAK,EAAE;gBACL,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,mDAAmD,CACpD,CACF;aACA,IAAI,CAAC,gBAAgB,CAAC,OAAO,CAAC,CAAC;IACpC,CAAC;IACD;;;;;;;;;;;;;;;;OAgBG;IACH,eAAe,CAAC,EACd,SAAS,EACT,GAAG,EACH,QAAQ,EACR,SAAS,GAmCV;QACC,OAAO,IAAI,CAAC,iBAAiB,EAAE;aAC5B,OAAO,CAAC;YACP,IAAI,EAAE,6CAA6C;YACnD,MAAM,EAAE,KAAK;YACb,UAAU,EAAE;gBACV,SAAS;aACV;YACD,KAAK,EAAE;gBACL,GAAG;gBACH,QAAQ;gBACR,SAAS;aACV;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,gDAAgD,CACjD,CACF;aACA,IAAI,CAAC,gBAAgB,CAAC,OAAO,CAAC,CAAC;IACpC,CAAC;IACD;;;;;;;;;;;;;;;;OAgBG;IACH,eAAe,CAAC,EACd,QAAQ,EACR,GAAG,EACH,QAAQ,EACR,SAAS,GAmCV;QACC,OAAO,IAAI,CAAC,iBAAiB,EAAE;aAC5B,OAAO,CAAC;YACP,IAAI,EAAE,4CAA4C;YAClD,MAAM,EAAE,KAAK;YACb,UAAU,EAAE;gBACV,QAAQ;aACT;YACD,KAAK,EAAE;gBACL,GAAG;gBACH,QAAQ;gBACR,SAAS;aACV;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,gDAAgD,CACjD,CACF;aACA,IAAI,CAAC,gBAAgB,CAAC,OAAO,CAAC,CAAC;IACpC,CAAC;IACD;;;;;;;;;;;;;;;OAeG;IACH,oBAAoB,CAAC,EACnB,SAAS,EACT,GAAG,EACH,QAAQ,EACR,SAAS,EACT,eAAe,GAqChB;QACC,OAAO,IAAI,CAAC,iBAAiB,EAAE;aAC5B,OAAO,CAAC;YACP,IAAI,EAAE,+CAA+C;YACrD,MAAM,EAAE,QAAQ;YAChB,UAAU,EAAE;gBACV,SAAS;aACV;YACD,KAAK,EAAE;gBACL,GAAG;gBACH,QAAQ;gBACR,SAAS;aACV;YACD,OAAO,EAAE;gBACP,mBAAmB,EAAE,eAAe;aACrC;SACF,CAAC;aACD,IAAI,CAAC,gBAAgB,CAAC,aAAa,CAAC,CAAC;IAC1C,CAAC;IACD;;;;;;;;;;;;;;;OAeG;IACH,kBAAkB,CAAC,EACjB,SAAS,EACT,GAAG,EACH,QAAQ,EACR,SAAS,GAgCV;QACC,OAAO,IAAI,CAAC,iBAAiB,EAAE;aAC5B,OAAO,CAAC;YACP,IAAI,EAAE,6CAA6C;YACnD,MAAM,EAAE,QAAQ;YAChB,UAAU,EAAE;gBACV,SAAS;aACV;YACD,KAAK,EAAE;gBACL,GAAG;gBACH,QAAQ;gBACR,SAAS;aACV;SACF,CAAC;aACD,IAAI,CAAC,gBAAgB,CAAC,aAAa,CAAC,CAAC;IAC1C,CAAC;IACD;;;;;;;;;;;;;;;OAeG;IACH,gBAAgB,CAAC,EACf,QAAQ,EACR,GAAG,EACH,QAAQ,EACR,SAAS,GAgCV;QACC,OAAO,IAAI,CAAC,iBAAiB,EAAE;aAC5B,OAAO,CAAC;YACP,IAAI,EAAE,4CAA4C;YAClD,MAAM,EAAE,QAAQ;YAChB,UAAU,EAAE;gBACV,QAAQ;aACT;YACD,KAAK,EAAE;gBACL,GAAG;gBACH,QAAQ;gBACR,SAAS;aACV;SACF,CAAC;aACD,IAAI,CAAC,gBAAgB,CAAC,aAAa,CAAC,CAAC;IAC1C,CAAC;IACD,MAAM,CAAC,UAAU;QACf,iDAAuB,CAAC,kBAAkB,CACxC,kDAAkD,EAClD,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,YAAY,CAAC;SACjD,CAAC;aACD,QAAQ,CAAC,kDAAkD,CAAC,CAChE,CAAC;QACF,iDAAuB,CAAC,kBAAkB,CACxC,mDAAmD,EACnD,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,mDAAmD,CAAC,CACjE,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,iBAAiB,CAAC;SACtD,CAAC;aACD,QAAQ,CAAC,oDAAoD,CAAC,CAClE,CAAC;QACF,iDAAuB,CAAC,kBAAkB,CACxC,sDAAsD,EACtD,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,WAAW,CAAC;SAChD,CAAC;aACD,QAAQ,CAAC,sDAAsD,CAAC,CACpE,CAAC;QACF,iDAAuB,CAAC,kBAAkB,CACxC,gDAAgD,EAChD,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,WAAW,CAAC;SAChD,CAAC;aACD,QAAQ,CAAC,gDAAgD,CAAC,CAC9D,CAAC;QACF,iDAAuB,CAAC,kBAAkB,CACxC,gDAAgD,EAChD,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,WAAW,CAAC;SAChD,CAAC;aACD,QAAQ,CAAC,gDAAgD,CAAC,CAC9D,CAAC;QACF,iDAAuB,CAAC,YAAY,CAAC;YACnC,wDAAuC;SACxC,CAAC,CAAC;IACL,CAAC;CACF;AA38BD,sDA28BC"}

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

@@ -0,0 +1,47 @@
+import { CommonHttpService } from "../core/CommonHttpService";
+import { type ConnectModules } from "../models/dynamicModules";
+export declare class DynamicModulesService extends CommonHttpService {
+    /**
+     * Returns all modules registered dynamically by the calling app.
+     *
+     * **[Permissions](#permissions) required:** Only Connect apps can make this
+     * request.
+     *
+     * @returns Returned if the request is successful.
+     * @path {GET} /atlassian-connect/1/app/module/dynamic
+     */
+    getModules(): Promise<Blob>;
+    /**
+     * Registers a list of modules. For the list of modules that support dynamic
+     * registration, see [Dynamic
+     * modules](https://developer.atlassian.com/cloud/confluence/dynamic-modules/).
+     *
+     * **[Permissions](#permissions) required:** Only Connect apps can make this
+     * request.
+     *
+     * @path {POST} /atlassian-connect/1/app/module/dynamic
+     */
+    registerModules({ mediaType, connectModules, }: {
+        mediaType: string;
+        connectModules: ConnectModules;
+    }): Promise<void>;
+    /**
+     * Remove all or a list of modules registered by the calling app.
+     *
+     * **[Permissions](#permissions) required:** Only Connect apps can make this
+     * request.
+     *
+     * @path {DELETE} /atlassian-connect/1/app/module/dynamic
+     */
+    removeModules({ moduleKey, }: {
+        /**
+         * The key of the module to remove. To include multiple module keys, provide
+         * multiple copies of this parameter.
+         * For example,
+         * `moduleKey=dynamic-attachment-entity-property&moduleKey=dynamic-select-field`.
+         * Nonexistent keys are ignored.
+         */
+        moduleKey: string[];
+    }): Promise<void>;
+    static initialize(): void;
+}

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

@@ -0,0 +1,92 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.DynamicModulesService = 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 dynamicModules_1 = require("../models/dynamicModules");
+const validationSchemaStorage_1 = require("../validationSchemaStorage");
+class DynamicModulesService extends CommonHttpService_1.CommonHttpService {
+    /**
+     * Returns all modules registered dynamically by the calling app.
+     *
+     * **[Permissions](#permissions) required:** Only Connect apps can make this
+     * request.
+     *
+     * @returns Returned if the request is successful.
+     * @path {GET} /atlassian-connect/1/app/module/dynamic
+     */
+    getModules() {
+        return this.getClientInstance()
+            .request({
+            path: "/atlassian-connect/1/app/module/dynamic",
+            method: "GET",
+        })
+            .then(this.getClientInstance().responseHandler({
+            200: {
+                "*/*": "blob",
+            },
+        }))
+            .then(commonHttpClient.castResponse())
+            .then(validationSchemaStorage_1.validationSchemaStorage.validator("DynamicModulesService.getModules.response"))
+            .then(commonHttpClient.getBody);
+    }
+    /**
+     * Registers a list of modules. For the list of modules that support dynamic
+     * registration, see [Dynamic
+     * modules](https://developer.atlassian.com/cloud/confluence/dynamic-modules/).
+     *
+     * **[Permissions](#permissions) required:** Only Connect apps can make this
+     * request.
+     *
+     * @path {POST} /atlassian-connect/1/app/module/dynamic
+     */
+    registerModules({ mediaType, connectModules, }) {
+        return this.getClientInstance()
+            .request({
+            path: "/atlassian-connect/1/app/module/dynamic",
+            method: "POST",
+            headers: {
+                "Content-Type": mediaType,
+            },
+            body: connectModules,
+        })
+            .then(commonHttpClient.discardResult);
+    }
+    /**
+     * Remove all or a list of modules registered by the calling app.
+     *
+     * **[Permissions](#permissions) required:** Only Connect apps can make this
+     * request.
+     *
+     * @path {DELETE} /atlassian-connect/1/app/module/dynamic
+     */
+    removeModules({ moduleKey, }) {
+        return this.getClientInstance()
+            .request({
+            path: "/atlassian-connect/1/app/module/dynamic",
+            method: "DELETE",
+            query: {
+                moduleKey,
+            },
+        })
+            .then(commonHttpClient.discardResult);
+    }
+    static initialize() {
+        validationSchemaStorage_1.validationSchemaStorage.registerExtensible("DynamicModulesService.getModules.response", zod_1.z
+            .object({
+            status: zod_1.z.literal(200),
+            mediaType: zod_1.z.string(),
+            body: validationSchemaStorage_1.validationSchemaStorage.lazy("ConnectModules"),
+        })
+            .describe("DynamicModulesService.getModules.response"));
+        validationSchemaStorage_1.validationSchemaStorage.registerOnce([
+            dynamicModules_1.registerDynamicModulesValidationSchemas,
+        ]);
+    }
+}
+exports.DynamicModulesService = DynamicModulesService;
+//# sourceMappingURL=DynamicModulesService.js.map

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

@@ -0,0 +1 @@
+{"version":3,"file":"DynamicModulesService.js","sourceRoot":"","sources":["../../../../src/openapi/v1/services/DynamicModulesService.ts"],"names":[],"mappings":";;;AAAA,eAAe;AACf,wDAAwD;AACxD,gDAAgD;AAChD,6BAAwB;AAExB,6DAA6D;AAC7D,iEAA8D;AAC9D,6DAGkC;AAClC,wEAAqE;AACrE,MAAa,qBAAsB,SAAQ,qCAAiB;IAC1D;;;;;;;;OAQG;IACH,UAAU;QACR,OAAO,IAAI,CAAC,iBAAiB,EAAE;aAC5B,OAAO,CAAC;YACP,IAAI,EAAE,yCAAyC;YAC/C,MAAM,EAAE,KAAK;SACd,CAAC;aACD,IAAI,CACH,IAAI,CAAC,iBAAiB,EAAE,CAAC,eAAe,CAAC;YACvC,GAAG,EAAE;gBACH,KAAK,EAAE,MAAM;aACd;SACF,CAAC,CACH;aACA,IAAI,CACH,gBAAgB,CAAC,YAAY,EAIzB,CACL;aACA,IAAI,CACH,iDAAuB,CAAC,SAAS,CAC/B,2CAA2C,CAC5C,CACF;aACA,IAAI,CAAC,gBAAgB,CAAC,OAAO,CAAC,CAAC;IACpC,CAAC;IACD;;;;;;;;;OASG;IACH,eAAe,CAAC,EACd,SAAS,EACT,cAAc,GAIf;QACC,OAAO,IAAI,CAAC,iBAAiB,EAAE;aAC5B,OAAO,CAAC;YACP,IAAI,EAAE,yCAAyC;YAC/C,MAAM,EAAE,MAAM;YACd,OAAO,EAAE;gBACP,cAAc,EAAE,SAAS;aAC1B;YACD,IAAI,EAAE,cAAc;SACrB,CAAC;aACD,IAAI,CAAC,gBAAgB,CAAC,aAAa,CAAC,CAAC;IAC1C,CAAC;IACD;;;;;;;OAOG;IACH,aAAa,CAAC,EACZ,SAAS,GAUV;QACC,OAAO,IAAI,CAAC,iBAAiB,EAAE;aAC5B,OAAO,CAAC;YACP,IAAI,EAAE,yCAAyC;YAC/C,MAAM,EAAE,QAAQ;YAChB,KAAK,EAAE;gBACL,SAAS;aACV;SACF,CAAC;aACD,IAAI,CAAC,gBAAgB,CAAC,aAAa,CAAC,CAAC;IAC1C,CAAC;IACD,MAAM,CAAC,UAAU;QACf,iDAAuB,CAAC,kBAAkB,CACxC,2CAA2C,EAC3C,OAAC;aACE,MAAM,CAAC;YACN,MAAM,EAAE,OAAC,CAAC,OAAO,CAAC,GAAG,CAAC;YACtB,SAAS,EAAE,OAAC,CAAC,MAAM,EAAE;YACrB,IAAI,EAAE,iDAAuB,CAAC,IAAI,CAAC,gBAAgB,CAAC;SACrD,CAAC;aACD,QAAQ,CAAC,2CAA2C,CAAC,CACzD,CAAC;QACF,iDAAuB,CAAC,YAAY,CAAC;YACnC,wDAAuC;SACxC,CAAC,CAAC;IACL,CAAC;CACF;AA9GD,sDA8GC"}