dai[.ddlZddlZddlZddlZddlZddlZddlZddlmZddl Z ddl m Z ddl m Z ddl m Z ddlmZddlmZmZmZmZmZmZmZmZddlmZddlZej8d k\rdd lmZndd lmZej>e Z!Gd d eZ"y) N)cast) BeautifulSoup) deprecated) HTTPError)utils)ApiConflictErrorApiErrorApiNotAcceptableApiNotFoundErrorApiPermissionError ApiValueError JsonRPCErrorJsonRPCRestrictionsError)AtlassianRestAPI))Literalc eZdZdddddddddZfd Zed Z dd Zdd Zd Z ddZ ddZ ddZ dZ ddZdZdZdZddZddZddZdZdZddZ ddZddZddZ ddZ dd Z dd!Zdd"Zdd#Zdd$Z dd%Z!e"d&d'(d)Z#d*Z$d+Z%d,Z&d-e'd.e(d/fd0Z)d1e'd.e(d/fd2Z*d1e'd-e'd.e(d/fd3Z+d1e'd-e'fd4Z,d5Z-d6Z.d7Z/dd8Z0 dd9Z1 dd:Z2 dd;Z3e"dZ4d?Z5e"ddKZ? ddLZ@ ddMZAddNZBddOZCdPZDdQZEddRZF ddSZGdTZHd-e'dUe'fdVZIdWZJdXZKdYZLdZZMd[ZNd\ZOd]ZPd^ZQdd_ZR dd`ZS ddaZT ddbZU ddcZV dddZW ddeZXdfZYdgZZdhZ[diZ\djZ]dkZ^dlZ_dmZ`dnZaddoZbddpZcdqZddrZeddsZfddtZgdduZh ddvZidwZjdxZkdyZlddzZmdd{Zndd|Zodd}Zp dd~ZqdZrdZsde'de'de'fdZtdZudZvdZwdZxdZydZzdZ{dZ|dZ}dZ~dZdZdZdZdZdZdZdZddZddZdZ ddZ ddZdZdZ ddZddZddZdZdZdZdZdZdZdZdZdZddZdZddZddZdZddZddZdZddZddZdZdZdZdZdZdZdZdZdZdZdZdZdZdZd„ZdÄZdĄZdńZdƄZdDŽZdȄZdɄZxZS) Confluencez image/gifz image/pngz image/jpegzapplication/pdfzapplication/mswordzapplication/vnd.ms-excelz image/svg+xml)z.gifz.pngz.jpgz.jpegz.pdfz.docz.xlsz.svgcd|vsd|vr#d|vrtj|d}d|vrd|d<tt||g|i|y)Nz atlassian.netzjira.com/wikicloudT)r url_joinersuperr__init__)selfurlargskwargs __class__s U/var/www/timesheet/venv/lib/python3.12/site-packages/atlassian/confluence/__init__.pyrzConfluence.__init__2sU s "jC&7gS>P"--c7;Cf$"&w j$(>t>v>c.|dvr td|||diS)N)atlas_doc_formateditor export_viewviewstoragewikizCWrong value for representation, it should be either wiki or storagevaluerepresentation) ValueError)bodyr,s r! _create_bodyzConfluence._create_body9s- "  bc c$. QRRr"c#K|i} |j||||||}d|vry|jdgD]}||jdijd}| yd}i}d}cw)a> Used to get the paged data :param url: string: The url to retrieve :param params: dict (default is None): The parameter's :param data: dict (default is None): The data :param flags: string[] (default is None): The flags :param trailing: bool (default is None): If True, a trailing slash is added to the url :param absolute: bool (default is False): If True, the url is used absolute and not relative to the root :return: A generator object for the data elements N)trailingparamsdataflagsabsoluteresults_linksnextFget) rrr2r3r4r1r5responser+s r! _get_pagedzConfluence._get_pagedGs, >Fxx!!  H(!i4    ,,x,008C{  HFH5sA)A+c(d}i}|t||d<|t||d<|t||d< |j||}|jd ry y #t$r,}|jjdk(r t d| d}~wwxYw) z Check if title exists as page. :param space: Space key :param title: Title of the page :param type: type of the page, 'page' or 'blogpost'. Defaults to 'page' :return: rest/api/contentNspaceKeytitletyper2=The calling user does not have permission to view the contentreasonr6TF)strr:rr; status_coder )rspacer@rArr2r;es r! page_existszConfluence.page_exists~s!  !$UF:   !%jF7O   YF6N xxFx3H << " zz%%,(S  sA B%'B  Bcd}||d||d}|j||ddid}|jdk7r%td |jd |jy ) za Notify members (currently only groups implemented) about something on that page zrest/share-page/latest/sharepage)contextualPageIdentityId entityTypegroupsnote contentTypezapplication/json; charset=utf-8T)jsonheaders advanced_modezfailed sharing content z: N)postrH Exceptiontext)rpage_idgroupmessagerr2rs r!share_with_otherszConfluence.share_with_otherssp- '    IIc@a0brvI w ==C 5amm_BqvvhOP P r"ci}|t||d<|t||d<|||d<d|d|}tj| |js|||j ||S|j ||}|jr|S|j dS#t $r,} | jjd k(r td | d} ~ wwxYw) a Provide content by type (page, blog, comment) :param page_id: A string containing the id of the type content container. :param type: :param start: OPTIONAL: The start point of the collection to return. Default: None (0). :param limit: OPTIONAL: how many items should be returned after the start index. Default: Site limit 200. :param expand: OPTIONAL: expand e.g. history :return: Nstartlimitexpandrest/api/content/z/child/rBr6rCgThere is no content with the given id, or the calling user does not have permission to view the contentrE) intloginforVr<r:rr;rHr ) rr[rArarbrcr2rr;rJs r!get_page_child_by_typez!Confluence.get_page_child_by_types  !%jF7O  !%jF7O  %F8 !''$8   %%%-EMs6::88C87%%#O||I.. zz%%,W  s$"B+ B B C&'C  Cc\|j||||}|Dcgc]}|d }}|Scc}w)av Find a list of Child title :param page_id: A string containing the id of the type content container. :param type: :param start: OPTIONAL: The start point of the collection to return. Default: None (0). :param limit: OPTIONAL: how many items should be returned after the start index. Default: Site limit 200. :return: r@ri)rr[rArarb child_pagechildchild_title_lists r!get_child_title_listzConfluence.get_child_title_lists>00$uM 8BCuE'NCCD )c\|j||||}|Dcgc]}|d }}|Scc}w)as Find a list of Child id :param page_id: A string containing the id of the type content container. :param type: :param start: OPTIONAL: The start point of the collection to return. Default: None (0). :param limit: OPTIONAL: how many items should be returned after the start index. Default: Site limit 200. :return: idrk)rr[rArarbrlrm child_id_lists r!get_child_id_listzConfluence.get_child_id_lists<00$uM 2<=t= =>rpc(|j|dS)zc Get child pages for the provided page_id :param page_id: :return: rM)r[rArkrr[s r!get_child_pageszConfluence.get_child_pagess **7*HHr"cP|j|||xsijdS)z Provide content id from search result by title and space. :param space: SPACE key :param title: title :param type: type of content: Page or Blogpost. Defaults to page :return: )rArr)get_page_by_titler:)rrIr@rAs r! get_page_idzConfluence.get_page_ids,&&ue$&?E2JJ4PPr"cd} |j|djdxsidjdxsd}|S#t$r }tj |Yd}~|Sd}~wwxYw)zd Provide parent content id from page id :type page_id: str :return: N ancestorsr[rcrrget_page_by_idr:rYrgerror)rr[parent_content_idrJs r!get_parent_content_idz Confluence.get_parent_content_ids ! !%!4!4W[!4!Y!]!]^i!j!pnp!c$i!   !   IIaLL   rANrarbrcr?r@rBrCrDrEr6rz Can't find 'z ' page on )rfrGrVr:rr;rHr IndexError TypeErrorrgrrdebug) rrIr@rarbrcrArr2r;rJs r!ryzConfluence.get_page_by_title:s8!$  !%jF7O  !%jF7O  %F8   !$UF:   !%jF7O   88C8/ / xxFx3H << *1- - zz%%,(S  I&  II UG:dhhZ@ A IIaL s0.BC C 'CC D!:DD!ci}|r||d<|r||d<|r||d<d|} |j||}|S#t$r,}|jjdk(r t d|d }~wwxYw) a Returns a piece of Content. Example request URI(s): http://example.com/confluence/rest/api/content/1234?expand=space,body.view,version,container http://example.com/confluence/rest/api/content/1234?status=any :param page_id: Content ID :param status: (str) list of Content statuses to filter results on. Default value: [current] :param version: (int) :param expand: OPTIONAL: Default value: history,space,version We can also specify some extensions such as extensions.inlineProperties (for getting inline comment-specific properties) or extensions. Resolution for the resolution status of each comment in the results :return: rcstatusversionrdrBrCrerENr:rr;rHr ) rr[rcrrr2rr;rJs r!rzConfluence.get_page_by_idhs %F8  %F8   'F9 !'+ xxFx3H zz%%,W  s3 A('A##A(c  |j|dddd}|rt|ddDcgc]A}|d Dcgc]+}|d |d zDcgc]}|jc}-c}}C}}}}t|d kDr"t j |t||d Sd|iSdhScc}wcc}}wcc}}}w#t $rF}|jjdk(r#tjd|td|Yd}~yd}~wt$r }tjd|Yd}~yd}~wwxYw)a Fetches html tables added to confluence page :param page_id: integer confluence page_id :return: json object with page_id, number_of_tables_in_page and list of list tables_content representing scraped tables body.storagerr.r(r+lxml)featurestabletrthtdr)r[number_of_tables_in_pagetables_contentzNo tables found for page: zPage content is emptyrCz#Couldn't retrieve tables from pagezThere is no content with the given pageid, pageid params is not an integer or the calling user does not have permission to view the pagerENz Error occured) rrrZlenrTdumpsrr;rHrgrr rY)rr[ page_contentrrowcell tables_rawrJs r!get_tables_from_pagezConfluence.get_tables_from_pagesV *..w~.NvVW`abijL"N|f!Mg!VOTTXkZsCID ,ABDdiiBZ z?Q&::'.8;J.85g000!CZ$ zz%%, ?IT- * IIoq ) ) *sd5C CB=B82B=7C=3C 1C 5C 8B==CC E&T- s(A.A)A.)A.. B=7r?rarbrrcrArBrCrDrENr:rr;rHr ) rrIrarbrrc content_typerr2r;rJs r!get_all_pages_from_space_rawz'Confluence.get_all_pages_from_space_rawSs2! !&F:  #F7O #F7O %F8  %F8  )F6N xxFx3H zz%%,(S  sA A:'A55A:cg} |j||||||}|jdg} |j| t| |kr |S||z }Q)a Retrieve all pages from a Confluence space. :param space: The space key to fetch pages from. :param start: OPTIONAL: The starting point of the collection. Default: 0. :param limit: OPTIONAL: The maximum number of pages per request. Default: 50. :param status: OPTIONAL: Filter pages by status ('current', 'trashed', 'any'). Default: None. :param expand: OPTIONAL: Comma-separated list of properties to expand. Default: history,space,version. :param content_type: OPTIONAL: The content type to return ('page', 'blogpost'). Default: page. :return: List containing all pages from the specified space. rIrarbrrcrr6)rr:rr) rrIrarbrrcr all_pagesr;r6s r!get_all_pages_from_spacez#Confluence.get_all_pages_from_spaces|( 88) 9Hll9b1G   W %7|u$ UNE)r"c#K |j||||||}|jdg}|Ed{t||kr y||z }I7w)a Retrieve all pages from a Confluence space using pagination. :param space: The space key to fetch pages from. :param start: OPTIONAL: The starting point of the collection. Default: 0. :param limit: OPTIONAL: The maximum number of pages per request. Default: 50. :param status: OPTIONAL: Filter pages by status ('current', 'trashed', 'any'). Default: None. :param expand: OPTIONAL: Comma-separated list of properties to expand. Default: history,space,version. :param content_type: OPTIONAL: The content type to return ('page', 'blogpost'). Default: page. :return: Generator yielding pages one by one. rr6N)rr:r) rrIrarbrrcrr;r6s r!%get_all_pages_from_space_as_generatorz0Confluence.get_all_pages_from_space_as_generatorsv(88) 9Hll9b1G  7|e#  UNE% s0AA Ac.|j|||||S)a Get list of pages from trash :param space: :param start: OPTIONAL: The start point of the collection to return. Default: None (0). :param limit: OPTIONAL: The limit of the number of pages to return, this may be restricted by fixed system limits. Default: 500 :param status: :param content_type: the content type to return. Default value: page. Valid values: page, blogpost. :return: )rr)rrIrarbrrs r!get_all_pages_from_space_trashz)Confluence.get_all_pages_from_space_trashs!,,UE5&Wc,ddr"c*|j||||S)a Get list of draft pages from space Use case is cleanup old drafts from Confluence :param space: :param start: OPTIONAL: The start point of the collection to return. Default: None (0). :param limit: OPTIONAL: The limit of the number of pages to return, this may be restricted by fixed system limits. Default: 500 :param status: :return: r)rrIrarbrs r!get_all_draft_pages_from_spacez)Confluence.get_all_draft_pages_from_spaces,,UE5&IIr"cd|d|}i}|r||d<|r||d< |j||}|jd S#t$r,}|jjdk(r t d|d }~wwxYw) a Search list of draft pages by space key Use case is cleanup old drafts from Confluence :param space: Space Key :param status: Can be changed :param start: OPTIONAL: The start point of the collection to return. Default: None (0). :param limit: OPTIONAL: The limit of the number of pages to return, this may be restricted by fixed system limits. Default: 500 :return: z$rest/api/content?cql=space=spaceKey=z and status=rbrarBrCrDrENr6r) rrIrarbrrr2r;rJs r!*get_all_draft_pages_from_space_through_cqlz5Confluence.get_all_draft_pages_from_space_through_cqls5UG<xP #F7O #F7O xxFx3H||I&& zz%%,(S  s> A3'A..A3cd}i}|rdj||d<|r||d<|r||d<|r||d<|r||d<|r||d<g} |j|| } | jd } | | z} | jd } | d | vr| d d jd}i}n | S^#t$rR} | jj dk(r t d| | jj dk(r td d } ~ wwxYw)a Get all pages from a set of space ids: https://developer.atlassian.com/cloud/confluence/rest/v2/api-group-page/#api-pages-get :param space_ids: A Set of space IDs passed as a filter to Confluence :param batch_size: OPTIONAL: The batch size of pages to retrieve from confluence per request MAX is 250. Default: 250 :param sort: OPTIONAL: The order the pages are retrieved in. Valid values: id, -id, created-date, -created-date, modified-date, -modified-date, title, -title :param status: OPTIONAL: Filter pages based on their status. Valid values: current, archived, deleted, trashed Default: current,archived :param title: OPTIONAL: Filter pages based on their title. :param body_format: OPTIONAL: The format of the body in the response. Valid values: storage, atlas_doc_format :return: z /api/v2/pages,zspace-idrbsortrr@z body-formatrBr6r7Nr8z/wiki/rzThe configured params cannot be interpreted by ConfluenceCheck the api documentation for valid values for status, expand, and sort paramsrEUnauthorized (401)r;)joinr: removeprefixrr;rHr )r space_ids batch_sizerrr@ body_formatpathr2 _all_pagesr;pageslinksrJs r!+get_all_pages_by_space_ids_confluence_cloudz6Confluence.get_all_pages_by_space_ids_confluence_cloudsA2 !$)!4F:  (F7O !F6N %F8  #F7O $/F= !  88D88 Y/'%/  X.$5#H-f5BB8LDF/ zz%%,#g zz%%, 4xHH  s AB B C;)A C66C;z2.4.2z&Use get_all_restrictions_for_content())rrFc&|j|S)z0Let's use the get_all_restrictions_for_content())r) get_all_restrictions_for_contentrrs r!get_all_restictions_for_contentz*Confluence.get_all_restictions_for_contentYs44 4KKr"c0d|d}|j|S)z Returns info about all restrictions by operation. :param content_id: :return: Return the raw json response rdz/restriction/byOperationr9)rrrs r!rz+Confluence.get_all_restrictions_for_content^s! "*-EFxx}r"c|jdk(s |jriSd}ddd|gd}|j||jdxsiS) A The JSON-RPC APIs for Confluence are provided here to help you browse and discover APIs you have access to. JSON-RPC APIs operate differently than REST APIs. To learn more about how to use these APIs, please refer to the Confluence JSON-RPC documentation on Atlassian Developers. r!rpc/json-rpc/confluenceservice-v22.0getContentPermissionSets jsonrpcmethodrrr2r3result api_versionrrXr:)rr[rr3s r!'get_all_restrictions_from_page_json_rpcz2Confluence.get_all_restrictions_from_page_json_rpcgsX   w &$**I1 ,Fa\c[deyy4y(,,X6<" B BCW XY . {*IJZI[[\]   s0B B 8B B user_namec||dd}|S)N)rAuserName groupName)rr rcontents r!create_restricts_from_from_userz*Confluence.create_restricts_from_from_users+QUVr"c |j|jd}d}d}|j|d}|j|d}|j|d} |j|d} d||fvrp|6|D]1} t | jd| jdk(s0d }3|6|D]1} t | jd| jdk(s0d }3|dk(rT|dur9|j||} |j | |j ||| y|rtd |d |d |d|dk(r|s|j|d} |j||} |j | |j | |j |d| |j ||| td |d|d |dy|rtd |d |d |dyyyy#t$rwxYw)Nrr@Frr[rrr rr Tr[rrUser "z%" already have restrictions type of "z " on page "rz " granted restrictions type of ") rr:r rrappendrrprintr) rr r[rruser_find_view_booluser_find_edit_boolusers_content_viewusers_content_editcurrent_user_content_viewcurrent_user_content_editusercurrent_user_contents r!add_user_in_restricted_pagez&Confluence.add_user_in_restricted_pages'''8<>*59R9V9VWa9bb26/7&1 27:>>*59R9V9VWa9bb26/7$v-*e3/3/S/S&/BR0T0,+112FGBB$+,<0BC -6$YK/TUeTffqr{q||}~&/.484X4X&/&5Y51594X4X&/BR5Y51+112KL*112KLBB$+VYkCBB$+=McuC$YK/OP`Oaalmvlwwxy-6$YK/TUeTffqr{q||}~-'0 -)D^   s&3:G+.7G+&AG+,B#G+G++ G6c|j|jd}d}|j|d}|j|d}|j|d}|j|d}t |D]E\} } t | jd|jdk(s3d }|j | Gt |D]E\} } t | jd|jdk(s3d }|j | G |r;|j|d| |j|d| td |d |d y|std |d|d y#t$rwxYw)Nrr@Frrrrr Trrz." has been deleted from restrictions on page "rz+" has not founded in restrictions on page ") rr:r r enumeraterpoprrrr) rr r[ruser_find_boolrrrr user_index user_values r! remove_user_from_restricted_pagez+Confluence.remove_user_from_restricted_pages'''8< "%s"rdr properties)rAr@rrIr.metadatarArrr|N)v1v2r+r>r%T full-widthcontent-appearance-draftcontent-appearance-published fixed-widthrrCrDrE)rgrhr/rXrr;rHr )rrIr@r. parent_idrAr,r% full_widthrrr3r;rJs r! create_pagezConfluence.create_pagePsV2 +T5%@!U^%%dN;%r*   *.i!@ AD   &L"88?7HD \ *8 4  JQS_I`D \ *+E FNUWcMdD \ *+I JJQS`IaD \ *+E FNUWdMeD \ *+I J yy4y0H zz%%,(S  sB%% C.'CCcvd}||d}|r||d<|r||d<|r||d<|j|||jS)z Move page method :param space_key: :param page_id: :param target_title: :param target_id: :param position: topLevel or append , above, below :return: z/pages/movepage.action)r?pageId targetTitletargetIdpositionr2rU)rXno_check_headers)r space_keyr[ target_id target_titlerMrr2s r! move_pagezConfluence.move_pagesU"''7; $0F= ! !*F:  !)F: yyVT5J5JyKKr"c|||d}|r||d<|r||d<|rd|i|d<|r+||d<|jdtj|S|jd| S) aS Creates a new or updates an existing content template. Note, blueprint templates cannot be created or updated via the REST API. If you provide a ``template_id`` then this method will update the template with the provided settings. If no ``template_id`` is provided, then this method assumes you are creating a new template. :param str name: If creating, the name of the new template. If updating, the name to change the template name to. Set to the current name if this field is not being updated. :param dict body: This object is used when creating or updating content. { "storage": { "value": "", "representation": "view" } } :param str template_type: OPTIONAL: The type of the new template. Default: "page". :param str template_id: OPTIONAL: The ID of the template being updated. REQUIRED if updating a template. :param str description: OPTIONAL: A description of the new template. Max length 255. :param list labels: OPTIONAL: Labels for the new template. An array like: [ { "prefix": "", "name": "", "id": "", "label": "", } ] :param dict space: OPTIONAL: The key for the space of the new template. Only applies to space templates. If not specified, the template will be created as a global template. :return: )name templateTyper. descriptionlabelsrrI templateIdzrest/api/templaterrT)putrTrrX) rrUr. template_type template_idrWrXrIr3s r!create_or_update_templatez$Confluence.create_or_update_templatesxVmTJ "-D  #DN "ENDM !,D 88/djj6F8G Gyy,4y88r"z3.7.0zUse get_content_template()cd|} |j|}|S#t$r,}|jjdk(r t d|d}~wwxYw)z{ Get user template by id. Experimental API Use case is get template body and create page from that zrest/experimental/template/rerENrrr]rr;rJs r!get_template_by_idzConfluence.get_template_by_idsh ,K=9 xx}H zz%%,W   A'A  Acd|} |j|}|S#t$r,}|jjdk(r t d|d}~wwxYw)a. Get a content template. This includes information about the template, like the name, the space or blueprint that the template is in, the body of the template, and more. :param str template_id: The ID of the content template to be returned :return: rest/api/template/r`rerENrras r!get_content_templatezConfluence.get_content_templatesh#;-0 xx}H zz%%,W  rczUse get_blueprint_templates()cd}i}|r||d<|r||d<|r||d<|r||d< |j||}|jd xsgS#t$r,}|jjdk(r t d| d }~wwxYw) a Get all users blueprints from space. Experimental API :param space: Space Key :param start: OPTIONAL: The start point of the collection to return. Default: None (0). :param limit: OPTIONAL: The limit of the number of pages to return, this may be restricted by fixed system limits. Default: 20 :param expand: OPTIONAL: expand e.g. body z$rest/experimental/template/blueprintr?rarbrcrBr`rDrENr6r rrIrarbrcrr2r;rJs r!get_all_blueprints_from_spacez(Confluence.get_all_blueprints_from_spaces5 !&F:  #F7O #F7O %F8  xxFx3H||I&,", zz%%,(S  A A?'A::A?cd}i}|r||d<|r||d<|r||d<|r||d< |j||}|jd xsgS#t$r,}|jjdk(r t d| d }~wwxYw) a Gets all templates provided by blueprints. Use this method to retrieve all global blueprint templates or all blueprint templates in a space. :param space: OPTIONAL: The key of the space to be queried for templates. If ``space`` is not specified, global blueprint templates will be returned. :param start: OPTIONAL: The starting index of the returned templates. Default: None (0). :param limit: OPTIONAL: The limit of the number of pages to return, this may be restricted by fixed system limits. Default: 25 :param expand: OPTIONAL: A multi-value parameter indicating which properties of the template to expand. zrest/api/template/blueprintr?rarbrcrBr`rDrENr6rrhs r!get_blueprint_templatesz"Confluence.get_blueprint_templates4s, !&F:  #F7O #F7O %F8  xxFx3H||I&,", zz%%,(S  rjzUse get_content_templates()cd}i}|r||d<|r||d<|r||d<|r||d< |j||}|jd xsgS#t$r,}|jjdk(r t d| d }~wwxYw) a3 Get all users templates from space. Experimental API ref: https://docs.atlassian.com/atlassian-confluence/1000.73.0/com/atlassian/confluence/plugins/restapi /resources/TemplateResource.html :param space: Space Key :param start: OPTIONAL: The start point of the collection to return. Default: None (0). :param limit: OPTIONAL: The limit of the number of pages to return, this may be restricted by fixed system limits. Default: 20 :param expand: OPTIONAL: expand e.g. body zrest/experimental/template/pager?rarbrcrBr`rDrENr6rrhs r!get_all_templates_from_spacez'Confluence.get_all_templates_from_spaceXs0 !&F:  #F7O #F7O %F8  xxFx3H||I&,", zz%%,(S   rjcd}i}|r||d<|r||d<|r||d<|r||d< |j||}|jd xsgS#t$r,}|jjdk(r t d| d }~wwxYw) a Get all content templates. Use this method to retrieve all global content templates or all content templates in a space. :param space: OPTIONAL: The key of the space to be queried for templates. If ``space`` is not specified, global templates will be returned. :param start: OPTIONAL: The start point of the collection to return. Default: None (0). :param limit: OPTIONAL: The limit of the number of pages to return, this may be restricted by fixed system limits. Default: 25 :param expand: OPTIONAL: A multi-value parameter indicating which properties of the template to expand. e.g. ``body`` zrest/api/template/pager?rarbrcrBr`rDrENr6rrhs r!get_content_templatesz Confluence.get_content_templates{s' !&F:  #F7O #F7O %F8  xxFx3H||I&,", zz%%,(S  rjc*|jd|S)a Deletes a template. This results in different actions depending on the type of template: * If the template is a content template, it is deleted. * If the template is a modified space-level blueprint template, it reverts to the template inherited from the global-level blueprint template. * If the template is a modified global-level blueprint template, it reverts to the default global-level blueprint template. Note: Unmodified blueprint templates cannot be deleted. :param str template_id: The ID of the template to be deleted. :return: rer6)rr]s r!remove_templatezConfluence.remove_templates{{/ }=>>r"cvd}i}|r||d<|r||d<|r||d<|r||d<|r||d<|j||S)a` Get all spaces with provided limit :param start: OPTIONAL: The start point of the collection to return. Default: None (0). :param limit: OPTIONAL: The limit of the number of pages to return, this may be restricted by fixed system limits. Default: 500 :param space_type: OPTIONAL: Filter the list of spaces returned by type (global, personal) :param space_status: OPTIONAL: Filter the list of spaces returned by status (current, archived) :param expand: OPTIONAL: additional info, e.g. metadata, icon, description, homepage rest/api/spacerarbrcrArrBr9)rrarbrc space_type space_statusrr2s r!get_all_spaceszConfluence.get_all_spacess_" #F7O #F7O %F8  'F6N +F8 xxFx++r"c0d|d}|j|S)zJ Archive space :param space_key: :return: rest/api/space/z/archiver[rrPrs r! archive_spacezConfluence.archive_spaces  {(3xx}r"cXd|d}d|i}|r||d<|r||d<|j||S)z Get trashed contents by space :param space_key: :param cursor: :param expand: :param limit: :return: rz/content/trashrbcursorrcrBr9)rrPrrcrbrr2s r!get_trashed_contents_by_spacez(Confluence.get_trashed_contents_by_spacesI {.95! %F8  %F8 xxFx++r"c0d|d}|j|S)z Remove all content from the trash in the given space, deleting them permanently.Example request URI: :param space_key: :return: rzrrrr|s r! remove_trashed_contents_by_spacez+Confluence.remove_trashed_contents_by_spaces! {.9{{3r"cd|ddd|j|dd} |jd|}|S#t$r,}|jjd k(r t d | d }~wwxYw) zR Add comment into page :param page_id :param text commentrMcurrent)rrrArr()rA containerr.rdrrCrDrEN)r/rXrr;rHr )rr[rZr3r;rJs r! add_commentzConfluence.add_comments '9M%%dI6  yy!44y@H zz%%,(S  s1 A&'A!!A&c  ||j||n|}d}|u|r|nd|d}||||dd} dd d } d |d } |j| | d |i} | jdr| dz| dddzdz} |j| | | d|||fi} | Stjdy#t$rR}|jj dk(r t d||jj dk(r t d|d}~wwxYw)a0 Attach (upload) a file to a page, if it exists it will update automatically the version the new file and keep the old one. :param title: The page name :type title: ``str`` :param space: The space name :type space: ``str`` :param page_id: The page id to which we would like to upload the file :type page_id: ``str`` :param name: The name of the attachment :type name: ``str`` :param content: Contains the content which should be uploaded :type content: ``binary`` :param content_type: Specify the HTTP content type. The default is "application/binary" :type content_type: ``str`` :param comment: A comment describing this upload/file :type comment: ``str`` N)rIr@ attachmentz Uploaded .true)rAfileNamerSr minorEditno-checkzapplication/json)X-Atlassian-TokenAcceptrd/child/attachmentfilename)rrUr2size/r6rrrz/datafile)rr3rUfilesr`zhAttachments are disabled or the calling user does not have permission to add attachments to this contentrErCzThe requested content is not found, the user does not have permission to view it, or the attachments exceeds the maximum configured attachment sizez-No 'page_id' found, not uploading attachments) rzr:rXrr;rHr rgwarning)rrrUrr[r@rIrrAr3rUr attachmentsr;rJs r!attach_contentzConfluence.attach_content sn:AH$""e"tjj|d}|jj |d}t |d5} |j| ||||||cdddS#1swYyxYw)a Attach (upload) a file to a page, if it exists it will update automatically the version the new file and keep the old one. :param title: The page name :type title: ``str`` :param space: The space name :type space: ``str`` :param page_id: The page id to which we would like to upload the file :type page_id: ``str`` :param filename: The file to upload (Specifies the content) :type filename: ``str`` :param name: Specifies name of the attachment. This parameter is optional. Is no name give the file name is used as name :type name: ``str`` :param content_type: Specify the HTTP content type. The default is The default is "application/binary" :type content_type: ``str`` :param comment: A comment describing this upload/file :type comment: ``str`` Nr~application/binaryrb)r[r@rIr)osrbasenamesplitext content_typesr:openr) rrrUrr[r@rIr extensioninfiles r! attach_filezConfluence.attach_file]s> <77##H-D  ((226I--11)=QRL (D ! V&&'   s .BBc&|s|tj} |r|j||d}|s d|dS|j|||d}|syi}|D]} | dxs| d } | d d } |jt | d } |rt j | } | || <Qtjd| r:tjdd| }tjd| d|dt|} tjj|| }tjj|| }t|d5}|j!| ddd |r|St#||dS#1swY&xYw#t$$rt'd|dt($rt)d|dt*j,$r4}t+j,d||j.|j0d}~wt2$r}t3d|d}~wwxYw)a Downloads attachments from a Confluence page. Supports downloading all files or a specific file. Files can either be saved to disk or returned as BytesIO objects for in-memory handling. :param page_id: str The ID of the Confluence page to fetch attachments from. :param path: str, optional Directory where attachments will be saved. If None, defaults to the current working directory. Ignored if `to_memory` is True. :param start: int, optional The start point for paginated attachment fetching. Default is 0. Ignored if `filename` is specified. :param limit: int, optional The maximum number of attachments to fetch per request. Default is 50. Ignored if `filename` is specified. :param filename: str, optional The name of a specific file to download. If provided, only this file will be fetched. :param to_memory: bool, optional If True, attachments are returned as a dictionary of {filename: BytesIO object}. If False, files are written to the specified directory on disk. :return: - If `to_memory` is True, returns a dictionary {filename: BytesIO object}. - If `to_memory` is False, returns a summary dict: {"attachments_downloaded": int, "path": str}. :raises: - FileNotFoundError: If the specified path does not exist. - PermissionError: If there are permission issues with the specified path. - requests.HTTPError: If the HTTP request to fetch an attachment fails. - Exception: For any unexpected errors. N)r[rr6zNo attachment with filename 'z' found on the page.)r[rarbz!No attachments found on the page.r@rrr7downloadTnot_json_responsez[<>:"/\\|?*\x00-\x1F]_z File name 'z3' contained invalid characters and was renamed to 'z'.wb)attachments_downloadedrzThe directory 'z' does not exist.z0Permission denied when trying to save files to 'z3HTTP error occurred while downloading attachments: )r;requestzAn unexpected error occurred: )rgetcwdget_attachments_from_contentr:rGioBytesIOrsearchsubwarningswarn UserWarningrrrwriterNotADirectoryErrorFileNotFoundErrorPermissionErrorrequestsrr;rrY)rr[rrarbr to_memoryrdownloaded_filesr file_name download_linkr;file_obj sanitized file_pathrhttp_errerrs r!download_attachments_from_pagez)Confluence.download_attachments_from_pagesL:T\99;D8 D"??Zb?cdmn ":8*DXYY#??W\di?jktu "> " ) - &w/C:d3C *8 4Z @ 88C $6$8O!zz(3H2:$Y/yy!99E$&FF+CS)$T  ))4ghqgrrtu'%. " T9 =I " T9 =Ii.-$ 8,--- -4''25k2BDQQ--" O#odV;L$MN N _!$TUYTZZ\"]^ ^!! $$EhZP!** ((   D 9FAH/G11 H=H  HcV||d}|r||d<|jd||jS)z Remove completely a file if version is None or delete version :param version: :param page_id: file version :param filename: :return: )rJrrzjson/removeattachment.actionrN)rXform_token_headers)rr[rrr2s r!delete_attachmentzConfluence.delete_attachments@$:  'F9 yy *++  r"c^|jr d|d|}nd|d|}|j|S)z Remove completely a file if version is None or delete version :param attachment_id: :param version: file version :return: rd /version/rest/experimental/content/rr6)r attachment_idrrs r!delete_attachment_by_idz"Confluence.delete_attachment_by_ids> ::%m_IgYGC.}oYwiPC{{3r"c |j|d|jdd}|j|jd}t||kDr||jd}|j |jd|t j d|jd t||j|jd}t||kDrt j d ||jd y ) z Keep last versions :param filename: :param page_id: :param keep_last_versions: :return: r)r[rcrr6rrrnumber)rrz>Removed oldest version for %s, now versions equal more than %sr@Kept versions %s for %sN)rr:get_attachment_historyrrrgrh)rr[rkeep_last_versionsrattachment_versions remove_version_attachment_numbers r!#remove_page_attachment_keep_versionz.Confluence.remove_page_attachment_keep_versions66wyck6lpp   #99*..:NO%&);;/BCU/V/Z/Z[c/d ,  ( ((nnT28 )  HHPw''(  #'"="=jnnT>R"S %&);; *,> w@WXr"c||d}|jrd|d}nd|d}|j||xsijdS)z Get attachment history :param attachment_id :param limit :param start :return )rbrardz/versionrrBr6rr:)rrrbrar2rs r!rz!Confluence.get_attachment_historysT!51 ::%m_H=C.}oXFCV,277 BBr"ci}|r||d<|r||d<|r||d<|r||d<|r||d<d|d} |j||} | S#t$r,} | jjd k(r t d | d } ~ wwxYw) z Get attachments for page :param page_id: :param start: :param limit: :param expand: :param filename: :param media_type: :return: rarbrcr mediaTyperdrrBrCrerENr) rr[rarbrcr media_typer2rr;rJs r!rz'Confluence.get_attachments_from_content/s& #F7O #F7O %F8  !)F:  ",F; !'*;< xxFx3H zz%%,W  sA A7 'A22A7cd|d}d|d} |j||}|S#t$r,}|jjdk(r t d|d }~wwxYw) z Set a label on the page :param page_id: content_id format :param label: label to add :return: rdrglobal)rrUrr3rCrerEN)rXrr;rHr )rr[rrr3r;rJs r!set_page_labelzConfluence.set_page_label^sy"'&1"E2 yycy5H zz%%,W  s" A'AArcd|d}||d} |j||}|S#t$rR}|jjdk(r t d||jjdk(r t d |d }~wwxYw) z Delete Confluence page label :param page_id: content_id format :param label: label name :return: rdr)rrrU)rr2r`zCThe user has view permission, but no edit permission to the contentrErCzcThe content or label doesn't exist, or the calling user doesn't have view permission to the contentN)r6rr;rHr r )rr[rrr2r;rJs r!remove_page_labelzConfluence.remove_page_labelws"'&1/ {{F{;H"! zz%%,(\zz%%,V  s" A=A A88A=cd|d} |j|}|S#t$r,}|jjdk(r t d|d}~wwxYw)Nrdz/historyrCrerErrr[rr;rJs r!historyzConfluence.historysh!'(3 xx}H zz%%,W  s A'A  Ac$|j|SN)rrs r!get_content_historyzConfluence.get_content_historys||J''r"c^|jr d|d|}nd|d|}|j|S)z Get content history by version number :param content_id: :param version_number: :return: rdrrr)rrversion_numberrs r!%get_content_history_by_version_numberz0Confluence.get_content_history_by_version_numbers? ::%j\>:JKC.zl)NCSTCxx}r"c`|jr d|d|}nd|d|}|j|y) Remove content history. It works as experimental method :param page_id: :param version_number: version number :return: rdrrNr)rr[rrs r!remove_content_historyz!Confluence.remove_content_historys= ::%gYi7GHC.wiy@PQC Cr"c(|j||y)rN)r)rr[rs r!remove_page_historyzConfluence.remove_page_historys ##G^@QRr"cLd}|j|d}t|dk(ry|jdxsijdxsijdxsi}||vrA|jd jd |jd jd zSy) ze Check has unknown attachment error on page :param page_id: :return: z9plugins/servlet/confluence/placeholder/unknown-attachmentz body.viewrrr.r'r+r7basetinyui)rrr:)rr[unknown_attachment_identifierrr.s r!has_unknown_attachment_errorz'Confluence.has_unknown_attachment_errors )d%$$W[$A v;! F#)r..v6<"AA'JPb (D 0::h'++F3fjj6J6N6Nx6XX Xr"c,|j|}|r.|jdd}||k7rtjd|y|jrL|j|dj xsijdxsijdxsi}n=|j|dxsijdxsijdxsi}|jd }|rt j|}tjd |tjd ||jj|jjk(rtjd |y tjd|y)z Compare content and check is already updated or not :param page_id: Content ID for retrieve storage value :param body: Body for compare it :param title: Title to compare :return: True if the same r@NzTitle of %s is differentFrrr.r(r+zOld Content: """%s"""zNew Content: """%s"""z!Content of %s is exactly the sameTzContent of %s differs) rr:rgrhrVrTrsymbol_normalizerrstriplower)rr[r.r@confluence_content current_titleconfluence_body_contents r!"is_page_content_is_already_updatedz-Confluence.is_page_content_is_already_updatedsr"009 .227DAM %3W=   $$W^$DIIKQrVVW]^dbdc)n"# " $(#6#6w~#6#V#\Z\"a"abh"i"omo!t!t"" #5"8"8"A "&+&=&=>U&V # )+BC )40 " ( ( * 0 0 2djjl6H6H6J J HH8' B HH,g 6r"c 4|j||||||||S)zVDuplicate update_page. Left for the people who used it before. Use update_page instead)r[r@r.rAr, minor_editversion_commentrG) update_page) rr[r@r.rAr,rrrGs r!update_existing_pagezConfluence.update_existing_pages4)!+!  r"c ddi} tjd|||| s&|$|j|||r|j|S |jr)|j |j dddz} n|j |dddz} |||| |d d iid }||j|||d <|r d |dg|d<|r||dd<| durddi|dd d<ddi|dd d<nddi|dd d<ddi|dd d< |jd||| }|S#ttf$r6} tjd||tj| Yd} ~ yd} ~ wwxYw#t$rR} | jjdk(r t!d| | jjdk(r t#d| d} ~ wwxYw) aF Update page if already exist :param page_id: :param title: :param body: :param parent_id: :param type: :param representation: OPTIONAL: either Confluence 'storage' or 'wiki' markup format :param minor_edit: Indicates whether to notify watchers about changes. If False then notifications will be sent. :param version_comment: Version comment :param always_update: Whether always to update (suppress content check) :param full_width: OPTIONAL: Default False :return: rrzUpdating %s "%s" with %sN lastUpdatedrrzCan't find '%s' %s!rrr=)rrrAr@rr>r.rMr?r|rr]Tr+rBr>rCrDrErdr3r2rNo space or no content type, or setup a wrong version type set to content, or status param is not draft and status content is currentrErC'Can not find draft with current content)rgrhrrrVrrTrrrrr/r[rr;rHr r )rr[r@r.rFrAr,rr always_updaterGr2rrJr3r;s r!rzConfluence.update_page4sA:I& +T5)D!1d6]6]^egkmr6s&&w/ / !!,,w/446}EhORSS,,w/ >xH1L") C%r*    ,,T>BDL *0 !B CD  )8DOI &  JQS_I`D \ *+E FNUWcMdD \ *+I JJQS`IaD \ *+E FNUWdMeD \ *+I J xx#G9- H$[I&  II+UD 9 IIaL @ zz%%,#0  zz%%,&'PYZ[[  s2AD!E)!E&0,E!!E&) G2A F??Gc tjd||ddi} |j|||r|j|S|j |dddz} |j|dj d xsij d j d } | j d d } | r|| zn| |z} ||||j| || |dd}|r d|dg|d<|r||dd< |jd||| }|S#t$rR}|jjdk(r td||jjdk(r td|d}~wwxYw)a Insert body to a page if already exist :param parent_id: :param page_id: :param title: :param insert_body: :param type: :param representation: OPTIONAL: either Confluence 'storage' or 'wiki' markup format :param minor_edit: Indicates whether to notify watchers about changes. If False then notifications will be sent. :param top_of_page: Option to add the content to the end of page body :return: Updating %s "%s"rrr rrrrr.r(r+zóór )rrrAr@r.rrMr?r|rr]rdr rrrErCrN)rgrhrrrr:replacer/r[rr;rHr r )rr[r@ insert_bodyrFrAr,rr top_of_pager2r previous_bodyr.r3r;rJs r!_insert_to_existing_pagez#Confluence._insert_to_existing_pages2 #T51I&  2 27K O&&w/ /ll7+M:8DqHG$$W^$DHHPVTV[[\efjjkrs *11*dCM2=;.=S^C^D))$?&-JG D.4I%F$G[!-<Y * 88'y1!$$O ::))S0'4 !  ::))S0*+T]^__ s-D E!A EE!c btjd|||j|||||||dS)a Append body to page if already exist :param parent_id: :param page_id: :param title: :param append_body: :param type: :param representation: OPTIONAL: either Confluence 'storage' or 'wiki' markup format :param minor_edit: Indicates whether to notify watchers about changes. If False then notifications will be sent. :return: rFrFrAr,rrrgrhr)rr[r@ append_bodyrFrAr,rs r! append_pagezConfluence.append_pagesE, #T51,,   )!-  r"c btjd|||j|||||||dS)a Append body to page if already exist :param parent_id: :param page_id: :param title: :param prepend_body: :param type: :param representation: OPTIONAL: either Confluence 'storage' or 'wiki' markup format :param minor_edit: Indicates whether to notify watchers about changes. If False then notifications will be sent. :return: rTrr)rr[r@ prepend_bodyrFrAr,rs r! prepend_pagezConfluence.prepend_pagesE, #T51,,   )!-  r"c |j|} |j| |rA|j| |} ||n|j| }|j || ||||||} n|j | ||||||} t jd|j| xsijdxsijd| S)a Update page or create a page if it is not exists :param parent_id: :param title: :param body: :param representation: OPTIONAL: either Confluence 'storage' or 'wiki' markup format :param minor_edit: Update page without notification :param version_comment: Version comment :param editor: OPTIONAL: v2 to be created in the new editor :param full_width: OPTIONAL: Default is False :return: )rFr[r@r.r,rrrG)rIrFr@r.r,r%rGz!You may access your page at: %s%sr7r) rrKrzrrrHrgrhrr:) rrFr@r.r,rrr%rGrIr[rs r!update_or_createzConfluence.update_or_create s.##I.   E5 )&&ue4G%.%: @Z@Z[b@cI%%#-% /%& F%%#-%&F  / HHl   ) /R 4 4X >  r"c2|dd}|jd|S)zj Convert to Confluence XHTML format from wiki style :param wiki: :return: r)r*z$rest/api/contentbody/convert/storagerrX)rr)r3s r!convert_wiki_to_storagez"Confluence.convert_wiki_to_storageQ s" 8yy?dyKKr"c2|dd}|jd|S)zn Convert from Confluence XHTML format to view format :param storage: :return: r(r*z!rest/api/contentbody/convert/viewrr$)rr(r3s r!convert_storage_to_viewz"Confluence.convert_storage_to_viewZ s" !I>yy<4yHHr"cFd|d}|} |j||}|S#t$rx}|jjdk(r t d||jjdk(r t d||jjd k(r t d |d }~wwxYw) z Set the page (content) property e.g. add hash parameters :param page_id: content_id format :param data: data should be as json data :return: rd /propertyrrThe given property has a different content id to the one in the path, or the content already has a value with the given key, or the value is missing, or the value is too longrEr`GThe user does not have permission to edit the content with the given idThe value is too longN)rXrr;rHr r )rr[r3r json_datar;rJs r!set_page_propertyzConfluence.set_page_propertyc s"')4  yyc y:H&% zz%%,#E  zz%%,(`zz%%,#$;AFF ! s B A3BB cd|d|jd} |j||}|S#t$r}|jjdk(r t d||jjdk(r t d ||jjd k(r td ||jjd k(r td ||jjdk(r t d|d}~wwxYw)z Update the page (content) property. Use json data or independent keys :param data: :param page_id: content_id format :data: property data in json format :return: rd /property/rrrr*rEr`r+rCzThere is no content with the given id, or no property with the given key, or if the calling user does not have permission to view the content.r4zWThe given version is does not match the expected target version of the updated propertyr,r-N) r:r[rr;rHr r r r)rr[r3rr;rJs r!update_page_propertyzConfluence.update_page_property s"'*TXXe_4EF xxStx4H87 zz%%,#E  zz%%,(`zz%%,&[ zz%%,&pzz%%,#$;AFF 5 s. C;B?C66C;cd|dt|} |j|}|S#t$r,}|jjdk(r t d|d}~wwxYw)z Delete the page (content) property e.g. delete key of hash :param page_id: content_id format :param page_property: key of property :return: rdr1rrCrerEN)rGr6rr;rHr )rr[ page_propertyrr;rJs r!delete_page_propertyzConfluence.delete_page_property sw"'*S5G4HI {{{,H zz%%,W  ' A'AAcd|dt|} |j|}|S#t$r,}|jjdk(r t d|d}~wwxYw)z Get the page (content) property e.g. get key of hash :param page_id: content_id format :param page_property_key: key of property :return: rdr1r4rCzThere is no content with the given id, or no property with the given key, or the calling user does not have permission to view the contentrEN)rGr:rr;rHr )rr[page_property_keyrr;rJs r!get_page_propertyzConfluence.get_page_property sy"'*S9J5K4LM xxSx)H zz%%,"   r7cd|d} |j|}|S#t$r,}|jjdk(r t d|d}~wwxYw)z} Get the page (content) properties :param page_id: content_id format :return: get properties rdr)r4rCrerENrrs r!get_page_propertieszConfluence.get_page_properties sm "')4 xxSx)H zz%%,W  s A'A  Acd|d} |j|}|jdS#t$r,}|jjdk(r t d|d}~wwxYw) z Provide the ancestors from the page (content) id :param page_id: content_id format :return: get properties rdz?expand=ancestorsr4rCrDrENr|rrs r!get_page_ancestorszConfluence.get_page_ancestors su "'*;< xxSx)H||K(( zz%%,(S  s+ A 'AA c@|j}|jd|S)z&Clean all caches from cache management%rest/cacheManagement/1.0/cacheEntriesrUrr6)rrUs r!clean_all_cacheszConfluence.clean_all_caches s!)){{BG{TTr"cJ|j}d|i}|jd||S)zClean caches from cache management e.g. com.gliffy.cache.gon org.hibernate.cache.internal.StandardQueryCache_v5 cacheNamer@r3rUrB)r cache_namerUr3s r!clean_package_cachezConfluence.clean_package_cache s0 ))Z({{BW^{__r"cd|d|} |j|}|jdS#t$r,}|jjdk(r t d|d}~wwxYw)a[ Get all groups from Confluence User management :param start: OPTIONAL: The start point of the collection to return. Default: None (0). :param limit: OPTIONAL: The limit of the number of groups to return, this may be restricted by fixed system limits. Default: 1000 :return: zrest/api/group?limit=&start=r`z8The calling user does not have permission to view groupsrENr6r)rrarbrr;rJs r!get_all_groupszConfluence.get_all_groups su&eWGE7; xx}H||I&& zz%%,(N  s, A!'AA!c6d}|dd}|j||S)zu Create a group by given group parameter :param name: str :return: New group params zrest/api/admin/groupr\)rUrArr$)rrUrr3s r! create_groupzConfluence.create_group- s&%g.yy4y((r"ctjd|d|} |j|}|S#t$r,}|jj dk(r t d|d}~wwxYw)z Delete a group by given group parameter If you delete a group and content is restricted to that group, the content will be hidden from all users :param name: str :return: zDRemoving group: %s during Confluence remove_group method executionzrest/api/admin/group/rCz`There is no group with the given name, or the calling user does not have permission to delete itrEN)rgrhr6rr;rHr )rrUrr;rJs r! remove_groupzConfluence.remove_group8 sy WY]^%dV, {{3'H zz%%,P  s0 A%'A  A%cd|d|d|d|} |j|}|jd S#t$r,}|jjdk(r t d|d}~wwxYw) a Get a paginated collection of users in the given group :param group_name :param start: OPTIONAL: The start point of the collection to return. Default: None (0). :param limit: OPTIONAL: The limit of the number of users to return, this may be restricted by fixed system limits. Default: 1000 :param expand: OPTIONAL: A comma separated list of properties to expand on the content. status :return: zrest/api/group/z/member?limit=rJz&expand=r`7The calling user does not have permission to view usersrENr6r)r group_namerarbrcrr;rJs r!get_group_memberszConfluence.get_group_membersQ s |>%whW]V^_ xx}H||I&& zz%%,(M  s2 A''A""A'cd}d}d}g}|rH|j|t|||}|dz }t|dk(rd}n|j||rH|std|d|S) z Get collection of all users in the given group :param group_name :param expand: OPTIONAL: A comma separated list of properties to expand on the content. status :return: 2Tr)rRrarbrcrFzDid not get members from z0 group, please check permissions or connectivity)rSrrr)rrRrcrbflagstepmembersvaluess r!get_all_memberszConfluence.get_all_membersj s++%'l ,F AID6{av& -j\9ij kr"cd|}|xsi}|r||d< |j||}|S#t$r,}|jjdk(r t d|d}~wwxYw)a? Get information about a space through space key :param space_key: The unique space key name :param expand: OPTIONAL: additional info from description, homepage :param params: OPTIONAL: dictionary of additional URL parameters :return: Returns the space along with its ID rzrcrBrCdThere is no space with the given key, or the calling user does not have permission to view the spacerENr)rrPrcr2rr;rJs r! get_spacezConfluence.get_space s {+2 %F8  xxFx3H zz%%,U  s) A'AAc|rd|znd}d|d|}|||d}|r||d< |j||} | S#t$r,} | jjdk(r t d | d } ~ wwxYw) ab Get space content. You can specify which type of content want to receive, or get all content types. Use expand to get specific content properties or page :param content_type: :param space_key: The unique space key name :param depth: OPTIONAL: all|root Gets all space pages or only root pages :param start: OPTIONAL: The start point of the collection to return. Default: 0. :param limit: OPTIONAL: The limit of the number of pages to return, this may be restricted by fixed system limits. Default: 500 :param expand: OPTIONAL: by default expands page body in confluence storage format. See atlassian documentation for more information. :return: Returns the space along with its ID rrrzz/content)rrarbrcrBrCr\rENr) rrPrrarbrrcrr2r;rJs r!get_space_contentzConfluence.get_space_content s21=# ,"E  {(<.A  %F8  xxFx3H zz%%,U  s6 A+'A&&A+cF|j|djdS)z Get information about a space through space key :param space_key: The unique space key name :return: Returns homepage homepager)r]r:)rrPs r!get_home_page_of_spacez!Confluence.get_home_page_of_space s" ~~i ~;?? KKr"c4||d}|jd|y)zd Create space :param space_key: :param space_name: :return: )rrUrurNr$)rrP space_namer3s r! create_spacezConfluence.create_space s!*5 " .r"cd|} |j|}|S#t$r,}|jjdk(r t d|d}~wwxYw)zI Delete space :param space_key: :return: rzrCz_There is no space with the given key, or the calling user does not have permission to delete itrEN)r6rr;rHr )rrPrr;rJs r! delete_spacezConfluence.delete_space si  {+ {{3'H zz%%,P  rccd|d}i}|r||d< |j||}|S#t$r,}|jjdk(r t d|d}~wwxYw)Nrzr)rcrBrCr\rEr)rrPrcrr2r;rJs r!get_space_propertyzConfluence.get_space_property s {)4 %F8  xxFx3H zz%%,U  s& A'AAcd}d|i}|r||d< |j||}|S#t$rR}|jjdk(r t d||jjdk(r t d |d }~wwxYw) a Get information about a user through username :param username: The username :param expand: OPTIONAL expand for get status of user. Possible param is "status". Results are "Active, Deactivated" :return: Returns the user details rest/api/userusernamercrBr`rQrErC:The user with the given username or userkey does not existNr:rr;rHr r )rrlrcrr2r;rJs r!get_user_details_by_usernamez'Confluence.get_user_details_by_username sh' %F8  xxFx3H zz%%,(Mzz%%,&P  $ A?A A::A?cd}d|i}|r||d< |j||}|S#t$rR}|jjdk(r t d||jjdk(r t d |d }~wwxYw) a  Get information about a user through accountid :param accountid: The account id :param expand: OPTIONAL expand for get status of user. Possible param is "status". Results are "Active, Deactivated" :return: Returns the user details rk accountIdrcrBr`rQrErCz.The user with the given account does not existNrn)r accountidrcrr2r;rJs r!get_user_details_by_accountidz(Confluence.get_user_details_by_accountid* sy) %F8  xxFx3H zz%%,(Mzz%%,&D  rpcd}d|i}|r||d< |j||}|S#t$rR}|jjdk(r t d||jjdk(r t d |d }~wwxYw) a Get information about a user through user key :param userkey: The user key :param expand: OPTIONAL expand for get status of user. Possible param is "status". Results are "Active, Deactivated" :return: Returns the user details rkrrcrBr`rQrErCrmNrn)ruserkeyrcrr2r;rJs r!get_user_details_by_userkeyz&Confluence.get_user_details_by_userkeyI s! %F8  xxFx3H zz%%,(Mzz%%,&P  rpci}|t||d<|t||d<|||d<|||d<|||d<|||d< |jd| }|S#t$r,} | jjd k(r t d | d} ~ wwxYw) a Get results from cql search result with all related fields Search for entities in Confluence using the Confluence Query Language (CQL) :param cql: :param start: OPTIONAL: The start point of the collection to return. Default: 0. :param limit: OPTIONAL: The limit of the number of issues to return, this may be restricted by fixed system limits. Default by built-in method: 25 :param excerpt: the excerpt strategy to apply to the result, one of : indexed, highlight, none. This defaults to highlight :param expand: OPTIONAL: the properties to expand on the search result, this may cause database requests for some properties :param include_archived_spaces: OPTIONAL: whether to include content in archived spaces in the result, this defaults to false :return: NrarbrrcincludeArchivedSpacesexcerptzrest/api/searchrBrzThe query cannot be parsedrE)rfr:rr;rHr ) rrrarbrcinclude_archived_spacesrzr2r;rJs r!rzConfluence.cqlh s0  !%jF7O  !%jF7O ?F5M  %F8  " ..EF* +   'F9  xx 1&xAH  zz%%,#$@KK   sA B 'BB c.|j}d|}|jdk(s |jrV|j|}|s"tj dt ddtj|djS|j||d S) zp Export page as standard pdf exporter :param page_id: Page ID :return: PDF File z-spaces/flyingpdf/pdfpageexport.action?pageId=rzFailed to get download PDF url.zFailed to export page as PDFrEK)timeoutTrUr) rrr)get_pdf_download_url_for_confluence_cloudrgrr rr:rrr[rUrs r!get_page_as_pdfzConfluence.get_page_as_pdf s ))=gYG   w &$**@@EC ;<&'ENopp<<R088 8xxWxEEr"cL|j}d|}|j||dS)zs Export page as standard word exporter. :param page_id: Page ID :return: Word File zexportword?pageId=Tr)rr:rs r!get_page_as_wordzConfluence.get_page_as_word s0 ))"7),xxWxEEr"rP export_typereturnc ldtffd }j|d tjd|zdz|z|dk(rt |d|d d d d }ni|dk(r|d|ddd d d }nR|dk(r|d|dd d d d }n;|dk(r+d|z}tjdj |St djjd|}jj|j|}t|jd} td|jddd ij!d!}d%} | r j!|xsi} tjd&|d'| j!d(d)| iur| j!d*rt| j!d(d}td|jd+d,d-ij!d.} j| vr| Sj| z} | j'd/d0kDr| j)d1d/} | St+j,d2| ry)#t"$r} t%d"| #d$} ~ wwxYw#t"$r} t%d3|z| #d$} ~ wwxYw#t"$r} t%d4|z| #d$} ~ wwxYw)5aB Export a Confluence space to a file of the specified type. (!) This method was developed for Confluence Cloud and may not work with Confluence on-prem. (!) This is an experimental method that does not trigger an officially supported REST endpoint. It may break if Atlassian changes the space export front-end logic. :param space_key: The key of the space to export. :param export_type: The type of export to perform. Valid values are: 'html', 'csv', 'xml', 'pdf'. :return: The URL to download the exported file. linkc j|d}t|jd}|jdddijd}|S#t$r}t d| d}~wwxYw) NT)rV html.parserinputrU atl_tokenr+zAProblems with getting the atl_token for get_space_export method :rE)r:rrZfindrYr )rr; parsed_htmlrrJrs r!get_atl_requestz4Confluence.get_space_export..get_atl_request su n88D8=+HMM=I ',,Wv{6KLPPQXY    nbklmm nsA A A, A''A, permissionsrPrcz@Initiated experimental get_space_export method for export type: z from Confluence space: csvz!spaces/exportspacecsv.action?key=TYPE_CSVallrExport)r exportType contentOptionincludeCommentsconfirmhtmlz"spaces/exportspacehtml.action?key= TYPE_HTML visibleOnlyxmlz!spaces/exportspacexml.action?key=TYPE_XMLpdfz(spaces/flyingpdf/doflyingpdf.action?key=zInitiated PDF space exportzIInvalid export_type parameter value. Valid values are: 'html/csv/xml/pdf'z spaces/doexportspace.action?key=)rr)rUr3rrGmetarUz ajs-pollURIrz@Problems with getting the poll_url for get_space_export method :rENTzSpace z export status: r]Nonecompleteaclasszspace-export-download-pathhrefrrz /wiki/wikiz>Encountered error during space export status check from space z1Encountered error during space export from space )rGr]rgrhrrr-rrsessionrXrrrZrrr:rYr countrtimesleep)rrPrr form_datarr;rpoll_urlrJ running_taskprogress_response download_url combined_urls` r!get_space_exportzConfluence.get_space_export s# n# n =AG f HHR,-  e# -0QR[Q\.]^)"'$*$  &!03UV_U`1a!b"-%2'-'  %!03TU^T_1`!a",%*'-'  %@9L67EEcJJ !lmm//dhh7WXaWb5c/dC||((d6M6MT](^H' }EK m{'7'7@W'X'\'\]f'gh L(,(:(@b%HHvi[0@ARAVAVW`bhAi@jkl(27H7L7LZ7X&34E4I4I)4TVc&d '+E;3C3CC'SoIp3q3u3uv|3}'~ 88|3#//+/88l+BL+11':Q>/;/C/CLRY/Z #//JJrN*1 majkll m&!"X[ddmn  fNQZZcde e fstBJ=A)J'-IJB,I46I4=I4J I1 I,,I11J4 J=J  JJ J3J..J3c$|j|S)zo Alias method for export page as pdf :param page_id: Page ID :return: PDF File )rrvs r! export_pagezConfluence.export_page s ##G,,r"c0d}d|d|d} |j|i}|jd gD]*}|jd |k(s|jd }|S|S#t$r,}|jjdk(r t d|d}~wwxYw) a  Provide space, parent_id and title of the descendant page, it will return the descendant page_id :param space: str :param parent_id: int :param title: str :return: page_id of the page whose title is passed in argument rz#rest/api/content/search?cql=parent=z%20AND%20space="rrrrENr6r@rrr) rrIrFr@r[rr;rJ each_pages r!get_descendant_page_idz!Confluence.get_descendant_page_id s3I;>NugUVW xxR(H"i4 I}}W%.#---   zz%%,#$CANN   sA B)'BBc(d}|j|S)zQ It is not public method for reindex Confluence :return: rest/prototype/1/index/reindexr$rrs r!reindexzConfluence.reindex8 s /yy~r"c(d}|j|S)zC Get reindex status of Confluence :return: rr9rs r!reindex_get_statuszConfluence.reindex_get_status@ s /xx}r"cN|jd}|s|jd}|S)z Get health status https://confluence.atlassian.com/jirakb/how-to-retrieve-health-check-results-using-rest-api-867195158.html :return: zrest/troubleshooting/1.0/check/z"rest/supportHealthCheck/1.0/check/r9)rr;s r! health_checkzConfluence.health_checkH s*88=>xx DEHr"c4ddi}d}|j||S)z3 Enable Synchrony :return: rrrest/synchrony-interop/enablerAr$rrUrs r!synchrony_enablezConfluence.synchrony_enableU s& ' 3-yygy..r"c4ddi}d}|j||S)z4 Disable Synchrony :return: rrrest/synchrony-interop/disablerAr$rs r!synchrony_disablezConfluence.synchrony_disable^ s& ' 3.yygy..r"c$|jdS)Nzrest/api/accessmoder9)rs r!check_access_modezConfluence.check_access_modeg sxx-..r"c |jd}|S#t$r,}|jjdk(r t d|d}~wwxYw)zc Get information about how anonymous is represented in confluence :return: zrest/api/user/anonymousr`z;The calling user does not have permission to use ConfluencerENr)rr;rJs r! anonymouszConfluence.anonymousj sY xx 9:H zz%%,(Q  s A 'AA cBd}|j||jdS)zR Provide plugins info :return a json of installed plugins rest/plugins/1.0/TrUr1r:rOrs r!get_plugins_infozConfluence.get_plugins_info| s$ "xxT%:%:TxJJr"cJd|d}|j||jdS)zQ Provide plugin info :return a json of installed plugins r-keyTrrr plugin_keyrs r!get_plugin_infozConfluence.get_plugin_info s- "*T2xxT%:%:TxJJr"cJd|d}|j||jdS)z[ Provide plugin license info :return a json specific License query rz -key/licenseTrrrs r!get_plugin_license_infoz"Confluence.get_plugin_license_info s- "*\:xxT%:%:TxJJr"cdt|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)rrrUr1z upm-tokenzrest/plugins/1.0/?token=)rrU)rrrOrUrX)r plugin_pathr upm_tokenrs r! upload_pluginzConfluence.upload_plugin sq 4 T23LL$)) ! '+  ) 4yyE43H3HyIIr"cHddd}d|d}ddi}|j|||S) zN Disable a plugin :param plugin_key: :return: r application/vnd.atl.plugins+jsonr Content-TyperrrdisabledrFr{rr app_headersrr3s r!disable_pluginzConfluence.disable_plugin s@",> "*T2*%xx$ x< "*T2)$xx$ x< j\2k*xx$ x<vxNH zz%%,u  s" A'AAc d}|j}tjd|j||d}|j dd}|j ddj d d }d |d }|rtjd |j|}t |jdd } |jd} | dk(rtjdy| dk(rAd}tjd| tjd|jd} n/tj| d| tjd|rtjd|j ddd} | j dd} tjd| S#t$r}tj|Yd}~yd}~wwxYw)a Confluence cloud does not return the PDF document when the PDF export is initiated. Instead, it starts a process in the background and provides a link to download the PDF once the process completes. This functions polls the long-running task page and returns the download url of the PDF. This method is used in get_space_export() method for space-> PDF export. :param url: URL to initiate PDF export :return: Download url for PDF file Tz)Initiate PDF export from Confluence Cloudrzutf-8ignore)encodingerrorszname="ajs-taskId" content="rz">rz/services/api/v1/task/z /progressz#Check if export task has completed.progressstateFAILEDzPDF conversion not successful.NdFzTask completed - z%Extract task results to download PDF.rz% - rzETask successfully done, querying the task result for the download urlrstrictz!Successfully got the download url) rrgrhr:decodesplitrfrrrrr)rrrrUr;response_stringrrrpercentage_complete task_statetask_result_url task_contentrrJs r!rz4Confluence.get_pdf_download_url_for_confluence_cloud s L--G HH@ AxxWxMH&oowxoPO%++,IJ1MSSTXYZ[\G/y BH>?$(HHX$6!&)*;*?*? A*N&O#.227; )II>?(C/#(LHH0 =>IIEF&7&;&;H&EOHH 34D EFJJqM II] ^88OAB$748PL'...QL II9 :   IIaL s&C$F4'A7F4AF44 G=GGcvd}i}|r||d<|r||d<|r||d<|r||d<|r||d<|j||S)z Fetch a paginated list of AuditRecord instances dating back to a certain time :param start_date: :param end_date: :param start: :param limit: :param search_string: :return: zrest/api/audit startDateendDaterarb searchStringrBr9)r start_dateend_daterarb search_stringrr2s r!auditzConfluence.audit4 s`" ",F;   (F9  #F7O #F7O %2F> "xxFx++r"cPd}d|i}|||d<|||d<|j||S)Nz/api/v2/whiteboardsspaceIdr@parentIdrr$)rrr@rrr3s r!create_whiteboardzConfluence.create_whiteboardY sC#7#  !DM  'D yy4y((r"c d|z}|j|S#t$r,}|jjdk(r t d|d}~wwxYwNz/api/v2/whiteboards/%srCzRWhiteboard not found. Check confluence instance url and/or if whiteboard id existsrErr whiteboard_idrrJs r!get_whiteboardzConfluence.get_whiteboardb sY *md}i}|r||d<|j||S)Nz@rest/calendar-services/1.0/calendar/subcalendars/watching/statusrrBr9)rrrr2s r!0team_calendars_get_sub_calendars_watching_statusz;Confluence.team_calendars_get_sub_calendars_watching_status s,P  'F9 xxFx++r"chd}i}|r||d<|r||d<|r||d<|r||d<|j||S)z Get calendar event status :param sub_calendar_id: :param start: :param end: :param user_time_zone_id: :return: z*rest/calendar-services/1.0/calendar/events subCalendarIduserTimeZoneIdraendrBr9)rsub_calendar_idrar&user_time_zone_idrr2s r!team_calendar_eventszConfluence.team_calendar_events sT; &5F? # '8F# $ #F7O F5MxxFx++r"c.d|}|j|S)zQ Get mobile paramaters :param username: :return: zrest/mobile/1.0/profile/r9)rrlrs r!get_mobile_parametersz Confluence.get_mobile_parameters s ) 3xx}r"c4d|d}|j||S)zw :param user_key: :param data: json like {"avatarDataURI":"image in base64"} :return: rest/user-profile/1.0/z/avatar/uploadrr$)ruser_keyr3rs r!avatar_upload_for_userz!Confluence.avatar_upload_for_user s%'xj?yy4y((r"c0d|d}|j|S)z3 :param user_key: :return: r-z/avatar/defaultr9)rr.rs r!avatar_set_default_for_userz&Confluence.avatar_set_default_for_user s 'xj@xx}r"cJ|||d}d}dd||gd}|j||y)zY That method related to creating user via json rpc for Confluence Server )emailfullnamerUrraddUserrrr2rNr$)rr3r4rlpasswordr2rr3s r!add_userzConfluence.add_user s<!hI1x(  #D !r"cFd|i}d}dd||gd}|j||y)zb That method related to changing user password via json rpc for Confluence Server rUrrchangeUserPasswordr6rNr$)rrlr7r2rr3s r!change_user_passwordzConfluence.change_user_password s:(#1*x(  #D !r"c>d}dd||gd}|j||y)zp That method related to changing calling user's own password via json rpc for Confluence Server rrchangeMyPasswordr6rNr$)roldpassnewpassrr3s r!change_my_passwordzConfluence.change_my_password s02((  #D !r"c4d|d|}|j|S)z Add given user to a group :param username: str - username of user to add to group :param group_name: str - name of group to add user to :return: Current state of the group rest/api/user//group/r{rrlrRrs r!add_user_to_groupzConfluence.add_user_to_group s$xj |<xx}r"c4d|d|}|j|S)a Remove the given {@link User} identified by username from the given {@link Group} identified by groupName. This method is idempotent i.e. if the membership is not present then no action will be taken. :param username: str - username of user to add to group :param group_name: str - name of group to add user to :return: Current state of the group rBrCrrrDs r!remove_user_from_groupz!Confluence.remove_user_from_group s%xj |<{{3r"c0d|d}|j|S)z Returns list of permissions granted to users and groups in the particular space. :param space_key: :return: rz /permissionsr9r|s r!get_all_space_permissionsz$Confluence.get_all_space_permissions s  {,7xx}r"cd|d}g}|r|j||xsgd|r|j||xsgd|s|s|jd|xsgitj|}|j||S)a Sets permissions to multiple users/groups in the given space. Request should contain all permissions that user/group/anonymous user will have in a given space. If permission is absent in the request, but was granted before, it will be revoked. If empty list of permissions passed to user/group/anonymous user, then all their existing permissions will be revoked. If user/group/anonymous user not mentioned in the request, their permissions will not be revoked. Maximum 40 different users/groups/anonymous user could be passed in the request. :param space_key: :param user_key: :param group_name: :param operations: :return: rzrI)userKey operations)rrMrMr)rrTrrX)rrPr.rRrMrr2 payload_jsons r!+set_permissions_to_multiple_items_for_spacez6Confluence.set_permissions_to_multiple_items_for_spaces  {,7  MMhj>NBO P  MM *BRPRS T MM<)9r: ;zz&) yy>Im>L L1. k   yy4y(,,X6<"MMOiL  H== - , ! ))++ ,sA77 B/%B**B/)NNNNFr)rMNNN)rMNN)rM)rrWN)rrNrM)NNN)NNrNN)r0N)rrUN)rrUNNrM)rrUNzhistory,space,versionrM)rr*rM)rrr0)NNNN)NF)NrMr(NFr)NNr)rMNNNN)rNN)NrNN)rrUNNN)NNr)rNNNN)NNNNNN)NrrUNF)rWr)rMr(FNF)NNrMr(FNFF)NrMr(FNF)NrMr(F)r(FNNF)zcom.gliffy.cache.gon)r)confluence-usersrrN)rN)zdescription.plain,homepageN)rrrNr)rNNNN)NNNNN)NN)__name__ __module__ __qualname__rr staticmethodr/r<rKr_rirortrwrzrrrrryrrrrrrrrrrrrrrrrrrrrGrr rr!r(r.r1r7r-rHrSr^rbrfrirlrnrprsrxr}rrrrrrrrrrrrrrrrrrrrrrr rrrr r"r%r'r/r2r6r:r<r>rCrHrKrMrOrSrZr]r_rbrergrirortrwrrrrrrrrrrrrrrrrrrrrrrrrrr rrrr r"r)r+r/r1r8r;r@rErGrJrOrRrUrWrZr]r`rcrfrhrsrxr{rrrrrrrrrrrrrrrrrrr __classcell__)r s@r!rr&sd!$* M? S S  5nBQ$&P   IQ ! $l J,\%N'*R4"N-^ R'D3p*^&' R e J'D AF(PQLRL ==$W^_mWn PWXfPg ASA3AZabpZqAF!#!!FCA4#T  9~ L>:9x(DEF*4(GH-I-B"-H(EF -G -D"-H?& ,>," :*Oh.`XDt "  Y4 C&-^2S<"(  =S &Z  6  Ux  FZ  ! P  ! P!6pLI@'R.0.)*U `'. )2'268-^L/.*>>D $.`F"Faf#afCafCafF-4 ///$KKKJ = = T =<$2+^ ,> )   ,$,,*) " " "   1<(8(:(:(<(:*<L6=$=$=$ ) , , / < = = = < < <  >r"r)#rrTloggingrrrrtypingrrbs4rrr atlassianratlassian.errorsrr r r r r rratlassian.rest_clientrsys version_infortyping_extensions getLoggerrrgrrr"r!rsx  !   3 v)g!m?>!m?>r"