@resolution/jira-api-client 0.1.0

package/lib/openapi/platform/services/server-info-service.js

@@ -0,0 +1,74 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.ServerInfoService = void 0;
+// DO NOT EDIT!
+// This file is generated by "api-typescript-generator".
+// To update this file run "yarn build:openapi".
+const zod_1 = require("zod");
+const commonHttpClient = require("../core/common-http-client");
+const common_http_service_1 = require("../core/common-http-service");
+const server_info_1 = require("../models/server-info");
+const validation_schema_storage_1 = require("../validation-schema-storage");
+/** This resource provides information about the Jira instance. */
+class ServerInfoService extends common_http_service_1.CommonHttpService {
+    /**
+     * Returns information about the Jira instance.
+     *
+     * This operation can be accessed anonymously.
+     *
+     * **[Permissions](#permissions) required:** None.
+     *
+     * @returns Returned if the request is successful.
+     *
+     * example: {
+     *   "baseUrl": "https://your-domain.atlassian.net",
+     *   "buildDate": "2020-03-26T22:20:59.000+0000",
+     *   "buildNumber": 582,
+     *   "defaultLocale": {
+     *     "locale": "en_AU"
+     *   },
+     *   "displayUrl": "https://instance.jira.your-domain.com",
+     *   "displayUrlServicedeskHelpCenter": "https://instance.help.your-domain.com",
+     *   "scmInfo": "1f51473f5c7b75c1a69a0090f4832cdc5053702a",
+     *   "serverTime": "2020-03-31T16:43:50.000+0000",
+     *   "serverTimeZone": "Australia/Sydney",
+     *   "serverTitle": "My Jira instance",
+     *   "version": "1001.0.0-SNAPSHOT",
+     *   "versionNumbers": [
+     *     5,
+     *     0,
+     *     0
+     *   ]
+     * }
+     * @path {GET} /rest/api/3/serverInfo
+     * @scopes-current
+     * @scopes-beta
+     */
+    getServerInfo() {
+        return this.getClientInstance()
+            .request({
+            path: "/rest/api/3/serverInfo",
+            method: "GET",
+        })
+            .then(this.getClientInstance().responseHandler({
+            200: {
+                "application/json": "json",
+            },
+        }))
+            .then(commonHttpClient.castResponse())
+            .then(validation_schema_storage_1.validationSchemaStorage.validator("ServerInfoService.getServerInfo.response"))
+            .then(commonHttpClient.getBody);
+    }
+    static initialize() {
+        validation_schema_storage_1.validationSchemaStorage.registerExtensible("ServerInfoService.getServerInfo.response", zod_1.z
+            .object({
+            status: zod_1.z.literal(200),
+            mediaType: zod_1.z.literal("application/json"),
+            body: validation_schema_storage_1.validationSchemaStorage.lazy("ServerInformation"),
+        })
+            .describe("ServerInfoService.getServerInfo.response"));
+        validation_schema_storage_1.validationSchemaStorage.registerOnce([server_info_1.registerServerInfoValidationSchemas]);
+    }
+}
+exports.ServerInfoService = ServerInfoService;
+//# sourceMappingURL=server-info-service.js.map

