nimble_python 0.22.0__tar.gz → 0.23.0__tar.gz

nimble_python-0.23.0/.release-please-manifest.json

@@ -0,0 +1,3 @@
+{
+  ".": "0.23.0"
+}

{nimble_python-0.22.0 → nimble_python-0.23.0}/CHANGELOG.md

@@ -1,5 +1,14 @@
 # Changelog
 
+## 0.23.0 (2026-07-13)
+
+Full Changelog: [v0.22.0...v0.23.0](https://github.com/Nimbleway/nimble-python/compare/v0.22.0...v0.23.0)
+
+### Features
+
+* **api:** api update ([a1e3f26](https://github.com/Nimbleway/nimble-python/commit/a1e3f264c89f0a534be69714d3af67b73c1b740c))
+* **api:** api update ([082bc09](https://github.com/Nimbleway/nimble-python/commit/082bc099c7c2b53c0df4c6336ea489cdb1a0fe3c))
+
 ## 0.22.0 (2026-07-07)
 
 Full Changelog: [v0.21.0...v0.22.0](https://github.com/Nimbleway/nimble-python/compare/v0.21.0...v0.22.0)

{nimble_python-0.22.0 → nimble_python-0.23.0}/PKG-INFO

@@ -1,6 +1,6 @@
 Metadata-Version: 2.3
 Name: nimble_python
-Version: 0.22.0
+Version: 0.23.0
 Summary: The official Python library for the nimble API
 Project-URL: Homepage, https://github.com/Nimbleway/nimble-python
 Project-URL: Repository, https://github.com/Nimbleway/nimble-python

{nimble_python-0.22.0 → nimble_python-0.23.0}/api.md

@@ -153,6 +153,18 @@ Methods:
 - <code title="post /v1/serp/async">client.serp.<a href="./src/nimble_python/resources/serp.py">run_async</a>(\*\*<a href="src/nimble_python/types/serp_run_async_params.py">params</a>) -> <a href="./src/nimble_python/types/serp_run_async_response.py">SerpRunAsyncResponse</a></code>
 - <code title="post /v1/serp/batch">client.serp.<a href="./src/nimble_python/resources/serp.py">run_batch</a>(\*\*<a href="src/nimble_python/types/serp_run_batch_params.py">params</a>) -> <a href="./src/nimble_python/types/serp_run_batch_response.py">SerpRunBatchResponse</a></code>
 
+# FastSerp
+
+Types:
+
+```python
+from nimble_python.types import FastSerpRunResponse
+```
+
+Methods:
+
+- <code title="post /v1/fast-serp">client.fast_serp.<a href="./src/nimble_python/resources/fast_serp.py">run</a>(\*\*<a href="src/nimble_python/types/fast_serp_run_params.py">params</a>) -> <a href="./src/nimble_python/types/fast_serp_run_response.py">FastSerpRunResponse</a></code>
+
 # TaskAgent
 
 Types:

{nimble_python-0.22.0 → nimble_python-0.23.0}/pyproject.toml

@@ -1,6 +1,6 @@
 [project]
 name = "nimble_python"
-version = "0.22.0"
+version = "0.23.0"
 description = "The official Python library for the nimble API"
 dynamic = ["readme"]
 license = "Apache-2.0"

{nimble_python-0.22.0 → nimble_python-0.23.0}/src/nimble_python/_client.py

@@ -61,13 +61,14 @@ from .types.extract_async_response import ExtractAsyncResponse
 from .types.extract_batch_response import ExtractBatchResponse
 
 if TYPE_CHECKING:
-    from .resources import jobs, serp, agent, crawl, media, tasks, batches, task_agent, domain_knowledge
+    from .resources import jobs, serp, agent, crawl, media, tasks, batches, fast_serp, task_agent, domain_knowledge
     from .resources.serp import SerpResource, AsyncSerpResource
     from .resources.agent import AgentResource, AsyncAgentResource
     from .resources.crawl import CrawlResource, AsyncCrawlResource
     from .resources.media import MediaResource, AsyncMediaResource
     from .resources.tasks import TasksResource, AsyncTasksResource
     from .resources.batches import BatchesResource, AsyncBatchesResource
+    from .resources.fast_serp import FastSerpResource, AsyncFastSerpResource
     from .resources.jobs.jobs import JobsResource, AsyncJobsResource
     from .resources.domain_knowledge import DomainKnowledgeResource, AsyncDomainKnowledgeResource
     from .resources.task_agent.task_agent import TaskAgentResource, AsyncTaskAgentResource
@@ -185,6 +186,12 @@ class Nimble(SyncAPIClient):
 
         return SerpResource(self)
 
+    @cached_property
+    def fast_serp(self) -> FastSerpResource:
+        from .resources.fast_serp import FastSerpResource
+
+        return FastSerpResource(self)
+
     @cached_property
     def task_agent(self) -> TaskAgentResource:
         from .resources.task_agent import TaskAgentResource
@@ -3479,6 +3486,12 @@ class AsyncNimble(AsyncAPIClient):
 
         return AsyncSerpResource(self)
 
+    @cached_property
+    def fast_serp(self) -> AsyncFastSerpResource:
+        from .resources.fast_serp import AsyncFastSerpResource
+
+        return AsyncFastSerpResource(self)
+
     @cached_property
     def task_agent(self) -> AsyncTaskAgentResource:
         from .resources.task_agent import AsyncTaskAgentResource
@@ -6727,6 +6740,12 @@ class NimbleWithRawResponse:
 
         return SerpResourceWithRawResponse(self._client.serp)
 
+    @cached_property
+    def fast_serp(self) -> fast_serp.FastSerpResourceWithRawResponse:
+        from .resources.fast_serp import FastSerpResourceWithRawResponse
+
+        return FastSerpResourceWithRawResponse(self._client.fast_serp)
+
     @cached_property
     def task_agent(self) -> task_agent.TaskAgentResourceWithRawResponse:
         from .resources.task_agent import TaskAgentResourceWithRawResponse
@@ -6804,6 +6823,12 @@ class AsyncNimbleWithRawResponse:
 
         return AsyncSerpResourceWithRawResponse(self._client.serp)
 
+    @cached_property
+    def fast_serp(self) -> fast_serp.AsyncFastSerpResourceWithRawResponse:
+        from .resources.fast_serp import AsyncFastSerpResourceWithRawResponse
+
+        return AsyncFastSerpResourceWithRawResponse(self._client.fast_serp)
+
     @cached_property
     def task_agent(self) -> task_agent.AsyncTaskAgentResourceWithRawResponse:
         from .resources.task_agent import AsyncTaskAgentResourceWithRawResponse
@@ -6881,6 +6906,12 @@ class NimbleWithStreamedResponse:
 
         return SerpResourceWithStreamingResponse(self._client.serp)
 
+    @cached_property
+    def fast_serp(self) -> fast_serp.FastSerpResourceWithStreamingResponse:
+        from .resources.fast_serp import FastSerpResourceWithStreamingResponse
+
+        return FastSerpResourceWithStreamingResponse(self._client.fast_serp)
+
     @cached_property
     def task_agent(self) -> task_agent.TaskAgentResourceWithStreamingResponse:
         from .resources.task_agent import TaskAgentResourceWithStreamingResponse
@@ -6958,6 +6989,12 @@ class AsyncNimbleWithStreamedResponse:
 
         return AsyncSerpResourceWithStreamingResponse(self._client.serp)
 
+    @cached_property
+    def fast_serp(self) -> fast_serp.AsyncFastSerpResourceWithStreamingResponse:
+        from .resources.fast_serp import AsyncFastSerpResourceWithStreamingResponse
+
+        return AsyncFastSerpResourceWithStreamingResponse(self._client.fast_serp)
+
     @cached_property
     def task_agent(self) -> task_agent.AsyncTaskAgentResourceWithStreamingResponse:
         from .resources.task_agent import AsyncTaskAgentResourceWithStreamingResponse

{nimble_python-0.22.0 → nimble_python-0.23.0}/src/nimble_python/_version.py

@@ -1,4 +1,4 @@
 # File generated from our OpenAPI spec by Stainless. See CONTRIBUTING.md for details.
 
 __title__ = "nimble_python"
-__version__ = "0.22.0"  # x-release-please-version
+__version__ = "0.23.0"  # x-release-please-version

{nimble_python-0.22.0 → nimble_python-0.23.0}/src/nimble_python/resources/__init__.py

@@ -56,6 +56,14 @@ from .batches import (
     BatchesResourceWithStreamingResponse,
     AsyncBatchesResourceWithStreamingResponse,
 )
+from .fast_serp import (
+    FastSerpResource,
+    AsyncFastSerpResource,
+    FastSerpResourceWithRawResponse,
+    AsyncFastSerpResourceWithRawResponse,
+    FastSerpResourceWithStreamingResponse,
+    AsyncFastSerpResourceWithStreamingResponse,
+)
 from .task_agent import (
     TaskAgentResource,
     AsyncTaskAgentResource,
@@ -116,6 +124,12 @@ __all__ = [
     "AsyncSerpResourceWithRawResponse",
     "SerpResourceWithStreamingResponse",
     "AsyncSerpResourceWithStreamingResponse",
+    "FastSerpResource",
+    "AsyncFastSerpResource",
+    "FastSerpResourceWithRawResponse",
+    "AsyncFastSerpResourceWithRawResponse",
+    "FastSerpResourceWithStreamingResponse",
+    "AsyncFastSerpResourceWithStreamingResponse",
     "TaskAgentResource",
     "AsyncTaskAgentResource",
     "TaskAgentResourceWithRawResponse",

{nimble_python-0.22.0 → nimble_python-0.23.0}/src/nimble_python/resources/agent.py

@@ -121,7 +121,7 @@ class AgentResource(SyncAPIResource):
         prompt: str,
         url: str,
         input_schema: Dict[str, object] | Omit = omit,
-        metadata: Optional[agent_generate_params.CreateAgentGenerationRequestMetadata] | Omit = omit,
+        metadata: Optional[agent_generate_params.CrustCreateAgentGenerationRequestMetadata] | Omit = omit,
         name: Optional[str] | Omit = omit,
         output_schema: 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.
@@ -179,7 +179,7 @@ class AgentResource(SyncAPIResource):
         prompt: str,
         url: str | Omit = omit,
         input_schema: Dict[str, object] | Omit = omit,
-        metadata: Optional[agent_generate_params.CreateAgentGenerationRequestMetadata] | Omit = omit,
+        metadata: Optional[agent_generate_params.CrustCreateAgentGenerationRequestMetadata] | Omit = omit,
         name: Optional[str] | Omit = omit,
         output_schema: Dict[str, object] | Omit = omit,
         from_agent: str | Omit = omit,
@@ -512,7 +512,7 @@ class AsyncAgentResource(AsyncAPIResource):
         prompt: str,
         url: str,
         input_schema: Dict[str, object] | Omit = omit,
-        metadata: Optional[agent_generate_params.CreateAgentGenerationRequestMetadata] | Omit = omit,
+        metadata: Optional[agent_generate_params.CrustCreateAgentGenerationRequestMetadata] | Omit = omit,
         name: Optional[str] | Omit = omit,
         output_schema: 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.
@@ -570,7 +570,7 @@ class AsyncAgentResource(AsyncAPIResource):
         prompt: str,
         url: str | Omit = omit,
         input_schema: Dict[str, object] | Omit = omit,
-        metadata: Optional[agent_generate_params.CreateAgentGenerationRequestMetadata] | Omit = omit,
+        metadata: Optional[agent_generate_params.CrustCreateAgentGenerationRequestMetadata] | Omit = omit,
         name: Optional[str] | Omit = omit,
         output_schema: Dict[str, object] | Omit = omit,
         from_agent: str | Omit = omit,

nimble_python-0.23.0/src/nimble_python/resources/fast_serp.py

@@ -0,0 +1,293 @@
+# File generated from our OpenAPI spec by Stainless. See CONTRIBUTING.md for details.
+
+from __future__ import annotations
+
+from typing_extensions import Literal
+
+import httpx
+
+from ..types import fast_serp_run_params
+from .._types import Body, Omit, Query, Headers, NotGiven, omit, not_given
+from .._utils import maybe_transform, async_maybe_transform
+from .._compat import cached_property
+from .._resource import SyncAPIResource, AsyncAPIResource
+from .._response import (
+    to_raw_response_wrapper,
+    to_streamed_response_wrapper,
+    async_to_raw_response_wrapper,
+    async_to_streamed_response_wrapper,
+)
+from .._base_client import make_request_options
+from ..types.fast_serp_run_response import FastSerpRunResponse
+
+__all__ = ["FastSerpResource", "AsyncFastSerpResource"]
+
+
+class FastSerpResource(SyncAPIResource):
+    @cached_property
+    def with_raw_response(self) -> FastSerpResourceWithRawResponse:
+        """
+        This property can be used as a prefix for any HTTP method call to return
+        the raw response object instead of the parsed content.
+
+        For more information, see https://www.github.com/Nimbleway/nimble-python#accessing-raw-response-data-eg-headers
+        """
+        return FastSerpResourceWithRawResponse(self)
+
+    @cached_property
+    def with_streaming_response(self) -> FastSerpResourceWithStreamingResponse:
+        """
+        An alternative to `.with_raw_response` that doesn't eagerly read the response body.
+
+        For more information, see https://www.github.com/Nimbleway/nimble-python#with_streaming_response
+        """
+        return FastSerpResourceWithStreamingResponse(self)
+
+    def run(
+        self,
+        *,
+        search_engine: Literal[
+            "google_search",
+            "google_sge",
+            "google_aio",
+            "google_maps_search",
+            "google_maps_reviews",
+            "google_maps_place",
+            "google_news",
+            "google_images",
+            "bing_search",
+            "yandex_search",
+        ],
+        country: str | Omit = omit,
+        device: Literal["desktop", "mobile"] | Omit = omit,
+        domain: str | Omit = omit,
+        locale: str | Omit = omit,
+        location: str | Omit = omit,
+        num_results: int | Omit = omit,
+        page: int | Omit = omit,
+        parse: bool | Omit = omit,
+        query: str | Omit = omit,
+        render: bool | Omit = omit,
+        show_hidden_results: 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.
+        extra_headers: Headers | None = None,
+        extra_query: Query | None = None,
+        extra_body: Body | None = None,
+        timeout: float | httpx.Timeout | None | NotGiven = not_given,
+    ) -> FastSerpRunResponse:
+        """
+        Fast SERP
+
+        Args:
+          search_engine: The search engine to query.
+
+          country: ISO Alpha-2 country code used to access the target search engine (e.g. US, DE,
+              GB).
+
+          device: Device type used for the search request.
+
+          domain: Top-level domain for the search engine (e.g. "com", "co.uk", "de").
+
+          locale: Locale used for the search request.
+
+          location: Geo-location for the search (canonical Google location name).
+
+          num_results: Number of results to return (1–100).
+
+          page: The result page number for pagination.
+
+          parse: When true, the SERP response is parsed into structured JSON.
+
+          query: The search keyword or phrase to query.
+
+          render: Whether to render the page in a browser before extracting.
+
+          show_hidden_results: When true, disables Google result filtering (filter=0) so omitted/duplicate and
+              highly similar pages are also returned. Applies to Google search engines.
+
+          extra_headers: Send extra headers
+
+          extra_query: Add additional query parameters to the request
+
+          extra_body: Add additional JSON properties to the request
+
+          timeout: Override the client-level default timeout for this request, in seconds
+        """
+        return self._post(
+            "/v1/fast-serp",
+            body=maybe_transform(
+                {
+                    "search_engine": search_engine,
+                    "country": country,
+                    "device": device,
+                    "domain": domain,
+                    "locale": locale,
+                    "location": location,
+                    "num_results": num_results,
+                    "page": page,
+                    "parse": parse,
+                    "query": query,
+                    "render": render,
+                    "show_hidden_results": show_hidden_results,
+                },
+                fast_serp_run_params.FastSerpRunParams,
+            ),
+            options=make_request_options(
+                extra_headers=extra_headers, extra_query=extra_query, extra_body=extra_body, timeout=timeout
+            ),
+            cast_to=FastSerpRunResponse,
+        )
+
+
+class AsyncFastSerpResource(AsyncAPIResource):
+    @cached_property
+    def with_raw_response(self) -> AsyncFastSerpResourceWithRawResponse:
+        """
+        This property can be used as a prefix for any HTTP method call to return
+        the raw response object instead of the parsed content.
+
+        For more information, see https://www.github.com/Nimbleway/nimble-python#accessing-raw-response-data-eg-headers
+        """
+        return AsyncFastSerpResourceWithRawResponse(self)
+
+    @cached_property
+    def with_streaming_response(self) -> AsyncFastSerpResourceWithStreamingResponse:
+        """
+        An alternative to `.with_raw_response` that doesn't eagerly read the response body.
+
+        For more information, see https://www.github.com/Nimbleway/nimble-python#with_streaming_response
+        """
+        return AsyncFastSerpResourceWithStreamingResponse(self)
+
+    async def run(
+        self,
+        *,
+        search_engine: Literal[
+            "google_search",
+            "google_sge",
+            "google_aio",
+            "google_maps_search",
+            "google_maps_reviews",
+            "google_maps_place",
+            "google_news",
+            "google_images",
+            "bing_search",
+            "yandex_search",
+        ],
+        country: str | Omit = omit,
+        device: Literal["desktop", "mobile"] | Omit = omit,
+        domain: str | Omit = omit,
+        locale: str | Omit = omit,
+        location: str | Omit = omit,
+        num_results: int | Omit = omit,
+        page: int | Omit = omit,
+        parse: bool | Omit = omit,
+        query: str | Omit = omit,
+        render: bool | Omit = omit,
+        show_hidden_results: 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.
+        extra_headers: Headers | None = None,
+        extra_query: Query | None = None,
+        extra_body: Body | None = None,
+        timeout: float | httpx.Timeout | None | NotGiven = not_given,
+    ) -> FastSerpRunResponse:
+        """
+        Fast SERP
+
+        Args:
+          search_engine: The search engine to query.
+
+          country: ISO Alpha-2 country code used to access the target search engine (e.g. US, DE,
+              GB).
+
+          device: Device type used for the search request.
+
+          domain: Top-level domain for the search engine (e.g. "com", "co.uk", "de").
+
+          locale: Locale used for the search request.
+
+          location: Geo-location for the search (canonical Google location name).
+
+          num_results: Number of results to return (1–100).
+
+          page: The result page number for pagination.
+
+          parse: When true, the SERP response is parsed into structured JSON.
+
+          query: The search keyword or phrase to query.
+
+          render: Whether to render the page in a browser before extracting.
+
+          show_hidden_results: When true, disables Google result filtering (filter=0) so omitted/duplicate and
+              highly similar pages are also returned. Applies to Google search engines.
+
+          extra_headers: Send extra headers
+
+          extra_query: Add additional query parameters to the request
+
+          extra_body: Add additional JSON properties to the request
+
+          timeout: Override the client-level default timeout for this request, in seconds
+        """
+        return await self._post(
+            "/v1/fast-serp",
+            body=await async_maybe_transform(
+                {
+                    "search_engine": search_engine,
+                    "country": country,
+                    "device": device,
+                    "domain": domain,
+                    "locale": locale,
+                    "location": location,
+                    "num_results": num_results,
+                    "page": page,
+                    "parse": parse,
+                    "query": query,
+                    "render": render,
+                    "show_hidden_results": show_hidden_results,
+                },
+                fast_serp_run_params.FastSerpRunParams,
+            ),
+            options=make_request_options(
+                extra_headers=extra_headers, extra_query=extra_query, extra_body=extra_body, timeout=timeout
+            ),
+            cast_to=FastSerpRunResponse,
+        )
+
+
+class FastSerpResourceWithRawResponse:
+    def __init__(self, fast_serp: FastSerpResource) -> None:
+        self._fast_serp = fast_serp
+
+        self.run = to_raw_response_wrapper(
+            fast_serp.run,
+        )
+
+
+class AsyncFastSerpResourceWithRawResponse:
+    def __init__(self, fast_serp: AsyncFastSerpResource) -> None:
+        self._fast_serp = fast_serp
+
+        self.run = async_to_raw_response_wrapper(
+            fast_serp.run,
+        )
+
+
+class FastSerpResourceWithStreamingResponse:
+    def __init__(self, fast_serp: FastSerpResource) -> None:
+        self._fast_serp = fast_serp
+
+        self.run = to_streamed_response_wrapper(
+            fast_serp.run,
+        )
+
+
+class AsyncFastSerpResourceWithStreamingResponse:
+    def __init__(self, fast_serp: AsyncFastSerpResource) -> None:
+        self._fast_serp = fast_serp
+
+        self.run = async_to_streamed_response_wrapper(
+            fast_serp.run,
+        )

{nimble_python-0.22.0 → nimble_python-0.23.0}/src/nimble_python/resources/jobs/jobs.py

@@ -84,6 +84,8 @@ class JobsResource(SyncAPIResource):
 
           name: Job name.
 
+          description: Free-text description of the job.
+
           destination: Where a job writes its results.
 
           display_name: Human-friendly job name shown in the UI.
@@ -140,6 +142,8 @@ class JobsResource(SyncAPIResource):
         Update Job
 
         Args:
+          description: New description.
+
           destination: Where a job writes its results.
 
           display_name: New display name.
@@ -376,6 +380,8 @@ class AsyncJobsResource(AsyncAPIResource):
 
           name: Job name.
 
+          description: Free-text description of the job.
+
           destination: Where a job writes its results.
 
           display_name: Human-friendly job name shown in the UI.
@@ -432,6 +438,8 @@ class AsyncJobsResource(AsyncAPIResource):
         Update Job
 
         Args:
+          description: New description.
+
           destination: Where a job writes its results.
 
           display_name: New display name.