wordlift-client 1.111.0__py3-none-any.whl → 1.113.0__py3-none-any.whl

wordlift_client/api/redeem_codes_api.py

@@ -17,8 +17,8 @@ from pydantic import validate_call, Field, StrictFloat, StrictStr, StrictInt
 from typing import Any, Dict, List, Optional, Tuple, Union
 from typing_extensions import Annotated
 
-from wordlift_client.models.request import Request
-from wordlift_client.models.response import Response
+from wordlift_client.models.request2 import Request2
+from wordlift_client.models.response1 import Response1
 
 from wordlift_client.api_client import ApiClient, RequestSerialized
 from wordlift_client.api_response import ApiResponse
@@ -41,7 +41,7 @@ class RedeemCodesApi:
     @validate_call
     async def redeem_code(
         self,
-        request: Request,
+        request2: Request2,
         _request_timeout: Union[
             None,
             Annotated[StrictFloat, Field(gt=0)],
@@ -54,12 +54,12 @@ class RedeemCodesApi:
         _content_type: Optional[StrictStr] = None,
         _headers: Optional[Dict[StrictStr, Any]] = None,
         _host_index: Annotated[StrictInt, Field(ge=0, le=0)] = 0,
-    ) -> Response:
+    ) -> Response1:
         """Redeem the provided code and get a key
 
 
-        :param request: (required)
-        :type request: Request
+        :param request2: (required)
+        :type request2: Request2
         :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
@@ -83,7 +83,7 @@ class RedeemCodesApi:
         """ # noqa: E501
 
         _param = self._redeem_code_serialize(
-            request=request,
+            request2=request2,
             _request_auth=_request_auth,
             _content_type=_content_type,
             _headers=_headers,
@@ -91,7 +91,7 @@ class RedeemCodesApi:
         )
 
         _response_types_map: Dict[str, Optional[str]] = {
-            '200': "Response",
+            '200': "Response1",
             '404': "ProblemDetail",
             '409': "ProblemDetail",
             '500': "ProblemDetail",
@@ -110,7 +110,7 @@ class RedeemCodesApi:
     @validate_call
     async def redeem_code_with_http_info(
         self,
-        request: Request,
+        request2: Request2,
         _request_timeout: Union[
             None,
             Annotated[StrictFloat, Field(gt=0)],
@@ -123,12 +123,12 @@ class RedeemCodesApi:
         _content_type: Optional[StrictStr] = None,
         _headers: Optional[Dict[StrictStr, Any]] = None,
         _host_index: Annotated[StrictInt, Field(ge=0, le=0)] = 0,
-    ) -> ApiResponse[Response]:
+    ) -> ApiResponse[Response1]:
         """Redeem the provided code and get a key
 
 
-        :param request: (required)
-        :type request: Request
+        :param request2: (required)
+        :type request2: Request2
         :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
@@ -152,7 +152,7 @@ class RedeemCodesApi:
         """ # noqa: E501
 
         _param = self._redeem_code_serialize(
-            request=request,
+            request2=request2,
             _request_auth=_request_auth,
             _content_type=_content_type,
             _headers=_headers,
@@ -160,7 +160,7 @@ class RedeemCodesApi:
         )
 
         _response_types_map: Dict[str, Optional[str]] = {
-            '200': "Response",
+            '200': "Response1",
             '404': "ProblemDetail",
             '409': "ProblemDetail",
             '500': "ProblemDetail",
@@ -179,7 +179,7 @@ class RedeemCodesApi:
     @validate_call
     async def redeem_code_without_preload_content(
         self,
-        request: Request,
+        request2: Request2,
         _request_timeout: Union[
             None,
             Annotated[StrictFloat, Field(gt=0)],
@@ -196,8 +196,8 @@ class RedeemCodesApi:
         """Redeem the provided code and get a key
 
 
-        :param request: (required)
-        :type request: Request
+        :param request2: (required)
+        :type request2: Request2
         :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
@@ -221,7 +221,7 @@ class RedeemCodesApi:
         """ # noqa: E501
 
         _param = self._redeem_code_serialize(
-            request=request,
+            request2=request2,
             _request_auth=_request_auth,
             _content_type=_content_type,
             _headers=_headers,
@@ -229,7 +229,7 @@ class RedeemCodesApi:
         )
 
         _response_types_map: Dict[str, Optional[str]] = {
-            '200': "Response",
+            '200': "Response1",
             '404': "ProblemDetail",
             '409': "ProblemDetail",
             '500': "ProblemDetail",
@@ -243,7 +243,7 @@ class RedeemCodesApi:
 
     def _redeem_code_serialize(
         self,
-        request,
+        request2,
         _request_auth,
         _content_type,
         _headers,
@@ -267,8 +267,8 @@ class RedeemCodesApi:
         # process the header parameters
         # process the form parameters
         # process the body parameter
-        if request is not None:
-            _body_params = request
+        if request2 is not None:
+            _body_params = request2
 
 
         # set the HTTP header `Accept`

wordlift_client/api/web_asyncs_metadata_api.py

@@ -41,7 +41,7 @@ class WebAsyncsMetadataApi:
 
 
     @validate_call
-    async def get1(
+    async def get(
         self,
         id: Annotated[StrictStr, Field(description="The Web Async id")],
         _request_timeout: Union[
@@ -85,7 +85,7 @@ class WebAsyncsMetadataApi:
         :return: Returns the result object.
         """ # noqa: E501
 
-        _param = self._get1_serialize(
+        _param = self._get_serialize(
             id=id,
             _request_auth=_request_auth,
             _content_type=_content_type,
@@ -110,7 +110,7 @@ class WebAsyncsMetadataApi:
 
 
     @validate_call
-    async def get1_with_http_info(
+    async def get_with_http_info(
         self,
         id: Annotated[StrictStr, Field(description="The Web Async id")],
         _request_timeout: Union[
@@ -154,7 +154,7 @@ class WebAsyncsMetadataApi:
         :return: Returns the result object.
         """ # noqa: E501
 
-        _param = self._get1_serialize(
+        _param = self._get_serialize(
             id=id,
             _request_auth=_request_auth,
             _content_type=_content_type,
@@ -179,7 +179,7 @@ class WebAsyncsMetadataApi:
 
 
     @validate_call
-    async def get1_without_preload_content(
+    async def get_without_preload_content(
         self,
         id: Annotated[StrictStr, Field(description="The Web Async id")],
         _request_timeout: Union[
@@ -223,7 +223,7 @@ class WebAsyncsMetadataApi:
         :return: Returns the result object.
         """ # noqa: E501
 
-        _param = self._get1_serialize(
+        _param = self._get_serialize(
             id=id,
             _request_auth=_request_auth,
             _content_type=_content_type,
@@ -243,7 +243,7 @@ class WebAsyncsMetadataApi:
         return response_data.response
 
 
-    def _get1_serialize(
+    def _get_serialize(
         self,
         id,
         _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.111.0/python'
+        self.user_agent = 'OpenAPI-Generator/1.113.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.111.0".\
+               "SDK Package Version: 1.113.0".\
                format(env=sys.platform, pyversion=sys.version)
 
     def get_host_settings(self):

wordlift_client/models/autocomplete_result.py

@@ -37,10 +37,10 @@ class AutocompleteResult(BaseModel):
     scope: Optional[StrictStr] = None
     description: Optional[StrictStr] = None
     main_type: Optional[StrictStr] = Field(default=None, description="Schema type slug", alias="mainType")
-    value: Optional[StrictStr] = None
     label: Optional[StrictStr] = None
+    value: Optional[StrictStr] = None
     display_types: Optional[StrictStr] = Field(default=None, alias="displayTypes")
-    __properties: ClassVar[List[str]] = ["id", "labels", "descriptions", "types", "urls", "images", "sameAss", "scope", "description", "mainType", "value", "label", "displayTypes"]
+    __properties: ClassVar[List[str]] = ["id", "labels", "descriptions", "types", "urls", "images", "sameAss", "scope", "description", "mainType", "label", "value", "displayTypes"]
 
     @field_validator('scope')
     def scope_validate_enum(cls, value):
@@ -113,8 +113,8 @@ class AutocompleteResult(BaseModel):
             "scope": obj.get("scope"),
             "description": obj.get("description"),
             "mainType": obj.get("mainType"),
-            "value": obj.get("value"),
             "label": obj.get("label"),
+            "value": obj.get("value"),
             "displayTypes": obj.get("displayTypes")
         })
         return _obj

wordlift_client/models/request.py

@@ -25,10 +25,12 @@ from typing_extensions import Self
 
 class Request(BaseModel):
     """
-    Request
+    The Event request
     """ # noqa: E501
-    redeem_code: Optional[StrictStr] = None
-    __properties: ClassVar[List[str]] = ["redeem_code"]
+    source: Optional[StrictStr] = None
+    args: Optional[Dict[str, Any]] = None
+    url: Optional[StrictStr] = None
+    __properties: ClassVar[List[str]] = ["source", "args", "url"]
 
     model_config = ConfigDict(
         populate_by_name=True,
@@ -81,7 +83,9 @@ class Request(BaseModel):
             return cls.model_validate(obj)
 
         _obj = cls.model_validate({
-            "redeem_code": obj.get("redeem_code")
+            "source": obj.get("source"),
+            "args": obj.get("args"),
+            "url": obj.get("url")
         })
         return _obj
 

wordlift_client/models/request1.py

@@ -18,37 +18,21 @@ import pprint
 import re  # noqa: F401
 import json
 
-from pydantic import BaseModel, ConfigDict, Field, StrictInt, StrictStr, field_validator
+from datetime import datetime
+from pydantic import BaseModel, ConfigDict, Field, StrictBool, StrictStr
 from typing import Any, ClassVar, Dict, List, Optional
-from typing_extensions import Annotated
-from wordlift_client.models.html import Html
 from typing import Optional, Set
 from typing_extensions import Self
 
 class Request1(BaseModel):
     """
-    The request
+    Request1
     """ # noqa: E501
-    html: Optional[Html] = None
-    url: Optional[StrictStr] = Field(default=None, description="The url of the page to analyze.")
-    url_client: Optional[StrictStr] = Field(default=None, description="The client which the analysis should use to extract the content, by default chrome is used.", alias="urlClient")
-    language: Annotated[str, Field(min_length=2, strict=True, max_length=2)] = Field(description="The content language, 2 letters code, e.g. 'en'.")
-    text: Optional[StrictStr] = Field(default=None, description="A textual fragment.")
-    exclude: Optional[List[StrictStr]] = Field(default=None, description="An array of item IDs to exclude from the analysis results.")
-    scope: StrictStr = Field(description="The scope of the analysis, one of 'local', 'network', 'cloud-only', 'network-only' or 'all'.")
-    matches: Optional[StrictInt] = Field(default=None, description="Filter out results that don't have at least the specified number of occurrences. By default 1.")
-    links: Optional[StrictStr] = Field(default=None, description="When returning an interpolated HTML results, matches should have the 'wl-link' class. By default 'no'.")
-    __properties: ClassVar[List[str]] = ["html", "url", "urlClient", "language", "text", "exclude", "scope", "matches", "links"]
-
-    @field_validator('url_client')
-    def url_client_validate_enum(cls, value):
-        """Validates the enum"""
-        if value is None:
-            return value
-
-        if value not in set(['CHROME', 'PLAIN_HTTP', 'CHROME, PLAIN_HTTP']):
-            raise ValueError("must be one of enum values ('CHROME', 'PLAIN_HTTP', 'CHROME, PLAIN_HTTP')")
-        return value
+    completion: Optional[StrictStr] = None
+    has_upvote: StrictBool = Field(description="This indicates whether the user upvoted the completion.")
+    is_accepted: StrictBool = Field(description="This indicates whether the completion is accepted by the user.")
+    validated_at: Optional[datetime] = Field(default=None, description="Validation time of the record - null to revalidate.")
+    __properties: ClassVar[List[str]] = ["completion", "has_upvote", "is_accepted", "validated_at"]
 
     model_config = ConfigDict(
         populate_by_name=True,
@@ -89,9 +73,6 @@ class Request1(BaseModel):
             exclude=excluded_fields,
             exclude_none=True,
         )
-        # override the default output from pydantic by calling `to_dict()` of html
-        if self.html:
-            _dict['html'] = self.html.to_dict()
         return _dict
 
     @classmethod
@@ -104,15 +85,10 @@ class Request1(BaseModel):
             return cls.model_validate(obj)
 
         _obj = cls.model_validate({
-            "html": Html.from_dict(obj["html"]) if obj.get("html") is not None else None,
-            "url": obj.get("url"),
-            "urlClient": obj.get("urlClient"),
-            "language": obj.get("language"),
-            "text": obj.get("text"),
-            "exclude": obj.get("exclude"),
-            "scope": obj.get("scope"),
-            "matches": obj.get("matches"),
-            "links": obj.get("links")
+            "completion": obj.get("completion"),
+            "has_upvote": obj.get("has_upvote"),
+            "is_accepted": obj.get("is_accepted"),
+            "validated_at": obj.get("validated_at")
         })
         return _obj
 

wordlift_client/models/request2.py

@@ -25,12 +25,10 @@ from typing_extensions import Self
 
 class Request2(BaseModel):
     """
-    The Event request
+    Request2
     """ # noqa: E501
-    source: Optional[StrictStr] = None
-    args: Optional[Dict[str, Any]] = None
-    url: Optional[StrictStr] = None
-    __properties: ClassVar[List[str]] = ["source", "args", "url"]
+    redeem_code: Optional[StrictStr] = None
+    __properties: ClassVar[List[str]] = ["redeem_code"]
 
     model_config = ConfigDict(
         populate_by_name=True,
@@ -83,9 +81,7 @@ class Request2(BaseModel):
             return cls.model_validate(obj)
 
         _obj = cls.model_validate({
-            "source": obj.get("source"),
-            "args": obj.get("args"),
-            "url": obj.get("url")
+            "redeem_code": obj.get("redeem_code")
         })
         return _obj
 

wordlift_client/models/request3.py

@@ -18,21 +18,37 @@ import pprint
 import re  # noqa: F401
 import json
 
-from datetime import datetime
-from pydantic import BaseModel, ConfigDict, Field, StrictBool, StrictStr
+from pydantic import BaseModel, ConfigDict, Field, StrictInt, StrictStr, field_validator
 from typing import Any, ClassVar, Dict, List, Optional
+from typing_extensions import Annotated
+from wordlift_client.models.html import Html
 from typing import Optional, Set
 from typing_extensions import Self
 
 class Request3(BaseModel):
     """
-    Request3
+    The request
     """ # noqa: E501
-    completion: Optional[StrictStr] = None
-    has_upvote: StrictBool = Field(description="This indicates whether the user upvoted the completion.")
-    is_accepted: StrictBool = Field(description="This indicates whether the completion is accepted by the user.")
-    validated_at: Optional[datetime] = Field(default=None, description="Validation time of the record - null to revalidate.")
-    __properties: ClassVar[List[str]] = ["completion", "has_upvote", "is_accepted", "validated_at"]
+    html: Optional[Html] = None
+    url: Optional[StrictStr] = Field(default=None, description="The url of the page to analyze.")
+    url_client: Optional[StrictStr] = Field(default=None, description="The client which the analysis should use to extract the content, by default chrome is used.", alias="urlClient")
+    language: Annotated[str, Field(min_length=2, strict=True, max_length=2)] = Field(description="The content language, 2 letters code, e.g. 'en'.")
+    text: Optional[StrictStr] = Field(default=None, description="A textual fragment.")
+    exclude: Optional[List[StrictStr]] = Field(default=None, description="An array of item IDs to exclude from the analysis results.")
+    scope: StrictStr = Field(description="The scope of the analysis, one of 'local', 'network', 'cloud-only', 'network-only' or 'all'.")
+    matches: Optional[StrictInt] = Field(default=None, description="Filter out results that don't have at least the specified number of occurrences. By default 1.")
+    links: Optional[StrictStr] = Field(default=None, description="When returning an interpolated HTML results, matches should have the 'wl-link' class. By default 'no'.")
+    __properties: ClassVar[List[str]] = ["html", "url", "urlClient", "language", "text", "exclude", "scope", "matches", "links"]
+
+    @field_validator('url_client')
+    def url_client_validate_enum(cls, value):
+        """Validates the enum"""
+        if value is None:
+            return value
+
+        if value not in set(['CHROME', 'PLAIN_HTTP', 'CHROME, PLAIN_HTTP']):
+            raise ValueError("must be one of enum values ('CHROME', 'PLAIN_HTTP', 'CHROME, PLAIN_HTTP')")
+        return value
 
     model_config = ConfigDict(
         populate_by_name=True,
@@ -73,6 +89,9 @@ class Request3(BaseModel):
             exclude=excluded_fields,
             exclude_none=True,
         )
+        # override the default output from pydantic by calling `to_dict()` of html
+        if self.html:
+            _dict['html'] = self.html.to_dict()
         return _dict
 
     @classmethod
@@ -85,10 +104,15 @@ class Request3(BaseModel):
             return cls.model_validate(obj)
 
         _obj = cls.model_validate({
-            "completion": obj.get("completion"),
-            "has_upvote": obj.get("has_upvote"),
-            "is_accepted": obj.get("is_accepted"),
-            "validated_at": obj.get("validated_at")
+            "html": Html.from_dict(obj["html"]) if obj.get("html") is not None else None,
+            "url": obj.get("url"),
+            "urlClient": obj.get("urlClient"),
+            "language": obj.get("language"),
+            "text": obj.get("text"),
+            "exclude": obj.get("exclude"),
+            "scope": obj.get("scope"),
+            "matches": obj.get("matches"),
+            "links": obj.get("links")
         })
         return _obj
 

wordlift_client/models/response.py

@@ -18,8 +18,9 @@ import pprint
 import re  # noqa: F401
 import json
 
-from pydantic import BaseModel, ConfigDict, StrictStr
+from pydantic import BaseModel, ConfigDict, Field, StrictStr
 from typing import Any, ClassVar, Dict, List, Optional
+from wordlift_client.models.event import Event
 from typing import Optional, Set
 from typing_extensions import Self
 
@@ -27,8 +28,13 @@ class Response(BaseModel):
     """
     Response
     """ # noqa: E501
-    key: Optional[StrictStr] = None
-    __properties: ClassVar[List[str]] = ["key"]
+    items: Optional[List[Event]] = None
+    var_self: Optional[StrictStr] = Field(default=None, alias="self")
+    next: Optional[StrictStr] = None
+    prev: Optional[StrictStr] = None
+    last: Optional[StrictStr] = None
+    first: Optional[StrictStr] = None
+    __properties: ClassVar[List[str]] = ["items", "self", "next", "prev", "last", "first"]
 
     model_config = ConfigDict(
         populate_by_name=True,
@@ -69,6 +75,13 @@ class Response(BaseModel):
             exclude=excluded_fields,
             exclude_none=True,
         )
+        # override the default output from pydantic by calling `to_dict()` of each item in items (list)
+        _items = []
+        if self.items:
+            for _item in self.items:
+                if _item:
+                    _items.append(_item.to_dict())
+            _dict['items'] = _items
         return _dict
 
     @classmethod
@@ -81,7 +94,12 @@ class Response(BaseModel):
             return cls.model_validate(obj)
 
         _obj = cls.model_validate({
-            "key": obj.get("key")
+            "items": [Event.from_dict(_item) for _item in obj["items"]] if obj.get("items") is not None else None,
+            "self": obj.get("self"),
+            "next": obj.get("next"),
+            "prev": obj.get("prev"),
+            "last": obj.get("last"),
+            "first": obj.get("first")
         })
         return _obj
 

wordlift_client/models/response1.py

@@ -18,26 +18,17 @@ import pprint
 import re  # noqa: F401
 import json
 
-from pydantic import BaseModel, ConfigDict, Field, StrictStr
+from pydantic import BaseModel, ConfigDict, StrictStr
 from typing import Any, ClassVar, Dict, List, Optional
-from wordlift_client.models.annotation import Annotation
-from wordlift_client.models.entity1 import Entity1
-from wordlift_client.models.image import Image
-from wordlift_client.models.topic import Topic
 from typing import Optional, Set
 from typing_extensions import Self
 
 class Response1(BaseModel):
     """
-    Response
+    Response1
     """ # noqa: E501
-    entities: Optional[Dict[str, Entity1]] = Field(default=None, description="A map of entity URI to the respective entity.")
-    annotations: Optional[Dict[str, Annotation]] = Field(default=None, description="A map of annotation id to the respective annotation.")
-    images: Optional[List[Image]] = Field(default=None, description="A list of images.")
-    languages: Optional[List[StrictStr]] = Field(default=None, description="A list of languages.")
-    topics: Optional[List[Topic]] = Field(default=None, description="A list of topics.")
-    content: Optional[StrictStr] = Field(default=None, description="The text supplied for analysis.")
-    __properties: ClassVar[List[str]] = ["entities", "annotations", "images", "languages", "topics", "content"]
+    key: Optional[StrictStr] = None
+    __properties: ClassVar[List[str]] = ["key"]
 
     model_config = ConfigDict(
         populate_by_name=True,
@@ -78,34 +69,6 @@ class Response1(BaseModel):
             exclude=excluded_fields,
             exclude_none=True,
         )
-        # override the default output from pydantic by calling `to_dict()` of each value in entities (dict)
-        _field_dict = {}
-        if self.entities:
-            for _key in self.entities:
-                if self.entities[_key]:
-                    _field_dict[_key] = self.entities[_key].to_dict()
-            _dict['entities'] = _field_dict
-        # override the default output from pydantic by calling `to_dict()` of each value in annotations (dict)
-        _field_dict = {}
-        if self.annotations:
-            for _key in self.annotations:
-                if self.annotations[_key]:
-                    _field_dict[_key] = self.annotations[_key].to_dict()
-            _dict['annotations'] = _field_dict
-        # override the default output from pydantic by calling `to_dict()` of each item in images (list)
-        _items = []
-        if self.images:
-            for _item in self.images:
-                if _item:
-                    _items.append(_item.to_dict())
-            _dict['images'] = _items
-        # override the default output from pydantic by calling `to_dict()` of each item in topics (list)
-        _items = []
-        if self.topics:
-            for _item in self.topics:
-                if _item:
-                    _items.append(_item.to_dict())
-            _dict['topics'] = _items
         return _dict
 
     @classmethod
@@ -118,22 +81,7 @@ class Response1(BaseModel):
             return cls.model_validate(obj)
 
         _obj = cls.model_validate({
-            "entities": dict(
-                (_k, Entity1.from_dict(_v))
-                for _k, _v in obj["entities"].items()
-            )
-            if obj.get("entities") is not None
-            else None,
-            "annotations": dict(
-                (_k, Annotation.from_dict(_v))
-                for _k, _v in obj["annotations"].items()
-            )
-            if obj.get("annotations") is not None
-            else None,
-            "images": [Image.from_dict(_item) for _item in obj["images"]] if obj.get("images") is not None else None,
-            "languages": obj.get("languages"),
-            "topics": [Topic.from_dict(_item) for _item in obj["topics"]] if obj.get("topics") is not None else None,
-            "content": obj.get("content")
+            "key": obj.get("key")
         })
         return _obj