feat: Add Box Sign shared requests (box/box-openapi#504) (#453)

Co-authored-by: box-sdk-build <[email protected]>

Author: box-sdk-build

.codegen.json

@@ -1 +1 @@
-{ "engineHash": "b5ed925", "specHash": "99792c6", "version": "1.10.0" }
+{ "engineHash": "b5ed925", "specHash": "3dc3f1e", "version": "1.10.0" }

box_sdk_gen/managers/sign_requests.py

@@ -185,6 +185,8 @@ def get_sign_requests(
         *,
         marker: Optional[str] = None,
         limit: Optional[int] = None,
+        senders: Optional[List[str]] = None,
+        shared_requests: Optional[bool] = None,
         extra_headers: Optional[Dict[str, Optional[str]]] = None
     ) -> SignRequests:
         """
@@ -199,13 +201,26 @@ def get_sign_requests(
                 :type marker: Optional[str], optional
                 :param limit: The maximum number of items to return per page., defaults to None
                 :type limit: Optional[int], optional
+                :param senders: A list of sender emails to filter the signature requests by sender.
+        If provided, `shared_requests` must be set to `true`., defaults to None
+                :type senders: Optional[List[str]], optional
+                :param shared_requests: If set to `true`, only includes requests that user is not an owner,
+        but user is a collaborator. Collaborator access is determined by the
+        user access level of the sign files of the request.
+        Default is `false`. Must be set to `true` if `senders` are provided., defaults to None
+                :type shared_requests: Optional[bool], 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
         """
         if extra_headers is None:
             extra_headers = {}
         query_params_map: Dict[str, str] = prepare_params(
-            {'marker': to_string(marker), 'limit': to_string(limit)}
+            {
+                'marker': to_string(marker),
+                'limit': to_string(limit),
+                'senders': to_string(senders),
+                'shared_requests': to_string(shared_requests),
+            }
         )
         headers_map: Dict[str, str] = prepare_params({**extra_headers})
         response: FetchResponse = self.network_session.network_client.fetch(

box_sdk_gen/schemas/sign_request.py

@@ -78,6 +78,9 @@ def __init__(
         sign_files: Optional[SignRequestSignFilesField] = None,
         auto_expire_at: Optional[DateTime] = None,
         parent_folder: Optional[FolderMini] = None,
+        collaborator_level: Optional[str] = None,
+        sender_email: Optional[str] = None,
+        sender_id: Optional[int] = None,
         is_document_preparation_needed: Optional[bool] = None,
         redirect_url: Optional[str] = None,
         declined_redirect_url: Optional[str] = None,
@@ -119,6 +122,12 @@ def __init__(
                 :type sign_files: Optional[SignRequestSignFilesField], optional
                 :param auto_expire_at: Uses `days_valid` to calculate the date and time, in GMT, the sign request will expire if unsigned., defaults to None
                 :type auto_expire_at: Optional[DateTime], optional
+                :param collaborator_level: The collaborator level of the user to the sign request. Values can include "owner", "editor", and "viewer", defaults to None
+                :type collaborator_level: Optional[str], optional
+                :param sender_email: The email address of the sender of the sign request., defaults to None
+                :type sender_email: Optional[str], optional
+                :param sender_id: The user ID of the sender of the sign request., defaults to None
+                :type sender_id: Optional[int], optional
                 :param is_document_preparation_needed: Indicates if the sender should receive a `prepare_url` in the response to complete document preparation using the UI., defaults to None
                 :type is_document_preparation_needed: Optional[bool], optional
                 :param redirect_url: When specified, the signature request will be redirected to this url when a document is signed., defaults to None
@@ -173,3 +182,6 @@ def __init__(
         self.sign_files = sign_files
         self.auto_expire_at = auto_expire_at
         self.parent_folder = parent_folder
+        self.collaborator_level = collaborator_level
+        self.sender_email = sender_email
+        self.sender_id = sender_id

docs/sign_requests.md

@@ -109,6 +109,10 @@ client.sign_requests.get_sign_requests()
   - Defines the position marker at which to begin returning results. This is used when paginating using marker-based pagination. This requires `usemarker` to be set to `true`.
 - limit `Optional[int]`
   - The maximum number of items to return per page.
+- senders `Optional[List[str]]`
+  - A list of sender emails to filter the signature requests by sender. If provided, `shared_requests` must be set to `true`.
+- shared_requests `Optional[bool]`
+  - If set to `true`, only includes requests that user is not an owner, but user is a collaborator. Collaborator access is determined by the user access level of the sign files of the request. Default is `false`. Must be set to `true` if `senders` are provided.
 - extra_headers `Optional[Dict[str, Optional[str]]]`
   - Extra headers that will be included in the HTTP request.