codegen output f4654ffd7e7c4862b8046f4745120401

.gitignore

@@ -0,0 +1,160 @@
+# Byte-compiled / optimized / DLL files
+__pycache__/
+*.py[cod]
+*$py.class
+
+# C extensions
+*.so
+
+# Distribution / packaging
+.Python
+build/
+develop-eggs/
+dist/
+downloads/
+eggs/
+.eggs/
+lib/
+lib64/
+parts/
+sdist/
+var/
+wheels/
+share/python-wheels/
+*.egg-info/
+.installed.cfg
+*.egg
+MANIFEST
+
+# PyInstaller
+#  Usually these files are written by a python script from a template
+#  before PyInstaller builds the exe, so as to inject date/other infos into it.
+*.manifest
+*.spec
+
+# Installer logs
+pip-log.txt
+pip-delete-this-directory.txt
+
+# Unit test / coverage reports
+htmlcov/
+.tox/
+.nox/
+.coverage
+.coverage.*
+.cache
+nosetests.xml
+coverage.xml
+*.cover
+*.py,cover
+.hypothesis/
+.pytest_cache/
+cover/
+
+# Translations
+*.mo
+*.pot
+
+# Django stuff:
+*.log
+local_settings.py
+db.sqlite3
+db.sqlite3-journal
+
+# Flask stuff:
+instance/
+.webassets-cache
+
+# Scrapy stuff:
+.scrapy
+
+# Sphinx documentation
+docs/_build/
+
+# PyBuilder
+.pybuilder/
+target/
+
+# Jupyter Notebook
+.ipynb_checkpoints
+
+# IPython
+profile_default/
+ipython_config.py
+
+# pyenv
+#   For a library or package, you might want to ignore these files since the code is
+#   intended to run in multiple environments; otherwise, check them in:
+# .python-version
+
+# pipenv
+#   According to pypa/pipenv#598, it is recommended to include Pipfile.lock in version control.
+#   However, in case of collaboration, if having platform-specific dependencies or dependencies
+#   having no cross-platform support, pipenv may install dependencies that don't work, or not
+#   install all needed dependencies.
+#Pipfile.lock
+
+# poetry
+#   Similar to Pipfile.lock, it is generally recommended to include poetry.lock in version control.
+#   This is especially recommended for binary packages to ensure reproducibility, and is more
+#   commonly ignored for libraries.
+#   https://python-poetry.org/docs/basic-usage/#commit-your-poetrylock-file-to-version-control
+#poetry.lock
+
+# pdm
+#   Similar to Pipfile.lock, it is generally recommended to include pdm.lock in version control.
+#pdm.lock
+#   pdm stores project-wide configurations in .pdm.toml, but it is recommended to not include it
+#   in version control.
+#   https://pdm.fming.dev/#use-with-ide
+.pdm.toml
+
+# PEP 582; used by e.g. github.com/David-OConnor/pyflow and github.com/pdm-project/pdm
+__pypackages__/
+
+# Celery stuff
+celerybeat-schedule
+celerybeat.pid
+
+# SageMath parsed files
+*.sage.py
+
+# Environments
+.env
+.venv
+env/
+venv/
+ENV/
+env.bak/
+venv.bak/
+
+# Spyder project settings
+.spyderproject
+.spyproject
+
+# Rope project settings
+.ropeproject
+
+# mkdocs documentation
+/site
+
+# mypy
+.mypy_cache/
+.dmypy.json
+dmypy.json
+
+# Pyre type checker
+.pyre/
+
+# pytype static type analyzer
+.pytype/
+
+# Cython debug symbols
+cython_debug/
+
+# PyCharm
+#  JetBrains specific template is maintained in a separate JetBrains.gitignore that can
+#  be found at https://github.com/github/gitignore/blob/main/Global/JetBrains.gitignore
+#  and can be added to the global gitignore or merged into this file.  For a more nuclear
+#  option (not recommended) you can uncomment the following to ignore the entire idea folder.
+#.idea/

box_sdk_gen/managers/memberships.py

