release version 2.1.0

Author: dfs-lvics

dataforseo_client/api/ai_optimization_api.py

@@ -80,8 +80,6 @@
     from dataforseo_client.models.business_data_tripadvisor_reviews_task_get_response_info import BusinessDataTripadvisorReviewsTaskGetResponseInfo
     from dataforseo_client.models.business_data_social_media_pinterest_live_request_info import BusinessDataSocialMediaPinterestLiveRequestInfo
     from dataforseo_client.models.business_data_social_media_pinterest_live_response_info import BusinessDataSocialMediaPinterestLiveResponseInfo
-    from dataforseo_client.models.business_data_social_media_reddit_live_request_info import BusinessDataSocialMediaRedditLiveRequestInfo
-    from dataforseo_client.models.business_data_social_media_reddit_live_response_info import BusinessDataSocialMediaRedditLiveResponseInfo
 
 from dataforseo_client.api_client import ApiClient, RequestSerialized
 from dataforseo_client.api_response import ApiResponse
@@ -9400,196 +9398,4 @@ def _social_media_pinterest_live_serialize(
             collection_formats=_collection_formats,
             _host=_host,
             _request_auth=_request_auth
-        )
-
-    from dataforseo_client.models.business_data_social_media_reddit_live_request_info import BusinessDataSocialMediaRedditLiveRequestInfo
-    from dataforseo_client.models.business_data_social_media_reddit_live_response_info import BusinessDataSocialMediaRedditLiveResponseInfo
-    @validate_call
-    def social_media_reddit_live(
-        self,
-        list_optional_business_data_social_media_reddit_live_request_info: 'List[Optional[BusinessDataSocialMediaRedditLiveRequestInfo]]' = 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,
-    ) -> BusinessDataSocialMediaRedditLiveResponseInfo:
-
-        _param = self._social_media_reddit_live_serialize(
-            list_optional_business_data_social_media_reddit_live_request_info=list_optional_business_data_social_media_reddit_live_request_info,
-            _request_auth=_request_auth,
-            _content_type=_content_type,
-            _headers=_headers,
-            _host_index=_host_index
-        )
-
-        _response_types_map: Dict[str, Optional[str]] = {
-            '200': "BusinessDataSocialMediaRedditLiveResponseInfo",
-        }
-        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 social_media_reddit_live_with_http_info(
-        self,
-        list_optional_business_data_social_media_reddit_live_request_info: 'List[Optional[BusinessDataSocialMediaRedditLiveRequestInfo]]' = 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[BusinessDataSocialMediaRedditLiveResponseInfo]':
-
-        _param = self._social_media_reddit_live_serialize(
-            list_optional_business_data_social_media_reddit_live_request_info=list_optional_business_data_social_media_reddit_live_request_info,
-            _request_auth=_request_auth,
-            _content_type=_content_type,
-            _headers=_headers,
-            _host_index=_host_index
-        )
-
-        _response_types_map: Dict[str, Optional[str]] = {
-            '200': "BusinessDataSocialMediaRedditLiveResponseInfo",
-        }
-        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 social_media_reddit_live_without_preload_content(
-        self,
-        list_optional_business_data_social_media_reddit_live_request_info: 'List[Optional[BusinessDataSocialMediaRedditLiveRequestInfo]]' = 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:
-
-        _param = self._social_media_reddit_live_serialize(
-            list_optional_business_data_social_media_reddit_live_request_info=list_optional_business_data_social_media_reddit_live_request_info,
-            _request_auth=_request_auth,
-            _content_type=_content_type,
-            _headers=_headers,
-            _host_index=_host_index
-        )
-
-        _response_types_map: Dict[str, Optional[str]] = {
-            '200': "BusinessDataSocialMediaRedditLiveResponseInfo",
-        }
-        response_data = self.api_client.call_api(
-            *_param,
-            _request_timeout=_request_timeout
-        )
-        return response_data.response
-
-
-    def _social_media_reddit_live_serialize(
-        self,
-        list_optional_business_data_social_media_reddit_live_request_info,
-        _request_auth,
-        _content_type,
-        _headers,
-        _host_index,
-    ) -> RequestSerialized:
-
-        _host = None
-
-        _collection_formats: Dict[str, str] = {
-            'List[Optional[BusinessDataSocialMediaRedditLiveRequestInfo]]': '',
-        }
-
-        _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]] = {}
-        _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 list_optional_business_data_social_media_reddit_live_request_info is not None:
-            _body_params = list_optional_business_data_social_media_reddit_live_request_info
-
-
-        # set the HTTP header `Accept`
-        if 'Accept' not in _header_params:
-            _header_params['Accept'] = self.api_client.select_header_accept(
-                [
-                    'application/json'
-                ]
-            )
-
-        # 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'
-                    ]
-                )
-            )
-            if _default_content_type is not None:
-                _header_params['Content-Type'] = _default_content_type
-
-        # authentication setting
-        _auth_settings: List[str] = [
-            'basicAuth'
-        ]
-
-        return self.api_client.param_serialize(
-            method='POST',
-            resource_path='/v3/business_data/social_media/reddit/live',
-            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
         )

