@resolution/jira-api-client 0.1.0

package/lib/openapi/platform/services/avatars-service.js

@@ -0,0 +1,523 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.AvatarsService = void 0;
+const zod_1 = require("zod");
+const commonHttpClient = require("../core/common-http-client");
+const common_http_service_1 = require("../core/common-http-service");
+const avatars_1 = require("../models/avatars");
+const common_1 = require("../models/common");
+const validation_schema_storage_1 = require("../validation-schema-storage");
+/**
+ * This resource represents system and custom avatars. Use it to obtain the
+ * details of system or custom avatars, add and remove avatars from a project or
+ * issue type, and obtain avatar images.
+ */
+class AvatarsService extends common_http_service_1.CommonHttpService {
+    /**
+     * Deletes an avatar from a project or issue type.
+     *
+     * **[Permissions](#permissions) required:** *Administer Jira* [global
+     * permission](https://confluence.atlassian.com/x/x4dKLg).
+     *
+     * @path {DELETE}
+     * /rest/api/3/universal_avatar/type/{type}/owner/{owningObjectId}/avatar/{id}
+     * @scopes-current manage:jira-configuration
+     * @scopes-beta delete:avatar:jira
+     */
+    deleteAvatar({ type, owningObjectId, id, }) {
+        return this.getClientInstance()
+            .request({
+            path: "/rest/api/3/universal_avatar/type/{type}/owner/{owningObjectId}/avatar/{id}",
+            method: "DELETE",
+            pathParams: {
+                type,
+                owningObjectId,
+                id,
+            },
+        })
+            .then(commonHttpClient.discardResult);
+    }
+    /**
+     * Returns a list of system avatar details by owner type, where the owner types
+     * are issue type, project, or user.
+     *
+     * This operation can be accessed anonymously.
+     *
+     * **[Permissions](#permissions) required:** None.
+     *
+     * @returns Returned if the request is successful.
+     *
+     * example: {
+     *   "system": [
+     *     {
+     *       "id": "1000",
+     *       "isDeletable": false,
+     *       "isSelected": false,
+     *       "isSystemAvatar": true,
+     *       "urls": {
+     *         "16x16":
+     * "/secure/useravatar?size=xsmall&avatarId=10040&avatarType=project",
+     *         "24x24":
+     * "/secure/useravatar?size=small&avatarId=10040&avatarType=project",
+     *         "32x32":
+     * "/secure/useravatar?size=medium&avatarId=10040&avatarType=project",
+     *         "48x48": "/secure/useravatar?avatarId=10040&avatarType=project"
+     *       }
+     *     }
+     *   ]
+     * }
+     * @path {GET} /rest/api/3/avatar/{type}/system
+     * @scopes-current manage:jira-configuration
+     * @scopes-beta read:avatar:jira
+     */
+    getAllSystemAvatars({ type, }) {
+        return this.getClientInstance()
+            .request({
+            path: "/rest/api/3/avatar/{type}/system",
+            method: "GET",
+            pathParams: {
+                type,
+            },
+        })
+            .then(this.getClientInstance().responseHandler({
+            200: {
+                "application/json": "json",
+            },
+        }))
+            .then(commonHttpClient.castResponse())
+            .then(validation_schema_storage_1.validationSchemaStorage.validator("AvatarsService.getAllSystemAvatars.response"))
+            .then(commonHttpClient.getBody);
+    }
+    /**
+     * Returns a project or issue type avatar image by ID.
+     *
+     * This operation can be accessed anonymously.
+     *
+     * **[Permissions](#permissions) required:**
+     *
+     *  *  For system avatars, none.
+     *  *  For custom project avatars, *Browse projects* [project
+     * permission](https://confluence.atlassian.com/x/yodKLg) for the project the
+     * avatar belongs to.
+     *  *  For custom issue type avatars, *Browse projects* [project
+     * permission](https://confluence.atlassian.com/x/yodKLg) for at least one project
+     * the issue type is used in.
+     *
+     * @returns * status: 200, mediaType: * /*
+     *
+     *    Returned if the request is successful.
+     *
+     *  * status: 200, mediaType: application/json
+     *
+     *    Returned if the request is successful.
+     *
+     *  * status: 200, mediaType: image/png
+     *
+     *    Returned if the request is successful.
+     *
+     *  * status: 200, mediaType: image/svg+xml
+     *
+     *    Returned if the request is successful.
+     * @path {GET} /rest/api/3/universal_avatar/view/type/{type}/avatar/{id}
+     * @scopes-current read:jira-work
+     * @scopes-beta read:avatar:jira
+     */
+    getAvatarImageById({ type, id, size, format, }) {
+        return this.getClientInstance()
+            .request({
+            path: "/rest/api/3/universal_avatar/view/type/{type}/avatar/{id}",
+            method: "GET",
+            pathParams: {
+                type,
+                id,
+            },
+            query: {
+                size,
+                format,
+            },
+        })
+            .then(this.getClientInstance().responseHandler({
+            200: {
+                "*/*": "blob",
+                "application/json": "json",
+                "image/png": "blob",
+                "image/svg+xml": "blob",
+            },
+        }))
+            .then(commonHttpClient.castResponse())
+            .then(validation_schema_storage_1.validationSchemaStorage.validator("AvatarsService.getAvatarImageByID.response"));
+    }
+    /**
+     * Returns the avatar image for a project or issue type.
+     *
+     * This operation can be accessed anonymously.
+     *
+     * **[Permissions](#permissions) required:**
+     *
+     *  *  For system avatars, none.
+     *  *  For custom project avatars, *Browse projects* [project
+     * permission](https://confluence.atlassian.com/x/yodKLg) for the project the
+     * avatar belongs to.
+     *  *  For custom issue type avatars, *Browse projects* [project
+     * permission](https://confluence.atlassian.com/x/yodKLg) for at least one project
+     * the issue type is used in.
+     *
+     * @returns * status: 200, mediaType: * /*
+     *
+     *    Returned if the request is successful.
+     *
+     *  * status: 200, mediaType: application/json
+     *
+     *    Returned if the request is successful.
+     *
+     *  * status: 200, mediaType: image/png
+     *
+     *    Returned if the request is successful.
+     *
+     *  * status: 200, mediaType: image/svg+xml
+     *
+     *    Returned if the request is successful.
+     * @path {GET} /rest/api/3/universal_avatar/view/type/{type}/owner/{entityId}
+     * @scopes-current read:jira-work
+     * @scopes-beta read:avatar:jira
+     */
+    getAvatarImageByOwner({ type, entityId, size, format, }) {
+        return this.getClientInstance()
+            .request({
+            path: "/rest/api/3/universal_avatar/view/type/{type}/owner/{entityId}",
+            method: "GET",
+            pathParams: {
+                type,
+                entityId,
+            },
+            query: {
+                size,
+                format,
+            },
+        })
+            .then(this.getClientInstance().responseHandler({
+            200: {
+                "*/*": "blob",
+                "application/json": "json",
+                "image/png": "blob",
+                "image/svg+xml": "blob",
+            },
+        }))
+            .then(commonHttpClient.castResponse())
+            .then(validation_schema_storage_1.validationSchemaStorage.validator("AvatarsService.getAvatarImageByOwner.response"));
+    }
+    /**
+     * Returns the default project or issue type avatar image.
+     *
+     * This operation can be accessed anonymously.
+     *
+     * **[Permissions](#permissions) required:** None.
+     *
+     * @returns * status: 200, mediaType: * /*
+     *
+     *    Returned if the request is successful.
+     *
+     *  * status: 200, mediaType: application/json
+     *
+     *    Returned if the request is successful.
+     *
+     *  * status: 200, mediaType: image/png
+     *
+     *    Returned if the request is successful.
+     *
+     *  * status: 200, mediaType: image/svg+xml
+     *
+     *    Returned if the request is successful.
+     * @path {GET} /rest/api/3/universal_avatar/view/type/{type}
+     * @scopes-current read:jira-work
+     * @scopes-beta read:avatar:jira
+     */
+    getAvatarImageByType({ type, size, format, }) {
+        return this.getClientInstance()
+            .request({
+            path: "/rest/api/3/universal_avatar/view/type/{type}",
+            method: "GET",
+            pathParams: {
+                type,
+            },
+            query: {
+                size,
+                format,
+            },
+        })
+            .then(this.getClientInstance().responseHandler({
+            200: {
+                "*/*": "blob",
+                "application/json": "json",
+                "image/png": "blob",
+                "image/svg+xml": "blob",
+            },
+        }))
+            .then(commonHttpClient.castResponse())
+            .then(validation_schema_storage_1.validationSchemaStorage.validator("AvatarsService.getAvatarImageByType.response"));
+    }
+    /**
+     * Returns the system and custom avatars for a project or issue type.
+     *
+     * This operation can be accessed anonymously.
+     *
+     * **[Permissions](#permissions) required:**
+     *
+     *  *  for custom project avatars, *Browse projects* [project
+     * permission](https://confluence.atlassian.com/x/yodKLg) for the project the
+     * avatar belongs to.
+     *  *  for custom issue type avatars, *Browse projects* [project
+     * permission](https://confluence.atlassian.com/x/yodKLg) for at least one project
+     * the issue type is used in.
+     *  *  for system avatars, none.
+     *
+     * @returns Returned if the request is successful.
+     *
+     * example: {
+     *   "custom": [
+     *     {
+     *       "id": "1010",
+     *       "isDeletable": true,
+     *       "isSelected": false,
+     *       "isSystemAvatar": false,
+     *       "urls": {
+     *         "16x16":
+     * "https://your-domain.atlassian.net/secure/viewavatar?size=xsmall&avatarId=10080&avatarType=project",
+     *         "24x24":
+     * "https://your-domain.atlassian.net/secure/viewavatar?size=small&avatarId=10080&avatarType=project",
+     *         "32x32":
+     * "https://your-domain.atlassian.net/secure/viewavatar?size=medium&avatarId=10080&avatarType=project",
+     *         "48x48":
+     * "https://your-domain.atlassian.net/secure/viewavatar?avatarId=10080&avatarType=project"
+     *       }
+     *     }
+     *   ],
+     *   "system": [
+     *     {
+     *       "id": "1000",
+     *       "isDeletable": false,
+     *       "isSelected": false,
+     *       "isSystemAvatar": true,
+     *       "urls": {
+     *         "16x16":
+     * "https://your-domain.atlassian.net/secure/viewavatar?size=xsmall&avatarId=10040&avatarType=project",
+     *         "24x24":
+     * "https://your-domain.atlassian.net/secure/viewavatar?size=small&avatarId=10040&avatarType=project",
+     *         "32x32":
+     * "https://your-domain.atlassian.net/secure/viewavatar?size=medium&avatarId=10040&avatarType=project",
+     *         "48x48":
+     * "https://your-domain.atlassian.net/secure/viewavatar?avatarId=10040&avatarType=project"
+     *       }
+     *     }
+     *   ]
+     * }
+     * @path {GET} /rest/api/3/universal_avatar/type/{type}/owner/{entityId}
+     * @scopes-current manage:jira-configuration
+     * @scopes-beta read:avatar:jira
+     */
+    getAvatars({ type, entityId, }) {
+        return this.getClientInstance()
+            .request({
+            path: "/rest/api/3/universal_avatar/type/{type}/owner/{entityId}",
+            method: "GET",
+            pathParams: {
+                type,
+                entityId,
+            },
+        })
+            .then(this.getClientInstance().responseHandler({
+            200: {
+                "application/json": "json",
+            },
+        }))
+            .then(commonHttpClient.castResponse())
+            .then(validation_schema_storage_1.validationSchemaStorage.validator("AvatarsService.getAvatars.response"))
+            .then(commonHttpClient.getBody);
+    }
+    /**
+     * Loads a custom avatar for a project or issue type.
+     *
+     * Specify the avatar's local file location in the body of the request. Also,
+     * include the following headers:
+     *
+     *  *  `X-Atlassian-Token: no-check` To prevent XSRF protection blocking the
+     * request, for more information see [Special Headers](#special-request-headers).
+     *  *  `Content-Type: image/image type` Valid image types are JPEG, GIF, or PNG.
+     *
+     * For example:
+     * `curl --request POST `
+     *
+     * `--user email@example.com:<api_token> `
+     *
+     * `--header 'X-Atlassian-Token: no-check' `
+     *
+     * `--header 'Content-Type: image/< image_type>' `
+     *
+     * `--data-binary "<@/path/to/file/with/your/avatar>" `
+     *
+     * `--url
+     * 'https://your-domain.atlassian.net/rest/api/3/universal_avatar/type/{type}/owner/{entityId}'`
+     *
+     * The avatar is cropped to a square. If no crop parameters are specified, the
+     * square originates at the top left of the image. The length of the square's
+     * sides is set to the smaller of the height or width of the image.
+     *
+     * The cropped image is then used to create avatars of 16x16, 24x24, 32x32, and
+     * 48x48 in size.
+     *
+     * After creating the avatar use:
+     *
+     *  *  [Update issue type](#api-rest-api-3-issuetype-id-put) to set it as the
+     * issue type's displayed avatar.
+     *  *  [Set project avatar](#api-rest-api-3-project-projectIdOrKey-avatar-put) to
+     * set it as the project's displayed avatar.
+     *
+     * **[Permissions](#permissions) required:** *Administer Jira* [global
+     * permission](https://confluence.atlassian.com/x/x4dKLg).
+     *
+     * @returns Returned if the request is successful.
+     *
+     * example: {
+     *   "id": "1000",
+     *   "isDeletable": false,
+     *   "isSelected": false,
+     *   "isSystemAvatar": true,
+     *   "urls": {
+     *     "16x16": "/secure/useravatar?size=xsmall&avatarId=10040&avatarType=project",
+     *     "24x24": "/secure/useravatar?size=small&avatarId=10040&avatarType=project",
+     *     "32x32": "/secure/useravatar?size=medium&avatarId=10040&avatarType=project",
+     *     "48x48": "/secure/useravatar?avatarId=10040&avatarType=project"
+     *   }
+     * }
+     * @path {POST} /rest/api/3/universal_avatar/type/{type}/owner/{entityId}
+     * @scopes-current manage:jira-configuration
+     * @scopes-beta write:avatar:jira, read:avatar:jira
+     */
+    storeAvatar({ type, entityId, x, y, size, mediaType, requestBody, }) {
+        return this.getClientInstance()
+            .request({
+            path: "/rest/api/3/universal_avatar/type/{type}/owner/{entityId}",
+            method: "POST",
+            pathParams: {
+                type,
+                entityId,
+            },
+            query: {
+                x,
+                y,
+                size,
+            },
+            headers: {
+                "X-Atlassian-Token": "nocheck",
+                "Content-Type": mediaType,
+            },
+            body: requestBody,
+        })
+            .then(this.getClientInstance().responseHandler({
+            201: {
+                "application/json": "json",
+            },
+        }))
+            .then(commonHttpClient.castResponse())
+            .then(validation_schema_storage_1.validationSchemaStorage.validator("AvatarsService.storeAvatar.response"))
+            .then(commonHttpClient.getBody);
+    }
+    static initialize() {
+        validation_schema_storage_1.validationSchemaStorage.registerExtensible("AvatarsService.getAllSystemAvatars.response", zod_1.z
+            .object({
+            status: zod_1.z.literal(200),
+            mediaType: zod_1.z.literal("application/json"),
+            body: validation_schema_storage_1.validationSchemaStorage.lazy("SystemAvatars"),
+        })
+            .describe("AvatarsService.getAllSystemAvatars.response"));
+        validation_schema_storage_1.validationSchemaStorage.registerExtensible("AvatarsService.getAvatars.response", zod_1.z
+            .object({
+            status: zod_1.z.literal(200),
+            mediaType: zod_1.z.literal("application/json"),
+            body: validation_schema_storage_1.validationSchemaStorage.lazy("Avatars"),
+        })
+            .describe("AvatarsService.getAvatars.response"));
+        validation_schema_storage_1.validationSchemaStorage.registerExtensible("AvatarsService.storeAvatar.response", zod_1.z
+            .object({
+            status: zod_1.z.literal(201),
+            mediaType: zod_1.z.literal("application/json"),
+            body: validation_schema_storage_1.validationSchemaStorage.lazy("Avatar"),
+        })
+            .describe("AvatarsService.storeAvatar.response"));
+        validation_schema_storage_1.validationSchemaStorage.registerExtensible("AvatarsService.getAvatarImageByType.response", zod_1.z
+            .object({
+            status: zod_1.z.number(),
+            mediaType: zod_1.z.string(),
+            body: zod_1.z.unknown(),
+        })
+            .superRefine(({ mediaType: mediaType, body: body }, ctx) => {
+            if (mediaType === "application/json") {
+                validation_schema_storage_1.validationSchemaStorage.lazy("StreamingResponseBody").parse(body);
+            }
+            else if (mediaType === "image/png" ||
+                mediaType === "image/svg+xml") {
+                return;
+            }
+            else {
+                ctx.addIssue({
+                    code: zod_1.z.ZodIssueCode.custom,
+                    path: ["mediaType"],
+                    message: `Unexpected media type: ${mediaType}`,
+                });
+            }
+        })
+            .describe("AvatarsService.getAvatarImageByType.response"));
+        validation_schema_storage_1.validationSchemaStorage.registerExtensible("AvatarsService.getAvatarImageByID.response", zod_1.z
+            .object({
+            status: zod_1.z.number(),
+            mediaType: zod_1.z.string(),
+            body: zod_1.z.unknown(),
+        })
+            .superRefine(({ mediaType: mediaType, body: body }, ctx) => {
+            if (mediaType === "application/json") {
+                validation_schema_storage_1.validationSchemaStorage.lazy("StreamingResponseBody").parse(body);
+            }
+            else if (mediaType === "image/png" ||
+                mediaType === "image/svg+xml") {
+                return;
+            }
+            else {
+                ctx.addIssue({
+                    code: zod_1.z.ZodIssueCode.custom,
+                    path: ["mediaType"],
+                    message: `Unexpected media type: ${mediaType}`,
+                });
+            }
+        })
+            .describe("AvatarsService.getAvatarImageByID.response"));
+        validation_schema_storage_1.validationSchemaStorage.registerExtensible("AvatarsService.getAvatarImageByOwner.response", zod_1.z
+            .object({
+            status: zod_1.z.number(),
+            mediaType: zod_1.z.string(),
+            body: zod_1.z.unknown(),
+        })
+            .superRefine(({ mediaType: mediaType, body: body }, ctx) => {
+            if (mediaType === "application/json") {
+                validation_schema_storage_1.validationSchemaStorage.lazy("StreamingResponseBody").parse(body);
+            }
+            else if (mediaType === "image/png" ||
+                mediaType === "image/svg+xml") {
+                return;
+            }
+            else {
+                ctx.addIssue({
+                    code: zod_1.z.ZodIssueCode.custom,
+                    path: ["mediaType"],
+                    message: `Unexpected media type: ${mediaType}`,
+                });
+            }
+        })
+            .describe("AvatarsService.getAvatarImageByOwner.response"));
+        validation_schema_storage_1.validationSchemaStorage.registerOnce([
+            avatars_1.registerAvatarsValidationSchemas,
+            common_1.registerCommonValidationSchemas,
+        ]);
+    }
+}
+exports.AvatarsService = AvatarsService;
+//# sourceMappingURL=avatars-service.js.map

