Add further workflow run support - create, find, and all

[peggalex]

While there exists a WorkflowRuns resource for Onfido Studio support, it only has the method evidence(). Some other actions, such as create, list, and retrieve are not yet added to this SDK. This PR adds those actions in.

I performed validation using the following code, although depending on your Onfido settings you may have different required applicant fields and other configuration differences. There are also new unit tests for the added methods.

import onfido
from onfido.regions import Region

ONFIDO_API_KEY = "" # TODO: populate with secret
ONFIDO_WORKFLOW_ID = "" # TODO: populate with value


if __name__ == "__main__":
    onfido_api = onfido.Api(ONFIDO_API_KEY, region=Region.CA)

    applicant_id = onfido_api.applicant.create({            
        "first_name": "FIRST_NAME",
        "last_name": "LAST_NAME",
        "dob": "2000-01-01"
    })["id"]

    create_resp = onfido_api.workflowrun.create({
        "applicant_id": applicant_id,
        "workflow_id": ONFIDO_WORKFLOW_ID
    })
    print("Create:")
    print(create_resp)

    workflow_run_id = create_resp["id"]
    find_resp = onfido_api.workflowrun.find(workflow_run_id)
    print("\nFind:")
    print(find_resp)

    all_resp = onfido_api.workflowrun.all()
    print("\nAll:")
    print(all_resp)

[peggalex]

There are other tests simply compare the fully-formed url with query parameters, such as:

assert history[0].url == "https://api.eu.onfido.com/v3.6/applicants?include_deleted=True&per_page=5&page=2"

in test_applicants.py > test_list_applicants.

However, this is a slightly different case because there are more params, and there are url-escaped values such as commas in properties like tags and status:

tags (optional): a list of comma separated tags to filter the results.
(docs)

Comparing the parsed url query params as a dict might be more readable and maintainable than something like:

assert history[0].url == "https://api.eu.onfido.com/v3.6/workflow_runs?page=2&sort=asc&status=approved%2Cdeclined&tags=dummy_tag1%2Cdummy_tag2&created_at_gt=2023-11-17T16%3A39%3A04Z&created_at_lt=2008-02-29T02%3A56%3A37Z

[peggalex]

based on the existing onfido/resources/applicants.py

[peggalex]

@DavidMealha hi David, was wondering if you would be able to review my PR

[dvacca-onfido]

It looks good to me, thanks for your contribution.

[DavidMealha-Onfido]

Hey @peggalex, the changes look good but CI is failing, can you please fix it

[peggalex]

hey @DavidMealha, I was using str.removesuffix() that was introduced in python3.9. I've made some updates and tested with python3.7 -- it should work now. Could I ask you to rerun the CI?

[DavidMealha-Onfido]

Hey @peggalex, this has been released as part of v2.10.0. Thank you again for your contribution!