wordlift-client 1.134.0__py3-none-any.whl → 1.136.0__py3-none-any.whl

wordlift_client/models/detected_schema.py

@@ -0,0 +1,100 @@
+# 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, field_validator
+from typing import Any, ClassVar, Dict, List, Optional
+from typing import Optional, Set
+from typing_extensions import Self
+
+class DetectedSchema(BaseModel):
+    """
+    DetectedSchema
+    """ # noqa: E501
+    type: Optional[StrictStr] = Field(default=None, description="Schema.org type (e.g., Organization, WebSite, Article)")
+    format: Optional[StrictStr] = Field(default=None, description="Format of the structured data")
+    __properties: ClassVar[List[str]] = ["type", "format"]
+
+    @field_validator('format')
+    def format_validate_enum(cls, value):
+        """Validates the enum"""
+        if value is None:
+            return value
+
+        if value not in set(['JSON-LD', 'Microdata']):
+            raise ValueError("must be one of enum values ('JSON-LD', 'Microdata')")
+        return value
+
+    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 DetectedSchema 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 DetectedSchema from a dict"""
+        if obj is None:
+            return None
+
+        if not isinstance(obj, dict):
+            return cls.model_validate(obj)
+
+        _obj = cls.model_validate({
+            "type": obj.get("type"),
+            "format": obj.get("format")
+        })
+        return _obj
+
+

wordlift_client/models/error_response.py

@@ -28,8 +28,9 @@ class ErrorResponse(BaseModel):
     ErrorResponse
     """ # noqa: E501
     success: Optional[StrictBool] = None
