@resolution/jira-api-client 0.1.0 → 0.1.2

package/src/openapi/platform/services/project-email-service.ts

@@ -1,161 +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 ProjectEmailAddress,
-  registerProjectEmailValidationSchemas,
-} from "../models/project-email";
-import { validationSchemaStorage } from "../validation-schema-storage";
-/**
- * This resource represents the email address used to send a project's
- * notifications. Use it to get and set the [project's sender email
- * address](https://confluence.atlassian.com/x/dolKLg).
- */
-export class ProjectEmailService extends CommonHttpService {
-  /**
-   * Returns the [project's sender email
-   * address](https://confluence.atlassian.com/x/dolKLg).
-   *
-   * **[Permissions](#permissions) required:** *Browse projects* [project
-   * permission](https://confluence.atlassian.com/x/yodKLg) for the project.
-   *
-   * @returns Returned if the request is successful.
-   *
-   * example: {
-   *   "emailAddress": "jira@example.customdomain.com",
-   *   "emailAddressStatus": [
-   *     "Email address or domain not verified."
-   *   ]
-   * }
-   * @path {GET} /rest/api/3/project/{projectId}/email
-   * @scopes-current manage:jira-project
-   * @scopes-beta read:project.email:jira
-   */
-  getProjectEmail({
-    projectId,
-  }: {
-    /** The project ID. */
-    projectId: number;
-  }): Promise<ProjectEmailAddress> {
-    return this.getClientInstance()
-      .request({
-        path: "/rest/api/3/project/{projectId}/email",
-        method: "GET",
-        pathParams: {
-          projectId,
-        },
-      })
-      .then(
-        this.getClientInstance().responseHandler({
-          200: {
-            "application/json": "json",
-          },
-        }),
-      )
-      .then(
-        commonHttpClient.castResponse<{
-          status: 200;
-          mediaType: "application/json";
-          body: ProjectEmailAddress;
-        }>(),
-      )
-      .then(
-        validationSchemaStorage.validator(
-          "ProjectEmailService.getProjectEmail.response",
-        ),
-      )
-      .then(commonHttpClient.getBody);
-  }
-  /**
-   * Sets the [project's sender email
-   * address](https://confluence.atlassian.com/x/dolKLg).
-   *
-   * If `emailAddress` is an empty string, the default email address is restored.
-   *
-   * **[Permissions](#permissions) required:** *Administer Jira* [global
-   * permission](https://confluence.atlassian.com/x/x4dKLg) or *Administer Projects*
-   * [project permission.](https://confluence.atlassian.com/x/yodKLg)
-   *
-   * @returns Returned if the project's sender email address is successfully set.
-   * @path {PUT} /rest/api/3/project/{projectId}/email
-   * @scopes-current manage:jira-project
-   * @scopes-beta write:project.email:jira
-   */
-  updateProjectEmail({
-    projectId,
-    projectEmailAddress,
-  }: {
-    /** The project ID. */
-    projectId: number;
-    /**
-     * The project's sender email address to be set.
-     *
-     * @example {
-     *     "emailAddress": "jira@example.atlassian.net"
-     * }
-     */
-    projectEmailAddress: ProjectEmailAddress;
-  }): Promise<void> {
-    return this.getClientInstance()
-      .request({
-        path: "/rest/api/3/project/{projectId}/email",
-        method: "PUT",
-        pathParams: {
-          projectId,
-        },
-        headers: {
-          "Content-Type": "application/json",
-        },
-        body: projectEmailAddress,
-      })
-      .then(
-        this.getClientInstance().responseHandler({
-          204: {
-            "application/json": "json",
-          },
-        }),
-      )
-      .then(
-        commonHttpClient.castResponse<{
-          status: 204;
-          mediaType: "application/json";
-          body: void;
-        }>(),
-      )
-      .then(
-        validationSchemaStorage.validator(
-          "ProjectEmailService.updateProjectEmail.response",
-        ),
-      )
-      .then(commonHttpClient.getBody);
-  }
-  static initialize() {
-    validationSchemaStorage.registerExtensible(
-      "ProjectEmailService.getProjectEmail.response",
-      z
-        .object({
-          status: z.literal(200),
-          mediaType: z.literal("application/json"),
-          body: validationSchemaStorage.lazy("ProjectEmailAddress"),
-        })
-        .describe("ProjectEmailService.getProjectEmail.response"),
-    );
-    validationSchemaStorage.registerExtensible(
-      "ProjectEmailService.updateProjectEmail.response",
-      z
-        .object({
-          status: z.literal(204),
-          mediaType: z.literal("application/json"),
-          body: z.unknown(),
-        })
-        .describe("ProjectEmailService.updateProjectEmail.response"),
-    );
-    validationSchemaStorage.registerOnce([
-      registerProjectEmailValidationSchemas,
-    ]);
-  }
-}

