K:g[ddlmZmZddlmZmZddlmZmZmZm Z m Z m Z m Z m Z mZddlZddlmZddlmZmZddlmZddlmZmZmZmZdd lmZmZmZm Z m!Z!m"Z"erdd l#m$Z$e"Gd d Z%Gd deZ&GddeZ'GddeZ(GddeZ)GddeZ*GddeZ+ee,y))datedatetime)cached_property partialmethod) TYPE_CHECKINGAnyDictIterableIteratorListLiteralOptionalUnionN)Self) AirtableModelrebuild_models)AuditLogResponse)EnterpriseInfoNestedId UserGroupUserInfo)Url UrlBuildercache_unless_forcedcoerce_iso_strcoerce_list_strenterprise_only)ApiceZdZdZGddeZeeZdddefdZ e ddd d e d e d e fd Z d>dede d efdZdddddede d e d e d ef dZdddddeede d e d e d eef dZdddddddddddd deedeedee deedeedeeeeefdeeeeefd eeeeefd!eeeeefd"eeeeefd#eeeeefd eefd$Z d?dd%d ed&eed e d d'fd(Zd)eeed*fd d+fd,Z d-eed d.fd/Z!d)eeefd d+fd0Z"d)eeefd d+fd1Z#d2ed3d)eeeefd d+fd4Z$d5ed e%fd6Z&d7eed8eee%fd d9fd:Z'd;eed8eee%fd d>> enterprise = api.enterprise("entUBq2RGdihxl3vU") >>> enterprise.info().workspace_ids ['wspmhESAta6clCCwF', ...] ceZdZedZedz ZedZedz Zedz Zedz Z edz Z edz Z d e d efd Z d e d efd Zdedd efdZd e d efdZeedZeedZy)Enterprise._urlszmeta/enterpriseAccounts/{id}usersz meta/groupsz claim/usersauditLogEvents descendants moveGroupsmoveWorkspacesuser_idreturnc |j|z S)zM URL for retrieving information about a single user. r#selfr(s V/var/www/html/lionshead/venv/lib/python3.12/site-packages/pyairtable/api/enterprise.pyuserzEnterprise._urls.userEs::' 'group_idc |j|z S)zS URL for retrieving information about a single user group. )groups)r-r1s r.groupzEnterprise._urls.groupKs;;) )r0actiongrantrevokec(|jd|dz S)zY URL for granting or revoking admin access to one or more users. zusers/ AdminAccess)meta)r-r5s r. admin_accesszEnterprise._urls.admin_accessQs99x{;; ;r0c*|j|dz S)zF URL for removing a user from the enterprise. remove)r/r,s r. remove_userzEnterprise._urls.remove_userWs99W%0 0r0r7r8N)__name__ __module__ __qualname__rr;r#r3 claim_users audit_logr% move_groupsmove_workspacesstrr/r4r r<r?r grant_admin revoke_adminr0r._urlsr",s12w]#]* ++ ]* \) !11 ( ( (  *# *# *  `__. Args: aggregated: if ``True``, include aggregated values across the enterprise. descendants: if ``True``, include information about the enterprise's descendant orgs. rSr%includeparams)appendrLgeturlsr;rfrom_api)r-rSr%rUrWresponses r.infozEnterprise.infojsf  NN< (  NN= )W%88<< v<>&&x::r0Tr1collaborationscd|rdgngi}|jj|jj||}t j |S)a4 Retrieve information on a single user group with the given ID. Args: group_id: A user group ID (``grpQBq2RGdihxl3vU``). collaborations: If ``False``, no collaboration data will be requested from Airtable. This may result in faster responses. rUr^rV)rLrYrZr4rmodel_validate)r-r1r^rWpayloads r.r4zEnterprise.groupsJ>./rJ((,,tyyx8,H''00r0r^rSr% id_or_emailc8|j|g|||}|dS)ae Retrieve information on a single user with the given ID or email. Args: id_or_email: A user ID (``usrQBq2RGdihxl3vU``) or email address. collaborations: If ``False``, no collaboration data will be requested from Airtable. This may result in faster responses. aggregated: If ``True``, includes the user's aggregated values across this enterprise account and its descendants. descendants: If ``True``, includes information about the user in a ``dict`` keyed per descendant enterprise account. rbrr+)r-rcr^rSr%r#s r.r/zEnterprise.users0( M)!#   Qxr0 ids_or_emailscg}g}|D]}d|vr|n|j|g}|r|jd|r|jd|r|jd|jj|jj|||d} | dD cic]3} t j | |j|x} r | j| 5} } t| jScc} w) a Retrieve information on the users with the given IDs or emails. Read more at `Get users by ID or email `__. Args: ids_or_emails: A sequence of user IDs (``usrQBq2RGdihxl3vU``) or email addresses (or both). collaborations: If ``False``, no collaboration data will be requested from Airtable. This may result in faster responses. aggregated: If ``True``, includes the user's aggregated values across this enterprise account and its descendants. descendants: If ``True``, includes information about the user in a ``dict`` keyed per descendant enterprise account. @r^rSr%)rPemailrU)urlrWr#context) rXrLrYrZr#rr[rPlistvalues) r-rer^rSr%user_idsemailsvaluerUr\user_objr]r#s r.r#zEnterprise.userss.!"Ee|V 9 9% @#  NN+ ,  NN< (  NN= )88<< "  %W- - ))(DHHdKKK GGTM-  ELLN##  s8C-N) page_size page_limitsort_ascpreviousnext start_timeend_timer( event_typemodel_idcategoryrrrsrtrurvrwrxr(ryrzr{c #Kt|}t|}t|}t| } t| } t| } |||| | | ||rdnd||d } | jD cic] \} }|s | | } } }|rdnd}|jj d|j j | |}t|d D]6\}}tj|}||jsy |0||k\s6y y cc}} ww) a] Retrieve and yield results from the `Audit Log `__, one page of results at a time. Each result is an instance of :class:`~pyairtable.models.audit.AuditLogResponse` and contains the pagination IDs returned from the API, as described in the linked documentation. By default, the Airtable API will return up to 180 days of audit log events, going backwards from most recent. Retrieving all records may take some time, but is as straightforward as: >>> enterprise = Enterprise("entYourEnterpriseId") >>> events = [ ... event ... for page in enterprise.audit_log() ... for event in page.events ... ] If you are creating a record of all audit log events, you probably want to start with the earliest events in the retention window and iterate chronologically. You'll likely have a job running periodically in the background, so you'll need some way to persist the pagination IDs retrieved from the API in case that job is interrupted and needs to be restarted. The sample code below will use a local file to remember the next page's ID, so that if the job is interrupted, it will resume where it left off (potentially processing some entries twice). .. code-block:: python import os import shelve import pyairtable def handle_event(event): print(event) api = pyairtable.Api(os.environ["AIRTABLE_API_KEY"]) enterprise = api.enterprise(os.environ["AIRTABLE_ENTERPRISE_ID"]) persistence = shelve.open("audit_log.db") first_page = persistence.get("next", None) for page in enterprise.audit_log(sort_asc=True, next=first_page): for event in page.events: handle_event(event) persistence["next"] = page.pagination.next For more information on any of the keyword parameters below, refer to the `audit log events `__ API documentation. Args: page_size: How many events per page to return (maximum 100). page_limit: How many pages to return before stopping. sort_asc: Whether to sort in ascending order (earliest to latest) rather than descending order (latest to earliest). previous: Requests the previous page of results from the given ID. See the `audit log integration guide `__ for more information on pagination parameters. next: Requests the next page of results according to the given ID. See the `audit log integration guide `__ for more information on pagination parameters. start_time: Earliest timestamp to retrieve (inclusive). end_time: Latest timestamp to retrieve (inclusive). originating_user_id: Retrieve audit log events originating from the provided user ID or IDs (maximum 100). event_type: Retrieve audit log events falling under the provided `audit log event type `__ or types (maximum 100). model_id: Retrieve audit log events taking action on, or involving, the provided model ID or IDs (maximum 100). category: Retrieve audit log events belonging to the provided audit log event category or categories. Returns: An object representing a single page of audit log results. ascending descending) startTimeendTimeoriginatingUserId eventTypemodelIdr{pageSize sortOrderrurvrvruGET)methodrirW offset_field)startN) rritemsrLiterate_requestsrZrD enumeraterr`events)r-rrrsrtrurvrwrxr(ryrzr{rWkvr iter_requestscountr\parseds r.rDzEnterprise.audit_logsp$J/ !(+!'*$Z0 "8,"8,#!(# !)1+|   &,\\^9^6Aqq!Q$^9!)vz 11 ##% 2 )a@OE8%44X>FL==%%:*= A:s%A'D) C<4C<9A8D2D8 D)r% replacement UserRemovedc|jj|}ddi}|r||d<|rd|d<|jj||}tj ||j|S)a Unshare a user from all enterprise workspaces, bases, and interfaces. If applicable, the user will also be removed from as an enterprise admin. See `Remove user from enterprise `__ for more information. Args: user_id: The user ID. replacement: If the user is the sole owner of any workspaces, you must specify a replacement user ID to be added as the new owner of such workspaces. If the user is not the sole owner of any workspaces, this is optional and will be ignored if provided. descendants: If ``True``, removes the user from descendant enterprise accounts. isDryRunFreplacementOwnerIdTremoveFromDescendantsjsonrj)rZr?rLpostrr[)r-r(rr%rirar\s r.r?zEnterprise.remove_userYsp,ii##G,#-u"5 ,7G( ) /3G+ ,88==7=3##Hdhh#EEr0r#)managed unmanagedManageUsersResponsec d|jDcgc]\}}d|vrdnd|d|ic}}i}|jj|jj|}t j ||j|Scc}}w)a Batch manage organizations enterprise account users. This endpoint allows you to change a user's membership status from being unmanaged to being an organization member, and vice versa. See `Manage user membership `__ for more information. Args: users: A ``dict`` mapping user IDs or emails to the desired state, either ``"managed"`` or ``"unmanaged"``. r#rgrhrPstaterrj)rrLrrZrCrr[)r-r#keyrprar\s r.rCzEnterprise.claim_usersxs  %*KKM  %2LS%!$s WsU%2  88==!6!6W=E"++Hdhh+MMsBroDeleteUsersResponsec|jj|jjdt |i}t j ||j|S)z Delete multiple users by email. Args: emails: A list or other iterable of email addresses. rhrVrj)rLdeleterZr#rlrr[)r-ror\s r. delete_userszEnterprise.delete_userssG88??499??GT&\;R?S"++Hdhh+MMr0c&|jd|S)z Grant admin access to one or more users. Args: users: One or more user IDs, email addresses, or instances of :class:`~pyairtable.models.schema.UserInfo`. r7_post_admin_accessr-r#s r.rHzEnterprise.grant_admins&&w66r0c&|jd|S)z Revoke admin access to one or more users. Args: users: One or more user IDs, email addresses, or instances of :class:`~pyairtable.models.schema.UserInfo`. r8rrs r.rIzEnterprise.revoke_admins&&x77r0r5r6c 2|jj|jj|d|Dcgc],}t |t r |j n|}d|vrd|ind|i.c}}i}tj||j|Scc}}w)Nr#rgrhrPrrj) rLrrZr< isinstancerrPrr[)r-r5r#r/r(r\s r.rzEnterprise._post_admin_accesss88== II " "6 * % %/9$/IDGGt+..Wg&tWoM %!  #++Hdhh+MMs1Bnamec|jj|jjd|i}|j |j|dS)a Creates a descendant enterprise account of the enterprise account. Descendant enterprise accounts can only be created for root enterprise accounts with the Enterprise Hub feature enabled. See `Create descendant enterprise `__. Args: name: The name to give the new account. rrrP)rLrrZr% __class__)r-rr\s r.create_descendantzEnterprise.create_descendantsA88==!6!6fd^=L~~dhh77r0 group_idstargetMoveGroupsResponsect|tr |j}|jj |j j ||d}tj||j|S)a Move one or more user groups from the current enterprise account into a different enterprise account within the same organization. See `Move user groups `__. Args: group_ids: User group IDs. target: The ID of the target enterprise, or an instance of :class:`~pyairtable.Enterprise`. )groupIdstargetEnterpriseAccountIdrrj) rr rPrLrrZrErr[)r-rrr\s r.rEzEnterprise.move_groupssd fj )YYF88== II ! !%-3! "**8TXXt*LLr0 workspace_idsMoveWorkspacesResponsect|tr |j}|jj |j j ||d}tj||j|S)a Move one or more workspaces from the current enterprise account into a different enterprise account within the same organization. See `Move workspaces `__. Args: workspace_ids: The list of workspace IDs. target: The ID of the target enterprise, or an instance of :class:`~pyairtable.Enterprise`. ) workspaceIdsrrrj) rr rPrLrrZrFrr[)r-rrr\s r.rFzEnterprise.move_workspacessd fj )YYF88== II % % --3! &..x4.PPr0)TrO))r@rArB__doc__rrKrrZrGrRrboolrr]rr4rr/r r r#rintrrrr rrDr?r r rCrrHrIrrrrErFrJr0r.r r "s5= 5=n 5 !D4E44 !! ;; ;  ;;. 1c 14 19 1" $ !       @ $ ! 2$}2$ 2$  2$  2$ h2$n$($(#("&";?9=7;:>8<8<xC=xSM x 4. x 3- xsmxU3h#678x5dH!456x%Xc] 234xU3 #567x5hsm!345x5hsm!345x " #xz&*F " FFc]F  F  F>N#w'=>>?N N6N8C=N5JN7%X "67;P785h#78`__ endpoint. was_user_removed_as_adminUserRemoved.SharedsharedUserRemoved.Unsharedunsharedc4eZdZUeded<GddeZy)rUserRemoved.Shared.Workspace workspacescbeZdZUeed<eed<eed<dZeed<dZeeed<dZ eeed<y) rpermission_levelrMworkspace_namer(N deleted_timeenterprise_account_id) r@rArBrG__annotations__r(rrrrrJr0r. WorkspacezUserRemoved.Shared.Workspaces<! !  GS /3L(8, 337 !8C= 7r0rN)r@rArBr rrrrJr0r.SharedzUserRemoved.Shared s788 8  8r0rceZdZUeded<eded<eded<GddeZGd d eZGd d eZy )rUserRemoved.Unshared.BasebasesUserRemoved.Unshared.Interface interfacesUserRemoved.Unshared.Workspacerc^eZdZUeed<eed<eed<eed<dZeeed<dZeeed<y)rr(base_id base_nameformer_permission_levelNrr r@rArBrGrrrrrrJr0r.BasezUserRemoved.Unshared.Bases5LLN%( (/3L(8, 337 !8C= 7r0rcheZdZUeed<eed<eed<eed<eed<dZeeed<dZeeed<y) rr(r interface_idinterface_namerNrrrrJr0r. InterfacezUserRemoved.Unshared.Interface%s<LL  %( (/3L(8, 337 !8C= 7r0rc^eZdZUeed<eed<eed<eed<dZeeed<dZeeed<y)rr(rrMrNrrrrJr0r.rzUserRemoved.Unshared.Workspace.s7L%( (  /3L(8, 337 !8C= 7r0rN) r@rArBr rrrrrrJr0r.UnsharedzUserRemoved.UnsharedsJ/009::9:: 8= 8 8  8 8  8r0rN) r@rArBrrrrrrrJr0r.rrs3 $#  $$ 8 88=8r0rc^eZdZUdZeded<eded<GddeZGdd eZy ) rz Returned from the `Delete users by email `__ endpoint. DeleteUsersResponse.UserInfo deleted_usersDeleteUsersResponse.Errorerrorsc"eZdZUeed<eed<y)rrPrhNr@rArBrGrrJr0r.rzDeleteUsersResponse.UserInfo@s  r0rc6eZdZUeed<eed<dZeeed<y)rtyperhNmessage)r@rArBrGrrrrJr0r.ErrorzDeleteUsersResponse.ErrorDs  !%#%r0rN) r@rArBrr rrrrrJr0r.rr7s9 677 , --=& &r0rc^eZdZUdZej eZede d<Gdde Z y)ra> Returned from the `Manage user membership `__, `Grant admin access `__, and `Revoke admin access `__ endpoints. default_factoryManageUsersResponse.ErrorrcJeZdZUdZeeed<dZeeed<eed<eed<y)rNrPrhrr)r@rArBrPrrGrrhrJr0r.rzManageUsersResponse.ErrorTs( HSM #x}#  r0rN) r@rArBrpydanticFieldrlrr rrrrJr0r.rrJs01?t0TFD, -T r0rc,eZdZUeed<eed<eed<y) MoveErrorrPrrNrrJr0r.rr[s G I Lr0rc~eZdZUdZej eZee e d<ej eZ ee e d<y)rzf Returned by `Move user groups `__. r moved_groupsrN) r@rArBrrrrlrr rrrrrJr0r.rras;$28>>$#GL$x.G,hnnTBFDOBr0rc~eZdZUdZej eZee e d<ej eZ ee e d<y)rzd Returned by `Move workspaces `__. rmoved_workspacesrN) r@rArBrrrrlrr rrrrrJr0r.rrjs<(6x~~d'Kd8nK,hnnTBFDOBr0r)-rr functoolsrrtypingrrr r r r r rrrtyping_extensionsrpyairtable.models._baserrpyairtable.models.auditrpyairtable.models.schemarrrrpyairtable.utilsrrrrrrpyairtable.api.apirr rrrrrrvarsrJr0r.rs#4   "A4RR&]Q]Q]Q@18-18h&-&&-"  CCC]Ctvr0