From 634394aa25dee7eb3158573c1e79c7337dad97b0 Mon Sep 17 00:00:00 2001 From: box-sdk-build Date: Tue, 26 Mar 2024 07:12:04 -0700 Subject: [PATCH 1/2] feat: Change and method names (box/box-codegen#464) --- .codegen.json | 2 +- box_sdk_gen/box/ccg_auth.py | 4 ++-- box_sdk_gen/box/jwt_auth.py | 4 ++-- docs/authentication.md | 10 +++++----- test/auth.py | 13 ++++++------- test/commons.py | 4 ++-- test/file_requests.py | 4 ++-- test/integration_mappings.py | 4 ++-- test/invites.py | 4 ++-- test/recent_items.py | 4 ++-- test/session_termination.py | 6 ++++-- test/shared_links_files.py | 4 ++-- test/shared_links_folders.py | 4 ++-- test/shared_links_web_links.py | 4 ++-- test/shield_information_barrier_reports.py | 4 ++-- test/shield_information_barrier_segment_members.py | 4 ++-- ...ield_information_barrier_segment_restrictions.py | 4 ++-- test/shield_information_barrier_segments.py | 4 ++-- test/shield_information_barriers.py | 4 ++-- test/sign_templates.py | 6 +++--- test/storage_policicy_assignments.py | 4 ++-- test/storage_policies.py | 4 ++-- test/terms_of_service_user_statuses.py | 4 ++-- test/workflows.py | 6 ++++-- 24 files changed, 59 insertions(+), 56 deletions(-) diff --git a/.codegen.json b/.codegen.json index a96bf26..c4cdcbc 100644 --- a/.codegen.json +++ b/.codegen.json @@ -1 +1 @@ -{ "engineHash": "0d4bf53", "specHash": "d50ab5f", "version": "0.6.3" } +{ "engineHash": "fa2d002", "specHash": "d50ab5f", "version": "0.6.3" } diff --git a/box_sdk_gen/box/ccg_auth.py b/box_sdk_gen/box/ccg_auth.py index ef2b484..630bed3 100644 --- a/box_sdk_gen/box/ccg_auth.py +++ b/box_sdk_gen/box/ccg_auth.py @@ -125,7 +125,7 @@ def retrieve_authorization_header( token: AccessToken = self.retrieve_token(network_session=network_session) return ''.join(['Bearer ', token.access_token]) - def as_user( + def with_user_subject( self, user_id: str, *, token_storage: TokenStorage = None ) -> 'BoxCCGAuth': """ @@ -155,7 +155,7 @@ def as_user( ) return BoxCCGAuth(config=new_config) - def as_enterprise( + def with_enterprise_subject( self, enterprise_id: str, *, token_storage: TokenStorage = None ) -> 'BoxCCGAuth': """ diff --git a/box_sdk_gen/box/jwt_auth.py b/box_sdk_gen/box/jwt_auth.py index d21d744..4bdfb85 100644 --- a/box_sdk_gen/box/jwt_auth.py +++ b/box_sdk_gen/box/jwt_auth.py @@ -341,7 +341,7 @@ def retrieve_authorization_header( token: AccessToken = self.retrieve_token(network_session=network_session) return ''.join(['Bearer ', token.access_token]) - def as_user( + def with_user_subject( self, user_id: str, *, token_storage: TokenStorage = None ) -> 'BoxJWTAuth': """ @@ -375,7 +375,7 @@ def as_user( new_auth: 'BoxJWTAuth' = BoxJWTAuth(config=new_config) return new_auth - def as_enterprise( + def with_enterprise_subject( self, user_id: str, *, token_storage: TokenStorage = None ) -> 'BoxJWTAuth': """ diff --git a/docs/authentication.md b/docs/authentication.md index 1e78352..6d2007f 100644 --- a/docs/authentication.md +++ b/docs/authentication.md @@ -116,7 +116,7 @@ make calls as that user. See the [API documentation](https://developer.box.com/) for detailed instructions on how to use app auth. Clients for making calls as an App User can be created with the same JSON JWT config file generated through the -[Box Developer Console][dev_console]. Calling `auth.as_user('USER_ID')` method will return a new auth object, +[Box Developer Console][dev_console]. Calling `auth.with_user_subject('USER_ID')` method will return a new auth object, which is authenticated as the user with provided id, leaving the original object unchanged. ```python @@ -124,7 +124,7 @@ from box_sdk_gen import BoxClient, BoxJWTAuth, JWTConfig jwt_config = JWTConfig.from_config_file(config_file_path='/path/to/settings.json') auth = BoxJWTAuth(config=jwt_config) -user_auth = auth.as_user('USER_ID') +user_auth = auth.with_user_subject('USER_ID') user_client = BoxClient(auth=user_auth) ``` @@ -224,14 +224,14 @@ You can easily switch to be authenticated as a Service Account or as a User. To create a new auth object authenticated as Service Account you can call: ```python -enterprise_auth = auth.as_enterprise(enterprise_id='YOUR_ENTERPRISE_ID') +enterprise_auth = auth.with_enterprise_subject(enterprise_id='YOUR_ENTERPRISE_ID') enterprise_client = BoxClient(auth=enterprise_auth) ``` -To authenticate as user with provided User ID call: +To authenticate with user subject call: ```python -user_auth = auth.as_user(user_id='YOUR_USER_ID') +user_auth = auth.with_user_subject(user_id='YOUR_USER_ID') user_client = BoxClient(auth=user_auth) ``` diff --git a/test/auth.py b/test/auth.py index 5fd4f79..d29c737 100644 --- a/test/auth.py +++ b/test/auth.py @@ -58,11 +58,11 @@ def test_jwt_auth(): decode_base_64(get_env_var('JWT_CONFIG_BASE_64')) ) auth: BoxJWTAuth = BoxJWTAuth(config=jwt_config) - user_auth: BoxJWTAuth = auth.as_user(user_id) + user_auth: BoxJWTAuth = auth.with_user_subject(user_id) user_client: BoxClient = BoxClient(auth=user_auth) current_user: UserFull = user_client.users.get_user_me() assert current_user.id == user_id - enterprise_auth: BoxJWTAuth = auth.as_enterprise(enterprise_id) + enterprise_auth: BoxJWTAuth = auth.with_enterprise_subject(enterprise_id) enterprise_client: BoxClient = BoxClient(auth=enterprise_auth) new_user: UserFull = enterprise_client.users.get_user_me(fields=['enterprise']) assert not new_user.enterprise == None @@ -134,11 +134,11 @@ def test_ccg_auth(): user_id=user_id, ) auth: BoxCCGAuth = BoxCCGAuth(config=ccg_config) - user_auth: BoxCCGAuth = auth.as_user(user_id) + user_auth: BoxCCGAuth = auth.with_user_subject(user_id) user_client: BoxClient = BoxClient(auth=user_auth) current_user: UserFull = user_client.users.get_user_me() assert current_user.id == user_id - enterprise_auth: BoxCCGAuth = auth.as_enterprise(enterprise_id) + enterprise_auth: BoxCCGAuth = auth.with_enterprise_subject(enterprise_id) enterprise_client: BoxClient = BoxClient(auth=enterprise_auth) new_user: UserFull = enterprise_client.users.get_user_me(fields=['enterprise']) assert not new_user.enterprise == None @@ -196,9 +196,8 @@ def get_access_token() -> AccessToken: user_id=user_id, ) auth: BoxCCGAuth = BoxCCGAuth(config=ccg_config) - auth.as_user(user_id) - token: AccessToken = auth.retrieve_token() - return token + auth_user: BoxCCGAuth = auth.with_user_subject(user_id) + return auth_user.retrieve_token() def test_developer_token_auth(): diff --git a/test/commons.py b/test/commons.py index 2bb6d40..69673e5 100644 --- a/test/commons.py +++ b/test/commons.py @@ -97,9 +97,9 @@ def get_jwt_auth() -> BoxJWTAuth: return auth -def get_default_client_as_user(user_id: str) -> BoxClient: +def get_default_client_with_user_subject(user_id: str) -> BoxClient: auth: BoxJWTAuth = get_jwt_auth() - auth_user: BoxJWTAuth = auth.as_user(user_id) + auth_user: BoxJWTAuth = auth.with_user_subject(user_id) return BoxClient(auth=auth_user) diff --git a/test/file_requests.py b/test/file_requests.py index 57dd3a7..ebe4d1d 100644 --- a/test/file_requests.py +++ b/test/file_requests.py @@ -12,13 +12,13 @@ from box_sdk_gen.internal.utils import get_env_var -from test.commons import get_default_client_as_user +from test.commons import get_default_client_with_user_subject def testGetCopyUpdateDeleteFileRequest(): file_request_id: str = get_env_var('BOX_FILE_REQUEST_ID') user_id: str = get_env_var('USER_ID') - client: BoxClient = get_default_client_as_user(user_id) + client: BoxClient = get_default_client_with_user_subject(user_id) file_request: FileRequest = client.file_requests.get_file_request_by_id( file_request_id ) diff --git a/test/integration_mappings.py b/test/integration_mappings.py index 5d7a364..f660b74 100644 --- a/test/integration_mappings.py +++ b/test/integration_mappings.py @@ -24,7 +24,7 @@ from test.commons import get_default_client -from test.commons import get_default_client_as_user +from test.commons import get_default_client_with_user_subject client: BoxClient = get_default_client() @@ -36,7 +36,7 @@ def testIntegrationMappings(): slack_org_id: str = '1' partner_item_id: str = '1' user_id: str = get_env_var('USER_ID') - user_client: BoxClient = get_default_client_as_user(user_id) + user_client: BoxClient = get_default_client_with_user_subject(user_id) with pytest.raises(Exception): user_client.integration_mappings.create_slack_integration_mapping( IntegrationMappingPartnerItemSlack( diff --git a/test/invites.py b/test/invites.py index ed144b8..56701aa 100644 --- a/test/invites.py +++ b/test/invites.py @@ -14,12 +14,12 @@ from box_sdk_gen.internal.utils import get_env_var -from test.commons import get_default_client_as_user +from test.commons import get_default_client_with_user_subject def testInvites(): user_id: str = get_env_var('USER_ID') - client: BoxClient = get_default_client_as_user(user_id) + client: BoxClient = get_default_client_with_user_subject(user_id) current_user: UserFull = client.users.get_user_me(fields=['enterprise']) email: str = get_env_var('BOX_EXTERNAL_USER_EMAIL') invitation: Invite = client.invites.create_invite( diff --git a/test/recent_items.py b/test/recent_items.py index acc742d..293c404 100644 --- a/test/recent_items.py +++ b/test/recent_items.py @@ -8,10 +8,10 @@ from box_sdk_gen.internal.utils import get_uuid -from test.commons import get_default_client_as_user +from test.commons import get_default_client_with_user_subject def testRecentItems(): - client: BoxClient = get_default_client_as_user(get_env_var('USER_ID')) + client: BoxClient = get_default_client_with_user_subject(get_env_var('USER_ID')) recent_items: RecentItems = client.recent_items.get_recent_items() assert len(recent_items.entries) >= 0 diff --git a/test/session_termination.py b/test/session_termination.py index cb556a8..0ccd3c2 100644 --- a/test/session_termination.py +++ b/test/session_termination.py @@ -12,13 +12,15 @@ from test.commons import get_default_client -from test.commons import get_default_client_as_user +from test.commons import get_default_client_with_user_subject client: BoxClient = get_default_client() def testSessionTerminationUser(): - admin_client: BoxClient = get_default_client_as_user(get_env_var('USER_ID')) + admin_client: BoxClient = get_default_client_with_user_subject( + get_env_var('USER_ID') + ) user: UserFull = admin_client.users.get_user_me() result: SessionTerminationMessage = ( client.session_termination.terminate_users_sessions( diff --git a/test/shared_links_files.py b/test/shared_links_files.py index 064c7d3..1a13c9e 100644 --- a/test/shared_links_files.py +++ b/test/shared_links_files.py @@ -32,7 +32,7 @@ from test.commons import get_default_client -from test.commons import get_default_client_as_user +from test.commons import get_default_client_with_user_subject client: BoxClient = get_default_client() @@ -58,7 +58,7 @@ def testSharedLinksFiles(): ) assert to_string(file_from_api.shared_link.access) == 'open' user_id: str = get_env_var('USER_ID') - user_client: BoxClient = get_default_client_as_user(user_id) + user_client: BoxClient = get_default_client_with_user_subject(user_id) file_from_shared_link_password: FileFull = ( user_client.shared_links_files.find_file_for_shared_link( ''.join( diff --git a/test/shared_links_folders.py b/test/shared_links_folders.py index 25a2921..1ae8889 100644 --- a/test/shared_links_folders.py +++ b/test/shared_links_folders.py @@ -28,7 +28,7 @@ from test.commons import get_default_client -from test.commons import get_default_client_as_user +from test.commons import get_default_client_with_user_subject client: BoxClient = get_default_client() @@ -50,7 +50,7 @@ def testSharedLinksFolders(): ) assert to_string(folder_from_api.shared_link.access) == 'open' user_id: str = get_env_var('USER_ID') - user_client: BoxClient = get_default_client_as_user(user_id) + user_client: BoxClient = get_default_client_with_user_subject(user_id) folder_from_shared_link_password: FolderFull = ( user_client.shared_links_folders.find_folder_for_shared_link( ''.join( diff --git a/test/shared_links_web_links.py b/test/shared_links_web_links.py index e43a077..26cce19 100644 --- a/test/shared_links_web_links.py +++ b/test/shared_links_web_links.py @@ -32,7 +32,7 @@ from test.commons import get_default_client -from test.commons import get_default_client_as_user +from test.commons import get_default_client_with_user_subject client: BoxClient = get_default_client() @@ -61,7 +61,7 @@ def testSharedLinksWebLinks(): ) assert to_string(web_link_from_api.shared_link.access) == 'open' user_id: str = get_env_var('USER_ID') - user_client: BoxClient = get_default_client_as_user(user_id) + user_client: BoxClient = get_default_client_with_user_subject(user_id) web_link_from_shared_link_password: WebLink = ( user_client.shared_links_web_links.find_web_link_for_shared_link( ''.join( diff --git a/test/shield_information_barrier_reports.py b/test/shield_information_barrier_reports.py index 7391d08..d3b90c0 100644 --- a/test/shield_information_barrier_reports.py +++ b/test/shield_information_barrier_reports.py @@ -10,7 +10,7 @@ from box_sdk_gen.internal.utils import get_env_var -from test.commons import get_default_client_as_user +from test.commons import get_default_client_with_user_subject from test.commons import get_or_create_shield_information_barrier @@ -20,7 +20,7 @@ def shieldInformationBarrierReports(): - client: BoxClient = get_default_client_as_user(get_env_var('USER_ID')) + client: BoxClient = get_default_client_with_user_subject(get_env_var('USER_ID')) enterprise_id: str = get_env_var('ENTERPRISE_ID') barrier: ShieldInformationBarrier = get_or_create_shield_information_barrier( client, enterprise_id diff --git a/test/shield_information_barrier_segment_members.py b/test/shield_information_barrier_segment_members.py index 652af0d..25c8be9 100644 --- a/test/shield_information_barrier_segment_members.py +++ b/test/shield_information_barrier_segment_members.py @@ -30,13 +30,13 @@ from box_sdk_gen.internal.utils import get_uuid -from test.commons import get_default_client_as_user +from test.commons import get_default_client_with_user_subject from test.commons import get_or_create_shield_information_barrier def testShieldInformationBarrierSegmentMembers(): - client: BoxClient = get_default_client_as_user(get_env_var('USER_ID')) + client: BoxClient = get_default_client_with_user_subject(get_env_var('USER_ID')) enterprise_id: str = get_env_var('ENTERPRISE_ID') barrier: ShieldInformationBarrier = get_or_create_shield_information_barrier( client, enterprise_id diff --git a/test/shield_information_barrier_segment_restrictions.py b/test/shield_information_barrier_segment_restrictions.py index 1153763..acb5842 100644 --- a/test/shield_information_barrier_segment_restrictions.py +++ b/test/shield_information_barrier_segment_restrictions.py @@ -38,13 +38,13 @@ from box_sdk_gen.internal.utils import get_uuid -from test.commons import get_default_client_as_user +from test.commons import get_default_client_with_user_subject from test.commons import get_or_create_shield_information_barrier def testShieldInformationBarrierSegmentRestrictions(): - client: BoxClient = get_default_client_as_user(get_env_var('USER_ID')) + client: BoxClient = get_default_client_with_user_subject(get_env_var('USER_ID')) enterprise_id: str = get_env_var('ENTERPRISE_ID') barrier: ShieldInformationBarrier = get_or_create_shield_information_barrier( client, enterprise_id diff --git a/test/shield_information_barrier_segments.py b/test/shield_information_barrier_segments.py index 61e7a39..fd34e7e 100644 --- a/test/shield_information_barrier_segments.py +++ b/test/shield_information_barrier_segments.py @@ -18,13 +18,13 @@ from box_sdk_gen.internal.utils import get_uuid -from test.commons import get_default_client_as_user +from test.commons import get_default_client_with_user_subject from test.commons import get_or_create_shield_information_barrier def testShieldInformationBarrierSegments(): - client: BoxClient = get_default_client_as_user(get_env_var('USER_ID')) + client: BoxClient = get_default_client_with_user_subject(get_env_var('USER_ID')) enterprise_id: str = get_env_var('ENTERPRISE_ID') barrier: ShieldInformationBarrier = get_or_create_shield_information_barrier( client, enterprise_id diff --git a/test/shield_information_barriers.py b/test/shield_information_barriers.py index 3261828..9f7acbb 100644 --- a/test/shield_information_barriers.py +++ b/test/shield_information_barriers.py @@ -14,13 +14,13 @@ from box_sdk_gen.internal.utils import get_env_var -from test.commons import get_default_client_as_user +from test.commons import get_default_client_with_user_subject from test.commons import get_or_create_shield_information_barrier def testShieldInformationBarriers(): - client: BoxClient = get_default_client_as_user(get_env_var('USER_ID')) + client: BoxClient = get_default_client_with_user_subject(get_env_var('USER_ID')) enterprise_id: str = get_env_var('ENTERPRISE_ID') barrier: ShieldInformationBarrier = get_or_create_shield_information_barrier( client, enterprise_id diff --git a/test/sign_templates.py b/test/sign_templates.py index 37212e5..512efea 100644 --- a/test/sign_templates.py +++ b/test/sign_templates.py @@ -8,17 +8,17 @@ from box_sdk_gen.internal.utils import get_env_var -from test.commons import get_default_client_as_user +from test.commons import get_default_client_with_user_subject def testGetSignTemplates(): - client: BoxClient = get_default_client_as_user(get_env_var('USER_ID')) + client: BoxClient = get_default_client_with_user_subject(get_env_var('USER_ID')) sign_templates: SignTemplates = client.sign_templates.get_sign_templates(limit=2) assert len(sign_templates.entries) >= 0 def testGetSignTemplate(): - client: BoxClient = get_default_client_as_user(get_env_var('USER_ID')) + client: BoxClient = get_default_client_with_user_subject(get_env_var('USER_ID')) sign_templates: SignTemplates = client.sign_templates.get_sign_templates(limit=2) assert len(sign_templates.entries) >= 0 if len(sign_templates.entries) > 0: diff --git a/test/storage_policicy_assignments.py b/test/storage_policicy_assignments.py index aeba5b0..f0704de 100644 --- a/test/storage_policicy_assignments.py +++ b/test/storage_policicy_assignments.py @@ -40,7 +40,7 @@ from box_sdk_gen.internal.utils import get_env_var -from test.commons import get_default_client_as_user +from test.commons import get_default_client_with_user_subject from box_sdk_gen.client import BoxClient @@ -76,7 +76,7 @@ def get_or_create_storage_policy_assignment( def testGetStoragePolicyAssignments(): - client: BoxClient = get_default_client_as_user(admin_user_id) + client: BoxClient = get_default_client_with_user_subject(admin_user_id) user_name: str = get_uuid() new_user: UserFull = client.users.create_user( user_name, is_platform_access_only=True diff --git a/test/storage_policies.py b/test/storage_policies.py index 8e2f9ad..45ff6db 100644 --- a/test/storage_policies.py +++ b/test/storage_policies.py @@ -8,13 +8,13 @@ from box_sdk_gen.internal.utils import get_env_var -from test.commons import get_default_client_as_user +from test.commons import get_default_client_with_user_subject user_id: str = get_env_var('USER_ID') def testGetStoragePolicies(): - client: BoxClient = get_default_client_as_user(user_id) + client: BoxClient = get_default_client_with_user_subject(user_id) storage_policies: StoragePolicies = client.storage_policies.get_storage_policies() storage_policy: StoragePolicy = storage_policies.entries[0] assert to_string(storage_policy.type) == 'storage_policy' diff --git a/test/terms_of_service_user_statuses.py b/test/terms_of_service_user_statuses.py index a1f7c46..7fd246c 100644 --- a/test/terms_of_service_user_statuses.py +++ b/test/terms_of_service_user_statuses.py @@ -26,7 +26,7 @@ from box_sdk_gen.schemas import TermsOfServiceUserStatuses -from test.commons import get_default_client_as_user +from test.commons import get_default_client_with_user_subject from test.commons import get_or_create_terms_of_services @@ -37,7 +37,7 @@ def testGetTermsOfServiceUserStatuses(): admin_user_id: str = get_env_var('USER_ID') - client: BoxClient = get_default_client_as_user(admin_user_id) + client: BoxClient = get_default_client_with_user_subject(admin_user_id) tos: TermsOfService = get_or_create_terms_of_services() user: UserFull = client.users.create_user( get_uuid(), diff --git a/test/workflows.py b/test/workflows.py index e44f7e9..9e3a25f 100644 --- a/test/workflows.py +++ b/test/workflows.py @@ -36,13 +36,15 @@ from test.commons import upload_new_file -from test.commons import get_default_client_as_user +from test.commons import get_default_client_with_user_subject client: BoxClient = get_default_client() def testWorkflows(): - admin_client: BoxClient = get_default_client_as_user(get_env_var('USER_ID')) + admin_client: BoxClient = get_default_client_with_user_subject( + get_env_var('USER_ID') + ) workflow_folder_id: str = get_env_var('WORKFLOW_FOLDER_ID') uploaded_files: Files = admin_client.uploads.upload_file( UploadFileAttributes( From ee8c418b5cbc6182a5b2d10f2360743a5238a6b6 Mon Sep 17 00:00:00 2001 From: box-sdk-build Date: Wed, 27 Mar 2024 04:42:13 -0700 Subject: [PATCH 2/2] chore: Update .codegen.json with commit hash of codegen and openapi spec --- .codegen.json | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/.codegen.json b/.codegen.json index c4cdcbc..55c990b 100644 --- a/.codegen.json +++ b/.codegen.json @@ -1 +1 @@ -{ "engineHash": "fa2d002", "specHash": "d50ab5f", "version": "0.6.3" } +{ "engineHash": "e12401a", "specHash": "d50ab5f", "version": "0.6.3" }