@resolution/jira-api-client 0.1.0

package/src/openapi/platform/services/app-properties-service.ts

@@ -0,0 +1,441 @@
+// DO NOT EDIT!
+// This file is generated by "api-typescript-generator".
+// To update this file run "yarn build:openapi".
+import { z } from "zod";
+
+import * as commonHttpClient from "../core/common-http-client";
+import { CommonHttpService } from "../core/common-http-service";
+import {
+  type OperationMessage,
+  registerAppPropertiesValidationSchemas,
+} from "../models/app-properties";
+import {
+  type EntityProperty,
+  type PropertyKeys,
+  registerCommonValidationSchemas,
+} from "../models/common";
+import { validationSchemaStorage } from "../validation-schema-storage";
+/**
+ * This resource represents app properties. Use it to store arbitrary data for your
+ * [Connect
+ * app](https://developer.atlassian.com/cloud/jira/platform/index/#connect-apps).
+ */
+export class AppPropertiesService extends CommonHttpService {
+  /**
+   * Deletes an app's property.
+   *
+   * **[Permissions](#permissions) required:** Only a Connect app whose key matches
+   * `addonKey` can make this request.
+   * Additionally, Forge apps can access Connect app properties (stored against the
+   * same `app.connect.key`).
+   *
+   * @path {DELETE} /rest/atlassian-connect/1/addons/{addonKey}/properties/{propertyKey}
+   * @scopes-current
+   * @scopes-beta
+   */
+  addonPropertiesResourceDeleteAddonPropertyDelete({
+    addonKey,
+    propertyKey,
+  }: {
+    /** The key of the app, as defined in its descriptor. */
+    addonKey: string;
+    /** The key of the property. */
+    propertyKey: string;
+  }): Promise<void> {
+    return this.getClientInstance()
+      .request({
+        path: "/rest/atlassian-connect/1/addons/{addonKey}/properties/{propertyKey}",
+        method: "DELETE",
+        pathParams: {
+          addonKey,
+          propertyKey,
+        },
+      })
+      .then(commonHttpClient.discardResult);
+  }
+  /**
+   * Gets all the properties of an app.
+   *
+   * **[Permissions](#permissions) required:** Only a Connect app whose key matches
+   * `addonKey` can make this request.
+   * Additionally, Forge apps can access Connect app properties (stored against the
+   * same `app.connect.key`).
+   *
+   * @returns Returned if the request is successful.
+   *
+   * example: {
+   *     "keys": [
+   *         {
+   *             "self":
+   * "https://your-domain.atlassian.net/jira/rest/atlassian-connect/1/addon/example.app.key/properties/propertyKey",
+   *             "key": "propertyKey"
+   *         }
+   *     ]
+   * }
+   * @path {GET} /rest/atlassian-connect/1/addons/{addonKey}/properties
+   * @scopes-current
+   * @scopes-beta
+   */
+  addonPropertiesResourceGetAddonPropertiesGet({
+    addonKey,
+  }: {
+    /** The key of the app, as defined in its descriptor. */
+    addonKey: string;
+  }): Promise<PropertyKeys> {
+    return this.getClientInstance()
+      .request({
+        path: "/rest/atlassian-connect/1/addons/{addonKey}/properties",
+        method: "GET",
+        pathParams: {
+          addonKey,
+        },
+      })
+      .then(
+        this.getClientInstance().responseHandler({
+          200: {
+            "application/json": "json",
+          },
+        }),
+      )
+      .then(
+        commonHttpClient.castResponse<{
+          status: 200;
+          mediaType: "application/json";
+          body: PropertyKeys;
+        }>(),
+      )
+      .then(
+        validationSchemaStorage.validator(
+          "AppPropertiesService.AddonPropertiesResource.getAddonProperties_get.response",
+        ),
+      )
+      .then(commonHttpClient.getBody);
+  }
+  /**
+   * Returns the key and value of an app's property.
+   *
+   * **[Permissions](#permissions) required:** Only a Connect app whose key matches
+   * `addonKey` can make this request.
+   * Additionally, Forge apps can access Connect app properties (stored against the
+   * same `app.connect.key`).
+   *
+   * @returns Returned if the request is successful.
+   *
+   * example: {
+   *     "self":
+   * "https://your-domain.atlassian.net/jira/rest/atlassian-connect/1/addon/example.app.key/properties/propertyKey",
+   *     "key": "propertyKey",
+   *     "value": "propertyValue"
+   * }
+   * @path {GET} /rest/atlassian-connect/1/addons/{addonKey}/properties/{propertyKey}
+   * @scopes-current
+   * @scopes-beta
+   */
+  addonPropertiesResourceGetAddonPropertyGet({
+    addonKey,
+    propertyKey,
+  }: {
+    /** The key of the app, as defined in its descriptor. */
+    addonKey: string;
+    /** The key of the property. */
+    propertyKey: string;
+  }): Promise<EntityProperty> {
+    return this.getClientInstance()
+      .request({
+        path: "/rest/atlassian-connect/1/addons/{addonKey}/properties/{propertyKey}",
+        method: "GET",
+        pathParams: {
+          addonKey,
+          propertyKey,
+        },
+      })
+      .then(
+        this.getClientInstance().responseHandler({
+          200: {
+            "application/json": "json",
+          },
+        }),
+      )
+      .then(
+        commonHttpClient.castResponse<{
+          status: 200;
+          mediaType: "application/json";
+          body: EntityProperty;
+        }>(),
+      )
+      .then(
+        validationSchemaStorage.validator(
+          "AppPropertiesService.AddonPropertiesResource.getAddonProperty_get.response",
+        ),
+      )
+      .then(commonHttpClient.getBody);
+  }
+  /**
+   * Sets the value of an app's property. Use this resource to store custom data for
+   * your app.
+   *
+   * The value of the request body must be a
+   * [valid](http://tools.ietf.org/html/rfc4627), non-empty JSON blob. The maximum
+   * length is 32768 characters.
+   *
+   * **[Permissions](#permissions) required:** Only a Connect app whose key matches
+   * `addonKey` can make this request.
+   * Additionally, Forge apps can access Connect app properties (stored against the
+   * same `app.connect.key`).
+   *
+   * @returns * status: 200, mediaType: application/json
+   *
+   *    Returned if the property is updated.
+   *
+   *    example: {
+   *        "message": "Property updated.",
+   *        "statusCode": 200
+   *    }
+   *
+   *  * status: 201, mediaType: application/json
+   *
+   *    Returned is the property is created.
+   *
+   *    example: {
+   *        "message": "Property created.",
+   *        "statusCode": 201
+   *    }
+   * @path {PUT} /rest/atlassian-connect/1/addons/{addonKey}/properties/{propertyKey}
+   * @scopes-current
+   * @scopes-beta
+   */
+  addonPropertiesResourcePutAddonPropertyPut({
+    addonKey,
+    propertyKey,
+    requestBody,
+  }: {
+    /** The key of the app, as defined in its descriptor. */
+    addonKey: string;
+    /** The key of the property. */
+    propertyKey: string;
+    requestBody: unknown;
+  }): Promise<{
+    created: boolean;
+    operationMessage: OperationMessage;
+  }> {
+    return this.getClientInstance()
+      .request({
+        path: "/rest/atlassian-connect/1/addons/{addonKey}/properties/{propertyKey}",
+        method: "PUT",
+        pathParams: {
+          addonKey,
+          propertyKey,
+        },
+        headers: {
+          "Content-Type": "application/json",
+        },
+        body: requestBody,
+      })
+      .then(
+        this.getClientInstance().responseHandler({
+          200: {
+            "application/json": "json",
+          },
+          201: {
+            "application/json": "json",
+          },
+        }),
+      )
+      .then(
+        commonHttpClient.castResponse<{
+          status: 200 | 201;
+          mediaType: "application/json";
+          body: OperationMessage;
+        }>(),
+      )
+      .then(
+        validationSchemaStorage.validator(
+          "AppPropertiesService.AddonPropertiesResource.putAddonProperty_put.response",
+        ),
+      )
+      .then(commonHttpClient.asCreatedResponse("operationMessage"));
+  }
+  /**
+   * Deletes a Forge app's property.
+   *
+   * **[Permissions](#permissions) required:** Only Forge apps can make this request.
+   *
+   * @path {DELETE} /rest/forge/1/app/properties/{propertyKey}
+   * @scopes-current
+   * @scopes-beta
+   */
+  deleteForgeAppProperty({
+    propertyKey,
+  }: {
+    /** The key of the property. */
+    propertyKey: string;
+  }): Promise<void> {
+    return this.getClientInstance()
+      .request({
+        path: "/rest/forge/1/app/properties/{propertyKey}",
+        method: "DELETE",
+        pathParams: {
+          propertyKey,
+        },
+      })
+      .then(commonHttpClient.discardResult);
+  }
+  /**
+   * Sets the value of a Forge app's property.
+   * These values can be retrieved in [Jira
+   * expressions](https://developer.atlassian.com/cloud/jira/platform/jira-expressions/)
+   * through the `app` [context
+   * variable](https://developer.atlassian.com/cloud/jira/platform/jira-expressions/#context-variables).
+   *
+   * For other use cases, use the [Storage
+   * API](https://developer.atlassian.com/platform/forge/runtime-reference/storage-api/).
+   *
+   * The value of the request body must be a
+   * [valid](http://tools.ietf.org/html/rfc4627), non-empty JSON blob. The maximum
+   * length is 32768 characters.
+   *
+   * **[Permissions](#permissions) required:** Only Forge apps can make this request.
+   *
+   * @returns * status: 200, mediaType: application/json
+   *
+   *    Returned if the property is updated.
+   *
+   *    example: {
+   *        "message": "Property updated.",
+   *        "statusCode": 200
+   *    }
+   *
+   *  * status: 201, mediaType: application/json
+   *
+   *    Returned is the property is created.
+   *
+   *    example: {
+   *        "message": "Property created.",
+   *        "statusCode": 201
+   *    }
+   * @path {PUT} /rest/forge/1/app/properties/{propertyKey}
+   * @scopes-current
+   * @scopes-beta
+   */
+  putForgeAppProperty({
+    propertyKey,
+    requestBody,
+  }: {
+    /** The key of the property. */
+    propertyKey: string;
+    requestBody: unknown;
+  }): Promise<{
+    created: boolean;
+    operationMessage: OperationMessage;
+  }> {
+    return this.getClientInstance()
+      .request({
+        path: "/rest/forge/1/app/properties/{propertyKey}",
+        method: "PUT",
+        pathParams: {
+          propertyKey,
+        },
+        headers: {
+          "Content-Type": "application/json",
+        },
+        body: requestBody,
+      })
+      .then(
+        this.getClientInstance().responseHandler({
+          200: {
+            "application/json": "json",
+          },
+          201: {
+            "application/json": "json",
+          },
+        }),
+      )
+      .then(
+        commonHttpClient.castResponse<{
+          status: 200 | 201;
+          mediaType: "application/json";
+          body: OperationMessage;
+        }>(),
+      )
+      .then(
+        validationSchemaStorage.validator(
+          "AppPropertiesService.putForgeAppProperty.response",
+        ),
+      )
+      .then(commonHttpClient.asCreatedResponse("operationMessage"));
+  }
+  static initialize() {
+    validationSchemaStorage.registerExtensible(
+      "AppPropertiesService.AddonPropertiesResource.getAddonProperties_get.response",
+      z
+        .object({
+          status: z.literal(200),
+          mediaType: z.literal("application/json"),
+          body: validationSchemaStorage.lazy("PropertyKeys"),
+        })
+        .describe(
+          "AppPropertiesService.AddonPropertiesResource.getAddonProperties_get.response",
+        ),
+    );
+    validationSchemaStorage.registerExtensible(
+      "AppPropertiesService.AddonPropertiesResource.getAddonProperty_get.response",
+      z
+        .object({
+          status: z.literal(200),
+          mediaType: z.literal("application/json"),
+          body: validationSchemaStorage.lazy("EntityProperty"),
+        })
+        .describe(
+          "AppPropertiesService.AddonPropertiesResource.getAddonProperty_get.response",
+        ),
+    );
+    validationSchemaStorage.registerExtensible(
+      "AppPropertiesService.AddonPropertiesResource.putAddonProperty_put.response",
+      z
+        .object({
+          status: z.number(),
+          mediaType: z.string(),
+          body: z.unknown(),
+        })
+        .superRefine(({ status: status, body: body }, ctx) => {
+          if (status === 200 || status === 201) {
+            validationSchemaStorage.lazy("OperationMessage").parse(body);
+          } else {
+            ctx.addIssue({
+              code: z.ZodIssueCode.custom,
+              path: ["status"],
+              message: `Unexpected status code: ${status}`,
+            });
+          }
+        })
+        .describe(
+          "AppPropertiesService.AddonPropertiesResource.putAddonProperty_put.response",
+        ),
+    );
+    validationSchemaStorage.registerExtensible(
+      "AppPropertiesService.putForgeAppProperty.response",
+      z
+        .object({
+          status: z.number(),
+          mediaType: z.string(),
+          body: z.unknown(),
+        })
+        .superRefine(({ status: status, body: body }, ctx) => {
+          if (status === 200 || status === 201) {
+            validationSchemaStorage.lazy("OperationMessage").parse(body);
+          } else {
+            ctx.addIssue({
+              code: z.ZodIssueCode.custom,
+              path: ["status"],
+              message: `Unexpected status code: ${status}`,
+            });
+          }
+        })
+        .describe("AppPropertiesService.putForgeAppProperty.response"),
+    );
+    validationSchemaStorage.registerOnce([
+      registerCommonValidationSchemas,
+      registerAppPropertiesValidationSchemas,
+    ]);
+  }
+}

