Skip to content
This repository was archived by the owner on Nov 16, 2021. It is now read-only.

Commit 76492d4

Browse files
author
Engineering at Onfido
committed
New client release: 2.1.0
1 parent 9421491 commit 76492d4

15 files changed

Lines changed: 675 additions & 245 deletions

‎README.md‎

Lines changed: 6 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -4,7 +4,7 @@ The Onfido API is used to submit check requests.
44
This Python package is automatically generated by the [OpenAPI Generator](https://openapi-generator.tech) project:
55

66
- API version: 2.0.0
7-
- Package version: 2.0.0
7+
- Package version: 2.1.0
88
- Build package: org.openapitools.codegen.languages.PythonClientCodegen
99

1010
## Requirements.
@@ -102,18 +102,21 @@ Class | Method | HTTP request | Description
102102
*DefaultApi* | [**destroy_applicant**](docs/DefaultApi.md#destroy_applicant) | **DELETE** /applicants/{applicant_id} | Delete Applicant
103103
*DefaultApi* | [**download_document**](docs/DefaultApi.md#download_document) | **GET** /applicants/{applicant_id}/documents/{document_id}/download | Download a documents raw data
104104
*DefaultApi* | [**download_live_photo**](docs/DefaultApi.md#download_live_photo) | **GET** /live_photos/{live_photo_id}/download | Download live photo
105+
*DefaultApi* | [**download_live_video**](docs/DefaultApi.md#download_live_video) | **GET** /live_videos/{live_video_id}/download | Download live video
105106
*DefaultApi* | [**find_addresses**](docs/DefaultApi.md#find_addresses) | **GET** /addresses/pick | Search for addresses by postcode
106107
*DefaultApi* | [**find_applicant**](docs/DefaultApi.md#find_applicant) | **GET** /applicants/{applicant_id} | Retrieve Applicant
107108
*DefaultApi* | [**find_check**](docs/DefaultApi.md#find_check) | **GET** /applicants/{applicant_id}/checks/{check_id} | Retrieve a Check
108109
*DefaultApi* | [**find_document**](docs/DefaultApi.md#find_document) | **GET** /applicants/{applicant_id}/documents/{document_id} | A single document can be retrieved by calling this endpoint with the document’s unique identifier.
109110
*DefaultApi* | [**find_live_photo**](docs/DefaultApi.md#find_live_photo) | **GET** /live_photos/{live_photo_id} | Retrieve live photo
111+
*DefaultApi* | [**find_live_video**](docs/DefaultApi.md#find_live_video) | **GET** /live_videos/{live_video_id} | Retrieve live video
110112
*DefaultApi* | [**find_report**](docs/DefaultApi.md#find_report) | **GET** /checks/{check_id}/reports/{report_id} | A single report can be retrieved using this endpoint with the corresponding unique identifier.
111113
*DefaultApi* | [**find_report_type_group**](docs/DefaultApi.md#find_report_type_group) | **GET** /report_type_groups/{report_type_group_id} | Retrieve single report type group object
112114
*DefaultApi* | [**find_webhook**](docs/DefaultApi.md#find_webhook) | **GET** /webhooks/{webhook_id} | Retrieve a Webhook
113115
*DefaultApi* | [**list_applicants**](docs/DefaultApi.md#list_applicants) | **GET** /applicants | List Applicants
114116
*DefaultApi* | [**list_checks**](docs/DefaultApi.md#list_checks) | **GET** /applicants/{applicant_id}/checks | Retrieve Checks
115117
*DefaultApi* | [**list_documents**](docs/DefaultApi.md#list_documents) | **GET** /applicants/{applicant_id}/documents | List documents
116118
*DefaultApi* | [**list_live_photos**](docs/DefaultApi.md#list_live_photos) | **GET** /live_photos | List live photos
119+
*DefaultApi* | [**list_live_videos**](docs/DefaultApi.md#list_live_videos) | **GET** /live_videos | List live videos
117120
*DefaultApi* | [**list_report_type_groups**](docs/DefaultApi.md#list_report_type_groups) | **GET** /report_type_groups | Retrieve all report type groups
118121
*DefaultApi* | [**list_reports**](docs/DefaultApi.md#list_reports) | **GET** /checks/{check_id}/reports | All the reports belonging to a particular check can be listed from this endpoint.
119122
*DefaultApi* | [**list_webhooks**](docs/DefaultApi.md#list_webhooks) | **GET** /webhooks | List webhooks
@@ -142,6 +145,8 @@ Class | Method | HTTP request | Description
142145
- [IdNumber](docs/IdNumber.md)
143146
- [LivePhoto](docs/LivePhoto.md)
144147
- [LivePhotosList](docs/LivePhotosList.md)
148+
- [LiveVideo](docs/LiveVideo.md)
149+
- [LiveVideosList](docs/LiveVideosList.md)
145150
- [Report](docs/Report.md)
146151
- [ReportDocument](docs/ReportDocument.md)
147152
- [ReportOption](docs/ReportOption.md)

‎docs/DefaultApi.md‎

Lines changed: 158 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -11,18 +11,21 @@ Method | HTTP request | Description
1111
[**destroy_applicant**](DefaultApi.md#destroy_applicant) | **DELETE** /applicants/{applicant_id} | Delete Applicant
1212
[**download_document**](DefaultApi.md#download_document) | **GET** /applicants/{applicant_id}/documents/{document_id}/download | Download a documents raw data
1313
[**download_live_photo**](DefaultApi.md#download_live_photo) | **GET** /live_photos/{live_photo_id}/download | Download live photo
14+
[**download_live_video**](DefaultApi.md#download_live_video) | **GET** /live_videos/{live_video_id}/download | Download live video
1415
[**find_addresses**](DefaultApi.md#find_addresses) | **GET** /addresses/pick | Search for addresses by postcode
1516
[**find_applicant**](DefaultApi.md#find_applicant) | **GET** /applicants/{applicant_id} | Retrieve Applicant
1617
[**find_check**](DefaultApi.md#find_check) | **GET** /applicants/{applicant_id}/checks/{check_id} | Retrieve a Check
1718
[**find_document**](DefaultApi.md#find_document) | **GET** /applicants/{applicant_id}/documents/{document_id} | A single document can be retrieved by calling this endpoint with the document’s unique identifier.
1819
[**find_live_photo**](DefaultApi.md#find_live_photo) | **GET** /live_photos/{live_photo_id} | Retrieve live photo
20+
[**find_live_video**](DefaultApi.md#find_live_video) | **GET** /live_videos/{live_video_id} | Retrieve live video
1921
[**find_report**](DefaultApi.md#find_report) | **GET** /checks/{check_id}/reports/{report_id} | A single report can be retrieved using this endpoint with the corresponding unique identifier.
2022
[**find_report_type_group**](DefaultApi.md#find_report_type_group) | **GET** /report_type_groups/{report_type_group_id} | Retrieve single report type group object
2123
[**find_webhook**](DefaultApi.md#find_webhook) | **GET** /webhooks/{webhook_id} | Retrieve a Webhook
2224
[**list_applicants**](DefaultApi.md#list_applicants) | **GET** /applicants | List Applicants
2325
[**list_checks**](DefaultApi.md#list_checks) | **GET** /applicants/{applicant_id}/checks | Retrieve Checks
2426
[**list_documents**](DefaultApi.md#list_documents) | **GET** /applicants/{applicant_id}/documents | List documents
2527
[**list_live_photos**](DefaultApi.md#list_live_photos) | **GET** /live_photos | List live photos
28+
[**list_live_videos**](DefaultApi.md#list_live_videos) | **GET** /live_videos | List live videos
2629
[**list_report_type_groups**](DefaultApi.md#list_report_type_groups) | **GET** /report_type_groups | Retrieve all report type groups
2730
[**list_reports**](DefaultApi.md#list_reports) | **GET** /checks/{check_id}/reports | All the reports belonging to a particular check can be listed from this endpoint.
2831
[**list_webhooks**](DefaultApi.md#list_webhooks) | **GET** /webhooks | List webhooks
@@ -397,6 +400,59 @@ Name | Type | Description | Notes
397400

398401
[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md)
399402

403+
# **download_live_video**
404+
> file download_live_video(live_video_id)
405+
406+
Download live video
407+
408+
Live videos are downloaded using this endpoint.
409+
410+
### Example
411+
412+
* Api Key Authentication (Token):
413+
```python
414+
from __future__ import print_function
415+
import time
416+
import onfido
417+
from onfido.rest import ApiException
418+
from pprint import pprint
419+
configuration = onfido.Configuration()
420+
configuration.api_key['Authorization'] = 'token=' + 'YOUR API TOKEN'
421+
configuration.api_key_prefix['Authorization'] = 'Token'
422+
423+
# create an instance of the API class
424+
api_instance = onfido.DefaultApi(onfido.ApiClient(configuration))
425+
live_video_id = 'live_video_id_example' # str | The live video’s unique identifier.
426+
427+
try:
428+
# Download live video
429+
api_response = api_instance.download_live_video(live_video_id)
430+
pprint(api_response)
431+
except ApiException as e:
432+
print("Exception when calling DefaultApi->download_live_video: %s\n" % e)
433+
```
434+
435+
### Parameters
436+
437+
Name | Type | Description | Notes
438+
------------- | ------------- | ------------- | -------------
439+
**live_video_id** | **str**| The live video’s unique identifier. |
440+
441+
### Return type
442+
443+
**file**
444+
445+
### Authorization
446+
447+
[Token](../README.md#Token)
448+
449+
### HTTP request headers
450+
451+
- **Content-Type**: Not defined
452+
- **Accept**: */*, application/json
453+
454+
[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md)
455+
400456
# **find_addresses**
401457
> GenericAddressesList find_addresses(postcode)
402458
@@ -656,6 +712,57 @@ Name | Type | Description | Notes
656712

657713
[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md)
658714

715+
# **find_live_video**
716+
> LiveVideo find_live_video(live_video_id)
717+
718+
Retrieve live video
719+
720+
### Example
721+
722+
* Api Key Authentication (Token):
723+
```python
724+
from __future__ import print_function
725+
import time
726+
import onfido
727+
from onfido.rest import ApiException
728+
from pprint import pprint
729+
configuration = onfido.Configuration()
730+
configuration.api_key['Authorization'] = 'token=' + 'YOUR API TOKEN'
731+
configuration.api_key_prefix['Authorization'] = 'Token'
732+
733+
# create an instance of the API class
734+
api_instance = onfido.DefaultApi(onfido.ApiClient(configuration))
735+
live_video_id = 'live_video_id_example' # str | The live video’s unique identifier.
736+
737+
try:
738+
# Retrieve live video
739+
api_response = api_instance.find_live_video(live_video_id)
740+
pprint(api_response)
741+
except ApiException as e:
742+
print("Exception when calling DefaultApi->find_live_video: %s\n" % e)
743+
```
744+
745+
### Parameters
746+
747+
Name | Type | Description | Notes
748+
------------- | ------------- | ------------- | -------------
749+
**live_video_id** | **str**| The live video’s unique identifier. |
750+
751+
### Return type
752+
753+
[**LiveVideo**](LiveVideo.md)
754+
755+
### Authorization
756+
757+
[Token](../README.md#Token)
758+
759+
### HTTP request headers
760+
761+
- **Content-Type**: Not defined
762+
- **Accept**: application/json
763+
764+
[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md)
765+
659766
# **find_report**
660767
> Report find_report(check_id, report_id)
661768
@@ -1025,6 +1132,57 @@ Name | Type | Description | Notes
10251132

10261133
[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md)
10271134

1135+
# **list_live_videos**
1136+
> LiveVideosList list_live_videos(applicant_id)
1137+
1138+
List live videos
1139+
1140+
### Example
1141+
1142+
* Api Key Authentication (Token):
1143+
```python
1144+
from __future__ import print_function
1145+
import time
1146+
import onfido
1147+
from onfido.rest import ApiException
1148+
from pprint import pprint
1149+
configuration = onfido.Configuration()
1150+
configuration.api_key['Authorization'] = 'token=' + 'YOUR API TOKEN'
1151+
configuration.api_key_prefix['Authorization'] = 'Token'
1152+
1153+
# create an instance of the API class
1154+
api_instance = onfido.DefaultApi(onfido.ApiClient(configuration))
1155+
applicant_id = 'applicant_id_example' # str | The id of the applicant the live videos belong to.
1156+
1157+
try:
1158+
# List live videos
1159+
api_response = api_instance.list_live_videos(applicant_id)
1160+
pprint(api_response)
1161+
except ApiException as e:
1162+
print("Exception when calling DefaultApi->list_live_videos: %s\n" % e)
1163+
```
1164+
1165+
### Parameters
1166+
1167+
Name | Type | Description | Notes
1168+
------------- | ------------- | ------------- | -------------
1169+
**applicant_id** | **str**| The id of the applicant the live videos belong to. |
1170+
1171+
### Return type
1172+
1173+
[**LiveVideosList**](LiveVideosList.md)
1174+
1175+
### Authorization
1176+
1177+
[Token](../README.md#Token)
1178+
1179+
### HTTP request headers
1180+
1181+
- **Content-Type**: Not defined
1182+
- **Accept**: application/json
1183+
1184+
[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md)
1185+
10281186
# **list_report_type_groups**
10291187
> ReportTypeGroupsList list_report_type_groups()
10301188

‎docs/LivePhoto.md‎

Lines changed: 3 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -3,10 +3,10 @@
33
## Properties
44
Name | Type | Description | Notes
55
------------ | ------------- | ------------- | -------------
6-
**id** | **str** | The unique identifier for the document. | [optional]
7-
**created_at** | **datetime** | The date and time at which the document was uploaded. | [optional]
6+
**id** | **str** | The unique identifier for the photo. | [optional]
7+
**created_at** | **datetime** | The date and time at which the photo was uploaded. | [optional]
88
**href** | **str** | The uri of this resource. | [optional]
9-
**download_href** | **str** | The uri that can be used to download the document. | [optional]
9+
**download_href** | **str** | The uri that can be used to download the photo. | [optional]
1010
**file_name** | **str** | The name of the uploaded file. | [optional]
1111
**file_size** | **int** | The size of the file in bytes. | [optional]
1212
**file_type** | **str** | The file type of the uploaded file. | [optional]

‎onfido/__init__.py‎

Lines changed: 3 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -14,7 +14,7 @@
1414

1515
from __future__ import absolute_import
1616

17-
__version__ = "2.0.0"
17+
__version__ = "2.1.0"
1818

1919
# import apis into sdk package
2020
from onfido.api.default_api import DefaultApi
@@ -38,6 +38,8 @@
3838
from onfido.models.id_number import IdNumber
3939
from onfido.models.live_photo import LivePhoto
4040
from onfido.models.live_photos_list import LivePhotosList
41+
from onfido.models.live_video import LiveVideo
42+
from onfido.models.live_videos_list import LiveVideosList
4143
from onfido.models.report import Report
4244
from onfido.models.report_document import ReportDocument
4345
from onfido.models.report_option import ReportOption

0 commit comments

Comments
 (0)