@esm-js/jira.js/src/version2/jqlFunctionsApps.ts

A comprehensive JavaScript/TypeScript library designed for both Node.JS and browsers, facilitating seamless interaction with the Atlassian Jira API.

import type * as Models from './models';
import type * as Parameters from './parameters';
import type { Client } from '../clients';
import type { Callback } from '../callback';
import type { RequestConfig } from '../requestConfig';

export class JqlFunctionsApps {
  constructor(private client: Client) {}

  /**
   * 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](https://developer.atlassian.com/cloud/jira/platform/rest/v2/intro/#permissions) required:** This
   * API is only accessible to apps and apps can only inspect their own functions.
   *
   * The new `read:app-data:jira` OAuth scope is 100% optional now, and not using it won't break your app. However, we
   * recommend adding it to your app's scope list because we will eventually make it mandatory.
   */
  async getPrecomputations<T = Models.PageJqlFunctionPrecomputation>(
    parameters: Parameters.GetPrecomputations | undefined,
    callback: Callback<T>,
  ): Promise<void>;
  /**
   * 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](https://developer.atlassian.com/cloud/jira/platform/rest/v2/intro/#permissions) required:** This
   * API is only accessible to apps and apps can only inspect their own functions.
   *
   * The new `read:app-data:jira` OAuth scope is 100% optional now, and not using it won't break your app. However, we
   * recommend adding it to your app's scope list because we will eventually make it mandatory.
   */
  async getPrecomputations<T = Models.PageJqlFunctionPrecomputation>(
    parameters?: Parameters.GetPrecomputations,
    callback?: never,
  ): Promise<T>;
  async getPrecomputations<T = Models.PageJqlFunctionPrecomputation>(
    parameters?: Parameters.GetPrecomputations,
    callback?: Callback<T>,
  ): Promise<void | T> {
    const config: RequestConfig = {
      url: '/rest/api/2/jql/function/computation',
      method: 'GET',
      params: {
        functionKey: parameters?.functionKey,
        startAt: parameters?.startAt,
        maxResults: parameters?.maxResults,
        orderBy: parameters?.orderBy,
        filter: parameters?.filter,
      },
    };

    return this.client.sendRequest(config, callback);
  }

  /**
   * Update the precomputation value of a function created by a Forge/Connect app.
   *
   * **[Permissions](https://developer.atlassian.com/cloud/jira/platform/rest/v2/intro/#permissions) required:** An API
   * for apps to update their own precomputations.
   *
   * The new `write:app-data:jira` OAuth scope is 100% optional now, and not using it won't break your app. However, we
   * recommend adding it to your app's scope list because we will eventually make it mandatory.
   */
  async updatePrecomputations<T = void>(
    parameters: Parameters.UpdatePrecomputations,
    callback: Callback<T>,
  ): Promise<void>;
  /**
   * Update the precomputation value of a function created by a Forge/Connect app.
   *
   * **[Permissions](https://developer.atlassian.com/cloud/jira/platform/rest/v2/intro/#permissions) required:** An API
   * for apps to update their own precomputations.
   *
   * The new `write:app-data:jira` OAuth scope is 100% optional now, and not using it won't break your app. However, we
   * recommend adding it to your app's scope list because we will eventually make it mandatory.
   */
  async updatePrecomputations<T = void>(parameters: Parameters.UpdatePrecomputations, callback?: never): Promise<T>;
  async updatePrecomputations<T = void>(
    parameters: Parameters.UpdatePrecomputations,
    callback?: Callback<T>,
  ): Promise<void | T> {
    const config: RequestConfig = {
      url: '/rest/api/2/jql/function/computation',
      method: 'POST',
      params: {
        skipNotFoundPrecomputations: parameters.skipNotFoundPrecomputations,
      },
      data: {
        values: parameters.values,
      },
    };

    return this.client.sendRequest(config, callback);
  }

  /**
   * Returns function precomputations by IDs, 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](https://developer.atlassian.com/cloud/jira/platform/rest/v2/intro/#permissions) required:** This
   * API is only accessible to apps and apps can only inspect their own functions.
   *
   * The new `read:app-data:jira` OAuth scope is 100% optional now, and not using it won't break your app. However, we
   * recommend adding it to your app's scope list because we will eventually make it mandatory.
   */
  async getPrecomputationsByID<T = Models.JqlFunctionPrecomputationGetByIdResponse>(
    parameters: Parameters.GetPrecomputationsByID,
    callback: Callback<T>,
  ): Promise<void>;
  /**
   * Returns function precomputations by IDs, 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](https://developer.atlassian.com/cloud/jira/platform/rest/v2/intro/#permissions) required:** This
   * API is only accessible to apps and apps can only inspect their own functions.
   *
   * The new `read:app-data:jira` OAuth scope is 100% optional now, and not using it won't break your app. However, we
   * recommend adding it to your app's scope list because we will eventually make it mandatory.
   */
  async getPrecomputationsByID<T = Models.JqlFunctionPrecomputationGetByIdResponse>(
    parameters: Parameters.GetPrecomputationsByID,
    callback?: never,
  ): Promise<T>;
  async getPrecomputationsByID<T = Models.JqlFunctionPrecomputationGetByIdResponse>(
    parameters: Parameters.GetPrecomputationsByID,
    callback?: Callback<T>,
  ): Promise<void | T> {
    const config: RequestConfig = {
      url: '/rest/api/2/jql/function/computation/search',
      method: 'POST',
      params: {
        orderBy: parameters.orderBy,
      },
      data: {
        precomputationIDs: parameters.precomputationIDs,
      },
    };

    return this.client.sendRequest(config, callback);
  }
}