-    error: Optional[StrictStr] = Field(default=None, description="Error message")
-    __properties: ClassVar[List[str]] = ["success", "error"]
+    error: Optional[StrictStr] = Field(default=None, description="Error type/category")
+    message: Optional[StrictStr] = Field(default=None, description="Detailed error message")
+    __properties: ClassVar[List[str]] = ["success", "error", "message"]
 
     model_config = ConfigDict(
         populate_by_name=True,
@@ -83,7 +84,8 @@ class ErrorResponse(BaseModel):
 
         _obj = cls.model_validate({
             "success": obj.get("success"),
-            "error": obj.get("error")
+            "error": obj.get("error"),
+            "message": obj.get("message")
         })
         return _obj
 

wordlift_client/models/html_semantics.py

@@ -0,0 +1,100 @@
+# 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, field_validator
+from typing import Any, ClassVar, Dict, List, Optional
+from typing import Optional, Set
+from typing_extensions import Self
+
+class HtmlSemantics(BaseModel):
+    """
+    Legacy field - always returns status Unknown
+    """ # noqa: E501
+    status: Optional[StrictStr] = Field(default=None, description="Always returns Unknown as this analysis is integrated into Content Structure")
+    explanation: Optional[StrictStr] = Field(default=None, description="Explanation that this is integrated into Content Structure")
+    __properties: ClassVar[List[str]] = ["status", "explanation"]
+
+    @field_validator('status')
+    def status_validate_enum(cls, value):
+        """Validates the enum"""
+        if value is None:
+            return value
+
+        if value not in set(['Unknown']):
+            raise ValueError("must be one of enum values ('Unknown')")
+        return value
+
+    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 HtmlSemantics 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 HtmlSemantics from a dict"""
+        if obj is None:
+            return None
+
+        if not isinstance(obj, dict):
+            return cls.model_validate(obj)
+
+        _obj = cls.model_validate({
+            "status": obj.get("status"),
+            "explanation": obj.get("explanation")
+        })
+        return _obj
+
+

wordlift_client/models/http_validation_error1.py

@@ -0,0 +1,96 @@
+# 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
+from typing import Any, ClassVar, Dict, List, Optional
+from wordlift_client.models.validation_error1 import ValidationError1
+from typing import Optional, Set
+from typing_extensions import Self
+
+class HTTPValidationError1(BaseModel):
+    """
+    HTTPValidationError1
+    """ # noqa: E501
+    detail: Optional[List[ValidationError1]] = None
+    __properties: ClassVar[List[str]] = ["detail"]
+
+    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 HTTPValidationError1 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,
+        )
+        # override the default output from pydantic by calling `to_dict()` of each item in detail (list)
+        _items = []
+        if self.detail:
+            for _item in self.detail:
+                if _item:
+                    _items.append(_item.to_dict())
+            _dict['detail'] = _items
+        return _dict
+
+    @classmethod
+    def from_dict(cls, obj: Optional[Dict[str, Any]]) -> Optional[Self]:
+        """Create an instance of HTTPValidationError1 from a dict"""
+        if obj is None:
+            return None
+
+        if not isinstance(obj, dict):
+            return cls.model_validate(obj)
+
+        _obj = cls.model_validate({
+            "detail": [ValidationError1.from_dict(_item) for _item in obj["detail"]] if obj.get("detail") is not None else None
+        })
+        return _obj
+
+

wordlift_client/models/image_accessibility.py

@@ -19,7 +19,7 @@ import re  # noqa: F401
 import json
 
 from pydantic import BaseModel, ConfigDict, Field, StrictInt, StrictStr, field_validator
-from typing import Any, ClassVar, Dict, List, Optional, Union
+from typing import Any, ClassVar, Dict, List, Optional
 from typing_extensions import Annotated
 from typing import Optional, Set
 from typing_extensions import Self
@@ -28,12 +28,13 @@ class ImageAccessibility(BaseModel):
     """
     ImageAccessibility
     """ # noqa: E501
+    score: Optional[Annotated[int, Field(le=5, strict=True, ge=0)]] = Field(default=None, description="Numeric score for image accessibility (0-5)")
     status: Optional[StrictStr] = None
     explanation: Optional[StrictStr] = None
-    missing_alt_percentage: Optional[Union[Annotated[float, Field(le=100, strict=True, ge=0)], Annotated[int, Field(le=100, strict=True, ge=0)]]] = Field(default=None, description="Percentage of images missing alt text", alias="missingAltPercentage")
     total_images: Optional[StrictInt] = Field(default=None, description="Total number of images on the page", alias="totalImages")
     images_without_alt: Optional[StrictInt] = Field(default=None, description="Number of images without alt text", alias="imagesWithoutAlt")
-    __properties: ClassVar[List[str]] = ["status", "explanation", "missingAltPercentage", "totalImages", "imagesWithoutAlt"]
+    missing_alt_text_images: Optional[List[StrictStr]] = Field(default=None, description="Sample URLs or descriptions of images missing alt text", alias="missingAltTextImages")
+    __properties: ClassVar[List[str]] = ["score", "status", "explanation", "totalImages", "imagesWithoutAlt", "missingAltTextImages"]
 
     @field_validator('status')
     def status_validate_enum(cls, value):
@@ -41,8 +42,8 @@ class ImageAccessibility(BaseModel):
         if value is None:
             return value
 
-        if value not in set(['Good', 'Needs Improvement', 'Poor']):
-            raise ValueError("must be one of enum values ('Good', 'Needs Improvement', 'Poor')")
+        if value not in set(['Good', 'Needs Improvement', 'Poor', 'Unknown']):
+            raise ValueError("must be one of enum values ('Good', 'Needs Improvement', 'Poor', 'Unknown')")
         return value
 
     model_config = ConfigDict(
@@ -96,11 +97,12 @@ class ImageAccessibility(BaseModel):
             return cls.model_validate(obj)
 
         _obj = cls.model_validate({
+            "score": obj.get("score"),
             "status": obj.get("status"),
             "explanation": obj.get("explanation"),
-            "missingAltPercentage": obj.get("missingAltPercentage"),
             "totalImages": obj.get("totalImages"),
-            "imagesWithoutAlt": obj.get("imagesWithoutAlt")
+            "imagesWithoutAlt": obj.get("imagesWithoutAlt"),
+            "missingAltTextImages": obj.get("missingAltTextImages")
         })
         return _obj
 

wordlift_client/models/internal_linking.py

@@ -0,0 +1,100 @@
+# 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, field_validator
+from typing import Any, ClassVar, Dict, List, Optional
+from typing import Optional, Set
+from typing_extensions import Self
+
+class InternalLinking(BaseModel):
+    """
+    Legacy field - always returns status Unknown
+    """ # noqa: E501
+    status: Optional[StrictStr] = Field(default=None, description="Always returns Unknown as this analysis is integrated into Content Structure")
+    explanation: Optional[StrictStr] = Field(default=None, description="Explanation that this is integrated into Content Structure")
+    __properties: ClassVar[List[str]] = ["status", "explanation"]
+
+    @field_validator('status')
+    def status_validate_enum(cls, value):
+        """Validates the enum"""
+        if value is None:
+            return value
+
+        if value not in set(['Unknown']):
+            raise ValueError("must be one of enum values ('Unknown')")
+        return value
+
+    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 InternalLinking 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 InternalLinking from a dict"""
+        if obj is None:
+            return None
+
+        if not isinstance(obj, dict):
+            return cls.model_validate(obj)
+
+        _obj = cls.model_validate({
+            "status": obj.get("status"),
+            "explanation": obj.get("explanation")
+        })
+        return _obj
+
+

wordlift_client/models/js_rendering.py

@@ -20,6 +20,7 @@ import json
 
 from pydantic import BaseModel, ConfigDict, Field, StrictStr, field_validator
 from typing import Any, ClassVar, Dict, List, Optional
+from typing_extensions import Annotated
 from typing import Optional, Set
 from typing_extensions import Self
 
@@ -27,14 +28,14 @@ class JsRendering(BaseModel):
     """
     JsRendering
     """ # noqa: E501
+    score: Optional[Annotated[int, Field(le=15, strict=True, ge=0)]] = Field(default=None, description="Numeric score for JavaScript rendering (0-15)")
     status: Optional[StrictStr] = None
     explanation: Optional[StrictStr] = None
-    framework_detected: Optional[StrictStr] = Field(default=None, description="Detected JavaScript framework (React, Vue, Angular, etc.)", alias="frameworkDetected")
+    framework_detected: Optional[StrictStr] = Field(default=None, description="Detected JavaScript framework (None, React, Vue, Angular, Next.js, Nuxt, Gatsby, Other)", alias="frameworkDetected")
     rendering_type: Optional[StrictStr] = Field(default=None, description="Type of rendering used by the site", alias="renderingType")
-    ai_accessibility: Optional[StrictStr] = Field(default=None, description="How accessible the content is to AI agents", alias="aiAccessibility")
-    content_availability: Optional[StrictStr] = Field(default=None, description="Description of content availability in HTML", alias="contentAvailability")
+    content_availability: Optional[StrictStr] = Field(default=None, description="Description of content availability in HTML (e.g., \"All content in HTML\", \"Mostly in HTML\", \"Partially in JS\", \"Mostly in JS\")", alias="contentAvailability")
     recommendations: Optional[List[StrictStr]] = Field(default=None, description="Recommendations for improving JS rendering")
-    __properties: ClassVar[List[str]] = ["status", "explanation", "frameworkDetected", "renderingType", "aiAccessibility", "contentAvailability", "recommendations"]
+    __properties: ClassVar[List[str]] = ["score", "status", "explanation", "frameworkDetected", "renderingType", "contentAvailability", "recommendations"]
 
     @field_validator('status')
     def status_validate_enum(cls, value):
@@ -42,8 +43,8 @@ class JsRendering(BaseModel):
         if value is None:
             return value
 
-        if value not in set(['Good', 'Needs Improvement', 'Poor']):
-            raise ValueError("must be one of enum values ('Good', 'Needs Improvement', 'Poor')")
+        if value not in set(['Good', 'Needs Improvement', 'Poor', 'Unknown']):
+            raise ValueError("must be one of enum values ('Good', 'Needs Improvement', 'Poor', 'Unknown')")
         return value
 
     @field_validator('rendering_type')
@@ -56,16 +57,6 @@ class JsRendering(BaseModel):
             raise ValueError("must be one of enum values ('Static', 'SSR', 'SSG', 'CSR', 'Hybrid')")
         return value
 
-    @field_validator('ai_accessibility')
-    def ai_accessibility_validate_enum(cls, value):
-        """Validates the enum"""
-        if value is None:
-            return value
-
-        if value not in set(['Excellent', 'Good', 'Limited', 'Blocked']):
-            raise ValueError("must be one of enum values ('Excellent', 'Good', 'Limited', 'Blocked')")
-        return value
-
     model_config = ConfigDict(
         populate_by_name=True,
         validate_assignment=True,
@@ -117,11 +108,11 @@ class JsRendering(BaseModel):
             return cls.model_validate(obj)
 
         _obj = cls.model_validate({
+            "score": obj.get("score"),
             "status": obj.get("status"),
             "explanation": obj.get("explanation"),
             "frameworkDetected": obj.get("frameworkDetected"),
             "renderingType": obj.get("renderingType"),
-            "aiAccessibility": obj.get("aiAccessibility"),
             "contentAvailability": obj.get("contentAvailability"),
             "recommendations": obj.get("recommendations")
         })

wordlift_client/models/monitor_result_item.py

@@ -0,0 +1,117 @@
+# 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 datetime import datetime
+from pydantic import BaseModel, ConfigDict, StrictFloat, StrictInt, StrictStr
+from typing import Any, ClassVar, Dict, List, Optional, Union
+from wordlift_client.models.monitor_state import MonitorState
+from typing import Optional, Set
+from typing_extensions import Self
+
+class MonitorResultItem(BaseModel):
+    """
+    MonitorResultItem
+    """ # noqa: E501
+    monitor_name: StrictStr
+    state: MonitorState
+    details: Optional[StrictStr] = None
+    score: Optional[Union[StrictFloat, StrictInt]] = None
+    metadata: Optional[Dict[str, Any]] = None
+    created_at: datetime
+    processed_at: Optional[datetime] = None
+    __properties: ClassVar[List[str]] = ["monitor_name", "state", "details", "score", "metadata", "created_at", "processed_at"]
+
+    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 MonitorResultItem 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,
+        )
+        # set to None if details (nullable) is None
+        # and model_fields_set contains the field
+        if self.details is None and "details" in self.model_fields_set:
+            _dict['details'] = None
+
+        # set to None if score (nullable) is None
+        # and model_fields_set contains the field
+        if self.score is None and "score" in self.model_fields_set:
+            _dict['score'] = None
+
+        # set to None if processed_at (nullable) is None
+        # and model_fields_set contains the field
+        if self.processed_at is None and "processed_at" in self.model_fields_set:
+            _dict['processed_at'] = None
+
+        return _dict
+
+    @classmethod
+    def from_dict(cls, obj: Optional[Dict[str, Any]]) -> Optional[Self]:
+        """Create an instance of MonitorResultItem from a dict"""
+        if obj is None:
+            return None
+
+        if not isinstance(obj, dict):
+            return cls.model_validate(obj)
+
+        _obj = cls.model_validate({
+            "monitor_name": obj.get("monitor_name"),
+            "state": obj.get("state"),
+            "details": obj.get("details"),
+            "score": obj.get("score"),
+            "metadata": obj.get("metadata"),
+            "created_at": obj.get("created_at"),
+            "processed_at": obj.get("processed_at")
+        })
+        return _obj
+
+