package/src/openapi/platform/services/application-roles-service.ts

@@ -0,0 +1,247 @@
+// DO NOT EDIT!
+// This file is generated by "api-typescript-generator".
+// To update this file run "yarn build:openapi".
+import { z } from "zod";
+
+import * as commonHttpClient from "../core/common-http-client";
+import { CommonHttpService } from "../core/common-http-service";
+import {
+  type ApplicationRole,
+  registerCommonValidationSchemas,
+} from "../models/common";
+import { validationSchemaStorage } from "../validation-schema-storage";
+/**
+ * This resource represents application roles. Use it to get details of an
+ * application role or all application roles.
+ */
+export class ApplicationRolesService extends CommonHttpService {
+  /**
+   * Returns all application roles. In Jira, application roles are managed using the
+   * [Application access configuration](https://confluence.atlassian.com/x/3YxjL)
+   * page.
+   *
+   * **[Permissions](#permissions) required:** *Administer Jira* [global
+   * permission](https://confluence.atlassian.com/x/x4dKLg).
+   *
+   * @returns Returned if the request is successful.
+   *
+   * example: [
+   *   {
+   *     "defaultGroups": [
+   *       "jira-software-users"
+   *     ],
+   *     "defaultGroupsDetails": [
+   *       {
+   *         "groupId": "276f955c-63d7-42c8-9520-92d01dca0625",
+   *         "name": "jira-software-users",
+   *         "self":
+   * "https://your-domain.atlassian.net/rest/api/3/group?groupId=276f955c-63d7-42c8-9520-92d01dca0625"
+   *       }
+   *     ],
+   *     "defined": false,
+   *     "groupDetails": [
+   *       {
+   *         "groupId": "42c8955c-63d7-42c8-9520-63d7aca0625",
+   *         "name": "jira-testers",
+   *         "self":
+   * "https://your-domain.atlassian.net/rest/api/3/group?groupId=42c8955c-63d7-42c8-9520-63d7aca0625"
+   *       },
+   *       {
+   *         "groupId": "276f955c-63d7-42c8-9520-92d01dca0625",
+   *         "name": "jira-software-users",
+   *         "self":
+   * "https://your-domain.atlassian.net/rest/api/3/group?groupId=276f955c-63d7-42c8-9520-92d01dca0625"
+   *       }
+   *     ],
+   *     "groups": [
+   *       "jira-software-users",
+   *       "jira-testers"
+   *     ],
+   *     "hasUnlimitedSeats": false,
+   *     "key": "jira-software",
+   *     "name": "Jira Software",
+   *     "numberOfSeats": 10,
+   *     "platform": false,
+   *     "remainingSeats": 5,
+   *     "selectedByDefault": false,
+   *     "userCount": 5,
+   *     "userCountDescription": "5 developers"
+   *   },
+   *   {
+   *     "defaultGroups": [
+   *       "jira-core-users"
+   *     ],
+   *     "defaultGroupsDetails": [
+   *       {
+   *         "groupId": "92d01dca0625-42c8-42c8-9520-276f955c",
+   *         "name": "jira-core-users",
+   *         "self":
+   * "https://your-domain.atlassian.net/rest/api/3/group?groupId=92d01dca0625-42c8-42c8-9520-276f955c"
+   *       }
+   *     ],
+   *     "defined": false,
+   *     "groupDetails": [
+   *       {
+   *         "groupId": "92d01dca0625-42c8-42c8-9520-276f955c",
+   *         "name": "jira-core-users",
+   *         "self":
+   * "https://your-domain.atlassian.net/rest/api/3/group?groupId=92d01dca0625-42c8-42c8-9520-276f955c"
+   *       }
+   *     ],
+   *     "groups": [
+   *       "jira-core-users"
+   *     ],
+   *     "hasUnlimitedSeats": false,
+   *     "key": "jira-core",
+   *     "name": "Jira Core",
+   *     "numberOfSeats": 1,
+   *     "platform": true,
+   *     "remainingSeats": 1,
+   *     "selectedByDefault": false,
+   *     "userCount": 0,
+   *     "userCountDescription": "0 users"
+   *   }
+   * ]
+   * @path {GET} /rest/api/3/applicationrole
+   */
+  getAllApplicationRoles(): Promise<ApplicationRole[]> {
+    return this.getClientInstance()
+      .request({
+        path: "/rest/api/3/applicationrole",
+        method: "GET",
+      })
+      .then(
+        this.getClientInstance().responseHandler({
+          200: {
+            "application/json": "json",
+          },
+        }),
+      )
+      .then(
+        commonHttpClient.castResponse<{
+          status: 200;
+          mediaType: "application/json";
+          body: ApplicationRole[];
+        }>(),
+      )
+      .then(
+        validationSchemaStorage.validator(
+          "ApplicationRolesService.getAllApplicationRoles.response",
+        ),
+      )
+      .then(commonHttpClient.getBody);
+  }
+  /**
+   * Returns an application role.
+   *
+   * **[Permissions](#permissions) required:** *Administer Jira* [global
+   * permission](https://confluence.atlassian.com/x/x4dKLg).
+   *
+   * @returns Returned if the request is successful.
+   *
+   * example: {
+   *   "defaultGroups": [
+   *     "jira-software-users"
+   *   ],
+   *   "defaultGroupsDetails": [
+   *     {
+   *       "groupId": "276f955c-63d7-42c8-9520-92d01dca0625",
+   *       "name": "jira-software-users",
+   *       "self":
+   * "https://your-domain.atlassian.net/rest/api/3/group?groupId=276f955c-63d7-42c8-9520-92d01dca0625"
+   *     }
+   *   ],
+   *   "defined": false,
+   *   "groupDetails": [
+   *     {
+   *       "groupId": "42c8955c-63d7-42c8-9520-63d7aca0625",
+   *       "name": "jira-testers",
+   *       "self":
+   * "https://your-domain.atlassian.net/rest/api/3/group?groupId=42c8955c-63d7-42c8-9520-63d7aca0625"
+   *     },
+   *     {
+   *       "groupId": "276f955c-63d7-42c8-9520-92d01dca0625",
+   *       "name": "jira-software-users",
+   *       "self":
+   * "https://your-domain.atlassian.net/rest/api/3/group?groupId=276f955c-63d7-42c8-9520-92d01dca0625"
+   *     }
+   *   ],
+   *   "groups": [
+   *     "jira-software-users",
+   *     "jira-testers"
+   *   ],
+   *   "hasUnlimitedSeats": false,
+   *   "key": "jira-software",
+   *   "name": "Jira Software",
+   *   "numberOfSeats": 10,
+   *   "platform": false,
+   *   "remainingSeats": 5,
+   *   "selectedByDefault": false,
+   *   "userCount": 5,
+   *   "userCountDescription": "5 developers"
+   * }
+   * @path {GET} /rest/api/3/applicationrole/{key}
+   */
+  getApplicationRole({
+    key,
+  }: {
+    /**
+     * The key of the application role. Use the [Get all application
+     * roles](#api-rest-api-3-applicationrole-get) operation to get the key for each
+     * application role.
+     */
+    key: string;
+  }): Promise<ApplicationRole> {
+    return this.getClientInstance()
+      .request({
+        path: "/rest/api/3/applicationrole/{key}",
+        method: "GET",
+        pathParams: {
+          key,
+        },
+      })
+      .then(
+        this.getClientInstance().responseHandler({
+          200: {
+            "application/json": "json",
+          },
+        }),
+      )
+      .then(
+        commonHttpClient.castResponse<{
+          status: 200;
+          mediaType: "application/json";
+          body: ApplicationRole;
+        }>(),
+      )
+      .then(
+        validationSchemaStorage.validator(
+          "ApplicationRolesService.getApplicationRole.response",
+        ),
+      )
+      .then(commonHttpClient.getBody);
+  }
+  static initialize() {
+    validationSchemaStorage.registerExtensible(
+      "ApplicationRolesService.getAllApplicationRoles.response",
+      z
+        .object({
+          status: z.literal(200),
+          mediaType: z.literal("application/json"),
+          body: z.array(validationSchemaStorage.lazy("ApplicationRole")),
+        })
+        .describe("ApplicationRolesService.getAllApplicationRoles.response"),
+    );
+    validationSchemaStorage.registerExtensible(
+      "ApplicationRolesService.getApplicationRole.response",
+      z
+        .object({
+          status: z.literal(200),
+          mediaType: z.literal("application/json"),
+          body: validationSchemaStorage.lazy("ApplicationRole"),
+        })
+        .describe("ApplicationRolesService.getApplicationRole.response"),
+    );
+    validationSchemaStorage.registerOnce([registerCommonValidationSchemas]);
+  }
+}