wordlift-client 1.125.0__tar.gz → 1.127.0__tar.gz

{wordlift_client-1.125.0/wordlift_client.egg-info → wordlift_client-1.127.0}/PKG-INFO

@@ -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 → wordlift_client-1.127.0}/README.md

@@ -4,7 +4,7 @@ WordLift API
 This Python package is automatically generated by the [OpenAPI Generator](https://openapi-generator.tech) project:
 
 - API version: 1.0
-- Package version: 1.125.0
+- Package version: 1.127.0
 - Generator version: 7.6.0
 - Build package: org.openapitools.codegen.languages.PythonClientCodegen
 For more information, please visit [https://wordlift.io](https://wordlift.io)
@@ -236,10 +236,12 @@ Class | Method | HTTP request | Description
 *WebAsyncsResponsesApi* | [**get1**](docs/WebAsyncsResponsesApi.md#get1) | **GET** /webasyncs/{id}/pull | Get by id
 *WebPagesImportsApi* | [**create_web_page_imports**](docs/WebPagesImportsApi.md#create_web_page_imports) | **POST** /web-page-imports | Create
 *WebPagesApi* | [**get_web_page**](docs/WebPagesApi.md#get_web_page) | **GET** /web-pages | Get
+*AiVisibilityApi* | [**create_ai_visibility_audit**](docs/AiVisibilityApi.md#create_ai_visibility_audit) | **POST** /ai-visibility-audits | Create AI visibility audits for Query Fan-Out
 
 
 ## Documentation For Models
 
+ - [AIVisibilityAnalysisResult](docs/AIVisibilityAnalysisResult.md)
  - [Account](docs/Account.md)
  - [AccountConfig](docs/AccountConfig.md)
  - [AccountInfo](docs/AccountInfo.md)
@@ -253,6 +255,7 @@ Class | Method | HTTP request | Description
  - [AnalyticsImportRequest](docs/AnalyticsImportRequest.md)
  - [AnalyticsSync](docs/AnalyticsSync.md)
  - [AnalyticsSyncRequest](docs/AnalyticsSyncRequest.md)
+ - [AnalyzeURLRequest](docs/AnalyzeURLRequest.md)
  - [AnchorText](docs/AnchorText.md)
  - [Annotation](docs/Annotation.md)
  - [AskRequest](docs/AskRequest.md)
@@ -371,6 +374,7 @@ Class | Method | HTTP request | Description
  - [ProjectType](docs/ProjectType.md)
  - [Properties](docs/Properties.md)
  - [Properties1](docs/Properties1.md)
+ - [QueryCoverage](docs/QueryCoverage.md)
  - [QuestionAndAnswer](docs/QuestionAndAnswer.md)
  - [QuestionAndAnswerRequest](docs/QuestionAndAnswerRequest.md)
  - [QuickWin](docs/QuickWin.md)

{wordlift_client-1.125.0 → wordlift_client-1.127.0}/pyproject.toml

@@ -1,6 +1,6 @@
 [tool.poetry]
 name = "wordlift_client"
-version = "1.125.0"
+version = "1.127.0"
 description = "WordLift API"
 authors = ["WordLift <hello@wordlift.io>"]
 license = "(c) copyright 2022-present WordLift"

{wordlift_client-1.125.0 → wordlift_client-1.127.0}/setup.py

@@ -22,7 +22,7 @@ from setuptools import setup, find_packages  # noqa: H301
 # prerequisite: setuptools
 # http://pypi.python.org/pypi/setuptools
 NAME = "wordlift-client"
-VERSION = "1.125.0"
+VERSION = "1.127.0"
 PYTHON_REQUIRES = ">=3.7"
 REQUIRES = [
     "urllib3 >= 1.25.3, < 2.1.0",

wordlift_client-1.127.0/test/test_ai_visibility_analysis_result.py

@@ -0,0 +1,83 @@
+# 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 unittest
+
+from wordlift_client.models.ai_visibility_analysis_result import AIVisibilityAnalysisResult
+
+class TestAIVisibilityAnalysisResult(unittest.TestCase):
+    """AIVisibilityAnalysisResult unit test stubs"""
+
+    def setUp(self):
+        pass
+
+    def tearDown(self):
+        pass
+
+    def make_instance(self, include_optional) -> AIVisibilityAnalysisResult:
+        """Test AIVisibilityAnalysisResult
+            include_option is a boolean, when False only required
+            params are included, when True both required and
+            optional params are included """
+        # uncomment below to create an instance of `AIVisibilityAnalysisResult`
+        """
+        model = AIVisibilityAnalysisResult()
+        if include_optional:
+            return AIVisibilityAnalysisResult(
+                url = '',
+                num_queries_requested = 56,
+                coverage_threshold = 1.337,
+                entity_name = '',
+                query_reasoning = '',
+                covered_count = 56,
+                total_queries = 56,
+                query_details = [
+                    wordlift_client.models.query_coverage.QueryCoverage(
+                        query = '', 
+                        is_covered = True, 
+                        similarity = 1.337, 
+                        best_chunk_preview = '', )
+                    ],
+                content_chunks_count = 56,
+                coverage_score = 1.337
+            )
+        else:
+            return AIVisibilityAnalysisResult(
+                url = '',
+                num_queries_requested = 56,
+                coverage_threshold = 1.337,
+                entity_name = '',
+                query_reasoning = '',
+                covered_count = 56,
+                total_queries = 56,
+                query_details = [
+                    wordlift_client.models.query_coverage.QueryCoverage(
+                        query = '', 
+                        is_covered = True, 
+                        similarity = 1.337, 
+                        best_chunk_preview = '', )
+                    ],
+                content_chunks_count = 56,
+                coverage_score = 1.337,
+        )
+        """
+
+    def testAIVisibilityAnalysisResult(self):
+        """Test AIVisibilityAnalysisResult"""
+        # inst_req_only = self.make_instance(include_optional=False)
+        # inst_req_and_optional = self.make_instance(include_optional=True)
+
+if __name__ == '__main__':
+    unittest.main()

wordlift_client-1.127.0/test/test_ai_visibility_api.py

@@ -0,0 +1,39 @@
+# 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 unittest
+
+from wordlift_client.api.ai_visibility_api import AiVisibilityApi
+
+
+class TestAiVisibilityApi(unittest.TestCase):
+    """AiVisibilityApi unit test stubs"""
+
+    def setUp(self) -> None:
+        self.api = AiVisibilityApi()
+
+    def tearDown(self) -> None:
+        pass
+
+    def test_create_ai_visibility_audit(self) -> None:
+        """Test case for create_ai_visibility_audit
+
+        Create AI visibility audits for Query Fan-Out
+        """
+        pass
+
+
+if __name__ == '__main__':
+    unittest.main()

wordlift_client-1.127.0/test/test_analyze_url_request.py

@@ -0,0 +1,55 @@
+# 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 unittest
+
+from wordlift_client.models.analyze_url_request import AnalyzeURLRequest
+
+class TestAnalyzeURLRequest(unittest.TestCase):
+    """AnalyzeURLRequest unit test stubs"""
+
+    def setUp(self):
+        pass
+
+    def tearDown(self):
+        pass
+
+    def make_instance(self, include_optional) -> AnalyzeURLRequest:
+        """Test AnalyzeURLRequest
+            include_option is a boolean, when False only required
+            params are included, when True both required and
+            optional params are included """
+        # uncomment below to create an instance of `AnalyzeURLRequest`
+        """
+        model = AnalyzeURLRequest()
+        if include_optional:
+            return AnalyzeURLRequest(
+                url = '0',
+                num_queries = 1,
+                coverage_threshold = 0
+            )
+        else:
+            return AnalyzeURLRequest(
+                url = '0',
+        )
+        """
+
+    def testAnalyzeURLRequest(self):
+        """Test AnalyzeURLRequest"""
+        # inst_req_only = self.make_instance(include_optional=False)
+        # inst_req_and_optional = self.make_instance(include_optional=True)
+
+if __name__ == '__main__':
+    unittest.main()

wordlift_client-1.127.0/test/test_query_coverage.py

@@ -0,0 +1,59 @@
+# 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 unittest
+
+from wordlift_client.models.query_coverage import QueryCoverage
+
+class TestQueryCoverage(unittest.TestCase):
+    """QueryCoverage unit test stubs"""
+
+    def setUp(self):
+        pass
+
+    def tearDown(self):
+        pass
+
+    def make_instance(self, include_optional) -> QueryCoverage:
+        """Test QueryCoverage
+            include_option is a boolean, when False only required
+            params are included, when True both required and
+            optional params are included """
+        # uncomment below to create an instance of `QueryCoverage`
+        """
+        model = QueryCoverage()
+        if include_optional:
+            return QueryCoverage(
+                query = '',
+                is_covered = True,
+                similarity = 1.337,
+                best_chunk_preview = ''
+            )
+        else:
+            return QueryCoverage(
+                query = '',
+                is_covered = True,
+                similarity = 1.337,
+                best_chunk_preview = '',
+        )
+        """
+
+    def testQueryCoverage(self):
+        """Test QueryCoverage"""
+        # inst_req_only = self.make_instance(include_optional=False)
+        # inst_req_and_optional = self.make_instance(include_optional=True)
+
+if __name__ == '__main__':
+    unittest.main()

{wordlift_client-1.125.0 → wordlift_client-1.127.0}/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-1.125.0 → wordlift_client-1.127.0}/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-1.127.0/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-1.125.0 → wordlift_client-1.127.0}/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):