rapidata 2.35.1__py3-none-any.whl → 3.0.0a8__py3-none-any.whl

rapidata/api_client/api/survey_api.py

@@ -0,0 +1,304 @@
+# coding: utf-8
+
+"""
+    Rapidata Asset API
+
+    The API for the Rapidata Asset service
+
+    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 rapidata.api_client.models.send_survey_model import SendSurveyModel
+
+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 SurveyApi:
+    """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 identity_survey_post(
+        self,
+        send_survey_model: SendSurveyModel,
+        _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,
+    ) -> None:
+        """Sends a survey.
+
+
+        :param send_survey_model: (required)
+        :type send_survey_model: SendSurveyModel
+        :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._identity_survey_post_serialize(
+            send_survey_model=send_survey_model,
+            _request_auth=_request_auth,
+            _content_type=_content_type,
+            _headers=_headers,
+            _host_index=_host_index
+        )
+
+        _response_types_map: Dict[str, Optional[str]] = {
+            '200': None,
+        }
+        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 identity_survey_post_with_http_info(
+        self,
+        send_survey_model: SendSurveyModel,
+        _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[None]:
+        """Sends a survey.
+
+
+        :param send_survey_model: (required)
+        :type send_survey_model: SendSurveyModel
+        :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._identity_survey_post_serialize(
+            send_survey_model=send_survey_model,
+            _request_auth=_request_auth,
+            _content_type=_content_type,
+            _headers=_headers,
+            _host_index=_host_index
+        )
+
+        _response_types_map: Dict[str, Optional[str]] = {
+            '200': None,
+        }
+        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 identity_survey_post_without_preload_content(
+        self,
+        send_survey_model: SendSurveyModel,
+        _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:
+        """Sends a survey.
+
+
+        :param send_survey_model: (required)
+        :type send_survey_model: SendSurveyModel
+        :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._identity_survey_post_serialize(
+            send_survey_model=send_survey_model,
+            _request_auth=_request_auth,
+            _content_type=_content_type,
+            _headers=_headers,
+            _host_index=_host_index
+        )
+
+        _response_types_map: Dict[str, Optional[str]] = {
+            '200': None,
+        }
+        response_data = self.api_client.call_api(
+            *_param,
+            _request_timeout=_request_timeout
+        )
+        return response_data.response
+
+
+    def _identity_survey_post_serialize(
+        self,
+        send_survey_model,
+        _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
+        # process the header parameters
+        # process the form parameters
+        # process the body parameter
+        if send_survey_model is not None:
+            _body_params = send_survey_model
+
+
+
+        # set the HTTP header `Content-Type`
+        if _content_type:
+            _header_params['Content-Type'] = _content_type
+        else:
+            _default_content_type = (
+                self.api_client.select_header_content_type(
+                    [
+                        'application/json', 
+                        'text/json', 
+                        'application/*+json'
+                    ]
+                )
+            )
+            if _default_content_type is not None:
+                _header_params['Content-Type'] = _default_content_type
+
+        # authentication setting
+        _auth_settings: List[str] = [
+            'OAuth2', 
+            'OpenIdConnect', 
+            'Bearer'
+        ]
+
+        return self.api_client.param_serialize(
+            method='POST',
+            resource_path='/identity/survey',
+            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/user_rapid_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)
@@ -17,7 +17,6 @@ from typing import Any, Dict, List, Optional, Tuple, Union
 from typing_extensions import Annotated
 
 from pydantic import Field, StrictStr
-from typing import Optional
 from typing_extensions import Annotated
 from rapidata.api_client.models.add_user_response_result import AddUserResponseResult
 from rapidata.api_client.models.are_rapids_active_result import AreRapidsActiveResult
@@ -268,8 +267,9 @@ class UserRapidApi:
 
         # authentication setting
         _auth_settings: List[str] = [
-            'bearer', 
-            'oauth2'
+            'OAuth2', 
+            'OpenIdConnect', 
+            'Bearer'
         ]
 
         return self.api_client.param_serialize(
@@ -294,7 +294,7 @@ class UserRapidApi:
     def rapid_rapid_id_report_post(
         self,
         rapid_id: Annotated[StrictStr, Field(description="The rapid to report.")],
-        report_model: Annotated[Optional[ReportModel], Field(description="The body request.")] = None,
+        report_model: Annotated[ReportModel, Field(description="The body request.")],
         _request_timeout: Union[
             None,
             Annotated[StrictFloat, Field(gt=0)],
@@ -313,7 +313,7 @@ class UserRapidApi:
 
         :param rapid_id: The rapid to report. (required)
         :type rapid_id: str
-        :param report_model: The body request.
+        :param report_model: The body request. (required)
         :type report_model: ReportModel
         :param _request_timeout: timeout setting for this request. If one
                                  number provided, it will be total request
@@ -364,7 +364,7 @@ class UserRapidApi:
     def rapid_rapid_id_report_post_with_http_info(
         self,
         rapid_id: Annotated[StrictStr, Field(description="The rapid to report.")],
-        report_model: Annotated[Optional[ReportModel], Field(description="The body request.")] = None,
+        report_model: Annotated[ReportModel, Field(description="The body request.")],
         _request_timeout: Union[
             None,
             Annotated[StrictFloat, Field(gt=0)],
@@ -383,7 +383,7 @@ class UserRapidApi:
 
         :param rapid_id: The rapid to report. (required)
         :type rapid_id: str
-        :param report_model: The body request.
+        :param report_model: The body request. (required)
         :type report_model: ReportModel
         :param _request_timeout: timeout setting for this request. If one
                                  number provided, it will be total request
@@ -434,7 +434,7 @@ class UserRapidApi:
     def rapid_rapid_id_report_post_without_preload_content(
         self,
         rapid_id: Annotated[StrictStr, Field(description="The rapid to report.")],
-        report_model: Annotated[Optional[ReportModel], Field(description="The body request.")] = None,
+        report_model: Annotated[ReportModel, Field(description="The body request.")],
         _request_timeout: Union[
             None,
             Annotated[StrictFloat, Field(gt=0)],
@@ -453,7 +453,7 @@ class UserRapidApi:
 
         :param rapid_id: The rapid to report. (required)
         :type rapid_id: str
-        :param report_model: The body request.
+        :param report_model: The body request. (required)
         :type report_model: ReportModel
         :param _request_timeout: timeout setting for this request. If one
                                  number provided, it will be total request
@@ -550,8 +550,9 @@ class UserRapidApi:
 
         # authentication setting
         _auth_settings: List[str] = [
-            'bearer', 
-            'oauth2'
+            'OAuth2', 
+            'OpenIdConnect', 
+            'Bearer'
         ]
 
         return self.api_client.param_serialize(
@@ -811,8 +812,9 @@ class UserRapidApi:
 
         # authentication setting
         _auth_settings: List[str] = [
-            'bearer', 
-            'oauth2'
+            'OAuth2', 
+            'OpenIdConnect', 
+            'Bearer'
         ]
 
         return self.api_client.param_serialize(
@@ -836,7 +838,7 @@ class UserRapidApi:
     @validate_call
     def rapid_response_post(
         self,
-        rapid_result_model: Annotated[Optional[RapidResultModel], Field(description="The model containing the user guess.")] = None,
+        rapid_result_model: Annotated[RapidResultModel, Field(description="The model containing the user guess.")],
         _request_timeout: Union[
             None,
             Annotated[StrictFloat, Field(gt=0)],
@@ -853,7 +855,7 @@ class UserRapidApi:
         """Submits a response for a Rapid.
 
 
-        :param rapid_result_model: The model containing the user guess.
+        :param rapid_result_model: The model containing the user guess. (required)
         :type rapid_result_model: RapidResultModel
         :param _request_timeout: timeout setting for this request. If one
                                  number provided, it will be total request
@@ -902,7 +904,7 @@ class UserRapidApi:
     @validate_call
     def rapid_response_post_with_http_info(
         self,
-        rapid_result_model: Annotated[Optional[RapidResultModel], Field(description="The model containing the user guess.")] = None,
+        rapid_result_model: Annotated[RapidResultModel, Field(description="The model containing the user guess.")],
         _request_timeout: Union[
             None,
             Annotated[StrictFloat, Field(gt=0)],
@@ -919,7 +921,7 @@ class UserRapidApi:
         """Submits a response for a Rapid.
 
 
-        :param rapid_result_model: The model containing the user guess.
+        :param rapid_result_model: The model containing the user guess. (required)
         :type rapid_result_model: RapidResultModel
         :param _request_timeout: timeout setting for this request. If one
                                  number provided, it will be total request
@@ -968,7 +970,7 @@ class UserRapidApi:
     @validate_call
     def rapid_response_post_without_preload_content(
         self,
-        rapid_result_model: Annotated[Optional[RapidResultModel], Field(description="The model containing the user guess.")] = None,
+        rapid_result_model: Annotated[RapidResultModel, Field(description="The model containing the user guess.")],
         _request_timeout: Union[
             None,
             Annotated[StrictFloat, Field(gt=0)],
@@ -985,7 +987,7 @@ class UserRapidApi:
         """Submits a response for a Rapid.
 
 
-        :param rapid_result_model: The model containing the user guess.
+        :param rapid_result_model: The model containing the user guess. (required)
         :type rapid_result_model: RapidResultModel
         :param _request_timeout: timeout setting for this request. If one
                                  number provided, it will be total request
@@ -1087,8 +1089,9 @@ class UserRapidApi:
 
         # authentication setting
         _auth_settings: List[str] = [
-            'bearer', 
-            'oauth2'
+            'OAuth2', 
+            'OpenIdConnect', 
+            'Bearer'
         ]
 
         return self.api_client.param_serialize(
@@ -1112,7 +1115,7 @@ class UserRapidApi:
     @validate_call
     def rapid_skip_post(
         self,
-        rapid_skipped_model: Annotated[Optional[RapidSkippedModel], Field(description="The model containing the Rapid to skip.")] = None,
+        rapid_skipped_model: Annotated[RapidSkippedModel, Field(description="The model containing the Rapid to skip.")],
         _request_timeout: Union[
             None,
             Annotated[StrictFloat, Field(gt=0)],
@@ -1129,7 +1132,7 @@ class UserRapidApi:
         """Skips a Rapid for the user.
 
 
-        :param rapid_skipped_model: The model containing the Rapid to skip.
+        :param rapid_skipped_model: The model containing the Rapid to skip. (required)
         :type rapid_skipped_model: RapidSkippedModel
         :param _request_timeout: timeout setting for this request. If one
                                  number provided, it will be total request
@@ -1178,7 +1181,7 @@ class UserRapidApi:
     @validate_call
     def rapid_skip_post_with_http_info(
         self,
-        rapid_skipped_model: Annotated[Optional[RapidSkippedModel], Field(description="The model containing the Rapid to skip.")] = None,
+        rapid_skipped_model: Annotated[RapidSkippedModel, Field(description="The model containing the Rapid to skip.")],
         _request_timeout: Union[
             None,
             Annotated[StrictFloat, Field(gt=0)],
@@ -1195,7 +1198,7 @@ class UserRapidApi:
         """Skips a Rapid for the user.
 
 
-        :param rapid_skipped_model: The model containing the Rapid to skip.
+        :param rapid_skipped_model: The model containing the Rapid to skip. (required)
         :type rapid_skipped_model: RapidSkippedModel
         :param _request_timeout: timeout setting for this request. If one
                                  number provided, it will be total request
@@ -1244,7 +1247,7 @@ class UserRapidApi:
     @validate_call
     def rapid_skip_post_without_preload_content(
         self,
-        rapid_skipped_model: Annotated[Optional[RapidSkippedModel], Field(description="The model containing the Rapid to skip.")] = None,
+        rapid_skipped_model: Annotated[RapidSkippedModel, Field(description="The model containing the Rapid to skip.")],
         _request_timeout: Union[
             None,
             Annotated[StrictFloat, Field(gt=0)],
@@ -1261,7 +1264,7 @@ class UserRapidApi:
         """Skips a Rapid for the user.
 
 
-        :param rapid_skipped_model: The model containing the Rapid to skip.
+        :param rapid_skipped_model: The model containing the Rapid to skip. (required)
         :type rapid_skipped_model: RapidSkippedModel
         :param _request_timeout: timeout setting for this request. If one
                                  number provided, it will be total request
@@ -1363,8 +1366,9 @@ class UserRapidApi:
 
         # authentication setting
         _auth_settings: List[str] = [
-            'bearer', 
-            'oauth2'
+            'OAuth2', 
+            'OpenIdConnect', 
+            'Bearer'
         ]
 
         return self.api_client.param_serialize(