rapidata 2.23.2__py3-none-any.whl → 3.0.1__py3-none-any.whl

rapidata/api_client/api/newsletter_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
-from typing import Any, Dict, Optional
 from typing_extensions import Annotated
 from rapidata.api_client.models.newsletter_model import NewsletterModel
 
@@ -39,280 +38,10 @@ class NewsletterApi:
         self.api_client = api_client
 
 
-    @validate_call
-    def newsletter_post(
-        self,
-        newsletter_model: Annotated[Optional[NewsletterModel], Field(description="The model containing the email of a user and recaptcha token.")] = 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,
-    ) -> None:
-        """(Deprecated) Signs a user up to the newsletter.
-
-
-        :param newsletter_model: The model containing the email of a user and recaptcha token.
-        :type newsletter_model: NewsletterModel
-        :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
-        warnings.warn("POST /newsletter is deprecated.", DeprecationWarning)
-
-        _param = self._newsletter_post_serialize(
-            newsletter_model=newsletter_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 newsletter_post_with_http_info(
-        self,
-        newsletter_model: Annotated[Optional[NewsletterModel], Field(description="The model containing the email of a user and recaptcha token.")] = 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[None]:
-        """(Deprecated) Signs a user up to the newsletter.
-
-
-        :param newsletter_model: The model containing the email of a user and recaptcha token.
-        :type newsletter_model: NewsletterModel
-        :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
-        warnings.warn("POST /newsletter is deprecated.", DeprecationWarning)
-
-        _param = self._newsletter_post_serialize(
-            newsletter_model=newsletter_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 newsletter_post_without_preload_content(
-        self,
-        newsletter_model: Annotated[Optional[NewsletterModel], Field(description="The model containing the email of a user and recaptcha token.")] = 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:
-        """(Deprecated) Signs a user up to the newsletter.
-
-
-        :param newsletter_model: The model containing the email of a user and recaptcha token.
-        :type newsletter_model: NewsletterModel
-        :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
-        warnings.warn("POST /newsletter is deprecated.", DeprecationWarning)
-
-        _param = self._newsletter_post_serialize(
-            newsletter_model=newsletter_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 _newsletter_post_serialize(
-        self,
-        newsletter_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 newsletter_model is not None:
-            _body_params = newsletter_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] = [
-            'bearer', 
-            'oauth2'
-        ]
-
-        return self.api_client.param_serialize(
-            method='POST',
-            resource_path='/newsletter',
-            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 newsletter_subscribe_post(
         self,
-        newsletter_model: Annotated[Optional[NewsletterModel], Field(description="The model containing the email of a user and recaptcha token.")] = None,
+        newsletter_model: Annotated[NewsletterModel, Field(description="The model containing the email of a user and recaptcha token.")],
         _request_timeout: Union[
             None,
             Annotated[StrictFloat, Field(gt=0)],
@@ -325,11 +54,11 @@ class NewsletterApi:
         _content_type: Optional[StrictStr] = None,
         _headers: Optional[Dict[StrictStr, Any]] = None,
         _host_index: Annotated[StrictInt, Field(ge=0, le=0)] = 0,
-    ) -> object:
+    ) -> None:
         """Signs a user up to the newsletter.
 
 
-        :param newsletter_model: The model containing the email of a user and recaptcha token.
+        :param newsletter_model: The model containing the email of a user and recaptcha token. (required)
         :type newsletter_model: NewsletterModel
         :param _request_timeout: timeout setting for this request. If one
                                  number provided, it will be total request
@@ -362,7 +91,7 @@ class NewsletterApi:
         )
 
         _response_types_map: Dict[str, Optional[str]] = {
-            '200': "object",
+            '204': None,
         }
         response_data = self.api_client.call_api(
             *_param,
@@ -378,7 +107,7 @@ class NewsletterApi:
     @validate_call
     def newsletter_subscribe_post_with_http_info(
         self,
-        newsletter_model: Annotated[Optional[NewsletterModel], Field(description="The model containing the email of a user and recaptcha token.")] = None,
+        newsletter_model: Annotated[NewsletterModel, Field(description="The model containing the email of a user and recaptcha token.")],
         _request_timeout: Union[
             None,
             Annotated[StrictFloat, Field(gt=0)],
@@ -391,11 +120,11 @@ class NewsletterApi:
         _content_type: Optional[StrictStr] = None,
         _headers: Optional[Dict[StrictStr, Any]] = None,
         _host_index: Annotated[StrictInt, Field(ge=0, le=0)] = 0,
-    ) -> ApiResponse[object]:
+    ) -> ApiResponse[None]:
         """Signs a user up to the newsletter.
 
 
-        :param newsletter_model: The model containing the email of a user and recaptcha token.
+        :param newsletter_model: The model containing the email of a user and recaptcha token. (required)
         :type newsletter_model: NewsletterModel
         :param _request_timeout: timeout setting for this request. If one
                                  number provided, it will be total request
@@ -428,7 +157,7 @@ class NewsletterApi:
         )
 
         _response_types_map: Dict[str, Optional[str]] = {
-            '200': "object",
+            '204': None,
         }
         response_data = self.api_client.call_api(
             *_param,
@@ -444,7 +173,7 @@ class NewsletterApi:
     @validate_call
     def newsletter_subscribe_post_without_preload_content(
         self,
-        newsletter_model: Annotated[Optional[NewsletterModel], Field(description="The model containing the email of a user and recaptcha token.")] = None,
+        newsletter_model: Annotated[NewsletterModel, Field(description="The model containing the email of a user and recaptcha token.")],
         _request_timeout: Union[
             None,
             Annotated[StrictFloat, Field(gt=0)],
@@ -461,7 +190,7 @@ class NewsletterApi:
         """Signs a user up to the newsletter.
 
 
-        :param newsletter_model: The model containing the email of a user and recaptcha token.
+        :param newsletter_model: The model containing the email of a user and recaptcha token. (required)
         :type newsletter_model: NewsletterModel
         :param _request_timeout: timeout setting for this request. If one
                                  number provided, it will be total request
@@ -494,7 +223,7 @@ class NewsletterApi:
         )
 
         _response_types_map: Dict[str, Optional[str]] = {
-            '200': "object",
+            '204': None,
         }
         response_data = self.api_client.call_api(
             *_param,
@@ -535,15 +264,6 @@ class NewsletterApi:
             _body_params = newsletter_model
 
 
-        # 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'
-                ]
-            )
 
         # set the HTTP header `Content-Type`
         if _content_type:
