cirro-api-client 0.1.2__tar.gz → 0.1.3__tar.gz

{cirro_api_client-0.1.2 → cirro_api_client-0.1.3}/PKG-INFO

@@ -1,6 +1,6 @@
 Metadata-Version: 2.1
 Name: cirro_api_client
-Version: 0.1.2
+Version: 0.1.3
 Summary: A client library for accessing Cirro
 Home-page: https://github.com/CirroBio/Cirro-client-python
 License: MIT

cirro_api_client-0.1.3/cirro_api_client/v1/api/projects/archive_project.py

@@ -0,0 +1,98 @@
+from http import HTTPStatus
+from typing import Any, Dict, Optional
+
+import httpx
+
+from ... import errors
+from ...client import Client
+from ...types import Response
+
+
+def _get_kwargs(
+    project_id: str,
+) -> Dict[str, Any]:
+    _kwargs: Dict[str, Any] = {
+        "method": "put",
+        "url": f"/projects/{project_id}:archive",
+    }
+
+    return _kwargs
+
+
+def _parse_response(*, client: Client, response: httpx.Response) -> Optional[Any]:
+    if response.status_code == HTTPStatus.OK:
+        return None
+
+    errors.handle_error_response(response, client.raise_on_unexpected_status)
+
+
+def _build_response(*, client: Client, response: httpx.Response) -> Response[Any]:
+    return Response(
+        status_code=HTTPStatus(response.status_code),
+        content=response.content,
+        headers=response.headers,
+        parsed=_parse_response(client=client, response=response),
+    )
+
+
+def sync_detailed(
+    project_id: str,
+    *,
+    client: Client,
+) -> Response[Any]:
+    """Archive project
+
+     Sets the project status to archived
+
+    Args:
+        project_id (str):
+        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[Any]
+    """
+
+    kwargs = _get_kwargs(
+        project_id=project_id,
+    )
+
+    response = client.get_httpx_client().request(
+        auth=client.get_auth(),
+        **kwargs,
+    )
+
+    return _build_response(client=client, response=response)
+
+
+async def asyncio_detailed(
+    project_id: str,
+    *,
+    client: Client,
+) -> Response[Any]:
+    """Archive project
+
+     Sets the project status to archived
+
+    Args:
+        project_id (str):
+        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[Any]
+    """
+
+    kwargs = _get_kwargs(
+        project_id=project_id,
+    )
+
+    response = await client.get_async_httpx_client().request(auth=client.get_auth(), **kwargs)
+
+    return _build_response(client=client, response=response)

cirro_api_client-0.1.3/cirro_api_client/v1/api/projects/unarchive_project.py

@@ -0,0 +1,98 @@
+from http import HTTPStatus
+from typing import Any, Dict, Optional
+
+import httpx
+
+from ... import errors
+from ...client import Client
+from ...types import Response
+
+
+def _get_kwargs(
+    project_id: str,
+) -> Dict[str, Any]:
+    _kwargs: Dict[str, Any] = {
+        "method": "put",
+        "url": f"/projects/{project_id}:unarchive",
+    }
+
+    return _kwargs
+
+
+def _parse_response(*, client: Client, response: httpx.Response) -> Optional[Any]:
+    if response.status_code == HTTPStatus.OK:
+        return None
+
+    errors.handle_error_response(response, client.raise_on_unexpected_status)
+
+
+def _build_response(*, client: Client, response: httpx.Response) -> Response[Any]:
+    return Response(
+        status_code=HTTPStatus(response.status_code),
+        content=response.content,
+        headers=response.headers,
+        parsed=_parse_response(client=client, response=response),
+    )
+
+
+def sync_detailed(
+    project_id: str,
+    *,
+    client: Client,
+) -> Response[Any]:
+    """Unarchive project
+
+     Sets the project status to active
+
+    Args:
+        project_id (str):
+        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[Any]
+    """
+
+    kwargs = _get_kwargs(
+        project_id=project_id,
+    )
+
+    response = client.get_httpx_client().request(
+        auth=client.get_auth(),
+        **kwargs,
+    )
+
+    return _build_response(client=client, response=response)
+
+
+async def asyncio_detailed(
+    project_id: str,
+    *,
+    client: Client,
+) -> Response[Any]:
+    """Unarchive project
+
+     Sets the project status to active
+
+    Args:
+        project_id (str):
+        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[Any]
+    """
+
+    kwargs = _get_kwargs(
+        project_id=project_id,
+    )
+
+    response = await client.get_async_httpx_client().request(auth=client.get_auth(), **kwargs)
+
+    return _build_response(client=client, response=response)

