@resolution/jira-api-client 0.1.0

package/src/openapi/platform/services/announcement-banner-service.ts

@@ -0,0 +1,142 @@
+// 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 AnnouncementBannerConfiguration,
+  type AnnouncementBannerConfigurationUpdate,
+  registerAnnouncementBannerValidationSchemas,
+} from "../models/announcement-banner";
+import { validationSchemaStorage } from "../validation-schema-storage";
+/**
+ * This resource represents an announcement banner. Use it to retrieve and update
+ * banner configuration.
+ */
+export class AnnouncementBannerService extends CommonHttpService {
+  /**
+   * Returns the current announcement banner configuration.
+   *
+   * **[Permissions](#permissions) required:** *Administer Jira* [global
+   * permission](https://confluence.atlassian.com/x/x4dKLg).
+   *
+   * @returns Returned if the request is successful.
+   *
+   * example: {
+   *   "hashId": "9HN2FJK9DM8BHRWERVW3RRTGDJ4G4D5C",
+   *   "isDismissible": false,
+   *   "isEnabled": true,
+   *   "message": "This is a public, enabled, non-dismissible banner, set using the
+   * API",
+   *   "visibility": "public"
+   * }
+   * @path {GET} /rest/api/3/announcementBanner
+   */
+  getBanner(): Promise<AnnouncementBannerConfiguration> {
+    return this.getClientInstance()
+      .request({
+        path: "/rest/api/3/announcementBanner",
+        method: "GET",
+      })
+      .then(
+        this.getClientInstance().responseHandler({
+          200: {
+            "application/json": "json",
+          },
+        }),
+      )
+      .then(
+        commonHttpClient.castResponse<{
+          status: 200;
+          mediaType: "application/json";
+          body: AnnouncementBannerConfiguration;
+        }>(),
+      )
+      .then(
+        validationSchemaStorage.validator(
+          "AnnouncementBannerService.getBanner.response",
+        ),
+      )
+      .then(commonHttpClient.getBody);
+  }
+  /**
+   * Updates the announcement banner configuration.
+   *
+   * **[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/announcementBanner
+   */
+  setBanner({
+    announcementBannerConfigurationUpdate,
+  }: {
+    /**
+     * @example {
+     *     "isDismissible": false,
+     *     "isEnabled": true,
+     *     "message": "This is a public, enabled, non-dismissible banner, set using
+     * the API",
+     *     "visibility": "public"
+     * }
+     */
+    announcementBannerConfigurationUpdate: AnnouncementBannerConfigurationUpdate;
+  }): Promise<void> {
+    return this.getClientInstance()
+      .request({
+        path: "/rest/api/3/announcementBanner",
+        method: "PUT",
+        headers: {
+          "Content-Type": "application/json",
+        },
+        body: announcementBannerConfigurationUpdate,
+      })
+      .then(
+        this.getClientInstance().responseHandler({
+          204: {
+            "application/json": "json",
+          },
+        }),
+      )
+      .then(
+        commonHttpClient.castResponse<{
+          status: 204;
+          mediaType: "application/json";
+          body: void;
+        }>(),
+      )
+      .then(
+        validationSchemaStorage.validator(
+          "AnnouncementBannerService.setBanner.response",
+        ),
+      )
+      .then(commonHttpClient.getBody);
+  }
+  static initialize() {
+    validationSchemaStorage.registerExtensible(
+      "AnnouncementBannerService.getBanner.response",
+      z
+        .object({
+          status: z.literal(200),
+          mediaType: z.literal("application/json"),
+          body: validationSchemaStorage.lazy("AnnouncementBannerConfiguration"),
+        })
+        .describe("AnnouncementBannerService.getBanner.response"),
+    );
+    validationSchemaStorage.registerExtensible(
+      "AnnouncementBannerService.setBanner.response",
+      z
+        .object({
+          status: z.literal(204),
+          mediaType: z.literal("application/json"),
+          body: z.unknown(),
+        })
+        .describe("AnnouncementBannerService.setBanner.response"),
+    );
+    validationSchemaStorage.registerOnce([
+      registerAnnouncementBannerValidationSchemas,
+    ]);
+  }
+}

package/src/openapi/platform/services/app-data-policies-service.ts

