octostar-python-client 0.1.759__py3-none-any.whl

octostar/api/workspace_data/get_files_tree.py

@@ -0,0 +1,397 @@
+from http import HTTPStatus
+from typing import Any, Dict, List, Optional, Union, cast
+from warnings import warn
+
+import httpx
+
+from ...client import AuthenticatedClient, Client, get_default_client
+from ...types import Response, UNSET
+from ... import errors
+
+from typing import Dict
+from ...models.get_files_tree_response_500 import GetFilesTreeResponse500
+from ...types import UNSET, Unset
+from ...models.get_files_tree_response_400 import GetFilesTreeResponse400
+from typing import Union
+from typing import cast
+from typing import Optional
+from ...models.get_files_tree_response_200 import GetFilesTreeResponse200
+from ...models.get_files_tree_response_401 import GetFilesTreeResponse401
+
+
+client_missing_msg = """No client was passed to this function. The default admin client will be used, but this is deprecated and will be removed soon.
+Please create a client using octostar.client.make_client() and run the function via client.execute()."""
+
+
+def _get_kwargs(
+    *,
+    client: Client = None,
+    os_workspace: Union[Unset, None, str] = UNSET,
+    root: Union[Unset, None, str] = UNSET,
+    recurse: Union[Unset, None, bool] = UNSET,
+    exclude_root: Union[Unset, None, bool] = UNSET,
+    flat: Union[Unset, None, bool] = UNSET,
+    minimal: Union[Unset, None, bool] = UNSET,
+    structure: Union[Unset, None, bool] = UNSET,
+    accept: Union[Unset, str] = "application/json",
+) -> Dict[str, Any]:
+    if not client:
+        warn(client_missing_msg, FutureWarning, stacklevel=2)
+        client = get_default_client()
+        # raise RuntimeError("Missing client!")
+
+    base_url = client.get_base_url_v1()
+    url = "{}/api/v1/files/tree".format(base_url)
+
+    headers: Dict[str, str] = client.get_headers()
+    cookies: Dict[str, Any] = client.get_cookies()
+
+    if not isinstance(accept, Unset):
+        headers["Accept"] = accept
+
+    params: Dict[str, Any] = {}
+    params["os_workspace"] = os_workspace
+
+    params["root"] = root
+
+    params["recurse"] = recurse
+
+    params["exclude_root"] = exclude_root
+
+    params["flat"] = flat
+
+    params["minimal"] = minimal
+
+    params["structure"] = structure
+
+    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(),
+        "follow_redirects": client.follow_redirects,
+        "params": params,
+    }
+
+
+def _parse_response(*, client: Client = None, response: httpx.Response) -> Optional[
+    Union[
+        GetFilesTreeResponse200,
+        GetFilesTreeResponse400,
+        GetFilesTreeResponse401,
+        GetFilesTreeResponse500,
+    ]
+]:
+    if not client:
+        warn(client_missing_msg, FutureWarning, stacklevel=2)
+        client = get_default_client()
+        # raise RuntimeError("Missing client!")
+    if response.status_code == HTTPStatus.OK:
+        response_200 = GetFilesTreeResponse200.from_dict(response.json())
+
+        return response_200
+    if response.status_code == HTTPStatus.BAD_REQUEST:
+        response_400 = GetFilesTreeResponse400.from_dict(response.json())
+
+        return response_400
+    if response.status_code == HTTPStatus.UNAUTHORIZED:
+        response_401 = GetFilesTreeResponse401.from_dict(response.json())
+
+        return response_401
+    if response.status_code == HTTPStatus.INTERNAL_SERVER_ERROR:
+        response_500 = GetFilesTreeResponse500.from_dict(response.json())
+
+        return response_500
+    if client.raise_on_unexpected_status:
+        raise errors.UnexpectedStatus(response.status_code, response.content)
+    else:
+        return None
+
+
+def _build_response(*, client: Client = None, response: httpx.Response) -> Response[
+    Union[
+        GetFilesTreeResponse200,
+        GetFilesTreeResponse400,
+        GetFilesTreeResponse401,
+        GetFilesTreeResponse500,
+    ]
+]:
+    if not client:
+        warn(client_missing_msg, FutureWarning, stacklevel=2)
+        client = get_default_client()
+        # raise RuntimeError("Missing client!")
+    response_kwargs = {
+        "status_code": HTTPStatus(response.status_code),
+        "content": response.content,
+        "headers": response.headers,
+        "parsed": _parse_response(client=client, response=response),
+    }
+    return Response(**response_kwargs)
+
+
+def _build_chunk_response(
+    *, client: Client = None, response: httpx.Response, chunk: bytes
+) -> Response[
+    Union[
+        GetFilesTreeResponse200,
+        GetFilesTreeResponse400,
+        GetFilesTreeResponse401,
+        GetFilesTreeResponse500,
+    ]
+]:
+    if not client:
+        warn(client_missing_msg, FutureWarning, stacklevel=2)
+        client = get_default_client()
+        # raise RuntimeError("Missing client!")
+    response_kwargs = {
+        "status_code": HTTPStatus(response.status_code),
+        "content": chunk,
+        "headers": response.headers,
+        "parsed": None,  # cannot parse incomplete chunks of data, we leave it to the user
+    }
+    return Response(**response_kwargs)
+
+
+def sync_detailed(
+    *,
+    client: Client = None,
+    os_workspace: Union[Unset, None, str] = UNSET,
+    root: Union[Unset, None, str] = UNSET,
+    recurse: Union[Unset, None, bool] = UNSET,
+    exclude_root: Union[Unset, None, bool] = UNSET,
+    flat: Union[Unset, None, bool] = UNSET,
+    minimal: Union[Unset, None, bool] = UNSET,
+    structure: Union[Unset, None, bool] = UNSET,
+    accept: Union[Unset, str] = "application/json",
+) -> Response[
+    Union[
+        GetFilesTreeResponse200,
+        GetFilesTreeResponse400,
+        GetFilesTreeResponse401,
+        GetFilesTreeResponse500,
+    ]
+]:
+    """## Get a view (subtree) of a workspace filesystem.
+
+      Get a view (subtree) of a workspace filesystem.
+
+    ### Args:
+    * `os_workspace`: os_workspace (Union[Unset, None, str]):
+    * `root`: root (Union[Unset, None, str]):
+    * `recurse`: recurse (Union[Unset, None, bool]):
+    * `exclude_root`: exclude_root (Union[Unset, None, bool]):
+    * `flat`: flat (Union[Unset, None, bool]):
+    * `minimal`: minimal (Union[Unset, None, bool]):
+    * `structure`: structure (Union[Unset, None, bool]):
+    * `Accept`: accept (Union[Unset, str]):  Default: 'application/json'.
+
+    ### Raises:
+    * `errors.UnexpectedStatus`: If the server returns an undocumented status code and Client.raise_on_unexpected_status is True.
+    * `httpx.TimeoutException`: If the request takes longer than Client.timeout.
+
+    ## Returns:
+    * `Response[Union[GetFilesTreeResponse200, GetFilesTreeResponse400, GetFilesTreeResponse401, GetFilesTreeResponse500]]`
+    """
+
+    if not client:
+        warn(client_missing_msg, FutureWarning, stacklevel=2)
+        client = get_default_client()
+        # raise RuntimeError("Missing client!")
+    kwargs = _get_kwargs(
+        client=client,
+        os_workspace=os_workspace,
+        root=root,
+        recurse=recurse,
+        exclude_root=exclude_root,
+        flat=flat,
+        minimal=minimal,
+        structure=structure,
+        accept=accept,
+    )
+
+    response = httpx.request(
+        verify=client.verify_ssl,
+        **kwargs,
+    )
+    if response.is_error:
+        print(
+            f"{str(response.status_code)} Error: {response.text} for request",
+            str(kwargs),
+        )
+    return _build_response(client=client, response=response)
+
+
+def sync(
+    *,
+    client: Client = None,
+    os_workspace: Union[Unset, None, str] = UNSET,
+    root: Union[Unset, None, str] = UNSET,
+    recurse: Union[Unset, None, bool] = UNSET,
+    exclude_root: Union[Unset, None, bool] = UNSET,
+    flat: Union[Unset, None, bool] = UNSET,
+    minimal: Union[Unset, None, bool] = UNSET,
+    structure: Union[Unset, None, bool] = UNSET,
+    accept: Union[Unset, str] = "application/json",
+) -> Optional[
+    Union[
+        GetFilesTreeResponse200,
+        GetFilesTreeResponse400,
+        GetFilesTreeResponse401,
+        GetFilesTreeResponse500,
+    ]
+]:
+    """## Get a view (subtree) of a workspace filesystem.
+
+      Get a view (subtree) of a workspace filesystem.
+
+    ### Args:
+    * `os_workspace`: os_workspace (Union[Unset, None, str]):
+    * `root`: root (Union[Unset, None, str]):
+    * `recurse`: recurse (Union[Unset, None, bool]):
+    * `exclude_root`: exclude_root (Union[Unset, None, bool]):
+    * `flat`: flat (Union[Unset, None, bool]):
+    * `minimal`: minimal (Union[Unset, None, bool]):
+    * `structure`: structure (Union[Unset, None, bool]):
+    * `Accept`: accept (Union[Unset, str]):  Default: 'application/json'.
+
+    ### Raises:
+    * `errors.UnexpectedStatus`: If the server returns an undocumented status code and Client.raise_on_unexpected_status is True.
+    * `httpx.TimeoutException`: If the request takes longer than Client.timeout.
+
+    ## Returns:
+    * `Union[GetFilesTreeResponse200, GetFilesTreeResponse400, GetFilesTreeResponse401, GetFilesTreeResponse500]`
+    """
+
+    return sync_detailed(
+        client=client,
+        os_workspace=os_workspace,
+        root=root,
+        recurse=recurse,
+        exclude_root=exclude_root,
+        flat=flat,
+        minimal=minimal,
+        structure=structure,
+        accept=accept,
+    ).parsed
+
+
+async def asyncio_detailed(
+    *,
+    client: Client = None,
+    os_workspace: Union[Unset, None, str] = UNSET,
+    root: Union[Unset, None, str] = UNSET,
+    recurse: Union[Unset, None, bool] = UNSET,
+    exclude_root: Union[Unset, None, bool] = UNSET,
+    flat: Union[Unset, None, bool] = UNSET,
+    minimal: Union[Unset, None, bool] = UNSET,
+    structure: Union[Unset, None, bool] = UNSET,
+    accept: Union[Unset, str] = "application/json",
+) -> Response[
+    Union[
+        GetFilesTreeResponse200,
+        GetFilesTreeResponse400,
+        GetFilesTreeResponse401,
+        GetFilesTreeResponse500,
+    ]
+]:
+    """## Get a view (subtree) of a workspace filesystem.
+
+      Get a view (subtree) of a workspace filesystem.
+
+    ### Args:
+    * `os_workspace`: os_workspace (Union[Unset, None, str]):
+    * `root`: root (Union[Unset, None, str]):
+    * `recurse`: recurse (Union[Unset, None, bool]):
+    * `exclude_root`: exclude_root (Union[Unset, None, bool]):
+    * `flat`: flat (Union[Unset, None, bool]):
+    * `minimal`: minimal (Union[Unset, None, bool]):
+    * `structure`: structure (Union[Unset, None, bool]):
+    * `Accept`: accept (Union[Unset, str]):  Default: 'application/json'.
+
+    ### Raises:
+    * `errors.UnexpectedStatus`: If the server returns an undocumented status code and Client.raise_on_unexpected_status is True.
+    * `httpx.TimeoutException`: If the request takes longer than Client.timeout.
+
+    ## Returns:
+    * `Response[Union[GetFilesTreeResponse200, GetFilesTreeResponse400, GetFilesTreeResponse401, GetFilesTreeResponse500]]`
+    """
+
+    if not client:
+        warn(client_missing_msg, FutureWarning, stacklevel=2)
+        client = get_default_client()
+        # raise RuntimeError("Missing client!")
+    kwargs = _get_kwargs(
+        client=client,
+        os_workspace=os_workspace,
+        root=root,
+        recurse=recurse,
+        exclude_root=exclude_root,
+        flat=flat,
+        minimal=minimal,
+        structure=structure,
+        accept=accept,
+    )
+
+    async with httpx.AsyncClient(verify=client.verify_ssl) as _client:
+        response = await _client.request(**kwargs)
+
+    return _build_response(client=client, response=response)
+
+
+async def asyncio(
+    *,
+    client: Client = None,
+    os_workspace: Union[Unset, None, str] = UNSET,
+    root: Union[Unset, None, str] = UNSET,
+    recurse: Union[Unset, None, bool] = UNSET,
+    exclude_root: Union[Unset, None, bool] = UNSET,
+    flat: Union[Unset, None, bool] = UNSET,
+    minimal: Union[Unset, None, bool] = UNSET,
+    structure: Union[Unset, None, bool] = UNSET,
+    accept: Union[Unset, str] = "application/json",
+) -> Optional[
+    Union[
+        GetFilesTreeResponse200,
+        GetFilesTreeResponse400,
+        GetFilesTreeResponse401,
+        GetFilesTreeResponse500,
+    ]
+]:
+    """## Get a view (subtree) of a workspace filesystem.
+
+      Get a view (subtree) of a workspace filesystem.
+
+    ### Args:
+    * `os_workspace`: os_workspace (Union[Unset, None, str]):
+    * `root`: root (Union[Unset, None, str]):
+    * `recurse`: recurse (Union[Unset, None, bool]):
+    * `exclude_root`: exclude_root (Union[Unset, None, bool]):
+    * `flat`: flat (Union[Unset, None, bool]):
+    * `minimal`: minimal (Union[Unset, None, bool]):
+    * `structure`: structure (Union[Unset, None, bool]):
+    * `Accept`: accept (Union[Unset, str]):  Default: 'application/json'.
+
+    ### Raises:
+    * `errors.UnexpectedStatus`: If the server returns an undocumented status code and Client.raise_on_unexpected_status is True.
+    * `httpx.TimeoutException`: If the request takes longer than Client.timeout.
+
+    ## Returns:
+    * `Union[GetFilesTreeResponse200, GetFilesTreeResponse400, GetFilesTreeResponse401, GetFilesTreeResponse500]`
+    """
+
+    return (
+        await asyncio_detailed(
+            client=client,
+            os_workspace=os_workspace,
+            root=root,
+            recurse=recurse,
+            exclude_root=exclude_root,
+            flat=flat,
+            minimal=minimal,
+            structure=structure,
+            accept=accept,
+        )
+    ).parsed

