nimble_python 0.23.0__tar.gz → 1.0.0__tar.gz

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

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

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

@@ -1,5 +1,30 @@
 # Changelog
 
+## 1.0.0 (2026-07-20)
+
+Full Changelog: [v0.24.0...v1.0.0](https://github.com/Nimbleway/nimble-python/compare/v0.24.0...v1.0.0)
+
+### Features
+
+* **api:** api update ([1f846bf](https://github.com/Nimbleway/nimble-python/commit/1f846bff007afa2bd17e3dbe720e858dde41a062))
+* **api:** Api v2 ([54c125b](https://github.com/Nimbleway/nimble-python/commit/54c125b46e2eaa6e64aa5267f3e3fef7853b3085))
+
+## 0.24.0 (2026-07-19)
+
+Full Changelog: [v0.23.0...v0.24.0](https://github.com/Nimbleway/nimble-python/compare/v0.23.0...v0.24.0)
+
+### Features
+
+* **api:** api update ([27121de](https://github.com/Nimbleway/nimble-python/commit/27121de406e5be1d76975780b8689d48aecebbf5))
+* **api:** api update ([f1585c5](https://github.com/Nimbleway/nimble-python/commit/f1585c5fae73225539e26a86d33d6ee5c4b8ab5d))
+* **api:** api update ([145d461](https://github.com/Nimbleway/nimble-python/commit/145d46130aa4bf0dae2526b5173c76ef3cd9e832))
+* **stlc:** configurable CI runner and private-production-repo support in workflow templates ([1ba64bc](https://github.com/Nimbleway/nimble-python/commit/1ba64bcfba91ef0dcc170122382e00af7b3f1d8d))
+
+
+### Bug Fixes
+
+* **internal:** resolve build failures ([be103a1](https://github.com/Nimbleway/nimble-python/commit/be103a12056631ed49ad660acdd68aa24025e87c))
+
 ## 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)

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

@@ -1,6 +1,6 @@
 Metadata-Version: 2.3
 Name: nimble_python
-Version: 0.23.0
+Version: 1.0.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
@@ -76,7 +76,7 @@ client = Nimble(
     api_key=os.environ.get("NIMBLE_API_KEY"),  # This is the default and can be omitted
 )
 
-response = client.extract(
+response = client.extract.run(
     url="https://exapmle.com",
 )
 print(response.task_id)
@@ -102,7 +102,7 @@ client = AsyncNimble(
 
 
 async def main() -> None:
-    response = await client.extract(
+    response = await client.extract.run(
         url="https://exapmle.com",
     )
     print(response.task_id)
@@ -138,7 +138,7 @@ async def main() -> None:
         api_key=os.environ.get("NIMBLE_API_KEY"),  # This is the default and can be omitted
         http_client=DefaultAioHttpClient(),
     ) as client:
-        response = await client.extract(
+        response = await client.extract.run(
             url="https://exapmle.com",
         )
         print(response.task_id)
@@ -165,7 +165,7 @@ from nimble_python import Nimble
 
 client = Nimble()
 
-response = client.extract(
+response = client.extract.run(
     url="url",
     session={},
 )
@@ -188,7 +188,7 @@ from nimble_python import Nimble
 client = Nimble()
 
 try:
-    client.extract(
+    client.extract.run(
         url="https://exapmle.com",
     )
 except nimble_python.APIConnectionError as e:
@@ -233,7 +233,7 @@ client = Nimble(
 )
 
 # Or, configure per-request:
-client.with_options(max_retries=5).extract(
+client.with_options(max_retries=5).extract.run(
     url="https://exapmle.com",
 )
 ```
@@ -258,7 +258,7 @@ client = Nimble(
 )
 
 # Override per-request:
-client.with_options(timeout=5.0).extract(
+client.with_options(timeout=5.0).extract.run(
     url="https://exapmle.com",
 )
 ```
@@ -301,13 +301,13 @@ The "raw" Response object can be accessed by prefixing `.with_raw_response.` to
 from nimble_python import Nimble
 
 client = Nimble()
-response = client.with_raw_response.extract(
+response = client.extract.with_raw_response.run(
     url="https://exapmle.com",
 )
 print(response.headers.get('X-My-Header'))
 
-client = response.parse()  # get the object that `extract()` would have returned
-print(client.task_id)
+extract = response.parse()  # get the object that `extract.run()` would have returned
+print(extract.task_id)
 ```
 
 These methods return an [`APIResponse`](https://github.com/Nimbleway/nimble-python/tree/main/src/nimble_python/_response.py) object.
@@ -321,7 +321,7 @@ The above interface eagerly reads the full response body when you make the reque
 To stream the response body, use `.with_streaming_response` instead, which requires a context manager and only reads the response body once you call `.read()`, `.text()`, `.json()`, `.iter_bytes()`, `.iter_text()`, `.iter_lines()` or `.parse()`. In the async client, these are async methods.
 
 ```python
-with client.with_streaming_response.extract(
+with client.extract.with_streaming_response.run(
     url="https://exapmle.com",
 ) as response:
     print(response.headers.get("X-My-Header"))

{nimble_python-0.23.0 → nimble_python-1.0.0}/README.md

@@ -41,7 +41,7 @@ client = Nimble(
     api_key=os.environ.get("NIMBLE_API_KEY"),  # This is the default and can be omitted
 )
 
-response = client.extract(
+response = client.extract.run(
     url="https://exapmle.com",
 )
 print(response.task_id)
@@ -67,7 +67,7 @@ client = AsyncNimble(
 
 
 async def main() -> None:
-    response = await client.extract(
+    response = await client.extract.run(
         url="https://exapmle.com",
     )
     print(response.task_id)
@@ -103,7 +103,7 @@ async def main() -> None:
         api_key=os.environ.get("NIMBLE_API_KEY"),  # This is the default and can be omitted
         http_client=DefaultAioHttpClient(),
     ) as client:
-        response = await client.extract(
+        response = await client.extract.run(
             url="https://exapmle.com",
         )
         print(response.task_id)
@@ -130,7 +130,7 @@ from nimble_python import Nimble
 
 client = Nimble()
 
-response = client.extract(
+response = client.extract.run(
     url="url",
     session={},
 )
@@ -153,7 +153,7 @@ from nimble_python import Nimble
 client = Nimble()
 
 try:
-    client.extract(
+    client.extract.run(
         url="https://exapmle.com",
     )
 except nimble_python.APIConnectionError as e:
@@ -198,7 +198,7 @@ client = Nimble(
 )
 
 # Or, configure per-request:
-client.with_options(max_retries=5).extract(
+client.with_options(max_retries=5).extract.run(
     url="https://exapmle.com",
 )
 ```
@@ -223,7 +223,7 @@ client = Nimble(
 )
 
 # Override per-request:
-client.with_options(timeout=5.0).extract(
+client.with_options(timeout=5.0).extract.run(
     url="https://exapmle.com",
 )
 ```
@@ -266,13 +266,13 @@ The "raw" Response object can be accessed by prefixing `.with_raw_response.` to
 from nimble_python import Nimble
 
 client = Nimble()
-response = client.with_raw_response.extract(
+response = client.extract.with_raw_response.run(
     url="https://exapmle.com",
 )
 print(response.headers.get('X-My-Header'))
 
-client = response.parse()  # get the object that `extract()` would have returned
-print(client.task_id)
+extract = response.parse()  # get the object that `extract.run()` would have returned
+print(extract.task_id)
 ```
 
 These methods return an [`APIResponse`](https://github.com/Nimbleway/nimble-python/tree/main/src/nimble_python/_response.py) object.
@@ -286,7 +286,7 @@ The above interface eagerly reads the full response body when you make the reque
 To stream the response body, use `.with_streaming_response` instead, which requires a context manager and only reads the response body once you call `.read()`, `.text()`, `.json()`, `.iter_bytes()`, `.iter_text()`, `.iter_lines()` or `.parse()`. In the async client, these are async methods.
 
 ```python
-with client.with_streaming_response.extract(
+with client.extract.with_streaming_response.run(
     url="https://exapmle.com",
 ) as response:
     print(response.headers.get("X-My-Header"))

nimble_python-1.0.0/api.md

@@ -0,0 +1,312 @@
+# Shared Types
+
+```python
+from nimble_python.types import (
+    AutoScrollAction,
+    ClickAction,
+    EvalAction,
+    FetchAction,
+    FillAction,
+    GetCookiesAction,
+    GotoAction,
+    PressAction,
+    ScreenshotAction,
+    ScrollAction,
+    WaitAction,
+    WaitForElementAction,
+    WaitForNavigationAction,
+)
+```
+
+# Nimble
+
+Types:
+
+```python
+from nimble_python.types import MapResponse, SearchResponse
+```
+
+Methods:
+
+- <code title="post /v2/map">client.<a href="./src/nimble_python/_client.py">map</a>(\*\*<a href="src/nimble_python/types/client_map_params.py">params</a>) -> <a href="./src/nimble_python/types/map_response.py">MapResponse</a></code>
+- <code title="post /v2/search">client.<a href="./src/nimble_python/_client.py">search</a>(\*\*<a href="src/nimble_python/types/client_search_params.py">params</a>) -> <a href="./src/nimble_python/types/search_response.py">SearchResponse</a></code>
+
+# Extract
+
+Types:
+
+```python
+from nimble_python.types import ExtractAsyncResponse, ExtractBatchResponse, ExtractRunResponse
+```
+
+Methods:
+
+- <code title="post /v2/extract/async">client.extract.<a href="./src/nimble_python/resources/extract/extract.py">async\_</a>(\*\*<a href="src/nimble_python/types/extract_async_params.py">params</a>) -> <a href="./src/nimble_python/types/extract_async_response.py">ExtractAsyncResponse</a></code>
+- <code title="post /v2/extract/batch">client.extract.<a href="./src/nimble_python/resources/extract/extract.py">batch</a>(\*\*<a href="src/nimble_python/types/extract_batch_params.py">params</a>) -> <a href="./src/nimble_python/types/extract_batch_response.py">ExtractBatchResponse</a></code>
+- <code title="post /v2/extract">client.extract.<a href="./src/nimble_python/resources/extract/extract.py">run</a>(\*\*<a href="src/nimble_python/types/extract_run_params.py">params</a>) -> <a href="./src/nimble_python/types/extract_run_response.py">ExtractRunResponse</a></code>
+
+## Templates
+
+Types:
+
+```python
+from nimble_python.types.extract import (
+    TemplateUpdateResponse,
+    TemplateListResponse,
+    TemplateAsyncResponse,
+    TemplateBatchResponse,
+    TemplateGetResponse,
+    TemplateRunResponse,
+)
+```
+
+Methods:
+
+- <code title="patch /v2/extract/templates/{extract_template_name}">client.extract.templates.<a href="./src/nimble_python/resources/extract/templates/templates.py">update</a>(extract_template_name, \*\*<a href="src/nimble_python/types/extract/template_update_params.py">params</a>) -> <a href="./src/nimble_python/types/extract/template_update_response.py">TemplateUpdateResponse</a></code>
+- <code title="get /v2/extract/templates">client.extract.templates.<a href="./src/nimble_python/resources/extract/templates/templates.py">list</a>(\*\*<a href="src/nimble_python/types/extract/template_list_params.py">params</a>) -> <a href="./src/nimble_python/types/extract/template_list_response.py">TemplateListResponse</a></code>
+- <code title="delete /v2/extract/templates/{extract_template_name}">client.extract.templates.<a href="./src/nimble_python/resources/extract/templates/templates.py">delete</a>(extract_template_name) -> None</code>
+- <code title="post /v2/extract/templates/async">client.extract.templates.<a href="./src/nimble_python/resources/extract/templates/templates.py">async\_</a>(\*\*<a href="src/nimble_python/types/extract/template_async_params.py">params</a>) -> <a href="./src/nimble_python/types/extract/template_async_response.py">TemplateAsyncResponse</a></code>
+- <code title="post /v2/extract/templates/batch">client.extract.templates.<a href="./src/nimble_python/resources/extract/templates/templates.py">batch</a>(\*\*<a href="src/nimble_python/types/extract/template_batch_params.py">params</a>) -> <a href="./src/nimble_python/types/extract/template_batch_response.py">TemplateBatchResponse</a></code>
+- <code title="get /v2/extract/templates/{extract_template_name}">client.extract.templates.<a href="./src/nimble_python/resources/extract/templates/templates.py">get</a>(extract_template_name) -> <a href="./src/nimble_python/types/extract/template_get_response.py">TemplateGetResponse</a></code>
+- <code title="post /v2/extract/templates/run">client.extract.templates.<a href="./src/nimble_python/resources/extract/templates/templates.py">run</a>(\*\*<a href="src/nimble_python/types/extract/template_run_params.py">params</a>) -> <a href="./src/nimble_python/types/extract/template_run_response.py">TemplateRunResponse</a></code>
+
+### Generations
+
+Types:
+
+```python
+from nimble_python.types.extract.templates import GenerationCreateResponse, GenerationGetResponse
+```
+
+Methods:
+
+- <code title="post /v2/extract/templates/generations">client.extract.templates.generations.<a href="./src/nimble_python/resources/extract/templates/generations.py">create</a>(\*\*<a href="src/nimble_python/types/extract/templates/generation_create_params.py">params</a>) -> <a href="./src/nimble_python/types/extract/templates/generation_create_response.py">GenerationCreateResponse</a></code>
+- <code title="get /v2/extract/templates/generations/{generation_id}">client.extract.templates.generations.<a href="./src/nimble_python/resources/extract/templates/generations.py">get</a>(generation_id) -> <a href="./src/nimble_python/types/extract/templates/generation_get_response.py">GenerationGetResponse</a></code>
+
+### Versions
+
+Types:
+
+```python
+from nimble_python.types.extract.templates import VersionListResponse, VersionGetResponse
+```
+
+Methods:
+
+- <code title="get /v2/extract/templates/{extract_template_name}/versions">client.extract.templates.versions.<a href="./src/nimble_python/resources/extract/templates/versions.py">list</a>(extract_template_name, \*\*<a href="src/nimble_python/types/extract/templates/version_list_params.py">params</a>) -> <a href="./src/nimble_python/types/extract/templates/version_list_response.py">VersionListResponse</a></code>
+- <code title="get /v2/extract/templates/{extract_template_name}/versions/{version_id}">client.extract.templates.versions.<a href="./src/nimble_python/resources/extract/templates/versions.py">get</a>(version_id, \*, extract_template_name) -> <a href="./src/nimble_python/types/extract/templates/version_get_response.py">VersionGetResponse</a></code>
+
+# Agents
+
+Types:
+
+```python
+from nimble_python.types import (
+    AgentCreateResponse,
+    AgentUpdateResponse,
+    AgentListResponse,
+    AgentGetResponse,
+)
+```
+
+Methods:
+
+- <code title="post /v2/agents">client.agents.<a href="./src/nimble_python/resources/agents/agents.py">create</a>(\*\*<a href="src/nimble_python/types/agent_create_params.py">params</a>) -> <a href="./src/nimble_python/types/agent_create_response.py">AgentCreateResponse</a></code>
+- <code title="patch /v2/agents/{agent_id}">client.agents.<a href="./src/nimble_python/resources/agents/agents.py">update</a>(agent_id, \*\*<a href="src/nimble_python/types/agent_update_params.py">params</a>) -> <a href="./src/nimble_python/types/agent_update_response.py">AgentUpdateResponse</a></code>
+- <code title="get /v2/agents">client.agents.<a href="./src/nimble_python/resources/agents/agents.py">list</a>(\*\*<a href="src/nimble_python/types/agent_list_params.py">params</a>) -> <a href="./src/nimble_python/types/agent_list_response.py">AgentListResponse</a></code>
+- <code title="delete /v2/agents/{agent_id}">client.agents.<a href="./src/nimble_python/resources/agents/agents.py">delete</a>(agent_id) -> None</code>
+- <code title="get /v2/agents/{agent_id}">client.agents.<a href="./src/nimble_python/resources/agents/agents.py">get</a>(agent_id) -> <a href="./src/nimble_python/types/agent_get_response.py">AgentGetResponse</a></code>
+
+## Templates
+
+Types:
+
+```python
+from nimble_python.types.agents import TemplateListResponse, TemplateGetResponse
+```
+
+Methods:
+
+- <code title="get /v2/agents/templates">client.agents.templates.<a href="./src/nimble_python/resources/agents/templates.py">list</a>(\*\*<a href="src/nimble_python/types/agents/template_list_params.py">params</a>) -> <a href="./src/nimble_python/types/agents/template_list_response.py">TemplateListResponse</a></code>
+- <code title="get /v2/agents/templates/{template_name}">client.agents.templates.<a href="./src/nimble_python/resources/agents/templates.py">get</a>(template_name) -> <a href="./src/nimble_python/types/agents/template_get_response.py">TemplateGetResponse</a></code>
+
+## Runs
+
+Types:
+
+```python
+from nimble_python.types.agents import (
+    RunCreateResponse,
+    RunListResponse,
+    RunGetResponse,
+    RunResultResponse,
+)
+```
+
+Methods:
+
+- <code title="post /v2/agents/{agent_id}/runs">client.agents.runs.<a href="./src/nimble_python/resources/agents/runs.py">create</a>(agent_id, \*\*<a href="src/nimble_python/types/agents/run_create_params.py">params</a>) -> <a href="./src/nimble_python/types/agents/run_create_response.py">RunCreateResponse</a></code>
+- <code title="get /v2/agents/{agent_id}/runs">client.agents.runs.<a href="./src/nimble_python/resources/agents/runs.py">list</a>(agent_id, \*\*<a href="src/nimble_python/types/agents/run_list_params.py">params</a>) -> <a href="./src/nimble_python/types/agents/run_list_response.py">RunListResponse</a></code>
+- <code title="get /v2/agents/{agent_id}/runs/{run_id}">client.agents.runs.<a href="./src/nimble_python/resources/agents/runs.py">get</a>(run_id, \*, agent_id) -> <a href="./src/nimble_python/types/agents/run_get_response.py">RunGetResponse</a></code>
+- <code title="get /v2/agents/{agent_id}/runs/{run_id}/result">client.agents.runs.<a href="./src/nimble_python/resources/agents/runs.py">result</a>(run_id, \*, agent_id) -> <a href="./src/nimble_python/types/agents/run_result_response.py">RunResultResponse</a></code>
+- <code title="get /v2/agents/{agent_id}/runs/{run_id}/events">client.agents.runs.<a href="./src/nimble_python/resources/agents/runs.py">stream_events</a>(run_id, \*, agent_id) -> None</code>
+
+# Crawl
+
+Types:
+
+```python
+from nimble_python.types import (
+    CrawlListResponse,
+    CrawlRunResponse,
+    CrawlStatusResponse,
+    CrawlTerminateResponse,
+)
+```
+
+Methods:
+
+- <code title="get /v2/crawl">client.crawl.<a href="./src/nimble_python/resources/crawl.py">list</a>(\*\*<a href="src/nimble_python/types/crawl_list_params.py">params</a>) -> <a href="./src/nimble_python/types/crawl_list_response.py">CrawlListResponse</a></code>
+- <code title="post /v2/crawl">client.crawl.<a href="./src/nimble_python/resources/crawl.py">run</a>(\*\*<a href="src/nimble_python/types/crawl_run_params.py">params</a>) -> <a href="./src/nimble_python/types/crawl_run_response.py">CrawlRunResponse</a></code>
+- <code title="get /v2/crawl/{id}">client.crawl.<a href="./src/nimble_python/resources/crawl.py">status</a>(id) -> <a href="./src/nimble_python/types/crawl_status_response.py">CrawlStatusResponse</a></code>
+- <code title="delete /v2/crawl/{id}">client.crawl.<a href="./src/nimble_python/resources/crawl.py">terminate</a>(id) -> <a href="./src/nimble_python/types/crawl_terminate_response.py">CrawlTerminateResponse</a></code>
+
+# Tasks
+
+Types:
+
+```python
+from nimble_python.types import TaskListResponse, TaskGetResponse, TaskResultsResponse
+```
+
+Methods:
+
+- <code title="get /v2/tasks">client.tasks.<a href="./src/nimble_python/resources/tasks.py">list</a>(\*\*<a href="src/nimble_python/types/task_list_params.py">params</a>) -> <a href="./src/nimble_python/types/task_list_response.py">TaskListResponse</a></code>
+- <code title="get /v2/tasks/{task_id}">client.tasks.<a href="./src/nimble_python/resources/tasks.py">get</a>(task_id) -> <a href="./src/nimble_python/types/task_get_response.py">TaskGetResponse</a></code>
+- <code title="get /v2/tasks/{task_id}/results">client.tasks.<a href="./src/nimble_python/resources/tasks.py">results</a>(task_id) -> <a href="./src/nimble_python/types/task_results_response.py">TaskResultsResponse</a></code>
+
+# Batches
+
+Types:
+
+```python
+from nimble_python.types import BatchGetResponse, BatchProgressResponse
+```
+
+Methods:
+
+- <code title="get /v2/batches">client.batches.<a href="./src/nimble_python/resources/batches.py">list</a>() -> None</code>
+- <code title="get /v2/batches/{batch_id}">client.batches.<a href="./src/nimble_python/resources/batches.py">get</a>(batch_id) -> <a href="./src/nimble_python/types/batch_get_response.py">BatchGetResponse</a></code>
+- <code title="get /v2/batches/{batch_id}/progress">client.batches.<a href="./src/nimble_python/resources/batches.py">progress</a>(batch_id) -> <a href="./src/nimble_python/types/batch_progress_response.py">BatchProgressResponse</a></code>
+
+# DomainKnowledge
+
+Types:
+
+```python
+from nimble_python.types import DomainKnowledgeGetDriverResponse
+```
+
+Methods:
+
+- <code title="get /v2/domain-knowledge/driver">client.domain_knowledge.<a href="./src/nimble_python/resources/domain_knowledge.py">get_driver</a>(\*\*<a href="src/nimble_python/types/domain_knowledge_get_driver_params.py">params</a>) -> <a href="./src/nimble_python/types/domain_knowledge_get_driver_response.py">DomainKnowledgeGetDriverResponse</a></code>
+
+# Media
+
+Types:
+
+```python
+from nimble_python.types import MediaRunResponse, MediaRunAsyncResponse
+```
+
+Methods:
+
+- <code title="post /v2/media">client.media.<a href="./src/nimble_python/resources/media.py">run</a>(\*\*<a href="src/nimble_python/types/media_run_params.py">params</a>) -> <a href="./src/nimble_python/types/media_run_response.py">MediaRunResponse</a></code>
+- <code title="post /v2/media/async">client.media.<a href="./src/nimble_python/resources/media.py">run_async</a>(\*\*<a href="src/nimble_python/types/media_run_async_params.py">params</a>) -> <a href="./src/nimble_python/types/media_run_async_response.py">MediaRunAsyncResponse</a></code>
+
+# Serp
+
+Types:
+
+```python
+from nimble_python.types import SerpRunResponse, SerpRunAsyncResponse, SerpRunBatchResponse
+```
+
+Methods:
+
+- <code title="post /v2/serp">client.serp.<a href="./src/nimble_python/resources/serp.py">run</a>(\*\*<a href="src/nimble_python/types/serp_run_params.py">params</a>) -> <a href="./src/nimble_python/types/serp_run_response.py">SerpRunResponse</a></code>
+- <code title="post /v2/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 /v2/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 /v2/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>
+
+# Jobs
+
+Types:
+
+```python
+from nimble_python.types import (
+    JobCreateResponse,
+    JobUpdateResponse,
+    JobListResponse,
+    JobGetResponse,
+)
+```
+
+Methods:
+
+- <code title="post /v2/jobs">client.jobs.<a href="./src/nimble_python/resources/jobs/jobs.py">create</a>(\*\*<a href="src/nimble_python/types/job_create_params.py">params</a>) -> <a href="./src/nimble_python/types/job_create_response.py">JobCreateResponse</a></code>
+- <code title="patch /v2/jobs/{job_id}">client.jobs.<a href="./src/nimble_python/resources/jobs/jobs.py">update</a>(job_id, \*\*<a href="src/nimble_python/types/job_update_params.py">params</a>) -> <a href="./src/nimble_python/types/job_update_response.py">JobUpdateResponse</a></code>
+- <code title="get /v2/jobs">client.jobs.<a href="./src/nimble_python/resources/jobs/jobs.py">list</a>(\*\*<a href="src/nimble_python/types/job_list_params.py">params</a>) -> <a href="./src/nimble_python/types/job_list_response.py">JobListResponse</a></code>
+- <code title="delete /v2/jobs/{job_id}">client.jobs.<a href="./src/nimble_python/resources/jobs/jobs.py">delete</a>(job_id) -> None</code>
+- <code title="get /v2/jobs/{job_id}">client.jobs.<a href="./src/nimble_python/resources/jobs/jobs.py">get</a>(job_id) -> <a href="./src/nimble_python/types/job_get_response.py">JobGetResponse</a></code>
+
+## Runs
+
+Types:
+
+```python
+from nimble_python.types.jobs import (
+    RunCreateResponse,
+    RunListResponse,
+    RunCancelResponse,
+    RunGetResponse,
+)
+```
+
+Methods:
+
+- <code title="post /v2/jobs/{job_id}/runs">client.jobs.runs.<a href="./src/nimble_python/resources/jobs/runs/runs.py">create</a>(job_id) -> <a href="./src/nimble_python/types/jobs/run_create_response.py">RunCreateResponse</a></code>
+- <code title="get /v2/jobs/{job_id}/runs">client.jobs.runs.<a href="./src/nimble_python/resources/jobs/runs/runs.py">list</a>(job_id, \*\*<a href="src/nimble_python/types/jobs/run_list_params.py">params</a>) -> <a href="./src/nimble_python/types/jobs/run_list_response.py">RunListResponse</a></code>
+- <code title="post /v2/jobs/runs/{run_id}/cancel">client.jobs.runs.<a href="./src/nimble_python/resources/jobs/runs/runs.py">cancel</a>(run_id) -> <a href="./src/nimble_python/types/jobs/run_cancel_response.py">RunCancelResponse</a></code>
+- <code title="get /v2/jobs/runs/{run_id}">client.jobs.runs.<a href="./src/nimble_python/resources/jobs/runs/runs.py">get</a>(run_id) -> <a href="./src/nimble_python/types/jobs/run_get_response.py">RunGetResponse</a></code>
+
+### Artifacts
+
+Types:
+
+```python
+from nimble_python.types.jobs.runs import (
+    ArtifactListResponse,
+    ArtifactDownloadURLResponse,
+    ArtifactGetResponse,
+    ArtifactPreviewResponse,
+)
+```
+
+Methods:
+
+- <code title="get /v2/jobs/runs/{run_id}/artifacts">client.jobs.runs.artifacts.<a href="./src/nimble_python/resources/jobs/runs/artifacts.py">list</a>(run_id) -> <a href="./src/nimble_python/types/jobs/runs/artifact_list_response.py">ArtifactListResponse</a></code>
+- <code title="get /v2/jobs/runs/{run_id}/artifacts/{artifact_id}/download-url">client.jobs.runs.artifacts.<a href="./src/nimble_python/resources/jobs/runs/artifacts.py">download_url</a>(artifact_id, \*, run_id) -> <a href="./src/nimble_python/types/jobs/runs/artifact_download_url_response.py">ArtifactDownloadURLResponse</a></code>
+- <code title="get /v2/jobs/runs/{run_id}/artifacts/{artifact_id}">client.jobs.runs.artifacts.<a href="./src/nimble_python/resources/jobs/runs/artifacts.py">get</a>(artifact_id, \*, run_id) -> <a href="./src/nimble_python/types/jobs/runs/artifact_get_response.py">ArtifactGetResponse</a></code>
+- <code title="get /v2/jobs/runs/{run_id}/artifacts/{artifact_id}/preview">client.jobs.runs.artifacts.<a href="./src/nimble_python/resources/jobs/runs/artifacts.py">preview</a>(artifact_id, \*, run_id) -> <a href="./src/nimble_python/types/jobs/runs/artifact_preview_response.py">ArtifactPreviewResponse</a></code>

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

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