Skip to content

Commit 3361bc6

Browse files
author
Peter IJlst
committed
initial commit
0 parents  commit 3361bc6

Some content is hidden

Large Commits have some content hidden by default. Use the searchbox below for content that may be hidden.

70 files changed

+4512
-0
lines changed

‎README.md

+113
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,113 @@
1+
# org.openapitools.client - Kotlin client library for Onfido API
2+
3+
## Requires
4+
5+
* Kotlin 1.1.2
6+
* Gradle 3.3
7+
8+
## Build
9+
10+
First, create the gradle wrapper script:
11+
12+
```
13+
gradle wrapper
14+
```
15+
16+
Then, run:
17+
18+
```
19+
./gradlew check assemble
20+
```
21+
22+
This runs all tests and packages the library.
23+
24+
## Features/Implementation Notes
25+
26+
* Supports JSON inputs/outputs, File inputs, and Form inputs.
27+
* Supports collection formats for query parameters: csv, tsv, ssv, pipes.
28+
* Some Kotlin and Java types are fully qualified to avoid conflicts with types defined in OpenAPI definitions.
29+
* Implementation of ApiClient is intended to reduce method counts, specifically to benefit Android targets.
30+
31+
<a name="documentation-for-api-endpoints"></a>
32+
## Documentation for API Endpoints
33+
34+
All URIs are relative to *https://api.onfido.com/v2*
35+
36+
Class | Method | HTTP request | Description
37+
------------ | ------------- | ------------- | -------------
38+
*DefaultApi* | [**cancelReport**](docs/DefaultApi.md#cancelreport) | **POST** /checks/{check_id}/reports/{report_id}/cancel | This endpoint is for cancelling individual paused reports.
39+
*DefaultApi* | [**createApplicant**](docs/DefaultApi.md#createapplicant) | **POST** /applicants | Create Applicant
40+
*DefaultApi* | [**createCheck**](docs/DefaultApi.md#createcheck) | **POST** /applicants/{applicant_id}/checks | Create a check
41+
*DefaultApi* | [**createWebhook**](docs/DefaultApi.md#createwebhook) | **POST** /webhooks | Create a webhook
42+
*DefaultApi* | [**destroyApplicant**](docs/DefaultApi.md#destroyapplicant) | **DELETE** /applicants/{applicant_id} | Delete Applicant
43+
*DefaultApi* | [**downloadDocument**](docs/DefaultApi.md#downloaddocument) | **GET** /applicants/{applicant_id}/documents/{document_id}/download | Download a documents raw data
44+
*DefaultApi* | [**downloadLivePhoto**](docs/DefaultApi.md#downloadlivephoto) | **GET** /live_photos/{live_photo_id}/download | Download live photo
45+
*DefaultApi* | [**downloadLiveVideo**](docs/DefaultApi.md#downloadlivevideo) | **GET** /live_videos/{live_video_id}/download | Download live video
46+
*DefaultApi* | [**findAddresses**](docs/DefaultApi.md#findaddresses) | **GET** /addresses/pick | Search for addresses by postcode
47+
*DefaultApi* | [**findApplicant**](docs/DefaultApi.md#findapplicant) | **GET** /applicants/{applicant_id} | Retrieve Applicant
48+
*DefaultApi* | [**findCheck**](docs/DefaultApi.md#findcheck) | **GET** /applicants/{applicant_id}/checks/{check_id} | Retrieve a Check
49+
*DefaultApi* | [**findDocument**](docs/DefaultApi.md#finddocument) | **GET** /applicants/{applicant_id}/documents/{document_id} | A single document can be retrieved by calling this endpoint with the document’s unique identifier.
50+
*DefaultApi* | [**findLivePhoto**](docs/DefaultApi.md#findlivephoto) | **GET** /live_photos/{live_photo_id} | Retrieve live photo
51+
*DefaultApi* | [**findLiveVideo**](docs/DefaultApi.md#findlivevideo) | **GET** /live_videos/{live_video_id} | Retrieve live video
52+
*DefaultApi* | [**findReport**](docs/DefaultApi.md#findreport) | **GET** /checks/{check_id}/reports/{report_id} | A single report can be retrieved using this endpoint with the corresponding unique identifier.
53+
*DefaultApi* | [**findReportTypeGroup**](docs/DefaultApi.md#findreporttypegroup) | **GET** /report_type_groups/{report_type_group_id} | Retrieve single report type group object
54+
*DefaultApi* | [**findWebhook**](docs/DefaultApi.md#findwebhook) | **GET** /webhooks/{webhook_id} | Retrieve a Webhook
55+
*DefaultApi* | [**listApplicants**](docs/DefaultApi.md#listapplicants) | **GET** /applicants | List Applicants
56+
*DefaultApi* | [**listChecks**](docs/DefaultApi.md#listchecks) | **GET** /applicants/{applicant_id}/checks | Retrieve Checks
57+
*DefaultApi* | [**listDocuments**](docs/DefaultApi.md#listdocuments) | **GET** /applicants/{applicant_id}/documents | List documents
58+
*DefaultApi* | [**listLivePhotos**](docs/DefaultApi.md#listlivephotos) | **GET** /live_photos | List live photos
59+
*DefaultApi* | [**listLiveVideos**](docs/DefaultApi.md#listlivevideos) | **GET** /live_videos | List live videos
60+
*DefaultApi* | [**listReportTypeGroups**](docs/DefaultApi.md#listreporttypegroups) | **GET** /report_type_groups | Retrieve all report type groups
61+
*DefaultApi* | [**listReports**](docs/DefaultApi.md#listreports) | **GET** /checks/{check_id}/reports | All the reports belonging to a particular check can be listed from this endpoint.
62+
*DefaultApi* | [**listWebhooks**](docs/DefaultApi.md#listwebhooks) | **GET** /webhooks | List webhooks
63+
*DefaultApi* | [**restoreApplicant**](docs/DefaultApi.md#restoreapplicant) | **POST** /applicants/{applicant_id}/restore | Restore Applicant
64+
*DefaultApi* | [**resumeCheck**](docs/DefaultApi.md#resumecheck) | **POST** /checks/{check_id}/resume | Resume a Check
65+
*DefaultApi* | [**resumeReport**](docs/DefaultApi.md#resumereport) | **POST** /checks/{check_id}/reports/{report_id}/resume | This endpoint is for resuming individual paused reports.
66+
*DefaultApi* | [**updateApplicant**](docs/DefaultApi.md#updateapplicant) | **PUT** /applicants/{applicant_id} | Update Applicant
67+
*DefaultApi* | [**uploadDocument**](docs/DefaultApi.md#uploaddocument) | **POST** /applicants/{applicant_id}/documents | Upload a document
68+
*DefaultApi* | [**uploadLivePhoto**](docs/DefaultApi.md#uploadlivephoto) | **POST** /live_photos | Upload live photo
69+
70+
71+
<a name="documentation-for-models"></a>
72+
## Documentation for Models
73+
74+
- [org.openapitools.client.models.Address](docs/Address.md)
75+
- [org.openapitools.client.models.Applicant](docs/Applicant.md)
76+
- [org.openapitools.client.models.ApplicantsList](docs/ApplicantsList.md)
77+
- [org.openapitools.client.models.Check](docs/Check.md)
78+
- [org.openapitools.client.models.CheckCommon](docs/CheckCommon.md)
79+
- [org.openapitools.client.models.CheckWithReportIds](docs/CheckWithReportIds.md)
80+
- [org.openapitools.client.models.ChecksList](docs/ChecksList.md)
81+
- [org.openapitools.client.models.Document](docs/Document.md)
82+
- [org.openapitools.client.models.DocumentsList](docs/DocumentsList.md)
83+
- [org.openapitools.client.models.Error](docs/Error.md)
84+
- [org.openapitools.client.models.GenericAddress](docs/GenericAddress.md)
85+
- [org.openapitools.client.models.GenericAddressesList](docs/GenericAddressesList.md)
86+
- [org.openapitools.client.models.IdNumber](docs/IdNumber.md)
87+
- [org.openapitools.client.models.InlineObject](docs/InlineObject.md)
88+
- [org.openapitools.client.models.InlineObject1](docs/InlineObject1.md)
89+
- [org.openapitools.client.models.LivePhoto](docs/LivePhoto.md)
90+
- [org.openapitools.client.models.LivePhotosList](docs/LivePhotosList.md)
91+
- [org.openapitools.client.models.LiveVideo](docs/LiveVideo.md)
92+
- [org.openapitools.client.models.LiveVideosList](docs/LiveVideosList.md)
93+
- [org.openapitools.client.models.Report](docs/Report.md)
94+
- [org.openapitools.client.models.ReportDocument](docs/ReportDocument.md)
95+
- [org.openapitools.client.models.ReportOption](docs/ReportOption.md)
96+
- [org.openapitools.client.models.ReportType](docs/ReportType.md)
97+
- [org.openapitools.client.models.ReportTypeGroup](docs/ReportTypeGroup.md)
98+
- [org.openapitools.client.models.ReportTypeGroupsList](docs/ReportTypeGroupsList.md)
99+
- [org.openapitools.client.models.ReportsList](docs/ReportsList.md)
100+
- [org.openapitools.client.models.Webhook](docs/Webhook.md)
101+
- [org.openapitools.client.models.WebhooksList](docs/WebhooksList.md)
102+
103+
104+
<a name="documentation-for-authorization"></a>
105+
## Documentation for Authorization
106+
107+
<a name="Token"></a>
108+
### Token
109+
110+
- **Type**: API key
111+
- **API key parameter name**: Authorization
112+
- **Location**: HTTP header
113+

‎build.gradle

+33
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,33 @@
1+
group 'org.openapitools'
2+
version '1.0.0'
3+
4+
task wrapper(type: Wrapper) {
5+
gradleVersion = '3.3'
6+
distributionUrl = "https://services.gradle.org/distributions/gradle-$gradleVersion-all.zip"
7+
}
8+
9+
buildscript {
10+
ext.kotlin_version = '1.1.2'
11+
12+
repositories {
13+
mavenCentral()
14+
}
15+
dependencies {
16+
classpath "org.jetbrains.kotlin:kotlin-gradle-plugin:$kotlin_version"
17+
}
18+
}
19+
20+
apply plugin: 'kotlin'
21+
22+
repositories {
23+
mavenCentral()
24+
}
25+
26+
dependencies {
27+
compile "org.jetbrains.kotlin:kotlin-stdlib-jre8:$kotlin_version"
28+
compile "com.squareup.moshi:moshi-kotlin:1.5.0"
29+
compile "com.squareup.moshi:moshi-adapters:1.5.0"
30+
compile "com.squareup.okhttp3:okhttp:3.8.0"
31+
compile "org.threeten:threetenbp:1.3.6"
32+
testCompile "io.kotlintest:kotlintest:2.0.2"
33+
}

‎docs/Address.md

+20
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,20 @@
1+
2+
# Address
3+
4+
## Properties
5+
Name | Type | Description | Notes
6+
------------ | ------------- | ------------- | -------------
7+
**flatNumber** | **kotlin.String** | The flat number of this address | [optional]
8+
**buildingNumber** | **kotlin.String** | The building number of this address | [optional]
9+
**buildingName** | **kotlin.String** | The building name of this address | [optional]
10+
**street** | **kotlin.String** | The street of the applicant’s address | [optional]
11+
**subStreet** | **kotlin.String** | The sub-street of the applicant’s address | [optional]
12+
**town** | **kotlin.String** | The town of the applicant’s address | [optional]
13+
**postcode** | **kotlin.String** | The postcode or ZIP of the applicant’s address | [optional]
14+
**country** | **kotlin.String** | The 3 character ISO country code of this address. For example, GBR is the country code for the United Kingdom | [optional]
15+
**startDate** | [**java.time.LocalDateTime**](java.time.LocalDateTime.md) | The date the applicant started living at this address | [optional]
16+
**endDate** | [**java.time.LocalDateTime**](java.time.LocalDateTime.md) | The date the applicant left this address. If current residence, leave null | [optional]
17+
**state** | **kotlin.String** | The address state. US states must use the USPS abbreviation (see also ISO 3166-2:US), for example AK, CA, or TX. | [optional]
18+
19+
20+

‎docs/Applicant.md

+31
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,31 @@
1+
2+
# Applicant
3+
4+
## Properties
5+
Name | Type | Description | Notes
6+
------------ | ------------- | ------------- | -------------
7+
**id** | **kotlin.String** | The unique identifier for the applicant. Read-only. | [optional]
8+
**createdAt** | [**java.time.LocalDateTime**](java.time.LocalDateTime.md) | The date and time when this applicant was created. Read-only. | [optional]
9+
**deleteAt** | [**java.time.LocalDateTime**](java.time.LocalDateTime.md) | The date and time when this applicant is scheduled to be deleted. Read-only. | [optional]
10+
**href** | **kotlin.String** | The uri of this resource. Read-only. | [optional]
11+
**sandbox** | **kotlin.Boolean** | Read-only. | [optional]
12+
**title** | **kotlin.String** | The applicant’s title | [optional]
13+
**firstName** | **kotlin.String** | The applicant’s first name | [optional]
14+
**middleName** | **kotlin.String** | The applicant’s middle name(s) or initial | [optional]
15+
**lastName** | **kotlin.String** | The applicant’s surname | [optional]
16+
**email** | **kotlin.String** | The applicant’s email address. Required if doing a US check or a standard UK check. | [optional]
17+
**gender** | **kotlin.String** | The applicant’s gender. Valid values are male and female. | [optional]
18+
**dob** | [**java.time.LocalDateTime**](java.time.LocalDateTime.md) | The applicant’s date of birth | [optional]
19+
**telephone** | **kotlin.String** | The applicant’s landline phone number | [optional]
20+
**mobile** | **kotlin.String** | The applicant’s mobile phone number | [optional]
21+
**country** | **kotlin.String** | The country where this applicant will be checked. This must be a three-letter ISO code e.g. GBR or USA | [optional]
22+
**nationality** | **kotlin.String** | The applicant&#39;s nationality. This must be a three-letter ISO code e.g. GBR or USA | [optional]
23+
**mothersMaidenName** | **kotlin.String** | The applicant’s mothers maiden name | [optional]
24+
**countryOfBirth** | **kotlin.String** | The applicant’s country of birth | [optional]
25+
**townOfBirth** | **kotlin.String** | The applicant’s town of birth | [optional]
26+
**previousLastName** | **kotlin.String** | The applicant’s previous last name | [optional]
27+
**addresses** | [**kotlin.Array&lt;Address&gt;**](Address.md) | | [optional]
28+
**idNumbers** | [**kotlin.Array&lt;IdNumber&gt;**](IdNumber.md) | | [optional]
29+
30+
31+

‎docs/ApplicantsList.md

+10
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,10 @@
1+
2+
# ApplicantsList
3+
4+
## Properties
5+
Name | Type | Description | Notes
6+
------------ | ------------- | ------------- | -------------
7+
**applicants** | [**kotlin.Array&lt;Applicant&gt;**](Applicant.md) | | [optional]
8+
9+
10+

‎docs/Check.md

+26
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,26 @@
1+
2+
# Check
3+
4+
## Properties
5+
Name | Type | Description | Notes
6+
------------ | ------------- | ------------- | -------------
7+
**id** | **kotlin.String** | The unique identifier for the check. Read-only. | [optional]
8+
**createdAt** | [**java.time.LocalDateTime**](java.time.LocalDateTime.md) | The date and time when this check was created. Read-only. | [optional]
9+
**href** | **kotlin.String** | The uri of this resource. Read-only. | [optional]
10+
**status** | **kotlin.String** | The current state of the check in the checking process. Read-only. | [optional]
11+
**result** | **kotlin.String** | The overall result of the check, based on the results of the constituent reports. Read-only. | [optional]
12+
**downloadUri** | **kotlin.String** | A link to a PDF output of the check results. Append &#x60;.pdf&#x60; to get the pdf file. Read-only. | [optional]
13+
**formUri** | **kotlin.String** | A link to the applicant form, if the check is of type &#x60;standard&#x60;. Read-only. | [optional]
14+
**redirectUri** | **kotlin.String** | For &#x60;standard&#x60; checks, redirect to this URI when the applicant has submitted their data. Read-only. | [optional]
15+
**resultsUri** | **kotlin.String** | A link to the corresponding results page on the Onfido dashboard. | [optional]
16+
**type** | **kotlin.String** | The type of the check, &#x60;standard&#x60; or &#x60;express&#x60;. |
17+
**reportTypeGroups** | **kotlin.Array&lt;kotlin.String&gt;** | Array containing ids of the Report type groups being requested for. Write-only. | [optional]
18+
**tags** | **kotlin.Array&lt;kotlin.String&gt;** | Array of tags being assigned to this check. | [optional]
19+
**suppressFormEmails** | **kotlin.Boolean** | For standard checks, applicant form will not be automatically sent if this is set to true. You can manually send the form at any time after the check has been created, using the link found in the form_uri attribute of the check object. Write-only. | [optional]
20+
**chargeApplicantForCheck** | **kotlin.Boolean** | For standard checks, applicants will be presented with a mandatory payment screen before they can submit the applicant form, if this is set to true. In this case, your account will not be charged. Write-only. | [optional]
21+
**brandId** | **kotlin.String** | ID of the brand under which the check should be conducted. Write-only. | [optional]
22+
**async** | **kotlin.Boolean** | If this is set to true, we will queue checks for processing and return a response immediately. You can configure webhooks to notify you when the report is complete. Write-only. | [optional]
23+
**reports** | [**kotlin.Array&lt;Report&gt;**](Report.md) | An array of reports. | [optional]
24+
25+
26+

‎docs/CheckCommon.md

+25
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,25 @@
1+
2+
# CheckCommon
3+
4+
## Properties
5+
Name | Type | Description | Notes
6+
------------ | ------------- | ------------- | -------------
7+
**id** | **kotlin.String** | The unique identifier for the check. Read-only. | [optional]
8+
**createdAt** | [**java.time.LocalDateTime**](java.time.LocalDateTime.md) | The date and time when this check was created. Read-only. | [optional]
9+
**href** | **kotlin.String** | The uri of this resource. Read-only. | [optional]
10+
**status** | **kotlin.String** | The current state of the check in the checking process. Read-only. | [optional]
11+
**result** | **kotlin.String** | The overall result of the check, based on the results of the constituent reports. Read-only. | [optional]
12+
**downloadUri** | **kotlin.String** | A link to a PDF output of the check results. Append &#x60;.pdf&#x60; to get the pdf file. Read-only. | [optional]
13+
**formUri** | **kotlin.String** | A link to the applicant form, if the check is of type &#x60;standard&#x60;. Read-only. | [optional]
14+
**redirectUri** | **kotlin.String** | For &#x60;standard&#x60; checks, redirect to this URI when the applicant has submitted their data. Read-only. | [optional]
15+
**resultsUri** | **kotlin.String** | A link to the corresponding results page on the Onfido dashboard. | [optional]
16+
**type** | **kotlin.String** | The type of the check, &#x60;standard&#x60; or &#x60;express&#x60;. | [optional]
17+
**reportTypeGroups** | **kotlin.Array&lt;kotlin.String&gt;** | Array containing ids of the Report type groups being requested for. Write-only. | [optional]
18+
**tags** | **kotlin.Array&lt;kotlin.String&gt;** | Array of tags being assigned to this check. | [optional]
19+
**suppressFormEmails** | **kotlin.Boolean** | For standard checks, applicant form will not be automatically sent if this is set to true. You can manually send the form at any time after the check has been created, using the link found in the form_uri attribute of the check object. Write-only. | [optional]
20+
**chargeApplicantForCheck** | **kotlin.Boolean** | For standard checks, applicants will be presented with a mandatory payment screen before they can submit the applicant form, if this is set to true. In this case, your account will not be charged. Write-only. | [optional]
21+
**brandId** | **kotlin.String** | ID of the brand under which the check should be conducted. Write-only. | [optional]
22+
**async** | **kotlin.Boolean** | If this is set to true, we will queue checks for processing and return a response immediately. You can configure webhooks to notify you when the report is complete. Write-only. | [optional]
23+
24+
25+

0 commit comments

Comments
 (0)