octostar/api/workspace_data/upload_blob.py

@@ -0,0 +1,235 @@
+from http import HTTPStatus
+from typing import Any, Dict, Optional, Union
+from urllib.parse import quote
+from warnings import warn
+
+import httpx
+
+from ...client import Client, get_default_client
+from ...types import Response, UNSET, Unset
+from ... import errors
+
+
+client_missing_msg = """No client was passed to this function. The default admin client will be used, but this is deprecated and will be removed soon.
+Please create a client using octostar.client.make_client() and run the function via client.execute()."""
+
+
+def _get_kwargs(
+    filename: str,
+    *,
+    client: Client = None,
+    external_url: Union[Unset, None, bool] = UNSET,
+    accept: Union[Unset, str] = "application/json",
+) -> Dict[str, Any]:
+    if not client:
+        warn(client_missing_msg, FutureWarning, stacklevel=2)
+        client = get_default_client()
+
+    base_url = client.get_base_url_v1()
+    url = "{}/api/v1/files/upload-blob/{}".format(base_url, quote(filename, safe=""))
+
+    headers: Dict[str, str] = client.get_headers()
+    cookies: Dict[str, Any] = client.get_cookies()
+
+    if not isinstance(accept, Unset):
+        headers["Accept"] = accept
+
+    params: Dict[str, Any] = {}
+    params["external_url"] = external_url
+
+    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(),
+        "follow_redirects": client.follow_redirects,
+        "params": params,
+    }
+
+
+def _parse_response(
+    *, client: Client = None, response: httpx.Response
+) -> Optional[Dict[str, Any]]:
+    if not client:
+        warn(client_missing_msg, FutureWarning, stacklevel=2)
+        client = get_default_client()
+    if response.status_code == HTTPStatus.OK:
+        return response.json()
+    if client.raise_on_unexpected_status:
+        raise errors.UnexpectedStatus(response.status_code, response.content)
+    else:
+        return None
+
+
+def _build_response(
+    *, client: Client = None, response: httpx.Response
+) -> Response[Dict[str, Any]]:
+    if not client:
+        warn(client_missing_msg, FutureWarning, stacklevel=2)
+        client = get_default_client()
+    response_kwargs = {
+        "status_code": HTTPStatus(response.status_code),
+        "content": response.content,
+        "headers": response.headers,
+        "parsed": _parse_response(client=client, response=response),
+    }
+    return Response(**response_kwargs)
+
+
+def sync_detailed(
+    filename: str,
+    *,
+    client: Client = None,
+    external_url: Union[Unset, None, bool] = UNSET,
+    accept: Union[Unset, str] = "application/json",
+) -> Response[Dict[str, Any]]:
+    """## Request upload to temp bucket
+
+      Generate presigned POST metadata for uploading a file to a temporary S3 bucket.
+      The file will be uploaded to a temporary bucket specific to the authenticated user.
+
+    ### Args:
+    * `filename`: filename (str): Name of the file to upload
+    * `external_url`: external_url (Union[Unset, None, bool]): Whether to use the external endpoint URL
+    * `Accept`: accept (Union[Unset, str]):  Default: 'application/json'.
+
+    ### Raises:
+    * `errors.UnexpectedStatus`: If the server returns an undocumented status code and Client.raise_on_unexpected_status is True.
+    * `httpx.TimeoutException`: If the request takes longer than Client.timeout.
+
+    ## Returns:
+    * `Response[Dict[str, Any]]` containing 'url' and 'fields' for presigned POST
+    """
+
+    if not client:
+        warn(client_missing_msg, FutureWarning, stacklevel=2)
+        client = get_default_client()
+    kwargs = _get_kwargs(
+        filename,
+        client=client,
+        external_url=external_url,
+        accept=accept,
+    )
+
+    response = httpx.request(
+        verify=client.verify_ssl,
+        **kwargs,
+    )
+    if response.is_error:
+        print(
+            f"{str(response.status_code)} Error: {response.text} for request",
+            str(kwargs),
+        )
+    return _build_response(client=client, response=response)
+
+
+def sync(
+    filename: str,
+    *,
+    client: Client = None,
+    external_url: Union[Unset, None, bool] = UNSET,
+    accept: Union[Unset, str] = "application/json",
+) -> Optional[Dict[str, Any]]:
+    """## Request upload to temp bucket
+
+      Generate presigned POST metadata for uploading a file to a temporary S3 bucket.
+      The file will be uploaded to a temporary bucket specific to the authenticated user.
+
+    ### Args:
+    * `filename`: filename (str): Name of the file to upload
+    * `external_url`: external_url (Union[Unset, None, bool]): Whether to use the external endpoint URL
+    * `Accept`: accept (Union[Unset, str]):  Default: 'application/json'.
+
+    ### Raises:
+    * `errors.UnexpectedStatus`: If the server returns an undocumented status code and Client.raise_on_unexpected_status is True.
+    * `httpx.TimeoutException`: If the request takes longer than Client.timeout.
+
+    ## Returns:
+    * `Optional[Dict[str, Any]]` containing 'url' and 'fields' for presigned POST
+    """
+
+    return sync_detailed(
+        filename,
+        client=client,
+        external_url=external_url,
+        accept=accept,
+    ).parsed
+
+
+async def asyncio_detailed(
+    filename: str,
+    *,
+    client: Client = None,
+    external_url: Union[Unset, None, bool] = UNSET,
+    accept: Union[Unset, str] = "application/json",
+) -> Response[Dict[str, Any]]:
+    """## Request upload to temp bucket
+
+      Generate presigned POST metadata for uploading a file to a temporary S3 bucket.
+      The file will be uploaded to a temporary bucket specific to the authenticated user.
+
+    ### Args:
+    * `filename`: filename (str): Name of the file to upload
+    * `external_url`: external_url (Union[Unset, None, bool]): Whether to use the external endpoint URL
+    * `Accept`: accept (Union[Unset, str]):  Default: 'application/json'.
+
+    ### Raises:
+    * `errors.UnexpectedStatus`: If the server returns an undocumented status code and Client.raise_on_unexpected_status is True.
+    * `httpx.TimeoutException`: If the request takes longer than Client.timeout.
+
+    ## Returns:
+    * `Response[Dict[str, Any]]` containing 'url' and 'fields' for presigned POST
+    """
+
+    if not client:
+        warn(client_missing_msg, FutureWarning, stacklevel=2)
+        client = get_default_client()
+    kwargs = _get_kwargs(
+        filename,
+        client=client,
+        external_url=external_url,
+        accept=accept,
+    )
+
+    async with httpx.AsyncClient(verify=client.verify_ssl) as _client:
+        response = await _client.request(**kwargs)
+
+    return _build_response(client=client, response=response)
+
+
+async def asyncio(
+    filename: str,
+    *,
+    client: Client = None,
+    external_url: Union[Unset, None, bool] = UNSET,
+    accept: Union[Unset, str] = "application/json",
+) -> Optional[Dict[str, Any]]:
+    """## Request upload to temp bucket
+
+      Generate presigned POST metadata for uploading a file to a temporary S3 bucket.
+      The file will be uploaded to a temporary bucket specific to the authenticated user.
+
+    ### Args:
+    * `filename`: filename (str): Name of the file to upload
+    * `external_url`: external_url (Union[Unset, None, bool]): Whether to use the external endpoint URL
+    * `Accept`: accept (Union[Unset, str]):  Default: 'application/json'.
+
+    ### Raises:
+    * `errors.UnexpectedStatus`: If the server returns an undocumented status code and Client.raise_on_unexpected_status is True.
+    * `httpx.TimeoutException`: If the request takes longer than Client.timeout.
+
+    ## Returns:
+    * `Optional[Dict[str, Any]]` containing 'url' and 'fields' for presigned POST
+    """
+
+    return (
+        await asyncio_detailed(
+            filename,
+            client=client,
+            external_url=external_url,
+            accept=accept,
+        )
+    ).parsed