onfido-python 3.2.0__tar.gz → 3.4.0__tar.gz

{onfido_python-3.2.0/onfido_python.egg-info → onfido_python-3.4.0}/PKG-INFO

@@ -1,6 +1,6 @@
 Metadata-Version: 2.1
 Name: onfido-python
-Version: 3.2.0
+Version: 3.4.0
 Summary: Python library for the Onfido API
 Home-page: 
 Author: OpenAPI Generator community

{onfido_python-3.2.0 → onfido_python-3.4.0}/onfido/__init__.py

@@ -14,7 +14,7 @@
 """  # noqa: E501
 
 
-__version__ = "3.2.0"
+__version__ = "3.4.0"
 
 # import apis into sdk package
 from onfido.api.default_api import DefaultApi

{onfido_python-3.2.0 → onfido_python-3.4.0}/onfido/api/default_api.py

@@ -5359,6 +5359,287 @@ class DefaultApi:
 
 
 
+    @validate_call
+    def download_qes_document(
+        self,
+        workflow_run_id: Annotated[StrictStr, Field(description="The unique identifier of the Workflow Run for which you want to retrieve the signed document.")],
+        file_id: Annotated[StrictStr, Field(description="The unique identifier of the file which you want to retrieve.")],
+        _request_timeout: Union[
+            None,
+            Annotated[StrictFloat, Field(gt=0)],
+            Tuple[
+                Annotated[StrictFloat, Field(gt=0)],
+                Annotated[StrictFloat, Field(gt=0)]
+            ]
+        ] = None,
+        _request_auth: Optional[Dict[StrictStr, Any]] = None,
+        _content_type: Optional[StrictStr] = None,
+        _headers: Optional[Dict[StrictStr, Any]] = None,
+        _host_index: Annotated[StrictInt, Field(ge=0, le=0)] = 0,
+    ) -> bytearray:
+        """Retrieves the signed document or application form
+
+        Retrieves the signed document or application form depending on the file_id provided. 
+
+        :param workflow_run_id: The unique identifier of the Workflow Run for which you want to retrieve the signed document. (required)
+        :type workflow_run_id: str
+        :param file_id: The unique identifier of the file which you want to retrieve. (required)
+        :type file_id: str
+        :param _request_timeout: timeout setting for this request. If one
+                                 number provided, it will be total request
+                                 timeout. It can also be a pair (tuple) of
+                                 (connection, read) timeouts.
+        :type _request_timeout: int, tuple(int, int), optional
+        :param _request_auth: set to override the auth_settings for an a single
+                              request; this effectively ignores the
+                              authentication in the spec for a single request.
+        :type _request_auth: dict, optional
+        :param _content_type: force content-type for the request.
+        :type _content_type: str, Optional
+        :param _headers: set to override the headers for a single
+                         request; this effectively ignores the headers
+                         in the spec for a single request.
+        :type _headers: dict, optional
+        :param _host_index: set to override the host_index for a single
+                            request; this effectively ignores the host_index
+                            in the spec for a single request.
+        :type _host_index: int, optional
+        :return: Returns the result object.
+        """ # noqa: E501
+
+        _param = self._download_qes_document_serialize(
+            workflow_run_id=workflow_run_id,
+            file_id=file_id,
+            _request_auth=_request_auth,
+            _content_type=_content_type,
+            _headers=_headers,
+            _host_index=_host_index
+        )
+
+        _response_types_map: Dict[str, Optional[str]] = {
+            '302': None,
+            '200': "bytearray",
+        }
+        response_data = self.api_client.call_api(
+            *_param,
+            _request_timeout=_request_timeout
+        )
+        response_data.read()
+        return self.api_client.response_deserialize(
+            response_data=response_data,
+            response_types_map=_response_types_map,
+        ).data
+
+
+    @validate_call
+    def download_qes_document_with_http_info(
+        self,
+        workflow_run_id: Annotated[StrictStr, Field(description="The unique identifier of the Workflow Run for which you want to retrieve the signed document.")],
+        file_id: Annotated[StrictStr, Field(description="The unique identifier of the file which you want to retrieve.")],
+        _request_timeout: Union[
+            None,
+            Annotated[StrictFloat, Field(gt=0)],
+            Tuple[
+                Annotated[StrictFloat, Field(gt=0)],
+                Annotated[StrictFloat, Field(gt=0)]
+            ]
+        ] = None,
+        _request_auth: Optional[Dict[StrictStr, Any]] = None,
+        _content_type: Optional[StrictStr] = None,
+        _headers: Optional[Dict[StrictStr, Any]] = None,
+        _host_index: Annotated[StrictInt, Field(ge=0, le=0)] = 0,
+    ) -> ApiResponse[bytearray]:
+        """Retrieves the signed document or application form
+
+        Retrieves the signed document or application form depending on the file_id provided. 
+
+        :param workflow_run_id: The unique identifier of the Workflow Run for which you want to retrieve the signed document. (required)
+        :type workflow_run_id: str
+        :param file_id: The unique identifier of the file which you want to retrieve. (required)
+        :type file_id: str
+        :param _request_timeout: timeout setting for this request. If one
+                                 number provided, it will be total request
+                                 timeout. It can also be a pair (tuple) of
+                                 (connection, read) timeouts.
+        :type _request_timeout: int, tuple(int, int), optional
+        :param _request_auth: set to override the auth_settings for an a single
+                              request; this effectively ignores the
+                              authentication in the spec for a single request.
+        :type _request_auth: dict, optional
+        :param _content_type: force content-type for the request.
+        :type _content_type: str, Optional
+        :param _headers: set to override the headers for a single
+                         request; this effectively ignores the headers
+                         in the spec for a single request.
+        :type _headers: dict, optional
+        :param _host_index: set to override the host_index for a single
+                            request; this effectively ignores the host_index
+                            in the spec for a single request.
+        :type _host_index: int, optional
+        :return: Returns the result object.
+        """ # noqa: E501
+
+        _param = self._download_qes_document_serialize(
+            workflow_run_id=workflow_run_id,
+            file_id=file_id,
+            _request_auth=_request_auth,
+            _content_type=_content_type,
+            _headers=_headers,
+            _host_index=_host_index
+        )
+
+        _response_types_map: Dict[str, Optional[str]] = {
+            '302': None,
+            '200': "bytearray",
+        }
+        response_data = self.api_client.call_api(
+            *_param,
+            _request_timeout=_request_timeout
+        )
+        response_data.read()
+        return self.api_client.response_deserialize(
+            response_data=response_data,
+            response_types_map=_response_types_map,
+        )
+
+
+    @validate_call
+    def download_qes_document_without_preload_content(
+        self,
+        workflow_run_id: Annotated[StrictStr, Field(description="The unique identifier of the Workflow Run for which you want to retrieve the signed document.")],
+        file_id: Annotated[StrictStr, Field(description="The unique identifier of the file which you want to retrieve.")],
+        _request_timeout: Union[
+            None,
+            Annotated[StrictFloat, Field(gt=0)],
+            Tuple[
+                Annotated[StrictFloat, Field(gt=0)],
+                Annotated[StrictFloat, Field(gt=0)]
+            ]
+        ] = None,
+        _request_auth: Optional[Dict[StrictStr, Any]] = None,
+        _content_type: Optional[StrictStr] = None,
+        _headers: Optional[Dict[StrictStr, Any]] = None,
+        _host_index: Annotated[StrictInt, Field(ge=0, le=0)] = 0,
+    ) -> RESTResponseType:
+        """Retrieves the signed document or application form
+
+        Retrieves the signed document or application form depending on the file_id provided. 
+
+        :param workflow_run_id: The unique identifier of the Workflow Run for which you want to retrieve the signed document. (required)
+        :type workflow_run_id: str
+        :param file_id: The unique identifier of the file which you want to retrieve. (required)
+        :type file_id: str
+        :param _request_timeout: timeout setting for this request. If one
+                                 number provided, it will be total request
+                                 timeout. It can also be a pair (tuple) of
+                                 (connection, read) timeouts.
+        :type _request_timeout: int, tuple(int, int), optional
+        :param _request_auth: set to override the auth_settings for an a single
+                              request; this effectively ignores the
+                              authentication in the spec for a single request.
+        :type _request_auth: dict, optional
+        :param _content_type: force content-type for the request.
+        :type _content_type: str, Optional
+        :param _headers: set to override the headers for a single
+                         request; this effectively ignores the headers
+                         in the spec for a single request.
+        :type _headers: dict, optional
+        :param _host_index: set to override the host_index for a single
+                            request; this effectively ignores the host_index
+                            in the spec for a single request.
+        :type _host_index: int, optional
+        :return: Returns the result object.
+        """ # noqa: E501
+
+        _param = self._download_qes_document_serialize(
+            workflow_run_id=workflow_run_id,
+            file_id=file_id,
+            _request_auth=_request_auth,
+            _content_type=_content_type,
+            _headers=_headers,
+            _host_index=_host_index
+        )
+
+        _response_types_map: Dict[str, Optional[str]] = {
+            '302': None,
+            '200': "bytearray",
+        }
+        response_data = self.api_client.call_api(
+            *_param,
+            _request_timeout=_request_timeout
+        )
+        return response_data.response
+
+
+    def _download_qes_document_serialize(
+        self,
+        workflow_run_id,
+        file_id,
+        _request_auth,
+        _content_type,
+        _headers,
+        _host_index,
+    ) -> RequestSerialized:
+
+        _host = None
+
+        _collection_formats: Dict[str, str] = {
+        }
+
+        _path_params: Dict[str, str] = {}
+        _query_params: List[Tuple[str, str]] = []
+        _header_params: Dict[str, Optional[str]] = _headers or {}
+        _form_params: List[Tuple[str, str]] = []
+        _files: Dict[str, Union[str, bytes]] = {}
+        _body_params: Optional[bytes] = None
+
+        # process the path parameters
+        # process the query parameters
+        if workflow_run_id is not None:
+            
+            _query_params.append(('workflow_run_id', workflow_run_id))
+            
+        if file_id is not None:
+            
+            _query_params.append(('file_id', file_id))
+            
+        # process the header parameters
+        # process the form parameters
+        # process the body parameter
+
+
+        # set the HTTP header `Accept`
+        _header_params['Accept'] = self.api_client.select_header_accept(
+            [
+                'application/pdf', 
+                'application/json'
+            ]
+        )
+
+
+        # authentication setting
+        _auth_settings: List[str] = [
+            'Token'
+        ]
+
+        return self.api_client.param_serialize(
+            method='GET',
+            resource_path='/qualified_electronic_signature/documents',
+            path_params=_path_params,
+            query_params=_query_params,
+            header_params=_header_params,
+            body=_body_params,
+            post_params=_form_params,
+            files=_files,
+            auth_settings=_auth_settings,
+            collection_formats=_collection_formats,
+            _host=_host,
+            _request_auth=_request_auth
+        )
+
+
+
+
     @validate_call
     def download_signed_evidence_file(
         self,

{onfido_python-3.2.0 → onfido_python-3.4.0}/onfido/api_client.py

@@ -88,7 +88,7 @@ class ApiClient:
             self.default_headers[header_name] = header_value
         self.cookie = cookie
         # Set default User-Agent.
-        self.user_agent = 'onfido-python/3.2.0'
+        self.user_agent = 'onfido-python/3.4.0'
         self.client_side_validation = configuration.client_side_validation
 
     def __enter__(self):

{onfido_python-3.2.0 → onfido_python-3.4.0}/onfido/configuration.py

@@ -383,7 +383,7 @@ conf = onfido.Configuration(
                "OS: {env}\n"\
                "Python Version: {pyversion}\n"\
                "Version of the API: v3.6\n"\
-               "SDK Package Version: 3.2.0".\
+               "SDK Package Version: 3.4.0".\
                format(env=sys.platform, pyversion=sys.version)
 
     def get_host_settings(self):

{onfido_python-3.2.0 → onfido_python-3.4.0}/onfido/models/document.py

@@ -48,8 +48,8 @@ class Document(BaseModel):
         if value is None:
             return value
 
-        if value not in set(['jpg', 'png', 'pdf']):
-            raise ValueError("must be one of enum values ('jpg', 'png', 'pdf')")
+        if value not in set(['jpg', 'jpeg', 'png', 'pdf']):
+            raise ValueError("must be one of enum values ('jpg', 'jpeg', 'png', 'pdf')")
         return value
 
     @field_validator('side')

{onfido_python-3.2.0 → onfido_python-3.4.0}/onfido/models/document_properties.py

@@ -40,9 +40,10 @@ class DocumentProperties(BaseModel):
     document_numbers: Optional[List[DocumentPropertiesDocumentNumbersInner]] = None
     document_type: Optional[StrictStr] = None
     first_name: Optional[StrictStr] = None
+    middle_name: Optional[StrictStr] = None
+    last_name: Optional[StrictStr] = None
     gender: Optional[StrictStr] = None
     issuing_country: Optional[StrictStr] = None
-    last_name: Optional[StrictStr] = None
     nationality: Optional[StrictStr] = None
     issuing_state: Optional[StrictStr] = None
     issuing_date: Optional[date] = None
@@ -79,7 +80,7 @@ class DocumentProperties(BaseModel):
     document_classification: Optional[DocumentPropertiesDocumentClassification] = None
     extracted_data: Optional[DocumentPropertiesExtractedData] = None
     additional_properties: Dict[str, Any] = {}
-    __properties: ClassVar[List[str]] = ["date_of_birth", "date_of_expiry", "personal_number", "document_numbers", "document_type", "first_name", "gender", "issuing_country", "last_name", "nationality", "issuing_state", "issuing_date", "categorisation", "mrz_line1", "mrz_line2", "mrz_line3", "address", "place_of_birth", "spouse_name", "widow_name", "alias_name", "issuing_authority", "remarks", "civil_state", "expatriation", "father_name", "mother_name", "religion", "type_of_permit", "version_number", "document_subtype", "profession", "security_document_number", "tax_number", "nist_identity_evidence_strength", "has_issuance_confirmation", "real_id_compliance", "security_tier", "address_lines", "barcode", "nfc", "driving_licence_information", "document_classification", "extracted_data"]
+    __properties: ClassVar[List[str]] = ["date_of_birth", "date_of_expiry", "personal_number", "document_numbers", "document_type", "first_name", "middle_name", "last_name", "gender", "issuing_country", "nationality", "issuing_state", "issuing_date", "categorisation", "mrz_line1", "mrz_line2", "mrz_line3", "address", "place_of_birth", "spouse_name", "widow_name", "alias_name", "issuing_authority", "remarks", "civil_state", "expatriation", "father_name", "mother_name", "religion", "type_of_permit", "version_number", "document_subtype", "profession", "security_document_number", "tax_number", "nist_identity_evidence_strength", "has_issuance_confirmation", "real_id_compliance", "security_tier", "address_lines", "barcode", "nfc", "driving_licence_information", "document_classification", "extracted_data"]
 
     @field_validator('nist_identity_evidence_strength')
     def nist_identity_evidence_strength_validate_enum(cls, value):
@@ -204,9 +205,10 @@ class DocumentProperties(BaseModel):
             "document_numbers": [DocumentPropertiesDocumentNumbersInner.from_dict(_item) for _item in obj["document_numbers"]] if obj.get("document_numbers") is not None else None,
             "document_type": obj.get("document_type"),
             "first_name": obj.get("first_name"),
+            "middle_name": obj.get("middle_name"),
+            "last_name": obj.get("last_name"),
             "gender": obj.get("gender"),
             "issuing_country": obj.get("issuing_country"),
-            "last_name": obj.get("last_name"),
             "nationality": obj.get("nationality"),
             "issuing_state": obj.get("issuing_state"),
             "issuing_date": obj.get("issuing_date"),

{onfido_python-3.2.0 → onfido_python-3.4.0}/onfido/models/document_shared.py

@@ -41,8 +41,8 @@ class DocumentShared(BaseModel):
         if value is None:
             return value
 
-        if value not in set(['jpg', 'png', 'pdf']):
-            raise ValueError("must be one of enum values ('jpg', 'png', 'pdf')")
+        if value not in set(['jpg', 'jpeg', 'png', 'pdf']):
+            raise ValueError("must be one of enum values ('jpg', 'jpeg', 'png', 'pdf')")
         return value
 
     @field_validator('side')

{onfido_python-3.2.0 → onfido_python-3.4.0}/onfido/models/document_with_driver_verification_report_all_of_properties.py

@@ -42,9 +42,10 @@ class DocumentWithDriverVerificationReportAllOfProperties(BaseModel):
     document_numbers: Optional[List[DocumentPropertiesDocumentNumbersInner]] = None
     document_type: Optional[StrictStr] = None
     first_name: Optional[StrictStr] = None
+    middle_name: Optional[StrictStr] = None
+    last_name: Optional[StrictStr] = None
     gender: Optional[StrictStr] = None
     issuing_country: Optional[StrictStr] = None
-    last_name: Optional[StrictStr] = None
     nationality: Optional[StrictStr] = None
     issuing_state: Optional[StrictStr] = None
     issuing_date: Optional[date] = None
@@ -87,7 +88,7 @@ class DocumentWithDriverVerificationReportAllOfProperties(BaseModel):
     vehicle_class_details: Optional[List[DocumentWithDriverVerificationReportAllOfPropertiesAllOfVehicleClassDetailsInner]] = Field(default=None, description="Detailed classes/categories information")
     passenger_vehicle: Optional[DocumentWithDriverVerificationReportAllOfPropertiesAllOfPassengerVehicle] = None
     additional_properties: Dict[str, Any] = {}
-    __properties: ClassVar[List[str]] = ["date_of_birth", "date_of_expiry", "personal_number", "document_numbers", "document_type", "first_name", "gender", "issuing_country", "last_name", "nationality", "issuing_state", "issuing_date", "categorisation", "mrz_line1", "mrz_line2", "mrz_line3", "address", "place_of_birth", "spouse_name", "widow_name", "alias_name", "issuing_authority", "remarks", "civil_state", "expatriation", "father_name", "mother_name", "religion", "type_of_permit", "version_number", "document_subtype", "profession", "security_document_number", "tax_number", "nist_identity_evidence_strength", "has_issuance_confirmation", "real_id_compliance", "security_tier", "address_lines", "barcode", "nfc", "driving_licence_information", "document_classification", "extracted_data", "drivers_licence", "restricted_licence", "raw_licence_category", "raw_vehicle_classes", "vehicle_class_details", "passenger_vehicle"]
+    __properties: ClassVar[List[str]] = ["date_of_birth", "date_of_expiry", "personal_number", "document_numbers", "document_type", "first_name", "middle_name", "last_name", "gender", "issuing_country", "nationality", "issuing_state", "issuing_date", "categorisation", "mrz_line1", "mrz_line2", "mrz_line3", "address", "place_of_birth", "spouse_name", "widow_name", "alias_name", "issuing_authority", "remarks", "civil_state", "expatriation", "father_name", "mother_name", "religion", "type_of_permit", "version_number", "document_subtype", "profession", "security_document_number", "tax_number", "nist_identity_evidence_strength", "has_issuance_confirmation", "real_id_compliance", "security_tier", "address_lines", "barcode", "nfc", "driving_licence_information", "document_classification", "extracted_data", "drivers_licence", "restricted_licence", "raw_licence_category", "raw_vehicle_classes", "vehicle_class_details", "passenger_vehicle"]
 
     @field_validator('nist_identity_evidence_strength')
     def nist_identity_evidence_strength_validate_enum(cls, value):
@@ -222,9 +223,10 @@ class DocumentWithDriverVerificationReportAllOfProperties(BaseModel):
             "document_numbers": [DocumentPropertiesDocumentNumbersInner.from_dict(_item) for _item in obj["document_numbers"]] if obj.get("document_numbers") is not None else None,
             "document_type": obj.get("document_type"),
             "first_name": obj.get("first_name"),
+            "middle_name": obj.get("middle_name"),
+            "last_name": obj.get("last_name"),
             "gender": obj.get("gender"),
             "issuing_country": obj.get("issuing_country"),
-            "last_name": obj.get("last_name"),
             "nationality": obj.get("nationality"),
             "issuing_state": obj.get("issuing_state"),
             "issuing_date": obj.get("issuing_date"),

{onfido_python-3.2.0 → onfido_python-3.4.0}/onfido/models/webhook_event_payload_object.py

@@ -29,10 +29,11 @@ class WebhookEventPayloadObject(BaseModel):
     """ # 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.")
