@resolution/jira-api-client 0.1.0

package/src/openapi/platform/models/jira-expressions.ts

@@ -0,0 +1,578 @@
+// DO NOT EDIT!
+// This file is generated by "api-typescript-generator".
+// To update this file run "yarn build:openapi".
+import { z, type ZodTypeAny } from "zod";
+
+import type { CommonValidationSchemaStorage } from "../core/common-validation-schema-storage";
+export type CustomContextVariable =
+  | UserContextVariable
+  | IssueContextVariable
+  | JsonContextVariable;
+/**
+ * The project that is available under the `project` variable when evaluating the
+ * expression.
+ */
+export interface IdOrKeyBean {
+  /** The ID of the referenced item. */
+  id?: number;
+  /** The key of the referenced item. */
+  key?: string;
+}
+/**
+ * An
+ * [issue](https://developer.atlassian.com/cloud/jira/platform/jira-expressions-type-reference#issue)
+ * specified by ID or key. All the fields of the issue object are available in the
+ * Jira expression.
+ */
+export interface IssueContextVariable {
+  /** Type of custom context variable. */
+  type: string;
+  /** The issue ID. */
+  id?: number;
+  /** The issue key. */
+  key?: string;
+}
+/** The description of the page of issues loaded by the provided JQL query. */
+export interface IssuesJqlMetaDataBean {
+  /** The number of issues that were loaded in this evaluation. */
+  count: number;
+  /** The maximum number of issues that could be loaded in this evaluation. */
+  maxResults: number;
+  /** The index of the first issue. */
+  startAt: number;
+  /** The total number of issues the JQL returned. */
+  totalCount: number;
+  /**
+   * Any warnings related to the JQL query. Present only if the validation mode was
+   * set to `warn`.
+   */
+  validationWarnings?: string[];
+}
+/** Meta data describing the `issues` context variable. */
+export interface IssuesMetaBean {
+  /** The description of the page of issues loaded by the provided JQL query. */
+  jql?: IssuesJqlMetaDataBean;
+}
+/**
+ * The JQL specifying the issues available in the evaluated Jira expression under
+ * the `issues` context variable.
+ */
+export interface JexpIssues {
+  /** The JQL query that specifies the set of issues available in the Jira expression. */
+  jql?: JexpJqlIssues;
+}
+/**
+ * The JQL specifying the issues available in the evaluated Jira expression under
+ * the `issues` context variable. Not all issues returned by the JQL query are
+ * loaded, only those described by the `startAt` and `maxResults` properties. To
+ * determine whether it is necessary to iterate to ensure all the issues returned
+ * by the JQL query are evaluated, inspect `meta.issues.jql.count` in the response.
+ */
+export interface JexpJqlIssues {
+  /**
+   * The maximum number of issues to return from the JQL query. Inspect
+   * `meta.issues.jql.maxResults` in the response to ensure the maximum value has
+   * not been exceeded.
+   */
+  maxResults?: number;
+  /** The JQL query. */
+  query?: string;
+  /** The index of the first issue to return from the JQL query. */
+  startAt?: number;
+  /** Determines how to validate the JQL query and treat the validation results. */
+  validation?: "strict" | "warn" | "none";
+}
+/** Details about the analysed Jira expression. */
+export interface JiraExpressionAnalysis {
+  /** Details about the complexity of the analysed Jira expression. */
+  complexity?: JiraExpressionComplexity;
+  /** A list of validation errors. Not included if the expression is valid. */
+  errors?: JiraExpressionValidationError[];
+  /** The analysed expression. */
+  expression: string;
+  /** EXPERIMENTAL. The inferred type of the expression. */
+  type?: string;
+  /**
+   * Whether the expression is valid and the interpreter will evaluate it. Note that
+   * the expression may fail at runtime (for example, if it executes too many
+   * expensive operations).
+   */
+  valid: boolean;
+}
+/** Details about the complexity of the analysed Jira expression. */
+export interface JiraExpressionComplexity {
+  /**
+   * Information that can be used to determine how many [expensive
+   * operations](https://developer.atlassian.com/cloud/jira/platform/jira-expressions/#expensive-operations)
+   * the evaluation of the expression will perform. This information may be a
+   * formula or number. For example:
+   *
+   *  *  `issues.map(i => i.comments)` performs as many expensive operations as
+   * there are issues on the issues list. So this parameter returns `N`, where `N`
+   * is the size of issue list.
+   *  *  `new Issue(10010).comments` gets comments for one issue, so its complexity
+   * is `2` (`1` to retrieve issue 10010 from the database plus `1` to get its
+   * comments).
+   */
+  expensiveOperations: string;
+  /**
+   * Variables used in the formula, mapped to the parts of the expression they refer
+   * to.
+   */
+  variables?: {
+    /**
+     * Variables used in the formula, mapped to the parts of the expression they refer
+     * to.
+     */
+    [key: string]: string;
+  };
+}
+/** The context in which the Jira expression is evaluated. */
+export interface JiraExpressionEvalContextBean {
+  /**
+   * The ID of the board that is available under the `board` variable when
+   * evaluating the expression.
+   */
+  board?: number;
+  /**
+   * Custom context variables and their types. These variable types are available
+   * for use in a custom context:
+   *
+   *  *  `user`: A
+   * [user](https://developer.atlassian.com/cloud/jira/platform/jira-expressions-type-reference#user)
+   * specified as an Atlassian account ID.
+   *  *  `issue`: An
+   * [issue](https://developer.atlassian.com/cloud/jira/platform/jira-expressions-type-reference#issue)
+   * specified by ID or key. All the fields of the issue object are available in the
+   * Jira expression.
+   *  *  `json`: A JSON object containing custom content.
+   *  *  `list`: A JSON list of `user`, `issue`, or `json` variable types.
+   */
+  custom?: CustomContextVariable[];
+  /**
+   * The ID of the customer request that is available under the `customerRequest`
+   * variable when evaluating the expression. This is the same as the ID of the
+   * underlying Jira issue, but the customer request context variable will have a
+   * different type.
+   */
+  customerRequest?: number;
+  /**
+   * The issue that is available under the `issue` variable when evaluating the
+   * expression.
+   */
+  issue?: IdOrKeyBean;
+  /**
+   * The collection of issues that is available under the `issues` variable when
+   * evaluating the expression.
+   */
+  issues?: JexpIssues;
+  /**
+   * The project that is available under the `project` variable when evaluating the
+   * expression.
+   */
+  project?: IdOrKeyBean;
+  /**
+   * The ID of the service desk that is available under the `serviceDesk` variable
+   * when evaluating the expression.
+   */
+  serviceDesk?: number;
+  /**
+   * The ID of the sprint that is available under the `sprint` variable when
+   * evaluating the expression.
+   */
+  sprint?: number;
+}
+export interface JiraExpressionEvalRequestBean {
+  /** The context in which the Jira expression is evaluated. */
+  context?: JiraExpressionEvalContextBean;
+  /**
+   * The Jira expression to evaluate.
+   *
+   * @example { key: issue.key, type: issue.issueType.name, links: issue.links.map(link =>
+   * link.linkedIssue.id) }
+   */
+  expression: string;
+}
+/** Contains various characteristics of the performed expression evaluation. */
+export interface JiraExpressionEvaluationMetaDataBean {
+  /**
+   * Contains information about the expression complexity. For example, the number
+   * of steps it took to evaluate the expression.
+   */
+  complexity?: JiraExpressionsComplexityBean;
+  /**
+   * Contains information about the `issues` variable in the context. For example,
+   * is the issues were loaded with JQL, information about the page will be included
+   * here.
+   */
+  issues?: IssuesMetaBean;
+}
+/** Details of Jira expressions for analysis. */
+export interface JiraExpressionForAnalysis {
+  /**
+   * Context variables and their types. The type checker assumes that [common
+   * context
+   * variables](https://developer.atlassian.com/cloud/jira/platform/jira-expressions/#context-variables),
+   * such as `issue` or `project`, are available in context and sets their type. Use
+   * this property to override the default types or provide details of new variables.
+   */
+  contextVariables?: {
+    /**
+     * Context variables and their types. The type checker assumes that
+     * https://developer.atlassian.com/cloud/jira/platform/jira-expressions/#context-variables
+     * common context variables, such as <code>issue</code> or <code>project</code>,
+     * are available in context and sets their type. Use this property to override the
+     * default types or provide details of new variables.
+     */
+    [key: string]: string;
+  };
+  /**
+   * The list of Jira expressions to analyse.
+   *
+   * @example issues.map(issue => issue.properties['property_key'])
+   */
+  expressions: string[];
+}
+/** The result of evaluating a Jira expression. */
+export interface JiraExpressionResult {
+  /** Contains various characteristics of the performed expression evaluation. */
+  meta?: JiraExpressionEvaluationMetaDataBean;
+  /**
+   * The value of the evaluated expression. It may be a primitive JSON value or a
+   * Jira REST API object. (Some expressions do not produce any meaningful
+   * results—for example, an expression that returns a lambda function—if that's the
+   * case a simple string representation is returned. These string representations
+   * should not be relied upon and may change without notice.)
+   */
+  value: unknown;
+}
+/** Details about the analysed Jira expression. */
+export interface JiraExpressionsAnalysis {
+  /** The results of Jira expressions analysis. */
+  results: JiraExpressionAnalysis[];
+}
+/**
+ * Contains information about the expression complexity. For example, the number
+ * of steps it took to evaluate the expression.
+ */
+export interface JiraExpressionsComplexityBean {
+  /** The number of Jira REST API beans returned in the response. */
+  beans: JiraExpressionsComplexityValueBean;
+  /**
+   * The number of expensive operations executed while evaluating the expression.
+   * Expensive operations are those that load additional data, such as entity
+   * properties, comments, or custom fields.
+   */
+  expensiveOperations: JiraExpressionsComplexityValueBean;
+  /** The number of primitive values returned in the response. */
+  primitiveValues: JiraExpressionsComplexityValueBean;
+  /**
+   * The number of steps it took to evaluate the expression, where a step is a
+   * high-level operation performed by the expression. A step is an operation such
+   * as arithmetic, accessing a property, accessing a context variable, or calling a
+   * function.
+   */
+  steps: JiraExpressionsComplexityValueBean;
+}
+/**
+ * The number of steps it took to evaluate the expression, where a step is a
+ * high-level operation performed by the expression. A step is an operation such
+ * as arithmetic, accessing a property, accessing a context variable, or calling a
+ * function.
+ */
+export interface JiraExpressionsComplexityValueBean {
+  /**
+   * The maximum allowed complexity. The evaluation will fail if this value is
+   * exceeded.
+   */
+  limit: number;
+  /** The complexity value of the current expression. */
+  value: number;
+}
+/**
+ * Details about syntax and type errors. The error details apply to the entire
+ * expression, unless the object includes:
+ *
+ *  *  `line` and `column`
+ *  *  `expression`
+ */
+export interface JiraExpressionValidationError {
+  /** The text column in which the error occurred. */
+  column?: number;
+  /** The part of the expression in which the error occurred. */
+  expression?: string;
+  /** The text line in which the error occurred. */
+  line?: number;
+  /**
+   * Details about the error.
+   *
+   * @example !, -, typeof, (, IDENTIFIER, null, true, false, NUMBER, STRING,
+   * TEMPLATE_LITERAL, new, [ or { expected, > encountered.
+   */
+  message: string;
+  /** The error type. */
+  type: "syntax" | "type" | "other";
+}
+/** A JSON object with custom content. */
+export interface JsonContextVariable {
+  /** Type of custom context variable. */
+  type: string;
+  /** A JSON object containing custom content. */
+  value?: {
+    [key: string]: unknown;
+  };
+}
+/**
+ * A
+ * [user](https://developer.atlassian.com/cloud/jira/platform/jira-expressions-type-reference#user)
+ * specified as an Atlassian account ID.
+ */
+export interface UserContextVariable {
+  /** Type of custom context variable. */
+  type: string;
+  /** The account ID of the user. */
+  accountId: string;
+}
+export function registerJiraExpressionsValidationSchemas(
+  validationSchemaStorage: CommonValidationSchemaStorage<ZodTypeAny>,
+) {
+  validationSchemaStorage.register(
+    "CustomContextVariable",
+    z
+      .union([
+        validationSchemaStorage.lazy("UserContextVariable"),
+        validationSchemaStorage.lazy("IssueContextVariable"),
+        validationSchemaStorage.lazy("JsonContextVariable"),
+      ])
+      .describe("CustomContextVariable"),
+  );
+  validationSchemaStorage.register(
+    "IdOrKeyBean",
+    z
+      .object({
+        id: z.number().int().optional(),
+        key: z.string().optional(),
+      })
+      .strict()
+      .describe("IdOrKeyBean"),
+  );
+  validationSchemaStorage.register(
+    "IssueContextVariable",
+    z
+      .object({
+        type: z.string(),
+        id: z.number().int().optional(),
+        key: z.string().optional(),
+      })
+      .strict()
+      .describe("IssueContextVariable"),
+  );
+  validationSchemaStorage.register(
+    "IssuesJqlMetaDataBean",
+    z
+      .object({
+        count: z.number().int(),
+        maxResults: z.number().int(),
+        startAt: z.number().int(),
+        totalCount: z.number().int(),
+        validationWarnings: z.array(z.string()).optional(),
+      })
+      .strict()
+      .describe("IssuesJqlMetaDataBean"),
+  );
+  validationSchemaStorage.register(
+    "IssuesMetaBean",
+    z
+      .object({
+        jql: validationSchemaStorage.lazy("IssuesJqlMetaDataBean").optional(),
+      })
+      .strict()
+      .describe("IssuesMetaBean"),
+  );
+  validationSchemaStorage.register(
+    "JexpIssues",
+    z
+      .object({
+        jql: validationSchemaStorage.lazy("JexpJqlIssues").optional(),
+      })
+      .strict()
+      .describe("JexpIssues"),
+  );
+  validationSchemaStorage.register(
+    "JexpJqlIssues",
+    z
+      .object({
+        maxResults: z.number().int().optional(),
+        query: z.string().optional(),
+        startAt: z.number().int().optional(),
+        validation: z.enum(["strict", "warn", "none"]).optional(),
+      })
+      .strict()
+      .describe("JexpJqlIssues"),
+  );
+  validationSchemaStorage.register(
+    "JiraExpressionAnalysis",
+    z
+      .object({
+        complexity: validationSchemaStorage
+          .lazy("JiraExpressionComplexity")
+          .optional(),
+        errors: z
+          .array(validationSchemaStorage.lazy("JiraExpressionValidationError"))
+          .optional(),
+        expression: z.string(),
+        type: z.string().optional(),
+        valid: z.boolean(),
+      })
+      .strict()
+      .describe("JiraExpressionAnalysis"),
+  );
+  validationSchemaStorage.register(
+    "JiraExpressionComplexity",
+    z
+      .object({
+        expensiveOperations: z.string(),
+        variables: z.object({}).catchall(z.string()).optional(),
+      })
+      .strict()
+      .describe("JiraExpressionComplexity"),
+  );
+  validationSchemaStorage.register(
+    "JiraExpressionEvalContextBean",
+    z
+      .object({
+        board: z.number().int().optional(),
+        custom: z
+          .array(validationSchemaStorage.lazy("CustomContextVariable"))
+          .optional(),
+        customerRequest: z.number().int().optional(),
+        issue: validationSchemaStorage.lazy("IdOrKeyBean").optional(),
+        issues: validationSchemaStorage.lazy("JexpIssues").optional(),
+        project: validationSchemaStorage.lazy("IdOrKeyBean").optional(),
+        serviceDesk: z.number().int().optional(),
+        sprint: z.number().int().optional(),
+      })
+      .strict()
+      .describe("JiraExpressionEvalContextBean"),
+  );
+  validationSchemaStorage.register(
+    "JiraExpressionEvalRequestBean",
+    z
+      .object({
+        context: validationSchemaStorage
+          .lazy("JiraExpressionEvalContextBean")
+          .optional(),
+        expression: z.string(),
+      })
+      .strict()
+      .describe("JiraExpressionEvalRequestBean"),
+  );
+  validationSchemaStorage.register(
+    "JiraExpressionEvaluationMetaDataBean",
+    z
+      .object({
+        complexity: validationSchemaStorage
+          .lazy("JiraExpressionsComplexityBean")
+          .optional(),
+        issues: validationSchemaStorage.lazy("IssuesMetaBean").optional(),
+      })
+      .strict()
+      .describe("JiraExpressionEvaluationMetaDataBean"),
+  );
+  validationSchemaStorage.register(
+    "JiraExpressionForAnalysis",
+    z
+      .object({
+        contextVariables: z.object({}).catchall(z.string()).optional(),
+        expressions: z.array(z.string()),
+      })
+      .strict()
+      .describe("JiraExpressionForAnalysis"),
+  );
+  validationSchemaStorage.register(
+    "JiraExpressionResult",
+    z
+      .object({
+        meta: validationSchemaStorage
+          .lazy("JiraExpressionEvaluationMetaDataBean")
+          .optional(),
+        value: z.unknown(),
+      })
+      .strict()
+      .describe("JiraExpressionResult"),
+  );
+  validationSchemaStorage.register(
+    "JiraExpressionsAnalysis",
+    z
+      .object({
+        results: z.array(
+          validationSchemaStorage.lazy("JiraExpressionAnalysis"),
+        ),
+      })
+      .strict()
+      .describe("JiraExpressionsAnalysis"),
+  );
+  validationSchemaStorage.register(
+    "JiraExpressionsComplexityBean",
+    z
+      .object({
+        beans: validationSchemaStorage.lazy(
+          "JiraExpressionsComplexityValueBean",
+        ),
+        expensiveOperations: validationSchemaStorage.lazy(
+          "JiraExpressionsComplexityValueBean",
+        ),
+        primitiveValues: validationSchemaStorage.lazy(
+          "JiraExpressionsComplexityValueBean",
+        ),
+        steps: validationSchemaStorage.lazy(
+          "JiraExpressionsComplexityValueBean",
+        ),
+      })
+      .strict()
+      .describe("JiraExpressionsComplexityBean"),
+  );
+  validationSchemaStorage.register(
+    "JiraExpressionsComplexityValueBean",
+    z
+      .object({
+        limit: z.number().int(),
+        value: z.number().int(),
+      })
+      .strict()
+      .describe("JiraExpressionsComplexityValueBean"),
+  );
+  validationSchemaStorage.register(
+    "JiraExpressionValidationError",
+    z
+      .object({
+        column: z.number().int().optional(),
+        expression: z.string().optional(),
+        line: z.number().int().optional(),
+        message: z.string(),
+        type: z.enum(["syntax", "type", "other"]),
+      })
+      .strict()
+      .describe("JiraExpressionValidationError"),
+  );
+  validationSchemaStorage.register(
+    "JsonContextVariable",
+    z
+      .object({
+        type: z.string(),
+        value: z.object({}).catchall(z.unknown()).optional(),
+      })
+      .strict()
+      .describe("JsonContextVariable"),
+  );
+  validationSchemaStorage.register(
+    "UserContextVariable",
+    z
+      .object({
+        type: z.string(),
+        accountId: z.string(),
+      })
+      .strict()
+      .describe("UserContextVariable"),
+  );
+}

