@resolution/jira-api-client 0.1.0 → 0.1.2

package/src/openapi/platform/services/workflow-transition-properties-service.ts

@@ -1,388 +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 {
-  registerWorkflowTransitionPropertiesValidationSchemas,
-  type WorkflowTransitionProperty,
-} from "../models/workflow-transition-properties";
-import { validationSchemaStorage } from "../validation-schema-storage";
-/**
- * This resource represents workflow transition properties, which provides for
- * storing custom data against a workflow transition. Use it to get, create, and
- * delete workflow transition properties as well as get a list of property keys
- * for a workflow transition. Workflow transition properties are a type of [entity
- * property](https://developer.atlassian.com/cloud/jira/platform/jira-entity-properties/).
- */
-export class WorkflowTransitionPropertiesService extends CommonHttpService {
-  /**
-   * Adds a property to a workflow transition. Transition properties are used to
-   * change the behavior of a transition. For more information, see [Transition
-   * properties](https://confluence.atlassian.com/x/zIhKLg#Advancedworkflowconfiguration-transitionproperties)
-   * and [Workflow properties](https://confluence.atlassian.com/x/JYlKLg).
-   *
-   * **[Permissions](#permissions) required:** *Administer Jira* [global
-   * permission](https://confluence.atlassian.com/x/x4dKLg).
-   *
-   * @returns 200 response
-   *
-   * example: {
-   *   "key": "jira.i18n.title",
-   *   "value": "some.title",
-   *   "id": "jira.i18n.title"
-   * }
-   * @path {POST} /rest/api/3/workflow/transitions/{transitionId}/properties
-   * @scopes-current manage:jira-configuration
-   * @scopes-beta write:workflow.property:jira, read:workflow.property:jira
-   */
-  createWorkflowTransitionProperty({
-    transitionId,
-    key,
-    workflowName,
-    workflowMode,
-    workflowTransitionProperty,
-  }: {
-    /**
-     * The ID of the transition. To get the ID, view the workflow in text mode in the
-     * Jira admin settings. The ID is shown next to the transition.
-     */
-    transitionId: number;
-    /**
-     * The key of the property being added, also known as the name of the property.
-     * Set this to the same value as the `key` defined in the request body.
-     */
-    key: string;
-    /** The name of the workflow that the transition belongs to. */
-    workflowName: string;
-    /**
-     * The workflow status. Set to *live* for inactive workflows or *draft* for draft
-     * workflows. Active workflows cannot be edited.
-     */
-    workflowMode?: "live" | "draft";
-    /**
-     * @example {
-     *     "value": "createissue"
-     * }
-     */
-    workflowTransitionProperty: WorkflowTransitionProperty;
-  }): Promise<WorkflowTransitionProperty> {
-    return this.getClientInstance()
-      .request({
-        path: "/rest/api/3/workflow/transitions/{transitionId}/properties",
-        method: "POST",
-        pathParams: {
-          transitionId,
-        },
-        query: {
-          key,
-          workflowName,
-          workflowMode,
-        },
-        headers: {
-          "Content-Type": "application/json",
-        },
-        body: workflowTransitionProperty,
-      })
-      .then(
-        this.getClientInstance().responseHandler({
-          200: {
-            "application/json": "json",
-          },
-        }),
-      )
-      .then(
-        commonHttpClient.castResponse<{
-          status: 200;
-          mediaType: "application/json";
-          body: WorkflowTransitionProperty;
-        }>(),
-      )
-      .then(
-        validationSchemaStorage.validator(
-          "WorkflowTransitionPropertiesService.createWorkflowTransitionProperty.response",
-        ),
-      )
-      .then(commonHttpClient.getBody);
-  }
-  /**
-   * Deletes a property from a workflow transition. Transition properties are used
-   * to change the behavior of a transition. For more information, see [Transition
-   * properties](https://confluence.atlassian.com/x/zIhKLg#Advancedworkflowconfiguration-transitionproperties)
-   * and [Workflow properties](https://confluence.atlassian.com/x/JYlKLg).
-   *
-   * **[Permissions](#permissions) required:** *Administer Jira* [global
-   * permission](https://confluence.atlassian.com/x/x4dKLg).
-   *
-   * @path {DELETE} /rest/api/3/workflow/transitions/{transitionId}/properties
-   * @scopes-current manage:jira-configuration
-   * @scopes-beta delete:workflow.property:jira
-   */
-  deleteWorkflowTransitionProperty({
-    transitionId,
-    key,
-    workflowName,
-    workflowMode,
-  }: {
-    /**
-     * The ID of the transition. To get the ID, view the workflow in text mode in the
-     * Jira admin settings. The ID is shown next to the transition.
-     */
-    transitionId: number;
-    /**
-     * The name of the transition property to delete, also known as the name of the
-     * property.
-     */
-    key: string;
-    /** The name of the workflow that the transition belongs to. */
-    workflowName: string;
-    /**
-     * The workflow status. Set to `live` for inactive workflows or `draft` for draft
-     * workflows. Active workflows cannot be edited.
-     */
-    workflowMode?: "live" | "draft";
-  }): Promise<void> {
-    return this.getClientInstance()
-      .request({
-        path: "/rest/api/3/workflow/transitions/{transitionId}/properties",
-        method: "DELETE",
-        pathParams: {
-          transitionId,
-        },
-        query: {
-          key,
-          workflowName,
-          workflowMode,
-        },
-      })
-      .then(commonHttpClient.discardResult);
-  }
-  /**
-   * Returns the properties on a workflow transition. Transition properties are used
-   * to change the behavior of a transition. For more information, see [Transition
-   * properties](https://confluence.atlassian.com/x/zIhKLg#Advancedworkflowconfiguration-transitionproperties)
-   * and [Workflow properties](https://confluence.atlassian.com/x/JYlKLg).
-   *
-   * **[Permissions](#permissions) required:** *Administer Jira* [global
-   * permission](https://confluence.atlassian.com/x/x4dKLg).
-   *
-   * @returns 200 response
-   *
-   * example: [
-   *   {
-   *     "id": "jira.i18n.title",
-   *     "key": "jira.i18n.title",
-   *     "value": "some.title"
-   *   },
-   *   {
-   *     "id": "jira.permission",
-   *     "key": "jira.permission",
-   *     "value": "createissue"
-   *   }
-   * ]
-   * @path {GET} /rest/api/3/workflow/transitions/{transitionId}/properties
-   * @scopes-current manage:jira-configuration
-   * @scopes-beta read:workflow.property:jira
-   */
-  getWorkflowTransitionProperties({
-    transitionId,
-    includeReservedKeys,
-    key,
-    workflowName,
-    workflowMode,
-  }: {
-    /**
-     * The ID of the transition. To get the ID, view the workflow in text mode in the
-     * Jira administration console. The ID is shown next to the transition.
-     */
-    transitionId: number;
-    /**
-     * Some properties with keys that have the *jira.* prefix are reserved, which
-     * means they are not editable. To include these properties in the results, set
-     * this parameter to *true*.
-     */
-    includeReservedKeys?: boolean;
-    /**
-     * The key of the property being returned, also known as the name of the property.
-     * If this parameter is not specified, all properties on the transition are
-     * returned.
-     */
-    key?: string;
-    /** The name of the workflow that the transition belongs to. */
-    workflowName: string;
-    /**
-     * The workflow status. Set to *live* for active and inactive workflows, or
-     * *draft* for draft workflows.
-     */
-    workflowMode?: "live" | "draft";
-  }): Promise<WorkflowTransitionProperty> {
-    return this.getClientInstance()
-      .request({
-        path: "/rest/api/3/workflow/transitions/{transitionId}/properties",
-        method: "GET",
-        pathParams: {
-          transitionId,
-        },
-        query: {
-          includeReservedKeys,
-          key,
-          workflowName,
-          workflowMode,
-        },
-      })
-      .then(
-        this.getClientInstance().responseHandler({
-          200: {
-            "application/json": "json",
-          },
-        }),
-      )
-      .then(
-        commonHttpClient.castResponse<{
-          status: 200;
-          mediaType: "application/json";
-          body: WorkflowTransitionProperty;
-        }>(),
-      )
-      .then(
-        validationSchemaStorage.validator(
-          "WorkflowTransitionPropertiesService.getWorkflowTransitionProperties.response",
-        ),
-      )
-      .then(commonHttpClient.getBody);
-  }
-  /**
-   * Updates a workflow transition by changing the property value. Trying to update
-   * a property that does not exist results in a new property being added to the
-   * transition. Transition properties are used to change the behavior of a
-   * transition. For more information, see [Transition
-   * properties](https://confluence.atlassian.com/x/zIhKLg#Advancedworkflowconfiguration-transitionproperties)
-   * and [Workflow properties](https://confluence.atlassian.com/x/JYlKLg).
-   *
-   * **[Permissions](#permissions) required:** *Administer Jira* [global
-   * permission](https://confluence.atlassian.com/x/x4dKLg).
-   *
-   * @returns 200 response
-   *
-   * example: {
-   *   "key": "jira.i18n.title",
-   *   "value": "some.title",
-   *   "id": "jira.i18n.title"
-   * }
-   * @path {PUT} /rest/api/3/workflow/transitions/{transitionId}/properties
-   * @scopes-current manage:jira-configuration
-   * @scopes-beta write:workflow.property:jira, read:workflow.property:jira
-   */
-  updateWorkflowTransitionProperty({
-    transitionId,
-    key,
-    workflowName,
-    workflowMode,
-    workflowTransitionProperty,
-  }: {
-    /**
-     * The ID of the transition. To get the ID, view the workflow in text mode in the
-     * Jira admin settings. The ID is shown next to the transition.
-     */
-    transitionId: number;
-    /**
-     * The key of the property being updated, also known as the name of the property.
-     * Set this to the same value as the `key` defined in the request body.
-     */
-    key: string;
-    /** The name of the workflow that the transition belongs to. */
-    workflowName: string;
-    /**
-     * The workflow status. Set to `live` for inactive workflows or `draft` for draft
-     * workflows. Active workflows cannot be edited.
-     */
-    workflowMode?: "live" | "draft";
-    /**
-     * @example {
-     *     "value": "createissue"
-     * }
-     */
-    workflowTransitionProperty: WorkflowTransitionProperty;
-  }): Promise<WorkflowTransitionProperty> {
-    return this.getClientInstance()
-      .request({
-        path: "/rest/api/3/workflow/transitions/{transitionId}/properties",
-        method: "PUT",
-        pathParams: {
-          transitionId,
-        },
-        query: {
-          key,
-          workflowName,
-          workflowMode,
-        },
-        headers: {
-          "Content-Type": "application/json",
-        },
-        body: workflowTransitionProperty,
-      })
-      .then(
-        this.getClientInstance().responseHandler({
-          200: {
-            "application/json": "json",
-          },
-        }),
-      )
-      .then(
-        commonHttpClient.castResponse<{
-          status: 200;
-          mediaType: "application/json";
-          body: WorkflowTransitionProperty;
-        }>(),
-      )
-      .then(
-        validationSchemaStorage.validator(
-          "WorkflowTransitionPropertiesService.updateWorkflowTransitionProperty.response",
-        ),
-      )
-      .then(commonHttpClient.getBody);
-  }
-  static initialize() {
-    validationSchemaStorage.registerExtensible(
-      "WorkflowTransitionPropertiesService.getWorkflowTransitionProperties.response",
-      z
-        .object({
-          status: z.literal(200),
-          mediaType: z.literal("application/json"),
-          body: validationSchemaStorage.lazy("WorkflowTransitionProperty"),
-        })
-        .describe(
-          "WorkflowTransitionPropertiesService.getWorkflowTransitionProperties.response",
-        ),
-    );
-    validationSchemaStorage.registerExtensible(
-      "WorkflowTransitionPropertiesService.updateWorkflowTransitionProperty.response",
-      z
-        .object({
-          status: z.literal(200),
-          mediaType: z.literal("application/json"),
-          body: validationSchemaStorage.lazy("WorkflowTransitionProperty"),
-        })
-        .describe(
-          "WorkflowTransitionPropertiesService.updateWorkflowTransitionProperty.response",
-        ),
-    );
-    validationSchemaStorage.registerExtensible(
-      "WorkflowTransitionPropertiesService.createWorkflowTransitionProperty.response",
-      z
-        .object({
-          status: z.literal(200),
-          mediaType: z.literal("application/json"),
-          body: validationSchemaStorage.lazy("WorkflowTransitionProperty"),
-        })
-        .describe(
-          "WorkflowTransitionPropertiesService.createWorkflowTransitionProperty.response",
-        ),
-    );
-    validationSchemaStorage.registerOnce([
-      registerWorkflowTransitionPropertiesValidationSchemas,
-    ]);
-  }
-}