package/lib/openapi/platform/services/avatars-service.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"avatars-service.js","sourceRoot":"","sources":["../../../../src/openapi/platform/services/avatars-service.ts"],"names":[],"mappings":";;;AAIA,6BAAwB;AAExB,+DAA+D;AAC/D,qEAAgE;AAChE,+CAK2B;AAC3B,6CAAgF;AAChF,4EAAuE;AACvE;;;;GAIG;AACH,MAAa,cAAe,SAAQ,uCAAiB;IACnD;;;;;;;;;;OAUG;IACH,YAAY,CAAC,EACX,IAAI,EACJ,cAAc,EACd,EAAE,GAQH;QACC,OAAO,IAAI,CAAC,iBAAiB,EAAE;aAC5B,OAAO,CAAC;YACP,IAAI,EAAE,6EAA6E;YACnF,MAAM,EAAE,QAAQ;YAChB,UAAU,EAAE;gBACV,IAAI;gBACJ,cAAc;gBACd,EAAE;aACH;SACF,CAAC;aACD,IAAI,CAAC,gBAAgB,CAAC,aAAa,CAAC,CAAC;IAC1C,CAAC;IACD;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;OAgCG;IACH,mBAAmB,CAAC,EAClB,IAAI,GAIL;QACC,OAAO,IAAI,CAAC,iBAAiB,EAAE;aAC5B,OAAO,CAAC;YACP,IAAI,EAAE,kCAAkC;YACxC,MAAM,EAAE,KAAK;YACb,UAAU,EAAE;gBACV,IAAI;aACL;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,mDAAuB,CAAC,SAAS,CAC/B,6CAA6C,CAC9C,CACF;aACA,IAAI,CAAC,gBAAgB,CAAC,OAAO,CAAC,CAAC;IACpC,CAAC;IACD;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;OAiCG;IACH,kBAAkB,CAAC,EACjB,IAAI,EACJ,EAAE,EACF,IAAI,EACJ,MAAM,GAaP;QAcC,OAAO,IAAI,CAAC,iBAAiB,EAAE;aAC5B,OAAO,CAAC;YACP,IAAI,EAAE,2DAA2D;YACjE,MAAM,EAAE,KAAK;YACb,UAAU,EAAE;gBACV,IAAI;gBACJ,EAAE;aACH;YACD,KAAK,EAAE;gBACL,IAAI;gBACJ,MAAM;aACP;SACF,CAAC;aACD,IAAI,CACH,IAAI,CAAC,iBAAiB,EAAE,CAAC,eAAe,CAAC;YACvC,GAAG,EAAE;gBACH,KAAK,EAAE,MAAM;gBACb,kBAAkB,EAAE,MAAM;gBAC1B,WAAW,EAAE,MAAM;gBACnB,eAAe,EAAE,MAAM;aACxB;SACF,CAAC,CACH;aACA,IAAI,CACH,gBAAgB,CAAC,YAAY,EAW1B,CACJ;aACA,IAAI,CACH,mDAAuB,CAAC,SAAS,CAC/B,4CAA4C,CAC7C,CACF,CAAC;IACN,CAAC;IACD;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;OAiCG;IACH,qBAAqB,CAAC,EACpB,IAAI,EACJ,QAAQ,EACR,IAAI,EACJ,MAAM,GAaP;QAcC,OAAO,IAAI,CAAC,iBAAiB,EAAE;aAC5B,OAAO,CAAC;YACP,IAAI,EAAE,gEAAgE;YACtE,MAAM,EAAE,KAAK;YACb,UAAU,EAAE;gBACV,IAAI;gBACJ,QAAQ;aACT;YACD,KAAK,EAAE;gBACL,IAAI;gBACJ,MAAM;aACP;SACF,CAAC;aACD,IAAI,CACH,IAAI,CAAC,iBAAiB,EAAE,CAAC,eAAe,CAAC;YACvC,GAAG,EAAE;gBACH,KAAK,EAAE,MAAM;gBACb,kBAAkB,EAAE,MAAM;gBAC1B,WAAW,EAAE,MAAM;gBACnB,eAAe,EAAE,MAAM;aACxB;SACF,CAAC,CACH;aACA,IAAI,CACH,gBAAgB,CAAC,YAAY,EAW1B,CACJ;aACA,IAAI,CACH,mDAAuB,CAAC,SAAS,CAC/B,+CAA+C,CAChD,CACF,CAAC;IACN,CAAC;IACD;;;;;;;;;;;;;;;;;;;;;;;;;OAyBG;IACH,oBAAoB,CAAC,EACnB,IAAI,EACJ,IAAI,EACJ,MAAM,GAWP;QAcC,OAAO,IAAI,CAAC,iBAAiB,EAAE;aAC5B,OAAO,CAAC;YACP,IAAI,EAAE,+CAA+C;YACrD,MAAM,EAAE,KAAK;YACb,UAAU,EAAE;gBACV,IAAI;aACL;YACD,KAAK,EAAE;gBACL,IAAI;gBACJ,MAAM;aACP;SACF,CAAC;aACD,IAAI,CACH,IAAI,CAAC,iBAAiB,EAAE,CAAC,eAAe,CAAC;YACvC,GAAG,EAAE;gBACH,KAAK,EAAE,MAAM;gBACb,kBAAkB,EAAE,MAAM;gBAC1B,WAAW,EAAE,MAAM;gBACnB,eAAe,EAAE,MAAM;aACxB;SACF,CAAC,CACH;aACA,IAAI,CACH,gBAAgB,CAAC,YAAY,EAW1B,CACJ;aACA,IAAI,CACH,mDAAuB,CAAC,SAAS,CAC/B,8CAA8C,CAC/C,CACF,CAAC;IACN,CAAC;IACD;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;OA0DG;IACH,UAAU,CAAC,EACT,IAAI,EACJ,QAAQ,GAMT;QACC,OAAO,IAAI,CAAC,iBAAiB,EAAE;aAC5B,OAAO,CAAC;YACP,IAAI,EAAE,2DAA2D;YACjE,MAAM,EAAE,KAAK;YACb,UAAU,EAAE;gBACV,IAAI;gBACJ,QAAQ;aACT;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,mDAAuB,CAAC,SAAS,CAAC,oCAAoC,CAAC,CACxE;aACA,IAAI,CAAC,gBAAgB,CAAC,OAAO,CAAC,CAAC;IACpC,CAAC;IACD;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;OA0DG;IACH,WAAW,CAAC,EACV,IAAI,EACJ,QAAQ,EACR,CAAC,EACD,CAAC,EACD,IAAI,EACJ,SAAS,EACT,WAAW,GAcZ;QACC,OAAO,IAAI,CAAC,iBAAiB,EAAE;aAC5B,OAAO,CAAC;YACP,IAAI,EAAE,2DAA2D;YACjE,MAAM,EAAE,MAAM;YACd,UAAU,EAAE;gBACV,IAAI;gBACJ,QAAQ;aACT;YACD,KAAK,EAAE;gBACL,CAAC;gBACD,CAAC;gBACD,IAAI;aACL;YACD,OAAO,EAAE;gBACP,mBAAmB,EAAE,SAAS;gBAC9B,cAAc,EAAE,SAAS;aAC1B;YACD,IAAI,EAAE,WAAW;SAClB,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,mDAAuB,CAAC,SAAS,CAC/B,qCAAqC,CACtC,CACF;aACA,IAAI,CAAC,gBAAgB,CAAC,OAAO,CAAC,CAAC;IACpC,CAAC;IACD,MAAM,CAAC,UAAU;QACf,mDAAuB,CAAC,kBAAkB,CACxC,6CAA6C,EAC7C,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,mDAAuB,CAAC,IAAI,CAAC,eAAe,CAAC;SACpD,CAAC;aACD,QAAQ,CAAC,6CAA6C,CAAC,CAC3D,CAAC;QACF,mDAAuB,CAAC,kBAAkB,CACxC,oCAAoC,EACpC,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,mDAAuB,CAAC,IAAI,CAAC,SAAS,CAAC;SAC9C,CAAC;aACD,QAAQ,CAAC,oCAAoC,CAAC,CAClD,CAAC;QACF,mDAAuB,CAAC,kBAAkB,CACxC,qCAAqC,EACrC,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,mDAAuB,CAAC,IAAI,CAAC,QAAQ,CAAC;SAC7C,CAAC;aACD,QAAQ,CAAC,qCAAqC,CAAC,CACnD,CAAC;QACF,mDAAuB,CAAC,kBAAkB,CACxC,8CAA8C,EAC9C,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,IAAI,EAAE,IAAI,EAAE,EAAE,GAAG,EAAE,EAAE;YACzD,IAAI,SAAS,KAAK,kBAAkB,EAAE,CAAC;gBACrC,mDAAuB,CAAC,IAAI,CAAC,uBAAuB,CAAC,CAAC,KAAK,CAAC,IAAI,CAAC,CAAC;YACpE,CAAC;iBAAM,IACL,SAAS,KAAK,WAAW;gBACzB,SAAS,KAAK,eAAe,EAC7B,CAAC;gBACD,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,8CAA8C,CAAC,CAC5D,CAAC;QACF,mDAAuB,CAAC,kBAAkB,CACxC,4CAA4C,EAC5C,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,IAAI,EAAE,IAAI,EAAE,EAAE,GAAG,EAAE,EAAE;YACzD,IAAI,SAAS,KAAK,kBAAkB,EAAE,CAAC;gBACrC,mDAAuB,CAAC,IAAI,CAAC,uBAAuB,CAAC,CAAC,KAAK,CAAC,IAAI,CAAC,CAAC;YACpE,CAAC;iBAAM,IACL,SAAS,KAAK,WAAW;gBACzB,SAAS,KAAK,eAAe,EAC7B,CAAC;gBACD,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,4CAA4C,CAAC,CAC1D,CAAC;QACF,mDAAuB,CAAC,kBAAkB,CACxC,+CAA+C,EAC/C,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,IAAI,EAAE,IAAI,EAAE,EAAE,GAAG,EAAE,EAAE;YACzD,IAAI,SAAS,KAAK,kBAAkB,EAAE,CAAC;gBACrC,mDAAuB,CAAC,IAAI,CAAC,uBAAuB,CAAC,CAAC,KAAK,CAAC,IAAI,CAAC,CAAC;YACpE,CAAC;iBAAM,IACL,SAAS,KAAK,WAAW;gBACzB,SAAS,KAAK,eAAe,EAC7B,CAAC;gBACD,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,+CAA+C,CAAC,CAC7D,CAAC;QACF,mDAAuB,CAAC,YAAY,CAAC;YACnC,0CAAgC;YAChC,wCAA+B;SAChC,CAAC,CAAC;IACL,CAAC;CACF;AA3uBD,wCA2uBC"}