package/src/openapi/platform/models/jira-settings.ts

@@ -0,0 +1,118 @@
+// DO NOT EDIT!
+// This file is generated by "api-typescript-generator".
+// To update this file run "yarn build:openapi".
+import { z, type ZodTypeAny } from "zod";
+
+import type { CommonValidationSchemaStorage } from "../core/common-validation-schema-storage";
+import {
+  registerCommonValidationSchemas,
+  type TimeTrackingConfiguration,
+} from "./common";
+/** Details of an application property. */
+export interface ApplicationProperty {
+  /** The allowed values, if applicable. */
+  allowedValues?: string[];
+  /** The default value of the application property. */
+  defaultValue?: string;
+  /** The description of the application property. */
+  desc?: string;
+  example?: string;
+  /** The ID of the application property. The ID and key are the same. */
+  id?: string;
+  /** The key of the application property. The ID and key are the same. */
+  key?: string;
+  /** The name of the application property. */
+  name?: string;
+  /** The data type of the application property. */
+  type?: string;
+  /** The new value. */
+  value?: string;
+}
+/** Details about the configuration of Jira. */
+export interface Configuration {
+  /** Whether the ability to add attachments to issues is enabled. */
+  attachmentsEnabled?: boolean;
+  /** Whether the ability to link issues is enabled. */
+  issueLinkingEnabled?: boolean;
+  /** Whether the ability to create subtasks for issues is enabled. */
+  subTasksEnabled?: boolean;
+  /** The configuration of time tracking. */
+  timeTrackingConfiguration?: TimeTrackingConfiguration;
+  /**
+   * Whether the ability to track time is enabled. This property is deprecated.
+   *
+   * @deprecated
+   */
+  timeTrackingEnabled?: boolean;
+  /**
+   * Whether the ability to create unassigned issues is enabled. See [Configuring
+   * Jira application options](https://confluence.atlassian.com/x/uYXKM) for details.
+   */
+  unassignedIssuesAllowed?: boolean;
+  /**
+   * Whether the ability for users to vote on issues is enabled. See [Configuring
+   * Jira application options](https://confluence.atlassian.com/x/uYXKM) for details.
+   */
+  votingEnabled?: boolean;
+  /**
+   * Whether the ability for users to watch issues is enabled. See [Configuring Jira
+   * application options](https://confluence.atlassian.com/x/uYXKM) for details.
+   */
+  watchingEnabled?: boolean;
+}
+export interface SimpleApplicationPropertyBean {
+  /** The ID of the application property. */
+  id?: string;
+  /** The new value. */
+  value?: string;
+}
+export function registerJiraSettingsValidationSchemas(
+  validationSchemaStorage: CommonValidationSchemaStorage<ZodTypeAny>,
+) {
+  validationSchemaStorage.register(
+    "ApplicationProperty",
+    z
+      .object({
+        allowedValues: z.array(z.string()).optional(),
+        defaultValue: z.string().optional(),
+        desc: z.string().optional(),
+        example: z.string().optional(),
+        id: z.string().optional(),
+        key: z.string().optional(),
+        name: z.string().optional(),
+        type: z.string().optional(),
+        value: z.string().optional(),
+      })
+      .strict()
+      .describe("ApplicationProperty"),
+  );
+  validationSchemaStorage.register(
+    "Configuration",
+    z
+      .object({
+        attachmentsEnabled: z.boolean().optional(),
+        issueLinkingEnabled: z.boolean().optional(),
+        subTasksEnabled: z.boolean().optional(),
+        timeTrackingConfiguration: validationSchemaStorage
+          .lazy("TimeTrackingConfiguration")
+          .optional(),
+        timeTrackingEnabled: z.boolean().optional(),
+        unassignedIssuesAllowed: z.boolean().optional(),
+        votingEnabled: z.boolean().optional(),
+        watchingEnabled: z.boolean().optional(),
+      })
+      .strict()
+      .describe("Configuration"),
+  );
+  validationSchemaStorage.register(
+    "SimpleApplicationPropertyBean",
+    z
+      .object({
+        id: z.string().optional(),
+        value: z.string().optional(),
+      })
+      .strict()
+      .describe("SimpleApplicationPropertyBean"),
+  );
+  validationSchemaStorage.registerOnce([registerCommonValidationSchemas]);
+}