dataforseo_client/api/business_data_api.py

@@ -17,7 +17,6 @@
     from dataforseo_client.models.serp_google_locations_country_response_info import SerpGoogleLocationsCountryResponseInfo
     from dataforseo_client.models.serp_google_languages_response_info import SerpGoogleLanguagesResponseInfo
     from dataforseo_client.models.serp_google_organic_task_post_request_info import SerpGoogleOrganicTaskPostRequestInfo
-    from dataforseo_client.models.serp_api_stop_crawl_on_match_info import SerpApiStopCrawlOnMatchInfo
     from dataforseo_client.models.serp_google_organic_task_post_response_info import SerpGoogleOrganicTaskPostResponseInfo
     from dataforseo_client.models.serp_google_organic_tasks_ready_response_info import SerpGoogleOrganicTasksReadyResponseInfo
     from dataforseo_client.models.serp_tasks_ready_response_info import SerpTasksReadyResponseInfo
@@ -132,6 +131,7 @@
     from dataforseo_client.models.serp_bing_locations_country_response_info import SerpBingLocationsCountryResponseInfo
     from dataforseo_client.models.serp_bing_languages_response_info import SerpBingLanguagesResponseInfo
     from dataforseo_client.models.serp_bing_organic_task_post_request_info import SerpBingOrganicTaskPostRequestInfo
+    from dataforseo_client.models.serp_api_stop_crawl_on_match_info import SerpApiStopCrawlOnMatchInfo
     from dataforseo_client.models.serp_bing_organic_task_post_response_info import SerpBingOrganicTaskPostResponseInfo
     from dataforseo_client.models.serp_bing_organic_tasks_ready_response_info import SerpBingOrganicTasksReadyResponseInfo
     from dataforseo_client.models.serp_bing_organic_tasks_fixed_response_info import SerpBingOrganicTasksFixedResponseInfo

dataforseo_client/api/serp_api.py

