@resolution/jira-api-client 0.1.0 → 0.1.2

package/src/openapi/platform/services/jira-settings-service.ts

@@ -1,415 +0,0 @@
-// 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 ApplicationProperty,
-  type Configuration,
-  registerJiraSettingsValidationSchemas,
-  type SimpleApplicationPropertyBean,
-} from "../models/jira-settings";
-import { validationSchemaStorage } from "../validation-schema-storage";
-/**
- * This resource represents various settings in Jira. Use it to get and update
- * Jira settings and properties.
- */
-export class JiraSettingsService extends CommonHttpService {
-  /**
-   * Returns the application properties that are accessible on the *Advanced
-   * Settings* page. To navigate to the *Advanced Settings* page in Jira, choose the
-   * Jira icon > **Jira settings** > **System**, **General Configuration** and then
-   * click **Advanced Settings** (in the upper right).
-   *
-   * **[Permissions](#permissions) required:** *Administer Jira* [global
-   * permission](https://confluence.atlassian.com/x/x4dKLg).
-   *
-   * @returns Returned if the request is successful.
-   *
-   * example: [
-   *   {
-   *     "defaultValue": "",
-   *     "desc": "Jira home directory",
-   *     "id": "jira.home",
-   *     "key": "jira.home",
-   *     "name": "jira.home",
-   *     "type": "string",
-   *     "value": "/var/jira/jira-home"
-   *   },
-   *   {
-   *     "defaultValue": "CLONE -",
-   *     "id": "jira.clone.prefix",
-   *     "key": "jira.clone.prefix",
-   *     "name": "The prefix added to the Summary field of cloned issues",
-   *     "type": "string",
-   *     "value": "CLONE -"
-   *   }
-   * ]
-   * @path {GET} /rest/api/3/application-properties/advanced-settings
-   * @scopes-current manage:jira-configuration
-   * @scopes-beta read:instance-configuration:jira
-   */
-  getAdvancedSettings(): Promise<ApplicationProperty[]> {
-    return this.getClientInstance()
-      .request({
-        path: "/rest/api/3/application-properties/advanced-settings",
-        method: "GET",
-      })
-      .then(
-        this.getClientInstance().responseHandler({
-          200: {
-            "application/json": "json",
-          },
-        }),
-      )
-      .then(
-        commonHttpClient.castResponse<{
-          status: 200;
-          mediaType: "application/json";
-          body: ApplicationProperty[];
-        }>(),
-      )
-      .then(
-        validationSchemaStorage.validator(
-          "JiraSettingsService.getAdvancedSettings.response",
-        ),
-      )
-      .then(commonHttpClient.getBody);
-  }
-  /**
-   * Returns all application properties or an application property.
-   *
-   * If you specify a value for the `key` parameter, then an application property is
-   * returned as an object (not in an array). Otherwise, an array of all editable
-   * application properties is returned. See [Set application
-   * property](#api-rest-api-3-application-properties-id-put) for descriptions of
-   * editable properties.
-   *
-   * **[Permissions](#permissions) required:** *Administer Jira* [global
-   * permission](https://confluence.atlassian.com/x/x4dKLg).
-   *
-   * @returns Returned if the request is successful.
-   *
-   * example: [
-   *   {
-   *     "defaultValue": "",
-   *     "desc": "Jira home directory",
-   *     "id": "jira.home",
-   *     "key": "jira.home",
-   *     "name": "jira.home",
-   *     "type": "string",
-   *     "value": "/var/jira/jira-home"
-   *   },
-   *   {
-   *     "defaultValue": "CLONE -",
-   *     "id": "jira.clone.prefix",
-   *     "key": "jira.clone.prefix",
-   *     "name": "The prefix added to the Summary field of cloned issues",
-   *     "type": "string",
-   *     "value": "CLONE -"
-   *   }
-   * ]
-   * @path {GET} /rest/api/3/application-properties
-   * @scopes-current manage:jira-configuration
-   * @scopes-beta read:instance-configuration:jira
-   */
-  getApplicationProperty({
-    key,
-    permissionLevel,
-    keyFilter,
-  }: {
-    /** The key of the application property. */
-    key?: string;
-    /** The permission level of all items being returned in the list. */
-    permissionLevel?: string;
-    /**
-     * When a `key` isn't provided, this filters the list of results by the
-     * application property `key` using a regular expression. For example, using
-     * `jira.lf.*` will return all application properties with keys that start with
-     * *jira.lf.*.
-     */
-    keyFilter?: string;
-  }): Promise<ApplicationProperty[]> {
-    return this.getClientInstance()
-      .request({
-        path: "/rest/api/3/application-properties",
-        method: "GET",
-        query: {
-          key,
-          permissionLevel,
-          keyFilter,
-        },
-      })
-      .then(
-        this.getClientInstance().responseHandler({
-          200: {
-            "application/json": "json",
-          },
-        }),
-      )
-      .then(
-        commonHttpClient.castResponse<{
-          status: 200;
-          mediaType: "application/json";
-          body: ApplicationProperty[];
-        }>(),
-      )
-      .then(
-        validationSchemaStorage.validator(
-          "JiraSettingsService.getApplicationProperty.response",
-        ),
-      )
-      .then(commonHttpClient.getBody);
-  }
-  /**
-   * Returns the [global settings](https://confluence.atlassian.com/x/qYXKM) in
-   * Jira. These settings determine whether optional features (for example,
-   * subtasks, time tracking, and others) are enabled. If time tracking is enabled,
-   * this operation also returns the time tracking configuration.
-   *
-   * **[Permissions](#permissions) required:** Permission to access Jira.
-   *
-   * @returns Returned if the request is successful.
-   *
-   * example: {
-   *   "attachmentsEnabled": true,
-   *   "issueLinkingEnabled": true,
-   *   "subTasksEnabled": false,
-   *   "timeTrackingConfiguration": {
-   *     "defaultUnit": "day",
-   *     "timeFormat": "pretty",
-   *     "workingDaysPerWeek": 5,
-   *     "workingHoursPerDay": 8
-   *   },
-   *   "timeTrackingEnabled": true,
-   *   "unassignedIssuesAllowed": false,
-   *   "votingEnabled": true,
-   *   "watchingEnabled": true
-   * }
-   * @path {GET} /rest/api/3/configuration
-   * @scopes-current read:jira-user
-   * @scopes-beta read:instance-configuration:jira, read:issue.time-tracking:jira
-   */
-  getConfiguration(): Promise<Configuration> {
-    return this.getClientInstance()
-      .request({
-        path: "/rest/api/3/configuration",
-        method: "GET",
-      })
-      .then(
-        this.getClientInstance().responseHandler({
-          200: {
-            "application/json": "json",
-          },
-        }),
-      )
-      .then(
-        commonHttpClient.castResponse<{
-          status: 200;
-          mediaType: "application/json";
-          body: Configuration;
-        }>(),
-      )
-      .then(
-        validationSchemaStorage.validator(
-          "JiraSettingsService.getConfiguration.response",
-        ),
-      )
-      .then(commonHttpClient.getBody);
-  }
-  /**
-   * Changes the value of an application property. For example, you can change the
-   * value of the `jira.clone.prefix` from its default value of *CLONE -* to *Clone
-   * -* if you prefer sentence case capitalization. Editable properties are
-   * described below along with their default values.
-   *
-   * #### Advanced settings ####
-   *
-   * The advanced settings below are also accessible in
-   * [Jira](https://confluence.atlassian.com/x/vYXKM).
-   *
-   * | Key | Description | Default value |
-   * | -- | -- | -- |
-   * | `jira.clone.prefix` | The string of text prefixed to the title of a cloned
-   * issue. | `CLONE -` |
-   * | `jira.date.picker.java.format` | The date format for the Java (server-side)
-   * generated dates. This must be the same as the
-   * `jira.date.picker.javascript.format` format setting. | `d/MMM/yy` |
-   * | `jira.date.picker.javascript.format` | The date format for the JavaScript
-   * (client-side) generated dates. This must be the same as the
-   * `jira.date.picker.java.format` format setting. | `%e/%b/%y` |
-   * | `jira.date.time.picker.java.format` | The date format for the Java
-   * (server-side) generated date times. This must be the same as the
-   * `jira.date.time.picker.javascript.format` format setting. | `dd/MMM/yy h:mm a` |
-   * | `jira.date.time.picker.javascript.format` | The date format for the
-   * JavaScript (client-side) generated date times. This must be the same as the
-   * `jira.date.time.picker.java.format` format setting. | `%e/%b/%y %I:%M %p` |
-   * | `jira.issue.actions.order` | The default order of actions (such as *Comments*
-   * or *Change history*) displayed on the issue view. | `asc` |
-   * | `jira.view.issue.links.sort.order` | The sort order of the list of issue
-   * links on the issue view. | `type, status, priority` |
-   * | `jira.comment.collapsing.minimum.hidden` | The minimum number of comments
-   * required for comment collapsing to occur. A value of `0` disables comment
-   * collapsing. | `4` |
-   * | `jira.newsletter.tip.delay.days` | The number of days before a prompt to sign
-   * up to the Jira Insiders newsletter is shown. A value of `-1` disables this
-   * feature. | `7` |
-   *
-   *
-   * #### Look and feel ####
-   *
-   * The settings listed below adjust the [look and
-   * feel](https://confluence.atlassian.com/x/VwCLLg).
-   *
-   * | Key | Description | Default value |
-   * | -- | -- | -- |
-   * | `jira.lf.date.time` | The [ time
-   * format](https://docs.oracle.com/javase/6/docs/api/index.html?java/text/SimpleDateFormat.html).
-   * | `h:mm a` |
-   * | `jira.lf.date.day` | The [ day
-   * format](https://docs.oracle.com/javase/6/docs/api/index.html?java/text/SimpleDateFormat.html).
-   * | `EEEE h:mm a` |
-   * | `jira.lf.date.complete` | The [ date and time
-   * format](https://docs.oracle.com/javase/6/docs/api/index.html?java/text/SimpleDateFormat.html).
-   * | `dd/MMM/yy h:mm a` |
-   * | `jira.lf.date.dmy` | The [ date
-   * format](https://docs.oracle.com/javase/6/docs/api/index.html?java/text/SimpleDateFormat.html).
-   * | `dd/MMM/yy` |
-   * | `jira.date.time.picker.use.iso8061` | When enabled, sets Monday as the first
-   * day of the week in the date picker, as specified by the ISO8601 standard. |
-   * `false` |
-   * | `jira.lf.logo.url` | The URL of the logo image file. |
-   * `/images/icon-jira-logo.png` |
-   * | `jira.lf.logo.show.application.title` | Controls the visibility of the
-   * application title on the sidebar. | `false` |
-   * | `jira.lf.favicon.url` | The URL of the favicon. | `/favicon.ico` |
-   * | `jira.lf.favicon.hires.url` | The URL of the high-resolution favicon. |
-   * `/images/64jira.png` |
-   * | `jira.lf.navigation.bgcolour` | The background color of the sidebar. |
-   * `#0747A6` |
-   * | `jira.lf.navigation.highlightcolour` | The color of the text and logo of the
-   * sidebar. | `#DEEBFF` |
-   * | `jira.lf.hero.button.base.bg.colour` | The background color of the hero
-   * button. | `#3b7fc4` |
-   * | `jira.title` | The text for the application title. The application title can
-   * also be set in *General settings*. | `Jira` |
-   * | `jira.option.globalsharing` | Whether filters and dashboards can be shared
-   * with anyone signed into Jira. | `true` |
-   * | `xflow.product.suggestions.enabled` | Whether to expose product suggestions
-   * for other Atlassian products within Jira. | `true` |
-   *
-   *
-   * #### Other settings ####
-   *
-   * | Key | Description | Default value |
-   * | -- | -- | -- |
-   * | `jira.issuenav.criteria.autoupdate` | Whether instant updates to search
-   * criteria is active. | `true` |
-   *
-   *
-   * *Note: Be careful when changing [application properties and advanced
-   * settings](https://confluence.atlassian.com/x/vYXKM).*
-   *
-   * **[Permissions](#permissions) required:** *Administer Jira* [global
-   * permission](https://confluence.atlassian.com/x/x4dKLg).
-   *
-   * @returns Returned if the request is successful.
-   * @path {PUT} /rest/api/3/application-properties/{id}
-   * @scopes-current manage:jira-configuration
-   * @scopes-beta write:instance-configuration:jira, read:instance-configuration:jira
-   */
-  setApplicationProperty({
-    id,
-    simpleApplicationPropertyBean,
-  }: {
-    /** The key of the application property to update. */
-    id: string;
-    /**
-     * @example {
-     *     "id": "jira.home",
-     *     "value": "/var/jira/jira-home"
-     * }
-     */
-    simpleApplicationPropertyBean: SimpleApplicationPropertyBean;
-  }): Promise<ApplicationProperty> {
-    return this.getClientInstance()
-      .request({
-        path: "/rest/api/3/application-properties/{id}",
-        method: "PUT",
-        pathParams: {
-          id,
-        },
-        headers: {
-          "Content-Type": "application/json",
-        },
-        body: simpleApplicationPropertyBean,
-      })
-      .then(
-        this.getClientInstance().responseHandler({
-          200: {
-            "application/json": "json",
-          },
-        }),
-      )
-      .then(
-        commonHttpClient.castResponse<{
-          status: 200;
-          mediaType: "application/json";
-          body: ApplicationProperty;
-        }>(),
-      )
-      .then(
-        validationSchemaStorage.validator(
-          "JiraSettingsService.setApplicationProperty.response",
-        ),
-      )
-      .then(commonHttpClient.getBody);
-  }
-  static initialize() {
-    validationSchemaStorage.registerExtensible(
-      "JiraSettingsService.getApplicationProperty.response",
-      z
-        .object({
-          status: z.literal(200),
-          mediaType: z.literal("application/json"),
-          body: z.array(validationSchemaStorage.lazy("ApplicationProperty")),
-        })
-        .describe("JiraSettingsService.getApplicationProperty.response"),
-    );
-    validationSchemaStorage.registerExtensible(
-      "JiraSettingsService.setApplicationProperty.response",
-      z
-        .object({
-          status: z.literal(200),
-          mediaType: z.literal("application/json"),
-          body: validationSchemaStorage.lazy("ApplicationProperty"),
-        })
-        .describe("JiraSettingsService.setApplicationProperty.response"),
-    );
-    validationSchemaStorage.registerExtensible(
-      "JiraSettingsService.getAdvancedSettings.response",
-      z
-        .object({
-          status: z.literal(200),
-          mediaType: z.literal("application/json"),
-          body: z.array(validationSchemaStorage.lazy("ApplicationProperty")),
-        })
-        .describe("JiraSettingsService.getAdvancedSettings.response"),
-    );
-    validationSchemaStorage.registerExtensible(
-      "JiraSettingsService.getConfiguration.response",
-      z
-        .object({
-          status: z.literal(200),
-          mediaType: z.literal("application/json"),
-          body: validationSchemaStorage.lazy("Configuration"),
-        })
-        .describe("JiraSettingsService.getConfiguration.response"),
-    );
-    validationSchemaStorage.registerOnce([
-      registerJiraSettingsValidationSchemas,
-    ]);
-  }
-}

