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

onfido/models/workflow_run.py

@@ -18,11 +18,12 @@ import re  # noqa: F401
 import json
 
 from datetime import datetime
-from pydantic import BaseModel, ConfigDict, Field, StrictInt, StrictStr, field_validator
+from pydantic import BaseModel, ConfigDict, Field, StrictInt, StrictStr
 from typing import Any, ClassVar, Dict, List, Optional
 from typing_extensions import Annotated
-from onfido.models.workflow_run_response_error import WorkflowRunResponseError
-from onfido.models.workflow_run_shared_link import WorkflowRunSharedLink
+from onfido.models.workflow_run_error import WorkflowRunError
+from onfido.models.workflow_run_link import WorkflowRunLink
+from onfido.models.workflow_run_status import WorkflowRunStatus
 from typing import Optional, Set
 from typing_extensions import Self
 
@@ -34,30 +35,20 @@ class WorkflowRun(BaseModel):
     workflow_id: StrictStr = Field(description="The unique identifier for the Workflow.")
     tags: Optional[Annotated[List[Annotated[str, Field(min_length=1, strict=True, max_length=128)]], Field(max_length=30)]] = Field(default=None, description="Tags or labels assigned to the workflow run.")
     customer_user_id: Optional[Annotated[str, Field(strict=True, max_length=256)]] = Field(default=None, description="Customer-provided user identifier.")
-    link: Optional[WorkflowRunSharedLink] = None
+    link: Optional[WorkflowRunLink] = Field(default=None, description="Object for the configuration of the Workflow Run link.")
     created_at: Optional[datetime] = Field(default=None, description="The date and time when the Workflow Run was created.")
     updated_at: Optional[datetime] = Field(default=None, description="The date and time when the Workflow Run was last updated.")
     id: StrictStr = Field(description="The unique identifier for the Workflow Run.")
     workflow_version_id: Optional[StrictInt] = Field(default=None, description="The identifier for the Workflow version.")
     dashboard_url: Optional[StrictStr] = Field(default=None, description="The URL for viewing the Workflow Run results on your Onfido Dashboard.")
-    status: Optional[StrictStr] = Field(default=None, description="The status of the Workflow Run.")
+    status: Optional[WorkflowRunStatus] = Field(default=None, description="The status of the Workflow Run.")
     output: Optional[Dict[str, Any]] = Field(default=None, description="Output object contains all of the properties configured on the Workflow version.")
     reasons: Optional[List[StrictStr]] = Field(default=None, description="The reasons the Workflow Run outcome was reached. Configurable when creating the Workflow version.")
-    error: Optional[WorkflowRunResponseError] = None
+    error: Optional[WorkflowRunError] = Field(default=None, description="Error object. Only set when the Workflow Run status is 'error'.")
     sdk_token: Optional[StrictStr] = Field(default=None, description="Client token to use when loading this workflow run in the Onfido SDK.")
     additional_properties: Dict[str, Any] = {}
     __properties: ClassVar[List[str]] = ["applicant_id", "workflow_id", "tags", "customer_user_id", "link", "created_at", "updated_at", "id", "workflow_version_id", "dashboard_url", "status", "output", "reasons", "error", "sdk_token"]
 
-    @field_validator('status')
-    def status_validate_enum(cls, value):
-        """Validates the enum"""
-        if value is None:
-            return value
-
-        if value not in set(['awaiting_input', 'processing', 'abandoned', 'error', 'approved', 'review', 'declined']):
-            raise ValueError("must be one of enum values ('awaiting_input', 'processing', 'abandoned', 'error', 'approved', 'review', 'declined')")
-        return value
-
     model_config = ConfigDict(
         populate_by_name=True,
         validate_assignment=True,
@@ -136,7 +127,7 @@ class WorkflowRun(BaseModel):
             "workflow_id": obj.get("workflow_id"),
             "tags": obj.get("tags"),
             "customer_user_id": obj.get("customer_user_id"),
-            "link": WorkflowRunSharedLink.from_dict(obj["link"]) if obj.get("link") is not None else None,
+            "link": WorkflowRunLink.from_dict(obj["link"]) if obj.get("link") is not None else None,
             "created_at": obj.get("created_at"),
             "updated_at": obj.get("updated_at"),
             "id": obj.get("id"),
@@ -145,7 +136,7 @@ class WorkflowRun(BaseModel):
             "status": obj.get("status"),
             "output": obj.get("output"),
             "reasons": obj.get("reasons"),
-            "error": WorkflowRunResponseError.from_dict(obj["error"]) if obj.get("error") is not None else None,
+            "error": WorkflowRunError.from_dict(obj["error"]) if obj.get("error") is not None else None,
             "sdk_token": obj.get("sdk_token")
         })
         # store additional fields in additional_properties