package/lib/openapi/platform/services/server-info-service.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"server-info-service.js","sourceRoot":"","sources":["../../../../src/openapi/platform/services/server-info-service.ts"],"names":[],"mappings":";;;AAAA,eAAe;AACf,wDAAwD;AACxD,gDAAgD;AAChD,6BAAwB;AAExB,+DAA+D;AAC/D,qEAAgE;AAChE,uDAG+B;AAC/B,4EAAuE;AACvE,kEAAkE;AAClE,MAAa,iBAAkB,SAAQ,uCAAiB;IACtD;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;OAgCG;IACH,aAAa;QACX,OAAO,IAAI,CAAC,iBAAiB,EAAE;aAC5B,OAAO,CAAC;YACP,IAAI,EAAE,wBAAwB;YAC9B,MAAM,EAAE,KAAK;SACd,CAAC;aACD,IAAI,CACH,IAAI,CAAC,iBAAiB,EAAE,CAAC,eAAe,CAAC;YACvC,GAAG,EAAE;gBACH,kBAAkB,EAAE,MAAM;aAC3B;SACF,CAAC,CACH;aACA,IAAI,CACH,gBAAgB,CAAC,YAAY,EAIzB,CACL;aACA,IAAI,CACH,mDAAuB,CAAC,SAAS,CAC/B,0CAA0C,CAC3C,CACF;aACA,IAAI,CAAC,gBAAgB,CAAC,OAAO,CAAC,CAAC;IACpC,CAAC;IACD,MAAM,CAAC,UAAU;QACf,mDAAuB,CAAC,kBAAkB,CACxC,0CAA0C,EAC1C,OAAC;aACE,MAAM,CAAC;YACN,MAAM,EAAE,OAAC,CAAC,OAAO,CAAC,GAAG,CAAC;YACtB,SAAS,EAAE,OAAC,CAAC,OAAO,CAAC,kBAAkB,CAAC;YACxC,IAAI,EAAE,mDAAuB,CAAC,IAAI,CAAC,mBAAmB,CAAC;SACxD,CAAC;aACD,QAAQ,CAAC,0CAA0C,CAAC,CACxD,CAAC;QACF,mDAAuB,CAAC,YAAY,CAAC,CAAC,iDAAmC,CAAC,CAAC,CAAC;IAC9E,CAAC;CACF;AA1ED,8CA0EC"}

package/lib/openapi/platform/services/service-registry-service.d.ts

@@ -0,0 +1,32 @@
+import { CommonHttpService } from "../core/common-http-service";
+import { type ServiceRegistry } from "../models/service-registry";
+/**
+ * This resource represents a service registry. Use it to retrieve attributes
+ * related to a [service
+ * registry](https://support.atlassian.com/jira-service-management-cloud/docs/what-is-services/)
+ * in JSM.
+ */
+export declare class ServiceRegistryService extends CommonHttpService {
+    /**
+     * Retrieve the attributes of given service registries.
+     *
+     * **[Permissions](#permissions) required:** Only Connect apps can make this
+     * request and the servicesIds belong to the tenant you are requesting
+     *
+     * @returns Returned if the request is successful.
+     * @path {GET} /rest/atlassian-connect/1/service-registry
+     */
+    serviceRegistryResourceServicesGet({ serviceIds, }: {
+        /**
+         * The ID of the services (the strings starting with "b:" need to be decoded in
+         * Base64).
+         *
+         * @example [
+         *   "ari:cloud:graph::service/ca075ed7-6ea7-4563-acb3-000000000000/f51d7252-61e0-11ee-b94d-000000000000",
+         *   "ari:cloud:graph::service/ca075ed7-6ea7-4563-acb3-000000000000/f51d7252-61e0-11ee-b94d-000000000001"
+         * ]
+         */
+        serviceIds: string[];
+    }): Promise<ServiceRegistry[]>;
+    static initialize(): void;
+}

package/lib/openapi/platform/services/service-registry-service.js

@@ -0,0 +1,60 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.ServiceRegistryService = void 0;
+// DO NOT EDIT!
+// This file is generated by "api-typescript-generator".
+// To update this file run "yarn build:openapi".
+const zod_1 = require("zod");
+const commonHttpClient = require("../core/common-http-client");
+const common_http_service_1 = require("../core/common-http-service");
+const service_registry_1 = require("../models/service-registry");
+const validation_schema_storage_1 = require("../validation-schema-storage");
+/**
+ * This resource represents a service registry. Use it to retrieve attributes
+ * related to a [service
+ * registry](https://support.atlassian.com/jira-service-management-cloud/docs/what-is-services/)
+ * in JSM.
+ */
+class ServiceRegistryService extends common_http_service_1.CommonHttpService {
+    /**
+     * Retrieve the attributes of given service registries.
+     *
+     * **[Permissions](#permissions) required:** Only Connect apps can make this
+     * request and the servicesIds belong to the tenant you are requesting
+     *
+     * @returns Returned if the request is successful.
+     * @path {GET} /rest/atlassian-connect/1/service-registry
+     */
+    serviceRegistryResourceServicesGet({ serviceIds, }) {
+        return this.getClientInstance()
+            .request({
+            path: "/rest/atlassian-connect/1/service-registry",
+            method: "GET",
+            query: {
+                serviceIds,
+            },
+        })
+            .then(this.getClientInstance().responseHandler({
+            200: {
+                "application/json": "json",
+            },
+        }))
+            .then(commonHttpClient.castResponse())
+            .then(validation_schema_storage_1.validationSchemaStorage.validator("ServiceRegistryService.ServiceRegistryResource.services_get.response"))
+            .then(commonHttpClient.getBody);
+    }
+    static initialize() {
+        validation_schema_storage_1.validationSchemaStorage.registerExtensible("ServiceRegistryService.ServiceRegistryResource.services_get.response", zod_1.z
+            .object({
+            status: zod_1.z.literal(200),
+            mediaType: zod_1.z.literal("application/json"),
+            body: zod_1.z.array(validation_schema_storage_1.validationSchemaStorage.lazy("ServiceRegistry")),
+        })
+            .describe("ServiceRegistryService.ServiceRegistryResource.services_get.response"));
+        validation_schema_storage_1.validationSchemaStorage.registerOnce([
+            service_registry_1.registerServiceRegistryValidationSchemas,
+        ]);
+    }
+}
+exports.ServiceRegistryService = ServiceRegistryService;
+//# sourceMappingURL=service-registry-service.js.map

