cirro-api-client 0.2.3__tar.gz → 0.3.0__tar.gz

{cirro_api_client-0.2.3 → cirro_api_client-0.3.0}/PKG-INFO

@@ -1,8 +1,7 @@
-Metadata-Version: 2.1
+Metadata-Version: 2.3
 Name: cirro_api_client
-Version: 0.2.3
+Version: 0.3.0
 Summary: A client library for accessing Cirro
-Home-page: https://github.com/CirroBio/Cirro-client-python
 License: MIT
 Keywords: Cirro
 Author: Cirro

{cirro_api_client-0.2.3 → cirro_api_client-0.3.0}/cirro_api_client/v1/api/datasets/ingest_samples.py

@@ -44,7 +44,7 @@ def sync_detailed(
 ) -> Response[Any]:
     """Rerun sample ingest
 
-     Rerun sample ingest (TODO).
+     Rerun sample ingest.
 
     Args:
         project_id (str):
@@ -80,7 +80,7 @@ async def asyncio_detailed(
 ) -> Response[Any]:
     """Rerun sample ingest
 
-     Rerun sample ingest (TODO).
+     Rerun sample ingest.
 
     Args:
         project_id (str):

{cirro_api_client-0.2.3 → cirro_api_client-0.3.0}/cirro_api_client/v1/api/datasets/regenerate_manifest.py

@@ -44,7 +44,7 @@ def sync_detailed(
 ) -> Response[Any]:
     """Regenerate dataset manifest
 
-     Regenerate dataset manifest (TODO).
+     Regenerate dataset file listing.
 
     Args:
         project_id (str):
@@ -80,7 +80,7 @@ async def asyncio_detailed(
 ) -> Response[Any]:
     """Regenerate dataset manifest
 
-     Regenerate dataset manifest (TODO).
+     Regenerate dataset file listing.
 
     Args:
         project_id (str):

{cirro_api_client-0.2.3 → cirro_api_client-0.3.0}/cirro_api_client/v1/api/datasets/rerun_transform.py

@@ -44,7 +44,7 @@ def sync_detailed(
 ) -> Response[Any]:
     """Rerun data transforms
 
-     Rerun data transforms (TODO).
+     Rerun data transforms and web optimization.
 
     Args:
         project_id (str):
@@ -80,7 +80,7 @@ async def asyncio_detailed(
 ) -> Response[Any]:
     """Rerun data transforms
 
-     Rerun data transforms (TODO).
+     Rerun data transforms and web optimization.
 
     Args:
         project_id (str):

cirro_api_client-0.3.0/cirro_api_client/v1/api/file/generate_governance_file_access_token.py

