@resolution/jira-api-client 0.7.11 → 0.11.0

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

@@ -1,6 +1,6 @@
 import { CommonHttpService } from "../../core/CommonHttpService";
 import { type ColumnItem, type ColumnRequestBody } from "../models/common";
-import { type ChangeFilterOwner, type Filter, type PageBeanFilterDetails } from "../models/filters";
+import { type Filter, type ChangeFilterOwner, type PageBeanFilterDetails } from "../models/filters";
 /**
  * This resource represents [filters](https://confluence.atlassian.com/x/eQiiLQ).
  * Use it to get, create, update, or delete filters. Also use it to configure the
@@ -24,7 +24,7 @@ export declare class FiltersService extends CommonHttpService {
      * @see https://developer.atlassian.com/cloud/jira/platform/rest/v3/api-group-filters#api-rest-api-3-filter-id-owner-put
      * @param params
      */
-    changeFilterOwner: ({ id, changeFilterOwner, }: {
+    changeFilterOwner: ({ id, changeFilterOwner }: {
         /** The ID of the filter to update. */
         id: number;
         /**
@@ -32,7 +32,7 @@ export declare class FiltersService extends CommonHttpService {
          *
          * @example
          * {
-         *     "accountId": "0000-0000-0000-0000"
+         *   "accountId": "0000-0000-0000-0000"
          * }
          */
         changeFilterOwner: ChangeFilterOwner;
@@ -89,7 +89,7 @@ export declare class FiltersService extends CommonHttpService {
      * @see https://developer.atlassian.com/cloud/jira/platform/rest/v3/api-group-filters#api-rest-api-3-filter-post
      * @param params
      */
-    createFilter: ({ expand, overrideSharePermissions, filter, }: {
+    createFilter: ({ expand, overrideSharePermissions, filter }: {
         /**
          * Use [expand](#expansion) to include additional information about filter in the
          * response. This parameter accepts a comma-separated list. Expand options include:
@@ -120,9 +120,9 @@ export declare class FiltersService extends CommonHttpService {
          *
          * @example
          * {
-         *     "description": "Lists all open bugs",
-         *     "jql": "type = Bug and resolution is empty",
-         *     "name": "All Open Bugs"
+         *   "description": "Lists all open bugs",
+         *   "jql": "type = Bug and resolution is empty",
+         *   "name": "All Open Bugs"
          * }
          */
         filter: Filter;
@@ -182,7 +182,7 @@ export declare class FiltersService extends CommonHttpService {
      * @see https://developer.atlassian.com/cloud/jira/platform/rest/v3/api-group-filters#api-rest-api-3-filter-id-favourite-delete
      * @param params
      */
-    deleteFavouriteForFilter: ({ id, expand, }: {
+    deleteFavouriteForFilter: ({ id, expand }: {
         /** The ID of the filter. */
         id: number;
         /**
@@ -219,7 +219,7 @@ export declare class FiltersService extends CommonHttpService {
      * @see https://developer.atlassian.com/cloud/jira/platform/rest/v3/api-group-filters#api-rest-api-3-filter-id-delete
      * @param params
      */
-    deleteFilter: ({ id, }: {
+    deleteFilter: ({ id }: {
         /** The ID of the filter to delete. */
         id: number;
     }) => Promise<void>;
@@ -243,6 +243,7 @@ export declare class FiltersService extends CommonHttpService {
      * @returns Returned if the request is successful.
      *
      * example:
+     *
      * ```
      * [
      *   {
@@ -255,13 +256,14 @@ export declare class FiltersService extends CommonHttpService {
      *   }
      * ]
      * ```
+     *
      * @path GET `/rest/api/3/filter/{id}/columns`
      * @scopes-current read:jira-work
      * @scopes-beta read:filter.column:jira
      * @see https://developer.atlassian.com/cloud/jira/platform/rest/v3/api-group-filters#api-rest-api-3-filter-id-columns-get
      * @param params
      */
-    getColumns: ({ id, }: {
+    getColumns: ({ id }: {
         /** The ID of the filter. */
         id: number;
     }) => Promise<ColumnItem[]>;
@@ -286,6 +288,7 @@ export declare class FiltersService extends CommonHttpService {
      * @returns Returned if the request is successful.
      *
      * example:
+     *
      * ```
      * [
      *   {
@@ -393,13 +396,14 @@ export declare class FiltersService extends CommonHttpService {
      *   }
      * ]
      * ```
+     *
      * @path GET `/rest/api/3/filter/favourite`
      * @scopes-current read:jira-work
      * @scopes-beta read:filter:jira, read:group:jira, read:project:jira, read:project-role:jira, read:user:jira, read:jql:jira, read:application-role:jira, read:avatar:jira, read:issue-type-hierarchy:jira
      * @see https://developer.atlassian.com/cloud/jira/platform/rest/v3/api-group-filters#api-rest-api-3-filter-favourite-get
      * @param params
      */
-    getFavouriteFilters: ({ expand, }?: {
+    getFavouriteFilters: ({ expand }?: {
         /**
          * Use [expand](#expansion) to include additional information about filter in the
          * response. This parameter accepts a comma-separated list. Expand options include:
@@ -481,7 +485,7 @@ export declare class FiltersService extends CommonHttpService {
      * @see https://developer.atlassian.com/cloud/jira/platform/rest/v3/api-group-filters#api-rest-api-3-filter-id-get
      * @param params
      */
-    getFilter: ({ id, expand, overrideSharePermissions, }: {
+    getFilter: ({ id, expand, overrideSharePermissions }: {
         /** The ID of the filter to return. */
         id: number;
         /**
@@ -765,7 +769,7 @@ export declare class FiltersService extends CommonHttpService {
      * @see https://developer.atlassian.com/cloud/jira/platform/rest/v3/api-group-filters#api-rest-api-3-filter-search-get
      * @param params
      */
-    getFiltersPaginated: ({ filterName, accountId, owner, groupname, groupId, projectId, id, orderBy, startAt, maxResults, expand, overrideSharePermissions, }?: {
+    getFiltersPaginated: ({ filterName, accountId, owner, groupname, groupId, projectId, id, orderBy, startAt, maxResults, expand, overrideSharePermissions, isSubstringMatch }?: {
         /** String used to perform a case-insensitive partial match with `name`. */
         filterName?: string | undefined;
         /**
@@ -850,6 +854,13 @@ export declare class FiltersService extends CommonHttpService {
          * [global permission](https://confluence.atlassian.com/x/x4dKLg).
          */
         overrideSharePermissions?: boolean | undefined;
+        /**
+         * When `true` this will perform a case-insensitive substring match for the
+         * provided `filterName`. When `false` the filter name will be searched using
+         * [full text search
+         * syntax](https://support.atlassian.com/jira-software-cloud/docs/search-for-issues-using-the-text-field/).
+         */
+        isSubstringMatch?: boolean | undefined;
     }) => Promise<PageBeanFilterDetails>;
     /**
      * Returns the filters owned by the user. If `includeFavourites` is `true`, the
@@ -871,6 +882,7 @@ export declare class FiltersService extends CommonHttpService {
      * @returns Returned if the request is successful.
      *
      * example:
+     *
      * ```
      * [
      *   {
@@ -978,13 +990,14 @@ export declare class FiltersService extends CommonHttpService {
      *   }
      * ]
      * ```
+     *
      * @path GET `/rest/api/3/filter/my`
      * @scopes-current read:jira-work
      * @scopes-beta read:filter:jira, read:group:jira, read:project:jira, read:project-role:jira, read:user:jira, read:jql:jira, read:application-role:jira, read:avatar:jira, read:issue-type-hierarchy:jira
      * @see https://developer.atlassian.com/cloud/jira/platform/rest/v3/api-group-filters#api-rest-api-3-filter-my-get
      * @param params
      */
-    getMyFilters: ({ expand, includeFavourites, }?: {
+    getMyFilters: ({ expand, includeFavourites }?: {
         /**
          * Use [expand](#expansion) to include additional information about filter in the
          * response. This parameter accepts a comma-separated list. Expand options include:
@@ -1026,7 +1039,7 @@ export declare class FiltersService extends CommonHttpService {
      * @see https://developer.atlassian.com/cloud/jira/platform/rest/v3/api-group-filters#api-rest-api-3-filter-id-columns-delete
      * @param params
      */
-    resetColumns: ({ id, }: {
+    resetColumns: ({ id }: {
         /** The ID of the filter. */
         id: number;
     }) => Promise<void>;
@@ -1058,7 +1071,7 @@ export declare class FiltersService extends CommonHttpService {
      * @see https://developer.atlassian.com/cloud/jira/platform/rest/v3/api-group-filters#api-rest-api-3-filter-id-columns-put
      * @param params
      */
-    setColumns: ({ id, mediaType, columnRequestBody, }: {
+    setColumns: ({ id, mediaType, columnRequestBody }: {
         /** The ID of the filter. */
         id: number;
     } & ({
@@ -1137,7 +1150,7 @@ export declare class FiltersService extends CommonHttpService {
      * @see https://developer.atlassian.com/cloud/jira/platform/rest/v3/api-group-filters#api-rest-api-3-filter-id-favourite-put
      * @param params
      */
-    setFavouriteForFilter: ({ id, expand, }: {
+    setFavouriteForFilter: ({ id, expand }: {
         /** The ID of the filter. */
         id: number;
         /**
@@ -1213,7 +1226,7 @@ export declare class FiltersService extends CommonHttpService {
      * @see https://developer.atlassian.com/cloud/jira/platform/rest/v3/api-group-filters#api-rest-api-3-filter-id-put
      * @param params
      */
-    updateFilter: ({ id, expand, overrideSharePermissions, filter, }: {
+    updateFilter: ({ id, expand, overrideSharePermissions, filter }: {
         /** The ID of the filter to update. */
         id: number;
         /**
@@ -1246,9 +1259,9 @@ export declare class FiltersService extends CommonHttpService {
          *
          * @example
          * {
-         *     "description": "Lists all open bugs",
-         *     "jql": "type = Bug and resolution is empty",
-         *     "name": "All Open Bugs"
+         *   "description": "Lists all open bugs",
+         *   "jql": "type = Bug and resolution is empty",
+         *   "name": "All Open Bugs"
          * }
          */
         filter: Filter;