@resolution/jira-api-client 0.1.0

package/lib/openapi/platform/services/ui-modifications-apps-service.js

@@ -0,0 +1,262 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.UiModificationsAppsService = 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/common-http-client");
+const common_http_service_1 = require("../core/common-http-service");
+const ui_modifications_apps_1 = require("../models/ui-modifications-apps");
+const validation_schema_storage_1 = require("../validation-schema-storage");
+/**
+ * UI modifications is a feature available for **Forge apps only**. It enables
+ * Forge apps to control how selected Jira fields behave on the following views:
+ * global issue create, issue view. For example: hide specific fields, set them as
+ * required, etc.
+ */
+class UiModificationsAppsService extends common_http_service_1.CommonHttpService {
+    /**
+     * Creates a UI modification. UI modification can only be created by Forge apps.
+     *
+     * Each app can define up to 3000 UI modifications. Each UI modification can
+     * define up to 1000 contexts. The same context can be assigned to maximum 100 UI
+     * modifications.
+     *
+     * **[Permissions](#permissions) required:**
+     *
+     *  *  *None* if the UI modification is created without contexts.
+     *  *  *Browse projects* [project
+     * permission](https://confluence.atlassian.com/x/yodKLg) for one or more
+     * projects, if the UI modification is created with contexts.
+     *
+     * @returns Returned if the UI modification is created.
+     *
+     * example: {
+     *   "id": "d7dbda8a-6239-4b63-8e13-a5ef975c8e61",
+     *   "self":
+     * "https://api.atlassian.com/ex/jira/{cloudid}/rest/api/2/uiModifications/d7dbda8a-6239-4b63-8e13-a5ef975c8e61"
+     * }
+     * @path {POST} /rest/api/3/uiModifications
+     */
+    createUiModification({ createUiModificationDetails, }) {
+        return this.getClientInstance()
+            .request({
+            path: "/rest/api/3/uiModifications",
+            method: "POST",
+            headers: {
+                "Content-Type": "application/json",
+            },
+            body: createUiModificationDetails,
+        })
+            .then(this.getClientInstance().responseHandler({
+            201: {
+                "application/json": "json",
+            },
+        }))
+            .then(commonHttpClient.castResponse())
+            .then(validation_schema_storage_1.validationSchemaStorage.validator("UiModificationsAppsService.createUiModification.response"))
+            .then(commonHttpClient.getBody);
+    }
+    /**
+     * Deletes a UI modification. All the contexts that belong to the UI modification
+     * are deleted too. UI modification can only be deleted by Forge apps.
+     *
+     * **[Permissions](#permissions) required:** None.
+     *
+     * @returns Returned if the UI modification is deleted.
+     * @path {DELETE} /rest/api/3/uiModifications/{uiModificationId}
+     */
+    deleteUiModification({ uiModificationId, }) {
+        return this.getClientInstance()
+            .request({
+            path: "/rest/api/3/uiModifications/{uiModificationId}",
+            method: "DELETE",
+            pathParams: {
+                uiModificationId,
+            },
+        })
+            .then(this.getClientInstance().responseHandler({
+            204: {
+                "application/json": "json",
+            },
+        }))
+            .then(commonHttpClient.castResponse())
+            .then(validation_schema_storage_1.validationSchemaStorage.validator("UiModificationsAppsService.deleteUiModification.response"))
+            .then(commonHttpClient.getBody);
+    }
+    /**
+     * Gets UI modifications. UI modifications can only be retrieved by Forge apps.
+     *
+     * **[Permissions](#permissions) required:** None.
+     *
+     * @returns Returned if the request is successful.
+     *
+     * example: {
+     *   "isLast": true,
+     *   "maxResults": 100,
+     *   "startAt": 0,
+     *   "total": 3,
+     *   "values": [
+     *     {
+     *       "id": "d7dbda8a-6239-4b63-8e13-a5ef975c8e61",
+     *       "name": "Reveal Story Points",
+     *       "description": "Reveals Story Points field when any Sprint is selected.",
+     *       "self":
+     * "https://api.atlassian.com/ex/jira/{cloudid}/rest/api/2/uiModifications/d7dbda8a-6239-4b63-8e13-a5ef975c8e61",
+     *       "data": "{field: 'Story Points', config: {hidden: false}}",
+     *       "contexts": [
+     *         {
+     *           "id": "1533537a-bda3-4ac6-8481-846128cd9ef4",
+     *           "projectId": "10000",
+     *           "issueTypeId": "10000",
+     *           "viewType": "GIC",
+     *           "isAvailable": true
+     *         },
+     *         {
+     *           "id": "c016fefa-6eb3-40c9-8596-4c4ef273e67c",
+     *           "projectId": "10000",
+     *           "issueTypeId": "10001",
+     *           "viewType": "IssueView",
+     *           "isAvailable": true
+     *         }
+     *       ]
+     *     },
+     *     {
+     *       "id": "e4fe8db5-f82f-416b-a3aa-b260b55da577",
+     *       "name": "Set Assignee",
+     *       "description": "Sets the Assignee field automatically.",
+     *       "self":
+     * "https://api.atlassian.com/ex/jira/{cloudid}/rest/api/2/uiModifications/e4fe8db5-f82f-416b-a3aa-b260b55da577",
+     *       "contexts": [
+     *         {
+     *           "id": "8b3740f9-8780-4958-8228-69dcfbda11d9",
+     *           "projectId": "10000",
+     *           "issueTypeId": "10000",
+     *           "viewType": "GIC",
+     *           "isAvailable": true
+     *         }
+     *       ]
+     *     },
+     *     {
+     *       "id": "1453f993-79ce-4389-a36d-eb72d5c85dd6",
+     *       "name": "Hide Labels",
+     *       "description": "Hides Labels if any component is provided.",
+     *       "self":
+     * "https://api.atlassian.com/ex/jira/{cloudid}/rest/api/2/uiModifications/1453f993-79ce-4389-a36d-eb72d5c85dd6",
+     *       "contexts": []
+     *     },
+     *     {
+     *       "id": "d3f4097e-8d8e-451e-9fb6-27c3c8c3bfff",
+     *       "name": "Wildcard example",
+     *       "description": "This context is applied to all issue types",
+     *       "self":
+     * "https://api.atlassian.com/ex/jira/{cloudid}/rest/api/2/uiModifications/d3f4097e-8d8e-451e-9fb6-27c3c8c3bfff",
+     *       "contexts": [
+     *         {
+     *           "id": "521f2181-5d5e-46ea-9fc9-871bbf245b8b",
+     *           "projectId": "10000",
+     *           "issueTypeId": null,
+     *           "viewType": "GIC",
+     *           "isAvailable": true
+     *         }
+     *       ]
+     *     }
+     *   ]
+     * }
+     * @path {GET} /rest/api/3/uiModifications
+     */
+    getUiModifications({ startAt, maxResults, expand, }) {
+        return this.getClientInstance()
+            .request({
+            path: "/rest/api/3/uiModifications",
+            method: "GET",
+            query: {
+                startAt,
+                maxResults,
+                expand,
+            },
+        })
+            .then(this.getClientInstance().responseHandler({
+            200: {
+                "application/json": "json",
+            },
+        }))
+            .then(commonHttpClient.castResponse())
+            .then(validation_schema_storage_1.validationSchemaStorage.validator("UiModificationsAppsService.getUiModifications.response"))
+            .then(commonHttpClient.getBody);
+    }
+    /**
+     * Updates a UI modification. UI modification can only be updated by Forge apps.
+     *
+     * Each UI modification can define up to 1000 contexts. The same context can be
+     * assigned to maximum 100 UI modifications.
+     *
+     * **[Permissions](#permissions) required:**
+     *
+     *  *  *None* if the UI modification is created without contexts.
+     *  *  *Browse projects* [project
+     * permission](https://confluence.atlassian.com/x/yodKLg) for one or more
+     * projects, if the UI modification is created with contexts.
+     *
+     * @returns Returned if the UI modification is updated.
+     * @path {PUT} /rest/api/3/uiModifications/{uiModificationId}
+     */
+    updateUiModification({ uiModificationId, updateUiModificationDetails, }) {
+        return this.getClientInstance()
+            .request({
+            path: "/rest/api/3/uiModifications/{uiModificationId}",
+            method: "PUT",
+            pathParams: {
+                uiModificationId,
+            },
+            headers: {
+                "Content-Type": "application/json",
+            },
+            body: updateUiModificationDetails,
+        })
+            .then(this.getClientInstance().responseHandler({
+            204: {
+                "application/json": "json",
+            },
+        }))
+            .then(commonHttpClient.castResponse())
+            .then(validation_schema_storage_1.validationSchemaStorage.validator("UiModificationsAppsService.updateUiModification.response"))
+            .then(commonHttpClient.getBody);
+    }
+    static initialize() {
+        validation_schema_storage_1.validationSchemaStorage.registerExtensible("UiModificationsAppsService.getUiModifications.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("PageBeanUiModificationDetails"),
+        })
+            .describe("UiModificationsAppsService.getUiModifications.response"));
+        validation_schema_storage_1.validationSchemaStorage.registerExtensible("UiModificationsAppsService.createUiModification.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("UiModificationIdentifiers"),
+        })
+            .describe("UiModificationsAppsService.createUiModification.response"));
+        validation_schema_storage_1.validationSchemaStorage.registerExtensible("UiModificationsAppsService.updateUiModification.response", zod_1.z
+            .object({
+            status: zod_1.z.literal(204),
+            mediaType: zod_1.z.literal("application/json"),
+            body: zod_1.z.unknown(),
+        })
+            .describe("UiModificationsAppsService.updateUiModification.response"));
+        validation_schema_storage_1.validationSchemaStorage.registerExtensible("UiModificationsAppsService.deleteUiModification.response", zod_1.z
+            .object({
+            status: zod_1.z.literal(204),
+            mediaType: zod_1.z.literal("application/json"),
+            body: zod_1.z.unknown(),
+        })
+            .describe("UiModificationsAppsService.deleteUiModification.response"));
+        validation_schema_storage_1.validationSchemaStorage.registerOnce([
+            ui_modifications_apps_1.registerUiModificationsAppsValidationSchemas,
+        ]);
+    }
+}
+exports.UiModificationsAppsService = UiModificationsAppsService;
+//# sourceMappingURL=ui-modifications-apps-service.js.map