@@ -563,8 +283,9 @@ class NewsletterApi:
 
         # authentication setting
         _auth_settings: List[str] = [
-            'bearer', 
-            'oauth2'
+            'OAuth2', 
+            'OpenIdConnect', 
+            'Bearer'
         ]
 
         return self.api_client.param_serialize(
@@ -588,7 +309,7 @@ class NewsletterApi:
     @validate_call
     def newsletter_unsubscribe_post(
         self,
-        newsletter_model: Annotated[Optional[NewsletterModel], Field(description="The model containing the email of a user and recaptcha token.")] = None,
+        newsletter_model: Annotated[NewsletterModel, Field(description="The model containing the email of a user and recaptcha token.")],
         _request_timeout: Union[
             None,
             Annotated[StrictFloat, Field(gt=0)],
@@ -601,11 +322,11 @@ class NewsletterApi:
         _content_type: Optional[StrictStr] = None,
         _headers: Optional[Dict[StrictStr, Any]] = None,
         _host_index: Annotated[StrictInt, Field(ge=0, le=0)] = 0,
-    ) -> object:
+    ) -> None:
         """Unsubscribes a user from the newsletter.
 
 
-        :param newsletter_model: The model containing the email of a user and recaptcha token.
+        :param newsletter_model: The model containing the email of a user and recaptcha token. (required)
         :type newsletter_model: NewsletterModel
         :param _request_timeout: timeout setting for this request. If one
                                  number provided, it will be total request
@@ -638,7 +359,7 @@ class NewsletterApi:
         )
 
         _response_types_map: Dict[str, Optional[str]] = {
-            '200': "object",
+            '204': None,
         }
         response_data = self.api_client.call_api(
             *_param,
@@ -654,7 +375,7 @@ class NewsletterApi:
     @validate_call
     def newsletter_unsubscribe_post_with_http_info(
         self,
-        newsletter_model: Annotated[Optional[NewsletterModel], Field(description="The model containing the email of a user and recaptcha token.")] = None,
+        newsletter_model: Annotated[NewsletterModel, Field(description="The model containing the email of a user and recaptcha token.")],
         _request_timeout: Union[
             None,
             Annotated[StrictFloat, Field(gt=0)],
@@ -667,11 +388,11 @@ class NewsletterApi:
         _content_type: Optional[StrictStr] = None,
         _headers: Optional[Dict[StrictStr, Any]] = None,
         _host_index: Annotated[StrictInt, Field(ge=0, le=0)] = 0,
-    ) -> ApiResponse[object]:
+    ) -> ApiResponse[None]:
         """Unsubscribes a user from the newsletter.
 
 
-        :param newsletter_model: The model containing the email of a user and recaptcha token.
+        :param newsletter_model: The model containing the email of a user and recaptcha token. (required)
         :type newsletter_model: NewsletterModel
         :param _request_timeout: timeout setting for this request. If one
                                  number provided, it will be total request
@@ -704,7 +425,7 @@ class NewsletterApi:
         )
 
         _response_types_map: Dict[str, Optional[str]] = {
-            '200': "object",
+            '204': None,
         }
         response_data = self.api_client.call_api(
             *_param,
@@ -720,7 +441,7 @@ class NewsletterApi:
     @validate_call
     def newsletter_unsubscribe_post_without_preload_content(
         self,
-        newsletter_model: Annotated[Optional[NewsletterModel], Field(description="The model containing the email of a user and recaptcha token.")] = None,
+        newsletter_model: Annotated[NewsletterModel, Field(description="The model containing the email of a user and recaptcha token.")],
         _request_timeout: Union[
             None,
             Annotated[StrictFloat, Field(gt=0)],
@@ -737,7 +458,7 @@ class NewsletterApi:
         """Unsubscribes a user from the newsletter.
 
 
-        :param newsletter_model: The model containing the email of a user and recaptcha token.
+        :param newsletter_model: The model containing the email of a user and recaptcha token. (required)
         :type newsletter_model: NewsletterModel
         :param _request_timeout: timeout setting for this request. If one
                                  number provided, it will be total request
@@ -770,7 +491,7 @@ class NewsletterApi:
         )
 
         _response_types_map: Dict[str, Optional[str]] = {
-            '200': "object",
+            '204': None,
         }
         response_data = self.api_client.call_api(
             *_param,
@@ -811,15 +532,6 @@ class NewsletterApi:
             _body_params = newsletter_model
 
 
-        # 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'
-                ]
-            )
 
         # set the HTTP header `Content-Type`
         if _content_type:
@@ -839,8 +551,9 @@ class NewsletterApi:
 
         # authentication setting
         _auth_settings: List[str] = [
-            'bearer', 
-            'oauth2'
+            'OAuth2', 
+            'OpenIdConnect', 
+            'Bearer'
         ]
 
         return self.api_client.param_serialize(