@resolution/jira-api-client 0.1.0

package/src/openapi/platform/services/filters-service.ts

@@ -0,0 +1,1901 @@
+// DO NOT EDIT!
+// This file is generated by "api-typescript-generator".
+// To update this file run "yarn build:openapi".
+import { z } from "zod";
+
+import * as commonHttpClient from "../core/common-http-client";
+import { CommonHttpService } from "../core/common-http-service";
+import {
+  type ColumnItem,
+  type ColumnRequestBody,
+  registerCommonValidationSchemas,
+} from "../models/common";
+import {
+  type ChangeFilterOwner,
+  type Filter,
+  type PageBeanFilterDetails,
+  registerFiltersValidationSchemas,
+} from "../models/filters";
+import { validationSchemaStorage } from "../validation-schema-storage";
+/**
+ * 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
+ * columns for a filter and set favorite filters.
+ */
+export class FiltersService extends CommonHttpService {
+  /**
+   * Changes the owner of the filter.
+   *
+   * **[Permissions](#permissions) required:** Permission to access Jira. However,
+   * the user must own the filter or have the *Administer Jira* [global
+   * permission](https://confluence.atlassian.com/x/x4dKLg).
+   *
+   * @returns Returned if the request is successful.
+   * @path {PUT} /rest/api/3/filter/{id}/owner
+   * @scopes-beta read:filter:jira, write:filter:jira
+   * @scopes-current write:jira-work
+   */
+  changeFilterOwner({
+    id,
+    changeFilterOwner,
+  }: {
+    /** The ID of the filter to update. */
+    id: number;
+    /**
+     * The account ID of the new owner of the filter.
+     *
+     * @example {
+     *     "accountId": "0000-0000-0000-0000"
+     * }
+     */
+    changeFilterOwner: ChangeFilterOwner;
+  }): Promise<void> {
+    return this.getClientInstance()
+      .request({
+        path: "/rest/api/3/filter/{id}/owner",
+        method: "PUT",
+        pathParams: {
+          id,
+        },
+        headers: {
+          "Content-Type": "application/json",
+        },
+        body: changeFilterOwner,
+      })
+      .then(
+        this.getClientInstance().responseHandler({
+          204: {
+            "application/json": "json",
+          },
+        }),
+      )
+      .then(
+        commonHttpClient.castResponse<{
+          status: 204;
+          mediaType: "application/json";
+          body: void;
+        }>(),
+      )
+      .then(
+        validationSchemaStorage.validator(
+          "FiltersService.changeFilterOwner.response",
+        ),
+      )
+      .then(commonHttpClient.getBody);
+  }
+  /**
+   * Creates a filter. The filter is shared according to the [default share
+   * scope](#api-rest-api-3-filter-post). The filter is not selected as a favorite.
+   *
+   * **[Permissions](#permissions) required:** Permission to access Jira.
+   *
+   * @returns Returned if the request is successful.
+   *
+   * example: {
+   *   "approximateLastUsed": null,
+   *   "description": "Lists all open bugs",
+   *   "favourite": true,
+   *   "favouritedCount": 0,
+   *   "id": "10000",
+   *   "jql": "type = Bug and resolution is empty",
+   *   "name": "All Open Bugs",
+   *   "owner": {
+   *     "accountId": "5b10a2844c20165700ede21g",
+   *     "accountType": "atlassian",
+   *     "active": false,
+   *     "avatarUrls": {
+   *       "16x16":
+   * "https://avatar-management--avatars.server-location.prod.public.atl-paas.net/initials/MK-5.png?size=16&s=16",
+   *       "24x24":
+   * "https://avatar-management--avatars.server-location.prod.public.atl-paas.net/initials/MK-5.png?size=24&s=24",
+   *       "32x32":
+   * "https://avatar-management--avatars.server-location.prod.public.atl-paas.net/initials/MK-5.png?size=32&s=32",
+   *       "48x48":
+   * "https://avatar-management--avatars.server-location.prod.public.atl-paas.net/initials/MK-5.png?size=48&s=48"
+   *     },
+   *     "displayName": "Mia Krystof",
+   *     "key": "",
+   *     "name": "",
+   *     "self":
+   * "https://your-domain.atlassian.net/rest/api/3/user?accountId=5b10a2844c20165700ede21g"
+   *   },
+   *   "searchUrl":
+   * "https://your-domain.atlassian.net/rest/api/3/search?jql=type%20%3D%20Bug%20and%20resolutino%20is%20empty",
+   *   "self": "https://your-domain.atlassian.net/rest/api/3/filter/10000",
+   *   "sharePermissions": [],
+   *   "subscriptions": {
+   *     "end-index": 0,
+   *     "items": [],
+   *     "max-results": 0,
+   *     "size": 0,
+   *     "start-index": 0
+   *   },
+   *   "viewUrl": "https://your-domain.atlassian.net/issues/?filter=10000"
+   * }
+   * @path {POST} /rest/api/3/filter
+   * @scopes-current write:jira-work
+   * @scopes-beta read:filter:jira, read:group:jira, read:project:jira, read:project-role:jira,
+   * read:user:jira, write:filter:jira, read:application-role:jira,
+   * read:avatar:jira, read:issue-type-hierarchy:jira, read:issue-type:jira,
+   * read:project-category:jira, read:project-version:jira,
+   * read:project.component:jira
+   */
+  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:
+     *
+     *  *  `sharedUsers` Returns the users that the filter is shared with. This
+     * includes users that can browse projects that the filter is shared with. If you
+     * don't specify `sharedUsers`, then the `sharedUsers` object is returned but it
+     * doesn't list any users. The list of users returned is limited to 1000, to
+     * access additional users append `[start-index:end-index]` to the expand request.
+     * For example, to access the next 1000 users, use
+     * `?expand=sharedUsers[1001:2000]`.
+     *  *  `subscriptions` Returns the users that are subscribed to the filter. If you
+     * don't specify `subscriptions`, the `subscriptions` object is returned but it
+     * doesn't list any subscriptions. The list of subscriptions returned is limited
+     * to 1000, to access additional subscriptions append `[start-index:end-index]` to
+     * the expand request. For example, to access the next 1000 subscriptions, use
+     * `?expand=subscriptions[1001:2000]`.
+     */
+    expand?: string;
+    /**
+     * EXPERIMENTAL: Whether share permissions are overridden to enable filters with
+     * any share permissions to be created. Available to users with *Administer Jira*
+     * [global permission](https://confluence.atlassian.com/x/x4dKLg).
+     */
+    overrideSharePermissions?: boolean;
+    /**
+     * The filter to create.
+     *
+     * @example {
+     *     "description": "Lists all open bugs",
+     *     "jql": "type = Bug and resolution is empty",
+     *     "name": "All Open Bugs"
+     * }
+     */
+    filter: Filter;
+  }): Promise<Filter> {
+    return this.getClientInstance()
+      .request({
+        path: "/rest/api/3/filter",
+        method: "POST",
+        query: {
+          expand,
+          overrideSharePermissions,
+        },
+        headers: {
+          "Content-Type": "application/json",
+        },
+        body: filter,
+      })
+      .then(
+        this.getClientInstance().responseHandler({
+          200: {
+            "application/json": "json",
+          },
+        }),
+      )
+      .then(
+        commonHttpClient.castResponse<{
+          status: 200;
+          mediaType: "application/json";
+          body: Filter;
+        }>(),
+      )
+      .then(
+        validationSchemaStorage.validator(
+          "FiltersService.createFilter.response",
+        ),
+      )
+      .then(commonHttpClient.getBody);
+  }
+  /**
+   * Removes a filter as a favorite for the user. Note that this operation only
+   * removes filters visible to the user from the user's favorites list. For
+   * example, if the user favorites a public filter that is subsequently made
+   * private (and is therefore no longer visible on their favorites list) they
+   * cannot remove it from their favorites list.
+   *
+   * **[Permissions](#permissions) required:** Permission to access Jira.
+   *
+   * @returns Returned if the request is successful.
+   *
+   * example: {
+   *   "approximateLastUsed": "2023-03-01T13:15:00.000+0000",
+   *   "description": "Lists all open bugs",
+   *   "favourite": true,
+   *   "favouritedCount": 0,
+   *   "id": "10000",
+   *   "jql": "type = Bug and resolution is empty",
+   *   "name": "All Open Bugs",
+   *   "owner": {
+   *     "accountId": "5b10a2844c20165700ede21g",
+   *     "accountType": "atlassian",
+   *     "active": false,
+   *     "avatarUrls": {
+   *       "16x16":
+   * "https://avatar-management--avatars.server-location.prod.public.atl-paas.net/initials/MK-5.png?size=16&s=16",
+   *       "24x24":
+   * "https://avatar-management--avatars.server-location.prod.public.atl-paas.net/initials/MK-5.png?size=24&s=24",
+   *       "32x32":
+   * "https://avatar-management--avatars.server-location.prod.public.atl-paas.net/initials/MK-5.png?size=32&s=32",
+   *       "48x48":
+   * "https://avatar-management--avatars.server-location.prod.public.atl-paas.net/initials/MK-5.png?size=48&s=48"
+   *     },
+   *     "displayName": "Mia Krystof",
+   *     "key": "",
+   *     "name": "",
+   *     "self":
+   * "https://your-domain.atlassian.net/rest/api/3/user?accountId=5b10a2844c20165700ede21g"
+   *   },
+   *   "searchUrl":
+   * "https://your-domain.atlassian.net/rest/api/3/search?jql=type%20%3D%20Bug%20and%20resolutino%20is%20empty",
+   *   "self": "https://your-domain.atlassian.net/rest/api/3/filter/10000",
+   *   "sharePermissions": [],
+   *   "subscriptions": {
+   *     "end-index": 0,
+   *     "items": [],
+   *     "max-results": 0,
+   *     "size": 0,
+   *     "start-index": 0
+   *   },
+   *   "viewUrl": "https://your-domain.atlassian.net/issues/?filter=10000"
+   * }
+   * @path {DELETE} /rest/api/3/filter/{id}/favourite
+   * @scopes-current write:jira-work
+   * @scopes-beta write:filter:jira, read:application-role:jira, read:avatar:jira,
+   * read:filter:jira, read:group:jira, read:issue-type-hierarchy:jira,
+   * read:issue-type:jira, read:project-category:jira, read:project-role:jira,
+   * read:project-version:jira, read:project.component:jira, read:project:jira,
+   * read:user:jira
+   */
+  deleteFavouriteForFilter({
+    id,
+    expand,
+  }: {
+    /** The ID of the filter. */
+    id: number;
+    /**
+     * Use [expand](#expansion) to include additional information about filter in the
+     * response. This parameter accepts a comma-separated list. Expand options include:
+     *
+     *  *  `sharedUsers` Returns the users that the filter is shared with. This
+     * includes users that can browse projects that the filter is shared with. If you
+     * don't specify `sharedUsers`, then the `sharedUsers` object is returned but it
+     * doesn't list any users. The list of users returned is limited to 1000, to
+     * access additional users append `[start-index:end-index]` to the expand request.
+     * For example, to access the next 1000 users, use
+     * `?expand=sharedUsers[1001:2000]`.
+     *  *  `subscriptions` Returns the users that are subscribed to the filter. If you
+     * don't specify `subscriptions`, the `subscriptions` object is returned but it
+     * doesn't list any subscriptions. The list of subscriptions returned is limited
+     * to 1000, to access additional subscriptions append `[start-index:end-index]` to
+     * the expand request. For example, to access the next 1000 subscriptions, use
+     * `?expand=subscriptions[1001:2000]`.
+     */
+    expand?: string;
+  }): Promise<Filter> {
+    return this.getClientInstance()
+      .request({
+        path: "/rest/api/3/filter/{id}/favourite",
+        method: "DELETE",
+        pathParams: {
+          id,
+        },
+        query: {
+          expand,
+        },
+      })
+      .then(
+        this.getClientInstance().responseHandler({
+          200: {
+            "application/json": "json",
+          },
+        }),
+      )
+      .then(
+        commonHttpClient.castResponse<{
+          status: 200;
+          mediaType: "application/json";
+          body: Filter;
+        }>(),
+      )
+      .then(
+        validationSchemaStorage.validator(
+          "FiltersService.deleteFavouriteForFilter.response",
+        ),
+      )
+      .then(commonHttpClient.getBody);
+  }
+  /**
+   * Delete a filter.
+   *
+   * **[Permissions](#permissions) required:** Permission to access Jira, however
+   * filters can only be deleted by the creator of the filter or a user with
+   * *Administer Jira* [global
+   * permission](https://confluence.atlassian.com/x/x4dKLg).
+   *
+   * @path {DELETE} /rest/api/3/filter/{id}
+   * @scopes-current write:jira-work
+   * @scopes-beta delete:filter:jira
+   */
+  deleteFilter({
+    id,
+  }: {
+    /** The ID of the filter to delete. */
+    id: number;
+  }): Promise<void> {
+    return this.getClientInstance()
+      .request({
+        path: "/rest/api/3/filter/{id}",
+        method: "DELETE",
+        pathParams: {
+          id,
+        },
+      })
+      .then(commonHttpClient.discardResult);
+  }
+  /**
+   * Returns the columns configured for a filter. The column configuration is used
+   * when the filter's results are viewed in *List View* with the *Columns* set to
+   * *Filter*.
+   *
+   * This operation can be accessed anonymously.
+   *
+   * **[Permissions](#permissions) required:** None, however, column details are
+   * only returned for:
+   *
+   *  *  filters owned by the user.
+   *  *  filters shared with a group that the user is a member of.
+   *  *  filters shared with a private project that the user has *Browse projects*
+   * [project permission](https://confluence.atlassian.com/x/yodKLg) for.
+   *  *  filters shared with a public project.
+   *  *  filters shared with the public.
+   *
+   * @returns Returned if the request is successful.
+   *
+   * example: [
+   *   {
+   *     "label": "Key",
+   *     "value": "issuekey"
+   *   },
+   *   {
+   *     "label": "Summary",
+   *     "value": "summary"
+   *   }
+   * ]
+   * @path {GET} /rest/api/3/filter/{id}/columns
+   * @scopes-current read:jira-work
+   * @scopes-beta read:filter.column:jira
+   */
+  getColumns({
+    id,
+  }: {
+    /** The ID of the filter. */
+    id: number;
+  }): Promise<ColumnItem[]> {
+    return this.getClientInstance()
+      .request({
+        path: "/rest/api/3/filter/{id}/columns",
+        method: "GET",
+        pathParams: {
+          id,
+        },
+      })
+      .then(
+        this.getClientInstance().responseHandler({
+          200: {
+            "application/json": "json",
+          },
+        }),
+      )
+      .then(
+        commonHttpClient.castResponse<{
+          status: 200;
+          mediaType: "application/json";
+          body: ColumnItem[];
+        }>(),
+      )
+      .then(
+        validationSchemaStorage.validator("FiltersService.getColumns.response"),
+      )
+      .then(commonHttpClient.getBody);
+  }
+  /**
+   * Returns the visible favorite filters of the user.
+   *
+   * This operation can be accessed anonymously.
+   *
+   * **[Permissions](#permissions) required:** A favorite filter is only visible to
+   * the user where the filter is:
+   *
+   *  *  owned by the user.
+   *  *  shared with a group that the user is a member of.
+   *  *  shared with a private project that the user has *Browse projects* [project
+   * permission](https://confluence.atlassian.com/x/yodKLg) for.
+   *  *  shared with a public project.
+   *  *  shared with the public.
+   *
+   * For example, if the user favorites a public filter that is subsequently made
+   * private that filter is not returned by this operation.
+   *
+   * @returns Returned if the request is successful.
+   *
+   * example: [
+   *   {
+   *     "approximateLastUsed": "2023-03-01T13:15:00.000+0000",
+   *     "description": "Lists all open bugs",
+   *     "favourite": true,
+   *     "favouritedCount": 0,
+   *     "id": "10000",
+   *     "jql": "type = Bug and resolution is empty",
+   *     "name": "All Open Bugs",
+   *     "owner": {
+   *       "accountId": "5b10a2844c20165700ede21g",
+   *       "accountType": "atlassian",
+   *       "active": false,
+   *       "avatarUrls": {
+   *         "16x16":
+   * "https://avatar-management--avatars.server-location.prod.public.atl-paas.net/initials/MK-5.png?size=16&s=16",
+   *         "24x24":
+   * "https://avatar-management--avatars.server-location.prod.public.atl-paas.net/initials/MK-5.png?size=24&s=24",
+   *         "32x32":
+   * "https://avatar-management--avatars.server-location.prod.public.atl-paas.net/initials/MK-5.png?size=32&s=32",
+   *         "48x48":
+   * "https://avatar-management--avatars.server-location.prod.public.atl-paas.net/initials/MK-5.png?size=48&s=48"
+   *       },
+   *       "displayName": "Mia Krystof",
+   *       "key": "",
+   *       "name": "",
+   *       "self":
+   * "https://your-domain.atlassian.net/rest/api/3/user?accountId=5b10a2844c20165700ede21g"
+   *     },
+   *     "searchUrl":
+   * "https://your-domain.atlassian.net/rest/api/3/search?jql=type%20%3D%20Bug%20and%20resolutino%20is%20empty",
+   *     "self": "https://your-domain.atlassian.net/rest/api/3/filter/10000",
+   *     "sharePermissions": [],
+   *     "subscriptions": {
+   *       "end-index": 0,
+   *       "items": [],
+   *       "max-results": 0,
+   *       "size": 0,
+   *       "start-index": 0
+   *     },
+   *     "viewUrl": "https://your-domain.atlassian.net/issues/?filter=10000"
+   *   },
+   *   {
+   *     "approximateLastUsed": null,
+   *     "description": "Issues assigned to me",
+   *     "favourite": true,
+   *     "favouritedCount": 0,
+   *     "id": "10010",
+   *     "jql": "assignee = currentUser() and resolution is empty",
+   *     "name": "My issues",
+   *     "owner": {
+   *       "accountId": "5b10a2844c20165700ede21g",
+   *       "accountType": "atlassian",
+   *       "active": false,
+   *       "avatarUrls": {
+   *         "16x16":
+   * "https://avatar-management--avatars.server-location.prod.public.atl-paas.net/initials/MK-5.png?size=16&s=16",
+   *         "24x24":
+   * "https://avatar-management--avatars.server-location.prod.public.atl-paas.net/initials/MK-5.png?size=24&s=24",
+   *         "32x32":
+   * "https://avatar-management--avatars.server-location.prod.public.atl-paas.net/initials/MK-5.png?size=32&s=32",
+   *         "48x48":
+   * "https://avatar-management--avatars.server-location.prod.public.atl-paas.net/initials/MK-5.png?size=48&s=48"
+   *       },
+   *       "displayName": "Mia Krystof",
+   *       "key": "",
+   *       "name": "",
+   *       "self":
+   * "https://your-domain.atlassian.net/rest/api/3/user?accountId=5b10a2844c20165700ede21g"
+   *     },
+   *     "searchUrl":
+   * "https://your-domain.atlassian.net/rest/api/3/search?jql=assignee+in+%28currentUser%28%29%29+and+resolution+is+empty",
+   *     "self": "https://your-domain.atlassian.net/rest/api/3/filter/10010",
+   *     "sharePermissions": [
+   *       {
+   *         "id": 10000,
+   *         "type": "global"
+   *       },
+   *       {
+   *         "id": 10010,
+   *         "project": {
+   *           "avatarUrls": {
+   *             "16x16":
+   * "https://your-domain.atlassian.net/secure/projectavatar?size=xsmall&pid=10000",
+   *             "24x24":
+   * "https://your-domain.atlassian.net/secure/projectavatar?size=small&pid=10000",
+   *             "32x32":
+   * "https://your-domain.atlassian.net/secure/projectavatar?size=medium&pid=10000",
+   *             "48x48":
+   * "https://your-domain.atlassian.net/secure/projectavatar?size=large&pid=10000"
+   *           },
+   *           "id": "10000",
+   *           "insight": {
+   *             "lastIssueUpdateTime": "2021-04-22T05:37:05.000+0000",
+   *             "totalIssueCount": 100
+   *           },
+   *           "key": "EX",
+   *           "name": "Example",
+   *           "projectCategory": {
+   *             "description": "First Project Category",
+   *             "id": "10000",
+   *             "name": "FIRST",
+   *             "self":
+   * "https://your-domain.atlassian.net/rest/api/3/projectCategory/10000"
+   *           },
+   *           "self": "https://your-domain.atlassian.net/rest/api/3/project/EX",
+   *           "simplified": false,
+   *           "style": "classic"
+   *         },
+   *         "type": "project"
+   *       }
+   *     ],
+   *     "subscriptions": {
+   *       "end-index": 0,
+   *       "items": [],
+   *       "max-results": 0,
+   *       "size": 0,
+   *       "start-index": 0
+   *     },
+   *     "viewUrl": "https://your-domain.atlassian.net/issues/?filter=10010"
+   *   }
+   * ]
+   * @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
+   */
+  getFavouriteFilters({
+    expand,
+  }: {
+    /**
+     * Use [expand](#expansion) to include additional information about filter in the
+     * response. This parameter accepts a comma-separated list. Expand options include:
+     *
+     *  *  `sharedUsers` Returns the users that the filter is shared with. This
+     * includes users that can browse projects that the filter is shared with. If you
+     * don't specify `sharedUsers`, then the `sharedUsers` object is returned but it
+     * doesn't list any users. The list of users returned is limited to 1000, to
+     * access additional users append `[start-index:end-index]` to the expand request.
+     * For example, to access the next 1000 users, use
+     * `?expand=sharedUsers[1001:2000]`.
+     *  *  `subscriptions` Returns the users that are subscribed to the filter. If you
+     * don't specify `subscriptions`, the `subscriptions` object is returned but it
+     * doesn't list any subscriptions. The list of subscriptions returned is limited
+     * to 1000, to access additional subscriptions append `[start-index:end-index]` to
+     * the expand request. For example, to access the next 1000 subscriptions, use
+     * `?expand=subscriptions[1001:2000]`.
+     */
+    expand?: string;
+  }): Promise<Filter[]> {
+    return this.getClientInstance()
+      .request({
+        path: "/rest/api/3/filter/favourite",
+        method: "GET",
+        query: {
+          expand,
+        },
+      })
+      .then(
+        this.getClientInstance().responseHandler({
+          200: {
+            "application/json": "json",
+          },
+        }),
+      )
+      .then(
+        commonHttpClient.castResponse<{
+          status: 200;
+          mediaType: "application/json";
+          body: Filter[];
+        }>(),
+      )
+      .then(
+        validationSchemaStorage.validator(
+          "FiltersService.getFavouriteFilters.response",
+        ),
+      )
+      .then(commonHttpClient.getBody);
+  }
+  /**
+   * Returns a filter.
+   *
+   * This operation can be accessed anonymously.
+   *
+   * **[Permissions](#permissions) required:** None, however, the filter is only
+   * returned where it is:
+   *
+   *  *  owned by the user.
+   *  *  shared with a group that the user is a member of.
+   *  *  shared with a private project that the user has *Browse projects* [project
+   * permission](https://confluence.atlassian.com/x/yodKLg) for.
+   *  *  shared with a public project.
+   *  *  shared with the public.
+   *
+   * @returns Returned if the request is successful.
+   *
+   * example: {
+   *   "approximateLastUsed": "2023-03-01T13:15:00.000+0000",
+   *   "description": "Lists all open bugs",
+   *   "favourite": true,
+   *   "favouritedCount": 0,
+   *   "id": "10000",
+   *   "jql": "type = Bug and resolution is empty",
+   *   "name": "All Open Bugs",
+   *   "owner": {
+   *     "accountId": "5b10a2844c20165700ede21g",
+   *     "accountType": "atlassian",
+   *     "active": false,
+   *     "avatarUrls": {
+   *       "16x16":
+   * "https://avatar-management--avatars.server-location.prod.public.atl-paas.net/initials/MK-5.png?size=16&s=16",
+   *       "24x24":
+   * "https://avatar-management--avatars.server-location.prod.public.atl-paas.net/initials/MK-5.png?size=24&s=24",
+   *       "32x32":
+   * "https://avatar-management--avatars.server-location.prod.public.atl-paas.net/initials/MK-5.png?size=32&s=32",
+   *       "48x48":
+   * "https://avatar-management--avatars.server-location.prod.public.atl-paas.net/initials/MK-5.png?size=48&s=48"
+   *     },
+   *     "displayName": "Mia Krystof",
+   *     "key": "",
+   *     "name": "",
+   *     "self":
+   * "https://your-domain.atlassian.net/rest/api/3/user?accountId=5b10a2844c20165700ede21g"
+   *   },
+   *   "searchUrl":
+   * "https://your-domain.atlassian.net/rest/api/3/search?jql=type%20%3D%20Bug%20and%20resolutino%20is%20empty",
+   *   "self": "https://your-domain.atlassian.net/rest/api/3/filter/10000",
+   *   "sharePermissions": [],
+   *   "subscriptions": {
+   *     "end-index": 0,
+   *     "items": [],
+   *     "max-results": 0,
+   *     "size": 0,
+   *     "start-index": 0
+   *   },
+   *   "viewUrl": "https://your-domain.atlassian.net/issues/?filter=10000"
+   * }
+   * @path {GET} /rest/api/3/filter/{id}
+   * @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
+   */
+  getFilter({
+    id,
+    expand,
+    overrideSharePermissions,
+  }: {
+    /** The ID of the filter to return. */
+    id: number;
+    /**
+     * Use [expand](#expansion) to include additional information about filter in the
+     * response. This parameter accepts a comma-separated list. Expand options include:
+     *
+     *  *  `sharedUsers` Returns the users that the filter is shared with. This
+     * includes users that can browse projects that the filter is shared with. If you
+     * don't specify `sharedUsers`, then the `sharedUsers` object is returned but it
+     * doesn't list any users. The list of users returned is limited to 1000, to
+     * access additional users append `[start-index:end-index]` to the expand request.
+     * For example, to access the next 1000 users, use
+     * `?expand=sharedUsers[1001:2000]`.
+     *  *  `subscriptions` Returns the users that are subscribed to the filter. If you
+     * don't specify `subscriptions`, the `subscriptions` object is returned but it
+     * doesn't list any subscriptions. The list of subscriptions returned is limited
+     * to 1000, to access additional subscriptions append `[start-index:end-index]` to
+     * the expand request. For example, to access the next 1000 subscriptions, use
+     * `?expand=subscriptions[1001:2000]`.
+     */
+    expand?: string;
+    /**
+     * EXPERIMENTAL: Whether share permissions are overridden to enable filters with
+     * any share permissions to be returned. Available to users with *Administer Jira*
+     * [global permission](https://confluence.atlassian.com/x/x4dKLg).
+     */
+    overrideSharePermissions?: boolean;
+  }): Promise<Filter> {
+    return this.getClientInstance()
+      .request({
+        path: "/rest/api/3/filter/{id}",
+        method: "GET",
+        pathParams: {
+          id,
+        },
+        query: {
+          expand,
+          overrideSharePermissions,
+        },
+      })
+      .then(
+        this.getClientInstance().responseHandler({
+          200: {
+            "application/json": "json",
+          },
+        }),
+      )
+      .then(
+        commonHttpClient.castResponse<{
+          status: 200;
+          mediaType: "application/json";
+          body: Filter;
+        }>(),
+      )
+      .then(
+        validationSchemaStorage.validator("FiltersService.getFilter.response"),
+      )
+      .then(commonHttpClient.getBody);
+  }
+  /**
+   * Returns a [paginated](#pagination) list of filters. Use this operation to get:
+   *
+   *  *  specific filters, by defining `id` only.
+   *  *  filters that match all of the specified attributes. For example, all
+   * filters for a user with a particular word in their name. When multiple
+   * attributes are specified only filters matching all attributes are returned.
+   *
+   * This operation can be accessed anonymously.
+   *
+   * **[Permissions](#permissions) required:** None, however, only the following
+   * filters that match the query parameters are returned:
+   *
+   *  *  filters owned by the user.
+   *  *  filters shared with a group that the user is a member of.
+   *  *  filters shared with a private project that the user has *Browse projects*
+   * [project permission](https://confluence.atlassian.com/x/yodKLg) for.
+   *  *  filters shared with a public project.
+   *  *  filters shared with the public.
+   *
+   * @returns Returned if the request is successful.
+   *
+   * example: {
+   *   "isLast": true,
+   *   "maxResults": 100,
+   *   "self":
+   * "https://your-domain.atlassian.net/rest/api/3/filter/search?accountId=&maxResults=50&filterName=&orderBy=name&startAt=0&expand=description,owner,jql,searchUrl,viewUrl,favourite,favouritedCount,sharePermissions,editPermissions,isWritable,subscriptions,approximateLastUsed",
+   *   "startAt": 0,
+   *   "total": 2,
+   *   "values": [
+   *     {
+   *       "approximateLastUsed": "2023-03-01T13:15:00.000+0000",
+   *       "description": "Lists all open bugs",
+   *       "editPermissions": [],
+   *       "expand":
+   * "description,owner,jql,searchUrl,viewUrl,favourite,favouritedCount,sharePermissions,editPermissions,isWritable,approximateLastUsed,subscriptions",
+   *       "favourite": false,
+   *       "favouritedCount": 0,
+   *       "id": "10000",
+   *       "jql": "type = Bug and resolution is empty",
+   *       "name": "All Open Bugs",
+   *       "owner": {
+   *         "accountId": "5b10a2844c20165700ede21g",
+   *         "accountType": "atlassian",
+   *         "active": false,
+   *         "avatarUrls": {
+   *           "16x16":
+   * "https://avatar-management--avatars.server-location.prod.public.atl-paas.net/initials/MK-5.png?size=16&s=16",
+   *           "24x24":
+   * "https://avatar-management--avatars.server-location.prod.public.atl-paas.net/initials/MK-5.png?size=24&s=24",
+   *           "32x32":
+   * "https://avatar-management--avatars.server-location.prod.public.atl-paas.net/initials/MK-5.png?size=32&s=32",
+   *           "48x48":
+   * "https://avatar-management--avatars.server-location.prod.public.atl-paas.net/initials/MK-5.png?size=48&s=48"
+   *         },
+   *         "displayName": "Mia Krystof",
+   *         "key": "",
+   *         "name": "",
+   *         "self":
+   * "https://your-domain.atlassian.net/rest/api/3/user?accountId=5b10a2844c20165700ede21g"
+   *       },
+   *       "searchUrl":
+   * "https://your-domain.atlassian.net/rest/api/3/search?jql=type%20%3D%20Bug%20and%20resolutino%20is%20empty",
+   *       "self": "https://your-domain.atlassian.net/rest/api/3/filter/10000",
+   *       "sharePermissions": [],
+   *       "subscriptions": [],
+   *       "viewUrl": "https://your-domain.atlassian.net/issues/?filter=10000"
+   *     },
+   *     {
+   *       "approximateLastUsed": null,
+   *       "description": "Issues assigned to me",
+   *       "editPermissions": [
+   *         {
+   *           "id": 10010,
+   *           "project": {
+   *             "avatarUrls": {
+   *               "16x16":
+   * "https://your-domain.atlassian.net/secure/projectavatar?size=xsmall&pid=10002",
+   *               "24x24":
+   * "https://your-domain.atlassian.net/secure/projectavatar?size=small&pid=10002",
+   *               "32x32":
+   * "https://your-domain.atlassian.net/secure/projectavatar?size=medium&pid=10002",
+   *               "48x48":
+   * "https://your-domain.atlassian.net/secure/projectavatar?size=large&pid=10002"
+   *             },
+   *             "deleted": true,
+   *             "deletedBy": {
+   *               "accountId": "5b10a2844c20165700ede21g",
+   *               "accountType": "atlassian",
+   *               "active": false,
+   *               "avatarUrls": {
+   *                 "16x16":
+   * "https://avatar-management--avatars.server-location.prod.public.atl-paas.net/initials/MK-5.png?size=16&s=16",
+   *                 "24x24":
+   * "https://avatar-management--avatars.server-location.prod.public.atl-paas.net/initials/MK-5.png?size=24&s=24",
+   *                 "32x32":
+   * "https://avatar-management--avatars.server-location.prod.public.atl-paas.net/initials/MK-5.png?size=32&s=32",
+   *                 "48x48":
+   * "https://avatar-management--avatars.server-location.prod.public.atl-paas.net/initials/MK-5.png?size=48&s=48"
+   *               },
+   *               "displayName": "Mia Krystof",
+   *               "key": "",
+   *               "name": "",
+   *               "self":
+   * "https://your-domain.atlassian.net/rest/api/3/user?accountId=5b10a2844c20165700ede21g"
+   *             },
+   *             "deletedDate": "2022-11-11T13:35:29.000+0000",
+   *             "id": "10002",
+   *             "insight": {
+   *               "lastIssueUpdateTime": "2021-04-22T05:37:05.000+0000",
+   *               "totalIssueCount": 100
+   *             },
+   *             "key": "MKY",
+   *             "name": "Example",
+   *             "projectCategory": {
+   *               "description": "First Project Category",
+   *               "id": "10000",
+   *               "name": "FIRST",
+   *               "self":
+   * "https://your-domain.atlassian.net/rest/api/3/projectCategory/10000"
+   *             },
+   *             "retentionTillDate": "2023-01-10T13:35:29.000+0000",
+   *             "self": "https://your-domain.atlassian.net/rest/api/3/project/MKY",
+   *             "simplified": false,
+   *             "style": "classic"
+   *           },
+   *           "role": {
+   *             "self":
+   * "https://your-domain.atlassian.net/rest/api/3/project/MKY/role/10360",
+   *             "name": "Developers",
+   *             "id": 10360,
+   *             "description": "A project role that represents developers in a
+   * project",
+   *             "actors": [
+   *               {
+   *                 "actorGroup": {
+   *                   "name": "jira-developers",
+   *                   "displayName": "jira-developers",
+   *                   "groupId": "952d12c3-5b5b-4d04-bb32-44d383afc4b2"
+   *                 },
+   *                 "displayName": "jira-developers",
+   *                 "id": 10240,
+   *                 "name": "jira-developers",
+   *                 "type": "atlassian-group-role-actor"
+   *               },
+   *               {
+   *                 "actorUser": {
+   *                   "accountId": "5b10a2844c20165700ede21g"
+   *                 },
+   *                 "displayName": "Mia Krystof",
+   *                 "id": 10241,
+   *                 "type": "atlassian-user-role-actor"
+   *               }
+   *             ],
+   *             "scope": {
+   *               "project": {
+   *                 "id": "10000",
+   *                 "key": "KEY",
+   *                 "name": "Next Gen Project"
+   *               },
+   *               "type": "PROJECT"
+   *             }
+   *           },
+   *           "type": "project"
+   *         },
+   *         {
+   *           "group": {
+   *             "groupId": "276f955c-63d7-42c8-9520-92d01dca0625",
+   *             "name": "jira-administrators",
+   *             "self":
+   * "https://your-domain.atlassian.net/rest/api/3/group?groupId=276f955c-63d7-42c8-9520-92d01dca0625"
+   *           },
+   *           "id": 10010,
+   *           "type": "group"
+   *         }
+   *       ],
+   *       "expand":
+   * "description,owner,jql,searchUrl,viewUrl,favourite,favouritedCount,sharePermissions,editPermissions,isWritable,approximateLastUsed,subscriptions",
+   *       "favourite": true,
+   *       "favouritedCount": 123,
+   *       "id": "10010",
+   *       "jql": "assignee = currentUser() and resolution is empty",
+   *       "name": "My issues",
+   *       "owner": {
+   *         "accountId": "5b10a2844c20165700ede21g",
+   *         "accountType": "atlassian",
+   *         "active": false,
+   *         "avatarUrls": {
+   *           "16x16":
+   * "https://avatar-management--avatars.server-location.prod.public.atl-paas.net/initials/MK-5.png?size=16&s=16",
+   *           "24x24":
+   * "https://avatar-management--avatars.server-location.prod.public.atl-paas.net/initials/MK-5.png?size=24&s=24",
+   *           "32x32":
+   * "https://avatar-management--avatars.server-location.prod.public.atl-paas.net/initials/MK-5.png?size=32&s=32",
+   *           "48x48":
+   * "https://avatar-management--avatars.server-location.prod.public.atl-paas.net/initials/MK-5.png?size=48&s=48"
+   *         },
+   *         "displayName": "Mia Krystof",
+   *         "key": "",
+   *         "name": "",
+   *         "self":
+   * "https://your-domain.atlassian.net/rest/api/3/user?accountId=5b10a2844c20165700ede21g"
+   *       },
+   *       "searchUrl":
+   * "https://your-domain.atlassian.net/rest/api/3/search?jql=assignee+in+%28currentUser%28%29%29+and+resolution+is+empty",
+   *       "self": "https://your-domain.atlassian.net/rest/api/3/filter/10010",
+   *       "sharePermissions": [
+   *         {
+   *           "id": 10000,
+   *           "type": "global"
+   *         },
+   *         {
+   *           "id": 10010,
+   *           "project": {
+   *             "avatarUrls": {
+   *               "16x16":
+   * "https://your-domain.atlassian.net/secure/projectavatar?size=xsmall&pid=10000",
+   *               "24x24":
+   * "https://your-domain.atlassian.net/secure/projectavatar?size=small&pid=10000",
+   *               "32x32":
+   * "https://your-domain.atlassian.net/secure/projectavatar?size=medium&pid=10000",
+   *               "48x48":
+   * "https://your-domain.atlassian.net/secure/projectavatar?size=large&pid=10000"
+   *             },
+   *             "id": "10000",
+   *             "insight": {
+   *               "lastIssueUpdateTime": "2021-04-22T05:37:05.000+0000",
+   *               "totalIssueCount": 100
+   *             },
+   *             "key": "EX",
+   *             "name": "Example",
+   *             "projectCategory": {
+   *               "description": "First Project Category",
+   *               "id": "10000",
+   *               "name": "FIRST",
+   *               "self":
+   * "https://your-domain.atlassian.net/rest/api/3/projectCategory/10000"
+   *             },
+   *             "self": "https://your-domain.atlassian.net/rest/api/3/project/EX",
+   *             "simplified": false,
+   *             "style": "classic"
+   *           },
+   *           "type": "project"
+   *         }
+   *       ],
+   *       "subscriptions": [
+   *         {
+   *           "id": 1,
+   *           "user": {
+   *             "accountId": "5b10a2844c20165700ede21g",
+   *             "accountType": "atlassian",
+   *             "active": true,
+   *             "applicationRoles": {
+   *               "items": [],
+   *               "size": 1
+   *             },
+   *             "avatarUrls": {
+   *               "16x16":
+   * "https://avatar-management--avatars.server-location.prod.public.atl-paas.net/initials/MK-5.png?size=16&s=16",
+   *               "24x24":
+   * "https://avatar-management--avatars.server-location.prod.public.atl-paas.net/initials/MK-5.png?size=24&s=24",
+   *               "32x32":
+   * "https://avatar-management--avatars.server-location.prod.public.atl-paas.net/initials/MK-5.png?size=32&s=32",
+   *               "48x48":
+   * "https://avatar-management--avatars.server-location.prod.public.atl-paas.net/initials/MK-5.png?size=48&s=48"
+   *             },
+   *             "displayName": "Mia Krystof",
+   *             "emailAddress": "mia@example.com",
+   *             "groups": {
+   *               "items": [],
+   *               "size": 3
+   *             },
+   *             "key": "",
+   *             "name": "",
+   *             "self":
+   * "https://your-domain.atlassian.net/rest/api/3/user?accountId=5b10a2844c20165700ede21g",
+   *             "timeZone": "Australia/Sydney"
+   *           }
+   *         }
+   *       ],
+   *       "viewUrl": "https://your-domain.atlassian.net/issues/?filter=10010"
+   *     }
+   *   ]
+   * }
+   * @path {GET} /rest/api/3/filter/search
+   * @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
+   */
+  getFiltersPaginated({
+    filterName,
+    accountId,
+    owner,
+    groupname,
+    groupId,
+    projectId,
+    id,
+    orderBy,
+    startAt,
+    maxResults,
+    expand,
+    overrideSharePermissions,
+  }: {
+    /** String used to perform a case-insensitive partial match with `name`. */
+    filterName?: string;
+    /**
+     * User account ID used to return filters with the matching `owner.accountId`.
+     * This parameter cannot be used with `owner`.
+     */
+    accountId?: string;
+    /**
+     * This parameter is deprecated because of privacy changes. Use `accountId`
+     * instead. See the [migration
+     * guide](https://developer.atlassian.com/cloud/jira/platform/deprecation-notice-user-privacy-api-migration-guide/)
+     * for details. User name used to return filters with the matching `owner.name`.
+     * This parameter cannot be used with `accountId`.
+     */
+    owner?: string;
+    /**
+     * As a group's name can change, use of `groupId` is recommended to identify a
+     * group. Group name used to returns filters that are shared with a group that
+     * matches `sharePermissions.group.groupname`. This parameter cannot be used with
+     * the `groupId` parameter.
+     */
+    groupname?: string;
+    /**
+     * Group ID used to returns filters that are shared with a group that matches
+     * `sharePermissions.group.groupId`. This parameter cannot be used with the
+     * `groupname` parameter.
+     */
+    groupId?: string;
+    /**
+     * Project ID used to returns filters that are shared with a project that matches
+     * `sharePermissions.project.id`.
+     */
+    projectId?: number;
+    /**
+     * The list of filter IDs. To include multiple IDs, provide an ampersand-separated
+     * list. For example, `id=10000&id=10001`. Do not exceed 200 filter IDs.
+     */
+    id?: number[];
+    /**
+     * [Order](#ordering) the results by a field:
+     *
+     *  *  `description` Sorts by filter description. Note that this sorting works
+     * independently of whether the expand to display the description field is in use.
+     *  *  `favourite_count` Sorts by the count of how many users have this filter as
+     * a favorite.
+     *  *  `is_favourite` Sorts by whether the filter is marked as a favorite.
+     *  *  `id` Sorts by filter ID.
+     *  *  `name` Sorts by filter name.
+     *  *  `owner` Sorts by the ID of the filter owner.
+     *  *  `is_shared` Sorts by whether the filter is shared.
+     */
+    orderBy?:
+      | "description"
+      | "-description"
+      | "+description"
+      | "favourite_count"
+      | "-favourite_count"
+      | "+favourite_count"
+      | "id"
+      | "-id"
+      | "+id"
+      | "is_favourite"
+      | "-is_favourite"
+      | "+is_favourite"
+      | "name"
+      | "-name"
+      | "+name"
+      | "owner"
+      | "-owner"
+      | "+owner"
+      | "is_shared"
+      | "-is_shared"
+      | "+is_shared";
+    /** 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;
+    /**
+     * Use [expand](#expansion) to include additional information about filter in the
+     * response. This parameter accepts a comma-separated list. Expand options include:
+     *
+     *  *  `description` Returns the description of the filter.
+     *  *  `favourite` Returns an indicator of whether the user has set the filter as
+     * a favorite.
+     *  *  `favouritedCount` Returns a count of how many users have set this filter as
+     * a favorite.
+     *  *  `jql` Returns the JQL query that the filter uses.
+     *  *  `owner` Returns the owner of the filter.
+     *  *  `searchUrl` Returns a URL to perform the filter's JQL query.
+     *  *  `sharePermissions` Returns the share permissions defined for the filter.
+     *  *  `editPermissions` Returns the edit permissions defined for the filter.
+     *  *  `isWritable` Returns whether the current user has permission to edit the
+     * filter.
+     *  *  `approximateLastUsed` \[Experimental\] Returns the approximate date and
+     * time when the filter was last evaluated.
+     *  *  `subscriptions` Returns the users that are subscribed to the filter.
+     *  *  `viewUrl` Returns a URL to view the filter.
+     */
+    expand?: string;
+    /**
+     * EXPERIMENTAL: Whether share permissions are overridden to enable filters with
+     * any share permissions to be returned. Available to users with *Administer Jira*
+     * [global permission](https://confluence.atlassian.com/x/x4dKLg).
+     */
+    overrideSharePermissions?: boolean;
+  }): Promise<PageBeanFilterDetails> {
+    return this.getClientInstance()
+      .request({
+        path: "/rest/api/3/filter/search",
+        method: "GET",
+        query: {
+          filterName,
+          accountId,
+          owner,
+          groupname,
+          groupId,
+          projectId,
+          id,
+          orderBy,
+          startAt,
+          maxResults,
+          expand,
+          overrideSharePermissions,
+        },
+      })
+      .then(
+        this.getClientInstance().responseHandler({
+          200: {
+            "application/json": "json",
+          },
+        }),
+      )
+      .then(
+        commonHttpClient.castResponse<{
+          status: 200;
+          mediaType: "application/json";
+          body: PageBeanFilterDetails;
+        }>(),
+      )
+      .then(
+        validationSchemaStorage.validator(
+          "FiltersService.getFiltersPaginated.response",
+        ),
+      )
+      .then(commonHttpClient.getBody);
+  }
+  /**
+   * Returns the filters owned by the user. If `includeFavourites` is `true`, the
+   * user's visible favorite filters are also returned.
+   *
+   * **[Permissions](#permissions) required:** Permission to access Jira, however, a
+   * favorite filters is only visible to the user where the filter is:
+   *
+   *  *  owned by the user.
+   *  *  shared with a group that the user is a member of.
+   *  *  shared with a private project that the user has *Browse projects* [project
+   * permission](https://confluence.atlassian.com/x/yodKLg) for.
+   *  *  shared with a public project.
+   *  *  shared with the public.
+   *
+   * For example, if the user favorites a public filter that is subsequently made
+   * private that filter is not returned by this operation.
+   *
+   * @returns Returned if the request is successful.
+   *
+   * example: [
+   *   {
+   *     "approximateLastUsed": "2023-03-01T13:15:00.000+0000",
+   *     "description": "Lists all open bugs",
+   *     "favourite": true,
+   *     "favouritedCount": 0,
+   *     "id": "10000",
+   *     "jql": "type = Bug and resolution is empty",
+   *     "name": "All Open Bugs",
+   *     "owner": {
+   *       "accountId": "5b10a2844c20165700ede21g",
+   *       "accountType": "atlassian",
+   *       "active": false,
+   *       "avatarUrls": {
+   *         "16x16":
+   * "https://avatar-management--avatars.server-location.prod.public.atl-paas.net/initials/MK-5.png?size=16&s=16",
+   *         "24x24":
+   * "https://avatar-management--avatars.server-location.prod.public.atl-paas.net/initials/MK-5.png?size=24&s=24",
+   *         "32x32":
+   * "https://avatar-management--avatars.server-location.prod.public.atl-paas.net/initials/MK-5.png?size=32&s=32",
+   *         "48x48":
+   * "https://avatar-management--avatars.server-location.prod.public.atl-paas.net/initials/MK-5.png?size=48&s=48"
+   *       },
+   *       "displayName": "Mia Krystof",
+   *       "key": "",
+   *       "name": "",
+   *       "self":
+   * "https://your-domain.atlassian.net/rest/api/3/user?accountId=5b10a2844c20165700ede21g"
+   *     },
+   *     "searchUrl":
+   * "https://your-domain.atlassian.net/rest/api/3/search?jql=type%20%3D%20Bug%20and%20resolutino%20is%20empty",
+   *     "self": "https://your-domain.atlassian.net/rest/api/3/filter/10000",
+   *     "sharePermissions": [],
+   *     "subscriptions": {
+   *       "end-index": 0,
+   *       "items": [],
+   *       "max-results": 0,
+   *       "size": 0,
+   *       "start-index": 0
+   *     },
+   *     "viewUrl": "https://your-domain.atlassian.net/issues/?filter=10000"
+   *   },
+   *   {
+   *     "approximateLastUsed": null,
+   *     "description": "Issues assigned to me",
+   *     "favourite": true,
+   *     "favouritedCount": 0,
+   *     "id": "10010",
+   *     "jql": "assignee = currentUser() and resolution is empty",
+   *     "name": "My issues",
+   *     "owner": {
+   *       "accountId": "5b10a2844c20165700ede21g",
+   *       "accountType": "atlassian",
+   *       "active": false,
+   *       "avatarUrls": {
+   *         "16x16":
+   * "https://avatar-management--avatars.server-location.prod.public.atl-paas.net/initials/MK-5.png?size=16&s=16",
+   *         "24x24":
+   * "https://avatar-management--avatars.server-location.prod.public.atl-paas.net/initials/MK-5.png?size=24&s=24",
+   *         "32x32":
+   * "https://avatar-management--avatars.server-location.prod.public.atl-paas.net/initials/MK-5.png?size=32&s=32",
+   *         "48x48":
+   * "https://avatar-management--avatars.server-location.prod.public.atl-paas.net/initials/MK-5.png?size=48&s=48"
+   *       },
+   *       "displayName": "Mia Krystof",
+   *       "key": "",
+   *       "name": "",
+   *       "self":
+   * "https://your-domain.atlassian.net/rest/api/3/user?accountId=5b10a2844c20165700ede21g"
+   *     },
+   *     "searchUrl":
+   * "https://your-domain.atlassian.net/rest/api/3/search?jql=assignee+in+%28currentUser%28%29%29+and+resolution+is+empty",
+   *     "self": "https://your-domain.atlassian.net/rest/api/3/filter/10010",
+   *     "sharePermissions": [
+   *       {
+   *         "id": 10000,
+   *         "type": "global"
+   *       },
+   *       {
+   *         "id": 10010,
+   *         "project": {
+   *           "avatarUrls": {
+   *             "16x16":
+   * "https://your-domain.atlassian.net/secure/projectavatar?size=xsmall&pid=10000",
+   *             "24x24":
+   * "https://your-domain.atlassian.net/secure/projectavatar?size=small&pid=10000",
+   *             "32x32":
+   * "https://your-domain.atlassian.net/secure/projectavatar?size=medium&pid=10000",
+   *             "48x48":
+   * "https://your-domain.atlassian.net/secure/projectavatar?size=large&pid=10000"
+   *           },
+   *           "id": "10000",
+   *           "insight": {
+   *             "lastIssueUpdateTime": "2021-04-22T05:37:05.000+0000",
+   *             "totalIssueCount": 100
+   *           },
+   *           "key": "EX",
+   *           "name": "Example",
+   *           "projectCategory": {
+   *             "description": "First Project Category",
+   *             "id": "10000",
+   *             "name": "FIRST",
+   *             "self":
+   * "https://your-domain.atlassian.net/rest/api/3/projectCategory/10000"
+   *           },
+   *           "self": "https://your-domain.atlassian.net/rest/api/3/project/EX",
+   *           "simplified": false,
+   *           "style": "classic"
+   *         },
+   *         "type": "project"
+   *       }
+   *     ],
+   *     "subscriptions": {
+   *       "end-index": 0,
+   *       "items": [],
+   *       "max-results": 0,
+   *       "size": 0,
+   *       "start-index": 0
+   *     },
+   *     "viewUrl": "https://your-domain.atlassian.net/issues/?filter=10010"
+   *   }
+   * ]
+   * @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
+   */
+  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:
+     *
+     *  *  `sharedUsers` Returns the users that the filter is shared with. This
+     * includes users that can browse projects that the filter is shared with. If you
+     * don't specify `sharedUsers`, then the `sharedUsers` object is returned but it
+     * doesn't list any users. The list of users returned is limited to 1000, to
+     * access additional users append `[start-index:end-index]` to the expand request.
+     * For example, to access the next 1000 users, use
+     * `?expand=sharedUsers[1001:2000]`.
+     *  *  `subscriptions` Returns the users that are subscribed to the filter. If you
+     * don't specify `subscriptions`, the `subscriptions` object is returned but it
+     * doesn't list any subscriptions. The list of subscriptions returned is limited
+     * to 1000, to access additional subscriptions append `[start-index:end-index]` to
+     * the expand request. For example, to access the next 1000 subscriptions, use
+     * `?expand=subscriptions[1001:2000]`.
+     */
+    expand?: string;
+    /** Include the user's favorite filters in the response. */
+    includeFavourites?: boolean;
+  }): Promise<Filter[]> {
+    return this.getClientInstance()
+      .request({
+        path: "/rest/api/3/filter/my",
+        method: "GET",
+        query: {
+          expand,
+          includeFavourites,
+        },
+      })
+      .then(
+        this.getClientInstance().responseHandler({
+          200: {
+            "application/json": "json",
+          },
+        }),
+      )
+      .then(
+        commonHttpClient.castResponse<{
+          status: 200;
+          mediaType: "application/json";
+          body: Filter[];
+        }>(),
+      )
+      .then(
+        validationSchemaStorage.validator(
+          "FiltersService.getMyFilters.response",
+        ),
+      )
+      .then(commonHttpClient.getBody);
+  }
+  /**
+   * Reset the user's column configuration for the filter to the default.
+   *
+   * **[Permissions](#permissions) required:** Permission to access Jira, however,
+   * columns are only reset for:
+   *
+   *  *  filters owned by the user.
+   *  *  filters shared with a group that the user is a member of.
+   *  *  filters shared with a private project that the user has *Browse projects*
+   * [project permission](https://confluence.atlassian.com/x/yodKLg) for.
+   *  *  filters shared with a public project.
+   *  *  filters shared with the public.
+   *
+   * @path {DELETE} /rest/api/3/filter/{id}/columns
+   * @scopes-beta delete:filter.column:jira
+   * @scopes-current write:jira-work
+   */
+  resetColumns({
+    id,
+  }: {
+    /** The ID of the filter. */
+    id: number;
+  }): Promise<void> {
+    return this.getClientInstance()
+      .request({
+        path: "/rest/api/3/filter/{id}/columns",
+        method: "DELETE",
+        pathParams: {
+          id,
+        },
+      })
+      .then(commonHttpClient.discardResult);
+  }
+  /**
+   * Sets the columns for a filter. Only navigable fields can be set as columns. Use
+   * [Get fields](#api-rest-api-3-field-get) to get the list fields in Jira. A
+   * navigable field has `navigable` set to `true`.
+   *
+   * The parameters for this resource are expressed as HTML form data. For example,
+   * in curl:
+   *
+   * `curl -X PUT -d columns=summary -d columns=description
+   * https://your-domain.atlassian.net/rest/api/3/filter/10000/columns`
+   *
+   * **[Permissions](#permissions) required:** Permission to access Jira, however,
+   * columns are only set for:
+   *
+   *  *  filters owned by the user.
+   *  *  filters shared with a group that the user is a member of.
+   *  *  filters shared with a private project that the user has *Browse projects*
+   * [project permission](https://confluence.atlassian.com/x/yodKLg) for.
+   *  *  filters shared with a public project.
+   *  *  filters shared with the public.
+   *
+   * @returns Returned if the request is successful.
+   * @path {PUT} /rest/api/3/filter/{id}/columns
+   * @scopes-current write:jira-work
+   * @scopes-beta write:filter.column:jira
+   */
+  setColumns({
+    id,
+    mediaType = "application/json",
+    columnRequestBody,
+  }: {
+    /** The ID of the filter. */
+    id: number;
+  } & (
+    | {
+        mediaType?: "application/json";
+        /**
+         * The IDs of the fields to set as columns. In the form data, specify each field
+         * as `columns=id`, where `id` is the *id* of a field (as seen in the response for
+         * [Get fields](#api-rest-api-<ver>-field-get)). For example, `columns=summary`.
+         */
+        columnRequestBody: ColumnRequestBody;
+      }
+    | {
+        mediaType: "multipart/form-data";
+        /**
+         * The IDs of the fields to set as columns. In the form data, specify each field
+         * as `columns=id`, where `id` is the *id* of a field (as seen in the response for
+         * [Get fields](#api-rest-api-<ver>-field-get)). For example, `columns=summary`.
+         */
+        columnRequestBody: ColumnRequestBody;
+      }
+  )): Promise<unknown> {
+    return this.getClientInstance()
+      .request({
+        path: "/rest/api/3/filter/{id}/columns",
+        method: "PUT",
+        pathParams: {
+          id,
+        },
+        headers: {
+          "Content-Type": mediaType,
+        },
+        body: columnRequestBody,
+      })
+      .then(
+        this.getClientInstance().responseHandler({
+          200: {
+            "application/json": "json",
+          },
+        }),
+      )
+      .then(
+        commonHttpClient.castResponse<{
+          status: 200;
+          mediaType: "application/json";
+          body: unknown;
+        }>(),
+      )
+      .then(
+        validationSchemaStorage.validator("FiltersService.setColumns.response"),
+      )
+      .then(commonHttpClient.getBody);
+  }
+  /**
+   * Add a filter as a favorite for the user.
+   *
+   * **[Permissions](#permissions) required:** Permission to access Jira, however,
+   * the user can only favorite:
+   *
+   *  *  filters owned by the user.
+   *  *  filters shared with a group that the user is a member of.
+   *  *  filters shared with a private project that the user has *Browse projects*
+   * [project permission](https://confluence.atlassian.com/x/yodKLg) for.
+   *  *  filters shared with a public project.
+   *  *  filters shared with the public.
+   *
+   * @returns Returned if the request is successful.
+   *
+   * example: {
+   *   "approximateLastUsed": "2023-03-01T13:15:00.000+0000",
+   *   "description": "Lists all open bugs",
+   *   "favourite": true,
+   *   "favouritedCount": 0,
+   *   "id": "10000",
+   *   "jql": "type = Bug and resolution is empty",
+   *   "name": "All Open Bugs",
+   *   "owner": {
+   *     "accountId": "5b10a2844c20165700ede21g",
+   *     "accountType": "atlassian",
+   *     "active": false,
+   *     "avatarUrls": {
+   *       "16x16":
+   * "https://avatar-management--avatars.server-location.prod.public.atl-paas.net/initials/MK-5.png?size=16&s=16",
+   *       "24x24":
+   * "https://avatar-management--avatars.server-location.prod.public.atl-paas.net/initials/MK-5.png?size=24&s=24",
+   *       "32x32":
+   * "https://avatar-management--avatars.server-location.prod.public.atl-paas.net/initials/MK-5.png?size=32&s=32",
+   *       "48x48":
+   * "https://avatar-management--avatars.server-location.prod.public.atl-paas.net/initials/MK-5.png?size=48&s=48"
+   *     },
+   *     "displayName": "Mia Krystof",
+   *     "key": "",
+   *     "name": "",
+   *     "self":
+   * "https://your-domain.atlassian.net/rest/api/3/user?accountId=5b10a2844c20165700ede21g"
+   *   },
+   *   "searchUrl":
+   * "https://your-domain.atlassian.net/rest/api/3/search?jql=type%20%3D%20Bug%20and%20resolutino%20is%20empty",
+   *   "self": "https://your-domain.atlassian.net/rest/api/3/filter/10000",
+   *   "sharePermissions": [],
+   *   "subscriptions": {
+   *     "end-index": 0,
+   *     "items": [],
+   *     "max-results": 0,
+   *     "size": 0,
+   *     "start-index": 0
+   *   },
+   *   "viewUrl": "https://your-domain.atlassian.net/issues/?filter=10000"
+   * }
+   * @path {PUT} /rest/api/3/filter/{id}/favourite
+   * @scopes-current write:jira-work
+   * @scopes-beta read:filter:jira, read:group:jira, read:project:jira, read:project-role:jira,
+   * read:user:jira, write:filter:jira, read:jql:jira, read:application-role:jira,
+   * read:avatar:jira, read:issue-type-hierarchy:jira
+   */
+  setFavouriteForFilter({
+    id,
+    expand,
+  }: {
+    /** The ID of the filter. */
+    id: number;
+    /**
+     * Use [expand](#expansion) to include additional information about filter in the
+     * response. This parameter accepts a comma-separated list. Expand options include:
+     *
+     *  *  `sharedUsers` Returns the users that the filter is shared with. This
+     * includes users that can browse projects that the filter is shared with. If you
+     * don't specify `sharedUsers`, then the `sharedUsers` object is returned but it
+     * doesn't list any users. The list of users returned is limited to 1000, to
+     * access additional users append `[start-index:end-index]` to the expand request.
+     * For example, to access the next 1000 users, use
+     * `?expand=sharedUsers[1001:2000]`.
+     *  *  `subscriptions` Returns the users that are subscribed to the filter. If you
+     * don't specify `subscriptions`, the `subscriptions` object is returned but it
+     * doesn't list any subscriptions. The list of subscriptions returned is limited
+     * to 1000, to access additional subscriptions append `[start-index:end-index]` to
+     * the expand request. For example, to access the next 1000 subscriptions, use
+     * `?expand=subscriptions[1001:2000]`.
+     */
+    expand?: string;
+  }): Promise<Filter> {
+    return this.getClientInstance()
+      .request({
+        path: "/rest/api/3/filter/{id}/favourite",
+        method: "PUT",
+        pathParams: {
+          id,
+        },
+        query: {
+          expand,
+        },
+      })
+      .then(
+        this.getClientInstance().responseHandler({
+          200: {
+            "application/json": "json",
+          },
+        }),
+      )
+      .then(
+        commonHttpClient.castResponse<{
+          status: 200;
+          mediaType: "application/json";
+          body: Filter;
+        }>(),
+      )
+      .then(
+        validationSchemaStorage.validator(
+          "FiltersService.setFavouriteForFilter.response",
+        ),
+      )
+      .then(commonHttpClient.getBody);
+  }
+  /**
+   * Updates a filter. Use this operation to update a filter's name, description,
+   * JQL, or sharing.
+   *
+   * **[Permissions](#permissions) required:** Permission to access Jira, however
+   * the user must own the filter.
+   *
+   * @returns Returned if the request is successful.
+   *
+   * example: {
+   *   "approximateLastUsed": "2023-03-01T13:15:00.000+0000",
+   *   "description": "Lists all open bugs",
+   *   "favourite": true,
+   *   "favouritedCount": 0,
+   *   "id": "10000",
+   *   "jql": "type = Bug and resolution is empty",
+   *   "name": "All Open Bugs",
+   *   "owner": {
+   *     "accountId": "5b10a2844c20165700ede21g",
+   *     "accountType": "atlassian",
+   *     "active": false,
+   *     "avatarUrls": {
+   *       "16x16":
+   * "https://avatar-management--avatars.server-location.prod.public.atl-paas.net/initials/MK-5.png?size=16&s=16",
+   *       "24x24":
+   * "https://avatar-management--avatars.server-location.prod.public.atl-paas.net/initials/MK-5.png?size=24&s=24",
+   *       "32x32":
+   * "https://avatar-management--avatars.server-location.prod.public.atl-paas.net/initials/MK-5.png?size=32&s=32",
+   *       "48x48":
+   * "https://avatar-management--avatars.server-location.prod.public.atl-paas.net/initials/MK-5.png?size=48&s=48"
+   *     },
+   *     "displayName": "Mia Krystof",
+   *     "key": "",
+   *     "name": "",
+   *     "self":
+   * "https://your-domain.atlassian.net/rest/api/3/user?accountId=5b10a2844c20165700ede21g"
+   *   },
+   *   "searchUrl":
+   * "https://your-domain.atlassian.net/rest/api/3/search?jql=type%20%3D%20Bug%20and%20resolutino%20is%20empty",
+   *   "self": "https://your-domain.atlassian.net/rest/api/3/filter/10000",
+   *   "sharePermissions": [],
+   *   "subscriptions": {
+   *     "end-index": 0,
+   *     "items": [],
+   *     "max-results": 0,
+   *     "size": 0,
+   *     "start-index": 0
+   *   },
+   *   "viewUrl": "https://your-domain.atlassian.net/issues/?filter=10000"
+   * }
+   * @path {PUT} /rest/api/3/filter/{id}
+   * @scopes-current write:jira-work
+   * @scopes-beta write:filter:jira, 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
+   */
+  updateFilter({
+    id,
+    expand,
+    overrideSharePermissions,
+    filter,
+  }: {
+    /** The ID of the filter to update. */
+    id: number;
+    /**
+     * Use [expand](#expansion) to include additional information about filter in the
+     * response. This parameter accepts a comma-separated list. Expand options include:
+     *
+     *  *  `sharedUsers` Returns the users that the filter is shared with. This
+     * includes users that can browse projects that the filter is shared with. If you
+     * don't specify `sharedUsers`, then the `sharedUsers` object is returned but it
+     * doesn't list any users. The list of users returned is limited to 1000, to
+     * access additional users append `[start-index:end-index]` to the expand request.
+     * For example, to access the next 1000 users, use
+     * `?expand=sharedUsers[1001:2000]`.
+     *  *  `subscriptions` Returns the users that are subscribed to the filter. If you
+     * don't specify `subscriptions`, the `subscriptions` object is returned but it
+     * doesn't list any subscriptions. The list of subscriptions returned is limited
+     * to 1000, to access additional subscriptions append `[start-index:end-index]` to
+     * the expand request. For example, to access the next 1000 subscriptions, use
+     * `?expand=subscriptions[1001:2000]`.
+     */
+    expand?: string;
+    /**
+     * EXPERIMENTAL: Whether share permissions are overridden to enable the addition
+     * of any share permissions to filters. Available to users with *Administer Jira*
+     * [global permission](https://confluence.atlassian.com/x/x4dKLg).
+     */
+    overrideSharePermissions?: boolean;
+    /**
+     * The filter to update.
+     *
+     * @example {
+     *     "description": "Lists all open bugs",
+     *     "jql": "type = Bug and resolution is empty",
+     *     "name": "All Open Bugs"
+     * }
+     */
+    filter: Filter;
+  }): Promise<Filter> {
+    return this.getClientInstance()
+      .request({
+        path: "/rest/api/3/filter/{id}",
+        method: "PUT",
+        pathParams: {
+          id,
+        },
+        query: {
+          expand,
+          overrideSharePermissions,
+        },
+        headers: {
+          "Content-Type": "application/json",
+        },
+        body: filter,
+      })
+      .then(
+        this.getClientInstance().responseHandler({
+          200: {
+            "application/json": "json",
+          },
+        }),
+      )
+      .then(
+        commonHttpClient.castResponse<{
+          status: 200;
+          mediaType: "application/json";
+          body: Filter;
+        }>(),
+      )
+      .then(
+        validationSchemaStorage.validator(
+          "FiltersService.updateFilter.response",
+        ),
+      )
+      .then(commonHttpClient.getBody);
+  }
+  static initialize() {
+    validationSchemaStorage.registerExtensible(
+      "FiltersService.createFilter.response",
+      z
+        .object({
+          status: z.literal(200),
+          mediaType: z.literal("application/json"),
+          body: validationSchemaStorage.lazy("Filter"),
+        })
+        .describe("FiltersService.createFilter.response"),
+    );
+    validationSchemaStorage.registerExtensible(
+      "FiltersService.getFilter.response",
+      z
+        .object({
+          status: z.literal(200),
+          mediaType: z.literal("application/json"),
+          body: validationSchemaStorage.lazy("Filter"),
+        })
+        .describe("FiltersService.getFilter.response"),
+    );
+    validationSchemaStorage.registerExtensible(
+      "FiltersService.updateFilter.response",
+      z
+        .object({
+          status: z.literal(200),
+          mediaType: z.literal("application/json"),
+          body: validationSchemaStorage.lazy("Filter"),
+        })
+        .describe("FiltersService.updateFilter.response"),
+    );
+    validationSchemaStorage.registerExtensible(
+      "FiltersService.getColumns.response",
+      z
+        .object({
+          status: z.literal(200),
+          mediaType: z.literal("application/json"),
+          body: z.array(validationSchemaStorage.lazy("ColumnItem")),
+        })
+        .describe("FiltersService.getColumns.response"),
+    );
+    validationSchemaStorage.registerExtensible(
+      "FiltersService.setColumns.response",
+      z
+        .object({
+          status: z.literal(200),
+          mediaType: z.literal("application/json"),
+          body: z.unknown(),
+        })
+        .describe("FiltersService.setColumns.response"),
+    );
+    validationSchemaStorage.registerExtensible(
+      "FiltersService.setFavouriteForFilter.response",
+      z
+        .object({
+          status: z.literal(200),
+          mediaType: z.literal("application/json"),
+          body: validationSchemaStorage.lazy("Filter"),
+        })
+        .describe("FiltersService.setFavouriteForFilter.response"),
+    );
+    validationSchemaStorage.registerExtensible(
+      "FiltersService.deleteFavouriteForFilter.response",
+      z
+        .object({
+          status: z.literal(200),
+          mediaType: z.literal("application/json"),
+          body: validationSchemaStorage.lazy("Filter"),
+        })
+        .describe("FiltersService.deleteFavouriteForFilter.response"),
+    );
+    validationSchemaStorage.registerExtensible(
+      "FiltersService.changeFilterOwner.response",
+      z
+        .object({
+          status: z.literal(204),
+          mediaType: z.literal("application/json"),
+          body: z.unknown(),
+        })
+        .describe("FiltersService.changeFilterOwner.response"),
+    );
+    validationSchemaStorage.registerExtensible(
+      "FiltersService.getFavouriteFilters.response",
+      z
+        .object({
+          status: z.literal(200),
+          mediaType: z.literal("application/json"),
+          body: z.array(validationSchemaStorage.lazy("Filter")),
+        })
+        .describe("FiltersService.getFavouriteFilters.response"),
+    );
+    validationSchemaStorage.registerExtensible(
+      "FiltersService.getMyFilters.response",
+      z
+        .object({
+          status: z.literal(200),
+          mediaType: z.literal("application/json"),
+          body: z.array(validationSchemaStorage.lazy("Filter")),
+        })
+        .describe("FiltersService.getMyFilters.response"),
+    );
+    validationSchemaStorage.registerExtensible(
+      "FiltersService.getFiltersPaginated.response",
+      z
+        .object({
+          status: z.literal(200),
+          mediaType: z.literal("application/json"),
+          body: validationSchemaStorage.lazy("PageBeanFilterDetails"),
+        })
+        .describe("FiltersService.getFiltersPaginated.response"),
+    );
+    validationSchemaStorage.registerOnce([
+      registerFiltersValidationSchemas,
+      registerCommonValidationSchemas,
+    ]);
+  }
+}