{cirro_api_client-0.1.2 → cirro_api_client-0.1.3}/cirro_api_client/v1/models/__init__.py

@@ -37,6 +37,7 @@ from .dataset_detail_params import DatasetDetailParams
 from .dataset_viz import DatasetViz
 from .error_message import ErrorMessage
 from .executor import Executor
+from .feature_flags import FeatureFlags
 from .file_access_request import FileAccessRequest
 from .file_entry import FileEntry
 from .file_entry_metadata import FileEntryMetadata
@@ -145,6 +146,7 @@ __all__ = (
     "DatasetViz",
     "ErrorMessage",
     "Executor",
+    "FeatureFlags",
     "FileAccessRequest",
     "FileEntry",
     "FileEntryMetadata",

{cirro_api_client-0.1.2 → cirro_api_client-0.1.3}/cirro_api_client/v1/models/custom_pipeline_settings.py

@@ -23,6 +23,7 @@ class CustomPipelineSettings:
         last_sync (Union[None, Unset, datetime.datetime]): Time of last sync
         sync_status (Union[None, SyncStatus, Unset]):
         commit_hash (Union[None, Unset, str]): Commit hash of the last successful sync
+        is_authorized (Union[Unset, bool]): Whether we are authorized to access the repository Default: False.
     """
 
     repository: str
@@ -31,6 +32,7 @@ class CustomPipelineSettings:
     last_sync: Union[None, Unset, datetime.datetime] = UNSET
     sync_status: Union[None, SyncStatus, Unset] = UNSET
     commit_hash: Union[None, Unset, str] = UNSET
+    is_authorized: Union[Unset, bool] = False
     additional_properties: Dict[str, Any] = _attrs_field(init=False, factory=dict)
 
     def to_dict(self) -> Dict[str, Any]:
@@ -62,6 +64,8 @@ class CustomPipelineSettings:
         else:
             commit_hash = self.commit_hash
 
+        is_authorized = self.is_authorized
+
         field_dict: Dict[str, Any] = {}
         field_dict.update(self.additional_properties)
         field_dict.update(
@@ -79,6 +83,8 @@ class CustomPipelineSettings:
             field_dict["syncStatus"] = sync_status
         if commit_hash is not UNSET:
             field_dict["commitHash"] = commit_hash
+        if is_authorized is not UNSET:
+            field_dict["isAuthorized"] = is_authorized
 
         return field_dict
 
@@ -134,6 +140,8 @@ class CustomPipelineSettings:
 
         commit_hash = _parse_commit_hash(d.pop("commitHash", UNSET))
 
+        is_authorized = d.pop("isAuthorized", UNSET)
+
         custom_pipeline_settings = cls(
             repository=repository,
             branch=branch,
@@ -141,6 +149,7 @@ class CustomPipelineSettings:
             last_sync=last_sync,
             sync_status=sync_status,
             commit_hash=commit_hash,
+            is_authorized=is_authorized,
         )
 
         custom_pipeline_settings.additional_properties = d

{cirro_api_client-0.1.2 → cirro_api_client-0.1.3}/cirro_api_client/v1/models/dataset_viz.py

@@ -15,13 +15,13 @@ class DatasetViz:
         name (Union[Unset, str]): Name of viz
         desc (Union[Unset, str]): Description of viz
         type (Union[Unset, str]): Type of viz Example: vitescce.
-        config (Union[Unset, str]): Path to config file used to render viz
+        config (Union[Unset, Any]): Config or path to config used to render viz
     """
 
     name: Union[Unset, str] = UNSET
     desc: Union[Unset, str] = UNSET
     type: Union[Unset, str] = UNSET
-    config: Union[Unset, str] = UNSET
+    config: Union[Unset, Any] = UNSET
     additional_properties: Dict[str, Any] = _attrs_field(init=False, factory=dict)
 
     def to_dict(self) -> Dict[str, Any]:

cirro_api_client-0.1.3/cirro_api_client/v1/models/feature_flags.py

@@ -0,0 +1,54 @@
+from typing import Any, Dict, List, Type, TypeVar
+
+from attrs import define as _attrs_define
+from attrs import field as _attrs_field
+
+T = TypeVar("T", bound="FeatureFlags")
+
+
+@_attrs_define
+class FeatureFlags:
+    """
+    Attributes:
+        sftp_enabled (bool):
+        governance_enabled (bool):
+    """
+
+    sftp_enabled: bool
+    governance_enabled: bool
+    additional_properties: Dict[str, Any] = _attrs_field(init=False, factory=dict)
+
+    def to_dict(self) -> Dict[str, Any]:
+        sftp_enabled = self.sftp_enabled
+
+        governance_enabled = self.governance_enabled
+
+        field_dict: Dict[str, Any] = {}
+        field_dict.update(self.additional_properties)
+        field_dict.update(
+            {
+                "sftpEnabled": sftp_enabled,
+                "governanceEnabled": governance_enabled,
+            }
+        )
+
+        return field_dict
+
+    @classmethod
+    def from_dict(cls: Type[T], src_dict: Dict[str, Any]) -> T:
+        d = src_dict.copy()
+        sftp_enabled = d.pop("sftpEnabled")
+
+        governance_enabled = d.pop("governanceEnabled")
+
+        feature_flags = cls(
+            sftp_enabled=sftp_enabled,
+            governance_enabled=governance_enabled,
+        )
+
+        feature_flags.additional_properties = d
+        return feature_flags
+
+    @property
+    def additional_keys(self) -> List[str]:
+        return list(self.additional_properties.keys())

{cirro_api_client-0.1.2 → cirro_api_client-0.1.3}/cirro_api_client/v1/models/process.py

@@ -16,6 +16,8 @@ class Process:
         id (str): Unique ID of the Process Example: process-hutch-magic_flute-1_0.
         name (str): Friendly name for the process Example: MAGeCK Flute.
         executor (Executor): How the workflow is executed
+        category (str): Category of the process Example: Microbial Analysis.
+        pipeline_type (str): Type of pipeline Example: nf-core.
         description (Union[Unset, str]):  Example: MAGeCK Flute enables accurate identification of essential genes with
             their related biological functions.
         data_type (Union[None, Unset, str]): Name of the data type this pipeline produces (if it is not defined, use the
@@ -34,6 +36,8 @@ class Process:
     id: str
     name: str
     executor: Executor
+    category: str
+    pipeline_type: str
     description: Union[Unset, str] = UNSET
     data_type: Union[None, Unset, str] = UNSET
     documentation_url: Union[Unset, str] = UNSET
@@ -53,6 +57,10 @@ class Process:
 
         executor = self.executor.value
 
+        category = self.category
+
+        pipeline_type = self.pipeline_type
+
         description = self.description
 
         data_type: Union[None, Unset, str]
@@ -90,6 +98,8 @@ class Process:
                 "id": id,
                 "name": name,
                 "executor": executor,
+                "category": category,
+                "pipelineType": pipeline_type,
             }
         )
         if description is not UNSET:
