feat(api): api update (#73)

Author: stainless-app[bot]

.stats.yml

@@ -1,2 +1,2 @@
-configured_endpoints: 10
-openapi_spec_url: https://storage.googleapis.com/stainless-sdk-openapi-specs/arcade-ai%2Farcade-engine-4a9af27c5fe900e731350e1d8b72743021977c7863dd41764803a996298dc5b5.yml
+configured_endpoints: 12
+openapi_spec_url: https://storage.googleapis.com/stainless-sdk-openapi-specs/arcade-ai%2Farcade-engine-d58cc9da58058f299ad7d32005d843f2216fc02ae21dc44b8038b94382ec7e2f.yml

README.md

@@ -31,12 +31,12 @@ client = Arcade(
     api_key=os.environ.get("ARCADE_API_KEY"),  # This is the default and can be omitted
 )
 
-response = client.tools.execute(
+execute_tool_response = client.tools.execute(
     tool_name="Google.ListEmails",
     inputs={"n_emails": 10},
     user_id="user@example.com",
 )
-print(response.invocation_id)
+print(execute_tool_response.id)
 ```
 
 While you can provide an `api_key` keyword argument,
@@ -59,12 +59,12 @@ client = AsyncArcade(
 
 
 async def main() -> None:
-    response = await client.tools.execute(
+    execute_tool_response = await client.tools.execute(
         tool_name="Google.ListEmails",
         inputs={"n_emails": 10},
         user_id="user@example.com",
     )
-    print(response.invocation_id)
+    print(execute_tool_response.id)
 
 
 asyncio.run(main())

api.md

@@ -1,7 +1,7 @@
 # Shared Types
 
 ```python
-from arcadepy.types import AuthorizationResponse, Error, ToolDefinition
+from arcadepy.types import AuthorizationResponse, Error
 ```
 
 # Auth
@@ -51,23 +51,34 @@ Types:
 from arcadepy.types import (
     AuthorizeToolRequest,
     ExecuteToolRequest,
-    Inputs,
-    Output,
-    Parameter,
-    Requirements,
-    Response,
+    ExecuteToolResponse,
     ResponseOutput,
-    ToolkitDefinition,
-    ValueSchema,
+    ToolExecution,
+    ToolExecutionAttempt,
+    ToolListResponse,
+    ToolGetResponse,
 )
 ```
 
 Methods:
 
-- <code title="get /v1/tools/list">client.tools.<a href="./src/arcadepy/resources/tools/tools.py">list</a>(\*\*<a href="src/arcadepy/types/tool_list_params.py">params</a>) -> <a href="./src/arcadepy/types/shared/tool_definition.py">SyncOffsetPage[ToolDefinition]</a></code>
+- <code title="get /v1/tools/list">client.tools.<a href="./src/arcadepy/resources/tools/tools.py">list</a>(\*\*<a href="src/arcadepy/types/tool_list_params.py">params</a>) -> <a href="./src/arcadepy/types/tool_list_response.py">SyncOffsetPage[ToolListResponse]</a></code>
 - <code title="post /v1/tools/authorize">client.tools.<a href="./src/arcadepy/resources/tools/tools.py">authorize</a>(\*\*<a href="src/arcadepy/types/tool_authorize_params.py">params</a>) -> <a href="./src/arcadepy/types/shared/authorization_response.py">AuthorizationResponse</a></code>
-- <code title="post /v1/tools/execute">client.tools.<a href="./src/arcadepy/resources/tools/tools.py">execute</a>(\*\*<a href="src/arcadepy/types/tool_execute_params.py">params</a>) -> <a href="./src/arcadepy/types/response.py">Response</a></code>
-- <code title="get /v1/tools/definition">client.tools.<a href="./src/arcadepy/resources/tools/tools.py">get</a>(\*\*<a href="src/arcadepy/types/tool_get_params.py">params</a>) -> <a href="./src/arcadepy/types/shared/tool_definition.py">ToolDefinition</a></code>
+- <code title="post /v1/tools/execute">client.tools.<a href="./src/arcadepy/resources/tools/tools.py">execute</a>(\*\*<a href="src/arcadepy/types/tool_execute_params.py">params</a>) -> <a href="./src/arcadepy/types/execute_tool_response.py">ExecuteToolResponse</a></code>
+- <code title="get /v1/tools/definition">client.tools.<a href="./src/arcadepy/resources/tools/tools.py">get</a>() -> <a href="./src/arcadepy/types/tool_get_response.py">ToolGetResponse</a></code>
+
+## Scheduled
+
+Types:
+
+```python
+from arcadepy.types.tools import ScheduledListResponse, ScheduledDetailsResponse
+```
+
+Methods:
+
+- <code title="get /v1/tools/scheduled">client.tools.scheduled.<a href="./src/arcadepy/resources/tools/scheduled.py">list</a>() -> <a href="./src/arcadepy/types/tools/scheduled_list_response.py">ScheduledListResponse</a></code>
+- <code title="get /v1/tools/scheduled/{id}">client.tools.scheduled.<a href="./src/arcadepy/resources/tools/scheduled.py">details</a>(id) -> <a href="./src/arcadepy/types/tools/scheduled_details_response.py">ScheduledDetailsResponse</a></code>
 
 ## Formatted
 

src/arcadepy/resources/auth.py

@@ -118,8 +118,7 @@ def start(
     def status(
         self,
         *,
-        authorization_id: str,
-        scopes: str | NotGiven = NOT_GIVEN,
+        id: str,
         wait: int | NotGiven = NOT_GIVEN,
         # Use the following arguments if you need to pass additional parameters to the API that aren't available via kwargs.
         # The extra values given here take precedence over values defined on the client or passed to this method.
@@ -135,9 +134,7 @@ def status(
         completed or the timeout is reached.
 
         Args:
-          authorization_id: Authorization ID
-
-          scopes: Scopes
+          id: Authorization ID
 
           wait: Timeout in seconds (max 59)
 
@@ -158,8 +155,7 @@ def status(
                 timeout=timeout,
                 query=maybe_transform(
                     {
-                        "authorization_id": authorization_id,
-                        "scopes": scopes,
+                        "id": id,
                         "wait": wait,
                     },
                     auth_status_params.AuthStatusParams,
@@ -296,8 +292,7 @@ async def start(
     async def status(
         self,
         *,
-        authorization_id: str,
-        scopes: str | NotGiven = NOT_GIVEN,
+        id: str,
         wait: int | NotGiven = NOT_GIVEN,
         # Use the following arguments if you need to pass additional parameters to the API that aren't available via kwargs.
         # The extra values given here take precedence over values defined on the client or passed to this method.
@@ -313,9 +308,7 @@ async def status(
         completed or the timeout is reached.
 
         Args:
-          authorization_id: Authorization ID
-
-          scopes: Scopes
+          id: Authorization ID
 
           wait: Timeout in seconds (max 59)
 
@@ -336,8 +329,7 @@ async def status(
                 timeout=timeout,
                 query=await async_maybe_transform(
                     {
-                        "authorization_id": authorization_id,
-                        "scopes": scopes,
+                        "id": id,
                         "wait": wait,
                     },
                     auth_status_params.AuthStatusParams,

src/arcadepy/resources/chat/completions.py

@@ -3,7 +3,6 @@
 from __future__ import annotations
 
 from typing import Dict, List, Iterable
-from typing_extensions import Literal
 
 import httpx
 
@@ -60,7 +59,7 @@ def create(
         n: int | NotGiven = NOT_GIVEN,
         parallel_tool_calls: bool | NotGiven = NOT_GIVEN,
         presence_penalty: float | NotGiven = NOT_GIVEN,
-        response_format: Literal["json_object", "text"] | NotGiven = NOT_GIVEN,
+        response_format: completion_create_params.ResponseFormat | NotGiven = NOT_GIVEN,
         seed: int | NotGiven = NOT_GIVEN,
         stop: List[str] | NotGiven = NOT_GIVEN,
         stream: bool | NotGiven = NOT_GIVEN,
@@ -176,7 +175,7 @@ async def create(
         n: int | NotGiven = NOT_GIVEN,
         parallel_tool_calls: bool | NotGiven = NOT_GIVEN,
         presence_penalty: float | NotGiven = NOT_GIVEN,
-        response_format: Literal["json_object", "text"] | NotGiven = NOT_GIVEN,
+        response_format: completion_create_params.ResponseFormat | NotGiven = NOT_GIVEN,
         seed: int | NotGiven = NOT_GIVEN,
         stop: List[str] | NotGiven = NOT_GIVEN,
         stream: bool | NotGiven = NOT_GIVEN,

src/arcadepy/resources/tools/__init__.py

@@ -16,8 +16,22 @@
     FormattedResourceWithStreamingResponse,
     AsyncFormattedResourceWithStreamingResponse,
 )
+from .scheduled import (
+    ScheduledResource,
+    AsyncScheduledResource,
+    ScheduledResourceWithRawResponse,
+    AsyncScheduledResourceWithRawResponse,
+    ScheduledResourceWithStreamingResponse,
+    AsyncScheduledResourceWithStreamingResponse,
+)
 
 __all__ = [
+    "ScheduledResource",
+    "AsyncScheduledResource",
+    "ScheduledResourceWithRawResponse",
+    "AsyncScheduledResourceWithRawResponse",
+    "ScheduledResourceWithStreamingResponse",
+    "AsyncScheduledResourceWithStreamingResponse",
     "FormattedResource",
     "AsyncFormattedResource",
     "FormattedResourceWithRawResponse",

src/arcadepy/resources/tools/formatted.py

@@ -59,8 +59,8 @@ def list(
         timeout: float | httpx.Timeout | None | NotGiven = NOT_GIVEN,
     ) -> SyncOffsetPage[object]:
         """
-        Returns a page of tools, optionally filtered by toolkit, formatted for a
-        specific provider
+        Returns a page of tools from the engine configuration, optionally filtered by
+        toolkit, formatted for a specific provider
 
         Args:
           format: Provider format
@@ -103,7 +103,6 @@ def list(
     def get(
         self,
         *,
-        tool_id: str,
         format: str | NotGiven = NOT_GIVEN,
         # Use the following arguments if you need to pass additional parameters to the API that aren't available via kwargs.
         # The extra values given here take precedence over values defined on the client or passed to this method.
@@ -116,8 +115,6 @@ def get(
         Returns the formatted tool specification for a specific tool, given a provider
 
         Args:
-          tool_id: Tool ID
-
           format: Provider format
 
           extra_headers: Send extra headers
@@ -135,13 +132,7 @@ def get(
                 extra_query=extra_query,
                 extra_body=extra_body,
                 timeout=timeout,
-                query=maybe_transform(
-                    {
-                        "tool_id": tool_id,
-                        "format": format,
-                    },
-                    formatted_get_params.FormattedGetParams,
-                ),
+                query=maybe_transform({"format": format}, formatted_get_params.FormattedGetParams),
             ),
             cast_to=object,
         )
@@ -182,8 +173,8 @@ def list(
         timeout: float | httpx.Timeout | None | NotGiven = NOT_GIVEN,
     ) -> AsyncPaginator[object, AsyncOffsetPage[object]]:
         """
-        Returns a page of tools, optionally filtered by toolkit, formatted for a
-        specific provider
+        Returns a page of tools from the engine configuration, optionally filtered by
+        toolkit, formatted for a specific provider
 
         Args:
           format: Provider format
@@ -226,7 +217,6 @@ def list(
     async def get(
         self,
         *,
-        tool_id: str,
         format: str | NotGiven = NOT_GIVEN,
         # Use the following arguments if you need to pass additional parameters to the API that aren't available via kwargs.
         # The extra values given here take precedence over values defined on the client or passed to this method.
@@ -239,8 +229,6 @@ async def get(
         Returns the formatted tool specification for a specific tool, given a provider
 
         Args:
-          tool_id: Tool ID
-
           format: Provider format
 
           extra_headers: Send extra headers
@@ -258,13 +246,7 @@ async def get(
                 extra_query=extra_query,
                 extra_body=extra_body,
                 timeout=timeout,
-                query=await async_maybe_transform(
-                    {
-                        "tool_id": tool_id,
-                        "format": format,
-                    },
-                    formatted_get_params.FormattedGetParams,
-                ),
+                query=await async_maybe_transform({"format": format}, formatted_get_params.FormattedGetParams),
             ),
             cast_to=object,
         )