feat: add find app item for shared link endpoint (box/box-openapi#514) (#502)

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

Author: box-sdk-build

.codegen.json

@@ -1 +1 @@
-{ "engineHash": "8f5e41b", "specHash": "6782a0d", "version": "1.12.0" }
+{ "engineHash": "41feeaa", "specHash": "3dc6f70", "version": "1.12.0" }

box_sdk_gen/client.py

@@ -70,6 +70,8 @@
 
 from box_sdk_gen.managers.shared_links_web_links import SharedLinksWebLinksManager
 
+from box_sdk_gen.managers.shared_links_app_items import SharedLinksAppItemsManager
+
 from box_sdk_gen.managers.users import UsersManager
 
 from box_sdk_gen.managers.session_termination import SessionTerminationManager
@@ -289,6 +291,9 @@ def __init__(self, auth: Authentication, *, network_session: NetworkSession = No
         self.shared_links_web_links = SharedLinksWebLinksManager(
             auth=self.auth, network_session=self.network_session
         )
+        self.shared_links_app_items = SharedLinksAppItemsManager(
+            auth=self.auth, network_session=self.network_session
+        )
         self.users = UsersManager(auth=self.auth, network_session=self.network_session)
         self.session_termination = SessionTerminationManager(
             auth=self.auth, network_session=self.network_session

box_sdk_gen/managers/__init__.py

@@ -66,6 +66,8 @@
 
 from box_sdk_gen.managers.shared_links_web_links import *
 
+from box_sdk_gen.managers.shared_links_app_items import *
+
 from box_sdk_gen.managers.users import *
 
 from box_sdk_gen.managers.session_termination import *

box_sdk_gen/managers/shared_links_app_items.py

@@ -0,0 +1,84 @@
+from typing import Optional
+
+from typing import Dict
+
+from box_sdk_gen.internal.utils import to_string
+
+from box_sdk_gen.serialization.json import deserialize
+
+from box_sdk_gen.networking.fetch_options import ResponseFormat
+
+from box_sdk_gen.schemas.app_item import AppItem
+
+from box_sdk_gen.schemas.client_error import ClientError
+
+from box_sdk_gen.box.errors import BoxSDKError
+
+from box_sdk_gen.networking.auth import Authentication
+
+from box_sdk_gen.networking.network import NetworkSession
+
+from box_sdk_gen.networking.fetch_options import FetchOptions
+
+from box_sdk_gen.networking.fetch_response import FetchResponse
+
+from box_sdk_gen.internal.utils import prepare_params
+
+from box_sdk_gen.internal.utils import to_string
+
+from box_sdk_gen.internal.utils import ByteStream
+
+from box_sdk_gen.serialization.json import sd_to_json
+
+from box_sdk_gen.serialization.json import SerializedData
+
+
+class SharedLinksAppItemsManager:
+    def __init__(
+        self,
+        *,
+        auth: Optional[Authentication] = None,
+        network_session: NetworkSession = None
+    ):
+        if network_session is None:
+            network_session = NetworkSession()
+        self.auth = auth
+        self.network_session = network_session
+
+    def get_shared_item_app_items(
+        self, boxapi: str, *, extra_headers: Optional[Dict[str, Optional[str]]] = None
+    ) -> AppItem:
+        """
+                Returns the app item represented by a shared link.
+
+                The link can originate from the current enterprise or another.
+
+                :param boxapi: A header containing the shared link and optional password for the
+        shared link.
+
+        The format for this header is `shared_link=[link]&shared_link_password=[password]`
+                :type boxapi: str
+                :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 = {}
+        headers_map: Dict[str, str] = prepare_params(
+            {'boxapi': to_string(boxapi), **extra_headers}
+        )
+        response: FetchResponse = self.network_session.network_client.fetch(
+            FetchOptions(
+                url=''.join(
+                    [
+                        self.network_session.base_urls.base_url,
+                        '/2.0/shared_items#app_items',
+                    ]
+                ),
+                method='GET',
+                headers=headers_map,
+                response_format=ResponseFormat.JSON,
+                auth=self.auth,
+                network_session=self.network_session,
+            )
+        )
+        return deserialize(response.data, AppItem)

docs/README.md

@@ -49,6 +49,7 @@ the SDK are available by topic:
 - [Retention policy assignments](retention_policy_assignments.md)
 - [Search](search.md)
 - [Session termination](session_termination.md)
+- [Shared links app items](shared_links_app_items.md)
 - [Shared links files](shared_links_files.md)
 - [Shared links folders](shared_links_folders.md)
 - [Shared links web links](shared_links_web_links.md)

docs/shared_links_app_items.md

@@ -0,0 +1,30 @@
+# SharedLinksAppItemsManager
+
+- [Find app item for shared link](#find-app-item-for-shared-link)
+
+## Find app item for shared link
+
+Returns the app item represented by a shared link.
+
+The link can originate from the current enterprise or another.
+
+This operation is performed by calling function `get_shared_item_app_items`.
+
+See the endpoint docs at
+[API Reference](https://developer.box.com/reference/get-shared-items--app-items/).
+
+_Currently we don't have an example for calling `get_shared_item_app_items` in integration tests_
+
+### Arguments
+
+- boxapi `str`
+  - A header containing the shared link and optional password for the shared link. The format for this header is `shared_link=[link]&shared_link_password=[password]`
+- extra_headers `Optional[Dict[str, Optional[str]]]`
+  - Extra headers that will be included in the HTTP request.
+
+### Returns
+
+This function returns a value of type `AppItem`.
+
+Returns a full app item resource if the shared link is valid and
+the user has access to it.

docs/shared_links_web_links.md

@@ -50,7 +50,7 @@ user_client.shared_links_web_links.find_web_link_for_shared_link(
 
 This function returns a value of type `WebLink`.
 
-Returns a full file resource if the shared link is valid and
+Returns a full web link resource if the shared link is valid and
 the user has access to it.
 
 ## Get shared link for web link