wordlift-client 1.125.0__py3-none-any.whl → 1.127.0__py3-none-any.whl

wordlift_client/__init__.py

@@ -15,7 +15,7 @@
 """  # noqa: E501
 
 
-__version__ = "1.125.0"
+__version__ = "1.127.0"
 
 # import apis into sdk package
 from wordlift_client.api.account_api import AccountApi
@@ -87,6 +87,7 @@ from wordlift_client.api.web_asyncs_metadata_api import WebAsyncsMetadataApi
 from wordlift_client.api.web_asyncs_responses_api import WebAsyncsResponsesApi
 from wordlift_client.api.web_pages_imports_api import WebPagesImportsApi
 from wordlift_client.api.web_pages_api import WebPagesApi
+from wordlift_client.api.ai_visibility_api import AiVisibilityApi
 
 # import ApiClient
 from wordlift_client.api_response import ApiResponse
@@ -100,6 +101,7 @@ from wordlift_client.exceptions import ApiAttributeError
 from wordlift_client.exceptions import ApiException
 
 # import models into sdk package
+from wordlift_client.models.ai_visibility_analysis_result import AIVisibilityAnalysisResult
 from wordlift_client.models.account import Account
 from wordlift_client.models.account_config import AccountConfig
 from wordlift_client.models.account_info import AccountInfo
@@ -113,6 +115,7 @@ from wordlift_client.models.analyses_response_item import AnalysesResponseItem
 from wordlift_client.models.analytics_import_request import AnalyticsImportRequest
 from wordlift_client.models.analytics_sync import AnalyticsSync
 from wordlift_client.models.analytics_sync_request import AnalyticsSyncRequest
+from wordlift_client.models.analyze_url_request import AnalyzeURLRequest
 from wordlift_client.models.anchor_text import AnchorText
 from wordlift_client.models.annotation import Annotation
 from wordlift_client.models.ask_request import AskRequest
@@ -231,6 +234,7 @@ from wordlift_client.models.problem_detail import ProblemDetail
 from wordlift_client.models.project_type import ProjectType
 from wordlift_client.models.properties import Properties
 from wordlift_client.models.properties1 import Properties1
+from wordlift_client.models.query_coverage import QueryCoverage
 from wordlift_client.models.question_and_answer import QuestionAndAnswer
 from wordlift_client.models.question_and_answer_request import QuestionAndAnswerRequest
 from wordlift_client.models.quick_win import QuickWin

wordlift_client/api/__init__.py

@@ -70,4 +70,5 @@ from wordlift_client.api.web_asyncs_metadata_api import WebAsyncsMetadataApi
 from wordlift_client.api.web_asyncs_responses_api import WebAsyncsResponsesApi
 from wordlift_client.api.web_pages_imports_api import WebPagesImportsApi
 from wordlift_client.api.web_pages_api import WebPagesApi
+from wordlift_client.api.ai_visibility_api import AiVisibilityApi
 

wordlift_client/api/ai_visibility_api.py

@@ -0,0 +1,326 @@
+# coding: utf-8
+
+"""
+    WordLift API
+
+    WordLift API
+
+    The version of the OpenAPI document: 1.0
+    Contact: hello@wordlift.io
+    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 pydantic import StrictStr
+from typing import Optional
+from wordlift_client.models.ai_visibility_analysis_result import AIVisibilityAnalysisResult
+from wordlift_client.models.analyze_url_request import AnalyzeURLRequest
+
+from wordlift_client.api_client import ApiClient, RequestSerialized
+from wordlift_client.api_response import ApiResponse
+from wordlift_client.rest import RESTResponseType
+
+
+class AiVisibilityApi:
+    """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
+    async def create_ai_visibility_audit(
+        self,
+        analyze_url_request: AnalyzeURLRequest,
+        authorization: Optional[StrictStr] = 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,
+    ) -> AIVisibilityAnalysisResult:
+        """Create AI visibility audits for Query Fan-Out
+
+
+        :param analyze_url_request: (required)
+        :type analyze_url_request: AnalyzeURLRequest
+        :param authorization:
+        :type authorization: str
+        :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._create_ai_visibility_audit_serialize(
+            analyze_url_request=analyze_url_request,
+            authorization=authorization,
+            _request_auth=_request_auth,
+            _content_type=_content_type,
+            _headers=_headers,
+            _host_index=_host_index
+        )
+
+        _response_types_map: Dict[str, Optional[str]] = {
+            '200': "AIVisibilityAnalysisResult",
+            '422': "HTTPValidationError",
+        }
+        response_data = await self.api_client.call_api(
+            *_param,
+            _request_timeout=_request_timeout
+        )
+        await response_data.read()
+        return self.api_client.response_deserialize(
+            response_data=response_data,
+            response_types_map=_response_types_map,
+        ).data
+
+
+    @validate_call
+    async def create_ai_visibility_audit_with_http_info(
+        self,
+        analyze_url_request: AnalyzeURLRequest,
+        authorization: Optional[StrictStr] = 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[AIVisibilityAnalysisResult]:
+        """Create AI visibility audits for Query Fan-Out
+
+
+        :param analyze_url_request: (required)
+        :type analyze_url_request: AnalyzeURLRequest
+        :param authorization:
+        :type authorization: str
+        :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._create_ai_visibility_audit_serialize(
+            analyze_url_request=analyze_url_request,
+            authorization=authorization,
+            _request_auth=_request_auth,
+            _content_type=_content_type,
+            _headers=_headers,
+            _host_index=_host_index
+        )
+
+        _response_types_map: Dict[str, Optional[str]] = {
+            '200': "AIVisibilityAnalysisResult",
+            '422': "HTTPValidationError",
+        }
+        response_data = await self.api_client.call_api(
+            *_param,
+            _request_timeout=_request_timeout
+        )
+        await response_data.read()
+        return self.api_client.response_deserialize(
+            response_data=response_data,
+            response_types_map=_response_types_map,
+        )
+
+
+    @validate_call
+    async def create_ai_visibility_audit_without_preload_content(
+        self,
+        analyze_url_request: AnalyzeURLRequest,
+        authorization: Optional[StrictStr] = 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:
+        """Create AI visibility audits for Query Fan-Out
+
+
+        :param analyze_url_request: (required)
+        :type analyze_url_request: AnalyzeURLRequest
+        :param authorization:
+        :type authorization: str
+        :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._create_ai_visibility_audit_serialize(
+            analyze_url_request=analyze_url_request,
+            authorization=authorization,
+            _request_auth=_request_auth,
+            _content_type=_content_type,
+            _headers=_headers,
+            _host_index=_host_index
+        )
+
+        _response_types_map: Dict[str, Optional[str]] = {
+            '200': "AIVisibilityAnalysisResult",
+            '422': "HTTPValidationError",
+        }
+        response_data = await self.api_client.call_api(
+            *_param,
+            _request_timeout=_request_timeout
+        )
+        return response_data.response
+
+
+    def _create_ai_visibility_audit_serialize(
+        self,
+        analyze_url_request,
+        authorization,
+        _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]] = {}
+        _body_params: Optional[bytes] = None
+
+        # process the path parameters
+        # process the query parameters
+        # process the header parameters
+        if authorization is not None:
+            _header_params['authorization'] = authorization
+        # process the form parameters
+        # process the body parameter
+        if analyze_url_request is not None:
+            _body_params = analyze_url_request
+
+
+        # set the HTTP header `Accept`
+        _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] = [
+            'ApiKey'
+        ]
+
+        return self.api_client.param_serialize(
+            method='POST',
+            resource_path='/ai-visibility-audits',
+            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
+        )
+
+

