@resolution/jira-api-client 0.1.0 → 0.1.2

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

@@ -1,651 +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 BulkCustomFieldOptionCreateRequest,
-  type BulkCustomFieldOptionUpdateRequest,
-  type CustomFieldCreatedContextOptionsList,
-  type CustomFieldOption,
-  type CustomFieldUpdatedContextOptionsList,
-  type OrderOfCustomFieldOptions,
-  type PageBeanCustomFieldContextOption,
-  registerIssueCustomFieldOptionsValidationSchemas,
-} from "../models/issue-custom-field-options";
-import { validationSchemaStorage } from "../validation-schema-storage";
-/**
- * This resource represents custom issue field select list options created in Jira
- * or using the REST API. This resource supports the following field types:
- *
- *  *  Checkboxes.
- *  *  Radio Buttons.
- *  *  Select List (single choice).
- *  *  Select List (multiple choices).
- *  *  Select List (cascading).
- *
- * See [Issue custom field options
- * (apps)](#api-group-Issue-custom-field-options--apps-) to manipulate custom
- * issue field select list options created by a Connect app.
- *
- * Use it to retrieve, create, update, order, and delete custom field options.
- */
-export class IssueCustomFieldOptionsService extends CommonHttpService {
-  /**
-   * Creates options and, where the custom select field is of the type Select List
-   * (cascading), cascading options for a custom select field. The options are added
-   * to a context of the field.
-   *
-   * The maximum number of options that can be created per request is 1000 and each
-   * field can have a maximum of 10000 options.
-   *
-   * This operation works for custom field options created in Jira or the operations
-   * from this resource. **To work with issue field select list options created for
-   * Connect apps use the [Issue custom field options
-   * (apps)](#api-group-issue-custom-field-options--apps-) operations.**
-   *
-   * **[Permissions](#permissions) required:** *Administer Jira* [global
-   * permission](https://confluence.atlassian.com/x/x4dKLg).
-   *
-   * @returns Returned if the request is successful.
-   *
-   * example: {
-   *   "options": [
-   *     {
-   *       "disabled": false,
-   *       "id": "10001",
-   *       "value": "Scranton"
-   *     },
-   *     {
-   *       "disabled": true,
-   *       "id": "10002",
-   *       "optionId": "10000",
-   *       "value": "Manhattan"
-   *     },
-   *     {
-   *       "disabled": false,
-   *       "id": "10003",
-   *       "value": "The Electric City"
-   *     }
-   *   ]
-   * }
-   * @path {POST} /rest/api/3/field/{fieldId}/context/{contextId}/option
-   * @scopes-current manage:jira-configuration
-   * @scopes-beta read:field.option:jira, write:field.option:jira
-   */
-  createCustomFieldOption({
-    fieldId,
-    contextId,
-    bulkCustomFieldOptionCreateRequest,
-  }: {
-    /** The ID of the custom field. */
-    fieldId: string;
-    /** The ID of the context. */
-    contextId: number;
-    /**
-     * @example {
-     *     "options": [
-     *         {
-     *             "disabled": false,
-     *             "value": "Scranton"
-     *         },
-     *         {
-     *             "disabled": true,
-     *             "optionId": "10000",
-     *             "value": "Manhattan"
-     *         },
-     *         {
-     *             "disabled": false,
-     *             "value": "The Electric City"
-     *         }
-     *     ]
-     * }
-     */
-    bulkCustomFieldOptionCreateRequest: BulkCustomFieldOptionCreateRequest;
-  }): Promise<CustomFieldCreatedContextOptionsList> {
-    return this.getClientInstance()
-      .request({
-        path: "/rest/api/3/field/{fieldId}/context/{contextId}/option",
-        method: "POST",
-        pathParams: {
-          fieldId,
-          contextId,
-        },
-        headers: {
-          "Content-Type": "application/json",
-        },
-        body: bulkCustomFieldOptionCreateRequest,
-      })
-      .then(
-        this.getClientInstance().responseHandler({
-          200: {
-            "application/json": "json",
-          },
-        }),
-      )
-      .then(
-        commonHttpClient.castResponse<{
-          status: 200;
-          mediaType: "application/json";
-          body: CustomFieldCreatedContextOptionsList;
-        }>(),
-      )
-      .then(
-        validationSchemaStorage.validator(
-          "IssueCustomFieldOptionsService.createCustomFieldOption.response",
-        ),
-      )
-      .then(commonHttpClient.getBody);
-  }
-  /**
-   * Deletes a custom field option.
-   *
-   * Options with cascading options cannot be deleted without deleting the cascading
-   * options first.
-   *
-   * This operation works for custom field options created in Jira or the operations
-   * from this resource. **To work with issue field select list options created for
-   * Connect apps use the [Issue custom field options
-   * (apps)](#api-group-issue-custom-field-options--apps-) operations.**
-   *
-   * **[Permissions](#permissions) required:** *Administer Jira* [global
-   * permission](https://confluence.atlassian.com/x/x4dKLg).
-   *
-   * @path {DELETE} /rest/api/3/field/{fieldId}/context/{contextId}/option/{optionId}
-   * @scopes-current manage:jira-configuration
-   * @scopes-beta delete:field.option:jira
-   */
-  deleteCustomFieldOption({
-    fieldId,
-    contextId,
-    optionId,
-  }: {
-    /** The ID of the custom field. */
-    fieldId: string;
-    /** The ID of the context from which an option should be deleted. */
-    contextId: number;
-    /** The ID of the option to delete. */
-    optionId: number;
-  }): Promise<void> {
-    return this.getClientInstance()
-      .request({
-        path: "/rest/api/3/field/{fieldId}/context/{contextId}/option/{optionId}",
-        method: "DELETE",
-        pathParams: {
-          fieldId,
-          contextId,
-          optionId,
-        },
-      })
-      .then(commonHttpClient.discardResult);
-  }
-  /**
-   * Returns a custom field option. For example, an option in a select list.
-   *
-   * Note that this operation **only works for issue field select list options
-   * created in Jira or using operations from the [Issue custom field
-   * options](#api-group-Issue-custom-field-options) resource**, it cannot be used
-   * with issue field select list options created by Connect apps.
-   *
-   * This operation can be accessed anonymously.
-   *
-   * **[Permissions](#permissions) required:** The custom field option is returned
-   * as follows:
-   *
-   *  *  if the user has the *Administer Jira* [global
-   * permission](https://confluence.atlassian.com/x/x4dKLg).
-   *  *  if the user has the *Browse projects* [project
-   * permission](https://confluence.atlassian.com/x/yodKLg) for at least one project
-   * the custom field is used in, and the field is visible in at least one layout
-   * the user has permission to view.
-   *
-   * @returns Returned if the request is successful.
-   *
-   * example: {
-   *   "self":
-   * "https://your-domain.atlassian.net/rest/api/3/customFieldOption/10000",
-   *   "value": "To Do"
-   * }
-   * @path {GET} /rest/api/3/customFieldOption/{id}
-   * @scopes-current read:jira-work
-   * @scopes-beta read:field:jira, read:field.option:jira
-   */
-  getCustomFieldOption({
-    id,
-  }: {
-    /** The ID of the custom field option. */
-    id: string;
-  }): Promise<CustomFieldOption> {
-    return this.getClientInstance()
-      .request({
-        path: "/rest/api/3/customFieldOption/{id}",
-        method: "GET",
-        pathParams: {
-          id,
-        },
-      })
-      .then(
-        this.getClientInstance().responseHandler({
-          200: {
-            "application/json": "json",
-          },
-        }),
-      )
-      .then(
-        commonHttpClient.castResponse<{
-          status: 200;
-          mediaType: "application/json";
-          body: CustomFieldOption;
-        }>(),
-      )
-      .then(
-        validationSchemaStorage.validator(
-          "IssueCustomFieldOptionsService.getCustomFieldOption.response",
-        ),
-      )
-      .then(commonHttpClient.getBody);
-  }
-  /**
-   * Returns a [paginated](#pagination) list of all custom field option for a
-   * context. Options are returned first then cascading options, in the order they
-   * display in Jira.
-   *
-   * This operation works for custom field options created in Jira or the operations
-   * from this resource. **To work with issue field select list options created for
-   * Connect apps use the [Issue custom field options
-   * (apps)](#api-group-issue-custom-field-options--apps-) operations.**
-   *
-   * **[Permissions](#permissions) required:** *Administer Jira* [global
-   * permission](https://confluence.atlassian.com/x/x4dKLg).
-   *
-   * @returns Returned if the request is successful.
-   *
-   * example: {
-   *   "isLast": true,
-   *   "maxResults": 100,
-   *   "startAt": 0,
-   *   "total": 4,
-   *   "values": [
-   *     {
-   *       "id": "10001",
-   *       "value": "New York"
-   *     },
-   *     {
-   *       "id": "10002",
-   *       "value": "Boston",
-   *       "disabled": true
-   *     },
-   *     {
-   *       "id": "10004",
-   *       "value": "Denver"
-   *     },
-   *     {
-   *       "id": "10003",
-   *       "value": "Brooklyn",
-   *       "optionId": "10001"
-   *     }
-   *   ]
-   * }
-   * @path {GET} /rest/api/3/field/{fieldId}/context/{contextId}/option
-   * @scopes-current manage:jira-configuration
-   * @scopes-beta read:field.option:jira
-   */
-  getOptionsForContext({
-    fieldId,
-    contextId,
-    optionId,
-    onlyOptions,
-    startAt,
-    maxResults,
-  }: {
-    /** The ID of the custom field. */
-    fieldId: string;
-    /** The ID of the context. */
-    contextId: number;
-    /** The ID of the option. */
-    optionId?: number;
-    /** Whether only options are returned. */
-    onlyOptions?: boolean;
-    /** 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;
-  }): Promise<PageBeanCustomFieldContextOption> {
-    return this.getClientInstance()
-      .request({
-        path: "/rest/api/3/field/{fieldId}/context/{contextId}/option",
-        method: "GET",
-        pathParams: {
-          fieldId,
-          contextId,
-        },
-        query: {
-          optionId,
-          onlyOptions,
-          startAt,
-          maxResults,
-        },
-      })
-      .then(
-        this.getClientInstance().responseHandler({
-          200: {
-            "application/json": "json",
-          },
-        }),
-      )
-      .then(
-        commonHttpClient.castResponse<{
-          status: 200;
-          mediaType: "application/json";
-          body: PageBeanCustomFieldContextOption;
-        }>(),
-      )
-      .then(
-        validationSchemaStorage.validator(
-          "IssueCustomFieldOptionsService.getOptionsForContext.response",
-        ),
-      )
-      .then(commonHttpClient.getBody);
-  }
-  /**
-   * Changes the order of custom field options or cascading options in a context.
-   *
-   * This operation works for custom field options created in Jira or the operations
-   * from this resource. **To work with issue field select list options created for
-   * Connect apps use the [Issue custom field options
-   * (apps)](#api-group-issue-custom-field-options--apps-) operations.**
-   *
-   * **[Permissions](#permissions) required:** *Administer Jira* [global
-   * permission](https://confluence.atlassian.com/x/x4dKLg).
-   *
-   * @returns Returned if options are reordered.
-   * @path {PUT} /rest/api/3/field/{fieldId}/context/{contextId}/option/move
-   * @scopes-current manage:jira-configuration
-   * @scopes-beta write:field.option:jira
-   */
-  reorderCustomFieldOptions({
-    fieldId,
-    contextId,
-    orderOfCustomFieldOptions,
-  }: {
-    /** The ID of the custom field. */
-    fieldId: string;
-    /** The ID of the context. */
-    contextId: number;
-    /**
-     * @example {
-     *     "customFieldOptionIds": [
-     *         "10001",
-     *         "10002"
-     *     ],
-     *     "position": "First"
-     * }
-     */
-    orderOfCustomFieldOptions: OrderOfCustomFieldOptions;
-  }): Promise<void> {
-    return this.getClientInstance()
-      .request({
-        path: "/rest/api/3/field/{fieldId}/context/{contextId}/option/move",
-        method: "PUT",
-        pathParams: {
-          fieldId,
-          contextId,
-        },
-        headers: {
-          "Content-Type": "application/json",
-        },
-        body: orderOfCustomFieldOptions,
-      })
-      .then(
-        this.getClientInstance().responseHandler({
-          204: {
-            "application/json": "json",
-          },
-        }),
-      )
-      .then(
-        commonHttpClient.castResponse<{
-          status: 204;
-          mediaType: "application/json";
-          body: void;
-        }>(),
-      )
-      .then(
-        validationSchemaStorage.validator(
-          "IssueCustomFieldOptionsService.reorderCustomFieldOptions.response",
-        ),
-      )
-      .then(commonHttpClient.getBody);
-  }
-  /**
-   * Replaces the options of a custom field.
-   *
-   * Note that this operation **only works for issue field select list options
-   * created in Jira or using operations from the [Issue custom field
-   * options](#api-group-Issue-custom-field-options) resource**, it cannot be used
-   * with issue field select list options created by Connect or Forge apps.
-   *
-   * **[Permissions](#permissions) required:** *Administer Jira* [global
-   * permission](https://confluence.atlassian.com/x/x4dKLg).
-   *
-   * @path {DELETE} /rest/api/3/field/{fieldId}/context/{contextId}/option/{optionId}/issue
-   * @scopes-current manage:jira-configuration
-   * @scopes-beta read:field.option:jira, write:field.option:jira
-   */
-  replaceCustomFieldOption({
-    fieldId,
-    optionId,
-    contextId,
-    replaceWith,
-    jql,
-  }: {
-    /** The ID of the custom field. */
-    fieldId: string;
-    /** The ID of the option to be deselected. */
-    optionId: number;
-    /** The ID of the context. */
-    contextId: number;
-    /** The ID of the option that will replace the currently selected option. */
-    replaceWith?: number;
-    /**
-     * A JQL query that specifies the issues to be updated. For example,
-     * *project=10000*.
-     */
-    jql?: string;
-  }): Promise<void> {
-    return this.getClientInstance()
-      .request({
-        path: "/rest/api/3/field/{fieldId}/context/{contextId}/option/{optionId}/issue",
-        method: "DELETE",
-        pathParams: {
-          fieldId,
-          optionId,
-          contextId,
-        },
-        query: {
-          replaceWith,
-          jql,
-        },
-      })
-      .then(commonHttpClient.discardResult);
-  }
-  /**
-   * Updates the options of a custom field.
-   *
-   * If any of the options are not found, no options are updated. Options where the
-   * values in the request match the current values aren't updated and aren't
-   * reported in the response.
-   *
-   * Note that this operation **only works for issue field select list options
-   * created in Jira or using operations from the [Issue custom field
-   * options](#api-group-Issue-custom-field-options) resource**, it cannot be used
-   * with issue field select list options created by Connect apps.
-   *
-   * **[Permissions](#permissions) required:** *Administer Jira* [global
-   * permission](https://confluence.atlassian.com/x/x4dKLg).
-   *
-   * @returns Returned if the request is successful.
-   *
-   * example: {
-   *   "options": [
-   *     {
-   *       "disabled": false,
-   *       "id": "10001",
-   *       "value": "Scranton"
-   *     },
-   *     {
-   *       "disabled": true,
-   *       "id": "10002",
-   *       "value": "Manhattan"
-   *     },
-   *     {
-   *       "disabled": false,
-   *       "id": "10003",
-   *       "value": "The Electric City"
-   *     }
-   *   ]
-   * }
-   * @path {PUT} /rest/api/3/field/{fieldId}/context/{contextId}/option
-   * @scopes-current manage:jira-configuration
-   * @scopes-beta read:field.option:jira, write:field.option:jira
-   */
-  updateCustomFieldOption({
-    fieldId,
-    contextId,
-    bulkCustomFieldOptionUpdateRequest,
-  }: {
-    /** The ID of the custom field. */
-    fieldId: string;
-    /** The ID of the context. */
-    contextId: number;
-    /**
-     * @example {
-     *     "options": [
-     *         {
-     *             "disabled": false,
-     *             "id": "10001",
-     *             "value": "Scranton"
-     *         },
-     *         {
-     *             "disabled": true,
-     *             "id": "10002",
-     *             "value": "Manhattan"
-     *         },
-     *         {
-     *             "disabled": false,
-     *             "id": "10003",
-     *             "value": "The Electric City"
-     *         }
-     *     ]
-     * }
-     */
-    bulkCustomFieldOptionUpdateRequest: BulkCustomFieldOptionUpdateRequest;
-  }): Promise<CustomFieldUpdatedContextOptionsList> {
-    return this.getClientInstance()
-      .request({
-        path: "/rest/api/3/field/{fieldId}/context/{contextId}/option",
-        method: "PUT",
-        pathParams: {
-          fieldId,
-          contextId,
-        },
-        headers: {
-          "Content-Type": "application/json",
-        },
-        body: bulkCustomFieldOptionUpdateRequest,
-      })
-      .then(
-        this.getClientInstance().responseHandler({
-          200: {
-            "application/json": "json",
-          },
-        }),
-      )
-      .then(
-        commonHttpClient.castResponse<{
-          status: 200;
-          mediaType: "application/json";
-          body: CustomFieldUpdatedContextOptionsList;
-        }>(),
-      )
-      .then(
-        validationSchemaStorage.validator(
-          "IssueCustomFieldOptionsService.updateCustomFieldOption.response",
-        ),
-      )
-      .then(commonHttpClient.getBody);
-  }
-  static initialize() {
-    validationSchemaStorage.registerExtensible(
-      "IssueCustomFieldOptionsService.getCustomFieldOption.response",
-      z
-        .object({
-          status: z.literal(200),
-          mediaType: z.literal("application/json"),
-          body: validationSchemaStorage.lazy("CustomFieldOption"),
-        })
-        .describe(
-          "IssueCustomFieldOptionsService.getCustomFieldOption.response",
-        ),
-    );
-    validationSchemaStorage.registerExtensible(
-      "IssueCustomFieldOptionsService.getOptionsForContext.response",
-      z
-        .object({
-          status: z.literal(200),
-          mediaType: z.literal("application/json"),
-          body: validationSchemaStorage.lazy(
-            "PageBeanCustomFieldContextOption",
-          ),
-        })
-        .describe(
-          "IssueCustomFieldOptionsService.getOptionsForContext.response",
-        ),
-    );
-    validationSchemaStorage.registerExtensible(
-      "IssueCustomFieldOptionsService.updateCustomFieldOption.response",
-      z
-        .object({
-          status: z.literal(200),
-          mediaType: z.literal("application/json"),
-          body: validationSchemaStorage.lazy(
-            "CustomFieldUpdatedContextOptionsList",
-          ),
-        })
-        .describe(
-          "IssueCustomFieldOptionsService.updateCustomFieldOption.response",
-        ),
-    );
-    validationSchemaStorage.registerExtensible(
-      "IssueCustomFieldOptionsService.createCustomFieldOption.response",
-      z
-        .object({
-          status: z.literal(200),
-          mediaType: z.literal("application/json"),
-          body: validationSchemaStorage.lazy(
-            "CustomFieldCreatedContextOptionsList",
-          ),
-        })
-        .describe(
-          "IssueCustomFieldOptionsService.createCustomFieldOption.response",
-        ),
-    );
-    validationSchemaStorage.registerExtensible(
-      "IssueCustomFieldOptionsService.reorderCustomFieldOptions.response",
-      z
-        .object({
-          status: z.literal(204),
-          mediaType: z.literal("application/json"),
-          body: z.unknown(),
-        })
-        .describe(
-          "IssueCustomFieldOptionsService.reorderCustomFieldOptions.response",
-        ),
-    );
-    validationSchemaStorage.registerOnce([
-      registerIssueCustomFieldOptionsValidationSchemas,
-    ]);
-  }
-}