@@ -124,6 +134,10 @@ class Process:
 
         executor = Executor(d.pop("executor"))
 
+        category = d.pop("category")
+
+        pipeline_type = d.pop("pipelineType")
+
         description = d.pop("description", UNSET)
 
         def _parse_data_type(data: object) -> Union[None, Unset, str]:
@@ -155,6 +169,8 @@ class Process:
             id=id,
             name=name,
             executor=executor,
+            category=category,
+            pipeline_type=pipeline_type,
             description=description,
             data_type=data_type,
             documentation_url=documentation_url,

{cirro_api_client-0.1.2 → cirro_api_client-0.1.3}/cirro_api_client/v1/models/process_detail.py

@@ -29,6 +29,8 @@ class ProcessDetail:
         linked_project_ids (List[str]): Projects that can run this pipeline
         data_type (Union[None, Unset, str]): Name of the data type this pipeline produces (if it is not defined, use the
             name)
+        category (Union[Unset, str]): Category of the process Example: Microbial Analysis.
+        pipeline_type (Union[Unset, str]): Type of pipeline Example: nf-core.
         documentation_url (Union[None, Unset, str]): Link to pipeline documentation Example:
             https://docs.cirro.bio/pipelines/catalog_targeted_sequencing/#crispr-screen-analysis.
         file_requirements_message (Union[None, Unset, str]): Description of the files to be uploaded (optional)
