K.hqdZddlmZddlZddlZddlZddlZddlZddlZ ddl Z ddl Z ddl Z ddl Z ddlZddlZddlZddlZddlmZddlmZmZddlmZmZddlmZddlmZdd lmZm Z m!Z!m"Z"m#Z#m$Z$m%Z%m&Z&dd l'm(Z(m)Z)m*Z*ddl+Z+dd l,m-Z.dd l+m/Z/dd l0m1Z1ddl2m3Z3ddl4m5Z5ddl6m7Z7ddl8m9Z9ddl:m;Z;mZ>m?Z?ddl@mAZAmBZBmCZCmDZDmEZEmFZFmGZGmHZHmIZImJZJmKZKmLZLmMZMmNZNmOZOmPZPmQZQmRZRmSZSmTZTmUZUmVZVmWZWmXZXmYZYmZZZm[Z[m\Z\m]Z]m^Z^m_Z_m`Z`maZambZbmcZcmdZdmeZemfZfmgZgmhZhmiZimjZjmkZkddllmmZmmnZnmoZo ddlpmqZqn #er$rYnwxYwe jsdZtetue jvd2dZwd2dZxd3dZy d4d5d$Zze$d%d&e_'Z{Gd(d)e|e!e{Z}Gd*d+Z~Gd,d-e1ZGd.d/e1ZGd0d1ZdS)6aAJira Client module. This module implements a friendly (well, friendlier) interface between the raw JSON responses from Jira and the Resource/dict abstractions provided by this library. Users will construct a JIRA object as described below. Full API documentation can be found at: https://jira.readthedocs.io/en/latest/. ) annotationsN) OrderedDict)IterableIterator)cachewraps)BufferedReader)Number)AnyCallableGenericLiteral SupportsIndexTypeVar no_type_checkoverload)parse_qsquoteurlparse)parse)Response)AuthBase)CaseInsensitiveDict)get_netrc_auth)MultipartEncoder) __version__) JIRAErrorNotJIRAInstanceError)PrepareRequestForRetryResilientSession)+ AgileResource AttachmentBoardComment ComponentCustomerCustomFieldOption DashboardDashboardGadgetDashboardItemPropertyDashboardItemPropertyKeyFieldFilterGroupIssue IssueLink IssueLinkType IssuePropertyIssueSecurityLevelScheme IssueTypeIssueTypeSchemeNotificationSchemePermissionScheme PinnedCommentPriorityPrioritySchemeProject RemoteLink RequestType ResolutionResourceRole SecurityLevel ServiceDeskSprintStatusStatusCategoryUserVersionVotesWatchersWorkflowSchemeWorklog) json_loadsremove_empty_attributesthreaded_requests)JWTAuthjira client_methodr returnc0tfd}|S)aSA convenience decorator to check if the Jira instance is cloud. Checks if the client instance is talking to Cloud Jira. If it is, return the result of the called client method. If not, return None and log a warning. Args: client_method: The method that is being called by the client. Returns: Either the result of the wrapped function or None. Raises: JIRAError: In the case the error is not an HTTP error with a status code. NotJIRAInstanceError: In the case that the first argument to this method is not a `client.JIRA` instance. ctd|D}t|tst||jr|i|S|jddS)Nc3K|]}|VdSN.0args ]/Users/user/workspace/sujinbaek/cqa-test-app/venv/lib/python3.11/site-packages/jira/client.py z4cloud_api..check_if_cloud..",,,,,,,,zIThis functionality is not available on Jira Data Center (Server) version.)next isinstanceJIRAr _is_cloudlogwarning)argskwargsinstancerQs r[check_if_cloudz!cloud_api..check_if_clouds,,t,,,,,(D)) 1&x00 0   2 =$1&11 1  W   tr^r)rQrhs` r[ cloud_apirjns4$ -      r^c0tfd}|S)aKA convenience decorator to inform if a client method is experimental. Indicates the path covered by the client method is experimental. If the path disappears or the method becomes disallowed, this logs an error and returns None. If another kind of exception is raised, this reraises. Raises: JIRAError: In the case the error is not an HTTP error with a status code. NotJIRAInstanceError: In the case that the first argument to this method is is not a `client.JIRA` instance. Returns: Either the result of the wrapped function or None. cNtd|D}t|tst| |i|S#t$rR}t |dd}|9|jdvr0|jd|j d|jYd}~dSd}~wwxYw)Nc3K|]}|VdSrVrWrXs r[r\zFexperimental_atlassian_api..is_experimental..r]r^response)izFunctionality at path z# is/was experimental. Status Code: ) r_r`rarrgetattr status_codercrdurl)rerfrgernrQs r[is_experimentalz3experimental_atlassian_api..is_experimentals,,t,,,,,(D)) 1&x00 0  =$1&11 1   q*d33H#(< (J(J $$;X\;;$,$8;;ttttt sA B$ABBB$ri)rQrts` r[experimental_atlassian_apirus4 -$ r^funcc>tdfd }|S)zDecorator that converts Issue and Project resources to their keys when used as arguments. Args: func (Callable): the function to decorate rer rfrRc g}|D]}t|ttzr||j:t|t r||jj|||i|}|SrV)r`r/r;appendkeyr1name)rerfarg_listrZresultrvs r[wrapperz(translate_resource_args..wrappers % %C#uw// %((((C// %))))$$$$x*6** r^)rer rfr rRr ri)rvr~s` r[translate_resource_argsrs: 4[[     [  Nr^fieldsdict[str, Any] | None fieldargsr 5dict[str, dict[str, Any]] | dict[str, dict[str, str]]c |d|iSd|iS)NrrW)rrs r[ _field_workerrs &!! i  r^ ResourceTypeT) contravariantboundcteZdZ dddZddZd fd Zed!dZed"dZdZxZS)# ResultListNriterableIterable | None_startAtint _maxResults_total int | None_isLast bool | None_nextPageToken str | NonerRNonec&|t||nt|||_||_||_||nt ||_|rt|ng|_|j|_||_ dS)aResults List. Args: iterable (Iterable): [description]. Defaults to None. _startAt (int): Start page. Defaults to 0. _maxResults (int): Max results per page. Defaults to 0. _total (Optional[int]): Total results from query. Defaults to 0. _isLast (Optional[bool]): True to mark this page is the last page? (Default: ``None``). _nextPageToken (Optional[str]): Token for fetching the next page of results. Defaults to None. see `The official API docs `_ N) list__init__startAt maxResultsisLastlentotalrcurrent nextPageToken)selfrrrrrrs r[rzResultList.__init__s(   MM$ ) ) ) ) MM$    % %1VVs4yy >F,NDNNNB | +r^rcz|xjdz c_|j|jkrt|j|jdz SN)rr StopIterationrrs r[__next__zResultList.__next__s;  <$* $ $ =!12 2r^Iterator[ResourceType]cDtSrV)super__iter__)r __class__s r[rzResultList.__iter__sww!!!r^ircdSrVrW)rrs r[ __getitem__zResultList.__getitem__s=@Sr^sslicelist[ResourceType]cdSrVrW)rrs r[rzResultList.__getitem__s;>3r^c8t||SrV)rr)rslice_or_indexs r[rzResultList.__getitem__sn555r^)NrrNNN)rrrrrrrrrrrrrRr)rRr)rRr)rrrRr)rrrRr) __name__ __module__ __qualname__rrrrr __classcell__)rs@r[rrs%)!#%)!,!,!,!,!,F3333""""""@@@X@ >>>X>6666666r^rc&eZdZdZdZdZdZdS) QshGeneratorc||_dSrV) context_path)rrs r[rzQshGenerator.__init__s(r^c||}tj|dS)Nzutf-8) _generate_qshhashlibsha256encode hexdigest)rreqqshs r[__call__zQshGenerator.__call__s=  %%~cjj1122<<>>>r^ct|j}tjdkr!|jtjdn|j}t |jdfdDdfdt D}|j d|d|}|S)NrT)keep_blank_valuesc ni|]1}|d|2S),)join_sort_and_quote_values)rYrzparamsrs r[ z.QshGenerator._generate_qsh..,sF   HKC$55fSkBBCC   r^&c32K|]}|d|VdS)=NrW)rYrzjoineds r[r\z-QshGenerator._generate_qsh../s5QQCC//&+//QQQQQQr^) rrrrrpathrqueryrsortedkeysmethodupper)rr parse_resultrrrrrs` @@r[rzQshGenerator._generate_qsh s(( 4$%%))  c$"34466 7 7" ,,EEE     OU   QQQQ6&++--;P;PQQQQQ!!##44d44U44 r^c8t|}d|DS)Nc0g|]}t|dS)~safe)r)rYvalues r[ z7QshGenerator._sort_and_quote_values..6s%CCC5e#&&&CCCr^)r)rvaluesordered_valuess r[rz#QshGenerator._sort_and_quote_values4s!CCNCCCCr^N)rrrrrrrrWr^r[rrsU)))???(DDDDDr^rcjeZdZdZddZed Zd Zd ZddZ dZ ddZ ddZ ddZ ddZdS)JiraCookieAuthzJira Cookie Authentication. Allows using cookie authentication as described by `jira api docs `_ sessionr session_api_urlstrauthtuple[str, str]cL||_||_||_d|_d|_dS)a Cookie Based Authentication. Args: session (ResilientSession): The Session object to communicate with the API. session_api_url (str): The session api url to use. auth (Tuple[str, str]): The username, password tuple. rrN)_session_session_api_url_JiraCookieAuth__auth_retry_counter_401_max_allowed_401_retries)rrrrs r[rzJiraCookieAuth.__init__?s0  / "#()%%%r^c|jjSrV)rcookiesrs r[rzJiraCookieAuth.cookiesOs }$$r^c&|xjdz c_dSrrrs r[_increment_401_retry_counterz+JiraCookieAuth._increment_401_retry_counterSs 1$r^cd|_dSNrrrs r[_reset_401_retry_counterz'JiraCookieAuth._reset_401_retry_counterVs"#r^requestrequests.PreparedRequestc<|d|j|S)Nrn) register_hook handle_401rrs r[rzJiraCookieAuth.__call__Ysj$/:::r^c|j\}}||d}|j|jt j|}|dS)zInitialise the Session object's cookies, so we can use the session cookie. Raises HTTPError if the post returns an erroring http response )usernamepassworddataN)rrpostrjsondumpsraise_for_status)rrrauthentication_datars r[ init_sessionzJiraCookieAuth.init_session]sg "[(+3JJ M    ! 3F(G(G    r^rnrequests.ResponserRc @|jdkr~|j|jkrntd||||j }| |S)zRefresh cookies if the session cookie has expired. Then retry the request. Args: response (requests.Response): the response with the possible 401 to handle Returns: requests.Response iz,Trying to refresh the cookie auth session...) rqrrLOGinforr process_original_requestrcopyr)rrnrfs r[rzJiraCookieAuth.handle_401is  C ' ''$*GGG HHC D D D  - - / / /      44X5E5J5J5L5LMMH %%'''r^original_requestcV||||SrV)update_cookies send_requestrrs r[rz'JiraCookieAuth.process_original_request}s, ,---  !1222r^c\d|jvr|jd=||jdS)NCookie)headersprepare_cookiesrrs r[rzJiraCookieAuth.update_cookiess: '/ / / (2((66666r^c6|j|SrV)rsendrs r[rzJiraCookieAuth.send_requests}!!'***r^N)rr rrrr)rr)rnr rRr )rr)rrr__doc__rpropertyrrrrr rrrrrWr^r[rr9s **** %%X%%%%$$$   (33337777++++++r^rc"eZdZdZd dZd dZdS) TokenAuthzBearer Token Authentication.tokenrc||_dSrV)_token)rrs r[rzTokenAuth.__init__s  r^rrc*d|j|jd<|S)NzBearer authorization)r!r)rrs r[rzTokenAuth.__call__s%Ze dBd@Ze dCdAZdDdCZdDZdEZdFZdEdHZdIZddJde dfdFdUZedJde dfdGdVZdHdZZdId\ZdBd]Z dJdKdcZedLdMdfZ dNdOdiZ dPdkZ!dQdRdnZ"dSdqZ#dTdsZ$e% dNdUdyZ&dVd{Z'dWd|Z(e% dXdYdZ)dWdZ*dVdZ+dZdZ, d[d\dZ-d]dZ.ee/ d^d_dZ0ee/ d^d`dZ1ee/dadZ2dbdZ3dcdZ4dddZ5ee/dedZ6ee/dfdZ7ee/ dgdhdZ8didZ9djdZ:dkdZ; dldmdZ< dldndZ=dNdodZ> dpdqdZ?drdZ@dsdZAdsdZB d^dtdńZC dudvdDŽZD dQdwdɄZEdʄZFdxd΄ZGdydЄZHdzd҄ZIe dudvdӄZJd{dՄZK d|d}dׄZL d|d~dلZMdgdddfddZNddZOddZPe%ddZQe% dlddZRe% dNddZSe% dddZTe%ddZUe%ddZVe%ddZW d^ddZXddZYe%dddZZddZ[e% d^dd Z\e%dd Z]e%dd Z^e%ddZ_e%ddZ`e%ddZae%ddZbe%ddZce%ddZde%ddZee%ddZfe%ddZge%ddZhe%dd Zie% ddd(Zje%dd*Zke%dd,Zle%dd-Zme% dNdd2ZndWd3Zodd5Zpddd8Zqdd:Zrdd<Zs d|dd>Zt d|ddAZuddCZvdNddDZwddGZxddHZy dddOZzddQZ{ddSZ|dNddUZ}dNddWZ~e%ddXZe% ddd]Ze%dd_Ze%ddaZe%ddbZe%dddZe%ddfZe%ddiZe%ddlZe%ddnZe%ddpZddrZddtZe ddddvdd}Ze ddd~ddZ ddddvddZe ddddvdĐdZedddŐdZdƐdZdǐdZdǐdZdȐdZdɐdZdʐdZdːdZd̐dZdNd͐dZ d|dΐdZ dϐdАdZdѐdZ ddҐdZdӐdZdԐdZdԐdZe%ddddՐdZ d֐dאdZ dؐdِdZe% dڐdېdZ ddܐdZdNdݐdZdWdZdWdZdސdZdߐdZddZddZddZ dNddZdZdZedNdd„ZddÄZddĄZdńZe fddDŽZe fddȄZe fddɄZde dfddʄZ dNdd΄ZdτZddфZddԄZddՄZddքZddd؄Z ddd܄Zdd݄ZddބZdNdd߄ZÐdNddZ dQddZŐdZeǐddZeǐdZeǐddZeǐdZeǐdZeǐddZeǐdZeǐdZeǐdZeǐdZѐdWdZҐdWdZӐddZ dddZ ddd Z֐dd Zאdd ZؐdidZِddZ e% dddZe% dddZ dddZ dddZސd d Zߐd d!Zd d"Zd d#Zd d%Zd&Z d d d/Z d^dd0Zdd2Z dNdd6Z ddd9Zdd:Ze%dd<Ze%dd>ZdS(raaUser interface to Jira. Clients interact with Jira by constructing an instance of this object and calling its methods. For addressable resources in Jira -- those with "self" links -- an appropriate subclass of :py:class:`jira.resources.Resource` will be returned with customized ``update()`` and ``delete()`` methods, along with attribute access to fields. This means that calls of the form ``issue.fields.summary`` will be resolved into the proper lookups to return the JSON value at that mapping. Methods that do not return resources will return a dict constructed from the JSON response or a scalar value; see each method's documentation for details on what that method returns. Without any arguments, this client will connect anonymously to the Jira instance started by the Atlassian Plugin SDK from one of the 'atlas-run', ``atlas-debug`` or ``atlas-run-standalone`` commands. By default, this instance runs at ``http://localhost:2990/jira``. The ``options`` argument can be used to set the Jira instance to use. Authentication is handled with the ``basic_auth`` argument. If authentication is supplied (and is accepted by Jira), the client will remember it for subsequent requests. For quick command line access to a server, see the ``jirashell`` script included with this distribution. The easiest way to instantiate is using ``j = JIRA("https://jira.atlassian.com")`` serverzhttp://localhost:2990/jiraauth_urlz/rest/auth/1/sessionr/ rest_pathapirest_api_version2agile_rest_pathagile_rest_api_versionz1.0verifyT resilientasyncF async_workers client_certN check_update delay_reloadrrzno-cacheapplication/jsonno-check)z Cache-Control Content-TypeX-Atlassian-Tokendefault_batch_sizedroptions"dict[str, str | bool | Any] | None basic_authtuple[str, str] | None token_authoauthrjwtkerberos_optionsget_server_infoboolasync_rlogging max_retriesproxies Any | Nonetimeout>None | float | tuple[float, float] | tuple[float, None] | Nonerdefault_batch_sizes'dict[type[Resource], int | None] | Nonecttj|_|7i}|r3t |t rt jdt|}d}|r||d<| r | |d<| |d<t | r tj n tj t|_tjt"j|_|r |jd|d|vrtj|d}|d=ni}|j||jd|d|_t |jdt,sJ|jdd r|jddd |jd<t1|jj}t7|d kr ||jd <|t |jdt sJt;| |_|| |jj!|jdd|jvr*|jj"|jd||j_#|r ||j_$|r|%|no|r |j&|nb|r|'|nJ|r|(|n2|r|)|n|r|*|d} ||_+| r9|,}|j-|p |p|p|p|pd}t]d|d|_/| rz|0} t|d|_1n/#td$r"}|j3d||d}~wwxYw|4d|_/nd|_1|jdr,t"j5s |6dt"_5i|_7dS)a4Construct a Jira client instance. Without any arguments, this client will connect anonymously to the Jira instance started by the Atlassian Plugin SDK from one of the 'atlas-run', ``atlas-debug`` or ``atlas-run-standalone`` commands. By default, this instance runs at ``http://localhost:2990/jira``. The ``options`` argument can be used to set the Jira instance to use. Authentication is handled with the ``basic_auth`` or ``token_auth`` argument. If authentication is supplied (and is accepted by Jira), the client will remember it for subsequent requests. For quick command line access to a server, see the ``jirashell`` script included with this distribution. The easiest way to instantiate is using ``j = JIRA("https://jira.atlasian.com")`` Args: server (Optional[str]): The server address and context path to use. Defaults to ``http://localhost:2990/jira``. options (Optional[Dict[str, bool, Any]]): Specify the server and properties this client will use. Use a dict with any of the following properties: * server -- the server address and context path to use. Defaults to ``http://localhost:2990/jira``. * rest_path -- the root REST path to use. Defaults to ``api``, where the Jira REST resources live. * rest_api_version -- the version of the REST resources under rest_path to use. Defaults to ``2``. * agile_rest_path - the REST path to use for Jira Agile requests. Defaults to ``agile``. * verify (Union[bool, str]) -- Verify SSL certs. (Default: ``True``). Or path to a CA_BUNDLE file or directory with certificates of trusted CAs, for the `requests` library to use. * client_cert (Union[str, Tuple[str,str]]) -- Path to file with both cert and key or a tuple of (cert,key), for the `requests` library to use for client side SSL. * check_update -- Check whether using the newest python-jira library version. * headers -- a dict to update the default headers the session uses for all API requests. basic_auth (Optional[Tuple[str, str]]): A tuple of username and password to use when establishing a session via HTTP BASIC authentication. token_auth (Optional[str]): A string containing the token necessary for (PAT) bearer token authorization. oauth (Optional[Any]): A dict of properties for OAuth authentication. The following properties are required: * access_token -- OAuth access token for the user * access_token_secret -- OAuth access token secret to sign with the key * consumer_key -- key of the OAuth application link defined in Jira * key_cert -- private key file to sign requests with (should be the pair of the public key supplied to Jira in the OAuth application link) * signature_method (Optional) -- The signature method to use with OAuth. Defaults to oauthlib.oauth1.SIGNATURE_HMAC_SHA1 kerberos (bool): True to enable Kerberos authentication. (Default: ``False``) kerberos_options (Optional[Dict[str,str]]): A dict of properties for Kerberos authentication. The following properties are possible: * mutual_authentication -- string DISABLED or OPTIONAL. Example kerberos_options structure: ``{'mutual_authentication': 'DISABLED'}`` jwt (Optional[Any]): A dict of properties for JWT authentication supported by Atlassian Connect. The following properties are required: * secret -- shared secret as delivered during 'installed' lifecycle event (see https://developer.atlassian.com/static/connect/docs/latest/modules/lifecycle.html for details) * payload -- dict of fields to be inserted in the JWT payload, e.g. 'iss' Example jwt structure: ``{'secret': SHARED_SECRET, 'payload': {'iss': PLUGIN_KEY}}`` validate (bool): True makes your credentials first to be validated. Remember that if you are accessing Jira as anonymous it will fail. (Default: ``False``). get_server_info (bool): True fetches server version info first to determine if some API calls are available. (Default: ``True``). async_ (bool): True enables async requests for those actions where we implemented it, like issue update() or delete(). (Default: ``False``). async_workers (int): Set the number of worker threads for async operations. timeout (Optional[Union[Union[float, int], Tuple[float, float]]]): Set a connect/read timeout for the underlying calls to Jira. Obviously this means that you cannot rely on the return code when this is enabled. max_retries (int): Sets the amount Retries for the HTTP sessions initiated by the client. (Default: ``3``) proxies (Optional[Any]): Sets the proxies for the HTTP session. auth (Optional[Tuple[str,str]]): Set a cookie auth token if this is required. logging (bool): True enables loglevel to info => else critical. (Default: ``True``) default_batch_sizes (Optional[Dict[Type[Resource], Optional[int]]]): Manually specify the batch-sizes for the paginated retrieval of different item types. `Resource` is used as a fallback for every item type not specified. If an item type is mapped to `None` no fallback occurs, instead the JIRA-backend will use its default batch-size. By default all Resources will be queried in batches of 100. E.g., setting this to ``{Issue: 500, Resource: None}`` will make :py:meth:`search_issues` query Issues in batches of 500, while every other item type's batch-size will be controlled by the backend. (Default: None) NzpOld API usage, use JIRA(url) or JIRA(options={'server': url}, when using dictionary always use named parameters.r%r0r1r:rr'rrrLr)rDT anonymouszCan not log in with versionNumberszinvalid server_info: %sdeploymentType)rrrr4)8tuplesys version_infosys_version_infor`dictwarningswarnDeprecationWarningr setLevel_loggingINFOCRITICALrcrdeepcopyraDEFAULT_OPTIONS_optionsupdate_rankrendswithr server_urlrr _try_magicr r_add_client_cert_to_session'_add_ssl_cert_verif_strategy_to_sessionrrrIrJ_create_oauth_session_create_http_basic_session_create_jwt_session_create_token_session_create_kerberos_session_create_cookie_authrrrawrrV server_info_version Exceptionerrorgetchecked_version_check_update__fields_cache_value)rr%r=r?rArBrCkerberosrDvalidaterErGr1rHrIrJrLrrNrruser auth_methodsirss r[rz JIRA.__init__sB!&c&6 7 7 ?G *VT22  G&!  ' &GH   5%GG '4GO $ gDX]]83DEEE(, d6J(K(K  L M. / 6 67J K K K   i 233G ""G W%%% i ''000 $-1377777 = " + +C 0 0 C&*mH&=crc&BDM( #005 |  q ,8DM. ) $- 2D99999)999  ((*** 44666 $$T]9%=>>>  % % M ! ( (y)A B B B$/ !  ,$+DM !    & &u - - - -   +D +Z 8 8 8    $ $S ) ) ) )    & &z 2 2 2 2    ) );K ) L L L L    $ $T * * *H  F<<>>DxQZQ3Q(QdQk D{ D DEEE"  &!!##B  %b)9&: ; ;    8"=== #%&&)9":":D  %DM = ( (1E (    ! ! !#'D 35   s9O PO;;PrRdict[str, str]cF|js||jS)z9Cached dictionary of {Field Name: Field ID}. Lazy loaded.)r{_update_fields_cachers r[ _fields_cachezJIRA._fields_caches*' (  % % ' ' '''r^ci|_|D]!}d|vr|dD]}|d|j|<"dS)z/Update the cache used for `self._fields_cache`. clauseNamesidN)r{r)rfr{s r[rzJIRA._update_fields_caches_#%  = =A!!m,==D56tWD,T22 = =r^rc6t|jdS)zAReturn the server url. Returns: str r%)rrers r[rizJIRA.server_urls4=*+++r^c|jdvS)z5Return whether we are on a Cloud based Jira instance.)Cloud)rVrs r[rbzJIRA._is_clouds"j00r^rctjdtt|jdjdi|j||j_dS)NzOUse OAuth or Token based authentication instead of Cookie based Authentication.{server}{auth_url})rrrrW)r\r]r^rrformatrer)rrs r[rrzJIRA._create_cookie_auths`  8    ,M707HH$-HH    r^c tjdd}|dd}t|ttkr"t jdtd|dd Sd S#tj$rYd St$r%}|j |Yd }~d Sd }~wwxYw) z8Check if the current version of the library is outdated.z&https://pypi.python.org/pypi/jira/jsong5^I @rSr versionz3You are running an outdated version of Jira Python z. Current version is z.. Do not file any bugs against older versions.N) requestsrxr parse_versionrr\r]RequestExceptionrvrcrd)rrreleased_versionrss r[rzzJIRA._check_update_s <8%dff  $F|I6 -..{1K1KKK m+mml|mmmLK(    DD   H  Q          sA;BC CB<<Cc.|dS)zDestructor for JIRA instance.Nclosers r[__del__z JIRA.__del__s r^ct|dd}|/ |n#t$rYnwxYwd|_dSdS)Nr)rpr TypeErrorr)rrs r[rz JIRA.closesd$ D11          !DMMM  s * 77contentcfd|vr,|jdtd|dS)NzzGot SecurityTokenMissingzSecurityTokenMissing: T)rcrdr)rrs r[_check_for_html_errorzJIRA._check_for_html_errorsB +g 5 5 H  7 8 8 8>W>>?? ?tr^cXdfd|Dd}|S)NrCcDg|]}|dk|ddS)r{schemacustomIdrW)rYrsprint_field_names r[rz-JIRA._get_sprint_field_id..s<   y--- hK #---r^rr)rsprint_field_idrs @r[_get_sprint_field_idzJIRA._get_sprint_field_idsK$    [[]]      r^2 item_typetype[ResourceType] items_key request_pathrrrbaseuse_postResultList[ResourceType]c d} d} |jdr4 ddlm} | } n#t$rYnwxYw|jd} dfd } | } |r|| d <|r|| d <n||x}r|| d <||| || }||||}|} t|trk|d }|t|n|}|dd}|d d}|d d}nd}d }d}d}|s|pt|}|#||kr|j d||||p|pd|z}| |s|t||krg}| |j| }t|||D]}| } || d <|| d <||}|r)||t%j| n||| }|||D]S}|}t-|}|r,||||}||T| |s|||krt||kr| } || d <|| d <||| || }|r2||||}||||z }nn| |s|||krt||kt1|||||S)aFetch from a paginated end point. Args: item_type (Type[Resource]): Type of single item. ResultList of such items will be returned. items_key (Optional[str]): Path to the items in JSON returned from server. Set it to None, if response is an array, and not a JSON object. request_path (str): path in request URL startAt (int): index of the first record to be fetched. (Default: ``0``) maxResults (int): Maximum number of items to return. If maxResults evaluates as False, it will try to get all items in batches. (Default:50) params (Dict[str, Any]): Params to be used in all requests. Should not contain startAt and maxResults, as they will be added for each request created from this function. base (str): base URL to use for the requests. use_post (bool): Use POST endpoint instead of GET endpoint. Returns: ResultList Nr0r)FuturesSessionr1rRdict[str, Any]c|r8tjtjniSrV)rloadsrrrsr[ json_paramsz&JIRA._fetch_pages..json_params&s/>M K K K K K K"kmm  -%,K "  3(2K % %// :: :Z 3(2K %>> 4("  33Iy(SSW (D)) . W--&+&7E U#,,x77)1i)C)C&,4LLq,I,I)))*&,-)= 5CU )i*.D.DH$$j"!!  &D)?D1 Q +#,*s5zzE/A/A$&M%0[ $ =&&&N(-Z 'J'J 0 0 &1kmm 1< I.4= L1"mmL99 (MN//$*[:Q:Q/RRR!/!3!3C !3!L!L &,,Q////"/::#)==??#-h#7#7#:.2.G.G )9h//O"LL999'#(*u*<*<O,, 99$  .8K *09K -#~~$[th .  H *.*C*C%y(++ _555"i/ - '#(*u*<*<O,, 99*-/H%QX s  **cd}|dv} |pi} | r|n|| d<| d} g} | r| | d<n| dd||| ||} | |||| | d} | r| sn|t | | S) aFetch from a paginated API endpoint using `nextPageToken`. Args: item_type (Type[Resource]): Type of single item. Returns a `ResultList` of such items. items_key (Optional[str]): Path to the items in JSON returned from the server. request_path (str): Path in the request URL. maxResults (int): Maximum number of items to return per page. (Default: 50) params (Dict[str, Any]): Parameters to be sent with the request. base (str): Base URL for the requests. use_post (bool): Whether to use POST instead of GET. Returns: ResultList: List of fetched items. r;)rFrrTNr)r)rrxpoprrrr)rrrrrrrr DEFAULT_BATCH fetch_allrrrrns r[_fetch_pages_searchTokenzJIRA._fetch_pages_searchTokens2 *, |))++ 5>$NMMJ L!%0OOO$D$D $&  7/< O,,666~~[th&H LL229iRR S S S$LL99M M  % >>>>r^rrrc fd|r||n|DS#t$r9}tt|dztj|zd}~wwxYw)Nc>g|]}jj|SrW)rer)rYraw_issue_jsonrrs r[rz-JIRA._get_items_from_page..s=# $-GGr^z : )KeyErrorrrr)rrrrrss`` r[rzJIRA._get_items_from_pages  B?H'Ux ':':X   B B B3q66E>DJx,@,@@AA A Bs A 4AA rc|jd} ||}n+#t$r|td}YnwxYw|S)aReturn the batch size for the given resource type from the options. Check if specified item-type has a mapped batch-size, else try to fallback to batch-size assigned to `Resource`, else fallback to Backend-determined batch-size. Returns: Optional[int]: The batch size to use. When the configured batch size is None, the batch size should be determined by the JIRA-Backend. r:N)rerrxr?)rr batch_sizesitem_type_batch_sizes r[rzJIRA._get_batch_sizesh9= 9  C#.y#9  C C C#.??8T#B#B  C$#s%AAc|jS)z+Get the server this client is connected to.)rirs r[ client_infozJIRA.client_infos r^rQresource_formatidstuple[str, str] | int | strr?cft||j|j}|||S)aFind Resource object for any addressable resource on the server. This method is a universal resource locator for any REST-ful resource in Jira. The argument ``resource_format`` is a string of the form ``resource``, ``resource/{0}``, ``resource/{0}/sub``, ``resource/{0}/sub/{1}``, etc. The format placeholders will be populated from the ``ids`` argument if present. The existing authentication session will be used. The return value is an untyped Resource object, which will not support specialized :py:meth:`.Resource.update` or :py:meth:`.Resource.delete` behavior. Moreover, it will not know to return an issue Resource if the client uses the resource issue path. For this reason, it is intended to support resources that are not included in the standard Atlassian REST API. Args: resource_format (str): the subpath to the resource string ids (Optional[Tuple]): values to substitute in the ``resource_format`` string Returns: Resource )r?rerfind)rrrrs r[rz JIRA.finds0&OT]DMJJ cr^ sizect|jdrZ|jdt |jjd|dt j|jj|dSdS)zExecute all asynchronous jobs and wait for them to finish. By default it will run on 10 threads. Args: size (int): number of threads to run on. _async_jobszExecuting asynchronous z jobs found in queue by using z threads...)rN)hasattrrrcr rrrNmap)rrs r[async_doz JIRA.async_dos 4=- 0 0 H HMMy#dm.G*H*Hyyhlyyy     !$-";$ G G G G G G  H Hr^rz%dict[str, str] | list[dict[str, str]]cBi}|||d<|d|S)zReturn the mutable server application properties. Args: key (Optional[str]): the single property to return a value for Returns: Union[Dict[str, str], List[Dict[str, str]]] Nrzzapplication-propertiesrr)rrzrs r[application_propertieszJIRA.application_propertiess. ?F5M~~6v~FFFr^rc|d|z}||d}|j|tj|S)zSet the application property. Args: key (str): key of the property to set value (str): value to assign to the property zapplication-properties/)rrr)_get_latest_urlrputrr)rrzrrrpayloads r[set_application_propertyzJIRA.set_application_property'sO""#+> ???r^cachedrc||rt|dr|jS|jdz}|j|}t |}d|vr#t |tr|d|_ng|_|jS)zaList of application links. Returns: List[Dict]: json, or empty list _applicationlinksz*/rest/applinks/latest/listApplicationlinksr)rrrirrxrLr`r[)rrrrros r[applicationlinkszJIRA.applicationlinks2s *  *gd$788 *) )o LL M  c " " qMM Q;;:a..;%&vYD " "%'D "%%r^rr"c8|t|S)zGet an attachment Resource from the server for the specified ID. Args: id (str): The Attachment ID Returns: Attachment )_find_for_resourcer"rrs r[ attachmentzJIRA.attachmentJ&&z2666r^dict[str, int]c,|dS)zQGet the attachment metadata. Return: Dict[str, int] zattachment/metarrs r[attachment_metazJIRA.attachment_metaVs ~~/000r^issue str | intrstr | BufferedReaderfilenamec d}t|trt|d d}nD| t|tr-|jdkr"|j|jd| s9t tr$tj j d fd Gfdd t}| d |d } \}}|j |||| } |r n#|r wwxYwt!| } | rt| t"st%d | dt'|j|j t| t*r| dn| } | jdkrt%dd| d| z| S)aQAttach an attachment to an issue and returns a Resource for it. The client will *not* attempt to open or validate the attachment; it expects a file-like object to be ready for its use. The user is still responsible for tidying up (e.g., closing the file, killing the socket, etc.) Args: issue (Union[str, int]): the issue to attach the attachment to attachment (Union[str,BufferedReader]): file-like object to attach to the issue, also works if it is a string with the filename. filename (str): optional name for the attached file. If omitted, the file object's ``name`` attribute is used. If you acquired the file-like object by any other method than ``open()``, make sure that a name is specified in one way or the other. Returns: Attachment FrbTz6 was not opened in 'rb' mode, attaching file may fail.rR,tuple[MultipartEncoder, CaseInsensitiveDict]cdtddfi}t|jdd}||fS)z>Returns MultipartEncoder stream of attachment, and the header.rfilezapplication/octet-streamrr7) content-typer9)seekrr content_type) encoded_datarequest_headers attachment_iofnames r[&generate_multipartencoded_request_argszCJIRA.add_attachment..generate_multipartencoded_request_argssn   q ! ! !+ 7Q RSL2$0$=)3O  0 0r^c$eZdZdfd ZxZS)6JIRA.add_attachment..RetryableMultipartEncoderoriginal_request_kwargsrrRct\}}||d<||d<t|S)Nrr)rprepare)rrr r rrs r[rz>JIRA.add_attachment..RetryableMultipartEncoder.preparesF1W0V0X0X- o2>'/5D' 2ww'>???r^)rrrRr)rrrrr)rrs@r[RetryableMultipartEncoderrsN @ @ @ @ @ @ @ @ @ @ @r^rissue/z /attachments)rr_prepare_retry_classzUnable to parse JSON: z. Failed to add attachment?rzAdded empty attachment?!: z Response: z Attachment: )rRr)r`ropenr modercrdr{osrbasenamerrrrrrLrrr"rerr)rrrrclose_attachmentrrrr r rjsjira_attachmentrrrs @@@r[add_attachmentzJIRA.add_attachment^s*! j# & &  T22M#  &M*n55 */T:Q:Q  !^^^ 9M>BB 9G$$]%788E 1 1 1 1 1 1 1  @ @ @ @ @ @ @(> @ @ @mm8U88899 &,R,R,T,T )L/ ""!'%>%>%@%@ #A  &##%%%  &##%%%% &5?qMM VB11 VTRTTTUU U$ M4=:b$3G3G*O"Q%%R    1 $ $,AqAAAAB s %3D//Erc|dt|z}|j|S)zDelete attachment by id. Args: id (str): ID of the attachment to delete Returns: Response z attachment/rrrdeleterrrrs r[delete_attachmentzJIRA.delete_attachments6mmMCGG344}##C(((r^c8|t|S)zrGet a component Resource from the server. Args: id (str): ID of the component to get )rr%rs r[ componentzJIRA.components &&y"555r^r{projectr%c|||d}|||d<|||d<|||d<|d}|j|tj|} t |j|jt| } | S) apCreate a component inside a project and return a Resource for it. Args: name (str): name of the component project (str): key of the project to create the component in description (str): a description of the component leadUserName (Optional[str]): the username of the user responsible for this component assigneeType (Optional[str]): see the ComponentBean.AssigneeType class for valid values isAssigneeTypeValid (bool): True specifies whether the assignee type is acceptable (Default: ``False``) Returns: Component )r{r(isAssigneeTypeValidN description leadUserName assigneeTyper'rrs)rrrrrr%rerL) rr{r(r+r,r-r*rrrrr's r[create_componentzJIRA.create_components0#6    ""-D   ##/D  ##/D mmK(( M  sD)9)9  : :dmT] 1 NNN r^cb|dt|zdz}|dS)zyGet the count of related issues for a component. Args: id (str): ID of the component to use component//relatedIssueCounts issueCountrr)rrrs r[component_count_related_issuesz#JIRA.component_count_related_issuess8 $~~ 3r77 "%: :  L!!r^c|dt|z}|j|S)zDelete component by id. Args: id (str): ID of the component to use Returns: Response r1r"r$s r[delete_componentzJIRA.delete_components6mmL3r77233}##C(((r^r'c8|t|S)zGet a custom field option Resource from the server. Args: id (str): ID of the custom field to use Returns: CustomFieldOption )rr'rs r[custom_field_optionzJIRA.custom_field_option s&&'8"===r^ResultList[Dashboard]cRi}|||d<|tdd|||S)aReturn a ResultList of Dashboard resources and a ``total`` count. Args: filter (Optional[str]): either "favourite" or "my", the type of dashboards to return startAt (int): index of the first dashboard to return (Default: ``0``) maxResults (int): maximum number of dashboards to return. If maxResults set to False, it will try to get all items in batches. (Default: ``20``) Returns: ResultList[Dashboard] Nfilter dashboards dashboard)rr()rr=rrrs r[r>zJIRA.dashboardssC  %F8            r^r(c|t|}|j||pg|S)zGet a dashboard Resource from the server. Args: id (str): ID of the dashboard to get. Returns: Dashboard )rr(gadgetsrdashboard_gadgets)rrr?s r[r?zJIRA.dashboard3sI++Ir::   !7!7!;!;!ArBBBr^r+edit_permissionslist[dict] | list | Noneshare_permissionsct||pg|pg|d}|d}|j|t j|}t |}t|j|j|S)a*Create a new dashboard and return a dashboard resource for it. Args: name (str): Name of the new dashboard `required`. description (Optional[str]): Useful human-readable description of the new dashboard. edit_permissions (list | list[dict]): A list of permissions dicts `required` though can be an empty list. share_permissions (list | list[dict]): A list of permissions dicts `required` though can be an empty list. Returns: Dashboard r{editPermissionssharePermissionsr+r?rr.) rMrrrrrrLr(re) rr{r+rCrErrrrraw_dashboard_jsons r[create_dashboardzJIRA.create_dashboard@s, 7#3#9r$5$;*     mmK(( M  sD)9)9  : :-7]] ;MNNNNr^ct||pg|pg|d}|d}|d|d}|j||}t |} t |j|j| S)a2Copy an existing dashboard. Args: id (str): The ``id`` of the ``Dashboard`` to copy. name (str): Name of the new dashboard `required`. description (Optional[str]): Useful human-readable description of the new dashboard. edit_permissions (list | list[dict]): A list of permissions dicts `required` though can be an empty list. share_permissions (list | list[dict]): A list of permissions dicts `required` though can be an empty list. Returns: Dashboard rGr?r'z/copyrr.)rMrrrrLr(re) rrr{r+rCrErrrrrJs r[copy_dashboardzJIRA.copy_dashboardds0 7#3#9r$5$;*     mmK((  r    M  s  . .-7]] ;MNNNNr^minutesc|r|dznd}d|i}|d|d}|j||S)aUpdate the automatic refresh interval of a dashboard. Args: id (str): The ``id`` of the ``Dashboard`` to copy. minutes (int): The frequency of the dashboard automatic refresh in minutes. Returns: Response i`NautomaticRefreshMsz dashboards/z/automatic-refresh-msrM)_get_internal_urlrr)rrrOrrrrs r[*update_dashboard_automatic_refresh_minutesz/JIRA.update_dashboard_automatic_refresh_minutessZ&$+4%$e,$$%L2%L%L%LMM}  4 000r^ dashboard_iditem_id$ResultList[DashboardItemPropertyKey]c H|tdd|d|dS)a Return a ResultList of a Dashboard gadget's property keys. Args: dashboard_id (str): ID of dashboard. item_id (str): ID of dashboard item (``DashboardGadget``). Returns: ResultList[DashboardItemPropertyKey] r dashboard//items/ /properties)rr+)rrTrUs r[dashboard_item_property_keysz!JIRA.dashboard_item_property_keyss8  $  B B Bg B B B   r^ property_keyr*cB|t|||f}|S)aMGet the item property for a specific dashboard item (DashboardGadget). Args: dashboard_id (str): of the dashboard. item_id (str): ID of the item (``DashboardGadget``) on the dashboard. property_key (str): KEY of the gadget property. Returns: DashboardItemProperty )rr*)rrTrUr\dashboard_item_propertys r[r^zJIRA.dashboard_item_propertys.#'"9"9 !L'<#H# # '&r^c|d|d|d|}|j||}|jst |j|||||S)aSet a dashboard item property. Args: dashboard_id (str): Dashboard id. item_id (str): ID of dashboard item (``DashboardGadget``) to add property_key to. property_key (str): The key of the property to set. value (dict[str, Any]): The dictionary containing the value of the property key. Returns: DashboardItemProperty rXrY /properties/rMrqr)rrrokrrqr^)rrTrUr\rrrrs r[set_dashboard_item_propertyz JIRA.set_dashboard_item_propertysmm Q Q Qg Q Q< Q Q   M  c  . .t B qAAA A++L'<PPPr^list[DashboardGadget]c g}|tdd|d}|D]Y}|||jD];}|j|||j|j>>>?? M  s  . .*4Q--t}dmQQQQr^list[dict[str, Any]]c,|dS)z^Return a list of all issue fields. Returns: List[Dict[str, Any]] fieldrrs r[rz JIRA.fields7s ~~g&&&r^r-c8|t|S)zGet a filter Resource from the server. Args: id (str): ID of the filter to get. Returns: Filter )rr-rs r[r=z JIRA.filterA&&vr222r^ list[Filter]cNd}fd|D}|S)zGet a list of filter Resources which are the favourites of the currently authenticated user. Returns: List[Filter] zfilter/favouritecFg|]}tjj|SrW)r-rer)rYraw_filter_jsonrs r[rz*JIRA.favourite_filters..Ss9    4=$- A A   r^r)rr_jsonfilterss` r[favourite_filterszJIRA.favourite_filtersLsF (,~~6H'I'I    #)   r^jql favouriteci}|||d<|||d<|||d<|||d<|d}|j|tj|}t |}t |j|j|S) aCreate a new filter and return a filter Resource for it. Args: name (str): name of the new filter description (str): Useful human-readable description of the new filter jql (str): query string that defines the filter favourite (Optional[bool]): True adds this filter to the current user's favorites (Default: ``None``) Returns: Filter Nr{r+rrr=rr.)rrrrrrLr-re) rr{r+rrrrrrrs r[ create_filterzJIRA.create_filterYs$ "  DL  ""-D  ?DK  )D mmH%% M  sD)9)9  : :*4Q--dmT]HHHHr^c||}i}|p|j|d<|st|dr |p|j|d<|p|j|d<|p|j|d<|d|}|j|dditj |} tj | j } t|j|j| S) aUpdate a filter and return a filter Resource for it. Args: name (Optional[str]): name of the new filter description (Optional[str]): Useful human-readable description of the new filter jql (Optional[str]): query string that defines the filter favourite (Optional[bool]): True to add this filter to the current user's favorites (Default: ``None``) r{r+rrzfilter/r r6rrr.)r=r{rr+rrrrrrrrtextr-re) r filter_idr{r+rrr=rrrrrs r[ update_filterzJIRA.update_filterzs"Y''*v{V  D'&-88 D"-"C1CD 'VZU %9)9[mm1i1122 M   .*<=DJtDTDT   *QV,,dmT]HHHHr^expandr.czt|j|j}i}|||d<||||S)zGet a group Resource from the server. Args: id (str): ID of the group to get expand (Optional[Any]): Extra information to fetch inside each resource Returns: Group Nrr)r.rerr)rrrgrouprs r[rz JIRA.groupsGdmT]33  %F8  2f %%% r^'rexclude list[str]ci}g}|||d<|||d<|||d<|d|dD]}||dt|S) a_Return a list of groups matching the specified criteria. Args: query (Optional[str]): filter groups by name with this string exclude (Optional[Any]): filter out groups by name with this string maxResults (int): maximum results to return. (Default: ``9999``) Returns: List[str] Nrrrz groups/pickerrgroupsr{)rryr)rrrrrrrs r[rz JIRA.groupss "$  #F7O   'F9   !#-F< ^^OF^CCHM ) )E MM%- ( ( ( (f~~r^rrc |jdkrtd|dd}|d|}|dd}|dd}||d z kr|d |d zd |d zd d}|d|}|ddD]#}|dd|$|dd}|dd}||d z ki}|ddD]*}|dduo|ddk} |dduo|ddk} |d|d|d|d|dd|d|dd|| r|dn+| r|dn|d<,t t |dS)zReturn a hash or users with their information. Requires Jira 6.0 or will raise NotImplemented. Args: group (str): Name of the group. rrz_Group members is not implemented in Jira before version 6.0, upgrade the instance, if possible.users) groupnamerrrrz end-indexrzusers[:r]rrNrQr{ accountId displayName emailAddresshiddenactivetimezone)r{rrfullnameemailrrc|dSrrW)ts r[z$JIRA.group_members..s !r^rz)ruNotImplementedErrorrryrxrrr) rrrrr end_indexr2r~r}hasIdhasNames r[ group_memberszJIRA.group_memberssz =9 $ $%q  %88 NN76N 2 2z&!gJ{+ $("""D9q=DD9r>DDDF77B7 G, 1 1' 7#**400007 K0IW:f%D$(""gJw'  DHHTNN$.G488D>>R3GEhhv&&d2Mtxx7G7G27MG((hhtnn!XXk22 HH]33.(;;((8,, HHZ00 /DJJ/&)))+..   "6&,,..nnEEEFFFr^rc|d}t}||d<tj|}|j||dS)zCreate a new group in Jira. Args: groupname (str): The name of the group you wish to create. Returns: bool: True if successful. rr{rT)rrrrrr)rrrrxrs r[ add_groupzJIRA.add_groupsX""7++ MM& *Q-- 3W---tr^cp|d}d|i}|j||dS)zDelete a group from the Jira instance. Args: groupname (str): The group to be deleted from the Jira instance. Returns: bool: Returns True on success. rrrTrrr#)rrrrrs r[ remove_groupzJIRA.remove_groupsA""7++ ) $ S+++tr^ Issue | strr propertiesr/ct|tr|St|j|j}i}|||d<|||d<|||d<||||S)aGet an issue Resource from the server. Args: id (Union[Issue, str]): ID or key of the issue to get fields (Optional[str]): comma-separated string of issue fields to include in the results expand (Optional[str]): extra information to fetch inside each resource properties (Optional[str]): extra properties to fetch inside each result Returns: Issue Nrrrr)r`r/rerr)rrrrrrrs r[rz JIRA.issue)s~& b%  IdmT]33  %F8   %F8   !#-F<  2f %%% r^prefetchc ft|fi|}|dd}d}t|ttzr4|t|j}d|i|dd<|dd}t|trd|i|dd<nZt|trEd|t||rt|ndji|dd<|d}|j |tj |}t|} d | vr*t|j||tj | |r|| d St!|j|j| S) aCreate a new issue and return an issue Resource for it. Each keyword argument (other than the predefined ones) is treated as a field name and the argument's value is treated as the intended value for that field -- if the fields argument is used, all other keyword arguments will be ignored. By default, the client will immediately reload the issue Resource created by this method in order to return a complete Issue object to the caller; this behavior can be controlled through the 'prefetch' argument. Jira projects may contain many different issue types. Some issue screens have different requirements for fields in a new issue. This information is available through the 'createmeta' set of methods. Further examples are available here: https://developer.atlassian.com/display/JIRADEV/JIRA+REST+API+Example+-+Create+Issue Args: fields (Optional[Dict[str, Any]]): a dict containing field names and the values to use. If present, all other keyword arguments will be ignored prefetch (bool): True reloads the created issue Resource so all of its data is present in the value returned (Default: ``True``) Returns: Issue rr(Nr issuetyper(rrrz)rqrnrrrr.)rr`rrr(rissue_type_by_namerrrrrrLrrqrr/re) rrrrrp project_idrrrrs r[ create_issuezJIRA.create_issueKs2 -VAAyAA N9 % as # # ;c!ff--0J)-z(:DN9 % N; ' a   +/)DN; ' ' 3   d--FFz$KC OOOt.+DN; ' mmG$$ M  sD)9)9  : :#A  & &MA3TZPTEUEU   K::nU344 4 >JJJ Jr^ field_listc dgi}|D]}t|}|dd}d}t|ttzr4|t|j}d|i|dd<|dd}t|trd|i|dd<nZt|trEd|t||rt|ndji|dd<|d||d} |j |tj | } t| } nI#t$r<} | jd kr&| jtj| jj} nYd} ~ nd} ~ wwxYwg} i} | d D]}|d d | |d <t'|D]\}}|| vr!| d| |d|d*| dd}|r||d}nt-|j|j |}| d|d|d| S)a:Bulk create new issues and return an issue Resource for each successfully created issue. See `create_issue` documentation for field information. Args: field_list (List[Dict[str, Any]]): a list of dicts each containing field names and the values to use. Each dict is an individual issue to create and is subject to its minimum requirements. prefetch (bool): True reloads the created issue Resource so all of its data is present in the value returned (Default: ``True``) Returns: List[Dict[str, Any]] issueUpdatesrr(Nrrrz issue/bulkrierrors elementErrorsfailedElementNumberError)statusrwr input_fieldsissuesrrzr.Success)rrrwr)rr`rrr(rrryrrrrrrLrrqrnrr enumeraterrr/re)rrrr field_dict issue_datarrrrrrje issue_listrrwindexrrs r[ create_issueszJIRA.create_issuess"0 4$ 4 4J)6z)B)BJ8$Y/AJ!S3Y'' E!\\#a&&114 372D 8$Y/8$[1A!S!! 591I 8$[11As## $11A:(OJ425 8$[1  ' ' 3 3 3 3mmL))  ""3TZ-=-=">>A']]NN   ~$$)@!%BK,.s:      t}6F G G   r^r)rirLrrx)rrrrrprojectss` r[ service_deskszJIRA.service_deskssr o BB&1DM--c7-CCDD    $*8$4   r^rBc8|t|S)zGet a Service Desk Resource from the server. Args: id (str): ID or key of the Service Desk to get Returns: ServiceDesk )rrBrs r[ service_deskzJIRA.service_desks&&{B777r^c |}|d}d}t|ttzr||}nt|tr|}|j|d<|d}t|tr||d<n3t|tr|||j|d<|jdz}ddi}|j ||tj |} t| } d| vrt| j| |r|| dSt!|j|j| S) aCreate a new customer request and return an issue Resource for it. Each keyword argument (other than the predefined ones) is treated as a field name and the argument's value is treated as the intended value for that field -- if the fields argument is used, all other keyword arguments will be ignored. By default, the client will immediately reload the issue Resource created by this method in order to return a complete Issue object to the caller; this behavior can be controlled through the 'prefetch' argument. Jira projects may contain many issue types. Some issue screens have different requirements for fields in a new issue. This information is available through the 'createmeta' set of methods. Further examples are available here: https://developer.atlassian.com/display/JIRADEV/JIRA+REST+API+Example+-+Create+Issue Args: fields (Dict[str, Any]): a dict containing field names and the values to use. If present, all other keyword arguments will be ignored prefetch (bool): True reloads the created issue Resource so all of its data is present in the value returned (Default: ``True``) Returns: Issue serviceDeskIdN requestTypeIdz/rest/servicedeskapi/requestrrrissueKeyrar.)r`rrrrBrrequest_type_by_namerirrrrrLrrqrr/re) rrrrrrrrrrrrs r[create_customer_requestzJIRA.create_customer_requestsa4  ! as # # ,,Q//LL ; ' ' L ,_  ! a   R$%D ! ! 3   R$($=$=lA$N$N$QD !o >>&1 M  sG$*T:J:J  K K#A ^ + + qAAA A  K::nZ899 9 >JJJ Jr^rcj|js |jdkr td|jd|jddS)zCheck whether Jira deployment supports the createmeta issuetypes endpoint. Raises: JIRAError: If the deployment does not support the API endpoint. Returns: None rz"Unsupported JIRA deployment type: z or version: z. Use 'createmeta' instead.N)rbrurrVrs r[_check_createmeta_issuetypesz!JIRA._check_createmeta_issuetypesIs] > T]Y66,T5H,,W[Wd,,, 76r^projectIdOrKeyctjdtd||d|d||dS)aGet the issue types metadata for a given project, required to create issues. .. deprecated:: 3.6.0 Use :func:`project_issue_types` instead. This API was introduced in JIRA Server / DC 8.4 as a replacement for the more general purpose API 'createmeta'. For details see: https://confluence.atlassian.com/jiracore/createmeta-rest-endpoint-to-be-removed-975040986.html Args: projectIdOrKey (Union[str, int]): id or key of the project for which to get the metadata. startAt (int): Index of the first issue to return. (Default: ``0``) maxResults (int): Maximum number of issues to return. Total number of results is available in the ``total`` attribute of the returned :class:`ResultList`. If maxResults evaluates to False, it will try to get all issues in batches. (Default: ``50``) Returns: Dict[str, Any] zo'createmeta_issuetypes' is deprecated and will be removed in future releases.Use 'project_issue_types' instead. stacklevelissue/createmeta/ /issuetypesrrrr\r]r^rr)rrrrs r[createmeta_issuetypeszJIRA.createmeta_issuetypesXsu0   1      ))+++~~ ; ; ; ;"(   r^ issueTypeIdctjdtd||d|d|||dS)aGet the field metadata for a given project and issue type, required to create issues. .. deprecated:: 3.6.0 Use :func:`project_issue_fields` instead. This API was introduced in JIRA Server / DC 8.4 as a replacement for the more general purpose API 'createmeta'. For details see: https://confluence.atlassian.com/jiracore/createmeta-rest-endpoint-to-be-removed-975040986.html Args: projectIdOrKey (Union[str, int]): id or key of the project for which to get the metadata. issueTypeId (Union[str, int]): id of the issue type for which to get the metadata. startAt (int): Index of the first issue to return. (Default: ``0``) maxResults (int): Maximum number of issues to return. Total number of results is available in the ``total`` attribute of the returned :class:`ResultList`. If maxResults evaluates to False, it will try to get all issues in batches. (Default: ``50``) Returns: Dict[str, Any] zp'createmeta_fieldtypes' is deprecated and will be removed in future releases.Use 'project_issue_fields' instead.rrr /issuetypes/rrr)rrrrrs r[createmeta_fieldtypeszJIRA.createmeta_fieldtypessz4   2      ))+++~~ I I IK I I"(   r^ projectKeystuple[str, str] | str | None projectIdslist | tuple[str, str] issuetypeIdslist[str] | NoneissuetypeNamescn|jsJ|jdkrtd|jd|jdkrtjdt di}|||d <|/t |tr|d }||d <|||d <|||d <|||d<| d|S)a"Get the metadata required to create issues, optionally filtered by projects and issue types. Args: projectKeys (Optional[Union[Tuple[str, str], str]]): keys of the projects to filter the results with. Can be a single value or a comma-delimited string. May be combined with projectIds. projectIds (Union[List, Tuple[str, str]]): IDs of the projects to filter the results with. Can be a single value or a comma-delimited string. May be combined with projectKeys. issuetypeIds (Optional[List[str]]): IDs of the issue types to filter the results with. Can be a single value or a comma-delimited string. May be combined with issuetypeNames. issuetypeNames (Optional[str]): Names of the issue types to filter the results with. Can be a single value or a comma-delimited string. May be combined with issuetypeIds. expand (Optional[str]): extra information to fetch inside each resource. Returns: Dict[str, Any] ) rrzUnsupported JIRA version: z?. Use 'project_issue_types' and 'project_issue_fields' instead.rzThis API have been deprecated in JIRA 8.4 and is removed in JIRA 9.0. Use 'project_issue_types' and 'project_issue_fields' instead.rrNrrrrrrzissue/createmeta) rbrurr\r]r^r`rsplitr)rrrrrrrs r[ createmetazJIRA.createmetas0~ } ))TTTT)++ T& "$  "$/F= !  !*c** 3'--c22 #-F<  #%1F> "  %'5F# $  %F8 ~~0&999r^r~rFc,|jr|jn|jS)aGet the unique identifier depending on the deployment type. - Cloud: 'accountId' - Self Hosted: 'name' (equivalent to username). Args: user (User): a User object Returns: str: the User's unique identifier. )rbrr{)rr~s r[_get_user_identifierzJIRA._get_user_identifiers"&>t~~TY>r^cdvrS jrd}nd}t|dkrtddg}t|dkrfd|D}|r|d n|d }n.#t$r!}tt |d }~wwxYw|S) aInternal method for translating a user search (str) to an id. Return None and -1 unchanged. This function uses :py:meth:`JIRA.search_users` to find the user and then using :py:meth:`JIRA._get_user_identifier` extracts the relevant identifier property depending on whether the instance is a Cloud or self-hosted Instance. Args: user (Optional[str]): The search term used for finding a user. None, '-1' and -1 are equivalent to 'Unassigned'. Raises: JIRAError: If any error occurs. Returns: Optional[str]: The Jira user's identifier. Or "-1" and None unchanged. )NrRz-1r:)rr)r~rrzNo matching user found for: ''cFg|]}|k|SrW)r )rYurr~s r[rz%JIRA._get_user_id.. s1TTTt/H/H/K/Kt/S/S1/S/S/Sr^rN)rb search_usersrrrvrr )rr~rmatchesuser_objrss`` r[ _get_user_idzJIRA._get_user_ids" # # #K $~ D)))DD))t)CC5zzA~~ G G G GHHHG5zzA~~TTTTTeTTT%,:wqzz%(HH $ $ $CFF## # $((222sBB C'CC int | strassigneec|d|d}||}|jrd|ind|i}|j|t j|dS)aAssign an issue to a user. Args: issue (Union[int, str]): the issue ID or key to assign assignee (str): the user to assign the issue to. None will set it to unassigned. -1 will set it to Automatic. Returns: bool rz /assigneerr{rT)rrrbrrrr)rrrrruser_idrs r[ assign_issuezJIRA.assign_issue s{""#.C :     DM4=2B C C   r^comments)rr) rrrrrrrrr#s ` r[r#z JIRA.comments# s*  %F8    #H F9   "#&{#3#3F<   (F9  8 8 8 8HH    $*:$6   r^commentr$c@|t||f|S)atGet a comment Resource from the server for the specified ID. Args: issue (Union[int, str]): the issue ID or key to get the comment from comment (str): ID of the comment to get expand (Optional[str]): extra information to fetch for each comment such as renderedBody and properties. Returns: Comment r)rr$)rrr$rs r[r$z JIRA.commentI s$&&w0@&PPPr^str | int | Issuebody visibilitydict[str, str] | None is_internalc0d|i}|r dd|idg|d<|||d<|dt|zd z}|j|t j| }t |j|jt| S) aAdd a comment from the current authenticated user on the specified issue and return a Resource for it. Args: issue (Union[str, int, jira.resources.Issue]): ID or key of the issue to add the comment to body (str): Text of the comment to add visibility (Optional[Dict[str, str]]): a dict containing two entries: "type" and "value". "type" is 'role' (or 'group' if the Jira server has configured comment visibility for groups) "value" is the name of the role (or group) to which viewing of this comment will be restricted. is_internal (bool): True marks the comment as 'Internal' in Jira Service Desk (Default: ``False``) Returns: Comment: the created comment r(zsd.public.commentinternal)rzrrNr)rrrr.) rrrrrrr$rerL)rrr(r)r+rrrrs r[ add_commentzJIRA.add_commentY s*!'~  +z;6OPP"D   !!+D mmHs5zz1J>?? M  sD)9)9  : :t}dmAGGGGr^cR|dt|zdzS)zGet the edit metadata for an issue. Args: issue (Union[str, int]): the issue to get metadata for Returns: Dict[str, Dict[str, Dict[str, Any]]] rz /editmetar4rrs r[editmetaz JIRA.editmeta} s&~~hU3kABBBr^list[RemoteLink]ctdt|zdz}fd|D}|S)zGet a list of remote link Resources from an issue. Args: issue (Union[str, int]): the issue to get remote links from Returns: List[RemoteLink] r /remotelinkcFg|]}tjj|SrW)r<rer)rYraw_remotelink_jsonrs r[rz%JIRA.remote_links.. s:   # t}dm5H I I   r^r4)rrr remote_linkss` r[r7zJIRA.remote_links sV3u:: 5 EFF    '-   r^r<c<|t||fS)zGet a remote link Resource from the server. Args: issue (Union[str, int]): the issue holding the remote link id (str): ID of the remote link Returns: RemoteLink )rr<rrrs r[ remote_linkzJIRA.remote_link s&&zE2;???r^ destinationIssue | dict[str, Any]globalId application relationshipch |}nC#t$r6}g}tjd|jd|jt Yd}~nd}~wwxYwi}t|tr|j rt|| d|d<|D]e} | dd|j dkrFd | dd |j d |d <| dd d d|d<nfd |vrtdn|||d <|||d<||d<|||d<t|tri|j rb|D]_} | dd|jkrFd | dd |j d |d <| dd d d|d<n`|dt|zdz} |j| t'j|} t+|j |jt-| } | S)a<Add a remote link from an issue to an external application and returns a remote link Resource for it. ``destination`` should be a dict containing at least ``url`` to the linked external URL and ``title`` to display for the link inside Jira. For definitions of the allowable fields for ``destination`` and the keyword arguments ``globalId``, ``application`` and ``relationship``, see https://developer.atlassian.com/display/JIRADEV/JIRA+REST+API+for+Remote+Issue+Links. Args: issue (str): the issue to add the remote link to destination (Union[Issue, Dict[str, Any]]): the link details to add (see the above link for details) globalId (Optional[str]): unique ID for the link (see the above link for details) application (Optional[Dict[str,Any]]): application information for the link (see the above link for details) relationship (Optional[str]): relationship description for the link (see the above link for details) Returns: RemoteLink: the added remote link zXUnable to gather applicationlinks; you will not be able to add links to remote issues: (z) N)rsrrobjectr> displayUrlr%zappId={}&issueId={}rr=r{zcom.atlassian.jira)r{typez(Unable to identify the issue to link to.r?rr4rr.)rrr\r]rqrWarningr`r/rsr permalinkrerrrirrrrrr<rL) rrr;r=r>r?rrsrrrrrr:s r[add_remote_linkzJIRA.add_remote_link s2 +/+@+@+B+B     !  MM34=MMDEFMM          " k5 ) ) )ko )'*;'7'7 @U@U@W@WXXDN%  ]#L1[5I(5SSS'<'C'C-(.#-((D$ !"- 0 8 4++D'ET%%)*TUUU&##+Z &&1]#(DN  ##/D  k5 ) ) ko %  ]#L1T_DD'<'C'C-(.#-((D$ !"- 0 8 4++D'EEmmHs5zz1MABB M  sD)9)9  : :  :a==QQQ s A,AArAc d|i}|dt|zdz}|j|t j|}t |j|jt|}|S)aAdd a simple remote link from an issue to web resource. This avoids the admin access problems from add_remote_link by just using a simple object and presuming all fields are correct and not requiring more complex ``application`` data. ``object`` should be a dict containing at least ``url`` to the linked external URL and ``title`` to display for the link inside Jira For definitions of the allowable fields for ``object`` , see https://developer.atlassian.com/display/JIRADEV/JIRA+REST+API+for+Remote+Issue+Links. Args: issue (str): the issue to add the remote link to object (Dict[str,Any]): the dictionary used to create remotelink data Returns: RemoteLink rArr4rr.) rrrrrrr<rerL)rrrArrrr simple_links r[add_simple_linkzJIRA.add_simple_link sw$&!mmHs5zz1MABB M  sD)9)9  : :  :a==QQQ r^ci}|||d<|||d<|dt|zdz|dS)aGet a list of the transitions available on the specified issue to the current user. Args: issue (Union[str, int, jira.resources.Issue]): ID or key of the issue to get the transitions from id (Optional[str]): if present, get only the transition matching this ID expand (Optional): extra information to fetch inside each transition Returns: Any: json of response N transitionIdrr /transitionsr transitionsr4)rrrrrs r[rMzJIRA.transitions sX >%'F> "  %F8 ~~hU3nDV~TT   r^transition_namec||}d}|D]<}|d|kr |d}n=|S)aGet a transitionid available on the specified issue to the current user. Look at https://developer.atlassian.com/static/rest/jira/6.1.html#d2e1074 for json reference Args: issue (Union[str, int, jira.resources.Issue]): ID or key of the issue to get the transitions from transition_name (str): name of transition we are looking for Returns: Optional[int]: returns the id is found None when it's not Nr{r)rMlower)rrrNtransitions_jsonr transitions r[find_transitionid_by_namezJIRA.find_transitionid_by_name- sp ++E22*  J&!''))_-B-B-D-DDD%E r^rRworklogc nd} t|}n:#t$r-|||}|td|YnwxYwdd|ii}i} |r dd|iig| d<|r dd|iig| d <|s|r| |d <|||d <ni} |D] } || | | <| |d <|d t |zd z} |j| tj |} t| }n8#t$r+}|j |d| j|d}~wwxYw|S)aPerform a transition on an issue. Each keyword argument (other than the predefined ones) is treated as a field name and the argument's value is treated as the intended value for that field -- if the fields argument is used, all other keyword arguments will be ignored. Field values will be set on the issue as part of the transition process. Args: issue (Union[str, int, jira.resources.Issue]): ID or key of the issue to perform the transition on transition (str): ID or name of the transition to perform fields (Optional[Dict[str,Any]]): a dict containing field names and the values to use. comment (Optional[str]): String to add as comment to the issue when performing the transition. worklog (Optional[str]): String to add as time spent on the issue when performing the transition. **fieldargs: If present, all other keyword arguments will be ignored NzInvalid transition name. rRraddr(r$ timeSpentrTrfrrrLr )rrvrSrrrrrrrrL ValueErrorrcrwr)rrrRrr$rTrrKr update_dict fields_dictr{rrrrrss r[transition_issuezJIRA.transition_issueD s.$(  Jz??LL J J J99%LLL# HJ H HIII$# J !-t\.BC&(  B',vw.?&@%AK "  G',{G.D&E%FK "  )g )(DN  #DNNK" 6 6%.u%5 E""(DNmmHs5zz1NBCC M  sD)9)9  : : ]]FF    HNNa++16++ , , ,G  s'4A  A -C== D2&D--D2rHc8|t|S)zGet a votes Resource from the server. Args: issue (Union[str, int]): ID or key of the issue to get the votes for Returns: Votes )rrHr0s r[votesz JIRA.votes~ s&&ue444r^r3c8|t|S)aGet a IssueSecurityLevelScheme Resource from the server. Args: project (str): ID or key of the project to get the IssueSecurityLevelScheme for Returns: IssueSecurityLevelScheme: The issue security level scheme )rr3rr(s r[#project_issue_security_level_schemez(JIRA.project_issue_security_level_scheme s&&'?IIIr^r6c8|t|S)zGet a NotificationScheme Resource from the server. Args: project (str): ID or key of the project to get the NotificationScheme for Returns: NotificationScheme: The notification scheme )rr6r`s r[project_notification_schemez JIRA.project_notification_scheme s&&'97CCCr^r7c8|t|S)zGet a PermissionScheme Resource from the server. Args: project (str): ID or key of the project to get the permissionscheme for Returns: PermissionScheme: The permission scheme )rr7r`s r[project_permissionschemezJIRA.project_permissionscheme s&&'7AAAr^r:c8|t|S)zGet a PriorityScheme Resource from the server. Args: project (str): ID or key of the project to get the PriorityScheme for Returns: PriorityScheme: The priority scheme )rr:r`s r[project_priority_schemezJIRA.project_priority_scheme &&~w???r^rJc8|t|S)zGet a WorkflowScheme Resource from the server. Args: project (str): ID or key of the project to get the WorkflowScheme for Returns: WorkflowScheme: The workflow scheme )rrJr`s r[project_workflow_schemezJIRA.project_workflow_scheme rhr^c|dt|zdz}|j|S)zRegister a vote for the current authenticated user on an issue. Args: issue (Union[str, int]): ID or key of the issue to vote on Returns: Response r/votes)rrrrrrrrs r[add_votez JIRA.add_vote s;mmHs5zz1H<==}!!#&&&r^c|dt|zdz}|j|dS)zRemove the current authenticated user's vote from an issue. Args: issue (Union[str, int]): ID or key of the issue to remove vote on rrlNr"rms r[ remove_votezJIRA.remove_vote sAmmHs5zz1H<== S!!!!!r^rIc8|t|S)zGet a watchers Resource from the server for an issue. Args: issue (Union[str, int]): ID or key of the issue to get the watchers for Returns: Watchers )rrIr0s r[watchersz JIRA.watchers s&&x777r^watcherc|dt|zdz}||}|j|t j|S)zAdd a user to an issue's watchers list. Args: issue (Union[str, int]): ID or key of the issue affected watcher (str): name of the user to add to the watchers list Returns: Response r /watchersr)rrrrrrr)rrrsrr watcher_ids r[ add_watcherzJIRA.add_watcher s]mmHs5zz1K?@@&&w// }!!#DJz,B,B!CCCr^c|dt|zdz}||}|jrd|ind|i}|j||}|S)zRemove a user from an issue's watch list. Args: issue (Union[str, int]): ID or key of the issue affected watcher (str): name of the user to remove from the watchers list Returns: Response rrurrr)rrrrbrr#)rrrsrrrrr}s r[remove_watcherzJIRA.remove_watcher srmmHs5zz1K?@@##G,,,0NU;((W@U%%c'%:: r^ list[Worklog]cdt|zdz}fd|dD}|S)zGet a list of worklog Resources from the server for an issue. Args: issue (Union[str, int]): ID or key of the issue to get worklogs from Returns: List[Worklog] r/worklogcFg|]}tjj|SrW)rKrer)rYraw_worklog_jsonrs r[rz!JIRA.worklogs.. r"r^worklogsr4)rrrrs` r[rz JIRA.worklogs sZ3u:: 5 BCC    $*:$6   r^rKc<|t||fS)zGet a specific worklog Resource from the server. Args: issue (Union[str, int]): ID or key of the issue to get the worklog from id (str): ID of the worklog to get Returns: Worklog )rrKr9s r[rTz JIRA.worklog s&&w <<", "identifier": ""}`` Returns: Worklog NrrrrWrr$r)z%Y-%m-%dT%H:%M:%S.000+0000rz%Y-%m-%dT%H:%M:%S.000%zz/rest/api/latest/user?username=F)r{rrrauthor updateAuthorrr|rr) tzinfostrftime JIRA_BASE_URLrrrrrrKrerL)rrrWrrrrr$rr~r)rrrrrs r[ add_worklogzJIRA.add_worklog) ssD  %'5F# $  "$/F= !  !)F: !  )D   ''7D# $  %DOO  #"DO  !!+D   ~%")"2"23O"P"PY")"2"23L"M"MY  *-NNQUU# DN $(>D mm4U44455 M  s6 48H8H  I It}dmZ]]CCCr^list[IssueProperty]cfdd}fd|dD}|S)zGet a list of issue property Resource from the server for an issue. Args: issue (str): ID or key of the issue to get properties from Returns: List[IssueProperty] rrZcHg|]}|dSr)issue_property)rYrzrrs r[rz)JIRA.issue_properties.. s-WWWd))%U<<WWWr^rr)rrrrs`` r[issue_propertieszJIRA.issue_propertiesv sI ; ; ; ;<<WWWWWvWWW r^r2c<|t||fS)zGet a specific issue property Resource from the server. Args: issue (str): ID or key of the issue to get the property from key (str): Key of the property to get Returns: IssueProperty )rr2)rrrzs r[rzJIRA.issue_property s&&}uclCCCr^c|d|d|}|j|tj|S)aAdd or update a specific issue property Resource. Args: issue (str): ID or key of the issue to set the property to key (str): Key of the property to set data: The data to set for the property Returns: Response rr`r)rrrrr)rrrzrrrs r[add_issue_propertyzJIRA.add_issue_property sKmm=U====>>}  4:d+;+; <<. s9---!dmT]MJJ---r^issueLinkTypes)rr_cached_issue_link_types)rrrs` r[rzJIRA.issue_link_types slt<==  ^^O44F----%+,<%=---D ),,r^r1c8|t|S)zGet an issue link type Resource from the server. Args: id (str): ID of the issue link type to get Returns: IssueLinkType )rr1rs r[issue_link_typezJIRA.issue_link_type &&}b999r^list[IssueType]cNd}fd|D}|S)zjGet a list of issue type Resources from the server. Returns: List[IssueType] rcFg|]}tjj|SrWr4rerrY raw_type_jsonrs r[rz$JIRA.issue_types.. 9    dmT]M B B   r^r)rr issue_typess` r[rzJIRA.issue_types sF  ,,    !'   r^ResultList[IssueType]ct||tdd|d||}|S)aGet a list of issue type Resources available in a given project from the server. This API was introduced in JIRA Server / DC 8.4 as a replacement for the more general purpose API 'createmeta'. For details see: https://confluence.atlassian.com/jiracore/createmeta-rest-endpoint-to-be-removed-975040986.html Args: project (str): ID or key of the project to query issue types from. startAt (int): Index of first issue type to return. (Default: ``0``) maxResults (int): Maximum number of issue types to return. (Default: ``50``) Returns: ResultList[IssueType] rrrr)rrr4)rr(rrrs r[project_issue_typeszJIRA.project_issue_types sR& ))+++''   4 4 4 4! (  r^ issue_typeResultList[Field]cx||tdd|d|||}|S)aGet a list of field type Resources available for a project and issue type from the server. This API was introduced in JIRA Server / DC 8.4 as a replacement for the more general purpose API 'createmeta'. For details see: https://confluence.atlassian.com/jiracore/createmeta-rest-endpoint-to-be-removed-975040986.html Args: project (str): ID or key of the project to query field types from. issue_type (str): ID of the issue type to query field types from. startAt (int): Index of first issue type to return. (Default: ``0``) maxResults (int): Maximum number of issue types to return. (Default: ``50``) Returns: ResultList[Field] rrrr)rrr,)rr(rrrrs r[project_issue_fieldszJIRA.project_issue_fields/ sV* ))+++""   A A AZ A A! #   r^r4c8|t|S)zGet an issue type Resource from the server. Args: id (str): ID of the issue type to get Returns: IssueType )rr4rs r[rzJIRA.issue_typeN rr^c.|r||dj}n|}fd|D}t|dkr|dSt|dkrt ddt dd) aGet issue type by name. Args: name (str): Name of the issue type project (str): Key or ID of the project. If set, only issue types available for that project will be looked up. Returns: IssueType issueTypesr&c*g|]}|jk |SrWr{)rYitr{s r[rz+JIRA.issue_type_by_name..h s LLLrBGtOOOOOr^rrz Issue type ' ' is unknown.z' appears more than once.)r(rrrr)rr{r(rmatching_issue_typess ` r[rzJIRA.issue_type_by_nameY s  -,,w|,DDOKK**,,KLLLL[LLL # $ $ ) )'* * % & &! + +=$===>> >I$IIIJJ Jr^rlist[RequestType]ct|dr|j}jd|dz}ddi}tj||}fd|dD}|S) zReturns request types supported by a service desk instance. Args: service_desk (ServiceDesk): The service desk instance. Returns: List[RequestType] rz!/rest/servicedeskapi/servicedesk/z /requesttyperrrcFg|]}tjj|SrW)r=rerrs r[rz&JIRA.request_types.. s9     t}m D D   r^r)rrrirLrrx)rrrrrr request_typess` r[rzJIRA.request_typesp s < & & +'?L OL,LLL M '1DM--c7-CCDD    !'!1   r^c||} fd|Dd}n!#t$rtddwxYw|S)Nc*g|]}|jk |SrWr)rYrtr{s r[rz-JIRA.request_type_by_name.. s JJJ2"'T//B///r^rzRequest type 'r)r IndexErrorr)rrr{r request_types ` r[rzJIRA.request_type_by_name s{**<88  AJJJJJJJ1MLL A A A?D???@@ @ As -A  projectKey projectIdrissueId permissions$dict[str, dict[str, dict[str, str]]]czi}|||d<|||d<|||d<|||d<|||d<|d|S) aGet a dict of all available permissions on the server. ``permissions`` is a comma-separated value list of permission keys that is required in Jira Cloud. For possible and allowable permission values, see https://developer.atlassian.com/cloud/jira/platform/rest/v3/api-group-permission-schemes/#built-in-permissions Args: projectKey (Optional[str]): limit returned permissions to the specified project projectId (Optional[str]): limit returned permissions to the specified project issueKey (Optional[str]): limit returned permissions to the specified issue issueId (Optional[str]): limit returned permissions to the specified issue permissions (Optional[str]): limit returned permissions to the specified csv permission keys (cloud required field) Returns: Dict[str, Dict[str, Dict[str, str]]] Nrrrrr mypermissionsrr)rrrrrrrs r[my_permissionszJIRA.my_permissions so0  !#-F<  "+F;   !)F:    'F9   "$/F= !~~of~===r^list[Priority]cNd}fd|D}|S)zgGet a list of priority Resources from the server. Returns: List[Priority] prioritycFg|]}tjj|SrW)r9rer)rYraw_priority_jsonrs r[rz#JIRA.priorities.. s:   ! T]DM3D E E   r^r)rr prioritiess` r[rzJIRA.priorities sF  ++    %+   r^r9c8|t|S)zGet a priority Resource from the server. Args: id (str): ID of the priority to get Returns: Priority )rr9rs r[rz JIRA.priority s&&x444r^ list[Project]cdi}|||d<d|}fd|D}|S)aGet a list of project Resources from the server visible to the current authenticated user. Args: expand (Optional[str]): extra information to fetch for each project such as projectKeys and description. Returns: List[Project] Nrr(rcFg|]}tjj|SrW)r;rerrs r[rz!JIRA.projects.. r"r^r)rrrrrs` r[rz JIRA.projects s^  %F8  &99    $*   r^r;c<|t||S)aGet a project Resource from the server. Args: id (str): ID or key of the project to get expand (Optional[str]): extra information to fetch for the project such as projectKeys and description. Returns: Project r&)rr;)rrrs r[r(z JIRA.project s&&w6&BBBr^c8|d|zdzS)zGet a dict of all avatars for a project visible to the current authenticated user. Args: project (str): ID or key of the project to get avatars for project/z/avatarsrr`s r[project_avatarszJIRA.project_avatars s ~~j72Z?@@@r^ avatar_imgbytes contentType auto_confirmcftj|}||kr|}||d}ddi} ||| d<n||| d<|d|zdz} |j| || |} t| } |r||| S| S) aRegister an image file as a project avatar. The avatar created is temporary and must be confirmed before it can be used. Avatar images are specified by a filename, size, and file object. By default, the client will attempt to autodetect the picture's content type this mechanism relies on libmagic and will not work out of the box on Windows systems (see `Their Documentation `_ for details on how to install support). The ``contentType`` argument can be used to explicitly set the value (note that Jira will reject any type other than the well-known ones for images, e.g. ``image/jpg``, ``image/png``, etc.) This method returns a dict of properties that can be used to crop a subarea of a larger image for use. This dict should be saved and passed to :py:meth:`confirm_project_avatar` to finish the avatar creation process. If you want to confirm the avatar with Jira's default cropping, pass the 'auto_confirm' argument with a truthy value and :py:meth:`confirm_project_avatar` will be called for you before this method returns. Args: project (str): ID or key of the project to create the avatar in filename (str): name of the avatar file size (int): size of the avatar file avatar_img (bytes): file-like object holding the avatar contentType (str): explicit specification for the avatar image's content-type auto_confirm (bool): True to automatically confirm the temporary avatar by calling :py:meth:`confirm_project_avatar` with the return value of this method. (Default: ``False``) )rrr9r7Nr rz/avatar/temporaryrrr) rrgetsize_get_mime_typerrrrLconfirm_project_avatar) rr(rrrrrsize_from_filerrrrrcropping_propertiess r[create_temp_project_avatarzJIRA.create_temp_project_avatar sD22 > ! !!D4.j s9    dmT]M B B   r^r)rr(r componentss` r[project_componentszJIRA.project_components_ sP W 4} DEE    !'   r^ list[Version]cZd|zdz}fd|D}|S)zGet a list of version Resources present on a project. Args: project (str): ID or key of the project to get versions from Returns: List[Version] rz /versionscFg|]}tjj|SrW)rGrer)rY raw_ver_jsonrs r[rz)JIRA.project_versions..{ s9    DM4=, ? ?   r^r)rr(rversionss` r[project_versionszJIRA.project_versionsp sO W 4{ BCC    &   r^ version_nameVersion | NonecX||}|D]}|j|kr|cSdS)a Get a version Resource by its name present on a project. Args: project (str): ID or key of the project to get versions from version_name (str): name of the version to search for Returns: Optional[Version] N)r r{)rr(r rrs r[get_project_version_by_namez JIRA.get_project_version_by_name sF#'"7"7"@"@  G||++,tr^old_namenew_namecf|||}|r||dSdS)aRename a version Resource on a project. Args: project (str): ID or key of the project to get versions from old_name (str): old name of the version to rename new_name (str): new name of the version to rename rN)r rf)rr(rrrs r[rename_versionzJIRA.rename_version sE227HEE  * NNN ) ) ) ) ) * *r^dict[str, dict[str, str]]cd|zdz}||}i}|D]/\}}i}|dd|d<||d<|||<0|S)zGet a dict of role names to resource locations for a project. Args: project (str): ID or key of the project to get roles from Returns: Dict[str, Dict[str, str]] rz/roler'rRrrr)rrr)rr(r _rolesdict rolesdictkvtmps r[ project_roleszJIRA.project_roles sG#g-%)^^D%9%9 /1 $$&&  DAq"$C R(CICJIaLLr^r@clt|tr|}|t||fS)zGet a role Resource. Args: project (str): ID or key of the project to get the role from id (str): ID of the role to get Returns: Role )r`r rr@)rr(rs r[ project_rolezJIRA.project_role s7 b& ! ! B&&tgr];;;r^list[Resolution]cNd}fd|D}|S)zkGet a list of resolution Resources from the server. Returns: List[Resolution] resolutioncFg|]}tjj|SrW)r>rer)rY raw_res_jsonrs r[rz$JIRA.resolutions.. s9    t}dm\ B B   r^r)rr resolutionss` r[r!zJIRA.resolutions sF  --    &   r^r>c8|t|S)zGet a resolution Resource from the server. Args: id (str): ID of the resolution to get Returns: Resolution )rr>rs r[rzJIRA.resolution rr^*all) json_resultrjql_strvalidate_querystr | list[str] | Noner$Literal[False]ResultList[Issue]cdSrVrW rr%rrr&rrrr$rs r[ search_issueszJIRA.search_issues s  Cr^r Literal[True]cdSrVrWr+s r[r,zJIRA.search_issues s r^"dict[str, Any] | ResultList[Issue]c 8t|tr|d}n|dg}|jr1|dkr|||||||| St di} |jrDt|D]4\} } | |jvr&|| | |j| <|j| || <5||||||d} | r| d|r;|| d <|stj d t| d | | }|S| td d ||| | }| rd|D]a}| D]J\}}|jr>||jdivr!|jd||jd|<Kb|S)aGet a :class:`~jira.client.ResultList` of issue Resources matching a JQL search string. Args: jql_str (str): The JQL search string. startAt (int): Index of the first issue to return. (Default: ``0``) maxResults (int): Maximum number of issues to return. Total number of results is available in the ``total`` attribute of the returned :class:`ResultList`. If maxResults evaluates to False, it will try to get all issues in batches. (Default: ``50``) validate_query (bool): True to validate the query. (Default: ``True``) fields (Optional[Union[str, List[str]]]): comma-separated string or list of issue fields to include in the results. Default is to include all fields. expand (Optional[str]): extra information to fetch inside each resource properties (Optional[str]): extra properties to fetch inside each result json_result (bool): True to return a JSON response. When set to False a :class:`ResultList` will be returned. (Default: ``False``) use_post (bool): True to use POST endpoint to fetch issues. Returns: Union[Dict,ResultList]: Dict if ``json_result=True`` rNr#r)r%rrrrr$rzZThe `search` API is deprecated in Jira Cloud. Use `enhanced_search_issues` method instead.)rr validateQueryrrrrrGAll issues cannot be fetched at once, when json_result parameter is setsearchrrrr-r)r`rrrbenhanced_search_issuesrrrrr\r]rDrrr/rrsrx)rr%rrr&rrrr$r untranslaterr{ search_paramsrrissrrs r[r,zJIRA.search_issuessL@ fc " " \\#&&FF ^XF > !||22#)!!) +%3 p    :%f-- : :5D...=CAYK 25 9: $ 25 9F1I+$     ,   l + + +  *4M, '  ]&*^^&4&&FM""      #    H H H'--//HHDAqwH Hb 9 99936783DQ3GCGH-a0H  r^rreconcileIssueslist[int] | Nonect|tr|d}n|dg}i} |rK|jrDt |D]4\} } | |jvr&|| | |j| <|j| || <5|||||pgd} |r|| d<|r<|st jdtn|| d<|d| | }|S| td d|| | }| rd|D]a}| D]J\}}|j r>||j d ivr!|j d ||j d |<Kb|S) a=Get a :class:`~jira.client.ResultList` of issue Resources matching a JQL search string. Args: jql_str (str): The JQL search string. nextPageToken (Optional[str]): Token for paginated results. maxResults (int): Maximum number of issues to return. Total number of results is available in the ``total`` attribute of the returned :class:`ResultList`. If maxResults evaluates to False, it will try to get all issues in batches. (Default: ``50``) fields (Optional[Union[str, List[str]]]): comma-separated string or list of issue fields to include in the results. Default is to include all fields If you don't require fields, set it to empty string ``''``. expand (Optional[str]): extra information to fetch inside each resource. reconcileIssues (Optional[List[int]]): List of issue IDs to reconcile. properties (Optional[str]): extra properties to fetch inside each result json_result (bool): True to return a JSON response. When set to False a :class:`ResultList` will be returned. (Default: ``False``) use_post (bool): True to use POST endpoint to fetch issues. Returns: Union[Dict, ResultList]: JSON Dict if ``json_result=True``, otherwise a `ResultList`. rNr#)rrrrr:rr3rz search/jqlr5r)rrrrrrr)r`rrrrr\r]rDrrr/rrsrx)rr%rrrrr:rr$rr7rr{r8rrr9rrs r[r6zJIRA.enhanced_search_issuesksB fc " " \\#&&FF ^XF  >! > )& 1 1>>HAu 222AG D$6u$=>$($6u$=q $.4" ) )   ;-:M/ *   9 ] /9 l+%)^^]X&4&&FM..%!  /    H H H'--//HHDAqwH Hb 9 99936783DQ3GCGH-a0H  r^)r$int | dict[str, Any]c|jstdd|i}|d|d}|r|S|ddS)a_Get an approximate count of issues matching a JQL search string. Args: jql_str (str): The JQL search string. json_result (bool): If True, returns the full JSON response. Defaults to False. Returns: int | dict[str, Any]: The issue count if json_result is False, else the raw JSON response. z=The 'approximate-count' API is only available for Jira Cloud.rzsearch/approximate-countTr5countr)rbrYrrx)rr%r$r8 response_jsons r[approximate_issue_countzJIRA.approximate_issue_countst ~ O ( (, &}t)7) )   !   !,,,r^rAc8|t|S)zGet a security level Resource. Args: id (str): ID of the security level to get Returns: SecurityLevel )rrArs r[security_levelzJIRA.security_levelrr^cd}|d}|sB|dkr<|jd|dz }|d}|s|dk<|S)znGet a dict of server information for this Jira instance. Returns: Dict[str, Any] r serverInfor<z?Bug https://jira.atlassian.com/browse/JRA-59676 trying again...r)rrcrd)rretryjs r[rtzJIRA.server_infos|  NN< ( ( - H  Q    QJE|,,A  - r^c,|dS)znGet a dict of client information for this Jira instance. Returns: Dict[str, Any] myselfrrs r[rIz JIRA.myselfs ~~h'''r^ list[Status]cNd}fd|D}|S)zGet a list of all status Resources from the server. Refer to :py:meth:`JIRA.issue_types_for_project` for getting statuses for a specific issue type within a specific project. Returns: List[Status] rcFg|]}tjj|SrW)rDrerrY raw_stat_jsonrs r[rz!JIRA.statuses..s9    4=$- ? ?   r^r)rrstatusess` r[rOz JIRA.statusessE))    !'   r^cVd|d}fd|D}|S)a4Get a list of issue types available within the project. Each project has a set of valid issue types and each issue type has a set of valid statuses. The valid statuses for a given issue type can be extracted via: `issue_type_x.statuses` Returns: List[IssueType] rz /statusescFg|]}tjj|SrWrrMs r[rz0JIRA.issue_types_for_project..(rr^r)rrrrs` r[issue_types_for_projectzJIRA.issue_types_for_projectsR D> D D DEE    !'   r^rDc8|t|S)zGet a status Resource from the server. Args: id (str): ID of the status resource to get Returns: Status )rrDrs r[rz JIRA.status.r}r^list[StatusCategory]cNd}fd|D}|S)ztGet a list of status category Resources from the server. Returns: List[StatusCategory] statuscategorycFg|]}tjj|SrW)rErerrMs r[rz)JIRA.statuscategories..Bs9    4=$- G G   r^r)rrstatuscategoriess` r[rXzJIRA.statuscategories;sH  011    !'    r^rEc8|t|S)zGet a status category Resource from the server. Args: id (int): ID of the status category resource to get Returns: StatusCategory )rrErs r[rVzJIRA.statuscategoryHs&&~r:::r^ct|j|j|jrdnd}i}|||d<||||S)zGet a user Resource from the server. Args: id (str): ID of the user to get expand (Optional[Any]): Extra information to fetch inside each resource Returns: User rr) _query_paramNrr)rFrerrbr)rrrr~rs r[r~z JIRA.userUsb M M(,FJ      %F8  "V $$$ r^rrcJ||d}|tdd|||S)a=Get a list of user Resources that match the search string and can be assigned issues for projects. Args: username (str): A string to match usernames against projectKeys (str): Comma-separated list of project keys to check for issue assignment permissions startAt (int): Index of the first user to return (Default: ``0``) maxResults (int): Maximum number of users to return. If maxResults evaluates as False, it will try to get all users in batches. (Default: ``50``) Returns: ResultList )rrNz"user/assignable/multiProjectSearch)rrF)rrrrrrs r[$search_assignable_users_for_projectsz)JIRA.search_assignable_users_for_projectsjs;$'{CC    0       r^c|s|std|d|i}|d|i}|||d<|||d<|||d<|tdd|||S) awGet a list of user Resources that match the search string for assigning or creating issues. "username" query parameter is deprecated in Jira Cloud; the expected parameter now is "query", which can just be the full email again. But the "user" parameter is kept for backwards compatibility, i.e. Jira Server/Data Center. This method is intended to find users that are eligible to create issues in a project or be assigned to an existing issue. When searching for eligible creators, specify a project. When searching for eligible assignees, specify an issue key. Args: username (Optional[str]): A string to match usernames against project (Optional[str]): Filter returned users by permission in this project (expected if a result will be used to create an issue) issueKey (Optional[str]): Filter returned users by this issue (expected if a result will be used to edit this issue) expand (Optional[Any]): Extra information to fetch inside each resource startAt (int): Index of the first user to return (Default: ``0``) maxResults (int): maximum number of users to return. If maxResults evaluates as False, it will try to get all items in batches. (Default: ``50``) query (Optional[str]): Search term. It can just be the email. Returns: ResultList z9Either 'username' or 'query' arguments must be specified.Nrrr(rrzuser/assignable/searchrYrrF) rrr(rrrrrrs r["search_assignable_users_for_issuesz'JIRA.search_assignable_users_for_issuess<  K    (+F  u%F   'F9   !)F:   %F8     $       r^c4|dd|iS)zGet a dict of avatars for the specified user. Args: username (str): the username to get avatars for Returns: Dict[str, Any] z user/avatarsrrr)rrs r[ user_avatarszJIRA.user_avatarss~~nj(5K~LLLr^ctj|}||kr|}tj|d}|||d}ddi} ||| d<n||| d<|d} |j| || |} t| } |r| || S| S) aRegister an image file as a user avatar. The avatar created is temporary and must be confirmed before it can be used. Avatar images are specified by a filename, size, and file object. By default, the client will attempt to autodetect the picture's content type: this mechanism relies on ``libmagic`` and will not work out of the box on Windows systems (see `Their Documentation `_ for details on how to install support). The ``contentType`` argument can be used to explicitly set the value (note that Jira will reject any type other than the well-known ones for images, e.g. ``image/jpg``, ``image/png``, etc.) This method returns a dict of properties that can be used to crop a subarea of a larger image for use. This dict should be saved and passed to :py:meth:`confirm_user_avatar` to finish the avatar creation process. If you want to confirm the avatar with Jira's default cropping, pass the ``auto_confirm`` argument with a truthy value and :py:meth:`confirm_user_avatar` will be called for you before this method returns. Args: user (str): User to register the avatar for filename (str): name of the avatar file size (int): size of the avatar file avatar_img (bytes): file-like object containing the avatar contentType (Optional[Any]): explicit specification for the avatar image's content-type auto_confirm (bool): True to automatically confirm the temporary avatar by calling :py:meth:`confirm_user_avatar` with the return value of this method. (Default: ``False``) r)rrrr9r7Nr zuser/avatar/temporaryr) rrrrrrrrrLconfirm_user_avatar) rr~rrrrrrrrrrrrs r[create_temp_user_avatarzJIRA.create_temp_user_avatarsD22 > ! !!D7==**1- ( ( ' 3  "&1GN # #'+&9&9*&E&EGN #mm344 M  s67  T T.8mm  '++D2EFF F& &r^c|}|d}|j|d|itj|}t |S)arConfirm the temporary avatar image previously uploaded with the specified cropping. After a successful registry with :py:meth:`create_temp_user_avatar`, use this method to confirm the avatar for use. The final avatar can be a subarea of the uploaded image, which is customized with the ``cropping_properties``: the return value of :py:meth:`create_temp_user_avatar` should be used for this argument. Args: user (str): the user to confirm the avatar for cropping_properties (Dict[str,Any]): a dict of cropping properties from :py:meth:`create_temp_user_avatar` user/avatarrrr)rr~rrrrrs r[rdzJIRA.confirm_user_avatar sQ#mmM** M  sJ+=DJtDTDT  U U!}}r^cZ|d|i|d|S)zSet a user's avatar. Args: username (str): the user to set the avatar for avatar (str): ID of the avatar to set Returns: Response rrgr)rrrs r[set_user_avatarzJIRA.set_user_avatars4  "DMM-$@$@&   r^crd|i}|d|z}|j||S)zDelete a user's avatar. Args: username (str): the user to delete the avatar from avatar (str): ID of the avatar to remove Returns: Response rz user/avatar/rr)rrrrrrs r[delete_user_avatarzJIRA.delete_user_avatar(s?h'mmNV344}##C#777r^) internal_id global_id str | Issuerlrmc|du|duz std||d|d|}n>|>I-- P P PY P PQQC}##C(((r^ includeActiveincludeInactiveResultList[User]ct|s|std||||d}|tdd|||S)aGet a list of user Resources that match the specified search string. "username" query parameter is deprecated in Jira Cloud; the expected parameter now is "query", which can just be the full email again. But the "user" parameter is kept for backwards compatibility, i.e. Jira Server/Data Center. Args: user (Optional[str]): a string to match usernames, name or email against. startAt (int): index of the first user to return. maxResults (int): maximum number of users to return. If maxResults evaluates as False, it will try to get all items in batches. includeActive (bool): True to include active users in the results. (Default: ``True``) includeInactive (bool): True to include inactive users in the results. (Default: ``False``) query (Optional[str]): Search term. It can just be the email. Returns: ResultList[User] z5Either 'user' or 'query' arguments must be specified.)rrrrrsNz user/searchr_)rr~rrrrrsrrs r[rzJIRA.search_usersTs_2 VE VTUU U*.     t]GZQWXXXr^cv|jrdnd|i}|||d<|||d<|tdd|||S)aGet a list of user Resources that match a username string and have browse permission for the issue or project. Args: user (str): a string to match usernames against. issueKey (Optional[str]): find users with browse permission for this issue. projectKey (Optional[str]): find users with browse permission for this project. startAt (int): index of the first user to return. (Default: ``0``) maxResults (int): maximum number of users to return. If maxResults evaluates as False, it will try to get all items in batches. (Default: ``50``) Returns: ResultList rrNrrzuser/viewissue/search)rbrrF)rr~rrrrrs r[search_allowed_users_for_issuez#JIRA.search_allowed_users_for_issueys_("^;''TB  !)F:   !#-F<   $/*f   r^ releaseDate startDatearchivedreleasedrGc>||||d}|||d<|||d<|||d<|d} |j| tj|} t jdt|j|jt|  } | S) auCreate a version in a project and return a Resource for it. Args: name (str): name of the version to create project (str): key of the project to create the version in description (str): a description of the version releaseDate (Optional[Any]): the release date assigned to the version startDate (Optional[Any]): The start date for the version archived (bool): True to create an archived version. (Default: ``False``) released (bool): True to create a released version. (Default: ``False``) Returns: Version )r{r(rzr{Nr+rxryrrrr.) rrrrrtimesleeprGrerL) rr{r(r+rxryrzr{rrrrrs r[create_versionzJIRA.create_versions4      ""-D   ""-D   )D mmI&& M  sD)9)9  : : 1 $-JqMMJJJr^afterc i}|||d<n|||d<|d|zdz}|j|tj|}t |j|jt|}|S)a*Move a version within a project's ordered version list and return a new version Resource for it. One, but not both, of ``after`` and ``position`` must be specified. Args: id (str): ID of the version to move after (str): the self attribute of a version to place the specified version after (that is, higher in the list) position (Optional[str]): the absolute position to move this version to: must be one of ``First``, ``Last``, ``Earlier``, or ``Later`` Returns: Version Nrrqversion/z/moverr.)rrrrrrGrerL)rrrrqrrrrrs r[ move_versionzJIRA.move_versions  !DMM  !'D mmJOg566 M  sD)9)9  : :$-JqMMJJJr^czt|j|j}i}|||d<||||S)zGet a version Resource. Args: id (str): ID of the version to get expand (Optional[Any]): extra information to fetch inside each resource Returns: Version Nrr)rGrerr)rrrrrs r[rz JIRA.versionsG$-77  %F8  R '''r^cB|d|zdz}|d=|S)zGet a dict of the counts of issues fixed and affected by a version. Args: id (str): the version to count issues for rr2rrrrrs r[version_count_related_issuesz!JIRA.version_count_related_issuess+ "& RBW0W!X!X 6N r^cH|d|zdz}|dS)zGet the number of unresolved issues for a version. Args: id (str): ID of the version to count issues for rz/unresolvedIssueCountissuesUnresolvedCountrrs r[version_count_unresolved_issuesz$JIRA.version_count_unresolved_issuess2 "& O5 5" " -..r^cdjdi|j}|j|}t |j|jt |}|S)zoGet a dict of the current authenticated user's session information. Returns: User rrW)rrerrxrFrL)rrrrr~s r[rz JIRA.sessionsT *")::DM:: M  c " "DM4=*Q--@@ r^cJ|jdz}|j|S)zfDestroy the session of the current authenticated user. Returns: Response z/rest/auth/latest/session)rirr#rrrs r[ kill_sessionzJIRA.kill_sessions' o ;;}##C(((r^Response | Nonec\|js$|jdz}|j|SdS)zDestroy the user's current WebSudo session. Works only for non-cloud deployments, for others does nothing. Returns: Optional[Response] z/rest/auth/1/websudoN)rbrirr#rs r[ kill_websudozJIRA.kill_websudos6~ -/$::C='',, ,tr^rc"||f|j_dS)zCreates a basic http session. Args: username (str): Username for the session password (str): Password for the username Returns: ResilientSession N)rr)rrrs r[rnzJIRA._create_http_basic_session,s'1 r^c ddlm}ddlm} ddlm}n,#t $r|}|jdYnwxYw|d||fD]}|||d|d||d |d  }||j _ | |jd |dS#t$r,|j d |ddzdz||urYwxYwdS)Nr)SIGNATURE_HMAC_SHA1)OAuth1) SIGNATURE_RSAz8Fallback SHA 'SIGNATURE_RSA_SHA1' could not be imported.signature_method consumer_keykey_cert access_tokenaccess_token_secret)rsa_keyrresource_owner_keyresource_owner_secretz'OAuth1 succeeded with signature_method=z5Failed to create OAuth session with signature_method=z. zAttempting fallback method(s).z@Consider specifying the signature via oauth['signature_method'].)oauthlib.oauth1rrequests_oauthlibrrrrcdebugrxrrrIr exception)rrB DEFAULT_SHAr FALLBACK_SHAsha_typeoauth_instances r[rmzJIRA._create_oauth_session8sFFFFFF,,,,,, W E E E E E E E W W W&L HNNU V V V V V W#566 \R  H#Vn%j)!)#(#8&+,A&B N"0DM   SSSTTT   ""YHYYY67XY |++,+    s&>>1C3C=<C=c|i}ddlm}m}m}|dddkr|}nD|ddkr|}n(t d|d|||j_dS)Nr)DISABLEDOPTIONALHTTPKerberosAuthmutual_authenticationrrz+Unknown value for mutual_authentication: {})r) requests_kerberosrrrrxrYrrr)rrDrrrrs r[rqzJIRA._create_kerberos_sessionZs  #! JJJJJJJJJJ    7 D D R R$, ! !  ! !"9 : :j H H$, ! !=DD$%<=  .-"7    r^c8|jd}||j_dS)uFAdds the client certificate to the session. If configured through the constructor. https://docs.python-requests.org/en/latest/user/advanced/#client-side-certificates - str: a single file (containing the private key and the certificate) - Tuple[str,str] a tuple of both files’ paths r3N)rercert)rr3s r[rkz JIRA._add_client_cert_to_sessionrs .2]=-I ( r^c8|jd}||j_dS)a;Adds verification strategy for host SSL certificates. If configured through the constructor. https://docs.python-requests.org/en/latest/user/advanced/#ssl-cert-verification - str: Path to a `CA_BUNDLE` file or directory with certificates of trusted CAs. - bool: True/False r.N)rerr.)rssl_certs r[rlz,JIRA._add_ssl_cert_verif_strategy_to_session~s  $}X6' r^dtdatetime.timedelta | Nonectj}|||z }tj|SrV)datetimeutcnowcalendartimegm timetuple)rrs r[ _timestampzJIRA._timestamps<   $ $ & & > GAq{{}}---r^c  t|dd}n.#t$r!}|jd|d}~wwxYw|d|dd|dd |d t |jd |d D]$}||d |d%||j _ dS)NsecretHS256)algz(JWT authentication requires requests_jwtzJWT %siatc4tSrV)rarrs r[rz*JIRA._create_jwt_session..sdoo.?.?r^expc\ttjdS)Nr<)rO)rarr timedeltars r[rz*JIRA._create_jwt_session..s tx/A!/L/L/LMMr^rrrrr) rO NameErrorrcrwset_header_format add_fieldrrerrr)rrCjwt_authrsrs r[rozJIRA._create_jwt_sessions  s8}':::HH    HNNE F F FG  ""8,,,5"?"?@@@ MM    5,t}^/L"M"MNNNY%%'' + +A   qtQqT * * * *% s AAAc8t||j_dS)zhCreates token-based session. Header structure: "authorization": "Bearer ". N)rrr)rrAs r[rpzJIRA._create_token_sessions 'z22 r^chd|i}|j||tj|S)Nrr)rrrr)rrrrrrs r[rzJIRA._set_avatars2f~}  V$*T:J:J KKKr^rc|j}||ddd|jdi|S)aXReturns the full internal api url based on Jira base url and the path provided. Using the API version specified during the __init__. Args: path (str): The subpath desired. base (Optional[str]): The base url which should be prepended to the path Returns: str: Fully qualified URL latestr-)rr*r(rWrerrfrrrrr=s r[rRzJIRA._get_internal_urlsT-$$&&xj Q Q   t{%%W%%%r^c||j}|d|i|jdi|S)aQReturns the full url based on Jira base url and the path provided. Using the API version specified during the __init__. Args: path (str): The subpath desired. base (Optional[str]): The base url which should be prepended to the path Returns: str: Fully qualified URL rrWrrs r[rz JIRA._get_urlsE-$$&&~&&&t{%%W%%%r^c~|j}||dd|jdi|S)a;Returns the full url based on Jira base url and the path provided. Using the latest API endpoint. Args: path (str): The subpath desired. base (Optional[str]): The base url which should be prepended to the path Returns: str: Fully qualified URL r)rr*rWrrs r[rzJIRA._get_latest_urlsI-$$&&(CCDDDt{%%W%%%r^cd|||}|r.|j|tj|n|j||} t |}n<#t$r/}|j |d|r|j n||d}~wwxYw|S)aGet the json for a given path and params. Args: path (str): The subpath required params (Optional[Dict[str, Any]]): Parameters to filter the json query. base (Optional[str]): The Base Jira URL, defaults to the instance base. use_post (bool): Use POST endpoint instead of GET endpoint. Returns: Union[Dict[str, Any], List[Dict[str, str]]] rrrXN) rrrrrrxrLrYrcrwr) rrrrrrrrrrss r[rzJIRA._get_jsons$mmD$'' 7DM  sF););  < < <""3v"66  ]]FF    HNNa77Q#5166A77 8 8 8G  s$A44 B->*B((B- resource_clsr 3tuple[str, ...] | tuple[str | int, str] | int | strc||j|j}i}|||d<||||std|t ||S)aUses the find method of the provided Resource class. Args: resource_cls (Any): Any instance of :py:class`Resource` ids (Union[Tuple[str, str], int, str]): The arguments to the Resource's ``find()`` expand ([type], optional): The value for the expand property in the Resource's ``find()`` params. Defaults to None. Raises: JIRAError: If the Resource cannot be found Returns: Any: A class of the same type as ``resource_cls`` Nr)rrzUnable to find resource %s(%s))rerrrr)rrrrrrs r[rzJIRA._find_for_resourcesl& < t}==  %F8  V ,,, V.cleanup%sLLNNNNNr^) weakrefmagicMagicMAGIC_MIME_TYPEref_magic_weakrefrrAttributeErrorr)rrrrrs @r[rjzJIRA._try_magics # NNN LLL #5+@AA#####'.kk$&@&@#$  # # #" ! # # #"  #   DKKKK s)A;AAA8$A87A8;BBbuffc|j|j|S tj5}||t j|jdcdddS#1swxYwYt j|jdS#ttf$r|j dYdSwxYw)zGet the MIME type for a given stream of bytes. Args: buff (bytes): Stream of bytes Returns: Optional[str]: the MIME type Nrz]Couldn't detect content type of avatar image. Specify the 'contentType' parameter explicitly.) r id_buffertempfile TemporaryFilewrite mimetypes guess_typer{OSErrorrrcrd)rrrs r[rzJIRA._get_mime_type/s ; ";((.. . ')) 7Q  +AF33A6 7 7 7 7 7 7 7 7 7 7 7 7 7 7 7 7'//2 2#    H  D   44  s4B!4A7* B!7A;;B!>A;?!B!!+CCold_usernew_userc<|jdkr|d}d|i}d|i}|jd||j|j||tj |dStd) zRename a Jira user. Args: old_user (str): Old username login new_user (str): New username login rr~r{rz renaming rz> G4::--||~~8##$5666")..HY'/HY'0##  h'IxIIJ   GM"&/(:!M1=C''4  QhQQ!-QQ}$ G G GDXDDDDEEE Eh E E! E EFFF G/$FFCB M) $^ 499X&&D % I ,* I H GM&&y!9'=C''4  QhQQ!-QQ}$ G G GDXDDDDEEE Eh E E! E EFFF Gs<5C8 +C88 D<5D77D< 3G-+G-- H175H,,H1 backgroundc8|rdnd}|jdz}|j||jd}|jdkrdS|jds|sdS|jd r|jd dS|jds|rK|j ||jd|d d  }|jd dkrdS|j ddS)a&Start jira re-indexing. Returns True if reindexing is in progress or not needed, or False. If you call reindex() without any parameters it will perform a background reindex only if Jira thinks it should do it. Args: force (bool): True to reindex even if Jira doesn't say this is needed. (Default: ``False``) background (bool): True to reindex in background, slower but does not impact the users. (Default: ``True``) Returns: bool: True if reindexing is in progress or not needed r stoptheworldz$/secure/admin/jira/IndexReIndex.jsparriz-To perform the re-index now, please go to theTzAll issues are being re-indexedz$Jira re-indexing is already running.zRe-Index)indexingStrategyreindexrrrRz'Failed to reindex jira, probably a bug.F) rirrxrerqrrrcrdrrw)rrrrrrrs r[rz JIRA.reindexs;,6I<<>o FF M  c4=+C  D D =C  3 KLL  4 6;;8 9 9  H  C D D D4 6;;F G G 5  "" i0,<TT#A v{{<==CCt @AAAur^ backup.zip attachmentsbool | int | Nonec|jr1|jdz}tjd|i}d|jdd<n|jdz}d|i} |j||jd|}|jd krd S|j d |jd |jS#t$r%}|j d |Yd}~nd}~wwxYwdS)aWill call jira export to backup as zipped xml. Returning with success does not mean that the backup process finished. Args: filename (str): the filename for the backup (Default: "backup.zip") attachments (bool): True to also backup attachments (Default: ``False``) Returns: Union[bool, int]: Returns True if successful else it returns the statuscode of the Response or False z/rest/backup/1/export/runbackup cbAttachmentsXMLHttpRequestrzX-Requested-Withz/secure/admin/XmlBackup.jsparrrTzGot z response from calling backup.zI see %sNF) rbrirrrerrrqrcrdrvrw)rrrrrrrrss r[backupz JIRA.backups  > -/$EECj/;!?@@G;KDM) $%7 8 8/$BBC!8,G * ""3 i0Hw"WWA}##t H  QAMQQQ R R R=  * * * HNN:q ) ) ) ) ) ) ) ) *us3B'=)B'' C1CCcdttjdz}|jr|jd|dz}n|jddS|j||jd} tj |j S#t$rddl m}i} ||j }n6#|j$r)}|jd |Yd}~YdSd}~wwxYw|D]}||||<|cYSwxYw) zReturn status of cloud backup as a dict. Is there a way to get progress for Server version? Returns: Optional[Dict[str, Any]] iz/rest/obm/1.0/getprogress?_=r5This functionality is not available in Server versionNrrrzHUnable to find backup info. You probably need to initiate a new backup. )rr}rbrircrdrrxrerrrrvdefusedxml.ElementTree ElementTree fromstring ParseErrorr) r epoch_timerrretreeprogressrootpers r[backup_progresszJIRA.backup_progresssrt+,, > /$Q:$Q$Q$QQCC H  T U U U4 M  c4=+C  D D :af%% %    2 2 2 2 2 2H ''//#     c_acctttttt   YY[[ * *"hhqkk OOO s<>BD/*CD/ C8C3,D/3C884D/.D/cN|js|jddS|}|st dt jd|d}t|d}t|d}|dko|d kS) zfReturn boolean based on 'alternativePercentage' and 'size' returned from backup_progress (cloud only).rNz#Failed to retrieve backup progress.z \s([0-9]*)\salternativePercentagerrr;r) rbrcrdr RuntimeErrorrer4rr)rr perc_search perc_complete file_sizes r[backup_completezJIRA.backup_complete s~  H  T U U U4%%'' FDEE Ei8O1PQQ    a   v'' #5 A 5r^cx|js|jddS|}|st d|d}|p|}|jdz|z} |jd|t|d5} |j ||j dd }n#t$rtwxYw|j s6|jd |jt|j|d D]}|| dddn #1swxYwYn`#t$r'} |jd | Yd} ~ n4d} ~ wt$$r$} |j| Yd} ~ nd} ~ wwxYwdS)z.Download backup file from WebDAV (cloud only).rNz#Unable to retrieve backup progress.fileNamez/webdav/backupmanager/zWriting file to wbrT)rstreamz$Something went wrong with download: iz%Unable to access remote backup file: )rbrcrdrrrirrrrxrervrrbrwr iter_contentrr) rrr remote_file local_filerrrrespblockrioes r[backup_downloadzJIRA.backup_download/sR~  H  T U U U4'')) FDEE Ez* , o 88;F HNN:j:: ; ; ;j$'' &4&=,,T]9%=d-DD!&&&#++%&w/HNN#U$)#U#UVVV#DI...!..t44&&EJJu%%%%& & & & & & & & & & & & & & & & I I I HNNG2GG H H H H H H H H   HNN3         tsa#-EE(B;:E;CA-E EEEEE F7$F F7F22F7r{ct|dsR|d}|j||jd}t |}||_| |jrdnd}|j|S)aReturn the `accountId` (Cloud) else `username` of the current user. For anonymous users it will return a value that evaluates as False. Args: field (Optional[str]): the name of the identifier field. Defaults to "accountId" for Jira Cloud, else "username" Returns: str: User's `accountId` (Cloud) else `username`. _myselfrIrrNrr{)rrrrxrerLr'rb)rr{rrrrs r[ current_userzJIRA.current_userNs~tY'' "--))C !!#t}Y/G!HHA%/]]F!DL =$(>=KKvE|E""r^pid str | Project enable_undocVt|tr$t|drt|j}|d|}|j|d|i}|jdkrtd|jdkrtd|j S) aDelete project from Jira. Args: pid (Union[str, Project]): Jira projectID or Project or slug. enable_undo (bool): Jira Cloud only. True moves to 'Trash'. False permanently deletes. Raises: JIRAError: If project not found or not enough permissions ValueError: If pid parameter is not Project, slug or ProjectID Returns: bool: True if project was deleted rr enableUndoriz(Not enough permissions to delete projectrozProject not found in Jira) r`r;rrrrrr#rqrrb)rr)r+rrrs r[delete_projectzJIRA.delete_projecths" c7 # # T(:(: cf++Cmm,s,,-- M lK-H I I =C  FGG G =C  788 8t r^c|jdz}|jjst||j_|jjd|dd}|||j|t ddi|S)Nz&/secure/admin/WebSudoAuthenticate.jsparr)webSudoPasswordwebSudoDestination webSudoIsPostr z!application/x-www-form-urlencodedr)rirrrrfrr)rr=r;rrrs r[_gain_sudo_sessionzJIRA._gain_sudo_sessionso HH}! 5!/!4!4DM  $}1!4"-#   w}!! '!DE "   r^r[c|jdz}|j|}t|}i}d|vr!|dD]}|dD] }|||d<|S)Nz(/rest/project-templates/latest/templatesprojectTemplatesGroupedByTypeprojectTemplatesr{)rirrxrL)rrrrr templatesrrs r[r7zJIRA.templatesso JJ M  c " ")!}} *d 2 2=> - -12--A+,Iai((-r^c|d}|j|}t|}|dS)NpermissionschemepermissionSchemesrrrxrLrrrrrs r[permissionschemeszJIRA.permissionschemess@mm.// M  c " ")!}}'((r^list[IssueTypeScheme]c|d}|j|}t|}|dS)zGet all issue type schemes defined (Admin required). Returns: List[IssueTypeScheme]: All the Issue Type Schemes available to the currently logged in user. issuetypeschemeschemesr;r<s r[issue_type_schemeszJIRA.issue_type_schemess@mm-.. M  c " ")!}}Ir^c|d}|j|}t|}|dS)NissuesecurityschemesissueSecuritySchemesr;r<s r[rDzJIRA.issuesecurityschemess@mm233 M  c " ")!}}*++r^c|d}|j|}t|}|S)NprojectCategoryr;r<s r[projectcategorieszJIRA.projectcategoriess9mm-.. M  c " "!}} r^c|d|d}|j|}t|}|dS)Nzavatar/z/systemsystemr;)rentityrrrrs r[avatarsz JIRA.avatarssImm5f55566 M  c " ")!}}H~r^c|d}|j|}t|}|dS)Nnotificationschemerr;r<s r[notificationschemeszJIRA.notificationschemess@mm011 M  c " ")!}}H~r^c|d}|j|}t|}|dS)Nscreensrr;r<s r[rQz JIRA.screenss?mmI&& M  c " ")!}}H~r^c|d}|j|}t|}|S)Nworkflowschemesr;r<s r[workflowschemezJIRA.workflowschemes;mm-.. M  c " "!}} r^c|d}|j|}t|}|S)Nworkflowr;r<s r[ workflowszJIRA.workflowss:mmJ'' M  c " "!}} r^c|d|}|j|}t|}|j|S)Nzscreens/)rrr#rLrQ cache_clearrrrrrrs r[ delete_screenzJIRA.delete_screensRmmOrOO,, M  % %!}}   """ r^c|d|}|j|}t|}|j|S)Nzpermissionscheme/)rrr#rLr=rYrZs r[delete_permissionschemezJIRA.delete_permissionschemesVmm44455 M  % %!}} **,,, r^c|d|d}|j|}t|}|S)aFor the specified issue type scheme, returns all of the associated projects. (Admin required). Args: id (str): The issue type scheme id. Returns: List[Project]: Associated Projects for the Issue Type Scheme. zissuetypescheme/z /associationsr;rZs r["get_issue_type_scheme_associationsz'JIRA.get_issue_type_scheme_associationssFmm@r@@@AA M  c " "!}} r^software'ptype template_nameavatarIdissueSecuritySchemepermissionSchemerGnotificationScheme categoryIdrrc d} ||}||}|A|}|D]}|ddkr |d}n||r|dd}|td|A|}|D]}|ddkr |d}n||r|dd}|td| r| s| n| } | A|}|D]}|ddkr |d} n| |r|dd} |s |jrd nd } n|} d|d |d |d | |jrdnd|dddddt |d| d| i }|rt ||d<| rt | |d<|d} |j | tj |}| t|}|S)aCreate a project with the specified parameters. Args: key (str): Mandatory. Must match Jira project key requirements, usually only 2-10 uppercase characters. name (Optional[str]): If not specified it will use the key value. assignee (Optional[str]): Key of the lead, if not specified it will use current user. ptype (Optional[str]): Determines the type of project that should be created. Defaults to 'software'. template_name (Optional[str]): Is used to create a project based on one of the existing project templates. If `template_name` is not specified, then it should use one of the default values. avatarId (Optional[int]): ID of the avatar to use for the project. issueSecurityScheme (Optional[int]): Determines the security scheme to use. If none provided, will fetch the scheme named 'Default' or the first scheme returned. permissionScheme (Optional[int]): Determines the permission scheme to use. If none provided, will fetch the scheme named 'Default Permission Scheme' or the first scheme returned. projectCategory (Optional[int]): Determines the category the project belongs to. If none provided, will fetch the one named 'Default' or the first category returned. notificationScheme (Optional[int]): Determines the notification scheme to use. categoryId (Optional[int]): Same as projectCategory. Can be used interchangeably. url (Optional[str]): A link to information about the project, such as documentation. Returns: Union[bool,int]: Should evaluate to False if it fails otherwise it will be the new project id. Nr{zDefault Permission Schemerrz)Unable to identify valid permissionSchemeDefaultz,Unable to identify valid issueSecuritySchemez.com.pyxis.greenhopper.jira:gh-simplified-basicz>com.pyxis.greenhopper.jira:basic-software-development-templaterzprojectTypeKeyprojectTemplateKey leadAccountIdleadr- PROJECT_LEADr+rQrfrgrrrerhr(r)r(r=rrDrHrbrrrrrrrrL)rrzr{rrbrcrdrerfrGrgrhrr template_keyps_listsecrrrs r[create_projectzJIRA.create_projectsL  ((**H <D  #,,..G  v;"==='*4y$E> 'G'#*1:d#3  #JKK K  &//11G  v;)++*-d)'E,#*w*&-aj&6#  &MNN N % Q_ QJJ/   ",,..G  v;)++&)$iOE,&7&")!*T"2  )>V@@U L )Lt D 3 e ,#~ 9OO68 N 2 $4 5 5 "4 3    F-01D-E-EG) *  9$'$8$8GL !mmI&& M  sG)<)<  = = A r^r directoryIdrnotifyrignore_existingapplication_keys list | Nonec |s|}|d} t} || d<|| d<|| d<|r|| d<|rd| d<| | | d <tj| } |j| | nR#t $rE} | j7| jd }d |vr|d d kr|rYd} ~ dS| d} ~ wwxYwdS)aCreate a new Jira user. Args: username (str): the username of the new user email (str): email address of the new user directoryId (int): The directory ID the new user should be a part of (Default: ``1``) password (Optional[str]): Optional, the password for the new user fullname (Optional[str]): Optional, the full name of the new user notify (bool): True to send a notification to the new user. (Default: ``False``) active (bool): True to make the new user active upon creation. (Default: ``True``) ignore_existing (bool): True to ignore existing users. (Default: ``False``) application_keys (Optional[list]): Keys of products user should have access to Raises: JIRAError: If username already exists and `ignore_existing` has not been set to `True`. Returns: bool: Whether the user creation was successful. r~rrr{rTrue notificationNapplicationKeysrrrz)A user with that username already exists.T)rrrrrrrrn)rrrrtrrrurrvrwrrrrrserrs r[add_userz JIRA.add_users.> H""6**(MM#-!.&  %$AjM  ' &An   '#3A *Q--  M  s  1 1 1 1   z%joo''1#%%J+VVV'W 44444G ts!A>> C 8CCC bool | dict[str, Any]c|d}d|i}d|i}tj|}t|j|||}d|vs |d|krdS|S)a^Add a user to an existing group. Args: username (str): Username that will be added to specified group. group (str): Group that the user will be added to. Returns: Union[bool,Dict[str,Any]]: json response from Jira server for success or a value that evaluates as False in case of failure. group/userrr{rF)rrrrLrr)rrrrrryrrs r[add_user_to_groupzJIRA.add_user_to_groups}""<00 %  X *Q--&t}'9'9#ag'9'V'VWW ??ai5005Hr^cr|d}||d}|j||dS)zRemove a user from a group. Args: username (str): The user to remove from the group. groupname (str): The group that the user will be removed from. Returns: bool r)rrrTr)rrrrrrs r[remove_user_from_groupzJIRA.remove_user_from_group)sD""<00# : : S+++tr^c|d}|j|}t|}|S)ztReturn Jira role information. Returns: List[Dict[str,Any]]: List of current user roles role)rrrxrLr<s r[rz JIRA.role:s<""6** M  c " "%/]] r^issueid customfieldschemeidc|jdz}t|rd|}|||d}|j||jd|}t |S)Nz$/rest/idalko-igrid/1.0/datagrid/data customfield_)_issueId_fieldId _confSchemeIdrr)ririsdigitrrxrerL)rrrrrrrrs r[ get_igridzJIRA.get_igridJs~o FF {   # # % % 7666K#%   M  c4=+CF  S S!}}r^ResultList[Board]c |i}|r||d<|r||d<|r||d<|tdd||||jS)a*Get a list of board resources. Args: startAt: The starting index of the returned boards. Base index: 0. maxResults: The maximum number of boards to return per page. Default: 50 type: Filters results to boards of the specified type. Valid values: scrum, kanban. name: Filters results to boards that match or partially match the specified name. projectKeyOrID: Filters results to boards that match the specified project key or ID. Returns: ResultList[Board] rCr{projectKeyOrIdrboardr)rr#AGILE_BASE_URL)rrrrCr{projectKeyOrIDrs r[boardsz JIRA.boardsZss*  "!F6N  "!F6N  6'5F# $       $!   r^board_idextendedstateResultList[Sprint]c i}|r||d<|td|tdd|d||||jS)a&Get a list of sprint Resources. Args: board_id (int): the board to get sprints from extended (bool): Deprecated. startAt (int): the index of the first sprint to return (0 based) maxResults (int): the maximum number of sprints to return state (str): Filters results to sprints in specified states. Valid values: `future`, `active`, `closed`. You can define multiple states separated by commas Returns: ResultList[Sprint]: List of sprints. rNz%The `extended` argument is deprecatedrzboard/z/sprint)r^rrCr)rrrrrrrs r[sprintsz JIRA.sprintssj,  $#F7O   F G G G    &X & & &        r^dict[str, dict[str, Any]]ci}||||D]5}|j|vr|j||j<td|jd|d|S)aGet a dictionary of sprint Resources where the name of the sprint is the key. Args: board_id (int): the board to get sprints from extended (bool): Deprecated. state (str): Filters results to sprints in specified states. Valid values: `future`, `active`, `closed`. You can define multiple states separated by commas Returns: Dict[str, Dict[str, Any]]: dictionary of sprints with the sprint name as key )rrz1There are multiple sprints defined with the name z on board id zS, returning a dict with sprint names as a key, assumes unique names for each sprint)rr{rsr)rrrrrrs r[sprints_by_namezJIRA.sprints_by_namesb85AA  AvW$$"#%iii]_iiir^endDategoalci}|r||d<|r||d<|r||d<|r||d<|r||d<|d||j}|j|t j|} t | S) aUpdates the sprint with the given values. Args: id (Union[str, int]): The id of the sprint to update name (Optional[str]): The name to update your sprint to startDate (Optional[Any]): The start date for the sprint endDate (Optional[Any]): The start date for the sprint state: (Optional[str]): The state of the sprint goal: (Optional[str]): The goal of the sprint Returns: Dict[str, Any] r{ryrrrsprint/rr)rrrrrrrL) rrr{ryrrrrrrrs r[ update_sprintzJIRA.update_sprints,  #"GFO  -#,GK  )!(GI   %$GG   #"GFOmmNbNN1DmEE M  c 7(;(;  < <!}}r^ sprint_idcn|d|d||j}|dddS)0Return the total incompleted points this sprint.&rapid/charts/sprintreport?rapidViewId= &sprintId=rcontentsincompletedIssuesEstimateSumrrrrrrrs r[rz!JIRA.incompletedIssuesEstimateSumsK#~~ TX T T T T$ .  J >?HHr^cd|d|j}fd|ddD}|S)z^Return the completed issues for the sprint. Returns: List[Issue] rrrcFg|]}tjj|SrW)r/rer)rYraw_issues_jsonrs r[rz'JIRA.removed_issues..s9    $- @ @   r^r puntedIssuesr)rrrrrs` r[removed_issueszJIRA.removed_issuesso "& TX T T T T$"0" "     #)*#5n#E     r^cn|d|d||j}|dddS)rrrrrpuntedIssuesEstimateSumrrrs r[removedIssuesEstimateSumzJIRA.removedIssuesEstimateSumsK#~~ TX T T T T$ .  J 9:7CCr^cnt|j|j}|||jS)aReturn the information about a sprint. Args: board_id (str): the board retrieving issues from. Deprecated and ignored. sprint_id (str): the sprint retrieving issues from Returns: Dict[str, Any] )rCrerrrs)rrrsprints r[ sprint_infozJIRA.sprint_info s1 t}55 Izr^rCcdt|j|j}|||S)zReturn the information about a sprint. Args: sprint_id (int): the sprint retrieving issues from Returns: Sprint )rCrerr)rrrs r[rz JIRA.sprints+ t}55 B r^cjt|j|jd|i}|dS)zDelete an agile board.rr.N)r#rerr#)rrrs r[ delete_boardzJIRA.delete_board&s/dmT]r CCC r^scrumr project_idspreset location_typeLiteral['user', 'project'] location_idr#ci}|td|||j}||d<||d<||d<|jr(d|i|d<|dvr|dd|i|d |j }|j|tj | } t| } t|j |j| S) aCreate a new board for the ``project_ids``. Args: name (str): name of the Board (<255 characters). filter_id (str): the Filter to use to create the Board. Note: if the user does not have the 'Create shared objects' permission and tries to create a shared board, a private board will be created instead (remember that board sharing depends on the filter sharing). project_ids (str): Deprecated. See location_id. preset (str): What preset/type to use for this Board, options: kanban, scrum, agility. (Default: "scrum") location_type (str): the location type. Available in Cloud. (Default: "user") location_id (Optional[str]): aka ``projectKeyOrId``. The id of Project that the Board should be located under. Omit this for a 'user' location_type. Available in Cloud. Returns: Board: The newly created board Nzcproject_ids is deprecated and ignored. Use filter_id and location_id with `location_type='project'`r{filterIdrClocation)r~rrrrr.)r^r(rrbrfrrrrrrrLr#re) rr{rrrrrrrrrrs r[ create_boardzJIRA.create_board+s2#%  " Q     ",,{336K'   > L#)="9GJ I-- #**,> M  sG)<)<  = =#AT]DM~FFFFr^c(d|i}|r||d<|r||d<|r||d<|d|j}||d<|j|t j|}t |} t|j|j| S) aCreate a new sprint for the ``board_id``. Args: name (str): Name of the sprint board_id (int): Which board the sprint should be assigned. startDate (Optional[Any]): Start date for the sprint. endDate (Optional[Any]): End date for the sprint. goal (Optional[str]): Goal for the sprint. Returns: Sprint: The newly created Sprint r{ryrrrr originBoardIdrr.) rrrrrrrLrCre) rr{rryrrrrrrraw_sprint_jsons r[ create_sprintzJIRA.create_sprint]s($*4.  -#,GK  )!(GI   #"GFOmmH4+>m??#+ M  sG)<)<  = =$Q--dmT]HHHHr^ issue_keysc|d|d|j}d|i}|j|t j|S)aAdd the issues in ``issue_keys`` to the ``sprint_id``. The sprint must be started but not completed. If a sprint was completed, then have to also edit the history of the issue so that it was added to the sprint before it was completed, preferably before it started. A completed sprint's issues also all have a resolution set before the completion date. If a sprint was not started, then have to edit the marker and copy the rank of each issue too. Args: sprint_id (int): the sprint to add issues to issue_keys (List[str]): the issues to add to the sprint Returns: Response r/issuerrrrrrrrr)rrrrrrs r[add_issues_to_sprintzJIRA.add_issues_to_sprintsW"mm7i777d>QmRRZ(}!!#DJw,?,?!@@@r^epic_idstr | list[str] ignore_epicsc<i}t|tr|dnt||d<|t d|d|d|j}|j|tj |S) aAdd the issues in ``issue_keys`` to the ``epic_id``. Issues can only exist in one Epic! Args: epic_id (str): The ID for the epic where issues should be added. issue_keys (Union[str, List[str]]): The list (or comma separated str) of issues to add to the epic ignore_epics (bool): Deprecated. Returns: Response rrNz`ignore_epics` is Deprecatedzepic/rrr) r`rrrr^rrrrrr)rrrrrrrs r[add_issues_to_epiczJIRA.add_issues_to_epics& "%/ C%@%@ VJ  S ! ! !d:FVFV X  # = > > >mm3G333$:MmNN}!!#DJt,<,<!===r^ next_issue prev_issuec ||td||td|d}|}n|d}|}|jso|D]Z}|ddkrL|dd d kr|dd |_n&|dd d kr|dd |_[|d |j}d|gd|d|d|ji}|j|tj|S)aRank an issue before/after another using the default Ranking field, the one named 'Rank'. Pass only ONE of `next_issue` or `prev_issue`. Args: issue (str): issue key of the issue to be ranked before/after the second one. next_issue (str): issue key that the first issue is to be ranked before. prev_issue (str): issue key that the first issue is to be ranked after. Returns: Response Nz5One of 'next_issue' or 'prev_issue' must be specifiedz9Only one of 'next_issue' or 'prev_issue' may be specifiedBeforeAfterr{Rankrcustomz'com.pyxis.greenhopper.jira:gh-lexo-rankrz)com.pyxis.greenhopper.jira:gh-global-rankz issue/rankrrrankr/rankCustomFieldIdr) rYrgrrrrrrr) rrrrbefore_or_after other_issuer{rrrs r[rz JIRA.ranksY(  *"4TUU U  # (>K   !&O$KK  #%O$Kz A A A=F**h1DEE&+8_Z%@ h1FGG&+8_Z%@ mmLt/BmCC ug )? ) ) );   }  4:g+>+> ???r^c|d|j}d|i}|j|t j|S)a9Move issues in ``issue_keys`` to the backlog, removing them from all sprints that have not been completed. Args: issue_keys (List[str]): the issues to move to the backlog Raises: JIRAError: If moving issues to backlog fails Returns: Response z backlog/issuerrrr)rrrrrs r[move_to_backlogzJIRA.move_to_backlogsKmmO$2EmFFZ(}!!#DJw,?,?!@@@r^list[PinnedComment]cZd|di}fd|D}|S)zGet a list of pinned comment Resources of the issue provided. Args: issue (Union[int, str]): the issue ID or key to get the comments from Returns: List[PinnedComment] rz/pinned-commentsrcFg|]}tjj|SrW)r8rerr s r[rz(JIRA.pinned_comments..s:     $-8H I I   r^r)rrrpinned_commentss` r[rzJIRA.pinned_commentssV @ @ @ @LL    $*   r^pinc|dt|zdzt|zdz}|j|t|S)aPin/Unpin a comment on the issue. Args: issue (Union[int, str]): the issue ID or key to get the comments from comment (Union[int, str]): the comment ID pin (bool): Pin (True) or Unpin (False) Returns: Response rz /comment/z/pinr)rrrrrP)rrr$rrrs r[ pin_commentzJIRA.pin_comment sammHs5zz1K?#g,,NQWWXX}  3s88>>+;+; <<r?r@rArrBrrCrrDrrErFrGrFr1rrHrFrIrrJrKrLrMrr@rNrO)rRr)rRr)rRrF)rr)rr)rrrrrrrrrrrrrrrrFrRr)rrrrrrrrrrrrrrFrRr)rrrrrrrRr)rrrRr)rQ)rrrrrRr?)r)rrrV)rzrrRr)rzrrr)T)rrFrRr)rrrRr")rRr)rrrrrrrRr")rrrRr)rr)NNNF)r{rr(rrRr%)rrrRr')Nrr:)rRr;)rrrRr()NNN) r{rr+rrCrDrErDrRr() rrr{rr+rrCrDrErDrRr()rrrOrrRr)rTrrUrrRrV)rTrrUrr\rrRr*) rTrrUrr\rrrrRr*)rTrrRrd)rRrj)NNNNNN)rTrmrnrrorrprrqrrrsrrtrrRr))rRry)rrrRr-)rRr~)NNNN) r{rr+rrrrrrRr-)r{rr+rrrrr)rrrrKrRr.)NNr)rrrrKrrrRr)rrrRr)rrrRrF) rrrrrrrrrRr/)NT)rrrrFrRr/)rryrrFrRry)rrrrrRr&)rRr)rrrRrB)rRr)rr)rrrrrrrRr) rrrrrrrrrRr) rrrrrrrrrrrRr)r~rFrRr)r~rrRr)rrrrrRrF) rrrrrrrrrrrRr)rrr$rrrrRr$)NF) rr'r(rr)r*r+rFrRr$)rr)rrrRr2)rrrrrRr<) rrr;r<r=rr>rr?rrRr<)rrrAr)NN)rr'rr)rr'rNrrRr) rr'rRrrrr$rrTr)rrrRrH)r(rrRr3)r(rrRr6)r(rrRr7)r(rrRr:)r(rrRrJ)rrrRr)rrrRrI)rrrsrrRr)rrrRrz)rrrrrRrK) NNNNNNNNN)rrrWrrrrrrrrrr$rrrr~rr)rrRrK)rrrRr)rrrzrrRr2)rrrzrrRr) rCrrrrrr$rrRr)rrrRr0)F)rrFrRr)rrrRr1)rRr)r(rrrrrrRr) r(rrrrrrrrRr)rrrRr4)r{rr(rrRr4)rrBrRr)rrBr{r)NNNNN) rrrrrrrrrrrRr)rRr)rrrRr9)rrrRr)rrrrrRr;)r(r) r(rrrrrrrrrrrF)r(rrr)r(rrr)r(rrrrRr)r(rrRr)r(rrRr)r(rr rrRr )r(rrrrrrRr)r(rrRr)r(rrrrRr@)rRr)rrrRr>)rrTr#NN)r%rrrrrr&rFrr'rrrrr$r(rrFrRr))r%rrrrrr&rFrr'rrrrr$r.rrFrRr)r%rrrrrr&rFrr'rrrrr$rFrrFrRr0)Nrr#NNN)r%rrrrrrr'rrr:r;rrr$rFrrFrRr0)r%rr$rFrRr=)rrrRrAr)rRrJ)rrrRr)rrrRrD)rRrT)rrrRrE)rrrrKrRrF) rrrrrrrrrRr)NNNNrrN)rrr(rrrrrKrrrrrr)rrrRr) r~rrrrrrrrrKrrF)r~rrr)rrrrrRr)rrnrlrrmrrRr)NrrTFN)r~rrrrrrrrFrsrFrrrRrt)NNrr) r~rrrrrrrrrrRr)NNNFF)r{rr(rr+rrxrKryrKrzrFr{rFrRrG)rrrrrqrrRrG)rrrrKrRrG)rRrF)rRr)rRr)rrrr)rBr)rDr)rr)rCr)rAr)rrrrrRr)rrrrrrrrF)rr rrrRr )rrrRr)rrrr)rrrRrF)rrrRr)FT)rrFrrFrRrF)rF)rrrrFrRr)rRr)rRr)rr)r{rrRr)r)r*r+rFrRr)rRr[)rRr>r)rrrRr) NNr`NNNNNraNrQ)rzrr{rrrrbrrcrrdrrerrfrrGrrgrrhrrrr)rNNFTFN)rrrrrtrrrrrrurFrrFrvrFrwrx)rrrrrRr)rrrrrRrF)rrrrrr)rrNNN) rrrrrCrr{rrRr)NrrN) rrrrrrrrrrrRr)FN)rrrrFrrrRr)rrr{rryrKrrKrrrrrRr)rrrr)rrrrrRr)rrrRrC)Nrr~N)r{rrrrrrrrrrrrRr#) r{rrrryrKrrKrrrRrC)rrrrrRr)rrrrrrrRr)rrrrrrrRr)rrrRr)rrrRr)rrr$rrrFrRr)rrrrr!AGILE_BASE_REST_PATHr?rdryrrrrrrrirbrrrzrrrrrrjrrrrrrrrrrrrrr r%r'r/r5r7r9r>r?rurKrNrSr[r^rcrBrlrxrr=rrrrrrrrrrrrrrrrrrrrr rrr#r$r.r1r7r:rFrIrMrSr\r^rarcrergrjrnrprrrwryrrTrrrrrrrrrrrrrrrrrrrrr(rrrrrrr r rrrr!rrr,r6rArCrtrIrOrRrrXrVr~r]r`rbrerdrirkrqrrwrrrrrrrrrnrmrqrkrl staticmethodrrorprrRrrrrrjrrrrrrrrr%r(r.r3rr7r=rBrDrHrLrOrQrTrWr[r]r_rsr~rrrrrrrrrrrrrrrrrrrrrrrWr^r[raras(.*  U  C  ==  !% $ T   t  !" '.",  #4  c 5O>O*M"1N"6:-1!%'+%)26 $"RV'+GK'P6P6P6P6P6d(((X( ===,,,X,111X1        " ! ! !(,!PPPPPd (,!1?1?1?1?Y1?fBBBB $$$$(HJ. H H H H] H !% G G G G G @ @ @ @&&&&&0 7 7 7 71111 $ TTTTTl ) ) ) )6666 !&&&&&P " " " " ) ) ) ) > > > >24     2    #'596: O O O O Y OD #'596: #O#O#O#O Y#OJ111 Y1.    $''''$QQQQ. Y2RRR YR!<@!%*. ,R,R,R,R Y,Rb'''' 3 3 3 3     "&!% IIIIIH "&!% I I I I IH(!" 83G3G3G3Gj.    ("!!%     H)-7K7K7K7K7KtBFKKKKKZ   MMMM0     8 8 8 8)-5K5K5K5K]5Kn    $ % % % % % V ' ' ' ' ' V59-/)-%)! 3:3:3:3:3:j ? ? ? ?$3$3$3$3N "#"&# #####JCG Q Q Q Q Q -1! H H H H HF C C C C  @ @ @ @$ $-1#' SSSSSj4     (. )-"" 77777r5555 J J J J D D D D B B B B @ @ @ @ @ @ @ @ ' ' ' '"""" 8 8 8 8 D D D D"     = = = =!%'+%)"&#",0,0HDHDHDHDHDX     D D D D = = = = *. .>.>.>.>.>`)))) 6 6 6 6-----" : : : :      B > 6 6 6 6KKKKK.."& $#""& $>$>$>$>$>P     5 5 5 5& C C C C CAAAA#'"5'5'5'5'5'n"XXXX ) ) ) )  $ * * * ** < < < <     7 7 7 7#)/!!%  ',      X  #)/!!%      X "#)/!!%h"hhhhhhT%))/!,0!%W"WWWWWYWr " -----Y-@ : : : : ((((  3 3 3 3      ; ; ; ;2      < $"#! 5 5 5 5 5 p M M M M"#'">'>'>'>'>'@"      8 8 8 8 #' $ ))))))> " % #Y#Y#Y#Y#YP $!%      > #'"& $*****ZIM6" / / / /    ))))     2 2 2 2    H37     0 ) ) ) ( ( (....\. &&&&"3333LLL8E&&&&&$/<&&&&& 6C&&&&&&)-! F 8###*.*"GGGGGGGGR*****ZAF<B 6 6 6 6>#####67;8   ,     U  )) U)     U  ,, U,  U  U  U  U  U  U    " #$(#*.'+&*"'!%pppppl## %(,@@@@@D,"         $ $ $ $ $ L!% $ $ $ $ $ NJN8 $" %%%%%NIIII"DDDD        #'4:"&0G0G0G0G0Gl!%" "I"I"I"I"IHAAAA2%) >>>>>>"&!% 7@7@7@7@7@rAAAA " = = = = = =r^ra)rQr rRr )rvr rV)rrrr rRr)r __future__rrrrrrrHr`rrrrXrr}rpr\ collectionsrcollections.abcrr functoolsrrior numbersr typingr r r rrrrr urllib.parserrrrpackaging.versionrrr requests.authrrequests.structuresrrequests.utilsrrequests_toolbeltrrPrjira.exceptionsrrjira.resilientsessionrr jira.resourcesr!r"r#r$r%r&r'r(r)r*r+r,r-r.r/r0r1r2r3r4r5r6r7r8r9r:r;r<r=r>r?r@rArBrCrDrErFrGrHrIrJrK jira.utilsrLrMrN requests_jwtrOr getLoggerr  addHandler NullHandlerrjrurrrrrrrrrarWr^r[rs#"""""    ######........""""""""                    3222222222444444""""""333333))))))......;;;;;;;;JJJJJJJJ,,,,,,,,,,,,,,,,,,,,,,,,,,,,,,,,,,,,,,,,,,,,,,,,,,,,,,,,,,,,,,,,,,,,,,,,,,,,,,,,,,,,,,,,,,ZNMMMMMMMMM $$$$$$$   D h  #x#%%&&&####L####L0%)!!!!!w~TJJJ 8686868686w|,868686xDDDDDDDDBP+P+P+P+P+XP+P+P+f        AV=AV=AV=AV=AV=AV=AV=AV=AV=AV=s$D++D32D3