@resolution/jira-api-client 0.4.2 → 0.4.5

package/lib/openapi/platform/services/ProjectVersionsService.d.ts

@@ -34,7 +34,7 @@ export declare class ProjectVersionsService extends CommonHttpService {
      * @scopes-beta write:issue:jira
      * @see https://developer.atlassian.com/cloud/jira/platform/rest/v3/api-group-project-versions#api-rest-api-3-version-id-relatedwork-post
      */
-    createRelatedWork({ id, versionRelatedWork, }: {
+    createRelatedWork: ({ id, versionRelatedWork, }: {
         id: string;
         /**
          * @example {
@@ -44,7 +44,7 @@ export declare class ProjectVersionsService extends CommonHttpService {
          * }
          */
         versionRelatedWork: VersionRelatedWork;
-    }): Promise<VersionRelatedWork>;
+    }) => Promise<VersionRelatedWork>;
     /**
      * Creates a project version.
      *
@@ -74,7 +74,7 @@ export declare class ProjectVersionsService extends CommonHttpService {
      * @scopes-beta write:project-version:jira, read:project-version:jira
      * @see https://developer.atlassian.com/cloud/jira/platform/rest/v3/api-group-project-versions#api-rest-api-3-version-post
      */
-    createVersion({ version, }: {
+    createVersion: ({ version, }: {
         /**
          * @example {
          *     "archived": false,
@@ -86,7 +86,7 @@ export declare class ProjectVersionsService extends CommonHttpService {
          * }
          */
         version: Version;
-    }): Promise<Version>;
+    }) => Promise<Version>;
     /**
      * Deletes a project version.
      *
@@ -110,11 +110,11 @@ export declare class ProjectVersionsService extends CommonHttpService {
      * @scopes-beta delete:project-version:jira, write:project-version:jira
      * @see https://developer.atlassian.com/cloud/jira/platform/rest/v3/api-group-project-versions#api-rest-api-3-version-id-removeandswap-post
      */
-    deleteAndReplaceVersion({ id, deleteAndReplaceVersionBean, }: {
+    deleteAndReplaceVersion: ({ id, deleteAndReplaceVersionBean, }: {
         /** The ID of the version. */
         id: string;
         deleteAndReplaceVersionBean: DeleteAndReplaceVersionBean;
-    }): Promise<void>;
+    }) => Promise<void>;
     /**
      * Deletes the given related work for the given version.
      *
@@ -130,12 +130,12 @@ export declare class ProjectVersionsService extends CommonHttpService {
      * @scopes-beta write:issue:jira
      * @see https://developer.atlassian.com/cloud/jira/platform/rest/v3/api-group-project-versions#api-rest-api-3-version-versionid-relatedwork-relatedworkid-delete
      */
-    deleteRelatedWork({ versionId, relatedWorkId, }: {
+    deleteRelatedWork: ({ versionId, relatedWorkId, }: {
         /** The ID of the version that the target related work belongs to. */
         versionId: string;
         /** The ID of the related work to delete. */
         relatedWorkId: string;
-    }): Promise<void>;
+    }) => Promise<void>;
     /**
      * Deletes a project version.
      *
@@ -162,7 +162,7 @@ export declare class ProjectVersionsService extends CommonHttpService {
      * @scopes-beta delete:project-version:jira
      * @see https://developer.atlassian.com/cloud/jira/platform/rest/v3/api-group-project-versions#api-rest-api-3-version-id-delete
      */
-    deleteVersion({ id, moveFixIssuesTo, moveAffectedIssuesTo, }: {
+    deleteVersion: ({ id, moveFixIssuesTo, moveAffectedIssuesTo, }: {
         /** The ID of the version. */
         id: string;
         /**
@@ -170,14 +170,14 @@ export declare class ProjectVersionsService extends CommonHttpService {
          * deleted version. The replacement version must be in the same project as the
          * version being deleted and cannot be the version being deleted.
          */
-        moveFixIssuesTo?: string;
+        moveFixIssuesTo?: string | undefined;
         /**
          * The ID of the version to update `affectedVersion` to when the field contains
          * the deleted version. The replacement version must be in the same project as the
          * version being deleted and cannot be the version being deleted.
          */
-        moveAffectedIssuesTo?: string;
-    }): Promise<void>;
+        moveAffectedIssuesTo?: string | undefined;
+    }) => Promise<void>;
     /**
      * Returns all versions in a project. The response is not paginated. Use [Get
      * project versions paginated](#api-rest-api-3-project-projectIdOrKey-version-get)
@@ -229,7 +229,7 @@ export declare class ProjectVersionsService extends CommonHttpService {
      * @scopes-beta read:project-version:jira
      * @see https://developer.atlassian.com/cloud/jira/platform/rest/v3/api-group-project-versions#api-rest-api-3-project-projectidorkey-versions-get
      */
-    getProjectVersions({ projectIdOrKey, expand, }: {
+    getProjectVersions: ({ projectIdOrKey, expand, }: {
         /** The project ID or project key (case sensitive). */
         projectIdOrKey: string;
         /**
@@ -237,8 +237,8 @@ export declare class ProjectVersionsService extends CommonHttpService {
          * This parameter accepts `operations`, which returns actions that can be
          * performed on the version.
          */
-        expand?: string;
-    }): Promise<Version[]>;
+        expand?: string | undefined;
+    }) => Promise<Version[]>;
     /**
      * Returns a [paginated](#pagination) list of all versions in a project. See the
      * [Get project versions](#api-rest-api-3-project-projectIdOrKey-versions-get)
@@ -296,13 +296,13 @@ export declare class ProjectVersionsService extends CommonHttpService {
      * @scopes-beta read:project-version:jira
      * @see https://developer.atlassian.com/cloud/jira/platform/rest/v3/api-group-project-versions#api-rest-api-3-project-projectidorkey-version-get
      */
-    getProjectVersionsPaginated({ projectIdOrKey, startAt, maxResults, orderBy, query, status, expand, }: {
+    getProjectVersionsPaginated: ({ projectIdOrKey, startAt, maxResults, orderBy, query, status, expand, }: {
         /** The project ID or project key (case sensitive). */
         projectIdOrKey: string;
         /** The index of the first item to return in a page of results (page offset). */
-        startAt?: number;
+        startAt?: number | undefined;
         /** The maximum number of items to return per page. */
-        maxResults?: number;
+        maxResults?: number | undefined;
         /**
          * [Order](#ordering) the results by a field:
          *
@@ -314,18 +314,18 @@ export declare class ProjectVersionsService extends CommonHttpService {
          *  *  `startDate` Sorts by start date, starting with the oldest date. Versions
          * with no start date are listed last.
          */
-        orderBy?: "description" | "-description" | "+description" | "name" | "-name" | "+name" | "releaseDate" | "-releaseDate" | "+releaseDate" | "sequence" | "-sequence" | "+sequence" | "startDate" | "-startDate" | "+startDate";
+        orderBy?: "name" | "description" | "sequence" | "releaseDate" | "startDate" | "-description" | "+description" | "-name" | "+name" | "-releaseDate" | "+releaseDate" | "-sequence" | "+sequence" | "-startDate" | "+startDate" | undefined;
         /**
          * Filter the results using a literal string. Versions with matching `name` or
          * `description` are returned (case insensitive).
          */
-        query?: string;
+        query?: string | undefined;
         /**
          * A list of status values used to filter the results by version status. This
          * parameter accepts a comma-separated list. The status values are `released`,
          * `unreleased`, and `archived`.
          */
-        status?: string;
+        status?: string | undefined;
         /**
          * Use [expand](#expansion) to include additional information in the response.
          * This parameter accepts a comma-separated list. Expand options include:
@@ -336,8 +336,8 @@ export declare class ProjectVersionsService extends CommonHttpService {
          *  *  `driver` Returns the Atlassian account ID of the version driver.
          *  *  `approvers` Returns a list containing the approvers for this version.
          */
-        expand?: string;
-    }): Promise<PageBeanVersion>;
+        expand?: string | undefined;
+    }) => Promise<PageBeanVersion>;
     /**
      * Returns related work items for the given version id.
      *
@@ -375,10 +375,10 @@ export declare class ProjectVersionsService extends CommonHttpService {
      * @scopes-beta read:project-version:jira
      * @see https://developer.atlassian.com/cloud/jira/platform/rest/v3/api-group-project-versions#api-rest-api-3-version-id-relatedwork-get
      */
-    getRelatedWork({ id, }: {
+    getRelatedWork: ({ id, }: {
         /** The ID of the version. */
         id: string;
-    }): Promise<VersionRelatedWork[]>;
+    }) => Promise<VersionRelatedWork[]>;
     /**
      * Returns a project version.
      *
@@ -407,7 +407,7 @@ export declare class ProjectVersionsService extends CommonHttpService {
      * @scopes-beta read:project-version:jira
      * @see https://developer.atlassian.com/cloud/jira/platform/rest/v3/api-group-project-versions#api-rest-api-3-version-id-get
      */
-    getVersion({ id, expand, }: {
+    getVersion: ({ id, expand, }: {
         /** The ID of the version. */
         id: string;
         /**
@@ -423,8 +423,8 @@ export declare class ProjectVersionsService extends CommonHttpService {
          *  *  `approvers` Returns a list containing the Atlassian account IDs of
          * approvers for this version.
          */
-        expand?: string;
-    }): Promise<Version>;
+        expand?: string | undefined;
+    }) => Promise<Version>;
     /**
      * Returns the following counts for a version:
      *
@@ -462,10 +462,10 @@ export declare class ProjectVersionsService extends CommonHttpService {
      * @scopes-beta read:field:jira, read:project-version:jira
      * @see https://developer.atlassian.com/cloud/jira/platform/rest/v3/api-group-project-versions#api-rest-api-3-version-id-relatedissuecounts-get
      */
-    getVersionRelatedIssues({ id, }: {
+    getVersionRelatedIssues: ({ id, }: {
         /** The ID of the version. */
         id: string;
-    }): Promise<VersionIssueCounts>;
+    }) => Promise<VersionIssueCounts>;
     /**
      * Returns counts of the issues and unresolved issues for the project version.
      *
@@ -486,10 +486,10 @@ export declare class ProjectVersionsService extends CommonHttpService {
      * @scopes-beta read:project-version:jira
      * @see https://developer.atlassian.com/cloud/jira/platform/rest/v3/api-group-project-versions#api-rest-api-3-version-id-unresolvedissuecount-get
      */
-    getVersionUnresolvedIssues({ id, }: {
+    getVersionUnresolvedIssues: ({ id, }: {
         /** The ID of the version. */
         id: string;
-    }): Promise<VersionUnresolvedIssuesCount>;
+    }) => Promise<VersionUnresolvedIssuesCount>;
     /**
      * Merges two project versions. The merge is completed by deleting the version
      * specified in `id` and replacing any occurrences of its ID in `fixVersion` with
@@ -513,12 +513,12 @@ export declare class ProjectVersionsService extends CommonHttpService {
      * @scopes-beta delete:project-version:jira, write:project-version:jira
      * @see https://developer.atlassian.com/cloud/jira/platform/rest/v3/api-group-project-versions#api-rest-api-3-version-id-mergeto-moveissuesto-put
      */
-    mergeVersions({ id, moveIssuesTo, }: {
+    mergeVersions: ({ id, moveIssuesTo, }: {
         /** The ID of the version to delete. */
         id: string;
         /** The ID of the version to merge into. */
         moveIssuesTo: string;
-    }): Promise<void>;
+    }) => Promise<void>;
     /**
      * Modifies the version's sequence within the project, which affects the display
      * order of the versions in Jira.
@@ -547,7 +547,7 @@ export declare class ProjectVersionsService extends CommonHttpService {
      * @scopes-beta write:project-version:jira, read:project-version:jira
      * @see https://developer.atlassian.com/cloud/jira/platform/rest/v3/api-group-project-versions#api-rest-api-3-version-id-move-post
      */
-    moveVersion({ id, versionMoveBean, }: {
+    moveVersion: ({ id, versionMoveBean, }: {
         /** The ID of the version to be moved. */
         id: string;
         /**
@@ -556,7 +556,7 @@ export declare class ProjectVersionsService extends CommonHttpService {
          * }
          */
         versionMoveBean: VersionMoveBean;
-    }): Promise<Version>;
+    }) => Promise<Version>;
     /**
      * Updates the given related work. You can only update generic link related works
      * via Rest APIs. Any archived version related works can't be edited.
@@ -581,7 +581,7 @@ export declare class ProjectVersionsService extends CommonHttpService {
      * @scopes-beta write:issue:jira
      * @see https://developer.atlassian.com/cloud/jira/platform/rest/v3/api-group-project-versions#api-rest-api-3-version-id-relatedwork-put
      */
-    updateRelatedWork({ id, versionRelatedWork, }: {
+    updateRelatedWork: ({ id, versionRelatedWork, }: {
         /**
          * The ID of the version to update the related work on. For the related work id,
          * pass it to the input JSON.
@@ -596,7 +596,7 @@ export declare class ProjectVersionsService extends CommonHttpService {
          * }
          */
         versionRelatedWork: VersionRelatedWork;
-    }): Promise<VersionRelatedWork>;
+    }) => Promise<VersionRelatedWork>;
     /**
      * Updates a project version.
      *
@@ -626,7 +626,7 @@ export declare class ProjectVersionsService extends CommonHttpService {
      * @scopes-beta write:project-version:jira, read:project-version:jira
      * @see https://developer.atlassian.com/cloud/jira/platform/rest/v3/api-group-project-versions#api-rest-api-3-version-id-put
      */
-    updateVersion({ id, version, }: {
+    updateVersion: ({ id, version, }: {
         /** The ID of the version. */
         id: string;
         /**
@@ -644,6 +644,6 @@ export declare class ProjectVersionsService extends CommonHttpService {
          * }
          */
         version: Version;
-    }): Promise<Version>;
+    }) => Promise<Version>;
     static initialize(): void;
 }