@resolution/jira-api-client 0.4.2 → 0.4.5

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

@@ -29,33 +29,33 @@ export declare class IssueSearchService extends CommonHttpService {
      * @scopes-beta read:issue-details:jira
      * @see https://developer.atlassian.com/cloud/jira/platform/rest/v3/api-group-issue-search#api-rest-api-3-issue-picker-get
      */
-    getIssuePickerResource({ query, currentJql, currentIssueKey, currentProjectId, showSubTasks, showSubTaskParent, }?: {
+    getIssuePickerResource: ({ query, currentJql, currentIssueKey, currentProjectId, showSubTasks, showSubTaskParent, }?: {
         /**
          * A string to match against text fields in the issue such as title, description,
          * or comments.
          */
-        query?: string;
+        query?: string | undefined;
         /**
          * A JQL query defining a list of issues to search for the query term. Note that
          * `username` and `userkey` cannot be used as search terms for this parameter, due
          * to privacy reasons. Use `accountId` instead.
          */
-        currentJql?: string;
+        currentJql?: string | undefined;
         /**
          * The key of an issue to exclude from search results. For example, the issue the
          * user is viewing when they perform this query.
          */
-        currentIssueKey?: string;
+        currentIssueKey?: string | undefined;
         /** The ID of a project that suggested issues must belong to. */
-        currentProjectId?: string;
+        currentProjectId?: string | undefined;
         /** Indicate whether to include subtasks in the suggestions list. */
-        showSubTasks?: boolean;
+        showSubTasks?: boolean | undefined;
         /**
          * When `currentIssueKey` is a subtask, whether to include the parent issue in the
          * suggestions if it matches the query.
          */
-        showSubTaskParent?: boolean;
-    }): Promise<IssuePickerSuggestions>;
+        showSubTaskParent?: boolean | undefined;
+    }) => Promise<IssuePickerSuggestions>;
     /**
      * Checks whether one or more issues would be returned by one or more JQL queries.
      *
@@ -104,7 +104,7 @@ export declare class IssueSearchService extends CommonHttpService {
      * @scopes-beta read:issue-details:jira
      * @see https://developer.atlassian.com/cloud/jira/platform/rest/v3/api-group-issue-search#api-rest-api-3-jql-match-post
      */
-    matchIssues({ issuesAndJqlQueries, }: {
+    matchIssues: ({ issuesAndJqlQueries, }: {
         /**
          * @example {
          *     "issueIds": [
@@ -120,7 +120,7 @@ export declare class IssueSearchService extends CommonHttpService {
          * }
          */
         issuesAndJqlQueries: IssuesAndJqlQueries;
-    }): Promise<IssueMatches>;
+    }) => Promise<IssueMatches>;
     /**
      * Searches for IDs of issues using
      * [JQL](https://confluence.atlassian.com/x/egORLQ).
@@ -158,7 +158,7 @@ export declare class IssueSearchService extends CommonHttpService {
      * read:field:jira, read:group:jira
      * @see https://developer.atlassian.com/cloud/jira/platform/rest/v3/api-group-issue-search#api-rest-api-3-search-id-post
      */
-    searchForIssuesIds({ idSearchRequestBean, }: {
+    searchForIssuesIds: ({ idSearchRequestBean, }: {
         /**
          * A JSON object containing the search request.
          *
@@ -169,7 +169,7 @@ export declare class IssueSearchService extends CommonHttpService {
          * }
          */
         idSearchRequestBean: IdSearchRequestBean;
-    }): Promise<IdSearchResults>;
+    }) => Promise<IdSearchResults>;
     /**
      * Searches for issues using [JQL](https://confluence.atlassian.com/x/egORLQ).
      *
@@ -476,7 +476,7 @@ export declare class IssueSearchService extends CommonHttpService {
      * read:field-configuration:jira, read:issue-meta:jira
      * @see https://developer.atlassian.com/cloud/jira/platform/rest/v3/api-group-issue-search#api-rest-api-3-search-get
      */
-    searchForIssuesUsingJql({ jql, startAt, maxResults, validateQuery, fields, expand, properties, fieldsByKeys, }?: {
+    searchForIssuesUsingJql: ({ jql, startAt, maxResults, validateQuery, fields, expand, properties, fieldsByKeys, }?: {
         /**
          * The [JQL](https://confluence.atlassian.com/x/egORLQ) that defines the search.
          * Note:
@@ -487,16 +487,16 @@ export declare class IssueSearchService extends CommonHttpService {
          *  *  If a user has hidden their email address in their user profile, partial
          * matches of the email address will not find the user. An exact match is required.
          */
-        jql?: string;
+        jql?: string | undefined;
         /** 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. To manage page size, Jira may
          * return fewer items per page where a large number of fields are requested. The
          * greatest number of items returned per page is achieved when requesting `id` or
          * `key` only.
          */
-        maxResults?: number;
+        maxResults?: number | undefined;
         /**
          * Determines how to validate the JQL query and treat the validation results.
          * Supported values are:
@@ -511,7 +511,7 @@ export declare class IssueSearchService extends CommonHttpService {
          * Note: If the JQL is not correctly formed a 400 response code is returned,
          * regardless of the `validateQuery` value.
          */
-        validateQuery?: "strict" | "warn" | "none" | "true" | "false";
+        validateQuery?: "false" | "none" | "strict" | "warn" | "true" | undefined;
         /**
          * A list of fields to return for each issue, use it to retrieve a subset of
          * fields. This parameter accepts a comma-separated list. Expand options include:
@@ -532,7 +532,7 @@ export declare class IssueSearchService extends CommonHttpService {
          * Note: All navigable fields are returned by default. This differs from [GET
          * issue](#api-rest-api-3-issue-issueIdOrKey-get) where the default is all fields.
          */
-        fields?: string[];
+        fields?: string[] | undefined;
         /**
          * Use [expand](#expansion) to include additional information about issues in the
          * response. This parameter accepts a comma-separated list. Expand options include:
@@ -549,7 +549,7 @@ export declare class IssueSearchService extends CommonHttpService {
          * `versionedRepresentations` a JSON array containing each version of a field's
          * value, with the highest numbered item representing the most recent version.
          */
-        expand?: string;
+        expand?: string | undefined;
         /**
          * A list of issue property keys for issue properties to include in the results.
          * This parameter accepts a comma-separated list. Multiple properties can also be
@@ -557,10 +557,10 @@ export declare class IssueSearchService extends CommonHttpService {
          * `properties=prop1,prop2&properties=prop3`. A maximum of 5 issue property keys
          * can be specified.
          */
-        properties?: string[];
+        properties?: string[] | undefined;
         /** Reference fields by their key (rather than ID). */
-        fieldsByKeys?: boolean;
-    }): Promise<SearchResults>;
+        fieldsByKeys?: boolean | undefined;
+    }) => Promise<SearchResults>;
     /**
      * Searches for issues using [JQL](https://confluence.atlassian.com/x/egORLQ).
      *
@@ -867,7 +867,7 @@ export declare class IssueSearchService extends CommonHttpService {
      * read:field:jira, read:group:jira
      * @see https://developer.atlassian.com/cloud/jira/platform/rest/v3/api-group-issue-search#api-rest-api-3-search-post
      */
-    searchForIssuesUsingJqlPost({ searchRequestBean, }: {
+    searchForIssuesUsingJqlPost: ({ searchRequestBean, }: {
         /**
          * A JSON object containing the search request.
          *
@@ -889,6 +889,6 @@ export declare class IssueSearchService extends CommonHttpService {
          * }
          */
         searchRequestBean: SearchRequestBean;
-    }): Promise<SearchResults>;
+    }) => Promise<SearchResults>;
     static initialize(): void;
 }