onfido-python 3.4.0__py3-none-any.whl → 4.0.0__py3-none-any.whl

onfido/models/watchlist_enhanced_properties_records_inner_attribute_inner.py

@@ -0,0 +1,102 @@
+# coding: utf-8
+
+"""
+    Onfido API v3.6
+
+    The Onfido API (v3.6)
+
+    The version of the OpenAPI document: v3.6
+    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, StrictStr
+from typing import Any, ClassVar, Dict, List, Optional
+from typing import Optional, Set
+from typing_extensions import Self
+
+class WatchlistEnhancedPropertiesRecordsInnerAttributeInner(BaseModel):
+    """
+    WatchlistEnhancedPropertiesRecordsInnerAttributeInner
+    """ # noqa: E501
+    attribute_type: Optional[StrictStr] = None
+    attribute_value: Optional[StrictStr] = None
+    additional_properties: Dict[str, Any] = {}
+    __properties: ClassVar[List[str]] = ["attribute_type", "attribute_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 WatchlistEnhancedPropertiesRecordsInnerAttributeInner 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.
+        * Fields in `self.additional_properties` are added to the output dict.
+        """
+        excluded_fields: Set[str] = set([
+            "additional_properties",
+        ])
+
+        _dict = self.model_dump(
+            by_alias=True,
+            exclude=excluded_fields,
+            exclude_none=True,
+        )
+        # puts key-value pairs in additional_properties in the top level
+        if self.additional_properties is not None:
+            for _key, _value in self.additional_properties.items():
+                _dict[_key] = _value
+
+        return _dict
+
+    @classmethod
+    def from_dict(cls, obj: Optional[Dict[str, Any]]) -> Optional[Self]:
+        """Create an instance of WatchlistEnhancedPropertiesRecordsInnerAttributeInner from a dict"""
+        if obj is None:
+            return None
+
+        if not isinstance(obj, dict):
+            return cls.model_validate(obj)
+
+        _obj = cls.model_validate({
+            "attribute_type": obj.get("attribute_type"),
+            "attribute_value": obj.get("attribute_value")
+        })
+        # store additional fields in additional_properties
+        for _key in obj.keys():
+            if _key not in cls.__properties:
+                _obj.additional_properties[_key] = obj.get(_key)
+
+        return _obj
+
+

onfido/models/watchlist_enhanced_properties_records_inner_event_inner.py

@@ -0,0 +1,113 @@
+# coding: utf-8
+
+"""
+    Onfido API v3.6
+
+    The Onfido API (v3.6)
+
+    The version of the OpenAPI document: v3.6
+    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 date
+from pydantic import BaseModel, ConfigDict, StrictStr
+from typing import Any, ClassVar, Dict, List, Optional
+from onfido.models.watchlist_enhanced_properties_records_inner_event_inner_source import WatchlistEnhancedPropertiesRecordsInnerEventInnerSource
+from typing import Optional, Set
+from typing_extensions import Self
+
+class WatchlistEnhancedPropertiesRecordsInnerEventInner(BaseModel):
+    """
+    WatchlistEnhancedPropertiesRecordsInnerEventInner
+    """ # noqa: E501
+    category: Optional[StrictStr] = None
+    event_date: Optional[date] = None
+    event_description: Optional[StrictStr] = None
+    source: Optional[WatchlistEnhancedPropertiesRecordsInnerEventInnerSource] = None
+    sub_category: Optional[StrictStr] = None
+    additional_properties: Dict[str, Any] = {}
+    __properties: ClassVar[List[str]] = ["category", "event_date", "event_description", "source", "sub_category"]
+
+    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 WatchlistEnhancedPropertiesRecordsInnerEventInner 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.
+        * Fields in `self.additional_properties` are added to the output dict.
+        """
+        excluded_fields: Set[str] = set([
+            "additional_properties",
+        ])
+
+        _dict = self.model_dump(
+            by_alias=True,
+            exclude=excluded_fields,
+            exclude_none=True,
+        )
+        # override the default output from pydantic by calling `to_dict()` of source
+        if self.source:
+            _dict['source'] = self.source.to_dict()
+        # puts key-value pairs in additional_properties in the top level
+        if self.additional_properties is not None:
+            for _key, _value in self.additional_properties.items():
+                _dict[_key] = _value
+
+        return _dict
+
+    @classmethod
+    def from_dict(cls, obj: Optional[Dict[str, Any]]) -> Optional[Self]:
+        """Create an instance of WatchlistEnhancedPropertiesRecordsInnerEventInner from a dict"""
+        if obj is None:
+            return None
+
+        if not isinstance(obj, dict):
+            return cls.model_validate(obj)
+
+        _obj = cls.model_validate({
+            "category": obj.get("category"),
+            "event_date": obj.get("event_date"),
+            "event_description": obj.get("event_description"),
+            "source": WatchlistEnhancedPropertiesRecordsInnerEventInnerSource.from_dict(obj["source"]) if obj.get("source") is not None else None,
+            "sub_category": obj.get("sub_category")
+        })
+        # store additional fields in additional_properties
+        for _key in obj.keys():
+            if _key not in cls.__properties:
+                _obj.additional_properties[_key] = obj.get(_key)
+
+        return _obj
+
+