package/lib/openapi/platform/services/ui-modifications-apps-service.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"ui-modifications-apps-service.js","sourceRoot":"","sources":["../../../../src/openapi/platform/services/ui-modifications-apps-service.ts"],"names":[],"mappings":";;;AAAA,eAAe;AACf,wDAAwD;AACxD,gDAAgD;AAChD,6BAAwB;AAExB,+DAA+D;AAC/D,qEAAgE;AAChE,2EAMyC;AACzC,4EAAuE;AACvE;;;;;GAKG;AACH,MAAa,0BAA2B,SAAQ,uCAAiB;IAC/D;;;;;;;;;;;;;;;;;;;;;;OAsBG;IACH,oBAAoB,CAAC,EACnB,2BAA2B,GA6B5B;QACC,OAAO,IAAI,CAAC,iBAAiB,EAAE;aAC5B,OAAO,CAAC;YACP,IAAI,EAAE,6BAA6B;YACnC,MAAM,EAAE,MAAM;YACd,OAAO,EAAE;gBACP,cAAc,EAAE,kBAAkB;aACnC;YACD,IAAI,EAAE,2BAA2B;SAClC,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,0DAA0D,CAC3D,CACF;aACA,IAAI,CAAC,gBAAgB,CAAC,OAAO,CAAC,CAAC;IACpC,CAAC;IACD;;;;;;;;OAQG;IACH,oBAAoB,CAAC,EACnB,gBAAgB,GAIjB;QACC,OAAO,IAAI,CAAC,iBAAiB,EAAE;aAC5B,OAAO,CAAC;YACP,IAAI,EAAE,gDAAgD;YACtD,MAAM,EAAE,QAAQ;YAChB,UAAU,EAAE;gBACV,gBAAgB;aACjB;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,0DAA0D,CAC3D,CACF;aACA,IAAI,CAAC,gBAAgB,CAAC,OAAO,CAAC,CAAC;IACpC,CAAC;IACD;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;OAgFG;IACH,kBAAkB,CAAC,EACjB,OAAO,EACP,UAAU,EACV,MAAM,GAcP;QACC,OAAO,IAAI,CAAC,iBAAiB,EAAE;aAC5B,OAAO,CAAC;YACP,IAAI,EAAE,6BAA6B;YACnC,MAAM,EAAE,KAAK;YACb,KAAK,EAAE;gBACL,OAAO;gBACP,UAAU;gBACV,MAAM;aACP;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,wDAAwD,CACzD,CACF;aACA,IAAI,CAAC,gBAAgB,CAAC,OAAO,CAAC,CAAC;IACpC,CAAC;IACD;;;;;;;;;;;;;;;OAeG;IACH,oBAAoB,CAAC,EACnB,gBAAgB,EAChB,2BAA2B,GAyB5B;QACC,OAAO,IAAI,CAAC,iBAAiB,EAAE;aAC5B,OAAO,CAAC;YACP,IAAI,EAAE,gDAAgD;YACtD,MAAM,EAAE,KAAK;YACb,UAAU,EAAE;gBACV,gBAAgB;aACjB;YACD,OAAO,EAAE;gBACP,cAAc,EAAE,kBAAkB;aACnC;YACD,IAAI,EAAE,2BAA2B;SAClC,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,0DAA0D,CAC3D,CACF;aACA,IAAI,CAAC,gBAAgB,CAAC,OAAO,CAAC,CAAC;IACpC,CAAC;IACD,MAAM,CAAC,UAAU;QACf,mDAAuB,CAAC,kBAAkB,CACxC,wDAAwD,EACxD,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,+BAA+B,CAAC;SACpE,CAAC;aACD,QAAQ,CAAC,wDAAwD,CAAC,CACtE,CAAC;QACF,mDAAuB,CAAC,kBAAkB,CACxC,0DAA0D,EAC1D,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,2BAA2B,CAAC;SAChE,CAAC;aACD,QAAQ,CAAC,0DAA0D,CAAC,CACxE,CAAC;QACF,mDAAuB,CAAC,kBAAkB,CACxC,0DAA0D,EAC1D,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,OAAC,CAAC,OAAO,EAAE;SAClB,CAAC;aACD,QAAQ,CAAC,0DAA0D,CAAC,CACxE,CAAC;QACF,mDAAuB,CAAC,kBAAkB,CACxC,0DAA0D,EAC1D,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,OAAC,CAAC,OAAO,EAAE;SAClB,CAAC;aACD,QAAQ,CAAC,0DAA0D,CAAC,CACxE,CAAC;QACF,mDAAuB,CAAC,YAAY,CAAC;YACnC,oEAA4C;SAC7C,CAAC,CAAC;IACL,CAAC;CACF;AA7XD,gEA6XC"}