@@ -0,0 +1,136 @@
+// 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 ProjectDataPolicies,
+  registerAppDataPoliciesValidationSchemas,
+  type WorkspaceDataPolicy,
+} from "../models/app-data-policies";
+import { validationSchemaStorage } from "../validation-schema-storage";
+/** This resource represents app access rule data policies. */
+export class AppDataPoliciesService extends CommonHttpService {
+  /**
+   * Returns data policies for the projects specified in the request.
+   *
+   * @returns Returned if the request is successful.
+   *
+   * example: {
+   *   "projectDataPolicies": [
+   *     {
+   *       "dataPolicy": {
+   *         "anyContentBlocked": false
+   *       },
+   *       "id": 1000
+   *     },
+   *     {
+   *       "dataPolicy": {
+   *         "anyContentBlocked": true
+   *       },
+   *       "id": 1001
+   *     }
+   *   ]
+   * }
+   * @path {GET} /rest/api/3/data-policy/project
+   */
+  getPolicies({
+    ids,
+  }: {
+    /** A list of project identifiers. This parameter accepts a comma-separated list. */
+    ids?: string;
+  }): Promise<ProjectDataPolicies> {
+    return this.getClientInstance()
+      .request({
+        path: "/rest/api/3/data-policy/project",
+        method: "GET",
+        query: {
+          ids,
+        },
+      })
+      .then(
+        this.getClientInstance().responseHandler({
+          200: {
+            "application/json": "json",
+          },
+        }),
+      )
+      .then(
+        commonHttpClient.castResponse<{
+          status: 200;
+          mediaType: "application/json";
+          body: ProjectDataPolicies;
+        }>(),
+      )
+      .then(
+        validationSchemaStorage.validator(
+          "AppDataPoliciesService.getPolicies.response",
+        ),
+      )
+      .then(commonHttpClient.getBody);
+  }
+  /**
+   * Returns data policy for the workspace.
+   *
+   * @returns Returned if the request is successful
+   *
+   * example: {
+   *   "anyContentBlocked": false
+   * }
+   * @path {GET} /rest/api/3/data-policy
+   */
+  getPolicy(): Promise<WorkspaceDataPolicy> {
+    return this.getClientInstance()
+      .request({
+        path: "/rest/api/3/data-policy",
+        method: "GET",
+      })
+      .then(
+        this.getClientInstance().responseHandler({
+          200: {
+            "application/json": "json",
+          },
+        }),
+      )
+      .then(
+        commonHttpClient.castResponse<{
+          status: 200;
+          mediaType: "application/json";
+          body: WorkspaceDataPolicy;
+        }>(),
+      )
+      .then(
+        validationSchemaStorage.validator(
+          "AppDataPoliciesService.getPolicy.response",
+        ),
+      )
+      .then(commonHttpClient.getBody);
+  }
+  static initialize() {
+    validationSchemaStorage.registerExtensible(
+      "AppDataPoliciesService.getPolicy.response",
+      z
+        .object({
+          status: z.literal(200),
+          mediaType: z.literal("application/json"),
+          body: validationSchemaStorage.lazy("WorkspaceDataPolicy"),
+        })
+        .describe("AppDataPoliciesService.getPolicy.response"),
+    );
+    validationSchemaStorage.registerExtensible(
+      "AppDataPoliciesService.getPolicies.response",
+      z
+        .object({
+          status: z.literal(200),
+          mediaType: z.literal("application/json"),
+          body: validationSchemaStorage.lazy("ProjectDataPolicies"),
+        })
+        .describe("AppDataPoliciesService.getPolicies.response"),
+    );
+    validationSchemaStorage.registerOnce([
+      registerAppDataPoliciesValidationSchemas,
+    ]);
+  }
+}

package/src/openapi/platform/services/app-migration-service.ts

