@resolution/jira-api-client 0.4.2 → 0.4.5

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

@@ -81,7 +81,7 @@ export declare class UserSearchService extends CommonHttpService {
      * read:avatar:jira, read:group:jira
      * @see https://developer.atlassian.com/cloud/jira/platform/rest/v3/api-group-user-search#api-rest-api-3-user-assignable-search-get
      */
-    findAssignableUsers({ query, sessionId, username, accountId, project, issueKey, startAt, maxResults, actionDescriptorId, recommend, }?: {
+    findAssignableUsers: ({ query, sessionId, username, accountId, project, issueKey, startAt, maxResults, actionDescriptorId, recommend, }?: {
         /**
          * A query string that is matched against user attributes, such as `displayName`,
          * and `emailAddress`, to find relevant users. The string can match the prefix of
@@ -89,40 +89,40 @@ export declare class UserSearchService extends CommonHttpService {
          * `displayName` of *John Smith* and a user with an `emailAddress` of
          * *johnson@example.com*. Required, unless `username` or `accountId` is specified.
          */
-        query?: string;
+        query?: string | undefined;
         /** The sessionId of this request. SessionId is the same until the assignee is set. */
-        sessionId?: string;
+        sessionId?: string | undefined;
         /**
          * This parameter is no longer available. See the [deprecation
          * notice](https://developer.atlassian.com/cloud/jira/platform/deprecation-notice-user-privacy-api-migration-guide/)
          * for details.
          */
-        username?: string;
+        username?: string | undefined;
         /**
          * A query string that is matched exactly against user `accountId`. Required,
          * unless `query` is specified.
          */
-        accountId?: string;
+        accountId?: string | undefined;
         /**
          * The project ID or project key (case sensitive). Required, unless `issueKey` is
          * specified.
          */
-        project?: string;
+        project?: string | undefined;
         /** The key of the issue. Required, unless `project` is specified. */
-        issueKey?: string;
+        issueKey?: 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. This operation may return less than the
          * maximum number of items even if more are available. The operation fetches users
          * up to the maximum and then, from the fetched users, returns only the users that
          * can be assigned to the issue.
          */
-        maxResults?: number;
+        maxResults?: number | undefined;
         /** The ID of the transition. */
-        actionDescriptorId?: number;
-        recommend?: boolean;
-    }): Promise<User[]>;
+        actionDescriptorId?: number | undefined;
+        recommend?: boolean | undefined;
+    }) => Promise<User[]>;
     /**
      * Returns a list of users who can be assigned issues in one or more projects. The
      * list may be restricted to users whose attributes match a string.
@@ -194,7 +194,7 @@ export declare class UserSearchService extends CommonHttpService {
      * read:avatar:jira, read:group:jira
      * @see https://developer.atlassian.com/cloud/jira/platform/rest/v3/api-group-user-search#api-rest-api-3-user-assignable-multiprojectsearch-get
      */
-    findBulkAssignableUsers({ query, username, accountId, projectKeys, startAt, maxResults, }: {
+    findBulkAssignableUsers: ({ query, username, accountId, projectKeys, startAt, maxResults, }: {
         /**
          * A query string that is matched against user attributes, such as `displayName`
          * and `emailAddress`, to find relevant users. The string can match the prefix of
@@ -202,28 +202,28 @@ export declare class UserSearchService extends CommonHttpService {
          * `displayName` of *John Smith* and a user with an `emailAddress` of
          * *johnson@example.com*. Required, unless `accountId` is specified.
          */
-        query?: string;
+        query?: string | undefined;
         /**
          * This parameter is no longer available. See the [deprecation
          * notice](https://developer.atlassian.com/cloud/jira/platform/deprecation-notice-user-privacy-api-migration-guide/)
          * for details.
          */
-        username?: string;
+        username?: string | undefined;
         /**
          * A query string that is matched exactly against user `accountId`. Required,
          * unless `query` is specified.
          */
-        accountId?: string;
+        accountId?: string | undefined;
         /**
          * A list of project keys (case sensitive). This parameter accepts a
          * comma-separated list.
          */
         projectKeys: string;
         /** The index of the first item to return in a page of results (page offset). */
-        startAt?: number;
+        startAt?: number | undefined;
         /** The maximum number of items to return per page. */
-        maxResults?: number;
-    }): Promise<User[]>;
+        maxResults?: number | undefined;
+    }) => Promise<User[]>;
     /**
      * Finds users with a structured query and returns a [paginated](#pagination) list
      * of user keys.
@@ -271,14 +271,14 @@ export declare class UserSearchService extends CommonHttpService {
      * read:user:jira
      * @see https://developer.atlassian.com/cloud/jira/platform/rest/v3/api-group-user-search#api-rest-api-3-user-search-query-key-get
      */
-    findUserKeysByQuery({ query, startAt, maxResult, }: {
+    findUserKeysByQuery: ({ query, startAt, maxResult, }: {
         /** The search query. */
         query: string;
         /** The index of the first item to return in a page of results (page offset). */
-        startAt?: number;
+        startAt?: number | undefined;
         /** The maximum number of items to return per page. */
-        maxResult?: number;
-    }): Promise<PageBeanUserKey>;
+        maxResult?: number | undefined;
+    }) => Promise<PageBeanUserKey>;
     /**
      * Returns a list of active users that match the search string and property.
      *
@@ -350,7 +350,7 @@ export declare class UserSearchService extends CommonHttpService {
      * read:avatar:jira, read:group:jira
      * @see https://developer.atlassian.com/cloud/jira/platform/rest/v3/api-group-user-search#api-rest-api-3-user-search-get
      */
-    findUsers({ query, username, accountId, startAt, maxResults, property, }?: {
+    findUsers: ({ query, username, accountId, startAt, maxResults, property, }?: {
         /**
          * A query string that is matched against user attributes ( `displayName`, and
          * `emailAddress`) to find relevant users. The string can match the prefix of the
@@ -358,20 +358,20 @@ export declare class UserSearchService extends CommonHttpService {
          * `displayName` of *John Smith* and a user with an `emailAddress` of
          * *johnson@example.com*. Required, unless `accountId` or `property` is specified.
          */
-        query?: string;
-        username?: string;
+        query?: string | undefined;
+        username?: string | undefined;
         /**
          * A query string that is matched exactly against a user `accountId`. Required,
          * unless `query` or `property` is specified.
          */
-        accountId?: string;
+        accountId?: string | undefined;
         /**
          * The index of the first item to return in a page of filtered results (page
          * offset).
          */
-        startAt?: number;
+        startAt?: number | undefined;
         /** The maximum number of items to return per page. */
-        maxResults?: number;
+        maxResults?: number | undefined;
         /**
          * A query string used to search properties. Property keys are specified by path,
          * so property keys containing dot (.) or equals (=) characters cannot be used.
@@ -380,8 +380,8 @@ export declare class UserSearchService extends CommonHttpService {
          * `thepropertykey.something.nested=1`. Required, unless `accountId` or `query` is
          * specified.
          */
-        property?: string;
-    }): Promise<User[]>;
+        property?: string | undefined;
+    }) => Promise<User[]>;
     /**
      * Finds users with a structured query and returns a [paginated](#pagination) list
      * of user details.
@@ -430,14 +430,14 @@ export declare class UserSearchService extends CommonHttpService {
      * read:group:jira
      * @see https://developer.atlassian.com/cloud/jira/platform/rest/v3/api-group-user-search#api-rest-api-3-user-search-query-get
      */
-    findUsersByQuery({ query, startAt, maxResults, }: {
+    findUsersByQuery: ({ query, startAt, maxResults, }: {
         /** The search query. */
         query: string;
         /** The index of the first item to return in a page of results (page offset). */
-        startAt?: number;
+        startAt?: number | undefined;
         /** The maximum number of items to return per page. */
-        maxResults?: number;
-    }): Promise<PageBeanUser>;
+        maxResults?: number | undefined;
+    }) => Promise<PageBeanUser>;
     /**
      * Returns a list of users whose attributes match the query term. The returned
      * object includes the `html` field where the matched query term is highlighted
@@ -487,7 +487,7 @@ export declare class UserSearchService extends CommonHttpService {
      * @scopes-beta read:user:jira
      * @see https://developer.atlassian.com/cloud/jira/platform/rest/v3/api-group-user-search#api-rest-api-3-user-picker-get
      */
-    findUsersForPicker({ query, maxResults, showAvatar, exclude, excludeAccountIds, avatarSize, excludeConnectUsers, }: {
+    findUsersForPicker: ({ query, maxResults, showAvatar, exclude, excludeAccountIds, avatarSize, excludeConnectUsers, }: {
         /**
          * A query string that is matched against user attributes, such as `displayName`,
          * and `emailAddress`, to find relevant users. The string can match the prefix of
@@ -500,15 +500,15 @@ export declare class UserSearchService extends CommonHttpService {
          * The maximum number of items to return. The total number of matched users is
          * returned in `total`.
          */
-        maxResults?: number;
+        maxResults?: number | undefined;
         /** Include the URI to the user's avatar. */
-        showAvatar?: boolean;
+        showAvatar?: boolean | undefined;
         /**
          * This parameter is no longer available. See the [deprecation
          * notice](https://developer.atlassian.com/cloud/jira/platform/deprecation-notice-user-privacy-api-migration-guide/)
          * for details.
          */
-        exclude?: string[];
+        exclude?: string[] | undefined;
         /**
          * A list of account IDs to exclude from the search results. This parameter
          * accepts a comma-separated list. Multiple account IDs can also be provided using
@@ -516,10 +516,10 @@ export declare class UserSearchService extends CommonHttpService {
          * `excludeAccountIds=5b10a2844c20165700ede21g,5b10a0effa615349cb016cd8&excludeAccountIds=5b10ac8d82e05b22cc7d4ef5`.
          * Cannot be provided with `exclude`.
          */
-        excludeAccountIds?: string[];
-        avatarSize?: string;
-        excludeConnectUsers?: boolean;
-    }): Promise<FoundUsers>;
+        excludeAccountIds?: string[] | undefined;
+        avatarSize?: string | undefined;
+        excludeConnectUsers?: boolean | undefined;
+    }) => Promise<FoundUsers>;
     /**
      * Returns a list of users who fulfill these criteria:
      *
@@ -604,7 +604,7 @@ export declare class UserSearchService extends CommonHttpService {
      * read:avatar:jira, read:group:jira
      * @see https://developer.atlassian.com/cloud/jira/platform/rest/v3/api-group-user-search#api-rest-api-3-user-permission-search-get
      */
-    findUsersWithAllPermissions({ query, username, accountId, permissions, issueKey, projectKey, startAt, maxResults, }: {
+    findUsersWithAllPermissions: ({ query, username, accountId, permissions, issueKey, projectKey, startAt, maxResults, }: {
         /**
          * A query string that is matched against user attributes, such as `displayName`
          * and `emailAddress`, to find relevant users. The string can match the prefix of
@@ -612,18 +612,18 @@ export declare class UserSearchService extends CommonHttpService {
          * `displayName` of *John Smith* and a user with an `emailAddress` of
          * *johnson@example.com*. Required, unless `accountId` is specified.
          */
-        query?: string;
+        query?: string | undefined;
         /**
          * This parameter is no longer available. See the [deprecation
          * notice](https://developer.atlassian.com/cloud/jira/platform/deprecation-notice-user-privacy-api-migration-guide/)
          * for details.
          */
-        username?: string;
+        username?: string | undefined;
         /**
          * A query string that is matched exactly against user `accountId`. Required,
          * unless `query` is specified.
          */
-        accountId?: string;
+        accountId?: string | undefined;
         /**
          * A comma separated list of permissions. Permissions can be specified as any:
          *
@@ -667,14 +667,14 @@ export declare class UserSearchService extends CommonHttpService {
          */
         permissions: string;
         /** The issue key for the issue. */
-        issueKey?: string;
+        issueKey?: string | undefined;
         /** The project key for the project (case sensitive). */
-        projectKey?: string;
+        projectKey?: 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. */
-        maxResults?: number;
-    }): Promise<User[]>;
+        maxResults?: number | undefined;
+    }) => Promise<User[]>;
     /**
      * Returns a list of users who fulfill these criteria:
      *
@@ -756,7 +756,7 @@ export declare class UserSearchService extends CommonHttpService {
      * read:avatar:jira, read:group:jira
      * @see https://developer.atlassian.com/cloud/jira/platform/rest/v3/api-group-user-search#api-rest-api-3-user-viewissue-search-get
      */
-    findUsersWithBrowsePermission({ query, username, accountId, issueKey, projectKey, startAt, maxResults, }?: {
+    findUsersWithBrowsePermission: ({ query, username, accountId, issueKey, projectKey, startAt, maxResults, }?: {
         /**
          * A query string that is matched against user attributes, such as `displayName`
          * and `emailAddress`, to find relevant users. The string can match the prefix of
@@ -764,29 +764,29 @@ export declare class UserSearchService extends CommonHttpService {
          * `displayName` of *John Smith* and a user with an `emailAddress` of
          * *johnson@example.com*. Required, unless `accountId` is specified.
          */
-        query?: string;
+        query?: string | undefined;
         /**
          * This parameter is no longer available. See the [deprecation
          * notice](https://developer.atlassian.com/cloud/jira/platform/deprecation-notice-user-privacy-api-migration-guide/)
          * for details.
          */
-        username?: string;
+        username?: string | undefined;
         /**
          * A query string that is matched exactly against user `accountId`. Required,
          * unless `query` is specified.
          */
-        accountId?: string;
+        accountId?: string | undefined;
         /** The issue key for the issue. Required, unless `projectKey` is specified. */
-        issueKey?: string;
+        issueKey?: string | undefined;
         /**
          * The project key for the project (case sensitive). Required, unless `issueKey`
          * is specified.
          */
-        projectKey?: string;
+        projectKey?: 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. */
-        maxResults?: number;
-    }): Promise<User[]>;
+        maxResults?: number | undefined;
+    }) => Promise<User[]>;
     static initialize(): void;
 }