package/src/openapi/platform/services/jql-functions-apps-service.ts

@@ -1,219 +0,0 @@
-// 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 JqlFunctionPrecomputationUpdateRequestBean,
-  type PageBeanJqlFunctionPrecomputationBean,
-  registerJqlFunctionsAppsValidationSchemas,
-} from "../models/jql-functions-apps";
-import { validationSchemaStorage } from "../validation-schema-storage";
-/**
- * This resource represents JQL function's precomputations. Precomputation is a
- * mapping between custom function call and JQL fragment returned by this
- * function. Use it to get and update precomputations.
- */
-export class JqlFunctionsAppsService extends CommonHttpService {
-  /**
-   * Returns the list of a function's precomputations along with information about
-   * when they were created, updated, and last used. Each precomputation has a
-   * `value` \- the JQL fragment to replace the custom function clause with.
-   *
-   * **[Permissions](#permissions) required:** This API is only accessible to apps
-   * and apps can only inspect their own functions.
-   *
-   * @returns Returned if the request is successful.
-   *
-   * example: {
-   *   "isLast": true,
-   *   "maxResults": 100,
-   *   "startAt": 0,
-   *   "total": 1,
-   *   "values": [
-   *     {
-   *       "id": "cf75a1b0-4ac6-4bd8-8a50-29a465a96520",
-   *       "value": "issue in (TEST-1, TEST-2, TEST-3)",
-   *       "functionKey":
-   * "ari:cloud:ecosystem::extension/00000000-1111-2222-3333-4444444/111111-2222-3333-4444-55555/static/issuesWithText",
-   *       "field": "issue",
-   *       "operator": "in",
-   *       "functionName": "issuesWithText",
-   *       "arguments": [
-   *         "Test"
-   *       ],
-   *       "created": "2023-10-14T05:25:20.000+0000",
-   *       "updated": "2023-10-14T05:25:20.000+0000",
-   *       "used": "2023-10-14T05:25:20.000+0000"
-   *     },
-   *     {
-   *       "id": "2a854f11-d0e1-4260-aea8-64a562a7062a",
-   *       "error": "Error message to be displayed to the user",
-   *       "functionKey":
-   * "ari:cloud:ecosystem::extension/00000000-1111-2222-3333-4444444/111111-2222-3333-4444-55555/static/issuesWithText",
-   *       "field": "issue",
-   *       "operator": "=",
-   *       "functionName": "issuesWithText",
-   *       "arguments": [
-   *         "10001"
-   *       ],
-   *       "created": "2023-10-14T05:25:20.000+0000",
-   *       "updated": "2023-10-14T05:25:20.000+0000",
-   *       "used": "2023-10-14T05:25:20.000+0000"
-   *     }
-   *   ]
-   * }
-   * @path {GET} /rest/api/3/jql/function/computation
-   * @scopes-current
-   * @scopes-beta
-   */
-  getPrecomputations({
-    functionKey,
-    startAt,
-    maxResults,
-    orderBy,
-  }: {
-    /**
-     * The function key in format:
-     *
-     *  *  Forge: `ari:cloud:ecosystem::extension/[App ID]/[Environment
-     * ID]/static/[Function key from manifest]`
-     *  *  Connect: `[App key]__[Module key]`
-     */
-    functionKey?: string[];
-    /** The index of the first item to return in a page of results (page offset). */
-    startAt?: number;
-    /** The maximum number of items to return per page. */
-    maxResults?: number;
-    /**
-     * [Order](#ordering) the results by a field:
-     *
-     *  *  `functionKey` Sorts by the functionKey.
-     *  *  `used` Sorts by the used timestamp.
-     *  *  `created` Sorts by the created timestamp.
-     *  *  `updated` Sorts by the updated timestamp.
-     */
-    orderBy?: string;
-  }): Promise<PageBeanJqlFunctionPrecomputationBean> {
-    return this.getClientInstance()
-      .request({
-        path: "/rest/api/3/jql/function/computation",
-        method: "GET",
-        query: {
-          functionKey,
-          startAt,
-          maxResults,
-          orderBy,
-        },
-      })
-      .then(
-        this.getClientInstance().responseHandler({
-          200: {
-            "application/json": "json",
-          },
-        }),
-      )
-      .then(
-        commonHttpClient.castResponse<{
-          status: 200;
-          mediaType: "application/json";
-          body: PageBeanJqlFunctionPrecomputationBean;
-        }>(),
-      )
-      .then(
-        validationSchemaStorage.validator(
-          "JqlFunctionsAppsService.getPrecomputations.response",
-        ),
-      )
-      .then(commonHttpClient.getBody);
-  }
-  /**
-   * Update the precomputation value of a function created by a Forge/Connect app.
-   *
-   * **[Permissions](#permissions) required:** An API for apps to update their own
-   * precomputations.
-   *
-   * @returns Returned if the request is successful.
-   * @path {POST} /rest/api/3/jql/function/computation
-   * @scopes-current
-   * @scopes-beta
-   */
-  updatePrecomputations({
-    jqlFunctionPrecomputationUpdateRequestBean,
-  }: {
-    /**
-     * @example {
-     *     "values": [
-     *         {
-     *             "id": "f2ef228b-367f-4c6b-bd9d-0d0e96b5bd7b",
-     *             "value": "issue in (TEST-1, TEST-2, TEST-3)"
-     *         },
-     *         {
-     *             "error": "Error message to be displayed to the user",
-     *             "id": "2a854f11-d0e1-4260-aea8-64a562a7062a"
-     *         }
-     *     ]
-     * }
-     */
-    jqlFunctionPrecomputationUpdateRequestBean: JqlFunctionPrecomputationUpdateRequestBean;
-  }): Promise<void> {
-    return this.getClientInstance()
-      .request({
-        path: "/rest/api/3/jql/function/computation",
-        method: "POST",
-        headers: {
-          "Content-Type": "application/json",
-        },
-        body: jqlFunctionPrecomputationUpdateRequestBean,
-      })
-      .then(
-        this.getClientInstance().responseHandler({
-          204: {
-            "application/json": "json",
-          },
-        }),
-      )
-      .then(
-        commonHttpClient.castResponse<{
-          status: 204;
-          mediaType: "application/json";
-          body: void;
-        }>(),
-      )
-      .then(
-        validationSchemaStorage.validator(
-          "JqlFunctionsAppsService.updatePrecomputations.response",
-        ),
-      )
-      .then(commonHttpClient.getBody);
-  }
-  static initialize() {
-    validationSchemaStorage.registerExtensible(
-      "JqlFunctionsAppsService.getPrecomputations.response",
-      z
-        .object({
-          status: z.literal(200),
-          mediaType: z.literal("application/json"),
-          body: validationSchemaStorage.lazy(
-            "PageBeanJqlFunctionPrecomputationBean",
-          ),
-        })
-        .describe("JqlFunctionsAppsService.getPrecomputations.response"),
-    );
-    validationSchemaStorage.registerExtensible(
-      "JqlFunctionsAppsService.updatePrecomputations.response",
-      z
-        .object({
-          status: z.literal(204),
-          mediaType: z.literal("application/json"),
-          body: z.unknown(),
-        })
-        .describe("JqlFunctionsAppsService.updatePrecomputations.response"),
-    );
-    validationSchemaStorage.registerOnce([
-      registerJqlFunctionsAppsValidationSchemas,
-    ]);
-  }
-}