@@ -49,6 +51,8 @@ class ProcessDetail:
     parent_process_ids: List[str]
     linked_project_ids: List[str]
     data_type: Union[None, Unset, str] = UNSET
+    category: Union[Unset, str] = UNSET
+    pipeline_type: Union[Unset, str] = UNSET
     documentation_url: Union[None, Unset, str] = UNSET
     file_requirements_message: Union[None, Unset, str] = UNSET
     pipeline_code: Union["PipelineCode", None, Unset] = UNSET
@@ -83,6 +87,10 @@ class ProcessDetail:
         else:
             data_type = self.data_type
 
+        category = self.category
+
+        pipeline_type = self.pipeline_type
+
         documentation_url: Union[None, Unset, str]
         if isinstance(self.documentation_url, Unset):
             documentation_url = UNSET
@@ -148,6 +156,10 @@ class ProcessDetail:
         )
         if data_type is not UNSET:
             field_dict["dataType"] = data_type
+        if category is not UNSET:
+            field_dict["category"] = category
+        if pipeline_type is not UNSET:
+            field_dict["pipelineType"] = pipeline_type
         if documentation_url is not UNSET:
             field_dict["documentationUrl"] = documentation_url
         if file_requirements_message is not UNSET:
@@ -197,6 +209,10 @@ class ProcessDetail:
 
         data_type = _parse_data_type(d.pop("dataType", UNSET))
 
+        category = d.pop("category", UNSET)
+
+        pipeline_type = d.pop("pipelineType", UNSET)
+
         def _parse_documentation_url(data: object) -> Union[None, Unset, str]:
             if data is None:
                 return data
@@ -293,6 +309,8 @@ class ProcessDetail:
             parent_process_ids=parent_process_ids,
             linked_project_ids=linked_project_ids,
             data_type=data_type,
+            category=category,
+            pipeline_type=pipeline_type,
             documentation_url=documentation_url,
             file_requirements_message=file_requirements_message,
             pipeline_code=pipeline_code,

{cirro_api_client-0.1.2 → cirro_api_client-0.1.3}/cirro_api_client/v1/models/project_detail.py

@@ -1,13 +1,15 @@
 import datetime
-from typing import TYPE_CHECKING, Any, Dict, List, Type, TypeVar
+from typing import TYPE_CHECKING, Any, Dict, List, Type, TypeVar, Union, cast
 
 from attrs import define as _attrs_define
 from attrs import field as _attrs_field
 from dateutil.parser import isoparse
 
 from ..models.status import Status
+from ..types import UNSET, Unset
 
 if TYPE_CHECKING:
+    from ..models.cloud_account import CloudAccount
     from ..models.contact import Contact
     from ..models.project_settings import ProjectSettings
     from ..models.tag import Tag
@@ -32,6 +34,7 @@ class ProjectDetail:
         created_by (str):
         created_at (datetime.datetime):
         updated_at (datetime.datetime):
