test: remove hub tests temporarily (box/box-codegen#812) (#975)

* test: ExternalUsers API integration tests (box/box-codegen#799)

* chore: Update `.codegen.json` with commit hash of `codegen` and `openapi` spec [skip ci]

* chore: Update `.codegen.json` with commit hash of `codegen` and `openapi` spec [skip ci]

* chore: Update `.codegen.json` with commit hash of `codegen` and `openapi` spec [skip ci]

* test: remove hub tests temporarily (box/box-codegen#812)

Author: box-sdk-build

.codegen.json

@@ -1 +1 @@
-{ "engineHash": "3ba449c", "specHash": "ec8720b", "version": "0.1.0" }
+{ "engineHash": "dd00f3f", "specHash": "ec8720b", "version": "0.1.0" }

.github/workflows/build.yml

@@ -39,6 +39,7 @@ jobs:
           ENTERPRISE_ID: ${{ secrets.ENTERPRISE_ID }}
           BOX_FILE_REQUEST_ID: ${{ secrets.BOX_FILE_REQUEST_ID }}
           BOX_EXTERNAL_USER_EMAIL: ${{ secrets.BOX_EXTERNAL_USER_EMAIL }}
+          BOX_EXTERNAL_USER_ID: ${{ secrets.BOX_EXTERNAL_USER_ID }}
           APP_ITEM_ASSOCIATION_FILE_ID: ${{ secrets.APP_ITEM_ASSOCIATION_FILE_ID }}
           APP_ITEM_ASSOCIATION_FOLDER_ID: ${{ secrets.APP_ITEM_ASSOCIATION_FOLDER_ID }}
           WORKFLOW_FOLDER_ID: ${{ secrets.WORKFLOW_FOLDER_ID }}
@@ -78,6 +79,7 @@ jobs:
           ENTERPRISE_ID: ${{ secrets.ENTERPRISE_ID }}
           BOX_FILE_REQUEST_ID: ${{ secrets.BOX_FILE_REQUEST_ID }}
           BOX_EXTERNAL_USER_EMAIL: ${{ secrets.BOX_EXTERNAL_USER_EMAIL }}
+          BOX_EXTERNAL_USER_ID: ${{ secrets.BOX_EXTERNAL_USER_ID }}
           WORKFLOW_FOLDER_ID: ${{ secrets.WORKFLOW_FOLDER_ID }}
           APP_ITEM_ASSOCIATION_FILE_ID: ${{ secrets.APP_ITEM_ASSOCIATION_FILE_ID }}
           APP_ITEM_ASSOCIATION_FOLDER_ID: ${{ secrets.APP_ITEM_ASSOCIATION_FOLDER_ID }}

README.md

@@ -116,7 +116,7 @@ Now select `Authorization` and submit application to be reviewed by account admi
    download your app configuration settings as JSON.
 2. Encode configuration file to Base64, e.g. using command: `base64 -i path_to_json_file`
 3. Set environment variable: `JWT_CONFIG_BASE_64` with base64 encoded jwt configuration file
-4. Set environment variable: `BOX_FILE_REQUEST_ID` with ID of file request already created in the user account, `BOX_EXTERNAL_USER_EMAIL` with email of free external user which not belongs to any enterprise.
+4. Set environment variable: `BOX_FILE_REQUEST_ID` with ID of file request already created in the user account, `BOX_EXTERNAL_USER_EMAIL` with email of free external user which not belongs to any enterprise and `BOX_EXTERNAL_USER_ID` with its ID.
 5. Set environment variable: `WORKFLOW_FOLDER_ID` with the ID of the Relay workflow that deletes the file that triggered the workflow. The workflow should have a manual start to be able to start it from the API.
 6. Set environment variable: `APP_ITEM_ASSOCIATION_FILE_ID` to the ID of the file with associated app item and `APP_ITEM_ASSOCIATION_FOLDER_ID` to the ID of the folder with associated app item.
 7. Set environment variable: `APP_ITEM_SHARED_LINK` to the shared link associated with app item.

docs/external_users.md

@@ -12,7 +12,13 @@ This operation is performed by calling function `submit_job_to_delete_external_u
 See the endpoint docs at
 [API Reference](https://developer.box.com/reference/v2025.0/post-external-users-submit-delete-job/).
 
-_Currently we don't have an example for calling `submit_job_to_delete_external_users_v2025_r0` in integration tests_
+<!-- sample post_external_users_submit_delete_job_v2025.0 -->
+
+```python
+client.external_users.submit_job_to_delete_external_users_v2025_r0(
+    [UserReferenceV2025R0(id=get_env_var("BOX_EXTERNAL_USER_ID"))]
+)
+```
 
 ### Arguments
 

test/external_users.py

@@ -0,0 +1,53 @@
+from box_sdk_gen.client import BoxClient
+
+from box_sdk_gen.schemas.file_full import FileFull
+
+from box_sdk_gen.schemas.collaboration import Collaboration
+
+from box_sdk_gen.managers.user_collaborations import CreateCollaborationItem
+
+from box_sdk_gen.managers.user_collaborations import CreateCollaborationItemTypeField
+
+from box_sdk_gen.managers.user_collaborations import CreateCollaborationAccessibleBy
+
+from box_sdk_gen.managers.user_collaborations import (
+    CreateCollaborationAccessibleByTypeField,
+)
+
+from box_sdk_gen.managers.user_collaborations import CreateCollaborationRole
+
+from box_sdk_gen.schemas.v2025_r0.external_users_submit_delete_job_response_v2025_r0 import (
+    ExternalUsersSubmitDeleteJobResponseV2025R0,
+)
+
+from box_sdk_gen.schemas.v2025_r0.user_reference_v2025_r0 import UserReferenceV2025R0
+
+from test.commons import get_default_client_with_user_subject
+
+from test.commons import upload_new_file
+
+from box_sdk_gen.internal.utils import get_env_var
+
+from box_sdk_gen.internal.utils import get_uuid
+
+client: BoxClient = get_default_client_with_user_subject(get_env_var('USER_ID'))
+
+
+def testSubmitJobToDeleteExternalUsers():
+    file: FileFull = upload_new_file()
+    file_collaboration: Collaboration = client.user_collaborations.create_collaboration(
+        CreateCollaborationItem(type=CreateCollaborationItemTypeField.FILE, id=file.id),
+        CreateCollaborationAccessibleBy(
+            type=CreateCollaborationAccessibleByTypeField.USER,
+            id=get_env_var('BOX_EXTERNAL_USER_ID'),
+        ),
+        CreateCollaborationRole.EDITOR,
+    )
+    external_users_job_delete_response: ExternalUsersSubmitDeleteJobResponseV2025R0 = (
+        client.external_users.submit_job_to_delete_external_users_v2025_r0(
+            [UserReferenceV2025R0(id=get_env_var('BOX_EXTERNAL_USER_ID'))]
+        )
+    )
+    assert len(external_users_job_delete_response.entries) == 1
+    assert external_users_job_delete_response.entries[0].status == 202
+    client.files.delete_file_by_id(file.id)

test/hub_collaborations.py

@@ -22,32 +22,32 @@ commands =
   pytest {posargs} --disable-pytest-warnings --reruns 2
 deps = -rrequirements-test.txt
 allowlist_externals = pytest
-passenv = JWT_CONFIG_BASE_64,ADMIN_USER_ID,CLIENT_ID,CLIENT_SECRET,USER_ID,ENTERPRISE_ID,BOX_FILE_REQUEST_ID,BOX_EXTERNAL_USER_EMAIL,WORKFLOW_FOLDER_ID,APP_ITEM_ASSOCIATION_FILE_ID,APP_ITEM_ASSOCIATION_FOLDER_ID,APP_ITEM_SHARED_LINK,SLACK_AUTOMATION_USER_ID,SLACK_ORG_ID,SLACK_PARTNER_ITEM_ID
+passenv = JWT_CONFIG_BASE_64,ADMIN_USER_ID,CLIENT_ID,CLIENT_SECRET,USER_ID,ENTERPRISE_ID,BOX_FILE_REQUEST_ID,BOX_EXTERNAL_USER_EMAIL,BOX_EXTERNAL_USER_ID,WORKFLOW_FOLDER_ID,APP_ITEM_ASSOCIATION_FILE_ID,APP_ITEM_ASSOCIATION_FOLDER_ID,APP_ITEM_SHARED_LINK,SLACK_AUTOMATION_USER_ID,SLACK_ORG_ID,SLACK_PARTNER_ITEM_ID
 
 [testenv:pycodestyle]
-commands = 
+commands =
   pycodestyle --ignore=E501,W292 box_sdk_gen setup.py
   pycodestyle --ignore=E501,W292 test
-deps = 
+deps =
   pycodestyle
 
 [testenv:pylint]
 commands =
   pylint --rcfile=.pylintrc box_sdk_gen setup.py
   # pylint:disable W0621(redefined-outer-name) - Using py.test fixtures always breaks this rule.
   pylint --rcfile=.pylintrc test -d W0621 --ignore=mock_box
-deps = 
+deps =
   pylint
   -rrequirements-test.txt
 
 [testenv:coverage]
 basepython = python3.11
 commands =
     py.test --reruns 2 --cov box_sdk_gen --cov-report term-missing test/
-deps = 
+deps =
   coverage
   -rrequirements-test.txt
-passenv = JWT_CONFIG_BASE_64,ADMIN_USER_ID,CLIENT_ID,CLIENT_SECRET,USER_ID,ENTERPRISE_ID,BOX_FILE_REQUEST_ID,BOX_EXTERNAL_USER_EMAIL,WORKFLOW_FOLDER_ID,APP_ITEM_ASSOCIATION_FILE_ID,APP_ITEM_ASSOCIATION_FOLDER_ID,APP_ITEM_SHARED_LINK,SLACK_AUTOMATION_USER_ID,SLACK_ORG_ID,SLACK_PARTNER_ITEM_ID
+passenv = JWT_CONFIG_BASE_64,ADMIN_USER_ID,CLIENT_ID,CLIENT_SECRET,USER_ID,ENTERPRISE_ID,BOX_FILE_REQUEST_ID,BOX_EXTERNAL_USER_EMAIL,BOX_EXTERNAL_USER_ID,WORKFLOW_FOLDER_ID,APP_ITEM_ASSOCIATION_FILE_ID,APP_ITEM_ASSOCIATION_FOLDER_ID,APP_ITEM_SHARED_LINK,SLACK_AUTOMATION_USER_ID,SLACK_ORG_ID,SLACK_PARTNER_ITEM_ID
 
 [testenv:py311-build]
 description = Build the source and binary wheel packages for distribution.