@resolution/jira-api-client 0.1.0 → 0.1.2

package/src/openapi/platform/services/time-tracking-service.ts

@@ -1,386 +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 {
-  registerCommonValidationSchemas,
-  type TimeTrackingConfiguration,
-} from "../models/common";
-import {
-  registerTimeTrackingValidationSchemas,
-  type TimeTrackingProvider,
-} from "../models/time-tracking";
-import { validationSchemaStorage } from "../validation-schema-storage";
-/**
- * This resource represents time tracking and time tracking providers. Use it to
- * get and set the time tracking provider, get and set the time tracking options,
- * and disable time tracking.
- */
-export class TimeTrackingService extends CommonHttpService {
-  /**
-   * Returns all time tracking providers. By default, Jira only has one time
-   * tracking provider: *JIRA provided time tracking*. However, you can install
-   * other time tracking providers via apps from the Atlassian Marketplace. For more
-   * information on time tracking providers, see the documentation for the [ Time
-   * Tracking
-   * Provider](https://developer.atlassian.com/cloud/jira/platform/modules/time-tracking-provider/)
-   * module.
-   *
-   * **[Permissions](#permissions) required:** *Administer Jira* [global
-   * permission](https://confluence.atlassian.com/x/x4dKLg).
-   *
-   * @returns Returned if the request is successful.
-   *
-   * example: [
-   *   {
-   *     "key": "Jira",
-   *     "name": "JIRA provided time tracking",
-   *     "url": "/example/config/url"
-   *   }
-   * ]
-   * @path {GET} /rest/api/3/configuration/timetracking/list
-   * @scopes-current manage:jira-configuration
-   * @scopes-beta read:issue.time-tracking:jira
-   */
-  getAvailableTimeTrackingImplementations(): Promise<TimeTrackingProvider[]> {
-    return this.getClientInstance()
-      .request({
-        path: "/rest/api/3/configuration/timetracking/list",
-        method: "GET",
-      })
-      .then(
-        this.getClientInstance().responseHandler({
-          200: {
-            "application/json": "json",
-          },
-        }),
-      )
-      .then(
-        commonHttpClient.castResponse<{
-          status: 200;
-          mediaType: "application/json";
-          body: TimeTrackingProvider[];
-        }>(),
-      )
-      .then(
-        validationSchemaStorage.validator(
-          "TimeTrackingService.getAvailableTimeTrackingImplementations.response",
-        ),
-      )
-      .then(commonHttpClient.getBody);
-  }
-  /**
-   * Returns the time tracking provider that is currently selected. Note that if
-   * time tracking is disabled, then a successful but empty response is returned.
-   *
-   * **[Permissions](#permissions) required:** *Administer Jira* [global
-   * permission](https://confluence.atlassian.com/x/x4dKLg).
-   *
-   * @returns * status: 200, mediaType: application/json
-   *
-   *    Returned if the request is successful and time tracking is enabled.
-   *
-   *    example: {
-   *      "key": "Jira",
-   *      "name": "JIRA provided time tracking",
-   *      "url": "/example/config/url"
-   *    }
-   *
-   *  * status: 204, mediaType: application/json
-   *
-   *    Returned if the request is successful but time tracking is disabled.
-   * @path {GET} /rest/api/3/configuration/timetracking
-   * @scopes-current manage:jira-configuration
-   * @scopes-beta read:issue.time-tracking:jira
-   */
-  getSelectedTimeTrackingImplementation(): Promise<
-    commonHttpClient.WithResponse<
-      | {
-          status: 200;
-          mediaType: "application/json";
-          body: TimeTrackingProvider;
-        }
-      | {
-          status: 204;
-          mediaType: "application/json";
-          body: void;
-        }
-    >
-  > {
-    return this.getClientInstance()
-      .request({
-        path: "/rest/api/3/configuration/timetracking",
-        method: "GET",
-      })
-      .then(
-        this.getClientInstance().responseHandler({
-          200: {
-            "application/json": "json",
-          },
-          204: {
-            "application/json": "json",
-          },
-        }),
-      )
-      .then(
-        commonHttpClient.castResponse<
-          | {
-              status: 200;
-              mediaType: "application/json";
-              body: TimeTrackingProvider;
-            }
-          | {
-              status: 204;
-              mediaType: "application/json";
-              body: void;
-            }
-        >(),
-      )
-      .then(
-        validationSchemaStorage.validator(
-          "TimeTrackingService.getSelectedTimeTrackingImplementation.response",
-        ),
-      );
-  }
-  /**
-   * Returns the time tracking settings. This includes settings such as the time
-   * format, default time unit, and others. For more information, see [Configuring
-   * time tracking](https://confluence.atlassian.com/x/qoXKM).
-   *
-   * **[Permissions](#permissions) required:** *Administer Jira* [global
-   * permission](https://confluence.atlassian.com/x/x4dKLg).
-   *
-   * @returns Returned if the request is successful.
-   *
-   * example: {
-   *   "defaultUnit": "hour",
-   *   "timeFormat": "pretty",
-   *   "workingDaysPerWeek": 5.5,
-   *   "workingHoursPerDay": 7.6
-   * }
-   * @path {GET} /rest/api/3/configuration/timetracking/options
-   * @scopes-current manage:jira-configuration
-   * @scopes-beta read:issue.time-tracking:jira
-   */
-  getSharedTimeTrackingConfiguration(): Promise<TimeTrackingConfiguration> {
-    return this.getClientInstance()
-      .request({
-        path: "/rest/api/3/configuration/timetracking/options",
-        method: "GET",
-      })
-      .then(
-        this.getClientInstance().responseHandler({
-          200: {
-            "application/json": "json",
-          },
-        }),
-      )
-      .then(
-        commonHttpClient.castResponse<{
-          status: 200;
-          mediaType: "application/json";
-          body: TimeTrackingConfiguration;
-        }>(),
-      )
-      .then(
-        validationSchemaStorage.validator(
-          "TimeTrackingService.getSharedTimeTrackingConfiguration.response",
-        ),
-      )
-      .then(commonHttpClient.getBody);
-  }
-  /**
-   * Selects a time tracking provider.
-   *
-   * **[Permissions](#permissions) required:** *Administer Jira* [global
-   * permission](https://confluence.atlassian.com/x/x4dKLg).
-   *
-   * @returns Returned if the request is successful.
-   * @path {PUT} /rest/api/3/configuration/timetracking
-   * @scopes-current manage:jira-configuration
-   * @scopes-beta write:issue.time-tracking:jira
-   */
-  selectTimeTrackingImplementation({
-    timeTrackingProvider,
-  }: {
-    /**
-     * @example {
-     *     "key": "Jira"
-     * }
-     */
-    timeTrackingProvider: TimeTrackingProvider;
-  }): Promise<void> {
-    return this.getClientInstance()
-      .request({
-        path: "/rest/api/3/configuration/timetracking",
-        method: "PUT",
-        headers: {
-          "Content-Type": "application/json",
-        },
-        body: timeTrackingProvider,
-      })
-      .then(
-        this.getClientInstance().responseHandler({
-          204: {
-            "application/json": "json",
-          },
-        }),
-      )
-      .then(
-        commonHttpClient.castResponse<{
-          status: 204;
-          mediaType: "application/json";
-          body: void;
-        }>(),
-      )
-      .then(
-        validationSchemaStorage.validator(
-          "TimeTrackingService.selectTimeTrackingImplementation.response",
-        ),
-      )
-      .then(commonHttpClient.getBody);
-  }
-  /**
-   * Sets the time tracking settings.
-   *
-   * **[Permissions](#permissions) required:** *Administer Jira* [global
-   * permission](https://confluence.atlassian.com/x/x4dKLg).
-   *
-   * @returns Returned if the request is successful.
-   *
-   * example: {
-   *   "defaultUnit": "hour",
-   *   "timeFormat": "pretty",
-   *   "workingDaysPerWeek": 5.5,
-   *   "workingHoursPerDay": 7.6
-   * }
-   * @path {PUT} /rest/api/3/configuration/timetracking/options
-   * @scopes-current manage:jira-configuration
-   * @scopes-beta write:issue.time-tracking:jira, read:issue.time-tracking:jira
-   */
-  setSharedTimeTrackingConfiguration({
-    timeTrackingConfiguration,
-  }: {
-    /**
-     * @example {
-     *     "defaultUnit": "hour",
-     *     "timeFormat": "pretty",
-     *     "workingDaysPerWeek": 5.5,
-     *     "workingHoursPerDay": 7.6
-     * }
-     */
-    timeTrackingConfiguration: TimeTrackingConfiguration;
-  }): Promise<TimeTrackingConfiguration> {
-    return this.getClientInstance()
-      .request({
-        path: "/rest/api/3/configuration/timetracking/options",
-        method: "PUT",
-        headers: {
-          "Content-Type": "application/json",
-        },
-        body: timeTrackingConfiguration,
-      })
-      .then(
-        this.getClientInstance().responseHandler({
-          200: {
-            "application/json": "json",
-          },
-        }),
-      )
-      .then(
-        commonHttpClient.castResponse<{
-          status: 200;
-          mediaType: "application/json";
-          body: TimeTrackingConfiguration;
-        }>(),
-      )
-      .then(
-        validationSchemaStorage.validator(
-          "TimeTrackingService.setSharedTimeTrackingConfiguration.response",
-        ),
-      )
-      .then(commonHttpClient.getBody);
-  }
-  static initialize() {
-    validationSchemaStorage.registerExtensible(
-      "TimeTrackingService.getSelectedTimeTrackingImplementation.response",
-      z
-        .object({
-          status: z.number(),
-          mediaType: z.string(),
-          body: z.unknown(),
-        })
-        .superRefine(({ status: status, body: body }, ctx) => {
-          if (status === 200) {
-            validationSchemaStorage.lazy("TimeTrackingProvider").parse(body);
-          } else if (status === 204) {
-            z.unknown().parse(body);
-          } else {
-            ctx.addIssue({
-              code: z.ZodIssueCode.custom,
-              path: ["status"],
-              message: `Unexpected status code: ${status}`,
-            });
-          }
-        })
-        .describe(
-          "TimeTrackingService.getSelectedTimeTrackingImplementation.response",
-        ),
-    );
-    validationSchemaStorage.registerExtensible(
-      "TimeTrackingService.selectTimeTrackingImplementation.response",
-      z
-        .object({
-          status: z.literal(204),
-          mediaType: z.literal("application/json"),
-          body: z.unknown(),
-        })
-        .describe(
-          "TimeTrackingService.selectTimeTrackingImplementation.response",
-        ),
-    );
-    validationSchemaStorage.registerExtensible(
-      "TimeTrackingService.getAvailableTimeTrackingImplementations.response",
-      z
-        .object({
-          status: z.literal(200),
-          mediaType: z.literal("application/json"),
-          body: z.array(validationSchemaStorage.lazy("TimeTrackingProvider")),
-        })
-        .describe(
-          "TimeTrackingService.getAvailableTimeTrackingImplementations.response",
-        ),
-    );
-    validationSchemaStorage.registerExtensible(
-      "TimeTrackingService.getSharedTimeTrackingConfiguration.response",
-      z
-        .object({
-          status: z.literal(200),
-          mediaType: z.literal("application/json"),
-          body: validationSchemaStorage.lazy("TimeTrackingConfiguration"),
-        })
-        .describe(
-          "TimeTrackingService.getSharedTimeTrackingConfiguration.response",
-        ),
-    );
-    validationSchemaStorage.registerExtensible(
-      "TimeTrackingService.setSharedTimeTrackingConfiguration.response",
-      z
-        .object({
-          status: z.literal(200),
-          mediaType: z.literal("application/json"),
-          body: validationSchemaStorage.lazy("TimeTrackingConfiguration"),
-        })
-        .describe(
-          "TimeTrackingService.setSharedTimeTrackingConfiguration.response",
-        ),
-    );
-    validationSchemaStorage.registerOnce([
-      registerTimeTrackingValidationSchemas,
-      registerCommonValidationSchemas,
-    ]);
-  }
-}