+    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.")
     additional_properties: Dict[str, Any] = {}
-    __properties: ClassVar[List[str]] = ["id", "status", "completed_at_iso8601", "href"]
+    __properties: ClassVar[List[str]] = ["id", "status", "started_at_iso8601", "completed_at_iso8601", "href"]
 
     model_config = ConfigDict(
         populate_by_name=True,
@@ -94,6 +95,7 @@ class WebhookEventPayloadObject(BaseModel):
         _obj = cls.model_validate({
             "id": obj.get("id"),
             "status": obj.get("status"),
+            "started_at_iso8601": obj.get("started_at_iso8601"),
             "completed_at_iso8601": obj.get("completed_at_iso8601"),
             "href": obj.get("href")
         })

{onfido_python-3.2.0 → onfido_python-3.4.0}/onfido/models/workflow_run.py

@@ -33,6 +33,7 @@ class WorkflowRun(BaseModel):
     applicant_id: StrictStr = Field(description="The unique identifier for the Applicant.")
     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
     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.")
@@ -43,8 +44,9 @@ class WorkflowRun(BaseModel):
     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
+    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", "link", "created_at", "updated_at", "id", "workflow_version_id", "dashboard_url", "status", "output", "reasons", "error"]
+    __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):
@@ -113,6 +115,11 @@ class WorkflowRun(BaseModel):
         if self.tags is None and "tags" in self.model_fields_set:
             _dict['tags'] = None
 
