docs: add docs for hubs (box/box-openapi#426)

.codegen.json

@@ -1 +1 @@
-{ "engineHash": "52af7c9", "specHash": "6c3dd22", "version": "1.0.0" }
+{ "engineHash": "52af7c9", "specHash": "cb70223", "version": "1.0.0" }

box_sdk_gen/managers/legal_hold_policy_assignments.py

@@ -315,6 +315,12 @@ def get_legal_hold_policy_assignment_file_on_hold(
                 of files held within the legacy architecture.
 
 
+                This endpoint does not support returning any content that is on hold due to
+
+
+                a Custodian collaborating on a Hub.
+
+
                 The `GET /legal_hold_policy_assignments?policy_id={id}` API can be used to
 
 

box_sdk_gen/managers/search.py

@@ -432,7 +432,7 @@ def search_for_content(
                 :type trash_content: Optional[SearchForContentTrashContent], optional
                 :param mdfilters: Limits the search results to any items for which the metadata matches the provided filter.
         This parameter is a list that specifies exactly **one** metadata template used to filter the search results.
-        It is required unless the `query` parameter is provided., defaults to None
+        The parameter is required unless the `query` parameter is provided., defaults to None
                 :type mdfilters: Optional[List[MetadataFilter]], optional
                 :param sort: Defines the order in which search results are returned. This API
         defaults to returning items by relevance unless this parameter is

box_sdk_gen/managers/sign_requests.py

@@ -275,7 +275,7 @@ def create_sign_request(
         :type is_phone_verification_required_to_view: Optional[bool], optional
         :param template_id: When a signature request is created from a template this field will indicate the id of that template., defaults to None
         :type template_id: Optional[str], optional
-        :param external_system_name: Used as an optional system name to appear in the signature log next to the signers who have been assigned an `embed_url_external_id`, defaults to None
+        :param external_system_name: Used as an optional system name to appear in the signature log next to the signers who have been assigned the `embed_url_external_id`., defaults to None
         :type external_system_name: Optional[str], optional
         :param extra_headers: Extra headers that will be included in the HTTP request., defaults to None
         :type extra_headers: Optional[Dict[str, Optional[str]]], optional

box_sdk_gen/schemas/sign_request.py

@@ -104,8 +104,10 @@ def __init__(
                 :param id: Box Sign request ID., defaults to None
                 :type id: Optional[str], optional
                 :param prepare_url: This URL is returned if `is_document_preparation_needed` is
-        set to `true` for Box Sign request. It is used to prepare a signature request
-        using the UI. The signature request is not sent until the preparation
+        set to `true` in the request. The parameter is used to prepare
+        the signature request
+        using the UI. The signature request is not
+        sent until the preparation
         phase is complete., defaults to None
                 :type prepare_url: Optional[str], optional
                 :param status: Describes the status of the signature request., defaults to None
@@ -142,7 +144,7 @@ def __init__(
                 :type is_phone_verification_required_to_view: Optional[bool], optional
                 :param template_id: When a signature request is created from a template this field will indicate the id of that template., defaults to None
                 :type template_id: Optional[str], optional
-                :param external_system_name: Used as an optional system name to appear in the signature log next to the signers who have been assigned an `embed_url_external_id`, defaults to None
+                :param external_system_name: Used as an optional system name to appear in the signature log next to the signers who have been assigned the `embed_url_external_id`., defaults to None
                 :type external_system_name: Optional[str], optional
         """
         super().__init__(

box_sdk_gen/schemas/sign_request_base.py

@@ -54,7 +54,7 @@ def __init__(
         :type is_phone_verification_required_to_view: Optional[bool], optional
         :param template_id: When a signature request is created from a template this field will indicate the id of that template., defaults to None
         :type template_id: Optional[str], optional
-        :param external_system_name: Used as an optional system name to appear in the signature log next to the signers who have been assigned an `embed_url_external_id`, defaults to None
+        :param external_system_name: Used as an optional system name to appear in the signature log next to the signers who have been assigned the `embed_url_external_id`., defaults to None
         :type external_system_name: Optional[str], optional
         """
         super().__init__(**kwargs)

box_sdk_gen/schemas/sign_request_create_request.py

@@ -78,7 +78,7 @@ def __init__(
         :type is_phone_verification_required_to_view: Optional[bool], optional
         :param template_id: When a signature request is created from a template this field will indicate the id of that template., defaults to None
         :type template_id: Optional[str], optional
-        :param external_system_name: Used as an optional system name to appear in the signature log next to the signers who have been assigned an `embed_url_external_id`, defaults to None
+        :param external_system_name: Used as an optional system name to appear in the signature log next to the signers who have been assigned the `embed_url_external_id`., defaults to None
         :type external_system_name: Optional[str], optional
         """
         super().__init__(

docs/legal_hold_policy_assignments.md

@@ -161,6 +161,9 @@ latest file version held in the newly developed architecture. The `GET
 /file_version_legal_holds` API can be used to fetch current and past versions
 of files held within the legacy architecture.
 
+This endpoint does not support returning any content that is on hold due to
+a Custodian collaborating on a Hub.
+
 The `GET /legal_hold_policy_assignments?policy_id={id}` API can be used to
 find a list of policy assignments for a given policy ID.
 

docs/search.md

@@ -113,7 +113,7 @@ client.search.search_for_content(
 - trash_content `Optional[SearchForContentTrashContent]`
   - Determines if the search should look in the trash for items. By default, this API only returns search results for items not currently in the trash (`non_trashed_only`). _ `trashed_only` - Only searches for items currently in the trash _ `non_trashed_only` - Only searches for items currently not in the trash \* `all_items` - Searches for both trashed and non-trashed items.
 - mdfilters `Optional[List[MetadataFilter]]`
-  - Limits the search results to any items for which the metadata matches the provided filter. This parameter is a list that specifies exactly **one** metadata template used to filter the search results. It is required unless the `query` parameter is provided.
+  - Limits the search results to any items for which the metadata matches the provided filter. This parameter is a list that specifies exactly **one** metadata template used to filter the search results. The parameter is required unless the `query` parameter is provided.
 - sort `Optional[SearchForContentSort]`
   - Defines the order in which search results are returned. This API defaults to returning items by relevance unless this parameter is explicitly specified. _ `relevance` (default) returns the results sorted by relevance to the query search term. The relevance is based on the occurrence of the search term in the items name, description, content, and additional properties. _ `modified_at` returns the results ordered in descending order by date at which the item was last modified.
 - direction `Optional[SearchForContentDirection]`

docs/sign_requests.md

@@ -178,7 +178,7 @@ client.sign_requests.create_sign_request(
 - template_id `Optional[str]`
   - When a signature request is created from a template this field will indicate the id of that template.
 - external_system_name `Optional[str]`
-  - Used as an optional system name to appear in the signature log next to the signers who have been assigned an `embed_url_external_id`
+  - Used as an optional system name to appear in the signature log next to the signers who have been assigned the `embed_url_external_id`.
 - extra_headers `Optional[Dict[str, Optional[str]]]`
   - Extra headers that will be included in the HTTP request.