Skip to content

Commit

Permalink
New client release: 4.1.0
Browse files Browse the repository at this point in the history
  • Loading branch information
Engineering at Onfido committed Jun 6, 2019
1 parent 257802f commit a61985f
Show file tree
Hide file tree
Showing 6 changed files with 682 additions and 5 deletions.
6 changes: 4 additions & 2 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -4,7 +4,7 @@ The Onfido API is used to submit check requests.
This PHP package is automatically generated by the [OpenAPI Generator](https://openapi-generator.tech) project:

- API version: 2.0.0
- Package version: 4.0.1
- Package version: 4.1.0
- Build package: org.openapitools.codegen.languages.PhpClientCodegen

## Requirements
Expand All @@ -25,7 +25,7 @@ To install the bindings via [Composer](http://getcomposer.org/), add the followi
}
],
"require": {
"onfido/api-php-client": "^4.0.1"
"onfido/api-php-client": "^4.1.0"
}
}
```
Expand Down Expand Up @@ -113,10 +113,12 @@ Class | Method | HTTP request | Description
*DefaultApi* | [**createApplicant**](docs/Api/DefaultApi.md#createapplicant) | **POST** /applicants | Create Applicant
*DefaultApi* | [**createCheck**](docs/Api/DefaultApi.md#createcheck) | **POST** /applicants/{applicant_id}/checks | Create a check
*DefaultApi* | [**createWebhook**](docs/Api/DefaultApi.md#createwebhook) | **POST** /webhooks | Create a webhook
*DefaultApi* | [**deleteWebhook**](docs/Api/DefaultApi.md#deletewebhook) | **DELETE** /webhooks/{webhook_id} | Delete a webhook
*DefaultApi* | [**destroyApplicant**](docs/Api/DefaultApi.md#destroyapplicant) | **DELETE** /applicants/{applicant_id} | Delete Applicant
*DefaultApi* | [**downloadDocument**](docs/Api/DefaultApi.md#downloaddocument) | **GET** /applicants/{applicant_id}/documents/{document_id}/download | Download a documents raw data
*DefaultApi* | [**downloadLivePhoto**](docs/Api/DefaultApi.md#downloadlivephoto) | **GET** /live_photos/{live_photo_id}/download | Download live photo
*DefaultApi* | [**downloadLiveVideo**](docs/Api/DefaultApi.md#downloadlivevideo) | **GET** /live_videos/{live_video_id}/download | Download live video
*DefaultApi* | [**editWebhook**](docs/Api/DefaultApi.md#editwebhook) | **PUT** /webhooks/{webhook_id} | Edit a webhook
*DefaultApi* | [**findAddresses**](docs/Api/DefaultApi.md#findaddresses) | **GET** /addresses/pick | Search for addresses by postcode
*DefaultApi* | [**findApplicant**](docs/Api/DefaultApi.md#findapplicant) | **GET** /applicants/{applicant_id} | Retrieve Applicant
*DefaultApi* | [**findCheck**](docs/Api/DefaultApi.md#findcheck) | **GET** /applicants/{applicant_id}/checks/{check_id} | Retrieve a Check
Expand Down
2 changes: 1 addition & 1 deletion composer.json
Original file line number Diff line number Diff line change
@@ -1,6 +1,6 @@
{
"name": "onfido/api-php-client",
"version": "4.0.1",
"version": "4.1.0",
"description": "The Onfido API is used to submit check requests.",
"keywords": [
"openapitools",
Expand Down
107 changes: 107 additions & 0 deletions docs/Api/DefaultApi.md
Original file line number Diff line number Diff line change
Expand Up @@ -8,10 +8,12 @@ Method | HTTP request | Description
[**createApplicant**](DefaultApi.md#createApplicant) | **POST** /applicants | Create Applicant
[**createCheck**](DefaultApi.md#createCheck) | **POST** /applicants/{applicant_id}/checks | Create a check
[**createWebhook**](DefaultApi.md#createWebhook) | **POST** /webhooks | Create a webhook
[**deleteWebhook**](DefaultApi.md#deleteWebhook) | **DELETE** /webhooks/{webhook_id} | Delete a webhook
[**destroyApplicant**](DefaultApi.md#destroyApplicant) | **DELETE** /applicants/{applicant_id} | Delete Applicant
[**downloadDocument**](DefaultApi.md#downloadDocument) | **GET** /applicants/{applicant_id}/documents/{document_id}/download | Download a documents raw data
[**downloadLivePhoto**](DefaultApi.md#downloadLivePhoto) | **GET** /live_photos/{live_photo_id}/download | Download live photo
[**downloadLiveVideo**](DefaultApi.md#downloadLiveVideo) | **GET** /live_videos/{live_video_id}/download | Download live video
[**editWebhook**](DefaultApi.md#editWebhook) | **PUT** /webhooks/{webhook_id} | Edit a webhook
[**findAddresses**](DefaultApi.md#findAddresses) | **GET** /addresses/pick | Search for addresses by postcode
[**findApplicant**](DefaultApi.md#findApplicant) | **GET** /applicants/{applicant_id} | Retrieve Applicant
[**findCheck**](DefaultApi.md#findCheck) | **GET** /applicants/{applicant_id}/checks/{check_id} | Retrieve a Check
Expand Down Expand Up @@ -249,6 +251,57 @@ Name | Type | Description | Notes

[[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)

# **deleteWebhook**
> deleteWebhook($webhook_id)
Delete a webhook

### Example
```php
<?php
require_once(__DIR__ . '/vendor/autoload.php');