+        # set to None if sdk_token (nullable) is None
+        # and model_fields_set contains the field
+        if self.sdk_token is None and "sdk_token" in self.model_fields_set:
+            _dict['sdk_token'] = None
+
         return _dict
 
     @classmethod
@@ -128,6 +135,7 @@ class WorkflowRun(BaseModel):
             "applicant_id": obj.get("applicant_id"),
             "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,
             "created_at": obj.get("created_at"),
             "updated_at": obj.get("updated_at"),
@@ -137,7 +145,8 @@ 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": WorkflowRunResponseError.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
         for _key in obj.keys():

{onfido_python-3.2.0 → onfido_python-3.4.0}/onfido/models/workflow_run_builder.py

@@ -32,12 +32,13 @@ class WorkflowRunBuilder(BaseModel):
     applicant_id: StrictStr = Field(description="The unique identifier for the Applicant.")
     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
     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.")
     additional_properties: Dict[str, Any] = {}
-    __properties: ClassVar[List[str]] = ["applicant_id", "workflow_id", "tags", "link", "created_at", "updated_at", "custom_data"]
+    __properties: ClassVar[List[str]] = ["applicant_id", "workflow_id", "tags", "customer_user_id", "link", "created_at", "updated_at", "custom_data"]
 
     model_config = ConfigDict(
         populate_by_name=True,
@@ -108,6 +109,7 @@ class WorkflowRunBuilder(BaseModel):
             "applicant_id": obj.get("applicant_id"),
             "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,
             "created_at": obj.get("created_at"),
             "updated_at": obj.get("updated_at"),

{onfido_python-3.2.0 → onfido_python-3.4.0}/onfido/models/workflow_run_response.py

@@ -34,8 +34,9 @@ class WorkflowRunResponse(BaseModel):
     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
+    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"]
+    __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):
@@ -96,6 +97,11 @@ class WorkflowRunResponse(BaseModel):
             for _key, _value in self.additional_properties.items():
                 _dict[_key] = _value
 