onfido/models/watchlist_enhanced_properties_records_inner_event_inner_source.py

@@ -0,0 +1,107 @@
+# coding: utf-8
+
+"""
+    Onfido API v3.6
+
+    The Onfido API (v3.6)
+
+    The version of the OpenAPI document: v3.6
+    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 date
+from pydantic import BaseModel, ConfigDict, StrictStr
+from typing import Any, ClassVar, Dict, List, Optional
+from typing import Optional, Set
+from typing_extensions import Self
+
+class WatchlistEnhancedPropertiesRecordsInnerEventInnerSource(BaseModel):
+    """
+    WatchlistEnhancedPropertiesRecordsInnerEventInnerSource
+    """ # noqa: E501
+    source_date: Optional[date] = None
+    source_format: Optional[StrictStr] = None
+    source_name: Optional[StrictStr] = None
+    source_url: Optional[StrictStr] = None
+    additional_properties: Dict[str, Any] = {}
+    __properties: ClassVar[List[str]] = ["source_date", "source_format", "source_name", "source_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 WatchlistEnhancedPropertiesRecordsInnerEventInnerSource 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.
+        * Fields in `self.additional_properties` are added to the output dict.
+        """
+        excluded_fields: Set[str] = set([
+            "additional_properties",
+        ])
+
+        _dict = self.model_dump(
+            by_alias=True,
+            exclude=excluded_fields,
+            exclude_none=True,
+        )
+        # puts key-value pairs in additional_properties in the top level
+        if self.additional_properties is not None:
+            for _key, _value in self.additional_properties.items():
+                _dict[_key] = _value
+
+        return _dict
+
+    @classmethod
+    def from_dict(cls, obj: Optional[Dict[str, Any]]) -> Optional[Self]:
+        """Create an instance of WatchlistEnhancedPropertiesRecordsInnerEventInnerSource from a dict"""
+        if obj is None:
+            return None
+
+        if not isinstance(obj, dict):
+            return cls.model_validate(obj)
+
+        _obj = cls.model_validate({
+            "source_date": obj.get("source_date"),
+            "source_format": obj.get("source_format"),
+            "source_name": obj.get("source_name"),
+            "source_url": obj.get("source_url")
+        })
+        # store additional fields in additional_properties
+        for _key in obj.keys():
+            if _key not in cls.__properties:
+                _obj.additional_properties[_key] = obj.get(_key)
+
+        return _obj
+
+

onfido/models/watchlist_enhanced_properties_records_inner_source_inner.py

@@ -0,0 +1,106 @@
+# coding: utf-8
+
+"""
+    Onfido API v3.6
+
+    The Onfido API (v3.6)
+
+    The version of the OpenAPI document: v3.6
+    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, StrictStr
+from typing import Any, ClassVar, Dict, List, Optional
+from typing import Optional, Set
+from typing_extensions import Self
+
+class WatchlistEnhancedPropertiesRecordsInnerSourceInner(BaseModel):
+    """
+    WatchlistEnhancedPropertiesRecordsInnerSourceInner
+    """ # noqa: E501
+    source_headline: Optional[StrictStr] = None
+    source_name: Optional[StrictStr] = None
+    source_url: Optional[StrictStr] = None
+    source_format: Optional[StrictStr] = None
+    additional_properties: Dict[str, Any] = {}
+    __properties: ClassVar[List[str]] = ["source_headline", "source_name", "source_url", "source_format"]
+
+    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 WatchlistEnhancedPropertiesRecordsInnerSourceInner 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.
+        * Fields in `self.additional_properties` are added to the output dict.
+        """
+        excluded_fields: Set[str] = set([
+            "additional_properties",
+        ])
+
+        _dict = self.model_dump(
+            by_alias=True,
+            exclude=excluded_fields,
+            exclude_none=True,
+        )
+        # puts key-value pairs in additional_properties in the top level
+        if self.additional_properties is not None:
+            for _key, _value in self.additional_properties.items():
+                _dict[_key] = _value
+
+        return _dict
+
+    @classmethod
+    def from_dict(cls, obj: Optional[Dict[str, Any]]) -> Optional[Self]:
+        """Create an instance of WatchlistEnhancedPropertiesRecordsInnerSourceInner from a dict"""
+        if obj is None:
+            return None
+
+        if not isinstance(obj, dict):
+            return cls.model_validate(obj)
+
+        _obj = cls.model_validate({
+            "source_headline": obj.get("source_headline"),
+            "source_name": obj.get("source_name"),
+            "source_url": obj.get("source_url"),
+            "source_format": obj.get("source_format")
+        })
+        # store additional fields in additional_properties
+        for _key in obj.keys():
+            if _key not in cls.__properties:
+                _obj.additional_properties[_key] = obj.get(_key)
+
+        return _obj
+
+