@@ -135,7 +135,7 @@ def create_group_membership(self, user: CreateGroupMembershipUserArg, group: Cre
             on members with a role of `member`.
             Setting these permissions overwrites the default
             access levels of an admin.
-            Specifying a value of "null" for this object will disable
+            Specifying a value of "null" for this object will deactivate
             all configurable permissions. Specifying permissions will set
             them accordingly, omitted permissions will be enabled by default.
         :type configurable_permissions: Optional[Dict[str, bool]], optional
@@ -207,7 +207,7 @@ def update_group_membership_by_id(self, group_membership_id: str, role: Optional
             on members with a role of `member`.
             Setting these permissions overwrites the default
             access levels of an admin.
-            Specifying a value of "null" for this object will disable
+            Specifying a value of "null" for this object will deactivate
             all configurable permissions. Specifying permissions will set
             them accordingly, omitted permissions will be enabled by default.
         :type configurable_permissions: Optional[Dict[str, bool]], optional

box_sdk_gen/managers/storage_policies.py

@@ -33,6 +33,12 @@ def __init__(self, auth: Optional[Authentication] = None, network_session: Optio
     def get_storage_policies(self, fields: Optional[str] = None, marker: Optional[str] = None, limit: Optional[int] = None, extra_headers: Optional[Dict[str, Optional[str]]] = None) -> StoragePolicies:
         """
         Fetches all the storage policies in the enterprise.
+
+        Only a Primary Admin can access this endpoint. The user
+
+
+        needs to generate a token for an account to authenticate this request.
+
         :param fields: A comma-separated list of attributes to include in the
             response. This can be used to request fields that are
             not normally returned in a standard response.
@@ -59,7 +65,7 @@ def get_storage_policies(self, fields: Optional[str] = None, marker: Optional[st
         return StoragePolicies.from_dict(json.loads(response.text))
     def get_storage_policy_by_id(self, storage_policy_id: str, extra_headers: Optional[Dict[str, Optional[str]]] = None) -> StoragePolicy:
         """
-        Fetches a specific storage policy.
+        Fetches a specific storage policy. Only a Primary Admin can access this endpoint. The user needs to generate a token for an account to authenticate this request.
         :param storage_policy_id: The ID of the storage policy.
             Example: "34342"
         :type storage_policy_id: str

box_sdk_gen/managers/storage_policy_assignments.py

@@ -89,6 +89,12 @@ def __init__(self, auth: Optional[Authentication] = None, network_session: Optio
     def get_storage_policy_assignments(self, resolved_for_type: GetStoragePolicyAssignmentsResolvedForTypeArg, resolved_for_id: str, marker: Optional[str] = None, extra_headers: Optional[Dict[str, Optional[str]]] = None) -> StoragePolicyAssignments:
         """
         Fetches all the storage policy assignment for an enterprise or user.
+
+        Only a Primary Admin can access this endpoint. The user
+
+
+        needs to generate a token for an account to authenticate this request.
+
         :param resolved_for_type: The target type to return assignments for
         :type resolved_for_type: GetStoragePolicyAssignmentsResolvedForTypeArg
         :param resolved_for_id: The ID of the user or enterprise to return assignments for
@@ -109,6 +115,12 @@ def get_storage_policy_assignments(self, resolved_for_type: GetStoragePolicyAssi
     def create_storage_policy_assignment(self, storage_policy: CreateStoragePolicyAssignmentStoragePolicyArg, assigned_to: CreateStoragePolicyAssignmentAssignedToArg, extra_headers: Optional[Dict[str, Optional[str]]] = None) -> StoragePolicyAssignment:
         """
         Creates a storage policy assignment for an enterprise or user.
+
+        Only a Primary Admin can access this endpoint. The user
+
+
+        needs to generate a token for an account to authenticate this request.
+
         :param storage_policy: The storage policy to assign to the user or
             enterprise
         :type storage_policy: CreateStoragePolicyAssignmentStoragePolicyArg
@@ -126,7 +138,7 @@ def create_storage_policy_assignment(self, storage_policy: CreateStoragePolicyAs
         return StoragePolicyAssignment.from_dict(json.loads(response.text))
     def get_storage_policy_assignment_by_id(self, storage_policy_assignment_id: str, extra_headers: Optional[Dict[str, Optional[str]]] = None) -> StoragePolicyAssignment:
         """
-        Fetches a specific storage policy assignment.
+        Fetches a specific storage policy assignment. Only a Primary Admin can access this endpoint. The user needs to generate a token for an account to authenticate this request.
         :param storage_policy_assignment_id: The ID of the storage policy assignment.
             Example: "932483"
         :type storage_policy_assignment_id: str
@@ -140,7 +152,7 @@ def get_storage_policy_assignment_by_id(self, storage_policy_assignment_id: str,
         return StoragePolicyAssignment.from_dict(json.loads(response.text))
     def update_storage_policy_assignment_by_id(self, storage_policy_assignment_id: str, storage_policy: UpdateStoragePolicyAssignmentByIdStoragePolicyArg, extra_headers: Optional[Dict[str, Optional[str]]] = None) -> StoragePolicyAssignment:
         """
-        Updates a specific storage policy assignment.
+        Updates a specific storage policy assignment. Only a Primary Admin can access this endpoint. The user needs to generate a token for an account to authenticate this request.
         :param storage_policy_assignment_id: The ID of the storage policy assignment.
             Example: "932483"
         :type storage_policy_assignment_id: str
@@ -174,6 +186,12 @@ def delete_storage_policy_assignment_by_id(self, storage_policy_assignment_id: s
 
         twice per user in a 24 hour time frame.
 
+
+        Only a Primary Admin can access this endpoint. The user
+
+
+        needs to generate a token for an account to authenticate this request.
+
         :param storage_policy_assignment_id: The ID of the storage policy assignment.
             Example: "932483"
         :type storage_policy_assignment_id: str

box_sdk_gen/schemas.py

@@ -7713,7 +7713,7 @@ def __init__(self, type: Optional[SignRequestSignerSignerDecisionFieldTypeField]
         self.finalized_at = finalized_at
 
 class SignRequestSigner(SignRequestCreateSigner):
-    def __init__(self, email: str, has_viewed_document: Optional[bool] = None, signer_decision: Optional[SignRequestSignerSignerDecisionField] = None, inputs: Optional[List[SignRequestSignerInput]] = None, embed_url: Optional[str] = None, role: Optional[SignRequestCreateSignerRoleField] = None, is_in_person: Optional[bool] = None, order: Optional[int] = None, embed_url_external_user_id: Optional[str] = None, redirect_url: Optional[str] = None, declined_redirect_url: Optional[str] = None, login_required: Optional[bool] = None, verification_phone_number: Optional[str] = None, password: Optional[str] = None, **kwargs):
+    def __init__(self, email: str, has_viewed_document: Optional[bool] = None, signer_decision: Optional[SignRequestSignerSignerDecisionField] = None, inputs: Optional[List[SignRequestSignerInput]] = None, embed_url: Optional[str] = None, iframeable_embed_url: Optional[str] = None, role: Optional[SignRequestCreateSignerRoleField] = None, is_in_person: Optional[bool] = None, order: Optional[int] = None, embed_url_external_user_id: Optional[str] = None, redirect_url: Optional[str] = None, declined_redirect_url: Optional[str] = None, login_required: Optional[bool] = None, verification_phone_number: Optional[str] = None, password: Optional[str] = None, **kwargs):
         """
         :param email: Email address of the signer
         :type email: str
@@ -7723,6 +7723,13 @@ def __init__(self, email: str, has_viewed_document: Optional[bool] = None, signe
         :type signer_decision: Optional[SignRequestSignerSignerDecisionField], optional
         :param embed_url: URL to direct a signer to for signing
         :type embed_url: Optional[str], optional
+        :param iframeable_embed_url: This URL is specifically designed for
+            signing documents within an HTML `iframe` tag.
+            It will be returned in the response
+            only if the `embed_url_external_user_id`
+            parameter was passed in the
+            `create sign request` call.
+        :type iframeable_embed_url: Optional[str], optional
         :param role: Defines the role of the signer in the sign request. A `signer`
             must sign the document and an `approver` must approve the document. A
             `final_copy_reader` only receives the final signed document and signing
@@ -7765,6 +7772,7 @@ def __init__(self, email: str, has_viewed_document: Optional[bool] = None, signe
         self.signer_decision = signer_decision
         self.inputs = inputs
         self.embed_url = embed_url
+        self.iframeable_embed_url = iframeable_embed_url
 
 class SignRequestBase(BaseObject):
     def __init__(self, parent_folder: FolderMini, is_document_preparation_needed: Optional[bool] = None, redirect_url: Optional[str] = None, declined_redirect_url: Optional[str] = None, are_text_signatures_enabled: Optional[bool] = None, email_subject: Optional[str] = None, email_message: Optional[str] = None, are_reminders_enabled: Optional[bool] = None, name: Optional[str] = None, prefill_tags: Optional[List[SignRequestPrefillTag]] = None, days_valid: Optional[int] = None, external_id: Optional[str] = None, is_phone_verification_required_to_view: Optional[bool] = None, template_id: Optional[str] = None, **kwargs):

docs/email_aliases.md

@@ -15,7 +15,10 @@ This operation is performed by calling function `get_user_email_aliases`.
 See the endpoint docs at
 [API Reference](https://developer.box.com/reference/get-users-id-email-aliases/).
 
-*Currently we don't have an example for calling `get_user_email_aliases` in integration tests*
+<!-- sample get_users_id_email_aliases -->
+```python
+client.email_aliases.get_user_email_aliases(user_id=new_user.id)
+```
 
 ### Arguments
 
@@ -41,7 +44,10 @@ This operation is performed by calling function `create_user_email_alias`.
 See the endpoint docs at
 [API Reference](https://developer.box.com/reference/post-users-id-email-aliases/).
 
-*Currently we don't have an example for calling `create_user_email_alias` in integration tests*
+<!-- sample post_users_id_email_aliases -->
+```python
+client.email_aliases.create_user_email_alias(user_id=new_user.id, email=new_alias_email)
+```
 
 ### Arguments
 
@@ -69,7 +75,10 @@ This operation is performed by calling function `delete_user_email_alias_by_id`.
 See the endpoint docs at
 [API Reference](https://developer.box.com/reference/delete-users-id-email-aliases-id/).
 
-*Currently we don't have an example for calling `delete_user_email_alias_by_id` in integration tests*
+<!-- sample delete_users_id_email_aliases_id -->
+```python
+client.email_aliases.delete_user_email_alias_by_id(user_id=new_user.id, email_alias_id=new_alias.id)
+```
 
 ### Arguments
 

docs/memberships.md

@@ -104,7 +104,7 @@ client.memberships.create_group_membership(user=user, group=group)
 - role `Optional[CreateGroupMembershipRoleArg]`
   - The role of the user in the group.
 - configurable_permissions `Optional[Dict[str, bool]]`
-  - Custom configuration for the permissions an admin if a group will receive. This option has no effect on members with a role of `member`.  Setting these permissions overwrites the default access levels of an admin.  Specifying a value of "null" for this object will disable all configurable permissions. Specifying permissions will set them accordingly, omitted permissions will be enabled by default.
+  - Custom configuration for the permissions an admin if a group will receive. This option has no effect on members with a role of `member`.  Setting these permissions overwrites the default access levels of an admin.  Specifying a value of "null" for this object will deactivate all configurable permissions. Specifying permissions will set them accordingly, omitted permissions will be enabled by default.
 - fields `Optional[str]`
   - A comma-separated list of attributes to include in the response. This can be used to request fields that are not normally returned in a standard response.  Be aware that specifying this parameter will have the effect that none of the standard fields are returned in the response unless explicitly specified, instead only fields for the mini representation are returned, additional to the fields requested.
 - extra_headers `Optional[Dict[str, Optional[str]]]`
@@ -174,7 +174,7 @@ client.memberships.update_group_membership_by_id(group_membership_id=group_membe
 - role `Optional[UpdateGroupMembershipByIdRoleArg]`
   - The role of the user in the group.
 - configurable_permissions `Optional[Dict[str, bool]]`
-  - Custom configuration for the permissions an admin if a group will receive. This option has no effect on members with a role of `member`.  Setting these permissions overwrites the default access levels of an admin.  Specifying a value of "null" for this object will disable all configurable permissions. Specifying permissions will set them accordingly, omitted permissions will be enabled by default.
+  - Custom configuration for the permissions an admin if a group will receive. This option has no effect on members with a role of `member`.  Setting these permissions overwrites the default access levels of an admin.  Specifying a value of "null" for this object will deactivate all configurable permissions. Specifying permissions will set them accordingly, omitted permissions will be enabled by default.
 - fields `Optional[str]`
   - A comma-separated list of attributes to include in the response. This can be used to request fields that are not normally returned in a standard response.  Be aware that specifying this parameter will have the effect that none of the standard fields are returned in the response unless explicitly specified, instead only fields for the mini representation are returned, additional to the fields requested.
 - extra_headers `Optional[Dict[str, Optional[str]]]`