@@ -0,0 +1,289 @@
+// 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 ConnectCustomFieldValues,
+  type EntityPropertyDetails,
+  registerAppMigrationValidationSchemas,
+  type WorkflowRulesSearch,
+  type WorkflowRulesSearchDetails,
+} from "../models/app-migration";
+import { validationSchemaStorage } from "../validation-schema-storage";
+/**
+ * This resource supports [app
+ * migrations](https://developer.atlassian.com/platform/app-migration/). Use it to:
+ * - [to request migrated workflow rules
+ * details](https://developer.atlassian.com/platform/app-migration/tutorials/migration-app-workflow-rules/).
+ * - [perform bulk updates of entity
+ * properties](https://developer.atlassian.com/platform/app-migration/tutorials/entity-properties-bulk-api/).
+ * - [perform bulk updates of issue custom field
+ * values](https://developer.atlassian.com/platform/app-migration/tutorials/migrating-app-custom-fields/).
+ */
+export class AppMigrationService extends CommonHttpService {
+  /**
+   * Updates the value of a custom field added by Connect apps on one or more issues.
+   * The values of up to 200 custom fields can be updated.
+   *
+   * **[Permissions](#permissions) required:** Only Connect apps can make this
+   * request
+   *
+   * @returns Returned if the request is successful.
+   * @path {PUT} /rest/atlassian-connect/1/migration/field
+   */
+  appIssueFieldValueUpdateResourceUpdateIssueFieldsPut({
+    atlassianTransferId,
+    connectCustomFieldValues,
+  }: {
+    /** The ID of the transfer. */
+    atlassianTransferId: string;
+    /**
+     * @example {
+     *     "updateValueList": [
+     *         {
+     *             "_type": "StringIssueField",
+     *             "issueID": 10001,
+     *             "fieldID": 10076,
+     *             "string": "new string value"
+     *         },
+     *         {
+     *             "_type": "TextIssueField",
+     *             "issueID": 10002,
+     *             "fieldID": 10077,
+     *             "text": "new text value"
+     *         },
+     *         {
+     *             "_type": "SingleSelectIssueField",
+     *             "issueID": 10003,
+     *             "fieldID": 10078,
+     *             "optionID": "1"
+     *         },
+     *         {
+     *             "_type": "MultiSelectIssueField",
+     *             "issueID": 10004,
+     *             "fieldID": 10079,
+     *             "optionID": "2"
+     *         },
+     *         {
+     *             "_type": "RichTextIssueField",
+     *             "issueID": 10005,
+     *             "fieldID": 10080,
+     *             "richText": "new rich text value"
+     *         },
+     *         {
+     *             "_type": "NumberIssueField",
+     *             "issueID": 10006,
+     *             "fieldID": 10082,
+     *             "number": 54
+     *         }
+     *     ]
+     * }
+     */
+    connectCustomFieldValues: ConnectCustomFieldValues;
+  }): Promise<unknown> {
+    return this.getClientInstance()
+      .request({
+        path: "/rest/atlassian-connect/1/migration/field",
+        method: "PUT",
+        headers: {
+          "Atlassian-Transfer-Id": atlassianTransferId,
+          "Content-Type": "application/json",
+        },
+        body: connectCustomFieldValues,
+      })
+      .then(
+        this.getClientInstance().responseHandler({
+          200: {
+            "application/json": "json",
+          },
+        }),
+      )
+      .then(
+        commonHttpClient.castResponse<{
+          status: 200;
+          mediaType: "application/json";
+          body: unknown;
+        }>(),
+      )
+      .then(
+        validationSchemaStorage.validator(
+          "AppMigrationService.AppIssueFieldValueUpdateResource.updateIssueFields_put.response",
+        ),
+      )
+      .then(commonHttpClient.getBody);
+  }
+  /**
+   * Updates the values of multiple entity properties for an object, up to 50
+   * updates per request. This operation is for use by Connect apps during app
+   * migration.
+   *
+   * @path {PUT} /rest/atlassian-connect/1/migration/properties/{entityType}
+   */
+  migrationResourceUpdateEntityPropertiesValuePut({
+    entityType,
+    atlassianTransferId,
+    entityPropertyDetailses,
+  }: {
+    /** The type indicating the object that contains the entity properties. */
+    entityType:
+      | "IssueProperty"
+      | "CommentProperty"
+      | "DashboardItemProperty"
+      | "IssueTypeProperty"
+      | "ProjectProperty"
+      | "UserProperty"
+      | "WorklogProperty"
+      | "BoardProperty"
+      | "SprintProperty";
+    /** The app migration transfer ID. */
+    atlassianTransferId: string;
+    entityPropertyDetailses: EntityPropertyDetails[];
+  }): Promise<void> {
+    return this.getClientInstance()
+      .request({
+        path: "/rest/atlassian-connect/1/migration/properties/{entityType}",
+        method: "PUT",
+        pathParams: {
+          entityType,
+        },
+        headers: {
+          "Atlassian-Transfer-Id": atlassianTransferId,
+          "Content-Type": "application/json",
+        },
+        body: entityPropertyDetailses,
+      })
+      .then(commonHttpClient.discardResult);
+  }
+  /**
+   * Returns configurations for workflow transition rules migrated from server to
+   * cloud and owned by the calling Connect app.
+   *
+   * @returns Returned if the request is successful.
+   *
+   * example: {
+   *     "workflowEntityId": "a498d711-685d-428d-8c3e-bc03bb450ea7",
+   *     "invalidRules": [
+   *         "55d44f1d-c859-42e5-9c27-2c5ec3f340b1"
+   *     ],
+   *     "validRules": [
+   *         {
+   *             "workflowId": {
+   *                 "name": "Workflow name",
+   *                 "draft": true
+   *             },
+   *             "postFunctions": [
+   *                 {
+   *                     "id": "123",
+   *                     "key": "WorkflowKey",
+   *                     "configuration": {
+   *                         "value": "WorkflowValidator"
+   *                     },
+   *                     "transition": {
+   *                         "name": "transition",
+   *                         "id": 123
+   *                     }
+   *                 }
+   *             ],
+   *             "conditions": [
+   *                 {
+   *                     "id": "123",
+   *                     "key": "WorkflowKey",
+   *                     "configuration": {
+   *                         "value": "WorkflowValidator"
+   *                     },
+   *                     "transition": {
+   *                         "name": "transition",
+   *                         "id": 123
+   *                     }
+   *                 }
+   *             ],
+   *             "validators": [
+   *                 {
+   *                     "id": "123",
+   *                     "key": "WorkflowKey",
+   *                     "configuration": {
+   *                         "value": "WorkflowValidator"
+   *                     },
+   *                     "transition": {
+   *                         "name": "transition",
+   *                         "id": 123
+   *                     }
+   *                 }
+   *             ]
+   *         }
+   *     ]
+   * }
+   * @path {POST} /rest/atlassian-connect/1/migration/workflow/rule/search
+   */
+  migrationResourceWorkflowRuleSearchPost({
+    atlassianTransferId,
+    workflowRulesSearch,
+  }: {
+    /** The app migration transfer ID. */
+    atlassianTransferId: string;
+    workflowRulesSearch: WorkflowRulesSearch;
+  }): Promise<WorkflowRulesSearchDetails> {
+    return this.getClientInstance()
+      .request({
+        path: "/rest/atlassian-connect/1/migration/workflow/rule/search",
+        method: "POST",
+        headers: {
+          "Atlassian-Transfer-Id": atlassianTransferId,
+          "Content-Type": "application/json",
+        },
+        body: workflowRulesSearch,
+      })
+      .then(
+        this.getClientInstance().responseHandler({
+          200: {
+            "application/json": "json",
+          },
+        }),
+      )
+      .then(
+        commonHttpClient.castResponse<{
+          status: 200;
+          mediaType: "application/json";
+          body: WorkflowRulesSearchDetails;
+        }>(),
+      )
+      .then(
+        validationSchemaStorage.validator(
+          "AppMigrationService.MigrationResource.workflowRuleSearch_post.response",
+        ),
+      )
+      .then(commonHttpClient.getBody);
+  }
+  static initialize() {
+    validationSchemaStorage.registerExtensible(
+      "AppMigrationService.AppIssueFieldValueUpdateResource.updateIssueFields_put.response",
+      z
+        .object({
+          status: z.literal(200),
+          mediaType: z.literal("application/json"),
+          body: z.unknown(),
+        })
+        .describe(
+          "AppMigrationService.AppIssueFieldValueUpdateResource.updateIssueFields_put.response",
+        ),
+    );
+    validationSchemaStorage.registerExtensible(
+      "AppMigrationService.MigrationResource.workflowRuleSearch_post.response",
+      z
+        .object({
+          status: z.literal(200),
+          mediaType: z.literal("application/json"),
+          body: validationSchemaStorage.lazy("WorkflowRulesSearchDetails"),
+        })
+        .describe(
+          "AppMigrationService.MigrationResource.workflowRuleSearch_post.response",
+        ),
+    );
+    validationSchemaStorage.registerOnce([
+      registerAppMigrationValidationSchemas,
+    ]);
+  }
+}