onfido/models/watchlist_enhanced_report.py

@@ -92,9 +92,9 @@ class WatchlistEnhancedReport(BaseModel):
         # override the default output from pydantic by calling `to_dict()` of each item in documents (list)
         _items = []
         if self.documents:
-            for _item in self.documents:
-                if _item:
-                    _items.append(_item.to_dict())
+            for _item_documents in self.documents:
+                if _item_documents:
+                    _items.append(_item_documents.to_dict())
             _dict['documents'] = _items
         # override the default output from pydantic by calling `to_dict()` of breakdown
         if self.breakdown:

onfido/models/watchlist_monitor_matches_list.py

@@ -75,9 +75,9 @@ class WatchlistMonitorMatchesList(BaseModel):
         # override the default output from pydantic by calling `to_dict()` of each item in matches (list)
         _items = []
         if self.matches:
-            for _item in self.matches:
-                if _item:
-                    _items.append(_item.to_dict())
+            for _item_matches in self.matches:
+                if _item_matches:
+                    _items.append(_item_matches.to_dict())
             _dict['matches'] = _items
         # puts key-value pairs in additional_properties in the top level
         if self.additional_properties is not None:

onfido/models/watchlist_monitors_list.py

@@ -75,9 +75,9 @@ class WatchlistMonitorsList(BaseModel):
         # override the default output from pydantic by calling `to_dict()` of each item in monitors (list)
         _items = []
         if self.monitors:
-            for _item in self.monitors:
-                if _item:
-                    _items.append(_item.to_dict())
+            for _item_monitors in self.monitors:
+                if _item_monitors:
+                    _items.append(_item_monitors.to_dict())
             _dict['monitors'] = _items
         # puts key-value pairs in additional_properties in the top level
         if self.additional_properties is not None:

onfido/models/watchlist_peps_only_report.py

@@ -92,9 +92,9 @@ class WatchlistPepsOnlyReport(BaseModel):
         # override the default output from pydantic by calling `to_dict()` of each item in documents (list)
         _items = []
         if self.documents:
-            for _item in self.documents:
-                if _item:
-                    _items.append(_item.to_dict())
+            for _item_documents in self.documents:
+                if _item_documents:
+                    _items.append(_item_documents.to_dict())
             _dict['documents'] = _items
         # override the default output from pydantic by calling `to_dict()` of breakdown
         if self.breakdown:

onfido/models/watchlist_sanctions_only_report.py

@@ -92,9 +92,9 @@ class WatchlistSanctionsOnlyReport(BaseModel):
         # override the default output from pydantic by calling `to_dict()` of each item in documents (list)
         _items = []
         if self.documents:
-            for _item in self.documents:
-                if _item:
-                    _items.append(_item.to_dict())
+            for _item_documents in self.documents:
+                if _item_documents:
+                    _items.append(_item_documents.to_dict())
             _dict['documents'] = _items
         # override the default output from pydantic by calling `to_dict()` of breakdown
         if self.breakdown:

onfido/models/watchlist_standard_report.py

@@ -92,9 +92,9 @@ class WatchlistStandardReport(BaseModel):
         # override the default output from pydantic by calling `to_dict()` of each item in documents (list)
         _items = []
         if self.documents:
-            for _item in self.documents:
-                if _item:
-                    _items.append(_item.to_dict())
+            for _item_documents in self.documents:
+                if _item_documents:
+                    _items.append(_item_documents.to_dict())
             _dict['documents'] = _items
         # override the default output from pydantic by calling `to_dict()` of breakdown
         if self.breakdown:

onfido/models/webhook_event_object_status.py