package/src/openapi/platform/services/project-features-service.ts

@@ -1,207 +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 ContainerForProjectFeatures,
-  type ProjectFeatureState,
-  registerProjectFeaturesValidationSchemas,
-} from "../models/project-features";
-import { validationSchemaStorage } from "../validation-schema-storage";
-/**
- * This resource represents project features. Use it to get the list of features
- * for a project and modify the state of a feature. The project feature endpoint
- * is available only for Jira Software, both for team- and company-managed
- * projects.
- */
-export class ProjectFeaturesService extends CommonHttpService {
-  /**
-   * Returns the list of features for a project.
-   *
-   * @returns Returned if the request is successful.
-   *
-   * example: {
-   *   "features": [
-   *     {
-   *       "feature": "jsw.classic.roadmap",
-   *       "imageUri":
-   * "https://jira.atlassian.com/s/sb53l8/b/3/ab8a7691e4738b4f147e293f0864adfd5b8d3c85/_/download/resources/com.atlassian.jira.rest:classic-project-features/simple-roadmap-feature.svg",
-   *       "localisedDescription": "Your roadmap is an optimized location to create
-   * and manage your epics.",
-   *       "localisedName": "Roadmap",
-   *       "prerequisites": [],
-   *       "projectId": 10001,
-   *       "state": "ENABLED",
-   *       "toggleLocked": true
-   *     },
-   *     {
-   *       "feature": "jsw.classic.backlog",
-   *       "imageUri":
-   * "https://jira.atlassian.com/s/sb53l8/b/3/ab8a7691e4738b4f147e293f0864adfd5b8d3c85/_/download/resources/com.atlassian.jira.rest:classic-project-features/simple-backlog-feature.svg",
-   *       "localisedDescription": "Plan and prioritize work in a dedicated space.
-   * To enable and configure the backlog for each board, go to board settings.",
-   *       "localisedName": "Backlog",
-   *       "prerequisites": [],
-   *       "projectId": 10001,
-   *       "state": "ENABLED",
-   *       "toggleLocked": true
-   *     }
-   *   ]
-   * }
-   * @path {GET} /rest/api/3/project/{projectIdOrKey}/features
-   * @scopes-current read:jira-work
-   * @scopes-beta read:project.feature:jira
-   */
-  getFeaturesForProject({
-    projectIdOrKey,
-  }: {
-    /** The ID or (case-sensitive) key of the project. */
-    projectIdOrKey: string;
-  }): Promise<ContainerForProjectFeatures> {
-    return this.getClientInstance()
-      .request({
-        path: "/rest/api/3/project/{projectIdOrKey}/features",
-        method: "GET",
-        pathParams: {
-          projectIdOrKey,
-        },
-      })
-      .then(
-        this.getClientInstance().responseHandler({
-          200: {
-            "application/json": "json",
-          },
-        }),
-      )
-      .then(
-        commonHttpClient.castResponse<{
-          status: 200;
-          mediaType: "application/json";
-          body: ContainerForProjectFeatures;
-        }>(),
-      )
-      .then(
-        validationSchemaStorage.validator(
-          "ProjectFeaturesService.getFeaturesForProject.response",
-        ),
-      )
-      .then(commonHttpClient.getBody);
-  }
-  /**
-   * Sets the state of a project feature.
-   *
-   * @returns Returned if the request is successful.
-   *
-   * example: {
-   *   "features": [
-   *     {
-   *       "feature": "jsw.classic.roadmap",
-   *       "imageUri":
-   * "https://jira.atlassian.com/s/sb53l8/b/3/ab8a7691e4738b4f147e293f0864adfd5b8d3c85/_/download/resources/com.atlassian.jira.rest:classic-project-features/simple-roadmap-feature.svg",
-   *       "localisedDescription": "Your roadmap is an optimized location to create
-   * and manage your epics.",
-   *       "localisedName": "Roadmap",
-   *       "prerequisites": [],
-   *       "projectId": 10001,
-   *       "state": "ENABLED",
-   *       "toggleLocked": true
-   *     },
-   *     {
-   *       "feature": "jsw.classic.backlog",
-   *       "imageUri":
-   * "https://jira.atlassian.com/s/sb53l8/b/3/ab8a7691e4738b4f147e293f0864adfd5b8d3c85/_/download/resources/com.atlassian.jira.rest:classic-project-features/simple-backlog-feature.svg",
-   *       "localisedDescription": "Plan and prioritize work in a dedicated space.
-   * To enable and configure the backlog for each board, go to board settings.",
-   *       "localisedName": "Backlog",
-   *       "prerequisites": [],
-   *       "projectId": 10001,
-   *       "state": "ENABLED",
-   *       "toggleLocked": true
-   *     }
-   *   ]
-   * }
-   * @path {PUT} /rest/api/3/project/{projectIdOrKey}/features/{featureKey}
-   * @scopes-current manage:jira-project
-   * @scopes-beta write:project.feature:jira, read:project.feature:jira
-   */
-  toggleFeatureForProject({
-    projectIdOrKey,
-    featureKey,
-    projectFeatureState,
-  }: {
-    /** The ID or (case-sensitive) key of the project. */
-    projectIdOrKey: string;
-    /** The key of the feature. */
-    featureKey: string;
-    /**
-     * Details of the feature state change.
-     *
-     * @example {
-     *     "state": "ENABLED"
-     * }
-     */
-    projectFeatureState: ProjectFeatureState;
-  }): Promise<ContainerForProjectFeatures> {
-    return this.getClientInstance()
-      .request({
-        path: "/rest/api/3/project/{projectIdOrKey}/features/{featureKey}",
-        method: "PUT",
-        pathParams: {
-          projectIdOrKey,
-          featureKey,
-        },
-        headers: {
-          "Content-Type": "application/json",
-        },
-        body: projectFeatureState,
-      })
-      .then(
-        this.getClientInstance().responseHandler({
-          200: {
-            "application/json": "json",
-          },
-        }),
-      )
-      .then(
-        commonHttpClient.castResponse<{
-          status: 200;
-          mediaType: "application/json";
-          body: ContainerForProjectFeatures;
-        }>(),
-      )
-      .then(
-        validationSchemaStorage.validator(
-          "ProjectFeaturesService.toggleFeatureForProject.response",
-        ),
-      )
-      .then(commonHttpClient.getBody);
-  }
-  static initialize() {
-    validationSchemaStorage.registerExtensible(
-      "ProjectFeaturesService.getFeaturesForProject.response",
-      z
-        .object({
-          status: z.literal(200),
-          mediaType: z.literal("application/json"),
-          body: validationSchemaStorage.lazy("ContainerForProjectFeatures"),
-        })
-        .describe("ProjectFeaturesService.getFeaturesForProject.response"),
-    );
-    validationSchemaStorage.registerExtensible(
-      "ProjectFeaturesService.toggleFeatureForProject.response",
-      z
-        .object({
-          status: z.literal(200),
-          mediaType: z.literal("application/json"),
-          body: validationSchemaStorage.lazy("ContainerForProjectFeatures"),
-        })
-        .describe("ProjectFeaturesService.toggleFeatureForProject.response"),
-    );
-    validationSchemaStorage.registerOnce([
-      registerProjectFeaturesValidationSchemas,
-    ]);
-  }
-}

