@resolution/jira-api-client 0.4.2 → 0.4.5

package/lib/openapi/software/services/SprintService.d.ts

@@ -30,7 +30,7 @@ export declare class SprintService extends CommonHttpService {
      * @path {POST} /rest/agile/1.0/sprint
      * @see https://developer.atlassian.com/cloud/jira/software/rest/api-group-sprint#api-rest-agile-1-0-sprint-post
      */
-    createSprint({ sprintCreateBean, }: {
+    createSprint: ({ sprintCreateBean, }: {
         /**
          * @example {
          *     "endDate": "2015-04-20T01:22:00.000+10:00",
@@ -41,7 +41,7 @@ export declare class SprintService extends CommonHttpService {
          * }
          */
         sprintCreateBean: SprintCreateBean;
-    }): Promise<unknown>;
+    }) => Promise<unknown>;
     /**
      * Removes the property from the sprint identified by the id. Ths user removing
      * the property is required to have permissions to modify the sprint.
@@ -49,12 +49,12 @@ export declare class SprintService extends CommonHttpService {
      * @path {DELETE} /rest/agile/1.0/sprint/{sprintId}/properties/{propertyKey}
      * @see https://developer.atlassian.com/cloud/jira/software/rest/api-group-sprint#api-rest-agile-1-0-sprint-sprintid-properties-propertykey-delete
      */
-    deleteProperty({ sprintId, propertyKey, }: {
+    deleteProperty: ({ sprintId, propertyKey, }: {
         /** the ID of the sprint from which the property will be removed. */
         sprintId: string;
         /** the key of the property to remove. */
         propertyKey: string;
-    }): Promise<void>;
+    }) => Promise<void>;
     /**
      * Deletes a sprint. Once a sprint is deleted, all open issues in the sprint will
      * be moved to the backlog.
@@ -62,10 +62,10 @@ export declare class SprintService extends CommonHttpService {
      * @path {DELETE} /rest/agile/1.0/sprint/{sprintId}
      * @see https://developer.atlassian.com/cloud/jira/software/rest/api-group-sprint#api-rest-agile-1-0-sprint-sprintid-delete
      */
-    deleteSprint({ sprintId, }: {
+    deleteSprint: ({ sprintId, }: {
         /** The ID of the sprint to delete. */
         sprintId: number;
-    }): Promise<void>;
+    }) => Promise<void>;
     /**
      * Returns all issues in a sprint, for a given sprint ID. This only includes
      * issues that the user has permission to view. By default, the returned issues
@@ -245,44 +245,44 @@ export declare class SprintService extends CommonHttpService {
      * @path {GET} /rest/agile/1.0/sprint/{sprintId}/issue
      * @see https://developer.atlassian.com/cloud/jira/software/rest/api-group-sprint#api-rest-agile-1-0-sprint-sprintid-issue-get
      */
-    getIssuesForSprint({ sprintId, startAt, maxResults, jql, validateQuery, fields, expand, }: {
+    getIssuesForSprint: ({ sprintId, startAt, maxResults, jql, validateQuery, fields, expand, }: {
         /** The ID of the sprint that contains the requested issues. */
         sprintId: number;
         /**
          * The starting index of the returned issues. Base index: 0. See the 'Pagination'
          * section at the top of this page for more details.
          */
-        startAt?: number;
+        startAt?: number | undefined;
         /**
          * The maximum number of issues to return per page. See the 'Pagination' section
          * at the top of this page for more details. Note, the total number of issues
          * returned is limited by the property 'jira.search.views.default.max' in your
          * Jira instance. If you exceed this limit, your results will be truncated.
          */
-        maxResults?: number;
+        maxResults?: number | undefined;
         /**
          * Filters results using a JQL query. If you define an order in your JQL query, it
          * will override the default order of the returned issues.
          * Note that `username` and `userkey` can't be used as search terms for this
          * parameter due to privacy reasons. Use `accountId` instead.
          */
-        jql?: string;
+        jql?: string | undefined;
         /** Specifies whether to validate the JQL query or not. Default: true. */
-        validateQuery?: boolean;
+        validateQuery?: boolean | undefined;
         /**
          * The list of fields to return for each issue. By default, all navigable and
          * Agile fields are returned.
          */
-        fields?: {}[];
+        fields?: {}[] | undefined;
         /** A comma-separated list of the parameters to expand. */
-        expand?: string;
-    }): Promise<{
+        expand?: string | undefined;
+    }) => Promise<{
         issues: IssueBean[];
-        expand?: string;
+        expand?: string | undefined;
         maxResults: number;
         startAt: number;
-        total?: number;
-        isLast?: boolean;
+        total?: number | undefined;
+        isLast?: boolean | undefined;
     } & {
         [key: string]: unknown;
     }>;
@@ -305,10 +305,10 @@ export declare class SprintService extends CommonHttpService {
      * @path {GET} /rest/agile/1.0/sprint/{sprintId}/properties
      * @see https://developer.atlassian.com/cloud/jira/software/rest/api-group-sprint#api-rest-agile-1-0-sprint-sprintid-properties-get
      */
-    getPropertiesKeys({ sprintId, }: {
+    getPropertiesKeys: ({ sprintId, }: {
         /** the ID of the sprint from which property keys will be returned. */
         sprintId: string;
-    }): Promise<unknown>;
+    }) => Promise<unknown>;
     /**
      * Returns the value of the property with a given key from the sprint identified
      * by the provided id. The user who retrieves the property is required to have
@@ -326,12 +326,12 @@ export declare class SprintService extends CommonHttpService {
      * @path {GET} /rest/agile/1.0/sprint/{sprintId}/properties/{propertyKey}
      * @see https://developer.atlassian.com/cloud/jira/software/rest/api-group-sprint#api-rest-agile-1-0-sprint-sprintid-properties-propertykey-get
      */
-    getProperty({ sprintId, propertyKey, }: {
+    getProperty: ({ sprintId, propertyKey, }: {
         /** the ID of the sprint from which the property will be returned. */
         sprintId: string;
         /** the key of the property to return. */
         propertyKey: string;
-    }): Promise<unknown>;
+    }) => Promise<unknown>;
     /**
      * Returns the sprint for a given sprint ID. The sprint will only be returned if
      * the user can view the board that the sprint was created on, or view at least
@@ -353,10 +353,10 @@ export declare class SprintService extends CommonHttpService {
      * @path {GET} /rest/agile/1.0/sprint/{sprintId}
      * @see https://developer.atlassian.com/cloud/jira/software/rest/api-group-sprint#api-rest-agile-1-0-sprint-sprintid-get
      */
-    getSprint({ sprintId, }: {
+    getSprint: ({ sprintId, }: {
         /** The ID of the requested sprint. */
         sprintId: number;
-    }): Promise<unknown>;
+    }) => Promise<unknown>;
     /**
      * Moves issues to a sprint, for a given sprint ID. Issues can only be moved to
      * open or active sprints. The maximum number of issues that can be moved in one
@@ -365,7 +365,7 @@ export declare class SprintService extends CommonHttpService {
      * @path {POST} /rest/agile/1.0/sprint/{sprintId}/issue
      * @see https://developer.atlassian.com/cloud/jira/software/rest/api-group-sprint#api-rest-agile-1-0-sprint-sprintid-issue-post
      */
-    moveIssuesToSprintAndRank({ sprintId, issueRankRequestBean, }: {
+    moveIssuesToSprintAndRank: ({ sprintId, issueRankRequestBean, }: {
         /** The ID of the sprint that you want to assign issues to. */
         sprintId: number;
         /**
@@ -380,7 +380,7 @@ export declare class SprintService extends CommonHttpService {
          * }
          */
         issueRankRequestBean: IssueRankRequestBean;
-    }): Promise<void>;
+    }) => Promise<void>;
     /**
      * Performs a partial update of a sprint. A partial update means that fields not
      * present in the request JSON will not be updated.
@@ -413,7 +413,7 @@ export declare class SprintService extends CommonHttpService {
      * @path {POST} /rest/agile/1.0/sprint/{sprintId}
      * @see https://developer.atlassian.com/cloud/jira/software/rest/api-group-sprint#api-rest-agile-1-0-sprint-sprintid-post
      */
-    partiallyUpdateSprint({ sprintId, sprintBean, }: {
+    partiallyUpdateSprint: ({ sprintId, sprintBean, }: {
         /** The ID of the sprint to update. */
         sprintId: number;
         /**
@@ -422,7 +422,7 @@ export declare class SprintService extends CommonHttpService {
          * }
          */
         sprintBean: SprintBean;
-    }): Promise<unknown>;
+    }) => Promise<unknown>;
     /**
      * Sets the value of the specified sprint's property.
      *
@@ -440,7 +440,7 @@ export declare class SprintService extends CommonHttpService {
      * @path {PUT} /rest/agile/1.0/sprint/{sprintId}/properties/{propertyKey}
      * @see https://developer.atlassian.com/cloud/jira/software/rest/api-group-sprint#api-rest-agile-1-0-sprint-sprintid-properties-propertykey-put
      */
-    setProperty({ sprintId, propertyKey, requestBody, }: {
+    setProperty: ({ sprintId, propertyKey, requestBody, }: {
         /** the ID of the sprint on which the property will be set. */
         sprintId: string;
         /** the key of the sprint's property. The maximum length of the key is 255 bytes. */
@@ -451,7 +451,7 @@ export declare class SprintService extends CommonHttpService {
          * property value is 32768 bytes.
          */
         requestBody: unknown;
-    }): Promise<{
+    }) => Promise<{
         created: boolean;
         body: unknown;
     }>;
@@ -461,7 +461,7 @@ export declare class SprintService extends CommonHttpService {
      * @path {POST} /rest/agile/1.0/sprint/{sprintId}/swap
      * @see https://developer.atlassian.com/cloud/jira/software/rest/api-group-sprint#api-rest-agile-1-0-sprint-sprintid-swap-post
      */
-    swapSprint({ sprintId, sprintSwapBean, }: {
+    swapSprint: ({ sprintId, sprintSwapBean, }: {
         /** The ID of the sprint to swap. */
         sprintId: number;
         /**
@@ -470,7 +470,7 @@ export declare class SprintService extends CommonHttpService {
          * }
          */
         sprintSwapBean: SprintSwapBean;
-    }): Promise<void>;
+    }) => Promise<void>;
     /**
      * Performs a full update of a sprint. A full update means that the result will be
      * exactly the same as the request body. Any fields not present in the request
@@ -504,7 +504,7 @@ export declare class SprintService extends CommonHttpService {
      * @path {PUT} /rest/agile/1.0/sprint/{sprintId}
      * @see https://developer.atlassian.com/cloud/jira/software/rest/api-group-sprint#api-rest-agile-1-0-sprint-sprintid-put
      */
-    updateSprint({ sprintId, sprintBean, }: {
+    updateSprint: ({ sprintId, sprintBean, }: {
         /** the ID of the sprint to update. */
         sprintId: number;
         /**
@@ -518,6 +518,6 @@ export declare class SprintService extends CommonHttpService {
          * }
          */
         sprintBean: SprintBean;
-    }): Promise<unknown>;
+    }) => Promise<unknown>;
     static initialize(): void;
 }