+        account (Union['CloudAccount', None, Unset]):
     """
 
     id: str
@@ -46,9 +49,12 @@ class ProjectDetail:
     created_by: str
     created_at: datetime.datetime
     updated_at: datetime.datetime
+    account: Union["CloudAccount", None, Unset] = UNSET
     additional_properties: Dict[str, Any] = _attrs_field(init=False, factory=dict)
 
     def to_dict(self) -> Dict[str, Any]:
+        from ..models.cloud_account import CloudAccount
+
         id = self.id
 
         name = self.name
@@ -79,6 +85,14 @@ class ProjectDetail:
 
         updated_at = self.updated_at.isoformat()
 
+        account: Union[Dict[str, Any], None, Unset]
+        if isinstance(self.account, Unset):
+            account = UNSET
+        elif isinstance(self.account, CloudAccount):
+            account = self.account.to_dict()
+        else:
+            account = self.account
+
         field_dict: Dict[str, Any] = {}
         field_dict.update(self.additional_properties)
         field_dict.update(
@@ -97,11 +111,14 @@ class ProjectDetail:
                 "updatedAt": updated_at,
             }
         )
+        if account is not UNSET:
+            field_dict["account"] = account
 
         return field_dict
 
     @classmethod
     def from_dict(cls: Type[T], src_dict: Dict[str, Any]) -> T:
+        from ..models.cloud_account import CloudAccount
         from ..models.contact import Contact
         from ..models.project_settings import ProjectSettings
         from ..models.tag import Tag
@@ -141,6 +158,23 @@ class ProjectDetail:
 
         updated_at = isoparse(d.pop("updatedAt"))
 
+        def _parse_account(data: object) -> Union["CloudAccount", None, Unset]:
+            if data is None:
+                return data
+            if isinstance(data, Unset):
+                return data
+            try:
+                if not isinstance(data, dict):
+                    raise TypeError()
+                account_type_1 = CloudAccount.from_dict(data)
+
+                return account_type_1
+            except:  # noqa: E722
+                pass
+            return cast(Union["CloudAccount", None, Unset], data)
+
+        account = _parse_account(d.pop("account", UNSET))
+
         project_detail = cls(
             id=id,
             name=name,
@@ -154,6 +188,7 @@ class ProjectDetail:
             created_by=created_by,
             created_at=created_at,
             updated_at=updated_at,
+            account=account,
         )
 
         project_detail.additional_properties = d

{cirro_api_client-0.1.2 → cirro_api_client-0.1.3}/cirro_api_client/v1/models/project_role.py

@@ -6,6 +6,7 @@ class ProjectRole(str, Enum):
     COLLABORATOR = "COLLABORATOR"
     CONTRIBUTOR = "CONTRIBUTOR"
     NONE = "NONE"
+    OWNER = "OWNER"
     UNKNOWN = "UNKNOWN"
     """ This is a fallback value for when the value is not known, do not use this value when making requests """
 

{cirro_api_client-0.1.2 → cirro_api_client-0.1.3}/cirro_api_client/v1/models/project_settings.py

@@ -27,9 +27,9 @@ class ProjectSettings:
         service_connections (Union[Unset, List[str]]): List of service connections to enable
         vpc_id (Union[None, Unset, str]): VPC that the compute environment will use Example: vpc-00000000000000000.
         batch_subnets (Union[List[str], None, Unset]): List of subnets that the compute environment will use Example:
-            ["subnet-00000000000000000"].
+            ['subnet-00000000000000000'].
         sagemaker_subnets (Union[List[str], None, Unset]): List of subnets that the sagemaker instances will use
-            Example: ["subnet-00000000000000000"].
+            Example: ['subnet-00000000000000000'].
         kms_arn (Union[None, Unset, str]): KMS Key ARN to encrypt S3 objects, if not provided, default bucket encryption
             will be used
         is_discoverable (Union[None, Unset, bool]): Enables the project to be discoverable by other users Default:

{cirro_api_client-0.1.2 → cirro_api_client-0.1.3}/cirro_api_client/v1/models/system_info_response.py

@@ -19,6 +19,7 @@ class SystemInfoResponse:
         resources_bucket (str):
         references_bucket (str):
         live_endpoint (str):
+        agent_endpoint (str):
         region (str):
         system_message (str):
         maintenance_mode_enabled (bool):
@@ -32,6 +33,7 @@ class SystemInfoResponse:
     resources_bucket: str
     references_bucket: str
     live_endpoint: str
+    agent_endpoint: str
     region: str
     system_message: str
     maintenance_mode_enabled: bool
@@ -49,6 +51,8 @@ class SystemInfoResponse:
 
         live_endpoint = self.live_endpoint
 
+        agent_endpoint = self.agent_endpoint
+
         region = self.region
 
         system_message = self.system_message
@@ -72,6 +76,7 @@ class SystemInfoResponse:
                 "resourcesBucket": resources_bucket,
                 "referencesBucket": references_bucket,
                 "liveEndpoint": live_endpoint,
+                "agentEndpoint": agent_endpoint,
                 "region": region,
                 "systemMessage": system_message,
                 "maintenanceModeEnabled": maintenance_mode_enabled,
@@ -98,6 +103,8 @@ class SystemInfoResponse:
 
         live_endpoint = d.pop("liveEndpoint")
 
+        agent_endpoint = d.pop("agentEndpoint")
+
         region = d.pop("region")
 
         system_message = d.pop("systemMessage")
@@ -118,6 +125,7 @@ class SystemInfoResponse:
             resources_bucket=resources_bucket,
             references_bucket=references_bucket,
             live_endpoint=live_endpoint,
+            agent_endpoint=agent_endpoint,
             region=region,
             system_message=system_message,
             maintenance_mode_enabled=maintenance_mode_enabled,

{cirro_api_client-0.1.2 → cirro_api_client-0.1.3}/cirro_api_client/v1/models/tenant_info.py

@@ -4,6 +4,7 @@ from attrs import define as _attrs_define
 from attrs import field as _attrs_field
 
 if TYPE_CHECKING:
+    from ..models.feature_flags import FeatureFlags
     from ..models.login_provider import LoginProvider
 
 
@@ -23,6 +24,7 @@ class TenantInfo:
         terms_of_service_url (str):
         privacy_policy_url (str):
         login_providers (List['LoginProvider']):
+        features (FeatureFlags):
     """
 
     id: str
