@resolution/jira-api-client 0.1.0

package/src/openapi/platform/models/issue-custom-field-options-apps.ts

@@ -0,0 +1,273 @@
+// 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";
+/**
+ * Defines the behavior of the option within the global context. If this property
+ * is set, even if set to an empty object, then the option is available in all
+ * projects.
+ */
+export interface GlobalScopeBean {
+  /**
+   * Defines the behavior of the option in the global context.If notSelectable is
+   * set, the option cannot be set as the field's value. This is useful for
+   * archiving an option that has previously been selected but shouldn't be used
+   * anymore.If defaultValue is set, the option is selected by default.
+   */
+  attributes?: ("notSelectable" | "defaultValue")[];
+}
+/** Details of the options for a select list issue field. */
+export interface IssueFieldOption {
+  /** Details of the projects the option is available in. */
+  config?: IssueFieldOptionConfiguration;
+  /**
+   * The unique identifier for the option. This is only unique within the select
+   * field's set of options.
+   */
+  id: number;
+  /**
+   * The properties of the object, as arbitrary key-value pairs. These properties
+   * can be searched using JQL, if the extractions (see [Issue Field Option Property
+   * Index](https://developer.atlassian.com/cloud/jira/platform/modules/issue-field-option-property-index/))
+   * are defined in the descriptor for the issue field module.
+   */
+  properties?: {
+    [key: string]: unknown;
+  };
+  /** The option's name, which is displayed in Jira. */
+  value: string;
+}
+/** Details of the projects the option is available in. */
+export interface IssueFieldOptionConfiguration {
+  /**
+   * DEPRECATED
+   *
+   * @deprecated
+   */
+  attributes?: ("notSelectable" | "defaultValue")[];
+  /**
+   * Defines the projects that the option is available in. If the scope is not
+   * defined, then the option is available in all projects.
+   */
+  scope?: IssueFieldOptionScopeBean;
+}
+export interface IssueFieldOptionCreateBean extends Record<string, unknown> {
+  /** Details of the projects the option is available in. */
+  config?: IssueFieldOptionConfiguration;
+  /**
+   * The properties of the option as arbitrary key-value pairs. These properties can
+   * be searched using JQL, if the extractions (see
+   * https://developer.atlassian.com/cloud/jira/platform/modules/issue-field-option-property-index/)
+   * are defined in the descriptor for the issue field module.
+   */
+  properties?: {
+    [key: string]: unknown;
+  };
+  /** The option's name, which is displayed in Jira. */
+  value: string;
+}
+/**
+ * Defines the projects that the option is available in. If the scope is not
+ * defined, then the option is available in all projects.
+ */
+export interface IssueFieldOptionScopeBean {
+  /**
+   * Defines the behavior of the option within the global context. If this property
+   * is set, even if set to an empty object, then the option is available in all
+   * projects.
+   */
+  global?: GlobalScopeBean;
+  /**
+   * DEPRECATED
+   *
+   * @deprecated
+   */
+  projects?: number[];
+  /**
+   * Defines the projects in which the option is available and the behavior of the
+   * option within each project. Specify one object per project. The behavior of the
+   * option in a project context overrides the behavior in the global context.
+   */
+  projects2?: ProjectScopeBean[];
+}
+/** A page of items. */
+export interface PageBeanIssueFieldOption {
+  /** Whether this is the last page. */
+  isLast?: boolean;
+  /** The maximum number of items that could be returned. */
+  maxResults?: number;
+  /** If there is another page of results, the URL of the next page. */
+  nextPage?: string;
+  /** The URL of the page. */
+  self?: string;
+  /** The index of the first item returned. */
+  startAt?: number;
+  /** The number of items returned. */
+  total?: number;
+  /** The list of items. */
+  values?: IssueFieldOption[];
+}
+export interface ProjectScopeBean {
+  /**
+   * Defines the behavior of the option in the project.If notSelectable is set, the
+   * option cannot be set as the field's value. This is useful for archiving an
+   * option that has previously been selected but shouldn't be used anymore.If
+   * defaultValue is set, the option is selected by default.
+   */
+  attributes?: ("notSelectable" | "defaultValue")[];
+  /** The ID of the project that the option's behavior applies to. */
+  id?: number;
+}
+export function registerIssueCustomFieldOptionsAppsValidationSchemas(
+  validationSchemaStorage: CommonValidationSchemaStorage<ZodTypeAny>,
+) {
+  validationSchemaStorage.register(
+    "GlobalScopeBean",
+    z
+      .object({
+        attributes: z
+          .array(z.enum(["notSelectable", "defaultValue"]))
+          .superRefine((items, ctx) => {
+            if (new Set(items).size !== items.length) {
+              ctx.addIssue({
+                code: z.ZodIssueCode.custom,
+                path: [],
+                message: "Array items must be unique",
+              });
+            }
+          })
+          .optional(),
+      })
+      .strict()
+      .describe("GlobalScopeBean"),
+  );
+  validationSchemaStorage.register(
+    "IssueFieldOption",
+    z
+      .object({
+        config: validationSchemaStorage
+          .lazy("IssueFieldOptionConfiguration")
+          .optional(),
+        id: z.number().int(),
+        properties: z.object({}).catchall(z.unknown()).optional(),
+        value: z.string(),
+      })
+      .strict()
+      .describe("IssueFieldOption"),
+  );
+  validationSchemaStorage.register(
+    "IssueFieldOptionConfiguration",
+    z
+      .object({
+        attributes: z
+          .array(z.enum(["notSelectable", "defaultValue"]))
+          .superRefine((items, ctx) => {
+            if (new Set(items).size !== items.length) {
+              ctx.addIssue({
+                code: z.ZodIssueCode.custom,
+                path: [],
+                message: "Array items must be unique",
+              });
+            }
+          })
+          .optional(),
+        scope: validationSchemaStorage
+          .lazy("IssueFieldOptionScopeBean")
+          .optional(),
+      })
+      .strict()
+      .describe("IssueFieldOptionConfiguration"),
+  );
+  validationSchemaStorage.register(
+    "IssueFieldOptionCreateBean",
+    z
+      .object({
+        config: validationSchemaStorage
+          .lazy("IssueFieldOptionConfiguration")
+          .optional(),
+        properties: z.object({}).catchall(z.unknown()).optional(),
+        value: z.string(),
+      })
+      .catchall(z.unknown())
+      .describe("IssueFieldOptionCreateBean"),
+  );
+  validationSchemaStorage.register(
+    "IssueFieldOptionScopeBean",
+    z
+      .object({
+        global: validationSchemaStorage.lazy("GlobalScopeBean").optional(),
+        projects: z
+          .array(z.number().int())
+          .superRefine((items, ctx) => {
+            if (
+              new Set(items.map((item) => JSON.stringify(item))).size !==
+              items.length
+            ) {
+              ctx.addIssue({
+                code: z.ZodIssueCode.custom,
+                path: [],
+                message: "Array items must be unique",
+              });
+            }
+          })
+          .optional(),
+        projects2: z
+          .array(validationSchemaStorage.lazy("ProjectScopeBean"))
+          .superRefine((items, ctx) => {
+            if (
+              new Set(items.map((item) => JSON.stringify(item))).size !==
+              items.length
+            ) {
+              ctx.addIssue({
+                code: z.ZodIssueCode.custom,
+                path: [],
+                message: "Array items must be unique",
+              });
+            }
+          })
+          .optional(),
+      })
+      .strict()
+      .describe("IssueFieldOptionScopeBean"),
+  );
+  validationSchemaStorage.register(
+    "PageBeanIssueFieldOption",
+    z
+      .object({
+        isLast: z.boolean().optional(),
+        maxResults: z.number().int().optional(),
+        nextPage: z.string().optional(),
+        self: z.string().optional(),
+        startAt: z.number().int().optional(),
+        total: z.number().int().optional(),
+        values: z
+          .array(validationSchemaStorage.lazy("IssueFieldOption"))
+          .optional(),
+      })
+      .strict()
+      .describe("PageBeanIssueFieldOption"),
+  );
+  validationSchemaStorage.register(
+    "ProjectScopeBean",
+    z
+      .object({
+        attributes: z
+          .array(z.enum(["notSelectable", "defaultValue"]))
+          .superRefine((items, ctx) => {
+            if (new Set(items).size !== items.length) {
+              ctx.addIssue({
+                code: z.ZodIssueCode.custom,
+                path: [],
+                message: "Array items must be unique",
+              });
+            }
+          })
+          .optional(),
+        id: z.number().int().optional(),
+      })
+      .strict()
+      .describe("ProjectScopeBean"),
+  );
+}