package/lib/openapi/platform/services/service-registry-service.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"service-registry-service.js","sourceRoot":"","sources":["../../../../src/openapi/platform/services/service-registry-service.ts"],"names":[],"mappings":";;;AAAA,eAAe;AACf,wDAAwD;AACxD,gDAAgD;AAChD,6BAAwB;AAExB,+DAA+D;AAC/D,qEAAgE;AAChE,iEAGoC;AACpC,4EAAuE;AACvE;;;;;GAKG;AACH,MAAa,sBAAuB,SAAQ,uCAAiB;IAC3D;;;;;;;;OAQG;IACH,kCAAkC,CAAC,EACjC,UAAU,GAYX;QACC,OAAO,IAAI,CAAC,iBAAiB,EAAE;aAC5B,OAAO,CAAC;YACP,IAAI,EAAE,4CAA4C;YAClD,MAAM,EAAE,KAAK;YACb,KAAK,EAAE;gBACL,UAAU;aACX;SACF,CAAC;aACD,IAAI,CACH,IAAI,CAAC,iBAAiB,EAAE,CAAC,eAAe,CAAC;YACvC,GAAG,EAAE;gBACH,kBAAkB,EAAE,MAAM;aAC3B;SACF,CAAC,CACH;aACA,IAAI,CACH,gBAAgB,CAAC,YAAY,EAIzB,CACL;aACA,IAAI,CACH,mDAAuB,CAAC,SAAS,CAC/B,sEAAsE,CACvE,CACF;aACA,IAAI,CAAC,gBAAgB,CAAC,OAAO,CAAC,CAAC;IACpC,CAAC;IACD,MAAM,CAAC,UAAU;QACf,mDAAuB,CAAC,kBAAkB,CACxC,sEAAsE,EACtE,OAAC;aACE,MAAM,CAAC;YACN,MAAM,EAAE,OAAC,CAAC,OAAO,CAAC,GAAG,CAAC;YACtB,SAAS,EAAE,OAAC,CAAC,OAAO,CAAC,kBAAkB,CAAC;YACxC,IAAI,EAAE,OAAC,CAAC,KAAK,CAAC,mDAAuB,CAAC,IAAI,CAAC,iBAAiB,CAAC,CAAC;SAC/D,CAAC;aACD,QAAQ,CACP,sEAAsE,CACvE,CACJ,CAAC;QACF,mDAAuB,CAAC,YAAY,CAAC;YACnC,2DAAwC;SACzC,CAAC,CAAC;IACL,CAAC;CACF;AAtED,wDAsEC"}

package/lib/openapi/platform/services/status-service.d.ts