onfido/models/workflow_run_builder.py

@@ -21,7 +21,7 @@ from datetime import datetime
 from pydantic import BaseModel, ConfigDict, Field, StrictStr
 from typing import Any, ClassVar, Dict, List, Optional
 from typing_extensions import Annotated
-from onfido.models.workflow_run_shared_link import WorkflowRunSharedLink
+from onfido.models.workflow_run_link import WorkflowRunLink
 from typing import Optional, Set
 from typing_extensions import Self
 
@@ -33,7 +33,7 @@ class WorkflowRunBuilder(BaseModel):
     workflow_id: StrictStr = Field(description="The unique identifier for the Workflow.")
     tags: Optional[Annotated[List[Annotated[str, Field(min_length=1, strict=True, max_length=128)]], Field(max_length=30)]] = Field(default=None, description="Tags or labels assigned to the workflow run.")
     customer_user_id: Optional[Annotated[str, Field(strict=True, max_length=256)]] = Field(default=None, description="Customer-provided user identifier.")
-    link: Optional[WorkflowRunSharedLink] = None
+    link: Optional[WorkflowRunLink] = Field(default=None, description="Object for the configuration of the Workflow Run link.")
     created_at: Optional[datetime] = Field(default=None, description="The date and time when the Workflow Run was created.")
     updated_at: Optional[datetime] = Field(default=None, description="The date and time when the Workflow Run was last updated.")
     custom_data: Optional[Dict[str, Any]] = Field(default=None, description="Object with Custom Input Data to be used in the Workflow Run.")
@@ -110,7 +110,7 @@ class WorkflowRunBuilder(BaseModel):
             "workflow_id": obj.get("workflow_id"),
             "tags": obj.get("tags"),
             "customer_user_id": obj.get("customer_user_id"),
-            "link": WorkflowRunSharedLink.from_dict(obj["link"]) if obj.get("link") is not None else None,
+            "link": WorkflowRunLink.from_dict(obj["link"]) if obj.get("link") is not None else None,
             "created_at": obj.get("created_at"),
             "updated_at": obj.get("updated_at"),
             "custom_data": obj.get("custom_data")

onfido/models/{workflow_run_response_error.py → workflow_run_error.py}

@@ -22,9 +22,9 @@ from typing import Any, ClassVar, Dict, List, Optional
 from typing import Optional, Set
 from typing_extensions import Self
 
-class WorkflowRunResponseError(BaseModel):
+class WorkflowRunError(BaseModel):
     """
-    Error object. Only set when the Workflow Run status is 'error'.
+    WorkflowRunError
     """ # noqa: E501
     type: Optional[StrictStr] = Field(default=None, description="The type of error.")
     message: Optional[StrictStr] = Field(default=None, description="A textual description of the error.")
@@ -49,7 +49,7 @@ class WorkflowRunResponseError(BaseModel):
 
     @classmethod
     def from_json(cls, json_str: str) -> Optional[Self]:
-        """Create an instance of WorkflowRunResponseError from a JSON string"""
+        """Create an instance of WorkflowRunError from a JSON string"""
         return cls.from_dict(json.loads(json_str))
 
     def to_dict(self) -> Dict[str, Any]:
@@ -81,7 +81,7 @@ class WorkflowRunResponseError(BaseModel):
 
     @classmethod
     def from_dict(cls, obj: Optional[Dict[str, Any]]) -> Optional[Self]:
-        """Create an instance of WorkflowRunResponseError from a dict"""
+        """Create an instance of WorkflowRunError from a dict"""
         if obj is None:
             return None
 

onfido/models/{workflow_run_shared_link.py → workflow_run_link.py}

@@ -23,9 +23,9 @@ from typing import Any, ClassVar, Dict, List, Optional
 from typing import Optional, Set
 from typing_extensions import Self
 
-class WorkflowRunSharedLink(BaseModel):
+class WorkflowRunLink(BaseModel):
     """
-    Object for the configuration of the Workflow Run link.
+    WorkflowRunLink
     """ # noqa: E501
     url: Optional[StrictStr] = Field(default=None, description="Link to access the Workflow Run without the need to integrate with Onfido's SDKs.")
     completed_redirect_url: Optional[StrictStr] = Field(default=None, description="When the interactive section of the Workflow Run has completed successfully, the user will be redirected to this URL instead of seeing the default Onfido 'thank you' page.")
