feat(api): api update

Author: stainless-app[bot]

.stats.yml

@@ -1,4 +1,4 @@
 configured_endpoints: 105
-openapi_spec_url: https://storage.googleapis.com/stainless-sdk-openapi-specs/datamini%2Fasktable-62931b1d6bd2cf04f9887c2779e09de89d43cf8ea9323dbbe36b52e5fad4472f.yml
-openapi_spec_hash: a4508a681714884c7d56077656fef3c4
+openapi_spec_url: https://storage.googleapis.com/stainless-sdk-openapi-specs/datamini%2Fasktable-9b3127f357a8502fba6b108515b97e5acb04e50cb2f933c654c05532b6a5ab19.yml
+openapi_spec_hash: aa447a038dd69ccbad1eadad7204d5ad
 config_hash: acdf4142177ed1932c2d82372693f811

README.md

@@ -191,24 +191,6 @@ response = client.sys.projects.api_keys.create_token(
 print(response.chat_role)
 ```
 
-## File uploads
-
-Request parameters that correspond to file uploads can be passed as `bytes`, or a [`PathLike`](https://docs.python.org/3/library/os.html#os.PathLike) instance or a tuple of `(filename, contents, media type)`.
-
-```python
-from pathlib import Path
-from asktable import Asktable
-
-client = Asktable()
-
-client.datasources.add_file(
-    datasource_id="datasource_id",
-    file=Path("/path/to/file"),
-)
-```
-
-The async client uses the exact same interface. If you pass a [`PathLike`](https://docs.python.org/3/library/os.html#os.PathLike) instance, the file contents will be read asynchronously automatically.
-
 ## Handling errors
 
 When the library is unable to connect to the API (for example, due to network connection problems or a timeout), a subclass of `asktable.APIConnectionError` is raised.

api.md

@@ -11,7 +11,13 @@ from asktable.types import Policy
 Types:
 
 ```python
-from asktable.types.sys import APIKey, Project, ProjectModelGroupsResponse
+from asktable.types.sys import (
+    APIKey,
+    Project,
+    ProjectExportResponse,
+    ProjectImportResponse,
+    ProjectModelGroupsResponse,
+)
 ```
 
 Methods:
@@ -21,24 +27,28 @@ Methods:
 - <code title="patch /v1/sys/projects/{project_id}">client.sys.projects.<a href="./src/asktable/resources/sys/projects/projects.py">update</a>(project_id, \*\*<a href="src/asktable/types/sys/project_update_params.py">params</a>) -> <a href="./src/asktable/types/sys/project.py">Project</a></code>
 - <code title="get /v1/sys/projects">client.sys.projects.<a href="./src/asktable/resources/sys/projects/projects.py">list</a>(\*\*<a href="src/asktable/types/sys/project_list_params.py">params</a>) -> <a href="./src/asktable/types/sys/project.py">SyncPage[Project]</a></code>
 - <code title="delete /v1/sys/projects/{project_id}">client.sys.projects.<a href="./src/asktable/resources/sys/projects/projects.py">delete</a>(project_id) -> object</code>
-- <code title="post /v1/sys/projects/{project_id}/export">client.sys.projects.<a href="./src/asktable/resources/sys/projects/projects.py">export</a>(project_id) -> object</code>
-- <code title="post /v1/sys/projects/import">client.sys.projects.<a href="./src/asktable/resources/sys/projects/projects.py">import\_</a>(\*\*<a href="src/asktable/types/sys/project_import_params.py">params</a>) -> object</code>
+- <code title="post /v1/sys/projects/{project_id}/export">client.sys.projects.<a href="./src/asktable/resources/sys/projects/projects.py">export</a>(project_id) -> <a href="./src/asktable/types/sys/project_export_response.py">ProjectExportResponse</a></code>
+- <code title="post /v1/sys/projects/import">client.sys.projects.<a href="./src/asktable/resources/sys/projects/projects.py">import\_</a>(\*\*<a href="src/asktable/types/sys/project_import_params.py">params</a>) -> <a href="./src/asktable/types/sys/project_import_response.py">ProjectImportResponse</a></code>
 - <code title="get /v1/sys/projects/model-groups">client.sys.projects.<a href="./src/asktable/resources/sys/projects/projects.py">model_groups</a>() -> <a href="./src/asktable/types/sys/project_model_groups_response.py">ProjectModelGroupsResponse</a></code>
 
 ### APIKeys
 
 Types:
 
 ```python
-from asktable.types.sys.projects import APIKeyCreateResponse, APIKeyListResponse
+from asktable.types.sys.projects import (
+    APIKeyCreateResponse,
+    APIKeyListResponse,
+    APIKeyCreateTokenResponse,
+)
 ```
 
 Methods:
 
 - <code title="post /v1/sys/projects/{project_id}/api-keys">client.sys.projects.api_keys.<a href="./src/asktable/resources/sys/projects/api_keys.py">create</a>(project_id, \*\*<a href="src/asktable/types/sys/projects/api_key_create_params.py">params</a>) -> <a href="./src/asktable/types/sys/projects/api_key_create_response.py">APIKeyCreateResponse</a></code>
 - <code title="get /v1/sys/projects/{project_id}/api-keys">client.sys.projects.api_keys.<a href="./src/asktable/resources/sys/projects/api_keys.py">list</a>(project_id) -> <a href="./src/asktable/types/sys/projects/api_key_list_response.py">APIKeyListResponse</a></code>
 - <code title="delete /v1/sys/projects/{project_id}/api-keys/{key_id}">client.sys.projects.api_keys.<a href="./src/asktable/resources/sys/projects/api_keys.py">delete</a>(key_id, \*, project_id) -> None</code>
-- <code title="post /v1/sys/projects/{project_id}/tokens">client.sys.projects.api_keys.<a href="./src/asktable/resources/sys/projects/api_keys.py">create_token</a>(project_id, \*\*<a href="src/asktable/types/sys/projects/api_key_create_token_params.py">params</a>) -> object</code>
+- <code title="post /v1/sys/projects/{project_id}/tokens">client.sys.projects.api_keys.<a href="./src/asktable/resources/sys/projects/api_keys.py">create_token</a>(project_id, \*\*<a href="src/asktable/types/sys/projects/api_key_create_token_params.py">params</a>) -> <a href="./src/asktable/types/sys/projects/api_key_create_token_response.py">APIKeyCreateTokenResponse</a></code>
 
 # Securetunnels
 
@@ -62,7 +72,7 @@ Methods:
 Types:
 
 ```python
-from asktable.types import Role, RoleGetPolicesResponse
+from asktable.types import Role, RoleGetPolicesResponse, RoleGetVariablesResponse
 ```
 
 Methods:
@@ -73,7 +83,7 @@ Methods:
 - <code title="get /v1/roles">client.roles.<a href="./src/asktable/resources/roles.py">list</a>(\*\*<a href="src/asktable/types/role_list_params.py">params</a>) -> <a href="./src/asktable/types/role.py">SyncPage[Role]</a></code>
 - <code title="delete /v1/roles/{role_id}">client.roles.<a href="./src/asktable/resources/roles.py">delete</a>(role_id) -> object</code>
 - <code title="get /v1/roles/{role_id}/policies">client.roles.<a href="./src/asktable/resources/roles.py">get_polices</a>(role_id) -> <a href="./src/asktable/types/role_get_polices_response.py">RoleGetPolicesResponse</a></code>
-- <code title="get /v1/roles/{role_id}/variables">client.roles.<a href="./src/asktable/resources/roles.py">get_variables</a>(role_id, \*\*<a href="src/asktable/types/role_get_variables_params.py">params</a>) -> object</code>
+- <code title="get /v1/roles/{role_id}/variables">client.roles.<a href="./src/asktable/resources/roles.py">get_variables</a>(role_id, \*\*<a href="src/asktable/types/role_get_variables_params.py">params</a>) -> <a href="./src/asktable/types/role_get_variables_response.py">RoleGetVariablesResponse</a></code>
 
 # Policies
 
@@ -158,9 +168,15 @@ Methods:
 
 ## UploadParams
 
+Types:
+
+```python
+from asktable.types.datasources import UploadParamCreateResponse
+```
+
 Methods:
 
-- <code title="post /v1/datasources/upload_params">client.datasources.upload_params.<a href="./src/asktable/resources/datasources/upload_params.py">create</a>(\*\*<a href="src/asktable/types/datasources/upload_param_create_params.py">params</a>) -> object</code>
+- <code title="post /v1/datasources/upload_params">client.datasources.upload_params.<a href="./src/asktable/resources/datasources/upload_params.py">create</a>(\*\*<a href="src/asktable/types/datasources/upload_param_create_params.py">params</a>) -> <a href="./src/asktable/types/datasources/upload_param_create_response.py">UploadParamCreateResponse</a></code>
 
 ## Indexes
 
@@ -175,7 +191,7 @@ Methods:
 Types:
 
 ```python
-from asktable.types import Chatbot
+from asktable.types import Chatbot, BotInviteResponse
 ```
 
 Methods:
@@ -185,19 +201,19 @@ Methods:
 - <code title="patch /v1/bots/{bot_id}">client.bots.<a href="./src/asktable/resources/bots.py">update</a>(bot_id, \*\*<a href="src/asktable/types/bot_update_params.py">params</a>) -> <a href="./src/asktable/types/chatbot.py">Chatbot</a></code>
 - <code title="get /v1/bots">client.bots.<a href="./src/asktable/resources/bots.py">list</a>(\*\*<a href="src/asktable/types/bot_list_params.py">params</a>) -> <a href="./src/asktable/types/chatbot.py">SyncPage[Chatbot]</a></code>
 - <code title="delete /v1/bots/{bot_id}">client.bots.<a href="./src/asktable/resources/bots.py">delete</a>(bot_id) -> object</code>
-- <code title="post /v1/bots/{bot_id}/invite">client.bots.<a href="./src/asktable/resources/bots.py">invite</a>(bot_id, \*\*<a href="src/asktable/types/bot_invite_params.py">params</a>) -> object</code>
+- <code title="post /v1/bots/{bot_id}/invite">client.bots.<a href="./src/asktable/resources/bots.py">invite</a>(bot_id, \*\*<a href="src/asktable/types/bot_invite_params.py">params</a>) -> <a href="./src/asktable/types/bot_invite_response.py">BotInviteResponse</a></code>
 
 # Auth
 
 Types:
 
 ```python
-from asktable.types import AuthMeResponse
+from asktable.types import AuthCreateTokenResponse, AuthMeResponse
 ```
 
 Methods:
 
-- <code title="post /v1/auth/tokens">client.auth.<a href="./src/asktable/resources/auth.py">create_token</a>(\*\*<a href="src/asktable/types/auth_create_token_params.py">params</a>) -> object</code>
+- <code title="post /v1/auth/tokens">client.auth.<a href="./src/asktable/resources/auth.py">create_token</a>(\*\*<a href="src/asktable/types/auth_create_token_params.py">params</a>) -> <a href="./src/asktable/types/auth_create_token_response.py">AuthCreateTokenResponse</a></code>
 - <code title="get /v1/auth/me">client.auth.<a href="./src/asktable/resources/auth.py">me</a>() -> <a href="./src/asktable/types/auth_me_response.py">AuthMeResponse</a></code>
 
 # Answers

src/asktable/_files.py

@@ -34,7 +34,7 @@ def assert_is_file_content(obj: object, *, key: str | None = None) -> None:
     if not is_file_content(obj):
         prefix = f"Expected entry at `{key}`" if key is not None else f"Expected file input `{obj!r}`"
         raise RuntimeError(
-            f"{prefix} to be bytes, an io.IOBase instance, PathLike or a tuple but received {type(obj)} instead. See https://github.com/DataMini/asktable-python/tree/main#file-uploads"
+            f"{prefix} to be bytes, an io.IOBase instance, PathLike or a tuple but received {type(obj)} instead."
         ) from None
 
 

src/asktable/resources/answers.py

@@ -2,7 +2,7 @@
 
 from __future__ import annotations
 
-from typing import Optional
+from typing import Dict, Optional
 
 import httpx
 
@@ -53,7 +53,7 @@ def create(
         question: str,
         max_rows: Optional[int] | Omit = omit,
         role_id: Optional[str] | Omit = omit,
-        role_variables: Optional[object] | Omit = omit,
+        role_variables: Optional[Dict[str, object]] | Omit = omit,
         with_json: Optional[bool] | Omit = omit,
         # 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.
@@ -187,7 +187,7 @@ async def create(
         question: str,
         max_rows: Optional[int] | Omit = omit,
         role_id: Optional[str] | Omit = omit,
-        role_variables: Optional[object] | Omit = omit,
+        role_variables: Optional[Dict[str, object]] | Omit = omit,
         with_json: Optional[bool] | Omit = omit,
         # 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.

src/asktable/resources/ats/test_case.py

@@ -2,7 +2,7 @@
 
 from __future__ import annotations
 
-from typing import Optional
+from typing import Dict, Optional
 
 import httpx
 
@@ -57,7 +57,7 @@ def create(
         expected_sql: str,
         question: str,
         role_id: Optional[str] | Omit = omit,
-        role_variables: Optional[object] | Omit = omit,
+        role_variables: Optional[Dict[str, object]] | Omit = omit,
         # 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.
         extra_headers: Headers | None = None,
@@ -148,7 +148,7 @@ def update(
         expected_sql: str,
         question: str,
         role_id: Optional[str] | Omit = omit,
-        role_variables: Optional[object] | Omit = omit,
+        role_variables: Optional[Dict[str, object]] | Omit = omit,
         # 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.
         extra_headers: Headers | None = None,
@@ -313,7 +313,7 @@ async def create(
         expected_sql: str,
         question: str,
         role_id: Optional[str] | Omit = omit,
-        role_variables: Optional[object] | Omit = omit,
+        role_variables: Optional[Dict[str, object]] | Omit = omit,
         # 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.
         extra_headers: Headers | None = None,
@@ -404,7 +404,7 @@ async def update(
         expected_sql: str,
         question: str,
         role_id: Optional[str] | Omit = omit,
-        role_variables: Optional[object] | Omit = omit,
+        role_variables: Optional[Dict[str, object]] | Omit = omit,
         # 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.
         extra_headers: Headers | None = None,

src/asktable/resources/auth.py

@@ -2,7 +2,7 @@
 
 from __future__ import annotations
 
-from typing import Optional
+from typing import Dict, Optional
 from typing_extensions import Literal
 
 import httpx
@@ -20,6 +20,7 @@
 )
 from .._base_client import make_request_options
 from ..types.auth_me_response import AuthMeResponse
+from ..types.auth_create_token_response import AuthCreateTokenResponse
 
 __all__ = ["AuthResource", "AsyncAuthResource"]
 
@@ -52,14 +53,14 @@ def create_token(
         ak_role: Literal["sys", "admin", "asker", "visitor"] | Omit = omit,
         chat_role: Optional[auth_create_token_params.ChatRole] | Omit = omit,
         token_ttl: int | Omit = omit,
-        user_profile: Optional[object] | Omit = omit,
+        user_profile: Optional[Dict[str, object]] | Omit = omit,
         # 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.
         extra_headers: Headers | None = None,
         extra_query: Query | None = None,
         extra_body: Body | None = None,
         timeout: float | httpx.Timeout | None | NotGiven = not_given,
-    ) -> object:
+    ) -> AuthCreateTokenResponse:
         """
         Create Token
 
@@ -94,7 +95,7 @@ def create_token(
             options=make_request_options(
                 extra_headers=extra_headers, extra_query=extra_query, extra_body=extra_body, timeout=timeout
             ),
-            cast_to=object,
+            cast_to=AuthCreateTokenResponse,
         )
 
     def me(
@@ -145,14 +146,14 @@ async def create_token(
         ak_role: Literal["sys", "admin", "asker", "visitor"] | Omit = omit,
         chat_role: Optional[auth_create_token_params.ChatRole] | Omit = omit,
         token_ttl: int | Omit = omit,
-        user_profile: Optional[object] | Omit = omit,
+        user_profile: Optional[Dict[str, object]] | Omit = omit,
         # 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.
         extra_headers: Headers | None = None,
         extra_query: Query | None = None,
         extra_body: Body | None = None,
         timeout: float | httpx.Timeout | None | NotGiven = not_given,
-    ) -> object:
+    ) -> AuthCreateTokenResponse:
         """
         Create Token
 
@@ -187,7 +188,7 @@ async def create_token(
             options=make_request_options(
                 extra_headers=extra_headers, extra_query=extra_query, extra_body=extra_body, timeout=timeout
             ),
-            cast_to=object,
+            cast_to=AuthCreateTokenResponse,
         )
 
     async def me(

src/asktable/resources/bots.py

@@ -20,6 +20,7 @@
 from ..pagination import SyncPage, AsyncPage
 from .._base_client import AsyncPaginator, make_request_options
 from ..types.chatbot import Chatbot
+from ..types.bot_invite_response import BotInviteResponse
 
 __all__ = ["BotsResource", "AsyncBotsResource"]
 
@@ -351,7 +352,7 @@ def invite(
         extra_query: Query | None = None,
         extra_body: Body | None = None,
         timeout: float | httpx.Timeout | None | NotGiven = not_given,
-    ) -> object:
+    ) -> BotInviteResponse:
         """
         邀请用户加入对话
 
@@ -375,7 +376,7 @@ def invite(
                 timeout=timeout,
                 query=maybe_transform({"project_id": project_id}, bot_invite_params.BotInviteParams),
             ),
-            cast_to=object,
+            cast_to=BotInviteResponse,
         )
 
 
@@ -706,7 +707,7 @@ async def invite(
         extra_query: Query | None = None,
         extra_body: Body | None = None,
         timeout: float | httpx.Timeout | None | NotGiven = not_given,
-    ) -> object:
+    ) -> BotInviteResponse:
         """
         邀请用户加入对话
 
@@ -730,7 +731,7 @@ async def invite(
                 timeout=timeout,
                 query=await async_maybe_transform({"project_id": project_id}, bot_invite_params.BotInviteParams),
             ),
-            cast_to=object,
+            cast_to=BotInviteResponse,
         )
 
 

src/asktable/resources/business_glossary.py

@@ -2,7 +2,7 @@
 
 from __future__ import annotations
 
-from typing import Iterable, Optional
+from typing import Dict, Iterable, Optional
 
 import httpx
 
@@ -120,7 +120,7 @@ def update(
         active: Optional[bool] | Omit = omit,
         aliases: Optional[SequenceNotStr[str]] | Omit = omit,
         definition: Optional[str] | Omit = omit,
-        payload: Optional[object] | Omit = omit,
+        payload: Optional[Dict[str, object]] | Omit = omit,
         term: Optional[str] | Omit = omit,
         # 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.
@@ -350,7 +350,7 @@ async def update(
         active: Optional[bool] | Omit = omit,
         aliases: Optional[SequenceNotStr[str]] | Omit = omit,
         definition: Optional[str] | Omit = omit,
-        payload: Optional[object] | Omit = omit,
+        payload: Optional[Dict[str, object]] | Omit = omit,
         term: Optional[str] | Omit = omit,
         # 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.