@resolution/jira-api-client 0.1.0

package/lib/openapi/platform/services/user-properties-service.js

@@ -0,0 +1,254 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.UserPropertiesService = 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 common_1 = require("../models/common");
+const validation_schema_storage_1 = require("../validation-schema-storage");
+/**
+ * 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.
+ */
+class UserPropertiesService extends common_http_service_1.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, }) {
+        return this.getClientInstance()
+            .request({
+            path: "/rest/api/3/user/properties/{propertyKey}",
+            method: "DELETE",
+            pathParams: {
+                propertyKey,
+            },
+            query: {
+                accountId,
+                userKey,
+                username,
+            },
+        })
+            .then(commonHttpClient.discardResult);
+    }
+    /**
+     * 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, }) {
+        return this.getClientInstance()
+            .request({
+            path: "/rest/api/3/user/properties/{propertyKey}",
+            method: "GET",
+            pathParams: {
+                propertyKey,
+            },
+            query: {
+                accountId,
+                userKey,
+                username,
+            },
+        })
+            .then(this.getClientInstance().responseHandler({
+            200: {
+                "application/json": "json",
+            },
+        }))
+            .then(commonHttpClient.castResponse())
+            .then(validation_schema_storage_1.validationSchemaStorage.validator("UserPropertiesService.getUserProperty.response"))
+            .then(commonHttpClient.getBody);
+    }
+    /**
+     * 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, }) {
+        return this.getClientInstance()
+            .request({
+            path: "/rest/api/3/user/properties",
+            method: "GET",
+            query: {
+                accountId,
+                userKey,
+                username,
+            },
+        })
+            .then(this.getClientInstance().responseHandler({
+            200: {
+                "application/json": "json",
+            },
+        }))
+            .then(commonHttpClient.castResponse())
+            .then(validation_schema_storage_1.validationSchemaStorage.validator("UserPropertiesService.getUserPropertyKeys.response"))
+            .then(commonHttpClient.getBody);
+    }
+    /**
+     * 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, }) {
+        return this.getClientInstance()
+            .request({
+            path: "/rest/api/3/user/properties/{propertyKey}",
+            method: "PUT",
+            pathParams: {
+                propertyKey,
+            },
+            query: {
+                accountId,
+                userKey,
+                username,
+            },
+            headers: {
+                "Content-Type": "application/json",
+            },
+            body: requestBody,
+        })
+            .then(this.getClientInstance().responseHandler({
+            200: {
+                "application/json": "json",
+            },
+            201: {
+                "application/json": "json",
+            },
+        }))
+            .then(commonHttpClient.castResponse())
+            .then(validation_schema_storage_1.validationSchemaStorage.validator("UserPropertiesService.setUserProperty.response"))
+            .then(commonHttpClient.asCreatedResponse("body"));
+    }
+    static initialize() {
+        validation_schema_storage_1.validationSchemaStorage.registerExtensible("UserPropertiesService.getUserPropertyKeys.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("PropertyKeys"),
+        })
+            .describe("UserPropertiesService.getUserPropertyKeys.response"));
+        validation_schema_storage_1.validationSchemaStorage.registerExtensible("UserPropertiesService.getUserProperty.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("EntityProperty"),
+        })
+            .describe("UserPropertiesService.getUserProperty.response"));
+        validation_schema_storage_1.validationSchemaStorage.registerExtensible("UserPropertiesService.setUserProperty.response", zod_1.z
+            .object({
+            status: zod_1.z.number(),
+            mediaType: zod_1.z.string(),
+            body: zod_1.z.unknown(),
+        })
+            .superRefine(({ status: status, body: body }, ctx) => {
+            if (status === 200 || status === 201) {
+                zod_1.z.unknown().parse(body);
+            }
+            else {
+                ctx.addIssue({
+                    code: zod_1.z.ZodIssueCode.custom,
+                    path: ["status"],
+                    message: `Unexpected status code: ${status}`,
+                });
+            }
+        })
+            .describe("UserPropertiesService.setUserProperty.response"));
+        validation_schema_storage_1.validationSchemaStorage.registerOnce([common_1.registerCommonValidationSchemas]);
+    }
+}
+exports.UserPropertiesService = UserPropertiesService;
+//# sourceMappingURL=user-properties-service.js.map

package/lib/openapi/platform/services/user-properties-service.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"user-properties-service.js","sourceRoot":"","sources":["../../../../src/openapi/platform/services/user-properties-service.ts"],"names":[],"mappings":";;;AAAA,eAAe;AACf,wDAAwD;AACxD,gDAAgD;AAChD,6BAAwB;AAExB,+DAA+D;AAC/D,qEAAgE;AAChE,6CAI0B;AAC1B,4EAAuE;AACvE;;;;;;;;;;;;GAYG;AACH,MAAa,qBAAsB,SAAQ,uCAAiB;IAC1D;;;;;;;;;;;;;;;;;OAiBG;IACH,kBAAkB,CAAC,EACjB,WAAW,EACX,SAAS,EACT,OAAO,EACP,QAAQ,GAuBT;QACC,OAAO,IAAI,CAAC,iBAAiB,EAAE;aAC5B,OAAO,CAAC;YACP,IAAI,EAAE,2CAA2C;YACjD,MAAM,EAAE,QAAQ;YAChB,UAAU,EAAE;gBACV,WAAW;aACZ;YACD,KAAK,EAAE;gBACL,SAAS;gBACT,OAAO;gBACP,QAAQ;aACT;SACF,CAAC;aACD,IAAI,CAAC,gBAAgB,CAAC,aAAa,CAAC,CAAC;IAC1C,CAAC;IACD;;;;;;;;;;;;;;;;;;;;;;;;;;;OA2BG;IACH,eAAe,CAAC,EACd,WAAW,EACX,SAAS,EACT,OAAO,EACP,QAAQ,GAuBT;QACC,OAAO,IAAI,CAAC,iBAAiB,EAAE;aAC5B,OAAO,CAAC;YACP,IAAI,EAAE,2CAA2C;YACjD,MAAM,EAAE,KAAK;YACb,UAAU,EAAE;gBACV,WAAW;aACZ;YACD,KAAK,EAAE;gBACL,SAAS;gBACT,OAAO;gBACP,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,CAC/B,gDAAgD,CACjD,CACF;aACA,IAAI,CAAC,gBAAgB,CAAC,OAAO,CAAC,CAAC;IACpC,CAAC;IACD;;;;;;;;;;;;;;;;;;;;;;;;;;;;OA4BG;IACH,mBAAmB,CAAC,EAClB,SAAS,EACT,OAAO,EACP,QAAQ,GAqBT;QACC,OAAO,IAAI,CAAC,iBAAiB,EAAE;aAC5B,OAAO,CAAC;YACP,IAAI,EAAE,6BAA6B;YACnC,MAAM,EAAE,KAAK;YACb,KAAK,EAAE;gBACL,SAAS;gBACT,OAAO;gBACP,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,CAC/B,oDAAoD,CACrD,CACF;aACA,IAAI,CAAC,gBAAgB,CAAC,OAAO,CAAC,CAAC;IACpC,CAAC;IACD;;;;;;;;;;;;;;;;;;;;;;;;;OAyBG;IACH,eAAe,CAAC,EACd,WAAW,EACX,SAAS,EACT,OAAO,EACP,QAAQ,EACR,WAAW,GA6BZ;QAIC,OAAO,IAAI,CAAC,iBAAiB,EAAE;aAC5B,OAAO,CAAC;YACP,IAAI,EAAE,2CAA2C;YACjD,MAAM,EAAE,KAAK;YACb,UAAU,EAAE;gBACV,WAAW;aACZ;YACD,KAAK,EAAE;gBACL,SAAS;gBACT,OAAO;gBACP,QAAQ;aACT;YACD,OAAO,EAAE;gBACP,cAAc,EAAE,kBAAkB;aACnC;YACD,IAAI,EAAE,WAAW;SAClB,CAAC;aACD,IAAI,CACH,IAAI,CAAC,iBAAiB,EAAE,CAAC,eAAe,CAAC;YACvC,GAAG,EAAE;gBACH,kBAAkB,EAAE,MAAM;aAC3B;YACD,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,gDAAgD,CACjD,CACF;aACA,IAAI,CAAC,gBAAgB,CAAC,iBAAiB,CAAC,MAAM,CAAC,CAAC,CAAC;IACtD,CAAC;IACD,MAAM,CAAC,UAAU;QACf,mDAAuB,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,mDAAuB,CAAC,IAAI,CAAC,cAAc,CAAC;SACnD,CAAC;aACD,QAAQ,CAAC,oDAAoD,CAAC,CAClE,CAAC;QACF,mDAAuB,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,mDAAuB,CAAC,IAAI,CAAC,gBAAgB,CAAC;SACrD,CAAC;aACD,QAAQ,CAAC,gDAAgD,CAAC,CAC9D,CAAC;QACF,mDAAuB,CAAC,kBAAkB,CACxC,gDAAgD,EAChD,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,MAAM,EAAE,MAAM,EAAE,IAAI,EAAE,IAAI,EAAE,EAAE,GAAG,EAAE,EAAE;YACnD,IAAI,MAAM,KAAK,GAAG,IAAI,MAAM,KAAK,GAAG,EAAE,CAAC;gBACrC,OAAC,CAAC,OAAO,EAAE,CAAC,KAAK,CAAC,IAAI,CAAC,CAAC;YAC1B,CAAC;iBAAM,CAAC;gBACN,GAAG,CAAC,QAAQ,CAAC;oBACX,IAAI,EAAE,OAAC,CAAC,YAAY,CAAC,MAAM;oBAC3B,IAAI,EAAE,CAAC,QAAQ,CAAC;oBAChB,OAAO,EAAE,2BAA2B,MAAM,EAAE;iBAC7C,CAAC,CAAC;YACL,CAAC;QACH,CAAC,CAAC;aACD,QAAQ,CAAC,gDAAgD,CAAC,CAC9D,CAAC;QACF,mDAAuB,CAAC,YAAY,CAAC,CAAC,wCAA+B,CAAC,CAAC,CAAC;IAC1E,CAAC;CACF;AAlYD,sDAkYC"}