$config = Onfido\Configuration::getDefaultConfiguration();
$config->setApiKey('Authorization', 'token=' . 'YOUR API KEY');
$config->setApiKeyPrefix('Authorization', 'Token');

$apiInstance = new Onfido\Api\DefaultApi(
// If you want use custom http client, pass your client which implements `GuzzleHttp\ClientInterface`.
// This is optional, `GuzzleHttp\Client` will be used as default.
new GuzzleHttp\Client(),
$config
);
$webhook_id = 'webhook_id_example'; // string |

try {
$apiInstance->deleteWebhook($webhook_id);
} catch (Exception $e) {
echo 'Exception when calling DefaultApi->deleteWebhook: ', $e->getMessage(), PHP_EOL;
}
?>
```

### Parameters

Name | Type | Description | Notes
------------- | ------------- | ------------- | -------------
**webhook_id** | **string**| |

### Return type

void (empty response body)

### Authorization

[Token](../../README.md#Token)

### HTTP request headers

- **Content-Type**: Not defined
- **Accept**: application/json

[[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)

# **destroyApplicant**
> destroyApplicant($applicant_id)
Expand Down Expand Up @@ -462,6 +515,60 @@ Name | Type | Description | Notes

[[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)

# **editWebhook**
> \Onfido\Model\Webhook editWebhook($webhook_id, $webhook)
Edit a webhook

### Example
```php
<?php
require_once(__DIR__ . '/vendor/autoload.php');

$config = Onfido\Configuration::getDefaultConfiguration();
$config->setApiKey('Authorization', 'token=' . 'YOUR API KEY');
$config->setApiKeyPrefix('Authorization', 'Token');

$apiInstance = new Onfido\Api\DefaultApi(
// If you want use custom http client, pass your client which implements `GuzzleHttp\ClientInterface`.
// This is optional, `GuzzleHttp\Client` will be used as default.
new GuzzleHttp\Client(),
$config
);
$webhook_id = 'webhook_id_example'; // string |
$webhook = new \Onfido\Model\Webhook(); // \Onfido\Model\Webhook |

try {
$result = $apiInstance->editWebhook($webhook_id, $webhook);
print_r($result);
} catch (Exception $e) {
echo 'Exception when calling DefaultApi->editWebhook: ', $e->getMessage(), PHP_EOL;
}
?>
```

### Parameters

Name | Type | Description | Notes
------------- | ------------- | ------------- | -------------
**webhook_id** | **string**| |
**webhook** | [**\Onfido\Model\Webhook**](../Model/Webhook.md)| |

### Return type

[**\Onfido\Model\Webhook**](../Model/Webhook.md)

### Authorization

[Token](../../README.md#Token)

### HTTP request headers

- **Content-Type**: application/json
- **Accept**: application/json

[[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)

# **findAddresses**
> \Onfido\Model\GenericAddressesList findAddresses($postcode)
Expand Down
Loading

0 comments on commit a61985f

Please sign in to comment.