@@ -0,0 +1,54 @@
+# coding: utf-8
+
+"""
+    Onfido API v3.6
+
+    The Onfido API (v3.6)
+
+    The version of the OpenAPI document: v3.6
+    Generated by OpenAPI Generator (https://openapi-generator.tech)
+
+    Do not edit the class manually.
+"""  # noqa: E501
+
+
+from __future__ import annotations
+import json
+from enum import Enum
+from typing_extensions import Self
+
+
+class WebhookEventObjectStatus(str, Enum):
+    """
+    The current state of the object, if available.
+    """
+
+    """
+    allowed enum values
+    """
+    PROCESSING = 'processing'
+    AWAITING_INPUT = 'awaiting_input'
+    AWAITING_CLIENT_INPUT = 'awaiting_client_input'
+    APPROVED = 'approved'
+    DECLINED = 'declined'
+    REVIEW = 'review'
+    ABANDONED = 'abandoned'
+    ERROR = 'error'
+    STARTED = 'started'
+    CANCELLED = 'cancelled'
+    COMPLETED = 'completed'
+    AWAITING_DATA = 'awaiting_data'
+    AWAITING_APPROVAL = 'awaiting_approval'
+    COMPLETE = 'complete'
+    WITHDRAWN = 'withdrawn'
+    IN_PROGRESS = 'in_progress'
+    AWAITING_APPLICANT = 'awaiting_applicant'
+    PAUSED = 'paused'
+    REOPENED = 'reopened'
+
+    @classmethod
+    def from_json(cls, json_str: str) -> Self:
+        """Create an instance of WebhookEventObjectStatus from a JSON string"""
+        return cls(json.loads(json_str))
+
+

onfido/models/webhook_event_payload.py

@@ -17,9 +17,11 @@ import pprint
 import re  # noqa: F401
 import json
 
-from pydantic import BaseModel, ConfigDict, Field, StrictStr
+from pydantic import BaseModel, ConfigDict, Field
 from typing import Any, ClassVar, Dict, List, Optional
 from onfido.models.webhook_event_payload_object import WebhookEventPayloadObject
+from onfido.models.webhook_event_payload_resource import WebhookEventPayloadResource
+from onfido.models.webhook_event_resource_type import WebhookEventResourceType
 from onfido.models.webhook_event_type import WebhookEventType
 from typing import Optional, Set
 from typing_extensions import Self
@@ -28,10 +30,10 @@ class WebhookEventPayload(BaseModel):
     """
     WebhookEventPayload
     """ # noqa: E501
-    resource_type: StrictStr = Field(description="Indicates the resource affected by this event.")
+    resource_type: WebhookEventResourceType = Field(description="Indicates the resource affected by this event.")
     action: Optional[WebhookEventType] = Field(default=None, description="The event that triggered this webhook.")
     object: Optional[WebhookEventPayloadObject] = None
-    resource: Optional[Dict[str, Any]] = Field(default=None, description="The resource affected by this event.")
+    resource: Optional[WebhookEventPayloadResource] = None
     additional_properties: Dict[str, Any] = {}
     __properties: ClassVar[List[str]] = ["resource_type", "action", "object", "resource"]
 
@@ -79,6 +81,9 @@ class WebhookEventPayload(BaseModel):
         # override the default output from pydantic by calling `to_dict()` of object
         if self.object:
             _dict['object'] = self.object.to_dict()
+        # override the default output from pydantic by calling `to_dict()` of resource
+        if self.resource:
+            _dict['resource'] = self.resource.to_dict()
         # puts key-value pairs in additional_properties in the top level
         if self.additional_properties is not None:
             for _key, _value in self.additional_properties.items():
@@ -99,7 +104,7 @@ class WebhookEventPayload(BaseModel):
             "resource_type": obj.get("resource_type"),
             "action": obj.get("action"),
             "object": WebhookEventPayloadObject.from_dict(obj["object"]) if obj.get("object") is not None else None,
-            "resource": obj.get("resource")
+            "resource": WebhookEventPayloadResource.from_dict(obj["resource"]) if obj.get("resource") is not None else None
         })
         # store additional fields in additional_properties
         for _key in obj.keys():

onfido/models/webhook_event_payload_object.py

@@ -20,6 +20,7 @@ import json
 from datetime import datetime
 from pydantic import BaseModel, ConfigDict, Field, StrictStr
 from typing import Any, ClassVar, Dict, List, Optional
+from onfido.models.webhook_event_object_status import WebhookEventObjectStatus
 from typing import Optional, Set
 from typing_extensions import Self
 
@@ -28,7 +29,7 @@ class WebhookEventPayloadObject(BaseModel):
     The object affected by this event.
     """ # noqa: E501
     id: StrictStr = Field(description="The unique identifier of the resource.")
-    status: Optional[StrictStr] = Field(default=None, description="The current state of the object, if available.")
+    status: Optional[WebhookEventObjectStatus] = None
     started_at_iso8601: Optional[datetime] = Field(default=None, description="The date and time when the operation was started, if available.")
     completed_at_iso8601: Optional[datetime] = Field(default=None, description="The date and time when the operation was completed, if available.")
     href: StrictStr = Field(description="The uri of the resource.")