@@ -0,0 +1,268 @@
+import { CommonHttpService } from "../core/common-http-service";
+import { type JiraStatus, type PageOfStatuses, type StatusCreateRequest, type StatusUpdateRequest } from "../models/status";
+/**
+ * This resource represents statuses. Use it to search, get, create, delete, and
+ * change statuses.
+ */
+export declare class StatusService extends CommonHttpService {
+    /**
+     * Creates statuses for a global or project scope.
+     *
+     * **[Permissions](#permissions) required:**
+     *
+     *  *  *Administer projects* [project
+     * permission.](https://confluence.atlassian.com/x/yodKLg)
+     *  *  *Administer Jira* [project
+     * permission.](https://confluence.atlassian.com/x/yodKLg)
+     *
+     * @returns Returned if the request is successful.
+     *
+     * example: [
+     *   {
+     *     "description": "The issue is resolved",
+     *     "id": "1000",
+     *     "name": "Finished",
+     *     "scope": {
+     *       "project": {
+     *         "id": "1"
+     *       },
+     *       "type": "PROJECT"
+     *     },
+     *     "statusCategory": "DONE",
+     *     "usages": [],
+     *     "workflowUsages": []
+     *   }
+     * ]
+     * @path {POST} /rest/api/3/statuses
+     * @scopes-current manage:jira-configuration
+     * @scopes-beta write:workflow:jira
+     */
+    createStatuses({ statusCreateRequest, }: {
+        /**
+         * Details of the statuses being created and their scope.
+         *
+         * @example {
+         *     "scope": {
+         *         "project": {
+         *             "id": "1"
+         *         },
+         *         "type": "PROJECT"
+         *     },
+         *     "statuses": [
+         *         {
+         *             "description": "The issue is resolved",
+         *             "name": "Finished",
+         *             "statusCategory": "DONE"
+         *         }
+         *     ]
+         * }
+         */
+        statusCreateRequest: StatusCreateRequest;
+    }): Promise<JiraStatus[]>;
+    /**
+     * Deletes statuses by ID.
+     *
+     * **[Permissions](#permissions) required:**
+     *
+     *  *  *Administer projects* [project
+     * permission.](https://confluence.atlassian.com/x/yodKLg)
+     *  *  *Administer Jira* [project
+     * permission.](https://confluence.atlassian.com/x/yodKLg)
+     *
+     * @returns Returned if the request is successful.
+     * @path {DELETE} /rest/api/3/statuses
+     * @scopes-current manage:jira-configuration
+     * @scopes-beta write:workflow:jira
+     */
+    deleteStatusesById({ id, }: {
+        /**
+         * The list of status IDs. To include multiple IDs, provide an ampersand-separated
+         * list. For example, id=10000&id=10001.
+         *
+         * Min items `1`, Max items `50`
+         */
+        id: string[];
+    }): Promise<void>;
+    /**
+     * Returns a list of the statuses specified by one or more status IDs.
+     *
+     * **[Permissions](#permissions) required:**
+     *
+     *  *  *Administer projects* [project
+     * permission.](https://confluence.atlassian.com/x/yodKLg)
+     *  *  *Administer Jira* [project
+     * permission.](https://confluence.atlassian.com/x/yodKLg)
+     *
+     * @returns Returned if the request is successful.
+     *
+     * example: [
+     *   {
+     *     "description": "The issue is resolved",
+     *     "id": "1000",
+     *     "name": "Finished",
+     *     "scope": {
+     *       "project": {
+     *         "id": "1"
+     *       },
+     *       "type": "PROJECT"
+     *     },
+     *     "statusCategory": "DONE",
+     *     "usages": [
+     *       {
+     *         "issueTypes": [
+     *           "10002"
+     *         ],
+     *         "project": {
+     *           "id": "1"
+     *         }
+     *       }
+     *     ],
+     *     "workflowUsages": [
+     *       {
+     *         "workflowId": "545d80a3-91ff-4949-8b0d-a2bc484e70e5",
+     *         "workflowName": "Workflow 1"
+     *       }
+     *     ]
+     *   }
+     * ]
+     * @path {GET} /rest/api/3/statuses
+     * @scopes-current manage:jira-configuration
+     * @scopes-beta read:workflow:jira
+     */
+    getStatusesById({ expand, id, }: {
+        /**
+         * Use [expand](#expansion) to include additional information in the response.
+         * This parameter accepts a comma-separated list. Expand options include:
+         *
+         *  *  `usages` Returns the project and issue types that use the status in their
+         * workflow.
+         *  *  `workflowUsages` Returns the workflows that use the status.
+         */
+        expand?: string;
+        /**
+         * The list of status IDs. To include multiple IDs, provide an ampersand-separated
+         * list. For example, id=10000&id=10001.
+         *
+         * Min items `1`, Max items `50`
+         */
+        id: string[];
+    }): Promise<JiraStatus[]>;
+    /**
+     * Returns a
+     * [paginated](https://developer.atlassian.com/cloud/jira/platform/rest/v3/intro/#pagination)
+     * list of statuses that match a search on name or project.
+     *
+     * **[Permissions](#permissions) required:**
+     *
+     *  *  *Administer projects* [project
+     * permission.](https://confluence.atlassian.com/x/yodKLg)
+     *  *  *Administer Jira* [project
+     * permission.](https://confluence.atlassian.com/x/yodKLg)
+     *
+     * @returns Returned if the request is successful.
+     *
+     * example: {
+     *   "isLast": true,
+     *   "maxResults": 2,
+     *   "nextPage":
+     * "https://your-domain.atlassian.net/rest/api/3/statuses/search?startAt=2&maxResults=2",
+     *   "self":
+     * "https://your-domain.atlassian.net/rest/api/3/statuses/search?startAt=0&maxResults=2",
+     *   "startAt": 0,
+     *   "total": 5,
+     *   "values": [
+     *     {
+     *       "description": "The issue is resolved",
+     *       "id": "1000",
+     *       "name": "Finished",
+     *       "scope": {
+     *         "project": {
+     *           "id": "1"
+     *         },
+     *         "type": "PROJECT"
+     *       },
+     *       "statusCategory": "DONE",
+     *       "usages": [
+     *         {
+     *           "issueTypes": [
+     *             "10002"
+     *           ],
+     *           "project": {
+     *             "id": "1"
+     *           }
+     *         }
+     *       ],
+     *       "workflowUsages": [
+     *         {
+     *           "workflowId": "545d80a3-91ff-4949-8b0d-a2bc484e70e5",
+     *           "workflowName": "Workflow 1"
+     *         }
+     *       ]
+     *     }
+     *   ]
+     * }
+     * @path {GET} /rest/api/3/statuses/search
+     * @scopes-current manage:jira-configuration
+     * @scopes-beta read:workflow:jira
+     */
+    search({ expand, projectId, startAt, maxResults, searchString, statusCategory, }: {
+        /**
+         * Use [expand](#expansion) to include additional information in the response.
+         * This parameter accepts a comma-separated list. Expand options include:
+         *
+         *  *  `usages` Returns the project and issue types that use the status in their
+         * workflow.
+         *  *  `workflowUsages` Returns the workflows that use the status.
+         */
+        expand?: string;
+        /** The project the status is part of or null for global statuses. */
+        projectId?: string;
+        /** 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;
+        /**
+         * Term to match status names against or null to search for all statuses in the
+         * search scope.
+         */
+        searchString?: string;
+        /**
+         * Category of the status to filter by. The supported values are: `TODO`,
+         * `IN_PROGRESS`, and `DONE`.
+         */
+        statusCategory?: string;
+    }): Promise<PageOfStatuses>;
+    /**
+     * Updates statuses by ID.
+     *
+     * **[Permissions](#permissions) required:**
+     *
+     *  *  *Administer projects* [project
+     * permission.](https://confluence.atlassian.com/x/yodKLg)
+     *  *  *Administer Jira* [project
+     * permission.](https://confluence.atlassian.com/x/yodKLg)
+     *
+     * @returns Returned if the request is successful.
+     * @path {PUT} /rest/api/3/statuses
+     * @scopes-current manage:jira-configuration
+     * @scopes-beta write:workflow:jira
+     */
+    updateStatuses({ statusUpdateRequest, }: {
+        /**
+         * The list of statuses that will be updated.
+         *
+         * @example {
+         *     "statuses": [
+         *         {
+         *             "description": "The issue is resolved",
+         *             "id": "1000",
+         *             "name": "Finished",
+         *             "statusCategory": "DONE"
+         *         }
+         *     ]
+         * }
+         */
+        statusUpdateRequest: StatusUpdateRequest;
+    }): Promise<void>;
+    static initialize(): void;
+}