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

Commit 2e3d9b8

Browse files
author
Engineering at Onfido
committed
New client release: 3.1.0
1 parent cb1af6f commit 2e3d9b8

39 files changed

Lines changed: 534 additions & 38 deletions

‎README.md‎

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

88
- API version: 2.0.0
9-
- Package version: 3.0.0
9+
- Package version: 3.1.0
1010
- Build package: org.openapitools.codegen.languages.JavascriptClientCodegen
1111

1212
## Installation
@@ -131,6 +131,7 @@ Class | Method | HTTP request | Description
131131
*Onfido.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.
132132
*Onfido.DefaultApi* | [**findReportTypeGroup**](docs/DefaultApi.md#findReportTypeGroup) | **GET** /report_type_groups/{report_type_group_id} | Retrieve single report type group object
133133
*Onfido.DefaultApi* | [**findWebhook**](docs/DefaultApi.md#findWebhook) | **GET** /webhooks/{webhook_id} | Retrieve a Webhook
134+
*Onfido.DefaultApi* | [**generateSdkToken**](docs/DefaultApi.md#generateSdkToken) | **POST** /sdk_token | Generate a SDK token
134135
*Onfido.DefaultApi* | [**listApplicants**](docs/DefaultApi.md#listApplicants) | **GET** /applicants | List Applicants
135136
*Onfido.DefaultApi* | [**listChecks**](docs/DefaultApi.md#listChecks) | **GET** /applicants/{applicant_id}/checks | Retrieve Checks
136137
*Onfido.DefaultApi* | [**listDocuments**](docs/DefaultApi.md#listDocuments) | **GET** /applicants/{applicant_id}/documents | List documents
@@ -173,6 +174,8 @@ Class | Method | HTTP request | Description
173174
- [Onfido.ReportTypeGroup](docs/ReportTypeGroup.md)
174175
- [Onfido.ReportTypeGroupsList](docs/ReportTypeGroupsList.md)
175176
- [Onfido.ReportsList](docs/ReportsList.md)
177+
- [Onfido.SdkTokenRequest](docs/SdkTokenRequest.md)
178+
- [Onfido.SdkTokenResponse](docs/SdkTokenResponse.md)
176179
- [Onfido.Webhook](docs/Webhook.md)
177180
- [Onfido.WebhooksList](docs/WebhooksList.md)
178181

‎docs/DefaultApi.md‎

Lines changed: 45 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -21,6 +21,7 @@ Method | HTTP request | Description
2121
[**findReport**](DefaultApi.md#findReport) | **GET** /checks/{check_id}/reports/{report_id} | A single report can be retrieved using this endpoint with the corresponding unique identifier.
2222
[**findReportTypeGroup**](DefaultApi.md#findReportTypeGroup) | **GET** /report_type_groups/{report_type_group_id} | Retrieve single report type group object
2323
[**findWebhook**](DefaultApi.md#findWebhook) | **GET** /webhooks/{webhook_id} | Retrieve a Webhook
24+
[**generateSdkToken**](DefaultApi.md#generateSdkToken) | **POST** /sdk_token | Generate a SDK token
2425
[**listApplicants**](DefaultApi.md#listApplicants) | **GET** /applicants | List Applicants
2526
[**listChecks**](DefaultApi.md#listChecks) | **GET** /applicants/{applicant_id}/checks | Retrieve Checks
2627
[**listDocuments**](DefaultApi.md#listDocuments) | **GET** /applicants/{applicant_id}/documents | List documents
@@ -801,6 +802,50 @@ Name | Type | Description | Notes
801802
- **Content-Type**: Not defined
802803
- **Accept**: application/json
803804

805+
<a name="generateSdkToken"></a>
806+
# **generateSdkToken**
807+
> SdkTokenResponse generateSdkToken(SdkTokenRequest)
808+
809+
Generate a SDK token
810+
811+
### Example
812+
```javascript
813+
var Onfido = require('onfido');
814+
var defaultClient = Onfido.ApiClient.instance;
815+
// Configure API key authorization: Token
816+
const token_auth = defaultClient.authentications['Token'];
817+
token_auth.apiKey = 'token=' + 'YOUR API KEY';
818+
token_auth.apiKeyPrefix = 'Token';
819+
820+
var apiInstance = new Onfido.DefaultApi();
821+
var SdkTokenRequest = new Onfido.SdkTokenRequest(); // SdkTokenRequest |
822+
apiInstance.generateSdkToken(SdkTokenRequest).then(function(data) {
823+
console.log('API called successfully. Returned data: ' + data);
824+
}, function(error) {
825+
console.error(error);
826+
});
827+
828+
```
829+
830+
### Parameters
831+
832+
Name | Type | Description | Notes
833+
------------- | ------------- | ------------- | -------------
834+
**SdkTokenRequest** | [**SdkTokenRequest**](SdkTokenRequest.md)| |
835+
836+
### Return type
837+
838+
[**SdkTokenResponse**](SdkTokenResponse.md)
839+
840+
### Authorization
841+
842+
[Token](../README.md#Token)
843+
844+
### HTTP request headers
845+
846+
- **Content-Type**: application/json
847+
- **Accept**: application/json
848+
804849
<a name="listApplicants"></a>
805850
# **listApplicants**
806851
> ApplicantsList listApplicants(opts)

‎docs/SdkTokenRequest.md‎

Lines changed: 9 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,9 @@
1+
# Onfido.SdkTokenRequest
2+
3+
## Properties
4+
Name | Type | Description | Notes
5+
------------ | ------------- | ------------- | -------------
6+
**applicant_id** | **String** | The unique identifier of the applicant |
7+
**referrer** | **String** | The referrer URL pattern |
8+
9+

‎docs/SdkTokenResponse.md‎

Lines changed: 8 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,8 @@
1+
# Onfido.SdkTokenResponse
2+
3+
## Properties
4+
Name | Type | Description | Notes
5+
------------ | ------------- | ------------- | -------------
6+
**token** | **String** | The generated SDK token | [optional]
7+
8+

‎package.json‎

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1,6 +1,6 @@
11
{
22
"name": "onfido",
3-
"version": "3.0.0",
3+
"version": "3.1.0",
44
"description": "Client library for the Onfido API.",
55
"license": "MIT",
66
"main": "src/index.js",

‎src/ApiClient.js‎

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -32,7 +32,7 @@
3232

3333
/**
3434
* @module ApiClient
35-
* @version 3.0.0
35+
* @version 3.1.0
3636
*/
3737

3838
/**

‎src/api/DefaultApi.js‎

Lines changed: 55 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -16,24 +16,24 @@
1616
(function(root, factory) {
1717
if (typeof define === 'function' && define.amd) {
1818
// AMD. Register as an anonymous module.
19-
define(['ApiClient', 'model/Applicant', 'model/ApplicantsList', 'model/Check', 'model/CheckWithReportIds', 'model/ChecksList', 'model/Document', 'model/DocumentsList', 'model/Error', 'model/GenericAddressesList', 'model/LivePhoto', 'model/LivePhotosList', 'model/LiveVideo', 'model/LiveVideosList', 'model/Report', 'model/ReportTypeGroup', 'model/ReportTypeGroupsList', 'model/ReportsList', 'model/Webhook', 'model/WebhooksList'], factory);
19+
define(['ApiClient', 'model/Applicant', 'model/ApplicantsList', 'model/Check', 'model/CheckWithReportIds', 'model/ChecksList', 'model/Document', 'model/DocumentsList', 'model/Error', 'model/GenericAddressesList', 'model/LivePhoto', 'model/LivePhotosList', 'model/LiveVideo', 'model/LiveVideosList', 'model/Report', 'model/ReportTypeGroup', 'model/ReportTypeGroupsList', 'model/ReportsList', 'model/SdkTokenRequest', 'model/SdkTokenResponse', 'model/Webhook', 'model/WebhooksList'], factory);
2020
} else if (typeof module === 'object' && module.exports) {
2121
// CommonJS-like environments that support module.exports, like Node.
22-
module.exports = factory(require('../ApiClient'), require('../model/Applicant'), require('../model/ApplicantsList'), require('../model/Check'), require('../model/CheckWithReportIds'), require('../model/ChecksList'), require('../model/Document'), require('../model/DocumentsList'), require('../model/Error'), require('../model/GenericAddressesList'), require('../model/LivePhoto'), require('../model/LivePhotosList'), require('../model/LiveVideo'), require('../model/LiveVideosList'), require('../model/Report'), require('../model/ReportTypeGroup'), require('../model/ReportTypeGroupsList'), require('../model/ReportsList'), require('../model/Webhook'), require('../model/WebhooksList'));
22+
module.exports = factory(require('../ApiClient'), require('../model/Applicant'), require('../model/ApplicantsList'), require('../model/Check'), require('../model/CheckWithReportIds'), require('../model/ChecksList'), require('../model/Document'), require('../model/DocumentsList'), require('../model/Error'), require('../model/GenericAddressesList'), require('../model/LivePhoto'), require('../model/LivePhotosList'), require('../model/LiveVideo'), require('../model/LiveVideosList'), require('../model/Report'), require('../model/ReportTypeGroup'), require('../model/ReportTypeGroupsList'), require('../model/ReportsList'), require('../model/SdkTokenRequest'), require('../model/SdkTokenResponse'), require('../model/Webhook'), require('../model/WebhooksList'));
2323
} else {
2424
// Browser globals (root is window)
2525
if (!root.Onfido) {
2626
root.Onfido = {};
2727
}
28-
root.Onfido.DefaultApi = factory(root.Onfido.ApiClient, root.Onfido.Applicant, root.Onfido.ApplicantsList, root.Onfido.Check, root.Onfido.CheckWithReportIds, root.Onfido.ChecksList, root.Onfido.Document, root.Onfido.DocumentsList, root.Onfido.Error, root.Onfido.GenericAddressesList, root.Onfido.LivePhoto, root.Onfido.LivePhotosList, root.Onfido.LiveVideo, root.Onfido.LiveVideosList, root.Onfido.Report, root.Onfido.ReportTypeGroup, root.Onfido.ReportTypeGroupsList, root.Onfido.ReportsList, root.Onfido.Webhook, root.Onfido.WebhooksList);
28+
root.Onfido.DefaultApi = factory(root.Onfido.ApiClient, root.Onfido.Applicant, root.Onfido.ApplicantsList, root.Onfido.Check, root.Onfido.CheckWithReportIds, root.Onfido.ChecksList, root.Onfido.Document, root.Onfido.DocumentsList, root.Onfido.Error, root.Onfido.GenericAddressesList, root.Onfido.LivePhoto, root.Onfido.LivePhotosList, root.Onfido.LiveVideo, root.Onfido.LiveVideosList, root.Onfido.Report, root.Onfido.ReportTypeGroup, root.Onfido.ReportTypeGroupsList, root.Onfido.ReportsList, root.Onfido.SdkTokenRequest, root.Onfido.SdkTokenResponse, root.Onfido.Webhook, root.Onfido.WebhooksList);
2929
}
30-
}(this, function(ApiClient, Applicant, ApplicantsList, Check, CheckWithReportIds, ChecksList, Document, DocumentsList, Error, GenericAddressesList, LivePhoto, LivePhotosList, LiveVideo, LiveVideosList, Report, ReportTypeGroup, ReportTypeGroupsList, ReportsList, Webhook, WebhooksList) {
30+
}(this, function(ApiClient, Applicant, ApplicantsList, Check, CheckWithReportIds, ChecksList, Document, DocumentsList, Error, GenericAddressesList, LivePhoto, LivePhotosList, LiveVideo, LiveVideosList, Report, ReportTypeGroup, ReportTypeGroupsList, ReportsList, SdkTokenRequest, SdkTokenResponse, Webhook, WebhooksList) {
3131
'use strict';
3232

3333
/**
3434
* Default service.
3535
* @module api/DefaultApi
36-
* @version 3.0.0
36+
* @version 3.1.0
3737
*/
3838

3939
/**
@@ -964,6 +964,56 @@
964964
}
965965

966966

967+
/**
968+
* Generate a SDK token
969+
* @param {module:model/SdkTokenRequest} SdkTokenRequest
970+
* @return {Promise} a {@link https://www.promisejs.org/|Promise}, with an object containing data of type {@link module:model/SdkTokenResponse} and HTTP response
971+
*/
972+
this.generateSdkTokenWithHttpInfo = function(SdkTokenRequest) {
973+
var postBody = SdkTokenRequest;
974+
975+
// verify the required parameter 'SdkTokenRequest' is set
976+
if (SdkTokenRequest === undefined || SdkTokenRequest === null) {
977+
throw new Error("Missing the required parameter 'SdkTokenRequest' when calling generateSdkToken");
978+
}
979+
980+
981+
var pathParams = {
982+
};
983+
var queryParams = {
984+
};
985+
var collectionQueryParams = {
986+
};
987+
var headerParams = {
988+
};
989+
var formParams = {
990+
};
991+
992+
var authNames = ['Token'];
993+
var contentTypes = ['application/json'];
994+
var accepts = ['application/json'];
995+
var returnType = SdkTokenResponse;
996+
997+
return this.apiClient.callApi(
998+
'/sdk_token', 'POST',
999+
pathParams, queryParams, collectionQueryParams, headerParams, formParams, postBody,
1000+
authNames, contentTypes, accepts, returnType
1001+
);
1002+
}
1003+
1004+
/**
1005+
* Generate a SDK token
1006+
* @param {module:model/SdkTokenRequest} SdkTokenRequest
1007+
* @return {Promise} a {@link https://www.promisejs.org/|Promise}, with data of type {@link module:model/SdkTokenResponse}
1008+
*/
1009+
this.generateSdkToken = function(SdkTokenRequest) {
1010+
return this.generateSdkTokenWithHttpInfo(SdkTokenRequest)
1011+
.then(function(response_and_data) {
1012+
return response_and_data.data;
1013+
});
1014+
}
1015+
1016+
9671017
/**
9681018
* List Applicants
9691019
* @param {Object} opts Optional parameters

‎src/index.js‎

Lines changed: 14 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -16,12 +16,12 @@
1616
(function(factory) {
1717
if (typeof define === 'function' && define.amd) {
1818
// AMD. Register as an anonymous module.
19-
define(['ApiClient', 'model/Address', 'model/Applicant', 'model/ApplicantsList', 'model/Check', 'model/CheckCommon', 'model/CheckWithReportIds', 'model/ChecksList', 'model/Document', 'model/DocumentsList', 'model/Error', 'model/GenericAddress', 'model/GenericAddressesList', 'model/IdNumber', 'model/LivePhoto', 'model/LivePhotosList', 'model/LiveVideo', 'model/LiveVideosList', 'model/Report', 'model/ReportDocument', 'model/ReportOption', 'model/ReportType', 'model/ReportTypeGroup', 'model/ReportTypeGroupsList', 'model/ReportsList', 'model/Webhook', 'model/WebhooksList', 'api/DefaultApi'], factory);
19+
define(['ApiClient', 'model/Address', 'model/Applicant', 'model/ApplicantsList', 'model/Check', 'model/CheckCommon', 'model/CheckWithReportIds', 'model/ChecksList', 'model/Document', 'model/DocumentsList', 'model/Error', 'model/GenericAddress', 'model/GenericAddressesList', 'model/IdNumber', 'model/LivePhoto', 'model/LivePhotosList', 'model/LiveVideo', 'model/LiveVideosList', 'model/Report', 'model/ReportDocument', 'model/ReportOption', 'model/ReportType', 'model/ReportTypeGroup', 'model/ReportTypeGroupsList', 'model/ReportsList', 'model/SdkTokenRequest', 'model/SdkTokenResponse', 'model/Webhook', 'model/WebhooksList', 'api/DefaultApi'], factory);
2020
} else if (typeof module === 'object' && module.exports) {
2121
// CommonJS-like environments that support module.exports, like Node.
22-
module.exports = factory(require('./ApiClient'), require('./model/Address'), require('./model/Applicant'), require('./model/ApplicantsList'), require('./model/Check'), require('./model/CheckCommon'), require('./model/CheckWithReportIds'), require('./model/ChecksList'), require('./model/Document'), require('./model/DocumentsList'), require('./model/Error'), require('./model/GenericAddress'), require('./model/GenericAddressesList'), require('./model/IdNumber'), require('./model/LivePhoto'), require('./model/LivePhotosList'), require('./model/LiveVideo'), require('./model/LiveVideosList'), require('./model/Report'), require('./model/ReportDocument'), require('./model/ReportOption'), require('./model/ReportType'), require('./model/ReportTypeGroup'), require('./model/ReportTypeGroupsList'), require('./model/ReportsList'), require('./model/Webhook'), require('./model/WebhooksList'), require('./api/DefaultApi'));
22+
module.exports = factory(require('./ApiClient'), require('./model/Address'), require('./model/Applicant'), require('./model/ApplicantsList'), require('./model/Check'), require('./model/CheckCommon'), require('./model/CheckWithReportIds'), require('./model/ChecksList'), require('./model/Document'), require('./model/DocumentsList'), require('./model/Error'), require('./model/GenericAddress'), require('./model/GenericAddressesList'), require('./model/IdNumber'), require('./model/LivePhoto'), require('./model/LivePhotosList'), require('./model/LiveVideo'), require('./model/LiveVideosList'), require('./model/Report'), require('./model/ReportDocument'), require('./model/ReportOption'), require('./model/ReportType'), require('./model/ReportTypeGroup'), require('./model/ReportTypeGroupsList'), require('./model/ReportsList'), require('./model/SdkTokenRequest'), require('./model/SdkTokenResponse'), require('./model/Webhook'), require('./model/WebhooksList'), require('./api/DefaultApi'));
2323
}
24-
}(function(ApiClient, Address, Applicant, ApplicantsList, Check, CheckCommon, CheckWithReportIds, ChecksList, Document, DocumentsList, Error, GenericAddress, GenericAddressesList, IdNumber, LivePhoto, LivePhotosList, LiveVideo, LiveVideosList, Report, ReportDocument, ReportOption, ReportType, ReportTypeGroup, ReportTypeGroupsList, ReportsList, Webhook, WebhooksList, DefaultApi) {
24+
}(function(ApiClient, Address, Applicant, ApplicantsList, Check, CheckCommon, CheckWithReportIds, ChecksList, Document, DocumentsList, Error, GenericAddress, GenericAddressesList, IdNumber, LivePhoto, LivePhotosList, LiveVideo, LiveVideosList, Report, ReportDocument, ReportOption, ReportType, ReportTypeGroup, ReportTypeGroupsList, ReportsList, SdkTokenRequest, SdkTokenResponse, Webhook, WebhooksList, DefaultApi) {
2525
'use strict';
2626

2727
/**
@@ -53,7 +53,7 @@
5353
* </pre>
5454
* </p>
5555
* @module index
56-
* @version 3.0.0
56+
* @version 3.1.0
5757
*/
5858
var exports = {
5959
/**
@@ -181,6 +181,16 @@
181181
* @property {module:model/ReportsList}
182182
*/
183183
ReportsList: ReportsList,
184+
/**
185+
* The SdkTokenRequest model constructor.
186+
* @property {module:model/SdkTokenRequest}
187+
*/
188+
SdkTokenRequest: SdkTokenRequest,
189+
/**
190+
* The SdkTokenResponse model constructor.
191+
* @property {module:model/SdkTokenResponse}
192+
*/
193+
SdkTokenResponse: SdkTokenResponse,
184194
/**
185195
* The Webhook model constructor.
186196
* @property {module:model/Webhook}

‎src/model/Address.js‎

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -35,7 +35,7 @@
3535
/**
3636
* The Address model module.
3737
* @module model/Address
38-
* @version 3.0.0
38+
* @version 3.1.0
3939
*/
4040

4141
/**

‎src/model/Applicant.js‎

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -35,7 +35,7 @@
3535
/**
3636
* The Applicant model module.
3737
* @module model/Applicant
38-
* @version 3.0.0
38+
* @version 3.1.0
3939
*/
4040

4141
/**

0 commit comments

Comments
 (0)