package/lib/openapi/platform/services/classification-levels-service.d.ts

@@ -0,0 +1,72 @@
+import { CommonHttpService } from "../core/common-http-service";
+import { type DataClassificationLevelsBean } from "../models/classification-levels";
+/** This resource represents classification levels. */
+export declare class ClassificationLevelsService extends CommonHttpService {
+    /**
+     * Returns all classification levels.
+     *
+     * **[Permissions](#permissions) required:** None.
+     *
+     * @returns Returned if the request is successful.
+     *
+     * example: {
+     *   "classifications": [
+     *     {
+     *       "id":
+     * "ari:cloud:platform::classification-tag/5bfa70f7-4af1-44f5-9e12-1ce185f15a38",
+     *       "status": "published",
+     *       "name": "Restricted",
+     *       "rank": 1,
+     *       "description": "Data we hold that would be very damaging and would cause
+     * loss of trust with customers and present legal risk to Atlassian and/or
+     * customers if mishandled",
+     *       "guideline": "Access to data must be restricted to only individuals who
+     * need access in order to perform their job duties.",
+     *       "color": "RED"
+     *     },
+     *     {
+     *       "id":
+     * "ari:cloud:platform::classification-tag/bd58e74c-c31b-41a7-ba69-9673ebd9dae9",
+     *       "status": "archived",
+     *       "name": "Protected",
+     *       "rank": 2,
+     *       "description": "Data we hold that could cause loss of trust with
+     * customers or present legal risk to Atlassian if mishandled",
+     *       "guideline": "Access to systems or APIs mapping data to other identifiers
+     * must be carefully controlled.",
+     *       "color": "ORANGE"
+     *     },
+     *     {
+     *       "id":
+     * "ari:cloud:platform::classification-tag/a82d653e-1035-4aa2-b9de-4265511fd487",
+     *       "status": "published",
+     *       "name": "Confidential",
+     *       "rank": 3,
+     *       "description": "Data we hold that would likely be damaging and could
+     * cause loss of trust with our customers if mishandled",
+     *       "guideline": "Data should be encrypted at rest and in transit.",
+     *       "color": "BLUE"
+     *     },
+     *     {
+     *       "id":
+     * "ari:cloud:platform::classification-tag/a82d653e-1035-4aa2-b9de-4265511fd487",
+     *       "status": "published",
+     *       "name": "system-tag"
+     *     }
+     *   ]
+     * }
+     * @path {GET} /rest/api/3/classification-levels
+     * @scopes-current read:jira-work
+     * @scopes-beta read:project:jira
+     */
+    getAllUserDataClassificationLevels({ status, orderBy, }: {
+        /** Optional set of statuses to filter by. */
+        status?: ("PUBLISHED" | "ARCHIVED" | "DRAFT")[];
+        /**
+         * Ordering of the results by a given field. If not provided, values will not be
+         * sorted.
+         */
+        orderBy?: "rank" | "-rank" | "+rank";
+    }): Promise<DataClassificationLevelsBean>;
+    static initialize(): void;
+}