wordlift_client/api_client.py

@@ -89,7 +89,7 @@ class ApiClient:
             self.default_headers[header_name] = header_value
         self.cookie = cookie
         # Set default User-Agent.
-        self.user_agent = 'OpenAPI-Generator/1.125.0/python'
+        self.user_agent = 'OpenAPI-Generator/1.127.0/python'
         self.client_side_validation = configuration.client_side_validation
 
     async def __aenter__(self):

wordlift_client/configuration.py

@@ -426,7 +426,7 @@ conf = wordlift_client.Configuration(
                "OS: {env}\n"\
                "Python Version: {pyversion}\n"\
                "Version of the API: 1.0\n"\
-               "SDK Package Version: 1.125.0".\
+               "SDK Package Version: 1.127.0".\
                format(env=sys.platform, pyversion=sys.version)
 
     def get_host_settings(self):

wordlift_client/models/__init__.py

@@ -15,6 +15,7 @@
 
 
 # import models into model package
+from wordlift_client.models.ai_visibility_analysis_result import AIVisibilityAnalysisResult
 from wordlift_client.models.account import Account
 from wordlift_client.models.account_config import AccountConfig
 from wordlift_client.models.account_info import AccountInfo
@@ -28,6 +29,7 @@ from wordlift_client.models.analyses_response_item import AnalysesResponseItem
 from wordlift_client.models.analytics_import_request import AnalyticsImportRequest
 from wordlift_client.models.analytics_sync import AnalyticsSync
 from wordlift_client.models.analytics_sync_request import AnalyticsSyncRequest
+from wordlift_client.models.analyze_url_request import AnalyzeURLRequest
 from wordlift_client.models.anchor_text import AnchorText
 from wordlift_client.models.annotation import Annotation
 from wordlift_client.models.ask_request import AskRequest
@@ -146,6 +148,7 @@ from wordlift_client.models.problem_detail import ProblemDetail
 from wordlift_client.models.project_type import ProjectType
 from wordlift_client.models.properties import Properties
 from wordlift_client.models.properties1 import Properties1
+from wordlift_client.models.query_coverage import QueryCoverage
 from wordlift_client.models.question_and_answer import QuestionAndAnswer
 from wordlift_client.models.question_and_answer_request import QuestionAndAnswerRequest
 from wordlift_client.models.quick_win import QuickWin

wordlift_client/models/ai_visibility_analysis_result.py

@@ -0,0 +1,116 @@
+# coding: utf-8
+
+"""
+    WordLift API
+
+    WordLift API
+
+    The version of the OpenAPI document: 1.0
+    Contact: hello@wordlift.io
+    Generated by OpenAPI Generator (https://openapi-generator.tech)
+
+    Do not edit the class manually.
+"""  # noqa: E501
+
+
+from __future__ import annotations
+import pprint
+import re  # noqa: F401
+import json
+
+from pydantic import BaseModel, ConfigDict, StrictFloat, StrictInt, StrictStr
+from typing import Any, ClassVar, Dict, List, Union
+from wordlift_client.models.query_coverage import QueryCoverage
+from typing import Optional, Set
+from typing_extensions import Self
+
+class AIVisibilityAnalysisResult(BaseModel):
+    """
+    AIVisibilityAnalysisResult
+    """ # noqa: E501
+    url: StrictStr
+    num_queries_requested: StrictInt
+    coverage_threshold: Union[StrictFloat, StrictInt]
+    entity_name: StrictStr
+    query_reasoning: StrictStr
+    covered_count: StrictInt
+    total_queries: StrictInt
+    query_details: List[QueryCoverage]
+    content_chunks_count: StrictInt
+    coverage_score: Union[StrictFloat, StrictInt]
+    __properties: ClassVar[List[str]] = ["url", "num_queries_requested", "coverage_threshold", "entity_name", "query_reasoning", "covered_count", "total_queries", "query_details", "content_chunks_count", "coverage_score"]
+
+    model_config = ConfigDict(
+        populate_by_name=True,
+        validate_assignment=True,
+        protected_namespaces=(),
+    )
+
+
+    def to_str(self) -> str:
+        """Returns the string representation of the model using alias"""
+        return pprint.pformat(self.model_dump(by_alias=True))
+
+    def to_json(self) -> str:
+        """Returns the JSON representation of the model using alias"""
+        # TODO: pydantic v2: use .model_dump_json(by_alias=True, exclude_unset=True) instead
+        return json.dumps(self.to_dict())
+
+    @classmethod
+    def from_json(cls, json_str: str) -> Optional[Self]:
+        """Create an instance of AIVisibilityAnalysisResult from a JSON string"""
+        return cls.from_dict(json.loads(json_str))
+
+    def to_dict(self) -> Dict[str, Any]:
+        """Return the dictionary representation of the model using alias.
+
+        This has the following differences from calling pydantic's
+        `self.model_dump(by_alias=True)`:
+
+        * `None` is only added to the output dict for nullable fields that
+          were set at model initialization. Other fields with value `None`
+          are ignored.
+        * OpenAPI `readOnly` fields are excluded.
+        """
+        excluded_fields: Set[str] = set([
+            "coverage_score",
+        ])
+
+        _dict = self.model_dump(
+            by_alias=True,
+            exclude=excluded_fields,
+            exclude_none=True,
+        )
+        # override the default output from pydantic by calling `to_dict()` of each item in query_details (list)
+        _items = []
+        if self.query_details:
+            for _item in self.query_details:
+                if _item:
+                    _items.append(_item.to_dict())
+            _dict['query_details'] = _items
+        return _dict
+
+    @classmethod
+    def from_dict(cls, obj: Optional[Dict[str, Any]]) -> Optional[Self]:
+        """Create an instance of AIVisibilityAnalysisResult from a dict"""
+        if obj is None:
+            return None
+
+        if not isinstance(obj, dict):
+            return cls.model_validate(obj)
+
+        _obj = cls.model_validate({
+            "url": obj.get("url"),
+            "num_queries_requested": obj.get("num_queries_requested"),
+            "coverage_threshold": obj.get("coverage_threshold"),
+            "entity_name": obj.get("entity_name"),
+            "query_reasoning": obj.get("query_reasoning"),
+            "covered_count": obj.get("covered_count"),
+            "total_queries": obj.get("total_queries"),
+            "query_details": [QueryCoverage.from_dict(_item) for _item in obj["query_details"]] if obj.get("query_details") is not None else None,
+            "content_chunks_count": obj.get("content_chunks_count"),
+            "coverage_score": obj.get("coverage_score")
+        })
+        return _obj
+
+

wordlift_client/models/analyze_url_request.py

@@ -0,0 +1,93 @@
+# coding: utf-8
+
+"""
+    WordLift API
+
+    WordLift API
+
+    The version of the OpenAPI document: 1.0
+    Contact: hello@wordlift.io
+    Generated by OpenAPI Generator (https://openapi-generator.tech)
+
+    Do not edit the class manually.
+"""  # noqa: E501
+
+
+from __future__ import annotations
+import pprint
+import re  # noqa: F401
+import json
+
+from pydantic import BaseModel, ConfigDict, Field
+from typing import Any, ClassVar, Dict, List, Optional, Union
+from typing_extensions import Annotated
+from typing import Optional, Set
+from typing_extensions import Self
+
+class AnalyzeURLRequest(BaseModel):
+    """
+    AnalyzeURLRequest
+    """ # noqa: E501
+    url: Annotated[str, Field(min_length=1, strict=True, max_length=2083)] = Field(description="The URL to analyze")
+    num_queries: Optional[Annotated[int, Field(le=20, strict=True, ge=1)]] = Field(default=10, description="Number of synthetic queries to generate")
+    coverage_threshold: Optional[Union[Annotated[float, Field(le=1, strict=True, ge=0)], Annotated[int, Field(le=1, strict=True, ge=0)]]] = Field(default=0.65, description="The threshold for answering synthetic queries")
+    __properties: ClassVar[List[str]] = ["url", "num_queries", "coverage_threshold"]
+
+    model_config = ConfigDict(
+        populate_by_name=True,
+        validate_assignment=True,
+        protected_namespaces=(),
+    )
+
+
+    def to_str(self) -> str:
+        """Returns the string representation of the model using alias"""
+        return pprint.pformat(self.model_dump(by_alias=True))
+
+    def to_json(self) -> str:
+        """Returns the JSON representation of the model using alias"""
+        # TODO: pydantic v2: use .model_dump_json(by_alias=True, exclude_unset=True) instead
+        return json.dumps(self.to_dict())
+
+    @classmethod
+    def from_json(cls, json_str: str) -> Optional[Self]:
+        """Create an instance of AnalyzeURLRequest from a JSON string"""
+        return cls.from_dict(json.loads(json_str))
+
+    def to_dict(self) -> Dict[str, Any]:
+        """Return the dictionary representation of the model using alias.
+
+        This has the following differences from calling pydantic's
+        `self.model_dump(by_alias=True)`:
+
+        * `None` is only added to the output dict for nullable fields that
+          were set at model initialization. Other fields with value `None`
+          are ignored.
+        """
+        excluded_fields: Set[str] = set([
+        ])
+
+        _dict = self.model_dump(
+            by_alias=True,
+            exclude=excluded_fields,
+            exclude_none=True,
+        )
+        return _dict
+
+    @classmethod
+    def from_dict(cls, obj: Optional[Dict[str, Any]]) -> Optional[Self]:
+        """Create an instance of AnalyzeURLRequest from a dict"""
+        if obj is None:
+            return None
+
+        if not isinstance(obj, dict):
+            return cls.model_validate(obj)
+
+        _obj = cls.model_validate({
+            "url": obj.get("url"),
+            "num_queries": obj.get("num_queries") if obj.get("num_queries") is not None else 10,
+            "coverage_threshold": obj.get("coverage_threshold") if obj.get("coverage_threshold") is not None else 0.65
+        })
+        return _obj
+
+

wordlift_client/models/query_coverage.py

@@ -0,0 +1,94 @@
+# coding: utf-8
+
+"""
+    WordLift API
+
+    WordLift API
+
+    The version of the OpenAPI document: 1.0
+    Contact: hello@wordlift.io
+    Generated by OpenAPI Generator (https://openapi-generator.tech)
+
+    Do not edit the class manually.
+"""  # noqa: E501
+
+
+from __future__ import annotations
+import pprint
+import re  # noqa: F401
+import json
+
+from pydantic import BaseModel, ConfigDict, StrictBool, StrictFloat, StrictInt, StrictStr
+from typing import Any, ClassVar, Dict, List, Union
+from typing import Optional, Set
+from typing_extensions import Self
+
+class QueryCoverage(BaseModel):
+    """
+    QueryCoverage
+    """ # noqa: E501
+    query: StrictStr
+    is_covered: StrictBool
+    similarity: Union[StrictFloat, StrictInt]
+    best_chunk_preview: StrictStr
+    __properties: ClassVar[List[str]] = ["query", "is_covered", "similarity", "best_chunk_preview"]
+
+    model_config = ConfigDict(
+        populate_by_name=True,
+        validate_assignment=True,
+        protected_namespaces=(),
+    )
+
+
+    def to_str(self) -> str:
+        """Returns the string representation of the model using alias"""
+        return pprint.pformat(self.model_dump(by_alias=True))
+
+    def to_json(self) -> str:
+        """Returns the JSON representation of the model using alias"""
+        # TODO: pydantic v2: use .model_dump_json(by_alias=True, exclude_unset=True) instead
+        return json.dumps(self.to_dict())
+
+    @classmethod
+    def from_json(cls, json_str: str) -> Optional[Self]:
+        """Create an instance of QueryCoverage from a JSON string"""
+        return cls.from_dict(json.loads(json_str))
+
+    def to_dict(self) -> Dict[str, Any]:
+        """Return the dictionary representation of the model using alias.
+
+        This has the following differences from calling pydantic's
+        `self.model_dump(by_alias=True)`:
+
+        * `None` is only added to the output dict for nullable fields that
+          were set at model initialization. Other fields with value `None`
+          are ignored.
+        """
+        excluded_fields: Set[str] = set([
+        ])
+
+        _dict = self.model_dump(
+            by_alias=True,
+            exclude=excluded_fields,
+            exclude_none=True,
+        )
+        return _dict
+
+    @classmethod
+    def from_dict(cls, obj: Optional[Dict[str, Any]]) -> Optional[Self]:
+        """Create an instance of QueryCoverage from a dict"""
+        if obj is None:
+            return None
+
+        if not isinstance(obj, dict):
+            return cls.model_validate(obj)
+
+        _obj = cls.model_validate({
+            "query": obj.get("query"),
+            "is_covered": obj.get("is_covered"),
+            "similarity": obj.get("similarity"),
+            "best_chunk_preview": obj.get("best_chunk_preview")
+        })
+        return _obj
+
+

{wordlift_client-1.125.0.dist-info → wordlift_client-1.127.0.dist-info}/METADATA

@@ -1,6 +1,6 @@
 Metadata-Version: 2.1
 Name: wordlift-client
-Version: 1.125.0
+Version: 1.127.0
 Summary: WordLift API
 Home-page: 
 Author: WordLift

{wordlift_client-1.125.0.dist-info → wordlift_client-1.127.0.dist-info}/RECORD

@@ -1,17 +1,18 @@
-wordlift_client/__init__.py,sha256=iXu3Zo9pb4XhmLw14wLMdwaj1QXeuxRnlajLy-DvhWc,19924
-wordlift_client/api_client.py,sha256=OgQYk9oKCoaugvRbDU6jttk7Itwq_3jZqQC_bIbcYqs,26397
+wordlift_client/__init__.py,sha256=ul82y3xlaiQQbpW4OcWTIA5NNHvP1ZBLqeIdVf2CYDc,20219
+wordlift_client/api_client.py,sha256=zLm4sF5bAe5JRn7vW9KajN02NqCz9z8k6dIXNHfUe6w,26397
 wordlift_client/api_response.py,sha256=eMxw1mpmJcoGZ3gs9z6jM4oYoZ10Gjk333s9sKxGv7s,652
-wordlift_client/configuration.py,sha256=-tL1kSArEyQzMYyeK533c0OHwy6u3CGRxvwix-cBXik,15932
+wordlift_client/configuration.py,sha256=564JXIfwgZHK6BeBhybYVlSst7o7LZ6dJi40MCrmgIA,15932
 wordlift_client/exceptions.py,sha256=KvTu-E964XhAzMXOSfVycfOL1Eeraob5bgD4CfElD7M,5912
 wordlift_client/py.typed,sha256=47DEQpj8HBSa-_TImW-5JCeuQeRkm5NMpJWZG3hSuFU,0
 wordlift_client/rest.py,sha256=3D4hicZkeSFLxmhmgnlH63K7P39ToGyPk_3aQlHGznI,6817
-wordlift_client/api/__init__.py,sha256=ZFtlLTTprWNEj_vslrt3v3nploOs7k1X7XAAixnYIN4,5031
+wordlift_client/api/__init__.py,sha256=k7DpBQqbu6cTWKxrysIfdyzj8SzA_06DYZyT80OJoQo,5097
 wordlift_client/api/account_api.py,sha256=wxVhHEPyMfNpC1_sBLp2nECfvyGIVwlqqM2Xu3EGSHI,10288
 wordlift_client/api/account_google_search_console_api.py,sha256=QruHrGZ1LMRhVrVt5k1UOAQZSkMY8zMZWkQ2DdeD5Dw,12119
 wordlift_client/api/account_stats_api.py,sha256=tQshIfkbME-WMY-sBMwUUZdSTDBeoaV0wnrtAnaFv_g,10480
 wordlift_client/api/accounts_api.py,sha256=Lk8vONdxCPROiRllJKmvbT_IrryDFDZ2bpSbrklUAZU,48479
 wordlift_client/api/add_ons_api.py,sha256=BshQhozQWz1r9VGRFXwfUQF46kqoXXhiQvngGwAuDu4,12439
 wordlift_client/api/agent_api.py,sha256=2UwVNrNKWTPWYWS5TJm2Cucn5i9n3DiaKvcIn5Ol7YI,11591
+wordlift_client/api/ai_visibility_api.py,sha256=CfuOGWLl92Vx7k_w-tmj4WOBiyDfPI2sh9hvMwPAv9g,12393
 wordlift_client/api/analyses_api.py,sha256=S4VB2WoTG5WuPdg4xdrLfAR47YrUQzNmoVmVSTdcdvk,42549
 wordlift_client/api/analytics_imports_api.py,sha256=3H2K6QLm7gFck67KCnIXLrKbxsKwjteNgTHD1utDE3s,11969
 wordlift_client/api/analytics_syncs_api.py,sha256=yblLuk2iz9zjqT8rRkmVb7C1rPPxmOcLFnuMpSqq3-Q,22587
@@ -80,7 +81,7 @@ wordlift_client/api/web_asyncs_metadata_api.py,sha256=cpDQmIGc6uHu5rFXwZAy1cVgcW
 wordlift_client/api/web_asyncs_responses_api.py,sha256=h91xI3iIgGoMUcZ7Oft5xiLy0rHh_2qzZDrFTRz3P8w,10889
 wordlift_client/api/web_pages_api.py,sha256=VKPLIaQRxxDn3daP0zvXRiHj2eegsZIjxUmHKzxZXoc,10839
 wordlift_client/api/web_pages_imports_api.py,sha256=yPhNLZ1jV2dEDnYuHb7OpiFH3K2ROrRYHG4ZrAf4VMU,11719
-wordlift_client/models/__init__.py,sha256=JiVI6hniFzJl7yIWkF_uALxoroNrgbZjUiS2clqtgps,14386
+wordlift_client/models/__init__.py,sha256=do9iR5985QQzxIqdpUgLK1w5m6otQkkw7QX5YyLXsEQ,14615
 wordlift_client/models/account.py,sha256=trGNzy3ZBGE1VsSke4aoXBQem-3jK60xVz0OWOOMWso,5523
 wordlift_client/models/account_config.py,sha256=_4YZ8IGS4h16wa9aSaL9rpeoZYR8faiwEAtovP4eBVI,2592
 wordlift_client/models/account_info.py,sha256=tCqVHqfeK5u1cQkLOBgJRUTs-e8vmGCjqZ4wgfmNIuw,7750
@@ -88,12 +89,14 @@ wordlift_client/models/account_stats.py,sha256=hMtiIDYGGMp4ytKgvgBIx40U5EyWr6-IJ
 wordlift_client/models/account_subscription.py,sha256=hJNuMXCDt9EqLvp3vfgv2xMc1Uk7UQ7gzTM320MsPbk,2858
 wordlift_client/models/active_account.py,sha256=rFDPX3X2hwMQfMnURcLEPgb9W5NGE1xmDIQhPZRMXQA,5707
 wordlift_client/models/add_on_configuration.py,sha256=8sEIAr91rjmj-A3B1vGUVlZkc_hVxOSmO_Irt4irhz4,3731
+wordlift_client/models/ai_visibility_analysis_result.py,sha256=vyn8S5FK_-Wcx5BnJOUhNKwvK52P-q-VK16wSaA-TYo,4095
 wordlift_client/models/analyses_request.py,sha256=_D_X2nN1Dkq835XUs8rinSSNOgQf5nXrFUV_YFbUI6E,4553
 wordlift_client/models/analyses_response.py,sha256=Nd7Tm2Cll3zqLCAx6KpgaY-dqQgmYLwKxnICOBBdmhU,2924
 wordlift_client/models/analyses_response_item.py,sha256=A-Xu3xm-XsOLfcxQa4ULb6p_T3CUXcrz7jVmzg3cBvM,3906
 wordlift_client/models/analytics_import_request.py,sha256=yfc37Vz_NnDWJrH8GpRke9-paSFbe__v9IJknIaKWHc,2538
 wordlift_client/models/analytics_sync.py,sha256=0H_ac6_00mNBBdfninOli6Bq_Rr9RdjZKZf-qLGSWt4,5415
 wordlift_client/models/analytics_sync_request.py,sha256=TWvOIfsF2V1_zJSC8NhUwB7WXiD2fEguqAQ4KmY-Z-s,2487
+wordlift_client/models/analyze_url_request.py,sha256=-NCLEKVLL2SzpdcGDzqy1gJLRywWvPfAeKzNTg0hagg,3196
 wordlift_client/models/anchor_text.py,sha256=O0vQxxJfMhzWZ66-39bilO_cc1v89iyMaypoeK3YrFQ,4364
 wordlift_client/models/annotation.py,sha256=HRjN8hQ-Xz-rUOdLYTgUhucJ-vDATKhFSj1wRFqBMtw,3795
 wordlift_client/models/ask_request.py,sha256=sot1ueKn5jB6cWK6XETvaUjDcRINCCsUm-n-0cX4lWI,2712
@@ -217,6 +220,7 @@ wordlift_client/models/problem_detail.py,sha256=4_7xA64rpygLnTPtKyCYLeOcjBKs0GID
 wordlift_client/models/project_type.py,sha256=nUZ2YFzVSArByM6HMCzVdR7GH2cab22RcwhD5ROPqPM,745
 wordlift_client/models/properties.py,sha256=MiXOK8WyyBI_n-SCFq0ZFzyiNesx3IRud9FHculCk4g,2657
 wordlift_client/models/properties1.py,sha256=bcVIqb9yCa3bLztYT3Z8hwcTbNhz_FuBvzwnES6s05s,2712
+wordlift_client/models/query_coverage.py,sha256=O3_omdnagA9UyMU8DrZHgxzqRXim0KxCQof4ovB5LZc,2775
 wordlift_client/models/question_and_answer.py,sha256=y2-ZyG-KKlRQZzG-u8GX2QB_w8FiWKS24x5ngbJOQMs,5655
 wordlift_client/models/question_and_answer_request.py,sha256=yPMv-dFIkCkyMD0mwfYujvecVo0TAhEVy6gkHKOCwzc,3111
 wordlift_client/models/quick_win.py,sha256=WVcvUhh0uii0QYbEF-7CGvs-NtUO6lbZzLkcu8tZhgc,3187
@@ -276,8 +280,8 @@ wordlift_client/models/with_limits.py,sha256=rSzDb_If8APxR2Rw2U6cfFRFubnnai3Vj3-
 wordlift_client/models/word.py,sha256=FPCGb6ohwdfydE5_qG4PT-UrnMzaTktAWqEEnezwaso,3922
 wordlift_client/models/word_repetition_data.py,sha256=CQnxCnhakt12czl6a_AQIPgHlJtvR9YGBIjGV22rq14,2659
 wordlift_client/models/word_request.py,sha256=ZD13xNRYCZmF14jxEDrRRyEMAd-quDT-HsqkbUP_xWU,2627
-wordlift_client-1.125.0.dist-info/LICENSE,sha256=xx0jnfkXJvxRnG63LTGOxlggYnIysveWIZ6H3PNdCrQ,11357
-wordlift_client-1.125.0.dist-info/METADATA,sha256=33SE7W7PVoOAKyJeg6IEmZDZhRcF6yiRuuSR2M_t8a8,530
-wordlift_client-1.125.0.dist-info/WHEEL,sha256=iAkIy5fosb7FzIOwONchHf19Qu7_1wCWyFNR5gu9nU0,91
-wordlift_client-1.125.0.dist-info/top_level.txt,sha256=p7KFYU869ksxkpP7ADvg8baPgWkTYCzcOpDl1qrJdHk,16
-wordlift_client-1.125.0.dist-info/RECORD,,
+wordlift_client-1.127.0.dist-info/LICENSE,sha256=xx0jnfkXJvxRnG63LTGOxlggYnIysveWIZ6H3PNdCrQ,11357
+wordlift_client-1.127.0.dist-info/METADATA,sha256=KAnzJQceFC2xKltBI-CZthbor4g5yQrl7YjLtNB4mIc,530
+wordlift_client-1.127.0.dist-info/WHEEL,sha256=iAkIy5fosb7FzIOwONchHf19Qu7_1wCWyFNR5gu9nU0,91
+wordlift_client-1.127.0.dist-info/top_level.txt,sha256=p7KFYU869ksxkpP7ADvg8baPgWkTYCzcOpDl1qrJdHk,16
+wordlift_client-1.127.0.dist-info/RECORD,,