@@ -62,7 +62,7 @@ def __init__(
             self.default_headers[header_name] = header_value
         self.cookie = cookie
         # Set default User-Agent.
-        self.user_agent = 'python-client/2.0.26'
+        self.user_agent = 'python-client/2.1.0'
         self.client_side_validation = configuration.client_side_validation
 
     def __enter__(self):

dataforseo_client/api_client.py

@@ -14,6 +14,9 @@
 class AboutThisResultElement(BaseModel):
     """
     AboutThisResultElement
+
+    .. deprecated::
+    
     """ # noqa: E501
     type: Optional[StrictStr] = Field(default=None, description=r"type of element")
     url: Optional[StrictStr] = Field(default=None, description=r"result’s URL")

dataforseo_client/models/about_this_result_element.py

@@ -17,7 +17,7 @@ class AbsoluteItems(BaseModel):
     """ # noqa: E501
     geo_id: Optional[StrictStr] = Field(default=None, description=r"location identifier. you can use this field for matching obtained results with location parameters specified in the request. see the full list of available locations with their geo_id here or by making a separate request to https://api.dataforseo.com/v3/keywords_data/dataforseo_trends/locations. example:. US-NY")
     geo_name: Optional[StrictStr] = Field(default=None, description=r"location name. you can use this field for matching obtained results with location parameters specified in the request. see the full list of available locations with their geo_name here or by making a separate request to https://api.dataforseo.com/v3/keywords_data/dataforseo_trends/locations. example:. Andorra")
-    values: Optional[List[Optional[StrictStr]]] = Field(default=None, description=r"keyword popularity rates within a given location. represents location-specific keyword popularity rate over the specified time range;. using these values, you can understand which of the specified keywords is more popular in the related location;. the first value in the array is provided for the first term from the keywords array, the second value is provided for the second keyword, and so on;. calculation: we determine the highest popularity value across all specified keywords within a given location, and then express the popularity values of each keyword as a percentage of the highest value (100);. a value of 100 is the peak popularity for the term. a value of 50 means that the term is half as popular. a value of 0 means there was not enough data for this term")
+    values: Optional[List[Optional[StrictStr]]] = Field(default=None, description=r"contains data on relative keyword popularity by country or region")
     __properties: ClassVar[List[str]] = [
         "geo_id", 
         "geo_name", 

dataforseo_client/models/absolute_items.py

@@ -16,8 +16,8 @@ class AdLinkElement(BaseModel):
     AdLinkElement
     """ # noqa: E501
     type: Optional[StrictStr] = Field(default=None, description=r"type of element")
-    title: Optional[StrictStr] = Field(default=None, description=r"reference page title")
-    description: Optional[StrictStr] = Field(default=None, description=r"link description")
+    title: Optional[StrictStr] = Field(default=None, description=r"title of the element in SERP")
+    description: Optional[StrictStr] = Field(default=None, description=r"description of the link")
     url: Optional[StrictStr] = Field(default=None, description=r"reference page URL")
     domain: Optional[StrictStr] = Field(default=None, description=r"domain where a link points")
     ad_aclk: Optional[StrictStr] = Field(default=None, description=r"the identifier of the ad")

dataforseo_client/models/ad_link_element.py

@@ -0,0 +1,69 @@
+from __future__ import annotations
+import pprint
+import re  # noqa: F401
+import json
+
+from pydantic import BaseModel, ConfigDict, Field, StrictFloat, StrictInt, StrictStr, StrictBool
+from typing import Any, ClassVar, Dict, List, Optional, Union
+from typing import Optional, Set, Any, Dict, List
+from typing_extensions import Self
+
+
+
+
+class AggregatedMetricsInfoTotalInfo(BaseModel):
+    """
+    AggregatedMetricsInfoTotalInfo
+    """ # noqa: E501
+    mentions: Optional[StrictInt] = Field(default=None, description=r"total LLM mentions count. the number of times the target keyword or domain were mentioned in relation to this specific grouping key")
+    ai_search_volume: Optional[StrictInt] = Field(default=None, description=r"aggregated AI search volume for mentions within this grouping. learn more about this metric here")
+    __properties: ClassVar[List[str]] = [
+        "mentions", 
+        "ai_search_volume", 
+        ]
+
+    additional_properties: Dict[str, Any] = Field(default_factory=dict)
+
+    model_config = ConfigDict(
+        populate_by_name=True,
+        validate_assignment=True,
+        protected_namespaces=(),
+    )
+
+    def to_str(self) -> str:
+        return pprint.pformat(self.model_dump(by_alias=True))
+
+    def to_json(self) -> str:
+        return json.dumps(self.to_dict())
+
+    @classmethod
+    def from_json(cls, json_str: str) -> Optional[Self]:
+        return cls.from_dict(json.loads(json_str))
+
+    def to_dict(self) -> Dict[str, Any]:
+        excluded_fields: Set[str] = set([
+        ])
+
+        _dict = {}
+
+        _dict['mentions'] = self.mentions
+        _dict['ai_search_volume'] = self.ai_search_volume
+        return _dict
+
+
+    @classmethod
+    def from_dict(cls, obj: Optional[Dict[str, Any]]) -> Optional[Self]:
+        if obj is None:
+            return None
+
+        if not isinstance(obj, dict):
+            return cls.model_validate(obj)
+
+        _obj = cls.model_validate({
+            "mentions": obj.get("mentions"),
+            "ai_search_volume": obj.get("ai_search_volume"),
+        })
+
+        additional_properties = {k: v for k, v in obj.items() if k not in cls.__properties}
+        _obj.additional_properties = additional_properties
+        return _obj