+        # set to None if sdk_token (nullable) is None
+        # and model_fields_set contains the field
+        if self.sdk_token is None and "sdk_token" in self.model_fields_set:
+            _dict['sdk_token'] = None
+
         return _dict
 
     @classmethod
@@ -114,7 +120,8 @@ 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": WorkflowRunResponseError.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
         for _key in obj.keys():

{onfido_python-3.2.0 → onfido_python-3.4.0}/onfido/models/workflow_run_shared.py

@@ -32,11 +32,12 @@ class WorkflowRunShared(BaseModel):
     applicant_id: StrictStr = Field(description="The unique identifier for the Applicant.")
     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
     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] = {}
-    __properties: ClassVar[List[str]] = ["applicant_id", "workflow_id", "tags", "link", "created_at", "updated_at"]
+    __properties: ClassVar[List[str]] = ["applicant_id", "workflow_id", "tags", "customer_user_id", "link", "created_at", "updated_at"]
 
     model_config = ConfigDict(
         populate_by_name=True,
@@ -107,6 +108,7 @@ class WorkflowRunShared(BaseModel):
             "applicant_id": obj.get("applicant_id"),
             "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,
             "created_at": obj.get("created_at"),
             "updated_at": obj.get("updated_at")

{onfido_python-3.2.0 → onfido_python-3.4.0/onfido_python.egg-info}/PKG-INFO

@@ -1,6 +1,6 @@
 Metadata-Version: 2.1
 Name: onfido-python
-Version: 3.2.0
+Version: 3.4.0
 Summary: Python library for the Onfido API
 Home-page: 
 Author: OpenAPI Generator community

{onfido_python-3.2.0 → onfido_python-3.4.0}/onfido_python.egg-info/SOURCES.txt

@@ -302,6 +302,7 @@ tests/test_id_photos.py
 tests/test_live_photos.py
 tests/test_live_video.py
 tests/test_motion_capture.py
+tests/test_qualified_electronic_signatures.py
 tests/test_report_schemas.py
 tests/test_reports.py
 tests/test_sdk_token.py

{onfido_python-3.2.0 → onfido_python-3.4.0}/pyproject.toml

@@ -1,6 +1,6 @@
 [tool.poetry]
 name = "onfido-python"
-version = "3.2.0"
+version = "3.4.0"
 description = "Python library for the Onfido API"
 authors = ["OpenAPI Generator Community <team@openapitools.org>"]
 license = "MIT"

{onfido_python-3.2.0 → onfido_python-3.4.0}/setup.py

@@ -21,7 +21,7 @@ from setuptools import setup, find_packages  # noqa: H301
 # prerequisite: setuptools
 # http://pypi.python.org/pypi/setuptools
 NAME = "onfido-python"
-VERSION = "3.2.0"
+VERSION = "3.4.0"
 PYTHON_REQUIRES = ">=3.7"
 REQUIRES = [
     "urllib3 >= 1.25.3, < 2.1.0",