rapidata 1.8.3__py3-none-any.whl → 2.44.4__py3-none-any.whl

rapidata/api_client/api/workflow_api.py

@@ -1,9 +1,9 @@
 # coding: utf-8
 
 """
-    Rapidata.Dataset
+    Rapidata Asset API
 
-    No description provided (generated by Openapi Generator https://github.com/openapitools/openapi-generator)
+    The API for the Rapidata Asset service
 
     The version of the OpenAPI document: v1
     Generated by OpenAPI Generator (https://openapi-generator.tech)
@@ -16,14 +16,16 @@ 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, StrictStr
+from pydantic import Field, StrictBool, StrictInt, StrictStr
 from typing import Optional
 from typing_extensions import Annotated
+from rapidata.api_client.models.get_compare_ab_summary_result import GetCompareAbSummaryResult
+from rapidata.api_client.models.get_responses_result import GetResponsesResult
 from rapidata.api_client.models.get_workflow_by_id_result import GetWorkflowByIdResult
 from rapidata.api_client.models.get_workflow_progress_result import GetWorkflowProgressResult
-from rapidata.api_client.models.get_workflow_result_overview_result import GetWorkflowResultOverviewResult
-from rapidata.api_client.models.i_workflow_model_paged_result import IWorkflowModelPagedResult
-from rapidata.api_client.models.query_workflows_model import QueryWorkflowsModel
+from rapidata.api_client.models.paged_result_of_i_workflow_model import PagedResultOfIWorkflowModel
+from rapidata.api_client.models.query_model import QueryModel
+from rapidata.api_client.models.sort_direction import SortDirection
 
 from rapidata.api_client.api_client import ApiClient, RequestSerialized
 from rapidata.api_client.api_response import ApiResponse
@@ -275,13 +277,14 @@ class WorkflowApi:
 
         # authentication setting
         _auth_settings: List[str] = [
-            'bearer', 
-            'oauth2'
+            'OAuth2', 
+            'OpenIdConnect', 
+            'Bearer'
         ]
 
         return self.api_client.param_serialize(
             method='DELETE',
-            resource_path='/Workflow/Delete',
+            resource_path='/workflow/delete',
             path_params=_path_params,
             query_params=_query_params,
             header_params=_header_params,
@@ -298,9 +301,288 @@ class WorkflowApi:
 
 
     @validate_call
-    def workflow_get_by_id_get(
+    def workflow_workflow_id_compare_ab_summary_get(
         self,
-        workflow_id: Annotated[Optional[StrictStr], Field(description="The ID of the workflow to get.")] = None,
+        workflow_id: Annotated[StrictStr, Field(description="The ID of the workflow to get the summary for.")],
+        use_user_score: Annotated[Optional[StrictBool], Field(description="Whether to use the user score to determine the winner.")] = 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,
+    ) -> GetCompareAbSummaryResult:
+        """Calculates a summary of the results for a simple compare workflow.  The summary includes the number of times an asset at each index was the winner.
+
+
+        :param workflow_id: The ID of the workflow to get the summary for. (required)
+        :type workflow_id: str
+        :param use_user_score: Whether to use the user score to determine the winner.
+        :type use_user_score: bool
+        :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._workflow_workflow_id_compare_ab_summary_get_serialize(
+            workflow_id=workflow_id,
+            use_user_score=use_user_score,
+            _request_auth=_request_auth,
+            _content_type=_content_type,
+            _headers=_headers,
+            _host_index=_host_index
+        )
+
+        _response_types_map: Dict[str, Optional[str]] = {
+            '200': "GetCompareAbSummaryResult",
+        }
+        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 workflow_workflow_id_compare_ab_summary_get_with_http_info(
+        self,
+        workflow_id: Annotated[StrictStr, Field(description="The ID of the workflow to get the summary for.")],
+        use_user_score: Annotated[Optional[StrictBool], Field(description="Whether to use the user score to determine the winner.")] = 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[GetCompareAbSummaryResult]:
+        """Calculates a summary of the results for a simple compare workflow.  The summary includes the number of times an asset at each index was the winner.
+
+
+        :param workflow_id: The ID of the workflow to get the summary for. (required)
+        :type workflow_id: str
+        :param use_user_score: Whether to use the user score to determine the winner.
+        :type use_user_score: bool
+        :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._workflow_workflow_id_compare_ab_summary_get_serialize(
+            workflow_id=workflow_id,
+            use_user_score=use_user_score,
+            _request_auth=_request_auth,
+            _content_type=_content_type,
+            _headers=_headers,
+            _host_index=_host_index
+        )
+
+        _response_types_map: Dict[str, Optional[str]] = {
+            '200': "GetCompareAbSummaryResult",
+        }
+        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 workflow_workflow_id_compare_ab_summary_get_without_preload_content(
+        self,
+        workflow_id: Annotated[StrictStr, Field(description="The ID of the workflow to get the summary for.")],
+        use_user_score: Annotated[Optional[StrictBool], Field(description="Whether to use the user score to determine the winner.")] = 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:
+        """Calculates a summary of the results for a simple compare workflow.  The summary includes the number of times an asset at each index was the winner.
+
+
+        :param workflow_id: The ID of the workflow to get the summary for. (required)
+        :type workflow_id: str
+        :param use_user_score: Whether to use the user score to determine the winner.
+        :type use_user_score: bool
+        :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._workflow_workflow_id_compare_ab_summary_get_serialize(
+            workflow_id=workflow_id,
+            use_user_score=use_user_score,
+            _request_auth=_request_auth,
+            _content_type=_content_type,
+            _headers=_headers,
+            _host_index=_host_index
+        )
+
+        _response_types_map: Dict[str, Optional[str]] = {
+            '200': "GetCompareAbSummaryResult",
+        }
+        response_data = self.api_client.call_api(
+            *_param,
+            _request_timeout=_request_timeout
+        )
+        return response_data.response
+
+
+    def _workflow_workflow_id_compare_ab_summary_get_serialize(
+        self,
+        workflow_id,
+        use_user_score,
+        _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
+        if workflow_id is not None:
+            _path_params['workflowId'] = workflow_id
+        # process the query parameters
+        if use_user_score is not None:
+            
+            _query_params.append(('useUserScore', use_user_score))
+            
+        # 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(
+                [
+                    'text/plain', 
+                    'application/json', 
+                    'text/json'
+                ]
+            )
+
+
+        # authentication setting
+        _auth_settings: List[str] = [
+            'OAuth2', 
+            'OpenIdConnect', 
+            'Bearer'
+        ]
+
+        return self.api_client.param_serialize(
+            method='GET',
+            resource_path='/workflow/{workflowId}/compare-ab-summary',
+            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
+        )
+
+
+
+
+    @validate_call
+    def workflow_workflow_id_get(
+        self,
+        workflow_id: Annotated[StrictStr, Field(description="The ID of the workflow to get.")],
         _request_timeout: Union[
             None,
             Annotated[StrictFloat, Field(gt=0)],
@@ -317,7 +599,7 @@ class WorkflowApi:
         """Get a workflow by its ID.
 
 
-        :param workflow_id: The ID of the workflow to get.
+        :param workflow_id: The ID of the workflow to get. (required)
         :type workflow_id: str
         :param _request_timeout: timeout setting for this request. If one
                                  number provided, it will be total request
@@ -341,7 +623,7 @@ class WorkflowApi:
         :return: Returns the result object.
         """ # noqa: E501
 
-        _param = self._workflow_get_by_id_get_serialize(
+        _param = self._workflow_workflow_id_get_serialize(
             workflow_id=workflow_id,
             _request_auth=_request_auth,
             _content_type=_content_type,
@@ -364,9 +646,9 @@ class WorkflowApi:
 
 
     @validate_call
-    def workflow_get_by_id_get_with_http_info(
+    def workflow_workflow_id_get_with_http_info(
         self,
-        workflow_id: Annotated[Optional[StrictStr], Field(description="The ID of the workflow to get.")] = None,
+        workflow_id: Annotated[StrictStr, Field(description="The ID of the workflow to get.")],
         _request_timeout: Union[
             None,
             Annotated[StrictFloat, Field(gt=0)],
@@ -383,7 +665,7 @@ class WorkflowApi:
         """Get a workflow by its ID.
 
 
-        :param workflow_id: The ID of the workflow to get.
+        :param workflow_id: The ID of the workflow to get. (required)
         :type workflow_id: str
         :param _request_timeout: timeout setting for this request. If one
                                  number provided, it will be total request
@@ -407,7 +689,7 @@ class WorkflowApi:
         :return: Returns the result object.
         """ # noqa: E501
 
-        _param = self._workflow_get_by_id_get_serialize(
+        _param = self._workflow_workflow_id_get_serialize(
             workflow_id=workflow_id,
             _request_auth=_request_auth,
             _content_type=_content_type,
@@ -430,9 +712,9 @@ class WorkflowApi:
 
 
     @validate_call
-    def workflow_get_by_id_get_without_preload_content(
+    def workflow_workflow_id_get_without_preload_content(
         self,
-        workflow_id: Annotated[Optional[StrictStr], Field(description="The ID of the workflow to get.")] = None,
+        workflow_id: Annotated[StrictStr, Field(description="The ID of the workflow to get.")],
         _request_timeout: Union[
             None,
             Annotated[StrictFloat, Field(gt=0)],
@@ -449,7 +731,7 @@ class WorkflowApi:
         """Get a workflow by its ID.
 
 
-        :param workflow_id: The ID of the workflow to get.
+        :param workflow_id: The ID of the workflow to get. (required)
         :type workflow_id: str
         :param _request_timeout: timeout setting for this request. If one
                                  number provided, it will be total request
@@ -473,7 +755,7 @@ class WorkflowApi:
         :return: Returns the result object.
         """ # noqa: E501
 
-        _param = self._workflow_get_by_id_get_serialize(
+        _param = self._workflow_workflow_id_get_serialize(
             workflow_id=workflow_id,
             _request_auth=_request_auth,
             _content_type=_content_type,
@@ -491,7 +773,7 @@ class WorkflowApi:
         return response_data.response
 
 
-    def _workflow_get_by_id_get_serialize(
+    def _workflow_workflow_id_get_serialize(
         self,
         workflow_id,
         _request_auth,
@@ -515,11 +797,9 @@ class WorkflowApi:
         _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))
-            
+            _path_params['workflowId'] = workflow_id
+        # process the query parameters
         # process the header parameters
         # process the form parameters
         # process the body parameter
@@ -538,13 +818,14 @@ class WorkflowApi:
 
         # authentication setting
         _auth_settings: List[str] = [
-            'bearer', 
-            'oauth2'
+            'OAuth2', 
+            'OpenIdConnect', 
+            'Bearer'
         ]
 
         return self.api_client.param_serialize(
             method='GET',
-            resource_path='/Workflow/GetById',
+            resource_path='/workflow/{workflowId}',
             path_params=_path_params,
             query_params=_query_params,
             header_params=_header_params,
@@ -561,9 +842,9 @@ class WorkflowApi:
 
 
     @validate_call
-    def workflow_get_progress_get(
+    def workflow_workflow_id_progress_get(
         self,
-        workflow_id: Annotated[Optional[StrictStr], Field(description="The ID of the workflow to get the progress for.")] = None,
+        workflow_id: Annotated[StrictStr, Field(description="The ID of the workflow to get the progress for.")],
         _request_timeout: Union[
             None,
             Annotated[StrictFloat, Field(gt=0)],
@@ -580,7 +861,7 @@ class WorkflowApi:
         """Get the progress of a workflow.
 
 
-        :param workflow_id: The ID of the workflow to get the progress for.
+        :param workflow_id: The ID of the workflow to get the progress for. (required)
         :type workflow_id: str
         :param _request_timeout: timeout setting for this request. If one
                                  number provided, it will be total request
@@ -604,7 +885,7 @@ class WorkflowApi:
         :return: Returns the result object.
         """ # noqa: E501
 
-        _param = self._workflow_get_progress_get_serialize(
+        _param = self._workflow_workflow_id_progress_get_serialize(
             workflow_id=workflow_id,
             _request_auth=_request_auth,
             _content_type=_content_type,
@@ -627,9 +908,9 @@ class WorkflowApi:
 
 
     @validate_call
-    def workflow_get_progress_get_with_http_info(
+    def workflow_workflow_id_progress_get_with_http_info(
         self,
-        workflow_id: Annotated[Optional[StrictStr], Field(description="The ID of the workflow to get the progress for.")] = None,
+        workflow_id: Annotated[StrictStr, Field(description="The ID of the workflow to get the progress for.")],
         _request_timeout: Union[
             None,
             Annotated[StrictFloat, Field(gt=0)],
@@ -646,7 +927,7 @@ class WorkflowApi:
         """Get the progress of a workflow.
 
 
-        :param workflow_id: The ID of the workflow to get the progress for.
+        :param workflow_id: The ID of the workflow to get the progress for. (required)
         :type workflow_id: str
         :param _request_timeout: timeout setting for this request. If one
                                  number provided, it will be total request
@@ -670,7 +951,7 @@ class WorkflowApi:
         :return: Returns the result object.
         """ # noqa: E501
 
-        _param = self._workflow_get_progress_get_serialize(
+        _param = self._workflow_workflow_id_progress_get_serialize(
             workflow_id=workflow_id,
             _request_auth=_request_auth,
             _content_type=_content_type,
@@ -693,9 +974,9 @@ class WorkflowApi:
 
 
     @validate_call
-    def workflow_get_progress_get_without_preload_content(
+    def workflow_workflow_id_progress_get_without_preload_content(
         self,
-        workflow_id: Annotated[Optional[StrictStr], Field(description="The ID of the workflow to get the progress for.")] = None,
+        workflow_id: Annotated[StrictStr, Field(description="The ID of the workflow to get the progress for.")],
         _request_timeout: Union[
             None,
             Annotated[StrictFloat, Field(gt=0)],
@@ -712,7 +993,7 @@ class WorkflowApi:
         """Get the progress of a workflow.
 
 
-        :param workflow_id: The ID of the workflow to get the progress for.
+        :param workflow_id: The ID of the workflow to get the progress for. (required)
         :type workflow_id: str
         :param _request_timeout: timeout setting for this request. If one
                                  number provided, it will be total request
@@ -736,7 +1017,7 @@ class WorkflowApi:
         :return: Returns the result object.
         """ # noqa: E501
 
-        _param = self._workflow_get_progress_get_serialize(
+        _param = self._workflow_workflow_id_progress_get_serialize(
             workflow_id=workflow_id,
             _request_auth=_request_auth,
             _content_type=_content_type,
@@ -754,7 +1035,7 @@ class WorkflowApi:
         return response_data.response
 
 
-    def _workflow_get_progress_get_serialize(
+    def _workflow_workflow_id_progress_get_serialize(
         self,
         workflow_id,
         _request_auth,
@@ -778,11 +1059,9 @@ class WorkflowApi:
         _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))
-            
+            _path_params['workflowId'] = workflow_id
+        # process the query parameters
         # process the header parameters
         # process the form parameters
         # process the body parameter
@@ -801,13 +1080,14 @@ class WorkflowApi:
 
         # authentication setting
         _auth_settings: List[str] = [
-            'bearer', 
-            'oauth2'
+            'OAuth2', 
+            'OpenIdConnect', 
+            'Bearer'
         ]
 
         return self.api_client.param_serialize(
             method='GET',
-            resource_path='/Workflow/GetProgress',
+            resource_path='/workflow/{workflowId}/progress',
             path_params=_path_params,
             query_params=_query_params,
             header_params=_header_params,
@@ -824,9 +1104,11 @@ class WorkflowApi:
 
 
     @validate_call
-    def workflow_get_result_overview_get(
+    def workflow_workflow_id_responses_get(
         self,
-        workflow_id: Annotated[Optional[StrictStr], Field(description="The ID of the workflow to get the result overview for.")] = None,
+        workflow_id: Annotated[StrictStr, Field(description="The ID of the workflow to get the responses for.")],
+        limit: Annotated[Optional[StrictInt], Field(description="The number of responses to get.")] = None,
+        sort: Annotated[Optional[SortDirection], Field(description="Whether the oldest or most recent responses should be returned.")] = None,
         _request_timeout: Union[
             None,
             Annotated[StrictFloat, Field(gt=0)],
@@ -839,12 +1121,16 @@ class WorkflowApi:
         _content_type: Optional[StrictStr] = None,
         _headers: Optional[Dict[StrictStr, Any]] = None,
         _host_index: Annotated[StrictInt, Field(ge=0, le=0)] = 0,
-    ) -> GetWorkflowResultOverviewResult:
-        """Get the result overview for a workflow.
+    ) -> GetResponsesResult:
+        """Gets the limit most recent or oldest responses for a workflow.  The responses are not guaranteed to be of any specific rapid.  Instead, this endpoint returns all responses to any rapid in the workflow.
 
 
-        :param workflow_id: The ID of the workflow to get the result overview for.
+        :param workflow_id: The ID of the workflow to get the responses for. (required)
         :type workflow_id: str
+        :param limit: The number of responses to get.
+        :type limit: int
+        :param sort: Whether the oldest or most recent responses should be returned.
+        :type sort: SortDirection
         :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
@@ -867,8 +1153,10 @@ class WorkflowApi:
         :return: Returns the result object.
         """ # noqa: E501
 
-        _param = self._workflow_get_result_overview_get_serialize(
+        _param = self._workflow_workflow_id_responses_get_serialize(
             workflow_id=workflow_id,
+            limit=limit,
+            sort=sort,
             _request_auth=_request_auth,
             _content_type=_content_type,
             _headers=_headers,
@@ -876,7 +1164,7 @@ class WorkflowApi:
         )
 
         _response_types_map: Dict[str, Optional[str]] = {
-            '200': "GetWorkflowResultOverviewResult",
+            '200': "GetResponsesResult",
         }
         response_data = self.api_client.call_api(
             *_param,
@@ -890,9 +1178,11 @@ class WorkflowApi:
 
 
     @validate_call
-    def workflow_get_result_overview_get_with_http_info(
+    def workflow_workflow_id_responses_get_with_http_info(
         self,
-        workflow_id: Annotated[Optional[StrictStr], Field(description="The ID of the workflow to get the result overview for.")] = None,
+        workflow_id: Annotated[StrictStr, Field(description="The ID of the workflow to get the responses for.")],
+        limit: Annotated[Optional[StrictInt], Field(description="The number of responses to get.")] = None,
+        sort: Annotated[Optional[SortDirection], Field(description="Whether the oldest or most recent responses should be returned.")] = None,
         _request_timeout: Union[
             None,
             Annotated[StrictFloat, Field(gt=0)],
@@ -905,12 +1195,16 @@ class WorkflowApi:
         _content_type: Optional[StrictStr] = None,
         _headers: Optional[Dict[StrictStr, Any]] = None,
         _host_index: Annotated[StrictInt, Field(ge=0, le=0)] = 0,
-    ) -> ApiResponse[GetWorkflowResultOverviewResult]:
-        """Get the result overview for a workflow.
+    ) -> ApiResponse[GetResponsesResult]:
+        """Gets the limit most recent or oldest responses for a workflow.  The responses are not guaranteed to be of any specific rapid.  Instead, this endpoint returns all responses to any rapid in the workflow.
 
 
-        :param workflow_id: The ID of the workflow to get the result overview for.
+        :param workflow_id: The ID of the workflow to get the responses for. (required)
         :type workflow_id: str
+        :param limit: The number of responses to get.
+        :type limit: int
+        :param sort: Whether the oldest or most recent responses should be returned.
+        :type sort: SortDirection
         :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
@@ -933,8 +1227,10 @@ class WorkflowApi:
         :return: Returns the result object.
         """ # noqa: E501
 
-        _param = self._workflow_get_result_overview_get_serialize(
+        _param = self._workflow_workflow_id_responses_get_serialize(
             workflow_id=workflow_id,
+            limit=limit,
+            sort=sort,
             _request_auth=_request_auth,
             _content_type=_content_type,
             _headers=_headers,
@@ -942,7 +1238,7 @@ class WorkflowApi:
         )
 
         _response_types_map: Dict[str, Optional[str]] = {
-            '200': "GetWorkflowResultOverviewResult",
+            '200': "GetResponsesResult",
         }
         response_data = self.api_client.call_api(
             *_param,
@@ -956,9 +1252,11 @@ class WorkflowApi:
 
 
     @validate_call
-    def workflow_get_result_overview_get_without_preload_content(
+    def workflow_workflow_id_responses_get_without_preload_content(
         self,
-        workflow_id: Annotated[Optional[StrictStr], Field(description="The ID of the workflow to get the result overview for.")] = None,
+        workflow_id: Annotated[StrictStr, Field(description="The ID of the workflow to get the responses for.")],
+        limit: Annotated[Optional[StrictInt], Field(description="The number of responses to get.")] = None,
+        sort: Annotated[Optional[SortDirection], Field(description="Whether the oldest or most recent responses should be returned.")] = None,
         _request_timeout: Union[
             None,
             Annotated[StrictFloat, Field(gt=0)],
@@ -972,11 +1270,15 @@ class WorkflowApi:
         _headers: Optional[Dict[StrictStr, Any]] = None,
         _host_index: Annotated[StrictInt, Field(ge=0, le=0)] = 0,
     ) -> RESTResponseType:
-        """Get the result overview for a workflow.
+        """Gets the limit most recent or oldest responses for a workflow.  The responses are not guaranteed to be of any specific rapid.  Instead, this endpoint returns all responses to any rapid in the workflow.
 
 
-        :param workflow_id: The ID of the workflow to get the result overview for.
+        :param workflow_id: The ID of the workflow to get the responses for. (required)
         :type workflow_id: str
+        :param limit: The number of responses to get.
+        :type limit: int
+        :param sort: Whether the oldest or most recent responses should be returned.
+        :type sort: SortDirection
         :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
@@ -999,8 +1301,10 @@ class WorkflowApi:
         :return: Returns the result object.
         """ # noqa: E501
 
-        _param = self._workflow_get_result_overview_get_serialize(
+        _param = self._workflow_workflow_id_responses_get_serialize(
             workflow_id=workflow_id,
+            limit=limit,
+            sort=sort,
             _request_auth=_request_auth,
             _content_type=_content_type,
             _headers=_headers,
@@ -1008,7 +1312,7 @@ class WorkflowApi:
         )
 
         _response_types_map: Dict[str, Optional[str]] = {
-            '200': "GetWorkflowResultOverviewResult",
+            '200': "GetResponsesResult",
         }
         response_data = self.api_client.call_api(
             *_param,
@@ -1017,9 +1321,11 @@ class WorkflowApi:
         return response_data.response
 
 
-    def _workflow_get_result_overview_get_serialize(
+    def _workflow_workflow_id_responses_get_serialize(
         self,
         workflow_id,
+        limit,
+        sort,
         _request_auth,
         _content_type,
         _headers,
@@ -1041,10 +1347,16 @@ class WorkflowApi:
         _body_params: Optional[bytes] = None
 
         # process the path parameters
-        # process the query parameters
         if workflow_id is not None:
+            _path_params['workflowId'] = workflow_id
+        # process the query parameters
+        if limit is not None:
+            
+            _query_params.append(('limit', limit))
+            
+        if sort is not None:
             
-            _query_params.append(('workflowId', workflow_id))
+            _query_params.append(('sort', sort.value))
             
         # process the header parameters
         # process the form parameters
@@ -1064,13 +1376,14 @@ class WorkflowApi:
 
         # authentication setting
         _auth_settings: List[str] = [
-            'bearer', 
-            'oauth2'
+            'OAuth2', 
+            'OpenIdConnect', 
+            'Bearer'
         ]
 
         return self.api_client.param_serialize(
             method='GET',
-            resource_path='/Workflow/GetResultOverview',
+            resource_path='/workflow/{workflowId}/responses',
             path_params=_path_params,
             query_params=_query_params,
             header_params=_header_params,
@@ -1087,9 +1400,9 @@ class WorkflowApi:
 
 
     @validate_call
-    def workflow_query_get(
+    def workflows_get(
         self,
-        request: Annotated[Optional[QueryWorkflowsModel], Field(description="The model containing the filter, page, and sort criteria.")] = None,
+        request: Annotated[Optional[QueryModel], Field(description="The model containing the filter, page, and sort criteria.")] = None,
         _request_timeout: Union[
             None,
             Annotated[StrictFloat, Field(gt=0)],
@@ -1102,12 +1415,12 @@ class WorkflowApi:
         _content_type: Optional[StrictStr] = None,
         _headers: Optional[Dict[StrictStr, Any]] = None,
         _host_index: Annotated[StrictInt, Field(ge=0, le=0)] = 0,
-    ) -> IWorkflowModelPagedResult:
+    ) -> PagedResultOfIWorkflowModel:
         """Queries workflows based on the provided filter, page, and sort criteria.
 
 
         :param request: The model containing the filter, page, and sort criteria.
-        :type request: QueryWorkflowsModel
+        :type request: QueryModel
         :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
@@ -1130,7 +1443,7 @@ class WorkflowApi:
         :return: Returns the result object.
         """ # noqa: E501
 
-        _param = self._workflow_query_get_serialize(
+        _param = self._workflows_get_serialize(
             request=request,
             _request_auth=_request_auth,
             _content_type=_content_type,
@@ -1139,7 +1452,7 @@ class WorkflowApi:
         )
 
         _response_types_map: Dict[str, Optional[str]] = {
-            '200': "IWorkflowModelPagedResult",
+            '200': "PagedResultOfIWorkflowModel",
         }
         response_data = self.api_client.call_api(
             *_param,
@@ -1153,9 +1466,9 @@ class WorkflowApi:
 
 
     @validate_call
-    def workflow_query_get_with_http_info(
+    def workflows_get_with_http_info(
         self,
-        request: Annotated[Optional[QueryWorkflowsModel], Field(description="The model containing the filter, page, and sort criteria.")] = None,
+        request: Annotated[Optional[QueryModel], Field(description="The model containing the filter, page, and sort criteria.")] = None,
         _request_timeout: Union[
             None,
             Annotated[StrictFloat, Field(gt=0)],
@@ -1168,12 +1481,12 @@ class WorkflowApi:
         _content_type: Optional[StrictStr] = None,
         _headers: Optional[Dict[StrictStr, Any]] = None,
         _host_index: Annotated[StrictInt, Field(ge=0, le=0)] = 0,
-    ) -> ApiResponse[IWorkflowModelPagedResult]:
+    ) -> ApiResponse[PagedResultOfIWorkflowModel]:
         """Queries workflows based on the provided filter, page, and sort criteria.
 
 
         :param request: The model containing the filter, page, and sort criteria.
-        :type request: QueryWorkflowsModel
+        :type request: QueryModel
         :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
@@ -1196,7 +1509,7 @@ class WorkflowApi:
         :return: Returns the result object.
         """ # noqa: E501
 
-        _param = self._workflow_query_get_serialize(
+        _param = self._workflows_get_serialize(
             request=request,
             _request_auth=_request_auth,
             _content_type=_content_type,
@@ -1205,7 +1518,7 @@ class WorkflowApi:
         )
 
         _response_types_map: Dict[str, Optional[str]] = {
-            '200': "IWorkflowModelPagedResult",
+            '200': "PagedResultOfIWorkflowModel",
         }
         response_data = self.api_client.call_api(
             *_param,
@@ -1219,9 +1532,9 @@ class WorkflowApi:
 
 
     @validate_call
-    def workflow_query_get_without_preload_content(
+    def workflows_get_without_preload_content(
         self,
-        request: Annotated[Optional[QueryWorkflowsModel], Field(description="The model containing the filter, page, and sort criteria.")] = None,
+        request: Annotated[Optional[QueryModel], Field(description="The model containing the filter, page, and sort criteria.")] = None,
         _request_timeout: Union[
             None,
             Annotated[StrictFloat, Field(gt=0)],
@@ -1239,7 +1552,7 @@ class WorkflowApi:
 
 
         :param request: The model containing the filter, page, and sort criteria.
-        :type request: QueryWorkflowsModel
+        :type request: QueryModel
         :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
@@ -1262,7 +1575,7 @@ class WorkflowApi:
         :return: Returns the result object.
         """ # noqa: E501
 
-        _param = self._workflow_query_get_serialize(
+        _param = self._workflows_get_serialize(
             request=request,
             _request_auth=_request_auth,
             _content_type=_content_type,
@@ -1271,7 +1584,7 @@ class WorkflowApi:
         )
 
         _response_types_map: Dict[str, Optional[str]] = {
-            '200': "IWorkflowModelPagedResult",
+            '200': "PagedResultOfIWorkflowModel",
         }
         response_data = self.api_client.call_api(
             *_param,
@@ -1280,7 +1593,7 @@ class WorkflowApi:
         return response_data.response
 
 
-    def _workflow_query_get_serialize(
+    def _workflows_get_serialize(
         self,
         request,
         _request_auth,
@@ -1327,13 +1640,14 @@ class WorkflowApi:
 
         # authentication setting
         _auth_settings: List[str] = [
-            'bearer', 
-            'oauth2'
+            'OAuth2', 
+            'OpenIdConnect', 
+            'Bearer'
         ]
 
         return self.api_client.param_serialize(
             method='GET',
-            resource_path='/Workflow/Query',
+            resource_path='/workflows',
             path_params=_path_params,
             query_params=_query_params,
             header_params=_header_params,