New client release: 1.3.0

Author: Engineering at Onfido

README.md

@@ -4,8 +4,8 @@ The Onfido API is used to submit check requests.
 This Python package is automatically generated by the [Swagger Codegen](https://github.com/swagger-api/swagger-codegen) project:
 
 - API version: 2.0.0
-- Package version: 1.2.0
-- Build date: 2018-04-16T08:37:44.590Z
+- Package version: 1.3.0
+- Build date: 2018-06-18T15:35:27.640Z
 - Build package: class io.swagger.codegen.languages.PythonClientCodegen
 
 ## Requirements.
@@ -24,7 +24,7 @@ pip install git+https://github.com/onfido/api-python-client.git
 
 Then import the package:
 ```python
-import onfido 
+import onfido
 ```
 
 ### Setuptools
@@ -72,7 +72,7 @@ address.town = 'London'
 address.postcode = 'SW4 6EH'
 address.country = 'GBR'
 
-applicant.addresses = [address];
+applicant.addresses = [address]
 
 # setting check request details
 check = onfido.CheckCreationRequest()
@@ -81,9 +81,9 @@ check.type = 'express'
 report = onfido.Report()
 report.name = 'identity'
 
-check.reports = [report];
+check.reports = [report]
 
-try: 
+try:
     # Create Applicant
     api_response = api_instance.create_applicant(data=applicant)
     applicant_id = api_response.id
@@ -153,3 +153,4 @@ Class | Method | HTTP request | Description
  - [ReportsList](docs/ReportsList.md)
  - [Webhook](docs/Webhook.md)
  - [WebhooksList](docs/WebhooksList.md)
+

docs/DefaultApi.md

@@ -631,7 +631,7 @@ Name | Type | Description  | Notes
 [**Webhook**](Webhook.md)
 
 # **list_applicants**
-> ApplicantsList list_applicants()
+> ApplicantsList list_applicants(page=page, per_page=per_page)
 
 List Applicants
 
@@ -649,24 +649,30 @@ onfido.configuration.api_key_prefix['Authorization'] = 'Token'
 
 # create an instance of the API class
 api_instance = onfido.DefaultApi()
+page = 'page_example' # str | The page to return. Defaults to the first page if omitted. The first page is `page=1` (optional)
+per_page = 'per_page_example' # str | The number of objects per page. Defaults to 20 if omitted. (optional)
 
 try: 
     # List Applicants
-    api_response = api_instance.list_applicants()
+    api_response = api_instance.list_applicants(page=page, per_page=per_page)
     pprint(api_response)
 except ApiException as e:
     pprint(e.body)
 ```
 
 ### Parameters
-This endpoint does not need any parameter.
+
+Name | Type | Description  | Notes
+------------- | ------------- | ------------- | -------------
+ **page** | **str**| The page to return. Defaults to the first page if omitted. The first page is `page=1` | [optional] 
+ **per_page** | **str**| The number of objects per page. Defaults to 20 if omitted. | [optional] 
 
 ### Return type
 
 [**ApplicantsList**](ApplicantsList.md)
 
 # **list_checks**
-> ChecksList list_checks(applicant_id)
+> ChecksList list_checks(applicant_id, page=page, per_page=per_page)
 
 Retrieve Checks
 
@@ -685,10 +691,12 @@ onfido.configuration.api_key_prefix['Authorization'] = 'Token'
 # create an instance of the API class
 api_instance = onfido.DefaultApi()
 applicant_id = 'applicant_id_example' # str | 
+page = 'page_example' # str | The page to return. Defaults to the first page if omitted. The first page is `page=1` (optional)
+per_page = 'per_page_example' # str | The number of objects per page. Defaults to 20 if omitted. (optional)
 
 try: 
     # Retrieve Checks
-    api_response = api_instance.list_checks(applicant_id)
+    api_response = api_instance.list_checks(applicant_id, page=page, per_page=per_page)
     pprint(api_response)
 except ApiException as e:
     pprint(e.body)
@@ -699,6 +707,8 @@ except ApiException as e:
 Name | Type | Description  | Notes
 ------------- | ------------- | ------------- | -------------
  **applicant_id** | **str**|  | 
+ **page** | **str**| The page to return. Defaults to the first page if omitted. The first page is `page=1` | [optional] 
+ **per_page** | **str**| The number of objects per page. Defaults to 20 if omitted. | [optional] 
 
 ### Return type
 

onfido/api_client.py

@@ -73,7 +73,7 @@ def __init__(self, host=None, header_name=None, header_value=None, cookie=None):
             self.host = host
         self.cookie = cookie
         # Set default User-Agent.
-        self.user_agent = 'Swagger-Codegen/1.2.0/python'
+        self.user_agent = 'Swagger-Codegen/1.3.0/python'
 
     @property
     def user_agent(self):

onfido/apis/default_api.py

@@ -1749,6 +1749,8 @@ def list_applicants(self, **kwargs):
 
         :param callback function: The callback function
             for asynchronous request. (optional)
+        :param str page: The page to return. Defaults to the first page if omitted. The first page is `page=1`
+        :param str per_page: The number of objects per page. Defaults to 20 if omitted.
         :return: ApplicantsList
                  If the method is called asynchronously,
                  returns the request thread.
@@ -1775,12 +1777,14 @@ def list_applicants_with_http_info(self, **kwargs):
 
         :param callback function: The callback function
             for asynchronous request. (optional)
+        :param str page: The page to return. Defaults to the first page if omitted. The first page is `page=1`
+        :param str per_page: The number of objects per page. Defaults to 20 if omitted.
         :return: ApplicantsList
                  If the method is called asynchronously,
                  returns the request thread.
         """
 
-        all_params = []
+        all_params = ['page', 'per_page']
         all_params.append('callback')
         all_params.append('_return_http_data_only')
         all_params.append('_preload_content')
@@ -1802,6 +1806,10 @@ def list_applicants_with_http_info(self, **kwargs):
         path_params = {}
 
         query_params = {}
+        if 'page' in params:
+            query_params['page'] = params['page']
+        if 'per_page' in params:
+            query_params['per_page'] = params['per_page']
 
         header_params = {}
 
@@ -1853,6 +1861,8 @@ def list_checks(self, applicant_id, **kwargs):
         :param callback function: The callback function
             for asynchronous request. (optional)
         :param str applicant_id:  (required)
+        :param str page: The page to return. Defaults to the first page if omitted. The first page is `page=1`
+        :param str per_page: The number of objects per page. Defaults to 20 if omitted.
         :return: ChecksList
                  If the method is called asynchronously,
                  returns the request thread.
@@ -1880,12 +1890,14 @@ def list_checks_with_http_info(self, applicant_id, **kwargs):
         :param callback function: The callback function
             for asynchronous request. (optional)
         :param str applicant_id:  (required)
+        :param str page: The page to return. Defaults to the first page if omitted. The first page is `page=1`
+        :param str per_page: The number of objects per page. Defaults to 20 if omitted.
         :return: ChecksList
                  If the method is called asynchronously,
                  returns the request thread.
         """
 
-        all_params = ['applicant_id']
+        all_params = ['applicant_id', 'page', 'per_page']
         all_params.append('callback')
         all_params.append('_return_http_data_only')
         all_params.append('_preload_content')
@@ -1912,6 +1924,10 @@ def list_checks_with_http_info(self, applicant_id, **kwargs):
             path_params['applicant_id'] = params['applicant_id']
 
         query_params = {}
+        if 'page' in params:
+            query_params['page'] = params['page']
+        if 'per_page' in params:
+            query_params['per_page'] = params['per_page']
 
         header_params = {}
 

onfido/configuration.py

@@ -233,5 +233,5 @@ def to_debug_report(self):
                "OS: {env}\n"\
                "Python Version: {pyversion}\n"\
                "Version of the API: 2.0.0\n"\
-               "SDK Package Version: 1.2.0".\
+               "SDK Package Version: 1.3.0".\
                format(env=sys.platform, pyversion=sys.version)

setup.py

@@ -26,7 +26,7 @@
 from setuptools import setup, find_packages
 
 NAME = "onfido"
-VERSION = "1.2.0"
+VERSION = "1.3.0"
 
 # To install the library, run the following
 #