SDK regeneration

sayari-analytics · Sep 27, 2024 · cc4a750 · cc4a750
1 parent e0fd073
commit cc4a750
Show file tree

Hide file tree

Showing 3 changed files with 81 additions and 347 deletions.
diff --git a/reference.md b/reference.md
@@ -4875,7 +4875,7 @@ client = Sayari(
     client_secret="YOUR_CLIENT_SECRET",
 )
 client.traversal.shortest_path(
-    entities="string",
+    entities="H1y25N5ymnFyZ-q9Lpwm_g&entities=xthsA_jQuKn3GW8-9ILQqg",
 )
 
 ```
@@ -4892,7 +4892,7 @@ client.traversal.shortest_path(
 <dl>
 <dd>
 
-**entities:** `typing.Union[str, typing.Sequence[str]]` 
+**entities:** `typing.Union[str, typing.Sequence[str]]` — A list of Sayari entity IDs specifying the source and target entities for the shortest path calculation. The list must contain exactly two entity IDs The first entity ID represents the source.The second entity ID represents the target.
 
 </dd>
 </dl>

diff --git a/src/sayari/traversal/client.py b/src/sayari/traversal/client.py
@@ -1127,6 +1127,7 @@ def shortest_path(
         Parameters
         ----------
         entities : typing.Union[str, typing.Sequence[str]]
+            A list of Sayari entity IDs specifying the source and target entities for the shortest path calculation. The list must contain exactly two entity IDs The first entity ID represents the source.The second entity ID represents the target.
 
         request_options : typing.Optional[RequestOptions]
             Request-specific configuration.
@@ -1144,7 +1145,7 @@ def shortest_path(
             client_secret="YOUR_CLIENT_SECRET",
         )
         client.traversal.shortest_path(
-            entities="string",
+            entities="H1y25N5ymnFyZ-q9Lpwm_g&entities=xthsA_jQuKn3GW8-9ILQqg",
         )
         """
         _response = self._client_wrapper.httpx_client.request(
@@ -2378,6 +2379,7 @@ async def shortest_path(
         Parameters
         ----------
         entities : typing.Union[str, typing.Sequence[str]]
+            A list of Sayari entity IDs specifying the source and target entities for the shortest path calculation. The list must contain exactly two entity IDs The first entity ID represents the source.The second entity ID represents the target.
 
         request_options : typing.Optional[RequestOptions]
             Request-specific configuration.
@@ -2400,7 +2402,7 @@ async def shortest_path(
 
         async def main() -> None:
             await client.traversal.shortest_path(
-                entities="string",
+                entities="H1y25N5ymnFyZ-q9Lpwm_g&entities=xthsA_jQuKn3GW8-9ILQqg",
             )