package/src/openapi/platform/models/issue-custom-field-options.ts

@@ -0,0 +1,283 @@
+// 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";
+/** Details of the options to create for a custom field. */
+export interface BulkCustomFieldOptionCreateRequest {
+  /** Details of options to create. */
+  options?: CustomFieldOptionCreate[];
+}
+/** Details of the options to update for a custom field. */
+export interface BulkCustomFieldOptionUpdateRequest {
+  /** Details of the options to update. */
+  options?: CustomFieldOptionUpdate[];
+}
+/** Details of the custom field options for a context. */
+export interface CustomFieldContextOption {
+  /** Whether the option is disabled. */
+  disabled: boolean;
+  /** The ID of the custom field option. */
+  id: string;
+  /**
+   * For cascading options, the ID of the custom field option containing the
+   * cascading option.
+   */
+  optionId?: string;
+  /** The value of the custom field option. */
+  value: string;
+}
+/** A list of custom field options for a context. */
+export interface CustomFieldCreatedContextOptionsList {
+  /** The created custom field options. */
+  options?: CustomFieldContextOption[];
+}
+/** Details of a custom option for a field. */
+export interface CustomFieldOption {
+  /** The URL of these custom field option details. */
+  self?: string;
+  /** The value of the custom field option. */
+  value?: string;
+}
+/** Details of a custom field option to create. */
+export interface CustomFieldOptionCreate {
+  /** Whether the option is disabled. */
+  disabled?: boolean;
+  /**
+   * For cascading options, the ID of the custom field object containing the
+   * cascading option.
+   */
+  optionId?: string;
+  /** The value of the custom field option. */
+  value: string;
+}
+/** Details of a custom field option for a context. */
+export interface CustomFieldOptionUpdate {
+  /** Whether the option is disabled. */
+  disabled?: boolean;
+  /** The ID of the custom field option. */
+  id: string;
+  /** The value of the custom field option. */
+  value?: string;
+}
+/** A list of custom field options for a context. */
+export interface CustomFieldUpdatedContextOptionsList {
+  /** The updated custom field options. */
+  options?: CustomFieldOptionUpdate[];
+}
+/**
+ * An ordered list of custom field option IDs and information on where to move
+ * them.
+ */
+export interface OrderOfCustomFieldOptions {
+  /**
+   * The ID of the custom field option or cascading option to place the moved
+   * options after. Required if `position` isn't provided.
+   */
+  after?: string;
+  /**
+   * A list of IDs of custom field options to move. The order of the custom field
+   * option IDs in the list is the order they are given after the move. The list
+   * must contain custom field options or cascading options, but not both.
+   */
+  customFieldOptionIds: string[];
+  /**
+   * The position the custom field options should be moved to. Required if `after`
+   * isn't provided.
+   */
+  position?: "First" | "Last";
+}
+/** A page of items. */
+export interface PageBeanCustomFieldContextOption {
+  /** Whether this is the last page. */
+  isLast?: boolean;
+  /** The maximum number of items that could be returned. */
+  maxResults?: number;
+  /** If there is another page of results, the URL of the next page. */
+  nextPage?: string;
+  /** The URL of the page. */
+  self?: string;
+  /** The index of the first item returned. */
+  startAt?: number;
+  /** The number of items returned. */
+  total?: number;
+  /** The list of items. */
+  values?: CustomFieldContextOption[];
+}
+/** The result of the task execution. */
+export interface RemoveOptionFromIssuesResult {
+  /**
+   * A collection of errors related to unchanged issues. The collection size is
+   * limited, which means not all errors may be returned.
+   */
+  errors?: SimpleErrorCollection;
+  /** The IDs of the modified issues. */
+  modifiedIssues?: number[];
+  /** The IDs of the unchanged issues, those issues where errors prevent modification. */
+  unmodifiedIssues?: number[];
+}
+/**
+ * A collection of errors related to unchanged issues. The collection size is
+ * limited, which means not all errors may be returned.
+ */
+export interface SimpleErrorCollection {
+  /**
+   * The list of error messages produced by this operation. For example, "input
+   * parameter 'key' must be provided"
+   */
+  errorMessages?: string[];
+  /**
+   * The list of errors by parameter returned by the operation. For
+   * example,"projectKey": "Project keys must start with an uppercase letter,
+   * followed by one or more uppercase alphanumeric characters."
+   */
+  errors?: {
+    [key: string]: string;
+  };
+  httpStatusCode?: number;
+}
+export function registerIssueCustomFieldOptionsValidationSchemas(
+  validationSchemaStorage: CommonValidationSchemaStorage<ZodTypeAny>,
+) {
+  validationSchemaStorage.register(
+    "BulkCustomFieldOptionCreateRequest",
+    z
+      .object({
+        options: z
+          .array(validationSchemaStorage.lazy("CustomFieldOptionCreate"))
+          .optional(),
+      })
+      .strict()
+      .describe("BulkCustomFieldOptionCreateRequest"),
+  );
+  validationSchemaStorage.register(
+    "BulkCustomFieldOptionUpdateRequest",
+    z
+      .object({
+        options: z
+          .array(validationSchemaStorage.lazy("CustomFieldOptionUpdate"))
+          .optional(),
+      })
+      .strict()
+      .describe("BulkCustomFieldOptionUpdateRequest"),
+  );
+  validationSchemaStorage.register(
+    "CustomFieldContextOption",
+    z
+      .object({
+        disabled: z.boolean(),
+        id: z.string(),
+        optionId: z.string().optional(),
+        value: z.string(),
+      })
+      .strict()
+      .describe("CustomFieldContextOption"),
+  );
+  validationSchemaStorage.register(
+    "CustomFieldCreatedContextOptionsList",
+    z
+      .object({
+        options: z
+          .array(validationSchemaStorage.lazy("CustomFieldContextOption"))
+          .optional(),
+      })
+      .strict()
+      .describe("CustomFieldCreatedContextOptionsList"),
+  );
+  validationSchemaStorage.register(
+    "CustomFieldOption",
+    z
+      .object({
+        self: z.string().optional(),
+        value: z.string().optional(),
+      })
+      .strict()
+      .describe("CustomFieldOption"),
+  );
+  validationSchemaStorage.register(
+    "CustomFieldOptionCreate",
+    z
+      .object({
+        disabled: z.boolean().optional(),
+        optionId: z.string().optional(),
+        value: z.string(),
+      })
+      .strict()
+      .describe("CustomFieldOptionCreate"),
+  );
+  validationSchemaStorage.register(
+    "CustomFieldOptionUpdate",
+    z
+      .object({
+        disabled: z.boolean().optional(),
+        id: z.string(),
+        value: z.string().optional(),
+      })
+      .strict()
+      .describe("CustomFieldOptionUpdate"),
+  );
+  validationSchemaStorage.register(
+    "CustomFieldUpdatedContextOptionsList",
+    z
+      .object({
+        options: z
+          .array(validationSchemaStorage.lazy("CustomFieldOptionUpdate"))
+          .optional(),
+      })
+      .strict()
+      .describe("CustomFieldUpdatedContextOptionsList"),
+  );
+  validationSchemaStorage.register(
+    "OrderOfCustomFieldOptions",
+    z
+      .object({
+        after: z.string().optional(),
+        customFieldOptionIds: z.array(z.string()),
+        position: z.enum(["First", "Last"]).optional(),
+      })
+      .strict()
+      .describe("OrderOfCustomFieldOptions"),
+  );
+  validationSchemaStorage.register(
+    "PageBeanCustomFieldContextOption",
+    z
+      .object({
+        isLast: z.boolean().optional(),
+        maxResults: z.number().int().optional(),
+        nextPage: z.string().optional(),
+        self: z.string().optional(),
+        startAt: z.number().int().optional(),
+        total: z.number().int().optional(),
+        values: z
+          .array(validationSchemaStorage.lazy("CustomFieldContextOption"))
+          .optional(),
+      })
+      .strict()
+      .describe("PageBeanCustomFieldContextOption"),
+  );
+  validationSchemaStorage.register(
+    "RemoveOptionFromIssuesResult",
+    z
+      .object({
+        errors: validationSchemaStorage
+          .lazy("SimpleErrorCollection")
+          .optional(),
+        modifiedIssues: z.array(z.number().int()).optional(),
+        unmodifiedIssues: z.array(z.number().int()).optional(),
+      })
+      .strict()
+      .describe("RemoveOptionFromIssuesResult"),
+  );
+  validationSchemaStorage.register(
+    "SimpleErrorCollection",
+    z
+      .object({
+        errorMessages: z.array(z.string()).optional(),
+        errors: z.object({}).catchall(z.string()).optional(),
+        httpStatusCode: z.number().int().optional(),
+      })
+      .strict()
+      .describe("SimpleErrorCollection"),
+  );
+}

