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

rapidata/api_client/api/campaign_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)
@@ -19,10 +19,11 @@ from typing_extensions import Annotated
 from pydantic import Field, StrictStr
 from typing import Optional
 from typing_extensions import Annotated
-from rapidata.api_client.models.boost_query_result import BoostQueryResult
-from rapidata.api_client.models.campaign_query_result_paged_result import CampaignQueryResultPagedResult
 from rapidata.api_client.models.change_boost_model import ChangeBoostModel
+from rapidata.api_client.models.get_boost_result import GetBoostResult
+from rapidata.api_client.models.paged_result_of_campaign_query_result import PagedResultOfCampaignQueryResult
 from rapidata.api_client.models.query_model import QueryModel
+from rapidata.api_client.models.update_campaign_model import UpdateCampaignModel
 
 from rapidata.api_client.api_client import ApiClient, RequestSerialized
 from rapidata.api_client.api_response import ApiResponse
@@ -45,7 +46,7 @@ class CampaignApi:
     @validate_call
     def campaign_boost_put(
         self,
-        change_boost_model: Optional[ChangeBoostModel] = None,
+        change_boost_model: ChangeBoostModel,
         _request_timeout: Union[
             None,
             Annotated[StrictFloat, Field(gt=0)],
@@ -62,7 +63,7 @@ class CampaignApi:
         """Updates the boost with manual boosts.
 
 
-        :param change_boost_model:
+        :param change_boost_model: (required)
         :type change_boost_model: ChangeBoostModel
         :param _request_timeout: timeout setting for this request. If one
                                  number provided, it will be total request
@@ -111,7 +112,7 @@ class CampaignApi:
     @validate_call
     def campaign_boost_put_with_http_info(
         self,
-        change_boost_model: Optional[ChangeBoostModel] = None,
+        change_boost_model: ChangeBoostModel,
         _request_timeout: Union[
             None,
             Annotated[StrictFloat, Field(gt=0)],
@@ -128,7 +129,7 @@ class CampaignApi:
         """Updates the boost with manual boosts.
 
 
-        :param change_boost_model:
+        :param change_boost_model: (required)
         :type change_boost_model: ChangeBoostModel
         :param _request_timeout: timeout setting for this request. If one
                                  number provided, it will be total request
@@ -177,7 +178,7 @@ class CampaignApi:
     @validate_call
     def campaign_boost_put_without_preload_content(
         self,
-        change_boost_model: Optional[ChangeBoostModel] = None,
+        change_boost_model: ChangeBoostModel,
         _request_timeout: Union[
             None,
             Annotated[StrictFloat, Field(gt=0)],
@@ -194,7 +195,7 @@ class CampaignApi:
         """Updates the boost with manual boosts.
 
 
-        :param change_boost_model:
+        :param change_boost_model: (required)
         :type change_boost_model: ChangeBoostModel
         :param _request_timeout: timeout setting for this request. If one
                                  number provided, it will be total request
@@ -287,8 +288,9 @@ class CampaignApi:
 
         # authentication setting
         _auth_settings: List[str] = [
-            'bearer', 
-            'oauth2'
+            'OAuth2', 
+            'OpenIdConnect', 
+            'Bearer'
         ]
 
         return self.api_client.param_serialize(
@@ -324,7 +326,7 @@ class CampaignApi:
         _content_type: Optional[StrictStr] = None,
         _headers: Optional[Dict[StrictStr, Any]] = None,
         _host_index: Annotated[StrictInt, Field(ge=0, le=0)] = 0,
-    ) -> BoostQueryResult:
+    ) -> GetBoostResult:
         """Gets the status of the boost.
 
 
@@ -358,7 +360,7 @@ class CampaignApi:
         )
 
         _response_types_map: Dict[str, Optional[str]] = {
-            '200': "BoostQueryResult",
+            '200': "GetBoostResult",
         }
         response_data = self.api_client.call_api(
             *_param,
@@ -386,7 +388,7 @@ class CampaignApi:
         _content_type: Optional[StrictStr] = None,
         _headers: Optional[Dict[StrictStr, Any]] = None,
         _host_index: Annotated[StrictInt, Field(ge=0, le=0)] = 0,
-    ) -> ApiResponse[BoostQueryResult]:
+    ) -> ApiResponse[GetBoostResult]:
         """Gets the status of the boost.
 
 
@@ -420,7 +422,7 @@ class CampaignApi:
         )
 
         _response_types_map: Dict[str, Optional[str]] = {
-            '200': "BoostQueryResult",
+            '200': "GetBoostResult",
         }
         response_data = self.api_client.call_api(
             *_param,
@@ -482,7 +484,7 @@ class CampaignApi:
         )
 
         _response_types_map: Dict[str, Optional[str]] = {
-            '200': "BoostQueryResult",
+            '200': "GetBoostResult",
         }
         response_data = self.api_client.call_api(
             *_param,
@@ -533,8 +535,9 @@ class CampaignApi:
 
         # authentication setting
         _auth_settings: List[str] = [
-            'bearer', 
-            'oauth2'
+            'OAuth2', 
+            'OpenIdConnect', 
+            'Bearer'
         ]
 
         return self.api_client.param_serialize(
@@ -555,6 +558,289 @@ class CampaignApi:
 
 
 
+    @validate_call
+    def campaign_campaign_id_patch(
+        self,
+        campaign_id: Annotated[StrictStr, Field(description="id of the campaign to update")],
+        update_campaign_model: Annotated[UpdateCampaignModel, Field(description="model containing the updates")],
+        _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:
+        """Updates a campaign.
+
+
+        :param campaign_id: id of the campaign to update (required)
+        :type campaign_id: str
+        :param update_campaign_model: model containing the updates (required)
+        :type update_campaign_model: UpdateCampaignModel
+        :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._campaign_campaign_id_patch_serialize(
+            campaign_id=campaign_id,
+            update_campaign_model=update_campaign_model,
+            _request_auth=_request_auth,
+            _content_type=_content_type,
+            _headers=_headers,
+            _host_index=_host_index
+        )
+
+        _response_types_map: Dict[str, Optional[str]] = {
+            '204': 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 campaign_campaign_id_patch_with_http_info(
+        self,
+        campaign_id: Annotated[StrictStr, Field(description="id of the campaign to update")],
+        update_campaign_model: Annotated[UpdateCampaignModel, Field(description="model containing the updates")],
+        _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]:
+        """Updates a campaign.
+
+
+        :param campaign_id: id of the campaign to update (required)
+        :type campaign_id: str
+        :param update_campaign_model: model containing the updates (required)
+        :type update_campaign_model: UpdateCampaignModel
+        :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._campaign_campaign_id_patch_serialize(
+            campaign_id=campaign_id,
+            update_campaign_model=update_campaign_model,
+            _request_auth=_request_auth,
+            _content_type=_content_type,
+            _headers=_headers,
+            _host_index=_host_index
+        )
+
+        _response_types_map: Dict[str, Optional[str]] = {
+            '204': 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 campaign_campaign_id_patch_without_preload_content(
+        self,
+        campaign_id: Annotated[StrictStr, Field(description="id of the campaign to update")],
+        update_campaign_model: Annotated[UpdateCampaignModel, Field(description="model containing the updates")],
+        _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:
+        """Updates a campaign.
+
+
+        :param campaign_id: id of the campaign to update (required)
+        :type campaign_id: str
+        :param update_campaign_model: model containing the updates (required)
+        :type update_campaign_model: UpdateCampaignModel
+        :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._campaign_campaign_id_patch_serialize(
+            campaign_id=campaign_id,
+            update_campaign_model=update_campaign_model,
+            _request_auth=_request_auth,
+            _content_type=_content_type,
+            _headers=_headers,
+            _host_index=_host_index
+        )
+
+        _response_types_map: Dict[str, Optional[str]] = {
+            '204': None,
+        }
+        response_data = self.api_client.call_api(
+            *_param,
+            _request_timeout=_request_timeout
+        )
+        return response_data.response
+
+
+    def _campaign_campaign_id_patch_serialize(
+        self,
+        campaign_id,
+        update_campaign_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
+        if campaign_id is not None:
+            _path_params['campaignId'] = campaign_id
+        # process the query parameters
+        # process the header parameters
+        # process the form parameters
+        # process the body parameter
+        if update_campaign_model is not None:
+            _body_params = update_campaign_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='PATCH',
+            resource_path='/campaign/{campaignId}',
+            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 campaign_campaign_id_pause_post(
         self,
@@ -785,8 +1071,9 @@ class CampaignApi:
 
         # authentication setting
         _auth_settings: List[str] = [
-            'bearer', 
-            'oauth2'
+            'OAuth2', 
+            'OpenIdConnect', 
+            'Bearer'
         ]
 
         return self.api_client.param_serialize(
@@ -1037,8 +1324,9 @@ class CampaignApi:
 
         # authentication setting
         _auth_settings: List[str] = [
-            'bearer', 
-            'oauth2'
+            'OAuth2', 
+            'OpenIdConnect', 
+            'Bearer'
         ]
 
         return self.api_client.param_serialize(
@@ -1274,8 +1562,9 @@ class CampaignApi:
 
         # authentication setting
         _auth_settings: List[str] = [
-            'bearer', 
-            'oauth2'
+            'OAuth2', 
+            'OpenIdConnect', 
+            'Bearer'
         ]
 
         return self.api_client.param_serialize(
@@ -1312,7 +1601,7 @@ class CampaignApi:
         _content_type: Optional[StrictStr] = None,
         _headers: Optional[Dict[StrictStr, Any]] = None,
         _host_index: Annotated[StrictInt, Field(ge=0, le=0)] = 0,
-    ) -> CampaignQueryResultPagedResult:
+    ) -> PagedResultOfCampaignQueryResult:
         """Queries orders based on a filter, page, and sort criteria.
 
 
@@ -1349,7 +1638,7 @@ class CampaignApi:
         )
 
         _response_types_map: Dict[str, Optional[str]] = {
-            '200': "CampaignQueryResultPagedResult",
+            '200': "PagedResultOfCampaignQueryResult",
         }
         response_data = self.api_client.call_api(
             *_param,
@@ -1378,7 +1667,7 @@ class CampaignApi:
         _content_type: Optional[StrictStr] = None,
         _headers: Optional[Dict[StrictStr, Any]] = None,
         _host_index: Annotated[StrictInt, Field(ge=0, le=0)] = 0,
-    ) -> ApiResponse[CampaignQueryResultPagedResult]:
+    ) -> ApiResponse[PagedResultOfCampaignQueryResult]:
         """Queries orders based on a filter, page, and sort criteria.
 
 
@@ -1415,7 +1704,7 @@ class CampaignApi:
         )
 
         _response_types_map: Dict[str, Optional[str]] = {
-            '200': "CampaignQueryResultPagedResult",
+            '200': "PagedResultOfCampaignQueryResult",
         }
         response_data = self.api_client.call_api(
             *_param,
@@ -1481,7 +1770,7 @@ class CampaignApi:
         )
 
         _response_types_map: Dict[str, Optional[str]] = {
-            '200': "CampaignQueryResultPagedResult",
+            '200': "PagedResultOfCampaignQueryResult",
         }
         response_data = self.api_client.call_api(
             *_param,
@@ -1537,8 +1826,9 @@ class CampaignApi:
 
         # authentication setting
         _auth_settings: List[str] = [
-            'bearer', 
-            'oauth2'
+            'OAuth2', 
+            'OpenIdConnect', 
+            'Bearer'
         ]
 
         return self.api_client.param_serialize(