wordlift-client 1.123.0__tar.gz → 1.124.0__tar.gz

{wordlift_client-1.123.0/wordlift_client.egg-info → wordlift_client-1.124.0}/PKG-INFO

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

{wordlift_client-1.123.0 → wordlift_client-1.124.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.123.0
+- Package version: 1.124.0
 - Generator version: 7.6.0
 - Build package: org.openapitools.codegen.languages.PythonClientCodegen
 For more information, please visit [https://wordlift.io](https://wordlift.io)
@@ -162,6 +162,7 @@ Class | Method | HTTP request | Description
 *EntityGapsApi* | [**create_entity_gap**](docs/EntityGapsApi.md#create_entity_gap) | **POST** /entity-gaps | Create
 *FactCheckApi* | [**submit_fact_check**](docs/FactCheckApi.md#submit_fact_check) | **POST** /fact-check/score | Submit a fact-checking request
 *GoogleMerchantsApi* | [**list_google_merchants**](docs/GoogleMerchantsApi.md#list_google_merchants) | **GET** /ext/google/shopping/merchants | List
+*GoogleSearchConsoleApi* | [**create_url_inspection**](docs/GoogleSearchConsoleApi.md#create_url_inspection) | **POST** /gsc/url-inspections | Create
 *GoogleSearchConsoleApi* | [**list_website_search**](docs/GoogleSearchConsoleApi.md#list_website_search) | **GET** /ext/google/searchconsole/searches | List Website Search data
 *GoogleSearchConsoleApi* | [**list_websites**](docs/GoogleSearchConsoleApi.md#list_websites) | **GET** /ext/google/searchconsole/websites | List
 *GoogleSearchConsoleOAuth2Api* | [**create_auth_code_exchange**](docs/GoogleSearchConsoleOAuth2Api.md#create_auth_code_exchange) | **POST** /google-search-console/oauth2/auth-code-exchanges | Get an Access Code
@@ -293,6 +294,7 @@ Class | Method | HTTP request | Description
  - [CreateEmbeddingsInput](docs/CreateEmbeddingsInput.md)
  - [CreateSEOScore200Response](docs/CreateSEOScore200Response.md)
  - [CreateSEOScoreRequest](docs/CreateSEOScoreRequest.md)
+ - [CreateUrlInspectionRequest](docs/CreateUrlInspectionRequest.md)
  - [DiagnosticPlugin](docs/DiagnosticPlugin.md)
  - [DiagnosticPluginRequest](docs/DiagnosticPluginRequest.md)
  - [DomainValidationRequest](docs/DomainValidationRequest.md)

{wordlift_client-1.123.0 → wordlift_client-1.124.0}/pyproject.toml

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

{wordlift_client-1.123.0 → wordlift_client-1.124.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.123.0"
+VERSION = "1.124.0"
 PYTHON_REQUIRES = ">=3.7"
 REQUIRES = [
     "urllib3 >= 1.25.3, < 2.1.0",

wordlift_client-1.124.0/test/test_create_url_inspection_request.py

@@ -0,0 +1,53 @@
+# 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.create_url_inspection_request import CreateUrlInspectionRequest
+
+class TestCreateUrlInspectionRequest(unittest.TestCase):
+    """CreateUrlInspectionRequest unit test stubs"""
+
+    def setUp(self):
+        pass
+
+    def tearDown(self):
+        pass
+
+    def make_instance(self, include_optional) -> CreateUrlInspectionRequest:
+        """Test CreateUrlInspectionRequest
+            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 `CreateUrlInspectionRequest`
+        """
+        model = CreateUrlInspectionRequest()
+        if include_optional:
+            return CreateUrlInspectionRequest(
+                url = ''
+            )
+        else:
+            return CreateUrlInspectionRequest(
+                url = '',
+        )
+        """
+
+    def testCreateUrlInspectionRequest(self):
+        """Test CreateUrlInspectionRequest"""
+        # 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.123.0 → wordlift_client-1.124.0}/wordlift_client/__init__.py

@@ -15,7 +15,7 @@
 """  # noqa: E501
 
 
-__version__ = "1.123.0"
+__version__ = "1.124.0"
 
 # import apis into sdk package
 from wordlift_client.api.account_api import AccountApi
@@ -154,6 +154,7 @@ from wordlift_client.models.content_structure import ContentStructure
 from wordlift_client.models.create_embeddings_input import CreateEmbeddingsInput
 from wordlift_client.models.create_seo_score200_response import CreateSEOScore200Response
 from wordlift_client.models.create_seo_score_request import CreateSEOScoreRequest
+from wordlift_client.models.create_url_inspection_request import CreateUrlInspectionRequest
 from wordlift_client.models.diagnostic_plugin import DiagnosticPlugin
 from wordlift_client.models.diagnostic_plugin_request import DiagnosticPluginRequest
 from wordlift_client.models.domain_validation_request import DomainValidationRequest

{wordlift_client-1.123.0 → wordlift_client-1.124.0}/wordlift_client/api/google_search_console_api.py

@@ -20,6 +20,7 @@ from typing_extensions import Annotated
 from pydantic import Field, StrictInt, StrictStr
 from typing import List, Optional
 from typing_extensions import Annotated
+from wordlift_client.models.create_url_inspection_request import CreateUrlInspectionRequest
 from wordlift_client.models.page_website import PageWebsite
 from wordlift_client.models.page_website_search import PageWebsiteSearch
 
@@ -41,6 +42,280 @@ class GoogleSearchConsoleApi:
         self.api_client = api_client
 
 
+    @validate_call
+    async def create_url_inspection(
+        self,
+        create_url_inspection_request: CreateUrlInspectionRequest,
+        _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,
+    ) -> str:
+        """Create
+
+        Inspect a URL using the Google Search Console connected to the authenticated account.
+
+        :param create_url_inspection_request: (required)
+        :type create_url_inspection_request: CreateUrlInspectionRequest
+        :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_url_inspection_serialize(
+            create_url_inspection_request=create_url_inspection_request,
+            _request_auth=_request_auth,
+            _content_type=_content_type,
+            _headers=_headers,
+            _host_index=_host_index
+        )
+
+        _response_types_map: Dict[str, Optional[str]] = {
+            '200': "str",
+            '301': None,
+        }
+        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_url_inspection_with_http_info(
+        self,
+        create_url_inspection_request: CreateUrlInspectionRequest,
+        _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[str]:
+        """Create
+
+        Inspect a URL using the Google Search Console connected to the authenticated account.
+
+        :param create_url_inspection_request: (required)
+        :type create_url_inspection_request: CreateUrlInspectionRequest
+        :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_url_inspection_serialize(
+            create_url_inspection_request=create_url_inspection_request,
+            _request_auth=_request_auth,
+            _content_type=_content_type,
+            _headers=_headers,
+            _host_index=_host_index
+        )
+
+        _response_types_map: Dict[str, Optional[str]] = {
+            '200': "str",
+            '301': None,
+        }
+        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_url_inspection_without_preload_content(
+        self,
+        create_url_inspection_request: CreateUrlInspectionRequest,
+        _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
+
+        Inspect a URL using the Google Search Console connected to the authenticated account.
+
+        :param create_url_inspection_request: (required)
+        :type create_url_inspection_request: CreateUrlInspectionRequest
+        :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_url_inspection_serialize(
+            create_url_inspection_request=create_url_inspection_request,
+            _request_auth=_request_auth,
+            _content_type=_content_type,
+            _headers=_headers,
+            _host_index=_host_index
+        )
+
+        _response_types_map: Dict[str, Optional[str]] = {
+            '200': "str",
+            '301': None,
+        }
+        response_data = await self.api_client.call_api(
+            *_param,
+            _request_timeout=_request_timeout
+        )
+        return response_data.response
+
+
+    def _create_url_inspection_serialize(
+        self,
+        create_url_inspection_request,
+        _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
+        # process the form parameters
+        # process the body parameter
+        if create_url_inspection_request is not None:
+            _body_params = create_url_inspection_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='/gsc/url-inspections',
+            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
     async def list_website_search(
         self,

{wordlift_client-1.123.0 → wordlift_client-1.124.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.123.0/python'
+        self.user_agent = 'OpenAPI-Generator/1.124.0/python'
         self.client_side_validation = configuration.client_side_validation
 
     async def __aenter__(self):

{wordlift_client-1.123.0 → wordlift_client-1.124.0}/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.123.0".\
+               "SDK Package Version: 1.124.0".\
                format(env=sys.platform, pyversion=sys.version)
 
     def get_host_settings(self):

{wordlift_client-1.123.0 → wordlift_client-1.124.0}/wordlift_client/models/__init__.py

@@ -68,6 +68,7 @@ from wordlift_client.models.content_structure import ContentStructure
 from wordlift_client.models.create_embeddings_input import CreateEmbeddingsInput
 from wordlift_client.models.create_seo_score200_response import CreateSEOScore200Response
 from wordlift_client.models.create_seo_score_request import CreateSEOScoreRequest
+from wordlift_client.models.create_url_inspection_request import CreateUrlInspectionRequest
 from wordlift_client.models.diagnostic_plugin import DiagnosticPlugin
 from wordlift_client.models.diagnostic_plugin_request import DiagnosticPluginRequest
 from wordlift_client.models.domain_validation_request import DomainValidationRequest

{wordlift_client-1.123.0 → wordlift_client-1.124.0}/wordlift_client/models/account_stats.py

@@ -27,11 +27,12 @@ class AccountStats(BaseModel):
     """
     The Account statistics
     """ # noqa: E501
+    account_id: StrictInt = Field(description="The account ID.")
     entities: StrictInt = Field(description="The number of entities.")
     entities_with_url: StrictInt = Field(description="The number of entities with URL.")
     product_groups: StrictInt = Field(description="The number of product groups in the KG.")
     products: StrictInt = Field(description="The number of products in the KG.")
-    __properties: ClassVar[List[str]] = ["entities", "entities_with_url", "product_groups", "products"]
+    __properties: ClassVar[List[str]] = ["account_id", "entities", "entities_with_url", "product_groups", "products"]
 
     model_config = ConfigDict(
         populate_by_name=True,
@@ -84,6 +85,7 @@ class AccountStats(BaseModel):
             return cls.model_validate(obj)
 
         _obj = cls.model_validate({
+            "account_id": obj.get("account_id"),
             "entities": obj.get("entities"),
             "entities_with_url": obj.get("entities_with_url"),
             "product_groups": obj.get("product_groups"),

wordlift_client-1.124.0/wordlift_client/models/create_url_inspection_request.py

@@ -0,0 +1,88 @@
+# 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, StrictStr
+from typing import Any, ClassVar, Dict, List
+from typing import Optional, Set
+from typing_extensions import Self
+
+class CreateUrlInspectionRequest(BaseModel):
+    """
+    A URL inspection request.
+    """ # noqa: E501
+    url: StrictStr = Field(description="The URL to analyze.")
+    __properties: ClassVar[List[str]] = ["url"]
+
+    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 CreateUrlInspectionRequest 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 CreateUrlInspectionRequest 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")
+        })
+        return _obj
+
+

{wordlift_client-1.123.0 → wordlift_client-1.124.0/wordlift_client.egg-info}/PKG-INFO

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

{wordlift_client-1.123.0 → wordlift_client-1.124.0}/wordlift_client.egg-info/SOURCES.txt

@@ -83,6 +83,7 @@ test/test_content_structure.py
 test/test_create_embeddings_input.py
 test/test_create_seo_score200_response.py
 test/test_create_seo_score_request.py
+test/test_create_url_inspection_request.py
 test/test_custom_domains_api.py
 test/test_data_uri_api.py
 test/test_dataset_api.py
@@ -412,6 +413,7 @@ wordlift_client/models/content_structure.py
 wordlift_client/models/create_embeddings_input.py
 wordlift_client/models/create_seo_score200_response.py
 wordlift_client/models/create_seo_score_request.py
+wordlift_client/models/create_url_inspection_request.py
 wordlift_client/models/diagnostic_plugin.py
 wordlift_client/models/diagnostic_plugin_request.py
 wordlift_client/models/domain_validation_request.py