package/src/openapi/platform/models/issue-custom-field-values-apps.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";
+/** A list of issue IDs and the value to update a custom field to. */
+export interface CustomFieldValueUpdate {
+  /** The list of issue IDs. */
+  issueIds: number[];
+  /**
+   * The value for the custom field. The value must be compatible with the [custom
+   * field
+   * type](https://developer.atlassian.com/platform/forge/manifest-reference/modules/jira-custom-field/#data-types)
+   * as follows:
+   *
+   *  *  `string` the value must be a string.
+   *  *  `number` the value must be a number.
+   *  *  `datetime` the value must be a string that represents a date in the ISO
+   * format or the simplified extended ISO format. For example,
+   * `"2023-01-18T12:00:00-03:00"` or `"2023-01-18T12:00:00.000Z"`. However, the
+   * milliseconds part is ignored.
+   *  *  `user` the value must be an object that contains the `accountId` field.
+   *  *  `group` the value must be an object that contains the group `name` or
+   * `groupId` field. Because group names can change, we recommend using `groupId`.
+   *
+   * A list of appropriate values must be provided if the field is of the `list`
+   * [collection
+   * type](https://developer.atlassian.com/platform/forge/manifest-reference/modules/jira-custom-field/#collection-types).
+   */
+  value: unknown;
+}
+/** Details of updates for a custom field. */
+export interface CustomFieldValueUpdateDetails {
+  /** The list of custom field update details. */
+  updates?: CustomFieldValueUpdate[];
+}
+/** A custom field and its new value with a list of issue to update. */
+export interface MultipleCustomFieldValuesUpdate {
+  /** The ID or key of the custom field. For example, `customfield_10010`. */
+  customField: string;
+  /** The list of issue IDs. */
+  issueIds: number[];
+  /**
+   * The value for the custom field. The value must be compatible with the [custom
+   * field
+   * type](https://developer.atlassian.com/platform/forge/manifest-reference/modules/jira-custom-field/#data-types)
+   * as follows:
+   *
+   *  *  `string` the value must be a string.
+   *  *  `number` the value must be a number.
+   *  *  `datetime` the value must be a string that represents a date in the ISO
+   * format or the simplified extended ISO format. For example,
+   * `"2023-01-18T12:00:00-03:00"` or `"2023-01-18T12:00:00.000Z"`. However, the
+   * milliseconds part is ignored.
+   *  *  `user` the value must be an object that contains the `accountId` field.
+   *  *  `group` the value must be an object that contains the group `name` or
+   * `groupId` field. Because group names can change, we recommend using `groupId`.
+   *
+   * A list of appropriate values must be provided if the field is of the `list`
+   * [collection
+   * type](https://developer.atlassian.com/platform/forge/manifest-reference/modules/jira-custom-field/#collection-types).
+   */
+  value: unknown;
+}
+/** List of updates for a custom fields. */
+export interface MultipleCustomFieldValuesUpdateDetails {
+  updates?: MultipleCustomFieldValuesUpdate[];
+}
+export function registerIssueCustomFieldValuesAppsValidationSchemas(
+  validationSchemaStorage: CommonValidationSchemaStorage<ZodTypeAny>,
+) {
+  validationSchemaStorage.register(
+    "CustomFieldValueUpdate",
+    z
+      .object({
+        issueIds: z.array(z.number().int()),
+        value: z.unknown(),
+      })
+      .strict()
+      .describe("CustomFieldValueUpdate"),
+  );
+  validationSchemaStorage.register(
+    "CustomFieldValueUpdateDetails",
+    z
+      .object({
+        updates: z
+          .array(validationSchemaStorage.lazy("CustomFieldValueUpdate"))
+          .optional(),
+      })
+      .strict()
+      .describe("CustomFieldValueUpdateDetails"),
+  );
+  validationSchemaStorage.register(
+    "MultipleCustomFieldValuesUpdate",
+    z
+      .object({
+        customField: z.string(),
+        issueIds: z.array(z.number().int()),
+        value: z.unknown(),
+      })
+      .strict()
+      .describe("MultipleCustomFieldValuesUpdate"),
+  );
+  validationSchemaStorage.register(
+    "MultipleCustomFieldValuesUpdateDetails",
+    z
+      .object({
+        updates: z
+          .array(
+            validationSchemaStorage.lazy("MultipleCustomFieldValuesUpdate"),
+          )
+          .optional(),
+      })
+      .strict()
+      .describe("MultipleCustomFieldValuesUpdateDetails"),
+  );
+}