package/lib/openapi/platform/services/user-properties-service.d.ts

@@ -0,0 +1,218 @@
+import { CommonHttpService } from "../core/common-http-service";
+import { type EntityProperty, type PropertyKeys } from "../models/common";
+/**
+ * This resource represents [user](#api-group-Users) properties and provides for
+ * storing custom data against a user. Use it to get, create, and delete user
+ * properties as well as get a list of property keys for a user. This resourse is
+ * designed for integrations and apps to store per-user data and settings. This
+ * enables data used to customized the user experience to be kept in the Jira
+ * Cloud instance's database. User properties are a type of [entity
+ * property](https://developer.atlassian.com/cloud/jira/platform/jira-entity-properties/).
+ *
+ * This resource does not access the [user
+ * properties](https://confluence.atlassian.com/x/8YxjL) created and maintained in
+ * Jira.
+ */
+export declare class UserPropertiesService extends CommonHttpService {
+    /**
+     * Deletes a property from a user.
+     *
+     * Note: This operation does not access the [user
+     * properties](https://confluence.atlassian.com/x/8YxjL) created and maintained in
+     * Jira.
+     *
+     * **[Permissions](#permissions) required:**
+     *
+     *  *  *Administer Jira* [global
+     * permission](https://confluence.atlassian.com/x/x4dKLg), to delete a property
+     * from any user.
+     *  *  Access to Jira, to delete a property from the calling user's record.
+     *
+     * @path {DELETE} /rest/api/3/user/properties/{propertyKey}
+     * @scopes-current write:jira-work
+     * @scopes-beta delete:user.property:jira
+     */
+    deleteUserProperty({ propertyKey, accountId, userKey, username, }: {
+        /** The key of the user's property. */
+        propertyKey: string;
+        /**
+         * The account ID of the user, which uniquely identifies the user across all
+         * Atlassian products. For example, *5b10ac8d82e05b22cc7d4ef5*.
+         */
+        accountId?: string;
+        /**
+         * This parameter is no longer available and will be removed from the
+         * documentation soon. See the [deprecation
+         * notice](https://developer.atlassian.com/cloud/jira/platform/deprecation-notice-user-privacy-api-migration-guide/)
+         * for details.
+         */
+        userKey?: string;
+        /**
+         * This parameter is no longer available and will be removed from the
+         * documentation soon. See the [deprecation
+         * notice](https://developer.atlassian.com/cloud/jira/platform/deprecation-notice-user-privacy-api-migration-guide/)
+         * for details.
+         */
+        username?: string;
+    }): Promise<void>;
+    /**
+     * Returns the value of a user's property. If no property key is provided [Get
+     * user property keys](#api-rest-api-3-user-properties-get) is called.
+     *
+     * Note: This operation does not access the [user
+     * properties](https://confluence.atlassian.com/x/8YxjL) created and maintained in
+     * Jira.
+     *
+     * **[Permissions](#permissions) required:**
+     *
+     *  *  *Administer Jira* [global
+     * permission](https://confluence.atlassian.com/x/x4dKLg), to get a property from
+     * any user.
+     *  *  Access to Jira, to get a property from the calling user's record.
+     *
+     * @returns Returned if the request is successful.
+     *
+     * example: {
+     *   "key": "issue.support",
+     *   "value": {
+     *     "system.conversation.id": "b1bf38be-5e94-4b40-a3b8-9278735ee1e6",
+     *     "system.support.time": "1m"
+     *   }
+     * }
+     * @path {GET} /rest/api/3/user/properties/{propertyKey}
+     * @scopes-current read:jira-user
+     * @scopes-beta read:user.property:jira
+     */
+    getUserProperty({ propertyKey, accountId, userKey, username, }: {
+        /** The key of the user's property. */
+        propertyKey: string;
+        /**
+         * The account ID of the user, which uniquely identifies the user across all
+         * Atlassian products. For example, *5b10ac8d82e05b22cc7d4ef5*.
+         */
+        accountId?: string;
+        /**
+         * This parameter is no longer available and will be removed from the
+         * documentation soon. See the [deprecation
+         * notice](https://developer.atlassian.com/cloud/jira/platform/deprecation-notice-user-privacy-api-migration-guide/)
+         * for details.
+         */
+        userKey?: string;
+        /**
+         * This parameter is no longer available and will be removed from the
+         * documentation soon. See the [deprecation
+         * notice](https://developer.atlassian.com/cloud/jira/platform/deprecation-notice-user-privacy-api-migration-guide/)
+         * for details.
+         */
+        username?: string;
+    }): Promise<EntityProperty>;
+    /**
+     * Returns the keys of all properties for a user.
+     *
+     * Note: This operation does not access the [user
+     * properties](https://confluence.atlassian.com/x/8YxjL) created and maintained in
+     * Jira.
+     *
+     * **[Permissions](#permissions) required:**
+     *
+     *  *  *Administer Jira* [global
+     * permission](https://confluence.atlassian.com/x/x4dKLg), to access the property
+     * keys on any user.
+     *  *  Access to Jira, to access the calling user's property keys.
+     *
+     * @returns Returned if the request is successful.
+     *
+     * example: {
+     *   "keys": [
+     *     {
+     *       "key": "issue.support",
+     *       "self":
+     * "https://your-domain.atlassian.net/rest/api/3/issue/EX-2/properties/issue.support"
+     *     }
+     *   ]
+     * }
+     * @path {GET} /rest/api/3/user/properties
+     * @scopes-current read:jira-user
+     * @scopes-beta read:user.property:jira
+     */
+    getUserPropertyKeys({ accountId, userKey, username, }: {
+        /**
+         * The account ID of the user, which uniquely identifies the user across all
+         * Atlassian products. For example, *5b10ac8d82e05b22cc7d4ef5*.
+         */
+        accountId?: string;
+        /**
+         * This parameter is no longer available and will be removed from the
+         * documentation soon. See the [deprecation
+         * notice](https://developer.atlassian.com/cloud/jira/platform/deprecation-notice-user-privacy-api-migration-guide/)
+         * for details.
+         */
+        userKey?: string;
+        /**
+         * This parameter is no longer available and will be removed from the
+         * documentation soon. See the [deprecation
+         * notice](https://developer.atlassian.com/cloud/jira/platform/deprecation-notice-user-privacy-api-migration-guide/)
+         * for details.
+         */
+        username?: string;
+    }): Promise<PropertyKeys>;
+    /**
+     * Sets the value of a user's property. Use this resource to store custom data
+     * against a user.
+     *
+     * Note: This operation does not access the [user
+     * properties](https://confluence.atlassian.com/x/8YxjL) created and maintained in
+     * Jira.
+     *
+     * **[Permissions](#permissions) required:**
+     *
+     *  *  *Administer Jira* [global
+     * permission](https://confluence.atlassian.com/x/x4dKLg), to set a property on
+     * any user.
+     *  *  Access to Jira, to set a property on the calling user's record.
+     *
+     * @returns * status: 200, mediaType: application/json
+     *
+     *    Returned if the user property is updated.
+     *
+     *  * status: 201, mediaType: application/json
+     *
+     *    Returned if the user property is created.
+     * @path {PUT} /rest/api/3/user/properties/{propertyKey}
+     * @scopes-current write:jira-work
+     * @scopes-beta write:user.property:jira
+     */
+    setUserProperty({ propertyKey, accountId, userKey, username, requestBody, }: {
+        /** The key of the user's property. The maximum length is 255 characters. */
+        propertyKey: string;
+        /**
+         * The account ID of the user, which uniquely identifies the user across all
+         * Atlassian products. For example, *5b10ac8d82e05b22cc7d4ef5*.
+         */
+        accountId?: string;
+        /**
+         * This parameter is no longer available and will be removed from the
+         * documentation soon. See the [deprecation
+         * notice](https://developer.atlassian.com/cloud/jira/platform/deprecation-notice-user-privacy-api-migration-guide/)
+         * for details.
+         */
+        userKey?: string;
+        /**
+         * This parameter is no longer available and will be removed from the
+         * documentation soon. See the [deprecation
+         * notice](https://developer.atlassian.com/cloud/jira/platform/deprecation-notice-user-privacy-api-migration-guide/)
+         * for details.
+         */
+        username?: string;
+        /**
+         * The value of the property. The value has to be a valid, non-empty
+         * [JSON](https://tools.ietf.org/html/rfc4627) value. The maximum length of the
+         * property value is 32768 bytes.
+         */
+        requestBody: unknown;
+    }): Promise<{
+        created: boolean;
+        body: unknown;
+    }>;
+    static initialize(): void;
+}