@@ -34,6 +36,7 @@ class TenantInfo:
     terms_of_service_url: str
     privacy_policy_url: str
     login_providers: List["LoginProvider"]
+    features: "FeatureFlags"
     additional_properties: Dict[str, Any] = _attrs_field(init=False, factory=dict)
 
     def to_dict(self) -> Dict[str, Any]:
@@ -58,6 +61,8 @@ class TenantInfo:
             login_providers_item = login_providers_item_data.to_dict()
             login_providers.append(login_providers_item)
 
+        features = self.features.to_dict()
+
         field_dict: Dict[str, Any] = {}
         field_dict.update(self.additional_properties)
         field_dict.update(
@@ -71,6 +76,7 @@ class TenantInfo:
                 "termsOfServiceUrl": terms_of_service_url,
                 "privacyPolicyUrl": privacy_policy_url,
                 "loginProviders": login_providers,
+                "features": features,
             }
         )
 
@@ -78,6 +84,7 @@ class TenantInfo:
 
     @classmethod
     def from_dict(cls: Type[T], src_dict: Dict[str, Any]) -> T:
+        from ..models.feature_flags import FeatureFlags
         from ..models.login_provider import LoginProvider
 
         d = src_dict.copy()
@@ -104,6 +111,8 @@ class TenantInfo:
 
             login_providers.append(login_providers_item)
 
+        features = FeatureFlags.from_dict(d.pop("features"))
+
         tenant_info = cls(
             id=id,
             name=name,
@@ -114,6 +123,7 @@ class TenantInfo:
             terms_of_service_url=terms_of_service_url,
             privacy_policy_url=privacy_policy_url,
             login_providers=login_providers,
+            features=features,
         )
 
         tenant_info.additional_properties = d