windmill-api 1.86.0__tar.gz → 1.88.0__tar.gz

{windmill_api-1.86.0 → windmill_api-1.88.0}/PKG-INFO

@@ -1,6 +1,6 @@
 Metadata-Version: 2.1
 Name: windmill-api
-Version: 1.86.0
+Version: 1.88.0
 Summary: A client library for accessing Windmill API
 License: Apache-2.0
 Author: Ruben Fiszel

{windmill_api-1.86.0 → windmill_api-1.88.0}/pyproject.toml

@@ -1,6 +1,6 @@
 [tool.poetry]
 name = "windmill-api"
-version = "1.86.0"
+version = "1.88.0"
 description = "A client library for accessing Windmill API"
 license = "Apache-2.0"
 

{windmill_api-1.86.0 → windmill_api-1.88.0}/setup.py

@@ -12,6 +12,7 @@ packages = \
  'windmill_api.api.folder',
  'windmill_api.api.granular_acl',
  'windmill_api.api.group',
+ 'windmill_api.api.input_',
  'windmill_api.api.job',
  'windmill_api.api.oauth',
  'windmill_api.api.resource',
@@ -32,7 +33,7 @@ install_requires = \
 
 setup_kwargs = {
     'name': 'windmill-api',
-    'version': '1.86.0',
+    'version': '1.88.0',
     'description': 'A client library for accessing Windmill API',
     'long_description': '# Autogenerated Windmill OpenApi Client\nThis is the raw autogenerated api client. You are most likely more interested in [wmill](https://pypi.org/project/wmill/) which leverages this client to offer an user friendly experience. We use [this openapi python client generator](https://github.com/openapi-generators/openapi-python-client/)\n\n# windmill-api\nA client library for accessing Windmill API\n\n## Usage\nFirst, create a client:\n\n```python\nfrom windmill_api import Client\n\nclient = Client(base_url="https://api.example.com")\n```\n\nIf the endpoints you\'re going to hit require authentication, use `AuthenticatedClient` instead:\n\n```python\nfrom windmill_api import AuthenticatedClient\n\nclient = AuthenticatedClient(base_url="https://api.example.com", token="SuperSecretToken")\n```\n\nNow call your endpoint and use your models:\n\n```python\nfrom windmill_api.models import MyDataModel\nfrom windmill_api.api.my_tag import get_my_data_model\nfrom windmill_api.types import Response\n\nmy_data: MyDataModel = get_my_data_model.sync(client=client)\n# or if you need more info (e.g. status_code)\nresponse: Response[MyDataModel] = get_my_data_model.sync_detailed(client=client)\n```\n\nOr do the same thing with an async version:\n\n```python\nfrom windmill_api.models import MyDataModel\nfrom windmill_api.api.my_tag import get_my_data_model\nfrom windmill_api.types import Response\n\nmy_data: MyDataModel = await get_my_data_model.asyncio(client=client)\nresponse: Response[MyDataModel] = await get_my_data_model.asyncio_detailed(client=client)\n```\n\nBy default, when you\'re calling an HTTPS API it will attempt to verify that SSL is working correctly. Using certificate verification is highly recommended most of the time, but sometimes you may need to authenticate to a server (especially an internal server) using a custom certificate bundle.\n\n```python\nclient = AuthenticatedClient(\n    base_url="https://internal_api.example.com", \n    token="SuperSecretToken",\n    verify_ssl="/path/to/certificate_bundle.pem",\n)\n```\n\nYou can also disable certificate validation altogether, but beware that **this is a security risk**.\n\n```python\nclient = AuthenticatedClient(\n    base_url="https://internal_api.example.com", \n    token="SuperSecretToken", \n    verify_ssl=False\n)\n```\n\nThings to know:\n1. Every path/method combo becomes a Python module with four functions:\n    1. `sync`: Blocking request that returns parsed data (if successful) or `None`\n    1. `sync_detailed`: Blocking request that always returns a `Request`, optionally with `parsed` set if the request was successful.\n    1. `asyncio`: Like `sync` but async instead of blocking\n    1. `asyncio_detailed`: Like `sync_detailed` but async instead of blocking\n\n1. All path/query params, and bodies become method arguments.\n1. If your endpoint had any tags on it, the first tag will be used as a module name for the function (my_tag above)\n1. Any endpoint which did not have a tag will be in `windmill_api.api.default`\n\n',
     'author': 'Ruben Fiszel',

windmill_api-1.88.0/windmill_api/api/flow/archive_flow_by_path.py

@@ -0,0 +1,104 @@
+from typing import Any, Dict
+
+import httpx
+
+from ...client import Client
+from ...models.archive_flow_by_path_json_body import ArchiveFlowByPathJsonBody
+from ...types import Response
+
+
+def _get_kwargs(
+    workspace: str,
+    path: str,
+    *,
+    client: Client,
+    json_body: ArchiveFlowByPathJsonBody,
+) -> Dict[str, Any]:
+    url = "{}/w/{workspace}/flows/archive/{path}".format(client.base_url, workspace=workspace, path=path)
+
+    headers: Dict[str, str] = client.get_headers()
+    cookies: Dict[str, Any] = client.get_cookies()
+
+    json_json_body = json_body.to_dict()
+
+    return {
+        "method": "post",
+        "url": url,
+        "headers": headers,
+        "cookies": cookies,
+        "timeout": client.get_timeout(),
+        "json": json_json_body,
+    }
+
+
+def _build_response(*, response: httpx.Response) -> Response[Any]:
+    return Response(
+        status_code=response.status_code,
+        content=response.content,
+        headers=response.headers,
+        parsed=None,
+    )
+
+
+def sync_detailed(
+    workspace: str,
+    path: str,
+    *,
+    client: Client,
+    json_body: ArchiveFlowByPathJsonBody,
+) -> Response[Any]:
+    """archive flow by path
+
+    Args:
+        workspace (str):
+        path (str):
+        json_body (ArchiveFlowByPathJsonBody):
+
+    Returns:
+        Response[Any]
+    """
+
+    kwargs = _get_kwargs(
+        workspace=workspace,
+        path=path,
+        client=client,
+        json_body=json_body,
+    )
+
+    response = httpx.request(
+        verify=client.verify_ssl,
+        **kwargs,
+    )
+
+    return _build_response(response=response)
+
+
+async def asyncio_detailed(
+    workspace: str,
+    path: str,
+    *,
+    client: Client,
+    json_body: ArchiveFlowByPathJsonBody,
+) -> Response[Any]:
+    """archive flow by path
+
+    Args:
+        workspace (str):
+        path (str):
+        json_body (ArchiveFlowByPathJsonBody):
+
+    Returns:
+        Response[Any]
+    """
+
+    kwargs = _get_kwargs(
+        workspace=workspace,
+        path=path,
+        client=client,
+        json_body=json_body,
+    )
+
+    async with httpx.AsyncClient(verify=client.verify_ssl) as _client:
+        response = await _client.request(**kwargs)
+
+    return _build_response(response=response)

windmill_api-1.88.0/windmill_api/api/flow/get_flow_input_history_by_path.py

@@ -0,0 +1,189 @@
+from typing import Any, Dict, List, Optional, Union
+
+import httpx
+
+from ...client import Client
+from ...models.get_flow_input_history_by_path_response_200_item import GetFlowInputHistoryByPathResponse200Item
+from ...types import UNSET, Response, Unset
+
+
+def _get_kwargs(
+    workspace: str,
+    path: str,
+    *,
+    client: Client,
+    page: Union[Unset, None, int] = UNSET,
+    per_page: Union[Unset, None, int] = UNSET,
+) -> Dict[str, Any]:
+    url = "{}/w/{workspace}/flows/input_history/p/{path}".format(client.base_url, workspace=workspace, path=path)
+
+    headers: Dict[str, str] = client.get_headers()
+    cookies: Dict[str, Any] = client.get_cookies()
+
+    params: Dict[str, Any] = {}
+    params["page"] = page
+
+    params["per_page"] = per_page
+
+    params = {k: v for k, v in params.items() if v is not UNSET and v is not None}
+
+    return {
+        "method": "get",
+        "url": url,
+        "headers": headers,
+        "cookies": cookies,
+        "timeout": client.get_timeout(),
+        "params": params,
+    }
+
+
+def _parse_response(*, response: httpx.Response) -> Optional[List[GetFlowInputHistoryByPathResponse200Item]]:
+    if response.status_code == 200:
+        response_200 = []
+        _response_200 = response.json()
+        for response_200_item_data in _response_200:
+            response_200_item = GetFlowInputHistoryByPathResponse200Item.from_dict(response_200_item_data)
+
+            response_200.append(response_200_item)
+
+        return response_200
+    return None
+
+
+def _build_response(*, response: httpx.Response) -> Response[List[GetFlowInputHistoryByPathResponse200Item]]:
+    return Response(
+        status_code=response.status_code,
+        content=response.content,
+        headers=response.headers,
+        parsed=_parse_response(response=response),
+    )
+
+
+def sync_detailed(
+    workspace: str,
+    path: str,
+    *,
+    client: Client,
+    page: Union[Unset, None, int] = UNSET,
+    per_page: Union[Unset, None, int] = UNSET,
+) -> Response[List[GetFlowInputHistoryByPathResponse200Item]]:
+    """list inputs for previous completed flow jobs
+
+    Args:
+        workspace (str):
+        path (str):
+        page (Union[Unset, None, int]):
+        per_page (Union[Unset, None, int]):
+
+    Returns:
+        Response[List[GetFlowInputHistoryByPathResponse200Item]]
+    """
+
+    kwargs = _get_kwargs(
+        workspace=workspace,
+        path=path,
+        client=client,
+        page=page,
+        per_page=per_page,
+    )
+
+    response = httpx.request(
+        verify=client.verify_ssl,
+        **kwargs,
+    )
+
+    return _build_response(response=response)
+
+
+def sync(
+    workspace: str,
+    path: str,
+    *,
+    client: Client,
+    page: Union[Unset, None, int] = UNSET,
+    per_page: Union[Unset, None, int] = UNSET,
+) -> Optional[List[GetFlowInputHistoryByPathResponse200Item]]:
+    """list inputs for previous completed flow jobs
+
+    Args:
+        workspace (str):
+        path (str):
+        page (Union[Unset, None, int]):
+        per_page (Union[Unset, None, int]):
+
+    Returns:
+        Response[List[GetFlowInputHistoryByPathResponse200Item]]
+    """
+
+    return sync_detailed(
+        workspace=workspace,
+        path=path,
+        client=client,
+        page=page,
+        per_page=per_page,
+    ).parsed
+
+
+async def asyncio_detailed(
+    workspace: str,
+    path: str,
+    *,
+    client: Client,
+    page: Union[Unset, None, int] = UNSET,
+    per_page: Union[Unset, None, int] = UNSET,
+) -> Response[List[GetFlowInputHistoryByPathResponse200Item]]:
+    """list inputs for previous completed flow jobs
+
+    Args:
+        workspace (str):
+        path (str):
+        page (Union[Unset, None, int]):
+        per_page (Union[Unset, None, int]):
+
+    Returns:
+        Response[List[GetFlowInputHistoryByPathResponse200Item]]
+    """
+
+    kwargs = _get_kwargs(
+        workspace=workspace,
+        path=path,
+        client=client,
+        page=page,
+        per_page=per_page,
+    )
+
+    async with httpx.AsyncClient(verify=client.verify_ssl) as _client:
+        response = await _client.request(**kwargs)
+
+    return _build_response(response=response)
+
+
+async def asyncio(
+    workspace: str,
+    path: str,
+    *,
+    client: Client,
+    page: Union[Unset, None, int] = UNSET,
+    per_page: Union[Unset, None, int] = UNSET,
+) -> Optional[List[GetFlowInputHistoryByPathResponse200Item]]:
+    """list inputs for previous completed flow jobs
+
+    Args:
+        workspace (str):
+        path (str):
+        page (Union[Unset, None, int]):
+        per_page (Union[Unset, None, int]):
+
+    Returns:
+        Response[List[GetFlowInputHistoryByPathResponse200Item]]
+    """
+
+    return (
+        await asyncio_detailed(
+            workspace=workspace,
+            path=path,
+            client=client,
+            page=page,
+            per_page=per_page,
+        )
+    ).parsed

windmill_api-1.88.0/windmill_api/api/input_/create_input.py

@@ -0,0 +1,124 @@
+from typing import Any, Dict, Union
+
+import httpx
+
+from ...client import Client
+from ...models.create_input_json_body import CreateInputJsonBody
+from ...models.create_input_runnable_type import CreateInputRunnableType
+from ...types import UNSET, Response, Unset
+
+
+def _get_kwargs(
+    workspace: str,
+    *,
+    client: Client,
+    json_body: CreateInputJsonBody,
+    runnable_id: Union[Unset, None, str] = UNSET,
+    runnable_type: Union[Unset, None, CreateInputRunnableType] = UNSET,
+) -> Dict[str, Any]:
+    url = "{}/w/{workspace}/inputs/create".format(client.base_url, workspace=workspace)
+
+    headers: Dict[str, str] = client.get_headers()
+    cookies: Dict[str, Any] = client.get_cookies()
+
+    params: Dict[str, Any] = {}
+    params["runnable_id"] = runnable_id
+
+    json_runnable_type: Union[Unset, None, str] = UNSET
+    if not isinstance(runnable_type, Unset):
+        json_runnable_type = runnable_type.value if runnable_type else None
+
+    params["runnable_type"] = json_runnable_type
+
+    params = {k: v for k, v in params.items() if v is not UNSET and v is not None}
+
+    json_json_body = json_body.to_dict()
+
+    return {
+        "method": "post",
+        "url": url,
+        "headers": headers,
+        "cookies": cookies,
+        "timeout": client.get_timeout(),
+        "json": json_json_body,
+        "params": params,
+    }
+
+
+def _build_response(*, response: httpx.Response) -> Response[Any]:
+    return Response(
+        status_code=response.status_code,
+        content=response.content,
+        headers=response.headers,
+        parsed=None,
+    )
+
+
+def sync_detailed(
+    workspace: str,
+    *,
+    client: Client,
+    json_body: CreateInputJsonBody,
+    runnable_id: Union[Unset, None, str] = UNSET,
+    runnable_type: Union[Unset, None, CreateInputRunnableType] = UNSET,
+) -> Response[Any]:
+    """Create an Input for future use in a script or flow
+
+    Args:
+        workspace (str):
+        runnable_id (Union[Unset, None, str]):
+        runnable_type (Union[Unset, None, CreateInputRunnableType]):
+        json_body (CreateInputJsonBody):
+
+    Returns:
+        Response[Any]
+    """
+
+    kwargs = _get_kwargs(
+        workspace=workspace,
+        client=client,
+        json_body=json_body,
+        runnable_id=runnable_id,
+        runnable_type=runnable_type,
+    )
+
+    response = httpx.request(
+        verify=client.verify_ssl,
+        **kwargs,
+    )
+
+    return _build_response(response=response)
+
+
+async def asyncio_detailed(
+    workspace: str,
+    *,
+    client: Client,
+    json_body: CreateInputJsonBody,
+    runnable_id: Union[Unset, None, str] = UNSET,
+    runnable_type: Union[Unset, None, CreateInputRunnableType] = UNSET,
+) -> Response[Any]:
+    """Create an Input for future use in a script or flow
+
+    Args:
+        workspace (str):
+        runnable_id (Union[Unset, None, str]):
+        runnable_type (Union[Unset, None, CreateInputRunnableType]):
+        json_body (CreateInputJsonBody):
+
+    Returns:
+        Response[Any]
+    """
+
+    kwargs = _get_kwargs(
+        workspace=workspace,
+        client=client,
+        json_body=json_body,
+        runnable_id=runnable_id,
+        runnable_type=runnable_type,
+    )
+
+    async with httpx.AsyncClient(verify=client.verify_ssl) as _client:
+        response = await _client.request(**kwargs)
+
+    return _build_response(response=response)

windmill_api-1.86.0/windmill_api/api/flow/archive_flow_by_path.py → windmill_api-1.88.0/windmill_api/api/input_/delete_input.py

@@ -8,11 +8,11 @@ from ...types import Response
 
 def _get_kwargs(
     workspace: str,
-    path: str,
+    input_: str,
     *,
     client: Client,
 ) -> Dict[str, Any]:
-    url = "{}/w/{workspace}/flows/archive/{path}".format(client.base_url, workspace=workspace, path=path)
+    url = "{}/w/{workspace}/inputs/delete/{input}".format(client.base_url, workspace=workspace, input=input_)
 
     headers: Dict[str, str] = client.get_headers()
     cookies: Dict[str, Any] = client.get_cookies()
@@ -37,15 +37,15 @@ def _build_response(*, response: httpx.Response) -> Response[Any]:
 
 def sync_detailed(
     workspace: str,
-    path: str,
+    input_: str,
     *,
     client: Client,
 ) -> Response[Any]:
-    """archive flow by path
+    """Delete a Saved Input
 
     Args:
         workspace (str):
-        path (str):
+        input_ (str):
 
     Returns:
         Response[Any]
@@ -53,7 +53,7 @@ def sync_detailed(
 
     kwargs = _get_kwargs(
         workspace=workspace,
-        path=path,
+        input_=input_,
         client=client,
     )
 
@@ -67,15 +67,15 @@ def sync_detailed(
 
 async def asyncio_detailed(
     workspace: str,
-    path: str,
+    input_: str,
     *,
     client: Client,
 ) -> Response[Any]:
-    """archive flow by path
+    """Delete a Saved Input
 
     Args:
         workspace (str):
-        path (str):
+        input_ (str):
 
     Returns:
         Response[Any]
@@ -83,7 +83,7 @@ async def asyncio_detailed(
 
     kwargs = _get_kwargs(
         workspace=workspace,
-        path=path,
+        input_=input_,
         client=client,
     )