Refresh onfido-python after onfido-openapi-spec update (dbd43ed)

.release.json

@@ -1,9 +1,9 @@
 {
   "source": {
     "repo_url": "https://github.com/onfido/onfido-openapi-spec",
-    "short_sha": "c80d3b5",
-    "long_sha": "c80d3b513a15bb67ec316709884b890ab2f47121",
-    "version": "v5.5.0"
+    "short_sha": "dbd43ed",
+    "long_sha": "dbd43ed035dc8ddaf611883e77370114f21534e5",
+    "version": "v5.6.0"
   },
-  "release": "v5.5.0"
+  "release": "v5.6.0"
 }

onfido/__init__.py

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

onfido/api/default_api.py

@@ -14996,6 +14996,7 @@ def list_workflow_runs(
         created_at_lt: Annotated[Optional[datetime], Field(description="A ISO-8601 date to filter results with a created date less than (before) the one provided.")] = None,
         sort: Annotated[Optional[StrictStr], Field(description="A string with the value 'desc' or 'asc' that allows to sort the returned list by the completed datetime either descending or ascending, respectively. If not specified, defaults to 'desc'.")] = None,
         applicant_id: Annotated[Optional[StrictStr], Field(description="the applicant's id.")] = None,
+        tags: Annotated[Optional[List[StrictStr]], Field(description="A list of tags to filter the results.")] = None,
         _request_timeout: Union[
             None,
             Annotated[StrictFloat, Field(gt=0)],
@@ -15025,6 +15026,8 @@ def list_workflow_runs(
         :type sort: str
         :param applicant_id: the applicant's id.
         :type applicant_id: str
+        :param tags: A list of tags to filter the results.
+        :type tags: List[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
@@ -15054,6 +15057,7 @@ def list_workflow_runs(
             created_at_lt=created_at_lt,
             sort=sort,
             applicant_id=applicant_id,
+            tags=tags,
             _request_auth=_request_auth,
             _content_type=_content_type,
             _headers=_headers,
@@ -15083,6 +15087,7 @@ def list_workflow_runs_with_http_info(
         created_at_lt: Annotated[Optional[datetime], Field(description="A ISO-8601 date to filter results with a created date less than (before) the one provided.")] = None,
         sort: Annotated[Optional[StrictStr], Field(description="A string with the value 'desc' or 'asc' that allows to sort the returned list by the completed datetime either descending or ascending, respectively. If not specified, defaults to 'desc'.")] = None,
         applicant_id: Annotated[Optional[StrictStr], Field(description="the applicant's id.")] = None,
+        tags: Annotated[Optional[List[StrictStr]], Field(description="A list of tags to filter the results.")] = None,
         _request_timeout: Union[
             None,
             Annotated[StrictFloat, Field(gt=0)],
@@ -15112,6 +15117,8 @@ def list_workflow_runs_with_http_info(
         :type sort: str
         :param applicant_id: the applicant's id.
         :type applicant_id: str
+        :param tags: A list of tags to filter the results.
+        :type tags: List[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
@@ -15141,6 +15148,7 @@ def list_workflow_runs_with_http_info(
             created_at_lt=created_at_lt,
             sort=sort,
             applicant_id=applicant_id,
+            tags=tags,
             _request_auth=_request_auth,
             _content_type=_content_type,
             _headers=_headers,
@@ -15170,6 +15178,7 @@ def list_workflow_runs_without_preload_content(
         created_at_lt: Annotated[Optional[datetime], Field(description="A ISO-8601 date to filter results with a created date less than (before) the one provided.")] = None,
         sort: Annotated[Optional[StrictStr], Field(description="A string with the value 'desc' or 'asc' that allows to sort the returned list by the completed datetime either descending or ascending, respectively. If not specified, defaults to 'desc'.")] = None,
         applicant_id: Annotated[Optional[StrictStr], Field(description="the applicant's id.")] = None,
+        tags: Annotated[Optional[List[StrictStr]], Field(description="A list of tags to filter the results.")] = None,
         _request_timeout: Union[
             None,
             Annotated[StrictFloat, Field(gt=0)],
@@ -15199,6 +15208,8 @@ def list_workflow_runs_without_preload_content(
         :type sort: str
         :param applicant_id: the applicant's id.
         :type applicant_id: str
+        :param tags: A list of tags to filter the results.
+        :type tags: List[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
@@ -15228,6 +15239,7 @@ def list_workflow_runs_without_preload_content(
             created_at_lt=created_at_lt,
             sort=sort,
             applicant_id=applicant_id,
+            tags=tags,
             _request_auth=_request_auth,
             _content_type=_content_type,
             _headers=_headers,
@@ -15252,6 +15264,7 @@ def _list_workflow_runs_serialize(
         created_at_lt,
         sort,
         applicant_id,
+        tags,
         _request_auth,
         _content_type,
         _headers,
@@ -15261,6 +15274,7 @@ def _list_workflow_runs_serialize(
         _host = None
 
         _collection_formats: Dict[str, str] = {
+            'tags': 'csv',
         }
 
         _path_params: Dict[str, str] = {}
@@ -15316,6 +15330,10 @@ def _list_workflow_runs_serialize(
 
             _query_params.append(('applicant_id', applicant_id))
 
+        if tags is not None:
+
+            _query_params.append(('tags', tags))
+
         # process the header parameters
         # process the form parameters
         # process the body parameter

onfido/api_client.py

@@ -90,7 +90,7 @@ def __init__(
             self.default_headers[header_name] = header_value
         self.cookie = cookie
         # Set default User-Agent.
-        self.user_agent = 'onfido-python/5.5.0'
+        self.user_agent = 'onfido-python/5.6.0'
         self.client_side_validation = configuration.client_side_validation
 
     def __enter__(self):

onfido/configuration.py

@@ -501,7 +501,7 @@ def to_debug_report(self) -> str:
                "OS: {env}\n"\
                "Python Version: {pyversion}\n"\
                "Version of the API: v3.6\n"\
-               "SDK Package Version: 5.5.0".\
+               "SDK Package Version: 5.6.0".\
                format(env=sys.platform, pyversion=sys.version)
 
     def get_host_settings(self) -> List[HostSetting]:

onfido/models/proof_of_address_properties.py

@@ -44,8 +44,8 @@ def document_type_validate_enum(cls, value):
         if value is None:
             return value
 
-        if value not in set(['bank_building_society_statement', 'utility_bill', 'council_tax', 'benefit_letters', 'mortgage_statement', 'mobile_phone_bill', 'general_letter', 'insurance_statement', 'pension_property_statement_letter', 'identity_document_with_address', 'exchange_house_statement', 'unknown_default_open_api']):
-            raise ValueError("must be one of enum values ('bank_building_society_statement', 'utility_bill', 'council_tax', 'benefit_letters', 'mortgage_statement', 'mobile_phone_bill', 'general_letter', 'insurance_statement', 'pension_property_statement_letter', 'identity_document_with_address', 'exchange_house_statement', 'unknown_default_open_api')")
+        if value not in set(['bank_building_society_statement', 'utility_bill', 'council_tax', 'benefit_letters', 'mortgage_statement', 'mobile_phone_bill', 'general_letter', 'insurance_statement', 'pension_property_statement_letter', 'identity_document_with_address', 'exchange_house_statement', 'accommodation_tenancy_certificate', 'address_certificate', 'electricity_bill', 'gas_bill', 'internet_bill', 'phone_bill', 'water_bill', 'unknown_default_open_api']):
+            raise ValueError("must be one of enum values ('bank_building_society_statement', 'utility_bill', 'council_tax', 'benefit_letters', 'mortgage_statement', 'mobile_phone_bill', 'general_letter', 'insurance_statement', 'pension_property_statement_letter', 'identity_document_with_address', 'exchange_house_statement', 'accommodation_tenancy_certificate', 'address_certificate', 'electricity_bill', 'gas_bill', 'internet_bill', 'phone_bill', 'water_bill', 'unknown_default_open_api')")
         return value
 
     model_config = ConfigDict(

onfido/models/webhook_event_payload_resource.py

@@ -43,11 +43,12 @@ class WebhookEventPayloadResource(BaseModel):
     input: Optional[Dict[str, Any]] = Field(default=None, description="Input object with the fields used by the Task execution.")
     output: Any = Field(default=None, description="Value field (it can be an Object, List, etc.) with the fields produced by the Task execution.")
     reasons: Optional[List[StrictStr]] = Field(default=None, description="The reasons the Workflow Run outcome was reached. Configurable when creating the Workflow Version.")
+    tags: Optional[List[StrictStr]] = Field(default=None, description="A list of tags associated with the Workflow Run.")
     link: Optional[WorkflowRunLink] = Field(default=None, description="Object for the configuration of the Workflow Run link.")
     error: Optional[WorkflowRunError] = Field(default=None, description="Error object that details why a Workflow Run is in Error status.")
     customer_user_id: Optional[Annotated[str, Field(strict=True, max_length=256)]] = Field(default=None, description="Customer-provided user identifier.")
     additional_properties: Dict[str, Any] = {}
-    __properties: ClassVar[List[str]] = ["id", "applicant_id", "created_at", "updated_at", "dashboard_url", "workflow_id", "workflow_run_id", "workflow_version_id", "task_def_id", "task_def_version", "input", "output", "reasons", "link", "error", "customer_user_id"]
+    __properties: ClassVar[List[str]] = ["id", "applicant_id", "created_at", "updated_at", "dashboard_url", "workflow_id", "workflow_run_id", "workflow_version_id", "task_def_id", "task_def_version", "input", "output", "reasons", "tags", "link", "error", "customer_user_id"]
 
     @field_validator('task_def_id')
     def task_def_id_validate_regular_expression(cls, value):
@@ -146,6 +147,7 @@ def from_dict(cls, obj: Optional[Dict[str, Any]]) -> Optional[Self]:
             "input": obj.get("input"),
             "output": obj.get("output"),
             "reasons": obj.get("reasons"),
+            "tags": obj.get("tags"),
             "link": WorkflowRunLink.from_dict(obj["link"]) if obj.get("link") is not None else None,
             "error": WorkflowRunError.from_dict(obj["error"]) if obj.get("error") is not None else None,
             "customer_user_id": obj.get("customer_user_id")