daiۀ^ddlZddlmZddlmZej eZGddeZy)N) HTTPError)AtlassianRestAPIceZdZdZdZdZdZdZdZdZ d7d Z d Z d Z d Z d8d Zd7dZd7dZd9dZd:dZd;dZdZdd,Z.d8d-Z/d.Z0d/Z1d0Z2d1Z3d2Z4d3Z5d4Z6d5Z7d6Z8y)? ServiceDeskz% JIRA ServiceDesk API object c<|jd|jS)zGet info about Service Desk appzrest/servicedeskapi/infoheadersgetexperimental_headers)selfs N/var/www/timesheet/venv/lib/python3.12/site-packages/atlassian/service_desk.pyget_infozServiceDesk.get_infosxx2D8894C\C\8]   OB##H--rNctjd|||d}|r||d<|r||d<d|ji}t|tr||d<nt|t r||d<|j di|S) a Creating customer request :param service_desk_id: str :param request_type_id: str :param values_dict: str/dict :param raise_on_behalf_of: str :param request_participants: list :return: New request zCreating request...) serviceDeskId requestTypeIdrequestFieldValuesraiseOnBehalfOfrequestParticipantsr jsonr!)r-)r#r$r isinstancedictstrr%)rrrequest_type_id values_dictraise_on_behalf_ofrequest_participantsr! param_maps rcreate_customer_requestz#ServiceDesk.create_customer_requestXs$ &',,"-  &8D" # *>D& ' 9 9: k4 ( $If   S ) $If tyyD)DDrc|jd|d|j}|jr|S|r7|jdgr%|jdgdjdiSiS)zt Get customer request status name :param issue_id_or_key: str :return: Status name r)z/statusr rrstatusr)rr*requests rget_customer_request_statusz'ServiceDesk.get_customer_request_statussv((*?*;7 C--    N {{8R({{8R0377"EE rcHd|d}|j||jS)z Returns a list of transitions that customers can perform on the request :param issue_id_or_key: str :return: r) /transitionr r )rr*urls rget_customer_transitionsz$ServiceDesk.get_customer_transitionss,-_,=[IxxT%>%>x??rcD|jd|d|jS)zy Gets request types :param service_desk_id: str :return: all service desk request types r /requesttyper r rs rget_request_typeszServiceDesk.get_request_typess0xx..?| L--  rcd|d}i}|t||d<|t||d<|j|||j}|jr|S|xsijdS)z Get request participants :param issue_id_or_key: str :param start: OPTIONAL: int :param limit: OPTIONAL: int :return: Request participants r) /participantstartlimitparamsr rintr r rrr*rMrNrFrPr.s rget_request_participantsz$ServiceDesk.get_request_participantss{-_,=\J  !%jF7O  !%jF7O88C8Q8Q8R   OB##H--rcjd|d}i}|||d<|||d<|j|||jS)a" Add users as participants to an existing customer request The calling user must have permission to manage participants for this customer request :param issue_id_or_key: str :param users_list: list :param account_list: list :return: r)rL usernames accountIdsr!r r%r rr* users_list account_listrFr!s radd_request_participantsz$ServiceDesk.add_request_participantssS-_,=\J  ! *D   #!-D yy41J1JyKKrcjd|d}i}|||d<|||d<|j|||jS)a Remove participants from an existing customer request The calling user must have permission to manage participants for this customer request :param issue_id_or_key: str :param users_list: list :param account_list: list :return: r)rLrVrWrX)deleter rZs rremove_request_participantsz'ServiceDesk.remove_request_participantssS-_,=\J  ! *D   #!-D {{3T43L3L{MMrctjd|z|d|id}d|d}|j||j|S)a- Perform a customer transition for a given request and transition ID. An optional comment can be included to provide a reason for the transition. :param issue_id_or_key: str :param transition_id: str :param comment: OPTIONAL: str :return: None z!Performing transition for issue: body)idadditionalCommentr)rEr r")rr* transition_idcommentr!rFs rperform_transitionzServiceDesk.perform_transitionsO 4FG#67:KL,_,=[Iyyd&?&?dyKKrc~tjd||d}d|d}|j|||jS)z Creating request comment :param issue_id_or_key: str :param body: str :param public: OPTIONAL: bool (default is True) :return: New comment zCreating comment...)rbpublicr)/comment)pathr!r r")rr*rbrir!rFs rcreate_request_commentz"ServiceDesk.create_request_commentsE &'/,_,=XFyycd6O6OyPPrcd|d}i}|t||d<|t||d<|t||d<|t||d<|j|||j}|jr|S|xsijdS) a Get all comments in issue :param issue_id_or_key: str :param start: OPTIONAL: int :param limit: OPTIONAL: int :param public: OPTIONAL: bool :param internal: OPTIONAL: bool :return: Issue comments r)rjrMrNriinternalrOr)rRboolr r r) rr*rMrNrirnrFrPr.s rget_request_commentsz ServiceDesk.get_request_commentss-_,=XF  !%jF7O  !%jF7O  #F|F8   !%hF: 88C8Q8Q8R   OB##H--rcH|jd|d||jS)z Get single comment by ID :param issue_id_or_key: str :param comment_id: str :return: Single comment r)z /comment/r r )rr* comment_ids rget_request_comment_by_idz%ServiceDesk.get_request_comment_by_id"s4xx*?*;9ZL Q--  rcd}d|d}i}|t||d<|t||d<||j||j|S|j||j|S)aa Returns a list of organizations in the Jira instance. If the user is not an agent, the resource returns a list of organizations the user is a member of. :param service_desk_id: OPTIONAL: str Get organizations from single Service Desk :param start: OPTIONAL: int The starting index of the returned objects. Base index: 0. See the Pagination section for more details. :param limit: OPTIONAL: int The maximum number of users to return per page. Default: 50. See the Pagination section for more details. :return: rest/servicedeskapi/organizationr /organizationrMrNr rPrRr r )rrrMrNurl_without_sd_idurl_with_sd_idrPs rget_organisationszServiceDesk.get_organisations1s?;O;LMZ  !%jF7O  !%jF7O  "88!11  xx0I0IRXxYYrcFd|}|j||jS)z Get an organization for a given organization ID :param organization_id: str :return: Organization !rest/servicedeskapi/organization/r r rorganization_idrFs rget_organizationzServiceDesk.get_organizationPs*2/1BCxxT%>%>x??rcd|d}i}|t||d<|t||d<|j||j|S)z Get all the users of a specified organization :param organization_id: str :param start: OPTIONAL: int :param limit: OPTIONAL: int :return: Users list in organization r}/userrMrNrwrx)rrrMrNrFrPs rget_users_in_organizationz%ServiceDesk.get_users_in_organization[sY2/1B%H  !%jF7O  !%jF7OxxT%>%>vxNNrcztjd|zd}d|i}|j||j|S)z To create an organization Jira administrator global or agent permission is required depending on the settings :param name: str :return: Organization data zCreating organization: runamer r")rrrFr!s rcreate_organizationzServiceDesk.create_organizationms? *T120~yyd&?&?dyKKrc|tjdd|d}d|i}|j||j|S)z Adds an organization to a servicedesk for a given servicedesk ID and organization ID :param service_desk_id: str :param organization_id: int :return: zAdding organization...rrvorganizationIdr r"rrrrFr!s radd_organizationzServiceDesk.add_organization{sE )*00AO /2yyd&?&?dyKKrc|tjdd|d}d|i}|j||j|S)z Removes an organization from a servicedesk for a given servicedesk ID and organization ID :param service_desk_id: str :param organization_id: int :return: zRemoving organization...rrvrr r#r$r_r rs rremove_organizationzServiceDesk.remove_organizationsE +,00AO /2{{3(A(A{MMrcrtjd|d|}|j||jS)zw Deletes an organization for a given organization ID :param organization_id: :return: zDeleting organization: %s r}r rr~s rdelete_organizationzServiceDesk.delete_organizations9 -?1/1BC{{3(A(A{BBrctjdt|d|d}||d}|j||j|S)z Adds users to an organization users_list is a list of strings account_list is a list of accountIds :param account_list: :param organization_id: str :param users_list: list :return: zAdding users: %s r}rrVrWr )r#r$r9r%r rrr[r\rFr!s radd_users_to_organizationz%ServiceDesk.add_users_to_organizationsK $c*o61/1B%H'|Dyyd&?&?dyKKrctjdt|d|d}||d}|j||j|S)a Removes users from an organization users_list is a list of strings account_list is a list of accountIds :param organization_id: str :param users_list: list :param account_list: list :return: zRemoving users: %sr}rrr )r#r$r9r_r rs rremove_users_from_organizationz*ServiceDesk.remove_users_from_organizationsK %s:71/1B%H'|D{{3(A(A{MMrcg}t|ts|g}|D]%}|j||}|j|'|j ||||S)a Add attachment as a comment. Setting attachment visibility is dependent on the user's permission. For example, Agents can create either public or internal attachments, while Unlicensed users can only create internal attachments, and Customers can only create public attachments. An additional comment may be provided which will be prepended to the attachments. :param service_desk_id: str :param issue_id_or_key: str :param filenames: Union(List[str], str), name, if file in current directory or full path to file :param public: OPTIONAL: bool (default is True) :param comment: OPTIONAL: str (default is None) :return: Request info )r7listattach_temporary_fileappendadd_attachments) rrr* filenamesrirftemp_attachment_idsfilenametemp_attachment_ids rcreate_attachmentszServiceDesk.create_attachmentssg.!)T*" I! ;H!%!;!;OX!V   & &'9 : ; ##O5H&RYZZrcXtjd|j|||||S)a Add attachment as a comment. Setting attachment visibility is dependent on the user's permission. For example, Agents can create either public or internal attachments, while Unlicensed users can only create internal attachments, and Customers can only create public attachments. An additional comment may be provided which will be prepended to the attachments. :param service_desk_id: str :param issue_id_or_key: str :param filename: str, name, if file in current directory or full path to file :param public: OPTIONAL: bool (default is True) :param comment: OPTIONAL: str (default is None) :return: Request info zCreating attachment...rirf)r#r$r)rrr*rrirfs rcreate_attachmentzServiceDesk.create_attachments8, )*&&    '  rcd|d}|jj}|d=d|d<t|d5}|jr4|j ||d|ij j d }n%|j ||d|ij d }|d j d }|cd d d S#1swYy xYw) z Create temporary attachment, which can later be converted into permanent attachment :param service_desk_id: str :param filename: str :return: Temporary Attachment ID rz/attachTemporaryFile Content-Typeno-checkX-Atlassian-Tokenrbfile)rkr filestemporaryAttachmentsrtemporaryAttachmentIdN)r copyopenrr%r6r )rrrrFr rresultrs rrz!ServiceDesk.attach_temporary_files10AAUV $88==?  04>01 (D ! &T!!II30DVUYNI[TVS/0 5IRXZ^Q_`dd*"(/F!G %! & & &s A;B::CcZ||d|id}d|d}|j||j|S)aR Adds temporary attachment to customer request using attach_temporary_file function :param issue_id_or_key: str :param temp_attachment_ids: List[str], ID from result attach_temporary_file function :param public: bool (default is True) :param comment: str (default is None) :return: rb)temporaryAttachmentIdsrirdr)z /attachmentr rY)rr*rrirfr!rFs rrzServiceDesk.add_attachments(sE':"('!2  -_,=[Iyyd&?&?dyKKrcXtjd|j||g||S)aK Adds temporary attachment to customer request using attach_temporary_file function :param issue_id_or_key: str :param temp_attachment_id: str, ID from result attach_temporary_file function :param public: bool (default is True) :param comment: str (default is None) :return: zAdding attachmentr)r#r$r)rr*rrirfs radd_attachmentzServiceDesk.add_attachment:s8 $%##    $  rcd|d}i}|t||d<|t||d<|j|||j}|jr|S|xsijdS)aT Get the SLA information for a customer request for a given request ID or key A request can have zero or more SLA values IMPORTANT: The calling user must be an agent :param issue_id_or_key: str :param start: OPTIONAL: int :param limit: OPTIONAL: int :return: SLA information r)z/slarMrNrOrrQrSs rget_slazServiceDesk.get_slaLs{-_,=TB  !%jF7O  !%jF7O88C8Q8Q8R   OB##H--rcLd|d|}|j||jS)z Get customer request SLA information for given request ID or key and SLA metric ID IMPORTANT: The calling user must be an agent :param issue_id_or_key: str :param sla_id: str :return: SLA information r)z/sla/r r )rr*sla_idrFs r get_sla_by_idzServiceDesk.get_sla_by_idcs0-_,=U6(KxxT%>%>x??rc4|g}d}|j||S)z Fix corrupted or missing sla https://confluence.atlassian.com/jirakb/missing-or-corrupted-sla-data-in-jira-service-management-828790603.html :param tickets: list of tickets like [XXX-123, XXX-124] :return: zErest/servicedesk/1/servicedesk/sla/admin/task/destructive/reconstruct)r!)r%)rticketsrFs r sla_rebuildzServiceDesk.sla_rebuildps& ?GUyy7y++rcd|d}i}|t||d<|t||d<|j||j|}|jr|S|xsijdS)z Get all approvals on a request, for a given request ID/Key :param issue_id_or_key: str :param start: OPTIONAL: int :param limit: OPTIONAL: int :return: r)z /approvalrMrNrwrrQrSs r get_approvalszServiceDesk.get_approvals~s{-_,=YG  !%jF7O  !%jF7O88C)B)B68R   OB##H--rcLd|d|}|j||jS)z Get an approval for a given approval ID :param issue_id_or_key: str :param approval_id: str :return: r) /approval/r r )rr* approval_idrFs rget_approval_by_idzServiceDesk.get_approval_by_ids0-_,=Z }UxxT%>%>x??rcVd|d|}d|i}|j||j|S)z Answer a pending approval :param issue_id_or_key: str :param approval_id: str :param decision: str :return: r)rdecisionr rY)rr*rrrFr!s ranswer_approvalzServiceDesk.answer_approvals<-_,=Z }UH%yyd&?&?dyKKrcFd|}|j||jS)za Get queue settings on project :param project_key: str :return: zrest/servicedeskapi/queues/r r )r project_keyrFs rget_queue_settingszServiceDesk.get_queue_settingss),K=9xxT%>%>x??rcd|d}i}|t||d<|t||d<|||d<|j||j|S)a Returns a list of the customers on a service desk. The returned list of customers can be filtered using the query parameter. The parameter is matched against customers' displayName, name, or email. For example, searching for "John", "Jo", "Smi", or "Smith" will match a user with display name "John Smith".. :param query: :param start: :param limit: :param service_desk_id: str :return: the customers added to the service desk r /customerrMrNqueryrwrx)rrrrMrNrFrPs r get_customerszServiceDesk.get_customerssh10AK  !%jF7O  !%jF7O  #F7OxxT%>%>vxNNrc~d|d}||d}tjd|j||j|S)a Adds one or more existing customers to the given service desk. If you need to create a customer, see Create customer method. Administer project permission is required, or agents if public signups and invites are enabled for the Service Desk project. :param service_desk_id: str :param list_of_usernames: list :param list_of_accountids: list :return: the customers added to the service desk rrrzAdding customers...r r"rrlist_of_usernameslist_of_accountidsrFr!s r add_customerszServiceDesk.add_customerssJ10AK*,  &'yyd&?&?dyKKrc~d|d}||d}tjd|j||j|S)a Removes one or more customers from a service desk. The service desk must have closed access. If any of the passed customers are not associated with the service desk, no changes will be made for those customers and the resource returns a 204 success code. :param service_desk_id: str :param list_of_usernames: list :param list_of_accountids: list :return: the customers added to the service desk rrrzRemoving customers...r rrs rremove_customerszServiceDesk.remove_customerssJ10AK*,  (){{3(A(A{MMrcd|d}i}|t||d<|t||d<|t||d<|j||j|S)a Returns a page of queues defined inside a service desk, for a given service desk ID. The returned queues will include issue counts for each queue (issueCount field) if the query param includeCount is set to true (default=false). Permissions: The calling user must be an agent of the given service desk. :param service_desk_id: str :param include_count: bool :param start: int :param limit: int :return: a page of queues rz/queue includeCountrMrNrw)rorRr r )rr include_countrMrNrFrPs r get_queueszServiceDesk.get_queuessn10AH  $%)-%8F> "  !%jF7O  !%jF7OxxT%>%>vxNNrcd|d|d}i}|t||d<|t||d<|j||j|S)a{ Returns a page of issues inside a queue for a given queue ID. Only fields that the queue is configured to show are returned. For example, if a queue is configured to show only Description and Due Date, then only those two fields are returned for each issue in the queue. Permissions: The calling user must have permission to view the requested queue, i.e. they must be an agent of the service desk that the queue belongs to. :param service_desk_id: str :param queue_id: str :param start: int :param limit: int :return: a page of issues rz/queue/z/issuerMrNrwrx)rrqueue_idrMrNrFrPs rget_issues_in_queuezServiceDesk.get_issues_in_queues` 10A RXY  !%jF7O  !%jF7OxxT%>%>vxNNrcBd}|j||jdS)zR Provide plugins info :return a json of installed plugins rest/plugins/1.0/Tr trailingr no_check_headersrrFs rget_plugins_infozServiceDesk.get_plugins_info1s$ "xxT%:%:TxJJrcJd|d}|j||jdS)zQ Provide plugin info :return a json of installed plugins r-keyTrrr plugin_keyrFs rget_plugin_infozServiceDesk.get_plugin_info9s- "*T2xxT%:%:TxJJrcJd|d}|j||jdS)z[ Provide plugin license info :return a json specific License query rz -key/licenseTrrrs rget_plugin_license_infoz#ServiceDesk.get_plugin_license_infoAs- "*\:xxT%:%:TxJJrcdt|di}|jdd|jdjd}d|}|j |||j S) z Provide plugin path for upload into Jira e.g. useful for auto deploy :param plugin_path: :return: pluginrGETrT)methodrkr rz upm-tokenzrest/plugins/1.0/?token=)rr )rrBrr r%)r plugin_pathr upm_tokenrFs r upload_pluginzServiceDesk.upload_pluginIsq 4 T23LL$)) ! '+  ) 4yyE43H3HyIIrc0d|d}|j|S)zK Delete plugin :param plugin_key: :return: rr)r_rs r delete_pluginzServiceDesk.delete_pluginYs! "*T2{{3rcBd}|jd||jS)Nzrest/plugins/latest/safe-moder)rrkr )rBsafe_mode_headersrs rcheck_plugin_manager_statusz'ServiceDesk.check_plugin_manager_statusbs"-||5sD j\2k*xx$ x<MMOn-  H== - , ! ))++ ,sA77 B/%B**B/)NN)r2)N)T)rr TT)Nrr )TN)Frr )9__name__ __module__ __qualname____doc__rrrr'r+r/r?rCrGrJrTr]r`rgrlrprsr{get_organizationsrrrrrrrrrrrrrrrrrrrrrrrrrrrrrrrrrrrrrr sw W <    . ! &EP$ @  .*L&N(L" Q.6  Z:* @O$ L L N CEGUWL"JLZ\N. [N  >&BL$ $.. @ ,.* @ L @O4@BVXL,CEY[N*O4O4KKKJ  T =L6>rr) loggingrequestsr rest_clientr getLoggerr r#rrrrrs/)g!V>"V>r