@@ -63,7 +63,7 @@ class WorkflowRunSharedLink(BaseModel):
 
     @classmethod
     def from_json(cls, json_str: str) -> Optional[Self]:
-        """Create an instance of WorkflowRunSharedLink from a JSON string"""
+        """Create an instance of WorkflowRunLink from a JSON string"""
         return cls.from_dict(json.loads(json_str))
 
     def to_dict(self) -> Dict[str, Any]:
@@ -91,11 +91,31 @@ class WorkflowRunSharedLink(BaseModel):
             for _key, _value in self.additional_properties.items():
                 _dict[_key] = _value
 
+        # set to None if completed_redirect_url (nullable) is None
+        # and model_fields_set contains the field
+        if self.completed_redirect_url is None and "completed_redirect_url" in self.model_fields_set:
+            _dict['completed_redirect_url'] = None
+
+        # set to None if expired_redirect_url (nullable) is None
+        # and model_fields_set contains the field
+        if self.expired_redirect_url is None and "expired_redirect_url" in self.model_fields_set:
+            _dict['expired_redirect_url'] = None
+
+        # set to None if expires_at (nullable) is None
+        # and model_fields_set contains the field
+        if self.expires_at is None and "expires_at" in self.model_fields_set:
+            _dict['expires_at'] = None
+
+        # set to None if language (nullable) is None
+        # and model_fields_set contains the field
+        if self.language is None and "language" in self.model_fields_set:
+            _dict['language'] = None
+
         return _dict
 
     @classmethod
     def from_dict(cls, obj: Optional[Dict[str, Any]]) -> Optional[Self]:
-        """Create an instance of WorkflowRunSharedLink from a dict"""
+        """Create an instance of WorkflowRunLink from a dict"""
         if obj is None:
             return None
 

onfido/models/workflow_run_response.py

@@ -17,9 +17,10 @@ import pprint
 import re  # noqa: F401
 import json
 
-from pydantic import BaseModel, ConfigDict, Field, StrictInt, StrictStr, field_validator
+from pydantic import BaseModel, ConfigDict, Field, StrictInt, StrictStr
 from typing import Any, ClassVar, Dict, List, Optional
-from onfido.models.workflow_run_response_error import WorkflowRunResponseError
+from onfido.models.workflow_run_error import WorkflowRunError
+from onfido.models.workflow_run_status import WorkflowRunStatus
 from typing import Optional, Set
 from typing_extensions import Self
 
@@ -30,24 +31,14 @@ class WorkflowRunResponse(BaseModel):
     id: StrictStr = Field(description="The unique identifier for the Workflow Run.")
     workflow_version_id: Optional[StrictInt] = Field(default=None, description="The identifier for the Workflow version.")
     dashboard_url: Optional[StrictStr] = Field(default=None, description="The URL for viewing the Workflow Run results on your Onfido Dashboard.")
-    status: Optional[StrictStr] = Field(default=None, description="The status of the Workflow Run.")
+    status: Optional[WorkflowRunStatus] = Field(default=None, description="The status of the Workflow Run.")
     output: Optional[Dict[str, Any]] = Field(default=None, description="Output object contains all of the properties configured on the Workflow version.")
     reasons: Optional[List[StrictStr]] = Field(default=None, description="The reasons the Workflow Run outcome was reached. Configurable when creating the Workflow version.")
-    error: Optional[WorkflowRunResponseError] = None
+    error: Optional[WorkflowRunError] = Field(default=None, description="Error object. Only set when the Workflow Run status is 'error'.")
     sdk_token: Optional[StrictStr] = Field(default=None, description="Client token to use when loading this workflow run in the Onfido SDK.")
     additional_properties: Dict[str, Any] = {}
     __properties: ClassVar[List[str]] = ["id", "workflow_version_id", "dashboard_url", "status", "output", "reasons", "error", "sdk_token"]
 