@@ -0,0 +1,186 @@
+from http import HTTPStatus
+from typing import Any, Dict, Optional
+
+import httpx
+
+from ... import errors
+from ...client import Client
+from ...models.aws_credentials import AWSCredentials
+from ...models.governance_file_access_request import GovernanceFileAccessRequest
+from ...types import Response
+
+
+def _get_kwargs(
+    requirement_id: str,
+    *,
+    body: GovernanceFileAccessRequest,
+) -> Dict[str, Any]:
+    headers: Dict[str, Any] = {}
+
+    _kwargs: Dict[str, Any] = {
+        "method": "post",
+        "url": f"/governance/requirements/{requirement_id}/s3-token",
+    }
+
+    _body = body.to_dict()
+
+    _kwargs["json"] = _body
+    headers["Content-Type"] = "application/json"
+
+    _kwargs["headers"] = headers
+    return _kwargs
+
+
+def _parse_response(*, client: Client, response: httpx.Response) -> Optional[AWSCredentials]:
+    if response.status_code == HTTPStatus.OK:
+        response_200 = AWSCredentials.from_dict(response.json())
+
+        return response_200
+
+    errors.handle_error_response(response, client.raise_on_unexpected_status)
+
+
+def _build_response(*, client: Client, response: httpx.Response) -> Response[AWSCredentials]:
+    return Response(
+        status_code=HTTPStatus(response.status_code),
+        content=response.content,
+        headers=response.headers,
+        parsed=_parse_response(client=client, response=response),
+    )
+
+
+def sync_detailed(
+    requirement_id: str,
+    *,
+    client: Client,
+    body: GovernanceFileAccessRequest,
+) -> Response[AWSCredentials]:
+    """Create governance file access token
+
+     Generates credentials used for connecting via S3
+
+    Args:
+        requirement_id (str):
+        body (GovernanceFileAccessRequest):
+        client (Client): instance of the API client
+
+    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[AWSCredentials]
+    """
+
+    kwargs = _get_kwargs(
+        requirement_id=requirement_id,
+        body=body,
+    )
+
+    response = client.get_httpx_client().request(
+        auth=client.get_auth(),
+        **kwargs,
+    )
+
+    return _build_response(client=client, response=response)
+
+
+def sync(
+    requirement_id: str,
+    *,
+    client: Client,
+    body: GovernanceFileAccessRequest,
+) -> Optional[AWSCredentials]:
+    """Create governance file access token
+
+     Generates credentials used for connecting via S3
+
+    Args:
+        requirement_id (str):
+        body (GovernanceFileAccessRequest):
+        client (Client): instance of the API client
+
+    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:
+        AWSCredentials
+    """
+
+    try:
+        return sync_detailed(
+            requirement_id=requirement_id,
+            client=client,
+            body=body,
+        ).parsed
+    except errors.NotFoundException:
+        return None
+
+
+async def asyncio_detailed(
+    requirement_id: str,
+    *,
+    client: Client,
+    body: GovernanceFileAccessRequest,
+) -> Response[AWSCredentials]:
+    """Create governance file access token
+
+     Generates credentials used for connecting via S3
+
+    Args:
+        requirement_id (str):
+        body (GovernanceFileAccessRequest):
+        client (Client): instance of the API client
+
+    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[AWSCredentials]
+    """
+
+    kwargs = _get_kwargs(
+        requirement_id=requirement_id,
+        body=body,
+    )
+
+    response = await client.get_async_httpx_client().request(auth=client.get_auth(), **kwargs)
+
+    return _build_response(client=client, response=response)
+
+
+async def asyncio(
+    requirement_id: str,
+    *,
+    client: Client,
+    body: GovernanceFileAccessRequest,
+) -> Optional[AWSCredentials]:
+    """Create governance file access token
+
+     Generates credentials used for connecting via S3
+
+    Args:
+        requirement_id (str):
+        body (GovernanceFileAccessRequest):
+        client (Client): instance of the API client
+
+    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:
+        AWSCredentials
+    """
+
+    try:
+        return (
+            await asyncio_detailed(
+                requirement_id=requirement_id,
+                client=client,
+                body=body,
+            )
+        ).parsed
+    except errors.NotFoundException:
+        return None

{cirro_api_client-0.2.3 → cirro_api_client-0.3.0}/cirro_api_client/v1/api/file/generate_project_file_access_token.py

@@ -6,14 +6,14 @@ import httpx
 from ... import errors
 from ...client import Client
 from ...models.aws_credentials import AWSCredentials
-from ...models.file_access_request import FileAccessRequest
+from ...models.project_file_access_request import ProjectFileAccessRequest
 from ...types import Response
 
 
 def _get_kwargs(
     project_id: str,
     *,
-    body: FileAccessRequest,
+    body: ProjectFileAccessRequest,
 ) -> Dict[str, Any]:
     headers: Dict[str, Any] = {}
 
@@ -53,7 +53,7 @@ def sync_detailed(
     project_id: str,
     *,
     client: Client,
-    body: FileAccessRequest,
+    body: ProjectFileAccessRequest,
 ) -> Response[AWSCredentials]:
     """Create project file access token
 
@@ -61,7 +61,7 @@ def sync_detailed(
 
     Args:
         project_id (str):
-        body (FileAccessRequest):
+        body (ProjectFileAccessRequest):
         client (Client): instance of the API client
 
     Raises:
@@ -89,7 +89,7 @@ def sync(
     project_id: str,
     *,
     client: Client,
-    body: FileAccessRequest,
+    body: ProjectFileAccessRequest,
 ) -> Optional[AWSCredentials]:
     """Create project file access token
 
