rapidata 0.4.0__py3-none-any.whl → 0.5.0__py3-none-any.whl

rapidata/api_client/api/rapid_api.py

@@ -313,7 +313,7 @@ class RapidApi:
     def rapid_create_demographic_rapid_post(
         self,
         model: Optional[CreateDemographicRapidModel] = None,
-        file: Optional[List[Union[StrictBytes, StrictStr, Tuple[StrictStr, StrictBytes]]]] = None,
+        file: Annotated[Optional[List[Union[StrictBytes, StrictStr, Tuple[StrictStr, StrictBytes]]]], Field(description="The file to use as the asset for the rapid.")] = None,
         _request_timeout: Union[
             None,
             Annotated[StrictFloat, Field(gt=0)],
@@ -332,7 +332,7 @@ class RapidApi:
 
         :param model:
         :type model: CreateDemographicRapidModel
-        :param file:
+        :param file: The file to use as the asset for the rapid.
         :type file: List[bytearray]
         :param _request_timeout: timeout setting for this request. If one
                                  number provided, it will be total request
@@ -383,7 +383,7 @@ class RapidApi:
     def rapid_create_demographic_rapid_post_with_http_info(
         self,
         model: Optional[CreateDemographicRapidModel] = None,
-        file: Optional[List[Union[StrictBytes, StrictStr, Tuple[StrictStr, StrictBytes]]]] = None,
+        file: Annotated[Optional[List[Union[StrictBytes, StrictStr, Tuple[StrictStr, StrictBytes]]]], Field(description="The file to use as the asset for the rapid.")] = None,
         _request_timeout: Union[
             None,
             Annotated[StrictFloat, Field(gt=0)],
@@ -402,7 +402,7 @@ class RapidApi:
 
         :param model:
         :type model: CreateDemographicRapidModel
-        :param file:
+        :param file: The file to use as the asset for the rapid.
         :type file: List[bytearray]
         :param _request_timeout: timeout setting for this request. If one
                                  number provided, it will be total request
@@ -453,7 +453,7 @@ class RapidApi:
     def rapid_create_demographic_rapid_post_without_preload_content(
         self,
         model: Optional[CreateDemographicRapidModel] = None,
-        file: Optional[List[Union[StrictBytes, StrictStr, Tuple[StrictStr, StrictBytes]]]] = None,
+        file: Annotated[Optional[List[Union[StrictBytes, StrictStr, Tuple[StrictStr, StrictBytes]]]], Field(description="The file to use as the asset for the rapid.")] = None,
         _request_timeout: Union[
             None,
             Annotated[StrictFloat, Field(gt=0)],
@@ -472,7 +472,7 @@ class RapidApi:
 
         :param model:
         :type model: CreateDemographicRapidModel
-        :param file:
+        :param file: The file to use as the asset for the rapid.
         :type file: List[bytearray]
         :param _request_timeout: timeout setting for this request. If one
                                  number provided, it will be total request

rapidata/api_client/api/simple_workflow_api.py

@@ -0,0 +1,350 @@
+# coding: utf-8
+
+"""
+    Rapidata.Dataset
+
+    No description provided (generated by Openapi Generator https://github.com/openapitools/openapi-generator)
+
+    The version of the OpenAPI document: v1
+    Generated by OpenAPI Generator (https://openapi-generator.tech)
+
+    Do not edit the class manually.
+"""  # noqa: E501
+
+import warnings
+from pydantic import validate_call, Field, StrictFloat, StrictStr, StrictInt
+from typing import Any, Dict, List, Optional, Tuple, Union
+from typing_extensions import Annotated
+
+from pydantic import Field, StrictInt, StrictStr
+from typing import Optional
+from typing_extensions import Annotated
+from rapidata.api_client.models.simple_workflow_get_result_overview_get200_response import SimpleWorkflowGetResultOverviewGet200Response
+
+from rapidata.api_client.api_client import ApiClient, RequestSerialized
+from rapidata.api_client.api_response import ApiResponse
+from rapidata.api_client.rest import RESTResponseType
+
+
+class SimpleWorkflowApi:
+    """NOTE: This class is auto generated by OpenAPI Generator
+    Ref: https://openapi-generator.tech
+
+    Do not edit the class manually.
+    """
+
+    def __init__(self, api_client=None) -> None:
+        if api_client is None:
+            api_client = ApiClient.get_default()
+        self.api_client = api_client
+
+
+    @validate_call
+    def simple_workflow_get_result_overview_get(
+        self,
+        workflow_id: Annotated[StrictStr, Field(description="The ID of the workflow.")],
+        not_started_display_count: Annotated[Optional[StrictInt], Field(description="The number of rapids that have not started to return.")] = None,
+        in_progress_display_count: Annotated[Optional[StrictInt], Field(description="The number of rapids that are in progress to return.")] = None,
+        completed_display_count: Annotated[Optional[StrictInt], Field(description="The number of rapids that are completed to return.")] = None,
+        _request_timeout: Union[
+            None,
+            Annotated[StrictFloat, Field(gt=0)],
+            Tuple[
+                Annotated[StrictFloat, Field(gt=0)],
+                Annotated[StrictFloat, Field(gt=0)]
+            ]
+        ] = None,
+        _request_auth: Optional[Dict[StrictStr, Any]] = None,
+        _content_type: Optional[StrictStr] = None,
+        _headers: Optional[Dict[StrictStr, Any]] = None,
+        _host_index: Annotated[StrictInt, Field(ge=0, le=0)] = 0,
+    ) -> SimpleWorkflowGetResultOverviewGet200Response:
+        """Get the result overview for a simple workflow.
+
+
+        :param workflow_id: The ID of the workflow. (required)
+        :type workflow_id: str
+        :param not_started_display_count: The number of rapids that have not started to return.
+        :type not_started_display_count: int
+        :param in_progress_display_count: The number of rapids that are in progress to return.
+        :type in_progress_display_count: int
+        :param completed_display_count: The number of rapids that are completed to return.
+        :type completed_display_count: int
+        :param _request_timeout: timeout setting for this request. If one
+                                 number provided, it will be total request
+                                 timeout. It can also be a pair (tuple) of
+                                 (connection, read) timeouts.
+        :type _request_timeout: int, tuple(int, int), optional
+        :param _request_auth: set to override the auth_settings for an a single
+                              request; this effectively ignores the
+                              authentication in the spec for a single request.
+        :type _request_auth: dict, optional
+        :param _content_type: force content-type for the request.
+        :type _content_type: str, Optional
+        :param _headers: set to override the headers for a single
+                         request; this effectively ignores the headers
+                         in the spec for a single request.
+        :type _headers: dict, optional
+        :param _host_index: set to override the host_index for a single
+                            request; this effectively ignores the host_index
+                            in the spec for a single request.
+        :type _host_index: int, optional
+        :return: Returns the result object.
+        """ # noqa: E501
+
+        _param = self._simple_workflow_get_result_overview_get_serialize(
+            workflow_id=workflow_id,
+            not_started_display_count=not_started_display_count,
+            in_progress_display_count=in_progress_display_count,
+            completed_display_count=completed_display_count,
+            _request_auth=_request_auth,
+            _content_type=_content_type,
+            _headers=_headers,
+            _host_index=_host_index
+        )
+
+        _response_types_map: Dict[str, Optional[str]] = {
+            '200': "SimpleWorkflowGetResultOverviewGet200Response",
+        }
+        response_data = self.api_client.call_api(
+            *_param,
+            _request_timeout=_request_timeout
+        )
+        response_data.read()
+        return self.api_client.response_deserialize(
+            response_data=response_data,
+            response_types_map=_response_types_map,
+        ).data
+
+
+    @validate_call
+    def simple_workflow_get_result_overview_get_with_http_info(
+        self,
+        workflow_id: Annotated[StrictStr, Field(description="The ID of the workflow.")],
+        not_started_display_count: Annotated[Optional[StrictInt], Field(description="The number of rapids that have not started to return.")] = None,
+        in_progress_display_count: Annotated[Optional[StrictInt], Field(description="The number of rapids that are in progress to return.")] = None,
+        completed_display_count: Annotated[Optional[StrictInt], Field(description="The number of rapids that are completed to return.")] = None,
+        _request_timeout: Union[
+            None,
+            Annotated[StrictFloat, Field(gt=0)],
+            Tuple[
+                Annotated[StrictFloat, Field(gt=0)],
+                Annotated[StrictFloat, Field(gt=0)]
+            ]
+        ] = None,
+        _request_auth: Optional[Dict[StrictStr, Any]] = None,
+        _content_type: Optional[StrictStr] = None,
+        _headers: Optional[Dict[StrictStr, Any]] = None,
+        _host_index: Annotated[StrictInt, Field(ge=0, le=0)] = 0,
+    ) -> ApiResponse[SimpleWorkflowGetResultOverviewGet200Response]:
+        """Get the result overview for a simple workflow.
+
+
+        :param workflow_id: The ID of the workflow. (required)
+        :type workflow_id: str
+        :param not_started_display_count: The number of rapids that have not started to return.
+        :type not_started_display_count: int
+        :param in_progress_display_count: The number of rapids that are in progress to return.
+        :type in_progress_display_count: int
+        :param completed_display_count: The number of rapids that are completed to return.
+        :type completed_display_count: int
+        :param _request_timeout: timeout setting for this request. If one
+                                 number provided, it will be total request
+                                 timeout. It can also be a pair (tuple) of
+                                 (connection, read) timeouts.
+        :type _request_timeout: int, tuple(int, int), optional
+        :param _request_auth: set to override the auth_settings for an a single
+                              request; this effectively ignores the
+                              authentication in the spec for a single request.
+        :type _request_auth: dict, optional
+        :param _content_type: force content-type for the request.
+        :type _content_type: str, Optional
+        :param _headers: set to override the headers for a single
+                         request; this effectively ignores the headers
+                         in the spec for a single request.
+        :type _headers: dict, optional
+        :param _host_index: set to override the host_index for a single
+                            request; this effectively ignores the host_index
+                            in the spec for a single request.
+        :type _host_index: int, optional
+        :return: Returns the result object.
+        """ # noqa: E501
+
+        _param = self._simple_workflow_get_result_overview_get_serialize(
+            workflow_id=workflow_id,
+            not_started_display_count=not_started_display_count,
+            in_progress_display_count=in_progress_display_count,
+            completed_display_count=completed_display_count,
+            _request_auth=_request_auth,
+            _content_type=_content_type,
+            _headers=_headers,
+            _host_index=_host_index
+        )
+
+        _response_types_map: Dict[str, Optional[str]] = {
+            '200': "SimpleWorkflowGetResultOverviewGet200Response",
+        }
+        response_data = self.api_client.call_api(
+            *_param,
+            _request_timeout=_request_timeout
+        )
+        response_data.read()
+        return self.api_client.response_deserialize(
+            response_data=response_data,
+            response_types_map=_response_types_map,
+        )
+
+
+    @validate_call
+    def simple_workflow_get_result_overview_get_without_preload_content(
+        self,
+        workflow_id: Annotated[StrictStr, Field(description="The ID of the workflow.")],
+        not_started_display_count: Annotated[Optional[StrictInt], Field(description="The number of rapids that have not started to return.")] = None,
+        in_progress_display_count: Annotated[Optional[StrictInt], Field(description="The number of rapids that are in progress to return.")] = None,
+        completed_display_count: Annotated[Optional[StrictInt], Field(description="The number of rapids that are completed to return.")] = None,
+        _request_timeout: Union[
+            None,
+            Annotated[StrictFloat, Field(gt=0)],
+            Tuple[
+                Annotated[StrictFloat, Field(gt=0)],
+                Annotated[StrictFloat, Field(gt=0)]
+            ]
+        ] = None,
+        _request_auth: Optional[Dict[StrictStr, Any]] = None,
+        _content_type: Optional[StrictStr] = None,
+        _headers: Optional[Dict[StrictStr, Any]] = None,
+        _host_index: Annotated[StrictInt, Field(ge=0, le=0)] = 0,
+    ) -> RESTResponseType:
+        """Get the result overview for a simple workflow.
+
+
+        :param workflow_id: The ID of the workflow. (required)
+        :type workflow_id: str
+        :param not_started_display_count: The number of rapids that have not started to return.
+        :type not_started_display_count: int
+        :param in_progress_display_count: The number of rapids that are in progress to return.
+        :type in_progress_display_count: int
+        :param completed_display_count: The number of rapids that are completed to return.
+        :type completed_display_count: int
+        :param _request_timeout: timeout setting for this request. If one
+                                 number provided, it will be total request
+                                 timeout. It can also be a pair (tuple) of
+                                 (connection, read) timeouts.
+        :type _request_timeout: int, tuple(int, int), optional
+        :param _request_auth: set to override the auth_settings for an a single
+                              request; this effectively ignores the
+                              authentication in the spec for a single request.
+        :type _request_auth: dict, optional
+        :param _content_type: force content-type for the request.
+        :type _content_type: str, Optional
+        :param _headers: set to override the headers for a single
+                         request; this effectively ignores the headers
+                         in the spec for a single request.
+        :type _headers: dict, optional
+        :param _host_index: set to override the host_index for a single
+                            request; this effectively ignores the host_index
+                            in the spec for a single request.
+        :type _host_index: int, optional
+        :return: Returns the result object.
+        """ # noqa: E501
+
+        _param = self._simple_workflow_get_result_overview_get_serialize(
+            workflow_id=workflow_id,
+            not_started_display_count=not_started_display_count,
+            in_progress_display_count=in_progress_display_count,
+            completed_display_count=completed_display_count,
+            _request_auth=_request_auth,
+            _content_type=_content_type,
+            _headers=_headers,
+            _host_index=_host_index
+        )
+
+        _response_types_map: Dict[str, Optional[str]] = {
+            '200': "SimpleWorkflowGetResultOverviewGet200Response",
+        }
+        response_data = self.api_client.call_api(
+            *_param,
+            _request_timeout=_request_timeout
+        )
+        return response_data.response
+
+
+    def _simple_workflow_get_result_overview_get_serialize(
+        self,
+        workflow_id,
+        not_started_display_count,
+        in_progress_display_count,
+        completed_display_count,
+        _request_auth,
+        _content_type,
+        _headers,
+        _host_index,
+    ) -> RequestSerialized:
+
+        _host = None
+
+        _collection_formats: Dict[str, str] = {
+        }
+
+        _path_params: Dict[str, str] = {}
+        _query_params: List[Tuple[str, str]] = []
+        _header_params: Dict[str, Optional[str]] = _headers or {}
+        _form_params: List[Tuple[str, str]] = []
+        _files: Dict[
+            str, Union[str, bytes, List[str], List[bytes], List[Tuple[str, bytes]]]
+        ] = {}
+        _body_params: Optional[bytes] = None
+
+        # process the path parameters
+        # process the query parameters
+        if workflow_id is not None:
+            
+            _query_params.append(('WorkflowId', workflow_id))
+            
+        if not_started_display_count is not None:
+            
+            _query_params.append(('NotStartedDisplayCount', not_started_display_count))
+            
+        if in_progress_display_count is not None:
+            
+            _query_params.append(('InProgressDisplayCount', in_progress_display_count))
+            
+        if completed_display_count is not None:
+            
+            _query_params.append(('CompletedDisplayCount', completed_display_count))
+            
+        # process the header parameters
+        # process the form parameters
+        # process the body parameter
+
+
+        # set the HTTP header `Accept`
+        if 'Accept' not in _header_params:
+            _header_params['Accept'] = self.api_client.select_header_accept(
+                [
+                    'application/json'
+                ]
+            )
+
+
+        # authentication setting
+        _auth_settings: List[str] = [
+            'bearer'
+        ]
+
+        return self.api_client.param_serialize(
+            method='GET',
+            resource_path='/SimpleWorkflow/GetResultOverview',
+            path_params=_path_params,
+            query_params=_query_params,
+            header_params=_header_params,
+            body=_body_params,
+            post_params=_form_params,
+            files=_files,
+            auth_settings=_auth_settings,
+            collection_formats=_collection_formats,
+            _host=_host,
+            _request_auth=_request_auth
+        )
+
+

rapidata/api_client/api/validation_api.py

@@ -50,7 +50,7 @@ class ValidationApi:
     def validation_add_validation_rapid_post(
         self,
         model: Optional[AddValidationRapidModel] = None,
-        files: Optional[List[Union[StrictBytes, StrictStr, Tuple[StrictStr, StrictBytes]]]] = None,
+        files: Annotated[Optional[List[Union[StrictBytes, StrictStr, Tuple[StrictStr, StrictBytes]]]], Field(description="The files to be used as assets for the validation rapid. Each file will create a new rapid.")] = None,
         _request_timeout: Union[
             None,
             Annotated[StrictFloat, Field(gt=0)],
@@ -69,7 +69,7 @@ class ValidationApi:
 
         :param model:
         :type model: AddValidationRapidModel
-        :param files:
+        :param files: The files to be used as assets for the validation rapid. Each file will create a new rapid.
         :type files: List[bytearray]
         :param _request_timeout: timeout setting for this request. If one
                                  number provided, it will be total request
@@ -120,7 +120,7 @@ class ValidationApi:
     def validation_add_validation_rapid_post_with_http_info(
         self,
         model: Optional[AddValidationRapidModel] = None,
-        files: Optional[List[Union[StrictBytes, StrictStr, Tuple[StrictStr, StrictBytes]]]] = None,
+        files: Annotated[Optional[List[Union[StrictBytes, StrictStr, Tuple[StrictStr, StrictBytes]]]], Field(description="The files to be used as assets for the validation rapid. Each file will create a new rapid.")] = None,
         _request_timeout: Union[
             None,
             Annotated[StrictFloat, Field(gt=0)],
@@ -139,7 +139,7 @@ class ValidationApi:
 
         :param model:
         :type model: AddValidationRapidModel
-        :param files:
+        :param files: The files to be used as assets for the validation rapid. Each file will create a new rapid.
         :type files: List[bytearray]
         :param _request_timeout: timeout setting for this request. If one
                                  number provided, it will be total request
@@ -190,7 +190,7 @@ class ValidationApi:
     def validation_add_validation_rapid_post_without_preload_content(
         self,
         model: Optional[AddValidationRapidModel] = None,
-        files: Optional[List[Union[StrictBytes, StrictStr, Tuple[StrictStr, StrictBytes]]]] = None,
+        files: Annotated[Optional[List[Union[StrictBytes, StrictStr, Tuple[StrictStr, StrictBytes]]]], Field(description="The files to be used as assets for the validation rapid. Each file will create a new rapid.")] = None,
         _request_timeout: Union[
             None,
             Annotated[StrictFloat, Field(gt=0)],
@@ -209,7 +209,7 @@ class ValidationApi:
 
         :param model:
         :type model: AddValidationRapidModel
-        :param files:
+        :param files: The files to be used as assets for the validation rapid. Each file will create a new rapid.
         :type files: List[bytearray]
         :param _request_timeout: timeout setting for this request. If one
                                  number provided, it will be total request