package/src/openapi/platform/services/project-key-and-name-validation-service.ts

@@ -1,200 +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 ErrorCollection,
-  registerCommonValidationSchemas,
-} from "../models/common";
-import { validationSchemaStorage } from "../validation-schema-storage";
-/** This resource provides validation for project keys and names. */
-export class ProjectKeyAndNameValidationService extends CommonHttpService {
-  /**
-   * Validates a project key and, if the key is invalid or in use, generates a valid
-   * random string for the project key.
-   *
-   * **[Permissions](#permissions) required:** None.
-   *
-   * @returns Returned if the request is successful.
-   *
-   * example: "VPNE"
-   * @path {GET} /rest/api/3/projectvalidate/validProjectKey
-   */
-  getValidProjectKey({
-    key,
-  }: {
-    /** The project key. */
-    key?: string;
-  }): Promise<string> {
-    return this.getClientInstance()
-      .request({
-        path: "/rest/api/3/projectvalidate/validProjectKey",
-        method: "GET",
-        query: {
-          key,
-        },
-      })
-      .then(
-        this.getClientInstance().responseHandler({
-          200: {
-            "application/json": "json",
-          },
-        }),
-      )
-      .then(
-        commonHttpClient.castResponse<{
-          status: 200;
-          mediaType: "application/json";
-          body: string;
-        }>(),
-      )
-      .then(
-        validationSchemaStorage.validator(
-          "ProjectKeyAndNameValidationService.getValidProjectKey.response",
-        ),
-      )
-      .then(commonHttpClient.getBody);
-  }
-  /**
-   * Checks that a project name isn't in use. If the name isn't in use, the passed
-   * string is returned. If the name is in use, this operation attempts to generate
-   * a valid project name based on the one supplied, usually by adding a sequence
-   * number. If a valid project name cannot be generated, a 404 response is returned.
-   *
-   * **[Permissions](#permissions) required:** None.
-   *
-   * @returns Returned if the request is successful.
-   *
-   * example: "Valid Project Name Example"
-   * @path {GET} /rest/api/3/projectvalidate/validProjectName
-   */
-  getValidProjectName({
-    name,
-  }: {
-    /** The project name. */
-    name: string;
-  }): Promise<string> {
-    return this.getClientInstance()
-      .request({
-        path: "/rest/api/3/projectvalidate/validProjectName",
-        method: "GET",
-        query: {
-          name,
-        },
-      })
-      .then(
-        this.getClientInstance().responseHandler({
-          200: {
-            "application/json": "json",
-          },
-        }),
-      )
-      .then(
-        commonHttpClient.castResponse<{
-          status: 200;
-          mediaType: "application/json";
-          body: string;
-        }>(),
-      )
-      .then(
-        validationSchemaStorage.validator(
-          "ProjectKeyAndNameValidationService.getValidProjectName.response",
-        ),
-      )
-      .then(commonHttpClient.getBody);
-  }
-  /**
-   * Validates a project key by confirming the key is a valid string and not in use.
-   *
-   * **[Permissions](#permissions) required:** None.
-   *
-   * @returns Returned if the request is successful.
-   *
-   * example: {
-   *   "errorMessages": [],
-   *   "errors": {
-   *     "projectKey": "A project with that project key already exists."
-   *   }
-   * }
-   * @path {GET} /rest/api/3/projectvalidate/key
-   * @scopes-current read:jira-work
-   * @scopes-beta read:project:jira
-   */
-  validateProjectKey({
-    key,
-  }: {
-    /** The project key. */
-    key?: string;
-  }): Promise<ErrorCollection> {
-    return this.getClientInstance()
-      .request({
-        path: "/rest/api/3/projectvalidate/key",
-        method: "GET",
-        query: {
-          key,
-        },
-      })
-      .then(
-        this.getClientInstance().responseHandler({
-          200: {
-            "application/json": "json",
-          },
-        }),
-      )
-      .then(
-        commonHttpClient.castResponse<{
-          status: 200;
-          mediaType: "application/json";
-          body: ErrorCollection;
-        }>(),
-      )
-      .then(
-        validationSchemaStorage.validator(
-          "ProjectKeyAndNameValidationService.validateProjectKey.response",
-        ),
-      )
-      .then(commonHttpClient.getBody);
-  }
-  static initialize() {
-    validationSchemaStorage.registerExtensible(
-      "ProjectKeyAndNameValidationService.validateProjectKey.response",
-      z
-        .object({
-          status: z.literal(200),
-          mediaType: z.literal("application/json"),
-          body: validationSchemaStorage.lazy("ErrorCollection"),
-        })
-        .describe(
-          "ProjectKeyAndNameValidationService.validateProjectKey.response",
-        ),
-    );
-    validationSchemaStorage.registerExtensible(
-      "ProjectKeyAndNameValidationService.getValidProjectKey.response",
-      z
-        .object({
-          status: z.literal(200),
-          mediaType: z.literal("application/json"),
-          body: z.string(),
-        })
-        .describe(
-          "ProjectKeyAndNameValidationService.getValidProjectKey.response",
-        ),
-    );
-    validationSchemaStorage.registerExtensible(
-      "ProjectKeyAndNameValidationService.getValidProjectName.response",
-      z
-        .object({
-          status: z.literal(200),
-          mediaType: z.literal("application/json"),
-          body: z.string(),
-        })
-        .describe(
-          "ProjectKeyAndNameValidationService.getValidProjectName.response",
-        ),
-    );
-    validationSchemaStorage.registerOnce([registerCommonValidationSchemas]);
-  }
-}