-    @field_validator('status')
-    def status_validate_enum(cls, value):
-        """Validates the enum"""
-        if value is None:
-            return value
-
-        if value not in set(['awaiting_input', 'processing', 'abandoned', 'error', 'approved', 'review', 'declined']):
-            raise ValueError("must be one of enum values ('awaiting_input', 'processing', 'abandoned', 'error', 'approved', 'review', 'declined')")
-        return value
-
     model_config = ConfigDict(
         populate_by_name=True,
         validate_assignment=True,
@@ -120,7 +111,7 @@ class WorkflowRunResponse(BaseModel):
             "status": obj.get("status"),
             "output": obj.get("output"),
             "reasons": obj.get("reasons"),
-            "error": WorkflowRunResponseError.from_dict(obj["error"]) if obj.get("error") is not None else None,
+            "error": WorkflowRunError.from_dict(obj["error"]) if obj.get("error") is not None else None,
             "sdk_token": obj.get("sdk_token")
         })
         # store additional fields in additional_properties

onfido/models/workflow_run_shared.py

@@ -21,7 +21,7 @@ from datetime import datetime
 from pydantic import BaseModel, ConfigDict, Field, StrictStr
 from typing import Any, ClassVar, Dict, List, Optional
 from typing_extensions import Annotated
-from onfido.models.workflow_run_shared_link import WorkflowRunSharedLink
+from onfido.models.workflow_run_link import WorkflowRunLink
 from typing import Optional, Set
 from typing_extensions import Self
 
@@ -33,7 +33,7 @@ class WorkflowRunShared(BaseModel):
     workflow_id: StrictStr = Field(description="The unique identifier for the Workflow.")
     tags: Optional[Annotated[List[Annotated[str, Field(min_length=1, strict=True, max_length=128)]], Field(max_length=30)]] = Field(default=None, description="Tags or labels assigned to the workflow run.")
     customer_user_id: Optional[Annotated[str, Field(strict=True, max_length=256)]] = Field(default=None, description="Customer-provided user identifier.")
-    link: Optional[WorkflowRunSharedLink] = None
+    link: Optional[WorkflowRunLink] = Field(default=None, description="Object for the configuration of the Workflow Run link.")
     created_at: Optional[datetime] = Field(default=None, description="The date and time when the Workflow Run was created.")
     updated_at: Optional[datetime] = Field(default=None, description="The date and time when the Workflow Run was last updated.")
     additional_properties: Dict[str, Any] = {}
@@ -109,7 +109,7 @@ class WorkflowRunShared(BaseModel):
             "workflow_id": obj.get("workflow_id"),
             "tags": obj.get("tags"),
             "customer_user_id": obj.get("customer_user_id"),
-            "link": WorkflowRunSharedLink.from_dict(obj["link"]) if obj.get("link") is not None else None,
+            "link": WorkflowRunLink.from_dict(obj["link"]) if obj.get("link") is not None else None,
             "created_at": obj.get("created_at"),
             "updated_at": obj.get("updated_at")
         })

onfido/models/workflow_run_status.py

@@ -0,0 +1,43 @@
+# 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 WorkflowRunStatus(str, Enum):
+    """
+    WorkflowRunStatus
+    """
+
+    """
+    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'
+
+    @classmethod
+    def from_json(cls, json_str: str) -> Self:
+        """Create an instance of WorkflowRunStatus from a JSON string"""
+        return cls(json.loads(json_str))
+
+

onfido/rest.py

@@ -226,7 +226,7 @@ class RESTClientObject:
                         headers=headers,
                         preload_content=False
                     )
-                elif headers['Content-Type'] == 'text/plain' and isinstance(body, bool):
+                elif headers['Content-Type'].startswith('text/') and isinstance(body, bool):
                     request_body = "true" if body else "false"
                     r = self.pool_manager.request(
                         method,

{onfido_python-3.5.0.dist-info → onfido_python-4.0.0.dist-info}/METADATA

@@ -1,6 +1,6 @@
 Metadata-Version: 2.1
 Name: onfido-python
-Version: 3.5.0
+Version: 4.0.0
 Summary: Python library for the Onfido API
 Home-page: 
 Author: OpenAPI Generator community
@@ -9,8 +9,8 @@ License: MIT
 Keywords: OpenAPI,OpenAPI-Generator,onfido,identity
 Description-Content-Type: text/markdown
 License-File: LICENSE
-Requires-Dist: urllib3 <2.1.0,>=1.25.3
-Requires-Dist: python-dateutil
+Requires-Dist: urllib3 <3.0.0,>=1.25.3
+Requires-Dist: python-dateutil >=2.8.2
 Requires-Dist: pydantic >=2
 Requires-Dist: typing-extensions >=4.7.1