@@ -97,7 +97,7 @@ def sync(
 
     Args:
         project_id (str):
-        body (FileAccessRequest):
+        body (ProjectFileAccessRequest):
         client (Client): instance of the API client
 
     Raises:
@@ -122,7 +122,7 @@ async def asyncio_detailed(
     project_id: str,
     *,
     client: Client,
-    body: FileAccessRequest,
+    body: ProjectFileAccessRequest,
 ) -> Response[AWSCredentials]:
     """Create project file access token
 
@@ -130,7 +130,7 @@ async def asyncio_detailed(
 
     Args:
         project_id (str):
-        body (FileAccessRequest):
+        body (ProjectFileAccessRequest):
         client (Client): instance of the API client
 
     Raises:
@@ -155,7 +155,7 @@ async def asyncio(
     project_id: str,
     *,
     client: Client,
-    body: FileAccessRequest,
+    body: ProjectFileAccessRequest,
 ) -> Optional[AWSCredentials]:
     """Create project file access token
 
@@ -163,7 +163,7 @@ async def asyncio(
 
     Args:
         project_id (str):
-        body (FileAccessRequest):
+        body (ProjectFileAccessRequest):
         client (Client): instance of the API client
 
     Raises:

{cirro_api_client-0.2.3 → cirro_api_client-0.3.0}/cirro_api_client/v1/api/governance/create_classification.py

@@ -17,7 +17,7 @@ def _get_kwargs(
     headers: Dict[str, Any] = {}
 
     _kwargs: Dict[str, Any] = {
-        "method": "put",
+        "method": "post",
         "url": "/governance/classifications",
     }
 

cirro_api_client-0.3.0/cirro_api_client/v1/api/governance/create_contact.py

@@ -0,0 +1,173 @@
+from http import HTTPStatus
+from typing import Any, Dict, Optional
+
+import httpx
+
+from ... import errors
+from ...client import Client
+from ...models.contact_input import ContactInput
+from ...models.governance_contact import GovernanceContact
+from ...types import Response
+
+
+def _get_kwargs(
+    *,
+    body: ContactInput,
+) -> Dict[str, Any]:
+    headers: Dict[str, Any] = {}
+
+    _kwargs: Dict[str, Any] = {
+        "method": "post",
+        "url": "/governance/contacts",
+    }
+
+    _body = body.to_dict()
+
+    _kwargs["json"] = _body
+    headers["Content-Type"] = "application/json"
+
+    _kwargs["headers"] = headers
+    return _kwargs
+
+
+def _parse_response(*, client: Client, response: httpx.Response) -> Optional[GovernanceContact]:
+    if response.status_code == HTTPStatus.CREATED:
+        response_201 = GovernanceContact.from_dict(response.json())
+
+        return response_201
+
+    errors.handle_error_response(response, client.raise_on_unexpected_status)
+
+
+def _build_response(*, client: Client, response: httpx.Response) -> Response[GovernanceContact]:
+    return Response(
+        status_code=HTTPStatus(response.status_code),
+        content=response.content,
+        headers=response.headers,
+        parsed=_parse_response(client=client, response=response),
+    )
+
+
+def sync_detailed(
+    *,
+    client: Client,
+    body: ContactInput,
+) -> Response[GovernanceContact]:
+    """Create contact
+
+     Creates a contact
+
+    Args:
+        body (ContactInput):
+        client (Client): instance of the API client
+
+    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[GovernanceContact]
+    """
+
+    kwargs = _get_kwargs(
+        body=body,
+    )
+
+    response = client.get_httpx_client().request(
+        auth=client.get_auth(),
+        **kwargs,
+    )
+
+    return _build_response(client=client, response=response)
+
+
+def sync(
+    *,
+    client: Client,
+    body: ContactInput,
+) -> Optional[GovernanceContact]:
+    """Create contact
+
+     Creates a contact
+
+    Args:
+        body (ContactInput):
+        client (Client): instance of the API client
+
+    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:
+        GovernanceContact
+    """
+
+    try:
+        return sync_detailed(
+            client=client,
+            body=body,
+        ).parsed
+    except errors.NotFoundException:
+        return None
+
+
+async def asyncio_detailed(
+    *,
+    client: Client,
+    body: ContactInput,
+) -> Response[GovernanceContact]:
+    """Create contact
+
+     Creates a contact
+
+    Args:
+        body (ContactInput):
+        client (Client): instance of the API client
+
+    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[GovernanceContact]
+    """
+
+    kwargs = _get_kwargs(
+        body=body,
+    )
+
+    response = await client.get_async_httpx_client().request(auth=client.get_auth(), **kwargs)
+
+    return _build_response(client=client, response=response)
+
+
+async def asyncio(
+    *,
+    client: Client,
+    body: ContactInput,
+) -> Optional[GovernanceContact]:
+    """Create contact
+
+     Creates a contact
+
+    Args:
+        body (ContactInput):
+        client (Client): instance of the API client
+
+    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:
+        GovernanceContact
+    """
+
+    try:
+        return (
+            await asyncio_detailed(
+                client=client,
+                body=body,
+            )
+        ).parsed
+    except errors.NotFoundException:
+        return None

cirro_api_client-0.3.0/cirro_api_client/v1/api/governance/create_requirement.py

@@ -0,0 +1,173 @@
+from http import HTTPStatus
+from typing import Any, Dict, Optional
+
+import httpx
+
+from ... import errors
+from ...client import Client
+from ...models.governance_requirement import GovernanceRequirement
+from ...models.requirement_input import RequirementInput
+from ...types import Response
+
+
+def _get_kwargs(
+    *,
+    body: RequirementInput,
+) -> Dict[str, Any]:
+    headers: Dict[str, Any] = {}
+
+    _kwargs: Dict[str, Any] = {
+        "method": "post",
+        "url": "/governance/requirements",
+    }
+
+    _body = body.to_dict()
+
+    _kwargs["json"] = _body
+    headers["Content-Type"] = "application/json"
+
+    _kwargs["headers"] = headers
+    return _kwargs
+
+
+def _parse_response(*, client: Client, response: httpx.Response) -> Optional[GovernanceRequirement]:
+    if response.status_code == HTTPStatus.CREATED:
+        response_201 = GovernanceRequirement.from_dict(response.json())
+
+        return response_201
+
+    errors.handle_error_response(response, client.raise_on_unexpected_status)
+
+
+def _build_response(*, client: Client, response: httpx.Response) -> Response[GovernanceRequirement]:
+    return Response(
+        status_code=HTTPStatus(response.status_code),
+        content=response.content,
+        headers=response.headers,
+        parsed=_parse_response(client=client, response=response),
+    )
+
+
+def sync_detailed(
+    *,
+    client: Client,
+    body: RequirementInput,
+) -> Response[GovernanceRequirement]:
+    """Create requirement
+
+     Creates a requirement
+
+    Args:
+        body (RequirementInput):
+        client (Client): instance of the API client
+
+    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[GovernanceRequirement]
+    """
+
+    kwargs = _get_kwargs(
+        body=body,
+    )
+
+    response = client.get_httpx_client().request(
+        auth=client.get_auth(),
+        **kwargs,
+    )
+
+    return _build_response(client=client, response=response)
+
+
+def sync(
+    *,
+    client: Client,
+    body: RequirementInput,
+) -> Optional[GovernanceRequirement]:
+    """Create requirement
+
+     Creates a requirement
+
+    Args:
+        body (RequirementInput):
+        client (Client): instance of the API client
+
+    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:
+        GovernanceRequirement
+    """
+
+    try:
+        return sync_detailed(
+            client=client,
+            body=body,
+        ).parsed
+    except errors.NotFoundException:
+        return None
+
+
+async def asyncio_detailed(
+    *,
+    client: Client,
+    body: RequirementInput,
+) -> Response[GovernanceRequirement]:
+    """Create requirement
+
+     Creates a requirement
+
+    Args:
+        body (RequirementInput):
+        client (Client): instance of the API client
+
+    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[GovernanceRequirement]
+    """
+
+    kwargs = _get_kwargs(
+        body=body,
+    )
+
+    response = await client.get_async_httpx_client().request(auth=client.get_auth(), **kwargs)
+
+    return _build_response(client=client, response=response)
+
+
+async def asyncio(
+    *,
+    client: Client,
+    body: RequirementInput,
+) -> Optional[GovernanceRequirement]:
+    """Create requirement
+
+     Creates a requirement
+
+    Args:
+        body (RequirementInput):
+        client (Client): instance of the API client
+
+    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:
+        GovernanceRequirement
+    """
+
+    try:
+        return (
+            await asyncio_detailed(
+                client=client,
+                body=body,
+            )
+        ).parsed
+    except errors.NotFoundException:
+        return None